diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 182786ebb..e3894c2d9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -39,10 +39,10 @@ jobs: - run: node --version - run: gjs --version - run: yarn install - - run: yarn run build - - run: yarn run build:examples - - run: yarn run validate:examples - - run: yarn run start:cli-examples + - run: yarn build + - run: yarn build:examples + - run: yarn validate:examples + - run: yarn start:cli-examples gjs-types-all: @@ -67,9 +67,9 @@ jobs: - name: Install dependencies run: sudo apt-get --yes install gjs libappindicator3-dev libgda-5.0-dev libgirepository1.0-dev libgtk-3-dev libgtk-4-dev libgtksourceview-3.0-dev libnotify-dev libsoup2.4-dev libsoup-3.0-dev libwebkit2gtk-4.0-dev libadwaita-1-dev gnome-shell-common libmutter-10-dev libgcr-3-dev libgnome-desktop-3-dev build-essential gobject-introspection libgirepository1.0-dev libcairo2-dev - run: yarn install - - run: yarn run build - - run: yarn run build:types:packages:no-install + - run: yarn build + - run: yarn build:types:packages:no-install - name: Show diff run: (cd ./types && git diff | cat) - run: yarn install - - run: NODE_OPTIONS=--max_old_space_size=9216 yarn run validate:types:packages \ No newline at end of file + - run: NODE_OPTIONS=--max_old_space_size=9216 yarn validate:types:packages \ No newline at end of file diff --git a/.ts-for-gir.all.rc.js b/.ts-for-gir.all.rc.js index 3fdece869..682890ad9 100644 --- a/.ts-for-gir.all.rc.js +++ b/.ts-for-gir.all.rc.js @@ -21,8 +21,8 @@ export default { ignore: [ '*/Colorhug-1.0', // Duplicate of ColorHug-1.0 '*/GUPnP-DLNA-1.0', // Same namespace as GUPnP-1.0.gir, is this a bug or should we merge the type definitions? - '*/GstBase-1.0', // Unable to resolve type: BaseSink from GstBase in ClutterGst 1.0 - '*/ClutterGst-1.0', // Depends on GstBase-1.0 - '*/GstAudio-0.10', // Depends on GstBase-1.0 + '*/GstBase-0.10', // Unable to resolve type: BaseSink from GstBase in ClutterGst 1.0 + '*/ClutterGst-1.0', // Depends on GstBase-0.10 + '*/GstAudio-0.10', // Depends on GstBase-0.10 ], } diff --git a/.ts-for-gir.packages-all.rc.js b/.ts-for-gir.packages-all.rc.js index d0de66422..457cc23b2 100644 --- a/.ts-for-gir.packages-all.rc.js +++ b/.ts-for-gir.packages-all.rc.js @@ -8,9 +8,9 @@ export default { ignore: [ '*/Colorhug-1.0', // Duplicate of ColorHug-1.0 '*/GUPnP-DLNA-1.0', // Same namespace as GUPnP-1.0.gir, is this a bug or should we merge the type definitions? - '*/GstBase-1.0', // Unable to resolve type: BaseSink from GstBase in ClutterGst 1.0 - '*/ClutterGst-1.0', // Depends on GstBase-1.0 - '*/GstAudio-0.10', // Depends on GstBase-1.0 + '*/GstBase-0.10', // Unable to resolve type: BaseSink from GstBase in ClutterGst 1.0 + '*/ClutterGst-1.0', // Depends on GstBase-0.10 + '*/GstAudio-0.10', // Depends on GstBase-0.10 ], ignoreVersionConflicts: true, promisify: true, diff --git a/.yarn/sdks/eslint/bin/eslint.js b/.yarn/sdks/eslint/bin/eslint.js index 9ef98e400..42eab9933 100755 --- a/.yarn/sdks/eslint/bin/eslint.js +++ b/.yarn/sdks/eslint/bin/eslint.js @@ -1,18 +1,25 @@ #!/usr/bin/env node const {existsSync} = require(`fs`); -const {createRequire} = require(`module`); +const {createRequire, register} = require(`module`); const {resolve} = require(`path`); +const {pathToFileURL} = require(`url`); const relPnpApiPath = "../../../../.pnp.cjs"; const absPnpApiPath = resolve(__dirname, relPnpApiPath); const absRequire = createRequire(absPnpApiPath); +const absPnpLoaderPath = resolve(absPnpApiPath, `../.pnp.loader.mjs`); +const isPnpLoaderEnabled = existsSync(absPnpLoaderPath); + if (existsSync(absPnpApiPath)) { if (!process.versions.pnp) { // Setup the environment to be able to require eslint/bin/eslint.js require(absPnpApiPath).setup(); + if (isPnpLoaderEnabled && register) { + register(pathToFileURL(absPnpLoaderPath)); + } } } diff --git a/.yarn/sdks/eslint/lib/api.js b/.yarn/sdks/eslint/lib/api.js index 653b22bae..ea2b46a70 100644 --- a/.yarn/sdks/eslint/lib/api.js +++ b/.yarn/sdks/eslint/lib/api.js @@ -1,18 +1,25 @@ #!/usr/bin/env node const {existsSync} = require(`fs`); -const {createRequire} = require(`module`); +const {createRequire, register} = require(`module`); const {resolve} = require(`path`); +const {pathToFileURL} = require(`url`); const relPnpApiPath = "../../../../.pnp.cjs"; const absPnpApiPath = resolve(__dirname, relPnpApiPath); const absRequire = createRequire(absPnpApiPath); +const absPnpLoaderPath = resolve(absPnpApiPath, `../.pnp.loader.mjs`); +const isPnpLoaderEnabled = existsSync(absPnpLoaderPath); + if (existsSync(absPnpApiPath)) { if (!process.versions.pnp) { // Setup the environment to be able to require eslint require(absPnpApiPath).setup(); + if (isPnpLoaderEnabled && register) { + register(pathToFileURL(absPnpLoaderPath)); + } } } diff --git a/.yarn/sdks/eslint/lib/unsupported-api.js b/.yarn/sdks/eslint/lib/unsupported-api.js index 30fdf158b..f5f8e24d0 100644 --- a/.yarn/sdks/eslint/lib/unsupported-api.js +++ b/.yarn/sdks/eslint/lib/unsupported-api.js @@ -1,18 +1,25 @@ #!/usr/bin/env node const {existsSync} = require(`fs`); -const {createRequire} = require(`module`); +const {createRequire, register} = require(`module`); const {resolve} = require(`path`); +const {pathToFileURL} = require(`url`); const relPnpApiPath = "../../../../.pnp.cjs"; const absPnpApiPath = resolve(__dirname, relPnpApiPath); const absRequire = createRequire(absPnpApiPath); +const absPnpLoaderPath = resolve(absPnpApiPath, `../.pnp.loader.mjs`); +const isPnpLoaderEnabled = existsSync(absPnpLoaderPath); + if (existsSync(absPnpApiPath)) { if (!process.versions.pnp) { // Setup the environment to be able to require eslint/use-at-your-own-risk require(absPnpApiPath).setup(); + if (isPnpLoaderEnabled && register) { + register(pathToFileURL(absPnpLoaderPath)); + } } } diff --git a/.yarn/sdks/prettier/bin/prettier.cjs b/.yarn/sdks/prettier/bin/prettier.cjs index 5efad688e..00f1f7f74 100755 --- a/.yarn/sdks/prettier/bin/prettier.cjs +++ b/.yarn/sdks/prettier/bin/prettier.cjs @@ -1,18 +1,25 @@ #!/usr/bin/env node const {existsSync} = require(`fs`); -const {createRequire} = require(`module`); +const {createRequire, register} = require(`module`); const {resolve} = require(`path`); +const {pathToFileURL} = require(`url`); const relPnpApiPath = "../../../../.pnp.cjs"; const absPnpApiPath = resolve(__dirname, relPnpApiPath); const absRequire = createRequire(absPnpApiPath); +const absPnpLoaderPath = resolve(absPnpApiPath, `../.pnp.loader.mjs`); +const isPnpLoaderEnabled = existsSync(absPnpLoaderPath); + if (existsSync(absPnpApiPath)) { if (!process.versions.pnp) { // Setup the environment to be able to require prettier/bin/prettier.cjs require(absPnpApiPath).setup(); + if (isPnpLoaderEnabled && register) { + register(pathToFileURL(absPnpLoaderPath)); + } } } diff --git a/.yarn/sdks/prettier/index.cjs b/.yarn/sdks/prettier/index.cjs index 8758e367a..d546c6a75 100644 --- a/.yarn/sdks/prettier/index.cjs +++ b/.yarn/sdks/prettier/index.cjs @@ -1,18 +1,25 @@ #!/usr/bin/env node const {existsSync} = require(`fs`); -const {createRequire} = require(`module`); +const {createRequire, register} = require(`module`); const {resolve} = require(`path`); +const {pathToFileURL} = require(`url`); const relPnpApiPath = "../../../.pnp.cjs"; const absPnpApiPath = resolve(__dirname, relPnpApiPath); const absRequire = createRequire(absPnpApiPath); +const absPnpLoaderPath = resolve(absPnpApiPath, `../.pnp.loader.mjs`); +const isPnpLoaderEnabled = existsSync(absPnpLoaderPath); + if (existsSync(absPnpApiPath)) { if (!process.versions.pnp) { // Setup the environment to be able to require prettier require(absPnpApiPath).setup(); + if (isPnpLoaderEnabled && register) { + register(pathToFileURL(absPnpLoaderPath)); + } } } diff --git a/.yarn/sdks/prettier/package.json b/.yarn/sdks/prettier/package.json index 6e68f38b6..b26338148 100644 --- a/.yarn/sdks/prettier/package.json +++ b/.yarn/sdks/prettier/package.json @@ -1,6 +1,6 @@ { "name": "prettier", - "version": "3.2.5-sdk", + "version": "3.3.2-sdk", "main": "./index.cjs", "type": "commonjs", "bin": "./bin/prettier.cjs" diff --git a/.yarn/sdks/typescript/bin/tsc b/.yarn/sdks/typescript/bin/tsc index 454b950b7..a6bb0e2c1 100755 --- a/.yarn/sdks/typescript/bin/tsc +++ b/.yarn/sdks/typescript/bin/tsc @@ -1,18 +1,25 @@ #!/usr/bin/env node const {existsSync} = require(`fs`); -const {createRequire} = require(`module`); +const {createRequire, register} = require(`module`); const {resolve} = require(`path`); +const {pathToFileURL} = require(`url`); const relPnpApiPath = "../../../../.pnp.cjs"; const absPnpApiPath = resolve(__dirname, relPnpApiPath); const absRequire = createRequire(absPnpApiPath); +const absPnpLoaderPath = resolve(absPnpApiPath, `../.pnp.loader.mjs`); +const isPnpLoaderEnabled = existsSync(absPnpLoaderPath); + if (existsSync(absPnpApiPath)) { if (!process.versions.pnp) { // Setup the environment to be able to require typescript/bin/tsc require(absPnpApiPath).setup(); + if (isPnpLoaderEnabled && register) { + register(pathToFileURL(absPnpLoaderPath)); + } } } diff --git a/.yarn/sdks/typescript/bin/tsserver b/.yarn/sdks/typescript/bin/tsserver index d7a605684..957bed200 100755 --- a/.yarn/sdks/typescript/bin/tsserver +++ b/.yarn/sdks/typescript/bin/tsserver @@ -1,18 +1,25 @@ #!/usr/bin/env node const {existsSync} = require(`fs`); -const {createRequire} = require(`module`); +const {createRequire, register} = require(`module`); const {resolve} = require(`path`); +const {pathToFileURL} = require(`url`); const relPnpApiPath = "../../../../.pnp.cjs"; const absPnpApiPath = resolve(__dirname, relPnpApiPath); const absRequire = createRequire(absPnpApiPath); +const absPnpLoaderPath = resolve(absPnpApiPath, `../.pnp.loader.mjs`); +const isPnpLoaderEnabled = existsSync(absPnpLoaderPath); + if (existsSync(absPnpApiPath)) { if (!process.versions.pnp) { // Setup the environment to be able to require typescript/bin/tsserver require(absPnpApiPath).setup(); + if (isPnpLoaderEnabled && register) { + register(pathToFileURL(absPnpLoaderPath)); + } } } diff --git a/.yarn/sdks/typescript/lib/tsc.js b/.yarn/sdks/typescript/lib/tsc.js index 2f62fc96c..a262a77d0 100644 --- a/.yarn/sdks/typescript/lib/tsc.js +++ b/.yarn/sdks/typescript/lib/tsc.js @@ -1,18 +1,25 @@ #!/usr/bin/env node const {existsSync} = require(`fs`); -const {createRequire} = require(`module`); +const {createRequire, register} = require(`module`); const {resolve} = require(`path`); +const {pathToFileURL} = require(`url`); const relPnpApiPath = "../../../../.pnp.cjs"; const absPnpApiPath = resolve(__dirname, relPnpApiPath); const absRequire = createRequire(absPnpApiPath); +const absPnpLoaderPath = resolve(absPnpApiPath, `../.pnp.loader.mjs`); +const isPnpLoaderEnabled = existsSync(absPnpLoaderPath); + if (existsSync(absPnpApiPath)) { if (!process.versions.pnp) { // Setup the environment to be able to require typescript/lib/tsc.js require(absPnpApiPath).setup(); + if (isPnpLoaderEnabled && register) { + register(pathToFileURL(absPnpLoaderPath)); + } } } diff --git a/.yarn/sdks/typescript/lib/tsserver.js b/.yarn/sdks/typescript/lib/tsserver.js index bbb1e4650..1dae54c1a 100644 --- a/.yarn/sdks/typescript/lib/tsserver.js +++ b/.yarn/sdks/typescript/lib/tsserver.js @@ -1,14 +1,28 @@ #!/usr/bin/env node const {existsSync} = require(`fs`); -const {createRequire} = require(`module`); +const {createRequire, register} = require(`module`); const {resolve} = require(`path`); +const {pathToFileURL} = require(`url`); const relPnpApiPath = "../../../../.pnp.cjs"; const absPnpApiPath = resolve(__dirname, relPnpApiPath); const absRequire = createRequire(absPnpApiPath); +const absPnpLoaderPath = resolve(absPnpApiPath, `../.pnp.loader.mjs`); +const isPnpLoaderEnabled = existsSync(absPnpLoaderPath); + +if (existsSync(absPnpApiPath)) { + if (!process.versions.pnp) { + // Setup the environment to be able to require typescript/lib/tsserver.js + require(absPnpApiPath).setup(); + if (isPnpLoaderEnabled && register) { + register(pathToFileURL(absPnpLoaderPath)); + } + } +} + const moduleWrapper = tsserver => { if (!process.versions.pnp) { return tsserver; @@ -214,11 +228,11 @@ const moduleWrapper = tsserver => { return tsserver; }; -if (existsSync(absPnpApiPath)) { - if (!process.versions.pnp) { - // Setup the environment to be able to require typescript/lib/tsserver.js - require(absPnpApiPath).setup(); - } +const [major, minor] = absRequire(`typescript/package.json`).version.split(`.`, 2).map(value => parseInt(value, 10)); +// In TypeScript@>=5.5 the tsserver uses the public TypeScript API so that needs to be patched as well. +// Ref https://github.com/microsoft/TypeScript/pull/55326 +if (major > 5 || (major === 5 && minor >= 5)) { + moduleWrapper(absRequire(`typescript`)); } // Defer to the real typescript/lib/tsserver.js your application uses diff --git a/.yarn/sdks/typescript/lib/tsserverlibrary.js b/.yarn/sdks/typescript/lib/tsserverlibrary.js index a68f028fe..7f9d7f964 100644 --- a/.yarn/sdks/typescript/lib/tsserverlibrary.js +++ b/.yarn/sdks/typescript/lib/tsserverlibrary.js @@ -1,14 +1,28 @@ #!/usr/bin/env node const {existsSync} = require(`fs`); -const {createRequire} = require(`module`); +const {createRequire, register} = require(`module`); const {resolve} = require(`path`); +const {pathToFileURL} = require(`url`); const relPnpApiPath = "../../../../.pnp.cjs"; const absPnpApiPath = resolve(__dirname, relPnpApiPath); const absRequire = createRequire(absPnpApiPath); +const absPnpLoaderPath = resolve(absPnpApiPath, `../.pnp.loader.mjs`); +const isPnpLoaderEnabled = existsSync(absPnpLoaderPath); + +if (existsSync(absPnpApiPath)) { + if (!process.versions.pnp) { + // Setup the environment to be able to require typescript/lib/tsserverlibrary.js + require(absPnpApiPath).setup(); + if (isPnpLoaderEnabled && register) { + register(pathToFileURL(absPnpLoaderPath)); + } + } +} + const moduleWrapper = tsserver => { if (!process.versions.pnp) { return tsserver; @@ -214,11 +228,11 @@ const moduleWrapper = tsserver => { return tsserver; }; -if (existsSync(absPnpApiPath)) { - if (!process.versions.pnp) { - // Setup the environment to be able to require typescript/lib/tsserverlibrary.js - require(absPnpApiPath).setup(); - } +const [major, minor] = absRequire(`typescript/package.json`).version.split(`.`, 2).map(value => parseInt(value, 10)); +// In TypeScript@>=5.5 the tsserver uses the public TypeScript API so that needs to be patched as well. +// Ref https://github.com/microsoft/TypeScript/pull/55326 +if (major > 5 || (major === 5 && minor >= 5)) { + moduleWrapper(absRequire(`typescript`)); } // Defer to the real typescript/lib/tsserverlibrary.js your application uses diff --git a/.yarn/sdks/typescript/lib/typescript.js b/.yarn/sdks/typescript/lib/typescript.js index b5f4db25b..317b60b4c 100644 --- a/.yarn/sdks/typescript/lib/typescript.js +++ b/.yarn/sdks/typescript/lib/typescript.js @@ -1,18 +1,25 @@ #!/usr/bin/env node const {existsSync} = require(`fs`); -const {createRequire} = require(`module`); +const {createRequire, register} = require(`module`); const {resolve} = require(`path`); +const {pathToFileURL} = require(`url`); const relPnpApiPath = "../../../../.pnp.cjs"; const absPnpApiPath = resolve(__dirname, relPnpApiPath); const absRequire = createRequire(absPnpApiPath); +const absPnpLoaderPath = resolve(absPnpApiPath, `../.pnp.loader.mjs`); +const isPnpLoaderEnabled = existsSync(absPnpLoaderPath); + if (existsSync(absPnpApiPath)) { if (!process.versions.pnp) { // Setup the environment to be able to require typescript require(absPnpApiPath).setup(); + if (isPnpLoaderEnabled && register) { + register(pathToFileURL(absPnpLoaderPath)); + } } } diff --git a/.yarn/sdks/typescript/package.json b/.yarn/sdks/typescript/package.json index bedc36522..0c65a6950 100644 --- a/.yarn/sdks/typescript/package.json +++ b/.yarn/sdks/typescript/package.json @@ -1,6 +1,6 @@ { "name": "typescript", - "version": "5.4.3-sdk", + "version": "5.5.3-sdk", "main": "./lib/typescript.js", "type": "commonjs", "bin": { diff --git a/examples/gjs/adw-1-hello/package.json b/examples/gjs/adw-1-hello/package.json index 99286eb18..6a52acc98 100644 --- a/examples/gjs/adw-1-hello/package.json +++ b/examples/gjs/adw-1-hello/package.json @@ -20,11 +20,11 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "@babel/core": "^7.24.5", + "@babel/core": "^7.24.7", "@rollup/plugin-babel": "^6.0.4", - "rollup": "^4.17.2", - "typescript": "^5.4.5", - "vite": "^5.2.11" + "rollup": "^4.18.0", + "typescript": "^5.5.3", + "vite": "^5.3.3" }, "dependencies": { "@girs/adw-1": "workspace:^", diff --git a/examples/gjs/gio-2-cat/package.json b/examples/gjs/gio-2-cat/package.json index ca559fcdf..f16a3265f 100644 --- a/examples/gjs/gio-2-cat/package.json +++ b/examples/gjs/gio-2-cat/package.json @@ -20,8 +20,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gio-2.0": "workspace:^", diff --git a/examples/gjs/gio-2-dbus/package.json b/examples/gjs/gio-2-dbus/package.json index 8405f9227..6073444ad 100644 --- a/examples/gjs/gio-2-dbus/package.json +++ b/examples/gjs/gio-2-dbus/package.json @@ -23,8 +23,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gio-2.0": "workspace:^", diff --git a/examples/gjs/gio-2-list-model/package.json b/examples/gjs/gio-2-list-model/package.json index 0fdc3ace1..6e6d216ae 100644 --- a/examples/gjs/gio-2-list-model/package.json +++ b/examples/gjs/gio-2-list-model/package.json @@ -19,8 +19,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gio-2.0": "workspace:^", diff --git a/examples/gjs/glib-2-spawn-command/package.json b/examples/gjs/glib-2-spawn-command/package.json index 6b425bcd3..afb95a440 100644 --- a/examples/gjs/glib-2-spawn-command/package.json +++ b/examples/gjs/glib-2-spawn-command/package.json @@ -23,8 +23,8 @@ "devDependencies": { "fork-ts-checker-webpack-plugin": "^9.0.2", "ts-loader": "^9.5.1", - "typescript": "^5.4.5", - "webpack": "^5.91.0", + "typescript": "^5.5.3", + "webpack": "^5.92.1", "webpack-cli": "^5.1.4" }, "dependencies": { diff --git a/examples/gjs/glib-2-variant/package.json b/examples/gjs/glib-2-variant/package.json index f3863aeb6..900137b8b 100644 --- a/examples/gjs/glib-2-variant/package.json +++ b/examples/gjs/glib-2-variant/package.json @@ -20,8 +20,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gio-2.0": "workspace:^", diff --git a/examples/gjs/gtk-3-browser/package.json b/examples/gjs/gtk-3-browser/package.json index 5ad2fcfa9..da8391a6f 100644 --- a/examples/gjs/gtk-3-browser/package.json +++ b/examples/gjs/gtk-3-browser/package.json @@ -24,8 +24,8 @@ "devDependencies": { "fork-ts-checker-webpack-plugin": "^9.0.2", "ts-loader": "^9.5.1", - "typescript": "^5.4.5", - "webpack": "^5.91.0", + "typescript": "^5.5.3", + "webpack": "^5.92.1", "webpack-cli": "^5.1.4" }, "dependencies": { diff --git a/examples/gjs/gtk-3-builder/package.json b/examples/gjs/gtk-3-builder/package.json index ba4d9d404..7ab1a9f77 100644 --- a/examples/gjs/gtk-3-builder/package.json +++ b/examples/gjs/gtk-3-builder/package.json @@ -24,8 +24,8 @@ "fork-ts-checker-webpack-plugin": "^9.0.2", "raw-loader": "^4.0.2", "ts-loader": "^9.5.1", - "typescript": "^5.4.5", - "webpack": "^5.91.0", + "typescript": "^5.5.3", + "webpack": "^5.92.1", "webpack-cli": "^5.1.4" }, "dependencies": { diff --git a/examples/gjs/gtk-3-calc/package.json b/examples/gjs/gtk-3-calc/package.json index 830252b04..37d661249 100644 --- a/examples/gjs/gtk-3-calc/package.json +++ b/examples/gjs/gtk-3-calc/package.json @@ -20,8 +20,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gjs": "workspace:^", diff --git a/examples/gjs/gtk-3-editor/package.json b/examples/gjs/gtk-3-editor/package.json index 31558d813..87822d855 100644 --- a/examples/gjs/gtk-3-editor/package.json +++ b/examples/gjs/gtk-3-editor/package.json @@ -22,8 +22,8 @@ "devDependencies": { "fork-ts-checker-webpack-plugin": "^9.0.2", "ts-loader": "^9.5.1", - "typescript": "^5.4.5", - "webpack": "^5.91.0", + "typescript": "^5.5.3", + "webpack": "^5.92.1", "webpack-cli": "^5.1.4" }, "dependencies": { diff --git a/examples/gjs/gtk-3-gettext/package.json b/examples/gjs/gtk-3-gettext/package.json index 273f39b12..409f4ec6a 100644 --- a/examples/gjs/gtk-3-gettext/package.json +++ b/examples/gjs/gtk-3-gettext/package.json @@ -20,8 +20,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gjs": "workspace:^", diff --git a/examples/gjs/gtk-3-hello-2/package.json b/examples/gjs/gtk-3-hello-2/package.json index bf76c2663..4f0487c54 100644 --- a/examples/gjs/gtk-3-hello-2/package.json +++ b/examples/gjs/gtk-3-hello-2/package.json @@ -20,8 +20,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gjs": "workspace:^", diff --git a/examples/gjs/gtk-3-hello/package.json b/examples/gjs/gtk-3-hello/package.json index 5fdeb3f0c..fb07eace0 100644 --- a/examples/gjs/gtk-3-hello/package.json +++ b/examples/gjs/gtk-3-hello/package.json @@ -24,8 +24,8 @@ "devDependencies": { "fork-ts-checker-webpack-plugin": "^9.0.2", "ts-loader": "^9.5.1", - "typescript": "^5.4.5", - "webpack": "^5.91.0", + "typescript": "^5.5.3", + "webpack": "^5.92.1", "webpack-cli": "^5.1.4" }, "dependencies": { diff --git a/examples/gjs/gtk-3-template/package.json b/examples/gjs/gtk-3-template/package.json index 2c72e6c0e..7855d0a58 100644 --- a/examples/gjs/gtk-3-template/package.json +++ b/examples/gjs/gtk-3-template/package.json @@ -20,8 +20,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gjs": "workspace:^", diff --git a/examples/gjs/gtk-3-webkit/package.json b/examples/gjs/gtk-3-webkit/package.json index e8f445739..f735af473 100644 --- a/examples/gjs/gtk-3-webkit/package.json +++ b/examples/gjs/gtk-3-webkit/package.json @@ -20,8 +20,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gjs": "workspace:^", diff --git a/examples/gjs/gtk-4-application/package.json b/examples/gjs/gtk-4-application/package.json index 97631fd5d..89630c335 100644 --- a/examples/gjs/gtk-4-application/package.json +++ b/examples/gjs/gtk-4-application/package.json @@ -20,8 +20,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gio-2.0": "workspace:^", diff --git a/examples/gjs/gtk-4-custom-widget/package.json b/examples/gjs/gtk-4-custom-widget/package.json index 0b4d37f1b..1874ba4e9 100644 --- a/examples/gjs/gtk-4-custom-widget/package.json +++ b/examples/gjs/gtk-4-custom-widget/package.json @@ -21,8 +21,8 @@ "license": "MIT", "devDependencies": { "@ts-for-gir/cli": "workspace:^", - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gio-2.0": "workspace:^", diff --git a/examples/gjs/gtk-4-list-store/package.json b/examples/gjs/gtk-4-list-store/package.json index 85f671bf2..3304d662b 100644 --- a/examples/gjs/gtk-4-list-store/package.json +++ b/examples/gjs/gtk-4-list-store/package.json @@ -20,8 +20,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gio-2.0": "workspace:^", diff --git a/examples/gjs/gtk-4-template/package.json b/examples/gjs/gtk-4-template/package.json index e97d3572b..044efd84b 100644 --- a/examples/gjs/gtk-4-template/package.json +++ b/examples/gjs/gtk-4-template/package.json @@ -21,8 +21,8 @@ "license": "MIT", "devDependencies": { "@ts-for-gir/cli": "workspace:^", - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gio-2.0": "workspace:^", diff --git a/examples/gjs/run-async/package.json b/examples/gjs/run-async/package.json index 4b1e12bf8..8609bbd2a 100644 --- a/examples/gjs/run-async/package.json +++ b/examples/gjs/run-async/package.json @@ -19,8 +19,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/adw-1": "workspace:^", diff --git a/examples/gjs/soup-3-http/package.json b/examples/gjs/soup-3-http/package.json index a3c86d593..40979c528 100644 --- a/examples/gjs/soup-3-http/package.json +++ b/examples/gjs/soup-3-http/package.json @@ -22,8 +22,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gio-2.0": "workspace:^", diff --git a/examples/gjs/soup-3-websocket/package.json b/examples/gjs/soup-3-websocket/package.json index 8dd378e54..9a36e0dee 100644 --- a/examples/gjs/soup-3-websocket/package.json +++ b/examples/gjs/soup-3-websocket/package.json @@ -20,8 +20,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gio-2.0": "workspace:^", diff --git a/examples/gjs/timers/package.json b/examples/gjs/timers/package.json index 7bedfa3b4..552caab22 100644 --- a/examples/gjs/timers/package.json +++ b/examples/gjs/timers/package.json @@ -20,8 +20,8 @@ "author": "Pascal Garber ", "license": "MIT", "devDependencies": { - "esbuild": "^0.20.2", - "typescript": "^5.4.5" + "esbuild": "^0.23.0", + "typescript": "^5.5.3" }, "dependencies": { "@girs/gjs": "workspace:^" diff --git a/girs/Accounts-1.0.gir b/girs/Accounts-1.0.gir index 6ced2e9d9..0f60f1458 100644 --- a/girs/Accounts-1.0.gir +++ b/girs/Accounts-1.0.gir @@ -8,17 +8,77 @@ and/or use gtk-doc annotations. --> xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> - + - ID of an account. Often used when retrieving lists of accounts from + ID of an account. Often used when retrieving lists of accounts from #AgManager. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="AgAccount" glib:get-type="ag_account_get_type" glib:type-struct="AccountClass"> - Opaque structure. Use related accessor functions. + Opaque structure. Use related accessor functions. + - Deletes the account. Call ag_account_store() in order to record the change + Deletes the account. Call ag_account_store() in order to record the change in the storage. + - the #AgAccount. + the #AgAccount. - Get the display name of @account. + c:identifier="ag_account_get_display_name" + glib:get-property="display-name"> + Get the display name of @account. + - the display name. + the display name. - the #AgAccount. + the #AgAccount. - - Gets whether the selected service is enabled for @account. + + Gets whether the selected service is enabled for @account. + - %TRUE if the selected service for @account is enabled, %FALSE + %TRUE if the selected service for @account is enabled, %FALSE otherwise. - the #AgAccount. + the #AgAccount. - - Get the #AgManager for @account. + + Get the #AgManager for @account. + - the #AgManager. + the #AgManager. - the #AgAccount. + the #AgAccount. - Get the name of the provider of @account. + Get the name of the provider of @account. + - the name of the provider. + the name of the provider. - the #AgAccount. + the #AgAccount. - Gets the selected #AgService for @account. + Gets the selected #AgService for @account. + - the selected service, or %NULL if no service is selected. + the selected service, or %NULL if no service is selected. - the #AgAccount. + the #AgAccount. - Creates a new iterator. This method is useful for language bindings only. + Creates a new iterator. This method is useful for language bindings only. + - an #AgAccountSettingIter. + an #AgAccountSettingIter. - the #AgAccount. + the #AgAccount. - enumerate only the settings whose key starts with + enumerate only the settings whose key starts with @key_prefix. @@ -136,11 +253,16 @@ otherwise. c:identifier="ag_account_get_value" deprecated="1" deprecated-version="1.4"> - Gets the value of the configuration setting @key: @value must be a + Gets the value of the configuration setting @key: @value must be a #GValue initialized to the type of the setting. Use ag_account_get_variant() instead. + - one of #AgSettingSource: %AG_SETTING_SOURCE_NONE if the setting is + one of #AgSettingSource: %AG_SETTING_SOURCE_NONE if the setting is not present, %AG_SETTING_SOURCE_ACCOUNT if the setting comes from the account configuration, or %AG_SETTING_SOURCE_PROFILE if the value comes as predefined in the profile. @@ -148,18 +270,24 @@ predefined in the profile. - the #AgAccount. + the #AgAccount. - the name of the setting to retrieve. + the name of the setting to retrieve. - an initialized #GValue to receive the setting's value. + an initialized #GValue to receive the setting's value. @@ -167,9 +295,14 @@ predefined in the profile. - Gets the value of the configuration setting @key. + Gets the value of the configuration setting @key. + - a #GVariant holding the setting value, or + a #GVariant holding the setting value, or %NULL. The returned #GVariant is owned by the account, and no guarantees are made about its lifetime. If the client wishes to keep it, it should call g_variant_ref() on it. @@ -177,11 +310,15 @@ call g_variant_ref() on it. - the #AgAccount. + the #AgAccount. - the name of the setting to retrieve. + the name of the setting to retrieve. transfer-ownership="full" optional="1" allow-none="1"> - a pointer to an + a pointer to an #AgSettingSource variable which will tell whether the setting was retrieved from the accounts DB or from a service template. @@ -199,9 +338,14 @@ retrieved from the accounts DB or from a service template. - Gets a list of services that are enabled for @account. + Gets a list of services that are enabled for @account. + - a #GList of #AgService + a #GList of #AgService items representing all the services which are enabled. Must be free'd with ag_service_list_free(). @@ -210,16 +354,23 @@ ag_service_list_free(). - the #AgAccount. + the #AgAccount. - Get the list of services for @account. If the #AgManager was created with + Get the list of services for @account. If the #AgManager was created with specified service_type this will return only services with this service_type. + - a #GList of #AgService + a #GList of #AgService items representing all the services supported by this account. Must be free'd with ag_service_list_free(). @@ -228,16 +379,23 @@ free'd with ag_service_list_free(). - the #AgAccount. + the #AgAccount. - Get the list of services supported by @account, filtered by @service_type. + Get the list of services supported by @account, filtered by @service_type. + - a #GList of #AgService + a #GList of #AgService items representing all the services supported by this account which provide @service_type. Must be free'd with ag_service_list_free(). @@ -246,85 +404,117 @@ items representing all the services supported by this account which provide - the #AgAccount. + the #AgAccount. - the service type which all the returned services should + the service type which all the returned services should provide. - Removes the notification callback identified by @watch. + Removes the notification callback identified by @watch. + - the #AgAccount. + the #AgAccount. - the watch to remove. + the watch to remove. - Selects the configuration of service @service: from now on, all the + Selects the configuration of service @service: from now on, all the subsequent calls on the #AgAccount configuration will act on the @service. If @service is %NULL, the global account configuration is selected. Note that if @account is being shared with other code one must take special care to make sure the desired service is always selected. + - the #AgAccount. + the #AgAccount. - the #AgService to select. + the #AgService to select. - Changes the display name for @account to @display_name. + Changes the display name for @account to @display_name. + - the #AgAccount. + the #AgAccount. - the display name to set. + the display name to set. - Sets the "enabled" flag on the selected service for @account. + Sets the "enabled" flag on the selected service for @account. + - the #AgAccount. + the #AgAccount. - whether @account should be enabled. + whether @account should be enabled. @@ -333,26 +523,35 @@ care to make sure the desired service is always selected. c:identifier="ag_account_set_value" deprecated="1" deprecated-version="1.4"> - Sets the value of the configuration setting @key to the value @value. + Sets the value of the configuration setting @key to the value @value. If @value is %NULL, then the setting is unset. Use ag_account_set_variant() instead. + - the #AgAccount. + the #AgAccount. - the name of the setting to change. + the name of the setting to change. - a #GValue holding the new setting's value. + a #GValue holding the new setting's value. @@ -360,75 +559,102 @@ If @value is %NULL, then the setting is unset. - Sets the value of the configuration setting @key to the value @value. + Sets the value of the configuration setting @key to the value @value. If @value has a floating reference, the @account will take ownership of it. If @value is %NULL, then the setting is unset. + - the #AgAccount. + the #AgAccount. - the name of the setting to change. + the name of the setting to change. - a #GVariant holding the new setting's value. + a #GVariant holding the new setting's value. - Initializes @iter to iterate over the account settings. If @key_prefix is + Initializes @iter to iterate over the account settings. If @key_prefix is not %NULL, only keys whose names start with @key_prefix will be iterated over. + - the #AgAccount. + the #AgAccount. - an uninitialized #AgAccountSettingIter structure. + an uninitialized #AgAccountSettingIter structure. - enumerate only the settings whose key starts with + enumerate only the settings whose key starts with @key_prefix. - Creates signature of the @key with given @token. The account must be + Creates signature of the @key with given @token. The account must be stored prior to calling this function. + - the #AgAccount. + the #AgAccount. - the name of the key or prefix of the keys to be signed. + the name of the key or prefix of the keys to be signed. - a signing token (%NULL-terminated string) for creating the + a signing token (%NULL-terminated string) for creating the signature. The application must possess (request) the token. @@ -438,27 +664,39 @@ signature. The application must possess (request) the token. c:identifier="ag_account_store" deprecated="1" deprecated-version="1.4"> - Commit the changed account settings to the account database, and invoke + Commit the changed account settings to the account database, and invoke @callback when the operation has been completed. Use ag_account_store_async() instead. + - the #AgAccount. + the #AgAccount. - function to be called when the settings have been + function to be called when the settings have been written. - - pointer to user data, to be passed to @callback. + + pointer to user data, to be passed to @callback. @@ -466,21 +704,28 @@ written. - Commit the changed account settings to the account database, and invoke + Commit the changed account settings to the account database, and invoke @callback when the operation has been completed. + - the #AgAccount. + the #AgAccount. - optional #GCancellable object, %NULL to ignore. + optional #GCancellable object, %NULL to ignore. allow-none="1" scope="async" closure="2"> - function to be called when the settings have been + function to be called when the settings have been written. - - pointer to user data, to be passed to @callback. + + pointer to user data, to be passed to @callback. @@ -502,15 +754,22 @@ written. - Commit the changed account settings to the account database, and invoke + Commit the changed account settings to the account database, and invoke @callback when the operation has been completed. + - %TRUE on success, %FALSE on failure. + %TRUE on success, %FALSE on failure. - the #AgAccount. + the #AgAccount. @@ -519,18 +778,27 @@ written. c:identifier="ag_account_store_finish" version="1.4" throws="1"> - Finishes the store operation started by ag_account_store_async(). + Finishes the store operation started by ag_account_store_async(). + - %TRUE on success, %FALSE otherwise. + %TRUE on success, %FALSE otherwise. - the #AgAccount. + the #AgAccount. - A #GAsyncResult obtained from the #GAsyncReadyCallback passed to + A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ag_account_store_async(). @@ -538,167 +806,252 @@ ag_account_store_async(). - Get whether @service_type is supported on @account. + Get whether @service_type is supported on @account. + - %TRUE if @account supports the service type @service_type, %FALSE + %TRUE if @account supports the service type @service_type, %FALSE otherwise. - the #AgAccount. + the #AgAccount. - the name of the service type to check for + the name of the service type to check for - Verify if the key is signed and the signature matches the value + Verify if the key is signed and the signature matches the value and provides the aegis token which was used for signing the @key. + - %TRUE if the key is signed and the signature matches the value, + %TRUE if the key is signed and the signature matches the value, %FALSE otherwise. - the #AgAccount. + the #AgAccount. - the name of the key or prefix of the keys to be verified. + the name of the key or prefix of the keys to be verified. - location to receive the pointer to aegis token. + location to receive the pointer to aegis token. - Verify if the @key is signed with any of the tokens from the @tokens + Verify if the @key is signed with any of the tokens from the @tokens and the signature is valid. + - %TRUE if the key is signed with any of the given tokens and the + %TRUE if the key is signed with any of the given tokens and the signature is valid, %FALSE otherwise. - the #AgAccount. + the #AgAccount. - the name of the key or prefix of the keys to be verified. + the name of the key or prefix of the keys to be verified. - array of aegis tokens. + array of aegis tokens. - Installs a watch on all the keys under @key_prefix: @callback will be + Installs a watch on all the keys under @key_prefix: @callback will be invoked whenever the value of any of these keys changes (or a key is removed). + - a #AgAccountWatch, which can then be used to + a #AgAccountWatch, which can then be used to remove this watch. - the #AgAccount. + the #AgAccount. - the prefix of the keys to watch. + the prefix of the keys to watch. - a #AgAccountNotifyCb callback to be called. + a #AgAccountNotifyCb callback to be called. - - pointer to user data, to be passed to @callback. + + pointer to user data, to be passed to @callback. - Installs a watch on @key: @callback will be invoked whenever the value of + Installs a watch on @key: @callback will be invoked whenever the value of @key changes (or the key is removed). + - a #AgAccountWatch, which can then be used to + a #AgAccountWatch, which can then be used to remove this watch. - the #AgAccount. + the #AgAccount. - the name of the key to watch. + the name of the key to watch. - a #AgAccountNotifyCb callback to be called. + a #AgAccountNotifyCb callback to be called. - - pointer to user data, to be passed to @callback. + + pointer to user data, to be passed to @callback. - - The display name of the account. + + The display name of the account. - - Whether the account is currently enabled. + + Whether the account is currently enabled. + transfer-ownership="none" + default-value="FALSE"> - The AgAccountId for the account. + transfer-ownership="none" + default-value="0"> + The AgAccountId for the account. - The #AgManager from which the account was instantiated. + transfer-ownership="none" + getter="get_manager"> + The #AgManager from which the account was instantiated. - The ID of the provider for the account. + transfer-ownership="none" + default-value="NULL"> + The ID of the provider for the account. @@ -711,31 +1064,41 @@ remove this watch. - Emitted when the account has been deleted. + Emitted when the account has been deleted. - Emitted when the account display name has changed. + Emitted when the account display name has changed. - Emitted when the account "enabled" status was changed for one of its + Emitted when the account "enabled" status was changed for one of its services, or for the account globally. - the service which was enabled/disabled, or %NULL if the global + the service which was enabled/disabled, or %NULL if the global enabledness of the account changed. - the new state of the @account. + the new state of the @account. @@ -744,12 +1107,16 @@ enabledness of the account changed. - Use the accessor functions below. + Use the accessor functions below. + + @@ -757,6 +1124,7 @@ enabledness of the account changed. + @@ -764,6 +1132,7 @@ enabledness of the account changed. + @@ -771,6 +1140,7 @@ enabledness of the account changed. + @@ -778,6 +1148,7 @@ enabledness of the account changed. + @@ -785,6 +1156,7 @@ enabledness of the account changed. + @@ -792,6 +1164,7 @@ enabledness of the account changed. + @@ -799,30 +1172,47 @@ enabledness of the account changed. - This callback is invoked when the value of an account configuration setting + This callback is invoked when the value of an account configuration setting changes. If the callback was installed with ag_account_watch_key() then @key is the name of the configuration setting which changed; if it was installed with ag_account_watch_dir() then @key is the same key prefix that was used when installing this callback. + - the #AgAccount. + the #AgAccount. - the name of the key whose value has changed. + the name of the key whose value has changed. - - the user data that was passed when installing this callback. + + the user data that was passed when installing this callback. - + + glib:type-name="AgAccountService" glib:get-type="ag_account_service_get_type" glib:type-struct="AccountServiceClass"> - Opaque structure. Use related accessor functions. + Opaque structure. Use related accessor functions. + - Constructor. If @service is %NULL, the returned object will operate on the + Constructor. If @service is %NULL, the returned object will operate on the global account settings. + - a new #AgAccountService; call g_object_unref() when you don't need + a new #AgAccountService; call g_object_unref() when you don't need this object anymore. - an #AgAccount. + an #AgAccount. - an #AgService supported by @account. + an #AgService supported by @account. @@ -858,24 +1262,34 @@ this object anymore. c:identifier="ag_account_service_settings_iter_next" deprecated="1" deprecated-version="1.4"> - Iterates over the account keys. @iter must be an iterator previously + Iterates over the account keys. @iter must be an iterator previously initialized with ag_account_service_settings_iter_init(). Use ag_account_settings_iter_get_next() instead. + - %TRUE if @key and @value have been set, %FALSE if we there are no + %TRUE if @key and @value have been set, %FALSE if we there are no more account settings to iterate over. - an initialized #AgAccountSettingIter structure. + an initialized #AgAccountSettingIter structure. - a pointer to a string + a pointer to a string receiving the key name. @@ -883,53 +1297,79 @@ receiving the key name. direction="out" caller-allocates="0" transfer-ownership="none"> - a pointer to a pointer to a + a pointer to a pointer to a #GValue, to receive the key value. - - Get the #AgAccount associated with @self. + + Get the #AgAccount associated with @self. + - the underlying #AgAccount. The reference count on + the underlying #AgAccount. The reference count on it is not incremented, so if you need to use it beyond the lifetime of @self, you need to call g_object_ref() on it yourself. - the #AgAccountService. + the #AgAccountService. - Reads the authentication data stored in the account (merging the + Reads the authentication data stored in the account (merging the service-specific settings with the global account settings) and returns an #AgAuthData structure. The method and mechanism are read from the "auth/method" and "auth/mechanism" keys, respectively. The authentication parameters are found under the "auth/&lt;method&gt;/&lt;mechanism&gt;/" group. + - a newly allocated #AgAuthData structure. + a newly allocated #AgAuthData structure. - the #AgAccountService. + the #AgAccountService. - This method should be called only in the context of a handler of the + This method should be called only in the context of a handler of the #AgAccountService::changed signal, and can be used to retrieve the set of changes. + - a newly allocated array of strings describing the + a newly allocated array of strings describing the keys of the fields which have been altered. It must be free'd with g_strfreev(). @@ -938,58 +1378,90 @@ g_strfreev(). - the #AgAccountService. + the #AgAccountService. - - Checks whether the underlying #AgAccount is enabled and the selected + + Checks whether the underlying #AgAccount is enabled and the selected #AgService is enabled on it. If this method returns %FALSE, applications should not try to use this object. + - %TRUE if the service is enabled, %FALSE otherwise. + %TRUE if the service is enabled, %FALSE otherwise. - the #AgAccountService. + the #AgAccountService. - - Get the #AgService associated with @self. + + Get the #AgService associated with @self. + - the underlying #AgService. The reference count on + the underlying #AgService. The reference count on it is not incremented, so if you need to use it beyond the lifetime of @self, you need to call ag_service_ref() on it yourself. - the #AgAccountService. + the #AgAccountService. - Creates a new iterator. This method is useful for language bindings only. + Creates a new iterator. This method is useful for language bindings only. + - an #AgAccountSettingIter. + an #AgAccountSettingIter. - the #AgAccountService. + the #AgAccountService. - enumerate only the settings whose key starts with + enumerate only the settings whose key starts with @key_prefix. @@ -999,11 +1471,17 @@ it is not incremented, so if you need to use it beyond the lifetime of c:identifier="ag_account_service_get_value" deprecated="1" deprecated-version="1.4"> - Gets the value of the configuration setting @key: @value must be a + Gets the value of the configuration setting @key: @value must be a #GValue initialized to the type of the setting. Use ag_account_service_get_variant() instead. + - one of <type>#AgSettingSource</type>: %AG_SETTING_SOURCE_NONE if + one of <type>#AgSettingSource</type>: %AG_SETTING_SOURCE_NONE if the setting is not present, %AG_SETTING_SOURCE_ACCOUNT if the setting comes from the account configuration, or %AG_SETTING_SOURCE_PROFILE if the value comes as predefined in the profile. @@ -1011,18 +1489,24 @@ comes as predefined in the profile. - the #AgAccountService. + the #AgAccountService. - the name of the setting to retrieve. + the name of the setting to retrieve. - an initialized #GValue to receive the setting's value. + an initialized #GValue to receive the setting's value. @@ -1030,9 +1514,15 @@ comes as predefined in the profile. - Gets the value of the configuration setting @key. + Gets the value of the configuration setting @key. + - a #GVariant holding the setting value, or + a #GVariant holding the setting value, or %NULL. The returned #GVariant is owned by the account, and no guarantees are made about its lifetime. If the client wishes to keep it, it should call g_variant_ref() on it. @@ -1040,11 +1530,15 @@ call g_variant_ref() on it. - the #AgAccountService. + the #AgAccountService. - the name of the setting to retrieve. + the name of the setting to retrieve. transfer-ownership="full" optional="1" allow-none="1"> - a pointer to an + a pointer to an #AgSettingSource variable which will tell whether the setting was retrieved from the accounts DB or from a service template. @@ -1064,26 +1560,36 @@ retrieved from the accounts DB or from a service template. c:identifier="ag_account_service_set_value" deprecated="1" deprecated-version="1.4"> - Sets the value of the configuration setting @key to the value @value. + Sets the value of the configuration setting @key to the value @value. If @value is %NULL, then the setting is unset. Use ag_account_service_set_variant() instead. + - the #AgAccountService. + the #AgAccountService. - the name of the setting to change. + the name of the setting to change. - a #GValue holding the new setting's value. + a #GValue holding the new setting's value. @@ -1091,55 +1597,75 @@ If @value is %NULL, then the setting is unset. - Sets the value of the configuration setting @key to the value @value. + Sets the value of the configuration setting @key to the value @value. If @value has a floating reference, the @account will take ownership of it. If @value is %NULL, then the setting is unset. + - the #AgAccountService. + the #AgAccountService. - the name of the setting to change. + the name of the setting to change. - a #GVariant holding the new setting's value. + a #GVariant holding the new setting's value. - Initializes @iter to iterate over the account settings. If @key_prefix is + Initializes @iter to iterate over the account settings. If @key_prefix is not %NULL, only keys whose names start with @key_prefix will be iterated over. After calling this method, one would typically call ag_account_settings_iter_get_next() to read the settings one by one. + - the #AgAccountService. + the #AgAccountService. - an uninitialized #AgAccountSettingIter structure. + an uninitialized #AgAccountSettingIter structure. - enumerate only the settings whose key starts with + enumerate only the settings whose key starts with @key_prefix. @@ -1149,12 +1675,21 @@ ag_account_settings_iter_get_next() to read the settings one by one. version="1.4" writable="1" construct-only="1" - transfer-ownership="none"> - The #AgAccount used by the account service. + transfer-ownership="none" + getter="get_account"> + The #AgAccount used by the account service. - - Whether the account service is currently enabled. The value of + + Whether the account service is currently enabled. The value of this property is %TRUE if and only if the underlying #AgAccount is enabled and the selected #AgService is enabled on it. If this property is %FALSE, applications should not try to use this @@ -1165,8 +1700,11 @@ object. version="1.4" writable="1" construct-only="1" - transfer-ownership="none"> - The #AgService used by the account service. + transfer-ownership="none" + getter="get_service"> + The #AgService used by the account service. @@ -1176,7 +1714,9 @@ object. - Emitted when some setting has changed on the account service. You can + Emitted when some setting has changed on the account service. You can use the ag_account_service_get_changed_fields() method to retrieve the list of the settings which have changed. @@ -1184,13 +1724,17 @@ list of the settings which have changed. - Emitted when the service enabled state changes. + Emitted when the service enabled state changes. - whether the service is enabled. + whether the service is enabled. @@ -1199,12 +1743,18 @@ list of the settings which have changed. - Use the accessor functions below. + Use the accessor functions below. + + @@ -1212,6 +1762,8 @@ list of the settings which have changed. + @@ -1219,6 +1771,8 @@ list of the settings which have changed. + @@ -1226,6 +1780,8 @@ list of the settings which have changed. + @@ -1233,6 +1789,8 @@ list of the settings which have changed. + @@ -1240,6 +1798,8 @@ list of the settings which have changed. + @@ -1247,6 +1807,8 @@ list of the settings which have changed. + @@ -1255,16 +1817,24 @@ list of the settings which have changed. + disguised="1" + opaque="1"> + - Iterator for account settings. + Iterator for account settings. + - the AgAccount to iterate over + the AgAccount to iterate over @@ -1283,13 +1853,18 @@ list of the settings which have changed. - Frees the memory associated with an #AgAccountSettingIter. + Frees the memory associated with an #AgAccountSettingIter. + - a #AgAccountSettingIter. + a #AgAccountSettingIter. @@ -1297,23 +1872,32 @@ list of the settings which have changed. - Iterates over the account keys. @iter must be an iterator previously + Iterates over the account keys. @iter must be an iterator previously initialized with ag_account_settings_iter_init(). + - %TRUE if @key and @value have been set, %FALSE if we there are no + %TRUE if @key and @value have been set, %FALSE if we there are no more account settings to iterate over. - an initialized #AgAccountSettingIter structure. + an initialized #AgAccountSettingIter structure. - a pointer to a string + a pointer to a string receiving the key name. @@ -1321,7 +1905,9 @@ receiving the key name. direction="out" caller-allocates="0" transfer-ownership="none"> - a pointer to a pointer to a + a pointer to a pointer to a #GVariant, to receive the key value. @@ -1331,24 +1917,33 @@ receiving the key name. c:identifier="ag_account_settings_iter_next" deprecated="1" deprecated-version="1.4"> - Iterates over the account keys. @iter must be an iterator previously + Iterates over the account keys. @iter must be an iterator previously initialized with ag_account_settings_iter_init(). Use ag_account_settings_iter_get_next() instead. + - %TRUE if @key and @value have been set, %FALSE if we there are no + %TRUE if @key and @value have been set, %FALSE if we there are no more account settings to iterate over. - an initialized #AgAccountSettingIter structure. + an initialized #AgAccountSettingIter structure. - a pointer to a string + a pointer to a string receiving the key name. @@ -1356,7 +1951,9 @@ receiving the key name. direction="out" caller-allocates="0" transfer-ownership="none"> - a pointer to a pointer to a + a pointer to a pointer to a #GValue, to receive the key value. @@ -1364,175 +1961,299 @@ receiving the key name. - This callback is invoked when storing the account settings is completed. If + This callback is invoked when storing the account settings is completed. If @error is not %NULL, then some error occurred and the data has most likely not been written. + - the #AgAccount. + the #AgAccount. - a #GError, or %NULL. + a #GError, or %NULL. - - the user data that was passed to ag_account_store(). + + the user data that was passed to ag_account_store(). - - An opaque struct returned from ag_account_watch_dir() and + + An opaque struct returned from ag_account_watch_dir() and ag_account_watch_key(). + - These identify the various errors that can occur with methods in + These identify the various errors that can occur with methods in libaccounts-glib that return a #GError. + - there was an error accessing the accounts database + there was an error accessing the accounts database - the account was in the process of being + the account was in the process of being disposed - the account was in the process of being deleted + the account was in the process of being deleted - the database was locked + the database was locked - the requested account was not found + the requested account was not found - an asynchronous store operation is + an asynchronous store operation is already in progress. Since 1.4 - the accounts DB is in read-only mode. Since 1.4 + the accounts DB is in read-only mode. Since 1.4 - Opaque structure. Use related accessor functions. + Opaque structure. Use related accessor functions. + - Get the description of the #AgApplication. + Get the description of the #AgApplication. + - the description of @self. + the description of @self. - the #AgApplication. + the #AgApplication. - Get the #GDesktopAppInfo of the application. + Get the #GDesktopAppInfo of the application. + - the #GDesktopAppInfo for @self, or %NULL if + the #GDesktopAppInfo for @self, or %NULL if failed. - the #AgApplication. + the #AgApplication. - Get the translation domain of the #AgApplication. + Get the translation domain of the #AgApplication. + - the translation domain. + the translation domain. - the #AgApplication. + the #AgApplication. - Get the name of the #AgApplication. + Get the name of the #AgApplication. + - the name of @self. + the name of @self. - the #AgApplication. + the #AgApplication. - Get the description from the application XML file, for the specified + Get the description from the application XML file, for the specified service; if not found, get the service-type description instead. + - usage description of the service. + usage description of the service. - the #AgApplication. + the #AgApplication. - an #AgService. + an #AgService. - Increment the reference count of @self. + Increment the reference count of @self. + - @self. + @self. - the #AgApplication. + the #AgApplication. + + + + + + Check whether the application supports the given service. + + + %TRUE if @service is supported, %FALSE otherwise. + + + + + the #AgApplication. + + an #AgService. + + - Decrements the reference count of @self. The item is destroyed when the + Decrements the reference count of @self. The item is destroyed when the count gets to 0. + - the #AgApplication. + the #AgApplication. @@ -1540,21 +2261,32 @@ count gets to 0. - Opaque structure. Use related accessor functions. + Opaque structure. Use related accessor functions. + - Gets the ID of the credentials associated with this account. + Gets the ID of the credentials associated with this account. + - the credentials ID. + the credentials ID. - the #AgAuthData. + the #AgAuthData. @@ -1562,22 +2294,31 @@ count gets to 0. - Gets the authentication parameters. + Gets the authentication parameters. + - a floating #GVariant of type + a floating #GVariant of type %G_VARIANT_TYPE_VARDICT containing all the authentication parameters. - the #AgAuthData. + the #AgAuthData. - a #GVariant containing + a #GVariant containing client-specific authentication parameters to be added to the returned dictionary. @@ -1585,27 +2326,41 @@ dictionary. - Gets the authentication mechanism. + Gets the authentication mechanism. + - the authentication mechanism. + the authentication mechanism. - the #AgAuthData. + the #AgAuthData. - Gets the authentication method. + Gets the authentication method. + - the authentication method. + the authentication method. - the #AgAuthData. + the #AgAuthData. @@ -1614,10 +2369,15 @@ dictionary. c:identifier="ag_auth_data_get_parameters" deprecated="1" deprecated-version="1.4"> - Gets the authentication parameters. + Gets the authentication parameters. use ag_auth_data_get_login_parameters() instead. + - a #GHashTable + a #GHashTable containing all the authentication parameters. @@ -1626,7 +2386,9 @@ containing all the authentication parameters. - the #AgAuthData. + the #AgAuthData. @@ -1635,20 +2397,27 @@ containing all the authentication parameters. c:identifier="ag_auth_data_insert_parameters" deprecated="1" deprecated-version="1.4"> - Insert the given authentication parameters into the authentication data. If + Insert the given authentication parameters into the authentication data. If some parameters were already present, the parameters passed with this method take precedence. use ag_auth_data_get_login_parameters() instead. + - the #AgAuthData. + the #AgAuthData. - a #GHashTable + a #GHashTable containing the authentication parameters to be added. @@ -1658,33 +2427,55 @@ containing the authentication parameters to be added. - Increment the reference count of @self. + Increment the reference count of @self. + - @self. + @self. - the #AgAuthData. + the #AgAuthData. - Decrements the reference count of @self. The item is destroyed when the + Decrements the reference count of @self. The item is destroyed when the count gets to 0. + - the #AgAuthData. + the #AgAuthData. + + + + + + + + @@ -1698,19 +2489,105 @@ count gets to 0. c:identifier="AG_ERROR_ACCOUNT_NOT_FOUND"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="AgManager" glib:get-type="ag_manager_get_type" glib:type-struct="ManagerClass"> - Opaque structure. Use related accessor functions. + Opaque structure. Use related accessor functions. + - Create a new #AgManager. + Create a new #AgManager. + - an instance of an #AgManager. + an instance of an #AgManager. - Create a new #AgManager with the service type with the name @service_type. + Create a new #AgManager with the service type with the name @service_type. + - an #AgManager instance with the specified service type. + an #AgManager instance with the specified service type. - the name of a service type + the name of a service type - Frees the memory taken by a #GList of #AgAccountId allocated by #AgManager, + Frees the memory taken by a #GList of #AgAccountId allocated by #AgManager, such as by ag_manager_list(), ag_manager_list_enabled() or ag_manager_list_enabled_by_service_type(). + - a #GList returned from a #AgManager + a #GList returned from a #AgManager method which returns account IDs. @@ -1761,6 +2658,7 @@ method which returns account IDs. + @@ -1774,62 +2672,90 @@ method which returns account IDs. - Create a new account. The account is not stored in the database until + Create a new account. The account is not stored in the database until ag_account_store() has successfully returned; the @id field in the #AgAccount structure is also not meant to be valid until the account has been stored. + - a new #AgAccount, or %NULL. + a new #AgAccount, or %NULL. - the #AgManager. + the #AgManager. - name of the provider of the account. + name of the provider of the account. - Get whether the library will abort when a timeout error occurs. + c:identifier="ag_manager_get_abort_on_db_timeout" + glib:get-property="abort-on-db-timeout"> + Get whether the library will abort when a timeout error occurs. + - %TRUE is the library will abort when a timeout error occurs, %FALSE + %TRUE is the library will abort when a timeout error occurs, %FALSE otherwise. - the #AgManager. + the #AgManager. - Instantiates the object representing the account identified by + Instantiates the object representing the account identified by @account_id. + - an #AgAccount, on which the client must call + an #AgAccount, on which the client must call g_object_unref() when it is no longer required, or %NULL if an error occurs. - the #AgManager. + the #AgManager. - the #AgAccountId of the account. + the #AgAccountId of the account. - Gets all the account services. If the @manager was created for a + Gets all the account services. If the @manager was created for a specific service type, only services with that type will be returned. <note> <para> @@ -1840,8 +2766,11 @@ specific service type, only services with that type will be returned. the AgAccountService for that account only. </para> </note> + - a list of + a list of #AgAccountService objects. When done with it, call g_object_unref() on the list elements, and g_list_free() on the container. @@ -1850,45 +2779,67 @@ list elements, and g_list_free() on the container. - the #AgManager. + the #AgManager. - Search for @application_name in the list of applications, and return a new + Search for @application_name in the list of applications, and return a new #AgApplication if a matching application was found. + - a new #AgApplication if one was found, %NULL otherwise + a new #AgApplication if one was found, %NULL otherwise - an #AgManager + an #AgManager - the name of an application to search for + the name of an application to search for - - Get the timeout of database operations for @manager, in milliseconds. + + Get the timeout of database operations for @manager, in milliseconds. + - the timeout (in milliseconds) for database operations. + the timeout (in milliseconds) for database operations. - the #AgManager. + the #AgManager. - Gets all the enabled account services. If the @manager was created for a + Gets all the enabled account services. If the @manager was created for a specific service type, only services with that type will be returned. <note> <para> @@ -1899,8 +2850,11 @@ specific service type, only services with that type will be returned. the AgAccountService for that account only. </para> </note> + - a list of + a list of #AgAccountService objects. When done with it, call g_object_unref() on the list elements, and g_list_free() on the container. @@ -1909,67 +2863,100 @@ list elements, and g_list_free() on the container. - the #AgManager. + the #AgManager. - Loads the provider identified by @provider_name. + Loads the provider identified by @provider_name. + - an #AgProvider, which must be free'd with ag_provider_unref() when + an #AgProvider, which must be free'd with ag_provider_unref() when no longer required. - the #AgManager. + the #AgManager. - the name of the provider. + the name of the provider. - Loads the service identified by @service_name. + Loads the service identified by @service_name. + - an #AgService, which must be free'd with ag_service_unref() when no + an #AgService, which must be free'd with ag_service_unref() when no longer required. - the #AgManager. + the #AgManager. - the name of the service. + the name of the service. - Get the service type for @manager. + c:identifier="ag_manager_get_service_type" + glib:get-property="service-type"> + Get the service type for @manager. + - the name of the service type for the supplied @manager. + the name of the service type for the supplied @manager. - the #AgManager. + the #AgManager. - Lists the accounts. If the #AgManager is created with a specified + Lists the accounts. If the #AgManager is created with a specified #AgManager:service-type, it will return only the accounts supporting this service type. + - a #GList of + a #GList of #AgAccountId representing the accounts. Must be free'd with ag_manager_list_free() when no longer required. @@ -1978,16 +2965,23 @@ ag_manager_list_free() when no longer required. - the #AgManager. + the #AgManager. - Lists the registered applications which support the given service. + Lists the registered applications which support the given service. + - a #GList of all the + a #GList of all the applications which have declared support for the given service or for its service type. @@ -1996,20 +2990,29 @@ service type. - the #AgManager. + the #AgManager. - the #AgService for which we want to get the applications list. + the #AgService for which we want to get the applications list. - Lists the accounts supporting the given service type. + Lists the accounts supporting the given service type. + - a #GList of + a #GList of #AgAccountId representing the accounts. Must be free'd with ag_manager_list_free() when no longer required. @@ -2018,19 +3021,28 @@ ag_manager_list_free() when no longer required. - the #AgManager. + the #AgManager. - the name of the service type to check for. + the name of the service type to check for. - Lists the enabled accounts. + Lists the enabled accounts. + - a #GList of the enabled + a #GList of the enabled #AgAccountId representing the accounts. Must be free'd with ag_manager_list_free() when no longer required. @@ -2039,16 +3051,23 @@ ag_manager_list_free() when no longer required. - the #AgManager. + the #AgManager. - Lists the enabled accounts supporting the given service type. + Lists the enabled accounts supporting the given service type. + - a #GList of the enabled + a #GList of the enabled #AgAccountId representing the accounts. Must be free'd with ag_manager_list_free() when no longer required. @@ -2057,19 +3076,28 @@ ag_manager_list_free() when no longer required. - the #AgManager. + the #AgManager. - the name of the service type to check for. + the name of the service type to check for. - Gets a list of all the installed providers. + Gets a list of all the installed providers. + - a list of #AgProvider, + a list of #AgProvider, which must be then free'd with ag_provider_list_free(). @@ -2077,16 +3105,23 @@ which must be then free'd with ag_provider_list_free(). - the #AgManager. + the #AgManager. - Gets a list of all the installed service types. + Gets a list of all the installed service types. + - a list of + a list of #AgServiceType, which must be free'd with ag_service_type_list_free() when no longer required. @@ -2095,17 +3130,24 @@ no longer required. - the #AgManager. + the #AgManager. - Gets a list of all the installed services. + Gets a list of all the installed services. If the #AgManager was created with a specified #AgManager:service_type it will return only the installed services supporting that service type. + - a list of #AgService, + a list of #AgService, which must be free'd with ag_service_list_free() when no longer required. @@ -2113,17 +3155,55 @@ which must be free'd with ag_service_list_free() when no longer required. - the #AgManager. + the #AgManager. + + + + + + Get the list of services that are supported by @application. + + + a #GList of #AgService +items representing all the services which are supported. Must be free'd with +ag_service_list_free(). + + + + + + + the #AgManager. + + a #AgApplication. + + - Gets a list of all the installed services where the service type name is + Gets a list of all the installed services where the service type name is @service_type. + - a list of #AgService, + a list of #AgService, which must be free'd with ag_service_list_free() when no longer required. @@ -2131,11 +3211,15 @@ which must be free'd with ag_service_list_free() when no longer required. - the #AgManager. + the #AgManager. - the type of the service. + the type of the service. @@ -2143,96 +3227,147 @@ which must be free'd with ag_service_list_free() when no longer required. - Instantiates the object representing the account identified by + Instantiates the object representing the account identified by @account_id. + - an #AgAccount, on which the client must call + an #AgAccount, on which the client must call g_object_unref() when it is no longer required, or %NULL if an error occurs. - the #AgManager. + the #AgManager. - the #AgAccountId of the account. + the #AgAccountId of the account. - Instantiate the service type with the name @service_type. + Instantiate the service type with the name @service_type. + - an #AgServiceType, which must be free'd with + an #AgServiceType, which must be free'd with ag_service_type_unref() when no longer required. - the #AgManager. + the #AgManager. - the name of the service type. + the name of the service type. - Tells libaccounts whether it should make the client application abort when + c:identifier="ag_manager_set_abort_on_db_timeout" + glib:set-property="abort-on-db-timeout"> + Tells libaccounts whether it should make the client application abort when a timeout error occurs. The default is %FALSE. + - the #AgManager. + the #AgManager. - whether to abort when a DB timeout occurs. + whether to abort when a DB timeout occurs. - - Sets the timeout for database operations. This tells the library how long + + Sets the timeout for database operations. This tells the library how long it is allowed to block while waiting for a locked DB to become accessible. Higher values mean a higher chance of successful reads, but also mean that the execution might be blocked for a longer time. The default is 5 seconds. + - the #AgManager. + the #AgManager. - the new timeout, in milliseconds. + the new timeout, in milliseconds. - Whether to abort the application when a database timeout occurs. + transfer-ownership="none" + setter="set_abort_on_db_timeout" + getter="get_abort_on_db_timeout" + default-value="FALSE"> + Whether to abort the application when a database timeout occurs. - - Timeout for database operations, in milliseconds. + + Timeout for database operations, in milliseconds. - If the service type is set, certain operations on the #AgManager, such + transfer-ownership="none" + getter="get_service_type" + default-value="NULL"> + If the service type is set, certain operations on the #AgManager, such as ag_manager_list() and ag_manager_list_services(), will be restricted to only affect accounts or services with that service type. @@ -2240,8 +3375,11 @@ to only affect accounts or services with that service type. - Whether to use D-Bus for inter-process change notification. Setting this + transfer-ownership="none" + default-value="TRUE"> + Whether to use D-Bus for inter-process change notification. Setting this property to %FALSE causes libaccounts not to emit the change notification signals, and also not react to changes made by other processes. Disabling D-Bus is only meant to be used for specific cases, @@ -2255,7 +3393,9 @@ such as maintenance programs. - Emitted when a new account has been created; note that the account must + Emitted when a new account has been created; note that the account must have been stored in the database: the signal is not emitted just in response to ag_manager_create_account(). @@ -2263,13 +3403,17 @@ response to ag_manager_create_account(). - the #AgAccountId of the account that has been created. + the #AgAccountId of the account that has been created. - Emitted when an account has been deleted. + Emitted when an account has been deleted. This signal is redundant with #AgAccount::deleted, but it is convenient to provide full change notification with #AgManager. @@ -2277,13 +3421,17 @@ to provide full change notification with #AgManager. - the #AgAccountId of the account that has been deleted. + the #AgAccountId of the account that has been deleted. - Emitted when particular service of an account has been updated. + Emitted when particular service of an account has been updated. This signal is redundant with #AgAccount::deleted, but it is convenient to provide full change notification with #AgManager. @@ -2291,13 +3439,17 @@ to provide full change notification with #AgManager. - the #AgAccountId of the account that has been update. + the #AgAccountId of the account that has been update. - If the manager has been created with ag_manager_new_for_service_type(), + If the manager has been created with ag_manager_new_for_service_type(), this signal will be emitted when an account (identified by @account_id) has been modified in such a way that the application might be interested to start or stop using it: the "enabled" flag on the account or in some @@ -2311,7 +3463,9 @@ ag_manager_list_enabled() to get the current state. - the #AgAccountId of the account that has been enabled. + the #AgAccountId of the account that has been enabled. @@ -2320,12 +3474,16 @@ ag_manager_list_enabled() to get the current state. - Use the accessor functions below. + Use the accessor functions below. + + @@ -2341,6 +3499,7 @@ ag_manager_list_enabled() to get the current state. + @@ -2348,6 +3507,7 @@ ag_manager_list_enabled() to get the current state. + @@ -2355,6 +3515,7 @@ ag_manager_list_enabled() to get the current state. + @@ -2362,6 +3523,7 @@ ag_manager_list_enabled() to get the current state. + @@ -2369,6 +3531,7 @@ ag_manager_list_enabled() to get the current state. + @@ -2376,45 +3539,68 @@ ag_manager_list_enabled() to get the current state. + - + + - Opaque structure. Use related accessor functions. + Opaque structure. Use related accessor functions. + - Get the description of the #AgProvider. + Get the description of the #AgProvider. + - the description of @provider, or %NULL upon failure. + the description of @provider, or %NULL upon failure. - the #AgProvider. + the #AgProvider. - Get the display name of the #AgProvider. + Get the display name of the #AgProvider. + - the display name of @provider. + the display name of @provider. - the #AgProvider. + the #AgProvider. @@ -2422,75 +3608,110 @@ ag_manager_list_enabled() to get the current state. - Get a regular expression matching all domains where this provider's accounts + Get a regular expression matching all domains where this provider's accounts can be used. + - a regular expression matching the domain names. + a regular expression matching the domain names. - the #AgProvider. + the #AgProvider. - Gets the contents of the XML provider file. The buffer returned in @contents + Gets the contents of the XML provider file. The buffer returned in @contents should not be modified or freed, and is guaranteed to be valid as long as @provider is referenced. If some error occurs, @contents is set to %NULL. + - the #AgProvider. + the #AgProvider. - location to receive the pointer to the file contents. + location to receive the pointer to the file contents. - Get the translation domain of the #AgProvider. + Get the translation domain of the #AgProvider. + - the translation domain. + the translation domain. - the #AgProvider. + the #AgProvider. - Get the icon name of the #AgProvider. + Get the icon name of the #AgProvider. + - the icon_name. + the icon_name. - the #AgProvider. + the #AgProvider. - Get the name of the #AgProvider. + Get the name of the #AgProvider. + - the name of @provider. + the name of @provider. - the #AgProvider. + the #AgProvider. @@ -2498,18 +3719,25 @@ If some error occurs, @contents is set to %NULL. - Get the name of the account plugin which manages all accounts created from + Get the name of the account plugin which manages all accounts created from this #AgProvider. Some platforms might find it useful to store plugin names in the provider XML files, especially when the same plugin can work for different providers. + - the plugin name for @provider, or %NULL if a plugin name is not + the plugin name for @provider, or %NULL if a plugin name is not defined. - the #AgProvider. + the #AgProvider. @@ -2517,18 +3745,51 @@ defined. - Tell whether the provider doesn't support creating more than one account. + Tell whether the provider doesn't support creating more than one account. Note that libaccounts itself does not enforce preventing the creation of multiple accounts when this flag is set: the flag is only informative, and its implementation is left to the client. + - %FALSE if multiple accounts can be created from this provider, + %FALSE if multiple accounts can be created from this provider, %TRUE otherwise. - the #AgProvider. + the #AgProvider. + + + + + + Get list of tags specified for the #AgProvider. + + + #GList of tags for +@provider. The list must be freed with g_list_free(). Entries are owned by +the #AgProvider type and must not be free'd. + + + + + + + the #AgProvider. @@ -2536,58 +3797,84 @@ its implementation is left to the client. - Check whether @domain is supported by this provider, by matching it with the + Check whether @domain is supported by this provider, by matching it with the regex returned by ag_provider_get_domains_regex(). If the provider does not define a regular expression to match the supported domains, this function will return %FALSE. + - %TRUE if the given domain is supported, %FALSE otherwise. + %TRUE if the given domain is supported, %FALSE otherwise. - the #AgProvider. + the #AgProvider. - a domain name. + a domain name. - Adds a reference to @provider. + Adds a reference to @provider. + - @provider. + @provider. - the #AgProvider. + the #AgProvider. - Used to unreference the #AgProvider structure. + Used to unreference the #AgProvider structure. + - the #AgProvider. + the #AgProvider. - Frees the list @list. + Frees the list @list. + - a #GList of providers returned by some + a #GList of providers returned by some function of this library. @@ -2598,135 +3885,202 @@ function of this library. - Opaque structure. Use related accessor functions. + Opaque structure. Use related accessor functions. + - Gets the description of the #AgService. + Gets the description of the #AgService. + - the description of @service, or %NULL upon failure. + the description of @service, or %NULL upon failure. - the #AgService. + the #AgService. - Gets the display name of the #AgService. + Gets the display name of the #AgService. + - the display name of @service. + the display name of @service. - the #AgService. + the #AgService. - Gets the contents of the XML service file. The buffer returned in @contents + Gets the contents of the XML service file. The buffer returned in @contents should not be modified or freed, and is guaranteed to be valid as long as @service is referenced. If @data_offset is not %NULL, it is set to the offset where the &lt;type_data&gt; element can be found. If some error occurs, @contents is set to %NULL. + - the #AgService. + the #AgService. - location to receive the pointer to the file contents. + location to receive the pointer to the file contents. - pointer to receive the offset of the type data. + pointer to receive the offset of the type data. - Gets the translation domain of the #AgService. + Gets the translation domain of the #AgService. + - the name of the translation catalog. + the name of the translation catalog. - the #AgService. + the #AgService. - Gets the icon name of the #AgService. + Gets the icon name of the #AgService. + - the name of the icon of @service. + the name of the icon of @service. - the #AgService. + the #AgService. - Gets the name of the #AgService. + Gets the name of the #AgService. + - the name of @service. + the name of @service. - the #AgService. + the #AgService. - Gets the provider name of the #AgService. + Gets the provider name of the #AgService. + - the name of the provider of @service. + the name of the provider of @service. - the #AgService. + the #AgService. - Gets the service type of the #AgService. + Gets the service type of the #AgService. + - the type of @service. + the type of @service. - the #AgService. + the #AgService. - Get list of tags specified for the #AgService. If the service has not + Get list of tags specified for the #AgService. If the service has not defined tags, tags from the service type will be returned. + - #GList of tags for + #GList of tags for @service. The list must be freed with g_list_free(). Entries are owned by the #AgService type and must not be free'd. @@ -2735,61 +4089,89 @@ the #AgService type and must not be free'd. - the #AgService. + the #AgService. - Checks if the #AgService has the requested tag. + Checks if the #AgService has the requested tag. + - TRUE if #AgService has the tag, FALSE otherwise + TRUE if #AgService has the tag, FALSE otherwise - the #AgService. + the #AgService. - tag to check for. + tag to check for. - Adds a reference to @service. + Adds a reference to @service. + - @service. + @service. - the #AgService. + the #AgService. - Used to unreference the #AgService structure. + Used to unreference the #AgService structure. + - the #AgService. + the #AgService. - Frees the list @list. + Frees the list @list. + - a #GList of services returned by some + a #GList of services returned by some function of this library. @@ -2800,108 +4182,168 @@ function of this library. - Opaque structure. Use related accessor functions. + Opaque structure. Use related accessor functions. + - Get the description of the #AgServiceType. + Get the description of the #AgServiceType. + - the description of @service_type, or %NULL upon failure. + the description of @service_type, or %NULL upon failure. - the #AgServiceType. + the #AgServiceType. - Get the display name of the #AgServiceType. + Get the display name of the #AgServiceType. + - the display name of @service_type. + the display name of @service_type. - the #AgServiceType. + the #AgServiceType. - Gets the contents of the XML service type file. The buffer returned in + Gets the contents of the XML service type file. The buffer returned in @contents should not be modified or freed, and is guaranteed to be valid as long as @service_type is referenced. If some error occurs, @contents is set to %NULL. + - the #AgServiceType. + the #AgServiceType. - location to receive the pointer to the file contents. + location to receive the pointer to the file contents. - location to receive the length of the file, in bytes. + location to receive the length of the file, in bytes. - Get the translation domain of the #AgServiceType. + Get the translation domain of the #AgServiceType. + - the translation domain. + the translation domain. - the #AgServiceType. + the #AgServiceType. - Get the icon name of the #AgServiceType. + Get the icon name of the #AgServiceType. + - the name of the icon of @service_type. + the name of the icon of @service_type. - the #AgServiceType. + the #AgServiceType. - Get the name of the #AgServiceType. + Get the name of the #AgServiceType. + - the name of @service_type. + the name of @service_type. - the #AgServiceType. + the #AgServiceType. - Get list of tags specified for the #AgServiceType. + Get list of tags specified for the #AgServiceType. + - #GList of tags for + #GList of tags for @service_type. The list must be freed with g_list_free(). Entries are owned by the #AgServiceType type and must not be free'd. @@ -2911,61 +4353,93 @@ The list must be freed with g_list_free(). Entries are owned by the - the #AgServiceType. + the #AgServiceType. - Check if the #AgServiceType has the requested tag. + Check if the #AgServiceType has the requested tag. + - TRUE if the #AgServiceType has the tag, FALSE otherwise + TRUE if the #AgServiceType has the tag, FALSE otherwise - the #AgServiceType. + the #AgServiceType. - the tag to check for. + the tag to check for. - Adds a reference to @service_type. + Adds a reference to @service_type. + - @service_type. + @service_type. - the #AgServiceType. + the #AgServiceType. - Used to unreference the #AgServiceType structure. + Used to unreference the #AgServiceType structure. + - the #AgServiceType. + the #AgServiceType. - Frees the list @list. + Frees the list @list. + - a #GList of service types returned by + a #GList of service types returned by some function of this library, such as ag_manager_list_service_types(). @@ -2975,43 +4449,323 @@ some function of this library, such as ag_manager_list_service_types(). - The source of a setting on a #AgAccount. + The source of a setting on a #AgAccount. + - the setting is not present + the setting is not present - the setting comes from the current account + the setting comes from the current account configuration - the setting comes from the predefined profile + the setting comes from the predefined profile + Return the libaccounts-glib error domain. + the libaccounts-glib error domain. + + An #AgAccount is an object which represents an account. It provides a +method for enabling/disabling the account and methods for editing the +account settings. + +Accounts are created by #AgManager with ag_manager_create_account(), and +deleted by #AgAccount with ag_account_delete(). These operations, and any +other operations which modify the account settings, must be followed by +ag_account_store() before the changes are committed to the database. +<example id="example-create-new-AgAccount"> +<title>Creating a new <structname>AgAccount</structname></title> +<programlisting> +GMainLoop *main_loop = NULL; + +gboolean account_cleanup_idle (gpointer user_data) +{ + AgManager *manager; + AgAccount *account = AG_ACCOUNT (user_data); + manager = ag_account_get_manager (account); + + g_object_unref (account); + g_object_unref (manager); + + g_main_loop_quit (main_loop); + + return FALSE; +} + +void account_stored_cb (AgAccount *account, + const GError *error, + gpointer user_data) +{ + AgManager *manager = AG_MANAGER (user_data); + + if (error != NULL) + { + g_warning ("Account with ID '%u' failed to store, with error: %s", + account->id, + error->message); + } + else + { + g_print ("Account stored with ID: %u", account->id); + } + + /&ast; Clean up in an idle callback. &ast;/ + g_idle_add (account_cleanup_idle, account); + g_main_loop_run (main_loop); +} + +void store_account (void) +{ + AgManager *manager; + GList *providers; + const gchar *provider_name; + AgAccount *account; + + main_loop = g_main_loop_new (NULL, FALSE); + manager = ag_manager_new (); + providers = ag_manager_list_providers (manager); + g_assert (providers != NULL); + provider_name = ag_provider_get_name ((AgProvider *) providers->data); + account = ag_manager_create_account (manager, provider_name); + + ag_provider_list_free (providers); + + /&ast; The account is not valid until it has been stored. &ast;/ + ag_account_store (account, account_stored_cb, (gpointer) manager); +} +</programlisting> +</example> + + + The #AgAccountService object provides access to the account settings for a +specific service type. It is meant to be easier to use than the #AgAccount +class because it hides the complexity of the account structure and gives +access to only the limited subset of account settings which are relevant to +a service. + +To get an #AgAccountService one can use the #AgManager methods +ag_manager_get_account_services() or +ag_manager_get_enabled_account_services(), which both return a #GList of +account services. Note that if the #AgManager was instantiated for a +specific service type, these lists will contain only those account services +matching that service type. +Another way to get an #AgAccountService is to instantiate one using +ag_account_service_new(): this is useful if one already has an #AgAccount +instance. + +This is intended to be a convenient wrapper over the accounts settings +specific for a service; as such, it doesn't offer all the editing +possibilities offered by the #AgAccount class, such as enabling the service +itself: these operations should ideally not be performed by consumer +applications, but by the account editing UI only. + +<example> +<title>Querying available e-mail services</title> + <programlisting> +AgManager *manager; +GList *services, *list; + +// Instantiate an account manager interested in e-mail services only. +manager = ag_manager_new_for_service_type ("e-mail"); + +// Get the list of enabled AgAccountService objects of type e-mail. +services = ag_manager_get_enabled_account_services (manager); + +// Loop through the account services and do something useful with them. +for (list = services; list != NULL; list = list->next) +{ + AgAccountService *service = AG_ACCOUNT_SERVICE (list->data); + GVariant *v_server, *v_port, *v_username; + gchar *server = NULL, *username = NULL; + gint port; + AgAccount *account; + + v_server = ag_account_service_get_variant (service, "pop3/hostname", NULL); + if (v_server != NULL) + server = g_variant_dup_string (v_server, NULL); + + v_port = ag_account_service_get_variant (service, "pop3/port", NULL); + if (v_port != NULL) + port = g_variant_get_int16 (&v_port); + + // Suppose that the e-mail address is stored in the global account + // settings; let's get it from there: + account = ag_account_service_get_account (service); + ag_account_select_service (NULL); + v_username = ag_account_get_variant (account, "username", NULL); + if (v_username != NULL) + username = g_variant_dup_string (&v_username); + + ... + + g_free (username); + g_free (server); +} + </programlisting> +</example> + +<note> + <para> +User applications (with the notable exception of the accounts editing +application) should never use account services which are not enabled, and +should stop using an account when the account service becomes disabled. The +latter can be done by connecting to the #AgAccountService::changed signal +and checking if ag_account_service_get_enabled() still returns %TRUE. +Note that if the account gets deleted, it will always get disabled first; +so, there is no need to connect to the #AgAccount::deleted signal; one can +just monitor the #AgAccountService::changed signal. + </para> +</note> + + + The #AgApplication structure holds information on the client applications +registered with libaccounts. +It is instantiated by #AgManager with ag_manager_get_application() and +ag_manager_list_applications_by_service(), and destroyed with +ag_application_unref(). + +<example> +<title>Querying application names for an +<structname>AgService</structname></title> +<programlisting> +AgManager *manager; +GList *services, *applications; +AgService *service; + +manager = ag_manager_new (); +services = ag_manager_list_services (manager); +g_assert (services != NULL); +service = (AgService *) services->data; +applications = ag_manager_list_applications_by_service (manager, service); + +g_print ("Service type: %s\n", ag_service_get_name (service)); +for (applications; applications != NULL; applications = applications->next) +{ + const gchar *application_name = ag_application_get_name ((AgApplication *) applications->data); + g_print (" Application name: %s\n", application_name); +} +</programlisting> +</example> + + + The #AgAuthData structure holds information on the authentication +parameters used by an account. It is created by +ag_account_service_get_auth_data(), and can be destroyed with +ag_auth_data_unref(). + + + The #AgManager is the main object in this library. Use it to create an +#AgAccount, and to instantiate boxed types such as #AgProvider, +#AgApplication and #AgService. + +#AgManager can be instantiated with a set service type with +ag_manager_new_for_service_type(), which restricts some future operations on +the manager, such as ag_manager_list() or ag_manager_list_services(), to +only affect accounts or services with the set service type. + +Lists of objects instantiated by the manager can be freed with the +corresponding functions, such as ag_manager_list_free() for the #GList of +#AgAccountId returned from ag_manager_list(), or ag_service_list_free() for +the #GList of #AgService returned from ag_manager_list_services(). + + + The #AgProvider structure represents an account provider. The structure is +not directly exposed to applications, but its fields are accessible via +getter methods. It can be instantiated by #AgManager with +ag_manager_get_provider() or ag_manager_list_providers(). +The structure is reference counted. One must use ag_provider_unref() when +done with it. + +See the <link linkend="example-create-new-AgAccount">example of creating a +new <structname>AgAccount</structname></link> to see how #AgProvider can be +used. + + + The #AgService structure represents a service. The structure is not directly +exposed to applications, but its fields are accessible via getter methods. +It is instantiated by #AgManager, with ag_manager_get_service(), +ag_manager_list_services() or ag_manager_list_services_by_type(). +The structure is reference counted. One must use ag_service_unref() when +done with it. + + + The #AgServiceType structure represents a service type. The structure is +not directly exposed to applications, but its fields are accessible via +getter methods. +It is instantiated by #AgManager with ag_manager_list_service_types() or +ag_manager_load_service_type(). Additonally, #AgManager can be instantiated +with a set service type with ag_manager_new_for_service_type(), which +restricts some future operations on the manager, such as ag_manager_list() +or ag_manager_list_services(), to only affect accounts or services with the +set service type. +The structure is reference counted. One must use ag_service_type_unref() +when done with it. + + Return the libaccounts-glib error domain. + + the libaccounts-glib error domain. - Frees the list @list. + Frees the list @list. + - a #GList of providers returned by some + a #GList of providers returned by some function of this library. @@ -3022,13 +4776,18 @@ function of this library. - Frees the list @list. + Frees the list @list. + - a #GList of services returned by some + a #GList of services returned by some function of this library. @@ -3039,13 +4798,19 @@ function of this library. - Frees the list @list. + Frees the list @list. + - a #GList of service types returned by + a #GList of service types returned by some function of this library, such as ag_manager_list_service_types(). diff --git a/girs/AccountsService-1.0.gir b/girs/AccountsService-1.0.gir index 3ed4401f4..f66309c91 100644 --- a/girs/AccountsService-1.0.gir +++ b/girs/AccountsService-1.0.gir @@ -1639,7 +1639,7 @@ daemon. Returns the user manager singleton instance. Calling this function will + line="2705">Returns the user manager singleton instance. Calling this function will automatically being loading the user list if it isn't loaded already. The #ActUserManager:is-loaded property will be set to %TRUE when the users are finished loading and then act_user_manager_list_users() can be called. @@ -1648,7 +1648,7 @@ are finished loading and then act_user_manager_list_users() can be called. user manager object + line="2713">user manager object @@ -1716,26 +1716,26 @@ are finished loading and then act_user_manager_list_users() can be called. c:identifier="act_user_manager_activate_user_session"> Activate the session for a given user. + line="413">Activate the session for a given user. whether successfully activated + line="420">whether successfully activated the user manager + line="415">the user manager the user to activate + line="416">the user to activate @@ -1745,26 +1745,26 @@ are finished loading and then act_user_manager_list_users() can be called. throws="1"> Caches a user account so it shows up via act_user_manager_list_users(). + line="2893">Caches a user account so it shows up via act_user_manager_list_users(). user object + line="2901">user object a #ActUserManager + line="2895">a #ActUserManager a user name + line="2896">a user name @@ -1774,7 +1774,7 @@ are finished loading and then act_user_manager_list_users() can be called. version="0.6.27"> Asynchronously caches a user account so it shows up via + line="2934">Asynchronously caches a user account so it shows up via act_user_manager_list_users(). For more details, see act_user_manager_cache_user(), which @@ -1788,13 +1788,13 @@ is the synchronous version of this call. a #ActUserManager + line="2936">a #ActUserManager a unix user name + line="2937">a unix user name allow-none="1"> optional #GCancellable object, + line="2938">optional #GCancellable object, %NULL to ignore @@ -1815,7 +1815,7 @@ is the synchronous version of this call. closure="3"> a #GAsyncReadyCallback to call + line="2940">a #GAsyncReadyCallback to call when the request is satisfied @@ -1825,7 +1825,7 @@ is the synchronous version of this call. allow-none="1"> the data to pass to @callback + line="2942">the data to pass to @callback @@ -1836,7 +1836,7 @@ is the synchronous version of this call. throws="1"> Finishes an asynchronous user caching. + line="2979">Finishes an asynchronous user caching. See act_user_manager_cache_user_async(). user object + line="2989">user object a #ActUserManager + line="2981">a #ActUserManager a #GAsyncResult + line="2982">a #GAsyncResult @@ -1865,20 +1865,20 @@ See act_user_manager_cache_user_async(). Check whether the user can switch to another session. + line="384">Check whether the user can switch to another session. whether we can switch to another session + line="390">whether we can switch to another session the user manager + line="386">the user manager @@ -1888,38 +1888,38 @@ See act_user_manager_cache_user_async(). throws="1"> Creates a user account on the system. + line="2744">Creates a user account on the system. user object + line="2754">user object a #ActUserManager + line="2746">a #ActUserManager a unix user name + line="2747">a unix user name a unix GECOS value + line="2748">a unix GECOS value a #ActUserAccountType + line="2749">a #ActUserAccountType @@ -1929,7 +1929,7 @@ See act_user_manager_cache_user_async(). version="0.6.27"> Asynchronously creates a user account on the system. + line="2801">Asynchronously creates a user account on the system. For more details, see act_user_manager_create_user(), which is the synchronous version of this call. @@ -1942,25 +1942,25 @@ is the synchronous version of this call. a #ActUserManager + line="2803">a #ActUserManager a unix user name + line="2804">a unix user name a unix GECOS value + line="2805">a unix GECOS value a #ActUserAccountType + line="2806">a #ActUserAccountType allow-none="1"> optional #GCancellable object, + line="2807">optional #GCancellable object, %NULL to ignore @@ -1981,7 +1981,7 @@ is the synchronous version of this call. closure="5"> a #GAsyncReadyCallback to call + line="2809">a #GAsyncReadyCallback to call when the request is satisfied @@ -1991,7 +1991,7 @@ is the synchronous version of this call. allow-none="1"> the data to pass to @callback + line="2811">the data to pass to @callback @@ -2002,7 +2002,7 @@ is the synchronous version of this call. throws="1"> Finishes an asynchronous user creation. + line="2854">Finishes an asynchronous user creation. See act_user_manager_create_user_async(). user object + line="2864">user object a #ActUserManager + line="2856">a #ActUserManager a #GAsyncResult + line="2857">a #GAsyncResult @@ -2033,32 +2033,32 @@ See act_user_manager_create_user_async(). throws="1"> Deletes a user account on the system. + line="3144">Deletes a user account on the system. %TRUE if the user account was successfully deleted + line="3153">%TRUE if the user account was successfully deleted a #ActUserManager + line="3146">a #ActUserManager an #ActUser object + line="3147">an #ActUser object %TRUE to delete the users home directory + line="3148">%TRUE to delete the users home directory @@ -2068,7 +2068,7 @@ See act_user_manager_create_user_async(). version="0.6.27"> Asynchronously deletes a user account from the system. + line="3184">Asynchronously deletes a user account from the system. For more details, see act_user_manager_delete_user(), which is the synchronous version of this call. @@ -2081,19 +2081,19 @@ is the synchronous version of this call. a #ActUserManager + line="3186">a #ActUserManager a #ActUser object + line="3187">a #ActUser object %TRUE to delete the users home directory + line="3188">%TRUE to delete the users home directory allow-none="1"> optional #GCancellable object, + line="3189">optional #GCancellable object, %NULL to ignore @@ -2114,7 +2114,7 @@ is the synchronous version of this call. closure="4"> a #GAsyncReadyCallback to call + line="3191">a #GAsyncReadyCallback to call when the request is satisfied @@ -2124,7 +2124,7 @@ is the synchronous version of this call. allow-none="1"> the data to pass to @callback + line="3193">the data to pass to @callback @@ -2135,7 +2135,7 @@ is the synchronous version of this call. throws="1"> Finishes an asynchronous user account deletion. + line="3231">Finishes an asynchronous user account deletion. See act_user_manager_delete_user_async(). %TRUE if the user account was successfully deleted + line="3241">%TRUE if the user account was successfully deleted a #ActUserManager + line="3233">a #ActUserManager a #GAsyncResult + line="3234">a #GAsyncResult @@ -2164,7 +2164,7 @@ See act_user_manager_delete_user_async(). Retrieves a pointer to the #ActUser object for the login @username + line="1956">Retrieves a pointer to the #ActUser object for the login @username from @manager. Trying to use this object before its #ActUser:is-loaded property is %TRUE will result in undefined behavior. @@ -2173,20 +2173,20 @@ behavior. #ActUser object + line="1966">#ActUser object the manager to query. + line="1958">the manager to query. the login name of the user to get. + line="1959">the login name of the user to get. @@ -2195,7 +2195,7 @@ behavior. c:identifier="act_user_manager_get_user_by_id"> Retrieves a pointer to the #ActUser object for the user with the + line="2073">Retrieves a pointer to the #ActUser object for the user with the given uid from @manager. Trying to use this object before its #ActUser:is-loaded property is %TRUE will result in undefined behavior. @@ -2204,20 +2204,20 @@ behavior. #ActUser object + line="2083">#ActUser object the manager to query. + line="2075">the manager to query. the uid of the user to get. + line="2076">the uid of the user to get. @@ -2226,20 +2226,20 @@ behavior. c:identifier="act_user_manager_goto_login_session"> Switch the display to the login manager. + line="337">Switch the display to the login manager. whether successful or not + line="343">whether successful or not the user manager + line="339">the user manager @@ -2247,13 +2247,13 @@ behavior. Get a list of system user accounts + line="2132">Get a list of system user accounts List of #ActUser objects + line="2138">List of #ActUser objects @@ -2262,7 +2262,7 @@ behavior. a #ActUserManager + line="2134">a #ActUserManager @@ -2270,20 +2270,20 @@ behavior. Check whether or not the accounts service is running. + line="2728">Check whether or not the accounts service is running. whether or not accounts service is running + line="2734">whether or not accounts service is running a #ActUserManager + line="2730">a #ActUserManager @@ -2293,7 +2293,7 @@ behavior. throws="1"> Releases all metadata about a user account, including icon, + line="3018">Releases all metadata about a user account, including icon, language and session. If the user account is from a remote server and the user has never logged in before, then that account will no longer show up in ListCachedUsers() output. @@ -2302,20 +2302,20 @@ account will no longer show up in ListCachedUsers() output. %TRUE if successful, otherwise %FALSE + line="3029">%TRUE if successful, otherwise %FALSE a #ActUserManager + line="3020">a #ActUserManager a user name + line="3021">a user name @@ -2362,7 +2362,7 @@ account will no longer show up in ListCachedUsers() output. throws="1"> Finishes an asynchronous user uncaching. + line="3104">Finishes an asynchronous user uncaching. See act_user_manager_uncache_user_async(). %TRUE if the user account was successfully uncached + line="3114">%TRUE if the user account was successfully uncached a #ActUserManager + line="3106">a #ActUserManager a #GAsyncResult + line="3107">a #GAsyncResult @@ -2418,7 +2418,7 @@ See act_user_manager_uncache_user_async(). Emitted when a user is added to the user manager. + line="2429">Emitted when a user is added to the user manager. @@ -2426,7 +2426,7 @@ See act_user_manager_uncache_user_async(). the #ActUser that was added + line="2432">the #ActUser that was added @@ -2434,7 +2434,7 @@ See act_user_manager_uncache_user_async(). One of the users has changed + line="2474">One of the users has changed @@ -2442,7 +2442,7 @@ See act_user_manager_uncache_user_async(). the #ActUser that changed + line="2477">the #ActUser that changed @@ -2450,7 +2450,7 @@ See act_user_manager_uncache_user_async(). One of the users has logged in or out. + line="2459">One of the users has logged in or out. @@ -2458,7 +2458,7 @@ See act_user_manager_uncache_user_async(). the #ActUser that changed login status + line="2462">the #ActUser that changed login status @@ -2466,7 +2466,7 @@ See act_user_manager_uncache_user_async(). Emitted when a user is removed from the user manager. + line="2444">Emitted when a user is removed from the user manager. @@ -2474,7 +2474,7 @@ See act_user_manager_uncache_user_async(). the #ActUser that was removed + line="2447">the #ActUser that was removed diff --git a/girs/Adw-1.gir b/girs/Adw-1.gir index 263582053..bf222e5bd 100644 --- a/girs/Adw-1.gir +++ b/girs/Adw-1.gir @@ -221,14 +221,15 @@ values: * [property@AboutDialog:application-icon] is set from the `<id>` * [property@AboutDialog:application-name] is set from the `<name>` -* [property@AboutDialog:developer-name] is set from the `<developer_name>` +* [property@AboutDialog:developer-name] is set from the `<name>` within + `<developer>` * [property@AboutDialog:version] is set from the version of the latest release * [property@AboutDialog:website] is set from the `<url type="homepage">` * [property@AboutDialog:support-url] is set from the `<url type="help">` * [property@AboutDialog:issue-url] is set from the `<url type="bugtracker">` -* [property@AboutDialog:license-type] is set from the `<project_license>` - If the license type retrieved from AppStream is not listed in - [enum@Gtk.License], it will be set to `GTK_LICENCE_CUSTOM`. +* [property@AboutDialog:license-type] is set from the `<project_license>`. + If the license type retrieved from AppStream is not listed in + [enum@Gtk.License], it will be set to `GTK_LICENCE_CUSTOM`. If @release_notes_version is not `NULL`, [property@AboutDialog:release-notes-version] is set to match it, while @@ -238,7 +239,7 @@ description for that version. the newly created `AdwAboutDialog` + line="1983">the newly created `AdwAboutDialog` @@ -264,7 +265,7 @@ description for that version. version="1.5"> Adds a section to the Acknowledgements page. + line="3101">Adds a section to the Acknowledgements page. This can be used to acknowledge additional people and organizations for their non-development contributions - for example, backers in a crowdfunded @@ -289,7 +290,7 @@ See also: an about dialog + line="3103">an about dialog the section name + line="3104">the section name the list of names + line="3105">the list of names @@ -316,7 +317,7 @@ See also: version="1.5"> Adds an extra section to the Credits page. + line="3058">Adds an extra section to the Credits page. Extra sections are displayed below the standard categories. @@ -339,7 +340,7 @@ See also: an about dialog + line="3060">an about dialog the section name + line="3061">the section name the list of names + line="3062">the list of names @@ -366,7 +367,7 @@ See also: version="1.5"> Adds an extra section to the Legal page. + line="3321">Adds an extra section to the Legal page. Extra sections will be displayed below the application's own information. @@ -414,13 +415,13 @@ adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about), an about dialog + line="3323">an about dialog the name of the section + line="3324">the name of the section a copyright string + line="3325">a copyright string the type of license + line="3326">the type of license custom license information + line="3327">custom license information @@ -454,7 +455,7 @@ adw_about_dialog_add_legal_section (ADW_ABOUT_DIALOG (about), version="1.5"> Adds an extra link to the Details page. + line="2619">Adds an extra link to the Details page. Extra links are displayed under the comment and website. @@ -469,19 +470,19 @@ See [property@AboutDialog:website]. an about dialog + line="2621">an about dialog the link title + line="2622">the link title the link URL + line="2623">the link URL @@ -494,19 +495,19 @@ See [property@AboutDialog:website]. value="application-icon"/> Gets the name of the application icon for @self. + line="2130">Gets the name of the application icon for @self. the application icon name + line="2136">the application icon name an about dialog + line="2132">an about dialog @@ -519,19 +520,19 @@ See [property@AboutDialog:website]. value="application-name"/> Gets the application name for @self. + line="2175">Gets the application name for @self. the application name + line="2181">the application name an about dialog + line="2177">an about dialog @@ -543,12 +544,12 @@ See [property@AboutDialog:website]. Gets the list of artists of the application. + line="2883">Gets the list of artists of the application. The list of artists + line="2889">The list of artists @@ -557,7 +558,7 @@ See [property@AboutDialog:website]. an about dialog + line="2885">an about dialog @@ -569,19 +570,19 @@ See [property@AboutDialog:website]. Gets the comments about the application. + line="2437">Gets the comments about the application. the comments + line="2443">the comments an about dialog + line="2439">an about dialog @@ -593,19 +594,19 @@ See [property@AboutDialog:website]. Gets the copyright information for @self. + line="3142">Gets the copyright information for @self. the copyright information + line="3148">the copyright information an about dialog + line="3144">an about dialog @@ -617,19 +618,19 @@ See [property@AboutDialog:website]. Gets the debug information for @self. + line="2670">Gets the debug information for @self. the debug information + line="2676">the debug information an about dialog + line="2672">an about dialog @@ -642,19 +643,19 @@ See [property@AboutDialog:website]. value="debug-info-filename"/> Gets the debug information filename for @self. + line="2722">Gets the debug information filename for @self. the debug information filename + line="2728">the debug information filename an about dialog + line="2724">an about dialog @@ -666,12 +667,12 @@ See [property@AboutDialog:website]. Gets the list of designers of the application. + line="2825">Gets the list of designers of the application. The list of designers + line="2831">The list of designers @@ -680,7 +681,7 @@ See [property@AboutDialog:website]. an about dialog + line="2827">an about dialog @@ -692,19 +693,19 @@ See [property@AboutDialog:website]. Gets the developer name for @self. + line="2220">Gets the developer name for @self. the developer_name + line="2226">the developer_name an about dialog + line="2222">an about dialog @@ -716,12 +717,12 @@ See [property@AboutDialog:website]. Gets the list of developers of the application. + line="2767">Gets the list of developers of the application. The list of developers + line="2773">The list of developers @@ -730,7 +731,7 @@ See [property@AboutDialog:website]. an about dialog + line="2769">an about dialog @@ -742,12 +743,12 @@ See [property@AboutDialog:website]. Gets the list of documenters of the application. + line="2941">Gets the list of documenters of the application. The list of documenters + line="2947">The list of documenters @@ -756,7 +757,7 @@ See [property@AboutDialog:website]. an about dialog + line="2943">an about dialog @@ -768,19 +769,19 @@ See [property@AboutDialog:website]. Gets the issue tracker URL for @self. + line="2575">Gets the issue tracker URL for @self. the issue tracker URL + line="2581">the issue tracker URL an about dialog + line="2577">an about dialog @@ -792,19 +793,19 @@ See [property@AboutDialog:website]. Gets the license for @self. + line="3257">Gets the license for @self. the license + line="3263">the license an about dialog + line="3259">an about dialog @@ -816,19 +817,19 @@ See [property@AboutDialog:website]. Gets the license type for @self. + line="3193">Gets the license type for @self. the license type + line="3199">the license type an about dialog + line="3195">an about dialog @@ -840,19 +841,19 @@ See [property@AboutDialog:website]. Gets the release notes for @self. + line="2371">Gets the release notes for @self. the release notes + line="2377">the release notes an about dialog + line="2373">an about dialog @@ -865,19 +866,19 @@ See [property@AboutDialog:website]. value="release-notes-version"/> Gets the version described by the application's release notes. + line="2317">Gets the version described by the application's release notes. the release notes version + line="2323">the release notes version an about dialog + line="2319">an about dialog @@ -889,19 +890,19 @@ See [property@AboutDialog:website]. Gets the URL of the support page for @self. + line="2531">Gets the URL of the support page for @self. the support page URL + line="2537">the support page URL an about dialog + line="2533">an about dialog @@ -914,19 +915,19 @@ See [property@AboutDialog:website]. value="translator-credits"/> Gets the translator credits string. + line="2999">Gets the translator credits string. The translator credits string + line="3005">The translator credits string an about dialog + line="3001">an about dialog @@ -938,19 +939,19 @@ See [property@AboutDialog:website]. Gets the version for @self. + line="2270">Gets the version for @self. the version + line="2276">the version an about dialog + line="2272">an about dialog @@ -962,19 +963,19 @@ See [property@AboutDialog:website]. Gets the application website URL for @self. + line="2484">Gets the application website URL for @self. the website URL + line="2490">the website URL an about dialog + line="2486">an about dialog @@ -987,7 +988,7 @@ See [property@AboutDialog:website]. value="application-icon"/> Sets the name of the application icon for @self. + line="2148">Sets the name of the application icon for @self. The icon is displayed at the top of the main page. @@ -998,13 +999,13 @@ The icon is displayed at the top of the main page. an about dialog + line="2150">an about dialog the application icon name + line="2151">the application icon name @@ -1017,7 +1018,7 @@ The icon is displayed at the top of the main page. value="application-name"/> Sets the application name for @self. + line="2193">Sets the application name for @self. The name is displayed at the top of the main page. @@ -1028,13 +1029,13 @@ The name is displayed at the top of the main page. an about dialog + line="2195">an about dialog the application name + line="2196">the application name @@ -1046,7 +1047,7 @@ The name is displayed at the top of the main page. Sets the list of artists of the application. + line="2901">Sets the list of artists of the application. It will be displayed on the Credits page. @@ -1069,7 +1070,7 @@ See also: an about dialog + line="2903">an about dialog the list of artists + line="2904">the list of artists @@ -1092,7 +1093,7 @@ See also: Sets the comments about the application. + line="2455">Sets the comments about the application. Comments will be shown on the Details page, above links. @@ -1106,13 +1107,13 @@ detailed. It can also contain links and Pango markup. an about dialog + line="2457">an about dialog the comments + line="2458">the comments @@ -1124,7 +1125,7 @@ detailed. It can also contain links and Pango markup. Sets the copyright information for @self. + line="3160">Sets the copyright information for @self. This should be a short string of one or two lines, for example: `© 2022 Example`. @@ -1142,13 +1143,13 @@ information for the application dependencies or other components. an about dialog + line="3162">an about dialog the copyright information + line="3163">the copyright information @@ -1160,7 +1161,7 @@ information for the application dependencies or other components. Sets the debug information for @self. + line="2688">Sets the debug information for @self. Debug information will be shown on the Troubleshooting page. It's intended to be attached to issue reports when reporting issues against the @@ -1179,13 +1180,13 @@ Debug information cannot contain markup or links. an about dialog + line="2690">an about dialog the debug information + line="2691">the debug information @@ -1197,7 +1198,7 @@ Debug information cannot contain markup or links. Sets the debug information filename for @self. + line="2740">Sets the debug information filename for @self. It will be used as the suggested filename when saving debug information to a file. @@ -1211,13 +1212,13 @@ See [property@AboutDialog:debug-info]. an about dialog + line="2742">an about dialog the debug info filename + line="2743">the debug info filename @@ -1229,7 +1230,7 @@ See [property@AboutDialog:debug-info]. Sets the list of designers of the application. + line="2843">Sets the list of designers of the application. It will be displayed on the Credits page. @@ -1252,7 +1253,7 @@ See also: an about dialog + line="2845">an about dialog the list of designers + line="2846">the list of designers @@ -1275,7 +1276,7 @@ See also: Sets the developer name for @self. + line="2238">Sets the developer name for @self. The developer name is displayed on the main page, under the application name. @@ -1291,13 +1292,13 @@ Credits page, with [property@AboutDialog:developers] and related properties. an about dialog + line="2240">an about dialog the developer name + line="2241">the developer name @@ -1309,7 +1310,7 @@ Credits page, with [property@AboutDialog:developers] and related properties. Sets the list of developers of the application. + line="2785">Sets the list of developers of the application. It will be displayed on the Credits page. @@ -1332,7 +1333,7 @@ See also: an about dialog + line="2787">an about dialog the list of developers + line="2788">the list of developers @@ -1355,7 +1356,7 @@ See also: Sets the list of documenters of the application. + line="2959">Sets the list of documenters of the application. It will be displayed on the Credits page. @@ -1378,7 +1379,7 @@ See also: an about dialog + line="2961">an about dialog the list of documenters + line="2962">the list of documenters @@ -1401,7 +1402,7 @@ See also: Sets the issue tracker URL for @self. + line="2593">Sets the issue tracker URL for @self. The issue tracker link is displayed on the main page. @@ -1412,13 +1413,13 @@ The issue tracker link is displayed on the main page. an about dialog + line="2595">an about dialog the issue tracker URL + line="2596">the issue tracker URL @@ -1430,7 +1431,7 @@ The issue tracker link is displayed on the main page. Sets the license for @self. + line="3275">Sets the license for @self. This can be used to set a custom text for the license if it can't be set via [property@AboutDialog:license-type]. @@ -1453,13 +1454,13 @@ for the application dependencies or other components. an about dialog + line="3277">an about dialog the license + line="3278">the license @@ -1471,7 +1472,7 @@ for the application dependencies or other components. Sets the license for @self from a list of known licenses. + line="3211">Sets the license for @self from a list of known licenses. If the application's license is not in the list, [property@AboutDialog:license] can be used instead. The license type will be @@ -1495,13 +1496,13 @@ for the application dependencies or other components. an about dialog + line="3213">an about dialog the license type + line="3214">the license type @@ -1513,7 +1514,7 @@ for the application dependencies or other components. Sets the release notes for @self. + line="2389">Sets the release notes for @self. Release notes are displayed on the the What's New page. @@ -1545,13 +1546,13 @@ as the version; otherwise, [property@AboutDialog:version] is used. an about dialog + line="2391">an about dialog the release notes + line="2392">the release notes @@ -1564,7 +1565,7 @@ as the version; otherwise, [property@AboutDialog:version] is used. value="release-notes-version"/> Sets the version described by the application's release notes. + line="2335">Sets the version described by the application's release notes. The release notes version is displayed on the What's New page, above the release notes. @@ -1584,13 +1585,13 @@ See [property@AboutDialog:release-notes]. an about dialog + line="2337">an about dialog the release notes version + line="2338">the release notes version @@ -1602,7 +1603,7 @@ See [property@AboutDialog:release-notes]. Sets the URL of the support page for @self. + line="2549">Sets the URL of the support page for @self. The support page link is displayed on the main page. @@ -1613,13 +1614,13 @@ The support page link is displayed on the main page. an about dialog + line="2551">an about dialog the support page URL + line="2552">the support page URL @@ -1632,7 +1633,7 @@ The support page link is displayed on the main page. value="translator-credits"/> Sets the translator credits string. + line="3017">Sets the translator credits string. It will be displayed on the Credits page. @@ -1658,13 +1659,13 @@ See also: an about dialog + line="3019">an about dialog the translator credits + line="3020">the translator credits @@ -1676,7 +1677,7 @@ See also: Sets the version for @self. + line="2288">Sets the version for @self. The version is displayed on the main page. @@ -1690,13 +1691,13 @@ also be displayed above the release notes on the What's New page. an about dialog + line="2290">an about dialog the version + line="2291">the version @@ -1708,7 +1709,7 @@ also be displayed above the release notes on the What's New page. Sets the application website URL for @self. + line="2502">Sets the application website URL for @self. Website is displayed on the Details page, below comments, or on the main page if the Details page doesn't have any other content. @@ -1722,13 +1723,13 @@ Applications can add other links below, see [method@AboutDialog.add_link]. an about dialog + line="2504">an about dialog the website URL + line="2505">the website URL @@ -2476,14 +2477,15 @@ values: * [property@AboutWindow:application-icon] is set from the `<id>` * [property@AboutWindow:application-name] is set from the `<name>` -* [property@AboutWindow:developer-name] is set from the `<developer_name>` +* [property@AboutWindow:developer-name] is set from the `<name>` within + `<developer>` * [property@AboutWindow:version] is set from the version of the latest release * [property@AboutWindow:website] is set from the `<url type="homepage">` * [property@AboutWindow:support-url] is set from the `<url type="help">` * [property@AboutWindow:issue-url] is set from the `<url type="bugtracker">` -* [property@AboutWindow:license-type] is set from the `<project_license>` - If the license type retrieved from AppStream is not listed in - [enum@Gtk.License], it will be set to `GTK_LICENCE_CUSTOM`. +* [property@AboutWindow:license-type] is set from the `<project_license>`. + If the license type retrieved from AppStream is not listed in + [enum@Gtk.License], it will be set to `GTK_LICENCE_CUSTOM`. If @release_notes_version is not `NULL`, [property@AboutWindow:release-notes-version] is set to match it, while @@ -2493,7 +2495,7 @@ description for that version. the newly created `AdwAboutWindow` + line="1982">the newly created `AdwAboutWindow` @@ -2519,7 +2521,7 @@ description for that version. version="1.2"> Adds a section to the Acknowledgements page. + line="3100">Adds a section to the Acknowledgements page. This can be used to acknowledge additional people and organizations for their non-development contributions - for example, backers in a crowdfunded @@ -2544,7 +2546,7 @@ See also: an about window + line="3102">an about window the section name + line="3103">the section name the list of names + line="3104">the list of names @@ -2571,7 +2573,7 @@ See also: version="1.2"> Adds an extra section to the Credits page. + line="3057">Adds an extra section to the Credits page. Extra sections are displayed below the standard categories. @@ -2594,7 +2596,7 @@ See also: an about window + line="3059">an about window the section name + line="3060">the section name the list of names + line="3061">the list of names @@ -2621,7 +2623,7 @@ See also: version="1.2"> Adds an extra section to the Legal page. + line="3320">Adds an extra section to the Legal page. Extra sections will be displayed below the application's own information. @@ -2669,13 +2671,13 @@ adw_about_window_add_legal_section (ADW_ABOUT_WINDOW (about), an about window + line="3322">an about window the name of the section + line="3323">the name of the section a copyright string + line="3324">a copyright string the type of license + line="3325">the type of license custom license information + line="3326">custom license information @@ -2709,7 +2711,7 @@ adw_about_window_add_legal_section (ADW_ABOUT_WINDOW (about), version="1.2"> Adds an extra link to the Details page. + line="2618">Adds an extra link to the Details page. Extra links are displayed under the comment and website. @@ -2724,19 +2726,19 @@ See [property@AboutWindow:website]. an about window + line="2620">an about window the link title + line="2621">the link title the link URL + line="2622">the link URL @@ -2749,19 +2751,19 @@ See [property@AboutWindow:website]. value="application-icon"/> Gets the name of the application icon for @self. + line="2129">Gets the name of the application icon for @self. the application icon name + line="2135">the application icon name an about window + line="2131">an about window @@ -2774,19 +2776,19 @@ See [property@AboutWindow:website]. value="application-name"/> Gets the application name for @self. + line="2174">Gets the application name for @self. the application name + line="2180">the application name an about window + line="2176">an about window @@ -2798,12 +2800,12 @@ See [property@AboutWindow:website]. Gets the list of artists of the application. + line="2882">Gets the list of artists of the application. The list of artists + line="2888">The list of artists @@ -2812,7 +2814,7 @@ See [property@AboutWindow:website]. an about window + line="2884">an about window @@ -2824,19 +2826,19 @@ See [property@AboutWindow:website]. Gets the comments about the application. + line="2436">Gets the comments about the application. the comments + line="2442">the comments an about window + line="2438">an about window @@ -2848,19 +2850,19 @@ See [property@AboutWindow:website]. Gets the copyright information for @self. + line="3141">Gets the copyright information for @self. the copyright information + line="3147">the copyright information an about window + line="3143">an about window @@ -2872,19 +2874,19 @@ See [property@AboutWindow:website]. Gets the debug information for @self. + line="2669">Gets the debug information for @self. the debug information + line="2675">the debug information an about window + line="2671">an about window @@ -2897,19 +2899,19 @@ See [property@AboutWindow:website]. value="debug-info-filename"/> Gets the debug information filename for @self. + line="2721">Gets the debug information filename for @self. the debug information filename + line="2727">the debug information filename an about window + line="2723">an about window @@ -2921,12 +2923,12 @@ See [property@AboutWindow:website]. Gets the list of designers of the application. + line="2824">Gets the list of designers of the application. The list of designers + line="2830">The list of designers @@ -2935,7 +2937,7 @@ See [property@AboutWindow:website]. an about window + line="2826">an about window @@ -2947,19 +2949,19 @@ See [property@AboutWindow:website]. Gets the developer name for @self. + line="2219">Gets the developer name for @self. the developer_name + line="2225">the developer_name an about window + line="2221">an about window @@ -2971,12 +2973,12 @@ See [property@AboutWindow:website]. Gets the list of developers of the application. + line="2766">Gets the list of developers of the application. The list of developers + line="2772">The list of developers @@ -2985,7 +2987,7 @@ See [property@AboutWindow:website]. an about window + line="2768">an about window @@ -2997,12 +2999,12 @@ See [property@AboutWindow:website]. Gets the list of documenters of the application. + line="2940">Gets the list of documenters of the application. The list of documenters + line="2946">The list of documenters @@ -3011,7 +3013,7 @@ See [property@AboutWindow:website]. an about window + line="2942">an about window @@ -3023,19 +3025,19 @@ See [property@AboutWindow:website]. Gets the issue tracker URL for @self. + line="2574">Gets the issue tracker URL for @self. the issue tracker URL + line="2580">the issue tracker URL an about window + line="2576">an about window @@ -3047,19 +3049,19 @@ See [property@AboutWindow:website]. Gets the license for @self. + line="3256">Gets the license for @self. the license + line="3262">the license an about window + line="3258">an about window @@ -3071,19 +3073,19 @@ See [property@AboutWindow:website]. Gets the license type for @self. + line="3192">Gets the license type for @self. the license type + line="3198">the license type an about window + line="3194">an about window @@ -3095,19 +3097,19 @@ See [property@AboutWindow:website]. Gets the release notes for @self. + line="2370">Gets the release notes for @self. the release notes + line="2376">the release notes an about window + line="2372">an about window @@ -3120,19 +3122,19 @@ See [property@AboutWindow:website]. value="release-notes-version"/> Gets the version described by the application's release notes. + line="2316">Gets the version described by the application's release notes. the release notes version + line="2322">the release notes version an about window + line="2318">an about window @@ -3144,19 +3146,19 @@ See [property@AboutWindow:website]. Gets the URL of the support page for @self. + line="2530">Gets the URL of the support page for @self. the support page URL + line="2536">the support page URL an about window + line="2532">an about window @@ -3169,19 +3171,19 @@ See [property@AboutWindow:website]. value="translator-credits"/> Gets the translator credits string. + line="2998">Gets the translator credits string. The translator credits string + line="3004">The translator credits string an about window + line="3000">an about window @@ -3193,19 +3195,19 @@ See [property@AboutWindow:website]. Gets the version for @self. + line="2269">Gets the version for @self. the version + line="2275">the version an about window + line="2271">an about window @@ -3217,19 +3219,19 @@ See [property@AboutWindow:website]. Gets the application website URL for @self. + line="2483">Gets the application website URL for @self. the website URL + line="2489">the website URL an about window + line="2485">an about window @@ -3242,7 +3244,7 @@ See [property@AboutWindow:website]. value="application-icon"/> Sets the name of the application icon for @self. + line="2147">Sets the name of the application icon for @self. The icon is displayed at the top of the main page. @@ -3253,13 +3255,13 @@ The icon is displayed at the top of the main page. an about window + line="2149">an about window the application icon name + line="2150">the application icon name @@ -3272,7 +3274,7 @@ The icon is displayed at the top of the main page. value="application-name"/> Sets the application name for @self. + line="2192">Sets the application name for @self. The name is displayed at the top of the main page. @@ -3283,13 +3285,13 @@ The name is displayed at the top of the main page. an about window + line="2194">an about window the application name + line="2195">the application name @@ -3301,7 +3303,7 @@ The name is displayed at the top of the main page. Sets the list of artists of the application. + line="2900">Sets the list of artists of the application. It will be displayed on the Credits page. @@ -3324,7 +3326,7 @@ See also: an about window + line="2902">an about window the list of artists + line="2903">the list of artists @@ -3347,7 +3349,7 @@ See also: Sets the comments about the application. + line="2454">Sets the comments about the application. Comments will be shown on the Details page, above links. @@ -3361,13 +3363,13 @@ detailed. It can also contain links and Pango markup. an about window + line="2456">an about window the comments + line="2457">the comments @@ -3379,7 +3381,7 @@ detailed. It can also contain links and Pango markup. Sets the copyright information for @self. + line="3159">Sets the copyright information for @self. This should be a short string of one or two lines, for example: `© 2022 Example`. @@ -3397,13 +3399,13 @@ information for the application dependencies or other components. an about window + line="3161">an about window the copyright information + line="3162">the copyright information @@ -3415,7 +3417,7 @@ information for the application dependencies or other components. Sets the debug information for @self. + line="2687">Sets the debug information for @self. Debug information will be shown on the Troubleshooting page. It's intended to be attached to issue reports when reporting issues against the @@ -3434,13 +3436,13 @@ Debug information cannot contain markup or links. an about window + line="2689">an about window the debug information + line="2690">the debug information @@ -3452,7 +3454,7 @@ Debug information cannot contain markup or links. Sets the debug information filename for @self. + line="2739">Sets the debug information filename for @self. It will be used as the suggested filename when saving debug information to a file. @@ -3466,13 +3468,13 @@ See [property@AboutWindow:debug-info]. an about window + line="2741">an about window the debug info filename + line="2742">the debug info filename @@ -3484,7 +3486,7 @@ See [property@AboutWindow:debug-info]. Sets the list of designers of the application. + line="2842">Sets the list of designers of the application. It will be displayed on the Credits page. @@ -3507,7 +3509,7 @@ See also: an about window + line="2844">an about window the list of designers + line="2845">the list of designers @@ -3530,7 +3532,7 @@ See also: Sets the developer name for @self. + line="2237">Sets the developer name for @self. The developer name is displayed on the main page, under the application name. @@ -3546,13 +3548,13 @@ Credits page, with [property@AboutWindow:developers] and related properties. an about window + line="2239">an about window the developer name + line="2240">the developer name @@ -3564,7 +3566,7 @@ Credits page, with [property@AboutWindow:developers] and related properties. Sets the list of developers of the application. + line="2784">Sets the list of developers of the application. It will be displayed on the Credits page. @@ -3587,7 +3589,7 @@ See also: an about window + line="2786">an about window the list of developers + line="2787">the list of developers @@ -3610,7 +3612,7 @@ See also: Sets the list of documenters of the application. + line="2958">Sets the list of documenters of the application. It will be displayed on the Credits page. @@ -3633,7 +3635,7 @@ See also: an about window + line="2960">an about window the list of documenters + line="2961">the list of documenters @@ -3656,7 +3658,7 @@ See also: Sets the issue tracker URL for @self. + line="2592">Sets the issue tracker URL for @self. The issue tracker link is displayed on the main page. @@ -3667,13 +3669,13 @@ The issue tracker link is displayed on the main page. an about window + line="2594">an about window the issue tracker URL + line="2595">the issue tracker URL @@ -3685,7 +3687,7 @@ The issue tracker link is displayed on the main page. Sets the license for @self. + line="3274">Sets the license for @self. This can be used to set a custom text for the license if it can't be set via [property@AboutWindow:license-type]. @@ -3708,13 +3710,13 @@ for the application dependencies or other components. an about window + line="3276">an about window the license + line="3277">the license @@ -3726,7 +3728,7 @@ for the application dependencies or other components. Sets the license for @self from a list of known licenses. + line="3210">Sets the license for @self from a list of known licenses. If the application's license is not in the list, [property@AboutWindow:license] can be used instead. The license type will be @@ -3750,13 +3752,13 @@ for the application dependencies or other components. an about window + line="3212">an about window the license type + line="3213">the license type @@ -3768,7 +3770,7 @@ for the application dependencies or other components. Sets the release notes for @self. + line="2388">Sets the release notes for @self. Release notes are displayed on the the What's New page. @@ -3800,13 +3802,13 @@ as the version; otherwise, [property@AboutWindow:version] is used. an about window + line="2390">an about window the release notes + line="2391">the release notes @@ -3819,7 +3821,7 @@ as the version; otherwise, [property@AboutWindow:version] is used. value="release-notes-version"/> Sets the version described by the application's release notes. + line="2334">Sets the version described by the application's release notes. The release notes version is displayed on the What's New page, above the release notes. @@ -3839,13 +3841,13 @@ See [property@AboutWindow:release-notes]. an about window + line="2336">an about window the release notes version + line="2337">the release notes version @@ -3857,7 +3859,7 @@ See [property@AboutWindow:release-notes]. Sets the URL of the support page for @self. + line="2548">Sets the URL of the support page for @self. The support page link is displayed on the main page. @@ -3868,13 +3870,13 @@ The support page link is displayed on the main page. an about window + line="2550">an about window the support page URL + line="2551">the support page URL @@ -3887,7 +3889,7 @@ The support page link is displayed on the main page. value="translator-credits"/> Sets the translator credits string. + line="3016">Sets the translator credits string. It will be displayed on the Credits page. @@ -3913,13 +3915,13 @@ See also: an about window + line="3018">an about window the translator credits + line="3019">the translator credits @@ -3931,7 +3933,7 @@ See also: Sets the version for @self. + line="2287">Sets the version for @self. The version is displayed on the main page. @@ -3945,13 +3947,13 @@ also be displayed above the release notes on the What's New page. an about window + line="2289">an about window the version + line="2290">the version @@ -3963,7 +3965,7 @@ also be displayed above the release notes on the What's New page. Sets the application website URL for @self. + line="2501">Sets the application website URL for @self. Website is displayed on the Details page, below comments, or on the main page if the Details page doesn't have any other content. @@ -3977,13 +3979,13 @@ Applications can add other links below, see [method@AboutWindow.add_link]. an about window + line="2503">an about window the website URL + line="2504">the website URL @@ -4564,7 +4566,12 @@ It contains the subnode `box.header` for its main horizontal box, and `box.title` for the vertical box containing the title and subtitle labels. It contains subnodes `label.title` and `label.subtitle` representing -respectively the title label and subtitle label. +respectively the title label and subtitle label. + +`AdwActionRow` can use the +[`.property`](style-classes.html#property-rows) style class to emphasize +the row subtitle instead of the row title, which is useful for +displaying read-only properties. @@ -4573,19 +4580,19 @@ respectively the title label and subtitle label. Creates a new `AdwActionRow`. + line="436">Creates a new `AdwActionRow`. the newly created `AdwActionRow` + line="441">the newly created `AdwActionRow` Activates @self. + line="876">Activates @self. @@ -4594,7 +4601,7 @@ respectively the title label and subtitle label. an action row + line="878">an action row @@ -4602,7 +4609,7 @@ respectively the title label and subtitle label. Activates @self. + line="876">Activates @self. @@ -4611,7 +4618,7 @@ respectively the title label and subtitle label. an action row + line="878">an action row @@ -4619,7 +4626,7 @@ respectively the title label and subtitle label. Adds a prefix widget to @self. + line="449">Adds a prefix widget to @self. @@ -4628,13 +4635,13 @@ respectively the title label and subtitle label. an action row + line="451">an action row a widget + line="452">a widget @@ -4642,7 +4649,7 @@ respectively the title label and subtitle label. Adds a suffix widget to @self. + line="472">Adds a suffix widget to @self. @@ -4651,13 +4658,13 @@ respectively the title label and subtitle label. an action row + line="474">an action row a widget + line="475">a widget @@ -4669,19 +4676,19 @@ respectively the title label and subtitle label. value="activatable-widget"/> Gets the widget activated when @self is activated. + line="624">Gets the widget activated when @self is activated. the activatable widget for @self + line="630">the activatable widget for @self an action row + line="626">an action row @@ -4694,20 +4701,20 @@ respectively the title label and subtitle label. Gets the icon name for @self. + line="573">Gets the icon name for @self. Use [method@ActionRow.add_prefix] to add an icon. the icon name for @self + line="579">the icon name for @self an action row + line="575">an action row @@ -4718,19 +4725,19 @@ respectively the title label and subtitle label. Gets the subtitle for @self. + line="525">Gets the subtitle for @self. the subtitle for @self + line="531">the subtitle for @self an action row + line="527">an action row @@ -4741,13 +4748,13 @@ respectively the title label and subtitle label. Gets the number of lines at the end of which the subtitle label will be + line="773">Gets the number of lines at the end of which the subtitle label will be ellipsized. the number of lines at the end of which the subtitle label will be + line="780">the number of lines at the end of which the subtitle label will be ellipsized @@ -4755,7 +4762,7 @@ ellipsized. an action row + line="775">an action row @@ -4768,19 +4775,19 @@ ellipsized. value="subtitle-selectable"/> Gets whether the user can copy the subtitle from the label + line="827">Gets whether the user can copy the subtitle from the label whether the user can copy the subtitle from the label + line="833">whether the user can copy the subtitle from the label a `AdwActionRow` + line="829">a `AdwActionRow` @@ -4791,13 +4798,13 @@ ellipsized. Gets the number of lines at the end of which the title label will be + line="719">Gets the number of lines at the end of which the title label will be ellipsized. the number of lines at the end of which the title label will be + line="726">the number of lines at the end of which the title label will be ellipsized @@ -4805,7 +4812,7 @@ ellipsized. an action row + line="721">an action row @@ -4813,7 +4820,7 @@ ellipsized. Removes a child from @self. + line="495">Removes a child from @self. @@ -4822,13 +4829,13 @@ ellipsized. an action row + line="497">an action row the child to be removed + line="498">the child to be removed @@ -4840,7 +4847,7 @@ ellipsized. value="activatable-widget"/> Sets the widget to activate when @self is activated. + line="657">Sets the widget to activate when @self is activated. The row can be activated either by clicking on it, calling [method@ActionRow.activate], or via mnemonics in the title. @@ -4856,7 +4863,7 @@ The target widget will be activated by emitting the an action row + line="659">an action row the target widget + line="660">the target widget @@ -4878,7 +4885,7 @@ The target widget will be activated by emitting the Sets the icon name for @self. + line="595">Sets the icon name for @self. Use [method@ActionRow.add_prefix] to add an icon. @@ -4888,7 +4895,7 @@ The target widget will be activated by emitting the an action row + line="597">an action row the icon name + line="598">the icon name @@ -4908,7 +4915,7 @@ The target widget will be activated by emitting the Sets the subtitle for @self. + line="545">Sets the subtitle for @self. The subtitle is interpreted as Pango markup unless [property@PreferencesRow:use-markup] is set to `FALSE`. @@ -4920,13 +4927,13 @@ The subtitle is interpreted as Pango markup unless an action row + line="547">an action row the subtitle + line="548">the subtitle @@ -4937,7 +4944,7 @@ The subtitle is interpreted as Pango markup unless Sets the number of lines at the end of which the subtitle label will be + line="795">Sets the number of lines at the end of which the subtitle label will be ellipsized. If the value is 0, the number of lines won't be limited. @@ -4949,13 +4956,13 @@ If the value is 0, the number of lines won't be limited. an action row + line="797">an action row the number of lines at the end of which the subtitle label will be ellipsized + line="798">the number of lines at the end of which the subtitle label will be ellipsized @@ -4968,7 +4975,7 @@ If the value is 0, the number of lines won't be limited. value="subtitle-selectable"/> Sets whether the user can copy the subtitle from the label + line="847">Sets whether the user can copy the subtitle from the label See also [property@Gtk.Label:selectable]. @@ -4979,13 +4986,13 @@ See also [property@Gtk.Label:selectable]. a `AdwActionRow` + line="849">a `AdwActionRow` `TRUE` if the user can copy the subtitle from the label + line="850">`TRUE` if the user can copy the subtitle from the label @@ -4996,7 +5003,7 @@ See also [property@Gtk.Label:selectable]. Sets the number of lines at the end of which the title label will be + line="741">Sets the number of lines at the end of which the title label will be ellipsized. If the value is 0, the number of lines won't be limited. @@ -5008,13 +5015,13 @@ If the value is 0, the number of lines won't be limited. an action row + line="743">an action row the number of lines at the end of which the title label will be ellipsized + line="744">the number of lines at the end of which the title label will be ellipsized @@ -5030,7 +5037,7 @@ If the value is 0, the number of lines won't be limited. value="adw_action_row_set_activatable_widget"/> The widget to activate when the row is activated. + line="308">The widget to activate when the row is activated. The row can be activated either by clicking on it, calling [method@ActionRow.activate], or via mnemonics in the title. @@ -5054,7 +5061,7 @@ The target widget will be activated by emitting the value="adw_action_row_set_icon_name"/> The icon name for this row. + line="296">The icon name for this row. Use [method@ActionRow.add_prefix] to add an icon. @@ -5069,7 +5076,7 @@ The target widget will be activated by emitting the value="adw_action_row_set_subtitle"/> The subtitle for this row. + line="283">The subtitle for this row. The subtitle is interpreted as Pango markup unless [property@PreferencesRow:use-markup] is set to `FALSE`. @@ -5087,7 +5094,7 @@ The subtitle is interpreted as Pango markup unless value="adw_action_row_set_subtitle_lines"/> The number of lines at the end of which the subtitle label will be + line="339">The number of lines at the end of which the subtitle label will be ellipsized. If the value is 0, the number of lines won't be limited. @@ -5106,7 +5113,7 @@ If the value is 0, the number of lines won't be limited. value="adw_action_row_set_subtitle_selectable"/> Whether the user can copy the subtitle from the label. + line="353">Whether the user can copy the subtitle from the label. See also [property@Gtk.Label:selectable]. @@ -5123,7 +5130,7 @@ See also [property@Gtk.Label:selectable]. value="adw_action_row_set_title_lines"/> The number of lines at the end of which the title label will be ellipsized. + line="326">The number of lines at the end of which the title label will be ellipsized. If the value is 0, the number of lines won't be limited. @@ -5134,7 +5141,7 @@ If the value is 0, the number of lines won't be limited. This signal is emitted after the row has been activated. + line="369">This signal is emitted after the row has been activated. @@ -5163,7 +5170,7 @@ If the value is 0, the number of lines won't be limited. an action row + line="878">an action row @@ -5325,7 +5332,7 @@ Example of an `AdwAlertDialog` UI definition: version="1.5"> Creates a new `AdwAlertDialog`. + line="1171">Creates a new `AdwAlertDialog`. @heading and @body can be set to `NULL`. This can be useful if they need to be formatted or use markup. In that case, set them to `NULL` and call @@ -5343,7 +5350,7 @@ adw_alert_dialog_format_body (ADW_ALERT_DIALOG (dialog), the newly created `AdwAlertDialog` + line="1191">the newly created `AdwAlertDialog` @@ -5353,7 +5360,7 @@ adw_alert_dialog_format_body (ADW_ALERT_DIALOG (dialog), allow-none="1"> the heading + line="1173">the heading the body text + line="1174">the body text @@ -5386,7 +5393,7 @@ adw_alert_dialog_format_body (ADW_ALERT_DIALOG (dialog), version="1.5"> Adds a response with @id and @label to @self. + line="1684">Adds a response with @id and @label to @self. Responses are represented as buttons in the dialog. @@ -5410,19 +5417,19 @@ responses further. an alert dialog + line="1686">an alert dialog the response ID + line="1687">the response ID the response label + line="1688">the response label @@ -5433,7 +5440,7 @@ responses further. introspectable="0"> Adds multiple responses to @self. + line="1752">Adds multiple responses to @self. This is the same as calling [method@AlertDialog.add_response] repeatedly. The variable argument list should be `NULL`-terminated list of response IDs and @@ -5456,19 +5463,19 @@ adw_alert_dialog_add_responses (dialog, an alert dialog + line="1754">an alert dialog response id + line="1755">response id label for first response, then more id-label pairs + line="1756">label for first response, then more id-label pairs @@ -5479,7 +5486,7 @@ adw_alert_dialog_add_responses (dialog, glib:finish-func="choose_finish"> This function shows @self to the user. + line="2243">This function shows @self to the user. The @callback will be called when the alert is dismissed. It should call [method@AlertDialog.choose_finish] to obtain the result. @@ -5494,7 +5501,7 @@ will be shown within it. Otherwise, it will be a separate window. an alert dialog + line="2245">an alert dialog allow-none="1"> the parent widget + line="2246">the parent widget allow-none="1"> a `GCancellable` to cancel the operation + line="2247">a `GCancellable` to cancel the operation closure="3"> a callback to call when the operation is complete + line="2248">a callback to call when the operation is complete closure="2"> data to pass to @callback + line="2249">data to pass to @callback @@ -5543,12 +5550,12 @@ will be shown within it. Otherwise, it will be a separate window. version="1.5"> Finishes the [method@AlertDialog.choose] call and returns the response ID. + line="2284">Finishes the [method@AlertDialog.choose] call and returns the response ID. the ID of the response that was selected, or + line="2291">the ID of the response that was selected, or [property@AlertDialog:close-response] if the call was cancelled. @@ -5556,13 +5563,13 @@ will be shown within it. Otherwise, it will be a separate window. an alert dialog + line="2286">an alert dialog a `GAsyncResult` + line="2287">a `GAsyncResult` @@ -5573,7 +5580,7 @@ will be shown within it. Otherwise, it will be a separate window. introspectable="0"> Sets the formatted body text of @self. + line="1531">Sets the formatted body text of @self. See [property@AlertDialog:body]. @@ -5584,19 +5591,19 @@ See [property@AlertDialog:body]. an alert dialog + line="1533">an alert dialog the formatted string for the body text + line="1534">the formatted string for the body text the parameters to insert into @format + line="1535">the parameters to insert into @format @@ -5607,7 +5614,7 @@ See [property@AlertDialog:body]. introspectable="0"> Sets the formatted body text of @self with Pango markup. + line="1574">Sets the formatted body text of @self with Pango markup. The @format is assumed to contain Pango markup. @@ -5624,19 +5631,19 @@ See [property@AlertDialog:body]. an alert dialog + line="1576">an alert dialog the formatted string for the body text with Pango markup + line="1577">the formatted string for the body text with Pango markup the parameters to insert into @format + line="1578">the parameters to insert into @format @@ -5647,7 +5654,7 @@ See [property@AlertDialog:body]. introspectable="0"> Sets the formatted heading of @self. + line="1328">Sets the formatted heading of @self. See [property@AlertDialog:heading]. @@ -5658,19 +5665,19 @@ See [property@AlertDialog:heading]. an alert dialog + line="1330">an alert dialog the formatted string for the heading + line="1331">the formatted string for the heading the parameters to insert into @format + line="1332">the parameters to insert into @format @@ -5681,7 +5688,7 @@ See [property@AlertDialog:heading]. introspectable="0"> Sets the formatted heading of @self with Pango markup. + line="1371">Sets the formatted heading of @self with Pango markup. The @format is assumed to contain Pango markup. @@ -5698,19 +5705,19 @@ See [property@AlertDialog:heading]. an alert dialog + line="1373">an alert dialog the formatted string for the heading with Pango markup + line="1374">the formatted string for the heading with Pango markup the parameters to insert into @format + line="1375">the parameters to insert into @format @@ -5722,19 +5729,19 @@ See [property@AlertDialog:heading]. Gets the body text of @self. + line="1420">Gets the body text of @self. the body of @self. + line="1426">the body of @self. an alert dialog + line="1422">an alert dialog @@ -5746,19 +5753,19 @@ See [property@AlertDialog:heading]. Gets whether the body text of @self includes Pango markup. + line="1476">Gets whether the body text of @self includes Pango markup. whether @self uses markup for body text + line="1482">whether @self uses markup for body text an alert dialog + line="1478">an alert dialog @@ -5770,19 +5777,19 @@ See [property@AlertDialog:heading]. Gets the ID of the close response of @self. + line="2134">Gets the ID of the close response of @self. the close response ID + line="2140">the close response ID an alert dialog + line="2136">an alert dialog @@ -5795,19 +5802,19 @@ See [property@AlertDialog:heading]. value="default-response"/> Gets the ID of the default response of @self. + line="2069">Gets the ID of the default response of @self. the default response ID + line="2075">the default response ID an alert dialog + line="2071">an alert dialog @@ -5819,19 +5826,19 @@ See [property@AlertDialog:heading]. Gets the child widget of @self. + line="1623">Gets the child widget of @self. the child widget of @self. + line="1629">the child widget of @self. an alert dialog + line="1625">an alert dialog @@ -5843,19 +5850,19 @@ See [property@AlertDialog:heading]. Gets the heading of @self. + line="1212">Gets the heading of @self. the heading of @self. + line="1218">the heading of @self. an alert dialog + line="1214">an alert dialog @@ -5868,19 +5875,19 @@ See [property@AlertDialog:heading]. value="heading-use-markup"/> Gets whether the heading of @self includes Pango markup. + line="1270">Gets whether the heading of @self includes Pango markup. whether @self uses markup for heading + line="1276">whether @self uses markup for heading an alert dialog + line="1272">an alert dialog @@ -5890,27 +5897,27 @@ See [property@AlertDialog:heading]. version="1.5"> Gets the appearance of @response. + line="1914">Gets the appearance of @response. See [method@AlertDialog.set_response_appearance]. the appearance of @response + line="1923">the appearance of @response an alert dialog + line="1916">an alert dialog a response ID + line="1917">a response ID @@ -5920,27 +5927,27 @@ See [method@AlertDialog.set_response_appearance]. version="1.5"> Gets whether @response is enabled. + line="1999">Gets whether @response is enabled. See [method@AlertDialog.set_response_enabled]. whether @response is enabled + line="2008">whether @response is enabled an alert dialog + line="2001">an alert dialog a response ID + line="2002">a response ID @@ -5950,27 +5957,27 @@ See [method@AlertDialog.set_response_enabled]. version="1.5"> Gets the label of @response. + line="1854">Gets the label of @response. See [method@AlertDialog.set_response_label]. the label of @response + line="1863">the label of @response an alert dialog + line="1856">an alert dialog a response ID + line="1857">a response ID @@ -5980,25 +5987,25 @@ See [method@AlertDialog.set_response_label]. version="1.5"> Gets whether @self has a response with the ID @response. + line="2193">Gets whether @self has a response with the ID @response. whether @self has a response with the ID @response. + line="2200">whether @self has a response with the ID @response. an alert dialog + line="2195">an alert dialog response ID + line="2196">response ID @@ -6008,7 +6015,7 @@ See [method@AlertDialog.set_response_label]. version="1.5"> Removes a response from @self. + line="1807">Removes a response from @self. @@ -6017,13 +6024,13 @@ See [method@AlertDialog.set_response_label]. an alert dialog + line="1809">an alert dialog the response ID + line="1810">the response ID @@ -6035,7 +6042,7 @@ See [method@AlertDialog.set_response_label]. Sets the body text of @self. + line="1442">Sets the body text of @self. @@ -6044,13 +6051,13 @@ See [method@AlertDialog.set_response_label]. an alert dialog + line="1444">an alert dialog the body of @self + line="1445">the body of @self @@ -6062,7 +6069,7 @@ See [method@AlertDialog.set_response_label]. Sets whether the body text of @self includes Pango markup. + line="1498">Sets whether the body text of @self includes Pango markup. See [func@Pango.parse_markup]. @@ -6073,13 +6080,13 @@ See [func@Pango.parse_markup]. an alert dialog + line="1500">an alert dialog whether to use markup for body text + line="1501">whether to use markup for body text @@ -6091,7 +6098,7 @@ See [func@Pango.parse_markup]. Sets the ID of the close response of @self. + line="2156">Sets the ID of the close response of @self. It will be passed to [signal@AlertDialog::response] if the dialog is closed by pressing <kbd>Escape</kbd> or with a system action. @@ -6107,13 +6114,13 @@ The default close response is `close`. an alert dialog + line="2158">an alert dialog the close response ID + line="2159">the close response ID @@ -6126,7 +6133,7 @@ The default close response is `close`. value="default-response"/> Sets the ID of the default response of @self. + line="2094">Sets the ID of the default response of @self. If set, pressing <kbd>Enter</kbd> will activate the corresponding button. @@ -6140,7 +6147,7 @@ will do nothing. an alert dialog + line="2096">an alert dialog allow-none="1"> the default response ID + line="2097">the default response ID @@ -6161,7 +6168,7 @@ will do nothing. Sets the child widget of @self. + line="1645">Sets the child widget of @self. The child widget is displayed below the heading and body. @@ -6172,7 +6179,7 @@ The child widget is displayed below the heading and body. an alert dialog + line="1647">an alert dialog allow-none="1"> the child widget + line="1648">the child widget @@ -6193,7 +6200,7 @@ The child widget is displayed below the heading and body. Sets the heading of @self. + line="1234">Sets the heading of @self. @@ -6202,7 +6209,7 @@ The child widget is displayed below the heading and body. an alert dialog + line="1236">an alert dialog allow-none="1"> the heading of @self + line="1237">the heading of @self @@ -6224,7 +6231,7 @@ The child widget is displayed below the heading and body. value="heading-use-markup"/> Sets whether the heading of @self includes Pango markup. + line="1292">Sets whether the heading of @self includes Pango markup. See [func@Pango.parse_markup]. @@ -6235,13 +6242,13 @@ See [func@Pango.parse_markup]. an alert dialog + line="1294">an alert dialog whether to use markup for heading + line="1295">whether to use markup for heading @@ -6251,7 +6258,7 @@ See [func@Pango.parse_markup]. version="1.5"> Sets the appearance for @response. + line="1942">Sets the appearance for @response. <picture> <source srcset="alert-dialog-appearance-dark.png" media="(prefers-color-scheme: dark)"> @@ -6276,19 +6283,19 @@ Negative responses like Cancel or Close should use the default appearance. an alert dialog + line="1944">an alert dialog a response ID + line="1945">a response ID appearance for @response + line="1946">appearance for @response @@ -6298,7 +6305,7 @@ Negative responses like Cancel or Close should use the default appearance. version="1.5"> Sets whether @response is enabled. + line="2027">Sets whether @response is enabled. If @response is not enabled, the corresponding button will have [property@Gtk.Widget:sensitive] set to `FALSE` and it can't be activated as @@ -6316,19 +6323,19 @@ Responses are enabled by default. an alert dialog + line="2029">an alert dialog a response ID + line="2030">a response ID whether to enable @response + line="2031">whether to enable @response @@ -6338,7 +6345,7 @@ Responses are enabled by default. version="1.5"> Sets the label of @response to @label. + line="1882">Sets the label of @response to @label. Labels are displayed on the dialog buttons. An embedded underline in @label indicates a mnemonic. @@ -6350,19 +6357,19 @@ indicates a mnemonic. an alert dialog + line="1884">an alert dialog a response ID + line="1885">a response ID the label of @response + line="1886">the label of @response @@ -6379,7 +6386,7 @@ indicates a mnemonic. value="adw_alert_dialog_set_body"/> The body text of the dialog. + line="784">The body text of the dialog. value="adw_alert_dialog_set_body_use_markup"/> Whether the body text includes Pango markup. + line="796">Whether the body text includes Pango markup. See [func@Pango.parse_markup]. @@ -6413,7 +6420,7 @@ See [func@Pango.parse_markup]. value="adw_alert_dialog_set_close_response"/> The ID of the close response. + line="841">The ID of the close response. It will be passed to [signal@AlertDialog::response] if the dialog is closed by pressing <kbd>Escape</kbd> or with a system action. @@ -6436,7 +6443,7 @@ The default close response is `close`. value="adw_alert_dialog_set_default_response"/> The response ID of the default response. + line="824">The response ID of the default response. If set, pressing <kbd>Enter</kbd> will activate the corresponding button. @@ -6456,7 +6463,7 @@ will do nothing. value="adw_alert_dialog_set_extra_child"/> The child widget. + line="810">The child widget. Displayed below the heading and body. @@ -6473,7 +6480,7 @@ Displayed below the heading and body. value="adw_alert_dialog_set_heading"/> The heading of the dialog. + line="758">The heading of the dialog. value="adw_alert_dialog_set_heading_use_markup"/> Whether the heading includes Pango markup. + line="770">Whether the heading includes Pango markup. See [func@Pango.parse_markup]. @@ -6500,7 +6507,7 @@ See [func@Pango.parse_markup]. This signal is emitted when the dialog is closed. + line="862">This signal is emitted when the dialog is closed. @response will be set to the response ID of the button that had been activated. @@ -6515,7 +6522,7 @@ action, @response will be set to the value of the response ID + line="865">the response ID @@ -8374,12 +8381,12 @@ for handling a single child widget. Creates a new `AdwBin`. + line="150">Creates a new `AdwBin`. the new created `AdwBin` + line="155">the new created `AdwBin` @@ -8389,19 +8396,19 @@ for handling a single child widget. Gets the child widget of @self. + line="163">Gets the child widget of @self. the child widget of @self + line="169">the child widget of @self a bin + line="165">a bin @@ -8412,7 +8419,7 @@ for handling a single child widget. Sets the child widget of @self. + line="183">Sets the child widget of @self. @@ -8421,7 +8428,7 @@ for handling a single child widget. a bin + line="185">a bin allow-none="1"> the child widget + line="186">the child widget @@ -8444,7 +8451,7 @@ for handling a single child widget. The child widget of the `AdwBin`. + line="110">The child widget of the `AdwBin`. @@ -8602,7 +8609,10 @@ g_signal_connect_swapped (breakpoint, "unapply", line="1528">the target property - + the value to set @@ -11067,7 +11077,7 @@ See also [class@CarouselIndicatorDots]. c:type="AdwCenteringPolicy"> Describes title centering behavior of a [class@HeaderBar] widget. + line="131">Describes title centering behavior of a [class@HeaderBar] widget. Keep the title centered when possible + line="133">Keep the title centered when possible Keep the title centered at all cost + line="134">Keep the title centered at all cost Creates a new `AdwComboRow`. + line="694">Creates a new `AdwComboRow`. the newly created `AdwComboRow` + line="699">the newly created `AdwComboRow` @@ -12205,7 +12215,7 @@ contains a [class@Gtk.ScrolledWindow], which in turn contains a Gets whether search is enabled. + line="1087">Gets whether search is enabled. If set to `TRUE`, a search entry will be shown in the popup that allows to search for items in the list. @@ -12215,14 +12225,14 @@ Search requires [property@ComboRow:expression] to be set. whether the popup includes a search entry + line="1098">whether the popup includes a search entry a combo row + line="1089">a combo row @@ -12233,19 +12243,19 @@ Search requires [property@ComboRow:expression] to be set. Gets the expression used to obtain strings from items. + line="965">Gets the expression used to obtain strings from items. the expression used to obtain strings from items + line="971">the expression used to obtain strings from items a combo row + line="967">a combo row @@ -12256,19 +12266,19 @@ Search requires [property@ComboRow:expression] to be set. Gets the factory for populating list items. + line="874">Gets the factory for populating list items. the factory in use + line="880">the factory in use a combo row + line="876">a combo row @@ -12279,19 +12289,19 @@ Search requires [property@ComboRow:expression] to be set. Gets the factory for populating list items in the popup. + line="914">Gets the factory for populating list items in the popup. the factory in use + line="920">the factory in use a combo row + line="916">a combo row @@ -12302,19 +12312,19 @@ Search requires [property@ComboRow:expression] to be set. Gets the model that provides the displayed items. + line="781">Gets the model that provides the displayed items. The model in use + line="787">The model in use a combo row + line="783">a combo row @@ -12325,12 +12335,12 @@ Search requires [property@ComboRow:expression] to be set. Gets the position of the selected item. + line="734">Gets the position of the selected item. the position of the selected item, or + line="740">the position of the selected item, or [const@Gtk.INVALID_LIST_POSITION] if no item is selected @@ -12338,7 +12348,7 @@ Search requires [property@ComboRow:expression] to be set. a combo row + line="736">a combo row @@ -12349,19 +12359,19 @@ Search requires [property@ComboRow:expression] to be set. Gets the selected item. + line="758">Gets the selected item. the selected item + line="764">the selected item a combo row + line="760">a combo row @@ -12372,19 +12382,19 @@ Search requires [property@ComboRow:expression] to be set. Gets whether to use the current value as the subtitle. + line="1029">Gets whether to use the current value as the subtitle. whether to use the current value as the subtitle + line="1035">whether to use the current value as the subtitle a combo row + line="1031">a combo row @@ -12396,7 +12406,7 @@ Search requires [property@ComboRow:expression] to be set. Sets whether to enable search. + line="1114">Sets whether to enable search. If set to `TRUE`, a search entry will be shown in the popup that allows to search for items in the list. @@ -12410,13 +12420,13 @@ Search requires [property@ComboRow:expression] to be set. a combo row + line="1116">a combo row whether to enable search + line="1117">whether to enable search @@ -12427,7 +12437,7 @@ Search requires [property@ComboRow:expression] to be set. Sets the expression used to obtain strings from items. + line="985">Sets the expression used to obtain strings from items. The expression must have a value type of `G_TYPE_STRING`. @@ -12442,7 +12452,7 @@ It's used to bind strings to labels produced by the default factory if a combo row + line="987">a combo row an expression + line="988">an expression @@ -12462,7 +12472,7 @@ It's used to bind strings to labels produced by the default factory if Sets the factory for populating list items. + line="894">Sets the factory for populating list items. This factory is always used for the item in the row. It is also used for items in the popup unless [property@ComboRow:list-factory] is set. @@ -12474,7 +12484,7 @@ items in the popup unless [property@ComboRow:list-factory] is set. a combo row + line="896">a combo row allow-none="1"> the factory to use + line="897">the factory to use @@ -12494,7 +12504,7 @@ items in the popup unless [property@ComboRow:list-factory] is set. Sets the factory for populating list items in the popup. + line="934">Sets the factory for populating list items in the popup. If this is not set, [property@ComboRow:factory] is used. @@ -12505,7 +12515,7 @@ If this is not set, [property@ComboRow:factory] is used. a combo row + line="936">a combo row allow-none="1"> the factory to use + line="937">the factory to use @@ -12525,7 +12535,7 @@ If this is not set, [property@ComboRow:factory] is used. Sets the model that provides the displayed items. + line="801">Sets the model that provides the displayed items. @@ -12534,7 +12544,7 @@ If this is not set, [property@ComboRow:factory] is used. a combo row + line="803">a combo row allow-none="1"> the model to use + line="804">the model to use @@ -12554,7 +12564,7 @@ If this is not set, [property@ComboRow:factory] is used. Selects the item at the given position. + line="707">Selects the item at the given position. @@ -12563,13 +12573,13 @@ If this is not set, [property@ComboRow:factory] is used. a combo row + line="709">a combo row the position of the item to select, or + line="710">the position of the item to select, or [const@Gtk.INVALID_LIST_POSITION] @@ -12581,7 +12591,7 @@ If this is not set, [property@ComboRow:factory] is used. Sets whether to use the current value as the subtitle. + line="1049">Sets whether to use the current value as the subtitle. If you use a custom list item factory, you will need to give the row a name conversion expression with [property@ComboRow:expression]. @@ -12598,13 +12608,13 @@ The subtitle is interpreted as Pango markup if a combo row + line="1051">a combo row whether to use the current value as the subtitle + line="1052">whether to use the current value as the subtitle @@ -12622,7 +12632,7 @@ The subtitle is interpreted as Pango markup if value="adw_combo_row_set_enable_search"/> Whether to show a search entry in the popup. + line="650">Whether to show a search entry in the popup. If set to `TRUE`, a search entry will be shown in the popup that allows to search for items in the list. @@ -12641,7 +12651,7 @@ Search requires [property@ComboRow:expression] to be set. value="adw_combo_row_set_expression"/> An expression used to obtain strings from items. + line="615">An expression used to obtain strings from items. The expression must have a value type of `G_TYPE_STRING`. @@ -12661,7 +12671,7 @@ It's used to bind strings to labels produced by the default factory if value="adw_combo_row_set_factory"/> Factory for populating list items. + line="590">Factory for populating list items. This factory is always used for the item in the row. It is also used for items in the popup unless [property@ComboRow:list-factory] is set. @@ -12678,7 +12688,7 @@ items in the popup unless [property@ComboRow:list-factory] is set. value="adw_combo_row_set_list_factory"/> The factory for populating list items in the popup. + line="603">The factory for populating list items in the popup. If this is not set, [property@ComboRow:factory] is used. @@ -12694,7 +12704,7 @@ If this is not set, [property@ComboRow:factory] is used. value="adw_combo_row_set_model"/> The model that provides the displayed items. + line="580">The model that provides the displayed items. value="adw_combo_row_set_selected"/> The position of the selected item. + line="557">The position of the selected item. If no item is selected, the property has the value [const@Gtk.INVALID_LIST_POSITION] @@ -12722,7 +12732,7 @@ If no item is selected, the property has the value value="adw_combo_row_get_selected_item"/> The selected item. + line="570">The selected item. Whether to use the current value as the subtitle. + line="632">Whether to use the current value as the subtitle. If you use a custom list item factory, you will need to give the row a name conversion expression with [property@ComboRow:expression]. @@ -12918,7 +12928,7 @@ Use [method@Dialog.force_close] to close the dialog even when `can-close` is set ## Header Bar Integration When placed inside an `AdwDialog`, [class@HeaderBar] will display the dialog -title intead of window title. It will also adjust the decoration layout to +title instead of window title. It will also adjust the decoration layout to ensure it always has a close button and nothing else. Set [property@HeaderBar:show-start-title-buttons] and [property@HeaderBar:show-end-title-buttons] to `FALSE` to remove it if it's @@ -12939,12 +12949,12 @@ minimum size, and [property@Gtk.Widget:width-request] and Creates a new `AdwDialog`. + line="1296">Creates a new `AdwDialog`. the new created `AdwDialog` + line="1301">the new created `AdwDialog` @@ -12975,7 +12985,7 @@ minimum size, and [property@Gtk.Widget:width-request] and version="1.5"> Adds @breakpoint to @self. + line="1923">Adds @breakpoint to @self. @@ -12984,13 +12994,13 @@ minimum size, and [property@Gtk.Widget:width-request] and a dialog + line="1925">a dialog the breakpoint to add + line="1926">the breakpoint to add @@ -12998,7 +13008,7 @@ minimum size, and [property@Gtk.Widget:width-request] and Attempts to close @self. + line="1852">Attempts to close @self. If the [property@Dialog:can-close] property is set to `FALSE`, the [signal@Dialog::close-attempt] signal is emitted. @@ -13008,14 +13018,14 @@ See also: [method@Dialog.force_close]. whether @self was successfully closed + line="1863">whether @self was successfully closed a dialog + line="1854">a dialog @@ -13025,7 +13035,7 @@ See also: [method@Dialog.force_close]. version="1.5"> Closes @self. + line="1889">Closes @self. Unlike [method@Dialog.close], it succeeds even if [property@Dialog:can-close] is set to `FALSE`. @@ -13037,7 +13047,7 @@ is set to `FALSE`. a dialog + line="1891">a dialog @@ -13049,19 +13059,19 @@ is set to `FALSE`. Gets whether @self can be closed. + line="1417">Gets whether @self can be closed. whether the dialog can be closed + line="1423">whether the dialog can be closed a dialog + line="1419">a dialog @@ -13073,19 +13083,19 @@ is set to `FALSE`. Gets the child widget of @self. + line="1311">Gets the child widget of @self. the child widget of @self + line="1317">the child widget of @self a dialog + line="1313">a dialog @@ -13097,19 +13107,19 @@ is set to `FALSE`. Gets the height of the dialog's contents. + line="1526">Gets the height of the dialog's contents. the content height + line="1532">the content height a dialog + line="1528">a dialog @@ -13121,19 +13131,19 @@ is set to `FALSE`. Gets the width of the dialog's contents. + line="1476">Gets the width of the dialog's contents. the content width + line="1482">the content width a dialog + line="1478">a dialog @@ -13146,19 +13156,19 @@ is set to `FALSE`. value="current-breakpoint"/> Gets the current breakpoint. + line="1948">Gets the current breakpoint. the current breakpoint + line="1954">the current breakpoint a dialog + line="1950">a dialog @@ -13170,19 +13180,19 @@ is set to `FALSE`. Gets the default widget for @self. + line="1770">Gets the default widget for @self. the default widget + line="1776">the default widget a dialog + line="1772">a dialog @@ -13193,19 +13203,19 @@ is set to `FALSE`. Gets the focus widget for @self. + line="1698">Gets the focus widget for @self. the focus widget + line="1704">the focus widget a dialog + line="1700">a dialog @@ -13218,19 +13228,19 @@ is set to `FALSE`. value="follows-content-size"/> Gets whether to size content of @self automatically. + line="1576">Gets whether to size content of @self automatically. whether to size content automatically + line="1582">whether to size content automatically a dialog + line="1578">a dialog @@ -13243,12 +13253,12 @@ is set to `FALSE`. value="presentation-mode"/> Gets presentation mode for @self. + line="1635">Gets presentation mode for @self. the presentation mode + line="1641">the presentation mode @@ -13256,7 +13266,7 @@ is set to `FALSE`. a dialog + line="1637">a dialog @@ -13268,19 +13278,19 @@ is set to `FALSE`. Gets the title of @self. + line="1366">Gets the title of @self. the title + line="1372">the title a dialog + line="1368">a dialog @@ -13288,7 +13298,7 @@ is set to `FALSE`. Presents @self within @parent's window. + line="1994">Presents @self within @parent's window. If @self is already shown, raises it to the top instead. @@ -13302,7 +13312,7 @@ will be shown within it. Otherwise, it will be a separate window. a dialog + line="1996">a dialog allow-none="1"> a widget within the toplevel + line="1997">a widget within the toplevel @@ -13323,7 +13333,7 @@ will be shown within it. Otherwise, it will be a separate window. Sets whether @self can be closed. + line="1439">Sets whether @self can be closed. If set to `FALSE`, the close button, shortcuts and [method@Dialog.close] will result in [signal@Dialog::close-attempt] being @@ -13337,13 +13347,13 @@ emitted instead, and bottom sheet close swipe will be disabled. a dialog + line="1441">a dialog whether to allow closing + line="1442">whether to allow closing @@ -13355,7 +13365,7 @@ emitted instead, and bottom sheet close swipe will be disabled. Sets the child widget of @self. + line="1333">Sets the child widget of @self. @@ -13364,7 +13374,7 @@ emitted instead, and bottom sheet close swipe will be disabled. a dialog + line="1335">a dialog the child widget + line="1336">the child widget @@ -13385,7 +13395,7 @@ emitted instead, and bottom sheet close swipe will be disabled. Sets the height of the dialog's contents. + line="1548">Sets the height of the dialog's contents. Set it to -1 to reset it to the content's natural height. @@ -13398,13 +13408,13 @@ See also: [property@Gtk.Window:default-height] a dialog + line="1550">a dialog the content height + line="1551">the content height @@ -13416,7 +13426,7 @@ See also: [property@Gtk.Window:default-height] Sets the width of the dialog's contents. + line="1498">Sets the width of the dialog's contents. Set it to -1 to reset it to the content's natural width. @@ -13429,13 +13439,13 @@ See also: [property@Gtk.Window:default-width] a dialog + line="1500">a dialog the content width + line="1501">the content width @@ -13447,7 +13457,7 @@ See also: [property@Gtk.Window:default-width] Sets the default widget for @self. + line="1792">Sets the default widget for @self. It's activated when the user presses Enter. @@ -13458,7 +13468,7 @@ It's activated when the user presses Enter. a dialog + line="1794">a dialog allow-none="1"> the default widget + line="1795">the default widget @@ -13478,7 +13488,7 @@ It's activated when the user presses Enter. Sets the focus widget for @self. + line="1720">Sets the focus widget for @self. If @focus is not the current focus widget, and is focusable, sets it as the focus widget for the dialog. @@ -13494,7 +13504,7 @@ to a particular widget in the dialog, it is usually more convenient to use a dialog + line="1722">a dialog the focus widget + line="1723">the focus widget @@ -13516,7 +13526,7 @@ to a particular widget in the dialog, it is usually more convenient to use value="follows-content-size"/> Sets whether to size content of @self automatically. + line="1598">Sets whether to size content of @self automatically. If set to `TRUE`, always use the content's natural size instead of [property@Dialog:content-width] and [property@Dialog:content-height]. If @@ -13531,13 +13541,13 @@ See also: [property@Gtk.Window:resizable] a dialog + line="1600">a dialog whether to size content automatically + line="1601">whether to size content automatically @@ -13550,7 +13560,7 @@ See also: [property@Gtk.Window:resizable] value="presentation-mode"/> Sets presentation mode for @self. + line="1657">Sets presentation mode for @self. When set to `ADW_DIALOG_AUTO`, the dialog appears as a bottom sheet when the following condition is met: `max-width: 450px or max-height: 360px`, and as a @@ -13569,13 +13579,13 @@ Presentation mode does nothing for dialogs presented as a window. a dialog + line="1659">a dialog the new presentation mode + line="1660">the new presentation mode @@ -13588,7 +13598,7 @@ Presentation mode does nothing for dialogs presented as a window. Sets the title of @self. + line="1388">Sets the title of @self. @@ -13597,13 +13607,13 @@ Presentation mode does nothing for dialogs presented as a window. a dialog + line="1390">a dialog the new title + line="1391">the new title @@ -13621,7 +13631,7 @@ Presentation mode does nothing for dialogs presented as a window. value="adw_dialog_set_can_close"/> Whether the dialog can be closed. + line="1037">Whether the dialog can be closed. If set to `FALSE`, the close button, shortcuts and [method@Dialog.close] will result in [signal@Dialog::close-attempt] being @@ -13639,7 +13649,7 @@ emitted instead, and bottom sheet close swipe will be disabled. The child widget of the `AdwDialog`. + line="1013">The child widget of the `AdwDialog`. The height of the dialog's contents. + line="1070">The height of the dialog's contents. Set it to -1 to reset it to the content's natural height. @@ -13675,7 +13685,7 @@ See also: [property@Gtk.Window:default-height] value="adw_dialog_set_content_width"/> The width of the dialog's contents. + line="1054">The width of the dialog's contents. Set it to -1 to reset it to the content's natural width. @@ -13690,7 +13700,7 @@ See also: [property@Gtk.Window:default-width] value="adw_dialog_get_current_breakpoint"/> The current breakpoint. + line="1153">The current breakpoint. value="adw_dialog_set_default_widget"/> The default widget. + line="1139">The default widget. It's activated when the user presses Enter. @@ -13718,7 +13728,7 @@ It's activated when the user presses Enter. The focus widget. + line="1127">The focus widget. value="adw_dialog_set_follows_content_size"/> Whether to size content automatically. + line="1086">Whether to size content automatically. If set to `TRUE`, always use the content's natural size instead of [property@Dialog:content-width] and [property@Dialog:content-height]. If @@ -13756,7 +13766,7 @@ See also: [property@Gtk.Window:resizable] value="adw_dialog_set_presentation_mode"/> The dialog's presentation mode. + line="1104">The dialog's presentation mode. When set to `ADW_DIALOG_AUTO`, the dialog appears as a bottom sheet when the following condition is met: `max-width: 450px or max-height: 360px`, @@ -13779,7 +13789,7 @@ Presentation mode does nothing for dialogs presented as a window. The title of the dialog. + line="1025">The title of the dialog. @@ -13788,7 +13798,7 @@ Presentation mode does nothing for dialogs presented as a window. Emitted when the close button or shortcut is used, or + line="1167">Emitted when the close button or shortcut is used, or [method@Dialog.close] is called while [property@Dialog:can-close] is set to `FALSE`. @@ -13798,7 +13808,7 @@ Presentation mode does nothing for dialogs presented as a window. Emitted when the dialog is successfully closed. + line="1190">Emitted when the dialog is successfully closed. @@ -15063,6 +15073,9 @@ See [property@EntryRow:show-apply-button]. If the value is not found, `GTK_INVALID_LIST_POSITION` is returned. + the position of the value @@ -15407,7 +15420,7 @@ ellipsized. filename="src/adw-expander-row.c" line="800">the number of lines at the end of which the subtitle label will be ellipsized - + @@ -15433,7 +15446,7 @@ ellipsized. filename="src/adw-expander-row.c" line="751">the number of lines at the end of which the title label will be ellipsized - + @@ -15445,15 +15458,24 @@ ellipsized. + Removes a child from @self. + an expander row + the child to be removed @@ -15973,20 +15995,20 @@ classes `.folded` when it is folded, and `.unfolded` when it's not. Gets the fold transition animation duration for @self, in milliseconds. + line="2239">Gets the fold transition animation duration for @self, in milliseconds. See [the migration guide](migrating-to-breakpoints.html#replace-adwflap) the fold transition duration + line="2245">the fold transition duration a flap + line="2241">a flap @@ -16030,6 +16052,9 @@ classes `.folded` when it is folded, and `.unfolded` when it's not. See [the migration guide](migrating-to-breakpoints.html#replace-adwflap) + the fold threshold policy @@ -16049,7 +16074,7 @@ classes `.folded` when it is folded, and `.unfolded` when it's not. Gets whether @self is currently folded. + line="2280">Gets whether @self is currently folded. See [property@Flap:fold-policy]. See [the migration guide](migrating-to-breakpoints.html#replace-adwflap) @@ -16057,14 +16082,14 @@ See [property@Flap:fold-policy]. `TRUE` if @self is currently folded + line="2288">`TRUE` if @self is currently folded a flap + line="2282">a flap @@ -16077,20 +16102,20 @@ See [property@Flap:fold-policy]. Gets whether @self is locked. + line="2300">Gets whether @self is locked. See [the migration guide](migrating-to-breakpoints.html#replace-adwflap) `TRUE` if @self is locked + line="2306">`TRUE` if @self is locked a flap + line="2302">a flap @@ -16103,20 +16128,20 @@ See [property@Flap:fold-policy]. Gets whether @self is modal. + line="2399">Gets whether @self is modal. See [the migration guide](migrating-to-breakpoints.html#replace-adwflap) `TRUE` if @self is modal + line="2405">`TRUE` if @self is modal a flap + line="2401">a flap @@ -16237,20 +16262,20 @@ See [property@Flap:reveal-flap]. Gets whether @self can be closed with a swipe gesture. + line="2499">Gets whether @self can be closed with a swipe gesture. See [the migration guide](migrating-to-breakpoints.html#replace-adwflap) `TRUE` if @self can be closed with a swipe gesture + line="2505">`TRUE` if @self can be closed with a swipe gesture a flap + line="2501">a flap @@ -16263,20 +16288,20 @@ See [property@Flap:reveal-flap]. Gets whether @self can be opened with a swipe gesture. + line="2451">Gets whether @self can be opened with a swipe gesture. See [the migration guide](migrating-to-breakpoints.html#replace-adwflap) `TRUE` if @self can be opened with a swipe gesture + line="2457">`TRUE` if @self can be opened with a swipe gesture a flap + line="2453">a flap @@ -16289,20 +16314,20 @@ See [property@Flap:reveal-flap]. Gets the type of animation used for reveal and fold transitions in @self. + line="2347">Gets the type of animation used for reveal and fold transitions in @self. See [the migration guide](migrating-to-breakpoints.html#replace-adwflap) the current transition type of @self + line="2353">the current transition type of @self a flap + line="2349">a flap @@ -16415,7 +16440,7 @@ if `GTK_PACK_END`, it's displayed after the content. Sets the fold transition animation duration for @self, in milliseconds. + line="2257">Sets the fold transition animation duration for @self, in milliseconds. See [the migration guide](migrating-to-breakpoints.html#replace-adwflap) @@ -16425,13 +16450,13 @@ if `GTK_PACK_END`, it's displayed after the content. a flap + line="2259">a flap the new duration, in milliseconds + line="2260">the new duration, in milliseconds @@ -16474,7 +16499,7 @@ if `GTK_PACK_END`, it's displayed after the content. value="fold-threshold-policy"/> Sets the fold threshold policy for @self. + line="2206">Sets the fold threshold policy for @self. If set to `ADW_FOLD_THRESHOLD_POLICY_MINIMUM`, flap will only fold when the children cannot fit anymore. With `ADW_FOLD_THRESHOLD_POLICY_NATURAL`, it @@ -16491,13 +16516,13 @@ ellipsize instead of immediately folding. a flap + line="2208">a flap the policy to use + line="2209">the policy to use @@ -16510,7 +16535,7 @@ ellipsize instead of immediately folding. Sets whether @self is locked. + line="2318">Sets whether @self is locked. If `FALSE`, folding when the flap is revealed automatically closes it, and unfolding it when the flap is not revealed opens it. If `TRUE`, @@ -16524,13 +16549,13 @@ unfolding it when the flap is not revealed opens it. If `TRUE`, a flap + line="2320">a flap the new value + line="2321">the new value @@ -16543,7 +16568,7 @@ unfolding it when the flap is not revealed opens it. If `TRUE`, Sets whether @self is modal. + line="2417">Sets whether @self is modal. If `TRUE`, clicking the content widget while flap is revealed, as well as pressing the <kbd>Esc</kbd> key, will close the flap. If `FALSE`, clicks are @@ -16557,13 +16582,13 @@ passed through to the content widget. a flap + line="2419">a flap whether @self is modal + line="2420">whether @self is modal @@ -16676,7 +16701,7 @@ value. Sets whether @self can be closed with a swipe gesture. + line="2517">Sets whether @self can be closed with a swipe gesture. The area that can be swiped depends on the [property@Flap:transition-type] value. @@ -16689,13 +16714,13 @@ value. a flap + line="2519">a flap whether @self can be closed with a swipe gesture + line="2520">whether @self can be closed with a swipe gesture @@ -16708,7 +16733,7 @@ value. Sets whether @self can be opened with a swipe gesture. + line="2469">Sets whether @self can be opened with a swipe gesture. The area that can be swiped depends on the [property@Flap:transition-type] value. @@ -16721,13 +16746,13 @@ value. a flap + line="2471">a flap whether @self can be opened with a swipe gesture + line="2472">whether @self can be opened with a swipe gesture @@ -16740,7 +16765,7 @@ value. Sets the type of animation used for reveal and fold transitions in @self. + line="2365">Sets the type of animation used for reveal and fold transitions in @self. [property@Flap:flap] is transparent by default, which means the content will be seen through it with `ADW_FLAP_TRANSITION_TYPE_OVER` transitions; add the @@ -16755,13 +16780,13 @@ unwanted. a flap + line="2367">a flap the new transition type + line="2368">the new transition type @@ -17214,7 +17239,7 @@ It determines the type of animation when transitioning between children in a glib:type-struct="HeaderBarClass"> A title bar widget. + line="39">A title bar widget. <picture> <source srcset="header-bar-dark.png" media="(prefers-color-scheme: dark)"> @@ -17308,12 +17333,12 @@ contains a node with the name `widget` that contains a node with the name Creates a new `AdwHeaderBar`. + line="885">Creates a new `AdwHeaderBar`. the newly created `AdwHeaderBar`. + line="890">the newly created `AdwHeaderBar`. @@ -17324,19 +17349,19 @@ contains a node with the name `widget` that contains a node with the name value="centering-policy"/> Gets the policy for aligning the center widget. + line="1247">Gets the policy for aligning the center widget. the centering policy + line="1253">the centering policy a header bar + line="1249">a header bar @@ -17348,19 +17373,19 @@ contains a node with the name `widget` that contains a node with the name value="decoration-layout"/> Gets the decoration layout for @self. + line="1199">Gets the decoration layout for @self. the decoration layout + line="1205">the decoration layout a header bar + line="1201">a header bar @@ -17373,19 +17398,19 @@ contains a node with the name `widget` that contains a node with the name value="show-back-button"/> Gets whether @self can show the back button. + line="1142">Gets whether @self can show the back button. whether to show the back button + line="1148">whether to show the back button a header bar + line="1144">a header bar @@ -17397,19 +17422,19 @@ contains a node with the name `widget` that contains a node with the name value="show-end-title-buttons"/> Gets whether to show title buttons at the end of @self. + line="1094">Gets whether to show title buttons at the end of @self. `TRUE` if title buttons at the end are shown + line="1100">`TRUE` if title buttons at the end are shown a header bar + line="1096">a header bar @@ -17421,19 +17446,19 @@ contains a node with the name `widget` that contains a node with the name value="show-start-title-buttons"/> Gets whether to show title buttons at the start of @self. + line="1046">Gets whether to show title buttons at the start of @self. `TRUE` if title buttons at the start are shown + line="1052">`TRUE` if title buttons at the start are shown a header bar + line="1048">a header bar @@ -17445,19 +17470,19 @@ contains a node with the name `widget` that contains a node with the name Gets whether the title widget should be shown. + line="1292">Gets whether the title widget should be shown. whether the title widget should be shown. + line="1298">whether the title widget should be shown. a header bar + line="1294">a header bar @@ -17468,19 +17493,19 @@ contains a node with the name `widget` that contains a node with the name Gets the title widget widget of @self. + line="980">Gets the title widget widget of @self. the title widget + line="986">the title widget a header bar + line="982">a header bar @@ -17488,7 +17513,7 @@ contains a node with the name `widget` that contains a node with the name Adds @child to @self, packed with reference to the end of @self. + line="921">Adds @child to @self, packed with reference to the end of @self. @@ -17497,13 +17522,13 @@ contains a node with the name `widget` that contains a node with the name a header bar + line="923">a header bar the widget to be added to @self + line="924">the widget to be added to @self @@ -17511,7 +17536,7 @@ contains a node with the name `widget` that contains a node with the name Adds @child to @self, packed with reference to the start of the @self. + line="898">Adds @child to @self, packed with reference to the start of the @self. @@ -17520,13 +17545,13 @@ contains a node with the name `widget` that contains a node with the name a header bar + line="900">a header bar the widget to be added to @self + line="901">the widget to be added to @self @@ -17534,7 +17559,7 @@ contains a node with the name `widget` that contains a node with the name Removes a child from @self. + line="944">Removes a child from @self. The child must have been added with [method@HeaderBar.pack_start], [method@HeaderBar.pack_end] or [property@HeaderBar:title-widget]. @@ -17546,13 +17571,13 @@ The child must have been added with [method@HeaderBar.pack_start], a header bar + line="946">a header bar the child to remove + line="947">the child to remove @@ -17564,7 +17589,7 @@ The child must have been added with [method@HeaderBar.pack_start], value="centering-policy"/> Sets the policy for aligning the center widget. + line="1263">Sets the policy for aligning the center widget. @@ -17573,13 +17598,13 @@ The child must have been added with [method@HeaderBar.pack_start], a header bar + line="1265">a header bar the centering policy + line="1266">the centering policy @@ -17591,7 +17616,7 @@ The child must have been added with [method@HeaderBar.pack_start], value="decoration-layout"/> Sets the decoration layout for @self. + line="1215">Sets the decoration layout for @self. If this property is not set, the [property@Gtk.Settings:gtk-decoration-layout] setting is used. @@ -17611,7 +17636,7 @@ and minimize, maximize and close buttons at the end. a header bar + line="1217">a header bar allow-none="1"> a decoration layout + line="1218">a decoration layout @@ -17633,7 +17658,7 @@ and minimize, maximize and close buttons at the end. value="show-back-button"/> Sets whether @self can show the back button. + line="1160">Sets whether @self can show the back button. The back button will never be shown unless the header bar is placed inside an [class@NavigationView]. Usually, there is no reason to set it to `FALSE`. @@ -17645,13 +17670,13 @@ The back button will never be shown unless the header bar is placed inside an a header bar + line="1162">a header bar whether to show the back button + line="1163">whether to show the back button @@ -17663,7 +17688,7 @@ The back button will never be shown unless the header bar is placed inside an value="show-end-title-buttons"/> Sets whether to show title buttons at the end of @self. + line="1110">Sets whether to show title buttons at the end of @self. See [property@HeaderBar:show-start-title-buttons] for the other side. @@ -17678,13 +17703,13 @@ window (e.g. a close button will not be shown if the window can't be closed). a header bar + line="1112">a header bar `TRUE` to show standard title buttons + line="1113">`TRUE` to show standard title buttons @@ -17696,7 +17721,7 @@ window (e.g. a close button will not be shown if the window can't be closed). Sets whether to show title buttons at the start of @self. + line="1062">Sets whether to show title buttons at the start of @self. See [property@HeaderBar:show-end-title-buttons] for the other side. @@ -17711,13 +17736,13 @@ window (e.g. a close button will not be shown if the window can't be closed). a header bar + line="1064">a header bar `TRUE` to show standard title buttons + line="1065">`TRUE` to show standard title buttons @@ -17729,7 +17754,7 @@ window (e.g. a close button will not be shown if the window can't be closed). Sets whether the title widget should be shown. + line="1310">Sets whether the title widget should be shown. @@ -17738,13 +17763,13 @@ window (e.g. a close button will not be shown if the window can't be closed). a header bar + line="1312">a header bar whether the title widget is visible + line="1313">whether the title widget is visible @@ -17755,7 +17780,7 @@ window (e.g. a close button will not be shown if the window can't be closed). Sets the title widget for @self. + line="996">Sets the title widget for @self. When set to `NULL`, the header bar will display the title of the window it is contained in. @@ -17779,7 +17804,7 @@ To use a different title, use [class@WindowTitle]: a header bar + line="998">a header bar a widget to use for a title + line="999">a widget to use for a title @@ -17805,7 +17830,7 @@ To use a different title, use [class@WindowTitle]: value="adw_header_bar_set_centering_policy"/> The policy for aligning the center widget. + line="782">The policy for aligning the center widget. The decoration layout for buttons. + line="761">The decoration layout for buttons. If this property is not set, the [property@Gtk.Settings:gtk-decoration-layout] setting is used. @@ -17847,7 +17872,7 @@ and minimize, maximize and close buttons at the end. value="adw_header_bar_set_show_back_button"/> Whether the header bar can show the back button. + line="746">Whether the header bar can show the back button. The back button will never be shown unless the header bar is placed inside an [class@NavigationView]. Usually, there is no reason to set this to `FALSE`. @@ -17865,7 +17890,7 @@ The back button will never be shown unless the header bar is placed inside an value="adw_header_bar_set_show_end_title_buttons"/> Whether to show title buttons at the end of the header bar. + line="729">Whether to show title buttons at the end of the header bar. See [property@HeaderBar:show-start-title-buttons] for the other side. @@ -17887,7 +17912,7 @@ closed). value="adw_header_bar_set_show_start_title_buttons"/> Whether to show title buttons at the start of the header bar. + line="712">Whether to show title buttons at the start of the header bar. See [property@HeaderBar:show-end-title-buttons] for the other side. @@ -17910,7 +17935,7 @@ closed). value="adw_header_bar_set_show_title"/> Whether the title widget should be shown. + line="793">Whether the title widget should be shown. value="adw_header_bar_set_title_widget"/> The title widget to display. + line="687">The title widget to display. When set to `NULL`, the header bar will display the title of the window it is contained in. @@ -18053,7 +18078,7 @@ if it hasn't computed its fold yet. deprecated-version="1.4"> Finds the previous or next navigatable child. + line="3603">Finds the previous or next navigatable child. This will be the same child [method@Leaflet.navigate] or swipe gestures will navigate to. @@ -18066,20 +18091,20 @@ See [property@LeafletPage:navigatable]. the previous or next child + line="3617">the previous or next child a leaflet + line="3605">a leaflet the direction + line="3606">the direction @@ -18093,20 +18118,20 @@ See [property@LeafletPage:navigatable]. value="can-navigate-back"/> Gets whether gestures and shortcuts for navigating backward are enabled. + line="3483">Gets whether gestures and shortcuts for navigating backward are enabled. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) Whether gestures and shortcuts are enabled. + line="3489">Whether gestures and shortcuts are enabled. a leaflet + line="3485">a leaflet @@ -18120,20 +18145,20 @@ See [property@LeafletPage:navigatable]. value="can-navigate-forward"/> Gets whether gestures and shortcuts for navigating forward are enabled. + line="3543">Gets whether gestures and shortcuts for navigating forward are enabled. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) Whether gestures and shortcuts are enabled. + line="3549">Whether gestures and shortcuts are enabled. a leaflet + line="3545">a leaflet @@ -18170,7 +18195,7 @@ See [property@LeafletPage:navigatable]. deprecated-version="1.4"> Finds the child of @self with @name. + line="3671">Finds the child of @self with @name. Returns `NULL` if there is no child with this name. @@ -18180,20 +18205,20 @@ See [property@LeafletPage:name]. the requested child of @self + line="3682">the requested child of @self a leaflet + line="3673">a leaflet the name of the child to find + line="3674">the name of the child to find @@ -18207,20 +18232,20 @@ See [property@LeafletPage:name]. value="child-transition-params"/> Gets the child transition spring parameters for @self. + line="3416">Gets the child transition spring parameters for @self. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) the child transition parameters + line="3422">the child transition parameters a leaflet + line="3418">a leaflet @@ -18234,20 +18259,20 @@ See [property@LeafletPage:name]. value="child-transition-running"/> Gets whether a child transition is currently running for @self. + line="3465">Gets whether a child transition is currently running for @self. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) whether a transition is currently running + line="3471">whether a transition is currently running a leaflet + line="3467">a leaflet @@ -18265,6 +18290,9 @@ See [property@LeafletPage:name]. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) + the fold threshold policy @@ -18314,20 +18342,20 @@ sum of the minimum or natural sizes of the children (see Gets whether @self is homogeneous. + line="3161">Gets whether @self is homogeneous. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) whether @self is homogeneous + line="3167">whether @self is homogeneous a leaflet + line="3163">a leaflet @@ -18341,20 +18369,20 @@ sum of the minimum or natural sizes of the children (see value="mode-transition-duration"/> Gets the mode transition animation duration for @self. + line="3371">Gets the mode transition animation duration for @self. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) the mode transition duration, in milliseconds. + line="3377">the mode transition duration, in milliseconds. a leaflet + line="3373">a leaflet @@ -18397,7 +18425,7 @@ sum of the minimum or natural sizes of the children (see Returns a [iface@Gio.ListModel] that contains the pages of the leaflet. + line="3700">Returns a [iface@Gio.ListModel] that contains the pages of the leaflet. This can be used to keep an up-to-date view. The model also implements [iface@Gtk.SelectionModel] and can be used to track and change the visible @@ -18407,14 +18435,14 @@ page. a `GtkSelectionModel` for the leaflet's children + line="3710">a `GtkSelectionModel` for the leaflet's children a leaflet + line="3702">a leaflet @@ -18427,13 +18455,13 @@ page. Gets the type of animation used for transitions between modes and children. + line="3313">Gets the type of animation used for transitions between modes and children. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) the current transition type of @self + line="3319">the current transition type of @self @@ -18441,7 +18469,7 @@ page. a leaflet + line="3315">a leaflet @@ -18454,20 +18482,20 @@ page. Gets the widget currently visible when the leaflet is folded. + line="3209">Gets the widget currently visible when the leaflet is folded. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) the visible child + line="3215">the visible child a leaflet + line="3211">a leaflet @@ -18481,20 +18509,20 @@ page. value="visible-child-name"/> Gets the name of the currently visible child widget. + line="3263">Gets the name of the currently visible child widget. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) the name of the visible child + line="3269">the name of the visible child a leaflet + line="3265">a leaflet @@ -18546,7 +18574,7 @@ If @sibling is `NULL`, inserts @child at the first position. deprecated-version="1.4"> Navigates to the previous or next child. + line="3634">Navigates to the previous or next child. The child must have the [property@LeafletPage:navigatable] property set to `TRUE`, otherwise it will be skipped. @@ -18558,20 +18586,20 @@ This will be the same child as returned by whether the visible child was changed + line="3647">whether the visible child was changed a leaflet + line="3636">a leaflet the direction + line="3637">the direction @@ -18680,7 +18708,7 @@ If @sibling is `NULL`, moves @child to the first position. value="can-navigate-back"/> Sets whether gestures and shortcuts for navigating backward are enabled. + line="3501">Sets whether gestures and shortcuts for navigating backward are enabled. The supported gestures are: @@ -18706,13 +18734,13 @@ be navigated to. a leaflet + line="3503">a leaflet the new value + line="3504">the new value @@ -18726,7 +18754,7 @@ be navigated to. value="can-navigate-forward"/> Sets whether gestures and shortcuts for navigating forward are enabled. + line="3561">Sets whether gestures and shortcuts for navigating forward are enabled. The supported gestures are: @@ -18752,13 +18780,13 @@ be navigated to. a leaflet + line="3563">a leaflet the new value + line="3564">the new value @@ -18801,7 +18829,7 @@ be navigated to. value="child-transition-params"/> Sets the child transition spring parameters for @self. + line="3434">Sets the child transition spring parameters for @self. The default value is equivalent to: @@ -18817,13 +18845,13 @@ adw_spring_params_new (1, 0.5, 500) a leaflet + line="3436">a leaflet the new parameters + line="3437">the new parameters @@ -18837,7 +18865,7 @@ adw_spring_params_new (1, 0.5, 500) value="fold-threshold-policy"/> Sets the fold threshold policy for @self. + line="3128">Sets the fold threshold policy for @self. If set to `ADW_FOLD_THRESHOLD_POLICY_MINIMUM`, it will only fold when the children cannot fit anymore. With `ADW_FOLD_THRESHOLD_POLICY_NATURAL`, it @@ -18854,13 +18882,13 @@ ellipsize instead of immediately folding. a leaflet + line="3130">a leaflet the policy to use + line="3131">the policy to use @@ -18873,7 +18901,7 @@ ellipsize instead of immediately folding. Sets @self to be homogeneous or not. + line="3179">Sets @self to be homogeneous or not. If set to `FALSE`, different children can have different size along the opposite orientation. @@ -18886,13 +18914,13 @@ opposite orientation. a leaflet + line="3181">a leaflet whether to make @self homogeneous + line="3182">whether to make @self homogeneous @@ -18906,7 +18934,7 @@ opposite orientation. value="mode-transition-duration"/> Sets the mode transition animation duration for @self. + line="3389">Sets the mode transition animation duration for @self. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) @@ -18916,13 +18944,13 @@ opposite orientation. a leaflet + line="3391">a leaflet the new duration, in milliseconds + line="3392">the new duration, in milliseconds @@ -18935,7 +18963,7 @@ opposite orientation. Sets the type of animation used for transitions between modes and children. + line="3331">Sets the type of animation used for transitions between modes and children. The transition type can be changed without problems at runtime, so it is possible to change the animation based on the mode or child that is about to @@ -18949,13 +18977,13 @@ become current. a leaflet + line="3333">a leaflet the new transition type + line="3334">the new transition type @@ -18969,7 +18997,7 @@ become current. Sets the widget currently visible when the leaflet is folded. + line="3230">Sets the widget currently visible when the leaflet is folded. The transition is determined by [property@Leaflet:transition-type] and [property@Leaflet:child-transition-params]. The transition can be cancelled @@ -18984,13 +19012,13 @@ visible child. a leaflet + line="3232">a leaflet the new child + line="3233">the new child @@ -19004,7 +19032,7 @@ visible child. value="visible-child-name"/> Makes the child with the name @name visible. + line="3284">Makes the child with the name @name visible. See [property@Leaflet:visible-child]. See [the migration guide](migrating-to-breakpoints.html#replace-adwleaflet) @@ -19016,13 +19044,13 @@ See [property@Leaflet:visible-child]. a leaflet + line="3286">a leaflet the name of a child + line="3287">the name of a child @@ -19710,7 +19738,7 @@ New values may be added to this enumeration over time. - + Adwaita micro version component (e.g. 3 if the version is 1.2.3). @@ -23602,12 +23630,12 @@ overlay-split-view version="1.4"> Creates a new `AdwOverlaySplitView`. + line="1266">Creates a new `AdwOverlaySplitView`. the newly created `AdwOverlaySplitView` + line="1271">the newly created `AdwOverlaySplitView` @@ -23618,19 +23646,19 @@ overlay-split-view Gets whether @self is collapsed. + line="1373">Gets whether @self is collapsed. whether @self is collapsed + line="1379">whether @self is collapsed an overlay split view + line="1375">an overlay split view @@ -23642,19 +23670,19 @@ overlay-split-view Gets the content widget for @self. + line="1328">Gets the content widget for @self. the content widget for @self + line="1334">the content widget for @self an overlay split view + line="1330">an overlay split view @@ -23667,19 +23695,19 @@ overlay-split-view value="enable-hide-gesture"/> Gets whether @self can be closed with a swipe gesture. + line="1632">Gets whether @self can be closed with a swipe gesture. `TRUE` if @self can be closed with a swipe gesture + line="1638">`TRUE` if @self can be closed with a swipe gesture an overlay split view + line="1634">an overlay split view @@ -23692,19 +23720,19 @@ overlay-split-view value="enable-show-gesture"/> Gets whether @self can be opened with an edge swipe gesture. + line="1585">Gets whether @self can be opened with an edge swipe gesture. `TRUE` if @self can be opened with a swipe gesture + line="1591">`TRUE` if @self can be opened with a swipe gesture an overlay split view + line="1587">an overlay split view @@ -23717,19 +23745,19 @@ overlay-split-view value="max-sidebar-width"/> Gets the maximum sidebar width for @self. + line="1727">Gets the maximum sidebar width for @self. the maximum width + line="1733">the maximum width an overlay split view + line="1729">an overlay split view @@ -23742,19 +23770,19 @@ overlay-split-view value="min-sidebar-width"/> Gets the minimum sidebar width for @self. + line="1679">Gets the minimum sidebar width for @self. the minimum width + line="1685">the minimum width an overlay split view + line="1681">an overlay split view @@ -23766,19 +23794,19 @@ overlay-split-view Gets whether the sidebar widget is pinned for @self. + line="1538">Gets whether the sidebar widget is pinned for @self. whether if the sidebar widget is pinned + line="1544">whether if the sidebar widget is pinned an overlay split view + line="1540">an overlay split view @@ -23790,19 +23818,19 @@ overlay-split-view Gets whether the sidebar widget is shown for @self. + line="1502">Gets whether the sidebar widget is shown for @self. `TRUE` if the sidebar widget is shown + line="1508">`TRUE` if the sidebar widget is shown an overlay split view + line="1504">an overlay split view @@ -23814,19 +23842,19 @@ overlay-split-view Gets the sidebar widget for @self. + line="1281">Gets the sidebar widget for @self. the sidebar widget for @self + line="1287">the sidebar widget for @self an overlay split view + line="1283">an overlay split view @@ -23839,19 +23867,19 @@ overlay-split-view value="sidebar-position"/> Gets the sidebar position for @self. + line="1447">Gets the sidebar position for @self. the sidebar position for @self + line="1453">the sidebar position for @self an overlay split view + line="1449">an overlay split view @@ -23864,19 +23892,19 @@ overlay-split-view value="sidebar-width-fraction"/> Gets the preferred sidebar width fraction for @self. + line="1775">Gets the preferred sidebar width fraction for @self. the preferred width fraction + line="1781">the preferred width fraction an overlay split view + line="1777">an overlay split view @@ -23889,19 +23917,19 @@ overlay-split-view value="sidebar-width-unit"/> Gets the length unit for minimum and maximum sidebar widths. + line="1826">Gets the length unit for minimum and maximum sidebar widths. the length unit + line="1832">the length unit an overlay split view + line="1828">an overlay split view @@ -23913,7 +23941,7 @@ overlay-split-view Sets whether @self view is collapsed. + line="1391">Sets whether @self view is collapsed. When collapsed, the sidebar widget is presented as an overlay above the content widget, otherwise they are displayed side by side. @@ -23925,13 +23953,13 @@ content widget, otherwise they are displayed side by side. an overlay split view + line="1393">an overlay split view whether @self is collapsed + line="1394">whether @self is collapsed @@ -23943,7 +23971,7 @@ content widget, otherwise they are displayed side by side. Sets the content widget for @self. + line="1346">Sets the content widget for @self. @@ -23952,7 +23980,7 @@ content widget, otherwise they are displayed side by side. an overlay split view + line="1348">an overlay split view allow-none="1"> the content widget + line="1349">the content widget @@ -23974,7 +24002,7 @@ content widget, otherwise they are displayed side by side. value="enable-hide-gesture"/> Sets whether @self can be closed with a swipe gesture. + line="1650">Sets whether @self can be closed with a swipe gesture. Only touchscreen swipes are supported. @@ -23985,13 +24013,13 @@ Only touchscreen swipes are supported. an overlay split view + line="1652">an overlay split view whether @self can be closed with a swipe gesture + line="1653">whether @self can be closed with a swipe gesture @@ -24004,7 +24032,7 @@ Only touchscreen swipes are supported. value="enable-show-gesture"/> Sets whether @self can be opened with an edge swipe gesture. + line="1603">Sets whether @self can be opened with an edge swipe gesture. Only touchscreen swipes are supported. @@ -24015,13 +24043,13 @@ Only touchscreen swipes are supported. an overlay split view + line="1605">an overlay split view whether @self can be opened with a swipe gesture + line="1606">whether @self can be opened with a swipe gesture @@ -24034,7 +24062,7 @@ Only touchscreen swipes are supported. value="max-sidebar-width"/> Sets the maximum sidebar width for @self. + line="1745">Sets the maximum sidebar width for @self. Maximum width is affected by [property@OverlaySplitView:sidebar-width-unit]. @@ -24048,13 +24076,13 @@ minimum width exceeds it. an overlay split view + line="1747">an overlay split view the maximum width + line="1748">the maximum width @@ -24067,7 +24095,7 @@ minimum width exceeds it. value="min-sidebar-width"/> Sets the minimum sidebar width for @self. + line="1697">Sets the minimum sidebar width for @self. Minimum width is affected by [property@OverlaySplitView:sidebar-width-unit]. @@ -24081,13 +24109,13 @@ minimum width exceeds it. an overlay split view + line="1699">an overlay split view the minimum width + line="1700">the minimum width @@ -24099,7 +24127,7 @@ minimum width exceeds it. Sets whether the sidebar widget is pinned for @self. + line="1556">Sets whether the sidebar widget is pinned for @self. By default, collapsing @self automatically hides the sidebar widget, and uncollapsing it shows the sidebar. If set to `TRUE`, sidebar visibility never @@ -24112,13 +24140,13 @@ changes on its own. an overlay split view + line="1558">an overlay split view whether to pin the sidebar widget + line="1559">whether to pin the sidebar widget @@ -24130,7 +24158,7 @@ changes on its own. Sets whether the sidebar widget is shown for @self. + line="1520">Sets whether the sidebar widget is shown for @self. @@ -24139,13 +24167,13 @@ changes on its own. an overlay split view + line="1522">an overlay split view whether to show the sidebar widget + line="1523">whether to show the sidebar widget @@ -24157,7 +24185,7 @@ changes on its own. Sets the sidebar widget for @self. + line="1299">Sets the sidebar widget for @self. @@ -24166,7 +24194,7 @@ changes on its own. an overlay split view + line="1301">an overlay split view allow-none="1"> the sidebar widget + line="1302">the sidebar widget @@ -24188,7 +24216,7 @@ changes on its own. value="sidebar-position"/> Sets the sidebar position for @self. + line="1465">Sets the sidebar position for @self. If it's set to `GTK_PACK_START`, the sidebar is displayed before the content, if `GTK_PACK_END`, it's displayed after the content. @@ -24200,13 +24228,13 @@ if `GTK_PACK_END`, it's displayed after the content. an overlay split view + line="1467">an overlay split view the new position + line="1468">the new position @@ -24219,7 +24247,7 @@ if `GTK_PACK_END`, it's displayed after the content. value="sidebar-width-fraction"/> Sets the preferred sidebar width as a fraction of the total width of @self. + line="1793">Sets the preferred sidebar width as a fraction of the total width of @self. The preferred width is additionally limited by [property@OverlaySplitView:min-sidebar-width] and @@ -24235,13 +24263,13 @@ width exceeds the preferred width. an overlay split view + line="1795">an overlay split view the preferred width fraction + line="1796">the preferred width fraction @@ -24254,7 +24282,7 @@ width exceeds the preferred width. value="sidebar-width-unit"/> Sets the length unit for minimum and maximum sidebar widths. + line="1844">Sets the length unit for minimum and maximum sidebar widths. See [property@OverlaySplitView:min-sidebar-width] and [property@OverlaySplitView:max-sidebar-width]. @@ -24266,13 +24294,13 @@ See [property@OverlaySplitView:min-sidebar-width] and an overlay split view + line="1846">an overlay split view the length unit + line="1847">the length unit @@ -24290,7 +24318,7 @@ See [property@OverlaySplitView:min-sidebar-width] and value="adw_overlay_split_view_set_collapsed"/> Whether the split view is collapsed. + line="900">Whether the split view is collapsed. When collapsed, the sidebar widget is presented as an overlay above the content widget, otherwise they are displayed side by side. @@ -24308,7 +24336,7 @@ content widget, otherwise they are displayed side by side. value="adw_overlay_split_view_set_content"/> The content widget. + line="876">The content widget. value="adw_overlay_split_view_set_enable_hide_gesture"/> Whether the sidebar can be closed with a swipe gesture. + line="973">Whether the sidebar can be closed with a swipe gesture. Only touchscreen swipes are supported. @@ -24342,7 +24370,7 @@ Only touchscreen swipes are supported. value="adw_overlay_split_view_set_enable_show_gesture"/> Whether the sidebar can be opened with an edge swipe gesture. + line="959">Whether the sidebar can be opened with an edge swipe gesture. Only touchscreen swipes are supported. @@ -24360,7 +24388,7 @@ Only touchscreen swipes are supported. value="adw_overlay_split_view_set_max_sidebar_width"/> The maximum sidebar width. + line="1005">The maximum sidebar width. Maximum width is affected by [property@OverlaySplitView:sidebar-width-unit]. @@ -24382,7 +24410,7 @@ minimum width exceeds it. value="adw_overlay_split_view_set_min_sidebar_width"/> The minimum sidebar width. + line="987">The minimum sidebar width. Minimum width is affected by [property@OverlaySplitView:sidebar-width-unit]. @@ -24404,7 +24432,7 @@ minimum width exceeds it. value="adw_overlay_split_view_set_pin_sidebar"/> Whether the sidebar widget is pinned. + line="943">Whether the sidebar widget is pinned. By default, collapsing @self automatically hides the sidebar widget, and uncollapsing it shows the sidebar. If set to `TRUE`, sidebar visibility @@ -24424,7 +24452,7 @@ never changes on its own. value="adw_overlay_split_view_set_show_sidebar"/> Whether the sidebar widget is shown. + line="931">Whether the sidebar widget is shown. value="adw_overlay_split_view_set_sidebar"/> The sidebar widget. + line="888">The sidebar widget. value="adw_overlay_split_view_set_sidebar_position"/> The sidebar position. + line="915">The sidebar position. If it's set to `GTK_PACK_START`, the sidebar is displayed before the content, if `GTK_PACK_END`, it's displayed after the content. @@ -24474,7 +24502,7 @@ if `GTK_PACK_END`, it's displayed after the content. value="adw_overlay_split_view_set_sidebar_width_fraction"/> The preferred sidebar width as a fraction of the total width. + line="1023">The preferred sidebar width as a fraction of the total width. The preferred width is additionally limited by [property@OverlaySplitView:min-sidebar-width] and @@ -24497,7 +24525,7 @@ width exceeds the preferred width. value="adw_overlay_split_view_set_sidebar_width_unit"/> The length unit for minimum and maximum sidebar widths. + line="1042">The length unit for minimum and maximum sidebar widths. See [property@OverlaySplitView:min-sidebar-width] and [property@OverlaySplitView:max-sidebar-width]. @@ -25006,19 +25034,19 @@ is set as the suffix on the end of the title and description. Creates a new `AdwPreferencesGroup`. + line="350">Creates a new `AdwPreferencesGroup`. the newly created `AdwPreferencesGroup` + line="355">the newly created `AdwPreferencesGroup` Adds a child to @self. + line="363">Adds a child to @self. @@ -25027,13 +25055,13 @@ is set as the suffix on the end of the title and description. a preferences group + line="365">a preferences group the widget to add + line="366">the widget to add @@ -25044,19 +25072,19 @@ is set as the suffix on the end of the title and description. Gets the description of @self. + line="464">Gets the description of @self. the description of @self + line="470">the description of @self a preferences group + line="466">a preferences group @@ -25065,21 +25093,22 @@ is set as the suffix on the end of the title and description. c:identifier="adw_preferences_group_get_header_suffix" glib:get-property="header-suffix" version="1.1"> + Gets the suffix for @self's header. + line="511">Gets the suffix for @self's header. the suffix for @self's header. + line="517">the suffix for @self's header. a `AdwPreferencesGroup` + line="513">a `AdwPreferencesGroup` @@ -25090,19 +25119,19 @@ is set as the suffix on the end of the title and description. Gets the title of @self. + line="417">Gets the title of @self. the title of @self + line="423">the title of @self a preferences group + line="419">a preferences group @@ -25110,7 +25139,7 @@ is set as the suffix on the end of the title and description. Removes a child from @self. + line="388">Removes a child from @self. @@ -25119,13 +25148,13 @@ is set as the suffix on the end of the title and description. a preferences group + line="390">a preferences group the child to remove + line="391">the child to remove @@ -25136,7 +25165,7 @@ is set as the suffix on the end of the title and description. Sets the description for @self. + line="484">Sets the description for @self. @@ -25145,7 +25174,7 @@ is set as the suffix on the end of the title and description. a preferences group + line="486">a preferences group the description + line="487">the description @@ -25163,9 +25192,10 @@ is set as the suffix on the end of the title and description. c:identifier="adw_preferences_group_set_header_suffix" glib:set-property="header-suffix" version="1.1"> + Sets the suffix for @self's header. + line="533">Sets the suffix for @self's header. Displayed above the list, next to the title and description. @@ -25178,7 +25208,7 @@ Suffixes are commonly used to show a button or a spinner for the whole group. a `AdwPreferencesGroup` + line="535">a `AdwPreferencesGroup` the suffix to set + line="536">the suffix to set @@ -25198,7 +25228,7 @@ Suffixes are commonly used to show a button or a spinner for the whole group. Sets the title for @self. + line="437">Sets the title for @self. @@ -25207,13 +25237,13 @@ Suffixes are commonly used to show a button or a spinner for the whole group. a preferences group + line="439">a preferences group the title + line="440">the title @@ -25229,7 +25259,7 @@ Suffixes are commonly used to show a button or a spinner for the whole group. The description for this group of preferences. + line="263">The description for this group of preferences. The header suffix widget. + line="273">The header suffix widget. Displayed above the list, next to the title and description. @@ -25263,7 +25293,7 @@ group. value="adw_preferences_group_set_title"/> The title for this group of preferences. + line="253">The title for this group of preferences. @@ -25319,19 +25349,19 @@ of a preferences window. Creates a new `AdwPreferencesPage`. + line="269">Creates a new `AdwPreferencesPage`. the newly created `AdwPreferencesPage` + line="274">the newly created `AdwPreferencesPage` Adds a preferences group to @self. + line="282">Adds a preferences group to @self. @@ -25340,13 +25370,13 @@ of a preferences window. a preferences page + line="284">a preferences page the group to add + line="285">the group to add @@ -25358,19 +25388,19 @@ of a preferences window. Gets the description of @self. + line="413">Gets the description of @self. the description of @self. + line="419">the description of @self. a preferences page + line="415">a preferences page @@ -25381,19 +25411,19 @@ of a preferences window. Gets the icon name for @self. + line="327">Gets the icon name for @self. the icon name for @self + line="333">the icon name for @self a preferences page + line="329">a preferences page @@ -25404,19 +25434,19 @@ of a preferences window. Gets the name of @self. + line="466">Gets the name of @self. the name of @self + line="472">the name of @self a preferences page + line="468">a preferences page @@ -25427,19 +25457,19 @@ of a preferences window. Gets the title of @self. + line="370">Gets the title of @self. the title of @self. + line="376">the title of @self. a preferences page + line="372">a preferences page @@ -25450,19 +25480,19 @@ of a preferences window. Gets whether an embedded underline in the title indicates a mnemonic. + line="509">Gets whether an embedded underline in the title indicates a mnemonic. whether an embedded underline in the title indicates a mnemonic + line="515">whether an embedded underline in the title indicates a mnemonic a preferences page + line="511">a preferences page @@ -25470,7 +25500,7 @@ of a preferences window. Removes a group from @self. + line="303">Removes a group from @self. @@ -25479,13 +25509,13 @@ of a preferences window. a preferences page + line="305">a preferences page the group to remove + line="306">the group to remove @@ -25495,7 +25525,7 @@ of a preferences window. version="1.3"> Scrolls the scrolled window of @self to the top. + line="597">Scrolls the scrolled window of @self to the top. @@ -25504,7 +25534,7 @@ of a preferences window. a preferences page + line="599">a preferences page @@ -25516,7 +25546,7 @@ of a preferences window. Sets the description of @self. + line="435">Sets the description of @self. The description is displayed at the top of the page. @@ -25527,13 +25557,13 @@ The description is displayed at the top of the page. a preferences page + line="437">a preferences page the description + line="438">the description @@ -25544,7 +25574,7 @@ The description is displayed at the top of the page. Sets the icon name for @self. + line="347">Sets the icon name for @self. @@ -25553,7 +25583,7 @@ The description is displayed at the top of the page. a preferences page + line="349">a preferences page allow-none="1"> the icon name + line="350">the icon name @@ -25573,7 +25603,7 @@ The description is displayed at the top of the page. Sets the name of @self. + line="486">Sets the name of @self. @@ -25582,7 +25612,7 @@ The description is displayed at the top of the page. a preferences page + line="488">a preferences page allow-none="1"> the name + line="489">the name @@ -25602,7 +25632,7 @@ The description is displayed at the top of the page. Sets the title of @self. + line="390">Sets the title of @self. @@ -25611,13 +25641,13 @@ The description is displayed at the top of the page. a preferences page + line="392">a preferences page the title + line="393">the title @@ -25628,7 +25658,7 @@ The description is displayed at the top of the page. Sets whether an embedded underline in the title indicates a mnemonic. + line="529">Sets whether an embedded underline in the title indicates a mnemonic. @@ -25637,13 +25667,13 @@ The description is displayed at the top of the page. a preferences page + line="531">a preferences page `TRUE` if underlines in the text indicate mnemonics + line="532">`TRUE` if underlines in the text indicate mnemonics @@ -25660,7 +25690,7 @@ The description is displayed at the top of the page. value="adw_preferences_page_set_description"/> The description to be displayed at the top of the page. + line="192">The description to be displayed at the top of the page. value="adw_preferences_page_set_icon_name"/> The icon name for this page. + line="172">The icon name for this page. value="adw_preferences_page_set_name"/> The name of this page. + line="204">The name of this page. value="adw_preferences_page_set_title"/> The title for this page. + line="182">The title for this page. value="adw_preferences_page_set_use_underline"/> Whether an embedded underline in the title indicates a mnemonic. + line="214">Whether an embedded underline in the title indicates a mnemonic. @@ -29434,20 +29464,20 @@ with [property@Squeezer:transition-type]. Gets whether to allow squeezing beyond the last child's minimum size. + line="1566">Gets whether to allow squeezing beyond the last child's minimum size. See [the migration guide](migrating-to-breakpoints.html#replace-adwsqueezer) whether @self allows squeezing beyond the last child + line="1572">whether @self allows squeezing beyond the last child a squeezer + line="1568">a squeezer @@ -29487,20 +29517,20 @@ with [property@Squeezer:transition-type]. value="interpolate-size"/> Gets whether @self interpolates its size when changing the visible child. + line="1718">Gets whether @self interpolates its size when changing the visible child. See [the migration guide](migrating-to-breakpoints.html#replace-adwsqueezer) whether the size is interpolated + line="1724">whether the size is interpolated A squeezer + line="1720">A squeezer @@ -29543,7 +29573,7 @@ with [property@Squeezer:transition-type]. Returns a [iface@Gio.ListModel] that contains the pages of @self. + line="1863">Returns a [iface@Gio.ListModel] that contains the pages of @self. This can be used to keep an up-to-date view. The model also implements [iface@Gtk.SelectionModel] and can be used to track the visible page. @@ -29552,14 +29582,14 @@ This can be used to keep an up-to-date view. The model also implements a `GtkSelectionModel` for the squeezer's children + line="1872">a `GtkSelectionModel` for the squeezer's children a squeezer + line="1865">a squeezer @@ -29577,6 +29607,9 @@ This can be used to keep an up-to-date view. The model also implements See [the migration guide](migrating-to-breakpoints.html#replace-adwsqueezer) + the fold threshold policy @@ -29597,20 +29630,20 @@ This can be used to keep an up-to-date view. The model also implements value="transition-duration"/> Gets the transition animation duration for @self. + line="1615">Gets the transition animation duration for @self. See [the migration guide](migrating-to-breakpoints.html#replace-adwsqueezer) the transition duration, in milliseconds + line="1621">the transition duration, in milliseconds a squeezer + line="1617">a squeezer @@ -29624,7 +29657,7 @@ This can be used to keep an up-to-date view. The model also implements value="transition-running"/> Gets whether a transition is currently running for @self. + line="1696">Gets whether a transition is currently running for @self. If a transition is impossible, the property value will be set to `TRUE` and then immediately to `FALSE`, so it's possible to rely on its notifications @@ -29634,14 +29667,14 @@ to know that a transition has happened. whether a transition is currently running + line="1706">whether a transition is currently running a squeezer + line="1698">a squeezer @@ -29654,13 +29687,13 @@ to know that a transition has happened. Gets the type of animation used for transitions between children in @self. + line="1656">Gets the type of animation used for transitions between children in @self. See [the migration guide](migrating-to-breakpoints.html#replace-adwsqueezer) the current transition type of @self + line="1662">the current transition type of @self @@ -29668,7 +29701,7 @@ to know that a transition has happened. a squeezer + line="1658">a squeezer @@ -29707,20 +29740,20 @@ to know that a transition has happened. Gets the horizontal alignment, from 0 (start) to 1 (end). + line="1765">Gets the horizontal alignment, from 0 (start) to 1 (end). See [the migration guide](migrating-to-breakpoints.html#replace-adwsqueezer) the alignment value + line="1771">the alignment value a squeezer + line="1767">a squeezer @@ -29733,20 +29766,20 @@ to know that a transition has happened. Gets the vertical alignment, from 0 (top) to 1 (bottom). + line="1814">Gets the vertical alignment, from 0 (top) to 1 (bottom). See [the migration guide](migrating-to-breakpoints.html#replace-adwsqueezer) the alignment value + line="1820">the alignment value a squeezer + line="1816">a squeezer @@ -29786,7 +29819,7 @@ to know that a transition has happened. Sets whether to allow squeezing beyond the last child's minimum size. + line="1584">Sets whether to allow squeezing beyond the last child's minimum size. If set to `TRUE`, the squeezer can shrink to the point where no child can be shown. This is functionally equivalent to appending a widget with 0×0 minimum @@ -29800,13 +29833,13 @@ size. a squeezer + line="1586">a squeezer whether @self allows squeezing beyond the last child + line="1587">whether @self allows squeezing beyond the last child @@ -29853,7 +29886,7 @@ size when a different child becomes visible. value="interpolate-size"/> Sets whether @self interpolates its size when changing the visible child. + line="1736">Sets whether @self interpolates its size when changing the visible child. If `TRUE`, the squeezer will interpolate its size between the one of the previous visible child and the one of the new visible child, according to the @@ -29868,13 +29901,13 @@ horizontal, it will interpolate the its height. A squeezer + line="1738">A squeezer whether to interpolate the size + line="1739">whether to interpolate the size @@ -29888,7 +29921,7 @@ horizontal, it will interpolate the its height. value="switch-threshold-policy"/> Sets the switch threshold policy for @self. + line="1531">Sets the switch threshold policy for @self. Determines when the squeezer will switch children. @@ -29907,13 +29940,13 @@ ellipsize instead of immediately switching. a squeezer + line="1533">a squeezer the policy to use + line="1534">the policy to use @@ -29927,7 +29960,7 @@ ellipsize instead of immediately switching. value="transition-duration"/> Sets the transition animation duration for @self. + line="1633">Sets the transition animation duration for @self. See [the migration guide](migrating-to-breakpoints.html#replace-adwsqueezer) @@ -29937,13 +29970,13 @@ ellipsize instead of immediately switching. a squeezer + line="1635">a squeezer the new duration, in milliseconds + line="1636">the new duration, in milliseconds @@ -29956,7 +29989,7 @@ ellipsize instead of immediately switching. Sets the type of animation used for transitions between children in @self. + line="1674">Sets the type of animation used for transitions between children in @self. See [the migration guide](migrating-to-breakpoints.html#replace-adwsqueezer) @@ -29966,13 +29999,13 @@ ellipsize instead of immediately switching. a squeezer + line="1676">a squeezer the new transition type + line="1677">the new transition type @@ -29986,7 +30019,7 @@ ellipsize instead of immediately switching. Sets the horizontal alignment, from 0 (start) to 1 (end). + line="1783">Sets the horizontal alignment, from 0 (start) to 1 (end). This affects the children allocation during transitions, when they exceed the size of the squeezer. @@ -30002,13 +30035,13 @@ start side aligned and overflow the end side, and 1 means the opposite. a squeezer + line="1785">a squeezer the new alignment value + line="1786">the new alignment value @@ -30021,7 +30054,7 @@ start side aligned and overflow the end side, and 1 means the opposite. Sets the vertical alignment, from 0 (top) to 1 (bottom). + line="1832">Sets the vertical alignment, from 0 (top) to 1 (bottom). This affects the children allocation during transitions, when they exceed the size of the squeezer. @@ -30037,13 +30070,13 @@ top side aligned and overflow the bottom side, and 1 means the opposite. a squeezer + line="1834">a squeezer the new alignment value + line="1835">the new alignment value @@ -34461,19 +34494,19 @@ See [property@Gtk.DropTarget:value]. Gets the child of @self. + line="2817">Gets the child of @self. the child of @self + line="2823">the child of @self a tab page + line="2819">a tab page @@ -34484,19 +34517,19 @@ See [property@Gtk.DropTarget:value]. Gets the icon of @self. + line="2971">Gets the icon of @self. the icon of @self + line="2977">the icon of @self a tab page + line="2973">a tab page @@ -34508,19 +34541,19 @@ See [property@Gtk.DropTarget:value]. value="indicator-activatable"/> Gets whether the indicator of @self is activatable. + line="3154">Gets whether the indicator of @self is activatable. whether the indicator is activatable + line="3161">whether the indicator is activatable a tab page + line="3156">a tab page @@ -34531,19 +34564,19 @@ See [property@Gtk.DropTarget:value]. Gets the indicator icon of @self. + line="3058">Gets the indicator icon of @self. the indicator icon of @self + line="3064">the indicator icon of @self a tab page + line="3060">a tab page @@ -34556,19 +34589,19 @@ See [property@Gtk.DropTarget:value]. value="indicator-tooltip"/> Gets the tooltip of the indicator icon of @self. + line="3110">Gets the tooltip of the indicator icon of @self. the indicator tooltip of @self + line="3116">the indicator tooltip of @self a tab page + line="3112">a tab page @@ -34580,19 +34613,19 @@ See [property@Gtk.DropTarget:value]. Gets the search keyword of @self. + line="3248">Gets the search keyword of @self. the search keyword of @self + line="3254">the search keyword of @self a tab page + line="3250">a tab page @@ -34604,19 +34637,19 @@ See [property@Gtk.DropTarget:value]. Gets whether to live thumbnail is enabled @self. + line="3396">Gets whether to live thumbnail is enabled @self. whether live thumbnail is enabled + line="3402">whether live thumbnail is enabled a tab overview + line="3398">a tab overview @@ -34627,19 +34660,19 @@ See [property@Gtk.DropTarget:value]. Gets whether @self is loading. + line="3013">Gets whether @self is loading. whether @self is loading + line="3019">whether @self is loading a tab page + line="3015">a tab page @@ -34650,19 +34683,19 @@ See [property@Gtk.DropTarget:value]. Gets whether @self needs attention. + line="3199">Gets whether @self needs attention. whether @self needs attention + line="3205">whether @self needs attention a tab page + line="3201">a tab page @@ -34673,21 +34706,21 @@ See [property@Gtk.DropTarget:value]. Gets the parent page of @self. + line="2833">Gets the parent page of @self. See [method@TabView.add_page] and [method@TabView.close_page]. the parent page + line="2841">the parent page a tab page + line="2835">a tab page @@ -34698,21 +34731,21 @@ See [method@TabView.add_page] and [method@TabView.close_page]. Gets whether @self is pinned. + line="2867">Gets whether @self is pinned. See [method@TabView.set_page_pinned]. whether @self is pinned + line="2875">whether @self is pinned a tab page + line="2869">a tab page @@ -34723,19 +34756,19 @@ See [method@TabView.set_page_pinned]. Gets whether @self is selected. + line="2851">Gets whether @self is selected. whether @self is selected + line="2857">whether @self is selected a tab page + line="2853">a tab page @@ -34748,19 +34781,19 @@ See [method@TabView.set_page_pinned]. value="thumbnail-xalign"/> Gets the horizontal alignment of the thumbnail for @self. + line="3292">Gets the horizontal alignment of the thumbnail for @self. the horizontal alignment + line="3298">the horizontal alignment a tab page + line="3294">a tab page @@ -34773,19 +34806,19 @@ See [method@TabView.set_page_pinned]. value="thumbnail-yalign"/> Gets the vertical alignment of the thumbnail for @self. + line="3344">Gets the vertical alignment of the thumbnail for @self. the vertical alignment + line="3350">the vertical alignment a tab overview + line="3346">a tab overview @@ -34796,19 +34829,19 @@ See [method@TabView.set_page_pinned]. Gets the title of @self. + line="2885">Gets the title of @self. the title of @self + line="2891">the title of @self a tab page + line="2887">a tab page @@ -34819,19 +34852,19 @@ See [method@TabView.set_page_pinned]. Gets the tooltip of @self. + line="2931">Gets the tooltip of @self. the tooltip of @self + line="2937">the tooltip of @self a tab page + line="2933">a tab page @@ -34841,7 +34874,7 @@ See [method@TabView.set_page_pinned]. version="1.3"> Invalidates thumbnail for @self. + line="3450">Invalidates thumbnail for @self. If an [class@TabOverview] is open, the thumbnail representing @self will be immediately updated. Otherwise it will be update when opening the overview. @@ -34857,7 +34890,7 @@ See also [method@TabView.invalidate_thumbnails]. a tab page + line="3452">a tab page @@ -34868,7 +34901,7 @@ See also [method@TabView.invalidate_thumbnails]. Sets the icon of @self. + line="2987">Sets the icon of @self. [class@TabBar] and [class@TabOverview] display the icon next to the title, unless [property@TabPage:loading] is set to `TRUE`. @@ -34883,7 +34916,7 @@ unless [property@TabPage:loading] is set to `TRUE`. a tab page + line="2989">a tab page the icon of @self + line="2990">the icon of @self @@ -34904,7 +34937,7 @@ unless [property@TabPage:loading] is set to `TRUE`. value="indicator-activatable"/> Sets whether the indicator of @self is activatable. + line="3171">Sets whether the indicator of @self is activatable. If set to `TRUE`, [signal@TabView::indicator-activated] will be emitted when the indicator icon is clicked. @@ -34918,13 +34951,13 @@ If [property@TabPage:indicator-icon] is not set, does nothing. a tab page + line="3173">a tab page whether the indicator is activatable + line="3174">whether the indicator is activatable @@ -34935,7 +34968,7 @@ If [property@TabPage:indicator-icon] is not set, does nothing. Sets the indicator icon of @self. + line="3074">Sets the indicator icon of @self. A common use case is an audio or camera indicator in a web browser. @@ -34960,7 +34993,7 @@ indicator icon can act as a button. a tab page + line="3076">a tab page allow-none="1"> the indicator icon of @self + line="3077">the indicator icon of @self @@ -34982,7 +35015,7 @@ indicator icon can act as a button. value="indicator-tooltip"/> Sets the tooltip of the indicator icon of @self. + line="3128">Sets the tooltip of the indicator icon of @self. The tooltip can be marked up with the Pango text markup language. @@ -34995,13 +35028,13 @@ See [property@TabPage:indicator-icon]. a tab page + line="3130">a tab page the indicator tooltip of @self + line="3131">the indicator tooltip of @self @@ -35013,7 +35046,7 @@ See [property@TabPage:indicator-icon]. Sets the search keyword for @self. + line="3266">Sets the search keyword for @self. [class@TabOverview] can search pages by their keywords in addition to their titles and tooltips. @@ -35027,13 +35060,13 @@ Keywords allow to include e.g. page URLs into tab search in a web browser. a tab page + line="3268">a tab page the search keyword + line="3269">the search keyword @@ -35045,7 +35078,7 @@ Keywords allow to include e.g. page URLs into tab search in a web browser. Sets whether to enable live thumbnail for @self. + line="3414">Sets whether to enable live thumbnail for @self. When set to `TRUE`, @self's thumbnail in [class@TabOverview] will update immediately when @self is redrawn or resized. @@ -35062,13 +35095,13 @@ selected, and otherwise it will be static and will only update when a tab page + line="3416">a tab page whether to enable live thumbnail + line="3417">whether to enable live thumbnail @@ -35079,7 +35112,7 @@ selected, and otherwise it will be static and will only update when Sets whether @self is loading. + line="3029">Sets whether @self is loading. If set to `TRUE`, [class@TabBar] and [class@TabOverview] will display a spinner in place of icon. @@ -35094,13 +35127,13 @@ status will not be visible with `AdwTabBar`. a tab page + line="3031">a tab page whether @self is loading + line="3032">whether @self is loading @@ -35111,7 +35144,7 @@ status will not be visible with `AdwTabBar`. Sets whether @self needs attention. + line="3215">Sets whether @self needs attention. [class@TabBar] will display a line under the tab representing the page if set to `TRUE`. If the tab is not visible, the corresponding edge of the tab @@ -35130,13 +35163,13 @@ selected have [property@TabPage:needs-attention] set to `TRUE`. a tab page + line="3217">a tab page whether @self needs attention + line="3218">whether @self needs attention @@ -35149,7 +35182,7 @@ selected have [property@TabPage:needs-attention] set to `TRUE`. value="thumbnail-xalign"/> Sets the horizontal alignment of the thumbnail for @self. + line="3310">Sets the horizontal alignment of the thumbnail for @self. If the page is so wide that [class@TabOverview] can't display it completely and has to crop it, horizontal alignment will determine which part of the @@ -35167,13 +35200,13 @@ The default horizontal alignment is 0. a tab page + line="3312">a tab page the new value + line="3313">the new value @@ -35186,7 +35219,7 @@ The default horizontal alignment is 0. value="thumbnail-yalign"/> Sets the vertical alignment of the thumbnail for @self. + line="3362">Sets the vertical alignment of the thumbnail for @self. If the page is so tall that [class@TabOverview] can't display it completely and has to crop it, vertical alignment will determine which part of the page @@ -35204,13 +35237,13 @@ The default vertical alignment is 0. a tab page + line="3364">a tab page the new value + line="3365">the new value @@ -35221,7 +35254,7 @@ The default vertical alignment is 0. [class@TabBar] will display it in the center of the tab unless it's pinned, + line="2901">[class@TabBar] will display it in the center of the tab unless it's pinned, and will use it as a tooltip unless [property@TabPage:tooltip] is set. [class@TabOverview] will display it below the thumbnail unless it's pinned, @@ -35237,13 +35270,13 @@ Sets the title of @self. a tab page + line="2903">a tab page the title of @self + line="2904">the title of @self @@ -35254,7 +35287,7 @@ Sets the title of @self. Sets the tooltip of @self. + line="2947">Sets the tooltip of @self. The tooltip can be marked up with the Pango text markup language. @@ -35268,13 +35301,13 @@ If not set, [class@TabBar] and [class@TabOverview] will use a tab page + line="2949">a tab page the tooltip of @self + line="2950">the tooltip of @self @@ -35660,19 +35693,19 @@ are the accessible parent objects of the child widgets. Creates a new `AdwTabView`. + line="3489">Creates a new `AdwTabView`. the newly created `AdwTabView` + line="3494">the newly created `AdwTabView` Adds @child to @self with @parent as the parent. + line="4072">Adds @child to @self with @parent as the parent. This function can be used to automatically position new pages, and to select the correct page when this page is closed while being selected (see @@ -35683,20 +35716,20 @@ If @parent is `NULL`, this function is equivalent to [method@TabView.append]. the page object representing @child + line="4086">the page object representing @child a tab view + line="4074">a tab view a widget to add + line="4075">a widget to add a parent page for @child + line="4076">a parent page for @child @@ -35715,7 +35748,7 @@ If @parent is `NULL`, this function is equivalent to [method@TabView.append]. Adds @shortcuts for @self. + line="3868">Adds @shortcuts for @self. See [property@TabView:shortcuts] for details. @@ -35726,13 +35759,13 @@ See [property@TabView:shortcuts] for details. a tab view + line="3870">a tab view the shortcuts to add + line="3871">the shortcuts to add @@ -35740,25 +35773,25 @@ See [property@TabView:shortcuts] for details. Inserts @child as the last non-pinned page. + line="4172">Inserts @child as the last non-pinned page. the page object representing @child + line="4179">the page object representing @child a tab view + line="4174">a tab view a widget to add + line="4175">a widget to add @@ -35766,25 +35799,25 @@ See [property@TabView:shortcuts] for details. Inserts @child as the last pinned page. + line="4238">Inserts @child as the last pinned page. the page object representing @child + line="4245">the page object representing @child a tab view + line="4240">a tab view a widget to add + line="4241">a widget to add @@ -35793,7 +35826,7 @@ See [property@TabView:shortcuts] for details. c:identifier="adw_tab_view_close_other_pages"> Requests to close all pages other than @page. + line="4339">Requests to close all pages other than @page. @@ -35802,13 +35835,13 @@ See [property@TabView:shortcuts] for details. a tab view + line="4341">a tab view a page of @self + line="4342">a page of @self @@ -35816,7 +35849,7 @@ See [property@TabView:shortcuts] for details. Requests to close @page. + line="4258">Requests to close @page. Calling this function will result in the [signal@TabView::close-page] signal being emitted for @page. Closing the page can then be confirmed or @@ -35846,13 +35879,13 @@ are pinned, the parent will be selected instead. a tab view + line="4260">a tab view a page of @self + line="4261">a page of @self @@ -35861,7 +35894,7 @@ are pinned, the parent will be selected instead. c:identifier="adw_tab_view_close_page_finish"> Completes a [method@TabView.close_page] call for @page. + line="4303">Completes a [method@TabView.close_page] call for @page. If @confirm is `TRUE`, @page will be closed. If it's `FALSE`, it will be reverted to its previous state and [method@TabView.close_page] can be called @@ -35877,19 +35910,19 @@ This function should not be called unless a custom handler for a tab view + line="4305">a tab view a page of @self + line="4306">a page of @self whether to confirm or deny closing @page + line="4307">whether to confirm or deny closing @page @@ -35898,7 +35931,7 @@ This function should not be called unless a custom handler for c:identifier="adw_tab_view_close_pages_after"> Requests to close all pages after @page. + line="4392">Requests to close all pages after @page. @@ -35907,13 +35940,13 @@ This function should not be called unless a custom handler for a tab view + line="4394">a tab view a page of @self + line="4395">a page of @self @@ -35922,7 +35955,7 @@ This function should not be called unless a custom handler for c:identifier="adw_tab_view_close_pages_before"> Requests to close all pages before @page. + line="4366">Requests to close all pages before @page. @@ -35931,13 +35964,13 @@ This function should not be called unless a custom handler for a tab view + line="4368">a tab view a page of @self + line="4369">a page of @self @@ -35948,19 +35981,19 @@ This function should not be called unless a custom handler for Gets the default icon of @self. + line="3721">Gets the default icon of @self. the default icon of @self. + line="3727">the default icon of @self. a tab view + line="3723">a tab view @@ -35972,7 +36005,7 @@ This function should not be called unless a custom handler for value="is-transferring-page"/> Whether a page is being transferred. + line="3536">Whether a page is being transferred. The corresponding property will be set to `TRUE` when a drag-n-drop tab transfer starts on any `AdwTabView`, and to `FALSE` after it ends. @@ -35983,14 +36016,14 @@ be safely dropped on the tab view. whether a page is being transferred + line="3548">whether a page is being transferred a tab view + line="3538">a tab view @@ -36001,19 +36034,19 @@ be safely dropped on the tab view. Gets the tab context menu model for @self. + line="3778">Gets the tab context menu model for @self. the tab context menu model for @self + line="3784">the tab context menu model for @self a tab view + line="3780">a tab view @@ -36024,19 +36057,19 @@ be safely dropped on the tab view. Gets the number of pages in @self. + line="3502">Gets the number of pages in @self. the number of pages in @self + line="3508">the number of pages in @self a tab view + line="3504">a tab view @@ -36047,21 +36080,21 @@ be safely dropped on the tab view. Gets the number of pinned pages in @self. + line="3518">Gets the number of pinned pages in @self. See [method@TabView.set_page_pinned]. the number of pinned pages in @self + line="3526">the number of pinned pages in @self a tab view + line="3520">a tab view @@ -36069,25 +36102,25 @@ See [method@TabView.set_page_pinned]. Gets the [class@TabPage] representing the child at @position. + line="4017">Gets the [class@TabPage] representing the child at @position. the page object at @position + line="4024">the page object at @position a tab view + line="4019">a tab view the index of the page in @self, starting from 0 + line="4020">the index of the page in @self, starting from 0 @@ -36095,25 +36128,25 @@ See [method@TabView.set_page_pinned]. Gets the [class@TabPage] object representing @child. + line="3988">Gets the [class@TabPage] object representing @child. the page object for @child + line="3995">the page object for @child a tab view + line="3990">a tab view a child in @self + line="3991">a child in @self @@ -36122,25 +36155,25 @@ See [method@TabView.set_page_pinned]. c:identifier="adw_tab_view_get_page_position"> Finds the position of @page in @self, starting from 0. + line="4043">Finds the position of @page in @self, starting from 0. the position of @page in @self + line="4050">the position of @page in @self a tab view + line="4045">a tab view a page of @self + line="4046">a page of @self @@ -36151,7 +36184,7 @@ See [method@TabView.set_page_pinned]. Returns a [iface@Gio.ListModel] that contains the pages of @self. + line="4664">Returns a [iface@Gio.ListModel] that contains the pages of @self. This can be used to keep an up-to-date view. The model also implements [iface@Gtk.SelectionModel] and can be used to track and change the selected @@ -36160,14 +36193,14 @@ page. a `GtkSelectionModel` for the pages of @self + line="4674">a `GtkSelectionModel` for the pages of @self a tab view + line="4666">a tab view @@ -36178,19 +36211,19 @@ page. Gets the currently selected page in @self. + line="3558">Gets the currently selected page in @self. the selected page + line="3564">the selected page a tab view + line="3560">a tab view @@ -36202,19 +36235,19 @@ page. Gets the enabled shortcuts for @self. + line="3820">Gets the enabled shortcuts for @self. the shortcut mask + line="3826">the shortcut mask a tab view + line="3822">a tab view @@ -36222,7 +36255,7 @@ page. Inserts a non-pinned page at @position. + line="4125">Inserts a non-pinned page at @position. It's an error to try to insert a page before a pinned page, in that case [method@TabView.insert_pinned] should be used instead. @@ -36230,26 +36263,26 @@ It's an error to try to insert a page before a pinned page, in that case the page object representing @child + line="4136">the page object representing @child a tab view + line="4127">a tab view a widget to add + line="4128">a widget to add the position to add @child at, starting from 0 + line="4129">the position to add @child at, starting from 0 @@ -36257,7 +36290,7 @@ It's an error to try to insert a page before a pinned page, in that case Inserts a pinned page at @position. + line="4192">Inserts a pinned page at @position. It's an error to try to insert a pinned page after a non-pinned page, in that case [method@TabView.insert] should be used instead. @@ -36265,26 +36298,26 @@ that case [method@TabView.insert] should be used instead. the page object representing @child + line="4203">the page object representing @child a tab view + line="4194">a tab view a widget to add + line="4195">a widget to add the position to add @child at, starting from 0 + line="4196">the position to add @child at, starting from 0 @@ -36294,7 +36327,7 @@ that case [method@TabView.insert] should be used instead. version="1.3"> Invalidates thumbnails for all pages in @self. + line="4691">Invalidates thumbnails for all pages in @self. This is a convenience method, equivalent to calling [method@TabPage.invalidate_thumbnail] on each page. @@ -36306,7 +36339,7 @@ This is a convenience method, equivalent to calling a tab view + line="4693">a tab view @@ -36314,25 +36347,25 @@ This is a convenience method, equivalent to calling Inserts @child as the first non-pinned page. + line="4152">Inserts @child as the first non-pinned page. the page object representing @child + line="4159">the page object representing @child a tab view + line="4154">a tab view a widget to add + line="4155">a widget to add @@ -36340,25 +36373,25 @@ This is a convenience method, equivalent to calling Inserts @child as the first pinned page. + line="4218">Inserts @child as the first pinned page. the page object representing @child + line="4225">the page object representing @child a tab view + line="4220">a tab view a widget to add + line="4221">a widget to add @@ -36368,7 +36401,7 @@ This is a convenience method, equivalent to calling version="1.2"> Removes @shortcuts from @self. + line="3889">Removes @shortcuts from @self. See [property@TabView:shortcuts] for details. @@ -36379,13 +36412,13 @@ See [property@TabView:shortcuts] for details. a tab view + line="3891">a tab view the shortcuts to reomve + line="3892">the shortcuts to reomve @@ -36394,25 +36427,25 @@ See [property@TabView:shortcuts] for details. c:identifier="adw_tab_view_reorder_backward"> Reorders @page to before its previous page if possible. + line="4474">Reorders @page to before its previous page if possible. whether @page was moved + line="4481">whether @page was moved a tab view + line="4476">a tab view a page of @self + line="4477">a page of @self @@ -36420,25 +36453,25 @@ See [property@TabView:shortcuts] for details. Reorders @page to the first possible position. + line="4536">Reorders @page to the first possible position. whether @page was moved + line="4543">whether @page was moved a tab view + line="4538">a tab view a page of @self + line="4539">a page of @self @@ -36447,25 +36480,25 @@ See [property@TabView:shortcuts] for details. c:identifier="adw_tab_view_reorder_forward"> Reorders @page to after its next page if possible. + line="4505">Reorders @page to after its next page if possible. whether @page was moved + line="4512">whether @page was moved a tab view + line="4507">a tab view a page of @self + line="4508">a page of @self @@ -36473,25 +36506,25 @@ See [property@TabView:shortcuts] for details. Reorders @page to the last possible position. + line="4562">Reorders @page to the last possible position. whether @page was moved + line="4569">whether @page was moved a tab view + line="4564">a tab view a page of @self + line="4565">a page of @self @@ -36499,7 +36532,7 @@ See [property@TabView:shortcuts] for details. Reorders @page to @position. + line="4418">Reorders @page to @position. It's a programmer error to try to reorder a pinned page after a non-pinned one, or a non-pinned page before a pinned one. @@ -36507,26 +36540,26 @@ one, or a non-pinned page before a pinned one. whether @page was moved + line="4429">whether @page was moved a tab view + line="4420">a tab view a page of @self + line="4421">a page of @self the position to insert the page at, starting at 0 + line="4422">the position to insert the page at, starting at 0 @@ -36535,21 +36568,21 @@ one, or a non-pinned page before a pinned one. c:identifier="adw_tab_view_select_next_page"> Selects the page after the currently selected page. + line="3630">Selects the page after the currently selected page. If the last page was already selected, this function does nothing. whether the selected page was changed + line="3638">whether the selected page was changed a tab view + line="3632">a tab view @@ -36558,21 +36591,21 @@ If the last page was already selected, this function does nothing. c:identifier="adw_tab_view_select_previous_page"> Selects the page before the currently selected page. + line="3597">Selects the page before the currently selected page. If the first page was already selected, this function does nothing. whether the selected page was changed + line="3605">whether the selected page was changed a tab view + line="3599">a tab view @@ -36583,7 +36616,7 @@ If the first page was already selected, this function does nothing. Sets the default page icon for @self. + line="3737">Sets the default page icon for @self. If a page doesn't provide its own icon via [property@TabPage:icon], a default icon may be used instead for contexts where having an icon is necessary. @@ -36603,13 +36636,13 @@ By default, the `adw-tab-icon-missing-symbolic` icon is used. a tab view + line="3739">a tab view the default icon + line="3740">the default icon @@ -36620,7 +36653,7 @@ By default, the `adw-tab-icon-missing-symbolic` icon is used. Sets the tab context menu model for @self. + line="3794">Sets the tab context menu model for @self. When a context menu is shown for a tab, it will be constructed from the provided menu model. Use the [signal@TabView::setup-menu] signal to set up @@ -36633,7 +36666,7 @@ the menu actions for the particular tab. a tab view + line="3796">a tab view allow-none="1"> a menu model + line="3797">a menu model @@ -36651,7 +36684,7 @@ the menu actions for the particular tab. c:identifier="adw_tab_view_set_page_pinned"> Pins or unpins @page. + line="3910">Pins or unpins @page. Pinned pages are guaranteed to be placed before all non-pinned pages; at any given moment the first [property@TabView:n-pinned-pages] pages in @self are @@ -36688,19 +36721,19 @@ Changes the value of the [property@TabPage:pinned] property. a tab view + line="3912">a tab view a page of @self + line="3913">a page of @self whether @page should be pinned + line="3914">whether @page should be pinned @@ -36711,7 +36744,7 @@ Changes the value of the [property@TabPage:pinned] property. Sets the currently selected page in @self. + line="3574">Sets the currently selected page in @self. @@ -36720,13 +36753,13 @@ Changes the value of the [property@TabPage:pinned] property. a tab view + line="3576">a tab view a page in @self + line="3577">a page in @self @@ -36738,7 +36771,7 @@ Changes the value of the [property@TabPage:pinned] property. Sets the enabled shortcuts for @self. + line="3838">Sets the enabled shortcuts for @self. See [flags@TabViewShortcuts] for the list of the available shortcuts. All of the shortcuts are enabled by default. @@ -36753,13 +36786,13 @@ a convenient way to manage individual shortcuts. a tab view + line="3840">a tab view the new shortcuts + line="3841">the new shortcuts @@ -36767,7 +36800,7 @@ a convenient way to manage individual shortcuts. Transfers @page from @self to @other_view. + line="4626">Transfers @page from @self to @other_view. The @page object will be reused. @@ -36781,25 +36814,25 @@ one, or a non-pinned page before a pinned one. a tab view + line="4628">a tab view a page of @self + line="4629">a page of @self the tab view to transfer the page to + line="4630">the tab view to transfer the page to the position to insert the page at, starting at 0 + line="4631">the position to insert the page at, starting at 0 @@ -36815,7 +36848,7 @@ one, or a non-pinned page before a pinned one. value="adw_tab_view_set_default_icon"/> Default page icon. + line="2469">Default page icon. If a page doesn't provide its own icon via [property@TabPage:icon], a default icon may be used instead for contexts where having an icon is @@ -36839,7 +36872,7 @@ By default, the `adw-tab-icon-missing-symbolic` icon is used. value="adw_tab_view_get_is_transferring_page"/> Whether a page is being transferred. + line="2443">Whether a page is being transferred. This property will be set to `TRUE` when a drag-n-drop tab transfer starts on any `AdwTabView`, and to `FALSE` after it ends. @@ -36859,7 +36892,7 @@ be safely dropped on the tab view. value="adw_tab_view_set_menu_model"/> Tab context menu model. + line="2492">Tab context menu model. When a context menu is shown for a tab, it will be constructed from the provided menu model. Use the [signal@TabView::setup-menu] signal to set up @@ -36874,7 +36907,7 @@ the menu actions for the particular tab. value="adw_tab_view_get_n_pages"/> The number of pages in the tab view. + line="2421">The number of pages in the tab view. value="adw_tab_view_get_n_pinned_pages"/> The number of pinned pages in the tab view. + line="2431">The number of pinned pages in the tab view. See [method@TabView.set_page_pinned]. @@ -36894,7 +36927,7 @@ See [method@TabView.set_page_pinned]. A selection model with the tab view's pages. + line="2525">A selection model with the tab view's pages. This can be used to keep an up-to-date view. The model also implements [iface@Gtk.SelectionModel] and can be used to track and change the selected @@ -36912,7 +36945,7 @@ page. value="adw_tab_view_set_selected_page"/> The currently selected page. + line="2459">The currently selected page. value="adw_tab_view_set_shortcuts"/> The enabled shortcuts. + line="2506">The enabled shortcuts. See [flags@TabViewShortcuts] for the list of the available shortcuts. All of the shortcuts are enabled by default. @@ -36940,7 +36973,7 @@ provide a convenient way to manage individual shortcuts. Emitted after [method@TabView.close_page] has been called for @page. + line="2618">Emitted after [method@TabView.close_page] has been called for @page. The handler is expected to call [method@TabView.close_page_finish] to confirm or reject the closing. @@ -36965,15 +36998,21 @@ the handler, so can be used to do asynchronous checks before confirming the closing. A typical reason to connect to this signal is to show a confirmation dialog -for closing a tab. +for closing a tab. + +The signal handler should return `GDK_EVENT_STOP` to stop propagation or +`GDK_EVENT_CONTINUE` to invoke the default handler. + whether propagation should be stopped a page of @self + line="2621">a page of @self @@ -36981,7 +37020,7 @@ for closing a tab. Emitted when a tab should be transferred into a new window. + line="2696">Emitted when a tab should be transferred into a new window. This can happen after a tab has been dropped on desktop. @@ -36990,14 +37029,14 @@ needed and return its `AdwTabView` that the page will be transferred into. the `AdwTabView` from the new window + line="2707">the `AdwTabView` from the new window Emitted after the indicator icon on @page has been activated. + line="2723">Emitted after the indicator icon on @page has been activated. See [property@TabPage:indicator-icon] and [property@TabPage:indicator-activatable]. @@ -37008,7 +37047,7 @@ See [property@TabPage:indicator-icon] and a page of @self + line="2726">a page of @self @@ -37016,7 +37055,7 @@ See [property@TabPage:indicator-icon] and Emitted when a page has been created or transferred to @self. + line="2541">Emitted when a page has been created or transferred to @self. A typical reason to connect to this signal would be to connect to page signals for things such as updating window title. @@ -37027,13 +37066,13 @@ signals for things such as updating window title. a page of @self + line="2544">a page of @self the position of the page, starting from 0 + line="2545">the position of the page, starting from 0 @@ -37041,7 +37080,7 @@ signals for things such as updating window title. Emitted when a page has been removed or transferred to another view. + line="2566">Emitted when a page has been removed or transferred to another view. A typical reason to connect to this signal would be to disconnect signal handlers connected in the [signal@TabView::page-attached] handler. @@ -37057,13 +37096,13 @@ child dispose handler for that or do it in sync with your a page of @self + line="2569">a page of @self the position of the removed page, starting from 0 + line="2570">the position of the removed page, starting from 0 @@ -37071,7 +37110,7 @@ child dispose handler for that or do it in sync with your Emitted after @page has been reordered to @position. + line="2596">Emitted after @page has been reordered to @position. @@ -37079,13 +37118,13 @@ child dispose handler for that or do it in sync with your a page of @self + line="2599">a page of @self the position @page was moved to, starting at 0 + line="2600">the position @page was moved to, starting at 0 @@ -37093,7 +37132,7 @@ child dispose handler for that or do it in sync with your Emitted when a context menu is opened or closed for @page. + line="2670">Emitted when a context menu is opened or closed for @page. If the menu has been closed, @page will be set to `NULL`. @@ -37109,7 +37148,7 @@ disable actions not applicable to @page. allow-none="1"> a page of @self + line="2673">a page of @self @@ -39966,7 +40005,7 @@ See also [property@ToolbarView:bottom-bar-style]. - + Adwaita version, encoded as a string, useful for printing and @@ -40345,7 +40384,7 @@ page. Gets the currently visible child of @self, . + line="1805">Gets the currently visible child of @self. introspectable="0"> A convenience function for showing an application’s about dialog. + line="3397">A convenience function for showing an application’s about dialog. @@ -43076,19 +43115,19 @@ library are set up properly. the parent widget + line="3399">the parent widget the name of the first property + line="3400">the name of the first property value of first property, followed by more pairs of property name and + line="3401">value of first property, followed by more pairs of property name and value, `NULL`-terminated @@ -43100,7 +43139,7 @@ library are set up properly. introspectable="0"> A convenience function for showing an application’s about dialog from + line="3427">A convenience function for showing an application’s about dialog from AppStream metadata. See [ctor@AboutDialog.new_from_appdata] for details. @@ -43112,13 +43151,13 @@ See [ctor@AboutDialog.new_from_appdata] for details. the parent widget + line="3429">the parent widget The resource to use + line="3430">The resource to use allow-none="1"> The version to retrieve release notes for + line="3431">The version to retrieve release notes for the name of the first property + line="3432">the name of the first property value of first property, followed by more pairs of property name and + line="3433">value of first property, followed by more pairs of property name and value, `NULL`-terminated @@ -43151,7 +43190,7 @@ See [ctor@AboutDialog.new_from_appdata] for details. introspectable="0"> A convenience function for showing an application’s about window. + line="3396">A convenience function for showing an application’s about window. @@ -43163,19 +43202,19 @@ See [ctor@AboutDialog.new_from_appdata] for details. allow-none="1"> the parent top-level window + line="3398">the parent top-level window the name of the first property + line="3399">the name of the first property value of first property, followed by more pairs of property name and + line="3400">value of first property, followed by more pairs of property name and value, `NULL`-terminated @@ -43187,7 +43226,7 @@ See [ctor@AboutDialog.new_from_appdata] for details. introspectable="0"> A convenience function for showing an application’s about window from + line="3427">A convenience function for showing an application’s about window from AppStream metadata. See [ctor@AboutWindow.new_from_appdata] for details. @@ -43202,13 +43241,13 @@ See [ctor@AboutWindow.new_from_appdata] for details. allow-none="1"> the parent top-level window + line="3429">the parent top-level window The resource to use + line="3430">The resource to use allow-none="1"> The version to retrieve release notes for + line="3431">The version to retrieve release notes for the name of the first property + line="3432">the name of the first property value of first property, followed by more pairs of property name and + line="3433">value of first property, followed by more pairs of property name and value, `NULL`-terminated diff --git a/girs/Ags-6.0.gir b/girs/Ags-6.0.gir index f3b03b7c3..1db100d76 100644 --- a/girs/Ags-6.0.gir +++ b/girs/Ags-6.0.gir @@ -45,7 +45,7 @@ and/or use gtk-doc annotations. --> - + @@ -54,7 +54,7 @@ and/or use gtk-doc annotations. --> - + @@ -63,7 +63,7 @@ and/or use gtk-doc annotations. --> - + @@ -72,7 +72,7 @@ and/or use gtk-doc annotations. --> - + @@ -388,7 +388,7 @@ and/or use gtk-doc annotations. --> glib:type-name="AgsApplicationContext" glib:get-type="ags_application_context_get_type" glib:type-struct="ApplicationContextClass"> - + filename="object/ags_application_context.c" line="1166">Create a new instance of #AgsApplicationContext + line="146"/> filename="object/ags_application_context.c" line="1140">Get your application context instance. + line="145"/> filename="object/ags_application_context.c" line="1020">Signal to load and parse configuration. + line="113"/> @@ -464,7 +464,7 @@ and/or use gtk-doc annotations. --> filename="object/ags_application_context.c" line="1045">Prepare @application_context. + line="115"/> @@ -483,7 +483,7 @@ and/or use gtk-doc annotations. --> filename="object/ags_application_context.c" line="1121">Calls exit() + line="123"/> @@ -504,7 +504,7 @@ and/or use gtk-doc annotations. --> filename="object/ags_application_context.c" line="1095">Notification to register your types. + line="118"/> @@ -523,7 +523,7 @@ and/or use gtk-doc annotations. --> filename="object/ags_application_context.c" line="1070">Setup @application_context. + line="116"/> @@ -544,7 +544,7 @@ and/or use gtk-doc annotations. --> filename="object/ags_application_context.c" line="1020">Signal to load and parse configuration. + line="136"/> @@ -565,7 +565,7 @@ and/or use gtk-doc annotations. --> filename="object/ags_application_context.c" line="1045">Prepare @application_context. + line="138"/> @@ -586,7 +586,7 @@ and/or use gtk-doc annotations. --> filename="object/ags_application_context.c" line="1121">Calls exit() + line="143"/> @@ -607,7 +607,7 @@ and/or use gtk-doc annotations. --> filename="object/ags_application_context.c" line="1095">Notification to register your types. + line="141"/> @@ -628,7 +628,7 @@ and/or use gtk-doc annotations. --> filename="object/ags_application_context.c" line="950">Enable a feature of #AgsApplicationContext. + line="131"/> @@ -656,7 +656,7 @@ and/or use gtk-doc annotations. --> filename="object/ags_application_context.c" line="1070">Setup @application_context. + line="139"/> @@ -677,7 +677,7 @@ and/or use gtk-doc annotations. --> filename="object/ags_application_context.c" line="914">Test @flags to be set on @application_context. + line="129"/> filename="object/ags_application_context.c" line="982">Disable a feature of AgsApplicationContext. + line="133"/> @@ -863,14 +863,14 @@ your application context. - + + line="113"/> @@ -887,7 +887,7 @@ your application context. + line="115"/> @@ -904,7 +904,7 @@ your application context. + line="116"/> @@ -921,7 +921,7 @@ your application context. + line="118"/> @@ -938,7 +938,7 @@ your application context. + line="120"/> @@ -958,7 +958,7 @@ your application context. + line="121"/> @@ -978,7 +978,7 @@ your application context. + line="123"/> @@ -999,7 +999,7 @@ your application context. c:type="AgsApplicationContextFlags"> Enum values to control the behavior or indicate internal state of #AgsApplicationContext by + line="66">Enum values to control the behavior or indicate internal state of #AgsApplicationContext by enable/disable as flags. glib:name="AGS_APPLICATION_CONTEXT_TYPES_REGISTERED"> indicates the types have been registered + line="68">indicates the types have been registered - + Create a new instance of #AgsConfig. + line="1006">Create a new instance of #AgsConfig. the new #AgsConfig. + line="1011">the new #AgsConfig. @@ -6801,43 +6801,43 @@ enable/disable as flags. version="3.0.0"> Get config instance. + line="981">Get config instance. the config instance + line="986">the config instance Retrieve config by @group and @key. + line="913">Retrieve config by @group and @key. the property's value + line="921">the property's value the #AgsConfig + line="915">the #AgsConfig the config group identifier + line="916">the config group identifier the key of the property + line="917">the key of the property @@ -6847,7 +6847,7 @@ enable/disable as flags. version="3.0.0"> Load configuration from default values. + line="458">Load configuration from default values. @@ -6856,7 +6856,7 @@ enable/disable as flags. the #AgsConfig + line="460">the #AgsConfig @@ -6864,7 +6864,7 @@ enable/disable as flags. Set config by @group and @key, applying @value. + line="862">Set config by @group and @key, applying @value. @@ -6873,25 +6873,25 @@ enable/disable as flags. the #AgsConfig + line="864">the #AgsConfig the config group identifier + line="865">the config group identifier the key of the property + line="866">the key of the property the value to set + line="867">the value to set @@ -6899,7 +6899,7 @@ enable/disable as flags. Clears configuration. + line="942">Clears configuration. @@ -6908,7 +6908,7 @@ enable/disable as flags. the #AgsConfig + line="944">the #AgsConfig @@ -6918,31 +6918,31 @@ enable/disable as flags. version="3.0.0"> Retrieve config by @group and @key. + line="913">Retrieve config by @group and @key. the property's value + line="921">the property's value the #AgsConfig + line="915">the #AgsConfig the config group identifier + line="916">the config group identifier the key of the property + line="917">the key of the property @@ -6952,7 +6952,7 @@ enable/disable as flags. version="3.0.0"> Load configuration from default values. + line="458">Load configuration from default values. @@ -6961,7 +6961,7 @@ enable/disable as flags. the #AgsConfig + line="460">the #AgsConfig @@ -6971,7 +6971,7 @@ enable/disable as flags. version="3.0.0"> Read configuration in memory. + line="569">Read configuration in memory. @@ -6980,19 +6980,19 @@ enable/disable as flags. the #AgsConfig + line="571">the #AgsConfig the data buffer + line="572">the data buffer the size of the buffer + line="573">the size of the buffer @@ -7002,7 +7002,7 @@ enable/disable as flags. version="3.0.0"> Load configuration from @filename. + line="477">Load configuration from @filename. @@ -7011,13 +7011,13 @@ enable/disable as flags. the #AgsConfig + line="479">the #AgsConfig the configuration file + line="480">the configuration file @@ -7025,7 +7025,7 @@ enable/disable as flags. Save configuration. + line="713">Save configuration. @@ -7034,7 +7034,7 @@ enable/disable as flags. the #AgsConfig + line="715">the #AgsConfig @@ -7044,7 +7044,7 @@ enable/disable as flags. version="3.0.0"> Set config by @group and @key, applying @value. + line="862">Set config by @group and @key, applying @value. @@ -7053,25 +7053,25 @@ enable/disable as flags. the #AgsConfig + line="864">the #AgsConfig the config group identifier + line="865">the config group identifier the key of the property + line="866">the key of the property the value to set + line="867">the value to set @@ -7079,7 +7079,7 @@ enable/disable as flags. Save configuration. + line="661">Save configuration. @@ -7088,19 +7088,19 @@ enable/disable as flags. the #AgsConfig + line="663">the #AgsConfig the data buffer + line="664">the data buffer the size of the buffer + line="665">the size of the buffer @@ -7202,7 +7202,7 @@ enable/disable as flags. the #AgsConfig + line="460">the #AgsConfig @@ -7218,25 +7218,25 @@ enable/disable as flags. the #AgsConfig + line="864">the #AgsConfig the config group identifier + line="865">the config group identifier the key of the property + line="866">the key of the property the value to set + line="867">the value to set @@ -7248,26 +7248,26 @@ enable/disable as flags. the property's value + line="921">the property's value the #AgsConfig + line="915">the #AgsConfig the config group identifier + line="916">the config group identifier the key of the property + line="917">the key of the property @@ -9750,19 +9750,19 @@ otherwise if %TRUE convert back to original format. - + - + - + - + @@ -13934,7 +13934,7 @@ enable/disable as flags. - + @@ -22485,7 +22485,7 @@ enable/disable as flags. - + + + + + - + - + - + - + - + - + - + - + - + - + - + + + + + @@ -25320,13 +25332,13 @@ about a newly played buffer. version="3.0.0"> Instantiate server application context. + line="1161">Instantiate server application context. the new #AgsServerApplicationContext + line="1166">the new #AgsServerApplicationContext @@ -28427,7 +28439,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set. - + @@ -28450,6 +28462,28 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set. + + Get cache buffer size. + + + the cache buffer size + + + + + the #AgsConfig + + + + @@ -28538,13 +28572,35 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set. + + Get use cache. + + + if use cache %TRUE, otherwise %FALSE + + + + + the #AgsConfig + + + + Get current playback delay. - + Get current playback attack. - + Get current playback bpm. - + Get current playback buffer. - + Retrieve #AgsSoundcardCapability-enum information. - + Get current playback delay. - + Get current playback note offset. - + Get current playback delay factor. - + Get device. - + Get loop parameters of @soundcard. - + @@ -28776,7 +28832,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Get current playback loop offset. - + Get future playback buffer. - + Get current playback note 256th attack. - + @@ -28850,8 +28906,8 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set. Get current playback note 256th attack position within AGS_SOUNDCARD_DEFAULT_PERIOD. - + line="1082">Get current playback note 256th attack position within 16 times %AGS_SOUNDCARD_DEFAULT_PERIOD. + @@ -28877,7 +28933,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Get note 256th attack of current 16th pulse. - + Get note 256th attack position of current 16th pulse. - + Get current playback note 256th attack position within AGS_SOUNDCARD_DEFAULT_PERIOD. - + line="1105">Get current playback note 256th attack position within 16 times %AGS_SOUNDCARD_DEFAULT_PERIOD. + @@ -28954,7 +29010,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Get current playback note 256th offset. - + @@ -28985,7 +29041,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Get current playback note offset. - + Get current playback note offset. - + Get presets. - + @@ -29082,7 +29138,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Get future playback buffer. - + Get start playback note offset. - + Get sub block count. - + Get playback time as string. - + Get available. - + Get playing. - + Get recording. - + Get starting. - + Retrieve @card_id and @card_name as a list of strings. - + @@ -29289,7 +29345,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Lock @buffer. - + @@ -29317,7 +29373,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Callback when counter expires minor note offset. - + @@ -29343,7 +29399,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Retrieve detailed information of @card_id soundcard. - + @@ -29420,7 +29476,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Plays the current buffer of soundcard. - + @@ -29440,7 +29496,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Initializes the soundcard for playback. - + @@ -29460,7 +29516,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Records the current buffer of soundcard. - + @@ -29480,7 +29536,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Initializes the soundcard for recordback. - + @@ -29497,7 +29553,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set current playback bpm. - + @@ -29522,7 +29578,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set current playback delay factor. - + @@ -29545,7 +29601,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set device. - + @@ -29568,7 +29624,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set loop parameters of @soundcard. - + @@ -29605,7 +29661,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set current playback note offset. - + @@ -29630,7 +29686,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set current playback note offset. - + @@ -29653,7 +29709,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set presets. - + @@ -29696,7 +29752,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set start playback note offset. - + @@ -29719,7 +29775,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Stops the soundcard from playing to it. - + @@ -29736,7 +29792,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Every call to play may generate a tic. - + @@ -29755,7 +29811,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Trylock sub block. - + Unlock @buffer. - + @@ -29820,7 +29876,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Unlock sub block. - + @@ -29854,7 +29910,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Get current playback delay. - + Get current playback attack. - + Get current playback bpm. - + Get current playback buffer. - + Retrieve #AgsSoundcardCapability-enum information. - + Get current playback delay. - + Get current playback note offset. - + Get current playback delay factor. - + Get device. - + Get loop parameters of @soundcard. - + @@ -30098,7 +30154,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Get current playback loop offset. - + Get future playback buffer. - + Get current playback note 256th attack. - + @@ -30172,8 +30228,8 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set. Get current playback note 256th attack position within AGS_SOUNDCARD_DEFAULT_PERIOD. - + line="1082">Get current playback note 256th attack position within 16 times %AGS_SOUNDCARD_DEFAULT_PERIOD. + @@ -30199,7 +30255,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Get note 256th attack of current 16th pulse. - + Get note 256th attack position of current 16th pulse. - + Get current playback note 256th attack position within AGS_SOUNDCARD_DEFAULT_PERIOD. - + line="1105">Get current playback note 256th attack position within 16 times %AGS_SOUNDCARD_DEFAULT_PERIOD. + @@ -30276,7 +30332,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Get current playback note 256th offset. - + @@ -30307,7 +30363,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Get current playback note offset. - + Get current playback note offset. - + Get presets. - + @@ -30406,7 +30462,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Get future playback buffer. - + Get start playback note offset. - + Get sub block count. - + Get playback time as string. - + Get available. - + Get playing. - + Get recording. - + Get starting. - + Retrieve @card_id and @card_name as a list of strings. - + @@ -30623,7 +30679,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Lock @buffer. - + @@ -30651,7 +30707,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Callback when counter expires minor note offset. - + @@ -30677,7 +30733,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Retrieve detailed information of @card_id soundcard. - + @@ -30757,7 +30813,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Plays the current buffer of soundcard. - + @@ -30777,7 +30833,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Initializes the soundcard for playback. - + @@ -30797,7 +30853,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Records the current buffer of soundcard. - + @@ -30817,7 +30873,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Initializes the soundcard for recordback. - + @@ -30836,7 +30892,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set current playback bpm. - + @@ -30861,7 +30917,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set current playback delay factor. - + @@ -30886,7 +30942,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set device. - + @@ -30911,7 +30967,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set loop parameters of @soundcard. - + @@ -30948,7 +31004,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set current playback note offset. - + @@ -30973,7 +31029,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set current playback note offset. - + @@ -30998,7 +31054,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set presets. - + @@ -31041,7 +31097,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Set start playback note offset. - + @@ -31064,7 +31120,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Stops the soundcard from playing to it. - + @@ -31081,7 +31137,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Every call to play may generate a tic. - + @@ -31100,7 +31156,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Trylock sub block. - + Unlock @buffer. - + @@ -31165,7 +31221,7 @@ symbol and exponent, otherwise %NULL returned and error is appropriately set.Unlock sub block. - + @@ -31235,7 +31291,7 @@ about a newly played buffer. c:type="AgsSoundcardCapability"> Enum values to tell about capability. + line="110">Enum values to tell about capability. glib:name="AGS_SOUNDCARD_CAPABILITY_PLAYBACK"> capability playback + line="112">capability playback glib:name="AGS_SOUNDCARD_CAPABILITY_CAPTURE"> capability capture + line="113">capability capture glib:name="AGS_SOUNDCARD_CAPABILITY_DUPLEX"> capability duplex + line="114">capability duplex c:type="AgsSoundcardFormat"> #AgsSoundcardFormat specifies the audio data representation to be used. + line="86">#AgsSoundcardFormat specifies the audio data representation to be used. glib:name="AGS_SOUNDCARD_SIGNED_8_BIT"> signed 8 bit raw pcm data + line="88">signed 8 bit raw pcm data glib:name="AGS_SOUNDCARD_SIGNED_16_BIT"> signed 16 bit raw pcm data + line="89">signed 16 bit raw pcm data glib:name="AGS_SOUNDCARD_SIGNED_24_BIT"> signed 24 bit raw pcm data + line="90">signed 24 bit raw pcm data glib:name="AGS_SOUNDCARD_SIGNED_32_BIT"> signed 32 bit raw pcm data + line="91">signed 32 bit raw pcm data glib:name="AGS_SOUNDCARD_SIGNED_64_BIT"> signed 64 bit raw pcm data + line="92">signed 64 bit raw pcm data glib:name="AGS_SOUNDCARD_FLOAT"> float raw pcm data + line="93">float raw pcm data glib:name="AGS_SOUNDCARD_DOUBLE"> double raw pcm data + line="94">double raw pcm data glib:name="AGS_SOUNDCARD_COMPLEX"> complex audio data + line="95">complex audio data - + - + @@ -31375,7 +31431,7 @@ about a newly played buffer. - + - + @@ -31470,7 +31526,7 @@ about a newly played buffer. - + - + @@ -31529,7 +31585,7 @@ about a newly played buffer. - + @@ -31581,7 +31637,7 @@ about a newly played buffer. - + @@ -31619,7 +31675,7 @@ about a newly played buffer. - + - + - + - + - + - + @@ -31730,7 +31786,7 @@ about a newly played buffer. - + @@ -31746,7 +31802,7 @@ about a newly played buffer. - + @@ -31762,7 +31818,7 @@ about a newly played buffer. - + @@ -31778,7 +31834,7 @@ about a newly played buffer. - + @@ -31794,7 +31850,7 @@ about a newly played buffer. - + @@ -31810,7 +31866,7 @@ about a newly played buffer. - + @@ -31832,7 +31888,7 @@ about a newly played buffer. - + - + - + - + @@ -31914,7 +31970,7 @@ about a newly played buffer. - + @@ -31939,7 +31995,7 @@ about a newly played buffer. - + @@ -31961,7 +32017,7 @@ about a newly played buffer. - + - + @@ -32002,7 +32058,7 @@ about a newly played buffer. - + - + - + - + - + - + @@ -32119,7 +32175,7 @@ about a newly played buffer. - + - + @@ -32160,7 +32216,7 @@ about a newly played buffer. - + - + @@ -32201,7 +32257,7 @@ about a newly played buffer. - + - + @@ -32254,7 +32310,7 @@ about a newly played buffer. - + @@ -32297,7 +32353,7 @@ about a newly played buffer. - + - + - + - + @@ -32400,7 +32456,7 @@ about a newly played buffer. - + @@ -32430,7 +32486,7 @@ about a newly played buffer. - + @@ -32460,7 +32516,7 @@ about a newly played buffer. - + @@ -32483,7 +32539,7 @@ about a newly played buffer. - + @@ -32513,7 +32569,7 @@ about a newly played buffer. - + - + - + version="3.0.0"> Create #AgsXmlPasswordStore. + line="788">Create #AgsXmlPasswordStore. the new #AgsXmlPasswordStore instance + line="793">the new #AgsXmlPasswordStore instance @@ -40460,13 +40516,13 @@ enable/disable as status flags. version="3.0.0"> Find ags-srv-user xmlNode containing @login. + line="704">Find ags-srv-user xmlNode containing @login. the matching xmlNode or %NULL + line="711">the matching xmlNode or %NULL @@ -40474,13 +40530,13 @@ enable/disable as status flags. transfer-ownership="none"> the #AgsXmlPasswordStore + line="706">the #AgsXmlPasswordStore the login + line="707">the login @@ -40490,7 +40546,7 @@ enable/disable as status flags. version="3.0.0"> Open @filename. + line="659">Open @filename. @@ -40501,13 +40557,13 @@ enable/disable as status flags. transfer-ownership="none"> the #AgsXmlPasswordStore + line="661">the #AgsXmlPasswordStore the filename + line="662">the filename @@ -41105,7 +41161,7 @@ server. The #AgsXmlPasswordStore is an object to keep passwords. + line="78">The #AgsXmlPasswordStore is an object to keep passwords. + + Get cache buffer size. + + + the cache buffer size + + + + + the #AgsConfig + + + + + + Get use cache. + + + if use cache %TRUE, otherwise %FALSE + + + + + the #AgsConfig + + + + version="3.13.2"> Creates a new instance of #AgsAlsaDevin. + line="3984">Creates a new instance of #AgsAlsaDevin. the new #AgsAlsaDevin + line="3989">the new #AgsAlsaDevin @@ -2413,7 +2413,7 @@ and/or use gtk-doc annotations. --> version="3.13.2"> Calculate delay and attack and reset it. + line="3872">Calculate delay and attack and reset it. @@ -2422,7 +2422,7 @@ and/or use gtk-doc annotations. --> the #AgsAlsaDevin + line="3874">the #AgsAlsaDevin @@ -2432,7 +2432,7 @@ and/or use gtk-doc annotations. --> version="3.13.2"> Reallocate the internal audio buffer. + line="3890">Reallocate the internal audio buffer. @@ -2441,7 +2441,7 @@ and/or use gtk-doc annotations. --> the #AgsAlsaDevin + line="3892">the #AgsAlsaDevin @@ -2476,7 +2476,7 @@ and/or use gtk-doc annotations. --> version="3.13.2"> The buffer flag indicates the currently recorded buffer. + line="3840">The buffer flag indicates the currently recorded buffer. @@ -2485,7 +2485,7 @@ and/or use gtk-doc annotations. --> the #AgsAlsaDevin + line="3842">the #AgsAlsaDevin @@ -2982,12 +2982,12 @@ enable/disable as flags. version="3.13.2"> Creates a new instance of #AgsAlsaDevout. + line="4430">Creates a new instance of #AgsAlsaDevout. the new #AgsAlsaDevout + line="4435">the new #AgsAlsaDevout @@ -3001,7 +3001,7 @@ enable/disable as flags. version="3.13.2"> Calculate delay and attack and reset it. + line="4318">Calculate delay and attack and reset it. @@ -3010,7 +3010,7 @@ enable/disable as flags. the #AgsAlsaDevout + line="4320">the #AgsAlsaDevout @@ -3020,7 +3020,7 @@ enable/disable as flags. version="3.13.2"> Reallocate the internal audio buffer. + line="4336">Reallocate the internal audio buffer. @@ -3029,7 +3029,7 @@ enable/disable as flags. the #AgsAlsaDevout + line="4338">the #AgsAlsaDevout @@ -3039,7 +3039,7 @@ enable/disable as flags. version="3.13.2"> Enable a feature of @alsa_devout. + line="1380">Enable a feature of @alsa_devout. @@ -3048,13 +3048,13 @@ enable/disable as flags. the #AgsAlsaDevout + line="1382">the #AgsAlsaDevout see #AgsAlsaDevoutFlags-enum + line="1383">see #AgsAlsaDevoutFlags-enum @@ -3064,7 +3064,7 @@ enable/disable as flags. version="3.13.2"> Switch currently played buffer. + line="4286">Switch currently played buffer. @@ -3073,7 +3073,7 @@ enable/disable as flags. the #AgsAlsaDevout + line="4288">the #AgsAlsaDevout @@ -3083,25 +3083,25 @@ enable/disable as flags. version="3.13.2"> Test @flags to be set on @alsa_devout. + line="1345">Test @flags to be set on @alsa_devout. %TRUE if flags are set, else %FALSE + line="1352">%TRUE if flags are set, else %FALSE the #AgsAlsaDevout + line="1347">the #AgsAlsaDevout the flags + line="1348">the flags @@ -3111,7 +3111,7 @@ enable/disable as flags. version="3.13.2"> Disable a feature of @alsa_devout. + line="1411">Disable a feature of @alsa_devout. @@ -3120,13 +3120,13 @@ enable/disable as flags. the #AgsAlsaDevout + line="1413">the #AgsAlsaDevout see #AgsAlsaDevoutFlags-enum + line="1414">see #AgsAlsaDevoutFlags-enum @@ -3134,7 +3134,7 @@ enable/disable as flags. Attack of the buffer + line="469">Attack of the buffer default-value="120.000000"> Beats per minute + line="433">Beats per minute The buffer + line="418">The buffer default-value="1024"> The buffer size + line="382">The buffer size default-value="1.000000"> tact + line="451">tact default-value="hw:0,0"> The alsa soundcard indentifier + line="312">The alsa soundcard indentifier default-value="2"> The dsp channel count + line="328">The dsp channel count default-value="16"> The precision of the buffer + line="364">The precision of the buffer default-value="2"> The pcm channel count + line="346">The pcm channel count default-value="48000"> The samplerate + line="400">The samplerate @@ -4989,19 +4989,19 @@ enable/disable as flags. Creates an #AgsAudio, with defaults of @output_soundcard. + line="15724">Creates an #AgsAudio, with defaults of @output_soundcard. a new #AgsAudio + line="15730">a new #AgsAudio the #AgsSoundcard to use for output + line="15726">the #AgsSoundcard to use for output @@ -5043,7 +5043,7 @@ enable/disable as flags. version="3.0.0"> Cancel processing audio data. + line="13885">Cancel processing audio data. @@ -5052,13 +5052,13 @@ enable/disable as flags. the #AgsAudio + line="13887">the #AgsAudio the #AgsRecallID to apply to + line="13888">the #AgsRecallID to apply to @@ -5066,12 +5066,12 @@ enable/disable as flags. Check scope's recall id. + line="14913">Check scope's recall id. the scope's recall id of @audio + line="14920">the scope's recall id of @audio @@ -5080,13 +5080,13 @@ enable/disable as flags. the #AgsAudio + line="14915">the #AgsAudio the scope + line="14916">the scope @@ -5096,7 +5096,7 @@ enable/disable as flags. version="3.0.0"> Cleanup processing audio data. + line="14063">Cleanup processing audio data. @@ -5105,13 +5105,13 @@ enable/disable as flags. the #AgsAudio + line="14065">the #AgsAudio the #AgsRecallID to apply to + line="14066">the #AgsRecallID to apply to @@ -5119,7 +5119,7 @@ enable/disable as flags. Done processing audio data. + line="13727">Done processing audio data. @@ -5128,13 +5128,13 @@ enable/disable as flags. the #AgsAudio + line="13729">the #AgsAudio the #AgsRecallID to apply to + line="13730">the #AgsRecallID to apply to @@ -5144,7 +5144,7 @@ enable/disable as flags. version="3.0.0"> Duplicate all #AgsRecall templates of @audio. + line="13032">Duplicate all #AgsRecall templates of @audio. @@ -5153,31 +5153,31 @@ enable/disable as flags. the #AgsAudio + line="13034">the #AgsAudio an #AgsRecallID + line="13035">an #AgsRecallID the pad + line="13036">the pad the audio channel + line="13037">the audio channel the line + line="13038">the line @@ -5185,7 +5185,7 @@ enable/disable as flags. Initializes the recalls of @audio + line="13374">Initializes the recalls of @audio @@ -5194,19 +5194,19 @@ enable/disable as flags. the #AgsAudio + line="13376">the #AgsAudio the #AgsRecallID to use or #NULL + line="13377">the #AgsRecallID to use or #NULL staging flags, see #AgsSoundStagingFlags-enum + line="13378">staging flags, see #AgsSoundStagingFlags-enum @@ -5214,7 +5214,7 @@ enable/disable as flags. Performs play for the specified @staging_flags. + line="13568">Performs play for the specified @staging_flags. @@ -5223,19 +5223,19 @@ enable/disable as flags. the #AgsAudio + line="13570">the #AgsAudio the #AgsRecallID to apply to + line="13571">the #AgsRecallID to apply to staging flags, see #AgsSoundStagingFlags-enum + line="13572">staging flags, see #AgsSoundStagingFlags-enum @@ -5245,7 +5245,7 @@ enable/disable as flags. version="3.0.0"> Resets @audio's @sound_scope specified by @staging_flags. + line="15700">Resets @audio's @sound_scope specified by @staging_flags. @@ -5254,19 +5254,19 @@ enable/disable as flags. the #AgsAudio object + line="15702">the #AgsAudio object the scope to reset + line="15703">the scope to reset the stage to enable + line="15704">the stage to enable @@ -5276,7 +5276,7 @@ enable/disable as flags. version="3.0.0"> Performs resolving of recalls. + line="13191">Performs resolving of recalls. @@ -5285,13 +5285,13 @@ enable/disable as flags. the #AgsAudio + line="13193">the #AgsAudio the #AgsRecallID to use + line="13194">the #AgsRecallID to use @@ -5301,7 +5301,7 @@ enable/disable as flags. version="3.0.0"> Resize audio channels AgsInput will be allocated first. + line="6921">Resize audio channels AgsInput will be allocated first. @@ -5310,19 +5310,19 @@ enable/disable as flags. the #AgsAudio + line="6923">the #AgsAudio new audio channels + line="6924">new audio channels old audio channels + line="6925">old audio channels @@ -5330,7 +5330,7 @@ enable/disable as flags. Set pad count for the apropriate @channel_type + line="8026">Set pad count for the apropriate @channel_type @@ -5339,25 +5339,25 @@ enable/disable as flags. the #AgsAudio + line="8028">the #AgsAudio AGS_TYPE_INPUT or AGS_TYPE_OUTPUT + line="8029">AGS_TYPE_INPUT or AGS_TYPE_OUTPUT new pad count + line="8030">new pad count old pad count + line="8031">old pad count @@ -5365,12 +5365,12 @@ enable/disable as flags. Is emitted as audio is started. + line="14502">Is emitted as audio is started. the #GList-struct containing #AgsRecallID + line="14509">the #GList-struct containing #AgsRecallID @@ -5379,13 +5379,13 @@ enable/disable as flags. the #AgsAudio + line="14504">the #AgsAudio the scope + line="14505">the scope @@ -5393,7 +5393,7 @@ enable/disable as flags. Is emitted as playing audio is stopped. + line="14830">Is emitted as playing audio is stopped. @@ -5402,13 +5402,13 @@ enable/disable as flags. the #AgsAudio + line="14832">the #AgsAudio the #GList-struct containing #AgsRecallID + line="14833">the #GList-struct containing #AgsRecallID @@ -5416,7 +5416,7 @@ enable/disable as flags. the scope + line="14834">the scope @@ -5426,7 +5426,7 @@ enable/disable as flags. version="3.0.0"> Adds an automation. + line="11250">Adds an automation. @@ -5435,13 +5435,13 @@ enable/disable as flags. the #AgsAudio + line="11252">the #AgsAudio the #AgsAutomation + line="11253">the #AgsAutomation @@ -5451,7 +5451,7 @@ enable/disable as flags. version="3.0.0"> Adds an automation port. + line="10955">Adds an automation port. @@ -5460,13 +5460,13 @@ enable/disable as flags. the #AgsAudio + line="10957">the #AgsAudio the control name + line="10958">the control name @@ -5476,7 +5476,7 @@ enable/disable as flags. version="3.0.0"> Adds a cursor. + line="10640">Adds a cursor. @@ -5485,13 +5485,13 @@ enable/disable as flags. the #AgsAudio + line="10642">the #AgsAudio the #GObject implementing #AgsCursor + line="10643">the #GObject implementing #AgsCursor @@ -5501,7 +5501,7 @@ enable/disable as flags. version="3.0.0"> Adds a midi. + line="11886">Adds a midi. @@ -5510,13 +5510,13 @@ enable/disable as flags. the #AgsAudio + line="11888">the #AgsAudio the #AgsMidi + line="11889">the #AgsMidi @@ -5526,7 +5526,7 @@ enable/disable as flags. version="3.0.0"> Adds a notation. + line="10795">Adds a notation. @@ -5535,13 +5535,13 @@ enable/disable as flags. the #AgsAudio + line="10797">the #AgsAudio the #AgsNotation + line="10798">the #AgsNotation @@ -5551,7 +5551,7 @@ enable/disable as flags. version="3.0.0"> Adds a preset. + line="10036">Adds a preset. @@ -5560,13 +5560,13 @@ enable/disable as flags. the #AgsAudio + line="10038">the #AgsAudio an #AgsPreset + line="10039">an #AgsPreset @@ -5576,7 +5576,7 @@ enable/disable as flags. version="3.0.0"> Adds a recall to @audio. + line="12585">Adds a recall to @audio. @@ -5585,19 +5585,19 @@ enable/disable as flags. the #AgsAudio + line="12587">the #AgsAudio the #AgsRecall + line="12588">the #AgsRecall if %TRUE play context, else if %FALSE recall context + line="12589">if %TRUE play context, else if %FALSE recall context @@ -5607,7 +5607,7 @@ enable/disable as flags. version="3.0.0"> Adds a recall container. + line="12395">Adds a recall container. @@ -5616,13 +5616,13 @@ enable/disable as flags. the #AgsAudio + line="12397">the #AgsAudio the #AgsRecallContainer + line="12398">the #AgsRecallContainer @@ -5632,7 +5632,7 @@ enable/disable as flags. version="3.0.0"> Adds a recall id. + line="12135">Adds a recall id. @@ -5641,13 +5641,13 @@ enable/disable as flags. the #AgsAudio + line="12137">the #AgsAudio the #AgsRecallID + line="12138">the #AgsRecallID @@ -5657,7 +5657,7 @@ enable/disable as flags. version="3.0.0"> Adds a recycling context. + line="12265">Adds a recycling context. @@ -5666,13 +5666,13 @@ enable/disable as flags. the #AgsAudio + line="12267">the #AgsAudio the #AgsRecyclingContext + line="12268">the #AgsRecyclingContext @@ -5682,7 +5682,7 @@ enable/disable as flags. version="3.4.0"> Adds a SF2 synth generator. + line="10372">Adds a SF2 synth generator. @@ -5691,13 +5691,13 @@ enable/disable as flags. the #AgsAudio + line="10374">the #AgsAudio an #AgsSF2SynthGenerator + line="10375">an #AgsSF2SynthGenerator @@ -5707,7 +5707,7 @@ enable/disable as flags. version="3.4.0"> Adds a SFZ synth generator. + line="10508">Adds a SFZ synth generator. @@ -5716,13 +5716,13 @@ enable/disable as flags. the #AgsAudio + line="10510">the #AgsAudio an #AgsSFZSynthGenerator + line="10511">an #AgsSFZSynthGenerator @@ -5732,7 +5732,7 @@ enable/disable as flags. version="3.0.0"> Adds a synth generator. + line="10240">Adds a synth generator. @@ -5741,13 +5741,13 @@ enable/disable as flags. the #AgsAudio + line="10242">the #AgsAudio an #AgsSynthGenerator + line="10243">an #AgsSynthGenerator @@ -5757,7 +5757,7 @@ enable/disable as flags. version="3.0.0"> Adds a wave. + line="11543">Adds a wave. @@ -5766,13 +5766,13 @@ enable/disable as flags. the #AgsAudio + line="11545">the #AgsAudio the #AgsWave + line="11546">the #AgsWave @@ -5782,7 +5782,7 @@ enable/disable as flags. version="3.0.0"> Cancel processing audio data. + line="13885">Cancel processing audio data. @@ -5791,13 +5791,13 @@ enable/disable as flags. the #AgsAudio + line="13887">the #AgsAudio the #AgsRecallID to apply to + line="13888">the #AgsRecallID to apply to @@ -5807,12 +5807,12 @@ enable/disable as flags. version="3.0.0"> Check scope's recall id. + line="14913">Check scope's recall id. the scope's recall id of @audio + line="14920">the scope's recall id of @audio @@ -5821,13 +5821,13 @@ enable/disable as flags. the #AgsAudio + line="14915">the #AgsAudio the scope + line="14916">the scope @@ -5837,7 +5837,7 @@ enable/disable as flags. version="3.0.0"> Cleanup processing audio data. + line="14063">Cleanup processing audio data. @@ -5846,13 +5846,13 @@ enable/disable as flags. the #AgsAudio + line="14065">the #AgsAudio the #AgsRecallID to apply to + line="14066">the #AgsRecallID to apply to @@ -5862,12 +5862,12 @@ enable/disable as flags. version="3.0.0"> Retrieve all ports of #AgsAudio. + line="14943">Retrieve all ports of #AgsAudio. a new #GList containing #AgsPort + line="14949">a new #GList containing #AgsPort @@ -5876,7 +5876,7 @@ enable/disable as flags. the #AgsAudio + line="14945">the #AgsAudio @@ -5886,12 +5886,12 @@ enable/disable as flags. version="3.0.0"> Retrieve specified port of #AgsAudio + line="15070">Retrieve specified port of #AgsAudio a #GList-struct of #AgsPort if found, otherwise %NULL + line="15078">a #GList-struct of #AgsPort if found, otherwise %NULL @@ -5900,19 +5900,19 @@ enable/disable as flags. an #AgsAudio + line="15072">an #AgsAudio the port's name + line="15073">the port's name either %TRUE for play or %FALSE for recall + line="15074">either %TRUE for play or %FALSE for recall @@ -5922,7 +5922,7 @@ enable/disable as flags. version="3.0.0"> Done processing audio data. + line="13727">Done processing audio data. @@ -5931,13 +5931,13 @@ enable/disable as flags. the #AgsAudio + line="13729">the #AgsAudio the #AgsRecallID to apply to + line="13730">the #AgsRecallID to apply to @@ -5947,7 +5947,7 @@ enable/disable as flags. version="3.0.0"> Duplicate all #AgsRecall templates of @audio. + line="13032">Duplicate all #AgsRecall templates of @audio. @@ -5956,31 +5956,31 @@ enable/disable as flags. the #AgsAudio + line="13034">the #AgsAudio an #AgsRecallID + line="13035">an #AgsRecallID the pad + line="13036">the pad the audio channel + line="13037">the audio channel the line + line="13038">the line @@ -5991,19 +5991,19 @@ enable/disable as flags. version="3.1.0"> Gets absolute key. + line="9929">Gets absolute key. the absolute key + line="9935">the absolute key the #AgsAudio + line="9931">the #AgsAudio @@ -6060,19 +6060,19 @@ enable/disable as flags. version="3.1.0"> Gets audio start mapping. + line="9459">Gets audio start mapping. the audio start mapping + line="9465">the audio start mapping the #AgsAudio + line="9461">the #AgsAudio @@ -6083,12 +6083,12 @@ enable/disable as flags. version="3.1.0"> Get automation. + line="11190">Get automation. the #GList-struct containig #AgsAutomation + line="11196">the #GList-struct containig #AgsAutomation @@ -6097,7 +6097,7 @@ enable/disable as flags. the #AgsAudio + line="11192">the #AgsAudio @@ -6107,12 +6107,12 @@ enable/disable as flags. version="3.1.0"> Get automation port. + line="10890">Get automation port. the string vector containing automation ports + line="10896">the string vector containing automation ports @@ -6121,7 +6121,7 @@ enable/disable as flags. the #AgsAudio + line="10892">the #AgsAudio @@ -6132,19 +6132,19 @@ enable/disable as flags. version="3.1.0"> Gets bpm. + line="9412">Gets bpm. the bpm + line="9418">the bpm the #AgsAudio + line="9414">the #AgsAudio @@ -6155,19 +6155,19 @@ enable/disable as flags. version="3.1.0"> Gets buffer size. + line="8986">Gets buffer size. the buffer size + line="8992">the buffer size the #AgsAudio + line="8988">the #AgsAudio @@ -6178,12 +6178,12 @@ enable/disable as flags. version="3.1.0"> Get cursor. + line="10580">Get cursor. the #GList-struct containig #GObject implementing #AgsCursor + line="10586">the #GList-struct containig #GObject implementing #AgsCursor @@ -6192,7 +6192,7 @@ enable/disable as flags. the #AgsAudio + line="10582">the #AgsAudio @@ -6203,19 +6203,19 @@ enable/disable as flags. version="3.1.0"> Gets denominator. + line="9647">Gets denominator. the denominator + line="9653">the denominator the #AgsAudio + line="9649">the #AgsAudio @@ -6226,19 +6226,19 @@ enable/disable as flags. version="3.1.0"> Gets format. + line="9211">Gets format. the format + line="9217">the format the #AgsAudio + line="9213">the #AgsAudio @@ -6249,19 +6249,19 @@ enable/disable as flags. version="3.1.0"> Get the input object of @audio. + line="8143">Get the input object of @audio. the input + line="8149">the input the #AgsAudio + line="8145">the #AgsAudio @@ -6272,19 +6272,19 @@ enable/disable as flags. version="3.1.0"> Get input audio file. + line="11685">Get input audio file. the #GObject + line="11691">the #GObject the #AgsAudio + line="11687">the #AgsAudio @@ -6295,19 +6295,19 @@ enable/disable as flags. version="3.1.0"> Get input lines. + line="8091">Get input lines. the input lines + line="8097">the input lines the #AgsAudio + line="8093">the #AgsAudio @@ -6318,19 +6318,19 @@ enable/disable as flags. version="3.1.0"> Get input MIDI file. + line="12028">Get input MIDI file. the #GObject + line="12034">the #GObject the #AgsAudio + line="12030">the #AgsAudio @@ -6341,19 +6341,19 @@ enable/disable as flags. version="3.1.0"> Get input pads. + line="7001">Get input pads. the input pads + line="7007">the input pads the #AgsAudio + line="7003">the #AgsAudio @@ -6364,19 +6364,19 @@ enable/disable as flags. version="3.1.0"> Get the input sequencer object of @audio. + line="8671">Get the input sequencer object of @audio. the input sequencer + line="8677">the input sequencer the #AgsAudio + line="8673">the #AgsAudio @@ -6387,19 +6387,19 @@ enable/disable as flags. version="3.1.0"> Get the input soundcard object of @audio. + line="8398">Get the input soundcard object of @audio. the input soundcard + line="8404">the input soundcard the #AgsAudio + line="8400">the #AgsAudio @@ -6409,19 +6409,19 @@ enable/disable as flags. version="3.1.0"> Gets instrument name. + line="11732">Gets instrument name. the instrument name + line="11738">the instrument name the #AgsAudio + line="11734">the #AgsAudio @@ -6432,19 +6432,19 @@ enable/disable as flags. version="3.1.0"> Gets is minor. + line="9741">Gets is minor. is minor + line="9747">is minor the #AgsAudio + line="9743">the #AgsAudio @@ -6455,19 +6455,19 @@ enable/disable as flags. version="3.1.0"> Gets key. + line="9882">Gets key. the key + line="9888">the key the #AgsAudio + line="9884">the #AgsAudio @@ -6547,12 +6547,12 @@ enable/disable as flags. version="3.1.0"> Get midi. + line="11826">Get midi. the #GList-struct containig #AgsMidi + line="11832">the #GList-struct containig #AgsMidi @@ -6561,7 +6561,7 @@ enable/disable as flags. the #AgsAudio + line="11828">the #AgsAudio @@ -6572,19 +6572,19 @@ enable/disable as flags. version="3.1.0"> Gets midi channel. + line="9553">Gets midi channel. the midi channel + line="9559">the midi channel the #AgsAudio + line="9555">the #AgsAudio @@ -6595,19 +6595,19 @@ enable/disable as flags. version="3.1.0"> Gets midi start mapping. + line="9506">Gets midi start mapping. the midi start mapping + line="9512">the midi start mapping the #AgsAudio + line="9508">the #AgsAudio @@ -6618,12 +6618,12 @@ enable/disable as flags. version="3.1.0"> Get notation. + line="10735">Get notation. the #GList-struct containig #AgsNotation + line="10741">the #GList-struct containig #AgsNotation @@ -6632,7 +6632,7 @@ enable/disable as flags. the #AgsAudio + line="10737">the #AgsAudio @@ -6643,19 +6643,19 @@ enable/disable as flags. version="3.1.0"> Gets numerator. + line="9600">Gets numerator. the numerator + line="9606">the numerator the #AgsAudio + line="9602">the #AgsAudio @@ -6689,19 +6689,19 @@ enable/disable as flags. version="3.1.0"> Gets octave. + line="9835">Gets octave. the octave + line="9841">the octave the #AgsAudio + line="9837">the #AgsAudio @@ -6712,19 +6712,19 @@ enable/disable as flags. version="3.1.0"> Get the output object of @audio. + line="8117">Get the output object of @audio. the output + line="8123">the output the #AgsAudio + line="8119">the #AgsAudio @@ -6735,19 +6735,19 @@ enable/disable as flags. version="3.1.0"> Get output audio file. + line="11638">Get output audio file. the #GObject + line="11644">the #GObject the #AgsAudio + line="11640">the #AgsAudio @@ -6758,19 +6758,19 @@ enable/disable as flags. version="3.1.0"> Get output lines. + line="8065">Get output lines. the output lines + line="8071">the output lines the #AgsAudio + line="8067">the #AgsAudio @@ -6781,19 +6781,19 @@ enable/disable as flags. version="3.1.0"> Get output MIDI file. + line="11981">Get output MIDI file. the #GObject + line="11987">the #GObject the #AgsAudio + line="11983">the #AgsAudio @@ -6804,19 +6804,19 @@ enable/disable as flags. version="3.1.0"> Get output pads. + line="6957">Get output pads. the output pads + line="6963">the output pads the #AgsAudio + line="6959">the #AgsAudio @@ -6827,19 +6827,19 @@ enable/disable as flags. version="3.1.0"> Get the output sequencer object of @audio. + line="8581">Get the output sequencer object of @audio. the output sequencer + line="8587">the output sequencer the #AgsAudio + line="8583">the #AgsAudio @@ -6850,19 +6850,19 @@ enable/disable as flags. version="3.1.0"> Get the output soundcard object of @audio. + line="8169">Get the output soundcard object of @audio. the output soundcard + line="8175">the output soundcard the #AgsAudio + line="8171">the #AgsAudio @@ -6873,12 +6873,12 @@ enable/disable as flags. version="3.1.0"> Get play. + line="12465">Get play. the #GList-struct containig #AgsRecall + line="12471">the #GList-struct containig #AgsRecall @@ -6887,7 +6887,7 @@ enable/disable as flags. the #AgsAudio + line="12467">the #AgsAudio @@ -6921,19 +6921,19 @@ enable/disable as flags. version="3.1.0"> Get playback domain. + line="10133">Get playback domain. the #AgsPlaybackDomain + line="10139">the #AgsPlaybackDomain the #AgsAudio + line="10135">the #AgsAudio @@ -6944,12 +6944,12 @@ enable/disable as flags. version="3.1.0"> Get preset. + line="9976">Get preset. the #GList-struct containig #AgsPreset + line="9982">the #GList-struct containig #AgsPreset @@ -6958,7 +6958,7 @@ enable/disable as flags. the #AgsAudio + line="9978">the #AgsAudio @@ -6969,12 +6969,12 @@ enable/disable as flags. version="3.1.0"> Get recall. + line="12525">Get recall. the #GList-struct containig #AgsRecall + line="12531">the #GList-struct containig #AgsRecall @@ -6983,7 +6983,7 @@ enable/disable as flags. the #AgsAudio + line="12527">the #AgsAudio @@ -6994,12 +6994,12 @@ enable/disable as flags. version="3.1.0"> Get recall_container. + line="12335">Get recall_container. the #GList-struct containig #AgsRecallContainer + line="12341">the #GList-struct containig #AgsRecallContainer @@ -7008,7 +7008,7 @@ enable/disable as flags. the #AgsAudio + line="12337">the #AgsAudio @@ -7019,12 +7019,12 @@ enable/disable as flags. version="3.1.0"> Get recall id. + line="12075">Get recall id. the #GList-struct containig #AgsRecallID + line="12081">the #GList-struct containig #AgsRecallID @@ -7033,7 +7033,7 @@ enable/disable as flags. the #AgsAudio + line="12077">the #AgsAudio @@ -7067,12 +7067,12 @@ enable/disable as flags. version="3.1.0"> Get recycling_context. + line="12205">Get recycling_context. the #GList-struct containig #AgsRecyclingContext + line="12211">the #GList-struct containig #AgsRecyclingContext @@ -7081,7 +7081,7 @@ enable/disable as flags. the #AgsAudio + line="12207">the #AgsAudio @@ -7092,19 +7092,19 @@ enable/disable as flags. version="3.1.0"> Gets samplerate. + line="8761">Gets samplerate. the samplerate + line="8767">the samplerate the #AgsAudio + line="8763">the #AgsAudio @@ -7115,12 +7115,12 @@ enable/disable as flags. version="3.4.0"> Get SF2 synth generator. + line="10312">Get SF2 synth generator. the #GList-struct containing #AgsSF2SynthGenerator + line="10318">the #GList-struct containing #AgsSF2SynthGenerator @@ -7129,7 +7129,7 @@ enable/disable as flags. the #AgsAudio + line="10314">the #AgsAudio @@ -7140,12 +7140,12 @@ enable/disable as flags. version="3.4.0"> Get SFZ synth generator. + line="10448">Get SFZ synth generator. the #GList-struct containing #AgsSFZSynthGenerator + line="10454">the #GList-struct containing #AgsSFZSynthGenerator @@ -7154,7 +7154,7 @@ enable/disable as flags. the #AgsAudio + line="10450">the #AgsAudio @@ -7165,19 +7165,19 @@ enable/disable as flags. version="3.1.0"> Gets sharp flats. + line="9788">Gets sharp flats. the sharp flats + line="9794">the sharp flats the #AgsAudio + line="9790">the #AgsAudio @@ -7188,12 +7188,12 @@ enable/disable as flags. version="3.1.0"> Get synth generator. + line="10180">Get synth generator. the #GList-struct containing #AgsSynthGenerator + line="10186">the #GList-struct containing #AgsSynthGenerator @@ -7202,7 +7202,7 @@ enable/disable as flags. the #AgsAudio + line="10182">the #AgsAudio @@ -7213,19 +7213,19 @@ enable/disable as flags. version="3.1.0"> Gets time signature. + line="9694">Gets time signature. the time signature + line="9700">the time signature the #AgsAudio + line="9696">the #AgsAudio @@ -7235,19 +7235,19 @@ enable/disable as flags. version="3.1.0"> Gets track name. + line="11779">Gets track name. the track name + line="11785">the track name the #AgsAudio + line="11781">the #AgsAudio @@ -7258,12 +7258,12 @@ enable/disable as flags. version="3.1.0"> Get wave. + line="11483">Get wave. the #GList-struct containig #AgsWave + line="11489">the #GList-struct containig #AgsWave @@ -7272,7 +7272,7 @@ enable/disable as flags. the #AgsAudio + line="11485">the #AgsAudio @@ -7282,7 +7282,7 @@ enable/disable as flags. version="3.0.0"> Initializes the recalls of @audio + line="13374">Initializes the recalls of @audio @@ -7291,19 +7291,19 @@ enable/disable as flags. the #AgsAudio + line="13376">the #AgsAudio the #AgsRecallID to use or #NULL + line="13377">the #AgsRecallID to use or #NULL staging flags, see #AgsSoundStagingFlags-enum + line="13378">staging flags, see #AgsSoundStagingFlags-enum @@ -7313,7 +7313,7 @@ enable/disable as flags. version="3.3.0"> Insert @recall at @position in @audio's @play_context. + line="12658">Insert @recall at @position in @audio's @play_context. @@ -7322,25 +7322,25 @@ enable/disable as flags. the #AgsAudio + line="12660">the #AgsAudio the #AgsRecall + line="12661">the #AgsRecall if %TRUE play context, else if %FALSE recall context + line="12662">if %TRUE play context, else if %FALSE recall context the position + line="12663">the position @@ -7350,7 +7350,7 @@ enable/disable as flags. version="3.0.0"> Open some files. + line="15178">Open some files. @@ -7359,13 +7359,13 @@ enable/disable as flags. the #AgsAudio + line="15180">the #AgsAudio the files to open + line="15181">the files to open @@ -7373,13 +7373,13 @@ enable/disable as flags. if existing channels should be assigned + line="15182">if existing channels should be assigned if new channels should be created as not fitting if combined with @overwrite_channels + line="15183">if new channels should be created as not fitting if combined with @overwrite_channels @@ -7458,7 +7458,7 @@ enable/disable as flags. version="3.0.0"> Performs play for the specified @staging_flags. + line="13568">Performs play for the specified @staging_flags. @@ -7467,19 +7467,19 @@ enable/disable as flags. the #AgsAudio + line="13570">the #AgsAudio the #AgsRecallID to apply to + line="13571">the #AgsRecallID to apply to staging flags, see #AgsSoundStagingFlags-enum + line="13572">staging flags, see #AgsSoundStagingFlags-enum @@ -7489,7 +7489,7 @@ enable/disable as flags. version="3.0.0"> Resets @audio's @sound_scope specified by @staging_flags. + line="15700">Resets @audio's @sound_scope specified by @staging_flags. @@ -7498,19 +7498,19 @@ enable/disable as flags. the #AgsAudio object + line="15702">the #AgsAudio object the scope to reset + line="15703">the scope to reset the stage to enable + line="15704">the stage to enable @@ -7520,7 +7520,7 @@ enable/disable as flags. version="3.0.0"> Recursive set property for #AgsAudio. + line="15624">Recursive set property for #AgsAudio. @@ -7529,25 +7529,25 @@ enable/disable as flags. the #AgsAudio + line="15626">the #AgsAudio the count of elements in following arrays + line="15627">the count of elements in following arrays the parameter's name array + line="15628">the parameter's name array the value array + line="15629">the value array @@ -7557,7 +7557,7 @@ enable/disable as flags. version="5.4.0"> Remove all empty automation. + line="11070">Remove all empty automation. @@ -7566,25 +7566,25 @@ enable/disable as flags. the #AgsAudio + line="11072">the #AgsAudio the line + line="11073">the line channel type + line="11074">channel type the control name + line="11075">the control name @@ -7594,7 +7594,7 @@ enable/disable as flags. version="3.0.0"> Removes an automation. + line="11435">Removes an automation. @@ -7603,13 +7603,13 @@ enable/disable as flags. the #AgsAudio + line="11437">the #AgsAudio the #AgsAutomation + line="11438">the #AgsAutomation @@ -7619,7 +7619,7 @@ enable/disable as flags. version="3.0.0"> Removes an automation port. + line="11006">Removes an automation port. @@ -7628,13 +7628,13 @@ enable/disable as flags. the #AgsAudio + line="11008">the #AgsAudio the control name + line="11009">the control name @@ -7644,7 +7644,7 @@ enable/disable as flags. version="3.0.0"> Removes a cursor. + line="10687">Removes a cursor. @@ -7653,13 +7653,13 @@ enable/disable as flags. the #AgsAudio + line="10689">the #AgsAudio the #GObject implementing #AgsCursor + line="10690">the #GObject implementing #AgsCursor @@ -7669,7 +7669,7 @@ enable/disable as flags. version="3.0.0"> Removes a midi. + line="11933">Removes a midi. @@ -7678,13 +7678,13 @@ enable/disable as flags. the #AgsAudio + line="11935">the #AgsAudio the #AgsMidi + line="11936">the #AgsMidi @@ -7694,7 +7694,7 @@ enable/disable as flags. version="3.0.0"> Removes a notation. + line="10842">Removes a notation. @@ -7703,13 +7703,13 @@ enable/disable as flags. the #AgsAudio + line="10844">the #AgsAudio the #AgsNotation + line="10845">the #AgsNotation @@ -7719,7 +7719,7 @@ enable/disable as flags. version="3.0.0"> Removes a preset. + line="10084">Removes a preset. @@ -7728,13 +7728,13 @@ enable/disable as flags. the #AgsAudio + line="10086">the #AgsAudio an #AgsPreset + line="10087">an #AgsPreset @@ -7744,7 +7744,7 @@ enable/disable as flags. version="3.0.0"> Removes a recall from @audio. + line="12735">Removes a recall from @audio. @@ -7753,19 +7753,19 @@ enable/disable as flags. the #AgsAudio + line="12737">the #AgsAudio the #AgsRecall + line="12738">the #AgsRecall if %TRUE play context, else if %FALSE recall context + line="12739">if %TRUE play context, else if %FALSE recall context @@ -7775,7 +7775,7 @@ enable/disable as flags. version="3.0.0"> Removes a recall container. + line="12430">Removes a recall container. @@ -7784,13 +7784,13 @@ enable/disable as flags. the #AgsAudio + line="12432">the #AgsAudio the #AgsRecallContainer + line="12433">the #AgsRecallContainer @@ -7800,7 +7800,7 @@ enable/disable as flags. version="3.0.0"> Removes a recall id. + line="12170">Removes a recall id. @@ -7809,13 +7809,13 @@ enable/disable as flags. the #AgsAudio + line="12172">the #AgsAudio the #AgsRecallID + line="12173">the #AgsRecallID @@ -7825,7 +7825,7 @@ enable/disable as flags. version="3.0.0"> Removes a recycling context. + line="12300">Removes a recycling context. @@ -7834,13 +7834,13 @@ enable/disable as flags. the #AgsAudio + line="12302">the #AgsAudio the #AgsRecyclingContext + line="12303">the #AgsRecyclingContext @@ -7850,7 +7850,7 @@ enable/disable as flags. version="3.4.0"> Removes a SF2 synth generator. + line="10410">Removes a SF2 synth generator. @@ -7859,13 +7859,13 @@ enable/disable as flags. the #AgsAudio + line="10412">the #AgsAudio an #AgsSF2SynthGenerator + line="10413">an #AgsSF2SynthGenerator @@ -7875,7 +7875,7 @@ enable/disable as flags. version="3.4.0"> Removes a SFZ synth generator. + line="10544">Removes a SFZ synth generator. @@ -7884,13 +7884,13 @@ enable/disable as flags. the #AgsAudio + line="10546">the #AgsAudio an #AgsSFZSynthGenerator + line="10547">an #AgsSFZSynthGenerator @@ -7900,7 +7900,7 @@ enable/disable as flags. version="3.0.0"> Removes a synth generator. + line="10276">Removes a synth generator. @@ -7909,13 +7909,13 @@ enable/disable as flags. the #AgsAudio + line="10278">the #AgsAudio an #AgsSynthGenerator + line="10279">an #AgsSynthGenerator @@ -7925,7 +7925,7 @@ enable/disable as flags. version="3.0.0"> Removes a wave. + line="11590">Removes a wave. @@ -7934,13 +7934,13 @@ enable/disable as flags. the #AgsAudio + line="11592">the #AgsAudio the #AgsWave + line="11593">the #AgsWave @@ -7950,7 +7950,7 @@ enable/disable as flags. version="3.0.0"> Performs resolving of recalls. + line="13191">Performs resolving of recalls. @@ -7959,13 +7959,13 @@ enable/disable as flags. the #AgsAudio + line="13193">the #AgsAudio the #AgsRecallID to use + line="13194">the #AgsRecallID to use @@ -8001,7 +8001,7 @@ enable/disable as flags. version="3.1.0"> Sets absolute key. + line="9955">Sets absolute key. @@ -8010,13 +8010,13 @@ enable/disable as flags. the #AgsAudio + line="9957">the #AgsAudio the absolute key + line="9958">the absolute key @@ -8027,7 +8027,7 @@ enable/disable as flags. version="3.0.0"> Resize audio channels AgsInput will be allocated first. + line="6921">Resize audio channels AgsInput will be allocated first. @@ -8036,19 +8036,19 @@ enable/disable as flags. the #AgsAudio + line="6923">the #AgsAudio new audio channels + line="6924">new audio channels old audio channels + line="6925">old audio channels @@ -8085,7 +8085,7 @@ enable/disable as flags. version="3.1.0"> Sets audio start mapping. + line="9485">Sets audio start mapping. @@ -8094,13 +8094,13 @@ enable/disable as flags. the #AgsAudio + line="9487">the #AgsAudio the audio start mapping + line="9488">the audio start mapping @@ -8111,7 +8111,7 @@ enable/disable as flags. version="3.1.0"> Set automation by replacing existing. + line="11216">Set automation by replacing existing. @@ -8120,13 +8120,13 @@ enable/disable as flags. the #AgsAudio + line="11218">the #AgsAudio the #GList-struct containing #AgsAutomation + line="11219">the #GList-struct containing #AgsAutomation @@ -8138,7 +8138,7 @@ enable/disable as flags. version="3.1.0"> Get automation port. + line="10923">Get automation port. @@ -8147,13 +8147,13 @@ enable/disable as flags. the #AgsAudio + line="10925">the #AgsAudio the string vector containing automation ports + line="10926">the string vector containing automation ports @@ -8189,7 +8189,7 @@ enable/disable as flags. version="3.1.0"> Sets bpm. + line="9438">Sets bpm. @@ -8198,13 +8198,13 @@ enable/disable as flags. the #AgsAudio + line="9440">the #AgsAudio the bpm + line="9441">the bpm @@ -8215,7 +8215,7 @@ enable/disable as flags. version="3.0.0"> Sets buffer length. + line="9190">Sets buffer length. @@ -8224,13 +8224,13 @@ enable/disable as flags. the #AgsAudio + line="9192">the #AgsAudio the buffer length + line="9193">the buffer length @@ -8241,7 +8241,7 @@ enable/disable as flags. version="3.1.0"> Set cursor by replacing existing. + line="10606">Set cursor by replacing existing. @@ -8250,13 +8250,13 @@ enable/disable as flags. the #AgsAudio + line="10608">the #AgsAudio the #GList-struct containing #AgsCursor + line="10609">the #GList-struct containing #AgsCursor @@ -8269,7 +8269,7 @@ enable/disable as flags. version="3.1.0"> Sets denominator. + line="9673">Sets denominator. @@ -8278,13 +8278,13 @@ enable/disable as flags. the #AgsAudio + line="9675">the #AgsAudio the denominator + line="9676">the denominator @@ -8320,7 +8320,7 @@ enable/disable as flags. version="3.0.0"> Sets buffer length. + line="9391">Sets buffer length. @@ -8329,13 +8329,13 @@ enable/disable as flags. the #AgsAudio + line="9393">the #AgsAudio the format + line="9394">the format @@ -8346,7 +8346,7 @@ enable/disable as flags. version="3.1.0"> Set input audio file. + line="11711">Set input audio file. @@ -8355,13 +8355,13 @@ enable/disable as flags. the #AgsAudio + line="11713">the #AgsAudio the #GObject + line="11714">the #GObject @@ -8372,7 +8372,7 @@ enable/disable as flags. version="3.1.0"> Set input MIDI file. + line="12054">Set input MIDI file. @@ -8381,13 +8381,13 @@ enable/disable as flags. the #AgsAudio + line="12056">the #AgsAudio the #GObject + line="12057">the #GObject @@ -8398,7 +8398,7 @@ enable/disable as flags. version="3.1.0"> Set input pads. + line="7027">Set input pads. @@ -8407,13 +8407,13 @@ enable/disable as flags. the #AgsAudio + line="7029">the #AgsAudio input pads + line="7030">input pads @@ -8424,7 +8424,7 @@ enable/disable as flags. version="3.0.0"> Set the input sequencer object of @audio. + line="8740">Set the input sequencer object of @audio. @@ -8433,13 +8433,13 @@ enable/disable as flags. an #AgsAudio + line="8742">an #AgsAudio the #GObject implementing #AgsSequencer + line="8743">the #GObject implementing #AgsSequencer @@ -8450,7 +8450,7 @@ enable/disable as flags. version="3.0.0"> Set the input soundcard object of @audio. + line="8560">Set the input soundcard object of @audio. @@ -8459,13 +8459,13 @@ enable/disable as flags. an #AgsAudio + line="8562">an #AgsAudio the #GObject implementing #AgsSoundcard + line="8563">the #GObject implementing #AgsSoundcard @@ -8475,7 +8475,7 @@ enable/disable as flags. version="3.1.0"> Sets instrument name. + line="11758">Sets instrument name. @@ -8484,13 +8484,13 @@ enable/disable as flags. the #AgsAudio + line="11760">the #AgsAudio the instrument name + line="11761">the instrument name @@ -8501,7 +8501,7 @@ enable/disable as flags. version="3.1.0"> Sets is minor. + line="9767">Sets is minor. @@ -8510,13 +8510,13 @@ enable/disable as flags. the #AgsAudio + line="9769">the #AgsAudio is minor + line="9770">is minor @@ -8527,7 +8527,7 @@ enable/disable as flags. version="3.1.0"> Sets key. + line="9908">Sets key. @@ -8536,13 +8536,13 @@ enable/disable as flags. the #AgsAudio + line="9910">the #AgsAudio the key + line="9911">the key @@ -8662,7 +8662,7 @@ enable/disable as flags. version="3.1.0"> Set midi by replacing existing. + line="11852">Set midi by replacing existing. @@ -8671,13 +8671,13 @@ enable/disable as flags. the #AgsAudio + line="11854">the #AgsAudio the #GList-struct containing #AgsMidi + line="11855">the #GList-struct containing #AgsMidi @@ -8690,7 +8690,7 @@ enable/disable as flags. version="3.1.0"> Sets midi channel. + line="9579">Sets midi channel. @@ -8699,13 +8699,13 @@ enable/disable as flags. the #AgsAudio + line="9581">the #AgsAudio the midi channel + line="9582">the midi channel @@ -8716,7 +8716,7 @@ enable/disable as flags. version="3.1.0"> Sets midi start mapping. + line="9532">Sets midi start mapping. @@ -8725,13 +8725,13 @@ enable/disable as flags. the #AgsAudio + line="9534">the #AgsAudio the midi start mapping + line="9535">the midi start mapping @@ -8742,7 +8742,7 @@ enable/disable as flags. version="3.1.0"> Set notation by replacing existing. + line="10761">Set notation by replacing existing. @@ -8751,13 +8751,13 @@ enable/disable as flags. the #AgsAudio + line="10763">the #AgsAudio the #GList-struct containing #AgsNotation + line="10764">the #GList-struct containing #AgsNotation @@ -8770,7 +8770,7 @@ enable/disable as flags. version="3.1.0"> Sets numerator. + line="9626">Sets numerator. @@ -8779,13 +8779,13 @@ enable/disable as flags. the #AgsAudio + line="9628">the #AgsAudio the numerator + line="9629">the numerator @@ -8796,7 +8796,7 @@ enable/disable as flags. version="3.1.0"> Sets octave. + line="9861">Sets octave. @@ -8805,13 +8805,13 @@ enable/disable as flags. the #AgsAudio + line="9863">the #AgsAudio the octave + line="9864">the octave @@ -8822,7 +8822,7 @@ enable/disable as flags. version="3.1.0"> Set output audio file. + line="11664">Set output audio file. @@ -8831,13 +8831,13 @@ enable/disable as flags. the #AgsAudio + line="11666">the #AgsAudio the #GObject + line="11667">the #GObject @@ -8848,7 +8848,7 @@ enable/disable as flags. version="3.1.0"> Set output MIDI file. + line="12007">Set output MIDI file. @@ -8857,13 +8857,13 @@ enable/disable as flags. the #AgsAudio + line="12009">the #AgsAudio the #GObject + line="12010">the #GObject @@ -8874,7 +8874,7 @@ enable/disable as flags. version="3.1.0"> Set output pads. + line="6983">Set output pads. @@ -8883,13 +8883,13 @@ enable/disable as flags. the #AgsAudio + line="6985">the #AgsAudio output pads + line="6986">output pads @@ -8900,7 +8900,7 @@ enable/disable as flags. version="3.0.0"> Set the output sequencer object of @audio. + line="8650">Set the output sequencer object of @audio. @@ -8909,13 +8909,13 @@ enable/disable as flags. an #AgsAudio + line="8652">an #AgsAudio the #GObject implementing #AgsSequencer + line="8653">the #GObject implementing #AgsSequencer @@ -8926,7 +8926,7 @@ enable/disable as flags. version="3.0.0"> Set the output soundcard object of @audio. + line="8377">Set the output soundcard object of @audio. @@ -8935,13 +8935,13 @@ enable/disable as flags. the #AgsAudio + line="8379">the #AgsAudio the #GObject implementing #AgsSoundcard + line="8380">the #GObject implementing #AgsSoundcard @@ -8951,7 +8951,7 @@ enable/disable as flags. version="3.0.0"> Set pad count for the apropriate @channel_type + line="8026">Set pad count for the apropriate @channel_type @@ -8960,25 +8960,25 @@ enable/disable as flags. the #AgsAudio + line="8028">the #AgsAudio AGS_TYPE_INPUT or AGS_TYPE_OUTPUT + line="8029">AGS_TYPE_INPUT or AGS_TYPE_OUTPUT new pad count + line="8030">new pad count old pad count + line="8031">old pad count @@ -8989,7 +8989,7 @@ enable/disable as flags. version="3.1.0"> Set play by replacing existing. + line="12491">Set play by replacing existing. @@ -8998,13 +8998,13 @@ enable/disable as flags. the #AgsAudio + line="12493">the #AgsAudio the #GList-struct containing #AgsRecall + line="12494">the #GList-struct containing #AgsRecall @@ -9017,7 +9017,7 @@ enable/disable as flags. version="3.1.0"> Set playback domain. + line="10159">Set playback domain. @@ -9026,13 +9026,13 @@ enable/disable as flags. the #AgsAudio + line="10161">the #AgsAudio the #AgsPlaybackDomain + line="10162">the #AgsPlaybackDomain @@ -9043,7 +9043,7 @@ enable/disable as flags. version="3.1.0"> Set preset by replacing existing. + line="10002">Set preset by replacing existing. @@ -9052,13 +9052,13 @@ enable/disable as flags. the #AgsAudio + line="10004">the #AgsAudio the #GList-struct containing #AgsPreset + line="10005">the #GList-struct containing #AgsPreset @@ -9071,7 +9071,7 @@ enable/disable as flags. version="3.1.0"> Set recall by replacing existing. + line="12551">Set recall by replacing existing. @@ -9080,13 +9080,13 @@ enable/disable as flags. the #AgsAudio + line="12553">the #AgsAudio the #GList-struct containing #AgsRecall + line="12554">the #GList-struct containing #AgsRecall @@ -9099,7 +9099,7 @@ enable/disable as flags. version="3.1.0"> Set recall_container by replacing existing. + line="12361">Set recall_container by replacing existing. @@ -9108,13 +9108,13 @@ enable/disable as flags. the #AgsAudio + line="12363">the #AgsAudio the #GList-struct containing #AgsRecallContainer + line="12364">the #GList-struct containing #AgsRecallContainer @@ -9127,7 +9127,7 @@ enable/disable as flags. version="3.1.0"> Set recall id by replacing existing. + line="12101">Set recall id by replacing existing. @@ -9136,13 +9136,13 @@ enable/disable as flags. the #AgsAudio + line="12103">the #AgsAudio the #GList-struct containing #AgsRecallID + line="12104">the #GList-struct containing #AgsRecallID @@ -9155,7 +9155,7 @@ enable/disable as flags. version="3.1.0"> Set recycling_context by replacing existing. + line="12231">Set recycling_context by replacing existing. @@ -9164,13 +9164,13 @@ enable/disable as flags. the #AgsAudio + line="12233">the #AgsAudio the #GList-struct containing #AgsRecyclingContext + line="12234">the #GList-struct containing #AgsRecyclingContext @@ -9183,7 +9183,7 @@ enable/disable as flags. version="3.0.0"> Sets samplerate. + line="8965">Sets samplerate. @@ -9192,13 +9192,13 @@ enable/disable as flags. the #AgsAudio + line="8967">the #AgsAudio the samplerate + line="8968">the samplerate @@ -9209,7 +9209,7 @@ enable/disable as flags. version="3.4.0"> Set SF2 synth generator by replacing existing. + line="10338">Set SF2 synth generator by replacing existing. @@ -9218,13 +9218,13 @@ enable/disable as flags. the #AgsAudio + line="10340">the #AgsAudio the #GList-struct containing #AgsSF2SynthGenerator + line="10341">the #GList-struct containing #AgsSF2SynthGenerator @@ -9237,7 +9237,7 @@ enable/disable as flags. version="3.4.0"> Set SFZ synth generator by replacing existing. + line="10474">Set SFZ synth generator by replacing existing. @@ -9246,13 +9246,13 @@ enable/disable as flags. the #AgsAudio + line="10476">the #AgsAudio the #GList-struct containing #AgsSFZSynthGenerator + line="10477">the #GList-struct containing #AgsSFZSynthGenerator @@ -9265,7 +9265,7 @@ enable/disable as flags. version="3.1.0"> Sets sharp flats. + line="9814">Sets sharp flats. @@ -9274,13 +9274,13 @@ enable/disable as flags. the #AgsAudio + line="9816">the #AgsAudio the sharp flats + line="9817">the sharp flats @@ -9347,7 +9347,7 @@ enable/disable as flags. version="3.1.0"> Set synth generator by replacing existing. + line="10206">Set synth generator by replacing existing. @@ -9356,13 +9356,13 @@ enable/disable as flags. the #AgsAudio + line="10208">the #AgsAudio the #GList-struct containing #AgsSynthGenerator + line="10209">the #GList-struct containing #AgsSynthGenerator @@ -9374,7 +9374,7 @@ enable/disable as flags. version="3.1.0"> Sets time signature. + line="9720">Sets time signature. @@ -9383,13 +9383,13 @@ enable/disable as flags. the #AgsAudio + line="9722">the #AgsAudio the time signature + line="9723">the time signature @@ -9399,7 +9399,7 @@ enable/disable as flags. version="3.1.0"> Sets track name. + line="11805">Sets track name. @@ -9408,13 +9408,13 @@ enable/disable as flags. the #AgsAudio + line="11807">the #AgsAudio the track name + line="11808">the track name @@ -9425,7 +9425,7 @@ enable/disable as flags. version="3.1.0"> Set wave by replacing existing. + line="11509">Set wave by replacing existing. @@ -9434,13 +9434,13 @@ enable/disable as flags. the #AgsAudio + line="11511">the #AgsAudio the #GList-struct containing #AgsWave + line="11512">the #GList-struct containing #AgsWave @@ -9450,12 +9450,12 @@ enable/disable as flags. Is emitted as audio is started. + line="14502">Is emitted as audio is started. the #GList-struct containing #AgsRecallID + line="14509">the #GList-struct containing #AgsRecallID @@ -9464,13 +9464,13 @@ enable/disable as flags. the #AgsAudio + line="14504">the #AgsAudio the scope + line="14505">the scope @@ -9478,7 +9478,7 @@ enable/disable as flags. Is emitted as playing audio is stopped. + line="14830">Is emitted as playing audio is stopped. @@ -9487,13 +9487,13 @@ enable/disable as flags. the #AgsAudio + line="14832">the #AgsAudio the #GList-struct containing #AgsRecallID + line="14833">the #GList-struct containing #AgsRecallID @@ -9501,7 +9501,7 @@ enable/disable as flags. the scope + line="14834">the scope @@ -15299,19 +15299,19 @@ of @audio. the #AgsAudio + line="6923">the #AgsAudio new audio channels + line="6924">new audio channels old audio channels + line="6925">old audio channels @@ -15327,25 +15327,25 @@ of @audio. the #AgsAudio + line="8028">the #AgsAudio AGS_TYPE_INPUT or AGS_TYPE_OUTPUT + line="8029">AGS_TYPE_INPUT or AGS_TYPE_OUTPUT new pad count + line="8030">new pad count old pad count + line="8031">old pad count @@ -15361,31 +15361,31 @@ of @audio. the #AgsAudio + line="13034">the #AgsAudio an #AgsRecallID + line="13035">an #AgsRecallID the pad + line="13036">the pad the audio channel + line="13037">the audio channel the line + line="13038">the line @@ -15401,13 +15401,13 @@ of @audio. the #AgsAudio + line="13193">the #AgsAudio the #AgsRecallID to use + line="13194">the #AgsRecallID to use @@ -15423,19 +15423,19 @@ of @audio. the #AgsAudio + line="13376">the #AgsAudio the #AgsRecallID to use or #NULL + line="13377">the #AgsRecallID to use or #NULL staging flags, see #AgsSoundStagingFlags-enum + line="13378">staging flags, see #AgsSoundStagingFlags-enum @@ -15451,19 +15451,19 @@ of @audio. the #AgsAudio + line="13570">the #AgsAudio the #AgsRecallID to apply to + line="13571">the #AgsRecallID to apply to staging flags, see #AgsSoundStagingFlags-enum + line="13572">staging flags, see #AgsSoundStagingFlags-enum @@ -15479,13 +15479,13 @@ of @audio. the #AgsAudio + line="13729">the #AgsAudio the #AgsRecallID to apply to + line="13730">the #AgsRecallID to apply to @@ -15501,13 +15501,13 @@ of @audio. the #AgsAudio + line="13887">the #AgsAudio the #AgsRecallID to apply to + line="13888">the #AgsRecallID to apply to @@ -15523,13 +15523,13 @@ of @audio. the #AgsAudio + line="14065">the #AgsAudio the #AgsRecallID to apply to + line="14066">the #AgsRecallID to apply to @@ -15541,7 +15541,7 @@ of @audio. the #GList-struct containing #AgsRecallID + line="14509">the #GList-struct containing #AgsRecallID @@ -15550,13 +15550,13 @@ of @audio. the #AgsAudio + line="14504">the #AgsAudio the scope + line="14505">the scope @@ -15572,13 +15572,13 @@ of @audio. the #AgsAudio + line="14832">the #AgsAudio the #GList-struct containing #AgsRecallID + line="14833">the #GList-struct containing #AgsRecallID @@ -15586,7 +15586,7 @@ of @audio. the scope + line="14834">the scope @@ -15598,7 +15598,7 @@ of @audio. the scope's recall id of @audio + line="14920">the scope's recall id of @audio @@ -15607,13 +15607,13 @@ of @audio. the #AgsAudio + line="14915">the #AgsAudio the scope + line="14916">the scope @@ -15629,19 +15629,19 @@ of @audio. the #AgsAudio object + line="15702">the #AgsAudio object the scope to reset + line="15703">the scope to reset the stage to enable + line="15704">the stage to enable @@ -28983,19 +28983,19 @@ enable/disable as flags. Creates a new instance of #AgsChannel, linking tree to @audio. + line="14708">Creates a new instance of #AgsChannel, linking tree to @audio. a new #AgsChannel + line="14714">a new #AgsChannel the #AgsAudio + line="14710">the #AgsAudio @@ -29010,7 +29010,7 @@ enable/disable as flags. version="3.0.0"> Cancel processing specified by @recall_id. + line="10399">Cancel processing specified by @recall_id. @@ -29019,13 +29019,13 @@ enable/disable as flags. the #AgsChannel + line="10401">the #AgsChannel the #AgsRecallID + line="10402">the #AgsRecallID @@ -29033,12 +29033,12 @@ enable/disable as flags. Check @channel's @sound_scope. + line="11278">Check @channel's @sound_scope. the #GList-struct containing #AgsRecallID or %NULL if not playing + line="11285">the #GList-struct containing #AgsRecallID or %NULL if not playing @@ -29047,13 +29047,13 @@ enable/disable as flags. the #AgsChannel + line="11280">the #AgsChannel the sound scope + line="11281">the sound scope @@ -29063,7 +29063,7 @@ enable/disable as flags. version="3.0.0"> Cleanup processing specified by @recall_id. + line="10569">Cleanup processing specified by @recall_id. @@ -29072,13 +29072,13 @@ enable/disable as flags. the #AgsChannel + line="10571">the #AgsChannel the #AgsRecallID + line="10572">the #AgsRecallID @@ -29086,7 +29086,7 @@ enable/disable as flags. Done processing specified by @recall_id. + line="10238">Done processing specified by @recall_id. @@ -29095,13 +29095,13 @@ enable/disable as flags. the #AgsChannel + line="10240">the #AgsChannel the #AgsRecallID + line="10241">the #AgsRecallID @@ -29134,7 +29134,7 @@ enable/disable as flags. Prepare #AgsRecall objects and invoke #AgsRecall::run-init-pre, #AgsRecall::run-init-inter or + line="9880">Prepare #AgsRecall objects and invoke #AgsRecall::run-init-pre, #AgsRecall::run-init-inter or #AgsRecall::run-init-post as specified by @staging_flags. @@ -29144,19 +29144,19 @@ enable/disable as flags. the #AgsChannel + line="9882">the #AgsChannel the #AgsRecallID + line="9883">the #AgsRecallID the stages to invoke + line="9884">the stages to invoke @@ -29164,7 +29164,7 @@ enable/disable as flags. Run the specified steps by @recall_id of @channel. + line="10079">Run the specified steps by @recall_id of @channel. @@ -29173,19 +29173,19 @@ enable/disable as flags. the #AgsChannel + line="10081">the #AgsChannel the #AgsRecallID + line="10082">the #AgsRecallID the stages to invoke + line="10083">the stages to invoke @@ -29195,7 +29195,7 @@ enable/disable as flags. version="3.0.0"> Recursive run stage specified by @staging_flags for matching @sound_scope. + line="14685">Recursive run stage specified by @staging_flags for matching @sound_scope. @@ -29204,19 +29204,19 @@ enable/disable as flags. the #AgsChannel + line="14687">the #AgsChannel the sound scope + line="14688">the sound scope the staging flags + line="14689">the staging flags @@ -29316,12 +29316,12 @@ enable/disable as flags. Start @channel's @sound_scope to do playback. + line="10966">Start @channel's @sound_scope to do playback. the #GList-struct containing #AgsRecallID + line="10973">the #GList-struct containing #AgsRecallID @@ -29330,13 +29330,13 @@ enable/disable as flags. the #AgsChannel + line="10968">the #AgsChannel the sound scope + line="10969">the sound scope @@ -29344,7 +29344,7 @@ enable/disable as flags. Stop @channel's @sound_scope playback specified by @recall_id. + line="11195">Stop @channel's @sound_scope playback specified by @recall_id. @@ -29353,13 +29353,13 @@ enable/disable as flags. the #AgsChannel + line="11197">the #AgsChannel the #GList-struct containing #AgsRecallID + line="11198">the #GList-struct containing #AgsRecallID @@ -29367,7 +29367,7 @@ enable/disable as flags. the sound scope + line="11199">the sound scope @@ -29483,7 +29483,7 @@ enable/disable as flags. version="3.0.0"> Cancel processing specified by @recall_id. + line="10399">Cancel processing specified by @recall_id. @@ -29492,13 +29492,13 @@ enable/disable as flags. the #AgsChannel + line="10401">the #AgsChannel the #AgsRecallID + line="10402">the #AgsRecallID @@ -29508,12 +29508,12 @@ enable/disable as flags. version="3.0.0"> Check @channel's @sound_scope. + line="11278">Check @channel's @sound_scope. the #GList-struct containing #AgsRecallID or %NULL if not playing + line="11285">the #GList-struct containing #AgsRecallID or %NULL if not playing @@ -29522,13 +29522,13 @@ enable/disable as flags. the #AgsChannel + line="11280">the #AgsChannel the sound scope + line="11281">the sound scope @@ -29538,7 +29538,7 @@ enable/disable as flags. version="3.0.0"> Cleanup processing specified by @recall_id. + line="10569">Cleanup processing specified by @recall_id. @@ -29547,13 +29547,13 @@ enable/disable as flags. the #AgsChannel + line="10571">the #AgsChannel the #AgsRecallID + line="10572">the #AgsRecallID @@ -29563,12 +29563,12 @@ enable/disable as flags. version="3.0.0"> Retrieve all ports of #AgsChannel. + line="11308">Retrieve all ports of #AgsChannel. a new #GList containing #AgsPort + line="11314">a new #GList containing #AgsPort @@ -29577,7 +29577,7 @@ enable/disable as flags. the #AgsChannel + line="11310">the #AgsChannel @@ -29587,12 +29587,12 @@ enable/disable as flags. version="3.0.0"> Retrieve specified port of #AgsChannel + line="11435">Retrieve specified port of #AgsChannel a #GList-struct of #AgsPort if found, otherwise %NULL + line="11443">a #GList-struct of #AgsPort if found, otherwise %NULL @@ -29601,19 +29601,19 @@ enable/disable as flags. an #AgsChannel + line="11437">an #AgsChannel the port's name + line="11438">the port's name either %TRUE for play or %FALSE for recall + line="11439">either %TRUE for play or %FALSE for recall @@ -29623,7 +29623,7 @@ enable/disable as flags. version="3.0.0"> Done processing specified by @recall_id. + line="10238">Done processing specified by @recall_id. @@ -29632,13 +29632,13 @@ enable/disable as flags. the #AgsChannel + line="10240">the #AgsChannel the #AgsRecallID + line="10241">the #AgsRecallID @@ -29899,19 +29899,19 @@ enable/disable as flags. version="3.0.0"> Get level. + line="11543">Get level. the level of @channel as #AgsChannel or %NULL if no parent recycling. + line="11549">the level of @channel as #AgsChannel or %NULL if no parent recycling. the #AgsChannel + line="11545">the #AgsChannel @@ -30298,7 +30298,7 @@ enable/disable as flags. version="3.0.0"> Prepare #AgsRecall objects and invoke #AgsRecall::run-init-pre, #AgsRecall::run-init-inter or + line="9880">Prepare #AgsRecall objects and invoke #AgsRecall::run-init-pre, #AgsRecall::run-init-inter or #AgsRecall::run-init-post as specified by @staging_flags. @@ -30308,19 +30308,19 @@ enable/disable as flags. the #AgsChannel + line="9882">the #AgsChannel the #AgsRecallID + line="9883">the #AgsRecallID the stages to invoke + line="9884">the stages to invoke @@ -30571,7 +30571,7 @@ enable/disable as flags. version="3.0.0"> Run the specified steps by @recall_id of @channel. + line="10079">Run the specified steps by @recall_id of @channel. @@ -30580,19 +30580,19 @@ enable/disable as flags. the #AgsChannel + line="10081">the #AgsChannel the #AgsRecallID + line="10082">the #AgsRecallID the stages to invoke + line="10083">the stages to invoke @@ -30666,7 +30666,7 @@ enable/disable as flags. version="3.0.0"> Recursive run stage specified by @staging_flags for matching @sound_scope. + line="14685">Recursive run stage specified by @staging_flags for matching @sound_scope. @@ -30675,19 +30675,19 @@ enable/disable as flags. the #AgsChannel + line="14687">the #AgsChannel the sound scope + line="14688">the sound scope the staging flags + line="14689">the staging flags @@ -30697,7 +30697,7 @@ enable/disable as flags. version="3.0.0"> Recursive set property for #AgsChannel. + line="11782">Recursive set property for #AgsChannel. @@ -30706,25 +30706,25 @@ enable/disable as flags. the #AgsChannel + line="11784">the #AgsChannel the count of paramter name and value pairs + line="11785">the count of paramter name and value pairs a string vector containing parameter names + line="11786">a string vector containing parameter names the value array + line="11787">the value array @@ -31647,12 +31647,12 @@ Further it does loop detection and makes your machine running. Start @channel's @sound_scope to do playback. + line="10966">Start @channel's @sound_scope to do playback. the #GList-struct containing #AgsRecallID + line="10973">the #GList-struct containing #AgsRecallID @@ -31661,13 +31661,13 @@ Further it does loop detection and makes your machine running. the #AgsChannel + line="10968">the #AgsChannel the sound scope + line="10969">the sound scope @@ -31675,7 +31675,7 @@ Further it does loop detection and makes your machine running. Stop @channel's @sound_scope playback specified by @recall_id. + line="11195">Stop @channel's @sound_scope playback specified by @recall_id. @@ -31684,13 +31684,13 @@ Further it does loop detection and makes your machine running. the #AgsChannel + line="11197">the #AgsChannel the #GList-struct containing #AgsRecallID + line="11198">the #GList-struct containing #AgsRecallID @@ -31698,7 +31698,7 @@ Further it does loop detection and makes your machine running. the sound scope + line="11199">the sound scope @@ -32851,19 +32851,19 @@ Further it does loop detection and makes your machine running. the #AgsChannel + line="9882">the #AgsChannel the #AgsRecallID + line="9883">the #AgsRecallID the stages to invoke + line="9884">the stages to invoke @@ -32879,19 +32879,19 @@ Further it does loop detection and makes your machine running. the #AgsChannel + line="10081">the #AgsChannel the #AgsRecallID + line="10082">the #AgsRecallID the stages to invoke + line="10083">the stages to invoke @@ -32907,13 +32907,13 @@ Further it does loop detection and makes your machine running. the #AgsChannel + line="10240">the #AgsChannel the #AgsRecallID + line="10241">the #AgsRecallID @@ -32929,13 +32929,13 @@ Further it does loop detection and makes your machine running. the #AgsChannel + line="10401">the #AgsChannel the #AgsRecallID + line="10402">the #AgsRecallID @@ -32951,13 +32951,13 @@ Further it does loop detection and makes your machine running. the #AgsChannel + line="10571">the #AgsChannel the #AgsRecallID + line="10572">the #AgsRecallID @@ -32969,7 +32969,7 @@ Further it does loop detection and makes your machine running. the #GList-struct containing #AgsRecallID + line="10973">the #GList-struct containing #AgsRecallID @@ -32978,13 +32978,13 @@ Further it does loop detection and makes your machine running. the #AgsChannel + line="10968">the #AgsChannel the sound scope + line="10969">the sound scope @@ -33000,13 +33000,13 @@ Further it does loop detection and makes your machine running. the #AgsChannel + line="11197">the #AgsChannel the #GList-struct containing #AgsRecallID + line="11198">the #GList-struct containing #AgsRecallID @@ -33014,7 +33014,7 @@ Further it does loop detection and makes your machine running. the sound scope + line="11199">the sound scope @@ -33026,7 +33026,7 @@ Further it does loop detection and makes your machine running. the #GList-struct containing #AgsRecallID or %NULL if not playing + line="11285">the #GList-struct containing #AgsRecallID or %NULL if not playing @@ -33035,13 +33035,13 @@ Further it does loop detection and makes your machine running. the #AgsChannel + line="11280">the #AgsChannel the sound scope + line="11281">the sound scope @@ -33057,19 +33057,19 @@ Further it does loop detection and makes your machine running. the #AgsChannel + line="14687">the #AgsChannel the sound scope + line="14688">the sound scope the staging flags + line="14689">the staging flags @@ -37609,13 +37609,13 @@ enable/disable as flags. version="3.0.0"> Creates a new instance of #AgsCoreAudioDevin. + line="3588">Creates a new instance of #AgsCoreAudioDevin. a new #AgsCoreAudioDevin + line="3593">a new #AgsCoreAudioDevin @@ -37630,7 +37630,7 @@ enable/disable as flags. version="3.0.0"> Calculate delay and attack and reset it. + line="3457">Calculate delay and attack and reset it. @@ -37641,7 +37641,7 @@ enable/disable as flags. transfer-ownership="none"> the #AgsCoreAudioDevin + line="3459">the #AgsCoreAudioDevin @@ -37651,7 +37651,7 @@ enable/disable as flags. version="3.0.0"> Reallocate the internal audio buffer. + line="3475">Reallocate the internal audio buffer. @@ -37662,7 +37662,7 @@ enable/disable as flags. transfer-ownership="none"> the #AgsCoreAudioDevin + line="3477">the #AgsCoreAudioDevin @@ -37699,7 +37699,7 @@ enable/disable as flags. version="3.0.0"> The buffer flag indicates the currently played buffer. + line="3413">The buffer flag indicates the currently played buffer. @@ -37710,7 +37710,7 @@ enable/disable as flags. transfer-ownership="none"> an #AgsCoreAudioDevin + line="3415">an #AgsCoreAudioDevin @@ -38232,13 +38232,13 @@ enable/disable as flags. version="3.0.0"> Creates a new instance of #AgsCoreAudioDevout. + line="3998">Creates a new instance of #AgsCoreAudioDevout. a new #AgsCoreAudioDevout + line="4003">a new #AgsCoreAudioDevout @@ -38253,7 +38253,7 @@ enable/disable as flags. version="3.0.0"> Calculate delay and attack and reset it. + line="3867">Calculate delay and attack and reset it. @@ -38264,7 +38264,7 @@ enable/disable as flags. transfer-ownership="none"> the #AgsCoreAudioDevout + line="3869">the #AgsCoreAudioDevout @@ -38274,7 +38274,7 @@ enable/disable as flags. version="3.0.0"> Reallocate the internal audio buffer. + line="3885">Reallocate the internal audio buffer. @@ -38285,7 +38285,7 @@ enable/disable as flags. transfer-ownership="none"> the #AgsCoreAudioDevout + line="3887">the #AgsCoreAudioDevout @@ -38323,7 +38323,7 @@ enable/disable as flags. version="3.0.0"> The buffer flag indicates the currently played buffer. + line="3823">The buffer flag indicates the currently played buffer. @@ -38334,7 +38334,7 @@ enable/disable as flags. transfer-ownership="none"> an #AgsCoreAudioDevout + line="3825">an #AgsCoreAudioDevout @@ -39322,20 +39322,20 @@ enable/disable as flags. version="3.0.0"> Create a new instance of #AgsCoreAudioPort. + line="3010">Create a new instance of #AgsCoreAudioPort. the new #AgsCoreAudioPort + line="3016">the new #AgsCoreAudioPort the #AgsCoreAudioClient assigned to + line="3012">the #AgsCoreAudioClient assigned to @@ -39345,13 +39345,13 @@ enable/disable as flags. version="3.0.0"> Finds next match of @port_name in @core_audio_port. + line="1036">Finds next match of @port_name in @core_audio_port. the next matching #GList-struct or %NULL + line="1043">the next matching #GList-struct or %NULL @@ -39360,7 +39360,7 @@ enable/disable as flags. the #GList-struct containing #AgsCoreAudioPort + line="1038">the #GList-struct containing #AgsCoreAudioPort @@ -39368,7 +39368,7 @@ enable/disable as flags. the port name to find + line="1039">the port name to find @@ -39378,7 +39378,7 @@ enable/disable as flags. version="3.0.0"> Gets latency. + line="2974">Gets latency. @@ -39388,7 +39388,7 @@ enable/disable as flags. the #AgsCoreAudioPort + line="2976">the #AgsCoreAudioPort @@ -39398,7 +39398,7 @@ enable/disable as flags. version="3.0.0"> Register a new core audio port and read uuid. Creates a new AgsSequencer or AgsSoundcard + line="1533">Register a new core audio port and read uuid. Creates a new AgsSequencer or AgsSoundcard object. @@ -39409,31 +39409,31 @@ object. the #AgsCoreAudioPort + line="1535">the #AgsCoreAudioPort the name as string + line="1536">the name as string if %TRUE interpreted as audio port + line="1537">if %TRUE interpreted as audio port if %TRUE interpreted as midi port + line="1538">if %TRUE interpreted as midi port if %TRUE port is acting as output, otherwise as input + line="1539">if %TRUE port is acting as output, otherwise as input @@ -39475,7 +39475,7 @@ object. version="3.0.0"> Enable a feature of @core_audio_port. + line="974">Enable a feature of @core_audio_port. @@ -39485,13 +39485,13 @@ object. the #AgsCoreAudioPort + line="976">the #AgsCoreAudioPort see #AgsCoreAudioPortFlags-enum + line="977">see #AgsCoreAudioPortFlags-enum @@ -39548,26 +39548,26 @@ object. version="3.0.0"> Test @flags to be set on @core_audio_port. + line="939">Test @flags to be set on @core_audio_port. %TRUE if flags are set, else %FALSE + line="946">%TRUE if flags are set, else %FALSE the #AgsCoreAudioPort + line="941">the #AgsCoreAudioPort the flags + line="942">the flags @@ -39589,7 +39589,7 @@ object. version="3.0.0"> Disable a feature of @core_audio_port. + line="1005">Disable a feature of @core_audio_port. @@ -39599,13 +39599,13 @@ object. the #AgsCoreAudioPort + line="1007">the #AgsCoreAudioPort see #AgsCoreAudioPortFlags-enum + line="1008">see #AgsCoreAudioPortFlags-enum @@ -40812,31 +40812,31 @@ be %TRUE else it won't have any effect. version="3.0.0"> Create a new instance of #AgsDssiPlugin + line="781">Create a new instance of #AgsDssiPlugin the new #AgsDssiPlugin + line="789">the new #AgsDssiPlugin the plugin .so + line="783">the plugin .so the effect's string representation + line="784">the effect's string representation the effect's index + line="785">the effect's index @@ -60321,7 +60321,7 @@ enable/disable as flags. version="3.3.0"> Load port of @fx_dssi_audio. + line="1788">Load port of @fx_dssi_audio. @@ -60330,7 +60330,7 @@ enable/disable as flags. the #AgsFxDssiAudio + line="1790">the #AgsFxDssiAudio @@ -64459,19 +64459,19 @@ enable/disable as flags. version="3.3.0"> Create a new instance of #AgsFxLv2Audio + line="2298">Create a new instance of #AgsFxLv2Audio the new #AgsFxLv2Audio + line="2304">the new #AgsFxLv2Audio the #AgsAudio + line="2300">the #AgsAudio @@ -64481,7 +64481,7 @@ enable/disable as flags. version="3.3.0"> Change program of @fx_lv2_audio. + line="2207">Change program of @fx_lv2_audio. @@ -64490,19 +64490,19 @@ enable/disable as flags. the #AgsFxLv2Audio + line="2209">the #AgsFxLv2Audio the bank index + line="2210">the bank index the program index + line="2211">the program index @@ -64512,7 +64512,7 @@ enable/disable as flags. version="3.3.0"> Load plugin of @fx_lv2_audio. + line="1580">Load plugin of @fx_lv2_audio. @@ -64521,7 +64521,7 @@ enable/disable as flags. the #AgsFxLv2Audio + line="1582">the #AgsFxLv2Audio @@ -64531,7 +64531,7 @@ enable/disable as flags. version="3.3.0"> Load port of @fx_lv2_audio. + line="1852">Load port of @fx_lv2_audio. @@ -64540,7 +64540,7 @@ enable/disable as flags. the #AgsFxLv2Audio + line="1854">the #AgsFxLv2Audio @@ -64550,7 +64550,7 @@ enable/disable as flags. version="3.3.0"> Set @flags of @fx_lv2_audio. + line="1290">Set @flags of @fx_lv2_audio. @@ -64559,13 +64559,13 @@ enable/disable as flags. the #AgsFxLv2Audio + line="1292">the #AgsFxLv2Audio the flags + line="1293">the flags @@ -64575,25 +64575,25 @@ enable/disable as flags. version="3.3.0"> Test @flags of @fx_lv2_audio. + line="1255">Test @flags of @fx_lv2_audio. %TRUE on success, otherwise %FALSE + line="1262">%TRUE on success, otherwise %FALSE the #AgsFxLv2Audio + line="1257">the #AgsFxLv2Audio the flags + line="1258">the flags @@ -64603,7 +64603,7 @@ enable/disable as flags. version="3.3.0"> Unset @flags of @fx_lv2_audio. + line="1319">Unset @flags of @fx_lv2_audio. @@ -64612,13 +64612,13 @@ enable/disable as flags. the #AgsFxLv2Audio + line="1321">the #AgsFxLv2Audio the flags + line="1322">the flags @@ -64713,7 +64713,7 @@ enable/disable as flags. version="3.3.0"> Free @channel_data. + line="1058">Free @channel_data. @@ -64722,7 +64722,7 @@ enable/disable as flags. the #AgsFxLv2AudioChannelData-struct + line="1060">the #AgsFxLv2AudioChannelData-struct @@ -64734,12 +64734,12 @@ enable/disable as flags. introspectable="0"> Allocate #AgsFxLv2AudioChannelData-struct + line="1012">Allocate #AgsFxLv2AudioChannelData-struct the new #AgsFxLv2AudioChannelData-struct + line="1017">the new #AgsFxLv2AudioChannelData-struct @@ -64800,7 +64800,7 @@ enable/disable as flags. version="3.3.0"> Free @input_data. + line="1181">Free @input_data. @@ -64809,7 +64809,7 @@ enable/disable as flags. the #AgsFxLv2AudioInputData-struct + line="1183">the #AgsFxLv2AudioInputData-struct @@ -64820,12 +64820,12 @@ enable/disable as flags. introspectable="0"> Allocate #AgsFxLv2AudioInputData-struct + line="1137">Allocate #AgsFxLv2AudioInputData-struct the new #AgsFxLv2AudioInputData-struct + line="1142">the new #AgsFxLv2AudioInputData-struct @@ -64901,7 +64901,7 @@ enable/disable as flags. version="3.3.0"> Free @scope_data. + line="988">Free @scope_data. @@ -64910,7 +64910,7 @@ enable/disable as flags. the #AgsFxLv2AudioScopeData-struct + line="990">the #AgsFxLv2AudioScopeData-struct @@ -64921,12 +64921,12 @@ enable/disable as flags. introspectable="0"> Allocate #AgsFxLv2AudioScopeData-struct + line="961">Allocate #AgsFxLv2AudioScopeData-struct the new #AgsFxLv2AudioScopeData-struct + line="966">the new #AgsFxLv2AudioScopeData-struct @@ -65670,7 +65670,7 @@ enable/disable as flags. glib:get-type="ags_fx_notation_audio_processor_get_type" glib:type-struct="FxNotationAudioProcessorClass"> + line="114"/> @@ -65680,13 +65680,13 @@ enable/disable as flags. version="3.3.0"> Create a new instance of #AgsFxNotationAudioProcessor + line="2618">Create a new instance of #AgsFxNotationAudioProcessor + line="138"/> the new #AgsFxNotationAudioProcessor + line="2624">the new #AgsFxNotationAudioProcessor @@ -65694,14 +65694,14 @@ enable/disable as flags. the #AgsAudio + line="2620">the #AgsAudio + line="113"/> @@ -65715,7 +65715,7 @@ enable/disable as flags. + line="111"/> @@ -65729,7 +65729,7 @@ enable/disable as flags. + line="100"/> @@ -65752,7 +65752,7 @@ enable/disable as flags. + line="96"/> @@ -65775,7 +65775,7 @@ enable/disable as flags. + line="104"/> @@ -65798,7 +65798,7 @@ enable/disable as flags. + line="109"/> @@ -65812,7 +65812,7 @@ enable/disable as flags. + line="110"/> @@ -65827,7 +65827,7 @@ enable/disable as flags. + line="135"/> @@ -65841,7 +65841,7 @@ enable/disable as flags. + line="133"/> @@ -65856,7 +65856,7 @@ enable/disable as flags. + line="122"/> @@ -65880,7 +65880,7 @@ enable/disable as flags. + line="118"/> @@ -65904,7 +65904,7 @@ enable/disable as flags. + line="126"/> @@ -65927,7 +65927,7 @@ enable/disable as flags. + line="131"/> @@ -65942,7 +65942,7 @@ enable/disable as flags. + line="132"/> @@ -66024,19 +66024,22 @@ enable/disable as flags. + + + + line="114"/> + line="96"/> @@ -66061,7 +66064,7 @@ enable/disable as flags. + line="100"/> @@ -66086,7 +66089,7 @@ enable/disable as flags. + line="104"/> @@ -66111,7 +66114,7 @@ enable/disable as flags. + line="109"/> @@ -66127,7 +66130,7 @@ enable/disable as flags. + line="110"/> @@ -66143,7 +66146,7 @@ enable/disable as flags. + line="111"/> @@ -66159,7 +66162,7 @@ enable/disable as flags. + line="113"/> @@ -66205,13 +66208,13 @@ enable/disable as flags. version="3.3.0"> Create a new instance of #AgsFxNotationAudioSignal + line="696">Create a new instance of #AgsFxNotationAudioSignal the new #AgsFxNotationAudioSignal + line="702">the new #AgsFxNotationAudioSignal @@ -66219,7 +66222,7 @@ enable/disable as flags. the #AgsAudioSignal + line="698">the #AgsAudioSignal @@ -66786,13 +66789,13 @@ enable/disable as flags. version="3.3.0"> Create a new instance of #AgsFxPatternAudioProcessor + line="1479">Create a new instance of #AgsFxPatternAudioProcessor the new #AgsFxPatternAudioProcessor + line="1485">the new #AgsFxPatternAudioProcessor @@ -66800,7 +66803,7 @@ enable/disable as flags. the #AgsAudio + line="1481">the #AgsAudio @@ -74127,13 +74130,13 @@ enable/disable as flags. version="3.6.0"> Creates a new instance of #AgsGstreamerDevin. + line="3713">Creates a new instance of #AgsGstreamerDevin. the new #AgsGstreamerDevin + line="3718">the new #AgsGstreamerDevin @@ -74148,7 +74151,7 @@ enable/disable as flags. version="3.6.0"> Calculate delay and attack and reset it. + line="3481">Calculate delay and attack and reset it. @@ -74158,7 +74161,7 @@ enable/disable as flags. the #AgsGstreamerDevin + line="3483">the #AgsGstreamerDevin @@ -74168,7 +74171,7 @@ enable/disable as flags. version="3.6.0"> Reallocate the internal audio buffer. + line="3499">Reallocate the internal audio buffer. @@ -74178,7 +74181,7 @@ enable/disable as flags. the #AgsGstreamerDevin + line="3501">the #AgsGstreamerDevin @@ -74214,7 +74217,7 @@ enable/disable as flags. version="3.6.0"> The buffer flag indicates the currently played buffer. + line="3437">The buffer flag indicates the currently played buffer. @@ -74224,7 +74227,7 @@ enable/disable as flags. an #AgsGstreamerDevin + line="3439">an #AgsGstreamerDevin @@ -74744,13 +74747,13 @@ enable/disable as flags. version="3.6.0"> Creates a new instance of #AgsGstreamerDevout. + line="3873">Creates a new instance of #AgsGstreamerDevout. the new #AgsGstreamerDevout + line="3878">the new #AgsGstreamerDevout @@ -74765,7 +74768,7 @@ enable/disable as flags. version="3.6.0"> Calculate delay and attack and reset it. + line="3638">Calculate delay and attack and reset it. @@ -74776,7 +74779,7 @@ enable/disable as flags. transfer-ownership="none"> the #AgsGstreamerDevout + line="3640">the #AgsGstreamerDevout @@ -74786,7 +74789,7 @@ enable/disable as flags. version="3.6.0"> Reallocate the internal audio buffer. + line="3656">Reallocate the internal audio buffer. @@ -74797,7 +74800,7 @@ enable/disable as flags. transfer-ownership="none"> the #AgsGstreamerDevout + line="3658">the #AgsGstreamerDevout @@ -74835,7 +74838,7 @@ enable/disable as flags. version="3.6.0"> The buffer flag indicates the currently played buffer. + line="3594">The buffer flag indicates the currently played buffer. @@ -74846,7 +74849,7 @@ enable/disable as flags. transfer-ownership="none"> an #AgsGstreamerDevout + line="3596">an #AgsGstreamerDevout @@ -83569,7 +83572,7 @@ enable/disable as flags. - + @@ -83668,7 +83671,7 @@ enable/disable as flags. - + @@ -86941,12 +86944,12 @@ enable/disable as flags. version="3.0.0"> Creates a new instance of #AgsJackDevin. + line="3609">Creates a new instance of #AgsJackDevin. the new #AgsJackDevin + line="3614">the new #AgsJackDevin @@ -86960,7 +86963,7 @@ enable/disable as flags. version="3.0.0"> Calculate delay and attack and reset it. + line="3403">Calculate delay and attack and reset it. @@ -86969,7 +86972,7 @@ enable/disable as flags. the #AgsJackDevin + line="3405">the #AgsJackDevin @@ -86979,7 +86982,7 @@ enable/disable as flags. version="3.0.0"> Reallocate the internal audio buffer. + line="3421">Reallocate the internal audio buffer. @@ -86988,7 +86991,7 @@ enable/disable as flags. the #AgsJackDevin + line="3423">the #AgsJackDevin @@ -87023,7 +87026,7 @@ enable/disable as flags. version="3.0.0"> The buffer flag indicates the currently played buffer. + line="3367">The buffer flag indicates the currently played buffer. @@ -87032,7 +87035,7 @@ enable/disable as flags. an #AgsJackDevin + line="3369">an #AgsJackDevin @@ -87508,12 +87511,12 @@ enable/disable as flags. version="3.0.0"> Creates a new instance of #AgsJackDevout. + line="3782">Creates a new instance of #AgsJackDevout. the new #AgsJackDevout + line="3787">the new #AgsJackDevout @@ -87527,7 +87530,7 @@ enable/disable as flags. version="3.0.0"> Calculate delay and attack and reset it. + line="3573">Calculate delay and attack and reset it. @@ -87536,7 +87539,7 @@ enable/disable as flags. the #AgsJackDevout + line="3575">the #AgsJackDevout @@ -87546,7 +87549,7 @@ enable/disable as flags. version="3.0.0"> Reallocate the internal audio buffer. + line="3591">Reallocate the internal audio buffer. @@ -87555,7 +87558,7 @@ enable/disable as flags. the #AgsJackDevout + line="3593">the #AgsJackDevout @@ -87590,7 +87593,7 @@ enable/disable as flags. version="3.0.0"> The buffer flag indicates the currently played buffer. + line="3537">The buffer flag indicates the currently played buffer. @@ -87599,7 +87602,7 @@ enable/disable as flags. an #AgsJackDevout + line="3539">an #AgsJackDevout @@ -108425,25 +108428,25 @@ enable/disable as flags. version="3.0.0"> Parse change channel pressure. + line="2071">Parse change channel pressure. the xmlNode containing parsed data + line="2078">the xmlNode containing parsed data the #AgsMidiParser + line="2073">the #AgsMidiParser the status byte + line="2074">the status byte @@ -108453,25 +108456,25 @@ enable/disable as flags. version="3.0.0"> Parse change parameter. + line="1888">Parse change parameter. the xmlNode containing parsed data + line="1895">the xmlNode containing parsed data the #AgsMidiParser + line="1890">the #AgsMidiParser the status byte + line="1891">the status byte @@ -108481,25 +108484,25 @@ enable/disable as flags. version="3.0.0"> Parse change pitch bend. + line="1952">Parse change pitch bend. the xmlNode containing parsed data + line="1959">the xmlNode containing parsed data the #AgsMidiParser + line="1954">the #AgsMidiParser the status byte + line="1955">the status byte @@ -108509,25 +108512,25 @@ enable/disable as flags. version="3.0.0"> Parse change program. + line="2011">Parse change program. the xmlNode containing parsed data + line="2018">the xmlNode containing parsed data the #AgsMidiParser + line="2013">the #AgsMidiParser the status byte + line="2014">the status byte @@ -108537,25 +108540,25 @@ enable/disable as flags. version="3.0.0"> Parse end of track. + line="2489">Parse end of track. the xmlNode containing parsed data + line="2496">the xmlNode containing parsed data the #AgsMidiParser + line="2491">the #AgsMidiParser the meta type byte + line="2492">the meta type byte @@ -108563,25 +108566,25 @@ enable/disable as flags. Parse key off. + line="1677">Parse key off. the xmlNode containing parsed data + line="1684">the xmlNode containing parsed data the #AgsMidiParser + line="1679">the #AgsMidiParser the status byte + line="1680">the status byte @@ -108589,25 +108592,25 @@ enable/disable as flags. Parse key on. + line="1612">Parse key on. the xmlNode containing parsed data + line="1619">the xmlNode containing parsed data the #AgsMidiParser + line="1614">the #AgsMidiParser the status byte + line="1615">the status byte @@ -108617,25 +108620,25 @@ enable/disable as flags. version="3.0.0"> Parse key pressure. + line="1741">Parse key pressure. the xmlNode containing parsed data + line="1748">the xmlNode containing parsed data the #AgsMidiParser + line="1743">the #AgsMidiParser the status byte + line="1744">the status byte @@ -108645,25 +108648,25 @@ enable/disable as flags. version="3.0.0"> Parse key signature. + line="2741">Parse key signature. the xmlNode containing parsed data + line="2748">the xmlNode containing parsed data the #AgsMidiParser + line="2743">the #AgsMidiParser the meta type byte + line="2744">the meta type byte @@ -108671,25 +108674,25 @@ enable/disable as flags. Parse meta event. + line="2384">Parse meta event. the xmlNode containing parsed data + line="2391">the xmlNode containing parsed data the #AgsMidiParser + line="2386">the #AgsMidiParser the status byte + line="2387">the status byte @@ -108697,19 +108700,19 @@ enable/disable as flags. Read one byte. + line="1063">Read one byte. the byte read + line="1069">the byte read the #AgsMidiParser + line="1065">the #AgsMidiParser @@ -108717,25 +108720,25 @@ enable/disable as flags. Parse not defined. + line="2109">Parse not defined. the xmlNode containing parsed data + line="2116">the xmlNode containing parsed data the #AgsMidiParser + line="2111">the #AgsMidiParser the status byte + line="2112">the status byte @@ -108746,7 +108749,7 @@ enable/disable as flags. throws="1"> Error reporting. + line="1096">Error reporting. @@ -108755,7 +108758,7 @@ enable/disable as flags. the #AgsMidiParser + line="1098">the #AgsMidiParser @@ -108782,19 +108785,19 @@ enable/disable as flags. Parse all data of #AgsMidiParser:file. + line="1175">Parse all data of #AgsMidiParser:file. the xmlDoc representing your MIDI file + line="1181">the xmlDoc representing your MIDI file the #AgsMidiParser + line="1177">the #AgsMidiParser @@ -108804,19 +108807,19 @@ enable/disable as flags. version="3.0.0"> Parse MIDI header + line="1294">Parse MIDI header the xmlNode containing parsed data + line="1300">the xmlNode containing parsed data the #AgsMidiParser + line="1296">the #AgsMidiParser @@ -108824,19 +108827,19 @@ enable/disable as flags. Parse MIDI track. + line="1457">Parse MIDI track. the xmlNode containing parsed data + line="1463">the xmlNode containing parsed data the #AgsMidiParser + line="1459">the #AgsMidiParser @@ -108846,25 +108849,25 @@ enable/disable as flags. version="3.0.0"> Parse sequence number. + line="2438">Parse sequence number. the xmlNode containing parsed data + line="2445">the xmlNode containing parsed data the #AgsMidiParser + line="2440">the #AgsMidiParser the meta type byte + line="2441">the meta type byte @@ -108888,25 +108891,25 @@ enable/disable as flags. Parse smtpe. + line="2559">Parse smtpe. the xmlNode containing parsed data + line="2566">the xmlNode containing parsed data the #AgsMidiParser + line="2561">the #AgsMidiParser the meta type byte + line="2562">the meta type byte @@ -108914,25 +108917,25 @@ enable/disable as flags. Parse sysex. + line="2153">Parse sysex. the xmlNode containing parsed data + line="2160">the xmlNode containing parsed data the #AgsMidiParser + line="2155">the #AgsMidiParser the status byte + line="2156">the status byte @@ -108942,25 +108945,25 @@ enable/disable as flags. version="3.0.0"> Parse system common. + line="2260">Parse system common. the xmlNode containing parsed data + line="2267">the xmlNode containing parsed data the #AgsMidiParser + line="2262">the #AgsMidiParser the status byte + line="2263">the status byte @@ -108968,25 +108971,25 @@ enable/disable as flags. Parse tempo. + line="2617">Parse tempo. the xmlNode containing parsed data + line="2624">the xmlNode containing parsed data the #AgsMidiParser + line="2619">the #AgsMidiParser the meta type byte + line="2620">the meta type byte @@ -109022,25 +109025,25 @@ enable/disable as flags. version="3.0.0"> Parse time signature. + line="2683">Parse time signature. the xmlNode containing parsed data + line="2690">the xmlNode containing parsed data the #AgsMidiParser + line="2685">the #AgsMidiParser the meta type byte + line="2686">the meta type byte @@ -109050,25 +109053,25 @@ enable/disable as flags. version="3.0.0"> Parse change channel pressure. + line="2071">Parse change channel pressure. the xmlNode containing parsed data + line="2078">the xmlNode containing parsed data the #AgsMidiParser + line="2073">the #AgsMidiParser the status byte + line="2074">the status byte @@ -109078,25 +109081,25 @@ enable/disable as flags. version="3.0.0"> Parse change parameter. + line="1888">Parse change parameter. the xmlNode containing parsed data + line="1895">the xmlNode containing parsed data the #AgsMidiParser + line="1890">the #AgsMidiParser the status byte + line="1891">the status byte @@ -109106,25 +109109,25 @@ enable/disable as flags. version="3.0.0"> Parse change pitch bend. + line="1952">Parse change pitch bend. the xmlNode containing parsed data + line="1959">the xmlNode containing parsed data the #AgsMidiParser + line="1954">the #AgsMidiParser the status byte + line="1955">the status byte @@ -109134,25 +109137,25 @@ enable/disable as flags. version="3.0.0"> Parse change program. + line="2011">Parse change program. the xmlNode containing parsed data + line="2018">the xmlNode containing parsed data the #AgsMidiParser + line="2013">the #AgsMidiParser the status byte + line="2014">the status byte @@ -109162,25 +109165,25 @@ enable/disable as flags. version="3.0.0"> Parse channel message. + line="1483">Parse channel message. the xmlNode containing parsed data + line="1490">the xmlNode containing parsed data the #AgsMidiParser + line="1485">the #AgsMidiParser the status byte + line="1486">the status byte @@ -109190,25 +109193,25 @@ enable/disable as flags. version="3.0.0"> Parse end of track. + line="2489">Parse end of track. the xmlNode containing parsed data + line="2496">the xmlNode containing parsed data the #AgsMidiParser + line="2491">the #AgsMidiParser the meta type byte + line="2492">the meta type byte @@ -109218,25 +109221,25 @@ enable/disable as flags. version="3.0.0"> Parse key off. + line="1677">Parse key off. the xmlNode containing parsed data + line="1684">the xmlNode containing parsed data the #AgsMidiParser + line="1679">the #AgsMidiParser the status byte + line="1680">the status byte @@ -109246,25 +109249,25 @@ enable/disable as flags. version="3.0.0"> Parse key on. + line="1612">Parse key on. the xmlNode containing parsed data + line="1619">the xmlNode containing parsed data the #AgsMidiParser + line="1614">the #AgsMidiParser the status byte + line="1615">the status byte @@ -109274,25 +109277,25 @@ enable/disable as flags. version="3.0.0"> Parse key pressure. + line="1741">Parse key pressure. the xmlNode containing parsed data + line="1748">the xmlNode containing parsed data the #AgsMidiParser + line="1743">the #AgsMidiParser the status byte + line="1744">the status byte @@ -109302,25 +109305,25 @@ enable/disable as flags. version="3.0.0"> Parse key signature. + line="2741">Parse key signature. the xmlNode containing parsed data + line="2748">the xmlNode containing parsed data the #AgsMidiParser + line="2743">the #AgsMidiParser the meta type byte + line="2744">the meta type byte @@ -109330,25 +109333,25 @@ enable/disable as flags. version="3.0.0"> Parse meta event. + line="2384">Parse meta event. the xmlNode containing parsed data + line="2391">the xmlNode containing parsed data the #AgsMidiParser + line="2386">the #AgsMidiParser the status byte + line="2387">the status byte @@ -109374,19 +109377,19 @@ enable/disable as flags. version="3.0.0"> Read one byte. + line="1063">Read one byte. the byte read + line="1069">the byte read the #AgsMidiParser + line="1065">the #AgsMidiParser @@ -109396,25 +109399,25 @@ enable/disable as flags. version="3.0.0"> Parse not defined. + line="2109">Parse not defined. the xmlNode containing parsed data + line="2116">the xmlNode containing parsed data the #AgsMidiParser + line="2111">the #AgsMidiParser the status byte + line="2112">the status byte @@ -109425,7 +109428,7 @@ enable/disable as flags. throws="1"> Error reporting. + line="1096">Error reporting. @@ -109434,7 +109437,7 @@ enable/disable as flags. the #AgsMidiParser + line="1098">the #AgsMidiParser @@ -109488,19 +109491,19 @@ enable/disable as flags. version="3.0.0"> Parse all data of #AgsMidiParser:file. + line="1175">Parse all data of #AgsMidiParser:file. the xmlDoc representing your MIDI file + line="1181">the xmlDoc representing your MIDI file the #AgsMidiParser + line="1177">the #AgsMidiParser @@ -109510,19 +109513,19 @@ enable/disable as flags. version="3.0.0"> Parse MIDI header + line="1294">Parse MIDI header the xmlNode containing parsed data + line="1300">the xmlNode containing parsed data the #AgsMidiParser + line="1296">the #AgsMidiParser @@ -109532,19 +109535,19 @@ enable/disable as flags. version="3.0.0"> Parse MIDI track. + line="1457">Parse MIDI track. the xmlNode containing parsed data + line="1463">the xmlNode containing parsed data the #AgsMidiParser + line="1459">the #AgsMidiParser @@ -109670,25 +109673,25 @@ enable/disable as flags. version="3.0.0"> Parse sequence number. + line="2438">Parse sequence number. the xmlNode containing parsed data + line="2445">the xmlNode containing parsed data the #AgsMidiParser + line="2440">the #AgsMidiParser the meta type byte + line="2441">the meta type byte @@ -109764,25 +109767,25 @@ enable/disable as flags. version="3.0.0"> Parse smtpe. + line="2559">Parse smtpe. the xmlNode containing parsed data + line="2566">the xmlNode containing parsed data the #AgsMidiParser + line="2561">the #AgsMidiParser the meta type byte + line="2562">the meta type byte @@ -109792,25 +109795,25 @@ enable/disable as flags. version="3.0.0"> Parse sysex. + line="2153">Parse sysex. the xmlNode containing parsed data + line="2160">the xmlNode containing parsed data the #AgsMidiParser + line="2155">the #AgsMidiParser the status byte + line="2156">the status byte @@ -109820,25 +109823,25 @@ enable/disable as flags. version="3.0.0"> Parse system common. + line="2260">Parse system common. the xmlNode containing parsed data + line="2267">the xmlNode containing parsed data the #AgsMidiParser + line="2262">the #AgsMidiParser the status byte + line="2263">the status byte @@ -109848,25 +109851,25 @@ enable/disable as flags. version="3.0.0"> Parse tempo. + line="2617">Parse tempo. the xmlNode containing parsed data + line="2624">the xmlNode containing parsed data the #AgsMidiParser + line="2619">the #AgsMidiParser the meta type byte + line="2620">the meta type byte @@ -109904,37 +109907,37 @@ enable/disable as flags. version="3.0.0"> Convert ticks to seconds. + line="1006">Convert ticks to seconds. the seconds read from ticks + line="1015">the seconds read from ticks the #AgsMidiParser + line="1008">the #AgsMidiParser the ticks count + line="1009">the ticks count the division + line="1010">the division the tempo + line="1011">the tempo @@ -109944,25 +109947,25 @@ enable/disable as flags. version="3.0.0"> Parse time signature. + line="2683">Parse time signature. the xmlNode containing parsed data + line="2690">the xmlNode containing parsed data the #AgsMidiParser + line="2685">the #AgsMidiParser the meta type byte + line="2686">the meta type byte @@ -110475,14 +110478,14 @@ enable/disable as flags. the byte read + line="1069">the byte read the #AgsMidiParser + line="1065">the #AgsMidiParser @@ -110498,7 +110501,7 @@ enable/disable as flags. the #AgsMidiParser + line="1098">the #AgsMidiParser @@ -110510,14 +110513,14 @@ enable/disable as flags. the xmlDoc representing your MIDI file + line="1181">the xmlDoc representing your MIDI file the #AgsMidiParser + line="1177">the #AgsMidiParser @@ -110548,14 +110551,14 @@ enable/disable as flags. the xmlNode containing parsed data + line="1300">the xmlNode containing parsed data the #AgsMidiParser + line="1296">the #AgsMidiParser @@ -110567,14 +110570,14 @@ enable/disable as flags. the xmlNode containing parsed data + line="1463">the xmlNode containing parsed data the #AgsMidiParser + line="1459">the #AgsMidiParser @@ -110586,20 +110589,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="1619">the xmlNode containing parsed data the #AgsMidiParser + line="1614">the #AgsMidiParser the status byte + line="1615">the status byte @@ -110611,20 +110614,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="1684">the xmlNode containing parsed data the #AgsMidiParser + line="1679">the #AgsMidiParser the status byte + line="1680">the status byte @@ -110636,20 +110639,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="1748">the xmlNode containing parsed data the #AgsMidiParser + line="1743">the #AgsMidiParser the status byte + line="1744">the status byte @@ -110661,20 +110664,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="1895">the xmlNode containing parsed data the #AgsMidiParser + line="1890">the #AgsMidiParser the status byte + line="1891">the status byte @@ -110686,20 +110689,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="1959">the xmlNode containing parsed data the #AgsMidiParser + line="1954">the #AgsMidiParser the status byte + line="1955">the status byte @@ -110711,20 +110714,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2018">the xmlNode containing parsed data the #AgsMidiParser + line="2013">the #AgsMidiParser the status byte + line="2014">the status byte @@ -110736,20 +110739,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2078">the xmlNode containing parsed data the #AgsMidiParser + line="2073">the #AgsMidiParser the status byte + line="2074">the status byte @@ -110761,20 +110764,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2116">the xmlNode containing parsed data the #AgsMidiParser + line="2111">the #AgsMidiParser the status byte + line="2112">the status byte @@ -110786,20 +110789,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2160">the xmlNode containing parsed data the #AgsMidiParser + line="2155">the #AgsMidiParser the status byte + line="2156">the status byte @@ -110811,20 +110814,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2267">the xmlNode containing parsed data the #AgsMidiParser + line="2262">the #AgsMidiParser the status byte + line="2263">the status byte @@ -110836,20 +110839,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2391">the xmlNode containing parsed data the #AgsMidiParser + line="2386">the #AgsMidiParser the status byte + line="2387">the status byte @@ -110861,20 +110864,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2445">the xmlNode containing parsed data the #AgsMidiParser + line="2440">the #AgsMidiParser the meta type byte + line="2441">the meta type byte @@ -110886,20 +110889,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2496">the xmlNode containing parsed data the #AgsMidiParser + line="2491">the #AgsMidiParser the meta type byte + line="2492">the meta type byte @@ -110911,20 +110914,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2566">the xmlNode containing parsed data the #AgsMidiParser + line="2561">the #AgsMidiParser the meta type byte + line="2562">the meta type byte @@ -110936,20 +110939,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2624">the xmlNode containing parsed data the #AgsMidiParser + line="2619">the #AgsMidiParser the meta type byte + line="2620">the meta type byte @@ -110961,20 +110964,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2690">the xmlNode containing parsed data the #AgsMidiParser + line="2685">the #AgsMidiParser the meta type byte + line="2686">the meta type byte @@ -110986,20 +110989,20 @@ enable/disable as flags. the xmlNode containing parsed data + line="2748">the xmlNode containing parsed data the #AgsMidiParser + line="2743">the #AgsMidiParser the meta type byte + line="2744">the meta type byte @@ -123000,6 +123003,9 @@ enable/disable as flags. + note 256th offset @@ -124478,25 +124484,25 @@ be %TRUE else it won't have any effect. Creates a new instance of #AgsNotation. - + line="3894">Creates a new instance of #AgsNotation. + the new #AgsNotation + line="3901">the new #AgsNotation the assigned #AgsAudio + line="3896">the assigned #AgsAudio the audio channel to apply + line="3897">the audio channel to apply @@ -124504,12 +124510,12 @@ be %TRUE else it won't have any effect. Add @new_notation sorted to @notation + line="1206">Add @new_notation sorted to @notation the new beginning of @notation + line="1213">the new beginning of @notation @@ -124518,7 +124524,7 @@ be %TRUE else it won't have any effect. the #GList-struct containing #AgsNotation + line="1208">the #GList-struct containing #AgsNotation @@ -124526,7 +124532,7 @@ be %TRUE else it won't have any effect. the #AgsNotation to add + line="1209">the #AgsNotation to add @@ -124577,8 +124583,8 @@ be %TRUE else it won't have any effect. version="3.14.10"> Clear all selection of @notation. - + line="2189">Clear all selection of @notation. + @@ -124586,7 +124592,7 @@ be %TRUE else it won't have any effect. the #GList-struct containing #AgsNotation + line="2191">the #GList-struct containing #AgsNotation @@ -124598,67 +124604,67 @@ be %TRUE else it won't have any effect. version="3.0.0"> Parse @raw_midi data and convert to #AgsNotation. - + line="3667">Parse @raw_midi data and convert to #AgsNotation. + the #AgsNotation + line="3681">the #AgsNotation the data array + line="3669">the data array numerator + line="3670">numerator denominator + line="3671">denominator clocks + line="3672">clocks beats + line="3673">beats tempo + line="3674">tempo the bpm to use + line="3675">the bpm to use the segmentation delay factor + line="3676">the segmentation delay factor the buffer length + line="3677">the buffer length @@ -124668,12 +124674,12 @@ be %TRUE else it won't have any effect. version="3.0.0"> Compare @a and @b. + line="867">Compare @a and @b. 0 if equal, -1 if smaller and 1 if bigger timestamp + line="874">0 if equal, -1 if smaller and 1 if bigger timestamp @@ -124683,7 +124689,7 @@ be %TRUE else it won't have any effect. allow-none="1"> the #AgsNotation + line="869">the #AgsNotation allow-none="1"> another #AgsNotation + line="870">another #AgsNotation @@ -124702,8 +124708,8 @@ be %TRUE else it won't have any effect. version="3.0.0"> Add all note to selection. - + line="2454">Add all note to selection. + @@ -124711,7 +124717,7 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="2456">the #AgsNotation @@ -124721,7 +124727,7 @@ be %TRUE else it won't have any effect. version="3.0.0"> Adds @note to @notation. + line="1253">Adds @note to @notation. @@ -124730,19 +124736,19 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="1255">the #AgsNotation the #AgsNote to add + line="1256">the #AgsNote to add if %TRUE add to selection, else to default notation + line="1257">if %TRUE add to selection, else to default notation @@ -124752,8 +124758,8 @@ be %TRUE else it won't have any effect. version="3.0.0"> Select notes at position. - + line="2207">Select notes at position. + @@ -124761,26 +124767,26 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="2209">the #AgsNotation x offset + line="2210">x offset y note tone + line="2211">y note tone if %TRUE selection is replaced + line="2212">if %TRUE selection is replaced @@ -124790,8 +124796,8 @@ be %TRUE else it won't have any effect. version="3.0.0"> Add note within region to selection. - + line="2319">Add note within region to selection. + @@ -124799,38 +124805,38 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="2321">the #AgsNotation x start offset + line="2322">x start offset y start tone + line="2323">y start tone x end offset + line="2324">x end offset y end tone + line="2325">y end tone if %TRUE selection is replaced + line="2326">if %TRUE selection is replaced @@ -124840,19 +124846,19 @@ be %TRUE else it won't have any effect. version="3.0.0"> Copy selection to clipboard. - + line="2491">Copy selection to clipboard. + the selection as XML. + line="2497">the selection as XML. the #AgsNotation + line="2493">the #AgsNotation @@ -124862,21 +124868,63 @@ be %TRUE else it won't have any effect. version="3.0.0"> Cut selection to clipboard. - + line="2625">Cut selection to clipboard. + the selection as xmlNode + line="2631">the selection as xmlNode the #AgsNotation + line="2627">the #AgsNotation + + + + + + Find all notes by range @x_256th_lower to @x_256th_upper. + + + the #GList-struct containing matching #AgsNote + + + + + + + the #AgsNotation + + offset lower + + + + offset upper + + + + if %TRUE selection is searched + + version="3.0.0"> Find all notes by offset @x. + line="1732">Find all notes by offset @x. the #GList-struct containing matching #AgsNote + line="1740">the #GList-struct containing matching #AgsNote @@ -124898,19 +124946,19 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="1734">the #AgsNotation offset + line="1735">offset if %TRUE selection is searched + line="1736">if %TRUE selection is searched @@ -124920,37 +124968,37 @@ be %TRUE else it won't have any effect. version="3.0.0"> Find note by offset and tone. + line="1562">Find note by offset and tone. the matching note. + line="1571">the matching note. the #AgsNotation + line="1564">the #AgsNotation offset + line="1565">offset note + line="1566">note if %TRUE selection is searched + line="1567">if %TRUE selection is searched @@ -124960,12 +125008,12 @@ be %TRUE else it won't have any effect. version="3.0.0"> Find note by offset and tone region. + line="1633">Find note by offset and tone region. the matching notes as #GList-struct + line="1644">the matching notes as #GList-struct @@ -124974,37 +125022,37 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="1635">the #AgsNotation start offset + line="1636">start offset start tone + line="1637">start tone end offset + line="1638">end offset end tone + line="1639">end tone if %TRUE selection is searched + line="1640">if %TRUE selection is searched @@ -125014,8 +125062,8 @@ be %TRUE else it won't have any effect. version="3.0.0"> Clear selection. - + line="2144">Clear selection. + @@ -125023,7 +125071,7 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="2146">the #AgsNotation @@ -125034,19 +125082,19 @@ be %TRUE else it won't have any effect. version="3.1.0"> Get audio. + line="911">Get audio. the #AgsAudio + line="917">the #AgsAudio the #AgsNotation + line="913">the #AgsNotation @@ -125057,19 +125105,19 @@ be %TRUE else it won't have any effect. version="3.1.0"> Gets audio channel. + line="958">Gets audio channel. the audio channel + line="964">the audio channel the #AgsNotation + line="960">the #AgsNotation @@ -125079,19 +125127,19 @@ be %TRUE else it won't have any effect. version="3.1.0"> Gets is minor. + line="1005">Gets is minor. is minor + line="1011">is minor the #AgsNotation + line="1007">the #AgsNotation @@ -125102,12 +125150,12 @@ be %TRUE else it won't have any effect. version="3.1.0"> Get note. + line="1146">Get note. the #GList-struct containig #AgsNote + line="1152">the #GList-struct containig #AgsNote @@ -125116,7 +125164,7 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="1148">the #AgsNotation @@ -125149,12 +125197,12 @@ be %TRUE else it won't have any effect. version="3.0.0"> Retrieve selection. + line="1463">Retrieve selection. the selection. + line="1469">the selection. @@ -125163,7 +125211,7 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="1465">the #AgsNotation @@ -125173,19 +125221,19 @@ be %TRUE else it won't have any effect. version="3.1.0"> Gets sharp flats. + line="1052">Gets sharp flats. the sharp flats + line="1058">the sharp flats the #AgsNotation + line="1054">the #AgsNotation @@ -125196,19 +125244,19 @@ be %TRUE else it won't have any effect. version="3.1.0"> Get timestamp. + line="1099">Get timestamp. the #AgsTimestamp + line="1105">the #AgsTimestamp the #AgsNotation + line="1101">the #AgsNotation @@ -125218,8 +125266,8 @@ be %TRUE else it won't have any effect. version="3.0.0"> Paste previously copied notes. - + line="3105">Paste previously copied notes. + @@ -125227,37 +125275,37 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="3107">the #AgsNotation the clipboard XML data + line="3108">the clipboard XML data if %TRUE @x_offset used as cursor + line="3109">if %TRUE @x_offset used as cursor region start cursor offset + line="3110">region start cursor offset if %TRUE @y_offset used as cursor + line="3111">if %TRUE @y_offset used as cursor region start cursor tone + line="3112">region start cursor tone @@ -125267,8 +125315,8 @@ be %TRUE else it won't have any effect. version="3.0.0"> Paste previously copied notes. - + line="3131">Paste previously copied notes. + @@ -125276,49 +125324,49 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="3133">the #AgsNotation the clipboard XML data + line="3134">the clipboard XML data if %TRUE @x_offset used as cursor + line="3135">if %TRUE @x_offset used as cursor region start cursor offset + line="3136">region start cursor offset if %TRUE @y_offset used as cursor + line="3137">if %TRUE @y_offset used as cursor region start cursor tone + line="3138">region start cursor tone only paste if channel matches + line="3139">only paste if channel matches only paste if current note doesn't exist + line="3140">only paste if current note doesn't exist @@ -125328,25 +125376,25 @@ be %TRUE else it won't have any effect. version="3.0.0"> Check selection for note. + line="1497">Check selection for note. %TRUE if selected otherwise %FALSE + line="1504">%TRUE if selected otherwise %FALSE the #AgsNotation + line="1499">the #AgsNotation the #AgsNote to check for + line="1500">the #AgsNote to check for @@ -125356,7 +125404,7 @@ be %TRUE else it won't have any effect. version="3.0.0"> Removes @note from @notation. + line="1331">Removes @note from @notation. @@ -125365,19 +125413,19 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="1333">the #AgsNotation the #AgsNote to remove + line="1334">the #AgsNote to remove if %TRUE remove from selection, else from default notation + line="1335">if %TRUE remove from selection, else from default notation @@ -125387,31 +125435,31 @@ be %TRUE else it won't have any effect. version="3.0.0"> Removes one #AgsNote of notation. + line="1378">Removes one #AgsNote of notation. %TRUE if successfully removed note. + line="1386">%TRUE if successfully removed note. the #AgsNotation + line="1380">the #AgsNotation offset + line="1381">offset note + line="1382">note @@ -125421,8 +125469,8 @@ be %TRUE else it won't have any effect. version="3.0.0"> Remove notes at position of selection. - + line="2274">Remove notes at position of selection. + @@ -125430,19 +125478,19 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="2276">the #AgsNotation x offset + line="2277">x offset y note tone + line="2278">y note tone @@ -125452,8 +125500,8 @@ be %TRUE else it won't have any effect. version="3.0.0"> Remove note within region of selection. - + line="2394">Remove note within region of selection. + @@ -125461,31 +125509,31 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="2396">the #AgsNotation x start offset + line="2397">x start offset y start tone + line="2398">y start tone x end offset + line="2399">x end offset y end tone + line="2400">y end tone @@ -125496,7 +125544,7 @@ be %TRUE else it won't have any effect. version="3.1.0"> Set audio. + line="937">Set audio. @@ -125505,13 +125553,13 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="939">the #AgsNotation the #AgsAudio + line="940">the #AgsAudio @@ -125522,7 +125570,7 @@ be %TRUE else it won't have any effect. version="3.1.0"> Sets audio channel. + line="984">Sets audio channel. @@ -125531,13 +125579,13 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="986">the #AgsNotation the audio channel + line="987">the audio channel @@ -125572,7 +125620,7 @@ be %TRUE else it won't have any effect. version="3.1.0"> Sets is minor. + line="1031">Sets is minor. @@ -125581,13 +125629,13 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="1033">the #AgsNotation is minor + line="1034">is minor @@ -125598,7 +125646,7 @@ be %TRUE else it won't have any effect. version="3.1.0"> Set note by replacing existing. + line="1172">Set note by replacing existing. @@ -125607,13 +125655,13 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="1174">the #AgsNotation the #GList-struct containing #AgsNote + line="1175">the #GList-struct containing #AgsNote @@ -125625,7 +125673,7 @@ be %TRUE else it won't have any effect. version="3.1.0"> Sets sharp flats. + line="1078">Sets sharp flats. @@ -125634,13 +125682,13 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="1080">the #AgsNotation the sharp flats + line="1081">the sharp flats @@ -125651,7 +125699,7 @@ be %TRUE else it won't have any effect. version="3.1.0"> Set timestamp. + line="1125">Set timestamp. @@ -125660,13 +125708,13 @@ be %TRUE else it won't have any effect. the #AgsNotation + line="1127">the #AgsNotation the #AgsTimestamp + line="1128">the #AgsTimestamp @@ -125704,67 +125752,67 @@ be %TRUE else it won't have any effect. version="3.0.0"> Convert @notation to raw-midi. - + line="3196">Convert @notation to raw-midi. + the raw-midi buffer + line="3210">the raw-midi buffer the #AgsNotation + line="3198">the #AgsNotation the source bpm + line="3199">the source bpm the source delay factor + line="3200">the source delay factor numerator + line="3201">numerator denominator + line="3202">denominator clocks + line="3203">clocks beats + line="3204">beats tempo + line="3205">tempo the return location of buffer length + line="3206">the return location of buffer length @@ -125928,12 +125976,12 @@ enable/disable as flags. Creates a new instance of #AgsNote + line="2501">Creates a new instance of #AgsNote the new #AgsNote + line="2506">the new #AgsNote @@ -125942,43 +125990,43 @@ enable/disable as flags. version="3.0.0"> Creates a new instance of #AgsNote + line="2521">Creates a new instance of #AgsNote the new #AgsNote + line="2531">the new #AgsNote x0 + line="2523">x0 x1 + line="2524">x1 y + line="2525">y delay + line="2526">delay attack + line="2527">attack @@ -125988,12 +126036,12 @@ enable/disable as flags. version="3.0.0"> Find next note having the same y offset. + line="1923">Find next note having the same y offset. the matching entry as #GList-struct if last entry's x offset smaller than @x0, else %NULL + line="1931">the matching entry as #GList-struct if last entry's x offset smaller than @x0, else %NULL @@ -126002,7 +126050,7 @@ enable/disable as flags. the #GList-struct containing #AgsNote + line="1925">the #GList-struct containing #AgsNote @@ -126010,13 +126058,13 @@ enable/disable as flags. x offset + line="1926">x offset y offset + line="1927">y offset @@ -126026,12 +126074,12 @@ enable/disable as flags. version="3.0.0"> Find prev note having the same y offset. + line="1862">Find prev note having the same y offset. the matching entry as #GList-struct if first entry's x offset bigger than @x0, else %NULL + line="1870">the matching entry as #GList-struct if first entry's x offset bigger than @x0, else %NULL @@ -126040,7 +126088,7 @@ enable/disable as flags. the #GList-struct containing #AgsNote + line="1864">the #GList-struct containing #AgsNote @@ -126048,13 +126096,13 @@ enable/disable as flags. x offset + line="1865">x offset y offset + line="1866">y offset @@ -126064,12 +126112,12 @@ enable/disable as flags. version="3.0.0"> Parse @raw_midi data and convert to #AgsNote. + line="2305">Parse @raw_midi data and convert to #AgsNote. a #GList-struct containing the notes + line="2314">a #GList-struct containing the notes @@ -126078,25 +126126,25 @@ enable/disable as flags. the data array + line="2307">the data array the bpm to use + line="2308">the bpm to use the segmentation delay factor + line="2309">the segmentation delay factor the length of the array + line="2310">the length of the array @@ -126106,12 +126154,12 @@ enable/disable as flags. version="3.0.0"> Parse @raw_midi data and convert to #AgsNote. + line="2332">Parse @raw_midi data and convert to #AgsNote. a #GList-struct containing the notes + line="2346">a #GList-struct containing the notes @@ -126120,55 +126168,55 @@ enable/disable as flags. the data array + line="2334">the data array numerator + line="2335">numerator denominator + line="2336">denominator clocks + line="2337">clocks beats + line="2338">beats tempo + line="2339">tempo the bpm to use + line="2340">the bpm to use the segmentation delay factor + line="2341">the segmentation delay factor the length of the array + line="2342">the length of the array @@ -126178,12 +126226,12 @@ enable/disable as flags. version="3.0.0"> Convert ALSA sequencer data @event to #AgsNote. + line="2366">Convert ALSA sequencer data @event to #AgsNote. a #GList-struct containing the notes + line="2375">a #GList-struct containing the notes @@ -126195,25 +126243,25 @@ enable/disable as flags. allow-none="1"> ALSA sequencer events as array + line="2368">ALSA sequencer events as array the bpm to use + line="2369">the bpm to use the segmentation delay factor + line="2370">the segmentation delay factor the arrays length + line="2371">the arrays length @@ -126223,12 +126271,12 @@ enable/disable as flags. version="3.0.0"> Parse @raw_midi data and convert to #AgsNote. + line="2393">Parse @raw_midi data and convert to #AgsNote. a #GList-struct containing the notes + line="2407">a #GList-struct containing the notes @@ -126240,55 +126288,55 @@ enable/disable as flags. allow-none="1"> the snd_seq_event_t struct array + line="2395">the snd_seq_event_t struct array numerator + line="2396">numerator denominator + line="2397">denominator clocks + line="2398">clocks beats + line="2399">beats tempo + line="2400">tempo the bpm to use + line="2401">the bpm to use the segmentation delay factor + line="2402">the segmentation delay factor the count snd_seq_event_t structs + line="2403">the count snd_seq_event_t structs @@ -126298,61 +126346,61 @@ enable/disable as flags. version="3.0.0"> Convert note length to SMF delta-time. + line="1984">Convert note length to SMF delta-time. the delta-time + line="1997">the delta-time the note length to convert + line="1986">the note length to convert the source bpm + line="1987">the source bpm the source delay factor + line="1988">the source delay factor numerator + line="1989">numerator denominator + line="1990">denominator clocks + line="1991">clocks beats + line="1992">beats tempo + line="1993">tempo @@ -126362,61 +126410,61 @@ enable/disable as flags. version="3.0.0"> Convert SMF delta-time to note length. + line="2012">Convert SMF delta-time to note length. the note length + line="2025">the note length delta-time + line="2014">delta-time numerator + line="2015">numerator denominator + line="2016">denominator clocks + line="2017">clocks beats + line="2018">beats tempo + line="2019">tempo the target bpm + line="2020">the target bpm the target delay factor + line="2021">the target delay factor @@ -126460,19 +126508,19 @@ enable/disable as flags. version="3.0.0"> Duplicate a note. + line="2427">Duplicate a note. the duplicated #AgsNote. + line="2433">the duplicated #AgsNote. the #AgsNote + line="2429">the #AgsNote @@ -126483,19 +126531,19 @@ enable/disable as flags. version="3.1.0"> Gets attack. + line="1486">Gets attack. the attack + line="1492">the attack the #AgsNote + line="1488">the #AgsNote @@ -126506,19 +126554,19 @@ enable/disable as flags. version="3.1.0"> Gets decay. + line="1580">Gets decay. the decay + line="1586">the decay the #AgsNote + line="1582">the #AgsNote @@ -126529,19 +126577,19 @@ enable/disable as flags. version="6.1.0"> Gets feed x as 256th. + line="1721">Gets feed x as 256th. the feed x as 256th + line="1727">the feed x as 256th the #AgsNote + line="1723">the #AgsNote @@ -126551,19 +126599,19 @@ enable/disable as flags. version="3.1.0"> Gets is minor. + line="1157">Gets is minor. is minor + line="1163">is minor the #AgsNote + line="1159">the #AgsNote @@ -126597,19 +126645,19 @@ enable/disable as flags. version="3.1.0"> Gets ratio. + line="1674">Gets ratio. the ratio + line="1680">the ratio the #AgsNote + line="1676">the #AgsNote @@ -126620,19 +126668,19 @@ enable/disable as flags. version="3.1.0"> Gets release. + line="1627">Gets release. the release + line="1633">the release the #AgsNote + line="1629">the #AgsNote @@ -126643,19 +126691,19 @@ enable/disable as flags. version="3.1.0"> Gets rt-attack. + line="1439">Gets rt-attack. the rt-attack + line="1445">the rt-attack the #AgsNote + line="1441">the #AgsNote @@ -126666,19 +126714,19 @@ enable/disable as flags. version="3.1.0"> Gets rt-offset. + line="1392">Gets rt-offset. the rt-offset + line="1398">the rt-offset the #AgsNote + line="1394">the #AgsNote @@ -126688,19 +126736,19 @@ enable/disable as flags. version="3.1.0"> Gets sharp flats. + line="1204">Gets sharp flats. the sharp flats + line="1210">the sharp flats the #AgsNote + line="1206">the #AgsNote @@ -126711,19 +126759,19 @@ enable/disable as flags. version="3.1.0"> Gets sustain. + line="1533">Gets sustain. the sustain + line="1539">the sustain the #AgsNote + line="1535">the #AgsNote @@ -126734,19 +126782,19 @@ enable/disable as flags. version="3.1.0"> Gets x0. + line="1251">Gets x0. the x0 + line="1257">the x0 the #AgsNote + line="1253">the #AgsNote @@ -126757,19 +126805,19 @@ enable/disable as flags. version="6.1.0"> Gets x0 as 256th. + line="1768">Gets x0 as 256th. the x0 as 256th + line="1774">the x0 as 256th the #AgsNote + line="1770">the #AgsNote @@ -126780,19 +126828,19 @@ enable/disable as flags. version="3.1.0"> Gets x1. + line="1298">Gets x1. the x1 + line="1304">the x1 the #AgsNote + line="1300">the #AgsNote @@ -126803,19 +126851,19 @@ enable/disable as flags. version="6.1.0"> Gets x1 as 256th. + line="1815">Gets x1 as 256th. the x1 as 256th + line="1821">the x1 as 256th the #AgsNote + line="1817">the #AgsNote @@ -126826,19 +126874,19 @@ enable/disable as flags. version="3.1.0"> Gets y. + line="1345">Gets y. the y + line="1351">the y the #AgsNote + line="1347">the #AgsNote @@ -126849,7 +126897,7 @@ enable/disable as flags. version="3.1.0"> Sets attack. + line="1512">Sets attack. @@ -126858,13 +126906,13 @@ enable/disable as flags. the #AgsNote + line="1514">the #AgsNote the attack + line="1515">the attack @@ -126875,7 +126923,7 @@ enable/disable as flags. version="3.1.0"> Sets decay. + line="1606">Sets decay. @@ -126884,13 +126932,13 @@ enable/disable as flags. the #AgsNote + line="1608">the #AgsNote the decay + line="1609">the decay @@ -126941,7 +126989,7 @@ enable/disable as flags. version="3.1.0"> Sets is minor. + line="1183">Sets is minor. @@ -126950,13 +126998,13 @@ enable/disable as flags. the #AgsNote + line="1185">the #AgsNote is minor + line="1186">is minor @@ -126992,7 +127040,7 @@ enable/disable as flags. version="3.1.0"> Sets ratio. + line="1700">Sets ratio. @@ -127001,13 +127049,13 @@ enable/disable as flags. the #AgsNote + line="1702">the #AgsNote the ratio + line="1703">the ratio @@ -127018,7 +127066,7 @@ enable/disable as flags. version="3.1.0"> Sets release. + line="1653">Sets release. @@ -127027,13 +127075,13 @@ enable/disable as flags. the #AgsNote + line="1655">the #AgsNote the release + line="1656">the release @@ -127044,7 +127092,7 @@ enable/disable as flags. version="3.1.0"> Sets rt-attack. + line="1465">Sets rt-attack. @@ -127053,13 +127101,13 @@ enable/disable as flags. the #AgsNote + line="1467">the #AgsNote the rt-attack + line="1468">the rt-attack @@ -127070,7 +127118,7 @@ enable/disable as flags. version="3.1.0"> Sets rt-offset. + line="1418">Sets rt-offset. @@ -127079,13 +127127,13 @@ enable/disable as flags. the #AgsNote + line="1420">the #AgsNote the rt-offset + line="1421">the rt-offset @@ -127095,7 +127143,7 @@ enable/disable as flags. version="3.1.0"> Sets sharp flats. + line="1230">Sets sharp flats. @@ -127104,13 +127152,13 @@ enable/disable as flags. the #AgsNote + line="1232">the #AgsNote the sharp flats + line="1233">the sharp flats @@ -127121,7 +127169,7 @@ enable/disable as flags. version="3.1.0"> Sets sustain. + line="1559">Sets sustain. @@ -127130,13 +127178,13 @@ enable/disable as flags. the #AgsNote + line="1561">the #AgsNote the sustain + line="1562">the sustain @@ -127144,10 +127192,10 @@ enable/disable as flags. + version="3.1.0"> Sets x0 as 256th. + line="1277">Sets x0. @@ -127156,26 +127204,39 @@ enable/disable as flags. the #AgsNote + line="1279">the #AgsNote + the x0 + glib:set-property="x0-256th" + version="6.1.0"> + Sets x0 as 256th. + the #AgsNote + the x0 as 256th @@ -127186,7 +127247,7 @@ enable/disable as flags. version="3.1.0"> Sets x1. + line="1324">Sets x1. @@ -127195,13 +127256,13 @@ enable/disable as flags. the #AgsNote + line="1326">the #AgsNote the x1 + line="1327">the x1 @@ -127212,7 +127273,7 @@ enable/disable as flags. version="6.1.0"> Sets x1 as 256th. + line="1841">Sets x1 as 256th. @@ -127221,13 +127282,13 @@ enable/disable as flags. the #AgsNote + line="1843">the #AgsNote the x1 as 256th + line="1844">the x1 as 256th @@ -127238,7 +127299,7 @@ enable/disable as flags. version="3.1.0"> Sets y. + line="1371">Sets y. @@ -127247,13 +127308,13 @@ enable/disable as flags. the #AgsNote + line="1373">the #AgsNote the y + line="1374">the y @@ -127319,38 +127380,38 @@ enable/disable as flags. version="3.0.0"> Convert @note to raw MIDI and set the buffer length of returned bytes + line="2040">Convert @note to raw MIDI and set the buffer length of returned bytes in the array as @buffer_length. The sequencer raw midi as array. + line="2050">The sequencer raw midi as array. the #AgsNote + line="2042">the #AgsNote the bpm to use + line="2043">the bpm to use the segmentation delay factor + line="2044">the segmentation delay factor the length of the returned buffer + line="2045">the length of the returned buffer @@ -127360,67 +127421,67 @@ in the array as @buffer_length. version="3.0.0"> Convert @note to raw-midi. + line="2213">Convert @note to raw-midi. the raw-midi buffer + line="2227">the raw-midi buffer the #AgsNote + line="2215">the #AgsNote the source bpm + line="2216">the source bpm the source delay factor + line="2217">the source delay factor numerator + line="2218">numerator denominator + line="2219">denominator clocks + line="2220">clocks beats + line="2221">beats tempo + line="2222">tempo the return location of buffer length + line="2223">the return location of buffer length @@ -127430,38 +127491,38 @@ in the array as @buffer_length. version="3.0.0"> Convert @note to ALSA sequencer events and set the number of events + line="2243">Convert @note to ALSA sequencer events and set the number of events in the array as @n_events. The sequencer events as array. + line="2253">The sequencer events as array. the #AgsNote + line="2245">the #AgsNote the bpm to use + line="2246">the bpm to use the segmentation delay factor + line="2247">the segmentation delay factor the count of events + line="2248">the count of events @@ -127471,67 +127532,67 @@ in the array as @n_events. version="3.0.0"> Convert @note to raw-midi. + line="2271">Convert @note to raw-midi. an array of snd_seq_event_t structs + line="2285">an array of snd_seq_event_t structs the #AgsNote + line="2273">the #AgsNote the source bpm + line="2274">the source bpm the source delay factor + line="2275">the source delay factor numerator + line="2276">numerator denominator + line="2277">denominator clocks + line="2278">clocks beats + line="2279">beats tempo + line="2280">tempo the return location of event count + line="2281">the return location of event count @@ -138905,12 +138966,12 @@ enable/disable as flags. version="3.13.2"> Creates a new instance of #AgsOssDevin. + line="3695">Creates a new instance of #AgsOssDevin. the new #AgsOssDevin + line="3700">the new #AgsOssDevin @@ -138924,7 +138985,7 @@ enable/disable as flags. version="3.13.2"> Calculate delay and attack and reset it. + line="3583">Calculate delay and attack and reset it. @@ -138933,7 +138994,7 @@ enable/disable as flags. the #AgsOssDevin + line="3585">the #AgsOssDevin @@ -138943,7 +139004,7 @@ enable/disable as flags. version="3.13.2"> Reallocate the internal audio buffer. + line="3601">Reallocate the internal audio buffer. @@ -138952,7 +139013,7 @@ enable/disable as flags. the #AgsOssDevin + line="3603">the #AgsOssDevin @@ -138987,7 +139048,7 @@ enable/disable as flags. version="3.13.2"> The buffer flag indicates the currently recorded buffer. + line="3551">The buffer flag indicates the currently recorded buffer. @@ -138996,7 +139057,7 @@ enable/disable as flags. the #AgsOssDevin + line="3553">the #AgsOssDevin @@ -139467,12 +139528,12 @@ enable/disable as flags. version="3.13.2"> Creates a new instance of #AgsOssDevout. + line="3926">Creates a new instance of #AgsOssDevout. the new #AgsOssDevout + line="3931">the new #AgsOssDevout @@ -139486,7 +139547,7 @@ enable/disable as flags. version="3.13.2"> Calculate delay and attack and reset it. + line="3814">Calculate delay and attack and reset it. @@ -139495,7 +139556,7 @@ enable/disable as flags. the #AgsOssDevout + line="3816">the #AgsOssDevout @@ -139505,7 +139566,7 @@ enable/disable as flags. version="3.13.2"> Reallocate the internal audio buffer. + line="3832">Reallocate the internal audio buffer. @@ -139514,7 +139575,7 @@ enable/disable as flags. the #AgsOssDevout + line="3834">the #AgsOssDevout @@ -139549,7 +139610,7 @@ enable/disable as flags. version="3.13.2"> The buffer flag indicates the currently played buffer. + line="3782">The buffer flag indicates the currently played buffer. @@ -139558,7 +139619,7 @@ enable/disable as flags. the #AgsOssDevout + line="3784">the #AgsOssDevout @@ -144871,12 +144932,12 @@ enable/disable as flags. Creates an #AgsPort. - + line="2013">Creates an #AgsPort. + a new #AgsPort. + line="2018">a new #AgsPort. @@ -144885,12 +144946,12 @@ enable/disable as flags. version="3.11.4"> Retrieve port by plugin port. - + line="1807">Retrieve port by plugin port. + Next matching #GList-struct or %NULL + line="1814">Next matching #GList-struct or %NULL @@ -144899,7 +144960,7 @@ enable/disable as flags. the #GList-struct containing #AgsPort + line="1809">the #GList-struct containing #AgsPort @@ -144907,7 +144968,7 @@ enable/disable as flags. the #AgsPluginPort + line="1810">the #AgsPluginPort @@ -144917,12 +144978,12 @@ enable/disable as flags. version="3.0.0"> Retrieve port by specifier. - + line="1761">Retrieve port by specifier. + Next matching #GList-struct or %NULL + line="1768">Next matching #GList-struct or %NULL @@ -144931,7 +144992,7 @@ enable/disable as flags. the #GList-struct containing #AgsPort + line="1763">the #GList-struct containing #AgsPort @@ -144939,7 +145000,7 @@ enable/disable as flags. the recall specifier to match + line="1764">the recall specifier to match @@ -144949,7 +145010,7 @@ enable/disable as flags. version="3.0.0"> Perform safe get property. + line="1701">Perform safe get property. @@ -144958,19 +145019,19 @@ enable/disable as flags. an #AgsPort + line="1703">an #AgsPort the property's name + line="1704">the property's name the #GValue to store the result + line="1705">the #GValue to store the result @@ -144978,7 +145039,7 @@ enable/disable as flags. Perform safe read. + line="1394">Perform safe read. @@ -144987,13 +145048,13 @@ enable/disable as flags. an #AgsPort + line="1396">an #AgsPort the #GValue to store result + line="1397">the #GValue to store result @@ -145003,7 +145064,7 @@ enable/disable as flags. version="3.0.0"> Perform safe set property. + line="1740">Perform safe set property. @@ -145012,19 +145073,19 @@ enable/disable as flags. an #AgsPort + line="1742">an #AgsPort the property's name + line="1743">the property's name the #GValue containing data + line="1744">the #GValue containing data @@ -145032,7 +145093,7 @@ enable/disable as flags. Perform safe write. + line="1594">Perform safe write. @@ -145041,13 +145102,13 @@ enable/disable as flags. an #AgsPort + line="1596">an #AgsPort the #GValue containing data + line="1597">the #GValue containing data @@ -145057,8 +145118,8 @@ enable/disable as flags. version="3.0.0"> Adds an automation. - + line="1934">Adds an automation. + @@ -145066,13 +145127,13 @@ enable/disable as flags. the #AgsPort + line="1936">the #AgsPort the #AgsAutomation + line="1937">the #AgsAutomation @@ -145083,12 +145144,12 @@ enable/disable as flags. version="5.4.0"> Get automation. - + line="1906">Get automation. + get automation #GList-struct + line="1912">get automation #GList-struct @@ -145097,7 +145158,7 @@ enable/disable as flags. the #AgsPort + line="1908">the #AgsPort @@ -145108,19 +145169,19 @@ enable/disable as flags. version="5.4.0"> Get channel type. - + line="1850">Get channel type. + get channel type + line="1856">get channel type the #AgsPort + line="1852">the #AgsPort @@ -145131,19 +145192,42 @@ enable/disable as flags. version="5.4.0"> Get line. - + line="1878">Get line. + get line + line="1884">get line the #AgsPort + line="1880">the #AgsPort + + + + + + Get the plugin port of @port. + + + the plugin port + + + + + the #AgsPort @@ -145153,8 +145237,8 @@ enable/disable as flags. version="3.0.0"> Removes an automation. - + line="1973">Removes an automation. + @@ -145162,13 +145246,13 @@ enable/disable as flags. the #AgsPort + line="1975">the #AgsPort the #AgsAutomation + line="1976">the #AgsAutomation @@ -145178,8 +145262,8 @@ enable/disable as flags. version="3.0.0"> Perform safe get property. - + line="1701">Perform safe get property. + @@ -145187,19 +145271,19 @@ enable/disable as flags. an #AgsPort + line="1703">an #AgsPort the property's name + line="1704">the property's name the #GValue to store the result + line="1705">the #GValue to store the result @@ -145209,8 +145293,8 @@ enable/disable as flags. version="3.0.0"> Perform safe read. - + line="1394">Perform safe read. + @@ -145218,13 +145302,13 @@ enable/disable as flags. an #AgsPort + line="1396">an #AgsPort the #GValue to store result + line="1397">the #GValue to store result @@ -145234,8 +145318,8 @@ enable/disable as flags. version="3.0.0"> Perform safe read. - + line="1414">Perform safe read. + @@ -145243,13 +145327,13 @@ enable/disable as flags. an #AgsPort + line="1416">an #AgsPort the #GValue to store result + line="1417">the #GValue to store result @@ -145259,8 +145343,8 @@ enable/disable as flags. version="3.0.0"> Perform safe set property. - + line="1740">Perform safe set property. + @@ -145268,19 +145352,19 @@ enable/disable as flags. an #AgsPort + line="1742">an #AgsPort the property's name + line="1743">the property's name the #GValue containing data + line="1744">the #GValue containing data @@ -145290,8 +145374,8 @@ enable/disable as flags. version="3.0.0"> Perform safe write. - + line="1594">Perform safe write. + @@ -145299,19 +145383,19 @@ enable/disable as flags. an #AgsPort + line="1596">an #AgsPort the #GValue containing data + line="1597">the #GValue containing data - + @@ -145349,6 +145433,32 @@ enable/disable as flags. + + Set the plugin port of @port. + + + + + + + the #AgsPort + + + + the #AgsPluginPort + + + + @@ -145542,7 +145652,9 @@ enable/disable as flags. + transfer-ownership="none" + setter="set_plugin_port" + getter="get_plugin_port"> The plugin-port. @@ -145759,13 +145871,13 @@ enable/disable as flags. an #AgsPort + line="1396">an #AgsPort the #GValue to store result + line="1397">the #GValue to store result @@ -145781,13 +145893,13 @@ enable/disable as flags. an #AgsPort + line="1596">an #AgsPort the #GValue containing data + line="1597">the #GValue containing data @@ -145803,19 +145915,19 @@ enable/disable as flags. an #AgsPort + line="1703">an #AgsPort the property's name + line="1704">the property's name the #GValue to store the result + line="1705">the #GValue to store the result @@ -145831,19 +145943,19 @@ enable/disable as flags. an #AgsPort + line="1742">an #AgsPort the property's name + line="1743">the property's name the #GValue containing data + line="1744">the #GValue containing data @@ -148669,12 +148781,12 @@ enable/disable as flags. version="3.0.0"> Creates a new instance of #AgsPulseDevin. + line="3508">Creates a new instance of #AgsPulseDevin. the new #AgsPulseDevin + line="3513">the new #AgsPulseDevin @@ -148688,7 +148800,7 @@ enable/disable as flags. version="3.0.0"> Calculate delay and attack and reset it. + line="3377">Calculate delay and attack and reset it. @@ -148697,7 +148809,7 @@ enable/disable as flags. the #AgsPulseDevin + line="3379">the #AgsPulseDevin @@ -148707,7 +148819,7 @@ enable/disable as flags. version="3.0.0"> Reallocate the internal audio buffer. + line="3395">Reallocate the internal audio buffer. @@ -148716,7 +148828,7 @@ enable/disable as flags. the #AgsPulseDevin + line="3397">the #AgsPulseDevin @@ -148751,7 +148863,7 @@ enable/disable as flags. version="3.0.0"> The buffer flag indicates the currently played buffer. + line="3333">The buffer flag indicates the currently played buffer. @@ -148760,7 +148872,7 @@ enable/disable as flags. an #AgsPulseDevin + line="3335">an #AgsPulseDevin @@ -149259,12 +149371,12 @@ enable/disable as flags. version="3.0.0"> Creates a new instance of #AgsPulseDevout. + line="4041">Creates a new instance of #AgsPulseDevout. the new #AgsPulseDevout + line="4046">the new #AgsPulseDevout @@ -149278,7 +149390,7 @@ enable/disable as flags. version="3.0.0"> Calculate delay and attack and reset it. + line="3910">Calculate delay and attack and reset it. @@ -149287,7 +149399,7 @@ enable/disable as flags. the #AgsPulseDevout + line="3912">the #AgsPulseDevout @@ -149297,7 +149409,7 @@ enable/disable as flags. version="3.0.0"> Reallocate the internal audio buffer. + line="3928">Reallocate the internal audio buffer. @@ -149306,7 +149418,7 @@ enable/disable as flags. the #AgsPulseDevout + line="3930">the #AgsPulseDevout @@ -149341,7 +149453,7 @@ enable/disable as flags. version="3.0.0"> The buffer flag indicates the currently played buffer. + line="3866">The buffer flag indicates the currently played buffer. @@ -149350,7 +149462,7 @@ enable/disable as flags. an #AgsPulseDevout + line="3868">an #AgsPulseDevout @@ -149848,19 +149960,19 @@ enable/disable as flags. version="3.0.0"> Create a new instance of #AgsPulsePort. + line="2341">Create a new instance of #AgsPulsePort. the new #AgsPulsePort + line="2347">the new #AgsPulsePort the #AgsPulseClient assigned to + line="2343">the #AgsPulseClient assigned to @@ -149868,12 +149980,12 @@ enable/disable as flags. Finds next match of @port_name in @pulse_port. + line="984">Finds next match of @port_name in @pulse_port. the next matching #GList-struct or %NULL + line="991">the next matching #GList-struct or %NULL @@ -149882,7 +149994,7 @@ enable/disable as flags. the #GList-struct containig #AgsPulsePort + line="986">the #GList-struct containig #AgsPulsePort @@ -149890,7 +150002,7 @@ enable/disable as flags. the port name to find + line="987">the port name to find @@ -149912,7 +150024,7 @@ enable/disable as flags. version="3.0.0"> Gets latency. + line="2305">Gets latency. @@ -149921,7 +150033,7 @@ enable/disable as flags. the #AgsPulsePort + line="2307">the #AgsPulsePort @@ -149931,7 +150043,7 @@ enable/disable as flags. version="3.0.0"> Register a new pulseaudio port and read uuid. Creates a new AgsSequencer or AgsSoundcard + line="1023">Register a new pulseaudio port and read uuid. Creates a new AgsSequencer or AgsSoundcard object. @@ -149941,31 +150053,31 @@ object. the #AgsPulsePort + line="1025">the #AgsPulsePort the name as string + line="1026">the name as string if %TRUE interpreted as audio port + line="1027">if %TRUE interpreted as audio port if %TRUE interpreted as midi port + line="1028">if %TRUE interpreted as midi port if %TRUE port is acting as output, otherwise as input + line="1029">if %TRUE port is acting as output, otherwise as input @@ -150005,7 +150117,7 @@ object. version="3.0.0"> Enable a feature of @pulse_port. + line="922">Enable a feature of @pulse_port. @@ -150014,13 +150126,13 @@ object. the #AgsPulsePort + line="924">the #AgsPulsePort see #AgsPulsePortFlags-enum + line="925">see #AgsPulsePortFlags-enum @@ -150074,25 +150186,25 @@ object. version="3.0.0"> Test @flags to be set on @pulse_port. + line="887">Test @flags to be set on @pulse_port. %TRUE if flags are set, else %FALSE + line="894">%TRUE if flags are set, else %FALSE the #AgsPulsePort + line="889">the #AgsPulsePort the flags + line="890">the flags @@ -150113,7 +150225,7 @@ object. version="3.0.0"> Disable a feature of @pulse_port. + line="953">Disable a feature of @pulse_port. @@ -150122,13 +150234,13 @@ object. the #AgsPulsePort + line="955">the #AgsPulsePort see #AgsPulsePortFlags-enum + line="956">see #AgsPulsePortFlags-enum @@ -150647,7 +150759,7 @@ enable/disable as flags. - + @@ -150791,7 +150903,7 @@ enable/disable as flags. - + @@ -150834,15 +150946,15 @@ enable/disable as flags. - + - + - + @@ -150893,7 +151005,7 @@ enable/disable as flags. - + @@ -150902,7 +151014,7 @@ enable/disable as flags. - + @@ -151308,17 +151420,17 @@ enable/disable as flags. glib:type-name="AgsRecall" glib:get-type="ags_recall_get_type" glib:type-struct="RecallClass"> - + Instantiate #AgsRecall. - + line="7666">Instantiate #AgsRecall. + the new instance of #AgsRecall. + line="7671">the new instance of #AgsRecall. @@ -151327,14 +151439,14 @@ enable/disable as flags. version="3.0.0"> Finds next matching recall for type which has @provider. The @provider may be either an #AgsChannel + line="7296">Finds next matching recall for type which has @provider. The @provider may be either an #AgsChannel or an #AgsAudio object. This function tries to find the corresponding #AgsRecallChannel and #AgsRecallAudio objects of a #AgsRecall to find. If these recalls contains the @provider, the function will return. - + next matching #GList-struct, or %NULL if not found + line="7305">next matching #GList-struct, or %NULL if not found @@ -151343,7 +151455,7 @@ objects of a #AgsRecall to find. If these recalls contains the @provider, the fu the #GList-struct containing #AgsRecall + line="7298">the #GList-struct containing #AgsRecall @@ -151351,7 +151463,7 @@ objects of a #AgsRecall to find. If these recalls contains the @provider, the fu the #GObject, either #AgsAudio, #AgsChannel, #AgsRecycling or #AgsAudioSignal + line="7299">the #GObject, either #AgsAudio, #AgsChannel, #AgsRecycling or #AgsAudioSignal @@ -151361,12 +151473,12 @@ objects of a #AgsRecall to find. If these recalls contains the @provider, the fu version="3.0.0"> Like ags_recall_template_find_provider() but given additionally @recycling_context as search parameter. - + line="7469">Like ags_recall_template_find_provider() but given additionally @recycling_context as search parameter. + next matching #GList-struct, or %NULL if not found + line="7477">next matching #GList-struct, or %NULL if not found @@ -151375,7 +151487,7 @@ objects of a #AgsRecall to find. If these recalls contains the @provider, the fu the #GList-struct containing #AgsRecall + line="7471">the #GList-struct containing #AgsRecall @@ -151383,13 +151495,13 @@ objects of a #AgsRecall to find. If these recalls contains the @provider, the fu the #GObject as provider + line="7472">the #GObject as provider the #AgsRecyclingContext + line="7473">the #AgsRecyclingContext @@ -151399,13 +151511,13 @@ objects of a #AgsRecall to find. If these recalls contains the @provider, the fu version="3.0.0"> Finds next matching effect name. Intended to be used as + line="6853">Finds next matching effect name. Intended to be used as iteration function. - + next matching #GList-struct, or %NULL if not found + line="6863">next matching #GList-struct, or %NULL if not found @@ -151414,7 +151526,7 @@ iteration function. the #GList-struct containing #AgsRecall + line="6855">the #GList-struct containing #AgsRecall @@ -151422,19 +151534,19 @@ iteration function. the #AgsRecallID, may be %NULL + line="6856">the #AgsRecallID, may be %NULL the filename or %NULL + line="6857">the filename or %NULL the effect name + line="6858">the effect name @@ -151444,13 +151556,13 @@ iteration function. version="3.0.0"> Finds next matching recall which has @recycling_context, see #AgsRecallId for further + line="7239">Finds next matching recall which has @recycling_context, see #AgsRecallId for further details about #AgsRecyclingContext. Intended to be used as iteration function. - + next matching #GList-struct, or %NULL if not found + line="7247">next matching #GList-struct, or %NULL if not found @@ -151459,7 +151571,7 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. the #GList-struct containing #AgsRecall + line="7241">the #GList-struct containing #AgsRecall @@ -151467,7 +151579,7 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. the #AgsRecyclingContext + line="7242">the #AgsRecyclingContext @@ -151477,13 +151589,13 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. Finds next template, see #AGS_RECALL_TEMPLATE flag. Intended to be used as + line="7006">Finds next template, see #AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function. - + next matching #GList-struct, or %NULL if not found + line="7013">next matching #GList-struct, or %NULL if not found @@ -151492,7 +151604,7 @@ iteration function. the #GList-struct containing #AgsRecall + line="7008">the #GList-struct containing #AgsRecall @@ -151504,13 +151616,13 @@ iteration function. version="3.0.0"> Finds next matching recall for type. Intended to be used as + line="6971">Finds next matching recall for type. Intended to be used as iteration function. - + next matching #GList-struct, or %NULL if not found + line="6979">next matching #GList-struct, or %NULL if not found @@ -151519,7 +151631,7 @@ iteration function. the #GList-struct containing #AgsRecall + line="6973">the #GList-struct containing #AgsRecall @@ -151527,7 +151639,7 @@ iteration function. the #GType + line="6974">the #GType @@ -151537,13 +151649,13 @@ iteration function. version="3.0.0"> Finds next matching recall for type which has @recycling_context, see #AgsRecallId for further + line="7176">Finds next matching recall for type which has @recycling_context, see #AgsRecallId for further details about #AgsRecyclingContext. Intended to be used as iteration function. - + next matching #GList-struct, or %NULL if not found + line="7185">next matching #GList-struct, or %NULL if not found @@ -151552,7 +151664,7 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. the #GList-struct containing #AgsRecall + line="7178">the #GList-struct containing #AgsRecall @@ -151560,13 +151672,13 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. the #GType + line="7179">the #GType the #AgsRecyclingContext + line="7180">the #AgsRecyclingContext @@ -151576,12 +151688,12 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. Finds all recalls matching @filename and @effect. - + line="6785">Finds all recalls matching @filename and @effect. + a #GList-struct containing #AgsRecall, or %NULL if not found + line="6793">a #GList-struct containing #AgsRecall, or %NULL if not found @@ -151590,7 +151702,7 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. the #GList-struct containing #AgsRecall + line="6787">the #GList-struct containing #AgsRecall @@ -151598,13 +151710,13 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. the filename containing @effect or %NULL + line="6788">the filename containing @effect or %NULL the effect name + line="6789">the effect name @@ -151614,12 +151726,12 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. Get global config value lock free children. - + line="2370">Get global config value lock free children. + if %TRUE does lock free children, else not + line="2375">if %TRUE does lock free children, else not @@ -151628,12 +151740,12 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. Get global config value omit event. - + line="2389">Get global config value omit event. + if %TRUE does omit events, else not + line="2394">if %TRUE does omit events, else not @@ -151642,12 +151754,12 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. Get global config value performance mode. - + line="2408">Get global config value performance mode. + if %TRUE does performance mode, else not + line="2413">if %TRUE does performance mode, else not @@ -151656,12 +151768,12 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. Get global config value rt-safe. - + line="2427">Get global config value rt-safe. + if %TRUE does rt-safe strategy, else not + line="2432">if %TRUE does rt-safe strategy, else not @@ -151670,8 +151782,8 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. Set global config value omit event. - + line="2356">Set global config value omit event. + @@ -151679,7 +151791,7 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. %TRUE if omit event, otherwise %FALSE + line="2358">%TRUE if omit event, otherwise %FALSE @@ -151689,19 +151801,19 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. Check if recall is over. - + line="6706">Check if recall is over. + %TRUE if recall is done, otherwise %FALSE + line="6713">%TRUE if recall is done, otherwise %FALSE the #GList-struct containing #AgsRecall + line="6708">the #GList-struct containing #AgsRecall @@ -151709,7 +151821,7 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. the #AgsRecyclingContext + line="6709">the #AgsRecyclingContext @@ -151720,13 +151832,13 @@ details about #AgsRecyclingContext. Intended to be used as iteration function. Finds next matching recall for type which is a template, see #AGS_RECALL_TEMPLATE flag. + line="7083">Finds next matching recall for type which is a template, see #AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function. - + next matching #GList-struct, or %NULL if not found + line="7091">next matching #GList-struct, or %NULL if not found @@ -151735,7 +151847,7 @@ Intended to be used as iteration function. the #GList-struct containing #AgsRecall + line="7085">the #GList-struct containing #AgsRecall @@ -151743,7 +151855,7 @@ Intended to be used as iteration function. a #GType + line="7086">a #GType @@ -151753,12 +151865,12 @@ Intended to be used as iteration function. version="3.0.0"> Finds provider eg. #AgsAudio or #AgsChannel within @recall containig #AgsRecall. - + line="7424">Finds provider eg. #AgsAudio or #AgsChannel within @recall containig #AgsRecall. + next matching #GList-struct, or %NULL if not found + line="7431">next matching #GList-struct, or %NULL if not found @@ -151767,7 +151879,7 @@ Intended to be used as iteration function. the #GList-struct containing #AgsRecall + line="7426">the #GList-struct containing #AgsRecall @@ -151775,7 +151887,7 @@ Intended to be used as iteration function. the #GObject as provider + line="7427">the #GObject as provider @@ -151785,13 +151897,13 @@ Intended to be used as iteration function. version="3.0.0"> Finds next matching recall for type which is a template, see #AGS_RECALL_TEMPLATE flag. + line="7051">Finds next matching recall for type which is a template, see #AGS_RECALL_TEMPLATE flag. Intended to be used as iteration function. - + next matching #GList-struct, or %NULL if not found + line="7059">next matching #GList-struct, or %NULL if not found @@ -151800,7 +151912,7 @@ Intended to be used as iteration function. the #GList-struct containing #AgsRecall + line="7053">the #GList-struct containing #AgsRecall @@ -151808,7 +151920,7 @@ Intended to be used as iteration function. a #GType + line="7054">a #GType @@ -151816,8 +151928,8 @@ Intended to be used as iteration function. Automate port of @recall. - + line="5515">Automate port of @recall. + @@ -151825,7 +151937,7 @@ Intended to be used as iteration function. the #AgsRecall + line="5517">the #AgsRecall @@ -151833,8 +151945,8 @@ Intended to be used as iteration function. The #AgsRecall doesn't want to run anymore, it aborts further execution. - + line="6045">The #AgsRecall doesn't want to run anymore, it aborts further execution. + @@ -151842,7 +151954,7 @@ Intended to be used as iteration function. the #AgsRecall + line="6047">the #AgsRecall @@ -151852,8 +151964,8 @@ Intended to be used as iteration function. version="3.0.0"> Prepare for run, this is the pre stage within the preparation. - + line="5101">Prepare for run, this is the pre stage within the preparation. + @@ -151861,7 +151973,7 @@ Intended to be used as iteration function. the #AgsRecall + line="5103">the #AgsRecall @@ -151869,8 +151981,8 @@ Intended to be used as iteration function. A signal indicating that the a child has been added. - + line="6686">A signal indicating that the a child has been added. + @@ -151878,13 +151990,13 @@ Intended to be used as iteration function. the #AgsRecall + line="6688">the #AgsRecall the child #AgsRecall + line="6689">the child #AgsRecall @@ -151892,8 +152004,8 @@ Intended to be used as iteration function. Do feedback of @recall. - + line="5857">Do feedback of @recall. + @@ -151901,7 +152013,7 @@ Intended to be used as iteration function. the #AgsRecall + line="5859">the #AgsRecall @@ -151909,9 +152021,9 @@ Intended to be used as iteration function. The #AgsRecall doesn't want to run anymore, it has been done its + line="6109">The #AgsRecall doesn't want to run anymore, it has been done its work. - + @@ -151919,7 +152031,7 @@ work. the #AgsRecall + line="6111">the #AgsRecall @@ -151927,44 +152039,44 @@ work. Should duplicate an #AgsRecall, so it can pass the run stages. Mainly used for + line="6630">Should duplicate an #AgsRecall, so it can pass the run stages. Mainly used for creating duplicates of templates, see %AGS_RECALL_TEMPLATE. - + the duplicated #AgsRecall + line="6641">the duplicated #AgsRecall the template #AgsRecAll + line="6632">the template #AgsRecAll the #AgsRecallID + line="6633">the #AgsRecallID guint pointer to parameter count + line="6634">guint pointer to parameter count string vector containing parameter names + line="6635">string vector containing parameter names the #GValue-struct array + line="6636">the #GValue-struct array @@ -151974,8 +152086,8 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> Feed input queue of @recall. - + line="5441">Feed input queue of @recall. + @@ -151983,7 +152095,7 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="5443">the #AgsRecall @@ -151993,8 +152105,65 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> Feed output queue of @recall. - + line="5938">Feed output queue of @recall. + + + + + + + the #AgsRecall + + + + + + The #AgsRecall checks JACK metadata property change from CV port. + + + + + + + the #AgsRecall + + + + + + The #AgsRecall checks MIDI version 1 control change from input sequencer. + + + + + + + the #AgsRecall + + + + + + The #AgsRecall checks MIDI version 2 control change from input sequencer. + @@ -152002,7 +152171,7 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="6400">the #AgsRecall @@ -152012,8 +152181,8 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> Notifies a recall that an other depends on it. - + line="6664">Notifies a recall that an other depends on it. + @@ -152021,19 +152190,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="6666">the #AgsRecall the dependency to notify for, see #AgsRecallNotifyDependencyMode-enum + line="6667">the dependency to notify for, see #AgsRecallNotifyDependencyMode-enum if %TRUE increase, else if %FALSE decrease + line="6668">if %TRUE increase, else if %FALSE decrease @@ -152043,9 +152212,9 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> A signal indicating that the inheriting object should resolve + line="5024">A signal indicating that the inheriting object should resolve it's dependency. - + @@ -152053,7 +152222,7 @@ it's dependency. the #AgsRecall + line="5026">the #AgsRecall @@ -152063,8 +152232,8 @@ it's dependency. version="3.0.0"> Prepare for run, this is the inter stage within the preparation. - + line="5271">Prepare for run, this is the inter stage within the preparation. + @@ -152072,7 +152241,7 @@ it's dependency. the #AgsRecall + line="5273">the #AgsRecall @@ -152082,8 +152251,8 @@ it's dependency. version="3.0.0"> Prepare for run, this is the post stage within the preparation. - + line="5360">Prepare for run, this is the post stage within the preparation. + @@ -152091,7 +152260,7 @@ it's dependency. the #AgsRecall + line="5362">the #AgsRecall @@ -152101,8 +152270,8 @@ it's dependency. version="3.0.0"> Prepare for run, this is the pre stage within the preparation. - + line="5190">Prepare for run, this is the pre stage within the preparation. + @@ -152110,7 +152279,7 @@ it's dependency. the #AgsRecall + line="5192">the #AgsRecall @@ -152118,8 +152287,8 @@ it's dependency. This is the inter stage within a run. - + line="5688">This is the inter stage within a run. + @@ -152127,7 +152296,7 @@ it's dependency. the #AgsRecall + line="5690">the #AgsRecall @@ -152135,8 +152304,8 @@ it's dependency. This is the post stage within a run. - + line="5776">This is the post stage within a run. + @@ -152144,7 +152313,7 @@ it's dependency. the #AgsRecall + line="5778">the #AgsRecall @@ -152152,8 +152321,8 @@ it's dependency. This is the pre stage within a run. - + line="5601">This is the pre stage within a run. + @@ -152161,7 +152330,7 @@ it's dependency. the #AgsRecall + line="5603">the #AgsRecall @@ -152171,9 +152340,9 @@ it's dependency. version="3.0.0"> Unsets the %AGS_SOUND_BEHAVIOUR_PERSISTENT and related behaviour flags and + line="5989">Unsets the %AGS_SOUND_BEHAVIOUR_PERSISTENT and related behaviour flags and invokes ags_recall_done(). - + @@ -152181,7 +152350,7 @@ invokes ags_recall_done(). the #AgsRecall + line="5991">the #AgsRecall @@ -152191,8 +152360,8 @@ invokes ags_recall_done(). version="3.0.0"> Add @child to @recall. - + line="4324">Add @child to @recall. + @@ -152200,13 +152369,13 @@ invokes ags_recall_done(). the #AgsRecall + line="4326">the #AgsRecall the child #AgsRecall + line="4327">the child #AgsRecall @@ -152216,8 +152385,8 @@ invokes ags_recall_done(). version="3.3.0"> Add @port to @recall. - + line="4193">Add @port to @recall. + @@ -152225,13 +152394,13 @@ invokes ags_recall_done(). the #AgsRecall + line="4195">the #AgsRecall the #AgsPort + line="4196">the #AgsPort @@ -152241,8 +152410,8 @@ invokes ags_recall_done(). version="3.0.0"> Associate a new dependency for this recall. - + line="4065">Associate a new dependency for this recall. + @@ -152250,13 +152419,13 @@ invokes ags_recall_done(). the #AgsRecall + line="4067">the #AgsRecall the #AgsRecallDependency + line="4068">the #AgsRecallDependency @@ -152266,8 +152435,8 @@ invokes ags_recall_done(). version="3.0.0"> Connect callback to @recall specified by @recall_handler. - + line="4573">Connect callback to @recall specified by @recall_handler. + @@ -152275,7 +152444,7 @@ invokes ags_recall_done(). the #AgsRecall to connect + line="4575">the #AgsRecall to connect allow-none="1"> the signal specs + line="4576">the signal specs @@ -152294,8 +152463,8 @@ invokes ags_recall_done(). version="3.0.0"> Automate port of @recall. - + line="5515">Automate port of @recall. + @@ -152303,7 +152472,7 @@ invokes ags_recall_done(). the #AgsRecall + line="5517">the #AgsRecall @@ -152311,8 +152480,8 @@ invokes ags_recall_done(). The #AgsRecall doesn't want to run anymore, it aborts further execution. - + line="6045">The #AgsRecall doesn't want to run anymore, it aborts further execution. + @@ -152320,7 +152489,7 @@ invokes ags_recall_done(). the #AgsRecall + line="6047">the #AgsRecall @@ -152330,25 +152499,25 @@ invokes ags_recall_done(). version="3.0.0"> Check if @ability_flags is set for @recall. - + line="2706">Check if @ability_flags is set for @recall. + %TRUE flags are set, otherwise %FALSE + line="2713">%TRUE flags are set, otherwise %FALSE the #AgsRecall + line="2708">the #AgsRecall the ability flags + line="2709">the ability flags @@ -152358,25 +152527,25 @@ invokes ags_recall_done(). version="3.0.0"> Check if @behaviour_flags is set for @recall. - + line="2937">Check if @behaviour_flags is set for @recall. + %TRUE flags are set, otherwise %FALSE + line="2944">%TRUE flags are set, otherwise %FALSE the #AgsRecall + line="2939">the #AgsRecall the behaviour flags + line="2940">the behaviour flags @@ -152386,8 +152555,8 @@ invokes ags_recall_done(). version="3.0.0"> Prepare for run, this is the pre stage within the preparation. - + line="5101">Prepare for run, this is the pre stage within the preparation. + @@ -152395,7 +152564,7 @@ invokes ags_recall_done(). the #AgsRecall + line="5103">the #AgsRecall @@ -152405,25 +152574,25 @@ invokes ags_recall_done(). version="3.0.0"> Check if @sound_scope is set for @recall. - + line="3134">Check if @sound_scope is set for @recall. + %TRUE if sound scope matches, otherwise %FALSE + line="3141">%TRUE if sound scope matches, otherwise %FALSE the #AgsRecall + line="3136">the #AgsRecall the sound scope to check or -1 to check all + line="3137">the sound scope to check or -1 to check all @@ -152433,25 +152602,25 @@ invokes ags_recall_done(). version="3.0.0"> Check the occurence of @staging_flags in @recall. - + line="3459">Check the occurence of @staging_flags in @recall. + %TRUE if all flags matched, otherwise %FALSE + line="3466">%TRUE if all flags matched, otherwise %FALSE the #AgsRecall + line="3461">the #AgsRecall staging flags to check + line="3462">staging flags to check @@ -152461,25 +152630,25 @@ invokes ags_recall_done(). version="3.0.0"> Check the occurence of @state_flags in @recall. - + line="3664">Check the occurence of @state_flags in @recall. + %TRUE if all flags matched, otherwise %FALSE + line="3671">%TRUE if all flags matched, otherwise %FALSE the #AgsRecall + line="3666">the #AgsRecall state flags to check + line="3667">state flags to check @@ -152489,8 +152658,8 @@ invokes ags_recall_done(). version="3.0.0"> A signal indicating that the a child has been added. - + line="6686">A signal indicating that the a child has been added. + @@ -152498,13 +152667,13 @@ invokes ags_recall_done(). the #AgsRecall + line="6688">the #AgsRecall the child #AgsRecall + line="6689">the child #AgsRecall @@ -152514,8 +152683,8 @@ invokes ags_recall_done(). version="3.0.0"> Do feedback of @recall. - + line="5857">Do feedback of @recall. + @@ -152523,7 +152692,7 @@ invokes ags_recall_done(). the #AgsRecall + line="5859">the #AgsRecall @@ -152531,9 +152700,9 @@ invokes ags_recall_done(). The #AgsRecall doesn't want to run anymore, it has been done its + line="6109">The #AgsRecall doesn't want to run anymore, it has been done its work. - + @@ -152541,7 +152710,7 @@ work. the #AgsRecall + line="6111">the #AgsRecall @@ -152551,44 +152720,44 @@ work. version="3.0.0"> Should duplicate an #AgsRecall, so it can pass the run stages. Mainly used for + line="6630">Should duplicate an #AgsRecall, so it can pass the run stages. Mainly used for creating duplicates of templates, see %AGS_RECALL_TEMPLATE. - + the duplicated #AgsRecall + line="6641">the duplicated #AgsRecall the template #AgsRecAll + line="6632">the template #AgsRecAll the #AgsRecallID + line="6633">the #AgsRecallID guint pointer to parameter count + line="6634">guint pointer to parameter count string vector containing parameter names + line="6635">string vector containing parameter names the #GValue-struct array + line="6636">the #GValue-struct array @@ -152598,8 +152767,8 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> Feed input queue of @recall. - + line="5441">Feed input queue of @recall. + @@ -152607,7 +152776,7 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="5443">the #AgsRecall @@ -152617,8 +152786,8 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> Feed output queue of @recall. - + line="5938">Feed output queue of @recall. + @@ -152626,7 +152795,7 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="5940">the #AgsRecall @@ -152637,19 +152806,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Gets buffer size. - + line="4870">Gets buffer size. + the buffer size + line="4876">the buffer size the #AgsRecall + line="4872">the #AgsRecall @@ -152659,12 +152828,12 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Get recall children. - + line="4263">Get recall children. + the #GList-struct containig #AgsRecall + line="4269">the #GList-struct containig #AgsRecall @@ -152673,7 +152842,7 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="4265">the #AgsRecall @@ -152684,19 +152853,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Get effect. - + line="3768">Get effect. + the effect + line="3774">the effect the #AgsRecall + line="3770">the #AgsRecall @@ -152707,19 +152876,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Get effect index. - + line="3816">Get effect index. + the effect index + line="3822">the effect index the #AgsRecall + line="3818">the #AgsRecall @@ -152730,19 +152899,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Get filename. - + line="3720">Get filename. + the filename + line="3726">the filename the #AgsRecall + line="3722">the #AgsRecall @@ -152753,19 +152922,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Gets format. - + line="4925">Gets format. + the format + line="4931">the format the #AgsRecall + line="4927">the #AgsRecall @@ -152776,19 +152945,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Get the input soundcard object of @recall. - + line="4736">Get the input soundcard object of @recall. + the input soundcard + line="4742">the input soundcard the #AgsRecall + line="4738">the #AgsRecall @@ -152798,19 +152967,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Get object mutex. - + line="2446">Get object mutex. + the #GRecMutex to lock @recall + line="2452">the #GRecMutex to lock @recall the #AgsRecall + line="2448">the #AgsRecall @@ -152821,19 +152990,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Get the output soundcard object of @recall. - + line="4637">Get the output soundcard object of @recall. + the output soundcard + line="4643">the output soundcard the #AgsRecall + line="4639">the #AgsRecall @@ -152844,12 +153013,12 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.7.18"> Get port. - + line="4132">Get port. + the #GList-struct containig #AgsPort + line="4138">the #GList-struct containig #AgsPort @@ -152858,7 +153027,7 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="4134">the #AgsRecall @@ -152869,19 +153038,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Get recall container of @recall. - + line="3864">Get recall container of @recall. + the #AgsRecallContainer + line="3870">the #AgsRecallContainer the #AgsRecall + line="3866">the #AgsRecall @@ -152892,12 +153061,12 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Get recall dependency. - + line="4004">Get recall dependency. + the #GList-struct containig #AgsRecallDependency + line="4010">the #GList-struct containig #AgsRecallDependency @@ -152906,7 +153075,7 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="4006">the #AgsRecall @@ -152917,19 +153086,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Get recall id of @recall. - + line="3912">Get recall id of @recall. + the #AgsRecallID + line="3918">the #AgsRecallID the #AgsRecall + line="3914">the #AgsRecall @@ -152940,19 +153109,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.1.0"> Gets samplerate. - + line="4815">Gets samplerate. + the samplerate + line="4821">the samplerate the #AgsRecall + line="4817">the #AgsRecall @@ -152962,19 +153131,38 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> Get sound scope for @recall. - + line="3100">Get sound scope for @recall. + the used sound scope + line="3106">the used sound scope the #AgsRecall + line="3102">the #AgsRecall + + + + + + The #AgsRecall checks JACK metadata property change from CV port. + + + + + + + the #AgsRecall @@ -152984,8 +153172,8 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> Locks the ports. - + line="7568">Locks the ports. + @@ -152993,7 +153181,7 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="7570">the #AgsRecall @@ -153003,36 +153191,74 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> Check if @sound_scope related ability flag is set. - + line="2766">Check if @sound_scope related ability flag is set. + %TRUE if sound scope is available, otherwise %FALSE + line="2773">%TRUE if sound scope is available, otherwise %FALSE the #AgsRecall + line="2768">the #AgsRecall the sound scope + line="2769">the sound scope + + The #AgsRecall checks MIDI version 1 control change from input sequencer. + + + + + + + the #AgsRecall + + + + + + The #AgsRecall checks MIDI version 2 control change from input sequencer. + + + + + + + the #AgsRecall + + + + Notifies a recall that an other depends on it. - + line="6664">Notifies a recall that an other depends on it. + @@ -153040,19 +153266,19 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="6666">the #AgsRecall the dependency to notify for, see #AgsRecallNotifyDependencyMode-enum + line="6667">the dependency to notify for, see #AgsRecallNotifyDependencyMode-enum if %TRUE increase, else if %FALSE decrease + line="6668">if %TRUE increase, else if %FALSE decrease @@ -153062,8 +153288,8 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> Remove @child from @recall. - + line="4473">Remove @child from @recall. + @@ -153071,13 +153297,13 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="4475">the #AgsRecall the child #AgsRecall + line="4476">the child #AgsRecall @@ -153087,8 +153313,8 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.3.0"> Remove @port from @recall. - + line="4228">Remove @port from @recall. + @@ -153096,13 +153322,13 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="4230">the #AgsRecall the #AgsPort + line="4231">the #AgsPort @@ -153112,8 +153338,8 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> Remove a prior associated dependency. - + line="4097">Remove a prior associated dependency. + @@ -153121,13 +153347,13 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall + line="4099">the #AgsRecall the #AgsRecallDependency + line="4100">the #AgsRecallDependency @@ -153137,8 +153363,8 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> Remove a #AgsRecallHandler-struct from @recall. - + line="4605">Remove a #AgsRecallHandler-struct from @recall. + @@ -153146,7 +153372,7 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. the #AgsRecall to connect + line="4607">the #AgsRecall to connect allow-none="1"> the signal specs + line="4608">the signal specs @@ -153165,9 +153391,9 @@ creating duplicates of templates, see %AGS_RECALL_TEMPLATE. version="3.0.0"> A signal indicating that the inheriting object should resolve + line="5024">A signal indicating that the inheriting object should resolve it's dependency. - + @@ -153175,7 +153401,7 @@ it's dependency. the #AgsRecall + line="5026">the #AgsRecall @@ -153185,8 +153411,8 @@ it's dependency. version="3.0.0"> Prepare for run, this is the inter stage within the preparation. - + line="5271">Prepare for run, this is the inter stage within the preparation. + @@ -153194,7 +153420,7 @@ it's dependency. the #AgsRecall + line="5273">the #AgsRecall @@ -153204,8 +153430,8 @@ it's dependency. version="3.0.0"> Prepare for run, this is the post stage within the preparation. - + line="5360">Prepare for run, this is the post stage within the preparation. + @@ -153213,7 +153439,7 @@ it's dependency. the #AgsRecall + line="5362">the #AgsRecall @@ -153223,8 +153449,8 @@ it's dependency. version="3.0.0"> Prepare for run, this is the pre stage within the preparation. - + line="5190">Prepare for run, this is the pre stage within the preparation. + @@ -153232,7 +153458,7 @@ it's dependency. the #AgsRecall + line="5192">the #AgsRecall @@ -153242,8 +153468,8 @@ it's dependency. version="3.0.0"> This is the inter stage within a run. - + line="5688">This is the inter stage within a run. + @@ -153251,7 +153477,7 @@ it's dependency. the #AgsRecall + line="5690">the #AgsRecall @@ -153261,8 +153487,8 @@ it's dependency. version="3.0.0"> This is the post stage within a run. - + line="5776">This is the post stage within a run. + @@ -153270,7 +153496,7 @@ it's dependency. the #AgsRecall + line="5778">the #AgsRecall @@ -153278,8 +153504,8 @@ it's dependency. This is the pre stage within a run. - + line="5601">This is the pre stage within a run. + @@ -153287,7 +153513,7 @@ it's dependency. the #AgsRecall + line="5603">the #AgsRecall @@ -153297,8 +153523,8 @@ it's dependency. version="3.0.0"> Set ability flags recursively. - + line="2594">Set ability flags recursively. + @@ -153306,13 +153532,13 @@ it's dependency. the #AgsRecall + line="2596">the #AgsRecall ability flags + line="2597">ability flags @@ -153322,8 +153548,8 @@ it's dependency. version="3.0.0"> Set behaviour flags of @recall. - + line="2879">Set behaviour flags of @recall. + @@ -153331,13 +153557,13 @@ it's dependency. the #AgsRecall + line="2881">the #AgsRecall the behaviour flags + line="2882">the behaviour flags @@ -153348,8 +153574,8 @@ it's dependency. version="3.0.0"> Set buffer size of @recall. - + line="4896">Set buffer size of @recall. + @@ -153357,13 +153583,13 @@ it's dependency. the #AgsRecall + line="4898">the #AgsRecall the buffer size + line="4899">the buffer size @@ -153373,8 +153599,8 @@ it's dependency. version="3.1.0"> Set recall children by replacing existing. - + line="4289">Set recall children by replacing existing. + @@ -153382,13 +153608,13 @@ it's dependency. the #AgsRecall + line="4291">the #AgsRecall the #GList-struct containing #AgsRecall + line="4292">the #GList-struct containing #AgsRecall @@ -153401,8 +153627,8 @@ it's dependency. version="3.1.0"> Set effect. - + line="3794">Set effect. + @@ -153410,13 +153636,13 @@ it's dependency. the #AgsRecall + line="3796">the #AgsRecall the effect + line="3797">the effect @@ -153427,8 +153653,8 @@ it's dependency. version="3.1.0"> Set effect index. - + line="3842">Set effect index. + @@ -153436,13 +153662,13 @@ it's dependency. the #AgsRecall + line="3844">the #AgsRecall the effect index + line="3845">the effect index @@ -153453,8 +153679,8 @@ it's dependency. version="3.1.0"> Set filename. - + line="3746">Set filename. + @@ -153462,13 +153688,13 @@ it's dependency. the #AgsRecall + line="3748">the #AgsRecall the filename + line="3749">the filename @@ -153478,8 +153704,8 @@ it's dependency. version="3.0.0"> Set flags. - + line="2501">Set flags. + @@ -153487,13 +153713,13 @@ it's dependency. the #AgsRecall + line="2503">the #AgsRecall the flags + line="2504">the flags @@ -153504,8 +153730,8 @@ it's dependency. version="3.0.0"> Set format of @recall. - + line="4951">Set format of @recall. + @@ -153513,13 +153739,13 @@ it's dependency. the #AgsRecall + line="4953">the #AgsRecall the format + line="4954">the format @@ -153530,8 +153756,8 @@ it's dependency. version="3.0.0"> Set the input soundcard object of @recall. - + line="4794">Set the input soundcard object of @recall. + @@ -153539,13 +153765,13 @@ it's dependency. an #AgsRecall + line="4796">an #AgsRecall the #GObject implementing #AgsSoundcard + line="4797">the #GObject implementing #AgsSoundcard @@ -153556,8 +153782,8 @@ it's dependency. version="3.0.0"> Set the output soundcard object of @recall. - + line="4715">Set the output soundcard object of @recall. + @@ -153565,13 +153791,13 @@ it's dependency. the #AgsRecall + line="4717">the #AgsRecall the #GObject implementing #AgsSoundcard + line="4718">the #GObject implementing #AgsSoundcard @@ -153582,8 +153808,8 @@ it's dependency. version="3.7.18"> Set port by replacing existing. - + line="4158">Set port by replacing existing. + @@ -153591,13 +153817,13 @@ it's dependency. the #AgsRecall + line="4160">the #AgsRecall the #GList-struct containing #AgsPort + line="4161">the #GList-struct containing #AgsPort @@ -153610,8 +153836,8 @@ it's dependency. version="3.1.0"> Set @recall_container of @recall. - + line="3890">Set @recall_container of @recall. + @@ -153619,13 +153845,13 @@ it's dependency. the #AgsRecall + line="3892">the #AgsRecall the #AgsRecallContainer + line="3893">the #AgsRecallContainer @@ -153636,8 +153862,8 @@ it's dependency. version="3.1.0"> Set recall dependency by replacing existing. - + line="4030">Set recall dependency by replacing existing. + @@ -153645,13 +153871,13 @@ it's dependency. the #AgsRecall + line="4032">the #AgsRecall the #GList-struct containing #AgsRecallDependency + line="4033">the #GList-struct containing #AgsRecallDependency @@ -153664,8 +153890,8 @@ it's dependency. version="3.0.0"> Set @recall_id of @recall and all its children. - + line="3938">Set @recall_id of @recall and all its children. + @@ -153673,13 +153899,13 @@ it's dependency. the #AgsRecall + line="3940">the #AgsRecall the #AgsRecallID to set + line="3941">the #AgsRecallID to set @@ -153690,8 +153916,8 @@ it's dependency. version="3.0.0"> Set samplerate of @recall. - + line="4841">Set samplerate of @recall. + @@ -153699,13 +153925,13 @@ it's dependency. the #AgsRecall + line="4843">the #AgsRecall the samplerate + line="4844">the samplerate @@ -153715,8 +153941,8 @@ it's dependency. version="3.0.0"> Set @sound_scope for @recall. - + line="3042">Set @sound_scope for @recall. + @@ -153724,13 +153950,13 @@ it's dependency. the #AgsRecall + line="3044">the #AgsRecall the sound scope + line="3045">the sound scope @@ -153740,8 +153966,8 @@ it's dependency. version="3.0.0"> Set staging flags. - + line="3223">Set staging flags. + @@ -153749,13 +153975,13 @@ it's dependency. the #AgsRecall + line="3225">the #AgsRecall staging flags to set + line="3226">staging flags to set @@ -153765,8 +153991,8 @@ it's dependency. version="3.0.0"> Set state flags. - + line="3606">Set state flags. + @@ -153774,13 +154000,13 @@ it's dependency. the #AgsRecall + line="3608">the #AgsRecall state flags to set + line="3609">state flags to set @@ -153790,9 +154016,9 @@ it's dependency. version="3.0.0"> Unsets the %AGS_SOUND_BEHAVIOUR_PERSISTENT and related behaviour flags and + line="5989">Unsets the %AGS_SOUND_BEHAVIOUR_PERSISTENT and related behaviour flags and invokes ags_recall_done(). - + @@ -153800,7 +154026,7 @@ invokes ags_recall_done(). the #AgsRecall + line="5991">the #AgsRecall @@ -153810,25 +154036,25 @@ invokes ags_recall_done(). version="3.0.0"> Test @ability_flags to be set on @recall. - + line="2559">Test @ability_flags to be set on @recall. + %TRUE if flags are set, else %FALSE + line="2566">%TRUE if flags are set, else %FALSE the #AgsRecall + line="2561">the #AgsRecall the ability flags + line="2562">the ability flags @@ -153838,25 +154064,25 @@ invokes ags_recall_done(). version="3.0.0"> Test @behaviour_flags to be set on @recall. - + line="2844">Test @behaviour_flags to be set on @recall. + %TRUE if flags are set, else %FALSE + line="2851">%TRUE if flags are set, else %FALSE the #AgsRecall + line="2846">the #AgsRecall the behaviour flags + line="2847">the behaviour flags @@ -153866,25 +154092,25 @@ invokes ags_recall_done(). version="3.0.0"> Test @flags to be set on @recall. - + line="2466">Test @flags to be set on @recall. + %TRUE if flags are set, else %FALSE + line="2473">%TRUE if flags are set, else %FALSE the #AgsRecall + line="2468">the #AgsRecall the flags + line="2469">the flags @@ -153894,25 +154120,25 @@ invokes ags_recall_done(). version="3.0.0"> Test @staging_flags to be set on @recall. - + line="3187">Test @staging_flags to be set on @recall. + %TRUE if flags are set, else %FALSE + line="3194">%TRUE if flags are set, else %FALSE the #AgsRecall + line="3189">the #AgsRecall the staging flags + line="3190">the staging flags @@ -153922,25 +154148,25 @@ invokes ags_recall_done(). version="3.0.0"> Test @state_flags to be set on @recall. - + line="3570">Test @state_flags to be set on @recall. + %TRUE if flags are set, else %FALSE + line="3577">%TRUE if flags are set, else %FALSE the #AgsRecall + line="3572">the #AgsRecall the state flags + line="3573">the state flags @@ -153950,8 +154176,8 @@ invokes ags_recall_done(). version="3.0.0"> Unlocks the ports. - + line="7617">Unlocks the ports. + @@ -153959,7 +154185,7 @@ invokes ags_recall_done(). the #AgsRecall + line="7619">the #AgsRecall @@ -153969,8 +154195,8 @@ invokes ags_recall_done(). version="3.0.0"> Unset ability flags recursively. - + line="2650">Unset ability flags recursively. + @@ -153978,13 +154204,13 @@ invokes ags_recall_done(). the #AgsRecall + line="2652">the #AgsRecall ability flags + line="2653">ability flags @@ -153994,8 +154220,8 @@ invokes ags_recall_done(). version="3.0.0"> Unset behaviour flags of @recall. - + line="2908">Unset behaviour flags of @recall. + @@ -154003,13 +154229,13 @@ invokes ags_recall_done(). the #AgsRecall + line="2910">the #AgsRecall the behaviour flags + line="2911">the behaviour flags @@ -154019,8 +154245,8 @@ invokes ags_recall_done(). version="3.0.0"> Unset flags. - + line="2530">Unset flags. + @@ -154028,13 +154254,13 @@ invokes ags_recall_done(). the #AgsRecall + line="2532">the #AgsRecall the flags + line="2533">the flags @@ -154044,8 +154270,8 @@ invokes ags_recall_done(). version="3.0.0"> Unset staging flags. - + line="3401">Unset staging flags. + @@ -154053,13 +154279,13 @@ invokes ags_recall_done(). the #AgsRecall + line="3403">the #AgsRecall staging flags to unset + line="3404">staging flags to unset @@ -154069,8 +154295,8 @@ invokes ags_recall_done(). version="3.0.0"> Unset state flags. - + line="3635">Unset state flags. + @@ -154078,13 +154304,13 @@ invokes ags_recall_done(). the #AgsRecall + line="3637">the #AgsRecall state flags to unset + line="3638">state flags to unset @@ -154096,7 +154322,7 @@ invokes ags_recall_done(). default-value="0"> The nth audio channel. + line="532">The nth audio channel. transfer-ownership="full"> The #AgsPort doing automation. + line="583">The #AgsPort doing automation. @@ -154119,7 +154345,7 @@ invokes ags_recall_done(). default-value="0"> The buffer size. + line="478">The buffer size. transfer-ownership="full"> The child #AgsRecall. + line="661">The child #AgsRecall. @@ -154139,7 +154365,7 @@ invokes ags_recall_done(). transfer-ownership="none"> The type of child #AgsRecall. + line="645">The type of child #AgsRecall. default-value="NULL"> The plugin's effect. + line="342">The plugin's effect. default-value="0"> The effect's index. + line="358">The effect's index. default-value="NULL"> The plugin's filename. + line="326">The plugin's filename. default-value="0"> The format. + line="496">The format. getter="get_input_soundcard"> The assigned soundcard. + line="426">The assigned soundcard. default-value="-1"> The input soundcard channel. + line="442">The input soundcard channel. default-value="0"> The nth line. + line="550">The nth line. getter="get_output_soundcard"> The assigned soundcard. + line="392">The assigned soundcard. default-value="-1"> The output soundcard channel. + line="408">The output soundcard channel. default-value="0"> The nth pad. + line="514">The nth pad. transfer-ownership="none"> The parent #AgsRecall. + line="629">The parent #AgsRecall. getter="get_port"> The assigned #AgsPort + line="568">The assigned #AgsPort @@ -154282,7 +154508,7 @@ invokes ags_recall_done(). getter="get_recall_container"> The #AgsRecallContainer packed into. + line="376">The #AgsRecallContainer packed into. getter="get_recall_dependency"> The #AgsRecallDependency. + line="614">The #AgsRecallDependency. @@ -154306,7 +154532,7 @@ invokes ags_recall_done(). getter="get_recall_id"> The #AgsRecallID running in. + line="598">The #AgsRecallID running in. default-value="0"> The samplerate. + line="460">The samplerate. @@ -154448,10 +154674,34 @@ invokes ags_recall_done(). + + + + + + + + + + + + + + + + + + + + + + + + The ::automate signal notifies about running + line="813">The ::automate signal notifies about running automation and is normally called during ::run-pre. @@ -154460,7 +154710,7 @@ automation and is normally called during ::run-pre. The ::cancel signal notifies about cancelling playback. + line="939">The ::cancel signal notifies about cancelling playback. @@ -154468,7 +154718,7 @@ automation and is normally called during ::run-pre. The ::check-rt-data signal notifies about initializing + line="723">The ::check-rt-data signal notifies about initializing stage 0. @@ -154477,7 +154727,7 @@ stage 0. The ::child-added signal notifies about children + line="1019">The ::child-added signal notifies about children added. @@ -154486,7 +154736,7 @@ added. the #AgsRecall to add + line="1022">the #AgsRecall to add @@ -154494,7 +154744,7 @@ added. The ::do-feedback signal notifies about running + line="885">The ::do-feedback signal notifies about running stage 2. @@ -154503,7 +154753,7 @@ stage 2. The ::done signal notifies about stopping playback. + line="956">The ::done signal notifies about stopping playback. @@ -154511,18 +154761,18 @@ stage 2. The ::duplicate signal notifies about instantiating. + line="973">The ::duplicate signal notifies about instantiating. the new #AgsRecall instance + line="983">the new #AgsRecall instance the assigned #AgsRecallID + line="976">the assigned #AgsRecallID allow-none="1"> pointer to array length + line="977">pointer to array length allow-none="1"> parameter name string vector + line="978">parameter name string vector allow-none="1"> the #GValue-struct array + line="979">the #GValue-struct array @@ -154557,7 +154807,7 @@ stage 2. The ::feed-input-queue signal notifies about running + line="795">The ::feed-input-queue signal notifies about running feed input queue. @@ -154566,16 +154816,40 @@ feed input queue. The ::feed-output-queue signal notifies about running + line="903">The ::feed-output-queue signal notifies about running feed output queue. + + The ::jack-metadata signal notifies about checking JACK metadata property change. + + + + + + The ::midi1-control change event notifies about parsing MIDI version 1.0 control change. + + + + + + The ::midi2-control change event notifies about parsing MIDI version 2.0 control change. + + + + The ::notify-dependency signal notifies about dependency + line="998">The ::notify-dependency signal notifies about dependency added. @@ -154584,13 +154858,13 @@ added. the kind of dependency + line="1001">the kind of dependency if %TRUE increase dependency count, else if %FALSE decrease + line="1002">if %TRUE increase dependency count, else if %FALSE decrease @@ -154598,7 +154872,7 @@ added. The ::resolve-dependency signal notifies about resolving + line="705">The ::resolve-dependency signal notifies about resolving dependency. @@ -154607,7 +154881,7 @@ dependency. The ::run-init-inter signal notifies about initializing + line="759">The ::run-init-inter signal notifies about initializing stage 1. @@ -154616,7 +154890,7 @@ stage 1. The ::run-init-post signal notifies about initializing + line="777">The ::run-init-post signal notifies about initializing stage 2. @@ -154625,7 +154899,7 @@ stage 2. The ::run-init-pre signal notifies about initializing + line="741">The ::run-init-pre signal notifies about initializing stage 0. @@ -154634,7 +154908,7 @@ stage 0. The ::run-inter signal notifies about running + line="849">The ::run-inter signal notifies about running stage 1. @@ -154643,7 +154917,7 @@ stage 1. The ::run-post signal notifies about running + line="867">The ::run-post signal notifies about running stage 2. @@ -154652,7 +154926,7 @@ stage 2. The ::run-pre signal notifies about running + line="831">The ::run-pre signal notifies about running stage 0. @@ -154661,7 +154935,7 @@ stage 0. The ::stop-persistent signal notifies about definitively + line="921">The ::stop-persistent signal notifies about definitively stopping playback. @@ -155569,13 +155843,13 @@ stopping playback. - + - + @@ -155583,7 +155857,7 @@ stopping playback. the #AgsRecall + line="5026">the #AgsRecall @@ -155591,7 +155865,7 @@ stopping playback. - + @@ -155599,7 +155873,7 @@ stopping playback. the #AgsRecall + line="5103">the #AgsRecall @@ -155607,7 +155881,7 @@ stopping playback. - + @@ -155615,7 +155889,7 @@ stopping playback. the #AgsRecall + line="5192">the #AgsRecall @@ -155623,7 +155897,7 @@ stopping playback. - + @@ -155631,7 +155905,7 @@ stopping playback. the #AgsRecall + line="5273">the #AgsRecall @@ -155639,7 +155913,7 @@ stopping playback. - + @@ -155647,7 +155921,7 @@ stopping playback. the #AgsRecall + line="5362">the #AgsRecall @@ -155655,7 +155929,7 @@ stopping playback. - + @@ -155663,7 +155937,7 @@ stopping playback. the #AgsRecall + line="5443">the #AgsRecall @@ -155671,7 +155945,7 @@ stopping playback. - + @@ -155679,7 +155953,7 @@ stopping playback. the #AgsRecall + line="5517">the #AgsRecall @@ -155687,7 +155961,7 @@ stopping playback. - + @@ -155695,7 +155969,7 @@ stopping playback. the #AgsRecall + line="5603">the #AgsRecall @@ -155703,7 +155977,7 @@ stopping playback. - + @@ -155711,7 +155985,7 @@ stopping playback. the #AgsRecall + line="5690">the #AgsRecall @@ -155719,7 +155993,7 @@ stopping playback. - + @@ -155727,7 +156001,7 @@ stopping playback. the #AgsRecall + line="5778">the #AgsRecall @@ -155735,7 +156009,7 @@ stopping playback. - + @@ -155743,7 +156017,7 @@ stopping playback. the #AgsRecall + line="5859">the #AgsRecall @@ -155751,7 +156025,7 @@ stopping playback. - + @@ -155759,7 +156033,7 @@ stopping playback. the #AgsRecall + line="5940">the #AgsRecall @@ -155767,7 +156041,7 @@ stopping playback. - + @@ -155775,7 +156049,7 @@ stopping playback. the #AgsRecall + line="5991">the #AgsRecall @@ -155783,7 +156057,7 @@ stopping playback. - + @@ -155791,7 +156065,7 @@ stopping playback. the #AgsRecall + line="6047">the #AgsRecall @@ -155799,7 +156073,7 @@ stopping playback. - + @@ -155807,7 +156081,7 @@ stopping playback. the #AgsRecall + line="6111">the #AgsRecall @@ -155815,42 +156089,42 @@ stopping playback. - + the duplicated #AgsRecall + line="6641">the duplicated #AgsRecall the template #AgsRecAll + line="6632">the template #AgsRecAll the #AgsRecallID + line="6633">the #AgsRecallID guint pointer to parameter count + line="6634">guint pointer to parameter count string vector containing parameter names + line="6635">string vector containing parameter names the #GValue-struct array + line="6636">the #GValue-struct array @@ -155858,7 +156132,7 @@ stopping playback. - + @@ -155866,19 +156140,19 @@ stopping playback. the #AgsRecall + line="6666">the #AgsRecall the dependency to notify for, see #AgsRecallNotifyDependencyMode-enum + line="6667">the dependency to notify for, see #AgsRecallNotifyDependencyMode-enum if %TRUE increase, else if %FALSE decrease + line="6668">if %TRUE increase, else if %FALSE decrease @@ -155886,7 +156160,7 @@ stopping playback. - + @@ -155894,13 +156168,61 @@ stopping playback. the #AgsRecall + line="6688">the #AgsRecall the child #AgsRecall + line="6689">the child #AgsRecall + + + + + + + + + + + + + + the #AgsRecall + + + + + + + + + + + + + + the #AgsRecall + + + + + + + + + + + + + + the #AgsRecall @@ -155921,12 +156243,12 @@ stopping playback. version="3.0.0"> Create a new instance of #AgsRecallContainer + line="1589">Create a new instance of #AgsRecallContainer the new #AgsRecallContainer + line="1594">the new #AgsRecallContainer @@ -155935,12 +156257,12 @@ stopping playback. version="3.0.0"> Finds #AgsRecall for appropriate search criteria. + line="1448">Finds #AgsRecall for appropriate search criteria. the matching recalls + line="1457">the matching recalls @@ -155949,7 +156271,7 @@ stopping playback. the #GList-struct containing #AgsRecallContainer + line="1450">the #GList-struct containing #AgsRecallContainer @@ -155957,20 +156279,20 @@ stopping playback. recall type + line="1451">recall type search mask + line="1452">search mask an #AgsRecallID + line="1453">an #AgsRecallID @@ -156007,12 +156329,12 @@ stopping playback. version="3.0.0"> Retrieve recall audio of container. + line="1368">Retrieve recall audio of container. the #AgsRecallAudio + line="1374">the #AgsRecallAudio @@ -156020,7 +156342,7 @@ stopping playback. transfer-ownership="none"> the #AgsRecallContainer + line="1370">the #AgsRecallContainer @@ -156031,12 +156353,12 @@ stopping playback. version="3.0.0"> Retrieve recall audio run of container. + line="1388">Retrieve recall audio run of container. the #AgsRecallAudioRun as list + line="1394">the #AgsRecallAudioRun as list @@ -156046,7 +156368,7 @@ stopping playback. transfer-ownership="none"> the #AgsRecallContainer + line="1390">the #AgsRecallContainer @@ -156057,12 +156379,12 @@ stopping playback. version="3.0.0"> Retrieve the recall channel of container. + line="1408">Retrieve the recall channel of container. the #AgsRecallChannel + line="1414">the #AgsRecallChannel @@ -156072,7 +156394,7 @@ stopping playback. transfer-ownership="none"> the #AgsRecallContainer + line="1410">the #AgsRecallContainer @@ -156083,12 +156405,12 @@ stopping playback. version="3.0.0"> Retrieve the recall channel run of container. + line="1428">Retrieve the recall channel run of container. the #AgsRecall + line="1434">the #AgsRecall @@ -156098,7 +156420,7 @@ stopping playback. transfer-ownership="none"> the #AgsRecallContainer + line="1430">the #AgsRecallContainer @@ -156551,7 +156873,7 @@ enable/disable as flags. c:type="AgsRecallFlags"> Enum values to control the behavior or indicate internal state of #AgsRecall by + line="58">Enum values to control the behavior or indicate internal state of #AgsRecall by enable/disable as flags. glib:name="AGS_RECALL_TEMPLATE"> is template + line="60">is template glib:name="AGS_RECALL_DEFAULT_TEMPLATE"> is default template + line="61">is default template glib:name="AGS_RECALL_HAS_OUTPUT_PORT"> has output port + line="62">has output port glib:name="AGS_RECALL_BYPASS"> don't apply effect processing + line="63">don't apply effect processing glib:name="AGS_RECALL_INITIAL_RUN"> initial run, first attack to audio data + line="64">initial run, first attack to audio data A #AgsRecallHandler-struct acts as a callback definition - + line="212">A #AgsRecallHandler-struct acts as a callback definition + the signal to listen + line="214">the signal to listen the callback to use + line="215">the callback to use user data to pass + line="216">user data to pass version="3.0.0"> Allocates #AgsRecallHandler-struct. - + line="4545">Allocates #AgsRecallHandler-struct. + the newly allocated #AgsRecallHandler-struct + line="4553">the newly allocated #AgsRecallHandler-struct signal's name to connect + line="4547">signal's name to connect the #GCallback function + line="4548">the #GCallback function the data to pass the callback + line="4549">the data to pass the callback @@ -156661,8 +156983,8 @@ enable/disable as flags. version="3.0.0"> Free @recall_hanlder. - + line="4525">Free @recall_hanlder. + @@ -156673,7 +156995,7 @@ enable/disable as flags. allow-none="1"> the #AgsRecallHandler-struct + line="4527">the #AgsRecallHandler-struct @@ -157110,7 +157432,7 @@ enable/disable as flags. c:type="AgsRecallNotifyDependencyMode"> Modes to notify of dependencies. + line="77">Modes to notify of dependencies. glib:name="AGS_RECALL_NOTIFY_RUN"> notify dependency as calling run + line="79">notify dependency as calling run glib:name="AGS_RECALL_NOTIFY_AUDIO"> notify dependency audio + line="80">notify dependency audio glib:name="AGS_RECALL_NOTIFY_AUDIO_RUN"> notifiy dependency audio run + line="81">notifiy dependency audio run glib:name="AGS_RECALL_NOTIFY_CHANNEL"> notifiy dependency channel + line="82">notifiy dependency channel glib:name="AGS_RECALL_NOTIFY_CHANNEL_RUN"> notifiy dependency channel run + line="83">notifiy dependency channel run glib:name="AGS_RECALL_NOTIFY_RECALL"> notifiy dependency recall + line="84">notifiy dependency recall version="3.9.6"> Compute Soundfont2 synth. + line="4878">Compute Soundfont2 synth. @@ -163634,7 +163956,7 @@ enable/disable as flags. the #AgsSF2SynthUtil-struct + line="4880">the #AgsSF2SynthUtil-struct @@ -163644,7 +163966,7 @@ enable/disable as flags. version="3.9.6"> Compute Soundfont2 synth of complex data. + line="4560">Compute Soundfont2 synth of complex data. @@ -163653,7 +163975,7 @@ enable/disable as flags. the #AgsSF2SynthUtil-struct + line="4562">the #AgsSF2SynthUtil-struct @@ -163663,7 +163985,7 @@ enable/disable as flags. version="3.9.6"> Compute Soundfont2 synth of double precision floating point data. + line="4243">Compute Soundfont2 synth of double precision floating point data. @@ -163672,7 +163994,7 @@ enable/disable as flags. the #AgsSF2SynthUtil-struct + line="4245">the #AgsSF2SynthUtil-struct @@ -163682,7 +164004,7 @@ enable/disable as flags. version="3.9.6"> Compute Soundfont2 synth of floating point data. + line="3926">Compute Soundfont2 synth of floating point data. @@ -163691,7 +164013,7 @@ enable/disable as flags. the #AgsSF2SynthUtil-struct + line="3928">the #AgsSF2SynthUtil-struct @@ -163701,7 +164023,7 @@ enable/disable as flags. version="3.9.6"> Compute Soundfont2 synth of signed 16 bit data. + line="2658">Compute Soundfont2 synth of signed 16 bit data. @@ -163710,7 +164032,7 @@ enable/disable as flags. the #AgsSF2SynthUtil-struct + line="2660">the #AgsSF2SynthUtil-struct @@ -163720,7 +164042,7 @@ enable/disable as flags. version="3.9.6"> Compute Soundfont2 synth of signed 24 bit data. + line="2975">Compute Soundfont2 synth of signed 24 bit data. @@ -163729,7 +164051,7 @@ enable/disable as flags. the #AgsSF2SynthUtil-struct + line="2977">the #AgsSF2SynthUtil-struct @@ -163739,7 +164061,7 @@ enable/disable as flags. version="3.9.6"> Compute Soundfont2 synth of signed 32 bit data. + line="3292">Compute Soundfont2 synth of signed 32 bit data. @@ -163748,7 +164070,7 @@ enable/disable as flags. the #AgsSF2SynthUtil-struct + line="3294">the #AgsSF2SynthUtil-struct @@ -163758,7 +164080,7 @@ enable/disable as flags. version="3.9.6"> Compute Soundfont2 synth of signed 64 bit data. + line="3609">Compute Soundfont2 synth of signed 64 bit data. @@ -163767,7 +164089,7 @@ enable/disable as flags. the #AgsSF2SynthUtil-struct + line="3611">the #AgsSF2SynthUtil-struct @@ -163777,7 +164099,7 @@ enable/disable as flags. version="3.9.6"> Compute Soundfont2 synth of signed 8 bit data. + line="2341">Compute Soundfont2 synth of signed 8 bit data. @@ -163786,7 +164108,7 @@ enable/disable as flags. the #AgsSF2SynthUtil-struct + line="2343">the #AgsSF2SynthUtil-struct @@ -165026,37 +165348,37 @@ enable/disable as flags. version="3.4.0"> Find sample near MIDI key. + line="4940">Find sample near MIDI key. the #AgsIpatchSample + line="4952">the #AgsIpatchSample the #AgsIpatch + line="4942">the #AgsIpatch the bank + line="4943">the bank the program + line="4944">the program the MIDI key + line="4945">the MIDI key transfer-ownership="full"> the preset + line="4946">the preset transfer-ownership="full"> the instrument + line="4947">the instrument transfer-ownership="full"> the sample + line="4948">the sample @@ -170948,7 +171270,7 @@ found %NULL. - + @@ -173201,7 +173523,7 @@ able to handle matching scope. c:type="AgsSoundKeyFormat"> Enum values to specify key format. + line="182">Enum values to specify key format. glib:name="AGS_SOUND_KEY_FORMAT_16TH"> key format 16th + line="184">key format 16th glib:name="AGS_SOUND_KEY_FORMAT_256TH"> key format 256th + line="185">key format 256th c:type="AgsSoundStateFlags"> Enum values to indicate state. + line="160">Enum values to indicate state. glib:name="AGS_SOUND_STATE_IS_ACTIVE"> is active + line="163">is active glib:name="AGS_SOUND_STATE_IS_PROCESSING"> is processing + line="164">is processing glib:name="AGS_SOUND_STATE_IS_TERMINATING"> is terminating + line="165">is terminating + + + + + + + + + + + + + + + + + + + Calc next note 256th offset of @soundcard. + + + + + + + the #GObject sub-type implementing #AgsSoundcard + + + + the return location of note 256th offset lower + + + + the return location of note 256th offset upper + + + + Offset of @soundcard to system time. + line="500">Offset of @soundcard to system time. the system time + line="506">the system time the #GObject sub-type implementing #AgsSoundcard + line="502">the #GObject sub-type implementing #AgsSoundcard @@ -176263,19 +176640,19 @@ found %NULL. version="5.0.0"> Offset of @soundcard to system time. + line="536">Offset of @soundcard to system time. the system time + line="542">the system time the #GObject sub-type implementing #AgsSoundcard + line="538">the #GObject sub-type implementing #AgsSoundcard @@ -176285,19 +176662,19 @@ found %NULL. version="5.0.0"> Offset of @soundcard to system time. + line="571">Offset of @soundcard to system time. the system time + line="577">the system time the #GObject sub-type implementing #AgsSoundcard + line="573">the #GObject sub-type implementing #AgsSoundcard @@ -184696,13 +185073,13 @@ enable/disable as flags. version="3.0.0"> Creates a new instance of #AgsWasapiDevin. + line="3827">Creates a new instance of #AgsWasapiDevin. a new #AgsWasapiDevin + line="3832">a new #AgsWasapiDevin @@ -184716,7 +185093,7 @@ enable/disable as flags. version="3.0.0"> Calculate delay and attack and reset it. + line="3696">Calculate delay and attack and reset it. @@ -184726,7 +185103,7 @@ enable/disable as flags. the #AgsWasapiDevin + line="3698">the #AgsWasapiDevin @@ -184736,7 +185113,7 @@ enable/disable as flags. version="3.0.0"> Reallocate the internal audio buffer. + line="3714">Reallocate the internal audio buffer. @@ -184746,7 +185123,7 @@ enable/disable as flags. the #AgsWasapiDevin + line="3716">the #AgsWasapiDevin @@ -184782,7 +185159,7 @@ enable/disable as flags. version="3.0.0"> The buffer flag indicates the currently played buffer. + line="3652">The buffer flag indicates the currently played buffer. @@ -184792,7 +185169,7 @@ enable/disable as flags. an #AgsWasapiDevin + line="3654">an #AgsWasapiDevin @@ -185225,13 +185602,13 @@ enable/disable as flags. version="3.0.0"> Creates a new instance of #AgsWasapiDevout. + line="3989">Creates a new instance of #AgsWasapiDevout. a new #AgsWasapiDevout + line="3994">a new #AgsWasapiDevout @@ -185246,7 +185623,7 @@ enable/disable as flags. version="3.0.0"> Calculate delay and attack and reset it. + line="3858">Calculate delay and attack and reset it. @@ -185256,7 +185633,7 @@ enable/disable as flags. the #AgsWasapiDevout + line="3860">the #AgsWasapiDevout @@ -185266,7 +185643,7 @@ enable/disable as flags. version="3.0.0"> Reallocate the internal audio buffer. + line="3876">Reallocate the internal audio buffer. @@ -185276,7 +185653,7 @@ enable/disable as flags. the #AgsWasapiDevout + line="3878">the #AgsWasapiDevout @@ -185312,7 +185689,7 @@ enable/disable as flags. version="3.0.0"> The buffer flag indicates the currently played buffer. + line="3814">The buffer flag indicates the currently played buffer. @@ -185322,7 +185699,7 @@ enable/disable as flags. an #AgsWasapiDevout + line="3816">an #AgsWasapiDevout @@ -187430,7 +187807,7 @@ by offset x. #AgsAlsaDevout represents a soundcard and supports output. + line="192">#AgsAlsaDevout represents a soundcard and supports output. The #AgsFxNotationAudioProcessor class provides ports to the effect processor. + line="80">The #AgsFxNotationAudioProcessor class provides ports to the effect processor. The #AgsFxPatternAudioProcessor class provides ports to the effect processor. + line="72">The #AgsFxPatternAudioProcessor class provides ports to the effect processor. #AgsRecall acts as effect processor. It depends on staging program from #AgsAudioThread and #AgsChannelThread + line="117">#AgsRecall acts as effect processor. It depends on staging program from #AgsAudioThread and #AgsChannelThread what signals are invoked. ags-fx staging does actually only run duplicate and intialization of a recall: @@ -197209,31 +197586,31 @@ See SLIP (RFC1055). version="3.0.0"> Allocates #AgsRecallHandler-struct. - + line="4545">Allocates #AgsRecallHandler-struct. + the newly allocated #AgsRecallHandler-struct + line="4553">the newly allocated #AgsRecallHandler-struct signal's name to connect + line="4547">signal's name to connect the #GCallback function + line="4548">the #GCallback function the data to pass the callback + line="4549">the data to pass the callback @@ -197244,8 +197621,8 @@ See SLIP (RFC1055). version="3.0.0"> Free @recall_hanlder. - + line="4525">Free @recall_hanlder. + @@ -197256,7 +197633,7 @@ See SLIP (RFC1055). allow-none="1"> the #AgsRecallHandler-struct + line="4527">the #AgsRecallHandler-struct @@ -197320,37 +197697,37 @@ See SLIP (RFC1055). version="3.4.0"> Find sample near MIDI key. + line="4940">Find sample near MIDI key. the #AgsIpatchSample + line="4952">the #AgsIpatchSample the #AgsIpatch + line="4942">the #AgsIpatch the bank + line="4943">the bank the program + line="4944">the program the MIDI key + line="4945">the MIDI key transfer-ownership="full"> the preset + line="4946">the preset transfer-ownership="full"> the instrument + line="4947">the instrument transfer-ownership="full"> the sample + line="4948">the sample @@ -197417,25 +197794,82 @@ See SLIP (RFC1055). + + + + + + + + + + + + + + + + + + + Calc next note 256th offset of @soundcard. + + + + + + + the #GObject sub-type implementing #AgsSoundcard + + + + the return location of note 256th offset lower + + + + the return location of note 256th offset upper + + + + Offset of @soundcard to system time. + line="500">Offset of @soundcard to system time. the system time + line="506">the system time the #GObject sub-type implementing #AgsSoundcard + line="502">the #GObject sub-type implementing #AgsSoundcard @@ -197446,19 +197880,19 @@ See SLIP (RFC1055). version="5.0.0"> Offset of @soundcard to system time. + line="536">Offset of @soundcard to system time. the system time + line="542">the system time the #GObject sub-type implementing #AgsSoundcard + line="538">the #GObject sub-type implementing #AgsSoundcard @@ -197469,19 +197903,19 @@ See SLIP (RFC1055). version="5.0.0"> Offset of @soundcard to system time. + line="571">Offset of @soundcard to system time. the system time + line="577">the system time the #GObject sub-type implementing #AgsSoundcard + line="573">the #GObject sub-type implementing #AgsSoundcard diff --git a/girs/AgsGui-6.0.gir b/girs/AgsGui-6.0.gir index 3c98d647f..79f4b97da 100644 --- a/girs/AgsGui-6.0.gir +++ b/girs/AgsGui-6.0.gir @@ -8,6 +8,7 @@ and/or use gtk-doc annotations. --> xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> + Create a new instance of #AgsCartesian + line="5626">Create a new instance of #AgsCartesian the new #AgsCartesian + line="5631">the new #AgsCartesian @@ -217,25 +218,25 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Perform linear step conversion. + line="5236">Perform linear step conversion. the converted step value + line="5244">the converted step value current step value + line="5238">current step value is abscissae + line="5239">is abscissae allow-none="1"> the data + line="5240">the data @@ -254,7 +255,7 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Perform linear translation. + line="5265">Perform linear translation. @@ -263,13 +264,13 @@ and/or use gtk-doc annotations. --> the x position + line="5267">the x position the y position + line="5268">the y position transfer-ownership="full"> the return location of translated x + line="5269">the return location of translated x transfer-ownership="full"> the return location of transloated y + line="5270">the return location of transloated y allow-none="1"> the #AgsCartesian + line="5271">the #AgsCartesian @@ -306,19 +307,19 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Labeling function of x big scale + line="5329">Labeling function of x big scale the matching scale value + line="5336">the matching scale value the value + line="5331">the value allow-none="1"> the #AgsCartesian + line="5332">the #AgsCartesian @@ -337,19 +338,19 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Format x label @value appropriately. + line="5398">Format x label @value appropriately. the formatted string + line="5405">the formatted string the value + line="5400">the value allow-none="1"> the #AgsCartesian + line="5401">the #AgsCartesian @@ -368,19 +369,19 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Labeling function of x small scale + line="5306">Labeling function of x small scale the matching scale value + line="5313">the matching scale value the value + line="5308">the value allow-none="1"> the #AgsCartesian + line="5309">the #AgsCartesian @@ -399,19 +400,19 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Labeling function of y big scale + line="5375">Labeling function of y big scale the matching scale value + line="5382">the matching scale value the value + line="5377">the value allow-none="1"> the #AgsCartesian + line="5378">the #AgsCartesian @@ -430,19 +431,19 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Format y label @value appropriately. + line="5434">Format y label @value appropriately. the formatted string + line="5441">the formatted string the value + line="5436">the value allow-none="1"> the #AgsCartesian + line="5437">the #AgsCartesian @@ -461,19 +462,19 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Labeling function of y small scale + line="5352">Labeling function of y small scale the matching scale value + line="5359">the matching scale value the value + line="5354">the value allow-none="1"> the #AgsCartesian + line="5355">the #AgsCartesian @@ -492,7 +493,7 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Add @plot to @cartesian. + line="3251">Add @plot to @cartesian. @@ -501,7 +502,7 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3253">the #AgsCartesian allow-none="1"> the #AgsPlot-struct + line="3254">the #AgsPlot-struct @@ -520,7 +521,7 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Fill x label if @do_x_label, otherwise y label. + line="5574">Fill x label if @do_x_label, otherwise y label. @@ -529,13 +530,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="5576">the #AgsCartesian do x label + line="5577">do x label @@ -546,19 +547,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get center of @cartesian. + line="3389">Get center of @cartesian. the center + line="3395">the center the #AgsCartesian + line="3391">the #AgsCartesian @@ -569,19 +570,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get font size of @cartesian. + line="3533">Get font size of @cartesian. the font size + line="3539">the font size the #AgsCartesian + line="3535">the #AgsCartesian @@ -592,19 +593,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get line width of @cartesian. + line="3437">Get line width of @cartesian. the line width + line="3443">the line width the #AgsCartesian + line="3439">the #AgsCartesian @@ -615,19 +616,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get point radius. + line="3485">Get point radius. the point radius + line="3491">the point radius the #AgsCartesian + line="3487">the #AgsCartesian @@ -638,19 +639,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get cairo surface of @cartesian. + line="5211">Get cairo surface of @cartesian. the cairo surface + line="5217">the cairo surface the #AgsCartesian + line="5213">the #AgsCartesian @@ -661,19 +662,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x big scale factor of @cartesian. + line="4875">Get x big scale factor of @cartesian. the x big factor + line="4881">the x big factor the #AgsCartesian + line="4877">the #AgsCartesian @@ -684,19 +685,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x end of @cartesian. + line="4395">Get x end of @cartesian. the x end + line="4401">the x end the #AgsCartesian + line="4397">the #AgsCartesian @@ -707,12 +708,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x label of @cartesian. + line="4635">Get x label of @cartesian. the x label + line="4641">the x label @@ -721,7 +722,7 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4637">the #AgsCartesian @@ -732,19 +733,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x label factor of @cartesian. + line="5019">Get x label factor of @cartesian. the x label factor + line="5025">the x label factor the #AgsCartesian + line="5021">the #AgsCartesian @@ -755,19 +756,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x label precision of @cartesian. + line="5067">Get x label precision of @cartesian. the x label precision + line="5073">the x label precision the #AgsCartesian + line="5069">the #AgsCartesian @@ -778,19 +779,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x label start of @cartesian. + line="4059">Get x label start of @cartesian. the x label start + line="4065">the x label start the #AgsCartesian + line="4061">the #AgsCartesian @@ -801,19 +802,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x label step width. + line="4107">Get x label step width. the x label step width + line="4113">the x label step width the #AgsCartesian + line="4109">the #AgsCartesian @@ -824,19 +825,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x margin of @cartesian. + line="3293">Get x margin of @cartesian. the x margin + line="3299">the x margin the #AgsCartesian + line="3295">the #AgsCartesian @@ -847,19 +848,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x scale step width of @cartesian. + line="3677">Get x scale step width of @cartesian. the x scale step width + line="3683">the x scale step width the #AgsCartesian + line="3679">the #AgsCartesian @@ -870,19 +871,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x small scale factor of @cartesian. + line="4827">Get x small scale factor of @cartesian. the x small factor + line="4833">the x small factor the #AgsCartesian + line="4829">the #AgsCartesian @@ -893,19 +894,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x start of @cartesian. + line="4347">Get x start of @cartesian. the x start + line="4353">the x start the #AgsCartesian + line="4349">the #AgsCartesian @@ -916,19 +917,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x step of @cartesian. + line="4251">Get x step of @cartesian. the x step + line="4257">the x step the #AgsCartesian + line="4253">the #AgsCartesian @@ -939,19 +940,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x step factor of @cartesian. + line="4731">Get x step factor of @cartesian. the x step factor + line="4737">the x step factor the #AgsCartesian + line="4733">the #AgsCartesian @@ -962,19 +963,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x step width of @cartesian. + line="3581">Get x step width of @cartesian. the x step width + line="3587">the x step width the #AgsCartesian + line="3583">the #AgsCartesian @@ -985,19 +986,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x unit of @cartesian. + line="4539">Get x unit of @cartesian. the x unit + line="4545">the x unit the #AgsCartesian + line="4541">the #AgsCartesian @@ -1008,19 +1009,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x unit size of @cartesian. + line="3869">Get x unit size of @cartesian. the x unit size + line="3875">the x unit size the #AgsCartesian + line="3871">the #AgsCartesian @@ -1031,19 +1032,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x unit x0 of @cartesian. + line="3773">Get x unit x0 of @cartesian. the x unit x0 + line="3779">the x unit x0 the #AgsCartesian + line="3775">the #AgsCartesian @@ -1054,19 +1055,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get x unit y0 of @cartesian. + line="3821">Get x unit y0 of @cartesian. the x unit y0 + line="3827">the x unit y0 the #AgsCartesian + line="3823">the #AgsCartesian @@ -1077,19 +1078,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y big scale factor of @cartesian. + line="4971">Get y big scale factor of @cartesian. the y big factor + line="4977">the y big factor the #AgsCartesian + line="4973">the #AgsCartesian @@ -1100,19 +1101,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y end of @cartesian. + line="4491">Get y end of @cartesian. the y end + line="4497">the y end the #AgsCartesian + line="4493">the #AgsCartesian @@ -1123,12 +1124,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y label of @cartesian. + line="4683">Get y label of @cartesian. the y label + line="4689">the y label @@ -1137,7 +1138,7 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4685">the #AgsCartesian @@ -1148,19 +1149,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y label factor of @cartesian. + line="5115">Get y label factor of @cartesian. the y label factor + line="5121">the y label factor the #AgsCartesian + line="5117">the #AgsCartesian @@ -1171,19 +1172,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y label precision of @cartesian. + line="5163">Get y label precision of @cartesian. the y label precision + line="5169">the y label precision the #AgsCartesian + line="5165">the #AgsCartesian @@ -1194,19 +1195,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y label start of @cartesian. + line="4155">Get y label start of @cartesian. the y label start + line="4161">the y label start the #AgsCartesian + line="4157">the #AgsCartesian @@ -1217,19 +1218,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y label step height of @cartesian. + line="4203">Get y label step height of @cartesian. the y label step height + line="4209">the y label step height the #AgsCartesian + line="4205">the #AgsCartesian @@ -1240,19 +1241,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y margin of @cartesian. + line="3341">Get y margin of @cartesian. the y margin + line="3347">the y margin the #AgsCartesian + line="3343">the #AgsCartesian @@ -1263,19 +1264,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y scale step height of @cartesian. + line="3725">Get y scale step height of @cartesian. the y scale step height + line="3731">the y scale step height the #AgsCartesian + line="3727">the #AgsCartesian @@ -1286,19 +1287,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y small scale factor of @cartesian. + line="4923">Get y small scale factor of @cartesian. the y small factor + line="4929">the y small factor the #AgsCartesian + line="4925">the #AgsCartesian @@ -1309,19 +1310,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y start of @cartesian. + line="4443">Get y start of @cartesian. the y start + line="4449">the y start the #AgsCartesian + line="4445">the #AgsCartesian @@ -1332,19 +1333,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y step of @cartesian. + line="4299">Get y step of @cartesian. the y step + line="4305">the y step the #AgsCartesian + line="4301">the #AgsCartesian @@ -1355,19 +1356,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y step factor of @cartesian. + line="4779">Get y step factor of @cartesian. the y step factor + line="4785">the y step factor the #AgsCartesian + line="4781">the #AgsCartesian @@ -1378,19 +1379,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y step height. + line="3629">Get y step height. the y step height + line="3635">the y step height the #AgsCartesian + line="3631">the #AgsCartesian @@ -1401,19 +1402,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y unit of @cartesian. + line="4587">Get y unit of @cartesian. the y unit + line="4593">the y unit the #AgsCartesian + line="4589">the #AgsCartesian @@ -1424,19 +1425,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y unit size of @cartesian. + line="4011">Get y unit size of @cartesian. the y unit size + line="4017">the y unit size the #AgsCartesian + line="4013">the #AgsCartesian @@ -1447,19 +1448,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y unit x0 of @cartesian. + line="3917">Get y unit x0 of @cartesian. the y unit x0 + line="3923">the y unit x0 the #AgsCartesian + line="3919">the #AgsCartesian @@ -1470,7 +1471,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get y unit y0 of @cartesian. + line="3965">Get y unit y0 of @cartesian. @@ -1479,7 +1480,7 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3967">the #AgsCartesian @@ -1489,7 +1490,7 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Reallocate x label if @do_x_label, otherwise y label. + line="5470">Reallocate x label if @do_x_label, otherwise y label. @@ -1498,13 +1499,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="5472">the #AgsCartesian do x label + line="5473">do x label @@ -1514,7 +1515,7 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Remove @plot from @cartesian. + line="3272">Remove @plot from @cartesian. @@ -1523,7 +1524,7 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3274">the #AgsCartesian allow-none="1"> the #AgsPlot-struct + line="3275">the #AgsPlot-struct @@ -1543,7 +1544,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set center of @cartesian. + line="3415">Set center of @cartesian. @@ -1552,13 +1553,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3417">the #AgsCartesian the center + line="3418">the center @@ -1569,7 +1570,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set font size of @cartesian. + line="3559">Set font size of @cartesian. @@ -1578,13 +1579,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3561">the #AgsCartesian the font size + line="3562">the font size @@ -1595,7 +1596,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set line width of @cartesian. + line="3463">Set line width of @cartesian. @@ -1604,13 +1605,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3465">the #AgsCartesian the line width + line="3466">the line width @@ -1621,7 +1622,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set point radius. + line="3511">Set point radius. @@ -1630,13 +1631,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3513">the #AgsCartesian the point radius + line="3514">the point radius @@ -1647,7 +1648,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x big scale factor of @cartesian. + line="4901">Set x big scale factor of @cartesian. @@ -1656,13 +1657,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4903">the #AgsCartesian the x big scale factor + line="4904">the x big scale factor @@ -1673,7 +1674,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x end of @cartesian. + line="4421">Set x end of @cartesian. @@ -1682,13 +1683,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4423">the #AgsCartesian the x end + line="4424">the x end @@ -1699,7 +1700,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x label of @cartesian. + line="4659">Set x label of @cartesian. @@ -1708,13 +1709,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4661">the #AgsCartesian the x label + line="4662">the x label @@ -1725,7 +1726,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x label factor of @cartesian. + line="5045">Set x label factor of @cartesian. @@ -1734,13 +1735,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="5047">the #AgsCartesian the x label factor + line="5048">the x label factor @@ -1751,7 +1752,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x label precision of @cartesian. + line="5093">Set x label precision of @cartesian. @@ -1760,13 +1761,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="5095">the #AgsCartesian the x label precision + line="5096">the x label precision @@ -1777,7 +1778,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x label start of @cartesian. + line="4085">Set x label start of @cartesian. @@ -1786,13 +1787,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4087">the #AgsCartesian the x label start + line="4088">the x label start @@ -1803,7 +1804,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x label step width of @cartesian. + line="4133">Set x label step width of @cartesian. @@ -1812,13 +1813,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4135">the #AgsCartesian the x label step width + line="4136">the x label step width @@ -1829,7 +1830,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x margin of @cartesian. + line="3319">Set x margin of @cartesian. @@ -1838,13 +1839,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3321">the #AgsCartesian the x margin + line="3322">the x margin @@ -1855,7 +1856,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x scale step width of @cartesian. + line="3703">Set x scale step width of @cartesian. @@ -1864,13 +1865,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3705">the #AgsCartesian the x scale step width + line="3706">the x scale step width @@ -1881,7 +1882,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x small scale factor of @cartesian. + line="4853">Set x small scale factor of @cartesian. @@ -1890,13 +1891,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4855">the #AgsCartesian the x small scale factor + line="4856">the x small scale factor @@ -1907,7 +1908,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x start of @cartesian. + line="4373">Set x start of @cartesian. @@ -1916,13 +1917,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4375">the #AgsCartesian the x start + line="4376">the x start @@ -1933,7 +1934,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x step of @cartesian. + line="4277">Set x step of @cartesian. @@ -1942,13 +1943,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4279">the #AgsCartesian the x step + line="4280">the x step @@ -1959,7 +1960,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x step factor of @cartesian. + line="4757">Set x step factor of @cartesian. @@ -1968,13 +1969,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4759">the #AgsCartesian the x step factor + line="4760">the x step factor @@ -1985,7 +1986,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x step width of @cartesian. + line="3607">Set x step width of @cartesian. @@ -1994,13 +1995,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3609">the #AgsCartesian the x step width + line="3610">the x step width @@ -2011,7 +2012,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x unit of @cartesian. + line="4565">Set x unit of @cartesian. @@ -2020,13 +2021,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4567">the #AgsCartesian the x unit + line="4568">the x unit @@ -2037,7 +2038,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x unit size of @cartesian. + line="3895">Set x unit size of @cartesian. @@ -2046,13 +2047,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3897">the #AgsCartesian the x unit size + line="3898">the x unit size @@ -2063,7 +2064,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x unit x0 of @cartesian. + line="3799">Set x unit x0 of @cartesian. @@ -2072,13 +2073,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3801">the #AgsCartesian the x unit x0 + line="3802">the x unit x0 @@ -2089,7 +2090,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set x unit y0 of @cartesian. + line="3847">Set x unit y0 of @cartesian. @@ -2098,13 +2099,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3849">the #AgsCartesian the x unit y0 + line="3850">the x unit y0 @@ -2115,7 +2116,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y big scale factor of @cartesian. + line="4997">Set y big scale factor of @cartesian. @@ -2124,13 +2125,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4999">the #AgsCartesian the y big scale factor + line="5000">the y big scale factor @@ -2141,7 +2142,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y end of @cartesian. + line="4517">Set y end of @cartesian. @@ -2150,13 +2151,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4519">the #AgsCartesian the y end + line="4520">the y end @@ -2167,7 +2168,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y label of @cartesian. + line="4707">Set y label of @cartesian. @@ -2176,13 +2177,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4709">the #AgsCartesian the y label + line="4710">the y label @@ -2193,7 +2194,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y label factor of @cartesian. + line="5141">Set y label factor of @cartesian. @@ -2202,13 +2203,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="5143">the #AgsCartesian the y label factor + line="5144">the y label factor @@ -2219,7 +2220,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y label precision of @cartesian. + line="5189">Set y label precision of @cartesian. @@ -2228,13 +2229,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="5191">the #AgsCartesian the y label precision + line="5192">the y label precision @@ -2245,7 +2246,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y label start of @cartesian. + line="4181">Set y label start of @cartesian. @@ -2254,13 +2255,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4183">the #AgsCartesian the y label start + line="4184">the y label start @@ -2271,7 +2272,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y label step height of @cartesian. + line="4229">Set y label step height of @cartesian. @@ -2280,13 +2281,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4231">the #AgsCartesian the y label step height + line="4232">the y label step height @@ -2297,7 +2298,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y margin of @cartesian. + line="3367">Set y margin of @cartesian. @@ -2306,13 +2307,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3369">the #AgsCartesian the y margin + line="3370">the y margin @@ -2323,7 +2324,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y scale step height of @cartesian. + line="3751">Set y scale step height of @cartesian. @@ -2332,13 +2333,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3753">the #AgsCartesian the y scale step height + line="3754">the y scale step height @@ -2349,7 +2350,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y small scale factor of @cartesian. + line="4949">Set y small scale factor of @cartesian. @@ -2358,13 +2359,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4951">the #AgsCartesian the y small scale factor + line="4952">the y small scale factor @@ -2375,7 +2376,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y start of @cartesian. + line="4469">Set y start of @cartesian. @@ -2384,13 +2385,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4471">the #AgsCartesian the y start + line="4472">the y start @@ -2401,7 +2402,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y step of @cartesian. + line="4325">Set y step of @cartesian. @@ -2410,13 +2411,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4327">the #AgsCartesian the y step + line="4328">the y step @@ -2427,7 +2428,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y step factor of @cartesian. + line="4805">Set y step factor of @cartesian. @@ -2436,13 +2437,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4807">the #AgsCartesian the y step factor + line="4808">the y step factor @@ -2453,7 +2454,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y step height of @cartesian. + line="3655">Set y step height of @cartesian. @@ -2462,13 +2463,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3657">the #AgsCartesian the y step height + line="3658">the y step height @@ -2479,7 +2480,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y unit of @cartesian. + line="4613">Set y unit of @cartesian. @@ -2488,13 +2489,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4615">the #AgsCartesian the y unit + line="4616">the y unit @@ -2505,7 +2506,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y unit size of @cartesian. + line="4037">Set y unit size of @cartesian. @@ -2514,13 +2515,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="4039">the #AgsCartesian the y unit size + line="4040">the y unit size @@ -2531,7 +2532,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y unit x0 of @cartesian. + line="3943">Set y unit x0 of @cartesian. @@ -2540,13 +2541,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3945">the #AgsCartesian the y unit x0 + line="3946">the y unit x0 @@ -2557,7 +2558,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set y unit y0 of @cartesian. + line="3989">Set y unit y0 of @cartesian. @@ -2566,13 +2567,13 @@ and/or use gtk-doc annotations. --> the #AgsCartesian + line="3991">the #AgsCartesian the y unit y0 + line="3992">the y unit y0 @@ -3662,12 +3663,12 @@ and/or use gtk-doc annotations. --> Creates an #AgsDial + line="2353">Creates an #AgsDial a new #AgsDial + line="2358">a new #AgsDial @@ -3676,7 +3677,7 @@ and/or use gtk-doc annotations. --> version="3.0.0"> draws the widget + line="2272">draws the widget @@ -3685,7 +3686,7 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="2274">the #AgsDial @@ -3696,19 +3697,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get adjustment of @dial. + line="2244">Get adjustment of @dial. the #GtkAdjustment + line="2250">the #GtkAdjustment the #AgsDial + line="2246">the #AgsDial @@ -3719,19 +3720,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get button height of @dial. + line="2100">Get button height of @dial. the button height + line="2106">the button height the #AgsDial + line="2102">the #AgsDial @@ -3742,19 +3743,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get button width of @dial. + line="2052">Get button width of @dial. the button width + line="2058">the button width the #AgsDial + line="2054">the #AgsDial @@ -3765,19 +3766,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get font size of @dial. + line="2004">Get font size of @dial. the font size + line="2010">the font size the #AgsDial + line="2006">the #AgsDial @@ -3788,19 +3789,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get margin_left of @dial. + line="2148">Get margin_left of @dial. the margin left + line="2154">the margin left the #AgsDial + line="2150">the #AgsDial @@ -3811,19 +3812,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get margin right of @dial. + line="2196">Get margin right of @dial. the margin right + line="2202">the margin right the #AgsDial + line="2198">the #AgsDial @@ -3834,19 +3835,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get outline strength of @dial. + line="1908">Get outline strength of @dial. the outline _strength + line="1914">the outline _strength the #AgsDial + line="1910">the #AgsDial @@ -3857,19 +3858,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get radius of @dial. + line="1860">Get radius of @dial. the radius + line="1866">the radius the #AgsDial + line="1862">the #AgsDial @@ -3880,19 +3881,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get scale precision of @dial. + line="1956">Get scale precision of @dial. the scale precision + line="1962">the scale precision the #AgsDial + line="1958">the #AgsDial @@ -3902,19 +3903,19 @@ and/or use gtk-doc annotations. --> version="3.14.0"> Get value + line="2333">Get value the value + line="2339">the value the #AgsDial + line="2335">the #AgsDial @@ -3925,7 +3926,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set adjustment of @dial. + line="2222">Set adjustment of @dial. @@ -3934,13 +3935,13 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="2224">the #AgsDial the #GtkAdjustment + line="2225">the #GtkAdjustment @@ -3951,7 +3952,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set button height of @dial. + line="2078">Set button height of @dial. @@ -3960,13 +3961,13 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="2080">the #AgsDial the button height + line="2081">the button height @@ -3977,7 +3978,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set button width of @dial. + line="2030">Set button width of @dial. @@ -3986,13 +3987,13 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="2032">the #AgsDial the button width + line="2033">the button width @@ -4003,7 +4004,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set font size of @dial. + line="1982">Set font size of @dial. @@ -4012,13 +4013,13 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="1984">the #AgsDial the font size + line="1985">the font size @@ -4029,7 +4030,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set margin left of @dial. + line="2126">Set margin left of @dial. @@ -4038,13 +4039,13 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="2128">the #AgsDial the margin left + line="2129">the margin left @@ -4055,7 +4056,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set margin right of @dial. + line="2174">Set margin right of @dial. @@ -4064,13 +4065,13 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="2176">the #AgsDial the margin right + line="2177">the margin right @@ -4081,7 +4082,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set outline strength of @dial. + line="1886">Set outline strength of @dial. @@ -4090,13 +4091,13 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="1888">the #AgsDial the outline strength + line="1889">the outline strength @@ -4107,7 +4108,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set radius of @dial. + line="1838">Set radius of @dial. @@ -4116,13 +4117,13 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="1840">the #AgsDial the radius + line="1841">the radius @@ -4133,7 +4134,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set scale precision of @dial. + line="1934">Set scale precision of @dial. @@ -4142,13 +4143,13 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="1936">the #AgsDial the scale precision + line="1937">the scale precision @@ -4158,7 +4159,7 @@ and/or use gtk-doc annotations. --> version="3.0.0"> Set value + line="2309">Set value @@ -4167,13 +4168,13 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="2311">the #AgsDial the value to set + line="2312">the value to set @@ -4183,7 +4184,7 @@ and/or use gtk-doc annotations. --> version="3.0.0"> draws the widget + line="2272">draws the widget @@ -4192,7 +4193,7 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="2274">the #AgsDial @@ -4391,7 +4392,7 @@ and/or use gtk-doc annotations. --> the #AgsDial + line="2274">the #AgsDial @@ -4994,6 +4995,1764 @@ and/or use gtk-doc annotations. --> c:identifier="AGS_EXPANDER_SET_DRAW_RIGHT_CONNECTOR"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new instance of #AgsFileDialog. + + + the new #AgsFileDialog + + + + + the #GtkWidget transient-for + + + + the window title + + + + + + Response @file_dialog due to user action. + + + + + + + the #AgsFileDialog + + + + the response id + + + + + + + + + + + + + + + + + Response @file_dialog due to user action. + + + + + + + the #AgsFileDialog + + + + the response id + + + + + + + + + + + + + + + + + + + + + + + + The ::response signal notifies about window interaction. + + + + + + + + + + + + + + + + + + + + + + + + the #AgsFileDialog + + + + the response id + + + + + + + + + + + + + + Creates a new instance of #AgsFileWidget. + + + the new #AgsFileWidget + + + + + Create directory @dir_path. + + + + + + + the #AgsFileWidget + + + + the directory path + + + + + + Refresh @file_widget due to current path change. + + + + + + + the #AgsFileWidget + + + + + + Add @bookmark_location to bookmark with @button_text. + + + + + + + the #AgsFileWidget + + + + the bookmark location + + + + + + Add @button_action to location with @button_text. + + + + + + + the #AgsFileWidget + + + + the button action + + + + the button text + + + + + + Create directory @dir_path. + + + + + + + the #AgsFileWidget + + + + the directory path + + + + + + Get app generic path of @file_widget. + + + the app generic path as string + + + + + the #AgsFileWidget + + + + + + Get app home path of @file_widget. + + + the app home path as string + + + + + the #AgsFileWidget + + + + + + Get bookmark from @file_widget. + + + the bookmark #GHashTable + + + + + + + + the #AgsFileWidget + + + + + + Get bookmark filename of @file_widget. + + + the bookmark filename as string + + + + + the #AgsFileWidget + + + + + + Get current path of @file_widget. + + + the current path as string + + + + + the #AgsFileWidget + + + + + + Get default bundle of @file_widget. + + + the default bundle as string + + + + + the #AgsFileWidget + + + + + + Get default path of @file_widget. + + + the default path as string + + + + + the #AgsFileWidget + + + + + + + + + + + + + + + + + + + Get file magic executable of @file_widget. + + + the file magic executable as string + + + + + the #AgsFileWidget + + + + + + Get filename of @file_widget. + + + the filename as string + + + + + the #AgsFileWidget + + + + + + Get filenames of @file_widget. + + + the filename as string + + + + + + + the #AgsFileWidget + + + + + + Get home path of @file_widget. + + + the home path as string + + + + + the #AgsFileWidget + + + + + + Get location from @file_widget. + + + the location #GHashTable + + + + + + + + the #AgsFileWidget + + + + + + Get recently used from @file_widget. + + + the recently used string vector + + + + + + + the #AgsFileWidget + + + + the string vector length + + + + + + Get recently used filename of @file_widget. + + + the home path as string + + + + + the #AgsFileWidget + + + + + + Read bookmarks from bookmark-filename. + + + + + + + the #AgsFileWidget + + + + + + Read recently-used from recently-used-filename. + + + + + + + the #AgsFileWidget + + + + + + Refresh @file_widget due to current path change. + + + + + + + the #AgsFileWidget + + + + + + Remove @bookmark_location from bookmark with @button_text. + + + + + + + the #AgsFileWidget + + + + the bookmark location + + + + + + Remove @button_action from location with @button_text. + + + + + + + the #AgsFileWidget + + + + the button action + + + + + + Set @app_generic_path of @file_widget. + + + + + + + the #AgsFileWidget + + + + the app generic path + + + + + + Set @app_home_path of @file_widget. + + + + + + + the #AgsFileWidget + + + + the app home path + + + + + + Set @bookmark_filename of @file_widget. + + + + + + + the #AgsFileWidget + + + + the bookmark filename + + + + + + Set @current_path of @file_widget. + + + + + + + the #AgsFileWidget + + + + the current path + + + + + + Set @default_bundle of @file_widget. + + + + + + + the #AgsFileWidget + + + + the default bundle + + + + + + Set @default_path of @file_widget. + + + + + + + the #AgsFileWidget + + + + the default path + + + + + + Set @file_action of @file_widget. + + + + + + + the #AgsFileWidget + + + + the file action + + + + + + Set @file_filter of @file_widget. + + + + + + + the #AgsFileWidget + + + + the file filter + + + + + + Set @file_magic_executable of @file_widget. + + + + + + + the #AgsFileWidget + + + + the file magic executable + + + + + + Set @flags of @file_widget. + + + + + + + the #AgsFileWidget + + + + the flags + + + + + + Set @home_path of @file_widget. + + + + + + + the #AgsFileWidget + + + + the home path + + + + + + Set @recently_used_filename of @file_widget. + + + + + + + the #AgsFileWidget + + + + the recently used filename + + + + + + Test @file_action of @file_widget. + + + %TRUE if file action matches, otherwise %FALSE + + + + + the #AgsFileWidget + + + + the file action + + + + + + Test @file_filter of @file_widget. + + + %TRUE if file filter matches, otherwise %FALSE + + + + + the #AgsFileWidget + + + + the file filter + + + + + + Test @flags of @file_widget. + + + %TRUE if flags set, otherwise %FALSE + + + + + the #AgsFileWidget + + + + the flags + + + + + + Set @flags of @file_widget. + + + + + + + the #AgsFileWidget + + + + the flags + + + + + + Write bookmarks from bookmark-filename. + + + + + + + the #AgsFileWidget + + + + + + Write recently_useds from recently_used-filename. + + + + + + + the #AgsFileWidget + + + + + + The app generic path. + + + + The app home path. + + + + The recently used filename. + + + + The current path. + + + + The default bundle. + + + + The default path. + + + + The file magic executable. + + + + The home path. + + + + The recently used filename. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The ::create-dir signal notifies about creating directory. + + + + + + the directory path + + + + + + The ::refresh signal notifies about filesystem change. + + + + + + + + + + + + + + + + + + + the #AgsFileWidget + + + + + + + + + + + + + + the #AgsFileWidget + + + + the directory path + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -5039,7 +6798,34 @@ and/or use gtk-doc annotations. --> - + + + + + + + + + + + + + + + + + + + + + + @@ -5117,6 +6903,60 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -5135,6 +6975,24 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + @@ -5367,6 +7225,516 @@ and/or use gtk-doc annotations. --> + + + + + + + + Creates a new instance of #AgsIconLink. + + + the new #AgsIconLink + + + + + the icon name + + + + the action + + + + the link text + + + + + + Emits ::clicked event. + + + + + + + the #AgsIconLink + + + + + + Emits ::copy-event event. + + + + + + + the #AgsIconLink + + + + + + Emits ::delete-event event. + + + + + + + the #AgsIconLink + + + + + + Emits ::clicked event. + + + + + + + the #AgsIconLink + + + + + + Emits ::copy-event event. + + + + + + + the #AgsIconLink + + + + + + Emits ::delete-event event. + + + + + + + the #AgsIconLink + + + + + + Get action of @icon_link. + + + the action as string + + + + + the #AgsIconLink + + + + + + Get icon name of @icon_link. + + + the icon name as string + + + + + the #AgsIconLink + + + + + + Get link text of @icon_link. + + + the link text as string + + + + + the #AgsIconLink + + + + + + Set @action of @icon_link. + + + + + + + the #AgsIconLink + + + + the action + + + + + + Set @flags of @icon_link. + + + + + + + the #AgsIconLink + + + + the flags + + + + + + Set @icon_name of @icon_link. + + + + + + + the #AgsIconLink + + + + the icon name + + + + + + Set @link_text of @icon_link. + + + + + + + the #AgsIconLink + + + + the link text + + + + + + Test @flags of @icon_link. + + + %TRUE if flags set, otherwise %FALSE + + + + + the #AgsIconLink + + + + the flags + + + + + + Set @flags of @icon_link. + + + + + + + the #AgsIconLink + + + + the flags + + + + + + The assigned action. + + + + + + + + + + + + + + + + + + + + + + + + + + + + The ::clicked signal notifies about widget clicked. + + + + + + The ::copy-event signal notifies about widget copy_event. + + the #AgsIconLink + + + + + The ::delete-event signal notifies about widget delete_event. + + + + + + + + + + + + + + + + + + + the #AgsIconLink + + + + + + + + + + + + + + the #AgsIconLink + + + + + + + + + + + + + + the #AgsIconLink + + + + + + + + + + + + + Creates a new instance of #AgsIndicator. + line="1025">Creates a new instance of #AgsIndicator. the new #AgsIndicator + line="1033">the new #AgsIndicator the #GtkOrientation + line="1027">the #GtkOrientation the width of one segment + line="1028">the width of one segment the height of one segment + line="1029">the height of one segment @@ -5417,19 +7785,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get adjustment. + line="966">Get adjustment. the #GtkAdjustment + line="972">the #GtkAdjustment the #AgsIndicator + line="968">the #AgsIndicator @@ -5440,19 +7808,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get segment count. + line="918">Get segment count. the segment count + line="924">the segment count the #AgsIndicator + line="920">the #AgsIndicator @@ -5463,19 +7831,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get segment height. + line="822">Get segment height. the segment height + line="828">the segment height the #AgsIndicator + line="824">the #AgsIndicator @@ -5486,19 +7854,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get segment padding. + line="870">Get segment padding. the segment padding + line="876">the segment padding the #AgsIndicator + line="872">the #AgsIndicator @@ -5509,19 +7877,19 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get segment width. + line="774">Get segment width. the segment width + line="780">the segment width the #AgsIndicator + line="776">the #AgsIndicator @@ -5532,7 +7900,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set adjustment. + line="992">Set adjustment. @@ -5541,13 +7909,13 @@ and/or use gtk-doc annotations. --> the #AgsIndicator + line="994">the #AgsIndicator the #GtkAdjustment + line="995">the #GtkAdjustment @@ -5558,7 +7926,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set segment count. + line="944">Set segment count. @@ -5567,13 +7935,13 @@ and/or use gtk-doc annotations. --> the #AgsIndicator + line="946">the #AgsIndicator the segment count + line="947">the segment count @@ -5584,7 +7952,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set segment height. + line="848">Set segment height. @@ -5593,13 +7961,13 @@ and/or use gtk-doc annotations. --> the #AgsIndicator + line="850">the #AgsIndicator the segment height + line="851">the segment height @@ -5610,7 +7978,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set segment padding. + line="896">Set segment padding. @@ -5619,13 +7987,13 @@ and/or use gtk-doc annotations. --> the #AgsIndicator + line="898">the #AgsIndicator the segment padding + line="899">the segment padding @@ -5636,7 +8004,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set segment width. + line="800">Set segment width. @@ -5645,13 +8013,13 @@ and/or use gtk-doc annotations. --> the #AgsIndicator + line="802">the #AgsIndicator the segment width + line="803">the segment width @@ -5745,6 +8113,381 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + Creates an #AgsInputDialog + + + a new #AgsInputDialog + + + + + the title + + + + the transient for + + + + + + Emit signal AgsInputDialog::response(). + + + + + + + the #AgsInputDialog + + + + the response + + + + + + The #GtkEntry to get input from. + + + the entry widget + + + + + the #AgsInputDialog + + + + + + The #GtkSpinButton to get input from. + + + the spin button widget + + + + + the #AgsInputDialog + + + + + + Emit signal AgsInputDialog::response(). + + + + + + + the #AgsInputDialog + + + + the response + + + + + + Set @flags. + + + + + + + the #AgsInputDialog + + + + the flags + + + + + + Set informal message. + + + + + + + the #AgsInputDialog + + + + + + + + + Set label of spin button. + + + + + + + the #AgsInputDialog + + + + the spin button label + + + + + + Set informal text. + + + + + + + the #AgsInputDialog + + + + the text + + + + + + Test flags to be set. + + + %TRUE if flags is set, otherwise %FALSE + + + + + the #AgsInputDialog + + + + the flags + + + + + + Unset @flags. + + + + + + + the #AgsInputDialog + + + + the flags + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The ::response signal notifies adjustment value changed. + + + + + + the response + + + + + + + + + + + + + + + + + + + the #AgsInputDialog + + + + the response + + + + + + + + + + + + + @@ -9330,31 +12073,31 @@ and/or use gtk-doc annotations. --> Allocate #AgsPlot-struct. + line="2711">Allocate #AgsPlot-struct. the newly allocated #AgsPlot-struct + line="2719">the newly allocated #AgsPlot-struct number of points + line="2713">number of points number of bitmaps + line="2714">number of bitmaps number of pixmaps + line="2715">number of pixmaps @@ -9362,7 +12105,7 @@ and/or use gtk-doc annotations. --> Free @plot. + line="2798">Free @plot. @@ -9374,7 +12117,7 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="2800">the #AgsPlot-struct @@ -9384,12 +12127,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get bitmaps. + line="3091">Get bitmaps. bitmap field + line="3097">bitmap field @@ -9399,7 +12142,7 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3093">the #AgsPlot-struct @@ -9409,12 +12152,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get bitmap colors. + line="3131">Get bitmap colors. bitmap color field + line="3137">bitmap color field @@ -9424,7 +12167,7 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3133">the #AgsPlot-struct @@ -9434,12 +12177,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get join points. + line="2891">Get join points. join_points field + line="2897">join_points field @@ -9449,7 +12192,7 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="2893">the #AgsPlot-struct @@ -9459,12 +12202,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get number of bitmaps. + line="3051">Get number of bitmaps. n_bitmaps field + line="3057">n_bitmaps field @@ -9474,7 +12217,7 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3053">the #AgsPlot-struct @@ -9484,12 +12227,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get number of pixmaps. + line="3171">Get number of pixmaps. n_pixmaps field + line="3177">n_pixmaps field @@ -9499,7 +12242,7 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3173">the #AgsPlot-struct @@ -9509,12 +12252,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get number of points. + line="2851">Get number of points. n_points field + line="2857">n_points field @@ -9524,7 +12267,7 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="2853">the #AgsPlot-struct @@ -9534,12 +12277,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get pixmaps. + line="3211">Get pixmaps. pixmap field + line="3217">pixmap field @@ -9549,7 +12292,7 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3213">the #AgsPlot-struct @@ -9559,12 +12302,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get points. + line="2931">Get points. point field + line="2937">point field @@ -9574,7 +12317,7 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="2933">the #AgsPlot-struct @@ -9584,12 +12327,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get point colors. + line="2971">Get point colors. point color field + line="2977">point color field @@ -9599,7 +12342,7 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="2973">the #AgsPlot-struct @@ -9609,12 +12352,12 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Get point labels. + line="3011">Get point labels. point label field + line="3017">point label field @@ -9626,7 +12369,7 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3013">the #AgsPlot-struct @@ -9636,7 +12379,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set bitmap field of @plot. + line="3111">Set bitmap field of @plot. @@ -9648,13 +12391,13 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3113">the #AgsPlot-struct the bitmaps + line="3114">the bitmaps @@ -9664,7 +12407,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set bitmap color field of @plot. + line="3151">Set bitmap color field of @plot. @@ -9676,13 +12419,13 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3153">the #AgsPlot-struct the bitmaps colors as array of RGB value + line="3154">the bitmaps colors as array of RGB value @@ -9692,7 +12435,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set join_points field of @plot. + line="2911">Set join_points field of @plot. @@ -9704,13 +12447,13 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="2913">the #AgsPlot-struct if %TRUE join points, otherwise not + line="2914">if %TRUE join points, otherwise not @@ -9720,7 +12463,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set n_bitmaps field of @plot. + line="3071">Set n_bitmaps field of @plot. @@ -9732,13 +12475,13 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3073">the #AgsPlot-struct the number of bitmaps + line="3074">the number of bitmaps @@ -9748,7 +12491,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set n_pixmaps field of @plot. + line="3191">Set n_pixmaps field of @plot. @@ -9760,13 +12503,13 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3193">the #AgsPlot-struct the number of pixmaps + line="3194">the number of pixmaps @@ -9776,7 +12519,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set n_points field of @plot. + line="2871">Set n_points field of @plot. @@ -9788,13 +12531,13 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="2873">the #AgsPlot-struct the number of points + line="2874">the number of points @@ -9804,7 +12547,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set pixmap field of @plot. + line="3231">Set pixmap field of @plot. @@ -9816,13 +12559,13 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3233">the #AgsPlot-struct the pixmaps + line="3234">the pixmaps @@ -9832,7 +12575,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set point field of @plot. + line="2951">Set point field of @plot. @@ -9844,13 +12587,13 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="2953">the #AgsPlot-struct the points as array of coordinates + line="2954">the points as array of coordinates @@ -9860,7 +12603,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set point color field of @plot. + line="2991">Set point color field of @plot. @@ -9872,13 +12615,13 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="2993">the #AgsPlot-struct the points colors as array of RGB value + line="2994">the points colors as array of RGB value @@ -9888,7 +12631,7 @@ and/or use gtk-doc annotations. --> version="3.2.0"> Set point label field of @plot. + line="3031">Set point label field of @plot. @@ -9900,13 +12643,13 @@ and/or use gtk-doc annotations. --> allow-none="1"> the #AgsPlot-struct + line="3033">the #AgsPlot-struct the points labels as string vector + line="3034">the points labels as string vector @@ -12405,11 +15148,31 @@ be expanded. filename="widget/ags_expander_set.c" line="45">#AgsExpanderSet is a composite widget containing a #GtkGrid. + + #AgsFileDialog is a dialog widget to open or save files. + + + #AgsFileWidget is a widget to open or save files. + + + #AgsIconLink is a widget representing a #GtkAdjustment. + #AgsIndicator is a widget representing a #GtkAdjustment. + + #AgsInputDialog is a dialog widget to edit input settings. + version="3.0.0"> Allocate #AgsPlot-struct. + line="2711">Allocate #AgsPlot-struct. the newly allocated #AgsPlot-struct + line="2719">the newly allocated #AgsPlot-struct number of points + line="2713">number of points number of bitmaps + line="2714">number of bitmaps number of pixmaps + line="2715">number of pixmaps @@ -12644,7 +15407,7 @@ be expanded. version="3.0.0"> Free @plot. + line="2798">Free @plot. @@ -12656,7 +15419,7 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="2800">the #AgsPlot-struct @@ -12667,12 +15430,12 @@ be expanded. version="3.2.0"> Get bitmaps. + line="3091">Get bitmaps. bitmap field + line="3097">bitmap field @@ -12682,7 +15445,7 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3093">the #AgsPlot-struct @@ -12693,12 +15456,12 @@ be expanded. version="3.2.0"> Get bitmap colors. + line="3131">Get bitmap colors. bitmap color field + line="3137">bitmap color field @@ -12708,7 +15471,7 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3133">the #AgsPlot-struct @@ -12719,12 +15482,12 @@ be expanded. version="3.2.0"> Get join points. + line="2891">Get join points. join_points field + line="2897">join_points field @@ -12734,7 +15497,7 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="2893">the #AgsPlot-struct @@ -12745,12 +15508,12 @@ be expanded. version="3.2.0"> Get number of bitmaps. + line="3051">Get number of bitmaps. n_bitmaps field + line="3057">n_bitmaps field @@ -12760,7 +15523,7 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3053">the #AgsPlot-struct @@ -12771,12 +15534,12 @@ be expanded. version="3.2.0"> Get number of pixmaps. + line="3171">Get number of pixmaps. n_pixmaps field + line="3177">n_pixmaps field @@ -12786,7 +15549,7 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3173">the #AgsPlot-struct @@ -12797,12 +15560,12 @@ be expanded. version="3.2.0"> Get number of points. + line="2851">Get number of points. n_points field + line="2857">n_points field @@ -12812,7 +15575,7 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="2853">the #AgsPlot-struct @@ -12823,12 +15586,12 @@ be expanded. version="3.2.0"> Get pixmaps. + line="3211">Get pixmaps. pixmap field + line="3217">pixmap field @@ -12838,7 +15601,7 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3213">the #AgsPlot-struct @@ -12849,12 +15612,12 @@ be expanded. version="3.2.0"> Get points. + line="2931">Get points. point field + line="2937">point field @@ -12864,7 +15627,7 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="2933">the #AgsPlot-struct @@ -12875,12 +15638,12 @@ be expanded. version="3.2.0"> Get point colors. + line="2971">Get point colors. point color field + line="2977">point color field @@ -12890,7 +15653,7 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="2973">the #AgsPlot-struct @@ -12901,12 +15664,12 @@ be expanded. version="3.2.0"> Get point labels. + line="3011">Get point labels. point label field + line="3017">point label field @@ -12918,7 +15681,7 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3013">the #AgsPlot-struct @@ -12929,7 +15692,7 @@ be expanded. version="3.2.0"> Set bitmap field of @plot. + line="3111">Set bitmap field of @plot. @@ -12941,13 +15704,13 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3113">the #AgsPlot-struct the bitmaps + line="3114">the bitmaps @@ -12958,7 +15721,7 @@ be expanded. version="3.2.0"> Set bitmap color field of @plot. + line="3151">Set bitmap color field of @plot. @@ -12970,13 +15733,13 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3153">the #AgsPlot-struct the bitmaps colors as array of RGB value + line="3154">the bitmaps colors as array of RGB value @@ -12987,7 +15750,7 @@ be expanded. version="3.2.0"> Set join_points field of @plot. + line="2911">Set join_points field of @plot. @@ -12999,13 +15762,13 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="2913">the #AgsPlot-struct if %TRUE join points, otherwise not + line="2914">if %TRUE join points, otherwise not @@ -13016,7 +15779,7 @@ be expanded. version="3.2.0"> Set n_bitmaps field of @plot. + line="3071">Set n_bitmaps field of @plot. @@ -13028,13 +15791,13 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3073">the #AgsPlot-struct the number of bitmaps + line="3074">the number of bitmaps @@ -13045,7 +15808,7 @@ be expanded. version="3.2.0"> Set n_pixmaps field of @plot. + line="3191">Set n_pixmaps field of @plot. @@ -13057,13 +15820,13 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3193">the #AgsPlot-struct the number of pixmaps + line="3194">the number of pixmaps @@ -13074,7 +15837,7 @@ be expanded. version="3.2.0"> Set n_points field of @plot. + line="2871">Set n_points field of @plot. @@ -13086,13 +15849,13 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="2873">the #AgsPlot-struct the number of points + line="2874">the number of points @@ -13103,7 +15866,7 @@ be expanded. version="3.2.0"> Set pixmap field of @plot. + line="3231">Set pixmap field of @plot. @@ -13115,13 +15878,13 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3233">the #AgsPlot-struct the pixmaps + line="3234">the pixmaps @@ -13132,7 +15895,7 @@ be expanded. version="3.2.0"> Set point field of @plot. + line="2951">Set point field of @plot. @@ -13144,13 +15907,13 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="2953">the #AgsPlot-struct the points as array of coordinates + line="2954">the points as array of coordinates @@ -13161,7 +15924,7 @@ be expanded. version="3.2.0"> Set point color field of @plot. + line="2991">Set point color field of @plot. @@ -13173,13 +15936,13 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="2993">the #AgsPlot-struct the points colors as array of RGB value + line="2994">the points colors as array of RGB value @@ -13190,7 +15953,7 @@ be expanded. version="3.2.0"> Set point label field of @plot. + line="3031">Set point label field of @plot. @@ -13202,17 +15965,50 @@ be expanded. allow-none="1"> the #AgsPlot-struct + line="3033">the #AgsPlot-struct the points labels as string vector + line="3034">the points labels as string vector + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/girs/Anjuta-3.0.gir b/girs/Anjuta-3.0.gir index 90bbf6780..0545d631c 100644 --- a/girs/Anjuta-3.0.gir +++ b/girs/Anjuta-3.0.gir @@ -100,6 +100,18 @@ and/or use gtk-doc annotations. --> + + AnjutaDock provides an alternative to the traditional menu and toolbar based +methodologies used by most GNOME programs. Instead, it focuses on tasks, or +related sets of tasks. Each pane in the dock corresponds to a different set +of related tasks. + +Optionally, you can also associate an #AnjutaCommandBar with an AnjutaDock to +provide contextually appropriate sets of commands depending on the currently +visible pane + + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> @@ -858,6 +873,7 @@ is destroyed. @@ -1037,6 +1053,7 @@ is destroyed. @@ -1114,7 +1131,10 @@ is destroyed. - + @@ -1151,7 +1171,8 @@ is destroyed. + c:identifier="anjuta_cell_renderer_diff_set_diff" + glib:set-property="diff"> @@ -1168,7 +1189,8 @@ is destroyed. + transfer-ownership="none" + setter="set_diff"> @@ -1189,7 +1211,8 @@ is destroyed. + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> + transfer-ownership="none" + default-value="25"> @@ -2086,7 +2112,8 @@ Buttons are added to the last frame that appears before the button entry + glib:nick="frame" + glib:name="ANJUTA_COMMAND_BAR_ENTRY_FRAME"> This entry should create a frame in the @@ -2096,7 +2123,8 @@ Buttons are added to the last frame that appears before the button entry + glib:nick="button" + glib:name="ANJUTA_COMMAND_BAR_ENTRY_BUTTON"> This entry adds a button to the action bar, @@ -2106,7 +2134,10 @@ Buttons are added to the last frame that appears before the button entry added. - + - + + glib:nick="automatic" + glib:name="ANJUTA_COMMAND_QUEUE_EXECUTE_AUTOMATIC"> + glib:nick="manual" + glib:name="ANJUTA_COMMAND_QUEUE_EXECUTE_MANUAL"> + disguised="1" + opaque="1"> + c:identifier="anjuta_completion_get_case_sensitive" + glib:get-property="case-sensitive"> @@ -2589,7 +2627,8 @@ waiting + c:identifier="anjuta_completion_set_case_sensitive" + glib:set-property="case-sensitive"> @@ -2652,7 +2691,12 @@ the added items when the #AnjutaCompletion object is destroyed. - + @@ -2707,7 +2751,8 @@ the added items when the #AnjutaCompletion object is destroyed. + disguised="1" + opaque="1"> + glib:nick="failed" + glib:name="ANJUTA_CONVERT_ERROR_AUTO_DETECTION_FAILED"> The charset couldn't be autodetected @@ -3304,6 +3350,7 @@ needed. @@ -3395,7 +3442,10 @@ needed. - + @@ -3494,10 +3544,13 @@ owned by the pane and should not be destroyed or modified. - + - + @@ -3817,7 +3871,7 @@ method returns %TRUE, it means that the user has not entered anything. - + + c:identifier="anjuta_file_drop_entry_set_relative_path" + glib:set-property="relative-path"> @@ -4022,7 +4077,11 @@ is changed (include deleted variables) - + @@ -4042,7 +4101,8 @@ is changed (include deleted variables) + disguised="1" + opaque="1"> + c:identifier="anjuta_file_list_set_relative_path" + glib:set-property="relative-path"> @@ -4103,10 +4164,16 @@ is changed (include deleted variables) - + - + @@ -4124,7 +4191,10 @@ is changed (include deleted variables) - + + disguised="1" + opaque="1"> + glib:nick="stdout" + glib:name="ANJUTA_LAUNCHER_OUTPUT_STDOUT"> + glib:nick="stderr" + glib:name="ANJUTA_LAUNCHER_OUTPUT_STDERR"> + glib:nick="pty" + glib:name="ANJUTA_LAUNCHER_OUTPUT_PTY"> - + + disguised="1" + opaque="1"> - + @@ -6456,7 +6536,9 @@ that does not have any interface implementation. - + @@ -6470,13 +6552,17 @@ that does not have any interface implementation. + transfer-ownership="none" + getter="get_package" + default-value="NULL"> + transfer-ownership="none" + getter="get_version" + default-value="NULL"> @@ -6496,7 +6582,8 @@ that does not have any interface implementation. + disguised="1" + opaque="1"> - + + transfer-ownership="none" + getter="get_shell"> The #AnjutaShell object associated with this plugin @@ -6846,6 +6936,7 @@ anjuta_plugin_add_watch()). @@ -7339,7 +7430,8 @@ The returned values must be freed after use. + glib:nick="syntax" + glib:name="ANJUTA_PLUGIN_DESCRIPTION_PARSE_ERROR_INVALID_SYNTAX"> Syntax of plugin file is invalid @@ -7347,7 +7439,8 @@ The returned values must be freed after use. + glib:nick="escapes" + glib:name="ANJUTA_PLUGIN_DESCRIPTION_PARSE_ERROR_INVALID_ESCAPES"> Invalid escape sequence @@ -7355,7 +7448,8 @@ The returned values must be freed after use. + glib:nick="chars" + glib:name="ANJUTA_PLUGIN_DESCRIPTION_PARSE_ERROR_INVALID_CHARS"> Invalid characters @@ -7408,7 +7502,9 @@ The returned values must be freed after use. - + @@ -7420,7 +7516,8 @@ The returned values must be freed after use. + c:identifier="anjuta_plugin_handle_get_can_load" + glib:get-property="can-load"> @@ -7432,7 +7529,8 @@ The returned values must be freed after use. + c:identifier="anjuta_plugin_handle_get_can_unload" + glib:get-property="can-unload"> @@ -7444,7 +7542,8 @@ The returned values must be freed after use. + c:identifier="anjuta_plugin_handle_get_checked" + glib:get-property="checked"> @@ -7457,6 +7556,7 @@ The returned values must be freed after use. @@ -7473,6 +7573,7 @@ The returned values must be freed after use. @@ -7488,6 +7589,7 @@ The returned values must be freed after use. @@ -7503,7 +7605,8 @@ The returned values must be freed after use. + c:identifier="anjuta_plugin_handle_get_description" + glib:get-property="description"> @@ -7515,7 +7618,8 @@ The returned values must be freed after use. + c:identifier="anjuta_plugin_handle_get_icon_path" + glib:get-property="icon-path"> @@ -7526,7 +7630,9 @@ The returned values must be freed after use. - + @@ -7539,6 +7645,7 @@ The returned values must be freed after use. @@ -7553,7 +7660,8 @@ The returned values must be freed after use. + c:identifier="anjuta_plugin_handle_get_language" + glib:get-property="language"> @@ -7564,7 +7672,9 @@ The returned values must be freed after use. - + @@ -7575,7 +7685,9 @@ The returned values must be freed after use. - + @@ -7587,7 +7699,8 @@ The returned values must be freed after use. + c:identifier="anjuta_plugin_handle_get_resident" + glib:get-property="resident"> @@ -7599,7 +7712,8 @@ The returned values must be freed after use. + c:identifier="anjuta_plugin_handle_get_resolve_pass" + glib:get-property="resolve-pass"> @@ -7611,7 +7725,8 @@ The returned values must be freed after use. + c:identifier="anjuta_plugin_handle_get_user_activatable" + glib:get-property="user-activatable"> @@ -7694,55 +7809,101 @@ The returned values must be freed after use. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -7762,7 +7923,8 @@ The returned values must be freed after use. + disguised="1" + opaque="1"> + glib:nick="missing-factory" + glib:name="ANJUTA_PLUGIN_MANAGER_MISSING_FACTORY"> The factory for the plugin couldn't be found @@ -8419,7 +8582,8 @@ plugin does not exist or if the plugin cannot be unloaded. + glib:nick="error-unknown" + glib:name="ANJUTA_PLUGIN_MANAGER_ERROR_UNKNOWN"> Unknown error @@ -8432,10 +8596,14 @@ plugin does not exist or if the plugin cannot be unloaded. + disguised="1" + opaque="1"> - + @@ -8839,12 +9007,14 @@ on the left icon list where differnt pages are selected. + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> - + Define the file used to save plugins list. @@ -9178,13 +9350,15 @@ on the left icon list where differnt pages are selected. + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + setter="set_sync_file"> @@ -9340,7 +9514,8 @@ on the left icon list where differnt pages are selected. + glib:nick="uri-read-failed" + glib:name="ANJUTA_PROFILE_ERROR_URI_READ_FAILED"> Fail to read xml plugins list file. @@ -9348,7 +9523,8 @@ on the left icon list where differnt pages are selected. + glib:nick="uri-write-failed" + glib:name="ANJUTA_PROFILE_ERROR_URI_WRITE_FAILED"> Fail to write xml plugins list file. @@ -9356,7 +9532,8 @@ on the left icon list where differnt pages are selected. + glib:nick="plugin-missing" + glib:name="ANJUTA_PROFILE_ERROR_PLUGIN_MISSING"> @@ -9659,10 +9836,14 @@ will be loaded. + disguised="1" + opaque="1"> - + - + @@ -9879,7 +10062,9 @@ accessed using the functions below. - + @@ -9988,7 +10173,9 @@ accessed using the functions below. - + @@ -10203,7 +10390,9 @@ accessed using the functions below. - + @@ -10244,16 +10433,30 @@ accessed using the functions below. - + - + - + - + @@ -10494,67 +10697,80 @@ accessed using the functions below. + glib:nick="ok" + glib:name="ANJUTA_PROJECT_OK"> + glib:nick="modified" + glib:name="ANJUTA_PROJECT_MODIFIED"> + glib:nick="incomplete" + glib:name="ANJUTA_PROJECT_INCOMPLETE"> + glib:nick="loading" + glib:name="ANJUTA_PROJECT_LOADING"> + glib:nick="removed" + glib:name="ANJUTA_PROJECT_REMOVED"> + glib:nick="can-add-group" + glib:name="ANJUTA_PROJECT_CAN_ADD_GROUP"> + glib:nick="can-add-target" + glib:name="ANJUTA_PROJECT_CAN_ADD_TARGET"> + glib:nick="can-add-source" + glib:name="ANJUTA_PROJECT_CAN_ADD_SOURCE"> + glib:nick="can-add-module" + glib:name="ANJUTA_PROJECT_CAN_ADD_MODULE"> + glib:nick="can-add-package" + glib:name="ANJUTA_PROJECT_CAN_ADD_PACKAGE"> + glib:nick="can-remove" + glib:name="ANJUTA_PROJECT_CAN_REMOVE"> + glib:nick="can-save" + glib:name="ANJUTA_PROJECT_CAN_SAVE"> + glib:nick="remove-file" + glib:name="ANJUTA_PROJECT_REMOVE_FILE"> + glib:nick="unknown" + glib:name="ANJUTA_PROJECT_UNKNOWN"> + glib:nick="sharedlib" + glib:name="ANJUTA_PROJECT_SHAREDLIB"> + glib:nick="staticlib" + glib:name="ANJUTA_PROJECT_STATICLIB"> + glib:nick="program" + glib:name="ANJUTA_PROJECT_PROGRAM"> + glib:nick="python" + glib:name="ANJUTA_PROJECT_PYTHON"> + glib:nick="java" + glib:name="ANJUTA_PROJECT_JAVA"> + glib:nick="lisp" + glib:name="ANJUTA_PROJECT_LISP"> + glib:nick="header" + glib:name="ANJUTA_PROJECT_HEADER"> + glib:nick="man" + glib:name="ANJUTA_PROJECT_MAN"> + glib:nick="info" + glib:name="ANJUTA_PROJECT_INFO"> + glib:nick="generic" + glib:name="ANJUTA_PROJECT_GENERIC"> + glib:nick="data" + glib:name="ANJUTA_PROJECT_DATA"> + glib:nick="extra" + glib:name="ANJUTA_PROJECT_EXTRA"> + glib:nick="intltool" + glib:name="ANJUTA_PROJECT_INTLTOOL"> + glib:nick="configure" + glib:name="ANJUTA_PROJECT_CONFIGURE"> + glib:nick="idl" + glib:name="ANJUTA_PROJECT_IDL"> + glib:nick="mkenums" + glib:name="ANJUTA_PROJECT_MKENUMS"> + glib:nick="genmarshal" + glib:name="ANJUTA_PROJECT_GENMARSHAL"> + glib:nick="script" + glib:name="ANJUTA_PROJECT_SCRIPT"> + glib:nick="root-group" + glib:name="ANJUTA_PROJECT_ROOT_GROUP"> + glib:nick="lt-module" + glib:name="ANJUTA_PROJECT_LT_MODULE"> + glib:nick="proxy" + glib:name="ANJUTA_PROJECT_PROXY"> + glib:nick="project" + glib:name="ANJUTA_PROJECT_PROJECT"> + glib:nick="primary" + glib:name="ANJUTA_PROJECT_PRIMARY"> + glib:nick="executable" + glib:name="ANJUTA_PROJECT_EXECUTABLE"> + glib:nick="read-only" + glib:name="ANJUTA_PROJECT_READ_ONLY"> + glib:nick="frame" + glib:name="ANJUTA_PROJECT_FRAME"> + glib:nick="id-mask" + glib:name="ANJUTA_PROJECT_ID_MASK"> + glib:nick="flag-mask" + glib:name="ANJUTA_PROJECT_FLAG_MASK"> + glib:nick="type-mask" + glib:name="ANJUTA_PROJECT_TYPE_MASK"> + glib:nick="root" + glib:name="ANJUTA_PROJECT_ROOT"> + glib:nick="group" + glib:name="ANJUTA_PROJECT_GROUP"> + glib:nick="target" + glib:name="ANJUTA_PROJECT_TARGET"> + glib:nick="source" + glib:name="ANJUTA_PROJECT_SOURCE"> + glib:nick="module" + glib:name="ANJUTA_PROJECT_MODULE"> + glib:nick="package" + glib:name="ANJUTA_PROJECT_PACKAGE"> + glib:nick="variable" + glib:name="ANJUTA_PROJECT_VARIABLE"> + glib:nick="object" + glib:name="ANJUTA_PROJECT_OBJECT"> + glib:nick="read-only" + glib:name="ANJUTA_PROJECT_PROPERTY_READ_ONLY"> + glib:nick="read-write" + glib:name="ANJUTA_PROJECT_PROPERTY_READ_WRITE"> + glib:nick="hidden" + glib:name="ANJUTA_PROJECT_PROPERTY_HIDDEN"> + glib:nick="static" + glib:name="ANJUTA_PROJECT_PROPERTY_STATIC"> + glib:nick="string" + glib:name="ANJUTA_PROJECT_PROPERTY_STRING"> + glib:nick="list" + glib:name="ANJUTA_PROJECT_PROPERTY_LIST"> + glib:nick="boolean" + glib:name="ANJUTA_PROJECT_PROPERTY_BOOLEAN"> + glib:nick="map" + glib:name="ANJUTA_PROJECT_PROPERTY_MAP"> - + + disguised="1" + opaque="1"> @@ -11433,13 +11696,15 @@ and member functions definitions. + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="ANJUTA_SERIALIZER_READ"> @@ -11464,17 +11729,20 @@ and member functions definitions. + glib:nick="read" + glib:name="ANJUTA_SERIALIZER_READ"> + glib:nick="write" + glib:name="ANJUTA_SERIALIZER_WRITE"> + disguised="1" + opaque="1"> + glib:nick="start" + glib:name="ANJUTA_SESSION_PHASE_START"> + glib:nick="first" + glib:name="ANJUTA_SESSION_PHASE_FIRST"> + glib:nick="normal" + glib:name="ANJUTA_SESSION_PHASE_NORMAL"> + glib:nick="last" + glib:name="ANJUTA_SESSION_PHASE_LAST"> + glib:nick="end" + glib:name="ANJUTA_SESSION_PHASE_END"> - + + glib:nick="exist" + glib:name="ANJUTA_SHELL_ERROR_DOESNT_EXIST"> @@ -14240,37 +14517,44 @@ interface or %NULL. + glib:nick="none" + glib:name="ANJUTA_SHELL_PLACEMENT_NONE"> + glib:nick="top" + glib:name="ANJUTA_SHELL_PLACEMENT_TOP"> + glib:nick="bottom" + glib:name="ANJUTA_SHELL_PLACEMENT_BOTTOM"> + glib:nick="right" + glib:name="ANJUTA_SHELL_PLACEMENT_RIGHT"> + glib:nick="left" + glib:name="ANJUTA_SHELL_PLACEMENT_LEFT"> + glib:nick="center" + glib:name="ANJUTA_SHELL_PLACEMENT_CENTER"> + glib:nick="floating" + glib:name="ANJUTA_SHELL_PLACEMENT_FLOATING"> - + - + - + @@ -16090,7 +16381,10 @@ return an error if the token is not in the file. - + @@ -16340,7 +16634,10 @@ stream, the new token uses the same characters. - + @@ -16427,237 +16724,284 @@ stream, the new token uses the same characters. + glib:nick="none" + glib:name="ANJUTA_TOKEN_NONE"> + glib:nick="eol" + glib:name="ANJUTA_TOKEN_EOL"> + glib:nick="comma" + glib:name="ANJUTA_TOKEN_COMMA"> + glib:nick="type" + glib:name="ANJUTA_TOKEN_TYPE"> + glib:nick="first" + glib:name="ANJUTA_TOKEN_FIRST"> + glib:nick="file" + glib:name="ANJUTA_TOKEN_FILE"> + glib:nick="macro" + glib:name="ANJUTA_TOKEN_MACRO"> + glib:nick="content" + glib:name="ANJUTA_TOKEN_CONTENT"> + glib:nick="argument" + glib:name="ANJUTA_TOKEN_ARGUMENT"> + glib:nick="value" + glib:name="ANJUTA_TOKEN_VALUE"> + glib:nick="eov" + glib:name="ANJUTA_TOKEN_EOV"> + glib:nick="parsed" + glib:name="ANJUTA_TOKEN_PARSED"> + glib:nick="keyword" + glib:name="ANJUTA_TOKEN_KEYWORD"> + glib:nick="operator" + glib:name="ANJUTA_TOKEN_OPERATOR"> + glib:nick="name" + glib:name="ANJUTA_TOKEN_NAME"> + glib:nick="variable" + glib:name="ANJUTA_TOKEN_VARIABLE"> + glib:nick="definition" + glib:name="ANJUTA_TOKEN_DEFINITION"> + glib:nick="statement" + glib:name="ANJUTA_TOKEN_STATEMENT"> + glib:nick="number" + glib:name="ANJUTA_TOKEN_NUMBER"> + glib:nick="junk" + glib:name="ANJUTA_TOKEN_JUNK"> + glib:nick="comment" + glib:name="ANJUTA_TOKEN_COMMENT"> + glib:nick="open-quote" + glib:name="ANJUTA_TOKEN_OPEN_QUOTE"> + glib:nick="close-quote" + glib:name="ANJUTA_TOKEN_CLOSE_QUOTE"> + glib:nick="escape" + glib:name="ANJUTA_TOKEN_ESCAPE"> + glib:nick="function" + glib:name="ANJUTA_TOKEN_FUNCTION"> + glib:nick="space" + glib:name="ANJUTA_TOKEN_SPACE"> + glib:nick="start" + glib:name="ANJUTA_TOKEN_START"> + glib:nick="next" + glib:name="ANJUTA_TOKEN_NEXT"> + glib:nick="last" + glib:name="ANJUTA_TOKEN_LAST"> + glib:nick="item" + glib:name="ANJUTA_TOKEN_ITEM"> + glib:nick="string" + glib:name="ANJUTA_TOKEN_STRING"> + glib:nick="error" + glib:name="ANJUTA_TOKEN_ERROR"> + glib:nick="word" + glib:name="ANJUTA_TOKEN_WORD"> + glib:nick="list" + glib:name="ANJUTA_TOKEN_LIST"> + glib:nick="any" + glib:name="ANJUTA_TOKEN_ANY"> + glib:nick="user" + glib:name="ANJUTA_TOKEN_USER"> + glib:nick="flags" + glib:name="ANJUTA_TOKEN_FLAGS"> + glib:nick="public-flags" + glib:name="ANJUTA_TOKEN_PUBLIC_FLAGS"> + glib:nick="irrelevant" + glib:name="ANJUTA_TOKEN_IRRELEVANT"> + glib:nick="open" + glib:name="ANJUTA_TOKEN_OPEN"> + glib:nick="close" + glib:name="ANJUTA_TOKEN_CLOSE"> + glib:nick="significant" + glib:name="ANJUTA_TOKEN_SIGNIFICANT"> + glib:nick="private-flags" + glib:name="ANJUTA_TOKEN_PRIVATE_FLAGS"> + glib:nick="case-insensitive" + glib:name="ANJUTA_TOKEN_CASE_INSENSITIVE"> + glib:nick="static" + glib:name="ANJUTA_TOKEN_STATIC"> + glib:nick="removed" + glib:name="ANJUTA_TOKEN_REMOVED"> + glib:nick="added" + glib:name="ANJUTA_TOKEN_ADDED"> @@ -16763,7 +17108,9 @@ stream, the new token uses the same characters. - + @@ -16806,7 +17153,11 @@ stream, the new token uses the same characters. - + @@ -16854,7 +17205,8 @@ stream, the new token uses the same characters. + disguised="1" + opaque="1"> - + + glib:nick="modified" + glib:name="ANJUTA_VCS_STATUS_MODIFIED"> + glib:nick="added" + glib:name="ANJUTA_VCS_STATUS_ADDED"> + glib:nick="deleted" + glib:name="ANJUTA_VCS_STATUS_DELETED"> + glib:nick="conflicted" + glib:name="ANJUTA_VCS_STATUS_CONFLICTED"> + glib:nick="uptodate" + glib:name="ANJUTA_VCS_STATUS_UPTODATE"> + glib:nick="locked" + glib:name="ANJUTA_VCS_STATUS_LOCKED"> + glib:nick="missing" + glib:name="ANJUTA_VCS_STATUS_MISSING"> + glib:nick="unversioned" + glib:name="ANJUTA_VCS_STATUS_UNVERSIONED"> + glib:nick="ignored" + glib:name="ANJUTA_VCS_STATUS_IGNORED"> + glib:nick="all" + glib:name="ANJUTA_VCS_STATUS_ALL"> + transfer-ownership="none" + default-value="TRUE"> - + + transfer-ownership="none" + default-value="ANJUTA_VCS_STATUS_MODIFIED | ANJUTA_VCS_STATUS_ADDED | ANJUTA_VCS_STATUS_DELETED | ANJUTA_VCS_STATUS_CONFLICTED"> @@ -17620,9 +17987,631 @@ it was merged. For more detail, read the documentation for #GtkUIManager. + disguised="1" + opaque="1"> + + #AnjutaAsyncCommand provides a simple way for plugins to run tasks that +are synchronous and usually take several seconds or longer to execute in +another thread so that such tasks do no block Anjuta's user interface. + +#AnjutaAsyncCommand automatically runs and manages the thread when the +command starts, and destroys it when the command finishes. Aside from +locking protected data with anjuta_async_command_lock/unlock, clients, and +even commands themselves need not even be concerned that their tasks are +rnning on another thread. + +For an example of how #AnjutaAsyncCommand is used, see the Subversion plugin. + + + #AnjutaAsyncNotify is a way to allow Anjuta interfaces that run +asynchronously, such as #IAnjutaVCS, to notify clients that a method has +completed. #AnjutaAsyncNotify also reports errors to the user. + +All clients need to do is create an instance of #AnjutaAsyncNotify, connect +to the finished signal, and pass it in to the interface method to be called. + + + GNU autogen is a program generating a text file from a template and a +definition file. The template contains fixed text and variables those will +be replaced under the control of the definition file. + +By example from the following definition file +<programlisting> +AutoGen Definitions .; +list = { list_element = alpha; + list_info = "some alpha stuff"; }; +list = { list_info = "more beta stuff"; + list_element = beta; }; +list = { list_element = omega; + list_info = "final omega stuff"; } +</programlisting> +And the following template +<programlisting> +[+ AutoGen5 template +] +typedef enum {[+ + FOR list "," +] + IDX_[+ (string-upcase! (get "list_element")) +][+ + ENDFOR list +] } list_enum; +</programlisting> +Autogen generates +<programlisting> +typedef enum { + IDX_ALPHA, + IDX_BETA, + IDX_OMEGA } list_enum; +</programlisting> + +The template file can be quite complex, you can read autogen documentation +<ulink url="http://www.gnu.org/software/autogen">here</ulink>. + +The #AnjutaAutogen object takes care of writing the definition file from +a hash table and call autogen. The output can be written in a file or passed +to a callback function. Autogen is executed asynchronously, so there is +another callback function called when the processing is completed. + + + A module is the part of the plugin containing the code. For machine code +compiled from C sources by example, it is a shared library and contained in +a .so file on Linux. GLib provides a portable way to load dynamically such +code with #GModule objects. + +In GLib you can register a dynamic type which means that you links a GLib +type with a module. When the type is used for the first time the module is +loaded. When the type is not used anymore, the module is unloaded. Most of +the code necessary to do this is already written in GLib #GTypeModule object +except the load and unload function. + +#AnjutaCModule is used only by a #AnjutaCPluginFactory. It derives from +#GTypeModule and implements the load and unload function using a #GModule +object for a module written in C. + +Anjuta plugin types are not registered before loading the module. +The loading of the module is done explicitly and types are registered just +after in a function included in the plugin. This function is named +anjuta_glue_register_components and has a #GTypeModule as argument. +The plugin must registers at the least the plugin type dynamically. It can +register other types, but this is currently not used. + +After loading a module one or more plugin objects will be created using the +name of the plugin type which has just been registered. The module +will stay loaded while at least one plugin object is present. If all +plugins objects are destroyed the unload function will be called and the +module can be unloaded and removed from memory. + +It could be useful that some modules stay in memory even if there is no +object using it. A typical example is if some plugin code or some code of +a library used by a plugin registers a GLib type statically. GLib types can +be registered statically at run time but cannot be unregistered later. +The code (or rather the data used in the registration) must stay in the +memory even if the type is not used. In order to avoid this, you must +register every type dynamically. You could have other situations where a +module cannot be unloaded. By default, Anjuta plugin modules are not +unloaded unless it is explicitly allowed. + + + #AnjutaCPluginFactory implements the #IAnjutaPluginFactory interface. This +interface is used to create new plugin objects in Anjuta. + +This plugin factory creates new plugin objects which have a source code +written in C. This factory is always available in Anjuta. Other plugin +factories can be implemented as Anjuta plugins. + +This plugin factory uses the GLib dynamic type support implemented in +#AnjutaCModule object to allow loading and unloading of plugins code. But +if the plugins itself can be unloaded, the #AnjutaCModule object must stay. +If the plugin is needed later, it must be registed with the same +module object. The factory take care of this and of creating the plugin +object itself. + + + #AnjutaCommand is the base class for objects that are designed to provide +a layer of abstraction between UI code and some other component, like a +library or child process. AnjutaCommand provides a simple and consistent +interface for plugins to interact with these components without needing +to concern themselves with the exact details of how these components work. + +To create command objects, plugins derive them from an #AnjutaCommand +subclass like #AnjutaAsyncCommand, which runs commands in another thread or +#AnjutaSyncCommand, which runs commands synchronously. + +These classes determine how ::run is called and how signals are emitted. +::run is responsible for actually doing the work of the command. It is the +responsiblity of the command object that does a certain task to implement +::run to do its job. Everything else is normally implemented by its parent +classes at this point + +For an example of how to use #AnjutaCommand, see the Subversion and Git +plugins. + + + AnjutaCommandBar provides a convenient way to arrange several sets of +commands into one widget. It separates commands into different groups of +actions, with only one group visible at a time. + + + #AnjutaCommandQueue always starts the next command in the queue when +the previous command finishes. That also works for asyncronous commands + + + Anjuta debug messages are displayed using the g_debug() function from GLib. + +To display debug messages, Anjuta must have been compiled with +--enable-debug and the environment variable G_MESSAGES_DEBUG should be set +to "all" or to a list separated by whitespace of domains to display. + +By example +<programlisting> +G_MESSAGE_DEBUG=Gtk Anjuta libanjuta-gdb +</programlisting> +will display debug messages from Gtk, Anjuta and gdb plugin only. + + + AnjutaDockPane is an abstract wrapper class for panes in an +#AnjutaDock. + +Using AnjutaDockPane is especially helpful for those panes that show data +from extenal sources that must be refreshed frequently, or panes that are +exceptionally complex. + + + AnjutaEntry is a version of a #GtkEntry that displays some text, in +a lighter color, that describes what is to be entered into it. There is also +a button on the left to clear the entry's content quickly. AnjutaEntry is +similar to the serach boxes used in Evolution and Glade, but is more generic +can can be used in almost any situation. + + + #AnjutaPkgScanner is an async command that can be used to query the list +of files and the version of a package. + + + Anjuta plugins are components which are loaded in Anjuta IDE shell +either on startup or on demand to perform various subtasks. Plugins are +specialized in doing only a very specific task and can let other plugins +interract with it using interfaces. + +A plugin class is derived from #AnjutaPlugin class and will be used by +shell to instanciate any number of plugin objects. + +When a plugin class is derived from #AnjutaPlugin, the virtual mehtods +<emphasis>activate</emphasis> and <emphasis>deactivate</emphasis> must +be implemented. The <emphasis>activate</emphasis> method is used to +activate the plugin. Note that plugin activation is different from plugin +instance initialization. Instance initialization is use to do internal +initialization, while <emphasis>activate</emphasis> method is used to +setup the plugin in shell, UI and preferences. Other plugins can also +be queried in <emphasis>activate</emphasis> method. + +Following things should be done in <emphasis>activate</emphasis> method. +<orderedlist> + <listitem> + <para> + Register UI Actions: Use anjuta_ui_add_action_group_entries() or + anjuta_ui_add_toggle_action_group_entries() to add your action + groups. + </para> + </listitem> + <listitem> + <para> + Merge UI definition file: Use anjuta_ui_merge() to merge a UI + file. See #AnjutaUI for more detail. + </para> + </listitem> + <listitem> + <para> + Add widgets to Anjuta Shell: If the plugin has one or more + widgets as its User Interface, they can be added with + anjuta_shell_add_widget(). + </para> + </listitem> + <listitem> + <para> + Setup value watches with anjuta_plugin_add_watch(). + </para> + </listitem> +</orderedlist> + +<emphasis>deactivate</emphasis> method undos all the above. That is, it +removes widgets from the shell, unmerges UI and removes the action groups. + +Plugins interact with each other using interfaces. A plugin can expose an +interface which will let other plugins find it. Any number of interfaces can +be exposed by a plugin. These exposed interfaces are called +<emphasis>Primary</emphasis> interfaces of the plugin. The condition for +the interfaces to be primary is that they should be independent (i.e. +an external entity requesting to use a primary interface should not require +other primary interfaces). For example, an editor plugin can implement +#IAnjutaEditor, #IAnjutaStream and #IAnjutaFile interfaces and expose them +as primary interfaces, because they are independent. +<emphasis>Primary</emphasis> interfaces exposed by a plugin are exported in +its plugin meta-data file, so that plugin manager could register them. + +Any other interfaces implemented by the plugin are called +<emphasis>Secondary</emphasis> interfaces and they generally depend on +one or more primary interfaces. +For example, #IAnjutaEditor is the primary interface of anjuta-editor plugin, +but it also implements secondary interfaces #IAnjutaEditorGutter and +#IAnjutaEditorBuffer. Notice that secondary interfaces #IAnjutaEditorGutter +and #IAnjutaEditorBuffer depend on #IAnjutaEditor interface. + +The purpose of distinguishing between primary and +secondary interfaces is only at plugin level. At code level, they behave +just the same and there is no difference. +So, a natural sequence for a plugin to communicate with another plugin is: +<orderedlist> + <listitem> + <para> + Query the shell for a plugin implemeting the primary interface + using anjuta_shell_get_interface(). It will return an + implemetation of the interface (or %NULL if not found). + Do not save this object for longer use, because the implementor + plugin can change anytime and a different plugin implementing + the same primary interface may be activated. + <programlisting> +GError *err = NULL; +IAnjutaDocumentManager *docman; +IAnjutaEditor *editor; + +docman = anjuta_shell_get_interface (ANJUTA_PLUGIN(plugin)->shell, + IAnjutaDocumentManager, &amp;err); +if (err) +{ + g_warning ("Error encountered: %s", err->message); + g_error_free (err); + return; +} + +editor = ianjuta_document_manager_get_current_editor (docman, &amp;err); +if (err) +{ + g_warning ("Error encountered: %s", err->message); + g_error_free (err); + return; +} + +ianjuta_editor_goto_line (editor, 200); +... + </programlisting> + </para> +</listitem> +<listitem> + <para> + A primary interface of a plugin can be directly used, but + to use a secondary interface, make sure to check if the plugin + object implements it. For example, to check if editor plugin + implements IAnjutaEditorGutter interface, do something like: + <programlisting> + +if (IANJUTA_IS_EDITOR_GUTTER(editor)) +{ + ianjuta_editor_gutter_set_marker(IANJUTA_EDITOR_GUTTER (editor), + ANJUTA_EDITOR_MARKER_1, + line_number, &amp;err); +} + </programlisting> + </para> + </listitem> +</orderedlist> + +Plugins can also communicate with outside using Shell's <emphasis>Values +System</emphasis>. Values are objects exported by plugins to make them +available to other plugins. Read #AnjutaShell documentation for more +detail on <emphasis>Values System</emphasis>. A plugin can set up watches +with anjuta_plugin_add_watch() to get notifications for values exported +by other plugins. + +Values are very unreliable way of passing objects between plugins, but are +nevertheless very useful (and quicker to code). It must be used with care. +As a rule of thumb, a plugin should only watch values of other trusted +plugins. For example, a group of plugins forming a subsystem can comfortably +use values to pass objects and notifications. Use anjuta_plugin_add_watch() +and anjuta_plugin_remove_watch() to add or remove value watches. + + + Plugin handle is wrapper for installed plugins. For each installed plugin +there will be one corresponding plugin handle. It is mainly used by +plugin manager to keep track of loading and unloading of plugins. + + + #AnjutaPreferences is a way to let plugins register their preferences. There +are mainly two ways a plugin could register its preferences in Anjuta. + +First is to not use #AnjutaPreferences at all. Simply register a +preferences page in #AnjutaPreferencesDialog using the function +anjuta_preferences_dialog_add_page(). The plugin should take +care of loading, saving and widgets synchronization of the +preferences values. This can be done using #GSettings bindings +for example. + +Second is to use anjuta_preferences_add_page(), which will +automatically register the preferences keys and values from +a glade xml file. The glade xml file contains a preferences +page of the plugin. The widget names in the page are +given in a particular way (see anjuta_preferences_add_page()) to +let it know property key details. The preference dialog will automatically +setup the bindings between GSettings and the widgets. + + + Plugins can added preferences page with anjuta_preferences_dialog_add_page(). +However, read #AnjutaPreferences for adding proper preferences pages. + + + A anjuta profile contains the list of all plugins used in one Anjuta session. +It is possible to add and remove plugins, +check if one is included or get the whole list. The plugins list can be saved +into a xml file and loaded from it. + +A profile in an Anjuta session includes plugins from up to 3 different xml +sources: +<variablelist> + <varlistentry> + <term>$prefix/share/anjuta/profiles/default.profile</term> + <listitem> + <para> + This contains the system plugins. It is loaded in special system + profile and contains mandatory plugins for Anjuta. These plugins + cannot be unloaded. Anjuta can load a different profile using the -P + command line option. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>$project_dir/$project_name.anjuta</term> + <listitem> + <para> + This contains the project plugins. It lists mandatory plugins for the + project. This file is version controlled and distributed with the source + code. Every user working on the project uses the same one. If there + is no project loaded, no project plugins are loaded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>$project_dir/.anjuta/default.profile</term> + <listitem> + <para> + This contains the user plugins. This is the only list of plugins + which is updated when the user add or remove one plugin. + If there is no project loaded, the user home directory is used + instead of the project directory but this list is used only in this case. + There is no global user plugins list. + </para> + </listitem> + </varlistentry> +</variablelist> + + + Anjuta uses up to three profiles. A system profile which contains mandatory +plugins which are never unloaded. A user profile is used when no project is +loaded and a project profile when one is loaded. +If a second project is loaded, it is loaded in another instance of Anjuta. +When a project is closed, Anjuta goes back to the user profile. + +The profile manager can be in a frozen state where you can push or +pop a profile from the stack without triggering a change of the profile. + + + A project in Anjuta is represented by a tree. There are six kinds of node. + +The root node is the parent of all other nodes, it can implement +IAnjutaProject interface and represent the project itself but it is not +mandatory. + +A module node represents a module in autotools project, it is a group of +packages. + +A package node represents a package in autotools project, it is library. + +A group node is used to group several target or source, it can represent +a directory by example. + +A target node represents an object file defined explicitely. +There are different kinds of target: program, library... +A target have as children all source needed to build it. + +A source node represents a source file. These are lead of the tree, a source +node cannot have children. + +All these nodes are base objects. They have derived in each project backend +to provide more specific information. + + + A anjuta session contains local user settings, by example the list of files +open in one project. These settings are stored in +a .ini-like config file in a directory named session. Other libraries can +store their own settings in another format in the same directory. + + + Shell is the playground where plugins are loaded and their UI +widgets shown. It is also a place where plugins export objects for letting +other pluings to use. Plugins are loaded into shell on demand, but some +plugins are loaded on startup (such as help and text editor plugin). +Demand to load a plugin can be made by requesting for a primary inferface +using anjuta_shell_get_interface() or anjuta_shell_get_object(). + +Plugins can add widgets in shell with +anjuta_shell_add_widget() and remove with anjuta_shell_remove_widget() +functions. + +In Anjuta, shell is implemented using an advanced widget docking system, +allowing plugin widgets to dock, undock and layout in any fashion. Dock +layout is also maintained internally and is transparent to plugin +implementations. + +#AnjutaShell allows plugins to export arbitrary objects as <emphasis> +values</emphasis> in its <emphasis>Values System</emphasis>. "value_added" +and "value_removed" signals are emitted when a value is added to or +removed from the <emphasis>Values System</emphasis>, hence notifying +plugins of its state. However, plugins should really not connect directly +to these signals, because they are emitted for all values +and not just for the values the plugin is interested in. Instead, +to monitor specific <emphasis>Values</emphasis>, plugins should +setup watches using anjuta_plugin_add_watch(). + +<emphasis>Values</emphasis> are added, get or removed with +anjuta_shell_add_value() and anjuta_shell_get_value() or +anjuta_shell_remove_value(). There multi-valued equivalent functions +can be used to manipulate multiple values at once. + +<emphasis>Values</emphasis> are identified with names. Since <emphasis> +Values</emphasis> are effectively variables, their names should follow +the standard GNOME variable naming convention and should be as descriptive +as possible (e.g project_root_directory, project_name etc.). It is also +essential that meaningful prefix be given to names so that <emphasis> +Values</emphasis> are easily grouped (e.g all values exported by a +project manager should start with project_ prefix). + +Plugins can find other plugins with anjuta_shell_get_object() or +anjuta_shell_get_interface() based on their primary interfaces. + + + #AnjutaSyncCommand allows plugins to abstract the work of tasks that do not +need to be run in another thread. This class can provide a base for +abstratraction between client code and asynchronous facilities such as +#AnjutaLauncher or GIO, and is especially useful when complicated tasks +are being performed. + +#AnjutaSyncCommand simply calls ::run directly from ::start, and emits the +command-finished signal as soon as it returns. + +For an example of how #AnjutaSyncCommand is used, see the Git plugin. + + + A #AnjutaToken represents a token. It is a sequence of characters associated +with a type representing its meaning. By example, a token can represent +a keyword, a comment, a variable... + +The token can own the string or has only a pointer on some data allocated +somewhere else with a length. + +A token is linked with other tokens using three double linked lists. + +The first list using next and prev fields is used to keep the token in the +order where there are in the file. The first character of the first token is +the first character in the file. + +A second list is used to represent included +files. Such file is represented by a special token in the first list which +has a pointer, named children to a token list. Each token in this secondary +list has a pointer to its parent, it means the token representing the file +where is the token. It looks like a tree. In fact, every file is represented +by a special token, so the root node is normally a file token and has as +children all the token representing the file content. This parent/child list +is used for expanded variable too. + +A third list is used to group several tokens. A token can have a pointer to +another last token. It means that this token is a group starting from this +token to the one indicated by the last field. In addition each token in this +group has a pointer on the first token of the group. This grouping is +independent of the parent/child list. So a group can start in one file and +end in another included file. The grouping can be nested too. Typically +we can have a group representing a command, a sub group representing the +arguments and then one sub group for each argument. + + + A #AnjutaTokenStream object reads and writes a list of tokens. It uses two +list. The first list is assigned when the object is created. Each token is +read as characters discarding the separation between tokens. The second list +is written using the data of the first list, so no new memory is allocated, +in order to recreate a new list of tokens. + +This is used when the lexer needs several passes. At the beginning the file +is read as a single token containing the whole file content. The first pass +split this content into tokens. Additional passes are done on some parts of +the token list to get a more precise splitting. + +It is important to not allocate new memory and keep the same character +pointers in the additional passes because the token list does not own the +memory. The address of each character is used to find the position of the +changed data in the file. + +Several objects can be linked together to create a stack. It is used for +included file or variable expansion. + + + #AnjutaUI subclasses #GtkUIManager, so you should really read #GtkUIManager +documentation first to know about Actions, UI merging and UI XML file +format. This documentation will cover only the relevent APIs. + +#AnjutaUI has its own methods for adding action groups, which is differnt +from #GtkUIManager methods. All #AnjutaPlugin based classes should use +these methods instead of #GtkUIManager methods. The reason is, in addition +to adding the actions and groups to the UI manager, it also resgisters +them for UI customization and accellerators editing. It also keeps +record of all actions. + +An interesting side effect of this is that these +actions could be conveniently accessed or activated with +anjuta_ui_get_action() or anjuta_ui_activate_action_by_path(), without +the need of original action group object. This makes it is possible for +activating actions remotely from other plugins. + +anjuta_ui_get_accel_editor() will return a widget containing the +UI customization and accellerators editor. All actions and action groups +are organized into a tree view, which should be added to a visible +container (e.g. a #GtkDialog based object) and displayed to users. + +<note> + <para> + Any actions additions/removals using #GtkUIManager are not + registred with #AnjutaUI and hence their accellerators + cannot be edited. Nor will they be listed in UI manager + dialog. Hence, use #AnjutaUI methods whenever possible. + </para> +</note> + diff --git a/girs/Anthy-9000.gir b/girs/Anthy-9000.gir index 8f319fdd7..4c4c52b84 100644 --- a/girs/Anthy-9000.gir +++ b/girs/Anthy-9000.gir @@ -7,20 +7,49 @@ and/or use gtk-doc annotations. --> xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> - + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="AnthyGContext" glib:get-type="anthy_gcontext_get_type" glib:type-struct="GContextClass"> - An #AnthyGContext is an object that handles conversion strings. + An #AnthyGContext is an object that handles conversion strings. + - New an #AnthyGobject. + New an #AnthyGobject. + - A newly allocated #AnthyGContext + A newly allocated #AnthyGContext + + Set Anthy log level. + + + + + + + Log level + + + + - Commit a prediction string with @ntg_seg . + Commit a prediction string with @ntg_seg . + @@ -47,14 +104,19 @@ and/or use gtk-doc annotations. --> - Nth segment + Nth segment - Commit a string with @ntg_seg and @nth_lookup. + Commit a string with @ntg_seg and @nth_lookup. + @@ -63,18 +125,25 @@ and/or use gtk-doc annotations. --> - Nth segment + Nth segment - Nth lookup + Nth lookup - Set a personal dictionary. + Set a personal dictionary. + @@ -83,16 +152,23 @@ and/or use gtk-doc annotations. --> - a Dictionary name + a Dictionary name - The number of the candidates + The number of the candidates + - The number of the candidates + The number of the candidates @@ -106,9 +182,14 @@ and/or use gtk-doc annotations. --> - The number of the converted segments in the current prediction string. + The number of the converted segments in the current prediction string. + - The number of the converted segments in the current + The number of the converted segments in the current prediction string. @@ -120,9 +201,14 @@ and/or use gtk-doc annotations. --> - The number of the converted segments + The number of the converted segments + - The number of the converted segments + The number of the converted segments @@ -133,9 +219,14 @@ and/or use gtk-doc annotations. --> - A newly assigned string with @ntg_seg . + A newly assigned string with @ntg_seg . + - A newly assigned string. + A newly assigned string. @@ -143,15 +234,22 @@ and/or use gtk-doc annotations. --> - Nth segment + Nth segment - A newly assigned string with @ntg_seg and @nth_lookup . + A newly assigned string with @ntg_seg and @nth_lookup . + - A newly assigned string. + A newly assigned string. @@ -159,18 +257,25 @@ and/or use gtk-doc annotations. --> - Nth segment + Nth segment - Nth lookup + Nth lookup - Initialize the personal dictionaries. + Initialize the personal dictionaries. + @@ -182,7 +287,10 @@ and/or use gtk-doc annotations. --> - Resize the nth segment. + Resize the nth segment. + @@ -191,17 +299,24 @@ and/or use gtk-doc annotations. --> - nth segment + nth segment - size + size - Set an encoding. + Set an encoding. + @@ -210,14 +325,19 @@ and/or use gtk-doc annotations. --> - An encoding + An encoding - Set a prediction string. + Set a prediction string. + @@ -226,13 +346,18 @@ and/or use gtk-doc annotations. --> - A prediction string + A prediction string - Set a conversion string. + Set a conversion string. + @@ -241,7 +366,9 @@ and/or use gtk-doc annotations. --> - A conversion string + A conversion string @@ -253,7 +380,7 @@ and/or use gtk-doc annotations. --> - + @@ -261,67 +388,105 @@ and/or use gtk-doc annotations. --> + - + - + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + @@ -330,6 +495,7 @@ and/or use gtk-doc annotations. --> + @@ -343,6 +509,7 @@ and/or use gtk-doc annotations. --> + @@ -359,6 +526,7 @@ and/or use gtk-doc annotations. --> + @@ -373,6 +541,7 @@ and/or use gtk-doc annotations. --> + @@ -388,11 +557,13 @@ and/or use gtk-doc annotations. --> + + @@ -413,6 +584,7 @@ and/or use gtk-doc annotations. --> + @@ -420,12 +592,16 @@ and/or use gtk-doc annotations. --> - + + @@ -448,6 +624,7 @@ and/or use gtk-doc annotations. --> + @@ -458,12 +635,16 @@ and/or use gtk-doc annotations. --> - + + @@ -471,23 +652,29 @@ and/or use gtk-doc annotations. --> - + + + + @@ -501,6 +688,7 @@ and/or use gtk-doc annotations. --> + @@ -511,11 +699,13 @@ and/or use gtk-doc annotations. --> + + @@ -526,6 +716,7 @@ and/or use gtk-doc annotations. --> + @@ -536,6 +727,7 @@ and/or use gtk-doc annotations. --> + @@ -554,6 +746,7 @@ and/or use gtk-doc annotations. --> + @@ -567,6 +760,7 @@ and/or use gtk-doc annotations. --> + @@ -578,6 +772,7 @@ and/or use gtk-doc annotations. --> + @@ -592,6 +787,7 @@ and/or use gtk-doc annotations. --> + @@ -605,6 +801,7 @@ and/or use gtk-doc annotations. --> + diff --git a/girs/AppStream-1.0.gir b/girs/AppStream-1.0.gir index d78853cd0..c95a9e06b 100644 --- a/girs/AppStream-1.0.gir +++ b/girs/AppStream-1.0.gir @@ -22,21 +22,21 @@ and/or use gtk-doc annotations. --> glib:type-name="AsAgreement" glib:get-type="as_agreement_get_type" glib:type-struct="AgreementClass"> - + Creates a new #AsAgreement. - + line="435">Creates a new #AsAgreement. + a #AsAgreement + line="440">a #AsAgreement - + @@ -55,7 +55,7 @@ and/or use gtk-doc annotations. --> Gets the agreement kind. - + Gets the first section in the agreement. - + Gets all the sections in the agreement. - + Gets the agreement version_id. - + Sets the agreement kind. - + @@ -170,7 +170,7 @@ and/or use gtk-doc annotations. --> Sets the agreement version identifier. - + @@ -196,13 +196,13 @@ and/or use gtk-doc annotations. --> - + - + @@ -210,7 +210,7 @@ and/or use gtk-doc annotations. --> - + @@ -218,7 +218,7 @@ and/or use gtk-doc annotations. --> - + @@ -226,7 +226,7 @@ and/or use gtk-doc annotations. --> - + @@ -234,7 +234,7 @@ and/or use gtk-doc annotations. --> - + @@ -242,7 +242,7 @@ and/or use gtk-doc annotations. --> - + @@ -250,7 +250,7 @@ and/or use gtk-doc annotations. --> - + @@ -258,7 +258,7 @@ and/or use gtk-doc annotations. --> - + @@ -271,7 +271,7 @@ and/or use gtk-doc annotations. --> c:type="AsAgreementKind"> The kind of the agreement. + line="51">The kind of the agreement. glib:name="AS_AGREEMENT_KIND_UNKNOWN"> Unknown value + line="53">Unknown value glib:name="AS_AGREEMENT_KIND_GENERIC"> A generic agreement without a specific type + line="54">A generic agreement without a specific type glib:name="AS_AGREEMENT_KIND_EULA"> An End User License Agreement + line="55">An End User License Agreement glib:name="AS_AGREEMENT_KIND_PRIVACY"> A privacy agreement, typically a GDPR statement + line="56">A privacy agreement, typically a GDPR statement Converts the text representation to an enumerated value. - + Converts the enumerated value to an text representation. - + glib:type-name="AsAgreementSection" glib:get-type="as_agreement_section_get_type" glib:type-struct="AgreementSectionClass"> - + Creates a new #AsAgreementSection. - + line="389">Creates a new #AsAgreementSection. + a #AsAgreementSection + line="394">a #AsAgreementSection - + Get the current active locale, which -is used to get localized messages. - - - + line="197">Returns the #AsContext associated with this section. +This function may return %NULL if no context is set. + + + the #AsContext used by this agreement section. + + An instance of #AsAgreementSection. @@ -397,12 +404,12 @@ is used to get localized messages. version="0.12.1"> Gets the agreement section desc. - + line="159">Gets the agreement section desc. + a string, e.g. "GDPR", or NULL + line="165">a string, e.g. "GDPR", or NULL @@ -410,7 +417,7 @@ is used to get localized messages. transfer-ownership="none"> a #AsAgreementSection instance. + line="161">a #AsAgreementSection instance. @@ -421,7 +428,7 @@ is used to get localized messages. Gets the agreement section kind. - + Gets the agreement section name. - + - + Set the current active locale, which -is used to get localized messages. - + line="215">Sets the document context this release is associated +with. + @@ -476,17 +484,14 @@ is used to get localized messages. transfer-ownership="none"> an #AsAgreement + line="217">An instance of #AsAgreementSection. - + a POSIX or BCP47 locale, or %NULL. e.g. "de_DE" - + line="218">the #AsContext. + @@ -495,8 +500,8 @@ is used to get localized messages. version="0.12.1"> Sets the agreement section desc. - + line="178">Sets the agreement section desc. + @@ -505,13 +510,13 @@ is used to get localized messages. transfer-ownership="none"> a #AsAgreementSection instance. + line="180">a #AsAgreementSection instance. the agreement description, e.g. "GDPR" + line="182">the agreement description, e.g. "GDPR" allow-none="1"> the locale in BCP47 format. e.g. "en-GB" + line="181">the locale in BCP47 format. e.g. "en-GB" @@ -531,7 +536,7 @@ is used to get localized messages. Sets the agreement section kind. - + @@ -556,8 +561,8 @@ is used to get localized messages. version="0.12.1"> Sets the agreement section name. - + line="140">Sets the agreement section name. + @@ -566,13 +571,13 @@ is used to get localized messages. transfer-ownership="none"> a #AsAgreementSection instance. + line="142">a #AsAgreementSection instance. the agreement name, e.g. "GDPR" + line="143">the agreement name, e.g. "GDPR" allow-none="1"> the locale. e.g. "en_GB" + line="144">the locale. e.g. "en_GB" @@ -593,13 +598,13 @@ is used to get localized messages. - + - + @@ -607,7 +612,7 @@ is used to get localized messages. - + @@ -615,7 +620,7 @@ is used to get localized messages. - + @@ -623,7 +628,7 @@ is used to get localized messages. - + @@ -631,7 +636,7 @@ is used to get localized messages. - + @@ -639,7 +644,7 @@ is used to get localized messages. - + @@ -647,7 +652,7 @@ is used to get localized messages. - + @@ -655,7 +660,7 @@ is used to get localized messages. - + @@ -669,24 +674,24 @@ is used to get localized messages. glib:type-name="AsArtifact" glib:get-type="as_artifact_get_type" glib:type-struct="ArtifactClass"> - + Creates a new #AsArtifact. - + line="646">Creates a new #AsArtifact. + a #AsArtifact + line="651">a #AsArtifact Add a checksum for the file associated with this artifact. - + line="253">Add a checksum for the file associated with this artifact. + @@ -694,13 +699,13 @@ is used to get localized messages. An instance of #AsArtifact. + line="255">An instance of #AsArtifact. The #AsChecksum. + line="256">The #AsChecksum. @@ -708,8 +713,8 @@ is used to get localized messages. Adds a artifact location. - + line="204">Adds a artifact location. + @@ -720,7 +725,7 @@ is used to get localized messages. An URL of the download location + line="206">An URL of the download location @@ -729,19 +734,19 @@ is used to get localized messages. c:identifier="as_artifact_get_bundle_kind"> Gets the bundle kind of this artifact. - + line="331">Gets the bundle kind of this artifact. + the #AsBundleKind + line="337">the #AsBundleKind an #AsArtifact instance. + line="333">an #AsArtifact instance. @@ -749,19 +754,19 @@ is used to get localized messages. Gets the artifact checksum - + line="231">Gets the artifact checksum + an #AsChecksum, or %NULL for not set or invalid + line="237">an #AsChecksum, or %NULL for not set or invalid a #AsArtifact instance. + line="233">a #AsArtifact instance. @@ -772,12 +777,12 @@ is used to get localized messages. Get a list of all checksums we have for this artifact. - + line="217">Get a list of all checksums we have for this artifact. + an array of #AsChecksum objects. + line="222">an array of #AsChecksum objects. @@ -791,20 +796,20 @@ is used to get localized messages. Gets a suggested filename for the downloaded artifact, + line="360">Gets a suggested filename for the downloaded artifact, or %NULL if none is suggested. - + The platform triplet or identifier string. + line="367">The platform triplet or identifier string. a #AsArtifact instance. + line="362">a #AsArtifact instance. @@ -812,19 +817,19 @@ or %NULL if none is suggested. Gets the artifact kind. - + line="174">Gets the artifact kind. + the #AsArtifactKind + line="180">the #AsArtifactKind a #AsArtifact instance. + line="176">a #AsArtifact instance. @@ -832,12 +837,12 @@ or %NULL if none is suggested. Gets the artifact locations, typically URLs. - + line="190">Gets the artifact locations, typically URLs. + list of locations + line="195">list of locations @@ -851,19 +856,19 @@ or %NULL if none is suggested. Gets the artifact platform string (e.g. a triplet like "x86_64-linux-gnu"). - + line="302">Gets the artifact platform string (e.g. a triplet like "x86_64-linux-gnu"). + The platform triplet or identifier string. + line="308">The platform triplet or identifier string. a #AsArtifact instance. + line="304">a #AsArtifact instance. @@ -871,25 +876,25 @@ or %NULL if none is suggested. Gets the artifact size. - + line="267">Gets the artifact size. + The size of the given kind of this artifact. + line="274">The size of the given kind of this artifact. a #AsArtifact instance + line="269">a #AsArtifact instance a #AsSizeKind + line="270">a #AsSizeKind @@ -898,8 +903,8 @@ or %NULL if none is suggested. c:identifier="as_artifact_set_bundle_kind"> Sets the bundle kind for this release artifact. - + line="346">Sets the bundle kind for this release artifact. + @@ -907,13 +912,13 @@ or %NULL if none is suggested. an #AsArtifact instance. + line="348">an #AsArtifact instance. the #AsBundleKind, e.g. %AS_BUNDLE_KIND_TARBALL. + line="349">the #AsBundleKind, e.g. %AS_BUNDLE_KIND_TARBALL. @@ -921,8 +926,8 @@ or %NULL if none is suggested. Sets a suggested filename for this artifact after it has been downloaded. - + line="376">Sets a suggested filename for this artifact after it has been downloaded. + @@ -930,13 +935,13 @@ or %NULL if none is suggested. a #AsArtifact instance. + line="378">a #AsArtifact instance. the file name suggestion. + line="379">the file name suggestion. @@ -944,8 +949,8 @@ or %NULL if none is suggested. Sets the artifact kind. - + line="159">Sets the artifact kind. + @@ -953,13 +958,13 @@ or %NULL if none is suggested. a #AsArtifact instance. + line="161">a #AsArtifact instance. the #AsArtifactKind, e.g. %AS_ARTIFACT_KIND_SOURCE. + line="162">the #AsArtifactKind, e.g. %AS_ARTIFACT_KIND_SOURCE. @@ -967,8 +972,8 @@ or %NULL if none is suggested. Sets the artifact platform triplet or identifier string. - + line="317">Sets the artifact platform triplet or identifier string. + @@ -976,13 +981,13 @@ or %NULL if none is suggested. a #AsArtifact instance. + line="319">a #AsArtifact instance. the platform triplet. + line="320">the platform triplet. @@ -990,8 +995,8 @@ or %NULL if none is suggested. Sets the artifact size for the given kind. - + line="284">Sets the artifact size for the given kind. + @@ -999,19 +1004,19 @@ or %NULL if none is suggested. a #AsArtifact instance + line="286">a #AsArtifact instance a size in bytes, or 0 for unknown + line="287">a size in bytes, or 0 for unknown a #AsSizeKind + line="288">a #AsSizeKind @@ -1023,13 +1028,13 @@ or %NULL if none is suggested. - + - + @@ -1037,7 +1042,7 @@ or %NULL if none is suggested. - + @@ -1045,7 +1050,7 @@ or %NULL if none is suggested. - + @@ -1053,7 +1058,7 @@ or %NULL if none is suggested. - + @@ -1061,7 +1066,7 @@ or %NULL if none is suggested. - + @@ -1069,7 +1074,7 @@ or %NULL if none is suggested. - + @@ -1082,7 +1087,7 @@ or %NULL if none is suggested. c:type="AsArtifactKind"> The artifact type. + line="69">The artifact type. glib:name="AS_ARTIFACT_KIND_UNKNOWN"> Type invalid or not known + line="71">Type invalid or not known glib:name="AS_ARTIFACT_KIND_SOURCE"> The artifact describes software sources. + line="72">The artifact describes software sources. glib:name="AS_ARTIFACT_KIND_BINARY"> The artifact describes a binary distribution of the component. + line="73">The artifact describes a binary distribution of the component. Converts the text representation to an enumerated value. - + line="88">Converts the text representation to an enumerated value. + a #AsArtifactKind, or %AS_ARTIFACT_KIND_UNKNOWN for unknown. + line="94">a #AsArtifactKind, or %AS_ARTIFACT_KIND_UNKNOWN for unknown. the string. + line="90">the string. @@ -1133,19 +1138,19 @@ or %NULL if none is suggested. Converts the enumerated value to an text representation. - + line="107">Converts the enumerated value to an text representation. + string version of @kind + line="113">string version of @kind the #AsArtifactKind. + line="109">the #AsArtifactKind. @@ -1158,16 +1163,16 @@ or %NULL if none is suggested. glib:type-name="AsBranding" glib:get-type="as_branding_get_type" glib:type-struct="BrandingClass"> - + Creates a new #AsBranding. - + line="534">Creates a new #AsBranding. + a #AsBranding + line="539">a #AsBranding @@ -1176,33 +1181,33 @@ or %NULL if none is suggested. version="0.15.2"> Retrieve a color of the given @kind that matches @scheme_kind. + line="327">Retrieve a color of the given @kind that matches @scheme_kind. If a color has no scheme preference defined, it will be returned for either scheme type, unless a more suitable color was found. - + The HTML color code of the found color, or %NULL if no color was found. + line="337">The HTML color code of the found color, or %NULL if no color was found. an #AsBranding instance. + line="329">an #AsBranding instance. the #AsColorKind, e.g. %AS_COLOR_KIND_PRIMARY. + line="330">the #AsColorKind, e.g. %AS_COLOR_KIND_PRIMARY. Color scheme preference for the color, e.g. %AS_COLOR_SCHEME_KIND_LIGHT + line="331">Color scheme preference for the color, e.g. %AS_COLOR_SCHEME_KIND_LIGHT @@ -1212,8 +1217,8 @@ unless a more suitable color was found. version="0.15.2"> Deletes a color that matches the given type and scheme preference. - + line="225">Deletes a color that matches the given type and scheme preference. + @@ -1221,19 +1226,19 @@ unless a more suitable color was found. an #AsBranding instance. + line="227">an #AsBranding instance. the #AsColorKind, e.g. %AS_COLOR_KIND_PRIMARY. + line="228">the #AsColorKind, e.g. %AS_COLOR_KIND_PRIMARY. Type of color scheme preferred for this color, e.g. %AS_COLOR_SCHEME_KIND_LIGHT + line="229">Type of color scheme preferred for this color, e.g. %AS_COLOR_SCHEME_KIND_LIGHT @@ -1243,9 +1248,9 @@ unless a more suitable color was found. version="0.15.2"> Sets a new accent color. If a color of the given kind with the given scheme preference already exists, + line="189">Sets a new accent color. If a color of the given kind with the given scheme preference already exists, it will be overriden with the new color code. - + @@ -1253,25 +1258,25 @@ it will be overriden with the new color code. an #AsBranding instance. + line="191">an #AsBranding instance. the #AsColorKind, e.g. %AS_COLOR_KIND_PRIMARY. + line="192">the #AsColorKind, e.g. %AS_COLOR_KIND_PRIMARY. Type of color scheme preferred for this color, e.g. %AS_COLOR_SCHEME_KIND_LIGHT + line="193">Type of color scheme preferred for this color, e.g. %AS_COLOR_SCHEME_KIND_LIGHT a HTML color code. + line="194">a HTML color code. @@ -1283,13 +1288,13 @@ it will be overriden with the new color code. - + - + @@ -1297,7 +1302,7 @@ it will be overriden with the new color code. - + @@ -1305,7 +1310,7 @@ it will be overriden with the new color code. - + @@ -1313,7 +1318,7 @@ it will be overriden with the new color code. - + @@ -1321,7 +1326,7 @@ it will be overriden with the new color code. - + @@ -1329,7 +1334,7 @@ it will be overriden with the new color code. - + @@ -1339,11 +1344,11 @@ it will be overriden with the new color code. A #AsBrandingColorIter structure represents an iterator that can be used + line="43">A #AsBrandingColorIter structure represents an iterator that can be used to iterate over the accent colors of an #AsBranding object. #AsBrandingColorIter structures are typically allocated on the stack and then initialized with as_branding_color_iter_init(). - + @@ -1365,11 +1370,11 @@ then initialized with as_branding_color_iter_init(). Initializes a color iterator for the accent color list and associates it + line="251">Initializes a color iterator for the accent color list and associates it it with @branding. The #AsBrandingColorIter structure is typically allocated on the stack and does not need to be freed explicitly. - + @@ -1377,13 +1382,13 @@ and does not need to be freed explicitly. an uninitialized #AsBrandingColorIter + line="253">an uninitialized #AsBrandingColorIter an #AsBranding + line="254">an #AsBranding @@ -1391,7 +1396,7 @@ and does not need to be freed explicitly. Returns the current color entry and advances the iterator. + line="273">Returns the current color entry and advances the iterator. Example: |[<!-- language="C" --> AsBrandingColorIter iter; @@ -1404,18 +1409,18 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc // do something with the color data } ]| - + %FALSE if the last entry has been reached. + line="294">%FALSE if the last entry has been reached. an initialized #AsBrandingColorIter + line="275">an initialized #AsBrandingColorIter Destination of the returned color kind. + line="276">Destination of the returned color kind. Destination of the returned color's scheme preference. + line="277">Destination of the returned color's scheme preference. Destination of the returned color code. + line="278">Destination of the returned color code. @@ -1461,35 +1466,35 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc glib:type-name="AsBundle" glib:get-type="as_bundle_get_type" glib:type-struct="BundleClass"> - + Creates a new #AsBundle. - + line="304">Creates a new #AsBundle. + a #AsBundle + line="309">a #AsBundle Gets the ID for this bundle. + line="129">Gets the ID for this bundle. ID, e.g. "foobar-1.0.2" + line="135">ID, e.g. "foobar-1.0.2" an #AsBundle instance. + line="131">an #AsBundle instance. @@ -1497,19 +1502,19 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc Gets the bundle kind. - + line="163">Gets the bundle kind. + the #AsBundleKind + line="169">the #AsBundleKind an #AsBundle instance. + line="165">an #AsBundle instance. @@ -1517,7 +1522,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc Sets the ID for this bundle. + line="146">Sets the ID for this bundle. @@ -1526,13 +1531,13 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc an #AsBundle instance. + line="148">an #AsBundle instance. the URL. + line="149">the URL. @@ -1540,8 +1545,8 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc Sets the bundle kind. - + line="180">Sets the bundle kind. + @@ -1549,13 +1554,13 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc an #AsBundle instance. + line="182">an #AsBundle instance. the #AsBundleKind, e.g. %AS_BUNDLE_KIND_LIMBA. + line="183">the #AsBundleKind, e.g. %AS_BUNDLE_KIND_LIMBA. @@ -1567,13 +1572,13 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc - + - + @@ -1581,7 +1586,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc - + @@ -1589,7 +1594,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc - + @@ -1597,7 +1602,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc - + @@ -1605,7 +1610,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc - + @@ -1613,7 +1618,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc - + @@ -1626,7 +1631,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc c:type="AsBundleKind"> The bundle type. + line="46">The bundle type. Type invalid or not known + line="48">Type invalid or not known A native package (currently not used) + line="49">A native package (currently not used) A Limba bundle + line="50">A Limba bundle A Flatpak bundle + line="51">A Flatpak bundle An AppImageKit bundle + line="52">An AppImageKit bundle A Snap/Snappy bundle + line="53">A Snap/Snappy bundle A (maybe compressed) tarball. + line="54">A (maybe compressed) tarball. Cabinet firmware deployment + line="55">Cabinet firmware deployment + + + A Linglong bundle Converts the text representation to an enumerated value. - + line="76">Converts the text representation to an enumerated value. + a #AsBundleKind or %AS_BUNDLE_KIND_UNKNOWN for unknown + line="82">a #AsBundleKind or %AS_BUNDLE_KIND_UNKNOWN for unknown the string. + line="78">the string. @@ -1724,19 +1738,19 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc version="0.8.0"> Converts the enumerated value to an text representation. - + line="44">Converts the enumerated value to an text representation. + string version of @kind + line="50">string version of @kind the %AsBundleKind. + line="46">the %AsBundleKind. @@ -1755,13 +1769,22 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc + + + + + + + Flags on how caching should be used. + line="77">Flags on how caching should be used. No flags. + line="79">No flags. Create an user-specific metadata cache. + line="80">Create an user-specific metadata cache. Use and - if possible - update the system metadata cache. + line="81">Use and - if possible - update the system metadata cache. Don't clear the cache when opening it. + line="82">Don't clear the cache when opening it. Refresh the system cache that is shared between applications. + line="83">Refresh the system cache that is shared between applications. - + Creates a new #AsCategory. - + line="763">Creates a new #AsCategory. + a new #AsCategory + line="768">a new #AsCategory Add a subcategory to this category. - + line="465">Add a subcategory to this category. + @@ -1840,13 +1863,13 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc An instance of #AsCategory. + line="467">An instance of #AsCategory. A subcategory to add. + line="468">A subcategory to add. @@ -1854,8 +1877,8 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc Add a component to this category. - + line="607">Add a component to this category. + @@ -1863,13 +1886,13 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc An instance of #AsCategory. + line="609">An instance of #AsCategory. The #AsComponent to add. + line="610">The #AsComponent to add. @@ -1878,8 +1901,8 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc c:identifier="as_category_add_desktop_group"> Add a desktop-file category to this #AsCategory. - + line="578">Add a desktop-file category to this #AsCategory. + @@ -1887,13 +1910,13 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc An instance of #AsCategory. + line="580">An instance of #AsCategory. A subcategory to add. + line="581">A subcategory to add. @@ -1901,11 +1924,11 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc - + A list of subcategories. + line="456">A list of subcategories. @@ -1914,7 +1937,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc An instance of #AsCategory. + line="454">An instance of #AsCategory. @@ -1922,12 +1945,12 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc Get list of components which have been sorted into this category. - + line="592">Get list of components which have been sorted into this category. + List of #AsCategory + line="598">List of #AsCategory @@ -1936,18 +1959,18 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc An instance of #AsCategory. + line="594">An instance of #AsCategory. - + A list of desktop-file categories. + line="569">A list of desktop-file categories. @@ -1956,7 +1979,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc An instance of #AsCategory. + line="567">An instance of #AsCategory. @@ -1966,8 +1989,8 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc glib:get-property="icon"> Get the stock icon name for this category. - + line="537">Get the stock icon name for this category. + @@ -1975,7 +1998,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc An instance of #AsCategory. + line="539">An instance of #AsCategory. @@ -1985,8 +2008,8 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc glib:get-property="id"> Get the ID of this category. - + line="396">Get the ID of this category. + @@ -1994,7 +2017,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc An instance of #AsCategory. + line="398">An instance of #AsCategory. @@ -2004,8 +2027,8 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc glib:get-property="name"> Get the name of this category. - + line="424">Get the name of this category. + @@ -2013,7 +2036,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc An instance of #AsCategory. + line="426">An instance of #AsCategory. @@ -2023,8 +2046,8 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc glib:get-property="summary"> Get the summary (short description) of this category. - + line="508">Get the summary (short description) of this category. + @@ -2032,7 +2055,7 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc An instance of #AsCategory. + line="510">An instance of #AsCategory. @@ -2040,19 +2063,19 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc Test for sub-categories. - + line="493">Test for sub-categories. + %TRUE if this category has any subcategory + line="499">%TRUE if this category has any subcategory An instance of #AsCategory. + line="495">An instance of #AsCategory. @@ -2060,26 +2083,26 @@ while (as_branding_color_iter_next (&iter, &ckind, &scheme_preferenc Check if the exact #AsComponent @cpt is a member of this + line="621">Check if the exact #AsComponent @cpt is a member of this category already. - + %TRUE if the component is present. + line="629">%TRUE if the component is present. An instance of #AsCategory. + line="623">An instance of #AsCategory. The #AsComponent to look for. + line="624">The #AsComponent to look for. @@ -2087,8 +2110,8 @@ category already. Drop a subcategory from this #AsCategory. - + line="479">Drop a subcategory from this #AsCategory. + @@ -2096,13 +2119,13 @@ category already. An instance of #AsCategory. + line="481">An instance of #AsCategory. A subcategory to remove. + line="482">A subcategory to remove. @@ -2112,8 +2135,8 @@ category already. glib:set-property="icon"> Set the stock icon name for this category. - + line="550">Set the stock icon name for this category. + @@ -2121,7 +2144,7 @@ category already. An instance of #AsCategory. + line="552">An instance of #AsCategory. @@ -2134,8 +2157,8 @@ category already. glib:set-property="id"> Set the ID of this category. - + line="409">Set the ID of this category. + @@ -2143,7 +2166,7 @@ category already. An instance of #AsCategory. + line="411">An instance of #AsCategory. @@ -2156,8 +2179,8 @@ category already. glib:set-property="name"> Set the name of this category. - + line="437">Set the name of this category. + @@ -2165,7 +2188,7 @@ category already. An instance of #AsCategory. + line="439">An instance of #AsCategory. @@ -2176,8 +2199,8 @@ category already. Get the summary (short description) of this category. - + line="521">Get the summary (short description) of this category. + @@ -2185,13 +2208,13 @@ category already. An instance of #AsCategory. + line="523">An instance of #AsCategory. A new short summary of this category. + line="524">A new short summary of this category. @@ -2238,13 +2261,13 @@ category already. - + - + @@ -2252,7 +2275,7 @@ category already. - + @@ -2260,7 +2283,7 @@ category already. - + @@ -2268,28 +2291,134 @@ category already. - + + + The type of chassis a computing device is built into. + + Unknown chassis. + + + A desktop/workstation + + + A mobile computer with a bigger screen / laptop + + + A server, often without GUI + + + A tablet with touch as primary input method + + + A smaller touch-input device, like a smartphone + + + Converts the text representation to an enumerated value. + + + a #AsChassisKind or %AS_CHASSIS_KIND_UNKNOWN for unknown + + + + + the string. + + + + + + Converts the enumerated value to a text representation. + + + string version of @kind + + + + + the #AsChassisKind. + + + + + Result of a check operation. + filename="src/as-system-info.h" + line="48">Result of a check operation. The check failed. + filename="src/as-system-info.h" + line="50">The check failed. glib:nick="unknown" glib:name="AS_CHECK_RESULT_UNKNOWN"> The outcome could not be determined. + filename="src/as-system-info.h" + line="51">The outcome could not be determined. glib:nick="false" glib:name="AS_CHECK_RESULT_FALSE"> False/No + filename="src/as-system-info.h" + line="52">False/No glib:nick="true" glib:name="AS_CHECK_RESULT_TRUE"> True/Yes + filename="src/as-system-info.h" + line="53">True/Yes glib:type-name="AsChecksum" glib:get-type="as_checksum_get_type" glib:type-struct="ChecksumClass"> - + Creates a new #AsChecksum. - + line="290">Creates a new #AsChecksum. + an #AsChecksum + line="295">an #AsChecksum - Creates a new #AsChecksum with the given hash + line="271">Creates a new #AsChecksum with the given hash function and hash value. - + an #AsChecksum + line="277">an #AsChecksum @@ -2365,19 +2494,19 @@ function and hash value. Gets the checksum type. + line="122">Gets the checksum type. the #AsChecksumKind + line="128">the #AsChecksumKind a #AsChecksum instance. + line="124">a #AsChecksum instance. @@ -2385,19 +2514,19 @@ function and hash value. Gets the checksum, usually in its hexadecimal form. - + line="151">Gets the checksum, usually in its hexadecimal form. + the checksum. + line="157">the checksum. a #AsChecksum instance. + line="153">a #AsChecksum instance. @@ -2405,7 +2534,7 @@ function and hash value. Sets the checksum type. + line="137">Sets the checksum type. @@ -2414,13 +2543,13 @@ function and hash value. a #AsChecksum instance. + line="139">a #AsChecksum instance. the #AsChecksumKind, e.g. %AS_CHECKSUM_KIND_SHA256. + line="140">the #AsChecksumKind, e.g. %AS_CHECKSUM_KIND_SHA256. @@ -2428,8 +2557,8 @@ function and hash value. Sets the checksum value filename. - + line="166">Sets the checksum value filename. + @@ -2437,13 +2566,13 @@ function and hash value. a #AsChecksum instance. + line="168">a #AsChecksum instance. the new value. + line="169">the new value. @@ -2455,13 +2584,13 @@ function and hash value. - + - + @@ -2469,7 +2598,7 @@ function and hash value. - + @@ -2477,7 +2606,7 @@ function and hash value. - + @@ -2485,7 +2614,7 @@ function and hash value. - + @@ -2493,7 +2622,7 @@ function and hash value. - + @@ -2501,7 +2630,7 @@ function and hash value. - + @@ -2514,7 +2643,7 @@ function and hash value. c:type="AsChecksumKind"> Checksums supported by #AsRelease + line="46">Checksums supported by #AsRelease glib:name="AS_CHECKSUM_KIND_NONE"> No checksum + line="48">No checksum glib:name="AS_CHECKSUM_KIND_SHA1"> SHA1 checksum + line="49">SHA1 checksum glib:name="AS_CHECKSUM_KIND_SHA256"> SHA256 checksum + line="50">SHA256 checksum - + SHA512 checksum + + BLAKE2b checksum + line="52">BLAKE2 checksum - + BLAKE2s checksum + line="53">BLAKE3 checksum Converts the text representation to an enumerated value. - + line="71">Converts the text representation to an enumerated value. + a #AsChecksumKind or %AS_CHECKSUM_KIND_NONE for unknown + line="77">a #AsChecksumKind or %AS_CHECKSUM_KIND_NONE for unknown the string. + line="73">the string. @@ -2583,19 +2721,19 @@ function and hash value. Converts the enumerated value to an text representation. - + line="45">Converts the enumerated value to an text representation. + string version of @kind + line="51">string version of @kind the %AsChecksumKind. + line="47">the %AsChecksumKind. @@ -2607,7 +2745,7 @@ function and hash value. c:type="AsColorKind"> A branding color type. + line="56">A branding color type. glib:name="AS_COLOR_KIND_UNKNOWN"> Color type invalid or not known + line="58">Color type invalid or not known glib:name="AS_COLOR_KIND_PRIMARY"> Primary accent color + line="59">Primary accent color Converts the text representation to an enumerated value. - + line="105">Converts the text representation to an enumerated value. + a #AsColorKind or %AS_COLOR_KIND_UNKNOWN for unknown. + line="111">a #AsColorKind or %AS_COLOR_KIND_UNKNOWN for unknown. the string. + line="107">the string. @@ -2653,19 +2791,19 @@ function and hash value. version="0.15.2"> Converts the enumerated value to an text representation. - + line="87">Converts the enumerated value to an text representation. + string version of @kind + line="93">string version of @kind the %AsColorKind. + line="89">the %AsColorKind. @@ -2677,7 +2815,7 @@ function and hash value. c:type="AsColorSchemeKind"> A color scheme type. + line="70">A color scheme type. glib:name="AS_COLOR_SCHEME_KIND_UNKNOWN"> Color scheme invalid or not known + line="72">Color scheme invalid or not known glib:name="AS_COLOR_SCHEME_KIND_LIGHT"> A light color scheme + line="73">A light color scheme glib:name="AS_COLOR_SCHEME_KIND_DARK"> A dark color scheme + line="74">A dark color scheme Converts the text representation to an enumerated value. - + line="143">Converts the text representation to an enumerated value. + a #AsColorKind or %AS_COLOR_SCHEME_KIND_UNKNOWN for unknown. + line="149">a #AsColorKind or %AS_COLOR_SCHEME_KIND_UNKNOWN for unknown. the string. + line="145">the string. @@ -2732,19 +2870,19 @@ function and hash value. version="0.15.2"> Converts the enumerated value to an text representation. - + line="123">Converts the enumerated value to an text representation. + string version of @kind + line="129">string version of @kind the %AsColorSchemeKind. + line="125">the %AsColorSchemeKind. @@ -2757,16 +2895,16 @@ function and hash value. glib:type-name="AsComponent" glib:get-type="as_component_get_type" glib:type-struct="ComponentClass"> - + Creates a new #AsComponent. - + line="6862">Creates a new #AsComponent. + a new #AsComponent + line="6867">a new #AsComponent @@ -2775,8 +2913,8 @@ function and hash value. version="0.9.2"> Add a reference to the addon that is enhancing this component. - + line="806">Add a reference to the addon that is enhancing this component. + @@ -2784,13 +2922,13 @@ function and hash value. a #AsComponent instance. + line="808">a #AsComponent instance. The #AsComponent that extends @cpt + line="809">The #AsComponent that extends @cpt @@ -2800,8 +2938,8 @@ function and hash value. version="0.12.1"> Adds an agreement to the software component. - + line="3941">Adds an agreement to the software component. + @@ -2809,13 +2947,13 @@ function and hash value. a #AsComponent instance. + line="3943">a #AsComponent instance. an #AsAgreement instance. + line="3944">an #AsAgreement instance. @@ -2825,8 +2963,8 @@ function and hash value. version="0.8.0"> Adds a bundle to the component. - + line="879">Adds a bundle to the component. + @@ -2834,13 +2972,13 @@ function and hash value. a #AsComponent instance. + line="881">a #AsComponent instance. The #AsBundle to add. + line="882">The #AsBundle to add. @@ -2848,8 +2986,8 @@ function and hash value. Add a category. - + line="1704">Add a category. + @@ -2857,13 +2995,13 @@ function and hash value. a #AsComponent instance. + line="1706">a #AsComponent instance. the categories name to add. + line="1707">the categories name to add. @@ -2873,8 +3011,8 @@ function and hash value. version="0.11.0"> Adds a content rating to this component. - + line="3544">Adds a content rating to this component. + @@ -2882,13 +3020,13 @@ function and hash value. a #AsComponent instance. + line="3546">a #AsComponent instance. a #AsContentRating instance. + line="3547">a #AsContentRating instance. @@ -2898,8 +3036,8 @@ function and hash value. version="0.15.5"> Add a reference to the extended component - + line="764">Add a reference to the extended component + @@ -2907,13 +3045,13 @@ function and hash value. a #AsComponent instance. + line="766">a #AsComponent instance. The id of a component which is extended by this component + line="767">The id of a component which is extended by this component @@ -2921,8 +3059,8 @@ function and hash value. Add an icon to this component. - + line="1677">Add an icon to this component. + @@ -2930,13 +3068,13 @@ function and hash value. an #AsComponent instance + line="1679">an #AsComponent instance the valid #AsIcon instance to add. + line="1680">the valid #AsIcon instance to add. @@ -2944,9 +3082,9 @@ function and hash value. Add a new keyword to the keywords list for the given locale. This function does not + line="1553">Add a new keyword to the keywords list for the given locale. This function does not check for duplicate keywords. - + @@ -2954,13 +3092,13 @@ check for duplicate keywords. an #AsComponent instance. + line="1555">an #AsComponent instance. The new keyword to add. + line="1556">The new keyword to add. allow-none="1"> BCP47 locale of the values, or %NULL to use current locale. + line="1557">BCP47 locale of the values, or %NULL to use current locale. @@ -2979,8 +3117,8 @@ check for duplicate keywords. version="0.7.0"> Adds a language to the component. - + line="2491">Adds a language to the component. + @@ -2988,7 +3126,7 @@ check for duplicate keywords. an #AsComponent instance. + line="2493">an #AsComponent instance. allow-none="1"> the BCP47 locale, or %NULL. e.g. "en-GB" + line="2494">the BCP47 locale, or %NULL. e.g. "en-GB" the percentage completion of the translation, 0 for locales with unknown amount of translation + line="2495">the percentage completion of the translation, 0 for locales with unknown amount of translation @@ -3013,8 +3151,8 @@ check for duplicate keywords. version="0.11.0"> Adds a #AsLaunchable containing launchables entries for this component. - + line="3601">Adds a #AsLaunchable containing launchables entries for this component. + @@ -3022,13 +3160,13 @@ check for duplicate keywords. a #AsComponent instance. + line="3603">a #AsComponent instance. a #AsLaunchable instance. + line="3604">a #AsLaunchable instance. @@ -3038,8 +3176,8 @@ check for duplicate keywords. version="0.6.2"> Add a set of provided items to this component. - + line="2293">Add a set of provided items to this component. + @@ -3047,13 +3185,13 @@ check for duplicate keywords. a #AsComponent instance. + line="2295">a #AsComponent instance. a #AsProvided instance. + line="2296">a #AsProvided instance. @@ -3062,9 +3200,9 @@ check for duplicate keywords. c:identifier="as_component_add_provided_item"> Adds a provided item to the component with the given @kind, creating a new + line="2324">Adds a provided item to the component with the given @kind, creating a new @AsProvided for this kind internally if necessary. - + @@ -3072,31 +3210,56 @@ check for duplicate keywords. a #AsComponent instance. + line="2326">a #AsComponent instance. the kind of the provided item (e.g. %AS_PROVIDED_KIND_MEDIATYPE) + line="2327">the kind of the provided item (e.g. %AS_PROVIDED_KIND_MEDIATYPE) the item to add. + line="2328">the item to add. + + Adds an external reference to the software component. + + + + + + + a #AsComponent instance. + + + + an #AsReference instance. + + + + Adds a #AsRelation to set a recommends or requires relation of + line="3670">Adds a #AsRelation to set a recommends or requires relation of component @cpt on the item mentioned in the #AsRelation. - + @@ -3104,13 +3267,13 @@ component @cpt on the item mentioned in the #AsRelation. a #AsComponent instance. + line="3672">a #AsComponent instance. a #AsRelation instance. + line="3673">a #AsRelation instance. @@ -3118,8 +3281,8 @@ component @cpt on the item mentioned in the #AsRelation. Add an #AsRelease to this component. - + line="680">Add an #AsRelease to this component. + @@ -3127,13 +3290,13 @@ component @cpt on the item mentioned in the #AsRelation. a #AsComponent instance. + line="682">a #AsComponent instance. The #AsRelease to add + line="683">The #AsRelease to add @@ -3141,8 +3304,8 @@ component @cpt on the item mentioned in the #AsRelation. Add the component ID of a component that gets replaced by the current component. - + line="3906">Add the component ID of a component that gets replaced by the current component. + @@ -3150,13 +3313,13 @@ component @cpt on the item mentioned in the #AsRelation. a #AsComponent instance. + line="3908">a #AsComponent instance. an AppStream component ID + line="3909">an AppStream component ID @@ -3166,8 +3329,8 @@ component @cpt on the item mentioned in the #AsRelation. version="0.14.0"> Adds a user review to a software component. - + line="3485">Adds a user review to a software component. + @@ -3175,13 +3338,13 @@ component @cpt on the item mentioned in the #AsRelation. a #AsComponent instance. + line="3487">a #AsComponent instance. a #AsReview instance. + line="3488">a #AsReview instance. @@ -3189,8 +3352,8 @@ component @cpt on the item mentioned in the #AsRelation. Add an #AsScreenshot to this component. - + line="613">Add an #AsScreenshot to this component. + @@ -3198,13 +3361,13 @@ component @cpt on the item mentioned in the #AsRelation. a #AsComponent instance. + line="615">a #AsComponent instance. The #AsScreenshot to add + line="616">The #AsScreenshot to add @@ -3212,8 +3375,8 @@ component @cpt on the item mentioned in the #AsRelation. Add an #AsSuggested to this component. - + line="2353">Add an #AsSuggested to this component. + @@ -3221,13 +3384,13 @@ component @cpt on the item mentioned in the #AsRelation. a #AsComponent instance. + line="2355">a #AsComponent instance. The #AsSuggested + line="2356">The #AsSuggested @@ -3237,31 +3400,31 @@ component @cpt on the item mentioned in the #AsRelation. version="0.15.0"> Add a tag to this component. - + line="1918">Add a tag to this component. + %TRUE if the tag was added. + line="1926">%TRUE if the tag was added. a #AsComponent instance. + line="1920">a #AsComponent instance. The namespace the tag belongs to + line="1921">The namespace the tag belongs to The tag name + line="1922">The tag name @@ -3271,9 +3434,9 @@ component @cpt on the item mentioned in the #AsRelation. version="0.9.2"> Assign an #AsTranslation object describing the translation system used + line="2641">Assign an #AsTranslation object describing the translation system used by this component. - + @@ -3281,13 +3444,13 @@ by this component. an #AsComponent instance. + line="2643">an #AsComponent instance. an #AsTranslation instance. + line="2644">an #AsTranslation instance. @@ -3297,8 +3460,8 @@ by this component. version="0.6.2"> Adds some URL data to the component. - + line="712">Adds some URL data to the component. + @@ -3306,56 +3469,77 @@ by this component. a #AsComponent instance. + line="714">a #AsComponent instance. the URL kind, e.g. %AS_URL_KIND_HOMEPAGE + line="715">the URL kind, e.g. %AS_URL_KIND_HOMEPAGE the full URL. + line="716">the full URL. - + Remove all keywords for the given locale. - - - + line="3783">Verifies the respective relations and presents whether the system specified +in #AsSystemInfo @sysinfo and data from @pool supply the requested facilities. + + + An array of #AsRelationCheckResult + + + an #AsComponent instance. + line="3785">a #AsComponent instance. - BCP47 locale of the values, or %NULL to use current locale. - + line="3786">an #AsSystemInfo to use for system information. + + + + an #AsPool to find component dependencies in. + + + + the kind of relations to check + - + Remove all registered language translation information. - + line="1584">Remove all keywords for the given locale. + @@ -3363,18 +3547,27 @@ by this component. an #AsComponent instance. + line="1586">an #AsComponent instance. + + BCP47 locale of the values, or %NULL to use current locale. + + - + Remove all tags associated with this component. - + line="2554">Remove all registered language translation information. + @@ -3382,29 +3575,26 @@ by this component. a #AsComponent instance. + line="2556">an #AsComponent instance. - + Get the current active locale for this component, which -is used to get localized messages. - + line="1903">Remove all tags associated with this component. + - the current active locale. - + a #AsComponent instance. + line="1905">a #AsComponent instance. @@ -3414,15 +3604,15 @@ is used to get localized messages. version="0.9.2"> Returns a list of #AsComponent objects which + line="786">Returns a list of #AsComponent objects which are addons extending this component in functionality. This is the reverse of %as_component_get_extends() - + An array of #AsComponent. + line="795">An array of #AsComponent. @@ -3431,7 +3621,7 @@ This is the reverse of %as_component_get_extends() an #AsComponent instance. + line="788">an #AsComponent instance. @@ -3441,25 +3631,25 @@ This is the reverse of %as_component_get_extends() version="0.12.1"> Gets an agreement the component has specified for the particular kind. - + line="3957">Gets an agreement the component has specified for the particular kind. + a #AsAgreement or %NULL for not found + line="3964">a #AsAgreement or %NULL for not found a #AsComponent instance. + line="3959">a #AsComponent instance. an agreement kind, e.g. %AS_AGREEMENT_KIND_EULA + line="3960">an agreement kind, e.g. %AS_AGREEMENT_KIND_EULA @@ -3469,12 +3659,12 @@ This is the reverse of %as_component_get_extends() version="0.15.0"> Get a list of all agreements registered with this software component. - + line="3924">Get a list of all agreements registered with this software component. + An array of #AsAgreement. + line="3930">An array of #AsAgreement. @@ -3483,7 +3673,7 @@ This is the reverse of %as_component_get_extends() an #AsComponent instance. + line="3926">an #AsComponent instance. @@ -3493,19 +3683,19 @@ This is the reverse of %as_component_get_extends() version="0.14.0"> Gets the branch for the application. - + line="1255">Gets the branch for the application. + string, or %NULL if unset + line="1261">string, or %NULL if unset a #AsComponent instance. + line="1257">a #AsComponent instance. @@ -3515,20 +3705,20 @@ This is the reverse of %as_component_get_extends() version="0.15.2"> Get the branding associated with this component, or %NULL + line="3982">Get the branding associated with this component, or %NULL in case this component has no special branding. - + An #AsBranding. + line="3989">An #AsBranding. an #AsComponent instance. + line="3984">an #AsComponent instance. @@ -3538,25 +3728,25 @@ in case this component has no special branding. version="0.8.0"> Gets a bundle identifier string. - + line="853">Gets a bundle identifier string. + An #AsBundle, or %NULL if not set. + line="860">An #AsBundle, or %NULL if not set. a #AsComponent instance. + line="855">a #AsComponent instance. the bundle kind, e.g. %AS_BUNDLE_KIND_LIMBA. + line="856">the bundle kind, e.g. %AS_BUNDLE_KIND_LIMBA. @@ -3566,12 +3756,12 @@ in case this component has no special branding. version="0.10"> Get a list of all software bundles associated with this component. - + line="822">Get a list of all software bundles associated with this component. + A list of #AsBundle. + line="828">A list of #AsBundle. @@ -3580,7 +3770,7 @@ in case this component has no special branding. a #AsComponent instance. + line="824">a #AsComponent instance. @@ -3588,11 +3778,11 @@ in case this component has no special branding. - + String array of categories + line="1695">String array of categories @@ -3601,18 +3791,18 @@ in case this component has no special branding. a #AsComponent instance. + line="1693">a #AsComponent instance. - + A list of desktops where this component is compulsory + line="2208">A list of desktops where this component is compulsory @@ -3621,7 +3811,7 @@ in case this component has no special branding. a #AsComponent instance. + line="2206">a #AsComponent instance. @@ -3631,25 +3821,25 @@ in case this component has no special branding. version="0.11.0"> Gets a content ratings of a specific type that are defined for this component. - + line="3518">Gets a content ratings of a specific type that are defined for this component. + a #AsContentRating or %NULL if not found + line="3525">a #AsContentRating or %NULL if not found a #AsComponent instance. + line="3520">a #AsComponent instance. a ratings kind, e.g. "oars-1.0" + line="3521">a ratings kind, e.g. "oars-1.0" @@ -3659,12 +3849,12 @@ in case this component has no special branding. version="0.11.0"> Gets all content ratings defined for this software. - + line="3501">Gets all content ratings defined for this software. + an array + line="3507">an array @@ -3673,7 +3863,7 @@ in case this component has no special branding. a #AsComponent instance. + line="3503">a #AsComponent instance. @@ -3683,22 +3873,22 @@ in case this component has no special branding. version="0.11.2"> Get the #AsContext associated with this component. + line="4020">Get the #AsContext associated with this component. This function may return %NULL if no context is set (which will be the case if the component was not loaded from a file or cache but constructed in memory). - + the associated #AsContext or %NULL + line="4029">the associated #AsContext or %NULL a #AsComponent instance. + line="4022">a #AsComponent instance. @@ -3706,11 +3896,11 @@ a file or cache but constructed in memory). - + Hash table of custom user defined data fields. + line="3416">Hash table of custom user defined data fields. @@ -3720,7 +3910,7 @@ a file or cache but constructed in memory). An #AsComponent. + line="3414">An #AsComponent. @@ -3730,8 +3920,8 @@ a file or cache but constructed in memory). version="0.10.5"> Retrieve value for a custom data entry with the given key. - + line="3427">Retrieve value for a custom data entry with the given key. + @@ -3739,13 +3929,13 @@ a file or cache but constructed in memory). An #AsComponent. + line="3429">An #AsComponent. Field name. + line="3430">Field name. @@ -3753,7 +3943,7 @@ a file or cache but constructed in memory). Get a unique identifier for this metadata set. + line="1185">Get a unique identifier for this metadata set. This unique ID is only valid for the current session, as opposed to the AppStream ID which uniquely identifies a software component. @@ -3763,18 +3953,18 @@ The format of the unique id usually is: For example: system/os/package/org.example.FooBar - + the unique session-specific identifier. + line="1200">the unique session-specific identifier. a #AsComponent instance. + line="1187">a #AsComponent instance. @@ -3784,19 +3974,19 @@ system/os/package/org.example.FooBar version="0.15.2"> Gets the end-of-life date for the entire component. - + line="965">Gets the end-of-life date for the entire component. + The EOL date as string in ISO8601 format. + line="971">The EOL date as string in ISO8601 format. a #AsComponent instance. + line="967">a #AsComponent instance. @@ -3806,41 +3996,41 @@ system/os/package/org.example.FooBar glib:get-property="description"> Get the localized long description of this component. - + line="1435">Get the localized long description of this component. + the description. + line="1441">the description. a #AsComponent instance. + line="1437">a #AsComponent instance. - + Get the component's developer or development team name. - + line="1828">Get information about the component's developer or development team. +The returned object may be empty if no developer information was +available. + the developer name. - + line="1836">the developer as #AsDeveloper. + a #AsComponent instance. + line="1830">a #AsComponent instance. @@ -3850,15 +4040,15 @@ system/os/package/org.example.FooBar version="0.15.5"> Returns a string list of IDs of components which + line="729">Returns a string list of IDs of components which are extended by this addon. See %as_component_get_extends() for the reverse. - + A #GPtrArray or %NULL if not set. + line="738">A #GPtrArray or %NULL if not set. @@ -3867,7 +4057,7 @@ See %as_component_get_extends() for the reverse. an #AsComponent instance. + line="731">an #AsComponent instance. @@ -3876,7 +4066,7 @@ See %as_component_get_extends() for the reverse. c:identifier="as_component_get_icon_by_size"> Gets an icon matching the size constraints. + line="1617">Gets an icon matching the size constraints. The icons are not filtered by type, and the first icon which matches the size is returned. If you want more control over which icons you use for displaying, @@ -3884,30 +4074,30 @@ use the %as_component_get_icons() function to get a list of all icons. Note that this function is not HiDPI aware! It will never return an icon with a scaling factor > 1. - + An icon matching the given width/height, or %NULL if not found. + line="1632">An icon matching the given width/height, or %NULL if not found. an #AsComponent instance + line="1619">an #AsComponent instance The icon width in pixels. + line="1620">The icon width in pixels. the icon height in pixels. + line="1621">the icon height in pixels. @@ -3915,20 +4105,20 @@ a scaling factor > 1. Gets a stock icon for this component if one is associated with it. + line="1653">Gets a stock icon for this component if one is associated with it. Will return %NULL otherwise. - + An stock icon, or %NULL if none found. + line="1660">An stock icon, or %NULL if none found. an #AsComponent instance + line="1655">an #AsComponent instance @@ -3936,11 +4126,11 @@ Will return %NULL otherwise. - + A #GPtrArray of all icons for this component. + line="1608">A #GPtrArray of all icons for this component. @@ -3949,7 +4139,7 @@ Will return %NULL otherwise. an #AsComponent instance + line="1606">an #AsComponent instance @@ -3959,24 +4149,24 @@ Will return %NULL otherwise. glib:get-property="id"> Get the unique AppStream identifier for this component. + line="1148">Get the unique AppStream identifier for this component. This ID is unique for the described component, but does not uniquely identify the metadata set. For a unique ID for this metadata set in the current session, use %as_component_get_data_id() - + the unique AppStream identifier. + line="1159">the unique AppStream identifier. a #AsComponent instance. + line="1150">a #AsComponent instance. @@ -3984,11 +4174,11 @@ session, use %as_component_get_data_id() - + String array of keywords + line="1473">String array of keywords @@ -3997,7 +4187,7 @@ session, use %as_component_get_data_id() a #AsComponent instance. + line="1471">a #AsComponent instance. @@ -4006,13 +4196,13 @@ session, use %as_component_get_data_id() c:identifier="as_component_get_keywords_table"> Retrieve the internal hash table mapping languages to + line="1498">Retrieve the internal hash table mapping languages to keword arrays. - + Hash table locale->keyword arrays + line="1505">Hash table locale->keyword arrays @@ -4022,7 +4212,7 @@ keword arrays. a #AsComponent instance. + line="1500">a #AsComponent instance. @@ -4032,19 +4222,19 @@ keword arrays. glib:get-property="kind"> Returns the #AsComponentKind of this component. - + line="934">Returns the #AsComponentKind of this component. + the kind of #this. + line="940">the kind of #this. a #AsComponent instance. + line="936">a #AsComponent instance. @@ -4054,19 +4244,19 @@ keword arrays. version="0.7.0"> Gets the translation coverage in percent for a specific locale - + line="2511">Gets the translation coverage in percent for a specific locale + a percentage value, -1 if locale was not found + line="2518">a percentage value, -1 if locale was not found an #AsComponent instance. + line="2513">an #AsComponent instance. allow-none="1"> the BCP47 locale, or %NULL. e.g. "en-GB" + line="2514">the BCP47 locale, or %NULL. e.g. "en-GB" @@ -4085,12 +4275,12 @@ keword arrays. version="0.7.0"> Get a list of all languages. - + line="2537">Get a list of all languages. + list of locales + line="2543">list of locales @@ -4099,7 +4289,7 @@ keword arrays. an #AsComponent instance. + line="2539">an #AsComponent instance. @@ -4109,26 +4299,26 @@ keword arrays. version="0.11.0"> Gets a #AsLaunchable of a specific type that contains launchable entries for + line="3560">Gets a #AsLaunchable of a specific type that contains launchable entries for this component. - + a #AsLaunchable or %NULL if not found + line="3568">a #AsLaunchable or %NULL if not found a #AsComponent instance. + line="3562">a #AsComponent instance. a launch kind, e.g. %AS_LAUNCHABLE_KIND_DESKTOP_ID + line="3563">a launch kind, e.g. %AS_LAUNCHABLE_KIND_DESKTOP_ID @@ -4136,11 +4326,11 @@ this component. - + an array + line="3590">an array @@ -4149,7 +4339,7 @@ this component. a #AsComponent instance. + line="3588">a #AsComponent instance. @@ -4159,20 +4349,20 @@ this component. version="0.9.8"> Get the merge method which should apply to duplicate components + line="2382">Get the merge method which should apply to duplicate components with this ID. - + the #AsMergeKind of this component. + line="2389">the #AsMergeKind of this component. a #AsComponent instance. + line="2384">a #AsComponent instance. @@ -4181,19 +4371,19 @@ with this ID. c:identifier="as_component_get_metadata_license"> The license the metadata iself is subjected to. - + line="1740">The license the metadata iself is subjected to. + the license. + line="1746">the license. a #AsComponent instance. + line="1742">a #AsComponent instance. @@ -4203,19 +4393,19 @@ with this ID. glib:get-property="name"> A human-readable name for this component. - + line="1369">A human-readable name for this component. + the name. + line="1375">the name. a #AsComponent instance. + line="1371">a #AsComponent instance. @@ -4223,13 +4413,13 @@ with this ID. Get the internal locale to component name + line="2586">Get the internal locale to component name mapping table. - + locale->names map + line="2593">locale->names map @@ -4239,7 +4429,7 @@ mapping table. an #AsComponent instance. + line="2588">an #AsComponent instance. @@ -4249,26 +4439,26 @@ mapping table. version="0.12.10"> Get variant suffix for the component name + line="2039">Get variant suffix for the component name (only to be displayed if two components have the same name). - + the variant suffix + line="2046">the variant suffix a #AsComponent instance. + line="2041">a #AsComponent instance. - + @@ -4276,7 +4466,7 @@ mapping table. a #AsComponent instance. + line="1231">a #AsComponent instance. @@ -4284,7 +4474,7 @@ mapping table. Get the first package name of the list of packages that need to be installed + line="1060">Get the first package name of the list of packages that need to be installed for this component to be present on the system. Since most components consist of only one package, this is safe to use for about 90% of all cases. @@ -4292,18 +4482,18 @@ about 90% of all cases. However, to support a component fully, please use %as_component_get_pkgnames() for getting all packages that need to be installed, and use this method only to e.g. get the main package to perform a quick "is it installed?" check. - + String array of package names + line="1073">String array of package names a #AsComponent instance. + line="1062">a #AsComponent instance. @@ -4313,13 +4503,13 @@ e.g. get the main package to perform a quick "is it installed?" check. glib:get-property="pkgnames"> Get a list of package names which this component consists of. + line="1044">Get a list of package names which this component consists of. This usually is just one package name. - + String array of package names + line="1051">String array of package names @@ -4328,7 +4518,7 @@ This usually is just one package name. a #AsComponent instance. + line="1046">a #AsComponent instance. @@ -4338,9 +4528,9 @@ This usually is just one package name. version="0.6.1"> Returns the priority of this component. + line="2416">Returns the priority of this component. This method is used internally. - + @@ -4348,7 +4538,7 @@ This method is used internally. a #AsComponent instance. + line="2418">a #AsComponent instance. @@ -4358,19 +4548,19 @@ This method is used internally. glib:get-property="project-group"> Get the component's project group. - + line="1799">Get the component's project group. + the project group. + line="1805">the project group. a #AsComponent instance. + line="1801">a #AsComponent instance. @@ -4380,19 +4570,19 @@ This method is used internally. glib:get-property="project-license"> Get the license of the project this component belongs to. - + line="1769">Get the license of the project this component belongs to. + the license. + line="1775">the license. a #AsComponent instance. + line="1771">a #AsComponent instance. @@ -4400,12 +4590,12 @@ This method is used internally. Get a list of #AsProvided objects associated with this component. - + line="2278">Get a list of #AsProvided objects associated with this component. + A list of #AsProvided objects. + line="2284">A list of #AsProvided objects. @@ -4414,7 +4604,7 @@ This method is used internally. a #AsComponent instance. + line="2280">a #AsComponent instance. @@ -4423,27 +4613,27 @@ This method is used internally. c:identifier="as_component_get_provided_for_kind"> Get an #AsProvided object for the given interface type, + line="2254">Get an #AsProvided object for the given interface type, containing information about the public interfaces (mimetypes, firmware, DBus services, ...) this component provides. - + #AsProvided containing the items this component provides, or %NULL. + line="2263">#AsProvided containing the items this component provides, or %NULL. a #AsComponent instance. + line="2256">a #AsComponent instance. kind of the provided item, e.g. %AS_PROVIDED_KIND_MIMETYPE + line="2257">kind of the provided item, e.g. %AS_PROVIDED_KIND_MEDIATYPE @@ -4453,12 +4643,12 @@ this component provides. version="0.12.0"> Get an array of items that are recommended by this component. - + line="3635">Get an array of items that are recommended by this component. + an array + line="3641">an array @@ -4467,75 +4657,53 @@ this component provides. a #AsComponent instance. + line="3637">a #AsComponent instance. - + Get an array of the #AsRelease items this component -provides. - + line="2006">Get a list of external references and citation information for this component. + A list of releases + line="2012">An array of #AsReference. - + a #AsComponent instance. - - - - - - Returns the #AsReleasesKind of the release metadata -associated with this component. - - - The kind. - - - - - a #AsComponent instance. + line="2008">an #AsComponent instance. - + Get a remote URL to obtain release information for the component. - + line="629">Get release information for this component, +without downloading or loading any data from external sources. + The URL of external release data. - + line="636">Release information as #AsReleaseList + a #AsComponent instance. + line="631">a #AsComponent instance. @@ -4543,12 +4711,12 @@ associated with this component. Get a list of component IDs of components that this software replaces entirely. - + line="3889">Get a list of component IDs of components that this software replaces entirely. + an array of component-IDs + line="3895">an array of component-IDs @@ -4557,7 +4725,7 @@ associated with this component. a #AsComponent instance. + line="3891">a #AsComponent instance. @@ -4567,12 +4735,12 @@ associated with this component. version="0.12.0"> Get an array of items that are required by this component. - + line="3618">Get an array of items that are required by this component. + an array + line="3624">an array @@ -4581,7 +4749,7 @@ associated with this component. a #AsComponent instance. + line="3620">a #AsComponent instance. @@ -4591,12 +4759,12 @@ associated with this component. version="0.14.0"> Gets any reviews associated with the component. - + line="3468">Gets any reviews associated with the component. + an array + line="3474">an array @@ -4605,7 +4773,7 @@ associated with this component. a #AsComponent instance. + line="3470">a #AsComponent instance. @@ -4613,33 +4781,32 @@ associated with this component. - + the #AsComponentScope of this component. + line="2664">the #AsComponentScope of this component. a #AsComponent instance. + line="2662">a #AsComponent instance. - + Get a list of associated screenshots. - + line="2085">Get a list of all associated screenshots, for all environments. + an array of #AsScreenshot instances + line="2091">an array of #AsScreenshot instances @@ -4648,7 +4815,7 @@ associated with this component. a #AsComponent instance. + line="2087">a #AsComponent instance. @@ -4658,12 +4825,12 @@ associated with this component. version="0.9.7"> Returns all search tokens for this component. - + line="3313">Returns all search tokens for this component. + The string search tokens + line="3319">The string search tokens @@ -4672,7 +4839,7 @@ associated with this component. a #AsComponent instance. + line="3315">a #AsComponent instance. @@ -4682,7 +4849,7 @@ associated with this component. version="0.12.11"> Returns the sorting priority of this component. + line="2449">Returns the sorting priority of this component. This will only return a valid value if this component was the result of or involved in a search operation which @@ -4694,7 +4861,7 @@ from best match to worst. The returned value is an arbitrary integer value, valid only for the search terms involved in the search operation that yielded this component as a result. - + @@ -4702,25 +4869,25 @@ this component as a result. a #AsComponent instance. + line="2451">a #AsComponent instance. - + the source package name. + line="1127">the source package name. a #AsComponent instance. + line="1125">a #AsComponent instance. @@ -4728,12 +4895,12 @@ this component as a result. Get a list of associated suggestions. - + line="2367">Get a list of associated suggestions. + an array of #AsSuggested instances + line="2373">an array of #AsSuggested instances @@ -4742,7 +4909,7 @@ this component as a result. a #AsComponent instance. + line="2369">a #AsComponent instance. @@ -4752,19 +4919,19 @@ this component as a result. glib:get-property="summary"> Get a short description of this component. - + line="1401">Get a short description of this component. + the summary. + line="1407">the summary. a #AsComponent instance. + line="1403">a #AsComponent instance. @@ -4773,13 +4940,13 @@ this component as a result. c:identifier="as_component_get_summary_table"> Get the internal locale to component summary + line="2602">Get the internal locale to component summary mapping table. - + locale->summary map + line="2609">locale->summary map @@ -4789,7 +4956,7 @@ mapping table. an #AsComponent instance. + line="2604">an #AsComponent instance. @@ -4799,13 +4966,13 @@ mapping table. version="0.15.0"> Get an array of items that are supported by this component, + line="3652">Get an array of items that are supported by this component, e.g. to indicate support for a specific piece of hardware. - + an array + line="3659">an array @@ -4814,9 +4981,58 @@ e.g. to indicate support for a specific piece of hardware. a #AsComponent instance. + line="3654">a #AsComponent instance. + + + + + + Return a score between 0 and 100 determining how compatible the component +is with the system configuration provided as parameter. + +0 means the componsnt will not work at all, while 100 is best compatibility. + + + a compatibility score between 0 and 100 + + + + + a #AsComponent instance. + + an #AsSystemInfo to use for system information. + + + + if %TRUE, treat system info as neutral template, ignoring any peripheral devices or kernel relations. + + + + Receive the resulting check results + + + + version="0.15.2"> Gets the UNIX timestamp for the date when this component + line="998">Gets the UNIX timestamp for the date when this component is out of support (end-of-life) and will receive no more updates, not even security fixes. - + UNIX timestamp, or 0 for unset or invalid. + line="1006">UNIX timestamp, or 0 for unset or invalid. a #AsComponent instance. + line="1000">a #AsComponent instance. @@ -4848,16 +5064,16 @@ updates, not even security fixes. version="0.9.2"> Get a #GPtrArray of #AsTranslation objects describing the + line="2618">Get a #GPtrArray of #AsTranslation objects describing the translation systems and translation-ids (e.g. Gettext domains) used by this software component. Only set for metainfo files. - + An array of #AsTranslation objects. + line="2628">An array of #AsTranslation objects. @@ -4866,7 +5082,7 @@ Only set for metainfo files. an #AsComponent instance. + line="2620">an #AsComponent instance. @@ -4876,60 +5092,42 @@ Only set for metainfo files. version="0.6.2"> Gets a URL. - + line="694">Gets a URL. + string, or %NULL if unset + line="701">string, or %NULL if unset a #AsComponent instance. + line="696">a #AsComponent instance. the URL kind, e.g. %AS_URL_KIND_HOMEPAGE. + line="697">the URL kind, e.g. %AS_URL_KIND_HOMEPAGE. - - - - The #AsValueFlags that are set on @cpt. - - - - - a #AsComponent instance. - - - - - + %TRUE if this component has a bundle associated. + line="900">%TRUE if this component has a bundle associated. a #AsComponent instance. + line="898">a #AsComponent instance. @@ -4937,25 +5135,25 @@ Only set for metainfo files. Check if component is in the specified category. - + line="1724">Check if component is in the specified category. + %TRUE if the component is in the specified category. + line="1731">%TRUE if the component is in the specified category. an #AsComponent object + line="1726">an #AsComponent object the specified category to check + line="1727">the specified category to check @@ -4965,32 +5163,32 @@ Only set for metainfo files. version="0.15.0"> Test if the component is tagged with the selected + line="1979">Test if the component is tagged with the selected tag. - + %TRUE if tag exists. + line="1988">%TRUE if tag exists. a #AsComponent instance. + line="1981">a #AsComponent instance. The namespace the tag belongs to + line="1982">The namespace the tag belongs to The tag name + line="1983">The tag name @@ -5000,31 +5198,31 @@ tag. version="0.10.5"> Add a key and value pair to the custom data table. - + line="3445">Add a key and value pair to the custom data table. + %TRUE if the key did not exist yet. + line="3453">%TRUE if the key did not exist yet. An #AsComponent. + line="3447">An #AsComponent. Key name. + line="3448">Key name. A string value. + line="3449">A string value. @@ -5033,50 +5231,50 @@ tag. c:identifier="as_component_is_compulsory_for_desktop"> Check if this component is compulsory for the given desktop. - + line="2238">Check if this component is compulsory for the given desktop. + %TRUE if compulsory, %FALSE otherwise. + line="2245">%TRUE if compulsory, %FALSE otherwise. an #AsComponent object + line="2240">an #AsComponent object the desktop-id to test for + line="2241">the desktop-id to test for - Returns %TRUE if this component is free and open source software. + line="1866">Returns %TRUE if this component is free and open source software. To determine this status, this function will check if it comes from a vetted free-software-only source or whether its licenses are only free software licenses. - + %TRUE if this component is free software. + line="1875">%TRUE if this component is free software. a #AsComponent instance. + line="1868">a #AsComponent instance. @@ -5084,18 +5282,18 @@ are only free software licenses. - + Whether this component's metadata should be ignored. + line="3401">Whether this component's metadata should be ignored. a #AsComponent instance. + line="3399">a #AsComponent instance. @@ -5104,8 +5302,8 @@ are only free software licenses. c:identifier="as_component_is_member_of_category"> Test if the component @cpt is a member of category @category. - + line="3360">Test if the component @cpt is a member of category @category. + @@ -5113,13 +5311,13 @@ are only free software licenses. a #AsComponent instance. + line="3362">a #AsComponent instance. The category to test. + line="3363">The category to test. @@ -5127,20 +5325,20 @@ are only free software licenses. Check if the essential properties of this Component are + line="548">Check if the essential properties of this Component are populated with useful data. - + TRUE if the component data was validated successfully. + line="555">TRUE if the component data was validated successfully. a #AsComponent instance. + line="550">a #AsComponent instance. @@ -5151,142 +5349,103 @@ populated with useful data. throws="1"> Load metadata for this component from an XML string. + line="6451">Load metadata for this component from an XML string. You normally do not want to use this method directly and instead use the more convenient API of #AsMetadata to create and update components. If this function returns %TRUE, a valid component is returned unless the selected format was %AS_FORMAT_KIND_DESKTOP_ENTRY, in which case a component ID will have to be set explicitly by the caller in order to make the component valid. - + %TRUE on success. + line="6467">%TRUE on success. an #AsComponent instance. + line="6453">an #AsComponent instance. an #AsContext instance. + line="6454">an #AsContext instance. the format of the data to load, e.g. %AS_FORMAT_KIND_XML + line="6455">the format of the data to load, e.g. %AS_FORMAT_KIND_XML the data to load. + line="6456">the data to load. Load data from an external source, possibly a local file -or a network resource. - - + line="645">Get release information for this component, download it +if necessary. + + %TRUE on success. - + line="652">Release information as #AsReleaseList, or %NULL if loading failed. + a #AsComponent instance. + line="647">a #AsComponent instance. - - set to %TRUE to discard existing data and reload. - - - allow fetching release data from the internet. - - Load release information from XML bytes. - - - %TRUE on success. - - - - - a #AsComponent instance. - - - - the release XML data as #GBytes - - - - Remove a tag from this component - + line="1950">Remove a tag from this component + %TRUE if the tag was removed. + line="1958">%TRUE if the tag was removed. a #AsComponent instance. + line="1952">a #AsComponent instance. The namespace the tag belongs to + line="1953">The namespace the tag belongs to The tag name + line="1954">The tag name @@ -5296,25 +5455,25 @@ or a network resource. version="0.9.7"> Searches component data for a specific keyword. - + line="3225">Searches component data for a specific keyword. + a match scrore, where 0 is no match and 100 is the best match. + line="3232">a match scrore, where 0 is no match and 100 is the best match. a #AsComponent instance. + line="3227">a #AsComponent instance. the search term. + line="3228">the search term. @@ -5324,12 +5483,12 @@ or a network resource. version="0.9.8"> Searches component data for all the specific keywords. - + line="3270">Searches component data for all the specific keywords. + a match score, where 0 is no match and larger numbers are better + line="3277">a match score, where 0 is no match and larger numbers are better matches. @@ -5337,26 +5496,24 @@ matches. a #AsComponent instance. + line="3272">a #AsComponent instance. the search terms. + line="3273">the search terms. - + Set the current active locale for this component, which -is used to get localized messages. -If the #AsComponent was fetched from a localized database, usually only -one locale is available. - + line="1272">Set the branch that the component instance was sourced from. + @@ -5364,27 +5521,24 @@ one locale is available. a #AsComponent instance. + line="1274">a #AsComponent instance. - + a POSIX or BCP47 locale, or %NULL. e.g. "en_GB" + line="1275">the branch, e.g. "master" or "3-16". - + Set the branch that the component instance was sourced from. - + line="4000">Set branding for this component. + @@ -5392,24 +5546,49 @@ one locale is available. a #AsComponent instance. + line="4002">a #AsComponent instance. - + + an #AsBranding instance. + + + + + + Mark this component to be compulsory for the specified desktop environment. + + + + + + the branch, e.g. "master" or "3-16". + line="2219">a #AsComponent instance. + + + + The name of the desktop. - + Set branding for this component. - + line="4040">Sets the document context this component is associated +with. + @@ -5417,23 +5596,29 @@ one locale is available. a #AsComponent instance. + line="4042">a #AsComponent instance. - + an #AsBranding instance. - + line="4043">the #AsContext. + - + Mark this component to be compulsory for the specified desktop environment. - + line="1316">Set the active locale on the context assoaiacted with this component, +creating a new context for the component if none exists yet. + +Please not that this will flip the locale of all other components and +entities that use the same context as well! +This function is just a convenience method, and does not replace +proper #AsContext management. + @@ -5441,13 +5626,13 @@ one locale is available. a #AsComponent instance. + line="1318">a #AsComponent instance. - + The name of the desktop. + line="1319">the new locale. @@ -5455,12 +5640,12 @@ one locale is available. Set the session-specific unique metadata identifier for this + line="1211">Set the session-specific unique metadata identifier for this component. If two components have a different data_id but the same ID, they will be treated as independent sets of metadata describing the same component type. - + @@ -5468,13 +5653,13 @@ the same component type. a #AsComponent instance. + line="1213">a #AsComponent instance. the unique session-specific identifier. + line="1214">the unique session-specific identifier. @@ -5484,8 +5669,8 @@ the same component type. version="0.15.2"> Sets an end-of-life date for this component. - + line="982">Sets an end-of-life date for this component. + @@ -5493,13 +5678,13 @@ the same component type. a #AsComponent instance. + line="984">a #AsComponent instance. the EOL date in ISO8601 format. + line="985">the EOL date in ISO8601 format. @@ -5509,8 +5694,8 @@ the same component type. glib:set-property="description"> Set long description for this component. - + line="1452">Set long description for this component. + @@ -5518,13 +5703,13 @@ the same component type. A valid #AsComponent + line="1454">A valid #AsComponent The long description + line="1455">The long description allow-none="1"> The BCP47 locale for this value, or %NULL to use the current active one. + line="1456">The BCP47 locale for this value, or %NULL to use the current active one. - + Set the the component's developer or development team name. - + line="1847">Set the the component's developer. + @@ -5552,23 +5735,14 @@ the same component type. a #AsComponent instance. + line="1849">a #AsComponent instance. - - the developer or developer team name - - - + the BCP47 locale, or %NULL. e.g. "en-GB" - + line="1850">the new #AsDeveloper + @@ -5577,8 +5751,8 @@ the same component type. glib:set-property="id"> Set the AppStream identifier for this component. - + line="1168">Set the AppStream identifier for this component. + @@ -5586,13 +5760,13 @@ the same component type. a #AsComponent instance. + line="1170">a #AsComponent instance. the unique identifier. + line="1171">the unique identifier. @@ -5602,8 +5776,8 @@ the same component type. glib:set-property="keywords"> Set keywords for this component, replacing all existing ones for the selected locale. - + line="1514">Set keywords for this component, replacing all existing ones for the selected locale. + @@ -5611,13 +5785,13 @@ the same component type. a #AsComponent instance. + line="1516">a #AsComponent instance. Array of keywords + line="1517">Array of keywords @@ -5628,13 +5802,13 @@ the same component type. allow-none="1"> BCP47 locale of the values, or %NULL to use current locale. + line="1518">BCP47 locale of the values, or %NULL to use current locale. Set to %TRUE if the keywords array should be copied, %FALSE to set by reference. + line="1519">Set to %TRUE if the keywords array should be copied, %FALSE to set by reference. @@ -5644,8 +5818,8 @@ the same component type. glib:set-property="kind"> Sets the #AsComponentKind of this component. - + line="949">Sets the #AsComponentKind of this component. + @@ -5653,13 +5827,13 @@ the same component type. a #AsComponent instance. + line="951">a #AsComponent instance. the #AsComponentKind. + line="952">the #AsComponentKind. @@ -5669,8 +5843,8 @@ the same component type. version="0.9.8"> Sets the #AsMergeKind for this component. - + line="2400">Sets the #AsMergeKind for this component. + @@ -5678,13 +5852,13 @@ the same component type. a #AsComponent instance. + line="2402">a #AsComponent instance. the #AsMergeKind. + line="2403">the #AsMergeKind. @@ -5693,8 +5867,8 @@ the same component type. c:identifier="as_component_set_metadata_license"> Set the license this metadata is licensed under. - + line="1755">Set the license this metadata is licensed under. + @@ -5702,13 +5876,13 @@ the same component type. a #AsComponent instance. + line="1757">a #AsComponent instance. the metadata license. + line="1758">the metadata license. @@ -5718,8 +5892,8 @@ the same component type. glib:set-property="name"> Set a human-readable name for this component. - + line="1384">Set a human-readable name for this component. + @@ -5727,13 +5901,13 @@ the same component type. A valid #AsComponent + line="1386">A valid #AsComponent The name + line="1387">The name allow-none="1"> The BCP47 locale for this value, or %NULL to use the current active one. + line="1388">The BCP47 locale for this value, or %NULL to use the current active one. @@ -5752,9 +5926,9 @@ the same component type. version="0.12.10"> Set a variant suffix for the component name + line="2061">Set a variant suffix for the component name (only to be displayed if components have the same name). - + @@ -5762,13 +5936,13 @@ the same component type. a #AsComponent instance. + line="2063">a #AsComponent instance. the developer or developer team name + line="2064">the developer or developer team name allow-none="1"> the BCP47 locale, or %NULL. e.g. "en-GB" + line="2065">the BCP47 locale, or %NULL. e.g. "en-GB" - + @@ -5791,13 +5965,13 @@ the same component type. a #AsComponent instance. + line="1244">a #AsComponent instance. the origin. + line="1245">the origin. @@ -5807,8 +5981,8 @@ the same component type. version="0.14.5"> Set the package name that provides this component. - + line="1104">Set the package name that provides this component. + @@ -5816,13 +5990,13 @@ the same component type. a #AsComponent instance. + line="1106">a #AsComponent instance. the package name + line="1107">the package name @@ -5832,9 +6006,9 @@ the same component type. glib:set-property="pkgnames"> Set a list of package names this component consists of. + line="1084">Set a list of package names this component consists of. (This should usually be just one package name) - + @@ -5842,7 +6016,7 @@ the same component type. a #AsComponent instance. + line="1086">a #AsComponent instance. @@ -5857,9 +6031,9 @@ the same component type. version="0.6.1"> Sets the priority of this component. + line="2432">Sets the priority of this component. This method is used internally. - + @@ -5867,13 +6041,13 @@ This method is used internally. a #AsComponent instance. + line="2434">a #AsComponent instance. the given priority + line="2435">the given priority @@ -5883,8 +6057,8 @@ This method is used internally. glib:set-property="project-group"> Set the component's project group. - + line="1814">Set the component's project group. + @@ -5892,13 +6066,13 @@ This method is used internally. a #AsComponent instance. + line="1816">a #AsComponent instance. the project group. + line="1817">the project group. @@ -5908,8 +6082,8 @@ This method is used internally. glib:set-property="project-license"> Set the project license. - + line="1784">Set the project license. + @@ -5917,50 +6091,22 @@ This method is used internally. a #AsComponent instance. + line="1786">a #AsComponent instance. the project license. + line="1787">the project license. - - Sets the #AsReleasesKind of the release metadata -associated with this component. - - - - - - - a #AsComponent instance. - - - - the #AsComponentKind. - - - - - + Set a remote URL pointing to an AppStream release info file. - + line="664">Set a new set of releases for this component. + @@ -5968,22 +6114,22 @@ associated with this component. a #AsComponent instance. + line="666">a #AsComponent instance. - + the web URL where release data is found. - + line="667">the #AsReleaseList to use. + Sets the #AsComponentScope of this component. - + line="2675">Sets the #AsComponentScope of this component. + @@ -5991,13 +6137,13 @@ associated with this component. a #AsComponent instance. + line="2677">a #AsComponent instance. the #AsComponentKind. + line="2678">the #AsComponentKind. @@ -6007,8 +6153,8 @@ associated with this component. version="0.9.8"> Sets the sorting score of this component. - + line="2475">Sets the sorting score of this component. + @@ -6016,20 +6162,20 @@ associated with this component. a #AsComponent instance. + line="2477">a #AsComponent instance. the given sorting score + line="2478">the given sorting score - + @@ -6037,13 +6183,13 @@ associated with this component. a #AsComponent instance. + line="1138">a #AsComponent instance. the source package name. + line="1139">the source package name. @@ -6053,8 +6199,8 @@ associated with this component. glib:set-property="summary"> Set a short description for this component. - + line="1418">Set a short description for this component. + @@ -6062,13 +6208,13 @@ associated with this component. A valid #AsComponent + line="1420">A valid #AsComponent The summary + line="1421">The summary allow-none="1"> The BCP47 locale for this value, or %NULL to use the current active one. + line="1422">The BCP47 locale for this value, or %NULL to use the current active one. - - + + Reorder the screenshots to prioritize a certain environment or style, instead of using the default +screenshot order. + +If both "environment" and "style" are %NULL, the previous default order is restored. + @@ -6092,34 +6244,52 @@ associated with this component. a #AsComponent instance. + line="2147">a #AsComponent instance. - + #AsValueFlags to set on @cpt. - + line="2148">a GUI environment string, e.g. "plasma" or "gnome" + + + + and environment style string, e.g. "light" or "dark" + + + + if %TRUE, order screenshots of the given style earlier than ones of the given environment. + Returns a string identifying this component. + line="582">Returns a string identifying this component. (useful for debugging) - + A descriptive string + line="589">A descriptive string a #AsComponent instance. + line="584">a #AsComponent instance. @@ -6130,27 +6300,27 @@ associated with this component. throws="1"> Serialize this component into an XML string. + line="6540">Serialize this component into an XML string. You normally do not want to use this method directly and instead use the more convenient API of #AsMetadata to serialize components. - + %TRUE on success. + line="6550">%TRUE on success. an #AsComponent instance. + line="6542">an #AsComponent instance. an #AsContext instance. + line="6543">an #AsContext instance. @@ -6160,7 +6330,7 @@ convenient API of #AsMetadata to serialize components. getter="get_categories"> string array of categories + line="6803">string array of categories @@ -6173,24 +6343,13 @@ convenient API of #AsMetadata to serialize components. default-value="NULL"> the description - - - - the developer name + line="6748">the description hash map of icon urls and sizes + line="6776">hash map of icon urls and sizes @@ -6203,7 +6362,7 @@ convenient API of #AsMetadata to serialize components. default-value="NULL"> the unique identifier + line="6706">the unique identifier getter="get_keywords"> string array of keywords + line="6762">string array of keywords @@ -6226,7 +6385,7 @@ convenient API of #AsMetadata to serialize components. default-value="AS_COMPONENT_KIND_UNKNOWN"> the #AsComponentKind of this component + line="6677">the #AsComponentKind of this component default-value="NULL"> the name + line="6720">the name getter="get_pkgnames"> string array of packages name + line="6692">string array of packages name @@ -6260,7 +6419,7 @@ convenient API of #AsMetadata to serialize components. default-value="NULL"> the project group + line="6831">the project group default-value="NULL"> the project license + line="6817">the project license - + An array of #AsScreenshot instances + line="6846">An array of #AsScreenshot instances @@ -6292,13 +6449,13 @@ convenient API of #AsMetadata to serialize components. default-value="NULL"> the summary + line="6734">the summary the urls associated with this component + line="6789">the urls associated with this component @@ -6308,688 +6465,290 @@ convenient API of #AsMetadata to serialize components. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The type of an #AsComponent. - - Type invalid or not known - - + + + A generic (= without specialized type) component - - + filename="src/as-component-box.c" + line="150">Creates a new #AsComponentBox. + + + an #AsComponentBox + + + + + + + + + An application with a .desktop-file - - + filename="src/as-component-box.c" + line="167">Creates a new #AsComponentBox with the simplest parameters, +so it is basically an array storage without overhead. + +Only the most basic checks on inserted components will be performed, +and it is assumed that the inserted components have been checked +already prior to insertion. + + + an #AsComponentBox + + + + A console application - - + filename="src/as-component-box.c" + line="284">Add a component to the box. Returns an error if we could not add it +(most likely due to component box constraints). + + + %TRUE on success. + + + + + An instance of #AsComponentBox. + + + + + + + + A web application - - + filename="src/as-component-box.c" + line="209">Get the contents of this component box as #GPtrArray. + + + an array of #AsComponent instances. + + + + + + + An instance of #AsComponentBox. + + + + + An extension of existing software, which does not run standalone - - - A font - - - A multimedia codec - - - An input-method provider - - - Firmware - - - A driver - - - Software localization (usually l10n resources) - - - A system service launched by the init system - - - A remote software or data source - - - A computer operating system - - - An icon theme following the XDG specification - - - An application runtime platform - - - Converts the text representation to an enumerated value. - + filename="src/as-component-box.c" + line="317">Remove all contents of this component box. + - a #AsComponentKind or %AS_COMPONENT_KIND_UNKNOWN for unknown - + - + the string. - - + filename="src/as-component-box.c" + line="319">An instance of #AsComponentBox. + + - - + + Converts the enumerated value to an text representation. - + filename="src/as-component-box.c" + line="223">Get the flags this component box was constructed with. + string version of @kind - + filename="src/as-component-box.c" + line="229">The #AsComponentBoxFlags that are in effect. + - + the #AsComponentKind. - - + filename="src/as-component-box.c" + line="225">An instance of #AsComponentBox. + + - - - - Scope of the #AsComponent (system-wide or user-scope) - - Unknown scope - - - System scope - - - User scope - - + + Converts the text representation to an enumerated value. - + filename="src/as-component-box.c" + line="238">Get the amount of components in this box. + a #AsComponentScope or %AS_COMPONENT_SCOPE_UNKNOWN for unknown - + filename="src/as-component-box.c" + line="244">Amount of components. + - + the string. - - + filename="src/as-component-box.c" + line="240">An instance of #AsComponentBox. + + - - + + Converts the enumerated value to an text representation. - + filename="src/as-component-box.c" + line="266">Retrieve a component at the respective index from the internal +component array. + string version of @scope - + filename="src/as-component-box.c" + line="274">An #AsComponent or %NULL + - + the #AsComponentScope. - + filename="src/as-component-box.c" + line="268">An instance of #AsComponentBox. + + + + The component index. + - - - - - + + Creates a new #AsContentRating. - - + filename="src/as-component-box.c" + line="252">Check if there are any components present. + + a #AsContentRating - + filename="src/as-component-box.c" + line="258">%TRUE if this component box is empty. + - - + + + An instance of #AsComponentBox. + + + + + Gets the highest #AsContentRatingValue which is allowed to be seen by the -given Common Sense Media @age for the given subsection @id. - -For example, if the CSM age mappings for `violence-bloodshed` are: - * age ≥ 0 for %AS_CONTENT_RATING_VALUE_NONE - * age ≥ 9 for %AS_CONTENT_RATING_VALUE_MILD - * age ≥ 11 for %AS_CONTENT_RATING_VALUE_MODERATE - * age ≥ 18 for %AS_CONTENT_RATING_VALUE_INTENSE -then calling this function with `violence-bloodshed` and @age set to 17 would -return %AS_CONTENT_RATING_VALUE_MODERATE. Calling it with age 18 would -return %AS_CONTENT_RATING_VALUE_INTENSE. - + filename="src/as-component-box.c" + line="333">Remove a component at the specified index. +Please ensure that the index is not larger than +%as_component_box_get_size() - 1 + - the #AsContentRatingValue, or %AS_CONTENT_RATING_VALUE_UNKNOWN if - unknown - + - + the subsection ID e.g. `violence-cartoon` - - - + filename="src/as-component-box.c" + line="335">An instance of #AsComponentBox. + + + the CSM age + filename="src/as-component-box.c" + line="336">the index of the component to remove. - - + + Get a human-readable description of what content would be expected to -require the content rating attribute given by @id and @value. - + filename="src/as-component-box.c" + line="388">Sort components to bring them into a deterministic order. + - a human-readable description of @id and @value - + - - the subsection ID e.g. `violence-cartoon` - - - + the #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_INTENSE - - + filename="src/as-component-box.c" + line="390">An instance of #AsComponentBox. + + - - + + Gets the Common Sense Media approved age for a specific rating level. - + filename="src/as-component-box.c" + line="400">Sort components by their (search) match score. + - The age in years, or 0 for no details. - + - - the subsection ID e.g. `violence-cartoon` - - - + the #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_INTENSE - - - - - - Returns a list of all the valid OARS content rating attribute IDs as could -be passed to as_content_rating_add_attribute() or -as_content_rating_attribute_to_csm_age(). - - - a %NULL-terminated - array of IDs, to be freed with g_free() (the element values are owned by - libappstream and must not be freed) - - - - - - - Adds an attribute value to the content rating. - - - - - - - a #AsContentRating instance. - - - - a content rating ID, e.g. `money-gambling`. - - - - a #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_MODERATE. - - - - - - Gets the content_rating kind. - - - a string, e.g. "oars-1.0", or NULL - - - - - a #AsContentRating instance. - - - - - - Gets the lowest Common Sense Media approved age for the content_rating block. -NOTE: these numbers are based on the data and descriptions available from -https://www.commonsensemedia.org/about-us/our-mission/about-our-ratings and -you may disagree with them. - -You're free to disagree with these, and of course you should use your own -brain to work our if your child is able to cope with the concepts enumerated -here. Some 13 year olds may be fine with the concept of mutilation of body -parts; others may get nightmares. - - - The age in years, 0 for no rating, or G_MAXUINT for no details. - - - - - a #AsContentRating - - - - - - Gets the set of ratings IDs which are present in this @content_rating. An -example of a ratings ID is `violence-bloodshed`. - -The IDs are returned in lexicographical order. - - - %NULL-terminated - array of ratings IDs; each ratings ID is owned by the #AsContentRating and - must not be freed, but the container must be freed with g_free() - - - - - - - a #AsContentRating - - - - - - Gets the value of a content rating key. - - - the #AsContentRatingValue, or %AS_CONTENT_RATING_VALUE_UNKNOWN - - - - - a #AsContentRating - - - - A ratings ID, e.g. `violence-bloodshed`. - - - - - - Sets the content rating kind. - - - - - - - a #AsContentRating instance. - - - - the rating kind, e.g. "oars-1.0" - - - - - - Sets the value of a content rating key. - - - - - - - a #AsContentRating - + filename="src/as-component-box.c" + line="402">An instance of #AsComponentBox. + - - A ratings ID, e.g. `violence-bloodshed`. - - - - A #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_INTENSE - - + + + + + + + + - - + + - + @@ -6997,7 +6756,7 @@ The IDs are returned in lexicographical order. - + @@ -7005,7 +6764,7 @@ The IDs are returned in lexicographical order. - + @@ -7013,7 +6772,7 @@ The IDs are returned in lexicographical order. - + @@ -7021,7 +6780,7 @@ The IDs are returned in lexicographical order. - + @@ -7029,738 +6788,704 @@ The IDs are returned in lexicographical order. - + - + A content rating system for a particular territory. - Flags controlling the component box behavior. + + c:identifier="AS_COMPONENT_BOX_FLAG_NONE" + glib:nick="none" + glib:name="AS_COMPONENT_BOX_FLAG_NONE"> Unknown ratings system + filename="src/as-component-box.h" + line="61">No flags. - + c:identifier="AS_COMPONENT_BOX_FLAG_NO_CHECKS" + glib:nick="no-checks" + glib:name="AS_COMPONENT_BOX_FLAG_NO_CHECKS"> INCAA - - - ACB - - - DJCTQ - - - GSRR + filename="src/as-component-box.h" + line="62">Only perform the most basic verification. - - PEGI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The type of an #AsComponent. + + Type invalid or not known - + A generic (= without specialized type) component + + + An application with a .desktop-file + + + A console application + + + A web application + + + A system service launched by the init system + + + c:identifier="AS_COMPONENT_KIND_ADDON" + glib:nick="addon" + glib:name="AS_COMPONENT_KIND_ADDON"> KAVI + filename="src/as-component.h" + line="76">An extension of existing software, which does not run standalone - + c:identifier="AS_COMPONENT_KIND_RUNTIME" + glib:nick="runtime" + glib:name="AS_COMPONENT_KIND_RUNTIME"> USK + filename="src/as-component.h" + line="77">An application runtime platform - + c:identifier="AS_COMPONENT_KIND_FONT" + glib:nick="font" + glib:name="AS_COMPONENT_KIND_FONT"> ESRA + filename="src/as-component.h" + line="78">A font - + c:identifier="AS_COMPONENT_KIND_CODEC" + glib:nick="codec" + glib:name="AS_COMPONENT_KIND_CODEC"> CERO + filename="src/as-component.h" + line="79">A multimedia codec - + c:identifier="AS_COMPONENT_KIND_INPUT_METHOD" + glib:nick="input-method" + glib:name="AS_COMPONENT_KIND_INPUT_METHOD"> OFLCNZ + filename="src/as-component.h" + line="80">An input-method provider - + c:identifier="AS_COMPONENT_KIND_OPERATING_SYSTEM" + glib:nick="operating-system" + glib:name="AS_COMPONENT_KIND_OPERATING_SYSTEM"> Russia + filename="src/as-component.h" + line="81">A computer operating system - + c:identifier="AS_COMPONENT_KIND_FIRMWARE" + glib:nick="firmware" + glib:name="AS_COMPONENT_KIND_FIRMWARE"> MDA + filename="src/as-component.h" + line="82">Firmware - + c:identifier="AS_COMPONENT_KIND_DRIVER" + glib:nick="driver" + glib:name="AS_COMPONENT_KIND_DRIVER"> GRAC + filename="src/as-component.h" + line="83">A driver - + c:identifier="AS_COMPONENT_KIND_LOCALIZATION" + glib:nick="localization" + glib:name="AS_COMPONENT_KIND_LOCALIZATION"> ESRB + filename="src/as-component.h" + line="84">Software localization (usually l10n resources) - + c:identifier="AS_COMPONENT_KIND_REPOSITORY" + glib:nick="repository" + glib:name="AS_COMPONENT_KIND_REPOSITORY"> IARC + filename="src/as-component.h" + line="85">A remote software or data source - + Format @age as a human-readable string in the given rating @system. This is -the way to present system-specific strings in a UI. - - + filename="src/as-component.h" + line="86">An icon theme following the XDG specification + + + Converts the text representation to an enumerated value. + + a newly allocated formatted version of - @age, or %NULL if the given @system has no representation for @age - + filename="src/as-component.c" + line="206">a #AsComponentKind or %AS_COMPONENT_KIND_UNKNOWN for unknown + - - an #AsContentRatingSystem - - - + a CSM age to format - + filename="src/as-component.c" + line="202">the string. + - + Determine the most appropriate #AsContentRatingSystem for the given @locale. -Content rating systems are selected by territory. If no content rating system -seems suitable, %AS_CONTENT_RATING_SYSTEM_IARC is returned. - + filename="src/as-component.c" + line="154">Converts the enumerated value to an text representation. + the most relevant #AsContentRatingSystem - + filename="src/as-component.c" + line="160">string version of @kind + - + a locale, in the format described in `man 3 setlocale` - + filename="src/as-component.c" + line="156">the #AsComponentKind. + - + + + Scope of the #AsComponent (system-wide or user-scope) + Get the CSM ages corresponding to the entries returned by -as_content_rating_system_get_formatted_ages() for this @system. - - + filename="src/as-component.h" + line="139">Unknown scope + + + System scope + + + User scope + + + Converts the text representation to an enumerated value. + + an array of CSM ages - - - + filename="src/as-component.c" + line="321">a #AsComponentScope or %AS_COMPONENT_SCOPE_UNKNOWN for unknown + - + an #AsContentRatingSystem - + filename="src/as-component.c" + line="317">the string. + - + + + + Converts the enumerated value to an text representation. + + + string version of @scope + + + + return location for the length of the - returned array - + filename="src/as-component.c" + line="299">the #AsComponentScope. + - + + + + Get an array of all the possible return values of -as_content_rating_system_format_age() for the given @system. The array is -sorted with youngest CSM age first. - + line="1576">Creates a new #AsContentRating. + %NULL-terminated array of human-readable age strings - - - + line="1581">a #AsContentRating + + + + + Gets the highest #AsContentRatingValue which is allowed to be seen by the +given Common Sense Media @age for the given subsection @id. + +For example, if the CSM age mappings for `violence-bloodshed` are: + * age ≥ 0 for %AS_CONTENT_RATING_VALUE_NONE + * age ≥ 9 for %AS_CONTENT_RATING_VALUE_MILD + * age ≥ 11 for %AS_CONTENT_RATING_VALUE_MODERATE + * age ≥ 18 for %AS_CONTENT_RATING_VALUE_INTENSE +then calling this function with `violence-bloodshed` and @age set to 17 would +return %AS_CONTENT_RATING_VALUE_MODERATE. Calling it with age 18 would +return %AS_CONTENT_RATING_VALUE_INTENSE. + + + the #AsContentRatingValue, or %AS_CONTENT_RATING_VALUE_UNKNOWN if + unknown + - + an #AsContentRatingSystem - + line="1299">the subsection ID e.g. `violence-cartoon` + + + + the CSM age + - Get a human-readable string to identify @system. %NULL will be returned for -%AS_CONTENT_RATING_SYSTEM_UNKNOWN. - - + line="1147">Get a human-readable description of what content would be expected to +require the content rating attribute given by @id and @value. + + a human-readable string for @system, or %NULL if unknown + line="1155">a human-readable description of @id and @value - + an #AsContentRatingSystem - + line="1149">the subsection ID e.g. `violence-cartoon` + + + + the #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_INTENSE + - - - The specified level of an content_rating rating ID. - - Unknown value - - - None - - - A small amount - - - A moderate amount - - - An intense amount - - + Converts the text representation to an enumerated value. - + line="1257">Gets the Common Sense Media approved age for a specific rating level. + a #AsContentRatingValue or %AS_CONTENT_RATING_VALUE_UNKNOWN for unknown - + line="1264">The age in years, or 0 for no details. + - + the string. + line="1259">the subsection ID e.g. `violence-cartoon` + + the #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_INTENSE + + - + Converts the enumerated value to an text representation. - - + line="1339">Returns a list of all the valid OARS content rating attribute IDs as could +be passed to as_content_rating_add_attribute() or +as_content_rating_attribute_to_csm_age(). + + string version of @value - + line="1346">a %NULL-terminated + array of IDs, to be freed with g_free() (the element values are owned by + libappstream and must not be freed) + + + + + + + Adds an attribute value to the content rating. + + + + + a #AsContentRating instance. + + + + a content rating ID, e.g. `money-gambling`. + + the #AsContentRatingValue. + line="497">a #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_MODERATE. - - - - - - Creates a new #AsContext. - - - an #AsContext - - - - - - - The name of the file the data originates from. - - - - - a #AsContext instance. - - - - - - - - The AppStream format version. - - - - - a #AsContext instance. - - - - - - - - The active locale. - - - - - a #AsContext instance. - - - - - - - - %TRUE if all locale should be parsed. - - - - - a #AsContext instance. - - - - - - - - The media base URL. - - - - - a #AsContext instance. - - - - - + + Gets the content_rating kind. + The data origin. + filename="src/as-content-rating.c" + line="1410">a string, e.g. "oars-1.0", or NULL - - a #AsContext instance. - - - - - - - - The data priority. - - - - + a #AsContext instance. - + filename="src/as-content-rating.c" + line="1406">a #AsContentRating instance. + - - + + Gets the lowest Common Sense Media approved age for the content_rating block. +NOTE: these numbers are based on the data and descriptions available from +https://www.commonsensemedia.org/about-us/our-mission/about-our-ratings and +you may disagree with them. + +You're free to disagree with these, and of course you should use your own +brain to work our if your child is able to cope with the concepts enumerated +here. Some 13 year olds may be fine with the concept of mutilation of body +parts; others may get nightmares. + The document style. - + filename="src/as-content-rating.c" + line="1377">The age in years, 0 for no rating, or G_MAXUINT for no details. + - + a #AsContext instance. - + filename="src/as-content-rating.c" + line="1365">a #AsContentRating + - - - + + Gets the set of ratings IDs which are present in this @content_rating. An +example of a ratings ID is `violence-bloodshed`. + +The IDs are returned in lexicographical order. + + %TRUE if a media base URL is set. - + filename="src/as-content-rating.c" + line="107">%NULL-terminated + array of ratings IDs; each ratings ID is owned by the #AsContentRating and + must not be freed, but the container must be freed with g_free() + + + - + a #AsContext instance. - + filename="src/as-content-rating.c" + line="100">a #AsContentRating + - + Sets the file name we are loading data from. - + filename="src/as-content-rating.c" + line="160">Gets the value of a content rating key. + - + the #AsContentRatingValue, or %AS_CONTENT_RATING_VALUE_UNKNOWN + - + a #AsContext instance. - + filename="src/as-content-rating.c" + line="162">a #AsContentRating + - + the new file name. + filename="src/as-content-rating.c" + line="163">A ratings ID, e.g. `violence-bloodshed`. - - Sets the AppStream format version. - - - - - - - a #AsContext instance. - - - - the new format version. - - - - - + Sets the active locale. - + filename="src/as-content-rating.c" + line="1422">Sets the content rating kind. + - + a #AsContext instance. - + filename="src/as-content-rating.c" + line="1424">a #AsContentRating instance. + - + the new value. + filename="src/as-content-rating.c" + line="1425">the rating kind, e.g. "oars-1.0" - + Sets the media base URL. - + filename="src/as-content-rating.c" + line="133">Sets the value of a content rating key. + - + a #AsContext instance. - + filename="src/as-content-rating.c" + line="135">a #AsContentRating + - + the new value. + filename="src/as-content-rating.c" + line="136">A ratings ID, e.g. `violence-bloodshed`. - - - - Sets the data origin. - - - - - - - a #AsContext instance. - - the new value. - - - - - - Sets the data priority. - - - - - - - a #AsContext instance. - - - - the new priority. - - - - - - Sets the AppStream document style. - - - - - - - a #AsContext instance. - - - - the new document style. - + filename="src/as-content-rating.c" + line="137">A #AsContentRatingValue, e.g. %AS_CONTENT_RATING_VALUE_INTENSE + @@ -7768,16 +7493,16 @@ sorted with youngest CSM age first. - - + + - + @@ -7785,7 +7510,7 @@ sorted with youngest CSM age first. - + @@ -7793,7 +7518,7 @@ sorted with youngest CSM age first. - + @@ -7801,7 +7526,7 @@ sorted with youngest CSM age first. - + @@ -7809,7 +7534,7 @@ sorted with youngest CSM age first. - + @@ -7817,910 +7542,780 @@ sorted with youngest CSM age first. - + - + Kind of an input method for users to control software + filename="src/as-content-rating.h" + line="48">A content rating system for a particular territory. + glib:name="AS_CONTENT_RATING_SYSTEM_UNKNOWN"> Unknown kind + filename="src/as-content-rating.h" + line="50">Unknown ratings system - + c:identifier="AS_CONTENT_RATING_SYSTEM_INCAA" + glib:nick="incaa" + glib:name="AS_CONTENT_RATING_SYSTEM_INCAA"> Mouse/cursors/other pointing device + filename="src/as-content-rating.h" + line="51">INCAA - + c:identifier="AS_CONTENT_RATING_SYSTEM_ACB" + glib:nick="acb" + glib:name="AS_CONTENT_RATING_SYSTEM_ACB"> Keyboard input + filename="src/as-content-rating.h" + line="52">ACB - + c:identifier="AS_CONTENT_RATING_SYSTEM_DJCTQ" + glib:nick="djctq" + glib:name="AS_CONTENT_RATING_SYSTEM_DJCTQ"> Console / command-line interface + filename="src/as-content-rating.h" + line="53">DJCTQ - + c:identifier="AS_CONTENT_RATING_SYSTEM_GSRR" + glib:nick="gsrr" + glib:name="AS_CONTENT_RATING_SYSTEM_GSRR"> Touch input + filename="src/as-content-rating.h" + line="54">GSRR - + c:identifier="AS_CONTENT_RATING_SYSTEM_PEGI" + glib:nick="pegi" + glib:name="AS_CONTENT_RATING_SYSTEM_PEGI"> Gamepad input (any game controller with wheels/buttons/joysticks) + filename="src/as-content-rating.h" + line="55">PEGI - + c:identifier="AS_CONTENT_RATING_SYSTEM_KAVI" + glib:nick="kavi" + glib:name="AS_CONTENT_RATING_SYSTEM_KAVI"> Control via voice recognition/activation + filename="src/as-content-rating.h" + line="56">KAVI - + c:identifier="AS_CONTENT_RATING_SYSTEM_USK" + glib:nick="usk" + glib:name="AS_CONTENT_RATING_SYSTEM_USK"> Computer vision / visual object and sign detection + filename="src/as-content-rating.h" + line="57">USK - + c:identifier="AS_CONTENT_RATING_SYSTEM_ESRA" + glib:nick="esra" + glib:name="AS_CONTENT_RATING_SYSTEM_ESRA"> Input via a television remote + filename="src/as-content-rating.h" + line="58">ESRA - + c:identifier="AS_CONTENT_RATING_SYSTEM_CERO" + glib:nick="cero" + glib:name="AS_CONTENT_RATING_SYSTEM_CERO"> Graphics tablet input + filename="src/as-content-rating.h" + line="59">CERO - + Converts the text representation to an enumerated value. - - + filename="src/as-content-rating.h" + line="60">OFLCNZ + + + Russia + + + MDA + + + GRAC + + + ESRB + + + IARC + + + Format @age as a human-readable string in the given rating @system. This is +the way to present system-specific strings in a UI. + + a #AsControlKind or %AS_CONTROL_KIND_UNKNOWN for unknown - + filename="src/as-content-rating.c" + line="295">a newly allocated formatted version of + @age, or %NULL if the given @system has no representation for @age + - + the string. - + filename="src/as-content-rating.c" + line="289">an #AsContentRatingSystem + + + + a CSM age to format + - + Converts the enumerated value to a text representation. - + filename="src/as-content-rating.c" + line="683">Determine the most appropriate #AsContentRatingSystem for the given @locale. +Content rating systems are selected by territory. If no content rating system +seems suitable, %AS_CONTENT_RATING_SYSTEM_IARC is returned. + string version of @kind - + filename="src/as-content-rating.c" + line="691">the most relevant #AsContentRatingSystem + - + the #AsControlKind. - + filename="src/as-content-rating.c" + line="685">a locale, in the format described in `man 3 setlocale` + - - - The flags used when matching unique IDs. - - No flags set - - - Scope, e.g. a #AsComponentScope - - - Bundle kind, e.g. a #AsBundleKind - - - Origin - - - Component AppStream ID - - - Branch - - - - A rough estimate of how large a given display length is. - - Unknown - - - Very small display - - - Small display - - - Medium display - - - Large display - - + Very large display - - Get the CSM ages corresponding to the entries returned by +as_content_rating_system_get_formatted_ages() for this @system. + + + an array of CSM ages + + + + + + + an #AsContentRatingSystem + + + + return location for the length of the + returned array + + + + + Converts the text representation to an enumerated value. - - + filename="src/as-content-rating.c" + line="520">Get an array of all the possible return values of +as_content_rating_system_format_age() for the given @system. The array is +sorted with youngest CSM age first. + + a #AsDisplayLengthKind or %AS_DISPLAY_LENGTH_KIND_UNKNOWN for unknown - + filename="src/as-content-rating.c" + line="528">%NULL-terminated array of human-readable age strings + + + - + the string. - + filename="src/as-content-rating.c" + line="522">an #AsContentRatingSystem + Converts the enumerated value to a text representation. - - + filename="src/as-content-rating.c" + line="257">Get a human-readable string to identify @system. %NULL will be returned for +%AS_CONTENT_RATING_SYSTEM_UNKNOWN. + + string version of @kind + filename="src/as-content-rating.c" + line="264">a human-readable string for @system, or %NULL if unknown - + the #AsDisplayLengthKind. - + filename="src/as-content-rating.c" + line="259">an #AsContentRatingSystem + - + Side a display_length requirement is for. + filename="src/as-content-rating.h" + line="92">The specified level of an content_rating rating ID. + glib:name="AS_CONTENT_RATING_VALUE_UNKNOWN"> Unknown + filename="src/as-content-rating.h" + line="94">Unknown value - + c:identifier="AS_CONTENT_RATING_VALUE_NONE" + glib:nick="none" + glib:name="AS_CONTENT_RATING_VALUE_NONE"> Shortest side of the display rectangle. + filename="src/as-content-rating.h" + line="95">None - + c:identifier="AS_CONTENT_RATING_VALUE_MILD" + glib:nick="mild" + glib:name="AS_CONTENT_RATING_VALUE_MILD"> Longest side of the display rectangle. + filename="src/as-content-rating.h" + line="96">A small amount + + + A moderate amount + + + An intense amount + c:identifier="as_content_rating_value_from_string" + version="0.11.0"> Converts the text representation to an enumerated value. - + filename="src/as-content-rating.c" + line="221">Converts the text representation to an enumerated value. + a #AsDisplaySideKind or %AS_DISPLAY_SIDE_KIND_UNKNOWN for unknown - + filename="src/as-content-rating.c" + line="227">a #AsContentRatingValue or %AS_CONTENT_RATING_VALUE_UNKNOWN for unknown + - + the string. + filename="src/as-content-rating.c" + line="223">the string. + c:identifier="as_content_rating_value_to_string" + version="0.11.0"> Converts the enumerated value to a text representation. - + filename="src/as-content-rating.c" + line="197">Converts the enumerated value to an text representation. + string version of @kind + filename="src/as-content-rating.c" + line="203">string version of @value - + the #AsDisplaySideKind. - + filename="src/as-content-rating.c" + line="199">the #AsContentRatingValue. + - - Format of the AppStream metadata. - - Unknown metadata format. - - - AppStream XML metadata. - - - AppStream YAML (DEP-11) metadata. - - - XDG Desktop Entry data. - - + + + Converts the text representation to an enumerated value. - - + filename="src/as-context.c" + line="676">Creates a new #AsContext. + + a #AsFormatKind or %AS_FORMAT_KIND_UNKNOWN for unknown - + filename="src/as-context.c" + line="681">an #AsContext + - - - the string. - - - - - - Converts the enumerated value to an text representation. - + + + string version of @kind + filename="src/as-context.c" + line="412">The name of the file the data originates from. - + the #AsFormatKind. - - + filename="src/as-context.c" + line="410">a #AsContext instance. + + - - - - There are a few differences between AppStream's metainfo files (shipped by upstream projects) -and the catalog metadata (shipped by distributors). -The data source kind indicates which style we should process. -Usually you do not want to set this explicitly. - - The format style is unknown. - - - Parse AppStream upstream metadata (metainfo files) - - - Parse AppStream metadata catalog (shipped by software distributors) - - - - Format version / API level of the AppStream metadata. - - Unknown format version - - - 1.0 - - - Converts the text representation to an enumerated value. - + + + a #AsFormatVersion. For unknown, the highest version -number is assumed. + line="186">The AppStream format version. - + the string. - - + line="184">a #AsContext instance. + + - - - Converts the enumerated value to an text representation. - + + + string version of @version + line="294">The active locale in BCP47 format. - + the #AsFormatKind. - - + line="292">a #AsContext instance. + + - - - - - - Creates a new #AsIcon. - - - a #AsIcon - - - - - + + + The absolute path for the icon on disk. -This is only set for icons of kind %AS_ICON_KIND_LOCAL or -%AS_ICON_KIND_CACHED. - + filename="src/as-context.c" + line="332">%TRUE if all locale should be parsed. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="330">a #AsContext instance. + - - + + The icon height in pixels, or 0 if unknown. - + filename="src/as-context.c" + line="358">The media base URL. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="356">a #AsContext instance. + - - Gets the icon kind. - + + the #AsIconKind - + filename="src/as-context.c" + line="267">The data origin. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="265">a #AsContext instance. + - - + + the stock name of the icon. In case the icon is not of kind -"stock", the basename of the icon filename or URL is returned. - + filename="src/as-context.c" + line="240">The data priority. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="238">a #AsContext instance. + - - + + The icon scaling factor. - + filename="src/as-context.c" + line="213">The document style. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="211">a #AsContext instance. + - - Gets the icon URL, pointing at a remote location. HTTPS and FTP urls are allowed. -This property is only set for icons of type %AS_ICON_KIND_REMOTE - + + the URL - + filename="src/as-context.c" + line="452">The #AsValueFlags that are set on @cpt. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="450">a #AsContext instance. + - - + + The icon width in pixels, or 0 if unknown. - + filename="src/as-context.c" + line="345">%TRUE if a media base URL is set. + - + a #AsIcon instance. - - + filename="src/as-context.c" + line="343">a #AsContext instance. + + - + Sets the icon absolute filename. - + filename="src/as-context.c" + line="421">Sets the file name we are loading data from. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="423">a #AsContext instance. + - + the new icon URL. + filename="src/as-context.c" + line="424">the new file name. - + Sets the icon height. - + filename="src/as-context.c" + line="195">Sets the AppStream format version. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="197">a #AsContext instance. + - + the height in pixels. - + filename="src/as-context.c" + line="198">the new format version. + - + Sets the icon kind. - + filename="src/as-context.c" + line="303">Sets the active locale. +If the magic value "ALL" is used, the current system locale will be used +for data reading, but when writing data all locale will be written. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="305">a #AsContext instance. + - + the #AsIconKind, e.g. %AS_ICON_KIND_CACHED. - + filename="src/as-context.c" + line="306">a POSIX or BCP47 locale, or %NULL. e.g. "en_GB" + - + Sets the stock name or basename to use for the icon. - + filename="src/as-context.c" + line="367">Sets the media base URL. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="369">a #AsContext instance. + - + the icon stock name, e.g. "gwenview" + filename="src/as-context.c" + line="370">the new value. - + Sets the icon scaling factor used for HiDPI displays. - + filename="src/as-context.c" + line="276">Sets the data origin. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="278">a #AsContext instance. + - + the icon scaling factor. - + filename="src/as-context.c" + line="279">the new value. + - + Sets the icon URL. - + filename="src/as-context.c" + line="249">Sets the data priority. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="251">a #AsContext instance. + - + the new icon URL. - + filename="src/as-context.c" + line="252">the new priority. + - + Sets the icon width. - + filename="src/as-context.c" + line="222">Sets the AppStream document style. + - + a #AsIcon instance. - + filename="src/as-context.c" + line="224">a #AsContext instance. + - + the width in pixels. - + filename="src/as-context.c" + line="225">the new document style. + + + + + + + + + + + + a #AsContext instance. + + + + #AsValueFlags to set on @cpt. + @@ -8728,16 +8323,16 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - - + + - + @@ -8745,7 +8340,7 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - + @@ -8753,7 +8348,7 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - + @@ -8761,7 +8356,7 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - + @@ -8769,7 +8364,7 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - + @@ -8777,342 +8372,329 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - + - + The icon type. + filename="src/as-relation.h" + line="123">Kind of an input method for users to control software + glib:name="AS_CONTROL_KIND_UNKNOWN"> Unknown icon kind + filename="src/as-relation.h" + line="125">Unknown kind - + c:identifier="AS_CONTROL_KIND_POINTING" + glib:nick="pointing" + glib:name="AS_CONTROL_KIND_POINTING"> Icon in the internal caches + filename="src/as-relation.h" + line="126">Mouse/cursors/other precision pointing device - + c:identifier="AS_CONTROL_KIND_KEYBOARD" + glib:nick="keyboard" + glib:name="AS_CONTROL_KIND_KEYBOARD"> Stock icon name + filename="src/as-relation.h" + line="127">Keyboard input - + c:identifier="AS_CONTROL_KIND_CONSOLE" + glib:nick="console" + glib:name="AS_CONTROL_KIND_CONSOLE"> Local icon name + filename="src/as-relation.h" + line="128">Console / command-line interface - + c:identifier="AS_CONTROL_KIND_TOUCH" + glib:nick="touch" + glib:name="AS_CONTROL_KIND_TOUCH"> Remote icon URL + filename="src/as-relation.h" + line="129">Touch input - + Converts the text representation to an enumerated value. - - - a #AsIconKind or %AS_ICON_KIND_UNKNOWN for unknown - - - - - the string. - - - - - + filename="src/as-relation.h" + line="130">Gamepad input (any game controller with wheels/buttons/joysticks) + + Converts the enumerated value to an text representation. - - - string version of @kind - - - - - the %AsIconKind. - - - - - - - - + filename="src/as-relation.h" + line="131">Control via voice recognition/activation + + Creates a new #AsImage. - - - a #AsImage - - - - + filename="src/as-relation.h" + line="132">Computer vision / visual object and sign detection + + Gets the image height. - - - height in pixels - - - - - a #AsImage instance. - - - - - + filename="src/as-relation.h" + line="133">Input via a television remote + + Gets the image kind. - - - the #AsImageKind - - - - - a #AsImage instance. - - - - - + filename="src/as-relation.h" + line="134">Graphics tablet input + + Get locale for this image. - + filename="src/as-relation.c" + line="328">Converts the text representation to an enumerated value. + Locale string - + filename="src/as-relation.c" + line="334">a #AsControlKind or %AS_CONTROL_KIND_UNKNOWN for unknown + - + a #AsImage instance. - - + filename="src/as-relation.c" + line="330">the string. + + - - + + Gets the full qualified URL for the image, usually pointing at some mirror. - + filename="src/as-relation.c" + line="294">Converts the enumerated value to a text representation. + URL + filename="src/as-relation.c" + line="300">string version of @kind - + a #AsImage instance. - - + filename="src/as-relation.c" + line="296">the #AsControlKind. + + - - + + + + The flags used when matching unique IDs. + Gets the image width. - - + filename="src/as-utils.h" + line="49">No flags set + + + Scope, e.g. a #AsComponentScope + + + Bundle kind, e.g. a #AsBundleKind + + + Origin + + + Component AppStream ID + + + Branch + + + + + + Creates a new #AsDeveloper. + + width in pixels - + filename="src/as-developer.c" + line="94">a #AsDeveloper + - - - a #AsImage instance. - - - - - + + Sets the image height. - + filename="src/as-developer.c" + line="153">Gets a unique ID for this particular developer, e.g. "gnome" or "mozilla.org" + - + the unique developer ID, or %NULL if none was set. + - + a #AsImage instance. - + filename="src/as-developer.c" + line="155">an #AsDeveloper instance. + - - the height in pixels. - - - + Sets the image kind. - + filename="src/as-developer.c" + line="185">Get a localized developer, or development team name. + - + the developer name. + - + a #AsImage instance. - + filename="src/as-developer.c" + line="187">an #AsDeveloper instance. + - - the #AsImageKind, e.g. %AS_IMAGE_KIND_THUMBNAIL. - - - + Sets the locale for this image. - + filename="src/as-developer.c" + line="168">Sets the unique ID of this developer. + - + a #AsImage instance. - + filename="src/as-developer.c" + line="170">an #AsDeveloper instance. + - + the BCP47 locale string. + filename="src/as-developer.c" + line="171">a developer ID, e.g. "mozilla.org" - + Sets the fully-qualified mirror URL to use for the image. - + filename="src/as-developer.c" + line="200">Set the the developer or development team name. + - + a #AsImage instance. - + filename="src/as-developer.c" + line="202">an #AsDeveloper instance. + - + the URL. + filename="src/as-developer.c" + line="203">the developer or developer team name - - - - Sets the image width. - - - - - - - a #AsImage instance. - - - + the width in pixels. - + filename="src/as-developer.c" + line="204">the BCP47 locale, or %NULL. e.g. "en-GB" + @@ -9120,16 +8702,16 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - - + + - + @@ -9137,7 +8719,7 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - + @@ -9145,7 +8727,7 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - + @@ -9153,7 +8735,7 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - + @@ -9161,7 +8743,7 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - + @@ -9169,342 +8751,617 @@ This property is only set for icons of type %AS_ICON_KIND_REMOTE - + - + The image type. + filename="src/as-relation.h" + line="153">Side a display_length requirement is for. + glib:name="AS_DISPLAY_SIDE_KIND_UNKNOWN"> Type invalid or not known + filename="src/as-relation.h" + line="155">Unknown - + c:identifier="AS_DISPLAY_SIDE_KIND_SHORTEST" + glib:nick="shortest" + glib:name="AS_DISPLAY_SIDE_KIND_SHORTEST"> The source image at full resolution + filename="src/as-relation.h" + line="156">Shortest side of the display rectangle. - + c:identifier="AS_DISPLAY_SIDE_KIND_LONGEST" + glib:nick="longest" + glib:name="AS_DISPLAY_SIDE_KIND_LONGEST"> A thumbnail at reduced resolution + filename="src/as-relation.h" + line="157">Longest side of the display rectangle. - + Converts the text representation to an enumerated value. - - + filename="src/as-relation.c" + line="382">Converts the text representation to an enumerated value. + + a #AsImageKind, or %AS_IMAGE_KIND_UNKNOWN for unknown. - + filename="src/as-relation.c" + line="388">a #AsDisplaySideKind or %AS_DISPLAY_SIDE_KIND_UNKNOWN for unknown + - + the string. + filename="src/as-relation.c" + line="384">the string. - + Converts the enumerated value to an text representation. - + filename="src/as-relation.c" + line="362">Converts the enumerated value to a text representation. + string version of @kind + filename="src/as-relation.c" + line="368">string version of @kind the #AsImageKind. - + filename="src/as-relation.c" + line="364">the #AsDisplaySideKind. + - + Different internet connectivity requirements or recommendations for an -application. + filename="src/as-context.h" + line="84">Format of the AppStream metadata. + glib:name="AS_FORMAT_KIND_UNKNOWN"> Unknown + filename="src/as-context.h" + line="86">Unknown metadata format. - + c:identifier="AS_FORMAT_KIND_XML" + glib:nick="xml" + glib:name="AS_FORMAT_KIND_XML"> Always requires/recommends internet + filename="src/as-context.h" + line="87">AppStream XML metadata. - + c:identifier="AS_FORMAT_KIND_YAML" + glib:nick="yaml" + glib:name="AS_FORMAT_KIND_YAML"> Application is offline-only + filename="src/as-context.h" + line="88">AppStream YAML (DEP-11) metadata. - + c:identifier="AS_FORMAT_KIND_DESKTOP_ENTRY" + glib:nick="desktop-entry" + glib:name="AS_FORMAT_KIND_DESKTOP_ENTRY"> Requires/Recommends internet on first run only + filename="src/as-context.h" + line="89">XDG Desktop Entry data. + c:identifier="as_format_kind_from_string" + version="0.10.0"> Converts the text representation to an enumerated value. - + filename="src/as-context.c" + line="122">Converts the text representation to an enumerated value. + a #AsInternetKind or %AS_INTERNET_KIND_UNKNOWN for unknown - + filename="src/as-context.c" + line="128">a #AsFormatKind or %AS_FORMAT_KIND_UNKNOWN for unknown + the string. + filename="src/as-context.c" + line="124">the string. + c:identifier="as_format_kind_to_string" + version="0.10.0"> Converts the enumerated value to a text representation. - + filename="src/as-context.c" + line="102">Converts the enumerated value to an text representation. + string version of @kind + filename="src/as-context.c" + line="108">string version of @kind the #AsInternetKind. - + filename="src/as-context.c" + line="104">the #AsFormatKind. + - - - + + There are a few differences between AppStream's metainfo files (shipped by upstream projects) +and the catalog metadata (shipped by distributors). +The data source kind indicates which style we should process. +Usually you do not want to set this explicitly. + Creates a new #AsIssue. - - - an #AsIssue - - - - + filename="src/as-context.h" + line="67">The format style is unknown. + + Gets the issue ID (usually a bug number or CVE ID) - + filename="src/as-context.h" + line="68">Parse AppStream upstream metadata (metainfo files) + + + Parse AppStream metadata catalog (shipped by software distributors) + + + + Format version / API level of the AppStream metadata. + + Unknown format version + + + 1.0 + + + Converts the text representation to an enumerated value. + the ID. - + filename="src/as-context.c" + line="89">a #AsFormatVersion. For unknown, the highest version +number is assumed. + - + a #AsIssue instance. - - + filename="src/as-context.c" + line="85">the string. + + - - + + Gets the issue type. - + filename="src/as-context.c" + line="65">Converts the enumerated value to an text representation. + the #AsIssueKind - + filename="src/as-context.c" + line="71">string version of @version + - + a #AsIssue instance. - - + filename="src/as-context.c" + line="67">the #AsFormatKind. + + - - + + + + + Gets the URL associacted with this issue, usually -referencing a bug report or issue description. - + filename="src/as-icon.c" + line="463">Creates a new #AsIcon. + + + a #AsIcon + + + + + the URL. + filename="src/as-icon.c" + line="228">The absolute path for the icon on disk. +This is only set for icons of kind %AS_ICON_KIND_LOCAL or +%AS_ICON_KIND_CACHED. - + a #AsIssue instance. - + filename="src/as-icon.c" + line="226">a #AsIcon instance. + - + + + + The icon height in pixels, or 0 if unknown. + + + + + a #AsIcon instance. + + + + + Sets the issue ID. - + filename="src/as-icon.c" + line="125">Gets the icon kind. + + + the #AsIconKind + + + + + a #AsIcon instance. + + + + + + + + the stock name of the icon. In case the icon is not of kind +"stock", the basename of the icon filename or URL is returned. + + + + + a #AsIcon instance. + + + + + + + + The icon scaling factor. + + + + + a #AsIcon instance. + + + + + + Gets the icon URL, pointing at a remote location. HTTPS and FTP urls are allowed. +This property is only set for icons of type %AS_ICON_KIND_REMOTE + + + the URL + + + + + a #AsIcon instance. + + + + + + + + The icon width in pixels, or 0 if unknown. + + + + + a #AsIcon instance. + + + + + + Sets the icon absolute filename. + - + a #AsIssue instance. - + filename="src/as-icon.c" + line="241">a #AsIcon instance. + - + the new ID. + filename="src/as-icon.c" + line="242">the new icon URL. - + Sets the issue type. - + filename="src/as-icon.c" + line="298">Sets the icon height. + - + a #AsIssue instance. - + filename="src/as-icon.c" + line="300">a #AsIcon instance. + + + + the height in pixels. + + + + + + Sets the icon kind. + + + + + + + a #AsIcon instance. + the #AsIssueKind, e.g. %AS_ISSUE_KIND_SHA256. - + filename="src/as-icon.c" + line="143">the #AsIconKind, e.g. %AS_ICON_KIND_CACHED. + - + Sets an URL describing this issue. - + filename="src/as-icon.c" + line="176">Sets the stock name or basename to use for the icon. + - + a #AsIssue instance. - + filename="src/as-icon.c" + line="178">a #AsIcon instance. + + + + the icon stock name, e.g. "gwenview" + + + + + + Sets the icon scaling factor used for HiDPI displays. + + + + + + + a #AsIcon instance. + + + + the icon scaling factor. + + + + + + Sets the icon URL. + + + + + + + a #AsIcon instance. + the new URL. + filename="src/as-icon.c" + line="213">the new icon URL. + + Sets the icon width. + + + + + + + a #AsIcon instance. + + + + the width in pixels. + + + + - - - - + + + + - + @@ -9512,7 +9369,7 @@ referencing a bug report or issue description. - + @@ -9520,7 +9377,7 @@ referencing a bug report or issue description. - + @@ -9528,7 +9385,7 @@ referencing a bug report or issue description. - + @@ -9536,7 +9393,7 @@ referencing a bug report or issue description. - + @@ -9544,293 +9401,385 @@ referencing a bug report or issue description. - + - + Checksums supported by #AsRelease + filename="src/as-icon.h" + line="46">The icon type. - Unknown issue type - - - Generic issue type - - - Common Vulnerabilities and Exposures issue - - - Converts the text representation to an enumerated value. - - - a #AsIssueKind or %AS_ISSUE_KIND_UNKNOWN for unknown - - - - - the string. - - - - - + glib:name="AS_ICON_KIND_UNKNOWN"> Converts the enumerated value to an text representation. - - - string version of @kind - - - - - the %AsIssueKind. - - - - - - - The severity of an issue found by #AsValidator - + filename="src/as-icon.h" + line="48">Unknown icon kind - + c:identifier="AS_ICON_KIND_STOCK" + glib:nick="stock" + glib:name="AS_ICON_KIND_STOCK"> There is a serious, fatal error in your metadata + filename="src/as-icon.h" + line="49">Stock icon name - + c:identifier="AS_ICON_KIND_CACHED" + glib:nick="cached" + glib:name="AS_ICON_KIND_CACHED"> Something metadata issue which should be fixed as soon as possible. + filename="src/as-icon.h" + line="50">Icon in the internal caches - + c:identifier="AS_ICON_KIND_LOCAL" + glib:nick="local" + glib:name="AS_ICON_KIND_LOCAL"> Non-essential information on how to improve metadata, no immediate action needed. + filename="src/as-icon.h" + line="51">Local icon name - + c:identifier="AS_ICON_KIND_REMOTE" + glib:nick="remote" + glib:name="AS_ICON_KIND_REMOTE"> Pedantic information about ways to improve the data, but could also be ignored. + filename="src/as-icon.h" + line="52">Remote icon URL - + Converts the text representation to an enumerated value. - + filename="src/as-icon.c" + line="67">Converts the text representation to an enumerated value. + a #AsIssueSeverity, or %AS_ISSUE_SEVERITY_UNKNOWN for unknown. - + filename="src/as-icon.c" + line="73">a #AsIconKind or %AS_ICON_KIND_UNKNOWN for unknown + - + the string. + filename="src/as-icon.c" + line="69">the string. - + Converts the enumerated value to an text representation. - + filename="src/as-icon.c" + line="45">Converts the enumerated value to an text representation. + string version of @severity + filename="src/as-icon.c" + line="51">string version of @kind - + the #AsIssueSeverity. - + filename="src/as-icon.c" + line="47">the %AsIconKind. + - - - + glib:type-name="AsImage" + glib:get-type="as_image_get_type" + glib:type-struct="ImageClass"> + + Creates a new #AsLaunchable. - + filename="src/as-image.c" + line="537">Creates a new #AsImage. + a #AsLaunchable - + filename="src/as-image.c" + line="542">a #AsImage + - + Add a new launchable entry. - + filename="src/as-image.c" + line="210">Gets the image height. + - + height in pixels + - + a #AsLaunchable instance. - + filename="src/as-image.c" + line="212">an #AsImage instance. + - - - - + Get an array of launchable entries. - + filename="src/as-image.c" + line="132">Gets the image kind. + An string list of launch entries. - - - + filename="src/as-image.c" + line="138">the #AsImageKind + - + a #AsLaunchable instance. - + filename="src/as-image.c" + line="134">an #AsImage instance. + - + The launch system for the entries this #AsLaunchable -object stores. - + filename="src/as-image.c" + line="273">Get locale for this image. + an enum of type #AsLaunchableKind - + filename="src/as-image.c" + line="279">Locale string + - + a #AsLaunchable instance. - + filename="src/as-image.c" + line="275">an #AsImage instance. + - + Set the launch system for the entries this #AsLaunchable -object stores. - + filename="src/as-image.c" + line="241">Gets the image integer scale factor. + - + the scale factor. + - + a #AsLaunchable instance. - + filename="src/as-image.c" + line="243">an #AsImage instance. + + + + + + Gets the full qualified URL for the image, usually pointing at some mirror. + + + URL + + + + + an #AsImage instance. + + + + + + Gets the image width. + + + width in pixels + + + + + an #AsImage instance. + + + + + + Sets the image height. + + + + + + + an #AsImage instance. + + + + the height in pixels. + + + + + + Sets the image kind. + + + + + + + an #AsImage instance. + the new #AsLaunchableKind - + filename="src/as-image.c" + line="120">the #AsImageKind, e.g. %AS_IMAGE_KIND_THUMBNAIL. + + + + + + Sets the locale for this image. + + + + + + + an #AsImage instance. + + + + the BCP47 locale string. + + + + + + Sets the image scale factor. + + + + + + + an #AsImage instance. + + + + the integer scale factor, e.g. 2 + + + + + + Sets the fully-qualified mirror URL to use for the image. + + + + + + + an #AsImage instance. + + + + the URL. + + + + + + Sets the image width. + + + + + + + an #AsImage instance. + + + + the width in pixels. + @@ -9838,16 +9787,16 @@ object stores. - - + + - + @@ -9855,7 +9804,7 @@ object stores. - + @@ -9863,7 +9812,7 @@ object stores. - + @@ -9871,7 +9820,7 @@ object stores. - + @@ -9879,7 +9828,7 @@ object stores. - + @@ -9887,2089 +9836,2592 @@ object stores. - + - + Type of launch system the entries belong to. + filename="src/as-image.h" + line="46">The image type. + glib:name="AS_IMAGE_KIND_UNKNOWN"> Unknown kind + filename="src/as-image.h" + line="48">Type invalid or not known - + c:identifier="AS_IMAGE_KIND_SOURCE" + glib:nick="source" + glib:name="AS_IMAGE_KIND_SOURCE"> Launch by desktop-id + filename="src/as-image.h" + line="49">The source image at full resolution - - A systemd/SysV-init service name - - - A Cockpit manifest / package name - - + c:identifier="AS_IMAGE_KIND_THUMBNAIL" + glib:nick="thumbnail" + glib:name="AS_IMAGE_KIND_THUMBNAIL"> A web HTTPS URL to launch a web application from + filename="src/as-image.h" + line="50">A thumbnail at reduced resolution - + Converts the text representation to an enumerated value. - - + filename="src/as-image.c" + line="79">Converts the text representation to an enumerated value. + + a #AsLaunchableKind or %AS_LAUNCHABLE_KIND_UNKNOWN for unknown - + filename="src/as-image.c" + line="85">a #AsImageKind, or %AS_IMAGE_KIND_UNKNOWN for unknown. + - + the string. + filename="src/as-image.c" + line="81">the string. - + Converts the enumerated value to a text representation. - + filename="src/as-image.c" + line="98">Converts the enumerated value to an text representation. + string version of @kind + filename="src/as-image.c" + line="104">string version of @kind the #AsLaunchableKind. - + filename="src/as-image.c" + line="100">the #AsImageKind. + - - - - - - - - - - - - - + Defines how #AsComponent data should be merged if the component is -set for merge. - Different internet connectivity requirements or recommendations for an +application. + + c:identifier="AS_INTERNET_KIND_UNKNOWN" + glib:nick="unknown" + glib:name="AS_INTERNET_KIND_UNKNOWN"> No merge is happening. + filename="src/as-relation.h" + line="171">Unknown - + c:identifier="AS_INTERNET_KIND_ALWAYS" + glib:nick="always" + glib:name="AS_INTERNET_KIND_ALWAYS"> Merge replacing data of target. + filename="src/as-relation.h" + line="172">Always requires/recommends internet - + c:identifier="AS_INTERNET_KIND_OFFLINE_ONLY" + glib:nick="offline-only" + glib:name="AS_INTERNET_KIND_OFFLINE_ONLY"> Merge appending data to target. + filename="src/as-relation.h" + line="173">Application is offline-only - + c:identifier="AS_INTERNET_KIND_FIRST_RUN" + glib:nick="first-run" + glib:name="AS_INTERNET_KIND_FIRST_RUN"> Remove the entire component if it matches. + filename="src/as-relation.h" + line="174">Requires/Recommends internet on first run only - + Converts the text representation to an enumerated value. - + filename="src/as-relation.c" + line="404">Converts the text representation to an enumerated value. + a #AsMergeKind or %AS_MERGE_KIND_NONE for unknown - + filename="src/as-relation.c" + line="410">a #AsInternetKind or %AS_INTERNET_KIND_UNKNOWN for unknown + the string. + filename="src/as-relation.c" + line="406">the string. - + Converts the enumerated value to an text representation. - + filename="src/as-relation.c" + line="426">Converts the enumerated value to a text representation. + string version of @kind + filename="src/as-relation.c" + line="432">string version of @kind the #AsMergeKind. - + filename="src/as-relation.c" + line="428">the #AsInternetKind. + - - - + glib:type-name="AsIssue" + glib:get-type="as_issue_get_type" + glib:type-struct="IssueClass"> + + Creates a new #AsMetadata. - + filename="src/as-issue.c" + line="335">Creates a new #AsIssue. + a #AsMetadata - + filename="src/as-issue.c" + line="340">an #AsIssue + - + Guesses the AppStream metadata style (metainfo or catalog) based on -the filename. - + filename="src/as-issue.c" + line="137">Gets the issue ID (usually a bug number or CVE ID) + An #AsFormatStyle, e.g. %AS_FORMAT_STYLE_METAINFO. - + filename="src/as-issue.c" + line="143">the ID. + - + a file name - - + filename="src/as-issue.c" + line="139">a #AsIssue instance. + + - - + + Add an #AsComponent to the list of components. -This can be used to add multiple components in order to -produce a distro-XML AppStream metadata file. - + filename="src/as-issue.c" + line="108">Gets the issue type. + - + the #AsIssueKind + - - + + a #AsIssue instance. + - - - - - + + Gets the URL associacted with this issue, usually +referencing a bug report or issue description. + - + the URL. + - - + + a #AsIssue instance. + - + Convert an #AsComponent to metainfo data. -This will always be XML, YAML is no valid format for metainfo files. - -The amount of localization included in the metadata depends on how the #AsComponent -was initially loaded and whether it contains data for all locale. - -The first #AsComponent added to the internal list will be transformed. -In case no component is present, %NULL is returned. - - - A string containing the XML metadata. Free with g_free() - + filename="src/as-issue.c" + line="152">Sets the issue ID. + + + - + An instance of #AsMetadata. - + filename="src/as-issue.c" + line="154">a #AsIssue instance. + - + The format to use (XML or YAML) - + filename="src/as-issue.c" + line="155">the new ID. + - + Serialize all #AsComponent instances into AppStream -catalog metadata. -%NULL is returned if there is nothing to serialize. - - - A string containing the YAML or XML data. Free with g_free() - + filename="src/as-issue.c" + line="123">Sets the issue type. + + + - + An instance of #AsMetadata. - + filename="src/as-issue.c" + line="125">a #AsIssue instance. + - + The format to serialize the data to (XML or YAML). - + filename="src/as-issue.c" + line="126">the #AsIssueKind, e.g. %AS_ISSUE_KIND_SHA256. + - - + + Sets an URL describing this issue. + - The architecture of AppStream distro metadata - + - + an #AsMetadata instance. - + filename="src/as-issue.c" + line="191">a #AsIssue instance. + + + the new URL. + + - - Gets the #AsComponent which has been parsed from the XML. -If the AppStream XML contained multiple components, return the first -component that has been parsed. - - - An #AsComponent or %NULL - - - - - a #AsMetadata instance. - - - - - - - - A #GPtrArray of all parsed components - - - - - - - a #AsMetadata instance. - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Checksums supported by #AsRelease + Get the metadata parsing mode. - - - - - - - a #AsMetadata instance. - - - - - - + filename="src/as-issue.h" + line="48">Unknown issue type + + + Generic issue type + + + Common Vulnerabilities and Exposures issue + + + Converts the text representation to an enumerated value. + The AppStream metadata format version. - + filename="src/as-issue.c" + line="68">a #AsIssueKind or %AS_ISSUE_KIND_UNKNOWN for unknown + - + an #AsMetadata instance. - - + filename="src/as-issue.c" + line="64">the string. + + - - + + Gets the current active locale for parsing metadata, -or "ALL" if all locales are read. - + filename="src/as-issue.c" + line="44">Converts the enumerated value to an text representation. + Locale used for metadata parsing. + filename="src/as-issue.c" + line="50">string version of @kind - + a #AsMetadata instance. - - + filename="src/as-issue.c" + line="46">the %AsIssueKind. + + - - - + + + + The severity of an issue found by #AsValidator + + The severity is unknown. + + + Pedantic information about ways to improve the data, but could also be ignored. + + + Non-essential information on how to improve metadata, no immediate action needed. + + + Something metadata issue which should be fixed as soon as possible. + + + There is a serious, fatal error in your metadata + + + Converts the text representation to an enumerated value. + The media URL prefix. - + filename="src/as-validator-issue.c" + line="57">a #AsIssueSeverity, or %AS_ISSUE_SEVERITY_UNKNOWN for unknown. + - + an #AsMetadata instance. - - + filename="src/as-validator-issue.c" + line="53">the string. + + - - - + + + Converts the enumerated value to an text representation. + The origin of AppStream distro metadata + filename="src/as-validator-issue.c" + line="80">string version of @severity - + an #AsMetadata instance. - - + filename="src/as-validator-issue.c" + line="76">the #AsIssueSeverity. + + - - + + + + + Get the metadata parse flags. - + filename="src/as-launchable.c" + line="265">Creates a new #AsLaunchable. + + + a #AsLaunchable + + + + + Add a new launchable entry. + - + - + a #AsMetadata instance. - + filename="src/as-launchable.c" + line="185">a #AsLaunchable instance. + + + + - - + + Get an array of launchable entries. + Whether existing components should be updates with the parsed data, - instead of creating new ones. - + filename="src/as-launchable.c" + line="172">An string list of launch entries. + + + - + an #AsMetadata instance. - + filename="src/as-launchable.c" + line="168">a #AsLaunchable instance. + - - + + The launch system for the entries this #AsLaunchable +object stores. + Whether we will write a header/root node in catalog metadata. - + filename="src/as-launchable.c" + line="138">an enum of type #AsLaunchableKind + - + an #AsMetadata instance. - + filename="src/as-launchable.c" + line="133">a #AsLaunchable instance. + - + Parses any AppStream metadata into one or more #AsComponent instances. - + filename="src/as-launchable.c" + line="149">Set the launch system for the entries this #AsLaunchable +object stores. + - %TRUE on success. - + - + An instance of #AsMetadata. - + filename="src/as-launchable.c" + line="151">a #AsLaunchable instance. + - - Metadata describing one or more software components. - - - + The format of the data (XML or YAML). - + filename="src/as-launchable.c" + line="152">the new #AsLaunchableKind + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Type of launch system the entries belong to. + Parses any AppStream metadata into one or more #AsComponent instances. - + filename="src/as-launchable.h" + line="48">Unknown kind + + + Launch by desktop-id + + + A systemd/SysV-init service name + + + A Cockpit manifest / package name + + + A web HTTPS URL to launch a web application from + + + Converts the text representation to an enumerated value. + %TRUE on success. - + filename="src/as-launchable.c" + line="77">a #AsLaunchableKind or %AS_LAUNCHABLE_KIND_UNKNOWN for unknown + - - An instance of #AsMetadata. - - - + Metadata describing one or more software components as string. + filename="src/as-launchable.c" + line="73">the string. - - Length of @data, or -1 if length is unknown and @data is NULL-terminated. - - - - The format of the data (XML or YAML). - - - - + + Parses XDG Desktop Entry metadata and adds it to the list of parsed entities. - -Please note that not every desktop-entry file will result in a valid component -being generated, even if parsing succeeds without error (The desktiop-entry file -may be valid but not generate a component on purpose). - + filename="src/as-launchable.c" + line="47">Converts the enumerated value to a text representation. + %TRUE if the file was parsed without error. - + filename="src/as-launchable.c" + line="53">string version of @kind + - - An instance of #AsMetadata. - - - + The component-id the new #AsComponent should have. - + filename="src/as-launchable.c" + line="49">the #AsLaunchableKind. + - + + + + + + + + + + + + + + + + + Text markup types. + + Unknown markup. + + + XML markup. + + + Simple text with unicode symbols. + + + Markdown + + + + Defines how #AsComponent data should be merged if the component is +set for merge. + + No merge is happening. + + + Merge replacing data of target. + + + Merge appending data to target. + + + Remove the entire component if it matches. + + + Converts the text representation to an enumerated value. + + + a #AsMergeKind or %AS_MERGE_KIND_NONE for unknown + + + + Metadata describing one or more software components. + filename="src/as-component.c" + line="278">the string. - + + + + Converts the enumerated value to an text representation. + + + string version of @kind + + + + The data length, or -1 if unknown and null-terminated. - + filename="src/as-component.c" + line="255">the #AsMergeKind. + - - + + + + + Parses an AppStream upstream metadata file. - -If @file does not exist, %G_IO_ERROR_NOT_FOUND will be returned. Other -#GIOErrors and #AsMetadataErrors may be returned as appropriate. - + line="1772">Creates a new #AsMetadata. + + + a #AsMetadata + + + + + Guesses the AppStream metadata style (metainfo or catalog) based on +the filename. + %TRUE if the file was parsed without error. - + line="80">An #AsFormatStyle, e.g. %AS_FORMAT_STYLE_METAINFO. + - + A valid #AsMetadata instance + line="75">a file name + + + + + + Add an #AsComponent to the list of components. +This can be used to add multiple components in order to +produce a distro-XML AppStream metadata file. + + + + + + - - #GFile for the upstream metadata - - - - The format the data is in, or %AS_FORMAT_KIND_UNKNOWN if not known. - + + - + Parses any AppStream release metadata into #AsRelease objects. - - - A list of releases or %NULL on error. - - - + line="177">Remove all previously parsed or manually added components. + + + An instance of #AsMetadata. + line="179">an instance of #AsMetadata. - - Metadata describing release notes. - - - + Parses any AppStream release metadata into #AsRelease objects -using the provided file. - - - A list of releases or %NULL on error. - - - + line="963">Remove all previously parsed releases entries. + + + A valid #AsMetadata instance + line="965">a #AsMetadata instance. - - #GFile for the release metadata - - - Convert a list of #Asrelease entities into a release metadata XML representation. - + line="1130">Convert an #AsComponent to metainfo data. +This will always be XML, YAML is no valid format for metainfo files. + +The amount of localization included in the metadata depends on how the #AsComponent +was initially loaded and whether it contains data for all locale. + +The first #AsComponent added to the internal list will be transformed. +In case no component is present, %NULL is returned. + The XML representation or %NULL on error. + line="1145">A string containing the XML metadata. Free with g_free() A valid #AsMetadata instance + line="1132">An instance of #AsMetadata. - + the list of #Asrelease to convert. - - - + line="1133">The format to use (XML or YAML) + - Serialize all #AsComponent instances to XML or YAML metadata and save -the data to a file. -An existing file at the same location will be overridden. - - + line="1380">Serialize all #AsComponent instances into AppStream +catalog metadata. +%NULL is returned if there is nothing to serialize. + + %TRUE if the file was written without error. - + line="1390">A string containing the YAML or XML data. Free with g_free() + An instance of #AsMetadata. + line="1382">An instance of #AsMetadata. - + The filename for the new metadata file. - - - + line="1383">The format to serialize the data to (XML or YAML). - - Serialize #AsComponent instance to XML and save it to file. -An existing file at the same location will be overridden. - + + %TRUE if the file was written without error. - + line="1592">The architecture of AppStream distro metadata + + an #AsMetadata instance. - + + + + Gets the #AsComponent which has been parsed from the XML. +If the AppStream XML contained multiple components, return the last +component that has been parsed. + + + An #AsComponent or %NULL + + + + The filename for the new metadata file. - - - + line="1450">a #AsMetadata instance. + + + + + + + + an #AsComponentBox of all parsed components + + + + The format to save this file in. Only XML is supported at time. - - + line="1470">a #AsMetadata instance. + + - + Set the architecture the components in this metadata belong to. - + line="1694">Get the metadata parsing mode. + - + an #AsMetadata instance. + line="1696">a #AsMetadata instance. - + + + + + + The AppStream metadata format version. + + + + an architecture string. - - + line="1603">an #AsMetadata instance. + + - + Sets the current metadata parsing mode. - + line="1500">Gets the current active locale for parsing metadata, +or "ALL" if all locales are read. + - + Locale used for metadata parsing. + a #AsMetadata instance. + line="1502">a #AsMetadata instance. - + + + + + + The media URL prefix. + + + + the #AsFormatStyle. - - + line="1562">an #AsMetadata instance. + + - - Set the current AppStream format version that we should generate data for -or be able to read. + - + The origin of AppStream distro metadata + a #AsMetadata instance. + line="1533">an #AsMetadata instance. - - the AppStream metadata format version as #AsFormatVersion. - - - + Sets the locale which should be read when processing metadata. -All other locales are ignored, which increases parsing speed and -reduces memory usage. -If you set the locale to "ALL", all locales will be read. - + line="1721">Get the metadata parse flags. + - + a #AsMetadata instance. + line="1723">a #AsMetadata instance. - - the BCP47 locale. - - - + Set the base URL for all media links referenced in the metadata, -or %NULL if every component has absolute URLs. - - - + line="932">Gets the recently parsed #AsReleaseList entry. + + + An #AsReleaseList or %NULL + an #AsMetadata instance. + line="934">a #AsMetadata instance. - + + + + + + A #GPtrArray of all parsed release metadata. + + + + + + the base URL. - - + line="952">a #AsMetadata instance. + + - - Set the origin of AppStream distro metadata - + + - + Whether existing components should be updates with the parsed data, + instead of creating new ones. + an #AsMetadata instance. + line="1648">an #AsMetadata instance. - + + + + + + Whether we will write a header/root node in catalog metadata. + + + + the origin of AppStream distro metadata. - - + line="1683">an #AsMetadata instance. + + - + Sets the current metadata parse flags. - + line="600">Parses any AppStream metadata into one or more #AsComponent instances. + - + %TRUE on success. + a #AsMetadata instance. + line="602">An instance of #AsMetadata. - + the #AsParseFlags. - + line="603">Metadata describing one or more software components. + + + + The format of the data (XML or YAML). + - + If set to %TRUE, the parser will not create new components but -instead update existing components in the pool with new metadata. - -NOTE: Right now, this feature is only implemented for metainfo XML parsing! - + line="578">Parses any AppStream metadata into one or more #AsComponent instances. + - + %TRUE on success. + an #AsMetadata instance. + line="580">An instance of #AsMetadata. - + A boolean value. - + line="581">Metadata describing one or more software components as string. + + + + Length of @data, or -1 if length is unknown and @data is NULL-terminated. + + + + The format of the data (XML or YAML). + - + If set to %TRUE, tehe metadata writer will omit writing a DEP-11 -header document when in YAML mode, and will not write a root components node -when writing XML data. -Please keep in mind that this will create an invalid DEP-11 YAML AppStream -catalog metadata file, and an invalid XML file. -This parameter should only be changed e.g. by the appstream-generator tool. + line="621">Parses XDG Desktop Entry metadata and adds it to the list of parsed entities. -NOTE: Right now, this feature is only implemented for YAML! - +Please note that not every desktop-entry file will result in a valid component +being generated, even if parsing succeeds without error (The desktiop-entry file +may be valid but not generate a component on purpose). + - + %TRUE if the file was parsed without error. + an #AsMetadata instance. + line="623">An instance of #AsMetadata. - + A boolean value. - + line="624">The component-id the new #AsComponent should have. + + + + Metadata describing one or more software components. + + + + The data length, or -1 if unknown and null-terminated. + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A metadata processing error. - - Generic failure. - - - Unable to parse the metadata file. - - - Expected catalog metadata but got metainfo metadata, or vice versa. - - - We expected a component in the pool, but couldn't find one. - - + A essential value is missing in the source document. - - + filename="src/as-metadata.c" + line="686">Parses an AppStream upstream metadata file. + +If @file does not exist, %G_IO_ERROR_NOT_FOUND will be returned. Other +#GIOErrors and #AsMetadataErrors may be returned as appropriate. + An error quark. - - - - - - The flags used when installing and removing metadata files. - - Installed by the vendor, shared - - - Installed as metadata into /var/lib, shared - - - Installed as metadata into /var/cache, shared - - - Installed for the current user - - - - Influence certain aspects of how AppStream metadata is parsed. - - No flags. - - - Do not process the media_baseurl document property. - - - - - - Creates a new #AsPool. - - - a #AsPool - - - - - - - + line="698">%TRUE if the file was parsed without error. + - - + + A valid #AsMetadata instance + + + #GFile for the upstream metadata + + + + The format the data is in, or %AS_FORMAT_KIND_UNKNOWN if not known. + + - - + Register a set of components with the pool temporarily. -Data from components added like this will not be cached. - + filename="src/as-metadata.c" + line="806">Parses any AppStream release metadata into #AsRelease objects. +You can retrieve the last parsed #AsReleaseList using %as_metadata_get_release_list. + %TRUE if the new components were successfully added to the pool. + filename="src/as-metadata.c" + line="815">%TRUE on success. - + An instance of #AsPool - + filename="src/as-metadata.c" + line="808">An instance of #AsMetadata. + - + Array of components to add to the pool. - - - + filename="src/as-metadata.c" + line="809">Metadata describing release notes. + - + Add an additional non-standard location to the metadata pool where metadata will be read from. -If @directory contains a "xml", "xmls", "yaml" or "icons" subdirectory (or all of them), -those paths will be added to the search paths instead. - + filename="src/as-metadata.c" + line="857">Parses any AppStream release metadata into #AsRelease objects +using the provided file. +You can retrieve the last parsed #AsReleaseList using %as_metadata_get_release_list. + - + %TRUE on success. + - + An instance of #AsPool. - + filename="src/as-metadata.c" + line="859">A valid #AsMetadata instance + - + An existing filesystem location. - + filename="src/as-metadata.c" + line="860">#GFile for the release metadata + - + + + + Convert a releases of an #AsReleaseList entity into a release metadata XML representation. + + + The XML representation or %NULL on error. + + + + The expected format style of the metadata, e.g. %AS_FORMAT_STYLE_CATALOG - + filename="src/as-metadata.c" + line="904">A valid #AsMetadata instance + + + + the #AsReleaseList to convert. + - + Convenience function to add one or multiple #AsPoolFlags to -the flag set of this data pool. - + filename="src/as-metadata.c" + line="1102">Serialize all #AsComponent instances to XML or YAML metadata and save +the data to a file. +An existing file at the same location will be overridden. + - + %TRUE if the file was written without error. + - + An instance of #AsPool. - + filename="src/as-metadata.c" + line="1104">An instance of #AsMetadata. + - + The #AsPoolFlags to add. - + filename="src/as-metadata.c" + line="1105">The filename for the new metadata file. + + + + - + Splits up a string into an array of tokens that are suitable for searching. -This includes stripping whitespaces, casefolding the terms and removing greylist words. - -This function is usually called automatically when needed, you will only need to -run it explicitly when you need to check which search tokens the pool will actually -use internally for a given phrase. - - + filename="src/as-metadata.c" + line="1075">Serialize #AsComponent instance to XML and save it to file. +An existing file at the same location will be overridden. + + (array zero-terminated=1): Valid tokens to search for, or %NULL for error - - - + filename="src/as-metadata.c" + line="1083">%TRUE if the file was written without error. + - - An instance of #AsPool. - + + - + the (user-provided) search phrase. + filename="src/as-metadata.c" + line="1077">The filename for the new metadata file. + + The format to save this file in. Only XML is supported at time. + + - + Remove all metadata from the pool, data will be reloaded -once %as_pool_load is called again. - + filename="src/as-metadata.c" + line="1573">Set the architecture the components in this metadata belong to. + - + An #AsPool. - + filename="src/as-metadata.c" + line="1575">an #AsMetadata instance. + + + an architecture string. + + - + Get a list of found components. - - - an array of #AsComponent instances. - - - + filename="src/as-metadata.c" + line="1707">Sets the current metadata parsing mode. + + + - + An instance of #AsPool. - + filename="src/as-metadata.c" + line="1709">a #AsMetadata instance. + + + the #AsFormatStyle. + + - + Find components that are provided by a bundle with a specific ID by its prefix. -For example, given a AS_BUNDLE_KIND_FLATPAK and a bundle_id "org.kde.dolphin/", -it will list all the components that bundle dolphin. If the bundle_id is -"org.kde.dolphin/x86_64" it will give those with also the architecture. - - - - - + filename="src/as-metadata.c" + line="1614">Set the current AppStream format version that we should generate data for +or be able to read. + + + - + An instance of #AsPool. - + filename="src/as-metadata.c" + line="1616">a #AsMetadata instance. + - - The kind of the bundle we are looking for - - - - The bundle ID to match, as specified in #AsBundle - - - + %TRUE to match the ID by prefix, %FALSE to perform an absolute match. - + filename="src/as-metadata.c" + line="1617">the AppStream metadata format version as #AsFormatVersion. + - + Find components that are provided by a bundle with a specific ID by its prefix. -For example, given a AS_BUNDLE_KIND_FLATPAK and a bundle_id "org.kde.dolphin/", -it will list all the components that bundle dolphin. If the bundle_id is -"org.kde.dolphin/x86_64" it will give those with also the architecture. - -This function fully transfers ownership of the returned container, -to be used in GIR bindings. - - - an array of #AsComponent objects. - - - + filename="src/as-metadata.c" + line="1481">Sets the locale which should be read when processing metadata. +All other locales are ignored, which increases parsing speed and +reduces memory usage. +If you set the locale to "ALL", all locales will be read. + + + - + An instance of #AsPool. - + filename="src/as-metadata.c" + line="1483">a #AsMetadata instance. + - - The kind of the bundle we are looking for - - - + The bundle ID to match, as specified in #AsBundle + filename="src/as-metadata.c" + line="1484">the BCP47 locale. - - %TRUE to match the ID by prefix, %FALSE to perform an absolute match. - - - + Return a list of components which are in all of the categories. - - - an array of #AsComponent objects which have been found. - - - + filename="src/as-metadata.c" + line="1544">Set the base URL for all media links referenced in the metadata, +or %NULL if every component has absolute URLs. + + + - + An instance of #AsDatabase. - + filename="src/as-metadata.c" + line="1546">an #AsMetadata instance. + - + An array of XDG categories to include. - - - + filename="src/as-metadata.c" + line="1547">the base URL. + - + Return a list of components which are in one of the categories. - -This function fully transfers ownership of the returned container, -to be used in GIR bindings. - - - an array of #AsComponent objects which have been found. - - - - - - - An instance of #AsDatabase. - - - - An array of XDG categories to include. - - - - - - - - Find components extending the component with the given ID. They can then be registered to the -#AsComponent they extend via %as_component_add_addon. -If the %AS_POOL_FLAG_RESOLVE_ADDONS pool flag is set, addons are automatically resolved and -this explicit function is not needed, but overall query time will be increased (so only use -this flag if you will be resolving addon information later anyway). - - - an array of #AsComponent objects. - - - + filename="src/as-metadata.c" + line="1516">Set the origin of AppStream distro metadata + + + - + An instance of #AsPool. - + filename="src/as-metadata.c" + line="1518">an #AsMetadata instance. + - + The ID of the component to search extensions for. + filename="src/as-metadata.c" + line="1519">the origin of AppStream distro metadata. - + Find components extending the component with the given ID. They can then be registered to the -#AsComponent they extend via %as_component_add_addon. -If the %AS_POOL_FLAG_RESOLVE_ADDONS pool flag is set, addons are automatically resolved and -this explicit function is not needed, but overall query time will be increased (so only use -this flag if you will be resolving addon information later anyway). - -This function fully transfers ownership of the returned container, -to be used in GIR bindings. - - - an array of #AsComponent objects. - - - + filename="src/as-metadata.c" + line="1734">Sets the current metadata parse flags. + + + - + An instance of #AsPool. - + filename="src/as-metadata.c" + line="1736">a #AsMetadata instance. + - + The ID of the component to search extensions for. - + filename="src/as-metadata.c" + line="1737">the #AsParseFlags. + - + Get a specific component by its ID. -This function may contain multiple results if we have -data describing this component from multiple scopes/origin types. - - - An #AsComponent - - - + filename="src/as-metadata.c" + line="1629">If set to %TRUE, the parser will not create new components but +instead update existing components in the pool with new metadata. + +NOTE: Right now, this feature is only implemented for metainfo XML parsing! + + + - + An instance of #AsPool. - + filename="src/as-metadata.c" + line="1631">an #AsMetadata instance. + - + The AppStream-ID to look for. - + filename="src/as-metadata.c" + line="1632">A boolean value. + - + Get a specific component by its ID. -This function may contain multiple results if we have -data describing this component from multiple scopes/origin types. + filename="src/as-metadata.c" + line="1660">If set to %TRUE, tehe metadata writer will omit writing a DEP-11 +header document when in YAML mode, and will not write a root components node +when writing XML data. +Please keep in mind that this will create an invalid DEP-11 YAML AppStream +catalog metadata file, and an invalid XML file. +This parameter should only be changed e.g. by the appstream-generator tool. -This function fully transfers ownership of the returned container, -to be used in GIR bindings. - - - An #AsComponent - - - +NOTE: Right now, this feature is only implemented for YAML! + + + - + An instance of #AsPool. - + filename="src/as-metadata.c" + line="1662">an #AsMetadata instance. + - + The AppStream-ID to look for. - + filename="src/as-metadata.c" + line="1663">A boolean value. + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A metadata processing error. + Return a list of all components in the pool which are of a certain kind. - - - an array of #AsComponent objects which have been found. - - - - - - - An instance of #AsDatabase. - - - - An #AsComponentKind. - - - - - + filename="src/as-metadata.h" + line="65">Generic failure. + + Return a list of all components in the pool which are of a certain kind. - -This function fully transfers ownership of the returned container, -to be used in GIR bindings. - + filename="src/as-metadata.h" + line="66">Unable to parse the metadata file. + + + Expected catalog metadata but got metainfo metadata, or vice versa. + + + We expected a component in the pool, but couldn't find one. + + + A essential value is missing in the source document. + + + + An error quark. + + + + + + The flags used when installing and removing metadata files. + + An unknown/invalid location. + + + Installed by the vendor, shared + + + Installed as metadata into /var/lib, shared + + + Installed as metadata into /var/cache, shared + + + Installed for the current user + + + + Influence certain aspects of how AppStream metadata is parsed. + + No flags. + + + Do not process the media_baseurl document property. + + + + + + Creates a new #AsPool. + an array of #AsComponent objects which have been found. - - - + line="2679">a #AsPool + + + + + + + - An instance of #AsDatabase. - - An #AsComponentKind. - - - - + + Find components in the AppStream data pool which provide a specific launchable. -See #AsLaunchable for details on launchables, or refer to the AppStream specification. - - + line="967">Register a set of components with the pool temporarily. +Data from components added like this will not be cached. + + an array of #AsComponent objects which have been found. - - - + line="976">%TRUE if the new components were successfully added to the pool. + An instance of #AsPool. + line="969">An instance of #AsPool - - An #AsLaunchableKind - - - + The ID of the launchable. - + line="970">Components to add to the pool. + - + Find components in the AppStream data pool which provide a specific launchable. -See #AsLaunchable for details on launchables, or refer to the AppStream specification. - -This function fully transfers ownership of the returned container, -to be used in GIR bindings. - - - an array of #AsComponent objects which have been found. - - - + line="2338">Add an additional non-standard location to the metadata pool where metadata will be read from. +If @directory contains a "xml", "xmls", "yaml" or "icons" subdirectory (or all of them), +those paths will be added to the search paths instead. + + + An instance of #AsPool. + line="2340">An instance of #AsPool. - + An #AsLaunchableKind - + line="2341">An existing filesystem location. + - + The ID of the launchable. - + line="2342">The expected format style of the metadata, e.g. %AS_FORMAT_STYLE_CATALOG + - + Find components in the AppStream data pool which provide a certain item. - - - an array of #AsComponent objects which have been found. - - - + line="2546">Convenience function to add one or multiple #AsPoolFlags to +the flag set of this data pool. + + + An instance of #AsPool. + line="2548">An instance of #AsPool. - - An #AsProvidesKind - - - + The value of the provided item. - + line="2549">The #AsPoolFlags to add. + - + Find components in the AppStream data pool which provide a certain item. + line="2110">Splits up a string into an array of tokens that are suitable for searching. +This includes stripping whitespaces, casefolding the terms and removing greylist words. -This function fully transfers ownership of the returned container, -to be used in GIR bindings. - +This function is usually called automatically when needed, you will only need to +run it explicitly when you need to check which search tokens the pool will actually +use internally for a given phrase. + an array of #AsComponent objects which have been found. - - + line="2122">(array zero-terminated=1): Valid tokens to search for, or %NULL for error + + An instance of #AsPool. + line="2112">An instance of #AsPool. - - An #AsProvidesKind - - - + The value of the provided item. + line="2113">the (user-provided) search phrase. - + Get a list of found components. - -This function fully transfers ownership of the returned container, -to be used in GIR bindings. - - - an array of #AsComponent instances. - - - + line="989">Remove all metadata from the pool, data will be reloaded +once %as_pool_load is called again. + + + An instance of #AsPool. + line="991">An #AsPool. - + Get the #AsPoolFlags for this data pool. - - - + line="1837">Get a list of found components. + + + an #AsComponentBox. + An instance of #AsPool. + line="1839">An instance of #AsPool. - + Gets the currently used locale. - - + line="2049">Find components that are provided by a bundle with a specific ID by its prefix. +For example, given a AS_BUNDLE_KIND_FLATPAK and a bundle_id "org.kde.dolphin/", +it will list all the components that bundle dolphin. If the bundle_id is +"org.kde.dolphin/x86_64" it will give those with also the architecture. + + Locale used for metadata parsing. - + line="2061">an #AsComponentBox. + An instance of #AsPool. + line="2051">An instance of #AsPool. - - - + + The kind of the bundle we are looking for + + + + The bundle ID to match, as specified in #AsBundle + + + + %TRUE to match the ID by prefix, %FALSE to perform an absolute match. + + + + + Check if this pool contains any data. - + line="1950">Return a list of components which are in all of the categories. + + + an #AsComponentBox of found components. + + + + + An instance of #AsDatabase. + + + + An array of XDG categories to include. + + + + + + + + Find components extending the component with the given ID. They can then be registered to the +#AsComponent they extend via %as_component_add_addon. +If the %AS_POOL_FLAG_RESOLVE_ADDONS pool flag is set, addons are automatically resolved and +this explicit function is not needed, but overall query time will be increased (so only use +this flag if you will be resolving addon information later anyway). + + + an #AsComponentBox. + + + + + An instance of #AsPool. + + + + The ID of the component to search extensions for. + + + + + + Get a specific component by its ID. +This function may contain multiple results if we have +data describing this component from multiple scopes/origin types. + + + an #AsComponentBox. + + + + + An instance of #AsPool. + + + + The AppStream-ID to look for. + + + + + + Return a list of all components in the pool which are of a certain kind. + + + an #AsComponentBox of found components. + + + + + An instance of #AsDatabase. + + + + An #AsComponentKind. + + + + + + Find components in the AppStream data pool which provide a specific launchable. +See #AsLaunchable for details on launchables, or refer to the AppStream specification. + + + an #AsComponentBox of found components. + + + + + An instance of #AsPool. + + + + An #AsLaunchableKind + + + + The ID of the launchable. + + + + + + Find components in the AppStream data pool which provide a certain item. + + + an #AsComponentBox of found components. + + + + + An instance of #AsPool. + + + + An #AsProvidesKind + + + + The value of the provided item. + + + + + + Get the #AsPoolFlags for this data pool. + + + + + + + An instance of #AsPool. + + + + + + Gets the currently used locale. + + + Locale used for metadata parsing. + + + + + An instance of #AsPool. + + + + + + Check if this pool contains any data. + %TRUE if the pool is empty. + line="1012">%TRUE if the pool is empty. An instance of #AsPool. + line="1008">An instance of #AsPool. @@ -11977,7 +12429,7 @@ to be used in GIR bindings. Builds an index of all found components in the watched locations. + line="1665">Builds an index of all found components in the watched locations. The function will try to get as much data into the pool as possible, so even if the update completes with %FALSE, it might still have added components to the pool. @@ -11987,14 +12439,14 @@ are up to date. %TRUE if update completed without error. + line="1678">%TRUE if update completed without error. An instance of #AsPool. + line="1667">An instance of #AsPool. allow-none="1"> a #GCancellable. + line="1668">a #GCancellable. @@ -12013,9 +12465,9 @@ are up to date. version="0.12.10"> Asynchronously loads data from all registered locations. + line="1711">Asynchronously loads data from all registered locations. Equivalent to as_pool_load() (but asynchronous) - + @@ -12023,7 +12475,7 @@ Equivalent to as_pool_load() (but asynchronous) An instance of #AsPool. + line="1713">An instance of #AsPool. allow-none="1"> a #GCancellable. + line="1714">a #GCancellable. closure="2"> A #GAsyncReadyCallback + line="1715">A #GAsyncReadyCallback allow-none="1"> Data to pass to @callback + line="1716">Data to pass to @callback @@ -12063,25 +12515,25 @@ Equivalent to as_pool_load() (but asynchronous) throws="1"> Retrieve the result of as_pool_load_async(). - + line="1733">Retrieve the result of as_pool_load_async(). + %TRUE for success + line="1741">%TRUE for success An instance of #AsPool. + line="1735">An instance of #AsPool. A #GAsyncResult + line="1736">A #GAsyncResult @@ -12091,9 +12543,9 @@ Equivalent to as_pool_load() (but asynchronous) version="0.15.0"> Convenience function to remove one or multiple #AsPoolFlags from + line="2567">Convenience function to remove one or multiple #AsPoolFlags from the flag set of this data pool. - + @@ -12101,13 +12553,13 @@ the flag set of this data pool. An instance of #AsPool. + line="2569">An instance of #AsPool. The #AsPoolFlags to remove. + line="2570">The #AsPoolFlags to remove. @@ -12117,8 +12569,8 @@ the flag set of this data pool. version="0.15.0"> Remove all explicitly added metadata locations. - + line="2370">Remove all explicitly added metadata locations. + @@ -12126,75 +12578,34 @@ the flag set of this data pool. An instance of #AsPool. + line="2372">An instance of #AsPool. - + Search for a list of components matching the search term. + line="2191">Search for a list of components matching the search term. The list will be ordered by match score. - - - an array of the found #AsComponent objects. - - - - - - - An instance of #AsPool - - - - A search string - - - - - - Search for a list of components matching the search term. -The list will be ordered by match score. - -This function fully transfers ownership of the returned container, -to be used in GIR bindings. - - + + an array of the found #AsComponent objects. - - - + line="2199">an #AsComponentBox of the found components. + An instance of #AsPool + line="2193">An instance of #AsPool A search string + line="2194">A search string @@ -12202,8 +12613,8 @@ to be used in GIR bindings. Set the #AsPoolFlags for this data pool. - + line="2528">Set the #AsPoolFlags for this data pool. + @@ -12211,13 +12622,13 @@ to be used in GIR bindings. An instance of #AsPool. + line="2530">An instance of #AsPool. The new #AsPoolFlags. + line="2531">The new #AsPoolFlags. @@ -12227,13 +12638,13 @@ to be used in GIR bindings. version="0.15.0"> This is a convenience function that enables or disables loading of metadata + line="2588">This is a convenience function that enables or disables loading of metadata from well-known standard locations by configuring the #AsPoolFlags of this #AsPool accordingly. Data affected by this includes the OS data catalog, metainfo, desktop-entry files and Flatpak data. If you need more fine-grained control, set the #AsPoolFlags explicitly. - + @@ -12241,13 +12652,13 @@ If you need more fine-grained control, set the #AsPoolFlags explicitly. An instance of #AsPool. + line="2590">An instance of #AsPool. Whether loading of data from standard locations should be enabled. + line="2591">Whether loading of data from standard locations should be enabled. @@ -12255,8 +12666,8 @@ If you need more fine-grained control, set the #AsPoolFlags explicitly. Sets the current locale which should be used when parsing metadata. - + line="2302">Sets the current locale which should be used when parsing metadata. + @@ -12264,13 +12675,13 @@ If you need more fine-grained control, set the #AsPoolFlags explicitly. An instance of #AsPool. + line="2304">An instance of #AsPool. the BCP47 or POSIX locale to use for this pool. + line="2305">the BCP47 or POSIX locale to use for this pool. @@ -12281,7 +12692,7 @@ If you need more fine-grained control, set the #AsPoolFlags explicitly. The ::changed signal is emitted when components have been added + line="425">The ::changed signal is emitted when components have been added or removed from the metadata pool. @@ -12291,13 +12702,13 @@ or removed from the metadata pool. - + - + @@ -12310,7 +12721,7 @@ or removed from the metadata pool. - + @@ -12318,7 +12729,7 @@ or removed from the metadata pool. - + @@ -12326,7 +12737,7 @@ or removed from the metadata pool. - + @@ -12334,7 +12745,7 @@ or removed from the metadata pool. - + @@ -12342,7 +12753,7 @@ or removed from the metadata pool. - + @@ -12356,7 +12767,7 @@ or removed from the metadata pool. glib:error-domain="AsPool"> A metadata pool error. + line="95">A metadata pool error. glib:name="AS_POOL_ERROR_FAILED"> Generic failure - - - We do not have write-access to the cache target location. + line="97">Generic failure @@ -12385,7 +12787,7 @@ or removed from the metadata pool. line="98">The pool was loaded, but we had to ignore some metadata. @@ -12393,20 +12795,29 @@ or removed from the metadata pool. filename="src/as-pool.h" line="99">An AppStream-ID collision occured (a component with that ID already existed in the pool) - + Unable to write to *any* cache file (not even tmpfs writes worked) + + + c:identifier="AS_POOL_ERROR_CACHE_DAMAGED" + glib:nick="cache-damaged" + glib:name="AS_POOL_ERROR_CACHE_DAMAGED"> Some issue with an old on-disk cache occured. + line="101">The disk cache was broken and we could not automatically recover. An error quark. + line="2663">An error quark. @@ -12417,7 +12828,7 @@ or removed from the metadata pool. c:type="AsPoolFlags"> Flags controlling the metadata pool behavior. + line="51">Flags controlling the metadata pool behavior. glib:name="AS_POOL_FLAG_NONE"> No flags. + line="53">No flags. glib:name="AS_POOL_FLAG_LOAD_OS_CATALOG"> Load AppStream catalog metadata from OS locations. + line="54">Load AppStream catalog metadata from OS locations. glib:name="AS_POOL_FLAG_LOAD_OS_METAINFO"> Load MetaInfo data from OS locations. + line="55">Load MetaInfo data from OS locations. glib:name="AS_POOL_FLAG_LOAD_OS_DESKTOP_FILES"> Load components from desktop-entry files in OS locations. + line="56">Load components from desktop-entry files in OS locations. glib:name="AS_POOL_FLAG_LOAD_FLATPAK"> Load AppStream catalog metadata from Flatpak. + line="57">Load AppStream catalog metadata from Flatpak. glib:name="AS_POOL_FLAG_IGNORE_CACHE_AGE"> Load fresh data even if an up-o-date cache is available. + line="58">Load fresh data even if an up-o-date cache is available. glib:name="AS_POOL_FLAG_RESOLVE_ADDONS"> Always resolve addons for returned components. + line="59">Always resolve addons for returned components. glib:name="AS_POOL_FLAG_PREFER_OS_METAINFO"> Prefer local metainfo data over the system-provided catalog data. Useful for debugging. + line="60">Prefer local metainfo data over the system-provided catalog data. Useful for previewing local data. glib:name="AS_POOL_FLAG_MONITOR"> Monitor registered directories for changes, and auto-reload metadata if necessary. + line="61">Monitor registered directories for changes, and auto-reload metadata if necessary. glib:type-name="AsProvided" glib:get-type="as_provided_get_type" glib:type-struct="ProvidedClass"> - + Creates a new #AsProvided. - + line="286">Creates a new #AsProvided. + a #AsProvided + line="291">a #AsProvided Add a new provided item. - + line="273">Add a new provided item. + - + + a #AsProvided instance. + + + + + + + + + Get an array of provided data. + + + An string list of provided items. + + + + + + + a #AsProvided instance. + + + + + + The kind of items this #AsProvided object stores. + + + an enum of type #AsProvidedKind + + + + + a #AsProvided instance. + + + + + + Check if the current #AsProvided contains an item +of the given name. + + + %TRUE if found. + + + + + a #AsProvided instance. + + + + the name of a provided item, e.g. "audio/x-vorbis" (in case the provided kind is a mimetype) + + + + + + Set the kind of items this #AsProvided object stores. + + + + + + + a #AsProvided instance. + + + + the new #AsProvidedKind + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Type of the public interface components can provide. + + Unknown kind + + + A shared library + + + A binary installed into a directory in PATH + + + Provides a handler for a mimetype + + + A font + + + A modalias + + + A Python 3 module + + + A DBus service name on the system bus. + + + A DBus service name on the user/session bus. + + + Firmware flashed at runtime. + + + Firmware flashed permanently to the device. + + + An AppStream component + + + Converts the text representation to an enumerated value. + + + a #AsProvidedKind or %AS_PROVIDED_KIND_UNKNOWN for unknown + + + + + the string. + + + + + + Converts the enumerated value to a localized text representation, +using the plural forms (e.g. "Libraries" instead of "Library"). + +This can be useful when displaying provided items in GUI dialogs. + + + Pluralized, l10n string version of @kind + + + + + the #AsProvidedKind. + + + + + + Converts the enumerated value to a text representation. + + + string version of @kind + + + + + the #AsProvidedKind. + + + + + + + + + + + + + + + + Creates a new #AsReference. + + + a #AsReference + + + + + Gets the reference kind. + + + the #AsReferenceKind + + + + + an #AsReference instance. + + + + + + Gets the name of the registry this reference is for, +if the reference is of type %AS_REFERENCE_KIND_REGISTRY. +Otherwise return %NULL. + + + the registry name. + + + + + an #AsReference instance. + + + + + + Gets the value of this reference, e.g. a DOI if the +reference kind is %AS_REFERENCE_KIND_DOI or an URL +for %AS_REFERENCE_KIND_CITATION_CFF. + + + the value of this reference. + + + + + an #AsReference instance. + + + + + + Sets the reference kind. + + + + + + + an #AsReference instance. + + + + the #AsReferenceKind, e.g. %AS_REFERENCE_KIND_DOI. + + + + + + Sets a name of a registry if this reference is of +type %AS_REFERENCE_KIND_REGISTRY. + + + + + + + an #AsReference instance. + + + + name of an external registry. + + + + + + Sets a value for this reference. + + + + + + + an #AsReference instance. + + + + a value for this reference, e.g. "10.1000/182" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A reference type. + + Unknown reference kind. + + + Digital Object Identifier + + + Web URL to a Citation File Format file + + + A generic registry. + + + Converts the text representation to an enumerated value. + + + a AsReferenceKind or %AS_REFERENCE_KIND_UNKNOWN for unknown + + + + + the string. + + + + + + Converts the enumerated value to an text representation. + + + string version of @kind + + + + + the %AsReferenceKind. + + + + + + + + + Creates a new #AsRelation. + + + a #AsRelation + + + + + Calculate a compatibility sore between 0 and 100 based on the given set of +AsRelationCheckResults. + +A compatibility of 100 means all requirements are satisfied and the component will +run perfectly on the confoguration it was tested agains, while 0 means it will not run at all. + + + + + + + an array of #AsRelationCheckResult + + + + + + + + The version comparison type. + + + an enum of type #AsRelationCompare + + + + + a #AsRelation instance. + + + + + + Gets the display side kind, in case this item is of +kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH + + + a #AsDisplaySideKind or %AS_DISPLAY_SIDE_KIND_UNKNOWN + + + + + an #AsRelation instance. + + + + + + The kind of the item of this #AsRelation. + + + an enum of type #AsRelationItemKind + + + + + a #AsRelation instance. + + + + + + The type (and thereby strength) of this #AsRelation. + + + an enum of type #AsRelationKind + + + + + a #AsRelation instance. + + + + + + Get the value of this #AsRelation item as #AsControlKind if the +type of this relation is %AS_RELATION_ITEM_KIND_CONTROL. +Otherwise return %AS_CONTROL_KIND_UNKNOWN + + + a #AsControlKind or %AS_CONTROL_KIND_UNKNOWN in case the item is not of the right kind. + + + + + an #AsRelation instance. + + + + + + + + The value of this #AsRelation item as an integer. Returns 0 if the value was no integer. + + + + + an #AsRelation instance. + + + + + + If this #AsRelation is of kind %AS_RELATION_ITEM_KIND_INTERNET, return the +minimum bandwidth requirement of the component, if set. + +If the relation is of a different kind, or the requirement isn’t set, this +returns `0`. + + + The minimum bandwidth requirement, in Mbit/s. + + + + + an #AsRelation instance. + + + + + + Get the value of this #AsRelation item as #AsInternetKind if the +type of this relation is %AS_RELATION_ITEM_KIND_INTERNET. +Otherwise return %AS_INTERNET_KIND_UNKNOWN + + + a #AsInternetKind or %AS_INTERNET_KIND_UNKNOWN in case the item is not of the right kind. + + + + + an #AsRelation instance. + + + + + + In case this #AsRelation is of kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH, +return the set logical pixel amount. + + + The logical pixel amount for this display length, value <= 0 on error. + + + + + an #AsRelation instance. + + + + + + + + The value of the item this #AsRelation is about, as a string. + + + + a #AsProvided instance. - + filename="src/as-relation.c" + line="653">an #AsRelation instance. + - - - - - Get an array of provided data. - + + An string list of provided items. - - - + filename="src/as-relation.c" + line="589">The version of the item this #AsRelation is about. + - + a #AsProvided instance. - + filename="src/as-relation.c" + line="587">an #AsRelation instance. + - + The kind of items this #AsProvided object stores. - - + filename="src/as-relation.c" + line="1455">Test if this relation is satisfied on the current system or with the +provided #AsPool. If no #AsSystemInfo is found, a temporary one will be +created. If no #AsPool is provided, any component relationships can not +be validated and an error will be thrown. + + an enum of type #AsProvidedKind - + filename="src/as-relation.c" + line="1467">an #AsRelationCheckResult with details about the result, or %NULL on error. + - + a #AsProvided instance. - + filename="src/as-relation.c" + line="1457">a #AsRelation instance. + + + an #AsSystemInfo to use for system information. + + + + an #AsPool to find component dependencies in. + + - + Check if the current #AsProvided contains an item -of the given name. - + filename="src/as-relation.c" + line="569">Set the version comparison type of this #AsRelation. + - %TRUE if found. - + - + a #AsProvided instance. - + filename="src/as-relation.c" + line="571">an #AsRelation instance. + - + the name of a provided item, e.g. "audio/x-vorbis" (in case the provided kind is a mimetype) - + filename="src/as-relation.c" + line="572">the new #AsRelationCompare + - + Set the kind of items this #AsProvided object stores. - + filename="src/as-relation.c" + line="912">Sets the display side kind, in case this item is of +kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH + - + a #AsProvided instance. - + filename="src/as-relation.c" + line="914">an #AsRelation instance. + the new #AsProvidedKind - + filename="src/as-relation.c" + line="915">the new #AsDisplaySideKind. + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Type of the public interface components can provide. - - Unknown kind - - - A shared library - - - A binary installed into a directory in PATH - - - Provides a handler for a mimetype - - - A font - - - A modalias - - - A Python2 module - - + A Python3 module - - + filename="src/as-relation.c" + line="536">Set the kind of the item this #AsRelation is about. + + + + + + + a #AsRelation instance. + + + + the new #AsRelationItemKind + + + + + A DBus service name on the system bus. - - + filename="src/as-relation.c" + line="503">Set the kind of this #AsRelation. + + + + + + + a #AsRelation instance. + + + + the new #AsRelationKind + + + + + A DBus service name on the user/session bus. - - + filename="src/as-relation.c" + line="751">Set relation item value from an #AsControlKind. + + + + + + + an #AsRelation instance. + + + + an #AsControlKind + + + + + Firmware flashed at runtime. - - + filename="src/as-relation.c" + line="708">Sets the item value as an integer, if the given item type +of this #AsRelation permits integer values. + + + + + + + an #AsRelation instance. + + + + the new value. + + + + + + + + + + + + + + + + + + + Firmware flashed permanently to the device. - - + filename="src/as-relation.c" + line="789">Set relation item value from an #AsInternetKind. + + + + + + + an #AsRelation instance. + + + + an #AsInternetKind + + + + + An AppStream component - - + filename="src/as-relation.c" + line="875">Sets the item value as logical pixel count. This requires the relation +to be of item kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH. + + + + + + + an #AsRelation instance. + + + + logical pixel count. + + + + + Converts the text representation to an enumerated value. - + filename="src/as-relation.c" + line="668">Sets the item value as a string, if the given item type +of this #AsRelation permits string values. + - a #AsProvidedKind or %AS_PROVIDED_KIND_UNKNOWN for unknown - + - + the string. + filename="src/as-relation.c" + line="670">an #AsRelation instance. + + + + the new value. - - + + Converts the enumerated value to a localized text representation, -using the plural forms (e.g. "Libraries" instead of "Library"). - -This can be useful when displaying provided items in GUI dialogs. - + filename="src/as-relation.c" + line="600">Sets the item version. + - Pluralized, l10n string version of @kind - + - + the #AsProvidedKind. - + filename="src/as-relation.c" + line="602">an #AsRelation instance. + + + + the new version. + - - + + Converts the enumerated value to a text representation. - + filename="src/as-relation.c" + line="929">Tests whether the version number of this #AsRelation is fulfilled by +@version. Whether the given version is sufficient to fulfill the version +requirement of this #AsRelation is determined by its comparison resraint. + string version of @kind - + filename="src/as-relation.c" + line="939">%TRUE if the version from the parameter is sufficient. + - + the #AsProvidedKind. - + filename="src/as-relation.c" + line="931">an #AsRelation instance. + + + + a version number, e.g. `1.2.0` + - - - + + + + + - - + glib:type-name="AsRelationCheckResult" + glib:get-type="as_relation_check_result_get_type" + glib:type-struct="RelationCheckResultClass"> + + Creates a new #AsRelation. - + filename="src/as-relation-check-result.c" + line="76">Creates a new #AsRelationCheckResult. + a #AsRelation - + filename="src/as-relation-check-result.c" + line="81">a #AsRelationCheckResult + - + + Retrieve the error code, in case this result represents an error. + + + an #AsRelationError + + + + + an #AsRelationCheckResult instance. + + + + + The version comparison type. - - + filename="src/as-relation-check-result.c" + line="155">Get a human-readable message about the state of this relation. +May be %NULL in case the relation is satisfied and there is no further information about it. + + an enum of type #AsRelationCompare - + filename="src/as-relation-check-result.c" + line="162">a human-readable message about this relation's state. + - + a #AsRelation instance. - + filename="src/as-relation-check-result.c" + line="157">an #AsRelationCheckResult instance. + - + Gets the display side kind, in case this item is of -kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH - - + filename="src/as-relation-check-result.c" + line="124">Get the relation that this check result was generated for. + + a #AsDisplaySideKind or %AS_DISPLAY_SIDE_KIND_UNKNOWN - + filename="src/as-relation-check-result.c" + line="130">an #AsRelation or %NULL + - + an #AsRelation instance. - + filename="src/as-relation-check-result.c" + line="126">an #AsRelationCheckResult instance. + - + The kind of the item of this #AsRelation. - + filename="src/as-relation-check-result.c" + line="93">Returns the status of this relation check result. +If the status is %AS_RELATION_STATUS_ERROR, an error message will +have been set as message. + an enum of type #AsRelationItemKind - + filename="src/as-relation-check-result.c" + line="101">an #AsRelationStatus + - + a #AsRelation instance. - + filename="src/as-relation-check-result.c" + line="95">an #AsRelationCheckResult instance. + - + The type (and thereby strength) of this #AsRelation. - + filename="src/as-relation-check-result.c" + line="206">Set the error code in case this result represents an error. + - an enum of type #AsRelationKind - + - + a #AsRelation instance. - + filename="src/as-relation-check-result.c" + line="208">an #AsRelationCheckResult instance. + + + the #AsRelationError + + - + Get the value of this #AsRelation item as #AsControlKind if the -type of this relation is %AS_RELATION_ITEM_KIND_CONTROL. -Otherwise return %AS_CONTROL_KIND_UNKNOWN - + filename="src/as-relation-check-result.c" + line="171">Set a human-readable information message about the satisfaction state +of the dependency under the checked system configuration. + - a #AsControlKind or %AS_CONTROL_KIND_UNKNOWN in case the item is not of the right kind. - + - + an #AsRelation instance. - + filename="src/as-relation-check-result.c" + line="173">an #AsRelationCheckResult instance. + + + the new message + + + + + - + In case this #AsRelation is of kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH, -return the #AsDisplayLengthKind. - + filename="src/as-relation-check-result.c" + line="139">Set an #AsRelation to associate with this check result. + - The #AsDisplayLengthKind classification of the current pixel value, or %AS_DISPLAY_LENGTH_KIND_UNKNOWN on error. - + - + an #AsRelation instance. - + filename="src/as-relation-check-result.c" + line="141">an #AsRelationCheckResult instance. + + + the #AsRelation + + - - + + Set the outcome of this relation check result. + - The value of this #AsRelation item as an integer. Returns 0 if the value was no integer. - + - + an #AsRelation instance. - + filename="src/as-relation-check-result.c" + line="112">an #AsRelationCheckResult instance. + + + the new #AsRelationStatus + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The relational comparison type. + + Comparison predicate invalid or not known + + + Equal to + + + Not equal to + + + Less than + + + Greater than + + + Less than or equal to + + If this #AsRelation is of kind %AS_RELATION_ITEM_KIND_INTERNET, return the -minimum bandwidth requirement of the component, if set. - -If the relation is of a different kind, or the requirement isn’t set, this -returns `0`. - - - The minimum bandwidth requirement, in Mbit/s. - - - - - an #AsRelation instance. - - - - - + filename="src/as-relation.h" + line="107">Greater than or equal to + + Get the value of this #AsRelation item as #AsInternetKind if the -type of this relation is %AS_RELATION_ITEM_KIND_INTERNET. -Otherwise return %AS_INTERNET_KIND_UNKNOWN - + line="186">Converts the text representation to an enumerated value. + a #AsInternetKind or %AS_INTERNET_KIND_UNKNOWN in case the item is not of the right kind. - + line="192">a #AsRelationCompare, or %AS_RELATION_COMPARE_UNKNOWN for unknown. + - + an #AsRelation instance. - - + line="188">the string. + + - - + + In case this #AsRelation is of kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH, -return the set logical pixel amount. - - - The logical pixel amount for this display length, value <= 0 on error. - - - - - an #AsRelation instance. - - - - - - + line="233">Converts the enumerated value to an text representation. +The enum is converted into a two-letter identifier ("eq", "ge", etc.) +for use in the XML representation. + The value of the item this #AsRelation is about, as a string. + line="241">string version of @compare - + an #AsRelation instance. - - + line="235">the #AsRelationCompare. + + - - - + + + Converts the enumerated value to an text representation. +The enum is converted into an identifier consisting of two +mathematical comparison operators ("==", ">=", etc.) +for use in the YAML representation and user interfaces. + The version of the item this #AsRelation is about. + line="272">string version of @compare - + an #AsRelation instance. - - + line="265">the #AsRelationCompare. + + - - + + + + The error type. + Test if this relation is satisfied on the current system or with the -provided #AsPool. If no #AsSystemInfo is found, a temporary one will be -created. If no #AsPool is provided, any component relationships can not -be validated and an error will be thrown. - + filename="src/as-relation.h" + line="192">Generic failure + + + A metadata value was bad. + + + Some check was not (yet) implemented. + + %AS_CHECK_RESULT_TRUE if the system satisfies the relation, %AS_CHECK_RESULT_ERROR on error - + line="68">An error quark. + - - - a #AsRelation instance. - - - - an #AsSystemInfo to use for system information. - - - - an #AsPool to find component dependencies in. - - - - receive a localized status message. - - - - - + + + + Type of the item an #AsRelation is for. + + Unknown kind + + + A component ID + + + A hardware modalias + + + An operating system kernel (like Linux) + + + A system RAM requirement + + + A device firmware requirement (used by fwupd) + + + An input method for users to control software + + + Display edge length + + + A Computer Hardware ID (CHID) to depend on system hardware + + + Internet connectivity (Since: 0.15.5) + + Set the version comparison type of this #AsRelation. - + line="152">Converts the text representation to an enumerated value. + - + a #AsRelationItemKind or %AS_RELATION_ITEM_KIND_UNKNOWN for unknown + - - an #AsRelation instance. - - - + the new #AsRelationCompare - + line="154">the string. + - - + + Sets the display side kind, in case this item is of -kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH - + line="118">Converts the enumerated value to a text representation. + - + string version of @kind + - - an #AsRelation instance. - - the new #AsDisplaySideKind. - + line="120">the #AsRelationKind. + - - + + + + Type of a component's relation to other items. + + Unknown kind + + + The referenced item is required by the component + + + The referenced item is recommended + + + The referenced item is supported + + Set the kind of the item this #AsRelation is about. - + line="96">Converts the text representation to an enumerated value. + - + a #AsRelationKind or %AS_RELATION_KIND_UNKNOWN for unknown + - - a #AsRelation instance. - - - + the new #AsRelationItemKind - + line="98">the string. + - - + + Set the kind of this #AsRelation. - + line="74">Converts the enumerated value to a text representation. + - + string version of @kind + - - a #AsRelation instance. - - the new #AsRelationKind + line="76">the #AsRelationKind. - - + + + + Status of a relation check result. + Set relation item value from an #AsControlKind. - + filename="src/as-relation-check-result.h" + line="53">Unknown status. + + + An error occured and the status could not be checked. + + + The relation is not satisfied. + + + The relation is satisfied. + + + + + + Creates a new #AsRelease. + + + a #AsRelease + + + + + Add an artifact (binary / source download) for this release. + - + an #AsRelation instance. - + filename="src/as-release.c" + line="605">An instance of #AsRelease. + - + an #AsControlKind - + filename="src/as-release.c" + line="606">The #AsArtifact. + - + Sets the item value as display length placeholder value. This requires the relation -to be of item kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH. - + filename="src/as-release.c" + line="640">Add information about a (resolved) issue to this release. + - + an #AsRelation instance. - + filename="src/as-release.c" + line="642">An instance of #AsRelease. + - + the #AsDisplayLengthKind - + filename="src/as-release.c" + line="643">The #AsIssue. + - + Sets the item value as an integer, if the given item type -of this #AsRelation permits integer values. - + filename="src/as-release.c" + line="756">Add a tag to this release. + - + %TRUE if the tag was added. + - + an #AsRelation instance. - + filename="src/as-release.c" + line="758">an #AsRelease instance. + - + the new value. - + filename="src/as-release.c" + line="759">The namespace the tag belongs to + + + + The tag name + - - + + Remove all tags associated with this release. + - - + + an #AsRelease instance. + - - - - + Set relation item value from an #AsInternetKind. - + filename="src/as-release.c" + line="585">Get a list of all downloadable artifacts that are associated with +this release. + - + an array of #AsArtifact objects. + + + + + + + + + + + + + + the #AsContext associated with this release. +This function may return %NULL if no context is set. + - + an #AsRelation instance. - + filename="src/as-release.c" + line="706">An instance of #AsRelease. + - - an #AsInternetKind - - - + Sets the item value as logical pixel count. This requires the relation -to be of item kind %AS_RELATION_ITEM_KIND_DISPLAY_LENGTH. - - - + filename="src/as-release.c" + line="374">Gets the release date. + + + The date in ISO8601 format. + - + an #AsRelation instance. - + filename="src/as-release.c" + line="376">a #AsRelease instance. + - - logical pixel count. - - - + Sets the item value as a string, if the given item type -of this #AsRelation permits string values. - - - + filename="src/as-release.c" + line="421">Gets the end-of-life date for this release. + + + The EOL date in ISO8601 format. + - + an #AsRelation instance. - + filename="src/as-release.c" + line="423">a #AsRelease instance. + - - the new value. - - - + Sets the item version. - - - + filename="src/as-release.c" + line="550">Gets the release description markup for a given locale. + + + markup, or %NULL for not set or invalid + - + an #AsRelation instance. - + filename="src/as-release.c" + line="552">a #AsRelease instance. + - - the new version. - - - + Tests whether the version number of this #AsRelation is fulfilled by -@version. Whether the given version is sufficient to fulfill the version -requirement of this #AsRelation is determined by its comparison resraint. - + filename="src/as-release.c" + line="623">Get a list of all issues resolved by this release. + %TRUE if the version from the parameter is sufficient. - + filename="src/as-release.c" + line="628">an array of #AsIssue objects. + + + - - an #AsRelation instance. - + + - - a version number, e.g. `1.2.0` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The relational comparison type. - - Comparison predicate invalid or not known - - - Equal to - - - Not equal to - - - Less than - - - Greater than - - - Less than or equal to - - + Greater than or equal to - - + filename="src/as-release.c" + line="255">Gets the type of the release. +(development or stable release) + + + + + + + a #AsRelease instance. + + + + + Converts the text representation to an enumerated value. - + filename="src/as-release.c" + line="338">Gets the release timestamp. + a #AsRelationCompare, or %AS_RELATION_COMPARE_UNKNOWN for unknown. - + filename="src/as-release.c" + line="344">timestamp, or 0 for unset + - + the string. - - + filename="src/as-release.c" + line="340">a #AsRelease instance. + + - - + + Converts the enumerated value to an text representation. -The enum is converted into a two-letter identifier ("eq", "ge", etc.) -for use in the XML representation. - + filename="src/as-release.c" + line="457">Gets the UNIX timestamp for the date when this +release is out of support (end-of-life). + string version of @compare - + filename="src/as-release.c" + line="464">UNIX timestamp, or 0 for unset or invalid. + - + the #AsRelationCompare. - - + filename="src/as-release.c" + line="459">a #AsRelease instance. + + - - + + Converts the enumerated value to an text representation. -The enum is converted into an identifier consisting of two -mathematical comparison operators ("==", ">=", etc.) -for use in the YAML representation and user interfaces. - + filename="src/as-release.c" + line="514">Gets the urgency of the release +(showing how important it is to update to a more recent release) + string version of @compare + filename="src/as-release.c" + line="521">#AsUrgencyKind, or %AS_URGENCY_KIND_UNKNOWN for not set + + + + + a #AsRelease instance. + + + + + + Gets an URL. + + + string, or %NULL if unset - + the #AsRelationCompare. - + filename="src/as-release.c" + line="662">a #AsRelease instance. + + + + the URL kind, e.g. %AS_RELEASE_URL_KIND_DETAILS. + - - - - The error type. - - Generic failure - - + + A metadata value was bad. - - + filename="src/as-release.c" + line="290">Gets the release version. + + + string, or %NULL for not set or invalid + + + + + a #AsRelease instance. + + + + + Some check was not (yet) implemented. - - + filename="src/as-release.c" + line="817">Test if the release is tagged with the selected tag. + An error quark. - + filename="src/as-release.c" + line="825">%TRUE if tag exists. + - - - - Type of the item an #AsRelation is for. - - Unknown kind - - - A component ID - - - A hardware modalias - - - An operating system kernel (like Linux) - - - A system RAM requirement - - - A device firmware requirement (used by fwupd) - - - An input method for users to control software - - - Display edge length - - - A Computer Hardware ID (CHID) to depend on system hardware - - - Internet connectivity (Since: 0.15.5) - - + + + an #AsRelease instance. + + + + The namespace the tag belongs to + + + + The tag name + + + + + Converts the text representation to an enumerated value. - + filename="src/as-release.c" + line="788">Remove a tag from this release + a #AsRelationItemKind or %AS_RELATION_ITEM_KIND_UNKNOWN for unknown - + filename="src/as-release.c" + line="796">%TRUE if the tag was removed. + - + the string. + filename="src/as-release.c" + line="790">an #AsRelease instance. + + + + The namespace the tag belongs to + + + + The tag name - - + + Converts the enumerated value to a text representation. - + filename="src/as-release.c" + line="722">Sets the document context this release is associated +with. + - string version of @kind - + - + the #AsRelationKind. - + filename="src/as-release.c" + line="724">An instance of #AsRelease. + + + + the #AsContext. + - - - - Type of a component's relation to other items. - - Unknown kind - - - The referenced item is required by the component - - - The referenced item is recommended - - - The referenced item is supported - - + + Converts the text representation to an enumerated value. - + filename="src/as-release.c" + line="392">Sets the release date. + - a #AsRelationKind or %AS_RELATION_KIND_UNKNOWN for unknown - + - + the string. + filename="src/as-release.c" + line="394">a #AsRelease instance. + + + + the date in ISO8601 format. - - + + Converts the enumerated value to a text representation. - + filename="src/as-release.c" + line="439">Sets the end-of-life date for this release. + - string version of @kind - + - + the #AsRelationKind. - + filename="src/as-release.c" + line="441">a #AsRelease instance. + + + + the EOL date in ISO8601 format. + - - - - - - Creates a new #AsRelease. - - - a #AsRelease - - - - + + Add an artifact (binary / source download) for this release. - + line="568">Sets the description release markup. + @@ -14059,24 +15563,34 @@ for use in the YAML representation and user interfaces. An instance of #AsRelease. + line="570">a #AsRelease instance. - + The #AsArtifact. - + line="571">the description markup. + + + + the BCP47 locale, or %NULL. e.g. "en-GB". + - + Add information about a (resolved) issue to this release. - + line="272">Sets the release kind to distinguish between end-user ready +stable releases and development prereleases.. + @@ -14084,587 +15598,701 @@ for use in the YAML representation and user interfaces. An instance of #AsRelease. + line="274">a #AsRelease instance. - + The #AsIssue. - + line="275">the #AsReleaseKind + - + Get the current active locale, which -is used to get localized messages. - + line="354">Sets the release timestamp. + - the current active locale - + a #AsRelease instance. + line="356">a #AsRelease instance. + + the timestamp value. + + - + Get a list of all downloadable artifacts that are associated with -this release. - + line="488">Sets the UNIX timestamp for the date when this +release is out of support (end-of-life). + - an array of #AsArtifact objects. - - - + + a #AsRelease instance. + + the timestamp value. + + - + Gets the release date. - - - The date in ISO8601 format. - + line="533">Sets the release urgency. + + + a #AsRelease instance. + line="535">a #AsRelease instance. + + the urgency of this release/update (as #AsUrgencyKind) + + - Gets the end-of-life date for this release. - - - The EOL date in ISO8601 format. - + line="683">Sets an URL for this release. + + + a #AsRelease instance. + line="685">a #AsRelease instance. + + the URL kind, e.g. %AS_RELEASE_URL_KIND_DETAILS + + + + the full URL. + + - + Gets the release description markup for a given locale. - - - markup, or %NULL for not set or invalid - + line="306">Sets the release version. + + + a #AsRelease instance. + line="308">a #AsRelease instance. + + the version string. + + - + Get a list of all issues resolved by this release. - + line="321">Compare the version numbers of two releases. + an array of #AsIssue objects. - - - + line="328">1 if @rel1 version is higher than @rel2, 0 if versions are equal, -1 if @rel2 version is higher than @rel1. + - + + an #AsRelease + + an #AsRelease + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The release kind. + + Unknown release type + + + A stable release for end-users + + + A development release or pre-release for testing + + + A snapshot of a software being worked on + + Gets the type of the release. -(development or stable release) - + line="92">Converts the text representation to an enumerated value. + + an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown - + a #AsRelease instance. - - + line="94">the string. + + - - + + Gets the release timestamp. - + line="70">Converts the enumerated value to an text representation. + timestamp, or 0 for unset - + line="76">string version of @kind + - + a #AsRelease instance. - - + line="72">the #AsReleaseKind. + + - - + + + + + + Creates a new #AsReleaseList. + + + an #AsReleaseList + + + + Gets the UNIX timestamp for the date when this -release is out of support (end-of-life). - + filename="src/as-release-list.c" + line="228">Append a release entry to this #AsReleaseList container. + - UNIX timestamp, or 0 for unset or invalid. - + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="230">An instance of #AsReleaseList. + + + + - + Gets the urgency of the release -(showing how important it is to update to a more recent release) - + filename="src/as-release-list.c" + line="385">Remove all release entries from this releases object. + - #AsUrgencyKind, or %AS_URGENCY_KIND_UNKNOWN for not set - + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="387">a #AsReleaseList instance. + - + Gets an URL. - + filename="src/as-release-list.c" + line="240">Get the #AsContext associated with these releases. +This function may return %NULL if no context is set + string, or %NULL if unset - + filename="src/as-release-list.c" + line="247">the associated #AsContext or %NULL + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="242">a #AsReleaseList instance. + - - the URL kind, e.g. %AS_RELEASE_URL_KIND_DETAILS. - - - + Gets the release version. - - + filename="src/as-release-list.c" + line="168">Get the release entries as #GPtrArray. + + string, or %NULL for not set or invalid - + filename="src/as-release-list.c" + line="174">an array of #AsRelease instances. + + + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="170">An instance of #AsReleaseList. + - + Set the current active locale, which -is used to get localized messages. -If the #AsComponent linking this #AsRelease was fetched -from a localized database, usually only -one locale is available. - + filename="src/as-release-list.c" + line="282">Returns the #AsReleaseListKind of the release metadata +associated with this component. + - + The kind. + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="284">a #AsReleaseList instance. + - - a POSIX or BCP47 locale, or %NULL. e.g. "de_DE" - - - + Sets the release date. - + filename="src/as-release-list.c" + line="182">Get the amount of components in this box. + - + Amount of components. + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="184">An instance of #AsReleaseList. + - - the date in ISO8601 format. - - - + Sets the end-of-life date for this release. - - - + filename="src/as-release-list.c" + line="317">Get the remote URL to obtain release information from. + + + The URL of external release data, or %NULL + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="319">a #AsReleaseList instance. + - - the EOL date in ISO8601 format. - - - + Sets the description release markup. - + filename="src/as-release-list.c" + line="210">Retrieve a release entry at the respective index from the +release entry list. + - + An #AsRelease or %NULL + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="212">An instance of #AsReleaseList. + - - the description markup. - - - + the BCP47 locale, or %NULL. e.g. "en-GB". - + filename="src/as-release-list.c" + line="213">The release entry index. + - + Sets the release kind to distinguish between end-user ready -stable releases and development prereleases.. - + filename="src/as-release-list.c" + line="196">Check if there are any components present. + - + %TRUE if this component box is empty. + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="198">An instance of #AsReleaseList. + - - the #AsReleaseKind - - - + Sets the release timestamp. - + filename="src/as-release-list.c" + line="409">Load release information from XML bytes. + - + %TRUE on success. + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="411">a #AsReleaseList instance. + - + the timestamp value. - + filename="src/as-release-list.c" + line="412">the attached #AsContext or %NULL to use the current context + + + + the release XML data as #GBytes + - + Sets the UNIX timestamp for the date when this -release is out of support (end-of-life). - + filename="src/as-release-list.c" + line="256">Sets the document context these releases are associated with. + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="258">a #AsReleaseList instance. + - + the timestamp value. - + filename="src/as-release-list.c" + line="259">the #AsContext. + - + Sets the release urgency. - + filename="src/as-release-list.c" + line="300">Sets the #AsReleaseListKind of the release metadata +associated with this component. + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="302">a #AsReleaseList instance. + - + the urgency of this release/update (as #AsUrgencyKind) - + filename="src/as-release-list.c" + line="303">the #AsComponentKind. + - + Sets an URL for this release. - + filename="src/as-release-list.c" + line="397">Set the amount of release entries stored. + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="399">a #AsReleaseList instance. + - - the URL kind, e.g. %AS_RELEASE_URL_KIND_DETAILS - - - - the full URL. - + + - + Sets the release version. - + filename="src/as-release-list.c" + line="334">Set a remote URL pointing to an AppStream release info file. + - + a #AsRelease instance. - + filename="src/as-release-list.c" + line="336">a #AsReleaseList instance. + - + the version string. + filename="src/as-release-list.c" + line="337">the web URL where release data is found. - + Compare the version numbers of two releases. - + filename="src/as-release-list.c" + line="372">Sort releases by their release version, +starting with the most recent release. + - 1 if @rel1 version is higher than @rel2, 0 if versions are equal, -1 if @rel2 version is higher than @rel1. - + - + an #AsRelease - + filename="src/as-release-list.c" + line="374">a #AsReleaseList instance. + - - an #AsRelease - - + + + + + - - + + - + @@ -14672,7 +16300,7 @@ release is out of support (end-of-life). - + @@ -14680,7 +16308,7 @@ release is out of support (end-of-life). - + @@ -14688,7 +16316,7 @@ release is out of support (end-of-life). - + @@ -14696,7 +16324,7 @@ release is out of support (end-of-life). - + @@ -14704,89 +16332,89 @@ release is out of support (end-of-life). - + - + The release kind. + filename="src/as-release-list.h" + line="59">The kind of a releases block. + glib:name="AS_RELEASE_LIST_KIND_UNKNOWN"> Unknown release type + filename="src/as-release-list.h" + line="61">Unknown releases type - + c:identifier="AS_RELEASE_LIST_KIND_EMBEDDED" + glib:nick="embedded" + glib:name="AS_RELEASE_LIST_KIND_EMBEDDED"> A stable release for end-users + filename="src/as-release-list.h" + line="62">Release info is embedded in metainfo file - + c:identifier="AS_RELEASE_LIST_KIND_EXTERNAL" + glib:nick="external" + glib:name="AS_RELEASE_LIST_KIND_EXTERNAL"> A development release or pre-release for testing + filename="src/as-release-list.h" + line="63">Release info is split to a separate file + c:identifier="as_release_list_kind_from_string" + version="0.16.0"> Converts the text representation to an enumerated value. - + filename="src/as-release-list.c" + line="74">Converts the text representation to an enumerated value. + an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown - + filename="src/as-release-list.c" + line="80">an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown + the string. + filename="src/as-release-list.c" + line="76">the string. + c:identifier="as_release_list_kind_to_string" + version="0.16.0"> Converts the enumerated value to an text representation. - + filename="src/as-release-list.c" + line="54">Converts the enumerated value to an text representation. + string version of @kind + filename="src/as-release-list.c" + line="60">string version of @kind the #AsReleaseKind. - + filename="src/as-release-list.c" + line="56">the #AsReleaseKind. + @@ -14798,7 +16426,7 @@ release is out of support (end-of-life). c:type="AsReleaseUrlKind"> @AS_RELEASE_URL_KIND_UNKNOWN Unknown release web URL type + line="95">@AS_RELEASE_URL_KIND_UNKNOWN Unknown release web URL type The release URL kinds. glib:name="AS_RELEASE_URL_KIND_DETAILS"> Weblink to detailed release notes. + line="98">Weblink to detailed release notes. Converts the text representation to an enumerated value. - + line="180">Converts the text representation to an enumerated value. + an #AsReleaseUrlKind or %AS_RELEASE_URL_KIND_UNKNOWN for unknown + line="186">an #AsReleaseUrlKind or %AS_RELEASE_URL_KIND_UNKNOWN for unknown the string. + line="182">the string. @@ -14842,100 +16470,20 @@ The release URL kinds. version="0.12.5"> Converts the enumerated value to an text representation. - + line="162">Converts the enumerated value to an text representation. + string version of @kind - - - - - the #AsReleaseUrlKind. - - - - - - - The kind of a releases block. - - Unknown releases type - - - Release info is embedded in metainfo file - - - Release info is split to a separate file - - - Converts the text representation to an enumerated value. - - - an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown - - - - - the string. - - - - - - Converts the enumerated value to an text representation. - - - string version of @kind + line="168">string version of @kind the #AsReleaseKind. - + filename="src/as-release.c" + line="164">the #AsReleaseUrlKind. + @@ -14947,16 +16495,16 @@ The release URL kinds. glib:type-name="AsReview" glib:get-type="as_review_get_type" glib:type-struct="ReviewClass"> - + Creates a new #AsReview. - + line="1046">Creates a new #AsReview. + a #AsReview + line="1051">a #AsReview @@ -14965,8 +16513,8 @@ The release URL kinds. version="0.14.0"> Adds flags to an existing review without replacing the other flags. - + line="626">Adds flags to an existing review without replacing the other flags. + @@ -14974,13 +16522,13 @@ The release URL kinds. a #AsReview + line="628">a #AsReview a #AsReviewFlags, e.g. %AS_REVIEW_FLAG_SELF + line="629">a #AsReviewFlags, e.g. %AS_REVIEW_FLAG_SELF @@ -14990,10 +16538,10 @@ The release URL kinds. version="0.14.0"> Adds metadata to the review object. + line="820">Adds metadata to the review object. It is left for the the plugin to use this method as required, but a typical use would be to store some secure authentication token. - + @@ -15001,19 +16549,19 @@ typical use would be to store some secure authentication token. a #AsReview + line="822">a #AsReview a string + line="823">a string a string + line="824">a string @@ -15021,25 +16569,25 @@ typical use would be to store some secure authentication token. Checks if two reviews are the same. - + line="842">Checks if two reviews are the same. + %TRUE for success + line="849">%TRUE for success a #AsReview instance. + line="844">a #AsReview instance. a #AsReview instance. + line="845">a #AsReview instance. @@ -15050,19 +16598,19 @@ typical use would be to store some secure authentication token. version="0.14.0"> Gets the date the review was originally submitted. - + line="755">Gets the date the review was originally submitted. + the #GDateTime, or %NULL for unset + line="761">the #GDateTime, or %NULL for unset a #AsReview + line="757">a #AsReview @@ -15073,19 +16621,19 @@ typical use would be to store some secure authentication token. version="0.14.0"> Gets the multi-line review text that forms the body of the review. - + line="474">Gets the multi-line review text that forms the body of the review. + the string, or %NULL + line="480">the string, or %NULL a #AsReview + line="476">a #AsReview @@ -15096,20 +16644,20 @@ typical use would be to store some secure authentication token. version="0.14.0"> Gets any flags set on the review, for example if the user has already + line="585">Gets any flags set on the review, for example if the user has already voted on the review or if the user wrote the review themselves. - + a #AsReviewFlags, e.g. %AS_REVIEW_FLAG_SELF + line="592">a #AsReviewFlags, e.g. %AS_REVIEW_FLAG_SELF a #AsReview + line="587">a #AsReview @@ -15120,19 +16668,19 @@ voted on the review or if the user wrote the review themselves. version="0.14.0"> Gets the review id. - + line="402">Gets the review id. + the review identifier, e.g. "deadbeef" + line="408">the review identifier, e.g. "deadbeef" a #AsReview + line="404">a #AsReview @@ -15143,19 +16691,19 @@ voted on the review or if the user wrote the review themselves. version="0.14.0"> Gets the locale for the review. - + line="510">Gets the locale for the review. + the string, or %NULL + line="516">the string, or %NULL a #AsReview + line="512">a #AsReview @@ -15165,27 +16713,27 @@ voted on the review or if the user wrote the review themselves. version="0.14.0"> Gets some metadata from a review object. + line="798">Gets some metadata from a review object. It is left for the the plugin to use this method as required, but a typical use would be to retrieve some secure authentication token. - + A string value, or %NULL for not found + line="807">A string value, or %NULL for not found a #AsReview + line="800">a #AsReview a string + line="801">a string @@ -15196,20 +16744,20 @@ typical use would be to retrieve some secure authentication token. version="0.14.0"> This allows the UI to sort reviews into the correct order. + line="361">This allows the UI to sort reviews into the correct order. Higher numbers indicate a more important or relevant review. - + the review priority, or 0 for unset. + line="368">the review priority, or 0 for unset. a #AsReview + line="363">a #AsReview @@ -15220,19 +16768,19 @@ Higher numbers indicate a more important or relevant review. version="0.14.0"> Gets the star rating of the review, where 100 is 5 stars. - + line="546">Gets the star rating of the review, where 100 is 5 stars. + integer as a percentage, or 0 for unset + line="552">integer as a percentage, or 0 for unset a #AsReview + line="548">a #AsReview @@ -15243,19 +16791,19 @@ Higher numbers indicate a more important or relevant review. version="0.14.0"> Gets the name of the reviewer. - + line="647">Gets the name of the reviewer. + the reviewer ID, e.g. "deadbeef", or %NULL + line="653">the reviewer ID, e.g. "deadbeef", or %NULL a #AsReview + line="649">a #AsReview @@ -15266,19 +16814,19 @@ Higher numbers indicate a more important or relevant review. version="0.14.0"> Gets the name of the reviewer. - + line="665">Gets the name of the reviewer. + the reviewer name, e.g. "David Smith", or %NULL + line="671">the reviewer name, e.g. "David Smith", or %NULL a #AsReview + line="667">a #AsReview @@ -15289,19 +16837,19 @@ Higher numbers indicate a more important or relevant review. version="0.14.0"> Gets the review summary. - + line="420">Gets the review summary. + the one-line summary, e.g. "Awesome application" + line="426">the one-line summary, e.g. "Awesome application" a #AsReview + line="422">a #AsReview @@ -15312,19 +16860,19 @@ Higher numbers indicate a more important or relevant review. version="0.14.0"> Gets the version string for the application being reviewed.. - + line="737">Gets the version string for the application being reviewed.. + the version string, e.g. "0.1.2", or %NULL for unset + line="743">the version string, e.g. "0.1.2", or %NULL for unset a #AsReview + line="739">a #AsReview @@ -15335,8 +16883,8 @@ Higher numbers indicate a more important or relevant review. version="0.14.0"> Sets the date the review was originally submitted. - + line="773">Sets the date the review was originally submitted. + @@ -15344,13 +16892,13 @@ Higher numbers indicate a more important or relevant review. a #AsReview + line="775">a #AsReview a #GDateTime, or %NULL + line="776">a #GDateTime, or %NULL @@ -15361,8 +16909,8 @@ Higher numbers indicate a more important or relevant review. version="0.14.0"> Sets the multi-line review text that forms the body of the review. - + line="492">Sets the multi-line review text that forms the body of the review. + @@ -15370,13 +16918,13 @@ Higher numbers indicate a more important or relevant review. a #AsReview + line="494">a #AsReview multi-line description + line="495">multi-line description @@ -15387,9 +16935,9 @@ Higher numbers indicate a more important or relevant review. version="0.14.0"> Gets any flags set on the review, for example if the user has already + line="604">Gets any flags set on the review, for example if the user has already voted on the review or if the user wrote the review themselves. - + @@ -15397,13 +16945,13 @@ voted on the review or if the user wrote the review themselves. a #AsReview + line="606">a #AsReview a #AsReviewFlags, e.g. %AS_REVIEW_FLAG_SELF + line="607">a #AsReviewFlags, e.g. %AS_REVIEW_FLAG_SELF @@ -15414,8 +16962,8 @@ voted on the review or if the user wrote the review themselves. version="0.14.0"> Sets the review identifier that is unique to each review. - + line="438">Sets the review identifier that is unique to each review. + @@ -15423,13 +16971,13 @@ voted on the review or if the user wrote the review themselves. a #AsReview + line="440">a #AsReview review identifier, e.g. "deadbeef" + line="441">review identifier, e.g. "deadbeef" @@ -15440,8 +16988,8 @@ voted on the review or if the user wrote the review themselves. version="0.14.0"> Sets the locale for the review. - + line="528">Sets the locale for the review. + @@ -15449,13 +16997,13 @@ voted on the review or if the user wrote the review themselves. a #AsReview + line="530">a #AsReview a BCP47 locale, e.g. "en-GB" + line="531">a BCP47 locale, e.g. "en-GB" @@ -15466,9 +17014,9 @@ voted on the review or if the user wrote the review themselves. version="0.14.0"> Sets the priority for the review, where positive numbers indicate + line="380">Sets the priority for the review, where positive numbers indicate a better review for the specific user. - + @@ -15476,13 +17024,13 @@ a better review for the specific user. a #AsReview + line="382">a #AsReview a priority value + line="383">a priority value @@ -15493,8 +17041,8 @@ a better review for the specific user. version="0.14.0"> Sets the star rating of the review, where 100 is 5 stars.. - + line="564">Sets the star rating of the review, where 100 is 5 stars.. + @@ -15502,13 +17050,13 @@ a better review for the specific user. a #AsReview + line="566">a #AsReview a integer as a percentage, or 0 for unset + line="567">a integer as a percentage, or 0 for unset @@ -15519,8 +17067,8 @@ a better review for the specific user. version="0.14.0"> Sets the name of the reviewer, which can be left unset. - + line="683">Sets the name of the reviewer, which can be left unset. + @@ -15528,13 +17076,13 @@ a better review for the specific user. a #AsReview + line="685">a #AsReview the reviewer ID, e.g. "deadbeef" + line="686">the reviewer ID, e.g. "deadbeef" @@ -15545,8 +17093,8 @@ a better review for the specific user. version="0.14.0"> Sets the name of the reviewer, which can be left unset. - + line="701">Sets the name of the reviewer, which can be left unset. + @@ -15554,13 +17102,13 @@ a better review for the specific user. a #AsReview + line="703">a #AsReview the reviewer name, e.g. "David Smith" + line="704">the reviewer name, e.g. "David Smith" @@ -15571,8 +17119,8 @@ a better review for the specific user. version="0.14.0"> Sets the one-line summary that may be displayed in bold. - + line="456">Sets the one-line summary that may be displayed in bold. + @@ -15580,13 +17128,13 @@ a better review for the specific user. a #AsReview + line="458">a #AsReview a one-line summary, e.g. "Awesome application" + line="459">a one-line summary, e.g. "Awesome application" @@ -15597,8 +17145,8 @@ a better review for the specific user. version="0.14.0"> Sets the version string for the application being reviewed. - + line="719">Sets the version string for the application being reviewed. + @@ -15606,13 +17154,13 @@ a better review for the specific user. a #AsReview + line="721">a #AsReview a version string, e.g. "0.1.2" + line="722">a version string, e.g. "0.1.2" @@ -15676,7 +17224,7 @@ a better review for the specific user. default-value="0"> The priority for the review, where positive numbers indicate + line="258">The priority for the review, where positive numbers indicate a better review for the specific user. @@ -15737,13 +17285,13 @@ a better review for the specific user. - + - + @@ -15751,7 +17299,7 @@ a better review for the specific user. - + @@ -15759,7 +17307,7 @@ a better review for the specific user. - + @@ -15767,7 +17315,7 @@ a better review for the specific user. - + @@ -15775,7 +17323,7 @@ a better review for the specific user. - + @@ -15783,7 +17331,7 @@ a better review for the specific user. - + @@ -15791,7 +17339,7 @@ a better review for the specific user. - + @@ -15799,7 +17347,7 @@ a better review for the specific user. - + @@ -15813,7 +17361,7 @@ a better review for the specific user. c:type="AsReviewFlags"> The flags for the review. + line="49">The flags for the review. glib:name="AS_REVIEW_FLAG_NONE"> No special flags set + line="51">No special flags set glib:name="AS_REVIEW_FLAG_SELF"> The user wrote the review themselves + line="52">The user wrote the review themselves glib:name="AS_REVIEW_FLAG_VOTED"> The user voted on the review + line="53">The user voted on the review Creates a new #AsScreenshot. + line="843">Creates a new #AsScreenshot. a #AsScreenshot + line="848">a #AsScreenshot Adds an image to the screenshot. - + line="322">Adds an image to the screenshot. + @@ -15874,13 +17422,13 @@ a better review for the specific user. a #AsScreenshot instance. + line="324">a #AsScreenshot instance. a #AsImage instance. + line="325">a #AsImage instance. @@ -15888,8 +17436,8 @@ a better review for the specific user. Adds a video to the screenshot. - + line="391">Adds a video to the screenshot. + @@ -15897,13 +17445,13 @@ a better review for the specific user. a #AsScreenshot instance. + line="393">a #AsScreenshot instance. a #AsVideo instance. + line="394">a #AsVideo instance. @@ -15913,8 +17461,8 @@ a better review for the specific user. version="0.15.4"> Remove all images associated with this screenshot. - + line="340">Remove all images associated with this screenshot. + @@ -15922,43 +17470,72 @@ a better review for the specific user. a #AsScreenshot instance. + line="342">a #AsScreenshot instance. - + Get the current active locale, which -is used to get localized messages. - + line="410">Gets the image caption + + the caption + a #AsScreenshot instance. - + Gets the image caption + line="536">Returns the #AsContext associated with this screenshot. +This function may return %NULL if no context is set. - + + the #AsContext used by this screenshot. + + + + + an #AsScreenshot instance. + + + + + + Get the GUI environment ID of this screenshot, if any +is associated with it. E.g. "plasma-mobile" or "gnome:dark". + + the caption + line="200">The GUI environment ID the screenshot was recorded in, or %NULL if none set. a #AsScreenshot instance. + line="195">a #AsScreenshot instance. @@ -15968,35 +17545,41 @@ is used to get localized messages. version="0.14.0"> Gets the AsImage closest to the target size. The #AsImage may not actually + line="266">Gets the AsImage closest to the target size. The #AsImage may not actually be the requested size, and the application may have to pad / rescale the image to make it fit. Only images for the current active locale (or fallback, if images are not localized) are considered. - - + + an #AsImage, or %NULL + line="279">an #AsImage, or %NULL a #AsScreenshot instance. + line="268">a #AsScreenshot instance. target width + line="269">target width target height + line="270">target height + + + + the target scaling factor. @@ -16004,13 +17587,13 @@ are considered. Gets the images for this screenshots. Only images valid for the current + line="248">Gets the images for this screenshots. Only images valid for the current language are returned. We return all sizes. - + an array + line="255">an array @@ -16019,7 +17602,7 @@ language are returned. We return all sizes. a #AsScreenshot instance. + line="250">a #AsScreenshot instance. @@ -16029,13 +17612,13 @@ language are returned. We return all sizes. version="0.10"> Returns an array of all images we have, regardless of their + line="518">Returns an array of all images we have, regardless of their size and language. - + an array + line="525">an array @@ -16044,7 +17627,7 @@ size and language. an #AsScreenshot instance. + line="520">an #AsScreenshot instance. @@ -16052,19 +17635,19 @@ size and language. Gets the screenshot kind. + line="149">Gets the screenshot kind. a #AsScreenshotKind + line="155">a #AsScreenshotKind a #AsScreenshot instance. + line="151">a #AsScreenshot instance. @@ -16073,19 +17656,19 @@ size and language. c:identifier="as_screenshot_get_media_kind"> Gets the screenshot media kind. - + line="178">Gets the screenshot media kind. + a #AsScreenshotMediaKind + line="184">a #AsScreenshotMediaKind a #AsScreenshot instance. + line="180">a #AsScreenshot instance. @@ -16093,13 +17676,13 @@ size and language. Gets the videos for this screenshots. Only videos valid for the current + line="373">Gets the videos for this screenshots. Only videos valid for the current language selection are returned. We return all sizes. - + an array + line="380">an array @@ -16108,7 +17691,7 @@ language selection are returned. We return all sizes. a #AsScreenshot instance. + line="375">a #AsScreenshot instance. @@ -16117,13 +17700,13 @@ language selection are returned. We return all sizes. c:identifier="as_screenshot_get_videos_all"> Returns an array of all screencast videos we have, regardless of their + line="357">Returns an array of all screencast videos we have, regardless of their size and locale. - + an array + line="364">an array @@ -16132,7 +17715,7 @@ size and locale. a #AsScreenshot instance. + line="359">a #AsScreenshot instance. @@ -16140,33 +17723,28 @@ size and locale. Performs a quick validation on this screenshot + line="441">Performs a quick validation on this screenshot TRUE if the screenshot is a complete #AsScreenshot + line="447">TRUE if the screenshot is a complete #AsScreenshot a #AsScreenshot instance. + line="443">a #AsScreenshot instance. - + Set the current active locale, which -is used to get localized messages. -If the #AsComponent linking this #AsScreenshot was fetched -from a localized database, usually only -one locale is available. - + line="427">Sets a caption on the screenshot + @@ -16174,24 +17752,27 @@ one locale is available. a #AsScreenshot instance. + line="429">a #AsScreenshot instance. - + a POSIX or BCP47 locale, or %NULL. e.g. "de_DE" + line="430">the caption text. + + + - + Sets a caption on the screenshot + line="554">Sets the document context this screenshot is associated +with. @@ -16200,16 +17781,40 @@ one locale is available. a #AsScreenshot instance. + line="556">an #AsScreenshot instance. - + the caption text. - + line="557">the #AsContext. + - + + + + Sets the GUI environment ID of this screenshot. + + + + + + + a #AsScreenshot instance. + + + + the GUI environment ID, e.g. "plasma-mobile" or "gnome:dark" @@ -16217,7 +17822,7 @@ one locale is available. Sets the screenshot kind. + line="164">Sets the screenshot kind. @@ -16226,13 +17831,13 @@ one locale is available. a #AsScreenshot instance. + line="166">a #AsScreenshot instance. the #AsScreenshotKind. + line="167">the #AsScreenshotKind. @@ -16335,19 +17940,19 @@ one locale is available. c:identifier="as_screenshot_kind_from_string"> Converts the text representation to an enumerated value. + line="111">Converts the text representation to an enumerated value. a %AsScreenshotKind, or %AS_SCREENSHOT_KIND_UNKNOWN if not known. + line="117">a %AsScreenshotKind, or %AS_SCREENSHOT_KIND_UNKNOWN if not known. the string. + line="113">the string. @@ -16355,19 +17960,19 @@ one locale is available. Converts the enumerated value to an text representation. + line="131">Converts the enumerated value to an text representation. string version of @kind + line="137">string version of @kind the #AsScreenshotKind. + line="133">the #AsScreenshotKind. @@ -16408,67 +18013,6 @@ one locale is available. line="71">The screenshot contains videos - - The token match kind, which we want to be exactly 16 bits for storage -reasons. - - - No token matching - - - Use the component mediatypes - - - Use the component package name - - - Use the app origin - - - Use the component description - - - - - Use the component keyword - - - Use the component name - - - Use the component ID - - c:type="AsSizeKind"> The artifact size kind. + line="48">The artifact size kind. glib:name="AS_SIZE_KIND_UNKNOWN"> Unknown size + line="50">Unknown size glib:name="AS_SIZE_KIND_DOWNLOAD"> Size of download of component + line="51">Size of download of component glib:name="AS_SIZE_KIND_INSTALLED"> Size of installed component + line="52">Size of installed component Converts the text representation to an enumerated value. - + line="70">Converts the text representation to an enumerated value. + an #AsSizeKind or %AS_SIZE_KIND_UNKNOWN for unknown + line="76">an #AsSizeKind or %AS_SIZE_KIND_UNKNOWN for unknown the string. + line="72">the string. @@ -16527,19 +18071,19 @@ reasons. Converts the enumerated value to an text representation. - + line="52">Converts the enumerated value to an text representation. + string version of @size_kind + line="58">string version of @size_kind the #AsSizeKind. + line="54">the #AsSizeKind. @@ -16552,24 +18096,24 @@ reasons. glib:type-name="AsSuggested" glib:get-type="as_suggested_get_type" glib:type-struct="SuggestedClass"> - + Creates a new #AsSuggested. - + line="320">Creates a new #AsSuggested. + a new #AsSuggested + line="325">a new #AsSuggested Add a component id to this suggested object. - + line="156">Add a component id to this suggested object. + @@ -16577,13 +18121,13 @@ reasons. a #AsSuggested instance. + line="158">a #AsSuggested instance. The component id to add + line="159">The component id to add @@ -16591,12 +18135,12 @@ reasons. Get a list of components id that generated the suggestion - + line="141">Get a list of components id that generated the suggestion + an array of components id + line="147">an array of components id @@ -16605,7 +18149,7 @@ reasons. a #AsSuggested instance. + line="143">a #AsSuggested instance. @@ -16613,19 +18157,19 @@ reasons. Gets the suggested kind. - + line="112">Gets the suggested kind. + the #AsSuggestedKind + line="118">the #AsSuggestedKind a #AsSuggested instance. + line="114">a #AsSuggested instance. @@ -16633,20 +18177,20 @@ reasons. Check if the essential properties of this suggestion are + line="170">Check if the essential properties of this suggestion are populated with useful data. - + %TRUE if we have useful data. + line="177">%TRUE if we have useful data. a #AsSuggested instance. + line="172">a #AsSuggested instance. @@ -16654,8 +18198,8 @@ populated with useful data. Sets the suggested kind. - + line="127">Sets the suggested kind. + @@ -16663,13 +18207,13 @@ populated with useful data. a #AsSuggested instance. + line="129">a #AsSuggested instance. the #AsSuggestedKind, e.g. %AS_SUGGESTED_KIND_HEURISTIC. + line="130">the #AsSuggestedKind, e.g. %AS_SUGGESTED_KIND_HEURISTIC. @@ -16681,13 +18225,13 @@ populated with useful data. - + - + @@ -16695,7 +18239,7 @@ populated with useful data. - + @@ -16703,7 +18247,7 @@ populated with useful data. - + @@ -16711,7 +18255,7 @@ populated with useful data. - + @@ -16719,7 +18263,7 @@ populated with useful data. - + @@ -16727,7 +18271,7 @@ populated with useful data. - + @@ -16740,7 +18284,7 @@ populated with useful data. c:type="AsSuggestedKind"> The suggested type. + line="47">The suggested type. glib:name="AS_SUGGESTED_KIND_UNKNOWN"> Unknown suggested kind + line="49">Unknown suggested kind glib:name="AS_SUGGESTED_KIND_UPSTREAM"> Suggestions provided by the upstream project. + line="50">Suggestions provided by the upstream project. glib:name="AS_SUGGESTED_KIND_HEURISTIC"> Suggestions provided by automatic heuristics. + line="51">Suggestions provided by automatic heuristics. Converts the text representation to an enumerated value. - + line="64">Converts the text representation to an enumerated value. + a #AsSuggestedKind or %AS_SUGGESTED_KIND_UNKNOWN for unknown + line="70">a #AsSuggestedKind or %AS_SUGGESTED_KIND_UNKNOWN for unknown the string. + line="66">the string. @@ -16792,19 +18336,19 @@ populated with useful data. Converts the enumerated value to an text representation. - + line="45">Converts the enumerated value to an text representation. + string version of @kind + line="51">string version of @kind the %AsSuggestedKind. + line="47">the %AsSuggestedKind. @@ -16817,53 +18361,83 @@ populated with useful data. glib:type-name="AsSystemInfo" glib:get-type="as_system_info_get_type" glib:type-struct="SystemInfoClass"> - + Creates a new #AsSystemInfo. - + line="1108">Creates a new #AsSystemInfo. + + + a #AsSystemInfo + + + + + Creates a new #AsSystemInfo that can be used as a mock system +for the given chassis type, reading (mostly) no information +from the current system. + +This function will try to generate a device most representative of +the given chassis class. This can be useful when testing compatibility +for other devices on a different device that is not of the same chassis +type as the one to be tested. + a #AsSystemInfo + line="1139">an #AsSystemInfo template + + + the #AsChassisKind to generate a template for + + + Return a human readable device name for the given modalias. + line="812">Return a human readable device name for the given modalias. Will return the modalias again if no device name could be found, and returns %NULL on error. If @allow_fallback is set to %FALSE, this function will return %NULL and error %AS_SYSTEM_INFO_ERROR_NOT_FOUND in case no suitable description could be found. - + a human-readable device name, or %NULL on error. + line="825">a human-readable device name, or %NULL on error. a #AsSystemInfo instance. + line="814">a #AsSystemInfo instance. the modalias value to resolve (may contain wildcards). + line="815">the modalias value to resolve (may contain wildcards). fall back to low-quality data if no better information is available + line="816">fall back to low-quality data if no better information is available @@ -16872,47 +18446,68 @@ If @allow_fallback is set to %FALSE, this function will return %NULL and error c:identifier="as_system_info_get_display_length"> Get the current display length for the given side kind. + line="1063">Get the current display length for the given side kind. If the display size is unknown, this function will return 0. - + the display size in logical pixels. + line="1071">the display size in logical pixels. a #AsSystemInfo instance. + line="1065">a #AsSystemInfo instance. the #AsDisplaySideKind to select. + line="1066">the #AsDisplaySideKind to select. + + Check whether graphical applications can be displayed via X11 or Wayland. + + + %TRUE if graphical applications can be displayed. + + + + + a #AsSystemInfo instance. + + + + Get the name of the current kernel, e.g. "Linux" - + line="411">Get the name of the current kernel, e.g. "Linux" + the current OS kernel name + line="417">the current OS kernel name a #AsSystemInfo instance. + line="413">a #AsSystemInfo instance. @@ -16921,19 +18516,19 @@ If the display size is unknown, this function will return 0. c:identifier="as_system_info_get_kernel_version"> Get the version of the current kernel, e.g. "6.2.0-2" - + line="427">Get the version of the current kernel, e.g. "6.2.0-2" + the current kernel version + line="433">the current kernel version a #AsSystemInfo instance. + line="429">a #AsSystemInfo instance. @@ -16942,19 +18537,19 @@ If the display size is unknown, this function will return 0. c:identifier="as_system_info_get_memory_total"> Get the current total amount of physical memory in MiB. - + line="506">Get the current total amount of physical memory in MiB. + the current total amount of usable memory in MiB + line="512">the current total amount of usable memory in MiB a #AsSystemInfo instance. + line="508">a #AsSystemInfo instance. @@ -16963,12 +18558,12 @@ If the display size is unknown, this function will return 0. c:identifier="as_system_info_get_modaliases"> Get a list of modaliases for all the hardware on this system that has them. - + line="622">Get a list of modaliases for all the hardware on this system that has them. + a list of modaliases on the system. + line="628">a list of modaliases on the system. @@ -16977,7 +18572,7 @@ If the display size is unknown, this function will return 0. a #AsSystemInfo instance. + line="624">a #AsSystemInfo instance. @@ -16985,19 +18580,19 @@ If the display size is unknown, this function will return 0. Get the AppStream component ID of the current operating system. - + line="304">Get the AppStream component ID of the current operating system. + the component ID of the current OS. + line="310">the component ID of the current OS. a #AsSystemInfo instance. + line="306">a #AsSystemInfo instance. @@ -17006,19 +18601,19 @@ If the display size is unknown, this function will return 0. c:identifier="as_system_info_get_os_homepage"> Get the homepage URL of the current operating system. - + line="363">Get the homepage URL of the current operating system. + the homepage of the current OS. + line="369">the homepage of the current OS. a #AsSystemInfo instance. + line="365">a #AsSystemInfo instance. @@ -17026,19 +18621,19 @@ If the display size is unknown, this function will return 0. Get the ID of the current operating system. - + line="288">Get the ID of the current operating system. + the current OS ID. + line="294">the current OS ID. a #AsSystemInfo instance. + line="290">a #AsSystemInfo instance. @@ -17046,19 +18641,19 @@ If the display size is unknown, this function will return 0. Get the humen-readable name of the current operating system. - + line="331">Get the humen-readable name of the current operating system. + the name of the current OS. + line="337">the name of the current OS. a #AsSystemInfo instance. + line="333">a #AsSystemInfo instance. @@ -17067,19 +18662,19 @@ If the display size is unknown, this function will return 0. c:identifier="as_system_info_get_os_version"> Get the version string of the current operating system. - + line="347">Get the version string of the current operating system. + the version of the current OS. + line="353">the version of the current OS. a #AsSystemInfo instance. + line="349">a #AsSystemInfo instance. @@ -17088,25 +18683,25 @@ If the display size is unknown, this function will return 0. c:identifier="as_system_info_has_device_matching_modalias"> Check if there is a device on this system that matches the given modalias glob. - + line="655">Check if there is a device on this system that matches the given modalias glob. + %TRUE if a matching device was found. + line="662">%TRUE if a matching device was found. a #AsSystemInfo instance. + line="657">a #AsSystemInfo instance. the modalias value to to look for, may contain wildcards. + line="658">the modalias value to to look for, may contain wildcards. @@ -17116,27 +18711,27 @@ If the display size is unknown, this function will return 0. throws="1"> Test if the current system has a specific user input control method. + line="985">Test if the current system has a specific user input control method. Returns %AS_CHECK_RESULT_UNKNOWN if we could not test for an input control method, %AS_CHECK_RESULT_ERROR on error and %AS_CHECK_RESULT_FALSE if the control was not found. - + %AS_CHECK_RESULT_TRUE if control was found + line="995">%AS_CHECK_RESULT_TRUE if control was found a #AsSystemInfo instance. + line="987">a #AsSystemInfo instance. the #AsControlKind to test for. + line="988">the #AsControlKind to test for. @@ -17145,25 +18740,25 @@ Returns %AS_CHECK_RESULT_UNKNOWN if we could not test for an input control metho c:identifier="as_system_info_modalias_to_syspath"> Receive a path in /sys for the devices with the given modalias. - + line="638">Receive a path in /sys for the devices with the given modalias. + the syspath, or %NULL if none was found. + line="645">the syspath, or %NULL if none was found. a #AsSystemInfo instance. + line="640">a #AsSystemInfo instance. the modalias value to resolve. + line="641">the modalias value to resolve. @@ -17172,11 +18767,11 @@ Returns %AS_CHECK_RESULT_UNKNOWN if we could not test for an input control metho c:identifier="as_system_info_set_display_length"> Set the current display length for the given side kind. + line="1085">Set the current display length for the given side kind. The size needs to be in device-independent pixels, see the AppStream documentation for more information: https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations-display_length - + @@ -17184,29 +18779,53 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations a #AsSystemInfo instance. + line="1087">a #AsSystemInfo instance. the #AsDisplaySideKind to select. + line="1088">the #AsDisplaySideKind to select. the length value in device-independt pixels. + line="1089">the length value in device-independt pixels. + + Set whether this system has a GUI / desktop environment available. + + + + + + + a #AsSystemInfo instance. + + + + %TRUE if GUI is available. + + + + Explicitly mark a user input control as present or not present on this system. - + line="1017">Explicitly mark a user input control as present or not present on this system. + @@ -17214,19 +18833,19 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations a #AsSystemInfo instance. + line="1019">a #AsSystemInfo instance. the #AsControlKind to set. + line="1020">the #AsControlKind to set. %TRUE if the control should be marked as found. + line="1021">%TRUE if the control should be marked as found. @@ -17238,13 +18857,13 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations - + - + @@ -17252,7 +18871,7 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations - + @@ -17260,7 +18879,7 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations - + @@ -17268,7 +18887,7 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations - + @@ -17276,7 +18895,7 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations - + @@ -17284,7 +18903,7 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations - + @@ -17298,7 +18917,7 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations glib:error-domain="as-system-info-error-quark"> The error type. + line="91">The error type. Generic failure + line="93">Generic failure Information was not found. + line="94">Information was not found. - + Creates a new #AsTranslation. - + line="266">Creates a new #AsTranslation. + a #AsTranslation + line="271">a #AsTranslation The ID (e.g. Gettext translation domain) of this translation. - + line="150">The ID (e.g. Gettext translation domain) of this translation. + @@ -17360,7 +18979,7 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations a #AsTranslation instance. + line="152">a #AsTranslation instance. @@ -17368,19 +18987,19 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations The translation system type. - + line="121">The translation system type. + an enum of type #AsTranslationKind + line="127">an enum of type #AsTranslationKind a #AsTranslation instance. + line="123">a #AsTranslation instance. @@ -17390,20 +19009,20 @@ https://freedesktop.org/software/appstream/docs/chap-Metadata.html#tag-relations version="0.14.6"> The locale of the source strings for this component. If this has not been + line="177">The locale of the source strings for this component. If this has not been explicitly specified, `en_US` will be returned. - + The locale of the source strings for this component. + line="184">The locale of the source strings for this component. a #AsTranslation instance. + line="179">a #AsTranslation instance. @@ -17411,8 +19030,8 @@ explicitly specified, `en_US` will be returned. Set the ID (e.g. Gettext domain) of this translation. - + line="163">Set the ID (e.g. Gettext domain) of this translation. + @@ -17420,13 +19039,13 @@ explicitly specified, `en_US` will be returned. a #AsTranslation instance. + line="165">a #AsTranslation instance. The ID of this translation. + line="166">The ID of this translation. @@ -17434,8 +19053,8 @@ explicitly specified, `en_US` will be returned. Set the translation system type. - + line="136">Set the translation system type. + @@ -17443,13 +19062,13 @@ explicitly specified, `en_US` will be returned. a #AsTranslation instance. + line="138">a #AsTranslation instance. the new #AsTranslationKind + line="139">the new #AsTranslationKind @@ -17459,10 +19078,10 @@ explicitly specified, `en_US` will be returned. version="0.14.6"> Set the locale of the source strings for this component. In gettext, this is + line="194">Set the locale of the source strings for this component. In gettext, this is referred to as the `C` locale. It’s almost always `en_US`, but for some components it may not be. - + @@ -17470,7 +19089,7 @@ components it may not be. a #AsTranslation instance. + line="196">a #AsTranslation instance. allow-none="1"> The POSIX locale that the source strings are in, or %NULL if unknown or default. + line="197">The POSIX locale that the source strings are in, or %NULL if unknown or default. @@ -17491,13 +19110,13 @@ components it may not be. - + - + @@ -17505,7 +19124,7 @@ components it may not be. - + @@ -17513,7 +19132,7 @@ components it may not be. - + @@ -17521,7 +19140,7 @@ components it may not be. - + @@ -17529,7 +19148,7 @@ components it may not be. - + @@ -17537,7 +19156,7 @@ components it may not be. - + @@ -17550,7 +19169,7 @@ components it may not be. c:type="AsTranslationKind"> The translation type. + line="46">The translation type. glib:name="AS_TRANSLATION_KIND_UNKNOWN"> Type invalid or not known + line="48">Type invalid or not known glib:name="AS_TRANSLATION_KIND_GETTEXT"> Gettext translation domain + line="49">Gettext translation domain glib:name="AS_TRANSLATION_KIND_QT"> Qt translation domain + line="50">Qt translation domain Converts the text representation to an enumerated value. - + line="68">Converts the text representation to an enumerated value. + a #AsTranslationKind or %AS_TRANSLATION_KIND_UNKNOWN for unknown + line="74">a #AsTranslationKind or %AS_TRANSLATION_KIND_UNKNOWN for unknown the string. + line="70">the string. @@ -17602,19 +19221,19 @@ components it may not be. Converts the enumerated value to a text representation. - + line="50">Converts the enumerated value to a text representation. + string version of @kind + line="56">string version of @kind the #AsTranslationKind. + line="52">the #AsTranslationKind. @@ -17625,16 +19244,16 @@ components it may not be. glib:get-type="as_urgency_kind_get_type" c:type="AsUrgencyKind"> The urgency of an #AsRelease + filename="src/as-release.h" + line="72">The urgency of an #AsRelease Urgency is unknown or not set + filename="src/as-release.h" + line="74">Urgency is unknown or not set glib:nick="low" glib:name="AS_URGENCY_KIND_LOW"> Low urgency + filename="src/as-release.h" + line="75">Low urgency glib:nick="medium" glib:name="AS_URGENCY_KIND_MEDIUM"> Medium urgency + filename="src/as-release.h" + line="76">Medium urgency glib:nick="high" glib:name="AS_URGENCY_KIND_HIGH"> High urgency + filename="src/as-release.h" + line="77">High urgency glib:nick="critical" glib:name="AS_URGENCY_KIND_CRITICAL"> Critical urgency + filename="src/as-release.h" + line="78">Critical urgency Converts the text representation to an enumerated value. - + filename="src/as-release.c" + line="138">Converts the text representation to an enumerated value. + a %AsUrgencyKind or %AS_URGENCY_KIND_UNKNOWN for unknown + filename="src/as-release.c" + line="144">a %AsUrgencyKind or %AS_URGENCY_KIND_UNKNOWN for unknown the string. + filename="src/as-release.c" + line="140">the string. @@ -17698,20 +19317,20 @@ components it may not be. c:identifier="as_urgency_kind_to_string" version="0.6.5"> Converts the enumerated value to an text representation. - + filename="src/as-release.c" + line="114">Converts the enumerated value to an text representation. + string version of @urgency_kind + filename="src/as-release.c" + line="120">string version of @urgency_kind the %AsUrgencyKind. + filename="src/as-release.c" + line="116">the %AsUrgencyKind. @@ -17722,16 +19341,16 @@ components it may not be. glib:get-type="as_url_kind_get_type" c:type="AsUrlKind"> The URL type. + filename="src/as-component.h" + line="156">The URL type. Type invalid or not known + filename="src/as-component.h" + line="158">Type invalid or not known glib:nick="homepage" glib:name="AS_URL_KIND_HOMEPAGE"> Project homepage + filename="src/as-component.h" + line="159">Project homepage glib:nick="bugtracker" glib:name="AS_URL_KIND_BUGTRACKER"> Bugtracker + filename="src/as-component.h" + line="160">Bugtracker glib:nick="faq" glib:name="AS_URL_KIND_FAQ"> FAQ page + filename="src/as-component.h" + line="161">FAQ page glib:nick="help" glib:name="AS_URL_KIND_HELP"> Help manual + filename="src/as-component.h" + line="162">Help manual glib:nick="donation" glib:name="AS_URL_KIND_DONATION"> Page with information about how to donate to the project + filename="src/as-component.h" + line="163">Page with information about how to donate to the project glib:nick="translate" glib:name="AS_URL_KIND_TRANSLATE"> Page with instructions on how to translate the project / submit translations. + filename="src/as-component.h" + line="164">Page with instructions on how to translate the project / submit translations. glib:nick="contact" glib:name="AS_URL_KIND_CONTACT"> Contact the developers + filename="src/as-component.h" + line="165">Contact the developers glib:nick="vcs-browser" glib:name="AS_URL_KIND_VCS_BROWSER"> Browse the source code + filename="src/as-component.h" + line="166">Browse the source code glib:nick="contribute" glib:name="AS_URL_KIND_CONTRIBUTE"> Help developing + filename="src/as-component.h" + line="167">Help developing Converts the text representation to an enumerated value. - + filename="src/as-component.c" + line="365">Converts the text representation to an enumerated value. + a #AsUrlKind or %AS_URL_KIND_UNKNOWN for unknown + filename="src/as-component.c" + line="371">a #AsUrlKind or %AS_URL_KIND_UNKNOWN for unknown the string. + filename="src/as-component.c" + line="367">the string. Converts the enumerated value to an text representation. - + filename="src/as-component.c" + line="333">Converts the enumerated value to an text representation. + string version of @url_kind + filename="src/as-component.c" + line="339">string version of @url_kind the %AsUrlKind. + filename="src/as-component.c" + line="335">the %AsUrlKind. @@ -17890,16 +19509,16 @@ components it may not be. glib:type-name="AsValidator" glib:get-type="as_validator_get_type" glib:type-struct="ValidatorClass"> - + Creates a new #AsValidator. - + line="4381">Creates a new #AsValidator. + an #AsValidator + line="4386">an #AsValidator @@ -17909,13 +19528,13 @@ components it may not be. throws="1"> Override the severity of a selected tag. For most tags, the severity + line="611">Override the severity of a selected tag. For most tags, the severity can not be lowered to a value that makes a validation that would otherwise fail pass (so e.g. an ERROR can not become an INFO). Some tags are explicitly allowed to have their severity lowered to enable validation of e.g. incomplete metadata during development. Increasing the severity of any tag is always allowed. - + @@ -17923,19 +19542,19 @@ Increasing the severity of any tag is always allowed. a #AsValidator instance. + line="613">a #AsValidator instance. the issue tag to override, e.g. "release-time-missing" + line="614">the issue tag to override, e.g. "release-time-missing" the new severity for the tag. + line="615">the new severity for the tag. @@ -17946,8 +19565,8 @@ Increasing the severity of any tag is always allowed. throws="1"> Add release metadata explicitly from bytes. - + line="449">Add release metadata explicitly from bytes. + @@ -17955,19 +19574,19 @@ Increasing the severity of any tag is always allowed. a #AsValidator instance. + line="451">a #AsValidator instance. File basename of the release metadata file to add. + line="452">File basename of the release metadata file to add. Data of the release metadata file. + line="453">Data of the release metadata file. @@ -17978,8 +19597,8 @@ Increasing the severity of any tag is always allowed. throws="1"> Add a release metadata file to the validation process. - + line="493">Add a release metadata file to the validation process. + @@ -17987,30 +19606,39 @@ Increasing the severity of any tag is always allowed. a #AsValidator instance. + line="495">a #AsValidator instance. Release metadata file to add. + line="496">Release metadata file to add. - + Clears the list of issues - + line="319">Check the current registered values again and return %TRUE +if no issues were found that would make the previously validated +files fail validation. + +Usually you do not need to call this function explicitly, as +the as_validator_validate_* functions will already return whether +data was valid as return value. + - + %TRUE if previously validated files were valid. + An instance of #AsValidator. + line="321">An instance of #AsValidator. @@ -18020,9 +19648,9 @@ Increasing the severity of any tag is always allowed. version="0.16.0"> Clear all release information that was explicitly added to the + line="433">Clear all release information that was explicitly added to the validation process. - + @@ -18030,24 +19658,24 @@ validation process. a #AsValidator instance. + line="435">a #AsValidator instance. - - + + %TRUE in case we check if remote URLs exist. + line="551">%TRUE in case we allow network access. a #AsValidator instance. + line="549">a #AsValidator instance. @@ -18057,19 +19685,19 @@ validation process. version="0.16.0"> Get the number of files for which issues have been found. - + line="4128">Get the number of files for which issues have been found. + The number of files that have issues. + line="4134">The number of files that have issues. An instance of #AsValidator. + line="4130">An instance of #AsValidator. @@ -18077,12 +19705,12 @@ validation process. Get a list of found metadata format issues. - + line="4145">Get a list of found metadata format issues. + a list of #AsValidatorIssue instances, free with g_list_free() + line="4151">a list of #AsValidatorIssue instances, free with g_list_free() @@ -18091,7 +19719,7 @@ validation process. An instance of #AsValidator. + line="4147">An instance of #AsValidator. @@ -18101,14 +19729,14 @@ validation process. version="0.12.8"> Get a hash table of filenames mapped to lists of issues. + line="4160">Get a hash table of filenames mapped to lists of issues. This is useful if validation was requested for multiple files and a list of issues per-file is desired without prior explicit sorting. - + a file to issue list mapping + line="4168">a file to issue list mapping @@ -18120,41 +19748,39 @@ a list of issues per-file is desired without prior explicit sorting. An instance of #AsValidator. + line="4162">An instance of #AsValidator. - - - + c:identifier="as_validator_get_report_yaml" + throws="1"> + + + - - - - + %TRUE in case we are in strict mode and consider any issues as fatal. + line="582">%TRUE in case we are in strict mode and consider any issues as fatal. a #AsValidator instance. + line="580">a #AsValidator instance. @@ -18163,19 +19789,19 @@ a list of issues per-file is desired without prior explicit sorting. c:identifier="as_validator_get_tag_explanation"> Get the explanatory text for a given issue tag. - + line="4309">Get the explanatory text for a given issue tag. + Explanation text. + line="4315">Explanation text. An instance of #AsValidator. + line="4311">An instance of #AsValidator. @@ -18187,19 +19813,19 @@ a list of issues per-file is desired without prior explicit sorting. c:identifier="as_validator_get_tag_severity"> Get the severity for a given issue tag. - + line="4327">Get the severity for a given issue tag. + The #AsIssueSeverity + line="4333">The #AsIssueSeverity An instance of #AsValidator. + line="4329">An instance of #AsValidator. @@ -18210,12 +19836,12 @@ a list of issues per-file is desired without prior explicit sorting. Get an array of all tags known to the validator. - + line="4345">Get an array of all tags known to the validator. + A string array of tags + line="4351">A string array of tags @@ -18224,17 +19850,17 @@ a list of issues per-file is desired without prior explicit sorting. An instance of #AsValidator. + line="4347">An instance of #AsValidator. - + Set this value to make the #AsValidator check whether remote URLs -actually exist. - + line="560">If set to %TRUE, the validator will be allowed to connect +to the internet to e.g. check URLs for validity. + @@ -18242,13 +19868,13 @@ actually exist. a #AsValidator instance. + line="562">a #AsValidator instance. %TRUE if remote URLs should be checked for availability. + line="563">%TRUE if remote URLs should be checked for availability. @@ -18258,10 +19884,10 @@ actually exist. version="0.15.4"> Enable or disable strict mode. In strict mode, any found issue will result + line="593">Enable or disable strict mode. In strict mode, any found issue will result in a failed validation (except for issues of "pedantic" severity). Otherwise, only a "warning" or "error" will cause the validation to fail. - + @@ -18269,13 +19895,13 @@ Otherwise, only a "warning" or "error" will cause the validation to fail. a #AsValidator instance. + line="595">a #AsValidator instance. %TRUE to enable strict mode. + line="596">%TRUE to enable strict mode. @@ -18285,27 +19911,27 @@ Otherwise, only a "warning" or "error" will cause the validation to fail. version="0.14.0"> Validate AppStream XML data from a byte array. + line="3688">Validate AppStream XML data from a byte array. Remember to run %as_validator_clear_issues if you do not want previous validation runs to affect the outcome of this validation. - + %TRUE if bytes validated successfully. + line="3697">%TRUE if bytes validated successfully. An instance of #AsValidator. + line="3690">An instance of #AsValidator. XML metadata as #GBytes. + line="3691">XML metadata as #GBytes. @@ -18313,27 +19939,25 @@ validation runs to affect the outcome of this validation. Validate AppStream XML data. -Remember to run %as_validator_clear_issues if you do not want previous -validation runs to affect the outcome of this validation. - + line="3767">Validate AppStream XML data. + %TRUE if data validated successfully. + line="3774">%TRUE if data validated successfully. An instance of #AsValidator. + line="3769">An instance of #AsValidator. XML metadata. + line="3770">XML metadata. @@ -18341,27 +19965,25 @@ validation runs to affect the outcome of this validation. Validate an AppStream XML file. -Remember to run %as_validator_clear_issues if you do not want previous -validation runs to affect the outcome of this validation. - + line="3570">Validate an AppStream XML file. + %TRUE if file validated successfully. + line="3577">%TRUE if file validated successfully. An instance of #AsValidator. + line="3572">An instance of #AsValidator. An AppStream XML file. + line="3573">An AppStream XML file. @@ -18369,25 +19991,25 @@ validation runs to affect the outcome of this validation. Validate a full directory tree for issues in AppStream metadata. - + line="3948">Validate a full directory tree for issues in AppStream metadata. + %TRUE if file validated successfully. + line="3955">%TRUE if file validated successfully. An instance of #AsValidator. + line="3950">An instance of #AsValidator. The root directory of the filesystem tree that should be validated. + line="3951">The root directory of the filesystem tree that should be validated. @@ -18399,13 +20021,13 @@ validation runs to affect the outcome of this validation. - + - + @@ -18413,7 +20035,7 @@ validation runs to affect the outcome of this validation. - + @@ -18421,7 +20043,7 @@ validation runs to affect the outcome of this validation. - + @@ -18429,7 +20051,7 @@ validation runs to affect the outcome of this validation. - + @@ -18437,7 +20059,7 @@ validation runs to affect the outcome of this validation. - + @@ -18445,7 +20067,7 @@ validation runs to affect the outcome of this validation. - + @@ -18459,7 +20081,7 @@ validation runs to affect the outcome of this validation. glib:error-domain="as-validator-error-quark"> The error type. + line="47">The error type. glib:name="AS_VALIDATOR_ERROR_FAILED"> Generic failure + line="49">Generic failure - + c:identifier="AS_VALIDATOR_ERROR_INVALID_OVERRIDE" + glib:nick="invalid-override" + glib:name="AS_VALIDATOR_ERROR_INVALID_OVERRIDE"> The issue override was not accepted. + line="50">The issue override was not accepted. glib:name="AS_VALIDATOR_ERROR_INVALID_FILENAME"> The filename was invalid. + line="51">The filename was invalid. glib:type-name="AsValidatorIssue" glib:get-type="as_validator_issue_get_type" glib:type-struct="ValidatorIssueClass"> - + Creates a new #AsValidatorIssue. + line="387">Creates a new #AsValidatorIssue. a #AsValidatorIssue + line="392">a #AsValidatorIssue The component-id this issue is about. - + line="266">The component-id this issue is about. + a component-id. + line="272">a component-id. a #AsValidatorIssue instance. + line="268">a #AsValidatorIssue instance. @@ -18545,7 +20167,7 @@ validation runs to affect the outcome of this validation. filename="src/as-validator-issue.c" line="232">Get an extended explanation on this issue, or return %NULL if none is available. - + c:identifier="as_validator_issue_get_filename"> The name of the file this issue was found in. - + line="324">The name of the file this issue was found in. + the filename + line="330">the filename a #AsValidatorIssue instance. + line="326">a #AsValidatorIssue instance. @@ -18587,19 +20209,19 @@ if none is available. version="0.12.8"> Get a short context hint for this issue. - + line="199">Get a short context hint for this issue. + the hint + line="205">the hint a #AsValidatorIssue instance. + line="201">a #AsValidatorIssue instance. @@ -18607,19 +20229,19 @@ if none is available. Gets the line number where this issue was found. - + line="295">Gets the line number where this issue was found. + the line number where this issue occured, or -1 if unknown. + line="301">the line number where this issue occured, or -1 if unknown. a #AsValidatorIssue instance. + line="297">a #AsValidatorIssue instance. @@ -18628,20 +20250,20 @@ if none is available. c:identifier="as_validator_issue_get_location"> Builds a string containing all information about the location + line="353">Builds a string containing all information about the location where this issue occured that we know about. - + the location hint as string. + line="360">the location hint as string. a #AsValidatorIssue instance. + line="355">a #AsValidatorIssue instance. @@ -18650,19 +20272,19 @@ where this issue occured that we know about. c:identifier="as_validator_issue_get_severity"> Gets the severity of this issue. - + line="170">Gets the severity of this issue. + a #AsIssueSeverity + line="176">a #AsIssueSeverity a #AsValidatorIssue instance. + line="172">a #AsValidatorIssue instance. @@ -18672,19 +20294,19 @@ where this issue occured that we know about. version="0.12.8"> Gets the issue tag string for this issue. + line="137">Gets the issue tag string for this issue. the tag + line="143">the tag a #AsValidatorIssue instance. + line="139">a #AsValidatorIssue instance. @@ -18692,8 +20314,8 @@ where this issue occured that we know about. Sets the component-id this issue is about. - + line="281">Sets the component-id this issue is about. + @@ -18701,13 +20323,13 @@ where this issue occured that we know about. a #AsValidatorIssue instance. + line="283">a #AsValidatorIssue instance. a component-id. + line="284">a component-id. @@ -18718,7 +20340,7 @@ where this issue occured that we know about. Set explanatory text for this issue. - + @@ -18741,8 +20363,8 @@ where this issue occured that we know about. c:identifier="as_validator_issue_set_filename"> Sets the name of the file the issue was found in. - + line="339">Sets the name of the file the issue was found in. + @@ -18750,13 +20372,13 @@ where this issue occured that we know about. a #AsValidatorIssue instance. + line="341">a #AsValidatorIssue instance. the filename. + line="342">the filename. @@ -18766,8 +20388,8 @@ where this issue occured that we know about. version="0.12.8"> Sets short issue hint. - + line="216">Sets short issue hint. + @@ -18775,13 +20397,13 @@ where this issue occured that we know about. a #AsValidatorIssue instance. + line="218">a #AsValidatorIssue instance. the hint. + line="219">the hint. @@ -18789,8 +20411,8 @@ where this issue occured that we know about. Sets the line number where this issue was found. - + line="310">Sets the line number where this issue was found. + @@ -18798,13 +20420,13 @@ where this issue occured that we know about. a #AsValidatorIssue instance. + line="312">a #AsValidatorIssue instance. the line number. + line="313">the line number. @@ -18813,8 +20435,8 @@ where this issue occured that we know about. c:identifier="as_validator_issue_set_severity"> Sets the severity for this issue. - + line="185">Sets the severity for this issue. + @@ -18822,13 +20444,13 @@ where this issue occured that we know about. a #AsValidatorIssue instance. + line="187">a #AsValidatorIssue instance. the #AsIssueSeverity. + line="188">the #AsIssueSeverity. @@ -18838,7 +20460,7 @@ where this issue occured that we know about. version="0.12.8"> Sets the issue tag. + line="154">Sets the issue tag. @@ -18847,13 +20469,13 @@ where this issue occured that we know about. a #AsValidatorIssue instance. + line="156">a #AsValidatorIssue instance. the tag. + line="157">the tag. @@ -18865,13 +20487,13 @@ where this issue occured that we know about. - + - + @@ -18879,7 +20501,7 @@ where this issue occured that we know about. - + @@ -18887,7 +20509,7 @@ where this issue occured that we know about. - + @@ -18895,7 +20517,7 @@ where this issue occured that we know about. - + @@ -18903,7 +20525,7 @@ where this issue occured that we know about. - + @@ -18911,7 +20533,7 @@ where this issue occured that we know about. - + @@ -18923,8 +20545,8 @@ where this issue occured that we know about. glib:get-type="as_value_flags_get_type" c:type="AsValueFlags"> Set how values assigned to an #AsComponent should be treated when + filename="src/as-context.h" + line="105">Set how values assigned to an #AsComponent should be treated when they are set or retrieved. glib:nick="none" glib:name="AS_VALUE_FLAG_NONE"> No flags. + filename="src/as-context.h" + line="107">No flags. glib:nick="duplicate-check" glib:name="AS_VALUE_FLAG_DUPLICATE_CHECK"> Check for duplicates when adding items to list values. + filename="src/as-context.h" + line="108">Check for duplicates when adding items to list values. glib:nick="no-translation-fallback" glib:name="AS_VALUE_FLAG_NO_TRANSLATION_FALLBACK"> Don't fall back to C when retrieving translated values. + filename="src/as-context.h" + line="109">Don't fall back to C when retrieving translated values. glib:type-name="AsVideo" glib:get-type="as_video_get_type" glib:type-struct="VideoClass"> - + Creates a new #AsVideo. - + line="550">Creates a new #AsVideo. + a #AsVideo + line="555">a #AsVideo Gets the video codec, if known. - + line="166">Gets the video codec, if known. + the #AsVideoCodecKind + line="172">the #AsVideoCodecKind a #AsVideo instance. + line="168">a #AsVideo instance. @@ -19024,19 +20646,19 @@ they are set or retrieved. c:identifier="as_video_get_container_kind"> Gets the video container format, if known. - + line="197">Gets the video container format, if known. + the #AsVideoContainerKind + line="203">the #AsVideoContainerKind a #AsVideo instance. + line="199">a #AsVideo instance. @@ -19044,19 +20666,19 @@ they are set or retrieved. Gets the video height, if known. - + line="275">Gets the video height, if known. + height in pixels or 0 if unknown + line="281">height in pixels or 0 if unknown a #AsVideo instance. + line="277">a #AsVideo instance. @@ -19064,19 +20686,19 @@ they are set or retrieved. Get locale for this video. - + line="306">Get locale for this video. + Locale string + line="312">Locale string a #AsVideo instance. + line="308">a #AsVideo instance. @@ -19084,19 +20706,19 @@ they are set or retrieved. Gets the full qualified URL for the video, usually pointing at a mirror or CDN server. - + line="213">Gets the full qualified URL for the video, usually pointing at a mirror or CDN server. + a web URL + line="219">a web URL a #AsVideo instance. + line="215">a #AsVideo instance. @@ -19104,19 +20726,19 @@ they are set or retrieved. Gets the video width, if known. - + line="244">Gets the video width, if known. + width in pixels or 0 if unknown + line="250">width in pixels or 0 if unknown a #AsVideo instance. + line="246">a #AsVideo instance. @@ -19124,8 +20746,8 @@ they are set or retrieved. Sets the video codec. - + line="151">Sets the video codec. + @@ -19133,13 +20755,13 @@ they are set or retrieved. a #AsVideo instance. + line="153">a #AsVideo instance. the #AsVideoCodecKind, e.g. %AS_VIDEO_CODEC_KIND_AV1. + line="154">the #AsVideoCodecKind, e.g. %AS_VIDEO_CODEC_KIND_AV1. @@ -19148,8 +20770,8 @@ they are set or retrieved. c:identifier="as_video_set_container_kind"> Sets the video container. - + line="182">Sets the video container. + @@ -19157,13 +20779,13 @@ they are set or retrieved. a #AsVideo instance. + line="184">a #AsVideo instance. the #AsVideoContainerKind, e.g. %AS_VIDEO_CONTAINER_KIND_MKV. + line="185">the #AsVideoContainerKind, e.g. %AS_VIDEO_CONTAINER_KIND_MKV. @@ -19171,8 +20793,8 @@ they are set or retrieved. Sets the video height. - + line="291">Sets the video height. + @@ -19180,13 +20802,13 @@ they are set or retrieved. a #AsVideo instance. + line="293">a #AsVideo instance. the height in pixels. + line="294">the height in pixels. @@ -19194,8 +20816,8 @@ they are set or retrieved. Sets the locale for this video. - + line="321">Sets the locale for this video. + @@ -19203,13 +20825,13 @@ they are set or retrieved. a #AsVideo instance. + line="323">a #AsVideo instance. the BCP47 locale string. + line="324">the BCP47 locale string. @@ -19217,8 +20839,8 @@ they are set or retrieved. Sets the fully-qualified URL to use for the video. - + line="229">Sets the fully-qualified URL to use for the video. + @@ -19226,13 +20848,13 @@ they are set or retrieved. a #AsVideo instance. + line="231">a #AsVideo instance. the URL. + line="232">the URL. @@ -19240,8 +20862,8 @@ they are set or retrieved. Sets the video width. - + line="260">Sets the video width. + @@ -19249,13 +20871,13 @@ they are set or retrieved. a #AsVideo instance. + line="262">a #AsVideo instance. the width in pixels. + line="263">the width in pixels. @@ -19267,13 +20889,13 @@ they are set or retrieved. - + - + @@ -19281,7 +20903,7 @@ they are set or retrieved. - + @@ -19289,7 +20911,7 @@ they are set or retrieved. - + @@ -19297,7 +20919,7 @@ they are set or retrieved. - + @@ -19305,7 +20927,7 @@ they are set or retrieved. - + @@ -19313,7 +20935,7 @@ they are set or retrieved. - + @@ -19326,7 +20948,7 @@ they are set or retrieved. c:type="AsVideoCodecKind"> Supported video codecs. + line="46">Supported video codecs. glib:name="AS_VIDEO_CODEC_KIND_UNKNOWN"> Unknown video codec + line="48">Unknown video codec glib:name="AS_VIDEO_CODEC_KIND_VP9"> The VP9 video codec + line="49">The VP9 video codec glib:name="AS_VIDEO_CODEC_KIND_AV1"> The AV1 video codec + line="50">The AV1 video codec Converts the text representation to an enumerated value. - + line="73">Converts the text representation to an enumerated value. + a #AsVideoCodecKind, or %AS_VIDEO_CODEC_KIND_UNKNOWN for unknown. + line="79">a #AsVideoCodecKind, or %AS_VIDEO_CODEC_KIND_UNKNOWN for unknown. the string. + line="75">the string. @@ -19378,19 +21000,19 @@ they are set or retrieved. Converts the enumerated value to an text representation. - + line="92">Converts the enumerated value to an text representation. + string version of @codec + line="98">string version of @codec the #AsVideoCodecKind. + line="94">the #AsVideoCodecKind. @@ -19402,7 +21024,7 @@ they are set or retrieved. c:type="AsVideoContainerKind"> Supported video codecs. + line="62">Supported video codecs. glib:name="AS_VIDEO_CONTAINER_KIND_UNKNOWN"> Unknown video container + line="64">Unknown video container glib:name="AS_VIDEO_CONTAINER_KIND_MKV"> The Matroska video (MKV) container + line="65">The Matroska video (MKV) container glib:name="AS_VIDEO_CONTAINER_KIND_WEBM"> The WebM video container + line="66">The WebM video container Converts the text representation to an enumerated value. - + line="111">Converts the text representation to an enumerated value. + a #AsVideoContainerKind, or %AS_VIDEO_CONTAINER_KIND_UNKNOWN for unknown. + line="117">a #AsVideoContainerKind, or %AS_VIDEO_CONTAINER_KIND_UNKNOWN for unknown. the string. + line="113">the string. @@ -19455,19 +21077,19 @@ they are set or retrieved. c:identifier="as_video_container_kind_to_string"> Converts the enumerated value to an text representation. - + line="132">Converts the enumerated value to an text representation. + string version of @kind + line="138">string version of @kind the #AsVideoContainerKind. + line="134">the #AsVideoContainerKind. @@ -19480,7 +21102,7 @@ they are set or retrieved. Converts the text representation to an enumerated value. - + Converts the enumerated value to an text representation. - + moved-to="ArtifactKind.from_string"> Converts the text representation to an enumerated value. - + line="88">Converts the text representation to an enumerated value. + a #AsArtifactKind, or %AS_ARTIFACT_KIND_UNKNOWN for unknown. + line="94">a #AsArtifactKind, or %AS_ARTIFACT_KIND_UNKNOWN for unknown. the string. + line="90">the string. @@ -19546,19 +21168,19 @@ they are set or retrieved. moved-to="ArtifactKind.to_string"> Converts the enumerated value to an text representation. - + line="107">Converts the enumerated value to an text representation. + string version of @kind + line="113">string version of @kind the #AsArtifactKind. + line="109">the #AsArtifactKind. @@ -19635,7 +21257,7 @@ See also: #AsRelease This object represents an Appstream software component which is associated + line="51">This object represents an Appstream software component which is associated to a package in the distribution's repositories. A component can be anything, ranging from an application to a font, a codec or even a non-visual software project providing libraries and python-modules for @@ -19645,6 +21267,16 @@ The type of the component is stored as #AsComponentKind and can be queried to find out which kind of component we're dealing with. See also: #AsProvidesKind, #AsDatabase + + + This class is a container for #AsComponent objects which usually share the same #AsContext +and are manipulated together. +It also provides binding-safe accessor functions to manipulate an array of +components. + +See also: #AsComponent + + + Describes the developer of a component. + +See also: #AsComponent firmware, binaries, etc. Functions to work with these items are provided here. +See also: #AsComponent + + + Contains information about external references to the +component this reference is associated with. + See also: #AsComponent A component can have recommends- or requires relations on other components, system properties, + line="34">A component can have recommends- or requires relations on other components, system properties, hardware and other interfaces. This class contains a representation of those relations. @@ -19768,6 +21415,24 @@ Releases can be automatically generated by parsing upstream ChangeLogs or .spec files, or can be populated using MetaInfo files. See also: #AsComponent + + + This class contains multiple #Asrelease entries as well as information +affecting all releases of that grouping. +It can also fetch the required release information on-demand from +a web URL in case it is not available locally. + +See also: #AsRelease, #AsRelease + + + This class contains resulting information from a check for whether an +#AsRelation is satisfied on a specific system configuration. + +See also: #AsRelation Functions which are used in libappstream and might be useful for others + line="52">Functions which are used in libappstream and might be useful for others as well. @@ -19864,19 +21529,19 @@ See also: #AsScreenshot, #AsImage moved-to="BundleKind.from_string"> Converts the text representation to an enumerated value. - + line="76">Converts the text representation to an enumerated value. + a #AsBundleKind or %AS_BUNDLE_KIND_UNKNOWN for unknown + line="82">a #AsBundleKind or %AS_BUNDLE_KIND_UNKNOWN for unknown the string. + line="78">the string. @@ -19887,41 +21552,87 @@ See also: #AsScreenshot, #AsImage version="0.8.0"> Converts the enumerated value to an text representation. - + line="44">Converts the enumerated value to an text representation. + string version of @kind + line="50">string version of @kind the %AsBundleKind. + line="46">the %AsBundleKind. + + Converts the text representation to an enumerated value. + + + a #AsChassisKind or %AS_CHASSIS_KIND_UNKNOWN for unknown + + + + + the string. + + + + + + Converts the enumerated value to a text representation. + + + string version of @kind + + + + + the #AsChassisKind. + + + + Converts the text representation to an enumerated value. - + line="71">Converts the text representation to an enumerated value. + a #AsChecksumKind or %AS_CHECKSUM_KIND_NONE for unknown + line="77">a #AsChecksumKind or %AS_CHECKSUM_KIND_NONE for unknown the string. + line="73">the string. @@ -19931,19 +21642,19 @@ See also: #AsScreenshot, #AsImage moved-to="ChecksumKind.to_string"> Converts the enumerated value to an text representation. - + line="45">Converts the enumerated value to an text representation. + string version of @kind + line="51">string version of @kind the %AsChecksumKind. + line="47">the %AsChecksumKind. @@ -19954,19 +21665,19 @@ See also: #AsScreenshot, #AsImage version="0.15.2"> Converts the text representation to an enumerated value. - + line="105">Converts the text representation to an enumerated value. + a #AsColorKind or %AS_COLOR_KIND_UNKNOWN for unknown. + line="111">a #AsColorKind or %AS_COLOR_KIND_UNKNOWN for unknown. the string. + line="107">the string. @@ -19977,19 +21688,19 @@ See also: #AsScreenshot, #AsImage version="0.15.2"> Converts the enumerated value to an text representation. - + line="87">Converts the enumerated value to an text representation. + string version of @kind + line="93">string version of @kind the %AsColorKind. + line="89">the %AsColorKind. @@ -20000,19 +21711,19 @@ See also: #AsScreenshot, #AsImage version="0.15.2"> Converts the text representation to an enumerated value. - + line="143">Converts the text representation to an enumerated value. + a #AsColorKind or %AS_COLOR_SCHEME_KIND_UNKNOWN for unknown. + line="149">a #AsColorKind or %AS_COLOR_SCHEME_KIND_UNKNOWN for unknown. the string. + line="145">the string. @@ -20023,41 +21734,81 @@ See also: #AsScreenshot, #AsImage version="0.15.2"> Converts the enumerated value to an text representation. - + line="123">Converts the enumerated value to an text representation. + string version of @kind + line="129">string version of @kind the %AsColorSchemeKind. + line="125">the %AsColorSchemeKind. + + Returns the #AsComponent at the given index of the array. + +This does not perform bounds checking on the given @index_, +so you are responsible for checking it against the array length. +Use %as_component_box_len to determine the amount of components +present in the #AsComponentBox. + + + + a #AsComponentBox + + + the index of the #AsComponent to return + + + + + Get the amount of components in its box array. + + + + a #AsComponentBox + + + Converts the text representation to an enumerated value. - + line="200">Converts the text representation to an enumerated value. + a #AsComponentKind or %AS_COMPONENT_KIND_UNKNOWN for unknown + line="206">a #AsComponentKind or %AS_COMPONENT_KIND_UNKNOWN for unknown the string. + line="202">the string. @@ -20067,19 +21818,19 @@ See also: #AsScreenshot, #AsImage moved-to="ComponentKind.to_string"> Converts the enumerated value to an text representation. - + line="154">Converts the enumerated value to an text representation. + string version of @kind + line="160">string version of @kind the #AsComponentKind. + line="156">the #AsComponentKind. @@ -20089,19 +21840,19 @@ See also: #AsScreenshot, #AsImage moved-to="ComponentScope.from_string"> Converts the text representation to an enumerated value. - + line="315">Converts the text representation to an enumerated value. + a #AsComponentScope or %AS_COMPONENT_SCOPE_UNKNOWN for unknown + line="321">a #AsComponentScope or %AS_COMPONENT_SCOPE_UNKNOWN for unknown the string. + line="317">the string. @@ -20111,19 +21862,19 @@ See also: #AsScreenshot, #AsImage moved-to="ComponentScope.to_string"> Converts the enumerated value to an text representation. - + line="297">Converts the enumerated value to an text representation. + string version of @scope + line="303">string version of @scope the #AsComponentScope. + line="299">the #AsComponentScope. @@ -20134,13 +21885,13 @@ See also: #AsScreenshot, #AsImage version="0.12.12"> Format @age as a human-readable string in the given rating @system. This is + line="287">Format @age as a human-readable string in the given rating @system. This is the way to present system-specific strings in a UI. - + a newly allocated formatted version of + line="295">a newly allocated formatted version of @age, or %NULL if the given @system has no representation for @age @@ -20148,13 +21899,13 @@ the way to present system-specific strings in a UI. an #AsContentRatingSystem + line="289">an #AsContentRatingSystem a CSM age to format + line="290">a CSM age to format @@ -20168,7 +21919,7 @@ the way to present system-specific strings in a UI. line="683">Determine the most appropriate #AsContentRatingSystem for the given @locale. Content rating systems are selected by territory. If no content rating system seems suitable, %AS_CONTENT_RATING_SYSTEM_IARC is returned. - + filename="src/as-content-rating.c" line="580">Get the CSM ages corresponding to the entries returned by as_content_rating_system_get_formatted_ages() for this @system. - + version="0.12.12"> Get an array of all the possible return values of + line="520">Get an array of all the possible return values of as_content_rating_system_format_age() for the given @system. The array is sorted with youngest CSM age first. - + %NULL-terminated array of human-readable age strings + line="528">%NULL-terminated array of human-readable age strings @@ -20242,7 +21993,7 @@ sorted with youngest CSM age first. an #AsContentRatingSystem + line="522">an #AsContentRatingSystem @@ -20253,20 +22004,20 @@ sorted with youngest CSM age first. version="0.12.12"> Get a human-readable string to identify @system. %NULL will be returned for + line="257">Get a human-readable string to identify @system. %NULL will be returned for %AS_CONTENT_RATING_SYSTEM_UNKNOWN. - + a human-readable string for @system, or %NULL if unknown + line="264">a human-readable string for @system, or %NULL if unknown an #AsContentRatingSystem + line="259">an #AsContentRatingSystem @@ -20277,19 +22028,19 @@ sorted with youngest CSM age first. version="0.11.0"> Converts the text representation to an enumerated value. - + line="221">Converts the text representation to an enumerated value. + a #AsContentRatingValue or %AS_CONTENT_RATING_VALUE_UNKNOWN for unknown + line="227">a #AsContentRatingValue or %AS_CONTENT_RATING_VALUE_UNKNOWN for unknown the string. + line="223">the string. @@ -20300,19 +22051,19 @@ sorted with youngest CSM age first. version="0.11.0"> Converts the enumerated value to an text representation. - + line="197">Converts the enumerated value to an text representation. + string version of @value + line="203">string version of @value the #AsContentRatingValue. + line="199">the #AsContentRatingValue. @@ -20323,89 +22074,43 @@ sorted with youngest CSM age first. version="0.12.11"> Converts the text representation to an enumerated value. - + line="328">Converts the text representation to an enumerated value. + a #AsControlKind or %AS_CONTROL_KIND_UNKNOWN for unknown + line="334">a #AsControlKind or %AS_CONTROL_KIND_UNKNOWN for unknown the string. + line="330">the string. - Converts the enumerated value to a text representation. - - - string version of @kind - - - - - the #AsControlKind. - - - - - - Converts the text representation to an enumerated value. - - - a #AsDisplayLengthKind or %AS_DISPLAY_LENGTH_KIND_UNKNOWN for unknown - - - - - the string. - - - - - + moved-to="ControlKind.to_string" + version="0.12.11"> Converts the enumerated value to a text representation. - + line="294">Converts the enumerated value to a text representation. + string version of @kind + line="300">string version of @kind the #AsDisplayLengthKind. - + line="296">the #AsControlKind. + @@ -20415,19 +22120,19 @@ sorted with youngest CSM age first. version="0.12.12"> Converts the text representation to an enumerated value. - + line="382">Converts the text representation to an enumerated value. + a #AsDisplaySideKind or %AS_DISPLAY_SIDE_KIND_UNKNOWN for unknown + line="388">a #AsDisplaySideKind or %AS_DISPLAY_SIDE_KIND_UNKNOWN for unknown the string. + line="384">the string. @@ -20438,19 +22143,19 @@ sorted with youngest CSM age first. version="0.12.12"> Converts the enumerated value to a text representation. - + line="362">Converts the enumerated value to a text representation. + string version of @kind + line="368">string version of @kind the #AsDisplaySideKind. + line="364">the #AsDisplaySideKind. @@ -20458,66 +22163,66 @@ sorted with youngest CSM age first. - + - + - + - + - + - + - + - + + version="0.10.0"> Converts the text representation to an enumerated value. - + filename="src/as-context.c" + line="122">Converts the text representation to an enumerated value. + a #AsFormatKind or %AS_FORMAT_KIND_UNKNOWN for unknown + filename="src/as-context.c" + line="128">a #AsFormatKind or %AS_FORMAT_KIND_UNKNOWN for unknown the string. + filename="src/as-context.c" + line="124">the string. @@ -20525,22 +22230,22 @@ sorted with youngest CSM age first. + version="0.10.0"> Converts the enumerated value to an text representation. - + filename="src/as-context.c" + line="102">Converts the enumerated value to an text representation. + string version of @kind + filename="src/as-context.c" + line="108">string version of @kind the #AsFormatKind. + filename="src/as-context.c" + line="104">the #AsFormatKind. @@ -20548,15 +22253,15 @@ sorted with youngest CSM age first. + version="0.10.0"> Converts the text representation to an enumerated value. - + line="83">Converts the text representation to an enumerated value. + a #AsFormatVersion. For unknown, the highest version + line="89">a #AsFormatVersion. For unknown, the highest version number is assumed. @@ -20564,7 +22269,7 @@ number is assumed. the string. + line="85">the string. @@ -20572,22 +22277,22 @@ number is assumed. + version="0.10.0"> Converts the enumerated value to an text representation. - + line="65">Converts the enumerated value to an text representation. + string version of @version + line="71">string version of @version the #AsFormatKind. + line="67">the #AsFormatKind. @@ -20596,10 +22301,10 @@ number is assumed. c:identifier="as_get_current_distro_component_id"> Returns the component-ID of the current distribution based on contents + line="1210">Returns the component-ID of the current distribution based on contents of the `/etc/os-release` file. This function is a shorthand for %as_distro_details_get_cid - + @@ -20610,14 +22315,14 @@ This function is a shorthand for %as_distro_details_get_cid introspectable="0"> Get a list of the default Freedesktop and AppStream categories + line="778">Get a list of the default Freedesktop and AppStream categories that software components (especially GUI applications) can be sorted into in software centers. - + a list of #AsCategory + line="786">a list of #AsCategory @@ -20626,7 +22331,7 @@ into in software centers. Include special categories (e.g. "addons", and "all"/"featured" in submenus) + line="780">Include special categories (e.g. "addons", and "all"/"featured" in submenus) @@ -20636,7 +22341,7 @@ into in software centers. shadows="get_default_categories"> Get a list of the default Freedesktop and AppStream categories + line="853">Get a list of the default Freedesktop and AppStream categories that software components (especially GUI applications) can be sorted into in software centers. @@ -20646,7 +22351,7 @@ to be used in GIR bindings. a list of #AsCategory + line="864">a list of #AsCategory @@ -20655,30 +22360,52 @@ to be used in GIR bindings. Include special categories (e.g. "addons", and "all"/"featured" in submenus) + line="855">Include special categories (e.g. "addons", and "all"/"featured" in submenus) + + Get a translated license name for the given SPDX ID. + + + The license name, or %NULL if none found. + + + + + The SPDX license ID. + + + + Get a web URL to the license text and more license information for an SPDX + line="682">Get a web URL to the license text and more license information for an SPDX license identifier. - - + + The license URL. + line="689">The license URL, or %NULL if none available. The SPDX license ID. + line="684">The SPDX license ID. @@ -20686,40 +22413,40 @@ license identifier. Replaces the string @find with the string @replace in a #GString up to + line="865">Replaces the string @find with the string @replace in a #GString up to @limit times. If the number of instances of @find in the #GString is less than @limit, all instances are replaced. If @limit is `0`, all instances of @find are replaced. - + the number of find and replace operations performed. + line="877">the number of find and replace operations performed. a #GString + line="867">a #GString the string to find in @string + line="868">the string to find in @string the string to insert in place of @find + line="869">the string to insert in place of @find the maximum instances of @find to replace with @replace, or `0` for no limit + line="870">the maximum instances of @find to replace with @replace, or `0` for no limit @@ -20729,19 +22456,19 @@ all instances of @find are replaced. moved-to="IconKind.from_string"> Converts the text representation to an enumerated value. - + line="67">Converts the text representation to an enumerated value. + a #AsIconKind or %AS_ICON_KIND_UNKNOWN for unknown + line="73">a #AsIconKind or %AS_ICON_KIND_UNKNOWN for unknown the string. + line="69">the string. @@ -20751,19 +22478,19 @@ all instances of @find are replaced. moved-to="IconKind.to_string"> Converts the enumerated value to an text representation. - + line="45">Converts the enumerated value to an text representation. + string version of @kind + line="51">string version of @kind the %AsIconKind. + line="47">the %AsIconKind. @@ -20773,19 +22500,19 @@ all instances of @find are replaced. moved-to="ImageKind.from_string"> Converts the text representation to an enumerated value. - + line="79">Converts the text representation to an enumerated value. + a #AsImageKind, or %AS_IMAGE_KIND_UNKNOWN for unknown. + line="85">a #AsImageKind, or %AS_IMAGE_KIND_UNKNOWN for unknown. the string. + line="81">the string. @@ -20795,19 +22522,19 @@ all instances of @find are replaced. moved-to="ImageKind.to_string"> Converts the enumerated value to an text representation. - + line="98">Converts the enumerated value to an text representation. + string version of @kind + line="104">string version of @kind the #AsImageKind. + line="100">the #AsImageKind. @@ -20818,19 +22545,19 @@ all instances of @find are replaced. version="0.15.5"> Converts the text representation to an enumerated value. - + line="404">Converts the text representation to an enumerated value. + a #AsInternetKind or %AS_INTERNET_KIND_UNKNOWN for unknown + line="410">a #AsInternetKind or %AS_INTERNET_KIND_UNKNOWN for unknown the string. + line="406">the string. @@ -20841,19 +22568,19 @@ all instances of @find are replaced. version="0.15.5"> Converts the enumerated value to a text representation. - + line="426">Converts the enumerated value to a text representation. + string version of @kind + line="432">string version of @kind the #AsInternetKind. + line="428">the #AsInternetKind. @@ -20863,19 +22590,19 @@ all instances of @find are replaced. version="0.12.10"> Searches the known list of SPDX license exception IDs. + line="177">Searches the known list of SPDX license exception IDs. %TRUE if the string is a valid SPDX license exception ID + line="183">%TRUE if the string is a valid SPDX license exception ID a single SPDX license exception ID, e.g. "GCC-exception-3.1" + line="179">a single SPDX license exception ID, e.g. "GCC-exception-3.1" @@ -20885,20 +22612,20 @@ all instances of @find are replaced. version="0.9.8"> Checks the licence string to check it being a valid licence. + line="204">Checks the licence string to check it being a valid licence. NOTE: SPDX licenses can't typically contain brackets. %TRUE if the icon is a valid "SPDX license" + line="211">%TRUE if the icon is a valid "SPDX license" a SPDX license string, e.g. "CC-BY-3.0 and GFDL-1.3" + line="206">a SPDX license string, e.g. "CC-BY-3.0 and GFDL-1.3" @@ -20930,19 +22657,19 @@ NOTE: SPDX licenses can't typically contain brackets. moved-to="IssueKind.from_string"> Converts the text representation to an enumerated value. - + line="62">Converts the text representation to an enumerated value. + a #AsIssueKind or %AS_ISSUE_KIND_UNKNOWN for unknown + line="68">a #AsIssueKind or %AS_ISSUE_KIND_UNKNOWN for unknown the string. + line="64">the string. @@ -20952,19 +22679,19 @@ NOTE: SPDX licenses can't typically contain brackets. moved-to="IssueKind.to_string"> Converts the enumerated value to an text representation. - + line="44">Converts the enumerated value to an text representation. + string version of @kind + line="50">string version of @kind the %AsIssueKind. + line="46">the %AsIssueKind. @@ -20974,19 +22701,19 @@ NOTE: SPDX licenses can't typically contain brackets. moved-to="IssueSeverity.from_string"> Converts the text representation to an enumerated value. + line="51">Converts the text representation to an enumerated value. a #AsIssueSeverity, or %AS_ISSUE_SEVERITY_UNKNOWN for unknown. + line="57">a #AsIssueSeverity, or %AS_ISSUE_SEVERITY_UNKNOWN for unknown. the string. + line="53">the string. @@ -20996,19 +22723,19 @@ NOTE: SPDX licenses can't typically contain brackets. moved-to="IssueSeverity.to_string"> Converts the enumerated value to an text representation. + line="74">Converts the enumerated value to an text representation. string version of @severity + line="80">string version of @severity the #AsIssueSeverity. + line="76">the #AsIssueSeverity. @@ -21019,19 +22746,19 @@ NOTE: SPDX licenses can't typically contain brackets. version="0.11.0"> Converts the text representation to an enumerated value. - + line="71">Converts the text representation to an enumerated value. + a #AsLaunchableKind or %AS_LAUNCHABLE_KIND_UNKNOWN for unknown + line="77">a #AsLaunchableKind or %AS_LAUNCHABLE_KIND_UNKNOWN for unknown the string. + line="73">the string. @@ -21042,19 +22769,19 @@ NOTE: SPDX licenses can't typically contain brackets. version="0.11.0"> Converts the enumerated value to a text representation. - + line="47">Converts the enumerated value to a text representation. + string version of @kind + line="53">string version of @kind the #AsLaunchableKind. + line="49">the #AsLaunchableKind. @@ -21064,7 +22791,7 @@ NOTE: SPDX licenses can't typically contain brackets. version="0.12.10"> Check if the given license is for free-as-in-freedom software. + line="753">Check if the given license is for free-as-in-freedom software. A free software license is either approved by the Free Software Foundation or the Open Source Initiative. @@ -21080,14 +22807,14 @@ to learn more about the individual licenses and their conditions. %TRUE if the license string contains only free-as-in-freedom licenses. + line="770">%TRUE if the license string contains only free-as-in-freedom licenses. The SPDX license string to test. + line="755">The SPDX license string to test. @@ -21096,7 +22823,7 @@ to learn more about the individual licenses and their conditions. c:identifier="as_license_is_metadata_license"> Check if the metadata license is suitable for mixing with other + line="579">Check if the metadata license is suitable for mixing with other metadata and redistributing the bundled result (this means we prefer permissive licenses here, to not require people shipping catalog metadata to perform a full license review). @@ -21107,7 +22834,7 @@ commonly used to license metadata under. %TRUE if the license contains only permissive licenses suitable + line="591">%TRUE if the license contains only permissive licenses suitable as metadata license. @@ -21115,7 +22842,7 @@ as metadata license. The SPDX license string to test. + line="581">The SPDX license string to test. @@ -21124,7 +22851,7 @@ as metadata license. c:identifier="as_license_is_metadata_license_id"> Tests license ID against the vetted list of licenses that + line="521">Tests license ID against the vetted list of licenses that can be used for metainfo metadata. This function will not work for license expressions, if you need to test an SPDX license expression for compliance, please @@ -21133,14 +22860,14 @@ use %as_license_is_metadata_license insread. %TRUE if the string is a valid metadata license ID. + line="531">%TRUE if the string is a valid metadata license ID. a single SPDX license ID, e.g. "FSFAP" + line="523">a single SPDX license ID, e.g. "FSFAP" @@ -21150,34 +22877,49 @@ use %as_license_is_metadata_license insread. version="0.9.8"> Converts a non-SPDX license into an SPDX format string where possible. + line="412">Converts a non-SPDX license into an SPDX format string where possible. the best-effort SPDX license string + line="418">the best-effort SPDX license string a not-quite SPDX license string, e.g. "GPLv3+" + line="414">a not-quite SPDX license string, e.g. "GPLv3+" - - + Converts XML description markup into other forms of text. + + a newly allocated string, or %NULL on error. + the XML markup to transform. + + The markup style to convert into. + + filename="src/as-utils.c" line="70">Splits up a long line into an array of smaller strings, each being no longer than @line_len. Words are not split. - + moved-to="MergeKind.from_string"> Converts the text representation to an enumerated value. - + line="276">Converts the text representation to an enumerated value. + a #AsMergeKind or %AS_MERGE_KIND_NONE for unknown + line="282">a #AsMergeKind or %AS_MERGE_KIND_NONE for unknown the string. + line="278">the string. @@ -21238,19 +22980,19 @@ than @line_len. Words are not split. moved-to="MergeKind.to_string"> Converts the enumerated value to an text representation. - + line="253">Converts the enumerated value to an text representation. + string version of @kind + line="259">string version of @kind the #AsMergeKind. + line="255">the #AsMergeKind. @@ -21261,7 +23003,7 @@ than @line_len. Words are not split. An error quark. + line="1761">An error quark. @@ -21271,7 +23013,7 @@ than @line_len. Words are not split. An error quark. + line="2663">An error quark. @@ -21280,19 +23022,19 @@ than @line_len. Words are not split. moved-to="ProvidedKind.from_string"> Converts the text representation to an enumerated value. - + line="87">Converts the text representation to an enumerated value. + a #AsProvidedKind or %AS_PROVIDED_KIND_UNKNOWN for unknown + line="93">a #AsProvidedKind or %AS_PROVIDED_KIND_UNKNOWN for unknown the string. + line="89">the string. @@ -21302,22 +23044,22 @@ than @line_len. Words are not split. moved-to="ProvidedKind.to_l10n_string"> Converts the enumerated value to a localized text representation, + line="123">Converts the enumerated value to a localized text representation, using the plural forms (e.g. "Libraries" instead of "Library"). This can be useful when displaying provided items in GUI dialogs. - + Pluralized, l10n string version of @kind + line="132">Pluralized, l10n string version of @kind the #AsProvidedKind. + line="125">the #AsProvidedKind. @@ -21327,42 +23069,87 @@ This can be useful when displaying provided items in GUI dialogs. moved-to="ProvidedKind.to_string"> Converts the enumerated value to a text representation. - + line="51">Converts the enumerated value to a text representation. + string version of @kind + line="57">string version of @kind the #AsProvidedKind. + line="53">the #AsProvidedKind. + + Converts the text representation to an enumerated value. + + + a AsReferenceKind or %AS_REFERENCE_KIND_UNKNOWN for unknown + + + + + the string. + + + + + + Converts the enumerated value to an text representation. + + + string version of @kind + + + + + the %AsReferenceKind. + + + + Converts the text representation to an enumerated value. - + line="186">Converts the text representation to an enumerated value. + a #AsRelationCompare, or %AS_RELATION_COMPARE_UNKNOWN for unknown. + line="192">a #AsRelationCompare, or %AS_RELATION_COMPARE_UNKNOWN for unknown. the string. + line="188">the string. @@ -21373,21 +23160,21 @@ This can be useful when displaying provided items in GUI dialogs. version="0.12.0"> Converts the enumerated value to an text representation. + line="233">Converts the enumerated value to an text representation. The enum is converted into a two-letter identifier ("eq", "ge", etc.) for use in the XML representation. - + string version of @compare + line="241">string version of @compare the #AsRelationCompare. + line="235">the #AsRelationCompare. @@ -21398,22 +23185,22 @@ for use in the XML representation. version="0.12.0"> Converts the enumerated value to an text representation. + line="263">Converts the enumerated value to an text representation. The enum is converted into an identifier consisting of two mathematical comparison operators ("==", ">=", etc.) for use in the YAML representation and user interfaces. - + string version of @compare + line="272">string version of @compare the #AsRelationCompare. + line="265">the #AsRelationCompare. @@ -21425,7 +23212,7 @@ for use in the YAML representation and user interfaces. An error quark. + line="68">An error quark. @@ -21435,19 +23222,19 @@ for use in the YAML representation and user interfaces. version="0.12.0"> Converts the text representation to an enumerated value. - + line="152">Converts the text representation to an enumerated value. + a #AsRelationItemKind or %AS_RELATION_ITEM_KIND_UNKNOWN for unknown + line="158">a #AsRelationItemKind or %AS_RELATION_ITEM_KIND_UNKNOWN for unknown the string. + line="154">the string. @@ -21458,19 +23245,19 @@ for use in the YAML representation and user interfaces. version="0.12.0"> Converts the enumerated value to a text representation. - + line="118">Converts the enumerated value to a text representation. + string version of @kind + line="124">string version of @kind the #AsRelationKind. + line="120">the #AsRelationKind. @@ -21481,19 +23268,19 @@ for use in the YAML representation and user interfaces. version="0.12.0"> Converts the text representation to an enumerated value. - + line="96">Converts the text representation to an enumerated value. + a #AsRelationKind or %AS_RELATION_KIND_UNKNOWN for unknown + line="102">a #AsRelationKind or %AS_RELATION_KIND_UNKNOWN for unknown the string. + line="98">the string. @@ -21504,19 +23291,19 @@ for use in the YAML representation and user interfaces. version="0.12.0"> Converts the enumerated value to a text representation. - + line="74">Converts the enumerated value to a text representation. + string version of @kind + line="80">string version of @kind the #AsRelationKind. + line="76">the #AsRelationKind. @@ -21527,19 +23314,19 @@ for use in the YAML representation and user interfaces. version="0.12.0"> Converts the text representation to an enumerated value. - + line="92">Converts the text representation to an enumerated value. + an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown + line="98">an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown the string. + line="94">the string. @@ -21550,112 +23337,152 @@ for use in the YAML representation and user interfaces. version="0.12.0"> Converts the enumerated value to an text representation. - + line="70">Converts the enumerated value to an text representation. + string version of @kind + line="76">string version of @kind the #AsReleaseKind. + line="72">the #AsReleaseKind. - + Converts the text representation to an enumerated value. - + filename="src/as-release-list.c" + line="144">Returns the #AsRelease at the given index of the array. + +This does not perform bounds checking on the given @index_, +so you are responsible for checking it against the array length. +Use %as_release_list_len to determine the amount of releases +present in the #AsReleaseList container. + + + + a #AsReleaseList + + + the index of the #AsRelease to return + + + + + Converts the text representation to an enumerated value. + an #AsReleaseUrlKind or %AS_RELEASE_URL_KIND_UNKNOWN for unknown - + filename="src/as-release-list.c" + line="80">an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown + the string. + filename="src/as-release-list.c" + line="76">the string. - + Converts the enumerated value to an text representation. - + filename="src/as-release-list.c" + line="54">Converts the enumerated value to an text representation. + string version of @kind + filename="src/as-release-list.c" + line="60">string version of @kind the #AsReleaseUrlKind. - + filename="src/as-release-list.c" + line="56">the #AsReleaseKind. + - + Converts the text representation to an enumerated value. - + filename="src/as-release-list.c" + line="159">Get the amount of release entries present. + + + + a #AsReleaseList + + + + + Converts the text representation to an enumerated value. + an #AsReleaseKind or %AS_RELEASE_KIND_UNKNOWN for unknown - + filename="src/as-release.c" + line="186">an #AsReleaseUrlKind or %AS_RELEASE_URL_KIND_UNKNOWN for unknown + the string. + filename="src/as-release.c" + line="182">the string. - + Converts the enumerated value to an text representation. - + filename="src/as-release.c" + line="162">Converts the enumerated value to an text representation. + string version of @kind + filename="src/as-release.c" + line="168">string version of @kind the #AsReleaseKind. - + filename="src/as-release.c" + line="164">the #AsReleaseUrlKind. + @@ -21664,19 +23491,19 @@ for use in the YAML representation and user interfaces. moved-to="ScreenshotKind.from_string"> Converts the text representation to an enumerated value. + line="111">Converts the text representation to an enumerated value. a %AsScreenshotKind, or %AS_SCREENSHOT_KIND_UNKNOWN if not known. + line="117">a %AsScreenshotKind, or %AS_SCREENSHOT_KIND_UNKNOWN if not known. the string. + line="113">the string. @@ -21686,19 +23513,19 @@ for use in the YAML representation and user interfaces. moved-to="ScreenshotKind.to_string"> Converts the enumerated value to an text representation. + line="131">Converts the enumerated value to an text representation. string version of @kind + line="137">string version of @kind the #AsScreenshotKind. + line="133">the #AsScreenshotKind. @@ -21708,19 +23535,19 @@ for use in the YAML representation and user interfaces. moved-to="SizeKind.from_string"> Converts the text representation to an enumerated value. - + line="70">Converts the text representation to an enumerated value. + an #AsSizeKind or %AS_SIZE_KIND_UNKNOWN for unknown + line="76">an #AsSizeKind or %AS_SIZE_KIND_UNKNOWN for unknown the string. + line="72">the string. @@ -21730,19 +23557,19 @@ for use in the YAML representation and user interfaces. moved-to="SizeKind.to_string"> Converts the enumerated value to an text representation. - + line="52">Converts the enumerated value to an text representation. + string version of @size_kind + line="58">string version of @size_kind the #AsSizeKind. + line="54">the #AsSizeKind. @@ -21752,19 +23579,19 @@ for use in the YAML representation and user interfaces. version="0.9.8"> De-tokenizes the SPDX licenses into a string. + line="364">De-tokenizes the SPDX licenses into a string. string, or %NULL for invalid + line="370">string, or %NULL for invalid license tokens, typically from as_spdx_license_tokenize() + line="366">license tokens, typically from as_spdx_license_tokenize() @@ -21774,7 +23601,7 @@ for use in the YAML representation and user interfaces. version="0.9.8"> Tokenizes the SPDX license string (or any simarly formatted string) + line="304">Tokenizes the SPDX license string (or any simarly formatted string) into parts. Any license parts of the string e.g. "LGPL-2.0+" are prefexed with "@", the conjunctive replaced with "&", the disjunctive replaced with "|" and the WITH operator for license exceptions replaced with "^". @@ -21784,7 +23611,7 @@ appended into single tokens where possible. array of strings, or %NULL for invalid + line="315">array of strings, or %NULL for invalid @@ -21793,7 +23620,7 @@ appended into single tokens where possible. a license string, e.g. "LGPLv2+ and (QPL or GPLv2) and MIT" + line="306">a license string, e.g. "LGPLv2+ and (QPL or GPLv2) and MIT" @@ -21803,19 +23630,19 @@ appended into single tokens where possible. moved-to="SuggestedKind.from_string"> Converts the text representation to an enumerated value. - + line="64">Converts the text representation to an enumerated value. + a #AsSuggestedKind or %AS_SUGGESTED_KIND_UNKNOWN for unknown + line="70">a #AsSuggestedKind or %AS_SUGGESTED_KIND_UNKNOWN for unknown the string. + line="66">the string. @@ -21825,19 +23652,19 @@ appended into single tokens where possible. moved-to="SuggestedKind.to_string"> Converts the enumerated value to an text representation. - + line="45">Converts the enumerated value to an text representation. + string version of @kind + line="51">string version of @kind the %AsSuggestedKind. + line="47">the %AsSuggestedKind. @@ -21858,19 +23685,19 @@ appended into single tokens where possible. moved-to="TranslationKind.from_string"> Converts the text representation to an enumerated value. - + line="68">Converts the text representation to an enumerated value. + a #AsTranslationKind or %AS_TRANSLATION_KIND_UNKNOWN for unknown + line="74">a #AsTranslationKind or %AS_TRANSLATION_KIND_UNKNOWN for unknown the string. + line="70">the string. @@ -21880,19 +23707,19 @@ appended into single tokens where possible. moved-to="TranslationKind.to_string"> Converts the enumerated value to a text representation. - + line="50">Converts the enumerated value to a text representation. + string version of @kind + line="56">string version of @kind the #AsTranslationKind. + line="52">the #AsTranslationKind. @@ -21902,20 +23729,20 @@ appended into single tokens where possible. moved-to="UrgencyKind.from_string" version="0.6.5"> Converts the text representation to an enumerated value. - + filename="src/as-release.c" + line="138">Converts the text representation to an enumerated value. + a %AsUrgencyKind or %AS_URGENCY_KIND_UNKNOWN for unknown + filename="src/as-release.c" + line="144">a %AsUrgencyKind or %AS_URGENCY_KIND_UNKNOWN for unknown the string. + filename="src/as-release.c" + line="140">the string. @@ -21925,20 +23752,20 @@ appended into single tokens where possible. moved-to="UrgencyKind.to_string" version="0.6.5"> Converts the enumerated value to an text representation. - + filename="src/as-release.c" + line="114">Converts the enumerated value to an text representation. + string version of @urgency_kind + filename="src/as-release.c" + line="120">string version of @urgency_kind the %AsUrgencyKind. + filename="src/as-release.c" + line="116">the %AsUrgencyKind. @@ -21947,20 +23774,20 @@ appended into single tokens where possible. c:identifier="as_url_kind_from_string" moved-to="UrlKind.from_string"> Converts the text representation to an enumerated value. - + filename="src/as-component.c" + line="365">Converts the text representation to an enumerated value. + a #AsUrlKind or %AS_URL_KIND_UNKNOWN for unknown + filename="src/as-component.c" + line="371">a #AsUrlKind or %AS_URL_KIND_UNKNOWN for unknown the string. + filename="src/as-component.c" + line="367">the string. @@ -21969,20 +23796,20 @@ appended into single tokens where possible. c:identifier="as_url_kind_to_string" moved-to="UrlKind.to_string"> Converts the enumerated value to an text representation. - + filename="src/as-component.c" + line="333">Converts the enumerated value to an text representation. + string version of @url_kind + filename="src/as-component.c" + line="339">string version of @url_kind the %AsUrlKind. + filename="src/as-component.c" + line="335">the %AsUrlKind. @@ -21992,8 +23819,8 @@ appended into single tokens where possible. version="0.14.0"> Builds an identifier string unique to the individual dataset using the supplied information. - + line="1769">Builds an identifier string unique to the individual dataset using the supplied information. + @@ -22001,31 +23828,31 @@ appended into single tokens where possible. Scope of the metadata as #AsComponentScope e.g. %AS_COMPONENT_SCOPE_SYSTEM + line="1771">Scope of the metadata as #AsComponentScope e.g. %AS_COMPONENT_SCOPE_SYSTEM Bundling system providing this data, e.g. 'package' or 'flatpak' + line="1772">Bundling system providing this data, e.g. 'package' or 'flatpak' Origin string, e.g. 'os' or 'gnome-apps-nightly' + line="1773">Origin string, e.g. 'os' or 'gnome-apps-nightly' AppStream component ID, e.g. 'org.freedesktop.appstream.cli' + line="1774">AppStream component ID, e.g. 'org.freedesktop.appstream.cli' Branch, e.g. '3-20' or 'master' + line="1775">Branch, e.g. '3-20' or 'master' @@ -22035,25 +23862,25 @@ appended into single tokens where possible. version="0.14.0"> Checks two component data IDs for equality allowing globs to match. - + line="1925">Checks two component data IDs for equality allowing globs to match. + %TRUE if the ID's should be considered equal. + line="1932">%TRUE if the ID's should be considered equal. a data ID + line="1927">a data ID another data ID + line="1928">another data ID @@ -22062,8 +23889,8 @@ appended into single tokens where possible. c:identifier="as_utils_data_id_get_cid"> Get the component-id part of the data-id. - + line="1836">Get the component-id part of the data-id. + @@ -22071,7 +23898,7 @@ appended into single tokens where possible. The data-id. + line="1838">The data-id. @@ -22081,25 +23908,25 @@ appended into single tokens where possible. version="0.14.0"> Converts a data-id to a hash value. + line="1947">Converts a data-id to a hash value. This function implements the widely used DJB hash on the ID subset of the data-id string. It can be passed to g_hash_table_new() as the hash_func parameter, when using non-NULL strings or unique_ids as keys in a GHashTable. - + a hash value corresponding to the key + line="1959">a hash value corresponding to the key a data ID + line="1949">a data ID @@ -22109,32 +23936,32 @@ when using non-NULL strings or unique_ids as keys in a GHashTable. version="0.14.0"> Checks two data IDs for equality allowing globs to match, whilst also + line="1868">Checks two data IDs for equality allowing globs to match, whilst also allowing clients to whitelist sections that have to match. - + %TRUE if the IDs should be considered equal. + line="1877">%TRUE if the IDs should be considered equal. a data ID + line="1870">a data ID another data ID + line="1871">another data ID a #AsDataIdMatchFlags bitfield, e.g. %AS_DATA_ID_MATCH_FLAG_ID + line="1872">a #AsDataIdMatchFlags bitfield, e.g. %AS_DATA_ID_MATCH_FLAG_ID @@ -22144,20 +23971,20 @@ allowing clients to whitelist sections that have to match. version="0.14.0"> Checks if a data ID is valid i.e. has the correct number of + line="1811">Checks if a data ID is valid i.e. has the correct number of sections. - + %TRUE if the ID is valid + line="1818">%TRUE if the ID is valid a component data ID + line="1813">a component data ID @@ -22173,24 +24000,93 @@ sections. + + Get a human-readable, translated name of the desktop environment +represented by the given ID. + + + A localized name of the DE, or %NULL if none available. + + + + + a desktop environment id. + + + + + + Get a human-readable, translated name of the combination +of GUI environment and style. E.g. "plasma:dark" becomes "Plasma (Dark)". + + + A localized name of the environment style, or %NULL if none available. + + + + + a GUI environment style ID, e.g. "pantheon:dark" + + + + + + Retrieve the raw search token weight for the given tag name that AppStream uses +internally for searching. +This can be used to implement separate, but compatible search logic. + + + The tag weight used in (fulltext) searches. 0 for lowest weight/unused. + + + + + A tag name in a component element, e.g. "name" or "summary" or "keyword" + + + + Guess the #AsComponentScope that applies to a given path. - + line="2906">Guess the #AsComponentScope that applies to a given path. + the #AsComponentScope + line="2912">the #AsComponentScope The filename to test. + line="2908">The filename to test. @@ -22201,53 +24097,65 @@ sections. throws="1"> Installs an AppStream MetaInfo, AppStream Metadata Catalog or AppStream Icon tarball file + line="2527">Installs an AppStream MetaInfo, AppStream Metadata Catalog or AppStream Icon tarball file to the right place on the filesystem. Please note that this function does almost no validation and may guess missing values such as icon sizes and origin names. Ensure your metadata is good before installing it. - + %TRUE for success, %FALSE if error is set + line="2541">%TRUE for success, %FALSE if error is set the #AsMetadataLocation, e.g. %AS_METADATA_LOCATION_CACHE + line="2529">the #AsMetadataLocation, e.g. %AS_METADATA_LOCATION_CACHE the full path of the file to install + line="2530">the full path of the file to install the origin to use for the installation, or %NULL + line="2531">the origin to use for the installation, or %NULL the destdir to use, or %NULL + line="2532">the destdir to use, or %NULL - + c:identifier="as_utils_is_category_name" + version="0.9.7"> + Searches the known list of registered XDG category names. +See https://specifications.freedesktop.org/menu-spec/menu-spec-1.0.html#category-registry +for a reference. + + %TRUE if the category name is valid + a XDG category name, e.g. "ProjectManagement" @@ -22257,20 +24165,42 @@ Ensure your metadata is good before installing it. version="0.10.0"> Searches the known list of desktop environments AppStream -knows about. - + line="1403">Checks if the submitted desktop environment ID is +known and valid. + + + %TRUE if the desktop-id is valid + + + + + a desktop environment id. + + + + + + Checks if the given identifier is a valid, known GUI environment style. + %TRUE if the desktop-id is valid + line="1461">%TRUE if the environment-style ID is is valid - + a desktop environment id. + line="1457">a GUI environment style ID, e.g. "pantheon:dark" @@ -22280,20 +24210,20 @@ knows about. version="0.14.0"> Test if the given string is a valid platform triplet recognized by + line="1635">Test if the given string is a valid platform triplet recognized by AppStream. - + %TRUE if triplet is valid. + line="1642">%TRUE if triplet is valid. a platform triplet. + line="1637">a platform triplet. @@ -22303,20 +24233,20 @@ AppStream. version="0.9.8"> Searches the known list of TLDs we allow for AppStream IDs. + line="1369">Searches the known list of TLDs we allow for AppStream IDs. This excludes internationalized names. - + %TRUE if the TLD is valid + line="1376">%TRUE if the TLD is valid a top-level domain without dot, e.g. "de", "org", "name" + line="1371">a top-level domain without dot, e.g. "de", "org", "name" @@ -22326,14 +24256,14 @@ This excludes internationalized names. version="0.9.5"> Calculates if one locale is compatible with another. + line="1195">Calculates if one locale is compatible with another. When doing the calculation the locale and language code is taken into account if possible. - + %TRUE if the locale is compatible. + line="1204">%TRUE if the locale is compatible. @@ -22343,7 +24273,7 @@ account if possible. allow-none="1"> a BCP47 or POSIX locale string, or %NULL + line="1197">a BCP47 or POSIX locale string, or %NULL allow-none="1"> a BCP47 or POSIX locale string, or %NULL + line="1198">a BCP47 or POSIX locale string, or %NULL @@ -22361,13 +24291,13 @@ account if possible. c:identifier="as_utils_posix_locale_to_bcp47"> Converts a POSIX locale string to the corresponding IETF BCP47 format. + line="704">Converts a POSIX locale string to the corresponding IETF BCP47 format. If the given locale is already in BCP47 format, no change will be done. - + A locale string, free with g_free() + line="710">A locale string, free with g_free() @@ -22380,8 +24310,8 @@ If the given locale is already in BCP47 format, no change will be done. c:identifier="as_utils_sort_components_into_categories"> Sorts all components in @cpts into the #AsCategory categories listed in @categories. - + line="1705">Sorts all components in @cpts into the #AsCategory categories listed in @categories. + @@ -22389,7 +24319,7 @@ If the given locale is already in BCP47 format, no change will be done. List of components. + line="1707">List of components. @@ -22397,7 +24327,7 @@ If the given locale is already in BCP47 format, no change will be done. List of categories to sort components into. + line="1708">List of categories to sort components into. @@ -22405,7 +24335,7 @@ If the given locale is already in BCP47 format, no change will be done. Whether to check for duplicates. + line="1709">Whether to check for duplicates. @@ -22424,13 +24354,13 @@ If the given locale is already in BCP47 format, no change will be done. Compare alpha and numeric segments of two software versions, + line="144">Compare alpha and numeric segments of two software versions, considering @flags. - + >>0 if a is newer than b; + line="153">>>0 if a is newer than b; 0 if a and b are the same version; <<0 if b is newer than a @@ -22439,19 +24369,19 @@ considering @flags. First version number + line="146">First version number Second version number + line="147">Second version number Flags, e.g. %AS_VERCMP_FLAG_NONE + line="148">Flags, e.g. %AS_VERCMP_FLAG_NONE @@ -22459,12 +24389,12 @@ considering @flags. Compare alpha and numeric segments of two software versions. - + line="208">Compare alpha and numeric segments of two software versions. + >>0 if a is newer than b; + line="215">>>0 if a is newer than b; 0 if a and b are the same version; <<0 if b is newer than a @@ -22473,13 +24403,13 @@ considering @flags. First version number + line="210">First version number Second version number + line="211">Second version number @@ -22489,37 +24419,37 @@ considering @flags. version="0.16.0"> Compare two version numbers and check if the given version comparator matches. - + line="225">Compare two version numbers and check if the given version comparator matches. + %TRUE if the version comparison matches, %FALSE otherwise. + line="234">%TRUE if the version comparison matches, %FALSE otherwise. first version number + line="227">first version number the comparison operator + line="228">the comparison operator second version number + line="229">second version number the #AsVercmpFlags to use + line="230">the #AsVercmpFlags to use @@ -22544,19 +24474,19 @@ at runtime as a string. moved-to="VideoCodecKind.from_string"> Converts the text representation to an enumerated value. - + line="73">Converts the text representation to an enumerated value. + a #AsVideoCodecKind, or %AS_VIDEO_CODEC_KIND_UNKNOWN for unknown. + line="79">a #AsVideoCodecKind, or %AS_VIDEO_CODEC_KIND_UNKNOWN for unknown. the string. + line="75">the string. @@ -22566,19 +24496,19 @@ at runtime as a string. moved-to="VideoCodecKind.to_string"> Converts the enumerated value to an text representation. - + line="92">Converts the enumerated value to an text representation. + string version of @codec + line="98">string version of @codec the #AsVideoCodecKind. + line="94">the #AsVideoCodecKind. @@ -22588,19 +24518,19 @@ at runtime as a string. moved-to="VideoContainerKind.from_string"> Converts the text representation to an enumerated value. - + line="111">Converts the text representation to an enumerated value. + a #AsVideoContainerKind, or %AS_VIDEO_CONTAINER_KIND_UNKNOWN for unknown. + line="117">a #AsVideoContainerKind, or %AS_VIDEO_CONTAINER_KIND_UNKNOWN for unknown. the string. + line="113">the string. @@ -22610,19 +24540,19 @@ at runtime as a string. moved-to="VideoContainerKind.to_string"> Converts the enumerated value to an text representation. - + line="132">Converts the enumerated value to an text representation. + string version of @kind + line="138">string version of @kind the #AsVideoContainerKind. + line="134">the #AsVideoContainerKind. diff --git a/girs/AppStreamGlib-1.0.gir b/girs/AppStreamGlib-1.0.gir index d29be61bd..ba4b0aa53 100644 --- a/girs/AppStreamGlib-1.0.gir +++ b/girs/AppStreamGlib-1.0.gir @@ -14366,7 +14366,8 @@ taken place. + throws="1" + glib:async-func="load_async"> Loads the store from the default locations. @@ -14403,7 +14404,9 @@ taken place. + version="0.7.11" + glib:finish-func="load_finish" + glib:sync-func="load"> Asynchronously loads the store from the default locations. @@ -14487,7 +14490,8 @@ taken place. + throws="1" + glib:async-func="load_path_async"> Loads the store from a specific path. @@ -14524,7 +14528,9 @@ taken place. + version="0.7.11" + glib:finish-func="load_path_finish" + glib:sync-func="load_path"> Asynchronously loads the store from a specific path. diff --git a/girs/ArrowDataset-1.0.gir b/girs/ArrowDataset-1.0.gir index 612d66da5..59ffa97d8 100644 --- a/girs/ArrowDataset-1.0.gir +++ b/girs/ArrowDataset-1.0.gir @@ -8,9 +8,10 @@ and/or use gtk-doc annotations. --> xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> + glib:type-name="GADatasetCSVFileFormat" glib:get-type="gadataset_csv_file_format_get_type" glib:type-struct="CSVFileFormatClass"> - + - The newly created CSV file format. @@ -41,8 +41,7 @@ and/or use gtk-doc annotations. --> - + @@ -55,15 +54,16 @@ and/or use gtk-doc annotations. --> glib:type-name="GADatasetDataset" glib:get-type="gadataset_dataset_get_type" glib:type-struct="DatasetClass"> - + - + A newly created #GADatasetScannerBuilder on success, %NULL on error. @@ -71,7 +71,7 @@ and/or use gtk-doc annotations. --> A #GADatasetDataset. @@ -80,10 +80,10 @@ and/or use gtk-doc annotations. --> - + The type name of @dataset. It should be freed with g_free() when no longer needed. @@ -92,7 +92,7 @@ and/or use gtk-doc annotations. --> A #GADatasetDataset. @@ -102,10 +102,10 @@ and/or use gtk-doc annotations. --> c:identifier="gadataset_dataset_to_table" version="5.0.0" throws="1"> - + A loaded #GArrowTable on success, %NULL on error. @@ -113,7 +113,7 @@ and/or use gtk-doc annotations. --> A #GADatasetDataset. @@ -133,7 +133,8 @@ and/or use gtk-doc annotations. --> - + @@ -146,28 +147,37 @@ and/or use gtk-doc annotations. --> glib:type-name="GADatasetDatasetFactory" glib:get-type="gadataset_dataset_factory_get_type" glib:type-struct="DatasetFactoryClass"> - + - + + filename="arrow-dataset-glib/dataset-factory.cpp" + line="324"> A newly created #GADatasetDataset on success, %NULL on error. A #GADatasetDatasetFactory. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="320">A #GADatasetDatasetFactory. + + A #GADatasetFinishOptions. + + - + @@ -197,18 +207,18 @@ and/or use gtk-doc annotations. --> glib:type-name="GADatasetDirectoryPartitioning" glib:get-type="gadataset_directory_partitioning_get_type" glib:type-struct="DirectoryPartitioningClass"> - + - + The newly created #GADatasetDirectoryPartitioning on success, + filename="arrow-dataset-glib/partitioning.cpp" + line="539">The newly created #GADatasetDirectoryPartitioning on success, %NULL on error. @@ -216,8 +226,8 @@ and/or use gtk-doc annotations. --> A #GArrowSchema that describes all partitioned segments. + filename="arrow-dataset-glib/partitioning.cpp" + line="533">A #GArrowSchema that describes all partitioned segments. nullable="1" allow-none="1"> A list of #GArrowArray + filename="arrow-dataset-glib/partitioning.cpp" + line="534">A list of #GArrowArray for dictionary data types in @schema. @@ -237,10 +247,10 @@ and/or use gtk-doc annotations. --> nullable="1" allow-none="1"> A #GADatasetPartitioningOptions. - + filename="arrow-dataset-glib/partitioning.cpp" + line="536">A #GADatasetKeyValuePartitioningOptions. + @@ -252,8 +262,8 @@ and/or use gtk-doc annotations. --> - + @@ -266,29 +276,28 @@ and/or use gtk-doc annotations. --> glib:type-name="GADatasetFileFormat" glib:get-type="gadataset_file_format_get_type" glib:type-struct="FileFormatClass"> - + - %TRUE if they are the same content file format, %FALSE otherwise. A #GADatasetFileFormat. A #GADatasetFileFormat to be compared. @@ -297,18 +306,18 @@ and/or use gtk-doc annotations. --> - The default #GADatasetFileWriteOptions of @format. A #GADatasetFileFormat. @@ -317,11 +326,11 @@ and/or use gtk-doc annotations. --> - The type name of @format. It should be freed with g_free() when no longer needed. @@ -330,7 +339,7 @@ and/or use gtk-doc annotations. --> A #GADatasetFileFormat. @@ -340,11 +349,11 @@ and/or use gtk-doc annotations. --> c:identifier="gadataset_file_format_open_writer" version="6.0.0" throws="1"> - The newly created #GADatasetFileWriter of @format on success, %NULL on error. @@ -352,37 +361,37 @@ and/or use gtk-doc annotations. --> A #GADatasetFileFormat. A #GArrowOutputStream. The #GArrowFileSystem of @destination. The path of @destination. A #GArrowSchema that is used by written record batches. A #GADatasetFileWriteOptions. @@ -402,8 +411,7 @@ and/or use gtk-doc annotations. --> - + @@ -415,28 +423,28 @@ and/or use gtk-doc annotations. --> glib:type-name="GADatasetFileSystemDataset" glib:get-type="gadataset_file_system_dataset_get_type" glib:type-struct="FileSystemDatasetClass"> - + - + %TRUE on success, %FALSE on error. A #GADatasetScanner that produces data to be written. A #GADatasetFileSystemDatasetWriteOptions. @@ -449,7 +457,7 @@ and/or use gtk-doc annotations. --> construct-only="1" transfer-ownership="none"> File system of the dataset. @@ -459,7 +467,7 @@ and/or use gtk-doc annotations. --> construct-only="1" transfer-ownership="none"> Format of the dataset. @@ -469,7 +477,7 @@ and/or use gtk-doc annotations. --> construct-only="1" transfer-ownership="none"> Partitioning of the dataset. @@ -480,7 +488,7 @@ and/or use gtk-doc annotations. --> - + @@ -492,12 +500,12 @@ and/or use gtk-doc annotations. --> glib:type-name="GADatasetFileSystemDatasetFactory" glib:get-type="gadataset_file_system_dataset_factory_get_type" glib:type-struct="FileSystemDatasetFactoryClass"> - + - + @@ -512,26 +520,26 @@ and/or use gtk-doc annotations. --> c:identifier="gadataset_file_system_dataset_factory_add_path" version="5.0.0" throws="1"> - + %TRUE on success, %FALSE otherwise. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="652">%TRUE on success, %FALSE otherwise. A #GADatasetFileSystemDatasetFactory. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="648">A #GADatasetFileSystemDatasetFactory. A path to be added. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="649">A path to be added. @@ -540,49 +548,58 @@ and/or use gtk-doc annotations. --> c:identifier="gadataset_file_system_dataset_factory_finish" version="5.0.0" throws="1"> - + + filename="arrow-dataset-glib/dataset-factory.cpp" + line="686"> A newly created #GADatasetFileSystemDataset on success, %NULL on error. A #GADatasetFileSystemDatasetFactory. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="682">A #GADatasetFileSystemDatasetFactory. + + A #GADatasetFinishOptions. + + - + %TRUE on success, %FALSE otherwise. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="582">%TRUE on success, %FALSE otherwise. A #GADatasetFileSystemDatasetFactory. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="578">A #GADatasetFileSystemDatasetFactory. A #GArrowFileSystem. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="579">A #GArrowFileSystem. @@ -591,34 +608,34 @@ and/or use gtk-doc annotations. --> c:identifier="gadataset_file_system_dataset_factory_set_file_system_uri" version="5.0.0" throws="1"> - + %TRUE on success, %FALSE otherwise. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="611">%TRUE on success, %FALSE otherwise. A #GADatasetFileSystemDatasetFactory. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="607">A #GADatasetFileSystemDatasetFactory. An URI for file system. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="608">An URI for file system. File system passed to #GADatasetFileSystemDataset. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="513">File system passed to #GADatasetFileSystemDataset. construct-only="1" transfer-ownership="none"> Format passed to #GADatasetFileSystemDataset. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="498">Format passed to #GADatasetFileSystemDataset. + transfer-ownership="none" + default-value="NULL"> Partition base directory used by #GADatasetFileSystemDataset. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="541">Partition base directory used by #GADatasetFileSystemDataset. writable="1" transfer-ownership="none"> Partitioning used by #GADatasetFileSystemDataset. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="527">Partitioning used by #GADatasetFileSystemDataset. @@ -656,8 +674,8 @@ and/or use gtk-doc annotations. --> - + @@ -670,28 +688,32 @@ and/or use gtk-doc annotations. --> glib:type-name="GADatasetFileSystemDatasetWriteOptions" glib:get-type="gadataset_file_system_dataset_write_options_get_type" glib:type-struct="FileSystemDatasetWriteOptionsClass"> - + - + The newly created #GADatasetFileSystemDatasetWriteOptions. - + + transfer-ownership="none" + default-value="NULL"> Template string used to generate fragment base names. {i} will be replaced by an auto incremented integer. @@ -707,9 +729,10 @@ replaced by an auto incremented integer. + transfer-ownership="none" + default-value="1024"> Maximum number of partitions any batch may be written into. @@ -718,7 +741,7 @@ replaced by an auto incremented integer. writable="1" transfer-ownership="none"> #GADatasetPartitioning used to generate fragment paths. @@ -729,7 +752,7 @@ replaced by an auto incremented integer. - + @@ -741,8 +764,7 @@ replaced by an auto incremented integer. glib:type-name="GADatasetFileWriteOptions" glib:get-type="gadataset_file_write_options_get_type" glib:type-struct="FileWriteOptionsClass"> - + - + @@ -770,24 +791,23 @@ replaced by an auto incremented integer. glib:type-name="GADatasetFileWriter" glib:get-type="gadataset_file_writer_get_type" glib:type-struct="FileWriterClass"> - + - %TRUE on success, %FALSE on error. A #GADatasetFileWriter. @@ -797,24 +817,24 @@ replaced by an auto incremented integer. c:identifier="gadataset_file_writer_write_record_batch" version="6.0.0" throws="1"> - %TRUE on success, %FALSE on error. A #GADatasetFileWriter. A #GArrowRecordBatch to be written. @@ -824,24 +844,24 @@ replaced by an auto incremented integer. c:identifier="gadataset_file_writer_write_record_batch_reader" version="6.0.0" throws="1"> - %TRUE on success, %FALSE on error. A #GADatasetFileWriter. A #GArrowRecordBatchReader to be written. @@ -862,8 +882,77 @@ replaced by an auto incremented integer. - + + + + + + + + + + + A newly created #GADatasetDataset. + + + + + + + + The number of fragments to be used to inspect schema. + + + + The schema to finalize the dataset's schema. + + + + Whether validate fragments against the given schema or not. + + + + + + + + @@ -876,7 +965,7 @@ replaced by an auto incremented integer. glib:type-name="GADatasetFragment" glib:get-type="gadataset_fragment_get_type" glib:type-struct="FragmentClass"> - + - + + + + + + + The newly created #GADatasetHivePartitioning on success, + %NULL on error. + + + + + A #GArrowSchema that describes all partitioned segments. + + + + A list of #GArrowArray + for dictionary data types in @schema. + + + + + + A #GADatasetHivePartitioningOptions. + + + + + + + + The fallback string for null. + + It should be freed with g_free() when no longer needed. + + + + + + + + + + + + + + + + + + + + + + + + The newly created #GADatasetHivePartitioningOptions. + + + + + The fallback string for null. This is used only by +#GADatasetHivePartitioning. + + + + + + + + + + + + glib:type-name="GADatasetIPCFileFormat" glib:get-type="gadataset_ipc_file_format_get_type" glib:type-struct="IPCFileFormatClass"> - + - The newly created IPC file format. @@ -924,8 +1147,7 @@ replaced by an auto incremented integer. - + @@ -937,28 +1159,27 @@ replaced by an auto incremented integer. glib:type-name="GADatasetInMemoryFragment" glib:get-type="gadataset_in_memory_fragment_get_type" glib:type-struct="InMemoryFragmentClass"> - + - + A newly created #GADatasetInMemoryFragment. A #GArrowSchema. The record batches of the table. @@ -966,7 +1187,7 @@ replaced by an auto incremented integer. The number of record batches. @@ -979,7 +1200,7 @@ replaced by an auto incremented integer. - + @@ -988,11 +1209,12 @@ replaced by an auto incremented integer. c:symbol-prefix="key_value_partitioning" c:type="GADatasetKeyValuePartitioning" parent="Partitioning" + abstract="1" glib:type-name="GADatasetKeyValuePartitioning" glib:get-type="gadataset_key_value_partitioning_get_type" glib:type-struct="KeyValuePartitioningClass"> - + @@ -1000,12 +1222,56 @@ replaced by an auto incremented integer. - + + + + + + + The newly created #GADatasetKeyValuePartitioningOptions. + + + + + After splitting a path into components, decode the path +components before parsing according to this scheme. + + + + + + + + + + + + glib:type-name="GADatasetParquetFileFormat" glib:get-type="gadataset_parquet_file_format_get_type" glib:type-struct="ParquetFileFormatClass"> - + - The newly created Parquet file format. @@ -1034,8 +1299,7 @@ replaced by an auto incremented integer. - + @@ -1044,33 +1308,33 @@ replaced by an auto incremented integer. c:symbol-prefix="partitioning" c:type="GADatasetPartitioning" parent="GObject.Object" + abstract="1" glib:type-name="GADatasetPartitioning" glib:get-type="gadataset_partitioning_get_type" glib:type-struct="PartitioningClass"> - - - + + + The newly created #GADatasetPartitioning that doesn't - partition. + filename="arrow-dataset-glib/partitioning.cpp" + line="348">The newly created #GADatasetPartitioning + that doesn't partition. - + - + The type name of @partitioning. + filename="arrow-dataset-glib/partitioning.cpp" + line="329">The type name of @partitioning. It should be freed with g_free() when no longer needed. @@ -1078,8 +1342,8 @@ replaced by an auto incremented integer. A #GADatasetPartitioning. + filename="arrow-dataset-glib/partitioning.cpp" + line="327">A #GADatasetPartitioning. @@ -1098,41 +1362,40 @@ replaced by an auto incremented integer. - + - - + glib:type-name="GADatasetPartitioningFactoryOptions" + glib:get-type="gadataset_partitioning_factory_options_get_type" + glib:type-struct="PartitioningFactoryOptionsClass"> + - + The newly created #GADatasetPartitioningOptions. - + filename="arrow-dataset-glib/partitioning.cpp" + line="242">The newly created #GADatasetPartitioningFactoryOptions. + + transfer-ownership="none" + default-value="FALSE"> When inferring a schema for partition fields, yield dictionary + filename="arrow-dataset-glib/partitioning.cpp" + line="177">When inferring a schema for partition fields, yield dictionary encoded types instead of plain. This can be more efficient when materializing virtual columns, and Expressions parsed by the finished Partitioning will include dictionaries of all unique @@ -1140,23 +1403,24 @@ inspected values for each field. Optionally, an expected schema can be provided, in which case + filename="arrow-dataset-glib/partitioning.cpp" + line="198">Optionally, an expected schema can be provided, in which case inference will only check discovered fields against the schema and update internal state (such as dictionaries). + transfer-ownership="none" + default-value="GADATASET_SEGMENT_ENCODING_URI"> After splitting a path into components, decode the path + filename="arrow-dataset-glib/partitioning.cpp" + line="217">After splitting a path into components, decode the path components before parsing according to this scheme. @@ -1164,11 +1428,10 @@ components before parsing according to this scheme. - - + + @@ -1180,15 +1443,15 @@ components before parsing according to this scheme. glib:type-name="GADatasetScanner" glib:get-type="gadataset_scanner_get_type" glib:type-struct="ScannerClass"> - + - + A newly created #GArrowTable on success, %NULL on error. @@ -1196,7 +1459,7 @@ components before parsing according to this scheme. A #GADatasetScanner. @@ -1220,15 +1483,15 @@ components before parsing according to this scheme. glib:type-name="GADatasetScannerBuilder" glib:get-type="gadataset_scanner_builder_get_type" glib:type-struct="ScannerBuilderClass"> - + - + A newly created #GADatasetScannerBuilder on success, %NULL on error. @@ -1236,7 +1499,7 @@ components before parsing according to this scheme. A #GADatasetDataset to be scanned. @@ -1245,17 +1508,17 @@ components before parsing according to this scheme. - + A newly created #GADatasetScannerBuilder. A #GArrowRecordBatchReader that produces record batches. @@ -1266,10 +1529,10 @@ components before parsing according to this scheme. c:identifier="gadataset_scanner_builder_finish" version="5.0.0" throws="1"> - + A newly created #GADatasetScanner on success, %NULL on error. @@ -1277,7 +1540,7 @@ components before parsing according to this scheme. A #GADatasetScannerBuilder. @@ -1287,23 +1550,23 @@ components before parsing according to this scheme. c:identifier="gadataset_scanner_builder_set_filter" version="6.0.0" throws="1"> - + %TRUE on success, %FALSE on error. A #GADatasetScannerBuilder. A #GArrowExpression to filter rows with. @@ -1323,7 +1586,7 @@ components before parsing according to this scheme. - + @@ -1331,7 +1594,7 @@ components before parsing according to this scheme. - + @@ -1342,7 +1605,7 @@ components before parsing according to this scheme. glib:get-type="gadataset_segment_encoding_get_type" c:type="GADatasetSegmentEncoding"> They are corresponding to `arrow::dataset::SegmentEncoding` values. glib:nick="none" glib:name="GADATASET_SEGMENT_ENCODING_NONE"> No encoding. glib:nick="uri" glib:name="GADATASET_SEGMENT_ENCODING_URI"> Segment values are URL-encoded. #GADatasetDataset is a base class for datasets. #GADatasetFileSystemDataset is a class for file system dataset. @@ -1375,15 +1638,17 @@ write a dataset to file system dataset. #GADatasetDatasetFactory is a base class for dataset factories. + filename="arrow-dataset-glib/dataset-factory.cpp" + line="31">#GADatasetFinishOptions is a class for gadataset_factory_finish(). + +#GADatasetDatasetFactory is a base class for dataset factories. #GADatasetFileSystemDatasetFactory is a class for #GADatasetFileSystemDataset factory. #GADatasetFileWriteOptions is a class for options to write a file of this format. @@ -1399,28 +1664,38 @@ of this format. #GADatasetFragment is a base class for all fragment classes. #GADatasetInMemoryFragment is a class for in-memory fragment. #GADatasetPartitioningOptions is a class for partitioning options. + filename="arrow-dataset-glib/partitioning.cpp" + line="29">#GADatasetPartitioningFactoryOptions is a class for partitioning +factory options. #GADatasetPartitioning is a base class for partitioning classes such as #GADatasetDirectoryPartitioning. +#GADatasetKeyValuePartitioningOptions is a class for key-value +partitioning options. + #GADatasetKeyValuePartitioning is a base class for key-value style partitioning classes such as #GADatasetDirectoryPartitioning. #GADatasetDirectoryPartitioning is a class for partitioning that -uses directory structure. +uses directory structure. + +#GADatasetHivePartitioningOptions is a class for Hive-style +partitioning options. + +#GADatasetHivePartitioning is a class for partitioning that +uses Hive-style partitioning. #GADatasetScanner is a class for scanning dataset. #GADatasetScannerBuilder is a class for building a scanner. diff --git a/girs/ArrowFlight-1.0.gir b/girs/ArrowFlight-1.0.gir index 64c3eebd8..93c2b4f3f 100644 --- a/girs/ArrowFlight-1.0.gir +++ b/girs/ArrowFlight-1.0.gir @@ -8,9 +8,10 @@ and/or use gtk-doc annotations. --> xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> + glib:type-name="GAFlightCallOptions" glib:get-type="gaflight_call_options_get_type" glib:type-struct="CallOptionsClass"> - + - + The newly created options for a call. + + Add a header. + + + + + + + A #GAFlightCallOptions. + + + + A header name. + + + + A header value. + + + + + + Clear all headers. + + + + + + + A #GAFlightCallOptions. + + + + + + Iterates over all headers in the options. + + + + + + + A #GAFlightCallOptions. + + + + The user's callback function. + + + + Data for @func. + + + + @@ -39,7 +127,7 @@ and/or use gtk-doc annotations. --> - + @@ -51,23 +139,23 @@ and/or use gtk-doc annotations. --> glib:type-name="GAFlightClient" glib:get-type="gaflight_client_get_type" glib:type-struct="ClientClass"> - + - + The newly created client, %NULL on error. + filename="arrow-flight-glib/client.cpp" + line="483">The newly created client, %NULL on error. A #GAFlightLocation to be connected. + filename="arrow-flight-glib/client.cpp" + line="479">A #GAFlightLocation to be connected. nullable="1" allow-none="1"> A #GAFlightClientOptions. + filename="arrow-flight-glib/client.cpp" + line="480">A #GAFlightClientOptions. + + Authenticates to the server using basic HTTP style authentication. + + + %TRUE on success, %FALSE if there was an error. + + + + + A #GAFlightClient. + + + + User name to be used. + + + + Password to be used. + + + + A #GAFlightCallOptions. + + + + Bearer token name on success. + + + + Bearer token value on success. + + + + + + + + %TRUE on success, %FALSE if there was an error. + + + + + A #GAFlightClient. + + + + - + + filename="arrow-flight-glib/client.cpp" + line="673"> The #GAFlightStreamReader to read record batched from the server on success, %NULL on error. @@ -97,14 +267,14 @@ and/or use gtk-doc annotations. --> A #GAFlightClient. + filename="arrow-flight-glib/client.cpp" + line="668">A #GAFlightClient. A #GAFlightTicket. + filename="arrow-flight-glib/client.cpp" + line="669">A #GAFlightTicket. nullable="1" allow-none="1"> A #GAFlightCallOptions. + filename="arrow-flight-glib/client.cpp" + line="670">A #GAFlightCallOptions. + + + + + + + + The returned #GAFlightInfo on + success, %NULL on error. + + + + + A #GAFlightClient. + + + + A #GAFlightDescriptor to be processed. + + + + A #GAFlightCallOptions. @@ -122,11 +328,11 @@ and/or use gtk-doc annotations. --> c:identifier="gaflight_client_list_flights" version="5.0.0" throws="1"> - + + filename="arrow-flight-glib/client.cpp" + line="583"> The returned list of #GAFlightInfo on success, %NULL on error. @@ -135,8 +341,8 @@ and/or use gtk-doc annotations. --> A #GAFlightClient. + filename="arrow-flight-glib/client.cpp" + line="578">A #GAFlightClient. nullable="1" allow-none="1"> A #GAFlightCriteria. + filename="arrow-flight-glib/client.cpp" + line="579">A #GAFlightCriteria. nullable="1" allow-none="1"> A #GAFlightCallOptions. + filename="arrow-flight-glib/client.cpp" + line="580">A #GAFlightCallOptions. @@ -173,7 +379,7 @@ and/or use gtk-doc annotations. --> - + @@ -185,18 +391,80 @@ and/or use gtk-doc annotations. --> glib:type-name="GAFlightClientOptions" glib:get-type="gaflight_client_options_get_type" glib:type-struct="ClientOptionsClass"> - + - + The newly created options for a client. + filename="arrow-flight-glib/client.cpp" + line="394">The newly created options for a client. + + The client certificate to use if using Mutual TLS. + + + + Whether use TLS without validating the server certificate. Use +with caution. + + + + Override the host name checked by TLS. Use with caution. + + + + The private key associated with the client certificate for Mutual +TLS. + + + + Root certificates to use for validating server certificates. + + + + A soft limit on the number of bytes to write in a single batch +when sending Arrow data to a server. + +Used to help limit server memory consumption. Only enabled if +positive. When enabled, @GARROW_ERROR_IO may be yielded. + + @@ -204,7 +472,7 @@ and/or use gtk-doc annotations. --> - + @@ -216,22 +484,22 @@ and/or use gtk-doc annotations. --> glib:type-name="GAFlightCommandDescriptor" glib:get-type="gaflight_command_descriptor_get_type" glib:type-struct="CommandDescriptorClass"> - + - + The newly created #GAFlightCommandDescriptor. + filename="arrow-flight-glib/common.cpp" + line="524">The newly created #GAFlightCommandDescriptor. Opaque value used to express a command. + filename="arrow-flight-glib/common.cpp" + line="522">Opaque value used to express a command. @@ -239,11 +507,11 @@ and/or use gtk-doc annotations. --> - + The opaque value used to express a command. + filename="arrow-flight-glib/common.cpp" + line="540">The opaque value used to express a command. It should be freed with g_free() when no longer needed. @@ -251,8 +519,8 @@ and/or use gtk-doc annotations. --> A #GAFlightCommandDescriptor. + filename="arrow-flight-glib/common.cpp" + line="538">A #GAFlightCommandDescriptor. @@ -265,7 +533,7 @@ and/or use gtk-doc annotations. --> - + @@ -277,22 +545,22 @@ and/or use gtk-doc annotations. --> glib:type-name="GAFlightCriteria" glib:get-type="gaflight_criteria_get_type" glib:type-struct="CriteriaClass"> - + - + The newly created #GAFlightCriteria, %NULL on error. + filename="arrow-flight-glib/common.cpp" + line="196">The newly created #GAFlightCriteria, %NULL on error. A #GBytes. + filename="arrow-flight-glib/common.cpp" + line="194">A #GBytes. @@ -302,8 +570,8 @@ and/or use gtk-doc annotations. --> writable="1" transfer-ownership="none"> Opaque criteria expression, dependent on server implementation. + filename="arrow-flight-glib/common.cpp" + line="176">Opaque criteria expression, dependent on server implementation. @@ -313,7 +581,7 @@ and/or use gtk-doc annotations. --> - + @@ -325,7 +593,7 @@ and/or use gtk-doc annotations. --> glib:type-name="GAFlightDataStream" glib:get-type="gaflight_data_stream_get_type" glib:type-struct="DataStreamClass"> - + - + @@ -353,29 +621,29 @@ and/or use gtk-doc annotations. --> glib:type-name="GAFlightDescriptor" glib:get-type="gaflight_descriptor_get_type" glib:type-struct="DescriptorClass"> - + - + %TRUE if both of them represents the same descriptor, + filename="arrow-flight-glib/common.cpp" + line="421">%TRUE if both of them represents the same descriptor, %FALSE otherwise. A #GAFlightDescriptor. + filename="arrow-flight-glib/common.cpp" + line="418">A #GAFlightDescriptor. A #GAFlightDescriptor to be compared. + filename="arrow-flight-glib/common.cpp" + line="419">A #GAFlightDescriptor to be compared. @@ -383,11 +651,11 @@ and/or use gtk-doc annotations. --> - + A descriptor as a string. + filename="arrow-flight-glib/common.cpp" + line="402">A descriptor as a string. It should be freed with g_free() when no longer needed. @@ -395,8 +663,8 @@ and/or use gtk-doc annotations. --> A #GAFlightDescriptor. + filename="arrow-flight-glib/common.cpp" + line="400">A #GAFlightDescriptor. @@ -415,7 +683,7 @@ and/or use gtk-doc annotations. --> - + @@ -427,28 +695,28 @@ and/or use gtk-doc annotations. --> glib:type-name="GAFlightEndpoint" glib:get-type="gaflight_endpoint_get_type" glib:type-struct="EndpointClass"> - + - + The newly created #GAFlightEndpoint, %NULL on error. + filename="arrow-flight-glib/common.cpp" + line="815">The newly created #GAFlightEndpoint, %NULL on error. A #GAFlightTicket. + filename="arrow-flight-glib/common.cpp" + line="812">A #GAFlightTicket. A list of #GAFlightLocation. + filename="arrow-flight-glib/common.cpp" + line="813">A list of #GAFlightLocation. @@ -458,25 +726,25 @@ and/or use gtk-doc annotations. --> - + %TRUE if both of them represents the same endpoint, + filename="arrow-flight-glib/common.cpp" + line="837">%TRUE if both of them represents the same endpoint, %FALSE otherwise. A #GAFlightEndpoint. + filename="arrow-flight-glib/common.cpp" + line="834">A #GAFlightEndpoint. A #GAFlightEndpoint to be compared. + filename="arrow-flight-glib/common.cpp" + line="835">A #GAFlightEndpoint to be compared. @@ -484,11 +752,11 @@ and/or use gtk-doc annotations. --> - + + filename="arrow-flight-glib/common.cpp" + line="855"> The locations in this endpoint. It must be freed with g_list_free() and g_object_unref() when no @@ -501,16 +769,16 @@ and/or use gtk-doc annotations. --> A #GAFlightEndpoint. + filename="arrow-flight-glib/common.cpp" + line="853">A #GAFlightEndpoint. Opaque ticket identify; use with DoGet RPC. + filename="arrow-flight-glib/common.cpp" + line="795">Opaque ticket identify; use with DoGet RPC. @@ -520,11 +788,47 @@ and/or use gtk-doc annotations. --> - + + + It is called with each header name/value pair, together with the +@user_data parameter which is passed to +gaflight_call_options_foreach_header() and so on. + + + + + + + A header name. + + + + The value corresponding to the name. + + + + User data passed to gaflight_call_options_foreach_header() + and so on. + + + + glib:type-name="GAFlightInfo" glib:get-type="gaflight_info_get_type" glib:type-struct="InfoClass"> - + - + The newly created #GAFlightInfo, %NULL on error. + filename="arrow-flight-glib/common.cpp" + line="958">The newly created #GAFlightInfo, %NULL on error. A #GArrowSchema. + filename="arrow-flight-glib/common.cpp" + line="951">A #GArrowSchema. A #GAFlightDescriptor. + filename="arrow-flight-glib/common.cpp" + line="952">A #GAFlightDescriptor. A list of #GAFlightEndpoint. + filename="arrow-flight-glib/common.cpp" + line="953">A list of #GAFlightEndpoint. The number of total records. + filename="arrow-flight-glib/common.cpp" + line="954">The number of total records. The number of total bytes. + filename="arrow-flight-glib/common.cpp" + line="955">The number of total bytes. - + %TRUE if both of them represents the same information, + filename="arrow-flight-glib/common.cpp" + line="996">%TRUE if both of them represents the same information, %FALSE otherwise. A #GAFlightInfo. + filename="arrow-flight-glib/common.cpp" + line="993">A #GAFlightInfo. A #GAFlightInfo to be compared. + filename="arrow-flight-glib/common.cpp" + line="994">A #GAFlightInfo to be compared. @@ -606,18 +910,18 @@ and/or use gtk-doc annotations. --> - + The #GAFlightDescriptor of the information. + filename="arrow-flight-glib/common.cpp" + line="1056">The #GAFlightDescriptor of the information. A #GAFlightInfo. + filename="arrow-flight-glib/common.cpp" + line="1054">A #GAFlightInfo. @@ -625,11 +929,11 @@ and/or use gtk-doc annotations. --> - + + filename="arrow-flight-glib/common.cpp" + line="1071"> The list of #GAFlightEndpoint of the information. @@ -638,8 +942,8 @@ and/or use gtk-doc annotations. --> A #GAFlightInfo. + filename="arrow-flight-glib/common.cpp" + line="1069">A #GAFlightInfo. @@ -648,18 +952,18 @@ and/or use gtk-doc annotations. --> c:identifier="gaflight_info_get_schema" version="5.0.0" throws="1"> - + Deserialized #GArrowSchema, %NULL on error. + filename="arrow-flight-glib/common.cpp" + line="1026">Deserialized #GArrowSchema, %NULL on error. A #GAFlightInfo. + filename="arrow-flight-glib/common.cpp" + line="1022">A #GAFlightInfo. nullable="1" allow-none="1"> A #GArrowReadOptions. + filename="arrow-flight-glib/common.cpp" + line="1023">A #GArrowReadOptions. @@ -676,18 +980,18 @@ and/or use gtk-doc annotations. --> - + The number of total bytes of the information. + filename="arrow-flight-glib/common.cpp" + line="1107">The number of total bytes of the information. A #GAFlightInfo. + filename="arrow-flight-glib/common.cpp" + line="1105">A #GAFlightInfo. @@ -695,18 +999,18 @@ and/or use gtk-doc annotations. --> - + The number of total records of the information. + filename="arrow-flight-glib/common.cpp" + line="1092">The number of total records of the information. A #GAFlightInfo. + filename="arrow-flight-glib/common.cpp" + line="1090">A #GAFlightInfo. @@ -725,7 +1029,7 @@ and/or use gtk-doc annotations. --> - + @@ -737,23 +1041,23 @@ and/or use gtk-doc annotations. --> glib:type-name="GAFlightLocation" glib:get-type="gaflight_location_get_type" glib:type-struct="LocationClass"> - + - + The newly created location, %NULL on error. + filename="arrow-flight-glib/common.cpp" + line="253">The newly created location, %NULL on error. An URI to specify location. + filename="arrow-flight-glib/common.cpp" + line="250">An URI to specify location. @@ -761,24 +1065,24 @@ and/or use gtk-doc annotations. --> - + %TRUE if both of them represents the same URI, %FALSE otherwise. + filename="arrow-flight-glib/common.cpp" + line="314">%TRUE if both of them represents the same URI, %FALSE otherwise. A #GAFlightLocation. + filename="arrow-flight-glib/common.cpp" + line="311">A #GAFlightLocation. A #GAFlightLocation to be compared. + filename="arrow-flight-glib/common.cpp" + line="312">A #GAFlightLocation to be compared. @@ -786,11 +1090,11 @@ and/or use gtk-doc annotations. --> - + The scheme of this URI. + filename="arrow-flight-glib/common.cpp" + line="295">The scheme of this URI. It should be freed with g_free() when no longer needed. @@ -798,8 +1102,8 @@ and/or use gtk-doc annotations. --> A #GAFlightLocation. + filename="arrow-flight-glib/common.cpp" + line="293">A #GAFlightLocation. @@ -807,11 +1111,11 @@ and/or use gtk-doc annotations. --> - + A representation of this URI as a string. + filename="arrow-flight-glib/common.cpp" + line="277">A representation of this URI as a string. It should be freed with g_free() when no longer needed. @@ -819,8 +1123,8 @@ and/or use gtk-doc annotations. --> A #GAFlightLocation. + filename="arrow-flight-glib/common.cpp" + line="275">A #GAFlightLocation. @@ -832,11 +1136,51 @@ and/or use gtk-doc annotations. --> - + + + + + + + The descriptor for this upload. + + + + + A #GAFlightMessageReader. + + + + + + + + + + + + + + glib:type-name="GAFlightPathDescriptor" glib:get-type="gaflight_path_descriptor_get_type" glib:type-struct="PathDescriptorClass"> - + - + The newly created #GAFlightPathDescriptor. + filename="arrow-flight-glib/common.cpp" + line="458">The newly created #GAFlightPathDescriptor. List of paths identifying a + filename="arrow-flight-glib/common.cpp" + line="454">List of paths identifying a particular dataset. @@ -867,8 +1211,8 @@ and/or use gtk-doc annotations. --> The number of @paths. + filename="arrow-flight-glib/common.cpp" + line="456">The number of @paths. @@ -876,11 +1220,11 @@ and/or use gtk-doc annotations. --> - + + filename="arrow-flight-glib/common.cpp" + line="479"> The paths in this descriptor. It must be freed with g_strfreev() when no longer needed. @@ -891,8 +1235,8 @@ and/or use gtk-doc annotations. --> A #GAFlightPathDescriptor. + filename="arrow-flight-glib/common.cpp" + line="477">A #GAFlightPathDescriptor. @@ -904,7 +1248,7 @@ and/or use gtk-doc annotations. --> - + @@ -916,23 +1260,23 @@ and/or use gtk-doc annotations. --> glib:type-name="GAFlightRecordBatchReader" glib:get-type="gaflight_record_batch_reader_get_type" glib:type-struct="RecordBatchReaderClass"> - + - + The all data on success, %NULL on error. + filename="arrow-flight-glib/common.cpp" + line="1339">The all data on success, %NULL on error. A #GAFlightRecordBatchReader. + filename="arrow-flight-glib/common.cpp" + line="1336">A #GAFlightRecordBatchReader. @@ -942,24 +1286,32 @@ and/or use gtk-doc annotations. --> c:identifier="gaflight_record_batch_reader_read_next" version="6.0.0" throws="1"> - + The next chunk on success, %NULL on end + filename="arrow-flight-glib/common.cpp" + line="1311">The next chunk on success, %NULL on end of stream, %NULL on error. A #GAFlightRecordBatchReader. + filename="arrow-flight-glib/common.cpp" + line="1308">A #GAFlightRecordBatchReader. + + + - + @@ -986,22 +1338,22 @@ and/or use gtk-doc annotations. --> glib:type-name="GAFlightRecordBatchStream" glib:get-type="gaflight_record_batch_stream_get_type" glib:type-struct="RecordBatchStreamClass"> - + - + The newly created #GAFlightRecordBatchStream. + filename="arrow-flight-glib/server.cpp" + line="239">The newly created #GAFlightRecordBatchStream. A #GArrowRecordBatchReader to be read. + filename="arrow-flight-glib/server.cpp" + line="235">A #GArrowRecordBatchReader to be read. @@ -1010,8 +1362,8 @@ and/or use gtk-doc annotations. --> nullable="1" allow-none="1"> A #GArrowWriteOptions for writing record batches to + filename="arrow-flight-glib/server.cpp" + line="236">A #GArrowWriteOptions for writing record batches to a client. @@ -1023,8 +1375,8 @@ and/or use gtk-doc annotations. --> construct-only="1" transfer-ownership="none"> The reader that produces record batches. + filename="arrow-flight-glib/server.cpp" + line="217">The reader that produces record batches. @@ -1034,11 +1386,26 @@ and/or use gtk-doc annotations. --> - + + + + + + + glib:type-name="GAFlightServer" glib:get-type="gaflight_server_get_type" glib:type-struct="ServerClass"> - + + - + #GAFlightDataStream on success, %NULL on error. + filename="arrow-flight-glib/server.cpp" + line="1264">#GAFlightDataStream on success, %NULL on error. A #GAFlightServer. + filename="arrow-flight-glib/server.cpp" + line="1259">A #GAFlightServer. A #GAFlightServerCallContext. + filename="arrow-flight-glib/server.cpp" + line="1260">A #GAFlightServerCallContext. A #GAFlightTicket. + filename="arrow-flight-glib/server.cpp" + line="1261">A #GAFlightTicket. + + + + A #GAFlightInfo on success, %NULL on error. + + + + + A #GAFlightServer. + + + + A #GAFlightServerCallContext. + + + + A #GAFlightDescriptor. + + + + - + + filename="arrow-flight-glib/server.cpp" + line="1207"> #GList of #GAFlightInfo on success, %NULL on error. @@ -1098,14 +1499,14 @@ and/or use gtk-doc annotations. --> A #GAFlightServer. + filename="arrow-flight-glib/server.cpp" + line="1202">A #GAFlightServer. A #GAFlightServerCallContext. + filename="arrow-flight-glib/server.cpp" + line="1203">A #GAFlightServerCallContext. @@ -1114,8 +1515,8 @@ and/or use gtk-doc annotations. --> nullable="1" allow-none="1"> A #GAFlightCriteria. + filename="arrow-flight-glib/server.cpp" + line="1204">A #GAFlightCriteria. @@ -1124,37 +1525,70 @@ and/or use gtk-doc annotations. --> c:identifier="gaflight_server_do_get" version="6.0.0" throws="1"> - + #GAFlightDataStream on success, %NULL on error. + filename="arrow-flight-glib/server.cpp" + line="1264">#GAFlightDataStream on success, %NULL on error. A #GAFlightServer. + filename="arrow-flight-glib/server.cpp" + line="1259">A #GAFlightServer. A #GAFlightServerCallContext. + filename="arrow-flight-glib/server.cpp" + line="1260">A #GAFlightServerCallContext. A #GAFlightTicket. + filename="arrow-flight-glib/server.cpp" + line="1261">A #GAFlightTicket. + + + + A #GAFlightInfo on success, %NULL on error. + + + + + A #GAFlightServer. + + + + A #GAFlightServerCallContext. + + + + A #GAFlightDescriptor. + + + + - + @@ -1168,11 +1602,11 @@ and/or use gtk-doc annotations. --> c:identifier="gaflight_server_list_flights" version="5.0.0" throws="1"> - + + filename="arrow-flight-glib/server.cpp" + line="1207"> #GList of #GAFlightInfo on success, %NULL on error. @@ -1181,14 +1615,14 @@ and/or use gtk-doc annotations. --> A #GAFlightServer. + filename="arrow-flight-glib/server.cpp" + line="1202">A #GAFlightServer. A #GAFlightServerCallContext. + filename="arrow-flight-glib/server.cpp" + line="1203">A #GAFlightServerCallContext. @@ -1197,8 +1631,8 @@ and/or use gtk-doc annotations. --> nullable="1" allow-none="1"> A #GAFlightCriteria. + filename="arrow-flight-glib/server.cpp" + line="1204">A #GAFlightCriteria. @@ -1207,24 +1641,24 @@ and/or use gtk-doc annotations. --> c:identifier="gaflight_server_listen" version="5.0.0" throws="1"> - + %TRUE on success, %FALSE on error. + filename="arrow-flight-glib/server.cpp" + line="1146">%TRUE on success, %FALSE on error. A #GAFlightServer. + filename="arrow-flight-glib/server.cpp" + line="1142">A #GAFlightServer. A #GAFlightServerOptions. + filename="arrow-flight-glib/server.cpp" + line="1143">A #GAFlightServerOptions. @@ -1234,27 +1668,27 @@ and/or use gtk-doc annotations. --> version="5.0.0" throws="1"> Shuts down the serve. This function can be called from signal + filename="arrow-flight-glib/server.cpp" + line="1178">Shuts down the serve. This function can be called from signal handler or another thread. - + %TRUE on success, %FALSE on error. + filename="arrow-flight-glib/server.cpp" + line="1186">%TRUE on success, %FALSE on error. A #GAFlightServer. + filename="arrow-flight-glib/server.cpp" + line="1180">A #GAFlightServer. - + @@ -1268,6 +1702,141 @@ handler or another thread. + + + + + + + + + + + + + + + + + + + Reads a message from the client. + + + Read data as #GBytes on + success, %NULL on error. + + + + + A #GAFlightServerAuthReader. + + + + + + + + + + + + + + + + + + + + + Writes a message to the client. + + + %TRUE on success, %FALSE on error. + + + + + A #GAFlightServerAuthSender. + + + + A #GBytes to be sent. + + + + + + + + + + + + + + + + + glib:type-name="GAFlightServerCallContext" glib:get-type="gaflight_server_call_context_get_type" glib:type-struct="ServerCallContextClass"> - + + + Iterates over all incoming headers. + + + + + + + A #GAFlightServerCallContext. + + + + The user's callback function. + + + + Data for @func. + + + + - + @@ -1299,18 +1906,17 @@ handler or another thread. c:type="GAFlightServerClass" glib:is-gtype-struct-for="Server" version="5.0.0"> - + - + + filename="arrow-flight-glib/server.cpp" + line="1207"> #GList of #GAFlightInfo on success, %NULL on error. @@ -1319,14 +1925,14 @@ handler or another thread. A #GAFlightServer. + filename="arrow-flight-glib/server.cpp" + line="1202">A #GAFlightServer. A #GAFlightServerCallContext. + filename="arrow-flight-glib/server.cpp" + line="1203">A #GAFlightServerCallContext. @@ -1335,47 +1941,333 @@ handler or another thread. nullable="1" allow-none="1"> A #GAFlightCriteria. + filename="arrow-flight-glib/server.cpp" + line="1204">A #GAFlightCriteria. + + + + + A #GAFlightInfo on success, %NULL on error. + + + + + A #GAFlightServer. + + + + A #GAFlightServerCallContext. + + + + A #GAFlightDescriptor. + + + + + - + #GAFlightDataStream on success, %NULL on error. + filename="arrow-flight-glib/server.cpp" + line="1264">#GAFlightDataStream on success, %NULL on error. A #GAFlightServer. + filename="arrow-flight-glib/server.cpp" + line="1259">A #GAFlightServer. A #GAFlightServerCallContext. + filename="arrow-flight-glib/server.cpp" + line="1260">A #GAFlightServerCallContext. A #GAFlightTicket. + filename="arrow-flight-glib/server.cpp" + line="1261">A #GAFlightTicket. + + + + Authenticates the client on initial connection. The server can send +and read responses from the client at any time. + + + + + + + A #GAFlightServerCustomAuthHandler. + + + + A #GAFlightServerCallContext. + + + + A #GAFlightServerAuthSender. + + + + A #GAFlightServerAuthReader. + + + + + + Validates a per-call client token. + + + The identity of the peer, if + this authentication method supports it. + + + + + A #GAFlightServerCustomAuthHandler. + + + + A #GAFlightServerCallContext. + + + + The client token. May be the empty string if the client does not + provide a token. + + + + + + Authenticates the client on initial connection. The server can send +and read responses from the client at any time. + + + + + + + A #GAFlightServerCustomAuthHandler. + + + + A #GAFlightServerCallContext. + + + + A #GAFlightServerAuthSender. + + + + A #GAFlightServerAuthReader. + + + + + + Validates a per-call client token. + + + The identity of the peer, if + this authentication method supports it. + + + + + A #GAFlightServerCustomAuthHandler. + + + + A #GAFlightServerCallContext. + + + + The client token. May be the empty string if the client does not + provide a token. + + + + + + + + + + + + + + + + + + + + + + A #GAFlightServerCustomAuthHandler. + + + + A #GAFlightServerCallContext. + + + + A #GAFlightServerAuthSender. + + + + A #GAFlightServerAuthReader. + + + + + + + + + + The identity of the peer, if + this authentication method supports it. + + + + + A #GAFlightServerCustomAuthHandler. + + + + A #GAFlightServerCallContext. + + + + The client token. May be the empty string if the client does not + provide a token. + + + + + + glib:type-name="GAFlightServerOptions" glib:get-type="gaflight_server_options_get_type" glib:type-struct="ServerOptionsClass"> - + - + The newly created options for a server. + filename="arrow-flight-glib/server.cpp" + line="957">The newly created options for a server. A #GAFlightLocation to be listened. + filename="arrow-flight-glib/server.cpp" + line="955">A #GAFlightLocation to be listened. + + The authentication handler. + + + The location to be listened. @@ -1416,7 +2321,7 @@ handler or another thread. - + @@ -1428,22 +2333,22 @@ handler or another thread. glib:type-name="GAFlightStreamChunk" glib:get-type="gaflight_stream_chunk_get_type" glib:type-struct="StreamChunkClass"> - + - + The data of the chunk. + filename="arrow-flight-glib/common.cpp" + line="1191">The data of the chunk. A #GAFlightStreamChunk. + filename="arrow-flight-glib/common.cpp" + line="1189">A #GAFlightStreamChunk. @@ -1451,11 +2356,11 @@ handler or another thread. - + The metadata of the chunk. + filename="arrow-flight-glib/common.cpp" + line="1206">The metadata of the chunk. The metadata may be NULL. @@ -1463,8 +2368,8 @@ handler or another thread. A #GAFlightStreamChunk. + filename="arrow-flight-glib/common.cpp" + line="1204">A #GAFlightStreamChunk. @@ -1483,7 +2388,7 @@ handler or another thread. - + @@ -1495,7 +2400,7 @@ handler or another thread. glib:type-name="GAFlightStreamReader" glib:get-type="gaflight_stream_reader_get_type" glib:type-struct="StreamReaderClass"> - + @@ -1503,7 +2408,7 @@ handler or another thread. - + @@ -1516,22 +2421,22 @@ handler or another thread. glib:type-name="GAFlightTicket" glib:get-type="gaflight_ticket_get_type" glib:type-struct="TicketClass"> - + - + The newly created #GAFlightTicket, %NULL on error. + filename="arrow-flight-glib/common.cpp" + line="681">The newly created #GAFlightTicket, %NULL on error. A #GBytes. + filename="arrow-flight-glib/common.cpp" + line="679">A #GBytes. @@ -1539,24 +2444,24 @@ handler or another thread. - + %TRUE if both of them represents the same ticket, %FALSE otherwise. + filename="arrow-flight-glib/common.cpp" + line="699">%TRUE if both of them represents the same ticket, %FALSE otherwise. A #GAFlightTicket. + filename="arrow-flight-glib/common.cpp" + line="696">A #GAFlightTicket. A #GAFlightTicket to be compared. + filename="arrow-flight-glib/common.cpp" + line="697">A #GAFlightTicket to be compared. @@ -1566,8 +2471,8 @@ handler or another thread. writable="1" transfer-ownership="none"> Opaque identifier or credential to use when requesting a data + filename="arrow-flight-glib/common.cpp" + line="660">Opaque identifier or credential to use when requesting a data stream with the DoGet RPC. @@ -1578,14 +2483,14 @@ stream with the DoGet RPC. - + #GAFlightStreamReader is a class for reading record batches from a server. @@ -1597,7 +2502,7 @@ server. #GAFlightCriteria is a class for criteria. #GAFlightLocation is a class for location. @@ -1621,7 +2526,7 @@ as #GAFlightPathDescriptor. #GAFlightDataStream is a class for producing a sequence of IPC payloads to be sent in `FlightData` protobuf messages. Generally, this is not used directly. Generally, #GAFlightRecordBatchStream is @@ -1631,6 +2536,19 @@ used instead. IPC payloads to be sent in `FlightData` protobuf messages by #GArrowRecordBatchReader`. +#GAFlightMessageReader is a class for IPC payloads uploaded by a +client. Also allows reading application-defined metadata via the +Flight protocol. + +#GAFlightServerAuthSender is a class for sending messages to the +client during an authentication handshake. + +#GAFlightServerAuthReader is a class for reading messages from the +client during an authentication handshake. + +#GAFlightServerAuthHandler is an abstract class to implement +authentication for a Flight service. + #GAFlightServerOptions is a class for options of each server. #GAFlightServerCallContext is a class for context of each server call. diff --git a/girs/Atspi-2.0.gir b/girs/Atspi-2.0.gir index 316168691..8b953ca22 100644 --- a/girs/Atspi-2.0.gir +++ b/girs/Atspi-2.0.gir @@ -17,23 +17,23 @@ and/or use gtk-doc annotations. --> c:identifier-prefixes="Atspi" c:symbol-prefixes="atspi"> - + - + - + - + - + glib:type-name="AtspiAccessible" glib:get-type="atspi_accessible_get_type" glib:type-struct="AccessibleClass"> + The base interface which is implemented by all accessible objects. + +All objects support interfaces for querying their contained 'children' +and position in the accessible-object hierarchy, whether or not they +actually have children. @@ -162,7 +169,7 @@ and/or use gtk-doc annotations. --> Clears the cached information for the given accessible and all of its + line="1781">Clears the cached information for the given accessible and all of its descendants. @@ -172,7 +179,25 @@ descendants. The #AtspiAccessible whose cache to clear. + line="1783">The #AtspiAccessible whose cache to clear. + + + + + + Clears the cached information only for the given accessible. + + + + + + + The #AtspiAccessible whose cache to clear. @@ -183,14 +208,14 @@ descendants. throws="1"> Gets the accessible id of the accessible. This is not meant to be presented + line="1920">Gets the accessible id of the accessible. This is not meant to be presented to the user, but to be an id which is stable over application development. Typically, this is the gtkbuilder id. - + a character string representing the accessible id of the + line="1930">a character string representing the accessible id of the #AtspiAccessible object or NULL on exception. @@ -198,25 +223,24 @@ Typically, this is the gtkbuilder id. an #AtspiAccessible + line="1922">an #AtspiAccessible Gets the #AtspiAction interface for an #AtspiAccessible. + line="1259">Gets the #AtspiAction interface for an #AtspiAccessible. Use atspi_accessible_get_action_iface instead. a pointer to an #AtspiAction interface + line="1265">a pointer to an #AtspiAction interface instance, or NULL if @obj does not implement #AtspiAction. @@ -224,22 +248,21 @@ Typically, this is the gtkbuilder id. a pointer to the #AtspiAccessible instance to query. + line="1261">a pointer to the #AtspiAccessible instance to query. + c:identifier="atspi_accessible_get_action_iface"> Gets the #AtspiAction interface for an #AtspiAccessible. + line="1276">Gets the #AtspiAction interface for an #AtspiAccessible. a pointer to an #AtspiAction interface + line="1282">a pointer to an #AtspiAction interface instance, or NULL if @obj does not implement #AtspiAction. @@ -247,7 +270,7 @@ Typically, this is the gtkbuilder id. a pointer to the #AtspiAccessible instance to query. + line="1278">a pointer to the #AtspiAccessible instance to query. @@ -257,12 +280,12 @@ Typically, this is the gtkbuilder id. throws="1"> Gets the containing #AtspiApplication for an object. + line="827">Gets the containing #AtspiApplication for an object. the containing #AtspiApplication instance for + line="833">the containing #AtspiApplication instance for this object. @@ -270,7 +293,7 @@ Typically, this is the gtkbuilder id. The #AtspiAccessible being queried. + line="829">The #AtspiAccessible being queried. @@ -280,21 +303,21 @@ Typically, this is the gtkbuilder id. throws="1"> Gets the AT-SPI IPC specification version supported by the application + line="922">Gets the AT-SPI IPC specification version supported by the application pointed to by the #AtspiAccessible object. Only works on application root objects. a UTF-8 string indicating the AT-SPI version for the #AtspiAccessible object or NULL on exception. + line="930">a UTF-8 string indicating the AT-SPI version for the #AtspiAccessible object or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. + line="924">a pointer to the #AtspiAccessible object on which to operate. @@ -304,7 +327,7 @@ Only works on application root objects. throws="1"> Gets the #AttributeSet representing any assigned + line="743">Gets the #AttributeSet representing any assigned name-value pair attributes or annotations for this object. For typographic, textual, or textually-semantic attributes, see atspi_text_get_attributes instead. @@ -312,7 +335,7 @@ atspi_text_get_attributes instead. The name-value-pair + line="752">The name-value-pair attributes assigned to this object. @@ -323,7 +346,7 @@ attributes assigned to this object. The #AtspiAccessible being queried. + line="745">The #AtspiAccessible being queried. @@ -333,7 +356,7 @@ attributes assigned to this object. throws="1"> Gets a #GArray representing any assigned + line="792">Gets a #GArray representing any assigned name-value pair attributes or annotations for this object. For typographic, textual, or textually-semantic attributes, see atspi_text_get_attributes_as_array instead. @@ -341,7 +364,7 @@ atspi_text_get_attributes_as_array instead. The name-value-pair + line="801">The name-value-pair attributes assigned to this object. @@ -351,7 +374,7 @@ atspi_text_get_attributes_as_array instead. The #AtspiAccessible being queried. + line="794">The #AtspiAccessible being queried. @@ -361,12 +384,12 @@ atspi_text_get_attributes_as_array instead. throws="1"> Gets the #AtspiAccessible child of an #AtspiAccessible object at a given index. + line="478">Gets the #AtspiAccessible child of an #AtspiAccessible object at a given index. a pointer to the #AtspiAccessible child object at + line="485">a pointer to the #AtspiAccessible child object at index @child_index or NULL on exception. @@ -374,13 +397,13 @@ index @child_index or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. + line="480">a pointer to the #AtspiAccessible object on which to operate. a #long indicating which child is specified. + line="481">a #long indicating which child is specified. @@ -390,12 +413,12 @@ index @child_index or NULL on exception. throws="1"> Gets the number of children contained by an #AtspiAccessible object. + line="448">Gets the number of children contained by an #AtspiAccessible object. a #long indicating the number of #AtspiAccessible children + line="454">a #long indicating the number of #AtspiAccessible children contained by an #AtspiAccessible object or -1 on exception. @@ -403,25 +426,24 @@ index @child_index or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. + line="450">a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiCollection interface for an #AtspiAccessible. + line="1291">Gets the #AtspiCollection interface for an #AtspiAccessible. Use atspi_accessible_get_collection_iface instead. a pointer to an #AtspiCollection interface + line="1297">a pointer to an #AtspiCollection interface instance, or NULL if @obj does not implement #AtspiCollection. @@ -429,22 +451,21 @@ index @child_index or NULL on exception. a pointer to the #AtspiAccessible instance to query. + line="1293">a pointer to the #AtspiAccessible instance to query. + c:identifier="atspi_accessible_get_collection_iface"> Gets the #AtspiCollection interface for an #AtspiAccessible. + line="1308">Gets the #AtspiCollection interface for an #AtspiAccessible. a pointer to an #AtspiCollection interface + line="1314">a pointer to an #AtspiCollection interface instance, or NULL if @obj does not implement #AtspiCollection. @@ -452,25 +473,24 @@ index @child_index or NULL on exception. a pointer to the #AtspiAccessible instance to query. + line="1310">a pointer to the #AtspiAccessible instance to query. Gets the #AtspiComponent interface for an #AtspiAccessible. + line="1323">Gets the #AtspiComponent interface for an #AtspiAccessible. Use atspi_accessible_get_component_iface instead. a pointer to an #AtspiComponent interface + line="1329">a pointer to an #AtspiComponent interface instance, or NULL if @obj does not implement #AtspiComponent. @@ -478,22 +498,21 @@ index @child_index or NULL on exception. a pointer to the #AtspiAccessible instance to query. + line="1325">a pointer to the #AtspiAccessible instance to query. + c:identifier="atspi_accessible_get_component_iface"> Gets the #AtspiComponent interface for an #AtspiAccessible. + line="1340">Gets the #AtspiComponent interface for an #AtspiAccessible. a pointer to an #AtspiComponent interface + line="1346">a pointer to an #AtspiComponent interface instance, or NULL if @obj does not implement #AtspiComponent. @@ -501,7 +520,7 @@ index @child_index or NULL on exception. a pointer to the #AtspiAccessible instance to query. + line="1342">a pointer to the #AtspiAccessible instance to query. @@ -511,12 +530,12 @@ index @child_index or NULL on exception. throws="1"> Gets the description of an #AtspiAccessible object. + line="363">Gets the description of an #AtspiAccessible object. a UTF-8 string describing the #AtspiAccessible object + line="369">a UTF-8 string describing the #AtspiAccessible object or NULL on exception. @@ -524,25 +543,24 @@ or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. + line="365">a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiDocument interface for an #AtspiAccessible. + line="1355">Gets the #AtspiDocument interface for an #AtspiAccessible. Use atspi_accessible_get_document_iface instead. a pointer to an #AtspiDocument interface + line="1361">a pointer to an #AtspiDocument interface instance, or NULL if @obj does not implement #AtspiDocument. @@ -550,22 +568,21 @@ or NULL on exception. a pointer to the #AtspiAccessible instance to query. + line="1357">a pointer to the #AtspiAccessible instance to query. + c:identifier="atspi_accessible_get_document_iface"> Gets the #AtspiDocument interface for an #AtspiAccessible. + line="1372">Gets the #AtspiDocument interface for an #AtspiAccessible. a pointer to an #AtspiDocument interface + line="1378">a pointer to an #AtspiDocument interface instance, or NULL if @obj does not implement #AtspiDocument. @@ -573,25 +590,24 @@ or NULL on exception. a pointer to the #AtspiAccessible instance to query. + line="1374">a pointer to the #AtspiAccessible instance to query. Gets the #AtspiEditableText interface for an #AtspiAccessible. + line="1387">Gets the #AtspiEditableText interface for an #AtspiAccessible. Use atspi_accessible_get_editable_text_iface instead. a pointer to an #AtspiEditableText interface + line="1393">a pointer to an #AtspiEditableText interface instance, or NULL if @obj does not implement #AtspiEditableText. @@ -599,22 +615,21 @@ or NULL on exception. a pointer to the #AtspiAccessible instance to query. + line="1389">a pointer to the #AtspiAccessible instance to query. + c:identifier="atspi_accessible_get_editable_text_iface"> Gets the #AtspiEditableText interface for an #AtspiAccessible. + line="1404">Gets the #AtspiEditableText interface for an #AtspiAccessible. a pointer to an #AtspiEditableText interface + line="1410">a pointer to an #AtspiEditableText interface instance, or NULL if @obj does not implement #AtspiEditableText. @@ -622,7 +637,33 @@ or NULL on exception. a pointer to the #AtspiAccessible instance to query. + line="1406">a pointer to the #AtspiAccessible instance to query. + + + + + + Gets the help text associated with the accessible, if set. When this is +present, it provides information that a screen reader can relay to the user +to explain how to interact with the object. + + + a character string representing the help text for the +#AtspiAccessible object or NULL on exception. + + + + + an #AtspiAccessible @@ -631,12 +672,12 @@ or NULL on exception. c:identifier="atspi_accessible_get_hyperlink"> Gets the #AtspiHyperlink interface for an #AtspiAccessible. + line="1419">Gets the #AtspiHyperlink interface for an #AtspiAccessible. the #AtspiHyperlink object associated with + line="1425">the #AtspiHyperlink object associated with the given #AtspiAccessible, or NULL if not supported. @@ -644,25 +685,24 @@ or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. + line="1421">a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiHypertext interface for an #AtspiAccessible. + line="1434">Gets the #AtspiHypertext interface for an #AtspiAccessible. Use atspi_accessible_get_hypertext_iface instead. a pointer to an #AtspiHypertext interface + line="1440">a pointer to an #AtspiHypertext interface instance, or NULL if @obj does not implement #AtspiHypertext. @@ -670,22 +710,21 @@ or NULL on exception. a pointer to the #AtspiAccessible instance to query. + line="1436">a pointer to the #AtspiAccessible instance to query. + c:identifier="atspi_accessible_get_hypertext_iface"> Gets the #AtspiHypertext interface for an #AtspiAccessible. + line="1451">Gets the #AtspiHypertext interface for an #AtspiAccessible. a pointer to an #AtspiHypertext interface + line="1457">a pointer to an #AtspiHypertext interface instance, or NULL if @obj does not implement #AtspiHypertext. @@ -693,7 +732,7 @@ or NULL on exception. a pointer to the #AtspiAccessible instance to query. + line="1453">a pointer to the #AtspiAccessible instance to query. @@ -701,13 +740,13 @@ or NULL on exception. Gets the application id for a #AtspiAccessible object. + line="947">Gets the application id for a #AtspiAccessible object. Only works on application root objects. a positive #gint indicating the id for the #AtspiAccessible object + line="954">a positive #gint indicating the id for the #AtspiAccessible object or -1 on exception. @@ -715,25 +754,24 @@ or -1 on exception. a pointer to the #AtspiAccessible object on which to operate. + line="949">a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiImage interface for an #AtspiAccessible. + line="1466">Gets the #AtspiImage interface for an #AtspiAccessible. Use atspi_accessible_get_image_iface instead. a pointer to an #AtspiImage interface instance, or + line="1472">a pointer to an #AtspiImage interface instance, or NULL if @obj does not implement #AtspiImage. @@ -741,22 +779,21 @@ or -1 on exception. a pointer to the #AtspiAccessible instance to query. + line="1468">a pointer to the #AtspiAccessible instance to query. + c:identifier="atspi_accessible_get_image_iface"> Gets the #AtspiImage interface for an #AtspiAccessible. + line="1483">Gets the #AtspiImage interface for an #AtspiAccessible. a pointer to an #AtspiImage interface instance, or + line="1489">a pointer to an #AtspiImage interface instance, or NULL if @obj does not implement #AtspiImage. @@ -764,7 +801,7 @@ or -1 on exception. a pointer to the #AtspiAccessible instance to query. + line="1485">a pointer to the #AtspiAccessible instance to query. @@ -774,13 +811,13 @@ or -1 on exception. throws="1"> Gets the index of an #AtspiAccessible object within its parent's + line="529">Gets the index of an #AtspiAccessible object within its parent's #AtspiAccessible children list. a #glong indicating the index of the #AtspiAccessible object + line="536">a #glong indicating the index of the #AtspiAccessible object in its parent, or -1 if @obj has no containing parent or on exception. @@ -789,7 +826,7 @@ or -1 on exception. a pointer to the #AtspiAccessible object on which to operate. + line="531">a pointer to the #AtspiAccessible object on which to operate. @@ -798,12 +835,12 @@ or -1 on exception. c:identifier="atspi_accessible_get_interfaces"> A set of pointers to all interfaces supported by an #AtspiAccessible. + line="1668">A set of pointers to all interfaces supported by an #AtspiAccessible. A #GArray of strings + line="1674">A #GArray of strings describing the interfaces supported by the object. Interfaces are denoted in short-hand (i.e. "Component", "Text" etc.). @@ -814,7 +851,7 @@ or -1 on exception. The #AtspiAccessible to query. + line="1670">The #AtspiAccessible to query. @@ -824,7 +861,7 @@ or -1 on exception. throws="1"> Gets a UTF-8 string corresponding to the name of the role played by an + line="670">Gets a UTF-8 string corresponding to the name of the role played by an object, translated to the current locale. This method will return useful values for roles that fall outside the enumeration used in atspi_accessible_getRole (). @@ -832,7 +869,7 @@ enumeration used in atspi_accessible_getRole (). a localized, UTF-8 string specifying the type of UI role played + line="679">a localized, UTF-8 string specifying the type of UI role played by an #AtspiAccessible object. @@ -840,7 +877,7 @@ by an #AtspiAccessible object. a pointer to the #AtspiAccessible object on which to operate. + line="672">a pointer to the #AtspiAccessible object on which to operate. @@ -850,12 +887,12 @@ by an #AtspiAccessible object. throws="1"> Gets the name of an #AtspiAccessible object. + line="332">Gets the name of an #AtspiAccessible object. a UTF-8 string indicating the name of the #AtspiAccessible object + line="338">a UTF-8 string indicating the name of the #AtspiAccessible object or NULL on exception. @@ -863,7 +900,7 @@ or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. + line="334">a pointer to the #AtspiAccessible object on which to operate. @@ -886,12 +923,12 @@ or NULL on exception. throws="1"> Gets an #AtspiAccessible object's parent container. + line="397">Gets an #AtspiAccessible object's parent container. a pointer to the + line="403">a pointer to the #AtspiAccessible object which contains the given #AtspiAccessible instance, or NULL if the @obj has no parent container. @@ -901,7 +938,7 @@ or NULL on exception. a pointer to the #AtspiAccessible object to query. + line="399">a pointer to the #AtspiAccessible object to query. @@ -911,21 +948,21 @@ or NULL on exception. throws="1"> Returns the process id associated with the given accessible. Mainly + line="1796">Returns the process id associated with the given accessible. Mainly added for debugging; it is a shortcut to explicitly querying the accessible's app->bus_name and then calling GetConnectionUnixProcessID. - + The process ID or undetermined value if @error is set. + line="1805">The process ID or undetermined value if @error is set. The #AtspiAccessible to query. + line="1798">The #AtspiAccessible to query. @@ -935,13 +972,13 @@ accessible's app->bus_name and then calling GetConnectionUnixProcessID. throws="1"> Gets the set of #AtspiRelation objects which describes this #AtspiAccessible object's + line="572">Gets the set of #AtspiRelation objects which describes this #AtspiAccessible object's relationships with other #AtspiAccessible objects. a #GArray of + line="579">a #GArray of #AtspiRelation pointers or NULL on exception. @@ -951,7 +988,7 @@ relationships with other #AtspiAccessible objects. a pointer to the #AtspiAccessible object on which to operate. + line="574">a pointer to the #AtspiAccessible object on which to operate. @@ -961,20 +998,20 @@ relationships with other #AtspiAccessible objects. throws="1"> Gets the UI role played by an #AtspiAccessible object. + line="610">Gets the UI role played by an #AtspiAccessible object. This role's name can be obtained via atspi_accessible_get_role_name (). the #AtspiRole of an #AtspiAccessible object. + line="617">the #AtspiRole of an #AtspiAccessible object. a pointer to the #AtspiAccessible object on which to operate. + line="612">a pointer to the #AtspiAccessible object on which to operate. @@ -984,14 +1021,14 @@ This role's name can be obtained via atspi_accessible_get_role_name (). throws="1"> Gets a UTF-8 string corresponding to the name of the role played by an object. + line="638">Gets a UTF-8 string corresponding to the name of the role played by an object. This method will return useful values for roles that fall outside the enumeration used in atspi_accessible_get_role (). a UTF-8 string specifying the type of UI role played by an + line="646">a UTF-8 string specifying the type of UI role played by an #AtspiAccessible object. @@ -999,25 +1036,24 @@ enumeration used in atspi_accessible_get_role (). a pointer to the #AtspiAccessible object on which to operate. + line="640">a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiSelection interface for an #AtspiAccessible. + line="1498">Gets the #AtspiSelection interface for an #AtspiAccessible. Use atspi_accessible_get_selection_iface instead. a pointer to an #AtspiSelection interface + line="1504">a pointer to an #AtspiSelection interface instance, or NULL if @obj does not implement #AtspiSelection. @@ -1025,22 +1061,21 @@ enumeration used in atspi_accessible_get_role (). a pointer to the #AtspiAccessible instance to query. + line="1500">a pointer to the #AtspiAccessible instance to query. + c:identifier="atspi_accessible_get_selection_iface"> Gets the #AtspiSelection interface for an #AtspiAccessible. + line="1515">Gets the #AtspiSelection interface for an #AtspiAccessible. a pointer to an #AtspiSelection interface + line="1521">a pointer to an #AtspiSelection interface instance, or NULL if @obj does not implement #AtspiSelection. @@ -1048,7 +1083,7 @@ enumeration used in atspi_accessible_get_role (). a pointer to the #AtspiAccessible instance to query. + line="1517">a pointer to the #AtspiAccessible instance to query. @@ -1057,12 +1092,12 @@ enumeration used in atspi_accessible_get_role (). c:identifier="atspi_accessible_get_state_set"> Gets the states currently held by an object. + line="711">Gets the states currently held by an object. a pointer to an #AtspiStateSet representing an + line="717">a pointer to an #AtspiStateSet representing an object's current state set. @@ -1070,25 +1105,24 @@ object's current state set. a pointer to the #AtspiAccessible object on which to operate. + line="713">a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiTable interface for an #AtspiAccessible. + line="1548">Gets the #AtspiTable interface for an #AtspiAccessible. Use atspi_accessible_get_table_iface instead. a pointer to an #AtspiTable interface instance, or + line="1554">a pointer to an #AtspiTable interface instance, or NULL if @obj does not implement #AtspiTable. @@ -1096,7 +1130,7 @@ object's current state set. a pointer to the #AtspiAccessible instance to query. + line="1550">a pointer to the #AtspiAccessible instance to query. @@ -1105,12 +1139,12 @@ object's current state set. c:identifier="atspi_accessible_get_table_cell"> Gets the #AtspiTableCell interface for an #AtspiAccessible. + line="1580">Gets the #AtspiTableCell interface for an #AtspiAccessible. a pointer to an #AtspiTableCell interface instance, + line="1586">a pointer to an #AtspiTableCell interface instance, or NULL if @obj does not implement #AtspiTable. @@ -1118,22 +1152,21 @@ object's current state set. a pointer to the #AtspiAccessible instance to query. + line="1582">a pointer to the #AtspiAccessible instance to query. + c:identifier="atspi_accessible_get_table_iface"> Gets the #AtspiTable interface for an #AtspiAccessible. + line="1565">Gets the #AtspiTable interface for an #AtspiAccessible. a pointer to an #AtspiTable interface instance, or + line="1571">a pointer to an #AtspiTable interface instance, or NULL if @obj does not implement #AtspiTable. @@ -1141,25 +1174,24 @@ object's current state set. a pointer to the #AtspiAccessible instance to query. + line="1567">a pointer to the #AtspiAccessible instance to query. Gets the #AtspiTable interface for an #AtspiAccessible. + line="1595">Gets the #AtspiTable interface for an #AtspiAccessible. Use atspi_accessible_get_text_iface instead. a pointer to an #AtspiText interface instance, or + line="1601">a pointer to an #AtspiText interface instance, or NULL if @obj does not implement #AtspiText. @@ -1167,14 +1199,13 @@ object's current state set. a pointer to the #AtspiAccessible instance to query. + line="1597">a pointer to the #AtspiAccessible instance to query. + c:identifier="atspi_accessible_get_text_iface"> Gets the #AtspiTable interface for an #AtspiAccessible. @@ -1200,20 +1231,20 @@ object's current state set. throws="1"> Gets the toolkit name for an #AtspiAccessible object. + line="874">Gets the toolkit name for an #AtspiAccessible object. Only works on application root objects. a UTF-8 string indicating the toolkit name for the #AtspiAccessible object or NULL on exception. + line="881">a UTF-8 string indicating the toolkit name for the #AtspiAccessible object or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. + line="876">a pointer to the #AtspiAccessible object on which to operate. @@ -1223,38 +1254,37 @@ Only works on application root objects. throws="1"> Gets the toolkit version for an #AtspiAccessible object. + line="898">Gets the toolkit version for an #AtspiAccessible object. Only works on application root objects. a UTF-8 string indicating the toolkit version for the #AtspiAccessible object or NULL on exception. + line="905">a UTF-8 string indicating the toolkit version for the #AtspiAccessible object or NULL on exception. a pointer to the #AtspiAccessible object on which to operate. + line="900">a pointer to the #AtspiAccessible object on which to operate. Gets the #AtspiTable interface for an #AtspiAccessible. + line="1627">Gets the #AtspiTable interface for an #AtspiAccessible. Use atspi_accessible_get_value_iface instead. a pointer to an #AtspiValue interface instance, or + line="1633">a pointer to an #AtspiValue interface instance, or NULL if @obj does not implement #AtspiValue. @@ -1262,22 +1292,21 @@ Only works on application root objects. a pointer to the #AtspiAccessible instance to query. + line="1629">a pointer to the #AtspiAccessible instance to query. + c:identifier="atspi_accessible_get_value_iface"> Gets the #AtspiTable interface for an #AtspiAccessible. + line="1644">Gets the #AtspiTable interface for an #AtspiAccessible. a pointer to an #AtspiValue interface instance, or + line="1650">a pointer to an #AtspiValue interface instance, or NULL if @obj does not implement #AtspiValue. @@ -1285,7 +1314,7 @@ Only works on application root objects. a pointer to the #AtspiAccessible instance to query. + line="1646">a pointer to the #AtspiAccessible instance to query. @@ -1294,7 +1323,7 @@ Only works on application root objects. c:identifier="atspi_accessible_set_cache_mask"> Sets the type of data to cache for accessibles. + line="1729">Sets the type of data to cache for accessibles. If this is not set for an application or is reset to ATSPI_CACHE_UNDEFINED, then the desktop's cache flag will be used. If the desktop's cache flag is also undefined, then all possible data will @@ -1309,14 +1338,14 @@ events are not raised / to aid in testing for such bugs. The #AtspiAccessible to operate on. Must be the desktop or + line="1731">The #AtspiAccessible to operate on. Must be the desktop or the root of an application. An #AtspiCache specifying a bit mask of the types of data to cache. + line="1733">An #AtspiCache specifying a bit mask of the types of data to cache. @@ -1362,7 +1391,7 @@ events are not raised / to aid in testing for such bugs. The signal "mode-changed" is emitted by a screen reader to indicate + line="300">The signal "mode-changed" is emitted by a screen reader to indicate that its mode has changed. This signal supports the following details: focus-tracking flat-review @@ -1376,13 +1405,13 @@ caret-tracking a boolean specifying whether the mode is being toggled on or off. + line="303">a boolean specifying whether the mode is being toggled on or off. an optional string explaining why the mode changed. + line="304">an optional string explaining why the mode changed. @@ -1390,7 +1419,7 @@ caret-tracking The signal "region-changed" is emitted by a screen reader to indicate + line="277">The signal "region-changed" is emitted by a screen reader to indicate that it is now reading or tracking a new object, or, a new piece of text within an object. This allows a magnifier to gain the information needed to highlight the object that the screen reader is reading. @@ -1401,14 +1430,14 @@ needed to highlight the object that the screen reader is reading. an integer specifying the current offset of the text being read, + line="280">an integer specifying the current offset of the text being read, if the object is textual. an integer specifying the ending offset of the text being read, + line="282">an integer specifying the ending offset of the text being read, if the object is textual. @@ -1475,7 +1504,7 @@ needed to highlight the object that the screen reader is reading. Invoke the action indicated by #index. - + line="46">Get the description of '@i-th' action invocable on an object implementing #AtspiAction. Use atspi_action_get_action_description instead. - + filename="atspi/atspi-action.c" line="171">Get the name of the '@i-th' action invocable on an object implementing #AtspiAction. - + line="130">Get the name of the '@i-th' action invocable on an object implementing #AtspiAction. Use atspi_action_get_action_name instead. - + glib:type-name="AtspiApplication" glib:get-type="atspi_application_get_type" glib:type-struct="ApplicationClass"> + An interface identifying the root object associated +with a running application. + +An interface identifying an object which is the root of the +hierarchy associated with a running application. @@ -1806,8 +1842,8 @@ needed to highlight the object that the screen reader is reading. c:type="ATSPI_COMPONENTLAYER_COUNT"> One higher than the highest valid value of #AtspiComponentLayer. - + line="311">One higher than the highest valid value of #AtspiComponentLayer. + c:type="ATSPI_COORD_TYPE_COUNT"> One higher than the highest valid value of #AtspiCoordType. - + line="153">One higher than the highest valid value of #AtspiCoordType. + c:type="AtspiCollection" glib:type-name="AtspiCollection" glib:get-type="atspi_collection_get_type"> + An interface designed to allow accessibles which satisfy a set of +criteria to be returned. + +An interface designed to allow accessibles which satisfy a set of +criteria to be returned. This interface can be used to avoid iteration +or client-side search of the object tree. @@ -1917,7 +1961,7 @@ needed to highlight the object that the screen reader is reading. The active descendant of the given object. + line="274">The active descendant of the given object. Not yet implemented. @@ -1932,13 +1976,13 @@ Not yet implemented. throws="1"> Gets all #AtspiAccessible objects from the @collection matching a given + line="112">Gets all #AtspiAccessible objects from the @collection matching a given @rule. All + line="124">All #AtspiAccessible objects matching the given match rule. @@ -1948,19 +1992,19 @@ Not yet implemented. A pointer to the #AtspiCollection to query. + line="114">A pointer to the #AtspiCollection to query. An #AtspiMatchRule describing the match criteria. + line="115">An #AtspiMatchRule describing the match criteria. An #AtspiCollectionSortOrder specifying the way the results are to + line="116">An #AtspiCollectionSortOrder specifying the way the results are to be sorted. @@ -1968,13 +2012,13 @@ Not yet implemented. The maximum number of results to return, or 0 for no limit. + line="118">The maximum number of results to return, or 0 for no limit. Not supported. + line="119">Not supported. @@ -1984,13 +2028,13 @@ Not yet implemented. throws="1"> Gets all #AtspiAccessible objects from the @collection, before + line="217">Gets all #AtspiAccessible objects from the @collection, before @current_object, matching a given @rule. All + line="232">All #AtspiAccessible objects matching the given match rule that preceed @current_object. @@ -2001,25 +2045,25 @@ Not yet implemented. A pointer to the #AtspiCollection to query. + line="219">A pointer to the #AtspiCollection to query. Upon reaching this object, searching should stop. + line="220">Upon reaching this object, searching should stop. An #AtspiMatchRule describing the match criteria. + line="221">An #AtspiMatchRule describing the match criteria. An #AtspiCollectionSortOrder specifying the way the results are to + line="222">An #AtspiCollectionSortOrder specifying the way the results are to be sorted. @@ -2027,7 +2071,7 @@ Not yet implemented. An #AtspiCollectionTreeTraversalType specifying restrictions on + line="224">An #AtspiCollectionTreeTraversalType specifying restrictions on the objects to be traversed. @@ -2035,13 +2079,13 @@ Not yet implemented. The maximum number of results to return, or 0 for no limit. + line="226">The maximum number of results to return, or 0 for no limit. Not supported. + line="227">Not supported. @@ -2051,13 +2095,13 @@ Not yet implemented. throws="1"> Gets all #AtspiAccessible objects from the @collection, after + line="156">Gets all #AtspiAccessible objects from the @collection, after @current_object, matching a given @rule. All + line="175">All #AtspiAccessible objects matching the given match rule after @current_object. @@ -2068,25 +2112,25 @@ Not yet implemented. A pointer to the #AtspiCollection to query. + line="158">A pointer to the #AtspiCollection to query. The object at which to start searching. + line="159">The object at which to start searching. An #AtspiMatchRule describing the match criteria. + line="160">An #AtspiMatchRule describing the match criteria. An #AtspiCollectionSortOrder specifying the way the results are to + line="161">An #AtspiCollectionSortOrder specifying the way the results are to be sorted. @@ -2094,7 +2138,7 @@ Not yet implemented. An #AtspiCollectionTreeTraversalType specifying restrictions on + line="163">An #AtspiCollectionTreeTraversalType specifying restrictions on the objects to be traversed. @@ -2102,7 +2146,7 @@ Not yet implemented. If #TRUE, only descendants of @current_object's parent + line="165">If #TRUE, only descendants of @current_object's parent will be returned. Otherwise (if #FALSE), any accessible may be returned if it would preceed @current_object in a flattened hierarchy. @@ -2111,13 +2155,13 @@ Not yet implemented. The maximum number of results to return, or 0 for no limit. + line="169">The maximum number of results to return, or 0 for no limit. Not supported. + line="170">Not supported. @@ -2127,7 +2171,7 @@ Not yet implemented. throws="1"> Not yet implemented. + line="39">Not yet implemented. @@ -2148,7 +2192,7 @@ Not yet implemented. c:type="AtspiCollectionMatchType"> Enumeration used by #AtspiMatchRule to specify + line="196">Enumeration used by #AtspiMatchRule to specify how to interpret #AtspiAccessible objects. glib:name="ATSPI_Collection_MATCH_INVALID"> Indicates an error condition or + line="198">Indicates an error condition or uninitialized value. glib:name="ATSPI_Collection_MATCH_ALL"> #TRUE if all of the criteria are met. + line="200">#TRUE if all of the criteria are met. glib:name="ATSPI_Collection_MATCH_ANY"> #TRUE if any of the criteria are met. + line="201">#TRUE if any of the criteria are met. glib:name="ATSPI_Collection_MATCH_NONE"> #TRUE if none of the criteria are met. + line="202">#TRUE if none of the criteria are met. glib:name="ATSPI_Collection_MATCH_EMPTY"> Same as @ATSPI_Collection_MATCH_ALL if + line="203">Same as @ATSPI_Collection_MATCH_ALL if the criteria is non-empty; for empty criteria this rule requires returned value to also have empty set. @@ -2205,7 +2249,7 @@ value to also have empty set. glib:name="ATSPI_Collection_MATCH_LAST_DEFINED"> Used only to determine the end of the + line="206">Used only to determine the end of the enumeration. @@ -2215,7 +2259,7 @@ enumeration. c:type="AtspiCollectionSortOrder"> Enumeration used by interface #AtspiCollection to specify + line="160">Enumeration used by interface #AtspiCollection to specify the way #AtspiAccesible objects should be sorted. glib:name="ATSPI_Collection_SORT_ORDER_INVALID"> Invalid sort order + line="162">Invalid sort order glib:name="ATSPI_Collection_SORT_ORDER_CANONICAL"> Canonical sort order + line="163">Canonical sort order glib:name="ATSPI_Collection_SORT_ORDER_FLOW"> Flow sort order + line="164">Flow sort order glib:name="ATSPI_Collection_SORT_ORDER_TAB"> Tab sort order + line="165">Tab sort order glib:name="ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL"> Reverse canonical sort order + line="166">Reverse canonical sort order glib:name="ATSPI_Collection_SORT_ORDER_REVERSE_FLOW"> Reverse flow sort order + line="167">Reverse flow sort order glib:name="ATSPI_Collection_SORT_ORDER_REVERSE_TAB"> Reverse tab sort order + line="168">Reverse tab sort order glib:name="ATSPI_Collection_SORT_ORDER_LAST_DEFINED"> Used only to determine the end of the + line="169">Used only to determine the end of the enumeration. @@ -2297,7 +2341,7 @@ enumeration. c:type="AtspiCollectionTreeTraversalType"> Enumeration used by interface #AtspiCollection to specify + line="230">Enumeration used by interface #AtspiCollection to specify restrictions on #AtspiAccesible objects to be traversed. glib:name="ATSPI_Collection_TREE_RESTRICT_CHILDREN"> Restrict children tree traveral + line="232">Restrict children tree traveral glib:name="ATSPI_Collection_TREE_RESTRICT_SIBLING"> Restrict sibling tree traversal + line="233">Restrict sibling tree traversal glib:name="ATSPI_Collection_TREE_INORDER"> In-order tree traversal. + line="234">In-order tree traversal. glib:name="ATSPI_Collection_TREE_LAST_DEFINED"> Used only to determine the end of the + line="235">Used only to determine the end of the enumeration. @@ -2342,17 +2386,30 @@ enumeration. c:type="AtspiComponent" glib:type-name="AtspiComponent" glib:get-type="atspi_component_get_type"> + An interface implemented by objects which have onscreen visual +representations. + +The Component interface is implemented by objects which occupy on-screen +space, e.g. objects which have onscreen visual representations. The methods +in Component allow clients to identify where the objects lie in the onscreen +coordinate system, their relative size, stacking order, and position. It +also provides a mechanism whereby keyboard focus may be transferred to +specific user interface elements programmatically. This is a 2D API. +Coordinates of 3D objects are projected into the 2-dimensional screen view +for purposes of this interface. Queries whether a given #AtspiComponent contains a particular point. + line="79">Queries whether a given #AtspiComponent contains a particular point. #TRUE if the specified component contains the point (@x, @y), + line="89">#TRUE if the specified component contains the point (@x, @y), #FALSE otherwise. @@ -2360,25 +2417,25 @@ enumeration. a pointer to the #AtspiComponent to query. + line="81">a pointer to the #AtspiComponent to query. a #gint specifying the x coordinate in question. + line="82">a #gint specifying the x coordinate in question. a #gint specifying the y coordinate in question. + line="83">a #gint specifying the y coordinate in question. the desired coordinate system of the point (@x, @y) + line="84">the desired coordinate system of the point (@x, @y) (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN). @@ -2389,12 +2446,12 @@ enumeration. throws="1"> Gets the accessible child at a given coordinate within an #AtspiComponent. + line="110">Gets the accessible child at a given coordinate within an #AtspiComponent. a pointer to an + line="120">a pointer to an #AtspiAccessible child of the specified component which contains the point (@x, @y), or NULL if no child contains the point. @@ -2404,25 +2461,25 @@ enumeration. a pointer to the #AtspiComponent to query. + line="112">a pointer to the #AtspiComponent to query. a #gint specifying the x coordinate of the point in question. + line="113">a #gint specifying the x coordinate of the point in question. a #gint specifying the y coordinate of the point in question. + line="114">a #gint specifying the y coordinate of the point in question. the coordinate system of the point (@x, @y) + line="115">the coordinate system of the point (@x, @y) (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). @@ -2433,19 +2490,19 @@ enumeration. throws="1"> Gets the opacity/alpha value of a component, if alpha blending is in use. + line="299">Gets the opacity/alpha value of a component, if alpha blending is in use. the opacity value of a component, as a #gdouble between 0.0 and 1.0. + line="305">the opacity value of a component, as a #gdouble between 0.0 and 1.0. The #AtspiComponent to be queried. + line="301">The #AtspiComponent to be queried. @@ -2455,27 +2512,27 @@ enumeration. throws="1"> Gets the bounding box of the specified #AtspiComponent. + line="143">Gets the bounding box of the specified #AtspiComponent. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING. An #AtspiRect giving the accessible's extents. + line="153">An #AtspiRect giving the accessible's extents. a pointer to the #AtspiComponent to query. + line="145">a pointer to the #AtspiComponent to query. the desired coordinate system into which to return the results, + line="146">the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). @@ -2486,20 +2543,20 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Queries which layer the component is painted into, to help determine its + line="240">Queries which layer the component is painted into, to help determine its visibility in terms of stacking order. the #AtspiComponentLayer into which this component is painted. + line="247">the #AtspiComponentLayer into which this component is painted. a pointer to the #AtspiComponent to query. + line="242">a pointer to the #AtspiComponent to query. @@ -2509,13 +2566,13 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Queries the z stacking order of a component which is in the MDI or window + line="259">Queries the z stacking order of a component which is in the MDI or window layer. (Bigger z-order numbers mean nearer the top) a #gshort indicating the stacking order of the component + line="266">a #gshort indicating the stacking order of the component in the MDI layer, or -1 if the component is not in the MDI layer. @@ -2523,7 +2580,7 @@ STATE_VISIBLE and STATE_SHOWING. a pointer to the #AtspiComponent to query. + line="261">a pointer to the #AtspiComponent to query. @@ -2533,27 +2590,27 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Gets the minimum x and y coordinates of the specified #AtspiComponent. + line="181">Gets the minimum x and y coordinates of the specified #AtspiComponent. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING. An #AtspiPoint giving the @obj's position. + line="191">An #AtspiPoint giving the @obj's position. a pointer to the #AtspiComponent to query. + line="183">a pointer to the #AtspiComponent to query. the desired coordinate system into which to return the results, + line="184">the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). @@ -2564,21 +2621,21 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Gets the size of the specified #AtspiComponent. + line="214">Gets the size of the specified #AtspiComponent. The returned values are meaningful only if the Component has both STATE_VISIBLE and STATE_SHOWING. An #AtspiPoint giving the @obj's size. + line="222">An #AtspiPoint giving the @obj's size. a pointer to the #AtspiComponent to query. + line="216">a pointer to the #AtspiComponent to query. @@ -2588,20 +2645,20 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Attempts to set the keyboard input focus to the specified + line="279">Attempts to set the keyboard input focus to the specified #AtspiComponent. #TRUE if successful, #FALSE otherwise. + line="286">#TRUE if successful, #FALSE otherwise. a pointer to the #AtspiComponent on which to operate. + line="281">a pointer to the #AtspiComponent on which to operate. @@ -2611,26 +2668,26 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Scrolls whatever container of the #AtspiComponent object so it becomes + line="441">Scrolls whatever container of the #AtspiComponent object so it becomes visible on the screen. #TRUE if successful, #FALSE otherwise. + line="450">#TRUE if successful, #FALSE otherwise. a pointer to the #AtspiComponent object on which to operate. + line="443">a pointer to the #AtspiComponent object on which to operate. a #AtspiScrollType indicating where the object should be placed on the + line="444">a #AtspiScrollType indicating where the object should be placed on the screen. @@ -2641,39 +2698,39 @@ visible on the screen. throws="1"> Scrolls whatever container of the #AtspiComponent object so it becomes + line="467">Scrolls whatever container of the #AtspiComponent object so it becomes visible on the screen at a given position. #TRUE if successful, #FALSE otherwise. + line="479">#TRUE if successful, #FALSE otherwise. a pointer to the #AtspiComponent object on which to operate. + line="469">a pointer to the #AtspiComponent object on which to operate. a #AtspiCoordType indicating whether the coordinates are relative to + line="470">a #AtspiCoordType indicating whether the coordinates are relative to the screen, to the window, or to the parent object. the x coordinate of the point to reach + line="472">the x coordinate of the point to reach the y coordinate of the point to reach + line="473">the y coordinate of the point to reach @@ -2683,49 +2740,49 @@ visible on the screen at a given position. throws="1"> Moves and resizes the specified component. + line="317">Moves and resizes the specified component. #TRUE if successful; #FALSE otherwise. + line="329">#TRUE if successful; #FALSE otherwise. a pointer to the #AtspiComponent to move. + line="319">a pointer to the #AtspiComponent to move. the new vertical position to which the component should be moved. + line="320">the new horizontal position to which the component should be moved. the new horizontal position to which the component should be moved. + line="321">the new vertical position to which the component should be moved. the width to which the component should be resized. + line="322">the width to which the component should be resized. the height to which the component should be resized. + line="323">the height to which the component should be resized. the coordinate system in which the position is specified. + line="324">the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). @@ -2736,37 +2793,37 @@ visible on the screen at a given position. throws="1"> Moves the component to the specified position. + line="383">Moves the component to the specified position. #TRUE if successful; #FALSE otherwise. + line="393">#TRUE if successful; #FALSE otherwise. a pointer to the #AtspiComponent to move. + line="385">a pointer to the #AtspiComponent to move. the new vertical position to which the component should be moved. + line="386">the new horizontal position to which the component should be moved. the new horizontal position to which the component should be moved. + line="387">the new vertical position to which the component should be moved. the coordinate system in which the position is specified. + line="388">the coordinate system in which the position is specified. (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN). @@ -2777,31 +2834,31 @@ visible on the screen at a given position. throws="1"> Resizes the specified component to the given coordinates. + line="414">Resizes the specified component to the given pixel dimensions. #TRUE if successful; #FALSE otherwise. + line="422">#TRUE if successful; #FALSE otherwise. a pointer to the #AtspiComponent to query. + line="416">a pointer to the #AtspiComponent to query. the width to which the component should be resized. + line="417">the width to which the component should be resized. the height to which the component should be resized. + line="418">the height to which the component should be resized. @@ -2813,7 +2870,7 @@ visible on the screen at a given position. c:type="AtspiComponentLayer"> The #AtspiComponentLayer of an #AtspiComponent instance indicates its + line="258">The #AtspiComponentLayer of an #AtspiComponent instance indicates its relative stacking order with respect to the onscreen visual representation of the UI. #AtspiComponentLayer, in combination with #AtspiComponent bounds information, can be used to compute the visibility of all or part of a @@ -2838,7 +2895,7 @@ siblings if their bounds intersect. The order of layers, from bottom to top, glib:name="ATSPI_LAYER_INVALID"> Indicates an error condition or uninitialized value. + line="260">Indicates an error condition or uninitialized value. The bottom-most layer, over which everything else + line="261">The bottom-most layer, over which everything else is painted. The 'desktop background' is generally in this layer. glib:name="ATSPI_LAYER_CANVAS"> The 'background' layer for most content renderers and + line="263">The 'background' layer for most content renderers and UI #AtspiComponent containers. glib:name="ATSPI_LAYER_WIDGET"> The layer in which the majority of ordinary + line="265">The layer in which the majority of ordinary 'foreground' widgets reside. glib:name="ATSPI_LAYER_MDI"> A special layer between @ATSPI_LAYER_CANVAS and + line="267">A special layer between @ATSPI_LAYER_CANVAS and @ATSPI_LAYER_WIDGET, in which the 'pseudo windows' (e.g. the MDI frames) reside. See #atspi_component_get_mdi_z_order. @@ -2888,7 +2945,7 @@ reside. See #atspi_component_get_mdi_z_order. glib:name="ATSPI_LAYER_POPUP"> A layer for popup window content, above + line="270">A layer for popup window content, above @ATSPI_LAYER_WIDGET. glib:name="ATSPI_LAYER_OVERLAY"> The topmost layer. + line="272">The topmost layer. glib:name="ATSPI_LAYER_WINDOW"> The layer in which a toplevel window background usually + line="273">The layer in which a toplevel window background usually resides. glib:name="ATSPI_LAYER_LAST_DEFINED"> Used only to determine the end of the + line="275">Used only to determine the end of the enumeration. @@ -2927,7 +2984,7 @@ enumeration. c:type="AtspiCoordType"> Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces + line="134">Enumeration used by #AtspiComponent, #AtspiImage, and #AtspiText interfaces to specify whether coordinates are relative to the window or the screen. glib:name="ATSPI_COORD_TYPE_SCREEN"> Specifies xy coordinates relative to the screen. + line="136">Specifies xy coordinates relative to the screen. glib:name="ATSPI_COORD_TYPE_WINDOW"> Specifies xy coordinates relative to the widget's + line="137">Specifies xy coordinates relative to the widget's top-level window. glib:name="ATSPI_COORD_TYPE_PARENT"> Specifies xy coordinates relative to the widget's + line="139">Specifies xy coordinates relative to the widget's immediate parent. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + glib:type-name="AtspiDevice" glib:get-type="atspi_device_get_type" glib:type-struct="DeviceClass"> - + Creates a new #AtspiDevice with a specified callback function. - + line="90">Creates a new #AtspiDevice with a specified callback function. + a pointer to a newly-created #AtspiDevice. + line="95">a pointer to a newly-created #AtspiDevice. - + @@ -3299,24 +3356,76 @@ immediate parent. + + Synthesizes a mouse event at a specific screen coordinate. +Most AT clients should use the #AccessibleAction interface when +tempted to generate mouse events, rather than this method. +Event names: b1p = button 1 press; b2r = button 2 release; + b3c = button 3 click; b2d = button 2 double-click; + abs = absolute motion; rel = relative motion. + + + + + + + the device. + + + + The #AtspiAccessible that should receive the click. + + + + a #gint indicating the x coordinate of the mouse event, relative to + @obj.. + + + + a #gint indicating the y coordinate of the mouse event, relative to + @obj.. + + + + a string indicating which mouse event to be synthesized + (e.g. "b1p", "b1c", "b2r", "rel", "abs"). + + + + Returns the locked modifiers (ie, num lock, caps lock) associated with this + line="354">Returns the locked modifiers (ie, num lock, caps lock) associated with this keyboard. a guint of modifier flags. + line="361">a guint of modifier flags. the device. + line="356">the device. @@ -3324,7 +3433,7 @@ keyboard. Gets the modifier for a given keycode, if one exists. Does not creatt a new + line="333">Gets the modifier for a given keycode, if one exists. Does not create a new mapping. This function should be used when the intention is to query a locking modifier such as num lock via atspi_device_get_locked_modifiers, rather than to add key grabs. @@ -3332,20 +3441,20 @@ rather than to add key grabs. the modifier that is mapped to this keycode. + line="343">the modifier that is mapped to this keycode. the device. + line="335">the device. the keycode to map. + line="336">the keycode to map. @@ -3353,14 +3462,14 @@ rather than to add key grabs. Attempts to grab the entire keyboard. This should only be done + line="372">Attempts to grab the entire keyboard. This should only be done temporarily, as it may conflict with other applications that also want to grab the keyboard. #TRUE if successful, #FALSE otherwise. + line="379">#TRUE if successful, #FALSE otherwise. @@ -3372,7 +3481,7 @@ grab the keyboard. Maps the specified key code to a modifier so that it can be used in + line="293">Maps the specified key code to a modifier so that it can be used in conjunction with other keys to create a key grab. If the given keycode is already mapped, then this function will return the modifier that is currently mapped to the keycode, without doing anything else. Otherwise, @@ -3384,7 +3493,7 @@ then it will use the first modifier by default. the modifier that is now mapped to this keycode. This return + line="307">the modifier that is now mapped to this keycode. This return value can be passed to atspi_device_add_key_grab. @@ -3392,13 +3501,13 @@ value can be passed to atspi_device_add_key_grab. the device. + line="295">the device. the keycode to map. + line="296">the keycode to map. @@ -3406,7 +3515,7 @@ value can be passed to atspi_device_add_key_grab. Removes the key grab specified by @id. + line="221">Removes the key grab specified by @id. @@ -3415,13 +3524,13 @@ value can be passed to atspi_device_add_key_grab. the device. + line="223">the device. the identifier of the grab to be removed. + line="224">the identifier of the grab to be removed. @@ -3429,7 +3538,7 @@ value can be passed to atspi_device_add_key_grab. Removes a keyboard grab added via a call to atspi_device_add_keyboard. + line="390">Removes a keyboard grab added via a call to atspi_device_add_keyboard. @@ -3443,7 +3552,7 @@ value can be passed to atspi_device_add_key_grab. Removes a mapped modifier from the given keycode. + line="319">Removes a mapped modifier from the given keycode. @@ -3452,23 +3561,24 @@ value can be passed to atspi_device_add_key_grab. the device. + line="321">the device. the keycode to unmap. + line="322">the keycode to unmap. - + an identifier that can be later used to remove the grab. + line="195">an identifier that can be later used to remove the grab, or 0 +if the key/modifier combination could not be grabbed. Add a key grab for the given key/modifier combination. @@ -3476,13 +3586,13 @@ Add a key grab for the given key/modifier combination. the device. + line="187">the device. a #AtspiKeyDefinition specifying the key code to grab. + line="188">a #AtspiKeyDefinition specifying the key code to grab. destroy="3"> the function to call when the + line="189">the function to call when the given key is pressed. @@ -3504,7 +3614,7 @@ Add a key grab for the given key/modifier combination. allow-none="1"> Data to be passed to @callback. + line="191">Data to be passed to @callback. scope="async"> callback function to be called when @callback is + line="192">callback function to be called when @callback is destroyed. @@ -3522,9 +3632,9 @@ Add a key grab for the given key/modifier combination. c:identifier="atspi_device_add_key_watcher"> Add a callback that will receive a notification whenever a key is + line="249">Add a callback that will receive a notification whenever a key is pressed or released. - + @@ -3532,7 +3642,7 @@ pressed or released. the device. + line="251">the device. destroy="2"> the function to call when the given key is + line="252">the function to call when the given key is pressed. @@ -3555,7 +3665,7 @@ pressed or released. closure="0"> Data to be passed to @callback. + line="254">Data to be passed to @callback. destroy="0"> callback function to be called + line="255">callback function to be called when @callback is destroyed. + + Synthesizes a mouse event at a specific screen coordinate. +Most AT clients should use the #AccessibleAction interface when +tempted to generate mouse events, rather than this method. +Event names: b1p = button 1 press; b2r = button 2 release; + b3c = button 3 click; b2d = button 2 double-click; + abs = absolute motion; rel = relative motion. + + + + + + + the device. + + + + The #AtspiAccessible that should receive the click. + + + + a #gint indicating the x coordinate of the mouse event, relative to + @obj.. + + + + a #gint indicating the y coordinate of the mouse event, relative to + @obj.. + + + + a string indicating which mouse event to be synthesized + (e.g. "b1p", "b1c", "b2r", "rel", "abs"). + + + + - + @@ -3588,20 +3750,20 @@ pressed or released. c:identifier="atspi_device_get_locked_modifiers"> Returns the locked modifiers (ie, num lock, caps lock) associated with this + line="354">Returns the locked modifiers (ie, num lock, caps lock) associated with this keyboard. - + a guint of modifier flags. + line="361">a guint of modifier flags. the device. + line="356">the device. @@ -3609,28 +3771,28 @@ keyboard. Gets the modifier for a given keycode, if one exists. Does not creatt a new + line="333">Gets the modifier for a given keycode, if one exists. Does not create a new mapping. This function should be used when the intention is to query a locking modifier such as num lock via atspi_device_get_locked_modifiers, rather than to add key grabs. - + the modifier that is mapped to this keycode. + line="343">the modifier that is mapped to this keycode. the device. + line="335">the device. the keycode to map. + line="336">the keycode to map. @@ -3638,14 +3800,14 @@ rather than to add key grabs. Attempts to grab the entire keyboard. This should only be done + line="372">Attempts to grab the entire keyboard. This should only be done temporarily, as it may conflict with other applications that also want to grab the keyboard. - + #TRUE if successful, #FALSE otherwise. + line="379">#TRUE if successful, #FALSE otherwise. @@ -3657,7 +3819,7 @@ grab the keyboard. Maps the specified key code to a modifier so that it can be used in + line="293">Maps the specified key code to a modifier so that it can be used in conjunction with other keys to create a key grab. If the given keycode is already mapped, then this function will return the modifier that is currently mapped to the keycode, without doing anything else. Otherwise, @@ -3665,11 +3827,11 @@ it will use the last modifier that AT-SPI used to map a key. If no keys have yet been mapped using this device, then it will look for a modifier that is not currently being used. If no unused modifier can be found, then it will use the first modifier by default. - + the modifier that is now mapped to this keycode. This return + line="307">the modifier that is now mapped to this keycode. This return value can be passed to atspi_device_add_key_grab. @@ -3677,19 +3839,19 @@ value can be passed to atspi_device_add_key_grab. the device. + line="295">the device. the keycode to map. + line="296">the keycode to map. - + @@ -3710,7 +3872,7 @@ value can be passed to atspi_device_add_key_grab. - + @@ -3718,8 +3880,8 @@ value can be passed to atspi_device_add_key_grab. c:identifier="atspi_device_remove_key_grab"> Removes the key grab specified by @id. - + line="221">Removes the key grab specified by @id. + @@ -3727,13 +3889,13 @@ value can be passed to atspi_device_add_key_grab. the device. + line="223">the device. the identifier of the grab to be removed. + line="224">the identifier of the grab to be removed. @@ -3742,8 +3904,8 @@ value can be passed to atspi_device_add_key_grab. c:identifier="atspi_device_ungrab_keyboard"> Removes a keyboard grab added via a call to atspi_device_add_keyboard. - + line="390">Removes a keyboard grab added via a call to atspi_device_add_keyboard. + @@ -3756,8 +3918,8 @@ value can be passed to atspi_device_add_key_grab. Removes a mapped modifier from the given keycode. - + line="319">Removes a mapped modifier from the given keycode. + @@ -3765,13 +3927,13 @@ value can be passed to atspi_device_add_key_grab. the device. + line="321">the device. the keycode to unmap. + line="322">the keycode to unmap. @@ -3783,7 +3945,7 @@ value can be passed to atspi_device_add_key_grab. - + @@ -3791,7 +3953,7 @@ value can be passed to atspi_device_add_key_grab. - + @@ -3813,13 +3975,13 @@ value can be passed to atspi_device_add_key_grab. the device. + line="223">the device. the identifier of the grab to be removed. + line="224">the identifier of the grab to be removed. @@ -3831,7 +3993,7 @@ value can be passed to atspi_device_add_key_grab. the modifier that is now mapped to this keycode. This return + line="307">the modifier that is now mapped to this keycode. This return value can be passed to atspi_device_add_key_grab. @@ -3839,13 +4001,13 @@ value can be passed to atspi_device_add_key_grab. the device. + line="295">the device. the keycode to map. + line="296">the keycode to map. @@ -3861,13 +4023,13 @@ value can be passed to atspi_device_add_key_grab. the device. + line="321">the device. the keycode to unmap. + line="322">the keycode to unmap. @@ -3879,20 +4041,20 @@ value can be passed to atspi_device_add_key_grab. the modifier that is mapped to this keycode. + line="343">the modifier that is mapped to this keycode. the device. + line="335">the device. the keycode to map. + line="336">the keycode to map. @@ -3904,7 +4066,7 @@ value can be passed to atspi_device_add_key_grab. #TRUE if successful, #FALSE otherwise. + line="379">#TRUE if successful, #FALSE otherwise. @@ -3933,16 +4095,59 @@ value can be passed to atspi_device_add_key_grab. a guint of modifier flags. + line="361">a guint of modifier flags. the device. + line="356">the device. + + + + + + + + + + + + + + the device. + + The #AtspiAccessible that should receive the click. + + + + a #gint indicating the x coordinate of the mouse event, relative to + @obj.. + + + + a #gint indicating the y coordinate of the mouse event, relative to + @obj.. + + + + a string indicating which mouse event to be synthesized + (e.g. "b1p", "b1c", "b2r", "rel", "abs"). + + @@ -3952,7 +4157,7 @@ value can be passed to atspi_device_add_key_grab. glib:type-name="AtspiDeviceEvent" glib:get-type="atspi_device_event_get_type" c:symbol-prefix="device_event"> - + @@ -3986,12 +4191,12 @@ value can be passed to atspi_device_add_key_grab. Creates a new #AtspiDeviceLegacy. + line="340">Creates a new #AtspiDeviceLegacy. a pointer to a newly-created #AtspiDeviceLegacy. + line="345">a pointer to a newly-created #AtspiDeviceLegacy. @@ -4018,12 +4223,12 @@ value can be passed to atspi_device_add_key_grab. Creates a new #AtspiDeviceListener with a specified callback function. + line="218">Creates a new #AtspiDeviceListener with a specified callback function. a pointer to a newly-created #AtspiDeviceListener. + line="229">a pointer to a newly-created #AtspiDeviceListener. @@ -4034,7 +4239,7 @@ value can be passed to atspi_device_add_key_grab. destroy="2"> an #AtspiDeviceListenerCB callback function, + line="220">an #AtspiDeviceListenerCB callback function, or NULL. @@ -4044,7 +4249,7 @@ value can be passed to atspi_device_add_key_grab. allow-none="1"> a pointer to data which will be passed to the + line="222">a pointer to data which will be passed to the callback when invoked. @@ -4053,7 +4258,7 @@ callback when invoked. scope="async"> A #GDestroyNotify called when the listener is freed + line="224">A #GDestroyNotify called when the listener is freed and data associated with the callback should be freed. It can be NULL. @@ -4064,14 +4269,14 @@ and data associated with the callback should be freed. It can be NULL. introspectable="0"> Creates a new #AtspiDeviceListener with a specified callback function. + line="245">Creates a new #AtspiDeviceListener with a specified callback function. This method is similar to #atspi_device_listener_new, but callback takes no user data. a pointer to a newly-created #AtspiDeviceListener. + line="256">a pointer to a newly-created #AtspiDeviceListener. @@ -4081,7 +4286,7 @@ takes no user data. destroy="1"> an #AtspiDeviceListenerCB callback function, + line="247">an #AtspiDeviceListenerCB callback function, or NULL. @@ -4091,7 +4296,7 @@ takes no user data. scope="async"> A #GDestroyNotify called when the listener is freed + line="249">A #GDestroyNotify called when the listener is freed and data associated with the callback should be freed. It can be NULL. @@ -4115,7 +4320,7 @@ and data associated with the callback should be freed. It can be NULL. c:identifier="atspi_device_listener_add_callback"> Adds an in-process callback function to an existing #AtspiDeviceListener. + line="266">Adds an in-process callback function to an existing #AtspiDeviceListener. @@ -4124,7 +4329,7 @@ and data associated with the callback should be freed. It can be NULL. the #AtspiDeviceListener instance to modify. + line="268">the #AtspiDeviceListener instance to modify. destroy="1"> an #AtspiDeviceListenerCB function pointer. + line="269">an #AtspiDeviceListenerCB function pointer. scope="async"> A #GDestroyNotify called when the listener is freed + line="270">A #GDestroyNotify called when the listener is freed and data associated with the callback should be freed. It can be NULL. @@ -4152,7 +4357,7 @@ and data associated with the callback should be freed. It can be NULL. allow-none="1"> a pointer to data which will be passed to the + line="272">a pointer to data which will be passed to the callback when invoked. @@ -4162,7 +4367,7 @@ and data associated with the callback should be freed. It can be NULL. c:identifier="atspi_device_listener_remove_callback"> Removes an in-process callback function from an existing + line="293">Removes an in-process callback function from an existing #AtspiDeviceListener. @@ -4172,13 +4377,13 @@ and data associated with the callback should be freed. It can be NULL. the #AtspiDeviceListener instance to modify. + line="295">the #AtspiDeviceListener instance to modify. an #AtspiDeviceListenerCB function pointer. + line="296">an #AtspiDeviceListenerCB function pointer. @@ -4285,12 +4490,12 @@ relayed to the currently focussed application, #FALSE if the event delivery shou Creates a new #AtspiDeviceX11. + line="825">Creates a new #AtspiDeviceX11. a pointer to a newly-created #AtspiDeviceX11. + line="830">a pointer to a newly-created #AtspiDeviceX11. @@ -4321,7 +4526,7 @@ relayed to the currently focussed application, #FALSE if the event delivery shou filename="atspi/atspi-document.c" line="47">Gets the value of a single attribute, if specified for the document as a whole. Use atspi_document_get_document_attribute_value instead. - + a string indicating the name of a specific attribute. - + @@ -4352,14 +4557,14 @@ an empty string if the attribute is unspecified for the object. throws="1"> Gets all constant attributes for the document as a whole. For attributes + line="94">Gets all constant attributes for the document as a whole. For attributes that change within the document content, see @atspi_text_get_attribute_run instead. Use atspi_document_get_document_attributes instead. - + a #GHashTable + line="101">a #GHashTable containing the constant attributes of the document, as name-value pairs. @@ -4370,7 +4575,7 @@ that change within the document content, see @atspi_text_get_attribute_run inste a pointer to the #AtspiDocument object on which to operate. + line="96">a pointer to the #AtspiDocument object on which to operate. @@ -4380,12 +4585,12 @@ that change within the document content, see @atspi_text_get_attribute_run inste throws="1"> Gets the current page number of an #AccessibleDocument object. - + line="154">Gets the current page number of an #AccessibleDocument object. + a #gint indicating the current page number in the + line="160">a #gint indicating the current page number in the #AccessibleDocument object. @@ -4393,7 +4598,7 @@ that change within the document content, see @atspi_text_get_attribute_run inste a pointer to the #AtspiDocument object to query. + line="156">a pointer to the #AtspiDocument object to query. @@ -4405,7 +4610,7 @@ that change within the document content, see @atspi_text_get_attribute_run inste Gets the value of a single attribute, if specified for the document as a whole. - + a string indicating the name of a specific attribute. - + @@ -4434,13 +4639,13 @@ an empty string if the attribute is unspecified for the object. throws="1"> Gets all constant attributes for the document as a whole. For attributes + line="112">Gets all constant attributes for the document as a whole. For attributes that change within the document content, see @atspi_text_get_attribute_run instead. - + a #GHashTable + line="119">a #GHashTable containing the constant attributes of the document, as name-value pairs. @@ -4451,7 +4656,7 @@ that change within the document content, see @atspi_text_get_attribute_run inste a pointer to the #AtspiDocument object on which to operate. + line="114">a pointer to the #AtspiDocument object on which to operate. @@ -4463,7 +4668,7 @@ that change within the document content, see @atspi_text_get_attribute_run inste filename="atspi/atspi-document.c" line="26">Gets the locale associated with the document's content, e.g. the locale for LOCALE_TYPE_MESSAGES. - + throws="1"> Gets the page count of an #AccessibleDocument object. - + line="133">Gets the page count of an #AccessibleDocument object. + a #gint indicating the page count of an + line="139">a #gint indicating the page count of an #AccessibleDocument object. @@ -4497,11 +4702,73 @@ e.g. the locale for LOCALE_TYPE_MESSAGES. a pointer to the #AtspiDocument object to query. + line="135">a pointer to the #AtspiDocument object to query. + + + + + + Returns an array of AtspiTextSelections within this document. + + + a GArray of +AtspiTextSelection structures representing the selection. + + + + + + + an #AtspiDocument + + Makes 1 or more selections within this document denoted by the given +array of AtspiTextSelections. Any existing physical selection (inside or +outside this document) is replaced by the new selections. All objects within +the given selection ranges must be descendants of this document. Otherwise +FALSE will be returned. + + + TRUE if the selection was made successfully; FALSE otherwise. + + + + + an #AtspiDocument. + + + + a GArray of AtspiTextSelections + to be selected. + + + + + + One higher than the highest valid value of #AtspiEventType. - + line="707">One higher than the highest valid value of #AtspiEventType. + throws="1"> Copies text from an #AtspiEditableText object into the system clipboard. + line="129">Copies text from an #AtspiEditableText object into the system clipboard. see: #atspi_editable_text_paste_text #TRUE if the operation was successful, otherwise #FALSE. + line="141">#TRUE if the operation was successful, otherwise #FALSE. a pointer to the #AtspiEditableText object to modify. + line="131">a pointer to the #AtspiEditableText object to modify. a #gint indicating the starting character offset + line="132">a #gint indicating the starting character offset of the text to copy. a #gint indicating the offset of the first character + line="134">a #gint indicating the offset of the first character past the end of the text section to be copied. @@ -4603,7 +4870,7 @@ see: #atspi_editable_text_paste_text throws="1"> Deletes text from an #AtspiEditableText object, copying the + line="158">Deletes text from an #AtspiEditableText object, copying the excised portion into the system clipboard. see: #atspi_editable_text_paste_text @@ -4611,27 +4878,27 @@ see: #atspi_editable_text_paste_text #TRUE if operation was successful, #FALSE otherwise. + line="171">#TRUE if operation was successful, #FALSE otherwise. a pointer to the #AtspiEditableText object to modify. + line="160">a pointer to the #AtspiEditableText object to modify. a #gint indicating the starting character offset + line="161">a #gint indicating the starting character offset of the text to cut. a #gint indicating the offset of the first character + line="163">a #gint indicating the offset of the first character past the end of the text section to be cut. @@ -4642,7 +4909,7 @@ see: #atspi_editable_text_paste_text throws="1"> Deletes text from an #AtspiEditableText object, without copying the + line="189">Deletes text from an #AtspiEditableText object, without copying the excised portion into the system clipboard. see: #atspi_editable_text_cut_text @@ -4650,27 +4917,27 @@ see: #atspi_editable_text_cut_text #TRUE if the operation was successful, otherwise #FALSE. + line="202">#TRUE if the operation was successful, otherwise #FALSE. a pointer to the #AtspiEditableText object to modify. + line="191">a pointer to the #AtspiEditableText object to modify. a #gint indicating the starting character offset + line="192">a #gint indicating the starting character offset of the text to delete. a #gint indicating the offset of the first character + line="194">a #gint indicating the offset of the first character past the end of the text section to be deleted. @@ -4681,7 +4948,7 @@ see: #atspi_editable_text_cut_text throws="1"> Inserts text into an #AtspiEditableText object. + line="95">Inserts text into an #AtspiEditableText object. As with all character offsets, the specified @position may not be the same as the resulting byte offset, since the text is in a variable-width encoding. @@ -4689,33 +4956,33 @@ variable-width encoding. #TRUE if the operation was successful, otherwise #FALSE. + line="110">#TRUE if the operation was successful, otherwise #FALSE. a pointer to the #AtspiEditableText object to modify. + line="97">a pointer to the #AtspiEditableText object to modify. a #gint indicating the character offset at which to insert + line="98">a #gint indicating the character offset at which to insert the new text. a string representing the text to insert, in UTF-8 encoding. + line="100">a string representing the text to insert, in UTF-8 encoding. the number of characters of text to insert, in bytes. If the + line="101">the number of characters of text to insert, in bytes. If the byte count of text is less than or equal to length, the entire contents of text will be inserted. @@ -4727,7 +4994,7 @@ of text will be inserted. throws="1"> Inserts text from the system clipboard into an #AtspiEditableText object. + line="220">Inserts text from the system clipboard into an #AtspiEditableText object. As with all character offsets, the specified @position may not be the same as the resulting byte offset, since the text is in a variable-width encoding. @@ -4735,20 +5002,20 @@ As with all character offsets, the specified @position may not be the #TRUE if the operation was successful, otherwise #FALSE. + line="231">#TRUE if the operation was successful, otherwise #FALSE. a pointer to the #AtspiEditableText object to modify. + line="222">a pointer to the #AtspiEditableText object to modify. a #gint indicating the character offset at which to insert + line="223">a #gint indicating the character offset at which to insert the new text. @@ -4759,25 +5026,25 @@ As with all character offsets, the specified @position may not be the throws="1"> Replace the entire text contents of an #AtspiEditableText object. + line="71">Replace the entire text contents of an #AtspiEditableText object. #TRUE if the operation was successful, otherwise #FALSE. + line="79">#TRUE if the operation was successful, otherwise #FALSE. a pointer to the #AtspiEditableText object to modify. + line="73">a pointer to the #AtspiEditableText object to modify. a character string, encoded in UTF-8, which is to + line="74">a character string, encoded in UTF-8, which is to become the new text contents of the #AtspiEditableText object. @@ -4789,7 +5056,7 @@ As with all character offsets, the specified @position may not be the glib:type-name="AtspiEvent" glib:get-type="atspi_event_get_type" c:symbol-prefix="event"> - + @@ -4811,7 +5078,7 @@ As with all character offsets, the specified @position may not be the Starts/enters the main event loop for the AT-SPI services. + line="1111">Starts/enters the main event loop for the AT-SPI services. NOTE: This method does not return control; it is exited via a call to #atspi_event_quit from within an event handler. @@ -4823,7 +5090,7 @@ NOTE: This method does not return control; it is exited via a call to Quits the last main event loop for the AT-SPI services, + line="1129">Quits the last main event loop for the AT-SPI services, See: #atspi_event_main @@ -4838,16 +5105,25 @@ See: #atspi_event_main glib:type-name="AtspiEventListener" glib:get-type="atspi_event_listener_get_type" glib:type-struct="EventListenerClass"> + A generic interface implemented by objects for the receipt of event +notifications. + +A generic interface implemented by objects for the receipt of event +notifications. atspi-event-listener is the interface via which clients of +the atspi-registry receive notification of changes to an application's user +interface and content. Creates a new #AtspiEventListener associated with a specified @callback. + line="134">Creates a new #AtspiEventListener associated with a specified @callback. A new #AtspiEventListener. + line="144">A new #AtspiEventListener. @@ -4858,7 +5134,7 @@ See: #atspi_event_main destroy="2"> An #AtspiEventListenerCB to be called + line="136">An #AtspiEventListenerCB to be called when an event is fired. @@ -4868,7 +5144,7 @@ when an event is fired. allow-none="1"> data to pass to the callback. + line="138">data to pass to the callback. scope="async"> A #GDestroyNotify called when the listener is freed + line="139">A #GDestroyNotify called when the listener is freed and data associated with the callback should be freed. Can be NULL. @@ -4887,12 +5163,12 @@ and data associated with the callback should be freed. Can be NULL. introspectable="0"> Creates a new #AtspiEventListener associated with a specified @callback. + line="159">Creates a new #AtspiEventListener associated with a specified @callback. A new #AtspiEventListener. + line="167">A new #AtspiEventListener. @@ -4902,7 +5178,7 @@ and data associated with the callback should be freed. Can be NULL. destroy="1"> An #AtspiEventListenerSimpleCB to be called + line="161">An #AtspiEventListenerSimpleCB to be called when an event is fired. @@ -4912,7 +5188,7 @@ when an event is fired. scope="async"> A #GDestroyNotify called when the listener is freed + line="163">A #GDestroyNotify called when the listener is freed and data associated with the callback should be freed. Can be NULL. @@ -4923,13 +5199,13 @@ and data associated with the callback should be freed. Can be NULL. throws="1"> Deregisters an #AtspiEventListenerCB from the registry, for a specific + line="877">Deregisters an #AtspiEventListenerCB from the registry, for a specific event type. #TRUE if successful, otherwise #FALSE. + line="888">#TRUE if successful, otherwise #FALSE. @@ -4939,7 +5215,7 @@ and data associated with the callback should be freed. Can be NULL. closure="1"> the #AtspiEventListenerCB registered against an + line="879">the #AtspiEventListenerCB registered against an event type. @@ -4949,13 +5225,13 @@ and data associated with the callback should be freed. Can be NULL. allow-none="1"> User data that was passed in for this callback. + line="881">User data that was passed in for this callback. a string specifying the event type for which this + line="882">a string specifying the event type for which this listener is to be deregistered. @@ -4967,20 +5243,20 @@ and data associated with the callback should be freed. Can be NULL. throws="1"> deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific + line="960">deregisters an #AtspiEventListenerSimpleCB from the registry, for a specific event type. #TRUE if successful, otherwise #FALSE. + line="970">#TRUE if successful, otherwise #FALSE. the #AtspiEventListenerSimpleCB registered against + line="962">the #AtspiEventListenerSimpleCB registered against an event type. @@ -4988,7 +5264,7 @@ and data associated with the callback should be freed. Can be NULL. a string specifying the event type for which this + line="964">a string specifying the event type for which this listener is to be deregistered. @@ -4999,12 +5275,12 @@ and data associated with the callback should be freed. Can be NULL. throws="1"> Registers an #AtspiEventListenerCB against an @event_type. + line="656">Registers an #AtspiEventListenerCB against an @event_type. #TRUE if successfull, otherwise #FALSE. + line="668">#TRUE if successfull, otherwise #FALSE. @@ -5015,7 +5291,7 @@ and data associated with the callback should be freed. Can be NULL. destroy="2"> the #AtspiEventListenerCB to be registered + line="658">the #AtspiEventListenerCB to be registered against an event type. @@ -5025,7 +5301,7 @@ against an event type. allow-none="1"> User data to be passed to the callback. + line="660">User data to be passed to the callback. scope="async"> A #GDestroyNotify called when the callback is destroyed. + line="661">A #GDestroyNotify called when the callback is destroyed. a character string indicating the type of events for which + line="662">a character string indicating the type of events for which notification is requested. See #atspi_event_listener_register for a description of the format. @@ -5053,7 +5329,7 @@ for a description of the format. #TRUE if successful, otherwise #FALSE. + line="711">#TRUE if successful, otherwise #FALSE. @@ -5066,7 +5342,7 @@ for a description of the format. destroy="2"> an #AtspiEventListenerCB function pointer. + line="704">an #AtspiEventListenerCB function pointer. #TRUE if successful, otherwise #FALSE. + line="739">#TRUE if successful, otherwise #FALSE. @@ -5112,7 +5388,7 @@ for a description of the format. destroy="2"> an #AtspiEventListenerCB function pointer. + line="731">an #AtspiEventListenerCB function pointer. throws="1"> Registers an #AtspiEventListenetSimpleCB. The method is similar to + line="817">Registers an #AtspiEventListenetSimpleCB. The method is similar to #atspi_event_listener_register, but @callback takes no user_data. #TRUE if successfull, otherwise #FALSE. + line="833">#TRUE if successfull, otherwise #FALSE. @@ -5166,7 +5442,7 @@ for a description of the format. destroy="1"> the #AtspiEventListenerSimpleCB to be + line="819">the #AtspiEventListenerSimpleCB to be registered against an event type. @@ -5176,13 +5452,13 @@ for a description of the format. scope="async"> A #GDestroyNotify called when the callback is destroyed. + line="821">A #GDestroyNotify called when the callback is destroyed. a character string indicating the type of events for which + line="822">a character string indicating the type of events for which notification is requested. Format is EventClass:major_type:minor_type:detail where all subfields other than EventClass are optional. @@ -5198,26 +5474,26 @@ for a description of the format. throws="1"> Deregisters an #AtspiEventListener from the registry, for a specific + line="856">Deregisters an #AtspiEventListener from the registry, for a specific event type. #TRUE if successful, otherwise #FALSE. + line="865">#TRUE if successful, otherwise #FALSE. The #AtspiEventListener to deregister. + line="858">The #AtspiEventListener to deregister. a string specifying the event type for which this + line="859">a string specifying the event type for which this listener is to be deregistered. @@ -5228,7 +5504,7 @@ for a description of the format. throws="1"> Adds an in-process callback function to an existing #AtspiEventListener. + line="466">Adds an in-process callback function to an existing #AtspiEventListener. Legal object event types: @@ -5264,6 +5540,7 @@ Legal object event types: object:column-deleted object:model-changed object:active-descendant-changed + object:announcement (screen reader events) screen-reader:region-changed @@ -5314,20 +5591,20 @@ reader and is thus a special case internally. #TRUE if successful, otherwise #FALSE. + line="561">#TRUE if successful, otherwise #FALSE. The #AtspiEventListener to register against an event type. + line="468">The #AtspiEventListener to register against an event type. a character string indicating the type of events for which + line="469">a character string indicating the type of events for which notification is requested. Format is EventClass:major_type:minor_type:detail where all subfields other than EventClass are optional. @@ -5343,25 +5620,25 @@ reader and is thus a special case internally. throws="1"> Adds an in-process callback function to an existing #AtspiEventListener. + line="577">Adds an in-process callback function to an existing #AtspiEventListener. #TRUE if successful, otherwise #FALSE. + line="590">#TRUE if successful, otherwise #FALSE. The #AtspiEventListener to register against an event type. + line="579">The #AtspiEventListener to register against an event type. a character string indicating the type of events for which + line="580">a character string indicating the type of events for which notification is requested. See #atspi_event_listener_register for a description of the format and legal event types. @@ -5372,7 +5649,7 @@ for a description of the format and legal event types. allow-none="1"> a list of + line="583">a list of properties that should be sent along with the event. The properties are valued for the duration of the event callback. TODO: Document. @@ -5387,25 +5664,25 @@ for a description of the format and legal event types. throws="1"> Adds an in-process callback function to an existing #AtspiEventListener. + line="609">Adds an in-process callback function to an existing #AtspiEventListener. #TRUE if successful, otherwise #FALSE. + line="623">#TRUE if successful, otherwise #FALSE. The #AtspiEventListener to register against an event type. + line="611">The #AtspiEventListener to register against an event type. a character string indicating the type of events for which + line="612">a character string indicating the type of events for which notification is requested. See #atspi_event_listener_register for a description of the format and legal event types. @@ -5416,7 +5693,7 @@ for a description of the format and legal event types. allow-none="1"> a list of + line="615">a list of properties that should be sent along with the event. The properties are valued for the duration of the event callback. @@ -5429,7 +5706,7 @@ for a description of the format and legal event types. allow-none="1"> the application whose events should be reported, or + line="618">the application whose events should be reported, or %null for all applications. @@ -5484,7 +5761,7 @@ for a description of the format and legal event types. - + @@ -5518,7 +5795,7 @@ for a description of the format and legal event types. c:type="AtspiEventType"> Enumeration used to specify the event types of interest to an + line="683">Enumeration used to specify the event types of interest to an #AtspiEventListener, or to identify the type of an event for which notification has been sent. glib:name="ATSPI_KEY_PRESSED_EVENT"> Indicates that a key on a keyboard device was + line="685">Indicates that a key on a keyboard device was pressed. glib:name="ATSPI_KEY_RELEASED_EVENT"> Indicates that a key on a keyboard device was + line="687">Indicates that a key on a keyboard device was released. glib:name="ATSPI_BUTTON_PRESSED_EVENT"> Indicates that a button on a non-keyboard + line="689">Indicates that a button on a non-keyboard human interface device (HID) was pressed. glib:name="ATSPI_BUTTON_RELEASED_EVENT"> Indicates that a button on a non-keyboard + line="691">Indicates that a button on a non-keyboard human interface device (HID) was released. + + + + + + + + + + + @@ -5614,13 +5906,25 @@ human interface device (HID) was released. glib:type-name="AtspiHyperlink" glib:get-type="atspi_hyperlink_get_type" glib:type-struct="HyperlinkClass"> + Instances of atspi-hyperlink are the means by which end users +and clients interact with linked content. + + Instances of atspi-hyperlink are returned by +atspi-hypertext objects, and are the means by +which end users and clients interact with linked, +and in some cases embedded, content. These instances +may have multiple "anchors", where an anchor corresponds to a +reference to a particular resource with a corresponding resource +identified (URI). Gets the ending character offset of the text range associated with + line="188">Gets the ending character offset of the text range associated with an #AtspiHyperlink, in its originating #AtspiHypertext. @@ -5630,7 +5934,7 @@ human interface device (HID) was released. a pointer to the #AtspiHyperlink implementor on which to operate. + line="190">a pointer to the #AtspiHyperlink implementor on which to operate. @@ -5640,7 +5944,7 @@ human interface device (HID) was released. throws="1"> Gets the starting and ending character offsets of the text range + line="140">Gets the starting and ending character offsets of the text range associated with an #AtspiHyperlink, in its originating #AtspiHypertext. @@ -5650,7 +5954,7 @@ associated with an #AtspiHyperlink, in its originating #AtspiHypertext. a pointer to the #AtspiHyperlink implementor on which to operate. + line="142">a pointer to the #AtspiHyperlink implementor on which to operate. @@ -5660,7 +5964,7 @@ associated with an #AtspiHyperlink, in its originating #AtspiHypertext. throws="1"> Gets the total number of anchors which an #AtspiHyperlink implementor has. + line="66">Gets the total number of anchors which an #AtspiHyperlink implementor has. Though typical hyperlinks have only one anchor, client-side image maps and other hypertext objects may potentially activate or refer to multiple URIs. For each anchor there is a corresponding URI and object. @@ -5670,14 +5974,14 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. a #gint indicating the number of anchors in this hyperlink. + line="77">a #gint indicating the number of anchors in this hyperlink. a pointer to the #AtspiHyperlink object on which to operate. + line="68">a pointer to the #AtspiHyperlink object on which to operate. @@ -5687,13 +5991,13 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. throws="1"> Gets the object associated with a particular hyperlink anchor, as an + line="116">Gets the object associated with a particular hyperlink anchor, as an #AtspiAccessible. an #AtspiAccessible that represents the object + line="124">an #AtspiAccessible that represents the object associated with the @ith anchor of the specified #AtspiHyperlink. @@ -5701,13 +6005,13 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. a pointer to the #AtspiHyperlink implementor on which to operate. + line="118">a pointer to the #AtspiHyperlink implementor on which to operate. a (zero-index) #gint indicating which hyperlink anchor to query. + line="119">a (zero-index) #gint indicating which hyperlink anchor to query. @@ -5717,7 +6021,7 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. throws="1"> Gets the starting character offset of the text range associated with + line="167">Gets the starting character offset of the text range associated with an #AtspiHyperlink, in its originating #AtspiHypertext. @@ -5727,7 +6031,7 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. a pointer to the #AtspiHyperlink implementor on which to operate. + line="169">a pointer to the #AtspiHyperlink implementor on which to operate. @@ -5735,25 +6039,25 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. Gets the URI associated with a particular hyperlink anchor. + line="91">Gets the URI associated with a particular hyperlink anchor. a UTF-8 string giving the URI of the @ith hyperlink anchor. + line="98">a UTF-8 string giving the URI of the @ith hyperlink anchor. a pointer to the #AtspiHyperlink implementor on which to operate. + line="93">a pointer to the #AtspiHyperlink implementor on which to operate. a (zero-index) integer indicating which hyperlink anchor to query. + line="94">a (zero-index) integer indicating which hyperlink anchor to query. @@ -5763,13 +6067,13 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. throws="1"> Tells whether an #AtspiHyperlink object is still valid with respect to its + line="210">Tells whether an #AtspiHyperlink object is still valid with respect to its originating hypertext object. #TRUE if the specified #AtspiHyperlink is still valid with respect + line="217">#TRUE if the specified #AtspiHyperlink is still valid with respect to its originating #AtspiHypertext object, #FALSE otherwise. @@ -5777,7 +6081,7 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. a pointer to the #AtspiHyperlink on which to operate. + line="212">a pointer to the #AtspiHyperlink on which to operate. @@ -5799,17 +6103,27 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. c:type="AtspiHypertext" glib:type-name="AtspiHypertext" glib:get-type="atspi_hypertext_get_type"> + An interface used for objects which implement linking between +multiple resource locations. + +An interface used for objects which implement linking between +multiple resource or content locations, or multiple 'markers' +within a single document. A hypertext instance is associated +with one or more hyperlinks which are associated with particular +offsets within the hypertext's content. Gets the #AtspiHyperlink object at a specified index. + line="65">Gets the #AtspiHyperlink object at a specified index. the #AtspiHyperlink object + line="72">the #AtspiHyperlink object specified by @link_index. @@ -5817,13 +6131,13 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. a pointer to the #AtspiHypertext implementor on which to operate. + line="67">a pointer to the #AtspiHypertext implementor on which to operate. a (zero-index) #gint indicating which hyperlink to query. + line="68">a (zero-index) #gint indicating which hyperlink to query. @@ -5833,13 +6147,13 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. throws="1"> Gets the index of the #AtspiHyperlink object at a specified + line="88">Gets the index of the #AtspiHyperlink object at a specified character offset. the linkIndex of the #AtspiHyperlink active at + line="96">the linkIndex of the #AtspiHyperlink active at character offset @character_offset, or -1 if there is no hyperlink at the specified character offset. @@ -5848,13 +6162,13 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. a pointer to the #AtspiHypertext implementor on which to operate. + line="90">a pointer to the #AtspiHypertext implementor on which to operate. a #gint specifying the character offset to query. + line="91">a #gint specifying the character offset to query. @@ -5864,13 +6178,13 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. throws="1"> Gets the total number of #AtspiHyperlink objects that an + line="40">Gets the total number of #AtspiHyperlink objects that an #AtspiHypertext implementor has. a #gint indicating the number of #AtspiHyperlink objects + line="47">a #gint indicating the number of #AtspiHyperlink objects of the #AtspiHypertext implementor, or -1 if the number cannot be determined (for example, if the #AtspiHypertext object is so large that it is not @@ -5881,7 +6195,7 @@ see: #atspi_hyperlink_get_uri and #atspi_hyperlink_get_object. a pointer to the #AtspiHypertext implementor on which to operate. + line="42">a pointer to the #AtspiHypertext implementor on which to operate. @@ -6364,8 +6678,8 @@ the image's width and y corresponds to the image's height. c:type="ATSPI_KEYEVENTTYPE_COUNT"> One higher than the highest valid value of #AtspiKeyEventType. - + line="676">One higher than the highest valid value of #AtspiKeyEventType. + c:type="ATSPI_KEYSYNTHTYPE_COUNT"> One higher than the highest valid value of #AtspiKeySynthType. - + line="755">One higher than the highest valid value of #AtspiKeySynthType. + A callback that will be invoked when a key is pressed. - + line="64">A callback that will be invoked when a key is pressed. + @@ -6389,37 +6703,37 @@ the image's width and y corresponds to the image's height. the device. + line="66">the device. TRUE if the key is being pressed, FALSE if being released. + line="67">TRUE if the key is being pressed, FALSE if being released. the hardware code for the key. + line="68">the hardware code for the key. the keysym for the key. + line="69">the keysym for the key. a bitflag indicating which key modifiers are active. + line="70">a bitflag indicating which key modifiers are active. the text corresponding to the keypress. + line="71">the text corresponding to the keypress. closure="6"> user-supplied data + line="72">user-supplied data @@ -6439,7 +6753,7 @@ the image's width and y corresponds to the image's height. glib:type-name="AtspiKeyDefinition" glib:get-type="atspi_key_definition_get_type" c:symbol-prefix="key_definition"> - + @@ -6459,7 +6773,7 @@ the image's width and y corresponds to the image's height. c:type="AtspiKeyEventType"> Deprecated. Should not be used. + line="662">Deprecated. Should not be used. glib:name="ATSPI_KEY_PRESSED"> Key press event + line="664">Key press event glib:name="ATSPI_KEY_RELEASED"> Key release event + line="665">Key release event c:type="AtspiKeyListenerSyncType"> Specifies the type of a key listener event. + line="141">Specifies the type of a key listener event. The values above can and should be bitwise-'OR'-ed together, observing the compatibility limitations specified in the description of each value. For instance, #ATSPI_KEYLISTENER_ALL_WINDOWS | #ATSPI_KEYLISTENER_CANCONSUME is @@ -6499,7 +6813,7 @@ system performance. glib:name="ATSPI_KEYLISTENER_NOSYNC"> Events may be delivered asynchronously, + line="143">Events may be delivered asynchronously, which means in some cases they may already have been delivered to the application before the AT client receives the notification. @@ -6510,8 +6824,8 @@ application before the AT client receives the notification. glib:name="ATSPI_KEYLISTENER_SYNCHRONOUS"> Events are delivered synchronously, before the -currently focussed application sees them. + line="146">Events are delivered synchronously, before the +currently focused application sees them. glib:name="ATSPI_KEYLISTENER_CANCONSUME"> Events may be consumed by the AT client. Presumes and + line="148">Events may be consumed by the AT client. Presumes and requires #ATSPI_KEYLISTENER_SYNCHRONOUS, incompatible with #ATSPI_KEYLISTENER_NOSYNC. Events are received not from the application toolkit layer, but + line="150">Events are received not from the application toolkit layer, but from the device driver or windowing system subsystem; such notifications are 'global' in the sense that they are not broken or defeated by applications that participate poorly in the accessibility APIs, or not at all; however because of the intrusive nature of @@ -6542,9 +6856,9 @@ required, it may be best to avoid this enum value/flag. Structure containing identifying information about a set of keycode or + line="124">Structure containing identifying information about a set of keycode or keysyms. - + @@ -6564,7 +6878,7 @@ required, it may be best to avoid this enum value/flag. c:type="AtspiKeySynthType"> Enumeration used when synthesizing keyboard input via + line="714">Enumeration used when synthesizing keyboard input via #atspi_generate_keyboard_event. glib:name="ATSPI_KEY_PRESS"> Emulates the pressing of a hardware keyboard key. + line="716">Emulates the pressing of a hardware keyboard key. glib:name="ATSPI_KEY_RELEASE"> Emulates the release of a hardware keyboard key. + line="717">Emulates the release of a hardware keyboard key. glib:name="ATSPI_KEY_PRESSRELEASE"> Emulates the pressing and immediate releasing + line="718">Emulates the pressing and immediate releasing of a hardware keyboard key. glib:name="ATSPI_KEY_SYM"> A symbolic key event is generated, without specifying a + line="720">A symbolic key event is generated, without specifying a hardware key. Note: if the keysym is not present in the current keyboard map, the #AtspiDeviceEventController instance has a limited ability to generate such keysyms on-the-fly. Reliability of GenerateKeyboardEvent @@ -6620,7 +6934,7 @@ physical hardware keyboard is not connected). glib:name="ATSPI_KEY_STRING"> A string is converted to its equivalent keyboard events + line="731">A string is converted to its equivalent keyboard events and emitted. If the string consists of complex characters or composed characters which are not in the current keymap, string emission is subject to the out-of-keymap limitations described for @@ -6634,7 +6948,7 @@ Chinese and Japanese locales. glib:name="ATSPI_KEY_LOCKMODIFIERS"> Emulates locking a set of modifiers. + line="737">Emulates locking a set of modifiers. glib:name="ATSPI_KEY_UNLOCKMODIFIERS"> Emulates unlocking a set of modifiers. + line="738">Emulates unlocking a set of modifiers. c:type="ATSPI_LOCALE_TYPE_COUNT"> One higher than the highest valid value of #AtspiLocaleType. - + line="127">One higher than the highest valid value of #AtspiLocaleType. + + + Enumeration used to indicate a type of live region and how assertive it +should be in terms of speaking notifications. Currently, this is only used +for "announcement" events, but it may be used for additional purposes +in the future. + + No live region. + + + This live region should be considered polite. + + + This live region should be considered assertive. + + Used by interfaces #AtspiText and #AtspiDocument, this + line="100">Used by interfaces #AtspiText and #AtspiDocument, this enumeration corresponds to the POSIX 'setlocale' enum values. glib:name="ATSPI_LOCALE_TYPE_MESSAGES"> For localizable natural-language messages. + line="102">For localizable natural-language messages. glib:name="ATSPI_LOCALE_TYPE_COLLATE"> For regular expression matching and string + line="103">For regular expression matching and string collation. glib:name="ATSPI_LOCALE_TYPE_CTYPE"> For regular expression matching, character + line="105">For regular expression matching, character classification, conversion, case-sensitive comparison, and wide character functions. @@ -6700,7 +7052,7 @@ functions. glib:name="ATSPI_LOCALE_TYPE_MONETARY"> For monetary formatting. + line="108">For monetary formatting. glib:name="ATSPI_LOCALE_TYPE_NUMERIC"> For number formatting (such as the decimal + line="109">For number formatting (such as the decimal point and the thousands separator). glib:name="ATSPI_LOCALE_TYPE_TIME"> For time and date formatting. + line="111">For time and date formatting. - + c:type="ATSPI_MODIFIERTYPE_COUNT"> One higher than the highest valid value of #AtspiModifierType. - + line="794">One higher than the highest valid value of #AtspiModifierType. + glib:type-name="AtspiMatchRule" glib:get-type="atspi_match_rule_get_type" glib:type-struct="MatchRuleClass"> + An interface that allows the definition of match rules +for accessible objects. Creates a new #AtspiMatchRule with specified @states, @attributes, + line="89">Creates a new #AtspiMatchRule with specified @states, @attributes, @interfaces, and @roles. A new #AtspiMatchRule. + line="120">A new #AtspiMatchRule. An #AtspiStateSet specifying the states to match or NULL if none. + line="91">An #AtspiStateSet specifying the states to match or NULL if none. An #AtspiCollectionMatchType specifying how to interpret + line="92">An #AtspiCollectionMatchType specifying how to interpret @states. @@ -6802,7 +7158,7 @@ point and the thousands separator). A #GHashTable specifying + line="94">A #GHashTable specifying attributes to match. To specify multiple attribute values, separate each value with a :: If an attribute value contains a :, then it can be escaped by preceding it with a \. A backslash can @@ -6815,7 +7171,7 @@ point and the thousands separator). An #AtspiCollectionMatchType specifying how to + line="99">An #AtspiCollectionMatchType specifying how to interpret @attributes. @@ -6823,7 +7179,7 @@ point and the thousands separator). A #GArray of roles to match, or NULL if + line="107">A #GArray of roles to match, or NULL if not applicable. @@ -6832,7 +7188,7 @@ point and the thousands separator). An #AtspiCollectionMatchType specifying how to + line="109">An #AtspiCollectionMatchType specifying how to interpret @roles. @@ -6840,10 +7196,10 @@ point and the thousands separator). An array of interfaces to match, or + line="101">An array of interfaces to match, or NULL if not applicable. Interface names should be specified - by their DBus names (org.a11y.Atspi.Accessible, - org.a11y.Atspi.Component, etc). + by the final component of their DBus names (Accessible, + Component, etc). @@ -6851,7 +7207,7 @@ point and the thousands separator). An #AtspiCollectionMatchType specifying how to + line="105">An #AtspiCollectionMatchType specifying how to interpret @interfaces. @@ -6859,7 +7215,7 @@ point and the thousands separator). if #TRUE, the match rule should be denied (inverted); if #FALSE, + line="111">if #TRUE, the match rule should be denied (inverted); if #FALSE, it should not. For example, if the match rule defines that a match is an object of ROLE_HEADING which has STATE_FOCUSABLE and a click action, inverting it would match all objects that are not of ROLE_HEADING, @@ -6925,7 +7281,7 @@ point and the thousands separator). glib:name="ATSPI_MODIFIER_SHIFT"> The left or right 'Shift' key. + line="764">The left or right 'Shift' key. glib:name="ATSPI_MODIFIER_SHIFTLOCK"> The ShiftLock or CapsLock key. + line="765">The ShiftLock or CapsLock key. glib:name="ATSPI_MODIFIER_CONTROL"> 'Control'/'Ctrl'. + line="766">'Control'/'Ctrl'. glib:name="ATSPI_MODIFIER_ALT"> The Alt key (as opposed to AltGr). + line="767">The Alt key (as opposed to AltGr). glib:name="ATSPI_MODIFIER_META"> Depending on the platform, this may map to 'Window', + line="768">Depending on the platform, this may map to 'Window', 'Function', 'Meta', 'Menu', or 'NumLock'. Such 'Meta keys' will map to one of META, META2, META3. On X Windows platforms these META values map to the modifier masks Mod1Mask, Mod2Mask, Mod3Mask, e.g. an @@ -6975,7 +7331,7 @@ is set in the corresponding XEvent. glib:name="ATSPI_MODIFIER_META2"> See @ATSPI_MODIFIER_META. + line="774">See @ATSPI_MODIFIER_META. glib:name="ATSPI_MODIFIER_META3"> See @ATSPI_MODIFIER_META. + line="775">See @ATSPI_MODIFIER_META. glib:name="ATSPI_MODIFIER_NUMLOCK"> A symbolic meta key name that is mapped by AT-SPI + line="776">A symbolic meta key name that is mapped by AT-SPI to the appropriate META value, for the convenience of the client. @@ -7088,8 +7444,8 @@ to the appropriate META value, for the convenience of the client. c:type="ATSPI_RELATIONTYPE_COUNT"> One higher than the highest valid value of #AtspiRelationType. - + line="933">One higher than the highest valid value of #AtspiRelationType. + - + One higher than the highest valid value of #AtspiRole. - + line="1419">One higher than the highest valid value of #AtspiRole. + Gets a copy of an #AtspiRange object. + line="41">Gets a copy of an #AtspiRange object. the #AtspiRange copy of an #AtspiRange object. + line="47">the #AtspiRange copy of an #AtspiRange object. a pointer to the source #AtspiRange object that will be copied. + line="43">a pointer to the source #AtspiRange object that will be copied. @@ -7178,18 +7534,26 @@ to the appropriate META value, for the convenience of the client. glib:type-name="AtspiRelation" glib:get-type="atspi_relation_get_type" glib:type-struct="RelationClass"> + An interface via which non-hierarchical relationships +are indicated. + +An interface via which non-hierarchical relationships +are indicated. An instance of this interface represents +a "one-to-many" correspondence. Gets the number of objects which this relationship has as its + line="54">Gets the number of objects which this relationship has as its target objects (the subject is the #AtspiAccessible from which this #AtspiRelation originated). a #gint indicating how many target objects which the + line="62">a #gint indicating how many target objects which the originating #AtspiAccessible object has the #AtspiRelation relationship with. @@ -7198,7 +7562,7 @@ to the appropriate META value, for the convenience of the client. a pointer to the #AtspiRelation object to query. + line="56">a pointer to the #AtspiRelation object to query. @@ -7207,12 +7571,12 @@ to the appropriate META value, for the convenience of the client. c:identifier="atspi_relation_get_relation_type"> Gets the type of relationship represented by an #AtspiRelation. + line="38">Gets the type of relationship represented by an #AtspiRelation. an #AtspiRelationType indicating the type of relation + line="44">an #AtspiRelationType indicating the type of relation encapsulated in this #AtspiRelation object. @@ -7220,7 +7584,7 @@ to the appropriate META value, for the convenience of the client. a pointer to the #AtspiRelation object to query. + line="40">a pointer to the #AtspiRelation object to query. @@ -7228,12 +7592,12 @@ to the appropriate META value, for the convenience of the client. Gets the @i-th target of a specified #AtspiRelation relationship. + line="72">Gets the @i-th target of a specified #AtspiRelation relationship. an #AtspiAccessible which is the @i-th object + line="79">an #AtspiAccessible which is the @i-th object with which the originating #AtspiAccessible has relationship specified in the #AtspiRelation object. @@ -7242,13 +7606,13 @@ to the appropriate META value, for the convenience of the client. a pointer to the #AtspiRelation object to query. + line="74">a pointer to the #AtspiRelation object to query. a (zero-index) #gint indicating which (of possibly several) target is requested. + line="75">a (zero-index) #gint indicating which (of possibly several) target is requested. @@ -7279,7 +7643,7 @@ to the appropriate META value, for the convenience of the client. c:type="AtspiRelationType"> #AtspiRelationType specifies a relationship between objects + line="801">#AtspiRelationType specifies a relationship between objects (possibly one-to-many or many-to-one) outside of the normal parent/child hierarchical relationship. It allows better semantic identification of how objects @@ -7304,7 +7668,7 @@ the type of relation encapsulated in an #AtspiRelation object. glib:name="ATSPI_RELATION_NULL"> Not a meaningful relationship; clients should not + line="803">Not a meaningful relationship; clients should not normally encounter this #AtspiRelationType value. glib:name="ATSPI_RELATION_LABEL_FOR"> Object is a label for one or more other objects. + line="805">Object is a label for one or more other objects. glib:name="ATSPI_RELATION_LABELLED_BY"> Object is labelled by one or more other + line="806">Object is labelled by one or more other objects. glib:name="ATSPI_RELATION_CONTROLLER_FOR"> Object is an interactive object which + line="808">Object is an interactive object which modifies the state, onscreen location, or other attributes of one or more target objects. @@ -7344,7 +7708,7 @@ target objects. glib:name="ATSPI_RELATION_CONTROLLED_BY"> Object state, position, etc. is + line="811">Object state, position, etc. is modified/controlled by user interaction with one or more other objects. For instance a viewport or scroll pane may be @ATSPI_RELATION_CONTROLLED_BY scrollbars. @@ -7356,7 +7720,7 @@ scrollbars. glib:name="ATSPI_RELATION_MEMBER_OF"> Object has a grouping relationship (e.g. 'same + line="815">Object has a grouping relationship (e.g. 'same group as') to one or more other objects. glib:name="ATSPI_RELATION_TOOLTIP_FOR"> Object is a tooltip associated with another + line="817">Object is a tooltip associated with another object. glib:name="ATSPI_RELATION_NODE_CHILD_OF"> Object is a child of the target. + line="819">Object is a child of the target. glib:name="ATSPI_RELATION_NODE_PARENT_OF"> Object is a parent of the target. + line="820">Object is a parent of the target. glib:name="ATSPI_RELATION_EXTENDED"> Used to indicate that a relationship exists, but + line="821">Used to indicate that a relationship exists, but its type is not specified in the enumeration. glib:name="ATSPI_RELATION_FLOWS_TO"> Object renders content which flows logically to + line="823">Object renders content which flows logically to another object. For instance, text in a paragraph may flow to another object which is not the 'next sibling' in the accessibility hierarchy. @@ -7415,7 +7779,7 @@ object which is not the 'next sibling' in the accessibility hierarchy. glib:name="ATSPI_RELATION_FLOWS_FROM"> Reciprocal of @ATSPI_RELATION_FLOWS_TO. + line="826">Reciprocal of @ATSPI_RELATION_FLOWS_TO. glib:name="ATSPI_RELATION_SUBWINDOW_OF"> Object is visually and semantically considered + line="827">Object is visually and semantically considered a subwindow of another object, even though it is not the object's child. Useful when dealing with embedded applications and other cases where the widget hierarchy does not map cleanly to the onscreen presentation. @@ -7436,7 +7800,7 @@ widget hierarchy does not map cleanly to the onscreen presentation. glib:name="ATSPI_RELATION_EMBEDS"> Similar to @ATSPI_RELATION_SUBWINDOW_OF, but + line="831">Similar to @ATSPI_RELATION_SUBWINDOW_OF, but specifically used for cross-process embedding. glib:name="ATSPI_RELATION_EMBEDDED_BY"> Reciprocal of @ATSPI_RELATION_EMBEDS. Used to + line="833">Reciprocal of @ATSPI_RELATION_EMBEDS. Used to denote content rendered by embedded renderers that live in a separate process space from the embedding context. @@ -7457,7 +7821,7 @@ space from the embedding context. glib:name="ATSPI_RELATION_POPUP_FOR"> Denotes that the object is a transient window or + line="836">Denotes that the object is a transient window or frame associated with another onscreen object. Similar to @ATSPI_TOOLTIP_FOR, but more general. Useful for windows which are technically toplevels but which, for one or more reasons, do not explicitly cause their @@ -7474,7 +7838,7 @@ of assistive technology clients, even though the previous toplevel glib:name="ATSPI_RELATION_PARENT_WINDOW_OF"> This is the reciprocal relation to + line="845">This is the reciprocal relation to @ATSPI_RELATION_POPUP_FOR. Reciprocal of %ATSPI_RELATION_DESCRIBED_BY. + line="847">Reciprocal of %ATSPI_RELATION_DESCRIBED_BY. Indicates that this object provides descriptive information about the target object(s). See also %ATSPI_RELATION_DETAILS_FOR and %ATSPI_RELATION_ERROR_FOR. @@ -7495,7 +7859,7 @@ object(s). See also %ATSPI_RELATION_DETAILS_FOR and %ATSPI_RELATION_ERROR_FOR. Reciprocal of %ATSPI_RELATION_DESCRIPTION_FOR. + line="850">Reciprocal of %ATSPI_RELATION_DESCRIPTION_FOR. Indicates that one or more target objects provide descriptive information about this object. This relation type is most appropriate for information that is not essential as its presentation may be user-configurable and/or @@ -7515,7 +7879,7 @@ closely reviewed. glib:name="ATSPI_RELATION_DETAILS"> Reciprocal of %ATSPI_RELATION_DETAILS_FOR. Indicates + line="862">Reciprocal of %ATSPI_RELATION_DETAILS_FOR. Indicates that this object has a detailed or extended description, the contents of which can be found in the target object(s). This relation type is most appropriate for information that is sufficiently lengthy as to make @@ -7531,7 +7895,7 @@ If the detailed information describes an error condition, glib:name="ATSPI_RELATION_DETAILS_FOR"> Reciprocal of %ATSPI_RELATION_DETAILS. Indicates + line="870">Reciprocal of %ATSPI_RELATION_DETAILS. Indicates that this object provides a detailed or extended description about the target object(s). See also %ATSPI_RELATION_DESCRIPTION_FOR and %ATSPI_RELATION_ERROR_FOR. @Since: 2.26. @@ -7543,7 +7907,7 @@ object(s). See also %ATSPI_RELATION_DESCRIPTION_FOR and glib:name="ATSPI_RELATION_ERROR_MESSAGE"> Reciprocal of %ATSPI_RELATION_ERROR_FOR. + line="874">Reciprocal of %ATSPI_RELATION_ERROR_FOR. Indicates that this object has one or more errors, the nature of which is described in the contents of the target object(s). Objects that have this relation type should also contain %ATSPI_STATE_INVALID_ENTRY in their @@ -7556,7 +7920,7 @@ relation type should also contain %ATSPI_STATE_INVALID_ENTRY in their glib:name="ATSPI_RELATION_ERROR_FOR"> Reciprocal of %ATSPI_RELATION_ERROR_MESSAGE. + line="879">Reciprocal of %ATSPI_RELATION_ERROR_MESSAGE. Indicates that this object contains an error message describing an invalid condition in the target object(s). @Since: 2.26. @@ -7567,7 +7931,7 @@ condition in the target object(s). @Since: 2.26. glib:name="ATSPI_RELATION_LAST_DEFINED"> Do not use as a parameter value, used to + line="882">Do not use as a parameter value, used to determine the size of the enumeration. @@ -7577,7 +7941,7 @@ determine the size of the enumeration. c:type="AtspiRole"> Enumeration used by interface #AtspiAccessible to specify the role + line="940">Enumeration used by interface #AtspiAccessible to specify the role of an #AtspiAccessible object. glib:name="ATSPI_ROLE_INVALID"> A role indicating an error condition, such as + line="942">A role indicating an error condition, such as uninitialized Role data. glib:name="ATSPI_ROLE_ACCELERATOR_LABEL"> Object is a label indicating the keyboard + line="944">Object is a label indicating the keyboard accelerators for the parent. glib:name="ATSPI_ROLE_ALERT"> Object is used to alert the user about something. + line="946">Object is used to alert the user about something. glib:name="ATSPI_ROLE_ANIMATION"> Object contains a dynamic or moving image of some + line="947">Object contains a dynamic or moving image of some kind. glib:name="ATSPI_ROLE_ARROW"> Object is a 2d directional indicator. + line="949">Object is a 2d directional indicator. glib:name="ATSPI_ROLE_CALENDAR"> Object contains one or more dates, usually arranged + line="950">Object contains one or more dates, usually arranged into a 2d list. glib:name="ATSPI_ROLE_CANVAS"> Object that can be drawn into and is used to trap + line="952">Object that can be drawn into and is used to trap events. glib:name="ATSPI_ROLE_CHECK_BOX"> A choice that can be checked or unchecked and + line="954">A choice that can be checked or unchecked and provides a separate indicator for the current state. glib:name="ATSPI_ROLE_CHECK_MENU_ITEM"> A menu item that behaves like a check box. See + line="956">A menu item that behaves like a check box. See @ATSPI_ROLE_CHECK_BOX. glib:name="ATSPI_ROLE_COLOR_CHOOSER"> A specialized dialog that lets the user choose a + line="958">A specialized dialog that lets the user choose a color. glib:name="ATSPI_ROLE_COLUMN_HEADER"> The header for a column of data. + line="960">The header for a column of data. glib:name="ATSPI_ROLE_COMBO_BOX"> A list of choices the user can select from. + line="961">A list of choices the user can select from. glib:name="ATSPI_ROLE_DATE_EDITOR"> An object which allows entry of a date. + line="962">An object which allows entry of a date. glib:name="ATSPI_ROLE_DESKTOP_ICON"> An inconifed internal frame within a DESKTOP_PANE. + line="963">An inconifed internal frame within a DESKTOP_FRAME. glib:name="ATSPI_ROLE_DESKTOP_FRAME"> A pane that supports internal frames and + line="964">A pane that supports internal frames and iconified versions of those internal frames. glib:name="ATSPI_ROLE_DIAL"> An object that allows a value to be changed via rotating a + line="966">An object that allows a value to be changed via rotating a visual element, or which displays a value via such a rotating element. glib:name="ATSPI_ROLE_DIALOG"> A top level window with title bar and a border. + line="968">A top level window with title bar and a border. glib:name="ATSPI_ROLE_DIRECTORY_PANE"> A pane that allows the user to navigate through + line="969">A pane that allows the user to navigate through and select the contents of a directory. glib:name="ATSPI_ROLE_DRAWING_AREA"> A specialized dialog that displays the files in -the directory and lets the user select a file, browse a different -directory, or specify a filename. + line="971">An object used for drawing custom user interface +elements. glib:name="ATSPI_ROLE_FILE_CHOOSER"> An object used for drawing custom user interface -elements. + line="973">A specialized dialog that displays the files in +the directory and lets the user select a file, browse a different +directory, or specify a filename. glib:name="ATSPI_ROLE_FILLER"> A object that fills up space in a user interface. + line="976">A object that fills up space in a user interface. glib:name="ATSPI_ROLE_FOCUS_TRAVERSABLE"> Don't use, reserved for future use. + line="977">Don't use, reserved for future use. glib:name="ATSPI_ROLE_FONT_CHOOSER"> Allows selection of a display font. + line="978">Allows selection of a display font. glib:name="ATSPI_ROLE_FRAME"> A top level window with a title bar, border, menubar, + line="979">A top level window with a title bar, border, menubar, etc. glib:name="ATSPI_ROLE_GLASS_PANE"> A pane that is guaranteed to be painted on top of + line="981">A pane that is guaranteed to be painted on top of all panes beneath it. glib:name="ATSPI_ROLE_HTML_CONTAINER"> A document container for HTML, whose children + line="983">A document container for HTML, whose children represent the document content. glib:name="ATSPI_ROLE_ICON"> A small fixed size picture, typically used to decorate + line="985">A small fixed size picture, typically used to decorate components. glib:name="ATSPI_ROLE_IMAGE"> An image, typically static. + line="987">An image, typically static. glib:name="ATSPI_ROLE_INTERNAL_FRAME"> A frame-like object that is clipped by a desktop + line="988">A frame-like object that is clipped by a desktop pane. glib:name="ATSPI_ROLE_LABEL"> An object used to present an icon or short string in an + line="990">An object used to present an icon or short string in an interface. glib:name="ATSPI_ROLE_LAYERED_PANE"> A specialized pane that allows its children to be + line="992">A specialized pane that allows its children to be drawn in layers, providing a form of stacking order. glib:name="ATSPI_ROLE_LIST"> An object that presents a list of objects to the user and + line="994">An object that presents a list of objects to the user and allows the user to select one or more of them. glib:name="ATSPI_ROLE_LIST_ITEM"> An object that represents an element of a list. + line="996">An object that represents an element of a list. glib:name="ATSPI_ROLE_MENU"> An object usually found inside a menu bar that contains a + line="997">An object usually found inside a menu bar that contains a list of actions the user can choose from. glib:name="ATSPI_ROLE_MENU_BAR"> An object usually drawn at the top of the primary + line="999">An object usually drawn at the top of the primary dialog box of an application that contains a list of menus the user can choose from. @@ -7926,7 +8290,7 @@ choose from. glib:name="ATSPI_ROLE_MENU_ITEM"> An object usually contained in a menu that presents + line="1002">An object usually contained in a menu that presents an action the user can choose. glib:name="ATSPI_ROLE_OPTION_PANE"> A specialized pane whose primary use is inside a + line="1004">A specialized pane whose primary use is inside a dialog. glib:name="ATSPI_ROLE_PAGE_TAB"> An object that is a child of a page tab list. + line="1006">An object that is a child of a page tab list. glib:name="ATSPI_ROLE_PAGE_TAB_LIST"> An object that presents a series of panels (or + line="1007">An object that presents a series of panels (or page tabs), one at a time,through some mechanism provided by the object. @@ -7966,7 +8330,7 @@ object. glib:name="ATSPI_ROLE_PANEL"> A generic container that is often used to group objects. + line="1010">A generic container that is often used to group objects. glib:name="ATSPI_ROLE_PASSWORD_TEXT"> A text object uses for passwords, or other places + line="1011">A text object uses for passwords, or other places where the text content is not shown visibly to the user. glib:name="ATSPI_ROLE_POPUP_MENU"> A temporary window that is usually used to offer the + line="1013">A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices. @@ -7996,7 +8360,7 @@ choices. glib:name="ATSPI_ROLE_PROGRESS_BAR"> An object used to indicate how much of a task has + line="1016">An object used to indicate how much of a task has been completed. glib:name="ATSPI_ROLE_PUSH_BUTTON"> An object the user can manipulate to tell the + line="1018">An object the user can manipulate to tell the application to do something. glib:name="ATSPI_ROLE_RADIO_BUTTON"> A specialized check box that will cause other + line="1020">A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked. @@ -8027,7 +8391,7 @@ checked. glib:name="ATSPI_ROLE_RADIO_MENU_ITEM"> Object is both a menu item and a "radio button" + line="1023">Object is both a menu item and a "radio button" . See @ATSPI_ROLE_RADIO_BUTTON. glib:name="ATSPI_ROLE_ROOT_PANE"> A specialized pane that has a glass pane and a + line="1025">A specialized pane that has a glass pane and a layered pane as its children. glib:name="ATSPI_ROLE_ROW_HEADER"> The header for a row of data. + line="1027">The header for a row of data. glib:name="ATSPI_ROLE_SCROLL_BAR"> An object usually used to allow a user to + line="1028">An object usually used to allow a user to incrementally view a large amount of data by moving the bounds of a viewport along a one-dimensional axis. @@ -8067,7 +8431,7 @@ viewport along a one-dimensional axis. glib:name="ATSPI_ROLE_SCROLL_PANE"> An object that allows a user to incrementally view + line="1031">An object that allows a user to incrementally view a large amount of information. @ATSPI_ROLE_SCROLL_PANE objects are usually accompanied by @ATSPI_ROLE_SCROLL_BAR controllers, on which the @ATSPI_RELATION_CONTROLLER_FOR and @ATSPI_RELATION_CONTROLLED_BY @@ -8080,7 +8444,7 @@ reciprocal relations are set. See #atspi_get_relation_set. glib:name="ATSPI_ROLE_SEPARATOR"> An object usually contained in a menu to provide a + line="1036">An object usually contained in a menu to provide a visible and logical separation of the contents in a menu. glib:name="ATSPI_ROLE_SLIDER"> An object that allows the user to select from a bounded -range. + line="1038">An object that allows the user to select from a bounded +range. Unlike @ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control +'viewport'-like objects. glib:name="ATSPI_ROLE_SPIN_BUTTON"> An object which allows one of a set of choices to -be selected, and which displays the current choice. Unlike -@ATSPI_ROLE_SCROLL_BAR, @ATSPI_ROLE_SLIDER objects need not control -'viewport'-like objects. + line="1041">An object which allows one of a set of choices to +be selected, and which displays the current choice. A specialized panel that presents two other panels + line="1043">A specialized panel that presents two other panels at the same time. glib:name="ATSPI_ROLE_STATUS_BAR"> Object displays non-quantitative status information + line="1045">Object displays non-quantitative status information (c.f. @ATSPI_ROLE_PROGRESS_BAR) glib:name="ATSPI_ROLE_TABLE"> An object used to repesent information in terms of rows + line="1047">An object used to repesent information in terms of rows and columns. glib:name="ATSPI_ROLE_TABLE_CELL"> A 'cell' or discrete child within a Table. Note: + line="1049">A 'cell' or discrete child within a Table. Note: Table cells need not have @ATSPI_ROLE_TABLE_CELL, other #AtspiRoleType values are valid as well. @@ -8153,7 +8516,7 @@ Table cells need not have @ATSPI_ROLE_TABLE_CELL, other glib:name="ATSPI_ROLE_TABLE_COLUMN_HEADER"> An object which labels a particular column + line="1052">An object which labels a particular column in an #AtspiTable. glib:name="ATSPI_ROLE_TABLE_ROW_HEADER"> An object which labels a particular row in a + line="1054">An object which labels a particular row in a #AtspiTable. #AtspiTable rows and columns may also be labelled via the @ATSPI_RELATION_LABEL_FOR/@ATSPI_RELATION_LABELLED_BY relationships. See #atspi_get_relation_set. @@ -8175,7 +8538,7 @@ See #atspi_get_relation_set. glib:name="ATSPI_ROLE_TEAROFF_MENU_ITEM"> Object allows menu to be removed from menubar + line="1058">Object allows menu to be removed from menubar and shown in its own window. glib:name="ATSPI_ROLE_TERMINAL"> An object that emulates a terminal. + line="1060">An object that emulates a terminal. glib:name="ATSPI_ROLE_TEXT"> An interactive widget that supports multiple lines of text + line="1061">An interactive widget that supports multiple lines of text and optionally accepts user input, but whose purpose is not to solicit user input. Thus @ATSPI_ROLE_TEXT is appropriate for the text view in a plain text editor but inappropriate for an input field in a dialog box or web form. For @@ -8209,7 +8572,7 @@ of textual information, see @ATSPI_ROLE_STATIC. glib:name="ATSPI_ROLE_TOGGLE_BUTTON"> A specialized push button that can be checked or + line="1068">A specialized push button that can be checked or unchecked, but does not procide a separate indicator for the current state. @@ -8220,7 +8583,7 @@ state. glib:name="ATSPI_ROLE_TOOL_BAR"> A bar or palette usually composed of push buttons or + line="1071">A bar or palette usually composed of push buttons or toggle buttons. glib:name="ATSPI_ROLE_TOOL_TIP"> An object that provides information about another + line="1073">An object that provides information about another object. glib:name="ATSPI_ROLE_TREE"> An object used to repsent hierarchical information to the + line="1075">An object used to repsent hierarchical information to the user. glib:name="ATSPI_ROLE_TREE_TABLE"> An object that presents both tabular and + line="1077">An object that presents both tabular and hierarchical info to the user. glib:name="ATSPI_ROLE_UNKNOWN"> The object contains some #AtspiAccessible information, + line="1079">The object contains some #AtspiAccessible information, but its role is not known. glib:name="ATSPI_ROLE_VIEWPORT"> An object usually used in a scroll pane, or to + line="1081">An object usually used in a scroll pane, or to otherwise clip a larger object or content renderer to a specific onscreen viewport. @@ -8281,7 +8644,7 @@ onscreen viewport. glib:name="ATSPI_ROLE_WINDOW"> A top level window with no title or border. + line="1084">A top level window with no title or border. glib:name="ATSPI_ROLE_EXTENDED"> means that the role for this item is known, but not + line="1085">means that the role for this item is known, but not included in the core enumeration. Deprecated since 2.24. glib:name="ATSPI_ROLE_HEADER"> An object that serves as a document header. + line="1087">An object that serves as a document header. glib:name="ATSPI_ROLE_FOOTER"> An object that serves as a document footer. + line="1088">An object that serves as a document footer. glib:name="ATSPI_ROLE_PARAGRAPH"> An object which is contains a single paragraph of + line="1089">An object which is contains a single paragraph of text content. See also @ATSPI_ROLE_TEXT. glib:name="ATSPI_ROLE_RULER"> An object which describes margins and tab stops, etc. + line="1091">An object which describes margins and tab stops, etc. for text objects which it controls (should have @ATSPI_RELATION_CONTROLLER_FOR relation to such). @@ -8339,9 +8702,9 @@ text content. See also @ATSPI_ROLE_TEXT. glib:name="ATSPI_ROLE_APPLICATION"> An object corresponding to the toplevel accessible + line="1094">An object corresponding to the toplevel accessible of an application, which may contain @ATSPI_ROLE_FRAME objects or other -accessible objects. Children of #AccessibleDesktop objects are generally +accessible objects. Children of objects with the #ATSPI_ROLE_DESKTOP_FRAME role are generally @ATSPI_ROLE_APPLICATION objects. The object is a dialog or list containing items + line="1098">The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry. @@ -8362,7 +8725,7 @@ completion of a text entry. glib:name="ATSPI_ROLE_EDITBAR"> The object is an editable text object in a toolbar. + line="1101">The object is an editable text object in a toolbar. glib:name="ATSPI_ROLE_EMBEDDED"> The object is an embedded component container. This + line="1102">The object is an embedded component container. This role is a "grouping" hint that the contained objects share a context which is different from the container in which this accessible is embedded. In particular, it is used for some kinds of document embedding, @@ -8384,7 +8747,7 @@ and for embedding of out-of-process component, "panel applets", etc. glib:name="ATSPI_ROLE_ENTRY"> The object is a component whose textual content may be + line="1107">The object is a component whose textual content may be entered or modified by the user, provided @ATSPI_STATE_EDITABLE is present. A readonly @ATSPI_ROLE_ENTRY object (i.e. where @ATSPI_STATE_EDITABLE is not present) implies a read-only 'text field' in a form, as opposed to a @@ -8397,7 +8760,7 @@ title, label, or caption. glib:name="ATSPI_ROLE_CHART"> The object is a graphical depiction of quantitative data. + line="1112">The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The @ATSPI_LABELLED_BY relation is @@ -8411,7 +8774,7 @@ accessible description property. See @ATSPI_ROLE_CAPTION. glib:name="ATSPI_ROLE_CAPTION"> The object contains descriptive information, usually + line="1118">The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. @@ -8422,7 +8785,7 @@ image. glib:name="ATSPI_ROLE_DOCUMENT_FRAME"> The object is a visual frame or container which + line="1121">The object is a visual frame or container which contains a view of document content. #AtspiDocument frames may occur within another #AtspiDocument instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often @@ -8436,7 +8799,7 @@ should implement the #AtspiDocument interface. glib:name="ATSPI_ROLE_HEADING"> The object serves as a heading for content which + line="1127">The object serves as a heading for content which follows it in a document. The 'heading level' of the heading, if availabe, may be obtained by querying the object's attributes. @@ -8447,7 +8810,7 @@ availabe, may be obtained by querying the object's attributes. glib:name="ATSPI_ROLE_PAGE"> The object is a containing instance which encapsulates a + line="1130">The object is a containing instance which encapsulates a page of information. @ATSPI_ROLE_PAGE is used in documents and content which support a paginated navigation model. @@ -8458,7 +8821,7 @@ support a paginated navigation model. glib:name="ATSPI_ROLE_SECTION"> The object is a containing instance of document content + line="1133">The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections @@ -8471,7 +8834,7 @@ may be nested. glib:name="ATSPI_ROLE_REDUNDANT_OBJECT"> The object is redundant with another object in + line="1138">The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should be ignored by clients, if they are encountered at all. @@ -8482,7 +8845,7 @@ this role should be ignored by clients, if they are encountered at all. glib:name="ATSPI_ROLE_FORM"> The object is a containing instance of document content + line="1141">The object is a containing instance of document content which has within it components with which the user can interact in order to input information; i.e. the object is a container for pushbuttons, comboboxes, text input fields, and other 'GUI' components. @ATSPI_ROLE_FORM @@ -8501,7 +8864,7 @@ application or viewer instance. glib:name="ATSPI_ROLE_LINK"> The object is a hypertext anchor, i.e. a "link" in a + line="1152">The object is a hypertext anchor, i.e. a "link" in a hypertext document. Such objects are distinct from 'inline' content which may also use the #AtspiHypertext/#AtspiHyperlink interfacesto indicate the range/location within a text object where an inline or embedded object @@ -8514,7 +8877,7 @@ lies. glib:name="ATSPI_ROLE_INPUT_METHOD_WINDOW"> The object is a window or similar viewport + line="1157">The object is a window or similar viewport which is used to allow composition or input of a 'complex character', in other words it is an "input method window". @@ -8525,7 +8888,7 @@ in other words it is an "input method window". glib:name="ATSPI_ROLE_TABLE_ROW"> A row in a table. + line="1160">A row in a table. glib:name="ATSPI_ROLE_TREE_ITEM"> An object that represents an element of a tree. + line="1161">An object that represents an element of a tree. glib:name="ATSPI_ROLE_DOCUMENT_SPREADSHEET"> A document frame which contains a + line="1162">A document frame which contains a spreadsheet. glib:name="ATSPI_ROLE_DOCUMENT_PRESENTATION"> A document frame which contains a + line="1164">A document frame which contains a presentation or slide content. glib:name="ATSPI_ROLE_DOCUMENT_TEXT"> A document frame which contains textual content, + line="1166">A document frame which contains textual content, such as found in a word processing application. @@ -8574,7 +8937,7 @@ application. glib:name="ATSPI_ROLE_DOCUMENT_WEB"> A document frame which contains HTML or other + line="1169">A document frame which contains HTML or other markup suitable for display in a web browser. glib:name="ATSPI_ROLE_DOCUMENT_EMAIL"> A document frame which contains email content + line="1171">A document frame which contains email content to be displayed or composed either in plain text or HTML. @@ -8595,7 +8958,7 @@ HTML. glib:name="ATSPI_ROLE_COMMENT"> An object found within a document and designed to + line="1174">An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated. @@ -8606,7 +8969,7 @@ might not be visible until activated. glib:name="ATSPI_ROLE_LIST_BOX"> A non-collapsible list of choices the user can + line="1177">A non-collapsible list of choices the user can select from. glib:name="ATSPI_ROLE_GROUPING"> A group of related widgets. This group typically has + line="1179">A group of related widgets. This group typically has a label. glib:name="ATSPI_ROLE_IMAGE_MAP"> An image map object. Usually a graphic with multiple + line="1181">An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. @@ -8637,7 +9000,7 @@ another document or section of a document. glib:name="ATSPI_ROLE_NOTIFICATION"> A transitory object designed to present a + line="1184">A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. @@ -8648,7 +9011,7 @@ particular application. glib:name="ATSPI_ROLE_INFO_BAR"> An object designed to present a message to the user + line="1187">An object designed to present a message to the user within an existing window. glib:name="ATSPI_ROLE_LEVEL_BAR"> A bar that serves as a level indicator to, for + line="1189">A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. @Since: 2.8 A bar that serves as the title of a window or a + line="1191">A bar that serves as the title of a window or a dialog. @Since: 2.12 An object which contains a text section + line="1193">An object which contains a text section that is quoted from another source. @Since: 2.12 An object which represents an audio + line="1195">An object which represents an audio element. @Since: 2.12 An object which represents a video + line="1197">An object which represents a video element. @Since: 2.12 A definition of a term or concept. @Since: 2.12 + line="1199">A definition of a term or concept. @Since: 2.12 A section of a page that consists of a + line="1200">A section of a page that consists of a composition that forms an independent part of a document, page, or site. Examples: A blog entry, a news story, a forum post. @Since: 2.12 @@ -8729,7 +9092,7 @@ instance, show the strength of a password or the state of a battery. @Since: 2.8 glib:name="ATSPI_ROLE_LANDMARK"> A region of a web page intended as a + line="1204">A region of a web page intended as a navigational landmark. This is designed to allow Assistive Technologies to provide quick navigation among key regions within a document. @Since: 2.12 @@ -8741,7 +9104,7 @@ instance, show the strength of a password or the state of a battery. @Since: 2.8 glib:name="ATSPI_ROLE_LOG"> A text widget or container holding log content, such + line="1208">A text widget or container holding log content, such as chat history and error logs. In this role there is a relationship between the arrival of new items in the log and the reading order. The log contains a meaningful sequence and new @@ -8755,7 +9118,7 @@ instance, show the strength of a password or the state of a battery. @Since: 2.8 glib:name="ATSPI_ROLE_MARQUEE"> A container where non-essential information + line="1214">A container where non-essential information changes frequently. Common usages of marquee include stock tickers and ad banners. The primary difference between a marquee and a log is that logs usually have a meaningful order or sequence of @@ -8768,7 +9131,7 @@ instance, show the strength of a password or the state of a battery. @Since: 2.8 glib:name="ATSPI_ROLE_MATH"> A text widget or container that holds a mathematical + line="1219">A text widget or container that holds a mathematical expression. @Since: 2.12 A widget whose purpose is to display a rating, + line="1221">A widget whose purpose is to display a rating, such as the number of stars associated with a song in a media player. Objects of this role should also implement AtspiValue. @Since: 2.12 @@ -8790,7 +9153,7 @@ instance, show the strength of a password or the state of a battery. @Since: 2.8 glib:name="ATSPI_ROLE_TIMER"> An object containing a numerical counter which + line="1225">An object containing a numerical counter which indicates an amount of elapsed time from a start point, or the time remaining until an end point. @Since: 2.12 @@ -8801,7 +9164,7 @@ instance, show the strength of a password or the state of a battery. @Since: 2.8 glib:name="ATSPI_ROLE_STATIC"> A generic non-container object whose purpose is to display + line="1228">A generic non-container object whose purpose is to display a brief amount of information to the user and whose role is known by the implementor but lacks semantic value for the user. Examples in which @ATSPI_ROLE_STATIC is appropriate include the message displayed in a message @@ -8822,7 +9185,7 @@ instance, show the strength of a password or the state of a battery. @Since: 2.8 glib:name="ATSPI_ROLE_MATH_FRACTION"> An object that represents a mathematical fraction. @Since: 2.16. + line="1241">An object that represents a mathematical fraction. @Since: 2.16. An object that represents a mathematical expression + line="1242">An object that represents a mathematical expression displayed with a radical. @Since: 2.16. An object that contains text that is displayed as a + line="1244">An object that contains text that is displayed as a subscript. @Since: 2.16. An object that contains text that is displayed as a + line="1246">An object that contains text that is displayed as a superscript. @Since: 2.16. An object that represents a list of term-value + line="1248">An object that represents a list of term-value groups. A term-value group represents an individual description and consist of one or more names (@ATSPI_ROLE_DESCRIPTION_TERM) followed by one or more values (@ATSPI_ROLE_DESCRIPTION_VALUE). For each list, there should not be @@ -8874,7 +9237,7 @@ instance, show the strength of a password or the state of a battery. @Since: 2.8 glib:name="ATSPI_ROLE_DESCRIPTION_TERM"> An object that represents a term or phrase + line="1253">An object that represents a term or phrase with a corresponding definition. @Since: 2.26. An object that represents the description, + line="1255">An object that represents the description, definition, or value of a term. @Since: 2.26. An object that contains the text of a footnote. @Since: 2.26. + line="1257">An object that contains the text of a footnote. @Since: 2.26. Content previously deleted or proposed to be + line="1258">Content previously deleted or proposed to be deleted, e.g. in revision history or a content view providing suggestions from reviewers. @Since: 2.34. @@ -8914,7 +9277,7 @@ from reviewers. @Since: 2.34. glib:name="ATSPI_ROLE_CONTENT_INSERTION"> Content previously inserted or proposed to be + line="1261">Content previously inserted or proposed to be inserted, e.g. in revision history or a content view providing suggestions from reviewers. @Since: 2.34. @@ -8925,7 +9288,7 @@ from reviewers. @Since: 2.34. glib:name="ATSPI_ROLE_MARK"> A run of content that is marked or highlighted, such as for + line="1264">A run of content that is marked or highlighted, such as for reference purposes, or to call it out as having a special purpose. If the marked content has an associated section in the document elaborating on the reason for the mark, then %ATSPI_RELATION_DETAILS should be used on the mark @@ -8940,39 +9303,68 @@ to point back to the mark. @Since: 2.36. glib:name="ATSPI_ROLE_SUGGESTION"> A container for content that is called out as a proposed + line="1271">A container for content that is called out as a proposed change from the current version of the document, such as by a reviewer of the -content. This role should include either %ATSPI_ROLE_CONTENT_DELETION and/or -%ATSPI_ROLE_CONTENT_INSERTION children, in any order, to indicate what the +content. An object with this role should include children with %ATSPI_ROLE_CONTENT_DELETION and/or +%ATSPI_ROLE_CONTENT_INSERTION, in any order, to indicate what the actual change is. @Since: 2.36 - + A specialized push button to open a menu. @Since 2.46 + + Not a valid role, used for finding end of - enumeration. + line="1277">Not a valid role, used for finding end of +enumeration. + + Gets the localized description string describing the #AtspiRole @role. + + + the localized string describing the AtspiRole + + + + + an #AtspiRole object to query. + + + + Gets a localizable string that indicates the name of an #AtspiRole. -<em>DEPRECATED.</em> + line="1994">Gets a localizable string that indicates the name of an #AtspiRole. a localizable string name for an #AtspiRole enumerated type. + line="2000">a localizable string name for an #AtspiRole enumerated type. an #AtspiRole object to query. + line="1996">an #AtspiRole object to query. @@ -8983,8 +9375,8 @@ actual change is. @Since: 2.36 c:type="ATSPI_SCROLLTYPE_COUNT"> One higher than the highest valid value of #AtspiScrollType. - + line="1473">One higher than the highest valid value of #AtspiScrollType. + One higher than the highest valid value of #AtspiCollectionSortOrder. - + line="189">One higher than the highest valid value of #AtspiCollectionSortOrder. + One higher than the highest valid value of #AtspiStateType. - + line="655">One higher than the highest valid value of #AtspiStateType. + c:type="AtspiScrollType"> Enumeration used by interface #AtspiAccessible to specify where an + line="1442">Enumeration used by interface #AtspiAccessible to specify where an #AtspiAccessible object should be placed on the screen when using scroll_to. glib:name="ATSPI_SCROLL_TOP_LEFT"> Scroll the object to the top left corner of the + line="1444">Scroll the object to the top left corner of the window. glib:name="ATSPI_SCROLL_BOTTOM_RIGHT"> Scroll the object to the bottom right corner of + line="1446">Scroll the object to the bottom right corner of the window. glib:name="ATSPI_SCROLL_TOP_EDGE"> Scroll the object to the top edge of the window. + line="1448">Scroll the object to the top edge of the window. glib:name="ATSPI_SCROLL_BOTTOM_EDGE"> Scroll the object to the bottom edge of the + line="1449">Scroll the object to the bottom edge of the window. glib:name="ATSPI_SCROLL_LEFT_EDGE"> Scroll the object to the left edge of the + line="1451">Scroll the object to the left edge of the window. glib:name="ATSPI_SCROLL_RIGHT_EDGE"> Scroll the object to the right edge of the + line="1453">Scroll the object to the right edge of the window. glib:name="ATSPI_SCROLL_ANYWHERE"> Scroll the object to application-dependent position + line="1455">Scroll the object to application-dependent position on the window. @@ -9129,25 +9521,35 @@ on the window. c:type="AtspiSelection" glib:type-name="AtspiSelection" glib:get-type="atspi_selection_get_type"> + An interface which indicates that an object exposes a 'selection' model, +allowing the selection of one or more of its children. + +An interface which indicates that an object exposes a 'selection' +model, allowing the selection of one or more of its children. +Read-only Selection instances are possible, in which case the +interface is used to programmatically determine the selected-ness +of its children. Clears the current selection, removing all selected children from the + line="234">Clears the current selection, removing all selected children from the specified #AtspiSelection implementor's selection list. - + #TRUE if successful, #FALSE otherwise. + line="241">#TRUE if successful, #FALSE otherwise. a pointer to the #AtspiSelection implementor on which to operate. + line="236">a pointer to the #AtspiSelection implementor on which to operate. @@ -9157,7 +9559,7 @@ on the window. throws="1"> Deselects a specific child of an #AtspiSelection. + line="156">Deselects a specific child of an #AtspiSelection. Note that @child_index is the index of the child in the parent container. @@ -9166,20 +9568,20 @@ See #atspi_selection_deselect_selected_child #TRUE if the child was successfully deselected, #FALSE otherwise. + line="168">#TRUE if the child was successfully deselected, #FALSE otherwise. a pointer to the #AtspiSelection on which to operate. + line="158">a pointer to the #AtspiSelection on which to operate. a #gint indicating which of the children + line="159">a #gint indicating which of the children of the #AtspiAccessible is to be de-selected. @@ -9190,7 +9592,7 @@ See #atspi_selection_deselect_selected_child throws="1"> Removes a child from the selected children list of an #AtspiSelection. + line="127">Removes a child from the selected children list of an #AtspiSelection. Note that @child_index is the index in the selected-children list, not the index in the parent container. @selectedChildIndex in this method, and @child_index in #atspi_selection_select_child @@ -9199,20 +9601,20 @@ See #atspi_selection_deselect_selected_child #TRUE if the child was successfully deselected, #FALSE otherwise. + line="139">#TRUE if the child was successfully deselected, #FALSE otherwise. a pointer to the #AtspiSelection on which to operate. + line="129">a pointer to the #AtspiSelection on which to operate. a #gint indicating which of the selected children + line="130">a #gint indicating which of the selected children of the #Accessible is to be selected. @@ -9223,13 +9625,13 @@ See #atspi_selection_deselect_selected_child throws="1"> Gets the number of children of an #AtspiSelection implementor which are + line="40">Gets the number of children of an #AtspiSelection implementor which are currently selected. a #gint indicating the number of #Accessible children + line="47">a #gint indicating the number of #Accessible children of the #AtspiSelection implementor which are currently selected. @@ -9237,7 +9639,7 @@ See #atspi_selection_deselect_selected_child a pointer to the #AtspiSelection implementor on which to operate. + line="42">a pointer to the #AtspiSelection implementor on which to operate. @@ -9247,7 +9649,7 @@ See #atspi_selection_deselect_selected_child throws="1"> Gets the i-th selected #AtspiAccessible child of an #AtspiSelection. + line="63">Gets the i-th selected #AtspiAccessible child of an #AtspiSelection. Note that @selected_child_index refers to the index in the list of 'selected' children and generally differs from that used in @@ -9259,7 +9661,7 @@ See #atspi_selection_deselect_selected_child a pointer to a selected #AtspiAccessible child + line="78">a pointer to a selected #AtspiAccessible child object, specified by @selected_child_index. @@ -9267,13 +9669,13 @@ See #atspi_selection_deselect_selected_child a pointer to the #AtspiSelection on which to operate. + line="65">a pointer to the #AtspiSelection on which to operate. a #gint indicating which of the selected + line="66">a #gint indicating which of the selected children is specified. @@ -9284,14 +9686,14 @@ See #atspi_selection_deselect_selected_child throws="1"> Determines whether a particular child of an #AtspiSelection implementor + line="185">Determines whether a particular child of an #AtspiSelection implementor is currently selected. Note that @child_index is the index into the standard #AtspiAccessible container's list of children. #TRUE if the specified child is currently selected, + line="194">#TRUE if the specified child is currently selected, #FALSE otherwise. @@ -9299,13 +9701,13 @@ See #atspi_selection_deselect_selected_child a pointer to the #AtspiSelection implementor on which to operate. + line="187">a pointer to the #AtspiSelection implementor on which to operate. an index into the #AtspiSelection's list of children. + line="188">an index into the #AtspiSelection's list of children. @@ -9315,20 +9717,20 @@ See #atspi_selection_deselect_selected_child throws="1"> Attempts to select all of the children of an #AtspiSelection implementor. + line="212">Attempts to select all of the children of an #AtspiSelection implementor. Not all #AtspiSelection implementors support this operation. - + #TRUE if successful, #FALSE otherwise. + line="219">#TRUE if successful, #FALSE otherwise. a pointer to the #AtspiSelection implementor on which to operate. + line="214">a pointer to the #AtspiSelection implementor on which to operate. @@ -9338,7 +9740,7 @@ Not all #AtspiSelection implementors support this operation. throws="1"> Adds a child to the selected children list of an #AtspiSelection. + line="99">Adds a child to the selected children list of an #AtspiSelection. For #AtspiSelection implementors that only allow single selections, this may replace the (single) current selection. @@ -9346,20 +9748,20 @@ Not all #AtspiSelection implementors support this operation. #TRUE if the child was successfully selected, #FALSE otherwise. + line="110">#TRUE if the child was successfully selected, #FALSE otherwise. a pointer to the #AtspiSelection on which to operate. + line="101">a pointer to the #AtspiSelection on which to operate. a #gint indicating which child of the #Accessible + line="102">a #gint indicating which child of the #Accessible is to be selected. @@ -9373,23 +9775,27 @@ Not all #AtspiSelection implementors support this operation. glib:type-name="AtspiStateSet" glib:get-type="atspi_state_set_get_type" glib:type-struct="StateSetClass"> + The atspi-stateset objects implement wrappers around a +bitmap of accessible states. Generates an #AtspiStateSet with the given @states. + line="49">Generates an #AtspiStateSet with the given @states. A new #AtspiStateSet with the given states. + line="56">A new #AtspiStateSet with the given states. An array of states with which the + line="51">An array of states with which the method initializes the state set. @@ -9400,7 +9806,7 @@ Not all #AtspiSelection implementors support this operation. Adds a particular #AtspiState to an #AtspiStateSet (i.e. sets the + line="140">Adds a particular #AtspiState to an #AtspiStateSet (i.e. sets the given state to #TRUE in the stateset). @@ -9410,13 +9816,13 @@ Not all #AtspiSelection implementors support this operation. a pointer to the #AtspiStateSet object on which to operate. + line="142">a pointer to the #AtspiStateSet object on which to operate. an #AtspiStateType to be added to the specified #AtspiStateSet. + line="143">an #AtspiStateType to be added to the specified #AtspiStateSet. @@ -9424,14 +9830,14 @@ Not all #AtspiSelection implementors support this operation. Determines the differences between two instances of #AtspiStateSet. + line="156">Determines the differences between two instances of #AtspiStateSet. @see #atspi_state_set_equals. an #AtspiStateSet object containing all states + line="165">an #AtspiStateSet object containing all states contained on one of the two sets but not the other. @@ -9439,13 +9845,13 @@ contained on one of the two sets but not the other. a pointer to the first #AtspiStateSet object on which to operate. + line="158">a pointer to the first #AtspiStateSet object on which to operate. a pointer to the second #AtspiStateSet object on which to operate. + line="159">a pointer to the second #AtspiStateSet object on which to operate. @@ -9453,13 +9859,13 @@ contained on one of the two sets but not the other. Determines whether a given #AtspiStateSet includes a given state; that is, + line="179">Determines whether a given #AtspiStateSet includes a given state; that is, whether @state is true for the @set in question. #TRUE if @state is true/included in the given #AtspiStateSet, + line="188">#TRUE if @state is true/included in the given #AtspiStateSet, otherwise #FALSE. @@ -9467,13 +9873,13 @@ contained on one of the two sets but not the other. a pointer to the #AtspiStateSet object on which to operate. + line="181">a pointer to the #AtspiStateSet object on which to operate. an #AtspiStateType for which the specified #AtspiStateSet + line="182">an #AtspiStateType for which the specified #AtspiStateSet will be queried. @@ -9482,7 +9888,7 @@ contained on one of the two sets but not the other. Determines whether two instances of #AtspiStateSet are equivalent (i.e. + line="202">Determines whether two instances of #AtspiStateSet are equivalent (i.e. consist of the same #AtspiStates). Useful for checking multiple state variables at once. @@ -9491,7 +9897,7 @@ contained on one of the two sets but not the other. #TRUE if the two #AtspiStateSets are equivalent, + line="213">#TRUE if the two #AtspiStateSets are equivalent, otherwise #FALSE. @@ -9499,13 +9905,13 @@ otherwise #FALSE. a pointer to the first #AtspiStateSet object on which to operate. + line="204">a pointer to the first #AtspiStateSet object on which to operate. a pointer to the second #AtspiStateSet object on which to operate. + line="205">a pointer to the second #AtspiStateSet object on which to operate. @@ -9513,12 +9919,12 @@ otherwise #FALSE. Returns the states in an #AtspiStateSet as an array. + line="228">Returns the states in an #AtspiStateSet as an array. A #GArray of state + line="234">A #GArray of state types representing the current state. @@ -9528,7 +9934,7 @@ otherwise #FALSE. The #AtspiStateSet to be queried. + line="230">The #AtspiStateSet to be queried. @@ -9538,14 +9944,14 @@ otherwise #FALSE. #TRUE if the state set contains no states; #FALSE otherwise. + line="262">#TRUE if the state set contains no states; #FALSE otherwise. The #AtspiStateSet to query. + line="260">The #AtspiStateSet to query. @@ -9553,7 +9959,7 @@ otherwise #FALSE. Removes a particular #AtspiState to an #AtspiStateSet (i.e. sets the + line="270">Removes a particular #AtspiState to an #AtspiStateSet (i.e. sets the given state to #FALSE in the stateset.) @@ -9563,13 +9969,13 @@ otherwise #FALSE. a pointer to the #AtspiStateSet object on which to operate. + line="272">a pointer to the #AtspiStateSet object on which to operate. an #AtspiStateType to remove from the specified @set. + line="273">an #AtspiStateType to remove from the specified @set. @@ -9577,7 +9983,7 @@ otherwise #FALSE. Enables/disables a state in an #AtspiStateSet according to its @name. + line="85">Enables/disables a state in an #AtspiStateSet according to its @name. @@ -9586,19 +9992,19 @@ otherwise #FALSE. a pointer to the #AtspiStateSet object on which to operate. + line="87">a pointer to the #AtspiStateSet object on which to operate. a string corresponding to a state name. + line="88">a string corresponding to a state name. if #TRUE, @name should be enabled in the @set in question; + line="89">if #TRUE, @name should be enabled in the @set in question; otherwise, it should be disabled. @@ -9628,7 +10034,7 @@ otherwise #FALSE. c:type="AtspiStateType"> Enumeration used by various interfaces indicating every possible state + line="434">Enumeration used by various interfaces indicating every possible state an #AtspiAccesible object can assume. glib:name="ATSPI_STATE_INVALID"> Indicates an invalid state - probably an error + line="436">Indicates an invalid state - probably an error condition. glib:name="ATSPI_STATE_ACTIVE"> Indicates a window is currently the active window, or + line="438">Indicates a window is currently the active window, or an object is the active subelement within a container or table. @ATSPI_STATE_ACTIVE should not be used for objects which have #ATSPI_STATE_FOCUSABLE or #ATSPI_STATE_SELECTABLE: Those objects should use @@ -9663,7 +10069,7 @@ parent container. glib:name="ATSPI_STATE_ARMED"> Indicates that the object is armed. + line="446">Indicates that the object is armed. glib:name="ATSPI_STATE_BUSY"> Indicates the current object is busy, i.e. onscreen + line="447">Indicates the current object is busy, i.e. onscreen representation is in the process of changing, or the object is temporarily unavailable for interaction due to activity already in progress. @@ -9683,7 +10089,7 @@ temporarily unavailable for interaction due to activity already in progress. Indicates this object is currently checked. + line="450">Indicates this object is currently checked. Indicates this object is collapsed. + line="451">Indicates this object is collapsed. Indicates that this object no longer has a valid + line="452">Indicates that this object no longer has a valid backing widget (for instance, if its peer object has been destroyed). Indicates the user can change the contents of this + line="454">Indicates the user can change the contents of this object. glib:name="ATSPI_STATE_ENABLED"> Indicates that this object is enabled, i.e. that it + line="456">Indicates that this object is enabled, i.e. that it currently reflects some application state. Objects that are "greyed out" may lack this state, and may lack the @ATSPI_STATE_SENSITIVE if direct user interaction cannot cause them to acquire @ATSPI_STATE_ENABLED. @@ -9734,7 +10140,7 @@ See @ATSPI_STATE_SENSITIVE. glib:name="ATSPI_STATE_EXPANDABLE"> Indicates this object allows progressive + line="461">Indicates this object allows progressive disclosure of its children. glib:name="ATSPI_STATE_EXPANDED"> Indicates this object is expanded. + line="463">Indicates this object is expanded. glib:name="ATSPI_STATE_FOCUSABLE"> Indicates this object can accept keyboard focus, + line="464">Indicates this object can accept keyboard focus, which means all events resulting from typing on the keyboard will normally be passed to it when it has focus. @@ -9764,7 +10170,7 @@ normally be passed to it when it has focus. glib:name="ATSPI_STATE_FOCUSED"> Indicates this object currently has the keyboard + line="467">Indicates this object currently has the keyboard focus. glib:name="ATSPI_STATE_HAS_TOOLTIP"> Indicates that the object has an associated + line="469">Indicates that the object has an associated tooltip. glib:name="ATSPI_STATE_HORIZONTAL"> Indicates the orientation of this object is + line="471">Indicates the orientation of this object is horizontal. glib:name="ATSPI_STATE_ICONIFIED"> Indicates this object is minimized and is + line="473">Indicates this object is minimized and is represented only by an icon. glib:name="ATSPI_STATE_MODAL"> Indicates something must be done with this object + line="475">Indicates something must be done with this object before the user can interact with an object in a different window. glib:name="ATSPI_STATE_MULTI_LINE"> Indicates this (text) object can contain multiple + line="477">Indicates this (text) object can contain multiple lines of text. glib:name="ATSPI_STATE_MULTISELECTABLE"> Indicates this object allows more than one of + line="479">Indicates this object allows more than one of its children to be selected at the same time, or in the case of text objects, that the object supports non-contiguous text selections. @@ -9835,7 +10241,7 @@ objects, that the object supports non-contiguous text selections. glib:name="ATSPI_STATE_OPAQUE"> Indicates this object paints every pixel within its + line="482">Indicates this object paints every pixel within its rectangular region. It also indicates an alpha value of unity, if it supports alpha blending. @@ -9846,7 +10252,7 @@ supports alpha blending. glib:name="ATSPI_STATE_PRESSED"> Indicates this object is currently pressed. + line="485">Indicates this object is currently pressed. glib:name="ATSPI_STATE_RESIZABLE"> Indicates the size of this object's size is not + line="486">Indicates the size of this object's size is not fixed. glib:name="ATSPI_STATE_SELECTABLE"> Indicates this object is the child of an object + line="488">Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that can be selected. @@ -9876,7 +10282,7 @@ those children that can be selected. glib:name="ATSPI_STATE_SELECTED"> Indicates this object is the child of an object that + line="491">Indicates this object is the child of an object that allows its children to be selected and that this child is one of those children that has been selected. @@ -9887,7 +10293,7 @@ children that has been selected. glib:name="ATSPI_STATE_SENSITIVE"> Indicates this object is sensitive, e.g. to user + line="494">Indicates this object is sensitive, e.g. to user interaction. @ATSPI_STATE_SENSITIVE usually accompanies. @ATSPI_STATE_ENABLED for user-actionable controls, but may be found in the absence of @ATSPI_STATE_ENABLED if the current visible state of the control @@ -9904,7 +10310,7 @@ current state is ambiguous or undefined. See @ATSPI_STATE_ENABLED, glib:name="ATSPI_STATE_SHOWING"> Indicates this object, the object's parent, the + line="503">Indicates this object, the object's parent, the object's parent's parent, and so on, are all 'shown' to the end-user, i.e. subject to "exposure" if blocking or obscuring objects do not interpose between this object and the top of the window stack. @@ -9916,7 +10322,7 @@ interpose between this object and the top of the window stack. glib:name="ATSPI_STATE_SINGLE_LINE"> Indicates this (text) object can contain only a + line="507">Indicates this (text) object can contain only a single line of text. glib:name="ATSPI_STATE_STALE"> Indicates that the information returned for this object + line="509">Indicates that the information returned for this object may no longer be synchronized with the application state. This can occur if the object has @ATSPI_STATE_TRANSIENT, and can also occur towards the end of the object peer's lifecycle. @@ -9938,7 +10344,7 @@ end of the object peer's lifecycle. glib:name="ATSPI_STATE_TRANSIENT"> Indicates this object is transient. + line="513">Indicates this object is transient. glib:name="ATSPI_STATE_VERTICAL"> Indicates the orientation of this object is vertical; + line="514">Indicates the orientation of this object is vertical; for example this state may appear on such objects as scrollbars, text objects (with vertical text flow), separators, etc. @@ -9958,7 +10364,7 @@ objects (with vertical text flow), separators, etc. glib:name="ATSPI_STATE_VISIBLE"> Indicates this object is visible, e.g. has been + line="517">Indicates this object is visible, e.g. has been explicitly marked for exposure to the user. @ATSPI_STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only that it is 'potentially' visible, barring obstruction, being scrolled or clipped @@ -9975,7 +10381,7 @@ semantically equivalent to saying that an object is 'hidden'. glib:name="ATSPI_STATE_MANAGES_DESCENDANTS"> Indicates that "active-descendant-changed" + line="526">Indicates that "active-descendant-changed" event is sent when children become 'active' (i.e. are selected or navigated to onscreen). Used to prevent need to enumerate all children in very large containers, like tables. The presence of @@ -9993,7 +10399,7 @@ the client having previously requested references to those children. glib:name="ATSPI_STATE_INDETERMINATE"> Indicates that a check box or other boolean + line="536">Indicates that a check box or other boolean indicator is in a state other than checked or not checked. This usually means that the boolean value reflected or controlled by the object does not apply consistently to the entire current context. @@ -10012,7 +10418,7 @@ fired. glib:name="ATSPI_STATE_REQUIRED"> Indicates that user interaction with this object is + line="547">Indicates that user interaction with this object is 'required' from the user, for instance before completing the processing of a form. @@ -10023,7 +10429,7 @@ processing of a form. glib:name="ATSPI_STATE_TRUNCATED"> Indicates that an object's onscreen content + line="550">Indicates that an object's onscreen content is truncated, e.g. a text value in a spreadsheet cell. glib:name="ATSPI_STATE_ANIMATED"> Indicates this object's visual representation is + line="552">Indicates this object's visual representation is dynamic, not static. This state may be applied to an object during an animated 'effect' and be removed from the object once its visual representation becomes static. Some applications, notably content viewers, @@ -10049,7 +10455,7 @@ static; this state is advisory. glib:name="ATSPI_STATE_INVALID_ENTRY"> This object has indicated an error condition + line="560">This object has indicated an error condition due to failure of input validation. For instance, a form control may acquire this state in response to invalid or malformed user input. @@ -10060,7 +10466,7 @@ acquire this state in response to invalid or malformed user input. glib:name="ATSPI_STATE_SUPPORTS_AUTOCOMPLETION"> This state indicates that the object + line="563">This state indicates that the object in question implements some form of typeahead or pre-selection behavior whereby entering the first character of one or more sub-elements causes those elements to scroll into view or become @@ -10078,7 +10484,7 @@ these input events may trigger text-changed events from the source. glib:name="ATSPI_STATE_SELECTABLE_TEXT"> This state indicates that the object in + line="573">This state indicates that the object in question supports text selection. It should only be exposed on objects which implement the #AtspiText interface, in order to distinguish this state from @ATSPI_STATE_SELECTABLE, which infers that the object in question is a @@ -10092,7 +10498,7 @@ similar, text selection and subelement selection are distinct operations. glib:name="ATSPI_STATE_IS_DEFAULT"> This state indicates that the object in question is + line="579">This state indicates that the object in question is the 'default' interaction object in a dialog, i.e. the one that gets activated if the user presses "Enter" when the dialog is initially posted. @@ -10104,7 +10510,7 @@ posted. glib:name="ATSPI_STATE_VISITED"> This state indicates that the object (typically a + line="583">This state indicates that the object (typically a hyperlink) has already been activated or invoked, with the result that some backing data has been downloaded or rendered. @@ -10115,7 +10521,7 @@ some backing data has been downloaded or rendered. glib:name="ATSPI_STATE_CHECKABLE"> Indicates this object has the potential to + line="586">Indicates this object has the potential to be checked, such as a checkbox or toggle-able table cell. @Since: 2.12 @@ -10126,7 +10532,7 @@ some backing data has been downloaded or rendered. glib:name="ATSPI_STATE_HAS_POPUP"> Indicates that the object has a popup + line="589">Indicates that the object has a popup context menu or sub-level menu which may or may not be showing. This means that activation renders conditional content. Note that ordinary tooltips are not considered popups in this @@ -10139,7 +10545,7 @@ context. @Since: 2.12 glib:name="ATSPI_STATE_READ_ONLY"> Indicates that an object which is ENABLED and + line="594">Indicates that an object which is ENABLED and SENSITIVE has a value which can be read, but not modified, by the user. @Since: 2.16 @@ -10150,7 +10556,7 @@ user. @Since: 2.16 glib:name="ATSPI_STATE_LAST_DEFINED"> This value of the enumeration should not be used + line="597">This value of the enumeration should not be used as a parameter, it indicates the number of items in the #AtspiStateType enumeration. @@ -10201,8 +10607,8 @@ enumeration. c:type="ATSPI_TEXT_BOUNDARY_TYPE_COUNT"> One higher than the highest valid value of #AtspiTextBoundaryType. - + line="398">One higher than the highest valid value of #AtspiTextBoundaryType. + c:type="ATSPI_TEXT_CLIP_TYPE_COUNT"> One higher than the highest valid value of #AtspiTextClipType. - + line="427">One higher than the highest valid value of #AtspiTextClipType. + c:type="ATSPI_TREETRAVERSALTYPE_COUNT"> One higher than the highest valid value of + line="250">One higher than the highest valid value of #AtspiCollection_TreeTraversalType. - + c:type="AtspiTable" glib:type-name="AtspiTable" glib:get-type="atspi_table_get_type"> + An interface used by containers whose data is arranged in a tabular form. + +An interface used by containers whose contained data is arranged +in a tabular (i.e. row-column) form. Tables may resemble +a two-dimensional grid, as in a spreadsheet, or may feature objects +which span multiple rows and/or columns, but whose bounds are +aligned on a row/column matrix. Objects within tables are children +of the table object, and they may be referenced either via a child +index or via a row/column pair. Table 'cells' may implement other +interfaces, such as Text, Action, Image, and Component, and should do +so as appropriate to their onscreen presentation and/or behavior. Selects the specified column, adding it to the current column selection. + line="571">Selects the specified column, adding it to the current column selection. Not all tables support column selection. #TRUE if the specified column was successfully selected, #FALSE if not. + line="579">#TRUE if the specified column was successfully selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. + line="573">a pointer to the #AtspiTable implementor on which to operate. the zero-indexed column number of the column being selected. + line="574">the zero-indexed column number of the column being selected. @@ -10272,26 +10691,26 @@ Not all tables support column selection. throws="1"> Selects the specified row, adding it to the current row selection. + line="546">Selects the specified row, adding it to the current row selection. Not all tables support row selection. #TRUE if the specified row was successfully selected, #FALSE if not. + line="554">#TRUE if the specified row was successfully selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. + line="548">a pointer to the #AtspiTable implementor on which to operate. the zero-indexed row number of the row being selected. + line="549">the zero-indexed row number of the row being selected. @@ -10301,14 +10720,14 @@ Not all tables support row selection. throws="1"> Gets the table cell at the specified row and column indices. + line="130">Gets the table cell at the specified row and column indices. To get the accessible object at a particular (x, y) screen coordinate, use #atspi_component_get_accessible_at_point. an #AtspiAccessible object representing the + line="140">an #AtspiAccessible object representing the specified table cell. @@ -10316,19 +10735,19 @@ coordinate, use #atspi_component_get_accessible_at_point. a pointer to the #AtspiTable implementor on which to operate. + line="132">a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. + line="133">the specified table row, zero-indexed. the specified table column, zero-indexed. + line="134">the specified table column, zero-indexed. @@ -10338,12 +10757,12 @@ coordinate, use #atspi_component_get_accessible_at_point. throws="1"> Gets an accessible representation of the caption for an #AtspiTable. + line="44">Gets an accessible representation of the caption for an #AtspiTable. an #AtspiAccessible object that serves as + line="50">an #AtspiAccessible object that serves as the table's caption. @@ -10351,7 +10770,7 @@ the table's caption. a pointer to the #AtspiTable implementor on which to operate. + line="46">a pointer to the #AtspiTable implementor on which to operate. @@ -10361,7 +10780,7 @@ the table's caption. throws="1"> Gets the table column index occupied by the child at a particular 1-D + line="218">Gets the table column index occupied by the child at a particular 1-D child index. @see #atspi_table_get_index_at, #atspi_table_get_row_at_index @@ -10369,7 +10788,7 @@ child index. a #gint indicating the first column spanned by the child of a + line="228">a #gint indicating the first column spanned by the child of a table, at the specified 1-D (zero-offset) @index. @@ -10377,13 +10796,13 @@ child index. a pointer to the #AtspiTable implementor on which to operate. + line="220">a pointer to the #AtspiTable implementor on which to operate. the specified child index, zero-indexed. + line="221">the specified child index, zero-indexed. @@ -10393,26 +10812,26 @@ child index. throws="1"> Gets a text description of a particular table column. This differs from + line="271">Gets a text description of a particular table column. This differs from #atspi_table_get_column_header, which returns an #Accessible. a UTF-8 string describing the specified table column, if available. + line="279">a UTF-8 string describing the specified table column, if available. a pointer to the #AtspiTable implementor on which to operate. + line="273">a pointer to the #AtspiTable implementor on which to operate. the specified table column, zero-indexed. + line="274">the specified table column, zero-indexed. @@ -10422,7 +10841,7 @@ child index. throws="1"> Gets the number of columns spanned by the table cell at the specific + line="326">Gets the number of columns spanned by the table cell at the specific row and column (some tables can have cells which span multiple rows and/or columns). The returned values are meaningful only if the Table has both @@ -10431,26 +10850,26 @@ STATE_VISIBLE and STATE_SHOWING. a #gint indicating the number of columns spanned by the specified cell. + line="338">a #gint indicating the number of columns spanned by the specified cell. a pointer to the #AtspiTable implementor on which to operate. + line="328">a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. + line="329">the specified table row, zero-indexed. the specified table column, zero-indexed. + line="330">the specified table column, zero-indexed. @@ -10460,14 +10879,14 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Gets the header associated with a table column, if available. + line="382">Gets the header associated with a table column, if available. This differs from #atspi_table_get_column_description, which returns a string. an #AtspiAccessible representation of the + line="391">an #AtspiAccessible representation of the specified table column, if available. @@ -10475,13 +10894,13 @@ returns a string. a pointer to the #AtspiTable implementor on which to operate. + line="384">a pointer to the #AtspiTable implementor on which to operate. the specified table column, zero-indexed. + line="385">the specified table column, zero-indexed. @@ -10491,7 +10910,7 @@ returns a string. throws="1"> Gets the 1-D child index corresponding to the specified 2-D row and + line="159">Gets the 1-D child index corresponding to the specified 2-D row and column indices. To get the accessible object at a particular (x, y) screen coordinate, use #atspi_component_get_accessible_at_point. @@ -10500,7 +10919,7 @@ coordinate, use #atspi_component_get_accessible_at_point. a #gint which serves as the index of a specified cell in the + line="171">a #gint which serves as the index of a specified cell in the table, in a form usable by #atspi_get_child_at_index. @@ -10508,19 +10927,19 @@ coordinate, use #atspi_component_get_accessible_at_point. a pointer to the #AtspiTable implementor on which to operate. + line="161">a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. + line="162">the specified table row, zero-indexed. the specified table column, zero-indexed. + line="163">the specified table column, zero-indexed. @@ -10530,21 +10949,21 @@ coordinate, use #atspi_component_get_accessible_at_point. throws="1"> Gets the number of columns in an #AtspiTable, + line="108">Gets the number of columns in an #AtspiTable, exclusive of any columns that are programmatically hidden, but inclusive of columns that may be outside of the current scrolling window or viewport. a #gint indicating the number of columns in the table. + line="116">a #gint indicating the number of columns in the table. a pointer to the #AtspiTable implementor on which to operate. + line="110">a pointer to the #AtspiTable implementor on which to operate. @@ -10554,21 +10973,21 @@ coordinate, use #atspi_component_get_accessible_at_point. throws="1"> Gets the number of rows in an #AtspiTable, + line="86">Gets the number of rows in an #AtspiTable, exclusive of any rows that are programmatically hidden, but inclusive of rows that may be outside of the current scrolling window or viewport. a #gint indicating the number of rows in the table. + line="94">a #gint indicating the number of rows in the table. a pointer to the #AtspiTable implementor on which to operate. + line="88">a pointer to the #AtspiTable implementor on which to operate. @@ -10578,20 +10997,20 @@ coordinate, use #atspi_component_get_accessible_at_point. throws="1"> Queries a table to find out how many columns are currently selected. + line="475">Queries a table to find out how many columns are currently selected. Not all tables support column selection. a #gint indicating the number of columns currently selected. + line="482">a #gint indicating the number of columns currently selected. a pointer to the #AtspiTable implementor on which to operate. + line="477">a pointer to the #AtspiTable implementor on which to operate. @@ -10601,20 +11020,20 @@ Not all tables support column selection. throws="1"> Query a table to find out how many rows are currently selected. + line="409">Query a table to find out how many rows are currently selected. Not all tables support row selection. a #gint indicating the number of rows currently selected. + line="416">a #gint indicating the number of rows currently selected. a pointer to the #AtspiTable implementor on which to operate. + line="411">a pointer to the #AtspiTable implementor on which to operate. @@ -10624,7 +11043,7 @@ Not all tables support row selection. throws="1"> Gets the table row index occupied by the child at a particular 1-D + line="190">Gets the table row index occupied by the child at a particular 1-D child index. @see #atspi_table_get_index_at, #atspi_table_get_column_at_index @@ -10632,7 +11051,7 @@ child index. a #gint indicating the first row spanned by the child of a + line="200">a #gint indicating the first row spanned by the child of a table, at the specified 1-D (zero-offset) @index. @@ -10640,13 +11059,13 @@ child index. a pointer to the #AtspiTable implementor on which to operate. + line="192">a pointer to the #AtspiTable implementor on which to operate. the specified child index, zero-indexed. + line="193">the specified child index, zero-indexed. @@ -10656,7 +11075,7 @@ child index. throws="1"> Given a child index, determines the row and column indices and + line="649">Given a child index, determines the row and column indices and extents, and whether the cell is currently selected. If the child at index is not a cell (for instance, if it is a summary, caption, etc.), #FALSE is returned. @@ -10681,7 +11100,7 @@ and is_selected will contain 2, 5, 1, 2, and #TRUE if the index is associated with a valid table + line="688">#TRUE if the index is associated with a valid table cell, #FALSE if the index does not correspond to a cell. If #FALSE is returned, the values of the out parameters are undefined. @@ -10691,13 +11110,13 @@ undefined. a pointer to the #AtspiTable implementor on which to operate. + line="651">a pointer to the #AtspiTable implementor on which to operate. the index of the #AtspiTable child whose row/column + line="652">the index of the #AtspiTable child whose row/column extents are requested. @@ -10707,7 +11126,7 @@ extents are requested. transfer-ownership="full"> back-filled with the first table row associated with + line="654">back-filled with the first table row associated with the cell with child index. @@ -10717,7 +11136,7 @@ the cell with child index. transfer-ownership="full"> back-filled with the first table column associated + line="656">back-filled with the first table column associated with the cell with child index. @@ -10727,7 +11146,7 @@ with the cell with child index. transfer-ownership="full"> back-filled with the number of table rows + line="658">back-filled with the number of table rows across which child i extends. @@ -10737,7 +11156,7 @@ across which child i extends. transfer-ownership="full"> back-filled with the number of table columns + line="660">back-filled with the number of table columns across which child i extends. @@ -10747,7 +11166,7 @@ across which child i extends. transfer-ownership="full"> a boolean which is back-filled with #TRUE + line="662">a boolean which is back-filled with #TRUE if the child at index i corresponds to a selected table cell, #FALSE otherwise. @@ -10759,26 +11178,26 @@ if the child at index i corresponds to a selected table cell, throws="1"> Gets a text description of a particular table row. This differs from + line="246">Gets a text description of a particular table row. This differs from #atspi_table_get_row_header, which returns an #AtspiAccessible. a UTF-8 string describing the specified table row, if available. + line="254">a UTF-8 string describing the specified table row, if available. a pointer to the #AtspiTable implementor on which to operate. + line="248">a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. + line="249">the specified table row, zero-indexed. @@ -10788,7 +11207,7 @@ if the child at index i corresponds to a selected table cell, throws="1"> Gets the number of rows spanned by the table cell at the specific row + line="296">Gets the number of rows spanned by the table cell at the specific row and column. (some tables can have cells which span multiple rows and/or columns). The returned values are meaningful only if the Table has both @@ -10797,26 +11216,26 @@ STATE_VISIBLE and STATE_SHOWING. a #gint indicating the number of rows spanned by the specified cell. + line="308">a #gint indicating the number of rows spanned by the specified cell. a pointer to the #AtspiTable implementor on which to operate. + line="298">a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. + line="299">the specified table row, zero-indexed. the specified table column, zero-indexed. + line="300">the specified table column, zero-indexed. @@ -10826,13 +11245,13 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Gets the header associated with a table row, if available. This differs from + line="356">Gets the header associated with a table row, if available. This differs from #atspi_table_get_row_description, which returns a string. an #AtspiAccessible representation of the specified + line="364">an #AtspiAccessible representation of the specified table row, if available. @@ -10840,13 +11259,13 @@ STATE_VISIBLE and STATE_SHOWING. a pointer to the #AtspiTable implementor on which to operate. + line="358">a pointer to the #AtspiTable implementor on which to operate. the specified table row, zero-indexed. + line="359">the specified table row, zero-indexed. @@ -10856,13 +11275,13 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Queries a table for a list of indices of columns which are currently + line="452">Queries a table for a list of indices of columns which are currently selected. an array of #gint values, + line="459">an array of #gint values, specifying which columns are currently selected. @@ -10872,7 +11291,7 @@ selected. a pointer to the #AtspiTable implementor on which to operate. + line="454">a pointer to the #AtspiTable implementor on which to operate. @@ -10882,12 +11301,12 @@ selected. throws="1"> Queries a table for a list of indices of rows which are currently selected. + line="430">Queries a table for a list of indices of rows which are currently selected. an array of #gint values, + line="436">an array of #gint values, specifying which rows are currently selected. @@ -10897,7 +11316,7 @@ selected. a pointer to the #AtspiTable implementor on which to operate. + line="432">a pointer to the #AtspiTable implementor on which to operate. @@ -10907,12 +11326,12 @@ selected. throws="1"> Gets an accessible object which summarizes the contents of an #AtspiTable. + line="65">Gets an accessible object which summarizes the contents of an #AtspiTable. an #AtspiAccessible object that serves as the + line="71">an #AtspiAccessible object that serves as the table's summary (often a reduced #AtspiTable). @@ -10920,7 +11339,7 @@ selected. a pointer to the #AtspiTable implementor on which to operate. + line="67">a pointer to the #AtspiTable implementor on which to operate. @@ -10930,26 +11349,26 @@ selected. throws="1"> Determines whether specified table column is selected. + line="521">Determines whether specified table column is selected. Not all tables support column selection. #TRUE if the specified column is currently selected, #FALSE if not. + line="529">#TRUE if the specified column is currently selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. + line="523">a pointer to the #AtspiTable implementor on which to operate. the zero-indexed column number of the column being queried. + line="524">the zero-indexed column number of the column being queried. @@ -10959,26 +11378,26 @@ Not all tables support column selection. throws="1"> Determines whether a table row is selected. Not all tables support + line="496">Determines whether a table row is selected. Not all tables support row selection. #TRUE if the specified row is currently selected, #FALSE if not. + line="504">#TRUE if the specified row is currently selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. + line="498">a pointer to the #AtspiTable implementor on which to operate. the zero-indexed row number of the row being queried. + line="499">the zero-indexed row number of the row being queried. @@ -10988,31 +11407,31 @@ row selection. throws="1"> Determines whether the cell at a specific row and column is selected. + line="725">Determines whether the cell at a specific row and column is selected. #TRUE if the specified cell is currently selected, #FALSE if not. + line="733">#TRUE if the specified cell is currently selected, #FALSE if not. a pointer to the #AtspiTable implementor on which to operate. + line="727">a pointer to the #AtspiTable implementor on which to operate. the zero-indexed row of the cell being queried. + line="728">the zero-indexed row of the cell being queried. the zero-indexed column of the cell being queried. + line="729">the zero-indexed column of the cell being queried. @@ -11022,14 +11441,14 @@ row selection. throws="1"> De-selects the specified column, removing it from the current column + line="622">De-selects the specified column, removing it from the current column selection. Not all tables support column selection. #TRUE if the specified column was successfully de-selected, + line="631">#TRUE if the specified column was successfully de-selected, #FALSE if not. @@ -11037,13 +11456,13 @@ Not all tables support column selection. a pointer to the #AtspiTable implementor on which to operate. + line="624">a pointer to the #AtspiTable implementor on which to operate. the zero-indexed column number of the column being de-selected. + line="625">the zero-indexed column number of the column being de-selected. @@ -11053,13 +11472,13 @@ Not all tables support column selection. throws="1"> De-selects the specified row, removing it from the current row selection. + line="596">De-selects the specified row, removing it from the current row selection. Not all tables support row selection. #TRUE if the specified row was successfully de-selected, + line="604">#TRUE if the specified row was successfully de-selected, #FALSE if not. @@ -11067,13 +11486,13 @@ Not all tables support row selection. a pointer to the #AtspiTable implementor on which to operate. + line="598">a pointer to the #AtspiTable implementor on which to operate. the zero-indexed number of the row being de-selected. + line="599">the zero-indexed number of the row being de-selected. @@ -11322,36 +11741,47 @@ or 0 if the cell does not implement this method. c:type="AtspiText" glib:type-name="AtspiText" glib:get-type="atspi_text_get_type"> + An interface implemented by objects which place textual +information onscreen. + +The text interface should be implemented by objects which place textual +information onscreen as character strings or glyphs. The text interface +allows access to textual content including display attributes and +semantic hints associated with runs of text, and to bounding +information for glyphs and substrings. It also allows portions of text to +be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT. Selects some text (adds a text selection) in an #AtspiText object. - + line="870">Selects some text (adds a text selection) in an #AtspiText object. + #TRUE if successful, #FALSE otherwise. + line="878">#TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. + line="872">a pointer to the #AtspiText object on which to operate. the starting offset of the desired new selection. + line="873">the starting offset of the desired new selection. the offset of the first character after the new selection. + line="874">the offset of the first character after the new selection. @@ -11361,13 +11791,13 @@ or 0 if the cell does not implement this method. throws="1"> Gets a set of attributes applied to a range of text from an #AtspiText object, optionally + line="235">Gets a set of attributes applied to a range of text from an #AtspiText object, optionally including its 'default' attributes. - + a #GHashTable with attributes + line="252">a #GHashTable with attributes defined at the indicated offset, optionally including the 'default' ones. @@ -11378,20 +11808,20 @@ including its 'default' attributes. a pointer to the #AtspiText object to query. + line="237">a pointer to the #AtspiText object to query. a #gint indicating the offset from which the attribute + line="238">a #gint indicating the offset from which the attribute search is based. a #bool that, when set as #FALSE, indicates the call + line="240">a #bool that, when set as #FALSE, indicates the call should only return those attributes which are explicitly set on the current attribute run, omitting any attributes which are inherited from the default values. @@ -11403,7 +11833,7 @@ default values. transfer-ownership="full"> a #gint pointer indicating the start of the desired text + line="244">a #gint pointer indicating the start of the desired text range. @@ -11413,7 +11843,7 @@ default values. transfer-ownership="full"> a #gint pointer indicating the first character past the desired + line="246">a #gint pointer indicating the first character past the desired range. @@ -11427,13 +11857,13 @@ default values. throws="1"> Gets the value of a named attribute at a given offset. + line="293">Gets the value of a named attribute at a given offset. Use atspi_text_get_text_attribute_value instead. - + the value of a given attribute at the given + line="301">the value of a given attribute at the given offset, or %NULL if not present. @@ -11441,20 +11871,20 @@ offset, or %NULL if not present. a pointer to the #AtspiText object to query. + line="295">a pointer to the #AtspiText object to query. The character offset at which to query the attribute. + line="296">The character offset at which to query the attribute. The attribute to query. - + line="297">The attribute to query. + @@ -11466,16 +11896,15 @@ offset, or %NULL if not present. throws="1"> Gets the attributes applied to a range of text from an #AtspiText + line="154">Gets the attributes applied to a range of text from an #AtspiText object. The text attributes correspond to CSS attributes -where possible. -<em>DEPRECATED</em> +where possible. Use atspi_text_get_text_attributes instead. - + a #GHashTable + line="168">a #GHashTable describing the attributes at the given character offset. @@ -11486,13 +11915,13 @@ describing the attributes at the given character offset. a pointer to the #AtspiText object to query. + line="156">a pointer to the #AtspiText object to query. a #gint indicating the offset from which the attribute + line="157">a #gint indicating the offset from which the attribute search is based. @@ -11502,7 +11931,7 @@ describing the attributes at the given character offset. transfer-ownership="full"> a #gint pointer indicating the start of the desired text + line="159">a #gint pointer indicating the start of the desired text range. @@ -11512,7 +11941,7 @@ describing the attributes at the given character offset. transfer-ownership="full"> a #gint pointer indicating the first character past the desired + line="161">a #gint pointer indicating the first character past the desired range. @@ -11523,13 +11952,13 @@ describing the attributes at the given character offset. throws="1"> Gets the ranges of text from an #AtspiText object which lie within the + line="775">Gets the ranges of text from an #AtspiText object which lie within the bounds defined by (@x, @y) and (@x+@width, @y+@height). - + a null-terminated list of + line="792">a null-terminated list of pointers to #AtspiTextRange structs detailing the bounded text. @@ -11539,51 +11968,51 @@ describing the attributes at the given character offset. a pointer to the #AtspiText object on which to operate. + line="777">a pointer to the #AtspiText object on which to operate. the 'starting' x coordinate of the bounding box. + line="778">the 'starting' x coordinate of the bounding box. the 'starting' y coordinate of the bounding box. + line="779">the 'starting' y coordinate of the bounding box. the x extent of the bounding box. + line="780">the x extent of the bounding box. the y extent of the bounding box. + line="781">the y extent of the bounding box. an #AccessibleCoordType indicating the coordinate system to use + line="782">an #AccessibleCoordType indicating the coordinate system to use for the returned values. an #AtspiTextClipType indicating how to treat characters that + line="784">an #AtspiTextClipType indicating how to treat characters that intersect the bounding box's x extents. an #AtspiTextClipType indicating how to treat characters that + line="786">an #AtspiTextClipType indicating how to treat characters that intersect the bounding box's y extents. @@ -11594,19 +12023,19 @@ describing the attributes at the given character offset. throws="1"> Gets the current offset of the text caret in an #AtspiText object. - + line="134">Gets the current offset of the text caret in an #AtspiText object. + a #gint indicating the current position of the text caret. + line="140">a #gint indicating the current position of the text caret. a pointer to the #AtspiText object to query. + line="136">a pointer to the #AtspiText object to query. @@ -11616,12 +12045,12 @@ describing the attributes at the given character offset. throws="1"> Gets the character at a given offset for an #AtspiText object. - + line="630">Gets the character at a given offset for an #AtspiText object. + a #guint representing the + line="638">a #guint representing the UCS-4 unicode code point of the given character, or 0xFFFFFFFF if the character in question cannot be represented in the UCS-4 encoding. @@ -11631,13 +12060,13 @@ describing the attributes at the given character offset. a pointer to the #AtspiText object on which to operate. + line="632">a pointer to the #AtspiText object on which to operate. a #gint indicating the text offset where the desired + line="633">a #gint indicating the text offset where the desired character is located. @@ -11648,12 +12077,12 @@ describing the attributes at the given character offset. throws="1"> Gets the character count of an #AccessibleText object. - + line="81">Gets the character count of an #AccessibleText object. + a #gint indicating the total number of + line="87">a #gint indicating the total number of characters in the #AccessibleText object. @@ -11661,7 +12090,7 @@ describing the attributes at the given character offset. a pointer to the #AtspiText object to query. + line="83">a pointer to the #AtspiText object to query. @@ -11671,35 +12100,35 @@ describing the attributes at the given character offset. throws="1"> Gets a bounding box containing the glyph representing + line="658">Gets a bounding box containing the glyph representing the character at a particular text offset. The returned values are meaningful only if the Text has both STATE_VISIBLE and STATE_SHOWING. - + An #AtspiRect specifying the position and size of the character. + line="671">An #AtspiRect specifying the position and size of the character. a pointer to the #AtspiText object on which to operate. + line="660">a pointer to the #AtspiText object on which to operate. a #gint indicating the offset of the text character for + line="661">a #gint indicating the offset of the text character for whom boundary information is requested. an #AccessibleCoordType indicating the coordinate system to use + line="663">an #AccessibleCoordType indicating the coordinate system to use for the returned values. @@ -11710,16 +12139,16 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Gets the default attributes applied to an #AtspiText + line="346">Gets the default attributes applied to an #AtspiText object. The text attributes correspond to CSS attributes where possible. The combination of this attribute set and the attributes reported by #atspi_text_get_attributes describes the entire set of text attributes over a range. - + a #GHashTable + line="356">a #GHashTable containing the default attributes applied to a text object, (exclusive of explicitly-set attributes), encoded as UTF-8. @@ -11731,7 +12160,7 @@ describes the entire set of text attributes over a range. a pointer to the #AtspiText object to query. + line="348">a pointer to the #AtspiText object to query. @@ -11741,13 +12170,13 @@ describes the entire set of text attributes over a range. throws="1"> Gets the number of active non-contiguous selections for an + line="818">Gets the number of active non-contiguous selections for an #AtspiText object. - + a #gint indicating the current + line="825">a #gint indicating the current number of non-contiguous text selections active within an #AtspiText object. @@ -11756,7 +12185,7 @@ describes the entire set of text attributes over a range. a pointer to the #AtspiText object on which to operate. + line="820">a pointer to the #AtspiText object on which to operate. @@ -11766,12 +12195,12 @@ describes the entire set of text attributes over a range. throws="1"> Gets the character offset into the text at a given point. - + line="699">Gets the character offset into the text at a given point. + the offset (as a #gint) at the point (@x, @y) + line="709">the offset (as a #gint) at the point (@x, @y) in the specified coordinate system. @@ -11779,25 +12208,25 @@ describes the entire set of text attributes over a range. a pointer to the #AtspiText object on which to operate. + line="701">a pointer to the #AtspiText object on which to operate. the x coordinate of the point to be queried. + line="702">the x coordinate of the point to be queried. the y coordinate of the point to be queried. + line="703">the y coordinate of the point to be queried. an #AtspiCoordType indicating the coordinate system in which + line="704">an #AtspiCoordType indicating the coordinate system in which the values should be returned. @@ -11808,14 +12237,14 @@ describes the entire set of text attributes over a range. throws="1"> Gets the bounding box for text within a range in an #AtspiText object. + line="731">Gets the bounding box for text within a range in an #AtspiText object. The returned values are meaningful only if the Text has both STATE_VISIBLE and STATE_SHOWING. - + An #AtspiRect giving the position and size of the specified range + line="745">An #AtspiRect giving the position and size of the specified range of text. @@ -11823,27 +12252,27 @@ STATE_VISIBLE and STATE_SHOWING. a pointer to the #AtspiText object on which to operate. + line="733">a pointer to the #AtspiText object on which to operate. a #gint indicating the offset of the first text character for + line="734">a #gint indicating the offset of the first text character for whom boundary information is requested. a #gint indicating the offset of the text character + line="736">a #gint indicating the offset of the text character after the last character for whom boundary information is requested. an #AtspiCoordType indicating the coordinate system to use + line="738">an #AtspiCoordType indicating the coordinate system to use for the returned values. @@ -11854,9 +12283,9 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Gets the bounds of the @selection_num-th active text selection for an + line="841">Gets the bounds of the @selection_num-th active text selection for an #AtspiText object. - + @@ -11864,13 +12293,13 @@ STATE_VISIBLE and STATE_SHOWING. a pointer to the #AtspiText object on which to operate. + line="843">a pointer to the #AtspiText object on which to operate. a #gint indicating which selection to query. + line="844">a #gint indicating which selection to query. @@ -11881,7 +12310,7 @@ STATE_VISIBLE and STATE_SHOWING. throws="1"> Gets a portion of the text exposed through an #AtspiText according to a given @offset + line="458">Gets a portion of the text exposed through an #AtspiText according to a given @offset and a specific @granularity, along with the start and end offsets defining the boundaries of such a portion of text. @@ -11911,11 +12340,11 @@ start after the offset. If @granularity is ATSPI_TEXT_GRANULARITY_PARAGRAPH the returned string is from the start of the paragraph at or before the offset to the start of the following paragraph after the offset. - + a newly allocated string containing the text at the @offset bounded + line="497">a newly allocated string containing the text at the @offset bounded by the specified @granularity. Use g_free() to free the returned string. Returns %NULL if the offset is invalid or no implementation is available. @@ -11924,19 +12353,19 @@ of the following paragraph after the offset. an #AtspiText + line="460">an #AtspiText position + line="461">position An #AtspiTextGranularity + line="462">An #AtspiTextGranularity @@ -11944,14 +12373,14 @@ of the following paragraph after the offset. Gets a range of text from an #AtspiText object. The number of bytes + line="102">Gets a range of text from an #AtspiText object. The number of bytes in the returned string may exceed either end_offset or start_offset, since UTF-8 is a variable-width encoding. - + a text string containing characters from @start_offset + line="112">a text string containing characters from @start_offset to @end_offset-1, inclusive, encoded as UTF-8. @@ -11959,19 +12388,19 @@ of the following paragraph after the offset. a pointer to the #AtspiText object to query. + line="104">a pointer to the #AtspiText object to query. a #gint indicating the start of the desired text range. + line="105">a #gint indicating the start of the desired text range. a #gint indicating the first character past the desired range. + line="106">a #gint indicating the first character past the desired range. @@ -11981,13 +12410,13 @@ of the following paragraph after the offset. throws="1"> Gets delimited text from an #AtspiText object which follows a given + line="587">Gets delimited text from an #AtspiText object which follows a given text offset. - + an #AtspiTextRange containing a UTF-8 string representing the + line="598">an #AtspiTextRange containing a UTF-8 string representing the delimited text, both of whose delimiting boundaries are after or inclusive of the current offset, or an empty string if no such text exists. @@ -11997,20 +12426,20 @@ of the following paragraph after the offset. a pointer to the #AtspiText object on which to operate. + line="589">a pointer to the #AtspiText object on which to operate. a #gint indicating the offset from which the delimiter + line="590">a #gint indicating the offset from which the delimiter search is based. an #AtspiTextBoundaryType indicating whether the desired + line="592">an #AtspiTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run. @@ -12023,14 +12452,14 @@ of the following paragraph after the offset. throws="1"> Gets delimited text from an #AtspiText object which includes a given + line="543">Gets delimited text from an #AtspiText object which includes a given text offset. Use atspi_text_get_string_at_offset. - + an #AtspiTextRange containing a UTF-8 string representing the + line="554">an #AtspiTextRange containing a UTF-8 string representing the delimited text, whose delimiting boundaries bracket the current offset, or an empty string if no such text exists. @@ -12039,20 +12468,20 @@ of the following paragraph after the offset. a pointer to the #AtspiText object on which to operate. + line="545">a pointer to the #AtspiText object on which to operate. a #gint indicating the offset from which the delimiter + line="546">a #gint indicating the offset from which the delimiter search is based. an #AtspiTextBoundaryType indicating whether the desired + line="548">an #AtspiTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run. @@ -12064,12 +12493,12 @@ of the following paragraph after the offset. throws="1"> Gets the value of a named attribute at a given offset. - + line="316">Gets the value of a named attribute at a given offset. + the value of a given attribute at the given offset, or %NULL if + line="324">the value of a given attribute at the given offset, or %NULL if not present. @@ -12077,20 +12506,20 @@ not present. a pointer to the #AtspiText object to query. + line="318">a pointer to the #AtspiText object to query. The character offset at which to query the attribute. + line="319">The character offset at which to query the attribute. The attribute to query. - + line="320">The attribute to query. + @@ -12100,15 +12529,14 @@ not present. throws="1"> Gets the attributes applied to a range of text from an #AtspiText + line="183">Gets the attributes applied to a range of text from an #AtspiText object. The text attributes correspond to CSS attributes -where possible. -<em>DEPRECATED</em> - +where possible. + a #GHashTable + line="197">a #GHashTable describing the attributes at the given character offset. @@ -12119,13 +12547,13 @@ describing the attributes at the given character offset. a pointer to the #AtspiText object to query. + line="185">a pointer to the #AtspiText object to query. a #gint indicating the offset from which the attribute + line="186">a #gint indicating the offset from which the attribute search is based. @@ -12135,7 +12563,7 @@ describing the attributes at the given character offset. transfer-ownership="full"> a #gint pointer indicating the start of the desired text + line="188">a #gint pointer indicating the start of the desired text range. @@ -12145,7 +12573,7 @@ describing the attributes at the given character offset. transfer-ownership="full"> a #gint pointer indicating the first character past the desired + line="190">a #gint pointer indicating the first character past the desired range. @@ -12156,13 +12584,13 @@ describing the attributes at the given character offset. throws="1"> Gets delimited text from an #AtspiText object which precedes a given + line="395">Gets delimited text from an #AtspiText object which precedes a given text offset. - + an #AtspiTextRange containing a UTF-8 string representing the + line="406">an #AtspiTextRange containing a UTF-8 string representing the delimited text, both of whose delimiting boundaries are before the current offset, or an empty string if no such text exists. @@ -12171,20 +12599,20 @@ describing the attributes at the given character offset. a pointer to the #AtspiText object on which to operate. + line="397">a pointer to the #AtspiText object on which to operate. a #gint indicating the offset from which the delimiter + line="398">a #gint indicating the offset from which the delimiter search is based. an #AtspiTextBoundaryType indicating whether the desired + line="400">an #AtspiTextBoundaryType indicating whether the desired text string is a word, sentence, line, or attribute run. @@ -12195,25 +12623,25 @@ describing the attributes at the given character offset. throws="1"> De-selects a text selection. - + line="894">De-selects a text selection. + #TRUE if successful, #FALSE otherwise. + line="901">#TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. + line="896">a pointer to the #AtspiText object on which to operate. a #gint indicating which text selection to remove. + line="897">a #gint indicating which text selection to remove. @@ -12223,38 +12651,38 @@ describing the attributes at the given character offset. throws="1"> Scrolls whatever container of the #AtspiText text range so it becomes + line="947">Scrolls whatever container of the #AtspiText text range so it becomes visible on the screen. - + #TRUE if successful, #FALSE otherwise. + line="958">#TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. + line="949">a pointer to the #AtspiText object on which to operate. a #gint indicating the start of the desired text range. + line="950">a #gint indicating the start of the desired text range. a #gint indicating the first character past the desired range. + line="951">a #gint indicating the first character past the desired range. a #AtspiScrollType indicating where the object should be placed on the + line="952">a #AtspiScrollType indicating where the object should be placed on the screen. @@ -12265,51 +12693,51 @@ visible on the screen. throws="1"> Scrolls whatever container of the #AtspiText text range so it becomes + line="978">Scrolls whatever container of the #AtspiText text range so it becomes visible on the screen at a given position. - + #TRUE if successful, #FALSE otherwise. + line="991">#TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. + line="980">a pointer to the #AtspiText object on which to operate. a #gint indicating the start of the desired text range. + line="981">a #gint indicating the start of the desired text range. a #gint indicating the first character past the desired range. + line="982">a #gint indicating the first character past the desired range. a #AtspiCoordType indicating whether the coordinates are relative to + line="983">a #AtspiCoordType indicating whether the coordinates are relative to the screen, to the window, or to the parent object. the x coordinate of the point to reach + line="985">the x coordinate of the point to reach the y coordinate of the point to reach + line="986">the y coordinate of the point to reach @@ -12319,25 +12747,25 @@ visible on the screen at a given position. throws="1"> Moves the text caret to a given position. - + line="371">Moves the text caret to a given position. + #TRUE if successful, #FALSE otherwise. + line="378">#TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. + line="373">a pointer to the #AtspiText object on which to operate. the offset to which the text caret is to be moved. + line="374">the offset to which the text caret is to be moved. @@ -12347,37 +12775,37 @@ visible on the screen at a given position. throws="1"> Changes the bounds of an existing #AtspiText text selection. - + line="918">Changes the bounds of an existing #AtspiText text selection. + #TRUE if successful, #FALSE otherwise. + line="928">#TRUE if successful, #FALSE otherwise. a pointer to the #AtspiText object on which to operate. + line="920">a pointer to the #AtspiText object on which to operate. a zero-offset index indicating which text selection to modify. + line="921">a zero-offset index indicating which text selection to modify. a #gint indicating the new starting offset for the selection. + line="922">a #gint indicating the new starting offset for the selection. a #gint indicating the desired new offset of the first character + line="923">a #gint indicating the desired new offset of the first character after the selection. @@ -12390,7 +12818,7 @@ visible on the screen at a given position. c:type="AtspiTextBoundaryType"> Specifies the boundary conditions determining a run of text as returned from + line="318">Specifies the boundary conditions determining a run of text as returned from #atspi_text_get_text_at_offset, #atspi_text_get_text_after_offset, and #atspi_text_get_text_before_offset. @@ -12403,7 +12831,7 @@ AtspiTextGranularity with #atspi_text_get_string_at_offset instead. glib:name="ATSPI_TEXT_BOUNDARY_CHAR"> An #AtspiText instance is bounded by this + line="320">An #AtspiText instance is bounded by this character only. Start and end offsets differ by one, by definition, for this value. @@ -12414,7 +12842,7 @@ for this value. glib:name="ATSPI_TEXT_BOUNDARY_WORD_START"> Boundary condition is start of a word; i.e. + line="323">Boundary condition is start of a word; i.e. range is from start of one word to the start of another word. glib:name="ATSPI_TEXT_BOUNDARY_WORD_END"> Boundary condition is the end of a word; i.e. + line="325">Boundary condition is the end of a word; i.e. range is from the end of one word to the end of another. Some locales may not distinguish between words and characters or glyphs. In particular, those locales which use wholly or partially ideographic character sets. @@ -12438,7 +12866,7 @@ substrings. glib:name="ATSPI_TEXT_BOUNDARY_SENTENCE_START"> Boundary condition is start of a + line="331">Boundary condition is start of a sentence, as determined by the application. Some locales or character sets may not include explicit sentence delimiters, so this boundary type can not always be honored. Some locales will return lines @@ -12451,7 +12879,7 @@ of text instead of grammatical sentences. glib:name="ATSPI_TEXT_BOUNDARY_SENTENCE_END"> Boundary condition is end of a sentence, + line="336">Boundary condition is end of a sentence, as determined by the application, including the sentence-delimiting character, for instance '.' Some locales or character sets may not include explicit sentence delimiters, so this boundary type can not @@ -12465,7 +12893,7 @@ grammatical sentences. glib:name="ATSPI_TEXT_BOUNDARY_LINE_START"> Boundary condition is the start of a line; + line="342">Boundary condition is the start of a line; i.e. range is from start of one line to the start of another. This generally means that an end-of-line character will appear at the end of the range. @@ -12477,7 +12905,7 @@ the range. glib:name="ATSPI_TEXT_BOUNDARY_LINE_END"> Boundary condition is the end of a line; i.e. + line="346">Boundary condition is the end of a line; i.e. range is from start of one line to the start of another. This generally means that an end-of-line character will be the first character of the range. @@ -12489,7 +12917,7 @@ range. c:type="AtspiTextClipType"> Enumeration used by interface #AtspiText to indicate + line="405">Enumeration used by interface #AtspiText to indicate how to treat characters intersecting bounding boxes. glib:name="ATSPI_TEXT_CLIP_NONE"> No characters/glyphs are omitted. + line="407">No characters/glyphs are omitted. glib:name="ATSPI_TEXT_CLIP_MIN"> Characters/glyphs clipped by the minimum coordinate + line="408">Characters/glyphs clipped by the minimum coordinate are omitted. glib:name="ATSPI_TEXT_CLIP_MAX"> Characters/glyphs which intersect the maximum + line="410">Characters/glyphs which intersect the maximum coordinate are omitted. glib:name="ATSPI_TEXT_CLIP_BOTH"> Only glyphs falling entirely within the region + line="412">Only glyphs falling entirely within the region bounded by min and max are retained. @@ -12537,7 +12965,7 @@ bounded by min and max are retained. c:type="AtspiTextGranularity"> Text granularity types used for specifying the granularity of the region of + line="369">Text granularity types used for specifying the granularity of the region of text we are interested in. glib:name="ATSPI_TEXT_GRANULARITY_CHAR"> Granularity is defined by the boundaries between characters + line="371">Granularity is defined by the boundaries between characters (including non-printing characters) glib:name="ATSPI_TEXT_GRANULARITY_WORD"> Granularity is defined by the boundaries of a word, + line="373">Granularity is defined by the boundaries of a word, starting at the beginning of the current word and finishing at the beginning of the following one, if present. @@ -12567,7 +12995,7 @@ the following one, if present. glib:name="ATSPI_TEXT_GRANULARITY_SENTENCE"> Granularity is defined by the boundaries of a sentence, + line="376">Granularity is defined by the boundaries of a sentence, starting at the beginning of the current sentence and finishing at the beginning of the following one, if present. @@ -12578,7 +13006,7 @@ the following one, if present. glib:name="ATSPI_TEXT_GRANULARITY_LINE"> Granularity is defined by the boundaries of a line, + line="379">Granularity is defined by the boundaries of a line, starting at the beginning of the current line and finishing at the beginning of the following one, if present. @@ -12589,7 +13017,7 @@ the following one, if present. glib:name="ATSPI_TEXT_GRANULARITY_PARAGRAPH"> Granularity is defined by the boundaries of a paragraph, + line="382">Granularity is defined by the boundaries of a paragraph, starting at the beginning of the current paragraph and finishing at the beginning of the following one, if present. @@ -12610,6 +13038,62 @@ the following one, if present. + + This structure represents a single text selection within a document. This +selection is defined by two points in the content, where each one is defined +by an AtkObject supporting the AtkText interface and a character offset +relative to it. + +The end object must appear after the start object in the accessibility tree, +i.e. the end object must be reachable from the start object by navigating +forward (next, first child etc). + +This struct also contains a @start_is_active boolean, to communicate if the +start of the selection is the active point or not. + +The active point corresponds to the user's focus or point of interest. The +user moves the active point to expand or collapse the range. The anchor +point is the other point of the range and typically remains constant. In +most cases, anchor is the start of the range and active is the end. However, +when selecting backwards (e.g. pressing shift+left arrow in a text field), +the start of the range is the active point, as the user moves this to +manipulate the selection. + + + the AtspiAccessible containing the start of the selection. + + + + the text offset of the beginning of the selection within + @start_object. + + + + the AtspiAccessible containing the end of the selection. + + + + the text offset of the end of the selection within @end_object. + + + + a gboolean indicating whether the start of the selection + is the active point. + + + @@ -12631,24 +13115,33 @@ the following one, if present. c:type="AtspiValue" glib:type-name="AtspiValue" glib:get-type="atspi_value_get_type"> + An interface supporting a one-dimensional scalar +to be modified, or which reflects its value. + +An interface supporting a one-dimensional scalar +to be modified, or which reflects its value. If +STATE_EDITABLE is not present, the value is +treated as "read only". Gets the current value for an #AtspiValue. + line="59">Gets the current value for an #AtspiValue. the current value for this object. + line="65">the current value for this object. a pointer to the #AtspiValue implementor on which to operate. + line="61">a pointer to the #AtspiValue implementor on which to operate. @@ -12658,19 +13151,19 @@ the following one, if present. throws="1"> Gets the maximum allowed value for an #AtspiValue. + line="79">Gets the maximum allowed value for an #AtspiValue. the maximum allowed value for this object. + line="85">the maximum allowed value for this object. a pointer to the #AtspiValue implementor on which to operate. + line="81">a pointer to the #AtspiValue implementor on which to operate. @@ -12680,12 +13173,12 @@ the following one, if present. throws="1"> Gets the minimum increment by which an #AtspiValue can be adjusted. + line="145">Gets the minimum increment by which an #AtspiValue can be adjusted. the minimum increment by which the value may be changed, or + line="151">the minimum increment by which the value may be changed, or zero if the minimum increment cannot be determined. @@ -12693,7 +13186,7 @@ zero if the minimum increment cannot be determined. a pointer to the #AtspiValue implementor on which to operate. + line="147">a pointer to the #AtspiValue implementor on which to operate. @@ -12703,19 +13196,19 @@ zero if the minimum increment cannot be determined. throws="1"> Gets the minimum allowed value for an #AtspiValue. + line="39">Gets the minimum allowed value for an #AtspiValue. the minimum allowed value for this object. + line="45">the minimum allowed value for this object. a pointer to the #AtspiValue implementor on which to operate. + line="41">a pointer to the #AtspiValue implementor on which to operate. @@ -12726,7 +13219,7 @@ zero if the minimum increment cannot be determined. throws="1"> Gets the human readable text alternative associated with the value. + line="167">Gets the human readable text alternative associated with the value. @text is a newly created string, that must be freed by the caller. Can be NULL if no descriptor is available. @@ -12737,7 +13230,7 @@ caller. Can be NULL if no descriptor is available. a pointer to the #AtspiValue implementor on which to operate. + line="169">a pointer to the #AtspiValue implementor on which to operate. @@ -12747,12 +13240,12 @@ caller. Can be NULL if no descriptor is available. throws="1"> Sets the current value of an #AtspiValue. + line="99">Sets the current value of an #AtspiValue. #TRUE if the value could be assigned the specified value, + line="106">#TRUE if the value could be assigned the specified value, #FALSE otherwise. @@ -12760,13 +13253,13 @@ caller. Can be NULL if no descriptor is available. a pointer to the #AtspiValue implementor on which to operate. + line="101">a pointer to the #AtspiValue implementor on which to operate. a #gdouble value which is the desired new value of the object. + line="102">a #gdouble value which is the desired new value of the object. @@ -12777,7 +13270,7 @@ caller. Can be NULL if no descriptor is available. introspectable="0"> Sets the watch and timeout functions of a #DBusConnection + line="513">Sets the watch and timeout functions of a #DBusConnection to integrate the connection with the GLib main loop. Pass in #NULL for the #GMainContext unless you're doing something specialized. @@ -12786,7 +13279,7 @@ If called twice for the same context, does nothing the second time. If called once with context A and once with context B, context B replaces context A as the context monitoring the connection. - + @@ -12794,13 +13287,13 @@ connection. the connection + line="515">the connection the #GMainContext or #NULL for default context + line="516">the #GMainContext or #NULL for default context @@ -12810,7 +13303,7 @@ connection. introspectable="0"> Sets the watch and timeout functions of a #DBusServer + line="591">Sets the watch and timeout functions of a #DBusServer to integrate the server with the GLib main loop. In most cases the context argument should be #NULL. @@ -12818,7 +13311,7 @@ If called twice for the same context, does nothing the second time. If called once with context A and once with context B, context B replaces context A as the context monitoring the connection. - + @@ -12826,13 +13319,13 @@ connection. the server + line="593">the server the #GMainContext or #NULL for default + line="594">the #GMainContext or #NULL for default @@ -12842,20 +13335,20 @@ connection. throws="1"> Removes a device event listener from the registry's listener queue, + line="370">Removes a device event listener from the registry's listener queue, ceasing notification of events of the specified type. - + %TRUE if successful, otherwise %FALSE. + line="380">%TRUE if successful, otherwise %FALSE. a pointer to the #AtspiDeviceListener for which + line="372">a pointer to the #AtspiDeviceListener for which device events are requested. @@ -12865,7 +13358,7 @@ connection. allow-none="1"> Unused parameter. + line="374">Unused parameter. @@ -12875,20 +13368,20 @@ connection. throws="1"> Removes a keystroke event listener from the registry's listener queue, + line="257">Removes a keystroke event listener from the registry's listener queue, ceasing notification of events with modifiers matching @modmask. - + %TRUE if successful, otherwise %FALSE. + line="275">%TRUE if successful, otherwise %FALSE. a pointer to the #AtspiDeviceListener for which + line="259">a pointer to the #AtspiDeviceListener for which keystroke events are requested. @@ -12898,7 +13391,7 @@ connection. allow-none="1"> a pointer to the + line="261">a pointer to the #AtspiKeyDefinition array indicating which keystroke events are requested, or %NULL to indicate that all keycodes and keyvals for the specified @@ -12910,14 +13403,14 @@ connection. the key modifier mask for which this listener is to be + line="266">the key modifier mask for which this listener is to be 'deregistered' (of type #AtspiKeyMaskType). an #AtspiKeyMaskType mask indicating which + line="268">an #AtspiKeyMaskType mask indicating which types of key events were requested (%ATSPI_KEY_PRESSED, etc.). @@ -12928,7 +13421,7 @@ connection. moved-to="Event.main"> Starts/enters the main event loop for the AT-SPI services. + line="1111">Starts/enters the main event loop for the AT-SPI services. NOTE: This method does not return control; it is exited via a call to #atspi_event_quit from within an event handler. @@ -12942,7 +13435,7 @@ NOTE: This method does not return control; it is exited via a call to moved-to="Event.quit"> Quits the last main event loop for the AT-SPI services, + line="1129">Quits the last main event loop for the AT-SPI services, See: #atspi_event_main @@ -12952,13 +13445,13 @@ See: #atspi_event_main Disconnects from #AtspiRegistry instances and releases + line="1141">Disconnects from #AtspiRegistry instances and releases any floating resources. Call only once at exit. 0 if there were no leaks, otherwise other integer values. + line="1147">0 if there were no leaks, otherwise other integer values. @@ -12967,20 +13460,20 @@ any floating resources. Call only once at exit. throws="1"> Synthesizes a keyboard event (as if a hardware keyboard event occurred in the + line="391">Synthesizes a keyboard event (as if a hardware keyboard event occurred in the current UI context). - + %TRUE if successful, otherwise %FALSE. + line="412">%TRUE if successful, otherwise %FALSE. a #gint indicating the keycode or keysym or modifier mask of the + line="393">a #gint indicating the keycode or keysym or modifier mask of the key event being synthesized. @@ -12990,7 +13483,7 @@ current UI context). allow-none="1"> an (optional) UTF-8 string which, if + line="395">an (optional) UTF-8 string which, if @synth_type is %ATSPI_KEY_STRING, indicates a 'composed' keyboard input string being synthesized; this type of keyboard event synthesis does not emulate hardware @@ -13001,7 +13494,7 @@ current UI context). an #AtspiKeySynthType flag indicating whether @keyval + line="401">an #AtspiKeySynthType flag indicating whether @keyval is to be interpreted as a keysym rather than a keycode (%ATSPI_KEY_SYM) or a string (%ATSPI_KEY_STRING) or a modifier mask (%ATSPI_KEY_LOCKMODIFIERS and %ATSPI_KEY_UNLOCKMODIFIERS), or @@ -13016,39 +13509,93 @@ current UI context). throws="1"> Synthesizes a mouse event at a specific screen coordinate. + line="437">Synthesizes a mouse event at a specific screen coordinate. Most AT clients should use the #AccessibleAction interface when tempted to generate mouse events, rather than this method. Event names: b1p = button 1 press; b2r = button 2 release; b3c = button 3 click; b2d = button 2 double-click; abs = absolute motion; rel = relative motion. - + %TRUE if successful, otherwise %FALSE. + line="452">%TRUE if successful, otherwise %FALSE. a #glong indicating the screen x coordinate of the mouse event. + line="439">a #glong indicating the screen x coordinate of the mouse event. + + + + a #glong indicating the screen y coordinate of the mouse event. + + + + a string indicating which mouse event to be synthesized + (e.g. "b1p", "b1c", "b2r", "rel", "abs"). + + + + + + Like atspi_generate_mouse_event, but asynchronous. + + + + + + + a #glong indicating the screen x coordinate of the mouse event. a #glong indicating the screen y coordinate of the mouse event. + line="488">a #glong indicating the screen y coordinate of the mouse event. a string indicating which mouse event to be synthesized + line="489">a string indicating which mouse event to be synthesized (e.g. "b1p", "b1c", "b2r", "rel", "abs"). + + a callback to be called when a +reply is received. May be NULL. + + + + data to be passed to @callback. + + Gets the virtual desktop indicated by index @i. + line="73">Gets the virtual desktop indicated by index @i. NOTE: currently multiple virtual desktops are not implemented; as a consequence, any @i value different from 0 will not return a virtual desktop - instead it will return NULL. - + a pointer to the @i-th virtual desktop's + line="82">a pointer to the @i-th virtual desktop's #AtspiAccessible representation. @@ -13078,7 +13625,7 @@ virtual desktop - instead it will return NULL. a #gint indicating which of the accessible desktops is to be returned. + line="75">a #gint indicating which of the accessible desktops is to be returned. @@ -13086,21 +13633,21 @@ virtual desktop - instead it will return NULL. Gets the number of virtual desktops. + line="58">Gets the number of virtual desktops. NOTE: multiple virtual desktops are not implemented yet; as a consequence, this function always returns 1. - + a #gint indicating the number of active virtual desktops. + line="65">a #gint indicating the number of active virtual desktops. Gets the list of virtual desktops. On return, @list will point + line="93">Gets the list of virtual desktops. On return, @list will point to a newly-created, NULL terminated array of virtual desktop pointers. It is the responsibility of the caller to free this array when @@ -13108,38 +13655,78 @@ consequence, this function always returns 1. NOTE: currently multiple virtual desktops are not implemented; this implementation always returns a #Garray with a single #AtspiAccessible desktop. - + a #GArray of + line="105">a #GArray of desktops. + + Returns the version of the AT-SPI library being used at runtime. + + + + + + + the major version. + + + + the minor version. + + + + the micro/patch version. + + + + Connects to the accessibility registry and initializes the SPI. + line="1041">Connects to the accessibility registry and initializes the SPI. 0 on success, 1 if already initialized, or an integer error code. + line="1046">0 on success, 1 if already initialized, or an integer error code. Indicates whether AT-SPI has been initialized. + line="1098">Indicates whether AT-SPI has been initialized. %True if initialized; %False otherwise. + line="1103">%True if initialized; %False otherwise. @@ -13148,36 +13735,25 @@ desktops. throws="1"> Registers a listener for device events, for instance button events. - + line="353">This function does nothing and should not be called. + %TRUE if successful, otherwise %FALSE. + line="358">Always returns %FALSE. - a pointer to the #AtspiDeviceListener which requests - the events. - an #AtspiDeviceEventMask mask indicating which - types of key events are requested (%ATSPI_KEY_PRESSED, etc.). - Unused parameter. @@ -13187,25 +13763,25 @@ desktops. throws="1"> Registers a listener for keystroke events, either pre-emptively for + line="176">Registers a listener for keystroke events, either pre-emptively for all windows (%ATSPI_KEYLISTENER_ALL_WINDOWS), non-preemptively (%ATSPI_KEYLISTENER_NOSYNC), or pre-emptively at the toolkit level (%ATSPI_KEYLISTENER_CANCONSUME). If ALL_WINDOWS or CANCONSUME are used, the event is consumed upon receipt if one of @listener's callbacks returns %TRUE (other sync_type values may be available in the future). - + %TRUE if successful, otherwise %FALSE. + line="206">%TRUE if successful, otherwise %FALSE. a pointer to the #AtspiDeviceListener for which + line="178">a pointer to the #AtspiDeviceListener for which keystroke events are requested. @@ -13215,7 +13791,7 @@ desktops. allow-none="1"> a pointer to the + line="180">a pointer to the #AtspiKeyDefinition array indicating which keystroke events are requested, or NULL to indicate that all keycodes and keyvals for the specified @@ -13227,7 +13803,7 @@ desktops. an #AtspiKeyMaskType mask indicating which + line="185">an #AtspiKeyMaskType mask indicating which key event modifiers must be set in combination with @keys, events will only be reported for key events for which all modifiers in @modmask are set. If you wish to listen for @@ -13239,38 +13815,59 @@ desktops. an #AtspiKeyMaskType mask indicating which + line="192">an #AtspiKeyMaskType mask indicating which types of key events are requested (%ATSPI_KEY_PRESSED etc.). an #AtspiKeyListenerSyncType parameter indicating + line="194">an #AtspiKeyListenerSyncType parameter indicating the behavior of the notification/listener transaction. + + Gets the localized description string describing the #AtspiRole @role. + + + the localized string describing the AtspiRole + + + + + an #AtspiRole object to query. + + + + Gets a localizable string that indicates the name of an #AtspiRole. -<em>DEPRECATED.</em> + line="1994">Gets a localizable string that indicates the name of an #AtspiRole. a localizable string name for an #AtspiRole enumerated type. + line="2000">a localizable string name for an #AtspiRole enumerated type. an #AtspiRole object to query. + line="1996">an #AtspiRole object to query. @@ -13278,7 +13875,7 @@ desktops. Sets the main loop context that AT-SPI should assume is in use when + line="1925">Sets the main loop context that AT-SPI should assume is in use when setting an idle callback. This function should be called by application-side implementors (ie, at-spi2-atk) when it is desirable to re-enter the main loop. @@ -13290,7 +13887,7 @@ at-spi2-atk) when it is desirable to re-enter the main loop. The #GMainContext to use. + line="1927">The #GMainContext to use. @@ -13299,13 +13896,8 @@ at-spi2-atk) when it is desirable to re-enter the main loop. c:identifier="atspi_set_reference_window"> Sets the reference window that will be used when atspi_generate_mouse_event -is called. Coordinates will be assumed to be relative to this window. This -is needed because, due to Wayland's security model, it is not currently -possible to retrieve global coordinates. -If NULL is passed, then AT-SPI will use the window that has focus at the -time that atspi_generate_mouse_event is called. - + line="531">Deprecated. This function no longer does anything and should not be used. + @@ -13313,7 +13905,7 @@ time that atspi_generate_mouse_event is called. the #AtspiAccessible corresponding to the window to select. + line="533">the #AtspiAccessible corresponding to the window to select. should be a top-level window with a role of ATSPI_ROLE_APPLICATION. @@ -13323,8 +13915,8 @@ time that atspi_generate_mouse_event is called. Set the timeout used for method calls. If this is not set explicitly, -a default of 0.8 ms is used. + line="1895">Set the timeout used for method calls. If this is not set explicitly, +a default of 800 ms is used. Note that at-spi2-registryd currently uses a timeout of 3 seconds when sending a keyboard event notification. This means that, if an AT makes a call in response to the keyboard notification and the application @@ -13344,13 +13936,13 @@ timeout is set to 15 seconds. The timeout value, in milliseconds, or -1 to disable the timeout. + line="1897">The timeout value, in milliseconds, or -1 to disable the timeout. The amount of time, in milliseconds, to allow to pass + line="1898">The amount of time, in milliseconds, to allow to pass before enforcing timeouts on an application. Can be used to prevent timeout exceptions if an application is likely to block for an extended period of time on initialization. -1 can be passed to disable this diff --git a/girs/AyatanaAppIndicator-0.1.gir b/girs/AyatanaAppIndicator-0.1.gir index 372b6952a..0cdcea9d9 100644 --- a/girs/AyatanaAppIndicator-0.1.gir +++ b/girs/AyatanaAppIndicator-0.1.gir @@ -245,6 +245,9 @@ with @icon_theme_path. + Slot for #AppIndicator::connection-changed. @@ -266,6 +269,10 @@ with @icon_theme_path. + Function that gets called to make a #GtkStatusIcon when + there is no Application Indicator area available. @@ -277,6 +284,9 @@ with @icon_theme_path. + Slot for #AppIndicator::new-attention-icon. @@ -295,6 +305,9 @@ with @icon_theme_path. + Slot for #AppIndicator::new-icon. @@ -313,6 +326,9 @@ with @icon_theme_path. + Slot for #AppIndicator::new-icon-theme-path @@ -334,6 +350,9 @@ with @icon_theme_path. + Slot for #AppIndicator::new-label. @@ -358,6 +377,9 @@ with @icon_theme_path. + Slot for #AppIndicator::new-status. @@ -379,6 +401,9 @@ with @icon_theme_path. + Slot for #AppIndicator::scroll-event @@ -403,6 +428,10 @@ with @icon_theme_path. + The function that gets called if an Application + Indicator area appears after the fallback has been created. @@ -1450,6 +1479,9 @@ class object. + Slot for #AppIndicator::new-icon. @@ -1470,6 +1502,9 @@ class object. + Slot for #AppIndicator::new-attention-icon. @@ -1490,6 +1525,9 @@ class object. + Slot for #AppIndicator::new-status. @@ -1513,6 +1551,9 @@ class object. + Slot for #AppIndicator::new-icon-theme-path @@ -1536,6 +1577,9 @@ class object. + Slot for #AppIndicator::new-label. @@ -1562,6 +1606,9 @@ class object. + Slot for #AppIndicator::connection-changed. @@ -1585,6 +1632,9 @@ class object. + Slot for #AppIndicator::scroll-event @@ -1611,6 +1661,9 @@ class object. + Reserved for future use. @@ -1619,6 +1672,10 @@ class object. + Function that gets called to make a #GtkStatusIcon when + there is no Application Indicator area available. @@ -1632,6 +1689,10 @@ class object. + The function that gets called if an Application + Indicator area appears after the fallback has been created. @@ -1648,6 +1709,9 @@ class object. + Reserved for future use. @@ -1656,6 +1720,9 @@ class object. + Reserved for future use. @@ -1664,6 +1731,9 @@ class object. + Reserved for future use. @@ -1672,6 +1742,9 @@ class object. + Reserved for future use. @@ -1680,6 +1753,9 @@ class object. + Reserved for future use. @@ -1688,6 +1764,9 @@ class object. + Reserved for future use. diff --git a/girs/AyatanaIdo3-0.4.gir b/girs/AyatanaIdo3-0.4.gir index 4e3c2a666..fc004faf5 100644 --- a/girs/AyatanaIdo3-0.4.gir +++ b/girs/AyatanaIdo3-0.4.gir @@ -715,31 +715,31 @@ and/or use gtk-doc annotations. --> Creates a new #IdoScaleMenuItem with an empty label. + line="664">Creates a new #IdoScaleMenuItem with an empty label. a new #IdoScaleMenuItem. + line="672">a new #IdoScaleMenuItem. the text of the new menu item. + line="666">the text of the new menu item. The size style of the range. + line="667">The size style of the range. A #GtkAdjustment describing the slider value. + line="668">A #GtkAdjustment describing the slider value. @@ -748,13 +748,13 @@ and/or use gtk-doc annotations. --> c:identifier="ido_scale_menu_item_new_from_model"> Creates a new #IdoScaleMenuItem. If @menuitem contains an action, it + line="1059">Creates a new #IdoScaleMenuItem. If @menuitem contains an action, it will be bound to that action in @actions. a new #IdoScaleMenuItem + line="1065">a new #IdoScaleMenuItem @@ -796,7 +796,7 @@ will be bound to that action in @actions. Emits the "primary-clicked" signal. + line="947">Emits the "primary-clicked" signal. The default handler for this signal lowers the scale's adjustment to its lower bound. @@ -808,7 +808,7 @@ adjustment to its lower bound. the #IdoScaleMenuItem + line="949">the #IdoScaleMenuItem @@ -816,7 +816,7 @@ adjustment to its lower bound. Emits the "secondary-clicked" signal. + line="971">Emits the "secondary-clicked" signal. The default handler for this signal raises the scale's adjustment to its upper bound. @@ -828,7 +828,7 @@ adjustment to its upper bound. the #IdoScaleMenuItem + line="973">the #IdoScaleMenuItem @@ -837,21 +837,21 @@ adjustment to its upper bound. c:identifier="ido_scale_menu_item_get_primary_image"> Retrieves a pointer to the image widget used in the primary slot. + line="778">Retrieves a pointer to the image widget used in the primary slot. Whether this is visible depends upon the return value from ido_scale_menu_item_get_style(). A #GtkWidget pointer for the primary image. + line="786">A #GtkWidget pointer for the primary image. The #IdoScaleMenuItem + line="780">The #IdoScaleMenuItem @@ -860,21 +860,21 @@ ido_scale_menu_item_get_style(). c:identifier="ido_scale_menu_item_get_primary_label"> Retrieves a string of the text for the primary label widget. + line="853">Retrieves a string of the text for the primary label widget. Whether this is visible depends upon the return value from ido_scale_menu_item_get_style(). The label text. + line="861">The label text. The #IdoScaleMenuItem + line="855">The #IdoScaleMenuItem @@ -882,19 +882,19 @@ ido_scale_menu_item_get_style(). Retrieves the scale widget. + line="714">Retrieves the scale widget. The #IdoRange in this item + line="720">The #IdoRange in this item The #IdoScaleMenuItem + line="716">The #IdoScaleMenuItem @@ -903,21 +903,21 @@ ido_scale_menu_item_get_style(). c:identifier="ido_scale_menu_item_get_secondary_image"> Retrieves a pointer to the image widget used in the secondary slot. + line="800">Retrieves a pointer to the image widget used in the secondary slot. Whether this is visible depends upon the return value from ido_scale_menu_item_get_style(). A #GtkWidget pointer for the secondary image. + line="808">A #GtkWidget pointer for the secondary image. The #IdoScaleMenuItem + line="802">The #IdoScaleMenuItem @@ -926,21 +926,21 @@ ido_scale_menu_item_get_style(). c:identifier="ido_scale_menu_item_get_secondary_label"> Retrieves a string of the text for the secondary label widget. + line="875">Retrieves a string of the text for the secondary label widget. Whether this is visible depends upon the return value from ido_scale_menu_item_get_style(). The label text. + line="883">The label text. The #IdoScaleMenuItem + line="877">The #IdoScaleMenuItem @@ -948,20 +948,20 @@ ido_scale_menu_item_get_style(). Retrieves the type of widgets being used for the primary and + line="734">Retrieves the type of widgets being used for the primary and secondary widget slots. This could be images, labels, or nothing. A #IdoScaleMenuItemStyle enum describing the style. + line="741">A #IdoScaleMenuItemStyle enum describing the style. The #IdoScaleMenuItem + line="736">The #IdoScaleMenuItem @@ -970,7 +970,7 @@ secondary widget slots. This could be images, labels, or nothing. c:identifier="ido_scale_menu_item_primary_clicked"> Emits the "primary-clicked" signal. + line="947">Emits the "primary-clicked" signal. The default handler for this signal lowers the scale's adjustment to its lower bound. @@ -982,7 +982,7 @@ adjustment to its lower bound. the #IdoScaleMenuItem + line="949">the #IdoScaleMenuItem @@ -991,7 +991,7 @@ adjustment to its lower bound. c:identifier="ido_scale_menu_item_secondary_clicked"> Emits the "secondary-clicked" signal. + line="971">Emits the "secondary-clicked" signal. The default handler for this signal raises the scale's adjustment to its upper bound. @@ -1003,7 +1003,7 @@ adjustment to its upper bound. the #IdoScaleMenuItem + line="973">the #IdoScaleMenuItem @@ -1012,7 +1012,7 @@ adjustment to its upper bound. c:identifier="ido_scale_menu_item_set_primary_label"> Sets the text for the label widget in the primary slot. This + line="897">Sets the text for the label widget in the primary slot. This widget will only be visibile if the return value of ido_scale_menu_item_get_style() is set to %IDO_SCALE_MENU_ITEM_STYLE_LABEL. @@ -1023,13 +1023,13 @@ ido_scale_menu_item_get_style() is set to %IDO_SCALE_MENU_ITEM_STYLE_LABEL. The #IdoScaleMenuItem + line="899">The #IdoScaleMenuItem The label text + line="900">The label text @@ -1038,7 +1038,7 @@ ido_scale_menu_item_get_style() is set to %IDO_SCALE_MENU_ITEM_STYLE_LABEL. Sets the text for the label widget in the secondary slot. This + line="922">Sets the text for the label widget in the secondary slot. This widget will only be visibile if the return value of ido_scale_menu_item_get_style() is set to %IDO_SCALE_MENU_ITEM_STYLE_LABEL. @@ -1049,13 +1049,13 @@ ido_scale_menu_item_get_style() is set to %IDO_SCALE_MENU_ITEM_STYLE_LABEL. The #IdoScaleMenuItem + line="924">The #IdoScaleMenuItem The label text + line="925">The label text @@ -1063,7 +1063,7 @@ ido_scale_menu_item_get_style() is set to %IDO_SCALE_MENU_ITEM_STYLE_LABEL. Sets the type of widgets being used for the primary and + line="755">Sets the type of widgets being used for the primary and secondary widget slots. This could be images, labels, or nothing. @@ -1073,13 +1073,13 @@ secondary widget slots. This could be images, labels, or nothing. The #IdoScaleMenuItem + line="757">The #IdoScaleMenuItem Set the style use for the primary and secondary widget slots. + line="758">Set the style use for the primary and secondary widget slots. @@ -1117,7 +1117,7 @@ secondary widget slots. This could be images, labels, or nothing. no-hooks="1"> The ::primary-clicked signal is emitted when the pointer clicks the primary label. + line="280">The ::primary-clicked signal is emitted when the pointer clicks the primary label. @@ -1128,7 +1128,7 @@ secondary widget slots. This could be images, labels, or nothing. no-hooks="1"> The ::secondary-clicked signal is emitted when the pointer clicks the secondary label. + line="295">The ::secondary-clicked signal is emitted when the pointer clicks the secondary label. @@ -1136,7 +1136,7 @@ secondary widget slots. This could be images, labels, or nothing. The ::slider-grabbed signal is emitted when the pointer selects the slider. + line="252">The ::slider-grabbed signal is emitted when the pointer selects the slider. @@ -1144,7 +1144,7 @@ secondary widget slots. This could be images, labels, or nothing. The ::slider-released signal is emitted when the pointer releases the slider. + line="266">The ::slider-released signal is emitted when the pointer releases the slider. @@ -1152,7 +1152,7 @@ secondary widget slots. This could be images, labels, or nothing. Emitted whenever the value of the contained scale changes because + line="310">Emitted whenever the value of the contained scale changes because of user input. @@ -1161,7 +1161,7 @@ of user input. the new value + line="313">the new value @@ -1184,7 +1184,7 @@ of user input. the #IdoScaleMenuItem + line="949">the #IdoScaleMenuItem @@ -1200,7 +1200,7 @@ of user input. the #IdoScaleMenuItem + line="973">the #IdoScaleMenuItem diff --git a/girs/Babl-0.1.gir b/girs/Babl-0.1.gir index f8a872edb..e38773217 100644 --- a/girs/Babl-0.1.gir +++ b/girs/Babl-0.1.gir @@ -14,15 +14,15 @@ and/or use gtk-doc annotations. --> c:identifier-prefixes="Babl" c:symbol-prefixes="babl"> - + - + - + @@ -140,7 +140,7 @@ and/or use gtk-doc annotations. --> - + @@ -398,10 +398,10 @@ otherwise be a leak. introspectable="0"> get the dispatch function of a fish, this allows faster use of a fish + line="743">get the dispatch function of a fish, this allows faster use of a fish in a loop than the more indirect method of babl_process, this also avoids base-level instrumentation. - + @@ -649,11 +649,11 @@ the space of the format is used. Do a babl fish garbage collection cycle, should only be called + line="753">Do a babl fish garbage collection cycle, should only be called from the main thread with no concurrent babl processing in other threads in paralell. babl-0.1.98 - + @@ -1637,8 +1637,11 @@ coefficients. See #83. - + + 1 if @space is CMYK, 0 otherwise. @@ -1648,8 +1651,25 @@ coefficients. See #83. - + + 1 if @space is grayscale, 0 otherwise. + + + + + + + + + + + + 1 if @space is RGB, 0 otherwise. diff --git a/girs/Bamf-3.gir b/girs/Bamf-3.gir index 1104f8f87..a92319188 100644 --- a/girs/Bamf-3.gir +++ b/girs/Bamf-3.gir @@ -15,19 +15,49 @@ and/or use gtk-doc annotations. --> shared-library="libbamf3.so.2" c:identifier-prefixes="Bamf" c:symbol-prefixes="bamf"> + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="BamfApplication" glib:get-type="bamf_application_get_type" glib:type-struct="ApplicationClass"> + - Used to fetch the bus name and the object path of the remote application menu. - - %TRUE if found, %FALSE otherwise. + Used to fetch the bus name and the object path of the remote application menu. + + + %TRUE if found, %FALSE otherwise. - a #BamfApplication + a #BamfApplication - the bus name + the bus name - the object path + the object path + @@ -80,57 +123,81 @@ and/or use gtk-doc annotations. --> - Used to fetch the path to the .desktop file associated with the passed application. If + Used to fetch the path to the .desktop file associated with the passed application. If none exists, the result is NULL. + - A string representing the path to the desktop file. + A string representing the path to the desktop file. - a #BamfApplication + a #BamfApplication + - The focusable child for this application. + The focusable child for this application. - a #BamfApplication + a #BamfApplication - Used to discover whether the application wants menu stubs shown. - - Whether the stubs should be shown. + Used to discover whether the application wants menu stubs shown. + + + Whether the stubs should be shown. - a #BamfApplication + a #BamfApplication + - A string array containing the supported mime-types. + A string array containing the supported mime-types. - a #BamfApplication + a #BamfApplication @@ -138,48 +205,71 @@ none exists, the result is NULL. - Used to fetch the application contains a Window with given @xid. - - a #BamfWindow for the passed @xid or %NULL if not found. + Used to fetch the application contains a Window with given @xid. + + + a #BamfWindow for the passed @xid or %NULL if not found. - a #BamfApplication + a #BamfApplication - an X11 Window ID + an X11 Window ID - Used to fetch all #BamfWindow's associated with the passed #BamfApplication. + Used to fetch all #BamfWindow's associated with the passed #BamfApplication. + - A list of #BamfWindow's. + A list of #BamfWindow's. - a #BamfApplication + a #BamfApplication - Used to fetch all #BamfWindow's xids associated with the passed #BamfApplication. + Used to fetch all #BamfWindow's xids associated with the passed #BamfApplication. + - An array of xids. + An array of xids. - a #BamfApplication + a #BamfApplication @@ -224,11 +314,13 @@ none exists, the result is NULL. + + @@ -236,6 +328,7 @@ none exists, the result is NULL. + @@ -243,6 +336,7 @@ none exists, the result is NULL. + @@ -250,6 +344,7 @@ none exists, the result is NULL. + @@ -257,6 +352,7 @@ none exists, the result is NULL. + @@ -264,6 +360,7 @@ none exists, the result is NULL. + @@ -272,9 +369,39 @@ none exists, the result is NULL. + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + + + @@ -309,14 +436,19 @@ none exists, the result is NULL. glib:type-name="BamfControl" glib:get-type="bamf_control_get_type" glib:type-struct="ControlClass"> + + - The default #BamfControl reference. + The default #BamfControl reference. + @@ -331,6 +463,7 @@ none exists, the result is NULL. + @@ -345,6 +478,7 @@ none exists, the result is NULL. + @@ -362,6 +496,7 @@ none exists, the result is NULL. + @@ -384,11 +519,13 @@ none exists, the result is NULL. + + @@ -396,6 +533,7 @@ none exists, the result is NULL. + @@ -403,6 +541,7 @@ none exists, the result is NULL. + @@ -410,6 +549,7 @@ none exists, the result is NULL. + @@ -417,6 +557,7 @@ none exists, the result is NULL. + @@ -424,37 +565,182 @@ none exists, the result is NULL. + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="BamfMatcher" glib:get-type="bamf_matcher_get_type" glib:type-struct="MatcherClass"> + - Returns the default matcher. This matcher is owned by bamf and shared between other callers. + Returns the default matcher. This matcher is owned by bamf and shared between other callers. + - A new #BamfMatcher + A new #BamfMatcher + @@ -487,206 +780,300 @@ none exists, the result is NULL. - Used to fetch the active #BamfApplication. - - The active #BamfApplication. + Used to fetch the active #BamfApplication. + + + The active #BamfApplication. - a #BamfMatcher + a #BamfMatcher - Used to fetch the active #BamfWindow. - - The active #BamfWindow. + Used to fetch the active #BamfWindow. + + + The active #BamfWindow. - a #BamfMatcher + a #BamfMatcher + - A #BamfApplication for given desktop file. + A #BamfApplication for given desktop file. - a #BamfMatcher + a #BamfMatcher - Path to the desktop file + Path to the desktop file - Create a #BamfApplication if one isn't found + Create a #BamfApplication if one isn't found - Used to fetch the #BamfApplication containing the passed window. - - The #BamfApplication representing the xid passed, or NULL if none exists. + Used to fetch the #BamfApplication containing the passed window. + + + The #BamfApplication representing the xid passed, or NULL if none exists. - a #BamfMatcher + a #BamfMatcher - The window to look for + The window to look for - Used to fetch the #BamfApplication containing the passed xid. - - The #BamfApplication representing the xid passed, or NULL if none exists. + Used to fetch the #BamfApplication containing the passed xid. + + + The #BamfApplication representing the xid passed, or NULL if none exists. - a #BamfMatcher + a #BamfMatcher - The XID to search for + The XID to search for - Used to fetch all #BamfApplication's running or not. Application authors who wish to only + Used to fetch all #BamfApplication's running or not. Application authors who wish to only see running applications should use bamf_matcher_get_running_applications instead. The reason this method is needed is bamf will occasionally track applications which are not currently running for nefarious purposes. + - A list of #BamfApplication's. + A list of #BamfApplication's. - a #BamfMatcher + a #BamfMatcher - Used to fetch all #BamfApplication's which are running. + Used to fetch all #BamfApplication's which are running. + - A list of #BamfApplication's. + A list of #BamfApplication's. - a #BamfMatcher + a #BamfMatcher - Used to fetch all #BamfView's representing tabs. Currently unused. + Used to fetch all #BamfView's representing tabs. Currently unused. + - A list of #BamfTab's. + A list of #BamfTab's. - a #BamfMatcher + a #BamfMatcher - Used to fetch the #BamfWindow that wraps the given @window. - - The #BamfWindow representing the xid passed, or NULL if none exists. + Used to fetch the #BamfWindow that wraps the given @window. + + + The #BamfWindow representing the xid passed, or NULL if none exists. - a #BamfMatcher + a #BamfMatcher - The X11 Window ID to search for + The X11 Window ID to search for - Used to fetch all windows that BAMF knows about in the requested screen, + Used to fetch all windows that BAMF knows about in the requested screen, in stacking bottom-to-top order. If the @monitor is set to a negative value, then it fetches all the available windows in all monitors. + - A list of #BamfWindow's. + A list of #BamfWindow's. - a #BamfMatcher + a #BamfMatcher - the monitor you want the stack from, negative value to get all + the monitor you want the stack from, negative value to get all - Used to fetch all windows that BAMF knows about. + Used to fetch all windows that BAMF knows about. + - A list of #BamfWindow's. + A list of #BamfWindow's. - a #BamfMatcher + a #BamfMatcher - Used to fetch all xid's associated with an application. Useful for performing window + Used to fetch all xid's associated with an application. Useful for performing window + - A list of xids. + A list of xids. - a #BamfMatcher + a #BamfMatcher @@ -696,19 +1083,26 @@ then it fetches all the available windows in all monitors. - Used to effect how bamf performs matching. Desktop files passed to this method will + Used to effect how bamf performs matching. Desktop files passed to this method will be prefered by bamf to system desktop files. + - a #BamfMatcher + a #BamfMatcher - an array of strings, each containing an absolute path to a .desktop file - + an array of strings, each containing an absolute path to a .desktop file + @@ -775,11 +1169,13 @@ be prefered by bamf to system desktop files. + + @@ -787,6 +1183,7 @@ be prefered by bamf to system desktop files. + @@ -794,6 +1191,7 @@ be prefered by bamf to system desktop files. + @@ -801,6 +1199,7 @@ be prefered by bamf to system desktop files. + @@ -808,6 +1207,7 @@ be prefered by bamf to system desktop files. + @@ -815,14 +1215,53 @@ be prefered by bamf to system desktop files. + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="BamfTab" glib:get-type="bamf_tab_get_type" glib:type-struct="TabClass"> + - Returns the desktop file for the tab. - - The tab desktop id or %NULL if not set or available. Do not free the returned value, it belongs to @self. + Returns the desktop file for the tab. + + + The tab desktop id or %NULL if not set or available. Do not free the returned value, it belongs to @self. - A #BamfTab. + A #BamfTab. + - %TRUE if the tab is the active one on parent window XID, %FALSE otherwise. + %TRUE if the tab is the active one on parent window XID, %FALSE otherwise. - A #BamfTab. + A #BamfTab. + @@ -867,58 +1320,88 @@ be prefered by bamf to system desktop files. - The desktop file for the tab. - - The tab parent window XID id or 0 if not set or available. + The desktop file for the tab. + + + The tab parent window XID id or 0 if not set or available. - A #BamfTab. + A #BamfTab. - Closes the selected @self tab. - - %TRUE if success, %FALSE otherwise. + Closes the selected @self tab. + + + %TRUE if success, %FALSE otherwise. - A #BamfTab. + A #BamfTab. - Returns the desktop file for the tab. - - The tab desktop id or %NULL if not set or available. Do not free the returned value, it belongs to @self. + Returns the desktop file for the tab. + + + The tab desktop id or %NULL if not set or available. Do not free the returned value, it belongs to @self. - A #BamfTab. + A #BamfTab. + c:identifier="bamf_tab_get_is_foreground_tab" + glib:get-property="is-foreground-tab"> + - %TRUE if the tab is the active one on parent window XID, %FALSE otherwise. + %TRUE if the tab is the active one on parent window XID, %FALSE otherwise. - A #BamfTab. + A #BamfTab. - + + @@ -928,46 +1411,67 @@ be prefered by bamf to system desktop files. - - The desktop file for the tab. - - The tab parent window XID id or 0 if not set or available. + + The desktop file for the tab. + + + The tab parent window XID id or 0 if not set or available. - A #BamfTab. + A #BamfTab. - Selects the @self tab in the parent window. - - %TRUE if success, %FALSE otherwise. + Selects the @self tab in the parent window. + + + %TRUE if success, %FALSE otherwise. - A #BamfTab. + A #BamfTab. + - a #BamfTab + a #BamfTab - a callback function to call when the result is ready + a callback function to call when the result is ready @@ -975,21 +1479,34 @@ be prefered by bamf to system desktop files. transfer-ownership="none" nullable="1" allow-none="1"> - data to be sent to the callback. + data to be sent to the callback. - + - + - + - + @@ -1002,18 +1519,24 @@ be prefered by bamf to system desktop files. + + - The tab desktop id or %NULL if not set or available. Do not free the returned value, it belongs to @self. + The tab desktop id or %NULL if not set or available. Do not free the returned value, it belongs to @self. - A #BamfTab. + A #BamfTab. @@ -1021,6 +1544,7 @@ be prefered by bamf to system desktop files. + @@ -1033,13 +1557,18 @@ be prefered by bamf to system desktop files. + - The tab parent window XID id or 0 if not set or available. + The tab parent window XID id or 0 if not set or available. - A #BamfTab. + A #BamfTab. @@ -1047,13 +1576,18 @@ be prefered by bamf to system desktop files. + - %TRUE if the tab is the active one on parent window XID, %FALSE otherwise. + %TRUE if the tab is the active one on parent window XID, %FALSE otherwise. - A #BamfTab. + A #BamfTab. @@ -1061,6 +1595,7 @@ be prefered by bamf to system desktop files. + @@ -1068,6 +1603,7 @@ be prefered by bamf to system desktop files. + @@ -1075,6 +1611,7 @@ be prefered by bamf to system desktop files. + @@ -1082,6 +1619,7 @@ be prefered by bamf to system desktop files. + @@ -1090,6 +1628,7 @@ be prefered by bamf to system desktop files. + @@ -1100,66 +1639,107 @@ be prefered by bamf to system desktop files. - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="BamfView" glib:get-type="bamf_view_get_type" glib:type-struct="ViewClass"> + + @@ -1183,6 +1765,7 @@ be prefered by bamf to system desktop files. + @@ -1196,6 +1779,7 @@ be prefered by bamf to system desktop files. + @@ -1209,6 +1793,7 @@ be prefered by bamf to system desktop files. + @@ -1222,6 +1807,7 @@ be prefered by bamf to system desktop files. + @@ -1232,6 +1818,7 @@ be prefered by bamf to system desktop files. + @@ -1242,9 +1829,14 @@ be prefered by bamf to system desktop files. - Note: Makes sever dbus calls the first time this is called on a view. Dbus messaging is reduced afterwards. + Note: Makes sever dbus calls the first time this is called on a view. Dbus messaging is reduced afterwards. + - Returns a list of #BamfView which must be + Returns a list of #BamfView which must be freed after usage. Elements of the list are owned by bamf and should not be unreffed. @@ -1252,36 +1844,49 @@ be prefered by bamf to system desktop files. - a #BamfView + a #BamfView - Gets the icon of a view. This icon is used to visually represent the view. + Gets the icon of a view. This icon is used to visually represent the view. + - a #BamfView + a #BamfView - Gets the name of a view. This name is a short name best used to represent the view with text. + Gets the name of a view. This name is a short name best used to represent the view with text. + - a #BamfView + a #BamfView + @@ -1295,49 +1900,69 @@ be prefered by bamf to system desktop files. - Determines if the view is currently active and focused by the user. Useful for an active window indicator. + Determines if the view is currently active and focused by the user. Useful for an active window indicator. + - a #BamfView + a #BamfView - Determines if the view is currently running. Useful for a running window indicator. + Determines if the view is currently running. Useful for a running window indicator. + - a #BamfView + a #BamfView - Determines if the view is currently starting. Useful for the startup animation. + Determines if the view is currently starting. Useful for the startup animation. + - a #BamfView + a #BamfView - Determines if the view is currently requiring attention. Useful for a running window indicator. + Determines if the view is currently requiring attention. Useful for a running window indicator. + - a #BamfView + a #BamfView @@ -1345,19 +1970,25 @@ be prefered by bamf to system desktop files. + - a boolean useful for determining if a particular view is "user visible". User visible + a boolean useful for determining if a particular view is "user visible". User visible is a concept relating to whether or not a window should be shown in a launcher tasklist. - a #BamfView + a #BamfView + @@ -1374,6 +2005,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -1387,6 +2019,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -1400,6 +2033,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -1413,6 +2047,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -1426,6 +2061,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -1439,6 +2075,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -1452,22 +2089,32 @@ is a concept relating to whether or not a window should be shown in a launcher t - The view type of a window is a short string used to represent all views of the same class. These + The view type of a window is a short string used to represent all views of the same class. These descriptions should not be used to do casting as they are not considered stable. + - a #BamfView + a #BamfView - Note: Makes sever dbus calls the first time this is called on a view. Dbus messaging is reduced afterwards. + Note: Makes sever dbus calls the first time this is called on a view. Dbus messaging is reduced afterwards. + - Returns a list of #BamfView which must be + Returns a list of #BamfView which must be freed after usage. Elements of the list are owned by bamf and should not be unreffed. @@ -1475,13 +2122,16 @@ descriptions should not be used to do casting as they are not considered stable. - a #BamfView + a #BamfView + @@ -1492,50 +2142,70 @@ descriptions should not be used to do casting as they are not considered stable. - Gets the icon of a view. This icon is used to visually represent the view. + Gets the icon of a view. This icon is used to visually represent the view. + - a #BamfView + a #BamfView - Gets the name of a view. This name is a short name best used to represent the view with text. + Gets the name of a view. This name is a short name best used to represent the view with text. + - a #BamfView + a #BamfView - The view type of a window is a short string used to represent all views of the same class. These + The view type of a window is a short string used to represent all views of the same class. These descriptions should not be used to do casting as they are not considered stable. + - a #BamfView + a #BamfView + - %TRUE whether the #BamfView @view has the specified @child. + %TRUE whether the #BamfView @view has the specified @child. - a #BamfView + a #BamfView @@ -1544,54 +2214,75 @@ descriptions should not be used to do casting as they are not considered stable. - Determines if the view is currently active and focused by the user. Useful for an active window indicator. + Determines if the view is currently active and focused by the user. Useful for an active window indicator. + - a #BamfView + a #BamfView - Determines if the view is closed or not. + Determines if the view is closed or not. + - a #BamfView + a #BamfView - Determines if the view is currently running. Useful for a running window indicator. + Determines if the view is currently running. Useful for a running window indicator. + - a #BamfView + a #BamfView - Determines if the view is currently starting. Useful for the startup animation. + Determines if the view is currently starting. Useful for the startup animation. + - a #BamfView + a #BamfView + @@ -1602,13 +2293,18 @@ descriptions should not be used to do casting as they are not considered stable. - Determines if the view is currently requiring attention. Useful for a running window indicator. + Determines if the view is currently requiring attention. Useful for a running window indicator. + - a #BamfView + a #BamfView @@ -1616,14 +2312,19 @@ descriptions should not be used to do casting as they are not considered stable. + - a boolean useful for determining if a particular view is "user visible". User visible + a boolean useful for determining if a particular view is "user visible". User visible is a concept relating to whether or not a window should be shown in a launcher tasklist. - a #BamfView + a #BamfView @@ -1631,10 +2332,15 @@ is a concept relating to whether or not a window should be shown in a launcher t - Note: Makes sever dbus calls the first time this is called on a view. + Note: Makes sever dbus calls the first time this is called on a view. Dbus messaging is reduced afterwards. + - Returns a list of #BamfView which + Returns a list of #BamfView which is owned by the #BamfView and should not freed or modified after usage. @@ -1642,12 +2348,15 @@ Dbus messaging is reduced afterwards. - a #BamfView + a #BamfView + @@ -1662,37 +2371,48 @@ Dbus messaging is reduced afterwards. + - a boolean useful for determining if a particular view is "user visible". User visible + a boolean useful for determining if a particular view is "user visible". User visible is a concept relating to whether or not a window should be shown in a launcher tasklist. - a #BamfView + a #BamfView - + - + - + - + - + - + @@ -1813,14 +2533,18 @@ is a concept relating to whether or not a window should be shown in a launcher t + + - Returns a list of #BamfView which must be + Returns a list of #BamfView which must be freed after usage. Elements of the list are owned by bamf and should not be unreffed. @@ -1828,7 +2552,9 @@ is a concept relating to whether or not a window should be shown in a launcher t - a #BamfView + a #BamfView @@ -1836,12 +2562,15 @@ is a concept relating to whether or not a window should be shown in a launcher t + - a #BamfView + a #BamfView @@ -1849,12 +2578,15 @@ is a concept relating to whether or not a window should be shown in a launcher t + - a #BamfView + a #BamfView @@ -1862,12 +2594,15 @@ is a concept relating to whether or not a window should be shown in a launcher t + - a #BamfView + a #BamfView @@ -1875,14 +2610,19 @@ is a concept relating to whether or not a window should be shown in a launcher t + - a boolean useful for determining if a particular view is "user visible". User visible + a boolean useful for determining if a particular view is "user visible". User visible is a concept relating to whether or not a window should be shown in a launcher tasklist. - a #BamfView + a #BamfView @@ -1890,12 +2630,15 @@ is a concept relating to whether or not a window should be shown in a launcher t + - a #BamfView + a #BamfView @@ -1903,12 +2646,15 @@ is a concept relating to whether or not a window should be shown in a launcher t + - a #BamfView + a #BamfView @@ -1916,12 +2662,15 @@ is a concept relating to whether or not a window should be shown in a launcher t + - a #BamfView + a #BamfView @@ -1929,6 +2678,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -1944,6 +2694,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -1959,6 +2710,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -1971,6 +2723,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -1986,6 +2739,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -1998,6 +2752,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2013,6 +2768,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2028,6 +2784,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2043,6 +2800,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2058,6 +2816,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2073,6 +2832,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2091,6 +2851,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2106,6 +2867,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2121,12 +2883,15 @@ is a concept relating to whether or not a window should be shown in a launcher t + - a #BamfView + a #BamfView @@ -2134,6 +2899,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2149,22 +2915,56 @@ is a concept relating to whether or not a window should be shown in a launcher t + - + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2185,6 +2987,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2195,18 +2998,24 @@ is a concept relating to whether or not a window should be shown in a launcher t - - A transient for this #BamfWindow. + + + A transient for this #BamfWindow. - a #BamfWindow + a #BamfWindow + @@ -2220,6 +3029,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2230,6 +3040,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2240,6 +3051,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2250,6 +3062,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2261,6 +3074,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2277,6 +3091,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2293,6 +3108,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2303,6 +3119,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2313,18 +3130,24 @@ is a concept relating to whether or not a window should be shown in a launcher t - - A transient for this #BamfWindow. + + + A transient for this #BamfWindow. - a #BamfWindow + a #BamfWindow + @@ -2339,6 +3162,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2349,6 +3173,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2359,6 +3184,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2369,6 +3195,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2415,18 +3242,24 @@ is a concept relating to whether or not a window should be shown in a launcher t + - - A transient for this #BamfWindow. + + + A transient for this #BamfWindow. - a #BamfWindow + a #BamfWindow @@ -2434,6 +3267,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2446,6 +3280,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2458,6 +3293,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2470,6 +3306,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2482,6 +3319,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2497,6 +3335,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2510,6 +3349,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2522,6 +3362,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2540,6 +3381,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2558,6 +3400,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2565,6 +3408,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2572,6 +3416,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2579,6 +3424,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + @@ -2587,6 +3433,7 @@ is a concept relating to whether or not a window should be shown in a launcher t + - + + + @@ -2624,5 +3476,35 @@ is a concept relating to whether or not a window should be shown in a launcher t + + #BamfApplication is the base class that all applications need to derive from. + + + #BamfControl is the base class that all controls need to derive from. + + + #BamfFactory is the base class that all factorys need to derive from. + + + #BamfMatcher is the base class that all matchers need to derive from. + + + #BamfView is the base class that all views need to derive from. + + + #BamfWindow is the base class that all windows need to derive from. + diff --git a/girs/Budgie-1.0.gir b/girs/Budgie-1.0.gir index 0f439f9a1..e0fb1d84b 100644 --- a/girs/Budgie-1.0.gir +++ b/girs/Budgie-1.0.gir @@ -201,6 +201,9 @@ Likewise, a Vala implementation might look like the following: + Virtual panel_size_changed function @@ -638,6 +641,9 @@ the geometry. + Virtual invoke_action function @@ -657,6 +663,9 @@ the geometry. + Virtual supports_settings function @@ -673,6 +682,9 @@ the geometry. + Virtual get_settings_ui function @@ -689,6 +701,9 @@ the geometry. + Virtual panel_size_changed function @@ -727,6 +742,9 @@ the geometry. + Virtual update_popovers method @@ -1256,6 +1274,9 @@ to enable efficient screen management. + Virtual closed signal @@ -1349,6 +1370,9 @@ through a toggling action, such as being rolled past in a + Virtual closed signal diff --git a/girs/Camel-1.2.gir b/girs/Camel-1.2.gir index fa6afde03..bc3f402b0 100644 --- a/girs/Camel-1.2.gir +++ b/girs/Camel-1.2.gir @@ -6453,7 +6453,7 @@ age acts as a hard limit on cache entries. Timeout for access, or -1 to disable access expiry. - + @@ -6485,7 +6485,7 @@ age acts as a hard limit on cache entries. Timeout for age expiry, or -1 to disable. - + @@ -16495,14 +16495,14 @@ implement a search for any sort of backend. a new #time_t value - + Initial time - + time_t equivalent of the passed in argument, or (time_t) -1 on error. - + @@ -34953,7 +34953,7 @@ See camel_mime_message_set_date() for information about the @offset format.the date of the message - + @@ -34984,7 +34984,7 @@ See camel_mime_message_set_date() for information about the @offset format.the received date of the message - + @@ -35260,7 +35260,7 @@ camel_mime_message_set_date (message, CAMEL_MESSAGE_DATE_CURRENT, 0); a time_t date or %CAMEL_MESSAGE_DATE_CURRENT to use the current local date and time - + - + - + @@ -44803,7 +44803,7 @@ when the @result is %NULL. - + @@ -44816,13 +44816,13 @@ when the @result is %NULL. start time - + end time - + - + @@ -64309,7 +64309,7 @@ richtext version of @in. pointer to a variable to put the value in - + @@ -64369,7 +64369,7 @@ richtext version of @in. pointer to a variable to store the value in - + @@ -64560,7 +64560,7 @@ Unlike @camel_file_util_encode_string, it pads the value to output - + @@ -64620,7 +64620,7 @@ Unlike @camel_file_util_encode_string, it pads the value to output - + @@ -65167,7 +65167,7 @@ nothing when the @host is %NULL. line="4629">the time_t representation of the date string specified by @str or (time_t) 0 on error. If @tz_offset is non-NULL, the value of the timezone offset will be stored. - + @@ -65336,7 +65336,7 @@ string represented by @time and @tz_offset. time_t date representation - + the #time_t to convert - + the calendar time representation of @tm - + filename="src/camel/camel-utils.c" line="185">@src_time modified by the given parameters as date, with the time part being beginning of the day. - + a time_t to apply the value to, or -1 to use the current time - + - + - + @@ -275,10 +275,10 @@ - + - + @@ -294,10 +294,10 @@ - + - + @@ -313,10 +313,10 @@ - + - + @@ -332,10 +332,10 @@ - + - + @@ -410,9 +410,9 @@ - + - + @@ -425,9 +425,9 @@ - + - + @@ -440,9 +440,9 @@ - + - + @@ -455,9 +455,9 @@ - + - + @@ -470,9 +470,9 @@ - + - + @@ -485,9 +485,9 @@ - + - + @@ -500,9 +500,9 @@ - + - + @@ -518,11 +518,11 @@ - + - + - + @@ -530,7 +530,7 @@ - + @@ -546,16 +546,16 @@ - + - + - + - + @@ -567,16 +567,16 @@ - + - + - + - + @@ -926,9 +926,9 @@ - + - + @@ -950,9 +950,9 @@ - + - + @@ -974,9 +974,9 @@ - + - + @@ -989,9 +989,9 @@ - + - + @@ -1004,9 +1004,9 @@ - + - + @@ -1023,10 +1023,10 @@ - + - + @@ -1211,7 +1211,7 @@ - + @@ -1222,7 +1222,7 @@ - + @@ -1445,7 +1445,7 @@ - + @@ -1869,7 +1869,7 @@ - + @@ -1879,7 +1879,7 @@ - + @@ -1901,9 +1901,9 @@ - + - + @@ -1912,13 +1912,13 @@ - + - + - + @@ -2035,9 +2035,9 @@ - + - + @@ -2047,9 +2047,9 @@ - + - + @@ -2062,9 +2062,9 @@ - + - + @@ -2074,9 +2074,9 @@ - + - + @@ -2087,7 +2087,7 @@ - + @@ -2097,7 +2097,7 @@ - + @@ -2157,7 +2157,7 @@ - + @@ -2170,7 +2170,7 @@ - + @@ -2296,7 +2296,7 @@ - + @@ -2306,7 +2306,7 @@ - + @@ -2323,13 +2323,13 @@ - + - + - + @@ -2339,9 +2339,9 @@ - + - + @@ -2353,9 +2353,9 @@ - + - + @@ -2364,13 +2364,13 @@ - + - + - + @@ -2385,9 +2385,9 @@ - + - + @@ -2402,9 +2402,9 @@ - + - + @@ -2417,9 +2417,9 @@ - + - + @@ -2429,9 +2429,9 @@ - + - + @@ -2544,9 +2544,9 @@ - + - + @@ -2561,9 +2561,9 @@ - + - + diff --git a/girs/Cheese-3.0.gir b/girs/Cheese-3.0.gir index 0c9514427..dc2d11546 100644 --- a/girs/Cheese-3.0.gir +++ b/girs/Cheese-3.0.gir @@ -125,6 +125,9 @@ and/or use gtk-doc annotations. --> + invoked when a photo was saved to disk @@ -136,6 +139,9 @@ and/or use gtk-doc annotations. --> + invoked when a photo was taken @@ -150,6 +156,10 @@ and/or use gtk-doc annotations. --> + invoked when the state of the camera #GstElement +changed @@ -164,6 +174,9 @@ and/or use gtk-doc annotations. --> + invoked when a video was saved to disk @@ -767,6 +780,9 @@ NULL. + invoked when a photo was saved to disk @@ -780,6 +796,9 @@ NULL. + invoked when a photo was taken @@ -796,6 +815,9 @@ NULL. + invoked when a video was saved to disk @@ -809,6 +831,10 @@ NULL. + invoked when the state of the camera #GstElement +changed @@ -1121,7 +1147,8 @@ See cheese_camera_device_monitor_new_async() for the asynchronous version. + c:identifier="cheese_camera_device_monitor_new_async" + glib:finish-func="new_finish"> Creates a new #CheeseCameraDeviceMonitor object asynchronously. Callback @@ -1167,6 +1194,9 @@ See cheese_camera_device_monitor_new() for the synchronous version. + invoked when a new video capture device is connected @@ -1183,6 +1213,9 @@ See cheese_camera_device_monitor_new() for the synchronous version. + invoked when a video capture device is removed @@ -1273,6 +1306,9 @@ the system. + invoked when a new video capture device is connected @@ -1291,6 +1327,9 @@ the system. + invoked when a video capture device is removed diff --git a/girs/Clapper-0.0.gir b/girs/Clapper-0.0.gir new file mode 100644 index 000000000..729c5ad11 --- /dev/null +++ b/girs/Clapper-0.0.gir @@ -0,0 +1,6085 @@ + + + + + + + + + + + + + + + + + + + + + + + Represents an audio stream within media. + + + Get bitrate of audio @stream. + + + the bitrate of audio stream. + + + + + a #ClapperAudioStream + + + + + + Get number of audio channels in @stream. + + + the number of audio channels. + + + + + a #ClapperAudioStream + + + + + + Get codec used to encode @stream. + + + the audio codec of stream + or %NULL if undetermined. + + + + + a #ClapperAudioStream + + + + + + Get an ISO-639 language code of the @stream. + + + the language code of audio stream. + + + + + a #ClapperAudioStream + + + + + + Get language name of the @stream. + +This function will try to return a translated string into current +locale if possible, with a fallback to a name extracted from tags. + + + the language name of audio stream. + + + + + a #ClapperAudioStream + + + + + + Get sample format of audio @stream. + + + the sample format of stream + or %NULL if undetermined. + + + + + a #ClapperAudioStream + + + + + + Get sample rate of audio @stream (in Hz). + + + the sample rate of audio stream. + + + + + a #ClapperAudioStream + + + + + + Stream bitrate. + + + + Stream number of audio channels. + + + + Stream codec. + + + + Stream language code in ISO-639 format. + + + + Stream language name. + + + + Stream sample format. + + + + Stream sample rate (in Hz). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An optional Discoverer feature to be added to the player. + +#ClapperDiscoverer is a feature that wraps around #GstDiscoverer API +to automatically discover items within [class@Clapper.Queue]. Once media +is scanned, all extra information of it will be filled within media item, +this includes title, duration, chapters, etc. + +Please note that media items are also discovered during their playback +by the player itself. #ClapperDiscoverer is useful in situations where +one wants to present to the user an updated media item before its +playback, such as an UI that displays playback queue. + +Depending on your application, you can select an optimal +[enum@Clapper.DiscovererDiscoveryMode] that best suits your needs. + +Use [const@Clapper.HAVE_DISCOVERER] macro to check if Clapper API +was compiled with this feature. + + + Creates a new #ClapperDiscoverer instance. + + + a new #ClapperDiscoverer instance. + + + + + Get the [enum@Clapper.DiscovererDiscoveryMode] of @discoverer. + + + a currently set #ClapperDiscovererDiscoveryMode. + + + + + a #ClapperDiscoverer + + + + + + Set the [enum@Clapper.DiscovererDiscoveryMode] of @discoverer. + + + + + + + a #ClapperDiscoverer + + + + a #ClapperDiscovererDiscoveryMode + + + + + + Discoverer discovery mode. + + + + + + + + + + + + Run discovery for every single media item added to [class@Clapper.Queue]. + This mode is useful when application presents a list of items to select from to the user before playback. + It will scan every single item in queue, so user can have an updated list of items when selecting what to play. + + + Only run discovery on an item if it is not a currently selected item in [class@Clapper.Queue]. + This mode is optimal when application always plays (or at least goes into paused) after selecting item from queue. + It will skip discovery of such items since they will be discovered by [class@Clapper.Player] anyway. + + + + + + + + + + + + + + + + + + + + + + A base class for creating new features for the player. + +Feature objects are meant for adding additional functionalities that +are supposed to either act on playback/properties changes and/or change +them themselves due to some external signal/event. + +For reacting to playback changes subclass should override this class +virtual functions logic, while for controlling playback implementation +may call [method@Gst.Object.get_parent] to acquire a weak reference on +a parent [class@Clapper.Player] object feature was added to. + + + An item in queue got updated. This might be (or not) currently +played item. Implementations can get parent player object +if they want to check that from its queue. + + + + + + + a #ClapperFeature + + + + a #ClapperMediaItem that was updated + + + + + + Player mute state was changed. + + + + + + + a #ClapperFeature + + + + %TRUE if player is muted, %FALSE otherwise + + + + + + New media item started playing. All following events (such as position changes) +will be related to this @item from now on. + + + + + + + a #ClapperFeature + + + + a #ClapperMediaItem that is now playing + + + + + + Player position was changed. + + + + + + + a #ClapperFeature + + + + a decimal number with current position in seconds + + + + + + Prepare feature for operation (optional). + +This is different from init() as its called from features thread once +feature is added to the player, so it can already access it parent using +gst_object_get_parent(). If it fails, no other method will be called. + + + %TRUE on success, %FALSE otherwise. + + + + + a #ClapperFeature + + + + + + A property of @feature changed its value. + +Useful for reconfiguring @feature, since unlike "notify" signal +this is always called from the thread that feature works on and +only after feature was prepared. + + + + + + + a #ClapperFeature + + + + a #GParamSpec + + + + + + All items were removed from queue. Note that in such event +@queue_item_removed will NOT be called for each item for performance reasons. +You probably want to implement this function if you also implemented item removal. + + + + + + + a #ClapperFeature + + + + + + An item was added to the queue. + + + + + + + a #ClapperFeature + + + + a #ClapperMediaItem that was added + + + + position at which @item was placed in queue + + + + + + An item was removed from queue. + + + + + + + a #ClapperFeature + + + + a #ClapperMediaItem that was removed + + + + position from which @item was removed in queue + + + + + + An item changed position within queue. + + + + + + + a #ClapperFeature + + + + position from which #ClapperMediaItem was removed + + + + position at which #ClapperMediaItem was inserted after removal + + + + + + Progression mode of the queue was changed. + + + + + + + a #ClapperFeature + + + + a #ClapperQueueProgressionMode + + + + + + Player speed was changed. + + + + + + + a #ClapperFeature + + + + the playback speed multiplier + + + + + + Player state was changed. + + + + + + + a #ClapperFeature + + + + a #ClapperPlayerState + + + + + + Revert the changes done in @prepare (optional). + + + %TRUE on success, %FALSE otherwise. + + + + + a #ClapperFeature + + + + + + Player volume was changed. + + + + + + + a #ClapperFeature + + + + the volume level + + + + + + + + + + + + The object class structure. + + + + Prepare feature for operation (optional). + + + + %TRUE on success, %FALSE otherwise. + + + + + a #ClapperFeature + + + + + + + Revert the changes done in @prepare (optional). + + + + %TRUE on success, %FALSE otherwise. + + + + + a #ClapperFeature + + + + + + + A property of @feature changed its value. + + + + + + + + a #ClapperFeature + + + + a #GParamSpec + + + + + + + Player state was changed. + + + + + + + + a #ClapperFeature + + + + a #ClapperPlayerState + + + + + + + Player position was changed. + + + + + + + + a #ClapperFeature + + + + a decimal number with current position in seconds + + + + + + + Player speed was changed. + + + + + + + + a #ClapperFeature + + + + the playback speed multiplier + + + + + + + Player volume was changed. + + + + + + + + a #ClapperFeature + + + + the volume level + + + + + + + Player mute state was changed. + + + + + + + + a #ClapperFeature + + + + %TRUE if player is muted, %FALSE otherwise + + + + + + + Currently playing media item got changed. + + + + + + + + a #ClapperFeature + + + + a #ClapperMediaItem that is now playing + + + + + + + An item in queue got updated. + + + + + + + + a #ClapperFeature + + + + a #ClapperMediaItem that was updated + + + + + + + An item was added to the queue. + + + + + + + + a #ClapperFeature + + + + a #ClapperMediaItem that was added + + + + position at which @item was placed in queue + + + + + + + An item was removed from queue. + + + + + + + + a #ClapperFeature + + + + a #ClapperMediaItem that was removed + + + + position from which @item was removed in queue + + + + + + + + + + + + + + a #ClapperFeature + + + + position from which #ClapperMediaItem was removed + + + + position at which #ClapperMediaItem was inserted after removal + + + + + + + All items were removed from queue. + + + + + + + + a #ClapperFeature + + + + + + + Progression mode of the queue was changed. + + + + + + + + a #ClapperFeature + + + + a #ClapperQueueProgressionMode + + + + + + + + + + + + + Check if Clapper was compiled with Discoverer feature. + + + + + Check if Clapper was compiled with MPRIS feature. + + + + + Check if Clapper was compiled with Server feature. + + + + + Clapper major version component + + + + + + + + + + + + The value used to indicate that marker does not have an ending time specified + + + + + + + + + + + + Clapper micro version component + + + + + Clapper minor version component + + + + + + + + + + + + Represents a point in timeline. + +Markers are a convienient way of marking points of interest within a +[class@Clapper.Timeline] of [class@Clapper.MediaItem]. Use them +to indicate certain areas on the timeline. + +Markers are reference counted immutable objects. Once a marker is created +it can only be inserted into a single [class@Clapper.Timeline] at a time. + +Please note that markers are independent of [property@Clapper.MediaItem:duration] +and applications should not assume that all markers must have start/end times +lower or equal the item duration. This is not the case in e.g. live streams +where duration is unknown, but markers are still allowed to mark entries +(like EPG titles for example). + +Remember that [class@Clapper.Player] will also automatically insert certain +markers extracted from media such as video chapters. Clapper will never +"touch" the ones created by the application. If you want to differentiate +your own markers, applications can define and create markers with one of +the custom types from [enum@Clapper.MarkerType] enum. + +Example: + +```c +#define MY_APP_MARKER (CLAPPER_MARKER_TYPE_CUSTOM_1) + +ClapperMarker *marker = clapper_marker_new (MY_APP_MARKER, title, start, end); +``` + +```c +ClapperMarkerType marker_type = clapper_marker_get_marker_type (marker); + +if (marker_type == MY_APP_MARKER) { + // Do something with your custom marker +} +``` + + + Creates a new #ClapperMarker with given params. + +It is considered a programmer error trying to set an ending +point that is before the starting one. If end is unknown or +not defined a special [const@Clapper.MARKER_NO_END] value +should be used. + + + a new #ClapperMarker. + + + + + a #ClapperMarkerType + + + + title of the marker + + + + a start position of the marker + + + + an end position of the marker or [const@Clapper.MARKER_NO_END] if none + + + + + + Get the end position (in seconds) of @marker. + + + marker end. + + + + + a #ClapperMarker + + + + + + Get the #ClapperMarkerType of @marker. + + + type of marker. + + + + + a #ClapperMarker + + + + + + Get the start position (in seconds) of @marker. + + + marker start. + + + + + a #ClapperMarker + + + + + + Get the title of @marker. + + + the marker title. + + + + + a #ClapperMarker + + + + + + Ending time of marker. + + + + Type of stream. + + + + Starting time of marker. + + + + Title of marker. + + + + + + + + + + + + Unknown marker type. + + + A title marker in timeline. + + + A chapter marker in timeline. + + + A track marker in timeline. + + + + + + + + + + Represents a media item. + +A newly created media item must be added to player [class@Clapper.Queue] +first in order to be played. + + + Creates new #ClapperMediaItem from URI. + +Use one of the URI protocols supported by plugins in #GStreamer +installation. For local files you can use either "file" protocol +or [ctor@Clapper.MediaItem.new_from_file] method. + +It is considered a programmer error trying to create new media item from +invalid URI. If URI is valid, but unsupported by installed plugins on user +system, [class@Clapper.Player] will emit a [signal@Clapper.Player::missing-plugin] +signal upon playback. + + + a new #ClapperMediaItem. + + + + + a media URI + + + + + + Creates new #ClapperMediaItem from #GFile. + +Same as [ctor@Clapper.MediaItem.new], but uses a [iface@Gio.File] +for convenience in some situations instead of an URI. + + + a new #ClapperMediaItem. + + + + + a #GFile + + + + + + Get media item container format. + + + media container format. + + + + + a #ClapperMediaItem + + + + + + Get media item duration as decimal number in seconds. + + + media duration. + + + + + a #ClapperMediaItem + + + + + + Get the unique ID of #ClapperMediaItem. + + + an ID of #ClapperMediaItem. + + + + + a #ClapperMediaItem + + + + + + Get the additional URI of #ClapperMediaItem. + + + an additional URI of #ClapperMediaItem. + + + + + a #ClapperMediaItem + + + + + + Get the [class@Clapper.Timeline] assosiated with @item. + + + a #ClapperTimeline of item. + + + + + a #ClapperMediaItem + + + + + + Get media item title. + +The title can be either text detected by media discovery once it +completes. Otherwise whenever possible this will try to return a title +extracted from media URI e.g. basename without extension for local files. + + + media title. + + + + + a #ClapperMediaItem + + + + + + Get the URI of #ClapperMediaItem. + + + an URI of #ClapperMediaItem. + + + + + a #ClapperMediaItem + + + + + + Set the additional URI of #ClapperMediaItem. + +This is typically used to add an external subtitles URI to the @item. + + + + + + + a #ClapperMediaItem + + + + an additional URI + + + + + + Media container format. + + + + Media duration as a decimal number in seconds. + + + + Media Item ID. + + + + Media additional URI. + + + + Media timeline. + + + + Media title. + + + + Media URI. + + + + + + + + + + + An optional `MPRIS` feature to add to the player. + +Not every OS supports `MPRIS`. Use [const@Clapper.HAVE_MPRIS] macro +to check if Clapper API was compiled with this feature. + + + Creates a new #ClapperMpris instance. + + + a new #ClapperMpris instance. + + + + + an unique DBus name with "org.mpris.MediaPlayer2." prefix + + + + a media player friendly name + + + + desktop file basename (without ".desktop" extension) + + + + + + Get fallback art URL earlier set by user. + + + fallback art URL. + + + + + a #ClapperMpris + + + + + + Get whether remote `MPRIS` clients can control [class@Clapper.Queue]. + + + %TRUE if control over #ClapperQueue is allowed, %FALSE otherwise. + + + + + a #ClapperMpris + + + + + + Set fallback artwork to show when media does not provide one. + + + + + + + a #ClapperMpris + + + + an art URL + + + + + + Set whether remote MPRIS clients can control #ClapperQueue. + +This includes ability to open new URIs, adding/removing +items from the queue and selecting current item for +playback remotely using MPRIS interface. + +You probably want to keep this disabled if your application +is supposed to manage what is played now and not MPRIS client. + + + + + + + a #ClapperMpris + + + + if #ClapperQueue should be controllable + + + + + + The basename of an installed .desktop file with the ".desktop" extension stripped. + + + + Fallback artwork to show when media does not provide one. + + + + A friendly name to identify the media player. + +Example: "My Player" + + + + DBus name to own on connection. + +Must be written as a reverse DNS format starting with "org.mpris.MediaPlayer2." prefix. +Each #ClapperMpris instance running on the same system must have an unique. + +Example: "org.mpris.MediaPlayer2.MyPlayer1" + + + + Whether remote MPRIS clients can control #ClapperQueue. + + + + + + + + + + + + + + + + + + The media player object used for playback. + +#ClapperPlayer was written in an easy to use way, so no special GStreamer +experience is needed to get started with making various playback applications. + +Scheduling media for playback is done using a [class@Clapper.Queue] upon which +player operates. + +Player uses `GStreamer` internally and handles playback on a separate thread, while +serializing all events/commands between player and the thread it was created upon +(usually main app thread). This makes it very easy to integrate with UI toolkits +that operate on a single thread like (but not limited to) GTK. + +To listen for property changes, you can connect to property "notify" signal. + + + Creates a new #ClapperPlayer instance. + + + a new #ClapperPlayer instance. + + + + + Add another #ClapperFeature to the player. + + + + + + + a #ClapperPlayer + + + + a #ClapperFeature + + + + + + Get whether audio stream is enabled. + + + %TRUE if enabled, %FALSE otherwise. + + + + + a #ClapperPlayer + + + + + + Get #GstElement used as audio filter. + + + #GstElement set as audio filter. + + + + + a #ClapperPlayer + + + + + + Get the currently set audio stream offset. + +The returned value is in seconds as a decimal number. + + + the audio stream offset. + + + + + a #ClapperPlayer + + + + + + Get #GstElement used as audio sink. + + + #GstElement set as audio sink. + + + + + a #ClapperPlayer + + + + + + Get a list of audio streams within media item. + + + a #ClapperStreamList of audio #ClapperStream. + + + + + a #ClapperPlayer + + + + + + Get the autoplay value. + + + %TRUE if autoplay is enabled, %FALSE otherwise. + + + + + a #ClapperPlayer + + + + + + Get #GstElement currently used as audio decoder. + + + #GstElement currently used as audio decoder. + + + + + a #ClapperPlayer + + + + + + Get #GstElement currently used as video decoder. + + + #GstElement currently used as video decoder. + + + + + a #ClapperPlayer + + + + + + Get the mute state of the player. + + + %TRUE if player is muted, %FALSE otherwise. + + + + + a #ClapperPlayer + + + + + + Get the current player playback position. + +The returned value is in seconds as a decimal number. + + + the position of the player. + + + + + a #ClapperPlayer + + + + + + Get the #ClapperQueue of the player. + +The queue belongs to the player and can be accessed for as long +as #ClapperPlayer object instance it belongs to is alive. + + + the #ClapperQueue of the player. + + + + + a #ClapperPlayer + + + + + + Get the speed of the player used for playback. + + + the playback speed multiplier. + + + + + a #ClapperPlayer + + + + + + Get the current #ClapperPlayerState. + + + the #ClapperPlayerState of the player. + + + + + a #ClapperPlayer + + + + + + Get the currently set font description used for subtitle stream rendering. + + + the subtitle font description. + + + + + a #ClapperPlayer + + + + + + Get the currently set subtitle stream offset. + +The returned value is in seconds as a decimal number. + + + the subtitle stream offset. + + + + + a #ClapperPlayer + + + + + + Get a list of subtitle streams within media item. + + + a #ClapperStreamList of subtitle #ClapperStream. + + + + + a #ClapperPlayer + + + + + + Get whether subtitles are to be shown when available. + + + %TRUE if enabled, %FALSE otherwise. + + + + + a #ClapperPlayer + + + + + + Get whether video stream is enabled. + + + %TRUE if enabled, %FALSE otherwise. + + + + + a #ClapperPlayer + + + + + + Get #GstElement used as video filter. + + + #GstElement set as video filter. + + + + + a #ClapperPlayer + + + + + + Get #GstElement used as video sink. + + + #GstElement set as video sink. + + + + + a #ClapperPlayer + + + + + + Get a list of video streams within media item. + + + a #ClapperStreamList of video #ClapperStream. + + + + + a #ClapperPlayer + + + + + + Get the volume of the player. + + + current volume level. + + + + + a #ClapperPlayer + + + + + + Pause the playback of current media item. + +This function will queue a request for the underlaying #GStreamer +pipeline to go into `PAUSED` state, thus can also be used on a not +yet started video to go into `PAUSED` state first. + + + + + + + a #ClapperPlayer + + + + + + Either start or resume the playback of current media item. + +This function will queue a request for the underlaying #GStreamer +pipeline to go into `PLAYING` state. + + + + + + + a #ClapperPlayer + + + + + + Request the player to perform a seek operation. + +This function will use [enum@Clapper.PlayerSeekMethod.NORMAL] as a +seeking method. If you wish to specify what method to use per seeking +request, use [method@Clapper.Player.seek_custom] instead. + +Note that seeking requests are per selected media item. Seeking +requests will be ignored if player is stopped. You need to at least +call [method@Clapper.Player.pause] before seeking and then your requested +seek will be handled if item could be played. + + + + + + + a #ClapperPlayer + + + + a decimal number with position to seek to (in seconds) + + + + + + Request the player to perform a seek operation. + +Same as [method@Clapper.Player.seek], but also allows to specify +[enum@Clapper.PlayerSeekMethod] to use for seek. + + + + + + + a #ClapperPlayer + + + + a decimal number with position to seek to (in seconds) + + + + a #ClapperPlayerSeekMethod + + + + + + Set whether enable audio stream. + + + + + + + a #ClapperPlayer + + + + whether enabled + + + + + + Set #GstElement to be used as audio filter. + + + + + + + a #ClapperPlayer + + + + a #GstElement or %NULL for none. + + + + + + Set synchronisation offset between the audio stream and video. + +Positive values make the audio ahead of the video and negative +values make the audio go behind the video. + + + + + + + a #ClapperPlayer + + + + a decimal audio offset (in seconds) + + + + + + Set #GstElement to be used as audio sink. + + + + + + + a #ClapperPlayer + + + + a #GstElement or %NULL to use default. + + + + + + Set the autoplay state of the player. + +When autoplay is enabled, player will always try to start +playback after current media item changes. When disabled +current playback state is preserved when changing items. + + + + + + + a #ClapperPlayer + + + + %TRUE to enable autoplay, %FALSE otherwise. + + + + + + Set the mute state of the player. + + + + + + + a #ClapperPlayer + + + + %TRUE if player should be muted, %FALSE otherwise. + + + + + + Set the speed multiplier of the player. + + + + + + + a #ClapperPlayer + + + + the playback speed multiplier. + + + + + + Set Pango font description to be used for subtitle stream rendering. + + + + + + + a #ClapperPlayer + + + + Font description + + + + + + Set synchronisation offset between the subtitle stream and video. + +Positive values make the subtitles ahead of the video and negative +values make the subtitles go behind the video. + + + + + + + a #ClapperPlayer + + + + a decimal subtitle stream offset (in seconds) + + + + + + Set whether subtitles should be shown if any. + + + + + + + a #ClapperPlayer + + + + whether enabled + + + + + + Set whether enable video stream. + + + + + + + a #ClapperPlayer + + + + whether enabled + + + + + + Set #GstElement to be used as video filter. + + + + + + + a #ClapperPlayer + + + + a #GstElement or %NULL for none. + + + + + + Set #GstElement to be used as video sink. + + + + + + + a #ClapperPlayer + + + + a #GstElement or %NULL to use default. + + + + + + Set the volume of the player. + +The value should be within 0 - 2.0 range, where 1.0 is 100% +volume and anything above results with an overamplification. + + + + + + + a #ClapperPlayer + + + + the volume level. + + + + + + Stop the playback of current media item. + +This function will queue a request for the underlaying #GStreamer +pipeline to go into `READY` state. + + + + + + + a #ClapperPlayer + + + + + + Whether audio stream is enabled. + + + + Optional audio filter to use (none by default). + + + + Audio stream offset relative to video. + + + + Audio sink to use (autoaudiosink by default). + + + + List of currently available audio streams. + + + + Always try to start playback after media item changes. + + + + Currently used audio decoder. + + + + Currently used video decoder. + + + + Mute audio without changing volume. + + + + Current playback position as a decimal number in seconds. + + + + Clapper playback queue. + + + + Current playback speed. + + + + Current playback state. + + + + Subtitle stream font description. + + + + Subtitle stream offset relative to video. + + + + List of currently available subtitle streams. + + + + Whether subtitles stream is enabled. + + + + Whether video stream is enabled. + + + + Optional video filter to use (none by default). + + + + Video sink to use (autovideosink by default). + + + + List of currently available video streams. + + + + Current volume as a decimal number (1.0 = 100%). + +Note that #ClapperPlayer uses a CUBIC volume scale, meaning +that this property value reflects human hearing level and can +be easily bound to volume sliders as-is. + + + + These are normal error messages. Upon emitting this signal, +playback will stop due to the error. + + + + + + a #GError + + + + an additional debug message. + + + + + + A #GStreamer plugin or one of its features needed for playback is missing. + +The @description and @installer_detail can be used to present the user more info +about what is missing and prompt him to install it with an external installer. + + + + + + a localised string describing the missing feature, for use in + error dialogs and the like. + + + + a string containing all the details about the missing + element to be passed to an external installer called via either + gst_install_plugins_async() or gst_install_plugins_sync() function. + + + + + + A seeking operation has finished. Player is now at playback position after seek. + + + + + + These are some usually more minor error messages that should +be treated like warnings. Should not generally prevent/stop playback. + + + + + + a #GError + + + + an additional debug message. + + + + + + + + + + + + + + Seek to exact position (slow). + + + Seek to approximated position. + + + Seek to position of nearest keyframe (fast). + + + + + Player is stopped. + + + Player is buffering. + + + Player is paused. + + + Player is playing. + + + + + + + + + + + The value used to refer to an invalid position in a #ClapperQueue + + + + + A queue of media to be played. + + + + Add another #ClapperMediaItem to the end of queue. + +If item is already in queue, this function will do nothing, +so it is safe to call multiple times if unsure. + + + + + + + a #ClapperQueue + + + + a #ClapperMediaItem + + + + + + Removes all media items from the queue. + +If queue is empty, this function will do nothing, +so it is safe to call multiple times if unsure. + + + + + + + a #ClapperQueue + + + + + + Get the index of #ClapperMediaItem within #ClapperQueue. + + + %TRUE if @item is one of the elements of queue. + + + + + a #ClapperQueue + + + + a #ClapperMediaItem to search for + + + + return location for the index of + the element, if found + + + + + + Get index of the currently selected #ClapperMediaItem. + + + Current item index or [const@Clapper.QUEUE_INVALID_POSITION] + when nothing is selected. + + + + + a #ClapperQueue + + + + + + Get the currently selected #ClapperMediaItem. + + + The current #ClapperMediaItem. + + + + + a #ClapperQueue + + + + + + Get if #ClapperQueue is set to use gapless progression. + + + %TRUE if enabled, %FALSE otherwise. + + + + + a #ClapperQueue + + + + + + Get if #ClapperQueue is set to use instant media item changes. + + + %TRUE if enabled, %FALSE otherwise. + + + + + a #ClapperQueue + + + + + + Get the #ClapperMediaItem at index. + +This behaves the same as [method@Gio.ListModel.get_item], and is here +for code uniformity and convenience to avoid type casting by user. + +This function is not available in bindings as they already +inherit `get_item()` method from [iface@Gio.ListModel] interface. + + + The #ClapperMediaItem at @index. + + + + + a #ClapperQueue + + + + an item index + + + + + + Get the number of items in #ClapperQueue. + +This behaves the same as [method@Gio.ListModel.get_n_items], and is here +for code uniformity and convenience to avoid type casting by user. + +This function is not available in bindings as they already +inherit get_n_items() method from #GListModel interface. + + + The number of items in #ClapperQueue. + + + + + a #ClapperQueue + + + + + + Get the #ClapperQueueProgressionMode of the #ClapperQueue. + + + a currently set #ClapperQueueProgressionMode. + + + + + a #ClapperQueue + + + + + + Insert another #ClapperMediaItem at @index position to the queue. + +If item is already in queue, this function will do nothing, +so it is safe to call multiple times if unsure. + + + + + + + a #ClapperQueue + + + + a #ClapperMediaItem + + + + the index to place @item in queue, -1 to append + + + + + + Checks if given #ClapperMediaItem is currently selected. + + + %TRUE if @item is a current media item, %FALSE otherwise. + + + + + a #ClapperQueue + + + + a #ClapperMediaItem to check + + + + + + Removes #ClapperMediaItem at @index from the queue. + + + + + + + a #ClapperQueue + + + + an item index + + + + + + Removes #ClapperMediaItem from the queue. + +If item either was never in the queue or was removed from +it earlier, this function will do nothing, so it is safe +to call multiple times if unsure. + + + + + + + a #ClapperQueue + + + + a #ClapperMediaItem + + + + + + Change position of one #ClapperMediaItem within the queue. + +Note that the @index is the new position you expect item to be +after whole reposition operation is finished. + +If item is not in the queue, this function will do nothing. + + + + + + + a #ClapperQueue + + + + a #ClapperMediaItem + + + + the index to place @item in queue, -1 to place at the end + + + + + + Selects #ClapperMediaItem at @index from @queue as current one or +unselects currently selected index when @index is [const@Clapper.QUEUE_INVALID_POSITION]. + + + %TRUE if item at @index could be selected/unselected, + %FALSE if index was out of queue range. + + + + + a #ClapperQueue + + + + an item index or [const@Clapper.QUEUE_INVALID_POSITION] to unselect + + + + + + Selects #ClapperMediaItem from @queue as current one or +unselects currently selected item when @item is %NULL. + + + %TRUE if item could be selected/unselected, + %FALSE if it was not in the queue. + + + + + a #ClapperQueue + + + + a #ClapperMediaItem or %NULL to unselect + + + + + + Selects next #ClapperMediaItem from @queue for playback. + +Note that this will try to select next item in the order +of the queue, regardless of [enum@Clapper.QueueProgressionMode] set. + + + %TRUE if there was another media item in queue, %FALSE otherwise. + + + + + a #ClapperQueue + + + + + + Selects previous #ClapperMediaItem from @queue for playback. + +Note that this will try to select previous item in the order +of the queue, regardless of [enum@Clapper.QueueProgressionMode] set. + + + %TRUE if there was previous media item in queue, %FALSE otherwise. + + + + + a #ClapperQueue + + + + + + Set #ClapperQueue progression to be gapless. + +Gapless playback will try to re-use as much as possible of underlying +GStreamer elements when #ClapperQueue progresses, removing any +potential gap in the data. + +Enabling this option mostly makes sense when used together with +[property@Clapper.Queue:progression-mode] property set to +[enum@Clapper.QueueProgressionMode.CONSECUTIVE]. + +NOTE: This feature within GStreamer is rather new and +might still cause playback issues. Disabled by default. + + + + + + + a #ClapperQueue + + + + %TRUE to enable, %FALSE otherwise. + + + + + + Set #ClapperQueue media item changes to be instant. + +Instant will try to re-use as much as possible of underlying +GStreamer elements when #ClapperMediaItem is selected, allowing +media item change requests to be faster. + +NOTE: This feature within GStreamer is rather new and +might still cause playback issues. Disabled by default. + + + + + + + a #ClapperQueue + + + + %TRUE to enable, %FALSE otherwise. + + + + + + Set the #ClapperQueueProgressionMode of the #ClapperQueue. + +Changing the mode set will alter next item selection at the +end of playback. For possible values and their descriptions, +see #ClapperQueueProgressionMode documentation. + + + + + + + a #ClapperQueue + + + + a #ClapperQueueProgressionMode + + + + + + Removes #ClapperMediaItem at @index from the queue. + + + The removed #ClapperMediaItem at @index. + + + + + a #ClapperQueue + + + + an item index + + + + + + Index of currently selected media item for playback. + + + + Currently selected media item for playback. + + + + Use gapless progression. + + + + Use instant media item changes. + + + + Number of media items in the queue. + + + + Queue progression mode. + + + + + + + + + + + + Queue will not change current item after playback finishes. + + + Queue selects items one after another until the end. + When end of queue is reached, this mode will continue one another item is added to the queue, + playing it if player autoplay property is set, otherwise current player state is kept. + + + Queue keeps repeating current media item. + + + Queue starts from beginning after last media item. + + + Queue selects a random media item after current one. + Shuffle mode will avoid reselecting previously shuffled items as long as possible. + After it runs out of unused items, shuffling begins anew. + + + + + + + + + + + + + + + + + + + + + + + + + The value used to refer to an invalid position in a #ClapperStreamList + + + + + + + + + + + + An optional Server feature to add to the player. + +#ClapperServer is a feature that hosts a local server +providing an ability to both monitor and control playback +through WebSocket messages and HTTP requests. + +Use [const@Clapper.HAVE_SERVER] macro to check if Clapper API +was compiled with this feature. + + + Creates a new #ClapperServer instance. + + + a new #ClapperServer instance. + + + + + Get port on which server is currently listening on. + + + Current listening port or 0 if server is not listening. + + + + + a #ClapperServer + + + + + + Get whether #ClapperServer is set to be running. + + + %TRUE if enabled, %FALSE otherwise. + + + + + a #ClapperServer + + + + + + Get requested server listening port. + +If you want to know the port server is currently listening on, +use [method@Clapper.Server.get_current_port] instead. + + + Requested listening port or 0 when using random port. + + + + + a #ClapperServer + + + + + + Get whether remote @server clients can control [class@Clapper.Queue]. + + + %TRUE if control over #ClapperQueue is allowed, %FALSE otherwise. + + + + + a #ClapperServer + + + + + + Get whether #ClapperServer is currently running. + + + %TRUE if running, %FALSE otherwise. + + + + + a #ClapperServer + + + + + + Set whether #ClapperServer should be running. + +Note that server feature will run only after being added to the player. +It can be however set to enabled earlier. If server was already added, +changing this property allows to start/stop server at any time. + +To be notified when server is actually running/stopped after being enabled/disabled, +you can listen for changes to [property@Clapper.Server:running] property. + + + + + + + a #ClapperServer + + + + if #ClapperServer should run + + + + + + Set server listening port. + + + + + + + a #ClapperServer + + + + a port number or 0 for random free port + + + + + + Set whether remote @server clients can control [class@Clapper.Queue]. + +This includes ability to add/remove items from the queue and selecting +current item for playback remotely using WebSocket messages. + +You probably want to keep this disabled if your application +is supposed to manage what is played now and not WebSocket client. + + + + + + + a #ClapperServer + + + + if #ClapperQueue should be controllable + + + + + + Port on which server is currently listening on or 0 if not listening. + + + + Whether server is enabled. + + + + Port to listen on or 0 for using random unused port. + + + + Whether remote server clients can control #ClapperQueue. + + + + Whether server is currently running. + + + + Error signal when server could not start. +This will be emitted from application main thread. + + + + + + a #GError + + + + + + + + + + + + + Represents a stream within media. + + + This function is called when internal #GstStream gets updated. +Meant for internal usage only. Used for subclasses to update +their properties accordingly. + +Note that this vfunc is called from different threads. + + + + + + + a #ClapperStream + + + + an updated #GstCaps if changed + + + + an updated #GstTagList if changed + + + + + + Get the #ClapperStreamType of @stream. + + + type of stream. + + + + + a #ClapperStream + + + + + + Get the title of @stream, if any. + + + title of stream. + + + + + a #ClapperStream + + + + + + Type of stream. + + + + Title of stream. + + + + + + + + + + + + + + + + + + + + a #ClapperStream + + + + an updated #GstCaps if changed + + + + an updated #GstTagList if changed + + + + + + + + + + + + + A list of media streams. + + + + Get index of the currently selected #ClapperStream. + + + Current stream index or [const@Clapper.STREAM_LIST_INVALID_POSITION] + when nothing is selected. + + + + + a #ClapperStreamList + + + + + + Get the currently selected #ClapperStream. + + + The current #ClapperStream. + + + + + a #ClapperStreamList + + + + + + Get the number of streams in #ClapperStreamList. + +This behaves the same as [method@Gio.ListModel.get_n_items], and is here +for code uniformity and convenience to avoid type casting by user. + + + The number of streams in #ClapperStreamList. + + + + + a #ClapperStreamList + + + + + + Get the #ClapperStream at index. + +This behaves the same as [method@Gio.ListModel.get_item], and is here +for code uniformity and convenience to avoid type casting by user. + + + The #ClapperStream at @index. + + + + + a #ClapperStreamList + + + + a stream index + + + + + + Selects #ClapperStream at @index from @list as current one. + + + %TRUE if stream could be selected, %FALSE otherwise. + + + + + a #ClapperStreamList + + + + a stream index + + + + + + Selects #ClapperStream from @list to be activated. + + + %TRUE if stream was in the @list, %FALSE otherwise. + + + + + a #ClapperStreamList + + + + a #ClapperStream + + + + + + Index of currently selected stream. + + + + Currently selected stream. + + + + Number of streams in the list. + + + + + + + + + + + + Unknown stream type. + + + Stream is a #ClapperVideoStream. + + + Stream is a #ClapperAudioStream. + + + Stream is a #ClapperSubtitleStream. + + + + Represents a subtitle stream within media. + + + Get an ISO-639 language code of the @stream. + + + the language code of subtitle stream. + + + + + a #ClapperSubtitleStream + + + + + + Get language name of the @stream. + +This function will try to return a translated string into current +locale if possible, with a fallback to a name extracted from tags. + + + the language name of subtitle stream. + + + + + a #ClapperSubtitleStream + + + + + + Stream language code in ISO-639 format. + + + + Stream language name. + + + + + + + + + + + + + + + + + + + + + + + + + Formats @t for the [const@Clapper.TIME_FORMAT] format string. + + + + time value in seconds + + + + + A string that can be used in printf-like format to display +e.g. position or duration in `hh:mm:ss` format. Meant to be +used together with [func@Clapper.TIME_ARGS]. + +Example: + +```c +gchar *str = g_strdup_printf ("%" CLAPPER_TIME_FORMAT, CLAPPER_TIME_ARGS (time)); +``` + + + + + Formats @t for the [const@Clapper.TIME_MS_FORMAT] format string. + + + + time value in seconds + + + + + Same as [const@Clapper.TIME_FORMAT], but also displays milliseconds. +Meant to be used together with [func@Clapper.TIME_MS_ARGS]. + +Example: + +```c +gchar *str = g_strdup_printf ("%" CLAPPER_TIME_MS_FORMAT, CLAPPER_TIME_MS_ARGS (time)); +``` + + + + + A base class for creating objects that work within a separate thread. + + + Called right after thread started. + +Useful for initializing objects that work within this new thread. + + + + + + + a #ClapperThreadedObject + + + + + + Called when thread is going to stop. + +Useful for cleanup of things created on thread start. + + + + + + + a #ClapperThreadedObject + + + + + + Get the #GMainContext of the thread used by this object. + +Useful when you want to invoke object thread to do some +action in it from a different thread. + + + a #GMainContext of the object used thread. + + + + + a #ClapperThreadedObject + + + + + + + + + + + + The object class structure. + + + + Called right after thread started. + + + + + + + + a #ClapperThreadedObject + + + + + + + Called when thread is going to stop. + + + + + + + + a #ClapperThreadedObject + + + + + + + + + + + + + A media timeline filled with point markers. + + + + Get the #ClapperMarker at index. + +This behaves the same as [method@Gio.ListModel.get_item], and is here +for code uniformity and convenience to avoid type casting by user. + + + The #ClapperMarker at @index. + + + + + a #ClapperTimeline + + + + a marker index + + + + + + Get the number of markers in #ClapperTimeline. + +This behaves the same as [method@Gio.ListModel.get_n_items], and is here +for code uniformity and convenience to avoid type casting by user. + + + The number of markers in #ClapperTimeline. + + + + + a #ClapperTimeline + + + + + + Insert the #ClapperMarker into @timeline. + + + %TRUE if inserted, %FALSE if marker was +already inserted into timeline. + + + + + a #ClapperTimeline + + + + a #ClapperMarker + + + + + + Removes #ClapperMarker from the timeline. + +If marker was not in the @timeline, this function will do nothing, +so it is safe to call if unsure. + + + + + + + a #ClapperTimeline + + + + a #ClapperMarker + + + + + + Number of markers in the timeline. + + + + + + + + + + + Clapper version, encoded as a string + + + + + + + + + + + + Represents a video stream within media. + + + Get bitrate of video @stream. + + + the bitrate of video stream. + + + + + a #ClapperVideoStream + + + + + + Get codec used to encode @stream. + + + the video codec of stream + or %NULL if undetermined. + + + + + a #ClapperVideoStream + + + + + + Get number of frames per second in video @stream. + + + the FPS of video stream. + + + + + a #ClapperVideoStream + + + + + + Get height of video @stream. + + + the height of video stream. + + + + + a #ClapperVideoStream + + + + + + Get pixel format of video @stream. + + + the pixel format of stream + or %NULL if undetermined. + + + + + a #ClapperVideoStream + + + + + + Get width of video @stream. + + + the width of video stream. + + + + + a #ClapperVideoStream + + + + + + Stream bitrate. + + + + Stream codec. + + + + Stream FPS. + + + + Stream height. + + + + Stream pixel format. + + + + Stream width. + + + + + + + + + + + Initializes the Clapper library. Implementations must always call this +before using Clapper API. + +Because Clapper uses GStreamer internally, this function will also initialize +GStreamer before initializing Clapper itself for user convienience, so +application does not have to do so anymore. + +WARNING: This function will terminate your program if it was unable to +initialize for some reason. If you want to do some fallback logic, +use [func@Clapper.init_check] instead. + + + + + + + pointer to application's argc + + + + pointer to application's argv + + + + + + + + This function does the same thing as [func@Clapper.init], but instead of +terminating on failure it returns %FALSE with @error set. + + + %TRUE if Clapper could be initialized, %FALSE otherwise. + + + + + pointer to application's argc + + + + pointer to application's argv + + + + + + + + diff --git a/girs/ClapperGtk-0.0.gir b/girs/ClapperGtk-0.0.gir new file mode 100644 index 000000000..fb75ceff3 --- /dev/null +++ b/girs/ClapperGtk-0.0.gir @@ -0,0 +1,2618 @@ + + + + + + + + + + + + + + + + + + + + A layer where various messages can be displayed. + +#ClapperGtkBillboard widget is meant to be overlaid on top of +[class@ClapperGtk.Video] as a normal (non-fading) overlay. + +It is used to display various messages/announcements and later +takes care of fading them on its own. + +If automatic volume/speed change notifications when their values do +change are desired, functions for announcing them can be run in callbacks +to corresponding property notify signals on the [class@Clapper.Player]. + + + + + + Creates a new #ClapperGtkBillboard instance. + + + a new billboard #GtkWidget. + + + + + Temporarily displays current speed value on the +side of @billboard. + +Use this if you want to present current speed value to the user. +Note that @billboard also automatically announces speed changes. + + + + + + + a #ClapperGtkBillboard + + + + + + Temporarily displays current volume level on the +side of @billboard. + +Use this if you want to present current volume level to the user. +Note that @billboard also automatically announces volume changes. + + + + + + + a #ClapperGtkBillboard + + + + + + Pins a permanent message on the @billboard. + +The message will stay on the @billboard until a +[method@ClapperGtk.Billboard.unpin_pinned_message] is called. + + + + + + + a #ClapperGtkBillboard + + + + an icon name + + + + a message text + + + + + + Posts a temporary message on the @billboard. + +Duration how long a message will stay is automatically +calculated based on amount of text. + + + + + + + a #ClapperGtkBillboard + + + + an icon name + + + + a message text + + + + + + Unpins previously pinned message on the @billboard. + +If no message was pinned this function will do nothing, +so it is safe to call when unsure. + + + + + + + a #ClapperGtkBillboard + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A simple container widget that holds just one child. + +It is designed to work well with OSD overlay, adding some useful functionalities +to it, such as width and height that widget should target. This helps with +implementing simple adaptive widgets by observing its own width and signalling +when adaptive threshold is reached. + +You can use this when you need to create a widget that is adaptive or should have +a limited maximal width/height. + +If you need to have more then single widget as child, place a widget that +can hold multiple children such as [class@Gtk.Box] as a single conatiner child +and then your widgets into that child. + + + + + + Creates a new #ClapperGtkContainer instance. + + + a new container #GtkWidget. + + + + + Get a @container adaptive height threshold. + + + adaptive height set by user or -1 when none. + + + + + a #ClapperGtkContainer + + + + + + Get a @container adaptive width threshold. + + + adaptive width set by user or -1 when none. + + + + + a #ClapperGtkContainer + + + + + + Get a child #GtkWidget of @container. + + + #GtkWidget set as child. + + + + + a #ClapperGtkContainer + + + + + + Get a @container height target. + + + height target set by user or -1 when none. + + + + + a #ClapperGtkContainer + + + + + + Get a @container width target. + + + width target set by user or -1 when none. + + + + + a #ClapperGtkContainer + + + + + + Set an adaptive height threshold. When widget is resized to value or lower, +an [signal@ClapperGtk.Container::adapt] signal will be emitted with %TRUE to +notify implementation about mobile adaptation request, otherwise %FALSE when +both threshold values are exceeded. + + + + + + + a #ClapperGtkContainer + + + + a threshold on which adapt signal should be triggered or -1 to disable. + + + + + + Set an adaptive width threshold. When widget is resized to value or lower, +an [signal@ClapperGtk.Container::adapt] signal will be emitted with %TRUE to +notify implementation about mobile adaptation request, otherwise %FALSE when +both threshold values are exceeded. + + + + + + + a #ClapperGtkContainer + + + + a threshold on which adapt signal should be triggered or -1 to disable. + + + + + + Set a child #GtkWidget of @container. + + + + + + + a #ClapperGtkContainer + + + + a #GtkWidget + + + + + + Same as clapper_gtk_container_set_width_target() but for widget height. + + + + + + + a #ClapperGtkContainer + + + + height to target or -1 to restore default behavior + + + + + + Set a width that @container should target. When set container +will not stretch beyond set @width while still expanding into +possible boundaries trying to reach its target. + + + + + + + a #ClapperGtkContainer + + + + width to target -1 to restore default behavior + + + + + + Adaptive height threshold that triggers [signal@ClapperGtk.Container::adapt] signal. + + + + Adaptive width threshold that triggers [signal@ClapperGtk.Container::adapt] signal. + + + + Height that container should target. + + + + Width that container should target. + + + + + + + A helper signal for implementing mobile/narrow adaptive +behavior on descendants. + + + + + + %TRUE if narrowness reached adaptive threshold, %FALSE otherwise + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A menu button with extra options. + + + + + + Creates a new #ClapperGtkExtraMenuButton instance. + + + a new extra menu button #GtkWidget. + + + + + Get whether an option to open external subtitle stream inside popover is visible. + + + %TRUE if open subtitles is visible, %FALSE otherwise. + + + + + a #ClapperGtkExtraMenuButton + + + + + + Get whether speed control inside popover is visible. + + + %TRUE if speed control is visible, %FALSE otherwise. + + + + + a #ClapperGtkExtraMenuButton + + + + + + Get whether volume control inside popover is visible. + + + TRUE if volume control is visible, %FALSE otherwise. + + + + + a #ClapperGtkExtraMenuButton + + + + + + Set whether an option to open external subtitle stream should be allowed. + +Note that this [class@Gtk.Widget] can only add subtitles to currently playing +[class@Clapper.MediaItem]. When no media is selected, option to open subtitles +will not be shown regardless how this option is set. + + + + + + + a #ClapperGtkExtraMenuButton + + + + whether opening subtitles should be allowed + + + + + + Set whether speed control inside popover should be visible. + + + + + + + a #ClapperGtkExtraMenuButton + + + + whether visible + + + + + + Set whether volume control inside popover should be visible. + + + + + + + a #ClapperGtkExtraMenuButton + + + + whether visible + + + + + + Visibility of open subtitles option inside popover. + + + + Visibility of speed control inside popover. + + + + Visibility of volume control inside popover. + + + + A signal that user wants to open subtitles file. + +Implementation should add a way for user to select subtitles to open +such as by e.g. using [class@Gtk.FileDialog] and then add them to the +@item using [method@Clapper.MediaItem.set_suburi] method. + +This signal will pass the [class@Clapper.MediaItem] that was current when +user clicked the open button and subtitles should be added to this @item. +This avoids situations where another item starts playing before user selects +subtitles file to be opened. When using asynchronous operations to open file, +implementation should [method@GObject.Object.ref] the item to ensure that it +stays valid until finish. + +Note that this signal will not be emitted if open button is not visible by +setting [method@ClapperGtk.ExtraMenuButton.set_can_open_subtitles] to %TRUE, +so you do not have to implement handler for it otherwise. + + + + + + a #ClapperMediaItem + + + + + + + + + + + + + + + + + + + + A #ClapperGtkContainer that can take priority in user interactions with the #ClapperGtkVideo. + +#ClapperGtkLeadContainer is a special type of [class@ClapperGtk.Container] that can +lead in interaction events. When "leading", it is assumed that user interactions +over it which would normally trigger actions can be blocked/ignored when set in mask +of actions that this widget should block. + +This kind of container is useful when creating some statically visible overlays +covering top of [class@ClapperGtk.Video] that you want to take priority instead of +triggering default actions such as toggle play on click or revealing fading overlays. + +For more info how container widget works see [class@ClapperGtk.Container] documentation. + + + + + + Creates a new #ClapperGtkLeadContainer instance. + + + a new lead container #GtkWidget. + + + + + Get @actions that were set for this @lead_container to block. + + + a mask of actions that container blocks from being triggered on video. + + + + + a #ClapperGtkLeadContainer + + + + + + Get a whenever @lead_container has leadership set. + + + %TRUE if container is leading, %FALSE otherwise. + + + + + a #ClapperGtkLeadContainer + + + + + + Set @actions that #ClapperGtkVideo should skip when #GdkEvent which +would normally trigger them happens inside @lead_container. + + + + + + + a #ClapperGtkLeadContainer + + + + a #ClapperGtkVideoActionMask of actions to block + + + + + + Set if @lead_container leadership should be enabled. + +When enabled, interactions with @lead_container will not trigger +their default behavior, instead container and its contents will take priority. + + + + + + + a #ClapperGtkLeadContainer + + + + enable leadership + + + + + + Mask of actions that container blocks from being triggered on video. + + + + Width that container should target. + + + + + + + + + + + + + + + + + + + ClapperGtk major version component + + + + + ClapperGtk micro version component + + + + + ClapperGtk minor version component + + + + + + + + + + + + A #GtkButton for selecting next queue item. + + + + + + + Creates a new #ClapperGtkNextItemButton to play next #ClapperMediaItem. + + + a new next item button #GtkWidget. + + + + + + + + + + + + + + + + + + + A #GtkButton for selecting previous queue item. + + + + + + + Creates a new #ClapperGtkPreviousItemButton to play previous #ClapperMediaItem. + + + a new previous item button #GtkWidget. + + + + + + + + + + + + + + + + + + + + + + + + + + A bar for seeking and displaying playback position. + + + + + + Creates a new #ClapperGtkSeekBar instance. + + + a new seek bar #GtkWidget. + + + + + Get whether the position and duration labels are going to be revealed. + + + TRUE if the labels are going to be revealed, %FALSE otherwise. + + + + + a #ClapperGtkSeekBar + + + + + + Get [enum@Clapper.PlayerSeekMethod] used when seeking with seek bar. + + + #ClapperPlayerSeekMethod used for seeking. + + + + + a #ClapperGtkSeekBar + + + + + + Set whether the position and duration labels should be revealed. + + + + + + + a #ClapperGtkSeekBar + + + + whether to reveal labels + + + + + + Set [enum@Clapper.PlayerSeekMethod] to use when seeking with seek bar. + + + + + + + a #ClapperGtkSeekBar + + + + a #ClapperPlayerSeekMethod + + + + + + Reveal state of the position and duration labels. + + + + Method used for seeking. + + + + + + + + + + + A minimalistic playback controls panel widget. + +#ClapperGtkSimpleControls is a simple, ready to be used playback controls widget. +It is meant to be placed as an overlay (either fading or not) of [class@ClapperGtk.Video] +as-is, providing minimal yet universal playback controls for your app. + +If you need a further customized controls, please use individual widgets this +widget consists of to build your own controls implementation instead. + + + + + + Creates a new #ClapperGtkSimpleControls instance. + + + a new simple controls #GtkWidget. + + + + + Get [class@ClapperGtk.ExtraMenuButton] that resides within @controls. + + + #ClapperGtkExtraMenuButton within simple controls panel. + + + + + a #ClapperGtkSimpleControls + + + + + + Get whether [class@ClapperGtk.ToggleFullscreenButton] button in the @controls +is set to be visible. + + + %TRUE when fullscreenable, %FALSE otherwise. + + + + + a #ClapperGtkSimpleControls + + + + + + Get [enum@Clapper.PlayerSeekMethod] used when seeking with progress bar. + + + #ClapperPlayerSeekMethod used for seeking. + + + + + a #ClapperGtkSimpleControls + + + + + + Set whether [class@ClapperGtk.ToggleFullscreenButton] button in the @controls +should be visible. + +You might want to consider setting this to %FALSE, if your application +does not implement [signal@ClapperGtk.Video::toggle-fullscreen] signal. + + + + + + + a #ClapperGtkSimpleControls + + + + whether show button for toggling fullscreen state + + + + + + Set [enum@Clapper.PlayerSeekMethod] to use when seeking with progress bar. + + + + + + + a #ClapperGtkSimpleControls + + + + a #ClapperPlayerSeekMethod + + + + + + Access to extra menu button within controls. + + + + Whether toggle fullscreen button should be visible. + + + + Method used for seeking. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A header panel widget that displays current media title. + +#ClapperGtkTitleHeader is a simple, ready to be used header widget that +displays current media title. It can be placed as-is as a [class@ClapperGtk.Video] +overlay (either fading or not). + +If you need a further customized header, you can use [class@ClapperGtk.TitleLabel] +which is used by this widget to build your own implementation instead. + + + + + + Creates a new #ClapperGtkTitleHeader instance. + + + a new title header #GtkWidget. + + + + + Get currently displayed title by @header. + + + text of title label. + + + + + a #ClapperGtkTitleHeader + + + + + + Get whether a [property@Clapper.MediaItem:uri] property is going +be displayed as a header text when no other title could be determined. + + + %TRUE when item URI will be used as fallback, %FALSE otherwise. + + + + + a #ClapperGtkTitleHeader + + + + + + Set whether a [property@Clapper.MediaItem:uri] property should +be displayed as a header text when no other title could be determined. + + + + + + + a #ClapperGtkTitleHeader + + + + whether enabled + + + + + + Currently displayed title. + + + + When title cannot be determined, show URI instead. + + + + + + + + + + + A label showing an up to date title of media item. + +By default #ClapperGtkTitleLabel will automatically show title +of [property@Clapper.Queue:current-item] when placed within +[class@ClapperGtk.Video] widget hierarchy. + +Setting [property@ClapperGtk.TitleLabel:media-item] property will +make it show title of that particular [class@Clapper.MediaItem] +instead. Providing an item to read title from also allows using +this [class@Gtk.Widget] outside of [class@ClapperGtk.Video]. + + + + + + Creates a new #ClapperGtkTitleLabel instance. + + + a new title label #GtkWidget. + + + + + Get currently displayed title by @label. + + + text of title label. + + + + + a #ClapperGtkTitleLabel + + + + + + Get whether a [property@Clapper.MediaItem:uri] property is going +be displayed as a label text when no other title could be determined. + + + %TRUE when item URI will be used as fallback, %FALSE otherwise. + + + + + a #ClapperGtkTitleLabel + + + + + + Get currently set media item to display title of. + + + currently set media item. + + + + + a #ClapperGtkTitleLabel + + + + + + Set whether a [property@Clapper.MediaItem:uri] property should +be displayed as a label text when no other title could be determined. + + + + + + + a #ClapperGtkTitleLabel + + + + whether enabled + + + + + + Set a media item to display title of as label. When set to %NULL, +@label will use default behavior (showing title of current queue item). + + + + + + + a #ClapperGtkTitleLabel + + + + a #ClapperMediaItem + + + + + + Currently displayed title. + + + + When title cannot be determined, show URI instead. + + + + Currently set media item to display title of. + + + + + + + + + + + A #GtkButton for toggling fullscreen state. + + + + + + + Creates a new #ClapperGtkToggleFullscreenButton instance. + + + a new toggle fullscreen button #GtkWidget. + + + + + + + + + + + + A #GtkButton for toggling play/pause of playback. + + + + + + + Creates a new #ClapperGtkTogglePlayButton instance. + + + a new toggle play button #GtkWidget. + + + + + + + + + + + + ClapperGtk version, encoded as a string + + + + + + + + + + + + A ready to be used GTK video widget implementing Clapper API. + +#ClapperGtkVideo is the main widget exposed by `ClapperGtk` API. It both displays +videos played by [class@Clapper.Player] (exposed as its property) and manages +revealing and fading of any additional widgets overlaid on top of it. + +Other widgets provided by `ClapperGtk` library, once placed anywhere on video +(including nesting within another widget like [class@Gtk.Box]) will automatically +control #ClapperGtkVideo they were overlaid on top of. This allows to freely create +custom playback control panels best suited for specific application. Additionally, +pre-made widgets such as [class@ClapperGtk.SimpleControls] are also available. + +# Basic usage + +A typical use case is to embed video widget as part of your app where video playback +is needed. Get the [class@Clapper.Player] belonging to the video widget and start adding +new [class@Clapper.MediaItem] items to the [class@Clapper.Queue] for playback. +For more information please refer to the Clapper playback library documentation. + +#ClapperGtkVideo can automatically take care of revealing and later fading overlaid +content when interacting with the video. To do this, simply add your widgets with +[method@ClapperGtk.Video.add_fading_overlay]. If you want to display some static content +on top of video (or take care of visibility within overlaid widget itself) you can add +it to the video as a normal overlay with [method@ClapperGtk.Video.add_overlay]. + +# Actions + +#ClapperGtkVideo defines a set of built-in actions: + +```yaml +- "video.toggle-play": toggle play/pause +- "video.play": start/resume playback +- "video.pause": pause playback +- "video.stop": stop playback +- "video.seek": seek to position (variant "d") +- "video.seek-custom": seek to position using seek method (variant "(di)") +- "video.toggle-mute": toggle mute state +- "video.set-mute": set mute state (variant "b") +- "video.volume-up": increase volume by 2% +- "video.volume-down": decrease volume by 2% +- "video.set-volume": set volume to specified value (variant "d") +- "video.speed-up": increase speed (from 0.05x - 2x range to nearest quarter) +- "video.speed-down": decrease speed (from 0.05x - 2x range to nearest quarter) +- "video.set-speed": set speed to specified value (variant "d") +- "video.previous-item": select previous item in queue +- "video.next-item": select next item in queue +- "video.select-item": select item at specified index in queue (variant "u") +``` + +# ClapperGtkVideo as GtkBuildable + +#ClapperGtkVideo implementation of the [iface@Gtk.Buildable] interface supports +placing children as either normal overlay by specifying `overlay` or a fading +one by specifying `fading-overlay` as the `type` attribute of a `<child>` element. +Position of overlaid content is determined by `valign/halign` properties. + +```xml +<object class="ClapperGtkVideo" id="video"> + <child type="fading-overlay"> + <object class="ClapperGtkTitleHeader"> + <property name="valign">start</property> + </object> + </child> + <child type="fading-overlay"> + <object class="ClapperGtkSimpleControls"> + <property name="valign">end</property> + </object> + </child> +</object> +``` + + + + + + Creates a new #ClapperGtkVideo instance. + + + a new video #GtkWidget. + + + + + Similiar as clapper_gtk_video_add_overlay() but will also automatically +add fading functionality to overlaid #GtkWidget for convenience. This will +make widget reveal itself when interacting with @video and fade otherwise. +Useful when placing widgets such as playback controls panels. + + + + + + + a #ClapperGtkVideo + + + + a #GtkWidget + + + + + + Add another #GtkWidget to be overlaid on top of video. + +The position at which @widget is placed is determined from +[property@Gtk.Widget:halign] and [property@Gtk.Widget:valign] properties. + +This function will overlay @widget as-is meaning that widget is responsible +for managing its own visablity if needed. If you want to add a #GtkWidget +that will reveal and fade itself automatically when interacting with @video +(e.g. controls panel) you can use clapper_gtk_video_add_fading_overlay() +function for convenience. + + + + + + + a #ClapperGtkVideo + + + + a #GtkWidget + + + + + + Get whether automatic session inhibit is enabled. + + + %TRUE if enabled, %FALSE otherwise. + + + + + a #ClapperGtkVideo + + + + + + Get time in milliseconds after which fading overlays should fade. + + + currently set fade delay. + + + + + a #ClapperGtkVideo + + + + + + Get whether session is currently inhibited by +[property@ClapperGtk.Video:auto-inhibit]. + + + %TRUE if inhibited, %FALSE otherwise. + + + + + a #ClapperGtkVideo + + + + + + Get #ClapperPlayer used by this #ClapperGtkVideo instance. + + + a #ClapperPlayer used by video. + + + + + a #ClapperGtkVideo + + + + + + Get time in milliseconds after which fading overlays should fade +when revealed using touch device. + + + currently set touch fade delay. + + + + + a #ClapperGtkVideo + + + + + + Set whether video should try to automatically inhibit session +from idling (and possibly screen going black) when video is playing. + + + + + + + a #ClapperGtkVideo + + + + whether to enable automatic session inhibit + + + + + + Set time in milliseconds after which fading overlays should fade. + + + + + + + a #ClapperGtkVideo + + + + a fade delay + + + + + + Set time in milliseconds after which fading overlays should fade +when using touchscreen. + +It is often useful to set this higher then normal fade delay property, +as in case of touch events user do not have a moving pointer that would +extend fade timeout, so he can have more time to decide what to press next. + + + + + + + a #ClapperGtkVideo + + + + a touch fade delay + + + + + + Try to automatically inhibit session when video is playing. + + + + A delay in milliseconds before trying to fade all fading overlays. + + + + Get whether session is currently inhibited by the video. + + + + A #ClapperPlayer used by video. + + + + A delay in milliseconds before trying to fade all fading overlays +after revealed using touchscreen. + + + + A helper signal for implementing common seeking by double tap +on screen side for touchscreen devices. + +Note that @forward already takes into account RTL direction, +so implementation does not have to check. + + + + + + %TRUE if seek should be forward, %FALSE if backward + + + + + + A signal that user requested a change in fullscreen state of the video. + +Note that when going fullscreen from this signal, user will expect +for only video to be fullscreened and not the whole app window. +It is up to implementation to decide how to handle that. + + + + + + + + No action + + + Reveal fading overlays + + + Toggle playback (triggered by single click/tap) + + + Toggle fullscreen (triggered by double click/tap) + + + Seek request (triggered by double tap on screen side) + + + All of the above + + + + + + + + + + Get [class@Clapper.Player] used by [class@ClapperGtk.Video] ancestor of @widget. + +This utility is a convenience wrapper for calling [method@Gtk.Widget.get_ancestor] +of type `CLAPPER_GTK_TYPE_VIDEO` and [method@ClapperGtk.Video.get_player] with +additional %NULL checking and type casting. + +This is meant to be used mainly for custom widget development as an easy access to the +underlying parent [class@Clapper.Player] object. If you want to get the player from +[class@ClapperGtk.Video] widget itself, use [method@ClapperGtk.Video.get_player] instead. + +Rememeber that this function will return %NULL when widget does not have +a [class@ClapperGtk.Video] ancestor in widget hierarchy (widget is not yet placed). + + + a #ClapperPlayer from ancestor of a @widget. + + + + + a #GtkWidget + + + + + + + + + + + + diff --git a/girs/Cogl-1.0.gir b/girs/Cogl-1.0.gir index 0d9ad3728..a9aa38e12 100644 --- a/girs/Cogl-1.0.gir +++ b/girs/Cogl-1.0.gir @@ -120,7 +120,7 @@ notation. c:type="CoglAttributeType"> Data types for the components of a vertex attribute. + line="671">Data types for the components of a vertex attribute. glib:name="COGL_ATTRIBUTE_TYPE_BYTE"> Data is the same size of a byte + line="673">Data is the same size of a byte glib:name="COGL_ATTRIBUTE_TYPE_UNSIGNED_BYTE"> Data is the same size of an + line="674">Data is the same size of an unsigned byte glib:name="COGL_ATTRIBUTE_TYPE_SHORT"> Data is the same size of a short integer + line="676">Data is the same size of a short integer glib:name="COGL_ATTRIBUTE_TYPE_UNSIGNED_SHORT"> Data is the same size of + line="677">Data is the same size of an unsigned short integer glib:name="COGL_ATTRIBUTE_TYPE_FLOAT"> Data is the same size of a float + line="679">Data is the same size of a float @@ -309,7 +309,7 @@ will be used directly. c:type="CoglBlendStringError"> Error enumeration for the blend strings parser + line="609">Error enumeration for the blend strings parser glib:name="COGL_BLEND_STRING_ERROR_PARSE_ERROR"> Generic parse error + line="611">Generic parse error glib:name="COGL_BLEND_STRING_ERROR_ARGUMENT_PARSE_ERROR"> Argument parse error + line="612">Argument parse error glib:name="COGL_BLEND_STRING_ERROR_INVALID_ERROR"> Internal parser error + line="613">Internal parser error glib:name="COGL_BLEND_STRING_ERROR_GPU_UNSUPPORTED_ERROR"> Blend string not + line="614">Blend string not supported by the GPU - + @@ -361,7 +361,7 @@ will be used directly. c:type="CoglBufferBit"> Types of auxiliary buffers + line="896">Types of auxiliary buffers glib:name="COGL_BUFFER_BIT_COLOR"> Selects the primary color buffer + line="898">Selects the primary color buffer glib:name="COGL_BUFFER_BIT_DEPTH"> Selects the depth buffer + line="899">Selects the depth buffer glib:name="COGL_BUFFER_BIT_STENCIL"> Selects the stencil buffer + line="900">Selects the stencil buffer c:type="CoglBufferTarget"> Target flags for FBOs. + line="477">Target flags for FBOs. glib:name="COGL_WINDOW_BUFFER"> FIXME + line="479">FIXME glib:name="COGL_OFFSCREEN_BUFFER"> FIXME + line="480">FIXME c:symbol-prefix="color"> A structure for holding a color definition. The contents of + line="492">A structure for holding a color definition. The contents of the CoglColor structure are private and should never by accessed directly. - + @@ -1444,7 +1444,7 @@ values into a #CoglColor. c:type="CoglColorMask"> Defines a bit mask of color channels. This can be used with + line="855">Defines a bit mask of color channels. This can be used with cogl_pipeline_set_color_mask() for example to define which color channels should be written to the current framebuffer when drawing something. @@ -1455,7 +1455,7 @@ drawing something. glib:name="COGL_COLOR_MASK_NONE"> None of the color channels are masked + line="857">None of the color channels are masked glib:name="COGL_COLOR_MASK_RED"> Masks the red color channel + line="858">Masks the red color channel glib:name="COGL_COLOR_MASK_GREEN"> Masks the green color channel + line="859">Masks the green color channel glib:name="COGL_COLOR_MASK_BLUE"> Masks the blue color channel + line="860">Masks the blue color channel glib:name="COGL_COLOR_MASK_ALPHA"> Masks the alpha color channel + line="861">Masks the alpha color channel glib:name="COGL_COLOR_MASK_ALL"> All of the color channels are masked + line="862">All of the color channels are masked @@ -1513,7 +1513,7 @@ drawing something. c:type="CoglDepthTestFunction"> When using depth testing one of these functions is used to compare + line="751">When using depth testing one of these functions is used to compare the depth of an incoming fragment against the depth value currently stored in the depth buffer. The function is changed using cogl_depth_state_set_test_function(). @@ -1527,7 +1527,7 @@ cogl_depth_state_set_test_enabled()) glib:name="COGL_DEPTH_TEST_FUNCTION_NEVER"> Never passes. + line="753">Never passes. glib:name="COGL_DEPTH_TEST_FUNCTION_LESS"> Passes if the fragment's depth + line="754">Passes if the fragment's depth value is less than the value currently in the depth buffer. glib:name="COGL_DEPTH_TEST_FUNCTION_EQUAL"> Passes if the fragment's depth + line="756">Passes if the fragment's depth value is equal to the value currently in the depth buffer. glib:name="COGL_DEPTH_TEST_FUNCTION_LEQUAL"> Passes if the fragment's depth + line="758">Passes if the fragment's depth value is less or equal to the value currently in the depth buffer. glib:name="COGL_DEPTH_TEST_FUNCTION_GREATER"> Passes if the fragment's depth + line="760">Passes if the fragment's depth value is greater than the value currently in the depth buffer. glib:name="COGL_DEPTH_TEST_FUNCTION_NOTEQUAL"> Passes if the fragment's depth + line="762">Passes if the fragment's depth value is not equal to the value currently in the depth buffer. glib:name="COGL_DEPTH_TEST_FUNCTION_GEQUAL"> Passes if the fragment's depth + line="764">Passes if the fragment's depth value greater than or equal to the value currently in the depth buffer. glib:name="COGL_DEPTH_TEST_FUNCTION_ALWAYS"> Always passes. + line="766">Always passes. @@ -2256,6 +2256,12 @@ the fractional part without rounding. line="441">Whether #CoglFramebuffer support rendering the depth buffer to a texture. + + c:type="CoglFilterReturn"> Return values for the #CoglXlibFilterFunc and #CoglWin32FilterFunc functions. + line="793">Return values for the #CoglXlibFilterFunc and #CoglWin32FilterFunc functions. glib:name="COGL_FILTER_CONTINUE"> The event was not handled, continues the + line="795">The event was not handled, continues the processing glib:name="COGL_FILTER_REMOVE"> Remove the event, stops the processing + line="797">Remove the event, stops the processing c:type="CoglFogMode"> The fog mode determines the equation used to calculate the fogging blend + line="566">The fog mode determines the equation used to calculate the fogging blend factor while fogging is enabled. The simplest %COGL_FOG_MODE_LINEAR mode determines f as: @@ -2540,7 +2546,7 @@ coordinates from the origin. glib:name="COGL_FOG_MODE_LINEAR"> Calculates the fog blend factor as: + line="568">Calculates the fog blend factor as: |[ f = end - eye_distance / end - start ]| @@ -2552,7 +2558,7 @@ coordinates from the origin. glib:name="COGL_FOG_MODE_EXPONENTIAL"> Calculates the fog blend factor as: + line="572">Calculates the fog blend factor as: |[ f = e ^ -(density * eye_distance) ]| @@ -2564,7 +2570,7 @@ coordinates from the origin. glib:name="COGL_FOG_MODE_EXPONENTIAL_SQUARED"> Calculates the fog blend factor as: + line="576">Calculates the fog blend factor as: |[ f = e ^ -(density * eye_distance)^2 ]| @@ -2587,7 +2593,7 @@ actual arguments and return type may be different. c:type="CoglIndicesType"> You should aim to use the smallest data type that gives you enough + line="693">You should aim to use the smallest data type that gives you enough range, since it reduces the size of your index array and can help reduce the demand on memory bandwidth. @@ -2603,7 +2609,7 @@ advertized. glib:name="COGL_INDICES_TYPE_UNSIGNED_BYTE"> Your indices are unsigned bytes + line="695">Your indices are unsigned bytes glib:name="COGL_INDICES_TYPE_UNSIGNED_SHORT"> Your indices are unsigned shorts + line="696">Your indices are unsigned shorts glib:name="COGL_INDICES_TYPE_UNSIGNED_INT"> Your indices are unsigned ints + line="697">Your indices are unsigned ints c:type="CoglReadPixelsFlags"> Flags for cogl_framebuffer_read_pixels_into_bitmap() + line="912">Flags for cogl_framebuffer_read_pixels_into_bitmap() glib:name="COGL_READ_PIXELS_COLOR_BUFFER"> Read from the color buffer + line="914">Read from the color buffer c:type="CoglStereoMode"> Represents how draw should affect the two buffers + line="924">Represents how draw should affect the two buffers of a stereo framebuffer. See cogl_framebuffer_set_stereo_mode(). glib:name="COGL_STEREO_BOTH"> draw to both stereo buffers + line="926">draw to both stereo buffers glib:name="COGL_STEREO_LEFT"> draw only to the left stereo buffer + line="927">draw only to the left stereo buffer glib:name="COGL_STEREO_RIGHT"> draw only to the left stereo buffer + line="928">draw only to the left stereo buffer c:type="CoglSystemError"> Error enumeration for Cogl + line="633">Error enumeration for Cogl The @COGL_SYSTEM_ERROR_UNSUPPORTED error can be thrown for a variety of reasons. For example: @@ -6206,7 +6212,7 @@ this enum should also be considered experimental. glib:name="COGL_SYSTEM_ERROR_UNSUPPORTED"> You tried to use a feature or + line="635">You tried to use a feature or configuration not currently available. glib:name="COGL_SYSTEM_ERROR_NO_MEMORY"> You tried to allocate a resource + line="637">You tried to allocate a resource such as a texture and there wasn't enough memory. @@ -6297,7 +6303,7 @@ this enum should also be considered experimental. Explicitly allocates the storage for the given @texture which + line="509">Explicitly allocates the storage for the given @texture which allows you to be sure that there is enough memory for the texture and if not then the error can be handled gracefully. @@ -6305,11 +6311,11 @@ texture and if not then the error can be handled gracefully. since the texture will be implicitly allocated when data is set on the texture, or if the texture is attached to a #CoglOffscreen framebuffer and rendered too.</note> - + %TRUE if the texture was successfully allocated, + line="523">%TRUE if the texture was successfully allocated, otherwise %FALSE and @error will be updated if it wasn't %NULL. @@ -6318,9 +6324,38 @@ framebuffer and rendered too.</note> A #CoglTexture + line="511">A #CoglTexture + + + + + + + + + + + + + + + + + + + + + + + + + + + + + c:type="CoglTextureFlags"> Flags to pass to the cogl_texture_new_* family of functions. + line="543">Flags to pass to the cogl_texture_new_* family of functions. glib:name="COGL_TEXTURE_NONE"> No flags specified + line="545">No flags specified glib:name="COGL_TEXTURE_NO_AUTO_MIPMAP"> Disables the automatic generation of + line="546">Disables the automatic generation of the mipmap pyramid from the base level image whenever it is updated. The mipmaps are only generated when the texture is rendered with a mipmap filter so it should be free to leave out @@ -6877,7 +6912,7 @@ specified) glib:name="COGL_TEXTURE_NO_SLICING"> Disables the slicing of the texture + line="551">Disables the slicing of the texture glib:name="COGL_TEXTURE_NO_ATLAS"> Disables the insertion of the texture inside + line="552">Disables the insertion of the texture inside the texture atlas used by Cogl @@ -6931,42 +6966,42 @@ specified) Used to specify vertex information when calling cogl_polygon() - + line="522">Used to specify vertex information when calling cogl_polygon() + Model x-coordinate + line="524">Model x-coordinate Model y-coordinate + line="525">Model y-coordinate Model z-coordinate + line="526">Model z-coordinate Texture x-coordinate + line="527">Texture x-coordinate Texture y-coordinate + line="528">Texture y-coordinate The color to use at this vertex. This is ignored if + line="529">The color to use at this vertex. This is ignored if use_color is %FALSE when calling cogl_polygon() @@ -6978,7 +7013,7 @@ specified) c:type="CoglVerticesMode"> Different ways of interpreting vertices when drawing. + line="715">Different ways of interpreting vertices when drawing. glib:name="COGL_VERTICES_MODE_POINTS"> FIXME, equivalent to + line="717">FIXME, equivalent to <constant>GL_POINTS</constant> glib:name="COGL_VERTICES_MODE_LINES"> FIXME, equivalent to <constant>GL_LINES</constant> + line="719">FIXME, equivalent to <constant>GL_LINES</constant> glib:name="COGL_VERTICES_MODE_LINE_LOOP"> FIXME, equivalent to + line="720">FIXME, equivalent to <constant>GL_LINE_LOOP</constant> glib:name="COGL_VERTICES_MODE_LINE_STRIP"> FIXME, equivalent to + line="722">FIXME, equivalent to <constant>GL_LINE_STRIP</constant> glib:name="COGL_VERTICES_MODE_TRIANGLES"> FIXME, equivalent to + line="724">FIXME, equivalent to <constant>GL_TRIANGLES</constant> glib:name="COGL_VERTICES_MODE_TRIANGLE_STRIP"> FIXME, equivalent to + line="726">FIXME, equivalent to <constant>GL_TRIANGLE_STRIP</constant> glib:name="COGL_VERTICES_MODE_TRIANGLE_FAN"> FIXME, equivalent to <constant>GL_TRIANGLE_FAN</constant> + line="728">FIXME, equivalent to <constant>GL_TRIANGLE_FAN</constant> c:type="CoglWinding"> Enum used to represent the two directions of rotation. This can be + line="881">Enum used to represent the two directions of rotation. This can be used to set the front face for culling by calling cogl_pipeline_set_front_face_winding(). glib:name="COGL_WINDING_CLOCKWISE"> Vertices are in a clockwise order + line="883">Vertices are in a clockwise order glib:name="COGL_WINDING_COUNTER_CLOCKWISE"> Vertices are in a counter-clockwise order + line="884">Vertices are in a counter-clockwise order - + @@ -7190,7 +7225,7 @@ cogl_pipeline_set_front_face_winding(). - + @@ -7357,7 +7392,7 @@ OpenGL. - + diff --git a/girs/Colord-1.0.gir b/girs/Colord-1.0.gir index 36c95b1c2..8650f1f21 100644 --- a/girs/Colord-1.0.gir +++ b/girs/Colord-1.0.gir @@ -7566,12 +7566,12 @@ Do not use it in GUI applications. Creates a new #CdIcc object. + line="4091">Creates a new #CdIcc object. a new CdIcc object. + line="4096">a new CdIcc object. @@ -7590,7 +7590,7 @@ Do not use it in GUI applications. version="0.1.32"> Sets an item of data to the profile metadata, overwriting it if + line="2298">Sets an item of data to the profile metadata, overwriting it if it already exists. @@ -7600,19 +7600,19 @@ it already exists. A valid #CdIcc + line="2300">A valid #CdIcc the metadata key + line="2301">the metadata key the UTF-8 metadata value + line="2302">the UTF-8 metadata value @@ -7623,19 +7623,19 @@ it already exists. throws="1"> Creates a default sRGB ICC profile. + line="3103">Creates a default sRGB ICC profile. %TRUE for success + line="3110">%TRUE for success A valid #CdIcc + line="3105">A valid #CdIcc @@ -7646,25 +7646,25 @@ it already exists. throws="1"> Creates a default sRGB ICC profile. + line="3046">Creates a default sRGB ICC profile. %TRUE for success + line="3054">%TRUE for success A valid #CdIcc + line="3048">A valid #CdIcc a set of #CdIccLoadFlags + line="3049">a set of #CdIccLoadFlags @@ -7675,49 +7675,49 @@ it already exists. throws="1"> Creates an ICC profile from EDID data. + line="3182">Creates an ICC profile from EDID data. %TRUE for success + line="3194">%TRUE for success A valid #CdIcc + line="3184">A valid #CdIcc approximate device gamma + line="3185">approximate device gamma primary color value + line="3186">primary color value primary color value + line="3187">primary color value primary color value + line="3188">primary color value whitepoint value + line="3189">whitepoint value @@ -7728,25 +7728,25 @@ it already exists. throws="1"> Creates an ICC profile from EDID data. + line="3120">Creates an ICC profile from EDID data. %TRUE for success + line="3128">%TRUE for success A valid #CdIcc + line="3122">A valid #CdIcc EDID data + line="3123">EDID data @@ -7757,21 +7757,21 @@ it already exists. version="0.1.32"> Gets the profile red chromaticity value. + line="3006">Gets the profile red chromaticity value. This function will only return results if the profile was loaded with the %CD_ICC_LOAD_FLAGS_PRIMARIES flag. the #CdColorXYZ value + line="3014">the #CdColorXYZ value a valid #CdIcc instance + line="3008">a valid #CdIcc instance @@ -7782,21 +7782,21 @@ This function will only return results if the profile was loaded with the version="0.1.32"> Finds out if the profile could be deleted. + line="2430">Finds out if the profile could be deleted. This is only applicable for profiles loaded with cd_icc_load_file() as obviously data and fd's cannot be sanely unlinked. %TRUE if g_file_delete() would likely work + line="2438">%TRUE if g_file_delete() would likely work a #CdIcc instance. + line="2432">a #CdIcc instance. @@ -7806,21 +7806,21 @@ obviously data and fd's cannot be sanely unlinked. version="1.1.1"> Gets any characterization data used to build the profile. + line="1759">Gets any characterization data used to build the profile. This function will only return results if the profile was loaded with the %CD_ICC_LOAD_FLAGS_CHARACTERIZATION flag. TI3 string data + line="1767">TI3 string data a #CdIcc instance. + line="1761">a #CdIcc instance. @@ -7831,7 +7831,7 @@ This function will only return results if the profile was loaded with the version="0.1.32"> Gets the profile checksum if one exists. + line="2505">Gets the profile checksum if one exists. This will either be the embedded profile ID, or the file checksum if the #CdIcc object was loaded using cd_icc_load_data() or cd_icc_load_file() and the %CD_ICC_LOAD_FLAGS_FALLBACK_MD5 flag is used. @@ -7839,14 +7839,14 @@ and the %CD_ICC_LOAD_FLAGS_FALLBACK_MD5 flag is used. An embedded MD5 checksum, or %NULL for not set + line="2514">An embedded MD5 checksum, or %NULL for not set A valid #CdIcc + line="2507">A valid #CdIcc @@ -7857,19 +7857,19 @@ and the %CD_ICC_LOAD_FLAGS_FALLBACK_MD5 flag is used. version="0.1.32"> Gets the profile colorspace + line="2224">Gets the profile colorspace The profile colorspace, e.g. %CD_COLORSPACE_RGB + line="2230">The profile colorspace, e.g. %CD_COLORSPACE_RGB a #CdIcc instance. + line="2226">a #CdIcc instance. @@ -7879,20 +7879,20 @@ and the %CD_ICC_LOAD_FLAGS_FALLBACK_MD5 flag is used. version="1.1.7"> Return the cmsContext instance used locally. This may be required if you + line="2044">Return the cmsContext instance used locally. This may be required if you are using native LCMS calls and then cd_icc_load_handle(). Do not call cmsDeleteContext() on this value! + line="2051">Do not call cmsDeleteContext() on this value! a #CdIcc instance. + line="2046">a #CdIcc instance. @@ -7903,14 +7903,14 @@ are using native LCMS calls and then cd_icc_load_handle(). throws="1"> Gets the profile copyright. + line="2676">Gets the profile copyright. If the translated text is not available in the selected locale then the default untranslated (en_US) text is returned. The text as a UTF-8 string, or %NULL of the locale is invalid + line="2686">The text as a UTF-8 string, or %NULL of the locale is invalid or the tag does not exist. @@ -7918,13 +7918,13 @@ default untranslated (en_US) text is returned. A valid #CdIcc + line="2678">A valid #CdIcc A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default + line="2679">A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default @@ -7934,19 +7934,19 @@ default untranslated (en_US) text is returned. version="0.1.32"> Gets the ICC creation date and time. + line="2450">Gets the ICC creation date and time. A #GDateTime object, or %NULL for not set + line="2456">A #GDateTime object, or %NULL for not set A valid #CdIcc + line="2452">A valid #CdIcc @@ -7957,14 +7957,14 @@ default untranslated (en_US) text is returned. throws="1"> Gets the profile description. + line="2648">Gets the profile description. If the translated text is not available in the selected locale then the default untranslated (en_US) text is returned. The text as a UTF-8 string, or %NULL of the locale is invalid + line="2658">The text as a UTF-8 string, or %NULL of the locale is invalid or the tag does not exist. @@ -7972,13 +7972,13 @@ default untranslated (en_US) text is returned. A valid #CdIcc + line="2650">A valid #CdIcc A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default + line="2651">A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default @@ -7989,19 +7989,19 @@ default untranslated (en_US) text is returned. version="0.1.32"> Gets the filename of the ICC data, if one exists. + line="2134">Gets the filename of the ICC data, if one exists. A filename, or %NULL + line="2140">A filename, or %NULL A valid #CdIcc + line="2136">A valid #CdIcc @@ -8012,21 +8012,21 @@ default untranslated (en_US) text is returned. version="0.1.32"> Gets the profile green chromaticity value. + line="2986">Gets the profile green chromaticity value. This function will only return results if the profile was loaded with the %CD_ICC_LOAD_FLAGS_PRIMARIES flag. the #CdColorXYZ value + line="2994">the #CdColorXYZ value a valid #CdIcc instance + line="2988">a valid #CdIcc instance @@ -8034,20 +8034,20 @@ This function will only return results if the profile was loaded with the Return the cmsHPROFILE instance used locally. This may be required if you + line="2027">Return the cmsHPROFILE instance used locally. This may be required if you are using the profile in a transform. Do not call cmsCloseProfile() on this value! + line="2034">Do not call cmsCloseProfile() on this value! a #CdIcc instance. + line="2029">a #CdIcc instance. @@ -8058,19 +8058,19 @@ are using the profile in a transform. version="0.1.32"> Gets the profile kind. + line="2188">Gets the profile kind. The kind, e.g. %CD_PROFILE_KIND_INPUT + line="2194">The kind, e.g. %CD_PROFILE_KIND_INPUT a #CdIcc instance. + line="2190">a #CdIcc instance. @@ -8081,14 +8081,14 @@ are using the profile in a transform. throws="1"> Gets the profile manufacturer. + line="2702">Gets the profile manufacturer. If the translated text is not available in the selected locale then the default untranslated (en_US) text is returned. The text as a UTF-8 string, or %NULL of the locale is invalid + line="2712">The text as a UTF-8 string, or %NULL of the locale is invalid or the tag does not exist. @@ -8096,13 +8096,13 @@ default untranslated (en_US) text is returned. A valid #CdIcc + line="2704">A valid #CdIcc A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default + line="2705">A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default @@ -8112,12 +8112,12 @@ default untranslated (en_US) text is returned. version="0.1.32"> Gets all the metadata from the ICC profile. + line="2260">Gets all the metadata from the ICC profile. The profile metadata + line="2266">The profile metadata @@ -8127,7 +8127,7 @@ default untranslated (en_US) text is returned. A valid #CdIcc + line="2262">A valid #CdIcc @@ -8137,25 +8137,25 @@ default untranslated (en_US) text is returned. version="0.1.32"> Gets an item of data from the ICC metadata store. + line="2278">Gets an item of data from the ICC metadata store. The dictionary data, or %NULL if the key does not exist. + line="2285">The dictionary data, or %NULL if the key does not exist. A valid #CdIcc + line="2280">A valid #CdIcc the dictionary key + line="2281">the dictionary key @@ -8166,14 +8166,14 @@ default untranslated (en_US) text is returned. throws="1"> Gets the profile model. + line="2728">Gets the profile model. If the translated text is not available in the selected locale then the default untranslated (en_US) text is returned. The text as a UTF-8 string, or %NULL of the locale is invalid + line="2738">The text as a UTF-8 string, or %NULL of the locale is invalid or the tag does not exist. @@ -8181,13 +8181,13 @@ default untranslated (en_US) text is returned. A valid #CdIcc + line="2730">A valid #CdIcc A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default + line="2731">A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default @@ -8197,14 +8197,14 @@ default untranslated (en_US) text is returned. version="0.1.32"> Gets any named colors in the profile. + line="2410">Gets any named colors in the profile. This function will only return results if the profile was loaded with the %CD_ICC_LOAD_FLAGS_NAMED_COLORS flag. An array of color swatches + line="2418">An array of color swatches @@ -8213,7 +8213,7 @@ This function will only return results if the profile was loaded with the a #CdIcc instance. + line="2412">a #CdIcc instance. @@ -8224,21 +8224,21 @@ This function will only return results if the profile was loaded with the version="0.1.32"> Gets the profile red chromaticity value. + line="2966">Gets the profile red chromaticity value. This function will only return results if the profile was loaded with the %CD_ICC_LOAD_FLAGS_PRIMARIES flag. the #CdColorXYZ value + line="2974">the #CdColorXYZ value a valid #CdIcc instance + line="2968">a valid #CdIcc instance @@ -8249,12 +8249,12 @@ This function will only return results if the profile was loaded with the throws="1"> Generates a response curve of a specified size. + line="3325">Generates a response curve of a specified size. response data, or %NULL for error + line="3333">response data, or %NULL for error @@ -8263,13 +8263,13 @@ This function will only return results if the profile was loaded with the A valid #CdIcc + line="3327">A valid #CdIcc the size of the curve to generate + line="3328">the size of the curve to generate @@ -8280,12 +8280,12 @@ This function will only return results if the profile was loaded with the version="0.1.32"> Gets the ICC profile file size + line="2117">Gets the ICC profile file size The size in bytes, or 0 for unknown. + line="2122">The size in bytes, or 0 for unknown. @@ -8355,21 +8355,21 @@ Most users do not need to do this. version="0.1.32"> Gets the ICC color temperature, rounded to the nearest 100K. + line="2946">Gets the ICC color temperature, rounded to the nearest 100K. This function will only return results if the profile was loaded with the %CD_ICC_LOAD_FLAGS_PRIMARIES flag. The color temperature in Kelvin, or 0 for error. + line="2954">The color temperature in Kelvin, or 0 for error. A valid #CdIcc + line="2948">A valid #CdIcc @@ -8380,12 +8380,12 @@ This function will only return results if the profile was loaded with the throws="1"> Gets the video card calibration data from the profile. + line="3275">Gets the video card calibration data from the profile. VCGT data, or %NULL for error + line="3283">VCGT data, or %NULL for error @@ -8394,13 +8394,13 @@ This function will only return results if the profile was loaded with the A valid #CdIcc + line="3277">A valid #CdIcc the desired size of the table data + line="3278">the desired size of the table data @@ -8411,19 +8411,19 @@ This function will only return results if the profile was loaded with the version="0.1.32"> Gets the ICC profile version, typically 2.1 or 4.2 + line="2152">Gets the ICC profile version, typically 2.1 or 4.2 A floating point version number, or 0.0 for unknown + line="2158">A floating point version number, or 0.0 for unknown a #CdIcc instance. + line="2154">a #CdIcc instance. @@ -8433,12 +8433,12 @@ This function will only return results if the profile was loaded with the version="0.1.34"> Returns any warnings with profiles + line="3789">Returns any warnings with profiles An array of warning values + line="3795">An array of warning values @@ -8447,7 +8447,7 @@ This function will only return results if the profile was loaded with the a #CdIcc instance. + line="3791">a #CdIcc instance. @@ -8458,21 +8458,21 @@ This function will only return results if the profile was loaded with the version="0.1.32"> Gets the profile white point. + line="3026">Gets the profile white point. This function will only return results if the profile was loaded with the %CD_ICC_LOAD_FLAGS_PRIMARIES flag. the #CdColorXYZ value + line="3034">the #CdColorXYZ value a valid #CdIcc instance + line="3028">a valid #CdIcc instance @@ -8523,7 +8523,7 @@ This function will only return results if the profile was loaded with the throws="1"> Loads an ICC profile from an open file descriptor. + line="1979">Loads an ICC profile from an open file descriptor. @@ -8532,19 +8532,19 @@ This function will only return results if the profile was loaded with the a #CdIcc instance. + line="1981">a #CdIcc instance. a file descriptor + line="1982">a file descriptor a set of #CdIccLoadFlags + line="1983">a set of #CdIccLoadFlags @@ -8555,7 +8555,7 @@ This function will only return results if the profile was loaded with the throws="1"> Loads an ICC profile from a local or remote file. + line="1907">Loads an ICC profile from a local or remote file. @@ -8564,19 +8564,19 @@ This function will only return results if the profile was loaded with the a #CdIcc instance. + line="1909">a #CdIcc instance. a #GFile + line="1910">a #GFile a set of #CdIccLoadFlags + line="1911">a set of #CdIccLoadFlags A #GCancellable or %NULL + line="1912">A #GCancellable or %NULL @@ -8596,7 +8596,7 @@ This function will only return results if the profile was loaded with the throws="1"> Set the internal cmsHPROFILE instance. This may be required if you create + line="2063">Set the internal cmsHPROFILE instance. This may be required if you create the profile using cmsCreateRGBProfileTHR() and then want to use the functionality in #CdIcc. @@ -8618,7 +8618,7 @@ be called if cd_icc_load_file() has previously been used on the @icc object. a #CdIcc instance. + line="2065">a #CdIcc instance. a cmsHPROFILE instance + line="2066">a cmsHPROFILE instance a set of #CdIccLoadFlags + line="2067">a set of #CdIccLoadFlags @@ -8643,7 +8643,7 @@ be called if cd_icc_load_file() has previously been used on the @icc object. Removes an item of metadata. + line="2323">Removes an item of metadata. @@ -8652,13 +8652,13 @@ be called if cd_icc_load_file() has previously been used on the @icc object. A valid #CdIcc + line="2325">A valid #CdIcc the metadata key + line="2326">the metadata key @@ -8697,7 +8697,7 @@ Return vale: A #GBytes structure, or %NULL for error throws="1"> Saves an ICC profile to the default per-user location. + line="1855">Saves an ICC profile to the default per-user location. Return vale: %TRUE for success. @@ -8708,13 +8708,13 @@ Return vale: %TRUE for success. a #CdIcc instance. + line="1857">a #CdIcc instance. a set of #CdIccSaveFlags + line="1858">a set of #CdIccSaveFlags allow-none="1"> A #GCancellable or %NULL + line="1859">A #GCancellable or %NULL @@ -8734,7 +8734,7 @@ Return vale: %TRUE for success. throws="1"> Saves an ICC profile to a local or remote file. + line="1797">Saves an ICC profile to a local or remote file. Return vale: %TRUE for success. @@ -8745,19 +8745,19 @@ Return vale: %TRUE for success. a #CdIcc instance. + line="1799">a #CdIcc instance. a #GFile + line="1800">a #GFile a set of #CdIccSaveFlags + line="1801">a set of #CdIccSaveFlags allow-none="1"> A #GCancellable or %NULL + line="1802">A #GCancellable or %NULL @@ -8776,7 +8776,7 @@ Return vale: %TRUE for success. version="1.1.1"> Sets the characterization data used to build the profile. + line="1779">Sets the characterization data used to build the profile. @@ -8785,13 +8785,13 @@ Return vale: %TRUE for success. a #CdIcc instance. + line="1781">a #CdIcc instance. TI3 string data, or %NULL + line="1782">TI3 string data, or %NULL @@ -8802,7 +8802,7 @@ Return vale: %TRUE for success. version="0.1.32"> Sets the colorspace kind. + line="2242">Sets the colorspace kind. @@ -8811,13 +8811,13 @@ Return vale: %TRUE for success. a #CdIcc instance. + line="2244">a #CdIcc instance. the profile colorspace, e.g. %CD_COLORSPACE_RGB + line="2245">the profile colorspace, e.g. %CD_COLORSPACE_RGB @@ -8827,7 +8827,7 @@ Return vale: %TRUE for success. version="0.1.32"> Sets the profile _copyright for a specific locale. + line="2802">Sets the profile _copyright for a specific locale. @@ -8836,13 +8836,13 @@ Return vale: %TRUE for success. A valid #CdIcc + line="2804">A valid #CdIcc A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default + line="2805">A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default allow-none="1"> New UTF-8 string value + line="2806">New UTF-8 string value @@ -8861,7 +8861,7 @@ Return vale: %TRUE for success. version="0.1.32"> Sets the profile copyrights for specific locales. + line="2822">Sets the profile copyrights for specific locales. @@ -8870,13 +8870,13 @@ Return vale: %TRUE for success. A valid #CdIcc + line="2824">A valid #CdIcc New translated values, with the key being the locale. + line="2825">New translated values, with the key being the locale. @@ -8889,7 +8889,7 @@ Return vale: %TRUE for success. version="1.4.2"> Sets the ICC creation date and time. + line="2488">Sets the ICC creation date and time. @@ -8898,7 +8898,7 @@ Return vale: %TRUE for success. A valid #CdIcc + line="2490">A valid #CdIcc @@ -8911,7 +8911,7 @@ Return vale: %TRUE for success. version="0.1.32"> Sets the profile description for a specific locale. + line="2754">Sets the profile description for a specific locale. @@ -8920,13 +8920,13 @@ Return vale: %TRUE for success. A valid #CdIcc + line="2756">A valid #CdIcc A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default + line="2757">A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default allow-none="1"> New UTF-8 string value + line="2758">New UTF-8 string value @@ -8945,7 +8945,7 @@ Return vale: %TRUE for success. version="0.1.32"> Sets the profile descriptions for specific locales. + line="2774">Sets the profile descriptions for specific locales. @@ -8954,13 +8954,13 @@ Return vale: %TRUE for success. A valid #CdIcc + line="2776">A valid #CdIcc New translated values, with the key being the locale. + line="2777">New translated values, with the key being the locale. @@ -8973,7 +8973,7 @@ Return vale: %TRUE for success. version="1.1.1"> Sets the filename, which may be required if the ICC profile has been loaded + line="1889">Sets the filename, which may be required if the ICC profile has been loaded using cd_icc_load_fd() from a disk cache. @@ -8983,13 +8983,13 @@ using cd_icc_load_fd() from a disk cache. a #CdIcc instance. + line="1891">a #CdIcc instance. a filename, or %NULL + line="1892">a filename, or %NULL @@ -9000,7 +9000,7 @@ using cd_icc_load_fd() from a disk cache. version="0.1.32"> Sets the profile kind. + line="2206">Sets the profile kind. @@ -9009,13 +9009,13 @@ using cd_icc_load_fd() from a disk cache. a #CdIcc instance. + line="2208">a #CdIcc instance. the profile kind, e.g. %CD_PROFILE_KIND_DISPLAY_DEVICE + line="2209">the profile kind, e.g. %CD_PROFILE_KIND_DISPLAY_DEVICE @@ -9025,7 +9025,7 @@ using cd_icc_load_fd() from a disk cache. version="0.1.32"> Sets the profile manufacturer for a specific locale. + line="2850">Sets the profile manufacturer for a specific locale. @@ -9034,13 +9034,13 @@ using cd_icc_load_fd() from a disk cache. A valid #CdIcc + line="2852">A valid #CdIcc A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default + line="2853">A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default allow-none="1"> New UTF-8 string value + line="2854">New UTF-8 string value @@ -9059,7 +9059,7 @@ using cd_icc_load_fd() from a disk cache. version="0.1.32"> Sets the profile manufacturers for specific locales. + line="2870">Sets the profile manufacturers for specific locales. @@ -9068,13 +9068,13 @@ using cd_icc_load_fd() from a disk cache. A valid #CdIcc + line="2872">A valid #CdIcc New translated values, with the key being the locale. + line="2873">New translated values, with the key being the locale. @@ -9087,7 +9087,7 @@ using cd_icc_load_fd() from a disk cache. version="0.1.32"> Sets the profile model for a specific locale. + line="2898">Sets the profile model for a specific locale. @@ -9096,13 +9096,13 @@ using cd_icc_load_fd() from a disk cache. A valid #CdIcc + line="2900">A valid #CdIcc A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default + line="2901">A locale, e.g. "en_GB.UTF-8" or %NULL for the profile default allow-none="1"> New UTF-8 string value + line="2902">New UTF-8 string value @@ -9121,7 +9121,7 @@ using cd_icc_load_fd() from a disk cache. version="0.1.32"> Sets the profile models for specific locales. + line="2918">Sets the profile models for specific locales. @@ -9130,13 +9130,13 @@ using cd_icc_load_fd() from a disk cache. A valid #CdIcc + line="2920">A valid #CdIcc New translated values, with the key being the locale. + line="2921">New translated values, with the key being the locale. @@ -9183,7 +9183,7 @@ Most users do not need to do this. throws="1"> Sets the Video Card Gamma Table from the profile. + line="3428">Sets the Video Card Gamma Table from the profile. Return vale: %TRUE for success. @@ -9194,13 +9194,13 @@ Return vale: %TRUE for success. A valid #CdIcc + line="3430">A valid #CdIcc video card calibration data + line="3431">video card calibration data @@ -9213,7 +9213,7 @@ Return vale: %TRUE for success. version="0.1.32"> Sets the profile version. + line="2170">Sets the profile version. @@ -9222,13 +9222,13 @@ Return vale: %TRUE for success. a #CdIcc instance. + line="2172">a #CdIcc instance. the profile version, e.g. 2.1 or 4.0 + line="2173">the profile version, e.g. 2.1 or 4.0 diff --git a/girs/ColordGtk-1.0.gir b/girs/ColordGtk-1.0.gir index c2094bc9a..00e6db517 100644 --- a/girs/ColordGtk-1.0.gir +++ b/girs/ColordGtk-1.0.gir @@ -20,7 +20,7 @@ and/or use gtk-doc annotations. --> - + @@ -31,22 +31,21 @@ and/or use gtk-doc annotations. --> - + - + - - + + - + @@ -55,8 +54,7 @@ and/or use gtk-doc annotations. --> - + @@ -65,8 +63,7 @@ and/or use gtk-doc annotations. --> - + @@ -75,7 +72,7 @@ and/or use gtk-doc annotations. --> - + @@ -84,7 +81,7 @@ and/or use gtk-doc annotations. --> - + @@ -93,8 +90,7 @@ and/or use gtk-doc annotations. --> - + @@ -103,8 +99,7 @@ and/or use gtk-doc annotations. --> - + @@ -113,8 +108,7 @@ and/or use gtk-doc annotations. --> - + @@ -127,18 +121,17 @@ and/or use gtk-doc annotations. --> glib:type-name="CdSampleWidget" glib:get-type="cd_sample_widget_get_type" glib:type-struct="SampleWidgetClass"> - + - A new #CdSampleWidget object. @@ -148,9 +141,9 @@ and/or use gtk-doc annotations. --> glib:set-property="color" version="0.1.24"> Sets the color for the sample widget - @@ -158,13 +151,13 @@ and/or use gtk-doc annotations. --> This class instance A color @@ -186,17 +179,16 @@ and/or use gtk-doc annotations. --> - + - + disguised="1" + opaque="1"> + glib:type-name="CdSampleWindow" glib:get-type="cd_sample_window_get_type" glib:type-struct="SampleWindowClass"> - + - a new #CdSampleWindow object. @@ -225,9 +216,9 @@ and/or use gtk-doc annotations. --> c:identifier="cd_sample_window_set_color" version="0.1.22"> Sets the window to a specific color. - @@ -235,13 +226,13 @@ and/or use gtk-doc annotations. --> a valid #CdSampleWindow instance the color @@ -251,9 +242,9 @@ and/or use gtk-doc annotations. --> c:identifier="cd_sample_window_set_fraction" version="0.1.22"> Sets the percentage value on the window. - @@ -261,13 +252,13 @@ and/or use gtk-doc annotations. --> a valid #CdSampleWindow instance the fraction value to show, or -1 for pulsing. @@ -283,23 +274,22 @@ and/or use gtk-doc annotations. --> - + + disguised="1" + opaque="1"> Private #CdSampleWindow data - + - + @@ -308,7 +298,7 @@ and/or use gtk-doc annotations. --> - + @@ -317,7 +307,7 @@ and/or use gtk-doc annotations. --> - + @@ -330,16 +320,16 @@ and/or use gtk-doc annotations. --> glib:type-name="CdWindow" glib:get-type="cd_window_get_type" glib:type-struct="WindowClass"> - + Creates a new #CdWindow object. - + filename="libcolord-gtk/cd-window.c" + line="579">Creates a new #CdWindow object. + a new CdWindow object. + filename="libcolord-gtk/cd-window.c" + line="584">a new CdWindow object. @@ -348,13 +338,13 @@ and/or use gtk-doc annotations. --> version="0.1.20"> An error quark. - + @@ -371,19 +361,19 @@ and/or use gtk-doc annotations. --> c:identifier="cd_window_get_last_profile" version="0.1.20"> Gets the color profile to use for this widget. - + a #CdProfile a #CdWindow instance. @@ -393,7 +383,7 @@ and/or use gtk-doc annotations. --> c:identifier="cd_window_get_profile" version="0.1.20"> Gets the screen profile that should be used for the widget, which corresponds to the screen output the widget most covers. @@ -402,20 +392,20 @@ g_signal_connect (dialog, "map", G_CALLBACK (map_cb), priv); Note, the returned profile from cd_client_get_profile_for_widget_finish() has already been connected to, as is ready to use. - + a #CdWindow instance. a #GtkWidget @@ -424,7 +414,7 @@ has already been connected to, as is ready to use. nullable="1" allow-none="1"> a #GCancellable or %NULL @@ -435,7 +425,7 @@ has already been connected to, as is ready to use. scope="async" closure="3"> the function to run on completion @@ -444,7 +434,7 @@ has already been connected to, as is ready to use. nullable="1" allow-none="1"> the data to pass to @callback @@ -455,25 +445,25 @@ has already been connected to, as is ready to use. version="0.1.20" throws="1"> Gets the result from the asynchronous function. - + a #CdProfile or %NULL a #CdWindow instance. the #GAsyncResult @@ -484,30 +474,29 @@ has already been connected to, as is ready to use. version="0.1.20" throws="1"> Gets the screen profile that should be used for the widget, which corresponds to the screen output the widget most covers. WARNING: This function is synchronous, and may block. Do not use it in GUI applications. - + a #CdProfile or %NULL a #CdWindow instance. a #GtkWidget @@ -516,13 +505,13 @@ Do not use it in GUI applications. nullable="1" allow-none="1"> a #GCancellable or %NULL - + @@ -533,7 +522,7 @@ Do not use it in GUI applications. The ::changed signal is emitted when the device profile has changed. The #CdProfile that is referenced in the callback has not been connected to, and you will need to call @@ -542,7 +531,10 @@ cd_profile_connect() if the ICC filename is required. - + + the #CdProfile @@ -551,13 +543,13 @@ cd_profile_connect() if the ICC filename is required. - + - + @@ -573,7 +565,7 @@ cd_profile_connect() if the ICC filename is required. - + @@ -581,7 +573,7 @@ cd_profile_connect() if the ICC filename is required. - + @@ -589,7 +581,7 @@ cd_profile_connect() if the ICC filename is required. - + @@ -597,7 +589,7 @@ cd_profile_connect() if the ICC filename is required. - + @@ -605,7 +597,7 @@ cd_profile_connect() if the ICC filename is required. - + @@ -613,7 +605,7 @@ cd_profile_connect() if the ICC filename is required. - + @@ -621,7 +613,7 @@ cd_profile_connect() if the ICC filename is required. - + @@ -629,7 +621,7 @@ cd_profile_connect() if the ICC filename is required. - + @@ -638,26 +630,29 @@ cd_profile_connect() if the ICC filename is required. Errors that can be thrown - + the transaction failed for an unknown reason - + Private #CdWindow data - + These compile time macros allow the user to enable parts of client code depending on the version of libcolord installed. @@ -665,7 +660,7 @@ See also: #CdClient, #CdDevice These functions are useful when GTK is being used alongside colord and are just provided for convenience. @@ -673,7 +668,7 @@ See also: #CdDevice These helper functions provide a simple way to use the async functions in command line tools. diff --git a/girs/CudaGst-1.0.gir b/girs/CudaGst-1.0.gir index e7a0bccce..8d8a300ef 100644 --- a/girs/CudaGst-1.0.gir +++ b/girs/CudaGst-1.0.gir @@ -20,13 +20,17 @@ and/or use gtk-doc annotations. --> - + - + + + + + @@ -35,6 +39,12 @@ and/or use gtk-doc annotations. --> + + + + @@ -48,11 +58,11 @@ and/or use gtk-doc annotations. --> - + - + @@ -103,29 +113,29 @@ and/or use gtk-doc annotations. --> - + - + + line="173"/> + line="176"/> + line="182"/> @@ -141,7 +151,7 @@ and/or use gtk-doc annotations. --> + line="190"/> @@ -163,7 +173,7 @@ and/or use gtk-doc annotations. --> + line="193"/> @@ -176,7 +186,7 @@ and/or use gtk-doc annotations. --> - + @@ -208,7 +218,7 @@ and/or use gtk-doc annotations. --> - + @@ -253,18 +263,22 @@ and/or use gtk-doc annotations. --> c:identifier="CU_GL_DEVICE_LIST_ALL"> + + + + - + - + - + @@ -275,7 +289,7 @@ and/or use gtk-doc annotations. --> - + - + + + @@ -297,9 +315,42 @@ and/or use gtk-doc annotations. --> value="76" c:identifier="CU_DEVICE_ATTRIBUTE_COMPUTE_CAPABILITY_MINOR"> + + + + + + + + + + + + + + + + + + + - + @@ -307,7 +358,7 @@ and/or use gtk-doc annotations. --> - + @@ -322,7 +373,7 @@ and/or use gtk-doc annotations. --> - + @@ -344,8 +395,168 @@ and/or use gtk-doc annotations. --> c:identifier="CU_GRAPHICS_REGISTER_FLAGS_TEXTURE_GATHER"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -356,14 +567,14 @@ and/or use gtk-doc annotations. --> - + - + - + + + + + + + - + shared-library="libdmapsharing-3.0.so.2" c:identifier-prefixes="DMAP" c:symbol-prefixes="dmap"> + + Casts a #DMAPConnection or derived pointer into a (DMAPConnection *) pointer. +Depending on the current debugging level, this function may invoke +certain runtime checks to identify invalid casts. + + + + Object which is subject to casting. + + + + + Casts a derived #DMAPConnectionClass structure into a #DMAPConnectionClass +structure. + + + + a valid #DMAPConnectionClass + + + + + Get the class structure associated to a #DMAPConnection instance. + + + + a #DMAPConnection instance. + + + + + Casts a #DMAPContainerDb or derived pointer into a (DMAPContainerDb*) +pointer. Depending on the current debugging level, this function may invoke +certain runtime checks to identify invalid casts. + + + + Object which is subject to casting. + + + + + Get the interface structure associated to a #DMAPContainerDb instance. + + + + a #DMAPContainerDb instance. + + + + + Casts a #DMAPContainerRecord or derived pointer into a (DMAPContainerRecord*) +pointer. Depending on the current debugging level, this function may invoke +certain runtime checks to identify invalid casts. + + + + Object which is subject to casting. + + + + + Get the class structure associated to a #DMAPContainerRecord instance. + + + + a #DMAPContainerRecord instance. + + + glib:type-name="DMAPConnection" glib:get-type="dmap_connection_get_type" glib:type-struct="ConnectionClass"> + + @@ -36,6 +150,7 @@ and/or use gtk-doc annotations. --> + @@ -61,6 +176,7 @@ and/or use gtk-doc annotations. --> + @@ -71,6 +187,7 @@ and/or use gtk-doc annotations. --> + @@ -87,6 +204,7 @@ and/or use gtk-doc annotations. --> + @@ -97,6 +215,7 @@ and/or use gtk-doc annotations. --> + @@ -107,6 +226,7 @@ and/or use gtk-doc annotations. --> + @@ -117,6 +237,7 @@ and/or use gtk-doc annotations. --> + @@ -136,6 +257,7 @@ and/or use gtk-doc annotations. --> + @@ -147,33 +269,46 @@ and/or use gtk-doc annotations. --> - Attach an authentication credential to a request. This + Attach an authentication credential to a request. This method should be called by a function that is connected to the #DMAPConnection::authenticate signal. The signal will provide the connection, session, message and auth to that function. That function should obtain a password and provide it to this method. + - A #DMAPConnection + A #DMAPConnection - A #SoupSession + A #SoupSession - A #SoupMessage + A #SoupMessage - A #SoupAuth + A #SoupAuth - A password + A password @@ -181,6 +316,7 @@ should obtain a password and provide it to this method. + @@ -208,6 +344,7 @@ should obtain a password and provide it to this method. + @@ -218,7 +355,10 @@ should obtain a password and provide it to this method. - + @@ -226,6 +366,7 @@ should obtain a password and provide it to this method. + @@ -236,12 +377,16 @@ should obtain a password and provide it to this method. - + + @@ -258,12 +403,16 @@ should obtain a password and provide it to this method. - + + @@ -279,6 +428,7 @@ should obtain a password and provide it to this method. + @@ -291,6 +441,7 @@ should obtain a password and provide it to this method. + @@ -301,6 +452,7 @@ should obtain a password and provide it to this method. + @@ -313,7 +465,10 @@ should obtain a password and provide it to this method. - + transfer-ownership="none"> - + + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="0"> - + - + + transfer-ownership="none" + default-value="libdmapsharing"> @@ -425,6 +594,7 @@ should obtain a password and provide it to this method. + @@ -438,7 +608,11 @@ should obtain a password and provide it to this method. - + @@ -446,11 +620,13 @@ should obtain a password and provide it to this method. + + @@ -463,6 +639,7 @@ should obtain a password and provide it to this method. + @@ -475,6 +652,7 @@ should obtain a password and provide it to this method. + @@ -496,6 +674,7 @@ should obtain a password and provide it to this method. + @@ -523,6 +702,7 @@ should obtain a password and provide it to this method. + @@ -535,6 +715,7 @@ should obtain a password and provide it to this method. + @@ -547,6 +728,7 @@ should obtain a password and provide it to this method. + @@ -562,6 +744,7 @@ should obtain a password and provide it to this method. + @@ -580,6 +763,7 @@ should obtain a password and provide it to this method. + @@ -593,7 +777,9 @@ should obtain a password and provide it to this method. + disguised="1" + opaque="1"> + + glib:nick="get-info" + glib:name="DMAP_GET_INFO"> + glib:nick="login" + glib:name="DMAP_LOGIN"> + glib:nick="get-revision-number" + glib:name="DMAP_GET_REVISION_NUMBER"> + glib:nick="get-db-info" + glib:name="DMAP_GET_DB_INFO"> + glib:nick="get-songs" + glib:name="DMAP_GET_SONGS"> + glib:nick="get-playlists" + glib:name="DMAP_GET_PLAYLISTS"> + glib:nick="get-playlist-entries" + glib:name="DMAP_GET_PLAYLIST_ENTRIES"> + glib:nick="logout" + glib:name="DMAP_LOGOUT"> - + glib:type-name="DMAPContainerDb" glib:get-type="dmap_container_db_get_type" glib:type-struct="ContainerDbIface"> + - Add a record to the database. + Add a record to the database. + - A container database. + A container database. - A record. + A record. + @@ -675,21 +882,33 @@ should obtain a password and provide it to this method. - Apply a function to each record in a container database. + Apply a function to each record in a container database. + - A container database. + A container database. - The function to apply to each record in the database. + The function to apply to each record in the database. - - User data to pass to the function. + + User data to pass to the function. @@ -697,46 +916,65 @@ should obtain a password and provide it to this method. + - the database record corresponding to @id. This record should + the database record corresponding to @id. This record should be unrefed when no longer required. - A container database. + A container database. - A record ID. + A record ID. - Add a record to the database. + Add a record to the database. + - A container database. + A container database. - A record. + A record. + - the number of records in the database. + the number of records in the database. - A container database. + A container database. @@ -744,21 +982,33 @@ be unrefed when no longer required. - Apply a function to each record in a container database. + Apply a function to each record in a container database. + - A container database. + A container database. - The function to apply to each record in the database. + The function to apply to each record in the database. - - User data to pass to the function. + + User data to pass to the function. @@ -766,18 +1016,25 @@ be unrefed when no longer required. + - the database record corresponding to @id. This record should + the database record corresponding to @id. This record should be unrefed when no longer required. - A container database. + A container database. - A record ID. + A record ID. @@ -786,21 +1043,27 @@ be unrefed when no longer required. + + - A container database. + A container database. - A record. + A record. @@ -808,18 +1071,25 @@ be unrefed when no longer required. + - the database record corresponding to @id. This record should + the database record corresponding to @id. This record should be unrefed when no longer required. - A container database. + A container database. - A record ID. + A record ID. @@ -827,20 +1097,30 @@ be unrefed when no longer required. + - A container database. + A container database. - The function to apply to each record in the database. + The function to apply to each record in the database. - - User data to pass to the function. + + User data to pass to the function. @@ -848,6 +1128,7 @@ be unrefed when no longer required. + @@ -865,24 +1146,34 @@ be unrefed when no longer required. glib:type-name="DMAPContainerRecord" glib:get-type="dmap_container_record_get_type" glib:type-struct="ContainerRecordIface"> + - Add a record to the database. It is assumed that the record is placed + Add a record to the database. It is assumed that the record is placed directly into the database (not copied) and not freed. + - A DMAPContainerRecord. + A DMAPContainerRecord. - A DMAPRecord. + A DMAPRecord. - The record's ID. + The record's ID. @@ -890,59 +1181,83 @@ directly into the database (not copied) and not freed. + - A pointer to a DMAPDb containing the entries contained in record. + A pointer to a DMAPDb containing the entries contained in record. - A DMAPContainerRecord. + A DMAPContainerRecord. + - the number of records in the container record. + the number of records in the container record. - A DMAPContainerRecord. + A DMAPContainerRecord. + - the ID for the given record. + the ID for the given record. - A DMAPContainerRecord. + A DMAPContainerRecord. - Add a record to the database. It is assumed that the record is placed + Add a record to the database. It is assumed that the record is placed directly into the database (not copied) and not freed. + - A DMAPContainerRecord. + A DMAPContainerRecord. - A DMAPRecord. + A DMAPRecord. - The record's ID. + The record's ID. @@ -950,61 +1265,85 @@ directly into the database (not copied) and not freed. + - A pointer to a DMAPDb containing the entries contained in record. + A pointer to a DMAPDb containing the entries contained in record. - A DMAPContainerRecord. + A DMAPContainerRecord. + - the number of records in the container record. + the number of records in the container record. - A DMAPContainerRecord. + A DMAPContainerRecord. + - the ID for the given record. + the ID for the given record. - A DMAPContainerRecord. + A DMAPContainerRecord. - + + + - the ID for the given record. + the ID for the given record. - A DMAPContainerRecord. + A DMAPContainerRecord. @@ -1012,20 +1351,27 @@ directly into the database (not copied) and not freed. + - A DMAPContainerRecord. + A DMAPContainerRecord. - A DMAPRecord. + A DMAPRecord. - The record's ID. + The record's ID. @@ -1033,13 +1379,18 @@ directly into the database (not copied) and not freed. + - the number of records in the container record. + the number of records in the container record. - A DMAPContainerRecord. + A DMAPContainerRecord. @@ -1047,13 +1398,18 @@ directly into the database (not copied) and not freed. + - A pointer to a DMAPDb containing the entries contained in record. + A pointer to a DMAPDb containing the entries contained in record. - A DMAPContainerRecord. + A DMAPContainerRecord. @@ -1061,6 +1417,7 @@ directly into the database (not copied) and not freed. + @@ -1371,6 +1728,7 @@ directly into the database (not copied) and not freed. + @@ -1387,16 +1745,52 @@ directly into the database (not copied) and not freed. + + Casts a #DMAPDb or derived pointer into a (DMAPDb *) pointer. +Depending on the current debugging level, this function may invoke +certain runtime checks to identify invalid casts. + + + + Object which is subject to casting. + + + + + Get the insterface structure associated to a #DMAPDb instance. + + + + a #DMAPDb instance. + + + + - Add a record to the database. + Add a record to the database. + - The ID for the newly added record. A reference to the record + The ID for the newly added record. A reference to the record will be retained by the database (if required; an adapter-type implementation may not want to retain a reference as the record data may be placed elsewhere). In all cases, the record should be unrefed by the @@ -1405,58 +1799,83 @@ calling code. - A media database. + A media database. - A database record. + A database record. - Create a record and add it to the database. + Create a record and add it to the database. + - The ID for the newly added record. + The ID for the newly added record. See also the notes for dmap_db_add regarding reference counting. - A media database. + A media database. - A path to an appropriate media file. + A path to an appropriate media file. - Add a record to the database and assign it the given ID. + Add a record to the database and assign it the given ID. + - The ID for the newly added record. + The ID for the newly added record. See also the notes for dmap_db_add regarding reference counting. - A media database. + A media database. - A database record. + A database record. - A database record ID. + A database record ID. + @@ -1467,21 +1886,33 @@ See also the notes for dmap_db_add regarding reference counting. - Apply a function to each record in a media database. + Apply a function to each record in a media database. + - A media database. + A media database. - The function to apply to each record in the database. + The function to apply to each record in the database. - - User data to pass to the function. + + User data to pass to the function. @@ -1489,8 +1920,11 @@ See also the notes for dmap_db_add regarding reference counting. + - the database record corresponding to @id. This record should + the database record corresponding to @id. This record should be unrefed by the calling code when no longer required. If you are implementing a full database using this API, then you @@ -1507,37 +1941,53 @@ returning a record pointer. - A media database. + A media database. - A record ID. + A record ID. + - the database id for the record corresponding to @path or 0 if + the database id for the record corresponding to @path or 0 if such a record does not exist. - A media database. + A media database. - A record location. + A record location. - Add a record to the database. + Add a record to the database. + - The ID for the newly added record. A reference to the record + The ID for the newly added record. A reference to the record will be retained by the database (if required; an adapter-type implementation may not want to retain a reference as the record data may be placed elsewhere). In all cases, the record should be unrefed by the @@ -1546,53 +1996,77 @@ calling code. - A media database. + A media database. - A database record. + A database record. - Create a record and add it to the database. + Create a record and add it to the database. + - The ID for the newly added record. + The ID for the newly added record. See also the notes for dmap_db_add regarding reference counting. - A media database. + A media database. - A path to an appropriate media file. + A path to an appropriate media file. - Add a record to the database and assign it the given ID. + Add a record to the database and assign it the given ID. + - The ID for the newly added record. + The ID for the newly added record. See also the notes for dmap_db_add regarding reference counting. - A media database. + A media database. - A database record. + A database record. - A database record ID. + A database record ID. @@ -1600,6 +2074,7 @@ See also the notes for dmap_db_add regarding reference counting. + @@ -1618,33 +2093,50 @@ See also the notes for dmap_db_add regarding reference counting. + - the number of records in the database. + the number of records in the database. - A media database. + A media database. - Apply a function to each record in a media database. + Apply a function to each record in a media database. + - A media database. + A media database. - The function to apply to each record in the database. + The function to apply to each record in the database. - - User data to pass to the function. + + User data to pass to the function. @@ -1652,8 +2144,11 @@ See also the notes for dmap_db_add regarding reference counting. + - the database record corresponding to @id. This record should + the database record corresponding to @id. This record should be unrefed by the calling code when no longer required. If you are implementing a full database using this API, then you @@ -1670,35 +2165,47 @@ returning a record pointer. - A media database. + A media database. - A record ID. + A record ID. + - the database id for the record corresponding to @path or 0 if + the database id for the record corresponding to @path or 0 if such a record does not exist. - A media database. + A media database. - A record location. + A record location. + @@ -1710,13 +2217,17 @@ such a record does not exist. + + - The ID for the newly added record. A reference to the record + The ID for the newly added record. A reference to the record will be retained by the database (if required; an adapter-type implementation may not want to retain a reference as the record data may be placed elsewhere). In all cases, the record should be unrefed by the @@ -1725,11 +2236,15 @@ calling code. - A media database. + A media database. - A database record. + A database record. @@ -1737,23 +2252,32 @@ calling code. + - The ID for the newly added record. + The ID for the newly added record. See also the notes for dmap_db_add regarding reference counting. - A media database. + A media database. - A database record. + A database record. - A database record ID. + A database record ID. @@ -1761,19 +2285,26 @@ See also the notes for dmap_db_add regarding reference counting. + - The ID for the newly added record. + The ID for the newly added record. See also the notes for dmap_db_add regarding reference counting. - A media database. + A media database. - A path to an appropriate media file. + A path to an appropriate media file. @@ -1781,8 +2312,11 @@ See also the notes for dmap_db_add regarding reference counting. + - the database record corresponding to @id. This record should + the database record corresponding to @id. This record should be unrefed by the calling code when no longer required. If you are implementing a full database using this API, then you @@ -1799,11 +2333,15 @@ returning a record pointer. - A media database. + A media database. - A record ID. + A record ID. @@ -1811,18 +2349,25 @@ returning a record pointer. + - the database id for the record corresponding to @path or 0 if + the database id for the record corresponding to @path or 0 if such a record does not exist. - A media database. + A media database. - A record location. + A record location. @@ -1830,20 +2375,30 @@ such a record does not exist. + - A media database. + A media database. - The function to apply to each record in the database. + The function to apply to each record in the database. - - User data to pass to the function. + + User data to pass to the function. @@ -1851,6 +2406,7 @@ such a record does not exist. + @@ -1862,6 +2418,33 @@ such a record does not exist. + + + + + + + + + + + + + + + + + + + + + glib:type-name="DMAPGstInputStream" glib:get-type="dmap_gst_input_stream_get_type" glib:type-struct="GstInputStreamClass"> + + @@ -1884,6 +2469,7 @@ such a record does not exist. + @@ -1904,11 +2490,13 @@ such a record does not exist. + + @@ -1922,31 +2510,109 @@ such a record does not exist. + disguised="1" + opaque="1"> + + + - + - + - - + + + + Casts a #DMAPMdnsBrowser or derived pointer into a (DMAPMdnsBrowser *) pointer. +Depending on the current debugging level, this function may invoke +certain runtime checks to identify invalid casts. + + + + Object which is subject to casting. + + + + + Casts a derived #DAAPShareClass structure into a #DAAPShareClass structure. + + + + a valid #DMAPMdnsBrowserClass + + + + + Get the class structure associated to a #DMAPMdnsBrowser instance. + + + + a #DMAPMdnsBrowser instance. + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="DMAPMdnsBrowser" glib:get-type="dmap_mdns_browser_get_type" glib:type-struct="MdnsBrowserClass"> + - Creates a new mDNS browser. + Creates a new mDNS browser. + - a pointer to a DMAPMdnsBrowser. + a pointer to a DMAPMdnsBrowser. - The type of service to browse. + The type of service to browse. + @@ -1982,6 +2657,7 @@ such a record does not exist. + @@ -1996,6 +2672,7 @@ such a record does not exist. + @@ -2009,6 +2686,7 @@ such a record does not exist. + @@ -2021,27 +2699,41 @@ such a record does not exist. - Starts a DMAPMdnsBrowser. + Starts a DMAPMdnsBrowser. + - TRUE on success, else FALSE. + TRUE on success, else FALSE. - A DMAPMdnsBrowser. + A DMAPMdnsBrowser. - Stops a DMAPMdnsBrowser. + Stops a DMAPMdnsBrowser. + - TRUE on success, else FALSE. + TRUE on success, else FALSE. - A DMAPMdnsBrowser. + A DMAPMdnsBrowser. @@ -2053,13 +2745,20 @@ such a record does not exist. - Emitted each time a service becomes available to @browser + Emitted each time a service becomes available to @browser - - #DMAPMdnsBrowserService + + #DMAPMdnsBrowserService @@ -2078,11 +2777,13 @@ such a record does not exist. + + @@ -2099,6 +2800,7 @@ such a record does not exist. + @@ -2122,12 +2824,14 @@ such a record does not exist. + glib:nick="not-running" + glib:name="DMAP_MDNS_BROWSER_ERROR_NOT_RUNNING"> + glib:nick="failed" + glib:name="DMAP_MDNS_BROWSER_ERROR_FAILED"> @@ -2137,9 +2841,12 @@ such a record does not exist. + disguised="1" + opaque="1"> + + @@ -2170,32 +2877,38 @@ such a record does not exist. + glib:nick="invalid" + glib:name="DMAP_MDNS_BROWSER_SERVICE_TYPE_INVALID"> + glib:nick="daap" + glib:name="DMAP_MDNS_BROWSER_SERVICE_TYPE_DAAP"> + glib:nick="dpap" + glib:name="DMAP_MDNS_BROWSER_SERVICE_TYPE_DPAP"> + glib:nick="dacp" + glib:name="DMAP_MDNS_BROWSER_SERVICE_TYPE_DACP"> + glib:nick="raop" + glib:name="DMAP_MDNS_BROWSER_SERVICE_TYPE_RAOP"> + glib:nick="last" + glib:name="DMAP_MDNS_BROWSER_SERVICE_TYPE_LAST"> + glib:nick="tcp" + glib:name="DMAP_MDNS_BROWSER_TRANSPORT_PROTOCOL_TCP"> + glib:nick="udp" + glib:name="DMAP_MDNS_BROWSER_TRANSPORT_PROTOCOL_UDP"> + glib:nick="last" + glib:name="DMAP_MDNS_BROWSER_TRANSPORT_PROTOCOL_LAST"> glib:type-name="DMAPMdnsPublisher" glib:get-type="dmap_mdns_publisher_get_type" glib:type-struct="MdnsPublisherClass"> + + + @@ -2244,6 +2963,7 @@ such a record does not exist. + @@ -2259,6 +2979,7 @@ such a record does not exist. + @@ -2286,6 +3007,7 @@ such a record does not exist. + @@ -2304,6 +3026,7 @@ such a record does not exist. + @@ -2346,11 +3069,13 @@ such a record does not exist. + + @@ -2366,6 +3091,7 @@ such a record does not exist. + @@ -2388,12 +3114,14 @@ such a record does not exist. + glib:nick="not-running" + glib:name="DMAP_MDNS_PUBLISHER_ERROR_NOT_RUNNING"> + glib:nick="failed" + glib:name="DMAP_MDNS_PUBLISHER_ERROR_FAILED"> @@ -2403,7 +3131,9 @@ such a record does not exist. + disguised="1" + opaque="1"> + + glib:nick="music" + glib:name="DMAP_MEDIA_KIND_MUSIC"> + glib:nick="movie" + glib:name="DMAP_MEDIA_KIND_MOVIE"> + glib:nick="podcast" + glib:name="DMAP_MEDIA_KIND_PODCAST"> + glib:nick="tv-show" + glib:name="DMAP_MEDIA_KIND_TV_SHOW"> + @@ -2439,6 +3174,7 @@ such a record does not exist. + @@ -2451,13 +3187,79 @@ such a record does not exist. + + Casts a #DMAPRecord or derived pointer into a (DMAPRecord *) pointer. +Depending on the current debugging level, this function may invoke +certain runtime checks to identify invalid casts. + + + + Object which is subject to casting. + + + + + Casts a #DMAPRecordFactory or derived pointer into a (DMAPRecordFactory *) +pointer. Depending on the current debugging level, this function may invoke +certain runtime checks to identify invalid casts. + + + + Object which is subject to casting. + + + + + Get the interface structure associated to a #DMAPRecordFactory instance. + + + + a #DMAPRecordFactory instance. + + + + + Get the class structure associated to a #DAAPRecord instance. + + + + a #DAAPRecord instance. + + + + + @@ -2473,20 +3275,26 @@ such a record does not exist. + - A byte array representation of the record. + A byte array representation of the record. - A DMAPRecord. + A DMAPRecord. + @@ -2504,15 +3312,20 @@ such a record does not exist. + - A byte array representation of the record. + A byte array representation of the record. - A DMAPRecord. + A DMAPRecord. @@ -2524,18 +3337,30 @@ such a record does not exist. glib:type-name="DMAPRecordFactory" glib:get-type="dmap_record_factory_get_type" glib:type-struct="RecordFactoryIface"> + + - a new DMAPRecord as read from path. + a new DMAPRecord as read from path. - A DMAPRecordFactory. + A DMAPRecordFactory. - - Some piece of data that may be used to initialize return value. + + Some piece of data that may be used to initialize return value. @@ -2543,17 +3368,27 @@ such a record does not exist. + - a new DMAPRecord as read from path. + a new DMAPRecord as read from path. - A DMAPRecordFactory. + A DMAPRecordFactory. - - Some piece of data that may be used to initialize return value. + + Some piece of data that may be used to initialize return value. @@ -2562,22 +3397,34 @@ such a record does not exist. + + - a new DMAPRecord as read from path. + a new DMAPRecord as read from path. - A DMAPRecordFactory. + A DMAPRecordFactory. - - Some piece of data that may be used to initialize return value. + + Some piece of data that may be used to initialize return value. @@ -2587,20 +3434,26 @@ such a record does not exist. + + - A byte array representation of the record. + A byte array representation of the record. - A DMAPRecord. + A DMAPRecord. @@ -2608,6 +3461,7 @@ such a record does not exist. + @@ -2625,6 +3479,7 @@ such a record does not exist. + @@ -2638,12 +3493,62 @@ such a record does not exist. - + + + Casts a #DMAPShare or derived pointer into a (DMAPShare*) pointer. +Depending on the current debugging level, this function may invoke +certain runtime checks to identify invalid casts. + + + + Object which is subject to casting. + + + + + Casts a derived #DMAPShareClass structure into a #DMAPShareClass structure. + + + + a valid #DMAPShareClass + + + + + Get the class structure associated to a #DMAPShare instance. + + + + a #DMAPShare instance. + + + + glib:type-name="DMAPShare" glib:get-type="dmap_share_get_type" glib:type-struct="ShareClass"> + + @@ -2669,6 +3576,7 @@ such a record does not exist. + @@ -2697,6 +3605,7 @@ such a record does not exist. + @@ -2725,6 +3634,7 @@ such a record does not exist. + @@ -2753,6 +3663,7 @@ such a record does not exist. + @@ -2781,6 +3692,7 @@ such a record does not exist. + @@ -2809,6 +3721,7 @@ such a record does not exist. + @@ -2818,8 +3731,9 @@ such a record does not exist. - - + + + @@ -2829,6 +3743,7 @@ such a record does not exist. + @@ -2839,6 +3754,7 @@ such a record does not exist. + @@ -2867,6 +3783,7 @@ such a record does not exist. + @@ -2895,6 +3812,7 @@ such a record does not exist. + @@ -2908,6 +3826,7 @@ such a record does not exist. + @@ -2924,6 +3843,7 @@ such a record does not exist. + @@ -2940,6 +3860,7 @@ such a record does not exist. + @@ -2968,6 +3889,7 @@ such a record does not exist. + @@ -2995,7 +3917,10 @@ such a record does not exist. - + transfer-ownership="none"> - + - + - + - - - - + + transfer-ownership="none" + default-value="NULL"> @@ -3046,11 +3978,13 @@ such a record does not exist. + + @@ -3063,6 +3997,7 @@ such a record does not exist. + @@ -3075,6 +4010,7 @@ such a record does not exist. + @@ -3088,9 +4024,10 @@ such a record does not exist. - - - + + + + @@ -3102,6 +4039,7 @@ such a record does not exist. + @@ -3120,6 +4058,7 @@ such a record does not exist. + @@ -3150,6 +4089,7 @@ such a record does not exist. + @@ -3180,6 +4120,7 @@ such a record does not exist. + @@ -3210,6 +4151,7 @@ such a record does not exist. + @@ -3240,6 +4182,7 @@ such a record does not exist. + @@ -3270,6 +4213,7 @@ such a record does not exist. + @@ -3300,6 +4244,7 @@ such a record does not exist. + @@ -3330,6 +4275,7 @@ such a record does not exist. + @@ -3360,6 +4306,7 @@ such a record does not exist. + @@ -3378,6 +4325,7 @@ such a record does not exist. + @@ -3396,6 +4344,7 @@ such a record does not exist. + @@ -3425,9 +4374,14 @@ such a record does not exist. - + + + @@ -3445,56 +4399,67 @@ such a record does not exist. + glib:nick="byte" + glib:name="DMAP_TYPE_BYTE"> + glib:nick="signed-int" + glib:name="DMAP_TYPE_SIGNED_INT"> + glib:nick="short" + glib:name="DMAP_TYPE_SHORT"> + glib:nick="int" + glib:name="DMAP_TYPE_INT"> + glib:nick="int64" + glib:name="DMAP_TYPE_INT64"> + glib:nick="string" + glib:name="DMAP_TYPE_STRING"> + glib:nick="date" + glib:name="DMAP_TYPE_DATE"> + glib:nick="version" + glib:name="DMAP_TYPE_VERSION"> + glib:nick="container" + glib:name="DMAP_TYPE_CONTAINER"> + glib:nick="pointer" + glib:name="DMAP_TYPE_POINTER"> + @@ -3505,6 +4470,7 @@ such a record does not exist. + @@ -3516,6 +4482,7 @@ such a record does not exist. + @@ -3527,6 +4494,7 @@ such a record does not exist. + @@ -3538,6 +4506,7 @@ such a record does not exist. + @@ -3548,6 +4517,7 @@ such a record does not exist. + @@ -3559,6 +4529,7 @@ such a record does not exist. + @@ -3582,6 +4553,7 @@ such a record does not exist. + @@ -3590,12 +4562,13 @@ such a record does not exist. - + + @@ -3607,6 +4580,7 @@ such a record does not exist. + @@ -3621,6 +4595,7 @@ such a record does not exist. + @@ -3629,7 +4604,7 @@ such a record does not exist. - + @@ -3650,19 +4625,10 @@ such a record does not exist. - - - - - - - - - - + @@ -3679,6 +4645,7 @@ such a record does not exist. + @@ -3691,6 +4658,7 @@ such a record does not exist. + @@ -3706,6 +4674,7 @@ such a record does not exist. + @@ -3719,6 +4688,7 @@ such a record does not exist. + @@ -3730,6 +4700,7 @@ such a record does not exist. + @@ -3745,6 +4716,7 @@ such a record does not exist. + @@ -3758,6 +4730,7 @@ such a record does not exist. + @@ -3769,6 +4742,7 @@ such a record does not exist. + @@ -3781,5 +4755,17 @@ such a record does not exist. + + + + + + + + + + + diff --git a/girs/DbusmenuGtk-0.4.gir b/girs/DbusmenuGtk-0.4.gir index 944686248..59673d5a6 100644 --- a/girs/DbusmenuGtk-0.4.gir +++ b/girs/DbusmenuGtk-0.4.gir @@ -27,81 +27,120 @@ and/or use gtk-doc annotations. --> glib:type-name="DbusmenuGtkClient" glib:get-type="dbusmenu_gtkclient_get_type" glib:type-struct="ClientClass"> - A subclass of #DbusmenuClient to add functionality with regarding + A subclass of #DbusmenuClient to add functionality with regarding building GTK items out of the abstract tree. + - Creates a new #DbusmenuGtkClient object and creates a #DbusmenuClient + Creates a new #DbusmenuGtkClient object and creates a #DbusmenuClient that connects across DBus to a #DbusmenuServer. + - A new #DbusmenuGtkClient sync'd with a server + A new #DbusmenuGtkClient sync'd with a server - Name of the #DbusmenuServer on DBus + Name of the #DbusmenuServer on DBus - Name of the object on the #DbusmenuServer + Name of the object on the #DbusmenuServer - Gets the accel group for this client. + Gets the accel group for this client. + - Either a valid group or #NULL on error or + Either a valid group or #NULL on error or none set. - Client to query for an accelerator group + Client to query for an accelerator group - This grabs the #GtkMenuItem that is associated with the + This grabs the #GtkMenuItem that is associated with the #DbusmenuMenuitem. + - The #GtkMenuItem that can be played with. + The #GtkMenuItem that can be played with. - A #DbusmenuGtkClient with the item in it. + A #DbusmenuGtkClient with the item in it. - #DbusmenuMenuitem to get associated #GtkMenuItem on. + #DbusmenuMenuitem to get associated #GtkMenuItem on. - This grabs the submenu associated with the menuitem. + This grabs the submenu associated with the menuitem. + - The #GtkMenu if there is one. + The #GtkMenu if there is one. - A #DbusmenuGtkClient with the item in it. + A #DbusmenuGtkClient with the item in it. - #DbusmenuMenuitem to get associated #GtkMenu on. + #DbusmenuMenuitem to get associated #GtkMenu on. - This function provides some of the basic connectivity for being in + This function provides some of the basic connectivity for being in the GTK world. Things like visibility and sensitivity of the item are handled here so that the subclasses don't have to. If you're building your on GTK menu item you can use this function to apply those basic @@ -109,42 +148,58 @@ attributes so that you don't have to deal with them either. This also handles passing the "activate" signal back to the #DbusmenuMenuitem side of thing. + - The client handling everything on this connection + The client handling everything on this connection - The #DbusmenuMenuitem to attach the GTK-isms to + The #DbusmenuMenuitem to attach the GTK-isms to - A #GtkMenuItem representing the GTK world's view of this menuitem + A #GtkMenuItem representing the GTK world's view of this menuitem - The parent #DbusmenuMenuitem + The parent #DbusmenuMenuitem - Sets the acceleration group for the menu items with accelerators + Sets the acceleration group for the menu items with accelerators on this client. + - To set the group on + To set the group on - The new acceleration group + The new acceleration group @@ -159,13 +214,19 @@ on this client. - Functions and signal slots for using a #DbusmenuGtkClient + Functions and signal slots for using a #DbusmenuGtkClient + - #GtkMenuClass + #GtkMenuClass + @@ -178,6 +239,7 @@ on this client. + @@ -185,6 +247,7 @@ on this client. + @@ -192,6 +255,7 @@ on this client. + @@ -199,6 +263,7 @@ on this client. + @@ -206,6 +271,7 @@ on this client. + @@ -213,6 +279,7 @@ on this client. + @@ -221,13 +288,106 @@ on this client. + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="DbusmenuGtkMenu" glib:get-type="dbusmenu_gtkmenu_get_type" glib:type-struct="MenuClass"> - A #GtkMenu that is built using an abstract tree built from + A #GtkMenu that is built using an abstract tree built from a #DbusmenuGtkClient. + - Creates a new #DbusmenuGtkMenu object and creates a #DbusmenuClient + Creates a new #DbusmenuGtkMenu object and creates a #DbusmenuClient that connects across DBus to a #DbusmenuServer. + - A new #DbusmenuGtkMenu sync'd with a server + A new #DbusmenuGtkMenu sync'd with a server - Name of the #DbusmenuServer on DBus + Name of the #DbusmenuServer on DBus - Name of the object on the #DbusmenuServer + Name of the object on the #DbusmenuServer - An accessor for the client that this menu is using to + An accessor for the client that this menu is using to communicate with the server. + - A valid #DbusmenuGtkClient or NULL on error. + A valid #DbusmenuGtkClient or NULL on error. - The #DbusmenuGtkMenu to get the client from + The #DbusmenuGtkMenu to get the client from @@ -274,13 +453,15 @@ communicate with the server. + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="NULL"> @@ -293,14 +474,20 @@ communicate with the server. - All of the subclassable functions and signal slots for a + All of the subclassable functions and signal slots for a #DbusmenuGtkMenu. + - #GtkMenuClass + #GtkMenuClass + @@ -308,6 +495,7 @@ communicate with the server. + @@ -315,6 +503,7 @@ communicate with the server. + @@ -322,6 +511,7 @@ communicate with the server. + @@ -329,6 +519,7 @@ communicate with the server. + @@ -336,185 +527,317 @@ communicate with the server. + - + + + + In general, this is just a #GtkMenu, why else would you care? Oh, + because this menu is created by someone else on a server that exists + on the other side of DBus. You need a #DbusmenuServer to be able + push the data into this menu. + + The first thing you need to know is how to find that #DbusmenuServer + on DBus. This involves both the DBus name and the DBus object that + the menu interface can be found on. Those two value should be set + when creating the object using dbusmenu_gtkmenu_new(). They are then + stored on two properties #DbusmenuGtkClient:dbus-name and #DbusmenuGtkClient:dbus-object. + + After creation the #DbusmenuGtkClient it will continue to keep in + synchronization with the #DbusmenuServer object across Dbus. If the + number of entries change, the menus change, if they change thier + properties change, they update in the items. All of this should + be handled transparently to the user of this object. + - The Dbusmenu GTK parser adds cached items on the various + The Dbusmenu GTK parser adds cached items on the various menu items throughout the tree. Sometimes it can be useful to get that cached item to use directly. This function will retrieve it for you. + - A pointer to the cached item + A pointer to the cached item or NULL if it isn't there. - A #GtkMenuItem that may have a cached #DbusmenuMenuitem from the parser + A #GtkMenuItem that may have a cached #DbusmenuMenuitem from the parser - Goes through the GTK structures and turns them into the appropraite + Goes through the GTK structures and turns them into the appropraite Dbusmenu structures along with setting up all the relationships between the objects. It also stores the dbusmenu items as a cache on the GTK items so that they'll be reused if necissary. + - A dbusmenu item representing the menu structure + A dbusmenu item representing the menu structure - A #GtkMenuItem or #GtkMenuShell to turn into a #DbusmenuMenuitem + A #GtkMenuItem or #GtkMenuShell to turn into a #DbusmenuMenuitem + + In general, this is just a #GtkMenu, why else would you care? Oh, + because this menu is created by someone else on a server that exists + on the other side of DBus. You need a #DbusmenuServer to be able + push the data into this menu. + + The first thing you need to know is how to find that #DbusmenuServer + on DBus. This involves both the DBus name and the DBus object that + the menu interface can be found on. Those two value should be set + when creating the object using dbusmenu_gtkmenu_new(). They are then + stored on two properties #DbusmenuGtkMenu:dbus-name and #DbusmenuGtkMenu:dbus-object. + + After creation the #DbusmenuGtkMenu it will continue to keep in + synchronization with the #DbusmenuServer object across Dbus. If the + number of entries change, the menus change, if they change thier + properties change, they update in the items. All of this should + be handled transparently to the user of this object. + + + Some property helpers can't be done without picking up a GTK+ + dependency. So those sit in libdbusmenu-gtk but have very similar + prototypes to the code in libdbusmenu-glib so your code will + look consistent, just with the extra depedency. + - This function looks on the menu item for a property by the + This function looks on the menu item for a property by the name of @property. If one exists it tries to turn it into a #GdkPixbuf. It assumes that the property is a base64 encoded PNG file like the one created by #dbusmenu_menuite_property_set_image. + - A pixbuf or #NULL to signal error. + A pixbuf or #NULL to signal error. - The #DbusmenuMenuitem to look for the property on + The #DbusmenuMenuitem to look for the property on - The name of the property to look for. + The name of the property to look for. - This function gets a GTK shortcut as a key and a mask + This function gets a GTK shortcut as a key and a mask for use to set the accelerators. + - The #DbusmenuMenuitem to get the shortcut off + The #DbusmenuMenuitem to get the shortcut off - Location to put the key value + Location to put the key value - Location to put the modifier mask + Location to put the modifier mask - This function takes the pixbuf that is stored in @data and + This function takes the pixbuf that is stored in @data and turns it into a base64 encoded PNG so that it can be placed onto a standard #DbusmenuMenuitem property. + - Whether the function was able to set the property + Whether the function was able to set the property or not. - The #DbusmenuMenuitem to set the property on. + The #DbusmenuMenuitem to set the property on. - Name of the property to set. + Name of the property to set. - The image to place on the property. + The image to place on the property. - Takes the modifer described by @key and @modifier and places that into + Takes the modifer described by @key and @modifier and places that into the format sending across Dbus for shortcuts. + - Whether it was successful at setting the property. + Whether it was successful at setting the property. - The #DbusmenuMenuitem to set the shortcut on + The #DbusmenuMenuitem to set the shortcut on - The keycode of the key to send + The keycode of the key to send - A bitmask of modifiers used to activate the item + A bitmask of modifiers used to activate the item - Takes the shortcut that is installed on a menu item and calls + Takes the shortcut that is installed on a menu item and calls #dbusmenu_menuitem_property_set_shortcut with it. It also sets up listeners to watch it change. + - Whether it was successful at setting the property. + Whether it was successful at setting the property. - The #DbusmenuMenuitem to set the shortcut on + The #DbusmenuMenuitem to set the shortcut on - A menu item to steal the shortcut off of + A menu item to steal the shortcut off of - This function takes a GTK shortcut string as defined in + This function takes a GTK shortcut string as defined in #gtk_accelerator_parse and turns that into the information required to send it over DBusmenu. + - Whether it was successful at setting the property. + Whether it was successful at setting the property. - The #DbusmenuMenuitem to set the shortcut on + The #DbusmenuMenuitem to set the shortcut on - String describing the shortcut + String describing the shortcut + + The parser will take a GTK menu tree and attach it to a Dbusmenu menu + tree. Along with setting up all the signals for updates and destruction. + The returned item would be the root item of the given tree. + diff --git a/girs/DbusmenuGtk3-0.4.gir b/girs/DbusmenuGtk3-0.4.gir index f1b7120ed..8f58d6bfa 100644 --- a/girs/DbusmenuGtk3-0.4.gir +++ b/girs/DbusmenuGtk3-0.4.gir @@ -27,81 +27,120 @@ and/or use gtk-doc annotations. --> glib:type-name="DbusmenuGtkClient" glib:get-type="dbusmenu_gtkclient_get_type" glib:type-struct="ClientClass"> - A subclass of #DbusmenuClient to add functionality with regarding + A subclass of #DbusmenuClient to add functionality with regarding building GTK items out of the abstract tree. + - Creates a new #DbusmenuGtkClient object and creates a #DbusmenuClient + Creates a new #DbusmenuGtkClient object and creates a #DbusmenuClient that connects across DBus to a #DbusmenuServer. + - A new #DbusmenuGtkClient sync'd with a server + A new #DbusmenuGtkClient sync'd with a server - Name of the #DbusmenuServer on DBus + Name of the #DbusmenuServer on DBus - Name of the object on the #DbusmenuServer + Name of the object on the #DbusmenuServer - Gets the accel group for this client. + Gets the accel group for this client. + - Either a valid group or #NULL on error or + Either a valid group or #NULL on error or none set. - Client to query for an accelerator group + Client to query for an accelerator group - This grabs the #GtkMenuItem that is associated with the + This grabs the #GtkMenuItem that is associated with the #DbusmenuMenuitem. + - The #GtkMenuItem that can be played with. + The #GtkMenuItem that can be played with. - A #DbusmenuGtkClient with the item in it. + A #DbusmenuGtkClient with the item in it. - #DbusmenuMenuitem to get associated #GtkMenuItem on. + #DbusmenuMenuitem to get associated #GtkMenuItem on. - This grabs the submenu associated with the menuitem. + This grabs the submenu associated with the menuitem. + - The #GtkMenu if there is one. + The #GtkMenu if there is one. - A #DbusmenuGtkClient with the item in it. + A #DbusmenuGtkClient with the item in it. - #DbusmenuMenuitem to get associated #GtkMenu on. + #DbusmenuMenuitem to get associated #GtkMenu on. - This function provides some of the basic connectivity for being in + This function provides some of the basic connectivity for being in the GTK world. Things like visibility and sensitivity of the item are handled here so that the subclasses don't have to. If you're building your on GTK menu item you can use this function to apply those basic @@ -109,42 +148,58 @@ attributes so that you don't have to deal with them either. This also handles passing the "activate" signal back to the #DbusmenuMenuitem side of thing. + - The client handling everything on this connection + The client handling everything on this connection - The #DbusmenuMenuitem to attach the GTK-isms to + The #DbusmenuMenuitem to attach the GTK-isms to - A #GtkMenuItem representing the GTK world's view of this menuitem + A #GtkMenuItem representing the GTK world's view of this menuitem - The parent #DbusmenuMenuitem + The parent #DbusmenuMenuitem - Sets the acceleration group for the menu items with accelerators + Sets the acceleration group for the menu items with accelerators on this client. + - To set the group on + To set the group on - The new acceleration group + The new acceleration group @@ -159,13 +214,19 @@ on this client. - Functions and signal slots for using a #DbusmenuGtkClient + Functions and signal slots for using a #DbusmenuGtkClient + - #GtkMenuClass + #GtkMenuClass + @@ -178,6 +239,7 @@ on this client. + @@ -185,6 +247,7 @@ on this client. + @@ -192,6 +255,7 @@ on this client. + @@ -199,6 +263,7 @@ on this client. + @@ -206,6 +271,7 @@ on this client. + @@ -213,6 +279,7 @@ on this client. + @@ -221,13 +288,106 @@ on this client. + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="DbusmenuGtkMenu" glib:get-type="dbusmenu_gtkmenu_get_type" glib:type-struct="MenuClass"> - A #GtkMenu that is built using an abstract tree built from + A #GtkMenu that is built using an abstract tree built from a #DbusmenuGtkClient. + - Creates a new #DbusmenuGtkMenu object and creates a #DbusmenuClient + Creates a new #DbusmenuGtkMenu object and creates a #DbusmenuClient that connects across DBus to a #DbusmenuServer. + - A new #DbusmenuGtkMenu sync'd with a server + A new #DbusmenuGtkMenu sync'd with a server - Name of the #DbusmenuServer on DBus + Name of the #DbusmenuServer on DBus - Name of the object on the #DbusmenuServer + Name of the object on the #DbusmenuServer - An accessor for the client that this menu is using to + An accessor for the client that this menu is using to communicate with the server. + - A valid #DbusmenuGtkClient or NULL on error. + A valid #DbusmenuGtkClient or NULL on error. - The #DbusmenuGtkMenu to get the client from + The #DbusmenuGtkMenu to get the client from @@ -274,13 +453,15 @@ communicate with the server. + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="NULL"> @@ -293,14 +474,20 @@ communicate with the server. - All of the subclassable functions and signal slots for a + All of the subclassable functions and signal slots for a #DbusmenuGtkMenu. + - #GtkMenuClass + #GtkMenuClass + @@ -308,6 +495,7 @@ communicate with the server. + @@ -315,6 +503,7 @@ communicate with the server. + @@ -322,6 +511,7 @@ communicate with the server. + @@ -329,6 +519,7 @@ communicate with the server. + @@ -336,185 +527,317 @@ communicate with the server. + - + + + + In general, this is just a #GtkMenu, why else would you care? Oh, + because this menu is created by someone else on a server that exists + on the other side of DBus. You need a #DbusmenuServer to be able + push the data into this menu. + + The first thing you need to know is how to find that #DbusmenuServer + on DBus. This involves both the DBus name and the DBus object that + the menu interface can be found on. Those two value should be set + when creating the object using dbusmenu_gtkmenu_new(). They are then + stored on two properties #DbusmenuGtkClient:dbus-name and #DbusmenuGtkClient:dbus-object. + + After creation the #DbusmenuGtkClient it will continue to keep in + synchronization with the #DbusmenuServer object across Dbus. If the + number of entries change, the menus change, if they change thier + properties change, they update in the items. All of this should + be handled transparently to the user of this object. + - The Dbusmenu GTK parser adds cached items on the various + The Dbusmenu GTK parser adds cached items on the various menu items throughout the tree. Sometimes it can be useful to get that cached item to use directly. This function will retrieve it for you. + - A pointer to the cached item + A pointer to the cached item or NULL if it isn't there. - A #GtkMenuItem that may have a cached #DbusmenuMenuitem from the parser + A #GtkMenuItem that may have a cached #DbusmenuMenuitem from the parser - Goes through the GTK structures and turns them into the appropraite + Goes through the GTK structures and turns them into the appropraite Dbusmenu structures along with setting up all the relationships between the objects. It also stores the dbusmenu items as a cache on the GTK items so that they'll be reused if necissary. + - A dbusmenu item representing the menu structure + A dbusmenu item representing the menu structure - A #GtkMenuItem or #GtkMenuShell to turn into a #DbusmenuMenuitem + A #GtkMenuItem or #GtkMenuShell to turn into a #DbusmenuMenuitem + + In general, this is just a #GtkMenu, why else would you care? Oh, + because this menu is created by someone else on a server that exists + on the other side of DBus. You need a #DbusmenuServer to be able + push the data into this menu. + + The first thing you need to know is how to find that #DbusmenuServer + on DBus. This involves both the DBus name and the DBus object that + the menu interface can be found on. Those two value should be set + when creating the object using dbusmenu_gtkmenu_new(). They are then + stored on two properties #DbusmenuGtkMenu:dbus-name and #DbusmenuGtkMenu:dbus-object. + + After creation the #DbusmenuGtkMenu it will continue to keep in + synchronization with the #DbusmenuServer object across Dbus. If the + number of entries change, the menus change, if they change thier + properties change, they update in the items. All of this should + be handled transparently to the user of this object. + + + Some property helpers can't be done without picking up a GTK+ + dependency. So those sit in libdbusmenu-gtk but have very similar + prototypes to the code in libdbusmenu-glib so your code will + look consistent, just with the extra depedency. + - This function looks on the menu item for a property by the + This function looks on the menu item for a property by the name of @property. If one exists it tries to turn it into a #GdkPixbuf. It assumes that the property is a base64 encoded PNG file like the one created by #dbusmenu_menuite_property_set_image. + - A pixbuf or #NULL to signal error. + A pixbuf or #NULL to signal error. - The #DbusmenuMenuitem to look for the property on + The #DbusmenuMenuitem to look for the property on - The name of the property to look for. + The name of the property to look for. - This function gets a GTK shortcut as a key and a mask + This function gets a GTK shortcut as a key and a mask for use to set the accelerators. + - The #DbusmenuMenuitem to get the shortcut off + The #DbusmenuMenuitem to get the shortcut off - Location to put the key value + Location to put the key value - Location to put the modifier mask + Location to put the modifier mask - This function takes the pixbuf that is stored in @data and + This function takes the pixbuf that is stored in @data and turns it into a base64 encoded PNG so that it can be placed onto a standard #DbusmenuMenuitem property. + - Whether the function was able to set the property + Whether the function was able to set the property or not. - The #DbusmenuMenuitem to set the property on. + The #DbusmenuMenuitem to set the property on. - Name of the property to set. + Name of the property to set. - The image to place on the property. + The image to place on the property. - Takes the modifer described by @key and @modifier and places that into + Takes the modifer described by @key and @modifier and places that into the format sending across Dbus for shortcuts. + - Whether it was successful at setting the property. + Whether it was successful at setting the property. - The #DbusmenuMenuitem to set the shortcut on + The #DbusmenuMenuitem to set the shortcut on - The keycode of the key to send + The keycode of the key to send - A bitmask of modifiers used to activate the item + A bitmask of modifiers used to activate the item - Takes the shortcut that is installed on a menu item and calls + Takes the shortcut that is installed on a menu item and calls #dbusmenu_menuitem_property_set_shortcut with it. It also sets up listeners to watch it change. + - Whether it was successful at setting the property. + Whether it was successful at setting the property. - The #DbusmenuMenuitem to set the shortcut on + The #DbusmenuMenuitem to set the shortcut on - A menu item to steal the shortcut off of + A menu item to steal the shortcut off of - This function takes a GTK shortcut string as defined in + This function takes a GTK shortcut string as defined in #gtk_accelerator_parse and turns that into the information required to send it over DBusmenu. + - Whether it was successful at setting the property. + Whether it was successful at setting the property. - The #DbusmenuMenuitem to set the shortcut on + The #DbusmenuMenuitem to set the shortcut on - String describing the shortcut + String describing the shortcut + + The parser will take a GTK menu tree and attach it to a Dbusmenu menu + tree. Along with setting up all the signals for updates and destruction. + The returned item would be the root item of the given tree. + diff --git a/girs/Dee-1.0.gir b/girs/Dee-1.0.gir index 514c16dee..d4892056e 100644 --- a/girs/Dee-1.0.gir +++ b/girs/Dee-1.0.gir @@ -65,26 +65,26 @@ accessed directly c:identifier="dee_analyzer_collate_cmp_func"> A #GCompareDataFunc using a #DeeAnalyzer to compare the keys. This is just + line="474">A #GCompareDataFunc using a #DeeAnalyzer to compare the keys. This is just a convenience wrapper around dee_analyzer_collate_cmp(). -1, 0 or 1, if @key1 is &lt;, == or &gt; than @key2. + line="483">-1, 0 or 1, if @key1 is &lt;, == or &gt; than @key2. The first key to compare + line="476">The first key to compare The second key to compare + line="477">The second key to compare allow-none="1"> The #DeeAnalyzer to use for the comparison + line="478">The #DeeAnalyzer to use for the comparison @@ -101,7 +101,7 @@ a convenience wrapper around dee_analyzer_collate_cmp(). Register a #DeeTermFilterFunc to be called whenever dee_analyzer_analyze() + line="390">Register a #DeeTermFilterFunc to be called whenever dee_analyzer_analyze() is called. Term filters can be used to normalize, add, or remove terms from an input @@ -114,7 +114,7 @@ data stream. The analyzer to add a term filter to + line="392">The analyzer to add a term filter to destroy="2"> Function to call + line="393">Function to call allow-none="1"> Data to pass to @filter_func when it is invoked + line="394">Data to pass to @filter_func when it is invoked scope="async"> Called on @filter_data when the #DeeAnalyzer + line="395">Called on @filter_data when the #DeeAnalyzer owning the filter is destroyed @@ -152,7 +152,7 @@ data stream. Extract terms and or collation keys from some input data (which is normally, + line="328">Extract terms and or collation keys from some input data (which is normally, but not necessarily, a UTF-8 string). The terms and corresponding collation keys will be written in order to the @@ -170,13 +170,13 @@ Collation keys must be generated with dee_analyzer_collate_key(). The analyzer to use + line="330">The analyzer to use The input data to analyze + line="331">The input data to analyze allow-none="1"> A #DeeTermList to place the generated terms in. + line="332">A #DeeTermList to place the generated terms in. If %NULL to terms are generated @@ -195,7 +195,7 @@ Collation keys must be generated with dee_analyzer_collate_key(). allow-none="1"> A #DeeTermList to place generated collation keys in. + line="334">A #DeeTermList to place generated collation keys in. If %NULL no collation keys are generated @@ -204,7 +204,7 @@ Collation keys must be generated with dee_analyzer_collate_key(). Compare collation keys generated by dee_analyzer_collate_key() with similar + line="446">Compare collation keys generated by dee_analyzer_collate_key() with similar semantics as strcmp(). See also dee_analyzer_collate_cmp_func() if you need a version of this function that works as a #GCompareDataFunc. @@ -213,26 +213,26 @@ The default implementation in #DeeAnalyzer just uses strcmp(). -1, 0 or 1, if @key1 is &lt;, == or &gt; than @key2. + line="458">-1, 0 or 1, if @key1 is &lt;, == or &gt; than @key2. The analyzer to use when comparing collation keys + line="448">The analyzer to use when comparing collation keys The first collation key to compare + line="449">The first collation key to compare The second collation key to compare + line="450">The second collation key to compare @@ -240,7 +240,7 @@ The default implementation in #DeeAnalyzer just uses strcmp(). Generate a collation key for a set of input data (usually a UTF-8 string + line="419">Generate a collation key for a set of input data (usually a UTF-8 string passed through tokenization and term filters of the analyzer). The default implementation just calls g_strdup(). @@ -248,7 +248,7 @@ The default implementation just calls g_strdup(). A newly allocated collation key. Use dee_analyzer_collate_cmp() or + line="429">A newly allocated collation key. Use dee_analyzer_collate_cmp() or dee_analyzer_collate_cmp_func() to compare collation keys. Free with g_free(). @@ -257,13 +257,13 @@ The default implementation just calls g_strdup(). The analyzer to generate a collation key with + line="421">The analyzer to generate a collation key with The input data to generate a collation key for + line="422">The input data to generate a collation key for @@ -271,7 +271,7 @@ The default implementation just calls g_strdup(). Tokenize some input data (which is normally, but not necessarily, + line="363">Tokenize some input data (which is normally, but not necessarily, a UTF-8 string). Tokenization splits the input data into constituents (in most cases words), @@ -285,19 +285,19 @@ It is undefined if the tokenization process itself does any normalization. The analyzer to use + line="365">The analyzer to use The input data to analyze + line="366">The input data to analyze A #DeeTermList to place the generated tokens in. + line="367">A #DeeTermList to place the generated tokens in. @@ -306,7 +306,7 @@ It is undefined if the tokenization process itself does any normalization. c:identifier="dee_analyzer_add_term_filter"> Register a #DeeTermFilterFunc to be called whenever dee_analyzer_analyze() + line="390">Register a #DeeTermFilterFunc to be called whenever dee_analyzer_analyze() is called. Term filters can be used to normalize, add, or remove terms from an input @@ -319,7 +319,7 @@ data stream. The analyzer to add a term filter to + line="392">The analyzer to add a term filter to destroy="2"> Function to call + line="393">Function to call allow-none="1"> Data to pass to @filter_func when it is invoked + line="394">Data to pass to @filter_func when it is invoked scope="async"> Called on @filter_data when the #DeeAnalyzer + line="395">Called on @filter_data when the #DeeAnalyzer owning the filter is destroyed @@ -357,7 +357,7 @@ data stream. Extract terms and or collation keys from some input data (which is normally, + line="328">Extract terms and or collation keys from some input data (which is normally, but not necessarily, a UTF-8 string). The terms and corresponding collation keys will be written in order to the @@ -375,13 +375,13 @@ Collation keys must be generated with dee_analyzer_collate_key(). The analyzer to use + line="330">The analyzer to use The input data to analyze + line="331">The input data to analyze allow-none="1"> A #DeeTermList to place the generated terms in. + line="332">A #DeeTermList to place the generated terms in. If %NULL to terms are generated @@ -400,7 +400,7 @@ Collation keys must be generated with dee_analyzer_collate_key(). allow-none="1"> A #DeeTermList to place generated collation keys in. + line="334">A #DeeTermList to place generated collation keys in. If %NULL no collation keys are generated @@ -409,7 +409,7 @@ Collation keys must be generated with dee_analyzer_collate_key(). Compare collation keys generated by dee_analyzer_collate_key() with similar + line="446">Compare collation keys generated by dee_analyzer_collate_key() with similar semantics as strcmp(). See also dee_analyzer_collate_cmp_func() if you need a version of this function that works as a #GCompareDataFunc. @@ -418,26 +418,26 @@ The default implementation in #DeeAnalyzer just uses strcmp(). -1, 0 or 1, if @key1 is &lt;, == or &gt; than @key2. + line="458">-1, 0 or 1, if @key1 is &lt;, == or &gt; than @key2. The analyzer to use when comparing collation keys + line="448">The analyzer to use when comparing collation keys The first collation key to compare + line="449">The first collation key to compare The second collation key to compare + line="450">The second collation key to compare @@ -445,7 +445,7 @@ The default implementation in #DeeAnalyzer just uses strcmp(). Generate a collation key for a set of input data (usually a UTF-8 string + line="419">Generate a collation key for a set of input data (usually a UTF-8 string passed through tokenization and term filters of the analyzer). The default implementation just calls g_strdup(). @@ -453,7 +453,7 @@ The default implementation just calls g_strdup(). A newly allocated collation key. Use dee_analyzer_collate_cmp() or + line="429">A newly allocated collation key. Use dee_analyzer_collate_cmp() or dee_analyzer_collate_cmp_func() to compare collation keys. Free with g_free(). @@ -462,13 +462,13 @@ The default implementation just calls g_strdup(). The analyzer to generate a collation key with + line="421">The analyzer to generate a collation key with The input data to generate a collation key for + line="422">The input data to generate a collation key for @@ -476,7 +476,7 @@ The default implementation just calls g_strdup(). Tokenize some input data (which is normally, but not necessarily, + line="363">Tokenize some input data (which is normally, but not necessarily, a UTF-8 string). Tokenization splits the input data into constituents (in most cases words), @@ -490,19 +490,19 @@ It is undefined if the tokenization process itself does any normalization. The analyzer to use + line="365">The analyzer to use The input data to analyze + line="366">The input data to analyze A #DeeTermList to place the generated tokens in. + line="367">A #DeeTermList to place the generated tokens in. @@ -531,13 +531,13 @@ It is undefined if the tokenization process itself does any normalization. The analyzer to use + line="330">The analyzer to use The input data to analyze + line="331">The input data to analyze allow-none="1"> A #DeeTermList to place the generated terms in. + line="332">A #DeeTermList to place the generated terms in. If %NULL to terms are generated @@ -556,7 +556,7 @@ It is undefined if the tokenization process itself does any normalization. allow-none="1"> A #DeeTermList to place generated collation keys in. + line="334">A #DeeTermList to place generated collation keys in. If %NULL no collation keys are generated @@ -573,19 +573,19 @@ It is undefined if the tokenization process itself does any normalization. The analyzer to use + line="365">The analyzer to use The input data to analyze + line="366">The input data to analyze A #DeeTermList to place the generated tokens in. + line="367">A #DeeTermList to place the generated tokens in. @@ -601,7 +601,7 @@ It is undefined if the tokenization process itself does any normalization. The analyzer to add a term filter to + line="392">The analyzer to add a term filter to destroy="3"> Function to call + line="393">Function to call allow-none="1"> Data to pass to @filter_func when it is invoked + line="394">Data to pass to @filter_func when it is invoked scope="async"> Called on @filter_data when the #DeeAnalyzer + line="395">Called on @filter_data when the #DeeAnalyzer owning the filter is destroyed @@ -643,7 +643,7 @@ It is undefined if the tokenization process itself does any normalization. A newly allocated collation key. Use dee_analyzer_collate_cmp() or + line="429">A newly allocated collation key. Use dee_analyzer_collate_cmp() or dee_analyzer_collate_cmp_func() to compare collation keys. Free with g_free(). @@ -652,13 +652,13 @@ It is undefined if the tokenization process itself does any normalization. The analyzer to generate a collation key with + line="421">The analyzer to generate a collation key with The input data to generate a collation key for + line="422">The input data to generate a collation key for @@ -670,26 +670,26 @@ It is undefined if the tokenization process itself does any normalization. -1, 0 or 1, if @key1 is &lt;, == or &gt; than @key2. + line="458">-1, 0 or 1, if @key1 is &lt;, == or &gt; than @key2. The analyzer to use when comparing collation keys + line="448">The analyzer to use when comparing collation keys The first collation key to compare + line="449">The first collation key to compare The second collation key to compare + line="450">The second collation key to compare @@ -728,10 +728,13 @@ It is undefined if the tokenization process itself does any normalization. - + Ignore this structure. + line="39">Ignore this structure. @@ -770,21 +773,21 @@ It is undefined if the tokenization process itself does any normalization. Creates a new instance of #DeeClient and tries to connect to #DeeServer + line="239">Creates a new instance of #DeeClient and tries to connect to #DeeServer created using dee_server_new(). The #DeePeer:swarm-leader property will be set once the client connects. A newly constructed #DeeClient. + line="247">A newly constructed #DeeClient. Name of swarm to join. + line="241">Name of swarm to join. @@ -793,26 +796,26 @@ be set once the client connects. c:identifier="dee_client_new_for_address"> Creates a new instance of #DeeClient and tries to connect to @bus_address. + line="258">Creates a new instance of #DeeClient and tries to connect to @bus_address. The #DeePeer:swarm-leader property will be set once the client connects. A newly constructed #DeeClient. + line="266">A newly constructed #DeeClient. Name of swarm to join. + line="260">Name of swarm to join. D-Bus address to use when connecting to the server. + line="261">D-Bus address to use when connecting to the server. @@ -820,7 +823,8 @@ The #DeePeer:swarm-leader property will be set once the client connects. + transfer-ownership="none" + default-value="NULL"> @@ -838,10 +842,13 @@ The #DeePeer:swarm-leader property will be set once the client connects. - + Ignore this structure. + line="40">Ignore this structure. @@ -1039,7 +1046,7 @@ than @row2. Create a new #DeeFileResourceManager with its primary store- and load + line="173">Create a new #DeeFileResourceManager with its primary store- and load path set to @primary_path. You can manually add fallback search paths by calling @@ -1051,7 +1058,7 @@ you should call dee_resource_manager_get_default(). A newly allocated #DeeFileResourceManager. + line="187">A newly allocated #DeeFileResourceManager. Free with g_object_unref(). @@ -1059,7 +1066,7 @@ you should call dee_resource_manager_get_default(). The primary path used to store and load resources. + line="175">The primary path used to store and load resources. If you pass %NULL the manager will use a default path. @@ -1069,7 +1076,7 @@ you should call dee_resource_manager_get_default(). c:identifier="dee_file_resource_manager_add_search_path"> Add a path to the set of paths searched for resources. The manager will + line="202">Add a path to the set of paths searched for resources. The manager will first search the primary path as specified in the constructor and then search paths in the order they where added. @@ -1080,35 +1087,36 @@ search paths in the order they where added. The resource manager to add a search + line="204">The resource manager to add a search path to The path to add to the set of searched paths + line="206">The path to add to the set of searched paths + c:identifier="dee_file_resource_manager_get_primary_path" + glib:get-property="primary-path"> Helper method to access the :primary-path property. + line="226">Helper method to access the :primary-path property. The value of the :primary-path property + line="232">The value of the :primary-path property The resource manager to inspect + line="228">The resource manager to inspect @@ -1116,10 +1124,12 @@ path to + transfer-ownership="none" + getter="get_primary_path" + default-value="NULL"> Property holding the primary path used to store and load resources + line="147">Property holding the primary path used to store and load resources @@ -1666,21 +1676,21 @@ accessed directly A newly allocated #DeeFilterModel. Free with g_object_unref(). + line="385">A newly allocated #DeeFilterModel. Free with g_object_unref(). The back end model. This will be set as the + line="382">The back end model. This will be set as the #DeeProxyModel:back-end property Structure containing the logic used to create the filter model. + line="378">Structure containing the logic used to create the filter model. The filter model will create it's own copy of @filter so unless @filter is allocated statically or on the stack you need to free it after calling this method. @@ -1691,7 +1701,7 @@ accessed directly Includes @iter from the back end model in the filtered model, appending + line="421">Includes @iter from the back end model in the filtered model, appending it to the end of the filtered rows. This method is usually called when implementing #DeeFilterMapFunc or @@ -1700,7 +1710,7 @@ This method is usually called when implementing #DeeFilterMapFunc or Always returns @iter + line="432">Always returns @iter @@ -1715,25 +1725,25 @@ This method is usually called when implementing #DeeFilterMapFunc or Check if @iter from the back end model is mapped in @self. + line="403">Check if @iter from the back end model is mapped in @self. %TRUE if and only if @iter is contained in @self. + line="410">%TRUE if and only if @iter is contained in @self. The #DeeFilterModel to check + line="405">The #DeeFilterModel to check The #DeeModelIter to check + line="406">The #DeeModelIter to check @@ -1741,7 +1751,7 @@ This method is usually called when implementing #DeeFilterMapFunc or Includes @iter from the back end model in the filtered model, inserting it at + line="502">Includes @iter from the back end model in the filtered model, inserting it at @pos pushing other rows down. This method is usually called when implementing #DeeFilterMapFunc or @@ -1750,7 +1760,7 @@ This method is usually called when implementing #DeeFilterMapFunc or Always returns @iter + line="514">Always returns @iter @@ -1769,7 +1779,7 @@ This method is usually called when implementing #DeeFilterMapFunc or c:identifier="dee_filter_model_insert_iter_before"> Includes @iter from the back end model in the filtered model, inserting it at + line="530">Includes @iter from the back end model in the filtered model, inserting it at the position before @pos pushing other rows down. This method is usually called when implementing #DeeFilterMapFunc or @@ -1778,7 +1788,7 @@ This method is usually called when implementing #DeeFilterMapFunc or Always returns @iter + line="542">Always returns @iter @@ -1797,7 +1807,7 @@ This method is usually called when implementing #DeeFilterMapFunc or c:identifier="dee_filter_model_insert_iter_with_original_order"> Inserts @iter in @self in a way that is consistent with the ordering of the + line="580">Inserts @iter in @self in a way that is consistent with the ordering of the rows in the original #DeeModel behind @self. THis method assumes that @self is already ordered this way. If that's not the case then this method has undefined behaviour. @@ -1809,20 +1819,20 @@ accordance with the original models. Always returns @iter + line="595">Always returns @iter A #DeeFilterModel instance + line="583">A #DeeFilterModel instance Iterator + line="584">Iterator @@ -1830,7 +1840,7 @@ accordance with the original models. Includes @iter from the back end model in the filtered model, prepending + line="462">Includes @iter from the back end model in the filtered model, prepending it to the beginning of the filtered rows. This method is usually called when implementing #DeeFilterMapFunc or @@ -1839,7 +1849,7 @@ This method is usually called when implementing #DeeFilterMapFunc or Always returns @iter + line="473">Always returns @iter @@ -1857,7 +1867,7 @@ This method is usually called when implementing #DeeFilterMapFunc or transfer-ownership="none"> Property holding the #DeeFilter used to filter the model + line="320">Property holding the #DeeFilter used to filter the model defined in the #DeeFilterModel:back-end property. @@ -1910,10 +1920,11 @@ defined in the #DeeFilterModel:back-end property. + disguised="1" + opaque="1"> Ignore this structure. + line="68">Ignore this structure. Create a new hash index. + line="401">Create a new hash index. A newly allocated hash index. Free with g_object_unref(). + line="410">A newly allocated hash index. Free with g_object_unref(). The model to index + line="403">The model to index The #DeeAnalyzer used to tokenize and filter the terms extracted + line="404">The #DeeAnalyzer used to tokenize and filter the terms extracted by @reader The #DeeModelReader used to extract terms from the model + line="406">The #DeeModelReader used to extract terms from the model @@ -2072,7 +2083,10 @@ accessed directly - + handled in Dee - + Apply a #DeeICUTermFilter on a piece of UTF-8 text. + line="204">Apply a #DeeICUTermFilter on a piece of UTF-8 text. A newly allocated string. Free with g_free(). + line="211">A newly allocated string. Free with g_free(). The filter to apply + line="206">The filter to apply The text to apply the filter on + line="207">The text to apply the filter on @@ -2131,7 +2148,7 @@ error domain is #DEE_ICU_ERROR. Free all resources allocated by a #DeeICUTermFilter. + line="258">Free all resources allocated by a #DeeICUTermFilter. @@ -2140,7 +2157,7 @@ error domain is #DEE_ICU_ERROR. The filter to free + line="260">The filter to free @@ -2151,13 +2168,13 @@ error domain is #DEE_ICU_ERROR. throws="1"> Create a new #DeeICUTermFilter for a given ICU transliterator system id + line="134">Create a new #DeeICUTermFilter for a given ICU transliterator system id and/or set of transliteration rules. A newly allocated #DeeICUTermFilter. + line="145">A newly allocated #DeeICUTermFilter. Free with dee_icu_term_filter_destroy(). @@ -2165,7 +2182,7 @@ and/or set of transliteration rules. A system id for the transliterator to use. + line="136">A system id for the transliterator to use. See <link anchor="http://userguide.icu-project.org/transforms/general">userguide.icu-project.org/transforms/general</link> @@ -2175,7 +2192,7 @@ and/or set of transliteration rules. allow-none="1"> A set of transliteration rules to use. + line="138">A set of transliteration rules to use. See <link anchor="http://userguide.icu-project.org/transforms/general/rules">userguide.icu-project.org/transforms/general/rules</link> @@ -2186,12 +2203,12 @@ and/or set of transliteration rules. introspectable="0"> Construct a term filter that folds any UTF-8 string into ASCII. + line="190">Construct a term filter that folds any UTF-8 string into ASCII. A newly allocated #DeeICUTermFilter. Free with + line="195">A newly allocated #DeeICUTermFilter. Free with dee_icu_term_filter_destroy(). @@ -2580,7 +2597,7 @@ accessed directly Iterate over an index optionally starting from some given term. Note that + line="275">Iterate over an index optionally starting from some given term. Note that unordered indexes (like #DeeHashIndex) has undefined behaviour with this method. @@ -2591,13 +2608,13 @@ this method. The index to iterate over + line="277">The index to iterate over The term to start from or %NULL to iterate over all terms + line="278">The term to start from or %NULL to iterate over all terms closure="2"> Called for each term in the index + line="279">Called for each term in the index allow-none="1"> Arbitrary data to pass back to @func + line="280">Arbitrary data to pass back to @func @@ -2623,14 +2640,14 @@ this method. Get the number of indexed rows. A row is only indexed if it has at least one + line="370">Get the number of indexed rows. A row is only indexed if it has at least one term associated with it. If the analyzer has returned 0 terms then the row is omitted from the index. The number of rows in the index. Note that this may less than or + line="378">The number of rows in the index. Note that this may less than or equal to dee_model_get_n_rows(). @@ -2638,7 +2655,7 @@ is omitted from the index. The index to get the number of rows for + line="372">The index to get the number of rows for @@ -2646,25 +2663,25 @@ is omitted from the index. Get the number of rows that matches a given term + line="393">Get the number of rows that matches a given term The number of rows in the index registered for the given term + line="400">The number of rows in the index registered for the given term The index to inspect + line="395">The index to inspect The term to look for + line="396">The term to look for @@ -2672,19 +2689,19 @@ is omitted from the index. Get the number of terms in the index + line="350">Get the number of terms in the index The number of unique terms in the index + line="356">The number of unique terms in the index The index to get the number of terms for + line="352">The index to get the number of terms for @@ -2693,19 +2710,19 @@ is omitted from the index. invoker="get_supported_term_match_flags"> Get the #DeeTermMatchFlag<!-- --> supported by this #DeeIndex instance + line="415">Get the #DeeTermMatchFlag<!-- --> supported by this #DeeIndex instance A bit mask of the acceptedd #DeeTermMatchFlag<!-- -->s + line="421">A bit mask of the acceptedd #DeeTermMatchFlag<!-- -->s The index to inspect + line="417">The index to inspect @@ -2715,26 +2732,26 @@ is omitted from the index. A #DeeResultSet. Free with g_object_unref(). + line="210">A #DeeResultSet. Free with g_object_unref(). The index to perform the lookup in + line="205">The index to perform the lookup in The term to look up on + line="206">The term to look up on A bitmask of #DeeTermMatchFlag<!-- --> to control how matching is + line="207">A bitmask of #DeeTermMatchFlag<!-- --> to control how matching is done @@ -2743,7 +2760,7 @@ is omitted from the index. Iterate over an index optionally starting from some given term. Note that + line="275">Iterate over an index optionally starting from some given term. Note that unordered indexes (like #DeeHashIndex) has undefined behaviour with this method. @@ -2754,13 +2771,13 @@ this method. The index to iterate over + line="277">The index to iterate over The term to start from or %NULL to iterate over all terms + line="278">The term to start from or %NULL to iterate over all terms closure="2"> Called for each term in the index + line="279">Called for each term in the index allow-none="1"> Arbitrary data to pass back to @func + line="280">Arbitrary data to pass back to @func - + Get the analyzer being used to analyze terms extracted with the + line="317">Get the analyzer being used to analyze terms extracted with the #DeeModelReader used by this index. The #DeeAnalyzer used to analyze terms with + line="324">The #DeeAnalyzer used to analyze terms with The index to get the analyzer for + line="319">The index to get the analyzer for - + Get the model being indexed by this index + line="301">Get the model being indexed by this index The #DeeModel being indexed by this index + line="307">The #DeeModel being indexed by this index The index to get the model for + line="303">The index to get the model for @@ -2827,14 +2848,14 @@ this method. Get the number of indexed rows. A row is only indexed if it has at least one + line="370">Get the number of indexed rows. A row is only indexed if it has at least one term associated with it. If the analyzer has returned 0 terms then the row is omitted from the index. The number of rows in the index. Note that this may less than or + line="378">The number of rows in the index. Note that this may less than or equal to dee_model_get_n_rows(). @@ -2842,7 +2863,7 @@ is omitted from the index. The index to get the number of rows for + line="372">The index to get the number of rows for @@ -2851,25 +2872,25 @@ is omitted from the index. c:identifier="dee_index_get_n_rows_for_term"> Get the number of rows that matches a given term + line="393">Get the number of rows that matches a given term The number of rows in the index registered for the given term + line="400">The number of rows in the index registered for the given term The index to inspect + line="395">The index to inspect The term to look for + line="396">The term to look for @@ -2877,19 +2898,19 @@ is omitted from the index. Get the number of terms in the index + line="350">Get the number of terms in the index The number of unique terms in the index + line="356">The number of unique terms in the index The index to get the number of terms for + line="352">The index to get the number of terms for @@ -2897,19 +2918,19 @@ is omitted from the index. Get the reader being used to extract terms from rows in the model + line="334">Get the reader being used to extract terms from rows in the model The #DeeModelReader used to extract terms with + line="340">The #DeeModelReader used to extract terms with The index to get the reader for + line="336">The index to get the reader for @@ -2918,19 +2939,19 @@ is omitted from the index. c:identifier="dee_index_get_supported_term_match_flags"> Get the #DeeTermMatchFlag<!-- --> supported by this #DeeIndex instance + line="415">Get the #DeeTermMatchFlag<!-- --> supported by this #DeeIndex instance A bit mask of the acceptedd #DeeTermMatchFlag<!-- -->s + line="421">A bit mask of the acceptedd #DeeTermMatchFlag<!-- -->s The index to inspect + line="417">The index to inspect @@ -2940,26 +2961,26 @@ is omitted from the index. A #DeeResultSet. Free with g_object_unref(). + line="210">A #DeeResultSet. Free with g_object_unref(). The index to perform the lookup in + line="205">The index to perform the lookup in The term to look up on + line="206">The term to look up on A bitmask of #DeeTermMatchFlag<!-- --> to control how matching is + line="207">A bitmask of #DeeTermMatchFlag<!-- --> to control how matching is done @@ -2968,7 +2989,7 @@ is omitted from the index. Convenience function in for cases where you have a priori guarantee that + line="226">Convenience function in for cases where you have a priori guarantee that a dee_index_lookup() call will return exactly 0 or 1 row. If the lookup returns more than 1 row a warning will be printed on standard error and %NULL will be returned. @@ -2979,7 +3000,7 @@ a primary key in a relational database. A #DeeModelIter pointing to the matching + line="239">A #DeeModelIter pointing to the matching row or %NULL in case no rows matches @term @@ -2987,13 +3008,13 @@ a primary key in a relational database. The index to do the lookup in + line="228">The index to do the lookup in The exact term to match + line="229">The exact term to match @@ -3001,19 +3022,21 @@ a primary key in a relational database. + transfer-ownership="none" + getter="get_analyzer"> The #DeeAnalyzer used to analyze terms extracted by the model reader + line="169">The #DeeAnalyzer used to analyze terms extracted by the model reader + transfer-ownership="none" + getter="get_model"> The #DeeModel being indexed + line="157">The #DeeModel being indexed transfer-ownership="none"> The #DeeModelReader used to extract terms from rows in the model + line="183">The #DeeModelReader used to extract terms from rows in the model @@ -3046,26 +3069,26 @@ a primary key in a relational database. A #DeeResultSet. Free with g_object_unref(). + line="210">A #DeeResultSet. Free with g_object_unref(). The index to perform the lookup in + line="205">The index to perform the lookup in The term to look up on + line="206">The term to look up on A bitmask of #DeeTermMatchFlag<!-- --> to control how matching is + line="207">A bitmask of #DeeTermMatchFlag<!-- --> to control how matching is done @@ -3082,13 +3105,13 @@ a primary key in a relational database. The index to iterate over + line="277">The index to iterate over The term to start from or %NULL to iterate over all terms + line="278">The term to start from or %NULL to iterate over all terms closure="3"> Called for each term in the index + line="279">Called for each term in the index allow-none="1"> Arbitrary data to pass back to @func + line="280">Arbitrary data to pass back to @func @@ -3118,14 +3141,14 @@ a primary key in a relational database. The number of unique terms in the index + line="356">The number of unique terms in the index The index to get the number of terms for + line="352">The index to get the number of terms for @@ -3137,7 +3160,7 @@ a primary key in a relational database. The number of rows in the index. Note that this may less than or + line="378">The number of rows in the index. Note that this may less than or equal to dee_model_get_n_rows(). @@ -3145,7 +3168,7 @@ a primary key in a relational database. The index to get the number of rows for + line="372">The index to get the number of rows for @@ -3157,20 +3180,20 @@ a primary key in a relational database. The number of rows in the index registered for the given term + line="400">The number of rows in the index registered for the given term The index to inspect + line="395">The index to inspect The term to look for + line="396">The term to look for @@ -3182,14 +3205,14 @@ a primary key in a relational database. A bit mask of the acceptedd #DeeTermMatchFlag<!-- -->s + line="421">A bit mask of the acceptedd #DeeTermMatchFlag<!-- -->s The index to inspect + line="417">The index to inspect @@ -3279,10 +3302,13 @@ strategic points. - + Ignore this structure. + line="46">Ignore this structure. @@ -8558,6 +8584,7 @@ would always be non-empty. @@ -8837,7 +8864,7 @@ the @out_reader struct. - + The DeeModelTag structure is private and should only be used with the @@ -8917,13 +8944,13 @@ accessed directly Create a new #DeePeer. The peer will immediately connect to the swarm + line="800">Create a new #DeePeer. The peer will immediately connect to the swarm and start the peer discovery. A newly constructed #DeePeer. + line="808">A newly constructed #DeePeer. Free with g_object_unref(). @@ -8931,7 +8958,7 @@ and start the peer discovery. The name of the swarm to join. + line="802">The name of the swarm to join. Fx &quot;org.example.DataProviders&quot; @@ -8968,12 +8995,12 @@ and start the peer discovery. Gets list of #GDBusConnection instances used by this #DeePeer instance. + line="871">Gets list of #GDBusConnection instances used by this #DeePeer instance. + line="877"> List of connections. @@ -8983,7 +9010,7 @@ and start the peer discovery. a #DeePeer + line="873">a #DeePeer @@ -8991,13 +9018,13 @@ and start the peer discovery. In case this peer is connected to a message bus, gets the unique DBus + line="835">In case this peer is connected to a message bus, gets the unique DBus address of the current swarm leader, otherwise returns id of the leader. Unique DBus address of the current swarm leader, + line="842">Unique DBus address of the current swarm leader, possibly %NULL if the leader has not been detected yet @@ -9005,7 +9032,7 @@ address of the current swarm leader, otherwise returns id of the leader. a #DeePeer + line="837">a #DeePeer @@ -9015,7 +9042,7 @@ address of the current swarm leader, otherwise returns id of the leader. %TRUE if and only if this peer owns the swarm name on + line="823">%TRUE if and only if this peer owns the swarm name on the session bus @@ -9023,7 +9050,7 @@ address of the current swarm leader, otherwise returns id of the leader. a #DeePeer + line="821">a #DeePeer @@ -9031,12 +9058,12 @@ address of the current swarm leader, otherwise returns id of the leader. Gets list of all peers currently in this swarm. + line="889">Gets list of all peers currently in this swarm. List of peers (free using g_strfreev()). + line="895">List of peers (free using g_strfreev()). @@ -9045,7 +9072,7 @@ address of the current swarm leader, otherwise returns id of the leader. a #DeePeer + line="891">a #DeePeer @@ -9081,12 +9108,12 @@ address of the current swarm leader, otherwise returns id of the leader. Gets list of #GDBusConnection instances used by this #DeePeer instance. + line="871">Gets list of #GDBusConnection instances used by this #DeePeer instance. + line="877"> List of connections. @@ -9096,21 +9123,23 @@ address of the current swarm leader, otherwise returns id of the leader. a #DeePeer + line="873">a #DeePeer - + In case this peer is connected to a message bus, gets the unique DBus + line="835">In case this peer is connected to a message bus, gets the unique DBus address of the current swarm leader, otherwise returns id of the leader. Unique DBus address of the current swarm leader, + line="842">Unique DBus address of the current swarm leader, possibly %NULL if the leader has not been detected yet @@ -9118,28 +9147,30 @@ address of the current swarm leader, otherwise returns id of the leader. a #DeePeer + line="837">a #DeePeer - + Gets the unique name for this swarm. The swarm leader is the Peer owning + line="854">Gets the unique name for this swarm. The swarm leader is the Peer owning this name on the session bus. The swarm name + line="861">The swarm name a #DeePeer + line="856">a #DeePeer @@ -9149,7 +9180,7 @@ this name on the session bus. %TRUE if and only if this peer owns the swarm name on + line="823">%TRUE if and only if this peer owns the swarm name on the session bus @@ -9157,7 +9188,7 @@ this name on the session bus. a #DeePeer + line="821">a #DeePeer @@ -9165,7 +9196,7 @@ this name on the session bus. Gets the value of the :swarm-owner property. + line="906">Gets the value of the :swarm-owner property. Note that this does NOT mean that the peer is leader of the swarm! Check also dee_peer_is_swarm_leader(). @@ -9173,14 +9204,14 @@ dee_peer_is_swarm_leader(). TRUE if the :swarm-owner property was set during construction. + line="915">TRUE if the :swarm-owner property was set during construction. a #DeePeer + line="908">a #DeePeer @@ -9188,12 +9219,12 @@ dee_peer_is_swarm_leader(). Gets list of all peers currently in this swarm. + line="889">Gets list of all peers currently in this swarm. List of peers (free using g_strfreev()). + line="895">List of peers (free using g_strfreev()). @@ -9202,24 +9233,30 @@ dee_peer_is_swarm_leader(). a #DeePeer + line="891">a #DeePeer - + + transfer-ownership="none" + getter="get_swarm_name" + default-value="NULL"> + transfer-ownership="none" + default-value="FALSE"> @@ -9241,7 +9278,7 @@ dee_peer_is_swarm_leader(). Connect to this signal to be notified when peers close + line="504">Connect to this signal to be notified when peers close their #GDBusConnection. @@ -9250,7 +9287,7 @@ their #GDBusConnection. the closed #GDBusConnection + line="507">the closed #GDBusConnection @@ -9258,7 +9295,7 @@ their #GDBusConnection. Connect to this signal to be notified of existing and new peers that are + line="451">Connect to this signal to be notified of existing and new peers that are in your swarm. @@ -9267,7 +9304,7 @@ their #GDBusConnection. the DBus name of the object found + line="454">the DBus name of the object found @@ -9275,7 +9312,7 @@ their #GDBusConnection. Connect to this signal to be notified when peers disconnect from the swarm + line="469">Connect to this signal to be notified when peers disconnect from the swarm @@ -9283,7 +9320,7 @@ their #GDBusConnection. the DBus name of the object that disconnected + line="472">the DBus name of the object that disconnected @@ -9366,7 +9403,7 @@ their #GDBusConnection. Unique DBus address of the current swarm leader, + line="842">Unique DBus address of the current swarm leader, possibly %NULL if the leader has not been detected yet @@ -9374,7 +9411,7 @@ their #GDBusConnection. a #DeePeer + line="837">a #DeePeer @@ -9386,7 +9423,7 @@ their #GDBusConnection. %TRUE if and only if this peer owns the swarm name on + line="823">%TRUE if and only if this peer owns the swarm name on the session bus @@ -9394,7 +9431,7 @@ their #GDBusConnection. a #DeePeer + line="821">a #DeePeer @@ -9406,7 +9443,7 @@ their #GDBusConnection. + line="877"> List of connections. @@ -9416,7 +9453,7 @@ their #GDBusConnection. a #DeePeer + line="873">a #DeePeer @@ -9428,7 +9465,7 @@ their #GDBusConnection. List of peers (free using g_strfreev()). + line="895">List of peers (free using g_strfreev()). @@ -9437,7 +9474,7 @@ their #GDBusConnection. a #DeePeer + line="891">a #DeePeer @@ -9468,10 +9505,13 @@ their #GDBusConnection. - + Ignore this structure. + line="67">Ignore this structure. transfer-ownership="none"> The backend model used by this proxy model. + line="401">The backend model used by this proxy model. + transfer-ownership="none" + default-value="TRUE"> Boolean property defining whether sequence numbers will be inherited + line="427">Boolean property defining whether sequence numbers will be inherited from the back end model. You will most likely want to set this property to false if the implementation manipulates with the rows in the model and keep @@ -9513,10 +9554,11 @@ track of seqnums yourself. + transfer-ownership="none" + default-value="TRUE"> Boolean property defining whether or not to automatically forward signals + line="413">Boolean property defining whether or not to automatically forward signals from the back end model. This is especially useful for sub classes wishing to do their own more advanced signal forwarding. @@ -9571,10 +9613,11 @@ to do their own more advanced signal forwarding. + disguised="1" + opaque="1"> Ignore this structure. + line="54">Ignore this structure. Create a new #DeeSequenceModel. Before using it you must normally set a + line="1111">Create a new #DeeSequenceModel. Before using it you must normally set a schema on it by calling dee_model_set_schema(). A newly created + line="1117">A newly created #DeeSequenceModel. Free with g_object_unref(). @@ -10650,10 +10693,11 @@ schema on it by calling dee_model_set_schema(). + disguised="1" + opaque="1"> Ignore this structure. + line="57">Ignore this structure. Sequence number of this #DeeSerializableModel. + line="395">Sequence number of this #DeeSerializableModel. A #DeeSerializableModel instance + line="393">A #DeeSerializableModel instance @@ -10963,7 +11007,7 @@ accessed directly c:identifier="dee_serializable_model_inc_seqnum"> Increments sequence number of this #DeeSerializableModel. + line="439">Increments sequence number of this #DeeSerializableModel. @@ -10972,7 +11016,7 @@ accessed directly A #DeeSerializableModel instance + line="442">A #DeeSerializableModel instance @@ -10981,7 +11025,7 @@ accessed directly c:identifier="dee_serializable_model_set_seqnum"> Sets sequence number of this #DeeSerializableModel. + line="414">Sets sequence number of this #DeeSerializableModel. @@ -10990,13 +11034,13 @@ accessed directly A #DeeSerializableModel instance + line="417">A #DeeSerializableModel instance Sequence number + line="418">Sequence number @@ -11093,10 +11137,11 @@ accessed directly + disguised="1" + opaque="1"> Ignore this structure. + line="54">Ignore this structure. @@ -11133,7 +11178,7 @@ accessed directly Creates a new instance of #DeeServer and tries to bind + line="453">Creates a new instance of #DeeServer and tries to bind to #DeeServer:bus-address. The #DeePeer:swarm-leader property will be set when the binding succeeds. @@ -11150,14 +11195,14 @@ when the binding succeeds. A newly constructed #DeeServer. + line="471">A newly constructed #DeeServer. Name of swarm to join. + line="455">Name of swarm to join. @@ -11166,7 +11211,7 @@ when the binding succeeds. c:identifier="dee_server_new_for_address"> Creates a new instance of #DeeServer and tries to bind to @bus_address. + line="482">Creates a new instance of #DeeServer and tries to bind to @bus_address. The #DeePeer:swarm-leader property will be set when the binding succeeds. If there is already a #DeeServer instance bound to @bus_address, @@ -11185,20 +11230,20 @@ the connection will be shared with the newly constructed instance. A newly constructed #DeeServer. + line="503">A newly constructed #DeeServer. Name of swarm to join. + line="484">Name of swarm to join. D-Bus address to use for the connection. + line="485">D-Bus address to use for the connection. @@ -11207,13 +11252,13 @@ the connection will be shared with the newly constructed instance. c:identifier="dee_server_bus_address_for_name"> Helper method which creates bus address string for the given name, which + line="535">Helper method which creates bus address string for the given name, which should have the same format as a DBus unique name. Newly allocated string with bus address. + line="543">Newly allocated string with bus address. Use g_free() to free. @@ -11221,13 +11266,13 @@ should have the same format as a DBus unique name. A name to create bus address for. + line="537">A name to create bus address for. Include current user name as part of the bus address. + line="538">Include current user name as part of the bus address. @@ -11236,19 +11281,19 @@ should have the same format as a DBus unique name. c:identifier="dee_server_get_client_address"> Gets a D-Bus address string that can be used by clients to connect to server. + line="515">Gets a D-Bus address string that can be used by clients to connect to server. A D-Bus address string. Do not free. + line="521">A D-Bus address string. Do not free. A #DeeServer. + line="517">A #DeeServer. @@ -11256,13 +11301,15 @@ should have the same format as a DBus unique name. + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="TRUE"> @@ -11280,10 +11327,13 @@ should have the same format as a DBus unique name. - + Ignore this structure. + line="45">Ignore this structure. Create a new empty shared model without any column schema associated. + line="1752">Create a new empty shared model without any column schema associated. The column schema will be set in one of two ways: firstly you may set it manually with dee_model_set_schema() or secondly it will be set once the first rows are exchanged with a peer model. @@ -11317,14 +11367,14 @@ suitably picked memory backed model. a new #DeeSharedModel + line="1768">a new #DeeSharedModel A well known name to publish this model under. Models sharing this name + line="1754">A well known name to publish this model under. Models sharing this name will synchronize with each other @@ -11334,7 +11384,7 @@ suitably picked memory backed model. c:identifier="dee_shared_model_new_for_peer"> Create a new empty shared model without any column schema associated. + line="1783">Create a new empty shared model without any column schema associated. The column schema will be set in one of two ways: firstly you may set it manually with dee_model_set_schema() or secondly it will be set once the first rows are exchanged with a peer model. @@ -11348,14 +11398,14 @@ suitably picked memory backed model. a new #DeeSharedModel + line="1798">a new #DeeSharedModel A #DeePeer instance. + line="1785">A #DeePeer instance. @@ -11364,7 +11414,7 @@ suitably picked memory backed model. c:identifier="dee_shared_model_new_with_back_end"> Create a new shared model storing all data in @back_end. + line="1821">Create a new shared model storing all data in @back_end. The model will start synchronizing with peer models as soon as possible and the #DeeSharedModel:synchronized property will be set once finished. @@ -11372,21 +11422,21 @@ the #DeeSharedModel:synchronized property will be set once finished. a new #DeeSharedModel + line="1834">a new #DeeSharedModel A well known name to publish this model under. + line="1823">A well known name to publish this model under. Models sharing this name will synchronize with each other The #DeeModel that will actually store + line="1825">The #DeeModel that will actually store the model data. Ownership of the ref to @back_end is transfered to the shared model. @@ -11397,7 +11447,7 @@ the #DeeSharedModel:synchronized property will be set once finished. c:identifier="dee_shared_model_flush_revision_queue"> Expert: All changes to @self that has not yet been propagated to the peer + line="1978">Expert: All changes to @self that has not yet been propagated to the peer models are send. If you also want to block the mainloop until all the underlying transport streams have been flushed use dee_shared_model_flush_revision_queue_sync(). @@ -11414,14 +11464,14 @@ view-process, while holding on to the expensive changes a bit longer. The number of revisions flushed. + line="1996">The number of revisions flushed. The shared model to flush the revision queue on + line="1980">The shared model to flush the revision queue on @@ -11430,7 +11480,7 @@ view-process, while holding on to the expensive changes a bit longer. c:identifier="dee_shared_model_flush_revision_queue_sync"> Similar to dee_shared_model_flush_revision_queue(), but also blocks + line="2006">Similar to dee_shared_model_flush_revision_queue(), but also blocks the mainloop until all the underlying transport streams have been flushed. <emphasis>Important</emphasis>: This method <emphasis>may</emphasis> flush @@ -11440,55 +11490,58 @@ returns. The number of revisions flushed. + line="2017">The number of revisions flushed. The shared model to flush the revision queue on + line="2008">The shared model to flush the revision queue on + c:identifier="dee_shared_model_get_flush_mode" + glib:get-property="flush-mode"> Convenience function for accessing the #DeeSharedModel:flush-mode property. + line="1898">Convenience function for accessing the #DeeSharedModel:flush-mode property. The #DeeSharedModelFlushMode used by the model + line="1904">The #DeeSharedModelFlushMode used by the model A #DeeSharedModel + line="1900">A #DeeSharedModel - + Convenience function for accessing the #DeeSharedModel:peer property + line="1879">Convenience function for accessing the #DeeSharedModel:peer property The #DeePeer used to interact with the peer models + line="1885">The #DeePeer used to interact with the peer models The model to get the #DeePeer for + line="1881">The model to get the #DeePeer for @@ -11497,20 +11550,20 @@ returns. c:identifier="dee_shared_model_get_swarm_name"> Convenience function for accessing the #DeePeer:swarm-name property of the + line="1859">Convenience function for accessing the #DeePeer:swarm-name property of the #DeePeer defined in the #DeeSharedModel:peer property. The name of the swarm this model synchrnonizes with + line="1866">The name of the swarm this model synchrnonizes with The model to get the name for + line="1861">The model to get the name for @@ -11518,14 +11571,14 @@ returns. Check if the model is the swarm leader. This is a convenience function for + line="1931">Check if the model is the swarm leader. This is a convenience function for accessing the #DeeSharedModel:peer property and checking if it's the swarm leader. The value of dee_peer_is_swarm_leader() for the #DeePeer used by + line="1939">The value of dee_peer_is_swarm_leader() for the #DeePeer used by this shared model @@ -11533,7 +11586,7 @@ leader. The model to inspect + line="1933">The model to inspect @@ -11542,7 +11595,7 @@ leader. c:identifier="dee_shared_model_is_synchronized"> Check if the model is synchronized with its peers. Before modifying a + line="1953">Check if the model is synchronized with its peers. Before modifying a shared model in any way (except dee_model_set_schema()) you should wait for it to become synchronized. This is normally done by waiting for the &quot;notify::synchronized&quot; signal. @@ -11553,23 +11606,24 @@ This method is purely a convenience function for accessing the The value of the :synchronized property + line="1965">The value of the :synchronized property The model to inspect + line="1955">The model to inspect + c:identifier="dee_shared_model_set_flush_mode" + glib:set-property="flush-mode"> Convenience function for setting the #DeeSharedModel:flush-mode property. + line="1915">Convenience function for setting the #DeeSharedModel:flush-mode property. @@ -11578,13 +11632,13 @@ This method is purely a convenience function for accessing the A #DeeSharedModel + line="1917">A #DeeSharedModel Flush mode to use + line="1918">Flush mode to use @@ -11593,10 +11647,11 @@ This method is purely a convenience function for accessing the + transfer-ownership="none" + default-value="DEE_SHARED_MODEL_ACCESS_MODE_WORLD_WRITABLE"> Enumeration defining behavior of this model when trying to write to it. + line="733">Enumeration defining behavior of this model when trying to write to it. Setting this to #DEE_SHARED_MODEL_ACCESS_MODE_LEADER_WRITABLE is useful when one process is considered an "owner" of a model and all the other @@ -11605,10 +11660,15 @@ peers are supposed to only synchronize it for reading. See also DeePeer:swarm-owner property to ensure ownership of a swarm. - + Enumeration defining the flushing behavior. + line="752">Enumeration defining the flushing behavior. Setting this to #DEE_SHARED_MODEL_FLUSH_MODE_MANUAL will disable automatic flushing that usually happens when the application's main event @@ -11621,16 +11681,19 @@ explicitely. + transfer-ownership="none" + getter="get_peer"> The #DeePeer that this model uses to connect to the swarm + line="705">The #DeePeer that this model uses to connect to the swarm - + Boolean property defining whether or not the model has synchronized with + line="717">Boolean property defining whether or not the model has synchronized with its peers (if any) yet. You should not modify a #DeeSharedModel that is not synchronized. Before @@ -11647,7 +11710,7 @@ you should wait for it to become synchronized. Emitted right before a remote transaction will be committed to the model. + line="771">Emitted right before a remote transaction will be committed to the model. @@ -11655,13 +11718,13 @@ you should wait for it to become synchronized. The seqnum the model has now + line="774">The seqnum the model has now The seqnum the model will have after the transaction is applied + line="775">The seqnum the model will have after the transaction is applied @@ -11669,7 +11732,7 @@ you should wait for it to become synchronized. Emitted right after a remote transaction has been committed to the model. + line="789">Emitted right after a remote transaction has been committed to the model. @@ -11677,13 +11740,13 @@ you should wait for it to become synchronized. The seqnum the model had before the transaction was applied + line="792">The seqnum the model had before the transaction was applied The seqnum the model has now + line="793">The seqnum the model has now @@ -11700,12 +11763,14 @@ other peers in the swarm. + glib:nick="world-writable" + glib:name="DEE_SHARED_MODEL_ACCESS_MODE_WORLD_WRITABLE"> + glib:nick="leader-writable" + glib:name="DEE_SHARED_MODEL_ACCESS_MODE_LEADER_WRITABLE"> + glib:nick="automatic" + glib:name="DEE_SHARED_MODEL_FLUSH_MODE_AUTOMATIC"> + glib:nick="manual" + glib:name="DEE_SHARED_MODEL_FLUSH_MODE_MANUAL"> + disguised="1" + opaque="1"> Ignore this structure. + line="69">Ignore this structure. Add a term to the termlist. Note that it is possible to add a term multiple + line="198">Add a term to the termlist. Note that it is possible to add a term multiple times. The effect of this is determined by the #DeeModelIndex consuming the #DeeTermList. Always returns @self + line="207">Always returns @self The term list to add a term to + line="200">The term list to add a term to The term to add + line="201">The term to add @@ -11969,7 +12037,7 @@ times. The effect of this is determined by the #DeeModelIndex consuming the Remove all terms from a term list making it ready for reuse. Note that + line="241">Remove all terms from a term list making it ready for reuse. Note that term list implementations will often have optimized memory allocation schemes so reuse is often more efficient than allocating a new term list each time you need it. @@ -11977,14 +12045,14 @@ each time you need it. Always returns @self + line="250">Always returns @self The term list to clear + line="243">The term list to clear @@ -11992,7 +12060,7 @@ each time you need it. Create a copy of @self that shares the underlying string pool and containing + line="264">Create a copy of @self that shares the underlying string pool and containing a list of terms as currently set in @self. Subsequently freeing the original and keeping the clone around is not a @@ -12010,7 +12078,7 @@ This is because they share the underlying string pool. A newly allocated term list. + line="283">A newly allocated term list. Free with g_object_unref(). @@ -12018,7 +12086,7 @@ This is because they share the underlying string pool. The term list to clone + line="266">The term list to clone @@ -12026,7 +12094,7 @@ This is because they share the underlying string pool. Get the n'th term in the list. + line="173">Get the n'th term in the list. Note that in the default implementation it is guaranteed that the returned string is valid for the entire lifetime of the #DeeTermList. @@ -12034,20 +12102,20 @@ string is valid for the entire lifetime of the #DeeTermList. The @n<!-- -->th string held in the term list + line="183">The @n<!-- -->th string held in the term list The term list to get the @n<!-- -->th term from + line="175">The term list to get the @n<!-- -->th term from The (zero based) offset into the term list + line="176">The (zero based) offset into the term list @@ -12057,14 +12125,14 @@ string is valid for the entire lifetime of the #DeeTermList. The number of terms in the term list + line="227">The number of terms in the term list The term list to check the number of terms in + line="225">The term list to check the number of terms in @@ -12072,27 +12140,27 @@ string is valid for the entire lifetime of the #DeeTermList. Add a term to the termlist. Note that it is possible to add a term multiple + line="198">Add a term to the termlist. Note that it is possible to add a term multiple times. The effect of this is determined by the #DeeModelIndex consuming the #DeeTermList. Always returns @self + line="207">Always returns @self The term list to add a term to + line="200">The term list to add a term to The term to add + line="201">The term to add @@ -12100,7 +12168,7 @@ times. The effect of this is determined by the #DeeModelIndex consuming the Remove all terms from a term list making it ready for reuse. Note that + line="241">Remove all terms from a term list making it ready for reuse. Note that term list implementations will often have optimized memory allocation schemes so reuse is often more efficient than allocating a new term list each time you need it. @@ -12108,14 +12176,14 @@ each time you need it. Always returns @self + line="250">Always returns @self The term list to clear + line="243">The term list to clear @@ -12123,7 +12191,7 @@ each time you need it. Create a copy of @self that shares the underlying string pool and containing + line="264">Create a copy of @self that shares the underlying string pool and containing a list of terms as currently set in @self. Subsequently freeing the original and keeping the clone around is not a @@ -12141,7 +12209,7 @@ This is because they share the underlying string pool. A newly allocated term list. + line="283">A newly allocated term list. Free with g_object_unref(). @@ -12149,7 +12217,7 @@ This is because they share the underlying string pool. The term list to clone + line="266">The term list to clone @@ -12157,7 +12225,7 @@ This is because they share the underlying string pool. Get the n'th term in the list. + line="173">Get the n'th term in the list. Note that in the default implementation it is guaranteed that the returned string is valid for the entire lifetime of the #DeeTermList. @@ -12165,20 +12233,20 @@ string is valid for the entire lifetime of the #DeeTermList. The @n<!-- -->th string held in the term list + line="183">The @n<!-- -->th string held in the term list The term list to get the @n<!-- -->th term from + line="175">The term list to get the @n<!-- -->th term from The (zero based) offset into the term list + line="176">The (zero based) offset into the term list @@ -12188,14 +12256,14 @@ string is valid for the entire lifetime of the #DeeTermList. The number of terms in the term list + line="227">The number of terms in the term list The term list to check the number of terms in + line="225">The term list to check the number of terms in @@ -12220,20 +12288,20 @@ string is valid for the entire lifetime of the #DeeTermList. The @n<!-- -->th string held in the term list + line="183">The @n<!-- -->th string held in the term list The term list to get the @n<!-- -->th term from + line="175">The term list to get the @n<!-- -->th term from The (zero based) offset into the term list + line="176">The (zero based) offset into the term list @@ -12245,20 +12313,20 @@ string is valid for the entire lifetime of the #DeeTermList. Always returns @self + line="207">Always returns @self The term list to add a term to + line="200">The term list to add a term to The term to add + line="201">The term to add @@ -12270,14 +12338,14 @@ string is valid for the entire lifetime of the #DeeTermList. The number of terms in the term list + line="227">The number of terms in the term list The term list to check the number of terms in + line="225">The term list to check the number of terms in @@ -12289,14 +12357,14 @@ string is valid for the entire lifetime of the #DeeTermList. Always returns @self + line="250">Always returns @self The term list to clear + line="243">The term list to clear @@ -12308,7 +12376,7 @@ string is valid for the entire lifetime of the #DeeTermList. A newly allocated term list. + line="283">A newly allocated term list. Free with g_object_unref(). @@ -12316,7 +12384,7 @@ string is valid for the entire lifetime of the #DeeTermList. The term list to clone + line="266">The term list to clone @@ -12355,10 +12423,13 @@ string is valid for the entire lifetime of the #DeeTermList. - + Ignore this structure. + line="65">Ignore this structure. @@ -12420,7 +12491,8 @@ accessed directly + disguised="1" + opaque="1"> + line="1409"> A newly allocated #DeeTransaction. Free with g_object_unref() when done using it - no matter if you call dee_transaction_commit() or not. @@ -12451,7 +12523,7 @@ accessed directly The #DeeModel the transaction applies against + line="1407">The #DeeModel the transaction applies against @@ -12464,41 +12536,43 @@ accessed directly Apply a transaction to its target model. After this call the transaction + line="1472">Apply a transaction to its target model. After this call the transaction is invalidated and must be freed with g_object_unref(). %TRUE if and only if the transaction successfully applies to :target. + line="1481">%TRUE if and only if the transaction successfully applies to :target. The transaction to commit + line="1474">The transaction to commit - + Get the target model of a transaction. This is just a convenience method + line="1423">Get the target model of a transaction. This is just a convenience method for accessing the :target property. The target model + line="1430">The target model The transaction to retrieve the target model for + line="1425">The transaction to retrieve the target model for @@ -12506,13 +12580,13 @@ for accessing the :target property. Check if a #DeeTransaction has been committed. This method is mainly for + line="1440">Check if a #DeeTransaction has been committed. This method is mainly for debugging and testing purposes. %TRUE if and only if dee_transaction_commit() has completed + line="1447">%TRUE if and only if dee_transaction_commit() has completed successfully on the transaction. @@ -12520,7 +12594,7 @@ debugging and testing purposes. The transaction to inspect + line="1442">The transaction to inspect @@ -12528,7 +12602,8 @@ debugging and testing purposes. + transfer-ownership="none" + getter="get_target"> @@ -12604,7 +12679,8 @@ error domain is #DEE_TRANSACTION_ERROR. + disguised="1" + opaque="1"> Ignore this structure. @@ -12625,32 +12701,32 @@ accessed directly Create a new tree index. + line="732">Create a new tree index. A newly allocated tree index. Free with g_object_unref(). + line="741">A newly allocated tree index. Free with g_object_unref(). The model to index + line="734">The model to index The #DeeAnalyzer used to tokenize and filter the terms extracted + line="735">The #DeeAnalyzer used to tokenize and filter the terms extracted by @reader The #DeeModelReader used to extract terms from the model + line="737">The #DeeModelReader used to extract terms from the model @@ -12670,9 +12746,376 @@ accessed directly - + + + A #DeeAnalyzer takes a text stream, splits it into tokens, and runs the +tokens through a series of filtering steps. Optionally outputs collation +keys for the terms. + +One of the important use cases of analyzers in Dee is as vessel for the +indexing logic for creating a #DeeIndex from a #DeeModel. + +The recommended way to implement your own custom analyzers are by either +adding term filters to a #DeeAnalyzer or #DeeTextAnalyzer instance with +dee_analyzer_add_term_filter() and/or +derive your own subclass that overrides the dee_analyzer_tokenize() method. +Should you have very special requirements it is possible to reimplement +all aspects of the analyzer class though. + + + #DeeClient is the endpoint for connecting to #DeeServer. + + + This is an implementation of the #DeeResourceManager interface. +It uses atomic operations to write resources to files and memory maps +the resource files when you load them. + +Unless you have very specific circumstances you should normally not +create resource managers yourself, but get the default one for your +platform by calling dee_resource_manager_get_default(). + + + #DeeFilter<!-- -->s are used together with #DeeFilterModel<!-- -->s to build +"views" of some original #DeeModel. An example could be to build a view +of a model that exposes the rows of the original model sorted by a given +column (leaving the original model unaltered): +|[ + DeeModel *model, *view; + DeeFilter *collator; + + // Create and populate a model with some unsorted rows + model = dee_sequence_model_new (); + dee_model_set_schema (model, "i", "s", NULL); + dee_model_append (model, 27, "Foo"); + dee_model_append (model, 68, "Bar"); + + // Create a collator for column 1 + collator = dee_filter_new_collator (1); + + // Create the sorted view + view = dee_filter_model_new (collator, model); + g_free (collator); + + // When accessing the view the row with 'Bar' will be first +]| + + + A #DeeFilterModel should be regarded as a view on a specific subset of +of another #DeeModel, filtered according to a given "filtering rule". + +Filter models re-use the #DeeModelIter<!-- -->s of the back end model they +filter. This means that any iter from the filter model can be used directly +on the back end model. This is a powerful invariant, but implies the +restriction that a row in the filter model contains the exact same data +as the corresponding row in the back end model (ie. you can not apply +a "transfomation map" to the filtered data). + +The reuse of row iters also minimizes the amount of memory shuffling needed +to set up a filter model. The filtering functions, #DeeFilterMapFunc and +#DeeFilterMapNotify, has also been designed to minimize the amount of work +done to create a filter model. So if the filter functions are written +optimally the resulting filter models should be cheap to construct. + +Another important feature of the filter model is also that the rows +need not be in the same order as the original rows in the back end model. + +There is a suite of filters shipped with Dee which you can browse in the +<link linkend="dee-1.0-Filters.top_of_page">Filters section</link>. + + + GList implementation of a #DeeResultSet on top of a #GList + + + #DeeHashIndex is an implementation of #DeeHashIndex which is backed +by a hashmap. This means that it only supports the #DEE_TERM_MATCH_EXACT +flag in dee_hash_index_lookup(). + + + This module allows developers to easily construct powerful +#DeeTermFilter<!-- -->s with ease. The filters leverage the ICU +framework to provide world class transliteration features. + +The filters can be employed manually by calling dee_icu_term_filter_apply() +or installed in a #DeeAnalyzer by calling dee_analyzer_add_term_filter() +passing the term filter instance as the user data and +dee_icu_term_filter_destroy() as the #GDestroyNotify. + + + #DeeIndex is an interface for doing key based access to a #DeeModel. +A key in the index is known as a <emphasis>term</emphasis> and each term is +mapped to a set of matching #DeeModelIter<!-- -->s. + +The terms are calculated by means of a #DeeAnalyzer which extracts a set of +terms from a given row in the model adding these terms to a #DeeTermList. +There is a suite of analyzers shipped with Dee, which you can browse in the +<link linkend="dee-1.0-Analyzers.top_of_page">Analyzers section</link>. + + + #DeeModel is a generic table model that can holds #GVariant<!-- -->s as +column values. Each column is restricted to hold variants with some +predefined type signature. This is known as the +<emphasis>column schema</emphasis>. + +<refsect2 id="dee-1.0-DeeModel.on_indexes"> +<title>Indexes - Access by Key or Full Text Analysis</title> +<para> +Instead of forcing you to search the rows and columns for given values +or patterns #DeeModel is integrated with a powerful #DeeIndex that allows +you to create custom indexes over the model content that are updated +automatically as the model changes. +</para> +<para> +Indexes can be created for integer keys, string keys (fx. URIs), or for +full text search into the model contents. The indexing API is flexible +and extensible and can provide huge optimizations in terms of access times +if you find yourself iterating over the model searching for something. +</para> +</refsect2> + +<refsect2 id="dee-1.0-DeeModel.on_sorting"> +<title>Sorting</title> +<para> +As a simpler alternative to using indexes you can rely on sorted models. +This is done by using the dee_model_insert_sorted() and +dee_model_find_sorted() family of APIs. Some model classes have +accelerated implementations of sorted inserts and lookups. +Notably #DeeSequenceModel. +</para> +</refsect2> + +<refsect2 id="dee-1.0-DeeModel.on_tags"> +<title>Tags - Attach Arbitrary Data to Rows</title> +<para> +It's a very common pattern that you want to render a #DeeModel into some +view in a classinc MVC pattern. If the view needs to reflect changes in the +model dynamically you often find yourself creating ad-hoc mappings between +the rows of the model and the widgets in your view. +</para> +<para> +In situations where you need to pair the rows in a model with some external +data structure the <emphasis>tags API</emphasis> may come in handy. +It consists of the functions dee_model_register_tag(), dee_model_set_tag(), +dee_model_get_tag(), and dee_model_clear_tag(). +</para> +</refsect2> + + + The purpose of a #DeeModelReader is to extract string from a #DeeModel. +These strings are usually passed through a #DeeAnalyzer on into a #DeeIndex. + +Most readers will extract a value of a given type from a given column, +but it must be noted that this is not a requirement. The strings may be +built from several columns. + + + #DeePeer allows you to build objects that can rendevouz on DBus +without the need for an central registration service. Think of it like +peer-to-peer for your application. The DBus session bus will also implicitly +elect a swarm leader - namely the one owning the swarm name on the bus, but +it's up to the consumer of this API to determine whether swarm leadership has +any concrete responsibilities associated. + +Peers find eachother through a well-known "swarm-name", which is a +well known DBus name, such as: org.myapp.MyPeers. Choose a namespaced +name that would not normally be used outside of your program. + +For example: +<informalexample><programlisting> +{ + DeePeer *peer; + + peer = g_object_new (DBUS_TYPE_PEER, + "swarm-name", "org.myapp.MyPeers", + NULL); + + g_signal_connect (peer, "peer-found", + G_CALLBACK (on_peer_found), NULL); + g_signal_connect (peer, "peer-lost", + G_CALLBACK (on_peer_lost), NULL); +} +</programlisting></informalexample> + + + #DeeProxyModel wraps another #DeeModel instance and use it as a back end +by proxuing all method calls down to the back end. + + + The #DeeResourceManager API provides a simple API for storing and loading +DeeSerializable<!-- -->s from some persistent storage. The resources +are stored in a flat structure identified by names that should be chosen +similarly to DBus names. That is reverse domain names ala +net.launchpad.Example.MyData. + + + Interface for results returned by dee_index_lookup(). + +This interface utilizes a cursor-like metaphor. You advance the cursor +by calling dee_result_set_next() or adjust it manually by calling +dee_result_set_seek(). + +Calling dee_result_set_next() will also return the row at the +current cursor position. You may retrieve the current row without advancing +the cursor by calling dee_result_set_peek(). + + + #DeeSequenceModel is an implementation of the #DeeModel<!-- --> interface +backed by a #GSequence. It extends #DeeSerializableModel so that you may use +it as back end model for a #DeeSharedModel. + +The implementation is backed by a #GSequence giving a good tradeoff between +random access time versus random- insertion and deletion times. Notably the +dee_model_insert_sorted() and dee_model_find_sorted() methods use the +underlying tree structure to guarantee a <emphasis>O(log(N))</emphasis> +profile. + + + Interface for classes that can serialize to and from #GVariant<!-- -->s. + +There are two serialization concepts supported by this API: +<emphasis>serialization</emphasis> and <emphasis>externalization</emphasis>. +A serialized instance is created with dee_serializable_serialize() and can +be read back with dee_serializable_parse() provided you know the correct +#GType for the serialized data. The #GVariant representation of your +serialized data is guaranteed to be exactly as you implement yourself in the +@serialize vfunc of the #DeeSerializableIface. + +With externalized instances you don't have to know the correct GType to +recreate the instance. The #GType is encoded in the data itself. When you're +using dee_serializable_externalize() your data will be wrapped in a container +format with the required object metadata to read it back. For this reason +dee_serializable_parse_external() doesn't require you to pass in the #GType +you want to deserialize. + +<refsect2 id="dee-1.0-DeeSerializable.on_subclasses"> +<title>On Subclasses of DeeSerializable Types</title> +<para> +As a rule of thumb you need to re-implement the #DeeSerializable interface +and install parse functions with dee_serializable_register_parser() every +time you create a new class derived from a #DeeSerializable superclass. +</para> +<para> +In case a subclass does not provide it's own serialization interface +Dee will recurse upwards in the type hierarchy and use the serialization and +parser implementations of the first superclass with the required behaviour. +This means that the parsed instance will <emphasis>not</emphasis> be an +instance of the subclass but only of the serializable superclass. +Caveat emptor. +</para> +</refsect2> + + + #DeeSerializableModel is an abstract base class to ease implementation of +#DeeModel<!-- -->s providing rows versioned by a +<emphasis>sequence number</emphasis>. + + + #DeeServer allows you to create private connections (connections which +are not routed via dbus-daemon). Note that, unlike #DeePeer, #DeeServer +will always be swarm leader, and clients connected to it cannot overtake +swarm leadership once the server connection is closed. + + + #DeeSharedModel is created with a name (usually namespaced and unique to +your program(s)) which is used to locate other #DeeSharedModels created +with the same name through D-Bus, and will keep synchronized with them. + +This allows to you build MVC programs with a sane model API, but have the +controller (or multiple views) in a separate process. + +Before you modify the contents of the shared model it is important that +you wait for the model to synchronize with its peers. The normal way to do +this is to wait for the &quot;notify::synchronized&quot; signal. + + + #DeeTermList is a simple list type containing the indexed terms of a row +in a #DeeModel as recorded in a #DeeIndex. The terms are extracted from the +model by using a #DeeAnalyzer. + +The default implementation of #DeeTermList stores all terms in a string pool +and reuses terms from that string pool for the entire lifetime of the +term list. That is, even if you call dee_term_list_clear() on it. This +behaviour will save a lot of reallocations and g_strdup()<!-- -->s provided +there is reuse in the terms over time. + + + A #DeeTextAnalyzer is a #DeeAnalyzer that tokenizes UTF-8 text into words, +lower cases it, and does rudimentary normalization. Collation keys for the +current locale are generated. + + + #DeeTransaction is a self contained change set related to some particular +#DeeModel called the <emphasis>target model</emphasis>. + +The transaction instance itself implements the #DeeModel interface in a way +that overlays the target model. In database terms the target model has +isolation level READ_COMMITTED. Meaning that the target model is not modified +until you call dee_transaction_commit(). + +To flush the changes to the target model call dee_transaction_commit(). +After committing the transaction will become invalid and must be freed with +g_object_unref(). It is a programming error to try and access a transaction +that has been committed with the sole exception of calling +dee_transaction_is_committed(). + + + #DeeTreeIndex is an implementation of #DeeIndex which is backed +by a balanced binary tree. This means that it in addition to +#DEE_TERM_MATCH_EXACT also supports #DEE_TERM_MATCH_PREFIX as a flag in +dee_index_lookup(). + diff --git a/girs/Dex-1.gir b/girs/Dex-1.gir index a0cdbaa0e..8dbaf0960 100644 --- a/girs/Dex-1.gir +++ b/girs/Dex-1.gir @@ -7,6 +7,7 @@ and/or use gtk-doc annotations. --> xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> + If the DexAsyncPair is discarded by it's callers, then it will automatically be cancelled using g_cancellable_cancel(). - + - + @@ -231,7 +232,7 @@ be cancelled using g_cancellable_cancel(). Resolves @async_pair with @instance. - + @@ -268,7 +269,7 @@ This function is meant to be used when manually wrapping various #GAsyncReadyCallback based API. The ownership of @error is taken when calling this function. - + @@ -288,7 +289,7 @@ The ownership of @error is taken when calling this function. - + @@ -310,7 +311,7 @@ This function is meant to be used when manually wrapping various #GAsyncReadyCallback based API. The ownership of @instance is taken when calling this function. - + @@ -333,7 +334,7 @@ The ownership of @instance is taken when calling this function. Resolves @async_pair with @value. - + @@ -356,7 +357,7 @@ The ownership of @instance is taken when calling this function. - + @@ -374,7 +375,7 @@ The ownership of @instance is taken when calling this function. Resolves @async_pair with @variant. - + @@ -401,7 +402,7 @@ The ownership of @instance is taken when calling this function. line="377">Sets whether or not the future should cancel the async operation when the future is discarded. This happens when no more futures are awaiting the completion of this future. - + @@ -446,6 +447,12 @@ the completion of this future. glib:type-name="DexAsyncResult" glib:get-type="dex_async_result_get_type" glib:type-struct="AsyncResultClass"> + `DexAsyncResult` is used to integrate a `DexFuture` with `GAsyncResult`. + +Use this class when you need to expose the traditional async/finish +behavior of `GAsyncResult`. @@ -485,9 +492,9 @@ the completion of this future. Tracks the result of @future and uses the value to complete @async_result, + line="383">Tracks the result of @future and uses the value to complete @async_result, eventually calling the registered #GAsyncReadyCallback. - + @@ -495,13 +502,13 @@ eventually calling the registered #GAsyncReadyCallback. a #GAsyncResult + line="385">a #GAsyncResult a #DexFuture + line="386">a #DexFuture @@ -509,26 +516,26 @@ eventually calling the registered #GAsyncReadyCallback. Gets the future for the #DexAsyncResult, or %NULL if a future + line="181">Gets the future for the #DexAsyncResult, or %NULL if a future is not available. - + a #DexFuture or %NULL + line="188">a #DexFuture or %NULL a #DexAsyncResult + line="183">a #DexAsyncResult - + @@ -541,7 +548,7 @@ is not available. - + @@ -554,7 +561,7 @@ is not available. - + @@ -567,7 +574,7 @@ is not available. - + @@ -580,7 +587,7 @@ is not available. - + @@ -591,7 +598,7 @@ is not available. - + @@ -605,7 +612,7 @@ is not available. - + @@ -620,7 +627,7 @@ is not available. - + @@ -657,10 +664,17 @@ is not available. glib:type-name="DexBlock" glib:get-type="dex_block_get_type" glib:fundamental="1"> + #DexBlock represents a callback closure that can be scheduled to run +within a specific #GMainContext. + +You create these by chaining futures together using dex_future_then(), +dex_future_catch(), dex_future_finally() and similar. Gets the kind of block. + line="292">Gets the kind of block. The kind of block relates to what situations the block would be executed such as for handling a future resolution, rejection, or @@ -669,14 +683,14 @@ both. a #DexBlockKind + line="302">a #DexBlockKind a #DexBlock + line="294">a #DexBlock @@ -684,19 +698,19 @@ both. Gets the scheduler to use when executing a block. + line="312">Gets the scheduler to use when executing a block. a #DexScheduler + line="318">a #DexScheduler a #DexBlock + line="314">a #DexBlock @@ -751,6 +765,14 @@ both. glib:type-name="DexCancellable" glib:get-type="dex_cancellable_get_type" glib:fundamental="1"> + `DexCancellable` is a simple cancellation primitive which allows +for you to create `DexFuture` that will reject upon cancellation. + +Use this combined with other futures using dex_future_all_race() +to create a future that resolves when all other futures complete +or `dex_cancellable_cancel()` is called to reject. @@ -759,7 +781,7 @@ both. - + @@ -773,7 +795,7 @@ both. - + @@ -818,7 +840,7 @@ producer does not outpace the consumer. - + @@ -829,7 +851,7 @@ producer does not outpace the consumer. - + @@ -840,7 +862,7 @@ producer does not outpace the consumer. - + @@ -851,7 +873,7 @@ producer does not outpace the consumer. - + @@ -868,7 +890,7 @@ producer does not outpace the consumer. The resulting future will resolve or reject when an item is available to the channel or when send side has closed (in that order). - + - + - + glib:type-name="DexDelayed" glib:get-type="dex_delayed_get_type" glib:fundamental="1"> + #DexDelayed is a future which will resolve or reject the value of another +#DexFuture when dex_delayed_release() is called. + +This allows you to gate the resolution of a future which has already +resolved or rejected until a later moment. @@ -999,29 +1028,29 @@ rejected with %DEX_ERROR_CHANNEL_CLOSED. Retrieves the delayed future provided to dex_delayed_new(). + line="157">Retrieves the delayed future provided to dex_delayed_new(). This function can only return a #DexFuture before dex_delayed_release() is called. After that, the delayed future is released and this function will return %NULL. - + a #DexFuture or %NULL + line="167">a #DexFuture or %NULL a #DexDelayed + line="159">a #DexDelayed - + @@ -1102,6 +1131,25 @@ will return %NULL. glib:type-name="DexFiber" glib:get-type="dex_fiber_get_type" glib:fundamental="1"> + #DexFiber is a fiber (or coroutine) which itself is a #DexFuture. + +When the fiber completes execution it will either resolve or reject the +with the result or error. + +You may treat a #DexFiber like any other #DexFuture which makes it simple +to integrate fibers into other processing chains. + +#DexFiber are provided their own stack seperate from a threads main stack, +They are automatically scheduled as necessary. + +Use dex_await() and similar functions to await the result of another future +within the fiber and the fiber will be suspended allowing another fiber to +run and/or the rest of the applications main loop. + +Once a fiber is created, it is pinned to that scheduler. Use +dex_scheduler_spawn() to create a fiber on a specific scheduler. line="40">This function prototype is used for spawning fibers. A fiber is a lightweight, cooperative-multitasking feature where the fiber is given it's own stack. The fiber runs until it reaches -a point of suspention (using `dex_await` or similar) or exits +a point of suspension (using `dex_await` or similar) or exits the fiber. When suspended, the fiber is placed onto a queue until it is @@ -1146,36 +1194,50 @@ See `dex_scheduler_spawn()` glib:type-name="DexFuture" glib:get-type="dex_future_get_type" glib:fundamental="1"> + #DexFuture is the base class representing a future which may resolve with +a value or reject with error at some point in the future. + +It is the basis for libdex's concurrency and parallelism model. + +Use futures to represent work in progress and allow consumers to build +robust processing chains up front which will complete or fail as futures +resolve or reject. + +When running on a #DexFiber, you may use dex_await() and similar functions +to suspend the current thread and return upon completion of the dependent +future. Creates a new #DexFuture that will resolve or reject when all futures + line="634">Creates a new #DexFuture that will resolve or reject when all futures either resolve or reject. This method will return a #DexFutureSet which provides API to get the exact values of the dependent futures. The value of the future if resolved will be a %G_TYPE_BOOLEAN of %TRUE. - + a #DexFutureSet + line="646">a #DexFutureSet a #DexFuture + line="636">a #DexFuture a %NULL terminated list of futures + line="637">a %NULL terminated list of futures @@ -1186,7 +1248,7 @@ if resolved will be a %G_TYPE_BOOLEAN of %TRUE. introspectable="0"> Creates a new #DexFuture that will resolve when all futures resolve + line="690">Creates a new #DexFuture that will resolve when all futures resolve or reject as soon as the first future rejects. This method will return a #DexFutureSet which provides API to get @@ -1195,24 +1257,24 @@ will be propagated from the resolved or rejected future. Since the futures race to complete, some futures retrieved with the dex_future_set_get_future() API will still be %DEX_FUTURE_STATUS_PENDING. - + a #DexFutureSet + line="705">a #DexFutureSet a #DexFuture + line="692">a #DexFuture a %NULL terminated list of futures + line="693">a %NULL terminated list of futures @@ -1222,21 +1284,21 @@ dex_future_set_get_future() API will still be %DEX_FUTURE_STATUS_PENDING. shadows="all_race"> Creates a new #DexFuture that resolves when all futures resolve. + line="790">Creates a new #DexFuture that resolves when all futures resolve. If any future rejects, the resulting #DexFuture also rejects immediately. - + a #DexFuture + line="799">a #DexFuture an array of futures + line="792">an array of futures @@ -1244,7 +1306,7 @@ If any future rejects, the resulting #DexFuture also rejects immediately. the number of futures + line="793">the number of futures @@ -1252,22 +1314,22 @@ If any future rejects, the resulting #DexFuture also rejects immediately. Creates a new #DexFuture that resolves when all futures resolve. + line="810">Creates a new #DexFuture that resolves when all futures resolve. The resulting #DexFuture will not resolve or reject until all futures have either resolved or rejected. - + a #DexFuture + line="820">a #DexFuture an array of futures + line="812">an array of futures @@ -1275,7 +1337,7 @@ have either resolved or rejected. the number of futures + line="813">the number of futures @@ -1286,28 +1348,28 @@ have either resolved or rejected. introspectable="0"> Creates a new #DexFuture that will resolve when any dependent future + line="662">Creates a new #DexFuture that will resolve when any dependent future resolves, providing the same result as the resolved future. If no futures resolve, then the future will reject. - + a #DexFutureSet + line="672">a #DexFutureSet a #DexFuture + line="664">a #DexFuture a %NULL terminated list of futures + line="665">a %NULL terminated list of futures @@ -1315,21 +1377,21 @@ If no futures resolve, then the future will reject. Creates a new #DexFuture that resolves when the first future resolves. + line="770">Creates a new #DexFuture that resolves when the first future resolves. If all futures reject, then the #DexFuture returned will also reject. - + a #DexFuture + line="779">a #DexFuture an array of futures + line="772">an array of futures @@ -1337,7 +1399,7 @@ If all futures reject, then the #DexFuture returned will also reject. the number of futures + line="773">the number of futures @@ -1345,21 +1407,21 @@ If all futures reject, then the #DexFuture returned will also reject. Calls @callback when @future rejects. + line="576">Calls @callback when @future rejects. If @future resolves, then @callback will not be called. - + a #DexFuture + line="587">a #DexFuture a #DexFuture + line="578">a #DexFuture destroy="3"> a callback to execute + line="579">a callback to execute allow-none="1"> closure data for @callback + line="580">closure data for @callback scope="async"> destroy notify for @callback_data + line="581">destroy notify for @callback_data @@ -1394,23 +1456,23 @@ If @future resolves, then @callback will not be called. Asynchronously calls @callback when @future rejects. + line="512">Asynchronously calls @callback when @future rejects. This is similar to dex_future_catch() except that it will call @callback multiple times as each returned #DexFuture rejects, allowing for infinite loops. - + a #DexFuture + line="525">a #DexFuture a #DexFuture + line="514">a #DexFuture destroy="3"> a callback to execute + line="515">a callback to execute allow-none="1"> closure data for @callback + line="516">closure data for @callback scope="async"> destroy notify for @callback_data + line="517">destroy notify for @callback_data @@ -1445,19 +1507,19 @@ allowing for infinite loops. Calls @callback when @future resolves or rejects. - + line="606">Calls @callback when @future resolves or rejects. + a #DexFuture + line="615">a #DexFuture a #DexFuture + line="608">a #DexFuture destroy="3"> a callback to execute + line="609">a callback to execute allow-none="1"> closure data for @callback + line="610">closure data for @callback scope="async"> destroy notify for @callback_data + line="611">destroy notify for @callback_data @@ -1492,23 +1554,23 @@ allowing for infinite loops. Asynchronously calls @callback when @future rejects or resolves. + line="544">Asynchronously calls @callback when @future rejects or resolves. This is similar to dex_future_finally() except that it will call @callback multiple times as each returned #DexFuture rejects or resolves, allowing for infinite loops. - + a #DexFuture + line="557">a #DexFuture a #DexFuture + line="546">a #DexFuture destroy="3"> a callback to execute + line="547">a callback to execute allow-none="1"> closure data for @callback + line="548">closure data for @callback scope="async"> destroy notify for @callback_data + line="549">destroy notify for @callback_data @@ -1546,26 +1608,26 @@ allowing for infinite loops. introspectable="0"> Creates a new #DexFuture that resolves or rejects as soon as the + line="723">Creates a new #DexFuture that resolves or rejects as soon as the first dependent future resolves or rejects, sharing the same result. - + a #DexFutureSet + line="731">a #DexFutureSet a #DexFuture + line="725">a #DexFuture a %NULL terminated list of futures + line="726">a %NULL terminated list of futures @@ -1575,20 +1637,20 @@ first dependent future resolves or rejects, sharing the same result. shadows="first"> Creates a new #DexFuture that resolves or rejects as soon as the + line="750">Creates a new #DexFuture that resolves or rejects as soon as the first dependent future resolves or rejects, sharing the same result. - + a #DexFuture + line="758">a #DexFuture an array of futures + line="752">an array of futures @@ -1596,7 +1658,7 @@ first dependent future resolves or rejects, sharing the same result. the number of futures + line="753">the number of futures @@ -1605,19 +1667,19 @@ first dependent future resolves or rejects, sharing the same result. c:identifier="dex_future_new_for_boolean"> Creates a new #DexFuture and resolves it with @v_bool. - + line="896">Creates a new #DexFuture and resolves it with @v_bool. + a resolved #DexFuture + line="902">a resolved #DexFuture the resolved value for the future + line="898">the resolved value for the future @@ -1626,19 +1688,19 @@ first dependent future resolves or rejects, sharing the same result. c:identifier="dex_future_new_for_double"> Creates a new #DexFuture and resolves it with @v_double. - + line="1013">Creates a new #DexFuture and resolves it with @v_double. + a resolved #DexFuture + line="1019">a resolved #DexFuture the resolved value for the future + line="1015">the resolved value for the future @@ -1648,22 +1710,22 @@ first dependent future resolves or rejects, sharing the same result. version="0.4"> Creates a new rejected future using @errno_ as the value + line="1247">Creates a new rejected future using @errno_ as the value of errno for the GError. The resulting error domain will be %G_IO_ERROR. - + a rejected #DexFuture. + line="1256">a rejected #DexFuture. the `errno` to use for rejection + line="1249">the `errno` to use for rejection @@ -1672,19 +1734,19 @@ The resulting error domain will be %G_IO_ERROR. c:identifier="dex_future_new_for_error"> Creates a read-only #DexFuture that has rejected. - + line="880">Creates a read-only #DexFuture that has rejected. + a #DexFuture + line="886">a #DexFuture a #GError + line="882">a #GError @@ -1693,19 +1755,19 @@ The resulting error domain will be %G_IO_ERROR. c:identifier="dex_future_new_for_float"> Creates a new #DexFuture and resolves it with @v_float. - + line="991">Creates a new #DexFuture and resolves it with @v_float. + a resolved #DexFuture + line="997">a resolved #DexFuture the resolved value for the future + line="993">the resolved value for the future @@ -1713,19 +1775,19 @@ The resulting error domain will be %G_IO_ERROR. Creates a new #DexFuture and resolves it with @v_int. - + line="925">Creates a new #DexFuture and resolves it with @v_int. + a resolved #DexFuture + line="931">a resolved #DexFuture the resolved value for the future + line="927">the resolved value for the future @@ -1734,19 +1796,19 @@ The resulting error domain will be %G_IO_ERROR. c:identifier="dex_future_new_for_int64"> Creates a new #DexFuture and resolves it with @v_int64. - + line="947">Creates a new #DexFuture and resolves it with @v_int64. + a resolved #DexFuture + line="953">a resolved #DexFuture the resolved value for the future + line="949">the resolved value for the future @@ -1755,19 +1817,19 @@ The resulting error domain will be %G_IO_ERROR. c:identifier="dex_future_new_for_object"> Creates a new #DexFuture that is resolved with @value. - + line="1171">Creates a new #DexFuture that is resolved with @value. + a resolved #DexFuture + line="1177">a resolved #DexFuture the value + line="1173">the value @@ -1776,12 +1838,12 @@ The resulting error domain will be %G_IO_ERROR. c:identifier="dex_future_new_for_pointer"> Creates a new #DexFuture that is resolved with @pointer as a %G_TYPE_POINTER. - + line="1149">Creates a new #DexFuture that is resolved with @pointer as a %G_TYPE_POINTER. + a resolved #DexFuture + line="1155">a resolved #DexFuture @@ -1791,7 +1853,7 @@ The resulting error domain will be %G_IO_ERROR. allow-none="1"> the resolved future value as a pointer + line="1151">the resolved future value as a pointer @@ -1800,19 +1862,19 @@ The resulting error domain will be %G_IO_ERROR. c:identifier="dex_future_new_for_string"> Creates a new #DexFuture and resolves it with @string. - + line="1057">Creates a new #DexFuture and resolves it with @string. + a resolved #DexFuture + line="1063">a resolved #DexFuture the resolved value for the future + line="1059">the resolved value for the future @@ -1820,19 +1882,19 @@ The resulting error domain will be %G_IO_ERROR. Creates a new #DexFuture and resolves it with @v_uint. - + line="1035">Creates a new #DexFuture and resolves it with @v_uint. + a resolved #DexFuture + line="1041">a resolved #DexFuture the resolved value for the future + line="1037">the resolved value for the future @@ -1841,19 +1903,19 @@ The resulting error domain will be %G_IO_ERROR. c:identifier="dex_future_new_for_uint64"> Creates a new #DexFuture and resolves it with @v_uint64. - + line="969">Creates a new #DexFuture and resolves it with @v_uint64. + a resolved #DexFuture + line="975">a resolved #DexFuture the resolved value for the future + line="971">the resolved value for the future @@ -1862,19 +1924,19 @@ The resulting error domain will be %G_IO_ERROR. c:identifier="dex_future_new_for_value"> Creates a read-only #DexFuture that has resolved. - + line="864">Creates a read-only #DexFuture that has resolved. + a #DexFuture + line="870">a #DexFuture the resolved #GValue + line="866">the resolved #GValue @@ -1884,14 +1946,14 @@ The resulting error domain will be %G_IO_ERROR. version="0.4"> Creates an infinite future that will never resolve or reject. This can + line="1272">Creates an infinite future that will never resolve or reject. This can be useful when you want to mock a situation of "run forever" unless another future rejects or resolves. - + a #DexFuture that will never complete or reject + line="1279">a #DexFuture that will never complete or reject @@ -1900,31 +1962,31 @@ another future rejects or resolves. introspectable="0"> Creates a new #DexFuture that is rejeced. - + line="1219">Creates a new #DexFuture that is rejeced. + a new #DexFuture + line="1227">a new #DexFuture the error domain + line="1221">the error domain the error code + line="1222">the error code a printf-style format string + line="1223">a printf-style format string @@ -1937,19 +1999,19 @@ another future rejects or resolves. introspectable="0"> Creates a new #DexFuture that is resolved with @value. - + line="1101">Creates a new #DexFuture that is resolved with @value. + a resolved #DexFuture + line="1108">a resolved #DexFuture the GBoxed-based type + line="1103">the GBoxed-based type allow-none="1"> the value for the boxed type + line="1104">the value for the boxed type @@ -1967,19 +2029,19 @@ another future rejects or resolves. c:identifier="dex_future_new_take_object"> Creates a new #DexFuture that is resolved with @value. - + line="1195">Creates a new #DexFuture that is resolved with @value. + a resolved #DexFuture + line="1201">a resolved #DexFuture the value + line="1197">the value @@ -1988,19 +2050,19 @@ another future rejects or resolves. c:identifier="dex_future_new_take_string"> Creates a new #DexFuture and resolves it with @string. - + line="1079">Creates a new #DexFuture and resolves it with @string. + a resolved #DexFuture + line="1085">a resolved #DexFuture the resolved value for the future + line="1081">the resolved value for the future @@ -2010,19 +2072,19 @@ another future rejects or resolves. introspectable="0"> Creates a new #DexFuture that is resolved with @v_variant. - + line="1127">Creates a new #DexFuture that is resolved with @v_variant. + a resolved #DexFuture + line="1133">a resolved #DexFuture the variant to take ownership of + line="1129">the variant to take ownership of @@ -2030,21 +2092,21 @@ another future rejects or resolves. Calls @callback when @future resolves. + line="450">Calls @callback when @future resolves. If @future rejects, then @callback will not be called. - + a #DexFuture + line="461">a #DexFuture a #DexFuture + line="452">a #DexFuture destroy="3"> a callback to execute + line="453">a callback to execute allow-none="1"> closure data for @callback + line="454">closure data for @callback scope="async"> destroy notify for @callback_data + line="455">destroy notify for @callback_data @@ -2079,23 +2141,23 @@ If @future rejects, then @callback will not be called. Asynchronously calls @callback when @future resolves. + line="480">Asynchronously calls @callback when @future resolves. This is similar to dex_future_then() except that it will call @callback multiple times as each returned #DexFuture resolves or rejects, allowing for infinite loops. - + a #DexFuture + line="493">a #DexFuture a #DexFuture + line="482">a #DexFuture destroy="3"> a callback to execute + line="483">a callback to execute allow-none="1"> closure data for @callback + line="484">closure data for @callback scope="async"> destroy notify for @callback_data + line="485">destroy notify for @callback_data @@ -2130,7 +2192,7 @@ rejects, allowing for infinite loops. Suspends the current #DexFiber and resumes when @future has completed. + line="477">Suspends the current #DexFiber and resumes when @future has completed. If @future is completed when this function is called, the fiber will handle the result immediately. @@ -2143,11 +2205,11 @@ intermediate code to become invalid when resuming the stack. For example, if a foreach-style function taking a callback was to suspend from the callback, undefined behavior may occur such as thread-local-storage having changed. - + %TRUE if the future resolved, otherwise %FALSE + line="496">%TRUE if the future resolved, otherwise %FALSE and @error is set. @@ -2155,7 +2217,7 @@ having changed. a #DexFuture + line="479">a #DexFuture @@ -2163,21 +2225,21 @@ having changed. Awaits on @future and returns the gboolean result. + line="1590">Awaits on @future and returns the gboolean result. If the result is not a #gboolean, @error is set. - + the #gboolean, or %FALSE and @error is set + line="1599">the #gboolean, or %FALSE and @error is set a #DexFuture + line="1592">a #DexFuture @@ -2185,19 +2247,19 @@ If the result is not a #gboolean, @error is set. Awaits on @future and returns the %G_TYPE_BOXED based result. - + line="1510">Awaits on @future and returns the %G_TYPE_BOXED based result. + the boxed result, or %NULL and @error is set. + line="1517">the boxed result, or %NULL and @error is set. a #DexFuture + line="1512">a #DexFuture @@ -2205,21 +2267,21 @@ If the result is not a #gboolean, @error is set. Awaits on @future and returns the result as an double. + line="1454">Awaits on @future and returns the result as an double. The resolved value must be of type %G_TYPE_INT or @error is set. - + an double, or 0 in case of failure and @error is set. + line="1463">an double, or 0 in case of failure and @error is set. a #DexFuture + line="1456">a #DexFuture @@ -2227,21 +2289,21 @@ The resolved value must be of type %G_TYPE_INT or @error is set. Awaits on @future and returns the enum result. + line="1646">Awaits on @future and returns the enum result. If the result is not a %G_TYPE_ENUM, @error is set. - + the enum or 0 and @error is set. + line="1655">the enum or 0 and @error is set. a #DexFuture + line="1648">a #DexFuture @@ -2249,21 +2311,21 @@ If the result is not a %G_TYPE_ENUM, @error is set. Awaits on @future and returns the flags result. + line="1674">Awaits on @future and returns the flags result. If the result is not a %G_TYPE_FLAGS, @error is set. - + the flags or 0 and @error is set. + line="1683">the flags or 0 and @error is set. a #DexFuture + line="1676">a #DexFuture @@ -2271,21 +2333,21 @@ If the result is not a %G_TYPE_FLAGS, @error is set. Awaits on @future and returns the result as an float. + line="1482">Awaits on @future and returns the result as an float. The resolved value must be of type %G_TYPE_INT or @error is set. - + an float, or 0 in case of failure and @error is set. + line="1491">an float, or 0 in case of failure and @error is set. a #DexFuture + line="1484">a #DexFuture @@ -2293,21 +2355,21 @@ The resolved value must be of type %G_TYPE_INT or @error is set. Awaits on @future and returns the result as an int. + line="1342">Awaits on @future and returns the result as an int. The resolved value must be of type %G_TYPE_INT or @error is set. - + an int, or 0 in case of failure and @error is set. + line="1351">an int, or 0 in case of failure and @error is set. a #DexFuture + line="1344">a #DexFuture @@ -2315,21 +2377,21 @@ The resolved value must be of type %G_TYPE_INT or @error is set. Awaits on @future and returns the result as an int64. + line="1398">Awaits on @future and returns the result as an int64. The resolved value must be of type %G_TYPE_INT64 or @error is set. - + an int64, or 0 in case of failure and @error is set. + line="1407">an int64, or 0 in case of failure and @error is set. a #DexFuture + line="1400">a #DexFuture @@ -2337,19 +2399,19 @@ The resolved value must be of type %G_TYPE_INT64 or @error is set. Awaits on @future and returns the #GObject-based result. - + line="1564">Awaits on @future and returns the #GObject-based result. + the object, or %NULL and @error is set. + line="1571">the object, or %NULL and @error is set. a #DexFuture + line="1566">a #DexFuture @@ -2357,20 +2419,20 @@ The resolved value must be of type %G_TYPE_INT64 or @error is set. Calls dex_await() and returns the value of g_value_get_pointer(), + line="1315">Calls dex_await() and returns the value of g_value_get_pointer(), otherwise @error is set if the future rejected. - + a pointer or %NULL + line="1323">a pointer or %NULL a #DexFuture + line="1317">a #DexFuture @@ -2378,21 +2440,21 @@ otherwise @error is set if the future rejected. Awaits on @future and returns the string result. + line="1618">Awaits on @future and returns the string result. If the result is not a %G_TYPE_STRING, @error is set. - + the string or %NULL and @error is set + line="1627">the string or %NULL and @error is set a #DexFuture + line="1620">a #DexFuture @@ -2400,21 +2462,21 @@ If the result is not a %G_TYPE_STRING, @error is set. Awaits on @future and returns the result as an uint. + line="1370">Awaits on @future and returns the result as an uint. The resolved value must be of type %G_TYPE_INT or @error is set. - + an uint, or 0 in case of failure and @error is set. + line="1379">an uint, or 0 in case of failure and @error is set. a #DexFuture + line="1372">a #DexFuture @@ -2422,21 +2484,21 @@ The resolved value must be of type %G_TYPE_INT or @error is set. Awaits on @future and returns the result as an uint64. + line="1426">Awaits on @future and returns the result as an uint64. The resolved value must be of type %G_TYPE_INT64 or @error is set. - + an uint64, or 0 in case of failure and @error is set. + line="1435">an uint64, or 0 in case of failure and @error is set. a #DexFuture + line="1428">a #DexFuture @@ -2447,19 +2509,19 @@ The resolved value must be of type %G_TYPE_INT64 or @error is set. throws="1"> Awaits on @future and returns the %G_TYPE_VARIANT based result. - + line="1536">Awaits on @future and returns the %G_TYPE_VARIANT based result. + the variant result, or %NULL and @error is set. + line="1543">the variant result, or %NULL and @error is set. a #DexFuture + line="1538">a #DexFuture @@ -2467,9 +2529,9 @@ The resolved value must be of type %G_TYPE_INT64 or @error is set. Disowns a future, allowing it to run to completion even though there may + line="1731">Disowns a future, allowing it to run to completion even though there may be no observer interested in the futures completion or rejection. - + @@ -2477,13 +2539,13 @@ be no observer interested in the futures completion or rejection. a #DexFuture + line="1733">a #DexFuture - + @@ -2505,7 +2567,7 @@ be no observer interested in the futures completion or rejection. - + @@ -2515,16 +2577,80 @@ be no observer interested in the futures completion or rejection. + + This is a convenience function equivalent to calling +dex_future_get_status() and checking for %DEX_FUTURE_STATUS_PENDING. + + + %TRUE if the future is still pending; otherwise %FALSE + + + + + a #DexFuture + + + + + + This is a convenience function equivalent to calling +dex_future_get_status() and checking for %DEX_FUTURE_STATUS_REJECTED. + + + %TRUE if the future was rejected with an error; otherwise %FALSE + + + + + a #DexFuture + + + + + + This is a convenience function equivalent to calling +dex_future_get_status() and checking for %DEX_FUTURE_STATUS_RESOLVED. + + + %TRUE if the future has successfully resolved with a value; + otherwise %FALSE + + + + + a #DexFuture + + + + Sets the name of the future with a static/internal string. + line="829">Sets the name of the future with a static/internal string. @name will not be copied, so it must be static/internal which can be done either by using string literals or by using g_string_intern(). - + @@ -2532,13 +2658,13 @@ either by using string literals or by using g_string_intern(). a #DexFuture + line="831">a #DexFuture the name of the future + line="832">the name of the future @@ -2590,10 +2716,19 @@ This is the expected way to handle completion of a future when not using glib:type-name="DexFutureSet" glib:get-type="dex_future_set_get_type" glib:fundamental="1"> + #DexFutureSet represents a set of #DexFuture. + +You may retrieve each underlying #DexFuture using +dex_future_set_get_future_at(). + +The #DexFutureStatus of of the #DexFutureSet depends on how the set +was created using dex_future_all(), dex_future_any(), and similar mmethods. Gets a #DexFuture that was used to produce the result of @future_set. + line="326">Gets a #DexFuture that was used to produce the result of @future_set. Use dex_future_set_get_size() to determine the number of #DexFuture that are contained within the #DexFutureSet. @@ -2601,14 +2736,14 @@ are contained within the #DexFutureSet. a #DexFuture + line="335">a #DexFuture a #DexFutureSet + line="328">a #DexFutureSet @@ -2619,20 +2754,20 @@ are contained within the #DexFutureSet. Gets the number of futures associated with the #DexFutureSet. You may + line="309">Gets the number of futures associated with the #DexFutureSet. You may use dex_future_set_get_future_at() to obtain the individual #DexFuture. the number of #DexFuture in @future_set. + line="316">the number of #DexFuture in @future_set. a #DexFutureSet + line="311">a #DexFutureSet @@ -2642,13 +2777,13 @@ use dex_future_set_get_future_at() to obtain the individual #DexFuture. throws="1"> Gets the result from a #DexFuture that is part of the + line="347">Gets the result from a #DexFuture that is part of the #DexFutureSet. a #GValue if successful; otherwise %NULL + line="356">a #GValue if successful; otherwise %NULL and @error is set. @@ -2656,13 +2791,13 @@ use dex_future_set_get_future_at() to obtain the individual #DexFuture. a #DexFutureSet + line="349">a #DexFutureSet the #DexFuture position within the set + line="350">the #DexFuture position within the set @@ -2857,6 +2992,15 @@ use dex_future_set_get_future_at() to obtain the individual #DexFuture. glib:type-name="DexMainScheduler" glib:get-type="dex_main_scheduler_get_type" glib:fundamental="1"> + #DexMainScheduler is the scheduler used on the default thread of an +application. It is meant to integrate with your main loop. + +This scheduler does the bulk of the work in an application. + +Use #DexThreadPoolScheduler when you want to offload work to a thread +and still use future-based programming. @@ -2960,6 +3104,13 @@ If it was the last reference, the resources associated to the instance are freed glib:type-name="DexPromise" glib:get-type="dex_promise_get_type" glib:fundamental="1"> + #DexPromise is a convenient #DexFuture for prpoagating a result or +rejection in appliction and library code. + +Use this when there is not a more specialized #DexFuture for your needs to +propagate a result or rejection to the caller in an asynchronous fashion. @@ -2970,16 +3121,16 @@ If it was the last reference, the resources associated to the instance are freed c:identifier="dex_promise_new_cancellable"> Creates a new #DexPromise that can propagate cancellation if the + line="93">Creates a new #DexPromise that can propagate cancellation if the promise is discarded. This can be used to plumb cancellation between promises and #GAsyncReadyCallback based APIs. - + a #DexPromise + line="102">a #DexPromise @@ -2987,25 +3138,25 @@ This can be used to plumb cancellation between promises and c:identifier="dex_promise_get_cancellable"> Gets a #GCancellable that will cancel when the promise has + line="114">Gets a #GCancellable that will cancel when the promise has been discarded (and therefore result no longer necessary). This is useful when manually implementing wrappers around various #GAsyncReadyCallback based API. If @promise was created with dex_promise_new(), then %NULL is returned. - + a #GCancellable or %NULL + line="126">a #GCancellable or %NULL a #DexPromise + line="116">a #DexPromise @@ -3013,8 +3164,8 @@ If @promise was created with dex_promise_new(), then %NULL is returned. Marks the promise as rejected, indicating a failure. - + line="153">Marks the promise as rejected, indicating a failure. + @@ -3022,13 +3173,13 @@ If @promise was created with dex_promise_new(), then %NULL is returned. a #DexPromise + line="155">a #DexPromise a #GError + line="156">a #GError @@ -3036,8 +3187,8 @@ If @promise was created with dex_promise_new(), then %NULL is returned. Sets the result for a #DexPromise. - + line="136">Sets the result for a #DexPromise. + @@ -3045,20 +3196,20 @@ If @promise was created with dex_promise_new(), then %NULL is returned. a #DexPromise + line="138">a #DexPromise a #GValue containing the resolved value + line="139">a #GValue containing the resolved value - + @@ -3072,7 +3223,7 @@ If @promise was created with dex_promise_new(), then %NULL is returned. - + @@ -3086,7 +3237,7 @@ If @promise was created with dex_promise_new(), then %NULL is returned. - + @@ -3100,7 +3251,7 @@ If @promise was created with dex_promise_new(), then %NULL is returned. - + @@ -3114,7 +3265,7 @@ If @promise was created with dex_promise_new(), then %NULL is returned. - + @@ -3128,7 +3279,7 @@ If @promise was created with dex_promise_new(), then %NULL is returned. - + @@ -3142,7 +3293,7 @@ If @promise was created with dex_promise_new(), then %NULL is returned. - + @@ -3150,7 +3301,7 @@ If @promise was created with dex_promise_new(), then %NULL is returned. a #DexPromise + line="259">a #DexPromise allow-none="1"> a #GObject + line="260">a #GObject - + @@ -3173,19 +3324,19 @@ If @promise was created with dex_promise_new(), then %NULL is returned. a #DexPromise + line="244">a #DexPromise a string to use to resolve the promise + line="245">a string to use to resolve the promise - + @@ -3199,7 +3350,7 @@ If @promise was created with dex_promise_new(), then %NULL is returned. - + @@ -3213,7 +3364,7 @@ If @promise was created with dex_promise_new(), then %NULL is returned. - + @@ -3253,18 +3404,29 @@ If @promise was created with dex_promise_new(), then %NULL is returned. glib:type-name="DexScheduler" glib:get-type="dex_scheduler_get_type" glib:fundamental="1"> + #DexScheduler is the base class used by schedulers. + +Schedulers are responsible for ensuring asynchronous IO requests and +completions are processed. They also schedule closures to be run as part +of future result propagation. Additionally, they manage #DexFiber execution +and suspension. + +Specialized schedulers such as #DexThreadPoolScheduler will do this for a +number of threads and dispatch new work between them. Gets the default scheduler for the process. + line="60">Gets the default scheduler for the process. The default scheduler executes tasks within the default #GMainContext. Typically that is the main thread of the application. - + a #DexScheduler + line="68">a #DexScheduler @@ -3272,12 +3434,12 @@ Typically that is the main thread of the application. c:identifier="dex_scheduler_get_thread_default"> Gets the default scheduler for the thread. + line="85">Gets the default scheduler for the thread. a #DexScheduler or %NULL + line="90">a #DexScheduler or %NULL @@ -3285,12 +3447,12 @@ Typically that is the main thread of the application. c:identifier="dex_scheduler_ref_thread_default"> Gets the thread default scheduler with the reference count incremented. + line="104">Gets the thread default scheduler with the reference count incremented. a #DexScheduler or %NULL + line="109">a #DexScheduler or %NULL @@ -3298,7 +3460,7 @@ Typically that is the main thread of the application. c:identifier="dex_scheduler_get_main_context"> Gets the default main context for a scheduler. + line="141">Gets the default main context for a scheduler. This may be a different value depending on the calling thread. @@ -3308,18 +3470,18 @@ process. However, calling from a worker thread may give you a #GMainContext specifically for that thread. - + a #GMainContext + line="156">a #GMainContext a #DexScheduler + line="143">a #DexScheduler @@ -3327,8 +3489,8 @@ specifically for that thread. Queues @func to run on @scheduler. - + line="122">Queues @func to run on @scheduler. + @@ -3336,7 +3498,7 @@ specifically for that thread. a #DexScheduler + line="124">a #DexScheduler closure="1"> the function callback + line="125">the function callback allow-none="1"> the closure data for @func + line="126">the closure data for @func @@ -3362,18 +3524,18 @@ specifically for that thread. Request @scheduler to spawn a #DexFiber. + line="180">Request @scheduler to spawn a #DexFiber. The fiber will have it's own stack and cooperatively schedules among other fibers sharing the schaeduler. If @stack_size is 0, it will set to a sensible default. Otherwise, it is rounded up to the nearest page size. - + a #DexFuture that will resolve or reject when + line="196">a #DexFuture that will resolve or reject when @func completes (or it's resulting #DexFuture completes). @@ -3384,13 +3546,13 @@ rounded up to the nearest page size. allow-none="1"> a #DexScheduler + line="182">a #DexScheduler stack size in bytes or 0 + line="183">stack size in bytes or 0 destroy="3"> a #DexFiberFunc + line="184">a #DexFiberFunc closure="1"> closure data for @func + line="185">closure data for @func destroy="1"> closure notify for @func_data + line="186">closure notify for @func_data @@ -3450,6 +3612,16 @@ rounded up to the nearest page size. glib:type-name="DexStaticFuture" glib:get-type="dex_static_future_get_type" glib:fundamental="1"> + `DexStaticFuture` represents a future that is resolved from the initial +state. + +Use this when you need to create a future for API reasons but already have +the value or rejection at that point. + +#DexStaticFuture is used internally by functions like +dex_future_new_for_boolean() and similar. glib:type-name="DexThreadPoolScheduler" glib:get-type="dex_thread_pool_scheduler_get_type" glib:fundamental="1"> + #DexThreadPoolScheduler is a #DexScheduler that will dispatch work items +and fibers to sub-schedulers on a specific operating system thread. + +#DexFiber will never migrate from the thread they are created on to reduce +chances of safety issues involved in tracking state between CPU. + +New work items are placed into a global work queue and then dispatched +efficiently to a single thread pool worker using a specialized async +semaphore. On modern Linux using io_uring, this wakes up a single worker +thread and therefore is not subject to "thundering herd" common with +global work queues. + +When a worker creates a new work item, it is placed into a work stealing +queue owned by the thread. Other worker threads may steal work items when +they have exhausted their own work queue. Creates a new #DexScheduler that executes work items on a thread pool. + line="160">Creates a new #DexScheduler that executes work items on a thread pool. a #DexThreadPoolScheduler + line="165">a #DexThreadPoolScheduler @@ -3493,7 +3682,7 @@ rounded up to the nearest page size. c:identifier="dex_thread_pool_scheduler_get_default"> Gets the default thread pool scheduler for the instance. + line="211">Gets the default thread pool scheduler for the instance. This function is useful to allow programs and libraries to share an off-main-thread scheduler without having to coordinate on where @@ -3502,7 +3691,7 @@ the scheduler instance is created or owned. a #DexScheduler + line="220">a #DexScheduler @@ -3515,6 +3704,10 @@ the scheduler instance is created or owned. glib:type-name="DexTimeout" glib:get-type="dex_timeout_get_type" glib:fundamental="1"> + #DexTimeout is a #DexFuture that will resolve after the configured +period of time. @@ -3602,10 +3795,19 @@ the scheduler instance is created or owned. glib:type-name="DexUnixSignal" glib:get-type="dex_unix_signal_get_type" glib:fundamental="1"> + #DexUnixSignal is a #DexFuture that will resolve when a specific unix +signal has been received. + +Use this when you want to handle a signal from your main loop rather than +from a resticted operating signal handler. + +On Linux, this uses a signalfd. Creates a new #DexUnixSignal that completes when @signum is delivered + line="110">Creates a new #DexUnixSignal that completes when @signum is delivered to the process. @signum must be one of SIGHUP, SIGINT, SIGTERM, SIGUSR1, SIGUSR2, or @@ -3616,20 +3818,20 @@ This API is only supported on UNIX-like systems. a new #DexFuture + line="122">a new #DexFuture a unix signal number + line="112">a unix signal number - + @@ -3677,7 +3879,7 @@ This API is only supported on UNIX-like systems. An asynchronous `pwrite()` wrapper. - + Wrapper for g_bus_get(). - + Wrapper for g_dbus_connection_call(). - + Wrapper for g_dbus_connection_call_with_unix_fd_list(). - + Wrapper for g_dbus_connection_send_message_with_reply(). - + filename="src/dex-gio.c" line="734">Asynchronously copies a file and returns a #DexFuture which can be observed for the result. - + - + - + - + + + Queries to see if @file exists asynchronously. + + + a #DexFuture that will resolve with %TRUE + if the file exists, otherwise reject with error. + + + + + a #GFile + + + + - + Asynchronously opens a file for reading. - + - + - + - + - + - + - + - + - + - + - + - + - + - + filename="src/dex-gio.c" line="1283">Creates a future that awaits for @subprocess to complete using g_subprocess_wait_check_async(). - + Start time for query. - + End time for query. - + Start time for query. - + End time for query. - + Start time for query - + End time for query - + Start time for query - + End time for query - + Start time for query - + End time for query - + Start time for query - + End time for query - + Start time for query - + End time for query - + instance time, i.e. "5 minutes before the appointment" - + actual event occurrence start to which this instance corresponds - + actual event occurrence end to which this instance corresponds - + @@ -9250,7 +9250,7 @@ is %NULL. actual event occurrence end to which this @instance corresponds - + @@ -9271,7 +9271,7 @@ is %NULL. actual event occurrence start to which this @instance corresponds - + @@ -9313,7 +9313,7 @@ is %NULL. alarm instance time, i.e. "5 minutes before the appointment" - + @@ -9400,7 +9400,7 @@ It can be %NULL to unset it. event occurence end to set - + @@ -9427,7 +9427,7 @@ It can be %NULL to unset it. event occurence start to set - + @@ -9484,7 +9484,7 @@ It can be %NULL to unset it. instance time to set - + @@ -17507,7 +17507,7 @@ API for accessing time zone data. A time value. - + @@ -17840,7 +17840,7 @@ are DATE values or do not have a TZID (i.e. floating times). - + @@ -17894,14 +17894,14 @@ this hour, which may not be what you want. a time_t value containing @time plus the days added. - + A time_t value. - + a time_t value containing @time plus the days added. - + A time_t value. - + a time_t value containing @time plus the months added. - + A time_t value. - + a time_t value containing @time plus the weeks added. - + A time_t value. - + a time_t value containing @time plus the weeks added. - + A time_t value. - + the time corresponding to the beginning of the day. - + A time_t value. - + @@ -18093,14 +18093,14 @@ i_cal_time_adjust() to add or subtract days, hours, minutes & seconds. the beginning of the day. - + A time_t value. - + the time corresponding to the end of the day. - + A time_t value. - + @@ -18146,14 +18146,14 @@ i_cal_time_adjust() to add or subtract days, hours, minutes & seconds. the end of the day. - + A time_t value. - + filename="src/calendar/libecal/e-cal-time-util.c" line="657">Time_t corresponding to the specified ISO string. Note that we only allow UTC times at present. - + @@ -18342,14 +18342,14 @@ i_cal_time_adjust() to add or subtract days, hours, minutes & seconds. the beginning of the month. - + A time_t value. - + A time value. - + the beginning of the week. - + A time_t value. - + the beginning of the year. - + A time_t value. - + version="3.40"> Modifies the @vtimezone to include only subcomponents influencing + line="3358">Modifies the @vtimezone to include only subcomponents influencing the passed-in time interval between @from and @to. @@ -18511,13 +18511,13 @@ the passed-in time interval between @from and @to. transfer-ownership="full"> a VTIMEZONE component to modify + line="3360">a VTIMEZONE component to modify an #ICalTime for the minimum time + line="3361">an #ICalTime for the minimum time allow-none="1"> until which time to clamp, or %NULL for infinity + line="3362">until which time to clamp, or %NULL for infinity @@ -18536,7 +18536,7 @@ the passed-in time interval between @from and @to. version="3.40"> Similar to e_cal_util_clamp_vtimezone(), only reads the clamp + line="3391">Similar to e_cal_util_clamp_vtimezone(), only reads the clamp times from the @component. @@ -18550,13 +18550,13 @@ times from the @component. transfer-ownership="full"> a VTIMEZONE component to modify + line="3393">a VTIMEZONE component to modify an #ICalComponent to read the times from + line="3394">an #ICalComponent to read the times from @@ -18566,7 +18566,7 @@ times from the @component. version="3.34"> Searches for an X property named @x_name within X properties + line="2530">Searches for an X property named @x_name within X properties of @icalcomp and returns its value as a newly allocated string. Free it with g_free(), when no longer needed. Newly allocated value of the first @x_name + line="2539">Newly allocated value of the first @x_name X property in @icalcomp, or %NULL, if not found. @@ -18582,13 +18582,13 @@ Free it with g_free(), when no longer needed. an #ICalComponent + line="2532">an #ICalComponent name of the X property + line="2533">name of the X property @@ -18598,7 +18598,7 @@ Free it with g_free(), when no longer needed. version="3.46"> Searches properties of kind @prop_kind in the @icalcomp and returns + line="3602">Searches properties of kind @prop_kind in the @icalcomp and returns one, which is usable for the @locale. When @locale is %NULL, the current locale is assumed. If no such property for the locale exists either the one with no language parameter or the first @@ -18611,7 +18611,7 @@ when no longer needed. a property of kind @prop_kind for the @locale, + line="3617">a property of kind @prop_kind for the @locale, %NULL if no such property is set on the @comp. @@ -18619,13 +18619,13 @@ when no longer needed. an #ICalComponent + line="3604">an #ICalComponent an #ICalPropertyKind to traverse + line="3605">an #ICalPropertyKind to traverse allow-none="1"> a locale identifier, or %NULL + line="3606">a locale identifier, or %NULL @@ -18644,7 +18644,7 @@ when no longer needed. version="3.52"> Searches properties of kind @prop_kind in the @icalcomp, which can + line="3486">Searches properties of kind @prop_kind in the @icalcomp, which can be filtered by the @func, and returns one, which is usable for the @locale. When @locale is %NULL, the current locale is assumed. If no such property for the locale exists either the one with no language parameter or the first @@ -18660,7 +18660,7 @@ when no longer needed. a property of kind @prop_kind for the @locale, + line="3506">a property of kind @prop_kind for the @locale, %NULL if no such property is set on the @comp. @@ -18668,13 +18668,13 @@ when no longer needed. an #ICalComponent + line="3488">an #ICalComponent an #ICalPropertyKind to traverse + line="3489">an #ICalPropertyKind to traverse allow-none="1"> a locale identifier, or %NULL + line="3490">a locale identifier, or %NULL closure="4"> an #ECalUtilFilterPropertyFunc, to determine whether a property can be considered + line="3491">an #ECalUtilFilterPropertyFunc, to determine whether a property can be considered @@ -18704,7 +18704,7 @@ when no longer needed. allow-none="1"> user data for the @func + line="3492">user data for the @func @@ -18714,7 +18714,7 @@ when no longer needed. version="3.34"> Searches for an X property named @x_name within X properties + line="2495">Searches for an X property named @x_name within X properties of @icalcomp and returns it. Free the non-NULL object with g_object_unref(), when no longer needed. the first X ICalProperty named + line="2504">the first X ICalProperty named @x_name, or %NULL, when none found. @@ -18730,13 +18730,13 @@ with g_object_unref(), when no longer needed. an #ICalComponent + line="2497">an #ICalComponent name of the X property + line="2498">name of the X property @@ -18930,27 +18930,27 @@ for a specific X property use e_cal_util_component_has_x_property(). version="3.34"> Returns, whether the @icalcomp contains X property named @x_name. To check + line="2463">Returns, whether the @icalcomp contains X property named @x_name. To check for standard property use e_cal_util_component_has_property(). whether the @icalcomp contains X property named @x_name + line="2471">whether the @icalcomp contains X property named @x_name an #ICalComponent + line="2465">an #ICalComponent name of the X property + line="2466">name of the X property @@ -18982,32 +18982,32 @@ for standard property use e_cal_util_component_has_property(). version="3.30"> Removes all or only the first property of kind @kind in @icalcomp. + line="2635">Removes all or only the first property of kind @kind in @icalcomp. How many properties had been removed. + line="2643">How many properties had been removed. an #ICalComponent + line="2637">an #ICalComponent the kind of the property to remove + line="2638">the kind of the property to remove %TRUE to remove all, or %FALSE to remove only the first property of the @kind + line="2639">%TRUE to remove all, or %FALSE to remove only the first property of the @kind @@ -19017,26 +19017,26 @@ for standard property use e_cal_util_component_has_property(). version="3.34"> Removes the first X property named @x_name in @icalcomp. + line="2605">Removes the first X property named @x_name in @icalcomp. %TRUE, when any such had been found and removed, %FALSE otherwise. + line="2612">%TRUE, when any such had been found and removed, %FALSE otherwise. an #ICalComponent + line="2607">an #ICalComponent name of the X property + line="2608">name of the X property @@ -19046,7 +19046,7 @@ for standard property use e_cal_util_component_has_property(). version="3.34"> Sets a value of the first X property named @x_name in @icalcomp, + line="2566">Sets a value of the first X property named @x_name in @icalcomp, if any such already exists, or adds a new property with this name and value. As a special case, if @value is %NULL, then removes the first X property named @x_name from @icalcomp instead. @@ -19059,13 +19059,13 @@ the first X property named @x_name from @icalcomp instead. an #ICalComponent + line="2568">an #ICalComponent name of the X property + line="2569">name of the X property allow-none="1"> a value to set, or %NULL + line="2570">a value to set, or %NULL @@ -19084,21 +19084,21 @@ the first X property named @x_name from @icalcomp instead. version="3.34"> Encodes the #EConflictResolution into the bit-or of #ECalOperationFlags. + line="3103">Encodes the #EConflictResolution into the bit-or of #ECalOperationFlags. The returned value can be bit-or-ed with other #ECalOperationFlags values. a bit-or of #ECalOperationFlags, corresponding to the @conflict_resolution + line="3110">a bit-or of #ECalOperationFlags, corresponding to the @conflict_resolution an #EConflictResolution + line="3105">an #EConflictResolution @@ -19166,7 +19166,7 @@ g_object_unref(), when no longer needed. version="3.48"> Compares list of categories on the @old_comp with the list of categories + line="3738">Compares list of categories on the @old_comp with the list of categories on the @new_comp and fills @out_added categories and @out_removed categories accordingly, as if the @old_comp is replaced with the @new_comp. When either of the components is %NULL, it's considered as having no categories set. @@ -19190,7 +19190,7 @@ when no longer needed. allow-none="1"> an old #ICalComponent, or %NULL + line="3740">an old #ICalComponent, or %NULL allow-none="1"> a new #ICalComponent, or %NULL + line="3741">a new #ICalComponent, or %NULL transfer-ownership="container"> a #GHashTable with added categories + line="3742">a #GHashTable with added categories @@ -19220,7 +19220,7 @@ when no longer needed. transfer-ownership="container"> a #GHashTable with removed categories + line="3743">a #GHashTable with removed categories @@ -19233,7 +19233,7 @@ when no longer needed. version="3.50"> Compares two email addresses and returns whether they are equal. + line="3814">Compares two email addresses and returns whether they are equal. Each address can contain a "mailto:" prefix. The two addresses match only if they are non-NULL and non-empty. The address itself is compared case insensitively. @@ -19242,7 +19242,7 @@ is compared case insensitively. %TRUE, when the @email1 equals to @email2 + line="3824">%TRUE, when the @email1 equals to @email2 @@ -19252,7 +19252,7 @@ is compared case insensitively. allow-none="1"> the first email + line="3816">the first email allow-none="1"> the second email + line="3817">the second email @@ -19271,7 +19271,7 @@ is compared case insensitively. version="3.48"> Calls @func for each category stored in the @comp. + line="3632">Calls @func for each category stored in the @comp. @@ -19281,7 +19281,7 @@ is compared case insensitively. an #ICalComponent + line="3634">an #ICalComponent closure="2"> an #ECalUtilForeachCategoryFunc callback to call for each category + line="3635">an #ECalUtilForeachCategoryFunc callback to call for each category @@ -19300,7 +19300,7 @@ is compared case insensitively. allow-none="1"> user data passed to the @func + line="3636">user data passed to the @func @@ -19335,13 +19335,13 @@ See e_cal_util_generate_alarms_for_uid_sync() Start time - + End time - + Start time - + End time - + start time - + end time - + version="3.50"> Returns an attendee email, without the "mailto:" prefix, if + line="3966">Returns an attendee email, without the "mailto:" prefix, if the @attendee has it set. The email can be read from an "EMAIL" parameter, if present. email of the @attendee, or %NULL + line="3974">email of the @attendee, or %NULL @@ -19592,7 +19592,7 @@ parameter, if present. allow-none="1"> an ECalComponentAttendee + line="3968">an ECalComponentAttendee @@ -19603,7 +19603,7 @@ parameter, if present. version="2.32"> Find out when the component starts and stops, being careful about + line="2282">Find out when the component starts and stops, being careful about recurrences. @@ -19614,7 +19614,7 @@ recurrences. an #ECalComponent + line="2284">an #ECalComponent transfer-ownership="full"> Location to store the start time - + line="2285">Location to store the start time + transfer-ownership="full"> Location to store the end time - + line="2286">Location to store the end time + closure="4"> The #ECalRecurResolveTimezoneCb to call + line="2287">The #ECalRecurResolveTimezoneCb to call @@ -19651,19 +19651,19 @@ recurrences. allow-none="1"> User data to be passed to the @tz_cb callback + line="2288">User data to be passed to the @tz_cb callback The default timezone + line="2289">The default timezone the type of component, indicated with an #ICalComponentKind + line="2290">the type of component, indicated with an #ICalComponentKind @@ -19673,7 +19673,7 @@ recurrences. version="3.50"> Returns the real name and email address of the default mail identity, + line="3844">Returns the real name and email address of the default mail identity, if available. If no default mail identity is available, @out_name and @out_address are set to %NULL and the function returns %FALSE. %TRUE if @out_name and/or @out_address were set + line="3854">%TRUE if @out_name and/or @out_address were set an #ESourceRegistry + line="3846">an #ESourceRegistry return location for the user's real name, or %NULL + line="3847">return location for the user's real name, or %NULL return location for the user's email address, or %NULL + line="3848">return location for the user's email address, or %NULL @@ -19720,7 +19720,7 @@ if available. If no default mail identity is available, @out_name and version="3.50"> Returns an organizer email, without the "mailto:" prefix, if + line="3943">Returns an organizer email, without the "mailto:" prefix, if the @organizer has it set. The email can be read from an "EMAIL" parameter, if present. email of the @organizer, or %NULL + line="3951">email of the @organizer, or %NULL @@ -19738,7 +19738,7 @@ parameter, if present. allow-none="1"> an #ECalComponentOrganizer + line="3945">an #ECalComponentOrganizer @@ -19749,7 +19749,7 @@ parameter, if present. version="3.50"> Returns an @prop email, without the "mailto:" prefix, if + line="3989">Returns an @prop email, without the "mailto:" prefix, if the @prop has it set. The email can be read from an "EMAIL" parameter, if present. Otherwise the @prop can be only of type %I_CAL_ORGANIZER_PROPERTY or %I_CAL_ATTENDEE_PROPERTY. @@ -19760,14 +19760,14 @@ See also: e_cal_util_get_organizer_email(), e_cal_util_get_attendee_email() email of the @prop, or %NULL + line="4000">email of the @prop, or %NULL an #ICalProperty + line="3991">an #ICalProperty @@ -19777,7 +19777,7 @@ See also: e_cal_util_get_organizer_email(), e_cal_util_get_attendee_email() Fetches system timezone ICalTimezone object. + line="2227">Fetches system timezone ICalTimezone object. The returned pointer is part of the built-in timezones and should not be freed. The ICalTimezone object of the system timezone, or %NULL on an error. + line="2234">The ICalTimezone object of the system timezone, or %NULL on an error. @@ -19794,13 +19794,13 @@ The returned pointer is part of the built-in timezones and should not be freed.< version="2.28"> Fetches system timezone localtion string. + line="2211">Fetches system timezone localtion string. system timezone location string, %NULL + line="2216">system timezone location string, %NULL on an error. @@ -19830,13 +19830,13 @@ on an error. start time - + end time - + throws="1"> Initializes properties of a recurring @vtodo, like normalizing + line="2808">Initializes properties of a recurring @vtodo, like normalizing the Due date and eventually the Start date. The function does nothing when the @vtodo is not recurring. @@ -19954,20 +19954,20 @@ to the @cal_client, it only updates the @vtodo component. Whether succeeded. + line="2826">Whether succeeded. a VTODO component + line="2810">a VTODO component an #ECalClient to which the @vtodo belongs + line="2811">an #ECalClient to which the @vtodo belongs allow-none="1"> optional #GCancellable object, or %NULL + line="2812">optional #GCancellable object, or %NULL @@ -19987,7 +19987,7 @@ to the @cal_client, it only updates the @vtodo component. throws="1"> Changes all URL attachments which point to a local file in @component + line="3153">Changes all URL attachments which point to a local file in @component to inline attachments, aka adds the file content into the @component. It also populates FILENAME parameter on the attachment. Whether succeeded. + line="3163">Whether succeeded. an #ICalComponent to work with + line="3155">an #ICalComponent to work with allow-none="1"> optional #GCancellable object, or %NULL + line="3156">optional #GCancellable object, or %NULL @@ -20021,27 +20021,27 @@ It also populates FILENAME parameter on the attachment. version="3.16"> Returns whether the given @rid is the first instance of + line="2161">Returns whether the given @rid is the first instance of the recurrence defined in the @comp. Whether the @rid identifies the first instance of @comp. + line="2171">Whether the @rid identifies the first instance of @comp. an #ECalComponent instance + line="2163">an #ECalComponent instance a recurrence ID + line="2164">a recurrence ID closure="3"> The #ECalRecurResolveTimezoneCb to call + line="2165">The #ECalRecurResolveTimezoneCb to call @@ -20060,7 +20060,7 @@ the recurrence defined in the @comp. allow-none="1"> User data to be passed to the @tz_cb callback + line="2166">User data to be passed to the @tz_cb callback @@ -20071,7 +20071,7 @@ the recurrence defined in the @comp. throws="1"> Marks the @vtodo as complete with eventual update of other + line="2872">Marks the @vtodo as complete with eventual update of other properties. This is useful also for recurring tasks, for which it moves the @vtodo into the next occurrence according to the recurrence rule. @@ -20091,26 +20091,26 @@ to the @cal_client, it only updates the @vtodo component. Whether succeeded. + line="2896">Whether succeeded. a VTODO component + line="2874">a VTODO component completed time to set, or (time_t) -1 to use current time - + line="2875">completed time to set, or (time_t) -1 to use current time + an #ECalClient to which the @vtodo belongs + line="2876">an #ECalClient to which the @vtodo belongs allow-none="1"> optional #GCancellable object, or %NULL + line="2877">optional #GCancellable object, or %NULL @@ -20214,13 +20214,13 @@ Uses @tz_cb with @tz_cb_data to resolve time zones when needed. version="3.34"> Decodes the #EConflictResolution from the bit-or of #ECalOperationFlags. + line="3077">Decodes the #EConflictResolution from the bit-or of #ECalOperationFlags. an #EConflictResolution as stored in the @flags + line="3083">an #EConflictResolution as stored in the @flags @@ -20228,7 +20228,7 @@ Uses @tz_cb with @tz_cb_data to resolve time zones when needed. bit-or of #ECalOperationFlags + line="3079">bit-or of #ECalOperationFlags @@ -20482,33 +20482,33 @@ Free the returned string with g_free(), when no longer needed. version="3.40"> Sets the ACKNOWLEDGED property on the @component's alarm with UID @auid + line="3253">Sets the ACKNOWLEDGED property on the @component's alarm with UID @auid to the time @when (in UTC), or to the current time, when the @when is 0. Whether succeeded. + line="3262">Whether succeeded. an #ECalComponent + line="3255">an #ECalComponent an alarm UID to modify + line="3256">an alarm UID to modify a time, in UTC, when to set the acknowledged property, or 0 for the current time + line="3257">a time, in UTC, when to set the acknowledged property, or 0 for the current time @@ -20637,14 +20637,14 @@ done with it. version="3.50"> Strips "mailto:" prefix from the @address, if present. The returned + line="3791">Strips "mailto:" prefix from the @address, if present. The returned pointer is either the @address or a shifted position within the @address. the @address without the "mailto:" prefix + line="3798">the @address without the "mailto:" prefix @@ -20654,7 +20654,7 @@ pointer is either the @address or a shifted position within the @address. allow-none="1"> an address with or without "mailto:" prefix + line="3793">an address with or without "mailto:" prefix diff --git a/girs/EDataCal-2.0.gir b/girs/EDataCal-2.0.gir index c9f426fd6..d67fafe0d 100644 --- a/girs/EDataCal-2.0.gir +++ b/girs/EDataCal-2.0.gir @@ -17,7 +17,7 @@ and/or use gtk-doc annotations. --> + A signal notifying that the backend was closed @@ -325,6 +328,9 @@ functions below. + FIXME: Document me @@ -352,6 +358,9 @@ functions below. + FIXME: Document me @@ -384,6 +393,9 @@ functions below. + FIXME: Document me @@ -420,6 +432,9 @@ functions below. + FIXME: Document me @@ -450,6 +465,9 @@ functions below. + Fetch a property value by name from the backend @@ -465,6 +483,9 @@ functions below. + FIXME: Document me @@ -492,14 +513,17 @@ functions below. - + - + + Fetch a calendar object @@ -530,6 +554,9 @@ functions below. + FIXME: Document me @@ -557,6 +584,9 @@ functions below. + FIXME: Document me @@ -584,6 +614,9 @@ functions below. + FIXME: Document me @@ -619,6 +652,9 @@ functions below. + Open the backend @@ -643,6 +679,9 @@ functions below. + FIXME: Document me @@ -673,6 +712,9 @@ functions below. + Refresh the backend @@ -697,6 +739,9 @@ functions below. + FIXME: Document me @@ -732,6 +777,9 @@ functions below. + FIXME: Document me @@ -762,6 +810,9 @@ functions below. + Start up the specified view @@ -777,6 +828,9 @@ functions below. + Stop the specified view @@ -792,6 +846,9 @@ functions below. + A signal notifying that the backend is being shut down @@ -805,10 +862,12 @@ functions below. + version="3.10" + glib:finish-func="add_timezone_finish" + glib:sync-func="add_timezone_sync"> Asynchronously adds the timezone described by @tzobject to @backend. + line="4285">Asynchronously adds the timezone described by @tzobject to @backend. When the operation is finished, @callback will be called. You can then call e_cal_backend_add_timezone_finish() to get the result of @@ -822,13 +881,13 @@ the operation. an #ECalBackend + line="4287">an #ECalBackend an iCalendar VTIMEZONE string + line="4288">an iCalendar VTIMEZONE string allow-none="1"> optional #GCancellable object, or %NULL + line="4289">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="4290">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="4291">data to pass to the callback function @@ -868,7 +927,7 @@ the operation. throws="1"> Finishes the operation started with e_cal_backend_add_timezone(). + line="4323">Finishes the operation started with e_cal_backend_add_timezone(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="4333">%TRUE on success, %FALSE on failure an #ECalBackend + line="4325">an #ECalBackend a #GAsyncResult + line="4326">a #GAsyncResult @@ -897,10 +956,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="add_timezone"> Adds the timezone described by @tzobject to @backend. + line="4201">Adds the timezone described by @tzobject to @backend. If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="4212">%TRUE on success, %FALSE on failure an #ECalBackend + line="4203">an #ECalBackend an iCalendar VTIMEZONE string + line="4204">an iCalendar VTIMEZONE string allow-none="1"> optional #GCancellable object, or %NULL + line="4205">optional #GCancellable object, or %NULL @@ -940,7 +1000,7 @@ If an error occurs, the function will set @error and return %FALSE. version="3.2"> Adds a view to the list of live views being run by the given backend. + line="1616">Adds a view to the list of live views being run by the given backend. Doing so means that any listener on the view will get notified of any change that affect the live view. an #ECalBackend + line="1618">an #ECalBackend An #EDataCalView object. + line="1619">An #EDataCalView object. @@ -971,7 +1031,7 @@ change that affect the live view. a filename for an attachment in a local cache dir. Free returned + line="1567">a filename for an attachment in a local cache dir. Free returned pointer with a g_free(). @@ -979,13 +1039,13 @@ pointer with a g_free(). an #ECalBackend + line="1562">an #ECalBackend a component UID + line="1563">a component UID allow-none="1"> a filename to use; can be %NULL + line="1564">a filename to use; can be %NULL index of a file; used only when @filename is %NULL + line="1565">index of a file; used only when @filename is %NULL + version="3.10" + glib:finish-func="create_objects_finish" + glib:sync-func="create_objects_sync"> Asynchronously creates one or more new iCalendar objects from @calobjs. + line="2780">Asynchronously creates one or more new iCalendar objects from @calobjs. When the operation is finished, @callback will be called. You can then call e_cal_backend_create_objects_finish() to get the result of the @@ -1024,19 +1086,19 @@ operation. an #ECalBackend + line="2782">an #ECalBackend a %NULL-terminated array of iCalendar strings + line="2783">a %NULL-terminated array of iCalendar strings bit-or of #ECalOperationFlags + line="2784">bit-or of #ECalOperationFlags allow-none="1"> optional #GCancellable object, or %NULL + line="2785">optional #GCancellable object, or %NULL closure="4"> a #GAsyncReadyCallback to call when the request is satisifed + line="2786">a #GAsyncReadyCallback to call when the request is satisifed allow-none="1"> data to pass to the callback function + line="2787">data to pass to the callback function @@ -1076,7 +1138,7 @@ operation. throws="1"> Finishes the operation started with e_cal_backend_create_objects(). + line="2830">Finishes the operation started with e_cal_backend_create_objects(). A unique ID string for each newly-created object is deposited in @out_uids. Free the returned ID strings with g_free() when finished with them. @@ -1087,26 +1149,26 @@ If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="2844">%TRUE on success, %FALSE on failure an #ECalBackend + line="2832">an #ECalBackend a #GAsyncResult + line="2833">a #GAsyncResult a #GQueue in which to deposit results + line="2834">a #GQueue in which to deposit results @@ -1114,10 +1176,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="create_objects"> Creates one or more new iCalendar objects from @calobjs, and deposits + line="2681">Creates one or more new iCalendar objects from @calobjs, and deposits the unique ID string for each newly-created object in @out_uids. Free the returned ID strings with g_free() when finished with them. @@ -1128,32 +1191,32 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="2697">%TRUE on success, %FALSE on failure an #ECalBackend + line="2683">an #ECalBackend a %NULL-terminated array of iCalendar strings + line="2684">a %NULL-terminated array of iCalendar strings bit-or of #ECalOperationFlags + line="2685">bit-or of #ECalOperationFlags a #GQueue in which to deposit results + line="2686">a #GQueue in which to deposit results allow-none="1"> optional #GCancellable object, or %NULL + line="2687">optional #GCancellable object, or %NULL + version="3.10" + glib:finish-func="discard_alarm_finish" + glib:sync-func="discard_alarm_sync"> Asynchronously discards the VALARM object with a unique ID of @alarm_uid + line="3959">Asynchronously discards the VALARM object with a unique ID of @alarm_uid from the iCalendar object identified by @uid and, optionally, @rid. When the operation is finished, @callback will be called. You can @@ -1187,13 +1252,13 @@ the operation. an #ECalBackend + line="3961">an #ECalBackend a unique ID for an iCalendar object + line="3962">a unique ID for an iCalendar object allow-none="1"> a recurrence ID, or %NULL + line="3963">a recurrence ID, or %NULL a unique ID for an iCalendar VALARM object + line="3964">a unique ID for an iCalendar VALARM object bit-or of #ECalOperationFlags + line="3965">bit-or of #ECalOperationFlags allow-none="1"> optional #GCancellable object, or %NULL + line="3966">optional #GCancellable object, or %NULL closure="6"> a #GAsyncReadyCallback to call when the request is satisfied + line="3967">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="3968">data to pass to the callback function @@ -1254,7 +1319,7 @@ the operation. throws="1"> Finishes the operation started with e_cal_backend_discard_alarm(). + line="4013">Finishes the operation started with e_cal_backend_discard_alarm(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="4023">%TRUE on success, %FALSE on failure an #ECalBackend + line="4015">an #ECalBackend a #GAsyncResult + line="4016">a #GAsyncResult @@ -1283,10 +1348,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="discard_alarm"> Discards the VALARM object with a unique ID of @alarm_uid from the + line="3857">Discards the VALARM object with a unique ID of @alarm_uid from the iCalendar object identified by @uid and, optionally, @rid. If an error occurs, the function will set @error and return %FALSE. @@ -1295,20 +1361,20 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="3872">%TRUE on success, %FALSE on failure an #ECalBackend + line="3859">an #ECalBackend a unique ID for an iCalendar object + line="3860">a unique ID for an iCalendar object allow-none="1"> a recurrence ID, or %NULL + line="3861">a recurrence ID, or %NULL a unique ID for an iCalendar VALARM object + line="3862">a unique ID for an iCalendar VALARM object bit-or of #ECalOperationFlags + line="3863">bit-or of #ECalOperationFlags allow-none="1"> optional #GCancellable object, or %NULL + line="3864">optional #GCancellable object, or %NULL @@ -1348,7 +1414,7 @@ If an error occurs, the function will set @error and return %FALSE. version="3.10"> Thread-safe variation of e_cal_backend_get_cache_dir(). + line="1494">Thread-safe variation of e_cal_backend_get_cache_dir(). Use this function when accessing @backend from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -1357,14 +1423,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ECalBackend:cache-dir + line="1503">a newly-allocated copy of #ECalBackend:cache-dir an #ECalBackend + line="1496">an #ECalBackend @@ -1374,21 +1440,21 @@ The returned string should be freed with g_free() when no longer needed. version="3.34"> Calls @func for each existing view (as returned by e_cal_backend_list_views()). + line="1732">Calls @func for each existing view (as returned by e_cal_backend_list_views()). The @func can return %FALSE to stop early. whether the call had been stopped by @func + line="1741">whether the call had been stopped by @func an #ECalBackend + line="1734">an #ECalBackend closure="1"> an #ECalBackendForeachViewFunc function to call + line="1735">an #ECalBackendForeachViewFunc function to call @@ -1410,7 +1476,7 @@ The @func can return %FALSE to stop early. closure="0"> user data to pass to @func + line="1736">user data to pass to @func @@ -1420,7 +1486,7 @@ The @func can return %FALSE to stop early. version="3.34"> Notifies each view of the @backend about progress. When @only_completed_views + line="1789">Notifies each view of the @backend about progress. When @only_completed_views is %TRUE, notifies only completed views. @@ -1431,19 +1497,19 @@ is %TRUE, notifies only completed views. an #ECalBackend + line="1791">an #ECalBackend whether notify in completed views only + line="1792">whether notify in completed views only percent complete + line="1793">percent complete allow-none="1"> message describing the operation in progress, or %NULL + line="1794">message describing the operation in progress, or %NULL + version="3.10" + glib:finish-func="get_attachment_uris_finish" + glib:sync-func="get_attachment_uris_sync"> Asynchronously inspects the iCalendar object specified by @uid and, + line="3764">Asynchronously inspects the iCalendar object specified by @uid and, optionally, @rid for attachments. When the operation is finished, @callback will be called. You can then @@ -1477,13 +1545,13 @@ operation. an #ECalBackend + line="3766">an #ECalBackend a unique ID for an iCalendar object + line="3767">a unique ID for an iCalendar object allow-none="1"> a recurrence ID, or %NULL + line="3768">a recurrence ID, or %NULL allow-none="1"> optional #GCancellable object, or %NULL + line="3769">optional #GCancellable object, or %NULL closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="3770">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="3771">data to pass to the callback function @@ -1532,7 +1600,7 @@ operation. throws="1"> Finishes the operation started with e_cal_backend_get_attachment_uris(). + line="3811">Finishes the operation started with e_cal_backend_get_attachment_uris(). The requested attachment URI strings are deposited in @out_attachment_uris. Free the returned strings with g_free() when finished with them. @@ -1544,26 +1612,26 @@ Note that an empty result set does not necessarily imply an error. %TRUE on success, %FALSE on failure + line="3826">%TRUE on success, %FALSE on failure an #ECalBackend + line="3813">an #ECalBackend a #GAsyncResult + line="3814">a #GAsyncResult a #GQueue in which to deposit results + line="3815">a #GQueue in which to deposit results @@ -1571,10 +1639,11 @@ Note that an empty result set does not necessarily imply an error. + throws="1" + glib:async-func="get_attachment_uris"> Inspects the iCalendar object specified by @uid and, optionally, @rid + line="3668">Inspects the iCalendar object specified by @uid and, optionally, @rid for attachments and deposits a URI string for each attachment in @out_attachment_uris. Free the returned strings with g_free() when finished with them. @@ -1586,20 +1655,20 @@ Note that an empty result set does not necessarily imply an error. %TRUE on success, %FALSE on failure + line="3685">%TRUE on success, %FALSE on failure an #ECalBackend + line="3670">an #ECalBackend a unique ID for an iCalendar object + line="3671">a unique ID for an iCalendar object allow-none="1"> a recurrence ID, or %NULL + line="3672">a recurrence ID, or %NULL a #GQueue in which to deposit results + line="3673">a #GQueue in which to deposit results allow-none="1"> optional #GCancellable object, or %NULL + line="3674">optional #GCancellable object, or %NULL @@ -1633,27 +1702,27 @@ Note that an empty result set does not necessarily imply an error. version="3.10"> Obtains the value of the backend property named @prop_name. + line="1588">Obtains the value of the backend property named @prop_name. Freed the returned string with g_free() when finished with it. the value for @prop_name + line="1596">the value for @prop_name an #ECalBackend + line="1590">an #ECalBackend a backend property name + line="1591">a backend property name @@ -1664,30 +1733,32 @@ Freed the returned string with g_free() when finished with it. version="2.32"> Returns the cache directory path used by @backend. + line="1476">Returns the cache directory path used by @backend. the cache directory path + line="1482">the cache directory path an #ECalBackend + line="1478">an #ECalBackend + version="3.10" + glib:finish-func="get_free_busy_finish" + glib:sync-func="get_free_busy_sync"> Asynchronously obtains a free/busy object for the list of @users in the + line="2573">Asynchronously obtains a free/busy object for the list of @users in the time interval between @start and @end. When the operation is finished, @callback will be called. You can @@ -1702,25 +1773,25 @@ the operation. an #ECalBackend + line="2575">an #ECalBackend start time - + line="2576">start time + end time - + line="2577">end time + a %NULL-terminated array of user strings + line="2578">a %NULL-terminated array of user strings @@ -1731,7 +1802,7 @@ the operation. allow-none="1"> optional #GCancellable object, or %NULL + line="2579">optional #GCancellable object, or %NULL closure="5"> a #GAsyncReadyCallback to call when the request is satisfied + line="2580">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="2581">data to pass to the callback function @@ -1762,7 +1833,7 @@ the operation. throws="1"> Finishes the operation started with e_cal_backend_get_free_busy(). + line="2629">Finishes the operation started with e_cal_backend_get_free_busy(). The free/busy results can be returned through the e_data_cal_report_free_busy_data() function asynchronously. The out_freebusy @@ -1775,26 +1846,26 @@ If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="2645">%TRUE on success, %FALSE on failure an #ECalBackend + line="2631">an #ECalBackend a #GAsyncResult + line="2632">a #GAsyncResult iCalendar strings with overall returned Free/Busy data + line="2633">iCalendar strings with overall returned Free/Busy data @@ -1804,10 +1875,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="get_free_busy"> Obtains a free/busy object for the list of @users in the time interval + line="2474">Obtains a free/busy object for the list of @users in the time interval between @start and @end. The free/busy results can be returned through the @@ -1821,32 +1893,32 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure. + line="2494">%TRUE on success, %FALSE on failure. an #ECalBackend + line="2476">an #ECalBackend start time - + line="2477">start time + end time - + line="2478">end time + a %NULL-terminated array of user strings + line="2479">a %NULL-terminated array of user strings @@ -1854,7 +1926,7 @@ If an error occurs, the function will set @error and return %FALSE. iCalendar strings with overall returned Free/Busy data + line="2480">iCalendar strings with overall returned Free/Busy data @@ -1865,7 +1937,7 @@ If an error occurs, the function will set @error and return %FALSE. allow-none="1"> optional #GCancellable object, or %NULL + line="2481">optional #GCancellable object, or %NULL @@ -1875,30 +1947,32 @@ If an error occurs, the function will set @error and return %FALSE. glib:get-property="kind"> Gets the kind of components the given backend stores. + line="1275">Gets the kind of components the given backend stores. The kind of components for this backend. + line="1281">The kind of components for this backend. an #ECalBackend + line="1277">an #ECalBackend + version="3.10" + glib:finish-func="get_object_finish" + glib:sync-func="get_object_sync"> Asynchronously obtains an #ECalComponent by its @uid and, optionally, @rid. + line="2218">Asynchronously obtains an #ECalComponent by its @uid and, optionally, @rid. When the operation is finished, @callback will be called. You can then call e_cal_backend_get_object_finish() to get the result of the operation. @@ -1911,13 +1985,13 @@ call e_cal_backend_get_object_finish() to get the result of the operation. an #ECalBackend + line="2220">an #ECalBackend a unique ID for an iCalendar object + line="2221">a unique ID for an iCalendar object allow-none="1"> a recurrence ID, or %NULL + line="2222">a recurrence ID, or %NULL allow-none="1"> optional #GCancellable object, or %NULL + line="2223">optional #GCancellable object, or %NULL closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="2224">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="2225">data to pass to the callback function @@ -1966,7 +2040,7 @@ call e_cal_backend_get_object_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_cal_backend_get_object(). + line="2263">Finishes the operation started with e_cal_backend_get_object(). The returned string is an iCalendar object describing either single component or a vCalendar object, which includes also detached instances. It should be @@ -1978,30 +2052,32 @@ If an error occurs, the function will set @error and return %NULL. an #ECalComponent, or %NULL on error + line="2277">an #ECalComponent, or %NULL on error an #ECalBackend + line="2265">an #ECalBackend a #GAsyncResult + line="2266">a #GAsyncResult + version="3.10" + glib:finish-func="get_object_list_finish" + glib:sync-func="get_object_list_sync"> Asynchronously obtains a set of iCalendar instances which satisfy + line="2389">Asynchronously obtains a set of iCalendar instances which satisfy the criteria specified in @query. When the operation in finished, @callback will be called. You can then @@ -2016,13 +2092,13 @@ operation. an #ECalBackend + line="2391">an #ECalBackend a search query in S-expression format + line="2392">a search query in S-expression format allow-none="1"> optional #GCancellable object, or %NULL + line="2393">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="2394">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="2395">data to pass to the callback function @@ -2062,7 +2138,7 @@ operation. throws="1"> Finishes the operation started with e_cal_backend_get_object_list(). + line="2428">Finishes the operation started with e_cal_backend_get_object_list(). The matching iCalendar instances are deposited in @out_objects. The returned instances should be freed with g_free() when finished with them. @@ -2074,26 +2150,26 @@ Note that an empty result set does not necessarily imply an error. %TRUE on success, %FALSE on failure + line="2443">%TRUE on success, %FALSE on failure an #ECalBackend + line="2430">an #ECalBackend a #GAsyncResult + line="2431">a #GAsyncResult a #GQueue in which to deposit results + line="2432">a #GQueue in which to deposit results @@ -2101,10 +2177,11 @@ Note that an empty result set does not necessarily imply an error. + throws="1" + glib:async-func="get_object_list"> Obtains a set of iCalendar string instances which satisfy the criteria + line="2298">Obtains a set of iCalendar string instances which satisfy the criteria specified in @query, and deposits them in @out_objects. The returned instances should be freed with g_free() when finished with them. @@ -2116,26 +2193,26 @@ Note that an empty result set does not necessarily imply an error. %TRUE on success, %FALSE on failure + line="2314">%TRUE on success, %FALSE on failure an #ECalBackend + line="2300">an #ECalBackend a search query in S-expression format + line="2301">a search query in S-expression format a #GQueue in which to deposit results + line="2302">a #GQueue in which to deposit results allow-none="1"> optional #GCancellable object, or %NULL + line="2303">optional #GCancellable object, or %NULL @@ -2152,10 +2229,11 @@ Note that an empty result set does not necessarily imply an error. + throws="1" + glib:async-func="get_object"> Obtains an iCalendar string for an object identified by its @uid and, + line="2127">Obtains an iCalendar string for an object identified by its @uid and, optionally, @rid. The returned string should be freed with g_free() when finished with it. @@ -2166,20 +2244,20 @@ If an error occurs, the function will set @error and return %NULL. an #ECalComponent, or %NULL on error + line="2142">an #ECalComponent, or %NULL on error an #ECalBackend + line="2129">an #ECalBackend a unique ID for an iCalendar object + line="2130">a unique ID for an iCalendar object allow-none="1"> a recurrence ID, or %NULL + line="2131">a recurrence ID, or %NULL allow-none="1"> optional #GCancellable object, or %NULL + line="2132">optional #GCancellable object, or %NULL @@ -2208,30 +2286,32 @@ If an error occurs, the function will set @error and return %NULL. version="3.6"> Returns the data source registry to which #EBackend:source belongs. + line="1380">Returns the data source registry to which #EBackend:source belongs. an #ESourceRegistry + line="1386">an #ESourceRegistry an #ECalBackend + line="1382">an #ECalBackend + version="3.10" + glib:finish-func="get_timezone_finish" + glib:sync-func="get_timezone_sync"> Asynchronously obtains the VTIMEZONE object identified by @tzid. + line="4130">Asynchronously obtains the VTIMEZONE object identified by @tzid. When the operation is finished, @callback will be called. You can then call e_cal_backend_get_timezone_finish() to get the result of @@ -2245,13 +2325,13 @@ the operation. an #ECalBackend + line="4132">an #ECalBackend a unique ID for an iCalendar VTIMEZONE object + line="4133">a unique ID for an iCalendar VTIMEZONE object allow-none="1"> optional #GCancellable object, or %NULL + line="4134">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="4135">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="4136">data to pass to the callback function @@ -2291,7 +2371,7 @@ the operation. throws="1"> Finishes the operation started with e_cal_backend_get_timezone(). + line="4168">Finishes the operation started with e_cal_backend_get_timezone(). Free the returned string with g_free() when finished with it. @@ -2301,20 +2381,20 @@ If an error occurred, the function will set @error and return %NULL. an iCalendar string, or %NULL on error + line="4180">an iCalendar string, or %NULL on error an #ECalBackend + line="4170">an #ECalBackend a #GAsyncResult + line="4171">a #GAsyncResult @@ -2322,10 +2402,11 @@ If an error occurred, the function will set @error and return %NULL. + throws="1" + glib:async-func="get_timezone"> Obtains the VTIMEZONE object identified by @tzid. Free the returned + line="4044">Obtains the VTIMEZONE object identified by @tzid. Free the returned string with g_free() when finished with it. If an error occurs, the function will set @error and return %NULL. @@ -2334,20 +2415,20 @@ If an error occurs, the function will set @error and return %NULL. an iCalendar string, or %NULL on error + line="4056">an iCalendar string, or %NULL on error an #ECalBackend + line="4046">an #ECalBackend a unique ID for an iCalendar VTIMEZONE object + line="4047">a unique ID for an iCalendar VTIMEZONE object allow-none="1"> optional #GCancellable object, or %NULL + line="4048">optional #GCancellable object, or %NULL @@ -2367,20 +2448,20 @@ If an error occurs, the function will set @error and return %NULL. version="3.8"> Returns whether @backend will accept changes to its data content. + line="1398">Returns whether @backend will accept changes to its data content. whether @backend is writable + line="1404">whether @backend is writable an #ECalBackend + line="1400">an #ECalBackend @@ -2390,7 +2471,7 @@ If an error occurs, the function will set @error and return %NULL. version="3.2"> Checks if @backend's storage has been opened (and + line="1439">Checks if @backend's storage has been opened (and authenticated, if necessary) and the backend itself is ready for accessing. This property is changed automatically after the @backend is successfully opened. @@ -2399,14 +2480,14 @@ after the @backend is successfully opened. %TRUE if fully opened, %FALSE otherwise. + line="1448">%TRUE if fully opened, %FALSE otherwise. an #ECalBackend + line="1441">an #ECalBackend @@ -2419,14 +2500,14 @@ after the @backend is successfully opened. Whether is backend read-only. + line="1464">Whether is backend read-only. an #ECalBackend + line="1462">an #ECalBackend @@ -2436,7 +2517,7 @@ after the @backend is successfully opened. version="3.8"> Returns a list of #EDataCalView instances added with + line="1680">Returns a list of #EDataCalView instances added with e_cal_backend_add_view(). The views returned in the list are referenced for thread-safety. @@ -2453,7 +2534,7 @@ An easy way to free the list properly in one step is as follows: a list of cal views + line="1697">a list of cal views @@ -2462,17 +2543,19 @@ An easy way to free the list properly in one step is as follows: an #ECalBackend + line="1682">an #ECalBackend + version="3.10" + glib:finish-func="modify_objects_finish" + glib:sync-func="modify_objects_sync"> Asynchronously modifies one or more iCalendar objects according to + line="2981">Asynchronously modifies one or more iCalendar objects according to @calobjs and @mod. When the operation is finished, @callback will be called. You can then @@ -2487,25 +2570,25 @@ operation. an #ECalBackend + line="2983">an #ECalBackend a %NULL-terminated array of iCalendar strings + line="2984">a %NULL-terminated array of iCalendar strings modification type for recurrences + line="2985">modification type for recurrences bit-or of #ECalOperationFlags + line="2986">bit-or of #ECalOperationFlags allow-none="1"> optional #GCancellable object, or %NULL + line="2987">optional #GCancellable object, or %NULL closure="5"> a #GAsyncReadyCallback to call when the request is satisfied + line="2988">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="2989">data to pass to the callback function @@ -2545,7 +2628,7 @@ operation. throws="1"> Finishes the operation started with e_cal_backend_modify_objects(). + line="3035">Finishes the operation started with e_cal_backend_modify_objects(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="3045">%TRUE on success, %FALSE on failure an #ECalBackend + line="3037">an #ECalBackend a #GAsyncResult + line="3038">a #GAsyncResult @@ -2574,10 +2657,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="modify_objects"> Modifies one or more iCalendar objects according to @calobjs and @mod. + line="2883">Modifies one or more iCalendar objects according to @calobjs and @mod. If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="2896">%TRUE on success, %FALSE on failure an #ECalBackend + line="2885">an #ECalBackend a %NULL-terminated array of iCalendar strings + line="2886">a %NULL-terminated array of iCalendar strings modification type for recurrences + line="2887">modification type for recurrences bit-or of #ECalOperationFlags + line="2888">bit-or of #ECalOperationFlags allow-none="1"> optional #GCancellable object, or %NULL + line="2889">optional #GCancellable object, or %NULL @@ -2629,7 +2713,7 @@ If an error occurs, the function will set @error and return %FALSE. version="3.4"> Notifies each of the backend's listeners about a new object. + line="4409">Notifies each of the backend's listeners about a new object. Uses the #EDataCalView's fields-of-interest to filter out unwanted information from ical strings sent over the bus. @@ -2642,13 +2726,13 @@ information from ical strings sent over the bus. an #ECalBackend + line="4411">an #ECalBackend the newly created #ECalComponent + line="4412">the newly created #ECalComponent @@ -2658,7 +2742,7 @@ information from ical strings sent over the bus. version="3.4"> Notifies each of the backend's listeners about a modified object. + line="4431">Notifies each of the backend's listeners about a modified object. Uses the #EDataCalView's fields-of-interest to filter out unwanted information from ical strings sent over the bus. @@ -2671,19 +2755,19 @@ information from ical strings sent over the bus. an #ECalBackend + line="4433">an #ECalBackend the #ECalComponent before the modification + line="4434">the #ECalComponent before the modification the #ECalComponent after the modification + line="4435">the #ECalComponent after the modification @@ -2693,7 +2777,7 @@ information from ical strings sent over the bus. version="3.4"> Notifies each of the backend's listeners about a removed object. + line="4456">Notifies each of the backend's listeners about a removed object. Uses the #EDataCalView's fields-of-interest to filter out unwanted information from ical strings sent over the bus. @@ -2706,25 +2790,25 @@ information from ical strings sent over the bus. an #ECalBackend + line="4458">an #ECalBackend the Id of the removed object + line="4459">the Id of the removed object the removed component + line="4460">the removed component the component after the removal. This only applies to recurrent + line="4461">the component after the removal. This only applies to recurrent appointments that had an instance removed. In that case, this function notifies a modification instead of a removal. @@ -2734,7 +2818,7 @@ notifies a modification instead of a removal. Notifies each of the backend's listeners about an error + line="4484">Notifies each of the backend's listeners about an error @@ -2744,13 +2828,13 @@ notifies a modification instead of a removal. an #ECalBackend + line="4486">an #ECalBackend Error message + line="4487">Error message @@ -2760,7 +2844,7 @@ notifies a modification instead of a removal. version="3.2"> Notifies client about property value change. + line="4508">Notifies client about property value change. @@ -2770,13 +2854,13 @@ notifies a modification instead of a removal. an #ECalBackend + line="4510">an #ECalBackend property name, which changed + line="4511">property name, which changed allow-none="1"> new property value + line="4512">new property value - + Asynchronously "opens" the @backend. Opening a backend is something of + line="1896">Asynchronously "opens" the @backend. Opening a backend is something of an outdated concept, but the operation is hanging around for a little while longer. This usually involves some custom initialization logic, and testing of remote authentication if applicable. @@ -2809,7 +2897,7 @@ call e_cal_backend_open_finish() to get the result of the operation. an #ECalBackend + line="1898">an #ECalBackend allow-none="1"> optional #GCancellable object, or %NULL + line="1899">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="1900">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="1901">data to pass to the callback function @@ -2849,7 +2937,7 @@ call e_cal_backend_open_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_cal_backend_open(). + line="1932">Finishes the operation started with e_cal_backend_open(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="1942">%TRUE on success, %FALSE on failure an #ECalBackend + line="1934">an #ECalBackend a #GAsyncResult + line="1935">a #GAsyncResult @@ -2878,10 +2966,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="open"> "Opens" the @backend. Opening a backend is something of an outdated + line="1818">"Opens" the @backend. Opening a backend is something of an outdated concept, but the operation is hanging around for a little while longer. This usually involves some custom initialization logic, and testing of remote authentication if applicable. @@ -2892,14 +2981,14 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="1831">%TRUE on success, %FALSE on failure an #ECalBackend + line="1820">an #ECalBackend allow-none="1"> optional #GCancellable object, or %NULL + line="1821">optional #GCancellable object, or %NULL @@ -2918,8 +3007,7 @@ If an error occurs, the function will set @error and return %FALSE. version="3.10"> Obtains the #GSimpleAsyncResult for @opid and sets @result_queue as a -place to deposit results prior to completing the #GSimpleAsyncResult. + line="4536">Obtains the #GTask for @opid. <note> <para> @@ -2928,41 +3016,37 @@ place to deposit results prior to completing the #GSimpleAsyncResult. calling this function. </para> </note> - + a #GSimpleAsyncResult - + line="4551">a #GTask + an #ECalBackend + line="4538">an #ECalBackend an operation ID given to #EDataCal + line="4539">an operation ID given to #EDataCal - - return location for a #GQueue, or %NULL - - + version="3.10" + glib:finish-func="receive_objects_finish" + glib:sync-func="receive_objects_sync"> Asynchronously receives the set of iCalendar objects specified by + line="3398">Asynchronously receives the set of iCalendar objects specified by @calobj. This is used for iTIP confirmation and cancellation messages for scheduled meetings. @@ -2978,19 +3062,19 @@ operation. an #ECalBackend + line="3400">an #ECalBackend an iCalendar string + line="3401">an iCalendar string bit-or of #ECalOperationFlags + line="3402">bit-or of #ECalOperationFlags allow-none="1"> optional #GCancellable object, or %NULL + line="3403">optional #GCancellable object, or %NULL closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="3404">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="3405">data to pass to the callback function @@ -3030,7 +3114,7 @@ operation. throws="1"> Finishes the operation started with e_cal_backend_receive_objects(). + line="3445">Finishes the operation started with e_cal_backend_receive_objects(). If an error occurred, the function will set @error and erturn %FALSE. %TRUE on success, %FALSE on failure + line="3455">%TRUE on success, %FALSE on failure an #ECalBackend + line="3447">an #ECalBackend a #GAsyncResult + line="3448">a #GAsyncResult @@ -3059,10 +3143,11 @@ If an error occurred, the function will set @error and erturn %FALSE. + throws="1" + glib:async-func="receive_objects"> Receives the set of iCalendar objects specified by @calobj. This is used + line="3308">Receives the set of iCalendar objects specified by @calobj. This is used for iTIP confirmation and cancellation messages for scheduled meetings. If an error occurs, the function will set @error and return %FALSE. @@ -3071,26 +3156,26 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="3321">%TRUE on success, %FALSE on failure an #ECalBackend + line="3310">an #ECalBackend an iCalendar string + line="3311">an iCalendar string bit-or of #ECalOperationFlags + line="3312">bit-or of #ECalOperationFlags allow-none="1"> optional #GCancellable object, or %NULL + line="3313">optional #GCancellable object, or %NULL @@ -3109,7 +3194,7 @@ If an error occurs, the function will set @error and return %FALSE. version="3.10"> Returns the #EDataCal for @backend. The #EDataCal is essentially + line="1291">Returns the #EDataCal for @backend. The #EDataCal is essentially the glue between incoming D-Bus requests and @backend's native API. An #EDataCal should be set only once after @backend is first created. @@ -3122,14 +3207,14 @@ unreferenced with g_object_unref() when finished with it. an #EDataCal, or %NULL + line="1304">an #EDataCal, or %NULL an #ECalBackend + line="1293">an #ECalBackend @@ -3139,7 +3224,7 @@ unreferenced with g_object_unref() when finished with it. version="3.12"> Returns the #GProxyResolver for @backend (if applicable), as indicated + line="1348">Returns the #GProxyResolver for @backend (if applicable), as indicated by the #ESourceAuthentication:proxy-uid of @backend's #EBackend:source or one of its ancestors. @@ -3150,24 +3235,26 @@ be unreferenced with g_object_unref() when finished with it. a #GProxyResolver, or %NULL + line="1359">a #GProxyResolver, or %NULL an #ECalBackend + line="1350">an #ECalBackend + version="3.10" + glib:finish-func="refresh_finish" + glib:sync-func="refresh_sync"> Asynchronously initiates a refresh for @backend, if the @backend supports + line="2057">Asynchronously initiates a refresh for @backend, if the @backend supports refreshing. The actual refresh operation completes on its own time. This function, along with e_cal_backend_refresh_finish(), merely initiates the operation. @@ -3183,7 +3270,7 @@ call e_cal_backend_refresh_finish() to get the result of the initiation. an #ECalBackend + line="2059">an #ECalBackend allow-none="1"> optional #GCancellable object, or %NULL + line="2060">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="2061">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="2062">data to pass to the callback function @@ -3223,7 +3310,7 @@ call e_cal_backend_refresh_finish() to get the result of the initiation. throws="1"> Finishes the refresh initiation started with e_cal_backend_refresh(). + line="2093">Finishes the refresh initiation started with e_cal_backend_refresh(). If an error occurred while initiating the refresh, the function will set @error and return %FALSE. If the @backend does not support refreshing, @@ -3234,20 +3321,20 @@ the function will set an %E_CLIENT_ERROR_NOT_SUPPORTED error and return %TRUE on success, %FALSE on failure + line="2106">%TRUE on success, %FALSE on failure an #ECalBackend + line="2095">an #ECalBackend a #GAsyncResult + line="2096">a #GAsyncResult @@ -3255,10 +3342,11 @@ the function will set an %E_CLIENT_ERROR_NOT_SUPPORTED error and return + throws="1" + glib:async-func="refresh"> Initiates a refresh for @backend, if the @backend supports refreshing. + line="1968">Initiates a refresh for @backend, if the @backend supports refreshing. The actual refresh operation completes on its own time. This function merely initiates the operation. @@ -3271,14 +3359,14 @@ the function will set an %E_CLIENT_ERROR_NOT_SUPPORTED error and return %TRUE on success, %FALSE on failure + line="1983">%TRUE on success, %FALSE on failure an #ECalBackend + line="1970">an #ECalBackend optional #GCancellable object, or %NULL + line="1971">optional #GCancellable object, or %NULL + version="3.10" + glib:finish-func="remove_objects_finish" + glib:sync-func="remove_objects_sync"> Asynchronously removes one or more iCalendar objects according to + line="3186">Asynchronously removes one or more iCalendar objects according to @component_ids and @mod. When the operation is finished, @callback will be called. You can then @@ -3312,13 +3402,13 @@ operation. an #ECalBackend + line="3188">an #ECalBackend a #GList of #ECalComponentId structs + line="3189">a #GList of #ECalComponentId structs @@ -3326,13 +3416,13 @@ operation. modification type for recurrences + line="3190">modification type for recurrences bit-or of #ECalOperationFlags + line="3191">bit-or of #ECalOperationFlags allow-none="1"> optional #GCancellable object, or %NULL + line="3192">optional #GCancellable object, or %NULL closure="5"> a #GAsyncReadyCallback to call when the request is satisfied + line="3193">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="3194">data to pass to the callback function @@ -3372,7 +3462,7 @@ operation. throws="1"> Finishes the operation started with e_cal_backend_remove_objects(). + line="3242">Finishes the operation started with e_cal_backend_remove_objects(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="3252">%TRUE on success, %FALSE on failure an #ECalBackend + line="3244">an #ECalBackend a #GAsyncResult + line="3245">a #GAsyncResult @@ -3401,10 +3491,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="remove_objects"> Removes one or more iCalendar objects according to @component_ids and @mod. + line="3094">Removes one or more iCalendar objects according to @component_ids and @mod. If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="3107">%TRUE on success, %FALSE on failure an #ECalBackend + line="3096">an #ECalBackend a #GList of #ECalComponentId structs + line="3097">a #GList of #ECalComponentId structs @@ -3433,13 +3524,13 @@ If an error occurs, the function will set @error and return %FALSE. modification type for recurrences + line="3098">modification type for recurrences bit-or of #ECalOperationFlags + line="3099">bit-or of #ECalOperationFlags allow-none="1"> optional #GCancellable object, or %NULL + line="3100">optional #GCancellable object, or %NULL @@ -3458,7 +3549,7 @@ If an error occurs, the function will set @error and return %FALSE. version="3.2"> Removes view from the list of live views for the backend. + line="1642">Removes view from the list of live views for the backend. @@ -3468,13 +3559,13 @@ If an error occurs, the function will set @error and return %FALSE. an #ECalBackend + line="1644">an #ECalBackend An #EDataCalView object, previously added with @ref e_cal_backend_add_view. + line="1645">An #EDataCalView object, previously added with @ref e_cal_backend_add_view. @@ -3484,7 +3575,7 @@ If an error occurs, the function will set @error and return %FALSE. version="3.26"> Schedules user function @func to be run in a dedicated thread as + line="4661">Schedules user function @func to be run in a dedicated thread as a blocking operation. The function adds its own reference to @use_cancellable, if not %NULL. @@ -3493,7 +3584,7 @@ The error returned from @func is propagated to client using e_cal_backend_notify_error() function. If it's not desired, then left the error unchanged and notify about errors manually. + line="526"/> @@ -3501,7 +3592,7 @@ then left the error unchanged and notify about errors manually. an #ECalBackend + line="4663">an #ECalBackend allow-none="1"> an optional #GCancellable to use for @func + line="4664">an optional #GCancellable to use for @func destroy="3"> a function to call in a dedicated thread + line="4665">a function to call in a dedicated thread @@ -3530,7 +3621,7 @@ then left the error unchanged and notify about errors manually. allow-none="1"> user data being passed to @func + line="4666">user data being passed to @func scope="async"> optional destroy call back for @user_data + line="4667">optional destroy call back for @user_data + version="3.10" + glib:finish-func="send_objects_finish" + glib:sync-func="send_objects_sync"> Asynchronously sends meeting information in @calobj. The @backend may + line="3572">Asynchronously sends meeting information in @calobj. The @backend may modify @calobj and send meeting information only to particular users. When the operation is finished, @callback will be called. You can then @@ -3564,19 +3657,19 @@ call e_cal_backend_send_objects_finish() to get the result of the operation. an #ECalBackend + line="3574">an #ECalBackend an iCalendar string + line="3575">an iCalendar string bit-or of #ECalOperationFlags + line="3576">bit-or of #ECalOperationFlags optional #GCancellable object, or %NULL + line="3577">optional #GCancellable object, or %NULL a #GAsyncReadyCallback to call when the request is satisfied + line="3578">a #GAsyncReadyCallback to call when the request is satisfied data to pass to the callback function + line="3579">data to pass to the callback function @@ -3616,7 +3709,7 @@ call e_cal_backend_send_objects_finish() to get the result of the operation. Finishes the operation started with e_cal_backend_send_objects(). + line="3617">Finishes the operation started with e_cal_backend_send_objects(). The function returns a string representation of a sent, or to be send, vCalendar and deposits the list of users the meeting information was sent @@ -3630,26 +3723,26 @@ If an error occurs, the function will set @error and return %NULL. a newly allocated vCalendar string, or %NULL on error + line="3634">a newly allocated vCalendar string, or %NULL on error an #ECalBackend + line="3619">an #ECalBackend a #GAsyncResult + line="3620">a #GAsyncResult a #GQueue in which to deposit results + line="3621">a #GQueue in which to deposit results @@ -3657,10 +3750,11 @@ If an error occurs, the function will set @error and return %NULL. + throws="1" + glib:async-func="send_objects"> Sends meeting information in @calobj. The @backend may modify @calobj + line="3476">Sends meeting information in @calobj. The @backend may modify @calobj and send meeting information only to particular users. The function returns the (maybe) modified @calobj and deposits the list of users the meeting information was sent (to be send) to in @out_users. @@ -3673,32 +3767,32 @@ If an error occurs, the function will set @error and return %NULL. a vCalendar string, or %NULL on error + line="3494">a vCalendar string, or %NULL on error an #ECalBackend + line="3478">an #ECalBackend an iCalendar string + line="3479">an iCalendar string bit-or of #ECalOperationFlags + line="3480">bit-or of #ECalOperationFlags a #GQueue in which to deposit results + line="3481">a #GQueue in which to deposit results allow-none="1"> optional #GCancellable object, or %NULL + line="3482">optional #GCancellable object, or %NULL @@ -3718,7 +3812,7 @@ If an error occurs, the function will set @error and return %NULL. version="2.32"> Sets the cache directory path for use by @backend. + line="1525">Sets the cache directory path for use by @backend. Note that #ECalBackend is initialized with a default cache directory path which should suffice for most cases. Backends should not override @@ -3732,13 +3826,13 @@ the default path without good reason. an #ECalBackend + line="1527">an #ECalBackend a local cache directory path + line="1528">a local cache directory path @@ -3748,7 +3842,7 @@ the default path without good reason. version="3.10"> Sets the #EDataCal for @backend. The #EDataCal is essentially the + line="1321">Sets the #EDataCal for @backend. The #EDataCal is essentially the glue between incoming D-Bus requests and @backend's native API. An #EDataCal should be set only once after @backend is first created. @@ -3763,13 +3857,13 @@ The @backend adds its own reference on the @data_cal. an #ECalBackend + line="1323">an #ECalBackend an #EDataCal + line="1324">an #EDataCal @@ -3780,7 +3874,7 @@ The @backend adds its own reference on the @data_cal. version="3.8"> Sets whether @backend will accept changes to its data content. + line="1416">Sets whether @backend will accept changes to its data content. @@ -3790,13 +3884,13 @@ The @backend adds its own reference on the @data_cal. an #ECalBackend + line="1418">an #ECalBackend whether @backend is writable + line="1419">whether @backend is writable @@ -3806,7 +3900,7 @@ The @backend adds its own reference on the @data_cal. version="3.2"> Starts a new live view on the given backend. + line="4354">Starts a new live view on the given backend. @@ -3816,13 +3910,13 @@ The @backend adds its own reference on the @data_cal. an #ECalBackend + line="4356">an #ECalBackend The view to be started. + line="4357">The view to be started. @@ -3832,7 +3926,7 @@ The @backend adds its own reference on the @data_cal. version="3.2"> Stops a previously started live view on the given backend. + line="4381">Stops a previously started live view on the given backend. @@ -3842,13 +3936,13 @@ The @backend adds its own reference on the @data_cal. an #ECalBackend + line="4383">an #ECalBackend The view to be stopped. + line="4384">The view to be stopped. @@ -3896,7 +3990,7 @@ The @backend adds its own reference on the @data_cal. Emitted when a client destroys its #ECalClient for @backend + line="1202">Emitted when a client destroys its #ECalClient for @backend @@ -3904,7 +3998,7 @@ The @backend adds its own reference on the @data_cal. the bus name that invoked the "close" method + line="1205">the bus name that invoked the "close" method @@ -3912,7 +4006,7 @@ The @backend adds its own reference on the @data_cal. Emitted when the last client destroys its #ECalClient for + line="1220">Emitted when the last client destroys its #ECalClient for @backend. This signals the @backend to begin final cleanup tasks such as synchronizing data to permanent storage. @@ -3942,6 +4036,9 @@ a calendar backend. + Fetch a property value by name from the backend @@ -3959,6 +4056,9 @@ a calendar backend. + Open the backend @@ -3985,6 +4085,9 @@ a calendar backend. + Refresh the backend @@ -4011,6 +4114,9 @@ a calendar backend. + Fetch a calendar object @@ -4043,6 +4149,9 @@ a calendar backend. + FIXME: Document me @@ -4072,6 +4181,9 @@ a calendar backend. + FIXME: Document me @@ -4100,15 +4212,18 @@ a calendar backend. - + - + + FIXME: Document me @@ -4143,6 +4258,9 @@ a calendar backend. + FIXME: Document me @@ -4180,6 +4298,9 @@ a calendar backend. + FIXME: Document me @@ -4217,6 +4338,9 @@ a calendar backend. + FIXME: Document me @@ -4249,6 +4373,9 @@ a calendar backend. + FIXME: Document me @@ -4281,6 +4408,9 @@ a calendar backend. + FIXME: Document me @@ -4313,6 +4443,9 @@ a calendar backend. + FIXME: Document me @@ -4351,6 +4484,9 @@ a calendar backend. + FIXME: Document me @@ -4380,6 +4516,9 @@ a calendar backend. + FIXME: Document me @@ -4409,6 +4548,9 @@ a calendar backend. + Start up the specified view @@ -4426,6 +4568,9 @@ a calendar backend. + Stop the specified view @@ -4443,6 +4588,9 @@ a calendar backend. + A signal notifying that the backend was closed @@ -4460,6 +4608,9 @@ a calendar backend. + A signal notifying that the backend is being shut down @@ -4485,10 +4636,10 @@ a calendar backend. throws="1"> A callback prototype being called in a dedicated thread, scheduled + line="509">A callback prototype being called in a dedicated thread, scheduled by e_cal_backend_schedule_custom_operation(). + line="521"/> @@ -4496,7 +4647,7 @@ by e_cal_backend_schedule_custom_operation(). an #ECalBackend + line="511">an #ECalBackend closure="1"> a function user data, as provided to e_cal_backend_schedule_custom_operation() + line="512">a function user data, as provided to e_cal_backend_schedule_custom_operation() allow-none="1"> an optional #GCancellable, as provided to e_cal_backend_schedule_custom_operation() + line="513">an optional #GCancellable, as provided to e_cal_backend_schedule_custom_operation() @@ -4589,26 +4740,26 @@ backends of the specified type on demand. version="3.34"> Callback function used by e_cal_backend_foreach_view(). + line="1719">Callback function used by e_cal_backend_foreach_view(). %TRUE, to continue, %FALSE to stop further processing. + line="1727">%TRUE, to continue, %FALSE to stop further processing. an #ECalBackend + line="1721">an #ECalBackend an #EDataCalView + line="1722">an #EDataCalView closure="2"> user data for the function + line="1723">user data for the function @@ -4916,13 +5067,13 @@ FIXME: TIMEZONES - this uses the current Unix timezone. Start of the time window will be stored here. - + End of the time window will be stored here. - + @@ -5093,6 +5244,9 @@ functions below. line="190"/> + Add specified timezone @@ -5117,6 +5271,9 @@ functions below. + Create objects @@ -5156,6 +5313,9 @@ functions below. + Discard alarm @@ -5191,6 +5351,9 @@ functions below. + Get attachments uris for given object @@ -5223,6 +5386,9 @@ functions below. + Get Free/Busy objects @@ -5247,10 +5413,10 @@ functions below. - + - + @@ -5262,6 +5428,9 @@ functions below. + Get multiple objects at once @@ -5291,6 +5460,9 @@ functions below. + Get single object @@ -5321,6 +5493,9 @@ functions below. + Get specified timezone @@ -5348,6 +5523,9 @@ functions below. + Modify objects @@ -5390,6 +5568,9 @@ functions below. + Open the calendar @@ -5411,6 +5592,9 @@ functions below. + Receive objects @@ -5438,6 +5622,9 @@ functions below. + Refresh the calendar @@ -5459,6 +5646,9 @@ functions below. + Remove objects @@ -5501,6 +5691,9 @@ functions below. + Send objects @@ -5808,13 +6001,13 @@ functions below. Time range start. - + Time range end. - + + Open the calendar @@ -6379,6 +6575,9 @@ or just create it when it does not exist. + Refresh the calendar @@ -6402,6 +6601,9 @@ or just create it when it does not exist. + Get single object @@ -6434,6 +6636,9 @@ or just create it when it does not exist. + Get multiple objects at once @@ -6465,6 +6670,9 @@ or just create it when it does not exist. + Get Free/Busy objects @@ -6490,10 +6698,10 @@ or just create it when it does not exist. - + - + @@ -6504,6 +6712,9 @@ or just create it when it does not exist. + Create objects @@ -6545,6 +6756,9 @@ or just create it when it does not exist. + Modify objects @@ -6589,6 +6803,9 @@ or just create it when it does not exist. + Remove objects @@ -6633,6 +6850,9 @@ or just create it when it does not exist. + Receive objects @@ -6662,6 +6882,9 @@ or just create it when it does not exist. + Send objects @@ -6699,6 +6922,9 @@ or just create it when it does not exist. + Get attachments uris for given object @@ -6735,6 +6961,9 @@ or just create it when it does not exist. + Discard alarm @@ -6770,6 +6999,9 @@ or just create it when it does not exist. + Get specified timezone @@ -6799,6 +7031,9 @@ or just create it when it does not exist. + Add specified timezone @@ -7515,13 +7750,13 @@ It's not an error if none is found. start of the range, as time_t, inclusive - + end of the range, as time_t, exclusive - + start of the range, as time_t, inclusive - + end of the range, as time_t, exclusive - + throws="1"> This is called always before any operation which requires a connection + line="4918">This is called always before any operation which requires a connection to the remote side. It can fail with an #E_CLIENT_ERROR_REPOSITORY_OFFLINE error to indicate that the remote side cannot be currently reached. Other errors are propagated to the caller/client side. This method is not called @@ -9120,14 +9355,14 @@ It is mandatory to implement this virtual method by the descendant. Whether succeeded. + line="4955">Whether succeeded. an #ECalMetaBackend + line="4920">an #ECalMetaBackend allow-none="1"> an #ENamedParameters with previously used credentials, or %NULL + line="4921">an #ENamedParameters with previously used credentials, or %NULL @@ -9146,7 +9381,7 @@ It is mandatory to implement this virtual method by the descendant. transfer-ownership="full"> an #ESourceAuthenticationResult with an authentication result + line="4922">an #ESourceAuthenticationResult with an authentication result @@ -9156,7 +9391,7 @@ It is mandatory to implement this virtual method by the descendant. transfer-ownership="full"> a PEM encoded certificate on failure, or %NULL + line="4923">a PEM encoded certificate on failure, or %NULL transfer-ownership="full"> a #GTlsCertificateFlags on failure, or 0 + line="4924">a #GTlsCertificateFlags on failure, or 0 @@ -9175,7 +9410,7 @@ It is mandatory to implement this virtual method by the descendant. allow-none="1"> optional #GCancellable object, or %NULL + line="4925">optional #GCancellable object, or %NULL @@ -9186,7 +9421,7 @@ It is mandatory to implement this virtual method by the descendant. throws="1"> This is called when the backend goes into offline mode or + line="4979">This is called when the backend goes into offline mode or when the disconnect is required. The implementation should not report any error when it is called and the @meta_backend is not connected. @@ -9197,14 +9432,14 @@ It is mandatory to implement this virtual method by the descendant. Whether succeeded. + line="4992">Whether succeeded. an #ECalMetaBackend + line="4981">an #ECalMetaBackend allow-none="1"> optional #GCancellable object, or %NULL + line="4982">optional #GCancellable object, or %NULL @@ -9224,7 +9459,7 @@ It is mandatory to implement this virtual method by the descendant. throws="1"> Gathers the changes since the last check which had been done + line="5012">Gathers the changes since the last check which had been done on the remote side. The @last_sync_tag can be used as a tag of the last check. This can be %NULL, @@ -9255,14 +9490,14 @@ when no longer needed. Whether succeeded. + line="5058">Whether succeeded. an #ECalMetaBackend + line="5014">an #ECalMetaBackend allow-none="1"> optional sync tag from the last check + line="5015">optional sync tag from the last check set to %TRUE when this is the repeated call + line="5016">set to %TRUE when this is the repeated call transfer-ownership="full"> new sync tag to store on success + line="5017">new sync tag to store on success transfer-ownership="full"> whether to repeat this call again; default is %FALSE + line="5018">whether to repeat this call again; default is %FALSE transfer-ownership="full"> + line="5019"> a #GSList of #ECalMetaBackendInfo object infos which had been created since the last check @@ -9317,7 +9552,7 @@ when no longer needed. transfer-ownership="full"> + line="5022"> a #GSList of #ECalMetaBackendInfo object infos which had been modified since the last check @@ -9330,7 +9565,7 @@ when no longer needed. transfer-ownership="full"> + line="5025"> a #GSList of #ECalMetaBackendInfo object infos which had been removed since the last check @@ -9343,7 +9578,7 @@ when no longer needed. allow-none="1"> optional #GCancellable object, or %NULL + line="5028">optional #GCancellable object, or %NULL @@ -9353,7 +9588,7 @@ when no longer needed. version="3.28"> It is optional to implement this virtual method by the descendants. + line="5561">It is optional to implement this virtual method by the descendants. It is used to receive SSL error details when any online operation returns E_CLIENT_ERROR, E_CLIENT_ERROR_TLS_NOT_AVAILABLE error. %TRUE, when the SSL error details had been available and + line="5571">%TRUE, when the SSL error details had been available and the out parameters populated, %FALSE otherwise. @@ -9369,7 +9604,7 @@ returns E_CLIENT_ERROR, E_CLIENT_ERROR_TLS_NOT_AVAILABLE error. an #ECalMetaBackend + line="5563">an #ECalMetaBackend transfer-ownership="full"> SSL certificate encoded in PEM format + line="5564">SSL certificate encoded in PEM format transfer-ownership="full"> bit-or of #GTlsCertificateFlags claiming the certificate errors + line="5565">bit-or of #GTlsCertificateFlags claiming the certificate errors @@ -9399,7 +9634,7 @@ returns E_CLIENT_ERROR, E_CLIENT_ERROR_TLS_NOT_AVAILABLE error. throws="1"> Used to get list of all existing objects on the remote side. The descendant + line="5123">Used to get list of all existing objects on the remote side. The descendant can optionally provide @out_new_sync_tag, which will be stored on success, if not %NULL. The descendant can populate also ECalMetaBackendInfo::object of the @out_existing_objects, if known, in which case this will be used instead @@ -9416,14 +9651,14 @@ when no longer needed. Whether succeeded. + line="5145">Whether succeeded. an #ECalMetaBackend + line="5125">an #ECalMetaBackend transfer-ownership="full"> optional return location for a new sync tag + line="5126">optional return location for a new sync tag transfer-ownership="full"> + line="5127"> a #GSList of #ECalMetaBackendInfo object infos which are stored on the remote side @@ -9453,7 +9688,7 @@ when no longer needed. allow-none="1"> optional #GCancellable object, or %NULL + line="5129">optional #GCancellable object, or %NULL @@ -9464,7 +9699,7 @@ when no longer needed. throws="1"> Loads a component from the remote side. Any detached instances should be + line="5191">Loads a component from the remote side. Any detached instances should be returned together with the master object. The @out_component can be either a VCALENDAR component, which would contain the master object and all of its detached instances, eventually also used time zones, or the requested @@ -9482,20 +9717,20 @@ needed. Whether succeeded. + line="5215">Whether succeeded. an #ECalMetaBackend + line="5193">an #ECalMetaBackend a component UID + line="5194">a component UID allow-none="1"> optional extra data stored with the component, or %NULL + line="5195">optional extra data stored with the component, or %NULL transfer-ownership="full"> a loaded component, as #ICalComponent + line="5196">a loaded component, as #ICalComponent transfer-ownership="full"> an extra data to store to #ECalCache with this component + line="5197">an extra data to store to #ECalCache with this component allow-none="1"> optional #GCancellable object, or %NULL + line="5198">optional #GCancellable object, or %NULL @@ -9542,7 +9777,7 @@ needed. throws="1"> Removes a component from the remote side, with all its detached instances. + line="5374">Removes a component from the remote side, with all its detached instances. The @object is not %NULL when it's removing locally deleted object in offline mode. Being it %NULL, the descendant can obtain the object from the #ECalCache. @@ -9553,27 +9788,27 @@ It is mandatory to implement this virtual method by the writable descendant. Whether succeeded. + line="5392">Whether succeeded. an #ECalMetaBackend + line="5376">an #ECalMetaBackend an #EConflictResolution to use + line="5377">an #EConflictResolution to use a component UID + line="5378">a component UID extra data being saved with the component in the local cache, or %NULL + line="5379">extra data being saved with the component in the local cache, or %NULL corresponding iCalendar object, as stored in the local cache, or %NULL + line="5380">corresponding iCalendar object, as stored in the local cache, or %NULL bit-or of #ECalOperationFlags + line="5381">bit-or of #ECalOperationFlags optional #GCancellable object, or %NULL + line="5382">optional #GCancellable object, or %NULL @@ -9616,7 +9851,7 @@ It is mandatory to implement this virtual method by the writable descendant. Determines, whether current source content requires reconnect of the backend. + line="5530">Determines, whether current source content requires reconnect of the backend. It is optional to implement this virtual method by the descendant. The default implementation compares %E_SOURCE_EXTENSION_AUTHENTICATION and @@ -9629,14 +9864,14 @@ no successful connect done yet. %TRUE, when reconnect is required, %FALSE otherwise. + line="5543">%TRUE, when reconnect is required, %FALSE otherwise. an #ECalMetaBackend + line="5532">an #ECalMetaBackend @@ -9647,7 +9882,7 @@ no successful connect done yet. throws="1"> Saves one component into the remote side. The @instances contain the master + line="5265">Saves one component into the remote side. The @instances contain the master object and all the detached instances of the same component (all have the same UID). When the @overwrite_existing is %TRUE, then the descendant can overwrite an object with the same UID on the remote side (usually used for modify). The @conflict_resolution @@ -9681,33 +9916,33 @@ It is mandatory to implement this virtual method by the writable descendant. Whether succeeded. + line="5308">Whether succeeded. an #ECalMetaBackend + line="5267">an #ECalMetaBackend %TRUE when can overwrite existing components, %FALSE otherwise + line="5268">%TRUE when can overwrite existing components, %FALSE otherwise one of #EConflictResolution, what to do on conflicts + line="5269">one of #EConflictResolution, what to do on conflicts instances of the component to save + line="5270">instances of the component to save @@ -9718,13 +9953,13 @@ It is mandatory to implement this virtual method by the writable descendant. extra data saved with the components in an #ECalCache + line="5271">extra data saved with the components in an #ECalCache bit-or of #ECalOperationFlags + line="5272">bit-or of #ECalOperationFlags return location for the UID of the saved component + line="5273">return location for the UID of the saved component return location for the extra data to store with the component + line="5274">return location for the extra data to store with the component optional #GCancellable object, or %NULL + line="5275">optional #GCancellable object, or %NULL @@ -9762,7 +9997,7 @@ It is mandatory to implement this virtual method by the writable descendant. Searches @meta_backend with given expression @expr and returns + line="5487">Searches @meta_backend with given expression @expr and returns found components as a #GSList of #ECalComponent @out_components. Free the returned @out_components with g_slist_free_full (components, g_object_unref); when no longer needed. @@ -9778,14 +10013,14 @@ ensure it. Whether succeeded. + line="5507">Whether succeeded. an #ECalMetaBackend + line="5489">an #ECalMetaBackend allow-none="1"> a search expression, or %NULL + line="5490">a search expression, or %NULL transfer-ownership="full"> return location for the found #ECalComponent-s + line="5491">return location for the found #ECalComponent-s @@ -9814,7 +10049,7 @@ ensure it. allow-none="1"> optional #GCancellable object, or %NULL + line="5492">optional #GCancellable object, or %NULL @@ -9825,7 +10060,7 @@ ensure it. throws="1"> Searches @meta_backend with given expression @expr and returns + line="5444">Searches @meta_backend with given expression @expr and returns found components as a #GSList of iCal strings @out_icalstrings. Free the returned @out_icalstrings with g_slist_free_full (icalstrings, g_free); when no longer needed. @@ -9841,14 +10076,14 @@ ensure it. Whether succeeded. + line="5464">Whether succeeded. an #ECalMetaBackend + line="5446">an #ECalMetaBackend allow-none="1"> a search expression, or %NULL + line="5447">a search expression, or %NULL transfer-ownership="full"> return location for the found components as iCal strings + line="5448">return location for the found components as iCal strings @@ -9877,7 +10112,7 @@ ensure it. allow-none="1"> optional #GCancellable object, or %NULL + line="5449">optional #GCancellable object, or %NULL @@ -9900,7 +10135,7 @@ ensure it. throws="1"> This is called always before any operation which requires a connection + line="4918">This is called always before any operation which requires a connection to the remote side. It can fail with an #E_CLIENT_ERROR_REPOSITORY_OFFLINE error to indicate that the remote side cannot be currently reached. Other errors are propagated to the caller/client side. This method is not called @@ -9931,14 +10166,14 @@ It is mandatory to implement this virtual method by the descendant. Whether succeeded. + line="4955">Whether succeeded. an #ECalMetaBackend + line="4920">an #ECalMetaBackend allow-none="1"> an #ENamedParameters with previously used credentials, or %NULL + line="4921">an #ENamedParameters with previously used credentials, or %NULL @@ -9957,7 +10192,7 @@ It is mandatory to implement this virtual method by the descendant. transfer-ownership="full"> an #ESourceAuthenticationResult with an authentication result + line="4922">an #ESourceAuthenticationResult with an authentication result @@ -9967,7 +10202,7 @@ It is mandatory to implement this virtual method by the descendant. transfer-ownership="full"> a PEM encoded certificate on failure, or %NULL + line="4923">a PEM encoded certificate on failure, or %NULL transfer-ownership="full"> a #GTlsCertificateFlags on failure, or 0 + line="4924">a #GTlsCertificateFlags on failure, or 0 @@ -9986,7 +10221,7 @@ It is mandatory to implement this virtual method by the descendant. allow-none="1"> optional #GCancellable object, or %NULL + line="4925">optional #GCancellable object, or %NULL @@ -9997,7 +10232,7 @@ It is mandatory to implement this virtual method by the descendant. throws="1"> This is called when the backend goes into offline mode or + line="4979">This is called when the backend goes into offline mode or when the disconnect is required. The implementation should not report any error when it is called and the @meta_backend is not connected. @@ -10008,14 +10243,14 @@ It is mandatory to implement this virtual method by the descendant. Whether succeeded. + line="4992">Whether succeeded. an #ECalMetaBackend + line="4981">an #ECalMetaBackend allow-none="1"> optional #GCancellable object, or %NULL + line="4982">optional #GCancellable object, or %NULL @@ -10034,7 +10269,7 @@ It is mandatory to implement this virtual method by the descendant. version="3.28"> Returns the last known synchronization tag, the same as used to + line="3797">Returns the last known synchronization tag, the same as used to call e_cal_meta_backend_get_changes_sync(). Free the returned string with g_free(), when no longer needed. @@ -10043,7 +10278,7 @@ Free the returned string with g_free(), when no longer needed. The last known synchronization tag, + line="3806">The last known synchronization tag, or %NULL, when none is stored. @@ -10051,7 +10286,7 @@ Free the returned string with g_free(), when no longer needed. an #ECalMetaBackend + line="3799">an #ECalMetaBackend @@ -10062,7 +10297,7 @@ Free the returned string with g_free(), when no longer needed. throws="1"> Empties the local cache by removing all known components from it + line="4427">Empties the local cache by removing all known components from it and notifies about such removal any opened views. It removes also all known time zones. Whether succeeded. + line="4437">Whether succeeded. an #ECalMetaBackend + line="4429">an #ECalMetaBackend allow-none="1"> optional #GCancellable object, or %NULL + line="4430">optional #GCancellable object, or %NULL @@ -10097,20 +10332,20 @@ all known time zones. throws="1"> Ensures that the @meta_backend is connected to its destination. + line="4545">Ensures that the @meta_backend is connected to its destination. Whether succeeded. + line="4553">Whether succeeded. an #ECalMetaBackend + line="4547">an #ECalMetaBackend allow-none="1"> optional #GCancellable object, or %NULL + line="4548">optional #GCancellable object, or %NULL @@ -10130,7 +10365,7 @@ all known time zones. throws="1"> Extracts all VTIMEZONE components from the @vcalendar and adds them + line="4373">Extracts all VTIMEZONE components from the @vcalendar and adds them to the memory cache, thus they are available when needed. The function does nothing when the @vcalendar doesn't hold a VCALENDAR component. @@ -10142,26 +10377,26 @@ to preserver existing timezones and merge them with those in @vcalendar. Whether succeeded. + line="4389">Whether succeeded. an #ECalMetaBackend + line="4375">an #ECalMetaBackend a VCALENDAR #ICalComponent + line="4376">a VCALENDAR #ICalComponent whether to remove any existing first + line="4377">whether to remove any existing first allow-none="1"> optional #GCancellable object, or %NULL + line="4378">optional #GCancellable object, or %NULL @@ -10183,7 +10418,7 @@ to preserver existing timezones and merge them with those in @vcalendar. an #ECalBackend::capabilities property to be used by + line="3653">an #ECalBackend::capabilities property to be used by the descendant in conjunction to the descendant's capabilities in the result of e_cal_backend_get_backend_property() with #CLIENT_BACKEND_PROPERTY_CAPABILITIES. @@ -10193,7 +10428,7 @@ to preserver existing timezones and merge them with those in @vcalendar. an #ECalMetaBackend + line="3651">an #ECalMetaBackend @@ -10204,7 +10439,7 @@ to preserver existing timezones and merge them with those in @vcalendar. throws="1"> Gathers the changes since the last check which had been done + line="5012">Gathers the changes since the last check which had been done on the remote side. The @last_sync_tag can be used as a tag of the last check. This can be %NULL, @@ -10235,14 +10470,14 @@ when no longer needed. Whether succeeded. + line="5058">Whether succeeded. an #ECalMetaBackend + line="5014">an #ECalMetaBackend allow-none="1"> optional sync tag from the last check + line="5015">optional sync tag from the last check set to %TRUE when this is the repeated call + line="5016">set to %TRUE when this is the repeated call transfer-ownership="full"> new sync tag to store on success + line="5017">new sync tag to store on success transfer-ownership="full"> whether to repeat this call again; default is %FALSE + line="5018">whether to repeat this call again; default is %FALSE transfer-ownership="full"> + line="5019"> a #GSList of #ECalMetaBackendInfo object infos which had been created since the last check @@ -10297,7 +10532,7 @@ when no longer needed. transfer-ownership="full"> + line="5022"> a #GSList of #ECalMetaBackendInfo object infos which had been modified since the last check @@ -10310,7 +10545,7 @@ when no longer needed. transfer-ownership="full"> + line="5025"> a #GSList of #ECalMetaBackendInfo object infos which had been removed since the last check @@ -10323,7 +10558,7 @@ when no longer needed. allow-none="1"> optional #GCancellable object, or %NULL + line="5028">optional #GCancellable object, or %NULL @@ -10333,21 +10568,21 @@ when no longer needed. version="3.26"> This value has meaning only if e_cal_meta_backend_get_ever_connected() + line="3764">This value has meaning only if e_cal_meta_backend_get_ever_connected() is %TRUE. Whether the @meta_backend connected to a writable destination. + line="3771">Whether the @meta_backend connected to a writable destination. an #ECalMetaBackend + line="3766">an #ECalMetaBackend @@ -10360,7 +10595,7 @@ is %TRUE. Whether the @meta_backend ever made a successful connection + line="3706">Whether the @meta_backend ever made a successful connection to its destination. @@ -10368,7 +10603,7 @@ is %TRUE. an #ECalMetaBackend + line="3704">an #ECalMetaBackend @@ -10378,7 +10613,7 @@ is %TRUE. version="3.28"> It is optional to implement this virtual method by the descendants. + line="5561">It is optional to implement this virtual method by the descendants. It is used to receive SSL error details when any online operation returns E_CLIENT_ERROR, E_CLIENT_ERROR_TLS_NOT_AVAILABLE error. %TRUE, when the SSL error details had been available and + line="5571">%TRUE, when the SSL error details had been available and the out parameters populated, %FALSE otherwise. @@ -10394,7 +10629,7 @@ returns E_CLIENT_ERROR, E_CLIENT_ERROR_TLS_NOT_AVAILABLE error. an #ECalMetaBackend + line="5563">an #ECalMetaBackend transfer-ownership="full"> SSL certificate encoded in PEM format + line="5564">SSL certificate encoded in PEM format transfer-ownership="full"> bit-or of #GTlsCertificateFlags claiming the certificate errors + line="5565">bit-or of #GTlsCertificateFlags claiming the certificate errors @@ -10424,7 +10659,7 @@ returns E_CLIENT_ERROR, E_CLIENT_ERROR_TLS_NOT_AVAILABLE error. throws="1"> Changes all URL attachments which point to a local file in @component + line="4253">Changes all URL attachments which point to a local file in @component to inline attachments, aka adds the file content into the @component. It also populates FILENAME parameter on the attachment. This is called automatically before e_cal_meta_backend_save_component_sync(). @@ -10435,20 +10670,20 @@ The reverse operation is e_cal_meta_backend_store_inline_attachments_sync(). Whether succeeded. + line="4267">Whether succeeded. an #ECalMetaBackend + line="4255">an #ECalMetaBackend an #ICalComponent to work with + line="4256">an #ICalComponent to work with optional #GCancellable object, or %NULL + line="4257">optional #GCancellable object, or %NULL @@ -10468,7 +10703,7 @@ The reverse operation is e_cal_meta_backend_store_inline_attachments_sync(). Used to get list of all existing objects on the remote side. The descendant + line="5123">Used to get list of all existing objects on the remote side. The descendant can optionally provide @out_new_sync_tag, which will be stored on success, if not %NULL. The descendant can populate also ECalMetaBackendInfo::object of the @out_existing_objects, if known, in which case this will be used instead @@ -10485,14 +10720,14 @@ when no longer needed. Whether succeeded. + line="5145">Whether succeeded. an #ECalMetaBackend + line="5125">an #ECalMetaBackend transfer-ownership="full"> optional return location for a new sync tag + line="5126">optional return location for a new sync tag transfer-ownership="full"> + line="5127"> a #GSList of #ECalMetaBackendInfo object infos which are stored on the remote side @@ -10522,7 +10757,7 @@ when no longer needed. allow-none="1"> optional #GCancellable object, or %NULL + line="5129">optional #GCancellable object, or %NULL @@ -10533,7 +10768,7 @@ when no longer needed. throws="1"> Loads a component from the remote side. Any detached instances should be + line="5191">Loads a component from the remote side. Any detached instances should be returned together with the master object. The @out_component can be either a VCALENDAR component, which would contain the master object and all of its detached instances, eventually also used time zones, or the requested @@ -10551,20 +10786,20 @@ needed. Whether succeeded. + line="5215">Whether succeeded. an #ECalMetaBackend + line="5193">an #ECalMetaBackend a component UID + line="5194">a component UID allow-none="1"> optional extra data stored with the component, or %NULL + line="5195">optional extra data stored with the component, or %NULL transfer-ownership="full"> a loaded component, as #ICalComponent + line="5196">a loaded component, as #ICalComponent transfer-ownership="full"> an extra data to store to #ECalCache with this component + line="5197">an extra data to store to #ECalCache with this component allow-none="1"> optional #GCancellable object, or %NULL + line="5198">optional #GCancellable object, or %NULL @@ -10610,7 +10845,7 @@ needed. version="3.26"> Merges all the instances provided in @instances list into one VCALENDAR + line="4093">Merges all the instances provided in @instances list into one VCALENDAR object, which would eventually contain also all the used timezones. The @instances list should contain the master object and eventually all the detached instances for one component (they all have the same UID). @@ -10622,7 +10857,7 @@ location, which will not influence the timezone itself. an #ICalComponent containing a VCALENDAR + line="4107">an #ICalComponent containing a VCALENDAR component which consists of all the given instances. Free the returned pointer with g_object_unref(), when no longer needed. @@ -10633,13 +10868,13 @@ See: e_cal_meta_backend_save_component_sync() an #ECalMetaBackend + line="4095">an #ECalMetaBackend component instances to merge + line="4096">component instances to merge @@ -10648,7 +10883,7 @@ See: e_cal_meta_backend_save_component_sync() transfer-ownership="none"> whether to replace TZID-s with locations + line="4097">whether to replace TZID-s with locations @@ -10659,7 +10894,7 @@ See: e_cal_meta_backend_save_component_sync() throws="1"> Processes given changes by updating local cache content accordingly. + line="4797">Processes given changes by updating local cache content accordingly. The @meta_backend processes the changes like being online and particularly requires to be online to load created and modified objects when needed. Whether succeeded. + line="4813">Whether succeeded. an #ECalMetaBackend + line="4799">an #ECalMetaBackend allow-none="1"> + line="4800"> a #GSList of #ECalMetaBackendInfo object infos which had been created @@ -10695,7 +10930,7 @@ requires to be online to load created and modified objects when needed. allow-none="1"> + line="4802"> a #GSList of #ECalMetaBackendInfo object infos which had been modified @@ -10707,7 +10942,7 @@ requires to be online to load created and modified objects when needed. allow-none="1"> + line="4804"> a #GSList of #ECalMetaBackendInfo object infos which had been removed @@ -10719,7 +10954,7 @@ requires to be online to load created and modified objects when needed. allow-none="1"> optional #GCancellable object, or %NULL + line="4806">optional #GCancellable object, or %NULL @@ -10732,7 +10967,7 @@ requires to be online to load created and modified objects when needed. Referenced #ECalCache, which is used by @meta_backend. + line="3947">Referenced #ECalCache, which is used by @meta_backend. Unref it with g_object_unref() when no longer needed. @@ -10740,7 +10975,7 @@ requires to be online to load created and modified objects when needed. an #ECalMetaBackend + line="3945">an #ECalMetaBackend @@ -10751,21 +10986,21 @@ requires to be online to load created and modified objects when needed. throws="1"> Refreshes the @meta_backend immediately. To just schedule refresh + line="4522">Refreshes the @meta_backend immediately. To just schedule refresh operation call e_cal_meta_backend_schedule_refresh(). Whether succeeded. + line="4531">Whether succeeded. an #ECalMetaBackend + line="4524">an #ECalMetaBackend allow-none="1"> optional #GCancellable object, or %NULL + line="4525">optional #GCancellable object, or %NULL @@ -10785,7 +11020,7 @@ operation call e_cal_meta_backend_schedule_refresh(). throws="1"> Removes a component from the remote side, with all its detached instances. + line="5374">Removes a component from the remote side, with all its detached instances. The @object is not %NULL when it's removing locally deleted object in offline mode. Being it %NULL, the descendant can obtain the object from the #ECalCache. @@ -10796,27 +11031,27 @@ It is mandatory to implement this virtual method by the writable descendant. Whether succeeded. + line="5392">Whether succeeded. an #ECalMetaBackend + line="5376">an #ECalMetaBackend an #EConflictResolution to use + line="5377">an #EConflictResolution to use a component UID + line="5378">a component UID extra data being saved with the component in the local cache, or %NULL + line="5379">extra data being saved with the component in the local cache, or %NULL corresponding iCalendar object, as stored in the local cache, or %NULL + line="5380">corresponding iCalendar object, as stored in the local cache, or %NULL bit-or of #ECalOperationFlags + line="5381">bit-or of #ECalOperationFlags optional #GCancellable object, or %NULL + line="5382">optional #GCancellable object, or %NULL @@ -10859,7 +11094,7 @@ It is mandatory to implement this virtual method by the writable descendant. Determines, whether current source content requires reconnect of the backend. + line="5530">Determines, whether current source content requires reconnect of the backend. It is optional to implement this virtual method by the descendant. The default implementation compares %E_SOURCE_EXTENSION_AUTHENTICATION and @@ -10872,14 +11107,14 @@ no successful connect done yet. %TRUE, when reconnect is required, %FALSE otherwise. + line="5543">%TRUE, when reconnect is required, %FALSE otherwise. an #ECalMetaBackend + line="5532">an #ECalMetaBackend @@ -10890,7 +11125,7 @@ no successful connect done yet. throws="1"> Saves one component into the remote side. The @instances contain the master + line="5265">Saves one component into the remote side. The @instances contain the master object and all the detached instances of the same component (all have the same UID). When the @overwrite_existing is %TRUE, then the descendant can overwrite an object with the same UID on the remote side (usually used for modify). The @conflict_resolution @@ -10924,33 +11159,33 @@ It is mandatory to implement this virtual method by the writable descendant. Whether succeeded. + line="5308">Whether succeeded. an #ECalMetaBackend + line="5267">an #ECalMetaBackend %TRUE when can overwrite existing components, %FALSE otherwise + line="5268">%TRUE when can overwrite existing components, %FALSE otherwise one of #EConflictResolution, what to do on conflicts + line="5269">one of #EConflictResolution, what to do on conflicts instances of the component to save + line="5270">instances of the component to save @@ -10961,13 +11196,13 @@ It is mandatory to implement this virtual method by the writable descendant. extra data saved with the components in an #ECalCache + line="5271">extra data saved with the components in an #ECalCache bit-or of #ECalOperationFlags + line="5272">bit-or of #ECalOperationFlags return location for the UID of the saved component + line="5273">return location for the UID of the saved component return location for the extra data to store with the component + line="5274">return location for the extra data to store with the component optional #GCancellable object, or %NULL + line="5275">optional #GCancellable object, or %NULL @@ -11004,7 +11239,7 @@ It is mandatory to implement this virtual method by the writable descendant. Schedules refresh of the content of the @meta_backend. If there's any + line="4484">Schedules refresh of the content of the @meta_backend. If there's any already scheduled, then the function does nothing. Use e_cal_meta_backend_refresh_sync() to refresh the @meta_backend @@ -11018,7 +11253,7 @@ immediately. an #ECalMetaBackend + line="4486">an #ECalMetaBackend @@ -11029,7 +11264,7 @@ immediately. throws="1"> Searches @meta_backend with given expression @expr and returns + line="5487">Searches @meta_backend with given expression @expr and returns found components as a #GSList of #ECalComponent @out_components. Free the returned @out_components with g_slist_free_full (components, g_object_unref); when no longer needed. @@ -11045,14 +11280,14 @@ ensure it. Whether succeeded. + line="5507">Whether succeeded. an #ECalMetaBackend + line="5489">an #ECalMetaBackend allow-none="1"> a search expression, or %NULL + line="5490">a search expression, or %NULL transfer-ownership="full"> return location for the found #ECalComponent-s + line="5491">return location for the found #ECalComponent-s @@ -11081,7 +11316,7 @@ ensure it. allow-none="1"> optional #GCancellable object, or %NULL + line="5492">optional #GCancellable object, or %NULL @@ -11092,7 +11327,7 @@ ensure it. throws="1"> Searches @meta_backend with given expression @expr and returns + line="5444">Searches @meta_backend with given expression @expr and returns found components as a #GSList of iCal strings @out_icalstrings. Free the returned @out_icalstrings with g_slist_free_full (icalstrings, g_free); when no longer needed. @@ -11108,14 +11343,14 @@ ensure it. Whether succeeded. + line="5464">Whether succeeded. an #ECalMetaBackend + line="5446">an #ECalMetaBackend allow-none="1"> a search expression, or %NULL + line="5447">a search expression, or %NULL transfer-ownership="full"> return location for the found components as iCal strings + line="5448">return location for the found components as iCal strings @@ -11144,7 +11379,7 @@ ensure it. allow-none="1"> optional #GCancellable object, or %NULL + line="5449">optional #GCancellable object, or %NULL @@ -11155,7 +11390,7 @@ ensure it. version="3.26"> Sets the @cache as the cache to be used by the @meta_backend. + line="3892">Sets the @cache as the cache to be used by the @meta_backend. By default, a cache.db in ECalBackend::cache-dir is created in the constructed method. This function can be used to override the default. @@ -11170,13 +11405,13 @@ Note the @meta_backend adds its own reference to the @cache. an #ECalMetaBackend + line="3894">an #ECalMetaBackend an #ECalCache to use + line="3895">an #ECalCache to use @@ -11186,7 +11421,7 @@ Note the @meta_backend adds its own reference to the @cache. version="3.26"> Sets whether the @meta_backend connected to a writable destination. + line="3733">Sets whether the @meta_backend connected to a writable destination. This value has meaning only if e_cal_meta_backend_get_ever_connected() is %TRUE. @@ -11201,13 +11436,13 @@ to set the backend writable or not also in the offline mode. an #ECalMetaBackend + line="3735">an #ECalMetaBackend value to set + line="3736">value to set @@ -11217,7 +11452,7 @@ to set the backend writable or not also in the offline mode. version="3.26"> Sets whether the @meta_backend ever made a successful connection + line="3671">Sets whether the @meta_backend ever made a successful connection to its destination. This is used by the @meta_backend itself, during the opening phase, @@ -11232,13 +11467,13 @@ eventually report settings error easily. an #ECalMetaBackend + line="3673">an #ECalMetaBackend value to set + line="3674">value to set @@ -11248,7 +11483,7 @@ eventually report settings error easily. version="3.50"> Sets the @sync_tag for the @meta_backend. + line="3834">Sets the @sync_tag for the @meta_backend. @@ -11258,7 +11493,7 @@ eventually report settings error easily. an #ECalMetaBackend + line="3836">an #ECalMetaBackend allow-none="1"> a sync tag to set, or %NULL to unset the old one + line="3837">a sync tag to set, or %NULL to unset the old one @@ -11278,7 +11513,7 @@ eventually report settings error easily. throws="1"> Splits @objects into created/modified/removed lists according to current local + line="4655">Splits @objects into created/modified/removed lists according to current local cache content. Only the @out_removed_objects can be %NULL, others cannot. The function modifies @objects by moving its 'data' to corresponding out lists and sets the @objects 'data' to %NULL. @@ -11293,14 +11528,14 @@ The caller is still responsible to free @objects as well. Whether succeeded. + line="4681">Whether succeeded. an #ECalMetaBackend + line="4657">an #ECalMetaBackend transfer-ownership="full"> + line="4658"> a #GSList of #ECalMetaBackendInfo object infos to split @@ -11321,7 +11556,7 @@ The caller is still responsible to free @objects as well. transfer-ownership="full"> + line="4660"> a #GSList of #ECalMetaBackendInfo object infos which had been created @@ -11333,7 +11568,7 @@ The caller is still responsible to free @objects as well. transfer-ownership="full"> + line="4662"> a #GSList of #ECalMetaBackendInfo object infos which had been modified @@ -11346,7 +11581,7 @@ The caller is still responsible to free @objects as well. nullable="1"> + line="4664"> a #GSList of #ECalMetaBackendInfo object infos which had been removed; it can be %NULL, to not gather list of removed object infos @@ -11359,7 +11594,7 @@ The caller is still responsible to free @objects as well. allow-none="1"> optional #GCancellable object, or %NULL + line="4667">optional #GCancellable object, or %NULL @@ -11370,7 +11605,7 @@ The caller is still responsible to free @objects as well. throws="1"> Changes all inline attachments to URL attachments in @component, which + line="4282">Changes all inline attachments to URL attachments in @component, which will point to a local file instead. The function expects FILENAME parameter to be set on the attachment as the file name of it. This is called automatically after e_cal_meta_backend_load_component_sync(). @@ -11381,20 +11616,20 @@ The reverse operation is e_cal_meta_backend_inline_local_attachments_sync(). Whether succeeded. + line="4296">Whether succeeded. an #ECalMetaBackend + line="4284">an #ECalMetaBackend an #ICalComponent to work with + line="4285">an #ICalComponent to work with optional #GCancellable object, or %NULL + line="4286">optional #GCancellable object, or %NULL @@ -11414,7 +11649,7 @@ The reverse operation is e_cal_meta_backend_inline_local_attachments_sync(). The #ECalCache being used for this meta backend. + line="3576">The #ECalCache being used for this meta backend. @@ -11431,7 +11666,7 @@ The reverse operation is e_cal_meta_backend_inline_local_attachments_sync(). This signal is emitted whenever the underlying backend #ESource + line="3602">This signal is emitted whenever the underlying backend #ESource changes. Unlike the #ESource's 'changed' signal this one is tight to the #ECalMetaBackend itself and is emitted from a dedicated thread, thus it doesn't block the main thread. @@ -11459,14 +11694,14 @@ a dedicated thread, thus it doesn't block the main thread. Whether succeeded. + line="4955">Whether succeeded. an #ECalMetaBackend + line="4920">an #ECalMetaBackend allow-none="1"> an #ENamedParameters with previously used credentials, or %NULL + line="4921">an #ENamedParameters with previously used credentials, or %NULL @@ -11485,7 +11720,7 @@ a dedicated thread, thus it doesn't block the main thread. transfer-ownership="full"> an #ESourceAuthenticationResult with an authentication result + line="4922">an #ESourceAuthenticationResult with an authentication result @@ -11495,7 +11730,7 @@ a dedicated thread, thus it doesn't block the main thread. transfer-ownership="full"> a PEM encoded certificate on failure, or %NULL + line="4923">a PEM encoded certificate on failure, or %NULL transfer-ownership="full"> a #GTlsCertificateFlags on failure, or 0 + line="4924">a #GTlsCertificateFlags on failure, or 0 @@ -11514,7 +11749,7 @@ a dedicated thread, thus it doesn't block the main thread. allow-none="1"> optional #GCancellable object, or %NULL + line="4925">optional #GCancellable object, or %NULL @@ -11527,14 +11762,14 @@ a dedicated thread, thus it doesn't block the main thread. Whether succeeded. + line="4992">Whether succeeded. an #ECalMetaBackend + line="4981">an #ECalMetaBackend allow-none="1"> optional #GCancellable object, or %NULL + line="4982">optional #GCancellable object, or %NULL @@ -11556,14 +11791,14 @@ a dedicated thread, thus it doesn't block the main thread. Whether succeeded. + line="5058">Whether succeeded. an #ECalMetaBackend + line="5014">an #ECalMetaBackend allow-none="1"> optional sync tag from the last check + line="5015">optional sync tag from the last check set to %TRUE when this is the repeated call + line="5016">set to %TRUE when this is the repeated call transfer-ownership="full"> new sync tag to store on success + line="5017">new sync tag to store on success transfer-ownership="full"> whether to repeat this call again; default is %FALSE + line="5018">whether to repeat this call again; default is %FALSE transfer-ownership="full"> + line="5019"> a #GSList of #ECalMetaBackendInfo object infos which had been created since the last check @@ -11618,7 +11853,7 @@ a dedicated thread, thus it doesn't block the main thread. transfer-ownership="full"> + line="5022"> a #GSList of #ECalMetaBackendInfo object infos which had been modified since the last check @@ -11631,7 +11866,7 @@ a dedicated thread, thus it doesn't block the main thread. transfer-ownership="full"> + line="5025"> a #GSList of #ECalMetaBackendInfo object infos which had been removed since the last check @@ -11644,7 +11879,7 @@ a dedicated thread, thus it doesn't block the main thread. allow-none="1"> optional #GCancellable object, or %NULL + line="5028">optional #GCancellable object, or %NULL @@ -11657,14 +11892,14 @@ a dedicated thread, thus it doesn't block the main thread. Whether succeeded. + line="5145">Whether succeeded. an #ECalMetaBackend + line="5125">an #ECalMetaBackend transfer-ownership="full"> optional return location for a new sync tag + line="5126">optional return location for a new sync tag transfer-ownership="full"> + line="5127"> a #GSList of #ECalMetaBackendInfo object infos which are stored on the remote side @@ -11694,7 +11929,7 @@ a dedicated thread, thus it doesn't block the main thread. allow-none="1"> optional #GCancellable object, or %NULL + line="5129">optional #GCancellable object, or %NULL @@ -11707,20 +11942,20 @@ a dedicated thread, thus it doesn't block the main thread. Whether succeeded. + line="5215">Whether succeeded. an #ECalMetaBackend + line="5193">an #ECalMetaBackend a component UID + line="5194">a component UID allow-none="1"> optional extra data stored with the component, or %NULL + line="5195">optional extra data stored with the component, or %NULL transfer-ownership="full"> a loaded component, as #ICalComponent + line="5196">a loaded component, as #ICalComponent transfer-ownership="full"> an extra data to store to #ECalCache with this component + line="5197">an extra data to store to #ECalCache with this component allow-none="1"> optional #GCancellable object, or %NULL + line="5198">optional #GCancellable object, or %NULL @@ -11769,33 +12004,33 @@ a dedicated thread, thus it doesn't block the main thread. Whether succeeded. + line="5308">Whether succeeded. an #ECalMetaBackend + line="5267">an #ECalMetaBackend %TRUE when can overwrite existing components, %FALSE otherwise + line="5268">%TRUE when can overwrite existing components, %FALSE otherwise one of #EConflictResolution, what to do on conflicts + line="5269">one of #EConflictResolution, what to do on conflicts instances of the component to save + line="5270">instances of the component to save @@ -11806,13 +12041,13 @@ a dedicated thread, thus it doesn't block the main thread. allow-none="1"> extra data saved with the components in an #ECalCache + line="5271">extra data saved with the components in an #ECalCache bit-or of #ECalOperationFlags + line="5272">bit-or of #ECalOperationFlags transfer-ownership="full"> return location for the UID of the saved component + line="5273">return location for the UID of the saved component transfer-ownership="full"> return location for the extra data to store with the component + line="5274">return location for the extra data to store with the component allow-none="1"> optional #GCancellable object, or %NULL + line="5275">optional #GCancellable object, or %NULL @@ -11852,27 +12087,27 @@ a dedicated thread, thus it doesn't block the main thread. Whether succeeded. + line="5392">Whether succeeded. an #ECalMetaBackend + line="5376">an #ECalMetaBackend an #EConflictResolution to use + line="5377">an #EConflictResolution to use a component UID + line="5378">a component UID allow-none="1"> extra data being saved with the component in the local cache, or %NULL + line="5379">extra data being saved with the component in the local cache, or %NULL allow-none="1"> corresponding iCalendar object, as stored in the local cache, or %NULL + line="5380">corresponding iCalendar object, as stored in the local cache, or %NULL bit-or of #ECalOperationFlags + line="5381">bit-or of #ECalOperationFlags allow-none="1"> optional #GCancellable object, or %NULL + line="5382">optional #GCancellable object, or %NULL @@ -11918,14 +12153,14 @@ a dedicated thread, thus it doesn't block the main thread. Whether succeeded. + line="5464">Whether succeeded. an #ECalMetaBackend + line="5446">an #ECalMetaBackend allow-none="1"> a search expression, or %NULL + line="5447">a search expression, or %NULL transfer-ownership="full"> return location for the found components as iCal strings + line="5448">return location for the found components as iCal strings @@ -11954,7 +12189,7 @@ a dedicated thread, thus it doesn't block the main thread. allow-none="1"> optional #GCancellable object, or %NULL + line="5449">optional #GCancellable object, or %NULL @@ -11967,14 +12202,14 @@ a dedicated thread, thus it doesn't block the main thread. Whether succeeded. + line="5507">Whether succeeded. an #ECalMetaBackend + line="5489">an #ECalMetaBackend allow-none="1"> a search expression, or %NULL + line="5490">a search expression, or %NULL transfer-ownership="full"> return location for the found #ECalComponent-s + line="5491">return location for the found #ECalComponent-s @@ -12003,7 +12238,7 @@ a dedicated thread, thus it doesn't block the main thread. allow-none="1"> optional #GCancellable object, or %NULL + line="5492">optional #GCancellable object, or %NULL @@ -12016,14 +12251,14 @@ a dedicated thread, thus it doesn't block the main thread. %TRUE, when reconnect is required, %FALSE otherwise. + line="5543">%TRUE, when reconnect is required, %FALSE otherwise. an #ECalMetaBackend + line="5532">an #ECalMetaBackend @@ -12050,7 +12285,7 @@ a dedicated thread, thus it doesn't block the main thread. %TRUE, when the SSL error details had been available and + line="5571">%TRUE, when the SSL error details had been available and the out parameters populated, %FALSE otherwise. @@ -12058,7 +12293,7 @@ a dedicated thread, thus it doesn't block the main thread. an #ECalMetaBackend + line="5563">an #ECalMetaBackend transfer-ownership="full"> SSL certificate encoded in PEM format + line="5564">SSL certificate encoded in PEM format transfer-ownership="full"> bit-or of #GTlsCertificateFlags claiming the certificate errors + line="5565">bit-or of #GTlsCertificateFlags claiming the certificate errors @@ -12217,6 +12452,66 @@ or e_cal_meta_backend_info_copy(). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -12320,7 +12615,7 @@ or e_cal_meta_backend_info_copy(). Creates a new #EDataCal and exports the Calendar D-Bus interface + line="2479">Creates a new #EDataCal and exports the Calendar D-Bus interface on @connection at @object_path. The #EDataCal handles incoming remote method invocations and forwards them to the @backend. If the Calendar interface fails to export, the function sets @error and returns %NULL. @@ -12329,26 +12624,26 @@ interface fails to export, the function sets @error and returns %NULL. an #EDataCal, or %NULL on error + line="2491">an #EDataCal, or %NULL on error an #ECalBackend + line="2481">an #ECalBackend a #GDBusConnection + line="2482">a #GDBusConnection object path for the D-Bus interface + line="2483">object path for the D-Bus interface @@ -12359,21 +12654,21 @@ interface fails to export, the function sets @error and returns %NULL. version="3.8"> Returns the #GDBusConnection on which the Calendar D-Bus interface + line="2533">Returns the #GDBusConnection on which the Calendar D-Bus interface is exported. the #GDBusConnection + line="2540">the #GDBusConnection an #EDataCal + line="2535">an #EDataCal @@ -12384,21 +12679,21 @@ is exported. version="3.8"> Returns the object path at which the Calendar D-Bus interface is + line="2552">Returns the object path at which the Calendar D-Bus interface is exported. the object path + line="2559">the object path an #EDataCal + line="2554">an #EDataCal @@ -12408,7 +12703,7 @@ exported. version="3.10"> Returns the #ECalBackend to which incoming remote method invocations + line="2511">Returns the #ECalBackend to which incoming remote method invocations are being forwarded. The returned #ECalBackend is referenced for thread-safety and should @@ -12418,14 +12713,14 @@ be unreferenced with g_object_unref() when finished with it. an #ECalBackend + line="2521">an #ECalBackend an #EDataCal + line="2513">an #EDataCal @@ -12435,7 +12730,7 @@ be unreferenced with g_object_unref() when finished with it. version="3.2"> Notifies client about certain property value change + line="2087">Notifies client about certain property value change @@ -12445,19 +12740,19 @@ be unreferenced with g_object_unref() when finished with it. an #EDataCal + line="2089">an #EDataCal property name + line="2090">property name new property value + line="2091">new property value @@ -12467,7 +12762,7 @@ be unreferenced with g_object_unref() when finished with it. version="3.2"> Emits an error message, thus the clients can be notified about it. + line="2028">Emits an error message, thus the clients can be notified about it. @@ -12477,13 +12772,13 @@ be unreferenced with g_object_unref() when finished with it. an #EDataCal + line="2030">an #EDataCal an error message to report + line="2031">an error message to report @@ -12493,7 +12788,7 @@ be unreferenced with g_object_unref() when finished with it. version="3.2"> Reports result of a free/busy query on the @cal. + line="2053">Reports result of a free/busy query on the @cal. @@ -12503,13 +12798,13 @@ be unreferenced with g_object_unref() when finished with it. an #EDataCal + line="2055">an #EDataCal a #GSList of free/busy components encoded as string + line="2056">a #GSList of free/busy components encoded as string @@ -12521,7 +12816,7 @@ be unreferenced with g_object_unref() when finished with it. version="3.2"> Notifies listeners of the completion of the add_timezone method call. + line="1990">Notifies listeners of the completion of the add_timezone method call. @@ -12531,19 +12826,22 @@ be unreferenced with g_object_unref() when finished with it. A calendar client interface. + line="1992">A calendar client interface. associated operation id + line="1993">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1994">Operation error, if any, automatically freed if passed it. @@ -12553,7 +12851,7 @@ be unreferenced with g_object_unref() when finished with it. version="3.6"> Notifies listeners of the completion of the create_objects method call. + line="1567">Notifies listeners of the completion of the create_objects method call. @@ -12563,25 +12861,28 @@ be unreferenced with g_object_unref() when finished with it. A calendar client interface. + line="1569">A calendar client interface. associated operation id + line="1570">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1571">Operation error, if any, automatically freed if passed it. UIDs of the objects created. + line="1572">UIDs of the objects created. @@ -12589,7 +12890,7 @@ be unreferenced with g_object_unref() when finished with it. The newly created #ECalComponent objects. + line="1573">The newly created #ECalComponent objects. @@ -12601,7 +12902,7 @@ be unreferenced with g_object_unref() when finished with it. version="3.2"> Notifies listeners of the completion of the discard_alarm method call. + line="1911">Notifies listeners of the completion of the discard_alarm method call. @@ -12611,19 +12912,22 @@ be unreferenced with g_object_unref() when finished with it. A calendar client interface. + line="1913">A calendar client interface. associated operation id + line="1914">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1915">Operation error, if any, automatically freed if passed it. @@ -12633,7 +12937,7 @@ be unreferenced with g_object_unref() when finished with it. version="3.2"> Notifies listeners of the completion of the get_attachment_uris method call. + line="1861">Notifies listeners of the completion of the get_attachment_uris method call. @@ -12643,25 +12947,28 @@ be unreferenced with g_object_unref() when finished with it. A calendar client interface. + line="1863">A calendar client interface. associated operation id + line="1864">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1865">Operation error, if any, automatically freed if passed it. List of retrieved attachment uri's. + line="1866">List of retrieved attachment uri's. @@ -12673,7 +12980,7 @@ be unreferenced with g_object_unref() when finished with it. version="3.2"> Notifies listeners of the completion of the get_free_busy method call. + line="1513">Notifies listeners of the completion of the get_free_busy method call. To pass actual free/busy objects to the client asynchronously use e_data_cal_report_free_busy_data(), but the @freebusy should contain all the objects being used in e_data_cal_report_free_busy_data(). @@ -12686,25 +12993,28 @@ all the objects being used in e_data_cal_report_free_busy_data(). A calendar client interface. + line="1515">A calendar client interface. associated operation id + line="1516">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1517">Operation error, if any, automatically freed if passed it. a #GSList of iCalendar strings with all gathered free/busy components. + line="1518">a #GSList of iCalendar strings with all gathered free/busy components. @@ -12716,7 +13026,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). version="3.2"> Notifies listeners of the completion of the get_object method call. + line="1412">Notifies listeners of the completion of the get_object method call. @@ -12726,25 +13036,28 @@ all the objects being used in e_data_cal_report_free_busy_data(). A calendar client interface. + line="1414">A calendar client interface. associated operation id + line="1415">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1416">Operation error, if any, automatically freed if passed it. The object retrieved as an iCalendar string. + line="1417">The object retrieved as an iCalendar string. @@ -12754,7 +13067,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). version="3.2"> Notifies listeners of the completion of the get_object_list method call. + line="1461">Notifies listeners of the completion of the get_object_list method call. @@ -12764,25 +13077,28 @@ all the objects being used in e_data_cal_report_free_busy_data(). A calendar client interface. + line="1463">A calendar client interface. associated operation id + line="1464">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1465">Operation error, if any, automatically freed if passed it. List of retrieved objects. + line="1466">List of retrieved objects. @@ -12794,7 +13110,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). version="3.2"> Notifies listeners of the completion of the get_timezone method call. + line="1949">Notifies listeners of the completion of the get_timezone method call. @@ -12804,25 +13120,28 @@ all the objects being used in e_data_cal_report_free_busy_data(). A calendar client interface. + line="1951">A calendar client interface. associated operation id + line="1952">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1953">Operation error, if any, automatically freed if passed it. The requested timezone as an iCalendar string. + line="1954">The requested timezone as an iCalendar string. @@ -12832,7 +13151,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). version="3.6"> Notifies listeners of the completion of the modify_objects method call. + line="1627">Notifies listeners of the completion of the modify_objects method call. @@ -12842,25 +13161,28 @@ all the objects being used in e_data_cal_report_free_busy_data(). A calendar client interface. + line="1629">A calendar client interface. associated operation id + line="1630">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1631">Operation error, if any, automatically freed if passed it. The old #ECalComponent(s). + line="1632">The old #ECalComponent(s). @@ -12868,7 +13190,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). The new #ECalComponent(s). + line="1633">The new #ECalComponent(s). @@ -12880,7 +13202,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). version="3.2"> Notifies listeners of the completion of the open method call. + line="1336">Notifies listeners of the completion of the open method call. @@ -12890,19 +13212,22 @@ all the objects being used in e_data_cal_report_free_busy_data(). A calendar client interface. + line="1338">A calendar client interface. associated operation id + line="1339">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1340">Operation error, if any, automatically freed if passed it. @@ -12912,7 +13237,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). version="3.2"> Notifies listeners of the completion of the receive_objects method call. + line="1769">Notifies listeners of the completion of the receive_objects method call. @@ -12922,19 +13247,22 @@ all the objects being used in e_data_cal_report_free_busy_data(). A calendar client interface. + line="1771">A calendar client interface. associated operation id + line="1772">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1773">Operation error, if any, automatically freed if passed it. @@ -12944,7 +13272,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). version="3.2"> Notifies listeners of the completion of the refresh method call. + line="1374">Notifies listeners of the completion of the refresh method call. @@ -12954,19 +13282,22 @@ all the objects being used in e_data_cal_report_free_busy_data(). A calendar client interface. + line="1376">A calendar client interface. associated operation id + line="1377">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1378">Operation error, if any, automatically freed if passed it. @@ -12976,7 +13307,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). version="3.6"> Notifies listeners of the completion of the remove_objects method call. + line="1691">Notifies listeners of the completion of the remove_objects method call. @@ -12986,25 +13317,28 @@ all the objects being used in e_data_cal_report_free_busy_data(). A calendar client interface. + line="1693">A calendar client interface. associated operation id + line="1694">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1695">Operation error, if any, automatically freed if passed it. IDs of the removed objects. + line="1696">IDs of the removed objects. @@ -13012,7 +13346,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). The old #ECalComponent(s). + line="1697">The old #ECalComponent(s). @@ -13020,7 +13354,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). The new #ECalComponent(s). + line="1698">The new #ECalComponent(s). They will not be NULL only when removing instances of recurring appointments. @@ -13033,7 +13367,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). version="3.2"> Notifies listeners of the completion of the send_objects method call. + line="1807">Notifies listeners of the completion of the send_objects method call. @@ -13043,25 +13377,28 @@ all the objects being used in e_data_cal_report_free_busy_data(). A calendar client interface. + line="1809">A calendar client interface. associated operation id + line="1810">associated operation id - + Operation error, if any, automatically freed if passed it. + line="1811">Operation error, if any, automatically freed if passed it. List of users. + line="1812">List of users. @@ -13069,7 +13406,7 @@ all the objects being used in e_data_cal_report_free_busy_data(). An iCalendar string representing the object sent. + line="1813">An iCalendar string representing the object sent. @@ -13491,7 +13828,7 @@ if there are changes in the objects matching the view search expression. version="3.2"> Notifies all view listeners of the completion of the view, including a + line="1429">Notifies all view listeners of the completion of the view, including a status code. @@ -13502,13 +13839,13 @@ status code. an #EDataCalView + line="1431">an #EDataCalView View completion error, if any. + line="1432">View completion error, if any. @@ -13609,7 +13946,7 @@ information from iCalendar strings sent over the bus. version="3.4"> Notifies all view listeners of the modification of @component. + line="1328">Notifies all view listeners of the modification of @component. Uses the #EDataCalView's fields-of-interest to filter out unwanted information from iCalendar strings sent over the bus. @@ -13622,13 +13959,13 @@ information from iCalendar strings sent over the bus. an #EDataCalView + line="1330">an #EDataCalView The modified #ECalComponent. + line="1331">The modified #ECalComponent. @@ -13637,7 +13974,7 @@ information from iCalendar strings sent over the bus. c:identifier="e_data_cal_view_notify_objects_removed"> Notifies all view listener of the removal of a list of objects. + line="1353">Notifies all view listener of the removal of a list of objects. @@ -13647,13 +13984,13 @@ information from iCalendar strings sent over the bus. an #EDataCalView + line="1355">an #EDataCalView List of IDs for the objects that have been removed. + line="1356">List of IDs for the objects that have been removed. @@ -13664,7 +14001,7 @@ information from iCalendar strings sent over the bus. c:identifier="e_data_cal_view_notify_objects_removed_1"> Notifies all view listener of the removal of a single object. + line="1382">Notifies all view listener of the removal of a single object. @@ -13674,13 +14011,13 @@ information from iCalendar strings sent over the bus. an #EDataCalView + line="1384">an #EDataCalView ID of the removed object. + line="1385">ID of the removed object. @@ -13689,7 +14026,7 @@ information from iCalendar strings sent over the bus. c:identifier="e_data_cal_view_notify_progress"> Notifies all view listeners of progress messages. + line="1402">Notifies all view listeners of progress messages. @@ -13699,19 +14036,19 @@ information from iCalendar strings sent over the bus. an #EDataCalView + line="1404">an #EDataCalView Percentage completed. + line="1405">Percentage completed. Progress message to send to listeners. + line="1406">Progress message to send to listeners. @@ -14174,13 +14511,13 @@ functions below. start of the interval - + end of the interval - + start of the interval - + end of the interval - + @@ -14445,6 +14782,19 @@ or e_cal_meta_backend_info_copy(). + + + + + + + + + + + version="3.6"> #EAsyncClosure provides a simple way to run an asynchronous function + line="1703">#EAsyncClosure provides a simple way to run an asynchronous function synchronously without blocking a running #GMainLoop or using threads. 1) Create an #EAsyncClosure with e_async_closure_new(). @@ -52,7 +52,7 @@ synchronously without blocking a running #GMainLoop or using threads. introspectable="0"> Frees the @closure and the resources it holds. + line="1844">Frees the @closure and the resources it holds. @@ -62,7 +62,7 @@ synchronously without blocking a running #GMainLoop or using threads. an #EAsyncClosure + line="1846">an #EAsyncClosure @@ -73,7 +73,7 @@ synchronously without blocking a running #GMainLoop or using threads. introspectable="0"> Call this function immediately after starting an asynchronous operation. + line="1804">Call this function immediately after starting an asynchronous operation. The function waits for the asynchronous operation to complete and returns its #GAsyncResult to be passed to the operation's "finish" function. @@ -84,14 +84,14 @@ easily string together multiple asynchronous operations. a #GAsyncResult which is owned by the closure + line="1815">a #GAsyncResult which is owned by the closure an #EAsyncClosure + line="1806">an #EAsyncClosure @@ -102,7 +102,7 @@ easily string together multiple asynchronous operations. introspectable="0"> Pass this function as the #GAsyncReadyCallback argument of an asynchronous + line="1871">Pass this function as the #GAsyncReadyCallback argument of an asynchronous function, and the #EAsyncClosure as the data argument. This causes e_async_closure_wait() to terminate and return @result. @@ -118,14 +118,14 @@ This causes e_async_closure_wait() to terminate and return @result. allow-none="1"> a #GObject or %NULL, it is not used by the function + line="1873">a #GObject or %NULL, it is not used by the function at all a #GAsyncResult + line="1875">a #GAsyncResult allow-none="1"> an #EAsyncClosure + line="1876">an #EAsyncClosure @@ -145,13 +145,13 @@ This causes e_async_closure_wait() to terminate and return @result. introspectable="0"> Creates a new #EAsyncClosure for use with asynchronous functions. + line="1736">Creates a new #EAsyncClosure for use with asynchronous functions. a new #EAsyncClosure + line="1741">a new #EAsyncClosure @@ -161,14 +161,14 @@ This causes e_async_closure_wait() to terminate and return @result. introspectable="0"> Creates a new #EAsyncClosure for use with asynchronous functions + line="1758">Creates a new #EAsyncClosure for use with asynchronous functions using the @context as the main context. a new #EAsyncClosure + line="1765">a new #EAsyncClosure @@ -178,7 +178,7 @@ using the @context as the main context. allow-none="1"> a #GMainContext to use, or %NULL to use the default context + line="1760">a #GMainContext to use, or %NULL to use the default context @@ -419,13 +419,13 @@ is used a printf() format to create a custom message for the error. deprecated-version="3.8"> Copies a #GSList of #GObject<!-- -->s to the end of @copy_to. + line="2144">Copies a #GSList of #GObject<!-- -->s to the end of @copy_to. Use e_util_copy_object_slist() instead. New head of @copy_to. + line="2151">New head of @copy_to. The returned pointer can be freed with e_client_util_free_object_slist(). @@ -438,7 +438,7 @@ The returned pointer can be freed with e_client_util_free_object_slist(). allow-none="1"> Where to copy; may be %NULL + line="2146">Where to copy; may be %NULL @@ -446,7 +446,7 @@ The returned pointer can be freed with e_client_util_free_object_slist(). #GSList of #GObject<!-- -->s to be copied + line="2147">#GSList of #GObject<!-- -->s to be copied @@ -460,13 +460,13 @@ The returned pointer can be freed with e_client_util_free_object_slist(). deprecated-version="3.8"> Copies the #GSList of strings to the end of @copy_to. + line="2123">Copies the #GSList of strings to the end of @copy_to. Use e_util_copy_string_slist() instead. New head of @copy_to. + line="2130">New head of @copy_to. The returned pointer can be freed with e_client_util_free_string_slist(). @@ -479,7 +479,7 @@ The returned pointer can be freed with e_client_util_free_string_slist(). allow-none="1"> Where to copy; may be %NULL + line="2125">Where to copy; may be %NULL @@ -487,7 +487,7 @@ The returned pointer can be freed with e_client_util_free_string_slist(). #GSList of strings to be copied + line="2126">#GSList of strings to be copied @@ -501,7 +501,7 @@ The returned pointer can be freed with e_client_util_free_string_slist(). deprecated-version="3.8"> Calls g_object_unref() on each member of @objects and then frees @objects + line="2181">Calls g_object_unref() on each member of @objects and then frees @objects itself. Use g_slist_free_full() instead. @@ -512,7 +512,7 @@ itself. a #GSList of #GObject<!-- -->s + line="2183">a #GSList of #GObject<!-- -->s @@ -526,7 +526,7 @@ itself. deprecated-version="3.8"> Frees memory previously allocated by e_client_util_strv_to_slist(). + line="2165">Frees memory previously allocated by e_client_util_strv_to_slist(). Use g_slist_free_full() instead. @@ -536,7 +536,7 @@ itself. a #GSList of strings (gchar *) + line="2167">a #GSList of strings (gchar *) @@ -548,12 +548,12 @@ itself. version="3.2"> Parses comma-separated list of values into #GSList. + line="2198">Parses comma-separated list of values into #GSList. Newly allocated #GSList of + line="2204">Newly allocated #GSList of newly allocated strings corresponding to values parsed from @strings. Free the returned pointer with e_client_util_free_string_slist(). @@ -564,7 +564,7 @@ Free the returned pointer with e_client_util_free_string_slist(). string of comma-separated values + line="2200">string of comma-separated values @@ -576,13 +576,13 @@ Free the returned pointer with e_client_util_free_string_slist(). deprecated-version="3.8"> Convert a list of strings into a %NULL-terminated array of strings. + line="2080">Convert a list of strings into a %NULL-terminated array of strings. Use e_util_slist_to_strv() instead. Newly allocated %NULL-terminated array of strings. + line="2086">Newly allocated %NULL-terminated array of strings. The returned pointer should be freed with g_strfreev(). Note: Paired function for this is e_client_util_strv_to_slist(). @@ -594,7 +594,7 @@ Note: Paired function for this is e_client_util_strv_to_slist(). a #GSList of strings (const gchar *) + line="2082">a #GSList of strings (const gchar *) @@ -608,13 +608,13 @@ Note: Paired function for this is e_client_util_strv_to_slist(). deprecated-version="3.8"> Convert a %NULL-terminated array of strings to a list of strings. + line="2101">Convert a %NULL-terminated array of strings to a list of strings. Use e_util_strv_to_slist() instead. Newly allocated #GSList of + line="2107">Newly allocated #GSList of newly allocated strings. The returned pointer should be freed with e_client_util_free_string_slist(). @@ -627,7 +627,7 @@ Note: Paired function for this is e_client_util_slist_to_strv(). a %NULL-terminated array of strings (const gchar *) + line="2103">a %NULL-terminated array of strings (const gchar *) @@ -639,7 +639,7 @@ Note: Paired function for this is e_client_util_slist_to_strv(). deprecated-version="3.8"> The function takes a @dbus_error and tries to find a match in @known_errors + line="2269">The function takes a @dbus_error and tries to find a match in @known_errors for it, if it is a G_IO_ERROR, G_IO_ERROR_DBUS_ERROR. If it is anything else then the @dbus_error is moved to @client_error. @@ -654,7 +654,7 @@ matches. Whether was @dbus_error processed into @client_error. + line="2289">Whether was @dbus_error processed into @client_error. Note: The @dbus_error is automatically freed if returned %TRUE. @@ -663,7 +663,7 @@ Note: The @dbus_error is automatically freed if returned %TRUE. DBus #GError to unwrap + line="2271">DBus #GError to unwrap transfer-ownership="full"> Resulting #GError; can be %NULL + line="2272">Resulting #GError; can be %NULL List of known errors against which try to match + line="2273">List of known errors against which try to match How many items are stored in @known_errors + line="2274">How many items are stored in @known_errors Error domain for @known_errors + line="2275">Error domain for @known_errors Whether to fail when none of @known_errors matches + line="2276">Whether to fail when none of @known_errors matches @@ -745,10 +745,12 @@ Note: The @dbus_error is automatically freed if returned %TRUE. + version="3.2" + glib:finish-func="get_backend_property_finish" + glib:sync-func="get_backend_property_sync"> Queries @client's backend for a property of name @prop_name. + line="1294">Queries @client's backend for a property of name @prop_name. The call is finished by e_client_get_backend_property_finish() from the @callback. @@ -759,13 +761,13 @@ from the @callback. an #EClient + line="1296">an #EClient property name, whose value to retrieve; cannot be %NULL + line="1297">property name, whose value to retrieve; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1298">a #GCancellable; can be %NULL closure="3"> callback to call when a result is ready + line="1299">callback to call when a result is ready closure="3"> user data for the @callback + line="1300">user data for the @callback @@ -806,25 +808,25 @@ from the @callback. throws="1"> Finishes previous call of e_client_get_backend_property(). + line="1329">Finishes previous call of e_client_get_backend_property(). %TRUE if successful, %FALSE otherwise. + line="1338">%TRUE if successful, %FALSE otherwise. an #EClient + line="1331">an #EClient a #GAsyncResult + line="1332">a #GAsyncResult transfer-ownership="full"> Retrieved backend property value; cannot be %NULL + line="1333">Retrieved backend property value; cannot be %NULL @@ -841,28 +843,29 @@ from the @callback. + throws="1" + glib:async-func="get_backend_property"> Queries @client's backend for a property of name @prop_name. + line="1361">Queries @client's backend for a property of name @prop_name. %TRUE if successful, %FALSE otherwise. + line="1371">%TRUE if successful, %FALSE otherwise. an #EClient + line="1363">an #EClient property name, whose value to retrieve; cannot be %NULL + line="1364">property name, whose value to retrieve; cannot be %NULL transfer-ownership="full"> Retrieved backend property value; cannot be %NULL + line="1365">Retrieved backend property value; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1366">a #GCancellable; can be %NULL @@ -900,10 +903,12 @@ from the @callback. invoker="open" version="3.2" deprecated="1" - deprecated-version="3.8"> + deprecated-version="3.8" + glib:finish-func="open_finish" + glib:sync-func="open_sync"> Opens the @client, making it ready for queries and other operations. + line="1508">Opens the @client, making it ready for queries and other operations. The call is finished by e_client_open_finish() from the @callback. Use e_book_client_connect() and e_book_client_connect_finish() or @@ -917,13 +922,13 @@ The call is finished by e_client_open_finish() from the @callback. an #EClient + line="1510">an #EClient this parameter is not used anymore + line="1511">this parameter is not used anymore allow-none="1"> a #GCancellable; can be %NULL + line="1512">a #GCancellable; can be %NULL closure="3"> callback to call when a result is ready + line="1513">callback to call when a result is ready closure="3"> user data for the @callback + line="1514">user data for the @callback @@ -966,7 +971,7 @@ The call is finished by e_client_open_finish() from the @callback. throws="1"> Finishes previous call of e_client_open(). + line="1545">Finishes previous call of e_client_open(). Use e_book_client_connect() and e_book_client_connect_finish() or e_cal_client_connect() and @@ -975,20 +980,20 @@ The call is finished by e_client_open_finish() from the @callback. %TRUE if successful, %FALSE otherwise. + line="1553">%TRUE if successful, %FALSE otherwise. an #EClient + line="1547">an #EClient a #GAsyncResult + line="1548">a #GAsyncResult @@ -998,30 +1003,31 @@ The call is finished by e_client_open_finish() from the @callback. version="3.2" deprecated="1" deprecated-version="3.8" - throws="1"> + throws="1" + glib:async-func="open"> Opens the @client, making it ready for queries and other operations. + line="1578">Opens the @client, making it ready for queries and other operations. Use e_book_client_connect_sync() or e_cal_client_connect_sync() instead. %TRUE if successful, %FALSE otherwise. + line="1587">%TRUE if successful, %FALSE otherwise. an #EClient + line="1580">an #EClient this parameter is not used anymore + line="1581">this parameter is not used anymore allow-none="1"> a #GCancellable; can be %NULL + line="1582">a #GCancellable; can be %NULL @@ -1049,10 +1055,14 @@ The call is finished by e_client_open_finish() from the @callback. - + Initiates refresh on the @client. Finishing the method doesn't mean + line="1701">Initiates refresh on the @client. Finishing the method doesn't mean that the refresh is done, backend only notifies whether it started refreshing or not. Use e_client_check_refresh_supported() to check whether the backend supports this method. @@ -1065,7 +1075,7 @@ The call is finished by e_client_refresh_finish() from the @callback. an #EClient + line="1703">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1704">a #GCancellable; can be %NULL closure="2"> callback to call when a result is ready + line="1705">callback to call when a result is ready closure="2"> user data for the @callback + line="1706">user data for the @callback @@ -1106,25 +1116,25 @@ The call is finished by e_client_refresh_finish() from the @callback. throws="1"> Finishes previous call of e_client_refresh(). + line="1734">Finishes previous call of e_client_refresh(). %TRUE if successful, %FALSE otherwise. + line="1742">%TRUE if successful, %FALSE otherwise. an #EClient + line="1736">an #EClient a #GAsyncResult + line="1737">a #GAsyncResult @@ -1132,10 +1142,11 @@ The call is finished by e_client_refresh_finish() from the @callback. + throws="1" + glib:async-func="refresh"> Initiates refresh on the @client. Finishing the method doesn't mean + line="1762">Initiates refresh on the @client. Finishing the method doesn't mean that the refresh is done, backend only notifies whether it started refreshing or not. Use e_client_check_refresh_supported() to check whether the backend supports this method. @@ -1143,14 +1154,14 @@ whether the backend supports this method. %TRUE if successful, %FALSE otherwise. + line="1773">%TRUE if successful, %FALSE otherwise. an #EClient + line="1764">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1765">a #GCancellable; can be %NULL @@ -1168,10 +1179,12 @@ whether the backend supports this method. invoker="remove" version="3.2" deprecated="1" - deprecated-version="3.6"> + deprecated-version="3.6" + glib:finish-func="remove_finish" + glib:sync-func="remove_sync"> Removes the backing data for this #EClient. For example, with the file + line="1609">Removes the backing data for this #EClient. For example, with the file backend this deletes the database file. You cannot get it back! The call is finished by e_client_remove_finish() from the @callback. Use e_source_remove() instead. @@ -1183,7 +1196,7 @@ The call is finished by e_client_remove_finish() from the @callback. an #EClient + line="1611">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1612">a #GCancellable; can be %NULL closure="2"> callback to call when a result is ready + line="1613">callback to call when a result is ready closure="2"> user data for the @callback + line="1614">user data for the @callback @@ -1226,26 +1239,26 @@ The call is finished by e_client_remove_finish() from the @callback. throws="1"> Finishes previous call of e_client_remove(). + line="1642">Finishes previous call of e_client_remove(). Use e_source_remove_finish() instead. %TRUE if successful, %FALSE otherwise. + line="1650">%TRUE if successful, %FALSE otherwise. an #EClient + line="1644">an #EClient a #GAsyncResult + line="1645">a #GAsyncResult @@ -1255,24 +1268,25 @@ The call is finished by e_client_remove_finish() from the @callback. version="3.2" deprecated="1" deprecated-version="3.6" - throws="1"> + throws="1" + glib:async-func="remove"> Removes the backing data for this #EClient. For example, with the file + line="1672">Removes the backing data for this #EClient. For example, with the file backend this deletes the database file. You cannot get it back! Use e_source_remove_sync() instead. %TRUE if successful, %FALSE otherwise. + line="1681">%TRUE if successful, %FALSE otherwise. an #EClient + line="1674">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1675">a #GCancellable; can be %NULL @@ -1290,10 +1304,12 @@ backend this deletes the database file. You cannot get it back! invoker="retrieve_capabilities" version="3.2" deprecated="1" - deprecated-version="3.8"> + deprecated-version="3.8" + glib:finish-func="retrieve_capabilities_finish" + glib:sync-func="retrieve_capabilities_sync"> Initiates retrieval of capabilities on the @client. This is usually + line="1172">Initiates retrieval of capabilities on the @client. This is usually required only once, after the @client is opened. The returned value is cached and any subsequent call of e_client_get_capabilities() and e_client_check_capability() is using the cached value. @@ -1308,7 +1324,7 @@ from the @callback. an #EClient + line="1174">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1175">a #GCancellable; can be %NULL closure="2"> callback to call when a result is ready + line="1176">callback to call when a result is ready closure="2"> user data for the @callback + line="1177">user data for the @callback @@ -1351,7 +1367,7 @@ from the @callback. throws="1"> Finishes previous call of e_client_retrieve_capabilities(). + line="1208">Finishes previous call of e_client_retrieve_capabilities(). Returned value of @capabilities should be freed with g_free(), when no longer needed. Use e_client_get_capabilities() instead. @@ -1359,20 +1375,20 @@ when no longer needed. %TRUE if successful, %FALSE otherwise. + line="1219">%TRUE if successful, %FALSE otherwise. an #EClient + line="1210">an #EClient a #GAsyncResult + line="1211">a #GAsyncResult transfer-ownership="full"> Comma-separated list of capabilities of the @client + line="1212">Comma-separated list of capabilities of the @client @@ -1391,10 +1407,11 @@ when no longer needed. version="3.2" deprecated="1" deprecated-version="3.8" - throws="1"> + throws="1" + glib:async-func="retrieve_capabilities"> Initiates retrieval of capabilities on the @client. This is usually + line="1250">Initiates retrieval of capabilities on the @client. This is usually required only once, after the @client is opened. The returned value is cached and any subsequent call of e_client_get_capabilities() and e_client_check_capability() is using the cached value. Returned value @@ -1404,14 +1421,14 @@ of @capabilities should be freed with g_free(), when no longer needed. %TRUE if successful, %FALSE otherwise. + line="1263">%TRUE if successful, %FALSE otherwise. an #EClient + line="1252">an #EClient transfer-ownership="full"> Comma-separated list of capabilities of the @client + line="1253">Comma-separated list of capabilities of the @client allow-none="1"> a #GCancellable; can be %NULL + line="1254">a #GCancellable; can be %NULL @@ -1440,7 +1457,7 @@ of @capabilities should be freed with g_free(), when no longer needed. throws="1"> Retrieves @client properties to match server-side values, without waiting + line="1969">Retrieves @client properties to match server-side values, without waiting for the D-Bus property change notifications delivery. If an error occurs, the function sets @error and returns %FALSE. @@ -1448,14 +1465,14 @@ If an error occurs, the function sets @error and returns %FALSE. %TRUE on success, %FALSE on error + line="1980">%TRUE on success, %FALSE on error an #EClient + line="1971">an #EClient allow-none="1"> optional #GCancellable object, or %NULL + line="1972">optional #GCancellable object, or %NULL @@ -1473,10 +1490,12 @@ If an error occurs, the function sets @error and returns %FALSE. invoker="set_backend_property" version="3.2" deprecated="1" - deprecated-version="3.8"> + deprecated-version="3.8" + glib:finish-func="set_backend_property_finish" + glib:sync-func="set_backend_property_sync"> Sets @client's backend property of name @prop_name + line="1396">Sets @client's backend property of name @prop_name to value @prop_value. The call is finished by e_client_set_backend_property_finish() from the @callback. Clients cannot set backend properties. Any attempt @@ -1489,19 +1508,19 @@ by e_client_set_backend_property_finish() from the @callback. an #EClient + line="1398">an #EClient property name, whose value to change; cannot be %NULL + line="1399">property name, whose value to change; cannot be %NULL property value, to set; cannot be %NULL + line="1400">property value, to set; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1401">a #GCancellable; can be %NULL closure="4"> callback to call when a result is ready + line="1402">callback to call when a result is ready closure="4"> user data for the @callback + line="1403">user data for the @callback @@ -1544,27 +1563,27 @@ by e_client_set_backend_property_finish() from the @callback. throws="1"> Finishes previous call of e_client_set_backend_property(). + line="1438">Finishes previous call of e_client_set_backend_property(). Clients cannot set backend properties. Any attempt will fail with an %E_CLIENT_ERROR_NOT_SUPPORTED error. %TRUE if successful, %FALSE otherwise. + line="1446">%TRUE if successful, %FALSE otherwise. an #EClient + line="1440">an #EClient a #GAsyncResult + line="1441">a #GAsyncResult @@ -1574,10 +1593,11 @@ by e_client_set_backend_property_finish() from the @callback. version="3.2" deprecated="1" deprecated-version="3.8" - throws="1"> + throws="1" + glib:async-func="set_backend_property"> Sets @client's backend property of name @prop_name + line="1469">Sets @client's backend property of name @prop_name to value @prop_value. Clients cannot set backend properties. Any attempt will fail with an %E_CLIENT_ERROR_NOT_SUPPORTED error. @@ -1585,26 +1605,26 @@ to value @prop_value. %TRUE if successful, %FALSE otherwise. + line="1480">%TRUE if successful, %FALSE otherwise. an #EClient + line="1471">an #EClient property name, whose value to change; cannot be %NULL + line="1472">property name, whose value to change; cannot be %NULL property value, to set; cannot be %NULL + line="1473">property value, to set; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1474">a #GCancellable; can be %NULL @@ -1626,7 +1646,7 @@ to value @prop_value. throws="1"> Unwraps D-Bus error to local error. @dbus_error is automatically freed. + line="2235">Unwraps D-Bus error to local error. @dbus_error is automatically freed. @dbus_erorr and @out_error can point to the same variable. Use g_dbus_error_strip_remote_error() instead. @@ -1637,13 +1657,13 @@ to value @prop_value. an #EClient + line="2237">an #EClient a #GError returned bu D-Bus + line="2238">a #GError returned bu D-Bus @@ -1655,7 +1675,7 @@ to value @prop_value. deprecated-version="3.8"> Cancels all pending operations started on @client. + line="1156">Cancels all pending operations started on @client. The function no longer does anything. @@ -1665,7 +1685,7 @@ to value @prop_value. an #EClient + line="1158">an #EClient @@ -1675,26 +1695,26 @@ to value @prop_value. version="3.2"> Check if backend supports particular capability. + line="978">Check if backend supports particular capability. To get all capabilities use e_client_get_capabilities(). #GSList of const strings of capabilities + line="986">#GSList of const strings of capabilities an #EClient + line="980">an #EClient a capability + line="981">a capability @@ -1704,20 +1724,20 @@ To get all capabilities use e_client_get_capabilities(). version="3.2"> Checks whether a client supports explicit refreshing + line="1017">Checks whether a client supports explicit refreshing (see e_client_refresh()). TRUE if the client supports refreshing, FALSE otherwise. + line="1024">TRUE if the client supports refreshing, FALSE otherwise. A client. + line="1019">A client. @@ -1727,13 +1747,13 @@ To get all capabilities use e_client_get_capabilities(). version="3.16"> Returns a D-Bus bus name that will be used to connect the + line="2364">Returns a D-Bus bus name that will be used to connect the client to the backend subprocess. a newly-allocated string representing a D-Bus bus + line="2371">a newly-allocated string representing a D-Bus bus name that will be used to connect the client to the backend subprocess. The string should be freed by the caller using g_free(). @@ -1743,17 +1763,19 @@ client to the backend subprocess. an #EClient + line="2366">an #EClient + version="3.2" + glib:finish-func="get_backend_property_finish" + glib:sync-func="get_backend_property_sync"> Queries @client's backend for a property of name @prop_name. + line="1294">Queries @client's backend for a property of name @prop_name. The call is finished by e_client_get_backend_property_finish() from the @callback. @@ -1764,13 +1786,13 @@ from the @callback. an #EClient + line="1296">an #EClient property name, whose value to retrieve; cannot be %NULL + line="1297">property name, whose value to retrieve; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1298">a #GCancellable; can be %NULL closure="3"> callback to call when a result is ready + line="1299">callback to call when a result is ready allow-none="1"> user data for the @callback + line="1300">user data for the @callback @@ -1810,25 +1832,25 @@ from the @callback. throws="1"> Finishes previous call of e_client_get_backend_property(). + line="1329">Finishes previous call of e_client_get_backend_property(). %TRUE if successful, %FALSE otherwise. + line="1338">%TRUE if successful, %FALSE otherwise. an #EClient + line="1331">an #EClient a #GAsyncResult + line="1332">a #GAsyncResult transfer-ownership="full"> Retrieved backend property value; cannot be %NULL + line="1333">Retrieved backend property value; cannot be %NULL @@ -1845,28 +1867,29 @@ from the @callback. + throws="1" + glib:async-func="get_backend_property"> Queries @client's backend for a property of name @prop_name. + line="1361">Queries @client's backend for a property of name @prop_name. %TRUE if successful, %FALSE otherwise. + line="1371">%TRUE if successful, %FALSE otherwise. an #EClient + line="1363">an #EClient property name, whose value to retrieve; cannot be %NULL + line="1364">property name, whose value to retrieve; cannot be %NULL transfer-ownership="full"> Retrieved backend property value; cannot be %NULL + line="1365">Retrieved backend property value; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1366">a #GCancellable; can be %NULL @@ -1895,14 +1918,14 @@ from the @callback. version="3.2"> Get list of strings with capabilities advertised by a backend. + line="933">Get list of strings with capabilities advertised by a backend. This list, together with inner strings, is owned by the @client. To check for individual capabilities use e_client_check_capability(). #GSList of const strings + line="941">#GSList of const strings of capabilities @@ -1912,7 +1935,7 @@ To check for individual capabilities use e_client_check_capability(). an #EClient + line="935">an #EClient @@ -1923,19 +1946,19 @@ To check for individual capabilities use e_client_check_capability(). version="3.2"> Get the #ESource that this client has assigned. + line="897">Get the #ESource that this client has assigned. The source. + line="903">The source. an #EClient + line="899">an #EClient @@ -1943,19 +1966,19 @@ To check for individual capabilities use e_client_check_capability(). Check if this @client is connected. + line="1091">Check if this @client is connected. %TRUE if this @client is connected, otherwise %FALSE. + line="1097">%TRUE if this @client is connected, otherwise %FALSE. an #EClient + line="1093">an #EClient @@ -1967,7 +1990,7 @@ To check for individual capabilities use e_client_check_capability(). deprecated-version="3.8"> Check if this @client is fully opened. This includes + line="1131">Check if this @client is fully opened. This includes everything from e_client_open() call up to the authentication, if required by a backend. Client cannot do any other operation during the opening phase except of authenticate or cancel it. @@ -1978,14 +2001,14 @@ Every other operation results in an %E_CLIENT_ERROR_BUSY error. always %TRUE + line="1141">always %TRUE an #EClient + line="1133">an #EClient @@ -1995,19 +2018,19 @@ Every other operation results in an %E_CLIENT_ERROR_BUSY error. version="3.2"> Check if this @client is read-only. + line="1054">Check if this @client is read-only. %TRUE if this @client is read-only, otherwise %FALSE. + line="1060">%TRUE if this @client is read-only, otherwise %FALSE. an #EClient + line="1056">an #EClient @@ -2016,10 +2039,12 @@ Every other operation results in an %E_CLIENT_ERROR_BUSY error. c:identifier="e_client_open" version="3.2" deprecated="1" - deprecated-version="3.8"> + deprecated-version="3.8" + glib:finish-func="open_finish" + glib:sync-func="open_sync"> Opens the @client, making it ready for queries and other operations. + line="1508">Opens the @client, making it ready for queries and other operations. The call is finished by e_client_open_finish() from the @callback. Use e_book_client_connect() and e_book_client_connect_finish() or @@ -2033,13 +2058,13 @@ The call is finished by e_client_open_finish() from the @callback. an #EClient + line="1510">an #EClient this parameter is not used anymore + line="1511">this parameter is not used anymore allow-none="1"> a #GCancellable; can be %NULL + line="1512">a #GCancellable; can be %NULL closure="3"> callback to call when a result is ready + line="1513">callback to call when a result is ready allow-none="1"> user data for the @callback + line="1514">user data for the @callback @@ -2081,7 +2106,7 @@ The call is finished by e_client_open_finish() from the @callback. throws="1"> Finishes previous call of e_client_open(). + line="1545">Finishes previous call of e_client_open(). Use e_book_client_connect() and e_book_client_connect_finish() or e_cal_client_connect() and @@ -2090,20 +2115,20 @@ The call is finished by e_client_open_finish() from the @callback. %TRUE if successful, %FALSE otherwise. + line="1553">%TRUE if successful, %FALSE otherwise. an #EClient + line="1547">an #EClient a #GAsyncResult + line="1548">a #GAsyncResult @@ -2113,30 +2138,31 @@ The call is finished by e_client_open_finish() from the @callback. version="3.2" deprecated="1" deprecated-version="3.8" - throws="1"> + throws="1" + glib:async-func="open"> Opens the @client, making it ready for queries and other operations. + line="1578">Opens the @client, making it ready for queries and other operations. Use e_book_client_connect_sync() or e_cal_client_connect_sync() instead. %TRUE if successful, %FALSE otherwise. + line="1587">%TRUE if successful, %FALSE otherwise. an #EClient + line="1580">an #EClient this parameter is not used anymore + line="1581">this parameter is not used anymore allow-none="1"> a #GCancellable; can be %NULL + line="1582">a #GCancellable; can be %NULL @@ -2155,7 +2181,7 @@ The call is finished by e_client_open_finish() from the @callback. version="3.8"> Returns the #GMainContext on which event sources for @client are to + line="956">Returns the #GMainContext on which event sources for @client are to be attached. The returned #GMainContext is referenced for thread-safety and must be @@ -2164,22 +2190,26 @@ unreferenced with g_main_context_unref() when finished with it. a #GMainContext + line="966">a #GMainContext an #EClient + line="958">an #EClient - + Initiates refresh on the @client. Finishing the method doesn't mean + line="1701">Initiates refresh on the @client. Finishing the method doesn't mean that the refresh is done, backend only notifies whether it started refreshing or not. Use e_client_check_refresh_supported() to check whether the backend supports this method. @@ -2192,7 +2222,7 @@ The call is finished by e_client_refresh_finish() from the @callback. an #EClient + line="1703">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1704">a #GCancellable; can be %NULL closure="2"> callback to call when a result is ready + line="1705">callback to call when a result is ready allow-none="1"> user data for the @callback + line="1706">user data for the @callback @@ -2232,25 +2262,25 @@ The call is finished by e_client_refresh_finish() from the @callback. throws="1"> Finishes previous call of e_client_refresh(). + line="1734">Finishes previous call of e_client_refresh(). %TRUE if successful, %FALSE otherwise. + line="1742">%TRUE if successful, %FALSE otherwise. an #EClient + line="1736">an #EClient a #GAsyncResult + line="1737">a #GAsyncResult @@ -2258,10 +2288,11 @@ The call is finished by e_client_refresh_finish() from the @callback. + throws="1" + glib:async-func="refresh"> Initiates refresh on the @client. Finishing the method doesn't mean + line="1762">Initiates refresh on the @client. Finishing the method doesn't mean that the refresh is done, backend only notifies whether it started refreshing or not. Use e_client_check_refresh_supported() to check whether the backend supports this method. @@ -2269,14 +2300,14 @@ whether the backend supports this method. %TRUE if successful, %FALSE otherwise. + line="1773">%TRUE if successful, %FALSE otherwise. an #EClient + line="1764">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1765">a #GCancellable; can be %NULL @@ -2294,10 +2325,12 @@ whether the backend supports this method. c:identifier="e_client_remove" version="3.2" deprecated="1" - deprecated-version="3.6"> + deprecated-version="3.6" + glib:finish-func="remove_finish" + glib:sync-func="remove_sync"> Removes the backing data for this #EClient. For example, with the file + line="1609">Removes the backing data for this #EClient. For example, with the file backend this deletes the database file. You cannot get it back! The call is finished by e_client_remove_finish() from the @callback. Use e_source_remove() instead. @@ -2309,7 +2342,7 @@ The call is finished by e_client_remove_finish() from the @callback. an #EClient + line="1611">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1612">a #GCancellable; can be %NULL closure="2"> callback to call when a result is ready + line="1613">callback to call when a result is ready allow-none="1"> user data for the @callback + line="1614">user data for the @callback @@ -2351,26 +2384,26 @@ The call is finished by e_client_remove_finish() from the @callback. throws="1"> Finishes previous call of e_client_remove(). + line="1642">Finishes previous call of e_client_remove(). Use e_source_remove_finish() instead. %TRUE if successful, %FALSE otherwise. + line="1650">%TRUE if successful, %FALSE otherwise. an #EClient + line="1644">an #EClient a #GAsyncResult + line="1645">a #GAsyncResult @@ -2380,24 +2413,25 @@ The call is finished by e_client_remove_finish() from the @callback. version="3.2" deprecated="1" deprecated-version="3.6" - throws="1"> + throws="1" + glib:async-func="remove"> Removes the backing data for this #EClient. For example, with the file + line="1672">Removes the backing data for this #EClient. For example, with the file backend this deletes the database file. You cannot get it back! Use e_source_remove_sync() instead. %TRUE if successful, %FALSE otherwise. + line="1681">%TRUE if successful, %FALSE otherwise. an #EClient + line="1674">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1675">a #GCancellable; can be %NULL @@ -2415,10 +2449,12 @@ backend this deletes the database file. You cannot get it back! c:identifier="e_client_retrieve_capabilities" version="3.2" deprecated="1" - deprecated-version="3.8"> + deprecated-version="3.8" + glib:finish-func="retrieve_capabilities_finish" + glib:sync-func="retrieve_capabilities_sync"> Initiates retrieval of capabilities on the @client. This is usually + line="1172">Initiates retrieval of capabilities on the @client. This is usually required only once, after the @client is opened. The returned value is cached and any subsequent call of e_client_get_capabilities() and e_client_check_capability() is using the cached value. @@ -2433,7 +2469,7 @@ from the @callback. an #EClient + line="1174">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1175">a #GCancellable; can be %NULL closure="2"> callback to call when a result is ready + line="1176">callback to call when a result is ready allow-none="1"> user data for the @callback + line="1177">user data for the @callback @@ -2475,7 +2511,7 @@ from the @callback. throws="1"> Finishes previous call of e_client_retrieve_capabilities(). + line="1208">Finishes previous call of e_client_retrieve_capabilities(). Returned value of @capabilities should be freed with g_free(), when no longer needed. Use e_client_get_capabilities() instead. @@ -2483,20 +2519,20 @@ when no longer needed. %TRUE if successful, %FALSE otherwise. + line="1219">%TRUE if successful, %FALSE otherwise. an #EClient + line="1210">an #EClient a #GAsyncResult + line="1211">a #GAsyncResult transfer-ownership="full"> Comma-separated list of capabilities of the @client + line="1212">Comma-separated list of capabilities of the @client @@ -2515,10 +2551,11 @@ when no longer needed. version="3.2" deprecated="1" deprecated-version="3.8" - throws="1"> + throws="1" + glib:async-func="retrieve_capabilities"> Initiates retrieval of capabilities on the @client. This is usually + line="1250">Initiates retrieval of capabilities on the @client. This is usually required only once, after the @client is opened. The returned value is cached and any subsequent call of e_client_get_capabilities() and e_client_check_capability() is using the cached value. Returned value @@ -2528,14 +2565,14 @@ of @capabilities should be freed with g_free(), when no longer needed. %TRUE if successful, %FALSE otherwise. + line="1263">%TRUE if successful, %FALSE otherwise. an #EClient + line="1252">an #EClient transfer-ownership="full"> Comma-separated list of capabilities of the @client + line="1253">Comma-separated list of capabilities of the @client allow-none="1"> a #GCancellable; can be %NULL + line="1254">a #GCancellable; can be %NULL + version="3.16" + glib:finish-func="retrieve_properties_finish" + glib:sync-func="retrieve_properties_sync"> Asynchronously retrieves @client properties to match server-side values, + line="2018">Asynchronously retrieves @client properties to match server-side values, without waiting for the D-Bus property change notifications delivery. When the operation is finished, @callback will be called. You can then @@ -2576,7 +2615,7 @@ call e_client_retrieve_properties_finish() to get the result of the operation. an #EClient + line="2020">an #EClient optional #GCancellable object, or %NULL + line="2021">optional #GCancellable object, or %NULL a #GAsyncReadyCallback to call when the request is satisfied + line="2022">a #GAsyncReadyCallback to call when the request is satisfied data to pass to the callback function + line="2023">data to pass to the callback function @@ -2616,27 +2655,27 @@ call e_client_retrieve_properties_finish() to get the result of the operation. Finishes the operation started with e_client_retrieve_properties(). + line="2051">Finishes the operation started with e_client_retrieve_properties(). If an error occurs, the function sets @error and returns %FALSE. %TRUE on success, %FALSE on error + line="2061">%TRUE on success, %FALSE on error an #EClient + line="2053">an #EClient a #GAsyncResult + line="2054">a #GAsyncResult @@ -2644,10 +2683,11 @@ If an error occurs, the function sets @error and returns %FALSE. + throws="1" + glib:async-func="retrieve_properties"> Retrieves @client properties to match server-side values, without waiting + line="1969">Retrieves @client properties to match server-side values, without waiting for the D-Bus property change notifications delivery. If an error occurs, the function sets @error and returns %FALSE. @@ -2655,14 +2695,14 @@ If an error occurs, the function sets @error and returns %FALSE. %TRUE on success, %FALSE on error + line="1980">%TRUE on success, %FALSE on error an #EClient + line="1971">an #EClient allow-none="1"> optional #GCancellable object, or %NULL + line="1972">optional #GCancellable object, or %NULL @@ -2680,10 +2720,12 @@ If an error occurs, the function sets @error and returns %FALSE. c:identifier="e_client_set_backend_property" version="3.2" deprecated="1" - deprecated-version="3.8"> + deprecated-version="3.8" + glib:finish-func="set_backend_property_finish" + glib:sync-func="set_backend_property_sync"> Sets @client's backend property of name @prop_name + line="1396">Sets @client's backend property of name @prop_name to value @prop_value. The call is finished by e_client_set_backend_property_finish() from the @callback. Clients cannot set backend properties. Any attempt @@ -2696,19 +2738,19 @@ by e_client_set_backend_property_finish() from the @callback. an #EClient + line="1398">an #EClient property name, whose value to change; cannot be %NULL + line="1399">property name, whose value to change; cannot be %NULL property value, to set; cannot be %NULL + line="1400">property value, to set; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1401">a #GCancellable; can be %NULL closure="4"> callback to call when a result is ready + line="1402">callback to call when a result is ready allow-none="1"> user data for the @callback + line="1403">user data for the @callback @@ -2750,27 +2792,27 @@ by e_client_set_backend_property_finish() from the @callback. throws="1"> Finishes previous call of e_client_set_backend_property(). + line="1438">Finishes previous call of e_client_set_backend_property(). Clients cannot set backend properties. Any attempt will fail with an %E_CLIENT_ERROR_NOT_SUPPORTED error. %TRUE if successful, %FALSE otherwise. + line="1446">%TRUE if successful, %FALSE otherwise. an #EClient + line="1440">an #EClient a #GAsyncResult + line="1441">a #GAsyncResult @@ -2780,10 +2822,11 @@ by e_client_set_backend_property_finish() from the @callback. version="3.2" deprecated="1" deprecated-version="3.8" - throws="1"> + throws="1" + glib:async-func="set_backend_property"> Sets @client's backend property of name @prop_name + line="1469">Sets @client's backend property of name @prop_name to value @prop_value. Clients cannot set backend properties. Any attempt will fail with an %E_CLIENT_ERROR_NOT_SUPPORTED error. @@ -2791,26 +2834,26 @@ to value @prop_value. %TRUE if successful, %FALSE otherwise. + line="1480">%TRUE if successful, %FALSE otherwise. an #EClient + line="1471">an #EClient property name, whose value to change; cannot be %NULL + line="1472">property name, whose value to change; cannot be %NULL property value, to set; cannot be %NULL + line="1473">property value, to set; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1474">a #GCancellable; can be %NULL @@ -2829,7 +2872,7 @@ to value @prop_value. version="3.16"> Sets a D-Bus bus name that will be used to connect the client + line="2386">Sets a D-Bus bus name that will be used to connect the client to the backend subprocess. @@ -2839,13 +2882,13 @@ to the backend subprocess. an #EClient + line="2388">an #EClient a string representing a D-Bus bus name + line="2389">a string representing a D-Bus bus name @@ -2858,7 +2901,7 @@ to the backend subprocess. throws="1"> Unwraps D-Bus error to local error. @dbus_error is automatically freed. + line="2235">Unwraps D-Bus error to local error. @dbus_error is automatically freed. @dbus_erorr and @out_error can point to the same variable. Use g_dbus_error_strip_remote_error() instead. @@ -2869,23 +2912,25 @@ to the backend subprocess. an #EClient + line="2237">an #EClient a #GError returned bu D-Bus + line="2238">a #GError returned bu D-Bus + version="3.16" + glib:finish-func="wait_for_connected_finish" + glib:sync-func="wait_for_connected_sync"> Asynchronously waits until the @client is connected (according + line="1811">Asynchronously waits until the @client is connected (according to @ESource::connection-status property), but not longer than @timeout_seconds. The call is finished by e_client_wait_for_connected_finish() from @@ -2898,13 +2943,13 @@ the @callback. an #EClient + line="1813">an #EClient a timeout for the wait, in seconds + line="1814">a timeout for the wait, in seconds allow-none="1"> a #GCancellable; or %NULL + line="1815">a #GCancellable; or %NULL closure="3"> callback to call when a result is ready + line="1816">callback to call when a result is ready allow-none="1"> user data for the @callback + line="1817">user data for the @callback @@ -2944,25 +2989,25 @@ the @callback. throws="1"> Finishes previous call of e_client_wait_for_connected(). + line="1847">Finishes previous call of e_client_wait_for_connected(). %TRUE if successful, %FALSE otherwise. + line="1855">%TRUE if successful, %FALSE otherwise. an #EClient + line="1849">an #EClient a #GAsyncResult + line="1850">a #GAsyncResult @@ -2970,10 +3015,11 @@ the @callback. + throws="1" + glib:async-func="wait_for_connected"> Synchronously waits until the @client is connected (according + line="1894">Synchronously waits until the @client is connected (according to @ESource::connection-status property), but not longer than @timeout_seconds. Note: This also calls e_client_retrieve_properties_sync() on success, to have @@ -2983,20 +3029,20 @@ Note: This also calls e_client_retrieve_properties_sync() on success, to have %TRUE if successful, %FALSE otherwise. + line="1908">%TRUE if successful, %FALSE otherwise. an #EClient + line="1896">an #EClient a timeout for the wait, in seconds + line="1897">a timeout for the wait, in seconds a #GCancellable; or %NULL + line="1898">a #GCancellable; or %NULL @@ -3015,13 +3061,13 @@ Note: This also calls e_client_retrieve_properties_sync() on success, to have getter="get_capabilities"> The capabilities of this client + line="739">The capabilities of this client The main loop context in which notifications for + line="755">The main loop context in which notifications for this client will be delivered. @@ -3031,7 +3077,7 @@ this client will be delivered. default-value="FALSE"> Whether this client's backing data is online. + line="773">Whether this client's backing data is online. default-value="FALSE"> Whether this client is open and ready to use. + line="790">Whether this client is open and ready to use. This property is no longer relevant and will always be %TRUE after successfully creating any concrete type of #EClient. @@ -3052,7 +3098,7 @@ type of #EClient. default-value="FALSE"> Whether this client's backing data is readonly. + line="810">Whether this client's backing data is readonly. getter="get_source"> The #ESource for which this client was created. + line="826">The #ESource for which this client was created. @@ -3142,13 +3188,13 @@ type of #EClient. an #EClient + line="2237">an #EClient a #GError returned bu D-Bus + line="2238">a #GError returned bu D-Bus @@ -3165,7 +3211,7 @@ type of #EClient. an #EClient + line="1174">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1175">a #GCancellable; can be %NULL closure="3"> callback to call when a result is ready + line="1176">callback to call when a result is ready @@ -3196,7 +3242,7 @@ type of #EClient. closure="3"> user data for the @callback + line="1177">user data for the @callback @@ -3209,20 +3255,20 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1219">%TRUE if successful, %FALSE otherwise. an #EClient + line="1210">an #EClient a #GAsyncResult + line="1211">a #GAsyncResult transfer-ownership="full"> Comma-separated list of capabilities of the @client + line="1212">Comma-separated list of capabilities of the @client @@ -3244,14 +3290,14 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1263">%TRUE if successful, %FALSE otherwise. an #EClient + line="1252">an #EClient transfer-ownership="full"> Comma-separated list of capabilities of the @client + line="1253">Comma-separated list of capabilities of the @client allow-none="1"> a #GCancellable; can be %NULL + line="1254">a #GCancellable; can be %NULL @@ -3286,13 +3332,13 @@ type of #EClient. an #EClient + line="1296">an #EClient property name, whose value to retrieve; cannot be %NULL + line="1297">property name, whose value to retrieve; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1298">a #GCancellable; can be %NULL closure="4"> callback to call when a result is ready + line="1299">callback to call when a result is ready @@ -3323,7 +3369,7 @@ type of #EClient. closure="4"> user data for the @callback + line="1300">user data for the @callback @@ -3336,20 +3382,20 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1338">%TRUE if successful, %FALSE otherwise. an #EClient + line="1331">an #EClient a #GAsyncResult + line="1332">a #GAsyncResult transfer-ownership="full"> Retrieved backend property value; cannot be %NULL + line="1333">Retrieved backend property value; cannot be %NULL @@ -3371,20 +3417,20 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1371">%TRUE if successful, %FALSE otherwise. an #EClient + line="1363">an #EClient property name, whose value to retrieve; cannot be %NULL + line="1364">property name, whose value to retrieve; cannot be %NULL transfer-ownership="full"> Retrieved backend property value; cannot be %NULL + line="1365">Retrieved backend property value; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1366">a #GCancellable; can be %NULL @@ -3419,19 +3465,19 @@ type of #EClient. an #EClient + line="1398">an #EClient property name, whose value to change; cannot be %NULL + line="1399">property name, whose value to change; cannot be %NULL property value, to set; cannot be %NULL + line="1400">property value, to set; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1401">a #GCancellable; can be %NULL closure="5"> callback to call when a result is ready + line="1402">callback to call when a result is ready @@ -3462,7 +3508,7 @@ type of #EClient. closure="5"> user data for the @callback + line="1403">user data for the @callback @@ -3475,20 +3521,20 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1446">%TRUE if successful, %FALSE otherwise. an #EClient + line="1440">an #EClient a #GAsyncResult + line="1441">a #GAsyncResult @@ -3501,26 +3547,26 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1480">%TRUE if successful, %FALSE otherwise. an #EClient + line="1471">an #EClient property name, whose value to change; cannot be %NULL + line="1472">property name, whose value to change; cannot be %NULL property value, to set; cannot be %NULL + line="1473">property value, to set; cannot be %NULL allow-none="1"> a #GCancellable; can be %NULL + line="1474">a #GCancellable; can be %NULL @@ -3546,13 +3592,13 @@ type of #EClient. an #EClient + line="1510">an #EClient this parameter is not used anymore + line="1511">this parameter is not used anymore allow-none="1"> a #GCancellable; can be %NULL + line="1512">a #GCancellable; can be %NULL closure="4"> callback to call when a result is ready + line="1513">callback to call when a result is ready @@ -3583,7 +3629,7 @@ type of #EClient. closure="4"> user data for the @callback + line="1514">user data for the @callback @@ -3596,20 +3642,20 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1553">%TRUE if successful, %FALSE otherwise. an #EClient + line="1547">an #EClient a #GAsyncResult + line="1548">a #GAsyncResult @@ -3622,20 +3668,20 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1587">%TRUE if successful, %FALSE otherwise. an #EClient + line="1580">an #EClient this parameter is not used anymore + line="1581">this parameter is not used anymore allow-none="1"> a #GCancellable; can be %NULL + line="1582">a #GCancellable; can be %NULL @@ -3661,7 +3707,7 @@ type of #EClient. an #EClient + line="1611">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1612">a #GCancellable; can be %NULL closure="3"> callback to call when a result is ready + line="1613">callback to call when a result is ready @@ -3692,7 +3738,7 @@ type of #EClient. closure="3"> user data for the @callback + line="1614">user data for the @callback @@ -3705,20 +3751,20 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1650">%TRUE if successful, %FALSE otherwise. an #EClient + line="1644">an #EClient a #GAsyncResult + line="1645">a #GAsyncResult @@ -3731,14 +3777,14 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1681">%TRUE if successful, %FALSE otherwise. an #EClient + line="1674">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1675">a #GCancellable; can be %NULL @@ -3764,7 +3810,7 @@ type of #EClient. an #EClient + line="1703">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1704">a #GCancellable; can be %NULL closure="3"> callback to call when a result is ready + line="1705">callback to call when a result is ready @@ -3795,7 +3841,7 @@ type of #EClient. closure="3"> user data for the @callback + line="1706">user data for the @callback @@ -3808,20 +3854,20 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1742">%TRUE if successful, %FALSE otherwise. an #EClient + line="1736">an #EClient a #GAsyncResult + line="1737">a #GAsyncResult @@ -3834,14 +3880,14 @@ type of #EClient. %TRUE if successful, %FALSE otherwise. + line="1773">%TRUE if successful, %FALSE otherwise. an #EClient + line="1764">an #EClient allow-none="1"> a #GCancellable; can be %NULL + line="1765">a #GCancellable; can be %NULL @@ -3863,14 +3909,14 @@ type of #EClient. %TRUE on success, %FALSE on error + line="1980">%TRUE on success, %FALSE on error an #EClient + line="1971">an #EClient allow-none="1"> optional #GCancellable object, or %NULL + line="1972">optional #GCancellable object, or %NULL @@ -4617,7 +4663,7 @@ time. - + The micro version number of the Evolution-Data-Server library. Like @@ -4627,7 +4673,7 @@ time. - + The minor version number of the Evolution-Data-Server library. Like @@ -14640,7 +14686,9 @@ parameter. + version="3.46" + glib:finish-func="send_message_finish" + glib:sync-func="send_message_sync"> Asynchronously sends the @message. Finish the call with @@ -14825,7 +14873,8 @@ more control on the content read. + throws="1" + glib:async-func="send_message"> Synchronously sends prepared message and returns #GInputStream @@ -15072,7 +15121,7 @@ functions below. throws="1"> Creates a new #ESource instance. + line="2469">Creates a new #ESource instance. The #ESource::changed signal will be emitted from @main_context if given, or else from the thread-default #GMainContext at the time this function is @@ -15087,7 +15136,7 @@ FIXME: Elaborate on scratch sources. a new #ESource, or %NULL on error + line="2487">a new #ESource, or %NULL on error @@ -15097,7 +15146,7 @@ FIXME: Elaborate on scratch sources. allow-none="1"> a #GDBusObject or %NULL + line="2471">a #GDBusObject or %NULL allow-none="1"> a #GMainContext or %NULL + line="2472">a #GMainContext or %NULL @@ -15117,7 +15166,7 @@ FIXME: Elaborate on scratch sources. throws="1"> Creates a new "scratch" #ESource with a predetermined unique identifier. + line="2506">Creates a new "scratch" #ESource with a predetermined unique identifier. The #ESource::changed signal will be emitted from @main_context if given, or else from the thread-default #GMainContext at the time this function is @@ -15126,14 +15175,14 @@ called. a new scratch #ESource, or %NULL on error + line="2518">a new scratch #ESource, or %NULL on error a new unique identifier string + line="2508">a new unique identifier string allow-none="1"> a #GMainContext or %NULL + line="2509">a #GMainContext or %NULL @@ -15152,7 +15201,7 @@ called. version="3.6"> Converts a #GParamSpec name (e.g. "foo-bar" or "foo_bar") + line="3426">Converts a #GParamSpec name (e.g. "foo-bar" or "foo_bar") to "CamelCase" for use as a #GKeyFile key (e.g. "FooBar"). This function is made public only to aid in account migration. @@ -15165,7 +15214,7 @@ Applications should not need to use this. a #GParamSpec name + line="3428">a #GParamSpec name @@ -15187,7 +15236,7 @@ Applications should not need to use this. Emits the #ESource::changed signal from an idle callback in + line="2589">Emits the #ESource::changed signal from an idle callback in @source's #ESource:main-context. This function is primarily intended for use by #ESourceExtension @@ -15200,7 +15249,7 @@ when emitting a #GObject::notify signal on one of its properties. an #ESource + line="2591">an #ESource @@ -15232,10 +15281,12 @@ when emitting a #GObject::notify signal on one of its properties. + version="3.8" + glib:finish-func="get_oauth2_access_token_finish" + glib:sync-func="get_oauth2_access_token_sync"> Asynchronously obtains the OAuth 2.0 access token for @source along + line="3967">Asynchronously obtains the OAuth 2.0 access token for @source along with its expiry in seconds from the current time (or 0 if unknown). When the operation is finished, @callback will be called. You can then @@ -15249,7 +15300,7 @@ operation. an #ESource + line="3969">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3970">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request + line="3971">a #GAsyncReadyCallback to call when the request is satisfied @@ -15280,7 +15331,7 @@ operation. closure="2"> data to pass to the callback function + line="3973">data to pass to the callback function @@ -15291,7 +15342,7 @@ operation. throws="1"> Finishes the operation started with e_source_get_oauth2_access_token(). + line="4002">Finishes the operation started with e_source_get_oauth2_access_token(). Free the returned access token with g_free() when finished with it. If an error occurred, the function will set @error and return %FALSE. @@ -15299,20 +15350,20 @@ If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="4017">%TRUE on success, %FALSE on error an #ESource + line="4004">an #ESource a #GAsyncResult + line="4005">a #GAsyncResult allow-none="1"> return location for the access token, + line="4006">return location for the access token, or %NULL @@ -15335,7 +15386,7 @@ If an error occurred, the function will set @error and return %FALSE. allow-none="1"> return location for the token expiry, + line="4008">return location for the token expiry, or %NULL @@ -15344,10 +15395,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="get_oauth2_access_token"> Obtains the OAuth 2.0 access token for @source along with its expiry + line="3928">Obtains the OAuth 2.0 access token for @source along with its expiry in seconds from the current time (or 0 if unknown). Free the returned access token with g_free() when finished with it. @@ -15356,14 +15408,14 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3944">%TRUE on success, %FALSE on error an #ESource + line="3930">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3931">optional #GCancellable object, or %NULL allow-none="1"> return location for the access token, + line="3932">return location for the access token, or %NULL @@ -15395,7 +15447,7 @@ If an error occurs, the function will set @error and return %FALSE. allow-none="1"> return location for the token expiry, + line="3934">return location for the token expiry, or %NULL @@ -15467,10 +15519,12 @@ If an error occurs, the function will set @error and return %FALSE. + version="3.6" + glib:finish-func="remote_create_finish" + glib:sync-func="remote_create_sync"> Asynchronously creates a new remote resource by picking out relevant + line="3760">Asynchronously creates a new remote resource by picking out relevant details from @scratch_source. The @scratch_source must be an #ESource with no #GDBusObject. The @source must be #ESource:remote-creatable. @@ -15489,13 +15543,13 @@ call e_source_remote_create_finish() to get the result of the operation. an #ESource + line="3762">an #ESource an #ESource describing the resource to create + line="3763">an #ESource describing the resource to create allow-none="1"> optional #GCancellable object, or %NULL + line="3764">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="3765">a #GAsyncReadyCallback to call when the request is satisfied closure="3"> data to pass to the callback function + line="3766">data to pass to the callback function @@ -15536,26 +15590,26 @@ call e_source_remote_create_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_remote_create(). If + line="3803">Finishes the operation started with e_source_remote_create(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3812">%TRUE on success, %FALSE on error an #ESource + line="3805">an #ESource a #GAsyncResult + line="3806">a #GAsyncResult @@ -15563,10 +15617,11 @@ an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="remote_create"> Creates a new remote resource by picking out relevant details from + line="3719">Creates a new remote resource by picking out relevant details from @scratch_source. The @scratch_source must be an #ESource with no #GDBusObject. The @source must be #ESource:remote-creatable. @@ -15580,20 +15635,20 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3737">%TRUE on success, %FALSE on error an #ESource + line="3721">an #ESource an #ESource describing the resource to create + line="3722">an #ESource describing the resource to create allow-none="1"> optional #GCancellable object, or %NULL + line="3723">optional #GCancellable object, or %NULL + version="3.6" + glib:finish-func="remote_delete_finish" + glib:sync-func="remote_delete_sync"> Asynchronously deletes the resource represented by @source from a remote + line="3865">Asynchronously deletes the resource represented by @source from a remote server. The @source must be #ESource:remote-deletable. This will also delete the key file for @source and broadcast its removal to all clients, similar to e_source_remove(). @@ -15627,7 +15684,7 @@ call e_source_remote_delete_finish() to get the result of the operation. an #ESource + line="3867">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3868">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="3869">a #GAsyncReadyCallback to call when the request is satisfied closure="2"> data to pass to the callback function + line="3870">data to pass to the callback function @@ -15668,26 +15725,26 @@ call e_source_remote_delete_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_remote_delete(). If + line="3899">Finishes the operation started with e_source_remote_delete(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3908">%TRUE on success, %FALSE on error an #ESource + line="3901">an #ESource a #GAsyncResult + line="3902">a #GAsyncResult @@ -15695,10 +15752,11 @@ an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="remote_delete"> Deletes the resource represented by @source from a remote server. + line="3832">Deletes the resource represented by @source from a remote server. The @source must be #ESource:remote-deletable. This will also delete the key file for @source and broadcast its removal to all clients, similar to e_source_remove_sync(). @@ -15708,14 +15766,14 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3845">%TRUE on success, %FALSE on error an #ESource + line="3834">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3835">optional #GCancellable object, or %NULL - + Asynchronously requests the D-Bus service to delete the key files for + line="3561">Asynchronously requests the D-Bus service to delete the key files for @source and all of its descendants and broadcast their removal to all clients. The @source must be #ESource:removable. @@ -15746,7 +15808,7 @@ call e_source_remove_finish() to get the result of the operation. the #ESource to be removed + line="3563">the #ESource to be removed allow-none="1"> optional #GCancellable object, or %NULL + line="3564">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="3565">a #GAsyncReadyCallback to call when the request is satisfied closure="2"> data to pass to the callback function + line="3566">data to pass to the callback function @@ -15787,26 +15849,26 @@ call e_source_remove_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_remove(). If an + line="3594">Finishes the operation started with e_source_remove(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE of failure + line="3603">%TRUE on success, %FALSE of failure the #ESource to be removed + line="3596">the #ESource to be removed a #GAsyncResult + line="3597">a #GAsyncResult @@ -15814,10 +15876,11 @@ error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="remove"> Requests the D-Bus service to delete the key files for @source and all of + line="3529">Requests the D-Bus service to delete the key files for @source and all of its descendants and broadcast their removal to all clients. The @source must be #ESource:removable. @@ -15826,14 +15889,14 @@ If an error occurs, the functon will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3541">%TRUE on success, %FALSE on error the #ESource to be removed + line="3531">the #ESource to be removed allow-none="1"> optional #GCancellable object, or %NULL + line="3532">optional #GCancellable object, or %NULL @@ -15865,10 +15928,14 @@ If an error occurs, the functon will set @error and return %FALSE. - + Asynchronously submits the current contents of @source to the D-Bus + line="3656">Asynchronously submits the current contents of @source to the D-Bus service to be written to disk and broadcast to other clients. The @source must be #ESource:writable. @@ -15882,7 +15949,7 @@ call e_source_write_finish() to get the result of the operation. a writable #ESource + line="3658">a writable #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3659">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="3660">a #GAsyncReadyCallback to call when the request is satisfied closure="2"> data to pass to the callback function + line="3661">data to pass to the callback function @@ -15923,26 +15990,26 @@ call e_source_write_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_write(). If an + line="3689">Finishes the operation started with e_source_write(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3698">%TRUE on success, %FALSE on error a writable #ESource + line="3691">a writable #ESource a #GAsyncResult + line="3692">a #GAsyncResult @@ -15950,10 +16017,11 @@ error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="write"> Submits the current contents of @source to the D-Bus service to be + line="3624">Submits the current contents of @source to the D-Bus service to be written to disk and broadcast to other clients. The @source must be #ESource:writable. @@ -15962,14 +16030,14 @@ If an error occurs, the functon will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3636">%TRUE on success, %FALSE on error a writable #ESource + line="3626">a writable #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3627">optional #GCancellable object, or %NULL @@ -16017,7 +16085,7 @@ camel_session_add_service(). Emits the #ESource::changed signal from an idle callback in + line="2589">Emits the #ESource::changed signal from an idle callback in @source's #ESource:main-context. This function is primarily intended for use by #ESourceExtension @@ -16030,7 +16098,7 @@ when emitting a #GObject::notify signal on one of its properties. an #ESource + line="2591">an #ESource @@ -16040,13 +16108,13 @@ when emitting a #GObject::notify signal on one of its properties. version="3.6"> Compares two #ESource instances by their display names. Useful for + line="3353">Compares two #ESource instances by their display names. Useful for ordering sources in a user interface. a negative value if @source1 compares before @source2, zero if + line="3361">a negative value if @source1 compares before @source2, zero if they compare equal, or a positive value if @source1 compares after @source2 @@ -16055,23 +16123,25 @@ ordering sources in a user interface. the first #ESource + line="3355">the first #ESource the second #ESource + line="3356">the second #ESource + version="3.12" + glib:finish-func="delete_password_finish" + glib:sync-func="delete_password_sync"> Asynchronously deletes the password for @source from either the default + line="4390">Asynchronously deletes the password for @source from either the default keyring or session keyring. This operation does not rely on the registry service and therefore works for any #ESource -- registered or "scratch". @@ -16085,7 +16155,7 @@ call e_source_delete_password_finish() to get the result of the operation. an #ESource + line="4392">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="4393">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="4394">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="4395">data to pass to the callback function @@ -16125,7 +16195,7 @@ call e_source_delete_password_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_delete_password(). + line="4424">Finishes the operation started with e_source_delete_password(). Note the boolean return value indicates whether the delete operation itself completed successfully, not whether a password was found and @@ -16135,20 +16205,20 @@ deleted. If no password was found, the function will still return %TRUE on success, %FALSE on error + line="4437">%TRUE on success, %FALSE on error an #ESource + line="4426">an #ESource a #GAsyncResult + line="4427">a #GAsyncResult @@ -16156,10 +16226,11 @@ deleted. If no password was found, the function will still return + throws="1" + glib:async-func="delete_password"> Deletes the password for @source from either the default keyring or + line="4336">Deletes the password for @source from either the default keyring or session keyring. This operation does not rely on the registry service and therefore works for any #ESource -- registered or "scratch". @@ -16171,14 +16242,14 @@ deleted. If no password was found, the function will still return %TRUE on success, %FALSE on error + line="4351">%TRUE on success, %FALSE on error an #ESource + line="4338">an #ESource optional #GCancellable object, or %NULL + line="4339">optional #GCancellable object, or %NULL @@ -16197,7 +16268,7 @@ deleted. If no password was found, the function will still return version="3.6"> Thread-safe variation of e_source_get_display_name(). + line="3159">Thread-safe variation of e_source_get_display_name(). Use this function when accessing @source from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -16205,14 +16276,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESource:display-name + line="3168">a newly-allocated copy of #ESource:display-name an #ESource + line="3161">an #ESource @@ -16222,7 +16293,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.6"> Thread-safe variation of e_source_get_parent(). + line="2692">Thread-safe variation of e_source_get_parent(). Use this function when accessing @source from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -16230,14 +16301,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESource:parent + line="2701">a newly-allocated copy of #ESource:parent an #ESource + line="2694">an #ESource @@ -16247,20 +16318,20 @@ The returned string should be freed with g_free() when no longer needed. version="3.12"> Creates a label string based on @source's #ESource:display-name for use + line="3234">Creates a label string based on @source's #ESource:display-name for use with #SecretItem. a newly-allocated secret label + line="3241">a newly-allocated secret label an #ESource + line="3236">an #ESource @@ -16268,7 +16339,7 @@ with #SecretItem. Thread-safe variation of e_source_get_uid(). + line="2640">Thread-safe variation of e_source_get_uid(). Use this function when accessing @source from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -16276,14 +16347,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESource:uid + line="2649">a newly-allocated copy of #ESource:uid an #ESource + line="2642">an #ESource @@ -16293,7 +16364,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.16"> Emits locally (in this process only) the ESource::credentials-required + line="4876">Emits locally (in this process only) the ESource::credentials-required signal with given parameters. That's the difference with e_source_invoke_credentials_required(), which calls the signal globally, within each client. @@ -16304,26 +16375,26 @@ which calls the signal globally, within each client. an #ESource + line="4878">an #ESource an #ESourceCredentialsReason, why the credentials are required + line="4879">an #ESourceCredentialsReason, why the credentials are required PEM-encoded secure connection certificate, or an empty string + line="4880">PEM-encoded secure connection certificate, or an empty string a bit-or of #GTlsCertificateFlags for secure connection certificate + line="4881">a bit-or of #GTlsCertificateFlags for secure connection certificate @@ -16333,7 +16404,7 @@ which calls the signal globally, within each client. allow-none="1"> a #GError with a description of the previous credentials error, or %NULL + line="4882">a #GError with a description of the previous credentials error, or %NULL @@ -16341,26 +16412,26 @@ which calls the signal globally, within each client. Checks two #ESource instances for equality. #ESource instances are + line="2559">Checks two #ESource instances for equality. #ESource instances are equal if their unique identifier strings are equal. %TRUE if @source1 and @source2 are equal + line="2567">%TRUE if @source1 and @source2 are equal the first #ESource + line="2561">the first #ESource the second #ESource + line="2562">the second #ESource @@ -16371,12 +16442,12 @@ equal if their unique identifier strings are equal. version="3.16"> Obtain current connection status of the @source. + line="3462">Obtain current connection status of the @source. Current connection status of the @source. + line="3468">Current connection status of the @source. @@ -16384,7 +16455,7 @@ equal if their unique identifier strings are equal. an #ESource + line="3464">an #ESource @@ -16395,20 +16466,20 @@ equal if their unique identifier strings are equal. version="3.6"> Returns the display name for @source. Use the display name to + line="3140">Returns the display name for @source. Use the display name to represent the #ESource in a user interface. the display name for @source + line="3147">the display name for @source an #ESource + line="3142">an #ESource @@ -16419,7 +16490,7 @@ represent the #ESource in a user interface. version="3.6"> Returns %TRUE if @source is enabled. + line="2758">Returns %TRUE if @source is enabled. An application should try to honor this setting if at all possible, even if it does not provide a way to change the setting through its @@ -16436,14 +16507,14 @@ user interface. Disabled data sources should generally be hidden. whether @source is enabled + line="2776">whether @source is enabled an #ESource + line="2760">an #ESource @@ -16453,7 +16524,7 @@ user interface. Disabled data sources should generally be hidden. version="3.6"> Returns an instance of some #ESourceExtension subclass which registered + line="2958">Returns an instance of some #ESourceExtension subclass which registered itself under @extension_name. If no such instance exists within @source, one will be created. It is the caller's responsibility to know which subclass is being returned. @@ -16468,7 +16539,7 @@ use this function to fetch the extension instance as needed. an instance of some + line="2975">an instance of some #ESourceExtension subclass @@ -16476,23 +16547,25 @@ use this function to fetch the extension instance as needed. an #ESource + line="2960">an #ESource an extension name + line="2961">an extension name + version="3.16" + glib:finish-func="get_last_credentials_required_arguments_finish" + glib:sync-func="get_last_credentials_required_arguments_sync"> Asynchronously calls the GetLastCredentialsRequiredArguments method + line="5021">Asynchronously calls the GetLastCredentialsRequiredArguments method on the server side, to get the last values used for the 'credentials-required' signal. See e_source_get_last_credentials_required_arguments_sync() for more information. @@ -16508,7 +16581,7 @@ the result of the operation. an #ESource + line="5023">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="5024">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="5025">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="5026">data to pass to the callback function @@ -16548,7 +16621,7 @@ the result of the operation. throws="1"> Finishes the operation started with e_source_get_last_credentials_required_arguments(). + line="5057">Finishes the operation started with e_source_get_last_credentials_required_arguments(). See e_source_get_last_credentials_required_arguments_sync() for more information about the output arguments. @@ -16557,20 +16630,20 @@ If an error occurs, the function sets @error and returns %FALSE. %TRUE on success, %FALSE on error + line="5073">%TRUE on success, %FALSE on error an #ESource + line="5059">an #ESource a #GAsyncResult + line="5060">a #GAsyncResult transfer-ownership="full"> an #ESourceCredentialsReason, why the credentials are required + line="5061">an #ESourceCredentialsReason, why the credentials are required @@ -16589,7 +16662,7 @@ If an error occurs, the function sets @error and returns %FALSE. transfer-ownership="full"> PEM-encoded secure connection certificate, or an empty string + line="5062">PEM-encoded secure connection certificate, or an empty string transfer-ownership="full"> a bit-or of #GTlsCertificateFlags for secure connection certificate + line="5063">a bit-or of #GTlsCertificateFlags for secure connection certificate @@ -16608,7 +16681,7 @@ If an error occurs, the function sets @error and returns %FALSE. transfer-ownership="full"> a #GError with a description of the previous credentials error + line="5064">a #GError with a description of the previous credentials error @@ -16616,10 +16689,11 @@ If an error occurs, the function sets @error and returns %FALSE. + throws="1" + glib:async-func="get_last_credentials_required_arguments"> Retrieves the last used arguments of the 'credentials-required' signal emission. + line="4902">Retrieves the last used arguments of the 'credentials-required' signal emission. If there was none emitted yet, or a corresponding 'authenitcate' had been emitted already, then the @out_reason is set to #E_SOURCE_CREDENTIALS_REASON_UNKNOWN and the value of other 'out' arguments is set to no values. @@ -16630,14 +16704,14 @@ values should be freed with g_free() when no longer needed. %TRUE on success, %FALSE on error + line="4920">%TRUE on success, %FALSE on error an #ESource + line="4904">an #ESource transfer-ownership="full"> an #ESourceCredentialsReason, why the credentials are required + line="4905">an #ESourceCredentialsReason, why the credentials are required @@ -16656,7 +16730,7 @@ values should be freed with g_free() when no longer needed. transfer-ownership="full"> PEM-encoded secure connection certificate, or an empty string + line="4906">PEM-encoded secure connection certificate, or an empty string transfer-ownership="full"> a bit-or of #GTlsCertificateFlags for secure connection certificate + line="4907">a bit-or of #GTlsCertificateFlags for secure connection certificate @@ -16675,7 +16749,7 @@ values should be freed with g_free() when no longer needed. transfer-ownership="full"> a #GError with a description of the previous credentials error + line="4908">a #GError with a description of the previous credentials error allow-none="1"> optional #GCancellable object, or %NULL + line="4909">optional #GCancellable object, or %NULL + version="3.8" + glib:finish-func="get_oauth2_access_token_finish" + glib:sync-func="get_oauth2_access_token_sync"> Asynchronously obtains the OAuth 2.0 access token for @source along + line="3967">Asynchronously obtains the OAuth 2.0 access token for @source along with its expiry in seconds from the current time (or 0 if unknown). When the operation is finished, @callback will be called. You can then @@ -16708,7 +16784,7 @@ operation. an #ESource + line="3969">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3970">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request + line="3971">a #GAsyncReadyCallback to call when the request is satisfied @@ -16738,7 +16814,7 @@ operation. allow-none="1"> data to pass to the callback function + line="3973">data to pass to the callback function @@ -16749,7 +16825,7 @@ operation. throws="1"> Finishes the operation started with e_source_get_oauth2_access_token(). + line="4002">Finishes the operation started with e_source_get_oauth2_access_token(). Free the returned access token with g_free() when finished with it. If an error occurred, the function will set @error and return %FALSE. @@ -16757,20 +16833,20 @@ If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="4017">%TRUE on success, %FALSE on error an #ESource + line="4004">an #ESource a #GAsyncResult + line="4005">a #GAsyncResult allow-none="1"> return location for the access token, + line="4006">return location for the access token, or %NULL @@ -16793,7 +16869,7 @@ If an error occurred, the function will set @error and return %FALSE. allow-none="1"> return location for the token expiry, + line="4008">return location for the token expiry, or %NULL @@ -16802,10 +16878,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="get_oauth2_access_token"> Obtains the OAuth 2.0 access token for @source along with its expiry + line="3928">Obtains the OAuth 2.0 access token for @source along with its expiry in seconds from the current time (or 0 if unknown). Free the returned access token with g_free() when finished with it. @@ -16814,14 +16891,14 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3944">%TRUE on success, %FALSE on error an #ESource + line="3930">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3931">optional #GCancellable object, or %NULL allow-none="1"> return location for the access token, + line="3932">return location for the access token, or %NULL @@ -16853,7 +16930,7 @@ If an error occurs, the function will set @error and return %FALSE. allow-none="1"> return location for the token expiry, + line="3934">return location for the token expiry, or %NULL @@ -16865,19 +16942,19 @@ If an error occurs, the function will set @error and return %FALSE. version="3.6"> Returns the unique identifier string of the parent #ESource. + line="2674">Returns the unique identifier string of the parent #ESource. the UID of the parent #ESource + line="2680">the UID of the parent #ESource an #ESource + line="2676">an #ESource @@ -16888,7 +16965,7 @@ If an error occurs, the function will set @error and return %FALSE. version="3.6"> Returns whether new resources can be created on a remote server by + line="2881">Returns whether new resources can be created on a remote server by calling e_source_remote_create() on @source. Generally this is only %TRUE if @source has an #ESourceCollection @@ -16899,14 +16976,14 @@ this capability, calls to e_source_remote_create() will fail. whether @source can create remote resources + line="2893">whether @source can create remote resources an #ESource + line="2883">an #ESource @@ -16917,7 +16994,7 @@ this capability, calls to e_source_remote_create() will fail. version="3.6"> Returns whether the resource represented by @source can be deleted + line="2919">Returns whether the resource represented by @source can be deleted from a remote server by calling e_source_remote_delete(). Generally this is only %TRUE if @source is a child of an #ESource @@ -16929,14 +17006,14 @@ e_source_remote_delete() will fail. whether @source can delete remote resources + line="2932">whether @source can delete remote resources an #ESource + line="2921">an #ESource @@ -16947,20 +17024,20 @@ e_source_remote_delete() will fail. version="3.6"> Returns whether the D-Bus service will allow @source to be removed. + line="2848">Returns whether the D-Bus service will allow @source to be removed. If @source is not writable, calls to e_source_remove() will fail. whether @source is removable + line="2855">whether @source is removable an #ESource + line="2850">an #ESource @@ -16971,19 +17048,19 @@ If @source is not writable, calls to e_source_remove() will fail. version="3.6"> Returns the unique identifier string for @source. + line="2622">Returns the unique identifier string for @source. the UID for @source + line="2628">the UID for @source an #ESource + line="2624">an #ESource @@ -16994,20 +17071,20 @@ If @source is not writable, calls to e_source_remove() will fail. version="3.6"> Returns whether the D-Bus service will accept changes to @source. + line="2815">Returns whether the D-Bus service will accept changes to @source. If @source is not writable, calls to e_source_write() will fail. whether @source is writable + line="2822">whether @source is writable an #ESource + line="2817">an #ESource @@ -17017,25 +17094,25 @@ If @source is not writable, calls to e_source_write() will fail. version="3.6"> Checks whether @source has an #ESourceExtension with the given name. + line="3040">Checks whether @source has an #ESourceExtension with the given name. %TRUE if @source has such an extension, %FALSE if not + line="3047">%TRUE if @source has such an extension, %FALSE if not an #ESource + line="3042">an #ESource an extension name + line="3043">an extension name @@ -17043,31 +17120,33 @@ If @source is not writable, calls to e_source_write() will fail. Generates a hash value for @source. This function is intended for + line="2535">Generates a hash value for @source. This function is intended for easily hashing an #ESource to add to a #GHashTable or similar data structure. a hash value for @source. + line="2543">a hash value for @source. an #ESource + line="2537">an #ESource + version="3.16" + glib:finish-func="invoke_authenticate_finish" + glib:sync-func="invoke_authenticate_sync"> Asynchronously calls the InvokeAuthenticate method on the server side, + line="4806">Asynchronously calls the InvokeAuthenticate method on the server side, thus the backend knows what credentials to use to connect to its (possibly remote) data store. @@ -17081,7 +17160,7 @@ call e_source_invoke_authenticate_finish() to get the result of the operation. an #ESource + line="4808">an #ESource an #ENamedParameters structure with credentials to use; can be %NULL + line="4809">an #ENamedParameters structure with credentials to use; can be %NULL to use those from the last call @@ -17100,7 +17179,7 @@ call e_source_invoke_authenticate_finish() to get the result of the operation. optional #GCancellable object, or %NULL + line="4811">optional #GCancellable object, or %NULL a #GAsyncReadyCallback to call when the request is satisfied + line="4812">a #GAsyncReadyCallback to call when the request is satisfied data to pass to the callback function + line="4813">data to pass to the callback function @@ -17131,27 +17210,27 @@ call e_source_invoke_authenticate_finish() to get the result of the operation. Finishes the operation started with e_source_invoke_authenticate(). + line="4847">Finishes the operation started with e_source_invoke_authenticate(). If an error occurs, the function sets @error and returns %FALSE. %TRUE on success, %FALSE on error + line="4857">%TRUE on success, %FALSE on error an #ESource + line="4849">an #ESource a #GAsyncResult + line="4850">a #GAsyncResult @@ -17159,10 +17238,11 @@ If an error occurs, the function sets @error and returns %FALSE. + throws="1" + glib:async-func="invoke_authenticate"> Calls the InvokeAuthenticate method on the server side, thus the backend + line="4699">Calls the InvokeAuthenticate method on the server side, thus the backend knows what credentials to use to connect to its (possibly remote) data store. If an error occurs, the function sets @error and returns %FALSE. @@ -17170,14 +17250,14 @@ If an error occurs, the function sets @error and returns %FALSE. %TRUE on success, %FALSE on error + line="4712">%TRUE on success, %FALSE on error an #ESource + line="4701">an #ESource allow-none="1"> an #ENamedParameters structure with credentials to use; can be %NULL + line="4702">an #ENamedParameters structure with credentials to use; can be %NULL to use those from the last call @@ -17196,17 +17276,19 @@ If an error occurs, the function sets @error and returns %FALSE. allow-none="1"> optional #GCancellable object, or %NULL + line="4704">optional #GCancellable object, or %NULL + version="3.16" + glib:finish-func="invoke_credentials_required_finish" + glib:sync-func="invoke_credentials_required_sync"> Asynchronously calls the InvokeCredentialsRequired method on the server side, + line="4621">Asynchronously calls the InvokeCredentialsRequired method on the server side, to inform clients that credentials are required. When the operation is finished, @callback will be called. You can then @@ -17219,26 +17301,26 @@ call e_source_invoke_credentials_required_finish() to get the result of the oper an #ESource + line="4623">an #ESource an #ESourceCredentialsReason, why the credentials are required + line="4624">an #ESourceCredentialsReason, why the credentials are required PEM-encoded secure connection certificate, or an empty string + line="4625">PEM-encoded secure connection certificate, or an empty string a bit-or of #GTlsCertificateFlags for secure connection certificate + line="4626">a bit-or of #GTlsCertificateFlags for secure connection certificate @@ -17248,7 +17330,7 @@ call e_source_invoke_credentials_required_finish() to get the result of the oper allow-none="1"> a #GError with a description of the previous credentials error, or %NULL + line="4627">a #GError with a description of the previous credentials error, or %NULL optional #GCancellable object, or %NULL + line="4628">optional #GCancellable object, or %NULL a #GAsyncReadyCallback to call when the request is satisfied + line="4629">a #GAsyncReadyCallback to call when the request is satisfied data to pass to the callback function + line="4630">data to pass to the callback function @@ -17288,27 +17370,27 @@ call e_source_invoke_credentials_required_finish() to get the result of the oper throws="1"> Finishes the operation started with e_source_invoke_credentials_required(). + line="4670">Finishes the operation started with e_source_invoke_credentials_required(). If an error occurs, the function sets @error and returns %FALSE. %TRUE on success, %FALSE on error + line="4680">%TRUE on success, %FALSE on error an #ESource + line="4672">an #ESource a #GAsyncResult + line="4673">a #GAsyncResult @@ -17316,10 +17398,11 @@ If an error occurs, the function sets @error and returns %FALSE. + throws="1" + glib:async-func="invoke_credentials_required"> Let's the client-side know that credentials are required. The @reason defines which + line="4456">Let's the client-side know that credentials are required. The @reason defines which parameters are used. The client passed the credentials with an e_source_invoke_authenticate() call. @@ -17341,33 +17424,33 @@ If an error occurs, the function sets @error and returns %FALSE. %TRUE on success, %FALSE on error + line="4485">%TRUE on success, %FALSE on error an #ESource + line="4458">an #ESource an #ESourceCredentialsReason, why the credentials are required + line="4459">an #ESourceCredentialsReason, why the credentials are required PEM-encoded secure connection certificate, or an empty string + line="4460">PEM-encoded secure connection certificate, or an empty string a bit-or of #GTlsCertificateFlags for secure connection certificate + line="4461">a bit-or of #GTlsCertificateFlags for secure connection certificate @@ -17377,7 +17460,7 @@ If an error occurs, the function sets @error and returns %FALSE. allow-none="1"> a #GError with a description of the previous credentials error, or %NULL + line="4462">a #GError with a description of the previous credentials error, or %NULL allow-none="1"> optional #GCancellable object, or %NULL + line="4463">optional #GCancellable object, or %NULL + version="3.12" + glib:finish-func="lookup_password_finish" + glib:sync-func="lookup_password_sync"> Asynchronously looks up a password for @source. Both the default and + line="4250">Asynchronously looks up a password for @source. Both the default and session keyrings are queried. This operation does not rely on the registry service and therefore works for any #ESource -- registered or "scratch". @@ -17411,7 +17496,7 @@ call e_source_lookup_password_finish() to get the result of the operation. an #ESource + line="4252">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="4253">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="4254">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="4255">data to pass to the callback function @@ -17451,7 +17536,7 @@ call e_source_lookup_password_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_lookup_password(). + line="4290">Finishes the operation started with e_source_lookup_password(). Note the boolean return value indicates whether the lookup operation itself completed successfully, not whether a password was found. If @@ -17462,20 +17547,20 @@ and returns %FALSE. %TRUE on success, %FALSE on error + line="4305">%TRUE on success, %FALSE on error an #ESource + line="4292">an #ESource a #GAsyncResult + line="4293">a #GAsyncResult allow-none="1"> return location for the password, or %NULL + line="4294">return location for the password, or %NULL @@ -17495,10 +17580,11 @@ and returns %FALSE. + throws="1" + glib:async-func="lookup_password"> Looks up a password for @source. Both the default and session keyrings + line="4188">Looks up a password for @source. Both the default and session keyrings are queried. This operation does not rely on the registry service and therefore works for any #ESource -- registered or "scratch". @@ -17511,14 +17597,14 @@ and returns %FALSE. %TRUE on success, %FALSE on error + line="4205">%TRUE on success, %FALSE on error an #ESource + line="4190">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="4191">optional #GCancellable object, or %NULL allow-none="1"> return location for the password, or %NULL + line="4192">return location for the password, or %NULL + version="3.6" + glib:finish-func="mail_signature_load_finish" + glib:sync-func="mail_signature_load_sync"> Asynchronously loads a signature from the signature file for @source, + line="538">Asynchronously loads a signature from the signature file for @source, which is given by e_source_mail_signature_get_file(). If the signature file is executable, it will be executed and its output @@ -17568,13 +17656,13 @@ the operation. an #ESource + line="540">an #ESource the I/O priority of the request + line="541">the I/O priority of the request allow-none="1"> optional #GCancellable object, or %NULL + line="542">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="543">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="544">data to pass to the callback function @@ -17614,7 +17702,7 @@ the operation. throws="1"> Finishes an operation started with e_source_mail_signature_load(). The + line="580">Finishes an operation started with e_source_mail_signature_load(). The signature file contents are placed in @contents, and @length is set to the size of the @contents string. The @contents string should be freed with g_free() when no longer needed. @@ -17623,20 +17711,20 @@ with g_free() when no longer needed. %TRUE on success, %FALSE on failure + line="594">%TRUE on success, %FALSE on failure an #ESource + line="582">an #ESource a #GAsyncResult + line="583">a #GAsyncResult transfer-ownership="full"> return location for the signature content + line="584">return location for the signature content allow-none="1"> return location for the length of the signature + line="585">return location for the length of the signature content, or %NULL if the length is not needed @@ -17665,10 +17753,11 @@ with g_free() when no longer needed. + throws="1" + glib:async-func="mail_signature_load"> Loads a signature from the signature file for @source, which is + line="347">Loads a signature from the signature file for @source, which is given by e_source_mail_signature_get_file(). The signature contents are placed in @contents, and @length is set to the size of the @contents string. The @contents string should be freed with g_free() when no @@ -17682,14 +17771,14 @@ executable, the email signature content is read directly from the file. %TRUE on success, %FALSE on failure + line="366">%TRUE on success, %FALSE on failure an #ESource + line="349">an #ESource transfer-ownership="full"> return location for the signature content + line="350">return location for the signature content allow-none="1"> return location for the length of the signature + line="351">return location for the length of the signature content, or %NULL if the length is not needed @@ -17719,17 +17808,19 @@ executable, the email signature content is read directly from the file. allow-none="1"> optional #GCancellable object, or %NULL + line="353">optional #GCancellable object, or %NULL + version="3.6" + glib:finish-func="mail_signature_replace_finish" + glib:sync-func="mail_signature_replace_sync"> Asynchrously replaces the signature file for @source with the given + line="683">Asynchrously replaces the signature file for @source with the given @contents of @length bytes. The signature file for @source is given by e_source_mail_signature_get_file(). @@ -17745,25 +17836,25 @@ of the operation. an #ESource + line="685">an #ESource the signature contents + line="686">the signature contents the length of @contents in bytes + line="687">the length of @contents in bytes the I/O priority of the request + line="688">the I/O priority of the request allow-none="1"> optional #GCancellable object, or %NULL + line="689">optional #GCancellable object, or %NULL closure="5"> a #GAsyncReadyCallback to call when the request is satisfied + line="690">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="691">data to pass to the callback function @@ -17803,26 +17894,26 @@ of the operation. throws="1"> Finishes an operation started with e_source_mail_signature_replace(). + line="727">Finishes an operation started with e_source_mail_signature_replace(). %TRUE on success, %FALSE on failure + line="735">%TRUE on success, %FALSE on failure an #ESource + line="729">an #ESource a #GAsyncResult + line="730">a #GAsyncResult @@ -17830,10 +17921,11 @@ of the operation. + throws="1" + glib:async-func="mail_signature_replace"> Replaces the signature file for @source with the given @contents + line="643">Replaces the signature file for @source with the given @contents of @length bytes. The signature file for @source is given by e_source_mail_signature_get_file(). %TRUE on success, %FALSE on failure + line="655">%TRUE on success, %FALSE on failure an #ESource + line="645">an #ESource the signature contents + line="646">the signature contents the length of @contents in bytes + line="647">the length of @contents in bytes allow-none="1"> optional #GCancellable object, or %NULL + line="648">optional #GCancellable object, or %NULL + version="3.6" + glib:finish-func="mail_signature_symlink_finish" + glib:sync-func="mail_signature_symlink_sync"> Asynchronously replaces the signature file for @source with a symbolic + line="814">Asynchronously replaces the signature file for @source with a symbolic link to @symlink_target, which should be an executable file that prints a mail signature to standard output. The signature file for @source is given by e_source_mail_signature_get_file(). @@ -17896,19 +17990,19 @@ of the operation. an #ESource + line="816">an #ESource executable filename to link to + line="817">executable filename to link to the I/O priority of the request + line="818">the I/O priority of the request allow-none="1"> optional #GCancellable object, or %NULL + line="819">optional #GCancellable object, or %NULL closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="820">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="821">data to pass to the callback function @@ -17948,26 +18042,26 @@ of the operation. throws="1"> Finishes an operation started with e_source_mail_signature_symlink(). + line="858">Finishes an operation started with e_source_mail_signature_symlink(). %TRUE on success, %FALSE on failure + line="866">%TRUE on success, %FALSE on failure an #ESource + line="860">an #ESource a #GAsyncResult + line="861">a #GAsyncResult @@ -17975,10 +18069,11 @@ of the operation. + throws="1" + glib:async-func="mail_signature_symlink"> Replaces the signature file for @source with a symbolic link to + line="771">Replaces the signature file for @source with a symbolic link to @symlink_target, which should be an executable file that prints a mail signature to standard output. The signature file for @source is given by e_source_mail_signature_get_file(). @@ -17987,20 +18082,20 @@ a mail signature to standard output. The signature file for %TRUE on success, %FALSE on failure + line="783">%TRUE on success, %FALSE on failure an #ESource + line="773">an #ESource executable filename to link to + line="774">executable filename to link to optional #GCancellable object, or %NULL + line="775">optional #GCancellable object, or %NULL + version="3.12" + glib:finish-func="proxy_lookup_finish" + glib:sync-func="proxy_lookup_sync"> Asynchronously determines what proxy, if any, to use to connect to @uri. + line="1769">Asynchronously determines what proxy, if any, to use to connect to @uri. See e_source_proxy_lookup_sync() for more details. When the operation is finished, @callback will be called. You can then @@ -18033,13 +18130,13 @@ call e_source_proxy_lookup_finish() to get the result of the operation. an #ESource + line="1771">an #ESource a URI representing the destination to connect to + line="1772">a URI representing the destination to connect to allow-none="1"> optional #GCancellable object, or %NULL + line="1773">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="1774">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="1775">data to pass to the callback function @@ -18079,7 +18176,7 @@ call e_source_proxy_lookup_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_proxy_lookup(). + line="1807">Finishes the operation started with e_source_proxy_lookup(). Free the returned proxy URIs with g_strfreev() when finished with them. a %NULL-terminated array of proxy + line="1817">a %NULL-terminated array of proxy URIs, or %NULL @@ -18097,13 +18194,13 @@ Free the returned proxy URIs with g_strfreev() when finished with them. an #ESource + line="1809">an #ESource a #GAsyncResult + line="1810">a #GAsyncResult @@ -18111,10 +18208,11 @@ Free the returned proxy URIs with g_strfreev() when finished with them. + throws="1" + glib:async-func="proxy_lookup"> Looks into @source's #ESourceProxy extension to determine what proxy, + line="1577">Looks into @source's #ESourceProxy extension to determine what proxy, if any, to use to connect to @uri. The returned proxy URIs are of the same form described by g_proxy_resolver_lookup(). @@ -18143,7 +18241,7 @@ Free the returned proxy URIs with g_strfreev() when finished with them. a %NULL-terminated array of proxy URIs, + line="1609">a %NULL-terminated array of proxy URIs, or %NULL @@ -18153,13 +18251,13 @@ Free the returned proxy URIs with g_strfreev() when finished with them. an #ESource + line="1579">an #ESource a URI representing the destination to connect to + line="1580">a URI representing the destination to connect to allow-none="1"> optional #GCancellable object, or %NULL + line="1581">optional #GCancellable object, or %NULL @@ -18178,7 +18276,7 @@ Free the returned proxy URIs with g_strfreev() when finished with them. version="3.6"> Returns the #GDBusObject that was passed to e_source_new(). + line="3088">Returns the #GDBusObject that was passed to e_source_new(). The returned #GDBusObject is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it. @@ -18186,14 +18284,14 @@ unreferenced with g_object_unref() when finished with it. the #GDBusObject for @source, or %NULL + line="3097">the #GDBusObject for @source, or %NULL an #ESource + line="3090">an #ESource @@ -18203,7 +18301,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Returns the #GMainContext on which event sources for @source are to + line="3118">Returns the #GMainContext on which event sources for @source are to be attached. The returned #GMainContext is referenced for thread-safety and must be @@ -18212,14 +18310,14 @@ unreferenced with g_main_context_unref() when finished with it. a #GMainContext + line="3128">a #GMainContext an #ESource + line="3120">an #ESource @@ -18387,10 +18485,12 @@ whose callback data pointer matches @user_data. + version="3.6" + glib:finish-func="remote_create_finish" + glib:sync-func="remote_create_sync"> Asynchronously creates a new remote resource by picking out relevant + line="3760">Asynchronously creates a new remote resource by picking out relevant details from @scratch_source. The @scratch_source must be an #ESource with no #GDBusObject. The @source must be #ESource:remote-creatable. @@ -18409,13 +18509,13 @@ call e_source_remote_create_finish() to get the result of the operation. an #ESource + line="3762">an #ESource an #ESource describing the resource to create + line="3763">an #ESource describing the resource to create allow-none="1"> optional #GCancellable object, or %NULL + line="3764">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="3765">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="3766">data to pass to the callback function @@ -18455,26 +18555,26 @@ call e_source_remote_create_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_remote_create(). If + line="3803">Finishes the operation started with e_source_remote_create(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3812">%TRUE on success, %FALSE on error an #ESource + line="3805">an #ESource a #GAsyncResult + line="3806">a #GAsyncResult @@ -18482,10 +18582,11 @@ an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="remote_create"> Creates a new remote resource by picking out relevant details from + line="3719">Creates a new remote resource by picking out relevant details from @scratch_source. The @scratch_source must be an #ESource with no #GDBusObject. The @source must be #ESource:remote-creatable. @@ -18499,20 +18600,20 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3737">%TRUE on success, %FALSE on error an #ESource + line="3721">an #ESource an #ESource describing the resource to create + line="3722">an #ESource describing the resource to create allow-none="1"> optional #GCancellable object, or %NULL + line="3723">optional #GCancellable object, or %NULL + version="3.6" + glib:finish-func="remote_delete_finish" + glib:sync-func="remote_delete_sync"> Asynchronously deletes the resource represented by @source from a remote + line="3865">Asynchronously deletes the resource represented by @source from a remote server. The @source must be #ESource:remote-deletable. This will also delete the key file for @source and broadcast its removal to all clients, similar to e_source_remove(). @@ -18546,7 +18649,7 @@ call e_source_remote_delete_finish() to get the result of the operation. an #ESource + line="3867">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3868">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="3869">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="3870">data to pass to the callback function @@ -18586,26 +18689,26 @@ call e_source_remote_delete_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_remote_delete(). If + line="3899">Finishes the operation started with e_source_remote_delete(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3908">%TRUE on success, %FALSE on error an #ESource + line="3901">an #ESource a #GAsyncResult + line="3902">a #GAsyncResult @@ -18613,10 +18716,11 @@ an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="remote_delete"> Deletes the resource represented by @source from a remote server. + line="3832">Deletes the resource represented by @source from a remote server. The @source must be #ESource:remote-deletable. This will also delete the key file for @source and broadcast its removal to all clients, similar to e_source_remove_sync(). @@ -18626,14 +18730,14 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3845">%TRUE on success, %FALSE on error an #ESource + line="3834">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3835">optional #GCancellable object, or %NULL - + Asynchronously requests the D-Bus service to delete the key files for + line="3561">Asynchronously requests the D-Bus service to delete the key files for @source and all of its descendants and broadcast their removal to all clients. The @source must be #ESource:removable. @@ -18664,7 +18772,7 @@ call e_source_remove_finish() to get the result of the operation. the #ESource to be removed + line="3563">the #ESource to be removed allow-none="1"> optional #GCancellable object, or %NULL + line="3564">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="3565">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="3566">data to pass to the callback function @@ -18704,26 +18812,26 @@ call e_source_remove_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_remove(). If an + line="3594">Finishes the operation started with e_source_remove(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE of failure + line="3603">%TRUE on success, %FALSE of failure the #ESource to be removed + line="3596">the #ESource to be removed a #GAsyncResult + line="3597">a #GAsyncResult @@ -18731,10 +18839,11 @@ error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="remove"> Requests the D-Bus service to delete the key files for @source and all of + line="3529">Requests the D-Bus service to delete the key files for @source and all of its descendants and broadcast their removal to all clients. The @source must be #ESource:removable. @@ -18743,14 +18852,14 @@ If an error occurs, the functon will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3541">%TRUE on success, %FALSE on error the #ESource to be removed + line="3531">the #ESource to be removed allow-none="1"> optional #GCancellable object, or %NULL + line="3532">optional #GCancellable object, or %NULL @@ -18769,7 +18878,7 @@ If an error occurs, the functon will set @error and return %FALSE. version="3.16"> Set's current connection status of the @source. + line="3480">Set's current connection status of the @source. @@ -18778,13 +18887,13 @@ If an error occurs, the functon will set @error and return %FALSE. an #ESource + line="3482">an #ESource one of the #ESourceConnectionStatus + line="3483">one of the #ESourceConnectionStatus @@ -18796,7 +18905,7 @@ If an error occurs, the functon will set @error and return %FALSE. version="3.6"> Sets the display name for @source. The @display_name argument must be a + line="3190">Sets the display name for @source. The @display_name argument must be a valid UTF-8 string. Use the display name to represent the #ESource in a user interface. @@ -18810,13 +18919,13 @@ and trailing whitespace. an #ESource + line="3192">an #ESource a display name + line="3193">a display name @@ -18827,7 +18936,7 @@ and trailing whitespace. version="3.6"> Enables or disables @source. + line="2788">Enables or disables @source. An application should try to honor this setting if at all possible, even if it does not provide a way to change the setting through its @@ -18840,13 +18949,13 @@ user interface. Disabled data sources should generally be hidden. an #ESource + line="2790">an #ESource whether to enable @source + line="2791">whether to enable @source @@ -18857,7 +18966,7 @@ user interface. Disabled data sources should generally be hidden. version="3.6"> Identifies the parent of @source by its unique identifier string. + line="2723">Identifies the parent of @source by its unique identifier string. This can only be set prior to adding @source to an #ESourceRegistry. The internal copy of #ESource:parent is automatically stripped of leading @@ -18871,7 +18980,7 @@ instead. an #ESource + line="2725">an #ESource allow-none="1"> the UID of the parent #ESource, or %NULL + line="2726">the UID of the parent #ESource, or %NULL + version="3.12" + glib:finish-func="store_password_finish" + glib:sync-func="store_password_sync"> Asynchronously stores a password for @source. This operation does + line="4111">Asynchronously stores a password for @source. This operation does not rely on the registry service and therefore works for any #ESource -- registered or "scratch". @@ -18908,19 +19019,19 @@ call e_source_store_password_finish() to get the result of the operation. an #ESource + line="4113">an #ESource the password to store + line="4114">the password to store store permanently or just for the session + line="4115">store permanently or just for the session allow-none="1"> optional #GCancellable object, or %NULL + line="4116">optional #GCancellable object, or %NULL closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="4117">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="4118">data to pass to the callback function @@ -18960,25 +19071,25 @@ call e_source_store_password_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_store_password(). + line="4161">Finishes the operation started with e_source_store_password(). %TRUE on success, %FALSE on error + line="4169">%TRUE on success, %FALSE on error an #ESource + line="4163">an #ESource a #GAsyncResult + line="4164">a #GAsyncResult @@ -18986,10 +19097,11 @@ call e_source_store_password_finish() to get the result of the operation. + throws="1" + glib:async-func="store_password"> Stores a password for @source. This operation does not rely on the + line="4041">Stores a password for @source. This operation does not rely on the registry service and therefore works for any #ESource -- registered or "scratch". @@ -19000,26 +19112,26 @@ an error occurs, the function sets @error and returns %FALSE. %TRUE on success, %FALSE on error + line="4057">%TRUE on success, %FALSE on error an #ESource + line="4043">an #ESource the password to store + line="4044">the password to store store permanently or just for the session + line="4045">store permanently or just for the session allow-none="1"> optional #GCancellable object, or %NULL + line="4046">optional #GCancellable object, or %NULL @@ -19036,20 +19148,20 @@ an error occurs, the function sets @error and returns %FALSE. Outputs the current contents of @source as a key file string. + line="3383">Outputs the current contents of @source as a key file string. Free the returned string with g_free(). a newly-allocated string + line="3392">a newly-allocated string an #ESource + line="3385">an #ESource allow-none="1"> return location for the length of the returned + line="3386">return location for the length of the returned string, or %NULL @@ -19068,10 +19180,12 @@ Free the returned string with g_free(). + version="3.18" + glib:finish-func="unset_last_credentials_required_arguments_finish" + glib:sync-func="unset_last_credentials_required_arguments_sync"> Asynchronously calls the UnsetLastCredentialsRequiredArguments method + line="5161">Asynchronously calls the UnsetLastCredentialsRequiredArguments method on the server side, to unset the last values used for the 'credentials-required' signal. @@ -19086,7 +19200,7 @@ the result of the operation. an #ESource + line="5163">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="5164">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="5165">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="5166">data to pass to the callback function @@ -19126,27 +19240,27 @@ the result of the operation. throws="1"> Finishes the operation started with e_source_unset_last_credentials_required_arguments(). + line="5196">Finishes the operation started with e_source_unset_last_credentials_required_arguments(). If an error occurs, the function sets @error and returns %FALSE. %TRUE on success, %FALSE on error + line="5206">%TRUE on success, %FALSE on error an #ESource + line="5198">an #ESource a #GAsyncResult + line="5199">a #GAsyncResult @@ -19154,24 +19268,25 @@ If an error occurs, the function sets @error and returns %FALSE. + throws="1" + glib:async-func="unset_last_credentials_required_arguments"> Unsets the last used arguments of the 'credentials-required' signal emission. + line="5113">Unsets the last used arguments of the 'credentials-required' signal emission. If an error occurs, the function sets @error and returns %FALSE. %TRUE on success, %FALSE on error + line="5123">%TRUE on success, %FALSE on error an #ESource + line="5115">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="5116">optional #GCancellable object, or %NULL - + Asynchronously submits the current contents of @source to the D-Bus + line="3656">Asynchronously submits the current contents of @source to the D-Bus service to be written to disk and broadcast to other clients. The @source must be #ESource:writable. @@ -19202,7 +19321,7 @@ call e_source_write_finish() to get the result of the operation. a writable #ESource + line="3658">a writable #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3659">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="3660">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="3661">data to pass to the callback function @@ -19242,26 +19361,26 @@ call e_source_write_finish() to get the result of the operation. throws="1"> Finishes the operation started with e_source_write(). If an + line="3689">Finishes the operation started with e_source_write(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3698">%TRUE on success, %FALSE on error a writable #ESource + line="3691">a writable #ESource a #GAsyncResult + line="3692">a #GAsyncResult @@ -19269,10 +19388,11 @@ error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="write"> Submits the current contents of @source to the D-Bus service to be + line="3624">Submits the current contents of @source to the D-Bus service to be written to disk and broadcast to other clients. The @source must be #ESource:writable. @@ -19281,14 +19401,14 @@ If an error occurs, the functon will set @error and return %FALSE. %TRUE on success, %FALSE on error + line="3636">%TRUE on success, %FALSE on error a writable #ESource + line="3626">a writable #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3627">optional #GCancellable object, or %NULL @@ -19388,7 +19508,7 @@ If an error occurs, the functon will set @error and return %FALSE. Let's the backend know provided credentials to use to login + line="2326">Let's the backend know provided credentials to use to login to (possibly remote) data store. @@ -19397,7 +19517,7 @@ to (possibly remote) data store. an #ENamedParameters with provided credentials + line="2329">an #ENamedParameters with provided credentials @@ -19405,7 +19525,7 @@ to (possibly remote) data store. The ::changed signal is emitted when a property in @source or + line="2284">The ::changed signal is emitted when a property in @source or one of its extension objects changes. A common use for this signal is to notify a #GtkTreeModel containing data collected from #ESource<!-- -->s that it needs to update a row. @@ -19416,7 +19536,7 @@ from #ESource<!-- -->s that it needs to update a row. The ::credentials-required signal is emitted when the @source + line="2301">The ::credentials-required signal is emitted when the @source requires credentials to connect to (possibly remote) data store. The credentials can be passed to the backend using e_source_invoke_authenticate() function. @@ -19427,25 +19547,25 @@ e_source_invoke_authenticate() function. an #ESourceCredentialsReason indicating why the credentials are requested + line="2304">an #ESourceCredentialsReason indicating why the credentials are requested PEM-encoded secure connection certificate for failed SSL/TLS checks + line="2305">PEM-encoded secure connection certificate for failed SSL/TLS checks what failed with the SSL/TLS certificate + line="2306">what failed with the SSL/TLS certificate a text description of the error, if any + line="2307">a text description of the error, if any @@ -19565,7 +19685,7 @@ functions below. version="3.6"> Thread-safe variation of e_source_alarms_get_last_notified(). + line="263">Thread-safe variation of e_source_alarms_get_last_notified(). Use this function when accessing @extension from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -19574,14 +19694,42 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESourceAlarms:last-notified + line="272">a newly-allocated copy of #ESourceAlarms:last-notified an #ESourceAlarms + line="265">an #ESourceAlarms + + + + + + Returns whether the user should be alerted about all upcoming appointments +in the calendar described by the #ESource to which @extension belongs. + +This is used in addition to the GSettings key defall-reminder-enabled +in org.gnome.evolution-data-server.calendar. + + + whether to show alarms for every event + + + + + an #ESourceAlarms @@ -19592,7 +19740,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.6"> Returns whether the user should be alerted about upcoming appointments + line="193">Returns whether the user should be alerted about upcoming appointments in the calendar described by the #ESource to which @extension belongs. Alarm daemons such as evolution-alarm-notify can use this property to @@ -19602,14 +19750,14 @@ decide which calendars to query for upcoming appointments. whether to show alarms for upcoming appointments + line="203">whether to show alarms for upcoming appointments an #ESourceAlarms + line="195">an #ESourceAlarms @@ -19620,7 +19768,7 @@ decide which calendars to query for upcoming appointments. version="3.6"> Returns an ISO 8601 formatted timestamp of when the user was last + line="242">Returns an ISO 8601 formatted timestamp of when the user was last alerted about an upcoming appointment in the calendar described by the #ESource to which @extension belongs. If no valid timestamp has been set, the function will return %NULL. @@ -19629,16 +19777,47 @@ has been set, the function will return %NULL. an ISO 8601 timestamp, or %NULL + line="251">an ISO 8601 timestamp, or %NULL an #ESourceAlarms + line="244">an #ESourceAlarms + + + + + + Sets whether the user should be alerted about every event in +the calendar described by the #ESource to which @extension belongs. + +This is used in addition to the GSettings key defall-reminder-enabled +in org.gnome.evolution-data-server.calendar. + + + + + + + an #ESourceAlarms + + whether to show alarms for every event + + version="3.6"> Sets whether the user should be alerted about upcoming appointments in + line="215">Sets whether the user should be alerted about upcoming appointments in the calendar described by the #ESource to which @extension belongs. Alarm daemons such as evolution-alarm-notify can use this property to @@ -19661,13 +19840,13 @@ decide which calendars to query for upcoming appointments. an #ESourceAlarms + line="217">an #ESourceAlarms whether to show alarms for upcoming appointments + line="218">whether to show alarms for upcoming appointments @@ -19678,7 +19857,7 @@ decide which calendars to query for upcoming appointments. version="3.6"> Sets an ISO 8601 formatted timestamp of when the user was last + line="294">Sets an ISO 8601 formatted timestamp of when the user was last alerted about an upcoming appointment in the calendar described by the #ESource to which @extension belongs. @@ -19697,7 +19876,7 @@ such as evolution-alarm-notify. an #ESourceAlarms + line="296">an #ESourceAlarms allow-none="1"> an ISO 8601 timestamp, or %NULL + line="297">an ISO 8601 timestamp, or %NULL + + + an #ESource + line="2591">an #ESource @@ -21238,14 +21426,14 @@ See e_source_camel_configure_service(). %TRUE on success, %FALSE on error + line="3541">%TRUE on success, %FALSE on error the #ESource to be removed + line="3531">the #ESource to be removed allow-none="1"> optional #GCancellable object, or %NULL + line="3532">optional #GCancellable object, or %NULL @@ -21271,7 +21459,7 @@ See e_source_camel_configure_service(). the #ESource to be removed + line="3563">the #ESource to be removed allow-none="1"> optional #GCancellable object, or %NULL + line="3564">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="3565">a #GAsyncReadyCallback to call when the request is satisfied @@ -21302,7 +21490,7 @@ See e_source_camel_configure_service(). closure="3"> data to pass to the callback function + line="3566">data to pass to the callback function @@ -21315,20 +21503,20 @@ See e_source_camel_configure_service(). %TRUE on success, %FALSE of failure + line="3603">%TRUE on success, %FALSE of failure the #ESource to be removed + line="3596">the #ESource to be removed a #GAsyncResult + line="3597">a #GAsyncResult @@ -21341,14 +21529,14 @@ See e_source_camel_configure_service(). %TRUE on success, %FALSE on error + line="3636">%TRUE on success, %FALSE on error a writable #ESource + line="3626">a writable #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3627">optional #GCancellable object, or %NULL @@ -21374,7 +21562,7 @@ See e_source_camel_configure_service(). a writable #ESource + line="3658">a writable #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3659">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="3660">a #GAsyncReadyCallback to call when the request is satisfied @@ -21405,7 +21593,7 @@ See e_source_camel_configure_service(). closure="3"> data to pass to the callback function + line="3661">data to pass to the callback function @@ -21418,20 +21606,20 @@ See e_source_camel_configure_service(). %TRUE on success, %FALSE on error + line="3698">%TRUE on success, %FALSE on error a writable #ESource + line="3691">a writable #ESource a #GAsyncResult + line="3692">a #GAsyncResult @@ -21444,20 +21632,20 @@ See e_source_camel_configure_service(). %TRUE on success, %FALSE on error + line="3737">%TRUE on success, %FALSE on error an #ESource + line="3721">an #ESource an #ESource describing the resource to create + line="3722">an #ESource describing the resource to create allow-none="1"> optional #GCancellable object, or %NULL + line="3723">optional #GCancellable object, or %NULL @@ -21483,13 +21671,13 @@ See e_source_camel_configure_service(). an #ESource + line="3762">an #ESource an #ESource describing the resource to create + line="3763">an #ESource describing the resource to create allow-none="1"> optional #GCancellable object, or %NULL + line="3764">optional #GCancellable object, or %NULL closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="3765">a #GAsyncReadyCallback to call when the request is satisfied @@ -21520,7 +21708,7 @@ See e_source_camel_configure_service(). closure="4"> data to pass to the callback function + line="3766">data to pass to the callback function @@ -21533,20 +21721,20 @@ See e_source_camel_configure_service(). %TRUE on success, %FALSE on error + line="3812">%TRUE on success, %FALSE on error an #ESource + line="3805">an #ESource a #GAsyncResult + line="3806">a #GAsyncResult @@ -21559,14 +21747,14 @@ See e_source_camel_configure_service(). %TRUE on success, %FALSE on error + line="3845">%TRUE on success, %FALSE on error an #ESource + line="3834">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3835">optional #GCancellable object, or %NULL @@ -21592,7 +21780,7 @@ See e_source_camel_configure_service(). an #ESource + line="3867">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3868">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="3869">a #GAsyncReadyCallback to call when the request is satisfied @@ -21623,7 +21811,7 @@ See e_source_camel_configure_service(). closure="3"> data to pass to the callback function + line="3870">data to pass to the callback function @@ -21636,20 +21824,20 @@ See e_source_camel_configure_service(). %TRUE on success, %FALSE on error + line="3908">%TRUE on success, %FALSE on error an #ESource + line="3901">an #ESource a #GAsyncResult + line="3902">a #GAsyncResult @@ -21662,14 +21850,14 @@ See e_source_camel_configure_service(). %TRUE on success, %FALSE on error + line="3944">%TRUE on success, %FALSE on error an #ESource + line="3930">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3931">optional #GCancellable object, or %NULL allow-none="1"> return location for the access token, + line="3932">return location for the access token, or %NULL @@ -21701,7 +21889,7 @@ See e_source_camel_configure_service(). allow-none="1"> return location for the token expiry, + line="3934">return location for the token expiry, or %NULL @@ -21719,7 +21907,7 @@ See e_source_camel_configure_service(). an #ESource + line="3969">an #ESource allow-none="1"> optional #GCancellable object, or %NULL + line="3970">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request + line="3971">a #GAsyncReadyCallback to call when the request is satisfied @@ -21751,7 +21939,7 @@ See e_source_camel_configure_service(). closure="3"> data to pass to the callback function + line="3973">data to pass to the callback function @@ -21764,20 +21952,20 @@ See e_source_camel_configure_service(). %TRUE on success, %FALSE on error + line="4017">%TRUE on success, %FALSE on error an #ESource + line="4004">an #ESource a #GAsyncResult + line="4005">a #GAsyncResult allow-none="1"> return location for the access token, + line="4006">return location for the access token, or %NULL @@ -21800,7 +21988,7 @@ See e_source_camel_configure_service(). allow-none="1"> return location for the token expiry, + line="4008">return location for the token expiry, or %NULL @@ -22767,7 +22955,9 @@ e_source_credentials_provider_store_sync() will fail for this @source. + version="3.16" + glib:finish-func="delete_finish" + glib:sync-func="delete_sync"> Asynchronously deletes any previously stored credentials for @source. @@ -22861,7 +23051,8 @@ If an error occurs, the function sets @error and returns %FALSE. + throws="1" + glib:async-func="delete"> Deletes any previously stored credentials for @source. @@ -22902,7 +23093,9 @@ If an error occurs, the function sets @error and returns %FALSE. + version="3.16" + glib:finish-func="lookup_finish" + glib:sync-func="lookup_sync"> Asynchronously looks up for credentials for @source. @@ -23005,7 +23198,8 @@ If an error occurs, the function sets @error and returns %FALSE. + throws="1" + glib:async-func="lookup"> Looks up the credentials for @source. @@ -23180,7 +23374,9 @@ the @provider_impl. + version="3.16" + glib:finish-func="store_finish" + glib:sync-func="store_sync"> Asynchronously stores the @credentials for @source. Note the actual stored @@ -23288,7 +23484,8 @@ If an error occurs, the function sets @error and returns %FALSE. + throws="1" + glib:async-func="store"> Stores the @credentials for @source. Note the actual stored values @@ -27746,7 +27943,7 @@ function below. version="3.6"> Thread-safe variation of e_source_mail_signature_get_mime_type(). + line="255">Thread-safe variation of e_source_mail_signature_get_mime_type(). Use this function when accessing @extension from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -27755,7 +27952,7 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESourceMailSignature:mime-type, + line="264">a newly-allocated copy of #ESourceMailSignature:mime-type, or %NULL @@ -27763,7 +27960,7 @@ The returned string should be freed with g_free() when no longer needed. an #ESourceMailSignature + line="257">an #ESourceMailSignature @@ -27774,7 +27971,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.6"> Returns a #GFile instance pointing to the signature file for @extension. + line="210">Returns a #GFile instance pointing to the signature file for @extension. The signature file may be a regular file containing the static signature content, or it may be a symbolic link to an executable file that produces the signature content. @@ -27785,14 +27982,14 @@ e_source_mail_signature_load() uses this to load the signature content. a #GFile + line="221">a #GFile an #ESourceMailSignature + line="212">an #ESourceMailSignature @@ -27803,7 +28000,7 @@ e_source_mail_signature_load() uses this to load the signature content. version="3.6"> Returns the MIME type of the signature content for @extension, or %NULL + line="233">Returns the MIME type of the signature content for @extension, or %NULL if it has not yet been determined. e_source_mail_signature_load() sets this automatically if the MIME type @@ -27813,14 +28010,14 @@ has not yet been determined. the MIME type of the signature content, or %NULL + line="243">the MIME type of the signature content, or %NULL an #ESourceMailSignature + line="235">an #ESourceMailSignature @@ -27831,7 +28028,7 @@ has not yet been determined. version="3.6"> Sets the MIME type of the signature content for @extension. + line="287">Sets the MIME type of the signature content for @extension. e_source_mail_signature_load() sets this automatically if the MIME type has not yet been determined. @@ -27848,7 +28045,7 @@ set instead. an #ESourceMailSignature + line="289">an #ESourceMailSignature allow-none="1"> a MIME type, or %NULL + line="290">a MIME type, or %NULL @@ -28437,7 +28634,7 @@ functions below. version="3.6"> Thread-safe variation of e_source_openpgp_get_key_id(). + line="533">Thread-safe variation of e_source_openpgp_get_key_id(). Use this function when accessing @extension from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -28446,14 +28643,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESourceOpenPGP:key-id + line="542">a newly-allocated copy of #ESourceOpenPGP:key-id an #ESourceOpenPGP + line="535">an #ESourceOpenPGP @@ -28463,7 +28660,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.6"> Thread-safe variation of e_source_openpgp_get_signing_algorithm(). + line="617">Thread-safe variation of e_source_openpgp_get_signing_algorithm(). Use this function when accessing @extension from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -28472,14 +28669,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESourceOpenPGP:signing-algorithm + line="626">a newly-allocated copy of #ESourceOpenPGP:signing-algorithm an #ESourceOpenPGP + line="619">an #ESourceOpenPGP @@ -28490,21 +28687,45 @@ The returned string should be freed with g_free() when no longer needed. version="3.6"> Returns whether to skip key validation and assume that used keys are + line="431">Returns whether to skip key validation and assume that used keys are always fully trusted. whether used keys are always fully trusted + line="438">whether used keys are always fully trusted an #ESourceOpenPGP + line="433">an #ESourceOpenPGP + + + + + + Returns, whether should ask before sending PGP public key in messages. The default is %TRUE. + + + whether should ask before sending PGP public key in messages + + + + + an #ESourceOpenPGP @@ -28515,21 +28736,21 @@ always fully trusted. version="3.18"> Returns whether to digitally encrypt outgoing messages by default using + line="727">Returns whether to digitally encrypt outgoing messages by default using OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). whether to encrypt outgoing messages by default + line="734">whether to encrypt outgoing messages by default an #ESourceOpenPGP + line="729">an #ESourceOpenPGP @@ -28540,20 +28761,20 @@ OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). version="3.6"> Returns whether to "encrypt-to-self" when sending encrypted messages. + line="474">Returns whether to "encrypt-to-self" when sending encrypted messages. whether to "encrypt-to-self" + line="480">whether to "encrypt-to-self" an #ESourceOpenPGP + line="476">an #ESourceOpenPGP @@ -28564,20 +28785,20 @@ OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). version="3.6"> Returns the OpenPGP key ID used to sign and encrypt messages. + line="515">Returns the OpenPGP key ID used to sign and encrypt messages. the key ID used to sign and encrypt messages + line="521">the key ID used to sign and encrypt messages an #ESourceOpenPGP + line="517">an #ESourceOpenPGP @@ -28588,14 +28809,14 @@ OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). version="3.46"> Returns, whether gpg can locate keys using Web Key Directory (WKD) lookup + line="811">Returns, whether gpg can locate keys using Web Key Directory (WKD) lookup when encrypting messages. The default is %TRUE. whether gpg can locate keys using Web Key Directory (WKD) lookup + line="818">whether gpg can locate keys using Web Key Directory (WKD) lookup when encrypting messages. @@ -28603,7 +28824,7 @@ when encrypting messages. The default is %TRUE. an #ESourceOpenPGP + line="813">an #ESourceOpenPGP @@ -28614,20 +28835,20 @@ when encrypting messages. The default is %TRUE. version="3.20"> Returns whether to prefer inline sign/encrypt of the text/plain messages. + line="770">Returns whether to prefer inline sign/encrypt of the text/plain messages. whether to prefer inline sign/encrypt of the text/plain messages + line="776">whether to prefer inline sign/encrypt of the text/plain messages an #ESourceOpenPGP + line="772">an #ESourceOpenPGP @@ -28638,14 +28859,14 @@ when encrypting messages. The default is %TRUE. version="3.50"> Returns, whether should claim the encryption is preferred when sending + line="899">Returns, whether should claim the encryption is preferred when sending public key in messages. The default is %TRUE. whether should claim the encryption is preferred when sending + line="906">whether should claim the encryption is preferred when sending public key in messages @@ -28653,7 +28874,7 @@ public key in messages. The default is %TRUE. an #ESourceOpenPGP + line="901">an #ESourceOpenPGP @@ -28664,20 +28885,20 @@ public key in messages. The default is %TRUE. version="3.50"> Returns, whether should send GPG public key in messages. The default is %TRUE. + line="857">Returns, whether should send PGP public key in messages. The default is %TRUE. whether should send GPG public key in messages + line="863">whether should send PGP public key in messages an #ESourceOpenPGP + line="859">an #ESourceOpenPGP @@ -28688,21 +28909,21 @@ public key in messages. The default is %TRUE. version="3.6"> Returns whether to digitally sign outgoing messages by default using + line="684">Returns whether to digitally sign outgoing messages by default using OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). whether to sign outgoing messages by default + line="691">whether to sign outgoing messages by default an #ESourceOpenPGP + line="686">an #ESourceOpenPGP @@ -28713,21 +28934,21 @@ OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). version="3.6"> Returns the name of the hash algorithm used to digitally sign outgoing + line="598">Returns the name of the hash algorithm used to digitally sign outgoing messages. the signing algorithm for outgoing messages + line="605">the signing algorithm for outgoing messages an #ESourceOpenPGP + line="600">an #ESourceOpenPGP @@ -28738,7 +28959,7 @@ messages. version="3.6"> Sets whether to skip key validation and assume that used keys are + line="450">Sets whether to skip key validation and assume that used keys are always fully trusted. @@ -28749,13 +28970,41 @@ always fully trusted. an #ESourceOpenPGP + line="452">an #ESourceOpenPGP whether used keys are always fully trusted + line="453">whether used keys are always fully trusted + + + + + + Sets the @ask_send_public_key on the @extension, which tells the client to +ask before user sends public key in the messages in an Autocrypt header. + + + + + + + an #ESourceOpenPGP + + + + value to set @@ -28766,7 +29015,7 @@ always fully trusted. version="3.18"> Sets whether to digitally encrypt outgoing messages by default using + line="746">Sets whether to digitally encrypt outgoing messages by default using OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). @@ -28777,13 +29026,13 @@ OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). an #ESourceOpenPGP + line="748">an #ESourceOpenPGP whether to encrypt outgoing messages by default + line="749">whether to encrypt outgoing messages by default @@ -28794,7 +29043,7 @@ OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). version="3.6"> Sets whether to "encrypt-to-self" when sending encrypted messages. + line="492">Sets whether to "encrypt-to-self" when sending encrypted messages. @@ -28804,13 +29053,13 @@ OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). an #ESourceOpenPGP + line="494">an #ESourceOpenPGP whether to "encrypt-to-self" + line="495">whether to "encrypt-to-self" @@ -28821,7 +29070,7 @@ OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). version="3.6"> Sets the OpenPGP key ID used to sign and encrypt messages. + line="564">Sets the OpenPGP key ID used to sign and encrypt messages. The internal copy of @key_id is automatically stripped of leading and trailing whitespace. If the resulting string is empty, %NULL is set @@ -28835,13 +29084,13 @@ instead. an #ESourceOpenPGP + line="566">an #ESourceOpenPGP the key ID used to sign and encrypt messages + line="567">the key ID used to sign and encrypt messages @@ -28852,7 +29101,7 @@ instead. version="3.46"> Sets the @locate_keys on the @extension, which is used to instruct + line="832">Sets the @locate_keys on the @extension, which is used to instruct gpg to locate keys using Web Key Directory (WKD) lookup when encrypting messages. an #ESourceOpenPGP + line="834">an #ESourceOpenPGP value to set + line="835">value to set @@ -28881,7 +29130,7 @@ messages. version="3.20"> Sets whether to prefer inline sign/encrypt of the text/plain messages. + line="788">Sets whether to prefer inline sign/encrypt of the text/plain messages. @@ -28891,13 +29140,13 @@ messages. an #ESourceOpenPGP + line="790">an #ESourceOpenPGP whether to prefer inline sign/encrypt of the text/plain messages + line="791">whether to prefer inline sign/encrypt of the text/plain messages @@ -28908,7 +29157,7 @@ messages. version="3.50"> Sets the @send_prefer_encrypt on the @extension, which tells the client to + line="919">Sets the @send_prefer_encrypt on the @extension, which tells the client to claim the user prefer encryption when also sending its public key in the messages (e_source_openpgp_set_send_public_key()). an #ESourceOpenPGP + line="921">an #ESourceOpenPGP value to set + line="922">value to set @@ -28937,7 +29186,7 @@ the messages (e_source_openpgp_set_send_public_key()). version="3.50"> Sets the @send_public_key on the @extension, which tells the client to + line="875">Sets the @send_public_key on the @extension, which tells the client to include user's public key in the messages in an Autocrypt header. @@ -28948,13 +29197,13 @@ include user's public key in the messages in an Autocrypt header. an #ESourceOpenPGP + line="877">an #ESourceOpenPGP value to set + line="878">value to set @@ -28965,7 +29214,7 @@ include user's public key in the messages in an Autocrypt header. version="3.6"> Sets whether to digitally sign outgoing messages by default using + line="703">Sets whether to digitally sign outgoing messages by default using OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). @@ -28976,13 +29225,13 @@ OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). an #ESourceOpenPGP + line="705">an #ESourceOpenPGP whether to sign outgoing messages by default + line="706">whether to sign outgoing messages by default @@ -28993,7 +29242,7 @@ OpenPGP-compliant software such as GNU Privacy Guard (GnuPG). version="3.6"> Sets the name of the hash algorithm used to digitally sign outgoing + line="648">Sets the name of the hash algorithm used to digitally sign outgoing messages. The internal copy of @signing_algorithm is automatically stripped of @@ -29008,13 +29257,13 @@ leading and trailing whitespace. If the resulting string is empty, an #ESourceOpenPGP + line="650">an #ESourceOpenPGP the signing algorithm for outgoing messages + line="651">the signing algorithm for outgoing messages @@ -29028,6 +29277,15 @@ leading and trailing whitespace. If the resulting string is empty, default-value="FALSE"> + + + version="3.12"> Thread-safe variation of e_source_proxy_get_autoconfig_url(). + line="705">Thread-safe variation of e_source_proxy_get_autoconfig_url(). Use this function when accessing @extension from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -29166,14 +29424,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESourceProxy:autoconfig-url + line="714">a newly-allocated copy of #ESourceProxy:autoconfig-url an #ESourceProxy + line="707">an #ESourceProxy @@ -29183,7 +29441,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.12"> Thread-safe variation of e_source_proxy_get_ftp_host(). + line="887">Thread-safe variation of e_source_proxy_get_ftp_host(). Use this function when accessing @extension from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -29192,14 +29450,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESourceProxy:ftp-host + line="896">a newly-allocated copy of #ESourceProxy:ftp-host an #ESourceProxy + line="889">an #ESourceProxy @@ -29209,7 +29467,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.12"> Thread-safe variation of e_source_proxy_get_http_auth_password(). + line="1267">Thread-safe variation of e_source_proxy_get_http_auth_password(). Use this function when accessing @extension from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -29218,14 +29476,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESourceProxy:http-auth-password + line="1276">a newly-allocated copy of #ESourceProxy:http-auth-password an #ESourceProxy + line="1269">an #ESourceProxy @@ -29235,7 +29493,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.12"> Thread-safe variation of e_source_proxy_get_http_auth_user(). + line="1186">Thread-safe variation of e_source_proxy_get_http_auth_user(). Use this function when accessing @extension from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -29244,14 +29502,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESourceProxy:http-auth-user + line="1195">a newly-allocated copy of #ESourceProxy:http-auth-user an #ESourceProxy + line="1188">an #ESourceProxy @@ -29261,7 +29519,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.12"> Thread-safe variation of e_source_proxy_get_http_host(). + line="1011">Thread-safe variation of e_source_proxy_get_http_host(). Use this function when accessing @extension from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -29270,14 +29528,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESourceProxy:http-host + line="1020">a newly-allocated copy of #ESourceProxy:http-host an #ESourceProxy + line="1013">an #ESourceProxy @@ -29287,7 +29545,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.12"> Threads-safe variation of e_source_proxy_get_https_host(). + line="1348">Threads-safe variation of e_source_proxy_get_https_host(). Use this function when accessing @extension from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -29296,14 +29554,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESourceProxy:https-host + line="1357">a newly-allocated copy of #ESourceProxy:https-host an #ESourceProxy + line="1350">an #ESourceProxy @@ -29313,7 +29571,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.12"> Thread-safe variation of e_source_proxy_get_ignore_hosts(). + line="793">Thread-safe variation of e_source_proxy_get_ignore_hosts(). Use this function when accessing @extension from multiple threads. The returned string array should be freed with g_strfreev() when no @@ -29323,7 +29581,7 @@ longer needed. a newly-allocated copy of + line="803">a newly-allocated copy of #ESourceProxy:ignore-hosts @@ -29333,7 +29591,7 @@ longer needed. an #ESourceProxy + line="795">an #ESourceProxy @@ -29343,7 +29601,7 @@ longer needed. version="3.12"> Thread-safe variation of e_source_proxy_get_socks_host(). + line="1472">Thread-safe variation of e_source_proxy_get_socks_host(). Use this function when accessing @extension from multiple threads. The returned string should be freed with g_free() when no longer needed. @@ -29352,14 +29610,14 @@ The returned string should be freed with g_free() when no longer needed. a newly-allocated copy of #ESourceProxy:socks-host + line="1481">a newly-allocated copy of #ESourceProxy:socks-host an #ESourceProxy + line="1474">an #ESourceProxy @@ -29370,7 +29628,7 @@ The returned string should be freed with g_free() when no longer needed. version="3.12"> Returns the URL that provides proxy configuration values. When the + line="685">Returns the URL that provides proxy configuration values. When the @extension's #ESourceProxy:method is @E_PROXY_METHOD_AUTO, this URL is used to look up proxy information for all protocols. the autoconfiguration URL + line="693">the autoconfiguration URL an #ESourceProxy + line="687">an #ESourceProxy @@ -29396,21 +29654,21 @@ is used to look up proxy information for all protocols. version="3.12"> Returns the machine name to proxy FTP through when @extension's + line="868">Returns the machine name to proxy FTP through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. FTP proxy host name + line="875">FTP proxy host name an #ESourceProxy + line="870">an #ESourceProxy @@ -29421,21 +29679,21 @@ is used to look up proxy information for all protocols. version="3.12"> Returns the port on the machine defined by #ESourceProxy:ftp-host to proxy + line="949">Returns the port on the machine defined by #ESourceProxy:ftp-host to proxy through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. FTP proxy port + line="956">FTP proxy port an #ESourceProxy + line="951">an #ESourceProxy @@ -29446,21 +29704,21 @@ through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. version="3.12"> Returns the password to pass as authentication when doing HTTP proxying + line="1248">Returns the password to pass as authentication when doing HTTP proxying and #ESourceProxy:http-use-auth is %TRUE. HTTP proxy password + line="1255">HTTP proxy password an #ESourceProxy + line="1250">an #ESourceProxy @@ -29471,21 +29729,21 @@ and #ESourceProxy:http-use-auth is %TRUE. version="3.12"> Returns the user name to pass as authentication when doing HTTP proxying + line="1167">Returns the user name to pass as authentication when doing HTTP proxying and #ESourceProxy:http-use-auth is %TRUE. HTTP proxy username + line="1174">HTTP proxy username an #ESourceProxy + line="1169">an #ESourceProxy @@ -29496,21 +29754,21 @@ and #ESourceProxy:http-use-auth is %TRUE. version="3.12"> Returns the machine name to proxy HTTP through when @extension's + line="992">Returns the machine name to proxy HTTP through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. HTTP proxy host name + line="999">HTTP proxy host name an #ESourceProxy + line="994">an #ESourceProxy @@ -29521,21 +29779,21 @@ and #ESourceProxy:http-use-auth is %TRUE. version="3.12"> Returns the port on the machine defined by #ESourceProxy:http-host to proxy + line="1073">Returns the port on the machine defined by #ESourceProxy:http-host to proxy through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. HTTP proxy port + line="1080">HTTP proxy port an #ESourceProxy + line="1075">an #ESourceProxy @@ -29546,7 +29804,7 @@ through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. version="3.12"> Returns whether the HTTP proxy server at #ESourceProxy:http-host and + line="1116">Returns whether the HTTP proxy server at #ESourceProxy:http-host and #ESourceProxy:http-port requires authentication. The username/password combo is defined by #ESourceProxy:http-auth-user @@ -29557,14 +29815,14 @@ and #ESourceProxy:http-auth-password, but only applies when @extension's whether to authenticate HTTP proxy connections + line="1127">whether to authenticate HTTP proxy connections an #ESourceProxy + line="1118">an #ESourceProxy @@ -29575,21 +29833,21 @@ and #ESourceProxy:http-auth-password, but only applies when @extension's version="3.12"> Returns the machine name to proxy secure HTTP through when @extension's + line="1329">Returns the machine name to proxy secure HTTP through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. secure HTTP proxy host name + line="1336">secure HTTP proxy host name an #ESourceProxy + line="1331">an #ESourceProxy @@ -29600,21 +29858,21 @@ and #ESourceProxy:http-auth-password, but only applies when @extension's version="3.12"> Returns the port on the machine defined by #ESourceProxy:https-host to proxy + line="1410">Returns the port on the machine defined by #ESourceProxy:https-host to proxy through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. secure HTTP proxy port + line="1417">secure HTTP proxy port an #ESourceProxy + line="1412">an #ESourceProxy @@ -29625,7 +29883,7 @@ through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. version="3.12"> Returns a %NULL-terminated string array of hosts which are connected to + line="768">Returns a %NULL-terminated string array of hosts which are connected to directly, rather than via the proxy (if it is active). The array elements can be hostnames, domains (using an initial wildcard like *.foo.com), IP host addresses (both IPv4 and IPv6) and network addresses with a netmask @@ -29638,7 +29896,7 @@ freed. a %NULL-terminated string array of hosts + line="781">a %NULL-terminated string array of hosts @@ -29647,7 +29905,7 @@ freed. an #ESourceProxy + line="770">an #ESourceProxy @@ -29658,7 +29916,7 @@ freed. version="3.12"> Returns the proxy configuration method for @extension. + line="636">Returns the proxy configuration method for @extension. The proxy configuration method determines the behavior of e_source_proxy_lookup(). @@ -29667,14 +29925,14 @@ e_source_proxy_lookup(). the proxy configuration method + line="645">the proxy configuration method an #ESourceProxy + line="638">an #ESourceProxy @@ -29685,21 +29943,21 @@ e_source_proxy_lookup(). version="3.12"> Returns the machine name to use as a SOCKS proxy when @extension's + line="1453">Returns the machine name to use as a SOCKS proxy when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. SOCKS proxy host name + line="1460">SOCKS proxy host name an #ESourceProxy + line="1455">an #ESourceProxy @@ -29710,21 +29968,21 @@ e_source_proxy_lookup(). version="3.12"> Returns the port on the machine defined by #ESourceProxy:socks-host to proxy + line="1534">Returns the port on the machine defined by #ESourceProxy:socks-host to proxy through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. SOCKS proxy port + line="1541">SOCKS proxy port an #ESourceProxy + line="1536">an #ESourceProxy @@ -29735,7 +29993,7 @@ through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. version="3.12"> Sets the URL that provides proxy configuration values. When the + line="736">Sets the URL that provides proxy configuration values. When the @extension's #ESourceProxy:method is @E_PROXY_METHOD_AUTO, this URL is used to look up proxy information for all protocols. an #ESourceProxy + line="738">an #ESourceProxy an autoconfiguration URL + line="739">an autoconfiguration URL @@ -29764,7 +30022,7 @@ is used to look up proxy information for all protocols. version="3.12"> Sets the machine name to proxy FTP through when @extension's + line="918">Sets the machine name to proxy FTP through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. @@ -29775,13 +30033,13 @@ is used to look up proxy information for all protocols. an #ESourceProxy + line="920">an #ESourceProxy FTP proxy host name + line="921">FTP proxy host name @@ -29792,7 +30050,7 @@ is used to look up proxy information for all protocols. version="3.12"> Sets the port on the machine defined by #ESourceProxy:ftp-host to proxy + line="968">Sets the port on the machine defined by #ESourceProxy:ftp-host to proxy through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. @@ -29803,13 +30061,13 @@ through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. an #ESourceProxy + line="970">an #ESourceProxy FTP proxy port + line="971">FTP proxy port @@ -29820,7 +30078,7 @@ through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. version="3.12"> Sets the password to pass as authentication when doing HTTP proxying + line="1298">Sets the password to pass as authentication when doing HTTP proxying and #ESourceProxy:http-use-auth is %TRUE. @@ -29831,13 +30089,13 @@ and #ESourceProxy:http-use-auth is %TRUE. an #ESourceProxy + line="1300">an #ESourceProxy HTTP proxy password + line="1301">HTTP proxy password @@ -29848,7 +30106,7 @@ and #ESourceProxy:http-use-auth is %TRUE. version="3.12"> Sets the user name to pass as authentication when doing HTTP proxying + line="1217">Sets the user name to pass as authentication when doing HTTP proxying and #ESourceProxy:http-use-auth is %TRUE. @@ -29859,13 +30117,13 @@ and #ESourceProxy:http-use-auth is %TRUE. an #ESourceProxy + line="1219">an #ESourceProxy HTTP proxy username + line="1220">HTTP proxy username @@ -29876,7 +30134,7 @@ and #ESourceProxy:http-use-auth is %TRUE. version="3.12"> Sets the machine name to proxy HTTP through when @extension's + line="1042">Sets the machine name to proxy HTTP through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. @@ -29887,13 +30145,13 @@ and #ESourceProxy:http-use-auth is %TRUE. an #ESourceProxy + line="1044">an #ESourceProxy HTTP proxy host name + line="1045">HTTP proxy host name @@ -29904,7 +30162,7 @@ and #ESourceProxy:http-use-auth is %TRUE. version="3.12"> Sets the port on the machine defined by #ESourceProxy:http-host to proxy + line="1092">Sets the port on the machine defined by #ESourceProxy:http-host to proxy through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. @@ -29915,13 +30173,13 @@ through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. an #ESourceProxy + line="1094">an #ESourceProxy HTTP proxy port + line="1095">HTTP proxy port @@ -29932,7 +30190,7 @@ through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. version="3.12"> Sets whether the HTTP proxy server at #ESourceProxy:http-host and + line="1139">Sets whether the HTTP proxy server at #ESourceProxy:http-host and #ESourceProxy:http-port requires authentication. The username/password combo is defined by #ESourceProxy:http-auth-user @@ -29947,13 +30205,13 @@ and #ESourceProxy:http-auth-password, but only applies when @extension's an #ESourceProxy + line="1141">an #ESourceProxy whether to authenticate HTTP proxy connections + line="1142">whether to authenticate HTTP proxy connections @@ -29964,7 +30222,7 @@ and #ESourceProxy:http-auth-password, but only applies when @extension's version="3.12"> Sets the machine name to proxy secure HTTP through when @extension's + line="1379">Sets the machine name to proxy secure HTTP through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. @@ -29975,13 +30233,13 @@ and #ESourceProxy:http-auth-password, but only applies when @extension's an #ESourceProxy + line="1381">an #ESourceProxy secure HTTP proxy host name + line="1382">secure HTTP proxy host name @@ -29992,7 +30250,7 @@ and #ESourceProxy:http-auth-password, but only applies when @extension's version="3.12"> Sets the port on the machine defined by #ESourceProxy:https-host to proxy + line="1429">Sets the port on the machine defined by #ESourceProxy:https-host to proxy through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. @@ -30003,13 +30261,13 @@ through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. an #ESourceProxy + line="1431">an #ESourceProxy secure HTTP proxy port + line="1432">secure HTTP proxy port @@ -30020,7 +30278,7 @@ through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. version="3.12"> Sets the hosts which are connected to directly, rather than via the proxy + line="826">Sets the hosts which are connected to directly, rather than via the proxy (if it is active). The array elements can be hostnames, domains (using an initial wildcard like *.foo.com), IP host addresses (both IPv4 and IPv6) and network addresses with a netmask (something like 192.168.0.0/24). @@ -30033,13 +30291,13 @@ and network addresses with a netmask (something like 192.168.0.0/24). an #ESourceProxy + line="828">an #ESourceProxy a %NULL-terminated string array of hosts + line="829">a %NULL-terminated string array of hosts @@ -30050,7 +30308,7 @@ and network addresses with a netmask (something like 192.168.0.0/24). version="3.12"> Sets the proxy configuration method for @extension. + line="659">Sets the proxy configuration method for @extension. The proxy configuration method determines the behavior of e_source_proxy_lookup(). @@ -30063,13 +30321,13 @@ e_source_proxy_lookup(). an #ESourceProxy + line="661">an #ESourceProxy the proxy configuration method + line="662">the proxy configuration method @@ -30080,7 +30338,7 @@ e_source_proxy_lookup(). version="3.12"> Sets the machine name to use as a SOCKS proxy when @extension's + line="1503">Sets the machine name to use as a SOCKS proxy when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. @@ -30091,13 +30349,13 @@ e_source_proxy_lookup(). an #ESourceProxy + line="1505">an #ESourceProxy SOCKS proxy host name + line="1506">SOCKS proxy host name @@ -30108,7 +30366,7 @@ e_source_proxy_lookup(). version="3.12"> Sets the port on the machine defined by #ESourceProxy:socks-host to proxy + line="1553">Sets the port on the machine defined by #ESourceProxy:socks-host to proxy through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. @@ -30119,13 +30377,13 @@ through when @extension's #ESourceProxy:method is @E_PROXY_METHOD_MANUAL. an #ESourceProxy + line="1555">an #ESourceProxy SOCKS proxy port + line="1556">SOCKS proxy port @@ -30566,7 +30824,7 @@ functions below. throws="1"> Finishes the operation started with e_source_registry_new_finish(). + line="1865">Finishes the operation started with e_source_registry_new_finish(). If an error occurs in connecting to the D-Bus service, the function sets @error and returns %NULL. a new #ESourceRegistry, or %NULL on error + line="1874">a new #ESourceRegistry, or %NULL on error a #GAsyncResult + line="1867">a #GAsyncResult @@ -30592,7 +30850,7 @@ sets @error and returns %NULL. throws="1"> Creates a new #ESourceRegistry front-end for the registry D-Bus service. + line="1768">Creates a new #ESourceRegistry front-end for the registry D-Bus service. If an error occurs in connecting to the D-Bus service, the function sets @error and returns %NULL. @@ -30603,7 +30861,7 @@ internally, so it is the caller's responsibility to keep one. a new #ESourceRegistry, or %NULL on error + line="1780">a new #ESourceRegistry, or %NULL on error @@ -30613,7 +30871,7 @@ internally, so it is the caller's responsibility to keep one. allow-none="1"> optional #GCancellable object, or %NULL + line="1770">optional #GCancellable object, or %NULL @@ -30626,7 +30884,7 @@ internally, so it is the caller's responsibility to keep one. Whether debugging is enabled, that is, + line="2366">Whether debugging is enabled, that is, whether e_source_registry_debug_print() will produce any output. @@ -30637,7 +30895,7 @@ whether e_source_registry_debug_print() will produce any output. introspectable="0"> Prints the text only if a debugging is enabled with an environment + line="2382">Prints the text only if a debugging is enabled with an environment variable ESR_DEBUG=1. @@ -30648,13 +30906,13 @@ variable ESR_DEBUG=1. a format string to print + line="2384">a format string to print other arguments for the format + line="2385">other arguments for the format @@ -30664,7 +30922,7 @@ variable ESR_DEBUG=1. version="3.6"> Convenience function to free a #GNode tree of registered + line="2775">Convenience function to free a #GNode tree of registered sources created by e_source_registry_build_display_tree(). @@ -30675,15 +30933,18 @@ sources created by e_source_registry_build_display_tree(). a tree of sources, arranged for display + line="2777">a tree of sources, arranged for display - + Asynchronously creates a new #ESourceRegistry front-end for the registry + line="1828">Asynchronously creates a new #ESourceRegistry front-end for the registry D-Bus service. When the operation is finished, @callback will be called. You can then @@ -30703,7 +30964,7 @@ internally, so it is the caller's responsibility to keep one. allow-none="1"> optional #GCancellable object, or %NULL + line="1830">optional #GCancellable object, or %NULL closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="1831">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="1832">data to pass to the callback function @@ -30838,7 +31099,7 @@ internally, so it is the caller's responsibility to keep one. introspectable="0"> Returns a single #GNode tree of registered sources that can be used to + line="2714">Returns a single #GNode tree of registered sources that can be used to populate a #GtkTreeModel. (The root #GNode is just an empty placeholder.) Similar to e_source_registry_list_sources(), an @extension_name can be @@ -30858,7 +31119,7 @@ that in one step. a tree of sources, + line="2735">a tree of sources, arranged for display @@ -30866,7 +31127,7 @@ that in one step. an #ESourceRegistry + line="2716">an #ESourceRegistry allow-none="1"> an extension name, or %NULL + line="2717">an extension name, or %NULL @@ -30885,7 +31146,7 @@ that in one step. version="3.8"> Determines whether @source is "effectively" enabled by examining its + line="2606">Determines whether @source is "effectively" enabled by examining its own #ESource:enabled property as well as those of its ancestors in the #ESource hierarchy. If all examined #ESource:enabled properties are %TRUE, then the function returns %TRUE. If any are %FALSE, then the @@ -30899,30 +31160,32 @@ whether to act on the data set described by the #ESource. whether @source is "effectively" enabled + line="2621">whether @source is "effectively" enabled an #ESourceRegistry + line="2608">an #ESourceRegistry an #ESource + line="2609">an #ESource + version="3.6" + glib:finish-func="commit_source_finish" + glib:sync-func="commit_source_sync"> See e_source_registry_commit_source_sync() for details. + line="1992">See e_source_registry_commit_source_sync() for details. When the operation is finished, @callback will be called. You can then call e_source_registry_commit_source_finish() to get the result of the @@ -30936,13 +31199,13 @@ operation. an #ESourceRegistry + line="1994">an #ESourceRegistry an #ESource with changes to commit + line="1995">an #ESource with changes to commit allow-none="1"> optional #GCancellable object, or %NULL + line="1996">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="1997">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="1998">data to pass to the callback function @@ -30982,7 +31245,7 @@ operation. throws="1"> Finishes the operation started with e_source_registry_commit_source(). + line="2030">Finishes the operation started with e_source_registry_commit_source(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="2040">%TRUE on success, %FALSE on failure an #ESourceRegistry + line="2032">an #ESourceRegistry a #GAsyncResult + line="2033">a #GAsyncResult @@ -31011,10 +31274,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="commit_source"> This is a convenience function intended for use with graphical + line="1922">This is a convenience function intended for use with graphical #ESource editors. Call this function when the user is finished making changes to @source. @@ -31033,20 +31297,20 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="1944">%TRUE on success, %FALSE on failure an #ESourceRegistry + line="1924">an #ESourceRegistry an #ESource with changes to commit + line="1925">an #ESource with changes to commit allow-none="1"> optional #GCancellable object, or %NULL + line="1926">optional #GCancellable object, or %NULL + version="3.6" + glib:finish-func="create_sources_finish" + glib:sync-func="create_sources_sync"> Asynchronously requests the D-Bus service create new key files for each + line="2232">Asynchronously requests the D-Bus service create new key files for each #ESource in @list_of_sources. Each list element must be a scratch #ESource with no #GDBusObject. @@ -31081,13 +31347,13 @@ operation. an #ESourceRegistry + line="2234">an #ESourceRegistry a list of #ESource instances with + line="2235">a list of #ESource instances with no #GDBusObject @@ -31099,7 +31365,7 @@ no #GDBusObject allow-none="1"> optional #GCancellable object, or %NULL + line="2237">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="2238">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="2239">data to pass to the callback function @@ -31130,7 +31396,7 @@ no #GDBusObject throws="1"> Finishes the operation started with e_source_registry_create_sources(). + line="2277">Finishes the operation started with e_source_registry_create_sources(). If an error occurred, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="2287">%TRUE on success, %FALSE on failure an #ESourceRegistry + line="2279">an #ESourceRegistry a #GAsyncResult + line="2280">a #GAsyncResult @@ -31159,10 +31425,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="create_sources"> Requests the D-Bus service create new key files for each #ESource in + line="2116">Requests the D-Bus service create new key files for each #ESource in @list_of_sources. Each list element must be a scratch #ESource with no #GDBusObject. @@ -31172,20 +31439,20 @@ If an error occurs, the function will set @error and return %FALSE. %TRUE on success, %FALSE on failure + line="2130">%TRUE on success, %FALSE on failure an #ESourceRegistry + line="2118">an #ESourceRegistry a list of #ESource instances with + line="2119">a list of #ESource instances with no #GDBusObject @@ -31197,7 +31464,7 @@ no #GDBusObject allow-none="1"> optional #GCancellable object, or %NULL + line="2121">optional #GCancellable object, or %NULL @@ -31207,7 +31474,7 @@ no #GDBusObject version="3.6"> Handy debugging function that uses e_source_registry_build_display_tree() + line="2933">Handy debugging function that uses e_source_registry_build_display_tree() to print a tree of registered sources to standard output. @@ -31218,7 +31485,7 @@ to print a tree of registered sources to standard output. an #ESourceRegistry + line="2935">an #ESourceRegistry allow-none="1"> an extension name, or %NULL + line="2936">an extension name, or %NULL @@ -31237,7 +31504,7 @@ to print a tree of registered sources to standard output. version="3.8"> Compares @source's #ESource:display-name against other sources having + line="2797">Compares @source's #ESource:display-name against other sources having an #ESourceExtension named @extension_name, if given, or else against all other sources in the @registry. @@ -31256,20 +31523,20 @@ Free the returned string with g_free() when finished with it. a unique display name for @source + line="2818">a unique display name for @source an #ESourceRegistry + line="2799">an #ESourceRegistry an #ESource + line="2800">an #ESource allow-none="1"> an extension name, or %NULL + line="2801">an extension name, or %NULL @@ -31288,7 +31555,7 @@ Free the returned string with g_free() when finished with it. version="3.6"> Examines @source and its ancestors and returns the "deepest" #ESource + line="2545">Examines @source and its ancestors and returns the "deepest" #ESource having an #ESourceExtension with the given @extension_name. If neither @source nor any of its ancestors have such an extension, the function returns %NULL. @@ -31312,26 +31579,26 @@ not to be referenced directly (see e_source_get_extension()). an #ESource, or %NULL if no match was found + line="2571">an #ESource, or %NULL if no match was found an #ESourceRegistry + line="2547">an #ESourceRegistry an #ESource + line="2548">an #ESource the extension name to find + line="2549">the extension name to find @@ -31344,14 +31611,14 @@ not to be referenced directly (see e_source_get_extension()). an instance of #EOAuth2Services, owned by @registry + line="1891">an instance of #EOAuth2Services, owned by @registry an #ESourceRegistry + line="1889">an #ESourceRegistry @@ -31361,7 +31628,7 @@ not to be referenced directly (see e_source_get_extension()). version="3.10"> Similar to e_source_registry_list_sources(), but returns only enabled + line="2496">Similar to e_source_registry_list_sources(), but returns only enabled sources according to e_source_registry_check_enabled(). The sources returned in the list are referenced for thread-safety. @@ -31378,7 +31645,7 @@ An easy way to free the list properly in one step is as follows: a sorted list of sources + line="2514">a sorted list of sources @@ -31387,7 +31654,7 @@ An easy way to free the list properly in one step is as follows: an #ESourceRegistry + line="2498">an #ESourceRegistry an extension name, or %NULL + line="2499">an extension name, or %NULL @@ -31406,7 +31673,7 @@ An easy way to free the list properly in one step is as follows: version="3.6"> Returns a list of registered sources, sorted by display name. If + line="2441">Returns a list of registered sources, sorted by display name. If @extension_name is given, restrict the list to sources having that extension name. @@ -31424,7 +31691,7 @@ An easy way to free the list properly in one step is as follows: a sorted list of sources + line="2460">a sorted list of sources @@ -31433,7 +31700,7 @@ An easy way to free the list properly in one step is as follows: an #ESourceRegistry + line="2443">an #ESourceRegistry an extension name, or %NULL + line="2444">an extension name, or %NULL @@ -31452,7 +31719,7 @@ An easy way to free the list properly in one step is as follows: version="3.6"> Returns the built-in address book #ESource. + line="2960">Returns the built-in address book #ESource. This #ESource is always present and makes for a safe fallback. @@ -31463,14 +31730,14 @@ unreferenced with g_object_unref() when finished with it. the built-in address book #ESource + line="2971">the built-in address book #ESource an #ESourceRegistry + line="2962">an #ESourceRegistry @@ -31480,7 +31747,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Returns the built-in calendar #ESource. + line="2990">Returns the built-in calendar #ESource. This #ESource is always present and makes for a safe fallback. @@ -31491,14 +31758,14 @@ unreferenced with g_object_unref() when finished with it. the built-in calendar #ESource + line="3001">the built-in calendar #ESource an #ESourceRegistry + line="2992">an #ESourceRegistry @@ -31508,7 +31775,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Returns the built-in mail account #ESource. + line="3020">Returns the built-in mail account #ESource. This #ESource is always present and makes for a safe fallback. @@ -31519,14 +31786,14 @@ unreferenced with g_object_unref() when finished with it. the built-in mail account #ESource + line="3031">the built-in mail account #ESource an #ESourceRegistry + line="3022">an #ESourceRegistry @@ -31536,7 +31803,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Returns the built-in memo list #ESource. + line="3050">Returns the built-in memo list #ESource. This #ESource is always present and makes for a safe fallback. @@ -31547,14 +31814,14 @@ unreferenced with g_object_unref() when finished with it. the built-in memo list #ESource + line="3061">the built-in memo list #ESource an #ESourceRegistry + line="3052">an #ESourceRegistry @@ -31564,7 +31831,7 @@ unreferenced with g_object_unref() when finished with it. version="3.12"> Returns the built-in proxy profile #ESource. + line="3080">Returns the built-in proxy profile #ESource. This #ESource is always present and makes for a safe fallback. @@ -31575,14 +31842,14 @@ unreferenced with g_object_unref() when finished with it. the built-in proxy profile #ESource + line="3091">the built-in proxy profile #ESource an #ESourceRegistry + line="3082">an #ESourceRegistry @@ -31592,7 +31859,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Returns the built-in task list #ESource. + line="3110">Returns the built-in task list #ESource. This #ESource is always present and makes for a safe fallback. @@ -31603,14 +31870,14 @@ unreferenced with g_object_unref() when finished with it. the built-in task list #ESource + line="3121">the built-in task list #ESource an #ESourceRegistry + line="3112">an #ESourceRegistry @@ -31620,7 +31887,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Returns the #ESource most recently passed to + line="3140">Returns the #ESource most recently passed to e_source_registry_set_default_address_book() either in this session or a previous session, or else falls back to the built-in address book. @@ -31631,14 +31898,14 @@ unreferenced with g_object_unref() when finished with it. the default address book #ESource + line="3151">the default address book #ESource an #ESourceRegistry + line="3142">an #ESourceRegistry @@ -31648,7 +31915,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Returns the #ESource most recently passed to + line="3212">Returns the #ESource most recently passed to e_source_registry_set_default_calendar() either in this session or a previous session, or else falls back to the built-in calendar. @@ -31659,14 +31926,14 @@ unreferenced with g_object_unref() when finished with it. the default calendar #ESource + line="3223">the default calendar #ESource an #ESourceRegistry + line="3214">an #ESourceRegistry @@ -31676,7 +31943,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> This is a convenience function to return a default #ESource based on + line="3629">This is a convenience function to return a default #ESource based on @extension_name. This only works with a subset of extension names. If @extension_name is #E_SOURCE_EXTENSION_ADDRESS_BOOK, the function @@ -31709,20 +31976,20 @@ unreferenced with g_object_unref() when finished with it. the default #ESource based on @extension_name + line="3663">the default #ESource based on @extension_name an #ESourceRegistry + line="3631">an #ESourceRegistry an extension_name + line="3632">an extension_name @@ -31732,7 +31999,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Returns the #ESource most recently passed to + line="3284">Returns the #ESource most recently passed to e_source_registry_set_default_mail_account() either in this session or a previous session, or else falls back to the built-in mail account. @@ -31743,14 +32010,14 @@ unreferenced with g_object_unref() when finished with it. the default mail account #ESource + line="3295">the default mail account #ESource an #ESourceRegistry + line="3286">an #ESourceRegistry @@ -31760,7 +32027,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Returns the #ESource most recently passed to + line="3413">Returns the #ESource most recently passed to e_source_registry_set_default_mail_identity() either in this session or a previous session, or else falls back to the mail identity named by the default mail account. If even that fails it returns any mail @@ -31773,7 +32040,7 @@ unreferenced with g_object_unref() when finished with it. the default mail identity #ESource, + line="3426">the default mail identity #ESource, or %NULL @@ -31781,7 +32048,7 @@ unreferenced with g_object_unref() when finished with it. an #ESourceRegistry + line="3415">an #ESourceRegistry @@ -31791,7 +32058,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Returns the #ESource most recently passed to + line="3485">Returns the #ESource most recently passed to e_source_registry_set_default_memo_list() either in this session or a previous session, or else falls back to the built-in memo list. @@ -31802,14 +32069,14 @@ unreferenced with g_object_unref() when finished with it. the default memo list #ESource + line="3496">the default memo list #ESource an #ESourceRegistry + line="3487">an #ESourceRegistry @@ -31819,7 +32086,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Returns the #ESource most recently passed to + line="3557">Returns the #ESource most recently passed to e_source_registry_set_default_task_list() either in this session or a previous session, or else falls back to the built-in task list. @@ -31830,14 +32097,14 @@ unreferenced with g_object_unref() when finished with it. the default task list #ESource + line="3568">the default task list #ESource an #ESourceRegistry + line="3559">an #ESourceRegistry @@ -31847,7 +32114,7 @@ unreferenced with g_object_unref() when finished with it. version="3.6"> Looks up an #ESource in @registry by its unique identifier string. + line="2417">Looks up an #ESource in @registry by its unique identifier string. The returned #ESource is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it. @@ -31856,30 +32123,32 @@ unreferenced with g_object_unref() when finished with it. an #ESource, or %NULL if no match was found + line="2427">an #ESource, or %NULL if no match was found an #ESourceRegistry + line="2419">an #ESourceRegistry a unique identifier string + line="2420">a unique identifier string + version="3.30" + glib:finish-func="refresh_backend_finish" + glib:sync-func="refresh_backend_sync"> Asynchronously requests the D-Bus service to refresh collection backend + line="2351">Asynchronously requests the D-Bus service to refresh collection backend for an #ESource with UID @source_uid. The result means that the refresh had been scheduled not whether the refresh itself succeeded. The refresh is not initiated when the collection backend is offline. @@ -31896,13 +32165,13 @@ the operation. an #ESourceRegistry + line="2353">an #ESourceRegistry UID of a collection #ESource whose backend to refresh + line="2354">UID of a collection #ESource whose backend to refresh allow-none="1"> optional #GCancellable object, or %NULL + line="2355">optional #GCancellable object, or %NULL closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="2356">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="2357">data to pass to the callback function @@ -31942,7 +32211,7 @@ the operation. throws="1"> Finishes the operation started with e_source_registry_refresh_backend(). + line="2391">Finishes the operation started with e_source_registry_refresh_backend(). If an error occurred, the function will set @error and return %FALSE. Whether succeeded + line="2401">Whether succeeded an #ESourceRegistry + line="2393">an #ESourceRegistry a #GAsyncResult + line="2394">a #GAsyncResult @@ -31971,10 +32240,11 @@ If an error occurred, the function will set @error and return %FALSE. + throws="1" + glib:async-func="refresh_backend"> Requests the D-Bus service to refresh collection backend for an #ESource + line="2302">Requests the D-Bus service to refresh collection backend for an #ESource with UID @source_uid. The result means that the refresh had been scheduled not whether the refresh itself succeeded. The refresh is not initiated when the collection backend is offline. @@ -31985,20 +32255,20 @@ If an error occurs, the function will set @error and return %FALSE. Whether succeeded + line="2316">Whether succeeded an #ESourceRegistry + line="2304">an #ESourceRegistry UID of a collection #ESource whose backend to refresh + line="2305">UID of a collection #ESource whose backend to refresh allow-none="1"> optional #GCancellable object, or %NULL + line="2306">optional #GCancellable object, or %NULL @@ -32018,7 +32288,7 @@ If an error occurs, the function will set @error and return %FALSE. version="3.6"> Sets @default_source as the default address book. If @default_source + line="3178">Sets @default_source as the default address book. If @default_source is %NULL, the default address book is reset to the built-in address book. This setting will persist across sessions until changed. an #ESourceRegistry + line="3180">an #ESourceRegistry allow-none="1"> an address book #ESource, or %NULL + line="3181">an address book #ESource, or %NULL @@ -32050,7 +32320,7 @@ This setting will persist across sessions until changed. version="3.6"> Sets @default_source as the default calendar. If @default_source + line="3250">Sets @default_source as the default calendar. If @default_source is %NULL, the default calendar is reset to the built-in calendar. This setting will persist across sessions until changed. an #ESourceRegistry + line="3252">an #ESourceRegistry allow-none="1"> a calendar #ESource, or %NULL + line="3253">a calendar #ESource, or %NULL @@ -32081,7 +32351,7 @@ This setting will persist across sessions until changed. version="3.6"> This is a convenience function to set a default #ESource based on + line="3695">This is a convenience function to set a default #ESource based on @extension_name. This only works with a subset of extension names. If @extension_name is #E_SOURCE_EXTENSION_ADDRESS_BOOK, the function @@ -32119,13 +32389,13 @@ For all other values of @extension_name, the function does nothing. an #ESourceRegistry + line="3697">an #ESourceRegistry an extension name + line="3698">an extension name allow-none="1"> an #ESource, or %NULL + line="3699">an #ESource, or %NULL @@ -32145,7 +32415,7 @@ For all other values of @extension_name, the function does nothing. version="3.6"> Sets @default_source as the default mail account. If @default_source + line="3322">Sets @default_source as the default mail account. If @default_source is %NULL, the default mail account is reset to the built-in mail account. This setting will persist across sessions until changed. an #ESourceRegistry + line="3324">an #ESourceRegistry allow-none="1"> a mail account #ESource, or %NULL + line="3325">a mail account #ESource, or %NULL @@ -32177,7 +32447,7 @@ This setting will persist across sessions until changed. version="3.6"> Sets @default_source as the default mail identity. If @default_source + line="3451">Sets @default_source as the default mail identity. If @default_source is %NULL, the next request for the default mail identity will use the fallbacks described in e_source_registry_ref_default_mail_identity(). an #ESourceRegistry + line="3453">an #ESourceRegistry allow-none="1"> a mail identity #ESource, or %NULL + line="3454">a mail identity #ESource, or %NULL @@ -32209,7 +32479,7 @@ fallbacks described in e_source_registry_ref_default_mail_identity(). version="3.6"> Sets @default_source as the default memo list. If @default_source + line="3523">Sets @default_source as the default memo list. If @default_source is %NULL, the default memo list is reset to the built-in memo list. This setting will persist across sessions until changed. an #ESourceRegistry + line="3525">an #ESourceRegistry allow-none="1"> a memo list #ESource, or %NULL + line="3526">a memo list #ESource, or %NULL @@ -32241,7 +32511,7 @@ This setting will persist across sessions until changed. version="3.6"> Sets @default_source as the default task list. If @default_source + line="3595">Sets @default_source as the default task list. If @default_source is %NULL, the default task list is reset to the built-in task list. This setting will persist across sessions until changed. an #ESourceRegistry + line="3597">an #ESourceRegistry allow-none="1"> a task list #ESource, or %NULL + line="3598">a task list #ESource, or %NULL @@ -32273,7 +32543,7 @@ This setting will persist across sessions until changed. setter="set_default_address_book"> The default address book #ESource. + line="1499">The default address book #ESource. setter="set_default_calendar"> The default calendar #ESource. + line="1516">The default calendar #ESource. setter="set_default_mail_account"> The default mail account #ESource. + line="1533">The default mail account #ESource. setter="set_default_mail_identity"> The default mail identity #ESource. + line="1550">The default mail identity #ESource. setter="set_default_memo_list"> The default memo list #ESource. + line="1567">The default memo list #ESource. setter="set_default_task_list"> The default task list #ESource. + line="1584">The default task list #ESource. @@ -32330,7 +32600,7 @@ This setting will persist across sessions until changed. The ::credentials-required signal is emitted when the @source + line="1682">The ::credentials-required signal is emitted when the @source requires credentials to connect to (possibly remote) data store. The credentials can be passed to the source using e_source_invoke_authenticate() function. The signal is emitted in @@ -32344,31 +32614,31 @@ Note: This is just a proxy signal for the ESource::credentials-required signal.< the #ESource that requires credentials + line="1685">the #ESource that requires credentials an #ESourceCredentialsReason indicating why the credentials are requested + line="1686">an #ESourceCredentialsReason indicating why the credentials are requested PEM-encoded secure connection certificate for failed SSL checks + line="1687">PEM-encoded secure connection certificate for failed SSL checks what failed with the SSL certificate + line="1688">what failed with the SSL certificate a #GError with a description of the error, or %NULL + line="1689">a #GError with a description of the error, or %NULL @@ -32376,7 +32646,7 @@ Note: This is just a proxy signal for the ESource::credentials-required signal.< Emitted when an #ESource is added to @registry. + line="1601">Emitted when an #ESource is added to @registry. @@ -32384,7 +32654,7 @@ Note: This is just a proxy signal for the ESource::credentials-required signal.< the newly-added #ESource + line="1604">the newly-added #ESource @@ -32392,7 +32662,7 @@ Note: This is just a proxy signal for the ESource::credentials-required signal.< Emitted when an #ESource registered with @registry emits + line="1617">Emitted when an #ESource registered with @registry emits its #ESource::changed signal. @@ -32401,7 +32671,7 @@ its #ESource::changed signal. the #ESource that changed + line="1620">the #ESource that changed @@ -32409,7 +32679,7 @@ its #ESource::changed signal. Emitted when an #ESource #ESource:enabled property becomes %FALSE. + line="1666">Emitted when an #ESource #ESource:enabled property becomes %FALSE. @@ -32417,7 +32687,7 @@ its #ESource::changed signal. the #ESource that got disabled + line="1669">the #ESource that got disabled @@ -32425,7 +32695,7 @@ its #ESource::changed signal. Emitted when an #ESource #ESource:enabled property becomes %TRUE. + line="1650">Emitted when an #ESource #ESource:enabled property becomes %TRUE. @@ -32433,7 +32703,7 @@ its #ESource::changed signal. the #ESource that got enabled + line="1653">the #ESource that got enabled @@ -32441,7 +32711,7 @@ its #ESource::changed signal. Emitted when an #ESource is removed from @registry. + line="1634">Emitted when an #ESource is removed from @registry. @@ -32449,7 +32719,7 @@ its #ESource::changed signal. the #ESource that got removed + line="1637">the #ESource that got removed @@ -34065,7 +34335,7 @@ source's display name in user interfaces. transfer-ownership="none" setter="set_color" getter="get_color" - default-value="#becedd"> + default-value="#62a0ea"> value="i;" c:type="E_WEBDAV_COLLATION_ASCII_CASEMAP"> + line="218"/> + line="217"/> + line="215"/> + line="214"/> + line="221"/> + line="220"/> + line="224"/> + line="223"/> + line="287"/> @@ -35958,7 +36228,7 @@ with e_source_webdav_update_ssl_trust(). + line="278"/> @@ -35988,7 +36258,7 @@ with e_source_webdav_update_ssl_trust(). + line="318"/> @@ -36016,7 +36286,7 @@ with e_source_webdav_update_ssl_trust(). glib:get-type="e_webdav_access_control_entry_get_type" c:symbol-prefix="webdav_access_control_entry"> + line="295"/> @@ -36047,7 +36317,7 @@ The @flags should always contain either %E_WEBDAV_ACE_FLAG_GRANT or Use e_webdav_access_control_entry_append_privilege() to add respective privileges to the entry. + line="299"/> The function assumes ownership of the @privilege, which is freed together with the @ace. + line="306"/> @@ -36123,7 +36393,7 @@ together with the @ace. c:identifier="e_webdav_access_control_entry_copy" version="3.26"> + line="304"/> c:identifier="e_webdav_access_control_entry_get_privileges" version="3.26"> + line="309"/> line="542">Frees an #EWebDAVAccessControlEntry previously created with e_webdav_access_control_entry_new() or e_webdav_access_control_entry_copy(). The function does nothing, if @ptr is %NULL. + line="305"/> @@ -36342,7 +36612,7 @@ or e_webdav_access_control_entry_copy(). The function does nothing, if @ptr is % + line="157"/> @@ -36390,7 +36660,7 @@ or e_webdav_access_control_entry_copy(). The function does nothing, if @ptr is % + line="213"/> @@ -36404,7 +36674,7 @@ or e_webdav_access_control_entry_copy(). The function does nothing, if @ptr is % glib:get-type="e_webdav_privilege_get_type" c:symbol-prefix="webdav_privilege"> + line="256"/> @@ -36433,7 +36703,7 @@ known hints when it's %E_WEBDAV_PRIVILEGE_HINT_UNKNOWN. The @ns_uri and @name can be %NULL only if the @hint is one of the known privileges. Otherwise it's an error to pass either of the two as %NULL. + line="260"/> c:identifier="e_webdav_privilege_copy" version="3.26"> + line="266"/> line="433">Frees an #EWebDAVPrivilege previously created with e_webdav_privilege_new() or e_webdav_privilege_copy(). The function does nothing, if @ptr is %NULL. + line="267"/> @@ -36535,7 +36805,7 @@ or e_webdav_privilege_copy(). The function does nothing, if @ptr is %NULL. + line="248"/> @@ -36589,7 +36859,7 @@ or e_webdav_privilege_copy(). The function does nothing, if @ptr is %NULL. + line="232"/> @@ -36613,7 +36883,7 @@ or e_webdav_privilege_copy(). The function does nothing, if @ptr is %NULL. glib:get-type="e_webdav_property_change_get_type" c:symbol-prefix="webdav_property_change"> + line="196"/> @@ -36636,7 +36906,7 @@ or e_webdav_privilege_copy(). The function does nothing, if @ptr is %NULL. which is used to remove the given property. To change property value use e_webdav_property_change_new_set() instead. + line="204"/> + line="200"/> c:identifier="e_webdav_property_change_copy" version="3.26"> + line="207"/> e_webdav_property_change_new_remove() or or e_webdav_property_change_copy(). The function does nothing, if @ptr is %NULL. + line="208"/> @@ -36757,7 +37027,7 @@ The function does nothing, if @ptr is %NULL. + line="189"/> @@ -36768,37 +37038,37 @@ The function does nothing, if @ptr is %NULL. version="3.26"> A callback function for e_webdav_session_propfind_sync(), + line="159">A callback function for e_webdav_session_propfind_sync(), e_webdav_session_report_sync() and other XML response with DAV:propstat elements traversal functions. The @prop_node points to the actual property (prop) node and it can be examined with e_xml_find_child(), e_xml_find_children_nodes() and other provided XML helper functions. + line="179"/> %TRUE to continue traversal of the returned response, %FALSE otherwise. + line="175">%TRUE to continue traversal of the returned response, %FALSE otherwise. an #EWebDAVSession + line="161">an #EWebDAVSession an #xmlNode + line="162">an #xmlNode a #GUri, containing the request URI, maybe redirected by the server + line="163">a #GUri, containing the request URI, maybe redirected by the server a full URI to which the property belongs, or %NULL, when not found + line="164">a full URI to which the property belongs, or %NULL, when not found an HTTP status code for this property + line="165">an HTTP status code for this property user data, as passed to e_webdav_session_propfind_sync() + line="166">user data, as passed to e_webdav_session_propfind_sync() @@ -36834,7 +37104,7 @@ with e_xml_find_child(), e_xml_find_children_nodes() and other provided XML help glib:get-type="e_webdav_resource_get_type" c:symbol-prefix="webdav_resource"> + line="122"/> @@ -36882,7 +37152,7 @@ for them to be fetched. The @etag for %E_WEBDAV_RESOURCE_KIND_COLLECTION can be a change tag instead. + line="126"/> + line="139"/> Frees an #EWebDAVResource previously created with e_webdav_resource_new() or e_webdav_resource_copy(). The function does nothing, if @ptr is %NULL. + line="140"/> @@ -37030,7 +37300,7 @@ or e_webdav_resource_copy(). The function does nothing, if @ptr is %NULL. + line="95"/> @@ -37063,10 +37333,18 @@ or e_webdav_resource_copy(). The function does nothing, if @ptr is %NULL. value="7" c:identifier="E_WEBDAV_RESOURCE_KIND_WEBDAV_NOTES"> + + + + + line="107"/> @@ -37114,10 +37392,10 @@ or e_webdav_resource_copy(). The function does nothing, if @ptr is %NULL. glib:type-struct="WebDAVSessionClass"> Contains only private data that should be read and manipulated using the + line="320">Contains only private data that should be read and manipulated using the functions below. + line="339"/> @@ -37127,7 +37405,7 @@ functions below. The #EWebDAVSession uses an #ESourceWebdav extension on certain places when it's defined for the @source. + line="343"/> version="3.26"> Frees @privileges returned by e_webdav_session_get_supported_privilege_set_sync(). + line="5101">Frees @privileges returned by e_webdav_session_get_supported_privilege_set_sync(). The function does nothing, if @privileges is %NULL. + line="614"/> @@ -37163,7 +37441,7 @@ The function does nothing, if @privileges is %NULL. allow-none="1"> a tree of #EWebDAVPrivilege structures + line="5103">a tree of #EWebDAVPrivilege structures @@ -37173,7 +37451,7 @@ The function does nothing, if @privileges is %NULL. version="3.40"> Compares two hrefs and return whether they reference + line="5183">Compares two hrefs and return whether they reference the same item on the server. The comparison is done in a relaxed way, not considering scheme part and comparing the host name case insensitively, while the path @@ -37181,24 +37459,24 @@ case sensitively. It also ignores the username/password information in the hostname part, if it's included. The function doesn't decode any URI-encoded characters. + line="615"/> whether the two href-s reference the same item + line="5196">whether the two href-s reference the same item the first href + line="5185">the first href the second href + line="5186">the second href @@ -37208,15 +37486,15 @@ The function doesn't decode any URI-encoded characters. version="3.26"> Dequotes @text, if it's enclosed in double-quotes. The function + line="5058">Dequotes @text, if it's enclosed in double-quotes. The function changes @text, it doesn't allocate new string. The function does nothing when the @text is not enclosed in double-quotes. + line="613"/> possibly dequoted @text + line="5066">possibly dequoted @text @@ -37228,7 +37506,7 @@ nothing when the @text is not enclosed in double-quotes. allow-none="1"> text to dequote + line="5060">text to dequote @@ -37239,21 +37517,21 @@ nothing when the @text is not enclosed in double-quotes. throws="1"> Issues ACL request on the provided @uri, or, in case it's %NULL, on the URI + line="4035">Issues ACL request on the provided @uri, or, in case it's %NULL, on the URI defined in associated #ESource. + line="554"/> Whether succeeded. + line="4046">Whether succeeded. an #EWebDAVSession + line="4037">an #EWebDAVSession allow-none="1"> URI to issue the request for, or %NULL to read from #ESource + line="4038">URI to issue the request for, or %NULL to read from #ESource the request itself, as an #EXmlDocument, the root element should be DAV:acl + line="4039">the request itself, as an #EXmlDocument, the root element should be DAV:acl allow-none="1"> optional #GCancellable object, or %NULL + line="4040">optional #GCancellable object, or %NULL @@ -37293,7 +37571,7 @@ The @source_uri can reference also collections, in which case the @depth influen whether only the collection itself is copied (%E_WEBDAV_DEPTH_THIS) or whether the collection with all its children is copied (%E_WEBDAV_DEPTH_INFINITY). + line="475"/> + line="461"/> + line="467"/> + line="359"/> throws="1"> Gets Access Control List (ACL) restrictions for the @uri, or, in case it's %NULL, + line="4604">Gets Access Control List (ACL) restrictions for the @uri, or, in case it's %NULL, for the URI defined in associated #ESource. The @out_principal_kind is valid only if the @out_restrictions contains #E_WEBDAV_ACL_RESTRICTION_REQUIRED_PRINCIPAL. The @out_principal_hrefs is valid only if the @out_principal_kind is valid and when @@ -37548,18 +37826,18 @@ Free the returned @out_principal_hrefs with g_slist_free_full (entries, g_free); when no longer needed. + line="584"/> Whether succeeded. + line="4624">Whether succeeded. an #EWebDAVSession + line="4606">an #EWebDAVSession allow-none="1"> URI to issue the request for, or %NULL to read from #ESource + line="4607">URI to issue the request for, or %NULL to read from #ESource transfer-ownership="full"> return location for bit-or of #EWebDAVACLRestrictions + line="4608">return location for bit-or of #EWebDAVACLRestrictions transfer-ownership="full"> return location for principal kind + line="4609">return location for principal kind @@ -37596,7 +37874,7 @@ when no longer needed. transfer-ownership="full"> return location for a #GSList of principal href-s + line="4610">return location for a #GSList of principal href-s @@ -37607,7 +37885,7 @@ when no longer needed. allow-none="1"> optional #GCancellable object, or %NULL + line="4611">optional #GCancellable object, or %NULL @@ -37618,7 +37896,7 @@ when no longer needed. throws="1"> Gets Access Control List (ACL) for the @uri, or, in case it's %NULL, for the URI + line="4502">Gets Access Control List (ACL) for the @uri, or, in case it's %NULL, for the URI defined in associated #ESource. This function doesn't read general #E_WEBDAV_ACE_PRINCIPAL_PROPERTY. @@ -37627,18 +37905,18 @@ Free the returned @out_entries with g_slist_free_full (entries, e_webdav_access_control_entry_free); when no longer needed. + line="579"/> Whether succeeded. + line="4519">Whether succeeded. an #EWebDAVSession + line="4504">an #EWebDAVSession allow-none="1"> URI to issue the request for, or %NULL to read from #ESource + line="4505">URI to issue the request for, or %NULL to read from #ESource transfer-ownership="full"> return location for a #GSList of #EWebDAVAccessControlEntry + line="4506">return location for a #GSList of #EWebDAVAccessControlEntry @@ -37667,7 +37945,7 @@ when no longer needed. allow-none="1"> optional #GCancellable object, or %NULL + line="4507">optional #GCancellable object, or %NULL @@ -37678,7 +37956,7 @@ when no longer needed. throws="1"> Gets current user privileges for the @uri, or, in case it's %NULL, for the URI + line="4237">Gets current user privileges for the @uri, or, in case it's %NULL, for the URI defined in associated #ESource, with optional read of the capabilities and what the user is allowed. See e_webdav_session_options_sync() for more information about the @out_capabilities and @out_allows values. @@ -37687,18 +37965,18 @@ Free the returned @out_privileges with g_slist_free_full (privileges, e_webdav_privilege_free); when no longer needed. + line="571"/> Whether succeeded. + line="4256">Whether succeeded. an #EWebDAVSession + line="4239">an #EWebDAVSession allow-none="1"> URI to issue the request for, or %NULL to read from #ESource + line="4240">URI to issue the request for, or %NULL to read from #ESource transfer-ownership="full"> return location for a %GSList of #EWebDAVPrivilege + line="4241">return location for a %GSList of #EWebDAVPrivilege @@ -37729,7 +38007,7 @@ when no longer needed. allow-none="1"> return location for DAV capabilities, or %NULL + line="4242">return location for DAV capabilities, or %NULL @@ -37743,7 +38021,7 @@ when no longer needed. allow-none="1"> return location for allowed operations, or %NULL + line="4243">return location for allowed operations, or %NULL @@ -37755,7 +38033,7 @@ when no longer needed. allow-none="1"> optional #GCancellable object, or %NULL + line="4244">optional #GCancellable object, or %NULL @@ -37766,25 +38044,25 @@ when no longer needed. throws="1"> Gets current user privileges for the @uri, or, in case it's %NULL, for the URI + line="4208">Gets current user privileges for the @uri, or, in case it's %NULL, for the URI defined in associated #ESource. Free the returned @out_privileges with g_slist_free_full (privileges, e_webdav_privilege_free); when no longer needed. + line="565"/> Whether succeeded. + line="4223">Whether succeeded. an #EWebDAVSession + line="4210">an #EWebDAVSession allow-none="1"> URI to issue the request for, or %NULL to read from #ESource + line="4211">URI to issue the request for, or %NULL to read from #ESource transfer-ownership="full"> return location for a %GSList of #EWebDAVPrivilege + line="4212">return location for a %GSList of #EWebDAVPrivilege @@ -37813,7 +38091,7 @@ when no longer needed. allow-none="1"> optional #GCancellable object, or %NULL + line="4213">optional #GCancellable object, or %NULL @@ -37840,7 +38118,7 @@ when no longer needed. To read large data use e_webdav_session_get_sync() instead. + line="428"/> + line="344"/> c:identifier="e_webdav_session_get_last_dav_error_is_permission" version="3.36"> + line="345"/> throws="1"> Gets list of principal collection href for the @uri, or, in case it's %NULL, + line="4706">Gets list of principal collection href for the @uri, or, in case it's %NULL, for the URI defined in associated #ESource. The @out_principal_hrefs are root collections that contain the principals that are available on the server that implements this resource. @@ -37986,18 +38264,18 @@ Free the returned @out_principal_hrefs with g_slist_free_full (entries, g_free); when no longer needed. + line="592"/> Whether succeeded. + line="4723">Whether succeeded. an #EWebDAVSession + line="4708">an #EWebDAVSession allow-none="1"> URI to issue the request for, or %NULL to read from #ESource + line="4709">URI to issue the request for, or %NULL to read from #ESource transfer-ownership="full"> return location for a #GSList of principal href-s + line="4710">return location for a #GSList of principal href-s @@ -38026,7 +38304,7 @@ when no longer needed. allow-none="1"> optional #GCancellable object, or %NULL + line="4711">optional #GCancellable object, or %NULL @@ -38037,7 +38315,7 @@ when no longer needed. throws="1"> Gets supported privileges for the @uri, or, in case it's %NULL, for the URI + line="4096">Gets supported privileges for the @uri, or, in case it's %NULL, for the URI defined in associated #ESource. The root node of @out_privileges has always %NULL data. @@ -38045,18 +38323,18 @@ The root node of @out_privileges has always %NULL data. Free the returned @out_privileges with e_webdav_session_util_free_privileges() when no longer needed. + line="559"/> Whether succeeded. + line="4112">Whether succeeded. an #EWebDAVSession + line="4098">an #EWebDAVSession allow-none="1"> URI to issue the request for, or %NULL to read from #ESource + line="4099">URI to issue the request for, or %NULL to read from #ESource transfer-ownership="full"> return location for the tree of supported privileges + line="4100">return location for the tree of supported privileges allow-none="1"> optional #GCancellable object, or %NULL + line="4101">optional #GCancellable object, or %NULL @@ -38106,7 +38384,7 @@ when no longer needed. The e_webdav_session_get_data_sync() can be used to read the resource data directly to memory. + line="420"/> + line="529"/> throws="1"> Lists content of the @uri, or, in case it's %NULL, of the URI defined + line="3616">Lists content of the @uri, or, in case it's %NULL, of the URI defined in associated #ESource, which should point to a collection. The @flags influences which properties are read for the resources. @@ -38250,18 +38528,18 @@ Free the returned @out_resources with g_slist_free_full (resources, e_webdav_resource_free); when no longer needed. + line="534"/> Whether succeeded. + line="3636">Whether succeeded. an #EWebDAVSession + line="3618">an #EWebDAVSession allow-none="1"> URI to issue the request for, or %NULL to read from #ESource + line="3619">URI to issue the request for, or %NULL to read from #ESource requested depth, can be one of %E_WEBDAV_DEPTH_THIS, %E_WEBDAV_DEPTH_THIS_AND_CHILDREN or %E_WEBDAV_DEPTH_INFINITY + line="3620">requested depth, can be one of %E_WEBDAV_DEPTH_THIS, %E_WEBDAV_DEPTH_THIS_AND_CHILDREN or %E_WEBDAV_DEPTH_INFINITY a bit-or of #EWebDAVListFlags, claiming what properties to read + line="3621">a bit-or of #EWebDAVListFlags, claiming what properties to read transfer-ownership="full"> return location for the resources + line="3622">return location for the resources @@ -38302,7 +38580,7 @@ when no longer needed. allow-none="1"> optional #GCancellable object, or %NULL + line="3623">optional #GCancellable object, or %NULL @@ -38313,7 +38591,7 @@ when no longer needed. throws="1"> Locks a resource identified by @uri, or, in case it's %NULL, by the URI defined + line="3853">Locks a resource identified by @uri, or, in case it's %NULL, by the URI defined in associated #ESource. It obtains a write lock with the given @lock_scope. The @owner is used to identify the lock owner. When it's an http:// or https://, @@ -38324,18 +38602,18 @@ The @out_lock_token can be refreshed with e_webdav_session_refresh_lock_sync(). Release the lock with e_webdav_session_unlock_sync(). Free the returned @out_lock_token with g_free(), when no longer needed. + line="546"/> Whether succeeded. + line="3875">Whether succeeded. an #EWebDAVSession + line="3855">an #EWebDAVSession allow-none="1"> URI to lock, or %NULL to read from #ESource + line="3856">URI to lock, or %NULL to read from #ESource an #EWebDAVLockScope to define the scope of the lock + line="3857">an #EWebDAVLockScope to define the scope of the lock timeout for the lock, in seconds, on 0 to infinity + line="3858">timeout for the lock, in seconds, on 0 to infinity allow-none="1"> optional identificator of the owner of the lock, or %NULL + line="3859">optional identificator of the owner of the lock, or %NULL transfer-ownership="full"> return location of the obtained or refreshed lock token + line="3860">return location of the obtained or refreshed lock token allow-none="1"> optional #GCancellable object, or %NULL + line="3861">optional #GCancellable object, or %NULL @@ -38404,7 +38682,7 @@ Free the returned @out_lock_token with g_free(), when no longer needed. If provided, free the returned @out_xml_response with xmlFreeDoc(), when no longer needed. + line="488"/> + line="412"/> + line="406"/> To create specific collections use e_webdav_session_mkcalendar_sync() or e_webdav_session_mkcol_addressbook_sync(). + line="402"/> line="2664">Moves a resource identified by @source_uri to @destination_uri on the server. The @source_uri can reference also collections. + line="482"/> version="3.26" throws="1"> + line="348"/> + line="362"/> + line="368"/> throws="1"> Issues a DAV:principal-property-search for the @uri, or, in case it's %NULL, + line="4970">Issues a DAV:principal-property-search for the @uri, or, in case it's %NULL, for the URI defined in associated #ESource. The DAV:principal-property-search performs a search for all principals whose properties contain character data that matches the search criteria @match_value in @match_property property @@ -38969,11 +39247,11 @@ Free the returned @out_principals with g_slist_free_full (principals, e_webdav_resource_free); when no longer needed. + line="603"/> Whether succeeded. Note it can report success also when no matching + line="5001">Whether succeeded. Note it can report success also when no matching principal had been found. @@ -38981,7 +39259,7 @@ when no longer needed. an #EWebDAVSession + line="4972">an #EWebDAVSession allow-none="1"> URI to issue the request for, or %NULL to read from #ESource + line="4973">URI to issue the request for, or %NULL to read from #ESource whether to apply to principal-collection-set + line="4974">whether to apply to principal-collection-set allow-none="1"> namespace URI of the property to search in, or %NULL for %E_WEBDAV_NS_DAV + line="4975">namespace URI of the property to search in, or %NULL for %E_WEBDAV_NS_DAV name of the property to search in + line="4976">name of the property to search in a string value to search for + line="4977">a string value to search for transfer-ownership="full"> return location for matching principals + line="4978">return location for matching principals @@ -39038,7 +39316,7 @@ when no longer needed. allow-none="1"> optional #GCancellable object, or %NULL + line="4979">optional #GCancellable object, or %NULL @@ -39055,7 +39333,7 @@ DAV:propstat. The @xml can be %NULL, in which case the server should behave like DAV:allprop request. + line="379"/> + line="387"/> + line="449"/> + line="437"/> + line="497"/> + line="352"/> + line="392"/> throws="1"> Changes Access Control List (ACL) for the @uri, or, in case it's %NULL, + line="4760">Changes Access Control List (ACL) for the @uri, or, in case it's %NULL, for the URI defined in associated #ESource. Make sure that the @entries satisfy ACL restrictions, as returned @@ -39704,18 +39982,18 @@ or there's a need to write such Access Control Entry, then do not use e_webdav_session_get_acl_sync(), neither e_webdav_session_set_acl_sync(), and write more generic implementation. + line="598"/> Whether succeeded. + line="4788">Whether succeeded. an #EWebDAVSession + line="4762">an #EWebDAVSession allow-none="1"> URI to issue the request for, or %NULL to read from #ESource + line="4763">URI to issue the request for, or %NULL to read from #ESource entries to write + line="4764">entries to write @@ -39741,7 +40019,7 @@ and write more generic implementation. allow-none="1"> optional #GCancellable object, or %NULL + line="4765">optional #GCancellable object, or %NULL @@ -39757,7 +40035,7 @@ and write more generic implementation. The @message, if provided, is used to verify that the response is an XML Content-Type. It's used to get the request URI as well. + line="522"/> The @message, if provided, is used to verify that the response is an XML Content-Type. It's used to get the request URI as well. + line="515"/> The @message, if provided, is used to verify that the response is a multi-status and that the Content-Type is properly set. It's used to get a request URI as well. + line="508"/> + line="503"/> Updates properties (set/remove) on the provided @uri, or, in case it's %NULL, + line="3781">Updates properties (set/remove) on the provided @uri, or, in case it's %NULL, on the URI defined in associated #ESource, with the @changes. The order of @changes is significant, unlike on other places. @@ -40009,18 +40287,18 @@ This function supports only flat properties, those not under other element. To support more complex property tries use e_webdav_session_proppatch_sync() directly. + line="541"/> Whether succeeded. + line="3797">Whether succeeded. an #EWebDAVSession + line="3783">an #EWebDAVSession allow-none="1"> URI to issue the request for, or %NULL to read from #ESource + line="3784">URI to issue the request for, or %NULL to read from #ESource a #GSList with request changes + line="3785">a #GSList with request changes @@ -40046,7 +40324,7 @@ directly. allow-none="1"> optional #GCancellable object, or %NULL + line="3786">optional #GCancellable object, or %NULL @@ -40062,7 +40340,7 @@ directly. c:type="EWebDAVSessionClass" glib:is-gtype-struct-for="WebDAVSession"> + line="339"/> @@ -40160,7 +40438,7 @@ also with set default namespace @ns_href. version="3.26"> Adds a new attribute to the current element. + line="441">Adds a new attribute to the current element. Use %NULL @ns_href, to use the default namespace, otherwise either previously added namespace with the same href from e_xml_document_add_namespaces() is picked, or a new namespace with generated prefix is added. @@ -40173,7 +40451,7 @@ or a new namespace with generated prefix is added. an #EXmlDocument + line="443">an #EXmlDocument allow-none="1"> optional namespace href for the new attribute, or %NULL + line="444">optional namespace href for the new attribute, or %NULL name of the attribute + line="445">name of the attribute value of the attribute + line="446">value of the attribute @@ -40204,7 +40482,7 @@ or a new namespace with generated prefix is added. version="3.26"> Adds a new attribute with a double value to the current element. + line="504">Adds a new attribute with a double value to the current element. Use %NULL @ns_href, to use the default namespace, otherwise either previously added namespace with the same href from e_xml_document_add_namespaces() is picked, or a new namespace with generated prefix is added. @@ -40217,7 +40495,7 @@ or a new namespace with generated prefix is added. an #EXmlDocument + line="506">an #EXmlDocument allow-none="1"> optional namespace href for the new attribute, or %NULL + line="507">optional namespace href for the new attribute, or %NULL name of the attribute + line="508">name of the attribute double value of the attribute + line="509">double value of the attribute @@ -40248,7 +40526,7 @@ or a new namespace with generated prefix is added. version="3.26"> Adds a new attribute with an integer value to the current element. + line="473">Adds a new attribute with an integer value to the current element. Use %NULL @ns_href, to use the default namespace, otherwise either previously added namespace with the same href from e_xml_document_add_namespaces() is picked, or a new namespace with generated prefix is added. @@ -40261,7 +40539,7 @@ or a new namespace with generated prefix is added. an #EXmlDocument + line="475">an #EXmlDocument allow-none="1"> optional namespace href for the new attribute, or %NULL + line="476">optional namespace href for the new attribute, or %NULL name of the attribute + line="477">name of the attribute integer value of the attribute + line="478">integer value of the attribute @@ -40292,7 +40570,7 @@ or a new namespace with generated prefix is added. version="3.26"> Adds a new attribute with a time_t value in ISO 8601 format to the current element. + line="535">Adds a new attribute with a time_t value in ISO 8601 format to the current element. The format is "YYYY-MM-DDTHH:MM:SSZ". Use %NULL @ns_href, to use the default namespace, otherwise either previously added namespace with the same href from e_xml_document_add_namespaces() is picked, @@ -40306,7 +40584,7 @@ or a new namespace with generated prefix is added. an #EXmlDocument + line="537">an #EXmlDocument allow-none="1"> optional namespace href for the new attribute, or %NULL + line="538">optional namespace href for the new attribute, or %NULL name of the attribute + line="539">name of the attribute time_t value of the attribute - + line="540">time_t value of the attribute + @@ -40337,7 +40615,7 @@ or a new namespace with generated prefix is added. version="3.32"> Adds a new attribute with a time_t value in iCalendar format to the current element. + line="570">Adds a new attribute with a time_t value in iCalendar format to the current element. The format is "YYYYMMDDTHHMMSSZ". Use %NULL @ns_href, to use the default namespace, otherwise either previously added namespace with the same href from e_xml_document_add_namespaces() is picked, @@ -40351,7 +40629,7 @@ or a new namespace with generated prefix is added. an #EXmlDocument + line="572">an #EXmlDocument allow-none="1"> optional namespace href for the new attribute, or %NULL + line="573">optional namespace href for the new attribute, or %NULL name of the attribute + line="574">name of the attribute time_t value of the attribute - + line="575">time_t value of the attribute + @@ -40382,7 +40660,7 @@ or a new namespace with generated prefix is added. version="3.26"> Adds an empty element, which is an element with no attribute and no value. + line="414">Adds an empty element, which is an element with no attribute and no value. It's the same as calling e_xml_document_start_element() immediately followed by e_xml_document_end_element(). @@ -40395,7 +40673,7 @@ followed by e_xml_document_end_element(). an #EXmlDocument + line="416">an #EXmlDocument allow-none="1"> optional namespace href for the new element, or %NULL + line="417">optional namespace href for the new element, or %NULL name of the new element + line="418">name of the new element @@ -40421,7 +40699,7 @@ followed by e_xml_document_end_element(). introspectable="0"> Adds one or more namespaces to @xml, which can be referenced + line="182">Adds one or more namespaces to @xml, which can be referenced later by @ns_href. The caller should take care that neither used @ns_prefix, nor @ns_href, is already used by @xml. an #EXmlDocument + line="184">an #EXmlDocument namespace prefix to use for this namespace + line="185">namespace prefix to use for this namespace namespace href + line="186">namespace href %NULL-terminated pairs of (ns_prefix, ns_href) + line="187">%NULL-terminated pairs of (ns_prefix, ns_href) @@ -40461,7 +40739,7 @@ used @ns_prefix, nor @ns_href, is already used by @xml. version="3.26"> This is a pair function for e_xml_document_start_element() and + line="394">This is a pair function for e_xml_document_start_element() and e_xml_document_start_text_element(), which changes current element to the parent of that element. an #EXmlDocument + line="396">an #EXmlDocument @@ -40539,7 +40817,7 @@ nul character. version="3.26"> Starts a new non-text element as a child of the current element. + line="334">Starts a new non-text element as a child of the current element. Each such call should be ended with corresponding e_xml_document_end_element(). Use %NULL @ns_href, to use the default namespace, otherwise either previously added namespace with the same href from e_xml_document_add_namespaces() is picked, @@ -40555,7 +40833,7 @@ To start a text node use e_xml_document_start_text_element(). an #EXmlDocument + line="336">an #EXmlDocument allow-none="1"> optional namespace href for the new element, or %NULL + line="337">optional namespace href for the new element, or %NULL name of the new element + line="338">name of the new element @@ -40580,7 +40858,7 @@ To start a text node use e_xml_document_start_text_element(). version="3.26"> Starts a new text element as a child of the current element. + line="364">Starts a new text element as a child of the current element. Each such call should be ended with corresponding e_xml_document_end_element(). Use %NULL @ns_href, to use the default namespace, otherwise either previously added namespace with the same href from e_xml_document_add_namespaces() is picked, @@ -40596,7 +40874,7 @@ To start a non-text node use e_xml_document_start_element(). an #EXmlDocument + line="366">an #EXmlDocument allow-none="1"> optional namespace href for the new element, or %NULL + line="367">optional namespace href for the new element, or %NULL name of the new element + line="368">name of the new element @@ -40621,7 +40899,7 @@ To start a non-text node use e_xml_document_start_element(). version="3.26"> Writes @value of length @len, encoded to base64, as content of the current element. + line="655">Writes @value of length @len, encoded to base64, as content of the current element. @@ -40631,19 +40909,19 @@ To start a non-text node use e_xml_document_start_element(). an #EXmlDocument + line="657">an #EXmlDocument value to write as the content + line="658">value to write as the content length of @value + line="659">length of @value @@ -40653,7 +40931,7 @@ To start a non-text node use e_xml_document_start_element(). version="3.26"> Writes @value of length @len as content of the current element. + line="730">Writes @value of length @len as content of the current element. @@ -40663,19 +40941,19 @@ To start a non-text node use e_xml_document_start_element(). an #EXmlDocument + line="732">an #EXmlDocument value to write as the content + line="733">value to write as the content length of @value + line="734">length of @value @@ -40685,7 +40963,7 @@ To start a non-text node use e_xml_document_start_element(). version="3.26"> Writes @value as content of the current element. + line="632">Writes @value as content of the current element. @@ -40695,13 +40973,13 @@ To start a non-text node use e_xml_document_start_element(). an #EXmlDocument + line="634">an #EXmlDocument value to write as the content + line="635">value to write as the content @@ -40711,7 +40989,7 @@ To start a non-text node use e_xml_document_start_element(). version="3.26"> Writes @value as content of the current element. + line="609">Writes @value as content of the current element. @@ -40721,13 +40999,13 @@ To start a non-text node use e_xml_document_start_element(). an #EXmlDocument + line="611">an #EXmlDocument value to write as the content + line="612">value to write as the content @@ -40737,7 +41015,7 @@ To start a non-text node use e_xml_document_start_element(). version="3.26"> Writes @value as content of the current element. + line="708">Writes @value as content of the current element. @@ -40747,13 +41025,13 @@ To start a non-text node use e_xml_document_start_element(). an #EXmlDocument + line="710">an #EXmlDocument value to write as the content + line="711">value to write as the content @@ -40763,7 +41041,7 @@ To start a non-text node use e_xml_document_start_element(). version="3.26"> Writes @value in ISO 8601 format as content of the current element. + line="681">Writes @value in ISO 8601 format as content of the current element. The format is "YYYY-MM-DDTHH:MM:SSZ". @@ -40774,14 +41052,14 @@ The format is "YYYY-MM-DDTHH:MM:SSZ". an #EXmlDocument + line="683">an #EXmlDocument value to write as the content - + line="684">value to write as the content + @@ -40912,7 +41190,7 @@ The format is "YYYY-MM-DDTHH:MM:SSZ". introspectable="0"> Pass this function as the #GAsyncReadyCallback argument of an asynchronous + line="1871">Pass this function as the #GAsyncReadyCallback argument of an asynchronous function, and the #EAsyncClosure as the data argument. This causes e_async_closure_wait() to terminate and return @result. @@ -40928,14 +41206,14 @@ This causes e_async_closure_wait() to terminate and return @result. allow-none="1"> a #GObject or %NULL, it is not used by the function + line="1873">a #GObject or %NULL, it is not used by the function at all a #GAsyncResult + line="1875">a #GAsyncResult allow-none="1"> an #EAsyncClosure + line="1876">an #EAsyncClosure @@ -40956,13 +41234,13 @@ This causes e_async_closure_wait() to terminate and return @result. introspectable="0"> Creates a new #EAsyncClosure for use with asynchronous functions. + line="1736">Creates a new #EAsyncClosure for use with asynchronous functions. a new #EAsyncClosure + line="1741">a new #EAsyncClosure @@ -40973,14 +41251,14 @@ This causes e_async_closure_wait() to terminate and return @result. introspectable="0"> Creates a new #EAsyncClosure for use with asynchronous functions + line="1758">Creates a new #EAsyncClosure for use with asynchronous functions using the @context as the main context. a new #EAsyncClosure + line="1765">a new #EAsyncClosure @@ -40990,7 +41268,7 @@ using the @context as the main context. allow-none="1"> a #GMainContext to use, or %NULL to use the default context + line="1760">a #GMainContext to use, or %NULL to use the default context @@ -41000,7 +41278,7 @@ using the @context as the main context. version="3.16"> Thread safe variant of g_object_bind_property(). See its documentation + line="1442">Thread safe variant of g_object_bind_property(). See its documentation for more information on arguments and return value. @@ -41011,31 +41289,31 @@ for more information on arguments and return value. the source #GObject + line="1444">the source #GObject the property on @source to bind + line="1445">the property on @source to bind the target #GObject + line="1446">the target #GObject the property on @target to bind + line="1447">the property on @target to bind flags to pass to #GBinding + line="1448">flags to pass to #GBinding @@ -41046,14 +41324,14 @@ for more information on arguments and return value. version="3.16"> Thread safe variant of g_object_bind_property_full(). See its documentation + line="1467">Thread safe variant of g_object_bind_property_full(). See its documentation for more information on arguments and return value. the #GBinding instance representing the + line="1486">the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero. @@ -41062,31 +41340,31 @@ for more information on arguments and return value. the source #GObject + line="1469">the source #GObject the property on @source to bind + line="1470">the property on @source to bind the target #GObject + line="1471">the target #GObject the property on @target to bind + line="1472">the property on @target to bind flags to pass to #GBinding + line="1473">flags to pass to #GBinding scope="notified"> the transformation function + line="1474">the transformation function from the @source to the @target, or %NULL to use the default @@ -41110,7 +41388,7 @@ for more information on arguments and return value. destroy="8"> the transformation function + line="1476">the transformation function from the @target to the @source, or %NULL to use the default @@ -41121,14 +41399,14 @@ for more information on arguments and return value. allow-none="1"> custom data to be passed to the transformation functions, + line="1478">custom data to be passed to the transformation functions, or %NULL function to be called when disposing the binding, to free the + line="1480">function to be called when disposing the binding, to free the resources used by the transformation functions @@ -41140,14 +41418,14 @@ for more information on arguments and return value. version="3.16"> Thread safe variant of g_object_bind_property_with_closures(). See its + line="1507">Thread safe variant of g_object_bind_property_with_closures(). See its documentation for more information on arguments and return value. the #GBinding instance representing the + line="1522">the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero. @@ -41156,31 +41434,31 @@ documentation for more information on arguments and return value. the source #GObject + line="1509">the source #GObject the property on @source to bind + line="1510">the property on @source to bind the target #GObject + line="1511">the target #GObject the property on @target to bind + line="1512">the property on @target to bind flags to pass to #GBinding + line="1513">flags to pass to #GBinding allow-none="1"> a #GClosure wrapping the transformation function + line="1514">a #GClosure wrapping the transformation function from the @source to the @target, or %NULL to use the default @@ -41199,7 +41477,7 @@ documentation for more information on arguments and return value. allow-none="1"> a #GClosure wrapping the transformation function + line="1516">a #GClosure wrapping the transformation function from the @target to the @source, or %NULL to use the default @@ -41210,32 +41488,32 @@ documentation for more information on arguments and return value. version="3.4"> Transforms an enumeration nickname to its corresponding value. + line="1580">Transforms an enumeration nickname to its corresponding value. %TRUE if the enum nickname has a corresponding value + line="1589">%TRUE if the enum nickname has a corresponding value a #GBinding + line="1582">a #GBinding a #GValue of type #G_TYPE_STRING + line="1583">a #GValue of type #G_TYPE_STRING a #GValue whose type is derived from #G_TYPE_ENUM + line="1584">a #GValue whose type is derived from #G_TYPE_ENUM allow-none="1"> not used + line="1585">not used @@ -41254,32 +41532,32 @@ documentation for more information on arguments and return value. version="3.4"> Transforms an enumeration value to its corresponding nickname. + line="1541">Transforms an enumeration value to its corresponding nickname. %TRUE if the enum value has a corresponding nickname + line="1550">%TRUE if the enum value has a corresponding nickname a #GBinding + line="1543">a #GBinding a #GValue whose type is derived from #G_TYPE_ENUM + line="1544">a #GValue whose type is derived from #G_TYPE_ENUM a #GValue of type #G_TYPE_STRING + line="1545">a #GValue of type #G_TYPE_STRING allow-none="1"> not used + line="1546">not used @@ -41604,14 +41882,14 @@ This function is thread safe. deprecated-version="3.8"> Returns the value set by e_data_server_util_set_dbus_call_timeout(). + line="2179">Returns the value set by e_data_server_util_set_dbus_call_timeout(). This value is not used anywhere. the D-Bus call timeout in milliseconds + line="2184">the D-Bus call timeout in milliseconds @@ -41622,7 +41900,7 @@ This function is thread safe. deprecated-version="3.8"> Sets default timeout, in milliseconds, for calls of g_dbus_proxy_call() + line="2156">Sets default timeout, in milliseconds, for calls of g_dbus_proxy_call() family functions. -1 means the default value as set by D-Bus itself. @@ -41640,7 +41918,7 @@ and -1 is used when not set. default timeout for D-Bus calls in miliseconds + line="2158">default timeout for D-Bus calls in miliseconds @@ -42680,14 +42958,14 @@ modified or freed. version="3.8"> Fetches the appropriate enumeration value for @string in the given + line="1619">Fetches the appropriate enumeration value for @string in the given enum type @type and stores the result in @enum_value %TRUE if the string was a valid name or nick + line="1628">%TRUE if the string was a valid name or nick for the given @type, %FALSE if the conversion failed. @@ -42695,19 +42973,19 @@ enum type @type and stores the result in @enum_value The enum type + line="1621">The enum type The string containing the enum value or nick + line="1622">The string containing the enum value or nick A return location to store the result + line="1623">A return location to store the result @@ -42717,26 +42995,26 @@ enum type @type and stores the result in @enum_value version="3.8"> Converts an enum value to a string using strings from the GType system. + line="1668">Converts an enum value to a string using strings from the GType system. the string representing @eval + line="1675">the string representing @eval An enum type + line="1670">An enum type The enum value to convert + line="1671">The enum value to convert @@ -42746,7 +43024,7 @@ enum type @type and stores the result in @enum_value version="3.6"> Asynchronously deletes @file. If @file is a directory, its contents + line="1375">Asynchronously deletes @file. If @file is a directory, its contents are deleted recursively before @file itself is deleted. The recursive delete operation will stop on the first error. @@ -42764,13 +43042,13 @@ call e_file_recursive_delete_finish() to get the result of the operation. a #GFile to delete + line="1377">a #GFile to delete the I/O priority of the request + line="1378">the I/O priority of the request allow-none="1"> optional #GCancellable object, or %NULL + line="1379">optional #GCancellable object, or %NULL closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + line="1380">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> data to pass to the callback function + line="1381">data to pass to the callback function @@ -42843,7 +43121,7 @@ returned. throws="1"> Deletes @file. If @file is a directory, its contents are deleted + line="1288">Deletes @file. If @file is a directory, its contents are deleted recursively before @file itself is deleted. The recursive delete operation will stop on the first error. @@ -42856,14 +43134,14 @@ returned. %TRUE if the file was deleted, %FALSE otherwise + line="1303">%TRUE if the file was deleted, %FALSE otherwise a #GFile to delete + line="1290">a #GFile to delete allow-none="1"> optional #GCancellable object, or %NULL + line="1291">optional #GCancellable object, or %NULL @@ -43709,7 +43987,7 @@ seconds from UTC time, stored in @offset. The #time_t to convert. - + The calendar time representation of @tm. - + introspectable="0"> Similar to g_timeout_add(), but also names the #GSource for use in + line="2196">Similar to g_timeout_add(), but also names the #GSource for use in debugging and profiling. The name is formed from @function and the <literal>PACKAGE</literal> definintion from a &lt;config.h&gt; file. the time between calls to the function, in milliseconds + line="2198">the time between calls to the function, in milliseconds (1/1000ths of a second) function to call + line="2200">function to call data to pass to @function + line="2201">data to pass to @function @@ -43960,7 +44238,7 @@ debugging and profiling. The name is formed from @function and the introspectable="0"> Similar to g_timeout_add_full(), but also names the #GSource for use + line="2212">Similar to g_timeout_add_full(), but also names the #GSource for use in debugging and profiling. The name is formed from @function and the <literal>PACKAGE</literal> definition from a &lt;config.h&gt; file. the priority of the timeout source, typically in the + line="2214">the priority of the timeout source, typically in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH the time between calls to the function, in milliseconds + line="2216">the time between calls to the function, in milliseconds (1/1000ths of a second) function to call + line="2218">function to call data to pass to @function + line="2219">data to pass to @function function to call when the timeout is removed, or %NULL + line="2220">function to call when the timeout is removed, or %NULL @@ -44001,7 +44279,7 @@ in debugging and profiling. The name is formed from @function and the introspectable="0"> Similar to g_timeout_add_seconds(), but also names the #GSource for use + line="2231">Similar to g_timeout_add_seconds(), but also names the #GSource for use in debugging and profiling. The name is formed from @function and the <literal>PACKAGE</literal> definition from a &lt;config.h&gt; file. the time between calls to the function, in seconds + line="2233">the time between calls to the function, in seconds function to call + line="2234">function to call data to pass to @function + line="2235">data to pass to @function @@ -44030,7 +44308,7 @@ in debugging and profiling. The name is formed from @function and the introspectable="0"> Similar to g_timeout_add_seconds_full(), but also names the #GSource for + line="2246">Similar to g_timeout_add_seconds_full(), but also names the #GSource for use in debugging and profiling. The name is formed from @function and the <literal>PACKAGE</literal> definition from a &lt;config.h&gt; file. the priority of the timeout source, typically in the + line="2248">the priority of the timeout source, typically in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH the time between calls to the function, in seconds + line="2250">the time between calls to the function, in seconds function to call + line="2251">function to call data to pass to @function + line="2252">data to pass to @function function to call when the timeout is removed, or %NULL + line="2253">function to call when the timeout is removed, or %NULL @@ -44916,7 +45194,7 @@ are accepted as well. version="3.12"> Similar to g_timeout_add_seconds_full(), but also names the #GSource as + line="2313">Similar to g_timeout_add_seconds_full(), but also names the #GSource as @name. You might find e_named_timeout_add_seconds() or @@ -44927,21 +45205,21 @@ the #GSource implicitly. the ID (greater than 0) of the event source + line="2331">the ID (greater than 0) of the event source the priority of the timeout source, typically in the + line="2315">the priority of the timeout source, typically in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH the time between calls to the function, in seconds + line="2317">the time between calls to the function, in seconds allow-none="1"> debug name for the source + line="2318">debug name for the source destroy="5"> function to call + line="2319">function to call allow-none="1"> data to pass to @function + line="2320">data to pass to @function scope="async"> function to call when the timeout is removed, + line="2321">function to call when the timeout is removed, or %NULL @@ -44990,7 +45268,7 @@ the #GSource implicitly. version="3.12"> Similar to g_timeout_add_full(), but also names the #GSource as @name. + line="2264">Similar to g_timeout_add_full(), but also names the #GSource as @name. You might find e_named_timeout_add() or e_named_timeout_add_full() more convenient. Those macros name the #GSource implicitly. @@ -44999,21 +45277,21 @@ convenient. Those macros name the #GSource implicitly. the ID (greather than 0) of the event source + line="2281">the ID (greather than 0) of the event source the priority of the timeout source, typically in the + line="2266">the priority of the timeout source, typically in the range between #G_PRIORITY_DEFAULT and #G_PRIORITY_HIGH the time between calls to the function, in milliseconds + line="2268">the time between calls to the function, in milliseconds (1/1000ths of a second) @@ -45023,7 +45301,7 @@ convenient. Those macros name the #GSource implicitly. allow-none="1"> debug name for the source + line="2270">debug name for the source destroy="5"> function to call + line="2271">function to call allow-none="1"> data to pass to @function + line="2272">data to pass to @function scope="async"> function to call when the timeout is removed, + line="2273">function to call when the timeout is removed, or %NULL @@ -45063,7 +45341,7 @@ convenient. Those macros name the #GSource implicitly. version="3.4"> Calls @func for all instantiable subtypes of @parent_type. + line="2486">Calls @func for all instantiable subtypes of @parent_type. This is often useful for extending functionality by way of #EModule. A module may register a subtype of @parent_type in its e_module_load() @@ -45078,7 +45356,7 @@ to instantiate all registered subtypes of @parent_type. the root #GType to traverse from + line="2488">the root #GType to traverse from closure="2"> the function to call for each visited #GType + line="2489">the function to call for each visited #GType allow-none="1"> user data to pass to the function + line="2490">user data to pass to the function @@ -45166,7 +45444,7 @@ when it's done with it. introspectable="0"> Calls malloc_trim() to free unused heap memory. The function + line="3063">Calls malloc_trim() to free unused heap memory. The function does nothing, when the malloc_trim() is not available. This might be called after some operations which may use a lot @@ -45182,7 +45460,7 @@ of memory temporarily. version="3.28"> Checks whether the @collection_source can be used as a credential source + line="2766">Checks whether the @collection_source can be used as a credential source for the @child_source. The relationship is not tested in the function. When the @collection_source is %NULL, then it simply returns %FALSE. whether @collection_source can be used as a credential source + line="2775">whether @collection_source can be used as a credential source for @child_source, that is, whether they share credentials. @@ -45201,7 +45479,7 @@ When the @collection_source is %NULL, then it simply returns %FALSE. allow-none="1"> a collection #ESource, or %NULL + line="2768">a collection #ESource, or %NULL allow-none="1"> a children of @collection_source + line="2769">a children of @collection_source @@ -45220,7 +45498,7 @@ When the @collection_source is %NULL, then it simply returns %FALSE. version="3.46"> Changes component @component in the @inout_uri to value @value. + line="2992">Changes component @component in the @inout_uri to value @value. As the #GUri cannot be modified the @inout_uri points to a new #GUri at the end of the call and the previous structure is unreffed. @@ -45237,13 +45515,13 @@ See: e_util_change_uri_port() transfer-ownership="full"> a #GUri + line="2994">a #GUri a string #SoupURIComponent to change + line="2995">a string #SoupURIComponent to change allow-none="1"> a value to set, or %NULL to unset + line="2996">a value to set, or %NULL to unset @@ -45262,7 +45540,7 @@ See: e_util_change_uri_port() version="3.46"> Changes the port in the @inout_uri to value @port. + line="3036">Changes the port in the @inout_uri to value @port. As the #GUri cannot be modified the @inout_uri points to a new #GUri at the end of the call and the previous structure is unreffed. @@ -45279,13 +45557,13 @@ See: e_util_change_uri_component() transfer-ownership="full"> a #GUri + line="3038">a #GUri the port number to set + line="3039">the port number to set @@ -45384,7 +45662,7 @@ Returned pointer can be freed with e_util_free_string_slist(). introspectable="0"> Prints a text according to @format and its arguments to stdout + line="2406">Prints a text according to @format and its arguments to stdout prefixed with @domain in brackets [] and the current date and time. This function doesn't check whether the logging is enabled, it's up to the caller to determine it, the function only prints the information @@ -45401,19 +45679,19 @@ See: e_util_debug_printv() a debug domain + line="2408">a debug domain a printf-like format + line="2409">a printf-like format arguments for the @format + line="2410">arguments for the @format @@ -45424,7 +45702,7 @@ See: e_util_debug_printv() introspectable="0"> Prints a text according to @format and its @args to stdout + line="2435">Prints a text according to @format and its @args to stdout prefixed with @domain in brackets [] and the current date and time. This function doesn't check whether the logging is enabled, it's up to the caller to determine it, the function only prints the information @@ -45441,19 +45719,19 @@ See: e_util_debug_print() a debug domain + line="2437">a debug domain a printf-like format + line="2438">a printf-like format arguments for the @format + line="2439">arguments for the @format @@ -45595,7 +45873,7 @@ also @objects itself. version="3.26"> Generates a unique identificator, which can be used as part of + line="2649">Generates a unique identificator, which can be used as part of the Message-ID header, or iCalendar component UID, or vCard UID. The resulting string doesn't contain any host name, it's a hexa-decimal string with no particular meaning. @@ -45606,7 +45884,7 @@ Free the returned string with g_free(), when no longer needed. generated unique identificator as + line="2659">generated unique identificator as a newly allocated string @@ -45616,7 +45894,7 @@ Free the returned string with g_free(), when no longer needed. version="3.40"> The @main_path is a directory, which will be always used. It + line="2957">The @main_path is a directory, which will be always used. It should have as its prefix the @replace_prefix, otherwise the function returns only the @main_path in the paths array. @@ -45632,7 +45910,7 @@ g_get_user_data_dir() + "evolution/modules/", aka a %GPtrArray + line="2975">a %GPtrArray with paths to use, including the @main_path. Free it with g_ptr_array_unref(), when no longer needed. @@ -45643,19 +45921,19 @@ g_get_user_data_dir() + "evolution/modules/", aka the main path to work with + line="2959">the main path to work with path prefix to replace + line="2960">path prefix to replace whether to add also the modules directory + line="2961">whether to add also the modules directory @@ -45664,7 +45942,7 @@ g_get_user_data_dir() + "evolution/modules/", aka c:identifier="e_util_get_source_full_name"> Constructs a full name of the @source with all of its parents + line="2529">Constructs a full name of the @source with all of its parents of the form: "&lt;account-name&gt; : &lt;parent&gt;/&lt;source&gt;" where the "&lt;parent&gt;/" part can be repeated zero or more times, depending on the deep level of the @source. @@ -45673,7 +45951,7 @@ on the deep level of the @source. Full name of the @source as a newly allocated + line="2539">Full name of the @source as a newly allocated string, which should be freed with g_free() when done with it. Since 3.18 @@ -45686,7 +45964,7 @@ Since 3.18 allow-none="1"> an #ESourceRegistry + line="2531">an #ESourceRegistry allow-none="1"> an #ESource + line="2532">an #ESource @@ -45733,19 +46011,50 @@ reused after a thread has terminated, though. + + Guesses whether the @source is read only. This is done on some heuristic +like the source backend, where some are known to be read only. That this +function returns %FALSE does not necessarily mean the source is writable, +it only means the source is not well-known read-only source. To know +for sure open the corresponding #EClient, if the @source references such, +and use e_client_is_readonly(). + + + %TRUE, when the @source is well-known read-only source, or %FALSE otherwise + + + + + an #ESource + + + + Checks whether the @identity_source can be used for sending, which means + line="2706">Checks whether the @identity_source can be used for sending, which means whether it has configures send mail source. Whether @identity_source can be used to send messages + line="2714">Whether @identity_source can be used to send messages @@ -45755,7 +46064,7 @@ whether it has configures send mail source. allow-none="1"> an #ESourceRegistry + line="2708">an #ESourceRegistry allow-none="1"> an #ESource with mail identity extension + line="2709">an #ESource with mail identity extension @@ -45825,7 +46134,7 @@ Note: Pair function for this is e_util_strv_to_slist(). version="3.40"> Compares two #ESource-s in a way suitable for user interface. + line="2894">Compares two #ESource-s in a way suitable for user interface. It can be used as a #GCompareFunc. This is also used by e_source_registry_build_display_tree(). @@ -45834,7 +46143,7 @@ This is also used by e_source_registry_build_display_tree(). an integer less than, equal to, or greater than zero, + line="2904">an integer less than, equal to, or greater than zero, if @source_a is <, == or > than @source_b. @@ -45845,7 +46154,7 @@ This is also used by e_source_registry_build_display_tree(). allow-none="1"> the first #ESource + line="2896">the first #ESource allow-none="1"> the second #ESource + line="2897">the second #ESource @@ -46050,7 +46359,7 @@ Note: Pair function for this is e_util_slist_to_strv(). version="3.26"> Unrefs the given @object in a dedicated thread. This is useful when unreffing + line="2617">Unrefs the given @object in a dedicated thread. This is useful when unreffing object deep in call stack when the caller might still use the object and this being the last reference to it. allow-none="1"> a #GObject + line="2619">a #GObject @@ -46367,7 +46676,7 @@ Free the returned #GWeakRef with e_weak_ref_free(). line="542">Frees an #EWebDAVAccessControlEntry previously created with e_webdav_access_control_entry_new() or e_webdav_access_control_entry_copy(). The function does nothing, if @ptr is %NULL. + line="305"/> @@ -46957,7 +47266,7 @@ no longer needed. line="433">Frees an #EWebDAVPrivilege previously created with e_webdav_privilege_new() or e_webdav_privilege_copy(). The function does nothing, if @ptr is %NULL. + line="267"/> @@ -46983,7 +47292,7 @@ or e_webdav_privilege_copy(). The function does nothing, if @ptr is %NULL. e_webdav_property_change_new_remove() or or e_webdav_property_change_copy(). The function does nothing, if @ptr is %NULL. + line="208"/> @@ -47008,7 +47317,7 @@ The function does nothing, if @ptr is %NULL. line="145">Frees an #EWebDAVResource previously created with e_webdav_resource_new() or e_webdav_resource_copy(). The function does nothing, if @ptr is %NULL. + line="140"/> @@ -47051,7 +47360,7 @@ or e_webdav_resource_copy(). The function does nothing, if @ptr is %NULL. introspectable="0"> Duplicates content of the @node. If the @node is %NULL, then the + line="597">Duplicates content of the @node. If the @node is %NULL, then the function does nothing and returns also %NULL. Unlike e_xml_get_node_text(), this includes also any element sub-structure @@ -47060,7 +47369,7 @@ of the @node, if any such exists. the @node content as #xmlChar string, + line="607">the @node content as #xmlChar string, or %NULL, when the content could not be read or was not set. Free the non-%NULL value with xmlFree(), when no longer needed. @@ -47074,7 +47383,7 @@ See: e_xml_find_child_and_dup_content(), e_xml_get_node_text() allow-none="1"> an #xmlNode + line="599">an #xmlNode @@ -47085,12 +47394,12 @@ See: e_xml_find_child_and_dup_content(), e_xml_get_node_text() introspectable="0"> Searches the children nodes of the @parent for an element named @name in namespace @ns_href. + line="571">Searches the children nodes of the @parent for an element named @name in namespace @ns_href. an #xmlNode of the given name, or %NULL, if not found. + line="579">an #xmlNode of the given name, or %NULL, if not found. It also returns %NULL, when the @parent is %NULL. See: e_xml_find_sibling(), e_xml_find_children_nodes() @@ -47103,7 +47412,7 @@ See: e_xml_find_sibling(), e_xml_find_children_nodes() allow-none="1"> an #xmlNode, parent of which immediate children to search + line="573">an #xmlNode, parent of which immediate children to search allow-none="1"> a namespace href the node should have set, or %NULL for none namespace + line="574">a namespace href the node should have set, or %NULL for none namespace an element name to search for + line="575">an element name to search for @@ -47129,13 +47438,13 @@ See: e_xml_find_sibling(), e_xml_find_children_nodes() introspectable="0"> Searches the children nodes of the @parent for an element named @name in namespace @ns_href + line="624">Searches the children nodes of the @parent for an element named @name in namespace @ns_href and returns its content. This combines e_xml_find_child() and e_xml_dup_node_content() calls. the found node content as #xmlChar string, + line="633">the found node content as #xmlChar string, or %NULL, when the node could not be found or the content could not be read or was not set. Free the non-%NULL value with xmlFree(), when no longer needed. @@ -47149,7 +47458,7 @@ See: e_xml_find_child_and_get_text() allow-none="1"> an #xmlNode, parent of which immediate children to search + line="626">an #xmlNode, parent of which immediate children to search allow-none="1"> a namespace href the node should have set, or %NULL for none namespace + line="627">a namespace href the node should have set, or %NULL for none namespace an element name to search for + line="628">an element name to search for @@ -47175,7 +47484,7 @@ See: e_xml_find_child_and_get_text() introspectable="0"> Searches the children nodes of the @parent for an element named @name in namespace @ns_href + line="694">Searches the children nodes of the @parent for an element named @name in namespace @ns_href and returns its text content. It combines e_xml_find_child() and e_xml_get_node_text() calls. @@ -47183,7 +47492,7 @@ It combines e_xml_find_child() and e_xml_get_node_text() calls. the found node text as #xmlChar string, + line="705">the found node text as #xmlChar string, or %NULL, when the node could not be found or the content could not be read or was not set. @@ -47197,7 +47506,7 @@ See: e_xml_find_child_and_dup_content(), e_xml_find_children_nodes() allow-none="1"> an #xmlNode, parent of which immediate children to search + line="696">an #xmlNode, parent of which immediate children to search allow-none="1"> a namespace href the node should have set, or %NULL for none namespace + line="697">a namespace href the node should have set, or %NULL for none namespace an element name to search for + line="698">an element name to search for @@ -47223,7 +47532,7 @@ See: e_xml_find_child_and_dup_content(), e_xml_find_children_nodes() introspectable="0"> Retrieve multiple nodes in one go, in an efficient way. It can be + line="728">Retrieve multiple nodes in one go, in an efficient way. It can be quicker than traversing the children of the @parent @count times in certain circumstances. @@ -47242,19 +47551,19 @@ The names should not be included more than once. an #xmlNode, whose children to search + line="730">an #xmlNode, whose children to search how many nodes will be read + line="731">how many nodes will be read triple of arguments describing the nodes and their out variable + line="732">triple of arguments describing the nodes and their out variable @@ -47265,7 +47574,7 @@ The names should not be included more than once. introspectable="0"> Checks whether the @parent has a hierarchy of children described by pair + line="794">Checks whether the @parent has a hierarchy of children described by pair of 'ns_href' and 'name'. Note: It requires two %NULL-s at the end of the arguments, because the `ns_href' can @@ -47275,7 +47584,7 @@ Note: It requires two %NULL-s at the end of the arguments, because the `ns_href' an #xmlNode referencing the node in the hierarchy + line="808">an #xmlNode referencing the node in the hierarchy of the children of the @parent, or %NULL, when no such found. @@ -47286,7 +47595,7 @@ Note: It requires two %NULL-s at the end of the arguments, because the `ns_href' allow-none="1"> an #xmlNode, or %NULL, in which case function does nothing and just returns %NULL + line="796">an #xmlNode, or %NULL, in which case function does nothing and just returns %NULL a namespace href the node should have set, or %NULL for none namespace + line="797">a namespace href the node should have set, or %NULL for none namespace an element name to search for + line="798">an element name to search for a two-%NULL-terminated pair of hierarchy children + line="799">a two-%NULL-terminated pair of hierarchy children @@ -47318,13 +47627,13 @@ Note: It requires two %NULL-s at the end of the arguments, because the `ns_href' introspectable="0"> Searches for the next sibling node of the @sibling for an element named @name in namespace @ns_href. + line="544">Searches for the next sibling node of the @sibling for an element named @name in namespace @ns_href. Unlike e_xml_find_sibling(), it skips the @sibling itself. an #xmlNode of the given name, or %NULL, if not found + line="553">an #xmlNode of the given name, or %NULL, if not found It also returns %NULL, when the @sibling is %NULL. See: e_xml_find_sibling(), e_xml_find_child() @@ -47337,7 +47646,7 @@ See: e_xml_find_sibling(), e_xml_find_child() allow-none="1"> an #xmlNode, where to search from + line="546">an #xmlNode, where to search from allow-none="1"> a namespace href the node should have set, or %NULL for none namespace + line="547">a namespace href the node should have set, or %NULL for none namespace an element name to search for + line="548">an element name to search for @@ -47363,13 +47672,13 @@ See: e_xml_find_sibling(), e_xml_find_child() introspectable="0"> Searches the sibling nodes of the @sibling for an element named @name in namespace @ns_href. + line="513">Searches the sibling nodes of the @sibling for an element named @name in namespace @ns_href. It checks the @sibling itself too, but it doesn't check the previous siblings of the @sibling. an #xmlNode of the given name, or %NULL, if not found + line="522">an #xmlNode of the given name, or %NULL, if not found It also returns %NULL, when the @sibling is %NULL. See: e_xml_find_next_sibling(), e_xml_find_child() @@ -47382,7 +47691,7 @@ See: e_xml_find_next_sibling(), e_xml_find_child() allow-none="1"> an #xmlNode, where to start searching + line="515">an #xmlNode, where to start searching allow-none="1"> a namespace href the node should have set, or %NULL for none namespace + line="516">a namespace href the node should have set, or %NULL for none namespace an element name to search for + line="517">an element name to search for @@ -47446,26 +47755,26 @@ to build an equivalent #xmlDoc. This is the reverse of e_xml_to_hash(). introspectable="0"> Attempts to find a child element of @parent named @child_name. + line="179">Attempts to find a child element of @parent named @child_name. If no such child exists, the function returns %NULL. a child XML node structure, or %NULL + line="187">a child XML node structure, or %NULL an XML node structure + line="181">an XML node structure element name of a child node + line="182">element name of a child node @@ -47476,7 +47785,7 @@ If no such child exists, the function returns %NULL. introspectable="0"> Retrieves content of the @node. If the @node is %NULL, then the + line="656">Retrieves content of the @node. If the @node is %NULL, then the function does nothing and returns also %NULL. This is similar to e_xml_dup_node_content(), except it does not @@ -47488,7 +47797,7 @@ reading element values with a single text node as a child. The @node content, or %NULL. + line="669">The @node content, or %NULL. See: e_xml_dup_node_content() @@ -47500,7 +47809,7 @@ See: e_xml_dup_node_content() allow-none="1"> an #xmlNode + line="658">an #xmlNode @@ -47511,7 +47820,7 @@ See: e_xml_dup_node_content() introspectable="0"> Initializes libxml library global memory. This should be called + line="43">Initializes libxml library global memory. This should be called in the main thread. The function does nothing, when it had been called already. @@ -47527,7 +47836,7 @@ called already. Whether the @node is an element node of name @name and with a namespace href set to @ns_href + line="481">Whether the @node is an element node of name @name and with a namespace href set to @ns_href @@ -47537,7 +47846,7 @@ called already. allow-none="1"> an #xmlNode + line="477">an #xmlNode allow-none="1"> a namespace href the node should have set, or %NULL for none namespace + line="478">a namespace href the node should have set, or %NULL for none namespace an element name to search for + line="479">an element name to search for @@ -47563,14 +47872,14 @@ called already. introspectable="0"> Creates a new #xmlXPathContextPtr on @doc with preregistered + line="229">Creates a new #xmlXPathContextPtr on @doc with preregistered namespaces. The namepsaces are pair of (prefix, href), terminated by %NULL. a new #xmlXPathContextPtr. Free the returned + line="238">a new #xmlXPathContextPtr. Free the returned pointer with xmlXPathFreeContext() when no longer needed. @@ -47578,13 +47887,13 @@ by %NULL. an #xmlDocPtr + line="231">an #xmlDocPtr %NULL-terminated list of pairs (prefix, href) with namespaces + line="232">%NULL-terminated list of pairs (prefix, href) with namespaces @@ -47595,13 +47904,13 @@ by %NULL. introspectable="0"> Parses XML data into an #xmlDocPtr. Free returned pointer + line="206">Parses XML data into an #xmlDocPtr. Free returned pointer with xmlFreeDoc(), when no longer needed. a new #xmlDocPtr with parsed @data, + line="214">a new #xmlDocPtr with parsed @data, or %NULL on error. @@ -47609,7 +47918,7 @@ with xmlFreeDoc(), when no longer needed. an XML data + line="208">an XML data @@ -47617,7 +47926,7 @@ with xmlFreeDoc(), when no longer needed. length of data, should be greated than zero + line="209">length of data, should be greated than zero @@ -47627,21 +47936,21 @@ with xmlFreeDoc(), when no longer needed. introspectable="0"> Reads a local XML file and parses the contents into an XML document + line="66">Reads a local XML file and parses the contents into an XML document structure. If the XML file cannot be read or its contents are malformed, the function returns %NULL. an XML document structure, or %NULL + line="74">an XML document structure, or %NULL path to an XML file + line="68">path to an XML file @@ -47649,26 +47958,26 @@ the function returns %NULL. Writes the given XML document structure to the file given by @filename. + line="94">Writes the given XML document structure to the file given by @filename. If an error occurs while saving, the function returns -1 and sets errno. 0 on success, -1 on failure + line="102">0 on success, -1 on failure path to a file to save to + line="96">path to a file to save to an XML document structure + line="97">an XML document structure @@ -47714,7 +48023,7 @@ of @doc. introspectable="0"> Registers one or more additional namespaces. It's a caller's error + line="274">Registers one or more additional namespaces. It's a caller's error to try to register a namespace with the same prefix again, unless the prefix uses the same namespace href. @@ -47725,25 +48034,25 @@ the prefix uses the same namespace href. an #xmlXPathContextPtr + line="276">an #xmlXPathContextPtr namespace prefix + line="277">namespace prefix namespace href + line="278">namespace href %NULL-terminated list of pairs (prefix, href) with additional namespaces + line="279">%NULL-terminated list of pairs (prefix, href) with additional namespaces @@ -47754,14 +48063,14 @@ the prefix uses the same namespace href. introspectable="0"> Evaluates path specified by @format and returns its #xmlXPathObjectPtr, + line="330">Evaluates path specified by @format and returns its #xmlXPathObjectPtr, in case the path evaluates to a non-empty node set. See also e_xml_xpath_eval_as_string() which evaluates the path to string. a new #xmlXPathObjectPtr which + line="340">a new #xmlXPathObjectPtr which references given path, or %NULL if path cannot be found or when it evaluates to an empty nodeset. Free returned pointer with xmlXPathFreeObject(), when no longer needed. @@ -47771,19 +48080,19 @@ e_xml_xpath_eval_as_string() which evaluates the path to string. an #xmlXPathContextPtr + line="332">an #xmlXPathContextPtr printf-like format specifier of path to evaluate + line="333">printf-like format specifier of path to evaluate arguments for the @format + line="334">arguments for the @format @@ -47794,14 +48103,14 @@ e_xml_xpath_eval_as_string() which evaluates the path to string. introspectable="0"> Evaluates path specified by @format and returns its result as string, + line="378">Evaluates path specified by @format and returns its result as string, in case the path evaluates to a non-empty node set. See also e_xml_xpath_eval() which evaluates the path to an #xmlXPathObjectPtr. a new string which contains value + line="388">a new string which contains value of the given path, or %NULL if path cannot be found or when it evaluates to an empty nodeset. Free returned pointer with g_free(), when no longer needed. @@ -47811,19 +48120,19 @@ e_xml_xpath_eval() which evaluates the path to an #xmlXPathObjectPtr. an #xmlXPathContextPtr + line="380">an #xmlXPathContextPtr printf-like format specifier of path to evaluate + line="381">printf-like format specifier of path to evaluate arguments for the @format + line="382">arguments for the @format @@ -47834,31 +48143,31 @@ e_xml_xpath_eval() which evaluates the path to an #xmlXPathObjectPtr. introspectable="0"> Evaluates path specified by @format and returns whether it exists. + line="436">Evaluates path specified by @format and returns whether it exists. %TRUE, when the given XPath exists, %FALSE otherwise. + line="444">%TRUE, when the given XPath exists, %FALSE otherwise. an #xmlXPathContextPtr + line="438">an #xmlXPathContextPtr printf-like format specifier of path to evaluate + line="439">printf-like format specifier of path to evaluate arguments for the @format + line="440">arguments for the @format diff --git a/girs/EDataServerUI-1.2.gir b/girs/EDataServerUI-1.2.gir index 6ba9636dc..e9f3bea49 100644 --- a/girs/EDataServerUI-1.2.gir +++ b/girs/EDataServerUI-1.2.gir @@ -17,7 +17,7 @@ and/or use gtk-doc annotations. --> version="3.16"> Creates a new #ECredentialsPrompter, which listens for credential requests + line="1191">Creates a new #ECredentialsPrompter, which listens for credential requests from @registry. a new #ECredentialsPrompter + line="1198">a new #ECredentialsPrompter an #ESourceRegistry to have the prompter listen to + line="1193">an #ESourceRegistry to have the prompter listen to @@ -448,7 +448,7 @@ from @registry. version="3.16"> Returns a #GtkWindow, which should be used as a dialog parent. This is determined + line="1379">Returns a #GtkWindow, which should be used as a dialog parent. This is determined by an ECredentialsPrompter::get-dialog-parent signal emission. If there is no callback registered or the current callbacks don't have any suitable window, then there's chosen the last active window from the default GApplication, if any available. @@ -457,7 +457,7 @@ chosen the last active window from the default GApplication, if any available. a #GtkWindow, to be used as a dialog parent, + line="1388">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -465,73 +465,18 @@ chosen the last active window from the default GApplication, if any available. an #ECredentialsPrompter + line="1381">an #ECredentialsPrompter - - Completes an ongoing credentials prompt on idle, by finishing the @async_result. -This function is meant to be used by an #ECredentialsPrompterImpl implementation. -To actually finish the credentials prompt previously started with -e_credentials_prompter_prompt(), the e_credentials_prompter_prompt_finish() should -be called from the provided callback. - -Using %NULL @credentials will result in a G_IO_ERROR_CANCELLED error, if -no other @error is provided. - - - - - - - an #ECredentialsPrompter - - - - a #GSimpleAsyncResult - - - - an #ESource, on which the prompt was started - - - - credentials, as provided by a user, on %NULL, when the prompt was cancelled - - - - a resulting #GError, or %NULL - - - - Returns, whether can respond to credential prompts automatically. + line="1247">Returns, whether can respond to credential prompts automatically. Default value is %TRUE. This property does not influence direct calls of e_credentials_prompter_prompt(). @@ -540,14 +485,14 @@ This property does not influence direct calls of e_credentials_prompter_prompt() Whether can respond to credential prompts automatically. + line="1256">Whether can respond to credential prompts automatically. an #ECredentialsPrompter + line="1249">an #ECredentialsPrompter @@ -557,7 +502,7 @@ This property does not influence direct calls of e_credentials_prompter_prompt() version="3.16"> Returns whether the auto-prompt is disabled for the given @source. + line="1330">Returns whether the auto-prompt is disabled for the given @source. All sources can be auto-prompted by default. This is a complementary value for the ECredentialsPrompter::auto-prompt property. @@ -567,20 +512,20 @@ This value does not influence direct calls of e_credentials_prompter_prompt(). Whether the auto-prompt is disabled for the given @source + line="1341">Whether the auto-prompt is disabled for the given @source an #ECredentialsPrompter + line="1332">an #ECredentialsPrompter an #ESource + line="1333">an #ESource @@ -590,7 +535,7 @@ This value does not influence direct calls of e_credentials_prompter_prompt(). Returns a #GtkWindow, which should be used as a dialog parent. This is determined + line="1379">Returns a #GtkWindow, which should be used as a dialog parent. This is determined by an ECredentialsPrompter::get-dialog-parent signal emission. If there is no callback registered or the current callbacks don't have any suitable window, then there's chosen the last active window from the default GApplication, if any available. @@ -599,7 +544,7 @@ chosen the last active window from the default GApplication, if any available. a #GtkWindow, to be used as a dialog parent, + line="1388">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -607,7 +552,7 @@ chosen the last active window from the default GApplication, if any available. an #ECredentialsPrompter + line="1381">an #ECredentialsPrompter @@ -617,7 +562,7 @@ chosen the last active window from the default GApplication, if any available. Returns a #GtkWindow, which should be used as a dialog parent for the @auth_source. + line="1408">Returns a #GtkWindow, which should be used as a dialog parent for the @auth_source. This is determined by an ECredentialsPrompter::get-dialog-parent-full signal emission and an ECredentialsPrompter::get-dialog-parent when the first doesn't return anything. @@ -629,7 +574,7 @@ if any available. a #GtkWindow, to be used as a dialog parent, + line="1421">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -637,7 +582,7 @@ if any available. an #ECredentialsPrompter + line="1410">an #ECredentialsPrompter allow-none="1"> an #ESource + line="1411">an #ESource @@ -657,13 +602,13 @@ if any available. version="3.16"> Returns an #ESourceCredentialsProvider, which the @prompter uses. + line="1228">Returns an #ESourceCredentialsProvider, which the @prompter uses. an #ESourceCredentialsProvider, which the @prompter uses. + line="1234">an #ESourceCredentialsProvider, which the @prompter uses. @@ -671,7 +616,7 @@ if any available. an #ECredentialsPrompter + line="1230">an #ECredentialsPrompter @@ -682,20 +627,20 @@ if any available. version="3.16"> Returns an #ESourceRegistry, to which the @prompter listens. + line="1210">Returns an #ESourceRegistry, to which the @prompter listens. an #ESourceRegistry, to which the @prompter listens. + line="1216">an #ESourceRegistry, to which the @prompter listens. an #ECredentialsPrompter + line="1212">an #ECredentialsPrompter @@ -706,7 +651,7 @@ if any available. throws="1"> Runs a credentials prompt loop for @source, as long as the @func doesn't + line="1820">Runs a credentials prompt loop for @source, as long as the @func doesn't indicate that the provided credentials can be used to successfully authenticate against @source<!-- -->'s server, or that the @func returns %FALSE. The loop is also teminated when a used cancels @@ -717,11 +662,11 @@ Note: The function doesn't return until the loop is terminated, either successfully or unsuccessfully. The function can be called from any thread, though a dedicated thread is preferred. + line="186"/> %TRUE, when the credentials were provided successfully and they + line="1841">%TRUE, when the credentials were provided successfully and they can be used to authenticate the @source; %FALSE otherwise. @@ -729,19 +674,19 @@ Note: The function doesn't return until the loop is terminated, either an #ECredentialsPrompter + line="1822">an #ECredentialsPrompter an #ESource to be prompted credentials for + line="1823">an #ESource to be prompted credentials for a bit-or of #ECredentialsPrompterPromptFlags initial flags + line="1824">a bit-or of #ECredentialsPrompterPromptFlags initial flags @@ -751,7 +696,7 @@ Note: The function doesn't return until the loop is terminated, either closure="3"> an #ECredentialsPrompterLoopPromptFunc user function to call to check provided credentials + line="1825">an #ECredentialsPrompterLoopPromptFunc user function to call to check provided credentials @@ -761,7 +706,7 @@ Note: The function doesn't return until the loop is terminated, either allow-none="1"> user data to pass to @func + line="1826">user data to pass to @func an optional #GCancellable, or %NULL + line="1827">an optional #GCancellable, or %NULL @@ -780,7 +725,7 @@ Note: The function doesn't return until the loop is terminated, either version="3.16"> Process all enabled sources with connection state #E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS, + line="1586">Process all enabled sources with connection state #E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS, like if they just asked for its credentials for the first time. @@ -791,7 +736,7 @@ like if they just asked for its credentials for the first time. an #ECredentialsPrompter + line="1588">an #ECredentialsPrompter @@ -801,7 +746,7 @@ like if they just asked for its credentials for the first time. version="3.16"> Continues a credential prompt for @source. Returns, whether anything will be done. + line="1618">Continues a credential prompt for @source. Returns, whether anything will be done. The %FALSE either means that the @source<!-- -->'s connection status is not the %E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS or it is disabled. Whether continues with the credentials prompt. + line="1627">Whether continues with the credentials prompt. an #ECredentialsPrompter + line="1620">an #ECredentialsPrompter an #ESource + line="1621">an #ESource + version="3.16" + glib:finish-func="prompt_finish"> Asks the @prompter to prompt for credentials, which are returned + line="1648">Asks the @prompter to prompt for credentials, which are returned to the caller through @callback, when available.The @flags are ignored, when the @callback is %NULL; the credentials are passed to the @source with e_source_invoke_authenticate() directly, in this case. @@ -847,13 +793,13 @@ the provided credentials. an #ECredentialsPrompter + line="1650">an #ECredentialsPrompter an #ESource, which prompt the credentials for + line="1651">an #ESource, which prompt the credentials for allow-none="1"> Additional error text to show to a user, or %NULL + line="1652">Additional error text to show to a user, or %NULL a bit-or of #ECredentialsPrompterPromptFlags + line="1653">a bit-or of #ECredentialsPrompterPromptFlags @@ -880,7 +826,7 @@ the provided credentials. closure="4"> a callback to call when the credentials are ready, or %NULL + line="1654">a callback to call when the credentials are ready, or %NULL allow-none="1"> user data passed into @callback + line="1655">user data passed into @callback @@ -900,7 +846,7 @@ the provided credentials. throws="1"> Finishes a credentials prompt previously started with e_credentials_prompter_prompt(). + line="1693">Finishes a credentials prompt previously started with e_credentials_prompter_prompt(). The @out_source will have set a referenced #ESource, for which the prompt was started. Unref it, when no longer needed. Similarly the @out_credentials will have set a newly allocated #ENamedParameters structure with provided credentials, @@ -911,20 +857,20 @@ Both output arguments will be set to %NULL on error and %FALSE will be returned. %TRUE on success, %FALSE otherwise. + line="1708">%TRUE on success, %FALSE otherwise. an #ECredentialsPrompter + line="1695">an #ECredentialsPrompter a #GAsyncResult + line="1696">a #GAsyncResult optionally set to an #ESource, on which the prompt was started; can be %NULL + line="1697">optionally set to an #ESource, on which the prompt was started; can be %NULL set to an #ENamedParameters with provied credentials + line="1698">set to an #ENamedParameters with provided credentials @@ -957,7 +903,7 @@ Both output arguments will be set to %NULL on error and %FALSE will be returned. version="3.16"> Registers a prompter implementation for a given authentication method. If there is + line="1447">Registers a prompter implementation for a given authentication method. If there is registered a prompter for the same @authentication_method, then the function does nothing, otherwise it adds its own reference on the @prompter_impl, and uses it for that authentication method. One @prompter_impl can be registered for multiple @@ -971,7 +917,7 @@ registered for the exact authentication method. %TRUE on success, %FALSE on failure or when there was another prompter + line="1463">%TRUE on success, %FALSE on failure or when there was another prompter implementation registered for the given authentication method. @@ -979,7 +925,7 @@ implementation registered for the given authentication method. an #ECredentialsPrompter + line="1449">an #ECredentialsPrompter allow-none="1"> an authentication method to registr @prompter_impl for; or %NULL + line="1450">an authentication method to registr @prompter_impl for; or %NULL an #ECredentialsPrompterImpl + line="1451">an #ECredentialsPrompterImpl @@ -1006,7 +952,7 @@ implementation registered for the given authentication method. version="3.16"> Sets whether can respond to credential prompts automatically. That means that + line="1268">Sets whether can respond to credential prompts automatically. That means that whenever any ESource will ask for credentials, it'll try to provide them. Use e_credentials_prompter_set_auto_prompt_disabled_for() to influence @@ -1022,13 +968,13 @@ This property does not influence direct calls of e_credentials_prompter_prompt() an #ECredentialsPrompter + line="1270">an #ECredentialsPrompter new value of the auto-prompt property + line="1271">new value of the auto-prompt property @@ -1038,7 +984,7 @@ This property does not influence direct calls of e_credentials_prompter_prompt() version="3.16"> Sets whether the auto-prompt should be disabled for the given @source. + line="1297">Sets whether the auto-prompt should be disabled for the given @source. All sources can be auto-prompted by default. This is a complementary value for the ECredentialsPrompter::auto-prompt property. @@ -1052,19 +998,19 @@ This value does not influence direct calls of e_credentials_prompter_prompt(). an #ECredentialsPrompter + line="1299">an #ECredentialsPrompter an #ESource + line="1300">an #ESource whether the auto-prompt should be disabled for this @source + line="1301">whether the auto-prompt should be disabled for this @source @@ -1074,7 +1020,7 @@ This value does not influence direct calls of e_credentials_prompter_prompt(). Unregisters previously registered @prompter_impl for the given @autnetication_method with + line="1501">Unregisters previously registered @prompter_impl for the given @autnetication_method with e_credentials_prompter_register_impl(). Function does nothing, if no such authentication method is registered or if it has set a different prompter implementation. an #ECredentialsPrompter + line="1503">an #ECredentialsPrompter allow-none="1"> an authentication method to registr @prompter_impl for; or %NULL + line="1504">an authentication method to registr @prompter_impl for; or %NULL an #ECredentialsPrompterImpl + line="1505">an #ECredentialsPrompterImpl @@ -1117,7 +1063,7 @@ method is registered or if it has set a different prompter implementation. default-value="TRUE"> Whether the #ECredentialsPrompter can response to credential + line="1066">Whether the #ECredentialsPrompter can response to credential requests automatically. @@ -1127,7 +1073,7 @@ requests automatically. getter="get_provider"> The #ESourceCredentialsProvider object, which the prompter uses. + line="1106">The #ESourceCredentialsProvider object, which the prompter uses. getter="get_registry"> The #ESourceRegistry object, to whose credential requests the prompter listens. + line="1087">The #ESourceRegistry object, to whose credential requests the prompter listens. @@ -1151,13 +1097,13 @@ requests automatically. Emitted when a new dialog will be shown, to get the right parent + line="1124">Emitted when a new dialog will be shown, to get the right parent window for it. If the result of the call is %NULL, then it tries to get the window from the default GtkApplication. a #GtkWindow, to be used as a + line="1132">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -1165,13 +1111,13 @@ dialog parent, or %NULL. Emitted when a new dialog will be shown, to get the right parent + line="1145">Emitted when a new dialog will be shown, to get the right parent window for it. If the result of the call is %NULL, then it tries to get the window from the default GtkApplication. a #GtkWindow, to be used as a + line="1154">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -1182,7 +1128,7 @@ dialog parent, or %NULL. allow-none="1"> an #ESource, for which to show the credentials prompt + line="1148">an #ESource, for which to show the credentials prompt @@ -1203,7 +1149,7 @@ dialog parent, or %NULL. a #GtkWindow, to be used as a dialog parent, + line="1388">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -1211,7 +1157,7 @@ dialog parent, or %NULL. an #ECredentialsPrompter + line="1381">an #ECredentialsPrompter @@ -1641,13 +1587,13 @@ functions below. version="3.28"> Creates a new instance of an #ECredentialsPrompterImplOAuth2. + line="1704">Creates a new instance of an #ECredentialsPrompterImplOAuth2. a newly created #ECredentialsPrompterImplOAuth2, + line="1709">a newly created #ECredentialsPrompterImplOAuth2, which should be freed with g_object_unref() when no longer needed. @@ -2563,7 +2509,8 @@ This value has meaning only with calendar sources. + version="3.18" + glib:finish-func="refresh_finish"> Asynchronously starts refresh of the @content. This means to access the server diff --git a/girs/EDataServerUI4-1.0.gir b/girs/EDataServerUI4-1.0.gir index 234e5e0c8..bb96daf0e 100644 --- a/girs/EDataServerUI4-1.0.gir +++ b/girs/EDataServerUI4-1.0.gir @@ -17,7 +17,7 @@ and/or use gtk-doc annotations. --> version="3.16"> Creates a new #ECredentialsPrompter, which listens for credential requests + line="1191">Creates a new #ECredentialsPrompter, which listens for credential requests from @registry. a new #ECredentialsPrompter + line="1198">a new #ECredentialsPrompter an #ESourceRegistry to have the prompter listen to + line="1193">an #ESourceRegistry to have the prompter listen to @@ -450,7 +450,7 @@ from @registry. version="3.16"> Returns a #GtkWindow, which should be used as a dialog parent. This is determined + line="1379">Returns a #GtkWindow, which should be used as a dialog parent. This is determined by an ECredentialsPrompter::get-dialog-parent signal emission. If there is no callback registered or the current callbacks don't have any suitable window, then there's chosen the last active window from the default GApplication, if any available. @@ -459,7 +459,7 @@ chosen the last active window from the default GApplication, if any available. a #GtkWindow, to be used as a dialog parent, + line="1388">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -467,73 +467,18 @@ chosen the last active window from the default GApplication, if any available. an #ECredentialsPrompter + line="1381">an #ECredentialsPrompter - - Completes an ongoing credentials prompt on idle, by finishing the @async_result. -This function is meant to be used by an #ECredentialsPrompterImpl implementation. -To actually finish the credentials prompt previously started with -e_credentials_prompter_prompt(), the e_credentials_prompter_prompt_finish() should -be called from the provided callback. - -Using %NULL @credentials will result in a G_IO_ERROR_CANCELLED error, if -no other @error is provided. - - - - - - - an #ECredentialsPrompter - - - - a #GSimpleAsyncResult - - - - an #ESource, on which the prompt was started - - - - credentials, as provided by a user, on %NULL, when the prompt was cancelled - - - - a resulting #GError, or %NULL - - - - Returns, whether can respond to credential prompts automatically. + line="1247">Returns, whether can respond to credential prompts automatically. Default value is %TRUE. This property does not influence direct calls of e_credentials_prompter_prompt(). @@ -542,14 +487,14 @@ This property does not influence direct calls of e_credentials_prompter_prompt() Whether can respond to credential prompts automatically. + line="1256">Whether can respond to credential prompts automatically. an #ECredentialsPrompter + line="1249">an #ECredentialsPrompter @@ -559,7 +504,7 @@ This property does not influence direct calls of e_credentials_prompter_prompt() version="3.16"> Returns whether the auto-prompt is disabled for the given @source. + line="1330">Returns whether the auto-prompt is disabled for the given @source. All sources can be auto-prompted by default. This is a complementary value for the ECredentialsPrompter::auto-prompt property. @@ -569,20 +514,20 @@ This value does not influence direct calls of e_credentials_prompter_prompt(). Whether the auto-prompt is disabled for the given @source + line="1341">Whether the auto-prompt is disabled for the given @source an #ECredentialsPrompter + line="1332">an #ECredentialsPrompter an #ESource + line="1333">an #ESource @@ -592,7 +537,7 @@ This value does not influence direct calls of e_credentials_prompter_prompt(). Returns a #GtkWindow, which should be used as a dialog parent. This is determined + line="1379">Returns a #GtkWindow, which should be used as a dialog parent. This is determined by an ECredentialsPrompter::get-dialog-parent signal emission. If there is no callback registered or the current callbacks don't have any suitable window, then there's chosen the last active window from the default GApplication, if any available. @@ -601,7 +546,7 @@ chosen the last active window from the default GApplication, if any available. a #GtkWindow, to be used as a dialog parent, + line="1388">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -609,7 +554,7 @@ chosen the last active window from the default GApplication, if any available. an #ECredentialsPrompter + line="1381">an #ECredentialsPrompter @@ -619,7 +564,7 @@ chosen the last active window from the default GApplication, if any available. Returns a #GtkWindow, which should be used as a dialog parent for the @auth_source. + line="1408">Returns a #GtkWindow, which should be used as a dialog parent for the @auth_source. This is determined by an ECredentialsPrompter::get-dialog-parent-full signal emission and an ECredentialsPrompter::get-dialog-parent when the first doesn't return anything. @@ -631,7 +576,7 @@ if any available. a #GtkWindow, to be used as a dialog parent, + line="1421">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -639,7 +584,7 @@ if any available. an #ECredentialsPrompter + line="1410">an #ECredentialsPrompter allow-none="1"> an #ESource + line="1411">an #ESource @@ -659,13 +604,13 @@ if any available. version="3.16"> Returns an #ESourceCredentialsProvider, which the @prompter uses. + line="1228">Returns an #ESourceCredentialsProvider, which the @prompter uses. an #ESourceCredentialsProvider, which the @prompter uses. + line="1234">an #ESourceCredentialsProvider, which the @prompter uses. @@ -673,7 +618,7 @@ if any available. an #ECredentialsPrompter + line="1230">an #ECredentialsPrompter @@ -684,20 +629,20 @@ if any available. version="3.16"> Returns an #ESourceRegistry, to which the @prompter listens. + line="1210">Returns an #ESourceRegistry, to which the @prompter listens. an #ESourceRegistry, to which the @prompter listens. + line="1216">an #ESourceRegistry, to which the @prompter listens. an #ECredentialsPrompter + line="1212">an #ECredentialsPrompter @@ -708,7 +653,7 @@ if any available. throws="1"> Runs a credentials prompt loop for @source, as long as the @func doesn't + line="1820">Runs a credentials prompt loop for @source, as long as the @func doesn't indicate that the provided credentials can be used to successfully authenticate against @source<!-- -->'s server, or that the @func returns %FALSE. The loop is also teminated when a used cancels @@ -719,11 +664,11 @@ Note: The function doesn't return until the loop is terminated, either successfully or unsuccessfully. The function can be called from any thread, though a dedicated thread is preferred. + line="186"/> %TRUE, when the credentials were provided successfully and they + line="1841">%TRUE, when the credentials were provided successfully and they can be used to authenticate the @source; %FALSE otherwise. @@ -731,19 +676,19 @@ Note: The function doesn't return until the loop is terminated, either an #ECredentialsPrompter + line="1822">an #ECredentialsPrompter an #ESource to be prompted credentials for + line="1823">an #ESource to be prompted credentials for a bit-or of #ECredentialsPrompterPromptFlags initial flags + line="1824">a bit-or of #ECredentialsPrompterPromptFlags initial flags @@ -753,7 +698,7 @@ Note: The function doesn't return until the loop is terminated, either closure="3"> an #ECredentialsPrompterLoopPromptFunc user function to call to check provided credentials + line="1825">an #ECredentialsPrompterLoopPromptFunc user function to call to check provided credentials @@ -763,7 +708,7 @@ Note: The function doesn't return until the loop is terminated, either allow-none="1"> user data to pass to @func + line="1826">user data to pass to @func an optional #GCancellable, or %NULL + line="1827">an optional #GCancellable, or %NULL @@ -782,7 +727,7 @@ Note: The function doesn't return until the loop is terminated, either version="3.16"> Process all enabled sources with connection state #E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS, + line="1586">Process all enabled sources with connection state #E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS, like if they just asked for its credentials for the first time. @@ -793,7 +738,7 @@ like if they just asked for its credentials for the first time. an #ECredentialsPrompter + line="1588">an #ECredentialsPrompter @@ -803,7 +748,7 @@ like if they just asked for its credentials for the first time. version="3.16"> Continues a credential prompt for @source. Returns, whether anything will be done. + line="1618">Continues a credential prompt for @source. Returns, whether anything will be done. The %FALSE either means that the @source<!-- -->'s connection status is not the %E_SOURCE_CONNECTION_STATUS_AWAITING_CREDENTIALS or it is disabled. Whether continues with the credentials prompt. + line="1627">Whether continues with the credentials prompt. an #ECredentialsPrompter + line="1620">an #ECredentialsPrompter an #ESource + line="1621">an #ESource + version="3.16" + glib:finish-func="prompt_finish"> Asks the @prompter to prompt for credentials, which are returned + line="1648">Asks the @prompter to prompt for credentials, which are returned to the caller through @callback, when available.The @flags are ignored, when the @callback is %NULL; the credentials are passed to the @source with e_source_invoke_authenticate() directly, in this case. @@ -849,13 +795,13 @@ the provided credentials. an #ECredentialsPrompter + line="1650">an #ECredentialsPrompter an #ESource, which prompt the credentials for + line="1651">an #ESource, which prompt the credentials for allow-none="1"> Additional error text to show to a user, or %NULL + line="1652">Additional error text to show to a user, or %NULL a bit-or of #ECredentialsPrompterPromptFlags + line="1653">a bit-or of #ECredentialsPrompterPromptFlags @@ -882,7 +828,7 @@ the provided credentials. closure="4"> a callback to call when the credentials are ready, or %NULL + line="1654">a callback to call when the credentials are ready, or %NULL allow-none="1"> user data passed into @callback + line="1655">user data passed into @callback @@ -902,7 +848,7 @@ the provided credentials. throws="1"> Finishes a credentials prompt previously started with e_credentials_prompter_prompt(). + line="1693">Finishes a credentials prompt previously started with e_credentials_prompter_prompt(). The @out_source will have set a referenced #ESource, for which the prompt was started. Unref it, when no longer needed. Similarly the @out_credentials will have set a newly allocated #ENamedParameters structure with provided credentials, @@ -913,20 +859,20 @@ Both output arguments will be set to %NULL on error and %FALSE will be returned. %TRUE on success, %FALSE otherwise. + line="1708">%TRUE on success, %FALSE otherwise. an #ECredentialsPrompter + line="1695">an #ECredentialsPrompter a #GAsyncResult + line="1696">a #GAsyncResult optionally set to an #ESource, on which the prompt was started; can be %NULL + line="1697">optionally set to an #ESource, on which the prompt was started; can be %NULL set to an #ENamedParameters with provied credentials + line="1698">set to an #ENamedParameters with provided credentials @@ -959,7 +905,7 @@ Both output arguments will be set to %NULL on error and %FALSE will be returned. version="3.16"> Registers a prompter implementation for a given authentication method. If there is + line="1447">Registers a prompter implementation for a given authentication method. If there is registered a prompter for the same @authentication_method, then the function does nothing, otherwise it adds its own reference on the @prompter_impl, and uses it for that authentication method. One @prompter_impl can be registered for multiple @@ -973,7 +919,7 @@ registered for the exact authentication method. %TRUE on success, %FALSE on failure or when there was another prompter + line="1463">%TRUE on success, %FALSE on failure or when there was another prompter implementation registered for the given authentication method. @@ -981,7 +927,7 @@ implementation registered for the given authentication method. an #ECredentialsPrompter + line="1449">an #ECredentialsPrompter allow-none="1"> an authentication method to registr @prompter_impl for; or %NULL + line="1450">an authentication method to registr @prompter_impl for; or %NULL an #ECredentialsPrompterImpl + line="1451">an #ECredentialsPrompterImpl @@ -1008,7 +954,7 @@ implementation registered for the given authentication method. version="3.16"> Sets whether can respond to credential prompts automatically. That means that + line="1268">Sets whether can respond to credential prompts automatically. That means that whenever any ESource will ask for credentials, it'll try to provide them. Use e_credentials_prompter_set_auto_prompt_disabled_for() to influence @@ -1024,13 +970,13 @@ This property does not influence direct calls of e_credentials_prompter_prompt() an #ECredentialsPrompter + line="1270">an #ECredentialsPrompter new value of the auto-prompt property + line="1271">new value of the auto-prompt property @@ -1040,7 +986,7 @@ This property does not influence direct calls of e_credentials_prompter_prompt() version="3.16"> Sets whether the auto-prompt should be disabled for the given @source. + line="1297">Sets whether the auto-prompt should be disabled for the given @source. All sources can be auto-prompted by default. This is a complementary value for the ECredentialsPrompter::auto-prompt property. @@ -1054,19 +1000,19 @@ This value does not influence direct calls of e_credentials_prompter_prompt(). an #ECredentialsPrompter + line="1299">an #ECredentialsPrompter an #ESource + line="1300">an #ESource whether the auto-prompt should be disabled for this @source + line="1301">whether the auto-prompt should be disabled for this @source @@ -1076,7 +1022,7 @@ This value does not influence direct calls of e_credentials_prompter_prompt(). Unregisters previously registered @prompter_impl for the given @autnetication_method with + line="1501">Unregisters previously registered @prompter_impl for the given @autnetication_method with e_credentials_prompter_register_impl(). Function does nothing, if no such authentication method is registered or if it has set a different prompter implementation. an #ECredentialsPrompter + line="1503">an #ECredentialsPrompter allow-none="1"> an authentication method to registr @prompter_impl for; or %NULL + line="1504">an authentication method to registr @prompter_impl for; or %NULL an #ECredentialsPrompterImpl + line="1505">an #ECredentialsPrompterImpl @@ -1119,7 +1065,7 @@ method is registered or if it has set a different prompter implementation. default-value="TRUE"> Whether the #ECredentialsPrompter can response to credential + line="1066">Whether the #ECredentialsPrompter can response to credential requests automatically. @@ -1129,7 +1075,7 @@ requests automatically. getter="get_provider"> The #ESourceCredentialsProvider object, which the prompter uses. + line="1106">The #ESourceCredentialsProvider object, which the prompter uses. getter="get_registry"> The #ESourceRegistry object, to whose credential requests the prompter listens. + line="1087">The #ESourceRegistry object, to whose credential requests the prompter listens. @@ -1153,13 +1099,13 @@ requests automatically. Emitted when a new dialog will be shown, to get the right parent + line="1124">Emitted when a new dialog will be shown, to get the right parent window for it. If the result of the call is %NULL, then it tries to get the window from the default GtkApplication. a #GtkWindow, to be used as a + line="1132">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -1167,13 +1113,13 @@ dialog parent, or %NULL. Emitted when a new dialog will be shown, to get the right parent + line="1145">Emitted when a new dialog will be shown, to get the right parent window for it. If the result of the call is %NULL, then it tries to get the window from the default GtkApplication. a #GtkWindow, to be used as a + line="1154">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -1184,7 +1130,7 @@ dialog parent, or %NULL. allow-none="1"> an #ESource, for which to show the credentials prompt + line="1148">an #ESource, for which to show the credentials prompt @@ -1205,7 +1151,7 @@ dialog parent, or %NULL. a #GtkWindow, to be used as a dialog parent, + line="1388">a #GtkWindow, to be used as a dialog parent, or %NULL. @@ -1213,7 +1159,7 @@ dialog parent, or %NULL. an #ECredentialsPrompter + line="1381">an #ECredentialsPrompter @@ -1643,13 +1589,13 @@ functions below. version="3.28"> Creates a new instance of an #ECredentialsPrompterImplOAuth2. + line="1704">Creates a new instance of an #ECredentialsPrompterImplOAuth2. a newly created #ECredentialsPrompterImplOAuth2, + line="1709">a newly created #ECredentialsPrompterImplOAuth2, which should be freed with g_object_unref() when no longer needed. @@ -2567,7 +2513,8 @@ This value has meaning only with calendar sources. + version="3.18" + glib:finish-func="refresh_finish"> Asynchronously starts refresh of the @content. This means to access the server diff --git a/girs/Eom-1.0.gir b/girs/Eom-1.0.gir index 1805a76c7..49c873cab 100644 --- a/girs/Eom-1.0.gir +++ b/girs/Eom-1.0.gir @@ -715,7 +715,7 @@ from the libexif package for possible values (e.g. %EXIF_TAG_EXPOSURE_MODE). - + @@ -726,7 +726,7 @@ from the libexif package for possible values (e.g. %EXIF_TAG_EXPOSURE_MODE). - + @@ -1198,12 +1198,12 @@ from the libexif package for possible values (e.g. %EXIF_TAG_EXPOSURE_MODE). Gets the list of supported mimetypes + line="2199">Gets the list of supported mimetypes a #GList of supported mimetypes + line="2204">a #GList of supported mimetypes @@ -1235,7 +1235,7 @@ from the libexif package for possible values (e.g. %EXIF_TAG_EXPOSURE_MODE). Marks the image files contents as changed. Also, emits + line="2406">Marks the image files contents as changed. Also, emits EomImage::file-changed signal @@ -1245,7 +1245,7 @@ EomImage::file-changed signal a #EomImage + line="2408">a #EomImage @@ -1353,7 +1353,7 @@ EomImage::file-changed signal Marks the image files contents as changed. Also, emits + line="2406">Marks the image files contents as changed. Also, emits EomImage::file-changed signal @@ -1363,7 +1363,7 @@ EomImage::file-changed signal a #EomImage + line="2408">a #EomImage @@ -1372,19 +1372,19 @@ EomImage::file-changed signal c:identifier="eom_image_get_autorotate_transform"> Get @img autorotate transform. + line="2389">Get @img autorotate transform. A #EomTransform. + line="2395">A #EomTransform. a #EomImage + line="2391">a #EomImage @@ -1425,19 +1425,19 @@ EomImage::file-changed signal Gets the #GFile associated with @img + line="2070">Gets the #GFile associated with @img a #GFile + line="2076">a #GFile a #EomImage + line="2072">a #EomImage @@ -1446,20 +1446,20 @@ EomImage::file-changed signal c:identifier="eom_image_get_metadata_status"> Returns the current status of the image metadata, that is, + line="2141">Returns the current status of the image metadata, that is, whether the metadata has not been read yet, is ready, or not available at all. one of #EomImageMetadataStatus + line="2148">one of #EomImageMetadataStatus a #EomImage + line="2143">a #EomImage @@ -1467,19 +1467,19 @@ whether the metadata has not been read yet, is ready, or not available at all. Gets the #GdkPixbuf of the image + line="1322">Gets the #GdkPixbuf of the image a #GdkPixbuf + line="1328">a #GdkPixbuf a #EomImage + line="1324">a #EomImage @@ -1515,19 +1515,19 @@ whether the metadata has not been read yet, is ready, or not available at all. Gets the thumbnail pixbuf for @img + line="1358">Gets the thumbnail pixbuf for @img a #GdkPixbuf with a thumbnail + line="1364">a #GdkPixbuf with a thumbnail a #EomImage + line="1360">a #EomImage @@ -1535,19 +1535,19 @@ whether the metadata has not been read yet, is ready, or not available at all. Get @img transform. + line="2372">Get @img transform. A #EomTransform. + line="2378">A #EomTransform. a #EomImage + line="2374">a #EomImage @@ -1567,20 +1567,20 @@ whether the metadata has not been read yet, is ready, or not available at all. Gets the XMP info for @img or NULL if compiled without + line="2042">Gets the XMP info for @img or NULL if compiled without libexempi support. the xmp data + line="2049">the xmp data a #EomImage + line="2044">a #EomImage @@ -1602,19 +1602,19 @@ libexempi support. Checks whether a given image is animated. + line="2291">Checks whether a given image is animated. #TRUE if it is an animated image, #FALSE otherwise. + line="2297">#TRUE if it is an animated image, #FALSE otherwise. a #EomImage + line="2293">a #EomImage @@ -1732,19 +1732,19 @@ libexempi support. Starts playing an animated image. + line="2324">Starts playing an animated image. %TRUE on success, %FALSE if @img is already playing or isn't an animated image. + line="2330">%TRUE on success, %FALSE if @img is already playing or isn't an animated image. a #EomImage + line="2326">a #EomImage @@ -1933,7 +1933,7 @@ advances to the next frame. a #EomImage + line="2408">a #EomImage @@ -2339,7 +2339,7 @@ advances to the next frame. glib:type-name="EomJob" glib:get-type="eom_job_get_type" glib:type-struct="JobClass"> - + @@ -2347,7 +2347,7 @@ advances to the next frame. - + @@ -2358,7 +2358,7 @@ advances to the next frame. - + @@ -2376,7 +2376,7 @@ advances to the next frame. filename="eom-jobs.c" line="136">Executes the job passed as @job. Usually there is no need to call this on your own. Jobs should be executed by using the EomJobQueue. - + @@ -2390,7 +2390,7 @@ on your own. Jobs should be executed by using the EomJobQueue. - + @@ -2427,7 +2427,7 @@ on your own. Jobs should be executed by using the EomJobQueue. filename="eom-jobs.c" line="136">Executes the job passed as @job. Usually there is no need to call this on your own. Jobs should be executed by using the EomJobQueue. - + @@ -2441,7 +2441,7 @@ on your own. Jobs should be executed by using the EomJobQueue. - + @@ -2488,13 +2488,13 @@ on your own. Jobs should be executed by using the EomJobQueue. - + - + @@ -2507,7 +2507,7 @@ on your own. Jobs should be executed by using the EomJobQueue. - + @@ -2523,7 +2523,7 @@ on your own. Jobs should be executed by using the EomJobQueue. - + @@ -2545,12 +2545,12 @@ on your own. Jobs should be executed by using the EomJobQueue. glib:type-name="EomJobCopy" glib:get-type="eom_job_copy_get_type" glib:type-struct="JobCopyClass"> - + Creates a new #EomJob. - + - + @@ -2604,9 +2604,9 @@ on your own. Jobs should be executed by using the EomJobQueue. glib:type-name="EomJobLoad" glib:get-type="eom_job_load_get_type" glib:type-struct="JobLoadClass"> - + - + @@ -2632,7 +2632,7 @@ on your own. Jobs should be executed by using the EomJobQueue. - + @@ -2644,12 +2644,12 @@ on your own. Jobs should be executed by using the EomJobQueue. glib:type-name="EomJobModel" glib:get-type="eom_job_model_get_type" glib:type-struct="JobModelClass"> - + Creates a new #EomJob model. - + - + @@ -2694,12 +2694,12 @@ on your own. Jobs should be executed by using the EomJobQueue. glib:type-name="EomJobSave" glib:get-type="eom_job_save_get_type" glib:type-struct="JobSaveClass"> - + Creates a new #EomJob for image saving. - + glib:type-name="EomJobSaveAs" glib:get-type="eom_job_save_as_get_type" glib:type-struct="JobSaveAsClass"> - + Creates a new #EomJob for save as. - + - + @@ -2793,7 +2793,7 @@ file: a #GFile - + @@ -2846,9 +2846,9 @@ file: a #GFile glib:type-name="EomJobThumbnail" glib:get-type="eom_job_thumbnail_get_type" glib:type-struct="JobThumbnailClass"> - + - + @@ -2871,7 +2871,7 @@ file: a #GFile - + @@ -2883,12 +2883,12 @@ file: a #GFile glib:type-name="EomJobTransform" glib:get-type="eom_job_transform_get_type" glib:type-struct="JobTransformClass"> - + Create a new #EomJob for image transformation. - + - + @@ -3222,7 +3222,7 @@ is not stored in @store, -1 is returned. c:identifier="eom_list_store_thumbnail_refresh"> Refreshes the thumbnail for the image pointed by @iter. + line="913">Refreshes the thumbnail for the image pointed by @iter. @@ -3231,13 +3231,13 @@ is not stored in @store, -1 is returned. An #EomListStore. + line="915">An #EomListStore. A #GtkTreeIter pointing to an image in @store. + line="916">A #GtkTreeIter pointing to an image in @store. @@ -3245,7 +3245,7 @@ is not stored in @store, -1 is returned. Sets the thumbnail for the image pointed by @iter. + line="859">Sets the thumbnail for the image pointed by @iter. @@ -3254,13 +3254,13 @@ is not stored in @store, -1 is returned. An #EomListStore. + line="861">An #EomListStore. A #GtkTreeIter pointing to an image in @store. + line="862">A #GtkTreeIter pointing to an image in @store. @@ -3269,7 +3269,7 @@ is not stored in @store, -1 is returned. c:identifier="eom_list_store_thumbnail_unset"> Unsets the thumbnail for the image pointed by @iter, changing + line="884">Unsets the thumbnail for the image pointed by @iter, changing it to a "busy" icon. @@ -3279,13 +3279,13 @@ it to a "busy" icon. An #EomListStore. + line="886">An #EomListStore. A #GtkTreeIter pointing to an image in @store. + line="887">A #GtkTreeIter pointing to an image in @store. @@ -3420,14 +3420,14 @@ it to a "busy" icon. a new #EomPropertiesDialog + line="808">a new #EomPropertiesDialog the dialog's parent window + line="801">the dialog's parent window @@ -3629,18 +3629,18 @@ it to a "busy" icon. glib:type-name="EomScrollView" glib:get-type="eom_scroll_view_get_type" glib:type-struct="ScrollViewClass"> - + - + - + @@ -3659,7 +3659,7 @@ it to a "busy" icon. Gets the the currently displayed #EomImage. - + - + @@ -3688,7 +3688,7 @@ it to a "busy" icon. - + @@ -3700,7 +3700,7 @@ it to a "busy" icon. - + @@ -3711,7 +3711,7 @@ it to a "busy" icon. - + @@ -3723,7 +3723,7 @@ it to a "busy" icon. - + @@ -3738,7 +3738,7 @@ it to a "busy" icon. - + @@ -3751,7 +3751,7 @@ it to a "busy" icon. - + @@ -3767,7 +3767,7 @@ it to a "busy" icon. - + @@ -3783,7 +3783,7 @@ it to a "busy" icon. - + @@ -3799,7 +3799,7 @@ it to a "busy" icon. - + @@ -3813,7 +3813,7 @@ it to a "busy" icon. - + @@ -3828,7 +3828,7 @@ it to a "busy" icon. - + @@ -3843,7 +3843,7 @@ it to a "busy" icon. - + @@ -3859,7 +3859,7 @@ it to a "busy" icon. - + @@ -3874,7 +3874,7 @@ it to a "busy" icon. - + @@ -3888,7 +3888,7 @@ it to a "busy" icon. - + @@ -3904,7 +3904,7 @@ it to a "busy" icon. - + @@ -3919,7 +3919,7 @@ it to a "busy" icon. - + @@ -3933,7 +3933,7 @@ it to a "busy" icon. - + @@ -3944,7 +3944,7 @@ it to a "busy" icon. - + @@ -3955,7 +3955,7 @@ it to a "busy" icon. - + @@ -3969,7 +3969,7 @@ it to a "busy" icon. - + @@ -4002,7 +4002,7 @@ it to a "busy" icon. setter="set_background_color"> This is the default background color used for painting the background + line="2101">This is the default background color used for painting the background of the image view. If set to %NULL the color is determined by the active GTK theme. @@ -4014,7 +4014,7 @@ active GTK theme. getter="get_image"> This is the currently display #EomImage. + line="2142">This is the currently display #EomImage. default-value="TRUE"> If %TRUE the scrollwheel will zoom the view, otherwise it will be + line="2131">If %TRUE the scrollwheel will zoom the view, otherwise it will be used for scrolling a zoomed image. @@ -4034,7 +4034,7 @@ used for scrolling a zoomed image. setter="set_transparency_color"> This is the color used to fill the transparent parts of an image + line="2152">This is the color used to fill the transparent parts of an image if :transparency-style is set to use a custom color. @@ -4044,7 +4044,7 @@ if :transparency-style is set to use a custom color. default-value="EOM_TRANSP_CHECKED"> Determines how to fill the shown image's transparent areas. + line="2164">Determines how to fill the shown image's transparent areas. default-value="0.050000"> The current zoom factor is multiplied with this value + 1.0 when + line="2119">The current zoom factor is multiplied with this value + 1.0 when scrolling with the scrollwheel to determine the next zoom factor. @@ -4084,13 +4084,13 @@ scrolling with the scrollwheel to determine the next zoom factor. - + - + @@ -4712,12 +4712,12 @@ widget should be visible. Creates a new #EomThumbView object. + line="652">Creates a new #EomThumbView object. a newly created #EomThumbView. + line="657">a newly created #EomThumbView. @@ -4725,21 +4725,21 @@ widget should be visible. c:identifier="eom_thumb_view_get_first_selected_image"> Returns the first selected image. Note that the returned #EomImage + line="838">Returns the first selected image. Note that the returned #EomImage is not ensured to be really the first selected image in @thumbview, but generally, it will be. A #EomImage. + line="846">A #EomImage. A #EomThumbView. + line="840">A #EomThumbView. @@ -4748,19 +4748,19 @@ generally, it will be. c:identifier="eom_thumb_view_get_n_selected"> Gets the number of images that are currently selected in @thumbview. + line="793">Gets the number of images that are currently selected in @thumbview. the number of selected images in @thumbview. + line="799">the number of selected images in @thumbview. An #EomThumbView. + line="795">An #EomThumbView. @@ -4769,13 +4769,13 @@ generally, it will be. c:identifier="eom_thumb_view_get_selected_images"> Gets a list with the currently selected images. Note that a new reference is + line="871">Gets a list with the currently selected images. Note that a new reference is hold for each image and the list must be freed with g_list_free(). A newly allocated list of #EomImage's. + line="878">A newly allocated list of #EomImage's. @@ -4784,7 +4784,7 @@ hold for each image and the list must be freed with g_list_free(). A #EomThumbView. + line="873">A #EomThumbView. @@ -4792,7 +4792,7 @@ hold for each image and the list must be freed with g_list_free(). Changes the current selection according to a single movement + line="940">Changes the current selection according to a single movement described by #EomThumbViewSelectionChange. If there are no thumbnails currently selected, one is selected according to the natural selection according to the #EomThumbViewSelectionChange @@ -4806,13 +4806,13 @@ the first thumbnail will be selected. A #EomThumbView. + line="942">A #EomThumbView. A #EomThumbViewSelectionChange, describing the + line="943">A #EomThumbViewSelectionChange, describing the desired selection change. @@ -4823,7 +4823,7 @@ desired selection change. c:identifier="eom_thumb_view_set_current_image"> Changes the status of a image, marking it as currently selected. + line="902">Changes the status of a image, marking it as currently selected. If @deselect_other is %TRUE, all other selected images will be deselected. @@ -4834,19 +4834,19 @@ deselected. A #EomThumbView. + line="904">A #EomThumbView. The image to be selected. + line="905">The image to be selected. Whether to deselect currently selected images. + line="906">Whether to deselect currently selected images. @@ -4855,7 +4855,7 @@ deselected. c:identifier="eom_thumb_view_set_item_height"> Sets the height of each thumbnail in @thumbview. + line="766">Sets the height of each thumbnail in @thumbview. @@ -4864,13 +4864,13 @@ deselected. A #EomThumbView. + line="768">A #EomThumbView. The desired height. + line="769">The desired height. @@ -4878,7 +4878,7 @@ deselected. Sets the #EomListStore to be used with @thumbview. If an initial image + line="706">Sets the #EomListStore to be used with @thumbview. If an initial image was set during @store creation, its thumbnail will be selected and visible. @@ -4888,13 +4888,13 @@ was set during @store creation, its thumbnail will be selected and visible. A #EomThumbView. + line="708">A #EomThumbView. A #EomListStore. + line="709">A #EomListStore. @@ -4903,7 +4903,7 @@ was set during @store creation, its thumbnail will be selected and visible. Set the contextual menu to be used with the thumbnails in the + line="1034">Set the contextual menu to be used with the thumbnails in the widget. This can be done only once. @@ -4913,13 +4913,13 @@ widget. This can be done only once. An #EomThumbView. + line="1036">An #EomThumbView. A #GtkMenu. + line="1037">A #GtkMenu. @@ -5316,21 +5316,21 @@ widget. This can be done only once. Creates a new and empty #EomWindow. Use @flags to indicate + line="5327">Creates a new and empty #EomWindow. Use @flags to indicate if the window should be initialized fullscreen, in slideshow mode, and/or without the thumbnails collection visible. See #EomStartupFlags. a newly created #EomWindow. + line="5336">a newly created #EomWindow. the initialization parameters for the new window. + line="5329">the initialization parameters for the new window. @@ -5349,20 +5349,20 @@ and/or without the thumbnails collection visible. See #EomStartupFlags. Gets the image currently displayed in @window or %NULL if + line="5645">Gets the image currently displayed in @window or %NULL if no image is being displayed. an #EomImage. + line="5652">an #EomImage. an #EomWindow. + line="5647">an #EomWindow. @@ -5370,19 +5370,19 @@ no image is being displayed. Gets the mode of @window. See #EomWindowMode for details. + line="5500">Gets the mode of @window. See #EomWindowMode for details. An #EomWindowMode. + line="5506">An #EomWindowMode. An #EomWindow. + line="5502">An #EomWindow. @@ -5391,19 +5391,19 @@ no image is being displayed. c:identifier="eom_window_get_properties_dialog"> Gets the @window property dialog. The widget will be built on the first call to this function. + line="3094">Gets the @window property dialog. The widget will be built on the first call to this function. a #GtkDialog. + line="3100">a #GtkDialog. a #EomWindow + line="3096">a #EomWindow @@ -5411,19 +5411,19 @@ no image is being displayed. Gets the sidebar widget of @window. + line="5581">Gets the sidebar widget of @window. the #EomSidebar. + line="5587">the #EomSidebar. An #EomWindow. + line="5583">An #EomWindow. @@ -5431,19 +5431,19 @@ no image is being displayed. Gets the statusbar in @window. + line="5629">Gets the statusbar in @window. a #EomStatusBar. + line="5635">a #EomStatusBar. an #EomWindow. + line="5631">an #EomWindow. @@ -5451,20 +5451,20 @@ no image is being displayed. Gets the #EomListStore that contains the images in the collection + line="5548">Gets the #EomListStore that contains the images in the collection of @window. an #EomListStore. + line="5555">an #EomListStore. An #EomWindow. + line="5550">An #EomWindow. @@ -5472,19 +5472,19 @@ of @window. Gets the thumbnails navigation pane in @window. + line="5613">Gets the thumbnails navigation pane in @window. an #EomThumbNav. + line="5619">an #EomThumbNav. an #EomWindow. + line="5615">an #EomWindow. @@ -5492,19 +5492,19 @@ of @window. Gets the thumbnails view in @window. + line="5597">Gets the thumbnails view in @window. an #EomThumbView. + line="5603">an #EomThumbView. an #EomWindow. + line="5599">an #EomWindow. @@ -5512,19 +5512,19 @@ of @window. Gets the #GtkUIManager that describes the UI of @window. + line="5484">Gets the #GtkUIManager that describes the UI of @window. A #GtkUIManager. + line="5490">A #GtkUIManager. An #EomWindow. + line="5486">An #EomWindow. @@ -5532,19 +5532,19 @@ of @window. Gets the #EomScrollView in the window. + line="5565">Gets the #EomScrollView in the window. the #EomScrollView. + line="5571">the #EomScrollView. An #EomWindow. + line="5567">An #EomWindow. @@ -5552,19 +5552,19 @@ of @window. Tells whether @window is currently empty or not. + line="5662">Tells whether @window is currently empty or not. %TRUE if @window has no images, %FALSE otherwise. + line="5668">%TRUE if @window has no images, %FALSE otherwise. an #EomWindow. + line="5664">an #EomWindow. @@ -5572,7 +5572,7 @@ of @window. Opens a list of files, adding them to the collection in @window. + line="5453">Opens a list of files, adding them to the collection in @window. Files will be checked to be readable and later filtered according with eom_list_store_add_files(). @@ -5583,13 +5583,13 @@ with eom_list_store_add_files(). An #EomWindow. + line="5455">An #EomWindow. A %NULL-terminated list of #GFile's. + line="5456">A %NULL-terminated list of #GFile's. @@ -5610,7 +5610,7 @@ with eom_list_store_add_files(). Changes the mode of @window to normal, fullscreen, or slideshow. + line="5516">Changes the mode of @window to normal, fullscreen, or slideshow. See #EomWindowMode for details. @@ -5620,13 +5620,13 @@ See #EomWindowMode for details. an #EomWindow. + line="5518">an #EomWindow. an #EomWindowMode value. + line="5519">an #EomWindowMode value. @@ -5637,7 +5637,7 @@ See #EomWindowMode for details. default-value="EOM_WINDOW_COLLECTION_POS_BOTTOM"> Determines the position of the image collection in the window + line="5270">Determines the position of the image collection in the window relative to the image. @@ -5647,7 +5647,7 @@ relative to the image. default-value="FALSE"> If %TRUE the collection will be resizable by the user otherwise it will be + line="5283">If %TRUE the collection will be resizable by the user otherwise it will be in single column/row mode. @@ -5658,7 +5658,7 @@ in single column/row mode. default-value="0"> A bitwise OR of #EomStartupFlags elements, indicating how the window + line="5294">A bitwise OR of #EomStartupFlags elements, indicating how the window should behave upon creation. @@ -5671,7 +5671,7 @@ should behave upon creation. The #EomWindow::prepared signal is emitted when the @window is ready + line="5310">The #EomWindow::prepared signal is emitted when the @window is ready to be shown. diff --git a/girs/EvinceDocument-3.0.gir b/girs/EvinceDocument-3.0.gir index bff6ffe68..18c0f0ebd 100644 --- a/girs/EvinceDocument-3.0.gir +++ b/girs/EvinceDocument-3.0.gir @@ -644,7 +644,7 @@ For the time-format used, see ev_document_misc_format_datetime(). a #time_t - + @@ -11389,7 +11389,7 @@ the given line in the source file. It must be free with g_free when done - + The minor version number of the EV library diff --git a/girs/EvinceView-3.0.gir b/girs/EvinceView-3.0.gir index 4bb8c69b6..0ce90f609 100644 --- a/girs/EvinceView-3.0.gir +++ b/girs/EvinceView-3.0.gir @@ -3865,7 +3865,7 @@ with it afterwards. version="3.30"> Adds a Text Markup annotation (defaulting to a 'highlight' one) to + line="6338">Adds a Text Markup annotation (defaulting to a 'highlight' one) to the currently selected text on the document. When the selected text spans more than one page, it will add a @@ -3874,14 +3874,14 @@ corresponding annotation for each page that contains selected text. %TRUE if annotations were added successfully, %FALSE otherwise. + line="6348">%TRUE if annotations were added successfully, %FALSE otherwise. #EvView instance + line="6340">#EvView instance @@ -4028,13 +4028,13 @@ corresponding annotation for each page that contains selected text. an #EvView + line="9756">an #EvView the results as returned by ev_job_find_get_results() + line="9757">the results as returned by ev_job_find_get_results() @@ -4042,7 +4042,7 @@ corresponding annotation for each page that contains selected text. page index + line="9758">page index @@ -4074,7 +4074,7 @@ corresponding annotation for each page that contains selected text. version="3.12"> Restart the current search operation from the given @page. + line="9780">Restart the current search operation from the given @page. @@ -4083,13 +4083,13 @@ corresponding annotation for each page that contains selected text. an #EvView + line="9782">an #EvView a page index + line="9783">a page index @@ -4126,7 +4126,7 @@ corresponding annotation for each page that contains selected text. version="3.10"> FIXME + line="9842">FIXME @@ -4135,7 +4135,7 @@ corresponding annotation for each page that contains selected text. a #EvView + line="9844">a #EvView @@ -4258,7 +4258,7 @@ corresponding annotation for each page that contains selected text. version="3.30"> Returns a pointer to a constant string containing the selected + line="6319">Returns a pointer to a constant string containing the selected text in the view. The value returned may be NULL if there is no selected text. @@ -4266,14 +4266,14 @@ The value returned may be NULL if there is no selected text. The string representing selected text. + line="6328">The string representing selected text. #EvView instance + line="6321">#EvView instance @@ -4338,7 +4338,7 @@ The value returned may be NULL if there is no selected text. %TRUE iff the view is currently loading a document + line="8900">%TRUE iff the view is currently loading a document @@ -4407,7 +4407,7 @@ The value returned may be NULL if there is no selected text. a #EvView + line="1016">a #EvView @@ -4455,7 +4455,7 @@ The value returned may be NULL if there is no selected text. a #EvView + line="4316">a #EvView @@ -4471,7 +4471,7 @@ The value returned may be NULL if there is no selected text. version="3.10"> Enables or disables caret navigation mode for the document. + line="4271">Enables or disables caret navigation mode for the document. @@ -4480,13 +4480,13 @@ The value returned may be NULL if there is no selected text. a #EvView + line="4273">a #EvView whether to enable caret navigation mode + line="4274">whether to enable caret navigation mode @@ -4541,7 +4541,7 @@ The value returned may be NULL if there is no selected text. c:identifier="ev_view_set_page_cache_size"> Sets the maximum size in bytes that will be used to cache + line="8851">Sets the maximum size in bytes that will be used to cache rendered pages. Use 0 to disable caching rendered pages. Note that this limit doesn't affect the current visible page range, @@ -4555,13 +4555,13 @@ you have to use ev_document_model_set_max_scale() too. #EvView instance + line="8853">#EvView instance size in bytes + line="8854">size in bytes @@ -4584,14 +4584,14 @@ you have to use ev_document_model_set_max_scale() too. whether the document supports caret navigation + line="4252">whether the document supports caret navigation a #EvView + line="4250">a #EvView @@ -4639,7 +4639,7 @@ you have to use ev_document_model_set_max_scale() too. default-value="FALSE"> Allows to implement a custom notification system. + line="8309">Allows to implement a custom notification system. diff --git a/girs/Farstream-0.2.gir b/girs/Farstream-0.2.gir index 9701e09ae..ef14aa18a 100644 --- a/girs/Farstream-0.2.gir +++ b/girs/Farstream-0.2.gir @@ -18,175 +18,304 @@ and/or use gtk-doc annotations. --> + + Formats the codec in args for FS_CODEC_FORMAT + + + + a #FsCodec + + + - A format that can be used in printf like format strings to format a FsCodec + A format that can be used in printf like format strings to format a FsCodec + - If the id of a #FsCodec is #FS_CODEC_ID_ANY, then it will be replaced + If the id of a #FsCodec is #FS_CODEC_ID_ANY, then it will be replaced with a dynamic payload type at runtime + - If the id of a #FsCodec is #FS_CODEC_ID_DISABLE, then this codec will + If the id of a #FsCodec is #FS_CODEC_ID_DISABLE, then this codec will not be used + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Struct to hold information about ICE-19 compliant candidates + Struct to hold information about ICE-19 compliant candidates + - a string representing the foundation of this candidate (maximum 32 chars) + a string representing the foundation of this candidate (maximum 32 chars) - value between 1 and 256 indicating which component this candidate represents (1 is RTP, 2 is RTCP, #FsComponentType can be used here) + value between 1 and 256 indicating which component this candidate represents (1 is RTP, 2 is RTCP, #FsComponentType can be used here) - IP in dotted format + IP in dotted format - Port to use + Port to use - IP of base in dotted format as defined in ICE-19. + IP of base in dotted format as defined in ICE-19. - Port of base as defined in ICE-19. + Port of base as defined in ICE-19. - #FsNetworkProtocol for ip protocol to use as candidate + #FsNetworkProtocol for ip protocol to use as candidate - Value between 0 and (2^31 - 1) representing the priority + Value between 0 and (2^31 - 1) representing the priority - The #FsCandidateType of the candidate + The #FsCandidateType of the candidate - Username to use to connect to client if necessary, + Username to use to connect to client if necessary, NULL otherwise - Username to use to connect to client if necessary, + Username to use to connect to client if necessary, NULL otherwise - The TTL used when sending Multicast packet (0 = auto) + The TTL used when sending Multicast packet (0 = auto) - Allocates a new #FsCandidate, the rest of the fields can be optionally + Allocates a new #FsCandidate, the rest of the fields can be optionally filled manually. See also fs_candidate_new_full() + - a newly-allocated #FsCandidate + a newly-allocated #FsCandidate - The foundation of the candidate + The foundation of the candidate - The component this candidate is for + The component this candidate is for - The type of candidate + The type of candidate - The protocol this component is for + The protocol this component is for - The IP address of this component (can be NULL for local candidate to + The IP address of this component (can be NULL for local candidate to mean any address) - the UDP/TCP port + the UDP/TCP port - Allocates a new #FsCandidate, filling all the fields. See also + Allocates a new #FsCandidate, filling all the fields. See also fs_candidate_new() + - a newly-allocated #FsCandidate + a newly-allocated #FsCandidate - The foundation of the candidate + The foundation of the candidate - The component this candidate is for + The component this candidate is for - The IP address of this component (can be NULL for local candidate to + The IP address of this component (can be NULL for local candidate to mean any address) - the UDP/TCP port + the UDP/TCP port - IP of base in dotted format as defined in ICE-19. + IP of base in dotted format as defined in ICE-19. - Port of base as defined in ICE-19. + Port of base as defined in ICE-19. - The protocol this component is for + The protocol this component is for - Value between 0 and (2^31 - 1) representing the priority + Value between 0 and (2^31 - 1) representing the priority - The type of candidate + The type of candidate - Username to use to connect to client if necessary, + Username to use to connect to client if necessary, NULL otherwise @@ -194,25 +323,36 @@ fs_candidate_new() transfer-ownership="none" nullable="1" allow-none="1"> - Username to use to connect to client if necessary, + Username to use to connect to client if necessary, NULL otherwise - The TTL used when sending Multicast packet (0 = auto) + The TTL used when sending Multicast packet (0 = auto) - Copies a #FsCandidate and its contents. + Copies a #FsCandidate and its contents. + - a new #FsCandidate + a new #FsCandidate - a #FsCandidate to copy + a #FsCandidate to copy @@ -220,13 +360,18 @@ fs_candidate_new() - Frees a #FsCandidate and all its contents + Frees a #FsCandidate and all its contents + - a #FsCandidate to delete + a #FsCandidate to delete @@ -237,16 +382,23 @@ fs_candidate_new() glib:type-name="FsCandidateList" glib:get-type="fs_candidate_list_get_type"> - Copies a GList of #FsCandidate and its contents + Copies a GList of #FsCandidate and its contents + - a new GList of #FsCandidate + a new GList of #FsCandidate - A GList of #FsCandidate + A GList of #FsCandidate @@ -256,13 +408,18 @@ fs_candidate_new() - Deletes a GList of #FsCandidate and its contents + Deletes a GList of #FsCandidate and its contents + - A GList of #FsCandidate + A GList of #FsCandidate @@ -274,36 +431,53 @@ fs_candidate_new() glib:type-name="FsCandidateType" glib:get-type="fs_candidate_type_get_type" c:type="FsCandidateType"> - An enum for the type of candidate used/reported + An enum for the type of candidate used/reported - A host candidate (local) + glib:nick="host" + glib:name="FS_CANDIDATE_TYPE_HOST"> + A host candidate (local) - A server reflexive candidate. + glib:nick="srflx" + glib:name="FS_CANDIDATE_TYPE_SRFLX"> + A server reflexive candidate. - A peer reflexive candidate + glib:nick="prflx" + glib:name="FS_CANDIDATE_TYPE_PRFLX"> + A peer reflexive candidate - An relay candidate + glib:nick="relay" + glib:name="FS_CANDIDATE_TYPE_RELAY"> + An relay candidate - A multicast address + glib:nick="multicast" + glib:name="FS_CANDIDATE_TYPE_MULTICAST"> + A multicast address glib:type-name="FsCodec" glib:get-type="fs_codec_get_type" c:symbol-prefix="codec"> - This structure reprensents one codec that can be offered or received + This structure reprensents one codec that can be offered or received + - numeric identifier for encoding, eg. PT for SDP + numeric identifier for encoding, eg. PT for SDP - the name of the codec + the name of the codec - type of media this codec is for + type of media this codec is for - clock rate of this stream + clock rate of this stream - Number of channels codec should decode + Number of channels codec should decode - The minimum interval between two RTCP reports, + The minimum interval between two RTCP reports, If it is not specified (G_MAXUINT), it is up to the protocol to decide (it is 5 seconds for RTP). - key pairs of param name to param data + key pairs of param name to param data - key triplets of + key triplets of feedbck param type, subtype and extra string that is supported for this codec - Allocates and initializes a #FsCodec structure + Allocates and initializes a #FsCodec structure + - A newly allocated #FsCodec + A newly allocated #FsCodec - codec identifier, if RTP this should be based on IETF RTP payload types + codec identifier, if RTP this should be based on IETF RTP payload types - Name of media type this encodes + Name of media type this encodes - #FsMediaType for type of codec + #FsMediaType for type of codec - The clock rate this codec encodes at, if applicable + The clock rate this codec encodes at, if applicable - This function adds an new feedback parameter to a #FsCodec + This function adds an new feedback parameter to a #FsCodec + - The #FsCodec to add the parameter to + The #FsCodec to add the parameter to - The type of the feedback parameter + The type of the feedback parameter - The subtype of the feedback parameter + The subtype of the feedback parameter - The extra_params of the feeback parameter + The extra_params of the feeback parameter - This function adds an new optional parameter to a #FsCodec + This function adds an new optional parameter to a #FsCodec + - The #FsCodec to add the parameter to + The #FsCodec to add the parameter to - The name of the optional parameter + The name of the optional parameter - The extra_params of the optional parameter + The extra_params of the optional parameter - Compare two codecs, it will declare two codecs to be identical even + Compare two codecs, it will declare two codecs to be identical even if their optional parameters are in a different order. %NULL encoding names are ignored. + - %TRUE of the codecs are identical, %FALSE otherwise + %TRUE of the codecs are identical, %FALSE otherwise - First codec + First codec - Second codec + Second codec - Copies a #FsCodec structure. + Copies a #FsCodec structure. + - a copy of the codec + a copy of the codec - codec to copy + codec to copy @@ -457,35 +699,49 @@ are ignored. - Deletes a #FsCodec structure and all its data. Is a no-op on %NULL codec + Deletes a #FsCodec structure and all its data. Is a no-op on %NULL codec + - #FsCodec structure to free + #FsCodec structure to free - Finds the #FsFeedbackParameter in the #FsCodec that has the requested + Finds the #FsFeedbackParameter in the #FsCodec that has the requested subtype, type and extra_params. One of which must be non-NULL; + - the #FsFeedbackParameter from the #FsCodec or %NULL + the #FsFeedbackParameter from the #FsCodec or %NULL - a #FsCodec + a #FsCodec - The subtype of the parameter to search for or %NULL for + The subtype of the parameter to search for or %NULL for any type @@ -493,7 +749,9 @@ any type transfer-ownership="none" nullable="1" allow-none="1"> - The subtype of the parameter to search for or %NULL + The subtype of the parameter to search for or %NULL for any subtype @@ -501,7 +759,9 @@ for any subtype transfer-ownership="none" nullable="1" allow-none="1"> - The extra_params of the parameter to search for + The extra_params of the parameter to search for or %NULL for any extra_params @@ -509,26 +769,37 @@ or %NULL for any extra_params - Finds the #FsCodecParameter in the #FsCodec that has the requested name + Finds the #FsCodecParameter in the #FsCodec that has the requested name and, if not %NULL, the requested value + - the #FsCodecParameter from the #FsCodec or %NULL + the #FsCodecParameter from the #FsCodec or %NULL - a #FsCodec + a #FsCodec - The name of the parameter to search for + The name of the parameter to search for - The value of the parameter to search for or %NULL for + The value of the parameter to search for or %NULL for any value @@ -536,19 +807,26 @@ any value - Removes an optional parameter from a codec. + Removes an optional parameter from a codec. NULL param will do nothing. + - a #FsCodec + a #FsCodec - + a pointer to the #GList element to remove that contains a #FsFeedbackParameter @@ -559,32 +837,46 @@ NULL param will do nothing. - Removes an optional parameter from a codec. + Removes an optional parameter from a codec. NULL param will do nothing. + - a #FsCodec + a #FsCodec - a pointer to the #FsCodecParameter to remove + a pointer to the #FsCodecParameter to remove - Returns a newly-allocated string representing the codec + Returns a newly-allocated string representing the codec + - the newly-allocated string + the newly-allocated string - A farstream codec + A farstream codec @@ -595,9 +887,14 @@ NULL param will do nothing. glib:type-name="FsCodecGList" glib:get-type="fs_codec_list_get_type"> - Verifies if two glist of fscodecs are identical + Verifies if two glist of fscodecs are identical + - %TRUE if they are identical, %FALSE otherwise + %TRUE if they are identical, %FALSE otherwise @@ -605,7 +902,9 @@ NULL param will do nothing. transfer-ownership="none" nullable="1" allow-none="1"> - a #GList of #FsCodec + a #GList of #FsCodec @@ -614,7 +913,9 @@ NULL param will do nothing. transfer-ownership="none" nullable="1" allow-none="1"> - a #GList of #FsCodec + a #GList of #FsCodec @@ -622,16 +923,23 @@ NULL param will do nothing. - Copies a list of #FsCodec structures. + Copies a list of #FsCodec structures. + - The new list. + The new list. - + a GList of #FsCodec to copy @@ -642,14 +950,19 @@ NULL param will do nothing. - Deletes a list of #FsCodec structures and the list itself. + Deletes a list of #FsCodec structures and the list itself. Does nothing on %NULL lists. + - a GList of #FsCodec to delete + a GList of #FsCodec to delete @@ -659,7 +972,9 @@ Does nothing on %NULL lists. - Reads the content of a #GKeyFile of the following format into + Reads the content of a #GKeyFile of the following format into a #GList of #FsCodec structures. @@ -680,8 +995,11 @@ wierd_param=42 feedback:nack/pli=1 feedback:tfrc= ]| + - + The #GList of #FsCodec or %NULL if the keyfile was empty or an error occured. @@ -689,7 +1007,9 @@ The #GList of #FsCodec or %NULL if the keyfile was empty or an error occured. - Name of the #GKeyFile to read the codecs parameters from + Name of the #GKeyFile to read the codecs parameters from @@ -700,36 +1020,55 @@ The #GList of #FsCodec or %NULL if the keyfile was empty or an error occured. - Used to store arbitary parameters for a codec + Used to store arbitary parameters for a codec + - paramter name. + paramter name. - parameter value. + parameter value. - Makes a copy of a #FsCodecParameter + Makes a copy of a #FsCodecParameter + - a newly allocated #FsCodecParameter + a newly allocated #FsCodecParameter - a #FsCodecParameter + a #FsCodecParameter - Frees a #FsCodecParameter + Frees a #FsCodecParameter + - a #FsCodecParameter to free + a #FsCodecParameter to free @@ -739,24 +1078,35 @@ The #GList of #FsCodec or %NULL if the keyfile was empty or an error occured. - This enum contains the component IDs defined in ICE-19 + This enum contains the component IDs defined in ICE-19 - Use this when specifying a component is innapropriate + glib:nick="none" + glib:name="FS_COMPONENT_NONE"> + Use this when specifying a component is innapropriate - This component is for RTP data + glib:nick="rtp" + glib:name="FS_COMPONENT_RTP"> + This component is for RTP data - This component is for RTCP control + glib:nick="rtcp" + glib:name="FS_COMPONENT_RTCP"> + This component is for RTCP control - The #FsConference structure, all the members are private + The #FsConference structure, all the members are private + - Create a new Farstream Participant for the type of the given conference. + Create a new Farstream Participant for the type of the given conference. + - the new #FsParticipant that has been created. + the new #FsParticipant that has been created. The #FsParticipant is owned by the user and he must unref it when he is done with it. - #FsConference interface of a #GstElement + #FsConference interface of a #GstElement - Create a new Farstream session for the given conference. + Create a new Farstream session for the given conference. + - the new #FsSession that has been created. + the new #FsSession that has been created. The #FsSession must be unref'd by the user when closing the session. - #FsConference interface of a #GstElement + #FsConference interface of a #GstElement - #FsMediaType of the new session + #FsMediaType of the new session @@ -807,16 +1176,23 @@ The #FsSession must be unref'd by the user when closing the session. - Create a new Farstream Participant for the type of the given conference. + Create a new Farstream Participant for the type of the given conference. + - the new #FsParticipant that has been created. + the new #FsParticipant that has been created. The #FsParticipant is owned by the user and he must unref it when he is done with it. - #FsConference interface of a #GstElement + #FsConference interface of a #GstElement @@ -824,19 +1200,28 @@ done with it. - Create a new Farstream session for the given conference. + Create a new Farstream session for the given conference. + - the new #FsSession that has been created. + the new #FsSession that has been created. The #FsSession must be unref'd by the user when closing the session. - #FsConference interface of a #GstElement + #FsConference interface of a #GstElement - #FsMediaType of the new session + #FsMediaType of the new session @@ -845,7 +1230,7 @@ The #FsSession must be unref'd by the user when closing the session. - + @@ -853,25 +1238,37 @@ The #FsSession must be unref'd by the user when closing the session. - #FsConferenceClass class structure. + #FsConferenceClass class structure. + - parent GstBin class + parent GstBin class + - the new #FsSession that has been created. + the new #FsSession that has been created. The #FsSession must be unref'd by the user when closing the session. - #FsConference interface of a #GstElement + #FsConference interface of a #GstElement - #FsMediaType of the new session + #FsMediaType of the new session @@ -879,22 +1276,27 @@ The #FsSession must be unref'd by the user when closing the session. + - the new #FsParticipant that has been created. + the new #FsParticipant that has been created. The #FsParticipant is owned by the user and he must unref it when he is done with it. - #FsConference interface of a #GstElement + #FsConference interface of a #GstElement - + @@ -903,68 +1305,180 @@ done with it. glib:type-name="FsDTMFEvent" glib:get-type="fs_dtmf_event_get_type" c:type="FsDTMFEvent"> - An enum that represents the different DTMF event that can be sent to a + An enum that represents the different DTMF event that can be sent to a #FsSession. The values corresponds those those defined in RFC 4733 The rest of the possibles values are in the IANA registry at: http://www.iana.org/assignments/audio-telephone-event-registry - + - + - + - + - + - + - + - + - + - + + glib:nick="star" + glib:name="FS_DTMF_EVENT_STAR"> + glib:nick="pound" + glib:name="FS_DTMF_EVENT_POUND"> - + - + - + - + - An enum that represents the different ways a DTMF event can be sent + An enum that represents the different ways a DTMF event can be sent - Send as a special payload type defined by RFC 4733 + glib:nick="rtp-rfc4733" + glib:name="FS_DTMF_METHOD_RTP_RFC4733"> + Send as a special payload type defined by RFC 4733 (which obsoletes RFC 2833) - Send as tones as in-band audio sound + glib:nick="sound" + glib:name="FS_DTMF_METHOD_SOUND"> + Send as tones as in-band audio sound + + + + + + + + + + + + + + + + + + + + + + + Tells the programmer if an error if fatal or not, if it returns %TRUE, +the error is fatal, and the object that created it should +be discarded. It returns %FALSE otherwise. + + + + a #FsError + + + glib:type-name="FsElementAddedNotifier" glib:get-type="fs_element_added_notifier_get_type" glib:type-struct="ElementAddedNotifierClass"> - All members are private + All members are private + - Creates a new #FsElementAddedNotifier object + Creates a new #FsElementAddedNotifier object + - the newly-created #FsElementAddedNotifier + the newly-created #FsElementAddedNotifier - Add a #GstBin to on which the #FsElementAddedNotifier::element-added signal + Add a #GstBin to on which the #FsElementAddedNotifier::element-added signal will be called on every element and sub-element present and added in the future. + - a #FsElementAddedNotifier + a #FsElementAddedNotifier - A #GstBin to watch to added elements + A #GstBin to watch to added elements - Stop watching the passed bin and its subbins. + Stop watching the passed bin and its subbins. + - %TRUE if the #GstBin was being watched, %FALSE otherwise + %TRUE if the #GstBin was being watched, %FALSE otherwise - a #FsElementAddedNotifier + a #FsElementAddedNotifier - A #GstBin to stop watching + A #GstBin to stop watching - Same as first calling fs_utils_get_default_element_properties() and using + Same as first calling fs_utils_get_default_element_properties() and using the result with fs_element_added_notifier_set_properties_from_keyfile() . This is binding friendly (since GKeyFile doesn't have a boxed type). + - The id of the signal connection, this can be used to disconnect + The id of the signal connection, this can be used to disconnect this property setter using g_signal_handler_disconnect(). - a #FsElementAddedNotifier + a #FsElementAddedNotifier - Element for which to set the default codec + Element for which to set the default codec preferences @@ -1045,45 +1592,63 @@ this property setter using g_signal_handler_disconnect(). - Same as fs_element_added_notifier_set_properties_from_keyfile() but using + Same as fs_element_added_notifier_set_properties_from_keyfile() but using the name of the file to load instead of the #GKeyFile directly. + - %TRUE if the file was successfully loaded, %FALSE otherwise + %TRUE if the file was successfully loaded, %FALSE otherwise - a #FsElementAddedNotifier + a #FsElementAddedNotifier - The name of the keyfile to use + The name of the keyfile to use - Using a #GKeyFile where the groups are the element's type or name + Using a #GKeyFile where the groups are the element's type or name and the key=value are the property and its value, this function will set the properties on the elements added to this object after this function has been called. It will take ownership of the GKeyFile structure. It will first try the group as the element type, if that does not match, it will check its name. + - The id of the signal connection, this can be used to disconnect + The id of the signal connection, this can be used to disconnect this property setter using g_signal_handler_disconnect(). - a #FsElementAddedNotifier + a #FsElementAddedNotifier - a #GKeyFile + a #GKeyFile @@ -1096,7 +1661,9 @@ this property setter using g_signal_handler_disconnect(). c:type="FsElementAddedNotifierPrivate*"/> - This signal is emitted when an element is added to a #GstBin that was added + This signal is emitted when an element is added to a #GstBin that was added to this object or one of its sub-bins. Be careful, there is no guarantee that this will be emitted on your main thread, it will be emitted in the thread that added the element. @@ -1106,11 +1673,15 @@ The bin may be %NULL if this is the top-level bin. - The #GstBin to which this object was added + The #GstBin to which this object was added - The #GstElement that was added + The #GstElement that was added @@ -1119,72 +1690,102 @@ The bin may be %NULL if this is the top-level bin. - All members are private + All members are private + - the #GObjectClass parent + the #GObjectClass parent + disguised="1" + opaque="1"> + - This is the enum of error numbers that will come either on the "error" + This is the enum of error numbers that will come either on the "error" signal, from the Gst Bus or for error in the FS_ERROR domain in GErrors - Error constructing some of the sub-elements, this + glib:nick="construction" + glib:name="FS_ERROR_CONSTRUCTION"> + Error constructing some of the sub-elements, this probably denotes an error in the installation of the gstreamer elements. It is a fatal error. - An internal error happened in Farstream, it may be in + glib:nick="internal" + glib:name="FS_ERROR_INTERNAL"> + An internal error happened in Farstream, it may be in an inconsistent state. The object from which this error comes should be discarded. - Invalid arguments to the function, this + glib:nick="invalid-arguments" + glib:name="FS_ERROR_INVALID_ARGUMENTS"> + Invalid arguments to the function, this is a programming error and should not be reported to the user - A network related error, this should probably be + glib:nick="network" + glib:name="FS_ERROR_NETWORK"> + A network related error, this should probably be reported to the user. - The optional functionality is not implemented by + glib:nick="not-implemented" + glib:name="FS_ERROR_NOT_IMPLEMENTED"> + The optional functionality is not implemented by this plugin. - The codec negotiation has failed, this means + glib:nick="negotiation-failed" + glib:name="FS_ERROR_NEGOTIATION_FAILED"> + The codec negotiation has failed, this means that there are no common codecs between the local and remote codecs. - Data is received on an unknown codec, this most + glib:nick="unknown-codec" + glib:name="FS_ERROR_UNKNOWN_CODEC"> + Data is received on an unknown codec, this most likely denotes an error on the remote side, the buffers will be ignored. It can safely be ignored in most cases (but may result in a call with no media received). @@ -1192,33 +1793,48 @@ media received). - There are no codecs detected for that media type. + glib:nick="no-codecs" + glib:name="FS_ERROR_NO_CODECS"> + There are no codecs detected for that media type. - All of the codecs have been disabled by the + glib:nick="no-codecs-left" + glib:name="FS_ERROR_NO_CODECS_LEFT"> + All of the codecs have been disabled by the codec preferences, one should try less strict codec preferences. - Could not connect to the to remote party. + glib:nick="connection-failed" + glib:name="FS_ERROR_CONNECTION_FAILED"> + Could not connect to the to remote party. - The object has been disposed. + glib:nick="disposed" + glib:name="FS_ERROR_DISPOSED"> + The object has been disposed. - The object already exists + glib:nick="already-exists" + glib:name="FS_ERROR_ALREADY_EXISTS"> + The object already exists @@ -1231,84 +1847,285 @@ codec preferences, one should try less strict codec preferences. glib:type-name="FsFeedbackParameter" glib:get-type="fs_feedback_parameter_get_type" c:symbol-prefix="feedback_parameter"> - Use to store feedback parameters + Use to store feedback parameters + - the type of feedback, like "ack", "name", "ccm" + the type of feedback, like "ack", "name", "ccm" - the subtype of feedback (can be an empty string) + the subtype of feedback (can be an empty string) - a string containing extra parameters (can be empty) + a string containing extra parameters (can be empty) - Makes a copy of a #FsFeedbackParameter + Makes a copy of a #FsFeedbackParameter + - a newly allocated #FsFeedbackParameter + a newly allocated #FsFeedbackParameter - a #FsFeedbackParameter + a #FsFeedbackParameter - Frees a #FsFeedbackParameter + Frees a #FsFeedbackParameter + - a #FsFeedbackParameter to free + a #FsFeedbackParameter to free + + This macro is used to declare Farstream plugins and must be used once +in any farstream plugin. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Enum used to signify the media type of a codec or stream. + Enum used to signify the media type of a codec or stream. - A media type that encodes audio. + glib:nick="audio" + glib:name="FS_MEDIA_TYPE_AUDIO"> + A media type that encodes audio. - A media type that encodes video. + glib:nick="video" + glib:name="FS_MEDIA_TYPE_VIDEO"> + A media type that encodes video. - A media type for application data. + glib:nick="application" + glib:name="FS_MEDIA_TYPE_APPLICATION"> + A media type for application data. - Largest valid #FsMediaType + glib:nick="last" + glib:name="FS_MEDIA_TYPE_LAST"> + Largest valid #FsMediaType - Gives a user-printable string representing the media type + Gives a user-printable string representing the media type + - a static string representing the media type + a static string representing the media type - A media type + A media type @@ -1318,43 +2135,189 @@ codec preferences, one should try less strict codec preferences. glib:type-name="FsNetworkProtocol" glib:get-type="fs_network_protocol_get_type" c:type="FsNetworkProtocol"> - An enum for the base IP protocol + An enum for the base IP protocol - A UDP based protocol + glib:nick="udp" + glib:name="FS_NETWORK_PROTOCOL_UDP"> + A UDP based protocol - A TCP based protocol, will listen for + glib:nick="tcp" + glib:name="FS_NETWORK_PROTOCOL_TCP"> + A TCP based protocol, will listen for incoming connections - A TCP based protocol, will listen for + glib:nick="tcp-passive" + glib:name="FS_NETWORK_PROTOCOL_TCP_PASSIVE"> + A TCP based protocol, will listen for incoming connections - A TCP based protocol, will attempt to + glib:nick="tcp-active" + glib:name="FS_NETWORK_PROTOCOL_TCP_ACTIVE"> + A TCP based protocol, will attempt to open an outbound connection - A TCP based protocol, will listen for + glib:nick="tcp-so" + glib:name="FS_NETWORK_PROTOCOL_TCP_SO"> + A TCP based protocol, will listen for incoming connections and attempt an outbound connection at the same time as the peer (Simultanuous-Open) + + + + + + + + + + + + + + + + + + + + + + + Locks the participant for data set with g_object_set_data() or +g_object_set_qdata(). + + + + A #FsParticipant + + + + + Unlocks the participant for data set with g_object_set_data() or +g_object_set_qdata(). + + + + A #FsParticipant + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This macro can be used to initialize statically linked plugins. It is +necessary to call this macro before the plugin can be used. It has to be +used in combination with FS_PLUGIN_STATIC_REGISTER and must be placed +outside any block to declare the plugin initialization function. + + + + unique name of the plugin + + + + + This macro can be used to initialize statically linked plugins. It is +necessary to call this macro before the plugin can be used. It has to +be used in combination with FS_PLUGIN_STATIC_DECLARE and calls the plugin +initialization function. + + + + unique name of the plugin + + + glib:type-name="FsParticipant" glib:get-type="fs_participant_get_type" glib:type-struct="ParticipantClass"> - All members are private (access them using the properties) + All members are private (access them using the properties) + @@ -1374,7 +2340,7 @@ as the peer (Simultanuous-Open) - + @@ -1382,24 +2348,31 @@ as the peer (Simultanuous-Open) - The FsParticipant class has no virtual methods to implement, + The FsParticipant class has no virtual methods to implement, but you may want to override the properties or attach more date to it + - Our parent + Our parent - + + disguised="1" + opaque="1"> + glib:type-name="FsPlugin" glib:get-type="fs_plugin_get_type" glib:type-struct="PluginClass"> - This structure represents a plugin, it is opaque. + This structure represents a plugin, it is opaque. + - Loads the appropriate plugin if necessary and creates a GObject of + Loads the appropriate plugin if necessary and creates a GObject of the requested type + - The object created (or NULL if there is an error) + The object created (or NULL if there is an error) - The name of the plugin to load + The name of the plugin to load - The type of plugin to load (normally "transmitter") + The type of plugin to load (normally "transmitter") - location of a #GError, or NULL if no error occured + location of a #GError, or NULL if no error occured - The name of the first property to be set on the + The name of the first property to be set on the object - The NULL-terminated list of properties to set on the transmitter + The NULL-terminated list of properties to set on the transmitter @@ -1446,40 +2437,60 @@ the requested type - Loads the appropriate plugin if necessary and creates a GObject of + Loads the appropriate plugin if necessary and creates a GObject of the requested type + - The object created (or NULL if there is an error) + The object created (or NULL if there is an error) - The name of the plugin to load + The name of the plugin to load - The type of plugin to load (normally "transmitter") + The type of plugin to load (normally "transmitter") - location of a #GError, or NULL if no error occured + location of a #GError, or NULL if no error occured - The name of the first property to be set on the + The name of the first property to be set on the object - The rest of the arguments + The rest of the arguments - Gets the list of all available plugins of a certain type + Gets the list of all available plugins of a certain type + - a newly allocated NULL terminated array of + a newly allocated NULL terminated array of strings or %NULL if no strings were found. It should be freed with g_strfreev(). @@ -1488,13 +2499,47 @@ It should be freed with g_strfreev(). - Get list of plugins with this type suffix + Get list of plugins with this type suffix + + Register a staticly linked transmitter. This function should strictly be +used by plugins own register function. To register a static plugin: + extern fs_plugin_<name>_<type>_register_pluing (void); + fs_plugin_<name>_<type>_register_pluing (); + + + + + + + The name of the plugin to register + + + + The type of plugin to register (normally "transmitter") + + + + + + + - the parent object + the parent object @@ -1507,7 +2552,7 @@ It should be freed with g_strfreev(). - + @@ -1515,22 +2560,45 @@ It should be freed with g_strfreev(). + - + - + + + + Formats the codec in args for FS_RTP_HEADER_EXTENSION_ARGS + + + + a #FsRtpHeaderExtension + + + - A format that can be used in printf like format strings to format a + A format that can be used in printf like format strings to format a FsRtpHeaderExtension + glib:type-name="FsRtpHeaderExtension" glib:get-type="fs_rtp_header_extension_get_type" c:symbol-prefix="rtp_header_extension"> - Defines a RTP header extension with its negotiated identifier, direction + Defines a RTP header extension with its negotiated identifier, direction and URI. They should only be created with fs_rtp_header_extension_new(). + - The identifier of the RTP header extension + The identifier of the RTP header extension - the direction in which this extension can be used + the direction in which this extension can be used - The URI that defines this extension + The URI that defines this extension - Creates a new #FsRtpHeaderExtension + Creates a new #FsRtpHeaderExtension + - a new #FsRtpHeaderExtension + a new #FsRtpHeaderExtension - The identifier of the RTP header extension + The identifier of the RTP header extension - the direction in which this extension can be used + the direction in which this extension can be used - The URI that defines this extension + The URI that defines this extension - Compares two #FsRtpHeaderExtension structures + Compares two #FsRtpHeaderExtension structures + - %TRUE if they are identical, %FALSE otherwise + %TRUE if they are identical, %FALSE otherwise - The first #FsRtpHeaderExtension + The first #FsRtpHeaderExtension - The second #FsRtpHeaderExtension + The second #FsRtpHeaderExtension @@ -1594,14 +2691,21 @@ and URI. They should only be created with fs_rtp_header_extension_new(). - Copies a #FsRtpHeaderExtension + Copies a #FsRtpHeaderExtension + - a new #FsRtpHeaderExtension + a new #FsRtpHeaderExtension - The RTP header extension definition to copy + The RTP header extension definition to copy @@ -1609,13 +2713,18 @@ and URI. They should only be created with fs_rtp_header_extension_new(). - Frees the passed #FsRtpHeaderExtension + Frees the passed #FsRtpHeaderExtension + - A RTP header extension to free + A RTP header extension to free @@ -1626,9 +2735,14 @@ and URI. They should only be created with fs_rtp_header_extension_new(). glib:type-name="FsRtpHeaderExtensionGList" glib:get-type="fs_rtp_header_extension_list_get_type"> - Does a deep copy of a #GList of #FsRtpHeaderExtension + Does a deep copy of a #GList of #FsRtpHeaderExtension + - a new + a new #GList of #FsRtpHeaderExtension @@ -1636,7 +2750,9 @@ and URI. They should only be created with fs_rtp_header_extension_new(). - + a #GList of #FsRtpHeaderExtension @@ -1647,13 +2763,18 @@ and URI. They should only be created with fs_rtp_header_extension_new(). - Frees the passed #GList of #FsRtpHeaderExtension + Frees the passed #GList of #FsRtpHeaderExtension + - a #GList of #FsRtpHeaderExtension + a #GList of #FsRtpHeaderExtension @@ -1663,7 +2784,9 @@ and URI. They should only be created with fs_rtp_header_extension_new(). - Reads the content of a #GKeyFile of the following format into a + Reads the content of a #GKeyFile of the following format into a #GList of #FsRtpHeaderExtension structures. The groups have a format "rtp-hdrext:audio:XXX" or @@ -1689,8 +2812,11 @@ id=3 uri=urn:ietf:params:rtp-hdrext:ntp-64 direction=receive ]| + - a + a #GList of #FsRtpHeaderExtension that must be freed with fs_rtp_header_extension_list_destroy() @@ -1699,16 +2825,126 @@ fs_rtp_header_extension_list_destroy() - Name of the #GKeyFile to read the RTP Header Extensions from + Name of the #GKeyFile to read the RTP Header Extensions from - The media type for which to get header extensions + The media type for which to get header extensions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="FsSession" glib:get-type="fs_session_get_type" glib:type-struct="SessionClass"> - All members are private, access them using methods and properties + All members are private, access them using methods and properties + - Some codec updates need to be reliably transmitted to the other side + Some codec updates need to be reliably transmitted to the other side because they contain important parameters required to decode the media. Other codec updates, caused by user action, don't. + - A new #GList of + A new #GList of #FsCodec that need to be resent or %NULL if there are none. This list must be freed with fs_codec_list_destroy(). @@ -1732,14 +2976,18 @@ Other codec updates, caused by user action, don't. - a #FsSession + a #FsSession - + Codecs previously retrieved from the #FsSession:codecs property @@ -1749,7 +2997,9 @@ Other codec updates, caused by user action, don't. transfer-ownership="none" nullable="1" allow-none="1"> - + Codecs recently retrieved from the #FsSession:codecs property @@ -1759,27 +3009,41 @@ Other codec updates, caused by user action, don't. - Returns the GType of the stream transmitter, bindings can use it + Returns the GType of the stream transmitter, bindings can use it to validate/convert the parameters passed to fs_session_new_stream(). + - The #GType of the stream transmitter + The #GType of the stream transmitter - A #FsSession + A #FsSession - The name of the transmitter + The name of the transmitter - Get the list of all available transmitters for this session. + Get the list of all available transmitters for this session. + - a newly-allocagted %NULL terminated array of + a newly-allocagted %NULL terminated array of named of transmitters or %NULL if no transmitter is needed for this type of session. It should be freed with g_strfreev(). @@ -1788,30 +3052,43 @@ session. It should be freed with g_strfreev(). - A #FsSession + A #FsSession - This function creates a stream for the given participant into the active session. + This function creates a stream for the given participant into the active session. + - the new #FsStream that has been created. + the new #FsStream that has been created. User must unref the #FsStream when the stream is ended. If an error occured, returns NULL. - a #FsSession + a #FsSession - #FsParticipant of a participant for the new stream + #FsParticipant of a participant for the new stream - #FsStreamDirection describing the direction of the new stream that will + #FsStreamDirection describing the direction of the new stream that will be created for this participant @@ -1820,7 +3097,9 @@ be created for this participant - Sets the allowed caps for the sink and source pads for this #FsSession. + Sets the allowed caps for the sink and source pads for this #FsSession. Only codecs that can take the input specified by the @sink_caps and can produce output as specified by the @src_caps will be produced in the #FsSession:codecs property and so only those will be negotiated. @@ -1833,27 +3112,36 @@ stream and "ANY" for an application stream. The values can be retrived using the #FsSession:allowed-src-caps and #FsSession:allowed-sink-caps properties. UNRELEASED + - %TRUE if the new filter caps were acceptable. + %TRUE if the new filter caps were acceptable. - a #FsSession + a #FsSession - Caps for the sink pad or %NULL + Caps for the sink pad or %NULL - Caps for the src pad or %NULL + Caps for the src pad or %NULL @@ -1861,7 +3149,9 @@ The values can be retrived using the #FsSession:allowed-src-caps and - Set the list of desired codec preferences. The user may + Set the list of desired codec preferences. The user may change this value during an ongoing session. Note that doing this can cause the codecs to change. Therefore this requires the user to fetch the new codecs and renegotiate them with the peers. It is a #GList @@ -1875,20 +3165,27 @@ dynamically assigned payload type. If the list of specifications would invalidate all codecs, an error will be returned. + - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #FsSession + a #FsSession - a #GList of #FsCodec with the + a #GList of #FsCodec with the desired configuration @@ -1899,23 +3196,32 @@ be returned. - Sets encryption parameters. The exact parameters depend on the type of + Sets encryption parameters. The exact parameters depend on the type of plugin being used. UNRELEASED + - %TRUE if the encryption parameters could be set, %FALSE otherwise + %TRUE if the encryption parameters could be set, %FALSE otherwise - a #FsSession + a #FsSession - a #GstStructure containing the + a #GstStructure containing the encryption parameters or %NULL to disable encryption @@ -1924,51 +3230,71 @@ plugin being used. - This function will set the currently being sent codec for all streams in this + This function will set the currently being sent codec for all streams in this session. The given #FsCodec must be taken directly from the #codecs property of the session. If the given codec is not in the codecs list, @error will be set and %FALSE will be returned. The @send_codec will be copied so it must be free'd using fs_codec_destroy() when done. + - %FALSE if the send codec couldn't be set. + %FALSE if the send codec couldn't be set. - a #FsSession + a #FsSession - a #FsCodec representing the codec to send + a #FsCodec representing the codec to send - This function will start sending a telephony event (such as a DTMF + This function will start sending a telephony event (such as a DTMF tone) on the #FsSession. You have to call the function fs_session_stop_telephony_event() to stop it. If this function returns %TRUE, a "farstream-telephony-event-started" will always be emitted when the event is actually played out. + - %TRUE if sucessful, it can return %FALSE if the #FsStream + %TRUE if sucessful, it can return %FALSE if the #FsStream does not support this telephony event. - a #FsSession + a #FsSession - A #FsStreamDTMFEvent or another number defined at + A #FsStreamDTMFEvent or another number defined at http://www.iana.org/assignments/audio-telephone-event-registry - The volume in dBm0 without the negative sign. Should be between + The volume in dBm0 without the negative sign. Should be between 0 and 36. Higher values mean lower volume @@ -1976,7 +3302,9 @@ http://www.iana.org/assignments/audio-telephone-event-registry - This function will stop sending a telephony event started by + This function will stop sending a telephony event started by fs_session_start_telephony_event(). If the event was being sent for less than 50ms, it will be sent for 50ms minimum. If the duration was a positive and the event is not over, it will cut it @@ -1984,25 +3312,35 @@ short. If this function returns %TRUE, a "farstream-telephony-event-stopped" will always be emitted when the event is actually stopped. + - %TRUE if sucessful, it can return %FALSE if the #FsSession + %TRUE if sucessful, it can return %FALSE if the #FsSession does not support telephony events or if no telephony event is being sent - an #FsSession + an #FsSession - Some codec updates need to be reliably transmitted to the other side + Some codec updates need to be reliably transmitted to the other side because they contain important parameters required to decode the media. Other codec updates, caused by user action, don't. + - A new #GList of + A new #GList of #FsCodec that need to be resent or %NULL if there are none. This list must be freed with fs_codec_list_destroy(). @@ -2011,14 +3349,18 @@ Other codec updates, caused by user action, don't. - a #FsSession + a #FsSession - + Codecs previously retrieved from the #FsSession:codecs property @@ -2028,7 +3370,9 @@ Other codec updates, caused by user action, don't. transfer-ownership="none" nullable="1" allow-none="1"> - + Codecs recently retrieved from the #FsSession:codecs property @@ -2037,68 +3381,96 @@ Other codec updates, caused by user action, don't. - This will cause the session to remove all links to other objects and to + This will cause the session to remove all links to other objects and to remove itself from the #FsConference, it will also destroy all #FsStream inside this #FsSession Once a #FsSession has been destroyed, it can not be used anymore. It is strongly recommended to call this function from the main thread because releasing the application's reference to a session. + - a #FsSession + a #FsSession - This function emit the "error" signal on a #FsSession, it should only be + This function emit the "error" signal on a #FsSession, it should only be called by subclasses. + - #FsSession on which to emit the error signal + #FsSession on which to emit the error signal - The number of the error of type #FsError + The number of the error of type #FsError - Error message + Error message - Returns the GType of the stream transmitter, bindings can use it + Returns the GType of the stream transmitter, bindings can use it to validate/convert the parameters passed to fs_session_new_stream(). + - The #GType of the stream transmitter + The #GType of the stream transmitter - A #FsSession + A #FsSession - The name of the transmitter + The name of the transmitter - Get the list of all available transmitters for this session. + Get the list of all available transmitters for this session. + - a newly-allocagted %NULL terminated array of + a newly-allocagted %NULL terminated array of named of transmitters or %NULL if no transmitter is needed for this type of session. It should be freed with g_strfreev(). @@ -2107,7 +3479,9 @@ session. It should be freed with g_strfreev(). - A #FsSession + A #FsSession @@ -2115,24 +3489,35 @@ session. It should be freed with g_strfreev(). - This function creates a stream for the given participant into the active session. + This function creates a stream for the given participant into the active session. + - the new #FsStream that has been created. + the new #FsStream that has been created. User must unref the #FsStream when the stream is ended. If an error occured, returns NULL. - a #FsSession + a #FsSession - #FsParticipant of a participant for the new stream + #FsParticipant of a participant for the new stream - #FsStreamDirection describing the direction of the new stream that will + #FsStreamDirection describing the direction of the new stream that will be created for this participant @@ -2140,45 +3525,65 @@ be created for this participant - Parses a "farstream-codecs-changed" message and checks if it matches + Parses a "farstream-codecs-changed" message and checks if it matches the @session parameters. + - %TRUE if the message matches the session and is valid. + %TRUE if the message matches the session and is valid. - a #FsSession to match against the message + a #FsSession to match against the message - a #GstMessage to parse + a #GstMessage to parse - Parses a "farstream-send-codec-changed" message and checks if it matches + Parses a "farstream-send-codec-changed" message and checks if it matches the @session parameters. + - %TRUE if the message matches the session and is valid. + %TRUE if the message matches the session and is valid. - a #FsSession to match against the message + a #FsSession to match against the message - a #GstMessage to parse + a #GstMessage to parse - Returns the #FsCodec in the message if not + Returns the #FsCodec in the message if not %NULL. @@ -2186,7 +3591,9 @@ the @session parameters. direction="out" caller-allocates="0" transfer-ownership="none"> - + Returns a #GList of #FsCodec of the message if not %NULL @@ -2196,66 +3603,92 @@ the @session parameters. - Parses a "farstream-telephony-event-started" message and checks if it matches + Parses a "farstream-telephony-event-started" message and checks if it matches the @session parameters. + - %TRUE if the message matches the session and is valid. + %TRUE if the message matches the session and is valid. - a #FsSession to match against the message + a #FsSession to match against the message - a #GstMessage to parse + a #GstMessage to parse - Returns the #FsDTMFMethod in the message if not %NULL. + Returns the #FsDTMFMethod in the message if not %NULL. - Returns the #FsDTMFEvent in the message if not %NULL. + Returns the #FsDTMFEvent in the message if not %NULL. - Returns the volume in the message if not %NULL. + Returns the volume in the message if not %NULL. - Parses a "farstream-telephony-event-stopped" message and checks if it matches + Parses a "farstream-telephony-event-stopped" message and checks if it matches the @session parameters. + - %TRUE if the message matches the session and is valid. + %TRUE if the message matches the session and is valid. - a #FsSession to match against the message + a #FsSession to match against the message - a #GstMessage to parse + a #GstMessage to parse - Returns the #FsDTMFMethod in the message if not %NULL. + Returns the #FsDTMFMethod in the message if not %NULL. @@ -2263,7 +3696,9 @@ the @session parameters. - Sets the allowed caps for the sink and source pads for this #FsSession. + Sets the allowed caps for the sink and source pads for this #FsSession. Only codecs that can take the input specified by the @sink_caps and can produce output as specified by the @src_caps will be produced in the #FsSession:codecs property and so only those will be negotiated. @@ -2276,27 +3711,36 @@ stream and "ANY" for an application stream. The values can be retrived using the #FsSession:allowed-src-caps and #FsSession:allowed-sink-caps properties. UNRELEASED + - %TRUE if the new filter caps were acceptable. + %TRUE if the new filter caps were acceptable. - a #FsSession + a #FsSession - Caps for the sink pad or %NULL + Caps for the sink pad or %NULL - Caps for the src pad or %NULL + Caps for the src pad or %NULL @@ -2304,7 +3748,9 @@ The values can be retrived using the #FsSession:allowed-src-caps and - Set the list of desired codec preferences. The user may + Set the list of desired codec preferences. The user may change this value during an ongoing session. Note that doing this can cause the codecs to change. Therefore this requires the user to fetch the new codecs and renegotiate them with the peers. It is a #GList @@ -2318,20 +3764,27 @@ dynamically assigned payload type. If the list of specifications would invalidate all codecs, an error will be returned. + - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #FsSession + a #FsSession - a #GList of #FsCodec with the + a #GList of #FsCodec with the desired configuration @@ -2342,23 +3795,32 @@ be returned. - Sets encryption parameters. The exact parameters depend on the type of + Sets encryption parameters. The exact parameters depend on the type of plugin being used. UNRELEASED + - %TRUE if the encryption parameters could be set, %FALSE otherwise + %TRUE if the encryption parameters could be set, %FALSE otherwise - a #FsSession + a #FsSession - a #GstStructure containing the + a #GstStructure containing the encryption parameters or %NULL to disable encryption @@ -2367,51 +3829,71 @@ plugin being used. - This function will set the currently being sent codec for all streams in this + This function will set the currently being sent codec for all streams in this session. The given #FsCodec must be taken directly from the #codecs property of the session. If the given codec is not in the codecs list, @error will be set and %FALSE will be returned. The @send_codec will be copied so it must be free'd using fs_codec_destroy() when done. + - %FALSE if the send codec couldn't be set. + %FALSE if the send codec couldn't be set. - a #FsSession + a #FsSession - a #FsCodec representing the codec to send + a #FsCodec representing the codec to send - This function will start sending a telephony event (such as a DTMF + This function will start sending a telephony event (such as a DTMF tone) on the #FsSession. You have to call the function fs_session_stop_telephony_event() to stop it. If this function returns %TRUE, a "farstream-telephony-event-started" will always be emitted when the event is actually played out. + - %TRUE if sucessful, it can return %FALSE if the #FsStream + %TRUE if sucessful, it can return %FALSE if the #FsStream does not support this telephony event. - a #FsSession + a #FsSession - A #FsStreamDTMFEvent or another number defined at + A #FsStreamDTMFEvent or another number defined at http://www.iana.org/assignments/audio-telephone-event-registry - The volume in dBm0 without the negative sign. Should be between + The volume in dBm0 without the negative sign. Should be between 0 and 36. Higher values mean lower volume @@ -2419,7 +3901,9 @@ http://www.iana.org/assignments/audio-telephone-event-registry - This function will stop sending a telephony event started by + This function will stop sending a telephony event started by fs_session_start_telephony_event(). If the event was being sent for less than 50ms, it will be sent for 50ms minimum. If the duration was a positive and the event is not over, it will cut it @@ -2427,32 +3911,43 @@ short. If this function returns %TRUE, a "farstream-telephony-event-stopped" will always be emitted when the event is actually stopped. + - %TRUE if sucessful, it can return %FALSE if the #FsSession + %TRUE if sucessful, it can return %FALSE if the #FsSession does not support telephony events or if no telephony event is being sent - an #FsSession + an #FsSession - These are the #GstCaps that can be fed into the session, + These are the #GstCaps that can be fed into the session, they are used to filter the codecs to only those that can accepted those caps as input. - These are the #GstCaps that the session can produce, + These are the #GstCaps that the session can produce, they are used to filter the codecs to only those that can accepted those caps as output. - This is the current preferences list for the local codecs. It is + This is the current preferences list for the local codecs. It is set by the user to specify the codec options and priorities. The user may change its value with fs_session_set_codec_preferences() at any time during a session. It is a #GList of #FsCodec. @@ -2467,7 +3962,9 @@ dynamically assigned payload type. - This is the list of codecs used for this session. It will include the + This is the list of codecs used for this session. It will include the codecs and payload type used to receive media on this session. It will also include any configuration parameter that must be transmitted reliably for the other end to decode the content. @@ -2489,7 +3986,9 @@ fs_codec_list_destroy() when done. - This is the same list of codecs as #FsSession:codecs without + This is the same list of codecs as #FsSession:codecs without the configuration information that describes the data sent. It is suitable for configurations where a list of codecs is shared by many senders. If one is using codecs such as Theora, Vorbis or H.264 that require @@ -2513,12 +4012,16 @@ fs_codec_list_destroy() when done. writable="1" construct-only="1" transfer-ownership="none"> - The #FsConference parent of this session. This property is a + The #FsConference parent of this session. This property is a construct param and is read-only. - Indicates the currently active send codec. A user can change the active + Indicates the currently active send codec. A user can change the active send codec by calling fs_session_set_send_codec(). The send codec could also be automatically changed by Farstream. This property is an #FsCodec. User must free the codec using fs_codec_destroy() when done. @@ -2527,32 +4030,47 @@ the value of this property changes. - Retrieves previously set encryption parameters + Retrieves previously set encryption parameters - The ID of the session, the first number of the pads linked to this session + transfer-ownership="none" + default-value="0"> + The ID of the session, the first number of the pads linked to this session will be this id - The media-type of the session. This is either Audio, Video or both. + transfer-ownership="none" + default-value="FS_MEDIA_TYPE_AUDIO"> + The media-type of the session. This is either Audio, Video or both. This is a constructor parameter that cannot be changed. - The Gstreamer sink pad that must be used to send media data on this + The Gstreamer sink pad that must be used to send media data on this session. User must unref this GstPad when done with it. - - Sets the IP ToS field (and if possible the IPv6 TCLASS field + + Sets the IP ToS field (and if possible the IPv6 TCLASS field @@ -2562,27 +4080,35 @@ session. User must unref this GstPad when done with it. - + - This signal is emitted in any error condition, it can be emitted on any + This signal is emitted in any error condition, it can be emitted on any thread. Applications should listen to the GstBus for errors. - The #Gobject that emitted the signal + The #Gobject that emitted the signal - The number of the error + The number of the error - Error message + Error message @@ -2591,30 +4117,44 @@ thread. Applications should listen to the GstBus for errors. - You must override at least new_stream in a subclass. + You must override at least new_stream in a subclass. + - Our parent + Our parent + - the new #FsStream that has been created. + the new #FsStream that has been created. User must unref the #FsStream when the stream is ended. If an error occured, returns NULL. - a #FsSession + a #FsSession - #FsParticipant of a participant for the new stream + #FsParticipant of a participant for the new stream - #FsStreamDirection describing the direction of the new stream that will + #FsStreamDirection describing the direction of the new stream that will be created for this participant @@ -2623,23 +4163,32 @@ be created for this participant + - %TRUE if sucessful, it can return %FALSE if the #FsStream + %TRUE if sucessful, it can return %FALSE if the #FsStream does not support this telephony event. - a #FsSession + a #FsSession - A #FsStreamDTMFEvent or another number defined at + A #FsStreamDTMFEvent or another number defined at http://www.iana.org/assignments/audio-telephone-event-registry - The volume in dBm0 without the negative sign. Should be between + The volume in dBm0 without the negative sign. Should be between 0 and 36. Higher values mean lower volume @@ -2648,14 +4197,19 @@ http://www.iana.org/assignments/audio-telephone-event-registry + - %TRUE if sucessful, it can return %FALSE if the #FsSession + %TRUE if sucessful, it can return %FALSE if the #FsSession does not support telephony events or if no telephony event is being sent - an #FsSession + an #FsSession @@ -2663,17 +4217,24 @@ does not support telephony events or if no telephony event is being sent + - %FALSE if the send codec couldn't be set. + %FALSE if the send codec couldn't be set. - a #FsSession + a #FsSession - a #FsCodec representing the codec to send + a #FsCodec representing the codec to send @@ -2681,20 +4242,27 @@ does not support telephony events or if no telephony event is being sent + - %TRUE on success, %FALSE on error. + %TRUE on success, %FALSE on error. - a #FsSession + a #FsSession - a #GList of #FsCodec with the + a #GList of #FsCodec with the desired configuration @@ -2705,8 +4273,11 @@ does not support telephony events or if no telephony event is being sent + - a newly-allocagted %NULL terminated array of + a newly-allocagted %NULL terminated array of named of transmitters or %NULL if no transmitter is needed for this type of session. It should be freed with g_strfreev(). @@ -2715,7 +4286,9 @@ session. It should be freed with g_strfreev(). - A #FsSession + A #FsSession @@ -2723,17 +4296,24 @@ session. It should be freed with g_strfreev(). + - The #GType of the stream transmitter + The #GType of the stream transmitter - A #FsSession + A #FsSession - The name of the transmitter + The name of the transmitter @@ -2741,8 +4321,11 @@ session. It should be freed with g_strfreev(). + - A new #GList of + A new #GList of #FsCodec that need to be resent or %NULL if there are none. This list must be freed with fs_codec_list_destroy(). @@ -2751,14 +4334,18 @@ session. It should be freed with g_strfreev(). - a #FsSession + a #FsSession - + Codecs previously retrieved from the #FsSession:codecs property @@ -2768,7 +4355,9 @@ session. It should be freed with g_strfreev(). transfer-ownership="none" nullable="1" allow-none="1"> - + Codecs recently retrieved from the #FsSession:codecs property @@ -2779,27 +4368,36 @@ session. It should be freed with g_strfreev(). + - %TRUE if the new filter caps were acceptable. + %TRUE if the new filter caps were acceptable. - a #FsSession + a #FsSession - Caps for the sink pad or %NULL + Caps for the sink pad or %NULL - Caps for the src pad or %NULL + Caps for the src pad or %NULL @@ -2807,20 +4405,27 @@ session. It should be freed with g_strfreev(). + - %TRUE if the encryption parameters could be set, %FALSE otherwise + %TRUE if the encryption parameters could be set, %FALSE otherwise - a #FsSession + a #FsSession - a #GstStructure containing the + a #GstStructure containing the encryption parameters or %NULL to disable encryption @@ -2828,12 +4433,16 @@ session. It should be freed with g_strfreev(). - + - + + glib:type-name="FsStream" glib:get-type="fs_stream_get_type" glib:type-struct="StreamClass"> - All members are private, access them using methods and properties + All members are private, access them using methods and properties + - This function is used to add data identifiers that allow the + This function is used to add data identifiers that allow the plugin to recognize packets that are meant for id. For example, in RTP, one would set the SSRCs that are expected. @@ -2858,16 +4472,21 @@ override the previdous decision. For most protocols, calling this function is optional as the incoming data can be matched with a stream by its source IP address. This is mostly useful if one is using multicast or is behind a muxer server. + - a #FsStream + a #FsStream - The id to add to the stream + The id to add to the stream @@ -2875,21 +4494,30 @@ if one is using multicast or is behind a muxer server. - This function adds remote candidates. Any new candidates are + This function adds remote candidates. Any new candidates are added to the list. The candidates will be used to establish a connection with the peer. A copy will be made so the user must free the passed candidate using fs_candidate_destroy() when done. + - TRUE if the candidate was valid, FALSE otherwise + TRUE if the candidate was valid, FALSE otherwise - an #FsStream + an #FsStream - an #GList of #FsCandidate + an #GList of #FsCandidate representing the remote candidates @@ -2900,20 +4528,29 @@ passed candidate using fs_candidate_destroy() when done. - This function forces data to be sent immediately to the selected remote + This function forces data to be sent immediately to the selected remote candidate, by-passing any connectivity checks. There should be at most one candidate per component. + - %TRUE if the candidates could be forced, %FALSE otherwise + %TRUE if the candidates could be forced, %FALSE otherwise - a #FsStream + a #FsStream - + a #GList of #FsCandidate to force @@ -2924,20 +4561,29 @@ one candidate per component. - Sets decryption parameters. The exact parameters depend on the type of + Sets decryption parameters. The exact parameters depend on the type of plugin being used. UNRELEASED + - %TRUE if the decryption parameters could be set, %FALSE otherwise + %TRUE if the decryption parameters could be set, %FALSE otherwise - a #FsStream + a #FsStream - a #GstStructure containing the decryption + a #GstStructure containing the decryption parameters @@ -2946,22 +4592,31 @@ plugin being used. - This function will set the list of remote codecs for this stream. If + This function will set the list of remote codecs for this stream. If the given remote codecs couldn't be negotiated with the list of local codecs or already negotiated codecs for the corresponding #FsSession, @error will be set and %FALSE will be returned. The @remote_codecs list will be copied so it must be free'd using fs_codec_list_destroy() when done. + - %FALSE if the remote codecs couldn't be set. + %FALSE if the remote codecs couldn't be set. - a #FsStream + a #FsStream - a #GList of #FsCodec representing + a #GList of #FsCodec representing the remote codecs @@ -2972,29 +4627,40 @@ copied so it must be free'd using fs_codec_list_destroy() when done. - Set the transmitter to use for this stream. This function will only succeed + Set the transmitter to use for this stream. This function will only succeed once. The parameters correspond to the varios GObject properties of the selected stream transmitter. + - %TRUE if the transmitter could be set, %FALSE otherwise + %TRUE if the transmitter could be set, %FALSE otherwise - a #FsStream + a #FsStream - Name of the type of transmitter to use for this stream + Name of the type of transmitter to use for this stream - + an array of n_parameters #GParameter struct that will be passed to the newly-create #FsStreamTransmitter @@ -3003,14 +4669,18 @@ selected stream transmitter. - Number of parametrs passed to the stream + Number of parametrs passed to the stream transmitter - This function is used to add data identifiers that allow the + This function is used to add data identifiers that allow the plugin to recognize packets that are meant for id. For example, in RTP, one would set the SSRCs that are expected. @@ -3023,16 +4693,21 @@ override the previdous decision. For most protocols, calling this function is optional as the incoming data can be matched with a stream by its source IP address. This is mostly useful if one is using multicast or is behind a muxer server. + - a #FsStream + a #FsStream - The id to add to the stream + The id to add to the stream @@ -3040,21 +4715,30 @@ if one is using multicast or is behind a muxer server. - This function adds remote candidates. Any new candidates are + This function adds remote candidates. Any new candidates are added to the list. The candidates will be used to establish a connection with the peer. A copy will be made so the user must free the passed candidate using fs_candidate_destroy() when done. + - TRUE if the candidate was valid, FALSE otherwise + TRUE if the candidate was valid, FALSE otherwise - an #FsStream + an #FsStream - an #GList of #FsCandidate + an #GList of #FsCandidate representing the remote candidates @@ -3063,61 +4747,84 @@ passed candidate using fs_candidate_destroy() when done. - This will cause the stream to remove all links to other objects and to + This will cause the stream to remove all links to other objects and to remove itself from the #FsSession. Once a #FsStream has been destroyed, it can not be used anymore. It is strongly recommended to call this function from the main thread because releasing the application's reference to a stream. + - a #FsStream + a #FsStream - This function emits the #FsStream::error" signal, it should only be + This function emits the #FsStream::error" signal, it should only be called by subclasses. + - #FsStream on which to emit the error signal + #FsStream on which to emit the error signal - The number of the error + The number of the error - Error message to be displayed to user + Error message to be displayed to user - Emits the #FsStream::src-pad-added" signal, it should only be + Emits the #FsStream::src-pad-added" signal, it should only be called by subclasses. + - #FsStream on which to emit the src-pad-added signal + #FsStream on which to emit the src-pad-added signal - the #GstPad that this #FsStream has created + the #GstPad that this #FsStream has created - The #FsCodec for this pad + The #FsCodec for this pad @@ -3125,20 +4832,29 @@ called by subclasses. - This function forces data to be sent immediately to the selected remote + This function forces data to be sent immediately to the selected remote candidate, by-passing any connectivity checks. There should be at most one candidate per component. + - %TRUE if the candidates could be forced, %FALSE otherwise + %TRUE if the candidates could be forced, %FALSE otherwise - a #FsStream + a #FsStream - + a #GList of #FsCandidate to force @@ -3148,94 +4864,134 @@ one candidate per component. - Creates a #GstIterator that can be used to iterate the src pads of this + Creates a #GstIterator that can be used to iterate the src pads of this stream. These are the pads that were announced by #FsStream:src-pad-added and are still valid. + - The #GstIterator + The #GstIterator - a #FsStream + a #FsStream - Parses a "farstream-component-state-changed" message and checks if it matches + Parses a "farstream-component-state-changed" message and checks if it matches the @stream parameters. + - %TRUE if the message matches the stream and is valid. + %TRUE if the message matches the stream and is valid. - a #FsStream to match against the message + a #FsStream to match against the message - a #GstMessage to parse + a #GstMessage to parse - Returns the component from the #GstMessage if not %NULL + Returns the component from the #GstMessage if not %NULL - Returns the #FsStreamState from the #GstMessage if not %NULL + Returns the #FsStreamState from the #GstMessage if not %NULL - Parses a "farstream-local-candidates-prepared" message and checks if it matches + Parses a "farstream-local-candidates-prepared" message and checks if it matches the @stream parameters. + - %TRUE if the message matches the stream and is valid. + %TRUE if the message matches the stream and is valid. - a #FsStream to match against the message + a #FsStream to match against the message - a #GstMessage to parse + a #GstMessage to parse - Parses a "farstream-new-active-candidate-pair" message and checks + Parses a "farstream-new-active-candidate-pair" message and checks if it matches the @stream parameters. + - %TRUE if the message matches the stream and is valid. + %TRUE if the message matches the stream and is valid. - a #FsStream to match against the message + a #FsStream to match against the message - a #GstMessage to parse + a #GstMessage to parse - Returns the local #FsCandidate in + Returns the local #FsCandidate in the message if not %NULL. @@ -3243,7 +4999,9 @@ if it matches the @stream parameters. direction="out" caller-allocates="0" transfer-ownership="none"> - Returns the remote #FsCandidate in + Returns the remote #FsCandidate in the message if not %NULL. @@ -3251,26 +5009,37 @@ if it matches the @stream parameters. - Parses a "farstream-new-local-candidate" message and checks if it matches + Parses a "farstream-new-local-candidate" message and checks if it matches the @stream parameters. + - %TRUE if the message matches the stream and is valid. + %TRUE if the message matches the stream and is valid. - a #FsStream to match against the message + a #FsStream to match against the message - a #GstMessage to parse + a #GstMessage to parse - Returns the #FsCandidate in the message + Returns the #FsCandidate in the message if not %NULL. @@ -3278,26 +5047,37 @@ the @stream parameters. - Parses a "farstream-recv-codecs-changed" message and checks if it matches + Parses a "farstream-recv-codecs-changed" message and checks if it matches the @stream parameters. + - %TRUE if the message matches the stream and is valid. + %TRUE if the message matches the stream and is valid. - a #FsStream to match against the message + a #FsStream to match against the message - a #GstMessage to parse + a #GstMessage to parse - + Returns a #GList of #FsCodec of the message if not %NULL @@ -3308,20 +5088,29 @@ the @stream parameters. - Sets decryption parameters. The exact parameters depend on the type of + Sets decryption parameters. The exact parameters depend on the type of plugin being used. UNRELEASED + - %TRUE if the decryption parameters could be set, %FALSE otherwise + %TRUE if the decryption parameters could be set, %FALSE otherwise - a #FsStream + a #FsStream - a #GstStructure containing the decryption + a #GstStructure containing the decryption parameters @@ -3330,22 +5119,31 @@ plugin being used. - This function will set the list of remote codecs for this stream. If + This function will set the list of remote codecs for this stream. If the given remote codecs couldn't be negotiated with the list of local codecs or already negotiated codecs for the corresponding #FsSession, @error will be set and %FALSE will be returned. The @remote_codecs list will be copied so it must be free'd using fs_codec_list_destroy() when done. + - %FALSE if the remote codecs couldn't be set. + %FALSE if the remote codecs couldn't be set. - a #FsStream + a #FsStream - a #GList of #FsCodec representing + a #GList of #FsCodec representing the remote codecs @@ -3356,29 +5154,40 @@ copied so it must be free'd using fs_codec_list_destroy() when done. - Set the transmitter to use for this stream. This function will only succeed + Set the transmitter to use for this stream. This function will only succeed once. The parameters correspond to the varios GObject properties of the selected stream transmitter. + - %TRUE if the transmitter could be set, %FALSE otherwise + %TRUE if the transmitter could be set, %FALSE otherwise - a #FsStream + a #FsStream - Name of the type of transmitter to use for this stream + Name of the type of transmitter to use for this stream - + an array of n_parameters #GParameter struct that will be passed to the newly-create #FsStreamTransmitter @@ -3387,7 +5196,9 @@ selected stream transmitter. - Number of parametrs passed to the stream + Number of parametrs passed to the stream transmitter @@ -3396,7 +5207,9 @@ selected stream transmitter. - Set the transmitter to use for this stream. This function will only succeed + Set the transmitter to use for this stream. This function will only succeed once. The parameters correspond to the varios GObject properties of the @@ -3404,24 +5217,33 @@ selected stream transmitter. This is the same as fs_stream_set_transmitter() except that the parameters are passed in a #GHashTable to make it more friendly to GObject introspection + - %TRUE if the transmitter could be set, %FALSE otherwise + %TRUE if the transmitter could be set, %FALSE otherwise - a #FsStream + a #FsStream - Name of the type of transmitter to use for this stream + Name of the type of transmitter to use for this stream - + A #GHashTable of string->GValue containing the parameters. @@ -3431,7 +5253,9 @@ are passed in a #GHashTable to make it more friendly to GObject introspection - This is the list of codecs that have been received by this stream. + This is the list of codecs that have been received by this stream. The user must free the list if fs_codec_list_destroy(). The "farstream-recv-codecs-changed" message is send on the #GstBus when the value of this property changes. @@ -3444,20 +5268,27 @@ will come to it is different. - Retrieves previously set decryption parameters + Retrieves previously set decryption parameters - The direction of the stream. This property is set initially as a parameter + transfer-ownership="none" + default-value="FS_DIRECTION_NONE"> + The direction of the stream. This property is set initially as a parameter to the fs_session_new_stream() function. It can be changed later if required by setting this property. - This is the list of negotiatied codecs, it is the same list as the list + This is the list of negotiatied codecs, it is the same list as the list of #FsCodec from the parent #FsSession, except that the codec config data has been replaced with the data from the remote codecs for this stream. This is the list of #FsCodec used to receive data from this stream. @@ -3470,23 +5301,39 @@ It is a #GList of #FsCodec. writable="1" construct-only="1" transfer-ownership="none"> - The #FsParticipant for this stream. This property is a construct param and + The #FsParticipant for this stream. This property is a construct param and is read-only construction. - This is the list of remote codecs for this stream. They must be set by the + This is the list of remote codecs for this stream. They must be set by the user as soon as they are known using fs_stream_set_remote_codecs() (generally through external signaling). It is a #GList of #FsCodec. + + If set to TRUE, only encrypted content will be accepted on this +stream. + + - The #FsSession for this stream. This property is a construct param and + The #FsSession for this stream. This property is a construct param and is read-only construction. @@ -3497,28 +5344,36 @@ is read-only construction. - + - This signal is emitted in any error condition + This signal is emitted in any error condition - The number of the error + The number of the error - Error message to be displayed to user + Error message to be displayed to user - This signal is emitted when a new gst source pad has been created for a + This signal is emitted when a new gst source pad has been created for a specific codec being received. There will be a different source pad for each codec that is received. The user must ref the #GstPad if he wants to keep it. The user should not modify the #FsCodec and must copy it if he @@ -3531,11 +5386,15 @@ thread! - #GstPad of the new source pad + #GstPad of the new source pad - #FsCodec of the codec being received on the new source pad + #FsCodec of the codec being received on the new source pad @@ -3544,25 +5403,37 @@ thread! - You must override add_remote_candidate in a subclass. + You must override add_remote_candidate in a subclass. If you have to negotiate codecs, then you must override set_remote_codecs too + - Our parent + Our parent + - TRUE if the candidate was valid, FALSE otherwise + TRUE if the candidate was valid, FALSE otherwise - an #FsStream + an #FsStream - an #GList of #FsCandidate + an #GList of #FsCandidate representing the remote candidates @@ -3573,17 +5444,24 @@ If you have to negotiate codecs, then you must override set_remote_codecs too + - %TRUE if the candidates could be forced, %FALSE otherwise + %TRUE if the candidates could be forced, %FALSE otherwise - a #FsStream + a #FsStream - + a #GList of #FsCandidate to force @@ -3594,17 +5472,24 @@ If you have to negotiate codecs, then you must override set_remote_codecs too + - %FALSE if the remote codecs couldn't be set. + %FALSE if the remote codecs couldn't be set. - a #FsStream + a #FsStream - a #GList of #FsCodec representing + a #GList of #FsCodec representing the remote codecs @@ -3615,16 +5500,21 @@ If you have to negotiate codecs, then you must override set_remote_codecs too + - a #FsStream + a #FsStream - The id to add to the stream + The id to add to the stream @@ -3632,24 +5522,33 @@ If you have to negotiate codecs, then you must override set_remote_codecs too + - %TRUE if the transmitter could be set, %FALSE otherwise + %TRUE if the transmitter could be set, %FALSE otherwise - a #FsStream + a #FsStream - Name of the type of transmitter to use for this stream + Name of the type of transmitter to use for this stream - + an array of n_parameters #GParameter struct that will be passed to the newly-create #FsStreamTransmitter @@ -3658,7 +5557,9 @@ If you have to negotiate codecs, then you must override set_remote_codecs too - Number of parametrs passed to the stream + Number of parametrs passed to the stream transmitter @@ -3667,17 +5568,24 @@ If you have to negotiate codecs, then you must override set_remote_codecs too + - %TRUE if the decryption parameters could be set, %FALSE otherwise + %TRUE if the decryption parameters could be set, %FALSE otherwise - a #FsStream + a #FsStream - a #GstStructure containing the decryption + a #GstStructure containing the decryption parameters @@ -3685,7 +5593,7 @@ If you have to negotiate codecs, then you must override set_remote_codecs too - + @@ -3694,77 +5602,115 @@ If you have to negotiate codecs, then you must override set_remote_codecs too - An enum for specifying the direction of a stream + An enum for specifying the direction of a stream - No direction specified + glib:nick="none" + glib:name="FS_DIRECTION_NONE"> + No direction specified - Send only + glib:nick="send" + glib:name="FS_DIRECTION_SEND"> + Send only - Receive only + glib:nick="recv" + glib:name="FS_DIRECTION_RECV"> + Receive only - Send and receive + glib:nick="both" + glib:name="FS_DIRECTION_BOTH"> + Send and receive - + + - These are the possible states of a stream, a simple multicast stream + These are the possible states of a stream, a simple multicast stream could only be in "disconnected" or "ready" state. An stream using an ICE transmitter would use all of these. - connectivity checks have been completed, + glib:nick="failed" + glib:name="FS_STREAM_STATE_FAILED"> + connectivity checks have been completed, but connectivity was not established - no activity scheduled + glib:nick="disconnected" + glib:name="FS_STREAM_STATE_DISCONNECTED"> + no activity scheduled - gathering local candidates + glib:nick="gathering" + glib:name="FS_STREAM_STATE_GATHERING"> + gathering local candidates - establishing connectivity + glib:nick="connecting" + glib:name="FS_STREAM_STATE_CONNECTING"> + establishing connectivity - at least one working candidate pair + glib:nick="connected" + glib:name="FS_STREAM_STATE_CONNECTED"> + at least one working candidate pair - ICE concluded, candidate pair selection is now final + glib:nick="ready" + glib:name="FS_STREAM_STATE_READY"> + ICE concluded, candidate pair selection is now final glib:type-name="FsStreamTransmitter" glib:get-type="fs_stream_transmitter_get_type" glib:type-struct="StreamTransmitterClass"> - All members are private, access them using methods and properties + All members are private, access them using methods and properties + - This function is used to add remote candidates to the transmitter + This function is used to add remote candidates to the transmitter + - TRUE of the candidate could be added, FALSE if it couldnt + TRUE of the candidate could be added, FALSE if it couldnt (and the #GError will be set) - a #FsStreamTranmitter + a #FsStreamTranmitter - a #GList of the remote candidates + a #GList of the remote candidates @@ -3802,21 +5760,30 @@ An stream using an ICE transmitter would use all of these. - This function forces data to be sent immediately to the selected remote + This function forces data to be sent immediately to the selected remote candidate, by-passing any connectivity checks. There should be at most one candidate per component. + - %TRUE if the candidates could be forced, %FALSE otherwise + %TRUE if the candidates could be forced, %FALSE otherwise - a #FsStreamTransmitter + a #FsStreamTransmitter - a #GList of #FsCandidate to + a #GList of #FsCandidate to force @@ -3827,31 +5794,43 @@ one candidate per component. - This function tells the transmitter to start gathering local candidates, + This function tells the transmitter to start gathering local candidates, signals for new candidates and newly active candidates can be emitted during the call to this function. + - %TRUE if it succeeds (or is not implemented), %FALSE otherwise + %TRUE if it succeeds (or is not implemented), %FALSE otherwise - a #FsStreamTransmitter + a #FsStreamTransmitter - This functions stops the #FsStreamTransmitter, it must be called before + This functions stops the #FsStreamTransmitter, it must be called before the last reference is dropped. + - a #FsStreamTransmitter + a #FsStreamTransmitter @@ -3859,20 +5838,29 @@ the last reference is dropped. - This function is used to add remote candidates to the transmitter + This function is used to add remote candidates to the transmitter + - TRUE of the candidate could be added, FALSE if it couldnt + TRUE of the candidate could be added, FALSE if it couldnt (and the #GError will be set) - a #FsStreamTranmitter + a #FsStreamTranmitter - a #GList of the remote candidates + a #GList of the remote candidates @@ -3881,23 +5869,32 @@ the last reference is dropped. - This function emit the "error" signal on a #FsStreamTransmitter, it should + This function emit the "error" signal on a #FsStreamTransmitter, it should only be called by subclasses. + - #FsStreamTransmitter on which to emit the error signal + #FsStreamTransmitter on which to emit the error signal - The number of the error + The number of the error - Error message (for the programmer) + Error message (for the programmer) @@ -3905,21 +5902,30 @@ only be called by subclasses. - This function forces data to be sent immediately to the selected remote + This function forces data to be sent immediately to the selected remote candidate, by-passing any connectivity checks. There should be at most one candidate per component. + - %TRUE if the candidates could be forced, %FALSE otherwise + %TRUE if the candidates could be forced, %FALSE otherwise - a #FsStreamTransmitter + a #FsStreamTransmitter - a #GList of #FsCandidate to + a #GList of #FsCandidate to force @@ -3930,31 +5936,43 @@ one candidate per component. - This function tells the transmitter to start gathering local candidates, + This function tells the transmitter to start gathering local candidates, signals for new candidates and newly active candidates can be emitted during the call to this function. + - %TRUE if it succeeds (or is not implemented), %FALSE otherwise + %TRUE if it succeeds (or is not implemented), %FALSE otherwise - a #FsStreamTransmitter + a #FsStreamTransmitter - This functions stops the #FsStreamTransmitter, it must be called before + This functions stops the #FsStreamTransmitter, it must be called before the last reference is dropped. + - a #FsStreamTransmitter + a #FsStreamTransmitter @@ -3962,8 +5980,11 @@ the last reference is dropped. - This tells the stream transmitter to associate incoming data with this + transfer-ownership="none" + default-value="TRUE"> + This tells the stream transmitter to associate incoming data with this based on the source without looking at the content if possible. @@ -3973,8 +5994,13 @@ based on the source without looking at the content if possible. transfer-ownership="none"> - - A network source #GstElement to be used by the #FsSession + + A network source #GstElement to be used by the #FsSession @@ -3985,52 +6011,71 @@ based on the source without looking at the content if possible. c:type="FsStreamTransmitterPrivate*"/> - + - This signal is emitted in any error condition + This signal is emitted in any error condition - The number of the error + The number of the error - Error message (for the programmer) + Error message (for the programmer) - This signal is emitted when a buffer coming from a confirmed known source + This signal is emitted when a buffer coming from a confirmed known source is received. - The Component on which this buffer was received + The Component on which this buffer was received - - the #GstBuffer coming from the known source + + the #GstBuffer coming from the known source - This signal is emitted when all local candidates have been + This signal is emitted when all local candidates have been prepared, an ICE implementation would send its SDP offer or answer. - This signal is emitted when there is a new active chandidate pair that has + This signal is emitted when there is a new active chandidate pair that has been established. This is specially useful for ICE where the active candidate pair can change automatically due to network conditions. The user must not modify the candidates and must copy them if he wants to use them @@ -4040,40 +6085,54 @@ outside the callback scope. - #FsCandidate of the local candidate being used + #FsCandidate of the local candidate being used - #FsCandidate of the remote candidate being used + #FsCandidate of the remote candidate being used - This signal is emitted when a new local candidate is discovered. + This signal is emitted when a new local candidate is discovered. - #FsCandidate of the local candidate + #FsCandidate of the local candidate - This signal is emitted when the ICE state (or equivalent) of the component + This signal is emitted when the ICE state (or equivalent) of the component changes - the id of the component which state has changed + the id of the component which state has changed - the new state of the component + the new state of the component @@ -4082,25 +6141,37 @@ changes - You must override the add_remote_candidate in a subclass + You must override the add_remote_candidate in a subclass + - Our parent + Our parent + - TRUE of the candidate could be added, FALSE if it couldnt + TRUE of the candidate could be added, FALSE if it couldnt (and the #GError will be set) - a #FsStreamTranmitter + a #FsStreamTranmitter - a #GList of the remote candidates + a #GList of the remote candidates @@ -4110,17 +6181,24 @@ changes + - %TRUE if the candidates could be forced, %FALSE otherwise + %TRUE if the candidates could be forced, %FALSE otherwise - a #FsStreamTransmitter + a #FsStreamTransmitter - a #GList of #FsCandidate to + a #GList of #FsCandidate to force @@ -4131,13 +6209,18 @@ changes + - %TRUE if it succeeds (or is not implemented), %FALSE otherwise + %TRUE if it succeeds (or is not implemented), %FALSE otherwise - a #FsStreamTransmitter + a #FsStreamTransmitter @@ -4145,27 +6228,68 @@ changes + - a #FsStreamTransmitter + a #FsStreamTransmitter - + + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="FsTransmitter" glib:get-type="fs_transmitter_get_type" glib:type-struct="TransmitterClass"> - All members are private, access them using methods and properties + All members are private, access them using methods and properties + - This function creates a new transmitter of the requested type. + This function creates a new transmitter of the requested type. It will load the appropriate plugin as required. + - a newly-created #FsTransmitter of the requested type + a newly-created #FsTransmitter of the requested type (or NULL if there is an error) - The type of transmitter to create + The type of transmitter to create - The number of components to create + The number of components to create - The Type of Service of the socket, max is 255 + The Type of Service of the socket, max is 255 - Get the list of all available transmitters + Get the list of all available transmitters + - a newly allocated array of strings containing the + a newly allocated array of strings containing the list of all available transmitters or %NULL if there are none. It should be freed with g_strfreev(). @@ -4212,16 +6355,23 @@ list of all available transmitters or %NULL if there are none. It should - This function returns the GObject type for the stream transmitter. + This function returns the GObject type for the stream transmitter. This is meant for bindings that need to introspect the type of arguments that can be passed to the _new_stream_transmitter. + - the #GType + the #GType - A #FsTransmitter object + A #FsTransmitter object @@ -4229,67 +6379,96 @@ that can be passed to the _new_stream_transmitter. - This function will create a new #FsStreamTransmitter element for a + This function will create a new #FsStreamTransmitter element for a specific participant for this #FsTransmitter + - a new #FsStreamTransmitter, or NULL if there is an + a new #FsStreamTransmitter, or NULL if there is an error - a #FsTranmitter + a #FsTranmitter - the #FsParticipant for which the #FsStream using this + the #FsParticipant for which the #FsStream using this new #FsStreamTransmitter is created - The number of parameters to pass to the newly created + The number of parameters to pass to the newly created #FsStreamTransmitter - an array of #GParameter + an array of #GParameter - This function emit the "error" signal on a #FsTransmitter, it should + This function emit the "error" signal on a #FsTransmitter, it should only be called by subclasses. + - #FsTransmitter on which to emit the error signal + #FsTransmitter on which to emit the error signal - The number of the error + The number of the error - Error message to be displayed to user + Error message to be displayed to user - This function returns the GObject type for the stream transmitter. + This function returns the GObject type for the stream transmitter. This is meant for bindings that need to introspect the type of arguments that can be passed to the _new_stream_transmitter. + - the #GType + the #GType - A #FsTransmitter object + A #FsTransmitter object @@ -4297,30 +6476,43 @@ that can be passed to the _new_stream_transmitter. - This function will create a new #FsStreamTransmitter element for a + This function will create a new #FsStreamTransmitter element for a specific participant for this #FsTransmitter + - a new #FsStreamTransmitter, or NULL if there is an + a new #FsStreamTransmitter, or NULL if there is an error - a #FsTranmitter + a #FsTranmitter - the #FsParticipant for which the #FsStream using this + the #FsParticipant for which the #FsStream using this new #FsStreamTransmitter is created - The number of parameters to pass to the newly created + The number of parameters to pass to the newly created #FsStreamTransmitter - an array of #GParameter + an array of #GParameter @@ -4328,17 +6520,27 @@ new #FsStreamTransmitter is created - The number of components to create + transfer-ownership="none" + default-value="1"> + The number of components to create - - Apply current stream time to buffers or provide buffers without + + Apply current stream time to buffers or provide buffers without timestamps. Must be set before creating a stream transmitter. - A network source #GstElement to be used by the #FsSession + A network source #GstElement to be used by the #FsSession These element's sink must have async=FALSE This element MUST provide a pad named "sink_\%u" per component. These pads number must start at 1 (the \%u corresponds to the component @@ -4347,15 +6549,22 @@ These pads MUST be static pads. - A network source #GstElement to be used by the #FsSession + A network source #GstElement to be used by the #FsSession This element MUST provide a source pad named "src_%u" per component. These pads number must start at 1 (the %u corresponds to the component number). These pads MUST be static pads. - - Sets the IP ToS field (and if possible the IPv6 TCLASS field + + Sets the IP ToS field (and if possible the IPv6 TCLASS field @@ -4368,22 +6577,28 @@ These pads MUST be static pads. - + - This signal is emitted in any error condition + This signal is emitted in any error condition - The number of the error + The number of the error - Error message to be displayed to user + Error message to be displayed to user @@ -4392,35 +6607,51 @@ These pads MUST be static pads. - You must override both methods in a subclass. + You must override both methods in a subclass. + - Our parent + Our parent + - a new #FsStreamTransmitter, or NULL if there is an + a new #FsStreamTransmitter, or NULL if there is an error - a #FsTranmitter + a #FsTranmitter - the #FsParticipant for which the #FsStream using this + the #FsParticipant for which the #FsStream using this new #FsStreamTransmitter is created - The number of parameters to pass to the newly created + The number of parameters to pass to the newly created #FsStreamTransmitter - an array of #GParameter + an array of #GParameter @@ -4428,41 +6659,55 @@ new #FsStreamTransmitter is created + - the #GType + the #GType - A #FsTransmitter object + A #FsTransmitter object - + + disguised="1" + opaque="1"> + - Copies a GList of #FsCandidate and its contents + Copies a GList of #FsCandidate and its contents + - a new GList of #FsCandidate + a new GList of #FsCandidate - A GList of #FsCandidate + A GList of #FsCandidate @@ -4473,13 +6718,18 @@ new #FsStreamTransmitter is created c:identifier="fs_candidate_list_destroy" moved-to="CandidateList.destroy" introspectable="0"> - Deletes a GList of #FsCandidate and its contents + Deletes a GList of #FsCandidate and its contents + - A GList of #FsCandidate + A GList of #FsCandidate @@ -4489,9 +6739,14 @@ new #FsStreamTransmitter is created - Verifies if two glist of fscodecs are identical + Verifies if two glist of fscodecs are identical + - %TRUE if they are identical, %FALSE otherwise + %TRUE if they are identical, %FALSE otherwise @@ -4499,7 +6754,9 @@ new #FsStreamTransmitter is created transfer-ownership="none" nullable="1" allow-none="1"> - a #GList of #FsCodec + a #GList of #FsCodec @@ -4508,7 +6765,9 @@ new #FsStreamTransmitter is created transfer-ownership="none" nullable="1" allow-none="1"> - a #GList of #FsCodec + a #GList of #FsCodec @@ -4518,16 +6777,23 @@ new #FsStreamTransmitter is created - Copies a list of #FsCodec structures. + Copies a list of #FsCodec structures. + - The new list. + The new list. - + a GList of #FsCodec to copy @@ -4539,14 +6805,19 @@ new #FsStreamTransmitter is created c:identifier="fs_codec_list_destroy" moved-to="CodecGList.destroy" introspectable="0"> - Deletes a list of #FsCodec structures and the list itself. + Deletes a list of #FsCodec structures and the list itself. Does nothing on %NULL lists. + - a GList of #FsCodec to delete + a GList of #FsCodec to delete @@ -4557,7 +6828,9 @@ Does nothing on %NULL lists. c:identifier="fs_codec_list_from_keyfile" moved-to="CodecGList.from_keyfile" throws="1"> - Reads the content of a #GKeyFile of the following format into + Reads the content of a #GKeyFile of the following format into a #GList of #FsCodec structures. @@ -4578,8 +6851,11 @@ wierd_param=42 feedback:nack/pli=1 feedback:tfrc= ]| + - + The #GList of #FsCodec or %NULL if the keyfile was empty or an error occured. @@ -4587,7 +6863,9 @@ The #GList of #FsCodec or %NULL if the keyfile was empty or an error occured. - Name of the #GKeyFile to read the codecs parameters from + Name of the #GKeyFile to read the codecs parameters from @@ -4599,42 +6877,317 @@ The #GList of #FsCodec or %NULL if the keyfile was empty or an error occured. + + An FsCandidate is a way to exchange candidate information between the client +and Farstream. This description is compatible with ICE-13. It can also be a +multicast address. Candidates are linked to streams. The information +specified in this structure is usually representative of the codec +information exchanged in the signaling. + + + An #FsCodec is a way to exchange codec information between the client and +Farstream. The information specified in this structure is usually +representative of the codec information exchanged in the signaling. + + + A Farstream conference is a conversation space that takes place between 2 or +more participants. Each conference must have one or more Farstream sessions +that are associated to the conference participants. + + +This will communicate asynchronous events to the user through #GstMessage +of type #GST_MESSAGE_ELEMENT sent over the #GstBus. + +<refsect2><title>The "<literal>farstream-error</literal>" message</title> +|[ +"src-object" #GObject The object (#FsConference, #FsSession or #FsStream) that emitted the error +"error-no" #FsError The Error number +"error-msg" #gchar* The error message +]| +<para> +The message is sent on asynchronous errors. +</para> +</refsect2> + + + This object can be attach to any #GstBin and will emit a the +#FsElementAddedNotifier::element-added signal for every element inside the +#GstBin or any sub-bin and any element added in the future to the bin or +its sub-bins. There is also a utility method to have it used to +set the properties of elements based on a GKeyfile. + + + This object is the base implementation of a Farstream Participant. It needs to be +derived and implemented by a farstream conference gstreamer element. A +participant represents any source of media in a conference. This could be a +human-participant or an automaton. + + + This class is a generic class to load GType plugins based on their name. +With this simple class, you can only have one type per plugin. + + + This object is the base implementation of a Farstream Session. It needs to be +derived and implemented by a farstream conference gstreamer element. A +Farstream session is defined in the same way as an RTP session. It can contain +one or more participants but represents only one media stream (i.e. One +session for video and one session for audio in an AV conference). Sessions +contained in the same conference will be synchronised together during +playback. + + +This will communicate asynchronous events to the user through #GstMessage +of type #GST_MESSAGE_ELEMENT sent over the #GstBus. + +<refsect2><title>The "<literal>farstream-send-codec-changed</literal>" + message</title> +<table> + <tr> + <td><code>"session"</code></td> + <td>#FsSession</td> + <td>The session that emits the message</td> + </tr> + <tr> + <td><code>"codec"</code></td> + <td>#FsCodec</td> + <td>The new send codec</td> + </tr> + <tr> + <td><code>"secondary-codecs"</code></td> + <td>#GList</td> + <td>A #GList of #FsCodec (to be freed with fs_codec_list_destroy()) + </td> + </tr> +</table> +<para> +This message is sent on the bus when the value of the +#FsSession:current-send-codec property changes. +</para> +</refsect2> +<refsect2><title>The "<literal>farstream-codecs-changed</literal>" + message</title> +<table> + <tr> + <td><code>"session"</code></td> + <td>#FsSession</td> + <td>The session that emits the message</td> + </tr> +</table> +<para> +This message is sent on the bus when the value of the +#FsSession:codecs or #FsSession:codecs-without-config properties change. +If one is using codecs that have configuration data that needs to be +transmitted reliably, one should fetch #FsSession:codecs, otherwise, +#FsSession:codecs-without-config should be enough. +</para> +</refsect2> +<refsect2><title>The "<literal>farstream-telephony-event-started</literal>" + message</title> +<table> + <tr> + <td><code>"session"</code></td> + <td>#FsSession</td> + <td>The session that emits the message</td> + </tr> + <tr> + <td><code>"method"</code></td> + <td>#FsDTMFMethod</td> + <td>The method used to send the DTMF</td> + </tr> + <tr> + <td><code>"event"</code></td> + <td>#FSDTMFEvent</td> + <td>The event number</td> + </tr> + <tr> + <td><code>"volume"</code></td> + <td>guchar</td> + <td>The volume of the event</td> + </tr> +</table> +<para> +This message is emitted after a succesful call to +fs_session_start_telephony_event() to inform the application that the +telephony event has started. +</para> +</refsect2> +<refsect2><title>The "<literal>farstream-telephony-event-stopped</literal>" + message</title> +<table> + <tr> + <td><code>"session"</code></td> + <td>#FsSession</td> + <td>The session that emits the message</td> + </tr> + <tr> + <td><code>"method"</code></td> + <td>#FsDTMFMethod</td> + <td>The method used to send the DTMF</td> + </tr> +</table> +<para> +This message is emitted after a succesful call to +fs_session_stop_telephony_event() to inform the application that the +telephony event has stopped. +</para> +</refsect2> + + + This object is the base implementation of a Farstream Stream. It +needs to be derived and implemented by a Farstream conference GStreamer +element. A Farstream Stream is a media stream originating from a +#FsParticipant inside a #FsSession. In fact, a #FsStream instance is +obtained by adding a participant into a session using +fs_session_new_stream(). + + +This will communicate asynchronous events to the user through #GstMessage +of type #GST_MESSAGE_ELEMENT sent over the #GstBus. + +<refsect2><title>The "<literal>farstream-new-local-candidate</literal>" message</title> +|[ +"stream" #FsStream The stream that emits the message +"candidate" #FsCandidate The new candidate +]| +<para> +This message is emitted when a new local candidate is discovered. +</para> +</refsect2> +<refsect2><title>The "<literal>farstream-local-candidates-prepared</literal>" message</title> +|[ +"stream" #FsStream The stream that emits the message +]| +<para> +This signal is emitted when all local candidates have been +prepared, an ICE implementation would send its SDP offer or answer. +</para> +</refsect2> +<refsect2><title>The "<literal>farstream-new-active-candidate-pair</literal>" message</title> +|[ +"stream" #FsStream The stream that emits the message +"local-candidate" #FsCandidate Local candidate being used +"remote-candidate" #FsCandidate Remote candidate being used +]| +<para> +This message is emitted when there is a new active candidate pair that has +been established. This is specially useful for ICE where the active +candidate pair can change automatically due to network conditions. The user +must not modify the candidates and must copy them if he wants to use them +outside the callback scope. This message is emitted once per component. +</para> +</refsect2> +<refsect2><title>The "<literal>farstream-recv-codecs-changed</literal>" message</title> +|[ +"stream" #FsStream The stream that emits the message +"codecs" #FsCodecGList A #GList of #FsCodec +]| +<para> +This message is emitted when the content of the +#FsStream:current-recv-codecs property changes. It is normally emitted +right after the #FsStream::src-pad-added signal only if that codec was not +previously received in this stream, but it can also be emitted if the pad +already exists, but the source material that will come to it is different. +The list of new recv-codecs is included in the message +</para> +</refsect2> +<refsect2><title>The "<literal>farstream-component-state-changed</literal>" message</title> +|[ +"stream" #FsStream The stream that emits the message +"component" #guint The component whose state changed +"state" #FsStreamState The new state of the component +]| +<para> +This message is emitted the state of a component of a stream changes. +</para> +</refsect2> + + + This object is the base implementation of a Farstream Stream Transmitter. +It needs to be derived and implement by a Farstream transmitter. +A Farstream Stream transmitter is used to convery per-stream information +to a transmitter, this is mostly local and remote candidates + + + This object is the base implementation of a Farstream Transmitter. +It needs to be derived and implement by a Farstream transmitter. A +Farstream Transmitter provides a GStreamer network sink and source to be used +for the Farstream Session. It creates #FsStreamTransmitter objects which are +used to set the different per-stream properties + - Gives a user-printable string representing the media type + Gives a user-printable string representing the media type + - a static string representing the media type + a static string representing the media type - A media type + A media type - Parses a "farstream-farstream" message and checks if it matches + Parses a "farstream-farstream" message and checks if it matches the @object parameters. + - %TRUE if the message matches the object and is valid. + %TRUE if the message matches the object and is valid. - a #GObject to match against the message + a #GObject to match against the message - a #GstMessage to parse + a #GstMessage to parse - Returns the #FsError error number in + Returns the #FsError error number in the message if not %NULL. @@ -4642,7 +7195,9 @@ the message if not %NULL. direction="out" caller-allocates="0" transfer-ownership="none"> - Returns the error message if not %NULL + Returns the error message if not %NULL @@ -4650,9 +7205,14 @@ the message if not %NULL. - Does a deep copy of a #GList of #FsRtpHeaderExtension + Does a deep copy of a #GList of #FsRtpHeaderExtension + - a new + a new #GList of #FsRtpHeaderExtension @@ -4660,7 +7220,9 @@ the message if not %NULL. - + a #GList of #FsRtpHeaderExtension @@ -4672,13 +7234,18 @@ the message if not %NULL. c:identifier="fs_rtp_header_extension_list_destroy" moved-to="RtpHeaderExtensionGList.destroy" introspectable="0"> - Frees the passed #GList of #FsRtpHeaderExtension + Frees the passed #GList of #FsRtpHeaderExtension + - a #GList of #FsRtpHeaderExtension + a #GList of #FsRtpHeaderExtension @@ -4689,7 +7256,9 @@ the message if not %NULL. c:identifier="fs_rtp_header_extension_list_from_keyfile" moved-to="RtpHeaderExtensionGList.from_keyfile" throws="1"> - Reads the content of a #GKeyFile of the following format into a + Reads the content of a #GKeyFile of the following format into a #GList of #FsRtpHeaderExtension structures. The groups have a format "rtp-hdrext:audio:XXX" or @@ -4715,8 +7284,11 @@ id=3 uri=urn:ietf:params:rtp-hdrext:ntp-64 direction=receive ]| + - a + a #GList of #FsRtpHeaderExtension that must be freed with fs_rtp_header_extension_list_destroy() @@ -4725,22 +7297,31 @@ fs_rtp_header_extension_list_destroy() - Name of the #GKeyFile to read the RTP Header Extensions from + Name of the #GKeyFile to read the RTP Header Extensions from - The media type for which to get header extensions + The media type for which to get header extensions - These default codec preferences should work with the elements that are + These default codec preferences should work with the elements that are available in the main GStreamer element repositories. They should be suitable for standards based protocols like SIP or XMPP. + - + The default codec preferences for this plugin. This #GList should be freed with fs_codec_list_destroy() @@ -4749,7 +7330,9 @@ This #GList should be freed with fs_codec_list_destroy() - Element for which to fetch default codec preferences + Element for which to fetch default codec preferences @@ -4757,29 +7340,41 @@ This #GList should be freed with fs_codec_list_destroy() - This function produces a #GKeyFile that can be fed to + This function produces a #GKeyFile that can be fed to fs_element_added_notifier_set_properties_from_keyfile(). If no default properties have been found, it will return %NULL. + - a #GKeyFile containing the default element + a #GKeyFile containing the default element properties for this element or %NULL if no properties were found. Caller must free the #GKeyFile when he is done. - Element for which to fetch default element properties + Element for which to fetch default element properties - These default rtp header extension preferences should work with the elements + These default rtp header extension preferences should work with the elements that are available in the main GStreamer element repositories. They should be suitable for standards based protocols like SIP or XMPP. + - The default rtp + The default rtp header extension preferences for this plugin, this #GList should be freed with fs_codec_list_destroy() @@ -4788,53 +7383,71 @@ freed with fs_codec_list_destroy() - Element for which to fetch default RTP Header Extension preferences + Element for which to fetch default RTP Header Extension preferences - The #FsMediaType for which to get default RTP Header Extension + The #FsMediaType for which to get default RTP Header Extension preferences - This allows setting the bitrate on all elements that have a "bitrate" + This allows setting the bitrate on all elements that have a "bitrate" property without having to know the type or of the unit used by that element. This will be obsolete in 0.11 (when all elements use bit/sec for the "bitrate" property. + - The #GstElement + The #GstElement - The bitrate in bits/sec + The bitrate in bits/sec - This is for the bindings benefit. Works around the limitations of GObject + This is for the bindings benefit. Works around the limitations of GObject introspection. + - a #GValue of type #FS_TYPE_CANDIDATE_LIST + a #GValue of type #FS_TYPE_CANDIDATE_LIST - A #GList of #FsCandidate + A #GList of #FsCandidate diff --git a/girs/FcitxG-1.0.gir b/girs/FcitxG-1.0.gir index 1ea9b9b9c..614c10a00 100644 --- a/girs/FcitxG-1.0.gir +++ b/girs/FcitxG-1.0.gir @@ -37,12 +37,12 @@ and/or use gtk-doc annotations. --> New a #FcitxGClient + line="1094">New a #FcitxGClient A newly allocated #FcitxGClient + line="1099">A newly allocated #FcitxGClient @@ -50,19 +50,19 @@ and/or use gtk-doc annotations. --> c:identifier="fcitx_g_client_new_with_watcher"> New a #FcitxGClient + line="1106">New a #FcitxGClient A newly allocated #FcitxGClient + line="1112">A newly allocated #FcitxGClient the FcitxGWatcher to be used with this client + line="1108">the FcitxGWatcher to be used with this client @@ -70,7 +70,7 @@ and/or use gtk-doc annotations. --> tell fcitx current client has focus + line="445">tell fcitx current client has focus @@ -79,7 +79,7 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="447">A #FcitxGClient @@ -87,7 +87,7 @@ and/or use gtk-doc annotations. --> tell fcitx current client has lost focus + line="457">tell fcitx current client has lost focus @@ -96,7 +96,7 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="459">A #FcitxGClient @@ -106,14 +106,14 @@ and/or use gtk-doc annotations. --> the current uuid of input context. + line="439">the current uuid of input context. a #FcitxGWatcher + line="437">a #FcitxGWatcher @@ -121,19 +121,19 @@ and/or use gtk-doc annotations. --> Check #FcitxGClient is valid to communicate with Fcitx + line="1155">Check #FcitxGClient is valid to communicate with Fcitx #FcitxGClient is valid or not + line="1161">#FcitxGClient is valid or not A #FcitxGClient + line="1157">A #FcitxGClient @@ -160,10 +160,13 @@ and/or use gtk-doc annotations. --> - + use this function with #fcitx_g_client_process_key_finish + line="665">use this function with #fcitx_g_client_process_key_finish @@ -172,43 +175,43 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="667">A #FcitxGClient key value + line="668">key value hardware key code + line="669">hardware key code key state + line="670">key state event type is key release + line="671">event type is key release timestamp + line="672">timestamp timeout in millisecond + line="673">timeout in millisecond allow-none="1"> cancellable + line="674">cancellable closure="8"> callback + line="675">callback allow-none="1"> user data + line="676">user data @@ -246,76 +249,77 @@ and/or use gtk-doc annotations. --> c:identifier="fcitx_g_client_process_key_finish"> use this function with #fcitx_g_client_process_key_async + line="630">use this function with #fcitx_g_client_process_key_async process key result + line="637">process key result A #FcitxGClient + line="632">A #FcitxGClient result + line="633">result + c:identifier="fcitx_g_client_process_key_sync" + glib:async-func="process_key"> send a key event to fcitx synchronizely + line="701">send a key event to fcitx synchronizely the key is processed or not + line="712">the key is processed or not A #FcitxGClient + line="703">A #FcitxGClient key value + line="704">key value hardware key code + line="705">hardware key code key state + line="706">key state is key release + line="707">is key release timestamp + line="708">timestamp @@ -323,7 +327,7 @@ and/or use gtk-doc annotations. --> tell fcitx current client is reset from client side + line="469">tell fcitx current client is reset from client side @@ -332,7 +336,7 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="471">A #FcitxGClient @@ -341,7 +345,7 @@ and/or use gtk-doc annotations. --> c:identifier="fcitx_g_client_select_candidate"> tell fcitx current client to select candidate. + line="559">tell fcitx current client to select candidate. @@ -350,13 +354,13 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="561">A #FcitxGClient Candidate index + line="562">Candidate index @@ -365,7 +369,7 @@ and/or use gtk-doc annotations. --> c:identifier="fcitx_g_client_set_capability"> set client capability of input context. + line="481">set client capability of input context. @@ -374,13 +378,13 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="483">A #FcitxGClient capability + line="484">capability @@ -389,7 +393,7 @@ and/or use gtk-doc annotations. --> c:identifier="fcitx_g_client_set_cursor_rect"> tell fcitx current client's cursor geometry info + line="495">tell fcitx current client's cursor geometry info @@ -398,31 +402,31 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="497">A #FcitxGClient x of cursor + line="498">x of cursor y of cursor + line="499">y of cursor width of cursor + line="500">width of cursor height of cursor + line="501">height of cursor @@ -431,7 +435,7 @@ and/or use gtk-doc annotations. --> c:identifier="fcitx_g_client_set_cursor_rect_with_scale_factor"> tell fcitx current client's cursor geometry info + line="514">tell fcitx current client's cursor geometry info @@ -440,37 +444,37 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="516">A #FcitxGClient x of cursor + line="517">x of cursor y of cursor + line="518">y of cursor width of cursor + line="519">width of cursor height of cursor + line="520">height of cursor scale factor of surface + line="521">scale factor of surface @@ -478,7 +482,7 @@ and/or use gtk-doc annotations. --> Set the display name + line="1119">Set the display name @@ -487,13 +491,13 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="1121">A #FcitxGClient display name + line="1122">display name @@ -501,7 +505,7 @@ and/or use gtk-doc annotations. --> Set the program name + line="1131">Set the program name @@ -510,13 +514,13 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="1133">A #FcitxGClient program name + line="1134">program name @@ -531,7 +535,7 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="575">A #FcitxGClient allow-none="1"> surroundng text + line="576">surroundng text cursor position coresponding to text + line="577">cursor position coresponding to text anchor position coresponding to text + line="578">anchor position coresponding to text @@ -561,7 +565,7 @@ and/or use gtk-doc annotations. --> c:identifier="fcitx_g_client_set_use_batch_process_key_event"> Set whether use ProcessKeyEventBatch if supports, default is true. + line="1143">Set whether use ProcessKeyEventBatch if supports, default is true. @@ -570,13 +574,13 @@ and/or use gtk-doc annotations. --> A #FcitxGClient + line="1145">A #FcitxGClient whether use ProcessKeyEventBatch + line="1146">whether use ProcessKeyEventBatch diff --git a/girs/FolksEds-0.7.gir b/girs/FolksEds-0.7.gir index e339099a6..efb9dc550 100644 --- a/girs/FolksEds-0.7.gir +++ b/girs/FolksEds-0.7.gir @@ -1,5 +1,5 @@ - + diff --git a/girs/FolksTelepathy-0.7.gir b/girs/FolksTelepathy-0.7.gir index a9db91c96..29f7e1db9 100644 --- a/girs/FolksTelepathy-0.7.gir +++ b/girs/FolksTelepathy-0.7.gir @@ -1,5 +1,5 @@ - + diff --git a/girs/GCalc-2.gir b/girs/GCalc-2.gir index 724d00843..f8be30431 100644 --- a/girs/GCalc-2.gir +++ b/girs/GCalc-2.gir @@ -1,5 +1,5 @@ - + diff --git a/girs/GES-1.0.gir b/girs/GES-1.0.gir index 14650fd47..84eb97407 100644 --- a/girs/GES-1.0.gir +++ b/girs/GES-1.0.gir @@ -134,7 +134,7 @@ them with ges_asset_unproxy(). Indicate that an existing #GESAsset in the cache should be reloaded + line="1495">Indicate that an existing #GESAsset in the cache should be reloaded upon the next request. This can be used when some condition has changed, which may require that an existing asset should be updated. For example, if an external resource has changed or now become @@ -147,7 +147,7 @@ ges_asset_request_async(). %TRUE if the specified asset exists in the cache and could be + line="1512">%TRUE if the specified asset exists in the cache and could be marked for reloading. @@ -155,7 +155,7 @@ marked for reloading. The #GESAsset:extractable-type of the asset that + line="1497">The #GESAsset:extractable-type of the asset that needs reloading @@ -165,16 +165,19 @@ needs reloading allow-none="1"> The #GESAsset:id of the asset asset that needs + line="1499">The #GESAsset:id of the asset asset that needs reloading - + Returns an asset with the given properties. If such an asset already + line="1201">Returns an asset with the given properties. If such an asset already exists in the cache (it has been previously created in GES), then a reference to the existing asset is returned. Otherwise, a newly created asset is returned, and also added to the cache. @@ -210,7 +213,7 @@ want to wait for the request to finish. A reference to the requested + line="1241">A reference to the requested asset, or %NULL if an error occurred. @@ -218,7 +221,7 @@ asset, or %NULL if an error occurred. The #GESAsset:extractable-type of the asset + line="1203">The #GESAsset:extractable-type of the asset allow-none="1"> The #GESAsset:id of the asset + line="1204">The #GESAsset:id of the asset - + Requests an asset with the given properties asynchronously (see + line="1344">Requests an asset with the given properties asynchronously (see ges_asset_request()). When the asset has been initialized or fetched from the cache, the given callback function will be called. The asset can then be retrieved in the callback using the @@ -286,7 +292,7 @@ ges_asset_request_async (GES_TYPE_URI_CLIP, some_uri, NULL, The #GESAsset:extractable-type of the asset + line="1346">The #GESAsset:extractable-type of the asset The #GESAsset:id of the asset + line="1347">The #GESAsset:id of the asset An object to allow cancellation of the + line="1348">An object to allow cancellation of the asset request, or %NULL to ignore @@ -316,7 +322,7 @@ asset request, or %NULL to ignore closure="4"> A function to call when the initialization is finished + line="1350">A function to call when the initialization is finished allow-none="1"> Data to be passed to @callback + line="1351">Data to be passed to @callback @@ -335,13 +341,13 @@ asset request, or %NULL to ignore throws="1"> Fetches an asset requested by ges_asset_request_async(), which + line="1600">Fetches an asset requested by ges_asset_request_async(), which finalises the request. The requested asset, or %NULL if an error + line="1608">The requested asset, or %NULL if an error occurred. @@ -349,7 +355,7 @@ occurred. The task result to fetch the asset from + line="1602">The task result to fetch the asset from @@ -357,14 +363,14 @@ occurred. Extracts a new #GESAsset:extractable-type object from the asset. The + line="1566">Extracts a new #GESAsset:extractable-type object from the asset. The #GESAsset:id of the asset may determine the properties and state of the newly created object. A newly created object, or %NULL if an + line="1576">A newly created object, or %NULL if an error occurred. @@ -372,7 +378,7 @@ error occurred. The #GESAsset to extract an object from + line="1568">The #GESAsset to extract an object from @@ -392,6 +398,9 @@ error occurred. + Deprecated: 1.18: This vmethod is no longer called. @@ -406,6 +415,12 @@ error occurred. + A method called by a #GESProject when an asset has +failed to load. @error is the error given by +ges_asset_request_finish (). Returns: %TRUE if a new id for @self was +passed to @proposed_new_id. @@ -423,6 +438,15 @@ error occurred. + A method to be called when an asset is being requested +asynchronously. This will be after the properties of the asset have +been set, so it is tasked with (re)loading the 'state' of the asset. +The return value should indicated whether the loading is complete, is +carrying on asynchronously, or an error occurred. The default +implementation will simply return that loading is already complete (the +asset is already in a usable state after the properties have been set). @@ -436,14 +460,14 @@ error occurred. Extracts a new #GESAsset:extractable-type object from the asset. The + line="1566">Extracts a new #GESAsset:extractable-type object from the asset. The #GESAsset:id of the asset may determine the properties and state of the newly created object. A newly created object, or %NULL if an + line="1576">A newly created object, or %NULL if an error occurred. @@ -451,7 +475,7 @@ error occurred. The #GESAsset to extract an object from + line="1568">The #GESAsset to extract an object from @@ -461,12 +485,12 @@ error occurred. version="1.8"> Retrieve the error that was set on the asset when it was loaded. + line="1675">Retrieve the error that was set on the asset when it was loaded. The error set on @asset, or + line="1681">The error set on @asset, or %NULL if no error occurred when @asset was loaded. @@ -474,7 +498,7 @@ error occurred. A #GESAsset + line="1677">A #GESAsset @@ -484,19 +508,19 @@ error occurred. glib:get-property="extractable-type"> Gets the #GESAsset:extractable-type of the asset. + line="1185">Gets the #GESAsset:extractable-type of the asset. The extractable type of @self. + line="1191">The extractable type of @self. The #GESAsset + line="1187">The #GESAsset @@ -506,19 +530,19 @@ error occurred. glib:get-property="id"> Gets the #GESAsset:id of the asset. + line="1550">Gets the #GESAsset:id of the asset. The ID of @self. + line="1556">The ID of @self. A #GESAsset + line="1552">A #GESAsset @@ -528,19 +552,19 @@ error occurred. glib:get-property="proxy"> Gets the default #GESAsset:proxy of the asset. + line="1073">Gets the default #GESAsset:proxy of the asset. The default proxy of @asset. + line="1079">The default proxy of @asset. A #GESAsset + line="1075">A #GESAsset @@ -550,7 +574,7 @@ error occurred. glib:get-property="proxy-target"> Gets the #GESAsset:proxy-target of the asset. + line="1093">Gets the #GESAsset:proxy-target of the asset. Note that the proxy target may have loaded with an error, so you should call ges_asset_get_error() on the returned target. @@ -558,7 +582,7 @@ call ges_asset_get_error() on the returned target. The asset that @proxy is a proxy + line="1102">The asset that @proxy is a proxy of. @@ -566,7 +590,7 @@ of. A #GESAsset + line="1095">A #GESAsset @@ -574,14 +598,14 @@ of. Get all the proxies that the asset has. The first item of the list will + line="1054">Get all the proxies that the asset has. The first item of the list will be the default #GESAsset:proxy. The second will be the proxy that is 'next in line' to be default, and so on. The list of proxies + line="1062">The list of proxies that @asset has. @@ -591,7 +615,7 @@ that @asset has. A #GESAsset + line="1056">A #GESAsset @@ -601,7 +625,7 @@ that @asset has. glib:set-property="proxy"> Sets the #GESAsset:proxy for the asset. + line="903">Sets the #GESAsset:proxy for the asset. If @proxy is among the existing proxies of the asset (see ges_asset_list_proxies()) it will be moved to become the default @@ -619,7 +643,7 @@ remove **all** proxies from the asset. %TRUE if @proxy was successfully set as the default for + line="923">%TRUE if @proxy was successfully set as the default for @asset. @@ -627,7 +651,7 @@ remove **all** proxies from the asset. The #GESAsset to proxy + line="905">The #GESAsset to proxy allow-none="1"> A new default proxy for @asset + line="906">A new default proxy for @asset @@ -644,7 +668,7 @@ remove **all** proxies from the asset. Removes the proxy from the available list of proxies for the asset. If + line="1001">Removes the proxy from the available list of proxies for the asset. If the given proxy is the default proxy of the list, then the next proxy in the available list (see ges_asset_list_proxies()) will become the default. If there are no other proxies, then the asset will no longer @@ -653,7 +677,7 @@ have a default #GESAsset:proxy. %TRUE if @proxy was successfully removed from @asset's proxy + line="1012">%TRUE if @proxy was successfully removed from @asset's proxy list. @@ -661,13 +685,13 @@ list. The #GESAsset to no longer proxy with @proxy + line="1003">The #GESAsset to no longer proxy with @proxy An existing proxy of @asset + line="1004">An existing proxy of @asset @@ -679,7 +703,7 @@ list. getter="get_extractable_type"> The #GESExtractable object type that can be extracted from the asset. + line="488">The #GESExtractable object type that can be extracted from the asset. default-value="NULL"> The ID of the asset. This should be unique amongst all assets with + line="498">The ID of the asset. This should be unique amongst all assets with the same #GESAsset:extractable-type. Depending on the associated #GESExtractable implementation, this id may convey some information about the #GObject that should be extracted. Note that, as such, the @@ -708,7 +732,7 @@ default behaviour. getter="get_proxy"> The default proxy for this asset, or %NULL if it has no proxy. A + line="516">The default proxy for this asset, or %NULL if it has no proxy. A proxy will act as a substitute for the original asset when the original is requested (see ges_asset_request()). @@ -721,7 +745,7 @@ will replace it as the default (see ges_asset_set_proxy()). getter="get_proxy_target"> The asset that this asset is a proxy for, or %NULL if it is not a + line="530">The asset that this asset is a proxy for, or %NULL if it is not a proxy for another asset. Note that even if this asset is acting as a proxy for another asset, @@ -755,6 +779,15 @@ asset it is now the proxy of/no longer the proxy of. + A method to be called when an asset is being requested +asynchronously. This will be after the properties of the asset have +been set, so it is tasked with (re)loading the 'state' of the asset. +The return value should indicated whether the loading is complete, is +carrying on asynchronously, or an error occurred. The default +implementation will simply return that loading is already complete (the +asset is already in a usable state after the properties have been set). @@ -768,12 +801,19 @@ asset it is now the proxy of/no longer the proxy of. + A method that returns a new object of the asset's +#GESAsset:extractable-type, or %NULL if an error occurs. The default +implementation will fetch the properties of the #GESExtractable from +its get_parameters_from_id() class method and set them on a new +#GESAsset:extractable-type #GObject, which is returned. A newly created object, or %NULL if an + line="1576">A newly created object, or %NULL if an error occurred. @@ -781,7 +821,7 @@ error occurred. The #GESAsset to extract an object from + line="1568">The #GESAsset to extract an object from @@ -804,6 +844,9 @@ error occurred. + Deprecated: 1.18: This vmethod is no longer called. @@ -820,6 +863,12 @@ error occurred. + A method called by a #GESProject when an asset has +failed to load. @error is the error given by +ges_asset_request_finish (). Returns: %TRUE if a new id for @self was +passed to @proposed_new_id. @@ -1963,7 +2012,7 @@ do_time_effect_change (GESClip * clip) children = ges_container_get_children (GES_CONTAINER (clip), FALSE); for (tmp = children; tmp; tmp = tmp->next) - ges_track_element_set_auto_clamp_control_source (tmp->data, FALSE); + ges_track_element_set_auto_clamp_control_sources (tmp->data, FALSE); // add time effect, or set their children properties, or move them around ... @@ -1984,7 +2033,7 @@ do_time_effect_change (GESClip * clip) // handle error for (tmp = children; tmp; tmp = tmp->next) - ges_track_element_set_auto_clamp_control_source (tmp->data, TRUE); + ges_track_element_set_auto_clamp_control_sources (tmp->data, TRUE); g_list_free_full (children, gst_object_unref); gst_object_unref (source); @@ -1994,6 +2043,14 @@ do_time_effect_change (GESClip * clip) + Method to create the core #GESTrackElement of a clip +of this class. If a clip of this class may create several track elements per +track type, this should be left as %NULL, and +GESClipClass::create_track_elements should be used instead. Otherwise, you +should implement this class method and leave +GESClipClass::create_track_elements as the default implementation + Method to create the (multiple) core +#GESTrackElement-s of a clip of this class. If +GESClipClass::create_track_element is implemented, this should be kept as the +default implementation Extracts a #GESTrackElement from an asset and adds it to the clip. + line="3632">Extracts a #GESTrackElement from an asset and adds it to the clip. This can be used to add effects that derive from the asset to the clip, but this method is not intended to be used to create the core elements of the clip. @@ -2056,7 +2119,7 @@ elements of the clip. The newly created element, or + line="3643">The newly created element, or %NULL if an error occurred. @@ -2064,13 +2127,13 @@ elements of the clip. A #GESClip + line="3634">A #GESClip An asset with #GES_TYPE_TRACK_ELEMENT as its + line="3635">An asset with #GES_TYPE_TRACK_ELEMENT as its #GESAsset:extractable-type @@ -2082,7 +2145,7 @@ elements of the clip. throws="1"> Adds the track element child of the clip to a specific track. + line="4435">Adds the track element child of the clip to a specific track. If the given child is already in another track, this will create a copy of the child, add it to the clip, and add this copy to the track. @@ -2108,7 +2171,7 @@ a source to completely overlap another in the same track. The element that was added to @track, either + line="4465">The element that was added to @track, either @child or a copy of child, or %NULL if the element could not be added. @@ -2116,19 +2179,19 @@ a source to completely overlap another in the same track. A #GESClip + line="4437">A #GESClip A child of @clip + line="4438">A child of @clip The track to add @child to + line="4439">The track to add @child to @@ -2139,7 +2202,7 @@ a source to completely overlap another in the same track. throws="1"> Add a top effect to a clip at the given index. + line="3033">Add a top effect to a clip at the given index. Unlike using ges_container_add(), this allows you to set the index in advance. It will also check that no error occurred during the track @@ -2155,26 +2218,27 @@ would not be able to adapt itself once the effect is added. %TRUE if @effect was successfully added to @clip at @index. + line="3054">%TRUE if @effect was successfully added to @clip at @index. A #GESClip + line="3035">A #GESClip A top effect to add + line="3036">A top effect to add The index to add @effect at, or -1 to add at the highest + line="3037">The index to add @effect at, or -1 to add at the highest, + see #ges_clip_get_top_effect_index for more information @@ -2183,7 +2247,7 @@ would not be able to adapt itself once the effect is added. c:identifier="ges_clip_find_track_element"> Finds an element controlled by the clip. If @track is given, + line="2935">Finds an element controlled by the clip. If @track is given, then only the track elements in @track are searched for. If @type is given, then this function searches for a track element of the given @type. @@ -2196,7 +2260,7 @@ ges_clip_find_track_elements() if you wish to find all such elements. The element controlled by + line="2953">The element controlled by @clip, in @track, and of the given @type, or %NULL if no such element could be found. @@ -2205,7 +2269,7 @@ could be found. A #GESClip + line="2937">A #GESClip allow-none="1"> The track to search in, or %NULL to search in + line="2938">The track to search in, or %NULL to search in all tracks The type of track element to search for, or `G_TYPE_NONE` to + line="2940">The type of track element to search for, or `G_TYPE_NONE` to match any type @@ -2231,7 +2295,7 @@ match any type c:identifier="ges_clip_find_track_elements"> Finds the #GESTrackElement-s controlled by the clip that match the + line="3666">Finds the #GESTrackElement-s controlled by the clip that match the given criteria. If @track is given as %NULL and @track_type is given as #GES_TRACK_TYPE_UNKNOWN, then the search will match all elements in any track, including those with no track, and of any @@ -2253,7 +2317,7 @@ elements of the given @type. A list of all + line="3695">A list of all the #GESTrackElement-s controlled by @clip, in @track or of the given @track_type, and of the given @type. @@ -2264,7 +2328,7 @@ the #GESTrackElement-s controlled by @clip, in @track or of the given A #GESClip + line="3668">A #GESClip The track to search in, or %NULL to search in + line="3669">The track to search in, or %NULL to search in all tracks The track-type of the track element to search for, or + line="3671">The track-type of the track element to search for, or #GES_TRACK_TYPE_UNKNOWN to match any track type The type of track element to search for, or %G_TYPE_NONE to + line="3673">The type of track element to search for, or %G_TYPE_NONE to match any type @@ -2299,19 +2363,19 @@ match any type version="1.18"> Gets the #GESClip:duration-limit of the clip. + line="3005">Gets the #GESClip:duration-limit of the clip. The duration-limit of @clip. + line="3011">The duration-limit of @clip. A #GESClip + line="3007">A #GESClip @@ -2322,7 +2386,7 @@ match any type throws="1"> Convert the timeline time to an internal source time of the child. + line="4148">Convert the timeline time to an internal source time of the child. This will take any time effects placed on the clip into account (see #GESBaseEffect for what time effects are supported, and how to declare them in GES). @@ -2363,7 +2427,7 @@ reverse. The time in the internal coordinates of @child corresponding + line="4194">The time in the internal coordinates of @child corresponding to @timeline_time, or #GST_CLOCK_TIME_NONE if the conversion could not be performed. @@ -2372,20 +2436,20 @@ be performed. A #GESClip + line="4150">A #GESClip An #GESTrackElement:active child of @clip with a + line="4151">An #GESTrackElement:active child of @clip with a #GESTrackElement:track A time in the timeline time coordinates + line="4153">A time in the timeline time coordinates @@ -2395,12 +2459,12 @@ be performed. glib:get-property="layer"> Gets the #GESClip:layer of the clip. + line="2985">Gets the #GESClip:layer of the clip. The layer @clip is in, or %NULL if + line="2991">The layer @clip is in, or %NULL if @clip is not in any layer. @@ -2408,7 +2472,7 @@ be performed. A #GESClip + line="2987">A #GESClip @@ -2418,19 +2482,19 @@ be performed. glib:get-property="supported-formats"> Gets the #GESClip:supported-formats of the clip. + line="3616">Gets the #GESClip:supported-formats of the clip. The #GESTrackType-s supported by @clip. + line="3622">The #GESTrackType-s supported by @clip. A #GESClip + line="3618">A #GESClip @@ -2441,7 +2505,7 @@ be performed. throws="1"> Convert the internal source time from the child to a timeline time. + line="3995">Convert the internal source time from the child to a timeline time. This will take any time effects placed on the clip into account (see #GESBaseEffect for what time effects are supported, and how to declare them in GES). @@ -2488,7 +2552,7 @@ the same conversion, but using frame numbers. The time in the timeline coordinates corresponding to + line="4047">The time in the timeline coordinates corresponding to @internal_time, or #GST_CLOCK_TIME_NONE if the conversion could not be performed. @@ -2497,20 +2561,20 @@ performed. A #GESClip + line="3997">A #GESClip An #GESTrackElement:active child of @clip with a + line="3998">An #GESTrackElement:active child of @clip with a #GESTrackElement:track A time in the internal time coordinates of @child + line="4000">A time in the internal time coordinates of @child @@ -2521,7 +2585,7 @@ performed. throws="1"> Convert the source frame number to a timeline time. This acts the same + line="4381">Convert the source frame number to a timeline time. This acts the same as ges_clip_get_timeline_time_from_internal_time() using the core children of the clip and using the frame number to specify the internal position, rather than a timestamp. @@ -2535,7 +2599,7 @@ with ges_clip_asset_get_frame_time(). The timestamp corresponding to @frame_number in the core + line="4399">The timestamp corresponding to @frame_number in the core children of @clip, in the timeline coordinates, or #GST_CLOCK_TIME_NONE if the conversion could not be performed. @@ -2544,13 +2608,13 @@ if the conversion could not be performed. A #GESClip + line="4383">A #GESClip The frame number to get the corresponding timestamp of + line="4384">The frame number to get the corresponding timestamp of in the timeline coordinates @@ -2560,7 +2624,7 @@ in the timeline coordinates c:identifier="ges_clip_get_top_effect_index"> Gets the internal index of an effect in the clip. The index of effects + line="3204">Gets the internal index of an effect in the clip. The index of effects in a clip will run from 0 to n-1, where n is the total number of effects. If two effects share the same #GESTrackElement:track, the effect with the numerically lower index will be applied to the source @@ -2570,20 +2634,20 @@ a higher index effect to a lower index effect. The index of @effect in @clip, or -1 if something went wrong. + line="3216">The index of @effect in @clip, or -1 if something went wrong. A #GESClip + line="3206">A #GESClip The effect we want to get the index of + line="3207">The effect we want to get the index of @@ -2606,14 +2670,14 @@ a higher index effect to a lower index effect. Gets the #GESBaseEffect-s that have been added to the clip. The + line="3173">Gets the #GESBaseEffect-s that have been added to the clip. The returned list is ordered by their internal index in the clip. See ges_clip_get_top_effect_index(). A list of all + line="3181">A list of all #GESBaseEffect-s that have been added to @clip. @@ -2623,7 +2687,7 @@ ges_clip_get_top_effect_index(). A #GESClip + line="3175">A #GESClip @@ -2631,25 +2695,25 @@ ges_clip_get_top_effect_index(). See ges_clip_move_to_layer_full(), which also gives an error. + line="2920">See ges_clip_move_to_layer_full(), which also gives an error. %TRUE if @clip was successfully moved to @layer. + line="2927">%TRUE if @clip was successfully moved to @layer. A #GESClip + line="2922">A #GESClip The new layer + line="2923">The new layer @@ -2660,27 +2724,27 @@ ges_clip_get_top_effect_index(). throws="1"> Moves a clip to a new layer. If the clip already exists in a layer, it + line="2836">Moves a clip to a new layer. If the clip already exists in a layer, it is first removed from its current layer before being added to the new layer. %TRUE if @clip was successfully moved to @layer. + line="2846">%TRUE if @clip was successfully moved to @layer. A #GESClip + line="2838">A #GESClip The new layer + line="2839">The new layer @@ -2691,7 +2755,7 @@ layer. throws="1"> Remove a top effect from the clip. + line="3138">Remove a top effect from the clip. Note, if the effect is a time effect, this may be refused if the clip would not be able to adapt itself once the effect is removed. @@ -2699,20 +2763,20 @@ would not be able to adapt itself once the effect is removed. %TRUE if @effect was successfully added to @clip at @index. + line="3149">%TRUE if @effect was successfully added to @clip at @index. A #GESClip + line="3140">A #GESClip The top effect to remove + line="3141">The top effect to remove @@ -2722,7 +2786,7 @@ would not be able to adapt itself once the effect is removed. glib:set-property="supported-formats"> Sets the #GESClip:supported-formats of the clip. This should normally + line="3599">Sets the #GESClip:supported-formats of the clip. This should normally only be called by subclasses, which should be responsible for updating its value, rather than the user. @@ -2733,13 +2797,13 @@ its value, rather than the user. A #GESClip + line="3601">A #GESClip The #GESTrackType-s supported by @clip + line="3602">The #GESTrackType-s supported by @clip @@ -2748,31 +2812,31 @@ its value, rather than the user. c:identifier="ges_clip_set_top_effect_index"> See ges_clip_set_top_effect_index_full(), which also gives an error. + line="3358">See ges_clip_set_top_effect_index_full(), which also gives an error. %TRUE if @effect was successfully moved to @newindex. + line="3366">%TRUE if @effect was successfully moved to @newindex. A #GESClip + line="3360">A #GESClip An effect within @clip to move + line="3361">An effect within @clip to move The index for @effect in @clip + line="3362">The index for @effect in @clip @@ -2783,7 +2847,7 @@ its value, rather than the user. throws="1"> Set the index of an effect within the clip. See + line="3251">Set the index of an effect within the clip. See ges_clip_get_top_effect_index(). The new index must be an existing index of the clip. The effect is moved to the new index, and the other effects may be shifted in index accordingly to otherwise maintain the @@ -2792,26 +2856,26 @@ ordering. %TRUE if @effect was successfully moved to @newindex. + line="3264">%TRUE if @effect was successfully moved to @newindex. A #GESClip + line="3253">A #GESClip An effect within @clip to move + line="3254">An effect within @clip to move The index for @effect in @clip + line="3255">The index for @effect in @clip @@ -2837,12 +2901,12 @@ ordering. See ges_clip_split_full(), which also gives an error. + line="3583">See ges_clip_split_full(), which also gives an error. The newly created clip resulting + line="3590">The newly created clip resulting from the splitting @clip, or %NULL if @clip can't be split. @@ -2850,13 +2914,13 @@ from the splitting @clip, or %NULL if @clip can't be split. The #GESClip to split + line="3585">The #GESClip to split The timeline position at which to perform the split + line="3586">The timeline position at which to perform the split @@ -2867,7 +2931,7 @@ from the splitting @clip, or %NULL if @clip can't be split. throws="1"> Splits a clip at the given timeline position into two clips. The clip + line="3375">Splits a clip at the given timeline position into two clips. The clip must already have a #GESClip:layer. The original clip's #GESTimelineElement:duration is reduced such that @@ -2898,7 +2962,7 @@ but at a different #GESTimelineElement:in-point. The newly created clip resulting + line="3410">The newly created clip resulting from the splitting @clip, or %NULL if @clip can't be split. @@ -2906,13 +2970,13 @@ from the splitting @clip, or %NULL if @clip can't be split. The #GESClip to split + line="3377">The #GESClip to split The timeline position at which to perform the split, between + line="3378">The timeline position at which to perform the split, between the start and end of the clip @@ -2925,7 +2989,7 @@ the start and end of the clip default-value="18446744073709551615"> The maximum #GESTimelineElement:duration that can be *currently* set + line="2610">The maximum #GESTimelineElement:duration that can be *currently* set for the clip, taking into account the #GESTimelineElement:in-point, #GESTimelineElement:max-duration, #GESTrackElement:active, and #GESTrackElement:track properties of its children, as well as any @@ -2944,7 +3008,7 @@ limit. The layer this clip lies in. + line="2595">The layer this clip lies in. If you want to connect to this property's #GObject::notify signal, you should connect to it with g_signal_connect_after() since the @@ -2960,7 +3024,7 @@ signal emission may be stopped internally. default-value="GES_TRACK_TYPE_AUDIO | GES_TRACK_TYPE_VIDEO"> The #GESTrackType-s that the clip supports, which it can create + line="2579">The #GESTrackType-s that the clip supports, which it can create #GESTrackElement-s for. Note that this can be a combination of #GESTrackType flags to indicate support for several #GESTrackElement:track-type elements. @@ -3420,6 +3484,9 @@ The #GESContainer-s to group + Virtual method to add a child @@ -3434,6 +3501,9 @@ The #GESContainer-s to group + Virtual method that is called right after a #GESTimelineElement is added @@ -3448,6 +3518,9 @@ The #GESContainer-s to group + Virtual method that is called right after a #GESTimelineElement is removed @@ -3525,6 +3598,9 @@ be moved to. -1 means no move + Virtual method to remove a child @@ -3857,6 +3933,9 @@ may be stopped internally. + Virtual method that is called right after a #GESTimelineElement is added @@ -3873,6 +3952,9 @@ may be stopped internally. + Virtual method that is called right after a #GESTimelineElement is removed @@ -3889,6 +3971,9 @@ may be stopped internally. + Virtual method to add a child @@ -3905,6 +3990,9 @@ may be stopped internally. + Virtual method to remove a child @@ -3921,6 +4009,10 @@ may be stopped internally. + Virtual method to ungroup a container into a list of +containers @@ -3949,6 +4041,10 @@ new #GESContainer-s created from the splitting of @container. + Virtual method to group a list of containers together under a +single container @@ -3964,6 +4060,9 @@ new #GESContainer-s created from the splitting of @container. + Deprecated @@ -4163,7 +4262,7 @@ if no track elements are created or an error occurred. The default #GESDiscovererManager + line="248">The default #GESDiscovererManager @@ -4175,14 +4274,14 @@ if no track elements are created or an error occurred. The timeout to use for the discoverer + line="304">The timeout to use for the discoverer The #GESDiscovererManager + line="302">The #GESDiscovererManager @@ -4195,14 +4294,14 @@ if no track elements are created or an error occurred. Whether to use the cache or not + line="268">Whether to use the cache or not The #GESDiscovererManager + line="266">The #GESDiscovererManager @@ -4213,7 +4312,7 @@ if no track elements are created or an error occurred. version="1.24"> Sets the timeout to use for the discoverer + line="316">Sets the timeout to use for the discoverer @@ -4222,13 +4321,13 @@ if no track elements are created or an error occurred. The #GESDiscovererManager + line="318">The #GESDiscovererManager The timeout to set + line="319">The timeout to set @@ -4239,7 +4338,7 @@ if no track elements are created or an error occurred. version="1.24"> Sets whether to use the cache or not + line="281">Sets whether to use the cache or not @@ -4248,13 +4347,13 @@ if no track elements are created or an error occurred. The #GESDiscovererManager + line="283">The #GESDiscovererManager Whether to use the cache + line="284">Whether to use the cache @@ -4269,7 +4368,7 @@ if no track elements are created or an error occurred. default-value="60000000000"> The timeout (in milliseconds) for the #GstDiscoverer operations + line="155">The timeout (in milliseconds) for the #GstDiscoverer operations The #GstDiscovererInfo representing the discovered URI + line="225">The #GstDiscovererInfo representing the discovered URI allow-none="1"> The #GError that occurred, or %NULL + line="226">The #GError that occurred, or %NULL @@ -4307,13 +4406,13 @@ if no track elements are created or an error occurred. Retrieves information about a URI from and external source of information, + line="190">Retrieves information about a URI from and external source of information, like a cache file. This is used by the discoverer to speed up the discovery. The #GstDiscovererInfo representing + line="199">The #GstDiscovererInfo representing @uri, or %NULL if no information @@ -4321,11 +4420,27 @@ discovery. The URI to load the serialized info for + line="193">The URI to load the serialized info for + + Allows to setup the source element before the discoverer runs. + + + + + + The source #GstElement to setup + + + + glib:type-struct="EffectClass"> Currently we only support effects with N sinkpads and one single srcpad. -Apart from `gesaudiomixer` and `gescompositor` which can be used as effects -and where sinkpads will be requested as needed based on the timeline topology -GES will always request at most one sinkpad per effect (when required). + line="20">Any GStreamer filter can be used as effects in GES. The only restriction we +have is that effects element should have a single [sinkpad](GST_PAD_SINK) +(which will be requested if necessary) and a single [srcpad](GST_PAD_SRC). + +Note that `gesaudiomixer` and `gescompositor` can be used as effects even +though they can have several sinkpads. + +## GES specific effects: + +* **`gesvideoscale`**: GES implements a specific scaling bin that allows + specifying where scaling will happen inside the chain of effects. By + default scaling can happen either in the source (if the source doesn't have + a specific size, like `videotestsrc` or [mixing](ges_track_set_mixing) has + been disabled) or in the mixing element otherwise, when adding that element + as an effect, GES guarantees that the scaling will happen in it. This can + be useful for example if you want to crop the video before scaling or apply + rounding corners to the video after scaling, etc... > Note: GES always adds converters (`audioconvert ! audioresample ! > audioconvert` for audio effects and `videoconvert` for video effects) to @@ -4761,7 +4889,7 @@ GES will always request at most one sinkpad per effect (when required). Creates a new #GESEffect from the description of the bin. It should be + line="366">Creates a new #GESEffect from the description of the bin. It should be possible to determine the type of the effect through the element 'klass' metadata of the GstElements that will be created. In that corner case, you should use: @@ -4771,7 +4899,7 @@ and extract that asset to be in full control. a newly created #GESEffect, or %NULL if something went + line="377">a newly created #GESEffect, or %NULL if something went wrong. @@ -4779,7 +4907,7 @@ wrong. The gst-launch like bin description of the effect + line="368">The gst-launch like bin description of the effect @@ -4791,7 +4919,7 @@ wrong. default-value="NULL"> The description of the effect bin with a gst-launch-style + line="204">The description of the effect bin with a gst-launch-style pipeline description. Example: "videobalance saturation=1.5 hue=+0.5" @@ -4880,7 +5008,7 @@ to what track type the effect should be used in. c:identifier="ges_effect_class_register_rate_property"> Register an element that can change the rate at which media is playing. + line="404">Register an element that can change the rate at which media is playing. The property type must be float or double, and must be a factor of the rate, i.e. a value of 2.0 must mean that the media plays twice as fast. Several properties may be registered for a single element type, @@ -4909,7 +5037,7 @@ Note, you can obtain a reference to the GESEffectClass using %TRUE if the rate property was successfully registered. When + line="437">%TRUE if the rate property was successfully registered. When this method returns %FALSE, a warning is emitted with more information. @@ -4917,20 +5045,20 @@ this method returns %FALSE, a warning is emitted with more information. Instance of the GESEffectClass + line="406">Instance of the GESEffectClass The #GstElementFactory name of the element that changes + line="407">The #GstElementFactory name of the element that changes the rate The name of the property that changes the rate + line="409">The name of the property that changes the rate @@ -5175,6 +5303,13 @@ that is compatible with @self's current state. + This method is called after the #GESAsset of an object is +set. If your class supports the asset of an object changing, then you +can use this method to change the parameters of the object to match the +new asset #GESAsset:id. If setting the asset should be able to fail, +you should implement @set_asset_full instead. @@ -5189,6 +5324,11 @@ that is compatible with @self's current state. + Like @set_asset, but also allows you to return %FALSE +to indicate a failure to change the object in response to a change in +its asset. @@ -5358,6 +5498,13 @@ the new asset on the object. + This method is called after the #GESAsset of an object is +set. If your class supports the asset of an object changing, then you +can use this method to change the parameters of the object to match the +new asset #GESAsset:id. If setting the asset should be able to fail, +you should implement @set_asset_full instead. @@ -5374,6 +5521,11 @@ the new asset on the object. + Like @set_asset, but also allows you to return %FALSE +to indicate a failure to change the object in response to a change in +its asset. @@ -5390,6 +5542,13 @@ the new asset on the object. + The method to call to get the object +properties corresponding to a given asset #GESAsset:id. The default +implementation will simply return no parameters. The default #GESAsset +will call this to set the returned properties on the extracted object, +but other subclasses may ignore this method. @@ -5406,6 +5565,16 @@ the new asset on the object. + The method to fetch the #GESAsset:id of some associated asset. +Note that it may be the case that the object does not have its asset +set, or even that an asset with such an #GESAsset:id does not exist in +the GES cache. Instead, this should return the #GESAsset:id that is +_compatible_ with the current state of the object. The default +implementation simply returns the currently set asset ID, or the type name +of the object, which is what is used as the #GESAsset:id by default, +if no asset is set. @@ -5426,6 +5595,17 @@ that is compatible with @self's current state. + The method to call to get the actual +#GESAsset:extractable-type an asset should have set, given the +requested #GESAsset:id. The default implementation simply returns the +same type as given. You can overwrite this if it is more appropriate +to extract the object from a subclass, depending on the requested +#GESAsset:id. Note that when an asset is requested, this method will be +called before the other class methods. In particular, this means that +the @check_id and @get_parameters_from_id class methods of the returned +type will be used (instead of our own). @@ -5442,6 +5622,10 @@ that is compatible with @self's current state. + The method to set metadata on an asset. This is called +on initiation of the asset, but before it begins to load its state. @@ -5546,13 +5730,13 @@ using gst_bin_add(). throws="1"> Checks if there is a #GESFormatter available which can load a #GESTimeline + line="248">Checks if there is a #GESFormatter available which can load a #GESTimeline from the given URI. TRUE if there is a #GESFormatter that can support the given uri + line="256">TRUE if there is a #GESFormatter that can support the given uri or FALSE if not. @@ -5560,7 +5744,7 @@ or FALSE if not. a #gchar * pointing to the URI + line="250">a #gchar * pointing to the URI @@ -5570,20 +5754,20 @@ or FALSE if not. throws="1"> Returns TRUE if there is a #GESFormatter available which can save a + line="319">Returns TRUE if there is a #GESFormatter available which can save a #GESTimeline to the given URI. TRUE if the given @uri is supported, else FALSE. + line="327">TRUE if the given @uri is supported, else FALSE. a #gchar * pointing to a URI + line="321">a #gchar * pointing to a URI @@ -5591,17 +5775,20 @@ or FALSE if not. Get the default #GESAsset to use as formatter. It will return + line="473">Get the default #GESAsset to use as formatter. It will return the asset for the #GESFormatter that has the highest @rank The #GESAsset for the formatter with highest @rank + line="479">The #GESAsset for the formatter with highest @rank + Whether the URI can be loaded @@ -5622,13 +5809,13 @@ the asset for the #GESFormatter that has the highest @rank throws="1"> Load data from the given URI into timeline. + line="398">Load data from the given URI into timeline. Use @ges_timeline_load_from_uri TRUE if the timeline data was successfully loaded from the URI, + line="407">TRUE if the timeline data was successfully loaded from the URI, else FALSE. @@ -5636,19 +5823,19 @@ else FALSE. a #GESFormatter + line="400">a #GESFormatter a #GESTimeline + line="401">a #GESTimeline a #gchar * pointing to a URI + line="402">a #gchar * pointing to a URI @@ -5660,13 +5847,13 @@ else FALSE. throws="1"> Save data from timeline to the given URI. + line="431">Save data from timeline to the given URI. Use @ges_timeline_save_to_uri TRUE if the timeline data was successfully saved to the URI + line="441">TRUE if the timeline data was successfully saved to the URI else FALSE. @@ -5674,25 +5861,25 @@ else FALSE. a #GESFormatter + line="433">a #GESFormatter a #GESTimeline + line="434">a #GESTimeline a #gchar * pointing to a URI + line="435">a #gchar * pointing to a URI %TRUE to overwrite file if it exists + line="436">%TRUE to overwrite file if it exists @@ -5704,13 +5891,13 @@ else FALSE. throws="1"> Load data from the given URI into timeline. + line="398">Load data from the given URI into timeline. Use @ges_timeline_load_from_uri TRUE if the timeline data was successfully loaded from the URI, + line="407">TRUE if the timeline data was successfully loaded from the URI, else FALSE. @@ -5718,19 +5905,19 @@ else FALSE. a #GESFormatter + line="400">a #GESFormatter a #GESTimeline + line="401">a #GESTimeline a #gchar * pointing to a URI + line="402">a #gchar * pointing to a URI @@ -5742,13 +5929,13 @@ else FALSE. throws="1"> Save data from timeline to the given URI. + line="431">Save data from timeline to the given URI. Use @ges_timeline_save_to_uri TRUE if the timeline data was successfully saved to the URI + line="441">TRUE if the timeline data was successfully saved to the URI else FALSE. @@ -5756,25 +5943,25 @@ else FALSE. a #GESFormatter + line="433">a #GESFormatter a #GESTimeline + line="434">a #GESTimeline a #gchar * pointing to a URI + line="435">a #gchar * pointing to a URI %TRUE to overwrite file if it exists + line="436">%TRUE to overwrite file if it exists @@ -5881,25 +6068,25 @@ else FALSE. The class to register metas on + line="506">The class to register metas on The name of the formatter + line="507">The name of the formatter The formatter description + line="508">The formatter description A list of coma separated file extensions handled + line="509">A list of coma separated file extensions handled by the formatter. The order of the extensions should match the list of the structures inside @caps @@ -5907,7 +6094,7 @@ list of the structures inside @caps The caps the formatter handled, they should match what + line="512">The caps the formatter handled, they should match what gstreamer typefind mechanism will report for the files the formatter handles. @@ -5915,13 +6102,13 @@ handles. The version of the formatter + line="515">The version of the formatter The rank of the formatter + line="516">The rank of the formatter @@ -5939,7 +6126,7 @@ Every #GESFormatter subclass needs to implement this method. TRUE if the timeline data was successfully loaded from the URI, + line="407">TRUE if the timeline data was successfully loaded from the URI, else FALSE. @@ -5947,19 +6134,19 @@ else FALSE. a #GESFormatter + line="400">a #GESFormatter a #GESTimeline + line="401">a #GESTimeline a #gchar * pointing to a URI + line="402">a #gchar * pointing to a URI @@ -5982,7 +6169,7 @@ Every #GESFormatter subclass needs to implement this method. TRUE if the timeline data was successfully saved to the URI + line="441">TRUE if the timeline data was successfully saved to the URI else FALSE. @@ -5990,29 +6177,86 @@ else FALSE. a #GESFormatter + line="433">a #GESFormatter a #GESTimeline + line="434">a #GESTimeline a #gchar * pointing to a URI + line="435">a #gchar * pointing to a URI %TRUE to overwrite file if it exists + line="436">%TRUE to overwrite file if it exists + + Metadata type that holds information about the positioning, size, +transparency and composition operator of a video frame in the timeline +composition. + + + the parent #GstMeta. + + + + + + + The desired x position. + + + + The desired y position. + + + + The desired height of the video. -1 means that no scaling should be +applied. + + + + The desired width of the video. -1 means that no scaling should beapplied +applied. + + + + The desired z order. + + + + The blending operator for the source. + + + + method to get the objects contained in the layer @@ -6968,6 +7215,9 @@ efficient way of providing the list of contained #GESClip-s. c:type="GInitiallyUnownedClass"/> + method to get the objects contained in the layer @@ -9342,12 +9592,12 @@ ges_pipeline_set_render_settings(). Creates a new pipeline. + line="436">Creates a new pipeline. The newly created pipeline. + line="441">The newly created pipeline. @@ -9356,19 +9606,19 @@ ges_pipeline_set_render_settings(). glib:get-property="mode"> Gets the #GESPipeline:mode of the pipeline. + line="1167">Gets the #GESPipeline:mode of the pipeline. The current mode of @pipeline. + line="1173">The current mode of @pipeline. A #GESPipeline + line="1169">A #GESPipeline @@ -9376,7 +9626,7 @@ ges_pipeline_set_render_settings(). Gets a sample from the pipeline of the currently displayed image in + line="1316">Gets a sample from the pipeline of the currently displayed image in preview, in the specified format. Note that if you use "ANY" caps for @caps, then the current format of @@ -9386,7 +9636,7 @@ with gst_sample_get_caps(). A sample of @self's current image preview in + line="1329">A sample of @self's current image preview in the format given by @caps, or %NULL if an error prevented fetching the sample. @@ -9395,13 +9645,13 @@ sample. A #GESPipeline in #GST_STATE_PLAYING or #GST_STATE_PAUSED + line="1318">A #GESPipeline in #GST_STATE_PLAYING or #GST_STATE_PAUSED Some caps to specifying the desired format, or + line="1319">Some caps to specifying the desired format, or #GST_CAPS_ANY to use the native format @@ -9411,7 +9661,7 @@ sample. c:identifier="ges_pipeline_get_thumbnail_rgb24"> Gets a sample from the pipeline of the currently displayed image in + line="1412">Gets a sample from the pipeline of the currently displayed image in preview, in the 24-bit "RGB" format and of the desired width and height. @@ -9420,7 +9670,7 @@ See ges_pipeline_get_thumbnail(). A sample of @self's current image preview in + line="1426">A sample of @self's current image preview in the "RGB" format, scaled to @width and @height, or %NULL if an error prevented fetching the sample. @@ -9429,20 +9679,20 @@ prevented fetching the sample. A #GESPipeline in %GST_STATE_PLAYING or %GST_STATE_PAUSED + line="1414">A #GESPipeline in %GST_STATE_PLAYING or %GST_STATE_PAUSED The requested pixel width of the image, or -1 to use the native + line="1415">The requested pixel width of the image, or -1 to use the native size The requested pixel height of the image, or -1 to use the + line="1417">The requested pixel height of the image, or -1 to use the native size @@ -9452,19 +9702,19 @@ native size c:identifier="ges_pipeline_preview_get_audio_sink"> Gets the #GESPipeline:audio-sink of the pipeline. + line="1491">Gets the #GESPipeline:audio-sink of the pipeline. The audio sink used by @self for preview. + line="1497">The audio sink used by @self for preview. A #GESPipeline + line="1493">A #GESPipeline @@ -9473,19 +9723,19 @@ native size c:identifier="ges_pipeline_preview_get_video_sink"> Gets the #GESPipeline:video-sink of the pipeline. + line="1454">Gets the #GESPipeline:video-sink of the pipeline. The video sink used by @self for preview. + line="1460">The video sink used by @self for preview. A #GESPipeline + line="1456">A #GESPipeline @@ -9494,7 +9744,7 @@ native size c:identifier="ges_pipeline_preview_set_audio_sink"> Sets the #GESPipeline:audio-sink of the pipeline. + line="1512">Sets the #GESPipeline:audio-sink of the pipeline. @@ -9503,7 +9753,7 @@ native size A #GESPipeline in #GST_STATE_NULL + line="1514">A #GESPipeline in #GST_STATE_NULL allow-none="1"> A audio sink for @self to use for preview + line="1515">A audio sink for @self to use for preview @@ -9521,7 +9771,7 @@ native size c:identifier="ges_pipeline_preview_set_video_sink"> Sets the #GESPipeline:video-sink of the pipeline. + line="1475">Sets the #GESPipeline:video-sink of the pipeline. @@ -9530,7 +9780,7 @@ native size A #GESPipeline in #GST_STATE_NULL + line="1477">A #GESPipeline in #GST_STATE_NULL allow-none="1"> A video sink for @self to use for preview + line="1478">A video sink for @self to use for preview @@ -9549,13 +9799,13 @@ native size throws="1"> Saves the currently displayed image of the pipeline in preview to the + line="1352">Saves the currently displayed image of the pipeline in preview to the given location, in the specified dimensions and format. %TRUE if @self's current image preview was successfully saved + line="1366">%TRUE if @self's current image preview was successfully saved to @location using the given @format, @height and @width. @@ -9563,33 +9813,33 @@ to @location using the given @format, @height and @width. A #GESPipeline in %GST_STATE_PLAYING or %GST_STATE_PAUSED + line="1354">A #GESPipeline in %GST_STATE_PLAYING or %GST_STATE_PAUSED The requested pixel width of the image, or -1 to use the native + line="1355">The requested pixel width of the image, or -1 to use the native size The requested pixel height of the image, or -1 to use the + line="1357">The requested pixel height of the image, or -1 to use the native size The desired mime type (for example, "image/jpeg") + line="1359">The desired mime type (for example, "image/jpeg") The path to save the thumbnail to + line="1360">The path to save the thumbnail to @@ -9599,7 +9849,7 @@ native size glib:set-property="mode"> Sets the #GESPipeline:mode of the pipeline. + line="1181">Sets the #GESPipeline:mode of the pipeline. Note that the pipeline will be set to #GST_STATE_NULL during this call to perform the necessary changes. You will need to set the state again yourself @@ -9613,20 +9863,20 @@ after calling this. %TRUE if the mode of @pipeline was successfully set to @mode. + line="1197">%TRUE if the mode of @pipeline was successfully set to @mode. A #GESPipeline + line="1183">A #GESPipeline The mode to set for @pipeline + line="1184">The mode to set for @pipeline @@ -9635,7 +9885,7 @@ after calling this. c:identifier="ges_pipeline_set_render_settings"> Specifies encoding setting to be used by the pipeline to render its + line="1046">Specifies encoding setting to be used by the pipeline to render its #GESPipeline:timeline, and where the result should be written to. This method **must** be called before setting the pipeline mode to @@ -9644,27 +9894,27 @@ This method **must** be called before setting the pipeline mode to %TRUE if the settings were successfully set on @pipeline. + line="1059">%TRUE if the settings were successfully set on @pipeline. A #GESPipeline + line="1048">A #GESPipeline The URI to save the #GESPipeline:timeline rendering + line="1049">The URI to save the #GESPipeline:timeline rendering result to The encoding to use for rendering the #GESPipeline:timeline + line="1051">The encoding to use for rendering the #GESPipeline:timeline @@ -9675,7 +9925,7 @@ result to glib:set-property="timeline"> Takes the given timeline and sets it as the #GESPipeline:timeline for + line="1000">Takes the given timeline and sets it as the #GESPipeline:timeline for the pipeline. Note that you should only call this method once on a given pipeline @@ -9685,20 +9935,20 @@ it has been set. %TRUE if @timeline was successfully given to @pipeline. + line="1012">%TRUE if @timeline was successfully given to @pipeline. A #GESPipeline + line="1002">A #GESPipeline The timeline to set for @pipeline + line="1003">The timeline to set for @pipeline @@ -9709,7 +9959,7 @@ it has been set. transfer-ownership="none"> The audio filter(s) to apply during playback in preview mode, + line="367">The audio filter(s) to apply during playback in preview mode, immediately before the #GESPipeline:audio-sink. This exposes the #playsink:audio-filter property of the internal #playsink. @@ -9717,7 +9967,7 @@ immediately before the #GESPipeline:audio-sink. This exposes the The audio sink used for preview. This exposes the + line="321">The audio sink used for preview. This exposes the #playsink:audio-sink property of the internal #playsink. @@ -9729,7 +9979,7 @@ immediately before the #GESPipeline:audio-sink. This exposes the default-value="GES_PIPELINE_MODE_PREVIEW_AUDIO | GES_PIPELINE_MODE_PREVIEW_VIDEO"> The pipeline's mode. In preview mode (for audio or video, or both) + line="354">The pipeline's mode. In preview mode (for audio or video, or both) the pipeline can display the timeline's content to an end user. In rendering mode the pipeline can encode the timeline's content and save it to a file. @@ -9741,7 +9991,7 @@ save it to a file. setter="set_timeline"> The timeline used by this pipeline, whose content it will play and + line="341">The timeline used by this pipeline, whose content it will play and render, or %NULL if the pipeline does not yet have a timeline. Note that after you set the timeline for the first time, subsequent @@ -9754,7 +10004,7 @@ calls to change the timeline will fail. transfer-ownership="none"> The video filter(s) to apply during playback in preview mode, + line="381">The video filter(s) to apply during playback in preview mode, immediately before the #GESPipeline:video-sink. This exposes the #playsink:video-filter property of the internal #playsink. @@ -9762,7 +10012,7 @@ immediately before the #GESPipeline:video-sink. This exposes the The video sink used for preview. This exposes the + line="331">The video sink used for preview. This exposes the #playsink:video-sink property of the internal #playsink. @@ -9930,18 +10180,18 @@ is really not in good shape and is deprecated. #GESAsset with `GES_TYPE_TIMELINE` as @extractable_type itself. That means that you can extract #GESTimeline from a project as followed: -|[ - GESProject *project; - GESTimeline *timeline; +```c +GESProject *project; +GESTimeline *timeline; - project = ges_project_new ("file:///path/to/a/valid/project/uri"); +project = ges_project_new ("file:///path/to/a/valid/project/uri"); - // Here you can connect to the various signal to get more infos about - // what is happening and recover from errors if possible - ... +// Here you can connect to the various signal to get more infos about +// what is happening and recover from errors if possible +... - timeline = ges_asset_extract (GES_ASSET (project)); -]| +timeline = ges_asset_extract (GES_ASSET (project)); +``` The #GESProject class offers a higher level API to handle #GESAsset-s. It lets you request new asset, and it informs you about new assets through @@ -9972,7 +10222,7 @@ the same temporary location. Creates a new #GESProject and sets its uri to @uri if provided. Note that + line="1242">Creates a new #GESProject and sets its uri to @uri if provided. Note that if @uri is not valid or %NULL, the uri of the project will then be set the first time you save the project. If you then save the project to other locations, it will never be updated again and the first valid URI is @@ -9981,7 +10231,9 @@ the URI it will keep refering to. A newly created #GESProject + line="1252">A newly created #GESProject + +MT safe. @@ -9991,7 +10243,7 @@ the URI it will keep refering to. allow-none="1"> The uri to be set after creating the project. + line="1244">The uri to be set after creating the project. @@ -10112,27 +10364,29 @@ the URI it will keep refering to. Adds a #GESAsset to @project, the project will keep a reference on + line="1012">Adds a #GESAsset to @project, the project will keep a reference on @asset. %TRUE if the asset could be added %FALSE it was already -in the project + line="1020">%TRUE if the asset could be added %FALSE it was already +in the project. + +MT safe. A #GESProject + line="1014">A #GESProject A #GESAsset to add to @project + line="1015">A #GESAsset to add to @project @@ -10141,28 +10395,30 @@ in the project c:identifier="ges_project_add_encoding_profile"> Adds @profile to the project. It lets you save in what format -the project has been renders and keep a reference to those formats. -Also, those formats will be saves to the project file when possible. + line="1329">Adds @profile to the project. It lets you save in what format +the project will be rendered and keep a reference to those formats. +Also, those formats will be saved to the project file when possible. %TRUE if @profile could be added, %FALSE otherwize + line="1339">%TRUE if @profile could be added, %FALSE otherwise + +MT safe. A #GESProject + line="1331">A #GESProject A #GstEncodingProfile to add to the project. If a profile with -the same name already exists, it will be replaced + line="1332">A #GstEncodingProfile to add to the project. If a profile with +the same name already exists, it will be replaced. @@ -10173,7 +10429,10 @@ the same name already exists, it will be replaced version="1.18"> Adds a formatter as used to load @project + line="154">Adds a formatter to be used to load @project + + +MT safe. @@ -10182,13 +10441,13 @@ the same name already exists, it will be replaced The project to add a formatter to + line="156">The project to add a formatter to A formatter used by @project + line="157">A formatter used by @project @@ -10196,22 +10455,24 @@ the same name already exists, it will be replaced Create and add a #GESAsset to @project. You should connect to the + line="860">Create and add a #GESAsset to @project. You should connect to the "asset-added" signal to get the asset when it finally gets added to @project %TRUE if the asset started to be added %FALSE it was already -in the project + line="870">%TRUE if the asset was added and started loading, %FALSE it was +already in the project. + +MT safe. A #GESProject + line="862">A #GESProject allow-none="1"> The id of the asset to create and add to @project + line="863">The id of the asset to create and add to @project The #GType of the asset to create + line="864">The #GType of the asset to create @@ -10236,21 +10497,23 @@ in the project throws="1"> Create and add a #GESAsset to @project. You should connect to the + line="908">Create and add a #GESAsset to @project. You should connect to the "asset-added" signal to get the asset when it finally gets added to @project The newly created #GESAsset or %NULL. + line="919">The newly created #GESAsset or %NULL. + +MT safe. A #GESProject + line="910">A #GESProject allow-none="1"> The id of the asset to create and add to @project + line="911">The id of the asset to create and add to @project The #GType of the asset to create + line="912">The #GType of the asset to create @@ -10275,27 +10538,29 @@ in the project The #GESAsset with -@id or %NULL if no asset with @id as an ID + line="1085">The #GESAsset with +@id or %NULL if no asset with @id as an ID + +MT safe. A #GESProject + line="1080">A #GESProject The id of the asset to retrieve + line="1081">The id of the asset to retrieve The extractable_type of the asset + line="1082">The extractable_type of the asset to retrieve from @object @@ -10305,14 +10570,16 @@ to retrieve from @object c:identifier="ges_project_get_loading_assets"> Get the assets that are being loaded + line="1394">Get the assets that are being loaded A set of loading asset + line="1400">A set of loading asset that will be added to @project. Note that those Asset are *not* loaded yet, -and thus can not be used +and thus can not be used. + +MT safe. @@ -10321,7 +10588,7 @@ and thus can not be used A #GESProject + line="1396">A #GESProject @@ -10331,19 +10598,21 @@ and thus can not be used glib:get-property="uri"> Retrieve the uri that is currently set on @project + line="1304">Retrieve the uri that is currently set on @project a newly allocated string representing uri. + line="1310">a newly allocated string representing uri. + +MT safe. A #GESProject + line="1306">A #GESProject @@ -10351,15 +10620,17 @@ and thus can not be used List all @asset contained in @project filtering per extractable_type + line="1113">List all @asset contained in @project filtering per extractable_type as defined by @filter. It copies the asset and thus will not be updated in time. The list of -#GESAsset the object contains + line="1123">The list of +#GESAsset the object contains + +MT safe. @@ -10368,13 +10639,13 @@ in time. A #GESProject + line="1115">A #GESProject Type of assets to list, `GES_TYPE_EXTRACTABLE` will list + line="1116">Type of assets to list, `GES_TYPE_EXTRACTABLE` will list all assets @@ -10384,13 +10655,13 @@ all assets c:identifier="ges_project_list_encoding_profiles"> Lists the encoding profile that have been set to @project. The first one + line="1376">Lists the encoding profile that have been set to @project. The first one is the latest added. The + line="1383">The list of #GstEncodingProfile used in @project @@ -10400,7 +10671,7 @@ list of #GstEncodingProfile used in @project A #GESProject + line="1378">A #GESProject @@ -10408,25 +10679,27 @@ list of #GstEncodingProfile used in @project Loads @project into @timeline + line="1276">Loads @project into @timeline %TRUE if the project could be loaded %FALSE otherwize. + line="1284">%TRUE if the project could be loaded %FALSE otherwise. + +MT safe. A #GESProject that has an @uri set already + line="1278">A #GESProject that has an @uri set already A blank timeline to load @project into + line="1279">A blank timeline to load @project into @@ -10434,25 +10707,27 @@ list of #GstEncodingProfile used in @project remove a @asset to from @project. + line="1049">Remove @asset from @project. %TRUE if the asset could be removed %FALSE otherwise + line="1056">%TRUE if the asset could be removed %FALSE otherwise + +MT safe. A #GESProject + line="1051">A #GESProject A #GESAsset to remove from @project + line="1052">A #GESAsset to remove from @project @@ -10460,33 +10735,35 @@ list of #GstEncodingProfile used in @project Save the timeline of @project to @uri. You should make sure that @timeline + line="1151">Save the timeline of @project to @uri. You should make sure that @timeline is one of the timelines that have been extracted from @project (using ges_asset_extract (@project);) %TRUE if the project could be save, %FALSE otherwize + line="1167">%TRUE if the project could be save, %FALSE otherwise + +MT safe. A #GESProject to save + line="1153">A #GESProject to save The #GESTimeline to save, it must have been extracted from @project + line="1154">The #GESTimeline to save, it must have been extracted from @project The uri where to save @project and @timeline + line="1155">The uri where to save @project and @timeline The formatter asset to + line="1156">The formatter asset to use or %NULL. If %NULL, will try to save in the same format as the one from which the timeline as been loaded or default to the best formatter as defined in #ges_find_formatter_for_uri @@ -10504,7 +10781,7 @@ as defined in #ges_find_formatter_for_uri %TRUE to overwrite file if it exists + line="1160">%TRUE to overwrite file if it exists @@ -10536,7 +10813,7 @@ as defined in #ges_find_formatter_for_uri The #GESAsset that has been added to @project + line="547">The #GESAsset that has been added to @project @@ -10549,7 +10826,7 @@ as defined in #ges_find_formatter_for_uri The #GESAsset that started loading + line="557">The #GESAsset that started loading @@ -10562,7 +10839,7 @@ as defined in #ges_find_formatter_for_uri The #GESAsset that has been removed from @project + line="569">The #GESAsset that has been removed from @project @@ -10575,13 +10852,13 @@ as defined in #ges_find_formatter_for_uri The timeline that failed loading + line="652">The timeline that failed loading The #GError defining the error that occured + line="653">The #GError defining the error that occured @@ -10589,7 +10866,7 @@ as defined in #ges_find_formatter_for_uri Informs you that a #GESAsset could not be created. In case of + line="631">Informs you that a #GESAsset could not be created. In case of missing GStreamer plugins, the error will be set to #GST_CORE_ERROR #GST_CORE_ERROR_MISSING_PLUGIN @@ -10599,19 +10876,19 @@ missing GStreamer plugins, the error will be set to #GST_CORE_ERROR The #GError defining the error that occured, might be %NULL + line="634">The #GError defining the error that occured, might be %NULL The @id of the asset that failed loading + line="635">The @id of the asset that failed loading The @extractable_type of the asset that + line="636">The @extractable_type of the asset that failed loading @@ -10625,7 +10902,7 @@ failed loading The #GESTimeline that completed loading + line="591">The #GESTimeline that completed loading @@ -10638,7 +10915,7 @@ failed loading The #GESTimeline that started loading + line="579">The #GESTimeline that started loading @@ -10646,7 +10923,7 @@ failed loading |[ + line="598">```c static gchar source_moved_cb (GESProject *project, GError *error, GESAsset *asset_with_error) { @@ -10662,24 +10939,24 @@ main (int argc, gchar ** argv) g_signal_connect (project, "missing-uri", source_moved_cb, NULL); timeline = ges_asset_extract (GES_ASSET (project)); } -]| +``` The new URI of @wrong_asset + line="623">The new URI of @wrong_asset The error that happened + line="601">The error that happened The asset with the wrong ID, you should us it and its content + line="602">The asset with the wrong ID, you should us it and its content only to find out what the new location is. @@ -12651,12 +12928,12 @@ content, or render it to a file. Creates a new empty timeline. + line="2186">Creates a new empty timeline. The new timeline. + line="2191">The new timeline. @@ -12679,12 +12956,12 @@ single #GESVideoTrack. throws="1"> Creates a timeline from the given URI. + line="2206">Creates a timeline from the given URI. A new timeline if the uri was loaded + line="2214">A new timeline if the uri was loaded successfully, or %NULL if the uri could not be loaded. @@ -12692,7 +12969,7 @@ successfully, or %NULL if the uri could not be loaded. The URI to load from + line="2208">The URI to load from @@ -12792,7 +13069,7 @@ successfully, or %NULL if the uri could not be loaded. deprecated-version="1.18"> Add a layer to the timeline. + line="2350">Add a layer to the timeline. If the layer contains #GESClip-s, then this may trigger the creation of their core track element children for the timeline's tracks, and the @@ -12811,20 +13088,20 @@ ges_timeline_append_layer() and ges_timeline_move_layer() instead. %TRUE if @layer was properly added. + line="2372">%TRUE if @layer was properly added. The #GESTimeline + line="2352">The #GESTimeline The layer to add + line="2353">The layer to add @@ -12832,7 +13109,7 @@ ges_timeline_append_layer() and ges_timeline_move_layer() instead. Add a track to the timeline. + line="2496">Add a track to the timeline. If the timeline already contains clips, then this may trigger the creation of their core track element children for the track, and the @@ -12846,20 +13123,20 @@ that you avoid adding tracks to timelines that already contain clips. %TRUE if @track was properly added. + line="2512">%TRUE if @track was properly added. The #GESTimeline + line="2498">The #GESTimeline The track to add + line="2499">The track to add @@ -12867,20 +13144,20 @@ that you avoid adding tracks to timelines that already contain clips. Append a newly created layer to the timeline. The layer will + line="2318">Append a newly created layer to the timeline. The layer will be added at the lowest #GESLayer:priority (numerically, the highest). The newly created layer. + line="2325">The newly created layer. The #GESTimeline + line="2320">The #GESTimeline @@ -12888,7 +13165,7 @@ be added at the lowest #GESLayer:priority (numerically, the highest). Commit all the pending changes of the clips contained in the + line="2867">Commit all the pending changes of the clips contained in the timeline. When changes happen in a timeline, they are not immediately executed @@ -12911,7 +13188,7 @@ usually triggered by a corresponding state changes in a containing %TRUE if pending changes were committed, or %FALSE if nothing + line="2891">%TRUE if pending changes were committed, or %FALSE if nothing needed to be committed. @@ -12919,7 +13196,7 @@ needed to be committed. A #GESTimeline + line="2869">A #GESTimeline @@ -12927,7 +13204,7 @@ needed to be committed. Commit all the pending changes of the clips contained in the + line="2922">Commit all the pending changes of the clips contained in the timeline and wait for the changes to complete. See ges_timeline_commit(). @@ -12935,7 +13212,7 @@ See ges_timeline_commit(). %TRUE if pending changes were committed, or %FALSE if nothing + line="2931">%TRUE if pending changes were committed, or %FALSE if nothing needed to be committed. @@ -12943,7 +13220,7 @@ needed to be committed. A #GESTimeline + line="2924">A #GESTimeline @@ -12953,7 +13230,7 @@ needed to be committed. version="1.22"> WARNING: When using that mode, GES won't guarantee the coherence of the + line="3420">WARNING: When using that mode, GES won't guarantee the coherence of the timeline. You need to ensure that the rules described in the [Overlaps and auto transitions](#overlaps-and-autotransitions) section are respected any time the timeline is [commited](ges_timeline_commit) (otherwise playback will most @@ -12972,13 +13249,13 @@ usable: A #GESTimeline + line="3422">A #GESTimeline %TRUE to disable all the edit APIs so the user is in full + line="3423">%TRUE to disable all the edit APIs so the user is in full control of ensuring timeline state validity %FALSE otherwise. @@ -12989,7 +13266,7 @@ control of ensuring timeline state validity %FALSE otherwise. version="1.20"> Freezes the timeline from being committed. This is usually needed while the + line="2971">Freezes the timeline from being committed. This is usually needed while the timeline is being rendered to ensure that not change to the timeline are taken into account during that moment. Once the rendering is done, you should call #ges_timeline_thaw_commit so that committing becomes possible @@ -13003,7 +13280,7 @@ actually taken into account. The #GESTimeline + line="2973">The #GESTimeline @@ -13013,19 +13290,19 @@ actually taken into account. glib:get-property="auto-transition"> Gets #GESTimeline:auto-transition for the timeline. + line="3033">Gets #GESTimeline:auto-transition for the timeline. The auto-transition of @self. + line="3039">The auto-transition of @self. The #GESTimeline + line="3035">The #GESTimeline @@ -13035,19 +13312,19 @@ actually taken into account. glib:get-property="duration"> Get the current #GESTimeline:duration of the timeline + line="3016">Get the current #GESTimeline:duration of the timeline The current duration of @timeline. + line="3022">The current duration of @timeline. The #GESTimeline + line="3018">The #GESTimeline @@ -13059,14 +13336,14 @@ actually taken into account. %TRUE if edit APIs are disabled, %FALSE otherwise. + line="3468">%TRUE if edit APIs are disabled, %FALSE otherwise. A #GESTimeline + line="3466">A #GESTimeline @@ -13074,12 +13351,12 @@ actually taken into account. Gets the element contained in the timeline with the given name. + line="3120">Gets the element contained in the timeline with the given name. The timeline element in @timeline + line="3127">The timeline element in @timeline with the given @name, or %NULL if it was not found. @@ -13087,13 +13364,13 @@ with the given @name, or %NULL if it was not found. The #GESTimeline + line="3122">The #GESTimeline The name of the element to find + line="3123">The name of the element to find @@ -13103,26 +13380,26 @@ with the given @name, or %NULL if it was not found. version="1.18"> This method allows you to convert a timeline #GstClockTime into its + line="3394">This method allows you to convert a timeline #GstClockTime into its corresponding #GESFrameNumber in the timeline's output. The frame number @timestamp corresponds to. + line="3402">The frame number @timestamp corresponds to. A #GESTimeline + line="3396">A #GESTimeline The timestamp to get the corresponding frame number of + line="3397">The timestamp to get the corresponding frame number of @@ -13132,7 +13409,7 @@ corresponding #GESFrameNumber in the timeline's output. version="1.18"> This method allows you to convert a timeline output frame number into a + line="3365">This method allows you to convert a timeline output frame number into a timeline #GstClockTime. For example, this time could be used to seek to a particular frame in the timeline's output, or as the edit position for an element within the timeline. @@ -13140,20 +13417,20 @@ an element within the timeline. The timestamp corresponding to @frame_number in the output of @self. + line="3376">The timestamp corresponding to @frame_number in the output of @self. The self on which to retrieve the timestamp for @frame_number + line="3367">The self on which to retrieve the timestamp for @frame_number The frame number to get the corresponding timestamp of in the + line="3368">The frame number to get the corresponding timestamp of in the timeline coordinates @@ -13162,12 +13439,12 @@ an element within the timeline. Get the list of #GESGroup-s present in the timeline. + line="2299">Get the list of #GESGroup-s present in the timeline. The list of + line="2305">The list of groups that contain clips present in @timeline's layers. Must not be changed. @@ -13178,7 +13455,7 @@ Must not be changed. The #GESTimeline + line="2301">The #GESTimeline @@ -13186,13 +13463,13 @@ Must not be changed. Retrieve the layer whose index in the timeline matches the given + line="3191">Retrieve the layer whose index in the timeline matches the given priority. The layer with the given + line="3199">The layer with the given @priority, or %NULL if none was found. Since 1.6 @@ -13202,13 +13479,13 @@ Since 1.6 The #GESTimeline to retrieve a layer from + line="3193">The #GESTimeline to retrieve a layer from The priority/index of the layer to find + line="3194">The priority/index of the layer to find @@ -13216,12 +13493,12 @@ Since 1.6 Get the list of #GESLayer-s present in the timeline. + line="2771">Get the list of #GESLayer-s present in the timeline. The list of + line="2777">The list of layers present in @timeline sorted by priority. @@ -13231,7 +13508,7 @@ layers present in @timeline sorted by priority. The #GESTimeline + line="2773">The #GESTimeline @@ -13240,13 +13517,13 @@ layers present in @timeline sorted by priority. c:identifier="ges_timeline_get_pad_for_track"> Search for the #GstPad corresponding to the given timeline's track. + line="2715">Search for the #GstPad corresponding to the given timeline's track. You can link to this pad to receive the output data of the given track. The pad corresponding to @track, + line="2723">The pad corresponding to @track, or %NULL if there is an error. @@ -13254,13 +13531,13 @@ or %NULL if there is an error. The #GESTimeline + line="2717">The #GESTimeline A track + line="2718">A track @@ -13270,19 +13547,19 @@ or %NULL if there is an error. glib:get-property="snapping-distance"> Gets the #GESTimeline:snapping-distance for the timeline. + line="3082">Gets the #GESTimeline:snapping-distance for the timeline. The snapping distance (in nanoseconds) of @timeline. + line="3088">The snapping distance (in nanoseconds) of @timeline. The #GESTimeline + line="3084">The #GESTimeline @@ -13291,12 +13568,12 @@ or %NULL if there is an error. c:identifier="ges_timeline_get_track_for_pad"> Search for the #GESTrack corresponding to the given timeline's pad. + line="2684">Search for the #GESTrack corresponding to the given timeline's pad. The track corresponding to @pad, + line="2691">The track corresponding to @pad, or %NULL if there is an error. @@ -13304,13 +13581,13 @@ or %NULL if there is an error. The #GESTimeline + line="2686">The #GESTimeline A pad + line="2687">A pad @@ -13318,12 +13595,12 @@ or %NULL if there is an error. Get the list of #GESTrack-s used by the timeline. + line="2749">Get the list of #GESTrack-s used by the timeline. The list of tracks + line="2755">The list of tracks used by @timeline. @@ -13333,7 +13610,7 @@ used by @timeline. The #GESTimeline + line="2751">The #GESTimeline @@ -13341,19 +13618,19 @@ used by @timeline. Check whether the timeline is empty or not. + line="3161">Check whether the timeline is empty or not. %TRUE if @timeline is empty. + line="3167">%TRUE if @timeline is empty. The #GESTimeline + line="3163">The #GESTimeline @@ -13363,25 +13640,25 @@ used by @timeline. throws="1"> Loads the contents of URI into the timeline. + line="2229">Loads the contents of URI into the timeline. %TRUE if the timeline was loaded successfully from @uri. + line="2238">%TRUE if the timeline was loaded successfully from @uri. An empty #GESTimeline into which to load the formatter + line="2231">An empty #GESTimeline into which to load the formatter The URI to load from + line="2232">The URI to load from @@ -13391,7 +13668,7 @@ used by @timeline. version="1.16"> Moves a layer within the timeline to the index given by + line="3322">Moves a layer within the timeline to the index given by @new_layer_priority. An index of 0 corresponds to the layer with the highest priority in a timeline. If @new_layer_priority is greater than the number of layers @@ -13404,19 +13681,19 @@ present in the timeline, it will become the lowest priority layer. A #GESTimeline + line="3324">A #GESTimeline A layer within @timeline, whose priority should be changed + line="3325">A layer within @timeline, whose priority should be changed The new index for @layer + line="3326">The new index for @layer @@ -13424,7 +13701,7 @@ present in the timeline, it will become the lowest priority layer. Paste an element inside the timeline. @element **must** be the return of + line="3247">Paste an element inside the timeline. @element **must** be the return of ges_timeline_element_copy() with `deep=TRUE`, and it should not be changed before pasting. @element itself is not placed in the timeline, instead a new element is created, alike to the @@ -13444,7 +13721,7 @@ See also ges_timeline_element_paste(). The newly created element, or + line="3273">The newly created element, or %NULL if pasting fails. @@ -13452,26 +13729,26 @@ See also ges_timeline_element_paste(). The #GESTimeline onto which @element should be pasted + line="3249">The #GESTimeline onto which @element should be pasted The element to paste + line="3250">The element to paste The position in the timeline @element should be pasted to, + line="3251">The position in the timeline @element should be pasted to, i.e. the #GESTimelineElement:start value for the pasted element. The layer into which the element should be pasted. + line="3253">The layer into which the element should be pasted. -1 means paste to the same layer from which @element has been copied from @@ -13480,25 +13757,25 @@ i.e. the #GESTimelineElement:start value for the pasted element. Removes a layer from the timeline. + line="2441">Removes a layer from the timeline. %TRUE if @layer was properly removed. + line="2448">%TRUE if @layer was properly removed. The #GESTimeline + line="2443">The #GESTimeline The layer to remove + line="2444">The layer to remove @@ -13506,25 +13783,25 @@ i.e. the #GESTimelineElement:start value for the pasted element. Remove a track from the timeline. + line="2595">Remove a track from the timeline. %TRUE if @track was properly removed. + line="2602">%TRUE if @track was properly removed. The #GESTimeline + line="2597">The #GESTimeline The track to remove + line="2598">The track to remove @@ -13534,27 +13811,27 @@ i.e. the #GESTimelineElement:start value for the pasted element. throws="1"> Saves the timeline to the given location. If @formatter_asset is %NULL, + line="2258">Saves the timeline to the given location. If @formatter_asset is %NULL, the method will attempt to save in the same format the timeline was loaded from, before defaulting to the formatter with highest rank. %TRUE if @timeline was successfully saved to @uri. + line="2271">%TRUE if @timeline was successfully saved to @uri. The #GESTimeline + line="2260">The #GESTimeline The location to save to + line="2261">The location to save to allow-none="1"> The formatter asset to use, or %NULL + line="2262">The formatter asset to use, or %NULL %TRUE to overwrite file if it exists + line="2263">%TRUE to overwrite file if it exists @@ -13579,7 +13856,7 @@ loaded from, before defaulting to the formatter with highest rank. glib:set-property="auto-transition"> Sets #GESTimeline:auto-transition for the timeline. This will also set + line="3050">Sets #GESTimeline:auto-transition for the timeline. This will also set the corresponding #GESLayer:auto-transition for all of the timeline's layers to the same value. See ges_layer_set_auto_transition() if you wish to set the layer's #GESLayer:auto-transition individually. @@ -13591,13 +13868,13 @@ wish to set the layer's #GESLayer:auto-transition individually. The #GESTimeline + line="3052">The #GESTimeline Whether transitions should be automatically added + line="3053">Whether transitions should be automatically added to @timeline's layers @@ -13608,7 +13885,7 @@ to @timeline's layers glib:set-property="snapping-distance"> Sets #GESTimeline:snapping-distance for the timeline. This new value + line="3100">Sets #GESTimeline:snapping-distance for the timeline. This new value will only effect future snappings and will not be used to snap the current element positions within the timeline. @@ -13619,13 +13896,13 @@ current element positions within the timeline. The #GESTimeline + line="3102">The #GESTimeline The snapping distance to use (in nanoseconds) + line="3103">The snapping distance to use (in nanoseconds) @@ -13635,7 +13912,7 @@ current element positions within the timeline. version="1.20"> Thaw the timeline so that comiting becomes possible + line="2993">Thaw the timeline so that comiting becomes possible again and any call to `commit()` that happened during the rendering is actually taken into account. @@ -13646,7 +13923,7 @@ actually taken into account. The #GESTimeline + line="2995">The #GESTimeline @@ -13659,7 +13936,7 @@ actually taken into account. default-value="FALSE"> Whether to automatically create a transition whenever two + line="635">Whether to automatically create a transition whenever two #GESSource-s overlap in a track of the timeline. See #GESLayer:auto-transition if you want this to only happen in some layers. @@ -13671,7 +13948,7 @@ layers. default-value="18446744073709551615"> The current duration (in nanoseconds) of the timeline. A timeline + line="621">The current duration (in nanoseconds) of the timeline. A timeline 'starts' at time 0, so this is the maximum end time of all of its #GESTimelineElement-s. @@ -13684,7 +13961,7 @@ layers. default-value="0"> The distance (in nanoseconds) at which a #GESTimelineElement being + line="647">The distance (in nanoseconds) at which a #GESTimelineElement being moved within the timeline should snap one of its #GESSource-s with another #GESSource-s edge. See #GESEditMode for which edges can snap during an edit. 0 means no snapping. @@ -13722,7 +13999,7 @@ safe, use #ges_timeline_get_tracks instead. This signal will be emitted once the changes initiated by + line="886">This signal will be emitted once the changes initiated by ges_timeline_commit() have been executed in the backend. Use ges_timeline_commit_sync() if you do not want to have to connect to this signal. @@ -13733,7 +14010,7 @@ to this signal. Will be emitted after the group is added to to the timeline. This can + line="720">Will be emitted after the group is added to to the timeline. This can happen when grouping with `ges_container_group`, or by adding containers to a newly created group. @@ -13748,7 +14025,7 @@ were created for the timeline. The group that was added to @timeline + line="723">The group that was added to @timeline @@ -13756,7 +14033,7 @@ were created for the timeline. Will be emitted after the group is removed from the timeline through + line="739">Will be emitted after the group is removed from the timeline through `ges_container_ungroup`. Note that @group will no longer contain its former children, these are held in @children. @@ -13769,13 +14046,13 @@ timeline, but this signal will **not** be emitted in such a case. The group that was removed from @timeline + line="742">The group that was removed from @timeline A list + line="743">A list of #GESContainer-s that _were_ the children of the removed @group @@ -13786,7 +14063,7 @@ of #GESContainer-s that _were_ the children of the removed @group Will be emitted after the layer is added to the timeline. + line="691">Will be emitted after the layer is added to the timeline. Note that this should not be emitted whilst a timeline is being loaded from its #GESProject asset. You should connect to the @@ -13799,7 +14076,7 @@ layers were created for the timeline. The layer that was added to @timeline + line="694">The layer that was added to @timeline @@ -13807,7 +14084,7 @@ layers were created for the timeline. Will be emitted after the layer is removed from the timeline. + line="708">Will be emitted after the layer is removed from the timeline. @@ -13815,7 +14092,7 @@ layers were created for the timeline. The layer that was removed from @timeline + line="711">The layer that was removed from @timeline @@ -13823,12 +14100,12 @@ layers were created for the timeline. Simplified version of #GESTimeline::select-tracks-for-object which only + line="867">Simplified version of #GESTimeline::select-tracks-for-object which only allows @track_element to be added to a single #GESTrack. A track to put @track_element into, or %NULL if + line="876">A track to put @track_element into, or %NULL if it should be discarded. @@ -13836,13 +14113,13 @@ it should be discarded. The clip that @track_element is being added to + line="870">The clip that @track_element is being added to The element being added + line="871">The element being added @@ -13850,7 +14127,7 @@ it should be discarded. This will be emitted whenever the timeline needs to determine which + line="800">This will be emitted whenever the timeline needs to determine which tracks a clip's children should be added to. The track element will be added to each of the tracks given in the return. If a track element is selected to go into multiple tracks, it will be copied @@ -13904,7 +14181,7 @@ free function on the #GPtrArray to dereference the elements. An array of + line="858">An array of #GESTrack-s that @track_element should be added to, or %NULL to not add the element to any track. @@ -13915,13 +14192,13 @@ not add the element to any track. The clip that @track_element is being added to + line="803">The clip that @track_element is being added to The element being added + line="804">The element being added @@ -13929,7 +14206,7 @@ not add the element to any track. Will be emitted whenever a snapping event ends. After a snap event + line="781">Will be emitted whenever a snapping event ends. After a snap event has started (see #GESTimeline::snapping-started), it can later end because either another timeline edit has occurred (which may or may not have created a new snapping event), or because the timeline has @@ -13941,19 +14218,19 @@ been committed. The first element that was snapping + line="784">The first element that was snapping The second element that was snapping + line="785">The second element that was snapping The position where the two objects were to be snapped to + line="786">The position where the two objects were to be snapped to @@ -13961,7 +14238,7 @@ been committed. Will be emitted whenever an element's movement invokes a snapping + line="758">Will be emitted whenever an element's movement invokes a snapping event during an edit (usually of one of its ancestors) because its start or end point lies within the #GESTimeline:snapping-distance of another element's start or end point. @@ -13977,19 +14254,19 @@ element edit within a timeline. The first element that is snapping + line="761">The first element that is snapping The second element that is snapping + line="762">The second element that is snapping The position where the two objects will snap to + line="763">The position where the two objects will snap to @@ -13997,7 +14274,7 @@ element edit within a timeline. Will be emitted after the track is added to the timeline. + line="662">Will be emitted after the track is added to the timeline. Note that this should not be emitted whilst a timeline is being loaded from its #GESProject asset. You should connect to the @@ -14010,7 +14287,7 @@ tracks were created for the timeline. The track that was added to @timeline + line="665">The track that was added to @timeline @@ -14018,7 +14295,7 @@ tracks were created for the timeline. Will be emitted after the track is removed from the timeline. + line="679">Will be emitted after the track is removed from the timeline. @@ -14026,7 +14303,7 @@ tracks were created for the timeline. The track that was removed from @timeline + line="682">The track that was removed from @timeline @@ -14244,6 +14521,10 @@ ges_timeline_element_list_children_properties(). + Prepare @copy for pasting as a copy of @self. At least by +copying the children properties of @self into @copy. @@ -14357,6 +14638,13 @@ of #GESTrack it can exist in, or will create #GESTrackElement-s for. + List the children properties that have been +registered for the element. The default implementation is able to fetch +all of these, so should be sufficient. If you overwrite this, you +should still call the default implementation to get the full list, and +then edit its content. @@ -14434,6 +14722,11 @@ specification of the child property + Paste @self, which is the @copy prepared by @deep_copy, into +the timeline at the given @paste_position, with @ref_element as a +reference, which is the @self that was passed to @deep_copy. @@ -16583,6 +16876,10 @@ and emitting the notify signal. c:type="GInitiallyUnownedClass"/> + Method called just before the #GESTimelineElement:parent +is set. @@ -16606,6 +16903,27 @@ and emitting the notify signal. + Method called just before the #GESTimelineElement:start is +set. This method should check whether the #GESTimelineElement:start can +be changed to the new value and to otherwise prepare the element in +response to what the new value will be. A return of %FALSE means that +the property should not be set. A return of %TRUE means that the +property should be set to the value given to the setter and a notify +emitted. A return of -1 means that the property should not be set but +the setter should still return %TRUE (normally because the method +already handled setting the value, potentially to a snapped value, and +emitted the notify signal). +#GESTimelineElement:duration is set. This method should check +whether the #GESTimelineElement:duration can be changed to the new +value and to otherwise prepare the element in response to what the new +value will be. A return of %FALSE means that the property should not be +set. A return of %TRUE means that the property should be set to the +value given to the setter and a notify emitted. A return of -1 means +that the property should not be set but the setter should still return +%TRUE (normally because the method already handled setting the value, +potentially to a snapped value, and emitted the notify signal). @@ -16631,6 +16949,14 @@ and emitting the notify signal. + Method called just before the +#GESTimelineElement:in-point is set to a new value. This method should +not set the #GESTimelineElement:in-point itself, but should check +whether it can be changed to the new value and to otherwise prepare the +element in response to what the new value will be. A return of %FALSE +means that the property should not be set. @@ -16681,6 +17007,14 @@ and emitting the notify signal. + Method called just before the +#GESTimelineElement:max-duration is set. This method should +not set the #GESTimelineElement:max-duration itself, but should check +whether it can be changed to the new value and to otherwise prepare the +element in response to what the new value will be. A return of %FALSE +means that the property should not be set. @@ -16706,6 +17040,10 @@ and emitting the notify signal. + Method called just before the +#GESTimelineElement:priority is set. @@ -16731,6 +17069,10 @@ and emitting the notify signal. + Set this method to overwrite a redirect to +ges_timeline_element_edit() in ges_timeline_element_ripple(). @@ -16757,6 +17099,10 @@ failure. + Set this method to overwrite a redirect to +ges_timeline_element_edit() in ges_timeline_element_ripple_end(). @@ -16808,6 +17154,10 @@ failure. + Set this method to overwrite a redirect to +ges_timeline_element_edit() in ges_timeline_element_roll_end(). @@ -16833,6 +17183,10 @@ failure. + Set this method to overwrite a redirect to +ges_timeline_element_edit() in ges_timeline_element_trim(). @@ -16858,6 +17212,10 @@ failure. + Prepare @copy for pasting as a copy of @self. At least by +copying the children properties of @self into @copy. @@ -16874,6 +17232,11 @@ failure. + Paste @self, which is the @copy prepared by @deep_copy, into +the timeline at the given @paste_position, with @ref_element as a +reference, which is the @self that was passed to @deep_copy. @@ -16893,6 +17256,13 @@ failure. + List the children properties that have been +registered for the element. The default implementation is able to fetch +all of these, so should be sufficient. If you overwrite this, you +should still call the default implementation to get the full list, and +then edit its content. @@ -16909,6 +17279,13 @@ failure. + Find @child, and its registered child property @pspec, +corresponding to the child property specified by @prop_name. The +default implementation will search for the first child that matches. If +you overwrite this, you will likely still want to call the default +vmethod, which has access to the registered parameter specifications. @@ -16959,6 +17336,9 @@ specification of the child property + Return a the track types for the element. @@ -18192,7 +18572,7 @@ updating them. Creates a new track with the given track-type and caps. + line="885">Creates a new track with the given track-type and caps. If @type is #GES_TRACK_TYPE_VIDEO, and @caps is a subset of "video/x-raw(ANY)", then a #GESVideoTrack is created. This will @@ -18214,20 +18594,20 @@ ges_track_set_create_element_for_gap_func() on the returned track. A new track. + line="909">A new track. The #GESTrack:track-type for the track + line="887">The #GESTrack:track-type for the track The #GESTrack:caps for the track + line="888">The #GESTrack:caps for the track @@ -18246,25 +18626,25 @@ ges_track_set_create_element_for_gap_func() on the returned track. See ges_track_add_element(), which also gives an error. + line="1277">See ges_track_add_element(), which also gives an error. %TRUE if @object was successfully added to @track. + line="1284">%TRUE if @object was successfully added to @track. A #GESTrack + line="1279">A #GESTrack The element to add + line="1280">The element to add @@ -18275,7 +18655,7 @@ ges_track_set_create_element_for_gap_func() on the returned track. throws="1"> Adds the given track element to the track, which takes ownership of the + line="1185">Adds the given track element to the track, which takes ownership of the element. Note that this can fail if it would break a configuration rule of the @@ -18286,20 +18666,20 @@ Note that a #GESTrackElement can only be added to one track. %TRUE if @object was successfully added to @track. + line="1199">%TRUE if @object was successfully added to @track. A #GESTrack + line="1187">A #GESTrack The element to add + line="1188">The element to add @@ -18307,7 +18687,7 @@ Note that a #GESTrackElement can only be added to one track. Commits all the pending changes for the elements contained in the + line="1411">Commits all the pending changes for the elements contained in the track. When changes are made to the timing or priority of elements within a @@ -18324,7 +18704,7 @@ tracks, so you are unlikely to need to use this directly. %TRUE if pending changes were committed, or %FALSE if nothing + line="1429">%TRUE if pending changes were committed, or %FALSE if nothing needed to be committed. @@ -18332,7 +18712,7 @@ needed to be committed. A #GESTrack + line="1413">A #GESTrack @@ -18342,19 +18722,19 @@ needed to be committed. glib:get-property="caps"> Get the #GESTrack:caps of the track. + line="1360">Get the #GESTrack:caps of the track. The caps of @track. + line="1366">The caps of @track. A #GESTrack + line="1362">A #GESTrack @@ -18362,14 +18742,14 @@ needed to be committed. Gets the track elements contained in the track. The returned list is + line="1292">Gets the track elements contained in the track. The returned list is sorted by the element's #GESTimelineElement:priority and #GESTimelineElement:start. A list of + line="1300">A list of all the #GESTrackElement-s in @track. @@ -18379,7 +18759,7 @@ all the #GESTrackElement-s in @track. A #GESTrack + line="1294">A #GESTrack @@ -18389,19 +18769,19 @@ all the #GESTrackElement-s in @track. glib:get-property="mixing"> Gets the #GESTrack:mixing of the track. + line="1395">Gets the #GESTrack:mixing of the track. Whether @track is mixing. + line="1401">Whether @track is mixing. A #GESTrack + line="1397">A #GESTrack @@ -18412,19 +18792,19 @@ all the #GESTrackElement-s in @track. version="1.18"> Gets the #GESTrack:restriction-caps of the track. + line="1470">Gets the #GESTrack:restriction-caps of the track. The restriction-caps of @track. + line="1476">The restriction-caps of @track. A #GESTrack + line="1472">A #GESTrack @@ -18432,12 +18812,12 @@ all the #GESTrackElement-s in @track. Get the timeline this track belongs to. + line="1377">Get the timeline this track belongs to. The timeline that @track belongs to, or %NULL if + line="1383">The timeline that @track belongs to, or %NULL if it does not belong to a timeline. @@ -18445,7 +18825,7 @@ it does not belong to a timeline. A #GESTrack + line="1379">A #GESTrack @@ -18453,25 +18833,25 @@ it does not belong to a timeline. See ges_track_remove_element_full(), which also returns an error. + line="1345">See ges_track_remove_element_full(), which also returns an error. %TRUE if @object was successfully removed from @track. + line="1352">%TRUE if @object was successfully removed from @track. A #GESTrack + line="1347">A #GESTrack The element to remove + line="1348">The element to remove @@ -18482,26 +18862,26 @@ it does not belong to a timeline. throws="1"> Removes the given track element from the track, which revokes + line="1318">Removes the given track element from the track, which revokes ownership of the element. %TRUE if @object was successfully removed from @track. + line="1327">%TRUE if @object was successfully removed from @track. A #GESTrack + line="1320">A #GESTrack The element to remove + line="1321">The element to remove @@ -18511,7 +18891,7 @@ ownership of the element. introspectable="0"> Sets the function that will be used to create a #GstElement that can be + line="1444">Sets the function that will be used to create a #GstElement that can be used as a source to fill the gaps of the track. A gap is a timeline region where the track has no #GESTrackElement sources. Therefore, you are likely to want the #GstElement returned by the function to always @@ -18528,13 +18908,13 @@ function already set appropriately. A #GESTrack + line="1446">A #GESTrack The function to be used to create a source + line="1447">The function to be used to create a source #GstElement that can fill gaps in @track @@ -18546,7 +18926,7 @@ function already set appropriately. glib:set-property="mixing"> Sets the #GESTrack:mixing for the track. + line="1110">Sets the #GESTrack:mixing for the track. @@ -18555,13 +18935,13 @@ function already set appropriately. A #GESTrack + line="1112">A #GESTrack Whether @track should be mixing + line="1113">Whether @track should be mixing @@ -18571,7 +18951,7 @@ function already set appropriately. glib:set-property="restriction-caps"> Sets the #GESTrack:restriction-caps for the track. + line="1021">Sets the #GESTrack:restriction-caps for the track. > **NOTE**: Restriction caps are **not** taken into account when > using #GESPipeline:mode=#GES_PIPELINE_MODE_SMART_RENDER. @@ -18583,13 +18963,13 @@ function already set appropriately. A #GESTrack + line="1023">A #GESTrack The new restriction-caps for @track + line="1024">The new restriction-caps for @track @@ -18597,7 +18977,7 @@ function already set appropriately. Informs the track that it belongs to the given timeline. Calling this + line="956">Informs the track that it belongs to the given timeline. Calling this does not actually add the track to the timeline. For that, you should use ges_timeline_add_track(), which will also take care of informing the track that it belongs to the timeline. As such, there is no need @@ -18610,7 +18990,7 @@ for you to call this method. A #GESTrack + line="958">A #GESTrack @timeline (nullable): A #GESTimeline @@ -18623,7 +19003,7 @@ for you to call this method. c:identifier="ges_track_update_restriction_caps"> Updates the #GESTrack:restriction-caps of the track using the fields + line="1055">Updates the #GESTrack:restriction-caps of the track using the fields found in the given caps. Each of the #GstStructure-s in @caps is compared against the existing structure with the same index in the current #GESTrack:restriction-caps. If there is no corresponding @@ -18647,13 +19027,13 @@ width=400". A #GESTrack + line="1057">A #GESTrack The caps to update the restriction-caps with + line="1058">The caps to update the restriction-caps with @@ -18665,7 +19045,7 @@ width=400". getter="get_caps"> The capabilities used to choose the output of the #GESTrack's + line="711">The capabilities used to choose the output of the #GESTrack's elements. Internally, this is used to select output streams when several may be available, by determining whether its #GstPad is compatible (see #NleObject:caps for #nlecomposition). As such, @@ -18689,7 +19069,7 @@ Default value: #GST_CAPS_ANY. default-value="1000000000"> Current duration of the track + line="758">Current duration of the track Default value: O @@ -18701,7 +19081,7 @@ Default value: O default-value="NULL"> The #nlecomposition:id of the underlying #nlecomposition. + line="805">The #nlecomposition:id of the underlying #nlecomposition. default-value="TRUE"> Whether the track should support the mixing of #GESLayer data, such + line="790">Whether the track should support the mixing of #GESLayer data, such as composing the video data of each layer (when part of the video data is transparent, the next layer will become visible) or adding together the audio data. As such, for audio and video tracks, you'll @@ -18727,7 +19107,7 @@ likely want to keep this set to %TRUE. getter="get_restriction_caps"> The capabilities that specifies the final output format of the + line="738">The capabilities that specifies the final output format of the #GESTrack. For example, for a video track, it would specify the height, width, framerate and other properties of the stream. @@ -18745,7 +19125,7 @@ Default value: #GST_CAPS_ANY. default-value="GES_TRACK_TYPE_CUSTOM"> The track type of the track. This controls the type of + line="773">The track type of the track. This controls the type of #GESTrackElement-s that can be added to the track. This should match with the track's #GESTrack:caps. @@ -18773,7 +19153,7 @@ this. This signal will be emitted once the changes initiated by + line="845">This signal will be emitted once the changes initiated by ges_track_commit() have been executed in the backend. In particular, this will be emitted whenever the underlying #nlecomposition has been committed (see #nlecomposition::commited). @@ -18784,7 +19164,7 @@ committed (see #nlecomposition::commited). Will be emitted after a track element is added to the track. + line="821">Will be emitted after a track element is added to the track. @@ -18792,7 +19172,7 @@ committed (see #nlecomposition::commited). The element that was added + line="824">The element that was added @@ -18800,7 +19180,7 @@ committed (see #nlecomposition::commited). Will be emitted after a track element is removed from the track. + line="833">Will be emitted after a track element is removed from the track. @@ -18808,7 +19188,7 @@ committed (see #nlecomposition::commited). The element that was removed + line="836">The element that was removed @@ -18978,7 +19358,7 @@ instead deprecated-version="1.14"> Looks up which @element and @pspec would be effected by the given @name. If various + line="1372">Looks up which @element and @pspec would be effected by the given @name. If various contained elements have this property name you will get the first one, unless you specify the class name in @name. Use #ges_timeline_element_lookup_child @@ -18986,7 +19366,7 @@ specify the class name in @name. TRUE if @element and @pspec could be found. FALSE otherwise. In that + line="1389">TRUE if @element and @pspec could be found. FALSE otherwise. In that case the values for @pspec and @element are not modified. Unref @element after usage. @@ -18995,13 +19375,13 @@ usage. Object to lookup the property in + line="1374">Object to lookup the property in Name of the property to look up. You can specify the name of the + line="1375">Name of the property to look up. You can specify the name of the class as such: "ClassName::property-name", to guarantee that you get the proper GParamSpec in case various GstElement-s contain the same property name. If you don't do so, you will get the first element found, having @@ -19016,7 +19396,7 @@ usage. allow-none="1"> pointer to a #GstElement that + line="1380">pointer to a #GstElement that takes the real object to set property on @@ -19028,7 +19408,7 @@ usage. allow-none="1"> pointer to take the specification + line="1382">pointer to take the specification describing the property @@ -19038,7 +19418,7 @@ usage. c:identifier="ges_track_element_add_children_props"> Adds all the properties of a #GstElement that match the criteria as + line="1127">Adds all the properties of a #GstElement that match the criteria as children properties of the track element. If the name of @element's #GstElementFactory is not in @blacklist, and the factory's #GST_ELEMENT_METADATA_KLASS contains at least one member of @@ -19056,13 +19436,13 @@ This is intended to be used by subclasses when constructing. A #GESTrackElement + line="1129">A #GESTrackElement The child object to retrieve properties from + line="1130">The child object to retrieve properties from allow-none="1"> + line="1131"> An array of element factory "klass" categories to whitelist, or %NULL to accept all categories @@ -19084,7 +19464,7 @@ to accept all categories allow-none="1"> A + line="1134">A blacklist of element factory names, or %NULL to not blacklist any element factory @@ -19097,7 +19477,7 @@ element factory allow-none="1"> A + line="1137">A whitelist of element property names, or %NULL to whitelist all writeable properties @@ -19111,7 +19491,7 @@ writeable properties version="1.18"> Clamp the #GstTimedValueControlSource for the specified child property + line="1997">Clamp the #GstTimedValueControlSource for the specified child property to lie between the #GESTimelineElement:in-point and out-point of the element. The out-point is the #GES_TIMELINE_ELEMENT_END of the element translated from the timeline coordinates to the internal source @@ -19130,13 +19510,13 @@ in-point and out-point times, a new interpolated value will be placed. A #GESTrackElement + line="1999">A #GESTrackElement The name of the child property to clamp the control + line="2000">The name of the child property to clamp the control source of @@ -19148,21 +19528,21 @@ source of deprecated-version="1.18"> Edits the element within its track. + line="1783">Edits the element within its track. use #ges_timeline_element_edit instead. %TRUE if the edit of @object completed, %FALSE on failure. + line="1796">%TRUE if the edit of @object completed, %FALSE on failure. The #GESTrackElement to edit + line="1785">The #GESTrackElement to edit allow-none="1"> A whitelist of layers + line="1786">A whitelist of layers where the edit can be performed, %NULL allows all layers in the timeline @@ -19181,19 +19561,19 @@ timeline The edit mode + line="1789">The edit mode The edge of @object where the edit should occur + line="1790">The edge of @object where the edit should occur The edit position: a new location for the edge of @object + line="1791">The edit position: a new location for the edge of @object (in nanoseconds) @@ -19203,7 +19583,7 @@ timeline c:identifier="ges_track_element_get_all_control_bindings"> Get all the control bindings that have been created for the children + line="1243">Get all the control bindings that have been created for the children properties of the track element using ges_track_element_set_control_source(). The keys used in the returned hash table are the child property names that were passed to @@ -19213,7 +19593,7 @@ corresponding created #GstControlBinding. A + line="1254">A hash table containing all child-property-name/control-binding pairs for @trackelement. @@ -19225,7 +19605,7 @@ for @trackelement. A #GESTrackElement + line="1245">A #GESTrackElement @@ -19236,12 +19616,12 @@ for @trackelement. version="1.18"> Gets #GESTrackElement:auto-clamp-control-sources. + line="2074">Gets #GESTrackElement:auto-clamp-control-sources. Whether the control sources for the child properties of + line="2080">Whether the control sources for the child properties of @object are automatically clamped. @@ -19249,7 +19629,7 @@ for @trackelement. A #GESTrackElement + line="2076">A #GESTrackElement @@ -19260,7 +19640,7 @@ for @trackelement. deprecated="1"> Gets properties of a child of @object. + line="1519">Gets properties of a child of @object. Use #ges_timeline_element_get_child_properties @@ -19271,19 +19651,19 @@ for @trackelement. The origin #GESTrackElement + line="1521">The origin #GESTrackElement The name of the first property to get + line="1522">The name of the first property to get return location for the first property, followed optionally by more + line="1523">return location for the first property, followed optionally by more name/return location pairs, followed by NULL @@ -19295,7 +19675,7 @@ name/return location pairs, followed by NULL deprecated="1"> In general, a copy is made of the property contents and + line="1586">In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset(). @@ -19310,20 +19690,20 @@ is much more convenient for C programming. %TRUE if the property was found, %FALSE otherwise. + line="1603">%TRUE if the property was found, %FALSE otherwise. The origin #GESTrackElement + line="1588">The origin #GESTrackElement The name of the property + line="1589">The name of the property transfer-ownership="none"> return location for the property value, it will + line="1590">return location for the property value, it will be initialized if it is initialized with 0 @@ -19344,7 +19724,7 @@ be initialized if it is initialized with 0 deprecated="1"> Gets a property of a child of @object. + line="1544">Gets a property of a child of @object. Use #ges_timeline_element_get_child_property_by_pspec @@ -19354,13 +19734,13 @@ be initialized if it is initialized with 0 A #GESTrackElement + line="1546">A #GESTrackElement The #GParamSpec that specifies the property you want to get + line="1547">The #GParamSpec that specifies the property you want to get transfer-ownership="none"> return location for the value + line="1548">return location for the value @@ -19380,7 +19760,7 @@ be initialized if it is initialized with 0 deprecated="1"> Gets a property of a child of @object. If there are various child elements + line="1475">Gets a property of a child of @object. If there are various child elements that have the same property name, you can distinguish them using the following syntax: 'ClasseName::property_name' as property name. If you don't, the corresponding property of the first element found will be set. @@ -19394,19 +19774,19 @@ corresponding property of the first element found will be set. The #GESTrackElement parent object + line="1477">The #GESTrackElement parent object The name of the first property to get + line="1478">The name of the first property to get Value for the first property, followed optionally by more + line="1479">Value for the first property, followed optionally by more name/return location pairs, followed by NULL @@ -19416,7 +19796,7 @@ name/return location pairs, followed by NULL c:identifier="ges_track_element_get_control_binding"> Gets the control binding that was created for the specified child + line="1964">Gets the control binding that was created for the specified child property of the track element using ges_track_element_set_control_source(). The given @property_name must be the same name of the child property that was passed to @@ -19425,7 +19805,7 @@ ges_track_element_set_control_source(). The control binding that was + line="1976">The control binding that was created for the specified child property of @object, or %NULL if @property_name does not correspond to any control binding. @@ -19434,13 +19814,13 @@ created for the specified child property of @object, or %NULL if A #GESTrackElement + line="1966">A #GESTrackElement The name of the child property to return the control + line="1967">The name of the child property to return the control binding of @@ -19449,13 +19829,13 @@ binding of Get the #GstElement that the track element's underlying nleobject + line="1319">Get the #GstElement that the track element's underlying nleobject controls. The #GstElement being controlled by the + line="1326">The #GstElement being controlled by the nleobject that @object wraps. @@ -19463,7 +19843,7 @@ nleobject that @object wraps. A #GESTrackElement + line="1321">A #GESTrackElement @@ -19473,21 +19853,21 @@ nleobject that @object wraps. deprecated="1"> Get the GNonLin object this object is controlling. + line="1283">Get the GNonLin object this object is controlling. use #ges_track_element_get_nleobject instead. The GNonLin object this object is controlling. + line="1289">The GNonLin object this object is controlling. A #GESTrackElement + line="1285">A #GESTrackElement @@ -19497,19 +19877,19 @@ nleobject that @object wraps. version="1.6"> Get the nleobject that this element wraps. + line="1301">Get the nleobject that this element wraps. The nleobject that @object wraps. + line="1307">The nleobject that @object wraps. A #GESTrackElement + line="1303">A #GESTrackElement @@ -19519,12 +19899,12 @@ nleobject that @object wraps. glib:get-property="track"> Get the #GESTrackElement:track for the element. + line="1266">Get the #GESTrackElement:track for the element. The track that @object belongs to, + line="1272">The track that @object belongs to, or %NULL if it does not belong to a track. @@ -19532,7 +19912,7 @@ or %NULL if it does not belong to a track. A #GESTrackElement + line="1268">A #GESTrackElement @@ -19542,19 +19922,19 @@ or %NULL if it does not belong to a track. glib:get-property="track-type"> Gets the #GESTrackElement:track-type for the element. + line="975">Gets the #GESTrackElement:track-type for the element. The track-type of @object. + line="981">The track-type of @object. A #GESTrackElement + line="977">A #GESTrackElement @@ -19564,19 +19944,19 @@ or %NULL if it does not belong to a track. version="1.18"> Gets #GESTrackElement:has-internal-source for the element. + line="1354">Gets #GESTrackElement:has-internal-source for the element. %TRUE if @object can have its 'internal time' properties set. + line="1360">%TRUE if @object can have its 'internal time' properties set. A #GESTrackElement + line="1356">A #GESTrackElement @@ -19584,19 +19964,19 @@ or %NULL if it does not belong to a track. Gets #GESTrackElement:active for the element. + line="1337">Gets #GESTrackElement:active for the element. %TRUE if @object is active in its track. + line="1343">%TRUE if @object is active in its track. A #GESTrackElement + line="1339">A #GESTrackElement @@ -19606,7 +19986,7 @@ or %NULL if it does not belong to a track. version="1.18"> Get whether the given track element is a core track element. That is, + line="2102">Get whether the given track element is a core track element. That is, it was created by the @create_track_elements #GESClipClass method for some #GESClip. @@ -19624,14 +20004,14 @@ will be a core child of its parent clip. %TRUE if @element is a core track element. + line="2121">%TRUE if @element is a core track element. A #GESTrackElement + line="2104">A #GESTrackElement @@ -19641,7 +20021,7 @@ will be a core child of its parent clip. deprecated="1"> Gets an array of #GParamSpec* for all configurable properties of the + line="1497">Gets an array of #GParamSpec* for all configurable properties of the children of @object. Use #ges_timeline_element_list_children_properties An array of #GParamSpec* which should be freed after use or + line="1505">An array of #GParamSpec* which should be freed after use or %NULL if something went wrong. @@ -19659,7 +20039,7 @@ children of @object. The #GESTrackElement to get the list of children properties from + line="1499">The #GESTrackElement to get the list of children properties from transfer-ownership="full"> return location for the length of the returned array + line="1500">return location for the length of the returned array @@ -19678,7 +20058,7 @@ children of @object. deprecated="1"> Looks up which @element and @pspec would be effected by the given @name. If various + line="1372">Looks up which @element and @pspec would be effected by the given @name. If various contained elements have this property name you will get the first one, unless you specify the class name in @name. Use #ges_timeline_element_lookup_child @@ -19687,7 +20067,7 @@ specify the class name in @name. TRUE if @element and @pspec could be found. FALSE otherwise. In that + line="1389">TRUE if @element and @pspec could be found. FALSE otherwise. In that case the values for @pspec and @element are not modified. Unref @element after usage. @@ -19696,13 +20076,13 @@ usage. Object to lookup the property in + line="1374">Object to lookup the property in Name of the property to look up. You can specify the name of the + line="1375">Name of the property to look up. You can specify the name of the class as such: "ClassName::property-name", to guarantee that you get the proper GParamSpec in case various GstElement-s contain the same property name. If you don't do so, you will get the first element found, having @@ -19717,7 +20097,7 @@ usage. allow-none="1"> pointer to a #GstElement that + line="1380">pointer to a #GstElement that takes the real object to set property on @@ -19729,7 +20109,7 @@ usage. allow-none="1"> pointer to take the specification + line="1382">pointer to take the specification describing the property @@ -19739,7 +20119,7 @@ usage. c:identifier="ges_track_element_remove_control_binding"> Removes the #GstControlBinding that was created for the specified child + line="1810">Removes the #GstControlBinding that was created for the specified child property of the track element using ges_track_element_set_control_source(). The given @property_name must be the same name of the child property that was passed to @@ -19748,7 +20128,7 @@ ges_track_element_set_control_source(). %TRUE if the control binding was removed from the specified + line="1822">%TRUE if the control binding was removed from the specified child property of @object, or %FALSE if an error occurred. @@ -19756,13 +20136,13 @@ child property of @object, or %FALSE if an error occurred. A #GESTrackElement + line="1812">A #GESTrackElement The name of the child property to remove the control + line="1813">The name of the child property to remove the control binding from @@ -19773,25 +20153,25 @@ binding from glib:set-property="active"> Sets #GESTrackElement:active for the element. + line="854">Sets #GESTrackElement:active for the element. %TRUE if the property was *toggled*. + line="861">%TRUE if the property was *toggled*. A #GESTrackElement + line="856">A #GESTrackElement Whether @object should be active in its track + line="857">Whether @object should be active in its track @@ -19802,7 +20182,7 @@ binding from version="1.18"> Sets #GESTrackElement:auto-clamp-control-sources. If set to %TRUE, this + line="2045">Sets #GESTrackElement:auto-clamp-control-sources. If set to %TRUE, this will immediately clamp all the control sources. @@ -19812,13 +20192,13 @@ will immediately clamp all the control sources. A #GESTrackElement + line="2047">A #GESTrackElement Whether to automatically clamp the control sources for the + line="2048">Whether to automatically clamp the control sources for the child properties of @object @@ -19830,7 +20210,7 @@ child properties of @object deprecated="1"> Sets a property of a child of @object. If there are various child elements + line="1447">Sets a property of a child of @object. If there are various child elements that have the same property name, you can distinguish them using the following syntax: 'ClasseName::property_name' as property name. If you don't, the corresponding property of the first element found will be set. @@ -19844,19 +20224,19 @@ corresponding property of the first element found will be set. The #GESTrackElement parent object + line="1449">The #GESTrackElement parent object The name of the first property to set + line="1450">The name of the first property to set value for the first property, followed optionally by more + line="1451">value for the first property, followed optionally by more name/return location pairs, followed by NULL @@ -19868,7 +20248,7 @@ name/return location pairs, followed by NULL deprecated="1"> Sets a property of a GstElement contained in @object. + line="1562">Sets a property of a GstElement contained in @object. Note that #ges_track_element_set_child_property is really intended for language bindings, #ges_track_element_set_child_properties @@ -19879,26 +20259,26 @@ is much more convenient for C programming. %TRUE if the property was set, %FALSE otherwise. + line="1574">%TRUE if the property was set, %FALSE otherwise. The origin #GESTrackElement + line="1564">The origin #GESTrackElement The name of the property + line="1565">The name of the property The value + line="1566">The value @@ -19909,7 +20289,7 @@ is much more convenient for C programming. deprecated="1"> Sets a property of a child of @object. + line="1403">Sets a property of a child of @object. Use #ges_timeline_element_set_child_property_by_spec @@ -19920,19 +20300,19 @@ is much more convenient for C programming. A #GESTrackElement + line="1405">A #GESTrackElement The #GParamSpec that specifies the property you want to set + line="1406">The #GParamSpec that specifies the property you want to set The value + line="1407">The value @@ -19943,7 +20323,7 @@ is much more convenient for C programming. deprecated="1"> Sets a property of a child of @object. If there are various child elements + line="1425">Sets a property of a child of @object. If there are various child elements that have the same property name, you can distinguish them using the following syntax: 'ClasseName::property_name' as property name. If you don't, the corresponding property of the first element found will be set. @@ -19957,19 +20337,19 @@ corresponding property of the first element found will be set. The #GESTrackElement parent object + line="1427">The #GESTrackElement parent object The name of the first property to set + line="1428">The name of the first property to set Value for the first property, followed optionally by more + line="1429">Value for the first property, followed optionally by more name/return location pairs, followed by NULL @@ -19979,7 +20359,7 @@ name/return location pairs, followed by NULL c:identifier="ges_track_element_set_control_source"> Creates a #GstControlBinding for the specified child property of the + line="1861">Creates a #GstControlBinding for the specified child property of the track element using the given control source. The given @property_name should refer to an existing child property of the track element, as used in ges_timeline_element_lookup_child(). @@ -19992,7 +20372,7 @@ gst_direct_control_binding_new_absolute() instead. %TRUE if the specified child property could be bound to + line="1879">%TRUE if the specified child property could be bound to @source, or %FALSE if an error occurred. @@ -20000,25 +20380,25 @@ gst_direct_control_binding_new_absolute() instead. A #GESTrackElement + line="1863">A #GESTrackElement The control source to bind the child property to + line="1864">The control source to bind the child property to The name of the child property to control + line="1865">The name of the child property to control The type of binding to create ("direct" or + line="1866">The type of binding to create ("direct" or "direct-absolute") @@ -20030,7 +20410,7 @@ gst_direct_control_binding_new_absolute() instead. version="1.18"> Sets #GESTrackElement:has-internal-source for the element. If this is + line="900">Sets #GESTrackElement:has-internal-source for the element. If this is set to %FALSE, this method will also set the #GESTimelineElement:in-point of the element to 0 and its #GESTimelineElement:max-duration to #GST_CLOCK_TIME_NONE. @@ -20038,7 +20418,7 @@ set to %FALSE, this method will also set the %FALSE if @has_internal_source is forbidden for @object and + line="911">%FALSE if @has_internal_source is forbidden for @object and %TRUE in any other case. @@ -20046,13 +20426,13 @@ set to %FALSE, this method will also set the A #GESTrackElement + line="902">A #GESTrackElement Whether the @object should be allowed to have its + line="903">Whether the @object should be allowed to have its 'internal time' properties set. @@ -20063,7 +20443,7 @@ set to %FALSE, this method will also set the glib:set-property="track-type"> Sets the #GESTrackElement:track-type for the element. + line="957">Sets the #GESTrackElement:track-type for the element. @@ -20072,13 +20452,13 @@ set to %FALSE, this method will also set the A #GESTrackElement + line="959">A #GESTrackElement The new track-type for @object + line="960">The new track-type for @object @@ -20090,7 +20470,7 @@ set to %FALSE, this method will also set the default-value="TRUE"> Whether the effect of the element should be applied in its + line="351">Whether the effect of the element should be applied in its #GESTrackElement:track. If set to %FALSE, it will not be used in the output of the track. @@ -20104,7 +20484,7 @@ the output of the track. default-value="TRUE"> Whether the control sources on the element (see + line="437">Whether the control sources on the element (see ges_track_element_set_control_source()) will be automatically updated whenever the #GESTimelineElement:in-point or out-point of the element change in value. @@ -20123,7 +20503,7 @@ Default value: %TRUE default-value="FALSE"> This property is used to determine whether the 'internal time' + line="390">This property is used to determine whether the 'internal time' properties of the element have any meaning. In particular, unless this is set to %TRUE, the #GESTimelineElement:in-point and #GESTimelineElement:max-duration can not be set to any value other @@ -20162,7 +20542,7 @@ effects). The track that this element belongs to, or %NULL if it does not + line="379">The track that this element belongs to, or %NULL if it does not belong to a track. @@ -20175,7 +20555,7 @@ belong to a track. default-value="GES_TRACK_TYPE_UNKNOWN"> The track type of the element, which determines the type of track the + line="364">The track type of the element, which determines the type of track the element can be added to (see #GESTrack:track-type). This should correspond to the type of data that the element can produce or process. @@ -20201,7 +20581,7 @@ process. This is emitted when a control binding is added to a child property + line="461">This is emitted when a control binding is added to a child property of the track element. @@ -20210,7 +20590,7 @@ of the track element. The control binding that has been added + line="464">The control binding that has been added @@ -20218,7 +20598,7 @@ of the track element. This is emitted when a control binding is removed from a child + line="474">This is emitted when a control binding is removed from a child property of the track element. @@ -20227,7 +20607,7 @@ property of the track element. The control binding that has been removed + line="477">The control binding that has been removed @@ -20554,7 +20934,7 @@ controls. TRUE if @element and @pspec could be found. FALSE otherwise. In that + line="1389">TRUE if @element and @pspec could be found. FALSE otherwise. In that case the values for @pspec and @element are not modified. Unref @element after usage. @@ -20563,13 +20943,13 @@ usage. Object to lookup the property in + line="1374">Object to lookup the property in Name of the property to look up. You can specify the name of the + line="1375">Name of the property to look up. You can specify the name of the class as such: "ClassName::property-name", to guarantee that you get the proper GParamSpec in case various GstElement-s contain the same property name. If you don't do so, you will get the first element found, having @@ -20584,7 +20964,7 @@ usage. allow-none="1"> pointer to a #GstElement that + line="1380">pointer to a #GstElement that takes the real object to set property on @@ -20596,7 +20976,7 @@ usage. allow-none="1"> pointer to take the specification + line="1382">pointer to take the specification describing the property @@ -20882,7 +21262,7 @@ the URI points to a file of some type. Creates a new #GESUriClip for the provided @uri. + line="594">Creates a new #GESUriClip for the provided @uri. > **WARNING**: This function might 'discover` @uri **synchrounously**, it is > an IO and processing intensive task that you probably don't want to run in @@ -20892,7 +21272,7 @@ the URI points to a file of some type. The newly created #GESUriClip, or + line="605">The newly created #GESUriClip, or %NULL if there was an error. @@ -20900,7 +21280,7 @@ the URI points to a file of some type. the URI the source should control + line="596">the URI the source should control @@ -20910,19 +21290,19 @@ the URI points to a file of some type. glib:get-property="uri"> Get the location of the resource. + line="548">Get the location of the resource. The location of the resource. + line="554">The location of the resource. the #GESUriClip + line="550">the #GESUriClip @@ -20930,19 +21310,19 @@ the URI points to a file of some type. Lets you know if @self is an image or not. + line="534">Lets you know if @self is an image or not. %TRUE if @self is a still image %FALSE otherwise. + line="540">%TRUE if @self is a still image %FALSE otherwise. the #GESUriClip + line="536">the #GESUriClip @@ -20950,19 +21330,19 @@ the URI points to a file of some type. Lets you know if the audio track of @self is muted or not. + line="520">Lets you know if the audio track of @self is muted or not. %TRUE if the audio track of @self is muted, %FALSE otherwise. + line="526">%TRUE if the audio track of @self is muted, %FALSE otherwise. the #GESUriClip + line="522">the #GESUriClip @@ -20972,7 +21352,7 @@ the URI points to a file of some type. glib:set-property="is-image"> Sets whether the clip is a still image or not. + line="507">Sets whether the clip is a still image or not. @@ -20981,13 +21361,13 @@ the URI points to a file of some type. the #GESUriClip + line="509">the #GESUriClip %TRUE if @self is a still image, %FALSE otherwise + line="510">%TRUE if @self is a still image, %FALSE otherwise @@ -20997,7 +21377,7 @@ the URI points to a file of some type. glib:set-property="mute"> Sets whether the audio track of this clip is muted or not. + line="463">Sets whether the audio track of this clip is muted or not. @@ -21006,13 +21386,13 @@ the URI points to a file of some type. the #GESUriClip on which to mute or unmute the audio track + line="465">the #GESUriClip on which to mute or unmute the audio track %TRUE to mute @self audio track, %FALSE to unmute it + line="466">%TRUE to mute @self audio track, %FALSE to unmute it @@ -21273,12 +21653,12 @@ are different as those can be extended 'infinitely'. c:identifier="ges_uri_clip_asset_get_stream_assets"> Get the GESUriSourceAsset @self containes + line="724">Get the GESUriSourceAsset @self containes a + line="730">a #GList of #GESUriSourceAsset @@ -21288,7 +21668,7 @@ are different as those can be extended 'infinitely'. A #GESUriClipAsset + line="726">A #GESUriClipAsset @@ -21469,19 +21849,19 @@ by #GESUriClipAsset-s. c:identifier="ges_uri_source_asset_get_filesource_asset"> Get the #GESUriClipAsset @self is contained in + line="842">Get the #GESUriClipAsset @self is contained in a #GESUriClipAsset + line="848">a #GESUriClipAsset A #GESUriClipAsset + line="844">A #GESUriClipAsset @@ -21490,12 +21870,12 @@ by #GESUriClipAsset-s. c:identifier="ges_uri_source_asset_get_stream_info"> Get the #GstDiscovererStreamInfo user by @asset + line="818">Get the #GstDiscovererStreamInfo user by @asset a #GESUriClipAsset + line="824">a #GESUriClipAsset @@ -21503,7 +21883,7 @@ by #GESUriClipAsset-s. A #GESUriClipAsset + line="820">A #GESUriClipAsset @@ -21525,12 +21905,12 @@ by #GESUriClipAsset-s. version="1.18"> Check if @asset contains a single image + line="858">Check if @asset contains a single image %TRUE if the video stream corresponds to an image (i.e. only + line="864">%TRUE if the video stream corresponds to an image (i.e. only contains one frame) @@ -21538,7 +21918,7 @@ contains one frame) A #GESUriClipAsset + line="860">A #GESUriClipAsset @@ -21579,15 +21959,15 @@ contains one frame) - + - + - + @@ -21610,7 +21990,7 @@ contains one frame) version="1.18"> Retrieves the natural size of the video stream. The natural size, is + line="277">Retrieves the natural size of the video stream. The natural size, is the size at which it will be displayed if no scaling is being applied. NOTE: The sources take into account the potential video rotation applied @@ -21621,14 +22001,14 @@ account. %TRUE if the object has a natural size, %FALSE otherwise. + line="291">%TRUE if the object has a natural size, %FALSE otherwise. A #GESVideoSource + line="279">A #GESVideoSource transfer-ownership="full"> The natural width of the underlying source + line="280">The natural width of the underlying source transfer-ownership="full"> The natural height of the underlying source + line="281">The natural height of the underlying source @@ -21671,6 +22051,12 @@ account. + method to return the GstElement to put in the source topbin. +Other elements will be queued, like a videoscale. +In the case of a VideoUriSource, for example, the subclass will return a decodebin, +and we will append a videoscale. @@ -23125,10 +23511,32 @@ for later use. + + Attaches positioning metadata to a #GstBuffer. + + + a pointer to the added #GESFrameCompositionMeta. + + + + + #GstBuffer to which protection metadata should be added. + + + + Clean up any resources created by GES in ges_init(). + line="215">Clean up any resources created by GES in ges_init(). It is normally not needed to call this function in a normal application as the resources will automatically be freed when the program terminates. @@ -23136,7 +23544,7 @@ This function is therefore mostly used by testsuites and other memory profiling This function should be called from the thread where ges_init() was called. After this call GES should not be used until another ges_init() call. - + @@ -23189,14 +23597,14 @@ After this call GES should not be used until another ges_init() call. version="1.18"> Get the best formatter for @uri. It tries to find a formatter + line="772">Get the best formatter for @uri. It tries to find a formatter compatible with @uri extension, if none is found, it returns the default formatter asset. The #GESAsset for the best formatter to save to @uri + line="779">The #GESAsset for the best formatter to save to @uri @@ -23205,6 +23613,14 @@ formatter asset. + + + + + + + Initialize the GStreamer Editing Service. Call this before any usage of + line="188">Initialize the GStreamer Editing Service. Call this before any usage of GES. You should take care of initilizing GStreamer before calling this function. @@ -23255,7 +23671,7 @@ MT safety. GStreamer Editing Services do not guarantee MT safety. An application is required to use GES APIs (including ges_deinit()) in the thread where ges_init() was called. - + @@ -23263,16 +23679,16 @@ in the thread where ges_init() was called. Initializes the GStreamer Editing Services library, setting up internal path lists, + line="360">Initializes the GStreamer Editing Services library, setting up internal path lists, and loading evrything needed. This function will return %FALSE if GES could not be initialized for some reason. - + %TRUE if GES could be initialized. + line="372">%TRUE if GES could be initialized. @@ -23284,7 +23700,7 @@ for some reason. allow-none="1"> pointer to application's argc + line="362">pointer to application's argc allow-none="1"> pointer to application's argv + line="363">pointer to application's argv @@ -23307,7 +23723,7 @@ for some reason. introspectable="0"> Returns a #GOptionGroup with GES's argument specifications. The + line="286">Returns a #GOptionGroup with GES's argument specifications. The group is set up to use standard GOption callbacks, so when using this group in combination with GOption parsing methods, all argument parsing and initialization is automated. @@ -23319,11 +23735,11 @@ If you use this function, you should make sure you initialise the GStreamer as one of the very first things in your program. That means you need to use gst_init_get_option_group() and add it to the option context before using the ges_init_get_option_group() result. - + a pointer to GES's option group. + line="302">a pointer to GES's option group. @@ -23332,20 +23748,20 @@ using the ges_init_get_option_group() result. version="1.16"> Use this function to check if GES has been initialized with ges_init() + line="413">Use this function to check if GES has been initialized with ges_init() or ges_init_check(). - + %TRUE if initialization has been done, %FALSE otherwise. + line="419">%TRUE if initialization has been done, %FALSE otherwise. List all the assets in the current cache whose + line="1630">List all the assets in the current cache whose #GESAsset:extractable-type are of the given type (including subclasses). @@ -23356,7 +23772,7 @@ the current cache. A list of all + line="1642">A list of all #GESAsset-s currently in the cache whose #GESAsset:extractable-type is of the @filter type. @@ -23367,7 +23783,7 @@ of the @filter type. The type of object that can be extracted from the asset + line="1632">The type of object that can be extracted from the asset @@ -23468,7 +23884,7 @@ of the @filter type. - + @@ -23476,8 +23892,8 @@ of the @filter type. Gets the version number of the GStreamer Editing Services library. - + line="337">Gets the version number of the GStreamer Editing Services library. + @@ -23488,7 +23904,7 @@ of the @filter type. transfer-ownership="full"> pointer to a guint to store the major version number + line="339">pointer to a guint to store the major version number transfer-ownership="full"> pointer to a guint to store the minor version number + line="340">pointer to a guint to store the minor version number transfer-ownership="full"> pointer to a guint to store the micro version number + line="341">pointer to a guint to store the micro version number transfer-ownership="full"> pointer to a guint to store the nano version number + line="342">pointer to a guint to store the nano version number diff --git a/girs/GIRepository-3.0.gir b/girs/GIRepository-3.0.gir index 182855e4a..ee6928c35 100644 --- a/girs/GIRepository-3.0.gir +++ b/girs/GIRepository-3.0.gir @@ -5673,17 +5673,34 @@ It is possible to control the search paths programmatically, using [method@GIRepository.Repository.prepend_search_path]. It is also possible to modify the search paths by using the `GI_TYPELIB_PATH` environment variable. The environment variable takes precedence over the default search path -and the [method@GIRepository.Repository.prepend_search_path] calls. +and the [method@GIRepository.Repository.prepend_search_path] calls. + +### Namespace ordering + +In situations where namespaces may be searched in order, or returned in a +list, the namespaces will be returned in alphabetical order, with all fully +loaded namespaces being returned before any lazily loaded ones (those loaded +with `GI_REPOSITORY_LOAD_FLAG_LAZY`). This allows for deterministic and +reproducible results. + +Similarly, if a symbol (such as a `GType` or error domain) is being searched +for in the set of loaded namespaces, the namespaces will be searched in that +order. In particular, this means that a symbol which exists in two namespaces +will always be returned from the alphabetically-higher namespace. This should +only happen in the case of `Gio` and `GioUnix`/`GioWin32`, which all refer to +the same `.so` file and expose overlapping sets of symbols. Symbols should +always end up being resolved to `GioUnix` or `GioWin32` if they are platform +dependent, rather than `Gio` itself. Create a new [class@GIRepository.Repository]. + line="847">Create a new [class@GIRepository.Repository]. a new [class@GIRepository.Repository] + line="852">a new [class@GIRepository.Repository] @@ -5735,7 +5752,7 @@ This function will overwrite the contents of the output file. version="2.80"> Obtain the option group for girepository. + line="2007">Obtain the option group for girepository. It’s used by the dumper and for programs that want to provide introspection information @@ -5743,7 +5760,7 @@ information the option group + line="2015">the option group @@ -5752,7 +5769,7 @@ information version="2.80"> Obtain an unordered list of versions (either currently loaded or + line="1725">Obtain an unordered list of versions (either currently loaded or available) for @namespace_ in this @repository. The list is guaranteed to be `NULL` terminated. The `NULL` terminator is not @@ -5761,7 +5778,7 @@ counted in @n_versions_out. the array of versions. + line="1737">the array of versions. @@ -5770,13 +5787,13 @@ counted in @n_versions_out. A #GIRepository + line="1727">A #GIRepository GI namespace, e.g. `Gtk` + line="1728">GI namespace, e.g. `Gtk` allow-none="1"> The number of versions returned. + line="1729">The number of versions returned. @@ -5797,7 +5814,7 @@ counted in @n_versions_out. version="2.80"> Searches for the enum type corresponding to the given [type@GLib.Error] + line="1104">Searches for the enum type corresponding to the given [type@GLib.Error] domain. Before calling this function for a particular namespace, you must call @@ -5807,7 +5824,7 @@ ensure the namespace has already been loaded. [class@GIRepository.EnumInfo] + line="1116">[class@GIRepository.EnumInfo] representing metadata about @domain’s enum type, or `NULL` if none found @@ -5815,13 +5832,13 @@ ensure the namespace has already been loaded. A #GIRepository + line="1106">A #GIRepository a [type@GLib.Error] domain + line="1107">a [type@GLib.Error] domain @@ -5831,7 +5848,7 @@ ensure the namespace has already been loaded. version="2.80"> Searches all loaded namespaces for a particular [type@GObject.Type]. + line="964">Searches all loaded namespaces for a particular [type@GObject.Type]. Note that in order to locate the metadata, the namespace corresponding to the type must first have been loaded. There is currently no @@ -5842,7 +5859,7 @@ reliably when you know the [type@GObject.Type] is from a loaded namespace. [class@GIRepository.BaseInfo] + line="977">[class@GIRepository.BaseInfo] representing metadata about @type, or `NULL` if none found @@ -5850,13 +5867,13 @@ reliably when you know the [type@GObject.Type] is from a loaded namespace. A #GIRepository + line="966">A #GIRepository [type@GObject.Type] to search for + line="967">[type@GObject.Type] to search for @@ -5866,7 +5883,7 @@ reliably when you know the [type@GObject.Type] is from a loaded namespace. version="2.80"> Searches for a particular entry in a namespace. + line="1043">Searches for a particular entry in a namespace. Before calling this function for a particular namespace, you must call [method@GIRepository.Repository.require] to load the namespace, or otherwise @@ -5875,7 +5892,7 @@ ensure the namespace has already been loaded. [class@GIRepository.BaseInfo] + line="1055">[class@GIRepository.BaseInfo] representing metadata about @name, or `NULL` if none found @@ -5883,19 +5900,19 @@ ensure the namespace has already been loaded. A #GIRepository + line="1045">A #GIRepository Namespace which will be searched + line="1046">Namespace which will be searched Entry name to find + line="1047">Entry name to find @@ -5905,7 +5922,7 @@ ensure the namespace has already been loaded. version="2.80"> This function returns the ‘C prefix’, or the C level namespace + line="1386">This function returns the ‘C prefix’, or the C level namespace associated with the given introspection namespace. Each C symbol starts with this prefix, as well each [type@GObject.Type] in @@ -5918,20 +5935,20 @@ function. C namespace prefix, or `NULL` if none associated + line="1401">C namespace prefix, or `NULL` if none associated A #GIRepository + line="1388">A #GIRepository Namespace to inspect + line="1389">Namespace to inspect @@ -5941,7 +5958,7 @@ function. version="2.80"> Retrieves all (transitive) versioned dependencies for + line="703">Retrieves all (transitive) versioned dependencies for @namespace_. The returned strings are of the form `namespace-version`. @@ -5959,7 +5976,7 @@ counted in @n_dependencies_out. String array of + line="725">String array of all versioned dependencies @@ -5969,13 +5986,13 @@ counted in @n_dependencies_out. A #GIRepository + line="705">A #GIRepository Namespace of interest + line="706">Namespace of interest allow-none="1"> Return location for the number of + line="707">Return location for the number of dependencies @@ -5997,7 +6014,7 @@ counted in @n_dependencies_out. version="2.80"> Return an array of the immediate versioned dependencies for @namespace_. + line="614">Return an array of the immediate versioned dependencies for @namespace_. Returned strings are of the form `namespace-version`. Note: @namespace_ must have already been loaded using a function @@ -6013,7 +6030,7 @@ counted in @n_dependencies_out. String array of + line="634">String array of immediate versioned dependencies @@ -6023,13 +6040,13 @@ counted in @n_dependencies_out. A #GIRepository + line="616">A #GIRepository Namespace of interest + line="617">Namespace of interest allow-none="1"> Return location for the number of + line="618">Return location for the number of dependencies @@ -6051,7 +6068,7 @@ counted in @n_dependencies_out. version="2.80"> This function returns a particular metadata entry in the + line="893">This function returns a particular metadata entry in the given namespace @namespace_. The namespace must have already been loaded before calling this function. @@ -6061,7 +6078,7 @@ of entries. It is an error to pass an invalid @idx to this function. [class@GIRepository.BaseInfo] + line="906">[class@GIRepository.BaseInfo] containing metadata @@ -6069,19 +6086,19 @@ of entries. It is an error to pass an invalid @idx to this function. A #GIRepository + line="895">A #GIRepository Namespace to inspect + line="896">Namespace to inspect 0-based offset into namespace metadata for entry + line="897">0-based offset into namespace metadata for entry @@ -6091,7 +6108,7 @@ of entries. It is an error to pass an invalid @idx to this function. version="2.80"> Returns the current search path [class@GIRepository.Repository] will use when + line="361">Returns the current search path [class@GIRepository.Repository] will use when loading shared libraries referenced by imported namespaces. The list is internal to [class@GIRepository.Repository] and should not be @@ -6103,7 +6120,7 @@ counted in @n_paths_out. list of search paths, most + line="375">list of search paths, most important first @@ -6113,7 +6130,7 @@ counted in @n_paths_out. A #GIRepository + line="363">A #GIRepository allow-none="1"> The number of library paths returned. + line="364">The number of library paths returned. @@ -6134,7 +6151,7 @@ counted in @n_paths_out. version="2.80"> Return the list of currently loaded namespaces. + line="1247">Return the list of currently loaded namespaces. The list is guaranteed to be `NULL` terminated. The `NULL` terminator is not counted in @n_namespaces_out. @@ -6142,7 +6159,7 @@ counted in @n_namespaces_out. + line="1258"> list of namespaces @@ -6152,7 +6169,7 @@ counted in @n_namespaces_out. A #GIRepository + line="1249">A #GIRepository allow-none="1"> Return location for the number of + line="1250">Return location for the number of namespaces @@ -6174,7 +6191,7 @@ counted in @n_namespaces_out. version="2.80"> This function returns the number of metadata entries in + line="861">This function returns the number of metadata entries in given namespace @namespace_. The namespace must have already been loaded before calling this function. @@ -6182,20 +6199,20 @@ The namespace must have already been loaded before calling this function. number of metadata entries + line="871">number of metadata entries A #GIRepository + line="863">A #GIRepository Namespace to inspect + line="864">Namespace to inspect @@ -6205,7 +6222,7 @@ The namespace must have already been loaded before calling this function. version="2.80"> Look up the implemented interfaces for @gtype. + line="1154">Look up the implemented interfaces for @gtype. This function cannot fail per se; but for a totally ‘unknown’ [type@GObject.Type], it may return 0 implemented interfaces. @@ -6226,13 +6243,13 @@ not statically. a #GIRepository + line="1156">a #GIRepository a [type@GObject.Type] whose fundamental type is `G_TYPE_OBJECT` + line="1157">a [type@GObject.Type] whose fundamental type is `G_TYPE_OBJECT` transfer-ownership="full"> Number of interfaces + line="1158">Number of interfaces transfer-ownership="none"> Interfaces for @gtype + line="1159">Interfaces for @gtype @@ -6262,7 +6279,7 @@ not statically. version="2.80"> Returns the current search path [class@GIRepository.Repository] will use when + line="289">Returns the current search path [class@GIRepository.Repository] will use when loading typelib files. The list is internal to [class@GIRepository.Repository] and should not be @@ -6274,7 +6291,7 @@ counted in @n_paths_out. list of search paths, most + line="303">list of search paths, most important first @@ -6284,7 +6301,7 @@ counted in @n_paths_out. A #GIRepository + line="291">A #GIRepository allow-none="1"> The number of search paths returned. + line="292">The number of search paths returned. @@ -6305,7 +6322,7 @@ counted in @n_paths_out. version="2.80"> This function returns an array of paths to the + line="1318">This function returns an array of paths to the shared C libraries associated with the given namespace @namespace_. There may be no shared library path associated, in which case this @@ -6324,7 +6341,7 @@ counted in @out_n_elements. Array of + line="1341">Array of paths to shared libraries, or `NULL` if none are associated @@ -6334,13 +6351,13 @@ counted in @out_n_elements. A #GIRepository + line="1320">A #GIRepository Namespace to inspect + line="1321">Namespace to inspect allow-none="1"> Return location for the number of elements + line="1322">Return location for the number of elements in the returned array @@ -6362,7 +6379,7 @@ counted in @out_n_elements. version="2.80"> If namespace @namespace_ is loaded, return the full path to the + line="1425">If namespace @namespace_ is loaded, return the full path to the .typelib file it was loaded from. If the typelib for namespace @namespace_ was included in a shared library, @@ -6371,7 +6388,7 @@ return the special string `<builtin>`. Filesystem path (or `<builtin>`) if + line="1436">Filesystem path (or `<builtin>`) if successful, `NULL` if namespace is not loaded @@ -6379,13 +6396,13 @@ return the special string `<builtin>`. A #GIRepository + line="1427">A #GIRepository GI namespace to use, e.g. `Gtk` + line="1428">GI namespace to use, e.g. `Gtk` @@ -6395,7 +6412,7 @@ return the special string `<builtin>`. version="2.80"> This function returns the loaded version associated with the given + line="1285">This function returns the loaded version associated with the given namespace @namespace_. Note: The namespace must have already been loaded using a function @@ -6405,20 +6422,20 @@ function. Loaded version + line="1297">Loaded version A #GIRepository + line="1287">A #GIRepository Namespace to inspect + line="1288">Namespace to inspect @@ -6428,7 +6445,7 @@ function. version="2.80"> Check whether a particular namespace (and optionally, a specific + line="819">Check whether a particular namespace (and optionally, a specific version thereof) is currently loaded. This function is likely to only be useful in unusual circumstances; in order @@ -6440,20 +6457,20 @@ already been loaded. `TRUE` if namespace-version is loaded, `FALSE` otherwise + line="834">`TRUE` if namespace-version is loaded, `FALSE` otherwise A #GIRepository + line="821">A #GIRepository Namespace of interest + line="822">Namespace of interest allow-none="1"> Required version, may be `NULL` for latest + line="823">Required version, may be `NULL` for latest @@ -6473,31 +6490,31 @@ already been loaded. throws="1"> Load the given @typelib into the repository. + line="771">Load the given @typelib into the repository. namespace of the loaded typelib + line="780">namespace of the loaded typelib A #GIRepository + line="773">A #GIRepository the typelib to load + line="774">the typelib to load flags affecting the loading operation + line="775">flags affecting the loading operation @@ -6507,7 +6524,7 @@ already been loaded. version="2.80"> Prepends @directory to the search path that is used to + line="330">Prepends @directory to the search path that is used to search shared libraries referenced by imported namespaces. Multiple calls to this function all contribute to the final @@ -6529,13 +6546,13 @@ See the documentation of your dynamic linker for full details. A #GIRepository + line="332">A #GIRepository a single directory to scan for shared libraries + line="333">a single directory to scan for shared libraries @@ -6545,7 +6562,7 @@ See the documentation of your dynamic linker for full details. version="2.80"> Prepends @directory to the typelib search path. + line="268">Prepends @directory to the typelib search path. See also: gi_repository_get_search_path(). @@ -6556,13 +6573,13 @@ See also: gi_repository_get_search_path(). A #GIRepository + line="270">A #GIRepository directory name to prepend to the typelib + line="271">directory name to prepend to the typelib search path @@ -6574,7 +6591,7 @@ See also: gi_repository_get_search_path(). throws="1"> Force the namespace @namespace_ to be loaded if it isn’t already. + line="1910">Force the namespace @namespace_ to be loaded if it isn’t already. If @namespace_ is not loaded, this function will search for a `.typelib` file using the repository search path. In addition, a @@ -6584,7 +6601,7 @@ not specified, the latest will be used. a pointer to the [type@GIRepository.Typelib] if + line="1925">a pointer to the [type@GIRepository.Typelib] if successful, `NULL` otherwise @@ -6592,13 +6609,13 @@ not specified, the latest will be used. A #GIRepository + line="1912">A #GIRepository GI namespace to use, e.g. `Gtk` + line="1913">GI namespace to use, e.g. `Gtk` allow-none="1"> Version of namespace, may be `NULL` for latest + line="1914">Version of namespace, may be `NULL` for latest Set of [flags@GIRepository.RepositoryLoadFlags], may be 0 + line="1915">Set of [flags@GIRepository.RepositoryLoadFlags], may be 0 @@ -6624,7 +6641,7 @@ not specified, the latest will be used. throws="1"> Force the namespace @namespace_ to be loaded if it isn’t already. + line="1945">Force the namespace @namespace_ to be loaded if it isn’t already. If @namespace_ is not loaded, this function will search for a `.typelib` file within the private directory only. In addition, a @@ -6634,7 +6651,7 @@ not specified, the latest will be used. a pointer to the [type@GIRepository.Typelib] if + line="1962">a pointer to the [type@GIRepository.Typelib] if successful, `NULL` otherwise @@ -6642,20 +6659,20 @@ not specified, the latest will be used. A #GIRepository + line="1947">A #GIRepository Private directory where to find the requested + line="1948">Private directory where to find the requested typelib GI namespace to use, e.g. `Gtk` + line="1950">GI namespace to use, e.g. `Gtk` allow-none="1"> Version of namespace, may be `NULL` for latest + line="1951">Version of namespace, may be `NULL` for latest Set of [flags@GIRepository.RepositoryLoadFlags], may be 0 + line="1952">Set of [flags@GIRepository.RepositoryLoadFlags], may be 0 @@ -7879,7 +7896,7 @@ of a single module’s API. throws="1"> Creates a new [type@GIRepository.Typelib] from a [type@GLib.Bytes]. + line="2334">Creates a new [type@GIRepository.Typelib] from a [type@GLib.Bytes]. The [type@GLib.Bytes] can point to a memory location or a mapped file, and the typelib will hold a reference to it until the repository is destroyed. @@ -7887,14 +7904,14 @@ the typelib will hold a reference to it until the repository is destroyed. the new [type@GIRepository.Typelib] + line="2344">the new [type@GIRepository.Typelib] memory chunk containing the typelib + line="2336">memory chunk containing the typelib @@ -7904,19 +7921,19 @@ the typelib will hold a reference to it until the repository is destroyed. version="2.80"> Get the name of the namespace represented by @typelib. + line="2417">Get the name of the namespace represented by @typelib. name of the namespace represented by @typelib + line="2423">name of the namespace represented by @typelib a #GITypelib + line="2419">a #GITypelib @@ -7924,19 +7941,19 @@ the typelib will hold a reference to it until the repository is destroyed. Increment the reference count of a [type@GIRepository.Typelib]. + line="2368">Increment the reference count of a [type@GIRepository.Typelib]. the same @typelib pointer + line="2374">the same @typelib pointer a #GITypelib + line="2370">a #GITypelib @@ -7944,25 +7961,25 @@ the typelib will hold a reference to it until the repository is destroyed. Loads a symbol from a `GITypelib`. + line="2432">Loads a symbol from a `GITypelib`. `TRUE` on success + line="2441">`TRUE` on success the typelib + line="2434">the typelib name of symbol to be loaded + line="2435">name of symbol to be loaded nullable="1"> returns a pointer to the symbol value, or `NULL` + line="2436">returns a pointer to the symbol value, or `NULL` on failure @@ -7981,7 +7998,7 @@ the typelib will hold a reference to it until the repository is destroyed. Decrement the reference count of a [type@GIRepository.Typelib]. + line="2387">Decrement the reference count of a [type@GIRepository.Typelib]. Once the reference count reaches zero, the typelib is freed. @@ -7992,7 +8009,7 @@ Once the reference count reaches zero, the typelib is freed. a #GITypelib + line="2389">a #GITypelib @@ -8940,19 +8957,19 @@ depending on @storage_type. version="2.80"> Obtain a string representation of @type + line="2037">Obtain a string representation of @type the string + line="2043">the string the type_tag + line="2039">the type_tag diff --git a/girs/GLib-2.0.gir b/girs/GLib-2.0.gir index 7768f5e5c..3ac13d1d8 100644 --- a/girs/GLib-2.0.gir +++ b/girs/GLib-2.0.gir @@ -2381,7 +2381,7 @@ In the event the URI cannot be found, -1 is returned and a timestamp - + @@ -2510,7 +2510,7 @@ set and %FALSE is returned. return location for the last registration time, or %NULL - + @@ -2866,7 +2866,7 @@ In the event the URI cannot be found, -1 is returned and a timestamp - + @@ -3032,7 +3032,7 @@ In the event the URI cannot be found, -1 is returned and a timestamp. - + @@ -3492,7 +3492,7 @@ If no bookmark for @uri is found then it is created. a timestamp or -1 to use the current time - + @@ -3610,7 +3610,7 @@ for @uri is found, one is created. the time of the last registration for this application - + @@ -3930,7 +3930,7 @@ g_bookmark_file_set_visited_date_time(). a timestamp or -1 to use the current time - + @@ -4050,7 +4050,7 @@ does not affect the "modified" time. a timestamp or -1 to use the current time - + @@ -9155,7 +9155,7 @@ To set the value of a date to the current day, you could write: time_t value to set - + @@ -17727,6 +17727,12 @@ on a #GIOChannel is satisfied. in a generic way. + reads raw bytes from the channel. This is called from + various functions such as g_io_channel_read_chars() to + read raw bytes from the channel. Encoding and buffering + issues are dealt with at a higher level. @@ -17749,6 +17755,12 @@ in a generic way. + writes raw bytes to the channel. This is called from + various functions such as g_io_channel_write_chars() to + write raw bytes to the channel. Encoding and buffering + issues are dealt with at a higher level. @@ -17771,6 +17783,10 @@ in a generic way. + seeks the channel. This is called from + g_io_channel_seek() on channels that support it. @@ -17790,6 +17806,10 @@ in a generic way. + closes the channel. This is called from + g_io_channel_close() after flushing the buffers. @@ -17803,6 +17823,10 @@ in a generic way. + creates a watch on the channel. This call + corresponds directly to g_io_create_watch(). @@ -17819,6 +17843,14 @@ in a generic way. + called from g_io_channel_unref() when the channel needs to + be freed. This function must free the memory associated + with the channel, including freeing the #GIOChannel + structure itself. The channel buffers have been flushed + and possibly @io_close has been called by the time this + function is called. @@ -17832,6 +17864,12 @@ in a generic way. + sets the #GIOFlags on the channel. This is called + from g_io_channel_set_flags() with all flags except + for %G_IO_FLAG_APPEND and %G_IO_FLAG_NONBLOCK masked + out. @@ -17848,6 +17886,12 @@ in a generic way. + gets the #GIOFlags for the channel. This function + need only return the %G_IO_FLAG_APPEND and + %G_IO_FLAG_NONBLOCK flags; g_io_channel_get_flags() + automatically adds the others as appropriate. @@ -22185,7 +22229,7 @@ linked against at application run time. - + The micro version number of the GLib library. @@ -24441,6 +24485,11 @@ from a callback, g_markup_parse_context_parse() will report that error back to its caller. + Callback to invoke when the opening tag of an element + is seen. The callback's @attribute_names and @attribute_values parameters + are %NULL-terminated. @@ -24470,6 +24519,11 @@ back to its caller. + Callback to invoke when the closing tag of an element + is seen. Note that this is also called for empty tags like + `<empty/>`. @@ -24493,6 +24547,13 @@ back to its caller. + Callback to invoke when some text is seen (text is always + inside an element). Note that the text of an element may be spread + over multiple calls of this function. If the + %G_MARKUP_TREAT_CDATA_AS_TEXT flag is set, this function is also + called for the content of CDATA marked sections. @@ -24519,6 +24580,13 @@ back to its caller. + Callback to invoke for comments, processing instructions + and doctype declarations; if you're re-writing the parsed document, + write the passthrough text back out in the same position. If the + %G_MARKUP_TREAT_CDATA_AS_TEXT flag is not set, this function is also + called for CDATA marked sections. @@ -24545,6 +24613,9 @@ back to its caller. + Callback to invoke when an error occurs. @@ -25234,6 +25305,9 @@ if it exists, should be prior to any use of GLib. This functions related to this has been deprecated in 2.46, and no longer work. + function to use for allocating memory. @@ -25247,6 +25321,9 @@ This functions related to this has been deprecated in 2.46, and no longer work.< + function to use for reallocating memory. @@ -25263,6 +25340,9 @@ This functions related to this has been deprecated in 2.46, and no longer work.< + function to use to free memory. @@ -25276,6 +25356,9 @@ This functions related to this has been deprecated in 2.46, and no longer work.< + function to use for allocating zero-filled memory. @@ -25292,6 +25375,9 @@ This functions related to this has been deprecated in 2.46, and no longer work.< + function to use for allocating memory without a default error handler. @@ -25305,6 +25391,9 @@ This functions related to this has been deprecated in 2.46, and no longer work.< + function to use for reallocating memory without a default error handler. @@ -40550,6 +40639,9 @@ wrong source. functions for managing callback objects. + Called when a reference is added to the callback object @@ -40563,6 +40655,9 @@ functions for managing callback objects. + Called when a reference to the callback object is dropped @@ -40576,6 +40671,10 @@ functions for managing callback objects. + Called to extract the callback function and data from the + callback object. @@ -40687,6 +40786,19 @@ check function, it tests the results of the poll() call to see if the required condition has been met, and returns %TRUE if so. + Called before all the file descriptors are polled. If the + source can determine that it is ready here (without waiting for the + results of the poll() call) it should return %TRUE. It can also return + a @timeout_ value which should be the maximum timeout (in milliseconds) + which should be passed to the poll() call. The actual timeout used will + be -1 if all sources returned -1, or it will be the minimum of all + the @timeout_ values returned which were >= 0. Since 2.36 this may + be %NULL, in which case the effect is as if the function always returns + %FALSE with a timeout of -1. If @prepare returns a + timeout and the source also has a ready time set, then the + lower of the two will be used. @@ -40703,6 +40815,14 @@ required condition has been met, and returns %TRUE if so. + Called after all the file descriptors are polled. The source + should return %TRUE if it is ready to be dispatched. Note that some + time may have passed since the previous prepare function was called, + so the source should be checked again here. Since 2.36 this may + be %NULL, in which case the effect is as if the function always returns + %FALSE. @@ -40716,6 +40836,17 @@ required condition has been met, and returns %TRUE if so. + Called to dispatch the event source, after it has returned + %TRUE in either its @prepare or its @check function, or if a ready time + has been reached. The @dispatch function receives a callback function and + user data. The callback function may be %NULL if the source was never + connected to a callback using g_source_set_callback(). The @dispatch + function should call the callback function with @user_data and whatever + additional parameters are needed for this type of event source. The + return value of the @dispatch function should be %G_SOURCE_REMOVE if the + source should be removed or %G_SOURCE_CONTINUE to keep it. @@ -40739,6 +40870,12 @@ required condition has been met, and returns %TRUE if so. + Called when the source is finalized. At this point, the source + will have been destroyed, had its callback cleared, and have been removed + from its #GMainContext, but it will still have its final reference count, + so methods can be called on it from within this function. @@ -44687,6 +44824,9 @@ or g_thread_try_new(). to initialize the thread system. + virtual function pointer for g_mutex_new() @@ -44695,6 +44835,9 @@ to initialize the thread system. + virtual function pointer for g_mutex_lock() @@ -44708,6 +44851,9 @@ to initialize the thread system. + virtual function pointer for g_mutex_trylock() @@ -44721,6 +44867,9 @@ to initialize the thread system. + virtual function pointer for g_mutex_unlock() @@ -44734,6 +44883,9 @@ to initialize the thread system. + virtual function pointer for g_mutex_free() @@ -44747,6 +44899,9 @@ to initialize the thread system. + virtual function pointer for g_cond_new() @@ -44755,6 +44910,9 @@ to initialize the thread system. + virtual function pointer for g_cond_signal() @@ -44768,6 +44926,9 @@ to initialize the thread system. + virtual function pointer for g_cond_broadcast() @@ -44781,6 +44942,9 @@ to initialize the thread system. + virtual function pointer for g_cond_wait() @@ -44797,6 +44961,9 @@ to initialize the thread system. + virtual function pointer for g_cond_timed_wait() @@ -44816,6 +44983,9 @@ to initialize the thread system. + virtual function pointer for g_cond_free() @@ -44829,6 +44999,9 @@ to initialize the thread system. + virtual function pointer for g_private_new() @@ -44844,6 +45017,9 @@ to initialize the thread system. + virtual function pointer for g_private_get() @@ -44857,6 +45033,9 @@ to initialize the thread system. + virtual function pointer for g_private_set() @@ -44873,6 +45052,9 @@ to initialize the thread system. + virtual function pointer for g_thread_create() @@ -44907,6 +45089,9 @@ to initialize the thread system. + virtual function pointer for g_thread_yield() @@ -44915,6 +45100,9 @@ to initialize the thread system. + virtual function pointer for g_thread_join() @@ -44928,6 +45116,9 @@ to initialize the thread system. + virtual function pointer for g_thread_exit() @@ -44936,6 +45127,10 @@ to initialize the thread system. + virtual function pointer for + g_thread_set_priority() @@ -44952,6 +45147,9 @@ to initialize the thread system. + virtual function pointer for g_thread_self() @@ -44965,6 +45163,10 @@ to initialize the thread system. + used internally by recursive mutex locks and by some + assertion checks @@ -53340,7 +53542,7 @@ be shared. introspectable="0"> Creates a new #GVariant instance. + line="5368">Creates a new #GVariant instance. Think of this function as an analogue to g_strdup_printf(). @@ -53372,20 +53574,20 @@ new_variant = g_variant_new ("(t^as)", a new floating #GVariant instance + line="5402">a new floating #GVariant instance a #GVariant format string + line="5370">a #GVariant format string arguments, as per @format_string + line="5371">arguments, as per @format_string @@ -53710,7 +53912,7 @@ GLib 2.60) or (in older versions) fail and exit the process. version="2.24"> Creates a new #GVariant instance from serialized data. + line="6168">Creates a new #GVariant instance from serialized data. @type is the type of #GVariant instance that will be constructed. The interpretation of @data depends on knowing the type. @@ -53743,20 +53945,20 @@ process. a new floating #GVariant of type @type + line="6207">a new floating #GVariant of type @type a definite #GVariantType + line="6170">a definite #GVariantType the serialized data + line="6171">the serialized data @@ -53764,19 +53966,19 @@ process. the size of @data + line="6172">the size of @data %TRUE if @data is definitely in normal form + line="6173">%TRUE if @data is definitely in normal form function to call when @data is no longer needed + line="6174">function to call when @data is no longer needed allow-none="1"> data for @notify + line="6175">data for @notify @@ -54353,7 +54555,7 @@ new instance takes ownership of them as if via g_variant_ref_sink(). introspectable="0"> This function is intended to be used by libraries based on + line="5425">This function is intended to be used by libraries based on #GVariant that want to provide g_variant_new()-like functionality to their users. @@ -54393,14 +54595,14 @@ or by passing it to another g_variant_new() call. a new, usually floating, #GVariant + line="5469">a new, usually floating, #GVariant a string that is prefixed with a format string + line="5427">a string that is prefixed with a format string allow-none="1"> location to store the end pointer, + line="5428">location to store the end pointer, or %NULL a pointer to a #va_list + line="5430">a pointer to a #va_list @@ -54450,7 +54652,7 @@ instance takes ownership of @child. Performs a byteswapping operation on the contents of @value. The + line="6097">Performs a byteswapping operation on the contents of @value. The result is that all multi-byte numeric data contained in @value is byteswapped. That includes 16, 32, and 64bit signed and unsigned integers as well as file handles and double precision floating point @@ -54471,14 +54673,14 @@ A full, not floating, reference is returned. the byteswapped form of @value + line="6119">the byteswapped form of @value a #GVariant + line="6099">a #GVariant @@ -54488,7 +54690,7 @@ A full, not floating, reference is returned. version="2.34"> Checks if calling g_variant_get() with @format_string on @value would + line="4491">Checks if calling g_variant_get() with @format_string on @value would be valid from a type-compatibility standpoint. @format_string is assumed to be a valid format string (from a syntactic standpoint). @@ -54506,26 +54708,26 @@ g_variant_lookup() or g_menu_model_get_item_attribute()). %TRUE if @format_string is safe to use + line="4512">%TRUE if @format_string is safe to use a #GVariant + line="4493">a #GVariant a valid #GVariant format string + line="4494">a valid #GVariant format string %TRUE to ensure the format string makes deep copies + line="4495">%TRUE to ensure the format string makes deep copies @@ -54835,7 +55037,7 @@ this function with #GHashTable. They must each be a #GVariant. introspectable="0"> Deconstructs a #GVariant instance. + line="5492">Deconstructs a #GVariant instance. Think of this function as an analogue to scanf(). @@ -54859,19 +55061,19 @@ see the section on a #GVariant instance + line="5494">a #GVariant instance a #GVariant format string + line="5495">a #GVariant format string arguments, as per @format_string + line="5496">arguments, as per @format_string @@ -55016,7 +55218,7 @@ For an empty array, @length will be set to 0 and a pointer to a introspectable="0"> Reads a child item out of a container #GVariant instance and + line="5647">Reads a child item out of a container #GVariant instance and deconstructs it according to @format_string. This call is essentially a combination of g_variant_get_child_value() and g_variant_get(). @@ -55033,25 +55235,25 @@ see the section on a container #GVariant + line="5649">a container #GVariant the index of the child to deconstruct + line="5650">the index of the child to deconstruct a #GVariant format string + line="5651">a #GVariant format string arguments, as per @format_string + line="5652">arguments, as per @format_string @@ -55398,7 +55600,7 @@ value is Nothing, then this function returns %NULL. version="2.24"> Gets a #GVariant instance that has the same value as @value and is + line="6049">Gets a #GVariant instance that has the same value as @value and is trusted to be in normal form. If @value is already trusted to be in normal form then a new @@ -55427,14 +55629,14 @@ reference to it. a trusted #GVariant + line="6079">a trusted #GVariant a #GVariant + line="6051">a #GVariant @@ -55732,7 +55934,7 @@ other than %G_VARIANT_TYPE_UINT64. introspectable="0"> This function is intended to be used by libraries based on #GVariant + line="5536">This function is intended to be used by libraries based on #GVariant that want to provide g_variant_get()-like functionality to their users. @@ -55764,13 +55966,13 @@ see the section on a #GVariant + line="5538">a #GVariant a string that is prefixed with a format string + line="5539">a string that is prefixed with a format string location to store the end pointer, + line="5540">location to store the end pointer, or %NULL a pointer to a #va_list + line="5542">a pointer to a #va_list @@ -56652,7 +56854,7 @@ g_variant_builder_init(). introspectable="0"> Adds to a #GVariantBuilder. + line="5593">Adds to a #GVariantBuilder. This call is a convenience wrapper that is exactly equivalent to calling g_variant_new() followed by g_variant_builder_add_value(). @@ -56690,19 +56892,19 @@ make_pointless_dictionary (void) a #GVariantBuilder + line="5595">a #GVariantBuilder a #GVariant varargs format string + line="5596">a #GVariant varargs format string arguments, as per @format_string + line="5597">arguments, as per @format_string @@ -57314,7 +57516,7 @@ using #GVariantDict to construct a #GVariant. Releases all memory associated with a #GVariantDict without freeing + line="4221">Releases all memory associated with a #GVariantDict without freeing the #GVariantDict structure itself. It typically only makes sense to do this on a stack-allocated @@ -57336,7 +57538,7 @@ on uninitialised memory. a #GVariantDict + line="4223">a #GVariantDict @@ -57346,25 +57548,25 @@ on uninitialised memory. version="2.40"> Checks if @key exists in @dict. + line="4124">Checks if @key exists in @dict. %TRUE if @key is in @dict + line="4131">%TRUE if @key is in @dict a #GVariantDict + line="4126">a #GVariantDict the key to look up in the dictionary + line="4127">the key to look up in the dictionary @@ -57372,7 +57574,7 @@ on uninitialised memory. Returns the current value of @dict as a #GVariant of type + line="4257">Returns the current value of @dict as a #GVariant of type %G_VARIANT_TYPE_VARDICT, clearing it in the process. It is not permissible to use @dict in any way after this call except @@ -57383,14 +57585,14 @@ the case of stack-allocated). a new, floating, #GVariant + line="4269">a new, floating, #GVariant a #GVariantDict + line="4259">a #GVariantDict @@ -57401,7 +57603,7 @@ the case of stack-allocated). introspectable="0"> Initialises a #GVariantDict structure. + line="3993">Initialises a #GVariantDict structure. If @from_asv is given, it is used to initialise the dictionary. @@ -57425,7 +57627,7 @@ g_variant_dict_new() instead of this function. a #GVariantDict + line="3995">a #GVariantDict allow-none="1"> the initial value for @dict + line="3996">the initial value for @dict @@ -57445,7 +57647,7 @@ g_variant_dict_new() instead of this function. introspectable="0"> Inserts a value into a #GVariantDict. + line="4145">Inserts a value into a #GVariantDict. This call is a convenience wrapper that is exactly equivalent to calling g_variant_new() followed by g_variant_dict_insert_value(). @@ -57457,25 +57659,25 @@ calling g_variant_new() followed by g_variant_dict_insert_value(). a #GVariantDict + line="4147">a #GVariantDict the key to insert a value for + line="4148">the key to insert a value for a #GVariant varargs format string + line="4149">a #GVariant varargs format string arguments, as per @format_string + line="4150">arguments, as per @format_string @@ -57485,7 +57687,7 @@ calling g_variant_new() followed by g_variant_dict_insert_value(). version="2.40"> Inserts (or replaces) a key in a #GVariantDict. + line="4176">Inserts (or replaces) a key in a #GVariantDict. @value is consumed if it is floating. @@ -57496,19 +57698,19 @@ calling g_variant_new() followed by g_variant_dict_insert_value(). a #GVariantDict + line="4178">a #GVariantDict the key to insert a value for + line="4179">the key to insert a value for the value to insert + line="4180">the value to insert @@ -57519,7 +57721,7 @@ calling g_variant_new() followed by g_variant_dict_insert_value(). introspectable="0"> Looks up a value in a #GVariantDict. + line="4036">Looks up a value in a #GVariantDict. This function is a wrapper around g_variant_dict_lookup_value() and g_variant_get(). In the case that %NULL would have been returned, @@ -57534,32 +57736,32 @@ section on [`GVariant` format strings](gvariant-format-strings.html#pointers). %TRUE if a value was unpacked + line="4055">%TRUE if a value was unpacked a #GVariantDict + line="4038">a #GVariantDict the key to look up in the dictionary + line="4039">the key to look up in the dictionary a GVariant format string + line="4040">a GVariant format string the arguments to unpack the value into + line="4041">the arguments to unpack the value into @@ -57569,7 +57771,7 @@ section on [`GVariant` format strings](gvariant-format-strings.html#pointers). Looks up a value in a #GVariantDict. + line="4084">Looks up a value in a #GVariantDict. If @key is not found in @dictionary, %NULL is returned. @@ -57584,20 +57786,20 @@ value will have this type. the value of the dictionary key, or %NULL + line="4102">the value of the dictionary key, or %NULL a #GVariantDict + line="4086">a #GVariantDict the key to look up in the dictionary + line="4087">the key to look up in the dictionary allow-none="1"> a #GVariantType, or %NULL + line="4088">a #GVariantType, or %NULL @@ -57614,7 +57816,7 @@ value will have this type. Increases the reference count on @dict. + line="4293">Increases the reference count on @dict. Don't call this on stack-allocated #GVariantDict instances or bad things will happen. @@ -57622,14 +57824,14 @@ things will happen. a new reference to @dict + line="4302">a new reference to @dict a heap-allocated #GVariantDict + line="4295">a heap-allocated #GVariantDict @@ -57639,25 +57841,25 @@ things will happen. version="2.40"> Removes a key and its associated value from a #GVariantDict. + line="4200">Removes a key and its associated value from a #GVariantDict. %TRUE if the key was found and removed + line="4207">%TRUE if the key was found and removed a #GVariantDict + line="4202">a #GVariantDict the key to remove + line="4203">the key to remove @@ -57665,7 +57867,7 @@ things will happen. Decreases the reference count on @dict. + line="4316">Decreases the reference count on @dict. In the event that there are no more references, releases all memory associated with the #GVariantDict. @@ -57680,7 +57882,7 @@ things will happen. a heap-allocated #GVariantDict + line="4318">a heap-allocated #GVariantDict @@ -57788,7 +57990,7 @@ be freed in any way. introspectable="0"> Gets the next item in the container and unpacks it into the variable + line="5767">Gets the next item in the container and unpacks it into the variable argument list according to @format_string, returning %TRUE. If no more items remain then %FALSE is returned. @@ -57854,7 +58056,7 @@ See the section on %TRUE if a value was unpacked, or %FALSE if there was no + line="5836">%TRUE if a value was unpacked, or %FALSE if there was no value @@ -57862,19 +58064,19 @@ See the section on a #GVariantIter + line="5769">a #GVariantIter a GVariant format string + line="5770">a GVariant format string the arguments to unpack the value into + line="5771">the arguments to unpack the value into @@ -57911,7 +58113,7 @@ This function might be useful for preallocation of arrays. introspectable="0"> Gets the next item in the container and unpacks it into the variable + line="5689">Gets the next item in the container and unpacks it into the variable argument list according to @format_string, returning %TRUE. If no more items remain then %FALSE is returned. @@ -57956,26 +58158,26 @@ See the section on %TRUE if a value was unpacked, or %FALSE if there as no value + line="5737">%TRUE if a value was unpacked, or %FALSE if there as no value a #GVariantIter + line="5691">a #GVariantIter a GVariant format string + line="5692">a GVariant format string the arguments to unpack the value into + line="5693">the arguments to unpack the value into @@ -75016,7 +75218,7 @@ g_pattern_match() instead while supplying the reversed string. version="2.30"> This is equivalent to g_bit_lock, but working on pointers (or other + line="495">This is equivalent to g_bit_lock, but working on pointers (or other pointer-sized values). For portability reasons, you may only lock on the bottom 32 bits of @@ -75032,13 +75234,13 @@ artifact and the argument passed to it should not be `volatile`. a pointer to a #gpointer-sized value + line="497">a pointer to a #gpointer-sized value a bit value between 0 and 31 + line="498">a bit value between 0 and 31 @@ -75048,7 +75250,7 @@ artifact and the argument passed to it should not be `volatile`. version="2.80"> This is equivalent to g_bit_lock, but working on pointers (or other + line="425">This is equivalent to g_bit_lock, but working on pointers (or other pointer-sized values). For portability reasons, you may only lock on the bottom 32 bits of @@ -75061,13 +75263,13 @@ the pointer. a pointer to a #gpointer-sized value + line="427">a pointer to a #gpointer-sized value a bit value between 0 and 31 + line="428">a bit value between 0 and 31 allow-none="1"> returns the set pointer atomically. + line="429">returns the set pointer atomically. This is the value after setting the lock, it thus always has the lock bit set, while previously @address had the lockbit unset. You may also use g_pointer_bit_lock_mask_ptr() to clear the lock bit. @@ -75091,13 +75293,13 @@ the pointer. version="2.80"> This mangles @ptr as g_pointer_bit_lock() and g_pointer_bit_unlock() + line="619">This mangles @ptr as g_pointer_bit_lock() and g_pointer_bit_unlock() do. the mangled pointer. + line="637">the mangled pointer. @@ -75107,27 +75309,27 @@ do. allow-none="1"> the pointer to mask + line="621">the pointer to mask the bit to set/clear. If set to `G_MAXUINT`, the + line="622">the bit to set/clear. If set to `G_MAXUINT`, the lockbit is taken from @preserve_ptr or @ptr (depending on @preserve_mask). whether to set (lock) the bit or unset (unlock). This + line="624">whether to set (lock) the bit or unset (unlock). This has no effect, if @lock_bit is set to `G_MAXUINT`. if non-zero, a bit-mask for @preserve_ptr. The + line="626">if non-zero, a bit-mask for @preserve_ptr. The @preserve_mask bits from @preserve_ptr are set in the result. Note that the @lock_bit bit will be always set according to @set, regardless of @preserve_mask and @preserve_ptr (unless @lock_bit is @@ -75140,7 +75342,7 @@ do. allow-none="1"> if @preserve_mask is non-zero, the bits + line="631">if @preserve_mask is non-zero, the bits from this pointer are set in the result. @@ -75151,7 +75353,7 @@ do. version="2.30"> This is equivalent to g_bit_trylock(), but working on pointers (or + line="518">This is equivalent to g_bit_trylock(), but working on pointers (or other pointer-sized values). For portability reasons, you may only lock on the bottom 32 bits of @@ -75163,20 +75365,20 @@ artifact and the argument passed to it should not be `volatile`. %TRUE if the lock was acquired + line="532">%TRUE if the lock was acquired a pointer to a #gpointer-sized value + line="520">a pointer to a #gpointer-sized value a bit value between 0 and 31 + line="521">a bit value between 0 and 31 @@ -75186,7 +75388,7 @@ artifact and the argument passed to it should not be `volatile`. version="2.30"> This is equivalent to g_bit_unlock, but working on pointers (or other + line="569">This is equivalent to g_bit_unlock, but working on pointers (or other pointer-sized values). For portability reasons, you may only lock on the bottom 32 bits of @@ -75202,13 +75404,13 @@ artifact and the argument passed to it should not be `volatile`. a pointer to a #gpointer-sized value + line="571">a pointer to a #gpointer-sized value a bit value between 0 and 31 + line="572">a bit value between 0 and 31 @@ -75218,7 +75420,7 @@ artifact and the argument passed to it should not be `volatile`. version="2.80"> This is equivalent to g_pointer_bit_unlock() and atomically setting + line="649">This is equivalent to g_pointer_bit_unlock() and atomically setting the pointer value. Note that the lock bit will be cleared from the pointer. If the unlocked @@ -75233,13 +75435,13 @@ only use this on the lowest bits. a pointer to a #gpointer-sized value + line="651">a pointer to a #gpointer-sized value a bit value between 0 and 31 + line="652">a bit value between 0 and 31 allow-none="1"> the new pointer value to set + line="653">the new pointer value to set if non-zero, those bits of the current pointer in @address + line="654">if non-zero, those bits of the current pointer in @address are preserved. Note that the @lock_bit bit will be always set according to @set, regardless of @preserve_mask and the currently set value in @address. @@ -79763,7 +79965,7 @@ functionality, although under a misleading name. On some platforms, notably Windows, the #GPid type represents a resource + line="2630">On some platforms, notably Windows, the #GPid type represents a resource which must be closed to prevent resource leaking. g_spawn_close_pid() is provided for this purpose. It should be used on all platforms, even though it doesn't do anything under UNIX. @@ -79775,7 +79977,7 @@ though it doesn't do anything under UNIX. The process reference to close + line="2632">The process reference to close diff --git a/girs/GModule-2.0.gir b/girs/GModule-2.0.gir index aa1185baf..1f25e3a18 100644 --- a/girs/GModule-2.0.gir +++ b/girs/GModule-2.0.gir @@ -13,102 +13,1130 @@ and/or use gtk-doc annotations. --> version="2.0" shared-library="libgmodule-2.0.so.0" c:identifier-prefixes="G" - c:symbol-prefixes="g"> + c:symbol-prefixes="gmodule,g"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The #GModule struct is an opaque data structure to represent a + filename="gmodule/gmodule.c" + line="56">The #GModule struct is an opaque data structure to represent a [dynamically-loaded module][glib-Dynamic-Loading-of-Modules]. It should only be accessed via the following functions. - + Closes a module. - + filename="gmodule/gmodule.c" + line="711">Closes a module. + %TRUE on success + filename="gmodule/gmodule.c" + line="717">%TRUE on success a #GModule to close + filename="gmodule/gmodule.c" + line="713">a #GModule to close Ensures that a module will never be unloaded. + filename="gmodule/gmodule.c" + line="772">Ensures that a module will never be unloaded. Any future g_module_close() calls on the module will be ignored. - + a #GModule to make permanently resident + filename="gmodule/gmodule.c" + line="774">a #GModule to make permanently resident Returns the filename that the module was opened with. + filename="gmodule/gmodule.c" + line="855">Returns the filename that the module was opened with. If @module refers to the application itself, "main" is returned. - + the filename of the module + filename="gmodule/gmodule.c" + line="863">the filename of the module a #GModule + filename="gmodule/gmodule.c" + line="857">a #GModule Gets a symbol pointer from a module, such as one exported + filename="gmodule/gmodule.c" + line="800">Gets a symbol pointer from a module, such as one exported by %G_MODULE_EXPORT. Note that a valid symbol can be %NULL. - + %TRUE on success + filename="gmodule/gmodule.c" + line="809">%TRUE on success a #GModule + filename="gmodule/gmodule.c" + line="802">a #GModule the name of the symbol to find + filename="gmodule/gmodule.c" + line="803">the name of the symbol to find transfer-ownership="full" nullable="1"> returns the pointer to the symbol value + filename="gmodule/gmodule.c" + line="804">returns the pointer to the symbol value @@ -128,8 +1156,8 @@ by %G_MODULE_EXPORT. Note that a valid symbol can be %NULL. deprecated="1" deprecated-version="2.76"> A portable way to build the filename of a module. The platform-specific + filename="gmodule/gmodule.c" + line="876">A portable way to build the filename of a module. The platform-specific prefix and suffix are added to the filename, if needed, and the result is added to the directory, using the correct separator character. @@ -144,12 +1172,11 @@ For example, calling g_module_build_path() on a Linux system with a directory it will return `\Windows\mylibrary.dll`. Use g_module_open() instead with @module_name as the basename of the file_name argument. See %G_MODULE_SUFFIX for why. - + the complete path of the module, including the standard library + filename="gmodule/gmodule.c" + line="897">the complete path of the module, including the standard library prefix and suffix. This should be freed when no longer needed @@ -159,30 +1186,29 @@ basename of the file_name argument. See %G_MODULE_SUFFIX for why. the directory where the module is. This can be + filename="gmodule/gmodule.c" + line="878">the directory where the module is. This can be %NULL or the empty string to indicate that the standard platform-specific directories will be used, though that is not recommended the name of the module + filename="gmodule/gmodule.c" + line="881">the name of the module Gets a string describing the last module error. - + filename="gmodule/gmodule.c" + line="787">Gets a string describing the last module error. + a string describing the last module error + filename="gmodule/gmodule.c" + line="792">a string describing the last module error @@ -193,14 +1219,13 @@ basename of the file_name argument. See %G_MODULE_SUFFIX for why. A thin wrapper function around g_module_open_full() - + filename="gmodule/gmodule.c" + line="693">A thin wrapper function around g_module_open_full() + a #GModule on success, or %NULL on failure + filename="gmodule/gmodule.c" + line="702">a #GModule on success, or %NULL on failure @@ -209,15 +1234,15 @@ basename of the file_name argument. See %G_MODULE_SUFFIX for why. the name or path to the file containing the module, + filename="gmodule/gmodule.c" + line="695">the name or path to the file containing the module, or %NULL to obtain a #GModule representing the main program itself the flags used for opening the module. This can be the + filename="gmodule/gmodule.c" + line="697">the flags used for opening the module. This can be the logical OR of any of the #GModuleFlags. @@ -229,9 +1254,11 @@ basename of the file_name argument. See %G_MODULE_SUFFIX for why. Opens a module. If the module has already been opened, its reference count -is incremented. If not, the module is searched in the following order: + filename="gmodule/gmodule.c" + line="429">Opens a module. If the module has already been opened, its reference count +is incremented. If not, the module is searched using @file_name. + +Since 2.76, the search order/behavior is as follows: 1. If @file_name exists as a regular file, it is used as-is; else 2. If @file_name doesn't have the correct suffix and/or prefix for the @@ -242,16 +1269,20 @@ is incremented. If not, the module is searched in the following order: libtool archive is parsed to find the actual file name, and that is used. -At the end of all this, we would have a file path that we can access on -disk, and it is opened as a module. If not, @file_name is opened as -a module verbatim in the hopes that the system implementation will somehow -be able to access it. - +If, at the end of all this, we have a file path that we can access on disk, +it is opened as a module. If not, @file_name is attempted to be opened as a +module verbatim in the hopes that the system implementation will somehow be +able to access it. If that is not possible, %NULL is returned. + +Note that this behaviour was different prior to 2.76, but there is some +overlap in functionality. If backwards compatibility is an issue, kindly +consult earlier #GModule documentation for the prior search order/behavior +of @file_name. + a #GModule on success, or %NULL on failure + filename="gmodule/gmodule.c" + line="461">a #GModule on success, or %NULL on failure @@ -260,15 +1291,15 @@ be able to access it. nullable="1" allow-none="1"> the name or path to the file containing the module, + filename="gmodule/gmodule.c" + line="431">the name or path to the file containing the module, or %NULL to obtain a #GModule representing the main program itself the flags used for opening the module. This can be the + filename="gmodule/gmodule.c" + line="433">the flags used for opening the module. This can be the logical OR of any of the #GModuleFlags @@ -276,39 +1307,37 @@ be able to access it. Checks if modules are supported on the current platform. - + filename="gmodule/gmodule.c" + line="289">Checks if modules are supported on the current platform. + %TRUE if modules are supported + filename="gmodule/gmodule.c" + line="294">%TRUE if modules are supported Specifies the type of the module initialization function. + filename="gmodule/gmodule.c" + line="64">Specifies the type of the module initialization function. If a module contains a function named g_module_check_init() it is called automatically when the module is loaded. It is passed the #GModule structure and should return %NULL on success or a string describing the initialization error. - + %NULL on success, or a string describing the initialization error + filename="gmodule/gmodule.c" + line="74">%NULL on success, or a string describing the initialization error the #GModule corresponding to the module which has just been loaded + filename="gmodule/gmodule.c" + line="66">the #GModule corresponding to the module which has just been loaded @@ -318,40 +1347,38 @@ error. c:type="GModuleError" glib:error-domain="g-module-error-quark"> Errors returned by g_module_open_full(). - + there was an error loading or opening a module file a module returned an error from its `g_module_check_init()` function Flags passed to g_module_open(). Note that these flags are not supported on all platforms. - + specifies that symbols are only resolved when needed. The default action is to bind all symbols when the module is loaded. specifies that symbols in the module should not be added to the global name space. The default action on most platforms is to place symbols in the module in the global name space, @@ -359,39 +1386,60 @@ Note that these flags are not supported on all platforms. mask for all flags. Specifies the type of the module function called when it is unloaded. + filename="gmodule/gmodule.c" + line="77">Specifies the type of the module function called when it is unloaded. If a module contains a function named g_module_unload() it is called automatically when the module is unloaded. It is passed the #GModule structure. - + the #GModule about to be unloaded + filename="gmodule/gmodule.c" + line="79">the #GModule about to be unloaded + + + + + + + + + + + + + + + + + + A portable way to build the filename of a module. The platform-specific + filename="gmodule/gmodule.c" + line="876">A portable way to build the filename of a module. The platform-specific prefix and suffix are added to the filename, if needed, and the result is added to the directory, using the correct separator character. @@ -406,12 +1454,11 @@ For example, calling g_module_build_path() on a Linux system with a directory it will return `\Windows\mylibrary.dll`. Use g_module_open() instead with @module_name as the basename of the file_name argument. See %G_MODULE_SUFFIX for why. - + the complete path of the module, including the standard library + filename="gmodule/gmodule.c" + line="897">the complete path of the module, including the standard library prefix and suffix. This should be freed when no longer needed @@ -421,16 +1468,16 @@ basename of the file_name argument. See %G_MODULE_SUFFIX for why. the directory where the module is. This can be + filename="gmodule/gmodule.c" + line="878">the directory where the module is. This can be %NULL or the empty string to indicate that the standard platform-specific directories will be used, though that is not recommended the name of the module + filename="gmodule/gmodule.c" + line="881">the name of the module @@ -439,14 +1486,13 @@ basename of the file_name argument. See %G_MODULE_SUFFIX for why. Gets a string describing the last module error. - + filename="gmodule/gmodule.c" + line="787">Gets a string describing the last module error. + a string describing the last module error + filename="gmodule/gmodule.c" + line="792">a string describing the last module error @@ -461,92 +1507,15 @@ basename of the file_name argument. See %G_MODULE_SUFFIX for why. Checks if modules are supported on the current platform. - + filename="gmodule/gmodule.c" + line="289">Checks if modules are supported on the current platform. + %TRUE if modules are supported + filename="gmodule/gmodule.c" + line="294">%TRUE if modules are supported - - These functions provide a portable way to dynamically load object files -(commonly known as 'plug-ins'). The current implementation supports all -systems that provide an implementation of dlopen() (e.g. Linux/Sun), as -well as Windows platforms via DLLs. - -A program which wants to use these functions must be linked to the -libraries output by the command `pkg-config --libs gmodule-2.0`. - -To use them you must first determine whether dynamic loading -is supported on the platform by calling g_module_supported(). -If it is, you can open a module with g_module_open(), -find the module's symbols (e.g. function names) with g_module_symbol(), -and later close the module with g_module_close(). -g_module_name() will return the file name of a currently opened module. - -If any of the above functions fail, the error status can be found with -g_module_error(). - -The #GModule implementation features reference counting for opened modules, -and supports hook functions within a module which are called when the -module is loaded and unloaded (see #GModuleCheckInit and #GModuleUnload). - -If your module introduces static data to common subsystems in the running -program, e.g. through calling -`g_quark_from_static_string ("my-module-stuff")`, -it must ensure that it is never unloaded, by calling g_module_make_resident(). - -Example: Calling a function defined in a GModule -|[<!-- language="C" --> -// the function signature for 'say_hello' -typedef void (* SayHelloFunc) (const char *message); - -gboolean -just_say_hello (const char *filename, GError **error) -{ - SayHelloFunc say_hello; - GModule *module; - - module = g_module_open (filename, G_MODULE_BIND_LAZY); - if (!module) - { - g_set_error (error, FOO_ERROR, FOO_ERROR_BLAH, - "%s", g_module_error ()); - return FALSE; - } - - if (!g_module_symbol (module, "say_hello", (gpointer *)&say_hello)) - { - g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN, - "%s: %s", filename, g_module_error ()); - if (!g_module_close (module)) - g_warning ("%s: %s", filename, g_module_error ()); - return FALSE; - } - - if (say_hello == NULL) - { - g_set_error (error, SAY_ERROR, SAY_ERROR_OPEN, - "symbol say_hello is NULL"); - if (!g_module_close (module)) - g_warning ("%s: %s", filename, g_module_error ()); - return FALSE; - } - - // call our function in the module - say_hello ("Hello world!"); - - if (!g_module_close (module)) - g_warning ("%s: %s", filename, g_module_error ()); - return TRUE; - } -]| - diff --git a/girs/GObject-2.0.gir b/girs/GObject-2.0.gir index 248e3b282..32f0f4c1f 100644 --- a/girs/GObject-2.0.gir +++ b/girs/GObject-2.0.gir @@ -13,10 +13,10 @@ and/or use gtk-doc annotations. --> version="2.0" shared-library="libgobject-2.0.so.0" c:identifier-prefixes="G" - c:symbol-prefixes="g"> + c:symbol-prefixes="gobject,g"> This is the signature of marshaller functions, required to marshall arrays of parameter values to signal emissions into C language callback invocations. @@ -24,27 +24,24 @@ invocations. It is merely an alias to #GClosureMarshal since the #GClosure mechanism takes over responsibility of actual function invocation for the signal system. - + This is the signature of va_list marshaller functions, an optional marshaller that can be used in some situations to avoid marshalling the signal argument into GValues. - + A numerical value which represents the unique identifier of a registered type. - + version="2.38" introspectable="0"> A convenience macro to ease adding private data to instances of a new type + filename="gobject/gtype.h" + line="2116">A convenience macro to ease adding private data to instances of a new type in the @_C_ section of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE(). @@ -118,13 +115,12 @@ name of the form `TypeNamePrivate`. It is safe to call the `_get_instance_private` function on %NULL or invalid objects since it's only adding an offset to the instance pointer. In that case the returned pointer must not be dereferenced. - + the name of the type in CamelCase + filename="gobject/gtype.h" + line="2118">the name of the type in CamelCase @@ -133,8 +129,8 @@ case the returned pointer must not be dereferenced. version="2.38" introspectable="0"> A convenience macro to ease adding private data to instances of a new dynamic + filename="gobject/gtypemodule.h" + line="245">A convenience macro to ease adding private data to instances of a new dynamic type in the @_C_ section of G_DEFINE_DYNAMIC_TYPE_EXTENDED(). See G_ADD_PRIVATE() for details, it is similar but for static types. @@ -142,19 +138,22 @@ See G_ADD_PRIVATE() for details, it is similar but for static types. Note that this macro can only be used together with the G_DEFINE_DYNAMIC_TYPE_EXTENDED macros, since it depends on variable names from that macro. - + the name of the type in CamelCase + filename="gobject/gtypemodule.h" + line="247">the name of the type in CamelCase + + - + @@ -163,8 +162,7 @@ names from that macro. - + @@ -172,8 +170,8 @@ names from that macro. A callback function used by the type system to finalize those portions + filename="gobject/gtype.h" + line="826">A callback function used by the type system to finalize those portions of a derived types class structure that were setup from the corresponding GBaseInitFunc() function. @@ -181,24 +179,23 @@ Class finalization basically works the inverse way in which class initialization is performed. See GClassInitFunc() for a discussion of the class initialization process. - + The #GTypeClass structure to finalize + filename="gobject/gtype.h" + line="828">The #GTypeClass structure to finalize A callback function used by the type system to do base initialization + filename="gobject/gtype.h" + line="809">A callback function used by the type system to do base initialization of the class structures of derived types. This function is called as part of the initialization process of all derived @@ -209,16 +206,15 @@ For example, class members (such as strings) that are not sufficiently handled by a plain memory copy of the parent class into the derived class have to be altered. See GClassInitFunc() for a discussion of the class initialization process. - + The #GTypeClass structure to initialize + filename="gobject/gtype.h" + line="811">The #GTypeClass structure to initialize @@ -231,33 +227,32 @@ initialization process. glib:type-name="GBinding" glib:get-type="g_binding_get_type"> #GBinding is the representation of a binding between a property on a -#GObject instance (or source) and another property on another #GObject + filename="gobject/gbinding.c" + line="23">`GObject` instance (or source) and another property on another `GObject` instance (or target). Whenever the source property changes, the same value is applied to the target property; for instance, the following binding: -|[<!-- language="C" --> +```c g_object_bind_property (object1, "property-a", object2, "property-b", G_BINDING_DEFAULT); -]| +``` will cause the property named "property-b" of @object2 to be updated -every time g_object_set() or the specific accessor changes the value of +every time [method@GObject.set] or the specific accessor changes the value of the property "property-a" of @object1. It is possible to create a bidirectional binding between two properties -of two #GObject instances, so that if either property changes, the +of two `GObject` instances, so that if either property changes, the other is updated as well, for instance: -|[<!-- language="C" --> +```c g_object_bind_property (object1, "property-a", object2, "property-b", G_BINDING_BIDIRECTIONAL); -]| +``` will keep the two properties in sync. @@ -266,14 +261,14 @@ directions, in case of a bidirectional binding) to apply a custom transformation from the source value to the target value before applying it; for instance, the following binding: -|[<!-- language="C" --> +```c g_object_bind_property_full (adjustment1, "value", adjustment2, "value", G_BINDING_BIDIRECTIONAL, celsius_to_fahrenheit, fahrenheit_to_celsius, NULL, NULL); -]| +``` will keep the "value" property of the two adjustments in sync; the @celsius_to_fahrenheit function will be called whenever the "value" @@ -287,53 +282,50 @@ of @adjustment1. Note that #GBinding does not resolve cycles by itself; a cycle like -|[ +``` object1:propertyA -> object2:propertyB object2:propertyB -> object3:propertyC object3:propertyC -> object1:propertyA -]| +``` might lead to an infinite loop. The loop, in this particular case, -can be avoided if the objects emit the #GObject::notify signal only +can be avoided if the objects emit the `GObject::notify` signal only if the value has effectively been changed. A binding is implemented -using the #GObject::notify signal, so it is susceptible to all the -various ways of blocking a signal emission, like g_signal_stop_emission() -or g_signal_handler_block(). +using the `GObject::notify` signal, so it is susceptible to all the +various ways of blocking a signal emission, like [func@GObject.signal_stop_emission] +or [func@GObject.signal_handler_block]. A binding will be severed, and the resources it allocates freed, whenever -either one of the #GObject instances it refers to are finalized, or when +either one of the `GObject` instances it refers to are finalized, or when the #GBinding instance loses its last reference. Bindings for languages with garbage collection can use -g_binding_unbind() to explicitly release a binding between the source +[method@GObject.Binding.unbind] to explicitly release a binding between the source and target properties, instead of relying on the last reference on the -binding, source, and target instances to drop. - -#GBinding is available since GObject 2.26 +binding, source, and target instances to drop. Retrieves the #GObject instance used as the source of the binding. + filename="gobject/gbinding.c" + line="1024">Retrieves the #GObject instance used as the source of the binding. A #GBinding can outlive the source #GObject as the binding does not hold a strong reference to the source. If the source is destroyed before the binding then this function will return %NULL. - + the source #GObject, or %NULL if the + filename="gobject/gbinding.c" + line="1034">the source #GObject, or %NULL if the source does not exist any more. a #GBinding + filename="gobject/gbinding.c" + line="1026">a #GBinding @@ -342,26 +334,25 @@ binding then this function will return %NULL. c:identifier="g_binding_dup_target" version="2.68"> Retrieves the #GObject instance used as the target of the binding. + filename="gobject/gbinding.c" + line="1085">Retrieves the #GObject instance used as the target of the binding. A #GBinding can outlive the target #GObject as the binding does not hold a strong reference to the target. If the target is destroyed before the binding then this function will return %NULL. - + the target #GObject, or %NULL if the + filename="gobject/gbinding.c" + line="1095">the target #GObject, or %NULL if the target does not exist any more. a #GBinding + filename="gobject/gbinding.c" + line="1087">a #GBinding @@ -371,21 +362,20 @@ binding then this function will return %NULL. glib:get-property="flags" version="2.26"> Retrieves the flags passed when constructing the #GBinding. - + filename="gobject/gbinding.c" + line="968">Retrieves the flags passed when constructing the #GBinding. + the #GBindingFlags used by the #GBinding + filename="gobject/gbinding.c" + line="974">the #GBindingFlags used by the #GBinding a #GBinding + filename="gobject/gbinding.c" + line="970">a #GBinding @@ -397,8 +387,8 @@ binding then this function will return %NULL. deprecated="1" deprecated-version="2.68"> Retrieves the #GObject instance used as the source of the binding. + filename="gobject/gbinding.c" + line="986">Retrieves the #GObject instance used as the source of the binding. A #GBinding can outlive the source #GObject as the binding does not hold a strong reference to the source. If the source is destroyed before the @@ -409,20 +399,19 @@ threads as otherwise the pointer returned from this function might become invalid if the source is finalized from another thread in the meantime. Use g_binding_dup_source() for a safer version of this function. - + the source #GObject, or %NULL if the + filename="gobject/gbinding.c" + line="1000">the source #GObject, or %NULL if the source does not exist any more. a #GBinding + filename="gobject/gbinding.c" + line="988">a #GBinding @@ -432,22 +421,21 @@ function. glib:get-property="source-property" version="2.26"> Retrieves the name of the property of #GBinding:source used as the source + filename="gobject/gbinding.c" + line="1108">Retrieves the name of the property of #GBinding:source used as the source of the binding. - + the name of the source property + filename="gobject/gbinding.c" + line="1115">the name of the source property a #GBinding + filename="gobject/gbinding.c" + line="1110">a #GBinding @@ -459,8 +447,8 @@ of the binding. deprecated="1" deprecated-version="2.68"> Retrieves the #GObject instance used as the target of the binding. + filename="gobject/gbinding.c" + line="1047">Retrieves the #GObject instance used as the target of the binding. A #GBinding can outlive the target #GObject as the binding does not hold a strong reference to the target. If the target is destroyed before the @@ -471,20 +459,19 @@ threads as otherwise the pointer returned from this function might become invalid if the target is finalized from another thread in the meantime. Use g_binding_dup_target() for a safer version of this function. - + the target #GObject, or %NULL if the + filename="gobject/gbinding.c" + line="1061">the target #GObject, or %NULL if the target does not exist any more. a #GBinding + filename="gobject/gbinding.c" + line="1049">a #GBinding @@ -494,30 +481,29 @@ function. glib:get-property="target-property" version="2.26"> Retrieves the name of the property of #GBinding:target used as the target + filename="gobject/gbinding.c" + line="1127">Retrieves the name of the property of #GBinding:target used as the target of the binding. - + the name of the target property + filename="gobject/gbinding.c" + line="1134">the name of the target property a #GBinding + filename="gobject/gbinding.c" + line="1129">a #GBinding Explicitly releases the binding between the source and the target + filename="gobject/gbinding.c" + line="1146">Explicitly releases the binding between the source and the target property expressed by @binding. This function will release the reference that is being held on @@ -528,16 +514,15 @@ to hold a reference to it. Note however that this function does not take ownership of @binding, it only unrefs the reference that was initially created by g_object_bind_property() and is owned by the binding. - + a #GBinding + filename="gobject/gbinding.c" + line="1148">a #GBinding @@ -550,8 +535,8 @@ g_object_bind_property() and is owned by the binding. getter="get_flags" default-value="G_BINDING_DEFAULT"> Flags to be used to control the #GBinding + filename="gobject/gbinding.c" + line="941">Flags to be used to control the #GBinding transfer-ownership="none" getter="get_source"> The #GObject that should be used as the source of the binding + filename="gobject/gbinding.c" + line="881">The #GObject that should be used as the source of the binding getter="get_source_property" default-value="NULL"> The name of the property of #GBinding:source that should be used + filename="gobject/gbinding.c" + line="907">The name of the property of #GBinding:source that should be used as the source of the binding. This should be in [canonical form][canonical-parameter-names] to get the @@ -588,8 +573,8 @@ best performance. transfer-ownership="none" getter="get_target"> The #GObject that should be used as the target of the binding + filename="gobject/gbinding.c" + line="894">The #GObject that should be used as the target of the binding getter="get_target_property" default-value="NULL"> The name of the property of #GBinding:target that should be used + filename="gobject/gbinding.c" + line="924">The name of the property of #GBinding:target that should be used as the target of the binding. This should be in [canonical form][canonical-parameter-names] to get the @@ -615,8 +600,8 @@ best performance. glib:get-type="g_binding_flags_get_type" c:type="GBindingFlags"> Flags to be passed to g_object_bind_property() or + filename="gobject/gbinding.h" + line="68">Flags to be passed to g_object_bind_property() or g_object_bind_property_full(). This enumeration can be extended at later date. @@ -626,8 +611,8 @@ This enumeration can be extended at later date. glib:nick="default" glib:name="G_BINDING_DEFAULT"> The default binding; if the source property + filename="gobject/gbinding.h" + line="70">The default binding; if the source property changes, the target property is updated with its value. glib:nick="bidirectional" glib:name="G_BINDING_BIDIRECTIONAL"> Bidirectional binding; if either the + filename="gobject/gbinding.h" + line="72">Bidirectional binding; if either the property of the source or the property of the target changes, the other is updated. @@ -647,8 +632,8 @@ This enumeration can be extended at later date. glib:nick="sync-create" glib:name="G_BINDING_SYNC_CREATE"> Synchronize the values of the source and + filename="gobject/gbinding.h" + line="75">Synchronize the values of the source and target properties when creating the binding; the direction of the synchronization is always from the source to the target. @@ -658,8 +643,8 @@ This enumeration can be extended at later date. glib:nick="invert-boolean" glib:name="G_BINDING_INVERT_BOOLEAN"> If the two properties being bound are + filename="gobject/gbinding.h" + line="78">If the two properties being bound are booleans, setting one to %TRUE will result in the other being set to %FALSE and vice versa. This flag will only work for boolean properties, and cannot be used when passing custom @@ -674,72 +659,70 @@ This enumeration can be extended at later date. glib:type-name="GBindingGroup" glib:get-type="g_binding_group_get_type"> The #GBindingGroup can be used to bind multiple properties + filename="gobject/gbindinggroup.c" + line="29">`GBindingGroup` can be used to bind multiple properties from an object collectively. Use the various methods to bind properties from a single source object to multiple destination objects. Properties can be bound bidirectionally and are connected when the source object is set -with g_binding_group_set_source(). +with [method@GObject.BindingGroup.set_source]. Creates a new #GBindingGroup. - + filename="gobject/gbindinggroup.c" + line="362">Creates a new #GBindingGroup. + a new #GBindingGroup + filename="gobject/gbindinggroup.c" + line="367">a new #GBindingGroup Creates a binding between @source_property on the source object + filename="gobject/gbindinggroup.c" + line="557">Creates a binding between @source_property on the source object and @target_property on @target. Whenever the @source_property is changed the @target_property is updated using the same value. The binding flag %G_BINDING_SYNC_CREATE is automatically specified. See g_object_bind_property() for more information. - + the #GBindingGroup + filename="gobject/gbindinggroup.c" + line="559">the #GBindingGroup the property on the source to bind + filename="gobject/gbindinggroup.c" + line="560">the property on the source to bind the target #GObject + filename="gobject/gbindinggroup.c" + line="561">the target #GObject the property on @target to bind + filename="gobject/gbindinggroup.c" + line="562">the property on @target to bind the flags used to create the #GBinding + filename="gobject/gbindinggroup.c" + line="563">the flags used to create the #GBinding @@ -749,47 +732,46 @@ See g_object_bind_property() for more information. shadowed-by="bind_with_closures" version="2.72"> Creates a binding between @source_property on the source object and + filename="gobject/gbindinggroup.c" + line="588">Creates a binding between @source_property on the source object and @target_property on @target, allowing you to set the transformation functions to be used by the binding. The binding flag %G_BINDING_SYNC_CREATE is automatically specified. See g_object_bind_property_full() for more information. - + the #GBindingGroup + filename="gobject/gbindinggroup.c" + line="590">the #GBindingGroup the property on the source to bind + filename="gobject/gbindinggroup.c" + line="591">the property on the source to bind the target #GObject + filename="gobject/gbindinggroup.c" + line="592">the target #GObject the property on @target to bind + filename="gobject/gbindinggroup.c" + line="593">the property on @target to bind the flags used to create the #GBinding + filename="gobject/gbindinggroup.c" + line="594">the flags used to create the #GBinding allow-none="1" scope="notified"> the transformation function + filename="gobject/gbindinggroup.c" + line="595">the transformation function from the source object to the @target, or %NULL to use the default @@ -811,8 +793,8 @@ See g_object_bind_property_full() for more information. closure="6" destroy="7"> the transformation function + filename="gobject/gbindinggroup.c" + line="597">the transformation function from the @target to the source object, or %NULL to use the default @@ -821,8 +803,8 @@ See g_object_bind_property_full() for more information. nullable="1" allow-none="1"> custom data to be passed to the transformation + filename="gobject/gbindinggroup.c" + line="599">custom data to be passed to the transformation functions, or %NULL @@ -830,8 +812,8 @@ See g_object_bind_property_full() for more information. transfer-ownership="none" scope="async"> function to be called when disposing the binding, + filename="gobject/gbindinggroup.c" + line="601">function to be called when disposing the binding, to free the resources used by the transformation functions @@ -842,8 +824,8 @@ See g_object_bind_property_full() for more information. shadows="bind_full" version="2.72"> Creates a binding between @source_property on the source object and + filename="gobject/gbindinggroup.c" + line="632">Creates a binding between @source_property on the source object and @target_property on @target, allowing you to set the transformation functions to be used by the binding. The binding flag %G_BINDING_SYNC_CREATE is automatically specified. @@ -853,40 +835,39 @@ g_binding_group_bind_property_full(), using #GClosures instead of function pointers. See g_object_bind_property_with_closures() for more information. - + the #GBindingGroup + filename="gobject/gbindinggroup.c" + line="634">the #GBindingGroup the property on the source to bind + filename="gobject/gbindinggroup.c" + line="635">the property on the source to bind the target #GObject + filename="gobject/gbindinggroup.c" + line="636">the target #GObject the property on @target to bind + filename="gobject/gbindinggroup.c" + line="637">the property on @target to bind the flags used to create the #GBinding + filename="gobject/gbindinggroup.c" + line="638">the flags used to create the #GBinding nullable="1" allow-none="1"> a #GClosure wrapping the + filename="gobject/gbindinggroup.c" + line="639">a #GClosure wrapping the transformation function from the source object to the @target, or %NULL to use the default @@ -905,8 +886,8 @@ See g_object_bind_property_with_closures() for more information. nullable="1" allow-none="1"> a #GClosure wrapping the + filename="gobject/gbindinggroup.c" + line="642">a #GClosure wrapping the transformation function from the @target to the source object, or %NULL to use the default @@ -917,21 +898,20 @@ See g_object_bind_property_with_closures() for more information. c:identifier="g_binding_group_dup_source" version="2.72"> Gets the source object used for binding properties. - + filename="gobject/gbindinggroup.c" + line="377">Gets the source object used for binding properties. + a #GObject or %NULL. + filename="gobject/gbindinggroup.c" + line="383">a #GObject or %NULL. the #GBindingGroup + filename="gobject/gbindinggroup.c" + line="379">the #GBindingGroup @@ -941,22 +921,21 @@ See g_object_bind_property_with_closures() for more information. glib:set-property="source" version="2.72"> Sets @source as the source object used for creating property + filename="gobject/gbindinggroup.c" + line="422">Sets @source as the source object used for creating property bindings. If there is already a source object all bindings from it will be removed. Note that all properties that have been bound must exist on @source. - + the #GBindingGroup + filename="gobject/gbindinggroup.c" + line="424">the #GBindingGroup nullable="1" allow-none="1"> the source #GObject, + filename="gobject/gbindinggroup.c" + line="425">the source #GObject, or %NULL to clear it @@ -977,8 +956,8 @@ Note that all properties that have been bound must exist on @source. transfer-ownership="none" setter="set_source"> The source object used for binding properties. + filename="gobject/gbindinggroup.c" + line="340">The source object used for binding properties. @@ -986,40 +965,39 @@ Note that all properties that have been bound must exist on @source. c:type="GBindingTransformFunc" version="2.26"> A function to be called to transform @from_value to @to_value. + filename="gobject/gbinding.h" + line="43">A function to be called to transform @from_value to @to_value. If this is the @transform_to function of a binding, then @from_value is the @source_property on the @source object, and @to_value is the @target_property on the @target object. If this is the @transform_from function of a %G_BINDING_BIDIRECTIONAL binding, then those roles are reversed. - + %TRUE if the transformation was successful, and %FALSE + filename="gobject/gbinding.h" + line="58">%TRUE if the transformation was successful, and %FALSE otherwise a #GBinding + filename="gobject/gbinding.h" + line="45">a #GBinding the #GValue containing the value to transform + filename="gobject/gbinding.h" + line="46">the #GValue containing the value to transform the #GValue in which to store the transformed value + filename="gobject/gbinding.h" + line="47">the #GValue in which to store the transformed value allow-none="1" closure="3"> data passed to the transform function + filename="gobject/gbinding.h" + line="48">data passed to the transform function + + This function is provided by the user and should produce a copy of the passed in boxed structure. - + The newly created copy of the boxed structure. The boxed structure to be copied. @@ -1058,35 +1040,43 @@ of the passed in boxed structure. This function is provided by the user and should free the boxed structure passed. - + The boxed structure to be freed. + + + + Cast a function pointer to a #GCallback. - + a function pointer. @@ -1095,74 +1085,71 @@ structure passed. c:identifier="G_CCLOSURE_SWAP_DATA" introspectable="0"> Checks whether the user data of the #GCClosure should be passed as the first parameter to the callback. See g_cclosure_new_swap(). - + a #GCClosure A #GCClosure is a specialization of #GClosure for C function callbacks. - + the #GClosure the callback function A #GClosureMarshal function for use with signals with handlers that + filename="gobject/gmarshal.c" + line="2390">A #GClosureMarshal function for use with signals with handlers that take two boxed pointers as arguments and return a boolean. If you have such a signal, you will probably also need to use an accumulator, such as g_signal_accumulator_true_handled(). - + A #GClosure. + filename="gobject/gmarshal.c" + line="2392">A #GClosure. A #GValue to store the return value. May be %NULL + filename="gobject/gmarshal.c" + line="2393">A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. The length of the @param_values array. + filename="gobject/gmarshal.c" + line="2395">The length of the @param_values array. An array of #GValues holding the arguments + filename="gobject/gmarshal.c" + line="2396">An array of #GValues holding the arguments on which to invoke the callback of closure. @@ -1171,8 +1158,8 @@ accumulator, such as g_signal_accumulator_true_handled(). nullable="1" allow-none="1"> The invocation hint given as the last argument to + filename="gobject/gmarshal.c" + line="2398">The invocation hint given as the last argument to g_closure_invoke(). @@ -1181,8 +1168,8 @@ accumulator, such as g_signal_accumulator_true_handled(). nullable="1" allow-none="1"> Additional data specified when registering the + filename="gobject/gmarshal.c" + line="2400">Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() @@ -1193,18 +1180,17 @@ accumulator, such as g_signal_accumulator_true_handled(). c:identifier="g_cclosure_marshal_BOOLEAN__BOXED_BOXEDv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__BOXED_BOXED(). - + filename="gobject/gmarshal.c" + line="2450">The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__BOXED_BOXED(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="2452">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="2453">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="2456">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="2457">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="2458">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="2461">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="2462">the #GType of each argument from @args. @@ -1261,38 +1247,40 @@ accumulator, such as g_signal_accumulator_true_handled(). A marshaller for a #GCClosure with a callback of type -`gboolean (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter -denotes a flags type. - + filename="gobject/gmarshal.c" + line="2143">A #GClosureMarshal function for use with signals with handlers that +take a flags type as an argument and return a boolean. If you have +such a signal, you will probably also need to use an accumulator, +such as g_signal_accumulator_true_handled(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="2145">A #GClosure. a #GValue which can store the returned #gboolean + filename="gobject/gmarshal.c" + line="2146">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="2148">The length of the @param_values array. a #GValue array holding instance and arg1 + filename="gobject/gmarshal.c" + line="2149">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="2151">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="2153">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -1320,18 +1310,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_BOOLEAN__FLAGSv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__FLAGS(). - + filename="gobject/gmarshal.c" + line="2201">The #GVaClosureMarshal equivalent to g_cclosure_marshal_BOOLEAN__FLAGS(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="2203">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="2204">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="2207">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="2208">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="2209">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="2212">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="2213">the #GType of each argument from @args. @@ -1388,37 +1377,39 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`gchar* (*callback) (gpointer instance, GObject *arg1, gpointer arg2, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="2262">A #GClosureMarshal function for use with signals with handlers that +take a #GObject and a pointer and produce a string. It is highly +unlikely that your signal handler fits this description. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="2264">A #GClosure. a #GValue, which can store the returned string + filename="gobject/gmarshal.c" + line="2265">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 3 + filename="gobject/gmarshal.c" + line="2267">The length of the @param_values array. a #GValue array holding instance, arg1 and arg2 + filename="gobject/gmarshal.c" + line="2268">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="2270">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="2272">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -1446,18 +1439,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_STRING__OBJECT_POINTERv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_STRING__OBJECT_POINTER(). - + filename="gobject/gmarshal.c" + line="2321">The #GVaClosureMarshal equivalent to g_cclosure_marshal_STRING__OBJECT_POINTER(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="2323">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="2324">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="2327">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="2328">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="2329">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="2332">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="2333">the #GType of each argument from @args. @@ -1514,37 +1506,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gboolean arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="169">A #GClosureMarshal function for use with signals with a single +boolean argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="171">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="172">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="174">The length of the @param_values array. a #GValue array holding the instance and the #gboolean parameter + filename="gobject/gmarshal.c" + line="175">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="177">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="179">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -1572,18 +1567,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__BOOLEANv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOOLEAN(). - + filename="gobject/gmarshal.c" + line="221">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOOLEAN(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="223">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="224">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="227">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="228">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="229">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="232">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="233">the #GType of each argument from @args. @@ -1640,37 +1634,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, GBoxed *arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1581">A #GClosureMarshal function for use with signals with a single +argument which is any boxed pointer type. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1583">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1584">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1586">The length of the @param_values array. a #GValue array holding the instance and the #GBoxed* parameter + filename="gobject/gmarshal.c" + line="1587">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1589">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1591">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -1698,18 +1695,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__BOXEDv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOXED(). - + filename="gobject/gmarshal.c" + line="1633">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__BOXED(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1635">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="1636">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="1639">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="1640">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="1641">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="1644">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="1645">the #GType of each argument from @args. @@ -1766,37 +1762,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gchar arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="277">A #GClosureMarshal function for use with signals with a single +character argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="279">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="280">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="282">The length of the @param_values array. a #GValue array holding the instance and the #gchar parameter + filename="gobject/gmarshal.c" + line="283">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="285">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="287">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -1824,18 +1823,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__CHARv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__CHAR(). - + filename="gobject/gmarshal.c" + line="329">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__CHAR(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="331">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="332">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="335">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="336">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="337">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="340">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="341">the #GType of each argument from @args. @@ -1892,37 +1890,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gdouble arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1249">A #GClosureMarshal function for use with signals with one +double-precision floating point argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1251">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1252">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1254">The length of the @param_values array. a #GValue array holding the instance and the #gdouble parameter + filename="gobject/gmarshal.c" + line="1255">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1257">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1259">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -1950,18 +1951,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__DOUBLEv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__DOUBLE(). - + filename="gobject/gmarshal.c" + line="1301">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__DOUBLE(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1303">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="1304">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="1307">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="1308">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="1309">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="1312">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="1313">the #GType of each argument from @args. @@ -2018,37 +2018,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes an enumeration type.. - + filename="gobject/gmarshal.c" + line="925">A #GClosureMarshal function for use with signals with a single +argument with an enumerated type. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="927">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="928">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="930">The length of the @param_values array. a #GValue array holding the instance and the enumeration parameter + filename="gobject/gmarshal.c" + line="931">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="933">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="935">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -2076,18 +2079,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__ENUMv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ENUM(). - + filename="gobject/gmarshal.c" + line="977">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ENUM(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="979">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="980">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="983">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="984">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="985">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="988">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="989">the #GType of each argument from @args. @@ -2144,37 +2146,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type. - + filename="gobject/gmarshal.c" + line="1033">A #GClosureMarshal function for use with signals with a single +argument with a flags types. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1035">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1036">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1038">The length of the @param_values array. a #GValue array holding the instance and the flags parameter + filename="gobject/gmarshal.c" + line="1039">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1041">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1043">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -2202,18 +2207,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__FLAGSv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLAGS(). - + filename="gobject/gmarshal.c" + line="1085">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLAGS(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1087">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="1088">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="1091">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="1092">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="1093">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="1096">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="1097">the #GType of each argument from @args. @@ -2270,37 +2274,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gfloat arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1141">A #GClosureMarshal function for use with signals with one +single-precision floating point argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1143">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1144">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1146">The length of the @param_values array. a #GValue array holding the instance and the #gfloat parameter + filename="gobject/gmarshal.c" + line="1147">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1149">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1151">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -2328,18 +2335,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__FLOATv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLOAT(). - + filename="gobject/gmarshal.c" + line="1193">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__FLOAT(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1195">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="1196">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="1199">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="1200">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="1201">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="1204">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="1205">the #GType of each argument from @args. @@ -2396,37 +2402,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gint arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="493">A #GClosureMarshal function for use with signals with a single +integer argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="495">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="496">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="498">The length of the @param_values array. a #GValue array holding the instance and the #gint parameter + filename="gobject/gmarshal.c" + line="499">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="501">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="503">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -2454,18 +2463,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__INTv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__INT(). - + filename="gobject/gmarshal.c" + line="545">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__INT(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="547">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="548">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="551">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="552">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="553">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="556">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="557">the #GType of each argument from @args. @@ -2522,37 +2530,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, glong arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="709">A #GClosureMarshal function for use with signals with with a single +long integer argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="711">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="712">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="714">The length of the @param_values array. a #GValue array holding the instance and the #glong parameter + filename="gobject/gmarshal.c" + line="715">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="717">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="719">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -2580,18 +2591,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__LONGv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__LONG(). - + filename="gobject/gmarshal.c" + line="761">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__LONG(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="763">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="764">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="767">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="768">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="769">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="772">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="773">the #GType of each argument from @args. @@ -2648,37 +2658,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, GObject *arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1805">A #GClosureMarshal function for use with signals with a single +#GObject argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1807">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1808">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1810">The length of the @param_values array. a #GValue array holding the instance and the #GObject* parameter + filename="gobject/gmarshal.c" + line="1811">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1813">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1815">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -2706,18 +2719,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__OBJECTv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__OBJECT(). - + filename="gobject/gmarshal.c" + line="1857">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__OBJECT(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1859">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="1860">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="1863">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="1864">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="1865">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="1868">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="1869">the #GType of each argument from @args. @@ -2774,37 +2786,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, GParamSpec *arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1469">A #GClosureMarshal function for use with signals with a single +argument of type #GParamSpec. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1471">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1472">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1474">The length of the @param_values array. a #GValue array holding the instance and the #GParamSpec* parameter + filename="gobject/gmarshal.c" + line="1475">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1477">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1479">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -2832,18 +2847,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__PARAMv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__PARAM(). - + filename="gobject/gmarshal.c" + line="1521">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__PARAM(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1523">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="1524">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="1527">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="1528">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="1529">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="1532">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="1533">the #GType of each argument from @args. @@ -2900,37 +2914,42 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gpointer arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1693">A #GClosureMarshal function for use with signals with a single raw +pointer argument type. + +If it is possible, it is better to use one of the more specific +functions such as g_cclosure_marshal_VOID__OBJECT() or +g_cclosure_marshal_VOID__OBJECT(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1695">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1696">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1698">The length of the @param_values array. a #GValue array holding the instance and the #gpointer parameter + filename="gobject/gmarshal.c" + line="1699">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1701">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1703">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -2958,18 +2979,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__POINTERv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__POINTER(). - + filename="gobject/gmarshal.c" + line="1749">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__POINTER(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1751">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="1752">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="1755">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="1756">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="1757">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="1760">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="1761">the #GType of each argument from @args. @@ -3026,37 +3046,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, const gchar *arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1357">A #GClosureMarshal function for use with signals with a single string +argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1359">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1360">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1362">The length of the @param_values array. a #GValue array holding the instance and the #gchar* parameter + filename="gobject/gmarshal.c" + line="1363">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1365">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1367">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -3084,18 +3107,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__STRINGv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__STRING(). - + filename="gobject/gmarshal.c" + line="1409">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__STRING(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1411">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="1412">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="1415">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="1416">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="1417">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="1420">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="1421">the #GType of each argument from @args. @@ -3152,37 +3174,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, guchar arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="385">A #GClosureMarshal function for use with signals with a single +unsigned character argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="387">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="388">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="390">The length of the @param_values array. a #GValue array holding the instance and the #guchar parameter + filename="gobject/gmarshal.c" + line="391">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="393">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="395">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -3210,18 +3235,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__UCHARv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UCHAR(). - + filename="gobject/gmarshal.c" + line="437">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UCHAR(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="439">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="440">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="443">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="444">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="445">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="448">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="449">the #GType of each argument from @args. @@ -3278,37 +3302,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, guint arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="601">A #GClosureMarshal function for use with signals with with a single +unsigned integer argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="603">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="604">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="606">The length of the @param_values array. a #GValue array holding the instance and the #guint parameter + filename="gobject/gmarshal.c" + line="607">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="609">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="611">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -3335,37 +3362,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, guint arg1, gpointer arg2, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="2029">A #GClosureMarshal function for use with signals with an unsigned int +and a pointer as arguments. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="2031">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="2032">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 3 + filename="gobject/gmarshal.c" + line="2034">The length of the @param_values array. a #GValue array holding instance, arg1 and arg2 + filename="gobject/gmarshal.c" + line="2035">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="2037">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="2039">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -3393,18 +3423,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__UINT_POINTERv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT_POINTER(). - + filename="gobject/gmarshal.c" + line="2083">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT_POINTER(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="2085">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="2086">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="2089">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="2090">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="2091">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="2094">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="2095">the #GType of each argument from @args. @@ -3462,18 +3491,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__UINTv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT(). - + filename="gobject/gmarshal.c" + line="653">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__UINT(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="655">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="656">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="659">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="660">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="661">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="664">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="665">the #GType of each argument from @args. @@ -3530,37 +3558,38 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gulong arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="817">A #GClosureMarshal function for use with signals with a single +unsigned long integer argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="819">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="820">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="822">The length of the @param_values array. a #GValue array holding the instance and the #gulong parameter + filename="gobject/gmarshal.c" + line="823">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="825">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="827">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -3588,18 +3619,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__ULONGv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ULONG(). - + filename="gobject/gmarshal.c" + line="869">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__ULONG(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="871">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="872">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="875">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="876">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="877">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="880">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="881">the #GType of each argument from @args. @@ -3654,40 +3684,40 @@ denotes a flags type. - A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, GVariant *arg1, gpointer user_data)`. - + c:identifier="g_cclosure_marshal_VOID__VARIANT"> + A #GClosureMarshal function for use with signals with a single +#GVariant argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1919">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1920">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1922">The length of the @param_values array. a #GValue array holding the instance and the #GVariant* parameter + filename="gobject/gmarshal.c" + line="1923">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1925">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1927">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -3715,18 +3747,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__VARIANTv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VARIANT(). - + filename="gobject/gmarshal.c" + line="1969">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VARIANT(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1971">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="1972">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="1975">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="1976">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="1977">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="1980">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="1981">the #GType of each argument from @args. @@ -3783,37 +3814,37 @@ denotes a flags type. A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="72">A #GClosureMarshal function for use with signals with no arguments. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="74">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="75">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 1 + filename="gobject/gmarshal.c" + line="77">The length of the @param_values array. a #GValue array holding only the instance + filename="gobject/gmarshal.c" + line="78">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="80">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="82">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -3841,18 +3874,17 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__VOIDv" introspectable="0"> The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VOID(). - + filename="gobject/gmarshal.c" + line="121">The #GVaClosureMarshal equivalent to g_cclosure_marshal_VOID__VOID(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="123">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gmarshal.c" + line="124">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is invoked. + filename="gobject/gmarshal.c" + line="127">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gmarshal.c" + line="128">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gmarshal.c" + line="129">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gmarshal.c" + line="132">the length of the @param_types array the #GType of each argument from + filename="gobject/gmarshal.c" + line="133">the #GType of each argument from @args. @@ -3910,41 +3942,40 @@ denotes a flags type. c:identifier="g_cclosure_marshal_generic" version="2.30"> A generic marshaller function implemented via + filename="gobject/gclosure.c" + line="1445">A generic marshaller function implemented via [libffi](http://sourceware.org/libffi/). Normally this function is not passed explicitly to g_signal_new(), but used automatically by GLib when specifying a %NULL marshaller. - + A #GClosure. + filename="gobject/gclosure.c" + line="1447">A #GClosure. A #GValue to store the return value. May be %NULL + filename="gobject/gclosure.c" + line="1448">A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. The length of the @param_values array. + filename="gobject/gclosure.c" + line="1450">The length of the @param_values array. An array of #GValues holding the arguments + filename="gobject/gclosure.c" + line="1451">An array of #GValues holding the arguments on which to invoke the callback of closure. @@ -3953,8 +3984,8 @@ but used automatically by GLib when specifying a %NULL marshaller. nullable="1" allow-none="1"> The invocation hint given as the last argument to + filename="gobject/gclosure.c" + line="1453">The invocation hint given as the last argument to g_closure_invoke(). @@ -3963,8 +3994,8 @@ but used automatically by GLib when specifying a %NULL marshaller. nullable="1" allow-none="1"> Additional data specified when registering the + filename="gobject/gclosure.c" + line="1455">Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() @@ -3976,19 +4007,18 @@ but used automatically by GLib when specifying a %NULL marshaller. version="2.30" introspectable="0"> A generic #GVaClosureMarshal function implemented via + filename="gobject/gclosure.c" + line="1544">A generic #GVaClosureMarshal function implemented via [libffi](http://sourceware.org/libffi/). - + the #GClosure to which the marshaller belongs + filename="gobject/gclosure.c" + line="1546">the #GClosure to which the marshaller belongs nullable="1" allow-none="1"> a #GValue to store the return + filename="gobject/gclosure.c" + line="1547">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the instance on which the closure is + filename="gobject/gclosure.c" + line="1550">the instance on which the closure is invoked. va_list of arguments to be passed to the closure. + filename="gobject/gclosure.c" + line="1552">va_list of arguments to be passed to the closure. nullable="1" allow-none="1"> additional data specified when + filename="gobject/gclosure.c" + line="1553">additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() the length of the @param_types array + filename="gobject/gclosure.c" + line="1556">the length of the @param_types array the #GType of each argument from + filename="gobject/gclosure.c" + line="1557">the #GType of each argument from @args_list. @@ -4045,17 +4075,16 @@ but used automatically by GLib when specifying a %NULL marshaller. Creates a new closure which invokes @callback_func with @user_data as + filename="gobject/gclosure.c" + line="958">Creates a new closure which invokes @callback_func with @user_data as the last parameter. @destroy_data will be called as a finalize notifier on the #GClosure. - - + + a floating reference to a new #GCClosure + filename="gobject/gclosure.c" + line="969">a floating reference to a new #GCClosure @@ -4065,8 +4094,8 @@ the last parameter. allow-none="1" closure="1"> the function to invoke + filename="gobject/gclosure.c" + line="960">the function to invoke user data to pass to @callback_func + filename="gobject/gclosure.c" + line="961">user data to pass to @callback_func destroy notify to be called when @user_data is no longer used + filename="gobject/gclosure.c" + line="962">destroy notify to be called when @user_data is no longer used @@ -4091,31 +4120,30 @@ the last parameter. c:identifier="g_cclosure_new_object" introspectable="0"> A variant of g_cclosure_new() which uses @object as @user_data and + filename="gobject/gobject.c" + line="5312">A variant of g_cclosure_new() which uses @object as @user_data and calls g_object_watch_closure() on @object and the created closure. This function is useful when you have a callback closely associated with a #GObject, and want the callback to no longer run after the object is is freed. - - + + a new #GCClosure + filename="gobject/gobject.c" + line="5323">a new #GCClosure the function to invoke + filename="gobject/gobject.c" + line="5314">the function to invoke a #GObject pointer to pass to @callback_func + filename="gobject/gobject.c" + line="5315">a #GObject pointer to pass to @callback_func @@ -4124,31 +4152,30 @@ after the object is is freed. c:identifier="g_cclosure_new_object_swap" introspectable="0"> A variant of g_cclosure_new_swap() which uses @object as @user_data + filename="gobject/gobject.c" + line="5341">A variant of g_cclosure_new_swap() which uses @object as @user_data and calls g_object_watch_closure() on @object and the created closure. This function is useful when you have a callback closely associated with a #GObject, and want the callback to no longer run after the object is is freed. - - + + a new #GCClosure + filename="gobject/gobject.c" + line="5352">a new #GCClosure the function to invoke + filename="gobject/gobject.c" + line="5343">the function to invoke a #GObject pointer to pass to @callback_func + filename="gobject/gobject.c" + line="5344">a #GObject pointer to pass to @callback_func @@ -4157,17 +4184,16 @@ after the object is is freed. c:identifier="g_cclosure_new_swap" introspectable="0"> Creates a new closure which invokes @callback_func with @user_data as + filename="gobject/gclosure.c" + line="988">Creates a new closure which invokes @callback_func with @user_data as the first parameter. @destroy_data will be called as a finalize notifier on the #GClosure. - - + + a floating reference to a new #GCClosure + filename="gobject/gclosure.c" + line="999">a floating reference to a new #GCClosure @@ -4177,8 +4203,8 @@ the first parameter. allow-none="1" closure="1"> the function to invoke + filename="gobject/gclosure.c" + line="990">the function to invoke user data to pass to @callback_func + filename="gobject/gclosure.c" + line="991">user data to pass to @callback_func destroy notify to be called when @user_data is no longer used + filename="gobject/gclosure.c" + line="992">destroy notify to be called when @user_data is no longer used @@ -4204,14 +4230,13 @@ the first parameter. c:identifier="G_CLOSURE_NEEDS_MARSHAL" introspectable="0"> Check if the closure still needs a marshaller. See g_closure_set_marshal(). - + a #GClosure @@ -4220,26 +4245,25 @@ the first parameter. c:identifier="G_CLOSURE_N_NOTIFIERS" introspectable="0"> Get the total number of notifiers connected with the closure @cl. The count includes the meta marshaller, the finalize and invalidate notifiers and the marshal guards. Note that each guard counts as two notifiers. See g_closure_set_meta_marshal(), g_closure_add_finalize_notifier(), g_closure_add_invalidate_notifier() and g_closure_add_marshal_guards(). - + a #GClosure The type used for callback functions in structure definitions and function signatures. @@ -4248,16 +4272,20 @@ return void. The required signature of a callback function is determined by the context in which is used (e.g. the signal to which it is connected). Use G_CALLBACK() to cast the callback function to a #GCallback. - + + + A callback function used by the type system to finalize a class. + filename="gobject/gtype.h" + line="945">A callback function used by the type system to finalize a class. This function is rarely needed, as dynamically allocated class resources should be handled by GBaseInitFunc() and GBaseFinalizeFunc(). @@ -4266,16 +4294,15 @@ Also, specification of a GClassFinalizeFunc() in the #GTypeInfo structure of a static type is invalid, because classes of static types will never be finalized (they are artificially kept alive when their reference count drops to zero). - + The #GTypeClass structure to finalize + filename="gobject/gtype.h" + line="947">The #GTypeClass structure to finalize nullable="1" allow-none="1"> The @class_data member supplied via the #GTypeInfo structure + filename="gobject/gtype.h" + line="948">The @class_data member supplied via the #GTypeInfo structure A callback function used by the type system to initialize the class + filename="gobject/gtype.h" + line="840">A callback function used by the type system to initialize the class of a specific type. This function should initialize all static class members. @@ -4389,16 +4416,15 @@ is called to complete the initialization process with the static members Corresponding finalization counter parts to the GBaseInitFunc() functions have to be provided to release allocated resources at class finalization time. - + The #GTypeClass structure to initialize. + filename="gobject/gtype.h" + line="842">The #GTypeClass structure to initialize. nullable="1" allow-none="1"> The @class_data member supplied via the #GTypeInfo structure. + filename="gobject/gtype.h" + line="843">The @class_data member supplied via the #GTypeInfo structure. @@ -4418,8 +4444,8 @@ time. glib:get-type="g_closure_get_type" c:symbol-prefix="closure"> A #GClosure represents a callback supplied by the programmer. + filename="gobject/gclosure.c" + line="41">A `GClosure` represents a callback supplied by the programmer. It will generally comprise a function of some kind and a marshaller used to call it. It is the responsibility of the marshaller to @@ -4463,8 +4489,7 @@ callback function/data pointer combination: - g_closure_invalidate() and invalidation notifiers allow callbacks to be automatically removed when the objects they point to go away. - + @@ -4491,22 +4516,21 @@ callback function/data pointer combination: Indicates whether the closure is currently being invoked with - g_closure_invoke() + filename="gobject/gclosure.c" + line="43">Indicates whether the closure is currently being invoked with + g_closure_invoke() Indicates whether the closure has been invalidated by - g_closure_invalidate() + filename="gobject/gclosure.c" + line="45">Indicates whether the closure has been invalidated by + g_closure_invalidate() - + @@ -4540,31 +4564,30 @@ callback function/data pointer combination: A variant of g_closure_new_simple() which stores @object in the + filename="gobject/gobject.c" + line="5283">A variant of g_closure_new_simple() which stores @object in the @data field of the closure and calls g_object_watch_closure() on @object and the created closure. This function is mainly useful when implementing new types of closures. - - + + a newly allocated #GClosure + filename="gobject/gobject.c" + line="5295">a newly allocated #GClosure the size of the structure to allocate, must be at least + filename="gobject/gobject.c" + line="5285">the size of the structure to allocate, must be at least `sizeof (GClosure)` a #GObject pointer to store in the @data field of the newly + filename="gobject/gobject.c" + line="5287">a #GObject pointer to store in the @data field of the newly allocated #GClosure @@ -4572,8 +4595,8 @@ when implementing new types of closures. Allocates a struct of the given size and initializes the initial + filename="gobject/gclosure.c" + line="151">Allocates a struct of the given size and initializes the initial part as a #GClosure. This function is mainly useful when implementing new types of closures: @@ -4610,19 +4633,18 @@ MyClosure *my_closure_new (gpointer data) return my_closure; } ]| - - + + a floating reference to a new #GClosure + filename="gobject/gclosure.c" + line="195">a floating reference to a new #GClosure the size of the structure to allocate, must be at least + filename="gobject/gclosure.c" + line="153">the size of the structure to allocate, must be at least `sizeof (GClosure)` @@ -4631,8 +4653,8 @@ MyClosure *my_closure_new (gpointer data) nullable="1" allow-none="1"> data to store in the @data field of the newly allocated #GClosure + filename="gobject/gclosure.c" + line="155">data to store in the @data field of the newly allocated #GClosure @@ -4641,24 +4663,23 @@ MyClosure *my_closure_new (gpointer data) c:identifier="g_closure_add_finalize_notifier" introspectable="0"> Registers a finalization notifier which will be called when the + filename="gobject/gclosure.c" + line="435">Registers a finalization notifier which will be called when the reference count of @closure goes down to 0. Multiple finalization notifiers on a single closure are invoked in unspecified order. If a single call to g_closure_unref() results in the closure being both invalidated and finalized, then the invalidate notifiers will be run before the finalize notifiers. - + a #GClosure + filename="gobject/gclosure.c" + line="437">a #GClosure allow-none="1" closure="1"> data to pass to @notify_func + filename="gobject/gclosure.c" + line="438">data to pass to @notify_func nullable="1" allow-none="1"> the callback function to register + filename="gobject/gclosure.c" + line="439">the callback function to register @@ -4686,22 +4707,21 @@ notifiers will be run before the finalize notifiers. c:identifier="g_closure_add_invalidate_notifier" introspectable="0"> Registers an invalidation notifier which will be called when the + filename="gobject/gclosure.c" + line="472">Registers an invalidation notifier which will be called when the @closure is invalidated with g_closure_invalidate(). Invalidation notifiers are invoked before finalization notifiers, in an unspecified order. - + a #GClosure + filename="gobject/gclosure.c" + line="474">a #GClosure allow-none="1" closure="1"> data to pass to @notify_func + filename="gobject/gclosure.c" + line="475">data to pass to @notify_func nullable="1" allow-none="1"> the callback function to register + filename="gobject/gclosure.c" + line="476">the callback function to register @@ -4729,23 +4749,22 @@ in an unspecified order. c:identifier="g_closure_add_marshal_guards" introspectable="0"> Adds a pair of notifiers which get invoked before and after the + filename="gobject/gclosure.c" + line="374">Adds a pair of notifiers which get invoked before and after the closure callback, respectively. This is typically used to protect the extra arguments for the duration of the callback. See g_object_watch_closure() for an example of marshal guards. - + a #GClosure + filename="gobject/gclosure.c" + line="376">a #GClosure allow-none="1" closure="1"> data to pass + filename="gobject/gclosure.c" + line="377">data to pass to @pre_marshal_notify @@ -4765,8 +4784,8 @@ example of marshal guards. allow-none="1" closure="2"> a function to call before the closure callback + filename="gobject/gclosure.c" + line="379">a function to call before the closure callback allow-none="1" closure="3"> data to pass + filename="gobject/gclosure.c" + line="380">data to pass to @post_marshal_notify @@ -4785,16 +4804,16 @@ example of marshal guards. nullable="1" allow-none="1"> a function to call after the closure callback + filename="gobject/gclosure.c" + line="382">a function to call after the closure callback Sets a flag on the closure to indicate that its calling + filename="gobject/gclosure.c" + line="570">Sets a flag on the closure to indicate that its calling environment has become invalid, and thus causes any future invocations of g_closure_invoke() on this @closure to be ignored. @@ -4809,34 +4828,32 @@ that you've previously called g_closure_ref(). Note that g_closure_invalidate() will also be called when the reference count of a closure drops to zero (unless it has already been invalidated before). - + #GClosure to invalidate + filename="gobject/gclosure.c" + line="572">#GClosure to invalidate Invokes the closure, i.e. executes the callback represented by the @closure. - + filename="gobject/gclosure.c" + line="785">Invokes the closure, i.e. executes the callback represented by the @closure. + a #GClosure + filename="gobject/gclosure.c" + line="787">a #GClosure optional="1" allow-none="1"> a #GValue to store the return + filename="gobject/gclosure.c" + line="788">a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. the length of the @param_values array + filename="gobject/gclosure.c" + line="791">the length of the @param_values array an array of + filename="gobject/gclosure.c" + line="792">an array of #GValues holding the arguments on which to invoke the callback of @closure @@ -4873,30 +4890,29 @@ been invalidated before). nullable="1" allow-none="1"> a context-dependent invocation hint + filename="gobject/gclosure.c" + line="795">a context-dependent invocation hint Increments the reference count on a closure to force it staying + filename="gobject/gclosure.c" + line="547">Increments the reference count on a closure to force it staying alive while the caller holds a pointer to it. - + The @closure passed in, for convenience + filename="gobject/gclosure.c" + line="554">The @closure passed in, for convenience #GClosure to increment the reference count on + filename="gobject/gclosure.c" + line="549">#GClosure to increment the reference count on @@ -4905,20 +4921,19 @@ alive while the caller holds a pointer to it. c:identifier="g_closure_remove_finalize_notifier" introspectable="0"> Removes a finalization notifier. + filename="gobject/gclosure.c" + line="757">Removes a finalization notifier. Notice that notifiers are automatically removed after they are run. - + a #GClosure + filename="gobject/gclosure.c" + line="759">a #GClosure nullable="1" allow-none="1"> data which was passed to g_closure_add_finalize_notifier() + filename="gobject/gclosure.c" + line="760">data which was passed to g_closure_add_finalize_notifier() when registering @notify_func the callback function to remove + filename="gobject/gclosure.c" + line="762">the callback function to remove @@ -4943,20 +4958,19 @@ Notice that notifiers are automatically removed after they are run. c:identifier="g_closure_remove_invalidate_notifier" introspectable="0"> Removes an invalidation notifier. + filename="gobject/gclosure.c" + line="729">Removes an invalidation notifier. Notice that notifiers are automatically removed after they are run. - + a #GClosure + filename="gobject/gclosure.c" + line="731">a #GClosure nullable="1" allow-none="1"> data which was passed to g_closure_add_invalidate_notifier() + filename="gobject/gclosure.c" + line="732">data which was passed to g_closure_add_invalidate_notifier() when registering @notify_func the callback function to remove + filename="gobject/gclosure.c" + line="734">the callback function to remove @@ -4981,8 +4995,8 @@ Notice that notifiers are automatically removed after they are run. c:identifier="g_closure_set_marshal" introspectable="0"> Sets the marshaller of @closure. + filename="gobject/gclosure.c" + line="910">Sets the marshaller of @closure. The `marshal_data` of @marshal provides a way for a meta marshaller to provide additional information to the marshaller. @@ -4992,22 +5006,21 @@ functions), what it provides is a callback function to use instead of @closure->callback. See also: g_closure_set_meta_marshal() - + a #GClosure + filename="gobject/gclosure.c" + line="912">a #GClosure a #GClosureMarshal function + filename="gobject/gclosure.c" + line="913">a #GClosureMarshal function @@ -5016,8 +5029,8 @@ See also: g_closure_set_meta_marshal() c:identifier="g_closure_set_meta_marshal" introspectable="0"> Sets the meta marshaller of @closure. + filename="gobject/gclosure.c" + line="329">Sets the meta marshaller of @closure. A meta marshaller wraps the @closure's marshal and modifies the way it is called in some fashion. The most common use of this facility @@ -5034,16 +5047,15 @@ g_signal_type_cclosure_new()) retrieve the callback function from a fixed offset in the class structure. The meta marshaller retrieves the right callback and passes it to the marshaller as the @marshal_data argument. - + a #GClosure + filename="gobject/gclosure.c" + line="331">a #GClosure context-dependent data to pass + filename="gobject/gclosure.c" + line="332">context-dependent data to pass to @meta_marshal @@ -5062,16 +5074,16 @@ the right callback and passes it to the marshaller as the nullable="1" allow-none="1"> a #GClosureMarshal function + filename="gobject/gclosure.c" + line="334">a #GClosureMarshal function Takes over the initial ownership of a closure. + filename="gobject/gclosure.c" + line="655">Takes over the initial ownership of a closure. Each closure is initially created in a "floating" state, which means that the initial reference count is not owned by any caller. @@ -5118,16 +5130,15 @@ foo_notify_set_closure (GClosure *closure) Because g_closure_sink() may decrement the reference count of a closure (if it hasn't been called on @closure yet) just like g_closure_unref(), g_closure_ref() should be called prior to this function. - + #GClosure to decrement the initial reference count on, if it's + filename="gobject/gclosure.c" + line="657">#GClosure to decrement the initial reference count on, if it's still being held @@ -5135,22 +5146,21 @@ g_closure_ref() should be called prior to this function. Decrements the reference count of a closure after it was previously + filename="gobject/gclosure.c" + line="607">Decrements the reference count of a closure after it was previously incremented by the same caller. If no other callers are using the closure, then the closure will be destroyed and freed. - + #GClosure to decrement the reference count on + filename="gobject/gclosure.c" + line="609">#GClosure to decrement the reference count on @@ -5158,17 +5168,16 @@ destroyed and freed. The type used for marshaller functions. - + the #GClosure to which the marshaller belongs @@ -5177,7 +5186,7 @@ destroyed and freed. nullable="1" allow-none="1"> a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. @@ -5185,13 +5194,13 @@ destroyed and freed. the length of the @param_values array an array of #GValues holding the arguments on which to invoke the callback of @closure @@ -5204,7 +5213,7 @@ destroyed and freed. nullable="1" allow-none="1"> the invocation hint given as the last argument to g_closure_invoke() @@ -5214,7 +5223,7 @@ destroyed and freed. nullable="1" allow-none="1"> additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() @@ -5224,11 +5233,10 @@ destroyed and freed. The type used for the various notification callbacks which can be registered on closures. - + @@ -5238,21 +5246,20 @@ on closures. nullable="1" allow-none="1"> data specified when registering the notification callback the #GClosure on which the notification is emitted - + @@ -5262,26 +5269,25 @@ on closures. The connection flags are used to specify the behaviour of a signal's connection. - + Default behaviour (no special flags). Since: 2.74 If set, the handler should be called after the default handler of the signal. Normally, the handler is called before the default handler. If set, the instance and data should be swapped when calling the handler; see g_signal_connect_swapped() for an example. @@ -5291,8 +5297,8 @@ connection. version="2.44" introspectable="0"> A convenience macro for emitting the usual declarations in the + filename="gobject/gtype.h" + line="1617">A convenience macro for emitting the usual declarations in the header file for a type which is intended to be subclassed. You might use it in a header as follows: @@ -5368,34 +5374,33 @@ structures, use G_DECLARE_FINAL_TYPE(). If you must use G_DECLARE_DERIVABLE_TYPE() you should be sure to include some padding at the bottom of your class structure to leave space for the addition of future virtual functions. - + The name of the new type, in camel case (like `GtkWidget`) + filename="gobject/gtype.h" + line="1619">The name of the new type, in camel case (like `GtkWidget`) The name of the new type in lowercase, with words + filename="gobject/gtype.h" + line="1620">The name of the new type in lowercase, with words separated by `_` (like `gtk_widget`) The name of the module, in all caps (like `GTK`) + filename="gobject/gtype.h" + line="1622">The name of the module, in all caps (like `GTK`) The bare name of the type, in all caps (like `WIDGET`) + filename="gobject/gtype.h" + line="1623">The bare name of the type, in all caps (like `WIDGET`) the name of the parent type, in camel case (like `GtkWidget`) + filename="gobject/gtype.h" + line="1624">the name of the parent type, in camel case (like `GtkWidget`) @@ -5404,8 +5409,8 @@ class structure to leave space for the addition of future virtual functions. A convenience macro for emitting the usual declarations in the header file + filename="gobject/gtype.h" + line="1525">A convenience macro for emitting the usual declarations in the header file for a type which is not (at the present time) intended to be subclassed. You might use it in a header as follows: @@ -5470,34 +5475,33 @@ G_DECLARE_FINAL_TYPE() to G_DECLARE_DERIVABLE_TYPE() without breaking API or ABI should therefore use G_DECLARE_FINAL_TYPE() until you are sure that it makes sense for your class to be subclassed. Once a class structure has been exposed it is not possible to change its size or remove or reorder items without breaking the API and/or ABI. - + The name of the new type, in camel case (like `GtkWidget`) + filename="gobject/gtype.h" + line="1527">The name of the new type, in camel case (like `GtkWidget`) The name of the new type in lowercase, with words + filename="gobject/gtype.h" + line="1528">The name of the new type in lowercase, with words separated by `_` (like `gtk_widget`) The name of the module, in all caps (like `GTK`) + filename="gobject/gtype.h" + line="1530">The name of the module, in all caps (like `GTK`) The bare name of the type, in all caps (like `WIDGET`) + filename="gobject/gtype.h" + line="1531">The bare name of the type, in all caps (like `WIDGET`) the name of the parent type, in camel case (like `GtkWidget`) + filename="gobject/gtype.h" + line="1532">the name of the parent type, in camel case (like `GtkWidget`) @@ -5506,8 +5510,8 @@ reorder items without breaking the API and/or ABI. version="2.44" introspectable="0"> A convenience macro for emitting the usual declarations in the header file for a #GInterface type. + filename="gobject/gtype.h" + line="1727">A convenience macro for emitting the usual declarations in the header file for a #GInterface type. You might use it in a header as follows: @@ -5565,34 +5569,33 @@ manually define this as a macro for yourself. The declaration of the `_get_type()` function is the first thing emitted by the macro. This allows this macro to be used in the usual way with export control and API versioning macros. - + The name of the new type, in camel case (like `GtkWidget`) + filename="gobject/gtype.h" + line="1729">The name of the new type, in camel case (like `GtkWidget`) The name of the new type in lowercase, with words + filename="gobject/gtype.h" + line="1730">The name of the new type in lowercase, with words separated by `_` (like `gtk_widget`) The name of the module, in all caps (like `GTK`) + filename="gobject/gtype.h" + line="1732">The name of the module, in all caps (like `GTK`) The bare name of the type, in all caps (like `WIDGET`) + filename="gobject/gtype.h" + line="1733">The bare name of the type, in all caps (like `WIDGET`) the name of the prerequisite type, in camel case (like `GtkWidget`) + filename="gobject/gtype.h" + line="1734">the name of the prerequisite type, in camel case (like `GtkWidget`) @@ -5601,29 +5604,28 @@ to be used in the usual way with export control and API versioning macros. version="2.4" introspectable="0"> A convenience macro for type implementations. + filename="gobject/gtype.h" + line="1871">A convenience macro for type implementations. Similar to G_DEFINE_TYPE(), but defines an abstract type. See G_DEFINE_TYPE_EXTENDED() for an example. - + The name of the new type, in Camel case. + filename="gobject/gtype.h" + line="1873">The name of the new type, in Camel case. The name of the new type, in lowercase, with words + filename="gobject/gtype.h" + line="1874">The name of the new type, in lowercase, with words separated by `_`. The #GType of the parent type. + filename="gobject/gtype.h" + line="1876">The #GType of the parent type. @@ -5632,37 +5634,36 @@ See G_DEFINE_TYPE_EXTENDED() for an example. version="2.4" introspectable="0"> A convenience macro for type implementations. + filename="gobject/gtype.h" + line="1886">A convenience macro for type implementations. Similar to G_DEFINE_TYPE_WITH_CODE(), but defines an abstract type and allows you to insert custom code into the `*_get_type()` function, e.g. interface implementations via G_IMPLEMENT_INTERFACE(). See G_DEFINE_TYPE_EXTENDED() for an example. - + The name of the new type, in Camel case. + filename="gobject/gtype.h" + line="1888">The name of the new type, in Camel case. The name of the new type, in lowercase, with words + filename="gobject/gtype.h" + line="1889">The name of the new type, in lowercase, with words separated by `_`. The #GType of the parent type. + filename="gobject/gtype.h" + line="1891">The #GType of the parent type. Custom code that gets inserted in the `type_name_get_type()` function. + filename="gobject/gtype.h" + line="1892">Custom code that gets inserted in the `type_name_get_type()` function. @@ -5671,28 +5672,27 @@ See G_DEFINE_TYPE_EXTENDED() for an example. version="2.38" introspectable="0"> Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type. + filename="gobject/gtype.h" + line="1905">Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type. See G_DEFINE_TYPE_EXTENDED() for an example. - + The name of the new type, in Camel case. + filename="gobject/gtype.h" + line="1907">The name of the new type, in Camel case. The name of the new type, in lowercase, with words + filename="gobject/gtype.h" + line="1908">The name of the new type, in lowercase, with words separated by `_`. The #GType of the parent type. + filename="gobject/gtype.h" + line="1910">The #GType of the parent type. @@ -5701,8 +5701,8 @@ See G_DEFINE_TYPE_EXTENDED() for an example. version="2.26" introspectable="0"> A convenience macro for defining a new custom boxed type. + filename="gobject/gtype.h" + line="2371">A convenience macro for defining a new custom boxed type. Using this macro is the recommended way of defining new custom boxed types, over calling g_boxed_type_register_static() directly. It defines @@ -5754,29 +5754,28 @@ foo () my_struct_free (ms); } ]| - + The name of the new type, in Camel case + filename="gobject/gtype.h" + line="2373">The name of the new type, in Camel case The name of the new type, in lowercase, with words + filename="gobject/gtype.h" + line="2374">The name of the new type, in lowercase, with words separated by `_` the #GBoxedCopyFunc for the new type + filename="gobject/gtype.h" + line="2376">the #GBoxedCopyFunc for the new type the #GBoxedFreeFunc for the new type + filename="gobject/gtype.h" + line="2377">the #GBoxedFreeFunc for the new type @@ -5785,8 +5784,8 @@ foo () version="2.26" introspectable="0"> A convenience macro for boxed type implementations. + filename="gobject/gtype.h" + line="2435">A convenience macro for boxed type implementations. Similar to G_DEFINE_BOXED_TYPE(), but allows to insert custom code into the `type_name_get_type()` function, e.g. to register value transformations with @@ -5801,34 +5800,33 @@ G_DEFINE_BOXED_TYPE_WITH_CODE (GdkRectangle, gdk_rectangle, Similarly to the `G_DEFINE_TYPE_*` family of macros, the #GType of the newly defined boxed type is exposed in the `g_define_type_id` variable. - + The name of the new type, in Camel case + filename="gobject/gtype.h" + line="2437">The name of the new type, in Camel case The name of the new type, in lowercase, with words + filename="gobject/gtype.h" + line="2438">The name of the new type, in lowercase, with words separated by `_` the #GBoxedCopyFunc for the new type + filename="gobject/gtype.h" + line="2440">the #GBoxedCopyFunc for the new type the #GBoxedFreeFunc for the new type + filename="gobject/gtype.h" + line="2441">the #GBoxedFreeFunc for the new type Custom code that gets inserted in the `*_get_type()` function + filename="gobject/gtype.h" + line="2442">Custom code that gets inserted in the `*_get_type()` function @@ -5837,8 +5835,8 @@ defined boxed type is exposed in the `g_define_type_id` variable. version="2.14" introspectable="0"> A convenience macro for dynamic type implementations, which declares a + filename="gobject/gtypemodule.h" + line="81">A convenience macro for dynamic type implementations, which declares a class initialization function, an instance initialization function (see #GTypeInfo for information about these) and a static variable named `t_n`_parent_class pointing to the parent class. @@ -5847,24 +5845,23 @@ Furthermore, it defines a `*_get_type()` and a static `*_register_type()` functions for use in your `module_init()`. See G_DEFINE_DYNAMIC_TYPE_EXTENDED() for an example. - + The name of the new type, in Camel case. + filename="gobject/gtypemodule.h" + line="83">The name of the new type, in Camel case. The name of the new type, in lowercase, with words + filename="gobject/gtypemodule.h" + line="84">The name of the new type, in lowercase, with words separated by '_'. The #GType of the parent type. + filename="gobject/gtypemodule.h" + line="86">The #GType of the parent type. @@ -5873,8 +5870,8 @@ See G_DEFINE_DYNAMIC_TYPE_EXTENDED() for an example. version="2.14" introspectable="0"> A more general version of G_DEFINE_DYNAMIC_TYPE() which + filename="gobject/gtypemodule.h" + line="101">A more general version of G_DEFINE_DYNAMIC_TYPE() which allows to specify #GTypeFlags and custom code. |[<!-- language="C" --> @@ -5936,34 +5933,33 @@ gtk_gadget_register_type (GTypeModule *type_module) } } ]| - + The name of the new type, in Camel case. + filename="gobject/gtypemodule.h" + line="103">The name of the new type, in Camel case. The name of the new type, in lowercase, with words + filename="gobject/gtypemodule.h" + line="104">The name of the new type, in lowercase, with words separated by '_'. The #GType of the parent type. + filename="gobject/gtypemodule.h" + line="106">The #GType of the parent type. #GTypeFlags to pass to g_type_module_register_type() + filename="gobject/gtypemodule.h" + line="107">#GTypeFlags to pass to g_type_module_register_type() Custom code that gets inserted in the *_get_type() function. + filename="gobject/gtypemodule.h" + line="108">Custom code that gets inserted in the *_get_type() function. @@ -5972,7 +5968,7 @@ gtk_gadget_register_type (GTypeModule *type_module) version="2.74" introspectable="0"> A convenience macro for defining enumeration types. This macro will generate a `*_get_type()` function for the @@ -5987,22 +5983,21 @@ G_DEFINE_ENUM_TYPE (GtkOrientation, gtk_orientation, For projects that have multiple enumeration types, or enumeration types with many values, you should consider using glib-mkenums to generate the type function. - + the enumeration type, in `CamelCase` the enumeration type prefixed, in `snake_case` a list of enumeration values, defined using G_DEFINE_ENUM_VALUE() @@ -6012,22 +6007,21 @@ generate the type function. version="2.74" introspectable="0"> Defines an enumeration value, and maps it to a "nickname". This macro can only be used with G_DEFINE_ENUM_TYPE() and G_DEFINE_FLAGS_TYPE(). - + an enumeration value a short string representing the enumeration value @@ -6037,30 +6031,29 @@ G_DEFINE_FLAGS_TYPE(). version="2.70" introspectable="0"> A convenience macro for type implementations. + filename="gobject/gtype.h" + line="1919">A convenience macro for type implementations. Similar to G_DEFINE_TYPE(), but defines a final type. See G_DEFINE_TYPE_EXTENDED() for an example. - + the name of the new type, in Camel case + filename="gobject/gtype.h" + line="1921">the name of the new type, in Camel case the name of the new type, in lower case, with words + filename="gobject/gtype.h" + line="1922">the name of the new type, in lower case, with words separated by `_` (snake case) the #GType of the parent type + filename="gobject/gtype.h" + line="1924">the #GType of the parent type @@ -6069,37 +6062,36 @@ See G_DEFINE_TYPE_EXTENDED() for an example. version="2.70" introspectable="0"> A convenience macro for type implementations. + filename="gobject/gtype.h" + line="1935">A convenience macro for type implementations. Similar to G_DEFINE_TYPE_WITH_CODE(), but defines a final type and allows you to insert custom code into the `*_get_type()` function, e.g. interface implementations via G_IMPLEMENT_INTERFACE(). See G_DEFINE_TYPE_EXTENDED() for an example. - + the name of the new type, in Camel case + filename="gobject/gtype.h" + line="1937">the name of the new type, in Camel case the name of the new type, in lower case, with words + filename="gobject/gtype.h" + line="1938">the name of the new type, in lower case, with words separated by `_` (snake case) the #GType of the parent type + filename="gobject/gtype.h" + line="1940">the #GType of the parent type Custom code that gets inserted in the `type_name_get_type()` function. + filename="gobject/gtype.h" + line="1941">Custom code that gets inserted in the `type_name_get_type()` function. @@ -6108,30 +6100,29 @@ See G_DEFINE_TYPE_EXTENDED() for an example. version="2.70" introspectable="0"> A convenience macro for type implementations. + filename="gobject/gtype.h" + line="1954">A convenience macro for type implementations. Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines a final type. See G_DEFINE_TYPE_EXTENDED() for an example. - + the name of the new type, in Camel case + filename="gobject/gtype.h" + line="1956">the name of the new type, in Camel case the name of the new type, in lower case, with words + filename="gobject/gtype.h" + line="1957">the name of the new type, in lower case, with words separated by `_` (snake case) the #GType of the parent type + filename="gobject/gtype.h" + line="1959">the #GType of the parent type @@ -6140,7 +6131,7 @@ See G_DEFINE_TYPE_EXTENDED() for an example. version="2.74" introspectable="0"> A convenience macro for defining flag types. This macro will generate a `*_get_type()` function for the @@ -6159,22 +6150,21 @@ G_DEFINE_FLAGS_TYPE (GSettingsBindFlags, g_settings_bind_flags, For projects that have multiple enumeration types, or enumeration types with many values, you should consider using glib-mkenums to generate the type function. - + the enumeration type, in `CamelCase` the enumeration type prefixed, in `snake_case` a list of enumeration values, defined using G_DEFINE_ENUM_VALUE() @@ -6184,8 +6174,8 @@ generate the type function. version="2.24" introspectable="0"> A convenience macro for #GTypeInterface definitions, which declares + filename="gobject/gtype.h" + line="2049">A convenience macro for #GTypeInterface definitions, which declares a default vtable initialization function and defines a `*_get_type()` function. @@ -6198,23 +6188,22 @@ The initialization function has signature the full #GInterfaceInitFunc signature, for brevity and convenience. If you need to use an initialization function with an `iface_data` argument, you must write the #GTypeInterface definitions manually. - + The name of the new type, in Camel case. + filename="gobject/gtype.h" + line="2051">The name of the new type, in Camel case. The name of the new type, in lowercase, with words separated by `_`. + filename="gobject/gtype.h" + line="2052">The name of the new type, in lowercase, with words separated by `_`. The #GType of the prerequisite type for the interface, or %G_TYPE_INVALID + filename="gobject/gtype.h" + line="2053">The #GType of the prerequisite type for the interface, or %G_TYPE_INVALID for no prerequisite type. @@ -6224,8 +6213,8 @@ for no prerequisite type. version="2.24" introspectable="0"> A convenience macro for #GTypeInterface definitions. + filename="gobject/gtype.h" + line="2074">A convenience macro for #GTypeInterface definitions. Similar to G_DEFINE_INTERFACE(), but allows you to insert custom code into the `*_get_type()` function, e.g. additional interface implementations @@ -6233,29 +6222,28 @@ via G_IMPLEMENT_INTERFACE(), or additional prerequisite types. See G_DEFINE_TYPE_EXTENDED() for a similar example using G_DEFINE_TYPE_WITH_CODE(). - + The name of the new type, in Camel case. + filename="gobject/gtype.h" + line="2076">The name of the new type, in Camel case. The name of the new type, in lowercase, with words separated by `_`. + filename="gobject/gtype.h" + line="2077">The name of the new type, in lowercase, with words separated by `_`. The #GType of the prerequisite type for the interface, or %G_TYPE_INVALID + filename="gobject/gtype.h" + line="2078">The #GType of the prerequisite type for the interface, or %G_TYPE_INVALID for no prerequisite type. Custom code that gets inserted in the `*_get_type()` function. + filename="gobject/gtype.h" + line="2080">Custom code that gets inserted in the `*_get_type()` function. @@ -6264,21 +6252,20 @@ for no prerequisite type. version="2.26" introspectable="0"> A convenience macro for pointer type implementations, which defines a + filename="gobject/gtype.h" + line="2532">A convenience macro for pointer type implementations, which defines a `type_name_get_type()` function registering the pointer type. - + The name of the new type, in Camel case + filename="gobject/gtype.h" + line="2534">The name of the new type, in Camel case The name of the new type, in lowercase, with words + filename="gobject/gtype.h" + line="2535">The name of the new type, in lowercase, with words separated by `_` @@ -6288,28 +6275,27 @@ for no prerequisite type. version="2.26" introspectable="0"> A convenience macro for pointer type implementations. + filename="gobject/gtype.h" + line="2544">A convenience macro for pointer type implementations. Similar to G_DEFINE_POINTER_TYPE(), but allows to insert custom code into the `type_name_get_type()` function. - + The name of the new type, in Camel case + filename="gobject/gtype.h" + line="2546">The name of the new type, in Camel case The name of the new type, in lowercase, with words + filename="gobject/gtype.h" + line="2547">The name of the new type, in lowercase, with words separated by `_` Custom code that gets inserted in the `*_get_type()` function + filename="gobject/gtype.h" + line="2549">Custom code that gets inserted in the `*_get_type()` function @@ -6318,30 +6304,29 @@ custom code into the `type_name_get_type()` function. version="2.4" introspectable="0"> A convenience macro for type implementations, which declares a class + filename="gobject/gtype.h" + line="1813">A convenience macro for type implementations, which declares a class initialization function, an instance initialization function (see #GTypeInfo for information about these) and a static variable named `t_n_parent_class` pointing to the parent class. Furthermore, it defines a `*_get_type()` function. See G_DEFINE_TYPE_EXTENDED() for an example. - + The name of the new type, in Camel case. + filename="gobject/gtype.h" + line="1815">The name of the new type, in Camel case. The name of the new type, in lowercase, with words + filename="gobject/gtype.h" + line="1816">The name of the new type, in lowercase, with words separated by `_`. The #GType of the parent type. + filename="gobject/gtype.h" + line="1818">The #GType of the parent type. @@ -6350,8 +6335,8 @@ See G_DEFINE_TYPE_EXTENDED() for an example. version="2.4" introspectable="0"> The most general convenience macro for type implementations, on which + filename="gobject/gtype.h" + line="1970">The most general convenience macro for type implementations, on which G_DEFINE_TYPE(), etc are based. |[<!-- language="C" --> @@ -6386,8 +6371,8 @@ static inline gpointer gtk_gadget_get_instance_private (GtkGadget *self) GType gtk_gadget_get_type (void) { - static gsize static_g_define_type_id = 0; - if (g_once_init_enter (&static_g_define_type_id)) + static GType static_g_define_type_id = 0; + if (g_once_init_enter_pointer (&static_g_define_type_id)) { GType g_define_type_id = g_type_register_static_simple (GTK_TYPE_WIDGET, @@ -6407,7 +6392,7 @@ gtk_gadget_get_type (void) }; g_type_add_interface_static (g_define_type_id, TYPE_GIZMO, &g_implement_interface_info); } - g_once_init_leave (&static_g_define_type_id, g_define_type_id); + g_once_init_leave_pointer (&static_g_define_type_id, g_define_type_id); } return static_g_define_type_id; } @@ -6416,34 +6401,33 @@ gtk_gadget_get_type (void) The only pieces which have to be manually provided are the definitions of the instance and class structure and the definitions of the instance and class init functions. - + The name of the new type, in Camel case. + filename="gobject/gtype.h" + line="1972">The name of the new type, in Camel case. The name of the new type, in lowercase, with words + filename="gobject/gtype.h" + line="1973">The name of the new type, in lowercase, with words separated by `_`. The #GType of the parent type. + filename="gobject/gtype.h" + line="1975">The #GType of the parent type. #GTypeFlags to pass to g_type_register_static() + filename="gobject/gtype.h" + line="1976">#GTypeFlags to pass to g_type_register_static() Custom code that gets inserted in the `*_get_type()` function. + filename="gobject/gtype.h" + line="1977">Custom code that gets inserted in the `*_get_type()` function. @@ -6452,91 +6436,1120 @@ class init functions. version="2.4" introspectable="0"> A convenience macro for type implementations. + filename="gobject/gtype.h" + line="1829">A convenience macro for type implementations. Similar to G_DEFINE_TYPE(), but allows you to insert custom code into the `*_get_type()` function, e.g. interface implementations via G_IMPLEMENT_INTERFACE(). See G_DEFINE_TYPE_EXTENDED() for an example. - + + + + The name of the new type, in Camel case. + + + The name of the new type in lowercase, with words separated by `_`. + + + The #GType of the parent type. + + + Custom code that gets inserted in the `*_get_type()` function. + + + + + A convenience macro for type implementations, which declares a class +initialization function, an instance initialization function (see #GTypeInfo +for information about these), a static variable named `t_n_parent_class` +pointing to the parent class, and adds private instance data to the type. + +Furthermore, it defines a `*_get_type()` function. See G_DEFINE_TYPE_EXTENDED() +for an example. + +Note that private structs added with this macros must have a struct +name of the form `TN ## Private`. + +The private instance data can be retrieved using the automatically generated +getter function `t_n_get_instance_private()`. + +See also: G_ADD_PRIVATE() + The name of the new type, in Camel case. + filename="gobject/gtype.h" + line="1847">The name of the new type, in Camel case. The name of the new type in lowercase, with words separated by `_`. + filename="gobject/gtype.h" + line="1848">The name of the new type, in lowercase, with words + separated by `_`. The #GType of the parent type. + filename="gobject/gtype.h" + line="1850">The #GType of the parent type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - Custom code that gets inserted in the `*_get_type()` function. + + + + + + - - A convenience macro for type implementations, which declares a class -initialization function, an instance initialization function (see #GTypeInfo -for information about these), a static variable named `t_n_parent_class` -pointing to the parent class, and adds private instance data to the type. - -Furthermore, it defines a `*_get_type()` function. See G_DEFINE_TYPE_EXTENDED() -for an example. - -Note that private structs added with this macros must have a struct -name of the form `TN ## Private`. - -The private instance data can be retrieved using the automatically generated -getter function `t_n_get_instance_private()`. - -See also: G_ADD_PRIVATE() - + - - The name of the new type, in Camel case. + - - The name of the new type, in lowercase, with words - separated by `_`. + + + + + + - - The #GType of the parent type. + + + + + + + + + + + + Casts a derived #GEnumClass structure into a #GEnumClass structure. - + a valid #GEnumClass @@ -6545,14 +7558,13 @@ See also: G_ADD_PRIVATE() c:identifier="G_ENUM_CLASS_TYPE" introspectable="0"> Get the type identifier from a given #GEnumClass structure. - + a #GEnumClass @@ -6561,52 +7573,50 @@ See also: G_ADD_PRIVATE() c:identifier="G_ENUM_CLASS_TYPE_NAME" introspectable="0"> Get the static type name from a given #GEnumClass structure. - + a #GEnumClass The class of an enumeration type holds information about its possible values. - + the parent class the smallest possible value. the largest possible value. the number of possible values. an array of #GEnumValue structs describing the individual values. @@ -6614,42 +7624,45 @@ possible values. A structure which contains a single enum value, its name, and its nickname. - + the enum value the name of the value the nickname of the value + + Casts a derived #GFlagsClass structure into a #GFlagsClass structure. - + a valid #GFlagsClass @@ -6658,14 +7671,13 @@ nickname. c:identifier="G_FLAGS_CLASS_TYPE" introspectable="0"> Get the type identifier from a given #GFlagsClass structure. - + a #GFlagsClass @@ -6674,46 +7686,44 @@ nickname. c:identifier="G_FLAGS_CLASS_TYPE_NAME" introspectable="0"> Get the static type name from a given #GFlagsClass structure. - + a #GFlagsClass The class of a flags type holds information about its possible values. - + the parent class a mask covering all possible values. the number of possible values. an array of #GFlagsValue structs describing the individual values. @@ -6721,54 +7731,62 @@ possible values. A structure which contains a single flags value, its name, and its nickname. - + the flags value the name of the value the nickname of the value + + + + A convenience macro to ease interface addition in the `_C_` section + filename="gobject/gtype.h" + line="2095">A convenience macro to ease interface addition in the `_C_` section of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE(). See G_DEFINE_TYPE_EXTENDED() for an example. Note that this macro can only be used together with the `G_DEFINE_TYPE_*` macros, since it depends on variable names from those macros. - + The #GType of the interface to add + filename="gobject/gtype.h" + line="2097">The #GType of the interface to add The interface init function, of type #GInterfaceInitFunc + filename="gobject/gtype.h" + line="2098">The interface init function, of type #GInterfaceInitFunc @@ -6777,8 +7795,8 @@ macros, since it depends on variable names from those macros. version="2.24" introspectable="0"> A convenience macro to ease interface addition in the @_C_ section + filename="gobject/gtypemodule.h" + line="222">A convenience macro to ease interface addition in the @_C_ section of G_DEFINE_DYNAMIC_TYPE_EXTENDED(). See G_DEFINE_DYNAMIC_TYPE_EXTENDED() for an example. @@ -6786,18 +7804,17 @@ See G_DEFINE_DYNAMIC_TYPE_EXTENDED() for an example. Note that this macro can only be used together with the G_DEFINE_DYNAMIC_TYPE_EXTENDED macros, since it depends on variable names from that macro. - + The #GType of the interface to add + filename="gobject/gtypemodule.h" + line="224">The #GType of the interface to add The interface init function + filename="gobject/gtypemodule.h" + line="225">The interface init function @@ -6805,18 +7822,17 @@ names from that macro. c:identifier="G_INITIALLY_UNOWNED" introspectable="0"> Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*) pointer. Depending on the current debugging level, this function may invoke certain runtime checks to identify invalid casts. - + Object which is subject to casting. @@ -6825,15 +7841,14 @@ certain runtime checks to identify invalid casts. c:identifier="G_INITIALLY_UNOWNED_CLASS" introspectable="0"> Casts a derived #GInitiallyUnownedClass structure into a #GInitiallyUnownedClass structure. - + a valid #GInitiallyUnownedClass @@ -6842,23 +7857,67 @@ certain runtime checks to identify invalid casts. c:identifier="G_INITIALLY_UNOWNED_GET_CLASS" introspectable="0"> Get the class structure associated to a #GInitiallyUnowned instance. - + a #GInitiallyUnowned instance. + + + + + + + + + + + + + + + + - + @@ -6867,8 +7926,7 @@ certain runtime checks to identify invalid casts. - + @@ -6878,15 +7936,14 @@ certain runtime checks to identify invalid casts. c:identifier="G_IS_ENUM_CLASS" introspectable="0"> Checks whether @class "is a" valid #GEnumClass structure of type %G_TYPE_ENUM or derived. - + a #GEnumClass @@ -6895,15 +7952,14 @@ or derived. c:identifier="G_IS_FLAGS_CLASS" introspectable="0"> Checks whether @class "is a" valid #GFlagsClass structure of type %G_TYPE_FLAGS or derived. - + a #GFlagsClass @@ -6912,14 +7968,13 @@ or derived. c:identifier="G_IS_INITIALLY_UNOWNED" introspectable="0"> Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_INITIALLY_UNOWNED. - + Instance to check for being a %G_TYPE_INITIALLY_UNOWNED. @@ -6928,15 +7983,14 @@ or derived. c:identifier="G_IS_INITIALLY_UNOWNED_CLASS" introspectable="0"> Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type %G_TYPE_INITIALLY_UNOWNED or derived. - + a #GInitiallyUnownedClass @@ -6945,14 +7999,13 @@ or derived. c:identifier="G_IS_OBJECT" introspectable="0"> Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_OBJECT. - + Instance to check for being a %G_TYPE_OBJECT. @@ -6961,15 +8014,14 @@ or derived. c:identifier="G_IS_OBJECT_CLASS" introspectable="0"> Checks whether @class "is a" valid #GObjectClass structure of type %G_TYPE_OBJECT or derived. - + a #GObjectClass @@ -6978,15 +8030,14 @@ or derived. c:identifier="G_IS_PARAM_SPEC" introspectable="0"> Checks whether @pspec "is a" valid #GParamSpec structure of type %G_TYPE_PARAM or derived. - + a #GParamSpec @@ -6995,14 +8046,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_BOOLEAN" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOOLEAN. - + a valid #GParamSpec instance @@ -7011,14 +8061,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_BOXED" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_BOXED. - + a valid #GParamSpec instance @@ -7027,14 +8076,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_CHAR" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_CHAR. - + a valid #GParamSpec instance @@ -7043,15 +8091,14 @@ or derived. c:identifier="G_IS_PARAM_SPEC_CLASS" introspectable="0"> Checks whether @pclass "is a" valid #GParamSpecClass structure of type %G_TYPE_PARAM or derived. - + a #GParamSpecClass @@ -7060,14 +8107,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_DOUBLE" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_DOUBLE. - + a valid #GParamSpec instance @@ -7076,14 +8122,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_ENUM" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ENUM. - + a valid #GParamSpec instance @@ -7092,14 +8137,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_FLAGS" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLAGS. - + a valid #GParamSpec instance @@ -7108,14 +8152,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_FLOAT" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_FLOAT. - + a valid #GParamSpec instance @@ -7125,14 +8168,13 @@ or derived. version="2.10" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_GTYPE. - + a #GParamSpec @@ -7141,14 +8183,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_INT" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT. - + a valid #GParamSpec instance @@ -7157,14 +8198,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_INT64" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_INT64. - + a valid #GParamSpec instance @@ -7173,14 +8213,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_LONG" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_LONG. - + a valid #GParamSpec instance @@ -7189,14 +8228,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_OBJECT" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OBJECT. - + a valid #GParamSpec instance @@ -7206,14 +8244,13 @@ or derived. version="2.4" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_OVERRIDE. - + a #GParamSpec @@ -7222,14 +8259,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_PARAM" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_PARAM. - + a valid #GParamSpec instance @@ -7238,14 +8274,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_POINTER" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_POINTER. - + a valid #GParamSpec instance @@ -7254,14 +8289,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_STRING" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_STRING. - + a valid #GParamSpec instance @@ -7270,14 +8304,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_UCHAR" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UCHAR. - + a valid #GParamSpec instance @@ -7286,14 +8319,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_UINT" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT. - + a valid #GParamSpec instance @@ -7302,14 +8334,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_UINT64" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UINT64. - + a valid #GParamSpec instance @@ -7318,14 +8349,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_ULONG" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_ULONG. - + a valid #GParamSpec instance @@ -7334,14 +8364,13 @@ or derived. c:identifier="G_IS_PARAM_SPEC_UNICHAR" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_UNICHAR. - + a valid #GParamSpec instance @@ -7352,15 +8381,14 @@ or derived. deprecated="1" deprecated-version="2.32"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VALUE_ARRAY. Use #GArray instead of #GValueArray - + a valid #GParamSpec instance @@ -7370,14 +8398,13 @@ or derived. version="2.26" introspectable="0"> Checks whether the given #GParamSpec is of type %G_TYPE_PARAM_VARIANT. - + a #GParamSpec @@ -7385,8 +8412,7 @@ or derived. - + @@ -7395,8 +8421,7 @@ or derived. - + @@ -7405,8 +8430,7 @@ or derived. - + @@ -7415,8 +8439,7 @@ or derived. - + @@ -7425,8 +8448,7 @@ or derived. - + @@ -7436,14 +8458,13 @@ or derived. c:identifier="G_IS_VALUE" introspectable="0"> Checks if @value is a valid and initialized #GValue structure. - + A #GValue structure. @@ -7456,13 +8477,12 @@ or derived. glib:get-type="g_initially_unowned_get_type" glib:type-struct="InitiallyUnownedClass"> A type for objects that have an initially floating reference. + filename="gobject/gobject.h" + line="382">A type for objects that have an initially floating reference. All the fields in the `GInitiallyUnowned` structure are private to the implementation and should never be accessed directly. - + @@ -7477,14 +8497,13 @@ implementation and should never be accessed directly. c:type="GInitiallyUnownedClass" glib:is-gtype-struct-for="InitiallyUnowned"> The class structure for the GInitiallyUnowned type. - + filename="gobject/gobject.h" + line="390">The class structure for the GInitiallyUnowned type. + the parent class + filename="gobject/gobject.h" + line="262">the parent class @@ -7493,9 +8512,15 @@ implementation and should never be accessed directly. + the @constructor function is called by g_object_new () to + complete the object initialization after all the construction properties are + set. The first thing a @constructor implementation must do is chain up to the + @constructor of the parent class. Overriding @constructor should be rarely + needed, e.g. to handle construct properties, or to implement singletons. - + @@ -7514,9 +8539,15 @@ implementation and should never be accessed directly. + the generic setter for all properties of this type. Should be + overridden for every type with properties. If implementations of + @set_property don't emit property change notification explicitly, this will + be done implicitly by the type system. However, if the notify signal is + emitted explicitly, the type system will not emit it a second time. - + @@ -7537,9 +8568,12 @@ implementation and should never be accessed directly. + the generic getter for all properties of this type. Should be + overridden for every type with properties. - + @@ -7560,9 +8594,15 @@ implementation and should never be accessed directly. + the @dispose function is supposed to drop all references to other + objects, but keep the instance otherwise intact, so that client method + invocations still work. It may be run multiple times (due to reference + loops). Before returning, @dispose should chain up to the @dispose method + of the parent class. - + @@ -7574,9 +8614,13 @@ implementation and should never be accessed directly. + instance finalization function, should finish the finalization of + the instance begun in @dispose and chain up to the @finalize method of the + parent class. - + @@ -7588,9 +8632,13 @@ implementation and should never be accessed directly. + emits property change notification for a bunch + of properties. Overriding @dispatch_properties_changed should be rarely + needed. - + @@ -7608,17 +8656,19 @@ implementation and should never be accessed directly. + the class closure for the notify signal - + a #GObject + filename="gobject/gobject.c" + line="1936">a #GObject @@ -7628,9 +8678,17 @@ implementation and should never be accessed directly. + the @constructed function is called by g_object_new() as the + final step of the object creation process. At the point of the call, all + construction properties have been set on the object. The purpose of this + call is to allow for object initialisation steps that can only be performed + after construction properties have been set. @constructed implementors + should chain up to the @constructed call of their parent class to allow it + to complete its initialisation. - + @@ -7661,8 +8719,8 @@ implementation and should never be accessed directly. A callback function used by the type system to initialize a new + filename="gobject/gtype.h" + line="962">A callback function used by the type system to initialize a new instance of a type. This function initializes all instance members and allocates any resources @@ -7675,22 +8733,21 @@ belongs to the type the current initializer was introduced for. The extended members of @instance are guaranteed to have been filled with zeros before this function is called. - + The instance to initialize + filename="gobject/gtype.h" + line="964">The instance to initialize The class of the type the instance is + filename="gobject/gtype.h" + line="965">The class of the type the instance is created for @@ -7698,21 +8755,20 @@ zeros before this function is called. A callback function used by the type system to finalize an interface. + filename="gobject/gtype.h" + line="1000">A callback function used by the type system to finalize an interface. This function should destroy any internal data and release any resources allocated by the corresponding GInterfaceInitFunc() function. - + The interface structure to finalize + filename="gobject/gtype.h" + line="1002">The interface structure to finalize nullable="1" allow-none="1"> The @interface_data supplied via the #GInterfaceInfo structure + filename="gobject/gtype.h" + line="1003">The @interface_data supplied via the #GInterfaceInfo structure A structure that provides information to the type system which is + filename="gobject/gtype.h" + line="1154">A structure that provides information to the type system which is used specifically for managing interface types. - + location of the interface initialization function + filename="gobject/gtype.h" + line="1156">location of the interface initialization function location of the interface finalization function + filename="gobject/gtype.h" + line="1157">location of the interface finalization function user-supplied data passed to the interface init/finalize functions + filename="gobject/gtype.h" + line="1158">user-supplied data passed to the interface init/finalize functions A callback function used by the type system to initialize a new + filename="gobject/gtype.h" + line="984">A callback function used by the type system to initialize a new interface. This function should initialize all internal data and* allocate any @@ -7763,16 +8818,15 @@ resources required by the interface. The members of @iface_data are guaranteed to have been filled with zeros before this function is called. - + The interface structure to initialize + filename="gobject/gtype.h" + line="986">The interface structure to initialize nullable="1" allow-none="1"> The @interface_data supplied via the #GInterfaceInfo structure + filename="gobject/gtype.h" + line="987">The @interface_data supplied via the #GInterfaceInfo structure + + + + + + + + + + + + Casts a #GObject or derived pointer into a (GObject*) pointer. Depending on the current debugging level, this function may invoke certain runtime checks to identify invalid casts. - + Object which is subject to casting. @@ -7807,14 +8890,13 @@ certain runtime checks to identify invalid casts. c:identifier="G_OBJECT_CLASS" introspectable="0"> Casts a derived #GObjectClass structure into a #GObjectClass structure. - + a valid #GObjectClass @@ -7823,14 +8905,13 @@ certain runtime checks to identify invalid casts. c:identifier="G_OBJECT_CLASS_NAME" introspectable="0"> Return the name of a class structure's type. - + a valid #GObjectClass @@ -7839,14 +8920,13 @@ certain runtime checks to identify invalid casts. c:identifier="G_OBJECT_CLASS_TYPE" introspectable="0"> Get the type id of a class structure. - + a valid #GObjectClass @@ -7855,14 +8935,13 @@ certain runtime checks to identify invalid casts. c:identifier="G_OBJECT_GET_CLASS" introspectable="0"> Get the class structure associated to a #GObject instance. - + a #GObject instance. @@ -7871,14 +8950,13 @@ certain runtime checks to identify invalid casts. c:identifier="G_OBJECT_TYPE" introspectable="0"> Get the type id of an object. - + Object to return the type id for. @@ -7887,14 +8965,13 @@ certain runtime checks to identify invalid casts. c:identifier="G_OBJECT_TYPE_NAME" introspectable="0"> Get the name of an object's type. - + Object to return the type name for. @@ -7903,34 +8980,32 @@ certain runtime checks to identify invalid casts. c:identifier="G_OBJECT_WARN_INVALID_PROPERTY_ID" introspectable="0"> This macro should be used to emit a standard warning about unexpected + filename="gobject/gobject.h" + line="681">This macro should be used to emit a standard warning about unexpected properties in set_property() and get_property() implementations. - + the #GObject on which set_property() or get_property() was called + filename="gobject/gobject.h" + line="683">the #GObject on which set_property() or get_property() was called the numeric id of the property + filename="gobject/gobject.h" + line="684">the numeric id of the property the #GParamSpec of the property + filename="gobject/gobject.h" + line="685">the #GParamSpec of the property - + @@ -7949,25 +9024,34 @@ properties in set_property() and get_property() implementations. glib:get-type="g_object_get_type" glib:type-struct="ObjectClass"> The base object type. + filename="gobject/gobject.c" + line="40">The base object type. + +`GObject` is the fundamental type providing the common attributes and +methods for all object types in GTK, Pango and other libraries +based on GObject. The `GObject` class provides methods for object +construction and destruction, property access methods, and signal +support. Signals are described in detail [here][gobject-Signals]. -All the fields in the `GObject` structure are private to the implementation -and should never be accessed directly. +For a tutorial on implementing a new `GObject` class, see [How to define and +implement a new GObject](tutorial.html#how-to-define-and-implement-a-new-gobject). +For a list of naming conventions for GObjects and their methods, see the +[GType conventions](concepts.html#conventions). For the high-level concepts +behind GObject, read +[Instantiatable classed types: Objects](concepts.html#instantiatable-classed-types-objects). -Since GLib 2.72, all #GObjects are guaranteed to be aligned to at least the -alignment of the largest basic GLib type (typically this is #guint64 or -#gdouble). If you need larger alignment for an element in a #GObject, you -should allocate it on the heap (aligned), or arrange for your #GObject to be -appropriately padded. This guarantee applies to the #GObject (or derived) -struct, the #GObjectClass (or derived) struct, and any private data allocated -by G_ADD_PRIVATE(). - +Since GLib 2.72, all `GObject`s are guaranteed to be aligned to at least the +alignment of the largest basic GLib type (typically this is `guint64` or +`gdouble`). If you need larger alignment for an element in a `GObject`, you +should allocate it on the heap (aligned), or arrange for your `GObject` to be +appropriately padded. This guarantee applies to the `GObject` (or derived) +struct, the `GObjectClass` (or derived) struct, and any private data allocated +by `G_ADD_PRIVATE()`. + Creates a new instance of a #GObject subtype and sets its properties. + filename="gobject/gobject.c" + line="2368">Creates a new instance of a #GObject subtype and sets its properties. Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. Any @@ -7993,32 +9077,31 @@ alignment of the largest basic GLib type (typically this is `guint64` or `gdouble`). If you need larger alignment for an element in a #GObject, you should allocate it on the heap (aligned), or arrange for your #GObject to be appropriately padded. - + a new instance of + filename="gobject/gobject.c" + line="2402">a new instance of @object_type the type id of the #GObject subtype to instantiate + filename="gobject/gobject.c" + line="2370">the type id of the #GObject subtype to instantiate the name of the first property + filename="gobject/gobject.c" + line="2371">the name of the first property the value of the first property, followed optionally by more + filename="gobject/gobject.c" + line="2372">the value of the first property, followed optionally by more name/value pairs, followed by %NULL @@ -8028,36 +9111,35 @@ appropriately padded. c:identifier="g_object_new_valist" introspectable="0"> Creates a new instance of a #GObject subtype and sets its properties. + filename="gobject/gobject.c" + line="2847">Creates a new instance of a #GObject subtype and sets its properties. Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. - + a new instance of @object_type + filename="gobject/gobject.c" + line="2859">a new instance of @object_type the type id of the #GObject subtype to instantiate + filename="gobject/gobject.c" + line="2849">the type id of the #GObject subtype to instantiate the name of the first property + filename="gobject/gobject.c" + line="2850">the name of the first property the value of the first property, followed optionally by more + filename="gobject/gobject.c" + line="2851">the value of the first property, followed optionally by more name/value pairs, followed by %NULL @@ -8068,47 +9150,46 @@ which are not explicitly specified are set to their default values. version="2.54" introspectable="0"> Creates a new instance of a #GObject subtype and sets its properties using + filename="gobject/gobject.c" + line="2712">Creates a new instance of a #GObject subtype and sets its properties using the provided arrays. Both arrays must have exactly @n_properties elements, and the names and values correspond by index. Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. - + a new instance of + filename="gobject/gobject.c" + line="2726">a new instance of @object_type the object type to instantiate + filename="gobject/gobject.c" + line="2714">the object type to instantiate the number of properties + filename="gobject/gobject.c" + line="2715">the number of properties the names of each property to be set + filename="gobject/gobject.c" + line="2716">the names of each property to be set the values of each property to be set + filename="gobject/gobject.c" + line="2717">the values of each property to be set @@ -8120,39 +9201,38 @@ which are not explicitly specified are set to their default values. deprecated="1" deprecated-version="2.54"> Creates a new instance of a #GObject subtype and sets its properties. + filename="gobject/gobject.c" + line="2777">Creates a new instance of a #GObject subtype and sets its properties. Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values. Use g_object_new_with_properties() instead. deprecated. See #GParameter for more information. - + a new instance of + filename="gobject/gobject.c" + line="2788">a new instance of @object_type the type id of the #GObject subtype to instantiate + filename="gobject/gobject.c" + line="2779">the type id of the #GObject subtype to instantiate the length of the @parameters array + filename="gobject/gobject.c" + line="2780">the length of the @parameters array an array of #GParameter + filename="gobject/gobject.c" + line="2781">an array of #GParameter @@ -8160,8 +9240,7 @@ deprecated. See #GParameter for more information. - + @@ -8181,18 +9260,17 @@ deprecated. See #GParameter for more information. c:identifier="g_object_interface_find_property" version="2.4"> Find the #GParamSpec with the given name for an + filename="gobject/gobject.c" + line="1455">Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek(). - + the #GParamSpec for the property of the + filename="gobject/gobject.c" + line="1469">the #GParamSpec for the property of the interface with the name @property_name, or %NULL if no such property exists. @@ -8200,15 +9278,15 @@ g_type_default_interface_peek(). any interface vtable for the + filename="gobject/gobject.c" + line="1457">any interface vtable for the interface, or the default vtable for the interface name of a property to look up. + filename="gobject/gobject.c" + line="1459">name of a property to look up. @@ -8217,8 +9295,8 @@ g_type_default_interface_peek(). c:identifier="g_object_interface_install_property" version="2.4"> Add a property to an interface; this is only useful for interfaces + filename="gobject/gobject.c" + line="1375">Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly @@ -8234,24 +9312,23 @@ vtable initialization function (the @class_init member of been called for any object types implementing this interface. If @pspec is a floating reference, it will be consumed. - + any interface vtable for the + filename="gobject/gobject.c" + line="1377">any interface vtable for the interface, or the default vtable for the interface. the #GParamSpec for the new property + filename="gobject/gobject.c" + line="1380">the #GParamSpec for the new property @@ -8260,21 +9337,20 @@ If @pspec is a floating reference, it will be consumed. c:identifier="g_object_interface_list_properties" version="2.4"> Lists the properties of an interface.Generally, the interface + filename="gobject/gobject.c" + line="1595">Lists the properties of an interface.Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek(). - + a - pointer to an array of pointers to #GParamSpec - structures. The paramspecs are owned by GLib, but the - array should be freed with g_free() when you are done with - it. + filename="gobject/gobject.c" + line="1608">a + pointer to an array of pointers to #GParamSpec + structures. The paramspecs are owned by GLib, but the + array should be freed with g_free() when you are done with + it. @@ -8282,8 +9358,8 @@ already been loaded, g_type_default_interface_peek(). any interface vtable for the + filename="gobject/gobject.c" + line="1597">any interface vtable for the interface, or the default vtable for the interface @@ -8292,15 +9368,23 @@ already been loaded, g_type_default_interface_peek(). caller-allocates="0" transfer-ownership="full"> location to store number of properties returned. + filename="gobject/gobject.c" + line="1599">location to store number of properties returned. - + the @constructed function is called by g_object_new() as the + final step of the object creation process. At the point of the call, all + construction properties have been set on the object. The purpose of this + call is to allow for object initialisation steps that can only be performed + after construction properties have been set. @constructed implementors + should chain up to the @constructed call of their parent class to allow it + to complete its initialisation. + @@ -8311,8 +9395,12 @@ already been loaded, g_type_default_interface_peek(). - + emits property change notification for a bunch + of properties. Overriding @dispatch_properties_changed should be rarely + needed. + @@ -8329,8 +9417,14 @@ already been loaded, g_type_default_interface_peek(). - + the @dispose function is supposed to drop all references to other + objects, but keep the instance otherwise intact, so that client method + invocations still work. It may be run multiple times (due to reference + loops). Before returning, @dispose should chain up to the @dispose method + of the parent class. + @@ -8341,8 +9435,12 @@ already been loaded, g_type_default_interface_peek(). - + instance finalization function, should finish the finalization of + the instance begun in @dispose and chain up to the @finalize method of the + parent class. + @@ -8353,8 +9451,11 @@ already been loaded, g_type_default_interface_peek(). - + the generic getter for all properties of this type. Should be + overridden for every type with properties. + @@ -8375,8 +9476,8 @@ already been loaded, g_type_default_interface_peek(). Emits a "notify" signal for the property @property_name on @object. + filename="gobject/gobject.c" + line="1934">Emits a "notify" signal for the property @property_name on @object. When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() @@ -8386,16 +9487,15 @@ Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called. - + a #GObject + filename="gobject/gobject.c" + line="1936">a #GObject @@ -8404,8 +9504,14 @@ called. - + the generic setter for all properties of this type. Should be + overridden for every type with properties. If implementations of + @set_property don't emit property change notification explicitly, this will + be done implicitly by the type system. However, if the notify signal is + emitted explicitly, the type system will not emit it a second time. + @@ -8429,8 +9535,8 @@ called. version="2.8" introspectable="0"> Increases the reference count of the object by one and sets a + filename="gobject/gobject.c" + line="4019">Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established. @@ -8457,23 +9563,29 @@ Multiple toggle references may be added to the same gobject, however if there are multiple toggle references to an object, none of them will ever be notified until all but one are removed. For this reason, you should only ever use a toggle reference if there -is important state in the proxy object. - +is important state in the proxy object. + +Note that if you unref the object on another thread, then @notify might +still be invoked after g_object_remove_toggle_ref(), and the object argument +might be a dangling pointer. If the object is destroyed on other threads, +you must take care of that yourself. + +A g_object_add_toggle_ref() must be released with g_object_remove_toggle_ref(). + a #GObject + filename="gobject/gobject.c" + line="4021">a #GObject a function to call when this reference is the + filename="gobject/gobject.c" + line="4022">a function to call when this reference is the last reference to the object, or is no longer the last reference. @@ -8483,8 +9595,8 @@ is important state in the proxy object. nullable="1" allow-none="1"> data to pass to @notify + filename="gobject/gobject.c" + line="4025">data to pass to @notify @@ -8493,8 +9605,8 @@ is important state in the proxy object. c:identifier="g_object_add_weak_pointer" introspectable="0"> Adds a weak reference from weak_pointer to @object to indicate that + filename="gobject/gobject.c" + line="3741">Adds a weak reference from weak_pointer to @object to indicate that the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL. @@ -8503,16 +9615,15 @@ Note that as with g_object_weak_ref(), the weak references created by this method are not thread-safe: they cannot safely be used in one thread if the object's last g_object_unref() might happen in another thread. Use #GWeakRef if thread-safety is required. - + The object that should be weak referenced. + filename="gobject/gobject.c" + line="3743">The object that should be weak referenced. caller-allocates="0" transfer-ownership="full"> The memory address + filename="gobject/gobject.c" + line="3744">The memory address of a pointer. @@ -8531,8 +9642,8 @@ thread. Use #GWeakRef if thread-safety is required. c:identifier="g_object_bind_property" version="2.26"> Creates a binding between @source_property on @source and @target_property + filename="gobject/gbinding.c" + line="1369">Creates a binding between @source_property on @source and @target_property on @target. Whenever the @source_property is changed the @target_property is @@ -8563,12 +9674,11 @@ finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side. A #GObject can have multiple bindings. - + the #GBinding instance representing the + filename="gobject/gbinding.c" + line="1409">the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero. @@ -8576,32 +9686,32 @@ A #GObject can have multiple bindings. the source #GObject + filename="gobject/gbinding.c" + line="1371">the source #GObject the property on @source to bind + filename="gobject/gbinding.c" + line="1372">the property on @source to bind the target #GObject + filename="gobject/gbinding.c" + line="1373">the target #GObject the property on @target to bind + filename="gobject/gbinding.c" + line="1374">the property on @target to bind flags to pass to #GBinding + filename="gobject/gbinding.c" + line="1375">flags to pass to #GBinding @@ -8611,8 +9721,8 @@ A #GObject can have multiple bindings. shadowed-by="bind_property_with_closures" version="2.26"> Complete version of g_object_bind_property(). + filename="gobject/gbinding.c" + line="1172">Complete version of g_object_bind_property(). Creates a binding between @source_property on @source and @target_property on @target, allowing you to set the transformation functions to be used by @@ -8637,12 +9747,11 @@ and @transform_from transformation functions; the @notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead. - + the #GBinding instance representing the + filename="gobject/gbinding.c" + line="1214">the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero. @@ -8650,32 +9759,32 @@ g_object_bind_property_with_closures() instead. the source #GObject + filename="gobject/gbinding.c" + line="1174">the source #GObject the property on @source to bind + filename="gobject/gbinding.c" + line="1175">the property on @source to bind the target #GObject + filename="gobject/gbinding.c" + line="1176">the target #GObject the property on @target to bind + filename="gobject/gbinding.c" + line="1177">the property on @target to bind flags to pass to #GBinding + filename="gobject/gbinding.c" + line="1178">flags to pass to #GBinding allow-none="1" scope="notified"> the transformation function + filename="gobject/gbinding.c" + line="1179">the transformation function from the @source to the @target, or %NULL to use the default @@ -8697,8 +9806,8 @@ g_object_bind_property_with_closures() instead. closure="6" destroy="7"> the transformation function + filename="gobject/gbinding.c" + line="1181">the transformation function from the @target to the @source, or %NULL to use the default @@ -8707,8 +9816,8 @@ g_object_bind_property_with_closures() instead. nullable="1" allow-none="1"> custom data to be passed to the transformation functions, + filename="gobject/gbinding.c" + line="1183">custom data to be passed to the transformation functions, or %NULL @@ -8718,8 +9827,8 @@ g_object_bind_property_with_closures() instead. allow-none="1" scope="async"> a function to call when disposing the binding, to free + filename="gobject/gbinding.c" + line="1185">a function to call when disposing the binding, to free resources used by the transformation functions, or %NULL if not required @@ -8730,20 +9839,19 @@ g_object_bind_property_with_closures() instead. shadows="bind_property_full" version="2.26"> Creates a binding between @source_property on @source and @target_property + filename="gobject/gbinding.c" + line="1538">Creates a binding between @source_property on @source and @target_property on @target, allowing you to set the transformation functions to be used by the binding. This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers. - + the #GBinding instance representing the + filename="gobject/gbinding.c" + line="1558">the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero. @@ -8751,45 +9859,45 @@ function pointers. the source #GObject + filename="gobject/gbinding.c" + line="1540">the source #GObject the property on @source to bind + filename="gobject/gbinding.c" + line="1541">the property on @source to bind the target #GObject + filename="gobject/gbinding.c" + line="1542">the target #GObject the property on @target to bind + filename="gobject/gbinding.c" + line="1543">the property on @target to bind flags to pass to #GBinding + filename="gobject/gbinding.c" + line="1544">flags to pass to #GBinding a #GClosure wrapping the transformation function + filename="gobject/gbinding.c" + line="1545">a #GClosure wrapping the transformation function from the @source to the @target, or %NULL to use the default a #GClosure wrapping the transformation function + filename="gobject/gbinding.c" + line="1547">a #GClosure wrapping the transformation function from the @target to the @source, or %NULL to use the default @@ -8799,8 +9907,8 @@ function pointers. c:identifier="g_object_connect" introspectable="0"> A convenience function to connect multiple signals at once. + filename="gobject/gobject.c" + line="3465">A convenience function to connect multiple signals at once. The signal specs expected by this function have the form "modifier::signal_name", where modifier can be one of the following: @@ -8823,31 +9931,30 @@ The signal specs expected by this function have the form "signal::destroy", gtk_widget_destroyed, &menu->toplevel, NULL); ]| - + @object + filename="gobject/gobject.c" + line="3497">@object a #GObject + filename="gobject/gobject.c" + line="3467">a #GObject the spec for the first signal + filename="gobject/gobject.c" + line="3468">the spec for the first signal #GCallback for the first signal, followed by data for the + filename="gobject/gobject.c" + line="3469">#GCallback for the first signal, followed by data for the first signal, followed optionally by more signal spec/callback/data triples, followed by %NULL @@ -8858,35 +9965,34 @@ The signal specs expected by this function have the form c:identifier="g_object_disconnect" introspectable="0"> A convenience function to disconnect multiple signals at once. + filename="gobject/gobject.c" + line="3567">A convenience function to disconnect multiple signals at once. The signal specs expected by this function have the form "any_signal", which means to disconnect any signal with matching callback and data, or "any_signal::signal_name", which only disconnects the signal named "signal_name". - + a #GObject + filename="gobject/gobject.c" + line="3569">a #GObject the spec for the first signal + filename="gobject/gobject.c" + line="3570">the spec for the first signal #GCallback for the first signal, followed by data for the first signal, + filename="gobject/gobject.c" + line="3571">#GCallback for the first signal, followed by data for the first signal, followed optionally by more signal spec/callback/data triples, followed by %NULL @@ -8898,8 +10004,8 @@ disconnects the signal named "signal_name". version="2.34" introspectable="0"> This is a variant of g_object_get_data() which returns + filename="gobject/gobject.c" + line="4785">This is a variant of g_object_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object. @@ -8913,12 +10019,11 @@ is locked. This function can be useful to avoid races when multiple threads are using object data on the same key on the same object. - + the result of calling @dup_func on the value + filename="gobject/gobject.c" + line="4807">the result of calling @dup_func on the value associated with @key on @object, or %NULL if not set. If @dup_func is %NULL, the value is returned unmodified. @@ -8927,14 +10032,14 @@ object. the #GObject to store user data on + filename="gobject/gobject.c" + line="4787">the #GObject to store user data on a string, naming the user data pointer + filename="gobject/gobject.c" + line="4788">a string, naming the user data pointer allow-none="1" closure="2"> function to dup the value + filename="gobject/gobject.c" + line="4789">function to dup the value nullable="1" allow-none="1"> passed as user_data to @dup_func + filename="gobject/gobject.c" + line="4790">passed as user_data to @dup_func @@ -8963,8 +10068,8 @@ object. version="2.34" introspectable="0"> This is a variant of g_object_get_qdata() which returns + filename="gobject/gobject.c" + line="4572">This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object. @@ -8978,12 +10083,11 @@ is locked. This function can be useful to avoid races when multiple threads are using object data on the same key on the same object. - + the result of calling @dup_func on the value + filename="gobject/gobject.c" + line="4594">the result of calling @dup_func on the value associated with @quark on @object, or %NULL if not set. If @dup_func is %NULL, the value is returned unmodified. @@ -8992,14 +10096,14 @@ object. the #GObject to store user data on + filename="gobject/gobject.c" + line="4574">the #GObject to store user data on a #GQuark, naming the user data pointer + filename="gobject/gobject.c" + line="4575">a #GQuark, naming the user data pointer allow-none="1" closure="2"> function to dup the value + filename="gobject/gobject.c" + line="4576">function to dup the value nullable="1" allow-none="1"> passed as user_data to @dup_func + filename="gobject/gobject.c" + line="4577">passed as user_data to @dup_func @@ -9027,29 +10131,28 @@ object. c:identifier="g_object_force_floating" version="2.10"> This function is intended for #GObject implementations to re-enforce + filename="gobject/gobject.c" + line="3927">This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink(). - + a #GObject + filename="gobject/gobject.c" + line="3929">a #GObject Increases the freeze count on @object. If the freeze count is + filename="gobject/gobject.c" + line="1856">Increases the freeze count on @object. If the freeze count is non-zero, the emission of "notify" signals on @object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one @@ -9058,24 +10161,23 @@ object is frozen. This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified. - + a #GObject + filename="gobject/gobject.c" + line="1858">a #GObject Gets properties of an object. + filename="gobject/gobject.c" + line="3321">Gets properties of an object. In general, a copy is made of the property contents and the caller is responsible for freeing the memory in the appropriate manner for @@ -9101,28 +10203,27 @@ of three properties: an integer, a string and an object: g_free (strval); g_object_unref (objval); ]| - + a #GObject + filename="gobject/gobject.c" + line="3323">a #GObject name of the first property to get + filename="gobject/gobject.c" + line="3324">name of the first property to get return location for the first property, followed optionally by more + filename="gobject/gobject.c" + line="3325">return location for the first property, followed optionally by more name/return location pairs, followed by %NULL @@ -9130,36 +10231,35 @@ of three properties: an integer, a string and an object: Gets a named field from the objects table of associations (see g_object_set_data()). - + filename="gobject/gobject.c" + line="4737">Gets a named field from the objects table of associations (see g_object_set_data()). + the data if found, + filename="gobject/gobject.c" + line="4744">the data if found, or %NULL if no such data exists. #GObject containing the associations + filename="gobject/gobject.c" + line="4739">#GObject containing the associations name of the key for that association + filename="gobject/gobject.c" + line="4740">name of the key for that association Gets a property of an object. + filename="gobject/gobject.c" + line="3386">Gets a property of an object. The @value can be: @@ -9175,56 +10275,54 @@ responsible for freeing the memory by calling g_value_unset(). Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming. - + a #GObject + filename="gobject/gobject.c" + line="3388">a #GObject the name of the property to get + filename="gobject/gobject.c" + line="3389">the name of the property to get return location for the property value + filename="gobject/gobject.c" + line="3390">return location for the property value This function gets back user data pointers stored via + filename="gobject/gobject.c" + line="4527">This function gets back user data pointers stored via g_object_set_qdata(). - + The user data pointer set, or %NULL + filename="gobject/gobject.c" + line="4535">The user data pointer set, or %NULL The GObject to get a stored user data pointer from + filename="gobject/gobject.c" + line="4529">The GObject to get a stored user data pointer from A #GQuark, naming the user data pointer + filename="gobject/gobject.c" + line="4530">A #GQuark, naming the user data pointer @@ -9233,36 +10331,35 @@ g_object_set_qdata(). c:identifier="g_object_get_valist" introspectable="0"> Gets properties of an object. + filename="gobject/gobject.c" + line="3225">Gets properties of an object. In general, a copy is made of the property contents and the caller is responsible for freeing the memory in the appropriate manner for the type, for instance by calling g_free() or g_object_unref(). See g_object_get(). - + a #GObject + filename="gobject/gobject.c" + line="3227">a #GObject name of the first property to get + filename="gobject/gobject.c" + line="3228">name of the first property to get return location for the first property, followed optionally by more + filename="gobject/gobject.c" + line="3229">return location for the first property, followed optionally by more name/return location pairs, followed by %NULL @@ -9270,41 +10367,40 @@ See g_object_get(). Gets @n_properties properties for an @object. + filename="gobject/gobject.c" + line="3178">Gets @n_properties properties for an @object. Obtained properties will be set to @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in. - + a #GObject + filename="gobject/gobject.c" + line="3180">a #GObject the number of properties + filename="gobject/gobject.c" + line="3181">the number of properties the names of each property to get + filename="gobject/gobject.c" + line="3182">the names of each property to get the values of each property to get + filename="gobject/gobject.c" + line="3183">the values of each property to get @@ -9315,29 +10411,28 @@ properties are passed in. c:identifier="g_object_is_floating" version="2.10"> Checks whether @object has a [floating][floating-ref] reference. - + filename="gobject/gobject.c" + line="3819">Checks whether @object has a [floating][floating-ref] reference. + %TRUE if @object has a floating reference + filename="gobject/gobject.c" + line="3827">%TRUE if @object has a floating reference a #GObject + filename="gobject/gobject.c" + line="3821">a #GObject Emits a "notify" signal for the property @property_name on @object. + filename="gobject/gobject.c" + line="1934">Emits a "notify" signal for the property @property_name on @object. When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() @@ -9347,22 +10442,21 @@ Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called. - + a #GObject + filename="gobject/gobject.c" + line="1936">a #GObject the name of a property installed on the class of @object. + filename="gobject/gobject.c" + line="1937">the name of a property installed on the class of @object. @@ -9371,8 +10465,8 @@ called. c:identifier="g_object_notify_by_pspec" version="2.26"> Emits a "notify" signal for the property specified by @pspec on @object. + filename="gobject/gobject.c" + line="1977">Emits a "notify" signal for the property specified by @pspec on @object. This function omits the property name lookup, hence it is faster than g_object_notify(). @@ -9394,7 +10488,7 @@ g_object_class_install_property() inside a static array, e.g.: static void my_object_class_init (MyObjectClass *klass) { - properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo", + properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL, 0, 100, 50, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); @@ -9409,56 +10503,54 @@ and then notify a change on the "foo" property with: |[<!-- language="C" --> g_object_notify_by_pspec (self, properties[PROP_FOO]); ]| - + a #GObject + filename="gobject/gobject.c" + line="1979">a #GObject the #GParamSpec of a property installed on the class of @object. + filename="gobject/gobject.c" + line="1980">the #GParamSpec of a property installed on the class of @object. Increases the reference count of @object. + filename="gobject/gobject.c" + line="4218">Increases the reference count of @object. Since GLib 2.56, if `GLIB_VERSION_MAX_ALLOWED` is 2.56 or greater, the type of @object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit. - + the same @object + filename="gobject/gobject.c" + line="4229">the same @object a #GObject + filename="gobject/gobject.c" + line="4220">a #GObject Increase the reference count of @object, and possibly remove the + filename="gobject/gobject.c" + line="3837">Increase the reference count of @object, and possibly remove the [floating][floating-ref] reference, if @object has a floating reference. In other words, if the object is floating, then this call "assumes @@ -9469,19 +10561,18 @@ adds a new normal reference increasing the reference count by one. Since GLib 2.56, the type of @object will be propagated to the return type under the same conditions as for g_object_ref(). - + @object + filename="gobject/gobject.c" + line="3855">@object a #GObject + filename="gobject/gobject.c" + line="3839">a #GObject @@ -9491,25 +10582,29 @@ under the same conditions as for g_object_ref(). version="2.8" introspectable="0"> Removes a reference added with g_object_add_toggle_ref(). The -reference count of the object is decreased by one. - + filename="gobject/gobject.c" + line="4106">Removes a reference added with g_object_add_toggle_ref(). The +reference count of the object is decreased by one. + +Note that if you unref the object on another thread, then @notify might +still be invoked after g_object_remove_toggle_ref(), and the object argument +might be a dangling pointer. If the object is destroyed on other threads, +you must take care of that yourself. + a #GObject + filename="gobject/gobject.c" + line="4108">a #GObject a function to call when this reference is the + filename="gobject/gobject.c" + line="4109">a function to call when this reference is the last reference to the object, or is no longer the last reference. @@ -9519,8 +10614,8 @@ reference count of the object is decreased by one. nullable="1" allow-none="1"> data to pass to @notify, or %NULL to + filename="gobject/gobject.c" + line="4112">data to pass to @notify, or %NULL to match any toggle refs with the @notify argument. @@ -9530,20 +10625,19 @@ reference count of the object is decreased by one. c:identifier="g_object_remove_weak_pointer" introspectable="0"> Removes a weak reference from @object that was previously added + filename="gobject/gobject.c" + line="3769">Removes a weak reference from @object that was previously added using g_object_add_weak_pointer(). The @weak_pointer_location has to match the one used with g_object_add_weak_pointer(). - + The object that is weak referenced. + filename="gobject/gobject.c" + line="3771">The object that is weak referenced. caller-allocates="0" transfer-ownership="full"> The memory address + filename="gobject/gobject.c" + line="3772">The memory address of a pointer. @@ -9563,8 +10657,8 @@ to match the one used with g_object_add_weak_pointer(). version="2.34" introspectable="0"> Compares the user data for the key @key on @object with + filename="gobject/gobject.c" + line="4828">Compares the user data for the key @key on @object with @oldval, and if they are the same, replaces @oldval with @newval. @@ -9580,26 +10674,25 @@ should not destroy the object in the normal way. See g_object_set_data() for guidance on using a small, bounded set of values for @key. - + %TRUE if the existing value for @key was replaced + filename="gobject/gobject.c" + line="4854">%TRUE if the existing value for @key was replaced by @newval, %FALSE otherwise. the #GObject to store user data on + filename="gobject/gobject.c" + line="4830">the #GObject to store user data on a string, naming the user data pointer + filename="gobject/gobject.c" + line="4831">a string, naming the user data pointer nullable="1" allow-none="1"> the old value to compare against + filename="gobject/gobject.c" + line="4832">the old value to compare against nullable="1" allow-none="1"> the new value + filename="gobject/gobject.c" + line="4833">the new value allow-none="1" scope="async"> a destroy notify for the new value + filename="gobject/gobject.c" + line="4834">a destroy notify for the new value allow-none="1" scope="async"> destroy notify for the existing value + filename="gobject/gobject.c" + line="4835">destroy notify for the existing value @@ -9649,8 +10742,8 @@ for @key. version="2.34" introspectable="0"> Compares the user data for the key @quark on @object with + filename="gobject/gobject.c" + line="4613">Compares the user data for the key @quark on @object with @oldval, and if they are the same, replaces @oldval with @newval. @@ -9663,26 +10756,25 @@ the registered destroy notify for it (passed out in @old_destroy). It’s up to the caller to free this as needed, which may or may not include using @old_destroy as sometimes replacement should not destroy the object in the normal way. - + %TRUE if the existing value for @quark was replaced + filename="gobject/gobject.c" + line="4636">%TRUE if the existing value for @quark was replaced by @newval, %FALSE otherwise. the #GObject to store user data on + filename="gobject/gobject.c" + line="4615">the #GObject to store user data on a #GQuark, naming the user data pointer + filename="gobject/gobject.c" + line="4616">a #GQuark, naming the user data pointer nullable="1" allow-none="1"> the old value to compare against + filename="gobject/gobject.c" + line="4617">the old value to compare against nullable="1" allow-none="1"> the new value + filename="gobject/gobject.c" + line="4618">the new value allow-none="1" scope="async"> a destroy notify for the new value + filename="gobject/gobject.c" + line="4619">a destroy notify for the new value allow-none="1" scope="async"> destroy notify for the existing value + filename="gobject/gobject.c" + line="4620">destroy notify for the existing value Releases all references to other objects. This can be used to break + filename="gobject/gobject.c" + line="1822">Releases all references to other objects. This can be used to break reference cycles. This function should only be called from object system implementations. - + a #GObject + filename="gobject/gobject.c" + line="1824">a #GObject Sets properties on an object. + filename="gobject/gobject.c" + line="3288">Sets properties on an object. The same caveats about passing integer literals as varargs apply as with g_object_new(). In particular, any integer literals set as the values for @@ -9761,28 +10852,27 @@ properties of type #gint64 or #guint64 must be 64 bits wide, using the Note that the "notify" signals are queued and only emitted (in reverse order) after all properties have been set. See g_object_freeze_notify(). - + a #GObject + filename="gobject/gobject.c" + line="3290">a #GObject name of the first property to set + filename="gobject/gobject.c" + line="3291">name of the first property to set value for the first property, followed optionally by more + filename="gobject/gobject.c" + line="3292">value for the first property, followed optionally by more name/value pairs, followed by %NULL @@ -9790,8 +10880,8 @@ g_object_freeze_notify(). Each object carries around a table of associations from + filename="gobject/gobject.c" + line="4757">Each object carries around a table of associations from strings to pointers. This function lets you set an association. If the object already had an association with that name, @@ -9801,22 +10891,21 @@ Internally, the @key is converted to a #GQuark using g_quark_from_string(). This means a copy of @key is kept permanently (even after @object has been finalized) — so it is recommended to only use a small, bounded set of values for @key in your program, to avoid the #GQuark storage growing unbounded. - + #GObject containing the associations. + filename="gobject/gobject.c" + line="4759">#GObject containing the associations. name of the key + filename="gobject/gobject.c" + line="4760">name of the key nullable="1" allow-none="1"> data to associate with that key + filename="gobject/gobject.c" + line="4761">data to associate with that key @@ -9834,28 +10923,27 @@ for @key in your program, to avoid the #GQuark storage growing unbounded. c:identifier="g_object_set_data_full" introspectable="0"> Like g_object_set_data() except it adds notification + filename="gobject/gobject.c" + line="4876">Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed. Note that the @destroy callback is not called if @data is %NULL. - + #GObject containing the associations + filename="gobject/gobject.c" + line="4878">#GObject containing the associations name of the key + filename="gobject/gobject.c" + line="4879">name of the key nullable="1" allow-none="1"> data to associate with that key + filename="gobject/gobject.c" + line="4880">data to associate with that key allow-none="1" scope="async"> function to call when the association is destroyed + filename="gobject/gobject.c" + line="4881">function to call when the association is destroyed Sets a property on an object. - + filename="gobject/gobject.c" + line="3370">Sets a property on an object. + a #GObject + filename="gobject/gobject.c" + line="3372">a #GObject the name of the property to set + filename="gobject/gobject.c" + line="3373">the name of the property to set the value + filename="gobject/gobject.c" + line="3374">the value @@ -9913,8 +11000,8 @@ Note that the @destroy callback is not called if @data is %NULL. c:identifier="g_object_set_qdata" introspectable="0"> This sets an opaque, named pointer on an object. + filename="gobject/gobject.c" + line="4546">This sets an opaque, named pointer on an object. The name is specified through a #GQuark (retrieved e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @object with g_object_get_qdata() @@ -9922,22 +11009,21 @@ until the @object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using #NULL as pointer essentially removes the data stored. - + The GObject to set store a user data pointer + filename="gobject/gobject.c" + line="4548">The GObject to set store a user data pointer A #GQuark, naming the user data pointer + filename="gobject/gobject.c" + line="4549">A #GQuark, naming the user data pointer nullable="1" allow-none="1"> An opaque user data pointer + filename="gobject/gobject.c" + line="4550">An opaque user data pointer @@ -9955,28 +11041,27 @@ removes the data stored. c:identifier="g_object_set_qdata_full" introspectable="0"> This function works like g_object_set_qdata(), but in addition, + filename="gobject/gobject.c" + line="4657">This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with @data as argument when the @object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same @quark. - + The GObject to set store a user data pointer + filename="gobject/gobject.c" + line="4659">The GObject to set store a user data pointer A #GQuark, naming the user data pointer + filename="gobject/gobject.c" + line="4660">A #GQuark, naming the user data pointer nullable="1" allow-none="1"> An opaque user data pointer + filename="gobject/gobject.c" + line="4661">An opaque user data pointer allow-none="1" scope="async"> Function to invoke with @data as argument, when @data + filename="gobject/gobject.c" + line="4662">Function to invoke with @data as argument, when @data needs to be freed @@ -10005,30 +11090,29 @@ with the same @quark. c:identifier="g_object_set_valist" introspectable="0"> Sets properties on an object. - + filename="gobject/gobject.c" + line="3092">Sets properties on an object. + a #GObject + filename="gobject/gobject.c" + line="3094">a #GObject name of the first property to set + filename="gobject/gobject.c" + line="3095">name of the first property to set value for the first property, followed optionally by more + filename="gobject/gobject.c" + line="3096">value for the first property, followed optionally by more name/value pairs, followed by %NULL @@ -10039,41 +11123,40 @@ with the same @quark. version="2.54" introspectable="0"> Sets @n_properties properties for an @object. + filename="gobject/gobject.c" + line="3039">Sets @n_properties properties for an @object. Properties to be set will be taken from @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in. - + a #GObject + filename="gobject/gobject.c" + line="3041">a #GObject the number of properties + filename="gobject/gobject.c" + line="3042">the number of properties the names of each property to be set + filename="gobject/gobject.c" + line="3043">the names of each property to be set the values of each property to be set + filename="gobject/gobject.c" + line="3044">the values of each property to be set @@ -10082,37 +11165,36 @@ properties are passed in. Remove a specified datum from the object's data associations, + filename="gobject/gobject.c" + line="4902">Remove a specified datum from the object's data associations, without invoking the association's destroy handler. - + the data if found, or %NULL + filename="gobject/gobject.c" + line="4910">the data if found, or %NULL if no such data exists. #GObject containing the associations + filename="gobject/gobject.c" + line="4904">#GObject containing the associations name of the key + filename="gobject/gobject.c" + line="4905">name of the key This function gets back user data pointers stored via + filename="gobject/gobject.c" + line="4684">This function gets back user data pointers stored via g_object_set_qdata() and removes the @data from object without invoking its destroy() function (if any was set). @@ -10147,25 +11229,24 @@ Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full(). - + The user data pointer set, or %NULL + filename="gobject/gobject.c" + line="4725">The user data pointer set, or %NULL The GObject to get a stored user data pointer from + filename="gobject/gobject.c" + line="4686">The GObject to get a stored user data pointer from A #GQuark, naming the user data pointer + filename="gobject/gobject.c" + line="4687">A #GQuark, naming the user data pointer @@ -10175,8 +11256,8 @@ g_object_set_qdata_full(). version="2.70" introspectable="0"> If @object is floating, sink it. Otherwise, do nothing. + filename="gobject/gobject.c" + line="3871">If @object is floating, sink it. Otherwise, do nothing. In other words, this function will convert a floating reference (if present) into a full reference. @@ -10211,27 +11292,26 @@ reference. If g_object_take_ref() runs first then the result will be that the floating reference is converted to a hard reference and an additional reference on top of that one is added. It is best to avoid this situation. - + @object + filename="gobject/gobject.c" + line="3913">@object a #GObject + filename="gobject/gobject.c" + line="3873">a #GObject Reverts the effect of a previous call to + filename="gobject/gobject.c" + line="2033">Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on @object and when it reaches zero, queued "notify" signals are emitted. @@ -10240,48 +11320,46 @@ Duplicate notifications for each property are squashed so that at most one in which they have been queued. It is an error to call this function when the freeze count is zero. - + a #GObject + filename="gobject/gobject.c" + line="2035">a #GObject Decreases the reference count of @object. When its reference count + filename="gobject/gobject.c" + line="4303">Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed). If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this. - + a #GObject + filename="gobject/gobject.c" + line="4305">a #GObject This function essentially limits the life time of the @closure to + filename="gobject/gobject.c" + line="5232">This function essentially limits the life time of the @closure to the life time of the object. That is, when the object is finalized, the @closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized @@ -10290,22 +11368,21 @@ added as marshal guards to the @closure, to ensure that an extra reference count is held on @object during invocation of the @closure. Usually, this function will be called on closures that use this @object as closure data. - + #GObject restricting lifetime of @closure + filename="gobject/gobject.c" + line="5234">#GObject restricting lifetime of @closure #GClosure to watch + filename="gobject/gobject.c" + line="5235">#GClosure to watch @@ -10314,8 +11391,8 @@ use this @object as closure data. c:identifier="g_object_weak_ref" introspectable="0"> Adds a weak reference callback to an object. Weak references are + filename="gobject/gobject.c" + line="3650">Adds a weak reference callback to an object. Weak references are used for notification when an object is disposed. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a @@ -10325,22 +11402,21 @@ Note that the weak references created by this method are not thread-safe: they cannot safely be used in one thread if the object's last g_object_unref() might happen in another thread. Use #GWeakRef if thread-safety is required. - + #GObject to reference weakly + filename="gobject/gobject.c" + line="3652">#GObject to reference weakly callback to invoke before the object is freed + filename="gobject/gobject.c" + line="3653">callback to invoke before the object is freed nullable="1" allow-none="1"> extra data to pass to notify + filename="gobject/gobject.c" + line="3654">extra data to pass to notify @@ -10358,24 +11434,23 @@ Use #GWeakRef if thread-safety is required. c:identifier="g_object_weak_unref" introspectable="0"> Removes a weak reference callback to an object. - + filename="gobject/gobject.c" + line="3699">Removes a weak reference callback to an object. + #GObject to remove a weak reference from + filename="gobject/gobject.c" + line="3701">#GObject to remove a weak reference from callback to search for + filename="gobject/gobject.c" + line="3702">callback to search for nullable="1" allow-none="1"> data to search for + filename="gobject/gobject.c" + line="3703">data to search for @@ -10405,8 +11480,8 @@ Use #GWeakRef if thread-safety is required. action="1" no-hooks="1"> The notify signal is emitted on an object when one of its properties has + filename="gobject/gobject.c" + line="995">The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al. Note that getting this signal doesn’t itself guarantee that the value of @@ -10437,8 +11512,8 @@ detail strings for the notify signal. the #GParamSpec of the property which changed. + filename="gobject/gobject.c" + line="998">the #GParamSpec of the property which changed. @@ -10448,8 +11523,8 @@ detail strings for the notify signal. c:type="GObjectClass" glib:is-gtype-struct-for="Object"> The class structure for the GObject type. + filename="gobject/gobject.h" + line="260">The class structure for the GObject type. |[<!-- language="C" --> // Example of implementing a singleton using a constructor. @@ -10475,12 +11550,11 @@ my_singleton_constructor (GType type, return object; } ]| - + the parent class + filename="gobject/gobject.h" + line="262">the parent class @@ -10489,9 +11563,15 @@ my_singleton_constructor (GType type, + the @constructor function is called by g_object_new () to + complete the object initialization after all the construction properties are + set. The first thing a @constructor implementation must do is chain up to the + @constructor of the parent class. Overriding @constructor should be rarely + needed, e.g. to handle construct properties, or to implement singletons. - + @@ -10510,9 +11590,15 @@ my_singleton_constructor (GType type, + the generic setter for all properties of this type. Should be + overridden for every type with properties. If implementations of + @set_property don't emit property change notification explicitly, this will + be done implicitly by the type system. However, if the notify signal is + emitted explicitly, the type system will not emit it a second time. - + @@ -10533,9 +11619,12 @@ my_singleton_constructor (GType type, + the generic getter for all properties of this type. Should be + overridden for every type with properties. - + @@ -10556,9 +11645,15 @@ my_singleton_constructor (GType type, + the @dispose function is supposed to drop all references to other + objects, but keep the instance otherwise intact, so that client method + invocations still work. It may be run multiple times (due to reference + loops). Before returning, @dispose should chain up to the @dispose method + of the parent class. - + @@ -10570,9 +11665,13 @@ my_singleton_constructor (GType type, + instance finalization function, should finish the finalization of + the instance begun in @dispose and chain up to the @finalize method of the + parent class. - + @@ -10584,9 +11683,13 @@ my_singleton_constructor (GType type, + emits property change notification for a bunch + of properties. Overriding @dispatch_properties_changed should be rarely + needed. - + @@ -10604,17 +11707,19 @@ my_singleton_constructor (GType type, + the class closure for the notify signal - + a #GObject + filename="gobject/gobject.c" + line="1936">a #GObject @@ -10624,9 +11729,17 @@ my_singleton_constructor (GType type, + the @constructed function is called by g_object_new() as the + final step of the object creation process. At the point of the call, all + construction properties have been set on the object. The purpose of this + call is to allow for object initialisation steps that can only be performed + after construction properties have been set. @constructed implementors + should chain up to the @constructed call of their parent class to allow it + to complete its initialisation. - + @@ -10656,28 +11769,27 @@ my_singleton_constructor (GType type, Looks up the #GParamSpec for a property of a class. - + filename="gobject/gobject.c" + line="1428">Looks up the #GParamSpec for a property of a class. + the #GParamSpec for the property, or + filename="gobject/gobject.c" + line="1435">the #GParamSpec for the property, or %NULL if the class doesn't have a property of that name a #GObjectClass + filename="gobject/gobject.c" + line="1430">a #GObjectClass the name of the property to look up + filename="gobject/gobject.c" + line="1431">the name of the property to look up @@ -10686,8 +11798,8 @@ my_singleton_constructor (GType type, c:identifier="g_object_class_install_properties" version="2.26"> Installs new properties from an array of #GParamSpecs. + filename="gobject/gobject.c" + line="1241">Installs new properties from an array of #GParamSpecs. All properties should be installed during the class initializer. It is possible to install properties after that, but doing so is not @@ -10719,13 +11831,13 @@ my_object_class_init (MyObjectClass *klass) GObjectClass *gobject_class = G_OBJECT_CLASS (klass); obj_properties[PROP_FOO] = - g_param_spec_int ("foo", "Foo", "Foo", + g_param_spec_int ("foo", NULL, NULL, -1, G_MAXINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); obj_properties[PROP_BAR] = - g_param_spec_string ("bar", "Bar", "Bar", + g_param_spec_string ("bar", NULL, NULL, NULL, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); @@ -10750,28 +11862,27 @@ my_object_set_foo (MyObject *self, gint foo) } } ]| - + a #GObjectClass + filename="gobject/gobject.c" + line="1243">a #GObjectClass the length of the #GParamSpecs array + filename="gobject/gobject.c" + line="1244">the length of the #GParamSpecs array the #GParamSpecs array + filename="gobject/gobject.c" + line="1245">the #GParamSpecs array defining the new properties @@ -10782,8 +11893,8 @@ my_object_set_foo (MyObject *self, gint foo) Installs a new property. + filename="gobject/gobject.c" + line="1132">Installs a new property. All properties should be installed during the class initializer. It is possible to install properties after that, but doing so is not @@ -10793,28 +11904,27 @@ use of properties on the same type on other threads. Note that it is possible to redefine a property in a derived class, by installing a property with the same name. This can be useful at times, e.g. to change the range of allowed values or the default value. - + a #GObjectClass + filename="gobject/gobject.c" + line="1134">a #GObjectClass the id for the new property + filename="gobject/gobject.c" + line="1135">the id for the new property the #GParamSpec for the new property + filename="gobject/gobject.c" + line="1136">the #GParamSpec for the new property @@ -10822,14 +11932,13 @@ e.g. to change the range of allowed values or the default value. Get an array of #GParamSpec* for all properties of a class. - + filename="gobject/gobject.c" + line="1567">Get an array of #GParamSpec* for all properties of a class. + an array of + filename="gobject/gobject.c" + line="1574">an array of #GParamSpec* which should be freed after use @@ -10838,8 +11947,8 @@ e.g. to change the range of allowed values or the default value. a #GObjectClass + filename="gobject/gobject.c" + line="1569">a #GObjectClass caller-allocates="0" transfer-ownership="full"> return location for the length of the returned array + filename="gobject/gobject.c" + line="1570">return location for the length of the returned array @@ -10857,8 +11966,8 @@ e.g. to change the range of allowed values or the default value. c:identifier="g_object_class_override_property" version="2.4"> Registers @property_id as referring to a property with the name + filename="gobject/gobject.c" + line="1490">Registers @property_id as referring to a property with the name @name in a parent class or in an interface implemented by @oclass. This allows this class to "override" a property implementation in a parent class or to provide the implementation of a property from @@ -10874,28 +11983,27 @@ instead, so that the @param_id field of the #GParamSpec will be correct. For virtually all uses, this makes no difference. If you need to get the overridden property, you can call g_param_spec_get_redirect_target(). - + a #GObjectClass + filename="gobject/gobject.c" + line="1492">a #GObjectClass the new property ID + filename="gobject/gobject.c" + line="1493">the new property ID the name of a property registered in a parent class or + filename="gobject/gobject.c" + line="1494">the name of a property registered in a parent class or in an interface of this class. @@ -10904,37 +12012,35 @@ g_param_spec_get_redirect_target(). The GObjectConstructParam struct is an auxiliary structure used to hand + filename="gobject/gobject.h" + line="368">The GObjectConstructParam struct is an auxiliary structure used to hand #GParamSpec/#GValue pairs to the @constructor of a #GObjectClass. - + the #GParamSpec of the construct parameter + filename="gobject/gobject.h" + line="370">the #GParamSpec of the construct parameter the value to set the parameter to + filename="gobject/gobject.h" + line="371">the value to set the parameter to The type of the @finalize function of #GObjectClass. - + the #GObject being finalized @@ -10942,36 +12048,35 @@ g_param_spec_get_redirect_target(). The type of the @get_property function of #GObjectClass. - + a #GObject the numeric id under which the property was registered with g_object_class_install_property(). a #GValue to return the property value in the #GParamSpec describing the property @@ -10979,62 +12084,64 @@ g_param_spec_get_redirect_target(). The type of the @set_property function of #GObjectClass. - + a #GObject the numeric id under which the property was registered with g_object_class_install_property(). the new value for the property the #GParamSpec describing the property + + Mask containing the bits of #GParamSpec.flags which are reserved for GLib. - + Casts a derived #GParamSpec object (e.g. of type #GParamSpecInt) into a #GParamSpec object. - + a valid #GParamSpec @@ -11043,14 +12150,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_BOOLEAN" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecBoolean. - + a valid #GParamSpec instance @@ -11059,14 +12165,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_BOXED" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecBoxed. - + a valid #GParamSpec instance @@ -11075,14 +12180,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_CHAR" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecChar. - + a valid #GParamSpec instance @@ -11091,14 +12195,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_CLASS" introspectable="0"> Casts a derived #GParamSpecClass structure into a #GParamSpecClass structure. - + a valid #GParamSpecClass @@ -11107,14 +12210,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_DOUBLE" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecDouble. - + a valid #GParamSpec instance @@ -11123,14 +12225,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_ENUM" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecEnum. - + a valid #GParamSpec instance @@ -11139,14 +12240,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_FLAGS" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecFlags. - + a valid #GParamSpec instance @@ -11155,14 +12255,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_FLOAT" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecFloat. - + a valid #GParamSpec instance @@ -11171,14 +12270,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_GET_CLASS" introspectable="0"> Retrieves the #GParamSpecClass of a #GParamSpec. - + a valid #GParamSpec @@ -11188,14 +12286,13 @@ a #GParamSpec object. version="2.10" introspectable="0"> Casts a #GParamSpec into a #GParamSpecGType. - + a #GParamSpec @@ -11204,14 +12301,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_INT" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecInt. - + a valid #GParamSpec instance @@ -11220,14 +12316,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_INT64" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecInt64. - + a valid #GParamSpec instance @@ -11236,14 +12331,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_LONG" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecLong. - + a valid #GParamSpec instance @@ -11252,14 +12346,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_OBJECT" introspectable="0"> Casts a #GParamSpec instance into a #GParamSpecObject. - + a valid #GParamSpec instance @@ -11269,14 +12362,13 @@ a #GParamSpec object. version="2.4" introspectable="0"> Casts a #GParamSpec into a #GParamSpecOverride. - + a #GParamSpec @@ -11285,14 +12377,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_PARAM" introspectable="0"> Casts a #GParamSpec instance into a #GParamSpecParam. - + a valid #GParamSpec instance @@ -11301,14 +12392,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_POINTER" introspectable="0"> Casts a #GParamSpec instance into a #GParamSpecPointer. - + a valid #GParamSpec instance @@ -11317,14 +12407,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_STRING" introspectable="0"> Casts a #GParamSpec instance into a #GParamSpecString. - + a valid #GParamSpec instance @@ -11333,14 +12422,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_TYPE" introspectable="0"> Retrieves the #GType of this @pspec. - + a valid #GParamSpec @@ -11349,14 +12437,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_TYPE_NAME" introspectable="0"> Retrieves the #GType name of this @pspec. - + a valid #GParamSpec @@ -11365,14 +12452,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_UCHAR" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecUChar. - + a valid #GParamSpec instance @@ -11381,14 +12467,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_UINT" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecUInt. - + a valid #GParamSpec instance @@ -11397,14 +12482,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_UINT64" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecUInt64. - + a valid #GParamSpec instance @@ -11413,14 +12497,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_ULONG" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecULong. - + a valid #GParamSpec instance @@ -11429,14 +12512,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_UNICHAR" introspectable="0"> Cast a #GParamSpec instance into a #GParamSpecUnichar. - + a valid #GParamSpec instance @@ -11447,15 +12529,14 @@ a #GParamSpec object. deprecated="1" deprecated-version="2.32"> Cast a #GParamSpec instance into a #GParamSpecValueArray. Use #GArray instead of #GValueArray - + a valid #GParamSpec instance @@ -11464,14 +12545,13 @@ a #GParamSpec object. c:identifier="G_PARAM_SPEC_VALUE_TYPE" introspectable="0"> Retrieves the #GType to initialize a #GValue for this parameter. - + a valid #GParamSpec @@ -11481,14 +12561,13 @@ a #GParamSpec object. version="2.26" introspectable="0"> Casts a #GParamSpec into a #GParamSpecVariant. - + a #GParamSpec @@ -11497,7 +12576,7 @@ a #GParamSpec object. value="224" c:type="G_PARAM_STATIC_STRINGS"> #GParamFlags value alias for %G_PARAM_STATIC_NAME | %G_PARAM_STATIC_NICK | %G_PARAM_STATIC_BLURB. It is recommended to use this for all properties by default, as it allows for @@ -11507,17 +12586,15 @@ It is very rare that a property would have a dynamically constructed name, nickname or blurb. Since 2.13.0 - + Minimum shift count to be used for user defined flags, to be stored in #GParamSpec.flags. The maximum allowed is 10. - + version="2.38" introspectable="0"> Evaluates to the @field_name inside the @inst private data + filename="gobject/gtype.h" + line="2228">Evaluates to the @field_name inside the @inst private data structure for @TypeName. Note that this macro can only be used together with the `G_DEFINE_TYPE_*` and G_ADD_PRIVATE() macros, since it depends on variable names from those macros. - + the name of the type in CamelCase + filename="gobject/gtype.h" + line="2230">the name of the type in CamelCase the instance of @TypeName you wish to access + filename="gobject/gtype.h" + line="2231">the instance of @TypeName you wish to access the type of the field in the private data structure + filename="gobject/gtype.h" + line="2232">the type of the field in the private data structure the name of the field in the private data structure + filename="gobject/gtype.h" + line="2233">the name of the field in the private data structure @@ -11562,30 +12638,29 @@ those macros. version="2.38" introspectable="0"> Evaluates to a pointer to the @field_name inside the @inst private data + filename="gobject/gtype.h" + line="2210">Evaluates to a pointer to the @field_name inside the @inst private data structure for @TypeName. Note that this macro can only be used together with the `G_DEFINE_TYPE_*` and G_ADD_PRIVATE() macros, since it depends on variable names from those macros. - + the name of the type in CamelCase + filename="gobject/gtype.h" + line="2212">the name of the type in CamelCase the instance of @TypeName you wish to access + filename="gobject/gtype.h" + line="2213">the instance of @TypeName you wish to access the name of the field in the private data structure + filename="gobject/gtype.h" + line="2214">the name of the field in the private data structure @@ -11594,75 +12669,73 @@ those macros. version="2.38" introspectable="0"> Evaluates to the offset of the @field inside the instance private data + filename="gobject/gtype.h" + line="2193">Evaluates to the offset of the @field inside the instance private data structure for @TypeName. Note that this macro can only be used together with the `G_DEFINE_TYPE_*` and G_ADD_PRIVATE() macros, since it depends on variable names from those macros. - + the name of the type in CamelCase + filename="gobject/gtype.h" + line="2195">the name of the type in CamelCase the name of the field in the private data structure + filename="gobject/gtype.h" + line="2196">the name of the field in the private data structure Through the #GParamFlags flag values, certain aspects of parameters can be configured. See also: %G_PARAM_STATIC_STRINGS - + the parameter is readable the parameter is writable alias for %G_PARAM_READABLE | %G_PARAM_WRITABLE the parameter will be set upon object construction the parameter can only be set upon object construction upon parameter conversion (see g_param_value_convert()) strict validation is not required the string used as name when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. @@ -11670,12 +12743,12 @@ See also: %G_PARAM_STATIC_STRINGS internal the string used as nick when constructing the parameter is guaranteed to remain valid and unmmodified for the lifetime of the parameter. @@ -11685,7 +12758,7 @@ See also: %G_PARAM_STATIC_STRINGS value="128" c:identifier="G_PARAM_STATIC_BLURB"> the string used as blurb when constructing the parameter is guaranteed to remain valid and unmodified for the lifetime of the parameter. @@ -11695,7 +12768,7 @@ See also: %G_PARAM_STATIC_STRINGS value="1073741824" c:identifier="G_PARAM_EXPLICIT_NOTIFY"> calls to g_object_set_property() for this property will not automatically result in a "notify" signal being emitted: the implementation must call g_object_notify() themselves @@ -11705,7 +12778,7 @@ See also: %G_PARAM_STATIC_STRINGS value="2147483648" c:identifier="G_PARAM_DEPRECATED"> the parameter is deprecated and will be removed in a future version. A warning will be generated if it is used while running with G_ENABLE_DIAGNOSTIC=1. @@ -11725,28 +12798,26 @@ See also: %G_PARAM_STATIC_STRINGS glib:set-value-func="g_value_set_param" glib:get-value-func="g_value_get_param"> #GParamSpec is an object structure that encapsulates the metadata -required to specify parameters, such as e.g. #GObject properties. + filename="gobject/gparam.c" + line="33">`GParamSpec` encapsulates the metadata required to specify parameters, such as `GObject` properties. -## Parameter names # {#canonical-parameter-names} +## Parameter names A property name consists of one or more segments consisting of ASCII letters and digits, separated by either the `-` or `_` character. The first character of a property name must be a letter. These are the same rules as -for signal naming (see g_signal_new()). +for signal naming (see [func@GObject.signal_new]). -When creating and looking up a #GParamSpec, either separator can be +When creating and looking up a `GParamSpec`, either separator can be used, but they cannot be mixed. Using `-` is considerably more efficient, and is the ‘canonical form’. Using `_` is discouraged. - + Creates a new #GParamSpec instance. + filename="gobject/gparam.c" + line="422">Creates a new #GParamSpec instance. See [canonical parameter names][canonical-parameter-names] for details of the rules for @name. Names which violate these rules lead to undefined @@ -11758,26 +12829,25 @@ For GTK and related libraries these are considered deprecated and may be omitted, while for other libraries such as GStreamer and its plugins they are essential. When in doubt, follow the conventions used in the surrounding code and supporting libraries. - + (transfer floating): a newly allocated + filename="gobject/gparam.c" + line="443">(transfer floating): a newly allocated #GParamSpec instance, which is initially floating the #GType for the property; must be derived from %G_TYPE_PARAM + filename="gobject/gparam.c" + line="424">the #GType for the property; must be derived from %G_TYPE_PARAM the canonical name of the property + filename="gobject/gparam.c" + line="425">the canonical name of the property nullable="1" allow-none="1"> the nickname of the property + filename="gobject/gparam.c" + line="426">the nickname of the property nullable="1" allow-none="1"> a short description of the property + filename="gobject/gparam.c" + line="427">a short description of the property a combination of #GParamFlags + filename="gobject/gparam.c" + line="428">a combination of #GParamFlags @@ -11810,33 +12880,35 @@ surrounding code and supporting libraries. c:identifier="g_param_spec_is_valid_name" version="2.66"> Validate a property name for a #GParamSpec. This can be useful for + filename="gobject/gparam.c" + line="384">Validate a property name for a #GParamSpec. This can be useful for dynamically-generated properties which need to be validated at run-time before actually trying to create them. See [canonical parameter names][canonical-parameter-names] for details of the rules for valid names. - + %TRUE if @name is a valid property name, %FALSE otherwise. + filename="gobject/gparam.c" + line="395">%TRUE if @name is a valid property name, %FALSE otherwise. the canonical name of the property + filename="gobject/gparam.c" + line="386">the canonical name of the property - + The instance finalization function (optional), should chain + up to the finalize method of the parent class. + @@ -11847,8 +12919,12 @@ the rules for valid names. - + Checks if contents of @value comply with the specifications + set out by this type, without modifying the value. This vfunc is optional. + If it isn't set, GObject will use @value_validate. Since 2.74 + @@ -11862,8 +12938,12 @@ the rules for valid names. - + Resets a @value to the default value for this type + (recommended, the default is g_value_reset()), see + g_param_value_set_default(). + @@ -11877,8 +12957,12 @@ the rules for valid names. - + Ensures that the contents of @value comply with the + specifications set out by this type (optional), see + g_param_value_validate(). + @@ -11892,8 +12976,11 @@ the rules for valid names. - + Compares @value1 with @value2 according to this type + (recommended, the default is memcmp()), see g_param_values_cmp(). + @@ -11911,21 +12998,20 @@ the rules for valid names. Get the short description of a #GParamSpec. - + filename="gobject/gparam.c" + line="334">Get the short description of a #GParamSpec. + the short description of @pspec. + filename="gobject/gparam.c" + line="340">the short description of @pspec. a valid #GParamSpec + filename="gobject/gparam.c" + line="336">a valid #GParamSpec @@ -11934,47 +13020,45 @@ the rules for valid names. c:identifier="g_param_spec_get_default_value" version="2.38"> Gets the default value of @pspec as a pointer to a #GValue. + filename="gobject/gparam.c" + line="1621">Gets the default value of @pspec as a pointer to a #GValue. The #GValue will remain valid for the life of @pspec. - + a pointer to a #GValue which must not be modified + filename="gobject/gparam.c" + line="1629">a pointer to a #GValue which must not be modified a #GParamSpec + filename="gobject/gparam.c" + line="1623">a #GParamSpec Get the name of a #GParamSpec. + filename="gobject/gparam.c" + line="288">Get the name of a #GParamSpec. The name is always an "interned" string (as per g_intern_string()). This allows for pointer-value comparisons. - + the name of @pspec. + filename="gobject/gparam.c" + line="297">the name of @pspec. a valid #GParamSpec + filename="gobject/gparam.c" + line="290">a valid #GParamSpec @@ -11983,69 +13067,66 @@ This allows for pointer-value comparisons. c:identifier="g_param_spec_get_name_quark" version="2.46"> Gets the GQuark for the name. - + filename="gobject/gparam.c" + line="1667">Gets the GQuark for the name. + the GQuark for @pspec->name. + filename="gobject/gparam.c" + line="1673">the GQuark for @pspec->name. a #GParamSpec + filename="gobject/gparam.c" + line="1669">a #GParamSpec Get the nickname of a #GParamSpec. - + filename="gobject/gparam.c" + line="307">Get the nickname of a #GParamSpec. + the nickname of @pspec. + filename="gobject/gparam.c" + line="313">the nickname of @pspec. a valid #GParamSpec + filename="gobject/gparam.c" + line="309">a valid #GParamSpec Gets back user data pointers stored via g_param_spec_set_qdata(). - + filename="gobject/gparam.c" + line="501">Gets back user data pointers stored via g_param_spec_set_qdata(). + the user data pointer set, or %NULL + filename="gobject/gparam.c" + line="508">the user data pointer set, or %NULL a valid #GParamSpec + filename="gobject/gparam.c" + line="503">a valid #GParamSpec a #GQuark, naming the user data pointer + filename="gobject/gparam.c" + line="504">a #GQuark, naming the user data pointer @@ -12054,49 +13135,47 @@ This allows for pointer-value comparisons. c:identifier="g_param_spec_get_redirect_target" version="2.4"> If the paramspec redirects operations to another paramspec, + filename="gobject/gparam.c" + line="591">If the paramspec redirects operations to another paramspec, returns that paramspec. Redirect is used typically for providing a new implementation of a property in a derived type while preserving all the properties from the parent type. Redirection is established by creating a property of type #GParamSpecOverride. See g_object_class_override_property() for an example of the use of this capability. - + paramspec to which requests on this + filename="gobject/gparam.c" + line="605">paramspec to which requests on this paramspec should be redirected, or %NULL if none. a #GParamSpec + filename="gobject/gparam.c" + line="593">a #GParamSpec Increments the reference count of @pspec. - + filename="gobject/gparam.c" + line="204">Increments the reference count of @pspec. + the #GParamSpec that was passed into this function + filename="gobject/gparam.c" + line="210">the #GParamSpec that was passed into this function a valid #GParamSpec + filename="gobject/gparam.c" + line="206">a valid #GParamSpec @@ -12106,50 +13185,48 @@ for an example of the use of this capability. version="2.10" introspectable="0"> Convenience function to ref and sink a #GParamSpec. - + filename="gobject/gparam.c" + line="266">Convenience function to ref and sink a #GParamSpec. + the #GParamSpec that was passed into this function + filename="gobject/gparam.c" + line="273">the #GParamSpec that was passed into this function a valid #GParamSpec + filename="gobject/gparam.c" + line="268">a valid #GParamSpec Sets an opaque, named pointer on a #GParamSpec. The name is + filename="gobject/gparam.c" + line="519">Sets an opaque, named pointer on a #GParamSpec. The name is specified through a #GQuark (retrieved e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @pspec with g_param_spec_get_qdata(). Setting a previously set user data pointer, overrides (frees) the old pointer set, using %NULL as pointer essentially removes the data stored. - + the #GParamSpec to set store a user data pointer + filename="gobject/gparam.c" + line="521">the #GParamSpec to set store a user data pointer a #GQuark, naming the user data pointer + filename="gobject/gparam.c" + line="522">a #GQuark, naming the user data pointer nullable="1" allow-none="1"> an opaque user data pointer + filename="gobject/gparam.c" + line="523">an opaque user data pointer @@ -12167,28 +13244,27 @@ set, using %NULL as pointer essentially removes the data stored. c:identifier="g_param_spec_set_qdata_full" introspectable="0"> This function works like g_param_spec_set_qdata(), but in addition, + filename="gobject/gparam.c" + line="543">This function works like g_param_spec_set_qdata(), but in addition, a `void (*destroy) (gpointer)` function may be specified which is called with @data as argument when the @pspec is finalized, or the data is being overwritten by a call to g_param_spec_set_qdata() with the same @quark. - + the #GParamSpec to set store a user data pointer + filename="gobject/gparam.c" + line="545">the #GParamSpec to set store a user data pointer a #GQuark, naming the user data pointer + filename="gobject/gparam.c" + line="546">a #GQuark, naming the user data pointer nullable="1" allow-none="1"> an opaque user data pointer + filename="gobject/gparam.c" + line="547">an opaque user data pointer allow-none="1" scope="async"> function to invoke with @data as argument, when @data needs to + filename="gobject/gparam.c" + line="548">function to invoke with @data as argument, when @data needs to be freed @@ -12215,54 +13291,52 @@ g_param_spec_set_qdata() with the same @quark. The initial reference count of a newly created #GParamSpec is 1, + filename="gobject/gparam.c" + line="243">The initial reference count of a newly created #GParamSpec is 1, even though no one has explicitly called g_param_spec_ref() on it yet. So the initial reference count is flagged as "floating", until someone calls `g_param_spec_ref (pspec); g_param_spec_sink (pspec);` in sequence on it, taking over the initial reference count (thus ending up with a @pspec that has a reference count of 1 still, but is not flagged "floating" anymore). - + a valid #GParamSpec + filename="gobject/gparam.c" + line="245">a valid #GParamSpec Gets back user data pointers stored via g_param_spec_set_qdata() + filename="gobject/gparam.c" + line="569">Gets back user data pointers stored via g_param_spec_set_qdata() and removes the @data from @pspec without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier. - + the user data pointer set, or %NULL + filename="gobject/gparam.c" + line="579">the user data pointer set, or %NULL the #GParamSpec to get a stored user data pointer from + filename="gobject/gparam.c" + line="571">the #GParamSpec to get a stored user data pointer from a #GQuark, naming the user data pointer + filename="gobject/gparam.c" + line="572">a #GQuark, naming the user data pointer @@ -12271,50 +13345,49 @@ required to update user data pointers with a destroy notifier. c:identifier="g_param_spec_unref" introspectable="0"> Decrements the reference count of a @pspec. - + filename="gobject/gparam.c" + line="222">Decrements the reference count of a @pspec. + a valid #GParamSpec + filename="gobject/gparam.c" + line="224">a valid #GParamSpec private #GTypeInstance portion + filename="gobject/gparam.c" + line="35">private `GTypeInstance` portion name of this parameter: always an interned string + filename="gobject/gparam.c" + line="36">name of this parameter: always an interned string #GParamFlags flags for this parameter + filename="gobject/gparam.c" + line="37">`GParamFlags` flags for this parameter the #GValue type for this parameter + filename="gobject/gparam.c" + line="38">the `GValue` type for this parameter #GType type that uses (introduces) this parameter + filename="gobject/gparam.c" + line="39">`GType` type that uses (introduces) this parameter @@ -12341,17 +13414,17 @@ required to update user data pointers with a destroy notifier. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for boolean properties. private #GParamSpec portion default value for the property specified @@ -12364,11 +13437,11 @@ required to update user data pointers with a destroy notifier. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for boxed properties. private #GParamSpec portion @@ -12381,29 +13454,29 @@ required to update user data pointers with a destroy notifier. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for character properties. private #GParamSpec portion minimum value for the property specified maximum value for the property specified default value for the property specified @@ -12412,28 +13485,30 @@ required to update user data pointers with a destroy notifier. c:type="GParamSpecClass" glib:is-gtype-struct-for="ParamSpec"> The class structure for the GParamSpec type. + filename="gobject/gparam.h" + line="223">The class structure for the GParamSpec type. Normally, GParamSpec classes are filled by g_param_type_register_static(). - + the parent class + filename="gobject/gparam.h" + line="225">the parent class the #GValue type for this parameter + filename="gobject/gparam.h" + line="226">the #GValue type for this parameter + The instance finalization function (optional), should chain + up to the finalize method of the parent class. - + @@ -12445,9 +13520,13 @@ g_param_type_register_static(). + Resets a @value to the default value for this type + (recommended, the default is g_value_reset()), see + g_param_value_set_default(). - + @@ -12462,9 +13541,13 @@ g_param_type_register_static(). + Ensures that the contents of @value comply with the + specifications set out by this type (optional), see + g_param_value_validate(). - + @@ -12479,9 +13562,12 @@ g_param_type_register_static(). + Compares @value1 with @value2 according to this type + (recommended, the default is memcmp()), see g_param_values_cmp(). - + @@ -12499,9 +13585,13 @@ g_param_type_register_static(). + Checks if contents of @value comply with the specifications + set out by this type, without modifying the value. This vfunc is optional. + If it isn't set, GObject will use @value_validate. Since 2.74 - + @@ -12529,35 +13619,35 @@ g_param_type_register_static(). glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for double properties. private #GParamSpec portion minimum value for the property specified maximum value for the property specified default value for the property specified values closer than @epsilon will be considered identical by g_param_values_cmp(); the default value is 1e-90. @@ -12571,24 +13661,24 @@ g_param_type_register_static(). glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for enum properties. private #GParamSpec portion the #GEnumClass for the enum default value for the property specified @@ -12601,24 +13691,24 @@ properties. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for flags properties. private #GParamSpec portion the #GFlagsClass for the flags default value for the property specified @@ -12631,35 +13721,35 @@ properties. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for float properties. private #GParamSpec portion minimum value for the property specified maximum value for the property specified default value for the property specified values closer than @epsilon will be considered identical by g_param_values_cmp(); the default value is 1e-30. @@ -12674,17 +13764,17 @@ properties. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for #GType properties. private #GParamSpec portion a #GType whose subtypes can occur as values @@ -12697,29 +13787,29 @@ properties. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for integer properties. private #GParamSpec portion minimum value for the property specified maximum value for the property specified default value for the property specified @@ -12732,29 +13822,29 @@ properties. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for 64bit integer properties. private #GParamSpec portion minimum value for the property specified maximum value for the property specified default value for the property specified @@ -12767,29 +13857,29 @@ properties. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for long integer properties. private #GParamSpec portion minimum value for the property specified maximum value for the property specified default value for the property specified @@ -12802,11 +13892,11 @@ properties. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for object properties. private #GParamSpec portion @@ -12820,7 +13910,7 @@ properties. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that redirects operations to other types of #GParamSpec. @@ -12847,12 +13937,12 @@ unless you are implementing a new base type similar to GObject. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for %G_TYPE_PARAM properties. private #GParamSpec portion @@ -12865,11 +13955,11 @@ properties. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for pointer properties. private #GParamSpec portion @@ -12879,55 +13969,69 @@ properties. disguised="1" opaque="1"> A #GParamSpecPool maintains a collection of #GParamSpecs which can be + filename="gobject/gparam.c" + line="935">A #GParamSpecPool maintains a collection of #GParamSpecs which can be quickly accessed by owner and name. The implementation of the #GObject property system uses such a pool to store the #GParamSpecs of the properties all object types. - + + + Frees the resources allocated by a #GParamSpecPool. + + + + + + + a #GParamSpecPool + + + + Inserts a #GParamSpec in the pool. - + filename="gobject/gparam.c" + line="1023">Inserts a #GParamSpec in the pool. + a #GParamSpecPool. + filename="gobject/gparam.c" + line="1025">a #GParamSpecPool. the #GParamSpec to insert + filename="gobject/gparam.c" + line="1026">the #GParamSpec to insert a #GType identifying the owner of @pspec + filename="gobject/gparam.c" + line="1027">a #GType identifying the owner of @pspec Gets an array of all #GParamSpecs owned by @owner_type in + filename="gobject/gparam.c" + line="1363">Gets an array of all #GParamSpecs owned by @owner_type in the pool. - + a newly + filename="gobject/gparam.c" + line="1372">a newly allocated array containing pointers to all #GParamSpecs owned by @owner_type in the pool @@ -12937,14 +14041,14 @@ the pool. a #GParamSpecPool + filename="gobject/gparam.c" + line="1365">a #GParamSpecPool the owner to look for + filename="gobject/gparam.c" + line="1366">the owner to look for caller-allocates="0" transfer-ownership="full"> return location for the length of the returned array + filename="gobject/gparam.c" + line="1367">return location for the length of the returned array Gets an #GList of all #GParamSpecs owned by @owner_type in + filename="gobject/gparam.c" + line="1233">Gets an #GList of all #GParamSpecs owned by @owner_type in the pool. - + a + filename="gobject/gparam.c" + line="1241">a #GList of all #GParamSpecs owned by @owner_type in the pool#GParamSpecs. @@ -12978,54 +14081,53 @@ the pool. a #GParamSpecPool + filename="gobject/gparam.c" + line="1235">a #GParamSpecPool the owner to look for + filename="gobject/gparam.c" + line="1236">the owner to look for Looks up a #GParamSpec in the pool. - + filename="gobject/gparam.c" + line="1142">Looks up a #GParamSpec in the pool. + The found #GParamSpec, or %NULL if no + filename="gobject/gparam.c" + line="1152">The found #GParamSpec, or %NULL if no matching #GParamSpec was found. a #GParamSpecPool + filename="gobject/gparam.c" + line="1144">a #GParamSpecPool the name to look for + filename="gobject/gparam.c" + line="1145">the name to look for the owner to look for + filename="gobject/gparam.c" + line="1146">the owner to look for If %TRUE, also try to find a #GParamSpec with @param_name + filename="gobject/gparam.c" + line="1147">If %TRUE, also try to find a #GParamSpec with @param_name owned by an ancestor of @owner_type. @@ -13033,24 +14135,23 @@ matching #GParamSpec was found. Removes a #GParamSpec from the pool. - + filename="gobject/gparam.c" + line="1063">Removes a #GParamSpec from the pool. + a #GParamSpecPool + filename="gobject/gparam.c" + line="1065">a #GParamSpecPool the #GParamSpec to remove + filename="gobject/gparam.c" + line="1066">the #GParamSpec to remove @@ -13059,26 +14160,25 @@ matching #GParamSpec was found. c:identifier="g_param_spec_pool_new" introspectable="0"> Creates a new #GParamSpecPool. + filename="gobject/gparam.c" + line="976">Creates a new #GParamSpecPool. If @type_prefixing is %TRUE, lookups in the newly created pool will allow to specify the owner as a colon-separated prefix of the property name, like "GtkContainer:border-width". This feature is deprecated, so you should always set @type_prefixing to %FALSE. - + a newly allocated #GParamSpecPool. + filename="gobject/gparam.c" + line="987">a newly allocated #GParamSpecPool. Whether the pool will support type-prefixed property names. + filename="gobject/gparam.c" + line="978">Whether the pool will support type-prefixed property names. @@ -13092,56 +14192,56 @@ deprecated, so you should always set @type_prefixing to %FALSE. glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for string properties. private #GParamSpec portion default value for the property specified a string containing the allowed values for the first byte a string containing the allowed values for the subsequent bytes the replacement byte for bytes which don't match @cset_first or @cset_nth. replace empty string by %NULL replace %NULL strings by an empty string This structure is used to provide the type system with the information + filename="gobject/gparam.h" + line="362">This structure is used to provide the type system with the information required to initialize and destruct (finalize) a parameter's class and instances thereof. @@ -13149,24 +14249,25 @@ The initialized structure is passed to the g_param_type_register_static() The type system will perform a deep copy of this structure, so its memory does not need to be persistent across invocation of g_param_type_register_static(). - + Size of the instance (object) structure. + filename="gobject/gparam.h" + line="364">Size of the instance (object) structure. Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now. + filename="gobject/gparam.h" + line="365">Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now. + Location of the instance initialization function (optional). - + @@ -13179,14 +14280,16 @@ g_param_type_register_static(). The #GType of values conforming to this #GParamSpec + filename="gobject/gparam.h" + line="367">The #GType of values conforming to this #GParamSpec + The instance finalization function (optional). - + @@ -13198,9 +14301,13 @@ g_param_type_register_static(). + Resets a @value to the default value for @pspec + (recommended, the default is g_value_reset()), see + g_param_value_set_default(). - + @@ -13215,9 +14322,13 @@ g_param_type_register_static(). + Ensures that the contents of @value comply with the + specifications set out by @pspec (optional), see + g_param_value_validate(). - + @@ -13232,9 +14343,12 @@ g_param_type_register_static(). + Compares @value1 with @value2 according to @pspec + (recommended, the default is memcmp()), see g_param_values_cmp(). - + @@ -13260,29 +14374,29 @@ g_param_type_register_static(). glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for unsigned character properties. private #GParamSpec portion minimum value for the property specified maximum value for the property specified default value for the property specified @@ -13295,29 +14409,29 @@ g_param_type_register_static(). glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for unsigned integer properties. private #GParamSpec portion minimum value for the property specified maximum value for the property specified default value for the property specified @@ -13330,29 +14444,29 @@ g_param_type_register_static(). glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for unsigned 64bit integer properties. private #GParamSpec portion minimum value for the property specified maximum value for the property specified default value for the property specified @@ -13365,29 +14479,29 @@ g_param_type_register_static(). glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for unsigned long integer properties. private #GParamSpec portion minimum value for the property specified maximum value for the property specified default value for the property specified @@ -13400,17 +14514,17 @@ g_param_type_register_static(). glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for unichar (unsigned integer) properties. private #GParamSpec portion default value for the property specified @@ -13423,23 +14537,23 @@ g_param_type_register_static(). glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for #GValueArray properties. private #GParamSpec portion a #GParamSpec describing the elements contained in arrays of this property, may be %NULL if greater than 0, arrays of this property will always have this many elements @@ -13453,7 +14567,7 @@ g_param_type_register_static(). glib:get-type="intern" glib:fundamental="1"> A #GParamSpec derived structure that contains the meta data for #GVariant properties. When comparing values with g_param_values_cmp(), scalar values with the same @@ -13463,19 +14577,19 @@ otherwise undefined. %NULL is ordered before non-%NULL variants. Two %NULL values compare equal. private #GParamSpec portion a #GVariantType, or %NULL a #GVariant, or %NULL @@ -13490,40 +14604,62 @@ values compare equal. deprecated="1" deprecated-version="2.54"> The GParameter struct is an auxiliary structure used + filename="gobject/gparam.h" + line="268">The GParameter struct is an auxiliary structure used to hand parameter name/value pairs to g_object_newv(). This type is not introspectable. - + the parameter name + filename="gobject/gparam.h" + line="270">the parameter name the parameter value + filename="gobject/gparam.h" + line="271">the parameter value + + + + + + + + + + A mask for all #GSignalFlags bits. - + - + @@ -13531,15 +14667,14 @@ to hand parameter name/value pairs to g_object_newv(). A mask for all #GSignalMatchType bits. - + The signal accumulator is a special callback function that can be used to collect return values of the various callbacks that are called during a signal emission. @@ -13548,11 +14683,10 @@ The signal accumulator is specified at signal creation time, if it is left %NULL, no accumulation of callback return values is performed. The return value of signal emissions is then the value returned by the last callback. - + The accumulator function returns whether the signal emission should be aborted. Returning %TRUE will continue with the signal emission. Returning %FALSE will abort the current emission. @@ -13564,20 +14698,20 @@ last callback. Signal invocation hint, see #GSignalInvocationHint. Accumulator to collect callback return values in, this is the return value of the current signal emission. A #GValue holding the return value of the signal handler. @@ -13586,7 +14720,7 @@ last callback. nullable="1" allow-none="1"> Callback data that was specified when creating the signal. @@ -13594,18 +14728,17 @@ last callback. A simple function pointer to get invoked when the signal is emitted. Emission hooks allow you to tie a hook to the signal type, so that it will trap all emissions of that signal, from any object. You may not attach these to signals created with the %G_SIGNAL_NO_HOOKS flag. - + whether it wants to stay connected. If it returns %FALSE, the signal hook is disconnected (and destroyed). @@ -13613,20 +14746,20 @@ You may not attach these to signals created with the %G_SIGNAL_NO_HOOKS flag. Signal invocation hint, see #GSignalInvocationHint. the number of parameters to the function, including the instance on which the signal was emitted. the instance on which the signal was emitted, followed by the parameters of the emission. @@ -13638,7 +14771,7 @@ You may not attach these to signals created with the %G_SIGNAL_NO_HOOKS flag. user data associated with the hook. @@ -13646,41 +14779,40 @@ You may not attach these to signals created with the %G_SIGNAL_NO_HOOKS flag. The signal flags are used to specify a signal's behaviour. - + Invoke the object method handler in the first emission stage. Invoke the object method handler in the third emission stage. Invoke the object method handler in the last emission stage. Signals being emitted for an object while currently being in emission for this very object will not be emitted recursively, but instead cause the first emission to be restarted. This signal supports "::detail" appendices to the signal name upon handler connections and emissions. Action signals are signals that may freely be emitted on alive objects from user code via g_signal_emit() and friends, without the need of being embedded into extra code that performs pre or @@ -13690,20 +14822,20 @@ You may not attach these to signals created with the %G_SIGNAL_NO_HOOKS flag. No emissions hooks are supported for this signal. Varargs signal emission will always collect the arguments, even if there are no signal handlers connected. Since 2.30. The signal is deprecated and will be removed in a future version. A warning will be generated if it is connected while running with G_ENABLE_DIAGNOSTIC=1. Since 2.32. @@ -13712,7 +14844,7 @@ You may not attach these to signals created with the %G_SIGNAL_NO_HOOKS flag. Only used in #GSignalAccumulator accumulator functions for the #GSignalInvocationHint::run_type field to mark the first call to the accumulator function for a signal emission. Since 2.68. @@ -13726,10 +14858,11 @@ You may not attach these to signals created with the %G_SIGNAL_NO_HOOKS flag. #GSignalGroup manages to simplify the process of connecting -many signals to a #GObject as a group. As such there is no API -to disconnect a signal from the group. + filename="gobject/gsignalgroup.c" + line="30">`GSignalGroup` manages a collection of signals on a `GObject`. + +`GSignalGroup` simplifies the process of connecting many signals to a `GObject` +as a group. As such there is no API to disconnect a signal from the group. In particular, this allows you to: @@ -13738,52 +14871,50 @@ In particular, this allows you to: - Block and unblock signals as a group - Ensuring that blocked state transfers across target instances. -One place you might want to use such a structure is with #GtkTextView and -#GtkTextBuffer. Often times, you'll need to connect to many signals on -#GtkTextBuffer from a #GtkTextView subclass. This allows you to create a +One place you might want to use such a structure is with `GtkTextView` and +`GtkTextBuffer`. Often times, you'll need to connect to many signals on +`GtkTextBuffer` from a `GtkTextView` subclass. This allows you to create a signal group during instance construction, simply bind the -#GtkTextView:buffer property to #GSignalGroup:target and connect -all the signals you need. When the #GtkTextView:buffer property changes +`GtkTextView:buffer` property to `GSignalGroup:target` and connect +all the signals you need. When the `GtkTextView:buffer` property changes all of the signals will be transitioned correctly. Creates a new #GSignalGroup for target instances of @target_type. - + filename="gobject/gsignalgroup.c" + line="683">Creates a new #GSignalGroup for target instances of @target_type. + a new #GSignalGroup + filename="gobject/gsignalgroup.c" + line="689">a new #GSignalGroup the #GType of the target instance. + filename="gobject/gsignalgroup.c" + line="685">the #GType of the target instance. Blocks all signal handlers managed by @self so they will not + filename="gobject/gsignalgroup.c" + line="320">Blocks all signal handlers managed by @self so they will not be called during any signal emissions. Must be unblocked exactly the same number of times it has been blocked to become active again. This blocked state will be kept across changes of the target instance. - + the #GSignalGroup + filename="gobject/gsignalgroup.c" + line="322">the #GSignalGroup @@ -13793,27 +14924,26 @@ This blocked state will be kept across changes of the target instance. version="2.72" introspectable="0"> Connects @c_handler to the signal @detailed_signal + filename="gobject/gsignalgroup.c" + line="877">Connects @c_handler to the signal @detailed_signal on the target instance of @self. You cannot connect a signal handler after #GSignalGroup:target has been set. - + a #GSignalGroup + filename="gobject/gsignalgroup.c" + line="879">a #GSignalGroup a string of the form "signal-name::detail" + filename="gobject/gsignalgroup.c" + line="880">a string of the form "signal-name::detail" the #GCallback to connect + filename="gobject/gsignalgroup.c" + line="881">the #GCallback to connect the data to pass to @c_handler calls + filename="gobject/gsignalgroup.c" + line="882">the data to pass to @c_handler calls @@ -13841,29 +14971,28 @@ You cannot connect a signal handler after #GSignalGroup:target has been set. Connects @c_handler to the signal @detailed_signal + filename="gobject/gsignalgroup.c" + line="901">Connects @c_handler to the signal @detailed_signal on the target instance of @self. The @c_handler will be called after the default handler of the signal. You cannot connect a signal handler after #GSignalGroup:target has been set. - + a #GSignalGroup + filename="gobject/gsignalgroup.c" + line="903">a #GSignalGroup a string of the form "signal-name::detail" + filename="gobject/gsignalgroup.c" + line="904">a string of the form "signal-name::detail" the #GCallback to connect + filename="gobject/gsignalgroup.c" + line="905">the #GCallback to connect the data to pass to @c_handler calls + filename="gobject/gsignalgroup.c" + line="906">the data to pass to @c_handler calls @@ -13890,38 +15019,37 @@ You cannot connect a signal handler after #GSignalGroup:target has been set. Connects @closure to the signal @detailed_signal on #GSignalGroup:target. + filename="gobject/gsignalgroup.c" + line="760">Connects @closure to the signal @detailed_signal on #GSignalGroup:target. You cannot connect a signal handler after #GSignalGroup:target has been set. - + a #GSignalGroup + filename="gobject/gsignalgroup.c" + line="762">a #GSignalGroup a string of the form `signal-name` with optional `::signal-detail` + filename="gobject/gsignalgroup.c" + line="763">a string of the form `signal-name` with optional `::signal-detail` the closure to connect. + filename="gobject/gsignalgroup.c" + line="764">the closure to connect. whether the handler should be called before or after the + filename="gobject/gsignalgroup.c" + line="765">whether the handler should be called before or after the default handler of the signal. @@ -13931,27 +15059,26 @@ You cannot connect a signal handler after #GSignalGroup:target has been set. Connects @c_handler to the signal @detailed_signal + filename="gobject/gsignalgroup.c" + line="849">Connects @c_handler to the signal @detailed_signal on the target instance of @self. You cannot connect a signal handler after #GSignalGroup:target has been set. - + a #GSignalGroup + filename="gobject/gsignalgroup.c" + line="851">a #GSignalGroup a string of the form "signal-name::detail" + filename="gobject/gsignalgroup.c" + line="852">a string of the form "signal-name::detail" the #GCallback to connect + filename="gobject/gsignalgroup.c" + line="853">the #GCallback to connect the data to pass to @c_handler calls + filename="gobject/gsignalgroup.c" + line="854">the data to pass to @c_handler calls function to be called when disposing of @self + filename="gobject/gsignalgroup.c" + line="855">function to be called when disposing of @self the flags used to create the signal connection + filename="gobject/gsignalgroup.c" + line="856">the flags used to create the signal connection @@ -13992,50 +15119,49 @@ You cannot connect a signal handler after #GSignalGroup:target has been set. Connects @c_handler to the signal @detailed_signal on #GSignalGroup:target. + filename="gobject/gsignalgroup.c" + line="818">Connects @c_handler to the signal @detailed_signal on #GSignalGroup:target. Ensures that the @object stays alive during the call to @c_handler by temporarily adding a reference count. When the @object is destroyed the signal handler will automatically be removed. You cannot connect a signal handler after #GSignalGroup:target has been set. - + a #GSignalGroup + filename="gobject/gsignalgroup.c" + line="820">a #GSignalGroup a string of the form `signal-name` with optional `::signal-detail` + filename="gobject/gsignalgroup.c" + line="821">a string of the form `signal-name` with optional `::signal-detail` the #GCallback to connect + filename="gobject/gsignalgroup.c" + line="822">the #GCallback to connect the #GObject to pass as data to @c_handler calls + filename="gobject/gsignalgroup.c" + line="823">the #GObject to pass as data to @c_handler calls #GConnectFlags for the signal connection + filename="gobject/gsignalgroup.c" + line="824">#GConnectFlags for the signal connection @@ -14044,30 +15170,29 @@ You cannot connect a signal handler after #GSignalGroup:target has been set. Connects @c_handler to the signal @detailed_signal + filename="gobject/gsignalgroup.c" + line="927">Connects @c_handler to the signal @detailed_signal on the target instance of @self. The instance on which the signal is emitted and @data will be swapped when calling @c_handler. You cannot connect a signal handler after #GSignalGroup:target has been set. - + a #GSignalGroup + filename="gobject/gsignalgroup.c" + line="929">a #GSignalGroup a string of the form "signal-name::detail" + filename="gobject/gsignalgroup.c" + line="930">a string of the form "signal-name::detail" the #GCallback to connect + filename="gobject/gsignalgroup.c" + line="931">the #GCallback to connect the data to pass to @c_handler calls + filename="gobject/gsignalgroup.c" + line="932">the data to pass to @c_handler calls @@ -14094,21 +15219,20 @@ You cannot connect a signal handler after #GSignalGroup:target has been set. Gets the target instance used when connecting signals. - + filename="gobject/gsignalgroup.c" + line="414">Gets the target instance used when connecting signals. + The target instance + filename="gobject/gsignalgroup.c" + line="420">The target instance the #GSignalGroup + filename="gobject/gsignalgroup.c" + line="416">the #GSignalGroup @@ -14118,23 +15242,22 @@ You cannot connect a signal handler after #GSignalGroup:target has been set. Sets the target instance used when connecting signals. Any signal + filename="gobject/gsignalgroup.c" + line="438">Sets the target instance used when connecting signals. Any signal that has been registered with g_signal_group_connect_object() or similar functions will be connected to this object. If the target instance was previously set, signals will be disconnected from that object prior to connecting to @target. - + the #GSignalGroup. + filename="gobject/gsignalgroup.c" + line="440">the #GSignalGroup. nullable="1" allow-none="1"> The target instance used + filename="gobject/gsignalgroup.c" + line="441">The target instance used when connecting signals. @@ -14153,21 +15276,20 @@ disconnected from that object prior to connecting to @target. c:identifier="g_signal_group_unblock" version="2.72"> Unblocks all signal handlers managed by @self so they will be + filename="gobject/gsignalgroup.c" + line="368">Unblocks all signal handlers managed by @self so they will be called again during any signal emissions unless it is blocked again. Must be unblocked exactly the same number of times it has been blocked to become active again. - + the #GSignalGroup + filename="gobject/gsignalgroup.c" + line="370">the #GSignalGroup @@ -14178,8 +15300,8 @@ has been blocked to become active again. transfer-ownership="none" setter="set_target"> The target instance used when connecting signals. + filename="gobject/gsignalgroup.c" + line="605">The target instance used when connecting signals. construct-only="1" transfer-ownership="none"> The #GType of the target property. + filename="gobject/gsignalgroup.c" + line="617">The #GType of the target property. This signal is emitted when #GSignalGroup:target is set to a new value + filename="gobject/gsignalgroup.c" + line="631">This signal is emitted when #GSignalGroup:target is set to a new value other than %NULL. It is similar to #GObject::notify on `target` except it will not emit when #GSignalGroup:target is %NULL and also allows for receiving the #GObject without a data-race. @@ -14205,16 +15327,16 @@ receiving the #GObject without a data-race. a #GObject containing the new value for #GSignalGroup:target + filename="gobject/gsignalgroup.c" + line="634">a #GObject containing the new value for #GSignalGroup:target This signal is emitted when the target instance of @self is set to a + filename="gobject/gsignalgroup.c" + line="653">This signal is emitted when the target instance of @self is set to a new #GObject. This signal will only be emitted if the previous target of @self is @@ -14226,26 +15348,25 @@ non-%NULL. The #GSignalInvocationHint structure is used to pass on additional information to callbacks during a signal emission. - + The signal id of the signal invoking the callback The detail passed on for this emission The stage the signal emission is currently in, this field will contain one of %G_SIGNAL_RUN_FIRST, %G_SIGNAL_RUN_LAST or %G_SIGNAL_RUN_CLEANUP and %G_SIGNAL_ACCUMULATOR_FIRST_RUN. @@ -14256,93 +15377,91 @@ to callbacks during a signal emission. The match types specify what g_signal_handlers_block_matched(), g_signal_handlers_unblock_matched() and g_signal_handlers_disconnect_matched() match signals by. - + The signal id must be equal. The signal detail must be equal. The closure must be the same. The C closure callback must be the same. The closure data must be the same. Only unblocked signals may be matched. A structure holding in-depth information for a specific signal. See also: g_signal_query() - + The signal id of the signal being queried, or 0 if the signal to be queried was unknown. The signal name. The interface/instance type that this signal can be emitted for. The signal flags as passed in to g_signal_new(). The return type for user callbacks. The number of parameters that user callbacks take. The individual parameter types for user callbacks, note that the effective callback signature is: |[<!-- language="C" --> @@ -14355,33 +15474,106 @@ See also: g_signal_query() + + + Set the callback for a source as a #GClosure. + +If the source is not one of the standard GLib types, the @closure_callback +and @closure_marshal fields of the #GSourceFuncs structure must have been +filled in with pointers to appropriate functions. + + + + + + + the source + + + + a #GClosure + + + + + + Sets a dummy callback for @source. The callback will do nothing, and +if the source expects a #gboolean return value, it will return %TRUE. +(If the source expects any other type of return value, it will return +a 0/%NULL value; whatever g_value_init() initializes a #GValue to for +that type.) + +If the source is not one of the standard GLib types, the +@closure_callback and @closure_marshal fields of the #GSourceFuncs +structure must have been filled in with pointers to appropriate +functions. + + + + + + + the source + + + + + + + + + + + Checks that @g_class is a class structure of the type identified by @g_type + filename="gobject/gtype.h" + line="585">Checks that @g_class is a class structure of the type identified by @g_type and issues a warning if this is not the case. Returns @g_class casted to a pointer to @c_type. %NULL is not a valid class structure. This macro should only be used in type implementations. - + Location of a #GTypeClass structure + filename="gobject/gtype.h" + line="587">Location of a #GTypeClass structure The type to be returned + filename="gobject/gtype.h" + line="588">The type to be returned The corresponding C type of class structure of @g_type + filename="gobject/gtype.h" + line="589">The corresponding C type of class structure of @g_type @@ -14389,23 +15581,22 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_CHECK_CLASS_TYPE" introspectable="0"> Checks if @g_class is a class structure of the type identified by + filename="gobject/gtype.h" + line="598">Checks if @g_class is a class structure of the type identified by @g_type. If @g_class is %NULL, %FALSE will be returned. This macro should only be used in type implementations. - + Location of a #GTypeClass structure + filename="gobject/gtype.h" + line="600">Location of a #GTypeClass structure The type to be checked + filename="gobject/gtype.h" + line="601">The type to be checked @@ -14413,19 +15604,18 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_CHECK_INSTANCE" introspectable="0"> Checks if @instance is a valid #GTypeInstance structure, + filename="gobject/gtype.h" + line="501">Checks if @instance is a valid #GTypeInstance structure, otherwise issues a warning and returns %FALSE. %NULL is not a valid #GTypeInstance. This macro should only be used in type implementations. - + Location of a #GTypeInstance structure + filename="gobject/gtype.h" + line="503">Location of a #GTypeInstance structure @@ -14433,31 +15623,30 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_CHECK_INSTANCE_CAST" introspectable="0"> Checks that @instance is an instance of the type identified by @g_type + filename="gobject/gtype.h" + line="514">Checks that @instance is an instance of the type identified by @g_type and issues a warning if this is not the case. Returns @instance casted to a pointer to @c_type. No warning will be issued if @instance is %NULL, and %NULL will be returned. This macro should only be used in type implementations. - + Location of a #GTypeInstance structure + filename="gobject/gtype.h" + line="516">Location of a #GTypeInstance structure The type to be returned + filename="gobject/gtype.h" + line="517">The type to be returned The corresponding C type of @g_type + filename="gobject/gtype.h" + line="518">The corresponding C type of @g_type @@ -14465,23 +15654,22 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_CHECK_INSTANCE_FUNDAMENTAL_TYPE" introspectable="0"> Checks if @instance is an instance of the fundamental type identified by @g_type. + filename="gobject/gtype.h" + line="542">Checks if @instance is an instance of the fundamental type identified by @g_type. If @instance is %NULL, %FALSE will be returned. This macro should only be used in type implementations. - + Location of a #GTypeInstance structure. + filename="gobject/gtype.h" + line="544">Location of a #GTypeInstance structure. The fundamental type to be checked + filename="gobject/gtype.h" + line="545">The fundamental type to be checked @@ -14489,23 +15677,22 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_CHECK_INSTANCE_TYPE" introspectable="0"> Checks if @instance is an instance of the type identified by @g_type. If + filename="gobject/gtype.h" + line="529">Checks if @instance is an instance of the type identified by @g_type. If @instance is %NULL, %FALSE will be returned. This macro should only be used in type implementations. - + Location of a #GTypeInstance structure. + filename="gobject/gtype.h" + line="531">Location of a #GTypeInstance structure. The type to be checked + filename="gobject/gtype.h" + line="532">The type to be checked @@ -14513,18 +15700,17 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_CHECK_VALUE" introspectable="0"> Checks if @value has been initialized to hold values + filename="gobject/gtype.h" + line="611">Checks if @value has been initialized to hold values of a value type. This macro should only be used in type implementations. - + a #GValue + filename="gobject/gtype.h" + line="613">a #GValue @@ -14532,23 +15718,22 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_CHECK_VALUE_TYPE" introspectable="0"> Checks if @value has been initialized to hold values + filename="gobject/gtype.h" + line="623">Checks if @value has been initialized to hold values of type @g_type. This macro should only be used in type implementations. - + a #GValue + filename="gobject/gtype.h" + line="625">a #GValue The type to be checked + filename="gobject/gtype.h" + line="626">The type to be checked @@ -14557,30 +15742,29 @@ This macro should only be used in type implementations. version="2.24" introspectable="0"> Gets the private class structure for a particular type. + filename="gobject/gtype.h" + line="690">Gets the private class structure for a particular type. The private structure must have been registered in the get_type() function with g_type_add_class_private(). This macro should only be used in type implementations. - + the class of a type deriving from @private_type + filename="gobject/gtype.h" + line="692">the class of a type deriving from @private_type the type identifying which private data to retrieve + filename="gobject/gtype.h" + line="693">the type identifying which private data to retrieve The C type for the private structure + filename="gobject/gtype.h" + line="694">The C type for the private structure @@ -14588,27 +15772,25 @@ This macro should only be used in type implementations. value="1" c:type="G_TYPE_FLAG_RESERVED_ID_BIT"> A bit in the type number that's supposed to be left untouched. - - + filename="gobject/gtype.h" + line="2706">A bit in the type number that's supposed to be left untouched. + + Get the type identifier from a given @class structure. + filename="gobject/gtype.h" + line="647">Get the type identifier from a given @class structure. This macro should only be used in type implementations. - + Location of a valid #GTypeClass structure + filename="gobject/gtype.h" + line="649">Location of a valid #GTypeClass structure @@ -14616,17 +15798,16 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_FROM_INSTANCE" introspectable="0"> Get the type identifier from a given @instance structure. + filename="gobject/gtype.h" + line="636">Get the type identifier from a given @instance structure. This macro should only be used in type implementations. - + Location of a valid #GTypeInstance structure + filename="gobject/gtype.h" + line="638">Location of a valid #GTypeInstance structure @@ -14634,17 +15815,16 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_FROM_INTERFACE" introspectable="0"> Get the type identifier from a given @interface structure. + filename="gobject/gtype.h" + line="658">Get the type identifier from a given @interface structure. This macro should only be used in type implementations. - + Location of a valid #GTypeInterface structure + filename="gobject/gtype.h" + line="660">Location of a valid #GTypeInterface structure @@ -14652,54 +15832,50 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_FUNDAMENTAL" introspectable="0"> The fundamental type which is the ancestor of @type. Fundamental types are types that serve as ultimate bases for the derived types, thus they are the roots of distinct inheritance hierarchies. - + A #GType value. An integer constant that represents the number of identifiers reserved + filename="gobject/gtype.h" + line="49">An integer constant that represents the number of identifiers reserved for types that are assigned at compile-time. - + Shift value used in converting numbers to type IDs. - + filename="gobject/gtype.h" + line="43">Shift value used in converting numbers to type IDs. + Checks if @type has a #GTypeValueTable. - + A #GType value @@ -14708,31 +15884,30 @@ for types that are assigned at compile-time. c:identifier="G_TYPE_INSTANCE_GET_CLASS" introspectable="0"> Get the class structure of a given @instance, casted + filename="gobject/gtype.h" + line="555">Get the class structure of a given @instance, casted to a specified ancestor type @g_type of the instance. Note that while calling a GInstanceInitFunc(), the class pointer gets modified, so it might not always return the expected pointer. This macro should only be used in type implementations. - + Location of the #GTypeInstance structure + filename="gobject/gtype.h" + line="557">Location of the #GTypeInstance structure The #GType of the class to be returned + filename="gobject/gtype.h" + line="558">The #GType of the class to be returned The C type of the class structure + filename="gobject/gtype.h" + line="559">The C type of the class structure @@ -14740,27 +15915,26 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_INSTANCE_GET_INTERFACE" introspectable="0"> Get the interface structure for interface @g_type of a given @instance. + filename="gobject/gtype.h" + line="572">Get the interface structure for interface @g_type of a given @instance. This macro should only be used in type implementations. - + Location of the #GTypeInstance structure + filename="gobject/gtype.h" + line="574">Location of the #GTypeInstance structure The #GType of the interface to be returned + filename="gobject/gtype.h" + line="575">The #GType of the interface to be returned The C type of the interface structure + filename="gobject/gtype.h" + line="576">The C type of the interface structure @@ -14771,8 +15945,8 @@ This macro should only be used in type implementations. deprecated="1" deprecated-version="2.58"> Gets the private structure for a particular type. + filename="gobject/gtype.h" + line="670">Gets the private structure for a particular type. The private structure must have been registered in the class_init function with g_type_class_add_private(). @@ -14780,23 +15954,22 @@ class_init function with g_type_class_add_private(). This macro should only be used in type implementations. Use G_ADD_PRIVATE() and the generated `your_type_get_instance_private()` function instead - + the instance of a type deriving from @private_type + filename="gobject/gtype.h" + line="672">the instance of a type deriving from @private_type the type identifying which private data to retrieve + filename="gobject/gtype.h" + line="673">the type identifying which private data to retrieve The C type for the private structure + filename="gobject/gtype.h" + line="674">The C type for the private structure @@ -14804,16 +15977,15 @@ This macro should only be used in type implementations. c:identifier="G_TYPE_IS_ABSTRACT" introspectable="0"> Checks if @type is an abstract type. An abstract type cannot be instantiated and is normally used as an abstract base class for derived classes. - + A #GType value @@ -14821,8 +15993,7 @@ derived classes. - + @@ -14832,7 +16003,7 @@ derived classes. c:identifier="G_TYPE_IS_CLASSED" introspectable="0"> Checks if @type is a classed type. A classed type has an associated #GTypeClass which can be derived to store @@ -14843,12 +16014,11 @@ fundamental types built into GLib are classed. Interfaces are not classed: while their #GTypeInterface struct could be considered similar to #GTypeClass, and classes can derive interfaces, #GTypeInterface doesn’t allow for subclassing. - + A #GType value @@ -14857,15 +16027,14 @@ considered similar to #GTypeClass, and classes can derive interfaces, c:identifier="G_TYPE_IS_DEEP_DERIVABLE" introspectable="0"> Checks if @type is a deep derivable type. A deep derivable type can be used as the base class of a deep (multi-level) class hierarchy. - + A #GType value @@ -14875,15 +16044,14 @@ can be used as the base class of a deep (multi-level) class hierarchy. version="2.76" introspectable="0"> Checks if @type is deprecated. Instantiating a deprecated type will trigger a warning if running with `G_ENABLE_DIAGNOSTIC=1`. - + a #GType value @@ -14892,15 +16060,14 @@ trigger a warning if running with `G_ENABLE_DIAGNOSTIC=1`. c:identifier="G_TYPE_IS_DERIVABLE" introspectable="0"> Checks if @type is a derivable type. A derivable type can be used as the base class of a flat (single-level) class hierarchy. - + A #GType value @@ -14909,16 +16076,15 @@ be used as the base class of a flat (single-level) class hierarchy. c:identifier="G_TYPE_IS_DERIVED" introspectable="0"> Checks if @type is derived (or in object-oriented terminology: inherited) from another type (this holds true for all non-fundamental types). - + A #GType value @@ -14927,14 +16093,13 @@ types). c:identifier="G_TYPE_IS_ENUM" introspectable="0"> Checks whether @type "is a" %G_TYPE_ENUM. - + a #GType ID. @@ -14944,15 +16109,14 @@ types). version="2.70" introspectable="0"> Checks if @type is a final type. A final type cannot be derived any further. - + a #GType value @@ -14961,14 +16125,13 @@ further. c:identifier="G_TYPE_IS_FLAGS" introspectable="0"> Checks whether @type "is a" %G_TYPE_FLAGS. - + a #GType ID. @@ -14977,14 +16140,13 @@ further. c:identifier="G_TYPE_IS_FUNDAMENTAL" introspectable="0"> Checks if @type is a fundamental type. - + A #GType value @@ -14993,15 +16155,14 @@ further. c:identifier="G_TYPE_IS_INSTANTIATABLE" introspectable="0"> Checks if @type can be instantiated. Instantiation is the process of creating an instance (object) of this type. - + A #GType value @@ -15010,7 +16171,7 @@ process of creating an instance (object) of this type. c:identifier="G_TYPE_IS_INTERFACE" introspectable="0"> Checks if @type is an interface type. An interface type provides a pure API, the implementation @@ -15019,12 +16180,11 @@ to the interface). GLib interfaces are somewhat analogous to Java interfaces and C++ classes containing only pure virtual functions, with the difference that GType interfaces are not derivable (but see g_type_interface_add_prerequisite() for an alternative). - + A #GType value @@ -15033,14 +16193,13 @@ g_type_interface_add_prerequisite() for an alternative). c:identifier="G_TYPE_IS_OBJECT" introspectable="0"> Check if the passed in type id is a %G_TYPE_OBJECT or derived from it. - + Type id to check @@ -15049,14 +16208,13 @@ g_type_interface_add_prerequisite() for an alternative). c:identifier="G_TYPE_IS_PARAM" introspectable="0"> Checks whether @type "is a" %G_TYPE_PARAM. - + a #GType ID @@ -15065,17 +16223,16 @@ g_type_interface_add_prerequisite() for an alternative). c:identifier="G_TYPE_IS_VALUE" introspectable="0"> Checks whether the passed in type ID can be used for g_value_init(). That is, this macro checks whether this type provides an implementation of the #GTypeValueTable functions required for a type to create a #GValue of. - + A #GType value. @@ -15084,16 +16241,15 @@ of the #GTypeValueTable functions required for a type to create a #GValue of. Checks if @type is an abstract value type. An abstract value type introduces a value table, but can't be used for g_value_init() and is normally used as an abstract base type for derived value types. - + A #GType value @@ -15102,14 +16258,13 @@ an abstract base type for derived value types. c:identifier="G_TYPE_IS_VALUE_TYPE" introspectable="0"> Checks if @type is a value type and can be used with g_value_init(). - + A #GType value @@ -15118,17 +16273,16 @@ an abstract base type for derived value types. c:identifier="G_TYPE_MAKE_FUNDAMENTAL" introspectable="0"> Get the type ID for the fundamental type number @x. Use g_type_fundamental_next() instead of this macro to create new fundamental types. - + the fundamental type number. @@ -15136,8 +16290,7 @@ types. - + @@ -15146,8 +16299,7 @@ types. - + @@ -15156,8 +16308,7 @@ types. - + @@ -15166,8 +16317,7 @@ types. - + @@ -15176,8 +16326,7 @@ types. - + @@ -15186,8 +16335,7 @@ types. - + @@ -15197,64 +16345,68 @@ types. value="32" c:type="G_TYPE_RESERVED_BSE_FIRST"> First fundamental type number to create a new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL() reserved for BSE. - + Last fundamental type number reserved for BSE. - + First fundamental type number to create a new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL() reserved for GLib. - + Last fundamental type number reserved for GLib. - + First available fundamental type number to create new fundamental type id with G_TYPE_MAKE_FUNDAMENTAL(). - + + + + + A callback function used for notification when the state + filename="gobject/gobject.h" + line="537">A callback function used for notification when the state of a toggle reference changes. See also: g_object_add_toggle_ref() - + @@ -15264,20 +16416,20 @@ See also: g_object_add_toggle_ref() nullable="1" allow-none="1"> Callback data passed to g_object_add_toggle_ref() + filename="gobject/gobject.h" + line="539">Callback data passed to g_object_add_toggle_ref() The object on which g_object_add_toggle_ref() was called. + filename="gobject/gobject.h" + line="540">The object on which g_object_add_toggle_ref() was called. %TRUE if the toggle reference is now the + filename="gobject/gobject.h" + line="541">%TRUE if the toggle reference is now the last reference to the object. %FALSE if the toggle reference was the last reference and there are now other references. @@ -15285,16 +16437,52 @@ See also: g_object_add_toggle_ref() + + - + A union holding one collected value. + + + the field for holding integer values + + + + the field for holding long integer values + + + + the field for holding 64 bit integer values + + + + the field for holding floating point values + + + + the field for holding pointers + + An opaque structure used as the base of all classes. - + filename="gobject/gtype.h" + line="446">An opaque structure used as the base of all classes. + @@ -15304,8 +16492,8 @@ See also: g_object_add_toggle_ref() deprecated="1" deprecated-version="2.58"> Registers a private structure for an instantiatable type. + filename="gobject/gtype.c" + line="4675">Registers a private structure for an instantiatable type. When an object is allocated, the private structures for the type and all of its parent types are allocated @@ -15369,23 +16557,22 @@ my_object_get_some_field (MyObject *my_object) ]| Use the G_ADD_PRIVATE() macro with the `G_DEFINE_*` family of macros to add instance private data to a type - + class structure for an instantiatable + filename="gobject/gtype.c" + line="4677">class structure for an instantiatable type size of private structure + filename="gobject/gtype.c" + line="4679">size of private structure @@ -15395,8 +16582,8 @@ my_object_get_some_field (MyObject *my_object) version="2.38" introspectable="0"> Gets the offset of the private data for instances of @g_class. + filename="gobject/gtype.c" + line="4910">Gets the offset of the private data for instances of @g_class. This is how many bytes you should add to the instance pointer of a class in order to get the private data for the type represented by @@ -15404,26 +16591,24 @@ class in order to get the private data for the type represented by You can only call this function after you have registered a private data area for @g_class using g_type_class_add_private(). - + the offset, in bytes + filename="gobject/gtype.c" + line="4923">the offset, in bytes a #GTypeClass + filename="gobject/gtype.c" + line="4912">a #GTypeClass - + @@ -15438,8 +16623,8 @@ data area for @g_class using g_type_class_add_private(). This is a convenience function often needed in class initializers. + filename="gobject/gtype.c" + line="3158">This is a convenience function often needed in class initializers. It returns the class structure of the immediate parent type of the class passed in. Since derived classes hold a reference count on their parent classes as long as they are instantiated, the returned @@ -15447,20 +16632,19 @@ class will always exist. This function is essentially equivalent to: g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class))) - + the parent class + filename="gobject/gtype.c" + line="3172">the parent class of @g_class the #GTypeClass structure to + filename="gobject/gtype.c" + line="3160">the #GTypeClass structure to retrieve the parent class for @@ -15468,21 +16652,20 @@ g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class))) Decrements the reference count of the class structure being passed in. + filename="gobject/gtype.c" + line="3046">Decrements the reference count of the class structure being passed in. Once the last reference count of a class has been released, classes may be finalized by the type system, so further dereferencing of a class pointer after g_type_class_unref() are invalid. - + a #GTypeClass structure to unref + filename="gobject/gtype.c" + line="3048">a #GTypeClass structure to unref @@ -15491,29 +16674,27 @@ class pointer after g_type_class_unref() are invalid. c:identifier="g_type_class_unref_uncached" introspectable="0"> A variant of g_type_class_unref() for use in #GTypeClassCacheFunc + filename="gobject/gtype.c" + line="3071">A variant of g_type_class_unref() for use in #GTypeClassCacheFunc implementations. It unreferences a class without consulting the chain of #GTypeClassCacheFuncs, avoiding the recursion which would occur otherwise. - + a #GTypeClass structure to unref + filename="gobject/gtype.c" + line="3073">a #GTypeClass structure to unref - + @@ -15531,18 +16712,17 @@ otherwise. This function is essentially the same as g_type_class_ref(), + filename="gobject/gtype.c" + line="3096">This function is essentially the same as g_type_class_ref(), except that the classes reference count isn't incremented. As a consequence, this function may return %NULL if the class of the type passed in does not currently exist (hasn't been referenced before). - + the #GTypeClass + filename="gobject/gtype.c" + line="3106">the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist @@ -15550,8 +16730,8 @@ referenced before). type ID of a classed type + filename="gobject/gtype.c" + line="3098">type ID of a classed type @@ -15560,15 +16740,14 @@ referenced before). c:identifier="g_type_class_peek_static" version="2.4"> A more efficient version of g_type_class_peek() which works only for + filename="gobject/gtype.c" + line="3127">A more efficient version of g_type_class_peek() which works only for static types. - + the #GTypeClass + filename="gobject/gtype.c" + line="3134">the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist or is dynamically loaded @@ -15576,32 +16755,31 @@ static types. type ID of a classed type + filename="gobject/gtype.c" + line="3129">type ID of a classed type Increments the reference count of the class structure belonging to + filename="gobject/gtype.c" + line="2980">Increments the reference count of the class structure belonging to @type. This function will demand-create the class if it doesn't exist already. - + the #GTypeClass + filename="gobject/gtype.c" + line="2988">the #GTypeClass structure for the given type ID type ID of a classed type + filename="gobject/gtype.c" + line="2982">type ID of a classed type @@ -15609,8 +16787,8 @@ exist already. A callback function which is called when the reference count of a class + filename="gobject/gtype.h" + line="1012">A callback function which is called when the reference count of a class drops to zero. It may use g_type_class_ref() to prevent the class from being freed. You @@ -15620,12 +16798,11 @@ to prevent infinite recursion, use g_type_class_unref_uncached() instead. The functions have to check the class id passed in to figure whether they actually want to cache the class of this type, since all classes are routed through the same #GTypeClassCacheFunc chain. - + %TRUE to stop further #GTypeClassCacheFuncs from being + filename="gobject/gtype.h" + line="1029">%TRUE to stop further #GTypeClassCacheFuncs from being called, %FALSE to continue @@ -15635,14 +16812,14 @@ classes are routed through the same #GTypeClassCacheFunc chain. nullable="1" allow-none="1"> data that was given to the g_type_add_class_cache_func() call + filename="gobject/gtype.h" + line="1014">data that was given to the g_type_add_class_cache_func() call The #GTypeClass structure which is + filename="gobject/gtype.h" + line="1015">The #GTypeClass structure which is unreferenced @@ -15653,135 +16830,131 @@ classes are routed through the same #GTypeClassCacheFunc chain. deprecated-version="2.36" c:type="GTypeDebugFlags"> These flags used to be passed to g_type_init_with_debug_flags() which + filename="gobject/gtype.h" + line="708">These flags used to be passed to g_type_init_with_debug_flags() which is now deprecated. If you need to enable debugging features, use the `GOBJECT_DEBUG` environment variable. g_type_init() is now done automatically - + Print no messages + filename="gobject/gtype.h" + line="710">Print no messages Print messages about object bookkeeping + filename="gobject/gtype.h" + line="711">Print messages about object bookkeeping Print messages about signal emissions + filename="gobject/gtype.h" + line="712">Print messages about signal emissions Keep a count of instances of each type + filename="gobject/gtype.h" + line="714">Keep a count of instances of each type Mask covering all debug flags + filename="gobject/gtype.h" + line="713">Mask covering all debug flags Bit masks used to check or determine characteristics of a type. - + filename="gobject/gtype.h" + line="1067">Bit masks used to check or determine characteristics of a type. + No special flags. Since: 2.74 + filename="gobject/gtype.h" + line="1069">No special flags. Since: 2.74 Indicates an abstract type. No instances can be + filename="gobject/gtype.h" + line="1070">Indicates an abstract type. No instances can be created for an abstract type Indicates an abstract value type, i.e. a type + filename="gobject/gtype.h" + line="1072">Indicates an abstract value type, i.e. a type that introduces a value table, but can't be used for g_value_init() Indicates a final type. A final type is a non-derivable + filename="gobject/gtype.h" + line="1075">Indicates a final type. A final type is a non-derivable leaf node in a deep derivable type hierarchy tree. Since: 2.70 The type is deprecated and may be removed in a + filename="gobject/gtype.h" + line="1077">The type is deprecated and may be removed in a future version. A warning will be emitted if it is instantiated while running with `G_ENABLE_DIAGNOSTIC=1`. Since 2.76 Bit masks used to check or determine specific characteristics of a + filename="gobject/gtype.h" + line="1048">Bit masks used to check or determine specific characteristics of a fundamental type. - + Indicates a classed type + filename="gobject/gtype.h" + line="1050">Indicates a classed type Indicates an instantiatable type (implies classed) + filename="gobject/gtype.h" + line="1051">Indicates an instantiatable type (implies classed) Indicates a flat derivable type + filename="gobject/gtype.h" + line="1052">Indicates a flat derivable type Indicates a deep derivable type (implies derivable) + filename="gobject/gtype.h" + line="1053">Indicates a deep derivable type (implies derivable) A structure that provides information to the type system which is + filename="gobject/gtype.h" + line="1143">A structure that provides information to the type system which is used specifically for managing fundamental types. - + #GTypeFundamentalFlags describing the characteristics of the fundamental type + filename="gobject/gtype.h" + line="1145">#GTypeFundamentalFlags describing the characteristics of the fundamental type This structure is used to provide the type system with the information + filename="gobject/gtype.h" + line="1091">This structure is used to provide the type system with the information required to initialize and destruct (finalize) a type's class and its instances. @@ -15790,30 +16963,29 @@ The initialized structure is passed to the g_type_register_static() function g_type_plugin_complete_type_info()). The type system will perform a deep copy of this structure, so its memory does not need to be persistent across invocation of g_type_register_static(). - + Size of the class structure (required for interface, classed and instantiatable types) + filename="gobject/gtype.h" + line="1093">Size of the class structure (required for interface, classed and instantiatable types) Location of the base initialization function (optional) + filename="gobject/gtype.h" + line="1094">Location of the base initialization function (optional) Location of the base finalization function (optional) + filename="gobject/gtype.h" + line="1095">Location of the base finalization function (optional) Location of the class initialization function for + filename="gobject/gtype.h" + line="1096">Location of the class initialization function for classed and instantiatable types. Location of the default vtable inititalization function for interface types. (optional) This function is used both to fill in virtual functions in the class or default vtable, @@ -15823,56 +16995,54 @@ across invocation of g_type_register_static(). Location of the class finalization function for + filename="gobject/gtype.h" + line="1102">Location of the class finalization function for classed and instantiatable types. Location of the default vtable finalization function for interface types. (optional) User-supplied data passed to the class init/finalize functions + filename="gobject/gtype.h" + line="1105">User-supplied data passed to the class init/finalize functions Size of the instance (object) structure (required for instantiatable types only) + filename="gobject/gtype.h" + line="1106">Size of the instance (object) structure (required for instantiatable types only) Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10 this field is ignored. + filename="gobject/gtype.h" + line="1107">Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10 this field is ignored. Location of the instance initialization function (optional, for instantiatable types only) + filename="gobject/gtype.h" + line="1108">Location of the instance initialization function (optional, for instantiatable types only) A #GTypeValueTable function table for generic handling of GValues + filename="gobject/gtype.h" + line="1109">A #GTypeValueTable function table for generic handling of GValues of this type (usually only useful for fundamental types) An opaque structure used as the base of all type instances. - + filename="gobject/gtype.h" + line="456">An opaque structure used as the base of all type instances. + - + @@ -15888,10 +17058,9 @@ across invocation of g_type_register_static(). An opaque structure used as the base of all interface types. - + filename="gobject/gtype.h" + line="466">An opaque structure used as the base of all interface types. + @@ -15900,17 +17069,16 @@ across invocation of g_type_register_static(). Returns the corresponding #GTypeInterface structure of the parent type + filename="gobject/gtype.c" + line="3235">Returns the corresponding #GTypeInterface structure of the parent type of the instance type to which @g_iface belongs. This is useful when deriving the implementation of an interface from the parent type and then possibly overriding some methods. - + the + filename="gobject/gtype.c" + line="3244">the corresponding #GTypeInterface structure of the parent type of the instance type to which @g_iface belongs, or %NULL if the parent type doesn't conform to the interface @@ -15919,8 +17087,8 @@ then possibly overriding some methods. a #GTypeInterface structure + filename="gobject/gtype.c" + line="3237">a #GTypeInterface structure @@ -15928,59 +17096,57 @@ then possibly overriding some methods. Adds @prerequisite_type to the list of prerequisites of @interface_type. + filename="gobject/gtype.c" + line="1536">Adds @prerequisite_type to the list of prerequisites of @interface_type. This means that any type implementing @interface_type must also implement @prerequisite_type. Prerequisites can be thought of as an alternative to interface derivation (which GType doesn't support). An interface can have at most one instantiatable prerequisite type. - + #GType value of an interface type + filename="gobject/gtype.c" + line="1538">#GType value of an interface type #GType value of an interface or instantiatable type + filename="gobject/gtype.c" + line="1539">#GType value of an interface or instantiatable type Returns the #GTypePlugin structure for the dynamic interface + filename="gobject/gtype.c" + line="4037">Returns the #GTypePlugin structure for the dynamic interface @interface_type which has been added to @instance_type, or %NULL if @interface_type has not been added to @instance_type or does not have a #GTypePlugin structure. See g_type_add_interface_dynamic(). - + the #GTypePlugin for the dynamic + filename="gobject/gtype.c" + line="4047">the #GTypePlugin for the dynamic interface @interface_type of @instance_type #GType of an instantiatable type + filename="gobject/gtype.c" + line="4039">#GType of an instantiatable type #GType of an interface type + filename="gobject/gtype.c" + line="4040">#GType of an interface type @@ -15989,41 +17155,39 @@ not have a #GTypePlugin structure. See g_type_add_interface_dynamic(). c:identifier="g_type_interface_instantiatable_prerequisite" version="2.68"> Returns the most specific instantiatable prerequisite of an + filename="gobject/gtype.c" + line="1683">Returns the most specific instantiatable prerequisite of an interface type. If the interface type has no instantiatable prerequisite, %G_TYPE_INVALID is returned. See g_type_interface_add_prerequisite() for more information about prerequisites. - + the instantiatable prerequisite type or %G_TYPE_INVALID if none + filename="gobject/gtype.c" + line="1694">the instantiatable prerequisite type or %G_TYPE_INVALID if none an interface type + filename="gobject/gtype.c" + line="1685">an interface type Returns the #GTypeInterface structure of an interface to which the + filename="gobject/gtype.c" + line="3202">Returns the #GTypeInterface structure of an interface to which the passed in class conforms. - + the #GTypeInterface + filename="gobject/gtype.c" + line="3210">the #GTypeInterface structure of @iface_type if implemented by @instance_class, %NULL otherwise @@ -16031,14 +17195,14 @@ passed in class conforms. a #GTypeClass structure + filename="gobject/gtype.c" + line="3204">a #GTypeClass structure an interface ID which this class conforms to + filename="gobject/gtype.c" + line="3205">an interface ID which this class conforms to @@ -16047,14 +17211,13 @@ passed in class conforms. c:identifier="g_type_interface_prerequisites" version="2.2"> Returns the prerequisites of an interfaces type. - + filename="gobject/gtype.c" + line="1622">Returns the prerequisites of an interfaces type. + a + filename="gobject/gtype.c" + line="1632">a newly-allocated zero-terminated array of #GType containing the prerequisites of @interface_type @@ -16064,8 +17227,8 @@ passed in class conforms. an interface type + filename="gobject/gtype.c" + line="1624">an interface type optional="1" allow-none="1"> location to return the number + filename="gobject/gtype.c" + line="1625">location to return the number of prerequisites, or %NULL @@ -16087,12 +17250,11 @@ passed in class conforms. c:type="GTypeInterfaceCheckFunc" version="2.4"> A callback called after an interface vtable is initialized. + filename="gobject/gtype.h" + line="1034">A callback called after an interface vtable is initialized. See g_type_add_interface_check(). - + @@ -16102,14 +17264,14 @@ See g_type_add_interface_check(). nullable="1" allow-none="1"> data passed to g_type_add_interface_check() + filename="gobject/gtype.h" + line="1036">data passed to g_type_add_interface_check() the interface that has been + filename="gobject/gtype.h" + line="1037">the interface that has been initialized @@ -16124,43 +17286,46 @@ See g_type_add_interface_check(). glib:get-type="g_type_module_get_type" glib:type-struct="TypeModuleClass"> #GTypeModule provides a simple implementation of the #GTypePlugin + filename="gobject/gtypemodule.c" + line="28">`GTypeModule` provides a simple implementation of the `GTypePlugin` interface. -The model of #GTypeModule is a dynamically loaded module which +The model of `GTypeModule` is a dynamically loaded module which implements some number of types and interface implementations. When the module is loaded, it registers its types and interfaces -using g_type_module_register_type() and g_type_module_add_interface(). +using [method@GObject.TypeModule.register_type] and +[method@GObject.TypeModule.add_interface]. As long as any instances of these types and interface implementations are in use, the module is kept loaded. When the types and interfaces are gone, the module may be unloaded. If the types and interfaces become used again, the module will be reloaded. Note that the last reference cannot be released from within the module code, since that -would lead to the caller's code being unloaded before g_object_unref() +would lead to the caller's code being unloaded before `g_object_unref()` returns to it. Keeping track of whether the module should be loaded or not is done by using a use count - it starts at zero, and whenever it is greater than zero, the module is loaded. The use count is maintained internally by the type system, but also can be explicitly controlled by -g_type_module_use() and g_type_module_unuse(). Typically, when loading -a module for the first type, g_type_module_use() will be used to load -it so that it can initialize its types. At some later point, when the -module no longer needs to be loaded except for the type -implementations it contains, g_type_module_unuse() is called. +[method@GObject.TypeModule.use] and [method@GObject.TypeModule.unuse]. +Typically, when loading a module for the first type, `g_type_module_use()` +will be used to load it so that it can initialize its types. At some later +point, when the module no longer needs to be loaded except for the type +implementations it contains, `g_type_module_unuse()` is called. -#GTypeModule does not actually provide any implementation of module +`GTypeModule` does not actually provide any implementation of module loading and unloading. To create a particular module type you must -derive from #GTypeModule and implement the load and unload functions -in #GTypeModuleClass. - +derive from `GTypeModule` and implement the load and unload functions +in `GTypeModuleClass`. + - + loads the module and registers one or more types using + g_type_module_register_type(). + @@ -16171,8 +17336,10 @@ in #GTypeModuleClass. - + unloads the module + @@ -16184,8 +17351,8 @@ in #GTypeModuleClass. Registers an additional interface for a type, whose interface lives + filename="gobject/gtypemodule.c" + line="453">Registers an additional interface for a type, whose interface lives in the given type plugin. If the interface was already registered for the type in this plugin, nothing will be done. @@ -16194,8 +17361,7 @@ not be unloaded. Since 2.56 if @module is %NULL this will call g_type_add_interface_static() instead. This can be used when making a static build of the module. - + @@ -16205,26 +17371,26 @@ instead. This can be used when making a static build of the module. nullable="1" allow-none="1"> a #GTypeModule + filename="gobject/gtypemodule.c" + line="455">a #GTypeModule type to which to add the interface. + filename="gobject/gtypemodule.c" + line="456">type to which to add the interface. interface type to add + filename="gobject/gtypemodule.c" + line="457">interface type to add type information structure + filename="gobject/gtypemodule.c" + line="458">type information structure @@ -16233,8 +17399,8 @@ instead. This can be used when making a static build of the module. c:identifier="g_type_module_register_enum" version="2.6"> Looks up or registers an enumeration that is implemented with a particular + filename="gobject/gtypemodule.c" + line="524">Looks up or registers an enumeration that is implemented with a particular type plugin. If a type with name @type_name was previously registered, the #GType identifier for the type is returned, otherwise the type is newly registered, and the resulting #GType identifier returned. @@ -16244,12 +17410,11 @@ not be unloaded. Since 2.56 if @module is %NULL this will call g_type_register_static() instead. This can be used when making a static build of the module. - + the new or existing type ID + filename="gobject/gtypemodule.c" + line="546">the new or existing type ID @@ -16258,20 +17423,20 @@ instead. This can be used when making a static build of the module. nullable="1" allow-none="1"> a #GTypeModule + filename="gobject/gtypemodule.c" + line="526">a #GTypeModule name for the type + filename="gobject/gtypemodule.c" + line="527">name for the type an array of #GEnumValue structs for the + filename="gobject/gtypemodule.c" + line="528">an array of #GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. @@ -16283,8 +17448,8 @@ instead. This can be used when making a static build of the module. c:identifier="g_type_module_register_flags" version="2.6"> Looks up or registers a flags type that is implemented with a particular + filename="gobject/gtypemodule.c" + line="566">Looks up or registers a flags type that is implemented with a particular type plugin. If a type with name @type_name was previously registered, the #GType identifier for the type is returned, otherwise the type is newly registered, and the resulting #GType identifier returned. @@ -16294,12 +17459,11 @@ not be unloaded. Since 2.56 if @module is %NULL this will call g_type_register_static() instead. This can be used when making a static build of the module. - + the new or existing type ID + filename="gobject/gtypemodule.c" + line="588">the new or existing type ID @@ -16308,20 +17472,20 @@ instead. This can be used when making a static build of the module. nullable="1" allow-none="1"> a #GTypeModule + filename="gobject/gtypemodule.c" + line="568">a #GTypeModule name for the type + filename="gobject/gtypemodule.c" + line="569">name for the type an array of #GFlagsValue structs for the + filename="gobject/gtypemodule.c" + line="570">an array of #GFlagsValue structs for the possible flags values. The array is terminated by a struct with all members being 0. @@ -16331,8 +17495,8 @@ instead. This can be used when making a static build of the module. Looks up or registers a type that is implemented with a particular + filename="gobject/gtypemodule.c" + line="353">Looks up or registers a type that is implemented with a particular type plugin. If a type with name @type_name was previously registered, the #GType identifier for the type is returned, otherwise the type is newly registered, and the resulting #GType identifier returned. @@ -16346,12 +17510,11 @@ not be unloaded. Since 2.56 if @module is %NULL this will call g_type_register_static() instead. This can be used when making a static build of the module. - + the new or existing type ID + filename="gobject/gtypemodule.c" + line="376">the new or existing type ID @@ -16360,103 +17523,100 @@ instead. This can be used when making a static build of the module. nullable="1" allow-none="1"> a #GTypeModule + filename="gobject/gtypemodule.c" + line="355">a #GTypeModule the type for the parent class + filename="gobject/gtypemodule.c" + line="356">the type for the parent class name for the type + filename="gobject/gtypemodule.c" + line="357">name for the type type information structure + filename="gobject/gtypemodule.c" + line="358">type information structure flags field providing details about the type + filename="gobject/gtypemodule.c" + line="359">flags field providing details about the type Sets the name for a #GTypeModule - + filename="gobject/gtypemodule.c" + line="178">Sets the name for a #GTypeModule + a #GTypeModule. + filename="gobject/gtypemodule.c" + line="180">a #GTypeModule. a human-readable name to use in error messages. + filename="gobject/gtypemodule.c" + line="181">a human-readable name to use in error messages. Decreases the use count of a #GTypeModule by one. If the + filename="gobject/gtypemodule.c" + line="279">Decreases the use count of a #GTypeModule by one. If the result is zero, the module will be unloaded. (However, the #GTypeModule will not be freed, and types associated with the #GTypeModule are not unregistered. Once a #GTypeModule is initialized, it must exist forever.) - + a #GTypeModule + filename="gobject/gtypemodule.c" + line="281">a #GTypeModule Increases the use count of a #GTypeModule by one. If the + filename="gobject/gtypemodule.c" + line="231">Increases the use count of a #GTypeModule by one. If the use count was zero before, the plugin will be loaded. If loading the plugin fails, the use count is reset to its prior value. - + %FALSE if the plugin needed to be loaded and + filename="gobject/gtypemodule.c" + line="240">%FALSE if the plugin needed to be loaded and loading the plugin failed. a #GTypeModule + filename="gobject/gtypemodule.c" + line="233">a #GTypeModule @@ -16479,8 +17639,8 @@ its prior value. the name of the module + filename="gobject/gtypemodule.c" + line="30">the name of the module @@ -16488,21 +17648,23 @@ its prior value. c:type="GTypeModuleClass" glib:is-gtype-struct-for="TypeModule"> In order to implement dynamic loading of types based on #GTypeModule, + filename="gobject/gtypemodule.h" + line="55">In order to implement dynamic loading of types based on #GTypeModule, the @load and @unload functions in #GTypeModuleClass must be implemented. - + the parent class + filename="gobject/gtypemodule.h" + line="57">the parent class + loads the module and registers one or more types using + g_type_module_register_type(). - + @@ -16514,9 +17676,11 @@ the @load and @unload functions in #GTypeModuleClass must be implemented. + unloads the module - + @@ -16529,8 +17693,7 @@ the @load and @unload functions in #GTypeModuleClass must be implemented. - + @@ -16538,8 +17701,7 @@ the @load and @unload functions in #GTypeModuleClass must be implemented. - + @@ -16547,8 +17709,7 @@ the @load and @unload functions in #GTypeModuleClass must be implemented. - + @@ -16556,8 +17717,7 @@ the @load and @unload functions in #GTypeModuleClass must be implemented. - + @@ -16570,8 +17730,8 @@ the @load and @unload functions in #GTypeModuleClass must be implemented. glib:type-name="GTypePlugin" glib:get-type="g_type_plugin_get_type"> An interface that handles the lifecycle of dynamically loaded types. + filename="gobject/gtypeplugin.c" + line="25">An interface that handles the lifecycle of dynamically loaded types. The GObject type system supports dynamic loading of types. It goes as follows: @@ -16579,82 +17739,81 @@ It goes as follows: 1. The type is initially introduced (usually upon loading the module the first time, or by your main application that knows what modules introduces what types), like this: - |[<!-- language="C" --> + ```c new_type_id = g_type_register_dynamic (parent_type_id, "TypeName", new_type_plugin, type_flags); - ]| - where @new_type_plugin is an implementation of the - #GTypePlugin interface. + ``` + where `new_type_plugin` is an implementation of the + `GTypePlugin` interface. 2. The type's implementation is referenced, e.g. through - g_type_class_ref() or through g_type_create_instance() (this is - being called by g_object_new()) or through one of the above done on - a type derived from @new_type_id. + [func@GObject.TypeClass.ref] or through [func@GObject.type_create_instance] + (this is being called by [ctor@GObject.Object.new]) or through one of the above + done on a type derived from `new_type_id`. -3. This causes the type system to load the type's implementation by - calling g_type_plugin_use() and g_type_plugin_complete_type_info() - on @new_type_plugin. +3. This causes the type system to load the type's implementation by calling + [method@GObject.TypePlugin.use] and [method@GObject.TypePlugin.complete_type_info] + on `new_type_plugin`. -4. At some point the type's implementation isn't required anymore, - e.g. after g_type_class_unref() or g_type_free_instance() (called - when the reference count of an instance drops to zero). +4. At some point the type's implementation isn't required anymore, e.g. after + [method@GObject.TypeClass.unref] or [func@GObject.type_free_instance] + (called when the reference count of an instance drops to zero). 5. This causes the type system to throw away the information retrieved - from g_type_plugin_complete_type_info() and then it calls - g_type_plugin_unuse() on @new_type_plugin. + from [method@GObject.TypePlugin.complete_type_info] and then it calls + [method@GObject.TypePlugin.unuse] on `new_type_plugin`. 6. Things may repeat from the second step. -So basically, you need to implement a #GTypePlugin type that +So basically, you need to implement a `GTypePlugin` type that carries a use_count, once use_count goes from zero to one, you need to load the implementation to successfully handle the upcoming -g_type_plugin_complete_type_info() call. Later, maybe after +[method@GObject.TypePlugin.complete_type_info] call. Later, maybe after succeeding use/unuse calls, once use_count drops to zero, you can unload the implementation again. The type system makes sure to call -g_type_plugin_use() and g_type_plugin_complete_type_info() again -when the type is needed again. +[method@GObject.TypePlugin.use] and [method@GObject.TypePlugin.complete_type_info] +again when the type is needed again. -#GTypeModule is an implementation of #GTypePlugin that already -implements most of this except for the actual module loading and +[class@GObject.TypeModule] is an implementation of `GTypePlugin` that +already implements most of this except for the actual module loading and unloading. It even handles multiple registered types per module. Calls the @complete_interface_info function from the + filename="gobject/gtypeplugin.c" + line="174">Calls the @complete_interface_info function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. - + the #GTypePlugin + filename="gobject/gtypeplugin.c" + line="176">the #GTypePlugin the #GType of an instantiatable type to which the interface + filename="gobject/gtypeplugin.c" + line="177">the #GType of an instantiatable type to which the interface is added the #GType of the interface whose info is completed + filename="gobject/gtypeplugin.c" + line="179">the #GType of the interface whose info is completed the #GInterfaceInfo to fill in + filename="gobject/gtypeplugin.c" + line="180">the #GInterfaceInfo to fill in @@ -16662,78 +17821,75 @@ function outside of the GObject type system itself. Calls the @complete_type_info function from the #GTypePluginClass of @plugin. + filename="gobject/gtypeplugin.c" + line="144">Calls the @complete_type_info function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. - + a #GTypePlugin + filename="gobject/gtypeplugin.c" + line="146">a #GTypePlugin the #GType whose info is completed + filename="gobject/gtypeplugin.c" + line="147">the #GType whose info is completed the #GTypeInfo struct to fill in + filename="gobject/gtypeplugin.c" + line="148">the #GTypeInfo struct to fill in the #GTypeValueTable to fill in + filename="gobject/gtypeplugin.c" + line="149">the #GTypeValueTable to fill in Calls the @unuse_plugin function from the #GTypePluginClass of + filename="gobject/gtypeplugin.c" + line="125">Calls the @unuse_plugin function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. - + a #GTypePlugin + filename="gobject/gtypeplugin.c" + line="127">a #GTypePlugin Calls the @use_plugin function from the #GTypePluginClass of + filename="gobject/gtypeplugin.c" + line="106">Calls the @use_plugin function from the #GTypePluginClass of @plugin. There should be no need to use this function outside of the GObject type system itself. - + a #GTypePlugin + filename="gobject/gtypeplugin.c" + line="108">a #GTypePlugin @@ -16741,30 +17897,29 @@ the GObject type system itself. The #GTypePlugin interface is used by the type system in order to handle + filename="gobject/gtypeplugin.h" + line="83">The #GTypePlugin interface is used by the type system in order to handle the lifecycle of dynamically loaded types. - + Increases the use count of the plugin. + filename="gobject/gtypeplugin.h" + line="85">Increases the use count of the plugin. Decreases the use count of the plugin. + filename="gobject/gtypeplugin.h" + line="86">Decreases the use count of the plugin. Fills in the #GTypeInfo and + filename="gobject/gtypeplugin.h" + line="87">Fills in the #GTypeInfo and #GTypeValueTable structs for the type. The structs are initialized with `memset(s, 0, sizeof (s))` before calling this function. Fills in missing parts of the #GInterfaceInfo + filename="gobject/gtypeplugin.h" + line="90">Fills in missing parts of the #GInterfaceInfo for the interface. The structs is initialized with `memset(s, 0, sizeof (s))` before calling this function. The type of the @complete_interface_info function of #GTypePluginClass. - + the #GTypePlugin the #GType of an instantiatable type to which the interface is added the #GType of the interface whose info is completed the #GInterfaceInfo to fill in @@ -16821,35 +17975,34 @@ the lifecycle of dynamically loaded types. The type of the @complete_type_info function of #GTypePluginClass. - + the #GTypePlugin the #GType whose info is completed the #GTypeInfo struct to fill in the #GTypeValueTable to fill in @@ -16857,17 +18010,16 @@ the lifecycle of dynamically loaded types. The type of the @unuse_plugin function of #GTypePluginClass. - + the #GTypePlugin whose use count should be decreased @@ -16875,18 +18027,17 @@ the lifecycle of dynamically loaded types. The type of the @use_plugin function of #GTypePluginClass, which gets called to increase the use count of @plugin. - + the #GTypePlugin whose use count should be increased @@ -16894,34 +18045,33 @@ to increase the use count of @plugin. A structure holding information for a specific type. + filename="gobject/gtype.h" + line="477">A structure holding information for a specific type. See also: g_type_query() - + the #GType value of the type + filename="gobject/gtype.h" + line="479">the #GType value of the type the name of the type + filename="gobject/gtype.h" + line="480">the name of the type the size of the class structure + filename="gobject/gtype.h" + line="481">the size of the class structure the size of the instance structure + filename="gobject/gtype.h" + line="482">the size of the instance structure @@ -16929,8 +18079,8 @@ See also: g_type_query() c:type="GTypeValueCollectFunc" version="2.78"> This function is responsible for converting the values collected from + filename="gobject/gtype.h" + line="1256">This function is responsible for converting the values collected from a variadic argument list into contents suitable for storage in a #GValue. This function should setup @value similar to #GTypeValueInitFunc; e.g. @@ -17001,40 +18151,39 @@ prior to returning an error; however, `collect_values()` is not obliged to return a correctly setup @value for error returns, simply because any non-`NULL` return is considered a fatal programming error, and further program behaviour is undefined. - + `NULL` on success, otherwise a + filename="gobject/gtype.h" + line="1335">`NULL` on success, otherwise a newly allocated error string on failure the value to initialize + filename="gobject/gtype.h" + line="1258">the value to initialize the number of collected values + filename="gobject/gtype.h" + line="1259">the number of collected values the collected values + filename="gobject/gtype.h" + line="1260">the collected values optional flags + filename="gobject/gtype.h" + line="1261">optional flags @@ -17043,8 +18192,8 @@ further program behaviour is undefined. c:type="GTypeValueCopyFunc" version="2.78"> Copies the content of a #GValue into another. + filename="gobject/gtype.h" + line="1212">Copies the content of a #GValue into another. The @dest_value is a #GValue with zero-filled data section and @src_value is a properly initialized #GValue of same type, or derived type. @@ -17056,16 +18205,15 @@ contents of @dest_value remain valid. String type example: |[<!-- language="C" --> dest_value->data[0].v_pointer = g_strdup (src_value->data[0].v_pointer); ]| - + the value to copy + filename="gobject/gtype.h" + line="1214">the value to copy the location of the copy + filename="gobject/gtype.h" + line="1215">the location of the copy @@ -17083,8 +18231,8 @@ dest_value->data[0].v_pointer = g_strdup (src_value->data[0].v_pointer); c:type="GTypeValueFreeFunc" version="2.78"> Frees any old contents that might be left in the `value->data` array of + filename="gobject/gtype.h" + line="1191">Frees any old contents that might be left in the `value->data` array of the given value. No resources may remain allocated through the #GValue contents after this @@ -17095,16 +18243,15 @@ function returns. E.g. for our above string type: if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS)) g_free (value->data[0].v_pointer); ]| - + the value to free + filename="gobject/gtype.h" + line="1193">the value to free @@ -17113,8 +18260,8 @@ if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS)) c:type="GTypeValueInitFunc" version="2.78"> Initializes the value contents by setting the fields of the `value->data` + filename="gobject/gtype.h" + line="1170">Initializes the value contents by setting the fields of the `value->data` array. The data array of the #GValue passed into this function was zero-filled @@ -17125,16 +18272,15 @@ implementation might look like: |[<!-- language="C" --> value->data[0].v_pointer = g_strdup (""); ]| - + the value to initialize + filename="gobject/gtype.h" + line="1172">the value to initialize @@ -17143,8 +18289,8 @@ value->data[0].v_pointer = g_strdup (""); c:type="GTypeValueLCopyFunc" version="2.78"> This function is responsible for storing the `value` + filename="gobject/gtype.h" + line="1346">This function is responsible for storing the `value` contents into arguments passed through a variadic argument list which got collected into `collect_values` according to `lcopy_format`. @@ -17186,32 +18332,31 @@ else return NULL; ]| - + `NULL` on success, otherwise + filename="gobject/gtype.h" + line="1397">`NULL` on success, otherwise a newly allocated error string on failure the value to lcopy + filename="gobject/gtype.h" + line="1348">the value to lcopy the number of collected values + filename="gobject/gtype.h" + line="1349">the number of collected values the collected + filename="gobject/gtype.h" + line="1350">the collected locations for storage @@ -17219,8 +18364,8 @@ return NULL; optional flags + filename="gobject/gtype.h" + line="1352">optional flags @@ -17229,8 +18374,8 @@ return NULL; c:type="GTypeValuePeekPointerFunc" version="2.78"> If the value contents fit into a pointer, such as objects or strings, + filename="gobject/gtype.h" + line="1236">If the value contents fit into a pointer, such as objects or strings, return this pointer, so the caller can peek at the current contents. To extend on our above string example: @@ -17238,60 +18383,58 @@ To extend on our above string example: |[<!-- language="C" --> return value->data[0].v_pointer; ]| - + a pointer to the value contents + filename="gobject/gtype.h" + line="1249">a pointer to the value contents the value to peek + filename="gobject/gtype.h" + line="1238">the value to peek The #GTypeValueTable provides the functions required by the #GValue + filename="gobject/gtype.h" + line="1408">The #GTypeValueTable provides the functions required by the #GValue implementation, to serve as a container for values of a type. - + Function to initialize a GValue + filename="gobject/gtype.h" + line="1410">Function to initialize a GValue Function to free a GValue + filename="gobject/gtype.h" + line="1411">Function to free a GValue Function to copy a GValue + filename="gobject/gtype.h" + line="1412">Function to copy a GValue Function to peek the contents of a GValue if they fit + filename="gobject/gtype.h" + line="1413">Function to peek the contents of a GValue if they fit into a pointer A string format describing how to collect the contents of + filename="gobject/gtype.h" + line="1415">A string format describing how to collect the contents of this value bit-by-bit. Each character in the format represents an argument to be collected, and the characters themselves indicate the type of the argument. Currently supported arguments are: @@ -17307,23 +18450,23 @@ implementation, to serve as a container for values of a type. Function to initialize a GValue from the values + filename="gobject/gtype.h" + line="1427">Function to initialize a GValue from the values collected from variadic arguments Format description of the arguments to collect for @lcopy_value, + filename="gobject/gtype.h" + line="1429">Format description of the arguments to collect for @lcopy_value, analogous to @collect_format. Usually, @lcopy_format string consists only of `'p'`s to provide lcopy_value() with pointers to storage locations. Function to store the contents of a value into the + filename="gobject/gtype.h" + line="1432">Function to store the contents of a value into the locations collected from variadic arguments @@ -17331,50 +18474,231 @@ implementation, to serve as a container for values of a type. c:identifier="g_type_value_table_peek" introspectable="0"> Returns the location of the #GTypeValueTable associated with @type. + filename="gobject/gtype.c" + line="4336">Returns the location of the #GTypeValueTable associated with @type. Note that this function should only be used from source code that implements or has internal knowledge of the implementation of @type. - + location of the #GTypeValueTable associated with @type or + filename="gobject/gtype.c" + line="4346">location of the #GTypeValueTable associated with @type or %NULL if there is no #GTypeValueTable associated with @type a #GType + filename="gobject/gtype.c" + line="4338">a #GType + + + + + + + + + + + + + + + + + + + + + + Collects a variable argument value from a `va_list`. + +We have to implement the varargs collection as a macro, because on some systems +`va_list` variables cannot be passed by reference. + +Note: If you are creating the @value argument just before calling this macro, +you should use the G_VALUE_COLLECT_INIT() variant and pass the uninitialized +#GValue. That variant is faster than G_VALUE_COLLECT(). + + + + a #GValue return location. @value is supposed to be initialized + according to the value type to be collected + + + the va_list variable; it may be evaluated multiple times + + + flags which are passed on to the collect_value() function of + the #GTypeValueTable of @value. + + + a #gchar** variable that will be modified to hold a g_new() + allocated error messages if something fails + + + + + The maximal number of #GTypeCValues which can be collected for a +single #GValue. + + + + + Collects a variable argument value from a `va_list`. + +We have to implement the varargs collection as a macro, because on some +systems `va_list` variables cannot be passed by reference. + + + + a #GValue return location. @value must contain only 0 bytes. + + + the #GType to use for @value. + + + the va_list variable; it may be evaluated multiple times + + + flags which are passed on to the collect_value() function of + the #GTypeValueTable of @value. + + + a #gchar** variable that will be modified to hold a g_new() + allocated error messages if something fails + + + + + A variant of G_VALUE_COLLECT_INIT() that provides the #GTypeValueTable +to the caller. + + + + a #GValue return location. @value must contain only 0 bytes. + + + a #GTypeValueTable pointer that will be set to the value table + for @_value_type + + + the #GType to use for @value. + + + the va_list variable; it may be evaluated multiple times + + + flags which are passed on to the collect_value() function of + the #GTypeValueTable of @value. + + + a #gchar** variable that will be modified to hold a g_new() + allocated error messages if something fails + + + + + Skip an argument of type @_value_type from @var_args. + + + + the #GType of the value to skip + + + the va_list variable; it may be evaluated multiple times + + + Checks if @value holds (or contains) a value of @type. This macro will also check for @value != %NULL and issue a warning if the check fails. - + A #GValue structure. A #GType value. @@ -17383,14 +18707,13 @@ warning if the check fails. c:identifier="G_VALUE_HOLDS_BOOLEAN" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_BOOLEAN. - + a valid #GValue structure @@ -17399,15 +18722,14 @@ warning if the check fails. c:identifier="G_VALUE_HOLDS_BOXED" introspectable="0"> Checks whether the given #GValue can hold values derived from type %G_TYPE_BOXED. - + a valid #GValue structure @@ -17416,14 +18738,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_CHAR" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_CHAR. - + a valid #GValue structure @@ -17432,14 +18753,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_DOUBLE" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_DOUBLE. - + a valid #GValue structure @@ -17448,14 +18768,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_ENUM" introspectable="0"> Checks whether the given #GValue can hold values derived from type %G_TYPE_ENUM. - + a valid #GValue structure @@ -17464,14 +18783,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_FLAGS" introspectable="0"> Checks whether the given #GValue can hold values derived from type %G_TYPE_FLAGS. - + a valid #GValue structure @@ -17480,14 +18798,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_FLOAT" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_FLOAT. - + a valid #GValue structure @@ -17497,14 +18814,13 @@ from type %G_TYPE_BOXED. version="2.12" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_GTYPE. - + a valid #GValue structure @@ -17513,14 +18829,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_INT" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_INT. - + a valid #GValue structure @@ -17529,14 +18844,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_INT64" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_INT64. - + a valid #GValue structure @@ -17545,14 +18859,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_LONG" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_LONG. - + a valid #GValue structure @@ -17561,14 +18874,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_OBJECT" introspectable="0"> Checks whether the given #GValue can hold values derived from type %G_TYPE_OBJECT. - + a valid #GValue structure @@ -17577,14 +18889,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_PARAM" introspectable="0"> Checks whether the given #GValue can hold values derived from type %G_TYPE_PARAM. - + a valid #GValue structure @@ -17593,14 +18904,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_POINTER" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_POINTER. - + a valid #GValue structure @@ -17609,14 +18919,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_STRING" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_STRING. - + a valid #GValue structure @@ -17625,14 +18934,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_UCHAR" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_UCHAR. - + a valid #GValue structure @@ -17641,14 +18949,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_UINT" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_UINT. - + a valid #GValue structure @@ -17657,14 +18964,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_UINT64" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_UINT64. - + a valid #GValue structure @@ -17673,14 +18979,13 @@ from type %G_TYPE_BOXED. c:identifier="G_VALUE_HOLDS_ULONG" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_ULONG. - + a valid #GValue structure @@ -17690,14 +18995,13 @@ from type %G_TYPE_BOXED. version="2.26" introspectable="0"> Checks whether the given #GValue can hold values of type %G_TYPE_VARIANT. - + a valid #GValue structure @@ -17707,11 +19011,10 @@ from type %G_TYPE_BOXED. c:type="G_VALUE_INTERNED_STRING" version="2.66"> For string values, indicates that the string contained is canonical and will exist for the duration of the process. See g_value_set_interned_string(). - + version="2.66" introspectable="0"> Checks whether @value contains a string which is canonical. - + a valid #GValue structure + + Stores a value’s value into one or more argument locations from a `va_list`. + +This is the inverse of G_VALUE_COLLECT(). + + + + a #GValue to store into the @var_args; this must be initialized + and set + + + the va_list variable; it may be evaluated multiple times + + + flags which are passed on to the lcopy_value() function of + the #GTypeValueTable of @value. + + + a #gchar** variable that will be modified to hold a g_new() + allocated error message if something fails + + + If passed to G_VALUE_COLLECT(), allocated data won't be copied but used verbatim. This does not affect ref-counted types like objects. This does not affect usage of g_value_copy(), the data will be copied if it is not ref-counted. - + Get the type identifier of @value. - + A #GValue structure. @@ -17764,14 +19099,13 @@ be copied if it is not ref-counted. c:identifier="G_VALUE_TYPE_NAME" introspectable="0"> Gets the type name of @value. - + A #GValue structure. @@ -17780,19 +19114,18 @@ be copied if it is not ref-counted. c:type="GVaClosureMarshal" introspectable="0"> This is the signature of va_list marshaller functions, an optional marshaller that can be used in some situations to avoid marshalling the signal argument into GValues. - + the #GClosure to which the marshaller belongs @@ -17801,7 +19134,7 @@ marshalling the signal argument into GValues. nullable="1" allow-none="1"> a #GValue to store the return value. May be %NULL if the callback of @closure doesn't return a value. @@ -17809,14 +19142,14 @@ marshalling the signal argument into GValues. the instance on which the closure is invoked. va_list of arguments to be passed to the closure. @@ -17825,7 +19158,7 @@ marshalling the signal argument into GValues. nullable="1" allow-none="1"> additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() @@ -17833,13 +19166,13 @@ marshalling the signal argument into GValues. the length of the @param_types array the #GType of each argument from @args. @@ -17854,7 +19187,7 @@ marshalling the signal argument into GValues. glib:get-type="g_value_get_type" c:symbol-prefix="value"> An opaque structure used to hold different types of values. The data within the structure has protected scope: it is accessible only @@ -17865,8 +19198,7 @@ types. #GValue users cannot make any assumptions about how data is stored within the 2 element @data union, and the @g_type member should only be accessed through the G_VALUE_TYPE() macro. - + @@ -17877,24 +19209,23 @@ only be accessed through the G_VALUE_TYPE() macro. Copies the value of @src_value into @dest_value. - + filename="gobject/gvalue.c" + line="110">Copies the value of @src_value into @dest_value. + An initialized #GValue structure. + filename="gobject/gvalue.c" + line="112">An initialized #GValue structure. An initialized #GValue structure of the same type as @src_value. + filename="gobject/gvalue.c" + line="113">An initialized #GValue structure of the same type as @src_value. @@ -17903,48 +19234,46 @@ only be accessed through the G_VALUE_TYPE() macro. c:identifier="g_value_dup_boxed" introspectable="0"> Get the contents of a %G_TYPE_BOXED derived #GValue. Upon getting, + filename="gobject/gboxed.c" + line="429">Get the contents of a %G_TYPE_BOXED derived #GValue. Upon getting, the boxed value is duplicated and needs to be later freed with g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value), return_value); - + boxed contents of @value + filename="gobject/gboxed.c" + line="438">boxed contents of @value a valid #GValue of %G_TYPE_BOXED derived type + filename="gobject/gboxed.c" + line="431">a valid #GValue of %G_TYPE_BOXED derived type Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing + filename="gobject/gobject.c" + line="5119">Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing its reference count. If the contents of the #GValue are %NULL, then %NULL will be returned. - + object content of @value, + filename="gobject/gobject.c" + line="5127">object content of @value, should be unreferenced when no longer needed. a valid #GValue whose type is derived from %G_TYPE_OBJECT + filename="gobject/gobject.c" + line="5121">a valid #GValue whose type is derived from %G_TYPE_OBJECT @@ -17953,44 +19282,42 @@ its reference count. If the contents of the #GValue are %NULL, then c:identifier="g_value_dup_param" introspectable="0"> Get the contents of a %G_TYPE_PARAM #GValue, increasing its + filename="gobject/gparam.c" + line="1603">Get the contents of a %G_TYPE_PARAM #GValue, increasing its reference count. - + #GParamSpec content of @value, should be + filename="gobject/gparam.c" + line="1610">#GParamSpec content of @value, should be unreferenced when no longer needed. a valid #GValue whose type is derived from %G_TYPE_PARAM + filename="gobject/gparam.c" + line="1605">a valid #GValue whose type is derived from %G_TYPE_PARAM Get a copy the contents of a %G_TYPE_STRING #GValue. - + filename="gobject/gvaluetypes.c" + line="1146">Get a copy the contents of a %G_TYPE_STRING #GValue. + a newly allocated copy of the string content of @value + filename="gobject/gvaluetypes.c" + line="1152">a newly allocated copy of the string content of @value a valid #GValue of type %G_TYPE_STRING + filename="gobject/gvaluetypes.c" + line="1148">a valid #GValue of type %G_TYPE_STRING @@ -17999,87 +19326,83 @@ reference count. c:identifier="g_value_dup_variant" version="2.26"> Get the contents of a variant #GValue, increasing its refcount. The returned + filename="gobject/gvaluetypes.c" + line="1354">Get the contents of a variant #GValue, increasing its refcount. The returned #GVariant is never floating. - + variant contents of @value (may be %NULL); + filename="gobject/gvaluetypes.c" + line="1361">variant contents of @value (may be %NULL); should be unreffed using g_variant_unref() when no longer needed a valid #GValue of type %G_TYPE_VARIANT + filename="gobject/gvaluetypes.c" + line="1356">a valid #GValue of type %G_TYPE_VARIANT Determines if @value will fit inside the size of a pointer value. + filename="gobject/gvalue.c" + line="201">Determines if @value will fit inside the size of a pointer value. This is an internal function introduced mainly for C marshallers. - + %TRUE if @value will fit inside a pointer value. + filename="gobject/gvalue.c" + line="208">%TRUE if @value will fit inside a pointer value. An initialized #GValue structure. + filename="gobject/gvalue.c" + line="203">An initialized #GValue structure. Get the contents of a %G_TYPE_BOOLEAN #GValue. - + filename="gobject/gvaluetypes.c" + line="748">Get the contents of a %G_TYPE_BOOLEAN #GValue. + boolean contents of @value + filename="gobject/gvaluetypes.c" + line="754">boolean contents of @value a valid #GValue of type %G_TYPE_BOOLEAN + filename="gobject/gvaluetypes.c" + line="750">a valid #GValue of type %G_TYPE_BOOLEAN Get the contents of a %G_TYPE_BOXED derived #GValue. - + filename="gobject/gboxed.c" + line="412">Get the contents of a %G_TYPE_BOXED derived #GValue. + boxed contents of @value + filename="gobject/gboxed.c" + line="418">boxed contents of @value a valid #GValue of %G_TYPE_BOXED derived type + filename="gobject/gboxed.c" + line="414">a valid #GValue of %G_TYPE_BOXED derived type @@ -18089,382 +19412,364 @@ This is an internal function introduced mainly for C marshallers. deprecated="1" deprecated-version="2.32"> Do not use this function; it is broken on platforms where the %char + filename="gobject/gvaluetypes.c" + line="645">Do not use this function; it is broken on platforms where the %char type is unsigned, such as ARM and PowerPC. See g_value_get_schar(). Get the contents of a %G_TYPE_CHAR #GValue. This function's return type is broken, see g_value_get_schar() - + character contents of @value + filename="gobject/gvaluetypes.c" + line="654">character contents of @value a valid #GValue of type %G_TYPE_CHAR + filename="gobject/gvaluetypes.c" + line="647">a valid #GValue of type %G_TYPE_CHAR Get the contents of a %G_TYPE_DOUBLE #GValue. - + filename="gobject/gvaluetypes.c" + line="1004">Get the contents of a %G_TYPE_DOUBLE #GValue. + double contents of @value + filename="gobject/gvaluetypes.c" + line="1010">double contents of @value a valid #GValue of type %G_TYPE_DOUBLE + filename="gobject/gvaluetypes.c" + line="1006">a valid #GValue of type %G_TYPE_DOUBLE Get the contents of a %G_TYPE_ENUM #GValue. - + filename="gobject/genums.c" + line="679">Get the contents of a %G_TYPE_ENUM #GValue. + enum contents of @value + filename="gobject/genums.c" + line="685">enum contents of @value a valid #GValue whose type is derived from %G_TYPE_ENUM + filename="gobject/genums.c" + line="681">a valid #GValue whose type is derived from %G_TYPE_ENUM Get the contents of a %G_TYPE_FLAGS #GValue. - + filename="gobject/genums.c" + line="711">Get the contents of a %G_TYPE_FLAGS #GValue. + flags contents of @value + filename="gobject/genums.c" + line="717">flags contents of @value a valid #GValue whose type is derived from %G_TYPE_FLAGS + filename="gobject/genums.c" + line="713">a valid #GValue whose type is derived from %G_TYPE_FLAGS Get the contents of a %G_TYPE_FLOAT #GValue. - + filename="gobject/gvaluetypes.c" + line="972">Get the contents of a %G_TYPE_FLOAT #GValue. + float contents of @value + filename="gobject/gvaluetypes.c" + line="978">float contents of @value a valid #GValue of type %G_TYPE_FLOAT + filename="gobject/gvaluetypes.c" + line="974">a valid #GValue of type %G_TYPE_FLOAT Get the contents of a %G_TYPE_GTYPE #GValue. - + filename="gobject/gvaluetypes.c" + line="1250">Get the contents of a %G_TYPE_GTYPE #GValue. + the #GType stored in @value + filename="gobject/gvaluetypes.c" + line="1258">the #GType stored in @value a valid #GValue of type %G_TYPE_GTYPE + filename="gobject/gvaluetypes.c" + line="1252">a valid #GValue of type %G_TYPE_GTYPE Get the contents of a %G_TYPE_INT #GValue. - + filename="gobject/gvaluetypes.c" + line="780">Get the contents of a %G_TYPE_INT #GValue. + integer contents of @value + filename="gobject/gvaluetypes.c" + line="786">integer contents of @value a valid #GValue of type %G_TYPE_INT + filename="gobject/gvaluetypes.c" + line="782">a valid #GValue of type %G_TYPE_INT Get the contents of a %G_TYPE_INT64 #GValue. - + filename="gobject/gvaluetypes.c" + line="892">Get the contents of a %G_TYPE_INT64 #GValue. + 64bit integer contents of @value + filename="gobject/gvaluetypes.c" + line="898">64bit integer contents of @value a valid #GValue of type %G_TYPE_INT64 + filename="gobject/gvaluetypes.c" + line="894">a valid #GValue of type %G_TYPE_INT64 Get the contents of a %G_TYPE_LONG #GValue. - + filename="gobject/gvaluetypes.c" + line="844">Get the contents of a %G_TYPE_LONG #GValue. + long integer contents of @value + filename="gobject/gvaluetypes.c" + line="850">long integer contents of @value a valid #GValue of type %G_TYPE_LONG + filename="gobject/gvaluetypes.c" + line="846">a valid #GValue of type %G_TYPE_LONG Get the contents of a %G_TYPE_OBJECT derived #GValue. - + filename="gobject/gobject.c" + line="5103">Get the contents of a %G_TYPE_OBJECT derived #GValue. + object contents of @value + filename="gobject/gobject.c" + line="5109">object contents of @value a valid #GValue of %G_TYPE_OBJECT derived type + filename="gobject/gobject.c" + line="5105">a valid #GValue of %G_TYPE_OBJECT derived type Get the contents of a %G_TYPE_PARAM #GValue. - + filename="gobject/gparam.c" + line="1587">Get the contents of a %G_TYPE_PARAM #GValue. + #GParamSpec content of @value + filename="gobject/gparam.c" + line="1593">#GParamSpec content of @value a valid #GValue whose type is derived from %G_TYPE_PARAM + filename="gobject/gparam.c" + line="1589">a valid #GValue whose type is derived from %G_TYPE_PARAM Get the contents of a pointer #GValue. - + filename="gobject/gvaluetypes.c" + line="1213">Get the contents of a pointer #GValue. + pointer contents of @value + filename="gobject/gvaluetypes.c" + line="1219">pointer contents of @value a valid #GValue of %G_TYPE_POINTER + filename="gobject/gvaluetypes.c" + line="1215">a valid #GValue of %G_TYPE_POINTER Get the contents of a %G_TYPE_CHAR #GValue. - + filename="gobject/gvaluetypes.c" + line="683">Get the contents of a %G_TYPE_CHAR #GValue. + signed 8 bit integer contents of @value + filename="gobject/gvaluetypes.c" + line="689">signed 8 bit integer contents of @value a valid #GValue of type %G_TYPE_CHAR + filename="gobject/gvaluetypes.c" + line="685">a valid #GValue of type %G_TYPE_CHAR Get the contents of a %G_TYPE_STRING #GValue. - + filename="gobject/gvaluetypes.c" + line="1130">Get the contents of a %G_TYPE_STRING #GValue. + string content of @value + filename="gobject/gvaluetypes.c" + line="1136">string content of @value a valid #GValue of type %G_TYPE_STRING + filename="gobject/gvaluetypes.c" + line="1132">a valid #GValue of type %G_TYPE_STRING Get the contents of a %G_TYPE_UCHAR #GValue. - + filename="gobject/gvaluetypes.c" + line="716">Get the contents of a %G_TYPE_UCHAR #GValue. + unsigned character contents of @value + filename="gobject/gvaluetypes.c" + line="722">unsigned character contents of @value a valid #GValue of type %G_TYPE_UCHAR + filename="gobject/gvaluetypes.c" + line="718">a valid #GValue of type %G_TYPE_UCHAR Get the contents of a %G_TYPE_UINT #GValue. - + filename="gobject/gvaluetypes.c" + line="812">Get the contents of a %G_TYPE_UINT #GValue. + unsigned integer contents of @value + filename="gobject/gvaluetypes.c" + line="818">unsigned integer contents of @value a valid #GValue of type %G_TYPE_UINT + filename="gobject/gvaluetypes.c" + line="814">a valid #GValue of type %G_TYPE_UINT Get the contents of a %G_TYPE_UINT64 #GValue. - + filename="gobject/gvaluetypes.c" + line="940">Get the contents of a %G_TYPE_UINT64 #GValue. + unsigned 64bit integer contents of @value + filename="gobject/gvaluetypes.c" + line="946">unsigned 64bit integer contents of @value a valid #GValue of type %G_TYPE_UINT64 + filename="gobject/gvaluetypes.c" + line="942">a valid #GValue of type %G_TYPE_UINT64 Get the contents of a %G_TYPE_ULONG #GValue. - + filename="gobject/gvaluetypes.c" + line="876">Get the contents of a %G_TYPE_ULONG #GValue. + unsigned long integer contents of @value + filename="gobject/gvaluetypes.c" + line="882">unsigned long integer contents of @value a valid #GValue of type %G_TYPE_ULONG + filename="gobject/gvaluetypes.c" + line="878">a valid #GValue of type %G_TYPE_ULONG @@ -18473,48 +19778,46 @@ Get the contents of a %G_TYPE_CHAR #GValue. c:identifier="g_value_get_variant" version="2.26"> Get the contents of a variant #GValue. - + filename="gobject/gvaluetypes.c" + line="1336">Get the contents of a variant #GValue. + variant contents of @value (may be %NULL) + filename="gobject/gvaluetypes.c" + line="1342">variant contents of @value (may be %NULL) a valid #GValue of type %G_TYPE_VARIANT + filename="gobject/gvaluetypes.c" + line="1338">a valid #GValue of type %G_TYPE_VARIANT Initializes @value with the default value of @type. - + filename="gobject/gvalue.c" + line="71">Initializes @value with the default value of @type. + the #GValue structure that has been passed in + filename="gobject/gvalue.c" + line="78">the #GValue structure that has been passed in A zero-filled (uninitialized) #GValue structure. + filename="gobject/gvalue.c" + line="73">A zero-filled (uninitialized) #GValue structure. Type the #GValue should hold values of. + filename="gobject/gvalue.c" + line="74">Type the #GValue should hold values of. @@ -18523,117 +19826,112 @@ Get the contents of a %G_TYPE_CHAR #GValue. c:identifier="g_value_init_from_instance" version="2.42"> Initializes and sets @value from an instantiatable type via the + filename="gobject/gvalue.c" + line="305">Initializes and sets @value from an instantiatable type via the value_table's collect_value() function. Note: The @value will be initialised with the exact type of @instance. If you wish to set the @value's type to a different GType (such as a parent class GType), you need to manually call g_value_init() and g_value_set_instance(). - + An uninitialized #GValue structure. + filename="gobject/gvalue.c" + line="307">An uninitialized #GValue structure. the instance + filename="gobject/gvalue.c" + line="308">the instance Returns the value contents as pointer. This function asserts that + filename="gobject/gvalue.c" + line="223">Returns the value contents as pointer. This function asserts that g_value_fits_pointer() returned %TRUE for the passed in value. This is an internal function introduced mainly for C marshallers. - + the value contents as pointer + filename="gobject/gvalue.c" + line="231">the value contents as pointer An initialized #GValue structure + filename="gobject/gvalue.c" + line="225">An initialized #GValue structure Clears the current value in @value and resets it to the default value + filename="gobject/gvalue.c" + line="142">Clears the current value in @value and resets it to the default value (as if the value had just been initialized). - + the #GValue structure that has been passed in + filename="gobject/gvalue.c" + line="149">the #GValue structure that has been passed in An initialized #GValue structure. + filename="gobject/gvalue.c" + line="144">An initialized #GValue structure. Set the contents of a %G_TYPE_BOOLEAN #GValue to @v_boolean. - + filename="gobject/gvaluetypes.c" + line="732">Set the contents of a %G_TYPE_BOOLEAN #GValue to @v_boolean. + a valid #GValue of type %G_TYPE_BOOLEAN + filename="gobject/gvaluetypes.c" + line="734">a valid #GValue of type %G_TYPE_BOOLEAN boolean value to be set + filename="gobject/gvaluetypes.c" + line="735">boolean value to be set Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. - + filename="gobject/gboxed.c" + line="472">Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. + a valid #GValue of %G_TYPE_BOXED derived type + filename="gobject/gboxed.c" + line="474">a valid #GValue of %G_TYPE_BOXED derived type nullable="1" allow-none="1"> boxed value to be set + filename="gobject/gboxed.c" + line="475">boxed value to be set @@ -18652,19 +19950,18 @@ This is an internal function introduced mainly for C marshallers. deprecated="1" deprecated-version="2.4"> This is an internal function introduced mainly for C marshallers. + filename="gobject/gboxed.c" + line="509">This is an internal function introduced mainly for C marshallers. Use g_value_take_boxed() instead. - + a valid #GValue of %G_TYPE_BOXED derived type + filename="gobject/gboxed.c" + line="511">a valid #GValue of %G_TYPE_BOXED derived type nullable="1" allow-none="1"> duplicated unowned boxed value to be set + filename="gobject/gboxed.c" + line="512">duplicated unowned boxed value to be set @@ -18683,164 +19980,157 @@ This is an internal function introduced mainly for C marshallers. deprecated="1" deprecated-version="2.32"> Set the contents of a %G_TYPE_CHAR #GValue to @v_char. + filename="gobject/gvaluetypes.c" + line="628">Set the contents of a %G_TYPE_CHAR #GValue to @v_char. This function's input type is broken, see g_value_set_schar() - + a valid #GValue of type %G_TYPE_CHAR + filename="gobject/gvaluetypes.c" + line="630">a valid #GValue of type %G_TYPE_CHAR character value to be set + filename="gobject/gvaluetypes.c" + line="631">character value to be set Set the contents of a %G_TYPE_DOUBLE #GValue to @v_double. - + filename="gobject/gvaluetypes.c" + line="988">Set the contents of a %G_TYPE_DOUBLE #GValue to @v_double. + a valid #GValue of type %G_TYPE_DOUBLE + filename="gobject/gvaluetypes.c" + line="990">a valid #GValue of type %G_TYPE_DOUBLE double value to be set + filename="gobject/gvaluetypes.c" + line="991">double value to be set Set the contents of a %G_TYPE_ENUM #GValue to @v_enum. - + filename="gobject/genums.c" + line="663">Set the contents of a %G_TYPE_ENUM #GValue to @v_enum. + a valid #GValue whose type is derived from %G_TYPE_ENUM + filename="gobject/genums.c" + line="665">a valid #GValue whose type is derived from %G_TYPE_ENUM enum value to be set + filename="gobject/genums.c" + line="666">enum value to be set Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags. - + filename="gobject/genums.c" + line="695">Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags. + a valid #GValue whose type is derived from %G_TYPE_FLAGS + filename="gobject/genums.c" + line="697">a valid #GValue whose type is derived from %G_TYPE_FLAGS flags value to be set + filename="gobject/genums.c" + line="698">flags value to be set Set the contents of a %G_TYPE_FLOAT #GValue to @v_float. - + filename="gobject/gvaluetypes.c" + line="956">Set the contents of a %G_TYPE_FLOAT #GValue to @v_float. + a valid #GValue of type %G_TYPE_FLOAT + filename="gobject/gvaluetypes.c" + line="958">a valid #GValue of type %G_TYPE_FLOAT float value to be set + filename="gobject/gvaluetypes.c" + line="959">float value to be set Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype. - + filename="gobject/gvaluetypes.c" + line="1231">Set the contents of a %G_TYPE_GTYPE #GValue to @v_gtype. + a valid #GValue of type %G_TYPE_GTYPE + filename="gobject/gvaluetypes.c" + line="1233">a valid #GValue of type %G_TYPE_GTYPE #GType to be set + filename="gobject/gvaluetypes.c" + line="1234">#GType to be set Sets @value from an instantiatable type via the + filename="gobject/gvalue.c" + line="252">Sets @value from an instantiatable type via the value_table's collect_value() function. - + An initialized #GValue structure. + filename="gobject/gvalue.c" + line="254">An initialized #GValue structure. nullable="1" allow-none="1"> the instance + filename="gobject/gvalue.c" + line="255">the instance Set the contents of a %G_TYPE_INT #GValue to @v_int. - + filename="gobject/gvaluetypes.c" + line="764">Set the contents of a %G_TYPE_INT #GValue to @v_int. + a valid #GValue of type %G_TYPE_INT + filename="gobject/gvaluetypes.c" + line="766">a valid #GValue of type %G_TYPE_INT integer value to be set + filename="gobject/gvaluetypes.c" + line="767">integer value to be set Set the contents of a %G_TYPE_INT64 #GValue to @v_int64. - + filename="gobject/gvaluetypes.c" + line="909">Set the contents of a %G_TYPE_INT64 #GValue to @v_int64. + a valid #GValue of type %G_TYPE_INT64 + filename="gobject/gvaluetypes.c" + line="911">a valid #GValue of type %G_TYPE_INT64 64bit integer value to be set + filename="gobject/gvaluetypes.c" + line="912">64bit integer value to be set @@ -18906,20 +20194,19 @@ value_table's collect_value() function. c:identifier="g_value_set_interned_string" version="2.66"> Set the contents of a %G_TYPE_STRING #GValue to @v_string. The string is + filename="gobject/gvaluetypes.c" + line="1069">Set the contents of a %G_TYPE_STRING #GValue to @v_string. The string is assumed to be static and interned (canonical, for example from g_intern_string()), and is thus not duplicated when setting the #GValue. - + a valid #GValue of type %G_TYPE_STRING + filename="gobject/gvaluetypes.c" + line="1071">a valid #GValue of type %G_TYPE_STRING nullable="1" allow-none="1"> static string to be set + filename="gobject/gvaluetypes.c" + line="1072">static string to be set Set the contents of a %G_TYPE_LONG #GValue to @v_long. - + filename="gobject/gvaluetypes.c" + line="828">Set the contents of a %G_TYPE_LONG #GValue to @v_long. + a valid #GValue of type %G_TYPE_LONG + filename="gobject/gvaluetypes.c" + line="830">a valid #GValue of type %G_TYPE_LONG long integer value to be set + filename="gobject/gvaluetypes.c" + line="831">long integer value to be set Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object. + filename="gobject/gobject.c" + line="5014">Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object. g_value_set_object() increases the reference count of @v_object (the #GValue holds a reference to @v_object). If you do not wish @@ -18971,16 +20257,15 @@ need it), use g_value_take_object() instead. It is important that your #GValue holds a reference to @v_object (either its own, or one it has taken) to ensure that the object won't be destroyed while the #GValue still exists). - + a valid #GValue of %G_TYPE_OBJECT derived type + filename="gobject/gobject.c" + line="5016">a valid #GValue of %G_TYPE_OBJECT derived type nullable="1" allow-none="1"> object value to be set + filename="gobject/gobject.c" + line="5017">object value to be set @@ -19000,19 +20285,18 @@ the #GValue still exists). deprecated="1" deprecated-version="2.4"> This is an internal function introduced mainly for C marshallers. + filename="gobject/gobject.c" + line="5055">This is an internal function introduced mainly for C marshallers. Use g_value_take_object() instead. - + a valid #GValue of %G_TYPE_OBJECT derived type + filename="gobject/gobject.c" + line="5057">a valid #GValue of %G_TYPE_OBJECT derived type nullable="1" allow-none="1"> object value to be set + filename="gobject/gobject.c" + line="5058">object value to be set Set the contents of a %G_TYPE_PARAM #GValue to @param. - + filename="gobject/gparam.c" + line="1525">Set the contents of a %G_TYPE_PARAM #GValue to @param. + a valid #GValue of type %G_TYPE_PARAM + filename="gobject/gparam.c" + line="1527">a valid #GValue of type %G_TYPE_PARAM nullable="1" allow-none="1"> the #GParamSpec to be set + filename="gobject/gparam.c" + line="1528">the #GParamSpec to be set @@ -19059,19 +20342,18 @@ the #GValue still exists). deprecated="1" deprecated-version="2.4"> This is an internal function introduced mainly for C marshallers. + filename="gobject/gparam.c" + line="1547">This is an internal function introduced mainly for C marshallers. Use g_value_take_param() instead. - + a valid #GValue of type %G_TYPE_PARAM + filename="gobject/gparam.c" + line="1549">a valid #GValue of type %G_TYPE_PARAM nullable="1" allow-none="1"> the #GParamSpec to be set + filename="gobject/gparam.c" + line="1550">the #GParamSpec to be set Set the contents of a pointer #GValue to @v_pointer. - + filename="gobject/gvaluetypes.c" + line="1197">Set the contents of a pointer #GValue to @v_pointer. + a valid #GValue of %G_TYPE_POINTER + filename="gobject/gvaluetypes.c" + line="1199">a valid #GValue of %G_TYPE_POINTER nullable="1" allow-none="1"> pointer value to be set + filename="gobject/gvaluetypes.c" + line="1200">pointer value to be set Set the contents of a %G_TYPE_CHAR #GValue to @v_char. - + filename="gobject/gvaluetypes.c" + line="665">Set the contents of a %G_TYPE_CHAR #GValue to @v_char. + a valid #GValue of type %G_TYPE_CHAR + filename="gobject/gvaluetypes.c" + line="667">a valid #GValue of type %G_TYPE_CHAR signed 8 bit integer to be set + filename="gobject/gvaluetypes.c" + line="668">signed 8 bit integer to be set Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. + filename="gobject/gboxed.c" + line="489">Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed. The boxed value is assumed to be static, and is thus not duplicated when setting the #GValue. - + a valid #GValue of %G_TYPE_BOXED derived type + filename="gobject/gboxed.c" + line="491">a valid #GValue of %G_TYPE_BOXED derived type nullable="1" allow-none="1"> static boxed value to be set + filename="gobject/gboxed.c" + line="492">static boxed value to be set @@ -19169,23 +20448,22 @@ when setting the #GValue. Set the contents of a %G_TYPE_STRING #GValue to @v_string. + filename="gobject/gvaluetypes.c" + line="1045">Set the contents of a %G_TYPE_STRING #GValue to @v_string. The string is assumed to be static, and is thus not duplicated when setting the #GValue. If the the string is a canonical string, using g_value_set_interned_string() is more appropriate. - + a valid #GValue of type %G_TYPE_STRING + filename="gobject/gvaluetypes.c" + line="1047">a valid #GValue of type %G_TYPE_STRING nullable="1" allow-none="1"> static string to be set + filename="gobject/gvaluetypes.c" + line="1048">static string to be set Set the contents of a %G_TYPE_STRING #GValue to a copy of @v_string. - + filename="gobject/gvaluetypes.c" + line="1020">Set the contents of a %G_TYPE_STRING #GValue to a copy of @v_string. + a valid #GValue of type %G_TYPE_STRING + filename="gobject/gvaluetypes.c" + line="1022">a valid #GValue of type %G_TYPE_STRING nullable="1" allow-none="1"> caller-owned string to be duplicated for the #GValue + filename="gobject/gvaluetypes.c" + line="1023">caller-owned string to be duplicated for the #GValue @@ -19231,19 +20508,18 @@ is more appropriate. deprecated="1" deprecated-version="2.4"> This is an internal function introduced mainly for C marshallers. + filename="gobject/gvaluetypes.c" + line="1092">This is an internal function introduced mainly for C marshallers. Use g_value_take_string() instead. - + a valid #GValue of type %G_TYPE_STRING + filename="gobject/gvaluetypes.c" + line="1094">a valid #GValue of type %G_TYPE_STRING nullable="1" allow-none="1"> duplicated unowned string to be set + filename="gobject/gvaluetypes.c" + line="1095">duplicated unowned string to be set Set the contents of a %G_TYPE_UCHAR #GValue to @v_uchar. - + filename="gobject/gvaluetypes.c" + line="700">Set the contents of a %G_TYPE_UCHAR #GValue to @v_uchar. + a valid #GValue of type %G_TYPE_UCHAR + filename="gobject/gvaluetypes.c" + line="702">a valid #GValue of type %G_TYPE_UCHAR unsigned character value to be set + filename="gobject/gvaluetypes.c" + line="703">unsigned character value to be set Set the contents of a %G_TYPE_UINT #GValue to @v_uint. - + filename="gobject/gvaluetypes.c" + line="796">Set the contents of a %G_TYPE_UINT #GValue to @v_uint. + a valid #GValue of type %G_TYPE_UINT + filename="gobject/gvaluetypes.c" + line="798">a valid #GValue of type %G_TYPE_UINT unsigned integer value to be set + filename="gobject/gvaluetypes.c" + line="799">unsigned integer value to be set Set the contents of a %G_TYPE_UINT64 #GValue to @v_uint64. - + filename="gobject/gvaluetypes.c" + line="924">Set the contents of a %G_TYPE_UINT64 #GValue to @v_uint64. + a valid #GValue of type %G_TYPE_UINT64 + filename="gobject/gvaluetypes.c" + line="926">a valid #GValue of type %G_TYPE_UINT64 unsigned 64bit integer value to be set + filename="gobject/gvaluetypes.c" + line="927">unsigned 64bit integer value to be set Set the contents of a %G_TYPE_ULONG #GValue to @v_ulong. - + filename="gobject/gvaluetypes.c" + line="860">Set the contents of a %G_TYPE_ULONG #GValue to @v_ulong. + a valid #GValue of type %G_TYPE_ULONG + filename="gobject/gvaluetypes.c" + line="862">a valid #GValue of type %G_TYPE_ULONG unsigned long integer value to be set + filename="gobject/gvaluetypes.c" + line="863">unsigned long integer value to be set @@ -19357,19 +20629,18 @@ is more appropriate. c:identifier="g_value_set_variant" version="2.26"> Set the contents of a variant #GValue to @variant. + filename="gobject/gvaluetypes.c" + line="1268">Set the contents of a variant #GValue to @variant. If the variant is floating, it is consumed. - + a valid #GValue of type %G_TYPE_VARIANT + filename="gobject/gvaluetypes.c" + line="1270">a valid #GValue of type %G_TYPE_VARIANT nullable="1" allow-none="1"> a #GVariant, or %NULL + filename="gobject/gvaluetypes.c" + line="1271">a #GVariant, or %NULL + + Steal ownership on contents of a %G_TYPE_STRING #GValue. +As a result of this operation the value's contents will be reset to %NULL. + +The purpose of this call is to provide a way to avoid an extra copy +when some object have been serialized into string through #GValue API. + +NOTE: for safety and compatibility purposes, if #GValue contains +static string, or an interned one, this function will return a copy +of the string. Otherwise the transfer notation would be ambiguous. + + + string content of @value; + Should be freed with g_free() when no longer needed. + + + + + a valid #GValue of type %G_TYPE_STRING + + + + Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed + filename="gobject/gboxed.c" + line="525">Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed and takes over the ownership of the caller’s reference to @v_boxed; the caller doesn’t have to unref it any more. - + a valid #GValue of %G_TYPE_BOXED derived type + filename="gobject/gboxed.c" + line="527">a valid #GValue of %G_TYPE_BOXED derived type nullable="1" allow-none="1"> duplicated unowned boxed value to be set + filename="gobject/gboxed.c" + line="528">duplicated unowned boxed value to be set @@ -19419,24 +20720,23 @@ the caller doesn’t have to unref it any more. version="2.4" introspectable="0"> Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object + filename="gobject/gobject.c" + line="5071">Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object and takes over the ownership of the caller’s reference to @v_object; the caller doesn’t have to unref it any more (i.e. the reference count of the object is not increased). If you want the #GValue to hold its own reference to @v_object, use g_value_set_object() instead. - + a valid #GValue of %G_TYPE_OBJECT derived type + filename="gobject/gobject.c" + line="5073">a valid #GValue of %G_TYPE_OBJECT derived type nullable="1" allow-none="1"> object value to be set + filename="gobject/gobject.c" + line="5074">object value to be set @@ -19455,20 +20755,19 @@ g_value_set_object() instead. version="2.4" introspectable="0"> Sets the contents of a %G_TYPE_PARAM #GValue to @param and takes + filename="gobject/gparam.c" + line="1563">Sets the contents of a %G_TYPE_PARAM #GValue to @param and takes over the ownership of the caller’s reference to @param; the caller doesn’t have to unref it any more. - + a valid #GValue of type %G_TYPE_PARAM + filename="gobject/gparam.c" + line="1565">a valid #GValue of type %G_TYPE_PARAM nullable="1" allow-none="1"> the #GParamSpec to be set + filename="gobject/gparam.c" + line="1566">the #GParamSpec to be set @@ -19486,18 +20785,17 @@ doesn’t have to unref it any more. c:identifier="g_value_take_string" version="2.4"> Sets the contents of a %G_TYPE_STRING #GValue to @v_string. - + filename="gobject/gvaluetypes.c" + line="1108">Sets the contents of a %G_TYPE_STRING #GValue to @v_string. + a valid #GValue of type %G_TYPE_STRING + filename="gobject/gvaluetypes.c" + line="1110">a valid #GValue of type %G_TYPE_STRING nullable="1" allow-none="1"> string to take ownership of + filename="gobject/gvaluetypes.c" + line="1111">string to take ownership of @@ -19515,8 +20813,8 @@ doesn’t have to unref it any more. c:identifier="g_value_take_variant" version="2.26"> Set the contents of a variant #GValue to @variant, and takes over + filename="gobject/gvaluetypes.c" + line="1297">Set the contents of a variant #GValue to @variant, and takes over the ownership of the caller's reference to @variant; the caller doesn't have to unref it any more (i.e. the reference count of the variant is not increased). @@ -19528,16 +20826,15 @@ If you want the #GValue to hold its own reference to @variant, use g_value_set_variant() instead. This is an internal function introduced mainly for C marshallers. - + a valid #GValue of type %G_TYPE_VARIANT + filename="gobject/gvaluetypes.c" + line="1299">a valid #GValue of type %G_TYPE_VARIANT nullable="1" allow-none="1"> a #GVariant, or %NULL + filename="gobject/gvaluetypes.c" + line="1300">a #GVariant, or %NULL Tries to cast the contents of @src_value into a type appropriate + filename="gobject/gvalue.c" + line="513">Tries to cast the contents of @src_value into a type appropriate to store in @dest_value, e.g. to transform a %G_TYPE_INT value into a %G_TYPE_FLOAT value. Performing transformations between value types might incur precision lossage. Especially transformations into strings might reveal seemingly arbitrary results and shouldn't be relied upon for production code (such as rcfile value or object property serialization). - + Whether a transformation rule was found and could be applied. + filename="gobject/gvalue.c" + line="526">Whether a transformation rule was found and could be applied. Upon failing transformations, @dest_value is left untouched. Source value. + filename="gobject/gvalue.c" + line="515">Source value. Target value. + filename="gobject/gvalue.c" + line="516">Target value. Clears the current value in @value (if any) and "unsets" the type, + filename="gobject/gvalue.c" + line="174">Clears the current value in @value (if any) and "unsets" the type, this releases all resources associated with this GValue. An unset value is the same as an uninitialized (zero-filled) #GValue structure. - + An initialized #GValue structure. + filename="gobject/gvalue.c" + line="176">An initialized #GValue structure. @@ -19610,32 +20905,31 @@ structure. c:identifier="g_value_register_transform_func" introspectable="0"> Registers a value transformation function for use in g_value_transform(). + filename="gobject/gvalue.c" + line="426">Registers a value transformation function for use in g_value_transform(). A previously registered transformation function for @src_type and @dest_type will be replaced. - + Source type. + filename="gobject/gvalue.c" + line="428">Source type. Target type. + filename="gobject/gvalue.c" + line="429">Target type. a function which transforms values of type @src_type + filename="gobject/gvalue.c" + line="430">a function which transforms values of type @src_type into value of type @dest_type @@ -19643,28 +20937,27 @@ will be replaced. Returns whether a #GValue of type @src_type can be copied into + filename="gobject/gvalue.c" + line="488">Returns whether a #GValue of type @src_type can be copied into a #GValue of type @dest_type. - + %TRUE if g_value_copy() is possible with @src_type and @dest_type. + filename="gobject/gvalue.c" + line="496">%TRUE if g_value_copy() is possible with @src_type and @dest_type. source type to be copied. + filename="gobject/gvalue.c" + line="490">source type to be copied. destination type for copying. + filename="gobject/gvalue.c" + line="491">destination type for copying. @@ -19672,30 +20965,29 @@ a #GValue of type @dest_type. Check whether g_value_transform() is able to transform values + filename="gobject/gvalue.c" + line="465">Check whether g_value_transform() is able to transform values of type @src_type into values of type @dest_type. Note that for the types to be transformable, they must be compatible or a transformation function must be registered. - + %TRUE if the transformation is possible, %FALSE otherwise. + filename="gobject/gvalue.c" + line="475">%TRUE if the transformation is possible, %FALSE otherwise. Source type. + filename="gobject/gvalue.c" + line="467">Source type. Target type. + filename="gobject/gvalue.c" + line="468">Target type. @@ -19703,24 +20995,49 @@ transformation function must be registered. A #GValueArray contains an array of #GValue elements. - + filename="gobject/gvaluearray.c" + line="32">A `GValueArray` is a container structure to hold an array of generic values. + +The prime purpose of a `GValueArray` is for it to be used as an +object property that holds an array of values. A `GValueArray` wraps +an array of `GValue` elements in order for it to be used as a boxed +type through `G_TYPE_VALUE_ARRAY`. + +`GValueArray` is deprecated in favour of `GArray` since GLib 2.32. +It is possible to create a `GArray` that behaves like a `GValueArray` +by using the size of `GValue` as the element size, and by setting +[method@GObject.Value.unset] as the clear function using +[func@GLib.Array.set_clear_func], for instance, the following code: + +```c + GValueArray *array = g_value_array_new (10); +``` + +can be replaced by: + +```c + GArray *array = g_array_sized_new (FALSE, TRUE, sizeof (GValue), 10); + g_array_set_clear_func (array, (GDestroyNotify) g_value_unset); +``` + Use `GArray` instead, if possible for the given use case, + as described above. + number of values contained in the array + filename="gobject/gvaluearray.c" + line="34">number of values contained in the array array of values + filename="gobject/gvaluearray.c" + line="35">array of values @@ -19731,24 +21048,23 @@ transformation function must be registered. deprecated="1" deprecated-version="2.32"> Allocate and initialize a new #GValueArray, optionally preserve space + filename="gobject/gvaluearray.c" + line="111">Allocate and initialize a new #GValueArray, optionally preserve space for @n_prealloced elements. New arrays always contain 0 elements, regardless of the value of @n_prealloced. Use #GArray and g_array_sized_new() instead. - + a newly allocated #GValueArray with 0 values + filename="gobject/gvaluearray.c" + line="119">a newly allocated #GValueArray with 0 values number of values to preallocate space for + filename="gobject/gvaluearray.c" + line="113">number of values to preallocate space for @@ -19758,23 +21074,22 @@ regardless of the value of @n_prealloced. deprecated="1" deprecated-version="2.32"> Insert a copy of @value as last element of @value_array. If @value is + filename="gobject/gvaluearray.c" + line="222">Insert a copy of @value as last element of @value_array. If @value is %NULL, an uninitialized value is appended. Use #GArray and g_array_append_val() instead. - + the #GValueArray passed in as @value_array + filename="gobject/gvaluearray.c" + line="230">the #GValueArray passed in as @value_array #GValueArray to add an element to + filename="gobject/gvaluearray.c" + line="224">#GValueArray to add an element to nullable="1" allow-none="1"> #GValue to copy into #GValueArray, or %NULL + filename="gobject/gvaluearray.c" + line="225">#GValue to copy into #GValueArray, or %NULL @@ -19793,23 +21108,22 @@ regardless of the value of @n_prealloced. deprecated="1" deprecated-version="2.32"> Construct an exact copy of a #GValueArray by duplicating all its + filename="gobject/gvaluearray.c" + line="163">Construct an exact copy of a #GValueArray by duplicating all its contents. Use #GArray and g_array_ref() instead. - + Newly allocated copy of #GValueArray + filename="gobject/gvaluearray.c" + line="170">Newly allocated copy of #GValueArray #GValueArray to copy + filename="gobject/gvaluearray.c" + line="165">#GValueArray to copy @@ -19820,19 +21134,18 @@ contents. deprecated="1" deprecated-version="2.32"> Free a #GValueArray including its contents. + filename="gobject/gvaluearray.c" + line="137">Free a #GValueArray including its contents. Use #GArray and g_array_unref() instead. - + #GValueArray to free + filename="gobject/gvaluearray.c" + line="139">#GValueArray to free @@ -19842,28 +21155,27 @@ contents. deprecated="1" deprecated-version="2.32"> Return a pointer to the value at @index_ containd in @value_array. + filename="gobject/gvaluearray.c" + line="69">Return a pointer to the value at @index_ containd in @value_array. Use g_array_index() instead. - + pointer to a value at @index_ in @value_array + filename="gobject/gvaluearray.c" + line="76">pointer to a value at @index_ in @value_array #GValueArray to get a value from + filename="gobject/gvaluearray.c" + line="71">#GValueArray to get a value from index of the value of interest + filename="gobject/gvaluearray.c" + line="72">index of the value of interest @@ -19873,29 +21185,28 @@ contents. deprecated="1" deprecated-version="2.32"> Insert a copy of @value at specified position into @value_array. If @value + filename="gobject/gvaluearray.c" + line="245">Insert a copy of @value at specified position into @value_array. If @value is %NULL, an uninitialized value is inserted. Use #GArray and g_array_insert_val() instead. - + the #GValueArray passed in as @value_array + filename="gobject/gvaluearray.c" + line="254">the #GValueArray passed in as @value_array #GValueArray to add an element to + filename="gobject/gvaluearray.c" + line="247">#GValueArray to add an element to insertion position, must be <= value_array->;n_values + filename="gobject/gvaluearray.c" + line="248">insertion position, must be <= value_array->;n_values nullable="1" allow-none="1"> #GValue to copy into #GValueArray, or %NULL + filename="gobject/gvaluearray.c" + line="249">#GValue to copy into #GValueArray, or %NULL @@ -19914,23 +21225,22 @@ is %NULL, an uninitialized value is inserted. deprecated="1" deprecated-version="2.32"> Insert a copy of @value as first element of @value_array. If @value is + filename="gobject/gvaluearray.c" + line="198">Insert a copy of @value as first element of @value_array. If @value is %NULL, an uninitialized value is prepended. Use #GArray and g_array_prepend_val() instead. - + the #GValueArray passed in as @value_array + filename="gobject/gvaluearray.c" + line="207">the #GValueArray passed in as @value_array #GValueArray to add an element to + filename="gobject/gvaluearray.c" + line="200">#GValueArray to add an element to nullable="1" allow-none="1"> #GValue to copy into #GValueArray, or %NULL + filename="gobject/gvaluearray.c" + line="201">#GValue to copy into #GValueArray, or %NULL @@ -19949,28 +21259,27 @@ is %NULL, an uninitialized value is inserted. deprecated="1" deprecated-version="2.32"> Remove the value at position @index_ from @value_array. + filename="gobject/gvaluearray.c" + line="282">Remove the value at position @index_ from @value_array. Use #GArray and g_array_remove_index() instead. - + the #GValueArray passed in as @value_array + filename="gobject/gvaluearray.c" + line="290">the #GValueArray passed in as @value_array #GValueArray to remove an element from + filename="gobject/gvaluearray.c" + line="284">#GValueArray to remove an element from position of value to remove, which must be less than + filename="gobject/gvaluearray.c" + line="285">position of value to remove, which must be less than @value_array->n_values @@ -19982,34 +21291,33 @@ is %NULL, an uninitialized value is inserted. deprecated="1" deprecated-version="2.32"> Sort @value_array using @compare_func to compare the elements according to + filename="gobject/gvaluearray.c" + line="313">Sort @value_array using @compare_func to compare the elements according to the semantics of #GCompareFunc. The current implementation uses the same sorting algorithm as standard C qsort() function. Use #GArray and g_array_sort(). - + the #GValueArray passed in as @value_array + filename="gobject/gvaluearray.c" + line="324">the #GValueArray passed in as @value_array #GValueArray to sort + filename="gobject/gvaluearray.c" + line="315">#GValueArray to sort function to compare elements + filename="gobject/gvaluearray.c" + line="316">function to compare elements @@ -20020,26 +21328,25 @@ C qsort() function. deprecated="1" deprecated-version="2.32"> Sort @value_array using @compare_func to compare the elements according + filename="gobject/gvaluearray.c" + line="342">Sort @value_array using @compare_func to compare the elements according to the semantics of #GCompareDataFunc. The current implementation uses the same sorting algorithm as standard C qsort() function. Use #GArray and g_array_sort_with_data(). - + the #GValueArray passed in as @value_array + filename="gobject/gvaluearray.c" + line="354">the #GValueArray passed in as @value_array #GValueArray to sort + filename="gobject/gvaluearray.c" + line="344">#GValueArray to sort scope="call" closure="1"> function to compare elements + filename="gobject/gvaluearray.c" + line="345">function to compare elements nullable="1" allow-none="1"> extra data argument provided for @compare_func + filename="gobject/gvaluearray.c" + line="346">extra data argument provided for @compare_func @@ -20065,34 +21372,48 @@ C qsort() function. The type of value transformation functions which can be registered with g_value_register_transform_func(). @dest_value will be initialized to the correct destination type. - + Source value. Target value. + + + + + + A #GWeakNotify function can be added to an object as a callback that gets triggered when the object is finalized. @@ -20104,8 +21425,7 @@ In particular, this means it’s invalid to call g_object_ref(), g_weak_ref_init(), g_weak_ref_set(), g_object_add_toggle_ref(), g_object_weak_ref(), g_object_add_weak_pointer() or any function which calls them on the object from this callback. - + @@ -20115,13 +21435,13 @@ them on the object from this callback. nullable="1" allow-none="1"> data that was provided when the weak reference was established the object being disposed @@ -20129,8 +21449,8 @@ them on the object from this callback. A structure containing a weak reference to a #GObject. + filename="gobject/gobject.c" + line="5404">A structure containing a weak reference to a #GObject. A `GWeakRef` can either be empty (i.e. point to %NULL), or point to an object for as long as at least one "strong" reference to that object @@ -20154,11 +21474,9 @@ goes back to zero, at which point they too will be invalidated. It is invalid to take a #GWeakRef on an object during #GObjectClass.dispose without first having or creating a strong reference to the object. - + - + @@ -20168,14 +21486,13 @@ without first having or creating a strong reference to the object. version="2.32" introspectable="0"> Frees resources associated with a non-statically-allocated #GWeakRef. + filename="gobject/gobject.c" + line="5665">Frees resources associated with a non-statically-allocated #GWeakRef. After this call, the #GWeakRef is left in an undefined state. You should only call this on a #GWeakRef that previously had g_weak_ref_init() called on it. - + @@ -20185,8 +21502,8 @@ g_weak_ref_init() called on it. caller-allocates="0" transfer-ownership="full"> location of a weak reference, which + filename="gobject/gobject.c" + line="5667">location of a weak reference, which may be empty @@ -20197,8 +21514,8 @@ g_weak_ref_init() called on it. version="2.32" introspectable="0"> If @weak_ref is not empty, atomically acquire a strong + filename="gobject/gobject.c" + line="5687">If @weak_ref is not empty, atomically acquire a strong reference to the object it points to, and return that reference. This function is needed because of the potential race between taking @@ -20207,12 +21524,11 @@ its last reference at the same time in a different thread. The caller should release the resulting reference in the usual way, by using g_object_unref(). - + the object pointed to + filename="gobject/gobject.c" + line="5701">the object pointed to by @weak_ref, or %NULL if it was empty @@ -20222,8 +21538,8 @@ by using g_object_unref(). caller-allocates="0" transfer-ownership="full"> location of a weak reference to a #GObject + filename="gobject/gobject.c" + line="5689">location of a weak reference to a #GObject @@ -20233,8 +21549,8 @@ by using g_object_unref(). version="2.32" introspectable="0"> Initialise a non-statically-allocated #GWeakRef. + filename="gobject/gobject.c" + line="5630">Initialise a non-statically-allocated #GWeakRef. This function also calls g_weak_ref_set() with @object on the freshly-initialised weak reference. @@ -20243,8 +21559,7 @@ This function should always be matched with a call to g_weak_ref_clear(). It is not necessary to use this function for a #GWeakRef in static storage because it will already be properly initialised. Just use g_weak_ref_set() directly. - + @@ -20254,8 +21569,8 @@ properly initialised. Just use g_weak_ref_set() directly. caller-allocates="0" transfer-ownership="full"> uninitialized or empty location for a weak + filename="gobject/gobject.c" + line="5632">uninitialized or empty location for a weak reference @@ -20264,8 +21579,8 @@ properly initialised. Just use g_weak_ref_set() directly. nullable="1" allow-none="1"> a #GObject or %NULL + filename="gobject/gobject.c" + line="5634">a #GObject or %NULL @@ -20275,22 +21590,21 @@ properly initialised. Just use g_weak_ref_set() directly. version="2.32" introspectable="0"> Change the object to which @weak_ref points, or set it to + filename="gobject/gobject.c" + line="5796">Change the object to which @weak_ref points, or set it to %NULL. You must own a strong reference on @object while calling this function. - + location for a weak reference + filename="gobject/gobject.c" + line="5798">location for a weak reference nullable="1" allow-none="1"> a #GObject or %NULL + filename="gobject/gobject.c" + line="5799">a #GObject or %NULL @@ -20339,8 +21653,8 @@ function. version="2.62" introspectable="0"> Assert that @object is non-%NULL, then release one reference to it with + filename="gobject/gobject.h" + line="784">Assert that @object is non-%NULL, then release one reference to it with g_object_unref() and assert that it has been finalized (i.e. that there are no more references). @@ -20348,74 +21662,70 @@ If assertions are disabled via `G_DISABLE_ASSERT`, this macro just calls g_object_unref() without any further checks. This macro should only be used in regression tests. - + an object + filename="gobject/gobject.h" + line="786">an object Provide a copy of a boxed structure @src_boxed which is of type @boxed_type. - + filename="gobject/gboxed.c" + line="317">Provide a copy of a boxed structure @src_boxed which is of type @boxed_type. + The newly created copy of the boxed + filename="gobject/gboxed.c" + line="324">The newly created copy of the boxed structure. The type of @src_boxed. + filename="gobject/gboxed.c" + line="319">The type of @src_boxed. The boxed structure to be copied. + filename="gobject/gboxed.c" + line="320">The boxed structure to be copied. Free the boxed structure @boxed which is of type @boxed_type. - + filename="gobject/gboxed.c" + line="378">Free the boxed structure @boxed which is of type @boxed_type. + The type of @boxed. + filename="gobject/gboxed.c" + line="380">The type of @boxed. The boxed structure to be freed. + filename="gobject/gboxed.c" + line="381">The boxed structure to be freed. + c:identifier="g_boxed_type_register_static"> This function creates a new %G_TYPE_BOXED derived type id for a new + filename="gobject/gboxed.c" + line="256">This function creates a new %G_TYPE_BOXED derived type id for a new boxed type with name @name. Boxed type handling functions have to be provided to copy and free @@ -20424,31 +21734,30 @@ opaque boxed structures of this type. For the general case, it is recommended to use G_DEFINE_BOXED_TYPE() instead of calling g_boxed_type_register_static() directly. The macro will create the appropriate `*_get_type()` function for the boxed type. - + New %G_TYPE_BOXED derived type id for @name. + filename="gobject/gboxed.c" + line="272">New %G_TYPE_BOXED derived type id for @name. Name of the new boxed type. + filename="gobject/gboxed.c" + line="258">Name of the new boxed type. - + Boxed structure copy function. + filename="gobject/gboxed.c" + line="259">Boxed structure copy function. - + Boxed structure free function. + filename="gobject/gboxed.c" + line="260">Boxed structure free function. @@ -20457,40 +21766,39 @@ will create the appropriate `*_get_type()` function for the boxed type. c:identifier="g_cclosure_marshal_BOOLEAN__BOXED_BOXED" moved-to="CClosure.marshal_BOOLEAN__BOXED_BOXED"> A #GClosureMarshal function for use with signals with handlers that + filename="gobject/gmarshal.c" + line="2390">A #GClosureMarshal function for use with signals with handlers that take two boxed pointers as arguments and return a boolean. If you have such a signal, you will probably also need to use an accumulator, such as g_signal_accumulator_true_handled(). - + A #GClosure. + filename="gobject/gmarshal.c" + line="2392">A #GClosure. A #GValue to store the return value. May be %NULL + filename="gobject/gmarshal.c" + line="2393">A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. The length of the @param_values array. + filename="gobject/gmarshal.c" + line="2395">The length of the @param_values array. An array of #GValues holding the arguments + filename="gobject/gmarshal.c" + line="2396">An array of #GValues holding the arguments on which to invoke the callback of closure. @@ -20499,8 +21807,8 @@ accumulator, such as g_signal_accumulator_true_handled(). nullable="1" allow-none="1"> The invocation hint given as the last argument to + filename="gobject/gmarshal.c" + line="2398">The invocation hint given as the last argument to g_closure_invoke(). @@ -20509,8 +21817,8 @@ accumulator, such as g_signal_accumulator_true_handled(). nullable="1" allow-none="1"> Additional data specified when registering the + filename="gobject/gmarshal.c" + line="2400">Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() @@ -20521,38 +21829,40 @@ accumulator, such as g_signal_accumulator_true_handled(). c:identifier="g_cclosure_marshal_BOOLEAN__FLAGS" moved-to="CClosure.marshal_BOOLEAN__FLAGS"> A marshaller for a #GCClosure with a callback of type -`gboolean (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter -denotes a flags type. - + filename="gobject/gmarshal.c" + line="2143">A #GClosureMarshal function for use with signals with handlers that +take a flags type as an argument and return a boolean. If you have +such a signal, you will probably also need to use an accumulator, +such as g_signal_accumulator_true_handled(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="2145">A #GClosure. a #GValue which can store the returned #gboolean + filename="gobject/gmarshal.c" + line="2146">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="2148">The length of the @param_values array. a #GValue array holding instance and arg1 + filename="gobject/gmarshal.c" + line="2149">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="2151">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="2153">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -20580,37 +21892,39 @@ denotes a flags type. c:identifier="g_cclosure_marshal_STRING__OBJECT_POINTER" moved-to="CClosure.marshal_STRING__OBJECT_POINTER"> A marshaller for a #GCClosure with a callback of type -`gchar* (*callback) (gpointer instance, GObject *arg1, gpointer arg2, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="2262">A #GClosureMarshal function for use with signals with handlers that +take a #GObject and a pointer and produce a string. It is highly +unlikely that your signal handler fits this description. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="2264">A #GClosure. a #GValue, which can store the returned string + filename="gobject/gmarshal.c" + line="2265">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 3 + filename="gobject/gmarshal.c" + line="2267">The length of the @param_values array. a #GValue array holding instance, arg1 and arg2 + filename="gobject/gmarshal.c" + line="2268">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="2270">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="2272">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -20638,37 +21954,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__BOOLEAN" moved-to="CClosure.marshal_VOID__BOOLEAN"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gboolean arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="169">A #GClosureMarshal function for use with signals with a single +boolean argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="171">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="172">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="174">The length of the @param_values array. a #GValue array holding the instance and the #gboolean parameter + filename="gobject/gmarshal.c" + line="175">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="177">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="179">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -20696,37 +22015,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__BOXED" moved-to="CClosure.marshal_VOID__BOXED"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, GBoxed *arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1581">A #GClosureMarshal function for use with signals with a single +argument which is any boxed pointer type. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1583">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1584">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1586">The length of the @param_values array. a #GValue array holding the instance and the #GBoxed* parameter + filename="gobject/gmarshal.c" + line="1587">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1589">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1591">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -20754,37 +22076,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__CHAR" moved-to="CClosure.marshal_VOID__CHAR"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gchar arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="277">A #GClosureMarshal function for use with signals with a single +character argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="279">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="280">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="282">The length of the @param_values array. a #GValue array holding the instance and the #gchar parameter + filename="gobject/gmarshal.c" + line="283">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="285">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="287">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -20812,37 +22137,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__DOUBLE" moved-to="CClosure.marshal_VOID__DOUBLE"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gdouble arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1249">A #GClosureMarshal function for use with signals with one +double-precision floating point argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1251">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1252">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1254">The length of the @param_values array. a #GValue array holding the instance and the #gdouble parameter + filename="gobject/gmarshal.c" + line="1255">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1257">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1259">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -20870,37 +22198,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__ENUM" moved-to="CClosure.marshal_VOID__ENUM"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes an enumeration type.. - + filename="gobject/gmarshal.c" + line="925">A #GClosureMarshal function for use with signals with a single +argument with an enumerated type. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="927">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="928">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="930">The length of the @param_values array. a #GValue array holding the instance and the enumeration parameter + filename="gobject/gmarshal.c" + line="931">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="933">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="935">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -20928,37 +22259,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__FLAGS" moved-to="CClosure.marshal_VOID__FLAGS"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gint arg1, gpointer user_data)` where the #gint parameter denotes a flags type. - + filename="gobject/gmarshal.c" + line="1033">A #GClosureMarshal function for use with signals with a single +argument with a flags types. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1035">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1036">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1038">The length of the @param_values array. a #GValue array holding the instance and the flags parameter + filename="gobject/gmarshal.c" + line="1039">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1041">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1043">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -20986,37 +22320,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__FLOAT" moved-to="CClosure.marshal_VOID__FLOAT"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gfloat arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1141">A #GClosureMarshal function for use with signals with one +single-precision floating point argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1143">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1144">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1146">The length of the @param_values array. a #GValue array holding the instance and the #gfloat parameter + filename="gobject/gmarshal.c" + line="1147">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1149">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1151">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21044,37 +22381,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__INT" moved-to="CClosure.marshal_VOID__INT"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gint arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="493">A #GClosureMarshal function for use with signals with a single +integer argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="495">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="496">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="498">The length of the @param_values array. a #GValue array holding the instance and the #gint parameter + filename="gobject/gmarshal.c" + line="499">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="501">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="503">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21102,37 +22442,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__LONG" moved-to="CClosure.marshal_VOID__LONG"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, glong arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="709">A #GClosureMarshal function for use with signals with with a single +long integer argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="711">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="712">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="714">The length of the @param_values array. a #GValue array holding the instance and the #glong parameter + filename="gobject/gmarshal.c" + line="715">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="717">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="719">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21160,37 +22503,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__OBJECT" moved-to="CClosure.marshal_VOID__OBJECT"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, GObject *arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1805">A #GClosureMarshal function for use with signals with a single +#GObject argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1807">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1808">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1810">The length of the @param_values array. a #GValue array holding the instance and the #GObject* parameter + filename="gobject/gmarshal.c" + line="1811">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1813">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1815">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21218,37 +22564,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__PARAM" moved-to="CClosure.marshal_VOID__PARAM"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, GParamSpec *arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1469">A #GClosureMarshal function for use with signals with a single +argument of type #GParamSpec. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1471">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1472">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1474">The length of the @param_values array. a #GValue array holding the instance and the #GParamSpec* parameter + filename="gobject/gmarshal.c" + line="1475">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1477">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1479">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21276,37 +22625,42 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__POINTER" moved-to="CClosure.marshal_VOID__POINTER"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gpointer arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1693">A #GClosureMarshal function for use with signals with a single raw +pointer argument type. + +If it is possible, it is better to use one of the more specific +functions such as g_cclosure_marshal_VOID__OBJECT() or +g_cclosure_marshal_VOID__OBJECT(). + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1695">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1696">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1698">The length of the @param_values array. a #GValue array holding the instance and the #gpointer parameter + filename="gobject/gmarshal.c" + line="1699">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1701">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1703">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21334,37 +22690,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__STRING" moved-to="CClosure.marshal_VOID__STRING"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, const gchar *arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1357">A #GClosureMarshal function for use with signals with a single string +argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1359">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1360">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1362">The length of the @param_values array. a #GValue array holding the instance and the #gchar* parameter + filename="gobject/gmarshal.c" + line="1363">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1365">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1367">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21392,37 +22751,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__UCHAR" moved-to="CClosure.marshal_VOID__UCHAR"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, guchar arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="385">A #GClosureMarshal function for use with signals with a single +unsigned character argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="387">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="388">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="390">The length of the @param_values array. a #GValue array holding the instance and the #guchar parameter + filename="gobject/gmarshal.c" + line="391">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="393">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="395">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21450,37 +22812,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__UINT" moved-to="CClosure.marshal_VOID__UINT"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, guint arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="601">A #GClosureMarshal function for use with signals with with a single +unsigned integer argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="603">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="604">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="606">The length of the @param_values array. a #GValue array holding the instance and the #guint parameter + filename="gobject/gmarshal.c" + line="607">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="609">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="611">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21508,37 +22873,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__UINT_POINTER" moved-to="CClosure.marshal_VOID__UINT_POINTER"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, guint arg1, gpointer arg2, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="2029">A #GClosureMarshal function for use with signals with an unsigned int +and a pointer as arguments. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="2031">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="2032">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 3 + filename="gobject/gmarshal.c" + line="2034">The length of the @param_values array. a #GValue array holding instance, arg1 and arg2 + filename="gobject/gmarshal.c" + line="2035">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="2037">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="2039">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21566,37 +22934,38 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__ULONG" moved-to="CClosure.marshal_VOID__ULONG"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gulong arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="817">A #GClosureMarshal function for use with signals with a single +unsigned long integer argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="819">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="820">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="822">The length of the @param_values array. a #GValue array holding the instance and the #gulong parameter + filename="gobject/gmarshal.c" + line="823">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="825">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="827">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() + moved-to="CClosure.marshal_VOID__VARIANT"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, GVariant *arg1, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="1917">A #GClosureMarshal function for use with signals with a single +#GVariant argument. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="1919">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="1920">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 2 + filename="gobject/gmarshal.c" + line="1922">The length of the @param_values array. a #GValue array holding the instance and the #GVariant* parameter + filename="gobject/gmarshal.c" + line="1923">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="1925">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="1927">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21683,37 +23056,37 @@ denotes a flags type. c:identifier="g_cclosure_marshal_VOID__VOID" moved-to="CClosure.marshal_VOID__VOID"> A marshaller for a #GCClosure with a callback of type -`void (*callback) (gpointer instance, gpointer user_data)`. - + filename="gobject/gmarshal.c" + line="72">A #GClosureMarshal function for use with signals with no arguments. + the #GClosure to which the marshaller belongs + filename="gobject/gmarshal.c" + line="74">A #GClosure. ignored + filename="gobject/gmarshal.c" + line="75">A #GValue to store the return value. May be %NULL + if the callback of closure doesn't return a value. 1 + filename="gobject/gmarshal.c" + line="77">The length of the @param_values array. a #GValue array holding only the instance + filename="gobject/gmarshal.c" + line="78">An array of #GValues holding the arguments + on which to invoke the callback of closure. nullable="1" allow-none="1"> the invocation hint given as the last argument - to g_closure_invoke() + filename="gobject/gmarshal.c" + line="80">The invocation hint given as the last argument to + g_closure_invoke(). nullable="1" allow-none="1"> additional data specified when registering the marshaller + filename="gobject/gmarshal.c" + line="82">Additional data specified when registering the + marshaller, see g_closure_set_marshal() and + g_closure_set_meta_marshal() @@ -21742,41 +23117,40 @@ denotes a flags type. moved-to="CClosure.marshal_generic" version="2.30"> A generic marshaller function implemented via + filename="gobject/gclosure.c" + line="1445">A generic marshaller function implemented via [libffi](http://sourceware.org/libffi/). Normally this function is not passed explicitly to g_signal_new(), but used automatically by GLib when specifying a %NULL marshaller. - + A #GClosure. + filename="gobject/gclosure.c" + line="1447">A #GClosure. A #GValue to store the return value. May be %NULL + filename="gobject/gclosure.c" + line="1448">A #GValue to store the return value. May be %NULL if the callback of closure doesn't return a value. The length of the @param_values array. + filename="gobject/gclosure.c" + line="1450">The length of the @param_values array. An array of #GValues holding the arguments + filename="gobject/gclosure.c" + line="1451">An array of #GValues holding the arguments on which to invoke the callback of closure. @@ -21785,8 +23159,8 @@ but used automatically by GLib when specifying a %NULL marshaller. nullable="1" allow-none="1"> The invocation hint given as the last argument to + filename="gobject/gclosure.c" + line="1453">The invocation hint given as the last argument to g_closure_invoke(). @@ -21795,8 +23169,8 @@ but used automatically by GLib when specifying a %NULL marshaller. nullable="1" allow-none="1"> Additional data specified when registering the + filename="gobject/gclosure.c" + line="1455">Additional data specified when registering the marshaller, see g_closure_set_marshal() and g_closure_set_meta_marshal() @@ -21808,17 +23182,16 @@ but used automatically by GLib when specifying a %NULL marshaller. moved-to="CClosure.new" introspectable="0"> Creates a new closure which invokes @callback_func with @user_data as + filename="gobject/gclosure.c" + line="958">Creates a new closure which invokes @callback_func with @user_data as the last parameter. @destroy_data will be called as a finalize notifier on the #GClosure. - - + + a floating reference to a new #GCClosure + filename="gobject/gclosure.c" + line="969">a floating reference to a new #GCClosure @@ -21828,8 +23201,8 @@ the last parameter. allow-none="1" closure="1"> the function to invoke + filename="gobject/gclosure.c" + line="960">the function to invoke user data to pass to @callback_func + filename="gobject/gclosure.c" + line="961">user data to pass to @callback_func destroy notify to be called when @user_data is no longer used + filename="gobject/gclosure.c" + line="962">destroy notify to be called when @user_data is no longer used @@ -21855,31 +23228,30 @@ the last parameter. moved-to="CClosure.new_object" introspectable="0"> A variant of g_cclosure_new() which uses @object as @user_data and + filename="gobject/gobject.c" + line="5312">A variant of g_cclosure_new() which uses @object as @user_data and calls g_object_watch_closure() on @object and the created closure. This function is useful when you have a callback closely associated with a #GObject, and want the callback to no longer run after the object is is freed. - - + + a new #GCClosure + filename="gobject/gobject.c" + line="5323">a new #GCClosure the function to invoke + filename="gobject/gobject.c" + line="5314">the function to invoke a #GObject pointer to pass to @callback_func + filename="gobject/gobject.c" + line="5315">a #GObject pointer to pass to @callback_func @@ -21889,31 +23261,30 @@ after the object is is freed. moved-to="CClosure.new_object_swap" introspectable="0"> A variant of g_cclosure_new_swap() which uses @object as @user_data + filename="gobject/gobject.c" + line="5341">A variant of g_cclosure_new_swap() which uses @object as @user_data and calls g_object_watch_closure() on @object and the created closure. This function is useful when you have a callback closely associated with a #GObject, and want the callback to no longer run after the object is is freed. - - + + a new #GCClosure + filename="gobject/gobject.c" + line="5352">a new #GCClosure the function to invoke + filename="gobject/gobject.c" + line="5343">the function to invoke a #GObject pointer to pass to @callback_func + filename="gobject/gobject.c" + line="5344">a #GObject pointer to pass to @callback_func @@ -21923,17 +23294,16 @@ after the object is is freed. moved-to="CClosure.new_swap" introspectable="0"> Creates a new closure which invokes @callback_func with @user_data as + filename="gobject/gclosure.c" + line="988">Creates a new closure which invokes @callback_func with @user_data as the first parameter. @destroy_data will be called as a finalize notifier on the #GClosure. - - + + a floating reference to a new #GCClosure + filename="gobject/gclosure.c" + line="999">a floating reference to a new #GCClosure @@ -21943,8 +23313,8 @@ the first parameter. allow-none="1" closure="1"> the function to invoke + filename="gobject/gclosure.c" + line="990">the function to invoke user data to pass to @callback_func + filename="gobject/gclosure.c" + line="991">user data to pass to @callback_func destroy notify to be called when @user_data is no longer used + filename="gobject/gclosure.c" + line="992">destroy notify to be called when @user_data is no longer used @@ -21970,8 +23340,8 @@ the first parameter. version="2.28" introspectable="0"> Clears a reference to a #GObject. + filename="gobject/gobject.c" + line="4503">Clears a reference to a #GObject. @object_ptr must not be %NULL. @@ -21981,16 +23351,15 @@ pointer is set to %NULL. A macro is also included that allows this function to be used without pointer casts. - + a pointer to a #GObject reference + filename="gobject/gobject.c" + line="4505">a pointer to a #GObject reference @@ -21999,8 +23368,8 @@ pointer casts. c:identifier="g_clear_signal_handler" version="2.62"> Disconnects a handler from @instance so it will not be called during + filename="gobject/gsignal.c" + line="4159">Disconnects a handler from @instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to. The @handler_id_ptr is then set to zero, which is never a valid handler ID value (see g_signal_connect()). @@ -22008,22 +23377,21 @@ If the handler ID is 0 then this function does nothing. There is also a macro version of this function so that the code will be inlined. - + A pointer to a handler ID (of type #gulong) of the handler to be disconnected. + filename="gobject/gsignal.c" + line="4161">A pointer to a handler ID (of type #gulong) of the handler to be disconnected. The instance to remove the signal handler from. + filename="gobject/gsignal.c" + line="4162">The instance to remove the signal handler from. This pointer may be %NULL or invalid, if the handler ID is zero. @@ -22034,8 +23402,8 @@ will be inlined. version="2.56" introspectable="0"> Clears a weak reference to a #GObject. + filename="gobject/gobject.h" + line="816">Clears a weak reference to a #GObject. @weak_pointer_location must not be %NULL. @@ -22046,21 +23414,20 @@ and the pointer is set to %NULL. A macro is also included that allows this function to be used without pointer casts. The function itself is static inline, so its address may vary between compilation units. - + The memory address of a pointer + filename="gobject/gobject.h" + line="818">The memory address of a pointer This function is meant to be called from the `complete_type_info` + filename="gobject/genums.c" + line="230">This function is meant to be called from the `complete_type_info` function of a #GTypePlugin implementation, as in the following example: @@ -22080,16 +23447,15 @@ my_enum_complete_type_info (GTypePlugin *plugin, g_enum_complete_type_info (type, info, values); } ]| - + the type identifier of the type being completed + filename="gobject/genums.c" + line="232">the type identifier of the type being completed the #GTypeInfo struct to be filled in + filename="gobject/genums.c" + line="233">the #GTypeInfo struct to be filled in An array of #GEnumValue structs for the possible + filename="gobject/genums.c" + line="234">An array of #GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. @@ -22113,28 +23479,27 @@ my_enum_complete_type_info (GTypePlugin *plugin, Returns the #GEnumValue for a value. - + filename="gobject/genums.c" + line="471">Returns the #GEnumValue for a value. + the #GEnumValue for @value, or %NULL + filename="gobject/genums.c" + line="478">the #GEnumValue for @value, or %NULL if @value is not a member of the enumeration a #GEnumClass + filename="gobject/genums.c" + line="473">a #GEnumClass the value to look up + filename="gobject/genums.c" + line="474">the value to look up @@ -22142,14 +23507,13 @@ my_enum_complete_type_info (GTypePlugin *plugin, Looks up a #GEnumValue by name. - + filename="gobject/genums.c" + line="353">Looks up a #GEnumValue by name. + the #GEnumValue with name @name, + filename="gobject/genums.c" + line="360">the #GEnumValue with name @name, or %NULL if the enumeration doesn't have a member with that name @@ -22157,14 +23521,14 @@ my_enum_complete_type_info (GTypePlugin *plugin, a #GEnumClass + filename="gobject/genums.c" + line="355">a #GEnumClass the name to look up + filename="gobject/genums.c" + line="356">the name to look up @@ -22172,14 +23536,13 @@ my_enum_complete_type_info (GTypePlugin *plugin, Looks up a #GEnumValue by nickname. - + filename="gobject/genums.c" + line="412">Looks up a #GEnumValue by nickname. + the #GEnumValue with nickname @nick, + filename="gobject/genums.c" + line="419">the #GEnumValue with nickname @nick, or %NULL if the enumeration doesn't have a member with that nickname @@ -22187,14 +23550,14 @@ my_enum_complete_type_info (GTypePlugin *plugin, a #GEnumClass + filename="gobject/genums.c" + line="414">a #GEnumClass the nickname to look up + filename="gobject/genums.c" + line="415">the nickname to look up @@ -22202,31 +23565,30 @@ my_enum_complete_type_info (GTypePlugin *plugin, Registers a new static enumeration type with the name @name. + filename="gobject/genums.c" + line="143">Registers a new static enumeration type with the name @name. It is normally more convenient to let [glib-mkenums][glib-mkenums], generate a my_enum_get_type() function from a usual C enumeration definition than to write one yourself using g_enum_register_static(). - + The new type identifier. + filename="gobject/genums.c" + line="157">The new type identifier. A nul-terminated string used as the name of the new type. + filename="gobject/genums.c" + line="145">A nul-terminated string used as the name of the new type. An array of #GEnumValue structs for the possible + filename="gobject/genums.c" + line="146">An array of #GEnumValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. GObject keeps a reference to the data, so it cannot be stack-allocated. @@ -22238,82 +23600,49 @@ definition than to write one yourself using g_enum_register_static(). c:identifier="g_enum_to_string" version="2.54"> Pretty-prints @value in the form of the enum’s name. + filename="gobject/genums.c" + line="536">Pretty-prints @value in the form of the enum’s name. This is intended to be used for debugging purposes. The format of the output may change in the future. - + a newly-allocated text string + filename="gobject/genums.c" + line="546">a newly-allocated text string the type identifier of a #GEnumClass type + filename="gobject/genums.c" + line="538">the type identifier of a #GEnumClass type the value + filename="gobject/genums.c" + line="539">the value - - The GLib type system provides fundamental types for enumeration and -flags types. (Flags types are like enumerations, but allow their -values to be combined by bitwise or). A registered enumeration or -flags type associates a name and a nickname with each allowed -value, and the methods g_enum_get_value_by_name(), -g_enum_get_value_by_nick(), g_flags_get_value_by_name() and -g_flags_get_value_by_nick() can look up values by their name or -nickname. When an enumeration or flags type is registered with the -GLib type system, it can be used as value type for object -properties, using g_param_spec_enum() or g_param_spec_flags(). - -GObject ships with a utility called [glib-mkenums][glib-mkenums], -that can construct suitable type registration functions from C enumeration -definitions. - -Example of how to get a string representation of an enum value: -|[<!-- language="C" --> -GEnumClass *enum_class; -GEnumValue *enum_value; - -enum_class = g_type_class_ref (MAMAN_TYPE_MY_ENUM); -enum_value = g_enum_get_value (enum_class, MAMAN_MY_ENUM_FOO); - -g_print ("Name: %s\n", enum_value->value_name); - -g_type_class_unref (enum_class); -]| - This function is meant to be called from the complete_type_info() + filename="gobject/genums.c" + line="276">This function is meant to be called from the complete_type_info() function of a #GTypePlugin implementation, see the example for g_enum_complete_type_info() above. - + the type identifier of the type being completed + filename="gobject/genums.c" + line="278">the type identifier of the type being completed caller-allocates="0" transfer-ownership="full"> the #GTypeInfo struct to be filled in + filename="gobject/genums.c" + line="279">the #GTypeInfo struct to be filled in An array of #GFlagsValue structs for the possible + filename="gobject/genums.c" + line="280">An array of #GFlagsValue structs for the possible enumeration values. The array is terminated by a struct with all members being 0. @@ -22338,28 +23667,27 @@ g_enum_complete_type_info() above. Returns the first #GFlagsValue which is set in @value. - + filename="gobject/genums.c" + line="499">Returns the first #GFlagsValue which is set in @value. + the first #GFlagsValue which is set in + filename="gobject/genums.c" + line="506">the first #GFlagsValue which is set in @value, or %NULL if none is set a #GFlagsClass + filename="gobject/genums.c" + line="501">a #GFlagsClass the value + filename="gobject/genums.c" + line="502">the value @@ -22367,28 +23695,27 @@ g_enum_complete_type_info() above. Looks up a #GFlagsValue by name. - + filename="gobject/genums.c" + line="383">Looks up a #GFlagsValue by name. + the #GFlagsValue with name @name, + filename="gobject/genums.c" + line="390">the #GFlagsValue with name @name, or %NULL if there is no flag with that name a #GFlagsClass + filename="gobject/genums.c" + line="385">a #GFlagsClass the name to look up + filename="gobject/genums.c" + line="386">the name to look up @@ -22396,28 +23723,27 @@ g_enum_complete_type_info() above. Looks up a #GFlagsValue by nickname. - + filename="gobject/genums.c" + line="442">Looks up a #GFlagsValue by nickname. + the #GFlagsValue with nickname @nick, + filename="gobject/genums.c" + line="449">the #GFlagsValue with nickname @nick, or %NULL if there is no flag with that nickname a #GFlagsClass + filename="gobject/genums.c" + line="444">a #GFlagsClass the nickname to look up + filename="gobject/genums.c" + line="445">the nickname to look up @@ -22425,31 +23751,30 @@ g_enum_complete_type_info() above. Registers a new static flags type with the name @name. + filename="gobject/genums.c" + line="187">Registers a new static flags type with the name @name. It is normally more convenient to let [glib-mkenums][glib-mkenums] generate a my_flags_get_type() function from a usual C enumeration definition than to write one yourself using g_flags_register_static(). - + The new type identifier. + filename="gobject/genums.c" + line="200">The new type identifier. A nul-terminated string used as the name of the new type. + filename="gobject/genums.c" + line="189">A nul-terminated string used as the name of the new type. An array of #GFlagsValue structs for the possible + filename="gobject/genums.c" + line="190">An array of #GFlagsValue structs for the possible flags values. The array is terminated by a struct with all members being 0. GObject keeps a reference to the data, so it cannot be stack-allocated. @@ -22460,344 +23785,62 @@ definition than to write one yourself using g_flags_register_static(). c:identifier="g_flags_to_string" version="2.54"> Pretty-prints @value in the form of the flag names separated by ` | ` and + filename="gobject/genums.c" + line="626">Pretty-prints @value in the form of the flag names separated by ` | ` and sorted. Any extra bits will be shown at the end as a hexadecimal number. This is intended to be used for debugging purposes. The format of the output may change in the future. - + a newly-allocated text string + filename="gobject/genums.c" + line="637">a newly-allocated text string the type identifier of a #GFlagsClass type + filename="gobject/genums.c" + line="628">the type identifier of a #GFlagsClass type the value + filename="gobject/genums.c" + line="629">the value - - #GBoxed is a generic wrapper mechanism for arbitrary C structures. - -The only thing the type system needs to know about the structures is how to -copy them (a #GBoxedCopyFunc) and how to free them (a #GBoxedFreeFunc); -beyond that, they are treated as opaque chunks of memory. - -Boxed types are useful for simple value-holder structures like rectangles or -points. They can also be used for wrapping structures defined in non-#GObject -based libraries. They allow arbitrary structures to be handled in a uniform -way, allowing uniform copying (or referencing) and freeing (or unreferencing) -of them, and uniform representation of the type of the contained structure. -In turn, this allows any type which can be boxed to be set as the data in a -#GValue, which allows for polymorphic handling of a much wider range of data -types, and hence usage of such types as #GObject property values. - -#GBoxed is designed so that reference counted types can be boxed. Use the -type’s ‘ref’ function as the #GBoxedCopyFunc, and its ‘unref’ function as the -#GBoxedFreeFunc. For example, for #GBytes, the #GBoxedCopyFunc is -g_bytes_ref(), and the #GBoxedFreeFunc is g_bytes_unref(). - - - The #GValue structure is basically a variable container that consists -of a type identifier and a specific value of that type. - -The type identifier within a #GValue structure always determines the -type of the associated value. - -To create an undefined #GValue structure, simply create a zero-filled -#GValue structure. To initialize the #GValue, use the g_value_init() -function. A #GValue cannot be used until it is initialized. Before -destruction you must always use g_value_unset() to make sure allocated -memory is freed. - -The basic type operations (such as freeing and copying) are determined -by the #GTypeValueTable associated with the type ID stored in the #GValue. -Other #GValue operations (such as converting values between types) are -provided by this interface. - -The code in the example program below demonstrates #GValue's -features. - -|[<!-- language="C" --> -#include <glib-object.h> - -static void -int2string (const GValue *src_value, - GValue *dest_value) -{ - if (g_value_get_int (src_value) == 42) - g_value_set_static_string (dest_value, "An important number"); - else - g_value_set_static_string (dest_value, "What's that?"); -} - -int -main (int argc, - char *argv[]) -{ - // GValues must be initialized - GValue a = G_VALUE_INIT; - GValue b = G_VALUE_INIT; - const gchar *message; - - // The GValue starts empty - g_assert (!G_VALUE_HOLDS_STRING (&a)); - - // Put a string in it - g_value_init (&a, G_TYPE_STRING); - g_assert (G_VALUE_HOLDS_STRING (&a)); - g_value_set_static_string (&a, "Hello, world!"); - g_printf ("%s\n", g_value_get_string (&a)); - - // Reset it to its pristine state - g_value_unset (&a); - - // It can then be reused for another type - g_value_init (&a, G_TYPE_INT); - g_value_set_int (&a, 42); - - // Attempt to transform it into a GValue of type STRING - g_value_init (&b, G_TYPE_STRING); - - // An INT is transformable to a STRING - g_assert (g_value_type_transformable (G_TYPE_INT, G_TYPE_STRING)); - - g_value_transform (&a, &b); - g_printf ("%s\n", g_value_get_string (&b)); - - // Attempt to transform it again using a custom transform function - g_value_register_transform_func (G_TYPE_INT, G_TYPE_STRING, int2string); - g_value_transform (&a, &b); - g_printf ("%s\n", g_value_get_string (&b)); - return 0; -} -]| - -See also [gobject-Standard-Parameter-and-Value-Types] for more information on -validation of #GValue. - -For letting a #GValue own (and memory manage) arbitrary types or pointers, -they need to become a [boxed type][gboxed]. The example below shows how -the pointer `mystruct` of type `MyStruct` is used as a [boxed type][gboxed]. - -|[<!-- language="C" --> -typedef struct { ... } MyStruct; -G_DEFINE_BOXED_TYPE (MyStruct, my_struct, my_struct_copy, my_struct_free) - -// These two lines normally go in a public header. By GObject convention, -// the naming scheme is NAMESPACE_TYPE_NAME: -#define MY_TYPE_STRUCT (my_struct_get_type ()) -GType my_struct_get_type (void); - -void -foo () -{ - GValue *value = g_new0 (GValue, 1); - g_value_init (value, MY_TYPE_STRUCT); - g_value_set_boxed (value, mystruct); - // [... your code ....] - g_value_unset (value); - g_free (value); -} -]| - - - The GType API is the foundation of the GObject system. It provides the -facilities for registering and managing all fundamental data types, -user-defined object and interface types. - -For type creation and registration purposes, all types fall into one of -two categories: static or dynamic. Static types are never loaded or -unloaded at run-time as dynamic types may be. Static types are created -with g_type_register_static() that gets type specific information passed -in via a #GTypeInfo structure. - -Dynamic types are created with g_type_register_dynamic() which takes a -#GTypePlugin structure instead. The remaining type information (the -#GTypeInfo structure) is retrieved during runtime through #GTypePlugin -and the g_type_plugin_*() API. - -These registration functions are usually called only once from a -function whose only purpose is to return the type identifier for a -specific class. Once the type (or class or interface) is registered, -it may be instantiated, inherited, or implemented depending on exactly -what sort of type it is. - -There is also a third registration function for registering fundamental -types called g_type_register_fundamental() which requires both a #GTypeInfo -structure and a #GTypeFundamentalInfo structure but it is seldom used -since most fundamental types are predefined rather than user-defined. - -Type instance and class structs are limited to a total of 64 KiB, -including all parent types. Similarly, type instances' private data -(as created by G_ADD_PRIVATE()) are limited to a total of -64 KiB. If a type instance needs a large static buffer, allocate it -separately (typically by using #GArray or #GPtrArray) and put a pointer -to the buffer in the structure. - -As mentioned in the [GType conventions][gtype-conventions], type names must -be at least three characters long. There is no upper length limit. The first -character must be a letter (a–z or A–Z) or an underscore (‘_’). Subsequent -characters can be letters, numbers or any of ‘-_+’. - -# Runtime Debugging - -When `G_ENABLE_DEBUG` is defined during compilation, the GObject library -supports an environment variable `GOBJECT_DEBUG` that can be set to a -combination of flags to trigger debugging messages about -object bookkeeping and signal emissions during runtime. - -The currently supported flags are: - - `objects`: Tracks all #GObject instances in a global hash table called - `debug_objects_ht`, and prints the still-alive objects on exit. - - `instance-count`: Tracks the number of instances of every #GType and makes - it available via the g_type_get_instance_count() function. - - `signals`: Currently unused. - - + - - GObject is the fundamental type providing the common attributes and -methods for all object types in GTK, Pango and other libraries -based on GObject. The GObject class provides methods for object -construction and destruction, property access methods, and signal -support. Signals are described in detail [here][gobject-Signals]. - -For a tutorial on implementing a new GObject class, see [How to define and -implement a new GObject][howto-gobject]. For a list of naming conventions for -GObjects and their methods, see the [GType conventions][gtype-conventions]. -For the high-level concepts behind GObject, read [Instantiatable classed types: -Objects][gtype-instantiatable-classed]. - -## Floating references # {#floating-ref} - -**Note**: Floating references are a C convenience API and should not be -used in modern GObject code. Language bindings in particular find the -concept highly problematic, as floating references are not identifiable -through annotations, and neither are deviations from the floating reference -behavior, like types that inherit from #GInitiallyUnowned and still return -a full reference from g_object_new(). - -GInitiallyUnowned is derived from GObject. The only difference between -the two is that the initial reference of a GInitiallyUnowned is flagged -as a "floating" reference. This means that it is not specifically -claimed to be "owned" by any code portion. The main motivation for -providing floating references is C convenience. In particular, it -allows code to be written as: - -|[<!-- language="C" --> -container = create_container (); -container_add_child (container, create_child()); -]| - -If container_add_child() calls g_object_ref_sink() on the passed-in child, -no reference of the newly created child is leaked. Without floating -references, container_add_child() can only g_object_ref() the new child, -so to implement this code without reference leaks, it would have to be -written as: - -|[<!-- language="C" --> -Child *child; -container = create_container (); -child = create_child (); -container_add_child (container, child); -g_object_unref (child); -]| - -The floating reference can be converted into an ordinary reference by -calling g_object_ref_sink(). For already sunken objects (objects that -don't have a floating reference anymore), g_object_ref_sink() is equivalent -to g_object_ref() and returns a new reference. - -Since floating references are useful almost exclusively for C convenience, -language bindings that provide automated reference and memory ownership -maintenance (such as smart pointers or garbage collection) should not -expose floating references in their API. The best practice for handling -types that have initially floating references is to immediately sink those -references after g_object_new() returns, by checking if the #GType -inherits from #GInitiallyUnowned. For instance: - -|[<!-- language="C" --> -GObject *res = g_object_new_with_properties (gtype, - n_props, - prop_names, - prop_values); - -// or: if (g_type_is_a (gtype, G_TYPE_INITIALLY_UNOWNED)) -if (G_IS_INITIALLY_UNOWNED (res)) - g_object_ref_sink (res); - -return res; -]| - -Some object implementations may need to save an objects floating state -across certain code portions (an example is #GtkMenu), to achieve this, -the following sequence can be used: - -|[<!-- language="C" --> -// save floating state -gboolean was_floating = g_object_is_floating (object); -g_object_ref_sink (object); -// protected code portion - -... - -// restore floating state -if (was_floating) - g_object_force_floating (object); -else - g_object_unref (object); // release previously acquired reference -]| - Creates a new #GParamSpecBoolean instance specifying a %G_TYPE_BOOLEAN + filename="gobject/gparamspecs.c" + line="1912">Creates a new #GParamSpecBoolean instance specifying a %G_TYPE_BOOLEAN property. In many cases, it may be more appropriate to use an enum with g_param_spec_enum(), both to improve code clarity by using explicitly named values, and to allow for more values to be added in future without breaking API. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="1928">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="1914">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="1915">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="1916">description of the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="1917">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="1918">flags for the property specified Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED + filename="gobject/gparamspecs.c" + line="2489">Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_BOXED derived property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2502">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2491">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2492">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2493">description of the property specified %G_TYPE_BOXED derived type of this property + filename="gobject/gparamspecs.c" + line="2494">%G_TYPE_BOXED derived type of this property flags for the property specified + filename="gobject/gparamspecs.c" + line="2495">flags for the property specified Creates a new #GParamSpecChar instance specifying a %G_TYPE_CHAR property. - + filename="gobject/gparamspecs.c" + line="1832">Creates a new #GParamSpecChar instance specifying a %G_TYPE_CHAR property. + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="1844">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="1834">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="1835">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="1836">description of the property specified minimum value for the property specified + filename="gobject/gparamspecs.c" + line="1837">minimum value for the property specified maximum value for the property specified + filename="gobject/gparamspecs.c" + line="1838">maximum value for the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="1839">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="1840">flags for the property specified Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE + filename="gobject/gparamspecs.c" + line="2376">Creates a new #GParamSpecDouble instance specifying a %G_TYPE_DOUBLE property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2391">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2378">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2379">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2380">description of the property specified minimum value for the property specified + filename="gobject/gparamspecs.c" + line="2381">minimum value for the property specified maximum value for the property specified + filename="gobject/gparamspecs.c" + line="2382">maximum value for the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="2383">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2384">flags for the property specified Creates a new #GParamSpecEnum instance specifying a %G_TYPE_ENUM + filename="gobject/gparamspecs.c" + line="2242">Creates a new #GParamSpecEnum instance specifying a %G_TYPE_ENUM property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2256">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2244">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2245">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2246">description of the property specified a #GType derived from %G_TYPE_ENUM + filename="gobject/gparamspecs.c" + line="2247">a #GType derived from %G_TYPE_ENUM default value for the property specified + filename="gobject/gparamspecs.c" + line="2248">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2249">flags for the property specified Creates a new #GParamSpecFlags instance specifying a %G_TYPE_FLAGS + filename="gobject/gparamspecs.c" + line="2288">Creates a new #GParamSpecFlags instance specifying a %G_TYPE_FLAGS property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2302">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2290">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2291">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2292">description of the property specified a #GType derived from %G_TYPE_FLAGS + filename="gobject/gparamspecs.c" + line="2293">a #GType derived from %G_TYPE_FLAGS default value for the property specified + filename="gobject/gparamspecs.c" + line="2294">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2295">flags for the property specified Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property. + filename="gobject/gparamspecs.c" + line="2334">Creates a new #GParamSpecFloat instance specifying a %G_TYPE_FLOAT property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2348">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2336">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2337">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2338">description of the property specified minimum value for the property specified + filename="gobject/gparamspecs.c" + line="2339">minimum value for the property specified maximum value for the property specified + filename="gobject/gparamspecs.c" + line="2340">maximum value for the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="2341">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2342">flags for the property specified @@ -23204,24 +24241,23 @@ See g_param_spec_internal() for details on property names. c:identifier="g_param_spec_gtype" version="2.10"> Creates a new #GParamSpecGType instance specifying a + filename="gobject/gparamspecs.c" + line="2559">Creates a new #GParamSpecGType instance specifying a %G_TYPE_GTYPE property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2575">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2561">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2562">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2563">description of the property specified a #GType whose subtypes are allowed as values + filename="gobject/gparamspecs.c" + line="2564">a #GType whose subtypes are allowed as values of the property (use %G_TYPE_NONE for any type) flags for the property specified + filename="gobject/gparamspecs.c" + line="2566">flags for the property specified Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property. + filename="gobject/gparamspecs.c" + line="1952">Creates a new #GParamSpecInt instance specifying a %G_TYPE_INT property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="1966">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="1954">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="1955">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="1956">description of the property specified minimum value for the property specified + filename="gobject/gparamspecs.c" + line="1957">minimum value for the property specified maximum value for the property specified + filename="gobject/gparamspecs.c" + line="1958">maximum value for the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="1959">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="1960">flags for the property specified Creates a new #GParamSpecInt64 instance specifying a %G_TYPE_INT64 property. + filename="gobject/gparamspecs.c" + line="2121">Creates a new #GParamSpecInt64 instance specifying a %G_TYPE_INT64 property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2135">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2123">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2124">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2125">description of the property specified minimum value for the property specified + filename="gobject/gparamspecs.c" + line="2126">minimum value for the property specified maximum value for the property specified + filename="gobject/gparamspecs.c" + line="2127">maximum value for the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="2128">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2129">flags for the property specified Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property. + filename="gobject/gparamspecs.c" + line="2036">Creates a new #GParamSpecLong instance specifying a %G_TYPE_LONG property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2050">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2038">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2039">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2040">description of the property specified minimum value for the property specified + filename="gobject/gparamspecs.c" + line="2041">minimum value for the property specified maximum value for the property specified + filename="gobject/gparamspecs.c" + line="2042">maximum value for the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="2043">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2044">flags for the property specified Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_OBJECT + filename="gobject/gparamspecs.c" + line="2641">Creates a new #GParamSpecBoxed instance specifying a %G_TYPE_OBJECT derived property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2654">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2643">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2644">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2645">description of the property specified %G_TYPE_OBJECT derived type of this property + filename="gobject/gparamspecs.c" + line="2646">%G_TYPE_OBJECT derived type of this property flags for the property specified + filename="gobject/gparamspecs.c" + line="2647">flags for the property specified @@ -23511,53 +24543,51 @@ See g_param_spec_internal() for details on property names. version="2.4" introspectable="0"> Creates a new property of type #GParamSpecOverride. This is used + filename="gobject/gparamspecs.c" + line="2678">Creates a new property of type #GParamSpecOverride. This is used to direct operations to another paramspec, and will not be directly useful unless you are implementing a new base type similar to GObject. - + the newly created #GParamSpec + filename="gobject/gparamspecs.c" + line="2689">the newly created #GParamSpec the name of the property. + filename="gobject/gparamspecs.c" + line="2680">the name of the property. The property that is being overridden + filename="gobject/gparamspecs.c" + line="2681">The property that is being overridden Creates a new #GParamSpecParam instance specifying a %G_TYPE_PARAM + filename="gobject/gparamspecs.c" + line="2452">Creates a new #GParamSpecParam instance specifying a %G_TYPE_PARAM property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2465">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2454">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2455">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2456">description of the property specified a #GType derived from %G_TYPE_PARAM + filename="gobject/gparamspecs.c" + line="2457">a #GType derived from %G_TYPE_PARAM flags for the property specified + filename="gobject/gparamspecs.c" + line="2458">flags for the property specified Creates a new #GParamSpecPointer instance specifying a pointer property. + filename="gobject/gparamspecs.c" + line="2527">Creates a new #GParamSpecPointer instance specifying a pointer property. Where possible, it is better to use g_param_spec_object() or g_param_spec_boxed() to expose memory management information. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2540">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2529">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2530">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2531">description of the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2532">flags for the property specified Creates a new #GParamSpecString instance. + filename="gobject/gparamspecs.c" + line="2419">Creates a new #GParamSpecString instance. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2431">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2421">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2422">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2423">description of the property specified nullable="1" allow-none="1"> default value for the property specified + filename="gobject/gparamspecs.c" + line="2424">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2425">flags for the property specified Creates a new #GParamSpecUChar instance specifying a %G_TYPE_UCHAR property. - + filename="gobject/gparamspecs.c" + line="1872">Creates a new #GParamSpecUChar instance specifying a %G_TYPE_UCHAR property. + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="1884">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="1874">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="1875">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="1876">description of the property specified minimum value for the property specified + filename="gobject/gparamspecs.c" + line="1877">minimum value for the property specified maximum value for the property specified + filename="gobject/gparamspecs.c" + line="1878">maximum value for the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="1879">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="1880">flags for the property specified Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property. + filename="gobject/gparamspecs.c" + line="1994">Creates a new #GParamSpecUInt instance specifying a %G_TYPE_UINT property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2008">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="1996">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="1997">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="1998">description of the property specified minimum value for the property specified + filename="gobject/gparamspecs.c" + line="1999">minimum value for the property specified maximum value for the property specified + filename="gobject/gparamspecs.c" + line="2000">maximum value for the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="2001">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2002">flags for the property specified Creates a new #GParamSpecUInt64 instance specifying a %G_TYPE_UINT64 + filename="gobject/gparamspecs.c" + line="2163">Creates a new #GParamSpecUInt64 instance specifying a %G_TYPE_UINT64 property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2178">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2165">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2166">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2167">description of the property specified minimum value for the property specified + filename="gobject/gparamspecs.c" + line="2168">minimum value for the property specified maximum value for the property specified + filename="gobject/gparamspecs.c" + line="2169">maximum value for the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="2170">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2171">flags for the property specified Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG + filename="gobject/gparamspecs.c" + line="2078">Creates a new #GParamSpecULong instance specifying a %G_TYPE_ULONG property. See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2093">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2080">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2081">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2082">description of the property specified minimum value for the property specified + filename="gobject/gparamspecs.c" + line="2083">minimum value for the property specified maximum value for the property specified + filename="gobject/gparamspecs.c" + line="2084">maximum value for the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="2085">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2086">flags for the property specified Creates a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT + filename="gobject/gparamspecs.c" + line="2206">Creates a new #GParamSpecUnichar instance specifying a %G_TYPE_UINT property. #GValue structures for this property can be accessed with g_value_set_uint() and g_value_get_uint(). See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2220">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2208">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2209">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2210">description of the property specified default value for the property specified + filename="gobject/gparamspecs.c" + line="2211">default value for the property specified flags for the property specified + filename="gobject/gparamspecs.c" + line="2212">flags for the property specified @@ -24016,26 +25039,25 @@ See g_param_spec_internal() for details on property names. c:identifier="g_param_spec_value_array" introspectable="0"> Creates a new #GParamSpecValueArray instance specifying a + filename="gobject/gparamspecs.c" + line="2597">Creates a new #GParamSpecValueArray instance specifying a %G_TYPE_VALUE_ARRAY property. %G_TYPE_VALUE_ARRAY is a %G_TYPE_BOXED type, as such, #GValue structures for this property can be accessed with g_value_set_boxed() and g_value_get_boxed(). See g_param_spec_internal() for details on property names. - + a newly created parameter specification + filename="gobject/gparamspecs.c" + line="2613">a newly created parameter specification canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2599">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2600">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2601">description of the property specified a #GParamSpec describing the elements contained in + filename="gobject/gparamspecs.c" + line="2602">a #GParamSpec describing the elements contained in arrays of this property, may be %NULL flags for the property specified + filename="gobject/gparamspecs.c" + line="2604">flags for the property specified @@ -24075,26 +25097,25 @@ See g_param_spec_internal() for details on property names. c:identifier="g_param_spec_variant" version="2.26"> Creates a new #GParamSpecVariant instance specifying a #GVariant + filename="gobject/gparamspecs.c" + line="2721">Creates a new #GParamSpecVariant instance specifying a #GVariant property. If @default_value is floating, it is consumed. See g_param_spec_internal() for details on property names. - + the newly created #GParamSpec + filename="gobject/gparamspecs.c" + line="2738">the newly created #GParamSpec canonical name of the property specified + filename="gobject/gparamspecs.c" + line="2723">canonical name of the property specified nullable="1" allow-none="1"> nick name for the property specified + filename="gobject/gparamspecs.c" + line="2724">nick name for the property specified nullable="1" allow-none="1"> description of the property specified + filename="gobject/gparamspecs.c" + line="2725">description of the property specified a #GVariantType + filename="gobject/gparamspecs.c" + line="2726">a #GVariantType nullable="1" allow-none="1"> a #GVariant of type @type to + filename="gobject/gparamspecs.c" + line="2727">a #GVariant of type @type to use as the default value, or %NULL flags for the property specified + filename="gobject/gparamspecs.c" + line="2729">flags for the property specified @@ -24142,78 +25163,76 @@ See g_param_spec_internal() for details on property names. Registers @name as the name of a new static type derived + filename="gobject/gparam.c" + line="1470">Registers @name as the name of a new static type derived from %G_TYPE_PARAM. The type system uses the information contained in the #GParamSpecTypeInfo structure pointed to by @info to manage the #GParamSpec type and its instances. - + The new type identifier. + filename="gobject/gparam.c" + line="1482">The new type identifier. 0-terminated string used as the name of the new #GParamSpec type. + filename="gobject/gparam.c" + line="1472">0-terminated string used as the name of the new #GParamSpec type. The #GParamSpecTypeInfo for this #GParamSpec type. + filename="gobject/gparam.c" + line="1473">The #GParamSpecTypeInfo for this #GParamSpec type. Transforms @src_value into @dest_value if possible, and then + filename="gobject/gparam.c" + line="754">Transforms @src_value into @dest_value if possible, and then validates @dest_value, in order for it to conform to @pspec. If @strict_validation is %TRUE this function will only succeed if the transformed @dest_value complied to @pspec without modifications. See also g_value_type_transformable(), g_value_transform() and g_param_value_validate(). - + %TRUE if transformation and validation were successful, + filename="gobject/gparam.c" + line="770">%TRUE if transformation and validation were successful, %FALSE otherwise and @dest_value is left untouched. a valid #GParamSpec + filename="gobject/gparam.c" + line="756">a valid #GParamSpec source #GValue + filename="gobject/gparam.c" + line="757">source #GValue destination #GValue of correct type for @pspec + filename="gobject/gparam.c" + line="758">destination #GValue of correct type for @pspec %TRUE requires @dest_value to conform to @pspec + filename="gobject/gparam.c" + line="759">%TRUE requires @dest_value to conform to @pspec without modifications @@ -24222,27 +25241,26 @@ without modifications Checks whether @value contains the default value as specified in @pspec. - + filename="gobject/gparam.c" + line="647">Checks whether @value contains the default value as specified in @pspec. + whether @value contains the canonical default for this @pspec + filename="gobject/gparam.c" + line="654">whether @value contains the canonical default for this @pspec a valid #GParamSpec + filename="gobject/gparam.c" + line="649">a valid #GParamSpec a #GValue of correct type for @pspec + filename="gobject/gparam.c" + line="650">a #GValue of correct type for @pspec @@ -24251,29 +25269,28 @@ without modifications c:identifier="g_param_value_is_valid" version="2.74"> Return whether the contents of @value comply with the specifications + filename="gobject/gparam.c" + line="709">Return whether the contents of @value comply with the specifications set out by @pspec. - + whether the contents of @value comply with the specifications + filename="gobject/gparam.c" + line="717">whether the contents of @value comply with the specifications set out by @pspec. a valid #GParamSpec + filename="gobject/gparam.c" + line="711">a valid #GParamSpec a #GValue of correct type for @pspec + filename="gobject/gparam.c" + line="712">a #GValue of correct type for @pspec @@ -24281,110 +25298,90 @@ set out by @pspec. Sets @value to its default value as specified in @pspec. - + filename="gobject/gparam.c" + line="619">Sets @value to its default value as specified in @pspec. + a valid #GParamSpec + filename="gobject/gparam.c" + line="621">a valid #GParamSpec a #GValue of correct type for @pspec; since 2.64, you + filename="gobject/gparam.c" + line="622">a #GValue of correct type for @pspec; since 2.64, you can also pass an empty #GValue, initialized with %G_VALUE_INIT - - #GValue provides an abstract container structure which can be -copied, transformed and compared while holding a value of any -(derived) type, which is registered as a #GType with a -#GTypeValueTable in its #GTypeInfo structure. Parameter -specifications for most value types can be created as #GParamSpec -derived instances, to implement e.g. #GObject properties which -operate on #GValue containers. - -Parameter names need to start with a letter (a-z or A-Z). Subsequent -characters can be letters, numbers or a '-'. -All other characters are replaced by a '-' during construction. - -See also #GValue for more information. - Ensures that the contents of @value comply with the specifications + filename="gobject/gparam.c" + line="675">Ensures that the contents of @value comply with the specifications set out by @pspec. For example, a #GParamSpecInt might require that integers stored in @value may not be smaller than -42 and not be greater than +42. If @value contains an integer outside of this range, it is modified accordingly, so the resulting value will fit into the range -42 .. +42. - + whether modifying @value was necessary to ensure validity + filename="gobject/gparam.c" + line="687">whether modifying @value was necessary to ensure validity a valid #GParamSpec + filename="gobject/gparam.c" + line="677">a valid #GParamSpec a #GValue of correct type for @pspec + filename="gobject/gparam.c" + line="678">a #GValue of correct type for @pspec Compares @value1 with @value2 according to @pspec, and return -1, 0 or +1, + filename="gobject/gparam.c" + line="807">Compares @value1 with @value2 according to @pspec, and return -1, 0 or +1, if @value1 is found to be less than, equal to or greater than @value2, respectively. - + -1, 0 or +1, for a less than, equal to or greater than result + filename="gobject/gparam.c" + line="817">-1, 0 or +1, for a less than, equal to or greater than result a valid #GParamSpec + filename="gobject/gparam.c" + line="809">a valid #GParamSpec a #GValue of correct type for @pspec + filename="gobject/gparam.c" + line="810">a #GValue of correct type for @pspec a #GValue of correct type for @pspec + filename="gobject/gparam.c" + line="811">a #GValue of correct type for @pspec @@ -24392,22 +25389,21 @@ respectively. Creates a new %G_TYPE_POINTER derived type id for a new + filename="gobject/gvaluetypes.c" + line="1472">Creates a new %G_TYPE_POINTER derived type id for a new pointer type with name @name. - + a new %G_TYPE_POINTER derived type id for @name. + filename="gobject/gvaluetypes.c" + line="1479">a new %G_TYPE_POINTER derived type id for @name. the name of the new pointer type. + filename="gobject/gvaluetypes.c" + line="1474">the name of the new pointer type. @@ -24417,8 +25413,8 @@ pointer type with name @name. version="2.44" introspectable="0"> Updates a #GObject pointer to refer to @new_object. + filename="gobject/gobject.h" + line="697">Updates a #GObject pointer to refer to @new_object. It increments the reference count of @new_object (if non-%NULL), decrements the reference count of the current value of @object_ptr (if non-%NULL), and @@ -24443,18 +25439,17 @@ One convenient usage of this function is in implementing property setters: g_object_notify (foo, "bar"); } ]| - + a pointer to a #GObject reference + filename="gobject/gobject.h" + line="699">a pointer to a #GObject reference a pointer to the new #GObject to + filename="gobject/gobject.h" + line="700">a pointer to the new #GObject to assign to @object_ptr, or %NULL to clear the pointer @@ -24464,8 +25459,8 @@ One convenient usage of this function is in implementing property setters: version="2.56" introspectable="0"> Updates a pointer to weakly refer to @new_object. + filename="gobject/gobject.h" + line="851">Updates a pointer to weakly refer to @new_object. It assigns @new_object to @weak_pointer_location and ensures that @weak_pointer_location will automatically be set to %NULL @@ -24492,18 +25487,17 @@ One convenient usage of this function is in implementing property setters: g_object_notify (foo, "bar"); } ]| - + the memory address of a pointer + filename="gobject/gobject.h" + line="853">the memory address of a pointer a pointer to the new #GObject to + filename="gobject/gobject.h" + line="854">a pointer to the new #GObject to assign to it, or %NULL to clear the pointer @@ -24512,8 +25506,8 @@ One convenient usage of this function is in implementing property setters: c:identifier="g_signal_accumulator_first_wins" version="2.28"> A predefined #GSignalAccumulator for signals intended to be used as a + filename="gobject/gsignal.c" + line="4127">A predefined #GSignalAccumulator for signals intended to be used as a hook for application code to provide a particular value. Usually only one such value is desired and multiple handlers for the same signal don't make much sense (except for the case of the default @@ -24523,31 +25517,30 @@ usually want the signal connection to override the class handler). This accumulator will use the return value from the first signal handler that is run as the return value for the signal and not run any further handlers (ie: the first handler "wins"). - + standard #GSignalAccumulator result + filename="gobject/gsignal.c" + line="4145">standard #GSignalAccumulator result standard #GSignalAccumulator parameter + filename="gobject/gsignal.c" + line="4129">standard #GSignalAccumulator parameter standard #GSignalAccumulator parameter + filename="gobject/gsignal.c" + line="4130">standard #GSignalAccumulator parameter standard #GSignalAccumulator parameter + filename="gobject/gsignal.c" + line="4131">standard #GSignalAccumulator parameter nullable="1" allow-none="1"> standard #GSignalAccumulator parameter + filename="gobject/gsignal.c" + line="4132">standard #GSignalAccumulator parameter @@ -24565,39 +25558,38 @@ any further handlers (ie: the first handler "wins"). c:identifier="g_signal_accumulator_true_handled" version="2.4"> A predefined #GSignalAccumulator for signals that return a + filename="gobject/gsignal.c" + line="4092">A predefined #GSignalAccumulator for signals that return a boolean values. The behavior that this accumulator gives is that a return of %TRUE stops the signal emission: no further callbacks will be invoked, while a return of %FALSE allows the emission to continue. The idea here is that a %TRUE return indicates that the callback handled the signal, and no further handling is needed. - + standard #GSignalAccumulator result + filename="gobject/gsignal.c" + line="4109">standard #GSignalAccumulator result standard #GSignalAccumulator parameter + filename="gobject/gsignal.c" + line="4094">standard #GSignalAccumulator parameter standard #GSignalAccumulator parameter + filename="gobject/gsignal.c" + line="4095">standard #GSignalAccumulator parameter standard #GSignalAccumulator parameter + filename="gobject/gsignal.c" + line="4096">standard #GSignalAccumulator parameter nullable="1" allow-none="1"> standard #GSignalAccumulator parameter + filename="gobject/gsignal.c" + line="4097">standard #GSignalAccumulator parameter @@ -24614,29 +25606,28 @@ handling is needed. Adds an emission hook for a signal, which will get called for any emission + filename="gobject/gsignal.c" + line="935">Adds an emission hook for a signal, which will get called for any emission of that signal, independent of the instance. This is possible only for signals which don't have %G_SIGNAL_NO_HOOKS flag set. - + the hook id, for later use with g_signal_remove_emission_hook(). + filename="gobject/gsignal.c" + line="947">the hook id, for later use with g_signal_remove_emission_hook(). the signal identifier, as returned by g_signal_lookup(). + filename="gobject/gsignal.c" + line="937">the signal identifier, as returned by g_signal_lookup(). the detail on which to call the hook. + filename="gobject/gsignal.c" + line="938">the detail on which to call the hook. closure="3" destroy="4"> a #GSignalEmissionHook function. + filename="gobject/gsignal.c" + line="939">a #GSignalEmissionHook function. scope="notified" closure="2"> user data for @hook_func. + filename="gobject/gsignal.c" + line="940">user data for @hook_func. scope="async" destroy="3"> a #GDestroyNotify for @hook_data. + filename="gobject/gsignal.c" + line="941">a #GDestroyNotify for @hook_data. @@ -24676,21 +25667,20 @@ for signals which don't have %G_SIGNAL_NO_HOOKS flag set. Calls the original class closure of a signal. This function should only + filename="gobject/gsignal.c" + line="2034">Calls the original class closure of a signal. This function should only be called from an overridden class closure; see g_signal_override_class_closure() and g_signal_override_class_handler(). - + the argument list of the signal emission. + filename="gobject/gsignal.c" + line="2036">the argument list of the signal emission. The first element in the array is a #GValue for the instance the signal is being emitted on. The rest are any arguments to be passed to the signal. @@ -24699,8 +25689,8 @@ g_signal_override_class_handler(). Location for the return value. + filename="gobject/gsignal.c" + line="2039">Location for the return value. @@ -24710,28 +25700,27 @@ g_signal_override_class_handler(). version="2.18" introspectable="0"> Calls the original class closure of a signal. This function should + filename="gobject/gsignal.c" + line="2106">Calls the original class closure of a signal. This function should only be called from an overridden class closure; see g_signal_override_class_closure() and g_signal_override_class_handler(). - + the instance the signal is being + filename="gobject/gsignal.c" + line="2108">the instance the signal is being emitted on. parameters to be passed to the parent class closure, followed by a + filename="gobject/gsignal.c" + line="2110">parameters to be passed to the parent class closure, followed by a location for the return value. If the return type of the signal is %G_TYPE_NONE, the return value location can be omitted. @@ -24742,34 +25731,37 @@ g_signal_override_class_handler(). c:identifier="g_signal_connect" introspectable="0"> Connects a #GCallback function to a signal for a particular object. + filename="gobject/gsignal.h" + line="496">Connects a [type@GObject.Callback] function to a signal for a particular object. + +The handler will be called synchronously, before the default handler of the signal. +[func@GObject.signal_emit] will not return control until all handlers are called. -The handler will be called synchronously, before the default handler of the signal. g_signal_emit() will not return control until all handlers are called. +See [memory management of signal handlers](signals.html#Memory_management_of_signal_handlers) for +details on how to handle the return value and memory management of @data. -See [memory management of signal handlers][signal-memory-management] for -details on how to handle the return value and memory management of @data. - +This function cannot fail. If the given signal doesn’t exist, a critical +warning is emitted. + the instance to connect to. a string of the form "signal-name::detail". the #GCallback to connect. data to pass to @c_handler calls. @@ -24778,74 +25770,78 @@ details on how to handle the return value and memory management of @data. c:identifier="g_signal_connect_after" introspectable="0"> Connects a #GCallback function to a signal for a particular object. + filename="gobject/gsignal.h" + line="520">Connects a #GCallback function to a signal for a particular object. -The handler will be called synchronously, after the default handler of the signal. - +The handler will be called synchronously, after the default handler of the signal. + +This function cannot fail. If the given signal doesn’t exist, a critical +warning is emitted. + the instance to connect to. + filename="gobject/gsignal.h" + line="522">the instance to connect to. a string of the form "signal-name::detail". + filename="gobject/gsignal.h" + line="523">a string of the form "signal-name::detail". the #GCallback to connect. + filename="gobject/gsignal.h" + line="524">the #GCallback to connect. data to pass to @c_handler calls. + filename="gobject/gsignal.h" + line="525">data to pass to @c_handler calls. Connects a closure to a signal for a particular object. + filename="gobject/gsignal.c" + line="2359">Connects a closure to a signal for a particular object. If @closure is a floating reference (see g_closure_sink()), this function -takes ownership of @closure. - +takes ownership of @closure. + +This function cannot fail. If the given signal doesn’t exist, a critical +warning is emitted. + the handler ID (always greater than 0 for successful connections) + filename="gobject/gsignal.c" + line="2375">the handler ID (always greater than 0) the instance to connect to. + filename="gobject/gsignal.c" + line="2361">the instance to connect to. a string of the form "signal-name::detail". + filename="gobject/gsignal.c" + line="2362">a string of the form "signal-name::detail". the closure to connect. + filename="gobject/gsignal.c" + line="2363">the closure to connect. whether the handler should be called before or after the + filename="gobject/gsignal.c" + line="2364">whether the handler should be called before or after the default handler of the signal. @@ -24854,48 +25850,50 @@ takes ownership of @closure. Connects a closure to a signal for a particular object. + filename="gobject/gsignal.c" + line="2290">Connects a closure to a signal for a particular object. If @closure is a floating reference (see g_closure_sink()), this function -takes ownership of @closure. - +takes ownership of @closure. + +This function cannot fail. If the given signal doesn’t exist, a critical +warning is emitted. + the handler ID (always greater than 0 for successful connections) + filename="gobject/gsignal.c" + line="2307">the handler ID (always greater than 0) the instance to connect to. + filename="gobject/gsignal.c" + line="2292">the instance to connect to. the id of the signal. + filename="gobject/gsignal.c" + line="2293">the id of the signal. the detail. + filename="gobject/gsignal.c" + line="2294">the detail. the closure to connect. + filename="gobject/gsignal.c" + line="2295">the closure to connect. whether the handler should be called before or after the + filename="gobject/gsignal.c" + line="2296">whether the handler should be called before or after the default handler of the signal. @@ -24905,37 +25903,39 @@ takes ownership of @closure. c:identifier="g_signal_connect_data" introspectable="0"> Connects a #GCallback function to a signal for a particular object. Similar + filename="gobject/gsignal.c" + line="2456">Connects a #GCallback function to a signal for a particular object. Similar to g_signal_connect(), but allows to provide a #GClosureNotify for the data which will be called when the signal handler is disconnected and no longer used. Specify @connect_flags if you need `..._after()` or -`..._swapped()` variants of this function. - +`..._swapped()` variants of this function. + +This function cannot fail. If the given signal doesn’t exist, a critical +warning is emitted. + the handler ID (always greater than 0 for successful connections) + filename="gobject/gsignal.c" + line="2474">the handler ID (always greater than 0) the instance to connect to. + filename="gobject/gsignal.c" + line="2458">the instance to connect to. a string of the form "signal-name::detail". + filename="gobject/gsignal.c" + line="2459">a string of the form "signal-name::detail". the #GCallback to connect. + filename="gobject/gsignal.c" + line="2460">the #GCallback to connect. data to pass to @c_handler calls. + filename="gobject/gsignal.c" + line="2461">data to pass to @c_handler calls. a #GClosureNotify for @data. + filename="gobject/gsignal.c" + line="2462">a #GClosureNotify for @data. a combination of #GConnectFlags. + filename="gobject/gsignal.c" + line="2463">a combination of #GConnectFlags. @@ -24972,8 +25972,8 @@ used. Specify @connect_flags if you need `..._after()` or c:identifier="g_signal_connect_object" introspectable="0"> This is similar to g_signal_connect_data(), but uses a closure which + filename="gobject/gobject.c" + line="5138">This is similar to g_signal_connect_data(), but uses a closure which ensures that the @gobject stays alive during the call to @c_handler by temporarily adding a reference count to @gobject. @@ -24981,31 +25981,30 @@ When the @gobject is destroyed the signal handler will be automatically disconnected. Note that this is not currently threadsafe (ie: emitting a signal while @gobject is being destroyed in another thread is not safe). - + the handler id. + filename="gobject/gobject.c" + line="5156">the handler id. the instance to connect to. + filename="gobject/gobject.c" + line="5140">the instance to connect to. a string of the form "signal-name::detail". + filename="gobject/gobject.c" + line="5141">a string of the form "signal-name::detail". the #GCallback to connect. + filename="gobject/gobject.c" + line="5142">the #GCallback to connect. nullable="1" allow-none="1"> the object to pass as data + filename="gobject/gobject.c" + line="5143">the object to pass as data to @c_handler. a combination of #GConnectFlags. + filename="gobject/gobject.c" + line="5145">a combination of #GConnectFlags. @@ -25030,8 +26029,8 @@ is not safe). c:identifier="g_signal_connect_swapped" introspectable="0"> Connects a #GCallback function to a signal for a particular object. + filename="gobject/gsignal.h" + line="538">Connects a #GCallback function to a signal for a particular object. The instance on which the signal is emitted and @data will be swapped when calling the handler. This is useful when calling pre-existing functions to @@ -25056,29 +26055,31 @@ button_clicked_cb (GtkButton *button, GtkWidget *other_widget) g_signal_connect (button, "clicked", (GCallback) button_clicked_cb, other_widget); -]| - +]| + +This function cannot fail. If the given signal doesn’t exist, a critical +warning is emitted. + the instance to connect to. + filename="gobject/gsignal.h" + line="540">the instance to connect to. a string of the form "signal-name::detail". + filename="gobject/gsignal.h" + line="541">a string of the form "signal-name::detail". the #GCallback to connect. + filename="gobject/gsignal.h" + line="542">the #GCallback to connect. data to pass to @c_handler calls. + filename="gobject/gsignal.h" + line="543">data to pass to @c_handler calls. @@ -25086,40 +26087,39 @@ g_signal_connect (button, "clicked", c:identifier="g_signal_emit" introspectable="0"> Emits a signal. Signal emission is done synchronously. + filename="gobject/gsignal.c" + line="3559">Emits a signal. Signal emission is done synchronously. The method will only return control after all handlers are called or signal emission was stopped. Note that g_signal_emit() resets the return value to the default if no handlers are connected, in contrast to g_signal_emitv(). - + the instance the signal is being emitted on. + filename="gobject/gsignal.c" + line="3561">the instance the signal is being emitted on. the signal id + filename="gobject/gsignal.c" + line="3562">the signal id the detail + filename="gobject/gsignal.c" + line="3563">the detail parameters to be passed to the signal, followed by a + filename="gobject/gsignal.c" + line="3564">parameters to be passed to the signal, followed by a location for the return value. If the return type of the signal is %G_TYPE_NONE, the return value location can be omitted. @@ -25130,34 +26130,33 @@ if no handlers are connected, in contrast to g_signal_emitv(). c:identifier="g_signal_emit_by_name" introspectable="0"> Emits a signal. Signal emission is done synchronously. + filename="gobject/gsignal.c" + line="3587">Emits a signal. Signal emission is done synchronously. The method will only return control after all handlers are called or signal emission was stopped. Note that g_signal_emit_by_name() resets the return value to the default if no handlers are connected, in contrast to g_signal_emitv(). - + the instance the signal is being emitted on. + filename="gobject/gsignal.c" + line="3589">the instance the signal is being emitted on. a string of the form "signal-name::detail". + filename="gobject/gsignal.c" + line="3590">a string of the form "signal-name::detail". parameters to be passed to the signal, followed by a + filename="gobject/gsignal.c" + line="3591">parameters to be passed to the signal, followed by a location for the return value. If the return type of the signal is %G_TYPE_NONE, the return value location can be omitted. The number of parameters to pass to this function is defined when creating the signal. @@ -25169,41 +26168,40 @@ if no handlers are connected, in contrast to g_signal_emitv(). c:identifier="g_signal_emit_valist" introspectable="0"> Emits a signal. Signal emission is done synchronously. + filename="gobject/gsignal.c" + line="3240">Emits a signal. Signal emission is done synchronously. The method will only return control after all handlers are called or signal emission was stopped. Note that g_signal_emit_valist() resets the return value to the default if no handlers are connected, in contrast to g_signal_emitv(). - + the instance the signal is being + filename="gobject/gsignal.c" + line="3242">the instance the signal is being emitted on. the signal id + filename="gobject/gsignal.c" + line="3244">the signal id the detail + filename="gobject/gsignal.c" + line="3245">the detail a list of parameters to be passed to the signal, followed by a + filename="gobject/gsignal.c" + line="3246">a list of parameters to be passed to the signal, followed by a location for the return value. If the return type of the signal is %G_TYPE_NONE, the return value location can be omitted. @@ -25212,22 +26210,21 @@ if no handlers are connected, in contrast to g_signal_emitv(). Emits a signal. Signal emission is done synchronously. + filename="gobject/gsignal.c" + line="3088">Emits a signal. Signal emission is done synchronously. The method will only return control after all handlers are called or signal emission was stopped. Note that g_signal_emitv() doesn't change @return_value if no handlers are connected, in contrast to g_signal_emit() and g_signal_emit_valist(). - + argument list for the signal emission. + filename="gobject/gsignal.c" + line="3090">argument list for the signal emission. The first element in the array is a #GValue for the instance the signal is being emitted on. The rest are any arguments to be passed to the signal. @@ -25236,14 +26233,14 @@ connected, in contrast to g_signal_emit() and g_signal_emit_valist(). the signal id + filename="gobject/gsignal.c" + line="3093">the signal id the detail + filename="gobject/gsignal.c" + line="3094">the detail transfer-ownership="full" optional="1"> Location to + filename="gobject/gsignal.c" + line="3095">Location to store the return value of the signal emission. This must be provided if the specified signal returns a value, but may be ignored otherwise. @@ -25263,22 +26260,21 @@ specified signal returns a value, but may be ignored otherwise. Returns the invocation hint of the innermost signal emission of instance. - + filename="gobject/gsignal.c" + line="2267">Returns the invocation hint of the innermost signal emission of instance. + the invocation hint of the innermost + filename="gobject/gsignal.c" + line="2273">the invocation hint of the innermost signal emission, or %NULL if not found. the instance to query + filename="gobject/gsignal.c" + line="2269">the instance to query @@ -25286,8 +26282,8 @@ specified signal returns a value, but may be ignored otherwise. Blocks a handler of an instance so it will not be called during any + filename="gobject/gsignal.c" + line="2543">Blocks a handler of an instance so it will not be called during any signal emissions unless it is unblocked again. Thus "blocking" a signal handler means to temporarily deactivate it, a signal handler has to be unblocked exactly the same amount of times it has been @@ -25295,22 +26291,21 @@ blocked before to become active again. The @handler_id has to be a valid signal handler id, connected to a signal of @instance. - + The instance to block the signal handler of. + filename="gobject/gsignal.c" + line="2545">The instance to block the signal handler of. Handler id of the handler to be blocked. + filename="gobject/gsignal.c" + line="2546">Handler id of the handler to be blocked. @@ -25318,73 +26313,71 @@ signal of @instance. Disconnects a handler from an instance so it will not be called during + filename="gobject/gsignal.c" + line="2645">Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to. The @handler_id becomes invalid and may be reused. The @handler_id has to be a valid signal handler id, connected to a signal of @instance. - + The instance to remove the signal handler from. + filename="gobject/gsignal.c" + line="2647">The instance to remove the signal handler from. Handler id of the handler to be disconnected. + filename="gobject/gsignal.c" + line="2648">Handler id of the handler to be disconnected. Finds the first signal handler that matches certain selection criteria. + filename="gobject/gsignal.c" + line="2766">Finds the first signal handler that matches certain selection criteria. The criteria mask is passed as an OR-ed combination of #GSignalMatchType flags, and the criteria values are passed as arguments. The match @mask has to be non-0 for successful matches. If no handler was found, 0 is returned. - + A valid non-0 signal handler id for a successful match. + filename="gobject/gsignal.c" + line="2783">A valid non-0 signal handler id for a successful match. The instance owning the signal handler to be found. + filename="gobject/gsignal.c" + line="2768">The instance owning the signal handler to be found. Mask indicating which of @signal_id, @detail, @closure, @func + filename="gobject/gsignal.c" + line="2769">Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handler has to match. Signal the handler has to be connected to. + filename="gobject/gsignal.c" + line="2771">Signal the handler has to be connected to. Signal detail the handler has to be connected to. + filename="gobject/gsignal.c" + line="2772">Signal detail the handler has to be connected to. nullable="1" allow-none="1"> The closure the handler will invoke. + filename="gobject/gsignal.c" + line="2773">The closure the handler will invoke. nullable="1" allow-none="1"> The C closure callback of the handler (useless for non-C closures). + filename="gobject/gsignal.c" + line="2774">The C closure callback of the handler (useless for non-C closures). allow-none="1" closure="4"> The closure data of the handler's closure. + filename="gobject/gsignal.c" + line="2775">The closure data of the handler's closure. @@ -25420,27 +26413,26 @@ If no handler was found, 0 is returned. Returns whether @handler_id is the ID of a handler connected to @instance. - + filename="gobject/gsignal.c" + line="2688">Returns whether @handler_id is the ID of a handler connected to @instance. + whether @handler_id identifies a handler connected to @instance. + filename="gobject/gsignal.c" + line="2695">whether @handler_id identifies a handler connected to @instance. The instance where a signal handler is sought. + filename="gobject/gsignal.c" + line="2690">The instance where a signal handler is sought. the handler ID. + filename="gobject/gsignal.c" + line="2691">the handler ID. @@ -25448,8 +26440,8 @@ If no handler was found, 0 is returned. Undoes the effect of a previous g_signal_handler_block() call. A + filename="gobject/gsignal.c" + line="2592">Undoes the effect of a previous g_signal_handler_block() call. A blocked handler is skipped during signal emissions and will not be invoked, unblocking it (for exactly the amount of times it has been blocked before) reverts its "blocked" state, so the handler will be @@ -25462,22 +26454,21 @@ proceeded yet). The @handler_id has to be a valid id of a signal handler that is connected to a signal of @instance and is currently blocked. - + The instance to unblock the signal handler of. + filename="gobject/gsignal.c" + line="2594">The instance to unblock the signal handler of. Handler id of the handler to be unblocked. + filename="gobject/gsignal.c" + line="2595">Handler id of the handler to be unblocked. @@ -25486,33 +26477,32 @@ connected to a signal of @instance and is currently blocked. c:identifier="g_signal_handlers_block_by_func" introspectable="0"> Blocks all handlers on an instance that match @func and @data. - + filename="gobject/gsignal.h" + line="608">Blocks all handlers on an instance that match @func and @data. + The instance to block handlers from. + filename="gobject/gsignal.h" + line="610">The instance to block handlers from. The C closure callback of the handlers (useless for non-C closures). + filename="gobject/gsignal.h" + line="611">The C closure callback of the handlers (useless for non-C closures). The closure data of the handlers' closures. + filename="gobject/gsignal.h" + line="612">The closure data of the handlers' closures. Blocks all handlers on an instance that match a certain selection criteria. + filename="gobject/gsignal.c" + line="2844">Blocks all handlers on an instance that match a certain selection criteria. The criteria mask is passed as a combination of #GSignalMatchType flags, and the criteria values are passed as arguments. A handler must match on all @@ -25525,38 +26515,37 @@ If no handlers were found, 0 is returned, the number of blocked handlers otherwise. Support for %G_SIGNAL_MATCH_ID was added in GLib 2.78. - + The number of handlers that matched. + filename="gobject/gsignal.c" + line="2869">The number of handlers that matched. The instance to block handlers from. + filename="gobject/gsignal.c" + line="2846">The instance to block handlers from. Mask indicating which of @signal_id, @detail, @closure, @func + filename="gobject/gsignal.c" + line="2847">Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match. Signal the handlers have to be connected to. + filename="gobject/gsignal.c" + line="2849">Signal the handlers have to be connected to. Signal detail the handlers have to be connected to. + filename="gobject/gsignal.c" + line="2850">Signal detail the handlers have to be connected to. nullable="1" allow-none="1"> The closure the handlers will invoke. + filename="gobject/gsignal.c" + line="2851">The closure the handlers will invoke. nullable="1" allow-none="1"> The C closure callback of the handlers (useless for non-C closures). + filename="gobject/gsignal.c" + line="2852">The C closure callback of the handlers (useless for non-C closures). allow-none="1" closure="4"> The closure data of the handlers' closures. + filename="gobject/gsignal.c" + line="2853">The closure data of the handlers' closures. @@ -25592,20 +26581,19 @@ Support for %G_SIGNAL_MATCH_ID was added in GLib 2.78. Destroy all signal handlers of a type instance. This function is + filename="gobject/gsignal.c" + line="2714">Destroy all signal handlers of a type instance. This function is an implementation detail of the #GObject dispose implementation, and should not be used outside of the type system. - + The instance whose signal handlers are destroyed + filename="gobject/gsignal.c" + line="2716">The instance whose signal handlers are destroyed @@ -25615,20 +26603,19 @@ and should not be used outside of the type system. version="2.32" introspectable="0"> Disconnects all handlers on an instance that match @data. - + filename="gobject/gsignal.h" + line="594">Disconnects all handlers on an instance that match @data. + The instance to remove handlers from + filename="gobject/gsignal.h" + line="596">The instance to remove handlers from the closure data of the handlers' closures + filename="gobject/gsignal.h" + line="597">the closure data of the handlers' closures @@ -25636,33 +26623,32 @@ and should not be used outside of the type system. c:identifier="g_signal_handlers_disconnect_by_func" introspectable="0"> Disconnects all handlers on an instance that match @func and @data. - + filename="gobject/gsignal.h" + line="579">Disconnects all handlers on an instance that match @func and @data. + The instance to remove handlers from. + filename="gobject/gsignal.h" + line="581">The instance to remove handlers from. The C closure callback of the handlers (useless for non-C closures). + filename="gobject/gsignal.h" + line="582">The C closure callback of the handlers (useless for non-C closures). The closure data of the handlers' closures. + filename="gobject/gsignal.h" + line="583">The closure data of the handlers' closures. Disconnects all handlers on an instance that match a certain + filename="gobject/gsignal.c" + line="2954">Disconnects all handlers on an instance that match a certain selection criteria. The criteria mask is passed as a combination of #GSignalMatchType flags, and @@ -25676,38 +26662,37 @@ matches. If no handlers were found, 0 is returned, the number of disconnected handlers otherwise. Support for %G_SIGNAL_MATCH_ID was added in GLib 2.78. - + The number of handlers that matched. + filename="gobject/gsignal.c" + line="2980">The number of handlers that matched. The instance to remove handlers from. + filename="gobject/gsignal.c" + line="2956">The instance to remove handlers from. Mask indicating which of @signal_id, @detail, @closure, @func + filename="gobject/gsignal.c" + line="2957">Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match. Signal the handlers have to be connected to. + filename="gobject/gsignal.c" + line="2959">Signal the handlers have to be connected to. Signal detail the handlers have to be connected to. + filename="gobject/gsignal.c" + line="2960">Signal detail the handlers have to be connected to. nullable="1" allow-none="1"> The closure the handlers will invoke. + filename="gobject/gsignal.c" + line="2961">The closure the handlers will invoke. nullable="1" allow-none="1"> The C closure callback of the handlers (useless for non-C closures). + filename="gobject/gsignal.c" + line="2962">The C closure callback of the handlers (useless for non-C closures). allow-none="1" closure="4"> The closure data of the handlers' closures. + filename="gobject/gsignal.c" + line="2963">The closure data of the handlers' closures. @@ -25744,33 +26729,32 @@ Support for %G_SIGNAL_MATCH_ID was added in GLib 2.78. c:identifier="g_signal_handlers_unblock_by_func" introspectable="0"> Unblocks all handlers on an instance that match @func and @data. - + filename="gobject/gsignal.h" + line="622">Unblocks all handlers on an instance that match @func and @data. + The instance to unblock handlers from. + filename="gobject/gsignal.h" + line="624">The instance to unblock handlers from. The C closure callback of the handlers (useless for non-C closures). + filename="gobject/gsignal.h" + line="625">The C closure callback of the handlers (useless for non-C closures). The closure data of the handlers' closures. + filename="gobject/gsignal.h" + line="626">The closure data of the handlers' closures. Unblocks all handlers on an instance that match a certain selection + filename="gobject/gsignal.c" + line="2898">Unblocks all handlers on an instance that match a certain selection criteria. The criteria mask is passed as a combination of #GSignalMatchType flags, and @@ -25785,38 +26769,37 @@ otherwise. The match criteria should not apply to any handlers that are not currently blocked. Support for %G_SIGNAL_MATCH_ID was added in GLib 2.78. - + The number of handlers that matched. + filename="gobject/gsignal.c" + line="2925">The number of handlers that matched. The instance to unblock handlers from. + filename="gobject/gsignal.c" + line="2900">The instance to unblock handlers from. Mask indicating which of @signal_id, @detail, @closure, @func + filename="gobject/gsignal.c" + line="2901">Mask indicating which of @signal_id, @detail, @closure, @func and/or @data the handlers have to match. Signal the handlers have to be connected to. + filename="gobject/gsignal.c" + line="2903">Signal the handlers have to be connected to. Signal detail the handlers have to be connected to. + filename="gobject/gsignal.c" + line="2904">Signal detail the handlers have to be connected to. nullable="1" allow-none="1"> The closure the handlers will invoke. + filename="gobject/gsignal.c" + line="2905">The closure the handlers will invoke. nullable="1" allow-none="1"> The C closure callback of the handlers (useless for non-C closures). + filename="gobject/gsignal.c" + line="2906">The C closure callback of the handlers (useless for non-C closures). allow-none="1" closure="4"> The closure data of the handlers' closures. + filename="gobject/gsignal.c" + line="2907">The closure data of the handlers' closures. @@ -25852,8 +26835,8 @@ Support for %G_SIGNAL_MATCH_ID was added in GLib 2.78. Returns whether there are any handlers connected to @instance for the + filename="gobject/gsignal.c" + line="3009">Returns whether there are any handlers connected to @instance for the given signal id and detail. If @detail is 0 then it will only match handlers that were connected @@ -25869,38 +26852,37 @@ One example of when you might use this is when the arguments to the signal are difficult to compute. A class implementor may opt to not emit the signal if no one is attached anyway, thus saving the cost of building the arguments. - + %TRUE if a handler is connected to the signal, %FALSE + filename="gobject/gsignal.c" + line="3033">%TRUE if a handler is connected to the signal, %FALSE otherwise. the object whose signal handlers are sought. + filename="gobject/gsignal.c" + line="3011">the object whose signal handlers are sought. the signal id. + filename="gobject/gsignal.c" + line="3012">the signal id. the detail. + filename="gobject/gsignal.c" + line="3013">the detail. whether blocked handlers should count as match. + filename="gobject/gsignal.c" + line="3014">whether blocked handlers should count as match. @@ -25909,42 +26891,40 @@ of building the arguments. c:identifier="g_signal_is_valid_name" version="2.66"> Validate a signal name. This can be useful for dynamically-generated signals + filename="gobject/gsignal.c" + line="279">Validate a signal name. This can be useful for dynamically-generated signals which need to be validated at run-time before actually trying to create them. See [canonical parameter names][canonical-parameter-names] for details of the rules for valid names. The rules for signal names are the same as those for property names. - + %TRUE if @name is a valid signal name, %FALSE otherwise. + filename="gobject/gsignal.c" + line="290">%TRUE if @name is a valid signal name, %FALSE otherwise. the canonical name of the signal + filename="gobject/gsignal.c" + line="281">the canonical name of the signal Lists the signals by id that a certain instance or interface type + filename="gobject/gsignal.c" + line="1238">Lists the signals by id that a certain instance or interface type created. Further information about the signals can be acquired through g_signal_query(). - + Newly allocated array of signal IDs. + filename="gobject/gsignal.c" + line="1247">Newly allocated array of signal IDs. @@ -25952,8 +26932,8 @@ g_signal_query(). Instance or interface type. + filename="gobject/gsignal.c" + line="1240">Instance or interface type. caller-allocates="0" transfer-ownership="full"> Location to store the number of signal ids for @itype. + filename="gobject/gsignal.c" + line="1241">Location to store the number of signal ids for @itype. Given the name of the signal and the type of object it connects to, gets + filename="gobject/gsignal.c" + line="1194">Given the name of the signal and the type of object it connects to, gets the signal's identifying integer. Emitting the signal by number is somewhat faster than using the name each time. @@ -25981,56 +26961,54 @@ example, using g_type_class_ref()) for this function to work, as signals are always installed during class initialization. See g_signal_new() for details on allowed signal names. - + the signal's identifying number, or 0 if no signal was found. + filename="gobject/gsignal.c" + line="1211">the signal's identifying number, or 0 if no signal was found. the signal's name. + filename="gobject/gsignal.c" + line="1196">the signal's name. the type that the signal operates on. + filename="gobject/gsignal.c" + line="1197">the type that the signal operates on. Given the signal's identifier, finds its name. + filename="gobject/gsignal.c" + line="1290">Given the signal's identifier, finds its name. Two different signals may have the same name, if they have differing types. - + the signal name, or %NULL if the signal number was invalid. + filename="gobject/gsignal.c" + line="1298">the signal name, or %NULL if the signal number was invalid. the signal's identifying number. + filename="gobject/gsignal.c" + line="1292">the signal's identifying number. Creates a new signal. (This is usually done in the class initializer.) + filename="gobject/gsignal.c" + line="1352">Creates a new signal. (This is usually done in the class initializer.) A signal name consists of segments consisting of ASCII letters and digits, separated by either the `-` or `_` character. The first @@ -26054,40 +27032,39 @@ instead of g_cclosure_marshal_generic(). If @c_marshaller is non-%NULL, you need to also specify a va_marshaller using g_signal_set_va_marshaller() or the generic va_marshaller will be used. - + the signal id + filename="gobject/gsignal.c" + line="1397">the signal id the name for the signal + filename="gobject/gsignal.c" + line="1354">the name for the signal the type this signal pertains to. It will also pertain to + filename="gobject/gsignal.c" + line="1355">the type this signal pertains to. It will also pertain to types which are derived from this type. a combination of #GSignalFlags specifying detail of when + filename="gobject/gsignal.c" + line="1357">a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. The offset of the function pointer in the class structure + filename="gobject/gsignal.c" + line="1360">The offset of the function pointer in the class structure for this type. Used to invoke a class method generically. Pass 0 to not associate a class method slot with this signal. @@ -26096,10 +27073,11 @@ be used. transfer-ownership="none" nullable="1" allow-none="1" + scope="forever" closure="5"> the accumulator for this signal; may be %NULL. + filename="gobject/gsignal.c" + line="1363">the accumulator for this signal; may be %NULL. allow-none="1" closure="4"> user data for the @accumulator. + filename="gobject/gsignal.c" + line="1364">user data for the @accumulator. nullable="1" allow-none="1"> the function to translate arrays of parameter + filename="gobject/gsignal.c" + line="1365">the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL. the type of return value, or %G_TYPE_NONE for a signal + filename="gobject/gsignal.c" + line="1367">the type of return value, or %G_TYPE_NONE for a signal without a return value. the number of parameter types to follow. + filename="gobject/gsignal.c" + line="1369">the number of parameter types to follow. a list of types, one for each parameter. + filename="gobject/gsignal.c" + line="1370">a list of types, one for each parameter. @@ -26148,8 +27126,8 @@ be used. version="2.18" introspectable="0"> Creates a new signal. (This is usually done in the class initializer.) + filename="gobject/gsignal.c" + line="1428">Creates a new signal. (This is usually done in the class initializer.) This is a variant of g_signal_new() that takes a C callback instead of a class offset for the signal's class handler. This function @@ -26165,32 +27143,31 @@ See g_signal_new() for information about signal names. If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as the marshaller for this signal. - + the signal id + filename="gobject/gsignal.c" + line="1465">the signal id the name for the signal + filename="gobject/gsignal.c" + line="1430">the name for the signal the type this signal pertains to. It will also pertain to + filename="gobject/gsignal.c" + line="1431">the type this signal pertains to. It will also pertain to types which are derived from this type. a combination of #GSignalFlags specifying detail of when + filename="gobject/gsignal.c" + line="1433">a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. @@ -26198,10 +27175,11 @@ the marshaller for this signal. + allow-none="1" + scope="forever"> a #GCallback which acts as class implementation of + filename="gobject/gsignal.c" + line="1436">a #GCallback which acts as class implementation of this signal. Used to invoke a class method generically. Pass %NULL to not associate a class method with this signal. @@ -26210,10 +27188,11 @@ the marshaller for this signal. transfer-ownership="none" nullable="1" allow-none="1" + scope="forever" closure="5"> the accumulator for this signal; may be %NULL. + filename="gobject/gsignal.c" + line="1439">the accumulator for this signal; may be %NULL. allow-none="1" closure="4"> user data for the @accumulator. + filename="gobject/gsignal.c" + line="1440">user data for the @accumulator. nullable="1" allow-none="1"> the function to translate arrays of parameter + filename="gobject/gsignal.c" + line="1441">the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL. the type of return value, or %G_TYPE_NONE for a signal + filename="gobject/gsignal.c" + line="1443">the type of return value, or %G_TYPE_NONE for a signal without a return value. the number of parameter types to follow. + filename="gobject/gsignal.c" + line="1445">the number of parameter types to follow. a list of types, one for each parameter. + filename="gobject/gsignal.c" + line="1446">a list of types, one for each parameter. @@ -26261,39 +27240,38 @@ the marshaller for this signal. c:identifier="g_signal_new_valist" introspectable="0"> Creates a new signal. (This is usually done in the class initializer.) + filename="gobject/gsignal.c" + line="1828">Creates a new signal. (This is usually done in the class initializer.) See g_signal_new() for details on allowed signal names. If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as the marshaller for this signal. - + the signal id + filename="gobject/gsignal.c" + line="1853">the signal id the name for the signal + filename="gobject/gsignal.c" + line="1830">the name for the signal the type this signal pertains to. It will also pertain to + filename="gobject/gsignal.c" + line="1831">the type this signal pertains to. It will also pertain to types which are derived from this type. a combination of #GSignalFlags specifying detail of when + filename="gobject/gsignal.c" + line="1833">a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. @@ -26303,18 +27281,19 @@ the marshaller for this signal. nullable="1" allow-none="1"> The closure to invoke on signal emission; may be %NULL. + filename="gobject/gsignal.c" + line="1836">The closure to invoke on signal emission; may be %NULL. the accumulator for this signal; may be %NULL. + filename="gobject/gsignal.c" + line="1837">the accumulator for this signal; may be %NULL. allow-none="1" closure="4"> user data for the @accumulator. + filename="gobject/gsignal.c" + line="1838">user data for the @accumulator. nullable="1" allow-none="1"> the function to translate arrays of parameter + filename="gobject/gsignal.c" + line="1839">the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL. the type of return value, or %G_TYPE_NONE for a signal + filename="gobject/gsignal.c" + line="1841">the type of return value, or %G_TYPE_NONE for a signal without a return value. the number of parameter types in @args. + filename="gobject/gsignal.c" + line="1843">the number of parameter types in @args. va_list of #GType, one for each parameter. + filename="gobject/gsignal.c" + line="1844">va_list of #GType, one for each parameter. - + Creates a new signal. (This is usually done in the class initializer.) + filename="gobject/gsignal.c" + line="1566">Creates a new signal. (This is usually done in the class initializer.) See g_signal_new() for details on allowed signal names. If c_marshaller is %NULL, g_cclosure_marshal_generic() will be used as the marshaller for this signal. - + the signal id + filename="gobject/gsignal.c" + line="1594">the signal id the name for the signal + filename="gobject/gsignal.c" + line="1568">the name for the signal the type this signal pertains to. It will also pertain to + filename="gobject/gsignal.c" + line="1569">the type this signal pertains to. It will also pertain to types which are derived from this type a combination of #GSignalFlags specifying detail of when + filename="gobject/gsignal.c" + line="1571">a combination of #GSignalFlags specifying detail of when the default handler is to be invoked. You should at least specify %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST @@ -26404,8 +27380,8 @@ the marshaller for this signal. nullable="1" allow-none="1"> The closure to invoke on signal emission; + filename="gobject/gsignal.c" + line="1574">The closure to invoke on signal emission; may be %NULL @@ -26413,10 +27389,11 @@ the marshaller for this signal. transfer-ownership="none" nullable="1" allow-none="1" + scope="forever" closure="5"> the accumulator for this signal; may be %NULL + filename="gobject/gsignal.c" + line="1576">the accumulator for this signal; may be %NULL allow-none="1" closure="4"> user data for the @accumulator + filename="gobject/gsignal.c" + line="1577">user data for the @accumulator nullable="1" allow-none="1"> the function to translate arrays of + filename="gobject/gsignal.c" + line="1578">the function to translate arrays of parameter values to signal emissions into C language callback invocations or %NULL the type of return value, or %G_TYPE_NONE for a signal + filename="gobject/gsignal.c" + line="1581">the type of return value, or %G_TYPE_NONE for a signal without a return value the length of @param_types + filename="gobject/gsignal.c" + line="1583">the length of @param_types nullable="1" allow-none="1"> an array of types, one for + filename="gobject/gsignal.c" + line="1584">an array of types, one for each parameter (may be %NULL if @n_params is zero) @@ -26470,48 +27447,46 @@ the marshaller for this signal. Overrides the class closure (i.e. the default handler) for the given signal + filename="gobject/gsignal.c" + line="1952">Overrides the class closure (i.e. the default handler) for the given signal for emissions on instances of @instance_type. @instance_type must be derived from the type to which the signal belongs. See g_signal_chain_from_overridden() and g_signal_chain_from_overridden_handler() for how to chain up to the parent class closure from inside the overridden one. - + the signal id + filename="gobject/gsignal.c" + line="1954">the signal id the instance type on which to override the class closure + filename="gobject/gsignal.c" + line="1955">the instance type on which to override the class closure for the signal. the closure. + filename="gobject/gsignal.c" + line="1957">the closure. + version="2.18"> Overrides the class closure (i.e. the default handler) for the + filename="gobject/gsignal.c" + line="1994">Overrides the class closure (i.e. the default handler) for the given signal for emissions on instances of @instance_type with callback @class_handler. @instance_type must be derived from the type to which the signal belongs. @@ -26519,57 +27494,57 @@ type to which the signal belongs. See g_signal_chain_from_overridden() and g_signal_chain_from_overridden_handler() for how to chain up to the parent class closure from inside the overridden one. - + the name for the signal + filename="gobject/gsignal.c" + line="1996">the name for the signal the instance type on which to override the class handler + filename="gobject/gsignal.c" + line="1997">the instance type on which to override the class handler for the signal. - + the handler. + filename="gobject/gsignal.c" + line="1999">the handler. Internal function to parse a signal name into its @signal_id + filename="gobject/gsignal.c" + line="1089">Internal function to parse a signal name into its @signal_id and @detail quark. - + Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values. + filename="gobject/gsignal.c" + line="1100">Whether the signal name could successfully be parsed and @signal_id_p and @detail_p contain valid return values. a string of the form "signal-name::detail". + filename="gobject/gsignal.c" + line="1091">a string of the form "signal-name::detail". The interface/instance type that introduced "signal-name". + filename="gobject/gsignal.c" + line="1092">The interface/instance type that introduced "signal-name". caller-allocates="0" transfer-ownership="full"> Location to store the signal id. + filename="gobject/gsignal.c" + line="1093">Location to store the signal id. caller-allocates="0" transfer-ownership="full"> Location to store the detail quark. + filename="gobject/gsignal.c" + line="1094">Location to store the detail quark. %TRUE forces creation of a #GQuark for the detail. + filename="gobject/gsignal.c" + line="1095">%TRUE forces creation of a #GQuark for the detail. Queries the signal system for in-depth information about a + filename="gobject/gsignal.c" + line="1314">Queries the signal system for in-depth information about a specific signal. This function will fill in a user-provided structure to hold signal-specific information. If an invalid signal id is passed in, the @signal_id member of the #GSignalQuery is 0. All members filled into the #GSignalQuery structure should be considered constant and have to be left untouched. - + The signal id of the signal to query information for. + filename="gobject/gsignal.c" + line="1316">The signal id of the signal to query information for. caller-allocates="1" transfer-ownership="none"> A user provided structure that is + filename="gobject/gsignal.c" + line="1317">A user provided structure that is filled in with constant values upon success. @@ -26634,24 +27608,23 @@ be considered constant and have to be left untouched. Deletes an emission hook. - + filename="gobject/gsignal.c" + line="1009">Deletes an emission hook. + the id of the signal + filename="gobject/gsignal.c" + line="1011">the id of the signal the id of the emission hook, as returned by + filename="gobject/gsignal.c" + line="1012">the id of the emission hook, as returned by g_signal_add_emission_hook() @@ -26661,33 +27634,32 @@ be considered constant and have to be left untouched. c:identifier="g_signal_set_va_marshaller" version="2.32"> Change the #GSignalCVaMarshaller used for a given signal. This is a + filename="gobject/gsignal.c" + line="1786">Change the #GSignalCVaMarshaller used for a given signal. This is a specialised form of the marshaller that can often be used for the common case of a single connected signal handler and avoids the overhead of #GValue. Its use is optional. - + the signal id + filename="gobject/gsignal.c" + line="1788">the signal id the instance type on which to set the marshaller. + filename="gobject/gsignal.c" + line="1789">the instance type on which to set the marshaller. the marshaller to set. + filename="gobject/gsignal.c" + line="1790">the marshaller to set. @@ -26695,36 +27667,35 @@ overhead of #GValue. Its use is optional. Stops a signal's current emission. + filename="gobject/gsignal.c" + line="867">Stops a signal's current emission. This will prevent the default method from running, if the signal was %G_SIGNAL_RUN_LAST and you connected normally (i.e. without the "after" flag). Prints a warning if used on a signal which isn't being emitted. - + the object whose signal handlers you wish to stop. + filename="gobject/gsignal.c" + line="869">the object whose signal handlers you wish to stop. the signal identifier, as returned by g_signal_lookup(). + filename="gobject/gsignal.c" + line="870">the signal identifier, as returned by g_signal_lookup(). the detail which the signal was emitted with. + filename="gobject/gsignal.c" + line="871">the detail which the signal was emitted with. @@ -26732,27 +27703,26 @@ Prints a warning if used on a signal which isn't being emitted. Stops a signal's current emission. + filename="gobject/gsignal.c" + line="1138">Stops a signal's current emission. This is just like g_signal_stop_emission() except it will look up the signal id for you. - + the object whose signal handlers you wish to stop. + filename="gobject/gsignal.c" + line="1140">the object whose signal handlers you wish to stop. a string of the form "signal-name::detail". + filename="gobject/gsignal.c" + line="1141">a string of the form "signal-name::detail". @@ -26760,155 +27730,68 @@ signal id for you. Creates a new closure which invokes the function found at the offset + filename="gobject/gclosure.c" + line="1157">Creates a new closure which invokes the function found at the offset @struct_offset in the class structure of the interface or classed type identified by @itype. - - + + a floating reference to a new #GCClosure + filename="gobject/gclosure.c" + line="1167">a floating reference to a new #GCClosure the #GType identifier of an interface or classed type + filename="gobject/gclosure.c" + line="1159">the #GType identifier of an interface or classed type the offset of the member function of @itype's class + filename="gobject/gclosure.c" + line="1160">the offset of the member function of @itype's class structure which is to be invoked by the new closure - - The basic concept of the signal system is that of the emission -of a signal. Signals are introduced per-type and are identified -through strings. Signals introduced for a parent type are available -in derived types as well, so basically they are a per-type facility -that is inherited. - -A signal emission mainly involves invocation of a certain set of -callbacks in precisely defined manner. There are two main categories -of such callbacks, per-object ones and user provided ones. -(Although signals can deal with any kind of instantiatable type, I'm -referring to those types as "object types" in the following, simply -because that is the context most users will encounter signals in.) -The per-object callbacks are most often referred to as "object method -handler" or "default (signal) handler", while user provided callbacks are -usually just called "signal handler". - -The object method handler is provided at signal creation time (this most -frequently happens at the end of an object class' creation), while user -provided handlers are frequently connected and disconnected to/from a -certain signal on certain object instances. - -A signal emission consists of five stages, unless prematurely stopped: - -1. Invocation of the object method handler for %G_SIGNAL_RUN_FIRST signals - -2. Invocation of normal user-provided signal handlers (where the @after - flag is not set) - -3. Invocation of the object method handler for %G_SIGNAL_RUN_LAST signals - -4. Invocation of user provided signal handlers (where the @after flag is set) - -5. Invocation of the object method handler for %G_SIGNAL_RUN_CLEANUP signals - -The user-provided signal handlers are called in the order they were -connected in. - -All handlers may prematurely stop a signal emission, and any number of -handlers may be connected, disconnected, blocked or unblocked during -a signal emission. - -There are certain criteria for skipping user handlers in stages 2 and 4 -of a signal emission. - -First, user handlers may be blocked. Blocked handlers are omitted during -callback invocation, to return from the blocked state, a handler has to -get unblocked exactly the same amount of times it has been blocked before. - -Second, upon emission of a %G_SIGNAL_DETAILED signal, an additional -@detail argument passed in to g_signal_emit() has to match the detail -argument of the signal handler currently subject to invocation. -Specification of no detail argument for signal handlers (omission of the -detail part of the signal specification upon connection) serves as a -wildcard and matches any detail argument passed in to emission. - -While the @detail argument is typically used to pass an object property name -(as with #GObject::notify), no specific format is mandated for the detail -string, other than that it must be non-empty. - -## Memory management of signal handlers # {#signal-memory-management} - -If you are connecting handlers to signals and using a #GObject instance as -your signal handler user data, you should remember to pair calls to -g_signal_connect() with calls to g_signal_handler_disconnect() or -g_signal_handlers_disconnect_by_func(). While signal handlers are -automatically disconnected when the object emitting the signal is finalised, -they are not automatically disconnected when the signal handler user data is -destroyed. If this user data is a #GObject instance, using it from a -signal handler after it has been finalised is an error. - -There are two strategies for managing such user data. The first is to -disconnect the signal handler (using g_signal_handler_disconnect() or -g_signal_handlers_disconnect_by_func()) when the user data (object) is -finalised; this has to be implemented manually. For non-threaded programs, -g_signal_connect_object() can be used to implement this automatically. -Currently, however, it is unsafe to use in threaded programs. - -The second is to hold a strong reference on the user data until after the -signal is disconnected for other reasons. This can be implemented -automatically using g_signal_connect_data(). - -The first approach is recommended, as the second approach can result in -effective memory leaks of the user data if the signal handler is never -disconnected for some reason. - - - Set the callback for a source as a #GClosure. + + Set the callback for a source as a #GClosure. If the source is not one of the standard GLib types, the @closure_callback and @closure_marshal fields of the #GSourceFuncs structure must have been filled in with pointers to appropriate functions. - + the source + filename="gobject/gsourceclosure.c" + line="237">the source a #GClosure + filename="gobject/gsourceclosure.c" + line="238">a #GClosure + c:identifier="g_source_set_dummy_callback" + moved-to="Source.set_dummy_callback"> Sets a dummy callback for @source. The callback will do nothing, and + filename="gobject/gsourceclosure.c" + line="301">Sets a dummy callback for @source. The callback will do nothing, and if the source expects a #gboolean return value, it will return %TRUE. (If the source expects any other type of return value, it will return a 0/%NULL value; whatever g_value_init() initializes a #GValue to for @@ -26918,16 +27801,15 @@ If the source is not one of the standard GLib types, the @closure_callback and @closure_marshal fields of the #GSourceFuncs structure must have been filled in with pointers to appropriate functions. - + the source + filename="gobject/gsourceclosure.c" + line="303">the source @@ -26935,24 +27817,23 @@ functions. Return a newly allocated string, which describes the contents of a + filename="gobject/gvaluetypes.c" + line="1380">Return a newly allocated string, which describes the contents of a #GValue. The main purpose of this function is to describe #GValue contents for debugging output, the way in which the contents are described may change between different GLib versions. - + Newly allocated string. + filename="gobject/gvaluetypes.c" + line="1389">Newly allocated string. #GValue which contents are to be described. + filename="gobject/gvaluetypes.c" + line="1382">#GValue which contents are to be described. @@ -26961,16 +27842,15 @@ described may change between different GLib versions. c:identifier="g_type_add_class_cache_func" introspectable="0"> Adds a #GTypeClassCacheFunc to be called before the reference count of a + filename="gobject/gtype.c" + line="2544">Adds a #GTypeClassCacheFunc to be called before the reference count of a class goes from one to zero. This can be used to prevent premature class destruction. All installed #GTypeClassCacheFunc functions will be chained until one of them returns %TRUE. The functions have to check the class id passed in to figure whether they actually want to cache the class of this type, since all classes are routed through the same #GTypeClassCacheFunc chain. - + @@ -26980,14 +27860,14 @@ chain. nullable="1" allow-none="1"> data to be passed to @cache_func + filename="gobject/gtype.c" + line="2546">data to be passed to @cache_func a #GTypeClassCacheFunc + filename="gobject/gtype.c" + line="2547">a #GTypeClassCacheFunc @@ -26996,8 +27876,8 @@ chain. c:identifier="g_type_add_class_private" version="2.24"> Registers a private class structure for a classed type; + filename="gobject/gtype.c" + line="4958">Registers a private class structure for a classed type; when the class is allocated, the private structures for the class and all of its parent types are allocated sequentially in the same memory block as the public @@ -27007,30 +27887,28 @@ This function should be called in the type's get_type() function after the type is registered. The private structure can be retrieved using the G_TYPE_CLASS_GET_PRIVATE() macro. - + GType of a classed type + filename="gobject/gtype.c" + line="4960">GType of a classed type size of private structure + filename="gobject/gtype.c" + line="4961">size of private structure - + @@ -27048,8 +27926,8 @@ G_TYPE_CLASS_GET_PRIVATE() macro. version="2.4" introspectable="0"> Adds a function to be called after an interface vtable is + filename="gobject/gtype.c" + line="2612">Adds a function to be called after an interface vtable is initialized for any class (i.e. after the @interface_init member of #GInterfaceInfo has been called). @@ -27058,8 +27936,7 @@ that depends on the interfaces of a class. For instance, the implementation of #GObject uses this facility to check that an object implements all of the properties that are defined on its interfaces. - + @@ -27069,14 +27946,14 @@ interfaces. nullable="1" allow-none="1"> data to pass to @check_func + filename="gobject/gtype.c" + line="2614">data to pass to @check_func function to be called after each interface + filename="gobject/gtype.c" + line="2615">function to be called after each interface is initialized @@ -27086,32 +27963,31 @@ interfaces. Adds @interface_type to the dynamic @instance_type. The information + filename="gobject/gtype.c" + line="2942">Adds @interface_type to the dynamic @instance_type. The information contained in the #GTypePlugin structure pointed to by @plugin is used to manage the relationship. - + #GType value of an instantiatable type + filename="gobject/gtype.c" + line="2944">#GType value of an instantiatable type #GType value of an interface type + filename="gobject/gtype.c" + line="2945">#GType value of an interface type #GTypePlugin structure to retrieve the #GInterfaceInfo from + filename="gobject/gtype.c" + line="2946">#GTypePlugin structure to retrieve the #GInterfaceInfo from @@ -27119,32 +27995,31 @@ is used to manage the relationship. Adds @interface_type to the static @instance_type. + filename="gobject/gtype.c" + line="2905">Adds @interface_type to the static @instance_type. The information contained in the #GInterfaceInfo structure pointed to by @info is used to manage the relationship. - + #GType value of an instantiatable type + filename="gobject/gtype.c" + line="2907">#GType value of an instantiatable type #GType value of an interface type + filename="gobject/gtype.c" + line="2908">#GType value of an interface type #GInterfaceInfo structure for this + filename="gobject/gtype.c" + line="2909">#GInterfaceInfo structure for this (@instance_type, @interface_type) combination @@ -27153,8 +28028,7 @@ pointed to by @info is used to manage the relationship. - + @@ -27169,8 +28043,7 @@ pointed to by @info is used to manage the relationship. - + @@ -27185,22 +28058,21 @@ pointed to by @info is used to manage the relationship. Private helper function to aid implementation of the + filename="gobject/gtype.c" + line="4240">Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE() macro. - + %TRUE if @instance is valid, %FALSE otherwise + filename="gobject/gtype.c" + line="4247">%TRUE if @instance is valid, %FALSE otherwise a valid #GTypeInstance structure + filename="gobject/gtype.c" + line="4242">a valid #GTypeInstance structure @@ -27208,8 +28080,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -27224,8 +28095,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -27240,8 +28110,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -27256,8 +28125,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -27268,8 +28136,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -27281,8 +28148,7 @@ G_TYPE_CHECK_INSTANCE() macro. - + @@ -27297,15 +28163,14 @@ G_TYPE_CHECK_INSTANCE() macro. Return a newly allocated and 0-terminated array of type IDs, listing + filename="gobject/gtype.c" + line="3618">Return a newly allocated and 0-terminated array of type IDs, listing the child types of @type. - + Newly allocated + filename="gobject/gtype.c" + line="3627">Newly allocated and 0-terminated array of child types, free with g_free() @@ -27314,8 +28179,8 @@ the child types of @type. the parent type + filename="gobject/gtype.c" + line="3620">the parent type optional="1" allow-none="1"> location to store the length of + filename="gobject/gtype.c" + line="3621">location to store the length of the returned array, or %NULL @@ -27335,8 +28200,7 @@ the child types of @type. - + @@ -27356,18 +28220,17 @@ the child types of @type. c:identifier="g_type_class_peek" moved-to="TypeClass.peek"> This function is essentially the same as g_type_class_ref(), + filename="gobject/gtype.c" + line="3096">This function is essentially the same as g_type_class_ref(), except that the classes reference count isn't incremented. As a consequence, this function may return %NULL if the class of the type passed in does not currently exist (hasn't been referenced before). - + the #GTypeClass + filename="gobject/gtype.c" + line="3106">the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist @@ -27375,8 +28238,8 @@ referenced before). type ID of a classed type + filename="gobject/gtype.c" + line="3098">type ID of a classed type @@ -27386,15 +28249,14 @@ referenced before). moved-to="TypeClass.peek_static" version="2.4"> A more efficient version of g_type_class_peek() which works only for + filename="gobject/gtype.c" + line="3127">A more efficient version of g_type_class_peek() which works only for static types. - + the #GTypeClass + filename="gobject/gtype.c" + line="3134">the #GTypeClass structure for the given type ID or %NULL if the class does not currently exist or is dynamically loaded @@ -27402,8 +28264,8 @@ static types. type ID of a classed type + filename="gobject/gtype.c" + line="3129">type ID of a classed type @@ -27412,24 +28274,23 @@ static types. c:identifier="g_type_class_ref" moved-to="TypeClass.ref"> Increments the reference count of the class structure belonging to + filename="gobject/gtype.c" + line="2980">Increments the reference count of the class structure belonging to @type. This function will demand-create the class if it doesn't exist already. - + the #GTypeClass + filename="gobject/gtype.c" + line="2988">the #GTypeClass structure for the given type ID type ID of a classed type + filename="gobject/gtype.c" + line="2982">type ID of a classed type @@ -27438,8 +28299,8 @@ exist already. c:identifier="g_type_create_instance" introspectable="0"> Creates and initializes an instance of @type if @type is valid and + filename="gobject/gtype.c" + line="1843">Creates and initializes an instance of @type if @type is valid and can be instantiated. The type system only performs basic allocation and structure setups for instances: actual instance creation should happen through functions supplied by the type's fundamental type @@ -27455,20 +28316,19 @@ with zeros. Note: Do not use this function, unless you're implementing a fundamental type. Also language bindings should not use this function, but g_object_new() instead. - + an allocated and initialized instance, subject to further + filename="gobject/gtype.c" + line="1864">an allocated and initialized instance, subject to further treatment by the fundamental type implementation an instantiatable type to create an instance for + filename="gobject/gtype.c" + line="1845">an instantiatable type to create an instance for @@ -27477,15 +28337,14 @@ function, but g_object_new() instead. c:identifier="g_type_default_interface_peek" version="2.4"> If the interface type @g_type is currently in use, returns its + filename="gobject/gtype.c" + line="3329">If the interface type @g_type is currently in use, returns its default interface vtable. - + the default + filename="gobject/gtype.c" + line="3338">the default vtable for the interface, or %NULL if the type is not currently in use @@ -27493,8 +28352,8 @@ default interface vtable. an interface type + filename="gobject/gtype.c" + line="3331">an interface type @@ -27503,8 +28362,8 @@ default interface vtable. c:identifier="g_type_default_interface_ref" version="2.4"> Increments the reference count for the interface type @g_type, + filename="gobject/gtype.c" + line="3271">Increments the reference count for the interface type @g_type, and returns the default interface vtable for the type. If the type is not currently in use, then the default vtable @@ -27514,12 +28373,11 @@ the type (the @base_init and @class_init members of #GTypeInfo). Calling g_type_default_interface_ref() is useful when you want to make sure that signals and properties for an interface have been installed. - + the default + filename="gobject/gtype.c" + line="3288">the default vtable for the interface; call g_type_default_interface_unref() when you are done using the interface. @@ -27527,8 +28385,8 @@ have been installed. an interface type + filename="gobject/gtype.c" + line="3273">an interface type @@ -27537,22 +28395,21 @@ have been installed. c:identifier="g_type_default_interface_unref" version="2.4"> Decrements the reference count for the type corresponding to the + filename="gobject/gtype.c" + line="3357">Decrements the reference count for the type corresponding to the interface default vtable @g_iface. If the type is dynamic, then when no one is using the interface and all references have been released, the finalize function for the interface's default vtable (the @class_finalize member of #GTypeInfo) will be called. - + the default vtable + filename="gobject/gtype.c" + line="3359">the default vtable structure for an interface, as returned by g_type_default_interface_ref() @@ -27560,30 +28417,29 @@ vtable (the @class_finalize member of #GTypeInfo) will be called. Returns the length of the ancestry of the passed in type. This + filename="gobject/gtype.c" + line="3472">Returns the length of the ancestry of the passed in type. This includes the type itself, so that e.g. a fundamental type has depth 1. - + the depth of @type + filename="gobject/gtype.c" + line="3479">the depth of @type a #GType + filename="gobject/gtype.c" + line="3474">a #GType Ensures that the indicated @type has been registered with the + filename="gobject/gtype.c" + line="5056">Ensures that the indicated @type has been registered with the type system, and its _class_init() method has been run. In theory, simply calling the type's _get_type() method (or using @@ -27595,84 +28451,80 @@ which _get_type() methods do on the first call). As a result, if you write a bare call to a _get_type() macro, it may get optimized out by the compiler. Using g_type_ensure() guarantees that the type's _get_type() method is called. - + a #GType + filename="gobject/gtype.c" + line="5058">a #GType Frees an instance of a type, returning it to the instance pool for + filename="gobject/gtype.c" + line="1965">Frees an instance of a type, returning it to the instance pool for the type, if there is one. Like g_type_create_instance(), this function is reserved for implementors of fundamental types. - + an instance of a type + filename="gobject/gtype.c" + line="1967">an instance of a type Look up the type ID from a given type name, returning 0 if no type + filename="gobject/gtype.c" + line="3428">Look up the type ID from a given type name, returning 0 if no type has been registered under this name (this is the preferred method to find out by name whether a specific type has been registered yet). - + corresponding type ID or 0 + filename="gobject/gtype.c" + line="3437">corresponding type ID or 0 type name to look up + filename="gobject/gtype.c" + line="3430">type name to look up Internal function, used to extract the fundamental type ID portion. + filename="gobject/gtype.c" + line="4109">Internal function, used to extract the fundamental type ID portion. Use G_TYPE_FUNDAMENTAL() instead. - + fundamental type ID + filename="gobject/gtype.c" + line="4116">fundamental type ID valid type ID + filename="gobject/gtype.c" + line="4111">valid type ID @@ -27680,17 +28532,16 @@ Use G_TYPE_FUNDAMENTAL() instead. Returns the next free fundamental type id which can be used to + filename="gobject/gtype.c" + line="4086">Returns the next free fundamental type id which can be used to register a new fundamental type with g_type_register_fundamental(). The returned type ID represents the highest currently registered fundamental type identifier. - + the next available fundamental type ID to be registered, + filename="gobject/gtype.c" + line="4094">the next available fundamental type ID to be registered, or 0 if the type system ran out of fundamental type IDs @@ -27699,79 +28550,76 @@ fundamental type identifier. c:identifier="g_type_get_instance_count" version="2.44"> Returns the number of instances allocated of the particular type; + filename="gobject/gtype.c" + line="3924">Returns the number of instances allocated of the particular type; this is only available if GLib is built with debugging support and the `instance-count` debug flag is set (by setting the `GOBJECT_DEBUG` variable to include `instance-count`). - + the number of instances allocated of the given type; + filename="gobject/gtype.c" + line="3933">the number of instances allocated of the given type; if instance counts are not available, returns 0. a #GType + filename="gobject/gtype.c" + line="3926">a #GType Returns the #GTypePlugin structure for @type. - + filename="gobject/gtype.c" + line="4018">Returns the #GTypePlugin structure for @type. + the corresponding plugin + filename="gobject/gtype.c" + line="4024">the corresponding plugin if @type is a dynamic type, %NULL otherwise #GType to retrieve the plugin for + filename="gobject/gtype.c" + line="4020">#GType to retrieve the plugin for Obtains data which has previously been attached to @type + filename="gobject/gtype.c" + line="3762">Obtains data which has previously been attached to @type with g_type_set_qdata(). Note that this does not take subtyping into account; data attached to one type with g_type_set_qdata() cannot be retrieved from a subtype using g_type_get_qdata(). - + the data, or %NULL if no data was found + filename="gobject/gtype.c" + line="3774">the data, or %NULL if no data was found a #GType + filename="gobject/gtype.c" + line="3764">a #GType a #GQuark id to identify the data + filename="gobject/gtype.c" + line="3765">a #GQuark id to identify the data @@ -27780,18 +28628,17 @@ be retrieved from a subtype using g_type_get_qdata(). c:identifier="g_type_get_type_registration_serial" version="2.36"> Returns an opaque serial number that represents the state of the set + filename="gobject/gtype.c" + line="376">Returns an opaque serial number that represents the state of the set of registered types. Any time a type is registered this serial changes, which means you can cache information based on type lookups (such as g_type_from_name()) and know if the cache is still valid at a later time by comparing the current serial with the one at the type lookup. - + An unsigned int, representing the state of type registrations + filename="gobject/gtype.c" + line="387">An unsigned int, representing the state of type registrations @@ -27800,13 +28647,12 @@ time by comparing the current serial with the one at the type lookup. deprecated="1" deprecated-version="2.36"> This function used to initialise the type system. Since GLib 2.36, + filename="gobject/gtype.c" + line="4474">This function used to initialise the type system. Since GLib 2.36, the type system is initialised automatically and this function does nothing. the type system is now initialised automatically - + @@ -27816,24 +28662,23 @@ nothing. deprecated="1" deprecated-version="2.36"> This function used to initialise the type system with debugging + filename="gobject/gtype.c" + line="4449">This function used to initialise the type system with debugging flags. Since GLib 2.36, the type system is initialised automatically and this function does nothing. If you need to enable debugging features, use the `GOBJECT_DEBUG` environment variable. the type system is now initialised automatically - + bitwise combination of #GTypeDebugFlags values for + filename="gobject/gtype.c" + line="4451">bitwise combination of #GTypeDebugFlags values for debugging purposes @@ -27843,28 +28688,27 @@ environment variable. c:identifier="g_type_interface_add_prerequisite" moved-to="TypeInterface.add_prerequisite"> Adds @prerequisite_type to the list of prerequisites of @interface_type. + filename="gobject/gtype.c" + line="1536">Adds @prerequisite_type to the list of prerequisites of @interface_type. This means that any type implementing @interface_type must also implement @prerequisite_type. Prerequisites can be thought of as an alternative to interface derivation (which GType doesn't support). An interface can have at most one instantiatable prerequisite type. - + #GType value of an interface type + filename="gobject/gtype.c" + line="1538">#GType value of an interface type #GType value of an interface or instantiatable type + filename="gobject/gtype.c" + line="1539">#GType value of an interface or instantiatable type @@ -27873,31 +28717,30 @@ at most one instantiatable prerequisite type. c:identifier="g_type_interface_get_plugin" moved-to="TypeInterface.get_plugin"> Returns the #GTypePlugin structure for the dynamic interface + filename="gobject/gtype.c" + line="4037">Returns the #GTypePlugin structure for the dynamic interface @interface_type which has been added to @instance_type, or %NULL if @interface_type has not been added to @instance_type or does not have a #GTypePlugin structure. See g_type_add_interface_dynamic(). - + the #GTypePlugin for the dynamic + filename="gobject/gtype.c" + line="4047">the #GTypePlugin for the dynamic interface @interface_type of @instance_type #GType of an instantiatable type + filename="gobject/gtype.c" + line="4039">#GType of an instantiatable type #GType of an interface type + filename="gobject/gtype.c" + line="4040">#GType of an interface type @@ -27907,26 +28750,25 @@ not have a #GTypePlugin structure. See g_type_add_interface_dynamic(). moved-to="TypeInterface.instantiatable_prerequisite" version="2.68"> Returns the most specific instantiatable prerequisite of an + filename="gobject/gtype.c" + line="1683">Returns the most specific instantiatable prerequisite of an interface type. If the interface type has no instantiatable prerequisite, %G_TYPE_INVALID is returned. See g_type_interface_add_prerequisite() for more information about prerequisites. - + the instantiatable prerequisite type or %G_TYPE_INVALID if none + filename="gobject/gtype.c" + line="1694">the instantiatable prerequisite type or %G_TYPE_INVALID if none an interface type + filename="gobject/gtype.c" + line="1685">an interface type @@ -27935,15 +28777,14 @@ about prerequisites. c:identifier="g_type_interface_peek" moved-to="TypeInterface.peek"> Returns the #GTypeInterface structure of an interface to which the + filename="gobject/gtype.c" + line="3202">Returns the #GTypeInterface structure of an interface to which the passed in class conforms. - + the #GTypeInterface + filename="gobject/gtype.c" + line="3210">the #GTypeInterface structure of @iface_type if implemented by @instance_class, %NULL otherwise @@ -27951,14 +28792,14 @@ passed in class conforms. a #GTypeClass structure + filename="gobject/gtype.c" + line="3204">a #GTypeClass structure an interface ID which this class conforms to + filename="gobject/gtype.c" + line="3205">an interface ID which this class conforms to @@ -27968,14 +28809,13 @@ passed in class conforms. moved-to="TypeInterface.prerequisites" version="2.2"> Returns the prerequisites of an interfaces type. - + filename="gobject/gtype.c" + line="1622">Returns the prerequisites of an interfaces type. + a + filename="gobject/gtype.c" + line="1632">a newly-allocated zero-terminated array of #GType containing the prerequisites of @interface_type @@ -27985,8 +28825,8 @@ passed in class conforms. an interface type + filename="gobject/gtype.c" + line="1624">an interface type optional="1" allow-none="1"> location to return the number + filename="gobject/gtype.c" + line="1625">location to return the number of prerequisites, or %NULL @@ -28005,15 +28845,14 @@ passed in class conforms. Return a newly allocated and 0-terminated array of type IDs, listing + filename="gobject/gtype.c" + line="3662">Return a newly allocated and 0-terminated array of type IDs, listing the interface types that @type conforms to. - + Newly allocated + filename="gobject/gtype.c" + line="3671">Newly allocated and 0-terminated array of interface types, free with g_free() @@ -28022,8 +28861,8 @@ the interface types that @type conforms to. the type to list interface types for + filename="gobject/gtype.c" + line="3664">the type to list interface types for optional="1" allow-none="1"> location to store the length of + filename="gobject/gtype.c" + line="3665">location to store the length of the returned array, or %NULL @@ -28042,29 +28881,28 @@ the interface types that @type conforms to. If @is_a_type is a derivable type, check whether @type is a + filename="gobject/gtype.c" + line="3589">If @is_a_type is a derivable type, check whether @type is a descendant of @is_a_type. If @is_a_type is an interface, check whether @type conforms to it. - + %TRUE if @type is a @is_a_type + filename="gobject/gtype.c" + line="3599">%TRUE if @type is a @is_a_type type to check ancestry for + filename="gobject/gtype.c" + line="3591">type to check ancestry for possible ancestor of @type or interface that @type + filename="gobject/gtype.c" + line="3592">possible ancestor of @type or interface that @type could conform to @@ -28072,33 +28910,31 @@ whether @type conforms to it. Get the unique name that is assigned to a type ID. Note that this + filename="gobject/gtype.c" + line="3386">Get the unique name that is assigned to a type ID. Note that this function (like all other GType API) cannot cope with invalid type IDs. %G_TYPE_INVALID may be passed to this function, as may be any other validly registered type ID, but randomized type IDs should not be passed in and will most likely lead to a crash. - + static type name or %NULL + filename="gobject/gtype.c" + line="3396">static type name or %NULL type to return name for + filename="gobject/gtype.c" + line="3388">type to return name for - + @@ -28110,8 +28946,7 @@ not be passed in and will most likely lead to a crash. - + @@ -28123,99 +28958,99 @@ not be passed in and will most likely lead to a crash. Given a @leaf_type and a @root_type which is contained in its + filename="gobject/gtype.c" + line="3491">Given a @leaf_type and a @root_type which is contained in its ancestry, return the type that @root_type is the immediate parent of. In other words, this function determines the type that is derived directly from @root_type which is also a base class of @leaf_type. Given a root type and a leaf type, this function can be used to determine the types and order in which the leaf type is descended from the root type. - + immediate child of @root_type and ancestor of @leaf_type + filename="gobject/gtype.c" + line="3504">immediate child of @root_type and ancestor of @leaf_type descendant of @root_type and the type to be returned + filename="gobject/gtype.c" + line="3493">descendant of @root_type and the type to be returned immediate parent of the returned type + filename="gobject/gtype.c" + line="3494">immediate parent of the returned type Return the direct parent type of the passed in type. If the passed + filename="gobject/gtype.c" + line="3453">Return the direct parent type of the passed in type. If the passed in type has no parent, i.e. is a fundamental type, 0 is returned. - + the parent type + filename="gobject/gtype.c" + line="3460">the parent type the derived type + filename="gobject/gtype.c" + line="3455">the derived type Get the corresponding quark of the type IDs name. - + filename="gobject/gtype.c" + line="3410">Get the corresponding quark of the type IDs name. + the type names quark or 0 + filename="gobject/gtype.c" + line="3416">the type names quark or 0 type to return quark of type name for + filename="gobject/gtype.c" + line="3412">type to return quark of type name for Queries the type system for information about a specific type. + filename="gobject/gtype.c" + line="3881">Queries the type system for information about a specific type. + This function will fill in a user-provided structure to hold type-specific information. If an invalid #GType is passed in, the @type member of the #GTypeQuery is 0. All members filled into the #GTypeQuery structure should be considered constant and have to be -left untouched. - +left untouched. + +Since GLib 2.78, this function allows queries on dynamic types. Previously +it only supported static types. + #GType of a static, classed type + filename="gobject/gtype.c" + line="3883">#GType of a static, classed type caller-allocates="1" transfer-ownership="none"> a user provided structure that is + filename="gobject/gtype.c" + line="3884">a user provided structure that is filled in with constant values upon success @@ -28233,43 +29068,42 @@ left untouched. Registers @type_name as the name of a new dynamic type derived from + filename="gobject/gtype.c" + line="2861">Registers @type_name as the name of a new dynamic type derived from @parent_type. The type system uses the information contained in the #GTypePlugin structure pointed to by @plugin to manage the type and its instances (if not abstract). The value of @flags determines the nature (e.g. abstract or not) of the type. - + the new type identifier or %G_TYPE_INVALID if registration failed + filename="gobject/gtype.c" + line="2874">the new type identifier or %G_TYPE_INVALID if registration failed type from which this type will be derived + filename="gobject/gtype.c" + line="2863">type from which this type will be derived 0-terminated string used as the name of the new type + filename="gobject/gtype.c" + line="2864">0-terminated string used as the name of the new type #GTypePlugin structure to retrieve the #GTypeInfo from + filename="gobject/gtype.c" + line="2865">#GTypePlugin structure to retrieve the #GTypeInfo from bitwise combination of #GTypeFlags values + filename="gobject/gtype.c" + line="2866">bitwise combination of #GTypeFlags values @@ -28277,52 +29111,51 @@ instances (if not abstract). The value of @flags determines the nature Registers @type_id as the predefined identifier and @type_name as the + filename="gobject/gtype.c" + line="2686">Registers @type_id as the predefined identifier and @type_name as the name of a fundamental type. If @type_id is already registered, or a type named @type_name is already registered, the behaviour is undefined. The type system uses the information contained in the #GTypeInfo structure pointed to by @info and the #GTypeFundamentalInfo structure pointed to by @finfo to manage the type and its instances. The value of @flags determines additional characteristics of the fundamental type. - + the predefined type identifier + filename="gobject/gtype.c" + line="2702">the predefined type identifier a predefined type identifier + filename="gobject/gtype.c" + line="2688">a predefined type identifier 0-terminated string used as the name of the new type + filename="gobject/gtype.c" + line="2689">0-terminated string used as the name of the new type #GTypeInfo structure for this type + filename="gobject/gtype.c" + line="2690">#GTypeInfo structure for this type #GTypeFundamentalInfo structure for this type + filename="gobject/gtype.c" + line="2691">#GTypeFundamentalInfo structure for this type bitwise combination of #GTypeFlags values + filename="gobject/gtype.c" + line="2692">bitwise combination of #GTypeFlags values @@ -28330,43 +29163,42 @@ additional characteristics of the fundamental type. Registers @type_name as the name of a new static type derived from + filename="gobject/gtype.c" + line="2806">Registers @type_name as the name of a new static type derived from @parent_type. The type system uses the information contained in the #GTypeInfo structure pointed to by @info to manage the type and its instances (if not abstract). The value of @flags determines the nature (e.g. abstract or not) of the type. - + the new type identifier + filename="gobject/gtype.c" + line="2819">the new type identifier type from which this type will be derived + filename="gobject/gtype.c" + line="2808">type from which this type will be derived 0-terminated string used as the name of the new type + filename="gobject/gtype.c" + line="2809">0-terminated string used as the name of the new type #GTypeInfo structure for this type + filename="gobject/gtype.c" + line="2810">#GTypeInfo structure for this type bitwise combination of #GTypeFlags values + filename="gobject/gtype.c" + line="2811">bitwise combination of #GTypeFlags values @@ -28376,60 +29208,59 @@ instances (if not abstract). The value of @flags determines the nature version="2.12" introspectable="0"> Registers @type_name as the name of a new static type derived from + filename="gobject/gtype.c" + line="2756">Registers @type_name as the name of a new static type derived from @parent_type. The value of @flags determines the nature (e.g. abstract or not) of the type. It works by filling a #GTypeInfo struct and calling g_type_register_static(). - + the new type identifier + filename="gobject/gtype.c" + line="2773">the new type identifier type from which this type will be derived + filename="gobject/gtype.c" + line="2758">type from which this type will be derived 0-terminated string used as the name of the new type + filename="gobject/gtype.c" + line="2759">0-terminated string used as the name of the new type size of the class structure (see #GTypeInfo) + filename="gobject/gtype.c" + line="2760">size of the class structure (see #GTypeInfo) location of the class initialization function (see #GTypeInfo) + filename="gobject/gtype.c" + line="2761">location of the class initialization function (see #GTypeInfo) size of the instance structure (see #GTypeInfo) + filename="gobject/gtype.c" + line="2762">size of the instance structure (see #GTypeInfo) location of the instance initialization function (see #GTypeInfo) + filename="gobject/gtype.c" + line="2763">location of the instance initialization function (see #GTypeInfo) bitwise combination of #GTypeFlags values + filename="gobject/gtype.c" + line="2764">bitwise combination of #GTypeFlags values @@ -28438,12 +29269,11 @@ struct and calling g_type_register_static(). c:identifier="g_type_remove_class_cache_func" introspectable="0"> Removes a previously installed #GTypeClassCacheFunc. The cache + filename="gobject/gtype.c" + line="2573">Removes a previously installed #GTypeClassCacheFunc. The cache maintained by @cache_func has to be empty when calling g_type_remove_class_cache_func() to avoid leaks. - + @@ -28453,14 +29283,14 @@ g_type_remove_class_cache_func() to avoid leaks. nullable="1" allow-none="1"> data that was given when adding @cache_func + filename="gobject/gtype.c" + line="2575">data that was given when adding @cache_func a #GTypeClassCacheFunc + filename="gobject/gtype.c" + line="2576">a #GTypeClassCacheFunc @@ -28470,11 +29300,10 @@ g_type_remove_class_cache_func() to avoid leaks. version="2.4" introspectable="0"> Removes an interface check function added with + filename="gobject/gtype.c" + line="2646">Removes an interface check function added with g_type_add_interface_check(). - + @@ -28484,14 +29313,14 @@ g_type_add_interface_check(). nullable="1" allow-none="1"> callback data passed to g_type_add_interface_check() + filename="gobject/gtype.c" + line="2648">callback data passed to g_type_add_interface_check() callback function passed to g_type_add_interface_check() + filename="gobject/gtype.c" + line="2649">callback function passed to g_type_add_interface_check() @@ -28499,24 +29328,23 @@ g_type_add_interface_check(). Attaches arbitrary data to a type. - + filename="gobject/gtype.c" + line="3833">Attaches arbitrary data to a type. + a #GType + filename="gobject/gtype.c" + line="3835">a #GType a #GQuark id to identify the data + filename="gobject/gtype.c" + line="3836">a #GQuark id to identify the data nullable="1" allow-none="1"> the data + filename="gobject/gtype.c" + line="3837">the data - + @@ -28550,86 +29377,59 @@ g_type_add_interface_check(). moved-to="TypeValueTable.peek" introspectable="0"> Returns the location of the #GTypeValueTable associated with @type. + filename="gobject/gtype.c" + line="4336">Returns the location of the #GTypeValueTable associated with @type. Note that this function should only be used from source code that implements or has internal knowledge of the implementation of @type. - + location of the #GTypeValueTable associated with @type or + filename="gobject/gtype.c" + line="4346">location of the #GTypeValueTable associated with @type or %NULL if there is no #GTypeValueTable associated with @type a #GType + filename="gobject/gtype.c" + line="4338">a #GType - - The prime purpose of a #GValueArray is for it to be used as an -object property that holds an array of values. A #GValueArray wraps -an array of #GValue elements in order for it to be used as a boxed -type through %G_TYPE_VALUE_ARRAY. - -#GValueArray is deprecated in favour of #GArray since GLib 2.32. It -is possible to create a #GArray that behaves like a #GValueArray by -using the size of #GValue as the element size, and by setting -g_value_unset() as the clear function using g_array_set_clear_func(), -for instance, the following code: - -|[<!-- language="C" --> - GValueArray *array = g_value_array_new (10); -]| - -can be replaced by: - -|[<!-- language="C" --> - GArray *array = g_array_sized_new (FALSE, TRUE, sizeof (GValue), 10); - g_array_set_clear_func (array, (GDestroyNotify) g_value_unset); -]| - Registers a value transformation function for use in g_value_transform(). + filename="gobject/gvalue.c" + line="426">Registers a value transformation function for use in g_value_transform(). A previously registered transformation function for @src_type and @dest_type will be replaced. - + Source type. + filename="gobject/gvalue.c" + line="428">Source type. Target type. + filename="gobject/gvalue.c" + line="429">Target type. a function which transforms values of type @src_type + filename="gobject/gvalue.c" + line="430">a function which transforms values of type @src_type into value of type @dest_type @@ -28639,28 +29439,27 @@ will be replaced. c:identifier="g_value_type_compatible" moved-to="Value.type_compatible"> Returns whether a #GValue of type @src_type can be copied into + filename="gobject/gvalue.c" + line="488">Returns whether a #GValue of type @src_type can be copied into a #GValue of type @dest_type. - + %TRUE if g_value_copy() is possible with @src_type and @dest_type. + filename="gobject/gvalue.c" + line="496">%TRUE if g_value_copy() is possible with @src_type and @dest_type. source type to be copied. + filename="gobject/gvalue.c" + line="490">source type to be copied. destination type for copying. + filename="gobject/gvalue.c" + line="491">destination type for copying. @@ -28669,33 +29468,38 @@ a #GValue of type @dest_type. c:identifier="g_value_type_transformable" moved-to="Value.type_transformable"> Check whether g_value_transform() is able to transform values + filename="gobject/gvalue.c" + line="465">Check whether g_value_transform() is able to transform values of type @src_type into values of type @dest_type. Note that for the types to be transformable, they must be compatible or a transformation function must be registered. - + %TRUE if the transformation is possible, %FALSE otherwise. + filename="gobject/gvalue.c" + line="475">%TRUE if the transformation is possible, %FALSE otherwise. Source type. + filename="gobject/gvalue.c" + line="467">Source type. Target type. + filename="gobject/gvalue.c" + line="468">Target type. + + + + + + diff --git a/girs/GPlugin-1.0.gir b/girs/GPlugin-1.0.gir index 0622f94f0..612bba6d1 100644 --- a/girs/GPlugin-1.0.gir +++ b/girs/GPlugin-1.0.gir @@ -15,7 +15,7 @@ and/or use gtk-doc annotations. --> c:identifier-prefixes="GPlugin" c:symbol-prefixes="gplugin"> @@ -48,7 +48,7 @@ and/or use gtk-doc annotations. --> Log plugin state changes with - g_message. Since: 0.34.0 + g_message. Since: 0.34. - + @@ -76,6 +76,62 @@ and/or use gtk-doc annotations. --> + + A [iface@GPlugin.Source] that will query plugins on disk. + + + + Creates a [iface@GPlugin.Source] that will query plugins on disk using the +paths from @manager. + + + The new source. + + + + + The [class@GPlugin.Manager] instance. + + + + + + The [class@GPlugin.Manager] that this source is working for. + + + + + + + + + line="21">An abstract class that should not be accessed directly. + The load vfunc is called when the plugin manager wants to load a + plugin that was previously queried by this loader. @@ -103,6 +163,10 @@ and/or use gtk-doc annotations. --> + The query vfunc is called when the plugin manager needs to query a + plugin that has a file extension from @supported_extensions. @@ -117,6 +181,11 @@ and/or use gtk-doc annotations. --> + The supported_extensions vfunc returns a #GList of + file extensions that this loader supports without the + leading dot. For example: 'so', 'dll', 'py', etc. @@ -130,6 +199,10 @@ and/or use gtk-doc annotations. --> + The unload vfunc is called when the plugin manager wants to unload + a previously loaded plugin from this loader. @@ -149,22 +222,22 @@ and/or use gtk-doc annotations. --> + version="0.34"> Gets the identifier of @loader. + line="163">Gets the identifier of @loader. The ID of @loader. + line="169">The ID of @loader. The loader instance. + line="165">The loader instance. @@ -229,26 +302,26 @@ so, dll, py, etc. throws="1"> This function is called by the plugin manager to ask @loader to query + line="185">This function is called by the plugin manager to ask @loader to query @filename and determine if it's a usable plugin. A plugin instance or %NULL on failure. + line="194">A plugin instance or %NULL on failure. The loader instance performing the query. + line="187">The loader instance performing the query. The filename to query. + line="188">The filename to query. @@ -289,11 +362,15 @@ so, dll, py, etc. + The identifier of the loader. @@ -311,6 +388,11 @@ so, dll, py, etc. + The supported_extensions vfunc returns a #GList of + file extensions that this loader supports without the + leading dot. For example: 'so', 'dll', 'py', etc. @@ -326,6 +408,10 @@ so, dll, py, etc. + The query vfunc is called when the plugin manager needs to query a + plugin that has a file extension from @supported_extensions. @@ -342,6 +428,10 @@ so, dll, py, etc. + The load vfunc is called when the plugin manager wants to load a + plugin that was previously queried by this loader. @@ -358,6 +448,10 @@ so, dll, py, etc. + The unload vfunc is called when the plugin manager wants to unload + a previously loaded plugin from this loader. @@ -389,14 +483,14 @@ so, dll, py, etc. - + This is the micro version number of GPlugin that was compiled against. - + This is the minor version number of GPlugin that was compiled against. @@ -406,8 +500,9 @@ so, dll, py, etc. @@ -419,15 +514,15 @@ searched for plugins. + version="0.33"> Gets the default plugin manager in GPlugin. + line="1530">Gets the default plugin manager in GPlugin. The default GPluginManager instance. + line="1535">The default GPluginManager instance. @@ -435,7 +530,7 @@ searched for plugins. c:identifier="gplugin_manager_add_app_paths"> Adds the application installation path for @appname. + line="682">Adds the application installation path for @appname. This will add `{prefix}/{appname}/plugins` to the list as well as `${XDG_CONFIG_HOME}/{appname}/plugins`. @@ -447,19 +542,19 @@ This will add `{prefix}/{appname}/plugins` to the list as well as The manager instance. + line="684">The manager instance. The installation prefix for the application. + line="685">The installation prefix for the application. The name of the application whose paths to add. + line="686">The name of the application whose paths to add. @@ -468,7 +563,7 @@ This will add `{prefix}/{appname}/plugins` to the list as well as c:identifier="gplugin_manager_add_default_paths"> Adds the path that GPlugin was installed to to the plugin search path, as + line="658">Adds the path that GPlugin was installed to to the plugin search path, as well as `${XDG_CONFIG_HOME}/gplugin` so users can install additional loaders themselves. @@ -479,7 +574,7 @@ themselves. The manager instance. + line="660">The manager instance. @@ -487,7 +582,7 @@ themselves. Adds @path to the end of the list of paths to search for plugins. + line="556">Adds @path to the end of the list of paths to search for plugins. @@ -496,23 +591,23 @@ themselves. The manager instance. + line="558">The manager instance. A path to add to the end of the plugin search paths. + line="559">A path to add to the end of the plugin search paths. + version="0.37"> Append the paths held in the environment variable @name to the list. + line="713">Append the paths held in the environment variable @name to the list. @@ -521,13 +616,13 @@ themselves. The manager instance. + line="715">The manager instance. The name of the environment variable containing the paths to add. + line="716">The name of the environment variable containing the paths to add. @@ -535,7 +630,7 @@ themselves. Finds the first plugin matching @id. + line="1067">Finds the first plugin matching @id. This function uses [method@GPlugin.Manager.find_plugins] and returns the first plugin in the list. @@ -543,7 +638,7 @@ first plugin in the list. A plugin instance or %NULL if no plugin + line="1077">A plugin instance or %NULL if no plugin matching @id was found. @@ -551,13 +646,13 @@ first plugin in the list. The manager instance. + line="1069">The manager instance. The ID of the plugin to find. + line="1070">The ID of the plugin to find. @@ -566,14 +661,14 @@ first plugin in the list. c:identifier="gplugin_manager_find_plugin_with_newest_version"> Calls [method@GPlugin.Manager.find_plugins] with @id, and then returns the + line="1100">Calls [method@GPlugin.Manager.find_plugins] with @id, and then returns the plugins with the highest version number or %NULL if no plugins with @id are found. The plugin with an ID of @id that has the highest + line="1109">The plugin with an ID of @id that has the highest version number, or %NULL if no plugins were found with @id. @@ -581,13 +676,13 @@ found. The manager instance. + line="1102">The manager instance. The ID of the plugin to find. + line="1103">The ID of the plugin to find. @@ -595,12 +690,12 @@ found. Finds all plugins matching @id. + line="930">Finds all plugins matching @id. A [struct@GLib.SList] + line="937">A [struct@GLib.SList] of plugins matching @id. @@ -610,13 +705,13 @@ found. The manager instance. + line="932">The manager instance. The ID of the plugin to find. + line="933">The ID of the plugin to find. @@ -625,12 +720,12 @@ found. c:identifier="gplugin_manager_find_plugins_with_state"> Finds all plugins that currently have a state of @state. + line="1030">Finds all plugins that currently have a state of @state. A [struct@GLib.SList] + line="1037">A [struct@GLib.SList] of plugins whose state is @state. @@ -640,13 +735,13 @@ found. The manager instance. + line="1032">The manager instance. The state to look for. + line="1033">The state to look for. @@ -655,7 +750,7 @@ found. c:identifier="gplugin_manager_find_plugins_with_version"> Similar to [method@GPlugin.Manager.find_plugins] but only returns plugins + line="954">Similar to [method@GPlugin.Manager.find_plugins] but only returns plugins whose versions match @op and @version. This is primarily used for dependency loading where a plugin may depend on a @@ -664,7 +759,7 @@ specific range of versions of another plugin. A [struct@GLib.SList] + line="967">A [struct@GLib.SList] of plugins matching @id and the version constraint. @@ -674,25 +769,25 @@ specific range of versions of another plugin. The manager instance. + line="956">The manager instance. The ID of the plugin to find. + line="957">The ID of the plugin to find. one of <, <=, =, ==, >=, >. + line="958">one of <, <=, =, ==, >=, >. The version to compare against. + line="959">The version to compare against. @@ -700,7 +795,7 @@ specific range of versions of another plugin. Calls @func for each plugin that is known. + line="904">Calls @func for each plugin that is known. @@ -709,7 +804,7 @@ specific range of versions of another plugin. The manager instance. + line="906">The manager instance. closure="1"> The function to call with each plugin. + line="907">The function to call with each plugin. @@ -728,7 +823,7 @@ specific range of versions of another plugin. allow-none="1"> User data to pass to @func. + line="908">User data to pass to @func. @@ -736,12 +831,12 @@ specific range of versions of another plugin. Returns a list of all registered loaders. + line="859">Returns a list of all registered loaders. Returns a list + line="865">Returns a list of all registered loaders. @@ -751,7 +846,7 @@ specific range of versions of another plugin. The manager instance. + line="861">The manager instance. @@ -759,12 +854,12 @@ specific range of versions of another plugin. Gets the list of paths which will be searched for plugins. + line="747">Gets the list of paths which will be searched for plugins. The [type@GLib.List] of paths + line="753">The [type@GLib.List] of paths which will be searched for plugins. @@ -774,7 +869,7 @@ specific range of versions of another plugin. The manager instance. + line="749">The manager instance. @@ -784,12 +879,12 @@ specific range of versions of another plugin. throws="1"> Returns a list of all the plugins that @plugin depends on. + line="1176">Returns a list of all the plugins that @plugin depends on. A [struct@GLib.SList] + line="1184">A [struct@GLib.SList] of plugins that @plugin depends on, or %NULL on error with @error set. @@ -800,13 +895,13 @@ specific range of versions of another plugin. The manager instance. + line="1178">The manager instance. The plugin whose dependencies to get. + line="1179">The plugin whose dependencies to get. @@ -814,14 +909,14 @@ specific range of versions of another plugin. Returns a list of all plugin IDs. + line="1467">Returns a list of all plugin IDs. Each id should be queried directly for more information. A [struct@GLib.List] of + line="1475">A [struct@GLib.List] of each unique plugin ID. @@ -831,7 +926,7 @@ Each id should be queried directly for more information. The manager instance. + line="1469">The manager instance. @@ -841,7 +936,7 @@ Each id should be queried directly for more information. throws="1"> Loads @plugin and all of its dependencies. + line="1275">Loads @plugin and all of its dependencies. If a dependency can not be loaded, @plugin will not be loaded either. However, any other plugins that @plugin depends on that were loaded from @@ -850,7 +945,7 @@ this call, will not be unloaded. %TRUE if @plugin was loaded successfully or already loaded, %FALSE + line="1287">%TRUE if @plugin was loaded successfully or already loaded, %FALSE otherwise. @@ -858,13 +953,13 @@ this call, will not be unloaded. The manager instance. + line="1277">The manager instance. The plugin instance. + line="1278">The plugin instance. @@ -872,7 +967,7 @@ this call, will not be unloaded. Adds @path to the beginning of the list of paths to search for plugins. + line="585">Adds @path to the beginning of the list of paths to search for plugins. @@ -881,23 +976,23 @@ this call, will not be unloaded. The manager instance. + line="587">The manager instance. A path to add to the beginning of the plugin search paths. + line="588">A path to add to the beginning of the plugin search paths. + version="0.37"> Prepends the paths held in the environment variable @name to the list. + line="730">Prepends the paths held in the environment variable @name to the list. @@ -906,13 +1001,13 @@ this call, will not be unloaded. The manager instance. + line="732">The manager instance. The name of the environment variable containing the paths to add. + line="733">The name of the environment variable containing the paths to add. @@ -920,7 +1015,7 @@ this call, will not be unloaded. Forces a refresh of all plugins found in the search paths. + line="876">Forces a refresh of all plugins found in the search paths. @@ -929,7 +1024,7 @@ this call, will not be unloaded. The manager instance. + line="878">The manager instance. @@ -939,12 +1034,12 @@ this call, will not be unloaded. throws="1"> Registers @loader as an available loader. + line="764">Registers @loader as an available loader. %TRUE if the loader was successfully register, %FALSE otherwise + line="772">%TRUE if the loader was successfully register, %FALSE otherwise with @error set. @@ -952,13 +1047,13 @@ this call, will not be unloaded. The manager instance. + line="766">The manager instance. The loader instance to register. + line="767">The loader instance to register. @@ -966,7 +1061,7 @@ this call, will not be unloaded. Removes @path from the list of paths to search for plugins. + line="614">Removes @path from the list of paths to search for plugins. @@ -975,13 +1070,13 @@ this call, will not be unloaded. The manager instance. + line="616">The manager instance. A path to remove from the plugin search paths. + line="617">A path to remove from the plugin search paths. @@ -989,7 +1084,7 @@ this call, will not be unloaded. Clears all paths that are set to search for plugins. + line="644">Clears all paths that are set to search for plugins. @@ -998,7 +1093,7 @@ this call, will not be unloaded. The manager instance. + line="646">The manager instance. @@ -1008,14 +1103,14 @@ this call, will not be unloaded. throws="1"> Unloads @plugin. + line="1386">Unloads @plugin. If @plugin has dependencies, they are not unloaded. %TRUE if @plugin was unloaded successfully or not loaded, %FALSE + line="1396">%TRUE if @plugin was unloaded successfully or not loaded, %FALSE otherwise. @@ -1023,13 +1118,13 @@ If @plugin has dependencies, they are not unloaded. The manager instance. + line="1388">The manager instance. The plugin instance. + line="1389">The plugin instance. @@ -1039,12 +1134,12 @@ If @plugin has dependencies, they are not unloaded. throws="1"> Unregisters @loader as an available loader. + line="809">Unregisters @loader as an available loader. %TRUE if the loader was successfully unregistered, %FALSE + line="817">%TRUE if the loader was successfully unregistered, %FALSE otherwise with @error set. @@ -1052,21 +1147,21 @@ If @plugin has dependencies, they are not unloaded. The manager instance. + line="811">The manager instance. The loader instance to unregister. + line="812">The loader instance to unregister. - + Emitted after a plugin fails to load. + line="348">Emitted after a plugin fails to load. @@ -1074,21 +1169,21 @@ If @plugin has dependencies, they are not unloaded. The [iface@GPlugin.Plugin] that failed to load. + line="351">The [iface@GPlugin.Plugin] that failed to load. The [struct@GLib.Error] of what went wrong. + line="352">The [struct@GLib.Error] of what went wrong. - + Emitted after a plugin is loaded. + line="327">Emitted after a plugin is loaded. @@ -1096,15 +1191,15 @@ If @plugin has dependencies, they are not unloaded. The [iface@GPlugin.Plugin] that's about to be loaded. + line="330">The [iface@GPlugin.Plugin] that's about to be loaded. - + Emitted when @loader has been registered with @manager via + line="442">Emitted when @loader has been registered with @manager via [method@GPlugin.Manager.register_loader]. @@ -1113,15 +1208,15 @@ If @plugin has dependencies, they are not unloaded. The [class@GPlugin.Loader] instance that was registered. + line="445">The [class@GPlugin.Loader] instance that was registered. - + Emitted when @loader has been unregistered from @manager via + line="464">Emitted when @loader has been unregistered from @manager via [method@GPlugin.Manager.unregister_loader]. @@ -1130,25 +1225,27 @@ If @plugin has dependencies, they are not unloaded. The [class@GPlugin.Loader] instance that was unregistered. + line="467">The [class@GPlugin.Loader] instance that was unregistered. - + Emitted before @plugin is loaded. - -Return FALSE to stop loading + line="301">Emitted before @plugin is loaded. + %TRUE to allow the plugin to load or %FALSE to stop it from + being loaded. The [iface@GPlugin.Plugin] that's about to be loaded. + line="304">The [iface@GPlugin.Plugin] that's about to be loaded. allow-none="1"> Return address for a [struct@GLib.Error]. + line="305">Return address for a [struct@GLib.Error]. - + Emitted when @manager was asked to unload @plugin, but @plugin returned + line="418">Emitted when @manager was asked to unload @plugin, but @plugin returned %FALSE when its unload function was called. @@ -1174,21 +1271,21 @@ Return FALSE to stop loading The [iface@GPlugin.Plugin] instance that failed to unload. + line="421">The [iface@GPlugin.Plugin] instance that failed to unload. A [struct@GLib.Error] instance. + line="422">A [struct@GLib.Error] instance. - + emitted after a plugin is successfully unloaded. + line="397">emitted after a plugin is successfully unloaded. @@ -1196,25 +1293,27 @@ Return FALSE to stop loading The [iface@GPlugin.Plugin] that's about to be loaded. + line="400">The [iface@GPlugin.Plugin] that's about to be loaded. - + Emitted before a plugin is unloaded. - -Return FALSE to stop unloading + line="371">Emitted before a plugin is unloaded. + %TRUE to allow the plugin to be unloaded, or %FALSE to stop + the plugin from being unloaded. The [iface@GPlugin.Plugin] that's about to be unloaded. + line="374">The [iface@GPlugin.Plugin] that's about to be unloaded. allow-none="1"> Return address for a [struct@GLib.Error]. + line="375">Return address for a [struct@GLib.Error]. @@ -1284,6 +1383,10 @@ Return FALSE to stop unloading plugin. + The class closure for the #GPluginPlugin::state-changed + signal. @@ -1303,7 +1406,7 @@ plugin. + version="0.38"> Gets the desired state of the plugin. Typically this will hold the same @@ -1445,7 +1548,7 @@ unload. + version="0.38"> Sets the desired state of the plugin. This shouldn't need to be called by @@ -1496,7 +1599,7 @@ by loaders. glib:get-property="abi-version"> Returns the ABI or Application Binary Interface version that the plugin + line="1033">Returns the ABI or Application Binary Interface version that the plugin is supposed to work against. The abi_version from @info. + line="1040">The abi_version from @info. The plugin info instance. + line="1035">The plugin info instance. @@ -1627,12 +1730,12 @@ is supposed to work against. glib:get-property="authors"> Returns the authors of the plugin as specified in @info. + line="1330">Returns the authors of the plugin as specified in @info. The authors from @info. + line="1336">The authors from @info. @@ -1641,7 +1744,7 @@ is supposed to work against. The plugin info instance. + line="1332">The plugin info instance. @@ -1649,10 +1752,10 @@ is supposed to work against. + version="0.39"> Returns whether or not this plugin should be loaded when queried. This is + line="1076">Returns whether or not this plugin should be loaded when queried. This is useful for internal plugins that are adding functionality and should always be turned on. The plugin loaders use this to make sure all plugins can always be loaded. @@ -1660,7 +1763,7 @@ always be loaded. %TRUE if the plugin should be loaded when queried, %FALSE + line="1085">%TRUE if the plugin should be loaded when queried, %FALSE otherwise. @@ -1668,7 +1771,7 @@ always be loaded. The plugin info instance. + line="1078">The plugin info instance. @@ -1678,13 +1781,13 @@ always be loaded. glib:get-property="bind-global"> This property and therefore function is only used by the native plugin + line="1391">This property and therefore function is only used by the native plugin loader. %TRUE if the plugin has requested to be loaded with its symbols + line="1398">%TRUE if the plugin has requested to be loaded with its symbols bound global, %FALSE if they should be bound locally. @@ -1692,7 +1795,7 @@ loader. The plugin info instance. + line="1393">The plugin info instance. @@ -1702,19 +1805,19 @@ loader. glib:get-property="category"> Returns the category of the plugin as specified in @info. + line="1310">Returns the category of the plugin as specified in @info. The category from @info. + line="1316">The category from @info. The plugin info instance. + line="1312">The plugin info instance. @@ -1724,12 +1827,12 @@ loader. glib:get-property="dependencies"> Returns the dependencies of the plugins as specified in @info. + line="1370">Returns the dependencies of the plugins as specified in @info. The list of + line="1376">The list of dependencies from @info. @@ -1739,7 +1842,7 @@ loader. The plugin info instance. + line="1372">The plugin info instance. @@ -1749,19 +1852,19 @@ loader. glib:get-property="description"> Returns the description for the plugin as specified in @info. + line="1290">Returns the description for the plugin as specified in @info. The description from @info. + line="1296">The description from @info. The plugin info instance. + line="1292">The plugin info instance. @@ -1771,19 +1874,19 @@ loader. glib:get-property="icon-name"> Returns the name of the icon for the plugin as specified in @info. + line="1250">Returns the name of the icon for the plugin as specified in @info. The icon name from @info. + line="1256">The icon name from @info. The plugin info instance. + line="1252">The plugin info instance. @@ -1793,19 +1896,19 @@ loader. glib:get-property="id"> Returns the id that the plugin identifies itself as. + line="936">Returns the id that the plugin identifies itself as. The id from @info. + line="942">The id from @info. The plugin info instance. + line="938">The plugin info instance. @@ -1814,20 +1917,20 @@ loader. c:identifier="gplugin_plugin_info_get_id_normalized"> Gets the normalized version of the id from @info. That is, a version where + line="956">Gets the normalized version of the id from @info. That is, a version where only alphanumeric and -'s are in the id. The normalized id of @info. + line="963">The normalized id of @info. The plugin info instance. + line="958">The plugin info instance. @@ -1837,21 +1940,21 @@ only alphanumeric and -'s are in the id. glib:get-property="internal"> Returns where or not this plugin is is considered an internal plugin. An + line="1054">Returns where or not this plugin is is considered an internal plugin. An internal plugin would be something like a plugin loader or another plugin that should not be shown to users. %TRUE if the plugin is internal, %FALSE otherwise. + line="1062">%TRUE if the plugin is internal, %FALSE otherwise. The plugin info instance. + line="1056">The plugin info instance. @@ -1861,19 +1964,19 @@ that should not be shown to users. glib:get-property="license-id"> Returns the liences id for the plugin as specified in @info. + line="1190">Returns the liences id for the plugin as specified in @info. The license-id from @info. + line="1196">The license-id from @info. The plugin info instance. + line="1192">The plugin info instance. @@ -1883,19 +1986,19 @@ that should not be shown to users. glib:get-property="license-text"> Returns the license text for the plugin as specified in @info. + line="1210">Returns the license text for the plugin as specified in @info. The text of the license from @info. + line="1216">The text of the license from @info. The plugin info instance. + line="1212">The plugin info instance. @@ -1905,19 +2008,19 @@ that should not be shown to users. glib:get-property="license-url"> Returns the url of the license for the plugin as specified in @info + line="1230">Returns the url of the license for the plugin as specified in @info The url of the license from @info. + line="1236">The url of the license from @info. The plugin info instance. + line="1232">The plugin info instance. @@ -1929,7 +2032,7 @@ that should not be shown to users. deprecated-version="0.39.0"> Returns whether or not this plugin should be loaded when queried. This is + line="1102">Returns whether or not this plugin should be loaded when queried. This is useful for internal plugins that are adding functionality and should always be turned on. The plugin loaders use this to make sure all plugins can always be loaded. @@ -1938,7 +2041,7 @@ always be loaded. %TRUE if the plugin should be loaded when queried, %FALSE + line="1111">%TRUE if the plugin should be loaded when queried, %FALSE otherwise. @@ -1946,7 +2049,7 @@ always be loaded. The plugin info instance. + line="1104">The plugin info instance. @@ -1956,19 +2059,19 @@ always be loaded. glib:get-property="name"> Returns the name of the plugin as specified in @info. + line="1128">Returns the name of the plugin as specified in @info. The name from @info. + line="1134">The name from @info. The plugin info instance. + line="1130">The plugin info instance. @@ -1976,22 +2079,22 @@ always be loaded. + version="0.32"> Gets the priority of the plugin as specified in @info. + line="1011">Gets the priority of the plugin as specified in @info. The priority from @info. + line="1017">The priority from @info. The plugin info instance. + line="1013">The plugin info instance. @@ -1999,15 +2102,15 @@ always be loaded. + version="0.32"> Gets the provides of the plugin as specified in @info. + line="988">Gets the provides of the plugin as specified in @info. The list of + line="994">The list of dependencies from @info. @@ -2017,7 +2120,7 @@ always be loaded. The plugin info instance. + line="990">The plugin info instance. @@ -2025,22 +2128,22 @@ always be loaded. + version="0.39"> Returns the ID of the [class@Gio.Settings] schema as specified in @info. + line="1168">Returns the ID of the [class@Gio.Settings] schema as specified in @info. The schema ID from @info. + line="1176">The schema ID from @info. The plugin info instance. + line="1170">The plugin info instance. @@ -2050,19 +2153,19 @@ always be loaded. glib:get-property="summary"> Returns the summery for the plugin as specified in @info. + line="1270">Returns the summery for the plugin as specified in @info. The summary from @info. + line="1276">The summary from @info. The plugin info instance. + line="1272">The plugin info instance. @@ -2070,10 +2173,10 @@ always be loaded. + version="0.35"> Gets whether or not the plugin is unloadable. Certain libraries can not be + line="1413">Gets whether or not the plugin is unloadable. Certain libraries can not be shutdown cleanly and then re-enabled during the life time of a program. A plugin using one of these libraries should set the [property@GPlugin.PluginInfo:unloadable] property to %FALSE to tell @@ -2082,14 +2185,14 @@ plugin using one of these libraries should set the %TRUE if the plugin is unloadable, otherwise %FALSE. + line="1423">%TRUE if the plugin is unloadable, otherwise %FALSE. The plugin info instance. + line="1415">The plugin info instance. @@ -2099,19 +2202,19 @@ plugin using one of these libraries should set the glib:get-property="version"> Returns the version of the plugin as specified in @info. + line="1148">Returns the version of the plugin as specified in @info. The version from @info. + line="1154">The version from @info. The plugin info instance. + line="1150">The plugin info instance. @@ -2121,19 +2224,19 @@ plugin using one of these libraries should set the glib:get-property="website"> Returns the website for the plugin as specified in @info. + line="1350">Returns the website for the plugin as specified in @info. The website from @info. + line="1356">The website from @info. The plugin info instance. + line="1352">The plugin info instance. @@ -2146,7 +2249,7 @@ plugin using one of these libraries should set the default-value="0"> The GPlugin ABI version that the plugin was compiled against. + line="630">The GPlugin ABI version that the plugin was compiled against. GPlugin only uses the first byte (`0xff000000`) of this value. The remaining 3 bytes are available for the application to use. @@ -2170,7 +2273,7 @@ the second as well. getter="get_authors"> A list of the names and email addresses of the authors. + line="864">A list of the names and email addresses of the authors. It is recommended to use the RFC 822, 2822 format of: `"First Last <user@domain.com>"`. @@ -2179,7 +2282,7 @@ It is recommended to use the RFC 822, 2822 format of: Whether or not the plugin should be loaded when it's queried. + line="672">Whether or not the plugin should be loaded when it's queried. This is used by the loaders and may be useful to your application as well. @@ -2203,7 +2306,7 @@ Defaults to %FALSE. default-value="FALSE"> Determines whether the plugin should be have its symbols bound globally. + line="710">Determines whether the plugin should be have its symbols bound globally. Note: This should only be used by the native plugin loader. @@ -2216,7 +2319,7 @@ Note: This should only be used by the native plugin loader. default-value="NULL"> The category of this plugin. + line="847">The category of this plugin. This property is used to organize plugins into categories in a user interface. It is recommended that an application has a well defined @@ -2231,7 +2334,7 @@ that don't match this category into an "Other" category. getter="get_dependencies"> A comma separated list of plugin id's that this plugin depends on. + line="891">A comma separated list of plugin id's that this plugin depends on. @@ -2244,7 +2347,7 @@ that don't match this category into an "Other" category. default-value="NULL"> The full description of the plugin that will be used in a "more + line="834">The full description of the plugin that will be used in a "more information" section in a user interface. @@ -2256,7 +2359,7 @@ information" section in a user interface. default-value="NULL"> A XDG icon name for the plugin. The actual use of this is determined by + line="808">A XDG icon name for the plugin. The actual use of this is determined by the application/library using GPlugin. @@ -2268,7 +2371,7 @@ the application/library using GPlugin. default-value="NULL"> The id of the plugin. + line="572">The id of the plugin. While not required, the recommended convention is to use the following format: &lt;application or library&gt;/&lt;name of the plugin&gt;. @@ -2285,7 +2388,7 @@ For example, the Python3 loader in GPlugin has an id of default-value="FALSE"> Whether or not the plugin is considered an "internal" plugin. + line="658">Whether or not the plugin is considered an "internal" plugin. Defaults to %FALSE. @@ -2298,7 +2401,7 @@ Defaults to %FALSE. default-value="NULL"> The short name of the license. + line="762">The short name of the license. It is recommended to use the identifier of the license from https://spdx.org/licenses/ and should be "Other" for licenses that are @@ -2317,7 +2420,7 @@ the same time, they should be separated by an ampersand (&). default-value="NULL"> The text of the license for this plugin. This should only be used when + line="782">The text of the license for this plugin. This should only be used when the plugin is licensed under a license that is not listed at spdx.org. @@ -2329,7 +2432,7 @@ the plugin is licensed under a license that is not listed at spdx.org. default-value="NULL"> The url to the text of the license. This should primarily only be used + line="795">The url to the text of the license. This should primarily only be used for licenses not listed at spdx.org. @@ -2343,7 +2446,7 @@ for licenses not listed at spdx.org. default-value="FALSE"> Whether or not the plugin should be loaded when it's queried. + line="691">Whether or not the plugin should be loaded when it's queried. This is used by the loaders and may be useful to your application as well. @@ -2360,11 +2463,11 @@ Defaults to %FALSE. default-value="NULL"> The display name of the plugin. This should be a translated string. + line="724">The display name of the plugin. This should be a translated string. default-value="0"> The priority that this plugin should have when determining which plugin + line="611">The priority that this plugin should have when determining which plugin to use when multiple plugins have the same id or provides. Higher values take precedence over lower values. If two plugins have the same id and priority, the first one found will be used. A list of additional plugin ids and versions that this plugin can + line="590">A list of additional plugin ids and versions that this plugin can provide. This mechanism is used so that plugins can replace and extend the behavior of other plugins. @@ -2399,7 +2502,7 @@ on a specific version. default-value="NULL"> The ID of the [class@Gio.Settings] schema for the plugin. + line="748">The ID of the [class@Gio.Settings] schema for the plugin. default-value="NULL"> A short description of the plugin that can be listed with the name in a + line="821">A short description of the plugin that can be listed with the name in a user interface. default-value="TRUE"> Sets whether or not a plugin is unloadable. See + line="903">Sets whether or not a plugin is unloadable. See [method@GPlugin.PluginInfo.get_unloadable] for more information. @@ -2443,7 +2546,7 @@ user interface. default-value="NULL"> The version of the plugin. Preferably a semantic version. + line="736">The version of the plugin. Preferably a semantic version. default-value="NULL"> The url of the plugin that can be represented in a user interface. + line="879">The url of the plugin that can be represented in a user interface. @@ -2489,6 +2592,10 @@ signals. + The class closure for the #GPluginPlugin::state-changed + signal. @@ -2586,7 +2693,7 @@ signals. + version="0.32"> Gets a string representation of @state. @@ -2610,7 +2717,7 @@ signals. @@ -2618,7 +2725,7 @@ signals. filename="gplugin/gplugin-source.c" line="20">An interface that the manager will call during refresh to query plugins. - + This method is called when [method@GPlugin.Manager.refresh] is running. The @@ -2643,7 +2750,7 @@ which will tell the manager to continue scanning. - + This method is called when [method@GPlugin.Manager.refresh] is running. The @@ -2712,10 +2819,21 @@ which will tell the manager to continue scanning. + + + + + + + + + - + @@ -2726,7 +2844,7 @@ which will tell the manager to continue scanning. - + @@ -2734,7 +2852,7 @@ which will tell the manager to continue scanning. - + This is the string version number of GPlugin that was compiled against. @@ -2748,7 +2866,7 @@ which will tell the manager to continue scanning. filename="gplugin/gplugin-version.c" line="175">Checks the version of the GPlugin library that is being compiled against. - + - + c:type="GPLUGIN_VERSION_MIN_REQUIRED" + version="0.42"> + A macro that should be defined by the user prior to including the +`gplugin.h` header. + +The definition should be one of the predefined GPlugin version macros: +%GPLUGIN_VERSION_0_42, %GPLUGIN_VERSION_0_43, ... + +This macro defines the earliest version of GPlugin that the package is +required to be able to compile against. + +If the compiler is configured to warn about the use of deprecated functions, +then using functions that were deprecated in version +%GPLUGIN_VERSION_MIN_REQUIRED or earlier will cause warnings (but using +functions deprecated in later releases will not). + - + Gets the core flags that were passed to [func@GPlugin.init]. @@ -2835,30 +2967,30 @@ internally calls [func@GPlugin.init]. introspectable="0"> Creates a new #GPluginPluginInfo instance. + line="925">Creates a new #GPluginPluginInfo instance. The id of the plugin. + line="927">The id of the plugin. The GPlugin ABI version that the plugin uses. + line="928">The GPlugin ABI version that the plugin uses. name/value pairs of properties to set, followed by %NULL. + line="929">name/value pairs of properties to set, followed by %NULL. + version="0.32"> Gets a string representation of @state. @@ -2902,7 +3034,7 @@ Compatibility is defined by two things: first the version of the running library is newer than the version @major.@minor.@micro. Second the running library must be binary compatible with the version @major.@minor.@micro (same major version). - + A semantic version checker which ignores any characters after the micro version. - + c:identifier="GPLUGIN_GTK_DEPRECATED_IN_0_39_FOR" introspectable="0"> + line="263"/> @@ -54,7 +54,7 @@ and/or use gtk-doc annotations. --> @@ -93,7 +94,7 @@ way, intended to be placed in a [class@GPluginGtk4.View]. + version="0.39"> Create a new [class@GPluginGtk4.PluginPage] which can be used to display @@ -110,7 +111,7 @@ info about a [iface@GPlugin.Plugin]. + version="0.39"> Gets the [iface@GPlugin.Plugin] that's being displayed. @@ -135,7 +136,7 @@ info about a [iface@GPlugin.Plugin]. + version="0.40"> Gets the settings backend used when displaying plugin settings. @@ -164,7 +165,7 @@ where you need it. + version="0.39"> Sets the [iface@GPlugin.Plugin] that should be displayed. @@ -196,7 +197,7 @@ A @plugin value of %NULL will clear the widget. + version="0.40"> Sets the settings backend to use when displaying plugin settings. @@ -229,7 +230,7 @@ GPlugin users, this function takes a `gpointer` instead of a The [class@Gio.SettingsBackend] to use when viewing plugin settings. - + Emitted when the plugin page enable switch is toggled. @@ -280,8 +281,9 @@ GPlugin users, this function takes a `gpointer` instead of a @@ -297,7 +299,7 @@ intended to be placed in a [class@Gtk.ListBox]. + version="0.38"> Create a new [class@GPluginGtk4.PluginRow] which can be used to display info @@ -314,7 +316,7 @@ about a [iface@GPlugin.Plugin]. + version="0.38"> Returns the [iface@GPlugin.Plugin] that's being displayed. @@ -338,7 +340,7 @@ about a [iface@GPlugin.Plugin]. + version="0.38"> Returns a key that can be used to sort this row. @@ -361,7 +363,7 @@ about a [iface@GPlugin.Plugin]. + version="0.38"> Matches this row instance against some text to be searched for. @@ -391,7 +393,7 @@ about a [iface@GPlugin.Plugin]. + version="0.38"> Sets the [iface@GPlugin.Plugin] that should be displayed. @@ -421,7 +423,7 @@ A @plugin value of %NULL will clear the widget. line="157">The [iface@GPlugin.Plugin] whose info should be displayed. - + Emitted when the plugin row enable switch is toggled. @@ -461,8 +463,9 @@ A @plugin value of %NULL will clear the widget. @@ -477,7 +480,7 @@ A @plugin value of %NULL will clear the widget. + version="0.40"> Creates a new [class@GPluginGtk4.PluginSettingsList]. @@ -493,7 +496,7 @@ A @plugin value of %NULL will clear the widget. + version="0.40"> Returns the plugin settings that are being displayed. @@ -518,7 +521,7 @@ A @plugin value of %NULL will clear the widget. + version="0.40"> This function will set which plugin settings to display. @@ -602,7 +605,7 @@ A @plugin value of %NULL will clear the widget. - + This is the string version number of GPluginGtk that was compiled against. @@ -618,7 +621,7 @@ A @plugin value of %NULL will clear the widget. line="54">Checks the version of the GPluginGtk library that is being compiled against. + line="322"/> + c:type="GPLUGIN_GTK_VERSION_MIN_REQUIRED" + version="0.42"> + A macro that should be defined by the user prior to including the +`gplugin-gtk.h` header. + +The definition should be one of the predefined GPluginGtk version macros: +%GPLUGIN_GTK_VERSION_0_42, %GPLUGIN_GTK_VERSION_0_43, ... + +This macro defines the earliest version of GPluginGtk that the package is +required to be able to compile against. + +If the compiler is configured to warn about the use of deprecated functions, +then using functions that were deprecated in version +%GPLUGIN_GTK_VERSION_MIN_REQUIRED or earlier will cause warnings (but using +functions deprecated in later releases will not). + line="106"/> @@ -663,12 +683,12 @@ them. Creates a new [class@GPluginGtk4.View]. + line="382">Creates a new [class@GPluginGtk4.View]. The new view. + line="387">The new view. @@ -677,19 +697,19 @@ them. glib:get-property="manager"> Returns the plugin manager that is being displayed. + line="433">Returns the plugin manager that is being displayed. The plugin manager to display. + line="439">The plugin manager to display. The GTK view instance. + line="435">The GTK view instance. @@ -697,10 +717,10 @@ them. + version="0.40"> Gets the settings backend used when displaying plugin settings. + line="513">Gets the settings backend used when displaying plugin settings. Note, because we do not want to leak `G_SETTINGS_ENABLE_BACKEND` into GPlugin users, this function returns a `gpointer`, and you should cast to @@ -710,14 +730,14 @@ where you need it. The settings backend. + line="524">The settings backend. The GTK view instance. + line="515">The GTK view instance. @@ -727,16 +747,19 @@ where you need it. glib:get-property="show-internal"> Returns whether or not @view is showing internal plugins. + line="467">Gets whether or not @view is showing internal plugins. + %TRUE if internal plugins are being shown, otherwise %FALSE. The GTK view instance. + line="469">The GTK view instance. @@ -746,7 +769,7 @@ where you need it. glib:set-property="manager"> This function will set which plugin manager to display. + line="403">This function will set which plugin manager to display. @@ -755,13 +778,13 @@ where you need it. The GTK view instance. + line="405">The GTK view instance. The plugin manager to display. + line="406">The plugin manager to display. @@ -769,10 +792,10 @@ where you need it. + version="0.40"> Sets the settings backend to use when displaying plugin settings. + line="483">Sets the settings backend to use when displaying plugin settings. Note, because we do not want to leak `G_SETTINGS_ENABLE_BACKEND` into GPlugin users, this function takes a `gpointer` instead of a @@ -785,7 +808,7 @@ GPlugin users, this function takes a `gpointer` instead of a The GTK view instance. + line="485">The GTK view instance. The settings backend to use. If %NULL, + line="486">The settings backend to use. If %NULL, the default GSettings backend will be used. @@ -805,7 +828,7 @@ GPlugin users, this function takes a `gpointer` instead of a glib:set-property="show-internal"> This function will toggle whether or not the widget will show internal + line="449">This function will toggle whether or not the widget will show internal plugins. @@ -815,23 +838,23 @@ plugins. The GTK view instance. + line="451">The GTK view instance. Whether or not to show internal plugins. + line="452">Whether or not to show internal plugins. + version="0.39"> Shows the plugin list overview. + line="536">Shows the plugin list overview. @@ -840,17 +863,17 @@ plugins. The GTK view instance. + line="538">The GTK view instance. + version="0.39"> Shows a page for a single plugin. + line="555">Shows a page for a single plugin. @@ -859,13 +882,13 @@ plugins. The GTK view instance. + line="557">The GTK view instance. The plugin to show. + line="558">The plugin to show. @@ -926,7 +949,7 @@ library is newer than the version @major.@minor.@micro. Second the running library must be binary compatible with the version @major.@minor.@micro (same major version). + line="332"/> shared-library="libgsystem.so.0" c:identifier-prefixes="GS" c:symbol-prefixes="gs"> + + + + + + + - First, this class offers API to access the standard input and + First, this class offers API to access the standard input and output/error, streams as #GInputStream and #GOutputStream respectively. @@ -27,37 +39,53 @@ In the case where the process is connected to a controlling terminal, the gs_console_get() API is available, which exposes a number of additional features such as no-echo password reading. - If the current process has an interactive console, return the + If the current process has an interactive console, return the singleton #GSConsole instance. On Unix, this is equivalent to isatty(). For all other cases, such as pipes, sockets, /dev/null, this function will return %NULL. + - The console instance, or %NULL if not interactive + The console instance, or %NULL if not interactive + - The singleton stream connected to standard error + The singleton stream connected to standard error + - The singleton stream connected to standard input + The singleton stream connected to standard input + - The singleton stream connected to standard output + The singleton stream connected to standard output - The primary use case for this function is to output periodic + The primary use case for this function is to output periodic "status" or "progress" information. The first time this function is called, @line will be output normally. Subsequent invocations will overwrite the previous. @@ -66,16 +94,21 @@ You must invoke gs_console_end_status_line() to return the console to normal mode. In particular, concurrent use of this function and the stream returned by gs_console_get_stdout() results in undefined behavior. + - the #GSConsole + the #GSConsole - String to output + String to output - Complete a series of invocations of gs_console_begin_status_line(), + Complete a series of invocations of gs_console_begin_status_line(), returning the stream to normal mode. The last printed status line remains on the console; if this is not desired, print an empty string to clear it before invoking this function. + - the #GSConsole + the #GSConsole - Write @prompt to standard output, then switch output echo off, read + Write @prompt to standard output, then switch output echo off, read a result string, then switch output echo back on. + - A string, or %NULL on error + A string, or %NULL on error - the #GSConsole + the #GSConsole - A string to output before reading the password + A string to output before reading the password + + + + + + + + + + + + + + + + + + + + + + + @@ -144,18 +218,66 @@ a result string, then switch output echo back on. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - This class wraps the lower-level g_spawn_async_with_pipes() API, + This class wraps the lower-level g_spawn_async_with_pipes() API, providing a more modern GIO-style API, such as returning #GInputStream objects for child output pipes. @@ -173,10 +295,15 @@ without blocking the main loop. c:identifier="gs_subprocess_new" version="2.36" throws="1"> - Create a new process, using the parameters specified by + Create a new process, using the parameters specified by GSSubprocessContext. + - A newly created %GSSubprocess, or %NULL on error (and @error will be set) + A newly created %GSSubprocess, or %NULL on error (and @error will be set) @@ -194,6 +321,7 @@ GSSubprocessContext. + @@ -226,25 +354,34 @@ GSSubprocessContext. - Create a new subprocess using the provided argument array and + Create a new subprocess using the provided argument array and stream dispositions. + - Argument array + Argument array - Where to redirect stdout + Where to redirect stdout - Where to redirect stderr + Where to redirect stderr @@ -259,17 +396,24 @@ stream dispositions. - Run a process synchronously, throw an error if it fails. + Run a process synchronously, throw an error if it fails. + - Current working directory + Current working directory - What to do with standard input + What to do with standard input @@ -277,37 +421,50 @@ stream dispositions. transfer-ownership="none" nullable="1" allow-none="1"> - a #GCancellable + a #GCancellable - a #GError + a #GError - First argument + First argument - Remaining arguments, %NULL terminated + Remaining arguments, %NULL terminated - Use an operating-system specific method to attempt an immediate, + Use an operating-system specific method to attempt an immediate, forceful termination of the process. There is no mechanism to determine whether or not the request itself was successful; however, you can use gs_subprocess_wait() to monitor the status of the process after calling this function. On Unix, this function sends %SIGKILL. + - a #GSSubprocess + a #GSSubprocess @@ -315,7 +472,9 @@ On Unix, this function sends %SIGKILL. - The identifier for this child process; it is valid as long as the + The identifier for this child process; it is valid as long as the process @self is referenced. In particular, do <emphasis>not</emphasis> call g_spawn_close_pid() on this value; that is handled internally. @@ -330,21 +489,29 @@ gracefully handle an %ESRCH result to mitigate this. If you want to request process termination, using the high level gs_subprocess_request_exit() and gs_subprocess_force_exit() API is recommended. + - Operating-system specific identifier for child process + Operating-system specific identifier for child process - a #GSSubprocess + a #GSSubprocess + - Pipe + Pipe @@ -355,8 +522,11 @@ recommended. + - Pipe + Pipe @@ -367,8 +537,11 @@ recommended. + - Pipe + Pipe @@ -380,7 +553,9 @@ recommended. - This API uses an operating-system specific mechanism to request + This API uses an operating-system specific mechanism to request that the subprocess gracefully exit. This API is not available on all operating systems; for those not supported, it will do nothing and return %FALSE. Portable code should handle this situation @@ -396,32 +571,44 @@ You can use gs_subprocess_add_watch() to monitor the status of the process after calling this function. This function returns %TRUE if the process has already exited. + - %TRUE if the operation is supported, %FALSE otherwise. + %TRUE if the operation is supported, %FALSE otherwise. - a #GSSubprocess + a #GSSubprocess - Start an asynchronous wait for the subprocess @self to exit. + Start an asynchronous wait for the subprocess @self to exit. + - a #GSSubprocess + a #GSSubprocess - a #GCancellable + a #GCancellable allow-none="1" scope="async" closure="2"> - Invoked when process exits, or @cancellable is cancelled + Invoked when process exits, or @cancellable is cancelled - Data for @callback + Data for @callback @@ -446,29 +637,38 @@ This function returns %TRUE if the process has already exited. c:identifier="gs_subprocess_wait_finish" version="2.36" throws="1"> - The exit status of the process will be stored in @out_exit_status. + The exit status of the process will be stored in @out_exit_status. See the documentation of g_spawn_check_exit_status() for more details. Note that @error is not set if the process exits abnormally; you must use g_spawn_check_exit_status() for that. + - a #GSSubprocess + a #GSSubprocess - a #GAsyncResult + a #GAsyncResult - Exit status of the process encoded in platform-specific way + Exit status of the process encoded in platform-specific way @@ -477,31 +677,42 @@ must use g_spawn_check_exit_status() for that. c:identifier="gs_subprocess_wait_sync" version="2.36" throws="1"> - Synchronously wait for the subprocess to terminate, returning the + Synchronously wait for the subprocess to terminate, returning the status code in @out_exit_status. See the documentation of g_spawn_check_exit_status() for how to interpret it. Note that if @error is set, then @out_exit_status will be left uninitialized. + - %TRUE on success, %FALSE if @cancellable was cancelled + %TRUE on success, %FALSE if @cancellable was cancelled - a #GSSubprocess + a #GSSubprocess - Platform-specific exit code + Platform-specific exit code - a #GCancellable + a #GCancellable @@ -510,21 +721,30 @@ g_spawn_check_exit_status() for how to interpret it. Note that if c:identifier="gs_subprocess_wait_sync_check" version="2.36" throws="1"> - Combines gs_subprocess_wait_sync() with g_spawn_check_exit_status(). + Combines gs_subprocess_wait_sync() with g_spawn_check_exit_status(). + - %TRUE on success, %FALSE if process exited abnormally, or @cancellable was cancelled + %TRUE on success, %FALSE if process exited abnormally, or @cancellable was cancelled - a #GSSubprocess + a #GSSubprocess - a #GCancellable + a #GCancellable @@ -540,10 +760,13 @@ g_spawn_check_exit_status() for how to interpret it. Note that if - This class contains a set of options for launching child processes, + This class contains a set of options for launching child processes, such as where its standard input and output will be directed, the argument list, the environment, and more. @@ -552,19 +775,25 @@ popular cases, use of this class allows access to more advanced options. It can also be used to launch multiple subprocesses with a similar configuration. + - A new instance of a #GSSubprocessContext. + A new instance of a #GSSubprocessContext. - Argument list + Argument list + @@ -580,6 +809,7 @@ a similar configuration. + @@ -595,24 +825,34 @@ a similar configuration. + - A new instance of a #GSSubprocessContext. + A new instance of a #GSSubprocessContext. - First argument + First argument - a va_list + a va_list - Append an argument to the child's argument vector. + Append an argument to the child's argument vector. + @@ -621,7 +861,9 @@ a similar configuration. - An argument + An argument @@ -629,7 +871,9 @@ a similar configuration. - This allows you to open a pipe between the parent and child + This allows you to open a pipe between the parent and child processes, independent of the standard streams. For this function, the pipe is set up so that the parent can read, and the child can write. For the opposite version, see @@ -640,8 +884,11 @@ will see; you need to communicate this number via a separate channel, such as the argument list. For example, if you're using this pipe to send a password, provide <literal>--password-fd=&lt;fdno string&gt;</literal>. + - %TRUE on success, %FALSE on error (and @error will be set) + %TRUE on success, %FALSE on error (and @error will be set) @@ -652,14 +899,18 @@ this pipe to send a password, provide direction="out" caller-allocates="0" transfer-ownership="full"> - A newly referenced output stream + A newly referenced output stream - File descriptor number for the subprocess side of the pipe + File descriptor number for the subprocess side of the pipe @@ -667,10 +918,15 @@ this pipe to send a password, provide - Like gs_subprocess_context_open_pipe_read(), but returns a writable + Like gs_subprocess_context_open_pipe_read(), but returns a writable channel from which the child process can read. + - %TRUE on success, %FALSE on error (and @error will be set) + %TRUE on success, %FALSE on error (and @error will be set) @@ -681,14 +937,18 @@ channel from which the child process can read. direction="out" caller-allocates="0" transfer-ownership="full"> - A newly referenced stream + A newly referenced stream - File descriptor number for the subprocess side of the pipe + File descriptor number for the subprocess side of the pipe @@ -696,7 +956,10 @@ channel from which the child process can read. - FIXME - note extensive restricitons on GSpawnChildSetupFunc here + FIXME - note extensive restricitons on GSpawnChildSetupFunc here + @@ -705,7 +968,9 @@ channel from which the child process can read. - Function to call in the newly forked child, before execve() + Function to call in the newly forked child, before execve() @@ -713,12 +978,15 @@ channel from which the child process can read. transfer-ownership="none" nullable="1" allow-none="1"> - Data passed to child + Data passed to child + @@ -733,8 +1001,11 @@ channel from which the child process can read. - Replace the environment that will be used for the child process. + Replace the environment that will be used for the child process. The default is to inherit the current process. + @@ -743,7 +1014,9 @@ The default is to inherit the current process. - Environment KEY=VALUE pairs + Environment KEY=VALUE pairs @@ -752,6 +1025,7 @@ The default is to inherit the current process. + @@ -766,6 +1040,7 @@ The default is to inherit the current process. + @@ -783,6 +1058,7 @@ The default is to inherit the current process. + @@ -798,6 +1074,7 @@ The default is to inherit the current process. + @@ -812,6 +1089,7 @@ The default is to inherit the current process. + @@ -826,6 +1104,7 @@ The default is to inherit the current process. + @@ -841,6 +1120,7 @@ The default is to inherit the current process. + @@ -855,6 +1135,7 @@ The default is to inherit the current process. + @@ -869,6 +1150,7 @@ The default is to inherit the current process. + @@ -884,6 +1166,7 @@ The default is to inherit the current process. + @@ -898,6 +1181,7 @@ The default is to inherit the current process. + @@ -914,7 +1198,9 @@ The default is to inherit the current process. version="2.36" writable="1" transfer-ownership="none"> - Array of arguments passed to child process; must have at least + Array of arguments passed to child process; must have at least one element. The first element has special handling - if it is an not absolute path ( as determined by g_path_is_absolute() ), then the system search path will be used. See @@ -932,58 +1218,80 @@ about this, see %G_SPAWN_FILE_AND_ARGV_ZERO. - Flags to define the behaviour of the standard input/output/error of + Flags to define the behaviour of the standard input/output/error of a #GSSubprocess. + - Redirect to operating system's null output stream + Redirect to operating system's null output stream - Keep the stream from the parent process + Keep the stream from the parent process - Open a private unidirectional channel between the processes + Open a private unidirectional channel between the processes - Only applicable to standard error; causes it to be merged with standard output + Only applicable to standard error; causes it to be merged with standard output - Load all extended attributes for the file named @name residing in + Load all extended attributes for the file named @name residing in directory @dfd. + - Parent directory file descriptor + Parent directory file descriptor - File name + File name - Extended attribute set + Extended attribute set - Cancellable + Cancellable @@ -991,6 +1299,7 @@ directory @dfd. + @@ -1014,6 +1323,7 @@ directory @dfd. + @@ -1026,6 +1336,7 @@ directory @dfd. + @@ -1047,6 +1358,7 @@ directory @dfd. + @@ -1062,31 +1374,40 @@ directory @dfd. - Read all extended attributes from @fd in a canonical sorted order, and + Read all extended attributes from @fd in a canonical sorted order, and set @out_xattrs with the result. If the filesystem does not support extended attributes, @out_xattrs will have 0 elements, and this function will return successfully. + - a file descriptor + a file descriptor - A new #GVariant containing the extended attributes + A new #GVariant containing the extended attributes - Cancellable + Cancellable @@ -1094,95 +1415,135 @@ will have 0 elements, and this function will return successfully. - For each attribute in @xattrs, set its value on the file or + For each attribute in @xattrs, set its value on the file or directory referred to by @fd. This function does not remove any attributes not in @xattrs. + - File descriptor + File descriptor - Extended attributes + Extended attributes - Cancellable + Cancellable - Merely wraps UNIX chmod(). + Merely wraps UNIX chmod(). + - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - Path to file + Path to file - UNIX mode + UNIX mode - a #GCancellable + a #GCancellable - Merely wraps UNIX chown(). + Merely wraps UNIX chown(). + - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - Path to file + Path to file - UNIX owner + UNIX owner - UNIX group + UNIX group - a #GCancellable + a #GCancellable - Like g_file_create(), except this function allows specifying the + Like g_file_create(), except this function allows specifying the access mode. This allows atomically creating private files. + - Path to non-existent file + Path to non-existent file - Unix access permissions + Unix access permissions transfer-ownership="full" optional="1" allow-none="1"> - Newly created output, or %NULL + Newly created output, or %NULL - a #GCancellable + a #GCancellable @@ -1206,25 +1571,34 @@ access mode. This allows atomically creating private files. - Like g_file_make_directory(), except does not throw an error if the + Like g_file_make_directory(), except does not throw an error if the directory already exists. + - Path to create as directory + Path to create as directory - Also create parent directories + Also create parent directories - a #GCancellable + a #GCancellable @@ -1232,25 +1606,34 @@ directory already exists. - Wraps UNIX mkdir() function with support for @cancellable, and + Wraps UNIX mkdir() function with support for @cancellable, and uses @error instead of errno. + - Path to create as directory + Path to create as directory - Create directory with these permissions + Create directory with these permissions - a #GCancellable + a #GCancellable @@ -1258,7 +1641,9 @@ uses @error instead of errno. - This is a version of g_file_enumerator_next_file() that's easier to + This is a version of g_file_enumerator_next_file() that's easier to use correctly from C programs. With g_file_enumerator_next_file(), the gboolean return value signifies "end of iteration or error", which requires allocation of a temporary #GError. @@ -1294,12 +1679,15 @@ while (TRUE) out: g_object_unref (direnum); // Note: frees the last @info ]| + - an open #GFileEnumerator + an open #GFileEnumerator - Output location for the next #GFileInfo + Output location for the next #GFileInfo - Output location for the next #GFile, or %NULL + Output location for the next #GFile, or %NULL - a #GCancellable + a #GCancellable @@ -1332,39 +1726,51 @@ out: - Read all extended attributes of @f in a canonical sorted order, and + Read all extended attributes of @f in a canonical sorted order, and set @out_xattrs with the result. If the filesystem does not support extended attributes, @out_xattrs will have 0 elements, and this function will return successfully. + - a #GFile + a #GFile - A new #GVariant containing the extended attributes + A new #GVariant containing the extended attributes - Cancellable + Cancellable - Like g_file_get_basename(), but returns a constant copy so callers + Like g_file_get_basename(), but returns a constant copy so callers don't need to free the result. + @@ -1376,8 +1782,11 @@ don't need to free the result. - Like g_file_get_path(), but returns a constant copy so callers + Like g_file_get_path(), but returns a constant copy so callers don't need to free the result. + @@ -1388,54 +1797,78 @@ don't need to free the result. - Like gs_file_get_relative_path(), but does not mandate that + Like gs_file_get_relative_path(), but does not mandate that the two files have any parent in common. This function will instead insert "../" where appropriate. + - The relative path between the two. + The relative path between the two. - The first #GFile + The first #GFile - The second #GFile + The second #GFile - Merely wraps UNIX lchown(). + Merely wraps UNIX lchown(). + - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - Path to file + Path to file - UNIX owner + UNIX owner - UNIX group + UNIX group - a #GCancellable + a #GCancellable - First tries to use the UNIX link() call, but if the files are on + First tries to use the UNIX link() call, but if the files are on separate devices, fall back to copying via g_file_copy(). The given @flags have different semantics than those documented @@ -1450,20 +1883,27 @@ undesirable for the changes to also be reflected in @dest. The best use of this function is in the case where @src and @dest are read-only, or where @src is a temporary file, and you want to put it in the final place. + - Source file + Source file - Destination file + Destination file - flags + flags - This function is similar to gs_file_linkcopy(), except it also uses + This function is similar to gs_file_linkcopy(), except it also uses gs_file_sync_data() to ensure that @dest is in stable storage before it is moved into place. + - Source file + Source file - Destination file + Destination file - flags + flags - Like g_file_load_contents(), except validates the contents are + Like g_file_load_contents(), except validates the contents are UTF-8. + - Path to file whose contents must be UTF-8 + Path to file whose contents must be UTF-8 c:identifier="gs_file_map_noatime" introspectable="0" throws="1"> - Like g_mapped_file_new(), but try to avoid updating the file's + Like g_mapped_file_new(), but try to avoid updating the file's access time. This should be used by background scanning components such as search indexers, antivirus programs, etc. + - A new mapped file, or %NULL on error + A new mapped file, or %NULL on error - a #GFile + a #GFile - a #GCancellable + a #GCancellable @@ -1553,15 +2016,22 @@ components such as search indexers, antivirus programs, etc. - Return a #GBytes which references a readonly view of the contents of + Return a #GBytes which references a readonly view of the contents of @file. This function uses #GMappedFile internally. + - a newly referenced #GBytes + a newly referenced #GBytes - a #GFile + a #GFile - On success, sets @out_fd to a file descriptor for the directory + On success, sets @out_fd to a file descriptor for the directory that can be used with UNIX functions such as openat(). + - Directory name + Directory name - File descriptor for directory + File descriptor for directory - Cancellable + Cancellable @@ -1604,32 +2083,43 @@ that can be used with UNIX functions such as openat(). - On success, sets @out_fd to a file descriptor for the directory + On success, sets @out_fd to a file descriptor for the directory that can be used with UNIX functions such as openat(). + - Parent directory file descriptor + Parent directory file descriptor - Directory name + Directory name - File descriptor for directory + File descriptor for directory - Cancellable + Cancellable @@ -1637,27 +2127,36 @@ that can be used with UNIX functions such as openat(). - Like g_file_open_tmp(), except the file will be created in the + Like g_file_open_tmp(), except the file will be created in the provided @tmpdir, and allows specification of the Unix @mode, which means private files may be created. Return values will be stored in @out_file, and optionally @out_stream. + - Directory to place temporary file + Directory to place temporary file - Default mode (will be affected by umask) + Default mode (will be affected by umask) - Newly created file path + Newly created file path transfer-ownership="full" optional="1" allow-none="1"> - Newly created output stream + Newly created output stream - Like g_file_open_tmp(), except the file will be created in the + Like g_file_open_tmp(), except the file will be created in the provided @tmpdir, and allows specification of the Unix @mode, which means private files may be created. Return values will be stored in @out_name, and optionally @out_stream. + - Directory to place temporary file + Directory to place temporary file - Default mode (will be affected by umask) + Default mode (will be affected by umask) - Newly created file name + Newly created file name transfer-ownership="full" optional="1" allow-none="1"> - Newly created output stream + Newly created output stream - Wrapper for openat() using %O_RDONLY with %O_NOATIME if available. + Wrapper for openat() using %O_RDONLY with %O_NOATIME if available. + - File descriptor for directory + File descriptor for directory - Pathname, relative to @dfd + Pathname, relative to @dfd - Returned file descriptor + Returned file descriptor - Cancellable + Cancellable @@ -1755,62 +2278,89 @@ in @out_name, and optionally @out_stream. - Like g_file_read(), but try to avoid updating the file's + Like g_file_read(), but try to avoid updating the file's access time. This should be used by background scanning components such as search indexers, antivirus programs, etc. + - A new input stream, or %NULL on error + A new input stream, or %NULL on error - a #GFile + a #GFile - a #GCancellable + a #GCancellable - Return a #GFile that contains the same path with symlinks + Return a #GFile that contains the same path with symlinks followed. That is, it's a #GFile whose path is the result of calling realpath() on @file. + - A new #GFile or %NULL if @file is invalid + A new #GFile or %NULL if @file is invalid - A #GFile + A #GFile - This function wraps the raw Unix function rename(). + This function wraps the raw Unix function rename(). + - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - Current path + Current path - New path + New path - a #GCancellable + a #GCancellable @@ -1818,26 +2368,35 @@ of calling realpath() on @file. - For each attribute in @xattrs, set its value on the file or + For each attribute in @xattrs, set its value on the file or directory referred to by @file. This function does not remove any attributes not in @xattrs. + - File descriptor + File descriptor - Extended attributes + Extended attributes - Cancellable + Cancellable @@ -1845,14 +2404,19 @@ attributes not in @xattrs. - Wraps the UNIX fsync() function (or fdatasync(), if available), which + Wraps the UNIX fsync() function (or fdatasync(), if available), which ensures that the data in @file is on non-volatile storage. + - a #GFile + a #GFile - Like g_file_delete(), except this function does not follow Unix + Like g_file_delete(), except this function does not follow Unix symbolic links, and will delete a symbolic link even if it's pointing to a nonexistent file. In other words, this function merely wraps the raw Unix function unlink(). + - %TRUE on success, %FALSE on error + %TRUE on success, %FALSE on error - Path to file + Path to file - a #GCancellable + a #GCancellable - Generate a name suitable for use as a temporary file. This + Generate a name suitable for use as a temporary file. This function does no I/O; it is not guaranteed that a file with that name does not exist. + @@ -1899,39 +2475,95 @@ name does not exist. transfer-ownership="none" nullable="1" allow-none="1"> - String prepended to the result + String prepended to the result - String suffixed to the result + String suffixed to the result + + These macros leverage the GCC extension __attribute__ ((cleanup)) +to allow calling a cleanup function such as g_free() when a +variable goes out of scope. See <ulink +url="http://gcc.gnu.org/onlinedocs/gcc/Variable-Attributes.html"> +for more information on the attribute. + +The provided macros make it easy to use the cleanup attribute for +types that come with GLib. The primary two are #gs_free and +#gs_unref_object, which correspond to g_free() and +g_object_unref(), respectively. + +The rationale behind this is that particularly when handling error +paths, it can be very tricky to ensure the right variables are +freed. With this, one simply applies gs_lobj to a +locally-allocated #GFile for example, and it will be automatically +unreferenced when it goes out of scope. + +Note - you should only use these macros for <emphasis>stack +allocated</emphasis> variables. They don't provide garbage +collection or let you avoid freeing things. They're simply a +compiler assisted deterministic mechanism for calling a cleanup +function when a stack frame ends. + +<example id="gs-lfree"><title>Calling g_free automatically</title> +<programlisting> + +GFile * +create_file (GError **error) +{ + gs_free char *random_id = NULL; + + if (!prepare_file (error)) + return NULL; + + random_id = alloc_random_id (); + + return create_file_real (error); + // Note that random_id is freed here automatically +} +</programlisting> +</example> + - Log structured data in an operating-system specific fashion. The + Log structured data in an operating-system specific fashion. The parameter @opts should be an array of UTF-8 KEY=VALUE strings. This function does not support binary data. See http://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html for more information about fields that can be used on a systemd system. + - Text message to send + Text message to send - Optional structured data - + Optional structured data + @@ -1939,22 +2571,29 @@ system. - Like gs_log_structured(), but also print to standard output (if it + Like gs_log_structured(), but also print to standard output (if it is not already connected to the system log). + - A message to log + A message to log - Optional structured data - + Optional structured data + @@ -1963,20 +2602,27 @@ is not already connected to the system log). - The provided @message_id is a unique MESSAGE_ID (see <ulink url="http://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html"> for more information). + The provided @message_id is a unique MESSAGE_ID (see <ulink url="http://www.freedesktop.org/software/systemd/man/systemd.journal-fields.html"> for more information). This function otherwise acts as gs_log_structured_print(), taking @format as a format string. + - A unique MESSAGE_ID + A unique MESSAGE_ID - A format string + A format string @@ -1985,21 +2631,30 @@ This function otherwise acts as gs_log_structured_print(), taking - Use openat() to open a directory, using a standard set of flags. + Use openat() to open a directory, using a standard set of flags. + - File descriptor for origin directory + File descriptor for origin directory - Pathname, relative to @dfd + Pathname, relative to @dfd - Whether or not to follow symbolic links + Whether or not to follow symbolic links @@ -2009,31 +2664,40 @@ This function otherwise acts as gs_log_structured_print(), taking - Use openat() to open a directory, using a standard set of flags. + Use openat() to open a directory, using a standard set of flags. This function sets errno. + - File descriptor for origin directory + File descriptor for origin directory - Pathname, relative to @dfd - Whether or not to follow symbolic links + Whether or not to follow symbolic links - Set @error to an error with domain %G_IO_ERROR, and code based on + Set @error to an error with domain %G_IO_ERROR, and code based on the value of @saved_errno. The error message is set using a literal return from g_strerror(). + @@ -2042,11 +2706,15 @@ literal return from g_strerror(). transfer-ownership="none" nullable="1" allow-none="1"> - Error + Error - errno value + errno value @@ -2054,10 +2722,13 @@ literal return from g_strerror(). - Set @error to an error with domain %G_IO_ERROR, and code based on + Set @error to an error with domain %G_IO_ERROR, and code based on the value of @saved_errno. The error message is prefixed with the result of @format, a colon and space, then the result of g_strerror(). + @@ -2066,15 +2737,18 @@ g_strerror(). transfer-ownership="none" nullable="1" allow-none="1"> - Error + Error - - errno value + - Format string for printf + Format string for printf @@ -2083,19 +2757,28 @@ g_strerror(). - Recursively copy path @src (which must be a directory) to the + Recursively copy path @src (which must be a directory) to the target @dest. Any existing files are overwritten. + - %TRUE on success + %TRUE on success - Source path + Source path - Destination path + Destination path - Recursively copy path @src (which must be a directory) to the + Recursively copy path @src (which must be a directory) to the target @dest. If possible, hardlinks are used; if a hardlink is not possible, a regular copy is created. Any existing files are overwritten. + - %TRUE on success + %TRUE on success - Source path + Source path - Destination path + Destination path - Recursively delete the filename referenced by @path; it may be a + Recursively delete the filename referenced by @path; it may be a file or directory. No error is thrown if @path does not exist. + - A file or directory + A file or directory - Recursively delete the filename referenced by the combination of + Recursively delete the filename referenced by the combination of the directory fd@dfd and @path; it may be a file or directory. No error is thrown if @path does not exist. + - - A directory file descriptor, or -1 for current + - Path + Path - Cancellable + Cancellable - Use this function when you want your code to behave differently + Use this function when you want your code to behave differently depeneding on whether your program was started as a systemd unit, or e.g. interactively at a terminal. + - %TRUE if stdout is (probably) connnected to the systemd journal + %TRUE if stdout is (probably) connnected to the systemd journal + + + + + + + + + diff --git a/girs/GTop-2.0.gir b/girs/GTop-2.0.gir index 4f1d5ac31..c13bad266 100644 --- a/girs/GTop-2.0.gir +++ b/girs/GTop-2.0.gir @@ -2080,7 +2080,7 @@ and/or use gtk-doc annotations. --> diff --git a/girs/GUPnP-1.6.gir b/girs/GUPnP-1.6.gir index 5bfbef664..d09a3f04c 100644 --- a/girs/GUPnP-1.6.gir +++ b/girs/GUPnP-1.6.gir @@ -74,7 +74,7 @@ otherwise. filename="libgupnp/gupnp-acl.c" line="38">The [class@GUPnP.Device] associated with @path or %NULL if unknown. - + filename="libgupnp/gupnp-acl.c" line="40">The [class@GUPnP.Service] associated with @path or %NULL if unknown. - + filename="libgupnp/gupnp-acl.c" line="72">The [class@GUPnP.Device] associated with @path or %NULL if unknown. - + filename="libgupnp/gupnp-acl.c" line="74">The [class@GUPnP.Service] associated with @path or %NULL if unknown. - + filename="libgupnp/gupnp-acl.c" line="38">The [class@GUPnP.Device] associated with @path or %NULL if unknown. - + filename="libgupnp/gupnp-acl.c" line="40">The [class@GUPnP.Service] associated with @path or %NULL if unknown. - + filename="libgupnp/gupnp-acl.c" line="72">The [class@GUPnP.Device] associated with @path or %NULL if unknown. - + filename="libgupnp/gupnp-acl.c" line="74">The [class@GUPnP.Service] associated with @path or %NULL if unknown. - + filename="libgupnp/gupnp-acl.c" line="38">The [class@GUPnP.Device] associated with @path or %NULL if unknown. - + filename="libgupnp/gupnp-acl.c" line="40">The [class@GUPnP.Service] associated with @path or %NULL if unknown. - + filename="libgupnp/gupnp-acl.c" line="72">The [class@GUPnP.Device] associated with @path or %NULL if unknown. - + filename="libgupnp/gupnp-acl.c" line="74">The [class@GUPnP.Service] associated with @path or %NULL if unknown. - + Create a new #GUPnPControlPoint with the specified @context and @target. + line="1177">Create a new #GUPnPControlPoint with the specified @context and @target. @target should be a service or device name, such as `urn:schemas-upnp-org:service:WANIPConnection:1` or @@ -2215,20 +2215,20 @@ the specified discovery target changes. A new #GUPnPControlPoint object. + line="1188">A new #GUPnPControlPoint object. A #GUPnPContext + line="1179">A #GUPnPContext The search target + line="1180">The search target @@ -2236,7 +2236,7 @@ the specified discovery target changes. Create a new #GUPnPControlPoint with the specified @context, @factory and + line="1203">Create a new #GUPnPControlPoint with the specified @context, @factory and @target. @target should be a service or device name, such as @@ -2250,26 +2250,26 @@ By passing a custom `GUPnPResourceFactory`, the proxies handed out in ::device-a A new #GUPnPControlPoint object. + line="1220">A new #GUPnPControlPoint object. A #GUPnPContext + line="1205">A #GUPnPContext A #GUPnPResourceFactory + line="1206">A #GUPnPResourceFactory The search target + line="1207">The search target @@ -2336,20 +2336,20 @@ By passing a custom `GUPnPResourceFactory`, the proxies handed out in ::device-a deprecated-version="1.4.0"> Get the #GUPnPControlPoint associated with @control_point. + line="1239">Get the #GUPnPControlPoint associated with @control_point. Use [method@GSSDP.ResourceBrowser.get_client] instead. The #GUPnPContext. + line="1245">The #GUPnPContext. A #GUPnPControlPoint + line="1241">A #GUPnPControlPoint @@ -2361,21 +2361,21 @@ By passing a custom `GUPnPResourceFactory`, the proxies handed out in ::device-a value="resource-factory"/> Get the #GUPnPResourceFactory used by the @control_point. If none was set during construction + line="1317">Get the #GUPnPResourceFactory used by the @control_point. If none was set during construction by calling [ctor@GUPnP.ControlPoint.new_full], equivalent to calling [func@GUPnP.ResourceFactory.get_default] The #GUPnPResourceFactory used by this control point + line="1325">The #GUPnPResourceFactory used by this control point A #GUPnPControlPoint + line="1319">A #GUPnPControlPoint @@ -2384,7 +2384,7 @@ by calling [ctor@GUPnP.ControlPoint.new_full], equivalent to calling c:identifier="gupnp_control_point_list_device_proxies"> Get the list of #GUPnPDeviceProxy objects the control point currently assumes to + line="1261">Get the list of #GUPnPDeviceProxy objects the control point currently assumes to be active. Since a device might have gone offline without signalizing it, but @@ -2396,7 +2396,7 @@ Do not free the list nor its elements. Device proxies + line="1274">Device proxies currently assumed to be active. @@ -2406,7 +2406,7 @@ currently assumed to be active. A #GUPnPControlPoint + line="1263">A #GUPnPControlPoint @@ -2415,7 +2415,7 @@ currently assumed to be active. c:identifier="gupnp_control_point_list_service_proxies"> Get the list of discovered #GUPnPServiceProxy objects the control point currently assumes to + line="1289">Get the list of discovered #GUPnPServiceProxy objects the control point currently assumes to be active. Since a device might have gone offline without signalizing it, but @@ -2427,7 +2427,7 @@ Do not free the list nor its elements. Service proxies + line="1302">Service proxies currently assumed to be active. @@ -2437,7 +2437,7 @@ currently assumed to be active. A #GUPnPControlPoint + line="1291">A #GUPnPControlPoint @@ -2451,7 +2451,7 @@ currently assumed to be active. value="gupnp_control_point_get_resource_factory"/> The resource factory to use. Set to NULL for default factory. + line="1074">The resource factory to use. Set to NULL for default factory. @@ -2460,7 +2460,7 @@ currently assumed to be active. The ::device-proxy-available signal is emitted whenever a new + line="1092">The ::device-proxy-available signal is emitted whenever a new device has become available. @@ -2469,7 +2469,7 @@ device has become available. The now available #GUPnPDeviceProxy + line="1095">The now available #GUPnPDeviceProxy @@ -2477,7 +2477,7 @@ device has become available. The ::device-proxy-unavailable signal is emitted whenever a + line="1113">The ::device-proxy-unavailable signal is emitted whenever a device is not available any more. @@ -2486,7 +2486,7 @@ device is not available any more. The now unavailable #GUPnPDeviceProxy + line="1116">The now unavailable #GUPnPDeviceProxy @@ -2494,7 +2494,7 @@ device is not available any more. The ::service-proxy-available signal is emitted whenever a new + line="1134">The ::service-proxy-available signal is emitted whenever a new service has become available. @@ -2503,7 +2503,7 @@ service has become available. The now available #GUPnPServiceProxy + line="1137">The now available #GUPnPServiceProxy @@ -2511,7 +2511,7 @@ service has become available. The ::service-proxy-unavailable signal is emitted whenever a + line="1155">The ::service-proxy-unavailable signal is emitted whenever a service is not available any more. @@ -2520,7 +2520,7 @@ service is not available any more. The now unavailable #GUPnPServiceProxy + line="1158">The now unavailable #GUPnPServiceProxy @@ -2654,7 +2654,7 @@ service is not available any more. glib:type-struct="DeviceClass"> Base class for UPnP device implementations. + line="25">Base class for UPnP device implementations. #GUPnPDevice allows for retrieving a device's sub-devices and services. #GUPnPDevice implements the #GUPnPDeviceInfo @@ -4611,7 +4611,7 @@ absolute path or path relative to GUPnPRootDevice:description-dir. glib:type-struct="ServiceClass"> Implementation of an UPnP service + line="52">Implementation of an UPnP service #GUPnPService allows for handling incoming actions and state variable notification. It implements the [class@GUPnP.ServiceInfo] interface. @@ -4625,7 +4625,7 @@ For more details, see the ["Implementing UPnP devices"](server-tutorial.html#imp Default handler for [signal@GUPnP.Service::action_invoked]. See its documentation for details. + line="1874">Default handler for [signal@GUPnP.Service::action_invoked]. See its documentation for details. Can be overridden by child classes instead of connecting to the signal. @@ -4636,13 +4636,13 @@ Can be overridden by child classes instead of connecting to the signal. a `GUPnPService` + line="1876">a `GUPnPService` a `GUPnPServiceAction` + line="1877">a `GUPnPServiceAction` @@ -4650,7 +4650,7 @@ Can be overridden by child classes instead of connecting to the signal. Default handler for [signal@GUPnP.Service::notify_failed]. See its documentation for details. + line="1913">Default handler for [signal@GUPnP.Service::notify_failed]. See its documentation for details. Can be overridden by child classes instead of connecting to the signal. @@ -4661,13 +4661,13 @@ Can be overridden by child classes instead of connecting to the signal. a `GUPnPService` + line="1915">a `GUPnPService` a list of call-back urls that failed the notification + line="1916">a list of call-back urls that failed the notification @@ -4675,7 +4675,7 @@ Can be overridden by child classes instead of connecting to the signal. An error that describes why the notification failed + line="1917">An error that describes why the notification failed @@ -4683,7 +4683,7 @@ Can be overridden by child classes instead of connecting to the signal. Default handler for [signal@GUPnP.Service::query_variable]. See its documentation for details. + line="1892">Default handler for [signal@GUPnP.Service::query_variable]. See its documentation for details. Can be overridden by child classes instead of connecting to the signal. @@ -4694,19 +4694,19 @@ Can be overridden by child classes instead of connecting to the signal. a `GUPnPService` + line="1894">a `GUPnPService` the name of the variable that was queried + line="1895">the name of the variable that was queried a value that should be filled to the current value of @variable + line="1896">a value that should be filled to the current value of @variable @@ -4715,7 +4715,7 @@ Can be overridden by child classes instead of connecting to the signal. c:identifier="gupnp_service_action_invoked"> Default handler for [signal@GUPnP.Service::action_invoked]. See its documentation for details. + line="1874">Default handler for [signal@GUPnP.Service::action_invoked]. See its documentation for details. Can be overridden by child classes instead of connecting to the signal. @@ -4726,13 +4726,13 @@ Can be overridden by child classes instead of connecting to the signal. a `GUPnPService` + line="1876">a `GUPnPService` a `GUPnPServiceAction` + line="1877">a `GUPnPServiceAction` @@ -4793,7 +4793,7 @@ terminated with %NULL. Default handler for [signal@GUPnP.Service::notify_failed]. See its documentation for details. + line="1913">Default handler for [signal@GUPnP.Service::notify_failed]. See its documentation for details. Can be overridden by child classes instead of connecting to the signal. @@ -4804,13 +4804,13 @@ Can be overridden by child classes instead of connecting to the signal. a `GUPnPService` + line="1915">a `GUPnPService` a list of call-back urls that failed the notification + line="1916">a list of call-back urls that failed the notification @@ -4818,7 +4818,7 @@ Can be overridden by child classes instead of connecting to the signal. An error that describes why the notification failed + line="1917">An error that describes why the notification failed @@ -4856,7 +4856,7 @@ Can be overridden by child classes instead of connecting to the signal. c:identifier="gupnp_service_query_variable"> Default handler for [signal@GUPnP.Service::query_variable]. See its documentation for details. + line="1892">Default handler for [signal@GUPnP.Service::query_variable]. See its documentation for details. Can be overridden by child classes instead of connecting to the signal. @@ -4867,19 +4867,19 @@ Can be overridden by child classes instead of connecting to the signal. a `GUPnPService` + line="1894">a `GUPnPService` the name of the variable that was queried + line="1895">the name of the variable that was queried a value that should be filled to the current value of @variable + line="1896">a value that should be filled to the current value of @variable @@ -5532,13 +5532,13 @@ argument. a `GUPnPService` + line="1876">a `GUPnPService` a `GUPnPServiceAction` + line="1877">a `GUPnPServiceAction` @@ -5554,19 +5554,19 @@ argument. a `GUPnPService` + line="1894">a `GUPnPService` the name of the variable that was queried + line="1895">the name of the variable that was queried a value that should be filled to the current value of @variable + line="1896">a value that should be filled to the current value of @variable @@ -5582,13 +5582,13 @@ argument. a `GUPnPService` + line="1915">a `GUPnPService` a list of call-back urls that failed the notification + line="1916">a list of call-back urls that failed the notification @@ -5596,7 +5596,7 @@ argument. An error that describes why the notification failed + line="1917">An error that describes why the notification failed @@ -5668,7 +5668,7 @@ argument. glib:type-struct="ServiceInfoClass"> Service information shared by local and remote services. + line="47">Service information shared by local and remote services. A class that contains the common parts between local and remote services. @@ -5677,19 +5677,19 @@ A class that contains the common parts between local and remote services. glib:get-property="context"> Get the #GUPnPContext associated with @info. + line="337">Get the #GUPnPContext associated with @info. A #GUPnPContext. + line="343">A #GUPnPContext. A #GUPnPServiceInfo + line="339">A #GUPnPServiceInfo @@ -5698,19 +5698,19 @@ A class that contains the common parts between local and remote services. c:identifier="gupnp_service_info_get_control_url"> Get the control URL for this service, or %NULL.. + line="493">Get the control URL for this service, or %NULL.. A string. This string should be freed with g_free() after use. + line="499">A string. This string should be freed with g_free() after use. A #GUPnPServiceInfo + line="495">A #GUPnPServiceInfo @@ -5719,19 +5719,19 @@ A class that contains the common parts between local and remote services. c:identifier="gupnp_service_info_get_event_subscription_url"> Get the event subscription URL for this service, or %NULL. + line="515">Get the event subscription URL for this service, or %NULL. A string. This string should be freed with g_free() after use. + line="521">A string. This string should be freed with g_free() after use. A #GUPnPServiceInfo + line="517">A #GUPnPServiceInfo @@ -5739,7 +5739,7 @@ A class that contains the common parts between local and remote services. Get the serviceID of this service, or %NULL if there is no ID. + line="445">Get the serviceID of this service, or %NULL if there is no ID. The serviceID should be unique to a device. This makes it possible to provide the same serviceType multiple times on one device @@ -5749,14 +5749,14 @@ Example: `org:serviceId:RenderingControl` A string. This string should be freed with g_free() after use. + line="456">A string. This string should be freed with g_free() after use. A #GUPnPServiceInfo + line="447">A #GUPnPServiceInfo @@ -5766,19 +5766,19 @@ Example: `org:serviceId:RenderingControl` glib:get-property="location"> Get the location of the device description file. + line="357">Get the location of the device description file. A constant string. + line="363">A constant string. A #GUPnPServiceInfo + line="359">A #GUPnPServiceInfo @@ -5787,19 +5787,19 @@ Example: `org:serviceId:RenderingControl` c:identifier="gupnp_service_info_get_scpd_url"> Get the SCPD URL for this service, or %NULL if there is no SCPD. + line="471">Get the SCPD URL for this service, or %NULL if there is no SCPD. A string. This string should be freed with g_free() after use. + line="477">A string. This string should be freed with g_free() after use. A #GUPnPServiceInfo + line="473">A #GUPnPServiceInfo @@ -5809,21 +5809,21 @@ Example: `org:serviceId:RenderingControl` glib:get-property="service-type"> Get the UPnP service type, or %NULL. + line="417">Get the UPnP service type, or %NULL. Example: `urn:schemas-upnp-org:service:RenderingControl:1` A constant string. + line="425">A constant string. A #GUPnPServiceInfo + line="419">A #GUPnPServiceInfo @@ -5833,19 +5833,19 @@ Example: `urn:schemas-upnp-org:service:RenderingControl:1` glib:get-property="udn"> Get the Unique Device Name of the containing device. + line="397">Get the Unique Device Name of the containing device. A constant string. + line="403">A constant string. A #GUPnPServiceInfo + line="399">A #GUPnPServiceInfo @@ -5855,19 +5855,19 @@ Example: `urn:schemas-upnp-org:service:RenderingControl:1` glib:get-property="url-base"> Get the URL base of this service. + line="377">Get the URL base of this service. A constant #SoupURI. + line="383">A constant #SoupURI. A #GUPnPServiceInfo + line="379">A #GUPnPServiceInfo @@ -5877,7 +5877,7 @@ Example: `urn:schemas-upnp-org:service:RenderingControl:1` version="1.2.2"> Note that introspection object is created from the information in service + line="605">Note that introspection object is created from the information in service description document (SCPD) provided by the service so it can not be created if the service does not provide a SCPD. @@ -5891,7 +5891,7 @@ error code %G_IO_ERROR_CANCELLED. A #GUPnPServiceInfo + line="607">A #GUPnPServiceInfo allow-none="1"> a #GCancellable that can be used to cancel the call. + line="608">a #GCancellable that can be used to cancel the call. closure="2"> callback to be called when introspection object is ready. + line="609">callback to be called when introspection object is ready. allow-none="1"> user_data to be passed to the callback. + line="610">user_data to be passed to the callback. @@ -5931,13 +5931,13 @@ error code %G_IO_ERROR_CANCELLED. throws="1"> Finish an asynchronous call initiated with + line="693">Finish an asynchronous call initiated with gupnp_service_info_introspect_async(). %NULL, if the call had an error, a + line="702">%NULL, if the call had an error, a #GUPnPServiceIntrospection object otherwise. @@ -5946,13 +5946,13 @@ gupnp_service_info_introspect_async(). A GUPnPServiceInfo + line="695">A GUPnPServiceInfo A #GAsyncResult + line="696">A #GAsyncResult @@ -5964,7 +5964,7 @@ gupnp_service_info_introspect_async(). getter="get_context"> The #GUPnPContext to use. + line="205">The #GUPnPContext to use. transfer-ownership="none"> Private property. + line="295">Private property. transfer-ownership="none"> Private property. + line="316">Private property. default-value="NULL"> The location of the device description file. + line="223">The location of the device description file. default-value="NULL"> The service type. + line="260">The service type. default-value="NULL"> The UDN of the containing device. + line="242">The UDN of the containing device. getter="get_url_base"> The URL base (#SoupURI). + line="278">The URL base (#SoupURI). @@ -6108,13 +6108,13 @@ to be used for regular device or control point development. c:identifier="gupnp_service_introspection_get_action"> Returns the action by the name @action_name in this service. + line="978">Returns the action by the name @action_name in this service. the action or %NULL. Do not modify or free + line="985">the action or %NULL. Do not modify or free it. @@ -6123,14 +6123,14 @@ it. A #GUPnPServiceIntrospection + line="980">A #GUPnPServiceIntrospection The name of the action to retrieve + line="981">The name of the action to retrieve @@ -6139,13 +6139,13 @@ it. c:identifier="gupnp_service_introspection_get_state_variable"> Returns the state variable by the name @variable_name in this service. + line="938">Returns the state variable by the name @variable_name in this service. the state variable or %NULL. Do not modify or + line="945">the state variable or %NULL. Do not modify or free it. @@ -6154,14 +6154,14 @@ free it. A #GUPnPServiceIntrospection + line="940">A #GUPnPServiceIntrospection The name of the variable to retrieve + line="941">The name of the variable to retrieve @@ -6170,13 +6170,13 @@ free it. c:identifier="gupnp_service_introspection_list_action_names"> Returns a GList of names of all the actions in this service. + line="828">Returns a GList of names of all the actions in this service. A GList of names of all + line="834">A GList of names of all the actions or %NULL. Do not modify or free it or its contents. @@ -6186,7 +6186,7 @@ the actions or %NULL. Do not modify or free it or its contents. A #GUPnPServiceIntrospection + line="830">A #GUPnPServiceIntrospection @@ -6196,14 +6196,14 @@ the actions or %NULL. Do not modify or free it or its contents. c:identifier="gupnp_service_introspection_list_actions"> Returns a #GList of all the actions (of type #GUPnPServiceActionInfo) in + line="857">Returns a #GList of all the actions (of type #GUPnPServiceActionInfo) in this service. A + line="864">A #GList of all the actions or %NULL. Do not modify or free it or its contents. @@ -6214,7 +6214,7 @@ contents. A #GUPnPServiceIntrospection + line="859">A #GUPnPServiceIntrospection @@ -6224,13 +6224,13 @@ contents. c:identifier="gupnp_service_introspection_list_state_variable_names"> Returns a #GList of names of all the state variables in this service. + line="902">Returns a #GList of names of all the state variables in this service. A #GList of names of all + line="908">A #GList of names of all the state variables or %NULL. Do not modify or free it or its contents. @@ -6240,7 +6240,7 @@ the state variables or %NULL. Do not modify or free it or its contents. A #GUPnPServiceIntrospection + line="904">A #GUPnPServiceIntrospection @@ -6250,14 +6250,14 @@ the state variables or %NULL. Do not modify or free it or its contents. c:identifier="gupnp_service_introspection_list_state_variables"> Returns a GList of all the state variables (of type + line="879">Returns a GList of all the state variables (of type #GUPnPServiceStateVariableInfo) in this service. + line="886"> A #GList of all the state variables or %NULL. Do not modify or free it or its contents. @@ -6268,7 +6268,7 @@ its contents. A #GUPnPServiceIntrospection + line="881">A #GUPnPServiceIntrospection @@ -6327,13 +6327,13 @@ its contents. glib:type-struct="ServiceProxyClass"> Proxy class for remote services. + line="57">Proxy class for remote services. #GUPnPServiceProxy sends commands to a remote UPnP service and handles incoming event notifications. - + - + @@ -6352,32 +6352,32 @@ incoming event notifications. introspectable="0"> Sets up @callback to be called whenever a change notification for + line="564">Sets up @callback to be called whenever a change notification for @variable is recieved. - + %TRUE on success. + line="575">%TRUE on success. A #GUPnPServiceProxy + line="566">A #GUPnPServiceProxy The variable to add notification for + line="567">The variable to add notification for The type of the variable + line="568">The type of the variable closure="3"> The callback to call when @variable changes + line="569">The callback to call when @variable changes @@ -6396,7 +6396,7 @@ incoming event notifications. allow-none="1"> User data for @callback + line="570">User data for @callback @@ -6407,32 +6407,32 @@ incoming event notifications. version="0.20.12"> Sets up @callback to be called whenever a change notification for + line="593">Sets up @callback to be called whenever a change notification for @variable is recieved. - + %TRUE on success. + line="607">%TRUE on success. A #GUPnPServiceProxy + line="595">A #GUPnPServiceProxy The variable to add notification for + line="596">The variable to add notification for The type of the variable + line="597">The type of the variable destroy="4"> The callback to call when @variable changes + line="598">The callback to call when @variable changes @@ -6452,7 +6452,7 @@ incoming event notifications. allow-none="1"> User data for @callback + line="599">User data for @callback scope="async"> Function to call when the notification is removed, or %NULL + line="600">Function to call when the notification is removed, or %NULL @@ -6472,22 +6472,22 @@ incoming event notifications. version="0.20.12"> Get a notification for anything that happens on the peer. + line="669">Get a notification for anything that happens on the peer. @value in @callback will be of type G_TYPE_POINTER and contain the pre-parsed [type@libxml2.Doc]. Do NOT free or modify this document. - + %TRUE on success. + line="682">%TRUE on success. A #GUPnPServiceProxy + line="671">A #GUPnPServiceProxy destroy="2"> The callback to call when the peer issues any + line="672">The callback to call when the peer issues any variable notification. @@ -6508,7 +6508,7 @@ variable notification. allow-none="1"> User data for @callback + line="674">User data for @callback scope="async"> A #GDestroyNotify for @user_data + line="675">A #GDestroyNotify for @user_data @@ -6529,25 +6529,25 @@ variable notification. throws="1"> Synchronously call the @action on the remote UPnP service. - + line="1646">Synchronously call the @action on the remote UPnP service. + %NULL on error, @action if successful. + line="1656">%NULL on error, @action if successful. A #GUPnPServiceProxy + line="1648">A #GUPnPServiceProxy An action + line="1649">An action allow-none="1"> A #GCancellable which can be used to cancel the + line="1650">A #GCancellable which can be used to cancel the current action call @@ -6567,13 +6567,13 @@ current action call version="1.2.0"> Start a call on the remote UPnP service using the pre-configured @action. + line="1571">Start a call on the remote UPnP service using the pre-configured @action. Use gupnp_service_proxy_call_action_finish() in the @callback to finalize the call and gupnp_service_proxy_action_get_result(), gupnp_service_proxy_action_get_result_hash() or gupnp_service_proxy_action_get_result_list() to extract the result of the remote call. - + @@ -6581,13 +6581,13 @@ remote call. A #GUPnPServiceProxy + line="1573">A #GUPnPServiceProxy A #GUPnPServiceProxyAction to call + line="1574">A #GUPnPServiceProxyAction to call allow-none="1"> A #GCancellable which can be used to cancel the + line="1575">A #GCancellable which can be used to cancel the current action call @@ -6608,7 +6608,7 @@ current action call closure="3"> A #GAsyncReadyCallback to call when the action is + line="1577">A #GAsyncReadyCallback to call when the action is finished. @@ -6618,7 +6618,7 @@ finished. allow-none="1"> User data for @callback + line="1579">User data for @callback @@ -6629,26 +6629,26 @@ finished. throws="1"> Finish an asynchronous call initiated with + line="1620">Finish an asynchronous call initiated with gupnp_service_proxy_call_action_async(). - + %NULL, if the call had an error, the action otherwise. + line="1629">%NULL, if the call had an error, the action otherwise. a #GUPnPServiceProxy + line="1622">a #GUPnPServiceProxy a #GAsyncResult + line="1623">a #GAsyncResult @@ -6658,19 +6658,19 @@ gupnp_service_proxy_call_action_async(). glib:get-property="subscribed"> Returns if we are subscribed to this service. - + line="1551">Returns if we are subscribed to this service. + %TRUE if we are subscribed to this service, otherwise %FALSE. + line="1557">%TRUE if we are subscribed to this service, otherwise %FALSE. A #GUPnPServiceProxy + line="1553">A #GUPnPServiceProxy @@ -6679,30 +6679,30 @@ gupnp_service_proxy_call_action_async(). c:identifier="gupnp_service_proxy_remove_notify"> Cancels the variable change notification for @callback and @user_data. + line="701">Cancels the variable change notification for @callback and @user_data. Up to version 0.20.9 this function must not be called directlya or indirectly from a #GUPnPServiceProxyNotifyCallback associated with this service proxy, even if it is for another variable. In later versions such calls are allowed. - + %TRUE on success. + line="715">%TRUE on success. A #GUPnPServiceProxy + line="703">A #GUPnPServiceProxy The variable to add notification for + line="704">The variable to add notification for closure="2"> The callback to call when @variable changes + line="705">The callback to call when @variable changes @@ -6721,7 +6721,7 @@ calls are allowed. allow-none="1"> User data for @callback + line="706">User data for @callback @@ -6730,23 +6730,23 @@ calls are allowed. c:identifier="gupnp_service_proxy_remove_raw_notify"> Cancels the variable change notification for @callback and @user_data. + line="780">Cancels the variable change notification for @callback and @user_data. This function must not be called directly or indirectly from a #GUPnPServiceProxyNotifyCallback associated with this service proxy, even if it is for another variable. - + %TRUE on success. + line="792">%TRUE on success. A #GUPnPServiceProxy + line="782">A #GUPnPServiceProxy closure="1"> The callback to call when @variable changes + line="783">The callback to call when @variable changes @@ -6765,7 +6765,7 @@ if it is for another variable. allow-none="1"> User data for @callback + line="784">User data for @callback @@ -6775,8 +6775,8 @@ if it is for another variable. version="1.6.4"> Sets user and password for authentication - + line="1720">Sets user and password for authentication + @@ -6784,19 +6784,19 @@ if it is for another variable. A #GUPnPServiceProxy + line="1722">A #GUPnPServiceProxy user name for authentication + line="1723">user name for authentication user password for authentication + line="1724">user password for authentication @@ -6806,13 +6806,13 @@ if it is for another variable. glib:set-property="subscribed"> (Un)subscribes to this service. + line="1517">(Un)subscribes to this service. <note>The relevant messages are not immediately sent but queued. If you want to unsubcribe from this service because the application is quitting, rely on automatic synchronised unsubscription on object destruction instead.</note> - + @@ -6820,13 +6820,13 @@ destruction instead.</note> A #GUPnPServiceProxy + line="1519">A #GUPnPServiceProxy %TRUE to subscribe to this service + line="1520">%TRUE to subscribe to this service @@ -6839,7 +6839,7 @@ destruction instead.</note> default-value="FALSE"> Whether we are subscribed to this service. + line="296">Whether we are subscribed to this service. @@ -6848,7 +6848,7 @@ destruction instead.</note> Emitted whenever the subscription to this service has been lost due + line="314">Emitted whenever the subscription to this service has been lost due to an error condition. @@ -6857,7 +6857,7 @@ to an error condition. A pointer to a #GError describing why the subscription has + line="317">A pointer to a #GError describing why the subscription has been lost @@ -6872,14 +6872,14 @@ been lost c:symbol-prefix="service_proxy_action"> Opaque structure for holding in-progress action data. - + line="49">Opaque structure for holding in-progress action data. + Prepares action @action with parameters @Varargs to be sent off to + line="377">Prepares action @action with parameters @Varargs to be sent off to a remote service later with gupnp_service_proxy_call_action() or gupnp_service_proxy_call_action_async(). @@ -6916,24 +6916,24 @@ if (!gupnp_service_proxy_action_get_result (action, gupnp_service_proxy_action_unref (action); ``` - + A newly created #GUPnPServiceProxyAction + line="421">A newly created #GUPnPServiceProxyAction The name of a remote action to call + line="379">The name of a remote action to call tuples of in parameter name, in parameter type, and in parameter + line="380">tuples of in parameter name, in parameter type, and in parameter value, terminated with %NULL @@ -6943,7 +6943,7 @@ value, terminated with %NULL c:identifier="gupnp_service_proxy_action_new_from_list"> Prepares action @action with parameters @in_names and @in_values to be + line="464">Prepares action @action with parameters @in_names and @in_values to be sent off to a remote service later with gupnp_service_proxy_call_action() or gupnp_service_proxy_call_action_async(). This is mainly useful for language bindings. @@ -6978,24 +6978,24 @@ GError *error = NULL; gupnp_service_proxy_call_action_async (proxy, action, NULL, on_action_finished, NULL); gupnp_service_proxy_action_unref (action); ``` - + A newly created #GUPnPServiceProxyAction + line="508">A newly created #GUPnPServiceProxyAction An action + line="466">An action #GList of 'in' parameter + line="467">#GList of 'in' parameter names (as strings) @@ -7004,7 +7004,7 @@ names (as strings) #GList of values (as + line="469">#GList of values (as #GValue) that line up with @in_names @@ -7012,26 +7012,98 @@ names (as strings) + + Prepares action @action with to be sent off to +a remote service later with gupnp_service_proxy_call_action() or +gupnp_service_proxy_call_action_async() if no arguments required or by adding more +parameters with gupnp_service_proxy_action_add() + +After the action call has finished, the results of the call may be +retrived from the #GUPnPServiceProxyAction by using +gupnp_service_proxy_action_get_result(), +gupnp_service_proxy_action_get_result_list() or +gupnp_service_proxy_action_get_result_hash() + +```c +GUPnPServiceProxyAction *action = + gupnp_service_proxy_action_new_plain ("GetVolume"); +gupnp_service_proxy_action_add (action, "InstanceID", value_instance); +gupnp_service_proxy_action_add (action, "Channel", value_channel); +```` + + + A newly created #GUPnPServiceProxyAction + + + + + The name of a remote action to call + + + + + + Append @name to the list of arguments used by @action + + + @action for convenience. + + + + + The action to append to + + + + The name of the argument + + + + The value of the argument + + + + Retrieves the result of @action. The out parameters in @Varargs will be + line="962">Retrieves the result of @action. The out parameters in @Varargs will be filled in, and if an error occurred, @error will be set. In case of an UPnP error the error code will be the same in @error. - + %TRUE on success. + line="974">%TRUE on success. A #GUPnPServiceProxyAction handle + line="964">A #GUPnPServiceProxyAction handle optional="1"> The location where to store any error, or %NULL + line="965">The location where to store any error, or %NULL tuples of out parameter name, out parameter type, and out parameter + line="966">tuples of out parameter name, out parameter type, and out parameter value location, terminated with %NULL. The out parameter values should be freed after use @@ -7062,7 +7134,7 @@ freed after use throws="1"> See gupnp_service_proxy_action_get_result(); this version takes a #GHashTable for + line="874">See gupnp_service_proxy_action_get_result(); this version takes a #GHashTable for runtime generated parameter lists. The @out_hash needs to be pre-initialized with key value pairs denoting the argument @@ -7107,18 +7179,18 @@ void on_action_finished(GObject *object, GAsyncResult *res, gpointer user_data) g_hash_table_unref (out_args); } ``` - + %TRUE on success. + line="927">%TRUE on success. A #GUPnPServiceProxyAction handle + line="876">A #GUPnPServiceProxyAction handle A #GHashTable of + line="877">A #GHashTable of out parameter name and initialised #GValue pairs @@ -7142,7 +7214,7 @@ out parameter name and initialised #GValue pairs throws="1"> A variant of gupnp_service_proxy_action_get_result() that takes lists of + line="756">A variant of gupnp_service_proxy_action_get_result() that takes lists of out-parameter names, types and place-holders for values. The returned list in @out_values must be freed using `g_list_free` and each element @@ -7192,24 +7264,24 @@ void on_action_finished(GObject *object, GAsyncResult *res, gpointer user_data) g_list_free (out_values); } ``` - + %TRUE on success. + line="818">%TRUE on success. A #GUPnPServiceProxyAction handle + line="758">A #GUPnPServiceProxyAction handle #GList of 'out' parameter + line="759">#GList of 'out' parameter names (as strings) @@ -7218,7 +7290,7 @@ names (as strings) #GList of types (as #GType) + line="761">#GList of types (as #GType) that line up with @out_names @@ -7230,7 +7302,7 @@ that line up with @out_names transfer-ownership="full"> #GList of values + line="763">#GList of values (as #GValue) that line up with @out_names and @out_types. @@ -7238,24 +7310,48 @@ that line up with @out_names + + Iterate over the out arguments of a finished action + + + A newly created GUPnPServiceProxyActionIterator, or %NULL on error + + + + + A finished GUPnPServiceProxyAction + + + + Increases reference count of `action` - + line="292">Increases reference count of `action` + @action with an increased reference count + line="298">@action with an increased reference count an action + line="294">an action @@ -7266,33 +7362,33 @@ that line up with @out_names throws="1"> Update the value of @key to @value. + line="1015">Update the value of @key to @value. @key needs to already exist in @action. - + true if successfully modified, false otherwise + line="1026">true if successfully modified, false otherwise the action to modify + line="1017">the action to modify the name of the value to modify + line="1018">the name of the value to modify the new value of @key + line="1019">the new value of @key @@ -7302,9 +7398,9 @@ that line up with @out_names version="1.2.0"> Decreases reference count of `action`. If reference count drops to 0, + line="331">Decreases reference count of `action`. If reference count drops to 0, the action and its contents will be freed. - + @@ -7312,7 +7408,7 @@ the action and its contents will be freed. an action + line="333">an action @@ -7324,9 +7420,9 @@ the action and its contents will be freed. deprecated-version="1.2.0"> Callback notifying that @action on @proxy has returned and + line="68">Callback notifying that @action on @proxy has returned and gupnp_service_proxy_end_action() etc can be called. - + @@ -7334,13 +7430,13 @@ gupnp_service_proxy_end_action() etc can be called. The #GUPnPServiceProxy @action is called from + line="70">The #GUPnPServiceProxy @action is called from The #GUPnPServiceProxyAction in progress + line="71">The #GUPnPServiceProxyAction in progress closure="2"> User data + line="72">User data + + An opaque object representing an iterator over the out parameters of an action + + + Get the name of the current out argument + + + Name of the current argument + + + + + A GUPnP.ServiceProxyActionIter + + + + + + Get the value of the current parameter. + +If the service proxy had a successful introspection, the type according +to the introspection data will be used, otherwise it will be string. + + + %TRUE if the value could be read successfully + + + + + A GUPnP.ServiceProxyActionIter + + + + The value + + + + + + Move @self to the next out value of the iterated action + + + %TRUE if the next value was available + + + + + A GUPnP.ServiceProxyActionIter + + + + + + + + + + + - + + line="37"/> @@ -7384,9 +7582,9 @@ gupnp_service_proxy_end_action() etc can be called. c:type="GUPnPServiceProxyNotifyCallback"> Callback notifying that the state variable @variable on @proxy has changed to + line="83">Callback notifying that the state variable @variable on @proxy has changed to @value. - + @@ -7394,19 +7592,19 @@ gupnp_service_proxy_end_action() etc can be called. The #GUPnPServiceProxy the notification originates from + line="85">The #GUPnPServiceProxy the notification originates from The name of the variable being notified + line="86">The name of the variable being notified The #GValue of the variable being notified + line="87">The #GValue of the variable being notified closure="3"> User data + line="88">User data @@ -7524,7 +7722,7 @@ contains a list of (char *) strings rather than GValues. glib:type-struct="XMLDocClass"> Reference-counting wrapper for libxml's #xmlDoc + line="24">Reference-counting wrapper for libxml's #xmlDoc version="0.14.0"> Create a new #GUPnPXMLDoc for @xml_doc. + line="187">Create a new #GUPnPXMLDoc for @xml_doc. A new #GUPnPXMLDoc, or %NULL on an error + line="193">A new #GUPnPXMLDoc, or %NULL on an error Pointer to #xmlDoc to wrap under this object + line="189">Pointer to #xmlDoc to wrap under this object @@ -7555,19 +7753,19 @@ contains a list of (char *) strings rather than GValues. throws="1"> Create a new #GUPnPXMLDoc for the XML document at @path. + line="207">Create a new #GUPnPXMLDoc for the XML document at @path. A new #GUPnPXMLDoc, or %NULL on an error + line="214">A new #GUPnPXMLDoc, or %NULL on an error Path to xml document + line="209">Path to xml document @@ -7577,14 +7775,14 @@ contains a list of (char *) strings rather than GValues. a pointer to the wrapped #xmlDoc + line="234">a pointer to the wrapped #xmlDoc A #GUPnPXMLDoc + line="232">A #GUPnPXMLDoc @@ -7692,13 +7890,13 @@ contains a list of (char *) strings rather than GValues. deprecated-version="1.6."> Generate and return a new UUID. + line="549">Generate and return a new UUID. Use [func@GLib.uuid_string_random] instead. A newly generated UUID in string representation. + line="554">A newly generated UUID in string representation. diff --git a/girs/GVnc-1.0.gir b/girs/GVnc-1.0.gir index 2a9a734b7..81ee58898 100644 --- a/girs/GVnc-1.0.gir +++ b/girs/GVnc-1.0.gir @@ -978,13 +978,13 @@ color map entry at position @idx. Create a new connection object, which is initially + line="5473">Create a new connection object, which is initially in the disconnected state. - + the new connection + line="5479">the new connection @@ -1265,21 +1265,21 @@ in the disconnected state. Tell the server that it is no longer permitted to send + line="1799">Tell the server that it is no longer permitted to send audio. The client may continue to receive audio for a time after this, since packets may already be in flight. - + TRUE if the connection is ok, FALSE if it has an error + line="1807">TRUE if the connection is ok, FALSE if it has an error the connection object + line="1801">the connection object @@ -1287,27 +1287,27 @@ time after this, since packets may already be in flight. Tell the server that it is permitted to send audio + line="1772">Tell the server that it is permitted to send audio data. - + TRUE if the connection is ok, FALSE if it has an error + line="1779">TRUE if the connection is ok, FALSE if it has an error the connection object + line="1774">the connection object - + @@ -1330,52 +1330,52 @@ data. c:identifier="vnc_connection_framebuffer_update_request"> Request that the server send a framebuffer update when the + line="1886">Request that the server send a framebuffer update when the region positioned at (@x, @y) wth size (@width, @height) sees damage. The update sent may be a subset of the region requested, if @incremental is FALSE. - + TRUE if the connection is ok, FALSE if it has an error + line="1900">TRUE if the connection is ok, FALSE if it has an error the connection object + line="1888">the connection object TRUE to only receive region with changes + line="1889">TRUE to only receive region with changes horizontal offset to region of update + line="1890">horizontal offset to region of update vertical offset to region of update + line="1891">vertical offset to region of update horizontal size of region of update + line="1892">horizontal size of region of update vertical size of region of update + line="1893">vertical size of region of update @@ -1384,21 +1384,21 @@ requested, if @incremental is FALSE. c:identifier="vnc_connection_get_abs_pointer"> Determine if the remote server supports absolute pointer + line="6498">Determine if the remote server supports absolute pointer motion events. This will only be valid once the "vnc-initialized" signal has been emitted. - + TRUE if the server supports absolute pointer mode + line="6506">TRUE if the server supports absolute pointer mode the connection object + line="6500">the connection object @@ -1407,19 +1407,19 @@ motion events. This will only be valid once the c:identifier="vnc_connection_get_audio_format"> Get the current audio format specification - + line="1757">Get the current audio format specification + the current audio format + line="1763">the current audio format the connection object + line="1759">the connection object @@ -1427,20 +1427,20 @@ motion events. This will only be valid once the Get the cursor currently associated with the desktop, + line="6481">Get the cursor currently associated with the desktop, if any. - + the cursor or NULL + line="6488">the cursor or NULL the VNC connection + line="6483">the VNC connection @@ -1449,22 +1449,22 @@ if any. c:identifier="vnc_connection_get_ext_key_event"> Determine if the remote server supports the extended + line="6462">Determine if the remote server supports the extended keyboard event which transmits raw XT scancodes. This will only be valid once the "vnc-initialized" signal has been emitted - + TRUE if supported, FALSE otherwise + line="6471">TRUE if supported, FALSE otherwise the connection object + line="6464">the connection object @@ -1472,21 +1472,21 @@ signal has been emitted Get the height of the remote display. The height will + line="6445">Get the height of the remote display. The height will only be set once the "vnc-initialized" signal has been emitted - + the desktop height + line="6453">the desktop height the connection object + line="6447">the connection object @@ -1494,21 +1494,21 @@ been emitted Get the current LED state bitmap. This is only + line="6515">Get the current LED state bitmap. This is only valid once the "vnc-initialized" signal has been emitted. - + the LED state + line="6523">the LED state the connection object + line="6517">the connection object @@ -1516,21 +1516,21 @@ emitted. Get the name of the remote display. A name will only + line="6411">Get the name of the remote display. A name will only be available once the "vnc-initialized" signal has been emitted - + the remote display name + line="6419">the remote display name the connection object + line="6413">the connection object @@ -1539,19 +1539,19 @@ been emitted c:identifier="vnc_connection_get_pixel_format"> Get a specification of the current pixel format - + line="1514">Get a specification of the current pixel format + the current pixel format + line="1520">the current pixel format the connection object + line="1516">the connection object @@ -1560,21 +1560,21 @@ been emitted c:identifier="vnc_connection_get_power_control"> Determine if the remote server supports power control. + line="6532">Determine if the remote server supports power control. This will only be valid once the "vnc-initialized" signal has been emitted. - + TRUE if the server supports power control + line="6540">TRUE if the server supports power control the connection object + line="6534">the connection object @@ -1582,19 +1582,19 @@ signal has been emitted. Get the sharing state for the connection - + line="1555">Get the sharing state for the connection + TRUE if other clients are permitted, FALSE otherwise + line="1561">TRUE if other clients are permitted, FALSE otherwise the connection object + line="1557">the connection object @@ -1602,21 +1602,21 @@ signal has been emitted. Get the width of the remote display. The width will + line="6428">Get the width of the remote display. The width will only be set once the "vnc-initialized" signal has been emitted - + the desktop width + line="6436">the desktop width the connection object + line="6430">the connection object @@ -1624,20 +1624,20 @@ been emitted Determine if the current connection is in an error + line="1498">Determine if the current connection is in an error state - + TRUE if an error has occurred, FALSE otherwise + line="1505">TRUE if an error has occurred, FALSE otherwise the connection object + line="1500">the connection object @@ -1646,21 +1646,21 @@ state c:identifier="vnc_connection_is_initialized"> Determine if the connection to the remote desktop is + line="5651">Determine if the connection to the remote desktop is fully initialized and thus receiving framebuffer updates. - + TRUE if initialized, FALSE if closed or still negotiating + line="5659">TRUE if initialized, FALSE if closed or still negotiating the connection object + line="5653">the connection object @@ -1668,19 +1668,19 @@ updates. Check if the connection is currently open - + line="5627">Check if the connection is currently open + TRUE if open, FALSE if closing/closed + line="5633">TRUE if open, FALSE if closing/closed the connection object + line="5629">the connection object @@ -1688,40 +1688,40 @@ updates. Send a key press/release event to the server. By default the + line="1963">Send a key press/release event to the server. By default the event will be sent with the X11 key code from @key. If the extended key event protocol extension is active, the @scancode will be sent instead. - + TRUE if the connection is ok, FALSE if it has an error + line="1975">TRUE if the connection is ok, FALSE if it has an error the connection object + line="1965">the connection object TRUE if this is a key press, FALSE for a key release + line="1966">TRUE if this is a key press, FALSE for a key release the X11 key code + line="1967">the X11 key code the XT scan code + line="1968">the XT scan code @@ -1729,7 +1729,7 @@ will be sent instead. Open a socket connection to server identified by @addr. + line="6142">Open a socket connection to server identified by @addr. @addr may refer to either a TCP address (IPv4/6) or a UNIX socket address. The @hostname provided should reflect the name of the host that the @addr provides a @@ -1739,24 +1739,24 @@ For example, if @addr points to a proxy server, then endpoint. This will be used by some authentication schemes, for example x509 certificate validation against @hostname. - + TRUE if a connection was opened, FALSE if already open + line="6159">TRUE if a connection was opened, FALSE if already open the connection object + line="6144">the connection object the socket address + line="6145">the socket address allow-none="1"> the hostname + line="6146">the hostname @@ -1773,30 +1773,30 @@ against @hostname. Open a connection using @fd as the transport. If @fd + line="6055">Open a connection using @fd as the transport. If @fd refers to a TCP connection, it is recommended to use vnc_connection_open_fd_with_hostname instead, to provide the remote hostname. This allows use of x509 based authentication which requires a hostname to be available. - + TRUE if a connection was opened, FALSE if already open + line="6067">TRUE if a connection was opened, FALSE if already open the connection object + line="6057">the connection object file descriptor to use for the connection + line="6058">file descriptor to use for the connection @@ -1805,29 +1805,29 @@ to be available. c:identifier="vnc_connection_open_fd_with_hostname"> Open a connection using @fd as the transport. The + line="6075">Open a connection using @fd as the transport. The @hostname provided should reflect the name of the host that the @fd provides a connection to. This will be used by some authentication schemes, for example x509 certificate validation against @hostname. - + TRUE if a connection was opened, FALSE if already open + line="6087">TRUE if a connection was opened, FALSE if already open the connection object + line="6077">the connection object file descriptor to use for the connection + line="6078">file descriptor to use for the connection allow-none="1"> the host associated with the connection + line="6079">the host associated with the connection @@ -1844,32 +1844,32 @@ example x509 certificate validation against @hostname. Open a TCP connection to the remote desktop at @host + line="6110">Open a TCP connection to the remote desktop at @host listening on @port. - + TRUE if a connection was opened, FALSE if already open + line="6119">TRUE if a connection was opened, FALSE if already open the connection object + line="6112">the connection object the host name or IP address + line="6113">the host name or IP address the service name or port number + line="6114">the service name or port number @@ -1877,38 +1877,38 @@ listening on @port. Send a pointer event to the server, reflecting either movement + line="2001">Send a pointer event to the server, reflecting either movement of the pointer, or a change in state of its buttons, or both. - + TRUE if the connection is ok, FALSE if it has an error + line="2011">TRUE if the connection is ok, FALSE if it has an error the connection object + line="2003">the connection object the new state of the buttons + line="2004">the new state of the buttons the new horizontal position of the pointer + line="2005">the new horizontal position of the pointer the new veritical position of the pointer + line="2006">the new veritical position of the pointer @@ -1916,7 +1916,7 @@ of the pointer, or a change in state of its buttons, or both. Perform a power control action on the remote server. + line="6550">Perform a power control action on the remote server. This is only valid if the "vnc-power-control" signal has been emitted with a VNC_CONNECTION_POWER_STATUS_INIT @@ -1925,11 +1925,11 @@ code. The action should be assumed to be accepted unless "vnc-power-control" signal is emitted with a VNC_CONNECTION_POWER_STATUS_FAIL code. - + TRUE if the action was sent, FALSE if + line="6564">TRUE if the action was sent, FALSE if power control is not supported @@ -1937,7 +1937,7 @@ power control is not supported the connection object + line="6552">the connection object @@ -1949,26 +1949,26 @@ power control is not supported Set the audio sink to use for playing back audio from + line="1689">Set the audio sink to use for playing back audio from the remote session. - + TRUE if the connection is ok, FALSE if it has an error + line="1697">TRUE if the connection is ok, FALSE if it has an error the connection object + line="1691">the connection object the audio sink + line="1692">the audio sink @@ -1977,29 +1977,29 @@ the remote session. c:identifier="vnc_connection_set_audio_format"> Set the audio format specification to use for playback + line="1729">Set the audio format specification to use for playback from the remote session. The format should only be set when the audio stream is not active, otherwise it will be impossible to determine when the server has switched to sending data in the new format - + TRUE if the connection is ok, FALSE if it has an error + line="1740">TRUE if the connection is ok, FALSE if it has an error the connection object + line="1731">the connection object the audio format + line="1732">the audio format @@ -2008,26 +2008,26 @@ to sending data in the new format c:identifier="vnc_connection_set_auth_subtype"> If a multi-level authentication scheme was requested, this + line="6228">If a multi-level authentication scheme was requested, this identifies which auth type to use for the second phase. - + TRUE if the connection is ok, FALSE if it has an error + line="6236">TRUE if the connection is ok, FALSE if it has an error the connection object + line="6230">the connection object the auth sub-type + line="6231">the auth sub-type @@ -2035,26 +2035,26 @@ identifies which auth type to use for the second phase. Set the authentication type to use to complete the + line="6188">Set the authentication type to use to complete the connection. - + TRUE if the connection is ok, FALSE if it has an error + line="6196">TRUE if the connection is ok, FALSE if it has an error the connection object + line="6190">the connection object the requested auth type + line="6191">the requested auth type @@ -2063,34 +2063,34 @@ connection. c:identifier="vnc_connection_set_credential"> Sets the value of the authentication credential + line="6328">Sets the value of the authentication credential @type to the string @data. -@type is one of the VncConnectionCredential enum values - +@type is one of the VncConnectionCredential enum vlaues + TRUE if the connection is ok, FALSE if it has an error + line="6339">TRUE if the connection is ok, FALSE if it has an error the connection object + line="6330">the connection object the authentication credential type + line="6331">the authentication credential type the value associated with the credential + line="6332">the value associated with the credential @@ -2098,33 +2098,33 @@ connection. Inform the server of the list of encodings that it is + line="1828">Inform the server of the list of encodings that it is allowed to send. This should be done before requesting any framebuffer updates - + TRUE if the connection is ok, FALSE if it has an error + line="1838">TRUE if the connection is ok, FALSE if it has an error the connection object + line="1830">the connection object number of entries in @encoding + line="1831">number of entries in @encoding the list of permitted encodings + line="1832">the list of permitted encodings @@ -2136,26 +2136,26 @@ any framebuffer updates glib:set-property="framebuffer"> Set the framebuffer object to which frame buffer updates + line="6372">Set the framebuffer object to which frame buffer updates will be written. - + TRUE if the connection is ok, FALSE if it has an error + line="6380">TRUE if the connection is ok, FALSE if it has an error the connection object + line="6374">the connection object the framebuffer object + line="6375">the framebuffer object @@ -2164,29 +2164,29 @@ will be written. c:identifier="vnc_connection_set_pixel_format"> Tell the server what pixel format to use for + line="1638">Tell the server what pixel format to use for framebuffer updates. It is only safe to use this when no framebuffer updates are pending, otherwise it is impossible to determine when the server has switched over to using the new format. - + TRUE if the connection is ok, FALSE if it has an error + line="1649">TRUE if the connection is ok, FALSE if it has an error the connection object + line="1640">the connection object the new pixel format + line="1641">the new pixel format @@ -2194,34 +2194,34 @@ switched over to using the new format. Set the shared state for the connection. A TRUE value + line="1530">Set the shared state for the connection. A TRUE value allow allow this client to co-exist with other existing clients. A FALSE value will cause other clients to be dropped - + TRUE if the connection is ok, FALSE if it has an error + line="1540">TRUE if the connection is ok, FALSE if it has an error the connection object + line="1532">the connection object the new sharing state + line="1533">the new sharing state - + @@ -2241,9 +2241,9 @@ dropped Initiate a shutdown of the current connection + line="5594">Initiate a shutdown of the current connection by closing its socket - + @@ -2251,7 +2251,7 @@ by closing its socket the connection object + line="5596">the connection object @@ -2334,7 +2334,7 @@ by closing its socket Emitted when the cursor is changed. + line="5234">Emitted when the cursor is changed. @@ -2345,7 +2345,7 @@ by closing its socket allow-none="1"> the new cursor + line="5237">the new cursor @@ -2985,12 +2985,6 @@ by closing its socket glib:nick="clientname" glib:name="VNC_CONNECTION_CREDENTIAL_CLIENTNAME"> - - GXPS provides version information, primarily useful in configure checks + line="19">GXPS provides version information, primarily useful in configure checks for builds that have a configure script. Applications will not typically use the features described here. diff --git a/girs/GcrUi-3.gir b/girs/GcrUi-3.gir index 0296357ea..914f8f2e8 100644 --- a/girs/GcrUi-3.gir +++ b/girs/GcrUi-3.gir @@ -21,7 +21,7 @@ and/or use gtk-doc annotations. --> - + @@ -30,7 +30,7 @@ and/or use gtk-doc annotations. --> - + @@ -39,7 +39,7 @@ and/or use gtk-doc annotations. --> - + @@ -48,7 +48,7 @@ and/or use gtk-doc annotations. --> - + @@ -57,7 +57,7 @@ and/or use gtk-doc annotations. --> - + @@ -66,7 +66,7 @@ and/or use gtk-doc annotations. --> - + @@ -75,7 +75,7 @@ and/or use gtk-doc annotations. --> - + @@ -84,7 +84,7 @@ and/or use gtk-doc annotations. --> - + @@ -93,7 +93,7 @@ and/or use gtk-doc annotations. --> - + @@ -102,7 +102,7 @@ and/or use gtk-doc annotations. --> - + @@ -111,7 +111,7 @@ and/or use gtk-doc annotations. --> - + @@ -120,7 +120,7 @@ and/or use gtk-doc annotations. --> - + @@ -134,21 +134,20 @@ and/or use gtk-doc annotations. --> glib:get-type="gcr_certificate_renderer_get_type" glib:type-struct="CertificateRendererClass"> An implementation of #GcrRenderer which renders certificates. - + Create a new certificate renderer to display the certificate. - + a newly allocated #GcrCertificateRenderer, which should be released with g_object_unref() @@ -156,7 +155,7 @@ and/or use gtk-doc annotations. --> The certificate to display @@ -165,15 +164,14 @@ and/or use gtk-doc annotations. --> Create a new certificate renderer to display the label and attributes. One of the attributes should be a CKA_VALUE type attribute containing a DER encoded certificate. - + a newly allocated #GcrCertificateRenderer, which should be released with g_object_unref() @@ -184,7 +182,7 @@ encoded certificate. nullable="1" allow-none="1"> the label to display @@ -193,7 +191,7 @@ encoded certificate. nullable="1" allow-none="1"> The attributes to display @@ -203,22 +201,21 @@ encoded certificate. c:identifier="gcr_certificate_renderer_get_certificate" glib:get-property="certificate"> Get the certificate displayed in the renderer. If no certificate was explicitly set, then the renderer will return itself since it acts as a valid certificate. - + The certificate, owned by the renderer. The renderer @@ -228,17 +225,16 @@ a valid certificate. c:identifier="gcr_certificate_renderer_set_certificate" glib:set-property="certificate"> Set a certificate to display in the renderer. - + The renderer @@ -247,7 +243,7 @@ a valid certificate. nullable="1" allow-none="1"> the certificate to display @@ -255,7 +251,7 @@ a valid certificate. The certificate attributes to display. One of the attributes must be a CKA_VALUE type attribute which contains a DER encoded certificate. @@ -266,13 +262,13 @@ a CKA_VALUE type attribute which contains a DER encoded certificate. setter="set_certificate" getter="get_certificate"> The certificate to display. May be %NULL. The label to display. @@ -288,20 +284,21 @@ a CKA_VALUE type attribute which contains a DER encoded certificate. c:type="GcrCertificateRendererClass" glib:is-gtype-struct-for="CertificateRenderer"> The class for #GcrCertificateRenderer. - + The parent class. - + disguised="1" + opaque="1"> + glib:get-type="gcr_certificate_widget_get_type" glib:type-struct="CertificateWidgetClass"> A widget that can be used to display a certificate. A certificate widget is normally in a collapsed state showing only @@ -324,17 +321,17 @@ viewer. To show more than one certificate in a view, create the viewer and add renderers to it. - + Create a new certificate widget which displays a given certificate. - + a new certificate widget @@ -344,7 +341,7 @@ add renderers to it. nullable="1" allow-none="1"> certificate to display, or %NULL @@ -354,20 +351,20 @@ add renderers to it. c:identifier="gcr_certificate_widget_get_attributes" glib:get-property="attributes"> Get the attributes displayed in the widget. The attributes should contain a certificate. - + the attributes, owned by the widget The certificate widget @@ -377,19 +374,19 @@ a certificate. c:identifier="gcr_certificate_widget_get_certificate" glib:get-property="certificate"> Get the certificate displayed in the widget. - + the certificate The certificate widget @@ -399,17 +396,17 @@ a certificate. c:identifier="gcr_certificate_widget_set_attributes" glib:set-property="attributes"> Set the attributes displayed in the widget. The attributes should contain a certificate. - + The certificate widget @@ -418,7 +415,7 @@ a certificate. nullable="1" allow-none="1"> the attributes to display @@ -428,16 +425,16 @@ a certificate. c:identifier="gcr_certificate_widget_set_certificate" glib:set-property="certificate"> Set the certificate displayed in the widget - + The certificate widget @@ -446,7 +443,7 @@ a certificate. nullable="1" allow-none="1"> the certificate to display @@ -477,15 +474,16 @@ a certificate. - + - + disguised="1" + opaque="1"> + glib:get-type="gcr_collection_model_get_type" glib:type-struct="CollectionModelClass"> Ain implementation of a [iface@Gtk.TreeModel] which contains a row for each object in a [iface@Gcr.Collection]. @@ -516,21 +514,21 @@ or set with gcr_collection_model_set_selected_objects() and retrieved with To determine which object a row represents and vice versa, use the [method@CollectionModel.iter_for_object] or [method@CollectionModel.object_for_iter] functions. - + Create a new #GcrCollectionModel. The variable argument list should contain pairs of property names, and #GType values. The variable argument list should be terminated with %NULL. - + a newly allocated model, which should be released with g_object_unref(). @@ -538,19 +536,19 @@ be terminated with %NULL. the collection to represent whether list or tree mode the column names and types @@ -560,12 +558,12 @@ be terminated with %NULL. c:identifier="gcr_collection_model_new_full" introspectable="0"> Create a new #GcrCollectionModel. - + a newly allocated model, which should be released with g_object_unref() @@ -573,19 +571,19 @@ be terminated with %NULL. the collection to represent whether list or tree mode the columns the model should contain @@ -594,28 +592,28 @@ be terminated with %NULL. Set whether a given row is toggled selected or not. - + The model The row Whether the row should be selected or not. @@ -624,20 +622,20 @@ be terminated with %NULL. Get the column identifier for the column that contains the values of the selected state. - + The column identifier. The model @@ -647,19 +645,19 @@ of the selected state. c:identifier="gcr_collection_model_get_collection" glib:get-property="collection"> Get the collection which this model represents - + the collection, owned by the model a collection model @@ -668,12 +666,12 @@ of the selected state. Get a list of checked/selected objects. - + a list of selected objects, which should be freed with g_list_free() @@ -683,7 +681,7 @@ of the selected state. the collection model @@ -692,25 +690,25 @@ of the selected state. Check whether a given row has been toggled as selected. - + Whether the row has been selected. The model The row @@ -719,32 +717,32 @@ of the selected state. Set @iter to the row for the given object. If the object is not in this model, then %FALSE will be returned. - + %TRUE if the object was present. The model The object The row for the object @@ -753,25 +751,25 @@ model, then %FALSE will be returned. Get the object that is represented by the given row in the model. - + The object, owned by the model. The model The row @@ -781,16 +779,16 @@ model, then %FALSE will be returned. c:identifier="gcr_collection_model_set_collection" glib:set-property="collection"> Set the collection which this model represents - + a collection model @@ -799,7 +797,7 @@ model, then %FALSE will be returned. nullable="1" allow-none="1"> the collection or %NULL @@ -809,7 +807,7 @@ model, then %FALSE will be returned. c:identifier="gcr_collection_model_set_columns" introspectable="0"> Set the columns that the model should contain. @columns is an array of #GcrColumn structures, with the last one containing %NULL for all values. @@ -819,23 +817,23 @@ has been added to a view. The columns are accessed as static data. They should continue to remain in memory for longer than the GcrCollectionModel object. - + The number of columns The model The columns the model should contain @@ -844,22 +842,22 @@ in memory for longer than the GcrCollectionModel object. Set the checked/selected objects. - + the collection model a list of objects to select @@ -870,22 +868,22 @@ in memory for longer than the GcrCollectionModel object. Toggle the selected state of a given row. - + The model The row @@ -908,7 +906,8 @@ in memory for longer than the GcrCollectionModel object. introspectable="0" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="GCR_COLLECTION_MODEL_TREE"> @@ -923,39 +922,40 @@ in memory for longer than the GcrCollectionModel object. c:type="GcrCollectionModelClass" glib:is-gtype-struct-for="CollectionModel"> The class for #GcrCollectionModel. - + The parent class If a [class@CollectionModel] is created with a mode of %GCR_COLLECTION_MODEL_TREE, then any included objects that are themselves a [iface@Gcr.Collection], will have all child objects include as child rows in a tree form. - + only objects in the top collection, no child objects show objects in the collection, and child objects in a tree form - + disguised="1" + opaque="1"> + glib:get-type="gcr_combo_selector_get_type" glib:type-struct="ComboSelectorClass"> A widget that can be used to select a certificate or key. It allows the user to select one object from the selector at a time. - + Create a new #GcrTreeSelector. - + A newly allocated selector, which should be released with g_object_unref(). @@ -988,7 +988,7 @@ the user to select one object from the selector at a time. The collection that contains the objects to display @@ -998,19 +998,19 @@ the user to select one object from the selector at a time. c:identifier="gcr_combo_selector_get_collection" glib:get-property="collection"> Get the collection that this selector is displaying objects from. - + The collection, owned by the selector. The selector @@ -1019,19 +1019,19 @@ the user to select one object from the selector at a time. Get the selected object in the selector, or %NULL if nothing selected. - + the selected object, owned by the selector, or %NULL The selector @@ -1040,17 +1040,17 @@ the user to select one object from the selector at a time. Set the currently selected object in the selector, or clear the selection if selected is set to %NULL. - + The selector @@ -1059,7 +1059,7 @@ if selected is set to %NULL. nullable="1" allow-none="1"> the object to select or %NULL @@ -1071,7 +1071,7 @@ if selected is set to %NULL. transfer-ownership="none" getter="get_collection"> The collection which contains the objects to display in the selector. @@ -1085,20 +1085,21 @@ if selected is set to %NULL. - + - + disguised="1" + opaque="1"> + - + @@ -1107,7 +1108,7 @@ if selected is set to %NULL. - + @@ -1116,7 +1117,7 @@ if selected is set to %NULL. - + @@ -1130,18 +1131,18 @@ if selected is set to %NULL. glib:get-type="gcr_failure_renderer_get_type" glib:type-struct="FailureRendererClass"> A renderer that can be used for unsupported data. - + Create a new renderer for an error. - + the new renderer @@ -1151,13 +1152,13 @@ if selected is set to %NULL. nullable="1" allow-none="1"> the label for the failure the error to display @@ -1166,19 +1167,19 @@ if selected is set to %NULL. Create a new renderer for unsupported data. - + the new renderer the label for the failure @@ -1201,20 +1202,21 @@ if selected is set to %NULL. - + - + disguised="1" + opaque="1"> + - + @@ -1223,7 +1225,7 @@ if selected is set to %NULL. - + @@ -1232,7 +1234,7 @@ if selected is set to %NULL. - + @@ -1241,7 +1243,7 @@ if selected is set to %NULL. - + @@ -1250,7 +1252,7 @@ if selected is set to %NULL. - + @@ -1259,7 +1261,7 @@ if selected is set to %NULL. - + @@ -1268,7 +1270,7 @@ if selected is set to %NULL. - + @@ -1277,7 +1279,7 @@ if selected is set to %NULL. - + @@ -1286,7 +1288,7 @@ if selected is set to %NULL. - + @@ -1295,7 +1297,7 @@ if selected is set to %NULL. - + @@ -1304,7 +1306,7 @@ if selected is set to %NULL. - + @@ -1313,7 +1315,7 @@ if selected is set to %NULL. - + @@ -1322,7 +1324,7 @@ if selected is set to %NULL. - + @@ -1331,7 +1333,7 @@ if selected is set to %NULL. - + @@ -1340,7 +1342,7 @@ if selected is set to %NULL. - + @@ -1349,7 +1351,7 @@ if selected is set to %NULL. - + @@ -1358,7 +1360,7 @@ if selected is set to %NULL. - + @@ -1367,7 +1369,7 @@ if selected is set to %NULL. - + @@ -1376,7 +1378,7 @@ if selected is set to %NULL. - + @@ -1385,7 +1387,7 @@ if selected is set to %NULL. - + @@ -1394,7 +1396,7 @@ if selected is set to %NULL. - + @@ -1403,7 +1405,7 @@ if selected is set to %NULL. - + @@ -1412,7 +1414,7 @@ if selected is set to %NULL. - + @@ -1421,7 +1423,7 @@ if selected is set to %NULL. - + @@ -1430,7 +1432,7 @@ if selected is set to %NULL. - + @@ -1439,7 +1441,7 @@ if selected is set to %NULL. - + @@ -1448,7 +1450,7 @@ if selected is set to %NULL. - + @@ -1457,7 +1459,7 @@ if selected is set to %NULL. - + @@ -1466,7 +1468,7 @@ if selected is set to %NULL. - + @@ -1475,7 +1477,7 @@ if selected is set to %NULL. - + @@ -1484,7 +1486,7 @@ if selected is set to %NULL. - + @@ -1498,25 +1500,25 @@ if selected is set to %NULL. glib:get-type="gcr_import_button_get_type" glib:type-struct="ImportButtonClass"> A button which imports keys and certificates. The import button shows a spinner when the button is activated. When more than one importer is available, it shows a drop down to select which to import to. - + Create a new #GcrImportButton. - + a newly created #GcrImportButton @@ -1526,14 +1528,14 @@ import to. nullable="1" allow-none="1"> label to display on the button - + @@ -1550,7 +1552,7 @@ import to. - + @@ -1565,22 +1567,22 @@ import to. Queue an item to import via the button - + an import button a parsed item @@ -1594,7 +1596,7 @@ import to. Signal emitted when an import completes or fails. @@ -1602,13 +1604,13 @@ import to. the importer that was imported to if import was successful %NULL, or an error @@ -1616,7 +1618,7 @@ import to. Signal emitted when an import begins. @@ -1624,7 +1626,7 @@ import to. the importer that will be imported to @@ -1635,18 +1637,18 @@ import to. c:type="GcrImportButtonClass" glib:is-gtype-struct-for="ImportButton"> Class struct for [class@ImportButton]. - + The parent class - + @@ -1662,7 +1664,7 @@ import to. - + @@ -1687,13 +1689,14 @@ import to. - + disguised="1" + opaque="1"> + - + @@ -1702,7 +1705,7 @@ import to. - + @@ -1711,7 +1714,7 @@ import to. - + @@ -1720,7 +1723,7 @@ import to. - + @@ -1729,7 +1732,7 @@ import to. - + @@ -1738,7 +1741,7 @@ import to. - + @@ -1752,18 +1755,18 @@ import to. glib:get-type="gcr_key_renderer_get_type" glib:type-struct="KeyRendererClass"> An implementation of #GcrRenderer which renders keys. - + Create a new key renderer which renders a given key in the attributes. - + a newly allocated #GcrKeyRenderer, which should be freed with g_object_unref() @@ -1774,7 +1777,7 @@ import to. nullable="1" allow-none="1"> label describing the key @@ -1783,7 +1786,7 @@ import to. nullable="1" allow-none="1"> key to display, or %NULL @@ -1792,19 +1795,19 @@ import to. Get the attributes displayed in the renderer. - + the attributes, owned by the renderer The key renderer @@ -1813,17 +1816,17 @@ import to. Get the attributes displayed in the renderer. The attributes should represent either an RSA, DSA, or EC key in PKCS#11 style. - + The key renderer @@ -1832,7 +1835,7 @@ either an RSA, DSA, or EC key in PKCS#11 style. nullable="1" allow-none="1"> the attributes to display @@ -1852,20 +1855,21 @@ either an RSA, DSA, or EC key in PKCS#11 style. c:type="GcrKeyRendererClass" glib:is-gtype-struct-for="KeyRenderer"> The class for #GcrKeyRenderer. - + The parent class. - + disguised="1" + opaque="1"> + glib:get-type="gcr_key_widget_get_type" glib:type-struct="KeyWidgetClass"> A key widget and renderer A key widget can be used to display a RSA, DSA or EC key. The widget is @@ -1886,17 +1890,17 @@ Use [ctor@KeyWidget.new] to create a new key widget. Only one key can be displayed. A key widget contains a [iface@Viewer] internally and [class@KeyRenderer] is used to render the key to the viewer. To show more than one key in a view, create the viewer and add renderers to it. - + Create a new key widget which displays a given key in the attributes. - + A newly allocated #GcrKeyWidget, which should be freed with g_object_unref(). @@ -1907,7 +1911,7 @@ than one key in a view, create the viewer and add renderers to it. nullable="1" allow-none="1"> key to display, or %NULL @@ -1917,19 +1921,19 @@ than one key in a view, create the viewer and add renderers to it. c:identifier="gcr_key_widget_get_attributes" glib:get-property="attributes"> Get the attributes displayed in the widget. - + The attributes, owned by the widget. The key widget @@ -1939,17 +1943,17 @@ than one key in a view, create the viewer and add renderers to it. c:identifier="gcr_key_widget_set_attributes" glib:set-property="attributes"> Get the attributes displayed in the widget. The attributes should represent either an RSA, DSA or EC key in PKCS#11 style. - + The key widget @@ -1958,7 +1962,7 @@ either an RSA, DSA or EC key in PKCS#11 style. nullable="1" allow-none="1"> the attributes to display @@ -1975,16 +1979,20 @@ either an RSA, DSA or EC key in PKCS#11 style. - + - - + + - + @@ -1993,7 +2001,7 @@ either an RSA, DSA or EC key in PKCS#11 style. - + @@ -2002,7 +2010,7 @@ either an RSA, DSA or EC key in PKCS#11 style. - + @@ -2016,22 +2024,22 @@ either an RSA, DSA or EC key in PKCS#11 style. glib:get-type="gcr_list_selector_get_type" glib:type-struct="ListSelectorClass"> A selector widget to select 1 or more certificates or keys from a list. Live search is available for quick filtering. - + Create a new #GcrListSelector. - + a newly allocated selector, which should be released with g_object_unref() @@ -2039,7 +2047,7 @@ Live search is available for quick filtering. The collection that contains the objects to display @@ -2049,19 +2057,19 @@ Live search is available for quick filtering. c:identifier="gcr_list_selector_get_collection" glib:get-property="collection"> Get the collection that this selector is displaying objects from. - + The collection, owned by the selector. The selector @@ -2070,12 +2078,12 @@ Live search is available for quick filtering. Get a list of selected objects. - + the list of selected objects, to be released with g_list_free() @@ -2085,7 +2093,7 @@ Live search is available for quick filtering. The selector @@ -2094,22 +2102,22 @@ Live search is available for quick filtering. Select certain objects in the selector. - + The selector the list of objects to select @@ -2123,7 +2131,7 @@ Live search is available for quick filtering. transfer-ownership="none" getter="get_collection"> The collection which contains the objects to display in the selector. @@ -2137,20 +2145,21 @@ Live search is available for quick filtering. - + - + disguised="1" + opaque="1"> + - + @@ -2159,7 +2168,7 @@ Live search is available for quick filtering. - + @@ -2168,7 +2177,7 @@ Live search is available for quick filtering. - + @@ -2182,35 +2191,43 @@ Live search is available for quick filtering. glib:get-type="gcr_prompt_dialog_get_type" glib:type-struct="PromptDialogClass"> A [iface@Gcr.Prompt] implementation which shows a GTK dialog. The dialog will remain visible (but insensitive) between prompts. If the user cancels the dialog between prompts, then the dialog will be hidden. - + - + Whether the choice check box is visible or not. - + Whether the password confirm entry is visible or not. - + Whether the password entry is visible or not. - + Whether the warning label is visible or not. @@ -2224,20 +2241,21 @@ the dialog between prompts, then the dialog will be hidden. - + - + disguised="1" + opaque="1"> + - + @@ -2246,7 +2264,7 @@ the dialog between prompts, then the dialog will be hidden. - + @@ -2259,7 +2277,7 @@ the dialog between prompts, then the dialog will be hidden. glib:get-type="gcr_renderer_get_type" glib:type-struct="RendererIface"> An interface that's implemented by renderers which wish to render data to a [iface@Viewer]. @@ -2270,16 +2288,16 @@ this time. To lookup a renderer for a given set of attributes, use the gcr_renderer_create() function. This will create and initialize a renderer that's capable of viewing the data in those attributes. - + Create and initialize a renderer for the given attributes and label. These renderers should have been preregistered via gcr_renderer_register(). - + a new renderer, or %NULL if no renderer matched the attributes; the render should be released with g_object_unref() @@ -2290,13 +2308,13 @@ renderers should have been preregistered via gcr_renderer_register(). nullable="1" allow-none="1"> The label for the renderer The attributes to render @@ -2304,23 +2322,23 @@ renderers should have been preregistered via gcr_renderer_register(). Register a renderer to be created when matching attributes are passed to gcr_renderer_create(). - + The renderer class type The attributes to match @@ -2329,16 +2347,16 @@ gcr_renderer_create(). Register all the well known renderers for certificates and keys known to the Gcr library. - + - + @@ -2349,7 +2367,7 @@ Gcr library. - + @@ -2367,22 +2385,22 @@ Gcr library. Render the contents of the renderer to the given viewer. - + The renderer The viewer to render to. @@ -2391,17 +2409,17 @@ Gcr library. Emit the #GcrRenderer::data-changed signal on the renderer. This is used by renderer implementations. - + The renderer @@ -2411,19 +2429,19 @@ renderer implementations. c:identifier="gcr_renderer_get_attributes" glib:get-property="attributes"> Get the PKCS#11 attributes, if any, set for this renderer to display. - + the attributes, owned by the renderer The renderer @@ -2432,29 +2450,29 @@ renderer implementations. Called by #GcrViewer when about to display a popup menu for the content displayed by the renderer. The renderer can add a menu item if desired. - + The renderer The viewer that is displaying a popup The popup menu being displayed @@ -2462,22 +2480,22 @@ displayed by the renderer. The renderer can add a menu item if desired. Render the contents of the renderer to the given viewer. - + The renderer The viewer to render to. @@ -2487,16 +2505,16 @@ displayed by the renderer. The renderer can add a menu item if desired. c:identifier="gcr_renderer_set_attributes" glib:set-property="attributes"> Set the PKCS#11 attributes for this renderer to display. - + The renderer @@ -2505,7 +2523,7 @@ displayed by the renderer. The renderer can add a menu item if desired. nullable="1" allow-none="1"> attributes to set @@ -2517,19 +2535,19 @@ displayed by the renderer. The renderer can add a menu item if desired. setter="set_attributes" getter="get_attributes"> The attributes to display. The label to display. A signal that is emitted by the renderer when it's data changed and should be rerendered. @@ -2541,18 +2559,18 @@ changed and should be rerendered. c:type="GcrRendererIface" glib:is-gtype-struct-for="Renderer"> The interface for #GcrRenderer - + the parent interface type - + @@ -2565,20 +2583,20 @@ changed and should be rerendered. - + The renderer The viewer to render to. @@ -2587,7 +2605,7 @@ changed and should be rerendered. - + @@ -2629,7 +2647,7 @@ changed and should be rerendered. - + @@ -2638,7 +2656,7 @@ changed and should be rerendered. - + @@ -2647,7 +2665,7 @@ changed and should be rerendered. - + @@ -2661,7 +2679,7 @@ changed and should be rerendered. glib:get-type="gcr_secure_entry_buffer_get_type" glib:type-struct="SecureEntryBufferClass"> A [class@Gtk.EntryBuffer] that uses non-pageable memory. It's good practice to try to keep passwords or sensitive secrets out of @@ -2675,15 +2693,15 @@ the text. That is, a password style entry. Use [ctor@Gtk.Entry.new_with_buffer] or [method@Gtk.Entry.set_buffer] to set this buffer on an entry. - + Create a new secure entry buffer. - + the new entry buffer @@ -2699,20 +2717,21 @@ on an entry. - + - + disguised="1" + opaque="1"> + - + @@ -2721,7 +2740,7 @@ on an entry. - + @@ -2730,7 +2749,7 @@ on an entry. - + @@ -2744,10 +2763,10 @@ on an entry. glib:get-type="gcr_tree_selector_get_type" glib:type-struct="TreeSelectorClass"> A tree selector can be used to select certificates or keys. It allows the user to select multiple objects from a tree. - + @@ -2755,12 +2774,12 @@ the user to select multiple objects from a tree. c:identifier="gcr_tree_selector_new" introspectable="0"> Create a new #GcrTreeSelector. - + a newly allocated selector, which should be released with g_object_unref() @@ -2768,13 +2787,13 @@ the user to select multiple objects from a tree. The collection that contains the objects to display The columns to use to display the objects @@ -2784,19 +2803,19 @@ the user to select multiple objects from a tree. c:identifier="gcr_tree_selector_get_collection" glib:get-property="collection"> Get the collection that this selector is displaying objects from. - + the collection, owned by the selector The selector @@ -2807,19 +2826,19 @@ the user to select multiple objects from a tree. glib:get-property="columns" introspectable="0"> Get the columns displayed in a selector in multiple mode. - + The columns, owned by the selector. The selector @@ -2828,12 +2847,12 @@ the user to select multiple objects from a tree. Get a list of selected objects. - + the list of selected objects, to be released with g_list_free() @@ -2843,7 +2862,7 @@ the user to select multiple objects from a tree. The selector @@ -2852,22 +2871,22 @@ the user to select multiple objects from a tree. Select certain objects in the selector. - + The selector the list of objects to select @@ -2881,7 +2900,7 @@ the user to select multiple objects from a tree. transfer-ownership="none" getter="get_collection"> The collection which contains the objects to display in the selector. @@ -2891,7 +2910,7 @@ the user to select multiple objects from a tree. transfer-ownership="none" getter="get_columns"> The columns to use to display the objects. @@ -2905,20 +2924,21 @@ the user to select multiple objects from a tree. - + - + disguised="1" + opaque="1"> + - + @@ -2927,7 +2947,7 @@ the user to select multiple objects from a tree. - + @@ -2936,7 +2956,7 @@ the user to select multiple objects from a tree. - + @@ -2950,7 +2970,7 @@ the user to select multiple objects from a tree. glib:get-type="gcr_unlock_options_widget_get_type" glib:type-struct="UnlockOptionsWidgetClass"> This widget displays a set of unlock options for the user to select. The user can choose between keeping caching the unlock indefinitely, or for @@ -2959,18 +2979,17 @@ a given amount of time. Each option has a different name, for example #GCR_UNLOCK_OPTION_ALWAYS. These names are used together with the various functions like [method@UnlockOptionsWidget.get_choice]. - + Create a new #GcrUnlockOptionsWidget. - + a new #GcrUnlockOptionsWidget @@ -2979,20 +2998,19 @@ names are used together with the various functions like c:identifier="gcr_unlock_options_widget_get_choice" glib:get-property="choice"> Get the currently selected option, like %GCR_UNLOCK_OPTION_ALWAYS. - + The currently selected option name. The unlock options widget @@ -3001,27 +3019,26 @@ names are used together with the various functions like Get the label for one of the options. Use an option name like %GCR_UNLOCK_OPTION_ALWAYS. - + The current label for the option. The unlock options widget The option name @@ -3030,27 +3047,26 @@ names are used together with the various functions like Get the sensitivity state for one of the options. Use an option name like %GCR_UNLOCK_OPTION_ALWAYS. - + Whether the option is sensitive or not. The unlock options widget The option name @@ -3060,22 +3076,21 @@ names are used together with the various functions like c:identifier="gcr_unlock_options_widget_get_ttl" glib:get-property="ttl"> Get the timeout setting set for unlock options that have a timeout. This will also return a valid value if the currently selected option does not have a timeout. - + The unlock timeout in seconds. The unlock options widget @@ -3085,24 +3100,23 @@ does not have a timeout. c:identifier="gcr_unlock_options_widget_set_choice" glib:set-property="choice"> Set the currently selected option. Use an option name like %GCR_UNLOCK_OPTION_ALWAYS. - + The unlock options widget The option name @@ -3111,30 +3125,29 @@ does not have a timeout. Set the label for one of the options. Use an option name like %GCR_UNLOCK_OPTION_ALWAYS. - + The unlock options widget The option name The new label @@ -3143,36 +3156,35 @@ does not have a timeout. Set the sensitivity state for one of the options. Use an option name like %GCR_UNLOCK_OPTION_ALWAYS. The reason will be displayed as a tooltip. - + The unlock options widget The option name The sensitivity state. A user displayable string which contains the reason for the sensitivity. @@ -3182,24 +3194,23 @@ does not have a timeout. c:identifier="gcr_unlock_options_widget_set_ttl" glib:set-property="ttl"> Set the current setting for the timeout. This can be set even when the currently selected option does not have a timeout. - + The unlock options widget The timeout to set, in seconds @@ -3209,30 +3220,34 @@ currently selected option does not have a timeout. writable="1" transfer-ownership="none" setter="set_choice" - getter="get_choice"> + getter="get_choice" + default-value="NULL"> + getter="get_ttl" + default-value="0"> - + - + disguised="1" + opaque="1"> + - + @@ -3241,7 +3256,7 @@ currently selected option does not have a timeout. - + @@ -3254,7 +3269,7 @@ currently selected option does not have a timeout. glib:get-type="gcr_viewer_get_type" glib:type-struct="ViewerIface"> An abstract interface that represents a widget that can hold various renderers and display their contents. @@ -3264,17 +3279,17 @@ time. Use the [func@Viewer.new] and [func@Viewer.new_scrolled] to get default implementations of viewers. - + Get an implementation of #GcrViewer that supports a view of multiple renderers. - + a newly allocated #GcrViewer, which should be released with g_object_unref() @@ -3282,35 +3297,35 @@ of multiple renderers. Get an implementation of #GcrViewer that supports a scrolled view of multiple renderers. - + a #GcrViewer which is also a #GtkWidget Add a renderer to this viewer. - + The viewer The renderer to add @@ -3318,19 +3333,19 @@ of multiple renderers. Get the number of renderers present in the viewer. - + The number of renderers. The viewer @@ -3338,26 +3353,26 @@ of multiple renderers. Get a pointer to the renderer at the given index. It is an error to request an index that is out of bounds. - + the render, owned by the viewer The viewer The index of the renderer to get @@ -3365,22 +3380,22 @@ an index that is out of bounds. Insert a renderer at a specific point in the viewer - + the viewer the renderer to insert @@ -3389,7 +3404,7 @@ an index that is out of bounds. nullable="1" allow-none="1"> the renderer to insert before @@ -3397,22 +3412,22 @@ an index that is out of bounds. Remove a renderer from this viewer. - + The viewer The renderer to remove @@ -3420,22 +3435,22 @@ an index that is out of bounds. Add a renderer to this viewer. - + The viewer The renderer to add @@ -3443,19 +3458,19 @@ an index that is out of bounds. Get the number of renderers present in the viewer. - + The number of renderers. The viewer @@ -3463,26 +3478,26 @@ an index that is out of bounds. Get a pointer to the renderer at the given index. It is an error to request an index that is out of bounds. - + the render, owned by the viewer The viewer The index of the renderer to get @@ -3490,22 +3505,22 @@ an index that is out of bounds. Insert a renderer at a specific point in the viewer - + the viewer the renderer to insert @@ -3514,7 +3529,7 @@ an index that is out of bounds. nullable="1" allow-none="1"> the renderer to insert before @@ -3522,22 +3537,22 @@ an index that is out of bounds. Remove a renderer from this viewer. - + The viewer The renderer to remove @@ -3548,31 +3563,31 @@ an index that is out of bounds. c:type="GcrViewerIface" glib:is-gtype-struct-for="Viewer"> The interface for #GcrViewer - + The parent interface - + The viewer The renderer to add @@ -3581,20 +3596,20 @@ an index that is out of bounds. - + the viewer the renderer to insert @@ -3603,7 +3618,7 @@ an index that is out of bounds. nullable="1" allow-none="1"> the renderer to insert before @@ -3612,20 +3627,20 @@ an index that is out of bounds. - + The viewer The renderer to remove @@ -3634,17 +3649,17 @@ an index that is out of bounds. - + The number of renderers. The viewer @@ -3653,23 +3668,23 @@ an index that is out of bounds. - + the render, owned by the viewer The viewer The index of the renderer to get @@ -3697,37 +3712,37 @@ an index that is out of bounds. glib:get-type="gcr_viewer_widget_get_type" glib:type-struct="ViewerWidgetClass"> A viewer widget which can display certificates and keys that are located in files. - + Create a new viewer widget. - + A new #GcrViewerWidget object Clear the error displayed on the viewer widget. - + a viewer widget @@ -3737,23 +3752,23 @@ located in files. c:identifier="gcr_viewer_widget_get_display_name" glib:get-property="display-name"> Get the display name for data being displayed. This is automatically calculated from a loaded file, or can be explicitly set. Used as a hint when displaying a title for the data, but may be overridden by the parsed data. - + the display name a viewer widget @@ -3763,19 +3778,19 @@ overridden by the parsed data. c:identifier="gcr_viewer_widget_get_parser" glib:get-property="parser"> Get the parser used to parse loaded data into viewable items. - + the parser a viewer widget @@ -3783,19 +3798,19 @@ overridden by the parsed data. Get the viewer used to display the viewable items. - + the viewer a viewer widget @@ -3803,18 +3818,18 @@ overridden by the parsed data. Parse and load some data to be displayed into the viewer widgets. The data may contain multiple parseable items if the format can contain multiple items. - + a viewer widget @@ -3823,13 +3838,13 @@ items. nullable="1" allow-none="1"> label for the loaded data data to load @@ -3837,21 +3852,21 @@ items. Parse and load some data to be displayed into the viewer widgets. The data may contain multiple parseable items if the format can contain multiple items. This function will copy the data. Use [method@ViewerWidget.load_bytes] to avoid copying the data. - + a viewer widget @@ -3860,13 +3875,13 @@ copying the data. nullable="1" allow-none="1"> label for the loaded data data to load @@ -3874,7 +3889,7 @@ copying the data. length of data to load @@ -3882,23 +3897,23 @@ copying the data. Display contents of a file in the viewer widget. Multiple files can be loaded. - + a viewer widget a file to load @@ -3908,26 +3923,26 @@ be loaded. c:identifier="gcr_viewer_widget_set_display_name" glib:set-property="display-name"> Set the display name for data being displayed. Once explicitly set it will no longer be calculated automatically by loading data. Used as a hint when displaying a title for the data, but may be overridden by the parsed data. - + a viewer widget the display name @@ -3935,23 +3950,23 @@ overridden by the parsed data. Show an error on the viewer widget. This is displayed on a info bar near the edge of the widget. - + a viewer widget descriptive error message @@ -3960,7 +3975,7 @@ the edge of the widget. nullable="1" allow-none="1"> detailed error @@ -3970,9 +3985,10 @@ the edge of the widget. writable="1" transfer-ownership="none" setter="set_display_name" - getter="get_display_name"> + getter="get_display_name" + default-value="NULL"> Display name for data being displayed. This is automatically calculated from a loaded file, or can be explicitly set. @@ -3982,13 +3998,13 @@ overridden by the parsed data. The parser used to parse loaded data into viewable items. This signal is emitted when an item is added to the viewer widget. @@ -3996,13 +4012,13 @@ overridden by the parsed data. the renderer that was added the parsed item that was added @@ -4012,7 +4028,7 @@ overridden by the parsed data. - + @@ -4021,13 +4037,13 @@ overridden by the parsed data. c:identifier="gcr_renderer_create" moved-to="Renderer.create"> Create and initialize a renderer for the given attributes and label. These renderers should have been preregistered via gcr_renderer_register(). - + a new renderer, or %NULL if no renderer matched the attributes; the render should be released with g_object_unref() @@ -4038,13 +4054,13 @@ renderers should have been preregistered via gcr_renderer_register(). nullable="1" allow-none="1"> The label for the renderer The attributes to render @@ -4054,23 +4070,23 @@ renderers should have been preregistered via gcr_renderer_register(). c:identifier="gcr_renderer_register" moved-to="Renderer.register"> Register a renderer to be created when matching attributes are passed to gcr_renderer_create(). - + The renderer class type The attributes to match @@ -4080,10 +4096,10 @@ gcr_renderer_create(). c:identifier="gcr_renderer_register_well_known" moved-to="Renderer.register_well_known"> Register all the well known renderers for certificates and keys known to the Gcr library. - + @@ -4092,13 +4108,13 @@ Gcr library. c:identifier="gcr_viewer_new" moved-to="Viewer.new"> Get an implementation of #GcrViewer that supports a view of multiple renderers. - + a newly allocated #GcrViewer, which should be released with g_object_unref() @@ -4108,13 +4124,13 @@ of multiple renderers. c:identifier="gcr_viewer_new_scrolled" moved-to="Viewer.new_scrolled"> Get an implementation of #GcrViewer that supports a scrolled view of multiple renderers. - + a #GcrViewer which is also a #GtkWidget diff --git a/girs/Gda-5.0.gir b/girs/Gda-5.0.gir index d41284aa5..fb1404fe7 100644 --- a/girs/Gda-5.0.gir +++ b/girs/Gda-5.0.gir @@ -93,6 +93,7 @@ and/or use gtk-doc annotations. --> @@ -622,7 +623,10 @@ times in @batch's statements' list, then only the first one is removed. c:identifier="GDA_BATCH_CONFLICTING_PARAMETER_ERROR"> - + - + @@ -1970,7 +1977,10 @@ data model. - + - + File to use for system-wide DSN list. When changed, the whole list of DSN will be reloaded. - + File to use for per-user DSN list. When changed, the whole list of DSN will be reloaded. @@ -2525,7 +2541,10 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr c:identifier="GDA_CONFIG_PROVIDER_CREATION_ERROR"> - + + c:identifier="gda_connection_get_cnc_string" + glib:get-property="cnc-string"> Gets the connection string used to open this connection. @@ -3750,7 +3770,9 @@ to open a connection on the underlying data source. - + + c:identifier="gda_connection_get_meta_store" + glib:get-property="meta-store"> Get or initializes the #GdaMetaStore associated to @cnc @@ -3964,7 +3987,9 @@ association must have been done using gda_connection_add_prepared_statement(). - + Gets a pointer to the #GdaServerProvider object used to access the database @@ -5503,19 +5528,31 @@ The equivalent SQL command is: UPDATE &lt;table&gt; SET &lt;column_n - + - + - + + transfer-ownership="none" + default-value="5"> Defines the number of #GdaConnectionEvent objects kept in memory which can @@ -5525,7 +5562,8 @@ be fetched using gda_connection_get_events(). + transfer-ownership="none" + default-value="0"> Artificially slows down the execution of queries. This property can be used to @@ -5536,7 +5574,8 @@ executing each query. + transfer-ownership="none" + default-value="FALSE"> Computes execution times for each statement executed. @@ -5545,7 +5584,8 @@ executing each query. + transfer-ownership="none" + default-value="FALSE"> This property, if set to %TRUE, specifies that the connection is not a real connection, but rather @@ -5556,13 +5596,17 @@ Note: this property is used internally by Libgda and should not be directly used this property has no effect, reading it is supported, though. - + + transfer-ownership="none" + default-value="FALSE"> Useful only when there is a mainloop and when the connection acts as a thread wrapper around another connection, @@ -5574,10 +5618,14 @@ If the connection is not a thread wrapper, then this property has no effect. + transfer-ownership="none" + default-value="GDA_CONNECTION_OPTIONS_NONE"> - + @@ -6109,7 +6157,10 @@ Sets @event's SQL state. - + @@ -6241,7 +6292,8 @@ Sets @event's SQL state. + disguised="1" + opaque="1"> @@ -6537,7 +6589,8 @@ Note about the @GDA_CONNECTION_OPTIONS_AUTO_META_DATA flag: + disguised="1" + opaque="1"> + + + + + + + + + + + + + + @@ -6897,7 +6968,8 @@ and the columns of the wrapped data model + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> + c:identifier="gda_data_model_array_set_n_columns" + glib:set-property="n-columns"> Sets the number of columns for rows inserted in this model. @@ -10527,10 +10601,17 @@ Also clears @model's contents. - + - + @@ -10582,9 +10663,416 @@ Also clears @model's contents. + disguised="1" + opaque="1"> + + + + + Creates a new #GdaDataModel object to access the contents of the Berkeley DB file @file, +for the database @db_name if not %NULL + + + a new #GdaDataModel + + + + + name of the file containing the database + + + + the name of the database within @filename, or %NULL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Reset the list of errors which have occurred while using @model + + + + + + + a #GdaDataModelBdb object + + + + + + Get the list of errors which have occurred while using @model + + + a read-only list of #GError pointers, or %NULL if no error has occurred + + + + + + + a #GdaDataModelBdb object + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + transfer-ownership="none" + default-value="NULL"> @@ -10709,7 +11198,8 @@ Also clears @model's contents. + disguised="1" + opaque="1"> + transfer-ownership="none" + default-value="NULL"> Data to import, as a string. @@ -11638,7 +12129,8 @@ can be accessed in a random way. + transfer-ownership="none" + default-value="NULL"> Name of the file to import. @@ -11656,7 +12148,8 @@ can be accessed in a random way. + transfer-ownership="none" + default-value="FALSE"> Defines if the data model will be accessed randomly or through a cursor. If set to %FALSE, @@ -11667,7 +12160,8 @@ access will have to be done using a cursor. version="4.2.1" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="FALSE"> Defines the behaviour in case the imported data contains recoverable errors (usually too @@ -11734,7 +12228,8 @@ will stop, and if set to %FALSE, then the error will be reported but the import + disguised="1" + opaque="1"> - + - + @@ -12240,7 +12741,8 @@ row it was on was the last one). + disguised="1" + opaque="1"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="1"> @@ -12527,7 +13033,8 @@ gda_data_model_iter_get_value_at() will return %NULL when using an iterator. + disguised="1" + opaque="1"> c:identifier="GDA_DATA_PIVOT_FIELD_COLUMN"> - + + c:identifier="gda_data_proxy_get_sample_size" + glib:get-property="sample-size"> Get the size of each chunk of data displayed at a time. @@ -13639,7 +14150,8 @@ Note that any previous filter expression is replaced with the new @filter_expr i + c:identifier="gda_data_proxy_set_sample_size" + glib:set-property="sample-size"> Sets the size of each chunk of data to display: the maximum number of rows which @@ -13722,7 +14234,8 @@ To remove the chunking of the data to display, simply pass @sample_size the %0 v + transfer-ownership="none" + default-value="FALSE"> Defines how changes kept in the data proxy are handled when the proxied data model @@ -13737,7 +14250,10 @@ the change's number of columns match the proxied data model's number of columns </itemizedlist> - + + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + setter="set_sample_size" + getter="get_sample_size" + default-value="300"> @@ -14049,7 +14569,10 @@ callback returns a non %NULL value, then the change commit fails with the return c:identifier="GDA_DATA_PROXY_FILTER_ERROR"> - + + c:identifier="gda_data_select_get_connection" + glib:get-property="connection"> Get a pointer to the #GdaConnection object which was used when @model was created @@ -14521,13 +15045,17 @@ gda_data_select_set_modification_statement(). - + + transfer-ownership="none" + getter="get_connection"> @@ -14542,7 +15070,8 @@ gda_data_select_set_modification_statement(). + transfer-ownership="none" + default-value="0.000000"> This property stores the execution delay which has been necessary to obtain the data @@ -14554,7 +15083,8 @@ gda_data_select_set_modification_statement(). + transfer-ownership="none" + default-value="1"> @@ -14563,7 +15093,10 @@ gda_data_select_set_modification_statement(). - + @@ -14788,7 +15321,8 @@ to uniquely identify a single row in a table when creating modification statemen + disguised="1" + opaque="1"> - + + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> - + - + - + @@ -16000,7 +16548,9 @@ the same type as the one required by @holder. - + Get the ID of @holder. The ID can be set using @holder's "id" property @@ -16020,7 +16570,9 @@ the same type as the one required by @holder. - + Get wether the holder can be NULL or not @@ -16041,7 +16593,8 @@ the same type as the one required by @holder. + c:identifier="gda_holder_get_source_model" + glib:get-property="source-model"> If gda_holder_set_source_model() has been used to provide a hint that @holder's value @@ -16277,7 +16830,9 @@ NOTE: the default value does not need to be of the same type as the one required - + Sets if the holder can have a NULL value. If @not_null is TRUE, then that won't be allowed @@ -16302,6 +16857,7 @@ NOTE: the default value does not need to be of the same type as the one required - + @@ -16570,31 +17129,52 @@ take care of the 'old' static GValue. + transfer-ownership="none" + getter="get_g_type"> - + - + - + - + - + + transfer-ownership="none" + default-value="TRUE"> Defines if the "validate-change" signal gets emitted when @@ -16783,7 +17363,10 @@ otherwise. c:identifier="GDA_HOLDER_VALUE_NULL_ERROR"> - + + + + + + + + + + + + + + + @@ -19319,7 +19920,8 @@ See gda_meta_store_declare_foreign_key() for more information anout the @catalog readable="0" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="NULL"> @@ -19514,7 +20118,8 @@ signal, or %NULL if signal propagation should continue + disguised="1" + opaque="1"> @@ -19568,7 +20173,10 @@ signal, or %NULL if signal propagation should continue c:identifier="GDA_META_STORE_TRANSACTION_ALREADY_STARTED_ERROR"> - + + transfer-ownership="none" + default-value="3"> + disguised="1" + opaque="1"> @@ -20939,7 +21549,10 @@ will return %NULL - + @@ -20992,6 +21605,7 @@ will return %NULL @@ -21627,7 +22241,8 @@ providers' implementations to report any error while reading a value from the da + transfer-ownership="none" + default-value="1"> @@ -21677,7 +22292,7 @@ providers' implementations to report any error while reading a value from the da - + + c:identifier="gda_server_operation_get_op_type" + glib:get-property="op-type"> Get the type of operation @op is for @@ -23023,7 +23639,9 @@ Here are the possible formats of @path_format: + transfer-ownership="none" + getter="get_op_type" + default-value="0"> + transfer-ownership="none" + default-value="NULL"> @@ -23292,7 +23911,8 @@ Here are the possible formats of @path_format: + disguised="1" + opaque="1"> @@ -26005,7 +26625,8 @@ otherwise. + disguised="1" + opaque="1"> @@ -28152,7 +28773,10 @@ the source by the new model - + transfer-ownership="none"> - + - + + transfer-ownership="none" + default-value="TRUE"> Defines if the "validate-set" signal gets emitted when @@ -28967,7 +29598,7 @@ then column is set to invalid (-1); - + readable="0" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="GDA_SQL_STATEMENT_UNKNOWN"> Specifies the type of statement to be built, can only be @@ -30857,7 +31489,8 @@ or GDA_SQL_STATEMENT_DELETE + disguised="1" + opaque="1"> @@ -31792,18 +32425,24 @@ To include variables in the @sql string, see the - + - + - + + transfer-ownership="none" + default-value="0"> @@ -32055,7 +32694,10 @@ To include variables in the @sql string, see the c:identifier="GDA_SQL_PARSER_MODE_DELIMIT"> - + @@ -33107,7 +33749,10 @@ set the value of @expr->value instead. - + + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> @@ -33421,13 +34070,15 @@ set the value of @expr->value instead. + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> @@ -34102,7 +34753,10 @@ of the statement have been verified (emitted after gda_statement_check_validity( line="66">specifies that the data model's contents will be fully loaded into the client side (the memory of the process using Libgda), not requiring the server any more to access the data (the default behaviour is to access the server any time data is to be read, and data is cached in memory). This flag is useful only if used in conjunction with the GDA_STATEMENT_MODEL_RANDOM_ACCESS flag (otherwise an error will be returned). - + @@ -35204,7 +35858,8 @@ was called. + disguised="1" + opaque="1"> @@ -36184,7 +36839,7 @@ gda_tree_update_part()). If @node is %NULL then the top level nodes are updated. - + Tells if the GdaTree is a list or a tree. @@ -36643,7 +37298,8 @@ managed has to be updated + transfer-ownership="none" + default-value="TRUE"> This property specifies if, when initially creating nodes or updating the list of nodes, @@ -36782,7 +37438,8 @@ and needs to be postponed while an event occurs. + disguised="1" + opaque="1"> readable="0" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="NULL"> If no set, then the table name will be fetched from the parent node using the "schema" attribute @@ -36864,7 +37522,8 @@ priority over the GdaTreeMgrColumns:connection property. readable="0" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="NULL"> If no set, then the table name will be fetched from the parent node using the "table_name" attribute @@ -36887,7 +37546,8 @@ priority over the GdaTreeMgrColumns:connection property. + disguised="1" + opaque="1"> readable="0" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="NULL"> @@ -36942,7 +37603,10 @@ priority over the GdaTreeMgrColumns:connection property. - + + transfer-ownership="none" + default-value="NULL"> Defines the Distinguised Name of the LDAP entry to list children from @@ -37020,7 +37685,10 @@ use it. - + + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> readable="0" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="NULL"> If no set, then the table name will be fetched from the parent node using the "schema" attribute. If not @@ -37268,7 +37939,8 @@ a schema) will be used + disguised="1" + opaque="1"> - + @@ -37834,10 +38509,16 @@ does not have a ny children anymore when it had some c:identifier="GDA_TREE_NODE_UNKNOWN_ERROR"> - + - + + transfer-ownership="none" + default-value="1"> + transfer-ownership="none" + default-value="NULL"> @@ -38374,7 +39057,8 @@ are converted to "%ab" where ab is the hexadecimal representation of the charact + disguised="1" + opaque="1"> @@ -39213,6 +39897,19 @@ as #GdaRow objects). In this data model, all the data is stored in memory, which of rows is huge. This type of data model is easy to use to store some temporary data, and has a random access mode (any value can be accessed at any time without the need for an iterator). + + + The #GdaDataModelBdb object allows to access the contents of a Berkeley DB database as a +#GdaDataModel object. + +By default the resulting GdaDataModel contains only two columns (named "key" and "data") of type +GDA_TYPE_BINARY, but this object can be subclassed to convert the key or data part of a BDB record +into several columns (implement the create_key_columns(), create_data_columns(), get_key_part(), and get_data_part() +virtual methods). + +Note: this type of data model is available only if the Berkeley DB library was found at compilation time. + + + + + + + + + + + + + + @@ -83,6 +101,67 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -381,31 +460,31 @@ times in @batch's statements' list, then only the first one is removed. Creates a new #GdaBinary coping data. + line="618">Creates a new #GdaBinary coping data. the newly created #GdaBinary. + line="623">the newly created #GdaBinary. Creates a new #GdaBinary structure from an existing one. + line="732">Creates a new #GdaBinary structure from an existing one. a newly allocated #GdaBinary which contains a copy of information in @boxed. + line="738">a newly allocated #GdaBinary which contains a copy of information in @boxed. source to get a copy from. + line="734">source to get a copy from. @@ -413,7 +492,7 @@ times in @batch's statements' list, then only the first one is removed. Deallocates all memory associated to the given #GdaBinary. + line="755">Deallocates all memory associated to the given #GdaBinary. @@ -422,7 +501,7 @@ times in @batch's statements' list, then only the first one is removed. #GdaBinary to free. + line="757">#GdaBinary to free. @@ -432,14 +511,14 @@ times in @batch's statements' list, then only the first one is removed. associated data to #GdaBinary. + line="682">associated data to #GdaBinary. a #GdaBinary pointer + line="680">a #GdaBinary pointer @@ -449,7 +528,7 @@ times in @batch's statements' list, then only the first one is removed. size of associated data to #GdaBinary or -1 in case of error. + line="719">size of associated data to #GdaBinary or -1 in case of error. @@ -463,7 +542,7 @@ times in @batch's statements' list, then only the first one is removed. version="6.0"> Frees data referenced by #GdaBinary + line="696">Frees data referenced by #GdaBinary @@ -472,7 +551,7 @@ times in @batch's statements' list, then only the first one is removed. a #GdaBinary pointer + line="698">a #GdaBinary pointer @@ -480,7 +559,7 @@ times in @batch's statements' list, then only the first one is removed. Set binary data to a #GdaBinary, holding a copy of the data. + line="638">Set binary data to a #GdaBinary, holding a copy of the data. @@ -489,13 +568,13 @@ times in @batch's statements' list, then only the first one is removed. a #GdaBinary pointer + line="640">a #GdaBinary pointer value to be copied by #GdaBinary. + line="641">value to be copied by #GdaBinary. @@ -503,7 +582,7 @@ times in @batch's statements' list, then only the first one is removed. the size of the memory pool pointer to by @val. + line="642">the size of the memory pool pointer to by @val. @@ -511,7 +590,7 @@ times in @batch's statements' list, then only the first one is removed. Set binary data to a #GdaBinary, directly holding @val (no copy made). + line="659">Set binary data to a #GdaBinary, directly holding @val (no copy made). @@ -523,7 +602,7 @@ times in @batch's statements' list, then only the first one is removed. value to be taken by #GdaBinary. + line="661">value to be taken by #GdaBinary. @@ -531,7 +610,7 @@ times in @batch's statements' list, then only the first one is removed. the size of the memory pool pointer to by @val. + line="662">the size of the memory pool pointer to by @val. @@ -539,7 +618,7 @@ times in @batch's statements' list, then only the first one is removed. Converts all the non printable characters of bin->data into the "\xyz" representation + line="3439">Converts all the non printable characters of bin->data into the "\xyz" representation where "xyz" is the octal representation of the byte, and the '\' (backslash) character is converted to "\\". Printable characters (defined by g_ascii_isprint()) as well as newline character are not converted. @@ -554,20 +633,20 @@ a string for example when using g_value_transform() or gda_value_stringify(). a new string from @bin + line="3456">a new string from @bin a correctly filled @GdaBinary structure + line="3441">a correctly filled @GdaBinary structure a maximum len used to truncate, or %0 for no maximum length + line="3442">a maximum len used to truncate, or %0 for no maximum length @@ -588,31 +667,31 @@ a database, but can be modified if needed using gda_blob_set_op(). Creates a new #GdaBlob. + line="832">Creates a new #GdaBlob. a newly allocated #GdaBlob. + line="837">a newly allocated #GdaBlob. Creates a new #GdaBlob structure from an existing one. + line="883">Creates a new #GdaBlob structure from an existing one. a newly allocated #GdaBlob which contains a copy of information in @boxed. + line="889">a newly allocated #GdaBlob which contains a copy of information in @boxed. source to get a copy from. + line="885">source to get a copy from. @@ -620,7 +699,7 @@ a database, but can be modified if needed using gda_blob_set_op(). Deallocates all memory associated to the given #GdaBlob. + line="913">Deallocates all memory associated to the given #GdaBlob. @@ -629,7 +708,7 @@ a database, but can be modified if needed using gda_blob_set_op(). #GdaBlob to free. + line="915">#GdaBlob to free. @@ -641,14 +720,14 @@ a database, but can be modified if needed using gda_blob_set_op(). associated #GdaBinary. + line="854">associated #GdaBinary. a #GdaBlob pointer + line="852">a #GdaBlob pointer @@ -658,14 +737,14 @@ a database, but can be modified if needed using gda_blob_set_op(). associated #GdaBlobOp. + line="870">associated #GdaBlobOp. a #GdaBlob pointer + line="868">a #GdaBlob pointer @@ -673,7 +752,7 @@ a database, but can be modified if needed using gda_blob_set_op(). Correctly assigns @op to @blob (increases @op's reference count) + line="932">Correctly assigns @op to @blob (increases @op's reference count) @@ -682,7 +761,7 @@ a database, but can be modified if needed using gda_blob_set_op(). a #GdaBlob value + line="934">a #GdaBlob value allow-none="1"> a #GdaBlobOp object, or %NULL + line="935">a #GdaBlobOp object, or %NULL @@ -699,27 +778,27 @@ a database, but can be modified if needed using gda_blob_set_op(). Converts all the non printable characters of blob->data into the \xxx representation + line="3594">Converts all the non printable characters of blob->data into the \xxx representation where xxx is the octal representation of the byte, and the '\' (backslash) character is converted to "\\". a new string from @blob + line="3603">a new string from @blob a correctly filled @GdaBlob structure + line="3596">a correctly filled @GdaBlob structure a maximum len used to truncate, or 0 for no maximum length + line="3597">a maximum len used to truncate, or 0 for no maximum length @@ -979,6 +1058,105 @@ blob is truncated from its previous length. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1521,6 +1787,433 @@ data model. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + c:identifier="gda_config_can_modify_system_config"> Tells if the global (system) configuration can be modified (considering + line="1600">Tells if the global (system) configuration can be modified (considering system permissions and settings) TRUE if system-wide configuration can be modified + line="1606">TRUE if system-wide configuration can be modified @@ -1548,21 +2241,21 @@ system permissions and settings) throws="1"> Add or update a DSN from the definition in @info. + line="1198">Add or update a DSN from the definition in @info. This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigError error codes). TRUE if no error occurred + line="1207">TRUE if no error occurred a pointer to a filled GdaDsnInfo structure + line="1200">a pointer to a filled GdaDsnInfo structure @@ -1571,20 +2264,20 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr c:identifier="gda_config_dsn_needs_authentication"> Tells if the data source identified as @dsn_name needs any authentication. If a &lt;username&gt; + line="1471">Tells if the data source identified as @dsn_name needs any authentication. If a &lt;username&gt; and optionally a &lt;password&gt; are specified, they are ignored. TRUE if an authentication is needed + line="1478">TRUE if an authentication is needed the name of a DSN, in the "[&lt;username&gt;[:&lt;password&gt;]@]&lt;DSN&gt;" format + line="1473">the name of a DSN, in the "[&lt;username&gt;[:&lt;password&gt;]@]&lt;DSN&gt;" format @@ -1597,20 +2290,20 @@ and optionally a &lt;password&gt; are specified, they are ignored. Get a pointer to the global (unique) #GdaConfig object. This functions increments + line="1112">Get a pointer to the global (unique) #GdaConfig object. This functions increments the reference count of the object, so you need to call g_object_unref() on it once finished. a non %NULL pointer to the unique #GdaConfig + line="1118">a non %NULL pointer to the unique #GdaConfig Get information about the DSN named @dsn_name. + line="1130">Get information about the DSN named @dsn_name. @dsn_name's format is "[&lt;username&gt;[:&lt;password&gt;]@]&lt;DSN&gt;" (if &lt;username&gt; and optionally &lt;password&gt; are provided, they are ignored). Also see the gda_dsn_split() utility @@ -1619,14 +2312,14 @@ function. a pointer to read-only #GdaDsnInfo structure, or %NULL if not found + line="1140">a pointer to read-only #GdaDsnInfo structure, or %NULL if not found the name of the DSN to look for + line="1132">the name of the DSN to look for @@ -1635,19 +2328,19 @@ function. c:identifier="gda_config_get_dsn_info_at_index"> Get a pointer to a read-only #GdaDsnInfo at the @index position + line="1579">Get a pointer to a read-only #GdaDsnInfo at the @index position the pointer or %NULL if no DSN exists at position @index + line="1585">the pointer or %NULL if no DSN exists at position @index an index + line="1581">an index @@ -1656,19 +2349,19 @@ function. c:identifier="gda_config_get_dsn_info_index"> Get the index (starting at 0) of the DSN named @dsn_name + line="1551">Get the index (starting at 0) of the DSN named @dsn_name the index or -1 if not found + line="1557">the index or -1 if not found a DSN + line="1553">a DSN @@ -1676,12 +2369,12 @@ function. Get the number of defined DSN + line="1530">Get the number of defined DSN the number of defined DSN + line="1535">the number of defined DSN @@ -1690,7 +2383,7 @@ function. throws="1"> Get a pointer to the session-wide #GdaServerProvider for the + line="1656">Get a pointer to the session-wide #GdaServerProvider for the provider named @provider_name. The caller must not call g_object_unref() on the returned object. @@ -1699,14 +2392,14 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr a pointer to the #GdaServerProvider, or %NULL if an error occurred + line="1667">a pointer to the #GdaServerProvider, or %NULL if an error occurred a database provider + line="1658">a database provider @@ -1715,19 +2408,19 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr c:identifier="gda_config_get_provider_info"> Get some information about the a database provider (adapter) named + line="1621">Get some information about the a database provider (adapter) named a pointer to read-only #GdaProviderInfo structure, or %NULL if not found + line="1627">a pointer to read-only #GdaProviderInfo structure, or %NULL if not found a database provider + line="1623">a database provider @@ -1735,7 +2428,7 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr Get a #GdaDataModel representing all the configured DSN, and keeping itself up to date with + line="1500">Get a #GdaDataModel representing all the configured DSN, and keeping itself up to date with the changes in the declared DSN. The returned data model is composed of the following columns: @@ -1750,14 +2443,14 @@ The returned data model is composed of the following columns: a new #GdaDataModel + line="1515">a new #GdaDataModel Get a #GdaDataModel representing all the installed database providers. + line="1725">Get a #GdaDataModel representing all the installed database providers. The returned data model is composed of the following columns: <itemizedlist> @@ -1771,7 +2464,7 @@ The returned data model is composed of the following columns: a new #GdaDataModel + line="1739">a new #GdaDataModel @@ -1780,21 +2473,21 @@ The returned data model is composed of the following columns: throws="1"> Remove the DSN named @dsn_name. + line="1368">Remove the DSN named @dsn_name. This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigError error codes). TRUE if no error occurred + line="1377">TRUE if no error occurred the name of the DSN to remove + line="1370">the name of the DSN to remove @@ -1861,7 +2554,7 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr default-value="NULL"> File to use for system-wide DSN list. When changed, the whole list of DSN will be reloaded. + line="466">File to use for system-wide DSN list. When changed, the whole list of DSN will be reloaded. File to use for per-user DSN list. When changed, the whole list of DSN will be reloaded. + line="455">File to use for per-user DSN list. When changed, the whole list of DSN will be reloaded. @@ -1879,7 +2572,7 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr Gets emitted whenever a new DSN has been defined + line="390">Gets emitted whenever a new DSN has been defined @@ -1890,7 +2583,7 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr allow-none="1"> a #GdaDsnInfo + line="393">a #GdaDsnInfo @@ -1898,7 +2591,7 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr Gets emitted whenever a DSN's definition has been changed + line="435">Gets emitted whenever a DSN's definition has been changed @@ -1909,7 +2602,7 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr allow-none="1"> a #GdaDsnInfo + line="438">a #GdaDsnInfo @@ -1917,7 +2610,7 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr Gets emitted whenever a DSN has been removed + line="420">Gets emitted whenever a DSN has been removed @@ -1928,7 +2621,7 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr allow-none="1"> a #GdaDsnInfo + line="423">a #GdaDsnInfo @@ -1936,7 +2629,7 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr Gets emitted whenever a DSN is about to be removed + line="405">Gets emitted whenever a DSN is about to be removed @@ -1947,7 +2640,7 @@ This method may fail with a %GDA_CONFIG_ERROR domain error (see the #GdaConfigEr allow-none="1"> a #GdaDsnInfo + line="408">a #GdaDsnInfo @@ -2296,13 +2989,13 @@ The returned connection is not yet opened, you need to call gda_connection_open( c:identifier="gda_connection_internal_get_worker"> Retreive a pointer to the #GdaWorker used internally by the connection. This function is reserved to + line="6252">Retreive a pointer to the #GdaWorker used internally by the connection. This function is reserved to database provider's implementation and should not be used otherwise. the #GdaWorker, or %NULL + line="6259">the #GdaWorker, or %NULL @@ -2312,7 +3005,7 @@ database provider's implementation and should not be used otherwise. allow-none="1"> a #GdaServerProviderConnectionData, or %NULL + line="6254">a #GdaServerProviderConnectionData, or %NULL @@ -2699,7 +3392,7 @@ function that simply creates a #GdaConnectionEvent and then calls c:identifier="gda_connection_add_prepared_statement"> Declares that @prepared_stmt is a prepared statement object associated to @gda_stmt within the connection + line="6111">Declares that @prepared_stmt is a prepared statement object associated to @gda_stmt within the connection (meaning the connection increments the reference counter of @prepared_stmt). If @gda_stmt changes or is destroyed, the the association will be lost and the connection will lose the @@ -2712,19 +3405,19 @@ reference it has on @prepared_stmt. a #GdaConnection object + line="6113">a #GdaConnection object a #GdaStatement object + line="6114">a #GdaStatement object a prepared statement object (as a #GdaPStmt object, or more likely a descendant) + line="6115">a prepared statement object (as a #GdaPStmt object, or more likely a descendant) @@ -2734,19 +3427,19 @@ reference it has on @prepared_stmt. throws="1"> Adds a SAVEPOINT named @name. + line="3975">Adds a SAVEPOINT named @name. TRUE if no error occurred + line="3983">TRUE if no error occurred a #GdaConnection object + line="3977">a #GdaConnection object allow-none="1"> name of the savepoint to add + line="3978">name of the savepoint to add @@ -2816,7 +3509,7 @@ then it should be started before calling this method. throws="1"> Starts a transaction on the data source, identified by the @name parameter. + line="3887">Starts a transaction on the data source, identified by the @name parameter. Before starting a transaction, you can check whether the underlying provider does support transactions or not by using the gda_connection_supports_feature() function. @@ -2824,14 +3517,14 @@ provider does support transactions or not by using the gda_connection_supports_f %TRUE if the transaction was started successfully with the corresponding isolation level, %FALSE otherwise. + line="3899">%TRUE if the transaction was started successfully with the corresponding isolation level, %FALSE otherwise. a #GdaConnection object. + line="3889">a #GdaConnection object. the name of the transation to start, or %NULL + line="3890">the name of the transation to start, or %NULL the requested transaction level (use %GDA_TRANSACTION_ISOLATION_SERVER_DEFAULT to apply the server default) + line="3891">the requested transaction level (use %GDA_TRANSACTION_ISOLATION_SERVER_DEFAULT to apply the server default) @@ -2893,13 +3586,13 @@ given connection. throws="1"> Commits the given transaction to the backend database. You need to call + line="3918">Commits the given transaction to the backend database. You need to call gda_connection_begin_transaction() first. %TRUE if the transaction was finished successfully, + line="3927">%TRUE if the transaction was finished successfully, %FALSE otherwise. @@ -2907,7 +3600,7 @@ gda_connection_begin_transaction() first. a #GdaConnection object. + line="3920">a #GdaConnection object. allow-none="1"> the name of the transation to commit, or %NULL + line="3921">the name of the transation to commit, or %NULL @@ -2926,7 +3619,7 @@ gda_connection_begin_transaction() first. version="6.0"> A convenient method to create a new #GdaDbCatalog instance and set the current @cnc as a + line="7329">A convenient method to create a new #GdaDbCatalog instance and set the current @cnc as a property. If for some reason, this approach doesn't fit well, the same task can be achieved by the following code: @@ -2936,7 +3629,7 @@ g_object_set (catalog, "connection", cnc, NULL); A new instance of #GdaDbCatalog. The new object should be deallocated + line="7340">A new instance of #GdaDbCatalog. The new object should be deallocated using g_object_unref(). @@ -2944,7 +3637,7 @@ using g_object_unref(). A #GdaConnection object to use + line="7331">A #GdaConnection object to use @@ -3016,7 +3709,7 @@ using gda_sql_parser_new(). c:identifier="gda_connection_del_prepared_statement"> Removes any prepared statement associated to @gda_stmt in @cnc: this undoes what + line="6179">Removes any prepared statement associated to @gda_stmt in @cnc: this undoes what gda_connection_add_prepared_statement() does. @@ -3026,13 +3719,13 @@ gda_connection_add_prepared_statement() does. a #GdaConnection object + line="6181">a #GdaConnection object a #GdaStatement object + line="6182">a #GdaStatement object @@ -3126,19 +3819,19 @@ g_error_free (error); throws="1"> Delete the SAVEPOINT named @name when not used anymore. + line="4027">Delete the SAVEPOINT named @name when not used anymore. TRUE if no error occurred + line="4035">TRUE if no error occurred a #GdaConnection object + line="4029">a #GdaConnection object name of the savepoint to delete + line="4030">name of the savepoint to delete @@ -3158,26 +3851,26 @@ g_error_free (error); throws="1"> This is a convenience function to execute a SQL command over the opened connection. For the + line="3349">This is a convenience function to execute a SQL command over the opened connection. For the returned value, see gda_connection_statement_execute_non_select()'s documentation. the number of rows affected or -1, or -2 + line="3358">the number of rows affected or -1, or -2 an opened connection + line="3351">an opened connection a query statement that must not begin with "SELECT" + line="3352">a query statement that must not begin with "SELECT" @@ -3344,7 +4037,7 @@ to. Retrieves a list of the last errors occurred during the connection. The returned list is + line="5557">Retrieves a list of the last errors occurred during the connection. The returned list is chronologically ordered such as that the most recent event is the #GdaConnectionEvent of the first node. Warning: the @cnc object may change the list if connection events occur @@ -3352,7 +4045,7 @@ Warning: the @cnc object may change the list if connection events occur a #GList of #GdaConnectionEvent objects (the list should not be modified) + line="5566">a #GList of #GdaConnectionEvent objects (the list should not be modified) @@ -3361,7 +4054,7 @@ Warning: the @cnc object may change the list if connection events occur a #GdaConnection. + line="5559">a #GdaConnection. @@ -3410,19 +4103,19 @@ operation has finished. glib:get-property="meta-store"> Get or initializes the #GdaMetaStore associated to @cnc + line="6296">Get or initializes the #GdaMetaStore associated to @cnc a #GdaMetaStore object + line="6302">a #GdaMetaStore object a #GdaConnection object + line="6298">a #GdaConnection object @@ -3433,7 +4126,7 @@ operation has finished. introspectable="0"> Retrieves data stored in @cnc's associated #GdaMetaStore object. This method is useful + line="5286">Retrieves data stored in @cnc's associated #GdaMetaStore object. This method is useful to easily get some information about the meta-data associated to @cnc, such as the list of tables, views, and other database objects. @@ -3455,7 +4148,7 @@ gda_sql_identifier_quote() function which will be most useful. a #GdaDataModel containing the data required. The caller is responsible + line="5314">a #GdaDataModel containing the data required. The caller is responsible for freeing the returned model using g_object_unref(). @@ -3463,31 +4156,31 @@ for freeing the returned model using g_object_unref(). a #GdaConnection object. + line="5288">a #GdaConnection object. describes which data to get. + line="5289">describes which data to get. a place to store errors, or %NULL + line="5290">a place to store errors, or %NULL the number of filters in the @... argument + line="5291">the number of filters in the @... argument a list of (filter name (gchar *), filter value (GValue*)) pairs specifying + line="5292">a list of (filter name (gchar *), filter value (GValue*)) pairs specifying the filter to apply to the returned data model's contents (there must be @nb_filters pairs) @@ -3499,12 +4192,12 @@ the filter to apply to the returned data model's contents (there must be @nb_fil throws="1"> see #gda_connection_get_meta_store_data + line="5370">see #gda_connection_get_meta_store_data a #GdaDataModel containing the data required. The caller is responsible + line="5379">a #GdaDataModel containing the data required. The caller is responsible for freeing the returned model using g_object_unref(). @@ -3512,19 +4205,19 @@ for freeing the returned model using g_object_unref(). a #GdaConnection object. + line="5372">a #GdaConnection object. describes which data to get. + line="5373">describes which data to get. a #GList of #GdaHolder objects + line="5375">a #GList of #GdaHolder objects @@ -3555,26 +4248,26 @@ for freeing the returned model using g_object_unref(). c:identifier="gda_connection_get_prepared_statement"> Retrieves a pointer to an object representing a prepared statement for @gda_stmt within @cnc. The + line="6150">Retrieves a pointer to an object representing a prepared statement for @gda_stmt within @cnc. The association must have been done using gda_connection_add_prepared_statement(). the prepared statement, or %NULL if no association exists + line="6158">the prepared statement, or %NULL if no association exists a #GdaConnection object + line="6152">a #GdaConnection object a #GdaStatement object + line="6153">a #GdaStatement object @@ -3649,7 +4342,7 @@ to obtain the result. c:identifier="gda_connection_get_transaction_status"> Get the status of @cnc regarding transactions. The returned object should not be modified + line="4053">Get the status of @cnc regarding transactions. The returned object should not be modified or destroyed; however it may be modified or destroyed by the connection itself. If %NULL is returned, then no transaction has been associated with @cnc @@ -3657,14 +4350,14 @@ If %NULL is returned, then no transaction has been associated with @cnc a #GdaTransactionStatus object, or %NULL + line="4062">a #GdaTransactionStatus object, or %NULL a #GdaConnection object + line="4055">a #GdaConnection object @@ -3805,7 +4498,7 @@ The equivalent SQL command is: INSERT INTO &lt;table&gt; (&lt;column c:identifier="gda_connection_internal_change_transaction_state"> Internal function to be called by database providers to force a transaction status + line="6009">Internal function to be called by database providers to force a transaction status change. @@ -3815,13 +4508,13 @@ change. a #GdaConnection + line="6011">a #GdaConnection the new state + line="6012">the new state @@ -3833,13 +4526,13 @@ change. throws="1"> Get the opaque pointer previously set using gda_connection_internal_set_provider_data(). + line="6270">Get the opaque pointer previously set using gda_connection_internal_set_provider_data(). If it's not set, then add a connection event and returns %NULL the pointer to the opaque structure set using gda_connection_internal_set_provider_data(), or %NULL + line="6278">the pointer to the opaque structure set using gda_connection_internal_set_provider_data(), or %NULL @@ -3847,7 +4540,7 @@ If it's not set, then add a connection event and returns %NULL a #GdaConnection object + line="6272">a #GdaConnection object @@ -3856,7 +4549,7 @@ If it's not set, then add a connection event and returns %NULL c:identifier="gda_connection_internal_reset_transaction_status"> Internal function to be called by database providers to reset the transaction status. + line="6042">Internal function to be called by database providers to reset the transaction status. @@ -3865,7 +4558,7 @@ If it's not set, then add a connection event and returns %NULL a #GdaConnection + line="6044">a #GdaConnection @@ -3874,7 +4567,7 @@ If it's not set, then add a connection event and returns %NULL c:identifier="gda_connection_internal_savepoint_added"> Internal functions to be called by database providers when a savepoint has been added + line="5794">Internal functions to be called by database providers when a savepoint has been added to keep track of the transaction status of the connection Note: this function should not be called if gda_connection_internal_statement_executed() @@ -3888,7 +4581,7 @@ the action. a #GdaConnection + line="5796">a #GdaConnection allow-none="1"> name of the parent transaction, or %NULL + line="5797">name of the parent transaction, or %NULL savepoint's name, or %NULL + line="5798">savepoint's name, or %NULL @@ -3912,7 +4605,7 @@ the action. c:identifier="gda_connection_internal_savepoint_removed"> Internal functions to be called by database providers when a savepoint has been removed + line="5884">Internal functions to be called by database providers when a savepoint has been removed to keep track of the transaction status of the connection Note: this function should not be called if gda_connection_internal_statement_executed() @@ -3926,7 +4619,7 @@ the action. a #GdaConnection + line="5886">a #GdaConnection allow-none="1"> savepoint's name, or %NULL + line="5887">savepoint's name, or %NULL @@ -3944,7 +4637,7 @@ the action. c:identifier="gda_connection_internal_savepoint_rolledback"> Internal functions to be called by database providers when a savepoint has been rolled back + line="5839">Internal functions to be called by database providers when a savepoint has been rolled back to keep track of the transaction status of the connection Note: this function should not be called if gda_connection_internal_statement_executed() @@ -3958,7 +4651,7 @@ the action. a #GdaConnection + line="5841">a #GdaConnection allow-none="1"> savepoint's name, or %NULL + line="5842">savepoint's name, or %NULL @@ -3976,7 +4669,7 @@ the action. c:identifier="gda_connection_internal_set_provider_data"> Note: calling this function more than once will not make it call @destroy_func on any previously + line="6205">Note: calling this function more than once will not make it call @destroy_func on any previously set opaque @data, you'll have to do it yourself. Note: @destroy_func, needs to free the memory associated to @data, if necessary. @@ -3988,13 +4681,13 @@ Note: @destroy_func, needs to free the memory associated to @data, if necessary. a #GdaConnection object + line="6207">a #GdaConnection object a #GdaServerProviderConnectionData, which can be extended as needed by the provider for which @cnc is opened + line="6208">a #GdaServerProviderConnectionData, which can be extended as needed by the provider for which @cnc is opened @@ -4003,7 +4696,7 @@ Note: @destroy_func, needs to free the memory associated to @data, if necessary. scope="async"> function to call when the connection closes and @data needs to be destroyed + line="6209">function to call when the connection closes and @data needs to be destroyed @@ -4012,7 +4705,7 @@ Note: @destroy_func, needs to free the memory associated to @data, if necessary. c:identifier="gda_connection_internal_statement_executed"> Internal functions to be called by database providers when a statement has been executed + line="5929">Internal functions to be called by database providers when a statement has been executed to keep track of the transaction status of the connection @@ -4022,13 +4715,13 @@ to keep track of the transaction status of the connection a #GdaConnection + line="5931">a #GdaConnection a #GdaStatement which has been executed + line="5932">a #GdaStatement which has been executed allow-none="1"> execution's parameters + line="5933">execution's parameters a #GdaConnectionEvent if the execution failed, or %NULL + line="5934">a #GdaConnectionEvent if the execution failed, or %NULL @@ -4052,7 +4745,7 @@ to keep track of the transaction status of the connection c:identifier="gda_connection_internal_transaction_committed"> Internal functions to be called by database providers when a transaction has been committed + line="5740">Internal functions to be called by database providers when a transaction has been committed to keep track of the transaction status of the connection Note: this function should not be called if gda_connection_internal_statement_executed() @@ -4066,7 +4759,7 @@ the action. a #GdaConnection + line="5742">a #GdaConnection allow-none="1"> transaction's name, or %NULL + line="5743">transaction's name, or %NULL @@ -4084,7 +4777,7 @@ the action. c:identifier="gda_connection_internal_transaction_rolledback"> Internal functions to be called by database providers when a transaction has been rolled + line="5686">Internal functions to be called by database providers when a transaction has been rolled back to keep track of the transaction status of the connection Note: this function should not be called if gda_connection_internal_statement_executed() @@ -4098,7 +4791,7 @@ the action. a #GdaConnection + line="5688">a #GdaConnection allow-none="1"> transaction's name, or %NULL + line="5689">transaction's name, or %NULL @@ -4116,7 +4809,7 @@ the action. c:identifier="gda_connection_internal_transaction_started"> Internal functions to be called by database providers when a transaction has been started + line="5635">Internal functions to be called by database providers when a transaction has been started to keep track of the transaction status of the connection. Note: this function should not be called if gda_connection_internal_statement_executed() @@ -4130,7 +4823,7 @@ the action. a #GdaConnection + line="5637">a #GdaConnection allow-none="1"> name of the parent transaction, or %NULL + line="5638">name of the parent transaction, or %NULL transaction's name, or %NULL + line="5639">transaction's name, or %NULL isolation level. + line="5640">isolation level. @@ -4253,14 +4946,14 @@ gda_connection_set_main_context(), for example when there is a main loop for tha introspectable="0"> This method is similar to gda_server_operation_get_value_at(), but for SQL identifiers: a new string + line="7237">This method is similar to gda_server_operation_get_value_at(), but for SQL identifiers: a new string is returned instead of a #GValue. Also the returned string is assumed to represents an SQL identifier and will correctly be quoted to be used with @cnc. a new string, or %NULL if the value is undefined or + line="7249">a new string, or %NULL if the value is undefined or if the @path is not defined or @path does not hold any value, or if the value held is not a string (in that last case a warning is shown). @@ -4269,19 +4962,19 @@ if the @path is not defined or @path does not hold any value, or if the value he a #GdaConnection + line="7239">a #GdaConnection a #GdaServerOperation object + line="7240">a #GdaServerOperation object a complete path to a node (starting with "/") + line="7241">a complete path to a node (starting with "/") a place to store errors, or %NULL + line="7242">a place to store errors, or %NULL arguments to use with @path_format to make a complete path + line="7243">arguments to use with @path_format to make a complete path @@ -4307,14 +5000,14 @@ if the @path is not defined or @path does not hold any value, or if the value he throws="1"> This method is similar to gda_server_operation_get_value_at(), but for SQL identifiers: a new string + line="7279">This method is similar to gda_server_operation_get_value_at(), but for SQL identifiers: a new string is returned instead of a #GValue. Also the returned string is assumed to represents an SQL identifier and will correctly be quoted to be used with @cnc. a new string, or %NULL if the value is undefined or + line="7290">a new string, or %NULL if the value is undefined or if the @path is not defined or @path does not hold any value, or if the value held is not a string or a valid SQL identifier. @@ -4326,19 +5019,19 @@ a valid SQL identifier. allow-none="1"> a #GdaConnection, or %NULL + line="7282">a #GdaConnection, or %NULL a #GdaServerOperation object + line="7281">a #GdaServerOperation object a complete path to a node (starting with "/") + line="7283">a complete path to a node (starting with "/") @@ -4451,7 +5144,7 @@ be ignored throws="1"> Add more arguments if the flag needs them: + line="7005">Add more arguments if the flag needs them: GDA_SERVER_OPERATION_CREATE_TABLE_FKEY_FLAG: <itemizedlist> @@ -4477,26 +5170,26 @@ in order to execute the operation. a #GdaServerOperation if no errors; NULL and set @error otherwise + line="7036">a #GdaServerOperation if no errors; NULL and set @error otherwise an opened connection + line="7007">an opened connection name of the table to create + line="7008">name of the table to create list of arguments as #GdaServerOperationPrepareCreateTableArg containing column's name, + line="7009">list of arguments as #GdaServerOperationPrepareCreateTableArg containing column's name, column's #GType and a #GdaServerOperationCreateTableFlag flag @@ -4510,39 +5203,39 @@ column's #GType and a #GdaServerOperationCreateTableFlag flag introspectable="0"> Convenient funtion for table creation. + line="6910">Convenient funtion for table creation. For details about arguments see #gda_server_operation_prepare_create_table_v(). a #GdaServerOperation if no errors; NULL and set @error otherwise + line="6922">a #GdaServerOperation if no errors; NULL and set @error otherwise an opened connection + line="6912">an opened connection name of the table to create + line="6913">name of the table to create a place to store errors, or %NULL + line="6914">a place to store errors, or %NULL group of three arguments for column's name, column's #GType + line="6915">group of three arguments for column's name, column's #GType and a #GdaServerOperationCreateTableFlag flag, finished with %NULL @@ -4554,26 +5247,26 @@ and a #GdaServerOperationCreateTableFlag flag, finished with %NULL throws="1"> This is just a convenient function to create a #GdaServerOperation to drop a + line="7195">This is just a convenient function to create a #GdaServerOperation to drop a table in an opened connection. a new #GdaServerOperation or %NULL if couldn't create the opereration. + line="7204">a new #GdaServerOperation or %NULL if couldn't create the opereration. an opened connection + line="7197">an opened connection name of the table to drop + line="7198">name of the table to drop @@ -4626,7 +5319,7 @@ double quote (") character. throws="1"> Executes the statement upon which @rstmt is built. Note that as several statements can actually be executed by this + line="3773">Executes the statement upon which @rstmt is built. Note that as several statements can actually be executed by this method, it is recommended to be within a transaction. If @error is not %NULL and @stop_on_error is %FALSE, then it may contain the last error which occurred. @@ -4634,7 +5327,7 @@ If @error is not %NULL and @stop_on_error is %FALSE, then it may contain the las a new list of #GObject pointers (see gda_connection_statement_execute() for more information about what they + line="3787">a new list of #GObject pointers (see gda_connection_statement_execute() for more information about what they represent), one for each actual execution of the statement upon which @rstmt is built. If @stop_on_error is %FALSE, then the list may contain some %NULL pointers which refer to statements which failed to execute. @@ -4645,19 +5338,19 @@ the list may contain some %NULL pointers which refer to statements which failed a #GdaConnection + line="3775">a #GdaConnection a #GdaRepetitiveStatement object + line="3776">a #GdaRepetitiveStatement object specifies how the returned data model will be used as a #GdaStatementModelUsage enum + line="3777">specifies how the returned data model will be used as a #GdaStatementModelUsage enum an array of GType to request each returned GdaDataModel's column's GType, see gda_connection_statement_execute_select_full() for more information + line="3778">an array of GType to request each returned GdaDataModel's column's GType, see gda_connection_statement_execute_select_full() for more information @@ -4674,7 +5367,7 @@ the list may contain some %NULL pointers which refer to statements which failed set to TRUE if the method has to stop on the first error. + line="3779">set to TRUE if the method has to stop on the first error. @@ -4684,19 +5377,19 @@ the list may contain some %NULL pointers which refer to statements which failed throws="1"> Rollback all the modifications made after the SAVEPOINT named @name. + line="4001">Rollback all the modifications made after the SAVEPOINT named @name. TRUE if no error occurred + line="4009">TRUE if no error occurred a #GdaConnection object + line="4003">a #GdaConnection object name of the savepoint to rollback to + line="4004">name of the savepoint to rollback to @@ -4715,7 +5408,7 @@ the list may contain some %NULL pointers which refer to statements which failed throws="1"> Rollbacks the given transaction. This means that all changes + line="3946">Rollbacks the given transaction. This means that all changes made to the underlying data source since the last call to #gda_connection_begin_transaction() or #gda_connection_commit_transaction() will be discarded. @@ -4723,14 +5416,14 @@ will be discarded. %TRUE if the operation was successful, %FALSE otherwise. + line="3957">%TRUE if the operation was successful, %FALSE otherwise. a #GdaConnection object. + line="3948">a #GdaConnection object. allow-none="1"> the name of the transation to commit, or %NULL + line="3949">the name of the transation to commit, or %NULL @@ -4808,7 +5501,7 @@ while the blocking operation is being performed. throws="1"> Executes @stmt. + line="3386">Executes @stmt. As @stmt can, by design (and if not abused), contain only one SQL statement, the return object will either be: @@ -4869,20 +5562,20 @@ Also see the <link linkend="limitations">provider's limitations</link&g a #GObject, or %NULL if an error occurred + line="3453">a #GObject, or %NULL if an error occurred a #GdaConnection + line="3388">a #GdaConnection a #GdaStatement object + line="3389">a #GdaStatement object a #GdaSet object (which can be obtained using gda_statement_get_parameters()), or %NULL + line="3390">a #GdaSet object (which can be obtained using gda_statement_get_parameters()), or %NULL in the case where @stmt is a SELECT statement, specifies how the returned data model will be used + line="3391">in the case where @stmt is a SELECT statement, specifies how the returned data model will be used a place to store a new #GdaSet object which contains the values of the last inserted row, or %NULL + line="3392">a place to store a new #GdaSet object which contains the values of the last inserted row, or %NULL @@ -4917,7 +5610,7 @@ Also see the <link linkend="limitations">provider's limitations</link&g throws="1"> Executes a non-selection statement on the given connection. + line="3467">Executes a non-selection statement on the given connection. This function returns the number of rows affected by the execution of @stmt, or -1 if an error occurred, or -2 if the connection's provider does not return the number of rows affected. @@ -4932,20 +5625,20 @@ See gda_connection_statement_execute() form more information about @last_insert_ the number of rows affected (&gt;=0) or -1 or -2 + line="3487">the number of rows affected (&gt;=0) or -1 or -2 a #GdaConnection object. + line="3469">a #GdaConnection object. a #GdaStatement object. + line="3470">a #GdaStatement object. a #GdaSet object (which can be obtained using gda_statement_get_parameters()), or %NULL + line="3471">a #GdaSet object (which can be obtained using gda_statement_get_parameters()), or %NULL a place to store a new #GdaSet object which contains the values of the last inserted row, or %NULL + line="3472">a place to store a new #GdaSet object which contains the values of the last inserted row, or %NULL @@ -4974,7 +5667,7 @@ See gda_connection_statement_execute() form more information about @last_insert_ throws="1"> Executes a selection command on the given connection. + line="3537">Executes a selection command on the given connection. This function returns a #GdaDataModel resulting from the SELECT statement, or %NULL if an error occurred. @@ -4988,7 +5681,7 @@ about the @params list of parameters. a #GdaDataModel containing the data returned by the + line="3555">a #GdaDataModel containing the data returned by the data source, or %NULL if an error occurred @@ -4996,13 +5689,13 @@ data source, or %NULL if an error occurred a #GdaConnection object. + line="3539">a #GdaConnection object. a #GdaStatement object. + line="3540">a #GdaStatement object. allow-none="1"> a #GdaSet object (which can be obtained using gda_statement_get_parameters()), or %NULL + line="3541">a #GdaSet object (which can be obtained using gda_statement_get_parameters()), or %NULL @@ -5021,7 +5714,7 @@ data source, or %NULL if an error occurred throws="1"> Executes a selection command on the given connection. + line="3682">Executes a selection command on the given connection. This function returns a #GdaDataModel resulting from the SELECT statement, or %NULL if an error occurred. @@ -5035,7 +5728,7 @@ about the @params list of parameters. a #GdaDataModel containing the data returned by the + line="3704">a #GdaDataModel containing the data returned by the data source, or %NULL if an error occurred @@ -5043,13 +5736,13 @@ data source, or %NULL if an error occurred a #GdaConnection object. + line="3684">a #GdaConnection object. a #GdaStatement object. + line="3685">a #GdaStatement object. allow-none="1"> a #GdaSet object (which can be obtained using gda_statement_get_parameters()), or %NULL + line="3686">a #GdaSet object (which can be obtained using gda_statement_get_parameters()), or %NULL specifies how the returned data model will be used as a #GdaStatementModelUsage enum + line="3687">specifies how the returned data model will be used as a #GdaStatementModelUsage enum allow-none="1"> an array of GType to request each returned #GdaDataModel's column's GType, terminated with the G_TYPE_NONE + line="3688">an array of GType to request each returned #GdaDataModel's column's GType, terminated with the G_TYPE_NONE value. Any value left to 0 will make the database provider determine the real GType. @col_types can also be %NULL if no column type is specified. @@ -5087,7 +5780,7 @@ column type is specified. introspectable="0"> Executes a selection command on the given connection. + line="3581">Executes a selection command on the given connection. This function returns a #GdaDataModel resulting from the SELECT statement, or %NULL if an error occurred. @@ -5101,7 +5794,7 @@ about the @params list of parameters. a #GdaDataModel containing the data returned by the + line="3602">a #GdaDataModel containing the data returned by the data source, or %NULL if an error occurred @@ -5109,13 +5802,13 @@ data source, or %NULL if an error occurred a #GdaConnection object. + line="3583">a #GdaConnection object. a #GdaStatement object. + line="3584">a #GdaStatement object. allow-none="1"> a #GdaSet object (which can be obtained using gda_statement_get_parameters()), or %NULL + line="3585">a #GdaSet object (which can be obtained using gda_statement_get_parameters()), or %NULL specifies how the returned data model will be used as a #GdaStatementModelUsage enum + line="3586">specifies how the returned data model will be used as a #GdaStatementModelUsage enum a place to store an error, or %NULL + line="3587">a place to store an error, or %NULL a (-1 terminated) list of (column number, GType) specifying for each column mentioned the GType + line="3588">a (-1 terminated) list of (column number, GType) specifying for each column mentioned the GType of the column in the returned #GdaDataModel. @@ -5247,25 +5940,25 @@ table name). c:identifier="gda_connection_supports_feature"> Asks the underlying provider for if a specific feature is supported. + line="4073">Asks the underlying provider for if a specific feature is supported. %TRUE if the provider supports it, %FALSE if not. + line="4080">%TRUE if the provider supports it, %FALSE if not. a #GdaConnection object. + line="4075">a #GdaConnection object. feature to ask for. + line="4076">feature to ask for. @@ -5275,7 +5968,7 @@ table name). throws="1"> Updates @cnc's associated #GdaMetaStore. If @context is not %NULL, then only the parts described by + line="5026">Updates @cnc's associated #GdaMetaStore. If @context is not %NULL, then only the parts described by @context will be updated, and if it is %NULL, then the complete meta store will be updated. Detailed explanations follow: @@ -5318,14 +6011,14 @@ the <link linkend="howto-meta2">Update the meta data about a table</lin TRUE if no error occurred + line="5072">TRUE if no error occurred a #GdaConnection object. + line="5028">a #GdaConnection object. description of which part of @cnc's associated #GdaMetaStore should be updated, or %NULL + line="5029">description of which part of @cnc's associated #GdaMetaStore should be updated, or %NULL @@ -5503,25 +6196,25 @@ The equivalent SQL command is: UPDATE &lt;table&gt; SET &lt;column_n c:identifier="gda_connection_value_to_sql_string"> Produces a fully quoted and escaped string from a GValue + line="5614">Produces a fully quoted and escaped string from a GValue escaped and quoted value or NULL if not supported. + line="5621">escaped and quoted value or NULL if not supported. a #GdaConnection object. + line="5616">a #GdaConnection object. #GValue to convert from + line="5617">#GValue to convert from @@ -6451,2388 +7144,2750 @@ a connection's associated #GdaMetaStore. line="248">lists the <link linkend="GdaConnectionMetaTypeGDA_CONNECTION_META_INDEXES">table's indexes</link> - - - - - - - - - - - - - - - - - - - - - - - - - Specifies some aspects of a connection when opening it. - -Additional information about the GDA_CONNECTION_OPTIONS_SQL_IDENTIFIERS_CASE_SENSITIVE flag: -<itemizedlist> - <listitem><para>For example without this flag, if the table - name specified in a #GdaServerOperation to create a table is - <emphasis>MyTable</emphasis>, then usually the database will create a table named - <emphasis>mytable</emphasis>, whereas with this flag, the table will be created - as <emphasis>MyTable</emphasis> (note that in the end the database may still decide - to name the table <emphasis>mytable</emphasis> or differently if it can't do - otherwise).</para></listitem> - <listitem><para>Libgda will not apply this rule when parsing SQL code, the SQL code being parsed - has to be conform to the database it will be used with</para></listitem> -</itemizedlist> - -Note about the @GDA_CONNECTION_OPTIONS_AUTO_META_DATA flag: -<itemizedlist> - <listitem><para>Every time a DDL statement is successfully executed, the associated meta data, if - defined, will be updated, which has a impact on performances</para></listitem> - <listitem><para>If a transaction is started and some DDL statements are executed and the transaction - is not rolled back or committed, then the meta data may end up being wrong</para></listitem> -</itemizedlist> - - - no specific aspect - - - this flag specifies that the connection to open should be in a read-only mode - (this policy is not correctly enforced at the moment) - - - this flag specifies that SQL identifiers submitted as input - to Libgda have to keep their case sensitivity. - - - this flags specifies that if a #GdaMetaStore has been associated - to the connection, then it is kept up to date with the evolutions in the - database's structure. Be aware however that there are some drawbacks - explained below. - - - - Indicates the current status of a connection. The possible status and the transitions between those status -are indicated in the diagram below: - <mediaobject> - <imageobject role="html"> - <imagedata fileref="connection-status.png" format="PNG" contentwidth="50mm"/> - </imageobject> - <textobject> - <phrase>GdaConnection's status and transitions between different status</phrase> - </textobject> - </mediaobject> - - - the connection is closed (default status upon creation) - - - the connection is currently being opened - - - the connection is opened but not currently used - - - the connection is opened and currently being used - - - - - - - Creates a new #GdaDataModel object which buffers the rows of @model. This object is useful -only if @model can only be accessed using cursor based method. - - - a pointer to the newly created #GdaDataModel. - + + + + + + - - a #GdaDataModel - + + + + + - - - @wrapper will report as many columns as @mapping_size, and for each value at position 'i' in @mapping, -@wrapper will report the 'i'th column, mapped to the wrapped data model column at position mapping[i]. -For example if mapping is {3, 4, 0}, then @wrapper will report 3 columns, respectively mapped to the 4th, -5th and 1st columns of the wrapped data model (as column numbers start at 0). - -If @mapping is %NULL, then no mapping is done and @wrapper's columns will be the same as the wrapped -data model. - -If a column in @mapping does not exist in the wrapped data model, then it is simply ignored (no error -reported). - -Please note that if @wrapper has already been used and if the wrapped data model offers a cursor forward -access mode, then this method will return %FALSE and no action will be done. - -If the mapping is applied, then any existing iterator will be invalid, and @wrapper is reset as if it -had just been created. - - - %TRUE if the mapping actually changed - + + + + + - - a #GdaDataAccessWrapper object - + + - - an array of #gint which represents the mapping between @wrapper's columns -and the columns of the wrapped data model - - - + + - - the size of @mapping. - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a new comparator to compute the differences from @old_model to @new_model: if one applies -all the computed differences (as #GdaDiff structures) to @old_model, the resulting data model -should have the same contents as @new_model. - - - a new #GdaDataComparator object - + + + + + - - Data model to which the modifications should be applied - + + + + + - - Target data model. - + + + + + + + + + + + + + + + + - - + + + - + - - - + + + + + + + + - + - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + - - Actually computes the differences between the data models for which @comp is defined. - -For each difference computed, stored in a #GdaDiff structure, the "diff-computed" signal is emitted. -If one connects to this signal and returns FALSE in the signal handler, then computing differences will be -stopped and an error will be returned. - + + + + + + + + + + + + + + + + + + + + + + + + + + + - TRUE if all the differences have been successfully computed, and FALSE if an error occurred - - a #GdaDataComparator object - + + - - - Get a pointer to the #GdaDiff structure representing the difference which number is @pos - + + + - a pointer to a #GdaDiff, or %NULL if @pos is invalid - + - - a #GdaDataComparator object - + + - - the requested difference number (starting at 0) - - - - - Get the number of differences as computed by the last time gda_data_comparator_compute_diff() was called. - + + + - the number of computed differences - + - - a #GdaDataComparator object - + + + + + + + + + + + + + + + + + + + - - Defines the columns which will be used as a key when searching data. This is not mandatory but -will speed things up as less data will be processed. - - - + + + + - - a #GdaDataComparator object - + + - - an array of @nb_cols values - - - + + - - the size of the @col_numbers array - + + - - - - - - - - - - - - + + + + - - + + + + + - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - + + - - + + - - - + + + - + + + + + + - - - + + + + + + + + - - - + + + + + + + + - - - + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - Obtain a pointer to a #GdaDataHandler which can manage #GValue values of type @for_type. The returned -data handler will be adapted to use the current locale information (for example dates will be formatted -taking into account the locale). - -The returned pointer is %NULL if there is no default data handler available for the @for_type data type - + + + + - a #GdaDataHandler which must be destroyed using g_object_unref() - + + + + + + + - - a #GType type + - - Checks wether the GdaDataHandler is able to handle the gda type given as argument. - + + - %TRUE if the gda type can be handled - + - - an object which implements the #GdaDataHandler interface - + + - - a #GType - - - - - Get a short description of the GdaDataHandler - + + + - the description - - an object which implements the #GdaDataHandler interface - + + - - - Creates a new GValue which holds a sane initial value to be used if no value is specifically -provided. For example for a simple string, this would return a new value containing the "" string. - - - the new #GValue, or %NULL if no such value can be created. - + + + + + - - an object which implements the #GdaDataHandler interface - + + - - a #GType - - - - - Creates a new string which is an SQL representation of the given value, the returned string -can be used directly in an SQL statement. For example if @value is a G_TYPE_STRING, then -the returned string will be correctly quoted. Note however that it is a better practice -to use variables in statements instead of value literals, see -the <link linkend="GdaSqlParser.description">GdaSqlParser</link> for more information. - -If the value is NULL or is of type GDA_TYPE_NULL, -or is a G_TYPE_STRING and g_value_get_string() returns %NULL, the returned string is "NULL". - - - the new string, or %NULL if an error occurred - + + + + + - - an object which implements the #GdaDataHandler interface - + + - - the value to be converted to a string, or %NULL - + + - - - Creates a new string which is a "user friendly" representation of the given value -(in the user's locale, specially for the dates). If the value is -NULL or is of type GDA_TYPE_NULL, the returned string is a copy of "" (empty string). - -Note: the returned value will be in the current locale representation. - - - the new string, or %NULL if an error occurred - + + + + + - - an object which implements the #GdaDataHandler interface - + + - - the value to be converted to a string, or %NULL - + + - - - Creates a new GValue which represents the SQL value given as argument. This is -the opposite of the function gda_data_handler_get_sql_from_value(). The type argument -is used to determine the real data type requested for the returned value. - -If the @sql string is %NULL, then the returned GValue is of type GDA_TYPE_NULL; -if the @sql string does not correspond to a valid SQL string for the requested type, then -the %NULL is returned. - - - the new #GValue or %NULL on error - + + + + + - - an object which implements the #GdaDataHandler interface - + + - - an SQL string, or %NULL + - - a GType - - - - - Creates a new GValue which represents the @str value given as argument. This is -the opposite of the function gda_data_handler_get_str_from_value(). The type argument -is used to determine the real data type requested for the returned value. - -If the @str string is %NULL, then the returned GValue is of type GDA_TYPE_NULL; -if the @str string does not correspond to a valid string for the requested type, then -%NULL is returned. - -Note: the @str string must be in the current locale representation - - - the new #GValue or %NULL on error - - - - - an object which implements the #GdaDataHandler interface - - - - a string or %NULL + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies some aspects of a connection when opening it. + +Additional information about the GDA_CONNECTION_OPTIONS_SQL_IDENTIFIERS_CASE_SENSITIVE flag: +<itemizedlist> + <listitem><para>For example without this flag, if the table + name specified in a #GdaServerOperation to create a table is + <emphasis>MyTable</emphasis>, then usually the database will create a table named + <emphasis>mytable</emphasis>, whereas with this flag, the table will be created + as <emphasis>MyTable</emphasis> (note that in the end the database may still decide + to name the table <emphasis>mytable</emphasis> or differently if it can't do + otherwise).</para></listitem> + <listitem><para>Libgda will not apply this rule when parsing SQL code, the SQL code being parsed + has to be conform to the database it will be used with</para></listitem> +</itemizedlist> + +Note about the @GDA_CONNECTION_OPTIONS_AUTO_META_DATA flag: +<itemizedlist> + <listitem><para>Every time a DDL statement is successfully executed, the associated meta data, if + defined, will be updated, which has a impact on performances</para></listitem> + <listitem><para>If a transaction is started and some DDL statements are executed and the transaction + is not rolled back or committed, then the meta data may end up being wrong</para></listitem> +</itemizedlist> + + + no specific aspect + + + this flag specifies that the connection to open should be in a read-only mode + (this policy is not correctly enforced at the moment) + + + this flag specifies that SQL identifiers submitted as input + to Libgda have to keep their case sensitivity. + + + this flags specifies that if a #GdaMetaStore has been associated + to the connection, then it is kept up to date with the evolutions in the + database's structure. Be aware however that there are some drawbacks + explained below. + + + + Indicates the current status of a connection. The possible status and the transitions between those status +are indicated in the diagram below: + <mediaobject> + <imageobject role="html"> + <imagedata fileref="connection-status.png" format="PNG" contentwidth="50mm"/> + </imageobject> + <textobject> + <phrase>GdaConnection's status and transitions between different status</phrase> + </textobject> + </mediaobject> + + + the connection is closed (default status upon creation) + + + the connection is currently being opened + + + the connection is opened but not currently used + + + the connection is opened and currently being used + + + + + + + + + + + + + + + + + + + + + + + + + + - - a GType - - - - Checks wether the GdaDataHandler is able to handle the gda type given as argument. - + + - %TRUE if the gda type can be handled - + - - an object which implements the #GdaDataHandler interface - + + - - a #GType - + + + + + + + + + + + + + - - Get a short description of the GdaDataHandler - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - the description - - an object which implements the #GdaDataHandler interface - + + - - - Creates a new GValue which holds a sane initial value to be used if no value is specifically -provided. For example for a simple string, this would return a new value containing the "" string. - - - the new #GValue, or %NULL if no such value can be created. - + + + + + - - an object which implements the #GdaDataHandler interface - + + - - a #GType - + + - - - Creates a new string which is an SQL representation of the given value, the returned string -can be used directly in an SQL statement. For example if @value is a G_TYPE_STRING, then -the returned string will be correctly quoted. Note however that it is a better practice -to use variables in statements instead of value literals, see -the <link linkend="GdaSqlParser.description">GdaSqlParser</link> for more information. - -If the value is NULL or is of type GDA_TYPE_NULL, -or is a G_TYPE_STRING and g_value_get_string() returns %NULL, the returned string is "NULL". - - - the new string, or %NULL if an error occurred - + + + + + - - an object which implements the #GdaDataHandler interface - + + - - the value to be converted to a string, or %NULL - + + - - - Creates a new string which is a "user friendly" representation of the given value -(in the user's locale, specially for the dates). If the value is -NULL or is of type GDA_TYPE_NULL, the returned string is a copy of "" (empty string). - -Note: the returned value will be in the current locale representation. - - - the new string, or %NULL if an error occurred - + + + + + - - an object which implements the #GdaDataHandler interface - + + - - the value to be converted to a string, or %NULL - + + + + + + + + + + + + + - - Creates a new GValue which represents the SQL value given as argument. This is -the opposite of the function gda_data_handler_get_sql_from_value(). The type argument -is used to determine the real data type requested for the returned value. - -If the @sql string is %NULL, then the returned GValue is of type GDA_TYPE_NULL; -if the @sql string does not correspond to a valid SQL string for the requested type, then -the %NULL is returned. - - - the new #GValue or %NULL on error - + + + + - - an object which implements the #GdaDataHandler interface - + + - - an SQL string, or %NULL - + + + + + + + + + + + + + + + + + + + + + + + + - - a GType - + + + + + + + + + + + + + - - Creates a new GValue which represents the @str value given as argument. This is -the opposite of the function gda_data_handler_get_str_from_value(). The type argument -is used to determine the real data type requested for the returned value. - -If the @str string is %NULL, then the returned GValue is of type GDA_TYPE_NULL; -if the @str string does not correspond to a valid string for the requested type, then -%NULL is returned. - -Note: the @str string must be in the current locale representation - - - the new #GValue or %NULL on error - + + + + - - an object which implements the #GdaDataHandler interface - + + - - a string or %NULL + - - a GType - - + + + + + + + + + - - - + + + - - - - - the new string, or %NULL if an error occurred - - - - - an object which implements the #GdaDataHandler interface - - - - the value to be converted to a string, or %NULL - - - - - - - - - - the new string, or %NULL if an error occurred - + + + + + - - an object which implements the #GdaDataHandler interface - - - - the value to be converted to a string, or %NULL - + + - - - - - the new #GValue or %NULL on error - + + + + + - - an object which implements the #GdaDataHandler interface - + + - - an SQL string, or %NULL + - - a GType - - - - - - - the new #GValue or %NULL on error - + + + + + - - an object which implements the #GdaDataHandler interface - - - - a string or %NULL - - - - a GType - + + - - - - - the new #GValue, or %NULL if no such value can be created. - + + + + + - - an object which implements the #GdaDataHandler interface - + + - - a #GType - + + - - - - - %TRUE if the gda type can be handled - + + + + + - - an object which implements the #GdaDataHandler interface - - - - a #GType - + + - - - + + + - the description - + - - an object which implements the #GdaDataHandler interface - + + + + + - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new #GdaDataModel object which buffers the rows of @model. This object is useful +only if @model can only be accessed using cursor based method. + + + a pointer to the newly created #GdaDataModel. + + + + a #GdaDataModel + + + - + Adds the data from an XML node to the given data model (see the DTD for that node -in the $prefix/share/libgda/dtd/libgda-array.dtd file). + filename="libgda/gda-data-access-wrapper.c" + line="389">@wrapper will report as many columns as @mapping_size, and for each value at position 'i' in @mapping, +@wrapper will report the 'i'th column, mapped to the wrapped data model column at position mapping[i]. +For example if mapping is {3, 4, 0}, then @wrapper will report 3 columns, respectively mapped to the 4th, +5th and 1st columns of the wrapped data model (as column numbers start at 0). -Upon errors FALSE will be returned and @error will be assigned a -#GError from the #GDA_DATA_MODEL_ERROR domain. - +If @mapping is %NULL, then no mapping is done and @wrapper's columns will be the same as the wrapped +data model. + +If a column in @mapping does not exist in the wrapped data model, then it is simply ignored (no error +reported). + +Please note that if @wrapper has already been used and if the wrapped data model offers a cursor forward +access mode, then this method will return %FALSE and no action will be done. + +If the mapping is applied, then any existing iterator will be invalid, and @wrapper is reset as if it +had just been created. + %TRUE if successful, %FALSE otherwise. + filename="libgda/gda-data-access-wrapper.c" + line="413">%TRUE if the mapping actually changed - + a #GdaDataModel. - + filename="libgda/gda-data-access-wrapper.c" + line="391">a #GdaDataAccessWrapper object + - + an XML node representing a &lt;gda_array_data&gt; XML node. - + filename="libgda/gda-data-access-wrapper.c" + line="392">an array of #gint which represents the mapping between @wrapper's columns +and the columns of the wrapped data model + + + + + + the size of @mapping. + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Appends a row to the data model (the new row will possibly have NULL values for all columns, -or some other values depending on the data model implementation) - -Upon errors -1 will be returned and @error will be assigned a -#GError from the #GDA_DATA_MODEL_ERROR domain. - - + filename="libgda/gda-data-comparator.c" + line="147">Creates a new comparator to compute the differences from @old_model to @new_model: if one applies +all the computed differences (as #GdaDiff structures) to @old_model, the resulting data model +should have the same contents as @new_model. + + the number of the added row, or -1 if an error occurred - + filename="libgda/gda-data-comparator.c" + line="156">a new #GdaDataComparator object + - + a #GdaDataModel object. + filename="libgda/gda-data-comparator.c" + line="149">Data model to which the modifications should be applied - + + + Target data model. + + - - - Appends a row to the given data model. If any value in @values is actually %NULL, then -it is considered as a default value. If @values is %NULL then all values are set to their default value. - -Upon errors -1 will be returned and @error will be assigned a -#GError from the #GDA_DATA_MODEL_ERROR domain. - + + - the number of the added row, or -1 if an error occurred - + + + + + + + - - a #GdaDataModel object. - + + - - #GList of #GValue* representing the row to add. The - length must match model's column count. These #GValue - are value-copied (the user is still responsible for freeing them). - - - + + - - + Makes a copy of @src into a new #GdaDataModelArray object - - + filename="libgda/gda-data-comparator.c" + line="374">Actually computes the differences between the data models for which @comp is defined. + +For each difference computed, stored in a #GdaDiff structure, the "diff-computed" signal is emitted. +If one connects to this signal and returns FALSE in the signal handler, then computing differences will be +stopped and an error will be returned. + + a new data model, or %NULL if an error occurred - + filename="libgda/gda-data-comparator.c" + line="385">TRUE if all the differences have been successfully computed, and FALSE if an error occurred + - + a #GdaDataModel to copy data from - + filename="libgda/gda-data-comparator.c" + line="376">a #GdaDataComparator object + - + Like gda_data_model_array_copy_model(), makes a copy of @src, but copies only some -columns. - - + filename="libgda/gda-data-comparator.c" + line="599">Get a pointer to the #GdaDiff structure representing the difference which number is @pos + + a new data model, or %NULL if an error occurred - + filename="libgda/gda-data-comparator.c" + line="606">a pointer to a #GdaDiff, or %NULL if @pos is invalid + - + a #GdaDataModel to copy data from - + filename="libgda/gda-data-comparator.c" + line="601">a #GdaDataComparator object + - + size of @cols + filename="libgda/gda-data-comparator.c" + line="602">the requested difference number (starting at 0) - - array of @src's columns to copy into the new array, not %NULL - - - - - + Creates a new iterator object #GdaDataModelIter object which can be used to iterate through -rows in @model. The new #GdaDataModelIter does not hold any reference to @model (ie. if @model -is destroyed at some point, the new iterator will become useless but in any case it will not prevent -the data model from being destroyed). - -Depending on the data model's implementation, a new #GdaDataModelIter object may be created, -or a reference to an already existing #GdaDataModelIter may be returned. For example if @model only -supports being accessed using a forward moving cursor (say a the result of a SELECT executed by SQLite -with a cursor access mode specified), then this method will always return the same iterator. - -If a new #GdaDataModelIter is created, then the row it represents is undefined. - -For models which can be accessed -randomly, any row can be set using gda_data_model_iter_move_to_row(), -and for models which are accessible sequentially only then use -gda_data_model_iter_move_next() (and gda_data_model_iter_move_prev() if -supported). - -Note: for the #GdaDataProxy data model (which proxies any #GdaDataModel for modifications and -has twice the number of columns of the proxied data model), this method will create an iterator -in which only the columns of the proxied data model appear. If you need to have a #GdaDataModelIter -in which all the proxy's columns appear, create it using: -<programlisting><![CDATA[iter = g_object_new (GDA_TYPE_DATA_MODEL_ITER, "data-model", proxy, NULL);]]></programlisting> - - + filename="libgda/gda-data-comparator.c" + line="582">Get the number of differences as computed by the last time gda_data_comparator_compute_diff() was called. + + a #GdaDataModelIter object, or %NULL if an error occurred - + filename="libgda/gda-data-comparator.c" + line="588">the number of computed differences + - + a #GdaDataModel object. - + filename="libgda/gda-data-comparator.c" + line="584">a #GdaDataComparator object + - + Queries the underlying data model implementation for a description -of a given column. That description is returned in the form of -a #GdaColumn structure, which contains all the information -about the given column in the data model. - -WARNING: the returned #GdaColumn object belongs to the @model model and -and should not be destroyed; any modification will affect the whole data model. - - - the description of the column. - + filename="libgda/gda-data-comparator.c" + line="289">Defines the columns which will be used as a key when searching data. This is not mandatory but +will speed things up as less data will be processed. + + + - + a #GdaDataModel object. - + filename="libgda/gda-data-comparator.c" + line="291">a #GdaDataComparator object + - + column number. + filename="libgda/gda-data-comparator.c" + line="293">an array of @nb_cols values + + + + + + the size of the @col_numbers array - - Dumps a textual representation of the @model to the @to_stream stream - -The following environment variables can affect the resulting output: -<itemizedlist> - <listitem><para>GDA_DATA_MODEL_DUMP_ROW_NUMBERS: if set, the first column of the output will contain row numbers</para></listitem> - <listitem><para>GDA_DATA_MODEL_DUMP_ATTRIBUTES: if set, also dump the data model's columns' types and value's attributes</para></listitem> - <listitem><para>GDA_DATA_MODEL_DUMP_TITLE: if set, also dump the data model's title</para></listitem> - <listitem><para>GDA_DATA_MODEL_NULL_AS_EMPTY: if set, replace the 'NULL' string with an empty string for NULL values </para></listitem> - <listitem><para>GDA_DATA_MODEL_DUMP_TRUNCATE: if set to a numeric value, truncates the output to the width specified by the value. If the value is -1 then the actual terminal size (if it can be determined) is used</para></listitem> -</itemizedlist> - + + + + + + + + + + - + - - a #GdaDataModel. - - - - where to dump the data model - + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Dumps a textual representation of the @model into a new string. The main differences with gda_data_model_export_to_string() are that -the formatting options are passed using environment variables, and that the data is dumped regardless of the user locale (e.g. dates -are not formatted according to the locale). + filename="libgda/gda-data-handler.c" + line="245">Obtain a pointer to a #GdaDataHandler which can manage #GValue values of type @for_type. The returned +data handler will be adapted to use the current locale information (for example dates will be formatted +taking into account the locale). -The following environment variables can affect the resulting output: -<itemizedlist> - <listitem><para>GDA_DATA_MODEL_DUMP_ROW_NUMBERS: if set, the first column of the output will contain row numbers</para></listitem> - <listitem><para>GDA_DATA_MODEL_DUMP_TITLE: if set, also dump the data model's title</para></listitem> - <listitem><para>GDA_DATA_MODEL_NULL_AS_EMPTY: if set, replace the 'NULL' string with an empty string for NULL values </para></listitem> - <listitem><para>GDA_DATA_MODEL_DUMP_TRUNCATE: if set to a numeric value, truncates the output to the width specified by the value. If the value is -1 then the actual terminal size (if it can be determined) is used</para></listitem> -</itemizedlist> - +The returned pointer is %NULL if there is no default data handler available for the @for_type data type + a new string. - + filename="libgda/gda-data-handler.c" + line="255">a #GdaDataHandler which must be destroyed using g_object_unref() + - + a #GdaDataModel. - - + filename="libgda/gda-data-handler.c" + line="247">a #GType type + + - - + + Exports data contained in @model to the @file file; the format is specified using the @format argument. Note that -the date format used is the one used by the connection from which the data model has been made (as the result of a -SELECT statement), or, for other kinds of data models, the default format (refer to gda_data_handler_get_default()) unless -the "cnc" property has been set and points to a #GdaConnection to use that connection's date format. - -Specifically, the parameters in the @options list can be: -<itemizedlist> - <listitem><para>"SEPARATOR": a string value of which the first character is used as a separator in case of CSV export - </para></listitem> - <listitem><para>"QUOTE": a string value of which the first character is used as a quote character in case of CSV export. The - default if not specified is the double quote character</para></listitem> - <listitem><para>"FIELD_QUOTE": a boolean value which can be set to FALSE if no quote around the individual fields - is requeted, in case of CSV export</para></listitem> - <listitem><para>"NAMES_ON_FIRST_LINE": a boolean value which, if set to %TRUE and in case of a CSV or %GDA_DATA_MODEL_IO_TEXT_TABLE export, will add a first line with the name each exported field (note that "FIELDS_NAME" is also accepted as a synonym)</para></listitem> - <listitem><para>"NAME": a string value used to name the exported data if the export format is XML or %GDA_DATA_MODEL_IO_TEXT_TABLE</para></listitem> - <listitem><para>"OVERWRITE": a boolean value which tells if the file must be over-written if it already exists.</para></listitem> - <listitem><para>"NULL_AS_EMPTY": a boolean value which, if set to %TRUE and in case of a CSV or %GDA_DATA_MODEL_IO_TEXT_TABLE export, will render and NULL value as the empty string (instead of the 'NULL' string)</para></listitem> - <listitem><para>"INVALID_AS_NULL": a boolean value which, if set to %TRUE, considers any invalid data (for example for the date related values) as NULL</para></listitem> - <listitem><para>"COLUMN_SEPARATORS": a boolean value which, if set to %TRUE, adds a separators lines between each column, if the export format is %GDA_DATA_MODEL_IO_TEXT_TABLE - </para></listitem> - <listitem><para>"SEPARATOR_LINE": a boolean value which, if set to %TRUE, adds an horizontal line between column titles and values, if the export format is %GDA_DATA_MODEL_IO_TEXT_TABLE - </para></listitem> - <listitem><para>"ROW_NUMBERS": a boolean value which, if set to %TRUE, prepends a column with row numbers, if the export format is %GDA_DATA_MODEL_IO_TEXT_TABLE - </para></listitem> - <listitem><para>"MAX_WIDTH": an integer value which, if greater than 0, makes all the lines truncated to have at most that number of characters, if the export format is %GDA_DATA_MODEL_IO_TEXT_TABLE - </para></listitem> -</itemizedlist> - -Warning: this function uses a #GdaDataModelIter iterator, and if @model does not offer a random access -(check using gda_data_model_get_access_flags()), the iterator will be the same as normally used -to access data in @model previously to calling this method, and this iterator will be moved (point to -another row). - -Upon errors %FALSE will be returned and @error will be assigned a -#GError from the #GDA_DATA_MODEL_ERROR domain. - + filename="libgda/gda-data-handler.c" + line="207">Checks wether the GdaDataHandler is able to handle the gda type given as argument. + TRUE if no error occurred + filename="libgda/gda-data-handler.c" + line="214">%TRUE if the gda type can be handled - + a #GdaDataModel - + filename="libgda/gda-data-handler.c" + line="209">an object which implements the #GdaDataHandler interface + - + the format in which to export data - + filename="libgda/gda-data-handler.c" + line="210">a #GType + - + + + + Get a short description of the GdaDataHandler + + + the description + + + + the filename to export to - + filename="libgda/gda-data-handler.c" + line="228">an object which implements the #GdaDataHandler interface + + + + + + Creates a new GValue which holds a sane initial value to be used if no value is specifically +provided. For example for a simple string, this would return a new value containing the "" string. + + + the new #GValue, or %NULL if no such value can be created. + + + + + an object which implements the #GdaDataHandler interface + + + + a #GType + - + + + Creates a new string which is an SQL representation of the given value, the returned string +can be used directly in an SQL statement. For example if @value is a G_TYPE_STRING, then +the returned string will be correctly quoted. Note however that it is a better practice +to use variables in statements instead of value literals, see +the <link linkend="GdaSqlParser.description">GdaSqlParser</link> for more information. + +If the value is NULL or is of type GDA_TYPE_NULL, +or is a G_TYPE_STRING and g_value_get_string() returns %NULL, the returned string is "NULL". + + + the new string, or %NULL if an error occurred + + + + + an object which implements the #GdaDataHandler interface + + + an array containing which columns of @model will be exported, or %NULL for all columns - - - + filename="libgda/gda-data-handler.c" + line="58">the value to be converted to a string, or %NULL + - + + + + Creates a new string which is a "user friendly" representation of the given value +(in the user's locale, specially for the dates). If the value is +NULL or is of type GDA_TYPE_NULL, the returned string is a copy of "" (empty string). + +Note: the returned value will be in the current locale representation. + + + the new string, or %NULL if an error occurred + + + + the number of columns in @cols - - - an object which implements the #GdaDataHandler interface + + + an array containing which rows of @model will be exported, or %NULL for all rows - - - - - - the number of rows in @rows - - - - list of options for the export - + filename="libgda/gda-data-handler.c" + line="86">the value to be converted to a string, or %NULL + - - + + Exports data contained in @model to a string; the format is specified using the @format argument, see the -gda_data_model_export_to_file() documentation for more information about the @options argument (except for the -"OVERWRITE" option). - -Warning: this function uses a #GdaDataModelIter iterator, and if @model does not offer a random access -(check using gda_data_model_get_access_flags()), the iterator will be the same as normally used -to access data in @model previously to calling this method, and this iterator will be moved (point to -another row). + filename="libgda/gda-data-handler.c" + line="113">Creates a new GValue which represents the SQL value given as argument. This is +the opposite of the function gda_data_handler_get_sql_from_value(). The type argument +is used to determine the real data type requested for the returned value. -See also gda_data_model_dump_as_string(); - +If the @sql string is %NULL, then the returned GValue is of type GDA_TYPE_NULL; +if the @sql string does not correspond to a valid SQL string for the requested type, then +the %NULL is returned. + a new string, use g_free() when no longer needed - + filename="libgda/gda-data-handler.c" + line="127">the new #GValue or %NULL on error + - + a #GdaDataModel - + filename="libgda/gda-data-handler.c" + line="115">an object which implements the #GdaDataHandler interface + - - the format in which to export data - - - an array containing which columns of @model will be exported, or %NULL for all columns - - - + filename="libgda/gda-data-handler.c" + line="116">an SQL string, or %NULL + - - the number of columns in @cols - - - - an array containing which rows of @model will be exported, or %NULL for all rows - - - - - - the number of rows in @rows - - - + list of options for the export - + filename="libgda/gda-data-handler.c" + line="117">a GType + - - - Disables notifications of changes on the given data model. To -re-enable notifications again, you should call the -#gda_data_model_thaw function. - - - - - - - a #GdaDataModel object. - - - - - - Get the attributes of @model such as how to access the data it contains if it's modifiable, etc. - - - an ORed value of #GdaDataModelAccessFlags flags - - - - - a #GdaDataModel object. - - - - - + + Get the attributes of the value stored at (row, col) in @model, which -is an ORed value of #GdaValueAttribute flags. As a special case, if -@row is -1, then the attributes returned correspond to a "would be" value -if a row was added to @model. - - + filename="libgda/gda-data-handler.c" + line="145">Creates a new GValue which represents the @str value given as argument. This is +the opposite of the function gda_data_handler_get_str_from_value(). The type argument +is used to determine the real data type requested for the returned value. + +If the @str string is %NULL, then the returned GValue is of type GDA_TYPE_NULL; +if the @str string does not correspond to a valid string for the requested type, then +%NULL is returned. + +Note: the @str string must be in the current locale representation + + the attributes as an ORed value of #GdaValueAttribute - + filename="libgda/gda-data-handler.c" + line="161">the new #GValue or %NULL on error + - + a #GdaDataModel object - + filename="libgda/gda-data-handler.c" + line="147">an object which implements the #GdaDataHandler interface + - + a valid column number - + filename="libgda/gda-data-handler.c" + line="148">a string or %NULL + - + a valid row number, or -1 - + filename="libgda/gda-data-handler.c" + line="149">a GType + - - + + Get the index of the first column named @name in @model. - + filename="libgda/gda-data-handler.c" + line="207">Checks wether the GdaDataHandler is able to handle the gda type given as argument. + the column index, or -1 if no column named @name was found - + filename="libgda/gda-data-handler.c" + line="214">%TRUE if the gda type can be handled + - + a #GdaDataModel object. - + filename="libgda/gda-data-handler.c" + line="209">an object which implements the #GdaDataHandler interface + - + a column name - + filename="libgda/gda-data-handler.c" + line="210">a #GType + - - + + Get a short description of the GdaDataHandler + the name for the given column in a data model object. + filename="libgda/gda-data-handler.c" + line="232">the description - + a #GdaDataModel object. - + filename="libgda/gda-data-handler.c" + line="228">an object which implements the #GdaDataHandler interface + - - column number. - - - - - + + Creates a new GValue which holds a sane initial value to be used if no value is specifically +provided. For example for a simple string, this would return a new value containing the "" string. + + the title for the given column in a data model object. - + filename="libgda/gda-data-handler.c" + line="193">the new #GValue, or %NULL if no such value can be created. + - + a #GdaDataModel object. - + filename="libgda/gda-data-handler.c" + line="187">an object which implements the #GdaDataHandler interface + - + column number. - + filename="libgda/gda-data-handler.c" + line="188">a #GType + - + Get the global data model exception(s) that occurred when using @model. -This is useful for example for the LDAP related -data models where some rows may be missing because the LDAP search has reached a limit -imposed by the LDAP server. - - - a pointer to a %NULL terminated array of #GError, or %NULL. - - - - - - - a #GdaDataModel - - - - - - - - the number of columns in the given data model, or -1 if unknown. - - - - - a #GdaDataModel object. - - - - - - - + filename="libgda/gda-data-handler.c" + line="55">Creates a new string which is an SQL representation of the given value, the returned string +can be used directly in an SQL statement. For example if @value is a G_TYPE_STRING, then +the returned string will be correctly quoted. Note however that it is a better practice +to use variables in statements instead of value literals, see +the <link linkend="GdaSqlParser.description">GdaSqlParser</link> for more information. + +If the value is NULL or is of type GDA_TYPE_NULL, +or is a G_TYPE_STRING and g_value_get_string() returns %NULL, the returned string is "NULL". + + the number of rows in the given data model, or -1 if the number of rows is not known - + filename="libgda/gda-data-handler.c" + line="69">the new string, or %NULL if an error occurred + - + a #GdaDataModel object. - + filename="libgda/gda-data-handler.c" + line="57">an object which implements the #GdaDataHandler interface + - - - - Returns the status of notifications changes on the given data model. - - - - - - + a #GdaDataModel object. - - + filename="libgda/gda-data-handler.c" + line="58">the value to be converted to a string, or %NULL + + - + Returns the first row where all the values in @values at the columns identified at -@cols_index match. If the row can't be identified, then returns -1; + filename="libgda/gda-data-handler.c" + line="83">Creates a new string which is a "user friendly" representation of the given value +(in the user's locale, specially for the dates). If the value is +NULL or is of type GDA_TYPE_NULL, the returned string is a copy of "" (empty string). -NOTE: the @cols_index array MUST contain a column index for each value in @values - - +Note: the returned value will be in the current locale representation. + + the requested row number, of -1 if not found - + filename="libgda/gda-data-handler.c" + line="94">the new string, or %NULL if an error occurred + - + a #GdaDataModel object. - + filename="libgda/gda-data-handler.c" + line="85">an object which implements the #GdaDataHandler interface + - - a list of #GValue values (no %NULL is allowed) - - - - - + an array of #gint containing the column number to match each value of @values - - - + filename="libgda/gda-data-handler.c" + line="86">the value to be converted to a string, or %NULL + - + Upon errors %NULL will be returned and @error will be assigned a -#GError from the #GDA_DATA_MODEL_ERROR domain. - -This method is similar to gda_data_model_get_value_at(), except that it also allows one to specify the expected -#GType of the value to get: if the data model returned a #GValue of a type different than the expected one, then -this method returns %NULL and an error code. - -Note: the same limitations and usage instructions apply as for gda_data_model_get_value_at(). + filename="libgda/gda-data-handler.c" + line="113">Creates a new GValue which represents the SQL value given as argument. This is +the opposite of the function gda_data_handler_get_sql_from_value(). The type argument +is used to determine the real data type requested for the returned value. -Upon errors %NULL will be returned and @error will be assigned a -#GError from the #GDA_DATA_MODEL_ERROR domain. - - +If the @sql string is %NULL, then the returned GValue is of type GDA_TYPE_NULL; +if the @sql string does not correspond to a valid SQL string for the requested type, then +the %NULL is returned. + + a #GValue containing the value stored in the given -position, or %NULL on error (out-of-bound position, wrong data type, etc). - + filename="libgda/gda-data-handler.c" + line="127">the new #GValue or %NULL on error + - + a #GdaDataModel object. - + filename="libgda/gda-data-handler.c" + line="115">an object which implements the #GdaDataHandler interface + - - a valid column number. - - - + a valid row number. - + filename="libgda/gda-data-handler.c" + line="116">an SQL string, or %NULL + - + the expected data type of the returned value + filename="libgda/gda-data-handler.c" + line="117">a GType - - if TRUE, then NULL values (value of type %GDA_TYPE_NULL) will not generate any error - - - + Retrieves the data stored in the given position (identified by -the @col and @row parameters) on a data model. - -Upon errors %NULL will be returned and @error will be assigned a -#GError from the #GDA_DATA_MODEL_ERROR domain. - -This is the main function for accessing data in a model which allows random access to its data. -To access data in a data model using a cursor, use a #GdaDataModelIter object, obtained using -gda_data_model_create_iter(). - -Note1: the returned #GValue must not be modified directly (unexpected behaviours may -occur if you do so). - -Note2: the returned value may become invalid as soon as any Libgda part is executed again, -which means if you want to keep the value, a copy must be made, however it will remain valid -as long as the only Libgda usage is calling gda_data_model_get_value_at() for different values -of the same row. + filename="libgda/gda-data-handler.c" + line="145">Creates a new GValue which represents the @str value given as argument. This is +the opposite of the function gda_data_handler_get_str_from_value(). The type argument +is used to determine the real data type requested for the returned value. -If you want to modify a value stored in a #GdaDataModel, use the gda_data_model_set_value_at() or -gda_data_model_set_values() methods. +If the @str string is %NULL, then the returned GValue is of type GDA_TYPE_NULL; +if the @str string does not correspond to a valid string for the requested type, then +%NULL is returned. -Upon errors %NULL will be returned and @error will be assigned a -#GError from the #GDA_DATA_MODEL_ERROR domain. - - +Note: the @str string must be in the current locale representation + + a #GValue containing the value stored in the given -position, or %NULL on error (out-of-bound position, etc). - + filename="libgda/gda-data-handler.c" + line="161">the new #GValue or %NULL on error + - + a #GdaDataModel object. - + filename="libgda/gda-data-handler.c" + line="147">an object which implements the #GdaDataHandler interface + - + a valid column number. - + filename="libgda/gda-data-handler.c" + line="148">a string or %NULL + - + a valid row number. - + filename="libgda/gda-data-handler.c" + line="149">a GType + - + + + + + + + + + + the new string, or %NULL if an error occurred + + + + + an object which implements the #GdaDataHandler interface + + + + the value to be converted to a string, or %NULL + + + + + + + + + + the new string, or %NULL if an error occurred + + + + + an object which implements the #GdaDataHandler interface + + + + the value to be converted to a string, or %NULL + + + + + + + + + + the new #GValue or %NULL on error + + + + + an object which implements the #GdaDataHandler interface + + + + an SQL string, or %NULL + + + + a GType + + + + + + + + + + the new #GValue or %NULL on error + + + + + an object which implements the #GdaDataHandler interface + + + + a string or %NULL + + + + a GType + + + + + + + + + + the new #GValue, or %NULL if no such value can be created. + + + + + an object which implements the #GdaDataHandler interface + + + + a #GType + + + + + + + + + + %TRUE if the gda type can be handled + + + + + an object which implements the #GdaDataHandler interface + + + + a #GType + + + + + + + + + + the description + + + + + an object which implements the #GdaDataHandler interface + + + + + + + + + + + + + + Imports data contained in the @file file into @model; the format is detected. + line="1856">Adds the data from an XML node to the given data model (see the DTD for that node +in the $prefix/share/libgda/dtd/libgda-array.dtd file). Upon errors FALSE will be returned and @error will be assigned a #GError from the #GDA_DATA_MODEL_ERROR domain. - + TRUE if no error occurred + line="1868">%TRUE if successful, %FALSE otherwise. a #GdaDataModel + line="1858">a #GdaDataModel. - - the filename to import from - - - - a #GHashTable for columns translating, or %NULL, see gda_data_model_import_from_model() - - - - - - + list of options for the export - + line="1859">an XML node representing a &lt;gda_array_data&gt; XML node. + - Copy the contents of the @from data model to the @to data model. The copy stops as soon as an error -orrurs. - -The @cols_trans is a hash table for which keys are @to columns numbers and the values are -the corresponding column numbers in the @from data model. To set the values of a column in @to to NULL, -create an entry in the hash table with a negative value. For example: -<programlisting><![CDATA[GHashTable *hash; -gint *ptr; -hash = g_hash_table_new_full (g_int_hash, g_int_equal, g_free, NULL); -ptr = g_new (gint, 1); -*ptr = 2; -g_hash_table_insert (hash, ptr, GINT_TO_POINTER (3)); -gda_data_model_import_from_model (...); -g_hash_table_free (hash); -]]></programlisting> + line="890">Appends a row to the data model (the new row will possibly have NULL values for all columns, +or some other values depending on the data model implementation) -Upon errors FALSE will be returned and @error will be assigned a +Upon errors -1 will be returned and @error will be assigned a #GError from the #GDA_DATA_MODEL_ERROR domain. - + TRUE if no error occurred. - + line="901">the number of the added row, or -1 if an error occurred + - + the destination #GdaDataModel + line="892">a #GdaDataModel object. - - the source #GdaDataModel - - - - TRUE if @to is completely overwritten by @from's data, and FALSE if @from's data is appended to @to - - - - a #GHashTable for columns translating, or %NULL - - - - - - Loads the data from @string into @model. + line="859">Appends a row to the given data model. If any value in @values is actually %NULL, then +it is considered as a default value. If @values is %NULL then all values are set to their default value. -Upon errors FALSE will be returned and @error will be assigned a +Upon errors -1 will be returned and @error will be assigned a #GError from the #GDA_DATA_MODEL_ERROR domain. - + TRUE if no error occurred. - + line="873">the number of the added row, or -1 if an error occurred + a #GdaDataModel + line="861">a #GdaDataModel object. - - the string to import data from - - - a hash table containing which columns of @model will be imported, or %NULL for all columns, see gda_data_model_import_from_model() - - - + line="862">#GList of #GValue* representing the row to add. The + length must match model's column count. These #GValue + are value-copied (the user is still responsible for freeing them). + + - - list of options for the export - - - + Method reserved to #GdaDataModelIter implementations, should not be called directly. - - + filename="libgda/gda-data-model-array.c" + line="315">Makes a copy of @src into a new #GdaDataModelArray object + + %TRUE if @iter was moved correctly. - + filename="libgda/gda-data-model-array.c" + line="322">a new data model, or %NULL if an error occurred + - + a #GdaDataModel + filename="libgda/gda-data-model-array.c" + line="317">a #GdaDataModel to copy data from - - a #GdaDataModelIter iterating in @model - - - + Method reserved to #GdaDataModelIter implementations, should not be called directly. - - + filename="libgda/gda-data-model-array.c" + line="367">Like gda_data_model_array_copy_model(), makes a copy of @src, but copies only some +columns. + + %TRUE if @iter was moved correctly. - + filename="libgda/gda-data-model-array.c" + line="377">a new data model, or %NULL if an error occurred + - + a #GdaDataModel + filename="libgda/gda-data-model-array.c" + line="369">a #GdaDataModel to copy data from - + a #GdaDataModelIter iterating in @model - + filename="libgda/gda-data-model-array.c" + line="370">size of @cols + + + + array of @src's columns to copy into the new array, not %NULL + + + - + Method reserved to #GdaDataModelIter implementations, should not be called directly. - - + filename="libgda/gda-data-model.c" + line="813">Creates a new iterator object #GdaDataModelIter object which can be used to iterate through +rows in @model. The new #GdaDataModelIter does not hold any reference to @model (ie. if @model +is destroyed at some point, the new iterator will become useless but in any case it will not prevent +the data model from being destroyed). + +Depending on the data model's implementation, a new #GdaDataModelIter object may be created, +or a reference to an already existing #GdaDataModelIter may be returned. For example if @model only +supports being accessed using a forward moving cursor (say a the result of a SELECT executed by SQLite +with a cursor access mode specified), then this method will always return the same iterator. + +If a new #GdaDataModelIter is created, then the row it represents is undefined. + +For models which can be accessed +randomly, any row can be set using gda_data_model_iter_move_to_row(), +and for models which are accessible sequentially only then use +gda_data_model_iter_move_next() (and gda_data_model_iter_move_prev() if +supported). + +Note: for the #GdaDataProxy data model (which proxies any #GdaDataModel for modifications and +has twice the number of columns of the proxied data model), this method will create an iterator +in which only the columns of the proxied data model appear. If you need to have a #GdaDataModelIter +in which all the proxy's columns appear, create it using: +<programlisting><![CDATA[iter = g_object_new (GDA_TYPE_DATA_MODEL_ITER, "data-model", proxy, NULL);]]></programlisting> + + %TRUE if @iter was moved correctly. - + filename="libgda/gda-data-model.c" + line="841">a #GdaDataModelIter object, or %NULL if an error occurred + a #GdaDataModel + filename="libgda/gda-data-model.c" + line="815">a #GdaDataModel object. - - a #GdaDataModelIter iterating in @model - - - - the requested row - - - + Removes a row from the data model. + line="439">Queries the underlying data model implementation for a description +of a given column. That description is returned in the form of +a #GdaColumn structure, which contains all the information +about the given column in the data model. -Upon errors FALSE will be returned and @error will be assigned a -#GError from the #GDA_DATA_MODEL_ERROR domain. - - +WARNING: the returned #GdaColumn object belongs to the @model model and +and should not be destroyed; any modification will affect the whole data model. + + %TRUE if successful, %FALSE otherwise. - + line="452">the description of the column. + a #GdaDataModel object. + line="441">a #GdaDataModel object. - + the row number to be removed. + line="442">column number. - + Emits the 'reset' and 'changed' signal on @model. - + line="2227">Dumps a textual representation of the @model to the @to_stream stream + +The following environment variables can affect the resulting output: +<itemizedlist> + <listitem><para>GDA_DATA_MODEL_DUMP_ROW_NUMBERS: if set, the first column of the output will contain row numbers</para></listitem> + <listitem><para>GDA_DATA_MODEL_DUMP_ATTRIBUTES: if set, also dump the data model's columns' types and value's attributes</para></listitem> + <listitem><para>GDA_DATA_MODEL_DUMP_TITLE: if set, also dump the data model's title</para></listitem> + <listitem><para>GDA_DATA_MODEL_NULL_AS_EMPTY: if set, replace the 'NULL' string with an empty string for NULL values </para></listitem> + <listitem><para>GDA_DATA_MODEL_DUMP_TRUNCATE: if set to a numeric value, truncates the output to the width specified by the value. If the value is -1 then the actual terminal size (if it can be determined) is used</para></listitem> +</itemizedlist> + @@ -8840,95 +9895,242 @@ Upon errors FALSE will be returned and @error will be assigned a a #GdaDataModel object. + line="2229">a #GdaDataModel. + + where to dump the data model + + - + Emits the 'row_inserted' and 'changed' signals on @model. + line="2309">Dumps a textual representation of the @model into a new string. The main differences with gda_data_model_export_to_string() are that +the formatting options are passed using environment variables, and that the data is dumped regardless of the user locale (e.g. dates +are not formatted according to the locale). -This method should only be used by #GdaDataModel implementations to -signal that a row has been inserted. - - - +The following environment variables can affect the resulting output: +<itemizedlist> + <listitem><para>GDA_DATA_MODEL_DUMP_ROW_NUMBERS: if set, the first column of the output will contain row numbers</para></listitem> + <listitem><para>GDA_DATA_MODEL_DUMP_TITLE: if set, also dump the data model's title</para></listitem> + <listitem><para>GDA_DATA_MODEL_NULL_AS_EMPTY: if set, replace the 'NULL' string with an empty string for NULL values </para></listitem> + <listitem><para>GDA_DATA_MODEL_DUMP_TRUNCATE: if set to a numeric value, truncates the output to the width specified by the value. If the value is -1 then the actual terminal size (if it can be determined) is used</para></listitem> +</itemizedlist> + + + a new string. + a #GdaDataModel object. + line="2311">a #GdaDataModel. - - row number. - - - + Emits the 'row_removed' and 'changed' signal on @model. + line="1391">Exports data contained in @model to the @file file; the format is specified using the @format argument. Note that +the date format used is the one used by the connection from which the data model has been made (as the result of a +SELECT statement), or, for other kinds of data models, the default format (refer to gda_data_handler_get_default()) unless +the "cnc" property has been set and points to a #GdaConnection to use that connection's date format. -This method should only be used by #GdaDataModel implementations to -signal that a row has been removed - +Specifically, the parameters in the @options list can be: +<itemizedlist> + <listitem><para>"SEPARATOR": a string value of which the first character is used as a separator in case of CSV export + </para></listitem> + <listitem><para>"QUOTE": a string value of which the first character is used as a quote character in case of CSV export. The + default if not specified is the double quote character</para></listitem> + <listitem><para>"FIELD_QUOTE": a boolean value which can be set to FALSE if no quote around the individual fields + is requeted, in case of CSV export</para></listitem> + <listitem><para>"NAMES_ON_FIRST_LINE": a boolean value which, if set to %TRUE and in case of a CSV or %GDA_DATA_MODEL_IO_TEXT_TABLE export, will add a first line with the name each exported field (note that "FIELDS_NAME" is also accepted as a synonym)</para></listitem> + <listitem><para>"NAME": a string value used to name the exported data if the export format is XML or %GDA_DATA_MODEL_IO_TEXT_TABLE</para></listitem> + <listitem><para>"OVERWRITE": a boolean value which tells if the file must be over-written if it already exists.</para></listitem> + <listitem><para>"NULL_AS_EMPTY": a boolean value which, if set to %TRUE and in case of a CSV or %GDA_DATA_MODEL_IO_TEXT_TABLE export, will render and NULL value as the empty string (instead of the 'NULL' string)</para></listitem> + <listitem><para>"INVALID_AS_NULL": a boolean value which, if set to %TRUE, considers any invalid data (for example for the date related values) as NULL</para></listitem> + <listitem><para>"COLUMN_SEPARATORS": a boolean value which, if set to %TRUE, adds a separators lines between each column, if the export format is %GDA_DATA_MODEL_IO_TEXT_TABLE + </para></listitem> + <listitem><para>"SEPARATOR_LINE": a boolean value which, if set to %TRUE, adds an horizontal line between column titles and values, if the export format is %GDA_DATA_MODEL_IO_TEXT_TABLE + </para></listitem> + <listitem><para>"ROW_NUMBERS": a boolean value which, if set to %TRUE, prepends a column with row numbers, if the export format is %GDA_DATA_MODEL_IO_TEXT_TABLE + </para></listitem> + <listitem><para>"MAX_WIDTH": an integer value which, if greater than 0, makes all the lines truncated to have at most that number of characters, if the export format is %GDA_DATA_MODEL_IO_TEXT_TABLE + </para></listitem> +</itemizedlist> + +Warning: this function uses a #GdaDataModelIter iterator, and if @model does not offer a random access +(check using gda_data_model_get_access_flags()), the iterator will be the same as normally used +to access data in @model previously to calling this method, and this iterator will be moved (point to +another row). + +Upon errors %FALSE will be returned and @error will be assigned a +#GError from the #GDA_DATA_MODEL_ERROR domain. + - + TRUE if no error occurred + a #GdaDataModel object. + line="1393">a #GdaDataModel - + row number. + line="1394">the format in which to export data + + + + the filename to export to + + + + an array containing which columns of @model will be exported, or %NULL for all columns + + + + + + the number of columns in @cols + + + + an array containing which rows of @model will be exported, or %NULL for all rows + + + + + + the number of rows in @rows + + list of options for the export + + - + Emits the 'row_updated' and 'changed' signals on @model. + line="1079">Exports data contained in @model to a string; the format is specified using the @format argument, see the +gda_data_model_export_to_file() documentation for more information about the @options argument (except for the +"OVERWRITE" option). -This method should only be used by #GdaDataModel implementations to -signal that a row has been updated. - - - +Warning: this function uses a #GdaDataModelIter iterator, and if @model does not offer a random access +(check using gda_data_model_get_access_flags()), the iterator will be the same as normally used +to access data in @model previously to calling this method, and this iterator will be moved (point to +another row). + +See also gda_data_model_dump_as_string(); + + + a new string, use g_free() when no longer needed + a #GdaDataModel object. + line="1081">a #GdaDataModel - + row number. + line="1082">the format in which to export data + + + + an array containing which columns of @model will be exported, or %NULL for all columns + + + + + + the number of columns in @cols + + + + an array containing which rows of @model will be exported, or %NULL for all rows + + + + + + the number of rows in @rows + + list of options for the export + + - + Sends a hint to the data model. The hint may or may not be handled by the data -model, depending on its implementation - + line="331">Disables notifications of changes on the given data model. To +re-enable notifications again, you should call the +#gda_data_model_thaw function. + @@ -8936,985 +10138,1256 @@ model, depending on its implementation a #GdaDataModel + line="333">a #GdaDataModel object. - - a hint to send to the model - - - + + + + Get the attributes of @model such as how to access the data it contains if it's modifiable, etc. + + + an ORed value of #GdaDataModelAccessFlags flags + + + + an optional value to specify the hint, or %NULL - - + line="383">a #GdaDataModel object. + + - + Sets the @name of the given @col in @model, and if its title is not set, also sets the -title to @name. - + line="697">Get the attributes of the value stored at (row, col) in @model, which +is an ORed value of #GdaValueAttribute flags. As a special case, if +@row is -1, then the attributes returned correspond to a "would be" value +if a row was added to @model. + - + the attributes as an ORed value of #GdaValueAttribute + a #GdaDataModel object. + line="699">a #GdaDataModel object column number + line="700">a valid column number - + name for the given column. - + line="701">a valid row number, or -1 + - + Sets the @title of the given @col in @model. - + line="467">Get the index of the first column named @name in @model. + - + the column index, or -1 if no column named @name was found + a #GdaDataModel object. + line="469">a #GdaDataModel object. - - column number - - - + title for the given column. + line="470">a column name - - Modifies a value in @model, at (@col, @row). - -Upon errors FALSE will be returned and @error will be assigned a -#GError from the #GDA_DATA_MODEL_ERROR domain. - + + TRUE if the value in the data model has been updated and no error occurred - + line="504">the name for the given column in a data model object. + a #GdaDataModel object. + line="499">a #GdaDataModel object. column number. - - - - row number. + line="500">column number. - - a #GValue (not %NULL) - - - - In a similar way to gda_data_model_set_value_at(), this method modifies a data model's contents -by setting several values at once. - -If any value in @values is actually %NULL, then the value in the corresponding column is left -unchanged. - -Upon errors FALSE will be returned and @error will be assigned a -#GError from the #GDA_DATA_MODEL_ERROR domain. - + + %TRUE if the value in the data model has been updated and no error occurred - + line="554">the title for the given column in a data model object. + a #GdaDataModel object. + line="551">a #GdaDataModel object. - + row number. + line="552">column number. - - a list of #GValue (or %NULL), one for at most the number of columns of @model - - - - - + Re-enables notifications of changes on the given data model. - + line="1049">Get the global data model exception(s) that occurred when using @model. +This is useful for example for the LDAP related +data models where some rows may be missing because the LDAP search has reached a limit +imposed by the LDAP server. + - + a pointer to a %NULL terminated array of #GError, or %NULL. + + + a #GdaDataModel object. + line="1051">a #GdaDataModel - - Gets emitted when @model's access flags have changed. Use -gda_data_model_get_access_flags() to get the access flags. - - - - - - Gets emitted when any value in @model has been changed - - - - - - Gets emitted when @model's contents has been completely reset (the number and -type of columns may also have changed) + + - + the number of columns in the given data model, or -1 if unknown. + - - - Gets emitted when a row has been inserted in @model + + + a #GdaDataModel object. + + + + + + - + the number of rows in the given data model, or -1 if the number of rows is not known + - + the row number - - + line="405">a #GdaDataModel object. + + - - + + Gets emitted when a row has been removed from @model + line="364">Returns the status of notifications changes on the given data model. + - + - + the row number - - + line="366">a #GdaDataModel object. + + - - + + Gets emitted when a row has been modified in @model + line="959">Returns the first row where all the values in @values at the columns identified at +@cols_index match. If the row can't be identified, then returns -1; + +NOTE: the @cols_index array MUST contain a column index for each value in @values + - + the requested row number, of -1 if not found + - + the row number - - + line="961">a #GdaDataModel object. + + + + a list of #GValue values (no %NULL is allowed) + + + + + + an array of #gint containing the column number to match each value of @values + + + + - - - - - - - - - - - - - - - - - - - - - - - - - + + Creates a new #GdaDataModel object without initializing the column -types. Using gda_data_model_array_new_with_g_types() is usually better. - - + filename="libgda/gda-data-model.c" + line="641">Upon errors %NULL will be returned and @error will be assigned a +#GError from the #GDA_DATA_MODEL_ERROR domain. + +This method is similar to gda_data_model_get_value_at(), except that it also allows one to specify the expected +#GType of the value to get: if the data model returned a #GValue of a type different than the expected one, then +this method returns %NULL and an error code. + +Note: the same limitations and usage instructions apply as for gda_data_model_get_value_at(). + +Upon errors %NULL will be returned and @error will be assigned a +#GError from the #GDA_DATA_MODEL_ERROR domain. + + a pointer to the newly created #GdaDataModel. - + filename="libgda/gda-data-model.c" + line="662">a #GValue containing the value stored in the given +position, or %NULL on error (out-of-bound position, wrong data type, etc). + - + number of columns for rows in this data model. + filename="libgda/gda-data-model.c" + line="643">a #GdaDataModel object. + + + + a valid column number. - - - - Creates a new #GdaDataModel object with the column types as -specified. - - - a pointer to the newly created #GdaDataModel. - - - - + number of columns for rows in this data model. + filename="libgda/gda-data-model.c" + line="645">a valid row number. - + types of the columns of the model to create as #GType, as many as indicated by @cols - + filename="libgda/gda-data-model.c" + line="646">the expected data type of the returned value + + + + if TRUE, then NULL values (value of type %GDA_TYPE_NULL) will not generate any error + - - + + Creates a new #GdaDataModel object with the column types as -specified. - - + filename="libgda/gda-data-model.c" + line="592">Retrieves the data stored in the given position (identified by +the @col and @row parameters) on a data model. + +Upon errors %NULL will be returned and @error will be assigned a +#GError from the #GDA_DATA_MODEL_ERROR domain. + +This is the main function for accessing data in a model which allows random access to its data. +To access data in a data model using a cursor, use a #GdaDataModelIter object, obtained using +gda_data_model_create_iter(). + +Note1: the returned #GValue must not be modified directly (unexpected behaviours may +occur if you do so). + +Note2: the returned value may become invalid as soon as any Libgda part is executed again, +which means if you want to keep the value, a copy must be made, however it will remain valid +as long as the only Libgda usage is calling gda_data_model_get_value_at() for different values +of the same row. + +If you want to modify a value stored in a #GdaDataModel, use the gda_data_model_set_value_at() or +gda_data_model_set_values() methods. + +Upon errors %NULL will be returned and @error will be assigned a +#GError from the #GDA_DATA_MODEL_ERROR domain. + + a pointer to the newly created #GdaDataModel. - + filename="libgda/gda-data-model.c" + line="623">a #GValue containing the value stored in the given +position, or %NULL on error (out-of-bound position, etc). + - + number of columns for rows in this data model. + filename="libgda/gda-data-model.c" + line="594">a #GdaDataModel object. + + + + a valid column number. - + array of types of the columns of the model to create as #GType, as many as indicated by @cols - - - + filename="libgda/gda-data-model.c" + line="596">a valid row number. + - - + + Frees all the rows in @model. - + filename="libgda/gda-data-model.c" + line="2192">Imports data contained in the @file file into @model; the format is detected. + +Upon errors FALSE will be returned and @error will be assigned a +#GError from the #GDA_DATA_MODEL_ERROR domain. + - + TRUE if no error occurred + the model to clear. - + filename="libgda/gda-data-model.c" + line="2194">a #GdaDataModel + + + the filename to import from + + + + a #GHashTable for columns translating, or %NULL, see gda_data_model_import_from_model() + + + + + + + list of options for the export + + - Get a pointer to a row in @model - + filename="libgda/gda-data-model.c" + line="1897">Copy the contents of the @from data model to the @to data model. The copy stops as soon as an error +orrurs. + +The @cols_trans is a hash table for which keys are @to columns numbers and the values are +the corresponding column numbers in the @from data model. To set the values of a column in @to to NULL, +create an entry in the hash table with a negative value. For example: +<programlisting><![CDATA[GHashTable *hash; +gint *ptr; +hash = g_hash_table_new_full (g_int_hash, g_int_equal, g_free, NULL); +ptr = g_new (gint, 1); +*ptr = 2; +g_hash_table_insert (hash, ptr, GINT_TO_POINTER (3)); +gda_data_model_import_from_model (...); +g_hash_table_free (hash); +]]></programlisting> + +Upon errors FALSE will be returned and @error will be assigned a +#GError from the #GDA_DATA_MODEL_ERROR domain. + the #GdaRow, or %NULL if an error occurred - + filename="libgda/gda-data-model.c" + line="1924">TRUE if no error occurred. + - + a #GdaDataModelArray object - + filename="libgda/gda-data-model.c" + line="1899">the destination #GdaDataModel + - + row number (starting from 0) - + filename="libgda/gda-data-model.c" + line="1900">the source #GdaDataModel + + + + TRUE if @to is completely overwritten by @from's data, and FALSE if @from's data is appended to @to + + + + a #GHashTable for columns translating, or %NULL + + + + - + Sets the number of columns for rows inserted in this model. -@cols must be greated than or equal to 0. + filename="libgda/gda-data-model.c" + line="2157">Loads the data from @string into @model. -Also clears @model's contents. - +Upon errors FALSE will be returned and @error will be assigned a +#GError from the #GDA_DATA_MODEL_ERROR domain. + - + TRUE if no error occurred. + the #GdaDataModelArray. - + filename="libgda/gda-data-model.c" + line="2159">a #GdaDataModel + - + number of columns for rows this data model should use. - + filename="libgda/gda-data-model.c" + line="2160">the string to import data from + + + + a hash table containing which columns of @model will be imported, or %NULL for all columns, see gda_data_model_import_from_model() + + + + + + + list of options for the export + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + Creates a new #GdaDataModel object to list all the files starting from @basedir - - + filename="libgda/gda-data-model-iter.c" + line="796">Method reserved to #GdaDataModelIter implementations, should not be called directly. + + a new #GdaDataModel - + filename="libgda/gda-data-model-iter.c" + line="803">%TRUE if @iter was moved correctly. + - + a directory - + filename="libgda/gda-data-model-iter.c" + line="798">a #GdaDataModel + + + + a #GdaDataModelIter iterating in @model + - - + + Reset the list of errors which have occurred while using @model - + filename="libgda/gda-data-model-iter.c" + line="904">Method reserved to #GdaDataModelIter implementations, should not be called directly. + - + %TRUE if @iter was moved correctly. + a #GdaDataModelDir object - + filename="libgda/gda-data-model-iter.c" + line="906">a #GdaDataModel + - - - - Get the list of errors which have occurred while using @model - + + a #GdaDataModelIter iterating in @model + + + + + + Method reserved to #GdaDataModelIter implementations, should not be called directly. + a read-only list of #GError pointers, or %NULL if no error has occurred - - - + filename="libgda/gda-data-model-iter.c" + line="693">%TRUE if @iter was moved correctly. + a #GdaDataModelDir object - + filename="libgda/gda-data-model-iter.c" + line="687">a #GdaDataModel + + + a #GdaDataModelIter iterating in @model + + + + the requested row + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Format to use when exporting a data model, see gda_data_model_export_to_string() and gda_data_model_export_to_file() - - - data is exported as an XML structure - - - data is exported as CSV - - - data is exported as a human readable table - - - - - - - - - + Creates a new #GdaDataModel object which contains the data stored within the @filename file. - -The options are the following ones: -<itemizedlist> - <listitem><para>For the CSV format: - <itemizedlist> - <listitem><para>ENCODING (string): specifies the encoding of the data in the file</para></listitem> - <listitem><para>SEPARATOR (string): specifies the CSV separator (comma as default)</para></listitem> - <listitem><para>QUOTE (string): specifies the character used as quote (double quote as default)</para></listitem> - <listitem><para>NAMES_ON_FIRST_LINE (boolean): consider that the first line of the file contains columns' titles (note that the TITLE_AS_FIRST_LINE option is also accepted as a synonym)</para></listitem> - <listitem><para>G_TYPE_&lt;column number&gt; (GType): specifies the type of value expected in column &lt;column number&gt;</para></listitem> - </itemizedlist> - </para></listitem> - <listitem><para>Other formats: no option</para></listitem> -</itemizedlist> + filename="libgda/gda-data-model.c" + line="925">Removes a row from the data model. -Note: after the creation, please use gda_data_model_import_get_errors() to check any error. - - +Upon errors FALSE will be returned and @error will be assigned a +#GError from the #GDA_DATA_MODEL_ERROR domain. + + a pointer to the newly created #GdaDataModel. - + filename="libgda/gda-data-model.c" + line="936">%TRUE if successful, %FALSE otherwise. + - + the file to import data from - + filename="libgda/gda-data-model.c" + line="927">a #GdaDataModel object. + + + + the row number to be removed. + - + + + + Emits the 'reset' and 'changed' signal on @model. + + + + + + TRUE if random access will be required - + filename="libgda/gda-data-model.c" + line="314">a #GdaDataModel object. + + + + + + Emits the 'row_inserted' and 'changed' signals on @model. + +This method should only be used by #GdaDataModel implementations to +signal that a row has been inserted. + + + + + + + a #GdaDataModel object. + + + + row number. + - + + + + Emits the 'row_removed' and 'changed' signal on @model. + +This method should only be used by #GdaDataModel implementations to +signal that a row has been removed + + + + + + importing options - + filename="libgda/gda-data-model.c" + line="290">a #GdaDataModel object. + + + + row number. + - - + + Creates a new #GdaDataModel object which contains the data stored in the @data string. + filename="libgda/gda-data-model.c" + line="264">Emits the 'row_updated' and 'changed' signals on @model. -Important note: the @data string is not copied for memory efficiency reasons and should not -therefore be altered in any way as long as the returned data model exists. - - - a pointer to the newly created #GdaDataModel. - +This method should only be used by #GdaDataModel implementations to +signal that a row has been updated. + + + - + a string containing the data to import - + filename="libgda/gda-data-model.c" + line="266">a #GdaDataModel object. + + + + row number. + - + + + + Sends a hint to the data model. The hint may or may not be handled by the data +model, depending on its implementation + + + + + + TRUE if random access will be required - + filename="libgda/gda-data-model.c" + line="1033">a #GdaDataModel + + + + a hint to send to the model + - importing options, see gda_data_model_import_new_file() for more information - + filename="libgda/gda-data-model.c" + line="1035">an optional value to specify the hint, or %NULL + - - + + Creates a new #GdaDataModel and loads the data in @node. The resulting data model -can be accessed in a random way. - - - a pointer to the newly created #GdaDataModel. - + filename="libgda/gda-data-model.c" + line="521">Sets the @name of the given @col in @model, and if its title is not set, also sets the +title to @name. + + + - + an XML node corresponding to a &lt;data-array&gt; tag - + filename="libgda/gda-data-model.c" + line="523">a #GdaDataModel object. + + + + column number + + + + name for the given column. + - - + + Clears the history of errors @model has to report - + filename="libgda/gda-data-model.c" + line="571">Sets the @title of the given @col in @model. + a #GdaDataModelImport object - + filename="libgda/gda-data-model.c" + line="573">a #GdaDataModel object. + + + column number + + + + title for the given column. + + - + Get the list of errors which @model has to report. The returned list is a list of -#GError structures, and must not be modified - + filename="libgda/gda-data-model.c" + line="727">Modifies a value in @model, at (@col, @row). + +Upon errors FALSE will be returned and @error will be assigned a +#GError from the #GDA_DATA_MODEL_ERROR domain. + the list of errors (which must not be modified), or %NULL - - - + filename="libgda/gda-data-model.c" + line="740">TRUE if the value in the data model has been updated and no error occurred + a #GdaDataModelImport object - + filename="libgda/gda-data-model.c" + line="729">a #GdaDataModel object. + - - - - Data to import, as a string. - - - + + column number. + + + + row number. + + + + a #GValue (not %NULL) + + + + + Name of the file to import. - - - + filename="libgda/gda-data-model.c" + line="757">In a similar way to gda_data_model_set_value_at(), this method modifies a data model's contents +by setting several values at once. + +If any value in @values is actually %NULL, then the value in the corresponding column is left +unchanged. + +Upon errors FALSE will be returned and @error will be assigned a +#GError from the #GDA_DATA_MODEL_ERROR domain. + + + %TRUE if the value in the data model has been updated and no error occurred + + + + + a #GdaDataModel object. + + + + row number. + + + + a list of #GValue (or %NULL), one for at most the number of columns of @model + + + + + + + Data model options. - - - Re-enables notifications of changes on the given data model. + + + + + + + a #GdaDataModel object. + + + + + + Gets emitted when @model's access flags have changed. Use +gda_data_model_get_access_flags() to get the access flags. + + + + + + Gets emitted when any value in @model has been changed + + + + + + Gets emitted when @model's contents has been completely reset (the number and +type of columns may also have changed) + + + + + + Gets emitted when a row has been inserted in @model + + + + + + the row number + + + + + + Gets emitted when a row has been removed from @model + + + + + + the row number + + + + + + Gets emitted when a row has been modified in @model + + + + + + the row number + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new #GdaDataModel object without initializing the column +types. Using gda_data_model_array_new_with_g_types() is usually better. + + + a pointer to the newly created #GdaDataModel. + + + + + number of columns for rows in this data model. + + + + + + Creates a new #GdaDataModel object with the column types as +specified. + + + a pointer to the newly created #GdaDataModel. + + + + + number of columns for rows in this data model. + + + + types of the columns of the model to create as #GType, as many as indicated by @cols + + + + + + Creates a new #GdaDataModel object with the column types as +specified. + + + a pointer to the newly created #GdaDataModel. + + + + + number of columns for rows in this data model. + + + + array of types of the columns of the model to create as #GType, as many as indicated by @cols + + + + + + + + Frees all the rows in @model. + + + + + + + the model to clear. + + + + + + Get a pointer to a row in @model + + + the #GdaRow, or %NULL if an error occurred + + + + + a #GdaDataModelArray object + + + + row number (starting from 0) + + + + + + Sets the number of columns for rows inserted in this model. +@cols must be greated than or equal to 0. + +Also clears @model's contents. + + + + + + + the #GdaDataModelArray. + + + + number of columns for rows this data model should use. + + + + + - Defines if the data model will be accessed randomly or through a cursor. If set to %FALSE, -access will have to be done using a cursor. - + setter="set_n_columns" + default-value="0"> + - - Defines the behaviour in case the imported data contains recoverable errors (usually too -many or too few data per row). If set to %TRUE, an error will be reported and the import -will stop, and if set to %FALSE, then the error will be reported but the import will not stop. - - Data to import, as a pointer to an XML node (a #xmlNodePtr). - - - - + + - + @@ -9922,8 +11395,7 @@ will stop, and if set to %FALSE, then the error will be reported but the import - + @@ -9931,8 +11403,7 @@ will stop, and if set to %FALSE, then the error will be reported but the import - + @@ -9940,31 +11411,522 @@ will stop, and if set to %FALSE, then the error will be reported but the import - + - - + + + + + Creates a new #GdaDataModel object to list all the files starting from @basedir + + + a new #GdaDataModel + + + + + a directory + + + + + + Reset the list of errors which have occurred while using @model + + + + + + + a #GdaDataModelDir object + + + + + + Get the list of errors which have occurred while using @model + + + a read-only list of #GError pointers, or %NULL if no error has occurred + + + + + + + a #GdaDataModelDir object + + + + + + + - + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Format to use when exporting a data model, see gda_data_model_export_to_string() and gda_data_model_export_to_file() + + + data is exported as an XML structure + + + data is exported as CSV + + + data is exported as a human readable table + + + + + + + + + + Creates a new #GdaDataModel object which contains the data stored within the @filename file. + +The options are the following ones: +<itemizedlist> + <listitem><para>For the CSV format: + <itemizedlist> + <listitem><para>ENCODING (string): specifies the encoding of the data in the file</para></listitem> + <listitem><para>SEPARATOR (string): specifies the CSV separator (comma as default)</para></listitem> + <listitem><para>QUOTE (string): specifies the character used as quote (double quote as default)</para></listitem> + <listitem><para>NAMES_ON_FIRST_LINE (boolean): consider that the first line of the file contains columns' titles (note that the TITLE_AS_FIRST_LINE option is also accepted as a synonym)</para></listitem> + <listitem><para>G_TYPE_&lt;column number&gt; (GType): specifies the type of value expected in column &lt;column number&gt;</para></listitem> + </itemizedlist> + </para></listitem> + <listitem><para>Other formats: no option</para></listitem> +</itemizedlist> + +Note: after the creation, please use gda_data_model_import_get_errors() to check any error. + + + a pointer to the newly created #GdaDataModel. + + + + + the file to import data from + + + + TRUE if random access will be required + + + + importing options + + + + + + Creates a new #GdaDataModel object which contains the data stored in the @data string. + +Important note: the @data string is not copied for memory efficiency reasons and should not +therefore be altered in any way as long as the returned data model exists. + + + a pointer to the newly created #GdaDataModel. + + + + + a string containing the data to import + + + + TRUE if random access will be required + + + + importing options, see gda_data_model_import_new_file() for more information + + + + + + Creates a new #GdaDataModel and loads the data in @node. The resulting data model +can be accessed in a random way. + + + a pointer to the newly created #GdaDataModel. + + + + + an XML node corresponding to a &lt;data-array&gt; tag + + + + + + Clears the history of errors @model has to report + + + + + + + a #GdaDataModelImport object + + + + + + Get the list of errors which @model has to report. The returned list is a list of +#GError structures, and must not be modified + + + the list of errors (which must not be modified), or %NULL + + + + + + + a #GdaDataModelImport object + + + + + + Data to import, as a string. + + + + Name of the file to import. + + + + Data model options. + + + + Defines if the data model will be accessed randomly or through a cursor. If set to %FALSE, +access will have to be done using a cursor. + + + + Defines the behaviour in case the imported data contains recoverable errors (usually too +many or too few data per row). If set to %TRUE, an error will be reported and the import +will stop, and if set to %FALSE, then the error will be reported but the import will not stop. + + + + Data to import, as a pointer to an XML node (a #xmlNodePtr). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -13500,14 +15462,12 @@ to uniquely identify a single row in a table when creating modification statemen Compares two objects similar to g_strcmp(). In general, catalog and schema can be %NULL. In this case -those pairs are ignored. If we represent a full name as catalog.schema.name then two objects -null.null.customer and main.main.customer are identical. + line="319">Compares two objects similar to g_strcmp(). 0 if two objects are identical or -1 or 1 otherwise. + line="326">0 if catalog, schema and name are the same @@ -13988,7 +15948,7 @@ set. If @catalog is %NULL @schema may not be %NULL but if @schema is version="6.0"> This method append @table to the total list of all tables stored in @self. This method increase + line="774">This method append @table to the total list of all tables stored in @self. This method increase reference count for @table. @@ -13998,13 +15958,13 @@ reference count for @table. a #GdaDbCatalog instance + line="776">a #GdaDbCatalog instance table to append + line="777">table to append @@ -14014,7 +15974,7 @@ reference count for @table. version="6.0"> This method append @view to the total list of all views stored in @self. This method increase + line="795">This method append @view to the total list of all views stored in @self. This method increase reference count for @view. @@ -14024,55 +15984,17 @@ reference count for @view. a #GdaDbCatalog instance + line="797">a #GdaDbCatalog instance view to append + line="798">view to append - - Convenient function to get a table based on @name. The coller is responsible -for calling gda_db_catalog_parse_cnc() before calling this function. - - - table as #GdaDbTable or %NULL if the table is not found. The -returned pointer should not be freed and belongs to the @self. - - - - - a #GdaDbCatalog object -@catalog (nullable): catalog name or %NULL -@schema (nullable): schema name or %NULL - - - - - - - - - - table name - - - - @@ -14094,78 +16016,6 @@ returned pointer should not be freed and belongs to the @self. - - Convenient function to get a view based on name. The coller is responsible -for calling gda_db_catalog_parse_cnc() before calling this function. This -code is equivalent to the following code: - -|[<!-- language="C" --> - GdaDbBase *iobj; - GList *it; - - GdaDbCatalogPrivate *priv = gda_db_catalog_get_instance_private (self); - - if (gda_db_catalog_parse_cnc (self, error)) - return NULL; - - iobj = gda_db_base_new (); - gda_db_base_set_names (iobj, catalog, schema, name); - - for (it = priv->mp_views; it; it = it->next) - { - if (!gda_db_base_compare (iobj, GDA_DB_BASE (it->data))) - { - if (iobj) - g_object_unref (iobj); - - return GDA_DB_VIEW (it->data); - } - } - - if (iobj) - g_object_unref (iobj); - - return NULL; -]| - - - View as #GdaDbView or %NULL if the view is not found. The returned -pointer should not be freed and belongs to @self - - - - - a #GdaDbCatalog object - - - - a catalog name or %NULL - - - - a schema name or %NULL - - - - view name. Can't be %NULL - - - - @@ -14193,21 +16043,21 @@ pointer should not be freed and belongs to @self throws="1"> Parse internal cnc to populate @self object. This method should be called every time after + line="698">Parse internal cnc to populate @self object. This method should be called every time after database was modified or @self was just created using gda_connection_create_db_catalog(). The method will return %FALSE if no internal #GdaConnection available. Returns %TRUE if succeeded, %FALSE otherwise. + line="707">Returns %TRUE if succeeded, %FALSE otherwise. a #GdaDbCatalog instance + line="700">a #GdaDbCatalog instance @@ -14218,7 +16068,7 @@ method will return %FALSE if no internal #GdaConnection available. throws="1"> For detailed description see gda_db_catalog_parse_file_from_path() + line="1016">For detailed description see gda_db_catalog_parse_file_from_path() @@ -14227,13 +16077,13 @@ method will return %FALSE if no internal #GdaConnection available. an instance of #GdaDbCatalog + line="1018">an instance of #GdaDbCatalog xml file as #GFile instance + line="1019">xml file as #GFile instance @@ -14321,7 +16171,7 @@ before parsing it. throws="1"> After population @self with all data this method may be + line="816">After population @self with all data this method may be called to trigger code and modify user database. This is the main method to work with database. For retrieving information from database to an xml file use gda_db_catalog_parse_cnc() and gda_db_buildable_write_node(). @@ -14348,7 +16198,7 @@ issue was open on gitlab page. a #GdaDbCatalog object + line="818">a #GdaDbCatalog object @@ -14359,26 +16209,26 @@ issue was open on gitlab page. throws="1"> This method writes database description as xml file. + line="932">This method writes database description as xml file. Similar to gda_db_catalog_write_to_path() %TRUE if no error occurred, %FALSE otherwise. + line="941">%TRUE if no error occurred, %FALSE otherwise. a #GdaDbCatalog instance + line="934">a #GdaDbCatalog instance a #GFile to write database description + line="935">a #GFile to write database description @@ -14389,25 +16239,25 @@ Similar to gda_db_catalog_write_to_path() throws="1"> Save content of @self to a user friendly xml file. + line="959">Save content of @self to a user friendly xml file. %TRUE is no error, %FALSE otherwise. + line="967">%TRUE is no error, %FALSE otherwise. a #GdaDbCatalog instance + line="961">a #GdaDbCatalog instance path to xml file to save #GdaDbCatalog + line="962">path to xml file to save #GdaDbCatalog @@ -17107,6 +18957,321 @@ occurrence of "'" with "''" and "\" with "\\" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new empty #GdaDsnInfo struct. + line="105">Creates a new empty #GdaDsnInfo struct. a new #GdaDsnInfo struct. + line="110">a new #GdaDsnInfo struct. Copy constructor. + line="127">Copy constructor. a new #GdaDsnInfo + line="133">a new #GdaDsnInfo a #GdaDsnInfo to copy from + line="129">a #GdaDsnInfo to copy from @@ -17199,7 +19364,7 @@ occurrence of "'" with "''" and "\" with "\\" Compares @dsn1 and @dsn2. + line="216">Compares @dsn1 and @dsn2. If both @dsn1 and @dsn2 are %NULL, then the function returns %TRUE. If only one of @dsn1 or @dsn2 is %NULL, then the function return %FALSE. @@ -17207,7 +19372,7 @@ If only one of @dsn1 or @dsn2 is %NULL, then the function return %FALSE. %TRUE if they are equal. + line="226">%TRUE if they are equal. @@ -17217,7 +19382,7 @@ If only one of @dsn1 or @dsn2 is %NULL, then the function return %FALSE. allow-none="1"> a #GdaDsnInfo + line="218">a #GdaDsnInfo allow-none="1"> a #GdaDsnInfo + line="219">a #GdaDsnInfo @@ -17234,7 +19399,7 @@ If only one of @dsn1 or @dsn2 is %NULL, then the function return %FALSE. Frees any resources taken by @dsn struct. If @dsn is %NULL, then nothing happens. + line="152">Frees any resources taken by @dsn struct. If @dsn is %NULL, then nothing happens. @@ -17246,7 +19411,7 @@ If only one of @dsn1 or @dsn2 is %NULL, then the function return %FALSE. allow-none="1"> a #GdaDsnInfo struct to free + line="154">a #GdaDsnInfo struct to free @@ -17258,4562 +19423,3950 @@ If only one of @dsn1 or @dsn2 is %NULL, then the function return %FALSE. - - - - - - a new #GdaGeometricPoint - + + + + + + + + + + + + + + + + + + + + - - - - - + + + + + + + + + + - - + + - - - + + + - + - - + + - - - + + + + + + + + + + + + + + - + - - + + - - - + + + + + + + + + + + + + + - + - - + + - - - + + + - - + + - - + + - - - + + + - - + + - - + + - - - - - - - Creates a data handler for binary values - - - the new object - - - - - - - - - - - - - - - Creates a data handler for booleans - - - the new object - + + + + + - - - - - - - - - - - - - Creates a data handler for numerical values - - - the new object - + + + + + + + + + + + + + - - - - - - - - - - - - - Creates a data handler for strings - - - the new object - + + + + + + + + + + + + + - - - Creates a data handler for strings, which will use some specific methods implemented -by the @prov object (possibly also @cnc). - - - the new object - + + + + + + + + + + + + + - - a #GdaServerProvider object - + + + + + - - a #GdaConnection object, or %NULL - + + + + + + + + + + + + + - - - - - - - - - - - - - Creates a data handler for strings, which will use some specific methods implemented -by the provider object associated with @cnc. - - - the new object - + + + + + - - a #GdaConnection object - + + + + + - - - Creates a data handler for large strings - - - the new object - + + + + + - - - - - - - - - - - - - - - - Creates a data handler for time values - - - the new object - + + + + + + + + + + - - - Creates a data handler for time values, but using the default C locale -instead of the current user locale. - - - the new object - + + + + + + + + + + - - - Get a string representing the locale-dependent way to enter a date/time/datetime, using -a syntax suitable for the #GdauiFormatEntry widget - - - a new string - + + + + + + + + + + - - a #GdaHandlerTime object - + + - - the type of data being handled - - - - Get a string giving the user a hint about the locale-dependent requested format. - - - a new string - + + + + - - a #GdaHandlerTime object - + + - - the type of data being handled - - - - - - a new string representing @value without taking the current -locale into account (i.e. in the "C" locale) - + + + + - - a #GdaHandlerTime object - + + - - a #GValue value - - - - Specifies the SQL output style of the @dh data handler. The general format is "FIRSTsSECsTHIRD" -where FIRST, SEC and THIRD are specified by @first, @sec and @trird and 's' is the separator, -specified by @separator. - -The default implementation is @first=G_DATE_MONTH, @sec=G_DATE_DAY and @third=G_DATE_YEAR -(the year is rendered on 4 digits) and the separator is '-' - + + - + - - a #GdaHandlerTime object - + + - - what comes first in the date representation - - - - what comes second in the date representation - - - - what comes third in the date representation - - - - separator character used between year, month and day - - - - TRUE if year part of date must be rendered on 2 digits - - - - Specifies the human readable output style of the @dh data handler. -The general format is "FIRSTsSECsTHIRD" -where FIRST, SEC and THIRD are specified by @first, @sec and @trird and 's' is the separator, -specified by @separator. - -The default implementation depends on the current locale, except if @dh was created -using gda_handler_time_new_no_locale(). - + + - - a #GdaHandlerTime object - + + - - what comes first in the date representation - - - - what comes second in the date representation - - - - what comes third in the date representation - - - - separator character used between year, month and day - - - - TRUE if year part of date must be rendered on 2 digits - + + - - - - - - - - - - - - Creates a data handler for Gda types - - - the new object - - - - - - - - - - - - - - - Creates a new holder of type @type - - - a new #GdaHolder object - + + + + - - the #GType requested - - - - an identifiation - + + + + + - - - Creates a new #GdaHolder object with an ID set to @id, of type @type, -and containing the value passed as the last argument. - -Note that this function is a utility function and that only a limited set of types are supported. Trying -to use an unsupported type will result in a warning, and the returned value holder holding a safe default -value. - - - a new #GdaHolder object - + + + + + - - a valid GLib type - - - - the id of the holder to create, or %NULL + + + + - - value to set - - - - - - - - - - + + + - - + + + + + - - - + + + - - + + + + + - - - + + + - - + + + + + - - - - - + + + + + - - + + - - + + - - - Copy constructor. - -Note1: if @orig is set with a static value (see gda_holder_take_static_value()) -its copy will have a fresh new allocated GValue, so that user should free it when done. - + + + - a new #GdaHolder object - + - - a #GdaHolder object to copy - + + - - Forces a holder to be invalid; to set it valid again, a new value must be assigned -to it using gda_holder_set_value() or gda_holder_take_value(). - -@holder's value is set to %NULL. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - a #GdaHolder object - - + + + - - - Forces a holder to be invalid; to set it valid again, a new value must be assigned -to it using gda_holder_set_value() or gda_holder_take_value(). - -@holder's value is set to %NULL. - + + + - + - - a #GdaHolder object - - - - a #GError explaining why @holder is declared invalid, or %NULL - + + - - - Get an "encoded" version of @holder's name. The "encoding" consists in replacing non -alphanumeric character with the string "__gdaXX" where XX is the hex. representation -of the non alphanumeric char. - -This method is just a wrapper around the gda_text_to_alphanum() function. - + + + - a new string - - a #GdaHolder object - - + + + - - - Get the holder which makes @holder change its value when the holder's value is changed. - + + + + + + + + + + + + + + + + + - the #GdaHolder or %NULL - + - - a #GdaHolder - - + + + - - - Get the default value held into the holder. WARNING: the default value does not need to be of -the same type as the one required by @holder. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + the default value - + filename="libgda/gda-value.c" + line="1060">a new #GdaGeometricPoint + + + + + + + - - a #GdaHolder object - + + - - Get @holder's type - + + - the data type - + - - a #GdaHolder object - + + - - Get the ID of @holder. The ID can be set using @holder's "id" property - + + - the ID (don't modify the string). - + - - a #GdaHolder object - + + - - Get wether the holder can be NULL or not - + + - TRUE if the holder cannot be NULL - + - - a #GdaHolder object - + + - - If gda_holder_set_source_model() has been used to provide a hint that @holder's value -should be among the values contained in a column of a data model, then this method -returns which data model, and if @col is not %NULL, then it is set to the restricting column -as well. - -Otherwise, this method returns %NULL, and if @col is not %NULL, then it is set to 0. - + + - a pointer to a #GdaDataModel, or %NULL - + - - a #GdaHolder - + + - - a place to store the column in the model sourcing the holder, or %NULL - + + - - Get the value held into the holder. If @holder is set to use its default value -and that default value is not of the same type as @holder, then %NULL is returned. - -If @holder is set to NULL, then the returned value is a #GDA_TYPE_NULL GValue. - -If @holder is invalid, then the returned value is %NULL. - - - the value, or %NULL - + + + + - - a #GdaHolder object - + + + + + - + + + + + Same functionality as gda_holder_get_value() except that it returns the value as a string -(the conversion is done using @dh if not %NULL, or the default data handler otherwise). - + filename="libgda/handlers/gda-handler-bin.c" + line="45">Creates a data handler for binary values + the value, or %NULL - + filename="libgda/handlers/gda-handler-bin.c" + line="50">the new object + - - - a #GdaHolder object - - - - a #GdaDataHandler to use, or %NULL - - - - - + + + + + + + + + + + + Get the validity of @holder (that is, of the value held by @holder) - - + filename="libgda/handlers/gda-handler-boolean.c" + line="39">Creates a data handler for booleans + + TRUE if @holder's value can safely be used - + filename="libgda/handlers/gda-handler-boolean.c" + line="44">the new object + - - - a #GdaHolder object - - - - - + + + + + + + + + + + + Get the validity of @holder (that is, of the value held by @holder) - - + filename="libgda/handlers/gda-handler-numerical.c" + line="42">Creates a data handler for numerical values + + TRUE if @holder's value can safely be used - + filename="libgda/handlers/gda-handler-numerical.c" + line="47">the new object + - - - a #GdaHolder object - - - - - + + + + + + + + + + + + Sets @holder to change when @bind_to changes (and does not make @bind_to change when @holder changes). -For the operation to succeed, the GType of @holder and @bind_to must be the same, with the exception that -any of them can have a %GDA_TYPE_NULL type (in this situation, the GType of the two #GdaHolder objects -involved is set to match the other when any of them sets its type to something different than GDA_TYPE_NULL). - -If @bind_to is %NULL, then @holder will not be bound anymore. - - + filename="libgda/handlers/gda-handler-string.c" + line="44">Creates a data handler for strings + + TRUE if no error occurred - + filename="libgda/handlers/gda-handler-string.c" + line="49">the new object + + + + + Creates a data handler for strings, which will use some specific methods implemented +by the @prov object (possibly also @cnc). + + + the new object + - + a #GdaHolder - - - + filename="libgda/handlers/gda-handler-string.c" + line="63">a #GdaServerProvider object + + + a #GdaHolder or %NULL - + filename="libgda/handlers/gda-handler-string.c" + line="64">a #GdaConnection object, or %NULL + - - + + + + + + + + + + + + Sets the default value within the holder. If @value is %NULL then @holder won't have a -default value anymore. To set a default value to %NULL, then pass a #GValue created using -gda_value_new_null(). - -NOTE: the default value does not need to be of the same type as the one required by @holder. - - - + filename="libgda/handlers/gda-handler-text.c" + line="54">Creates a data handler for strings, which will use some specific methods implemented +by the provider object associated with @cnc. + + + the new object + - - a #GdaHolder object - - - + a value to set the holder's default value, or %NULL - + filename="libgda/handlers/gda-handler-text.c" + line="56">a #GdaConnection object + - - + + Sets if the holder can have a NULL value. If @not_null is TRUE, then that won't be allowed - - - + filename="libgda/handlers/gda-handler-text.c" + line="37">Creates a data handler for large strings + + + the new object + + + + + + + + + + + + + + + + + + Creates a data handler for time values + + + the new object + + + + + Creates a data handler for time values, but using the default C locale +instead of the current user locale. + + + the new object + + + + + Get a string representing the locale-dependent way to enter a date/time/datetime, using +a syntax suitable for the #GdauiFormatEntry widget + + + a new string + - + a #GdaHolder object - + filename="libgda/handlers/gda-handler-time.c" + line="397">a #GdaHandlerTime object + - + TRUE if @holder should not accept %NULL values - + filename="libgda/handlers/gda-handler-time.c" + line="398">the type of data being handled + - + Sets an hint that @holder's values should be restricted among the values -contained in the @col column of the @model data model. Note that this is just a hint, -meaning this policy is not enforced by @holder's implementation. - -If @model is %NULL, then the effect is to cancel ant previous call to gda_holder_set_source_model() -where @model was not %NULL. - - + filename="libgda/handlers/gda-handler-time.c" + line="447">Get a string giving the user a hint about the locale-dependent requested format. + + TRUE if no error occurred - + filename="libgda/handlers/gda-handler-time.c" + line="454">a new string + - + a #GdaHolder object - + filename="libgda/handlers/gda-handler-time.c" + line="449">a #GdaHandlerTime object + - - a #GdaDataModel object or %NULL - - - + the reference column in @model - + filename="libgda/handlers/gda-handler-time.c" + line="450">the type of data being handled + - - Sets the value within the holder. If @holder is an alias for another -holder, then the value is also set for that other holder. - -On success, the action of any call to gda_holder_force_invalid() is cancelled -as soon as this method is called (even if @holder's value does not actually change) - -If the value is not different from the one already contained within @holder, -then @holder is not changed and no signal is emitted. - -Note1: the @value argument is treated the same way if it is %NULL or if it is a #GDA_TYPE_NULL value - -Note2: if @holder can't accept the @value value, then this method returns FALSE, and @holder will be left -in an invalid state. - -Note3: before the change is accepted by @holder, the "validate-change" signal will be emitted (the value -of which can prevent the change from happening) which can be connected to to have a greater control -of which values @holder can have, or implement some business rules. - - + + + TRUE if value has been set - + filename="libgda/handlers/gda-handler-time.c" + line="301">a new string representing @value without taking the current +locale into account (i.e. in the "C" locale) + - + a #GdaHolder object - + filename="libgda/handlers/gda-handler-time.c" + line="298">a #GdaHandlerTime object + - + a value to set the holder to, or %NULL + filename="libgda/handlers/gda-handler-time.c" + line="299">a #GValue value - + Same functionality as gda_holder_set_value() except that it uses a string representation -of the value to set, which will be converted into a GValue first (using default data handler if -@dh is %NULL). + filename="libgda/handlers/gda-handler-time.c" + line="107">Specifies the SQL output style of the @dh data handler. The general format is "FIRSTsSECsTHIRD" +where FIRST, SEC and THIRD are specified by @first, @sec and @trird and 's' is the separator, +specified by @separator. -Note1: if @value is %NULL or is the "NULL" string, then @holder's value is set to %NULL. -Note2: if @holder can't accept the @value value, then this method returns FALSE, and @holder will be left -in an invalid state. - +The default implementation is @first=G_DATE_MONTH, @sec=G_DATE_DAY and @third=G_DATE_YEAR +(the year is rendered on 4 digits) and the separator is '-' + - TRUE if value has been set - + - + a #GdaHolder object - + filename="libgda/handlers/gda-handler-time.c" + line="109">a #GdaHandlerTime object + - + a #GdaDataHandler to use, or %NULL - + filename="libgda/handlers/gda-handler-time.c" + line="110">what comes first in the date representation + - + a value to set the holder to, as a string - + filename="libgda/handlers/gda-handler-time.c" + line="111">what comes second in the date representation + + + + what comes third in the date representation + + + + separator character used between year, month and day + + + + TRUE if year part of date must be rendered on 2 digits + - + Set @holder's value to its default value. - + filename="libgda/handlers/gda-handler-time.c" + line="139">Specifies the human readable output style of the @dh data handler. +The general format is "FIRSTsSECsTHIRD" +where FIRST, SEC and THIRD are specified by @first, @sec and @trird and 's' is the separator, +specified by @separator. + +The default implementation depends on the current locale, except if @dh was created +using gda_handler_time_new_no_locale(). + - TRUE if @holder has got a default value - + - + a #GdaHolder object - + filename="libgda/handlers/gda-handler-time.c" + line="141">a #GdaHandlerTime object + + + what comes first in the date representation + + + + what comes second in the date representation + + + + what comes third in the date representation + + + + separator character used between year, month and day + + + + TRUE if year part of date must be rendered on 2 digits + + - + + + + + + + + + + + + Creates a data handler for Gda types + + + the new object + + + + + + + + + + + + + + Sets the const value within the holder. If @holder is an alias for another -holder, then the value is also set for that other holder. - -The value will not be freed, and user should take care of it, either for its -freeing or for its correct value at the moment of query. - -If the value is not different from the one already contained within @holder, -then @holder is not changed and no signal is emitted. - -Note1: if @holder can't accept the @value value, then this method returns NULL, and @holder will be left -in an invalid state. - -Note2: before the change is accepted by @holder, the "validate-change" signal will be emitted (the value -of which can prevent the change from happening) which can be connected to to have a greater control -of which values @holder can have, or implement some business rules. - + line="328">Creates a new holder of type @type + NULL if an error occurred or if the previous GValue was NULL itself. It returns -the static GValue user set previously, so that he can free it. - + line="335">a new #GdaHolder object + - - a #GdaHolder object - - - + a const value to set the holder to - + line="330">the #GType requested + - + a boolean set with TRUE if the value changes, FALSE elsewhere. - + line="331">an identifiation + - - + + Sets the value within the holder. If @holder is an alias for another -holder, then the value is also set for that other holder. - -On success, the action of any call to gda_holder_force_invalid() is cancelled -as soon as this method is called (even if @holder's value does not actually change). - -If the value is not different from the one already contained within @holder, -then @holder is not changed and no signal is emitted. - -Note1: if @holder can't accept the @value value, then this method returns FALSE, and @holder will be left -in an invalid state. - -Note2: before the change is accepted by @holder, the "validate-change" signal will be emitted (the value -of which can prevent the change from happening) which can be connected to to have a greater control -of which values @holder can have, or implement some business rules. - -Note3: if user previously set this holder with gda_holder_take_static_value () the GValue -stored internally will be forgiven and replaced by the @value. User should then -take care of the 'old' static GValue. + line="417">Creates a new #GdaHolder object with an ID set to @id, of type @type, +and containing the value passed as the last argument. -Note4: in any case, the caller should not use @value anymore after this function returns because it may -have been freed. If necessary, use gda_holder_get_value() to get the real value. - - +Note that this function is a utility function and that only a limited set of types are supported. Trying +to use an unsupported type will result in a warning, and the returned value holder holding a safe default +value. + + TRUE if value has been set - + line="430">a new #GdaHolder object + - + a #GdaHolder object - - - + line="419">a valid GLib type + + + a value to set the holder to - + line="420">the id of the holder to create, or %NULL + + + + value to set + - - - Tells if @holder's current value is the default one. - + + - TRUE if @holder @holder's current value is the default one - + + + + + + + - a #GdaHolder object - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Defines if the "validate-change" signal gets emitted when -the holder's value changes. - - - - - - - Gets emitted when @holder's value has changed + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets emitted when the data model in which @holder's values should be has changed + line="344">Copy constructor. + +Note1: if @orig is set with a static value (see gda_holder_take_static_value()) +its copy will have a fresh new allocated GValue, so that user should free it when done. + + + a new #GdaHolder object + + + + + a #GdaHolder object to copy + + + + + + Forces a holder to be invalid; to set it valid again, a new value must be assigned +to it using gda_holder_set_value() or gda_holder_take_value(). + +@holder's value is set to %NULL. + - - + + + a #GdaHolder object + + + + + Gets emitted when @holder is set to its default value + line="1356">Forces a holder to be invalid; to set it valid again, a new value must be assigned +to it using gda_holder_set_value() or gda_holder_take_value(). + +@holder's value is set to %NULL. + - - + + + a #GdaHolder object + + + + a #GError explaining why @holder is declared invalid, or %NULL + + + + + Gets emitted when @holder is going to change its value. One can connect to -this signal to control which values @holder can have (for example to implement some business rules) + line="1999">Get an "encoded" version of @holder's name. The "encoding" consists in replacing non +alphanumeric character with the string "__gdaXX" where XX is the hex. representation +of the non alphanumeric char. + +This method is just a wrapper around the gda_text_to_alphanum() function. + NULL if @holder is allowed to change its value to @new_value, or a #GError -otherwise. - + line="2009">a new string + - + the proposed new value for @holder - - + line="2001">a #GdaHolder object + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Locks @lockable. If it is already locked by another thread, the current thread will block until it is unlocked -by the other thread. - -Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock @lockable several times -(and has to unlock it as many times to actually unlock it). - + filename="libgda/gda-holder.c" + line="1982">Get the holder which makes @holder change its value when the holder's value is changed. + - + the #GdaHolder or %NULL + - + a #GdaLockable object. - + filename="libgda/gda-holder.c" + line="1984">a #GdaHolder + - - + + Tries to lock @lockable. If it is already locked by another thread, then it immediately returns FALSE, otherwise -it locks @lockable. - -Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock @lockable several times -(and has to unlock it as many times to actually unlock it). - + filename="libgda/gda-holder.c" + line="1523">Get the default value held into the holder. WARNING: the default value does not need to be of +the same type as the one required by @holder. + TRUE if the object has successfully been locked. - + filename="libgda/gda-holder.c" + line="1530">the default value + - + a #GdaLockable object. - + filename="libgda/gda-holder.c" + line="1525">a #GdaHolder object + - - + + Unlocks @lockable. This method should not be called if the current does not already holds a lock on @lockable (having -used gda_lockable_lock() or gda_lockable_trylock()). - + filename="libgda/gda-holder.c" + line="747">Get @holder's type + - + the data type + - + a #GdaLockable object. - + filename="libgda/gda-holder.c" + line="749">a #GdaHolder object + - - + + Locks @lockable. If it is already locked by another thread, the current thread will block until it is unlocked -by the other thread. - -Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock @lockable several times -(and has to unlock it as many times to actually unlock it). - + filename="libgda/gda-holder.c" + line="764">Get the ID of @holder. The ID can be set using @holder's "id" property + - + the ID (don't modify the string). + - + a #GdaLockable object. - + filename="libgda/gda-holder.c" + line="766">a #GdaHolder object + - + Tries to lock @lockable. If it is already locked by another thread, then it immediately returns FALSE, otherwise -it locks @lockable. - -Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock @lockable several times -(and has to unlock it as many times to actually unlock it). - + filename="libgda/gda-holder.c" + line="1607">Get wether the holder can be NULL or not + TRUE if the object has successfully been locked. + filename="libgda/gda-holder.c" + line="1613">TRUE if the holder cannot be NULL - + a #GdaLockable object. - + filename="libgda/gda-holder.c" + line="1609">a #GdaHolder object + - + Unlocks @lockable. This method should not be called if the current does not already holds a lock on @lockable (having -used gda_lockable_lock() or gda_lockable_trylock()). - + filename="libgda/gda-holder.c" + line="1704">If gda_holder_set_source_model() has been used to provide a hint that @holder's value +should be among the values contained in a column of a data model, then this method +returns which data model, and if @col is not %NULL, then it is set to the restricting column +as well. + +Otherwise, this method returns %NULL, and if @col is not %NULL, then it is set to 0. + - + a pointer to a #GdaDataModel, or %NULL + - + a #GdaLockable object. - + filename="libgda/gda-holder.c" + line="1706">a #GdaHolder + + + a place to store the column in the model sourcing the holder, or %NULL + + - - - - - - - - - - - - - - - a #GdaLockable object. - - - - - - - - - - TRUE if the object has successfully been locked. - - - - - a #GdaLockable object. - - - - - - - - - - - - - - a #GdaLockable object. - - - - - - - - Casts @dbo to a #GdaMetaDbObject, no check is made on the validity of @dbo - - - - a pointer - - - - - Casts @dbo to a #GdaMetaTable, no check is made on the validity of @dbo - - - - - - - - Casts @col to a #GdaMetaTableColumn, no check is made - - - - a pointer - - - - - Casts @fk to a #GdaMetaTableForeignKey (no check is actuelly being done on @fk's validity) - - - - a pointer - - - - - Tells if @fk is an actual foreign key defined in the database's schema, or if it is an indication which -has been added to help Libgda understand the database schema. - - - - a pointer to a #GdaMetaTableForeignKey - - - - - Tells the actual policy implemented by @fk when used in the context of a DELETE. - - - - a pointer to a #GdaMetaTableForeignKey - - - - - Tells the actual policy implemented by @fk when used in the context of an UPDATE. - - - - a pointer to a #GdaMetaTableForeignKey - - - - - Casts @dbo to a #GdaMetaView, no check is made on the validity of @dbo - - - - - - - - The <structname>GdaMetaContext</structname> represents a meta data modification -context: the <emphasis>how</emphasis> when used with gda_meta_store_modify_with_context(), -and the <emphasis>what</emphasis> when used with gda_connection_update_meta_store(). - -To create a new #GdaMetaContext use #gda_meta_context_new. - -To add a new column/value pair use #gda_meta_context_add_column. + + Get the value held into the holder. If @holder is set to use its default value +and that default value is not of the same type as @holder, then %NULL is returned. -To free a #GdaMetaContext, created by #gda_meta_context_new, use #gda_attributes_manager_free. +If @holder is set to NULL, then the returned value is a #GDA_TYPE_NULL GValue. -Since 5.2, you must consider this struct as opaque. Any access to its internal must use public API. -Don't try to use #gda_meta_context_free on a struct that was created manually. - - - the name of the table <emphasis>in the GdaMetaStore's internal database</emphasis> - - - - the size of the @column_names and @column_values arrays - - - - an array of column names (columns of the @table_name table) - - - - - - an array of values, one for each column named in @column_names - - - - - - A #GHashTable storing columns' name as key and #GValue as column's -value. - - - - - - - Creates a new #GdaMetaContext struct with a #GHashTable to store column/value pairs. - - +If @holder is invalid, then the returned value is %NULL. + + a new #GdaMetaContext struct with a new created hash to -store column name/value pairs. - + filename="libgda/gda-holder.c" + line="793">the value, or %NULL + - - + + + a #GdaHolder object + + + + + Copy constructor. - + filename="libgda/gda-holder.c" + line="823">Same functionality as gda_holder_get_value() except that it returns the value as a string +(the conversion is done using @dh if not %NULL, or the default data handler otherwise). + a new #GdaMetaContext - + filename="libgda/gda-holder.c" + line="831">the value, or %NULL + - + a #GdaMetaContext - + filename="libgda/gda-holder.c" + line="825">a #GdaHolder object + + + a #GdaDataHandler to use, or %NULL + + - + Frees any resources taken by @ctx struct. If @ctx is %NULL, then nothing happens. - + filename="libgda/gda-holder.c" + line="1407">Get the validity of @holder (that is, of the value held by @holder) + - + TRUE if @holder's value can safely be used + - + a #GdaMetaContext struct to free - + filename="libgda/gda-holder.c" + line="1409">a #GdaHolder object + - - + + Get the validity of @holder (that is, of the value held by @holder) + the number of columns in the context - + filename="libgda/gda-holder.c" + line="1429">TRUE if @holder's value can safely be used + - + a #GdaMetaContext - + filename="libgda/gda-holder.c" + line="1424">a #GdaHolder object + - + Get table's name to used in the context. - + filename="libgda/gda-holder.c" + line="1764">Sets @holder to change when @bind_to changes (and does not make @bind_to change when @holder changes). +For the operation to succeed, the GType of @holder and @bind_to must be the same, with the exception that +any of them can have a %GDA_TYPE_NULL type (in this situation, the GType of the two #GdaHolder objects +involved is set to match the other when any of them sets its type to something different than GDA_TYPE_NULL). + +If @bind_to is %NULL, then @holder will not be bound anymore. + A string with the table's name used in the context. - + filename="libgda/gda-holder.c" + line="1777">TRUE if no error occurred + - + a #GdaMetaContext struct to get table's name from - + filename="libgda/gda-holder.c" + line="1766">a #GdaHolder + + + a #GdaHolder or %NULL + + - + Sets a new column/value pair to the given context @ctx. Column, must be a column in the given table's -name setted by #gda_meta_context_set_table () (a table in the <link linkend="information_schema">database -schema</link>). If the given @column already exists it's value is overwrited. + filename="libgda/gda-holder.c" + line="1542">Sets the default value within the holder. If @value is %NULL then @holder won't have a +default value anymore. To set a default value to %NULL, then pass a #GValue created using +gda_value_new_null(). -Column's name and value is copied and destroyed when #gda_meta_context_free is called. - +NOTE: the default value does not need to be of the same type as the one required by @holder. + - + a #GdaMetaContext struct to add column/value pais to - + filename="libgda/gda-holder.c" + line="1544">a #GdaHolder object + - - the column's name - - the column's value + filename="libgda/gda-holder.c" + line="1545">a value to set the holder's default value, or %NULL - - a #GdaConnection to be used when identifier are normalized, or NULL - - - + Set columns to use in the context. The #GHashTable use column's name as key and a #GValue as value, -to represent its value. - -@columns incements its reference counting. Is recommended to use #gda_meta_context_free in order to free them. - + filename="libgda/gda-holder.c" + line="1592">Sets if the holder can have a NULL value. If @not_null is TRUE, then that won't be allowed + - + a #GdaMetaContext struct to set colums to - + filename="libgda/gda-holder.c" + line="1594">a #GdaHolder object + - - a #GHashTable with the table's columns' name and their values -to use in context. - - - - - - + a #GdaConnection to used to normalize identifiers quoting, or NULL - + filename="libgda/gda-holder.c" + line="1595">TRUE if @holder should not accept %NULL values + - + Set table's name to use in the context. The table is one of <link linkend="information_schema">database -schema</link> used to store meta information about the database. Use "_tables" to update meta information -about database's tables. - + filename="libgda/gda-holder.c" + line="1624">Sets an hint that @holder's values should be restricted among the values +contained in the @col column of the @model data model. Note that this is just a hint, +meaning this policy is not enforced by @holder's implementation. + +If @model is %NULL, then the effect is to cancel ant previous call to gda_holder_set_source_model() +where @model was not %NULL. + - + TRUE if no error occurred + - + a #GdaMetaContext struct to set table to - + filename="libgda/gda-holder.c" + line="1626">a #GdaHolder object + - + a string with the table's name to use in context - + filename="libgda/gda-holder.c" + line="1627">a #GdaDataModel object or %NULL + + + + the reference column in @model + - + Creates a string representation of given context. - - - a new string with the representation of the context - - - - - a #GdaMetaContext - - - - - - - Struture to hold information about each database object (tables, views, ...), -its contents must not be modified. + filename="libgda/gda-holder.c" + line="865">Sets the value within the holder. If @holder is an alias for another +holder, then the value is also set for that other holder. -Note: @obj_catalog, @obj_schema, @obj_name, @obj_short_name and @obj_full_name respect the -<link linkend="information_schema:sql_identifiers">SQL identifiers</link> convention used in -#GdaMetaStore objects. Before using these SQL identifiers, you should check the -gda_sql_identifier_quote() to know if is it is necessary to surround by double quotes -before using in an SQL statement. - - - - - - - - - - - - the type of object (table, view) - - - - set to %TRUE if the information in this #GdaMetaDbObject may be outdated because the #GdaMetaStore has been updated - - - - the catalog the object is in - - - - the schema the object is in - - - - the object's name - - - - the shortest way to name the object - - - - the full name of the object (in the &lt;schema&gt;.&lt;nameagt; notation - - - - object's owner - - - - list of #GdaMetaDbObject pointers on which this object depends (through foreign keys - or tables used for views) - - - - - - - - - - - - - - - - - - - Type of database object which can be handled as a #GdaMetaDbObject - - - unknown type - - - represents a table - - - represents a view - - - - Defines the filtering policy of a foreign key when invoked on an UPDATE -or DELETE operation. - - - unspecified policy - - - not enforced policy - - - return an error, no action taken - - - same as @GDA_META_FOREIGN_KEY_NO_ACTION, not deferrable - - - policy is to delete any rows referencing the deleted row, or update the value of the referencing column to the new value of the referenced column, respectively - - - policy is to set the referencing column to NULL - - - policy is to set the referencing column to its default value - - - - - - - - - Types of sorting - - - sort alphabetically - - - sort by dependencies - - - - - - Create a new #GdaMetaStore object. - - +On success, the action of any call to gda_holder_force_invalid() is cancelled +as soon as this method is called (even if @holder's value does not actually change) + +If the value is not different from the one already contained within @holder, +then @holder is not changed and no signal is emitted. + +Note1: the @value argument is treated the same way if it is %NULL or if it is a #GDA_TYPE_NULL value + +Note2: if @holder can't accept the @value value, then this method returns FALSE, and @holder will be left +in an invalid state. + +Note3: before the change is accepted by @holder, the "validate-change" signal will be emitted (the value +of which can prevent the change from happening) which can be connected to to have a greater control +of which values @holder can have, or implement some business rules. + + the newly created object, or %NULL if an error occurred - + filename="libgda/gda-holder.c" + line="889">TRUE if value has been set + - + a #GdaHolder object + + + a connection string, or %NULL for an in-memory internal database - - - - - - Create a new #GdaMetaStore object using @file_name as its internal -database - - - the newly created object, or %NULL if an error occurred - - - - - a file name - + filename="libgda/gda-holder.c" + line="868">a value to set the holder to, or %NULL + - - - - - - - + + Use this method to get a correctly quoted (if necessary) SQL identifier which can be used -to retrieve or filter information in a #GdaMetaStore which stores meta data about @cnc. + filename="libgda/gda-holder.c" + line="899">Same functionality as gda_holder_set_value() except that it uses a string representation +of the value to set, which will be converted into a GValue first (using default data handler if +@dh is %NULL). -The returned SQL identifier can be used in conjunction with gda_connection_update_meta_store(), -gda_connection_get_meta_store_data(), gda_connection_get_meta_store_data_v() and -gda_meta_store_extract(). - - +Note1: if @value is %NULL or is the "NULL" string, then @holder's value is set to %NULL. +Note2: if @holder can't accept the @value value, then this method returns FALSE, and @holder will be left +in an invalid state. + + a new string, to free with g_free() once not needed anymore - + filename="libgda/gda-holder.c" + line="914">TRUE if value has been set + - + an SQL identifier - - - + filename="libgda/gda-holder.c" + line="901">a #GdaHolder object + + + a #GdaConnection - + filename="libgda/gda-holder.c" + line="902">a #GdaDataHandler to use, or %NULL + - - - - - - - - - - - - - - - + + a value to set the holder to, as a string + - - - + + + Set @holder's value to its default value. + - - - - - - - - - - - - + TRUE if @holder has got a default value + - - + + a #GdaHolder object + - - - - - + + Creates a new #GdaDataModelArray data model which can be used, after being correctly filled, -with the gda_meta_store_modify*() methods.* + filename="libgda/gda-holder.c" + line="1300">Sets the const value within the holder. If @holder is an alias for another +holder, then the value is also set for that other holder. -To be used by provider's implementation - +The value will not be freed, and user should take care of it, either for its +freeing or for its correct value at the moment of query. + +If the value is not different from the one already contained within @holder, +then @holder is not changed and no signal is emitted. + +Note1: if @holder can't accept the @value value, then this method returns NULL, and @holder will be left +in an invalid state. + +Note2: before the change is accepted by @holder, the "validate-change" signal will be emitted (the value +of which can prevent the change from happening) which can be connected to to have a greater control +of which values @holder can have, or implement some business rules. + a new #GdaDataModel - + filename="libgda/gda-holder.c" + line="1323">NULL if an error occurred or if the previous GValue was NULL itself. It returns +the static GValue user set previously, so that he can free it. + - + a #GdaMetaStore object - + filename="libgda/gda-holder.c" + line="1302">a #GdaHolder object + - + the name of a table present in @store - + filename="libgda/gda-holder.c" + line="1303">a const value to set the holder to + - - - - - - a new #GdaMetaStruct using @store - - - - - a #GdaMetaStore - - - + features of new struct - + filename="libgda/gda-holder.c" + line="1304">a boolean set with TRUE if the value changes, FALSE elsewhere. + - Defines a new declared foreign key into @store. If another declared foreign key is already defined -between the two tables and with the same name, then it is first removed. + filename="libgda/gda-holder.c" + line="952">Sets the value within the holder. If @holder is an alias for another +holder, then the value is also set for that other holder. -This method begins a transaction if possible (ie. none is already started), and if it can't, -then if there is an error, the job may be partially done. +On success, the action of any call to gda_holder_force_invalid() is cancelled +as soon as this method is called (even if @holder's value does not actually change). -A check is always performed to make sure all the database objects actually -exist and returns an error if not. The check is performed using @mstruct if it's not %NULL (in -this case only the tables already represented in @mstruct will be considered, in other words: @mstruct -will not be modified), and using an internal #GdaMetaStruct is %NULL. +If the value is not different from the one already contained within @holder, +then @holder is not changed and no signal is emitted. -The @catalog, @schema, @table, @ref_catalog, @ref_schema and @ref_table must follow the SQL -identifiers naming convention, see the <link linkend="gen:sql_identifiers">SQL identifiers</link> -section. The same convention needs to be respected for the strings in @conames and @ref_colnames. +Note1: if @holder can't accept the @value value, then this method returns FALSE, and @holder will be left +in an invalid state. -If @catalog is not %NULL, then @schema must also be not %NULL (the same restriction applies to -@ref_catalog and @ref_schema). - +Note2: before the change is accepted by @holder, the "validate-change" signal will be emitted (the value +of which can prevent the change from happening) which can be connected to to have a greater control +of which values @holder can have, or implement some business rules. + +Note3: if user previously set this holder with gda_holder_take_static_value () the GValue +stored internally will be forgiven and replaced by the @value. User should then +take care of the 'old' static GValue. + +Note4: in any case, the caller should not use @value anymore after this function returns because it may +have been freed. If necessary, use gda_holder_get_value() to get the real value. + %TRUE if no error occurred + filename="libgda/gda-holder.c" + line="981">TRUE if value has been set - + a #GdaMetaStore - + filename="libgda/gda-holder.c" + line="954">a #GdaHolder object + - - a #GdaMetaStruct, or %NULL - - - - the name of the foreign key to declare - - - - the catalog in which the table (for which the foreign key is for) is, or %NULL - - - - the schema in which the table (for which the foreign key is for) is, or %NULL - - - - the name of the table (for which the foreign key is for) - - - - the catalog in which the referenced table is, or %NULL - - - - the schema in which the referenced table is, or %NULL - - - - the name of the referenced table - - - - the number of columns involved (>0) - - - - an array of column names from the table for which the foreign key is for - - - - - - an array of column names from the referenced table - - - - - - - - Extracts some data stored in @store using a custom SELECT query. If the @select_sql filter involves -SQL identifiers (such as table or column names), then the values should have been adapted using -gda_meta_store_sql_identifier_quote(). - -For more information about -SQL identifiers are represented in @store, see the -<link linkend="information_schema:sql_identifiers">meta data section about SQL identifiers</link>. - - - a new #GdaDataModel, or %NULL if an error occurred - - - - - a #GdaMetaStore object - - - - a SELECT statement - - - - a place to store errors, or %NULL - - - - a list of (variable name (gchar *), GValue *value) terminated with NULL, representing values for all the -variables mentioned in @select_sql. If there is no variable then this part can be omitted. - - - - - - Extracts some data stored in @store using a custom SELECT query. If the @select_sql filter involves -SQL identifiers (such as table or column names), then the values should have been adapted using -gda_meta_store_sql_identifier_quote(). - -For more information about -SQL identifiers are represented in @store, see the -<link linkend="information_schema:sql_identifiers">meta data section about SQL identifiers</link>. - - - a new #GdaDataModel, or %NULL if an error occurred - - - - - a #GdaMetaStore object - - - - a SELECT statement - - - + a hash table with all variables names as keys and GValue* as -value, representing values for all the variables mentioned in @select_sql. If there is no variable then this part can be -omitted. - - - - + filename="libgda/gda-holder.c" + line="955">a value to set the holder to + - + The #GdaMetaStore object maintains a list of (name,value) attributes (attributes names starting with a '_' -character are for internal use only and cannot be altered). This method and the gda_meta_store_set_attribute_value() -method allows the user to add, set or remove attributes specific to their usage. - -This method allows to get the value of a attribute stored in @store. The returned attribute value is -placed at @att_value, the caller is responsible for free that string. - -If there is no attribute named @att_name then @att_value is set to %NULL -and @error will contain the GDA_META_STORE_ATTRIBUTE_NOT_FOUND_ERROR error code, and FALSE is returned. - + filename="libgda/gda-holder.c" + line="1505">Tells if @holder's current value is the default one. + TRUE if no error occurred + filename="libgda/gda-holder.c" + line="1511">TRUE if @holder @holder's current value is the default one - + a #GdaMetaStore object - + filename="libgda/gda-holder.c" + line="1507">a #GdaHolder object + - - name of the attribute to get - - - - the place to store the attribute value - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get a pointer to the #GdaConnection object internally used by @store to store -its contents. - -The returned connection can be used to access some other data than the one managed by @store -itself. The returned object is not owned by the caller (if you need to keep it, then use g_object_ref()). -Do not close the connection. - + filename="libgda/gda-holder.c" + line="275">Defines if the "validate-change" signal gets emitted when +the holder's value changes. + + + + + + + Gets emitted when @holder's value has changed - a #GdaConnection, or %NULL - + - - - a #GdaMetaStore object - - - - - + + Get @store's internal schema's version - + filename="libgda/gda-holder.c" + line="164">Gets emitted when the data model in which @holder's values should be has changed - the version (incremented each time the schema changes, backward compatible) - + - - - a #GdaMetaStore object - - - - - + + Propagates an update to @store, the update's contents is represented by @new_data, this function is -primarily reserved to database providers. - -For example tell @store to update its list of tables, @new_data should contain the same columns as the "_tables" -table of @store, and contain one row per table in the store; there should not be any more argument after the @error -argument. - -Now, to update only one table, the @new_data data model should have one row for the table to update (or no row -at all if the table does not exist anymore), and have values for the primary key of the "_tables" table of -@store, namely "table_catalog", "table_schema" and "table_name". - + filename="libgda/gda-holder.c" + line="209">Gets emitted when @holder is set to its default value - TRUE if no error occurred - + - - - a #GdaMetaStore object - - - - the name of the table to modify within @store - - - - a #GdaDataModel containing the new data to set in @table_name, or %NULL (treated as a data model -with no row at all) - - - - SQL expression (which may contain variables) defining the rows which are being obsoleted by @new_data, or %NULL - - - - a place to store errors, or %NULL - - - - a list of (variable name (gchar *), GValue *value) terminated with NULL, representing values for all the -variables mentioned in @condition. - - - - - + + Propagates an update to @store, the update's contents is represented by @new_data, this function is -primarily reserved to database providers. - - + filename="libgda/gda-holder.c" + line="191">Gets emitted when @holder is going to change its value. One can connect to +this signal to control which values @holder can have (for example to implement some business rules) + %TRUE if no error occurred - + filename="libgda/gda-holder.c" + line="199">NULL if @holder is allowed to change its value to @new_value, or a #GError +otherwise. + - - a #GdaMetaStore object - - - - the name of the table to modify within @store - - - - a #GdaDataModel containing the new data to set in @table_name, or %NULL (treated as a data model -with no row at all) - - - - SQL expression (which may contain variables) defining the rows which are being obsoleted by @new_data, or %NULL - - - - number of values in @value_names and @values - - - - names of values - - - - - + values - - - + filename="libgda/gda-holder.c" + line="194">the proposed new value for @holder + - - - Propagates an update to @store, the update's contents is represented by @new_data, this function is -primarily reserved to database providers. - - - TRUE if no error occurred - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - a #GdaMetaStore object - + + - - a #GdaMetaContext context describing what to modify in @store - - - - a #GdaDataModel containing the new data to set in @table_name, or %NULL (treated as a data model -with no row at all) - - - - - The internal database used by @store can be 'augmented' with some user-defined database objects -(such as tables or views). This method allows one to add a new database object. - -If the internal database already contains the object, then: -<itemizedlist> - <listitem><para>if the object is equal to the provided description then TRUE is returned</para></listitem> - <listitem><para>if the object exists but differs from the provided description, then FALSE is returned, - with the GDA_META_STORE_SCHEMA_OBJECT_CONFLICT_ERROR error code</para></listitem> -</itemizedlist> - -The @xml_description defines the table of view's definition, for example: -<programlisting><![CDATA[<table name="mytable"> - <column name="id" pkey="TRUE"/> - <column name="value"/> -</table>]]></programlisting> - -The partial DTD for this XML description of the object to add is the following (the top node must be -a &lt;table&gt; or a &lt;view&gt;): -<programlisting><![CDATA[<!ELEMENT table (column*,check*,fkey*)> -<!ATTLIST table - name NMTOKEN #REQUIRED> - -<!ELEMENT column EMPTY> -<!ATTLIST column - name NMTOKEN #REQUIRED - type CDATA #IMPLIED - pkey (TRUE|FALSE) #IMPLIED - autoinc (TRUE|FALSE) #IMPLIED - nullok (TRUE|FALSE) #IMPLIED> - -<!ELEMENT check (#PCDATA)> - -<!ELEMENT fkey (part+)> -<!ATTLIST fkey - ref_table NMTOKEN #REQUIRED> - -<!ELEMENT part EMPTY> -<!ATTLIST part - column NMTOKEN #IMPLIED - ref_column NMTOKEN #IMPLIED> - -<!ELEMENT view (definition)> -<!ATTLIST view - name NMTOKEN #REQUIRED - descr CDATA #IMPLIED> - -<!ELEMENT definition (#PCDATA)>]]></programlisting> - + + + - TRUE if the new object has successfully been added - + - - a #GdaMetaStore object - + + - - an XML description of the table or view to add to @store - - - - - Get an ordered list of the tables @store knows about. The tables are ordered in a way that tables dependencies -are respected: if table B has a foreign key on table A, then table A will be listed before table B in the returned -list. - - - a new list of tables names (as gchar*), the list must be freed when no longer needed, but the strings present in the list must not be modified. - - - + + + + + - - a #GdaMetaStore object - + + - - Get an ordered list of the tables @store knows about on which the @table_name table depends (recursively). -The tables are ordered in a way that tables dependencies -are respected: if table B has a foreign key on table A, then table A will be listed before table B in the returned -list. - - - a new list of tables names (as gchar*), the list must be freed when no longer needed, but the strings present in the list must not be modified. - - - + + + + - - a #GdaMetaStore object - + + - - the name of the table for which all the dependencies must be listed - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new #GdaMetaStruct object representing @store's internal database structure. - - - a new #GdaMetaStruct object, or %NULL if an error occurred - + filename="libgda/gda-lockable.c" + line="29">Locks @lockable. If it is already locked by another thread, the current thread will block until it is unlocked +by the other thread. + +Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock @lockable several times +(and has to unlock it as many times to actually unlock it). + + + - + a #GdaMetaStore object - + filename="libgda/gda-lockable.c" + line="31">a #GdaLockable object. + - - + + Removes the custom database object named @obj_name. - + filename="libgda/gda-lockable.c" + line="50">Tries to lock @lockable. If it is already locked by another thread, then it immediately returns FALSE, otherwise +it locks @lockable. + +Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock @lockable several times +(and has to unlock it as many times to actually unlock it). + TRUE if the custom object has successfully been removed + filename="libgda/gda-lockable.c" + line="60">TRUE if the object has successfully been locked. - + a #GdaMetaStore object - + filename="libgda/gda-lockable.c" + line="52">a #GdaLockable object. + - - name of the custom object to remove - - - - - - Set the value of the attribute named @att_name to @att_value; see gda_meta_store_get_attribute_value() for -more information. - - - TRUE if no error occurred - - - - - a #GdaMetaStore object - - - - name of the attribute to set - - - - value of the attribute to set, or %NULL to unset the attribute - - - - + + Specifies how @store must handle SQL identifiers it has to store. This method is mainly used by -database providers. - + filename="libgda/gda-lockable.c" + line="75">Unlocks @lockable. This method should not be called if the current does not already holds a lock on @lockable (having +used gda_lockable_lock() or gda_lockable_trylock()). + - + a #GdaMetaStore object - + filename="libgda/gda-lockable.c" + line="77">a #GdaLockable object. + - - a style - - - - + + Specifies a function which @store will use to determine if a keyword is an SQL reserved -keyword or not. + filename="libgda/gda-lockable.c" + line="29">Locks @lockable. If it is already locked by another thread, the current thread will block until it is unlocked +by the other thread. -This method is mainly used by database providers. - +Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock @lockable several times +(and has to unlock it as many times to actually unlock it). + - + a #GdaMetaStore object - + filename="libgda/gda-lockable.c" + line="31">a #GdaLockable object. + - - a #GdaSqlReservedKeywordsFunc function, or %NULL - - - + Removes a declared foreign key from @store. - -This method begins a transaction if possible (ie. none is already started), and if it can't, then if there -is an error, the job may be partially done. - -A check is always performed to make sure all the database objects actually -exist and returns an error if not. The check is performed using @mstruct if it's not %NULL (in -this case only the tables already represented in @mstruct will be considered, in other words: @mstruct -will not be modified), and using an internal #GdaMetaStruct is %NULL. + filename="libgda/gda-lockable.c" + line="50">Tries to lock @lockable. If it is already locked by another thread, then it immediately returns FALSE, otherwise +it locks @lockable. -See gda_meta_store_declare_foreign_key() for more information anout the @catalog, @schema, @name, -@ref_catalog, @ref_schema and @ref_name arguments. - +Note: unlike g_mutex_lock(), this method recursive, which means a thread can lock @lockable several times +(and has to unlock it as many times to actually unlock it). + %TRUE if no error occurred + filename="libgda/gda-lockable.c" + line="60">TRUE if the object has successfully been locked. - + a #GdaMetaStore - + filename="libgda/gda-lockable.c" + line="52">a #GdaLockable object. + - - a #GdaMetaStruct, or %NULL - - - - the name of the foreign key to declare - - - - the catalog in which the table (for which the foreign key is for) is, or %NULL - - - - the schema in which the table (for which the foreign key is for) is, or %NULL - - - - the name of the table (for which the foreign key is for) - - - - the catalog in which the referenced table is, or %NULL - - - - the schema in which the referenced table is, or %NULL - - - - the name of the referenced table - - - - - - - - - - - - - - - - - - - This signal is emitted when the @store's contents have changed (the changes are in the @changes list) - - - - - - a list of changes made, as a #GSList of pointers to #GdaMetaStoreChange (which must not be modified) - - - - - - - - This signal is emitted when the @store's contents have been reset completely and when -no detailed changes are available - - - - - - This signal is emitted when the contents of a table should be updated (data to update or insert only; -deleting data is done automatically). This signal is used for internal purposes by the #GdaConnection -object. - - a new #GError error structure if there was an error when processing the -signal, or %NULL if signal propagation should continue - - - - - the suggested update, as a #GdaMetaContext structure - - - - - - - - + Creates a new #GdaMetaStoreChange - - - - - - - - - a new #GdaMetaStoreChange - - - - - a #GdaMetaStoreChange - - - - - - - - - - - - a #GdaMetaStoreChange to be freed - - - - - - - - - - - - - - - - - - - hash table with string key key = ('+' or '-') and a column position in @table (string) starting at 0 and value as #GValue pointer - - - - - - - - a #GdaMetaStoreChange - - - - - - - - a string with the table name - - - - - a #GdaMetaStoreChange - - - - - - - - - - - - - - - - - - - - + filename="libgda/gda-lockable.c" + line="75">Unlocks @lockable. This method should not be called if the current does not already holds a lock on @lockable (having +used gda_lockable_lock() or gda_lockable_trylock()). + - + a #GdaMetaStoreChange - + filename="libgda/gda-lockable.c" + line="77">a #GdaLockable object. + - - name of the table - - - - - - - - - - - - - - - - + + + + + - - - + + + - - + + a #GdaLockable object. + - - - - - + + + + + TRUE if the object has successfully been locked. + - - - - - + + a #GdaLockable object. + - - - + + + - - - - - - - + + a #GdaLockable object. + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Creates a new #GdaMetaDbObject structure in @mstruct to represent the database object (of type @type) -which can be uniquely identified as @catalog.@schema.@name. - -If @catalog is not %NULL, then @schema should not be %NULL. - -If both @catalog and @schema are %NULL, then the database object will be the one which is -"visible" by default (that is which can be accessed only by its short @name name). - -If @catalog is %NULL and @schema is not %NULL, then the database object will be the one which -can be accessed by its @schema.@name name. - -Important note: @catalog, @schema and @name will be used using the following convention: -<itemizedlist> - <listitem><para>be surrounded by double quotes for a case sensitive search</para></listitem> - <listitem><para>otherwise for case insensitive search</para></listitem> -</itemizedlist> - -For more information, see the <link linkend="information_schema:sql_identifiers"> -meta data section about SQL identifiers</link>. - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Casts @dbo to a #GdaMetaDbObject, no check is made on the validity of @dbo + + + the #GdaMetaDbObject corresponding to the database object if no error occurred, or %NULL - + filename="libgda/gda-meta-struct.h" + line="214">a pointer + + + + + Casts @dbo to a #GdaMetaTable, no check is made on the validity of @dbo + + + + + + + + Casts @col to a #GdaMetaTableColumn, no check is made + + + + a pointer + + + + + Casts @fk to a #GdaMetaTableForeignKey (no check is actuelly being done on @fk's validity) + + + + a pointer + + + + + Tells if @fk is an actual foreign key defined in the database's schema, or if it is an indication which +has been added to help Libgda understand the database schema. + + + + a pointer to a #GdaMetaTableForeignKey + + + + + Tells the actual policy implemented by @fk when used in the context of a DELETE. + + + + a pointer to a #GdaMetaTableForeignKey + + + + + Tells the actual policy implemented by @fk when used in the context of an UPDATE. + + + + a pointer to a #GdaMetaTableForeignKey + + + + + + + + + + + + Casts @dbo to a #GdaMetaView, no check is made on the validity of @dbo + + + + + + + + + + + + - - a #GdaMetaStruct object - + + - - the type of object to add (which can be GDA_META_DB_UNKNOWN) - - - - the catalog the object belongs to (as a G_TYPE_STRING GValue), or %NULL - - - - the schema the object belongs to (as a G_TYPE_STRING GValue), or %NULL - - - - the object's name (as a G_TYPE_STRING GValue), not %NULL - - - - - This method is similar to gda_meta_struct_complement() and gda_meta_struct_complement_default() -but creates #GdaMetaDbObject for all the database object. - -Please refer to gda_meta_struct_complement() form more information. - - - TRUE if no error occurred - + + + + + - - a #GdaMetaStruct object - + + - - - This method is similar to gda_meta_struct_complement() and gda_meta_struct_complement_all() -but creates #GdaMetaDbObject for all the -database object which are usable using only their short name (that is which do not need to be prefixed by -the schema in which they are to be used). - -Please refer to gda_meta_struct_complement() form more information. - - - TRUE if no error occurred - + + + + + - - a #GdaMetaStruct object - + + - - - This method is similar to gda_meta_struct_complement() but creates #GdaMetaDbObject for all the dependencies -of @dbo. - -Please refer to gda_meta_struct_complement() form more information. - + + + - TRUE if no error occurred - + - - a #GdaMetaStruct object - + + - - a #GdaMetaDbObject part of @mstruct - + + - - - This method is similar to gda_meta_struct_complement() but creates #GdaMetaDbObject for all the -database object which are in the @schema schema (and in the @catalog catalog). -If @catalog is %NULL, then any catalog will be used, and -if @schema is %NULL then any schema will be used (if @schema is %NULL then catalog must also be %NULL). - -Please refer to gda_meta_struct_complement() form more information. - - - TRUE if no error occurred - + + + + + - - a #GdaMetaStruct object - + + - - name of a catalog, or %NULL - - - - name of a schema, or %NULL - - - - Creates a new graph (in the GraphViz syntax) representation of @mstruct. - - - a new string, or %NULL if an error occurred. - + + + + - - a #GdaMetaStruct object - + + - - informs what kind of information to show in the resulting graph - - - - Get a list of all the #GdaMetaDbObject structures representing database objects in @mstruct. Note that -no #GdaMetaDbObject structure must not be modified. - - - a new #GSList list of pointers to -#GdaMetaDbObject structures which must be destroyed after usage using g_slist_free(). The individual -#GdaMetaDbObject must not be modified. - - - + + + + - - a #GdaMetaStruct object - + + - - Tries to locate the #GdaMetaDbObject structure representing the database object named after -@catalog, @schema and @name. - -If one or both of @catalog and @schema are %NULL, and more than one database object matches the name, then -the return value is also %NULL. - - - the #GdaMetaDbObject or %NULL if not found - + + + + - - a #GdaMetaStruct object - + + - - the catalog the object belongs to (as a G_TYPE_STRING GValue), or %NULL - - - - the schema the object belongs to (as a G_TYPE_STRING GValue), or %NULL - - - - the object's name (as a G_TYPE_STRING GValue), not %NULL - + + - - Tries to find the #GdaMetaTableColumn representing the column named @col_name in @table. - - - the #GdaMetaTableColumn or %NULL if not found - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - a #GdaMetaStruct object - + + - - the #GdaMetaTable structure to find the column for - - - - the name of the column to find (as a G_TYPE_STRING GValue) - - - - - Loads an XML description into @mstruct. This method is still experimental and no description -the XML file structure is given, and no guarantee that it will remain as it is given. - + + + - TRUE if no error has occurred - + - - a #GdaMetaStruct object - + + - - the catalog name, or %NULL - - - - the schema name, or %NULL - - - - the specifications as the name of an XML file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - Reorders the list of database objects within @mstruct in a way specified by @sort_type. - + + - TRUE if no error occurred - + - - a #GdaMetaStruct object - + + - - the kind of sorting requested - + + + + + + + + + + + + + + + + + + + + + + + + - - + getter="get_column_type"> + - + + + - + transfer-ownership="none" + setter="set_name" + getter="get_name" + default-value="NULL"> + - - - - - - - - + + + + + - - - + + + - + + + + + + - - - + + + + + + + + + + + - - - + + + - + + + + + + - - - + + + - + + + + + + - - - - - - - - - - - - - Controls which features are computed about database objects. - - - database objects only have their own attributes - - - foreign keys are computed for tables - - - for views, the tables they use are also computed - - - all the features are computed - - - + This structure specifies a #GdaMetaDbObject to represent a table's specific attributes, -its contents must not be modified. + filename="libgda/gda-meta-store.h" + line="88">The <structname>GdaMetaContext</structname> represents a meta data modification +context: the <emphasis>how</emphasis> when used with gda_meta_store_modify_with_context(), +and the <emphasis>what</emphasis> when used with gda_connection_update_meta_store(). -Note that in some cases, the columns cannot be determined for views, and in this case the -@columns will be %NULL (this can be the case for example with SQLite where a view -uses a function which is not natively provided by SQLite. - - +To create a new #GdaMetaContext use #gda_meta_context_new. + +To add a new column/value pair use #gda_meta_context_add_column. + +To free a #GdaMetaContext, created by #gda_meta_context_new, use #gda_attributes_manager_free. + +Since 5.2, you must consider this struct as opaque. Any access to its internal must use public API. +Don't try to use #gda_meta_context_free on a struct that was created manually. + + list of #GdaMetaTableColumn structures, one for each column in the table - - - + filename="libgda/gda-meta-store.h" + line="90">the name of the table <emphasis>in the GdaMetaStore's internal database</emphasis> + - + index of the columns part of the primary key for the table (WARNING: columns numbering - here start at 0) - + filename="libgda/gda-meta-store.h" + line="91">the size of the @column_names and @column_values arrays + - + size of the @pk_cols_array array - + filename="libgda/gda-meta-store.h" + line="92">an array of column names (columns of the @table_name table) + + + - + list of #GdaMetaTableForeignKey where the referenced table is this table - - - + filename="libgda/gda-meta-store.h" + line="93">an array of values, one for each column named in @column_names + + + - + list of #GdaMetaTableForeignKey for this table - - + filename="libgda/gda-meta-store.h" + line="94">A #GHashTable storing columns' name as key and #GValue as column's +value. + + + - - - - - - - - - - - - - - - This structure represents a table of view's column, its contents must not be modified. - - + the column's name - - - + filename="libgda/gda-meta-store.c" + line="245">Creates a new #GdaMetaContext struct with a #GHashTable to store column/value pairs. + + + a new #GdaMetaContext struct with a new created hash to +store column name/value pairs. + + + + the column's DBMS's type - - - + filename="libgda/gda-meta-store.c" + line="265">Copy constructor. + + + a new #GdaMetaContext + + + + + a #GdaMetaContext + + + + + the detected column's #GType - - - + filename="libgda/gda-meta-store.c" + line="403">Frees any resources taken by @ctx struct. If @ctx is %NULL, then nothing happens. + + + + + + + a #GdaMetaContext struct to free + + + + + + + + the number of columns in the context + + + + + a #GdaMetaContext + + + + + tells if the column is part of a primary key - - - + filename="libgda/gda-meta-store.c" + line="306">Get table's name to used in the context. + + + A string with the table's name used in the context. + + + + + a #GdaMetaContext struct to get table's name from + + + + + tells if the column can be %NULL - - - + filename="libgda/gda-meta-store.c" + line="323">Sets a new column/value pair to the given context @ctx. Column, must be a column in the given table's +name setted by #gda_meta_context_set_table () (a table in the <link linkend="information_schema">database +schema</link>). If the given @column already exists it's value is overwrited. + +Column's name and value is copied and destroyed when #gda_meta_context_free is called. + + + + + + + a #GdaMetaContext struct to add column/value pais to + + + + the column's name + + + + the column's value + + + + a #GdaConnection to be used when identifier are normalized, or NULL + + + + + the column's default value, represented as a valid SQL value (surrounded by simple quotes for strings, ...), or %NULL if column has no default value - - - - - - - - - - - - - - - - - - - - + filename="libgda/gda-meta-store.c" + line="353">Set columns to use in the context. The #GHashTable use column's name as key and a #GValue as value, +to represent its value. + +@columns incements its reference counting. Is recommended to use #gda_meta_context_free in order to free them. + + + + + + + a #GdaMetaContext struct to set colums to + + + + a #GHashTable with the table's columns' name and their values +to use in context. + + + + + + + a #GdaConnection to used to normalize identifiers quoting, or NULL + + + + + + Set table's name to use in the context. The table is one of <link linkend="information_schema">database +schema</link> used to store meta information about the database. Use "_tables" to update meta information +about database's tables. + + + + + + + a #GdaMetaContext struct to set table to + + + + a string with the table's name to use in context + + + + + + Creates a string representation of given context. + + + a new string with the representation of the context + + + + + a #GdaMetaContext + + + + - + This structure represents a foreign key constraint, its contents must not be modified. - - + line="164">Struture to hold information about each database object (tables, views, ...), +its contents must not be modified. + +Note: @obj_catalog, @obj_schema, @obj_name, @obj_short_name and @obj_full_name respect the +<link linkend="information_schema:sql_identifiers">SQL identifiers</link> convention used in +#GdaMetaStore objects. Before using these SQL identifiers, you should check the +gda_sql_identifier_quote() to know if is it is necessary to surround by double quotes +before using in an SQL statement. + + + + + + + + + + + the #GdaMetaDbObject for which this structure represents a foreign key - + line="167">the type of object (table, view) + - + the #GdaMetaDbObject which is referenced by the foreign key - + line="168">set to %TRUE if the information in this #GdaMetaDbObject may be outdated because the #GdaMetaStore has been updated + - + the size of the @fk_cols_array, @fk_names_array, @ref_pk_cols_array and @ref_pk_names_array arrays - + line="169">the catalog the object is in + - + the columns' indexes in @meta_table which participate in the constraint (WARNING: columns numbering - here start at 1) - + line="170">the schema the object is in + - + the columns' names in @meta_table which participate in the constraint - + line="171">the object's name + - + the columns' indexes in @depend_on which participate in the constraint (WARNING: columns numbering - here start at 1) - + line="172">the shortest way to name the object + - + the columns' names in @depend_on which participate in the constraint - - - - - - - - - - + line="173">the full name of the object (in the &lt;schema&gt;.&lt;nameagt; notation + - + + object's owner + + list of #GdaMetaDbObject pointers on which this object depends (through foreign keys + or tables used for views) + + + + @@ -21827,6123 +23380,10489 @@ uses a function which is not natively provided by SQLite. - + This structure specifies a #GdaMetaDbObject to represent a view's specific attributes, -its contents must not be modified. - - + line="58">Type of database object which can be handled as a #GdaMetaDbObject + + a view is also a table as it has columns - - - + line="60">unknown type + + views' definition - - - + line="61">represents a table + + tells if the view's contents can be updated - - - - - - - - - - - - - - - - - - + line="62">represents a view + + + Holds numbers represented as strings. - -This struct must be considered as opaque. Any access to its members must use its -accessors added since version 5.0.2. - - + filename="libgda/gda-meta-struct.h" + line="282">Defines the filtering policy of a foreign key when invoked on an UPDATE +or DELETE operation. + + Creates a new #GdaNumeric with defaults. - + filename="libgda/gda-meta-struct.h" + line="284">unspecified policy + + + not enforced policy + + + return an error, no action taken + + + same as @GDA_META_FOREIGN_KEY_NO_ACTION, not deferrable + + + policy is to delete any rows referencing the deleted row, or update the value of the referencing column to the new value of the referenced column, respectively + + + policy is to set the referencing column to NULL + + + policy is to set the referencing column to its default value + + + + + + + + + Types of sorting + + + sort alphabetically + + + sort by dependencies + + + + + + Create a new #GdaMetaStore object. + a new #GdaNumeric. - + filename="libgda/gda-meta-store.c" + line="1048">the newly created object, or %NULL if an error occurred + + + + a connection string, or %NULL for an in-memory internal database + + + - + Creates a new #GdaNumeric structure from an existing one. - + filename="libgda/gda-meta-store.c" + line="1012">Create a new #GdaMetaStore object using @file_name as its internal +database + a newly allocated #GdaNumeric which contains a copy of information in @boxed. - -Free-function: gda_numeric_free - + filename="libgda/gda-meta-store.c" + line="1019">the newly created object, or %NULL if an error occurred + - + source to get a copy from. - - + filename="libgda/gda-meta-store.c" + line="1014">a file name + + - - + + + + + + + Deallocates all memory associated to the given @boxed - + filename="libgda/gda-meta-store.c" + line="2948">Use this method to get a correctly quoted (if necessary) SQL identifier which can be used +to retrieve or filter information in a #GdaMetaStore which stores meta data about @cnc. + +The returned SQL identifier can be used in conjunction with gda_connection_update_meta_store(), +gda_connection_get_meta_store_data(), gda_connection_get_meta_store_data_v() and +gda_meta_store_extract(). + + + a new string, to free with g_free() once not needed anymore + + + + + an SQL identifier + + + + a #GdaConnection + + + + + + - - a #GdaNumeric pointer - + + + + + + + - - - + + + - a #gdouble representation of @numeric - + - - a #GdaNumeric - + + - - - Gets the precision of a #GdaNumeric. - - - an integer with the precision of a #GdaNumeric. - + + + + + - - a #GdaNumeric - + + + + + - - + + Get the string representation of @numeric, in the C locale format (dot as a fraction separator). - - + filename="libgda/gda-meta-store.c" + line="4044">Creates a new #GdaDataModelArray data model which can be used, after being correctly filled, +with the gda_meta_store_modify*() methods.* + +To be used by provider's implementation + + a new string representing the stored valued in @numeric - + filename="libgda/gda-meta-store.c" + line="4054">a new #GdaDataModel + - + a #GdaNumeric - + filename="libgda/gda-meta-store.c" + line="4046">a #GdaMetaStore object + + + the name of a table present in @store + + - - Gets the width of a #GdaNumeric. (Not yet implemented). - - + + + an integer with the width of a #GdaNumeric. (Not jet implemented). - + filename="libgda/gda-meta-store.c" + line="5449">a new #GdaMetaStruct using @store + - + a #GdaNumeric - + filename="libgda/gda-meta-store.c" + line="5446">a #GdaMetaStore + + + features of new struct + + - + Sets @numeric using a #gdouble represented by @number. - + filename="libgda/gda-meta-store.c" + line="5047">Defines a new declared foreign key into @store. If another declared foreign key is already defined +between the two tables and with the same name, then it is first removed. + +This method begins a transaction if possible (ie. none is already started), and if it can't, +then if there is an error, the job may be partially done. + +A check is always performed to make sure all the database objects actually +exist and returns an error if not. The check is performed using @mstruct if it's not %NULL (in +this case only the tables already represented in @mstruct will be considered, in other words: @mstruct +will not be modified), and using an internal #GdaMetaStruct is %NULL. + +The @catalog, @schema, @table, @ref_catalog, @ref_schema and @ref_table must follow the SQL +identifiers naming convention, see the <link linkend="gen:sql_identifiers">SQL identifiers</link> +section. The same convention needs to be respected for the strings in @conames and @ref_colnames. + +If @catalog is not %NULL, then @schema must also be not %NULL (the same restriction applies to +@ref_catalog and @ref_schema). + - + %TRUE if no error occurred + - + a #GdaNumeric - + filename="libgda/gda-meta-store.c" + line="5049">a #GdaMetaStore + - + a #gdouble - + filename="libgda/gda-meta-store.c" + line="5050">a #GdaMetaStruct, or %NULL + - - - - Sets @numeric with a number represented by @str, in the C locale format (dot as a fraction separator). - - - - - - + a #GdaNumeric - - - + filename="libgda/gda-meta-store.c" + line="5051">the name of the foreign key to declare + + + a string representing a number, in the C locale format + filename="libgda/gda-meta-store.c" + line="5052">the catalog in which the table (for which the foreign key is for) is, or %NULL - - - - Sets the precision of a #GdaNumeric. - - - - - - + a #GdaNumeric - - - + filename="libgda/gda-meta-store.c" + line="5053">the schema in which the table (for which the foreign key is for) is, or %NULL + + + a #glong - + filename="libgda/gda-meta-store.c" + line="5054">the name of the table (for which the foreign key is for) + - - - - Sets the width of a #GdaNumeric. (Not yet implemented). - - - - - - + a #GdaNumeric - - - + filename="libgda/gda-meta-store.c" + line="5055">the catalog in which the referenced table is, or %NULL + + + a #glong - + filename="libgda/gda-meta-store.c" + line="5056">the schema in which the referenced table is, or %NULL + + + + the name of the referenced table + + + + the number of columns involved (>0) + + + + an array of column names from the table for which the foreign key is for + + + + + + an array of column names from the referenced table + + + - - - - + Copies @src's data to @dest - - - + filename="libgda/gda-meta-store.c" + line="2975">Extracts some data stored in @store using a custom SELECT query. If the @select_sql filter involves +SQL identifiers (such as table or column names), then the values should have been adapted using +gda_meta_store_sql_identifier_quote(). + +For more information about +SQL identifiers are represented in @store, see the +<link linkend="information_schema:sql_identifiers">meta data section about SQL identifiers</link>. + + + a new #GdaDataModel, or %NULL if an error occurred + - + a #GdaPStmt object - + filename="libgda/gda-meta-store.c" + line="2977">a #GdaMetaStore object + - + a #GdaPStmt object - + filename="libgda/gda-meta-store.c" + line="2978">a SELECT statement + + + + a place to store errors, or %NULL + + + + a list of (variable name (gchar *), GValue *value) terminated with NULL, representing values for all the +variables mentioned in @select_sql. If there is no variable then this part can be omitted. + - + Get a pointer to the #GdaStatement which led to the creation of this prepared statement. + filename="libgda/gda-meta-store.c" + line="3096">Extracts some data stored in @store using a custom SELECT query. If the @select_sql filter involves +SQL identifiers (such as table or column names), then the values should have been adapted using +gda_meta_store_sql_identifier_quote(). -Note: if that statement has been modified since the creation of @pstmt, then this method -will return %NULL - +For more information about +SQL identifiers are represented in @store, see the +<link linkend="information_schema:sql_identifiers">meta data section about SQL identifiers</link>. + the #GdaStatement - + filename="libgda/gda-meta-store.c" + line="3113">a new #GdaDataModel, or %NULL if an error occurred + - + a #GdaPStmt object - + filename="libgda/gda-meta-store.c" + line="3098">a #GdaMetaStore object + + + a SELECT statement + + + + a hash table with all variables names as keys and GValue* as +value, representing values for all the variables mentioned in @select_sql. If there is no variable then this part can be +omitted. + + + + + - - + + The #GdaMetaStore object maintains a list of (name,value) attributes (attributes names starting with a '_' +character are for internal use only and cannot be altered). This method and the gda_meta_store_set_attribute_value() +method allows the user to add, set or remove attributes specific to their usage. + +This method allows to get the value of a attribute stored in @store. The returned attribute value is +placed at @att_value, the caller is responsible for free that string. + +If there is no attribute named @att_name then @att_value is set to %NULL +and @error will contain the GDA_META_STORE_ATTRIBUTE_NOT_FOUND_ERROR error code, and FALSE is returned. + number of columns or -1 if something is wrong - + filename="libgda/gda-meta-store.c" + line="4305">TRUE if no error occurred + - - + + a #GdaMetaStore object + + + name of the attribute to get + + + + the place to store the attribute value + + - + List of parameters' IDs (as gchar *) - + filename="libgda/gda-meta-store.c" + line="2927">Get a pointer to the #GdaConnection object internally used by @store to store +its contents. + +The returned connection can be used to access some other data than the one managed by @store +itself. The returned object is not owned by the caller (if you need to keep it, then use g_object_ref()). +Do not close the connection. + a list of string with parameters ID's - - - + filename="libgda/gda-meta-store.c" + line="2938">a #GdaConnection, or %NULL + - - + + a #GdaMetaStore object + - + Actual SQL code used for this prepared statement, mem freed by GdaPStmt - + filename="libgda/gda-meta-store.c" + line="2911">Get @store's internal schema's version + SQL command used - + filename="libgda/gda-meta-store.c" + line="2917">the version (incremented each time the schema changes, backward compatible) + - - + + a #GdaMetaStore object + - + List of #GdaColumn objects which data models created from this -prepared statement can copy - + filename="libgda/gda-meta-store.c" + line="3222">Propagates an update to @store, the update's contents is represented by @new_data, this function is +primarily reserved to database providers. + +For example tell @store to update its list of tables, @new_data should contain the same columns as the "_tables" +table of @store, and contain one row per table in the store; there should not be any more argument after the @error +argument. + +Now, to update only one table, the @new_data data model should have one row for the table to update (or no row +at all if the table does not exist anymore), and have values for the primary key of the "_tables" table of +@store, namely "table_catalog", "table_schema" and "table_name". + a list of #GdaColumn objects - - - + filename="libgda/gda-meta-store.c" + line="3244">TRUE if no error occurred + - - + + a #GdaMetaStore object + + + the name of the table to modify within @store + + + + a #GdaDataModel containing the new data to set in @table_name, or %NULL (treated as a data model +with no row at all) + + + + SQL expression (which may contain variables) defining the rows which are being obsoleted by @new_data, or %NULL + + + + a place to store errors, or %NULL + + + + a list of (variable name (gchar *), GValue *value) terminated with NULL, representing values for all the +variables mentioned in @condition. + + - + Set column's types for statement. @types will be stolen and should -no be modified anymore. - + filename="libgda/gda-meta-store.c" + line="3341">Propagates an update to @store, the update's contents is represented by @new_data, this function is +primarily reserved to database providers. + an array of #GType used in the columns - - - - - - - - - - - - Set column's types for statement. @types is stalen and should -no be modified - - - + filename="libgda/gda-meta-store.c" + line="3356">%TRUE if no error occurred + - + a #GdaPStmt - + filename="libgda/gda-meta-store.c" + line="3343">a #GdaMetaStore object + - + number of columns and size of given array + filename="libgda/gda-meta-store.c" + line="3344">the name of the table to modify within @store + + + + a #GdaDataModel containing the new data to set in @table_name, or %NULL (treated as a data model +with no row at all) + + + + SQL expression (which may contain variables) defining the rows which are being obsoleted by @new_data, or %NULL + + + + number of values in @value_names and @values - + an array of types to use for each column - - + filename="libgda/gda-meta-store.c" + line="3349">names of values + + + + + + values + + - + Informs @pstmt that it corresponds to the preparation of the @stmt statement - + filename="libgda/gda-meta-store.c" + line="3290">Propagates an update to @store, the update's contents is represented by @new_data, this function is +primarily reserved to database providers. + - + TRUE if no error occurred + - + a #GdaPStmt object - + filename="libgda/gda-meta-store.c" + line="3292">a #GdaMetaStore object + - + a #GdaMetaContext context describing what to modify in @store + + + a #GdaStatement object, or %NULL - + filename="libgda/gda-meta-store.c" + line="3294">a #GdaDataModel containing the new data to set in @table_name, or %NULL (treated as a data model +with no row at all) + - + List of parameters' IDs (as gchar *), list is stolen - + filename="libgda/gda-meta-store.c" + line="4446">The internal database used by @store can be 'augmented' with some user-defined database objects +(such as tables or views). This method allows one to add a new database object. + +If the internal database already contains the object, then: +<itemizedlist> + <listitem><para>if the object is equal to the provided description then TRUE is returned</para></listitem> + <listitem><para>if the object exists but differs from the provided description, then FALSE is returned, + with the GDA_META_STORE_SCHEMA_OBJECT_CONFLICT_ERROR error code</para></listitem> +</itemizedlist> + +The @xml_description defines the table of view's definition, for example: +<programlisting><![CDATA[<table name="mytable"> + <column name="id" pkey="TRUE"/> + <column name="value"/> +</table>]]></programlisting> + +The partial DTD for this XML description of the object to add is the following (the top node must be +a &lt;table&gt; or a &lt;view&gt;): +<programlisting><![CDATA[<!ELEMENT table (column*,check*,fkey*)> +<!ATTLIST table + name NMTOKEN #REQUIRED> + +<!ELEMENT column EMPTY> +<!ATTLIST column + name NMTOKEN #REQUIRED + type CDATA #IMPLIED + pkey (TRUE|FALSE) #IMPLIED + autoinc (TRUE|FALSE) #IMPLIED + nullok (TRUE|FALSE) #IMPLIED> + +<!ELEMENT check (#PCDATA)> + +<!ELEMENT fkey (part+)> +<!ATTLIST fkey + ref_table NMTOKEN #REQUIRED> + +<!ELEMENT part EMPTY> +<!ATTLIST part + column NMTOKEN #IMPLIED + ref_column NMTOKEN #IMPLIED> + +<!ELEMENT view (definition)> +<!ATTLIST view + name NMTOKEN #REQUIRED + descr CDATA #IMPLIED> + +<!ELEMENT definition (#PCDATA)>]]></programlisting> + - + TRUE if the new object has successfully been added + - + a #GdaPStmt - + filename="libgda/gda-meta-store.c" + line="4448">a #GdaMetaStore object + - + a list of strings with ID's to set - - - + filename="libgda/gda-meta-store.c" + line="4449">an XML description of the table or view to add to @store + - + Set SQL code used for this prepared statement, mem freed by GdaPStmt - - - + filename="libgda/gda-meta-store.c" + line="4098">Get an ordered list of the tables @store knows about. The tables are ordered in a way that tables dependencies +are respected: if table B has a foreign key on table A, then table A will be listed before table B in the returned +list. + + + a new list of tables names (as gchar*), the list must be freed when no longer needed, but the strings present in the list must not be modified. + + + - - + + a #GdaMetaStore object + - - - - + Set the list of #GdaColumn objects which data models created from this -prepared statement can copy. The list is stolen, so you should not -free it. - - - + filename="libgda/gda-meta-store.c" + line="4134">Get an ordered list of the tables @store knows about on which the @table_name table depends (recursively). +The tables are ordered in a way that tables dependencies +are respected: if table B has a foreign key on table A, then table A will be listed before table B in the returned +list. + + + a new list of tables names (as gchar*), the list must be freed when no longer needed, but the strings present in the list must not be modified. + + + - + a #GdaPStmt - + filename="libgda/gda-meta-store.c" + line="4136">a #GdaMetaStore object + - + a list of #GdaColumn - - - + filename="libgda/gda-meta-store.c" + line="4137">the name of the table for which all the dependencies must be listed + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Creates a new #GdaMetaStruct object representing @store's internal database structure. + + + a new #GdaMetaStruct object, or %NULL if an error occurred + + + + + a #GdaMetaStore object + + + + + + Removes the custom database object named @obj_name. + + TRUE if the custom object has successfully been removed - - + + a #GdaMetaStore object + - - - - + + name of the custom object to remove - - - + + + Set the value of the attribute named @att_name to @att_value; see gda_meta_store_get_attribute_value() for +more information. + + TRUE if no error occurred - - + + a #GdaMetaStore object + - - - - + + name of the attribute to set - - + + value of the attribute to set, or %NULL to unset the attribute + - - - + + + Specifies how @store must handle SQL identifiers it has to store. This method is mainly used by +database providers. + - + - - - - - + + a #GdaMetaStore object + + + + a style + - - - + + + Specifies a function which @store will use to determine if a keyword is an SQL reserved +keyword or not. + +This method is mainly used by database providers. + - + - - + + a #GdaMetaStore object + - - - - - + + a #GdaSqlReservedKeywordsFunc function, or %NULL + - - - - - - - - - - - - - - - - + + + Removes a declared foreign key from @store. + +This method begins a transaction if possible (ie. none is already started), and if it can't, then if there +is an error, the job may be partially done. + +A check is always performed to make sure all the database objects actually +exist and returns an error if not. The check is performed using @mstruct if it's not %NULL (in +this case only the tables already represented in @mstruct will be considered, in other words: @mstruct +will not be modified), and using an internal #GdaMetaStruct is %NULL. + +See gda_meta_store_declare_foreign_key() for more information anout the @catalog, @schema, @name, +@ref_catalog, @ref_schema and @ref_name arguments. + + + %TRUE if no error occurred + - - + + a #GdaMetaStore + - - + + a #GdaMetaStruct, or %NULL + - - + + the name of the foreign key to declare + - - + + the catalog in which the table (for which the foreign key is for) is, or %NULL + - - - - - - - - - - - - - + + the schema in which the table (for which the foreign key is for) is, or %NULL + - - - - - - - - - - - - - + + the name of the table (for which the foreign key is for) + - + + the catalog in which the referenced table is, or %NULL - - - - - - - - - - - - - + + the schema in which the referenced table is, or %NULL + - + + the name of the referenced table - - - - - + + + + + + + + + + + + + + + + + + This signal is emitted when the @store's contents have changed (the changes are in the @changes list) + + - - - - - - - - - - - + + a list of changes made, as a #GSList of pointers to #GdaMetaStoreChange (which must not be modified) + + + - - - + + + This signal is emitted when the @store's contents have been reset completely and when +no detailed changes are available + + + + + + This signal is emitted when the contents of a table should be updated (data to update or insert only; +deleting data is done automatically). This signal is used for internal purposes by the #GdaConnection +object. - + a new #GError error structure if there was an error when processing the +signal, or %NULL if signal propagation should continue + - - - - - - - - + + the suggested update, as a #GdaMetaContext structure + - - + + + + + This command should be called inmediately called after a INSERT SQL command - + filename="libgda/gda-meta-store.c" + line="88">Creates a new #GdaMetaStoreChange + + + + + + + a #GdaSet with all data of the last inserted row - + filename="libgda/gda-meta-store.c" + line="158">a new #GdaMetaStoreChange + - + a #GdaProvider object - + filename="libgda/gda-meta-store.c" + line="156">a #GdaMetaStoreChange + - - a #GdaConnection to get last inserted from - - - - - + + + - + - - + + a #GdaMetaStoreChange to be freed + - - - + + + - + - - + + - - - - - - + + + - + hash table with string key key = ('+' or '-') and a column position in @table (string) starting at 0 and value as #GValue pointer + + + + - - + + a #GdaMetaStoreChange + - - - + + + + a string with the table name - - + + a #GdaMetaStoreChange + - - - - - - - - - - - - - - - + + + - + - - + + - - - - - - - - + + - - - + + + - + - - - - - - - - + + a #GdaMetaStoreChange + + + + name of the table + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + Creates a new #GdaMetaDbObject structure in @mstruct to represent the database object (of type @type) +which can be uniquely identified as @catalog.@schema.@name. + +If @catalog is not %NULL, then @schema should not be %NULL. + +If both @catalog and @schema are %NULL, then the database object will be the one which is +"visible" by default (that is which can be accessed only by its short @name name). + +If @catalog is %NULL and @schema is not %NULL, then the database object will be the one which +can be accessed by its @schema.@name name. + +Important note: @catalog, @schema and @name will be used using the following convention: +<itemizedlist> + <listitem><para>be surrounded by double quotes for a case sensitive search</para></listitem> + <listitem><para>otherwise for case insensitive search</para></listitem> +</itemizedlist> + +For more information, see the <link linkend="information_schema:sql_identifiers"> +meta data section about SQL identifiers</link>. + + + the #GdaMetaDbObject corresponding to the database object if no error occurred, or %NULL + - - + + a #GdaMetaStruct object + - - + + the type of object to add (which can be GDA_META_DB_UNKNOWN) + - - + + the catalog the object belongs to (as a G_TYPE_STRING GValue), or %NULL + - - + + the schema the object belongs to (as a G_TYPE_STRING GValue), or %NULL + + + + the object's name (as a G_TYPE_STRING GValue), not %NULL + - - - - - + + + This method is similar to gda_meta_struct_complement() and gda_meta_struct_complement_default() +but creates #GdaMetaDbObject for all the database object. + +Please refer to gda_meta_struct_complement() form more information. + + + TRUE if no error occurred + - - + + a #GdaMetaStruct object + - - - - - - - - - + + + This method is similar to gda_meta_struct_complement() and gda_meta_struct_complement_all() +but creates #GdaMetaDbObject for all the +database object which are usable using only their short name (that is which do not need to be prefixed by +the schema in which they are to be used). + +Please refer to gda_meta_struct_complement() form more information. + + TRUE if no error occurred - - + + a #GdaMetaStruct object + - - - - - - - - - + + + This method is similar to gda_meta_struct_complement() but creates #GdaMetaDbObject for all the dependencies +of @dbo. + +Please refer to gda_meta_struct_complement() form more information. + + TRUE if no error occurred - - + + a #GdaMetaStruct object + - - - - - + + a #GdaMetaDbObject part of @mstruct + - - - - - + + + This method is similar to gda_meta_struct_complement() but creates #GdaMetaDbObject for all the +database object which are in the @schema schema (and in the @catalog catalog). +If @catalog is %NULL, then any catalog will be used, and +if @schema is %NULL then any schema will be used (if @schema is %NULL then catalog must also be %NULL). + +Please refer to gda_meta_struct_complement() form more information. + + + TRUE if no error occurred + - - + + a #GdaMetaStruct object + - - - - - - - - - - - - - - + + name of a catalog, or %NULL + - - + + name of a schema, or %NULL + - - - - - + + + Creates a new graph (in the GraphViz syntax) representation of @mstruct. + + + a new string, or %NULL if an error occurred. + - - + + a #GdaMetaStruct object + - - - - - + + informs what kind of information to show in the resulting graph + - - - - - + + + Get a list of all the #GdaMetaDbObject structures representing database objects in @mstruct. Note that +no #GdaMetaDbObject structure must not be modified. + + + a new #GSList list of pointers to +#GdaMetaDbObject structures which must be destroyed after usage using g_slist_free(). The individual +#GdaMetaDbObject must not be modified. + + + - - + + a #GdaMetaStruct object + - - - - - - - - - - - - - - + + + Tries to locate the #GdaMetaDbObject structure representing the database object named after +@catalog, @schema and @name. + +If one or both of @catalog and @schema are %NULL, and more than one database object matches the name, then +the return value is also %NULL. + + + the #GdaMetaDbObject or %NULL if not found + - - + + a #GdaMetaStruct object + - - - - - + + the catalog the object belongs to (as a G_TYPE_STRING GValue), or %NULL + - - + the schema the object belongs to (as a G_TYPE_STRING GValue), or %NULL + - - + + the object's name (as a G_TYPE_STRING GValue), not %NULL + - - - - + + + + Tries to find the #GdaMetaTableColumn representing the column named @col_name in @table. + + + the #GdaMetaTableColumn or %NULL if not found + + + + + a #GdaMetaStruct object + + + + the #GdaMetaTable structure to find the column for + + + + the name of the column to find (as a G_TYPE_STRING GValue) + - - - + + + Loads an XML description into @mstruct. This method is still experimental and no description +the XML file structure is given, and no guarantee that it will remain as it is given. + + TRUE if no error has occurred - - + + a #GdaMetaStruct object + - - + + the catalog name, or %NULL + - - + + the schema name, or %NULL + + + + the specifications as the name of an XML file + - - - + + + Reorders the list of database objects within @mstruct in a way specified by @sort_type. + + TRUE if no error occurred - - + + a #GdaMetaStruct object + - - - - - - - - + + the kind of sorting requested + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Controls which features are computed about database objects. + + + database objects only have their own attributes + + + foreign keys are computed for tables + + + for views, the tables they use are also computed + + + all the features are computed + + + + This structure specifies a #GdaMetaDbObject to represent a table's specific attributes, +its contents must not be modified. + +Note that in some cases, the columns cannot be determined for views, and in this case the +@columns will be %NULL (this can be the case for example with SQLite where a view +uses a function which is not natively provided by SQLite. + + + + + + + + + + + - - - - + + + + - - + + - - - - + - - + + + + + + + + + + + + + - + - - + + - - - - + + + + + + + + + + + + + + + + + + + + + + + - - - + + + - + - - + + - - - - + - - - - - - + + + - + - - + + - - + + - - - + + + - + - - + + + + + + + + + + + + + - - - - - - - + + + + - - + + - - - - + + + + - - + + - - - - - - - - - - - - - + + + + - - + + - - - - - + + - + - - + + - - - - + - - - - + + + + - - + + - - - - + - - - - + + + + - - + + - - - - - - - + - - + + + + + + + + + + + + + + + This structure represents a table of view's column, its contents must not be modified. + + + the column's name + + + + the column's DBMS's type + + + + the detected column's #GType + + + + tells if the column is part of a primary key + + + + tells if the column can be %NULL + + + + the column's default value, represented as a valid SQL value (surrounded by simple quotes for strings, ...), or %NULL if column has no default value + + + + + + + + + + + + + + + + + + + + + + + This structure represents a foreign key constraint, its contents must not be modified. + + + the #GdaMetaDbObject for which this structure represents a foreign key + + + + the #GdaMetaDbObject which is referenced by the foreign key + + + + the size of the @fk_cols_array, @fk_names_array, @ref_pk_cols_array and @ref_pk_names_array arrays + + + + the columns' indexes in @meta_table which participate in the constraint (WARNING: columns numbering + here start at 1) + + + + the columns' names in @meta_table which participate in the constraint + + + + the columns' indexes in @depend_on which participate in the constraint (WARNING: columns numbering + here start at 1) + + + + the columns' names in @depend_on which participate in the constraint + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This structure specifies a #GdaMetaDbObject to represent a view's specific attributes, +its contents must not be modified. + + + a view is also a table as it has columns + + + + views' definition + + + + tells if the view's contents can be updated + + + + + + + + + + + + + + + + + + + Holds numbers represented as strings. + +This struct must be considered as opaque. Any access to its members must use its +accessors added since version 5.0.2. + + + Creates a new #GdaNumeric with defaults. + - + a new #GdaNumeric. + - - - - - - - - - - - - - + + This command should be called inmediately called after a INSERT SQL command - + filename="libgda/gda-value.c" + line="1236">Creates a new #GdaNumeric structure from an existing one. + a #GdaSet with all data of the last inserted row - + filename="libgda/gda-value.c" + line="1242">a newly allocated #GdaNumeric which contains a copy of information in @boxed. + +Free-function: gda_numeric_free + - + a #GdaProvider object - + filename="libgda/gda-value.c" + line="1238">source to get a copy from. + - - a #GdaConnection to get last inserted from - - - - + + Deallocates all memory associated to the given @boxed + - + - - + + a #GdaNumeric pointer + - - + + - + a #gdouble representation of @numeric + - - + + a #GdaNumeric + - - - - - + + Gets the precision of a #GdaNumeric. + - + an integer with the precision of a #GdaNumeric. + - - + + a #GdaNumeric + - - - + + Get the string representation of @numeric, in the C locale format (dot as a fraction separator). + + + a new string representing the stored valued in @numeric - - + + a #GdaNumeric + - - - - - - - - - - - - - - + + Gets the width of a #GdaNumeric. (Not yet implemented). + - + an integer with the width of a #GdaNumeric. (Not jet implemented). + - - - - - - - - - - - - + + a #GdaNumeric + + - - + + Sets @numeric using a #gdouble represented by @number. + - + - - + + a #GdaNumeric + - - - - - + + a #gdouble + - - + + Sets @numeric with a number represented by @str, in the C locale format (dot as a fraction separator). + - + - - + + a #GdaNumeric + - - - - - - - - + + a string representing a number, in the C locale format + - - - - + + Sets the precision of a #GdaNumeric. + + + - - + + a #GdaNumeric + - - - - - + + a #glong + - - + + Sets the width of a #GdaNumeric. (Not yet implemented). + - + - - + + a #GdaNumeric + - - - - - + + a #glong + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Copies @src's data to @dest + - + - - + + a #GdaPStmt object + - - - - - + + a #GdaPStmt object + - - + + Get a pointer to the #GdaStatement which led to the creation of this prepared statement. + +Note: if that statement has been modified since the creation of @pstmt, then this method +will return %NULL + - + the #GdaStatement + - - + + a #GdaPStmt object + - - - - - - - - - - - - - - - - - - - - + + - + number of columns or -1 if something is wrong + - - + + - - - - - - - - - - + + List of parameters' IDs (as gchar *) + + + a list of string with parameters ID's + + + - - + + - - - - - - - - - - - - + + Actual SQL code used for this prepared statement, mem freed by GdaPStmt + + + SQL command used - - + + - - - - - - - - - - - - - - - - - - - + + List of #GdaColumn objects which data models created from this +prepared statement can copy + - + a list of #GdaColumn objects + + + - - + + - - - - - - - - + + Set column's types for statement. @types will be stolen and should +no be modified anymore. + - + an array of #GType used in the columns + + + - - + + - - + + + + Set column's types for statement. @types is stalen and should +no be modified + + + + + + + a #GdaPStmt + + + + number of columns and size of given array + - - + + an array of types to use for each column + + + - - + + + + Informs @pstmt that it corresponds to the preparation of the @stmt statement + + + + + + + a #GdaPStmt object + + + + a #GdaStatement object, or %NULL + - - - - + + List of parameters' IDs (as gchar *), list is stolen + + + - - + + a #GdaPStmt + - - + + a list of strings with ID's to set + + + - + + + + Set SQL code used for this prepared statement, mem freed by GdaPStmt + + + + + + + + + - - - This structure holds the information associated to a database provider as discovered by Libgda. - - - the unique identifier of the database provider - - - - the complete path to the shared library implementing the database provider - - - - provider's description - - - - a #GdaSet containing all the parameters which can/must be specified when opening a connection or defining a named data source (DSN) - - - + a #GdaSet containing all the authentication parameters - - - - - - - - - - - - - - - - + filename="libgda/providers-support/gda-pstmt.c" + line="350">Set the list of #GdaColumn objects which data models created from this +prepared statement can copy. The list is stolen, so you should not +free it. + + + + + + + a #GdaPStmt + + + + a list of #GdaColumn + + + + + + + + - - - - - + + + + + - - - + + + - + - - - - - - - - + + + - + - - - - - - - - + + + - + - - - - - - - - - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - + + - - + + - - - - + + - - - + + + - + - - - - - + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + - + - - - - - - - - - - - + + - - - - - + + + + + - - - - - - - - - - - + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - a #GdaSet with all data of the last inserted row - - - - - a #GdaProvider object - - - - a #GdaConnection to get last inserted from - - - - - - - - - - - - - - - - - - + + - - - + + + - - + + + + + + + + - - - - + + + - - + + - - + + - + - - + + - - - - + stability="Unstable"> + + + - - + + + + + - - - - + + + - - + + - - - - - - - - + + - + - - + stability="Unstable"> + - + - - + + - - + - + - - + + - - + + - - + + - - + + - - + stability="Unstable"> + - + - - + + + + + - - - - + + + - - + + + + + + + + - - + stability="Unstable"> + - + - - + + - - - - - - - - + + - + - - + stability="Unstable"> + - + - - + + - - - - - + + - - + + - + - - - - - - - - - - - - - + stability="Unstable"> + - + - - + + - - - - - + + - - + + - - + This command should be called inmediately called after a INSERT SQL command + - + a #GdaSet with all data of the last inserted row + - - + + a #GdaProvider object + - - - - - - - - + + a #GdaConnection to get last inserted from + - - - - + stability="Unstable"> + + + - - + + - - - - + stability="Unstable"> + + + - - + + - - - - - + + - - - - + stability="Unstable"> + + + - - + + - - - - - - - - - - - - - - + stability="Unstable"> + - + - - + + - - + + - + - - + + + + + - - - - + stability="Unstable"> + + + - - + + + + + + + + + + + - - - - + + + - - + + + + + + + + - - - - + stability="Unstable"> + + + - - + + - - + + + + + + + + - - + - + - - + + + + + + + + - - - - + + + - - + + - - - - - + + - + - - - - + + + - - + + + + + + + + - - + - + - - + + - - + + - - + + - - + + - - + + + + + + + + - - - - + + + - - + + + + + + + + - - + - + - - + + - - - - - + + - - + + - - + + - - + - + - - + + - - + + - - + + - - + + + + + + + + + + - - - - + stability="Unstable"> + + + - - + + + + + + + + - - - - + stability="Unstable"> + + + - - + + - - - - - + + - - + + - - + + - - + stability="Unstable"> + - + - - + + + + + + + + - - - - + + + + - - + + - - - - - + + - + - - - - - + + + + + - - + + - - + + - + - - + + - - - - - + + + + + - - + + - - + + - - + + + + + + + + + + + + + - + - - - + + + - + - - + + - - - + + + - + - - + + + + + + + + + + + - - - + + + - + - - + + + + + - - - - - + + + + + - - + + - - + + - + - - - - - - - - - - - - - - + + + - + - - + + - - - - - + + - + - - - + + + - + - - + + - - - - - + + - - + + - + - - - + + + - + - - + + - - - - - + + - - + + - - - + + + This command should be called inmediately called after a INSERT SQL command + - + a #GdaSet with all data of the last inserted row + - - + + a #GdaProvider object + + + a #GdaConnection to get last inserted from + + - - - - - + + + + + - - + + - - - - - + + + + + - - + + - - - - - - - - + + - - - - - + + + + + - - + + - - - + + + - + - - + + - - + + - + + + + + + + - - - - - + + + + + - - + + - - + + - - + + - - + + - - - - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + - - - - + stability="Unstable"> + + + - - + + - - + + - - + + - - + + - - - - - - - - - - - - - + - + - - + + - - - - - - - - + + - - + + - - - - - - - - - - - - - - - + + + - - + + - - - - - + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - + + + - - + + - - - - - - - - + + - + - - + - + - - + + - - + + - - + + - - + + - - + + + + + + + + - - - - + + + - - + + + + + + + + - - + - + - - + + - - + + - - + + - - + + - - + - + - - + + - - + + - - + + - - + + + + + + + + + + - - - - - - - - - - - - - - - + stability="Unstable"> + + + - - + + - - + + - - + + - - - - + stability="Unstable"> + + + - - + + - - - - - + + - - + + - - + + - - + stability="Unstable"> + - + - - + + - - - - - + + - + - - - + + + This structure holds the information associated to a database provider as discovered by Libgda. + + + the unique identifier of the database provider + + + + the complete path to the shared library implementing the database provider + + + + provider's description + + + + a #GdaSet containing all the parameters which can/must be specified when opening a connection or defining a named data source (DSN) + + + + a #GdaSet containing all the authentication parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + a #GdaSet with all data of the last inserted row + + + + + a #GdaProvider object + + + + a #GdaConnection to get last inserted from + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + SQL is specific for current provider. + + + a new #GdaDataModel with as a result of the query + + + + + a #GdaProviderMeta + + + + a string with the SQL to execute on provider + + + + a #GdaSet with all paramaters to use in query + + + + + + SQL is specific for current provider. + + + a new #GdaDataModel with as a result of the query + + + + + a #GdaProviderMeta + + + + a string with the SQL to execute on provider + + + + + + + + + + + a #GdaConnection used by this object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new #GdaQuarkList, which is a set of key->value pairs, +very similar to GLib's GHashTable, but with the only purpose to +make easier the parsing and creation of data source connection +strings. + + + the newly created #GdaQuarkList. + +Free-function: gda_quark_list_free + + + + + Creates a new #GdaQuarkList given a string. + +@string must be a semi-colon separated list of "&lt;key&gt;=&lt;value&gt;" strings (for example +"DB_NAME=notes;USERNAME=alfred"). Each key and value must respect the RFC 1738 recommendations: the +<constant>&lt;&gt;&quot;#%{}|\^~[]&apos;`;/?:@=&amp;</constant> and space characters are replaced by +<constant>&quot;%%ab&quot;</constant> where +<constant>ab</constant> is the hexadecimal number corresponding to the character (for example the +"DB_NAME=notes;USERNAME=al%%20fred" string will specify a username as "al fred"). If this formalism +is not respected, then some unexpected results may occur. + - + the newly created #GdaQuarkList. + +Free-function: gda_quark_list_free + - - - + + a string. + + - - - - - + + + @string must be a semi-colon separated list of "&lt;key&gt;=&lt;value&gt;" strings (for example +"DB_NAME=notes;USERNAME=alfred"). Each key and value must respect the RFC 1738 recommendations: the +<constant>&lt;&gt;&quot;#%{}|\^~[]&apos;`;/?:@=&amp;</constant> and space characters are replaced by +<constant>&quot;%%ab&quot;</constant> where +<constant>ab</constant> is the hexadecimal number corresponding to the character (for example the +"DB_NAME=notes;USERNAME=al%%20fred" string will specify a username as "al fred"). If this formalism +is not respected, then some unexpected results may occur. + +Some corner cases for any string part (delimited by the semi-colon): +<itemizedlist> + <listitem><para>If it does not respect the "&lt;key&gt;=&lt;value&gt;" format then it will be ignored.</para></listitem> + <listitem><para>Only the 1st equal character is used to separate the key from the value part (which means + any other equal sign will be part of the value)</para></listitem> +</itemizedlist> + + +Adds new key->value pairs from the given @string. If @cleanup is +set to %TRUE, the previous contents will be discarded before adding +the new pairs. + + + - - + + a #GdaQuarkList. + - + + a string. + + whether to cleanup the previous content or not. + + - - - - + + Removes all strings in the given #GdaQuarkList. + + + - - + + a #GdaQuarkList. + - - + + Creates a new #GdaQuarkList from an existing one. + - + a newly allocated #GdaQuarkList with a copy of the data in @qlist. + - - + + quark_list to get a copy from. + - - - - - - - - - - - - - + + Searches for the value identified by @name in the given #GdaQuarkList. For protected values +(authentification data), don't forget to call gda_quark_list_protect_values() when you +don't need them anymore (when needed again, they will be unmangled again). + + + the value associated with the given key if found, or %NULL if not found. + - - + + a #GdaQuarkList. + + + the name of the value to search for. + + - + SQL is specific for current provider. - - - a new #GdaDataModel with as a result of the query - + filename="libgda/gda-quark-list.c" + line="519">Calls the given function for each of the key/value pairs in @qlist. The function is passed the key and value +of each pair, and the given user_data parameter. @qlist may not be modified while iterating over it. + + + - + a #GdaProviderMeta - + filename="libgda/gda-quark-list.c" + line="521">a #GdaQuarkList structure. + - + a string with the SQL to execute on provider - + filename="libgda/gda-quark-list.c" + line="522">the function to call for each key/value pair + - a #GdaSet with all paramaters to use in query - + filename="libgda/gda-quark-list.c" + line="523">user data to pass to the function + - + SQL is specific for current provider. - - - a new #GdaDataModel with as a result of the query - + filename="libgda/gda-quark-list.c" + line="281">Releases all memory occupied by the given #GdaQuarkList. + + + - + a #GdaProviderMeta - + filename="libgda/gda-quark-list.c" + line="283">a #GdaQuarkList, or %NULL + - - a string with the SQL to execute on provider - - - - - - - - - a #GdaConnection used by this object. - + + Call this function to get rid of the clear version of all the values stored in @qlist. If @qlist is %NULL, +then this function does nothing. + + + - - + + a #GdaQuarkList, or %NULL + - - - - + + Removes an entry from the #GdaQuarkList, given its name. + + + - - + + a #GdaQuarkList structure. + - - - - + + an entry name. - - + + + + + + + + + + + + + + + + - - + + - - - - - + + + + + - - + + + + + - - - - - + + + + + - - + + - - + + - - + + - - + + + + + + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - + + + + - - + + - - + + - - + + + + + + + + + + + + + - - + + - - - - + + + + + + + + + + + + + + + + + - - + + - - - - + + + + - - + + - - - - - - - - - - - - - - - - + + + + - - + + - - - - + + + + + + + + + + + + + + + + - - + + - - - - - - - + - - - - - + + + + + - - + + - - - - - - - + - - - - - + + + + + - - + + - - - - - - - + - - - - - + + + + + - - + + + + + - - - - - + + + + + - - + + - - - - - + + + + + - - + + - - - - - + + + + + - - + + - - - - + - - - - - + + + + + - - + + - - - - - + + + + + - - + + - - - - - - - + - - - - - + + + + + - - + + - - - - + - + - + + + + + + + + + + + + - - - - - + + + + + - - + + - + - + + + + + + + + + + + + - + + + + + + + + + + + + - - + - - - + + + - - + + + + + - - - - + + + - - + + + + + - - - - + + + - - + + - - - - - - - + - - - - + + + - - + + + + + - - - - + + + + - - + + - - - - - - - - - - + + + + - - + + - - - - - - - - - - - - - + + + + - - + + + + + - - - - + + + + - - + + - - - - + + + - - + + - - - - - - - + - - - - + + + - - + + - - - - - - - + - + - - - - + + + - - + + - - - - - - - + - - - - + + + - - + + + + + - - - - + + + + - - + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - + + + + + - - - - - - - - - - - + + - - - - - + + + + + - - - - - - - - - - - + + - + - - - - - - - - - - - - - - - - - - + + + + + - - - - - - - - - - - + + - - - - - + + + + + - - - - - - - - - - - + + - + - - - - - + + + + + - - + + - - - - - + + + + + - - - - - - - - + + - + - - - - - + + + + + - - - - - - - - - - - + + - + - - - - - - - - - - - - - - - - - - + + + + + - - - - - - - - + + - + - - - - - + + + + + - - - - - - - - - - - + + - + - - - - - - - - - - - - - - - - - - + + + + + - - - - - - - - - - - + + - + - - - - - - - - - - - - - - - - - - + + + + + - - - - - - - - - - - + + - + - - - - - - - - - - - - - - - - - - + + + + + - - - - - - - - + + - + - - - - - - - - - - - - - - - - - - + + + + + - - - - - + + - + - + - - - - - - - - - - - - - - - - - - + + + + + - - - - - - - - + + - + - - - - - - - - - - - - + + + + + - - - - - + + + + + - - - - - - - - - - - + + - - - - - + + + + + - - + + - - - - - + + + + + - - - - - - - - - - - + + - - - - - + + + + + - - - - - - - - + + - - + + - - + + - - - - - + + + + + - - + + + + + - - - - - + + + + + - - + + - - + + - - + + - - + + + + + + + + + + + + - - + + - - - - - - - - - Creates a new #GdaQuarkList, which is a set of key->value pairs, -very similar to GLib's GHashTable, but with the only purpose to -make easier the parsing and creation of data source connection -strings. - - - the newly created #GdaQuarkList. - -Free-function: gda_quark_list_free - - - - - Creates a new #GdaQuarkList given a string. - -@string must be a semi-colon separated list of "&lt;key&gt;=&lt;value&gt;" strings (for example -"DB_NAME=notes;USERNAME=alfred"). Each key and value must respect the RFC 1738 recommendations: the -<constant>&lt;&gt;&quot;#%{}|\^~[]&apos;`;/?:@=&amp;</constant> and space characters are replaced by -<constant>&quot;%%ab&quot;</constant> where -<constant>ab</constant> is the hexadecimal number corresponding to the character (for example the -"DB_NAME=notes;USERNAME=al%%20fred" string will specify a username as "al fred"). If this formalism -is not respected, then some unexpected results may occur. - - - the newly created #GdaQuarkList. - -Free-function: gda_quark_list_free - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - a string. - - + + + - - - @string must be a semi-colon separated list of "&lt;key&gt;=&lt;value&gt;" strings (for example -"DB_NAME=notes;USERNAME=alfred"). Each key and value must respect the RFC 1738 recommendations: the -<constant>&lt;&gt;&quot;#%{}|\^~[]&apos;`;/?:@=&amp;</constant> and space characters are replaced by -<constant>&quot;%%ab&quot;</constant> where -<constant>ab</constant> is the hexadecimal number corresponding to the character (for example the -"DB_NAME=notes;USERNAME=al%%20fred" string will specify a username as "al fred"). If this formalism -is not respected, then some unexpected results may occur. - -Some corner cases for any string part (delimited by the semi-colon): -<itemizedlist> - <listitem><para>If it does not respect the "&lt;key&gt;=&lt;value&gt;" format then it will be ignored.</para></listitem> - <listitem><para>Only the 1st equal character is used to separate the key from the value part (which means - any other equal sign will be part of the value)</para></listitem> -</itemizedlist> - - -Adds new key->value pairs from the given @string. If @cleanup is -set to %TRUE, the previous contents will be discarded before adding -the new pairs. - + + + - - a #GdaQuarkList. - + + - - a string. + + + + - - whether to cleanup the previous content or not. - + + - - - Removes all strings in the given #GdaQuarkList. - + + + - - a #GdaQuarkList. - + + + + + + + + + + + - - - Creates a new #GdaQuarkList from an existing one. - - - a newly allocated #GdaQuarkList with a copy of the data in @qlist. - + + + + + - - quark_list to get a copy from. - + + - - Searches for the value identified by @name in the given #GdaQuarkList. For protected values -(authentification data), don't forget to call gda_quark_list_protect_values() when you -don't need them anymore (when needed again, they will be unmangled again). - + + - the value associated with the given key if found, or %NULL if not found. - + - - a #GdaQuarkList. - + + - - the name of the value to search for. + + + + + + + - - Calls the given function for each of the key/value pairs in @qlist. The function is passed the key and value -of each pair, and the given user_data parameter. @qlist may not be modified while iterating over it. - + + - - a #GdaQuarkList structure. - + + - - the function to call for each key/value pair - + + - - user data to pass to the function - + + + + + - - Releases all memory occupied by the given #GdaQuarkList. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - a #GdaQuarkList, or %NULL - + + - - - Call this function to get rid of the clear version of all the values stored in @qlist. If @qlist is %NULL, -then this function does nothing. - + + + - - a #GdaQuarkList, or %NULL - + + + + + + + + + + + + + + + + - - Removes an entry from the #GdaQuarkList, given its name. - + + - - a #GdaQuarkList structure. - + + - - an entry name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -38488,13 +44553,6 @@ To include variables in the @sql string, see the default-value="0"> - - - @@ -41978,12 +48036,202 @@ of @stmt have been verified (emitted after gda_statement_check_validity()).time and timestamp with a timezone information are converted to GMT before rendering, and rendering does not show the timezone information + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new #GdaText object, initialy with no string. + line="386">Creates a new #GdaText object, initialy with no string. Use #gda_text_set_string() to set a string to. a new #GdaText object + line="392">a new #GdaText object Free resources on #GdaText object. + line="402">Free resources on #GdaText object. @@ -42016,7 +48264,7 @@ Use #gda_text_set_string() to set a string to. a #GdaText object + line="404">a #GdaText object @@ -42026,14 +48274,14 @@ Use #gda_text_set_string() to set a string to. a string represented by #GdaText + line="422">a string represented by #GdaText a #GdaText object + line="420">a #GdaText object @@ -42041,7 +48289,7 @@ Use #gda_text_set_string() to set a string to. Set string. The string is duplicated. + line="431">Set string. The string is duplicated. @@ -42050,13 +48298,13 @@ Use #gda_text_set_string() to set a string to. a #GdaText object + line="433">a #GdaText object a string to set from + line="434">a string to set from @@ -42064,7 +48312,7 @@ Use #gda_text_set_string() to set a string to. Takes ownership on a given string, so you don't need to free it. + line="451">Takes ownership on a given string, so you don't need to free it. @@ -42073,13 +48321,13 @@ Use #gda_text_set_string() to set a string to. a #GdaText object + line="453">a #GdaText object a string to take ownership on + line="454">a string to take ownership on @@ -42120,12 +48368,12 @@ of the non alphanumeric char. Creates a new #GdaTime with time now local. + line="1532">Creates a new #GdaTime with time now local. a new #GdaTime structure + line="1537">a new #GdaTime structure @@ -42134,19 +48382,19 @@ of the non alphanumeric char. version="6.0"> Creates new instcne of #GdaTime from #GDateTime. + line="1650">Creates new instcne of #GdaTime from #GDateTime. the a new value storing a time + line="1656">the a new value storing a time a #GDateTime to get time from + line="1652">a #GDateTime to get time from @@ -42155,43 +48403,43 @@ of the non alphanumeric char. c:identifier="gda_time_new_from_values"> Create new instance of #GdaTime from the provided values. + line="1617">Create new instance of #GdaTime from the provided values. the a new value storing a time + line="1627">the a new value storing a time hours + line="1619">hours minutes + line="1620">minutes seconds + line="1621">seconds fraction of seconds + line="1622">fraction of seconds timezone in seconds added to UTC + line="1623">timezone in seconds added to UTC @@ -42199,19 +48447,19 @@ of the non alphanumeric char. Create a copy of #GdaTime + line="1473">Create a copy of #GdaTime a pointer to a new #GdaTime struct + line="1479">a pointer to a new #GdaTime struct an instance of #GdaTime to copy + line="1475">an instance of #GdaTime to copy @@ -42219,7 +48467,7 @@ of the non alphanumeric char. Free resources holded by the #GdaTime instance + line="1489">Free resources holded by the #GdaTime instance @@ -42228,7 +48476,7 @@ of the non alphanumeric char. a #GdaTime to free + line="1491">a #GdaTime to free @@ -42238,19 +48486,19 @@ of the non alphanumeric char. version="6.0"> Extract fraction of seconds from the instance of #GdaTime + line="1764">Extract fraction of seconds from the instance of #GdaTime fraction of seconds + line="1770">fraction of seconds a #GdaTime value to get fraction of seconds from + line="1766">a #GdaTime value to get fraction of seconds from @@ -42258,7 +48506,7 @@ of the non alphanumeric char. Get hours from the #GdaTime instance + line="1665">Get hours from the #GdaTime instance @@ -42267,7 +48515,7 @@ of the non alphanumeric char. a #GdaTime value to get hours from + line="1667">a #GdaTime value to get hours from @@ -42277,7 +48525,7 @@ of the non alphanumeric char. version="6.0"> Get minutes from the #GdaTime instance + line="1698">Get minutes from the #GdaTime instance @@ -42286,7 +48534,7 @@ of the non alphanumeric char. a #GdaTime value to get minutes from + line="1700">a #GdaTime value to get minutes from @@ -42296,7 +48544,7 @@ of the non alphanumeric char. version="6.0"> Get second component from #GdaTime + line="1731">Get second component from #GdaTime @@ -42305,7 +48553,7 @@ of the non alphanumeric char. a #GdaTime value to get seconds from + line="1733">a #GdaTime value to get seconds from @@ -42315,7 +48563,7 @@ of the non alphanumeric char. version="6.0"> Returns number of seconds to be added to UTC time. + line="1806">Returns number of seconds to be added to UTC time. @@ -42324,7 +48572,7 @@ of the non alphanumeric char. a #GdaTime value to get time zone from + line="1808">a #GdaTime value to get time zone from @@ -42332,7 +48580,7 @@ of the non alphanumeric char. Returns a #GTimeZone in use in this @time. + line="1820">Returns a #GTimeZone in use in this @time. @@ -42341,7 +48589,7 @@ of the non alphanumeric char. a #GdaTime value to get time zone from + line="1822">a #GdaTime value to get time zone from @@ -42351,7 +48599,7 @@ of the non alphanumeric char. version="6.0"> Set new value for the second fraction + line="1787">Set new value for the second fraction @@ -42360,13 +48608,13 @@ of the non alphanumeric char. a #GdaTime value to set hours to + line="1789">a #GdaTime value to set hours to new second fraction to set to. + line="1790">new second fraction to set to. @@ -42374,7 +48622,7 @@ of the non alphanumeric char. Set hour component to the #GdaTime instance. + line="1679">Set hour component to the #GdaTime instance. @@ -42383,13 +48631,13 @@ of the non alphanumeric char. a #GdaTime value to set hours to + line="1681">a #GdaTime value to set hours to new hours to set to + line="1682">new hours to set to @@ -42399,7 +48647,7 @@ of the non alphanumeric char. version="6.0"> Set minutes to the #GdaTime instance + line="1712">Set minutes to the #GdaTime instance @@ -42408,13 +48656,13 @@ of the non alphanumeric char. a #GdaTime value to set hours to + line="1714">a #GdaTime value to set hours to new minutes to set to + line="1715">new minutes to set to @@ -42424,7 +48672,7 @@ of the non alphanumeric char. version="6.0"> Set second component + line="1745">Set second component @@ -42433,13 +48681,13 @@ of the non alphanumeric char. a #GdaTime value to set hours to + line="1747">a #GdaTime value to set hours to new seconds to set to + line="1748">new seconds to set to @@ -42449,7 +48697,7 @@ of the non alphanumeric char. version="6.0"> Set timezone component for the instance of #GdaTime + line="1837">Set timezone component for the instance of #GdaTime @@ -42458,13 +48706,13 @@ of the non alphanumeric char. a #GdaTime value to set time zone to + line="1839">a #GdaTime value to set time zone to new time zone to set to. See #gda_time_change_timezone + line="1840">new time zone to set to. See #gda_time_change_timezone @@ -42472,20 +48720,20 @@ of the non alphanumeric char. Creates a string representation of a #GdaTime in local time + line="1548">Creates a string representation of a #GdaTime in local time with the timezone designation. a new string + line="1555">a new string #GdaTime instance to convert to string + line="1550">#GdaTime instance to convert to string @@ -42495,20 +48743,20 @@ with the timezone designation. version="6.0"> Creates a string representation of a #GdaTime in local time + line="1566">Creates a string representation of a #GdaTime in local time without timezone designation. a new string + line="1573">a new string #GdaTime instance to convert to string + line="1568">#GdaTime instance to convert to string @@ -42518,20 +48766,20 @@ without timezone designation. version="6.0"> Creates a string representation of a #GdaTime in UTC time + line="1586">Creates a string representation of a #GdaTime in UTC time with time zone indication. a new string + line="1593">a new string #GdaTime instance to convert to string + line="1588">#GdaTime instance to convert to string @@ -42541,7 +48789,7 @@ with time zone indication. version="6.0"> Translate @time's to give timezone + line="1876">Translate @time's to give timezone @@ -42550,13 +48798,13 @@ with time zone indication. a valid #GdaTime + line="1878">a valid #GdaTime a new #GTimeZone to use + line="1879">a new #GTimeZone to use @@ -42564,7 +48812,7 @@ with time zone indication. Change time zone to UTC. + line="1605">Change time zone to UTC. @@ -42573,7 +48821,7 @@ with time zone indication. a #GdaTime + line="1607">a #GdaTime @@ -42585,19 +48833,19 @@ with time zone indication. deprecated-version="6.0"> A time is always valid, so this method has been deprecated. + line="1857">A time is always valid, so this method has been deprecated. #TRUE if #GdaTime is valid; %FALSE otherwise. + line="1863">#TRUE if #GdaTime is valid; %FALSE otherwise. a #GdaTime value to check if it is valid + line="1859">a #GdaTime value to check if it is valid @@ -45091,6 +51339,24 @@ does not have a ny children anymore when it had some line="54">the value can't be modified + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -46568,6 +53106,84 @@ the returned username and password strings are correctly decoded. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Performs the reverse of gda_binary_to_string() (note that for any "\xyz" succession + line="3523">Performs the reverse of gda_binary_to_string() (note that for any "\xyz" succession of 4 characters where "xyz" represents a valid octal value, the resulting read value will be modulo 256). @@ -49035,7 +55651,7 @@ I @str is %NULL, then an empty (i.e. where the @data part is %NULL) #GdaBinary i a new #GdaBinary if no error were found in @str, or %NULL otherwise + line="3533">a new #GdaBinary if no error were found in @str, or %NULL otherwise @@ -49045,7 +55661,7 @@ I @str is %NULL, then an empty (i.e. where the @data part is %NULL) #GdaBinary i allow-none="1"> a string to convert, or %NULL + line="3525">a string to convert, or %NULL @@ -49053,19 +55669,19 @@ I @str is %NULL, then an empty (i.e. where the @data part is %NULL) #GdaBinary i Performs the reverse of gda_blob_to_string(). + line="3615">Performs the reverse of gda_blob_to_string(). a new #gdaBlob if no error were found in @str, or NULL otherwise + line="3621">a new #gdaBlob if no error were found in @str, or NULL otherwise a string to convert + line="3617">a string to convert @@ -49307,7 +55923,7 @@ another row). Compares two values of the same type, with the exception that a value of any type can be + line="2946">Compares two values of the same type, with the exception that a value of any type can be compared to a GDA_TYPE_NULL value, specifically: <itemizedlist> <listitem><para>if @value1 and @value2 are both GDA_TYPE_NULL values then the returned value is 0</para></listitem> @@ -49319,7 +55935,7 @@ compared to a GDA_TYPE_NULL value, specifically: if both values have the same type, returns 0 if both contain + line="2960">if both values have the same type, returns 0 if both contain the same value, an integer less than 0 if @value1 is less than @value2 or an integer greater than 0 if @value1 is greater than @value2. @@ -49328,13 +55944,13 @@ an integer greater than 0 if @value1 is greater than @value2. a #GValue to compare (not %NULL) + line="2948">a #GValue to compare (not %NULL) the other #GValue to be compared to @value1 (not %NULL) + line="2949">the other #GValue to be compared to @value1 (not %NULL) @@ -49342,12 +55958,12 @@ an integer greater than 0 if @value1 is greater than @value2. Creates a new #GValue from an existing one. + line="2266">Creates a new #GValue from an existing one. a newly allocated #GValue with a copy of the data in @value. + line="2272">a newly allocated #GValue with a copy of the data in @value. Free-function: gda_value_free @@ -49356,7 +55972,7 @@ Free-function: gda_value_free value to get a copy from. + line="2268">value to get a copy from. @@ -49364,7 +55980,7 @@ Free-function: gda_value_free Tells if two values are equal or not, by comparing memory representations. Unlike gda_value_compare(), + line="2777">Tells if two values are equal or not, by comparing memory representations. Unlike gda_value_compare(), the returned value is boolean, and gives no idea about ordering. The two values must be of the same type, with the exception that a value of any type can be @@ -49379,20 +55995,20 @@ compared to a GDA_TYPE_NULL value, specifically: a non 0 value if @value1 and @value2 differ, and 0 if they are equal + line="2794">a non 0 value if @value1 and @value2 differ, and 0 if they are equal a #GValue to compare. + line="2779">a #GValue to compare. the other #GValue to be compared to @value1. + line="2780">the other #GValue to be compared to @value1. @@ -49400,7 +56016,7 @@ compared to a GDA_TYPE_NULL value, specifically: Deallocates all memory associated to a #GValue. + line="2188">Deallocates all memory associated to a #GValue. @@ -49412,7 +56028,7 @@ compared to a GDA_TYPE_NULL value, specifically: allow-none="1"> the resource to free (or %NULL) + line="2190">the resource to free (or %NULL) @@ -49422,14 +56038,14 @@ compared to a GDA_TYPE_NULL value, specifically: the value stored in @value. + line="2297">the value stored in @value. a #GValue whose value we want to get. + line="2295">a #GValue whose value we want to get. @@ -49439,14 +56055,14 @@ compared to a GDA_TYPE_NULL value, specifically: the value stored in @value. + line="2374">the value stored in @value. a #GValue whose value we want to get. + line="2372">a #GValue whose value we want to get. @@ -49457,14 +56073,14 @@ compared to a GDA_TYPE_NULL value, specifically: the value stored in @value. + line="2412">the value stored in @value. a #GValue whose value we want to get. + line="2410">a #GValue whose value we want to get. @@ -49492,14 +56108,14 @@ compared to a GDA_TYPE_NULL value, specifically: the value stored in @value. + line="2457">the value stored in @value. a #GValue whose value we want to get. + line="2455">a #GValue whose value we want to get. @@ -49509,14 +56125,14 @@ compared to a GDA_TYPE_NULL value, specifically: the value stored in @value. + line="2489">the value stored in @value. a #GValue whose value we want to get. + line="2487">a #GValue whose value we want to get. @@ -49526,14 +56142,14 @@ compared to a GDA_TYPE_NULL value, specifically: the value stored in @value. + line="2552">the value stored in @value. a #GValue whose value we want to get. + line="2550">a #GValue whose value we want to get. @@ -49543,14 +56159,14 @@ compared to a GDA_TYPE_NULL value, specifically: the value stored in @value. + line="2520">the value stored in @value. a #GValue whose value we want to get. + line="2518">a #GValue whose value we want to get. @@ -49558,19 +56174,19 @@ compared to a GDA_TYPE_NULL value, specifically: Tests if a given @value is of type #GDA_TYPE_NULL. + line="2228">Tests if a given @value is of type #GDA_TYPE_NULL. a boolean that says whether or not @value is of type #GDA_TYPE_NULL. + line="2234">a boolean that says whether or not @value is of type #GDA_TYPE_NULL. value to test. + line="2230">value to test. @@ -49578,19 +56194,19 @@ compared to a GDA_TYPE_NULL value, specifically: Gets whether the value stored in the given #GValue is of numeric type or not. + line="2243">Gets whether the value stored in the given #GValue is of numeric type or not. %TRUE if a number, %FALSE otherwise. + line="2249">%TRUE if a number, %FALSE otherwise. a #GValue. + line="2245">a #GValue. @@ -49609,12 +56225,12 @@ compared to a GDA_TYPE_NULL value, specifically: Creates a new #GValue of type @type, left in the same state as when g_value_init() is called. + line="1915">Creates a new #GValue of type @type, left in the same state as when g_value_init() is called. the newly created #GValue with the specified @type. You need to set the value in the returned GValue. + line="1921">the newly created #GValue with the specified @type. You need to set the value in the returned GValue. Free-function: gda_value_free @@ -49623,7 +56239,7 @@ Free-function: gda_value_free the new value type. + line="1917">the new value type. @@ -49631,12 +56247,12 @@ Free-function: gda_value_free Makes a new #GValue of type #GDA_TYPE_BINARY with value @val. + line="771">Makes a new #GValue of type #GDA_TYPE_BINARY with value @val. the newly created #GValue. + line="778">the newly created #GValue. Free-function: gda_value_free @@ -49645,13 +56261,13 @@ Free-function: gda_value_free value to set for the new #GValue. + line="773">value to set for the new #GValue. the size of the memory pool pointer to by @val. + line="774">the size of the memory pool pointer to by @val. @@ -49659,12 +56275,12 @@ Free-function: gda_value_free Makes a new #GValue of type #GDA_TYPE_BLOB with the data contained by @val. + line="1971">Makes a new #GValue of type #GDA_TYPE_BLOB with the data contained by @val. the newly created #GValue. + line="1978">the newly created #GValue. Free-function: gda_value_free @@ -49673,13 +56289,13 @@ Free-function: gda_value_free value to set for the new #GValue. + line="1973">value to set for the new #GValue. the size of the memory pool pointer to by @val. + line="1974">the size of the memory pool pointer to by @val. @@ -49688,13 +56304,13 @@ Free-function: gda_value_free c:identifier="gda_value_new_blob_from_file"> Makes a new #GValue of type #GDA_TYPE_BLOB interfacing with the contents of the file + line="1999">Makes a new #GValue of type #GDA_TYPE_BLOB interfacing with the contents of the file named @filename the newly created #GValue. + line="2006">the newly created #GValue. Free-function: gda_value_free @@ -49703,7 +56319,7 @@ Free-function: gda_value_free name of the file to manipulate + line="2001">name of the file to manipulate @@ -49712,7 +56328,7 @@ Free-function: gda_value_free c:identifier="gda_value_new_date_time_from_timet"> Makes a new #GValue of type #G_TYPE_DATE_TIME with value @val + line="2050">Makes a new #GValue of type #G_TYPE_DATE_TIME with value @val (of type time_t). The returned timestamp's value is relative to the current timezone (i.e. is localtime). @@ -49725,7 +56341,7 @@ ts = gda_value_new_date_time_from_timet (time (NULL)); the newly created #GValue, or %NULL in case of error + line="2064">the newly created #GValue, or %NULL in case of error Free-function: gda_value_free @@ -49734,7 +56350,7 @@ Free-function: gda_value_free value to set for the new #GValue. + line="2052">value to set for the new #GValue. @@ -49744,12 +56360,12 @@ Free-function: gda_value_free version="4.2.9"> Creates a new default value. + line="1950">Creates a new default value. a new #GValue of the type #GDA_TYPE_DEFAULT + line="1956">a new #GValue of the type #GDA_TYPE_DEFAULT @@ -49759,7 +56375,7 @@ Free-function: gda_value_free allow-none="1"> the default value as a string, or %NULL + line="1952">the default value as a string, or %NULL @@ -49768,7 +56384,7 @@ Free-function: gda_value_free c:identifier="gda_value_new_from_string"> Makes a new #GValue of type @type from its string representation. + line="2113">Makes a new #GValue of type @type from its string representation. For more information about the string format, see the gda_value_set_from_string() function. @@ -49778,7 +56394,7 @@ independent. the newly created #GValue or %NULL if the string representation cannot be converted to the specified @type. + line="2125">the newly created #GValue or %NULL if the string representation cannot be converted to the specified @type. Free-function: gda_value_free @@ -49787,13 +56403,13 @@ Free-function: gda_value_free stringified representation of the value. + line="2115">stringified representation of the value. the new value type. + line="2116">the new value type. @@ -49801,7 +56417,7 @@ Free-function: gda_value_free Creates a GValue from an XML representation of it. That XML + line="2145">Creates a GValue from an XML representation of it. That XML node corresponds to the following string representation: &lt;value type="gdatype"&gt;value&lt;/value&gt; @@ -49813,7 +56429,7 @@ independent. the newly created #GValue. + line="2158">the newly created #GValue. Free-function: gda_value_free @@ -49822,7 +56438,7 @@ Free-function: gda_value_free an XML node representing the value. + line="2147">an XML node representing the value. @@ -49830,13 +56446,13 @@ Free-function: gda_value_free Creates a new #GValue initiated to a #GdaNull structure with a #GDA_TYPE_NULL, to + line="1936">Creates a new #GValue initiated to a #GdaNull structure with a #GDA_TYPE_NULL, to represent a NULL in the database. a new #GValue of the type #GDA_TYPE_NULL + line="1942">a new #GValue of the type #GDA_TYPE_NULL @@ -49845,7 +56461,7 @@ represent a NULL in the database. version="6.0"> Makes a new #GValue of type #GDA_TYPE_TIME with value @val + line="2081">Makes a new #GValue of type #GDA_TYPE_TIME with value @val (of type time_t). The returned times's value is relative to the current timezone (i.e. is localtime). @@ -49858,7 +56474,7 @@ ts = gda_value_new_time_from_timet (time (NULL)); the newly created #GValue, or %NULL in case of error + line="2095">the newly created #GValue, or %NULL in case of error Free-function: gda_value_free @@ -49867,7 +56483,7 @@ Free-function: gda_value_free value to set for the new #GValue. + line="2083">value to set for the new #GValue. @@ -49876,7 +56492,7 @@ Free-function: gda_value_free c:identifier="gda_value_reset_with_type"> Resets the #GValue and set a new type to #GType. + line="2203">Resets the #GValue and set a new type to #GType. @@ -49885,13 +56501,13 @@ Free-function: gda_value_free the #GValue to be reseted + line="2205">the #GValue to be reseted the #GType to set to + line="2206">the #GType to set to @@ -49899,7 +56515,7 @@ Free-function: gda_value_free Stores @val into @value. + line="2313">Stores @val into @value. @@ -49908,13 +56524,13 @@ Free-function: gda_value_free a #GValue that will store @val. + line="2315">a #GValue that will store @val. a #GdaBinary structure with the data and its size to be stored in @value. + line="2316">a #GdaBinary structure with the data and its size to be stored in @value. @@ -49922,7 +56538,7 @@ Free-function: gda_value_free Stores @val into @value. + line="2352">Stores @val into @value. @@ -49931,13 +56547,13 @@ Free-function: gda_value_free a #GValue that will store @val. + line="2354">a #GValue that will store @val. a #GdaBlob structure with the data and its size to be stored in @value. + line="2355">a #GdaBlob structure with the data and its size to be stored in @value. @@ -49946,7 +56562,7 @@ Free-function: gda_value_free c:identifier="gda_value_set_from_string"> Stores the value data from its string representation as @type. + line="2612">Stores the value data from its string representation as @type. The accepted formats are: <itemizedlist> @@ -49963,7 +56579,7 @@ independent. %TRUE if the value has been converted to @type from + line="2632">%TRUE if the value has been converted to @type from its string representation; it not means that the value is converted successfully, just that the transformation is available. %FALSE otherwise. @@ -49972,19 +56588,19 @@ successfully, just that the transformation is available. %FALSE otherwise. a #GValue that will store @val. + line="2614">a #GValue that will store @val. the stringified representation of the value. + line="2615">the stringified representation of the value. the type of the value + line="2616">the type of the value @@ -49993,7 +56609,7 @@ successfully, just that the transformation is available. %FALSE otherwise. c:identifier="gda_value_set_from_value"> Sets the value of a #GValue from another #GValue. This + line="2650">Sets the value of a #GValue from another #GValue. This is different from #gda_value_copy, which creates a new #GValue. #gda_value_set_from_value, on the other hand, copies the contents of @copy into @value, which must already be allocated. @@ -50004,20 +56620,20 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to %TRUE if successful, %FALSE otherwise. + line="2663">%TRUE if successful, %FALSE otherwise. a #GValue. + line="2652">a #GValue. the value to copy from. + line="2653">the value to copy from. @@ -50026,7 +56642,7 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to c:identifier="gda_value_set_geometric_point"> Stores @val into @value. + line="2422">Stores @val into @value. @@ -50035,13 +56651,13 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to a #GValue that will store @val. + line="2424">a #GValue that will store @val. value to be stored in @value. + line="2425">value to be stored in @value. @@ -50070,7 +56686,7 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to Sets the type of @value to #GDA_TYPE_NULL. + line="2440">Sets the type of @value to #GDA_TYPE_NULL. @@ -50079,7 +56695,7 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to a #GValue that will store a value of type #GDA_TYPE_NULL. + line="2442">a #GValue that will store a value of type #GDA_TYPE_NULL. @@ -50087,7 +56703,7 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to Stores @val into @value. + line="2467">Stores @val into @value. @@ -50096,13 +56712,13 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to a #GValue that will store @val. + line="2469">a #GValue that will store @val. value to be stored in @value. + line="2470">value to be stored in @value. @@ -50110,7 +56726,7 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to Stores @val into @value. + line="2499">Stores @val into @value. @@ -50119,13 +56735,13 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to a #GValue that will store @val. + line="2501">a #GValue that will store @val. value to be stored in @value. + line="2502">value to be stored in @value. @@ -50133,7 +56749,7 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to Stores @val into @value. + line="2562">Stores @val into @value. @@ -50142,13 +56758,13 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to a #GValue that will store @val. + line="2564">a #GValue that will store @val. value to be stored in @value. + line="2565">value to be stored in @value. @@ -50156,7 +56772,7 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to Stores @val into @value. + line="2530">Stores @val into @value. @@ -50165,13 +56781,13 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to a #GValue that will store @val. + line="2532">a #GValue that will store @val. value to be stored in @value. + line="2533">value to be stored in @value. @@ -50179,7 +56795,7 @@ If values are incompatible (see @g_value_type_compatible) then @value is set to Converts a GValue to its string representation which is a human readable value. Note that the + line="2688">Converts a GValue to its string representation which is a human readable value. Note that the returned string does not take into account the current locale of the user (on the contrary to the #GdaDataHandler objects). Using this function should be limited to debugging and values serialization purposes. @@ -50189,14 +56805,14 @@ Output is in the "C" locale for numbers, and dates are converted in a YYYY-MM-DD a new string, or %NULL if the conversion cannot be done. Free the value with a g_free() when you've finished using it. + line="2699">a new string, or %NULL if the conversion cannot be done. Free the value with a g_free() when you've finished using it. a #GValue. + line="2690">a #GValue. @@ -50204,7 +56820,7 @@ Output is in the "C" locale for numbers, and dates are converted in a YYYY-MM-DD Stores @val into @value, but on the contrary to gda_value_set_binary(), the @binary + line="2333">Stores @val into @value, but on the contrary to gda_value_set_binary(), the @binary argument is not copied, but used as-is and it should be considered owned by @value. @@ -50214,13 +56830,13 @@ argument is not copied, but used as-is and it should be considered owned by @val a #GValue that will store @val. + line="2335">a #GValue that will store @val. a #GdaBinary structure with the data and its size to be stored in @value. + line="2336">a #GdaBinary structure with the data and its size to be stored in @value. @@ -50228,7 +56844,7 @@ argument is not copied, but used as-is and it should be considered owned by @val Stores @val into @value, but on the contrary to gda_value_set_blob(), the @blob + line="2389">Stores @val into @value, but on the contrary to gda_value_set_blob(), the @blob argument is not copied, but used as-is and it should be considered owned by @value. @@ -50238,13 +56854,13 @@ argument is not copied, but used as-is and it should be considered owned by @val a #GValue that will store @val. + line="2391">a #GValue that will store @val. a #GdaBlob structure with the data and its size to be stored in @value. + line="2392">a #GdaBlob structure with the data and its size to be stored in @value. @@ -50254,19 +56870,19 @@ argument is not copied, but used as-is and it should be considered owned by @val introspectable="0"> Serializes the given #GValue to an XML node string. + line="3271">Serializes the given #GValue to an XML node string. the XML node. Once not needed anymore, you should free it. + line="3277">the XML node. Once not needed anymore, you should free it. a #GValue. + line="3273">a #GValue. @@ -50275,19 +56891,19 @@ argument is not copied, but used as-is and it should be considered owned by @val c:identifier="gda_value_to_xml_string"> This methods creates an XML string representation of a #GValue + line="3298">This methods creates an XML string representation of a #GValue an string representing a #GValue in XML format + line="3304">an string representing a #GValue in XML format a #GValue to convert to string + line="3300">a #GValue to convert to string diff --git a/girs/Gdaui-6.0.gir b/girs/Gdaui-6.0.gir index 3bd451579..33593e614 100644 --- a/girs/Gdaui-6.0.gir +++ b/girs/Gdaui-6.0.gir @@ -6,22 +6,26 @@ and/or use gtk-doc annotations. --> xmlns="http://www.gtk.org/introspection/core/1.0" xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> + + + + - + - + - + @@ -115,7 +119,7 @@ and/or use gtk-doc annotations. --> glib:type-name="GdauiBasicForm" glib:get-type="gdaui_basic_form_get_type" glib:type-struct="BasicFormClass"> - + @@ -123,22 +127,22 @@ and/or use gtk-doc annotations. --> c:identifier="gdaui_basic_form_new" version="4.2"> Creates a new #GdauiBasicForm widget using all the #GdaHolder objects provided in @data_set. The global layout is rendered using a table (a #GtkTable), and an entry is created for each node of @data_set. - + the new widget a #GdaSet structure @@ -148,24 +152,24 @@ node of @data_set. c:identifier="gdaui_basic_form_new_in_dialog" version="4.2"> Creates a new #GdauiBasicForm widget in the same way as gdaui_basic_form_new() and puts it into a #GtkDialog widget. The returned dialog has the "Ok" and "Cancel" buttons which respectively return GTK_RESPONSE_ACCEPT and GTK_RESPONSE_REJECT. The #GdauiBasicForm widget is attached to the dialog using the user property "form". - + the new #GtkDialog widget a #GdaSet object @@ -174,7 +178,7 @@ The #GdauiBasicForm widget is attached to the dialog using the user property nullable="1" allow-none="1"> the parent window for the new dialog, or %NULL @@ -183,7 +187,7 @@ The #GdauiBasicForm widget is attached to the dialog using the user property nullable="1" allow-none="1"> the title of the dialog window, or %NULL @@ -192,14 +196,14 @@ The #GdauiBasicForm widget is attached to the dialog using the user property nullable="1" allow-none="1"> a helper text displayed at the top of the dialog, or %NULL - + @@ -210,7 +214,7 @@ The #GdauiBasicForm widget is attached to the dialog using the user property - + @@ -227,7 +231,7 @@ The #GdauiBasicForm widget is attached to the dialog using the user property - + @@ -241,29 +245,29 @@ The #GdauiBasicForm widget is attached to the dialog using the user property c:identifier="gdaui_basic_form_add_to_size_group" version="4.2"> Add @form's widgets specified by @part to @size_group (the widgets can then be removed using gdaui_basic_form_remove_from_size_group()). - + a #GdauiBasicForm a #GtkSizeGroup object specifies which widgets in @form are concerned @@ -273,17 +277,17 @@ The #GdauiBasicForm widget is attached to the dialog using the user property c:identifier="gdaui_basic_form_entry_grab_focus" version="4.2"> Makes the data entry corresponding to @holder grab the focus for the window it's in. If @holder is %NULL, then the focus is on the first entry which needs attention. - + a #GdauiBasicForm widget @@ -292,7 +296,7 @@ then the focus is on the first entry which needs attention. nullable="1" allow-none="1"> a #GdaHolder object, or %NULL @@ -302,18 +306,18 @@ then the focus is on the first entry which needs attention. c:identifier="gdaui_basic_form_entry_set_editable" version="4.2"> Sets the #GdauiDataEntry in @form which corresponds to the @holder parameter editable or not. If @holder is %NULL, then all the parameters are concerned. - + a #GdauiBasicForm widget @@ -322,13 +326,13 @@ are concerned. nullable="1" allow-none="1"> a #GdaHolder object; or %NULL %TRUE if corresponding data entry must be editable @@ -338,29 +342,29 @@ are concerned. c:identifier="gdaui_basic_form_entry_set_visible" version="4.2"> Shows or hides the #GdauiDataEntry in @form which corresponds to the @holder data holder - + a #GdauiBasicForm widget a #GdaHolder object set to %TRUE to show the data entry, and to %FALSE to hide it @@ -370,20 +374,20 @@ are concerned. c:identifier="gdaui_basic_form_get_data_set" version="4.2"> Get a pointer to the #GdaSet object which is modified by @form - + a pointer to the #GdaSet a #GdauiBasicForm widget @@ -393,25 +397,25 @@ is modified by @form c:identifier="gdaui_basic_form_get_entry_widget" version="4.2"> Get the #GdauiDataEntry in @form which corresponds to the @holder place. - + the requested widget, or %NULL if not found a #GdauiBasicForm widget a #GdaHolder object @@ -421,25 +425,25 @@ is modified by @form c:identifier="gdaui_basic_form_get_label_widget" version="4.2"> Get the label in @form which corresponds to the @holder holder. - + the requested widget, or %NULL if not found a #GdauiBasicForm widget a #GdaHolder object @@ -449,26 +453,26 @@ is modified by @form c:identifier="gdaui_basic_form_get_place_holder" version="4.2"> Retreives a pointer to a place holder widget. This feature is only available if a specific layout has been defined for @form using gdaui_basic_form_set_layout_from_file(). - + a pointer to the requested place holder, or %NULL if not found a #GdauiBasicForm the name of the requested place holder @@ -478,20 +482,20 @@ layout has been defined for @form using gdaui_basic_form_set_layout_from_file(). c:identifier="gdaui_basic_form_has_changed" version="4.2"> Tells if the form has had at least on entry changed since @form was created or gdaui_basic_form_set_as_reference() has been called. - + %TRUE if one entry has changed at least a #GdauiBasicForm widget @@ -501,19 +505,19 @@ gdaui_basic_form_set_as_reference() has been called. c:identifier="gdaui_basic_form_is_valid" version="4.2"> Tells if the form can be used as-is (if all the parameters do have some valid values) - + %TRUE if the form is valid a #GdauiBasicForm widget @@ -523,29 +527,29 @@ gdaui_basic_form_set_as_reference() has been called. c:identifier="gdaui_basic_form_remove_from_size_group" version="4.2"> Removes @form's widgets specified by @part from @size_group (the widgets must have been added using gdaui_basic_form_add_to_size_group()). - + a #GdauiBasicForm a #GtkSizeGroup object specifies which widgets in @form are concerned @@ -553,17 +557,17 @@ gdaui_basic_form_set_as_reference() has been called. Resets all the entries in the form to their original values - + a #GdauiBasicForm widget @@ -573,19 +577,19 @@ original values c:identifier="gdaui_basic_form_set_as_reference" version="4.2"> Tells @form that the current values in the different entries are to be considered as the original values for all the entries; the immediate consequence is that any sub-sequent call to gdaui_basic_form_has_changed() will return %FALSE (of course until any entry is changed). - + a #GdauiBasicForm widget @@ -595,16 +599,16 @@ will return %FALSE (of course until any entry is changed). c:identifier="gdaui_basic_form_set_entries_to_default" version="4.2"> For each entry in the form, sets it to a default value if it is possible to do so. - + a #GdauiBasicForm widget @@ -614,29 +618,29 @@ will return %FALSE (of course until any entry is changed). c:identifier="gdaui_basic_form_set_layout_from_file" version="4.2"> Sets a form layout according an XML description contained in @file_name, for the form identified by the @form_name name (as an XML layout file can contain the descriptions of several forms and grids). - + a #GdauiBasicForm XML file name to use the name of the form to use, in @file_name @@ -646,41 +650,41 @@ by the @form_name name (as an XML layout file can contain the descriptions of se c:identifier="gdaui_basic_form_set_unknown_color" version="5.0.3"> Defines the color to be used when @form displays an invalid value. Any value not between 0. and 1. will result in the default hard coded values to be used (grayish). - + a #GdauiBasicForm widget the red component of a color the green component of a color the blue component of a color the alpha component of a color @@ -690,27 +694,30 @@ between 0. and 1. will result in the default hard coded values to be used (grayi c:identifier="gdaui_basic_form_update_data_set" throws="1"> Updates values in all #GdaHolder in current #GdaSet - + a #GdauiBasicForm - + + transfer-ownership="none" + default-value="FALSE"> @@ -727,7 +734,7 @@ between 0. and 1. will result in the default hard coded values to be used (grayi Emitted when the use has activated any of the #GdaDataEntry widget in @form. @@ -736,7 +743,7 @@ in @form. Emitted when a GdaHolder changed in @form @@ -744,13 +751,13 @@ in @form. the #GdaHolder that changed TRUE if the modification has been initiated by a user modification @@ -758,7 +765,7 @@ in @form. Emitted when the form's layout changes @@ -766,7 +773,7 @@ in @form. Connect this signal and modify the popup menu. @@ -774,7 +781,7 @@ in @form. a #GtkMenu to modify @@ -784,13 +791,13 @@ in @form. - + - + @@ -809,7 +816,7 @@ in @form. - + @@ -822,7 +829,7 @@ in @form. - + @@ -835,7 +842,7 @@ in @form. - + @@ -844,80 +851,80 @@ in @form. - + - + - + - + - + - + - + - + - + Defines a function which creates a #GtkCellRenderer object - + a new #GtkCellRenderer a #GdaDataHandler a #GType @@ -926,7 +933,7 @@ in @form. nullable="1" allow-none="1"> options, or %NULL @@ -939,27 +946,27 @@ in @form. glib:type-name="GdauiCloud" glib:get-type="gdaui_cloud_get_type" glib:type-struct="CloudClass"> - + Creates a new #GdauiCloud widget suitable to display the data in @model - + filename="libgda-ui/gdaui-cloud.c" + line="353">Creates a new #GdauiCloud widget suitable to display the data in @model + the new widget + filename="libgda-ui/gdaui-cloud.c" + line="359">the new widget a #GdaDataModel + filename="libgda-ui/gdaui-cloud.c" + line="355">a #GdaDataModel @@ -971,7 +978,7 @@ in @form. - + @@ -988,37 +995,37 @@ in @form. c:identifier="gdaui_cloud_create_filter_widget" version="4.2"> Creates a search widget linked directly to modify @cloud's appearance. - + filename="libgda-ui/gdaui-cloud.c" + line="1032">Creates a search widget linked directly to modify @cloud's appearance. + a new widget + filename="libgda-ui/gdaui-cloud.c" + line="1038">a new widget a #GdauiCloud widget + filename="libgda-ui/gdaui-cloud.c" + line="1034">a #GdauiCloud widget Filters the elements displayed in @cloud, by altering their color. - + filename="libgda-ui/gdaui-cloud.c" + line="1000">Filters the elements displayed in @cloud, by altering their color. + a #GdauiCloud widget + filename="libgda-ui/gdaui-cloud.c" + line="1002">a #GdauiCloud widget nullable="1" allow-none="1"> the filter to use, or %NULL to remove any filter + filename="libgda-ui/gdaui-cloud.c" + line="1003">the filter to use, or %NULL to remove any filter @@ -1036,23 +1043,23 @@ in @form. c:identifier="gdaui_cloud_set_selection_mode" version="4.2"> Sets @cloud's selection mode - + filename="libgda-ui/gdaui-cloud.c" + line="509">Sets @cloud's selection mode + a #GdauiCloud widget + filename="libgda-ui/gdaui-cloud.c" + line="511">a #GdauiCloud widget the desired selection mode + filename="libgda-ui/gdaui-cloud.c" + line="512">the desired selection mode @@ -1061,17 +1068,17 @@ in @form. c:identifier="gdaui_cloud_set_weight_func" version="4.2"> Specifies a function called by @cloud to compute each row's respective weight. - + filename="libgda-ui/gdaui-cloud.c" + line="1062">Specifies a function called by @cloud to compute each row's respective weight. + a #GdauiCloud widget + filename="libgda-ui/gdaui-cloud.c" + line="1064">a #GdauiCloud widget scope="notified" closure="1"> a #GdauiCloudWeightFunc function which computes weights, or %NULL to unset + filename="libgda-ui/gdaui-cloud.c" + line="1065">a #GdauiCloudWeightFunc function which computes weights, or %NULL to unset nullable="1" allow-none="1"> a pointer to pass as last argument of @func each time it is called, or %NULL + filename="libgda-ui/gdaui-cloud.c" + line="1066">a pointer to pass as last argument of @func each time it is called, or %NULL - + - + - + - + @@ -1128,13 +1147,13 @@ in @form. - + - + @@ -1155,7 +1174,7 @@ in @form. - + @@ -1181,7 +1200,7 @@ in @form. glib:type-name="GdauiCombo" glib:get-type="gdaui_combo_get_type" glib:type-struct="ComboClass"> - + @@ -1189,12 +1208,12 @@ in @form. Create a new GdauiCombo widget. - + the newly-created widget. @@ -1203,32 +1222,32 @@ in @form. c:identifier="gdaui_combo_new_with_model" version="4.2"> Create a new GdauiCombo widget with a model. See gdaui_combo_set_data() for more information about the @n_cols and @cols_index usage. - + the newly-created widget. a #GdaDataModel object. number of columns in the model to be shown an array of columns to be shown, its size must be @n_cols @@ -1238,23 +1257,23 @@ more information about the @n_cols and @cols_index usage. c:identifier="gdaui_combo_add_null" version="4.2"> Tells if @combo should add a special entry representing an "undefined choice", as a %NULL entry. The default is that only the available choices in @combo's model are presented. - + a #GdauiCombo widget set to %TRUE to add a NULL value to the combo box @@ -1264,19 +1283,19 @@ that only the available choices in @combo's model are presented. c:identifier="gdaui_combo_is_null_selected" version="4.2"> Tell if the currently selected entry represents the "undefined choice" entry. - + %TRUE if the %NULL value is selected a #GdauiCombo widget @@ -1286,39 +1305,39 @@ that only the available choices in @combo's model are presented. c:identifier="gdaui_combo_set_data" version="5.2"> Makes @combo display data stored in @model (makes the combo widget refresh its list of values and display the values contained in the model). A NULL @model will make the combo empty and disassociate the previous model, if any. if @n_cols is %0, then all the columns of @model will be displayed in @combo. - + a #GdauiCombo widget. a #GdaDataModel object to get data from. number of columns in the model to be shown an array of columns to be shown, its size must be @n_cols @@ -1326,7 +1345,10 @@ if @n_cols is %0, then all the columns of @model will be displayed in @combo. - + @@ -1339,7 +1361,7 @@ if @n_cols is %0, then all the columns of @model will be displayed in @combo. - + @@ -1356,11 +1378,11 @@ if @n_cols is %0, then all the columns of @model will be displayed in @combo. - Creates a new #GdauiDataCellRendererBin. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_set()). Also, with #GtkTreeViewColumn, you @@ -1368,31 +1390,31 @@ can bind a property to a value in a #GtkTreeModel. For example, you can bind the "active" property on the cell renderer to a bin value in the model, thus causing the check button to reflect the state of the model. - the new cell renderer a #GdaDataHandler object the #GType of the data to be displayed - @@ -1417,13 +1439,17 @@ the model. transfer-ownership="none"> - + + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="GDA_VALUE_ATTR_NONE"> @@ -1462,7 +1489,7 @@ the model. - - @@ -1497,12 +1524,12 @@ the model. glib:type-name="GdauiDataCellRendererBoolean" glib:get-type="gdaui_data_cell_renderer_boolean_get_type" glib:type-struct="DataCellRendererBooleanClass"> - Creates a new #GdauiDataCellRendererBoolean. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_set()). Also, with #GtkTreeViewColumn, you @@ -1510,31 +1537,31 @@ can bind a property to a value in a #GtkTreeModel. For example, you can bind the "active" property on the cell renderer to a boolean value in the model, thus causing the check button to reflect the state of the model. - the new cell renderer a #GdaDataHandler object the #GType of the data to be displayed - @@ -1559,13 +1586,17 @@ the model. transfer-ownership="none"> - + + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="GDA_VALUE_ATTR_NONE"> @@ -1604,7 +1636,7 @@ the model. - - @@ -1639,39 +1671,39 @@ the model. glib:type-name="GdauiDataCellRendererCombo" glib:get-type="gdaui_data_cell_renderer_combo_get_type" glib:type-struct="DataCellRendererComboClass"> - Creates a new #GdauiDataCellRendererCombo which will fill the parameters listed in @source->nodes with values available from @source->data_model. - the new cell renderer a #GdaSet object a #GdauiSetSource structure listed in @paramlist->sources_list - @@ -1713,25 +1745,29 @@ the model. + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="GDA_VALUE_ATTR_NONE"> - - @@ -1817,11 +1853,11 @@ the model. glib:type-name="GdauiDataCellRendererInfo" glib:get-type="gdaui_data_cell_renderer_info_get_type" glib:type-struct="DataCellRendererInfoClass"> - Creates a new #GdauiDataCellRendererInfo. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_set()). Also, with #GtkTreeViewColumn, you @@ -1829,37 +1865,37 @@ can bind a property to a value in a #GtkTreeModel. For example, you can bind the "active" property on the cell renderer to a boolean value in the model, thus causing the check button to reflect the state of the model. - the new cell renderer a #GdauiDataStore a #GdaDataModelIter a #GdauiSetGroup pointer - @@ -1878,7 +1914,10 @@ the model. - + + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="GDA_VALUE_ATTR_NONE"> @@ -1924,13 +1965,13 @@ the model. a string with the path of the attribute action made @@ -1940,14 +1981,14 @@ the model. - - @@ -1974,12 +2015,12 @@ the model. glib:type-name="GdauiDataCellRendererTextual" glib:get-type="gdaui_data_cell_renderer_textual_get_type" glib:type-struct="DataCellRendererTextualClass"> - Creates a new #GdauiDataCellRendererTextual. Adjust how text is drawn using object properties. Object properties can be set globally (with g_object_set()). Also, with #GtkTreeViewColumn, @@ -1987,11 +2028,11 @@ you can bind a property to a value in a #GtkTreeModel. For example, you can bind the "text" property on the cell renderer to a string value in the model, thus rendering a different string in each row of the #GtkTreeView - the new cell renderer @@ -2001,26 +2042,26 @@ of the #GtkTreeView nullable="1" allow-none="1"> a #GdaDataHandler object, or %NULL the #GType being edited options as a string - @@ -2049,13 +2090,15 @@ of the #GtkTreeView + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="GDA_VALUE_ATTR_NONE"> @@ -2097,7 +2141,7 @@ of the #GtkTreeView - - @@ -2131,7 +2175,7 @@ of the #GtkTreeView glib:type-name="GdauiDataEntry" glib:get-type="gdaui_data_entry_get_type" glib:type-struct="DataEntryInterface"> - + @@ -2139,7 +2183,7 @@ of the #GtkTreeView - + @@ -2153,7 +2197,7 @@ of the #GtkTreeView - + @@ -2164,7 +2208,7 @@ of the #GtkTreeView - + @@ -2175,7 +2219,7 @@ of the #GtkTreeView - + @@ -2189,19 +2233,19 @@ of the #GtkTreeView invoker="get_attributes" version="4.2"> Retrieves the parameters of the GdauiDataEntry widget. - + the OR'ed bits corresponding to the attributes. a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2209,19 +2253,19 @@ of the #GtkTreeView Tells if @de can be edited by the user - + %TRUE if @de is editable a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2229,26 +2273,26 @@ of the #GtkTreeView Fetch the GdaDataHandler the GdauiDataEntry is using - + the GdaDataHandler object a #GtkWidget object which implements the #GdauiDataEntry interface - + @@ -2260,22 +2304,22 @@ of the #GtkTreeView Fetch the value held in the GdauiDataEntry widget. If the value is set to NULL, the returned value is of type GDA_TYPE_NULL. If the value is set to default, then the returned value is of type GDA_TYPE_NULL or is the default value if it has been provided to the widget (and is of the same type as the one provided by @de). - + a new #GValue a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2285,19 +2329,19 @@ has been provided to the widget (and is of the same type as the one provided by invoker="get_value_type" version="4.2"> Fetch the type of data the GdauiDataEntry handles - + the GType type a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2305,16 +2349,16 @@ has been provided to the widget (and is of the same type as the one provided by Makes @de grab the focus for the window it's in - + a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2324,29 +2368,29 @@ has been provided to the widget (and is of the same type as the one provided by invoker="set_attributes" version="4.2"> Sets the parameters of the #GdauiDataEntry. Only the attributes corresponding to the mask are set, the other ones are ignored. - + a #GtkWidget object which implements the #GdauiDataEntry interface the attributes to set (OR'ed between them) the mask corresponding to the considered attributes @@ -2354,29 +2398,29 @@ mask are set, the other ones are ignored. Set if @de can be modified or not by the user - + a #GtkWidget object which implements the #GdauiDataEntry interface set to %TRUE to have an editable data entry - + @@ -2393,41 +2437,41 @@ mask are set, the other ones are ignored. invoker="set_unknown_color" version="5.0.3"> Defines the color to be used when @de displays an invalid value. Any value not between 0. and 1. will result in the default hard coded values to be used (grayish). - + a #GtkWidget object which implements the #GdauiDataEntry interface the red component of a color the green component of a color the blue component of a color the alpha component of a color @@ -2435,7 +2479,7 @@ between 0. and 1. will result in the default hard coded values to be used (grayi Push a value into the #GdauiDataEntry. The value parameter must either be: <itemizedlist> <listitem><para>of type GDA_TYPE_NULL (may be created using gda_value_new_null()) to @@ -2443,14 +2487,14 @@ between 0. and 1. will result in the default hard coded values to be used (grayi <listitem><para>of type specified using gdaui_data_entry_set_value_type(), or</para></listitem> <listitem><para>NULL to represent an undetermined value (usually an error)</para></listitem> </itemizedlist> - + a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2459,14 +2503,14 @@ between 0. and 1. will result in the default hard coded values to be used (grayi nullable="1" allow-none="1"> a #GValue, or %NULL - + @@ -2483,30 +2527,30 @@ between 0. and 1. will result in the default hard coded values to be used (grayi invoker="set_value_type" version="4.2"> Sets the type of value the GdauiDataEntry will handle. The type must be compatible with what the widget can handle. - + a #GtkWidget object which implements the #GdauiDataEntry interface the #GType of the data to be displayed - + @@ -2521,21 +2565,21 @@ the widget can handle. version="5.2" throws="1"> Tests the validity of @de's contents. This function must be overrided by implementators. Default implementation returns TRUE. - + TRUE if @de's contents is valid a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2545,19 +2589,19 @@ Default implementation returns TRUE. c:identifier="gdaui_data_entry_get_attributes" version="4.2"> Retrieves the parameters of the GdauiDataEntry widget. - + the OR'ed bits corresponding to the attributes. a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2567,19 +2611,19 @@ Default implementation returns TRUE. c:identifier="gdaui_data_entry_get_editable" version="4.2"> Tells if @de can be edited by the user - + %TRUE if @de is editable a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2589,19 +2633,19 @@ Default implementation returns TRUE. c:identifier="gdaui_data_entry_get_handler" version="4.2"> Fetch the GdaDataHandler the GdauiDataEntry is using - + the GdaDataHandler object a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2611,19 +2655,19 @@ Default implementation returns TRUE. c:identifier="gdaui_data_entry_get_reference_value" version="4.2"> Fetch the reference value held in the #GdauiDataEntry widget - + the #GValue (not modifiable) a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2633,22 +2677,22 @@ Default implementation returns TRUE. c:identifier="gdaui_data_entry_get_value" version="4.2"> Fetch the value held in the GdauiDataEntry widget. If the value is set to NULL, the returned value is of type GDA_TYPE_NULL. If the value is set to default, then the returned value is of type GDA_TYPE_NULL or is the default value if it has been provided to the widget (and is of the same type as the one provided by @de). - + a new #GValue a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2658,19 +2702,19 @@ has been provided to the widget (and is of the same type as the one provided by c:identifier="gdaui_data_entry_get_value_type" version="4.2"> Fetch the type of data the GdauiDataEntry handles - + the GType type a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2680,16 +2724,16 @@ has been provided to the widget (and is of the same type as the one provided by c:identifier="gdaui_data_entry_grab_focus" version="4.2"> Makes @de grab the focus for the window it's in - + a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2699,29 +2743,29 @@ has been provided to the widget (and is of the same type as the one provided by c:identifier="gdaui_data_entry_set_attributes" version="4.2"> Sets the parameters of the #GdauiDataEntry. Only the attributes corresponding to the mask are set, the other ones are ignored. - + a #GtkWidget object which implements the #GdauiDataEntry interface the attributes to set (OR'ed between them) the mask corresponding to the considered attributes @@ -2731,7 +2775,7 @@ mask are set, the other ones are ignored. c:identifier="gdaui_data_entry_set_default_value" version="4.2"> Sets the default value for the GdauiDataEntry which gets displayed when the user forces the default value. If it is not set then it is set to type GDA_TYPE_NULL. The value parameter must either be: @@ -2739,14 +2783,14 @@ The value parameter must either be: <listitem><para>NULL or of type GDA_TYPE_NULL, or</para></listitem> <listitem><para>of type specified using gdaui_data_entry_set_value_type().</para></listitem> </itemizedlist> - + a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2755,7 +2799,7 @@ The value parameter must either be: nullable="1" allow-none="1"> a #GValue, or %NULL @@ -2765,22 +2809,22 @@ The value parameter must either be: c:identifier="gdaui_data_entry_set_editable" version="4.2"> Set if @de can be modified or not by the user - + a #GtkWidget object which implements the #GdauiDataEntry interface set to %TRUE to have an editable data entry @@ -2790,16 +2834,16 @@ The value parameter must either be: c:identifier="gdaui_data_entry_set_reference_current" version="4.2"> Tells that the current value in @de is to be considered as the reference value - + a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2809,17 +2853,17 @@ The value parameter must either be: c:identifier="gdaui_data_entry_set_reference_value" version="4.2"> Push a value into the GdauiDataEntry in the same way as gdaui_data_entry_set_value() but also sets this value as the reference value. - + a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2828,7 +2872,7 @@ also sets this value as the reference value. nullable="1" allow-none="1"> a #GValue, or %NULL @@ -2838,41 +2882,41 @@ also sets this value as the reference value. c:identifier="gdaui_data_entry_set_unknown_color" version="5.0.3"> Defines the color to be used when @de displays an invalid value. Any value not between 0. and 1. will result in the default hard coded values to be used (grayish). - + a #GtkWidget object which implements the #GdauiDataEntry interface the red component of a color the green component of a color the blue component of a color the alpha component of a color @@ -2882,7 +2926,7 @@ between 0. and 1. will result in the default hard coded values to be used (grayi c:identifier="gdaui_data_entry_set_value" version="4.2"> Push a value into the #GdauiDataEntry. The value parameter must either be: <itemizedlist> <listitem><para>of type GDA_TYPE_NULL (may be created using gda_value_new_null()) to @@ -2890,14 +2934,14 @@ between 0. and 1. will result in the default hard coded values to be used (grayi <listitem><para>of type specified using gdaui_data_entry_set_value_type(), or</para></listitem> <listitem><para>NULL to represent an undetermined value (usually an error)</para></listitem> </itemizedlist> - + a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2906,7 +2950,7 @@ between 0. and 1. will result in the default hard coded values to be used (grayi nullable="1" allow-none="1"> a #GValue, or %NULL @@ -2916,23 +2960,23 @@ between 0. and 1. will result in the default hard coded values to be used (grayi c:identifier="gdaui_data_entry_set_value_type" version="4.2"> Sets the type of value the GdauiDataEntry will handle. The type must be compatible with what the widget can handle. - + a #GtkWidget object which implements the #GdauiDataEntry interface the #GType of the data to be displayed @@ -2943,21 +2987,21 @@ the widget can handle. version="5.2" throws="1"> Tests the validity of @de's contents. This function must be overrided by implementators. Default implementation returns TRUE. - + TRUE if @de's contents is valid a #GtkWidget object which implements the #GdauiDataEntry interface @@ -2987,7 +3031,7 @@ Default implementation returns TRUE. - + @@ -3000,13 +3044,13 @@ Default implementation returns TRUE. - + - + @@ -3019,7 +3063,7 @@ Default implementation returns TRUE. - + @@ -3032,7 +3076,7 @@ Default implementation returns TRUE. - + @@ -3045,20 +3089,20 @@ Default implementation returns TRUE. - + a #GtkWidget object which implements the #GdauiDataEntry interface the #GType of the data to be displayed @@ -3067,17 +3111,17 @@ Default implementation returns TRUE. - + the GType type a #GtkWidget object which implements the #GdauiDataEntry interface @@ -3086,14 +3130,14 @@ Default implementation returns TRUE. - + a #GtkWidget object which implements the #GdauiDataEntry interface @@ -3102,7 +3146,7 @@ Default implementation returns TRUE. nullable="1" allow-none="1"> a #GValue, or %NULL @@ -3111,17 +3155,17 @@ Default implementation returns TRUE. - + a new #GValue a #GtkWidget object which implements the #GdauiDataEntry interface @@ -3130,7 +3174,7 @@ Default implementation returns TRUE. - + @@ -3146,7 +3190,7 @@ Default implementation returns TRUE. - + @@ -3159,7 +3203,7 @@ Default implementation returns TRUE. - + @@ -3175,26 +3219,26 @@ Default implementation returns TRUE. - + a #GtkWidget object which implements the #GdauiDataEntry interface the attributes to set (OR'ed between them) the mask corresponding to the considered attributes @@ -3203,17 +3247,17 @@ Default implementation returns TRUE. - + the OR'ed bits corresponding to the attributes. a #GtkWidget object which implements the #GdauiDataEntry interface @@ -3222,17 +3266,17 @@ Default implementation returns TRUE. - + the GdaDataHandler object a #GtkWidget object which implements the #GdauiDataEntry interface @@ -3241,7 +3285,7 @@ Default implementation returns TRUE. - + @@ -3257,20 +3301,20 @@ Default implementation returns TRUE. - + a #GtkWidget object which implements the #GdauiDataEntry interface set to %TRUE to have an editable data entry @@ -3279,17 +3323,17 @@ Default implementation returns TRUE. - + %TRUE if @de is editable a #GtkWidget object which implements the #GdauiDataEntry interface @@ -3298,14 +3342,14 @@ Default implementation returns TRUE. - + a #GtkWidget object which implements the #GdauiDataEntry interface @@ -3314,7 +3358,7 @@ Default implementation returns TRUE. - + @@ -3327,38 +3371,38 @@ Default implementation returns TRUE. - + a #GtkWidget object which implements the #GdauiDataEntry interface the red component of a color the green component of a color the blue component of a color the alpha component of a color @@ -3367,17 +3411,17 @@ Default implementation returns TRUE. - + TRUE if @de's contents is valid a #GtkWidget object which implements the #GdauiDataEntry interface @@ -3386,7 +3430,7 @@ Default implementation returns TRUE. - + @@ -3394,7 +3438,7 @@ Default implementation returns TRUE. - + @@ -3402,7 +3446,7 @@ Default implementation returns TRUE. - + @@ -3410,7 +3454,7 @@ Default implementation returns TRUE. - + @@ -3424,7 +3468,7 @@ Default implementation returns TRUE. glib:type-name="GdauiDataFilter" glib:get-type="gdaui_data_filter_get_type" glib:type-struct="DataFilterClass"> - + @@ -3432,20 +3476,20 @@ Default implementation returns TRUE. c:identifier="gdaui_data_filter_new" version="4.2"> Creates a new #GdauiDataFilter widget suitable to change the filter expression for @data_widget's displayed rows - + the new widget a widget implementing the #GdauiDataProxy interface @@ -3461,7 +3505,7 @@ for @data_widget's displayed rows - + @@ -3477,23 +3521,23 @@ for @data_widget's displayed rows glib:type-name="GdauiDataProxy" glib:get-type="gdaui_data_proxy_get_type" glib:type-struct="DataProxyInterface"> - + Get a pointer to the #GdaDataProxy being used by @iface - + a #GdaDataProxy pointer an object which implements the #GdauiDataProxy interface @@ -3503,20 +3547,20 @@ for @data_widget's displayed rows invoker="get_write_mode" version="4.2"> Get the way the modifications stored in the #GdaDataProxy used internally by @iface are written back to the #GdaDataModel which holds the data displayed in @iface. - + the write mode used by @iface an object which implements the #GdauiDataProxy interface @@ -3526,32 +3570,32 @@ the #GdaDataModel which holds the data displayed in @iface. invoker="perform_action" version="4.2"> Forces the widget to perform the selected @action, as if the user had pressed on the corresponding action button in the @iface widget, if the corresponding action is possible and if the @iface widget supports the action. - + an object which implements the #GdauiDataProxy interface a #GdauiAction action - + @@ -3565,7 +3609,7 @@ supports the action. - + @@ -3585,26 +3629,26 @@ supports the action. invoker="set_write_mode" version="4.2"> Specifies the way the modifications stored in the #GdaDataProxy used internally by @iface are written back to the #GdaDataModel which holds the data displayed in @iface. - + TRUE if the proposed mode has been taken into account an object which implements the #GdauiDataProxy interface the requested #GdauiDataProxyWriteMode mode @@ -3614,25 +3658,25 @@ the #GdaDataModel which holds the data displayed in @iface. invoker="supports_action" version="6.0"> Determines if @action can be used on @iface (using gdaui_data_proxy_perform_action()). - + %TRUE if the requested action is supported, %FALSE otherwise an object which implements the #GdauiDataProxy interface a #GdauiAction action @@ -3642,29 +3686,29 @@ the #GdaDataModel which holds the data displayed in @iface. c:identifier="gdaui_data_proxy_column_set_editable" version="4.2"> Sets if the data entry in the @iface widget at @column (in the data model @iface operates on) can be edited or not. - + an object which implements the #GdauiDataProxy interface column number of the data set to %TRUE to make the column editable @@ -3674,19 +3718,19 @@ can be edited or not. c:identifier="gdaui_data_proxy_get_proxy" version="4.2"> Get a pointer to the #GdaDataProxy being used by @iface - + a #GdaDataProxy pointer an object which implements the #GdauiDataProxy interface @@ -3696,20 +3740,20 @@ can be edited or not. c:identifier="gdaui_data_proxy_get_write_mode" version="4.2"> Get the way the modifications stored in the #GdaDataProxy used internally by @iface are written back to the #GdaDataModel which holds the data displayed in @iface. - + the write mode used by @iface an object which implements the #GdauiDataProxy interface @@ -3719,25 +3763,25 @@ the #GdaDataModel which holds the data displayed in @iface. c:identifier="gdaui_data_proxy_perform_action" version="4.2"> Forces the widget to perform the selected @action, as if the user had pressed on the corresponding action button in the @iface widget, if the corresponding action is possible and if the @iface widget supports the action. - + an object which implements the #GdauiDataProxy interface a #GdauiAction action @@ -3747,26 +3791,26 @@ supports the action. c:identifier="gdaui_data_proxy_set_write_mode" version="4.2"> Specifies the way the modifications stored in the #GdaDataProxy used internally by @iface are written back to the #GdaDataModel which holds the data displayed in @iface. - + TRUE if the proposed mode has been taken into account an object which implements the #GdauiDataProxy interface the requested #GdauiDataProxyWriteMode mode @@ -3776,25 +3820,25 @@ the #GdaDataModel which holds the data displayed in @iface. c:identifier="gdaui_data_proxy_supports_action" version="6.0"> Determines if @action can be used on @iface (using gdaui_data_proxy_perform_action()). - + %TRUE if the requested action is supported, %FALSE otherwise an object which implements the #GdauiDataProxy interface a #GdauiAction action @@ -3802,7 +3846,7 @@ the #GdaDataModel which holds the data displayed in @iface. The ::proxy-changed signal is emitted each time the #GdaDataProxy which would be returned by gdaui_data_proxy_get_proxy() changes. This is generally the result of changes in the structure of the proxied data model (different number and/or type @@ -3813,7 +3857,7 @@ of columns for example). the GdaDataProxy which would be returned by gdaui_data_proxy_get_proxy() @@ -3827,7 +3871,7 @@ of columns for example). glib:type-name="GdauiDataProxyInfo" glib:get-type="gdaui_data_proxy_info_get_type" glib:type-struct="DataProxyInfoClass"> - + @@ -3836,25 +3880,26 @@ of columns for example). c:identifier="gdaui_data_proxy_info_new" version="4.2"> Creates a new #GdauiDataProxyInfo widget suitable to display information about @data_proxy - + the new widget a widget implementing the #GdauiDataProxy interface OR'ed values, specifying what to display in the new widget @@ -3864,25 +3909,26 @@ of columns for example). c:identifier="gdaui_data_proxy_info_get_item" version="6.0"> Get the #GtkToolItem corresponding to the @action action - + the #GtkToolItem, or %NULL on error a #GdauiDataProxyInfo object a #GdauiAction action @@ -3894,7 +3940,8 @@ of columns for example). + transfer-ownership="none" + default-value="GDAUI_DATA_PROXY_INFO_CURRENT_ROW"> @@ -3904,7 +3951,7 @@ of columns for example). - + @@ -3915,7 +3962,7 @@ of columns for example). - + - + - + a #GdaDataProxy pointer an object which implements the #GdauiDataProxy interface @@ -3967,7 +4014,7 @@ of columns for example). - + @@ -3986,23 +4033,23 @@ of columns for example). - + %TRUE if the requested action is supported, %FALSE otherwise an object which implements the #GdauiDataProxy interface a #GdauiAction action @@ -4011,20 +4058,20 @@ of columns for example). - + an object which implements the #GdauiDataProxy interface a #GdauiAction action @@ -4033,23 +4080,23 @@ of columns for example). - + TRUE if the proposed mode has been taken into account an object which implements the #GdauiDataProxy interface the requested #GdauiDataProxyWriteMode mode @@ -4059,17 +4106,17 @@ of columns for example). - + the write mode used by @iface an object which implements the #GdauiDataProxy interface @@ -4078,7 +4125,7 @@ of columns for example). - + @@ -4095,36 +4142,36 @@ of columns for example). Defines when the data modifications held in the underlying #GdaDataProxy are written to the data model being proxied (using gda_data_proxy_apply_row_changes()). - + write only when explicitly requested write when the current selected row changes write when user activates a value change write when a parameters's value changes @@ -4134,27 +4181,27 @@ data model being proxied (using gda_data_proxy_apply_row_changes()). glib:type-name="GdauiDataSelector" glib:get-type="gdaui_data_selector_get_type" glib:type-struct="DataSelectorInterface"> - + Get the #GdaDataModelIter object represented the current selected row in @iface. This function may return either %NULL or an invalid iterator (see gda_data_model_iter_is_valid()) if the selection cannot be represented by a single selected row. Note that the returned #GdaDataModelIter is actually an iterator iterating on the #GdaDataModel returned by the gdaui_data_selector_get_model() method. - + a pointer to a #GdaDataModelIter object, or %NULL an object which implements the #GdauiDataSelector interface @@ -4162,21 +4209,21 @@ returned by the gdaui_data_selector_get_model() method. Queries the #GdaDataModel from which the data displayed by the widget implementing @iface are. Beware that the returned data model may be different than the one used when the widget was created in case it internally uses a #GdaDataProxy. - + the #GdaDataModel an object which implements the #GdauiDataSelector interface @@ -4186,17 +4233,17 @@ widget was created in case it internally uses a #GdaDataProxy. invoker="get_selected_rows" version="4.2"> Gat an array of selected rows. If no row is selected, the the returned value is %NULL. Please note that rows refers to the "visible" rows at the time it's being called, which may change if the widget implementing this interface uses a #GdaDataProxy (as is the case for example for the #GdauiRawForm, #GdauiForm, #GdauiRawGrid and #GdauiGrid). - + an array of #gint values, one for each selected row. Use g_array_free() when finished (passing %TRUE as the last argument) @@ -4205,7 +4252,7 @@ and #GdauiGrid). an object which implements the #GdauiDataSelector interface @@ -4213,37 +4260,37 @@ and #GdauiGrid). Force the selection of a specific row. Please note that @row refers to the "visible" row at the time it's being called, which may change if the widget implementing this interface uses a #GdaDataProxy (as is the case for example for the #GdauiRawForm, #GdauiForm, #GdauiRawGrid and #GdauiGrid). - + %TRUE if the row has been selected an object which implements the #GdauiDataSelector interface the row to select - + @@ -4257,28 +4304,28 @@ and #GdauiGrid). invoker="set_column_visible" version="4.2"> Shows or hides the data at column @column - + an object which implements the #GdauiDataSelector interface a column number, starting at %0, or -1 to apply to all the columns required visibility of the data in the @column column @@ -4286,22 +4333,22 @@ and #GdauiGrid). Sets the data model from which the data being displayed are. Also see gdaui_data_selector_get_model() - + an object which implements the #GdauiDataSelector interface a #GdaDataModel to use @@ -4309,25 +4356,25 @@ and #GdauiGrid). Please note that @row refers to the "visible" row at the time it's being called, which may change if the widget implementing this interface uses a #GdaDataProxy (as is the case for example for the #GdauiRawForm, #GdauiForm, #GdauiRawGrid and #GdauiGrid). - + an object which implements the #GdauiDataSelector interface the row to unselect @@ -4337,24 +4384,24 @@ and #GdauiGrid). c:identifier="gdaui_data_selector_get_data_set" version="4.2"> Get the #GdaDataModelIter object represented the current selected row in @iface. This function may return either %NULL or an invalid iterator (see gda_data_model_iter_is_valid()) if the selection cannot be represented by a single selected row. Note that the returned #GdaDataModelIter is actually an iterator iterating on the #GdaDataModel returned by the gdaui_data_selector_get_model() method. - + a pointer to a #GdaDataModelIter object, or %NULL an object which implements the #GdauiDataSelector interface @@ -4364,21 +4411,21 @@ returned by the gdaui_data_selector_get_model() method. c:identifier="gdaui_data_selector_get_model" version="4.2"> Queries the #GdaDataModel from which the data displayed by the widget implementing @iface are. Beware that the returned data model may be different than the one used when the widget was created in case it internally uses a #GdaDataProxy. - + the #GdaDataModel an object which implements the #GdauiDataSelector interface @@ -4388,17 +4435,17 @@ widget was created in case it internally uses a #GdaDataProxy. c:identifier="gdaui_data_selector_get_selected_rows" version="4.2"> Gat an array of selected rows. If no row is selected, the the returned value is %NULL. Please note that rows refers to the "visible" rows at the time it's being called, which may change if the widget implementing this interface uses a #GdaDataProxy (as is the case for example for the #GdauiRawForm, #GdauiForm, #GdauiRawGrid and #GdauiGrid). - + an array of #gint values, one for each selected row. Use g_array_free() when finished (passing %TRUE as the last argument) @@ -4407,7 +4454,7 @@ and #GdauiGrid). an object which implements the #GdauiDataSelector interface @@ -4417,30 +4464,30 @@ and #GdauiGrid). c:identifier="gdaui_data_selector_select_row" version="4.2"> Force the selection of a specific row. Please note that @row refers to the "visible" row at the time it's being called, which may change if the widget implementing this interface uses a #GdaDataProxy (as is the case for example for the #GdauiRawForm, #GdauiForm, #GdauiRawGrid and #GdauiGrid). - + %TRUE if the row has been selected an object which implements the #GdauiDataSelector interface the row to select @@ -4450,28 +4497,28 @@ and #GdauiGrid). c:identifier="gdaui_data_selector_set_column_visible" version="4.2"> Shows or hides the data at column @column - + an object which implements the #GdauiDataSelector interface a column number, starting at %0, or -1 to apply to all the columns required visibility of the data in the @column column @@ -4481,22 +4528,22 @@ and #GdauiGrid). c:identifier="gdaui_data_selector_set_model" version="4.2"> Sets the data model from which the data being displayed are. Also see gdaui_data_selector_get_model() - + an object which implements the #GdauiDataSelector interface a #GdaDataModel to use @@ -4506,25 +4553,25 @@ and #GdauiGrid). c:identifier="gdaui_data_selector_unselect_row" version="4.2"> Please note that @row refers to the "visible" row at the time it's being called, which may change if the widget implementing this interface uses a #GdaDataProxy (as is the case for example for the #GdauiRawForm, #GdauiForm, #GdauiRawGrid and #GdauiGrid). - + an object which implements the #GdauiDataSelector interface the row to unselect @@ -4539,23 +4586,24 @@ and #GdauiGrid). - + - + the #GdaDataModel an object which implements the #GdauiDataSelector interface @@ -4564,20 +4612,21 @@ and #GdauiGrid). - + an object which implements the #GdauiDataSelector interface a #GdaDataModel to use @@ -4586,10 +4635,11 @@ and #GdauiGrid). - + an array of #gint values, one for each selected row. Use g_array_free() when finished (passing %TRUE as the last argument) @@ -4598,7 +4648,7 @@ and #GdauiGrid). an object which implements the #GdauiDataSelector interface @@ -4607,17 +4657,18 @@ and #GdauiGrid). - + a pointer to a #GdaDataModelIter object, or %NULL an object which implements the #GdauiDataSelector interface @@ -4626,23 +4677,24 @@ and #GdauiGrid). - + %TRUE if the row has been selected an object which implements the #GdauiDataSelector interface the row to select @@ -4651,20 +4703,21 @@ and #GdauiGrid). - + an object which implements the #GdauiDataSelector interface the row to unselect @@ -4673,26 +4726,27 @@ and #GdauiGrid). - + an object which implements the #GdauiDataSelector interface a column number, starting at %0, or -1 to apply to all the columns required visibility of the data in the @column column @@ -4701,7 +4755,8 @@ and #GdauiGrid). - + @@ -4725,23 +4780,23 @@ and #GdauiGrid). glib:type-name="GdauiDataStore" glib:get-type="gdaui_data_store_get_type" glib:type-struct="DataStoreClass"> - + Creates a #GtkTreeModel interface with a #GdaDataModel - + the new object a #GdaDataModel object @@ -4751,25 +4806,25 @@ and #GdauiGrid). c:identifier="gdaui_data_store_append" version="4.2"> Appends a new row. - + %TRUE if no error occurred a #GdauiDataStore object an unset #GtkTreeIter to set to the appended row @@ -4779,22 +4834,22 @@ and #GdauiGrid). c:identifier="gdaui_data_store_delete" version="4.2"> Marks the row pointed by @iter to be deleted - + a #GdauiDataStore object the considered row @@ -4804,22 +4859,22 @@ and #GdauiGrid). c:identifier="gdaui_data_store_get_iter_from_values" version="4.2"> Sets @iter to the first row where all the values in @values at the columns identified at @cols_index match. If the row can't be identified, then the contents of @iter is not modified. NOTE: the @cols_index array MUST contain a column index for each value in @values - + %TRUE if the row has been identified @iter was set a #GdauiDataStore object @@ -4828,13 +4883,13 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value caller-allocates="1" transfer-ownership="none"> an unset #GtkTreeIter to set to the requested row a list of #GValue values @@ -4842,7 +4897,7 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value an array of #gint containing the column number to match each value of @values @@ -4850,18 +4905,19 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value - + the internal #GdaDataProxy being used by @store a #GdauiDataStore object @@ -4871,25 +4927,25 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value c:identifier="gdaui_data_store_get_row_from_iter" version="4.2"> Get the number of the row represented by @iter - + the row number, or -1 if an error occurred a #GdauiDataStore object a valid #GtkTreeIter @@ -4899,37 +4955,37 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value c:identifier="gdaui_data_store_set_value" version="4.2"> Stores a value in the @store data model. - + %TRUE on success a #GdauiDataStore object the considered row the data model column the value to store (gets copied) @@ -4939,22 +4995,22 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value c:identifier="gdaui_data_store_undelete" version="4.2"> Remove the "to be deleted" mark the row pointed by @iter, if it existed. - + a #GdauiDataStore object the considered row @@ -4968,10 +5024,11 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value + transfer-ownership="none" + default-value="FALSE"> - + @@ -4981,7 +5038,7 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value - + @@ -4998,19 +5055,21 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value glib:type-name="GdauiEntry" glib:get-type="gdaui_entry_get_type" glib:type-struct="EntryClass"> - + Creates a new #GdauiEntry widget. - + the newly created #GdauiEntry widget. @@ -5020,7 +5079,7 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value nullable="1" allow-none="1"> a prefix (not modifiable) string, or %NULL @@ -5029,7 +5088,7 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value nullable="1" allow-none="1"> a suffix (not modifiable) string, or %NULL @@ -5037,34 +5096,35 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value To be defined by children classes to handle delete themselves - + a #GdauiEntry the starting position. the end position (not included in deletion), always > @start_pos an offset to add to positions using @virt_start_pos or @virt_end_pos as reference to call gtk_editable_*() @@ -5073,40 +5133,41 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value To be defined by children classes to handle insert themselves - + a #GdauiEntry the text to be inserted @text's length in bytes (not characters) the position where @text is to be inserted an offset to add to positions using @virt_pos as reference to call gtk_editable_*() @@ -5114,13 +5175,14 @@ NOTE: the @cols_index array MUST contain a column index for each value in @value If defined, sould return a text suitable to display EMPTY value, it will be called when entry was set to NULL and is becomming not NULL - + a new string, or %NULL @@ -5132,7 +5194,7 @@ entry was set to NULL and is becomming not NULL Get a new string containing the contents of the widget as a string without the prefix and/or suffix and/or format if they have been specified. This method differs from calling gtk_entry_get_text() since the latest will return the complete text @@ -5141,17 +5203,18 @@ in @entry including prefix and/or suffix and/or format. Note: %NULL may be returned if this method is called while the widget is working on some internal modifications, or if gdaui_entry_set_text() was called with a %NULL as its @text argument. - + a new string, or %NULL a #GdauiEntry. @@ -5159,74 +5222,81 @@ as its @text argument. Sets the maximum allowed length of the contents of the widget. If the current contents are longer than the given length, then they will be truncated to fit. The difference with gtk_entry_set_max_length() is that the max length does not take into account the prefix and/or suffix parts which may have been set. - + a #GdauiEntry. the maximum length of the entry, or 0 for no maximum. - + Sets @prefix as a prefix string of @entry: that string will always be displayed in the text entry, will not be modifiable, and won't be part of the returned text - + a #GdauiEntry widget a prefix string - + Sets @suffix as a suffix string of @entry: that string will always be displayed in the text entry, will not be modifiable, and won't be part of the returned text - + a #GdauiEntry widget a suffix string @@ -5234,7 +5304,7 @@ text entry, will not be modifiable, and won't be part of the returned text Sets @text into @entry. As a side effect, if @text is %NULL, then the entry will @@ -5242,14 +5312,15 @@ be completely empty, whereas if @text is the empty string (""), then @entry will display the prefix and/or suffix and/or format string if they have been set. Except this case, calling this method is similar to calling gtk_entry_set_text() - + a #GdauiEntry widget @@ -5258,7 +5329,7 @@ gtk_entry_set_text() nullable="1" allow-none="1"> the text to set into @entry, or %NULL @@ -5267,33 +5338,42 @@ gtk_entry_set_text() Sets @entry's width in characters, without taking into account any prefix or suffix (which will automatically be handled). If you want to take a prefix or suffix into account direclty, then use gtk_entry_set_width_chars() - + a #GdauiEntry widget maximum width, or -1 - + - + @@ -5303,61 +5383,64 @@ a prefix or suffix into account direclty, then use gtk_entry_set_width_chars() - + Creates a new widget which is mainly a #GtkEntry - + the new widget the data handler to be used by the new widget the requested data type (compatible with @dh) - - + + - - - + + + - @@ -5365,57 +5448,59 @@ a prefix or suffix into account direclty, then use gtk_entry_set_width_chars() Creates a new data entry widget - the new widget the data handler to be used by the new widget the requested data type (compatible with @dh) - - + + - - - + + - + - + a new string, or %NULL @@ -5428,38 +5513,39 @@ a prefix or suffix into account direclty, then use gtk_entry_set_width_chars() - + a #GdauiEntry the text to be inserted @text's length in bytes (not characters) the position where @text is to be inserted an offset to add to positions using @virt_pos as reference to call gtk_editable_*() @@ -5468,32 +5554,33 @@ a prefix or suffix into account direclty, then use gtk_entry_set_width_chars() - + a #GdauiEntry the starting position. the end position (not included in deletion), always > @start_pos an offset to add to positions using @virt_start_pos or @virt_end_pos as reference to call gtk_editable_*() @@ -5505,41 +5592,42 @@ a prefix or suffix into account direclty, then use gtk_entry_set_width_chars() - + Creates a new #GdauiEntryCombo widget. The widget is a combo box which displays a selectable list of items (the items come from the 'source->data_model' data model) The widget allows the value setting of one or more #GdaHolder objects (one for each 'source->nodes') while proposing potentially "more readable" choices. - the new widget a #GdauiSet object a #GdauiSetSource structure, part of @paramlist @@ -5548,14 +5636,14 @@ The widget allows the value setting of one or more #GdaHolder objects Get a list of all the values in @combo's data model's selected row. The list must be freed by the caller. - a new list of values @@ -5564,7 +5652,7 @@ must be freed by the caller. a #GdauiEntryCombo widet @@ -5573,14 +5661,14 @@ must be freed by the caller. Get the original values stored within @combo. The returned values are the ones within @combo, so they must not be freed afterwards; the list has to be freed afterwards. - a new list of values @@ -5589,7 +5677,7 @@ within @combo, so they must not be freed afterwards; the list has to be freed af a #GdauiEntryCombo widet @@ -5597,15 +5685,15 @@ within @combo, so they must not be freed afterwards; the list has to be freed af Get the values stored within @combo. The returned values are the ones within @combo, so they must not be freed afterwards, however the returned list has to be freed afterwards. - a new list of values @@ -5614,7 +5702,7 @@ list has to be freed afterwards. a #GdauiEntryCombo widet @@ -5623,10 +5711,10 @@ list has to be freed afterwards. Sets the default values of @combo to the specified ones. None of the values provided in the list is modified. - @@ -5634,13 +5722,13 @@ values provided in the list is modified. a #GdauiEntryCombo widet a list of #GValue values @@ -5651,10 +5739,10 @@ values provided in the list is modified. Sets the original values of @combo to the specified ones. None of the values provided in the list is modified. - @@ -5662,13 +5750,13 @@ values provided in the list is modified. a #GdauiEntryCombo widet a list of #GValue values @@ -5678,7 +5766,7 @@ values provided in the list is modified. Sets the values of @combo to the specified ones. None of the values provided in the list is modified. @@ -5689,18 +5777,18 @@ An error can occur when there is no corresponding value(s) to be displayed for the provided values. If @values is %NULL, then the entry itself is set to NULL; - %TRUE if no error occurred. a #GdauiEntryCombo widet @@ -5709,7 +5797,7 @@ If @values is %NULL, then the entry itself is set to NULL; nullable="1" allow-none="1"> a list of #GValue values, or %NULL @@ -5719,77 +5807,82 @@ If @values is %NULL, then the entry itself is set to NULL; + transfer-ownership="none" + default-value="FALSE"> - - + + - - - + + + - - + - - + + - - - + + Defines a function which creates a #GdauiDataEntry widget - + a new #GdauiDataEntry a #GdaDataHandler a #GType @@ -5798,7 +5891,7 @@ If @values is %NULL, then the entry itself is set to NULL; nullable="1" allow-none="1"> options, or %NULL @@ -5811,7 +5904,8 @@ If @values is %NULL, then the entry itself is set to NULL; glib:type-name="GdauiEntryDate" glib:get-type="gdaui_entry_date_get_type" glib:type-struct="EntryDateClass"> - + @@ -5819,19 +5913,20 @@ If @values is %NULL, then the entry itself is set to NULL; Creates a new data entry widget - + the new widget the data handler to be used by the new widget @@ -5844,7 +5939,8 @@ If @values is %NULL, then the entry itself is set to NULL; - + @@ -5852,55 +5948,59 @@ If @values is %NULL, then the entry itself is set to NULL; - + Creates a new data entry widget - + the new widget the requested data type (compatible with @dh) - - + + - - - + + + - + @@ -5908,26 +6008,26 @@ If @values is %NULL, then the entry itself is set to NULL; Creates a new data entry widget. Known options are: THOUSAND_SEP, NB_DECIMALS and CURRENCY - the new widget the data handler to be used by the new widget the requested data type (compatible with @dh) @@ -5936,7 +6036,7 @@ If @values is %NULL, then the entry itself is set to NULL; nullable="1" allow-none="1"> some options formatting the new entry, or %NULL @@ -5944,7 +6044,7 @@ If @values is %NULL, then the entry itself is set to NULL; - @@ -5955,136 +6055,41 @@ If @values is %NULL, then the entry itself is set to NULL; - + + transfer-ownership="none" + default-value="NULL"> - - + + - - - - - - - - - - - - Packs a #GtkWidget widget into the @shell. - - - - - - - a #GdauiEntryShell object - - - - a #GtkWidget to pack into @shell - - - - - - Defines the color to be used when @de displays an invalid value. Any value not -between 0. and 1. will result in the default hard coded values to be used (grayish). - create your own CSS style and apply to your application - - - - - - - a #GdauiEntryShell - - - - the red component of a color - - - - the green component of a color - - - - the blue component of a color - - - - the alpha component of a color - - - - - - - - - - - - - - - - - - + + + - + @@ -6092,26 +6097,26 @@ between 0. and 1. will result in the default hard coded values to be used (grayi Creates a new data entry widget. Known options are: MAX_SIZE, MULTILINE, and HIDDEN - the new widget the data handler to be used by the new widget the requested data type (compatible with @dh) @@ -6120,34 +6125,42 @@ between 0. and 1. will result in the default hard coded values to be used (grayi nullable="1" allow-none="1"> some options formatting the new entry, or %NULL - + - + + transfer-ownership="none" + default-value="NULL"> - - + + - - - + + + - + @@ -6165,19 +6179,20 @@ between 0. and 1. will result in the default hard coded values to be used (grayi Creates a new widget which is mainly a GtkEntry - + the new widget the data handler to be used by the new widget @@ -6190,7 +6205,8 @@ between 0. and 1. will result in the default hard coded values to be used (grayi - + @@ -6202,7 +6218,7 @@ between 0. and 1. will result in the default hard coded values to be used (grayi glib:type-name="GdauiEntryTimestamp" glib:get-type="gdaui_entry_timestamp_get_type" glib:type-struct="EntryTimestampClass"> - @@ -6211,20 +6227,20 @@ between 0. and 1. will result in the default hard coded values to be used (grayi Creates a new data entry widget - the new widget the data handler to be used by the new widget @@ -6237,378 +6253,12 @@ between 0. and 1. will result in the default hard coded values to be used (grayi - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Signals to @gwrap that the entry has been activated (that is the user -pressed ENTER for example to signify he has finished entering data) - - - - - - - a #GdauiEntryWrapper widget - - - - - - Signals to @gwrap that the entry has changed - - - - - - - a #GdauiEntryWrapper widget - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - glib:type-name="GdauiForm" glib:get-type="gdaui_form_get_type" glib:type-struct="FormClass"> - + @@ -6624,19 +6274,19 @@ pressed ENTER for example to signify he has finished entering data) Creates a new #GdauiForm widget suitable to display the data in @model - + the new widget a #GdaDataModel @@ -6648,7 +6298,8 @@ pressed ENTER for example to signify he has finished entering data) + transfer-ownership="none" + default-value="GDAUI_DATA_PROXY_INFO_CURRENT_ROW"> - + @@ -6679,7 +6330,7 @@ pressed ENTER for example to signify he has finished entering data) glib:type-name="GdauiFormattedEntry" glib:get-type="gdaui_formatted_entry_get_type" glib:type-struct="FormattedEntryClass"> - @@ -6687,7 +6338,7 @@ pressed ENTER for example to signify he has finished entering data) Creates a new #GdauiFormattedEntry widget. Characters in @format are of two types: @@ -6717,18 +6368,18 @@ if @mask is not %NULL, then it should only contains the follogin characters, whi it is then interpreted in the following way: for a character C in @format, if the character at the same position in @mask is the space character (' '), then C will not interpreted as a writable format character as defined above. @mask does not be to have the same length as @format. - the newly created #GdauiFormattedEntry widget. a format string @@ -6737,7 +6388,7 @@ character as defined above. @mask does not be to have the same length as @format nullable="1" allow-none="1"> a mask string, or %NULL @@ -6745,22 +6396,22 @@ character as defined above. @mask does not be to have the same length as @format Get @entry's contents. This function is similar to gdaui_get_text() except that it optionnally uses the information contained in @mask when gdaui_formatted_entry_new() was called to format the output differently. - a new string, or %NULL a #GdauiFormattedEntry widget @@ -6769,10 +6420,10 @@ was called to format the output differently. Specifies that @entry should call @insert_func when the user wants to insert a char which is anot allowed, to perform other actions - @@ -6780,7 +6431,7 @@ which is anot allowed, to perform other actions a #GdauiFormattedEntry widget @@ -6791,7 +6442,7 @@ which is anot allowed, to perform other actions scope="notified" closure="1"> a #GdauiFormattedEntryInsertFunc, or %NULL @@ -6801,16 +6452,22 @@ which is anot allowed, to perform other actions nullable="1" allow-none="1"> a pointer which will be passed to @insert_func - + - + @@ -6820,7 +6477,7 @@ which is anot allowed, to perform other actions - @@ -6828,7 +6485,7 @@ which is anot allowed, to perform other actions - @@ -6858,7 +6515,7 @@ which is anot allowed, to perform other actions glib:type-name="GdauiGrid" glib:get-type="gdaui_grid_get_type" glib:type-struct="GridClass"> - + @@ -6866,12 +6523,12 @@ which is anot allowed, to perform other actions Creates a new #GdauiGrid widget suitable to display the data in @model - + the new widget @@ -6881,7 +6538,7 @@ which is anot allowed, to perform other actions nullable="1" allow-none="1"> a #GdaDataModel, or %NULL @@ -6891,23 +6548,23 @@ which is anot allowed, to perform other actions c:identifier="gdaui_grid_set_sample_size" version="4.2"> Sets the size of each chunk of data to display: the maximum number of rows which can be displayed at a time. See gdaui_raw_grid_set_sample_size() and gda_data_proxy_set_sample_size() - + a #GdauiGrid widget the size of the sample displayed in @grid @@ -6919,7 +6576,8 @@ can be displayed at a time. See gdaui_raw_grid_set_sample_size() and gda_data_pr + transfer-ownership="none" + default-value="GDAUI_DATA_PROXY_INFO_CURRENT_ROW"> @@ -6935,7 +6593,7 @@ can be displayed at a time. See gdaui_raw_grid_set_sample_size() and gda_data_pr - + @@ -6948,25 +6606,25 @@ can be displayed at a time. See gdaui_raw_grid_set_sample_size() and gda_data_pr - + - + - + - + - + - + Creates a new login widget which enables the user to specify connection parameters. - + filename="libgda-ui/gdaui-login.c" + line="494">Creates a new login widget which enables the user to specify connection parameters. + a new widget + filename="libgda-ui/gdaui-login.c" + line="500">a new widget @@ -6997,14 +6655,14 @@ can be displayed at a time. See gdaui_raw_grid_set_sample_size() and gda_data_pr nullable="1" allow-none="1"> a data source name, or %NULL + filename="libgda-ui/gdaui-login.c" + line="496">a data source name, or %NULL - + @@ -7021,22 +6679,23 @@ can be displayed at a time. See gdaui_raw_grid_set_sample_size() and gda_data_pr c:identifier="gdaui_login_get_connection_information" version="4.2"> Get the information specified in @login as a pointer to a (read-only) #GdaDsnInfo. + filename="libgda-ui/gdaui-login.c" + line="568">Get the information specified in @login as a pointer to a (read-only) #GdaDsnInfo. If the connection is not specified by a DSN, then the 'name' attribute of the returned -#GdaDsnInfo will be %NULL, and otherwise it will contain the name of the selected DSN. - - +#GdaDsnInfo will be %NULL, and otherwise it will contain the name of the selected DSN or %NULL +if no DSN selected or connection specified but "OK" button pressed. + + a pointer to a (read-only) #GdaDsnInfo. + filename="libgda-ui/gdaui-login.c" + line="577">a pointer to a (read-only) #GdaDsnInfo or %NULL. a #GdauiLogin object + filename="libgda-ui/gdaui-login.c" + line="570">a #GdauiLogin object @@ -7044,37 +6703,39 @@ If the connection is not specified by a DSN, then the 'name' attribute of the re Changes the information displayed in @login, to represent @cinfo. + filename="libgda-ui/gdaui-login.c" + line="644">Changes the information displayed in @login, to represent @cinfo. If @login's mode has %GDA_UI_LOGIN_HIDE_DIRECT_CONNECTION_MODE, then if @cinfo->name is not %NULL it is displayed in the DSN selector, otherwise a warning is shown and the result is the same as having passed %NULL for the @cinfo argument. In any case @login's mode (set by gdaui_login_set_mode()) is not changed. - + a #GdauiLogin object + filename="libgda-ui/gdaui-login.c" + line="646">a #GdauiLogin object a pointer to a structure representing the information to display. + filename="libgda-ui/gdaui-login.c" + line="647">a pointer to a structure representing the information to display. - + Changes the information displayed in @login, to represent @dsn. + filename="libgda-ui/gdaui-login.c" + line="618">Changes the information displayed in @login, to represent @dsn. If @login's mode has %GDA_UI_LOGIN_HIDE_DSN_SELECTION_MODE, then the DSN information is extracted and displayed in the direct login area. @@ -7082,15 +6743,15 @@ If @dsn is not a declared data source name, then a warning is shown and the resu is the same as having passed %NULL for the @dsn argument. In any case @login's mode (set by gdaui_login_set_mode()) is not changed. - + a #GdauiLogin object + filename="libgda-ui/gdaui-login.c" + line="620">a #GdauiLogin object nullable="1" allow-none="1"> a data source name, or %NULL + filename="libgda-ui/gdaui-login.c" + line="621">a data source name, or %NULL @@ -7108,37 +6769,42 @@ In any case @login's mode (set by gdaui_login_set_mode()) is not changed. c:identifier="gdaui_login_set_mode" version="4.2"> Set how @login operates - + filename="libgda-ui/gdaui-login.c" + line="514">Set how @login operates + a #GdauiLogin object + filename="libgda-ui/gdaui-login.c" + line="516">a #GdauiLogin object a flag + filename="libgda-ui/gdaui-login.c" + line="517">a flag - + + transfer-ownership="none" + default-value="0"> - + @@ -7158,13 +6824,13 @@ In any case @login's mode (set by gdaui_login_set_mode()) is not changed. - + - + @@ -7186,9 +6852,9 @@ In any case @login's mode (set by gdaui_login_set_mode()) is not changed. Defines the aspect of the #GdauiLogin widget - + @@ -7209,7 +6875,7 @@ In any case @login's mode (set by gdaui_login_set_mode()) is not changed. glib:type-name="GdauiNumericEntry" glib:get-type="gdaui_numeric_entry_get_type" glib:type-struct="NumericEntryClass"> - @@ -7217,27 +6883,27 @@ In any case @login's mode (set by gdaui_login_set_mode()) is not changed. Creates a new #GdauiNumericEntry widget. - the newly created #GdauiNumericEntry widget. the numeric type - @@ -7248,13 +6914,22 @@ In any case @login's mode (set by gdaui_login_set_mode()) is not changed. - + - + - + @@ -7267,7 +6942,7 @@ In any case @login's mode (set by gdaui_login_set_mode()) is not changed. - @@ -7275,75 +6950,75 @@ In any case @login's mode (set by gdaui_login_set_mode()) is not changed. Structure representing a plugin. Note: @entry_create_func and @cell_create_func can't be %NULL at the same time - + the name of the plugin a description for the plugin, or %NULL the shared object implementing the plugin, can be %NULL for internal plugins number of types the plugin can handle, or %0 for any type an array of #GType, containing the accepted types, its size is @nb_g_types, or %NULL if @nb_g_types is %0 a string describing the plugin's options, or %NULL the function called to create a #GdauiDataEntry, or %NULL the function called to create a #GtkCellRenderer, or %NULL Adds a new plugin which will be used by the forms and grids. The new plugin, as described by @plugin can declare a custom widget to be used for forms, grids, or both. If a plugin is already declared with the same name as the requested name, then a warning is issued and the operation fails. - + a pointer to a structure filled to describe the new plugin. All the contained information is copied. @@ -7358,7 +7033,7 @@ a warning is issued and the operation fails. - + @@ -7371,7 +7046,8 @@ a warning is issued and the operation fails. glib:type-name="GdauiProviderSelector" glib:get-type="gdaui_provider_selector_get_type" glib:type-struct="ProviderSelectorClass"> - + @@ -7379,12 +7055,13 @@ a warning is issued and the operation fails. Create a new #GdauiProviderSelector widget. - + the newly created widget. @@ -7393,19 +7070,20 @@ a warning is issued and the operation fails. c:identifier="gdaui_provider_selector_get_provider" version="4.2"> Get the selected provider. - + the selected provider, or %NULL if no provider is selected a #GdauiProviderSelector widget @@ -7415,19 +7093,20 @@ a warning is issued and the operation fails. c:identifier="gdaui_provider_selector_get_provider_obj" version="4.2"> Get the selected provider as a #GdaServerProvider object - + a #GdaServerProvider or %NULL if an error occurred a #GdauiProviderSelector widget @@ -7437,19 +7116,20 @@ a warning is issued and the operation fails. c:identifier="gdaui_provider_selector_set_provider" version="4.2"> Forces @selector to be set on @provider - + %TRUE if @provider has been selected a #GdauiProviderSelector widget @@ -7458,7 +7138,7 @@ a warning is issued and the operation fails. nullable="1" allow-none="1"> the provider to be selected, or %NULL for the default (SQLite) @@ -7471,7 +7151,8 @@ a warning is issued and the operation fails. - + @@ -7488,7 +7169,7 @@ a warning is issued and the operation fails. glib:type-name="GdauiRawForm" glib:get-type="gdaui_raw_form_get_type" glib:type-struct="RawFormClass"> - + @@ -7496,12 +7177,12 @@ a warning is issued and the operation fails. Creates a new #GdauiRawForm widget to display data in @model - + the new widget @@ -7511,7 +7192,7 @@ a warning is issued and the operation fails. nullable="1" allow-none="1"> a #GdaDataModel, or %NULL @@ -7527,7 +7208,7 @@ a warning is issued and the operation fails. - + @@ -7544,7 +7225,7 @@ a warning is issued and the operation fails. glib:type-name="GdauiRawGrid" glib:get-type="gdaui_raw_grid_get_type" glib:type-struct="RawGridClass"> - + @@ -7552,26 +7233,26 @@ a warning is issued and the operation fails. Creates a new #GdauiRawGrid widget suitable to display the data in @model - + the new widget a #GdaDataModel - + @@ -7585,7 +7266,7 @@ a warning is issued and the operation fails. - + @@ -7602,18 +7283,18 @@ a warning is issued and the operation fails. c:identifier="gdaui_raw_grid_add_formatting_function" version="5.0.3"> This function allows you to specify that the @func function needs to be called whenever the rendering of a cell in @grid needs to be done. It is similar in purpose to the gtk_tree_view_column_set_cell_data_func() function. - + a #GdauiRawGrid widget @@ -7623,7 +7304,7 @@ to the gtk_tree_view_column_set_cell_data_func() function. closure="1" destroy="2"> a #GdauiRawGridFormatFunc function pointer @@ -7632,7 +7313,7 @@ to the gtk_tree_view_column_set_cell_data_func() function. nullable="1" allow-none="1"> a pointer to pass to the @func function when called @@ -7642,7 +7323,7 @@ to the gtk_tree_view_column_set_cell_data_func() function. allow-none="1" scope="async"> destroy notifier for @data @@ -7652,22 +7333,22 @@ to the gtk_tree_view_column_set_cell_data_func() function. c:identifier="gdaui_raw_grid_remove_formatting_function" version="5.0.3"> This function undoes what has been specified before by gdaui_raw_grid_add_formatting_function() - + a #GdauiRawGrid widget a #GdauiRawGridFormatFunc function pointer @@ -7677,30 +7358,30 @@ to the gtk_tree_view_column_set_cell_data_func() function. c:identifier="gdaui_raw_grid_set_layout_from_file" version="4.2"> Sets a grid's columns layout according an XML description contained in @file_name, for the grid identified + filename="libgda-ui/gdaui-raw-grid.c" + line="2279">Sets a grid's columns layout according an XML description contained in @file_name, for the grid identified by the @grid_name name (as an XML layout file can contain the descriptions of several forms and grids). - + a #GdauiRawGrid + filename="libgda-ui/gdaui-raw-grid.c" + line="2281">a #GdauiRawGrid XML file name to use + filename="libgda-ui/gdaui-raw-grid.c" + line="2282">XML file name to use the name of the grid to use, in @file_name + filename="libgda-ui/gdaui-raw-grid.c" + line="2283">the name of the grid to use, in @file_name @@ -7709,24 +7390,24 @@ by the @grid_name name (as an XML layout file can contain the descriptions of se c:identifier="gdaui_raw_grid_set_sample_size" version="4.2"> Sets the size of each chunk of data to display: the maximum number of rows which + filename="libgda-ui/gdaui-raw-grid.c" + line="2243">Sets the size of each chunk of data to display: the maximum number of rows which can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_set_sample_size() - + a #GdauiRawGrid + filename="libgda-ui/gdaui-raw-grid.c" + line="2245">a #GdauiRawGrid the size of the sample displayed in @grid + filename="libgda-ui/gdaui-raw-grid.c" + line="2246">the size of the sample displayed in @grid @@ -7734,15 +7415,15 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ - + a #GdauiRawGrid + filename="libgda-ui/gdaui-raw-grid.c" + line="2264">a #GdauiRawGrid @@ -7752,7 +7433,8 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ + transfer-ownership="none" + default-value="FALSE"> @@ -7769,7 +7451,7 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ Emitted when the user double clicks on a row @@ -7777,7 +7459,7 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ the row that was double clicked @@ -7785,7 +7467,7 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ Connect this signal and modify the popup menu. @@ -7793,7 +7475,7 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ a #GtkMenu to modify @@ -7803,13 +7485,13 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ - + - + @@ -7825,7 +7507,7 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ - + @@ -7841,7 +7523,7 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ - + @@ -7876,7 +7558,7 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ glib:type-name="GdauiRtEditor" glib:get-type="gdaui_rt_editor_get_type" glib:type-struct="RtEditorClass"> - + @@ -7884,12 +7566,12 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ c:identifier="gdaui_rt_editor_new" version="4.2.2"> Creates a new #GdauiRtEditor widget - + the new widget @@ -7900,7 +7582,7 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ - + @@ -7914,19 +7596,19 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ c:identifier="gdaui_rt_editor_get_contents" version="4.2.2"> Get the contents of @editor, using the markup syntax - + a new string, or %NULL if there was an error a #GdauiRtEditor @@ -7936,28 +7618,28 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ c:identifier="gdaui_rt_editor_set_contents" version="4.2.2"> Set @editor's contents. If @length is -1, @markup must be nul-terminated - + a #GdauiRtEditor the text to set in @editor, using the markup syntax (must be valid UTF-8) length of text in bytes. @@ -7967,22 +7649,22 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ c:identifier="gdaui_rt_editor_set_editable" version="4.2.2"> Set @editor's editability - + a #GdauiRtEditor whether it's editable @@ -7990,21 +7672,25 @@ can be displayed at a time. See gdaui_grid_set_sample_size() and gda_data_proxy_ Get access to the actual #GtkTextBuffer used. Do not modify it! + transfer-ownership="none" + default-value="TRUE"> Determines if the contents of the widget appears in a scrolled window or not. - + If set to %TRUE, then the default text background is removed and thus the textbackground is the default widget's background. @@ -8012,9 +7698,12 @@ This property has to be set before the widget is realized, and is taken into acc if the widget is not editable (when it's realized). - + Instead of showing the formatted text, display the raw text (in the txt2tags syntax) @@ -8030,13 +7719,13 @@ if the widget is not editable (when it's realized). - + - + @@ -8054,12 +7743,30 @@ if the widget is not editable (when it's realized). - + + + + + + + + + + + + + + + glib:type-name="GdauiServerOperation" glib:get-type="gdaui_server_operation_get_type" glib:type-struct="ServerOperationClass"> - + @@ -8075,23 +7783,24 @@ if the widget is not editable (when it's realized). c:identifier="gdaui_server_operation_new" version="4.2"> Creates a new #GdauiServerOperation widget using all the parameters provided in @paramlist. + filename="libgda-ui/gdaui-server-operation.c" + line="195">Creates a new #GdauiServerOperation widget using all the parameters provided in @paramlist. The global layout is rendered using a table (a #GtkTable), and an entry is created for each node of @paramlist. - + the new widget + filename="libgda-ui/gdaui-server-operation.c" + line="204">the new widget a #GdaServerOperation structure + filename="libgda-ui/gdaui-server-operation.c" + line="197">a #GdaServerOperation structure @@ -8100,25 +7809,26 @@ node of @paramlist. c:identifier="gdaui_server_operation_new_in_dialog" version="4.2"> Creates a new #GdauiServerOperation widget in the same way as gdaui_server_operation_new() + filename="libgda-ui/gdaui-server-operation.c" + line="1039">Creates a new #GdauiServerOperation widget in the same way as gdaui_server_operation_new() and puts it into a #GtkDialog widget. The returned dialog has the "Ok" and "Cancel" buttons which respectively return GTK_RESPONSE_ACCEPT and GTK_RESPONSE_REJECT. The #GdauiServerOperation widget is attached to the dialog using the user property "form". - + the new #GtkDialog widget + filename="libgda-ui/gdaui-server-operation.c" + line="1053">the new #GtkDialog widget a #GdaServerOperation object + filename="libgda-ui/gdaui-server-operation.c" + line="1041">a #GdaServerOperation object the parent window for the new dialog, or %NULL + filename="libgda-ui/gdaui-server-operation.c" + line="1042">the parent window for the new dialog, or %NULL the title of the dialog window, or %NULL + filename="libgda-ui/gdaui-server-operation.c" + line="1043">the title of the dialog window, or %NULL a helper text displayed at the top of the dialog, or %NULL + filename="libgda-ui/gdaui-server-operation.c" + line="1044">a helper text displayed at the top of the dialog, or %NULL @@ -8153,7 +7863,8 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper - + @@ -8166,7 +7877,8 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper + transfer-ownership="none" + default-value="FALSE"> - + @@ -8199,29 +7912,51 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper glib:type-name="GdauiSet" glib:get-type="gdaui_set_get_type" glib:type-struct="SetClass"> - + Creates a new #GdauiSet which wraps @set's properties - + the new widget a #GdaSet + + Define the default path used when saving a file, or when showing a #GtkFileChooser file chooser. + + + + + + + a path, or %NULL to unset + + + + - + @@ -8232,7 +7967,7 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper - + @@ -8248,10 +7983,10 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper - + A new #GdauiSetGroup struct @@ -8265,10 +8000,10 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper - + list of #GdauiSetGroup @@ -8277,17 +8012,17 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper a #GdauiSet object - + list of #GdauiSetSource @@ -8296,7 +8031,7 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper a #GdauiSet object @@ -8313,7 +8048,7 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper Gets emitted when @set's public data (#GdauiSetGroup or #GdauiSetSource values) have changed @@ -8321,7 +8056,7 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper Gets emitted when the data model used in @set's #GdauiSetSource has changed @@ -8329,7 +8064,7 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper the #GdauiSetSource @@ -8339,13 +8074,13 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper - + - + @@ -8358,7 +8093,7 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper - + @@ -8375,11 +8110,12 @@ The #GdauiServerOperation widget is attached to the dialog using the user proper The <structname>GdauiSetGroup</structname>. To create a new #GdauiSetGroup use #gdaiu_set_group_new. @@ -8388,22 +8124,22 @@ To free a #GdauiSetGroup, created by #gdaui_set_group_new, use #gda_set_group_fr Since 5.2, you must consider this struct as opaque. Any access to its internal must use public API. Don't try to use #gdaui_set_group_free on a struct that was created manually. - + Creates a new #GdauiSetGroup struct. - + a new #GdauiSetGroup struct. a #GdaSetGroup @@ -8411,19 +8147,19 @@ Don't try to use #gdaui_set_group_free on a struct that was created manually. Copy constructor. - + a new #GdauiSetGroup a #GdauiSetGroup @@ -8431,9 +8167,9 @@ Don't try to use #gdaui_set_group_free on a struct that was created manually. Frees any resources taken by @sg struct. If @sg is %NULL, then nothing happens. - + @@ -8443,7 +8179,7 @@ Don't try to use #gdaui_set_group_free on a struct that was created manually. a #GdauiSetGroup struct to free @@ -8453,19 +8189,19 @@ Don't try to use #gdaui_set_group_free on a struct that was created manually. Get group used by @sg. - + used #GdaSetGroup a #GdauiSetGroup struct to free @@ -8475,19 +8211,19 @@ Don't try to use #gdaui_set_group_free on a struct that was created manually. Get source used by @sg. - + used #GdaSetGroup a #GdauiSetGroup struct @@ -8497,22 +8233,22 @@ Don't try to use #gdaui_set_group_free on a struct that was created manually. Set source to @source. - + a #GdauiSetGroup struct to free a #GdaSetGroup struct @@ -8522,16 +8258,16 @@ Don't try to use #gdaui_set_group_free on a struct that was created manually. Set source to @source. if @source is #NULL, then @group nodes contains exactly one entry. - + a #GdauiSetGroup struct to free @source (nullable): a #GdauiSetSource struct or NULL @@ -8544,11 +8280,12 @@ Don't try to use #gdaui_set_group_free on a struct that was created manually. The <structname>GdauiSetSource</structname> is a ... To create a new #GdauiSetSource use #gdaui_set_source_new. @@ -8557,17 +8294,17 @@ To free a #GdauiSetSource, created by #gdaui_set_source_new, use #gdaui_set_sour Since 5.2, you must consider this struct as opaque. Any access to its internal must use public API. Don't try to use #gdaui_set_source_free on a struct that was created manually. - + Creates a new #GdauiSetSource struct. - + a new #GdauiSetSource struct. @@ -8579,19 +8316,19 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. Copy constructor. - + a new #GdauiSetSource a #GdauiSetGroup @@ -8599,9 +8336,9 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. Frees any resources taken by @s struct. If @s is %NULL, then nothing happens. - + @@ -8611,7 +8348,7 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. a #GdauiSetSource struct to free @@ -8620,10 +8357,10 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. - + array of of columns to be shown. @@ -8632,7 +8369,7 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. a #GdauiSetSource @@ -8641,17 +8378,17 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. - + number of columns to referenced. a #GdauiSetSource @@ -8660,10 +8397,10 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. - + array of of columns to be shown. @@ -8672,7 +8409,7 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. a #GdauiSetSource @@ -8681,17 +8418,17 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. - + number of columns to be shown. a #GdauiSetSource @@ -8701,19 +8438,19 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. Get source used by @sg. - + used #GdaSetSource a #GdauiSetGroup struct @@ -8723,22 +8460,22 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. Set the columns to be shown. - + a #GdauiSetSource struct to free an array of with columns numbers of referen (Primary Key) at #GdaSetSource @@ -8746,7 +8483,7 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. number of columns of the array @@ -8756,22 +8493,22 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. Set the columns to be shown. - + a #GdauiSetSource an array of with columns numbers to be shown from a #GdaSetSource @@ -8779,7 +8516,7 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. number of columns of the array @@ -8789,22 +8526,22 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. Set source to @source. - + a #GdauiSetSource struct to free a #GdaSetSource struct @@ -8818,7 +8555,7 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. - + @@ -8827,7 +8564,7 @@ Don't try to use #gdaui_set_source_free on a struct that was created manually. Creates a #GtkTreeModel interface with a #GdaTree, mapping columns to attributes' values. As an example, <literal>gdaui_tree_store_new (tree, 2, G_TYPE_STRING, "name", G_TYPE_STRING, "schema");</literal> creates @@ -8836,29 +8573,29 @@ the values of the "schema" attribute. Note that the GType has to correspond to the type of value associated with the attribute name (no type conversion is done), and a warning will be displayed in case of type mismatch. - + the new object, or %NULL if an attribute's name was NULL or an empty string a #GdaTree object number of columns in the tree store couples of (GType, attribute name) for each column, from first to last @@ -8866,38 +8603,38 @@ conversion is done), and a warning will be displayed in case of type mismatch. Creates a #GtkTreeModel interface with a #GdaTree, mapping columns to attributes' values. For more information and limitations, see gdaui_tree_store_new(). - + the new object, or %NULL if an inconsistency exists in the parameters a #GdaTree object number of columns in the tree store an array of @n_columns GType to specify the type of each column an array of @n_columns strings to specify the attribute name to map each column on @@ -8905,7 +8642,7 @@ For more information and limitations, see gdaui_tree_store_new(). - + @@ -8919,7 +8656,7 @@ For more information and limitations, see gdaui_tree_store_new(). - + @@ -8936,7 +8673,7 @@ For more information and limitations, see gdaui_tree_store_new(). - + @@ -8950,7 +8687,7 @@ For more information and limitations, see gdaui_tree_store_new(). - + @@ -8967,7 +8704,7 @@ For more information and limitations, see gdaui_tree_store_new(). - + @@ -8987,31 +8724,31 @@ For more information and limitations, see gdaui_tree_store_new(). c:identifier="gdaui_tree_store_get_iter_from_node" version="5.2"> Sets @iter to represent @node in the tree. - + %TRUE if no error occurred and @iter is valid a #GdauiTreeStore object a #GtkTreeIter a #GdaTreeNode in @store @@ -9021,25 +8758,25 @@ For more information and limitations, see gdaui_tree_store_new(). c:identifier="gdaui_tree_store_get_node" version="4.2.8"> Get the #GdaTreeNode represented by @iter. - + the #GdaTreeNode represented by @iter, or %NULL if an error occurred a #GdauiTreeStore object a valid #GtkTreeIter @@ -9126,13 +8863,13 @@ For more information and limitations, see gdaui_tree_store_new(). - + - + @@ -9148,7 +8885,7 @@ For more information and limitations, see gdaui_tree_store_new(). - + @@ -9167,7 +8904,7 @@ For more information and limitations, see gdaui_tree_store_new(). - + @@ -9186,7 +8923,7 @@ For more information and limitations, see gdaui_tree_store_new(). - + @@ -9205,7 +8942,7 @@ For more information and limitations, see gdaui_tree_store_new(). - + @@ -9232,26 +8969,344 @@ For more information and limitations, see gdaui_tree_store_new(). + + The #GdauiBasicForm widget is a form containing an entry for each #GdaHolder object +contained in a #GdaSet (specified when the form is created). A typical usage is when the +user is requested to enter a value which will be used in a statement (without any error checking for clarity): +<programlisting> +GdaStatement *stmt; +GdaSet *params; +stmt = gda_sql_parser_parse_string (parser, "SELECT * FROM customers where name LIKE ##name::string", NULL, NULL); +gda_statement_get_parameters (stmt, &amp;params, NULL); + +GtkWidget *form; +gint result; +form = gdaui_basic_form_new_in_dialog (params, NULL, "Customer search", "Enter Customer search expression"); +result = gtk_dialog_run (GTK_DIALOG (form)); +gtk_widget_destroy (form); +if (result == GTK_RESPONSE_ACCEPT) { + // execute statement + GdaDataModel *model; + model = gda_connection_statement_execute_select (cnc, stmt, params, NULL); + [...] +} +g_object_unref (params); +g_object_unref (stmt); +</programlisting> + +The default layout within a #GdauiBasicForm is a vertical column: all the data entry widgets are aligned +in a single column. This behaviour can be changed using the gdaui_basic_form_set_layout_from_file() method or +setting the <link linkend="GdauiBasicForm--xml-layout">xml-layout</link> property. + +<anchor id="GdauiBasicFormXMLLayout"/> +The #GdauiBasicForm class parses textual descriptions of XML layout which +which can be described by the following DTD. + +<programlisting><![CDATA[ +<!ELEMENT gdaui_layouts (gdaui_form | gdaui_grid)> + +<!ELEMENT gdaui_form (gdaui_section | gdaui_column | gdaui_notebook)*> +<!ATTLIST gdaui_form + name CDATA #REQUIRED + container (columns|rows|hpaned|vpaned) #IMPLIED> + +<!ELEMENT gdaui_section (gdaui_section | gdaui_column | gdaui_notebook)*> +<!ATTLIST gdaui_section + title CDATA #IMPLIED > + +<!ELEMENT gdaui_notebook (gdaui_section | gdaui_column | gdaui_notebook)*> + +<!ELEMENT gdaui_column (gdaui_entry | gdaui_placeholder)*> + +<!ELEMENT gdaui_entry EMPTY> +<!ATTLIST gdaui_entry + name CDATA #REQUIRED + editable (true|false) #IMPLIED + label CDATA #IMPLIED + plugin CDATA #IMPLIED> + +<!ELEMENT gdaui_placeholder EMPTY> +<!ATTLIST gdaui_placeholder + id CDATA #REQUIRED + label CDATA #IMPLIED> +]]></programlisting> + +<example> + <title>A GdauiBasicForm layout example</title> + <programlisting><![CDATA[ +<?xml version="1.0" encoding="UTF-8"?> +<gdaui_layouts> + <gdaui_form name="customers" container="hpaned"> + <gdaui_section title="Summary"> + <gdaui_column> + <gdaui_entry name="id" editable="no"/> + <gdaui_entry name="name"/> + <gdaui_entry name="comments" plugin="text"/> + <gdaui_entry name="total_orders" label="Total ordered" plugin="number:NB_DECIMALS=2;CURRENCY=€"/> + </gdaui_column> + </gdaui_section> + <gdaui_section title="Photo"> + <gdaui_column> + <gdaui_entry name="photo" plugin="picture"/> + </gdaui_column> + </gdaui_section> + </gdaui_form> +</gdaui_layouts> +]]></programlisting> +</example> + + + The #GdauiCloud widget displays a string for each row in a #GdaDataModel for which the size +is variable (determined either by some data in the data model, or by a function provided by +the programmer). + +Depending on the selection mode of the widget, each string can be selected by the user and +the "selection-changed" signal is emitted. + + + The #GdaUiDataEntry is an interface for widgets (simple or complex) +which lets the user view and/or modify a #GValue. + +This interface is implemented by widgets which feature data editing (usually composed of an editing +area and a button to have some more control on the value being edited). +The interface allows to control how the widget works and to query the value and the attributes +of the data held by the widget. + +The widget can store the original value (to be able to tell if the value has been changed +by the user) and a default value (which will be returned if the user explicitly forces the widget +to be set to the default value). +Control methods allow to set the type of value to be edited (the requested type must be +compatible with what the widget can handle), set the value (which replaces the currently edited +value), set the value and the original value (the value passed as argument is set and is also +considered to be the original value). + +#GdaUiDataEntry widgets are normally created using the gdaui_new_data_entry() function. + + + The #GdauiDataFilter widget can be used as a standalone widget, but is also +used internally by the #GdauiDataProxyInfo widget for its search option. + + + The #GdauiDataProxy interface is implemented by widgets which allow modifications +to a #GdaDataModel (through a #GdaDataProxy to actually proxy the changes before they +are written to the data model). + + + The #GdauiDataProxyInfo widget is a container widget which, depending on how it is configured: +<itemizedlist> + <listitem><para>proposes action buttons to change the currently displayed row, add new row, ...</para></listitem> + <listitem><para>displays information about the number of rows in a #GdauiDataProxy</para></listitem> +</itemizedlist> + + + The #GdauiDataSelector interface is implemented by widgets which allow the user +to select some data from a #GdaDataModel. Depending on the actual widget, the selection +can be a single row or more than one row. + +This interface allows one to set and get the #GdaDataModel from which data is to be selected +and offers a few other common behaviours. + +Please note that any row number in this interface is in reference to the #GdaDataModel returned by +the gdaui_data_selector_get_model() method. + + + The #GdauiDataStore object implements the #GtkTreeModel interface on top of a #GdaDataModel to be able to display its contents +in a #GtkTreeView (however you should not directly a #GdauiTreeStore with a #GtkTreeView but use +a #GdauiRauGrid or #GdauiGrid instead, see explanatione below). You should probably not have to create you own +#GdauiDataStore, but use the ones returned by gtk_tree_view_get_model() (on a #GdauiRawGrid). + +The values returned by gtk_tree_model_get() are pointers to #GValue which do actually contain the values (i.e. +gtk_tree_model_get() does not return strings, integers, or booleans directly). The returned values are the same as returned +by gda_data_model_get_value_at() or similar functions (i.e. there can be NULL values, or errors). +Here is for example a correct way to use the #GdauiDataStore object (assuming for example that column 0 is supposed to hold a string): + +<programlisting><![CDATA[GMainContext *context; +GdauiDataStore *store; +GtkTreeIter iter; + +store = ... +if (gtk_tree_model_get_iter_first (GTK_TREE_MODEL (store), &iter)) { + GValue *value; + gtk_tree_model_get(GTK_TREE_MODEL(store), &iter, 0, &value, -1); + if (value == NULL) { + // an error occured while getting the value, see gda_data_model_get() for details + } + else if (G_VALUE_HOLDS (value, G_TYPE_STRING)) { + gchar *str; + str = g_value_get_string (value); + ... + } + else if (GDA_VALUE_HOLDS_NULL (value)) { + ... + } + else { + // this should not happen if column 0 is supposed to hold a string + g_assert_not_reached (); + } +} +]]></programlisting> + + + The #GdauiLogin widget can be used when the user needs to enter +data to open a connection. It can be customized in several ways: +<itemizedlist> + <listitem><para>data source (DSN) selection can be shown or hidden</para></listitem> + <listitem><para>the button to launch the control center to declare new data sources can be +shown or hidden</para></listitem> + <listitem><para>the form to open a connection not using a DSN can be shown or hidden</para></listitem> +</itemizedlist> + + + This section describes the functions used to declare UI plugins: data entry and cell renderers. + + + The #GdauiForm widget which uses the #GdauiRawForm and adds decorations such as +information about data model size, and features searching. + + + The #GdauiGrid widget which uses the #GdauiRawGrid and adds decorations such as +information about data model size, and features searching. + + + The text entered in the editor can be formatted using bold, underline, title, ... attributes +and then extracted using a subset of the <ulink url="http://www.txt2tags.org/markup.html">txt2tags</ulink> +markup. Use this widget to edit textual fields where some markup is desirable to organize the text. + +For example the real text used to obtain the formatting in the figure is: +<programlisting> +blah //italic// blah. +and ** BOLD!//both italic and bold// Bold!** +Nice Picture: [[[R2RrUAA...y8vLy8tYQwAA]]] Yes +- List item --One-- +- List item **Two** +- sub1 +- sub2</programlisting> +where the picture's serialized data has been truncated here for readability +(between the [[[ and ]]] markers). Pictures are usually inserted using the incorporated +tollbar and not y hand (even though it's possible). + + + The #GdauiServerOperation widget allows the user to enter information to perform +Data Definition queries (all queries which are not SELECT, INSERT, UPDATE or DELETE). +For example the figure shows a #GdauiServerOperation widget set to create an index in an +SQLite database. + + + The #GdauiTreeStore implements the #GtkTreeModel interface required +to display data from a #GdaTree in a #GtkTreeView widget. + +To allow a tree to be populated only on request (ie. when the user expands a row), each +#GdaTreeNode can give the attribute named #GDA_ATTRIBUTE_TREE_NODE_UNKNOWN_CHILDREN +a boolean %TRUE #GValue to tell the #GdauiTreeStore data model to artificially add +a dummy child for the row corresponding to the #GdaTreeNode. Then the programmer +can connect to the <link linkend="GtkTreeView-test-expand-row">GtkTreeView::test-expand-row</link> +signal and update the requested children. + + + Get the default path used when saving a file, or when showing a #GtkFileChooser file chooser. +When the application starts, the default path will be the same as the onde returned by +g_get_current_dir(). + + + the default path, or %NULL + + + + + Get an icon for the database engine. + + + a #GdkPixbuf, or %NULL if none found + + + + + a database engine (case non sensitive), like "PostgreSQL", "MySQL", etc. + + + + + + Initialization of the libgda-ui library, must be called before any usage of the library. + +<itemizedlist> +<listitem><para>Note 1: gtk_init() is not called by this function and should also + be called (see Note 2 about the importance of the calling order)</para></listitem> +<listitem><para>Note 2: you should always call gtk_init() before gdaui_init().</para></listitem> +<listitem><para>Note 3: this funtion also calls gda_init() so it should not be called + again</para></listitem> +</itemizedlist> + + + + + Creates a new #GdauiDataEntry widget, taking into account the requested entry name if @plugin_name is not %NULL (if no entry of that name is found, then the default data entry widget will be created). The @plugin_name format is interpreted as two parts: &lt;plugin name&gt;:&lt;plugin options&gt;, and if the plugins has no option, then the ":&lt;plugin options&gt;" part may be omitted. - + a new #GdauiDataEntry widget, _NEVER_ %NULL a #GType @@ -9260,7 +9315,7 @@ if the plugins has no option, then the ":&lt;plugin options&gt;" part ma nullable="1" allow-none="1"> the name of an entry plugin, or %NULL diff --git a/girs/Gdk-3.0.gir b/girs/Gdk-3.0.gir index 85d2e5ba1..08ce8535e 100644 --- a/girs/Gdk-3.0.gir +++ b/girs/Gdk-3.0.gir @@ -24725,7 +24725,7 @@ See gdk_keymap_get_caps_lock_state(). - + diff --git a/girs/GdkPixdata-2.0.gir b/girs/GdkPixdata-2.0.gir index aa7124f13..47b3cbd2a 100644 --- a/girs/GdkPixdata-2.0.gir +++ b/girs/GdkPixdata-2.0.gir @@ -18,9 +18,9 @@ and/or use gtk-doc annotations. --> value="1197763408" c:type="GDK_PIXBUF_MAGIC_NUMBER"> Magic number for #GdkPixdata structures. - + deprecated="1" deprecated-version="2.32"> The length of a #GdkPixdata structure without the @pixel_data pointer. - + deprecated="1" deprecated-version="2.32"> A pixel buffer suitable for serialization and streaming. Using `GdkPixdata`, images can be compiled into an application, @@ -52,49 +52,49 @@ into a `GdkPixbuf`, use `gdk_pixbuf_from_pixdata()`. `GdkPixdata` should not be used any more. `GResource` should be used to save the original compressed images inside the program's binary - + magic number. A valid `GdkPixdata` structure must have `GDK_PIXBUF_MAGIC_NUMBER` here less than 1 to disable length checks, otherwise `GDK_PIXDATA_HEADER_LENGTH` plus the length of `pixel_data` information about colorspace, sample width and encoding, in a `GdkPixdataType` Distance in bytes between rows Width of the image in pixels Height of the image in pixels `width` x `height` pixels, encoded according to `pixdata_type` and `rowstride` @@ -107,7 +107,7 @@ into a `GdkPixbuf`, use `gdk_pixbuf_from_pixdata()`. deprecated-version="2.32" throws="1"> Deserializes (reconstruct) a #GdkPixdata structure from a byte stream. The byte stream consists of a straightforward writeout of the @@ -120,10 +120,10 @@ for validity. This function may fail with `GDK_PIXBUF_ERROR_CORRUPT_IMAGE` or `GDK_PIXBUF_ERROR_UNKNOWN_TYPE`. Use `GResource` instead. - + Upon successful deserialization `TRUE` is returned, `FALSE` otherwise. @@ -131,19 +131,19 @@ or `GDK_PIXBUF_ERROR_UNKNOWN_TYPE`. a #GdkPixdata structure to be filled in. length of the stream used for deserialization. stream of bytes containing a serialized #GdkPixdata structure. @@ -158,16 +158,16 @@ or `GDK_PIXBUF_ERROR_UNKNOWN_TYPE`. deprecated="1" deprecated-version="2.32"> Converts a `GdkPixbuf` to a `GdkPixdata`. If `use_rle` is `TRUE`, the pixel data is run-length encoded into newly-allocated memory and a pointer to that memory is returned. Use #GResource instead. - + If `use_rle` is `TRUE`, a pointer to the newly-allocated memory for the run-length encoded pixel data, otherwise `NULL`. @@ -178,19 +178,19 @@ newly-allocated memory and a pointer to that memory is returned. a `GdkPixdata` to fill. the data to fill `pixdata` with. whether to use run-length encoding for the pixel data. @@ -201,16 +201,16 @@ newly-allocated memory and a pointer to that memory is returned. deprecated="1" deprecated-version="2.32"> Serializes a #GdkPixdata structure into a byte stream. The byte stream consists of a straightforward writeout of the #GdkPixdata fields in network byte order, plus the @pixel_data bytes the structure points to. Use #GResource instead. - + A newly-allocated string containing the serialized #GdkPixdata structure. @@ -221,7 +221,7 @@ structure. a valid #GdkPixdata structure to serialize. @@ -230,7 +230,7 @@ structure. caller-allocates="0" transfer-ownership="full"> location to store the resulting stream length in. @@ -241,17 +241,17 @@ structure. deprecated="1" deprecated-version="2.32"> Generates C source code suitable for compiling images directly into programs. GdkPixbuf ships with a program called `gdk-pixbuf-csource`, which offers a command line interface to this function. Use #GResource instead. - + a newly-allocated string buffer containing the C source form of `pixdata`. @@ -259,19 +259,19 @@ a command line interface to this function. a `GdkPixdata` to convert to C source used for naming generated data structures or macros the kind of C source to be generated @@ -283,19 +283,19 @@ a command line interface to this function. deprecated-version="2.32" c:type="GdkPixdataDumpType"> An enumeration which is used by gdk_pixdata_to_csource() to determine the form of C source to be generated. The three values @GDK_PIXDATA_DUMP_PIXDATA_STREAM, @GDK_PIXDATA_DUMP_PIXDATA_STRUCT and @GDK_PIXDATA_DUMP_MACROS are mutually exclusive, as are @GDK_PIXBUF_DUMP_GTYPES and @GDK_PIXBUF_DUMP_CTYPES. The remaining elements are optional flags that can be freely added. - + Generate pixbuf data stream (a single string containing a serialized #GdkPixdata structure in network byte order). @@ -304,13 +304,13 @@ elements are optional flags that can be freely added. value="1" c:identifier="GDK_PIXDATA_DUMP_PIXDATA_STRUCT"> Generate #GdkPixdata structure (needs the #GdkPixdata structure definition from gdk-pixdata.h). Generate <function>*_ROWSTRIDE</function>, <function>*_WIDTH</function>, <function>*_HEIGHT</function>, <function>*_BYTES_PER_PIXEL</function> and @@ -319,31 +319,31 @@ elements are optional flags that can be freely added. Generate GLib data types instead of standard C data types. Generate standard C data types instead of GLib data types. Generate static symbols. Generate const symbols. Provide a <function>*_RUN_LENGTH_DECODE(image_buf, rle_data, size, bpp)</function> macro definition to decode run-length encoded image data. @@ -353,23 +353,23 @@ elements are optional flags that can be freely added. deprecated-version="2.32" c:type="GdkPixdataType"> An enumeration containing three sets of flags for a #GdkPixdata struct: one for the used colorspace, one for the width of the samples and one for the encoding of the pixel data. - + each pixel has red, green and blue samples. each pixel has red, green and blue samples and an alpha value. @@ -377,35 +377,35 @@ for the encoding of the pixel data. value="255" c:identifier="GDK_PIXDATA_COLOR_TYPE_MASK"> mask for the colortype flags of the enum. each sample has 8 bits. mask for the sample width flags of the enum. the pixel data is in raw form. the pixel data is run-length encoded. Runs may be up to 127 bytes long; their length is stored in a single byte preceding the pixel data for the run. If a run is constant, its length @@ -416,7 +416,7 @@ for the encoding of the pixel data. value="251658240" c:identifier="GDK_PIXDATA_ENCODING_MASK"> mask for the encoding flags of the enum. @@ -426,30 +426,30 @@ for the encoding of the pixel data. deprecated-version="2.32" throws="1"> Converts a `GdkPixdata` to a `GdkPixbuf`. If `copy_pixels` is `TRUE` or if the pixel data is run-length-encoded, the pixel data is copied into newly-allocated memory; otherwise it is reused. Use `GResource` instead. - + a new pixbuf a #GdkPixdata to convert into a `GdkPixbuf`. whether to copy raw pixel data; run-length encoded pixel data is always copied. diff --git a/girs/GdkWayland-4.0.gir b/girs/GdkWayland-4.0.gir index 23f30d3f5..79acd6139 100644 --- a/girs/GdkWayland-4.0.gir +++ b/girs/GdkWayland-4.0.gir @@ -401,20 +401,20 @@ with [method@GdkWayland.WaylandDisplay.query_registry]. deprecated-version="4.10."> Gets the startup notification ID for a Wayland display, or %NULL + line="955">Gets the startup notification ID for a Wayland display, or %NULL if no ID has been defined. the startup notification ID for @display + line="962">the startup notification ID for @display a `GdkDisplay` + line="957">a `GdkDisplay` @@ -424,19 +424,19 @@ if no ID has been defined. introspectable="0"> Returns the Wayland `wl_compositor` of a `GdkDisplay`. + line="1298">Returns the Wayland `wl_compositor` of a `GdkDisplay`. a Wayland `wl_compositor` + line="1304">a Wayland `wl_compositor` a `GdkDisplay` + line="1300">a `GdkDisplay` @@ -446,19 +446,19 @@ if no ID has been defined. introspectable="0"> Returns the Wayland `wl_display` of a `GdkDisplay`. + line="1282">Returns the Wayland `wl_display` of a `GdkDisplay`. a Wayland `wl_display` + line="1288">a Wayland `wl_display` a `GdkDisplay` + line="1284">a `GdkDisplay` @@ -467,26 +467,26 @@ if no ID has been defined. c:identifier="gdk_wayland_display_query_registry"> Returns %TRUE if the interface was found in the display + line="2812">Returns %TRUE if the interface was found in the display `wl_registry.global` handler. %TRUE if the global is offered by the compositor + line="2820">%TRUE if the global is offered by the compositor a `GdkDisplay` + line="2814">a `GdkDisplay` global interface to query in the registry + line="2815">global interface to query in the registry @@ -495,7 +495,7 @@ if no ID has been defined. c:identifier="gdk_wayland_display_set_cursor_theme"> Sets the cursor theme for the given @display. + line="1195">Sets the cursor theme for the given @display. @@ -504,19 +504,19 @@ if no ID has been defined. a `GdkDisplay` + line="1197">a `GdkDisplay` the new cursor theme + line="1198">the new cursor theme the size to use for cursors + line="1199">the size to use for cursors @@ -527,7 +527,7 @@ if no ID has been defined. deprecated-version="4.10."> Sets the startup notification ID for a display. + line="972">Sets the startup notification ID for a display. This is usually taken from the value of the `DESKTOP_STARTUP_ID` environment variable, but in some cases (such as the application not @@ -545,13 +545,13 @@ complete (for example, when opening a window or when calling a `GdkDisplay` + line="974">a `GdkDisplay` the startup notification ID (must be valid utf8) + line="975">the startup notification ID (must be valid utf8) diff --git a/girs/GdkX11-3.0.gir b/girs/GdkX11-3.0.gir index 1b5b5b496..2f2aedc26 100644 --- a/girs/GdkX11-3.0.gir +++ b/girs/GdkX11-3.0.gir @@ -1343,7 +1343,7 @@ an is_modifier field. version="3.10"> Returns the current workspace for @screen when running under a + line="1848">Returns the current workspace for @screen when running under a window manager that supports multiple workspaces, as described in the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification. @@ -1351,14 +1351,14 @@ in the the current workspace, or 0 if workspaces are not supported + line="1857">the current workspace, or 0 if workspaces are not supported a #GdkScreen + line="1850">a #GdkScreen @@ -1398,7 +1398,7 @@ extension, 0 is returned. version="3.10"> Returns the number of workspaces for @screen when running under a + line="1829">Returns the number of workspaces for @screen when running under a window manager that supports multiple workspaces, as described in the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification. @@ -1406,14 +1406,14 @@ in the the number of workspaces, or 0 if workspaces are not supported + line="1838">the number of workspaces, or 0 if workspaces are not supported a #GdkScreen + line="1831">a #GdkScreen @@ -1446,12 +1446,12 @@ in the version="2.2"> Returns the name of the window manager for @screen. + line="1681">Returns the name of the window manager for @screen. the name of the window manager screen @screen, or + line="1687">the name of the window manager screen @screen, or "unknown" if the window manager is unknown. The string is owned by GDK and should not be freed. @@ -1460,7 +1460,7 @@ and should not be freed. a #GdkScreen + line="1683">a #GdkScreen @@ -1521,7 +1521,7 @@ and should not be freed. version="2.2"> This function is specific to the X11 backend of GDK, and indicates + line="1588">This function is specific to the X11 backend of GDK, and indicates whether the window manager supports a certain hint from the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification. @@ -1537,20 +1537,20 @@ a window manager change. %TRUE if the window manager supports @property + line="1606">%TRUE if the window manager supports @property the relevant #GdkScreen. + line="1590">the relevant #GdkScreen. a property atom. + line="1591">a property atom. diff --git a/girs/GdkX11-4.0.gir b/girs/GdkX11-4.0.gir index 9f53f6e83..47a8af88b 100644 --- a/girs/GdkX11-4.0.gir +++ b/girs/GdkX11-4.0.gir @@ -319,14 +319,14 @@ using GDK_XID_TO_POINTER(). Tries to open a new display to the X server given by + line="1408">Tries to open a new display to the X server given by @display_name. If opening the display fails, %NULL is returned. The new display + line="1417">The new display @@ -336,7 +336,7 @@ returned. allow-none="1"> name of the X display. + line="1410">name of the X display. See the XOpenDisplay() for details. @@ -346,7 +346,7 @@ returned. c:identifier="gdk_x11_display_set_program_class"> Sets the program class. + line="1660">Sets the program class. The X11 backend uses the program class to set the class name part of the `WM_CLASS` property on toplevel windows; see the ICCCM. @@ -358,13 +358,13 @@ of the `WM_CLASS` property on toplevel windows; see the ICCCM. a `GdkDisplay` + line="1662">a `GdkDisplay` a string + line="1663">a string @@ -374,7 +374,7 @@ of the `WM_CLASS` property on toplevel windows; see the ICCCM. introspectable="0"> Sends a startup notification message of type @message_type to + line="2183">Sends a startup notification message of type @message_type to @display. This is a convenience function for use by code that implements the @@ -390,20 +390,20 @@ for definitions of the message types and keys that can be used. a `GdkDisplay` + line="2185">a `GdkDisplay` startup notification message type ("new", "change", + line="2186">startup notification message type ("new", "change", or "remove") a list of key/value pairs (as strings), terminated by a + line="2188">a list of key/value pairs (as strings), terminated by a %NULL key. (A %NULL value for a key will cause that key to be skipped in the output.) @@ -414,7 +414,7 @@ skipped in the output.) c:identifier="gdk_x11_display_error_trap_pop"> Pops the error trap pushed by gdk_x11_display_error_trap_push(). + line="2672">Pops the error trap pushed by gdk_x11_display_error_trap_push(). Will XSync() if necessary and will always block until the error is known to have occurred or not occurred, so the error code can be returned. @@ -425,14 +425,14 @@ gdk_x11_display_error_trap_pop_ignored() would be more efficient. X error code or 0 on success + line="2684">X error code or 0 on success the display + line="2674">the display @@ -441,7 +441,7 @@ gdk_x11_display_error_trap_pop_ignored() would be more efficient. c:identifier="gdk_x11_display_error_trap_pop_ignored"> Pops the error trap pushed by gdk_x11_display_error_trap_push(). + line="2694">Pops the error trap pushed by gdk_x11_display_error_trap_push(). Does not block to see if an error occurred; merely records the range of requests to ignore errors for, and ignores those errors if they arrive asynchronously. @@ -453,7 +453,7 @@ if they arrive asynchronously. the display + line="2696">the display @@ -462,7 +462,7 @@ if they arrive asynchronously. c:identifier="gdk_x11_display_error_trap_push"> Begins a range of X requests on @display for which X error events + line="2524">Begins a range of X requests on @display for which X error events will be ignored. Unignored errors (when no trap is pushed) will abort the application. Use gdk_x11_display_error_trap_pop() or gdk_x11_display_error_trap_pop_ignored()to lift a trap pushed @@ -475,7 +475,7 @@ with this function. a `GdkDisplay` + line="2526">a `GdkDisplay` @@ -484,14 +484,14 @@ with this function. c:identifier="gdk_x11_display_get_default_group"> Returns the default group leader surface for all toplevel surfaces + line="1861">Returns the default group leader surface for all toplevel surfaces on @display. This surface is implicitly created by GDK. See gdk_x11_surface_set_group(). The default group leader surface + line="1869">The default group leader surface for @display @@ -499,7 +499,7 @@ for @display a `GdkDisplay` + line="1863">a `GdkDisplay` @@ -611,7 +611,7 @@ This function returns `NULL` if GDK is using GLX. c:identifier="gdk_x11_display_get_primary_monitor"> Gets the primary monitor for the display. + line="2827">Gets the primary monitor for the display. The primary monitor is considered the monitor where the “main desktop” lives. While normal application surfaces typically allow the window @@ -624,7 +624,7 @@ If no monitor is the designated primary monitor, any monitor the primary monitor, or any monitor if no + line="2841">the primary monitor, or any monitor if no primary monitor is configured by the user @@ -632,7 +632,7 @@ If no monitor is the designated primary monitor, any monitor a `GdkDisplay` + line="2829">a `GdkDisplay` @@ -640,19 +640,19 @@ If no monitor is the designated primary monitor, any monitor Retrieves the `GdkX11Screen` of the @display. + line="2755">Retrieves the `GdkX11Screen` of the @display. the `GdkX11Screen` + line="2761">the `GdkX11Screen` a `GdkX11Display` + line="2757">a `GdkX11Display` @@ -663,19 +663,19 @@ If no monitor is the designated primary monitor, any monitor deprecated-version="4.10"> Gets the startup notification ID for a display. + line="2314">Gets the startup notification ID for a display. the startup notification ID for @display + line="2320">the startup notification ID for @display a `GdkDisplay` + line="2316">a `GdkDisplay` @@ -684,7 +684,7 @@ If no monitor is the designated primary monitor, any monitor c:identifier="gdk_x11_display_get_user_time"> Returns the timestamp of the last user interaction on + line="2297">Returns the timestamp of the last user interaction on @display. The timestamp is taken from events caused by user interaction such as key presses or pointer movements. See gdk_x11_surface_set_user_time(). @@ -692,14 +692,14 @@ movements. See gdk_x11_surface_set_user_time(). the timestamp of the last user interaction + line="2306">the timestamp of the last user interaction a `GdkDisplay` + line="2299">a `GdkDisplay` @@ -739,19 +739,19 @@ may even fall back to a few default cursors. Returns the X display of a `GdkDisplay`. + line="2032">Returns the X display of a `GdkDisplay`. an X display + line="2038">an X display a `GdkDisplay` + line="2034">a `GdkDisplay` @@ -760,19 +760,19 @@ may even fall back to a few default cursors. c:identifier="gdk_x11_display_get_xrootwindow"> Returns the root X window used by `GdkDisplay`. + line="2064">Returns the root X window used by `GdkDisplay`. an X Window + line="2070">an X Window a `GdkDisplay` + line="2066">a `GdkDisplay` @@ -780,19 +780,19 @@ may even fall back to a few default cursors. Returns the X Screen used by `GdkDisplay`. + line="2048">Returns the X Screen used by `GdkDisplay`. an X Screen + line="2054">an X Screen a `GdkDisplay` + line="2050">a `GdkDisplay` @@ -800,7 +800,7 @@ may even fall back to a few default cursors. Call XGrabServer() on @display. + line="1880">Call XGrabServer() on @display. To ungrab the display again, use gdk_x11_display_ungrab(). gdk_x11_display_grab()/gdk_x11_display_ungrab() calls can be nested. @@ -812,7 +812,7 @@ gdk_x11_display_grab()/gdk_x11_display_ungrab() calls can be nested. a `GdkDisplay` + line="1882">a `GdkDisplay` @@ -865,7 +865,7 @@ for the corresponding `GtkSetting`). deprecated-version="4.10"> Sets the startup notification ID for a display. + line="2330">Sets the startup notification ID for a display. This is usually taken from the value of the DESKTOP_STARTUP_ID environment variable, but in some cases (such as the application not @@ -888,13 +888,13 @@ gdk_display_notify_startup_complete()). a `GdkDisplay` + line="2332">a `GdkDisplay` the startup notification ID (must be valid utf8) + line="2333">the startup notification ID (must be valid utf8) @@ -903,7 +903,7 @@ gdk_display_notify_startup_complete()). c:identifier="gdk_x11_display_set_surface_scale"> Forces a specific window scale for all windows on this display, + line="2629">Forces a specific window scale for all windows on this display, instead of using the default or user configured scale. This is can be used to disable scaling support by setting @scale to 1, or to programmatically set the window scale. @@ -918,13 +918,13 @@ to later user configuration changes. the display + line="2631">the display The new scale value + line="2632">The new scale value @@ -1059,7 +1059,7 @@ nul-separated elements of the original text string.) Ungrab @display after it has been grabbed with + line="1903">Ungrab @display after it has been grabbed with gdk_x11_display_grab(). @@ -1069,7 +1069,7 @@ gdk_x11_display_grab(). a `GdkDisplay` + line="1905">a `GdkDisplay` @@ -1142,7 +1142,7 @@ gdk_x11_display_grab(). The ::xevent signal is a low level signal that is emitted + line="3085">The ::xevent signal is a low level signal that is emitted whenever an XEvent has been received. When handlers to this signal return %TRUE, no other handlers will be @@ -1160,7 +1160,7 @@ XFreeEventData() will be called afterwards. %TRUE to stop other handlers from being invoked for the event. + line="3106">%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. @@ -1171,7 +1171,7 @@ XFreeEventData() will be called afterwards. allow-none="1"> a pointer to the XEvent to process + line="3088">a pointer to the XEvent to process @@ -1295,7 +1295,7 @@ The returned geometry is in ”application pixels”, not in ”device pixels” c:identifier="gdk_x11_screen_get_current_desktop"> Returns the current workspace for @screen when running under a + line="1408">Returns the current workspace for @screen when running under a window manager that supports multiple workspaces, as described in the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification. @@ -1303,14 +1303,14 @@ in the the current workspace, or 0 if workspaces are not supported + line="1417">the current workspace, or 0 if workspaces are not supported a `GdkX11Screen` + line="1410">a `GdkX11Screen` @@ -1348,7 +1348,7 @@ extension, 0 is returned. c:identifier="gdk_x11_screen_get_number_of_desktops"> Returns the number of workspaces for @screen when running under a + line="1391">Returns the number of workspaces for @screen when running under a window manager that supports multiple workspaces, as described in the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification. @@ -1356,14 +1356,14 @@ in the the number of workspaces, or 0 if workspaces are not supported + line="1400">the number of workspaces, or 0 if workspaces are not supported a `GdkX11Screen` + line="1393">a `GdkX11Screen` @@ -1394,12 +1394,12 @@ in the c:identifier="gdk_x11_screen_get_window_manager_name"> Returns the name of the window manager for @screen. + line="1276">Returns the name of the window manager for @screen. the name of the window manager screen @screen, or + line="1282">the name of the window manager screen @screen, or "unknown" if the window manager is unknown. The string is owned by GDK and should not be freed. @@ -1408,7 +1408,7 @@ and should not be freed. a `GdkX11Screen` + line="1278">a `GdkX11Screen` @@ -1437,7 +1437,7 @@ and should not be freed. c:identifier="gdk_x11_screen_supports_net_wm_hint"> This function is specific to the X11 backend of GDK, and indicates + line="1189">This function is specific to the X11 backend of GDK, and indicates whether the window manager supports a certain hint from the [Extended Window Manager Hints](http://www.freedesktop.org/Standards/wm-spec) specification. @@ -1453,20 +1453,20 @@ a window manager change. %TRUE if the window manager supports @property + line="1207">%TRUE if the window manager supports @property the relevant `GdkX11Screen`. + line="1191">the relevant `GdkX11Screen`. name of the WM property + line="1192">name of the WM property @@ -2273,19 +2273,19 @@ be freed. c:identifier="gdk_x11_lookup_xdisplay"> Find the `GdkDisplay` corresponding to @xdisplay, if any exists. + line="1999">Find the `GdkDisplay` corresponding to @xdisplay, if any exists. the `GdkDisplay`, if found, otherwise %NULL. + line="2005">the `GdkDisplay`, if found, otherwise %NULL. a pointer to an X Display + line="2001">a pointer to an X Display @@ -2294,7 +2294,7 @@ be freed. c:identifier="gdk_x11_set_sm_client_id"> Sets the `SM_CLIENT_ID` property on the application’s leader window so that + line="2711">Sets the `SM_CLIENT_ID` property on the application’s leader window so that the window manager can save the application’s state using the X11R6 ICCCM session management protocol. @@ -2311,7 +2311,7 @@ session management and the Inter-Client Communication Conventions Manual allow-none="1"> the client id assigned by the session manager + line="2713">the client id assigned by the session manager when the connection was opened, or %NULL to remove the property. diff --git a/girs/Gdl-3.gir b/girs/Gdl-3.gir index 5b7e73956..30400a14b 100644 --- a/girs/Gdl-3.gir +++ b/girs/Gdl-3.gir @@ -3039,7 +3039,7 @@ and should not be directly accessed. Creates a new #GdlDockLayout. Instead of setting @master + line="551">Creates a new #GdlDockLayout. Instead of setting @master directly with a master object, it is possible to use a #GdlDockObject, in this case the layout will be attached to the same master than the dock object. @@ -3047,14 +3047,14 @@ object. New #GdlDockLayout item. + line="560">New #GdlDockLayout item. A master or a dock object to which the layout will be attached. + line="553">A master or a dock object to which the layout will be attached. @@ -3089,7 +3089,7 @@ Deprecated 3.6: Use gdl_dock_layout_set_master() instead. c:identifier="gdl_dock_layout_delete_layout"> Deletes the layout with the given name from the memory. + line="745">Deletes the layout with the given name from the memory. This will set #GdlDockLayout:dirty to %TRUE. @@ -3099,13 +3099,13 @@ This will set #GdlDockLayout:dirty to %TRUE. The dock item. + line="747">The dock item. The name of the layout to delete. + line="748">The name of the layout to delete. @@ -3113,12 +3113,12 @@ This will set #GdlDockLayout:dirty to %TRUE. Get the list of layout names including or not the default layout. + line="869">Get the list of layout names including or not the default layout. a #GList list + line="876">a #GList list holding the layout names. You must first free each element in the list with g_free(), then free the list itself with g_list_free(). @@ -3129,13 +3129,13 @@ This will set #GdlDockLayout:dirty to %TRUE. The layout item. + line="871">The layout item. %TRUE to include the default layout. + line="872">%TRUE to include the default layout. @@ -3146,19 +3146,19 @@ This will set #GdlDockLayout:dirty to %TRUE. version="3.6"> Retrieves the master of the object. + line="638">Retrieves the master of the object. a #GdlDockMaster object + line="644">a #GdlDockMaster object a #GdlDockLayout + line="640">a #GdlDockLayout @@ -3166,19 +3166,19 @@ This will set #GdlDockLayout:dirty to %TRUE. Checks whether the XML tree in memory is different from the file where the layout was saved. + line="854">Checks whether the XML tree in memory is different from the file where the layout was saved. %TRUE is the layout in the memory is different from the file, else %FALSE. + line="859">%TRUE is the layout in the memory is different from the file, else %FALSE. The layout item. + line="856">The layout item. @@ -3187,26 +3187,26 @@ This will set #GdlDockLayout:dirty to %TRUE. c:identifier="gdl_dock_layout_load_from_file"> Loads the layout from file with the given @filename. + line="774">Loads the layout from file with the given @filename. This will set #GdlDockLayout:dirty to %FALSE. %TRUE if @layout successfully loaded else %FALSE + line="782">%TRUE if @layout successfully loaded else %FALSE The layout item. + line="776">The layout item. The name of the file to load. + line="777">The name of the file to load. @@ -3214,7 +3214,7 @@ This will set #GdlDockLayout:dirty to %FALSE. Loads the layout with the given name from the memory. + line="657">Loads the layout with the given name from the memory. This will set #GdlDockLayout:dirty to %TRUE. See also gdl_dock_layout_load_from_file() @@ -3222,14 +3222,14 @@ See also gdl_dock_layout_load_from_file() %TRUE if layout successfully loaded else %FALSE + line="667">%TRUE if layout successfully loaded else %FALSE The dock item. + line="659">The dock item. allow-none="1"> The name of the layout to load or %NULL for a default layout name. + line="660">The name of the layout to load or %NULL for a default layout name. @@ -3246,7 +3246,7 @@ See also gdl_dock_layout_load_from_file() Saves the @layout with the given name to the memory. + line="698">Saves the @layout with the given name to the memory. This will set #GdlDockLayout:dirty to %TRUE. See also gdl_dock_layout_save_to_file(). @@ -3258,7 +3258,7 @@ See also gdl_dock_layout_save_to_file(). The dock item. + line="700">The dock item. allow-none="1"> The name of the layout to save or %NULL for a default layout name. + line="701">The name of the layout to save or %NULL for a default layout name. @@ -3275,26 +3275,26 @@ See also gdl_dock_layout_save_to_file(). This function saves the current layout in XML format to + line="815">This function saves the current layout in XML format to the file with the given @filename. %TRUE if @layout successfuly save to the file, otherwise %FALSE. + line="823">%TRUE if @layout successfuly save to the file, otherwise %FALSE. The layout item. + line="817">The layout item. Name of the file we want to save in layout + line="818">Name of the file we want to save in layout @@ -3304,7 +3304,7 @@ the file with the given @filename. glib:set-property="master"> Attach the @layout to the @master and delete the reference to + line="594">Attach the @layout to the @master and delete the reference to the master that the layout attached previously. Instead of setting @master directly with the master object, it is possible to use a #GdlDockObject, in this case the layout will be attached to the same master than the dock @@ -3317,13 +3317,13 @@ object. The layout object + line="596">The layout object The master object to which the layout will be attached + line="597">The master object to which the layout will be attached @@ -6332,7 +6332,7 @@ The second one allows to close the dock item. The layout of all docking widgets can be saved using this #GdlDockLayout + line="36">The layout of all docking widgets can be saved using this #GdlDockLayout object. It automatically monitors the layout_changed signal of the dock master and stores the position of all widgets in memory after each change. diff --git a/girs/Gdm-1.0.gir b/girs/Gdm-1.0.gir index e7ca34a26..5c8cd27c1 100644 --- a/girs/Gdm-1.0.gir +++ b/girs/Gdm-1.0.gir @@ -17,7 +17,7 @@ and/or use gtk-doc annotations. --> - + @@ -26,7 +26,7 @@ and/or use gtk-doc annotations. --> - + @@ -35,7 +35,7 @@ and/or use gtk-doc annotations. --> - + @@ -44,7 +44,7 @@ and/or use gtk-doc annotations. --> - + @@ -53,7 +53,7 @@ and/or use gtk-doc annotations. --> - + @@ -62,7 +62,7 @@ and/or use gtk-doc annotations. --> - + @@ -71,7 +71,7 @@ and/or use gtk-doc annotations. --> - + @@ -80,7 +80,7 @@ and/or use gtk-doc annotations. --> - + @@ -92,31 +92,56 @@ and/or use gtk-doc annotations. --> glib:type-name="GdmChooser" glib:get-type="gdm_chooser_get_type" glib:type-struct="ChooserIface"> - + Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Chooser.top_of_page">org.gnome.DisplayManager.Chooser</link>. + - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-Chooser.top_of_page">org.gnome.DisplayManager.Chooser</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmChooser interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. - + Handler for the #GdmChooser::handle-disconnect signal. + @@ -131,7 +156,10 @@ and/or use gtk-doc annotations. --> - + Handler for the #GdmChooser::handle-select-hostname signal. + @@ -149,19 +177,34 @@ and/or use gtk-doc annotations. --> - + c:identifier="gdm_chooser_call_disconnect" + glib:finish-func="call_disconnect_finish" + glib:sync-func="call_disconnect_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Chooser.Disconnect">Disconnect()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_chooser_call_disconnect_finish() to get the result of the operation. + +See gdm_chooser_call_disconnect_sync() for the synchronous, blocking version of this method. + + A #GdmChooserProxy. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="2"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -183,55 +232,100 @@ and/or use gtk-doc annotations. --> - - + Finishes an operation started with gdm_chooser_call_disconnect(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmChooserProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_chooser_call_disconnect(). - - + throws="1" + glib:async-func="call_disconnect"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Chooser.Disconnect">Disconnect()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_chooser_call_disconnect() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmChooserProxy. + A #GCancellable or %NULL. - + c:identifier="gdm_chooser_call_select_hostname" + glib:finish-func="call_select_hostname_finish" + glib:sync-func="call_select_hostname_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Chooser.SelectHostname">SelectHostname()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_chooser_call_select_hostname_finish() to get the result of the operation. + +See gdm_chooser_call_select_hostname_sync() for the synchronous, blocking version of this method. + + A #GdmChooserProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="3"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -253,52 +353,93 @@ and/or use gtk-doc annotations. --> - - + Finishes an operation started with gdm_chooser_call_select_hostname(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmChooserProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_chooser_call_select_hostname(). - - + throws="1" + glib:async-func="call_select_hostname"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Chooser.SelectHostname">SelectHostname()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_chooser_call_select_hostname() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmChooserProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Chooser.Disconnect">Disconnect()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmChooser. - + + A #GDBusMethodInvocation. @@ -306,39 +447,75 @@ and/or use gtk-doc annotations. --> - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Chooser.SelectHostname">SelectHostname()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmChooser. - + + A #GDBusMethodInvocation. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Chooser.Disconnect">Disconnect()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_chooser_complete_disconnect() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Chooser.SelectHostname">SelectHostname()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_chooser_complete_select_hostname() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. @@ -347,13 +524,22 @@ and/or use gtk-doc annotations. --> - + Virtual table for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Chooser.top_of_page">org.gnome.DisplayManager.Chooser</link>. + + The parent interface. + Handler for the #GdmChooser::handle-disconnect signal. - + @@ -369,8 +555,11 @@ and/or use gtk-doc annotations. --> + Handler for the #GdmChooser::handle-select-hostname signal. - + @@ -396,88 +585,217 @@ and/or use gtk-doc annotations. --> glib:type-name="GdmChooserProxy" glib:get-type="gdm_chooser_proxy_get_type" glib:type-struct="ChooserProxyClass"> - + The #GdmChooserProxy structure contains only private data and should only be accessed using the provided API. + - - - - + + Finishes an operation started with gdm_chooser_proxy_new(). + + + The constructed proxy object or %NULL if @error is set. + - - + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_chooser_proxy_new(). + + + + + + Finishes an operation started with gdm_chooser_proxy_new_for_bus(). + + + The constructed proxy object or %NULL if @error is set. + + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_chooser_proxy_new_for_bus(). + + + + + + Like gdm_chooser_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See gdm_chooser_proxy_new_for_bus() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GBusType. + + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - + + + Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Chooser.top_of_page">org.gnome.DisplayManager.Chooser</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See gdm_chooser_proxy_new() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GDBusConnection. + + + + Flags from the #GDBusProxyFlags enumeration. + + + - + allow-none="1"> + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + - + An object path. + + + - - - - - - - - - - - - + A #GCancellable or %NULL. + - - - + + + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Chooser.top_of_page">org.gnome.DisplayManager.Chooser</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_chooser_proxy_new_finish() to get the result of the operation. + +See gdm_chooser_proxy_new_sync() for the synchronous, blocking version of this constructor. + - - + + A #GDBusConnection. + + Flags from the #GDBusProxyFlags enumeration. - + + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + An object path. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="6"> + A #GAsyncReadyCallback to call when the request is satisfied. + User data to pass to @callback. - - - - - - - - - - - - - - - + + Like gdm_chooser_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_chooser_proxy_new_for_bus_finish() to get the result of the operation. + +See gdm_chooser_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + + + + A #GBusType. + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - - - - - - - - - - - - - - - - - - - + + A #GAsyncReadyCallback to call when the request is satisfied. + - - + User data to pass to @callback. + @@ -578,8 +901,14 @@ and/or use gtk-doc annotations. --> - + Class structure for #GdmChooserProxy. + + The parent class. @@ -587,7 +916,7 @@ and/or use gtk-doc annotations. --> c:type="GdmChooserProxyPrivate" disguised="1" opaque="1"> - + glib:type-name="GdmChooserSkeleton" glib:get-type="gdm_chooser_skeleton_get_type" glib:type-struct="ChooserSkeletonClass"> - + The #GdmChooserSkeleton structure contains only private data and should only be accessed using the provided API. + - - - - + + Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Chooser.top_of_page">org.gnome.DisplayManager.Chooser</link>. + + + The skeleton object. + - + @@ -619,8 +955,14 @@ and/or use gtk-doc annotations. --> - + Class structure for #GdmChooserSkeleton. + + The parent class. @@ -629,7 +971,7 @@ and/or use gtk-doc annotations. --> c:type="GdmChooserSkeletonPrivate" disguised="1" opaque="1"> - + - + Gets a #GdmChooser object that can be used to + line="1358">Gets a #GdmChooser object that can be used to verify a user's local account. - + @@ -663,7 +1008,7 @@ verify a user's local account. a #GdmClient + line="1360">a #GdmClient allow-none="1"> a #GCancellable + line="1363">a #GCancellable closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="1361">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> The data to pass to @callback + line="1362">The data to pass to @callback @@ -702,50 +1047,51 @@ verify a user's local account. throws="1"> Finishes an operation started with + line="1397">Finishes an operation started with gdm_client_get_chooser(). - + a #GdmChooser + line="1406">a #GdmChooser a #GdmClient + line="1399">a #GdmClient The #GAsyncResult from the callback + line="1400">The #GAsyncResult from the callback + throws="1" + glib:async-func="get_chooser"> Gets a #GdmChooser object that can be used + line="1429">Gets a #GdmChooser object that can be used to do do various XDMCP chooser related tasks, such as selecting a host or disconnecting. - + #GdmChooser or %NULL if caller is not a chooser + line="1439">#GdmChooser or %NULL if caller is not a chooser a #GdmClient + line="1431">a #GdmClient allow-none="1"> a #GCancellable + line="1432">a #GCancellable - + + Gets GDM's enabled pam extensions. Currently, only +`org.gnome.DisplayManager.UserVerifier.ChoiceList` and +`org.gnome.DisplayManager.UserVerifier.CustomJSON` are supported. + + + a list of extensions + + + + + + + a #GdmClient + + + + + Gets a #GdmGreeter object that can be used to + line="1032">Gets a #GdmGreeter object that can be used to verify a user's local account. - + @@ -772,7 +1146,7 @@ verify a user's local account. a #GdmClient + line="1034">a #GdmClient allow-none="1"> a #GCancellable + line="1037">a #GCancellable closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="1035">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> The data to pass to @callback + line="1036">The data to pass to @callback @@ -811,51 +1185,52 @@ verify a user's local account. throws="1"> Finishes an operation started with + line="1071">Finishes an operation started with gdm_client_get_greeter(). - + a #GdmGreeter + line="1080">a #GdmGreeter a #GdmClient + line="1073">a #GdmClient The #GAsyncResult from the callback + line="1074">The #GAsyncResult from the callback + throws="1" + glib:async-func="get_greeter"> Gets a #GdmGreeter object that can be used + line="1103">Gets a #GdmGreeter object that can be used to do do various login screen related tasks, such as selecting a users session, and starting that session. - + #GdmGreeter or %NULL if caller is not a greeter + line="1114">#GdmGreeter or %NULL if caller is not a greeter a #GdmClient + line="1105">a #GdmClient allow-none="1"> a #GCancellable + line="1106">a #GCancellable + c:identifier="gdm_client_get_remote_greeter" + glib:finish-func="get_remote_greeter_finish" + glib:sync-func="get_remote_greeter_sync"> Gets a #GdmRemoteGreeter object that can be used to + line="1197">Gets a #GdmRemoteGreeter object that can be used to verify a user's local account. - + @@ -883,7 +1260,7 @@ verify a user's local account. a #GdmClient + line="1199">a #GdmClient allow-none="1"> a #GCancellable + line="1202">a #GCancellable closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="1200">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> The data to pass to @callback + line="1201">The data to pass to @callback @@ -922,50 +1299,51 @@ verify a user's local account. throws="1"> Finishes an operation started with + line="1236">Finishes an operation started with gdm_client_get_remote_greeter(). - + a #GdmRemoteGreeter + line="1245">a #GdmRemoteGreeter a #GdmClient + line="1238">a #GdmClient The #GAsyncResult from the callback + line="1239">The #GAsyncResult from the callback + throws="1" + glib:async-func="get_remote_greeter"> Gets a #GdmRemoteGreeter object that can be used + line="1268">Gets a #GdmRemoteGreeter object that can be used to do do various remote login screen related tasks, such as disconnecting. - + #GdmRemoteGreeter or %NULL if caller is not remote + line="1278">#GdmRemoteGreeter or %NULL if caller is not remote a #GdmClient + line="1270">a #GdmClient allow-none="1"> a #GCancellable + line="1271">a #GCancellable + c:identifier="gdm_client_get_user_verifier" + glib:finish-func="get_user_verifier_finish" + glib:sync-func="get_user_verifier_sync"> Gets a #GdmUserVerifier object that can be used to + line="822">Gets a #GdmUserVerifier object that can be used to verify a user's local account. - + @@ -993,7 +1373,7 @@ verify a user's local account. a #GdmClient + line="824">a #GdmClient allow-none="1"> a #GCancellable + line="827">a #GCancellable closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + line="825">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> The data to pass to @callback + line="826">The data to pass to @callback @@ -1031,13 +1411,13 @@ verify a user's local account. c:identifier="gdm_client_get_user_verifier_choice_list"> Gets a #GdmUserVerifierChoiceList object that can be used to + line="911">Gets a #GdmUserVerifierChoiceList object that can be used to verify a user's local account. - + #GdmUserVerifierChoiceList or %NULL if user + line="918">#GdmUserVerifierChoiceList or %NULL if user verifier isn't yet fetched, or daemon doesn't support choice lists @@ -1046,7 +1426,32 @@ verifier isn't yet fetched, or daemon doesn't support choice lists a #GdmClient + line="913">a #GdmClient + + + + + + Gets a #GdmUserVerifierCustomJSON object that can be used to +verify a user's local account. + + + #GdmUserVerifierCustomJSON or %NULL if user +verifier isn't yet fetched, or daemon doesn't support the custom JSON +protocol + + + + + a #GdmClient @@ -1056,49 +1461,50 @@ verifier isn't yet fetched, or daemon doesn't support choice lists throws="1"> Finishes an operation started with + line="861">Finishes an operation started with gdm_client_get_user_verifier(). - + a #GdmUserVerifier + line="870">a #GdmUserVerifier a #GdmClient + line="863">a #GdmClient The #GAsyncResult from the callback + line="864">The #GAsyncResult from the callback + throws="1" + glib:async-func="get_user_verifier"> Gets a #GdmUserVerifier object that can be used to + line="700">Gets a #GdmUserVerifier object that can be used to verify a user's local account. - + #GdmUserVerifier or %NULL if not connected + line="709">#GdmUserVerifier or %NULL if not connected a #GdmClient + line="702">a #GdmClient allow-none="1"> a #GCancellable + line="703">a #GCancellable + c:identifier="gdm_client_open_reauthentication_channel" + glib:finish-func="open_reauthentication_channel_finish" + glib:sync-func="open_reauthentication_channel_sync"> Gets a #GdmUserVerifier object that can be used to + line="633">Gets a #GdmUserVerifier object that can be used to reauthenticate an already logged in user. - + @@ -1126,13 +1534,13 @@ reauthenticate an already logged in user. a #GdmClient + line="635">a #GdmClient user to reauthenticate + line="636">user to reauthenticate allow-none="1"> a #GCancellable + line="639">a #GCancellable closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + line="637">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1"> The data to pass to @callback + line="638">The data to pass to @callback @@ -1171,43 +1579,44 @@ reauthenticate an already logged in user. throws="1"> Finishes an operation started with + line="673">Finishes an operation started with gdm_client_open_reauthentication_channel(). - + a #GdmUserVerifier + line="682">a #GdmUserVerifier a #GdmClient + line="675">a #GdmClient The #GAsyncResult from the callback + line="676">The #GAsyncResult from the callback + throws="1" + glib:async-func="open_reauthentication_channel"> Gets a #GdmUserVerifier object that can be used to + line="560">Gets a #GdmUserVerifier object that can be used to reauthenticate an already logged in user. Free with g_object_unref to close reauthentication channel. - + #GdmUserVerifier or %NULL if @username is not + line="571">#GdmUserVerifier or %NULL if @username is not already logged in. @@ -1215,13 +1624,13 @@ already logged in. a #GdmClient + line="562">a #GdmClient user to reauthenticate + line="563">user to reauthenticate allow-none="1"> a #GCancellable + line="564">a #GCancellable @@ -1239,8 +1648,9 @@ already logged in. c:identifier="gdm_client_set_enabled_extensions"> Enables GDM's pam extensions. Currently, only -org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + line="1522">Enables GDM's pam extensions. Currently, only +`org.gnome.DisplayManager.UserVerifier.ChoiceList` and +`org.gnome.DisplayManager.UserVerifier.CustomJSON` are supported. @@ -1249,13 +1659,13 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. a #GdmClient + line="1524">a #GdmClient a list of extensions + line="1525">a list of extensions @@ -1281,7 +1691,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -1290,7 +1700,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -1299,7 +1709,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -1308,7 +1718,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -1317,7 +1727,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -1326,7 +1736,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -1335,7 +1745,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -1344,43 +1754,108 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + + + This section contains code for working with the <link linkend="gdbus-interface-org-gnome-DisplayManager-Chooser.top_of_page">org.gnome.DisplayManager.Chooser</link> D-Bus interface in C. + + + This section contains code for working with the <link linkend="gdbus-interface-org-gnome-DisplayManager-Greeter.top_of_page">org.gnome.DisplayManager.Greeter</link> D-Bus interface in C. + + + This section contains code for working with the <link linkend="gdbus-interface-org-gnome-DisplayManager-Manager.top_of_page">org.gnome.DisplayManager.Manager</link> D-Bus interface in C. + + + This section contains code for working with the <link linkend="gdbus-interface-org-gnome-DisplayManager-RemoteGreeter.top_of_page">org.gnome.DisplayManager.RemoteGreeter</link> D-Bus interface in C. + + + This section contains code for working with the <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier.top_of_page">org.gnome.DisplayManager.UserVerifier</link> D-Bus interface in C. + + + This section contains code for working with the <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-ChoiceList.top_of_page">org.gnome.DisplayManager.UserVerifier.ChoiceList</link> D-Bus interface in C. + + + This section contains code for working with the <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-CustomJSON.top_of_page">org.gnome.DisplayManager.UserVerifier.CustomJSON</link> D-Bus interface in C. + + + This section contains code for working with the <link linkend="gdbus-interface-org-gnome-DisplayManager-WorkerManager.top_of_page">org.gnome.DisplayManager.WorkerManager</link> D-Bus interface in C. + - + Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Greeter.top_of_page">org.gnome.DisplayManager.Greeter</link>. + - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-Greeter.top_of_page">org.gnome.DisplayManager.Greeter</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmGreeter interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. - + Handler for the #GdmGreeter::default-language-name-changed signal. + @@ -1394,7 +1869,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmGreeter::default-session-name-changed signal. + @@ -1408,7 +1886,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmGreeter::handle-begin-auto-login signal. + @@ -1426,7 +1907,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmGreeter::handle-get-timed-login-details signal. + @@ -1441,7 +1925,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmGreeter::handle-select-session signal. + @@ -1459,7 +1946,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmGreeter::handle-select-user signal. + @@ -1477,7 +1967,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmGreeter::handle-start-session-when-ready signal. + @@ -1497,8 +1990,29 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + + Handler for the #GdmGreeter::handle-stop-conflicting-session signal. + + + + + + + + + + + + + - + Handler for the #GdmGreeter::reauthenticated signal. + @@ -1512,7 +2026,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmGreeter::selected-user-changed signal. + @@ -1526,7 +2043,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmGreeter::session-opened signal. + @@ -1537,10 +2057,16 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + + + - + Handler for the #GdmGreeter::timed-login-requested signal. + @@ -1557,22 +2083,40 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + c:identifier="gdm_greeter_call_begin_auto_login" + glib:finish-func="call_begin_auto_login_finish" + glib:sync-func="call_begin_auto_login_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.BeginAutoLogin">BeginAutoLogin()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_greeter_call_begin_auto_login_finish() to get the result of the operation. + +See gdm_greeter_call_begin_auto_login_sync() for the synchronous, blocking version of this method. + + A #GdmGreeterProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="3"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -1594,55 +2144,100 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_greeter_call_begin_auto_login(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmGreeterProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_greeter_call_begin_auto_login(). - - + throws="1" + glib:async-func="call_begin_auto_login"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.BeginAutoLogin">BeginAutoLogin()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_greeter_call_begin_auto_login() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmGreeterProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. - + c:identifier="gdm_greeter_call_get_timed_login_details" + glib:finish-func="call_get_timed_login_details_finish" + glib:sync-func="call_get_timed_login_details_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.GetTimedLoginDetails">GetTimedLoginDetails()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_greeter_call_get_timed_login_details_finish() to get the result of the operation. + +See gdm_greeter_call_get_timed_login_details_sync() for the synchronous, blocking version of this method. + + A #GdmGreeterProxy. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="2"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -1664,73 +2265,166 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_greeter_call_get_timed_login_details(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmGreeterProxy. - + + Return location for return parameter or %NULL to ignore. - + + Return location for return parameter or %NULL to ignore. - + + Return location for return parameter or %NULL to ignore. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_greeter_call_get_timed_login_details(). - - + throws="1" + glib:async-func="call_get_timed_login_details"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.GetTimedLoginDetails">GetTimedLoginDetails()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_greeter_call_get_timed_login_details() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmGreeterProxy. - + + Return location for return parameter or %NULL to ignore. - + + Return location for return parameter or %NULL to ignore. - + + Return location for return parameter or %NULL to ignore. + A #GCancellable or %NULL. - + c:identifier="gdm_greeter_call_select_session" + glib:finish-func="call_select_session_finish" + glib:sync-func="call_select_session_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.SelectSession">SelectSession()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_greeter_call_select_session_finish() to get the result of the operation. + +See gdm_greeter_call_select_session_sync() for the synchronous, blocking version of this method. + + A #GdmGreeterProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="3"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -1752,58 +2452,106 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_greeter_call_select_session(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmGreeterProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_greeter_call_select_session(). - - + throws="1" + glib:async-func="call_select_session"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.SelectSession">SelectSession()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_greeter_call_select_session() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmGreeterProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. - + c:identifier="gdm_greeter_call_select_user" + glib:finish-func="call_select_user_finish" + glib:sync-func="call_select_user_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.SelectUser">SelectUser()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_greeter_call_select_user_finish() to get the result of the operation. + +See gdm_greeter_call_select_user_sync() for the synchronous, blocking version of this method. + + A #GdmGreeterProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="3"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -1825,61 +2579,112 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_greeter_call_select_user(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmGreeterProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_greeter_call_select_user(). - - + throws="1" + glib:async-func="call_select_user"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.SelectUser">SelectUser()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_greeter_call_select_user() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmGreeterProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. - + c:identifier="gdm_greeter_call_start_session_when_ready" + glib:finish-func="call_start_session_when_ready_finish" + glib:sync-func="call_start_session_when_ready_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.StartSessionWhenReady">StartSessionWhenReady()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_greeter_call_start_session_when_ready_finish() to get the result of the operation. + +See gdm_greeter_call_start_session_when_ready_sync() for the synchronous, blocking version of this method. + + A #GdmGreeterProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="4"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -1901,55 +2712,214 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_greeter_call_start_session_when_ready(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmGreeterProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_greeter_call_start_session_when_ready(). - - + throws="1" + glib:async-func="call_start_session_when_ready"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.StartSessionWhenReady">StartSessionWhenReady()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_greeter_call_start_session_when_ready() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmGreeterProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. + + + + + + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.StopConflictingSession">StopConflictingSession()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_greeter_call_stop_conflicting_session_finish() to get the result of the operation. + +See gdm_greeter_call_stop_conflicting_session_sync() for the synchronous, blocking version of this method. + + + + + + + A #GdmGreeterProxy. + + + + A #GCancellable or %NULL. + + + + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + + + + User data to pass to @callback. + + + + + + Finishes an operation started with gdm_greeter_call_stop_conflicting_session(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + + + + + A #GdmGreeterProxy. + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_greeter_call_stop_conflicting_session(). + + + + + + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.StopConflictingSession">StopConflictingSession()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_greeter_call_stop_conflicting_session() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + + + + + A #GdmGreeterProxy. + + + + A #GCancellable or %NULL. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.BeginAutoLogin">BeginAutoLogin()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmGreeter. - + + A #GDBusMethodInvocation. @@ -1957,40 +2927,71 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.GetTimedLoginDetails">GetTimedLoginDetails()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmGreeter. - + + A #GDBusMethodInvocation. + Parameter to return. + Parameter to return. + Parameter to return. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.SelectSession">SelectSession()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmGreeter. - + + A #GDBusMethodInvocation. @@ -1998,15 +2999,26 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.SelectUser">SelectUser()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmGreeter. - + + A #GDBusMethodInvocation. @@ -2014,15 +3026,53 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.StartSessionWhenReady">StartSessionWhenReady()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmGreeter. - + + A #GDBusMethodInvocation. + + + + + + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.StopConflictingSession">StopConflictingSession()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + + + + + + A #GdmGreeter. + + + + A #GDBusMethodInvocation. @@ -2030,221 +3080,432 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.DefaultLanguageNameChanged">"DefaultLanguageNameChanged"</link> D-Bus signal. + + A #GdmGreeter. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.DefaultSessionNameChanged">"DefaultSessionNameChanged"</link> D-Bus signal. + + A #GdmGreeter. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.Reauthenticated">"Reauthenticated"</link> D-Bus signal. + + A #GdmGreeter. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.SelectedUserChanged">"SelectedUserChanged"</link> D-Bus signal. + + A #GdmGreeter. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.SessionOpened">"SessionOpened"</link> D-Bus signal. + + A #GdmGreeter. + Argument to pass with the signal. + + + + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.TimedLoginRequested">"TimedLoginRequested"</link> D-Bus signal. + + A #GdmGreeter. + Argument to pass with the signal. + Argument to pass with the signal. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.DefaultLanguageNameChanged">"DefaultLanguageNameChanged"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.DefaultSessionNameChanged">"DefaultSessionNameChanged"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.BeginAutoLogin">BeginAutoLogin()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_greeter_complete_begin_auto_login() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.GetTimedLoginDetails">GetTimedLoginDetails()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_greeter_complete_get_timed_login_details() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.SelectSession">SelectSession()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_greeter_complete_select_session() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.SelectUser">SelectUser()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_greeter_complete_select_user() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.StartSessionWhenReady">StartSessionWhenReady()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_greeter_complete_start_session_when_ready() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. - + + Argument passed by remote caller. + + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Greeter.StopConflictingSession">StopConflictingSession()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_greeter_complete_stop_conflicting_session() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. + + + + + A #GDBusMethodInvocation. + + + + + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.Reauthenticated">"Reauthenticated"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.SelectedUserChanged">"SelectedUserChanged"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.SessionOpened">"SessionOpened"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. + + + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-Greeter.TimedLoginRequested">"TimedLoginRequested"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. - + + Argument. @@ -2253,13 +3514,22 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Virtual table for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Greeter.top_of_page">org.gnome.DisplayManager.Greeter</link>. + + The parent interface. + Handler for the #GdmGreeter::handle-begin-auto-login signal. - + @@ -2278,8 +3548,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmGreeter::handle-get-timed-login-details signal. - + @@ -2295,8 +3568,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmGreeter::handle-select-session signal. - + @@ -2315,8 +3591,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmGreeter::handle-select-user signal. - + @@ -2335,8 +3614,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmGreeter::handle-start-session-when-ready signal. - + @@ -2358,9 +3640,32 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + + Handler for the #GdmGreeter::handle-stop-conflicting-session signal. + + + + + + + + + + + + + + + + Handler for the #GdmGreeter::default-language-name-changed signal. - + @@ -2375,8 +3680,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmGreeter::default-session-name-changed signal. - + @@ -2391,8 +3699,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmGreeter::reauthenticated signal. - + @@ -2407,8 +3718,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmGreeter::selected-user-changed signal. - + @@ -2423,8 +3737,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmGreeter::session-opened signal. - + @@ -2435,12 +3752,18 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + + + + Handler for the #GdmGreeter::timed-login-requested signal. - + @@ -2465,88 +3788,217 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmGreeterProxy" glib:get-type="gdm_greeter_proxy_get_type" glib:type-struct="GreeterProxyClass"> - + The #GdmGreeterProxy structure contains only private data and should only be accessed using the provided API. + - - - - + + Finishes an operation started with gdm_greeter_proxy_new(). + + + The constructed proxy object or %NULL if @error is set. + - - + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_greeter_proxy_new(). + + + + + + Finishes an operation started with gdm_greeter_proxy_new_for_bus(). + + + The constructed proxy object or %NULL if @error is set. + + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_greeter_proxy_new_for_bus(). + + + + + + Like gdm_greeter_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See gdm_greeter_proxy_new_for_bus() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GBusType. + + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - + + + Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Greeter.top_of_page">org.gnome.DisplayManager.Greeter</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See gdm_greeter_proxy_new() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GDBusConnection. + + + + Flags from the #GDBusProxyFlags enumeration. + + + - + allow-none="1"> + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + - + An object path. + + + - - - - - - - - - - - - + A #GCancellable or %NULL. + - - - + + + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Greeter.top_of_page">org.gnome.DisplayManager.Greeter</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_greeter_proxy_new_finish() to get the result of the operation. + +See gdm_greeter_proxy_new_sync() for the synchronous, blocking version of this constructor. + - - + + A #GDBusConnection. + + Flags from the #GDBusProxyFlags enumeration. - + + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + An object path. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="6"> + A #GAsyncReadyCallback to call when the request is satisfied. + User data to pass to @callback. - - - - + + Like gdm_greeter_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_greeter_proxy_new_for_bus_finish() to get the result of the operation. + +See gdm_greeter_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + + + - - - - - - - - - - - - - + + A #GBusType. + + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - - - - - - - - - - - - - - - - - - - + + A #GAsyncReadyCallback to call when the request is satisfied. + - - + User data to pass to @callback. + @@ -2647,8 +4104,14 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Class structure for #GdmGreeterProxy. + + The parent class. @@ -2656,7 +4119,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. c:type="GdmGreeterProxyPrivate" disguised="1" opaque="1"> - + glib:type-name="GdmGreeterSkeleton" glib:get-type="gdm_greeter_skeleton_get_type" glib:type-struct="GreeterSkeletonClass"> - + The #GdmGreeterSkeleton structure contains only private data and should only be accessed using the provided API. + - - - - + + Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Greeter.top_of_page">org.gnome.DisplayManager.Greeter</link>. + + + The skeleton object. + - + @@ -2688,8 +4158,14 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Class structure for #GdmGreeterSkeleton. + + The parent class. @@ -2698,12 +4174,12 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. c:type="GdmGreeterSkeletonPrivate" disguised="1" opaque="1"> - + - + @@ -2712,7 +4188,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2721,7 +4197,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2730,7 +4206,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2739,7 +4215,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2748,7 +4224,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2757,7 +4233,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2766,7 +4242,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2775,7 +4251,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2784,7 +4260,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2838,7 +4314,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2847,7 +4323,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2856,7 +4332,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2865,7 +4341,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2874,7 +4350,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2883,7 +4359,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2892,7 +4368,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2901,7 +4377,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2910,7 +4386,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2919,7 +4395,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2928,7 +4404,52 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2937,7 +4458,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2946,7 +4467,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2955,7 +4476,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2964,7 +4485,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2982,7 +4503,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -2991,7 +4512,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -3000,7 +4521,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -3009,7 +4530,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -3093,41 +4614,81 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmManager" glib:get-type="gdm_manager_get_type" glib:type-struct="ManagerIface"> + Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Manager.top_of_page">org.gnome.DisplayManager.Manager</link>. + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-Manager.top_of_page">org.gnome.DisplayManager.Manager</link> D-Bus interface. - + + A #GDBusInterfaceInfo. Do not free. + Overrides all #GObject properties in the #GdmManager interface for a concrete class. +The properties are overridden in the order they are defined. + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. - + + Gets the value of the <link linkend="gdbus-property-org-gnome-DisplayManager-Manager.Version">"Version"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use gdm_manager_dup_version() if on another thread. - + + The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. + A #GdmManager. + Handler for the #GdmManager::handle-open-reauthentication-channel signal. @@ -3146,6 +4707,9 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmManager::handle-open-session signal. @@ -3161,6 +4725,9 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmManager::handle-register-display signal. @@ -3179,6 +4746,9 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmManager::handle-register-session signal. @@ -3197,22 +4767,40 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + c:identifier="gdm_manager_call_open_reauthentication_channel" + glib:finish-func="call_open_reauthentication_channel_finish" + glib:sync-func="call_open_reauthentication_channel_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.OpenReauthenticationChannel">OpenReauthenticationChannel()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_manager_call_open_reauthentication_channel_finish() to get the result of the operation. + +See gdm_manager_call_open_reauthentication_channel_sync() for the synchronous, blocking version of this method. + A #GdmManagerProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="3"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -3234,61 +4828,122 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Finishes an operation started with gdm_manager_call_open_reauthentication_channel(). - + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmManagerProxy. - + + Return location for return parameter or %NULL to ignore. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_manager_call_open_reauthentication_channel(). + throws="1" + glib:async-func="call_open_reauthentication_channel"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.OpenReauthenticationChannel">OpenReauthenticationChannel()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_manager_call_open_reauthentication_channel() for the asynchronous version of this method. - + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmManagerProxy. + Argument to pass with the method invocation. - + + Return location for return parameter or %NULL to ignore. + A #GCancellable or %NULL. + c:identifier="gdm_manager_call_open_session" + glib:finish-func="call_open_session_finish" + glib:sync-func="call_open_session_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.OpenSession">OpenSession()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_manager_call_open_session_finish() to get the result of the operation. + +See gdm_manager_call_open_session_sync() for the synchronous, blocking version of this method. + A #GdmManagerProxy. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="2"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -3310,61 +4971,122 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Finishes an operation started with gdm_manager_call_open_session(). - + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmManagerProxy. - + + Return location for return parameter or %NULL to ignore. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_manager_call_open_session(). + throws="1" + glib:async-func="call_open_session"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.OpenSession">OpenSession()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_manager_call_open_session() for the asynchronous version of this method. - + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmManagerProxy. - + + Return location for return parameter or %NULL to ignore. + A #GCancellable or %NULL. + c:identifier="gdm_manager_call_register_display" + glib:finish-func="call_register_display_finish" + glib:sync-func="call_register_display_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.RegisterDisplay">RegisterDisplay()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_manager_call_register_display_finish() to get the result of the operation. + +See gdm_manager_call_register_display_sync() for the synchronous, blocking version of this method. + A #GdmManagerProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="3"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -3386,58 +5114,106 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Finishes an operation started with gdm_manager_call_register_display(). - + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmManagerProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_manager_call_register_display(). + throws="1" + glib:async-func="call_register_display"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.RegisterDisplay">RegisterDisplay()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_manager_call_register_display() for the asynchronous version of this method. - + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmManagerProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. + c:identifier="gdm_manager_call_register_session" + glib:finish-func="call_register_session_finish" + glib:sync-func="call_register_session_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.RegisterSession">RegisterSession()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_manager_call_register_session_finish() to get the result of the operation. + +See gdm_manager_call_register_session_sync() for the synchronous, blocking version of this method. + A #GdmManagerProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="3"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -3459,90 +5241,159 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Finishes an operation started with gdm_manager_call_register_session(). - + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmManagerProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_manager_call_register_session(). + throws="1" + glib:async-func="call_register_session"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.RegisterSession">RegisterSession()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_manager_call_register_session() for the asynchronous version of this method. - + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmManagerProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.OpenReauthenticationChannel">OpenReauthenticationChannel()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + A #GdmManager. - + + A #GDBusMethodInvocation. + Parameter to return. + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.OpenSession">OpenSession()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + A #GdmManager. - + + A #GDBusMethodInvocation. + Parameter to return. + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.RegisterDisplay">RegisterDisplay()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + A #GdmManager. - + + A #GDBusMethodInvocation. @@ -3550,56 +5401,106 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.RegisterSession">RegisterSession()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + A #GdmManager. - + + A #GDBusMethodInvocation. - + + Gets a copy of the <link linkend="gdbus-property-org-gnome-DisplayManager-Manager.Version">"Version"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - + + The property value or %NULL if the property is not set. The returned value should be freed with g_free(). + A #GdmManager. + glib:get-property="version" + introspectable="0"> + Gets the value of the <link linkend="gdbus-property-org-gnome-DisplayManager-Manager.Version">"Version"</link> D-Bus property. + +Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + +The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use gdm_manager_dup_version() if on another thread. - + + The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. + A #GdmManager. + glib:set-property="version" + introspectable="0"> + Sets the <link linkend="gdbus-property-org-gnome-DisplayManager-Manager.Version">"Version"</link> D-Bus property to @value. + +Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. + A #GdmManager. + The value to set. @@ -3610,53 +5511,111 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. setter="set_version" getter="get_version" default-value="NULL"> + Represents the D-Bus property <link linkend="gdbus-property-org-gnome-DisplayManager-Manager.Version">"Version"</link>. + +Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.OpenReauthenticationChannel">OpenReauthenticationChannel()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_manager_complete_open_reauthentication_channel() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.OpenSession">OpenSession()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_manager_complete_open_session() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.RegisterDisplay">RegisterDisplay()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_manager_complete_register_display() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-Manager.RegisterSession">RegisterSession()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_manager_complete_register_session() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. @@ -3665,11 +5624,20 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Virtual table for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Manager.top_of_page">org.gnome.DisplayManager.Manager</link>. + The parent interface. + Handler for the #GdmManager::handle-open-reauthentication-channel signal. @@ -3690,6 +5658,9 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmManager::handle-open-session signal. @@ -3707,6 +5678,9 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmManager::handle-register-display signal. @@ -3727,6 +5701,9 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmManager::handle-register-session signal. @@ -3747,13 +5724,22 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Getter for the #GdmManager:version property. - + + The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. + A #GdmManager. @@ -3767,88 +5753,217 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmManagerProxy" glib:get-type="gdm_manager_proxy_get_type" glib:type-struct="ManagerProxyClass"> + The #GdmManagerProxy structure contains only private data and should only be accessed using the provided API. - - - - + + Finishes an operation started with gdm_manager_proxy_new(). + + + The constructed proxy object or %NULL if @error is set. + - - - + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_manager_proxy_new(). + + + + + + Finishes an operation started with gdm_manager_proxy_new_for_bus(). + + + The constructed proxy object or %NULL if @error is set. + + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_manager_proxy_new_for_bus(). + + + + + + Like gdm_manager_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See gdm_manager_proxy_new_for_bus() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GBusType. + + + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - + + + Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Manager.top_of_page">org.gnome.DisplayManager.Manager</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See gdm_manager_proxy_new() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GDBusConnection. + + + + Flags from the #GDBusProxyFlags enumeration. + + + - + allow-none="1"> + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + - + An object path. + + + - - - - - - - - - - - - + A #GCancellable or %NULL. + - - - + + + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Manager.top_of_page">org.gnome.DisplayManager.Manager</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_manager_proxy_new_finish() to get the result of the operation. + +See gdm_manager_proxy_new_sync() for the synchronous, blocking version of this constructor. + - - + + A #GDBusConnection. + + Flags from the #GDBusProxyFlags enumeration. - + + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + An object path. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="6"> + A #GAsyncReadyCallback to call when the request is satisfied. + User data to pass to @callback. - - - - - - - - - - - - - - - + + Like gdm_manager_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_manager_proxy_new_for_bus_finish() to get the result of the operation. + +See gdm_manager_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + + + + A #GBusType. + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - - - - - - - - - - - - - - - - - - - + + A #GAsyncReadyCallback to call when the request is satisfied. + - - + User data to pass to @callback. + @@ -3949,8 +6069,14 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Class structure for #GdmManagerProxy. + The parent class. @@ -3967,17 +6093,24 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmManagerSkeleton" glib:get-type="gdm_manager_skeleton_get_type" glib:type-struct="ManagerSkeletonClass"> + The #GdmManagerSkeleton structure contains only private data and should only be accessed using the provided API. - + + Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-Manager.top_of_page">org.gnome.DisplayManager.Manager</link>. - - + + The skeleton object. + - + @@ -3990,8 +6123,14 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Class structure for #GdmManagerSkeleton. + The parent class. @@ -4005,7 +6144,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4014,7 +6153,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4023,7 +6162,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4032,7 +6171,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4041,7 +6180,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4050,7 +6189,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4059,7 +6198,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4068,7 +6207,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4080,31 +6219,56 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmRemoteGreeter" glib:get-type="gdm_remote_greeter_get_type" glib:type-struct="RemoteGreeterIface"> - + Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-RemoteGreeter.top_of_page">org.gnome.DisplayManager.RemoteGreeter</link>. + - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-RemoteGreeter.top_of_page">org.gnome.DisplayManager.RemoteGreeter</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmRemoteGreeter interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. - + Handler for the #GdmRemoteGreeter::handle-disconnect signal. + @@ -4119,19 +6283,34 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + c:identifier="gdm_remote_greeter_call_disconnect" + glib:finish-func="call_disconnect_finish" + glib:sync-func="call_disconnect_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-RemoteGreeter.Disconnect">Disconnect()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_remote_greeter_call_disconnect_finish() to get the result of the operation. + +See gdm_remote_greeter_call_disconnect_sync() for the synchronous, blocking version of this method. + + A #GdmRemoteGreeterProxy. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="2"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -4153,60 +6338,109 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_remote_greeter_call_disconnect(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmRemoteGreeterProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_remote_greeter_call_disconnect(). - - + throws="1" + glib:async-func="call_disconnect"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-RemoteGreeter.Disconnect">Disconnect()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_remote_greeter_call_disconnect() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmRemoteGreeterProxy. + A #GCancellable or %NULL. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-RemoteGreeter.Disconnect">Disconnect()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmRemoteGreeter. - + + A #GDBusMethodInvocation. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-RemoteGreeter.Disconnect">Disconnect()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_remote_greeter_complete_disconnect() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. @@ -4215,13 +6449,22 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Virtual table for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-RemoteGreeter.top_of_page">org.gnome.DisplayManager.RemoteGreeter</link>. + + The parent interface. + Handler for the #GdmRemoteGreeter::handle-disconnect signal. - + @@ -4244,176 +6487,310 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmRemoteGreeterProxy" glib:get-type="gdm_remote_greeter_proxy_get_type" glib:type-struct="RemoteGreeterProxyClass"> - + The #GdmRemoteGreeterProxy structure contains only private data and should only be accessed using the provided API. + - - - - + + Finishes an operation started with gdm_remote_greeter_proxy_new(). + + + The constructed proxy object or %NULL if @error is set. + - - - - - - - - - - - - - - - - - - - - + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_remote_greeter_proxy_new(). + - - - - - + + + Finishes an operation started with gdm_remote_greeter_proxy_new_for_bus(). + + + The constructed proxy object or %NULL if @error is set. + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_remote_greeter_proxy_new_for_bus(). - - - - - + + + Like gdm_remote_greeter_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See gdm_remote_greeter_proxy_new_for_bus() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + A #GBusType. + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - + + + Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-RemoteGreeter.top_of_page">org.gnome.DisplayManager.RemoteGreeter</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See gdm_remote_greeter_proxy_new() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GDBusConnection. + + + + Flags from the #GDBusProxyFlags enumeration. + + + - + allow-none="1"> + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + - + An object path. + + + - - - - - - - - - - - - + A #GCancellable or %NULL. + - - - - - + + + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-RemoteGreeter.top_of_page">org.gnome.DisplayManager.RemoteGreeter</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_remote_greeter_proxy_new_finish() to get the result of the operation. + +See gdm_remote_greeter_proxy_new_sync() for the synchronous, blocking version of this constructor. + + + - - + + A #GDBusConnection. + + Flags from the #GDBusProxyFlags enumeration. - + + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + An object path. + A #GCancellable or %NULL. + + A #GAsyncReadyCallback to call when the request is satisfied. + + + + User data to pass to @callback. + + - - - - + + Like gdm_remote_greeter_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_remote_greeter_proxy_new_for_bus_finish() to get the result of the operation. + +See gdm_remote_greeter_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + + + - - + + A #GBusType. + + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. + + A #GAsyncReadyCallback to call when the request is satisfied. + + + + User data to pass to @callback. + + @@ -4427,8 +6804,14 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Class structure for #GdmRemoteGreeterProxy. + + The parent class. @@ -4436,7 +6819,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. c:type="GdmRemoteGreeterProxyPrivate" disguised="1" opaque="1"> - + glib:type-name="GdmRemoteGreeterSkeleton" glib:get-type="gdm_remote_greeter_skeleton_get_type" glib:type-struct="RemoteGreeterSkeletonClass"> - + The #GdmRemoteGreeterSkeleton structure contains only private data and should only be accessed using the provided API. + - - - - + + Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-RemoteGreeter.top_of_page">org.gnome.DisplayManager.RemoteGreeter</link>. + + + The skeleton object. + - + @@ -4468,8 +6858,14 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Class structure for #GdmRemoteGreeterSkeleton. + + The parent class. @@ -4478,12 +6874,12 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. c:type="GdmRemoteGreeterSkeletonPrivate" disguised="1" opaque="1"> - + - + @@ -4492,7 +6888,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4501,7 +6897,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4510,7 +6906,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4519,7 +6915,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4528,7 +6924,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4537,7 +6933,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4546,7 +6942,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4555,7 +6951,79 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -4564,7 +7032,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4573,7 +7041,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4582,7 +7050,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4591,7 +7059,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4600,7 +7068,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4609,7 +7077,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4618,7 +7086,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -4630,31 +7098,56 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmUserVerifier" glib:get-type="gdm_user_verifier_get_type" glib:type-struct="UserVerifierIface"> - + Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier.top_of_page">org.gnome.DisplayManager.UserVerifier</link>. + - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier.top_of_page">org.gnome.DisplayManager.UserVerifier</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmUserVerifier interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. - + Handler for the #GdmUserVerifier::conversation-started signal. + @@ -4668,7 +7161,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::conversation-stopped signal. + @@ -4682,7 +7178,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::handle-answer-query signal. + @@ -4703,7 +7202,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::handle-begin-verification signal. + @@ -4721,7 +7223,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::handle-begin-verification-for-user signal. + @@ -4742,7 +7247,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::handle-cancel signal. + @@ -4757,7 +7265,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::handle-enable-extensions signal. + @@ -4775,7 +7286,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::info signal. + @@ -4792,7 +7306,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::info-query signal. + @@ -4809,7 +7326,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::problem signal. + @@ -4826,7 +7346,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::reauthentication-started signal. + @@ -4840,7 +7363,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::reset signal. + @@ -4851,7 +7377,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::secret-info-query signal. + @@ -4868,7 +7397,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::service-unavailable signal. + @@ -4885,7 +7417,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::verification-complete signal. + @@ -4899,7 +7434,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifier::verification-failed signal. + @@ -4913,25 +7451,46 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + c:identifier="gdm_user_verifier_call_answer_query" + glib:finish-func="call_answer_query_finish" + glib:sync-func="call_answer_query_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.AnswerQuery">AnswerQuery()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_call_answer_query_finish() to get the result of the operation. + +See gdm_user_verifier_call_answer_query_sync() for the synchronous, blocking version of this method. + + A #GdmUserVerifierProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="4"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -4953,61 +7518,112 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_user_verifier_call_answer_query(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmUserVerifierProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_call_answer_query(). - - + throws="1" + glib:async-func="call_answer_query"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.AnswerQuery">AnswerQuery()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_user_verifier_call_answer_query() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmUserVerifierProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. - + c:identifier="gdm_user_verifier_call_begin_verification" + glib:finish-func="call_begin_verification_finish" + glib:sync-func="call_begin_verification_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.BeginVerification">BeginVerification()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_call_begin_verification_finish() to get the result of the operation. + +See gdm_user_verifier_call_begin_verification_sync() for the synchronous, blocking version of this method. + + A #GdmUserVerifierProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="3"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -5029,39 +7651,72 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_user_verifier_call_begin_verification(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmUserVerifierProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_call_begin_verification(). - + c:identifier="gdm_user_verifier_call_begin_verification_for_user" + glib:finish-func="call_begin_verification_for_user_finish" + glib:sync-func="call_begin_verification_for_user_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.BeginVerificationForUser">BeginVerificationForUser()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_call_begin_verification_for_user_finish() to get the result of the operation. + +See gdm_user_verifier_call_begin_verification_for_user_sync() for the synchronous, blocking version of this method. + + A #GdmUserVerifierProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="4"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -5083,79 +7744,146 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_user_verifier_call_begin_verification_for_user(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmUserVerifierProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_call_begin_verification_for_user(). - - + throws="1" + glib:async-func="call_begin_verification_for_user"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.BeginVerificationForUser">BeginVerificationForUser()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_user_verifier_call_begin_verification_for_user() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmUserVerifierProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. - - - + throws="1" + glib:async-func="call_begin_verification"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.BeginVerification">BeginVerification()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_user_verifier_call_begin_verification() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + + A #GdmUserVerifierProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. - - + + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.Cancel">Cancel()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_call_cancel_finish() to get the result of the operation. + +See gdm_user_verifier_call_cancel_sync() for the synchronous, blocking version of this method. + + A #GdmUserVerifierProxy. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="2"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -5177,55 +7911,100 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_user_verifier_call_cancel(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmUserVerifierProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_call_cancel(). - - + throws="1" + glib:async-func="call_cancel"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.Cancel">Cancel()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_user_verifier_call_cancel() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmUserVerifierProxy. + A #GCancellable or %NULL. - + c:identifier="gdm_user_verifier_call_enable_extensions" + glib:finish-func="call_enable_extensions_finish" + glib:sync-func="call_enable_extensions_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.EnableExtensions">EnableExtensions()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_call_enable_extensions_finish() to get the result of the operation. + +See gdm_user_verifier_call_enable_extensions_sync() for the synchronous, blocking version of this method. + + A #GdmUserVerifierProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="3"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -5247,52 +8032,93 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_user_verifier_call_enable_extensions(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmUserVerifierProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_call_enable_extensions(). - - + throws="1" + glib:async-func="call_enable_extensions"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.EnableExtensions">EnableExtensions()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_user_verifier_call_enable_extensions() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmUserVerifierProxy. + Argument to pass with the method invocation. + A #GCancellable or %NULL. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.AnswerQuery">AnswerQuery()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmUserVerifier. - + + A #GDBusMethodInvocation. @@ -5300,15 +8126,26 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.BeginVerification">BeginVerification()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmUserVerifier. - + + A #GDBusMethodInvocation. @@ -5316,15 +8153,26 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.BeginVerificationForUser">BeginVerificationForUser()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmUserVerifier. - + + A #GDBusMethodInvocation. @@ -5332,15 +8180,26 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.Cancel">Cancel()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmUserVerifier. - + + A #GDBusMethodInvocation. @@ -5348,15 +8207,26 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.EnableExtensions">EnableExtensions()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmUserVerifier. - + + A #GDBusMethodInvocation. @@ -5364,263 +8234,463 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.ConversationStarted">"ConversationStarted"</link> D-Bus signal. + + A #GdmUserVerifier. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.ConversationStopped">"ConversationStopped"</link> D-Bus signal. + + A #GdmUserVerifier. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.Info">"Info"</link> D-Bus signal. + + A #GdmUserVerifier. + Argument to pass with the signal. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.InfoQuery">"InfoQuery"</link> D-Bus signal. + + A #GdmUserVerifier. + Argument to pass with the signal. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.Problem">"Problem"</link> D-Bus signal. + + A #GdmUserVerifier. + Argument to pass with the signal. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.ReauthenticationStarted">"ReauthenticationStarted"</link> D-Bus signal. + + A #GdmUserVerifier. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.Reset">"Reset"</link> D-Bus signal. + + A #GdmUserVerifier. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.SecretInfoQuery">"SecretInfoQuery"</link> D-Bus signal. + + A #GdmUserVerifier. + Argument to pass with the signal. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.ServiceUnavailable">"ServiceUnavailable"</link> D-Bus signal. + + A #GdmUserVerifier. + Argument to pass with the signal. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.VerificationComplete">"VerificationComplete"</link> D-Bus signal. + + A #GdmUserVerifier. + Argument to pass with the signal. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.VerificationFailed">"VerificationFailed"</link> D-Bus signal. + + A #GdmUserVerifier. + Argument to pass with the signal. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.ConversationStarted">"ConversationStarted"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.ConversationStopped">"ConversationStopped"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.AnswerQuery">AnswerQuery()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_user_verifier_complete_answer_query() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. - + + Argument passed by remote caller. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.BeginVerification">BeginVerification()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_user_verifier_complete_begin_verification() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.BeginVerificationForUser">BeginVerificationForUser()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_user_verifier_complete_begin_verification_for_user() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. - + + Argument passed by remote caller. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.Cancel">Cancel()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_user_verifier_complete_cancel() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier.EnableExtensions">EnableExtensions()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_user_verifier_complete_enable_extensions() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. @@ -5628,101 +8698,185 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.Info">"Info"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. - + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.InfoQuery">"InfoQuery"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. - + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.Problem">"Problem"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. - + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.ReauthenticationStarted">"ReauthenticationStarted"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.Reset">"Reset"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.SecretInfoQuery">"SecretInfoQuery"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. - + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.ServiceUnavailable">"ServiceUnavailable"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. - + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.VerificationComplete">"VerificationComplete"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier.VerificationFailed">"VerificationFailed"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. @@ -5734,31 +8888,56 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmUserVerifierChoiceList" glib:get-type="gdm_user_verifier_choice_list_get_type" glib:type-struct="UserVerifierChoiceListIface"> - + Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-ChoiceList.top_of_page">org.gnome.DisplayManager.UserVerifier.ChoiceList</link>. + - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-ChoiceList.top_of_page">org.gnome.DisplayManager.UserVerifier.ChoiceList</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmUserVerifierChoiceList interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. - + Handler for the #GdmUserVerifierChoiceList::choice-query signal. + @@ -5779,7 +8958,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmUserVerifierChoiceList::handle-select-choice signal. + @@ -5801,26 +8983,47 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + c:identifier="gdm_user_verifier_choice_list_call_select_choice" + glib:finish-func="call_select_choice_finish" + glib:sync-func="call_select_choice_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-ChoiceList.SelectChoice">SelectChoice()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_choice_list_call_select_choice_finish() to get the result of the operation. + +See gdm_user_verifier_choice_list_call_select_choice_sync() for the synchronous, blocking version of this method. + + A #GdmUserVerifierChoiceListProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="4"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -5842,58 +9051,102 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_user_verifier_choice_list_call_select_choice(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmUserVerifierChoiceListProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_choice_list_call_select_choice(). - - + throws="1" + glib:async-func="call_select_choice"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-ChoiceList.SelectChoice">SelectChoice()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_user_verifier_choice_list_call_select_choice() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmUserVerifierChoiceListProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-ChoiceList.SelectChoice">SelectChoice()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmUserVerifierChoiceList. - + + A #GDBusMethodInvocation. @@ -5901,54 +9154,100 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier-ChoiceList.ChoiceQuery">"ChoiceQuery"</link> D-Bus signal. + + A #GdmUserVerifierChoiceList. + Argument to pass with the signal. + Argument to pass with the signal. + Argument to pass with the signal. + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier-ChoiceList.ChoiceQuery">"ChoiceQuery"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - + + Argument. - + + Argument. - + + Argument. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-ChoiceList.SelectChoice">SelectChoice()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_user_verifier_choice_list_complete_select_choice() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. - + + Argument passed by remote caller. @@ -5957,13 +9256,22 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Virtual table for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-ChoiceList.top_of_page">org.gnome.DisplayManager.UserVerifier.ChoiceList</link>. + + The parent interface. + Handler for the #GdmUserVerifierChoiceList::handle-select-choice signal. - + @@ -5986,8 +9294,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifierChoiceList::choice-query signal. - + @@ -6016,90 +9327,1334 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmUserVerifierChoiceListProxy" glib:get-type="gdm_user_verifier_choice_list_proxy_get_type" glib:type-struct="UserVerifierChoiceListProxyClass"> - + The #GdmUserVerifierChoiceListProxy structure contains only private data and should only be accessed using the provided API. + - - - - + + Finishes an operation started with gdm_user_verifier_choice_list_proxy_new(). + + + The constructed proxy object or %NULL if @error is set. + + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_choice_list_proxy_new(). + + + + + + Finishes an operation started with gdm_user_verifier_choice_list_proxy_new_for_bus(). + + + The constructed proxy object or %NULL if @error is set. + + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_choice_list_proxy_new_for_bus(). + + + + + + Like gdm_user_verifier_choice_list_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See gdm_user_verifier_choice_list_proxy_new_for_bus() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GBusType. + + + + Flags from the #GDBusProxyFlags enumeration. + + + + A bus name (well-known or unique). + + + + An object path. + + + + A #GCancellable or %NULL. + + + + + + Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-ChoiceList.top_of_page">org.gnome.DisplayManager.UserVerifier.ChoiceList</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See gdm_user_verifier_choice_list_proxy_new() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GDBusConnection. + + + + Flags from the #GDBusProxyFlags enumeration. + + + + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + + + + An object path. + + + + A #GCancellable or %NULL. + + + + + + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-ChoiceList.top_of_page">org.gnome.DisplayManager.UserVerifier.ChoiceList</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_choice_list_proxy_new_finish() to get the result of the operation. + +See gdm_user_verifier_choice_list_proxy_new_sync() for the synchronous, blocking version of this constructor. + + + + + + + A #GDBusConnection. + + + + Flags from the #GDBusProxyFlags enumeration. + + + + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + + + + An object path. + + + + A #GCancellable or %NULL. + + + + A #GAsyncReadyCallback to call when the request is satisfied. + + + + User data to pass to @callback. + + + + + + Like gdm_user_verifier_choice_list_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_choice_list_proxy_new_for_bus_finish() to get the result of the operation. + +See gdm_user_verifier_choice_list_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + + + + + + + A #GBusType. + + + + Flags from the #GDBusProxyFlags enumeration. + + + + A bus name (well-known or unique). + + + + An object path. + + + + A #GCancellable or %NULL. + + + + A #GAsyncReadyCallback to call when the request is satisfied. + + + + User data to pass to @callback. + + + + + + + + + + + + + Class structure for #GdmUserVerifierChoiceListProxy. + + + The parent class. + + + + + + + + The #GdmUserVerifierChoiceListSkeleton structure contains only private data and should only be accessed using the provided API. + + + + + Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-ChoiceList.top_of_page">org.gnome.DisplayManager.UserVerifier.ChoiceList</link>. + + + The skeleton object. + + + + + + + + + + + + Class structure for #GdmUserVerifierChoiceListSkeleton. + + + The parent class. + + + + + + + + Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-CustomJSON.top_of_page">org.gnome.DisplayManager.UserVerifier.CustomJSON</link>. + + + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-CustomJSON.top_of_page">org.gnome.DisplayManager.UserVerifier.CustomJSON</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. + + + + + Overrides all #GObject properties in the #GdmUserVerifierCustomJSON interface for a concrete class. +The properties are overridden in the order they are defined. + + + The last property id. + + + + + The class structure for a #GObject derived class. + + + + The property id to assign to the first overridden property. + + + + + + Handler for the #GdmUserVerifierCustomJSON::handle-reply signal. + + + + + + + + + + + + + + + + + + + + + Handler for the #GdmUserVerifierCustomJSON::handle-report-error signal. + + + + + + + + + + + + + + + + + + + + + Handler for the #GdmUserVerifierCustomJSON::request signal. + + + + + + + + + + + + + + + + + + + + + + + + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-CustomJSON.Reply">Reply()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_custom_json_call_reply_finish() to get the result of the operation. + +See gdm_user_verifier_custom_json_call_reply_sync() for the synchronous, blocking version of this method. + + + + + + + A #GdmUserVerifierCustomJSONProxy. + + + + Argument to pass with the method invocation. + + + + Argument to pass with the method invocation. + + + + A #GCancellable or %NULL. + + + + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + + + + User data to pass to @callback. + + + + + + Finishes an operation started with gdm_user_verifier_custom_json_call_reply(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + + + + + A #GdmUserVerifierCustomJSONProxy. + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_custom_json_call_reply(). + + + + + + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-CustomJSON.Reply">Reply()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_user_verifier_custom_json_call_reply() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + + + + + A #GdmUserVerifierCustomJSONProxy. + + + + Argument to pass with the method invocation. + + + + Argument to pass with the method invocation. + + + + A #GCancellable or %NULL. + + + + + + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-CustomJSON.ReportError">ReportError()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_custom_json_call_report_error_finish() to get the result of the operation. + +See gdm_user_verifier_custom_json_call_report_error_sync() for the synchronous, blocking version of this method. + + + + + + + A #GdmUserVerifierCustomJSONProxy. + + + + Argument to pass with the method invocation. + + + + Argument to pass with the method invocation. + + + + A #GCancellable or %NULL. + + + + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + + + + User data to pass to @callback. + + + + + + Finishes an operation started with gdm_user_verifier_custom_json_call_report_error(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + + + + + A #GdmUserVerifierCustomJSONProxy. + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_custom_json_call_report_error(). + + + + + + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-CustomJSON.ReportError">ReportError()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_user_verifier_custom_json_call_report_error() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + + + + + A #GdmUserVerifierCustomJSONProxy. + + + + Argument to pass with the method invocation. + + + + Argument to pass with the method invocation. + + + + A #GCancellable or %NULL. + + + + + + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-CustomJSON.Reply">Reply()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + + + + + + A #GdmUserVerifierCustomJSON. + + + + A #GDBusMethodInvocation. + + + + + + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-CustomJSON.ReportError">ReportError()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + + + + + + A #GdmUserVerifierCustomJSON. + + + + A #GDBusMethodInvocation. + + + + + + Emits the <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier-CustomJSON.Request">"Request"</link> D-Bus signal. + + + + + + + A #GdmUserVerifierCustomJSON. + + + + Argument to pass with the signal. + + + + Argument to pass with the signal. + + + + Argument to pass with the signal. + + + + Argument to pass with the signal. + + + + + + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-CustomJSON.Reply">Reply()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_user_verifier_custom_json_complete_reply() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. + + + + + A #GDBusMethodInvocation. + + + + Argument passed by remote caller. + + + + Argument passed by remote caller. + + + + + + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-UserVerifier-CustomJSON.ReportError">ReportError()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_user_verifier_custom_json_complete_report_error() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. + + + + + A #GDBusMethodInvocation. + + + + Argument passed by remote caller. + + + + Argument passed by remote caller. + + + + + + On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-gnome-DisplayManager-UserVerifier-CustomJSON.Request">"Request"</link> is received. + +On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + + + + + + Argument. + + + + Argument. + + + + Argument. + + + + Argument. + + + + + + + Virtual table for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-CustomJSON.top_of_page">org.gnome.DisplayManager.UserVerifier.CustomJSON</link>. + + + The parent interface. + + + + Handler for the #GdmUserVerifierCustomJSON::handle-reply signal. + + + + + + + + + + + + + + + + + + + + + + + Handler for the #GdmUserVerifierCustomJSON::handle-report-error signal. + + + + + + + + + + + + + + + + + + + + + + + Handler for the #GdmUserVerifierCustomJSON::request signal. + + + + + + + + + + + + + + + + + + + + + + + + + + + The #GdmUserVerifierCustomJSONProxy structure contains only private data and should only be accessed using the provided API. + + + + + + + Finishes an operation started with gdm_user_verifier_custom_json_proxy_new(). + + + The constructed proxy object or %NULL if @error is set. + + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_custom_json_proxy_new(). + + + + + + Finishes an operation started with gdm_user_verifier_custom_json_proxy_new_for_bus(). + + + The constructed proxy object or %NULL if @error is set. + - - + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_custom_json_proxy_new_for_bus(). + + + + + + Like gdm_user_verifier_custom_json_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See gdm_user_verifier_custom_json_proxy_new_for_bus() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GBusType. + + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - + + + Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-CustomJSON.top_of_page">org.gnome.DisplayManager.UserVerifier.CustomJSON</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See gdm_user_verifier_custom_json_proxy_new() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GDBusConnection. + + + + Flags from the #GDBusProxyFlags enumeration. + + + - + allow-none="1"> + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + - + An object path. + + + - - - - - - - - - - - - + A #GCancellable or %NULL. + - - - + + + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-CustomJSON.top_of_page">org.gnome.DisplayManager.UserVerifier.CustomJSON</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_custom_json_proxy_new_finish() to get the result of the operation. + +See gdm_user_verifier_custom_json_proxy_new_sync() for the synchronous, blocking version of this constructor. + - - + + A #GDBusConnection. + + Flags from the #GDBusProxyFlags enumeration. - + + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + An object path. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="6"> + A #GAsyncReadyCallback to call when the request is satisfied. + User data to pass to @callback. - - - - - - - - - - - - - - - + + Like gdm_user_verifier_custom_json_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_custom_json_proxy_new_for_bus_finish() to get the result of the operation. + +See gdm_user_verifier_custom_json_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + + + + A #GBusType. + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - - - - - - - - - - - - - - - - - - - + + A #GAsyncReadyCallback to call when the request is satisfied. + - - + User data to pass to @callback. + @@ -6197,77 +10754,106 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + - - + + Class structure for #GdmUserVerifierCustomJSONProxy. + + The parent class. - - + - - - + glib:type-name="GdmUserVerifierCustomJSONSkeleton" + glib:get-type="gdm_user_verifier_custom_json_skeleton_get_type" + glib:type-struct="UserVerifierCustomJSONSkeletonClass"> + The #GdmUserVerifierCustomJSONSkeleton structure contains only private data and should only be accessed using the provided API. + + - - - - + + Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-CustomJSON.top_of_page">org.gnome.DisplayManager.UserVerifier.CustomJSON</link>. + + + The skeleton object. + - + - + - - + + Class structure for #GdmUserVerifierCustomJSONSkeleton. + + The parent class. - - + - + Virtual table for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier.top_of_page">org.gnome.DisplayManager.UserVerifier</link>. + + The parent interface. + Handler for the #GdmUserVerifier::handle-answer-query signal. - + @@ -6289,8 +10875,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::handle-begin-verification signal. - + @@ -6309,8 +10898,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::handle-begin-verification-for-user signal. - + @@ -6332,8 +10924,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::handle-cancel signal. - + @@ -6349,8 +10944,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::handle-enable-extensions signal. - + @@ -6369,8 +10967,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::conversation-started signal. - + @@ -6385,8 +10986,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::conversation-stopped signal. - + @@ -6401,8 +11005,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::info signal. - + @@ -6420,8 +11027,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::info-query signal. - + @@ -6439,8 +11049,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::problem signal. - + @@ -6458,8 +11071,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::reauthentication-started signal. - + @@ -6474,8 +11090,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::reset signal. - + @@ -6487,8 +11106,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::secret-info-query signal. - + @@ -6506,8 +11128,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::service-unavailable signal. - + @@ -6525,8 +11150,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::verification-complete signal. - + @@ -6541,8 +11169,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmUserVerifier::verification-failed signal. - + @@ -6564,88 +11195,217 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmUserVerifierProxy" glib:get-type="gdm_user_verifier_proxy_get_type" glib:type-struct="UserVerifierProxyClass"> - + The #GdmUserVerifierProxy structure contains only private data and should only be accessed using the provided API. + - - - - + + Finishes an operation started with gdm_user_verifier_proxy_new(). + + + The constructed proxy object or %NULL if @error is set. + - - + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_proxy_new(). + + + + + + Finishes an operation started with gdm_user_verifier_proxy_new_for_bus(). + + + The constructed proxy object or %NULL if @error is set. + + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_user_verifier_proxy_new_for_bus(). + + + + + + Like gdm_user_verifier_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See gdm_user_verifier_proxy_new_for_bus() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GBusType. + + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - + + + Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier.top_of_page">org.gnome.DisplayManager.UserVerifier</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See gdm_user_verifier_proxy_new() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GDBusConnection. + + + + Flags from the #GDBusProxyFlags enumeration. + + + - + allow-none="1"> + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + - + An object path. + + + - - - - - - - - - - - - + A #GCancellable or %NULL. + - - - + + + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier.top_of_page">org.gnome.DisplayManager.UserVerifier</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_proxy_new_finish() to get the result of the operation. + +See gdm_user_verifier_proxy_new_sync() for the synchronous, blocking version of this constructor. + - - + + A #GDBusConnection. + + Flags from the #GDBusProxyFlags enumeration. - + + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + An object path. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="6"> + A #GAsyncReadyCallback to call when the request is satisfied. + User data to pass to @callback. - - - - - - - - - - - - - - - + + Like gdm_user_verifier_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_user_verifier_proxy_new_for_bus_finish() to get the result of the operation. + +See gdm_user_verifier_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + + + + A #GBusType. + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - - - - - - - - - - - - - - - - - - - + + A #GAsyncReadyCallback to call when the request is satisfied. + - - + User data to pass to @callback. + @@ -6747,8 +11512,14 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Class structure for #GdmUserVerifierProxy. + + The parent class. @@ -6756,7 +11527,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. c:type="GdmUserVerifierProxyPrivate" disguised="1" opaque="1"> - + glib:type-name="GdmUserVerifierSkeleton" glib:get-type="gdm_user_verifier_skeleton_get_type" glib:type-struct="UserVerifierSkeletonClass"> - + The #GdmUserVerifierSkeleton structure contains only private data and should only be accessed using the provided API. + - - - - + + Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier.top_of_page">org.gnome.DisplayManager.UserVerifier</link>. + + + The skeleton object. + - + @@ -6788,8 +11566,14 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Class structure for #GdmUserVerifierSkeleton. + + The parent class. @@ -6798,7 +11582,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. c:type="GdmUserVerifierSkeletonPrivate" disguised="1" opaque="1"> - + - + @@ -6830,7 +11614,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -6839,7 +11623,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -6848,7 +11632,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -6857,7 +11641,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -6866,7 +11650,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + @@ -6878,30 +11662,55 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmWorkerManager" glib:get-type="gdm_worker_manager_get_type" glib:type-struct="WorkerManagerIface"> - + Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-WorkerManager.top_of_page">org.gnome.DisplayManager.WorkerManager</link>. + - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-WorkerManager.top_of_page">org.gnome.DisplayManager.WorkerManager</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmWorkerManager interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. + Handler for the #GdmWorkerManager::handle-choice-list-query signal. @@ -6925,11 +11734,44 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + + Handler for the #GdmWorkerManager::handle-custom-json-request signal. + + + + + + + + + + + + + + + + + + + + + + + Handler for the #GdmWorkerManager::handle-hello signal. + + + + @@ -6941,7 +11783,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmWorkerManager::handle-info signal. + @@ -6962,7 +11807,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmWorkerManager::handle-info-query signal. + @@ -6983,7 +11831,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmWorkerManager::handle-problem signal. + @@ -7004,7 +11855,10 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Handler for the #GdmWorkerManager::handle-secret-info-query signal. + @@ -7025,28 +11879,52 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + c:identifier="gdm_worker_manager_call_choice_list_query" + glib:finish-func="call_choice_list_query_finish" + glib:sync-func="call_choice_list_query_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.ChoiceListQuery">ChoiceListQuery()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_worker_manager_call_choice_list_query_finish() to get the result of the operation. + +See gdm_worker_manager_call_choice_list_query_sync() for the synchronous, blocking version of this method. + + A #GdmWorkerManagerProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="5"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -7068,66 +11952,319 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_worker_manager_call_choice_list_query(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. - + + Return location for return parameter or %NULL to ignore. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_worker_manager_call_choice_list_query(). - - + throws="1" + glib:async-func="call_choice_list_query"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.ChoiceListQuery">ChoiceListQuery()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_worker_manager_call_choice_list_query() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + Argument to pass with the method invocation. - + + Return location for return parameter or %NULL to ignore. + + + + A #GCancellable or %NULL. + + + + + + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.CustomJSONRequest">CustomJSONRequest()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_worker_manager_call_custom_json_request_finish() to get the result of the operation. + +See gdm_worker_manager_call_custom_json_request_sync() for the synchronous, blocking version of this method. + + + + + + + A #GdmWorkerManagerProxy. + + + + Argument to pass with the method invocation. + + + + Argument to pass with the method invocation. + + + + Argument to pass with the method invocation. + + + + Argument to pass with the method invocation. + + + + A #GCancellable or %NULL. + + + + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + + + + User data to pass to @callback. + + + + + + Finishes an operation started with gdm_worker_manager_call_custom_json_request(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + + + + + A #GdmWorkerManagerProxy. + + + + Return location for return parameter or %NULL to ignore. + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_worker_manager_call_custom_json_request(). + + + + + + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.CustomJSONRequest">CustomJSONRequest()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_worker_manager_call_custom_json_request() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + + + + + A #GdmWorkerManagerProxy. + + + + Argument to pass with the method invocation. + + + + Argument to pass with the method invocation. + + + + Argument to pass with the method invocation. + + + + Argument to pass with the method invocation. + + + + Return location for return parameter or %NULL to ignore. + A #GCancellable or %NULL. - - + + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Hello">Hello()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_worker_manager_call_hello_finish() to get the result of the operation. + +See gdm_worker_manager_call_hello_sync() for the synchronous, blocking version of this method. + + A #GdmWorkerManagerProxy. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="2"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -7149,57 +12292,106 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_worker_manager_call_hello(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_worker_manager_call_hello(). - - + throws="1" + glib:async-func="call_hello"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Hello">Hello()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_worker_manager_call_hello() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. + A #GCancellable or %NULL. - - + + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Info">Info()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_worker_manager_call_info_finish() to get the result of the operation. + +See gdm_worker_manager_call_info_sync() for the synchronous, blocking version of this method. + + A #GdmWorkerManagerProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="4"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -7221,39 +12419,72 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_worker_manager_call_info(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_worker_manager_call_info(). - + c:identifier="gdm_worker_manager_call_info_query" + glib:finish-func="call_info_query_finish" + glib:sync-func="call_info_query_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.InfoQuery">InfoQuery()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_worker_manager_call_info_query_finish() to get the result of the operation. + +See gdm_worker_manager_call_info_query_sync() for the synchronous, blocking version of this method. + + A #GdmWorkerManagerProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="4"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -7275,95 +12512,186 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_worker_manager_call_info_query(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. - + + Return location for return parameter or %NULL to ignore. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_worker_manager_call_info_query(). - - + throws="1" + glib:async-func="call_info_query"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.InfoQuery">InfoQuery()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_worker_manager_call_info_query() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. - + + Return location for return parameter or %NULL to ignore. + A #GCancellable or %NULL. - - + throws="1" + glib:async-func="call_info"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Info">Info()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_worker_manager_call_info() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. - + c:identifier="gdm_worker_manager_call_problem" + glib:finish-func="call_problem_finish" + glib:sync-func="call_problem_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Problem">Problem()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_worker_manager_call_problem_finish() to get the result of the operation. + +See gdm_worker_manager_call_problem_sync() for the synchronous, blocking version of this method. + + A #GdmWorkerManagerProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="4"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -7385,64 +12719,118 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_worker_manager_call_problem(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_worker_manager_call_problem(). - - + throws="1" + glib:async-func="call_problem"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Problem">Problem()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_worker_manager_call_problem() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. - + c:identifier="gdm_worker_manager_call_secret_info_query" + glib:finish-func="call_secret_info_query_finish" + glib:sync-func="call_secret_info_query_sync"> + Asynchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.SecretInfoQuery">SecretInfoQuery()</link> D-Bus method on @proxy. +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_worker_manager_call_secret_info_query_finish() to get the result of the operation. + +See gdm_worker_manager_call_secret_info_query_sync() for the synchronous, blocking version of this method. + + A #GdmWorkerManagerProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="4"> + A #GAsyncReadyCallback to call when the request is satisfied or %NULL. + User data to pass to @callback. @@ -7464,80 +12858,187 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - - + Finishes an operation started with gdm_worker_manager_call_secret_info_query(). + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. - + + Return location for return parameter or %NULL to ignore. + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_worker_manager_call_secret_info_query(). - - + throws="1" + glib:async-func="call_secret_info_query"> + Synchronously invokes the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.SecretInfoQuery">SecretInfoQuery()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. + +See gdm_worker_manager_call_secret_info_query() for the asynchronous version of this method. + + + %TRUE if the call succeeded, %FALSE if @error is set. + A #GdmWorkerManagerProxy. + Argument to pass with the method invocation. + Argument to pass with the method invocation. - + + Return location for return parameter or %NULL to ignore. + A #GCancellable or %NULL. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.ChoiceListQuery">ChoiceListQuery()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmWorkerManager. - + + A #GDBusMethodInvocation. + Parameter to return. + + + + + + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.CustomJSONRequest">CustomJSONRequest()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + + + + + + A #GdmWorkerManager. + + + + A #GDBusMethodInvocation. + + + + Parameter to return. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Hello">Hello()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmWorkerManager. - + + A #GDBusMethodInvocation. @@ -7545,15 +13046,26 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Info">Info()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmWorkerManager. - + + A #GDBusMethodInvocation. @@ -7561,34 +13073,59 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.InfoQuery">InfoQuery()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmWorkerManager. - + + A #GDBusMethodInvocation. + Parameter to return. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Problem">Problem()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmWorkerManager. - + + A #GDBusMethodInvocation. @@ -7596,112 +13133,270 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.SecretInfoQuery">SecretInfoQuery()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. + +This method will free @invocation, you cannot use it afterwards. + + A #GdmWorkerManager. - + + A #GDBusMethodInvocation. + Parameter to return. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.ChoiceListQuery">ChoiceListQuery()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_worker_manager_complete_choice_list_query() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. - + + Argument passed by remote caller. - + + Argument passed by remote caller. + + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.CustomJSONRequest">CustomJSONRequest()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_worker_manager_complete_custom_json_request() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. + + + + + A #GDBusMethodInvocation. + + + + Argument passed by remote caller. + + + + Argument passed by remote caller. + + + + Argument passed by remote caller. + + + + Argument passed by remote caller. + + + + + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Hello">Hello()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_worker_manager_complete_hello() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Info">Info()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_worker_manager_complete_info() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. - + + Argument passed by remote caller. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.InfoQuery">InfoQuery()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_worker_manager_complete_info_query() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. - + + Argument passed by remote caller. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.Problem">Problem()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_worker_manager_complete_problem() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. - + + Argument passed by remote caller. + Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-gnome-DisplayManager-WorkerManager.SecretInfoQuery">SecretInfoQuery()</link> D-Bus method. + +If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call gdm_worker_manager_complete_secret_info_query() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. + %G_DBUS_METHOD_INVOCATION_HANDLED or %TRUE if the invocation was handled, %G_DBUS_METHOD_INVOCATION_UNHANDLED or %FALSE to let other signal handlers run. - + + A #GDBusMethodInvocation. - + + Argument passed by remote caller. - + + Argument passed by remote caller. @@ -7710,13 +13405,51 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Virtual table for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-WorkerManager.top_of_page">org.gnome.DisplayManager.WorkerManager</link>. + + The parent interface. - - - + + Handler for the #GdmWorkerManager::handle-choice-list-query signal. + + + + + + + + + + + + + + + + + + + + + + + + + + Handler for the #GdmWorkerManager::handle-custom-json-request signal. + + @@ -7731,18 +13464,24 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + - - + + + + + + Handler for the #GdmWorkerManager::handle-hello signal. - + @@ -7758,8 +13497,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmWorkerManager::handle-info signal. - + @@ -7781,8 +13523,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmWorkerManager::handle-info-query signal. - + @@ -7804,8 +13549,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmWorkerManager::handle-problem signal. - + @@ -7827,8 +13575,11 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. + Handler for the #GdmWorkerManager::handle-secret-info-query signal. - + @@ -7857,88 +13608,217 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. glib:type-name="GdmWorkerManagerProxy" glib:get-type="gdm_worker_manager_proxy_get_type" glib:type-struct="WorkerManagerProxyClass"> - + The #GdmWorkerManagerProxy structure contains only private data and should only be accessed using the provided API. + - - - - + + Finishes an operation started with gdm_worker_manager_proxy_new(). + + + The constructed proxy object or %NULL if @error is set. + - - + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_worker_manager_proxy_new(). + + + + + + Finishes an operation started with gdm_worker_manager_proxy_new_for_bus(). + + + The constructed proxy object or %NULL if @error is set. + + + + + The #GAsyncResult obtained from the #GAsyncReadyCallback passed to gdm_worker_manager_proxy_new_for_bus(). + + + + + + Like gdm_worker_manager_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + +The calling thread is blocked until a reply is received. + +See gdm_worker_manager_proxy_new_for_bus() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GBusType. + + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - + + + Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-WorkerManager.top_of_page">org.gnome.DisplayManager.WorkerManager</link>. See g_dbus_proxy_new_sync() for more details. + +The calling thread is blocked until a reply is received. + +See gdm_worker_manager_proxy_new() for the asynchronous version of this constructor. + + + The constructed proxy object or %NULL if @error is set. + + + + + A #GDBusConnection. + + + + Flags from the #GDBusProxyFlags enumeration. + + + - + allow-none="1"> + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + - + An object path. + + + - - - - - - - - - - - - + A #GCancellable or %NULL. + - - - + + + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-WorkerManager.top_of_page">org.gnome.DisplayManager.WorkerManager</link>. See g_dbus_proxy_new() for more details. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_worker_manager_proxy_new_finish() to get the result of the operation. + +See gdm_worker_manager_proxy_new_sync() for the synchronous, blocking version of this constructor. + - - + + A #GDBusConnection. + + Flags from the #GDBusProxyFlags enumeration. - + + A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + An object path. + A #GCancellable or %NULL. allow-none="1" scope="async" closure="6"> + A #GAsyncReadyCallback to call when the request is satisfied. + User data to pass to @callback. - - - - - - - - - - - - - - - + + Like gdm_worker_manager_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from (see g_main_context_push_thread_default()). +You can then call gdm_worker_manager_proxy_new_for_bus_finish() to get the result of the operation. + +See gdm_worker_manager_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + + + + A #GBusType. + Flags from the #GDBusProxyFlags enumeration. + A bus name (well-known or unique). + An object path. + A #GCancellable or %NULL. - - - - - - - - - - - - - - - - - - - + + A #GAsyncReadyCallback to call when the request is satisfied. + - - + User data to pass to @callback. + @@ -8040,8 +13925,14 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Class structure for #GdmWorkerManagerProxy. + + The parent class. @@ -8049,7 +13940,7 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. c:type="GdmWorkerManagerProxyPrivate" disguised="1" opaque="1"> - + glib:type-name="GdmWorkerManagerSkeleton" glib:get-type="gdm_worker_manager_skeleton_get_type" glib:type-struct="WorkerManagerSkeletonClass"> - + The #GdmWorkerManagerSkeleton structure contains only private data and should only be accessed using the provided API. + - - - - + + Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-gnome-DisplayManager-WorkerManager.top_of_page">org.gnome.DisplayManager.WorkerManager</link>. + + + The skeleton object. + - + @@ -8081,8 +13979,14 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. - + Class structure for #GdmWorkerManagerSkeleton. + + The parent class. @@ -8091,28 +13995,47 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. c:type="GdmWorkerManagerSkeletonPrivate" disguised="1" opaque="1"> - + - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-Chooser.top_of_page">org.gnome.DisplayManager.Chooser</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmChooser interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. @@ -8120,13 +14043,13 @@ org.gnome.DisplayManager.UserVerifier.ChoiceList is supported. Reads /usr/share/xsessions and other relevant places for possible sessions + line="422">Reads /usr/share/xsessions and other relevant places for possible sessions to log into and returns the complete list. a %NULL terminated list of session ids + line="428">a %NULL terminated list of session ids @@ -8136,19 +14059,19 @@ to log into and returns the complete list. c:identifier="gdm_get_session_name_and_description"> Takes an xsession id and returns the name and comment about it. + line="459">Takes an xsession id and returns the name and comment about it. The session name if found, or %NULL otherwise + line="466">The session name if found, or %NULL otherwise an id from gdm_get_session_ids() + line="461">an id from gdm_get_session_ids() transfer-ownership="full"> optional returned session description + line="462">optional returned session description @@ -8181,23 +14104,42 @@ to log into and returns the complete list. - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-Greeter.top_of_page">org.gnome.DisplayManager.Greeter</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmGreeter interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. @@ -8205,23 +14147,42 @@ to log into and returns the complete list. + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-Manager.top_of_page">org.gnome.DisplayManager.Manager</link> D-Bus interface. - + + A #GDBusInterfaceInfo. Do not free. + Overrides all #GObject properties in the #GdmManager interface for a concrete class. +The properties are overridden in the order they are defined. + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. @@ -8229,23 +14190,42 @@ to log into and returns the complete list. - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-RemoteGreeter.top_of_page">org.gnome.DisplayManager.RemoteGreeter</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmRemoteGreeter interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. @@ -8253,23 +14233,85 @@ to log into and returns the complete list. - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-ChoiceList.top_of_page">org.gnome.DisplayManager.UserVerifier.ChoiceList</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmUserVerifierChoiceList interface for a concrete class. +The properties are overridden in the order they are defined. + + + The last property id. + + + + + The class structure for a #GObject derived class. + + + + The property id to assign to the first overridden property. + + + + + + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier-CustomJSON.top_of_page">org.gnome.DisplayManager.UserVerifier.CustomJSON</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. + + + + + Overrides all #GObject properties in the #GdmUserVerifierCustomJSON interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. @@ -8277,23 +14319,42 @@ to log into and returns the complete list. - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-UserVerifier.top_of_page">org.gnome.DisplayManager.UserVerifier</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmUserVerifier interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. @@ -8301,23 +14362,42 @@ to log into and returns the complete list. - - + Gets a machine-readable description of the <link linkend="gdbus-interface-org-gnome-DisplayManager-WorkerManager.top_of_page">org.gnome.DisplayManager.WorkerManager</link> D-Bus interface. + + + A #GDBusInterfaceInfo. Do not free. - + Overrides all #GObject properties in the #GdmWorkerManager interface for a concrete class. +The properties are overridden in the order they are defined. + + The last property id. + The class structure for a #GObject derived class. + The property id to assign to the first overridden property. diff --git a/girs/Gee-0.8.gir b/girs/Gee-0.8.gir index 381f930ad..b7c9b4799 100644 --- a/girs/Gee-0.8.gir +++ b/girs/Gee-0.8.gir @@ -1,5 +1,5 @@ - + @@ -1581,7 +1581,7 @@ - + @@ -1596,7 +1596,7 @@ - + @@ -1611,7 +1611,7 @@ - + @@ -1626,7 +1626,7 @@ - + @@ -1641,7 +1641,7 @@ - + @@ -1656,7 +1656,7 @@ - + @@ -2092,7 +2092,7 @@ - + @@ -2109,7 +2109,7 @@ - + @@ -2126,7 +2126,7 @@ - + @@ -2370,7 +2370,7 @@ - + @@ -2385,7 +2385,7 @@ - + @@ -2412,7 +2412,7 @@ - + @@ -2430,7 +2430,7 @@ - + @@ -2445,7 +2445,7 @@ - + @@ -2460,7 +2460,7 @@ - + @@ -2478,7 +2478,7 @@ - + @@ -2496,13 +2496,13 @@ - + - + @@ -2517,7 +2517,7 @@ - + @@ -2867,7 +2867,7 @@ - + @@ -2896,7 +2896,7 @@ - + @@ -2913,7 +2913,7 @@ - + @@ -2933,7 +2933,7 @@ - + @@ -2941,7 +2941,7 @@ - + @@ -3159,7 +3159,7 @@ - + @@ -3175,7 +3175,7 @@ - + @@ -3191,10 +3191,10 @@ - + - + @@ -3210,10 +3210,10 @@ - + - + @@ -3229,7 +3229,7 @@ - + @@ -3245,7 +3245,7 @@ - + @@ -3261,10 +3261,10 @@ - + - + @@ -3280,10 +3280,10 @@ - + - + @@ -3299,7 +3299,7 @@ - + @@ -3318,7 +3318,7 @@ - + @@ -3975,7 +3975,7 @@ - + @@ -3993,10 +3993,10 @@ - + - + @@ -4014,7 +4014,7 @@ - + @@ -4032,10 +4032,10 @@ - + - + @@ -4053,7 +4053,7 @@ - + @@ -6336,7 +6336,7 @@ - + @@ -6355,7 +6355,7 @@ - + @@ -6374,7 +6374,7 @@ - + @@ -6393,7 +6393,7 @@ - + @@ -6412,10 +6412,10 @@ - + - + @@ -6434,10 +6434,10 @@ - + - + @@ -6801,7 +6801,7 @@ - + @@ -6822,7 +6822,7 @@ - + @@ -6843,10 +6843,10 @@ - + - + @@ -7022,7 +7022,7 @@ - + @@ -7034,7 +7034,7 @@ - + @@ -7046,7 +7046,7 @@ - + @@ -7058,7 +7058,7 @@ - + @@ -7081,7 +7081,7 @@ - + @@ -7098,7 +7098,7 @@ - + @@ -7113,7 +7113,7 @@ - + @@ -7128,7 +7128,7 @@ - + @@ -7143,7 +7143,7 @@ - + @@ -7158,7 +7158,7 @@ - + @@ -7173,7 +7173,7 @@ - + @@ -7188,7 +7188,7 @@ - + @@ -7203,7 +7203,7 @@ - + @@ -7218,7 +7218,7 @@ - + @@ -7235,7 +7235,7 @@ - + @@ -7252,7 +7252,7 @@ - + @@ -7269,7 +7269,7 @@ - + @@ -7286,7 +7286,7 @@ - + @@ -7303,10 +7303,10 @@ - + - + @@ -7323,10 +7323,10 @@ - + - + @@ -7611,7 +7611,7 @@ - + @@ -7625,7 +7625,7 @@ - + @@ -7650,7 +7650,7 @@ - + @@ -7667,7 +7667,7 @@ - + @@ -7684,7 +7684,7 @@ - + @@ -7701,7 +7701,7 @@ - + @@ -7718,7 +7718,7 @@ - + @@ -7737,7 +7737,7 @@ - + @@ -7756,7 +7756,7 @@ - + @@ -7775,10 +7775,10 @@ - + - + @@ -8978,7 +8978,7 @@ - + @@ -9206,7 +9206,7 @@ - + @@ -9224,7 +9224,7 @@ - + @@ -9236,7 +9236,7 @@ - + @@ -9314,7 +9314,7 @@ - + @@ -9326,7 +9326,7 @@ - + @@ -9412,7 +9412,7 @@ - + @@ -9497,7 +9497,7 @@ - + @@ -10229,7 +10229,7 @@ - + @@ -10244,7 +10244,7 @@ - + @@ -10265,7 +10265,7 @@ - + @@ -10717,7 +10717,7 @@ - + @@ -10732,7 +10732,7 @@ - + @@ -10747,7 +10747,7 @@ - + @@ -10762,7 +10762,7 @@ - + @@ -10777,7 +10777,7 @@ - + @@ -10792,7 +10792,7 @@ - + @@ -11358,7 +11358,7 @@ - + @@ -11375,7 +11375,7 @@ - + @@ -11392,7 +11392,7 @@ - + @@ -11701,7 +11701,7 @@ - + @@ -11716,7 +11716,7 @@ - + @@ -11737,7 +11737,7 @@ - + @@ -11756,7 +11756,7 @@ - + @@ -11771,7 +11771,7 @@ - + @@ -11874,7 +11874,7 @@ - + @@ -11889,7 +11889,7 @@ - + @@ -11998,7 +11998,7 @@ - + @@ -12065,7 +12065,7 @@ - + @@ -12125,7 +12125,7 @@ - + @@ -12137,7 +12137,7 @@ - + @@ -12203,7 +12203,7 @@ - + @@ -12236,7 +12236,7 @@ - + @@ -12665,7 +12665,7 @@ - + @@ -12687,7 +12687,7 @@ - + @@ -12696,7 +12696,7 @@ - + @@ -12718,7 +12718,7 @@ - + @@ -12727,7 +12727,7 @@ - + @@ -12758,10 +12758,10 @@ - + - + @@ -12794,7 +12794,7 @@ - + @@ -12809,7 +12809,7 @@ - + @@ -12863,7 +12863,7 @@ - + @@ -13135,7 +13135,7 @@ - + @@ -13150,7 +13150,7 @@ - + @@ -13185,7 +13185,7 @@ - + @@ -13297,7 +13297,7 @@ - + @@ -13309,7 +13309,7 @@ - + @@ -13490,7 +13490,7 @@ - + @@ -13576,7 +13576,7 @@ - + @@ -13591,7 +13591,7 @@ - + @@ -13618,7 +13618,7 @@ - + @@ -13636,7 +13636,7 @@ - + @@ -13651,7 +13651,7 @@ - + @@ -13666,7 +13666,7 @@ - + @@ -13684,7 +13684,7 @@ - + @@ -13702,13 +13702,13 @@ - + - + @@ -13723,7 +13723,7 @@ - + @@ -13778,7 +13778,7 @@ - + @@ -13790,7 +13790,7 @@ - + @@ -13802,7 +13802,7 @@ - + @@ -13814,7 +13814,7 @@ - + @@ -13981,7 +13981,7 @@ - + @@ -14010,7 +14010,7 @@ - + @@ -14027,7 +14027,7 @@ - + @@ -14047,7 +14047,7 @@ - + @@ -14055,7 +14055,7 @@ - + @@ -14094,7 +14094,7 @@ - + @@ -14108,7 +14108,7 @@ - + @@ -14194,7 +14194,7 @@ - + @@ -14209,7 +14209,7 @@ - + @@ -14224,7 +14224,7 @@ - + @@ -14239,7 +14239,7 @@ - + @@ -14284,7 +14284,7 @@ - + @@ -14301,7 +14301,7 @@ - + @@ -14336,7 +14336,7 @@ - + @@ -14352,7 +14352,7 @@ - + @@ -14368,7 +14368,7 @@ - + @@ -14384,10 +14384,10 @@ - + - + @@ -14403,10 +14403,10 @@ - + - + @@ -14422,7 +14422,7 @@ - + @@ -14438,7 +14438,7 @@ - + @@ -14454,10 +14454,10 @@ - + - + @@ -14473,10 +14473,10 @@ - + - + @@ -14492,7 +14492,7 @@ - + @@ -14511,7 +14511,7 @@ - + @@ -14530,7 +14530,7 @@ - + @@ -15055,7 +15055,7 @@ - + @@ -15073,10 +15073,10 @@ - + - + @@ -15094,7 +15094,7 @@ - + @@ -15112,10 +15112,10 @@ - + - + @@ -15133,7 +15133,7 @@ - + @@ -15385,7 +15385,7 @@ - + @@ -15398,7 +15398,7 @@ - + @@ -15414,7 +15414,7 @@ - + @@ -15427,7 +15427,7 @@ - + @@ -15450,7 +15450,7 @@ - + @@ -15466,7 +15466,7 @@ - + @@ -15562,7 +15562,7 @@ - + @@ -15575,7 +15575,7 @@ - + @@ -15588,7 +15588,7 @@ - + @@ -15601,7 +15601,7 @@ - + @@ -15624,7 +15624,7 @@ - + @@ -15640,7 +15640,7 @@ - + @@ -15672,7 +15672,7 @@ - + @@ -15697,13 +15697,13 @@ - + - + @@ -15728,7 +15728,7 @@ - + @@ -15895,7 +15895,7 @@ - + @@ -15910,7 +15910,7 @@ - + @@ -15935,7 +15935,7 @@ - + @@ -15958,7 +15958,7 @@ - + @@ -15983,7 +15983,7 @@ - + @@ -16159,7 +16159,7 @@ - + @@ -16175,7 +16175,7 @@ - + @@ -16193,7 +16193,7 @@ - + @@ -16211,7 +16211,7 @@ - + @@ -16227,10 +16227,10 @@ - + - + @@ -16246,10 +16246,10 @@ - + - + @@ -16265,10 +16265,10 @@ - + - + @@ -16284,10 +16284,10 @@ - + - + @@ -16303,7 +16303,7 @@ - + @@ -16319,7 +16319,7 @@ - + @@ -16566,7 +16566,7 @@ - + @@ -16586,7 +16586,7 @@ - + @@ -16604,10 +16604,10 @@ - + - + @@ -16625,10 +16625,10 @@ - + - + @@ -16646,7 +16646,7 @@ - + @@ -16746,7 +16746,7 @@ - + @@ -16761,7 +16761,7 @@ - + @@ -16828,7 +16828,7 @@ - + @@ -16866,7 +16866,7 @@ - + @@ -16881,7 +16881,7 @@ - + @@ -17071,7 +17071,7 @@ - + @@ -17261,7 +17261,7 @@ - + @@ -17280,7 +17280,7 @@ - + @@ -17299,7 +17299,7 @@ - + @@ -17318,7 +17318,7 @@ - + @@ -17337,10 +17337,10 @@ - + - + @@ -17359,10 +17359,10 @@ - + - + @@ -17532,7 +17532,7 @@ - + @@ -17553,7 +17553,7 @@ - + @@ -17574,10 +17574,10 @@ - + - + @@ -17642,7 +17642,7 @@ - + @@ -17654,7 +17654,7 @@ - + @@ -17666,7 +17666,7 @@ - + @@ -17678,7 +17678,7 @@ - + @@ -17701,7 +17701,7 @@ - + @@ -17718,7 +17718,7 @@ - + @@ -17733,7 +17733,7 @@ - + @@ -17748,7 +17748,7 @@ - + @@ -17763,7 +17763,7 @@ - + @@ -17778,7 +17778,7 @@ - + @@ -17793,7 +17793,7 @@ - + @@ -17808,7 +17808,7 @@ - + @@ -17823,7 +17823,7 @@ - + @@ -17838,7 +17838,7 @@ - + @@ -17855,7 +17855,7 @@ - + @@ -17872,7 +17872,7 @@ - + @@ -17889,7 +17889,7 @@ - + @@ -17906,7 +17906,7 @@ - + @@ -17923,10 +17923,10 @@ - + - + @@ -17943,10 +17943,10 @@ - + - + @@ -18009,7 +18009,7 @@ - + @@ -18023,7 +18023,7 @@ - + @@ -18048,7 +18048,7 @@ - + @@ -18065,7 +18065,7 @@ - + @@ -18082,7 +18082,7 @@ - + @@ -18099,7 +18099,7 @@ - + @@ -18116,7 +18116,7 @@ - + @@ -18135,7 +18135,7 @@ - + @@ -18154,7 +18154,7 @@ - + @@ -18173,10 +18173,10 @@ - + - + @@ -18302,7 +18302,7 @@ - + @@ -18326,13 +18326,13 @@ - + - + @@ -18356,7 +18356,7 @@ - + @@ -18446,7 +18446,7 @@ - + @@ -18478,7 +18478,7 @@ - + @@ -18804,7 +18804,7 @@ - + @@ -18825,7 +18825,7 @@ - + @@ -18846,7 +18846,7 @@ - + @@ -18867,7 +18867,7 @@ - + @@ -19018,7 +19018,7 @@ - + @@ -19042,7 +19042,7 @@ - + @@ -19107,7 +19107,7 @@ - + @@ -19289,7 +19289,7 @@ - + @@ -19312,7 +19312,7 @@ - + @@ -19393,7 +19393,7 @@ - + @@ -19415,10 +19415,10 @@ - + - + @@ -19427,7 +19427,7 @@ - + @@ -19446,7 +19446,7 @@ - + @@ -19477,13 +19477,13 @@ - + - + - + @@ -19514,10 +19514,10 @@ - + - + @@ -19526,7 +19526,7 @@ - + @@ -19545,7 +19545,7 @@ - + @@ -19567,10 +19567,10 @@ - + - + @@ -19592,7 +19592,7 @@ - + @@ -19663,7 +19663,7 @@ - + @@ -19685,7 +19685,7 @@ - + @@ -19707,7 +19707,7 @@ - + @@ -19740,7 +19740,7 @@ - + diff --git a/girs/Gee-1.0.gir b/girs/Gee-1.0.gir index bb7aafa9f..e45373813 100644 --- a/girs/Gee-1.0.gir +++ b/girs/Gee-1.0.gir @@ -8,33 +8,51 @@ - + + + + + + + - + + + + + + + - + + + + + + + @@ -1287,17 +1305,29 @@ - + + + + + + + - + + + + + + + @@ -1335,13 +1365,19 @@ - + + + + + + + @@ -1553,9 +1589,12 @@ - + + + + @@ -1563,7 +1602,7 @@ - + @@ -1593,15 +1632,24 @@ - + - + + + + - + + + + + + + @@ -1632,18 +1680,30 @@ - + - + + + + - + + + + - + + + + + + + @@ -1677,12 +1737,18 @@ - + - + + + + + + + @@ -1710,12 +1776,18 @@ - + - + + + + + + + @@ -1745,9 +1817,12 @@ - + + + + @@ -1772,9 +1847,12 @@ - + + + + @@ -1799,12 +1877,18 @@ - + - + + + + + + + @@ -1832,12 +1916,18 @@ - + - + + + + + + + @@ -1865,9 +1955,12 @@ - + + + + @@ -1893,9 +1986,12 @@ - + + + + @@ -3019,9 +3115,12 @@ - + + + + @@ -3029,9 +3128,12 @@ - + + + + @@ -3219,9 +3321,12 @@ - + + + + diff --git a/girs/Gegl-0.4.gir b/girs/Gegl-0.4.gir index ae73087af..5595a434e 100644 --- a/girs/Gegl-0.4.gir +++ b/girs/Gegl-0.4.gir @@ -3478,7 +3478,7 @@ equivalent to storing as sRGB. + default-value="3903913984"> xmlns="http://www.gtk.org/introspection/core/1.0" xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> + + @@ -20,10 +22,9 @@ and/or use gtk-doc annotations. --> version="2.0" shared-library="libgio-2.0.so.0" c:identifier-prefixes="G" - c:symbol-prefixes="g"> + c:symbol-prefixes="gio,g"> - + @@ -32,8 +33,7 @@ and/or use gtk-doc annotations. --> - + @@ -42,8 +42,7 @@ and/or use gtk-doc annotations. --> - + @@ -52,8 +51,7 @@ and/or use gtk-doc annotations. --> - + @@ -62,8 +60,7 @@ and/or use gtk-doc annotations. --> - + @@ -72,8 +69,7 @@ and/or use gtk-doc annotations. --> - + @@ -82,8 +78,7 @@ and/or use gtk-doc annotations. --> - + @@ -92,8 +87,7 @@ and/or use gtk-doc annotations. --> - + @@ -102,8 +96,7 @@ and/or use gtk-doc annotations. --> - + @@ -112,8 +105,7 @@ and/or use gtk-doc annotations. --> - + @@ -122,8 +114,7 @@ and/or use gtk-doc annotations. --> - + @@ -132,8 +123,7 @@ and/or use gtk-doc annotations. --> - + @@ -142,8 +132,7 @@ and/or use gtk-doc annotations. --> - + @@ -152,8 +141,7 @@ and/or use gtk-doc annotations. --> - + @@ -162,8 +150,7 @@ and/or use gtk-doc annotations. --> - + @@ -172,8 +159,7 @@ and/or use gtk-doc annotations. --> - + @@ -182,8 +168,7 @@ and/or use gtk-doc annotations. --> - + @@ -192,8 +177,7 @@ and/or use gtk-doc annotations. --> - + @@ -202,8 +186,7 @@ and/or use gtk-doc annotations. --> - + @@ -212,8 +195,7 @@ and/or use gtk-doc annotations. --> - + @@ -222,8 +204,7 @@ and/or use gtk-doc annotations. --> - + @@ -232,8 +213,7 @@ and/or use gtk-doc annotations. --> - + @@ -246,63 +226,61 @@ and/or use gtk-doc annotations. --> glib:get-type="g_action_get_type" glib:type-struct="ActionInterface"> #GAction represents a single named action. + filename="gio/gaction.c" + line="30">`GAction` represents a single named action. The main interface to an action is that it can be activated with -g_action_activate(). This results in the 'activate' signal being -emitted. An activation has a #GVariant parameter (which may be -%NULL). The correct type for the parameter is determined by a static +[method@Gio.Action.activate]. This results in the 'activate' signal being +emitted. An activation has a `GVariant` parameter (which may be +`NULL`). The correct type for the parameter is determined by a static parameter type (which is given at construction time). An action may optionally have a state, in which case the state may be -set with g_action_change_state(). This call takes a #GVariant. The +set with [method@Gio.Action.change_state]. This call takes a #GVariant. The correct type for the state is determined by a static state type (which is given at construction time). The state may have a hint associated with it, specifying its valid range. -#GAction is merely the interface to the concept of an action, as +`GAction` is merely the interface to the concept of an action, as described above. Various implementations of actions exist, including -#GSimpleAction. +[class@Gio.SimpleAction]. In all cases, the implementing class is responsible for storing the -name of the action, the parameter type, the enabled state, the -optional state type and the state and emitting the appropriate -signals when these change. The implementor is responsible for filtering -calls to g_action_activate() and g_action_change_state() for type -safety and for the state being enabled. - -Probably the only useful thing to do with a #GAction is to put it -inside of a #GSimpleActionGroup. - +name of the action, the parameter type, the enabled state, the optional +state type and the state and emitting the appropriate signals when these +change. The implementor is responsible for filtering calls to +[method@Gio.Action.activate] and [method@Gio.Action.change_state] +for type safety and for the state being enabled. + +Probably the only useful thing to do with a `GAction` is to put it +inside of a [class@Gio.SimpleActionGroup]. + Checks if @action_name is valid. + filename="gio/gaction.c" + line="386">Checks if @action_name is valid. @action_name is valid if it consists only of alphanumeric characters, plus '-' and '.'. The empty string is not a valid action name. It is an error to call this function with a non-utf8 @action_name. @action_name must not be %NULL. - + %TRUE if @action_name is valid + filename="gio/gaction.c" + line="398">%TRUE if @action_name is valid a potential action name + filename="gio/gaction.c" + line="388">a potential action name @@ -312,8 +290,8 @@ It is an error to call this function with a non-utf8 @action_name. version="2.38" throws="1"> Parses a detailed action name into its separate name and target + filename="gio/gaction.c" + line="417">Parses a detailed action name into its separate name and target components. Detailed action names can have three formats. @@ -343,19 +321,18 @@ in @action_name (if a pointer is passed in). A %NULL value may still be returned in @target_value, as the @detailed_name may not contain a target. If returned, the #GVariant in @target_value is guaranteed to not be floating. - + %TRUE if successful, else %FALSE with @error set + filename="gio/gaction.c" + line="456">%TRUE if successful, else %FALSE with @error set a detailed action name + filename="gio/gaction.c" + line="419">a detailed action name the action name + filename="gio/gaction.c" + line="420">the action name the target value, + filename="gio/gaction.c" + line="421">the target value, or %NULL for no target @@ -388,8 +365,8 @@ If returned, the #GVariant in @target_value is guaranteed to not be floating. Formats a detailed action name from @action_name and @target_value. + filename="gio/gaction.c" + line="531">Formats a detailed action name from @action_name and @target_value. It is an error to call this function with an invalid action name. @@ -399,19 +376,18 @@ and @target_value by that function. See that function for the types of strings that will be printed by this function. - + a detailed format string + filename="gio/gaction.c" + line="547">a detailed format string a valid action name + filename="gio/gaction.c" + line="533">a valid action name nullable="1" allow-none="1"> a #GVariant target value, or %NULL + filename="gio/gaction.c" + line="534">a #GVariant target value, or %NULL Activates the action. + filename="gio/gaction.c" + line="355">Activates the action. @parameter must be the correct type of parameter for the action (ie: the parameter type given at construction time). If the parameter type was %NULL then @parameter must also be %NULL. If the @parameter GVariant is floating, it is consumed. - + a #GAction + filename="gio/gaction.c" + line="357">a #GAction nullable="1" allow-none="1"> the parameter to the activation + filename="gio/gaction.c" + line="358">the parameter to the activation @@ -462,8 +437,8 @@ If the @parameter GVariant is floating, it is consumed. invoker="change_state" version="2.30"> Request for the state of @action to be changed to @value. + filename="gio/gaction.c" + line="158">Request for the state of @action to be changed to @value. The action must be stateful and @value must be of the correct type. See g_action_get_state_type(). @@ -473,67 +448,64 @@ its state or may change its state to something other than @value. See g_action_get_state_hint(). If the @value GVariant is floating, it is consumed. - + a #GAction + filename="gio/gaction.c" + line="160">a #GAction the new state + filename="gio/gaction.c" + line="161">the new state Checks if @action is currently enabled. + filename="gio/gaction.c" + line="333">Checks if @action is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. - + whether the action is enabled + filename="gio/gaction.c" + line="342">whether the action is enabled a #GAction + filename="gio/gaction.c" + line="335">a #GAction Queries the name of @action. - + filename="gio/gaction.c" + line="222">Queries the name of @action. + the name of the action + filename="gio/gaction.c" + line="228">the name of the action a #GAction + filename="gio/gaction.c" + line="224">a #GAction @@ -542,8 +514,8 @@ have its state changed from outside callers. invoker="get_parameter_type" version="2.28"> Queries the type of the parameter that must be given when activating + filename="gio/gaction.c" + line="241">Queries the type of the parameter that must be given when activating @action. When activating the action using g_action_activate(), the #GVariant @@ -551,27 +523,26 @@ given to that function must be of the type returned by this function. In the case that this function returns %NULL, you must not give any #GVariant, but %NULL instead. - + the parameter type + filename="gio/gaction.c" + line="254">the parameter type a #GAction + filename="gio/gaction.c" + line="243">a #GAction Queries the current state of @action. + filename="gio/gaction.c" + line="196">Queries the current state of @action. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -579,19 +550,18 @@ given by g_action_get_state_type(). The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - + the current state of the action + filename="gio/gaction.c" + line="209">the current state of the action a #GAction + filename="gio/gaction.c" + line="198">a #GAction @@ -600,8 +570,8 @@ g_variant_unref() when it is no longer required. invoker="get_state_hint" version="2.28"> Requests a hint about the valid range of values for the state of + filename="gio/gaction.c" + line="297">Requests a hint about the valid range of values for the state of @action. If %NULL is returned it either means that the action is not stateful @@ -619,19 +589,18 @@ within the range may fail. The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - + the state range hint + filename="gio/gaction.c" + line="320">the state range hint a #GAction + filename="gio/gaction.c" + line="299">a #GAction @@ -640,8 +609,8 @@ g_variant_unref() when it is no longer required. invoker="get_state_type" version="2.28"> Queries the type of the state of @action. + filename="gio/gaction.c" + line="267">Queries the type of the state of @action. If the action is stateful (e.g. created with g_simple_action_new_stateful()) then this function returns the @@ -653,43 +622,41 @@ given as the state. All calls to g_action_change_state() must give a If the action is not stateful (e.g. created with g_simple_action_new()) then this function will return %NULL. In that case, g_action_get_state() will return %NULL and you must not call g_action_change_state(). - + the state type, if the action is stateful + filename="gio/gaction.c" + line="284">the state type, if the action is stateful a #GAction + filename="gio/gaction.c" + line="269">a #GAction Activates the action. + filename="gio/gaction.c" + line="355">Activates the action. @parameter must be the correct type of parameter for the action (ie: the parameter type given at construction time). If the parameter type was %NULL then @parameter must also be %NULL. If the @parameter GVariant is floating, it is consumed. - + a #GAction + filename="gio/gaction.c" + line="357">a #GAction nullable="1" allow-none="1"> the parameter to the activation + filename="gio/gaction.c" + line="358">the parameter to the activation @@ -707,8 +674,8 @@ If the @parameter GVariant is floating, it is consumed. c:identifier="g_action_change_state" version="2.30"> Request for the state of @action to be changed to @value. + filename="gio/gaction.c" + line="158">Request for the state of @action to be changed to @value. The action must be stateful and @value must be of the correct type. See g_action_get_state_type(). @@ -718,22 +685,21 @@ its state or may change its state to something other than @value. See g_action_get_state_hint(). If the @value GVariant is floating, it is consumed. - + a #GAction + filename="gio/gaction.c" + line="160">a #GAction the new state + filename="gio/gaction.c" + line="161">the new state @@ -743,24 +709,23 @@ If the @value GVariant is floating, it is consumed. glib:get-property="enabled" version="2.28"> Checks if @action is currently enabled. + filename="gio/gaction.c" + line="333">Checks if @action is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. - + whether the action is enabled + filename="gio/gaction.c" + line="342">whether the action is enabled a #GAction + filename="gio/gaction.c" + line="335">a #GAction @@ -770,21 +735,20 @@ have its state changed from outside callers. glib:get-property="name" version="2.28"> Queries the name of @action. - + filename="gio/gaction.c" + line="222">Queries the name of @action. + the name of the action + filename="gio/gaction.c" + line="228">the name of the action a #GAction + filename="gio/gaction.c" + line="224">a #GAction @@ -794,8 +758,8 @@ have its state changed from outside callers. glib:get-property="parameter-type" version="2.28"> Queries the type of the parameter that must be given when activating + filename="gio/gaction.c" + line="241">Queries the type of the parameter that must be given when activating @action. When activating the action using g_action_activate(), the #GVariant @@ -803,19 +767,18 @@ given to that function must be of the type returned by this function. In the case that this function returns %NULL, you must not give any #GVariant, but %NULL instead. - + the parameter type + filename="gio/gaction.c" + line="254">the parameter type a #GAction + filename="gio/gaction.c" + line="243">a #GAction @@ -825,8 +788,8 @@ In the case that this function returns %NULL, you must not give any glib:get-property="state" version="2.28"> Queries the current state of @action. + filename="gio/gaction.c" + line="196">Queries the current state of @action. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -834,19 +797,18 @@ given by g_action_get_state_type(). The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - + the current state of the action + filename="gio/gaction.c" + line="209">the current state of the action a #GAction + filename="gio/gaction.c" + line="198">a #GAction @@ -855,8 +817,8 @@ g_variant_unref() when it is no longer required. c:identifier="g_action_get_state_hint" version="2.28"> Requests a hint about the valid range of values for the state of + filename="gio/gaction.c" + line="297">Requests a hint about the valid range of values for the state of @action. If %NULL is returned it either means that the action is not stateful @@ -874,19 +836,18 @@ within the range may fail. The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - + the state range hint + filename="gio/gaction.c" + line="320">the state range hint a #GAction + filename="gio/gaction.c" + line="299">a #GAction @@ -896,8 +857,8 @@ g_variant_unref() when it is no longer required. glib:get-property="state-type" version="2.28"> Queries the type of the state of @action. + filename="gio/gaction.c" + line="267">Queries the type of the state of @action. If the action is stateful (e.g. created with g_simple_action_new_stateful()) then this function returns the @@ -909,19 +870,18 @@ given as the state. All calls to g_action_change_state() must give a If the action is not stateful (e.g. created with g_simple_action_new()) then this function will return %NULL. In that case, g_action_get_state() will return %NULL and you must not call g_action_change_state(). - + the state type, if the action is stateful + filename="gio/gaction.c" + line="284">the state type, if the action is stateful a #GAction + filename="gio/gaction.c" + line="269">a #GAction @@ -932,11 +892,11 @@ will return %NULL and you must not call g_action_change_state(). getter="get_enabled" default-value="TRUE"> If @action is currently enabled. + filename="gio/gaction.c" + line="113">If @action is currently enabled. -If the action is disabled then calls to g_action_activate() and -g_action_change_state() have no effect. +If the action is disabled then calls to [method@Gio.Action.activate] and +[method@Gio.Action.change_state] have no effect. getter="get_name" default-value="NULL"> The name of the action. This is mostly meaningful for identifying -the action once it has been added to a #GActionGroup. It is immutable. + filename="gio/gaction.c" + line="84">The name of the action. This is mostly meaningful for identifying +the action once it has been added to a [type@Gio.ActionGroup]. It is immutable. transfer-ownership="none" getter="get_parameter_type"> The type of the parameter that must be given when activating the -action. This is immutable, and may be %NULL if no parameter is needed when + filename="gio/gaction.c" + line="98">The type of the parameter that must be given when activating the +action. This is immutable, and may be `NULL` if no parameter is needed when activating the action. @@ -966,8 +926,8 @@ activating the action. transfer-ownership="none" getter="get_state"> The state of the action, or %NULL if the action is stateless. + filename="gio/gaction.c" + line="143">The state of the action, or %NULL if the action is stateless. transfer-ownership="none" getter="get_state_type"> The #GVariantType of the state that the action has, or %NULL if the + filename="gio/gaction.c" + line="129">The [type@GLib.VariantType] of the state that the action has, or `NULL` if the action is stateless. This is immutable. This struct defines a single action. It is for use with + filename="gio/gactionmap.c" + line="124">This struct defines a single action. It is for use with g_action_map_add_action_entries(). The order of the items in the structure are intended to reflect @@ -994,18 +954,25 @@ after @name are optional. Additional optional fields may be added in the future. See g_action_map_add_action_entries() for an example. - + the name of the action + filename="gio/gactionmap.c" + line="126">the name of the action + the callback to connect to the "activate" signal of the + action. Since GLib 2.40, this can be %NULL for stateful + actions, in which case the default handler is used. For + boolean-stated actions with no parameter, this is a + toggle. For other state types (and parameter type equal + to the state type) this will be a function that + just calls @change_state (which you should provide). - + @@ -1028,16 +995,16 @@ See g_action_map_add_action_entries() for an example. the type of the parameter that must be passed to the + filename="gio/gactionmap.c" + line="134">the type of the parameter that must be passed to the activate function for this action, given as a single GVariant type string (or %NULL for no parameter) the initial state for this action, given in + filename="gio/gactionmap.c" + line="137">the initial state for this action, given in [GVariant text format][gvariant-text]. The state is parsed with no extra type information, so type tags must be added to the string if they are necessary. Stateless actions should @@ -1045,9 +1012,13 @@ See g_action_map_add_action_entries() for an example. + the callback to connect to the "change-state" signal + of the action. All stateful actions should provide a + handler here; stateless actions should not. - + @@ -1081,26 +1052,25 @@ See g_action_map_add_action_entries() for an example. glib:get-type="g_action_group_get_type" glib:type-struct="ActionGroupInterface"> #GActionGroup represents a group of actions. Actions can be used to -expose functionality in a structured way, either from one part of a -program to another, or to the outside world. Action groups are often -used together with a #GMenuModel that provides additional -representation data for displaying the actions to the user, e.g. in -a menu. - -The main way to interact with the actions in a GActionGroup is to -activate them with g_action_group_activate_action(). Activating an -action may require a #GVariant parameter. The required type of the -parameter can be inquired with g_action_group_get_action_parameter_type(). -Actions may be disabled, see g_action_group_get_action_enabled(). + filename="gio/gactiongroup.c" + line="28">`GActionGroup` represents a group of actions. + +Actions can be used to expose functionality in a structured way, either +from one part of a program to another, or to the outside world. Action +groups are often used together with a `GMenuModel` that provides additional +representation data for displaying the actions to the user, e.g. in a menu. + +The main way to interact with the actions in a `GActionGroup` is to +activate them with [method@Gio.ActionGroup.activate_action]. Activating an +action may require a `GVariant` parameter. The required type of the +parameter can be inquired with [method@Gio.ActionGroup.get_action_parameter_type]. +Actions may be disabled, see [method@Gio.ActionGroup.get_action_enabled]. Activating a disabled action has no effect. -Actions may optionally have a state in the form of a #GVariant. The -current state of an action can be inquired with -g_action_group_get_action_state(). Activating a stateful action may -change its state, but it is also possible to set the state by calling -g_action_group_change_action_state(). +Actions may optionally have a state in the form of a #GVariant. The current +state of an action can be inquired with [method@Gio.ActionGroup.get_action_state]. +Activating a stateful action may change its state, but it is also possible to +set the state by calling [method@Gio.ActionGroup.change_action_state]. As typical example, consider a text editing application which has an option to change the current font to 'bold'. A good way to represent @@ -1108,51 +1078,49 @@ this would be a stateful action, with a boolean state. Activating the action would toggle the state. Each action in the group has a unique name (which is a string). All -method calls, except g_action_group_list_actions() take the name of +method calls, except [method@Gio.ActionGroup.list_actions] take the name of an action as an argument. -The #GActionGroup API is meant to be the 'public' API to the action -group. The calls here are exactly the interaction that 'external +The `GActionGroup` API is meant to be the 'public' API to the action +group. The calls here are exactly the interaction that 'external forces' (eg: UI, incoming D-Bus messages, etc.) are supposed to have -with actions. 'Internal' APIs (ie: ones meant only to be accessed by -the action group implementation) are found on subclasses. This is -why you will find - for example - g_action_group_get_action_enabled() +with actions. 'Internal' APIs (ie: ones meant only to be accessed by +the action group implementation) are found on subclasses. This is +why you will find - for example - [method@Gio.ActionGroup.get_action_enabled] but not an equivalent set() call. Signals are emitted on the action group in response to state changes on individual actions. -Implementations of #GActionGroup should provide implementations for -the virtual functions g_action_group_list_actions() and -g_action_group_query_action(). The other virtual functions should +Implementations of `GActionGroup` should provide implementations for +the virtual functions [method@Gio.ActionGroup.list_actions] and +[method@Gio.ActionGroup.query_action]. The other virtual functions should not be implemented - their "wrappers" are actually implemented with -calls to g_action_group_query_action(). - +calls to [method@Gio.ActionGroup.query_action]. + Emits the #GActionGroup::action-added signal on @action_group. + filename="gio/gactiongroup.c" + line="627">Emits the #GActionGroup::action-added signal on @action_group. This function should only be called by #GActionGroup implementations. - + a #GActionGroup + filename="gio/gactiongroup.c" + line="629">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="630">the name of an action in the group @@ -1161,32 +1129,31 @@ This function should only be called by #GActionGroup implementations. invoker="action_enabled_changed" version="2.28"> Emits the #GActionGroup::action-enabled-changed signal on @action_group. + filename="gio/gactiongroup.c" + line="675">Emits the #GActionGroup::action-enabled-changed signal on @action_group. This function should only be called by #GActionGroup implementations. - + a #GActionGroup + filename="gio/gactiongroup.c" + line="677">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="678">the name of an action in the group whether or not the action is now enabled + filename="gio/gactiongroup.c" + line="679">whether or not the action is now enabled @@ -1195,26 +1162,25 @@ This function should only be called by #GActionGroup implementations. invoker="action_removed" version="2.28"> Emits the #GActionGroup::action-removed signal on @action_group. + filename="gio/gactiongroup.c" + line="651">Emits the #GActionGroup::action-removed signal on @action_group. This function should only be called by #GActionGroup implementations. - + a #GActionGroup + filename="gio/gactiongroup.c" + line="653">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="654">the name of an action in the group @@ -1223,32 +1189,31 @@ This function should only be called by #GActionGroup implementations. invoker="action_state_changed" version="2.28"> Emits the #GActionGroup::action-state-changed signal on @action_group. + filename="gio/gactiongroup.c" + line="704">Emits the #GActionGroup::action-state-changed signal on @action_group. This function should only be called by #GActionGroup implementations. - + a #GActionGroup + filename="gio/gactiongroup.c" + line="706">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="707">the name of an action in the group the new state of the named action + filename="gio/gactiongroup.c" + line="708">the new state of the named action @@ -1257,8 +1222,8 @@ This function should only be called by #GActionGroup implementations. invoker="activate_action" version="2.28"> Activate the named action within @action_group. + filename="gio/gactiongroup.c" + line="573">Activate the named action within @action_group. If the action is expecting a parameter, then the correct type of parameter must be given as @parameter. If the action is expecting no @@ -1291,22 +1256,21 @@ g_debug ("application has been terminated. exiting."); exit (0); ]| - + a #GActionGroup + filename="gio/gactiongroup.c" + line="575">a #GActionGroup the name of the action to activate + filename="gio/gactiongroup.c" + line="576">the name of the action to activate parameters to the activation + filename="gio/gactiongroup.c" + line="577">parameters to the activation @@ -1324,8 +1288,8 @@ exit (0); invoker="change_action_state" version="2.28"> Request for the state of the named action within @action_group to be + filename="gio/gactiongroup.c" + line="540">Request for the state of the named action within @action_group to be changed to @value. The action must be stateful and @value must be of the correct type. @@ -1336,28 +1300,27 @@ its state or may change its state to something other than @value. See g_action_group_get_action_state_hint(). If the @value GVariant is floating, it is consumed. - + a #GActionGroup + filename="gio/gactiongroup.c" + line="542">a #GActionGroup the name of the action to request the change on + filename="gio/gactiongroup.c" + line="543">the name of the action to request the change on the new state + filename="gio/gactiongroup.c" + line="544">the new state @@ -1366,30 +1329,29 @@ If the @value GVariant is floating, it is consumed. invoker="get_action_enabled" version="2.28"> Checks if the named action within @action_group is currently enabled. + filename="gio/gactiongroup.c" + line="488">Checks if the named action within @action_group is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. - + whether or not the action is currently enabled + filename="gio/gactiongroup.c" + line="498">whether or not the action is currently enabled a #GActionGroup + filename="gio/gactiongroup.c" + line="490">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="491">the name of the action to query @@ -1398,8 +1360,8 @@ have its state changed from outside callers. invoker="get_action_parameter_type" version="2.28"> Queries the type of the parameter that must be given when activating + filename="gio/gactiongroup.c" + line="381">Queries the type of the parameter that must be given when activating the named action within @action_group. When activating the action using g_action_group_activate_action(), @@ -1412,25 +1374,24 @@ In the case that this function returns %NULL, you must not give any The parameter type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different parameter type. - + the parameter type + filename="gio/gactiongroup.c" + line="400">the parameter type a #GActionGroup + filename="gio/gactiongroup.c" + line="383">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="384">the name of the action to query @@ -1439,8 +1400,8 @@ with the same name but a different parameter type. invoker="get_action_state" version="2.28"> Queries the current state of the named action within @action_group. + filename="gio/gactiongroup.c" + line="512">Queries the current state of the named action within @action_group. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -1448,25 +1409,24 @@ given by g_action_group_get_action_state_type(). The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - + the current state of the action + filename="gio/gactiongroup.c" + line="526">the current state of the action a #GActionGroup + filename="gio/gactiongroup.c" + line="514">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="515">the name of the action to query @@ -1475,8 +1435,8 @@ g_variant_unref() when it is no longer required. invoker="get_action_state_hint" version="2.28"> Requests a hint about the valid range of values for the state of the + filename="gio/gactiongroup.c" + line="450">Requests a hint about the valid range of values for the state of the named action within @action_group. If %NULL is returned it either means that the action is not stateful @@ -1494,25 +1454,24 @@ within the range may fail. The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - + the state range hint + filename="gio/gactiongroup.c" + line="474">the state range hint a #GActionGroup + filename="gio/gactiongroup.c" + line="452">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="453">the name of the action to query @@ -1521,8 +1480,8 @@ g_variant_unref() when it is no longer required. invoker="get_action_state_type" version="2.28"> Queries the type of the state of the named action within + filename="gio/gactiongroup.c" + line="414">Queries the type of the state of the named action within @action_group. If the action is stateful then this function returns the @@ -1538,52 +1497,50 @@ and you must not call g_action_group_change_action_state(). The state type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different state type. - + the state type, if the action is stateful + filename="gio/gactiongroup.c" + line="436">the state type, if the action is stateful a #GActionGroup + filename="gio/gactiongroup.c" + line="416">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="417">the name of the action to query Checks if the named action exists within @action_group. - + filename="gio/gactiongroup.c" + line="360">Checks if the named action exists within @action_group. + whether the named action exists + filename="gio/gactiongroup.c" + line="367">whether the named action exists a #GActionGroup + filename="gio/gactiongroup.c" + line="362">a #GActionGroup the name of the action to check for + filename="gio/gactiongroup.c" + line="363">the name of the action to check for @@ -1592,17 +1549,16 @@ with the same name but a different state type. invoker="list_actions" version="2.28"> Lists the actions contained within @action_group. + filename="gio/gactiongroup.c" + line="337">Lists the actions contained within @action_group. The caller is responsible for freeing the list with g_strfreev() when it is no longer required. - + a %NULL-terminated array of the names of the + filename="gio/gactiongroup.c" + line="346">a %NULL-terminated array of the names of the actions in the group @@ -1611,8 +1567,8 @@ actions in the group a #GActionGroup + filename="gio/gactiongroup.c" + line="339">a #GActionGroup @@ -1621,8 +1577,8 @@ actions in the group invoker="query_action" version="2.32"> Queries all aspects of the named action within an @action_group. + filename="gio/gactiongroup.c" + line="731">Queries all aspects of the named action within an @action_group. This function acquires the information available from g_action_group_has_action(), g_action_group_get_action_enabled(), @@ -1649,25 +1605,24 @@ If the action exists, %TRUE is returned and any of the requested fields (as indicated by having a non-%NULL reference passed in) are filled. If the action doesn't exist, %FALSE is returned and the fields may or may not have been modified. - + %TRUE if the action exists, else %FALSE + filename="gio/gactiongroup.c" + line="769">%TRUE if the action exists, else %FALSE a #GActionGroup + filename="gio/gactiongroup.c" + line="733">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="734">the name of an action in the group caller-allocates="0" transfer-ownership="full"> if the action is presently enabled + filename="gio/gactiongroup.c" + line="735">if the action is presently enabled optional="1" allow-none="1"> the parameter type, or %NULL if none needed + filename="gio/gactiongroup.c" + line="736">the parameter type, or %NULL if none needed optional="1" allow-none="1"> the state type, or %NULL if stateless + filename="gio/gactiongroup.c" + line="737">the state type, or %NULL if stateless optional="1" allow-none="1"> the state hint, or %NULL if none + filename="gio/gactiongroup.c" + line="738">the state hint, or %NULL if none optional="1" allow-none="1"> the current state, or %NULL if stateless + filename="gio/gactiongroup.c" + line="739">the current state, or %NULL if stateless @@ -1729,26 +1684,25 @@ fields may or may not have been modified. c:identifier="g_action_group_action_added" version="2.28"> Emits the #GActionGroup::action-added signal on @action_group. + filename="gio/gactiongroup.c" + line="627">Emits the #GActionGroup::action-added signal on @action_group. This function should only be called by #GActionGroup implementations. - + a #GActionGroup + filename="gio/gactiongroup.c" + line="629">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="630">the name of an action in the group @@ -1757,32 +1711,31 @@ This function should only be called by #GActionGroup implementations. c:identifier="g_action_group_action_enabled_changed" version="2.28"> Emits the #GActionGroup::action-enabled-changed signal on @action_group. + filename="gio/gactiongroup.c" + line="675">Emits the #GActionGroup::action-enabled-changed signal on @action_group. This function should only be called by #GActionGroup implementations. - + a #GActionGroup + filename="gio/gactiongroup.c" + line="677">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="678">the name of an action in the group whether or not the action is now enabled + filename="gio/gactiongroup.c" + line="679">whether or not the action is now enabled @@ -1791,26 +1744,25 @@ This function should only be called by #GActionGroup implementations. c:identifier="g_action_group_action_removed" version="2.28"> Emits the #GActionGroup::action-removed signal on @action_group. + filename="gio/gactiongroup.c" + line="651">Emits the #GActionGroup::action-removed signal on @action_group. This function should only be called by #GActionGroup implementations. - + a #GActionGroup + filename="gio/gactiongroup.c" + line="653">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="654">the name of an action in the group @@ -1819,32 +1771,31 @@ This function should only be called by #GActionGroup implementations. c:identifier="g_action_group_action_state_changed" version="2.28"> Emits the #GActionGroup::action-state-changed signal on @action_group. + filename="gio/gactiongroup.c" + line="704">Emits the #GActionGroup::action-state-changed signal on @action_group. This function should only be called by #GActionGroup implementations. - + a #GActionGroup + filename="gio/gactiongroup.c" + line="706">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="707">the name of an action in the group the new state of the named action + filename="gio/gactiongroup.c" + line="708">the new state of the named action @@ -1853,8 +1804,8 @@ This function should only be called by #GActionGroup implementations. c:identifier="g_action_group_activate_action" version="2.28"> Activate the named action within @action_group. + filename="gio/gactiongroup.c" + line="573">Activate the named action within @action_group. If the action is expecting a parameter, then the correct type of parameter must be given as @parameter. If the action is expecting no @@ -1887,22 +1838,21 @@ g_debug ("application has been terminated. exiting."); exit (0); ]| - + a #GActionGroup + filename="gio/gactiongroup.c" + line="575">a #GActionGroup the name of the action to activate + filename="gio/gactiongroup.c" + line="576">the name of the action to activate parameters to the activation + filename="gio/gactiongroup.c" + line="577">parameters to the activation @@ -1920,8 +1870,8 @@ exit (0); c:identifier="g_action_group_change_action_state" version="2.28"> Request for the state of the named action within @action_group to be + filename="gio/gactiongroup.c" + line="540">Request for the state of the named action within @action_group to be changed to @value. The action must be stateful and @value must be of the correct type. @@ -1932,28 +1882,27 @@ its state or may change its state to something other than @value. See g_action_group_get_action_state_hint(). If the @value GVariant is floating, it is consumed. - + a #GActionGroup + filename="gio/gactiongroup.c" + line="542">a #GActionGroup the name of the action to request the change on + filename="gio/gactiongroup.c" + line="543">the name of the action to request the change on the new state + filename="gio/gactiongroup.c" + line="544">the new state @@ -1962,30 +1911,29 @@ If the @value GVariant is floating, it is consumed. c:identifier="g_action_group_get_action_enabled" version="2.28"> Checks if the named action within @action_group is currently enabled. + filename="gio/gactiongroup.c" + line="488">Checks if the named action within @action_group is currently enabled. An action must be enabled in order to be activated or in order to have its state changed from outside callers. - + whether or not the action is currently enabled + filename="gio/gactiongroup.c" + line="498">whether or not the action is currently enabled a #GActionGroup + filename="gio/gactiongroup.c" + line="490">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="491">the name of the action to query @@ -1994,8 +1942,8 @@ have its state changed from outside callers. c:identifier="g_action_group_get_action_parameter_type" version="2.28"> Queries the type of the parameter that must be given when activating + filename="gio/gactiongroup.c" + line="381">Queries the type of the parameter that must be given when activating the named action within @action_group. When activating the action using g_action_group_activate_action(), @@ -2008,25 +1956,24 @@ In the case that this function returns %NULL, you must not give any The parameter type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different parameter type. - + the parameter type + filename="gio/gactiongroup.c" + line="400">the parameter type a #GActionGroup + filename="gio/gactiongroup.c" + line="383">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="384">the name of the action to query @@ -2035,8 +1982,8 @@ with the same name but a different parameter type. c:identifier="g_action_group_get_action_state" version="2.28"> Queries the current state of the named action within @action_group. + filename="gio/gactiongroup.c" + line="512">Queries the current state of the named action within @action_group. If the action is not stateful then %NULL will be returned. If the action is stateful then the type of the return value is the type @@ -2044,25 +1991,24 @@ given by g_action_group_get_action_state_type(). The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - + the current state of the action + filename="gio/gactiongroup.c" + line="526">the current state of the action a #GActionGroup + filename="gio/gactiongroup.c" + line="514">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="515">the name of the action to query @@ -2071,8 +2017,8 @@ g_variant_unref() when it is no longer required. c:identifier="g_action_group_get_action_state_hint" version="2.28"> Requests a hint about the valid range of values for the state of the + filename="gio/gactiongroup.c" + line="450">Requests a hint about the valid range of values for the state of the named action within @action_group. If %NULL is returned it either means that the action is not stateful @@ -2090,25 +2036,24 @@ within the range may fail. The return value (if non-%NULL) should be freed with g_variant_unref() when it is no longer required. - + the state range hint + filename="gio/gactiongroup.c" + line="474">the state range hint a #GActionGroup + filename="gio/gactiongroup.c" + line="452">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="453">the name of the action to query @@ -2117,8 +2062,8 @@ g_variant_unref() when it is no longer required. c:identifier="g_action_group_get_action_state_type" version="2.28"> Queries the type of the state of the named action within + filename="gio/gactiongroup.c" + line="414">Queries the type of the state of the named action within @action_group. If the action is stateful then this function returns the @@ -2134,25 +2079,24 @@ and you must not call g_action_group_change_action_state(). The state type of a particular action will never change but it is possible for an action to be removed and for a new action to be added with the same name but a different state type. - + the state type, if the action is stateful + filename="gio/gactiongroup.c" + line="436">the state type, if the action is stateful a #GActionGroup + filename="gio/gactiongroup.c" + line="416">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="417">the name of the action to query @@ -2161,27 +2105,26 @@ with the same name but a different state type. c:identifier="g_action_group_has_action" version="2.28"> Checks if the named action exists within @action_group. - + filename="gio/gactiongroup.c" + line="360">Checks if the named action exists within @action_group. + whether the named action exists + filename="gio/gactiongroup.c" + line="367">whether the named action exists a #GActionGroup + filename="gio/gactiongroup.c" + line="362">a #GActionGroup the name of the action to check for + filename="gio/gactiongroup.c" + line="363">the name of the action to check for @@ -2190,17 +2133,16 @@ with the same name but a different state type. c:identifier="g_action_group_list_actions" version="2.28"> Lists the actions contained within @action_group. + filename="gio/gactiongroup.c" + line="337">Lists the actions contained within @action_group. The caller is responsible for freeing the list with g_strfreev() when it is no longer required. - + a %NULL-terminated array of the names of the + filename="gio/gactiongroup.c" + line="346">a %NULL-terminated array of the names of the actions in the group @@ -2209,8 +2151,8 @@ actions in the group a #GActionGroup + filename="gio/gactiongroup.c" + line="339">a #GActionGroup @@ -2219,8 +2161,8 @@ actions in the group c:identifier="g_action_group_query_action" version="2.32"> Queries all aspects of the named action within an @action_group. + filename="gio/gactiongroup.c" + line="731">Queries all aspects of the named action within an @action_group. This function acquires the information available from g_action_group_has_action(), g_action_group_get_action_enabled(), @@ -2247,25 +2189,24 @@ If the action exists, %TRUE is returned and any of the requested fields (as indicated by having a non-%NULL reference passed in) are filled. If the action doesn't exist, %FALSE is returned and the fields may or may not have been modified. - + %TRUE if the action exists, else %FALSE + filename="gio/gactiongroup.c" + line="769">%TRUE if the action exists, else %FALSE a #GActionGroup + filename="gio/gactiongroup.c" + line="733">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="734">the name of an action in the group caller-allocates="0" transfer-ownership="full"> if the action is presently enabled + filename="gio/gactiongroup.c" + line="735">if the action is presently enabled optional="1" allow-none="1"> the parameter type, or %NULL if none needed + filename="gio/gactiongroup.c" + line="736">the parameter type, or %NULL if none needed optional="1" allow-none="1"> the state type, or %NULL if stateless + filename="gio/gactiongroup.c" + line="737">the state type, or %NULL if stateless optional="1" allow-none="1"> the state hint, or %NULL if none + filename="gio/gactiongroup.c" + line="738">the state hint, or %NULL if none optional="1" allow-none="1"> the current state, or %NULL if stateless + filename="gio/gactiongroup.c" + line="739">the current state, or %NULL if stateless Signals that a new action was just added to the group. + filename="gio/gactiongroup.c" + line="241">Signals that a new action was just added to the group. This signal is emitted after the action has been added and is now visible. @@ -2335,8 +2276,8 @@ and is now visible. the name of the action in @action_group + filename="gio/gactiongroup.c" + line="244">the name of the action in @action_group @@ -2346,22 +2287,22 @@ and is now visible. detailed="1" version="2.28"> Signals that the enabled status of the named action has changed. + filename="gio/gactiongroup.c" + line="284">Signals that the enabled status of the named action has changed. the name of the action in @action_group + filename="gio/gactiongroup.c" + line="287">the name of the action in @action_group whether the action is enabled or not + filename="gio/gactiongroup.c" + line="288">whether the action is enabled or not @@ -2371,8 +2312,8 @@ and is now visible. detailed="1" version="2.28"> Signals that an action is just about to be removed from the group. + filename="gio/gactiongroup.c" + line="262">Signals that an action is just about to be removed from the group. This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler. @@ -2381,8 +2322,8 @@ is still visible and can be queried from the signal handler. the name of the action in @action_group + filename="gio/gactiongroup.c" + line="265">the name of the action in @action_group @@ -2392,22 +2333,22 @@ is still visible and can be queried from the signal handler. detailed="1" version="2.28"> Signals that the state of the named action has changed. + filename="gio/gactiongroup.c" + line="309">Signals that the state of the named action has changed. the name of the action in @action_group + filename="gio/gactiongroup.c" + line="312">the name of the action in @action_group the new value of the state + filename="gio/gactiongroup.c" + line="313">the new value of the state @@ -2418,47 +2359,50 @@ is still visible and can be queried from the signal handler. glib:is-gtype-struct-for="ActionGroup" version="2.28"> The virtual function table for #GActionGroup. - + filename="gio/gactiongroup.c" + line="77">The virtual function table for #GActionGroup. + + the virtual function pointer for g_action_group_has_action() - + whether the named action exists + filename="gio/gactiongroup.c" + line="367">whether the named action exists a #GActionGroup + filename="gio/gactiongroup.c" + line="362">a #GActionGroup the name of the action to check for + filename="gio/gactiongroup.c" + line="363">the name of the action to check for + the virtual function pointer for g_action_group_list_actions() - + a %NULL-terminated array of the names of the + filename="gio/gactiongroup.c" + line="346">a %NULL-terminated array of the names of the actions in the group @@ -2467,190 +2411,204 @@ actions in the group a #GActionGroup + filename="gio/gactiongroup.c" + line="339">a #GActionGroup + the virtual function pointer for g_action_group_get_action_enabled() - + whether or not the action is currently enabled + filename="gio/gactiongroup.c" + line="498">whether or not the action is currently enabled a #GActionGroup + filename="gio/gactiongroup.c" + line="490">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="491">the name of the action to query + the virtual function pointer for g_action_group_get_action_parameter_type() - + the parameter type + filename="gio/gactiongroup.c" + line="400">the parameter type a #GActionGroup + filename="gio/gactiongroup.c" + line="383">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="384">the name of the action to query + the virtual function pointer for g_action_group_get_action_state_type() - + the state type, if the action is stateful + filename="gio/gactiongroup.c" + line="436">the state type, if the action is stateful a #GActionGroup + filename="gio/gactiongroup.c" + line="416">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="417">the name of the action to query + the virtual function pointer for g_action_group_get_action_state_hint() - + the state range hint + filename="gio/gactiongroup.c" + line="474">the state range hint a #GActionGroup + filename="gio/gactiongroup.c" + line="452">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="453">the name of the action to query + the virtual function pointer for g_action_group_get_action_state() - + the current state of the action + filename="gio/gactiongroup.c" + line="526">the current state of the action a #GActionGroup + filename="gio/gactiongroup.c" + line="514">a #GActionGroup the name of the action to query + filename="gio/gactiongroup.c" + line="515">the name of the action to query + the virtual function pointer for g_action_group_change_action_state() - + a #GActionGroup + filename="gio/gactiongroup.c" + line="542">a #GActionGroup the name of the action to request the change on + filename="gio/gactiongroup.c" + line="543">the name of the action to request the change on the new state + filename="gio/gactiongroup.c" + line="544">the new state + the virtual function pointer for g_action_group_activate_action() - + a #GActionGroup + filename="gio/gactiongroup.c" + line="575">a #GActionGroup the name of the action to activate + filename="gio/gactiongroup.c" + line="576">the name of the action to activate nullable="1" allow-none="1"> parameters to the activation + filename="gio/gactiongroup.c" + line="577">parameters to the activation + the class closure for the #GActionGroup::action-added signal - + a #GActionGroup + filename="gio/gactiongroup.c" + line="629">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="630">the name of an action in the group + the class closure for the #GActionGroup::action-removed signal - + a #GActionGroup + filename="gio/gactiongroup.c" + line="653">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="654">the name of an action in the group + the class closure for the #GActionGroup::action-enabled-changed signal - + a #GActionGroup + filename="gio/gactiongroup.c" + line="677">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="678">the name of an action in the group whether or not the action is now enabled + filename="gio/gactiongroup.c" + line="679">whether or not the action is now enabled + the class closure for the #GActionGroup::action-enabled-changed signal - + a #GActionGroup + filename="gio/gactiongroup.c" + line="706">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="707">the name of an action in the group the new state of the named action + filename="gio/gactiongroup.c" + line="708">the new state of the named action + the virtual function pointer for g_action_group_query_action() - + %TRUE if the action exists, else %FALSE + filename="gio/gactiongroup.c" + line="769">%TRUE if the action exists, else %FALSE a #GActionGroup + filename="gio/gactiongroup.c" + line="733">a #GActionGroup the name of an action in the group + filename="gio/gactiongroup.c" + line="734">the name of an action in the group caller-allocates="0" transfer-ownership="full"> if the action is presently enabled + filename="gio/gactiongroup.c" + line="735">if the action is presently enabled optional="1" allow-none="1"> the parameter type, or %NULL if none needed + filename="gio/gactiongroup.c" + line="736">the parameter type, or %NULL if none needed optional="1" allow-none="1"> the state type, or %NULL if stateless + filename="gio/gactiongroup.c" + line="737">the state type, or %NULL if stateless optional="1" allow-none="1"> the state hint, or %NULL if none + filename="gio/gactiongroup.c" + line="738">the state hint, or %NULL if none optional="1" allow-none="1"> the current state, or %NULL if stateless + filename="gio/gactiongroup.c" + line="739">the current state, or %NULL if stateless @@ -2854,168 +2822,184 @@ actions in the group glib:is-gtype-struct-for="Action" version="2.28"> The virtual function table for #GAction. - + filename="gio/gaction.c" + line="64">The virtual function table for [type@Gio.Action]. + + the virtual function pointer for [method@Gio.Action.get_name] - + the name of the action + filename="gio/gaction.c" + line="228">the name of the action a #GAction + filename="gio/gaction.c" + line="224">a #GAction + the virtual function pointer for [method@Gio.Action.get_parameter_type] - + the parameter type + filename="gio/gaction.c" + line="254">the parameter type a #GAction + filename="gio/gaction.c" + line="243">a #GAction + the virtual function pointer for [method@Gio.Action.get_state_type] - + the state type, if the action is stateful + filename="gio/gaction.c" + line="284">the state type, if the action is stateful a #GAction + filename="gio/gaction.c" + line="269">a #GAction + the virtual function pointer for [method@Gio.Action.get_state_hint] - + the state range hint + filename="gio/gaction.c" + line="320">the state range hint a #GAction + filename="gio/gaction.c" + line="299">a #GAction + the virtual function pointer for [method@Gio.Action.get_enabled] - + whether the action is enabled + filename="gio/gaction.c" + line="342">whether the action is enabled a #GAction + filename="gio/gaction.c" + line="335">a #GAction + the virtual function pointer for [method@Gio.Action.get_state] - + the current state of the action + filename="gio/gaction.c" + line="209">the current state of the action a #GAction + filename="gio/gaction.c" + line="198">a #GAction + the virtual function pointer for [method@Gio.Action.change_state] - + a #GAction + filename="gio/gaction.c" + line="160">a #GAction the new state + filename="gio/gaction.c" + line="161">the new state + the virtual function pointer for [method@Gio.Action.activate]. Note that [type@Gio.Action] does not have an + 'activate' signal but that implementations of it may have one. - + a #GAction + filename="gio/gaction.c" + line="357">a #GAction nullable="1" allow-none="1"> the parameter to the activation + filename="gio/gaction.c" + line="358">the parameter to the activation @@ -3039,43 +3023,43 @@ actions in the group glib:get-type="g_action_map_get_type" glib:type-struct="ActionMapInterface"> The GActionMap interface is implemented by #GActionGroup -implementations that operate by containing a number of -named #GAction instances, such as #GSimpleActionGroup. + filename="gio/gactionmap.c" + line="28">`GActionMap` is an interface for action containers. + +The `GActionMap` interface is implemented by [iface@Gio.ActionGroup] +implementations that operate by containing a number of named +[iface@Gio.Action] instances, such as [class@Gio.SimpleActionGroup]. One useful application of this interface is to map the names of actions from various action groups to unique, prefixed names (e.g. by prepending "app." or "win."). This is the motivation for the 'Map' part of the interface name. - + Adds an action to the @action_map. + filename="gio/gactionmap.c" + line="85">Adds an action to the @action_map. If the action map already contains an action with the same name as @action then the old action is dropped from the action map. The action map takes its own reference on @action. - + a #GActionMap + filename="gio/gactionmap.c" + line="87">a #GActionMap a #GAction + filename="gio/gactionmap.c" + line="88">a #GAction @@ -3084,29 +3068,28 @@ The action map takes its own reference on @action. invoker="lookup_action" version="2.32"> Looks up the action with the name @action_name in @action_map. + filename="gio/gactionmap.c" + line="64">Looks up the action with the name @action_name in @action_map. If no such action exists, returns %NULL. - + a #GAction, or %NULL + filename="gio/gactionmap.c" + line="73">a #GAction, or %NULL a #GActionMap + filename="gio/gactionmap.c" + line="66">a #GActionMap the name of an action + filename="gio/gactionmap.c" + line="67">the name of an action @@ -3115,26 +3098,25 @@ If no such action exists, returns %NULL. invoker="remove_action" version="2.32"> Removes the named action from the action map. + filename="gio/gactionmap.c" + line="106">Removes the named action from the action map. If no action of this name is in the map then nothing happens. - + a #GActionMap + filename="gio/gactionmap.c" + line="108">a #GActionMap the name of the action + filename="gio/gactionmap.c" + line="109">the name of the action @@ -3143,29 +3125,28 @@ If no action of this name is in the map then nothing happens. c:identifier="g_action_map_add_action" version="2.32"> Adds an action to the @action_map. + filename="gio/gactionmap.c" + line="85">Adds an action to the @action_map. If the action map already contains an action with the same name as @action then the old action is dropped from the action map. The action map takes its own reference on @action. - + a #GActionMap + filename="gio/gactionmap.c" + line="87">a #GActionMap a #GAction + filename="gio/gactionmap.c" + line="88">a #GAction @@ -3174,8 +3155,8 @@ The action map takes its own reference on @action. c:identifier="g_action_map_add_action_entries" version="2.32"> A convenience function for creating multiple #GSimpleAction instances + filename="gio/gactionmap.c" + line="158">A convenience function for creating multiple #GSimpleAction instances and adding them to a #GActionMap. Each action is constructed as per one #GActionEntry. @@ -3212,22 +3193,21 @@ create_action_group (void) return G_ACTION_GROUP (group); } ]| - + a #GActionMap + filename="gio/gactionmap.c" + line="160">a #GActionMap a pointer to + filename="gio/gactionmap.c" + line="161">a pointer to the first item in an array of #GActionEntry structs @@ -3235,8 +3215,8 @@ create_action_group (void) the length of @entries, or -1 if @entries is %NULL-terminated + filename="gio/gactionmap.c" + line="163">the length of @entries, or -1 if @entries is %NULL-terminated the user data for signal connections + filename="gio/gactionmap.c" + line="164">the user data for signal connections @@ -3254,29 +3234,28 @@ create_action_group (void) c:identifier="g_action_map_lookup_action" version="2.32"> Looks up the action with the name @action_name in @action_map. + filename="gio/gactionmap.c" + line="64">Looks up the action with the name @action_name in @action_map. If no such action exists, returns %NULL. - + a #GAction, or %NULL + filename="gio/gactionmap.c" + line="73">a #GAction, or %NULL a #GActionMap + filename="gio/gactionmap.c" + line="66">a #GActionMap the name of an action + filename="gio/gactionmap.c" + line="67">the name of an action @@ -3285,26 +3264,25 @@ If no such action exists, returns %NULL. c:identifier="g_action_map_remove_action" version="2.32"> Removes the named action from the action map. + filename="gio/gactionmap.c" + line="106">Removes the named action from the action map. If no action of this name is in the map then nothing happens. - + a #GActionMap + filename="gio/gactionmap.c" + line="108">a #GActionMap the name of the action + filename="gio/gactionmap.c" + line="109">the name of the action @@ -3313,8 +3291,8 @@ If no action of this name is in the map then nothing happens. c:identifier="g_action_map_remove_action_entries" version="2.78"> Remove actions from a #GActionMap. This is meant as the reverse of + filename="gio/gactionmap.c" + line="279">Remove actions from a #GActionMap. This is meant as the reverse of g_action_map_add_action_entries(). @@ -3336,22 +3314,21 @@ remove_actions (GActionMap *map) g_action_map_remove_action_entries (map, entries, G_N_ELEMENTS (entries)); } ]| - + The #GActionMap + filename="gio/gactionmap.c" + line="281">The #GActionMap a pointer to + filename="gio/gactionmap.c" + line="282">a pointer to the first item in an array of #GActionEntry structs @@ -3359,8 +3336,8 @@ remove_actions (GActionMap *map) the length of @entries, or -1 if @entries is %NULL-terminated + filename="gio/gactionmap.c" + line="284">the length of @entries, or -1 if @entries is %NULL-terminated @@ -3371,80 +3348,85 @@ remove_actions (GActionMap *map) glib:is-gtype-struct-for="ActionMap" version="2.32"> The virtual function table for #GActionMap. - + filename="gio/gactionmap.c" + line="46">The virtual function table for #GActionMap. + + the virtual function pointer for g_action_map_lookup_action() - + a #GAction, or %NULL + filename="gio/gactionmap.c" + line="73">a #GAction, or %NULL a #GActionMap + filename="gio/gactionmap.c" + line="66">a #GActionMap the name of an action + filename="gio/gactionmap.c" + line="67">the name of an action + the virtual function pointer for g_action_map_add_action() - + a #GActionMap + filename="gio/gactionmap.c" + line="87">a #GActionMap a #GAction + filename="gio/gactionmap.c" + line="88">a #GAction + the virtual function pointer for g_action_map_remove_action() - + a #GActionMap + filename="gio/gactionmap.c" + line="108">a #GActionMap the name of the action + filename="gio/gactionmap.c" + line="109">the name of the action @@ -3458,33 +3440,36 @@ remove_actions (GActionMap *map) glib:get-type="g_app_info_get_type" glib:type-struct="AppInfoIface"> #GAppInfo and #GAppLaunchContext are used for describing and launching + filename="gio/gappinfo.c" + line="47">Information about an installed application and methods to launch +it (with file arguments). + +`GAppInfo` and `GAppLaunchContext` are used for describing and launching applications installed on the system. As of GLib 2.20, URIs will always be converted to POSIX paths -(using g_file_get_path()) when using g_app_info_launch() even if -the application requested an URI and not a POSIX path. For example +(using [method@Gio.File.get_path]) when using [method@Gio.AppInfo.launch] +even if the application requested an URI and not a POSIX path. For example for a desktop-file based application with Exec key `totem %U` and a single URI, `sftp://foo/file.avi`, then `/home/user/.gvfs/sftp on foo/file.avi` will be passed. This will -only work if a set of suitable GIO extensions (such as gvfs 2.26 +only work if a set of suitable GIO extensions (such as GVfs 2.26 compiled with FUSE support), is available and operational; if this is not the case, the URI will be passed unmodified to the application. Some URIs, such as `mailto:`, of course cannot be mapped to a POSIX -path (in gvfs there's no FUSE mount for it); such URIs will be +path (in GVfs there's no FUSE mount for it); such URIs will be passed unmodified to the application. -Specifically for gvfs 2.26 and later, the POSIX URI will be mapped -back to the GIO URI in the #GFile constructors (since gvfs -implements the #GVfs extension point). As such, if the application -needs to examine the URI, it needs to use g_file_get_uri() or -similar on #GFile. In other words, an application cannot assume -that the URI passed to e.g. g_file_new_for_commandline_arg() is -equal to the result of g_file_get_uri(). The following snippet +Specifically for GVfs 2.26 and later, the POSIX URI will be mapped +back to the GIO URI in the [iface@Gio.File] constructors (since GVfs +implements the GVfs extension point). As such, if the application +needs to examine the URI, it needs to use [method@Gio.File.get_uri] +or similar on [iface@Gio.File]. In other words, an application cannot +assume that the URI passed to e.g. [func@Gio.File.new_for_commandline_arg] +is equal to the result of [method@Gio.File.get_uri]. The following snippet illustrates this: -|[ +```c GFile *f; char *uri; @@ -3499,7 +3484,7 @@ if (g_file_has_uri_scheme (file, "cdda")) // do something special with uri } g_object_unref (file); -]| +``` This code will work when both `cdda://sr0/Track 1.wav` and `/home/user/.gvfs/cdda on sr0/Track 1.wav` is passed to the @@ -3507,33 +3492,31 @@ application. It should be noted that it's generally not safe for applications to rely on the format of a particular URIs. Different launcher applications (e.g. file managers) may have different ideas of what a given URI means. - + Creates a new #GAppInfo from the given information. + filename="gio/gdesktopappinfo.c" + line="4317">Creates a new #GAppInfo from the given information. Note that for @commandline, the quoting rules of the Exec key of the [freedesktop.org Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) are applied. For example, if the @commandline contains percent-encoded URIs, the percent-character must be doubled in order to prevent it from being swallowed by Exec key unquoting. See the specification for exact quoting rules. - + new #GAppInfo for given command. + filename="gio/gdesktopappinfo.c" + line="4332">new #GAppInfo for given command. the commandline to use + filename="gio/gdesktopappinfo.c" + line="4319">the commandline to use the application name, or %NULL to use @commandline + filename="gio/gdesktopappinfo.c" + line="4320">the application name, or %NULL to use @commandline flags that can specify details of the created #GAppInfo + filename="gio/gdesktopappinfo.c" + line="4321">flags that can specify details of the created #GAppInfo Gets a list of all of the applications currently registered + filename="gio/gdesktopappinfo.c" + line="4894">Gets a list of all of the applications currently registered on this system. For desktop files, this includes applications that have @@ -3564,12 +3547,11 @@ For desktop files, this includes applications that have of `OnlyShowIn` or `NotShowIn`. See g_app_info_should_show(). The returned list does not include applications which have the `Hidden` key set. - + a newly allocated #GList of references to #GAppInfos. + filename="gio/gdesktopappinfo.c" + line="4906">a newly allocated #GList of references to #GAppInfos. @@ -3578,17 +3560,16 @@ the `Hidden` key set. Gets a list of all #GAppInfos for a given content type, + filename="gio/gdesktopappinfo.c" + line="4581">Gets a list of all #GAppInfos for a given content type, including the recommended and fallback #GAppInfos. See g_app_info_get_recommended_for_type() and g_app_info_get_fallback_for_type(). - + #GList of #GAppInfos + filename="gio/gdesktopappinfo.c" + line="4590">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -3597,37 +3578,37 @@ g_app_info_get_fallback_for_type(). the content type to find a #GAppInfo for + filename="gio/gdesktopappinfo.c" + line="4583">the content type to find a #GAppInfo for + c:identifier="g_app_info_get_default_for_type" + glib:async-func="get_default_for_type_async"> Gets the default #GAppInfo for a given content type. - + filename="gio/gdesktopappinfo.c" + line="4639">Gets the default #GAppInfo for a given content type. + #GAppInfo for given @content_type or + filename="gio/gdesktopappinfo.c" + line="4647">#GAppInfo for given @content_type or %NULL on error. the content type to find a #GAppInfo for + filename="gio/gdesktopappinfo.c" + line="4641">the content type to find a #GAppInfo for if %TRUE, the #GAppInfo is expected to + filename="gio/gdesktopappinfo.c" + line="4642">if %TRUE, the #GAppInfo is expected to support URIs @@ -3635,26 +3616,27 @@ g_app_info_get_fallback_for_type(). + version="2.74" + glib:finish-func="get_default_for_type_finish" + glib:sync-func="get_default_for_type"> Asynchronously gets the default #GAppInfo for a given content type. - + filename="gio/gappinfo.c" + line="822">Asynchronously gets the default #GAppInfo for a given content type. + the content type to find a #GAppInfo for + filename="gio/gappinfo.c" + line="824">the content type to find a #GAppInfo for if %TRUE, the #GAppInfo is expected to + filename="gio/gappinfo.c" + line="825">if %TRUE, the #GAppInfo is expected to support URIs @@ -3663,8 +3645,8 @@ g_app_info_get_fallback_for_type(). nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gappinfo.c" + line="827">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gappinfo.c" + line="828">a #GAsyncReadyCallback to call when the request is done nullable="1" allow-none="1"> data to pass to @callback + filename="gio/gappinfo.c" + line="829">data to pass to @callback @@ -3694,74 +3676,74 @@ g_app_info_get_fallback_for_type(). version="2.74" throws="1"> Finishes a default #GAppInfo lookup started by + filename="gio/gappinfo.c" + line="942">Finishes a default #GAppInfo lookup started by g_app_info_get_default_for_type_async(). If no #GAppInfo is found, then @error will be set to %G_IO_ERROR_NOT_FOUND. - + #GAppInfo for given @content_type or + filename="gio/gappinfo.c" + line="952">#GAppInfo for given @content_type or %NULL on error. a #GAsyncResult + filename="gio/gappinfo.c" + line="944">a #GAsyncResult + c:identifier="g_app_info_get_default_for_uri_scheme" + glib:async-func="get_default_for_uri_scheme_async"> Gets the default application for handling URIs with + filename="gio/gdesktopappinfo.c" + line="4715">Gets the default application for handling URIs with the given URI scheme. A URI scheme is the initial part of the URI, up to but not including the ':', e.g. "http", "ftp" or "sip". - + #GAppInfo for given @uri_scheme or + filename="gio/gdesktopappinfo.c" + line="4724">#GAppInfo for given @uri_scheme or %NULL on error. a string containing a URI scheme. + filename="gio/gdesktopappinfo.c" + line="4717">a string containing a URI scheme. + version="2.74" + glib:finish-func="get_default_for_uri_scheme_finish" + glib:sync-func="get_default_for_uri_scheme"> Asynchronously gets the default application for handling URIs with + filename="gio/gappinfo.c" + line="882">Asynchronously gets the default application for handling URIs with the given URI scheme. A URI scheme is the initial part of the URI, up to but not including the ':', e.g. "http", "ftp" or "sip". - + a string containing a URI scheme. + filename="gio/gappinfo.c" + line="884">a string containing a URI scheme. optional #GCancellable object, %NULL to ignore + filename="gio/gappinfo.c" + line="885">optional #GCancellable object, %NULL to ignore a #GAsyncReadyCallback to call when the request is done + filename="gio/gappinfo.c" + line="886">a #GAsyncReadyCallback to call when the request is done data to pass to @callback + filename="gio/gappinfo.c" + line="887">data to pass to @callback @@ -3800,25 +3782,24 @@ of the URI, up to but not including the ':', e.g. "http", version="2.74" throws="1"> Finishes a default #GAppInfo lookup started by + filename="gio/gappinfo.c" + line="915">Finishes a default #GAppInfo lookup started by g_app_info_get_default_for_uri_scheme_async(). If no #GAppInfo is found, then @error will be set to %G_IO_ERROR_NOT_FOUND. - + #GAppInfo for given @uri_scheme or + filename="gio/gappinfo.c" + line="925">#GAppInfo for given @uri_scheme or %NULL on error. a #GAsyncResult + filename="gio/gappinfo.c" + line="917">a #GAsyncResult @@ -3827,16 +3808,15 @@ If no #GAppInfo is found, then @error will be set to %G_IO_ERROR_NOT_FOUND. Gets a list of fallback #GAppInfos for a given content type, i.e. + filename="gio/gdesktopappinfo.c" + line="4529">Gets a list of fallback #GAppInfos for a given content type, i.e. those applications which claim to support the given content type by MIME type subclassing and not directly. - + #GList of #GAppInfos + filename="gio/gdesktopappinfo.c" + line="4537">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -3845,8 +3825,8 @@ by MIME type subclassing and not directly. the content type to find a #GAppInfo for + filename="gio/gdesktopappinfo.c" + line="4531">the content type to find a #GAppInfo for @@ -3855,19 +3835,18 @@ by MIME type subclassing and not directly. c:identifier="g_app_info_get_recommended_for_type" version="2.28"> Gets a list of recommended #GAppInfos for a given content type, i.e. + filename="gio/gdesktopappinfo.c" + line="4487">Gets a list of recommended #GAppInfos for a given content type, i.e. those applications which claim to support the given content type exactly, and not by MIME type subclassing. Note that the first application of the list is the last used one, i.e. the last one for which g_app_info_set_as_last_used_for_type() has been called. - + #GList of #GAppInfos + filename="gio/gdesktopappinfo.c" + line="4498">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -3876,18 +3855,19 @@ called. the content type to find a #GAppInfo for + filename="gio/gdesktopappinfo.c" + line="4489">the content type to find a #GAppInfo for + throws="1" + glib:async-func="launch_default_for_uri_async"> Utility function that launches the default application + filename="gio/gappinfo.c" + line="969">Utility function that launches the default application registered to handle the specified uri. Synchronous I/O is done on the uri to detect the type of the file if required. @@ -3895,19 +3875,18 @@ required. The D-Bus–activated applications don't have to be started if your application terminates too soon after this function. To prevent this, use g_app_info_launch_default_for_uri_async() instead. - + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="984">%TRUE on success, %FALSE on error. the uri to show + filename="gio/gappinfo.c" + line="971">the uri to show nullable="1" allow-none="1"> an optional #GAppLaunchContext + filename="gio/gappinfo.c" + line="972">an optional #GAppLaunchContext + version="2.50" + glib:finish-func="launch_default_for_uri_finish" + glib:sync-func="launch_default_for_uri"> Async version of g_app_info_launch_default_for_uri(). + filename="gio/gappinfo.c" + line="1197">Async version of g_app_info_launch_default_for_uri(). This version is useful if you are interested in receiving error information in the case where the application is @@ -3936,16 +3917,15 @@ dialog to the user. This is also useful if you want to be sure that the D-Bus–activated applications are really started before termination and if you are interested in receiving error information from their activation. - + the uri to show + filename="gio/gappinfo.c" + line="1199">the uri to show nullable="1" allow-none="1"> an optional #GAppLaunchContext + filename="gio/gappinfo.c" + line="1200">an optional #GAppLaunchContext nullable="1" allow-none="1"> a #GCancellable + filename="gio/gappinfo.c" + line="1201">a #GCancellable scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gappinfo.c" + line="1202">a #GAsyncReadyCallback to call when the request is done nullable="1" allow-none="1"> data to pass to @callback + filename="gio/gappinfo.c" + line="1203">data to pass to @callback @@ -3993,21 +3973,20 @@ in receiving error information from their activation. version="2.50" throws="1"> Finishes an asynchronous launch-default-for-uri operation. - + filename="gio/gappinfo.c" + line="1259">Finishes an asynchronous launch-default-for-uri operation. + %TRUE if the launch was successful, %FALSE if @error is set + filename="gio/gappinfo.c" + line="1266">%TRUE if the launch was successful, %FALSE if @error is set a #GAsyncResult + filename="gio/gappinfo.c" + line="1261">a #GAsyncResult @@ -4016,22 +3995,21 @@ in receiving error information from their activation. c:identifier="g_app_info_reset_type_associations" version="2.20"> Removes all changes to the type associations done by + filename="gio/gdesktopappinfo.c" + line="4619">Removes all changes to the type associations done by g_app_info_set_as_default_for_type(), g_app_info_set_as_default_for_extension(), g_app_info_add_supports_type() or g_app_info_remove_supports_type(). - + a content type + filename="gio/gdesktopappinfo.c" + line="4621">a content type @@ -4040,50 +4018,48 @@ g_app_info_remove_supports_type(). invoker="add_supports_type" throws="1"> Adds a content type to the application information to indicate the + filename="gio/gappinfo.c" + line="408">Adds a content type to the application information to indicate the application is capable of opening files with the given content type. - + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="417">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="410">a #GAppInfo. a string. + filename="gio/gappinfo.c" + line="411">a string. Obtains the information whether the #GAppInfo can be deleted. + filename="gio/gappinfo.c" + line="1279">Obtains the information whether the #GAppInfo can be deleted. See g_app_info_delete(). - + %TRUE if @appinfo can be deleted + filename="gio/gappinfo.c" + line="1286">%TRUE if @appinfo can be deleted a #GAppInfo + filename="gio/gappinfo.c" + line="1281">a #GAppInfo @@ -4091,99 +4067,95 @@ See g_app_info_delete(). Checks if a supported content type can be removed from an application. - + filename="gio/gappinfo.c" + line="442">Checks if a supported content type can be removed from an application. + %TRUE if it is possible to remove supported + filename="gio/gappinfo.c" + line="448">%TRUE if it is possible to remove supported content types from a given @appinfo, %FALSE if not. a #GAppInfo. + filename="gio/gappinfo.c" + line="444">a #GAppInfo. Tries to delete a #GAppInfo. + filename="gio/gappinfo.c" + line="1306">Tries to delete a #GAppInfo. On some platforms, there may be a difference between user-defined #GAppInfos which can be deleted, and system-wide ones which cannot. See g_app_info_can_delete(). - + %TRUE if @appinfo has been deleted + filename="gio/gappinfo.c" + line="1316">%TRUE if @appinfo has been deleted a #GAppInfo + filename="gio/gappinfo.c" + line="1308">a #GAppInfo Creates a duplicate of a #GAppInfo. - + filename="gio/gappinfo.c" + line="116">Creates a duplicate of a #GAppInfo. + a duplicate of @appinfo. + filename="gio/gappinfo.c" + line="122">a duplicate of @appinfo. a #GAppInfo. + filename="gio/gappinfo.c" + line="118">a #GAppInfo. Checks if two #GAppInfos are equal. + filename="gio/gappinfo.c" + line="136">Checks if two #GAppInfos are equal. Note that the check *may not* compare each individual field, and only does an identity check. In case detecting changes in the contents is needed, program code must additionally compare relevant fields. - + %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. + filename="gio/gappinfo.c" + line="147">%TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. the first #GAppInfo. + filename="gio/gappinfo.c" + line="138">the first #GAppInfo. the second #GAppInfo. + filename="gio/gappinfo.c" + line="139">the second #GAppInfo. @@ -4192,45 +4164,43 @@ contents is needed, program code must additionally compare relevant fields. Gets the commandline with which the application will be + filename="gio/gappinfo.c" + line="286">Gets the commandline with which the application will be started. - + a string containing the @appinfo's commandline, + filename="gio/gappinfo.c" + line="293">a string containing the @appinfo's commandline, or %NULL if this information is not available a #GAppInfo + filename="gio/gappinfo.c" + line="288">a #GAppInfo Gets a human-readable description of an installed application. - + filename="gio/gappinfo.c" + line="239">Gets a human-readable description of an installed application. + a string containing a description of the + filename="gio/gappinfo.c" + line="245">a string containing a description of the application @appinfo, or %NULL if none. a #GAppInfo. + filename="gio/gappinfo.c" + line="241">a #GAppInfo. @@ -4239,119 +4209,114 @@ application @appinfo, or %NULL if none. invoker="get_display_name" version="2.24"> Gets the display name of the application. The display name is often more + filename="gio/gappinfo.c" + line="212">Gets the display name of the application. The display name is often more descriptive to the user than the name itself. - + the display name of the application for @appinfo, or the name if + filename="gio/gappinfo.c" + line="219">the display name of the application for @appinfo, or the name if no display name is available. a #GAppInfo. + filename="gio/gappinfo.c" + line="214">a #GAppInfo. Gets the executable's name for the installed application. + filename="gio/gappinfo.c" + line="260">Gets the executable's name for the installed application. This is intended to be used for debugging or labelling what program is going to be run. To launch the executable, use g_app_info_launch() and related functions, rather than spawning the return value from this function. - + a string containing the @appinfo's application + filename="gio/gappinfo.c" + line="270">a string containing the @appinfo's application binaries name a #GAppInfo + filename="gio/gappinfo.c" + line="262">a #GAppInfo Gets the icon for the application. - + filename="gio/gappinfo.c" + line="531">Gets the icon for the application. + the default #GIcon for @appinfo or %NULL + filename="gio/gappinfo.c" + line="537">the default #GIcon for @appinfo or %NULL if there is no default icon. a #GAppInfo. + filename="gio/gappinfo.c" + line="533">a #GAppInfo. Gets the ID of an application. An id is a string that + filename="gio/gappinfo.c" + line="166">Gets the ID of an application. An id is a string that identifies the application. The exact format of the id is platform dependent. For instance, on Unix this is the desktop file id from the xdg menu specification. Note that the returned ID may be %NULL, depending on how the @appinfo has been constructed. - + a string containing the application's ID. + filename="gio/gappinfo.c" + line="178">a string containing the application's ID. a #GAppInfo. + filename="gio/gappinfo.c" + line="168">a #GAppInfo. Gets the installed name of the application. - + filename="gio/gappinfo.c" + line="192">Gets the installed name of the application. + the name of the application for @appinfo. + filename="gio/gappinfo.c" + line="198">the name of the application for @appinfo. a #GAppInfo. + filename="gio/gappinfo.c" + line="194">a #GAppInfo. @@ -4360,19 +4325,18 @@ the @appinfo has been constructed. invoker="get_supported_types" version="2.34"> Retrieves the list of content types that @app_info claims to support. + filename="gio/gappinfo.c" + line="499">Retrieves the list of content types that @app_info claims to support. If this information is not provided by the environment, this function will return %NULL. This function does not take in consideration associations added with g_app_info_add_supports_type(), but only those exported directly by the application. - + + filename="gio/gappinfo.c" + line="510"> a list of content types. @@ -4381,16 +4345,16 @@ the application. a #GAppInfo that can handle files + filename="gio/gappinfo.c" + line="501">a #GAppInfo that can handle files Launches the application. Passes @files to the launched application + filename="gio/gappinfo.c" + line="553">Launches the application. Passes @files to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. @@ -4417,19 +4381,18 @@ process. This can be used to ignore `GIO_LAUNCHED_DESKTOP_FILE`, should it be inherited by further processes. The `DISPLAY`, `XDG_ACTIVATION_TOKEN` and `DESKTOP_STARTUP_ID` environment variables are also set, based on information provided in @context. - + %TRUE on successful launch, %FALSE otherwise. + filename="gio/gappinfo.c" + line="588">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + filename="gio/gappinfo.c" + line="555">a #GAppInfo nullable="1" allow-none="1"> a #GList of #GFile objects + filename="gio/gappinfo.c" + line="556">a #GList of #GFile objects @@ -4448,16 +4411,19 @@ variables are also set, based on information provided in @context. nullable="1" allow-none="1"> a #GAppLaunchContext or %NULL + filename="gio/gappinfo.c" + line="557">a #GAppLaunchContext or %NULL - + Launches the application. This passes the @uris to the launched application + filename="gio/gappinfo.c" + line="648">Launches the application. This passes the @uris to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. If the application only supports @@ -4469,19 +4435,18 @@ To launch the application without arguments pass a %NULL @uris list. Note that even if the launch is successful the application launched can fail to start if it runs into problems during startup. There is no way to detect this. - + %TRUE on successful launch, %FALSE otherwise. + filename="gio/gappinfo.c" + line="668">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + filename="gio/gappinfo.c" + line="650">a #GAppInfo nullable="1" allow-none="1"> a #GList containing URIs to launch. + filename="gio/gappinfo.c" + line="651">a #GList containing URIs to launch. @@ -4500,33 +4465,34 @@ no way to detect this. nullable="1" allow-none="1"> a #GAppLaunchContext or %NULL + filename="gio/gappinfo.c" + line="652">a #GAppLaunchContext or %NULL + version="2.60" + glib:finish-func="launch_uris_finish" + glib:sync-func="launch_uris"> Async version of g_app_info_launch_uris(). + filename="gio/gappinfo.c" + line="685">Async version of g_app_info_launch_uris(). The @callback is invoked immediately after the application launch, but it waits for activation in case of D-Bus–activated applications and also provides extended error information for sandboxed applications, see notes for g_app_info_launch_default_for_uri_async(). - + a #GAppInfo + filename="gio/gappinfo.c" + line="687">a #GAppInfo nullable="1" allow-none="1"> a #GList containing URIs to launch. + filename="gio/gappinfo.c" + line="688">a #GList containing URIs to launch. @@ -4545,8 +4511,8 @@ g_app_info_launch_default_for_uri_async(). nullable="1" allow-none="1"> a #GAppLaunchContext or %NULL + filename="gio/gappinfo.c" + line="689">a #GAppLaunchContext or %NULL nullable="1" allow-none="1"> a #GCancellable + filename="gio/gappinfo.c" + line="690">a #GCancellable scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gappinfo.c" + line="691">a #GAsyncReadyCallback to call when the request is done allow-none="1" closure="4"> data to pass to @callback + filename="gio/gappinfo.c" + line="692">data to pass to @callback @@ -4586,27 +4552,26 @@ g_app_info_launch_default_for_uri_async(). version="2.60" throws="1"> Finishes a g_app_info_launch_uris_async() operation. - + filename="gio/gappinfo.c" + line="734">Finishes a g_app_info_launch_uris_async() operation. + %TRUE on successful launch, %FALSE otherwise. + filename="gio/gappinfo.c" + line="742">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + filename="gio/gappinfo.c" + line="736">a #GAppInfo a #GAsyncResult + filename="gio/gappinfo.c" + line="737">a #GAsyncResult @@ -4615,27 +4580,26 @@ g_app_info_launch_default_for_uri_async(). invoker="remove_supports_type" throws="1"> Removes a supported type from an application, if possible. - + filename="gio/gappinfo.c" + line="467">Removes a supported type from an application, if possible. + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="475">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="469">a #GAppInfo. a string. + filename="gio/gappinfo.c" + line="470">a string. @@ -4644,27 +4608,26 @@ g_app_info_launch_default_for_uri_async(). invoker="set_as_default_for_extension" throws="1"> Sets the application as the default handler for the given file extension. - + filename="gio/gappinfo.c" + line="376">Sets the application as the default handler for the given file extension. + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="385">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="378">a #GAppInfo. a string containing the file extension + filename="gio/gappinfo.c" + line="379">a string containing the file extension (without the dot). @@ -4674,27 +4637,26 @@ g_app_info_launch_default_for_uri_async(). invoker="set_as_default_for_type" throws="1"> Sets the application as the default handler for a given type. - + filename="gio/gappinfo.c" + line="313">Sets the application as the default handler for a given type. + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="321">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="315">a #GAppInfo. the content type. + filename="gio/gappinfo.c" + line="316">the content type. @@ -4703,94 +4665,90 @@ g_app_info_launch_default_for_uri_async(). invoker="set_as_last_used_for_type" throws="1"> Sets the application as the last used application for a given type. + filename="gio/gappinfo.c" + line="343">Sets the application as the last used application for a given type. This will make the application appear as first in the list returned by g_app_info_get_recommended_for_type(), regardless of the default application for that content type. - + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="354">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="345">a #GAppInfo. the content type. + filename="gio/gappinfo.c" + line="346">the content type. Checks if the application info should be shown in menus that + filename="gio/gappinfo.c" + line="766">Checks if the application info should be shown in menus that list available applications. - + %TRUE if the @appinfo should be shown, %FALSE otherwise. + filename="gio/gappinfo.c" + line="773">%TRUE if the @appinfo should be shown, %FALSE otherwise. a #GAppInfo. + filename="gio/gappinfo.c" + line="768">a #GAppInfo. Checks if the application accepts files as arguments. - + filename="gio/gappinfo.c" + line="627">Checks if the application accepts files as arguments. + %TRUE if the @appinfo supports files. + filename="gio/gappinfo.c" + line="633">%TRUE if the @appinfo supports files. a #GAppInfo. + filename="gio/gappinfo.c" + line="629">a #GAppInfo. Checks if the application supports reading files and directories from URIs. - + filename="gio/gappinfo.c" + line="606">Checks if the application supports reading files and directories from URIs. + %TRUE if the @appinfo supports URIs. + filename="gio/gappinfo.c" + line="612">%TRUE if the @appinfo supports URIs. a #GAppInfo. + filename="gio/gappinfo.c" + line="608">a #GAppInfo. @@ -4799,28 +4757,27 @@ list available applications. c:identifier="g_app_info_add_supports_type" throws="1"> Adds a content type to the application information to indicate the + filename="gio/gappinfo.c" + line="408">Adds a content type to the application information to indicate the application is capable of opening files with the given content type. - + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="417">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="410">a #GAppInfo. a string. + filename="gio/gappinfo.c" + line="411">a string. @@ -4829,22 +4786,21 @@ application is capable of opening files with the given content type. c:identifier="g_app_info_can_delete" version="2.20"> Obtains the information whether the #GAppInfo can be deleted. + filename="gio/gappinfo.c" + line="1279">Obtains the information whether the #GAppInfo can be deleted. See g_app_info_delete(). - + %TRUE if @appinfo can be deleted + filename="gio/gappinfo.c" + line="1286">%TRUE if @appinfo can be deleted a #GAppInfo + filename="gio/gappinfo.c" + line="1281">a #GAppInfo @@ -4852,99 +4808,95 @@ See g_app_info_delete(). Checks if a supported content type can be removed from an application. - + filename="gio/gappinfo.c" + line="442">Checks if a supported content type can be removed from an application. + %TRUE if it is possible to remove supported + filename="gio/gappinfo.c" + line="448">%TRUE if it is possible to remove supported content types from a given @appinfo, %FALSE if not. a #GAppInfo. + filename="gio/gappinfo.c" + line="444">a #GAppInfo. Tries to delete a #GAppInfo. + filename="gio/gappinfo.c" + line="1306">Tries to delete a #GAppInfo. On some platforms, there may be a difference between user-defined #GAppInfos which can be deleted, and system-wide ones which cannot. See g_app_info_can_delete(). - + %TRUE if @appinfo has been deleted + filename="gio/gappinfo.c" + line="1316">%TRUE if @appinfo has been deleted a #GAppInfo + filename="gio/gappinfo.c" + line="1308">a #GAppInfo Creates a duplicate of a #GAppInfo. - + filename="gio/gappinfo.c" + line="116">Creates a duplicate of a #GAppInfo. + a duplicate of @appinfo. + filename="gio/gappinfo.c" + line="122">a duplicate of @appinfo. a #GAppInfo. + filename="gio/gappinfo.c" + line="118">a #GAppInfo. Checks if two #GAppInfos are equal. + filename="gio/gappinfo.c" + line="136">Checks if two #GAppInfos are equal. Note that the check *may not* compare each individual field, and only does an identity check. In case detecting changes in the contents is needed, program code must additionally compare relevant fields. - + %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. + filename="gio/gappinfo.c" + line="147">%TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. the first #GAppInfo. + filename="gio/gappinfo.c" + line="138">the first #GAppInfo. the second #GAppInfo. + filename="gio/gappinfo.c" + line="139">the second #GAppInfo. @@ -4953,45 +4905,43 @@ contents is needed, program code must additionally compare relevant fields. Gets the commandline with which the application will be + filename="gio/gappinfo.c" + line="286">Gets the commandline with which the application will be started. - + a string containing the @appinfo's commandline, + filename="gio/gappinfo.c" + line="293">a string containing the @appinfo's commandline, or %NULL if this information is not available a #GAppInfo + filename="gio/gappinfo.c" + line="288">a #GAppInfo Gets a human-readable description of an installed application. - + filename="gio/gappinfo.c" + line="239">Gets a human-readable description of an installed application. + a string containing a description of the + filename="gio/gappinfo.c" + line="245">a string containing a description of the application @appinfo, or %NULL if none. a #GAppInfo. + filename="gio/gappinfo.c" + line="241">a #GAppInfo. @@ -5000,119 +4950,114 @@ application @appinfo, or %NULL if none. c:identifier="g_app_info_get_display_name" version="2.24"> Gets the display name of the application. The display name is often more + filename="gio/gappinfo.c" + line="212">Gets the display name of the application. The display name is often more descriptive to the user than the name itself. - + the display name of the application for @appinfo, or the name if + filename="gio/gappinfo.c" + line="219">the display name of the application for @appinfo, or the name if no display name is available. a #GAppInfo. + filename="gio/gappinfo.c" + line="214">a #GAppInfo. Gets the executable's name for the installed application. + filename="gio/gappinfo.c" + line="260">Gets the executable's name for the installed application. This is intended to be used for debugging or labelling what program is going to be run. To launch the executable, use g_app_info_launch() and related functions, rather than spawning the return value from this function. - + a string containing the @appinfo's application + filename="gio/gappinfo.c" + line="270">a string containing the @appinfo's application binaries name a #GAppInfo + filename="gio/gappinfo.c" + line="262">a #GAppInfo Gets the icon for the application. - + filename="gio/gappinfo.c" + line="531">Gets the icon for the application. + the default #GIcon for @appinfo or %NULL + filename="gio/gappinfo.c" + line="537">the default #GIcon for @appinfo or %NULL if there is no default icon. a #GAppInfo. + filename="gio/gappinfo.c" + line="533">a #GAppInfo. Gets the ID of an application. An id is a string that + filename="gio/gappinfo.c" + line="166">Gets the ID of an application. An id is a string that identifies the application. The exact format of the id is platform dependent. For instance, on Unix this is the desktop file id from the xdg menu specification. Note that the returned ID may be %NULL, depending on how the @appinfo has been constructed. - + a string containing the application's ID. + filename="gio/gappinfo.c" + line="178">a string containing the application's ID. a #GAppInfo. + filename="gio/gappinfo.c" + line="168">a #GAppInfo. Gets the installed name of the application. - + filename="gio/gappinfo.c" + line="192">Gets the installed name of the application. + the name of the application for @appinfo. + filename="gio/gappinfo.c" + line="198">the name of the application for @appinfo. a #GAppInfo. + filename="gio/gappinfo.c" + line="194">a #GAppInfo. @@ -5121,19 +5066,18 @@ the @appinfo has been constructed. c:identifier="g_app_info_get_supported_types" version="2.34"> Retrieves the list of content types that @app_info claims to support. + filename="gio/gappinfo.c" + line="499">Retrieves the list of content types that @app_info claims to support. If this information is not provided by the environment, this function will return %NULL. This function does not take in consideration associations added with g_app_info_add_supports_type(), but only those exported directly by the application. - + + filename="gio/gappinfo.c" + line="510"> a list of content types. @@ -5142,16 +5086,16 @@ the application. a #GAppInfo that can handle files + filename="gio/gappinfo.c" + line="501">a #GAppInfo that can handle files Launches the application. Passes @files to the launched application + filename="gio/gappinfo.c" + line="553">Launches the application. Passes @files to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. @@ -5178,19 +5122,18 @@ process. This can be used to ignore `GIO_LAUNCHED_DESKTOP_FILE`, should it be inherited by further processes. The `DISPLAY`, `XDG_ACTIVATION_TOKEN` and `DESKTOP_STARTUP_ID` environment variables are also set, based on information provided in @context. - + %TRUE on successful launch, %FALSE otherwise. + filename="gio/gappinfo.c" + line="588">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + filename="gio/gappinfo.c" + line="555">a #GAppInfo nullable="1" allow-none="1"> a #GList of #GFile objects + filename="gio/gappinfo.c" + line="556">a #GList of #GFile objects @@ -5209,18 +5152,19 @@ variables are also set, based on information provided in @context. nullable="1" allow-none="1"> a #GAppLaunchContext or %NULL + filename="gio/gappinfo.c" + line="557">a #GAppLaunchContext or %NULL + throws="1" + glib:async-func="launch_uris_async"> Launches the application. This passes the @uris to the launched application + filename="gio/gappinfo.c" + line="648">Launches the application. This passes the @uris to the launched application as arguments, using the optional @context to get information about the details of the launcher (like what screen it is on). On error, @error will be set accordingly. If the application only supports @@ -5232,19 +5176,18 @@ To launch the application without arguments pass a %NULL @uris list. Note that even if the launch is successful the application launched can fail to start if it runs into problems during startup. There is no way to detect this. - + %TRUE on successful launch, %FALSE otherwise. + filename="gio/gappinfo.c" + line="668">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + filename="gio/gappinfo.c" + line="650">a #GAppInfo nullable="1" allow-none="1"> a #GList containing URIs to launch. + filename="gio/gappinfo.c" + line="651">a #GList containing URIs to launch. @@ -5263,33 +5206,34 @@ no way to detect this. nullable="1" allow-none="1"> a #GAppLaunchContext or %NULL + filename="gio/gappinfo.c" + line="652">a #GAppLaunchContext or %NULL + version="2.60" + glib:finish-func="launch_uris_finish" + glib:sync-func="launch_uris"> Async version of g_app_info_launch_uris(). + filename="gio/gappinfo.c" + line="685">Async version of g_app_info_launch_uris(). The @callback is invoked immediately after the application launch, but it waits for activation in case of D-Bus–activated applications and also provides extended error information for sandboxed applications, see notes for g_app_info_launch_default_for_uri_async(). - + a #GAppInfo + filename="gio/gappinfo.c" + line="687">a #GAppInfo nullable="1" allow-none="1"> a #GList containing URIs to launch. + filename="gio/gappinfo.c" + line="688">a #GList containing URIs to launch. @@ -5308,8 +5252,8 @@ g_app_info_launch_default_for_uri_async(). nullable="1" allow-none="1"> a #GAppLaunchContext or %NULL + filename="gio/gappinfo.c" + line="689">a #GAppLaunchContext or %NULL nullable="1" allow-none="1"> a #GCancellable + filename="gio/gappinfo.c" + line="690">a #GCancellable scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gappinfo.c" + line="691">a #GAsyncReadyCallback to call when the request is done nullable="1" allow-none="1"> data to pass to @callback + filename="gio/gappinfo.c" + line="692">data to pass to @callback @@ -5348,27 +5292,26 @@ g_app_info_launch_default_for_uri_async(). version="2.60" throws="1"> Finishes a g_app_info_launch_uris_async() operation. - + filename="gio/gappinfo.c" + line="734">Finishes a g_app_info_launch_uris_async() operation. + %TRUE on successful launch, %FALSE otherwise. + filename="gio/gappinfo.c" + line="742">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + filename="gio/gappinfo.c" + line="736">a #GAppInfo a #GAsyncResult + filename="gio/gappinfo.c" + line="737">a #GAsyncResult @@ -5377,27 +5320,26 @@ g_app_info_launch_default_for_uri_async(). c:identifier="g_app_info_remove_supports_type" throws="1"> Removes a supported type from an application, if possible. - + filename="gio/gappinfo.c" + line="467">Removes a supported type from an application, if possible. + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="475">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="469">a #GAppInfo. a string. + filename="gio/gappinfo.c" + line="470">a string. @@ -5406,27 +5348,26 @@ g_app_info_launch_default_for_uri_async(). c:identifier="g_app_info_set_as_default_for_extension" throws="1"> Sets the application as the default handler for the given file extension. - + filename="gio/gappinfo.c" + line="376">Sets the application as the default handler for the given file extension. + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="385">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="378">a #GAppInfo. a string containing the file extension + filename="gio/gappinfo.c" + line="379">a string containing the file extension (without the dot). @@ -5436,27 +5377,26 @@ g_app_info_launch_default_for_uri_async(). c:identifier="g_app_info_set_as_default_for_type" throws="1"> Sets the application as the default handler for a given type. - + filename="gio/gappinfo.c" + line="313">Sets the application as the default handler for a given type. + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="321">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="315">a #GAppInfo. the content type. + filename="gio/gappinfo.c" + line="316">the content type. @@ -5465,94 +5405,90 @@ g_app_info_launch_default_for_uri_async(). c:identifier="g_app_info_set_as_last_used_for_type" throws="1"> Sets the application as the last used application for a given type. + filename="gio/gappinfo.c" + line="343">Sets the application as the last used application for a given type. This will make the application appear as first in the list returned by g_app_info_get_recommended_for_type(), regardless of the default application for that content type. - + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="354">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="345">a #GAppInfo. the content type. + filename="gio/gappinfo.c" + line="346">the content type. Checks if the application info should be shown in menus that + filename="gio/gappinfo.c" + line="766">Checks if the application info should be shown in menus that list available applications. - + %TRUE if the @appinfo should be shown, %FALSE otherwise. + filename="gio/gappinfo.c" + line="773">%TRUE if the @appinfo should be shown, %FALSE otherwise. a #GAppInfo. + filename="gio/gappinfo.c" + line="768">a #GAppInfo. Checks if the application accepts files as arguments. - + filename="gio/gappinfo.c" + line="627">Checks if the application accepts files as arguments. + %TRUE if the @appinfo supports files. + filename="gio/gappinfo.c" + line="633">%TRUE if the @appinfo supports files. a #GAppInfo. + filename="gio/gappinfo.c" + line="629">a #GAppInfo. Checks if the application supports reading files and directories from URIs. - + filename="gio/gappinfo.c" + line="606">Checks if the application supports reading files and directories from URIs. + %TRUE if the @appinfo supports URIs. + filename="gio/gappinfo.c" + line="612">%TRUE if the @appinfo supports URIs. a #GAppInfo. + filename="gio/gappinfo.c" + line="608">a #GAppInfo. @@ -5563,7 +5499,7 @@ list available applications. glib:get-type="g_app_info_create_flags_get_type" c:type="GAppInfoCreateFlags"> Flags used when creating a #GAppInfo. glib:nick="none" glib:name="G_APP_INFO_CREATE_NONE"> No flags. glib:nick="needs-terminal" glib:name="G_APP_INFO_CREATE_NEEDS_TERMINAL"> Application opens in a terminal window. glib:nick="supports-uris" glib:name="G_APP_INFO_CREATE_SUPPORTS_URIS"> Application supports URI arguments. glib:nick="supports-startup-notification" glib:name="G_APP_INFO_CREATE_SUPPORTS_STARTUP_NOTIFICATION"> Application supports startup notification. Since 2.26 @@ -5606,180 +5542,195 @@ list available applications. c:type="GAppInfoIface" glib:is-gtype-struct-for="AppInfo"> Application Information interface, for operating system portability. - + filename="gio/gappinfo.h" + line="49">Application Information interface, for operating system portability. + The parent interface. + filename="gio/gappinfo.h" + line="51">The parent interface. + Copies a #GAppInfo. - + a duplicate of @appinfo. + filename="gio/gappinfo.c" + line="122">a duplicate of @appinfo. a #GAppInfo. + filename="gio/gappinfo.c" + line="118">a #GAppInfo. + Checks two #GAppInfos for equality. - + %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. + filename="gio/gappinfo.c" + line="147">%TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise. the first #GAppInfo. + filename="gio/gappinfo.c" + line="138">the first #GAppInfo. the second #GAppInfo. + filename="gio/gappinfo.c" + line="139">the second #GAppInfo. + Gets a string identifier for a #GAppInfo. - + a string containing the application's ID. + filename="gio/gappinfo.c" + line="178">a string containing the application's ID. a #GAppInfo. + filename="gio/gappinfo.c" + line="168">a #GAppInfo. + Gets the name of the application for a #GAppInfo. - + the name of the application for @appinfo. + filename="gio/gappinfo.c" + line="198">the name of the application for @appinfo. a #GAppInfo. + filename="gio/gappinfo.c" + line="194">a #GAppInfo. + Gets a short description for the application described by the #GAppInfo. - + a string containing a description of the + filename="gio/gappinfo.c" + line="245">a string containing a description of the application @appinfo, or %NULL if none. a #GAppInfo. + filename="gio/gappinfo.c" + line="241">a #GAppInfo. + Gets the executable name for the #GAppInfo. - + a string containing the @appinfo's application + filename="gio/gappinfo.c" + line="270">a string containing the @appinfo's application binaries name a #GAppInfo + filename="gio/gappinfo.c" + line="262">a #GAppInfo + Gets the #GIcon for the #GAppInfo. - + the default #GIcon for @appinfo or %NULL + filename="gio/gappinfo.c" + line="537">the default #GIcon for @appinfo or %NULL if there is no default icon. a #GAppInfo. + filename="gio/gappinfo.c" + line="533">a #GAppInfo. + Launches an application specified by the #GAppInfo. - + %TRUE on successful launch, %FALSE otherwise. + filename="gio/gappinfo.c" + line="588">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + filename="gio/gappinfo.c" + line="555">a #GAppInfo nullable="1" allow-none="1"> a #GList of #GFile objects + filename="gio/gappinfo.c" + line="556">a #GList of #GFile objects @@ -5798,68 +5749,74 @@ if there is no default icon. nullable="1" allow-none="1"> a #GAppLaunchContext or %NULL + filename="gio/gappinfo.c" + line="557">a #GAppLaunchContext or %NULL + Indicates whether the application specified supports launching URIs. - + %TRUE if the @appinfo supports URIs. + filename="gio/gappinfo.c" + line="612">%TRUE if the @appinfo supports URIs. a #GAppInfo. + filename="gio/gappinfo.c" + line="608">a #GAppInfo. + Indicates whether the application specified accepts filename arguments. - + %TRUE if the @appinfo supports files. + filename="gio/gappinfo.c" + line="633">%TRUE if the @appinfo supports files. a #GAppInfo. + filename="gio/gappinfo.c" + line="629">a #GAppInfo. + Launches an application with a list of URIs. - + %TRUE on successful launch, %FALSE otherwise. + filename="gio/gappinfo.c" + line="668">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + filename="gio/gappinfo.c" + line="650">a #GAppInfo nullable="1" allow-none="1"> a #GList containing URIs to launch. + filename="gio/gappinfo.c" + line="651">a #GList containing URIs to launch. @@ -5878,80 +5835,87 @@ if there is no default icon. nullable="1" allow-none="1"> a #GAppLaunchContext or %NULL + filename="gio/gappinfo.c" + line="652">a #GAppLaunchContext or %NULL + Returns whether an application should be shown (e.g. when getting a list of installed applications). +[FreeDesktop.Org Startup Notification Specification](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt). - + %TRUE if the @appinfo should be shown, %FALSE otherwise. + filename="gio/gappinfo.c" + line="773">%TRUE if the @appinfo should be shown, %FALSE otherwise. a #GAppInfo. + filename="gio/gappinfo.c" + line="768">a #GAppInfo. + Sets an application as default for a given content type. - + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="321">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="315">a #GAppInfo. the content type. + filename="gio/gappinfo.c" + line="316">the content type. + Sets an application as default for a given file extension. - + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="385">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="378">a #GAppInfo. a string containing the file extension + filename="gio/gappinfo.c" + line="379">a string containing the file extension (without the dot). @@ -5959,194 +5923,212 @@ if there is no default icon. + Adds to the #GAppInfo information about supported file types. - + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="417">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="410">a #GAppInfo. a string. + filename="gio/gappinfo.c" + line="411">a string. + Checks for support for removing supported file types from a #GAppInfo. - + %TRUE if it is possible to remove supported + filename="gio/gappinfo.c" + line="448">%TRUE if it is possible to remove supported content types from a given @appinfo, %FALSE if not. a #GAppInfo. + filename="gio/gappinfo.c" + line="444">a #GAppInfo. + Removes a supported application type from a #GAppInfo. - + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="475">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="469">a #GAppInfo. a string. + filename="gio/gappinfo.c" + line="470">a string. + Checks if a #GAppInfo can be deleted. Since 2.20 - + %TRUE if @appinfo can be deleted + filename="gio/gappinfo.c" + line="1286">%TRUE if @appinfo can be deleted a #GAppInfo + filename="gio/gappinfo.c" + line="1281">a #GAppInfo + Deletes a #GAppInfo. Since 2.20 - + %TRUE if @appinfo has been deleted + filename="gio/gappinfo.c" + line="1316">%TRUE if @appinfo has been deleted a #GAppInfo + filename="gio/gappinfo.c" + line="1308">a #GAppInfo + Gets the commandline for the #GAppInfo. Since 2.20 - + a string containing the @appinfo's commandline, + filename="gio/gappinfo.c" + line="293">a string containing the @appinfo's commandline, or %NULL if this information is not available a #GAppInfo + filename="gio/gappinfo.c" + line="288">a #GAppInfo + Gets the display name for the #GAppInfo. Since 2.24 - + the display name of the application for @appinfo, or the name if + filename="gio/gappinfo.c" + line="219">the display name of the application for @appinfo, or the name if no display name is available. a #GAppInfo. + filename="gio/gappinfo.c" + line="214">a #GAppInfo. + Sets the application as the last used. See g_app_info_set_as_last_used_for_type(). - + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="354">%TRUE on success, %FALSE on error. a #GAppInfo. + filename="gio/gappinfo.c" + line="345">a #GAppInfo. the content type. + filename="gio/gappinfo.c" + line="346">the content type. + Retrieves the list of content types that @app_info claims to support. - + + filename="gio/gappinfo.c" + line="510"> a list of content types. @@ -6155,25 +6137,27 @@ no display name is available. a #GAppInfo that can handle files + filename="gio/gappinfo.c" + line="501">a #GAppInfo that can handle files + Asynchronously launches an application with a list of URIs. (Since: 2.60) - + a #GAppInfo + filename="gio/gappinfo.c" + line="687">a #GAppInfo nullable="1" allow-none="1"> a #GList containing URIs to launch. + filename="gio/gappinfo.c" + line="688">a #GList containing URIs to launch. @@ -6192,8 +6176,8 @@ no display name is available. nullable="1" allow-none="1"> a #GAppLaunchContext or %NULL + filename="gio/gappinfo.c" + line="689">a #GAppLaunchContext or %NULL nullable="1" allow-none="1"> a #GCancellable + filename="gio/gappinfo.c" + line="690">a #GCancellable scope="async" closure="5"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gappinfo.c" + line="691">a #GAsyncReadyCallback to call when the request is done allow-none="1" closure="5"> data to pass to @callback + filename="gio/gappinfo.c" + line="692">data to pass to @callback + Finishes an operation started with @launch_uris_async. (Since: 2.60) - + %TRUE on successful launch, %FALSE otherwise. + filename="gio/gappinfo.c" + line="742">%TRUE on successful launch, %FALSE otherwise. a #GAppInfo + filename="gio/gappinfo.c" + line="736">a #GAppInfo a #GAsyncResult + filename="gio/gappinfo.c" + line="737">a #GAsyncResult @@ -6264,45 +6250,52 @@ no display name is available. glib:type-name="GAppInfoMonitor" glib:get-type="g_app_info_monitor_get_type"> #GAppInfoMonitor is a very simple object used for monitoring the app + filename="gio/gappinfo.c" + line="1655">`GAppInfoMonitor` monitors application information for changes. + +`GAppInfoMonitor` is a very simple object used for monitoring the app info database for changes (newly installed or removed applications). -Call g_app_info_monitor_get() to get a #GAppInfoMonitor and connect -to the #GAppInfoMonitor::changed signal. The signal will be emitted once when +Call [func@Gio.AppInfoMonitor.get] to get a `GAppInfoMonitor` and connect +to the [signal@Gio.AppInfoMonitor::changed] signal. The signal will be emitted once when the app info database changes, and will not be emitted again until after the -next call to g_app_info_get_all() or another `g_app_info_*()` function. This -is because monitoring the app info database for changes is expensive. - -The following functions will re-arm the #GAppInfoMonitor::changed signal so -it can be emitted again: - - g_app_info_get_all() - - g_app_info_get_all_for_type() - - g_app_info_get_default_for_type() - - g_app_info_get_fallback_for_type() - - g_app_info_get_recommended_for_type() - - g_desktop_app_info_get_implementations() - - g_desktop_app_info_new() - - g_desktop_app_info_new_from_filename() - - g_desktop_app_info_new_from_keyfile() - - g_desktop_app_info_search() +next call to [func@Gio.AppInfo.get_all] or another `g_app_info_*()` function. +This is because monitoring the app info database for changes is expensive. + +The following functions will re-arm the [signal@Gio.AppInfoMonitor::changed] +signal so it can be emitted again: + + - [func@Gio.AppInfo.get_all] + - [func@Gio.AppInfo.get_all_for_type] + - [func@Gio.AppInfo.get_default_for_type] + - [func@Gio.AppInfo.get_fallback_for_type] + - [func@Gio.AppInfo.get_recommended_for_type] + - [`g_desktop_app_info_get_implementations()`](../gio-unix/type_func.DesktopAppInfo.get_implementation.html) + - [`g_desktop_app_info_new()`](../gio-unix/ctor.DesktopAppInfo.new.html) + - [`g_desktop_app_info_new_from_filename()`](../gio-unix/ctor.DesktopAppInfo.new_from_filename.html) + - [`g_desktop_app_info_new_from_keyfile()`](../gio-unix/ctor.DesktopAppInfo.new_from_keyfile.html) + - [`g_desktop_app_info_search()`](../gio-unix/type_func.DesktopAppInfo.search.html) + +The latter functions are available if using +[`GDesktopAppInfo`](../gio-unix/class.DesktopAppInfo.html) from +`gio-unix-2.0.pc` (GIR namespace `GioUnix-2.0`). In the usual case, applications should try to make note of the change -(doing things like invalidating caches) but not act on it. In -particular, applications should avoid making calls to #GAppInfo APIs +(doing things like invalidating caches) but not act on it. In +particular, applications should avoid making calls to `GAppInfo` APIs in response to the change signal, deferring these until the time that -the updated data is actually required. The exception to this case is when +the updated data is actually required. The exception to this case is when application information is actually being displayed on the screen (for example, during a search or when the list of all applications is shown). -The reason for this is that changes to the list of installed -applications often come in groups (like during system updates) and -rescanning the list on every change is pointless and expensive. +The reason for this is that changes to the list of installed applications +often come in groups (like during system updates) and rescanning the list +on every change is pointless and expensive. Gets the #GAppInfoMonitor for the current thread-default main + filename="gio/gappinfo.c" + line="1753">Gets the #GAppInfoMonitor for the current thread-default main context. The #GAppInfoMonitor will emit a "changed" signal in the @@ -6315,19 +6308,18 @@ so will re-arm the signal ready to notify about the next change. You must only call g_object_unref() on the return value from under the same main context as you created it. - + a reference to a #GAppInfoMonitor + filename="gio/gappinfo.c" + line="1770">a reference to a #GAppInfoMonitor Signal emitted when the app info database changes, when applications are + filename="gio/gappinfo.c" + line="1739">Signal emitted when the app info database changes, when applications are installed or removed. @@ -6342,57 +6334,54 @@ installed or removed. glib:get-type="g_app_launch_context_get_type" glib:type-struct="AppLaunchContextClass"> Integrating the launch with the launching application. This is used to + filename="gio/gappinfo.h" + line="279">Integrating the launch with the launching application. This is used to handle for instance startup notification and launching the new application on the same screen as the launching window. - + Creates a new application launch context. This is not normally used, + filename="gio/gappinfo.c" + line="1347">Creates a new application launch context. This is not normally used, instead you instantiate a subclass of this, such as #GdkAppLaunchContext. - + a #GAppLaunchContext. + filename="gio/gappinfo.c" + line="1353">a #GAppLaunchContext. Gets the display string for the @context. This is used to ensure new + filename="gio/gappinfo.c" + line="1563">Gets the display string for the @context. This is used to ensure new applications are started on the same display as the launching application, by setting the `DISPLAY` environment variable. - + a display string for the display. + filename="gio/gappinfo.c" + line="1573">a display string for the display. a #GAppLaunchContext + filename="gio/gappinfo.c" + line="1565">a #GAppLaunchContext a #GAppInfo + filename="gio/gappinfo.c" + line="1566">a #GAppInfo a #GList of #GFile objects + filename="gio/gappinfo.c" + line="1567">a #GList of #GFile objects @@ -6402,8 +6391,8 @@ application, by setting the `DISPLAY` environment variable. Initiates startup notification for the application and returns the + filename="gio/gappinfo.c" + line="1593">Initiates startup notification for the application and returns the `XDG_ACTIVATION_TOKEN` or `DESKTOP_STARTUP_ID` for the launched operation, if supported. @@ -6416,32 +6405,31 @@ and startup notification IDs are defined in the [freedesktop.org Startup Notification Protocol](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt). Support for the XDG Activation Protocol was added in GLib 2.76. - + a startup notification ID for the application, or %NULL if + filename="gio/gappinfo.c" + line="1613">a startup notification ID for the application, or %NULL if not supported. a #GAppLaunchContext + filename="gio/gappinfo.c" + line="1595">a #GAppLaunchContext a #GAppInfo + filename="gio/gappinfo.c" + line="1596">a #GAppInfo a #GList of of #GFile objects + filename="gio/gappinfo.c" + line="1597">a #GList of #GFile objects @@ -6450,32 +6438,30 @@ Support for the XDG Activation Protocol was added in GLib 2.76. Called when an application has failed to launch, so that it can cancel + filename="gio/gappinfo.c" + line="1635">Called when an application has failed to launch, so that it can cancel the application startup notification started in g_app_launch_context_get_startup_notify_id(). - + a #GAppLaunchContext. + filename="gio/gappinfo.c" + line="1637">a #GAppLaunchContext. the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). + filename="gio/gappinfo.c" + line="1638">the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). - + @@ -6492,8 +6478,7 @@ the application startup notification started in g_app_launch_context_get_startup - + @@ -6512,35 +6497,34 @@ the application startup notification started in g_app_launch_context_get_startup Gets the display string for the @context. This is used to ensure new + filename="gio/gappinfo.c" + line="1563">Gets the display string for the @context. This is used to ensure new applications are started on the same display as the launching application, by setting the `DISPLAY` environment variable. - + a display string for the display. + filename="gio/gappinfo.c" + line="1573">a display string for the display. a #GAppLaunchContext + filename="gio/gappinfo.c" + line="1565">a #GAppLaunchContext a #GAppInfo + filename="gio/gappinfo.c" + line="1566">a #GAppInfo a #GList of #GFile objects + filename="gio/gappinfo.c" + line="1567">a #GList of #GFile objects @@ -6551,17 +6535,16 @@ application, by setting the `DISPLAY` environment variable. c:identifier="g_app_launch_context_get_environment" version="2.32"> Gets the complete environment variable list to be passed to + filename="gio/gappinfo.c" + line="1538">Gets the complete environment variable list to be passed to the child process when @context is used to launch an application. This is a %NULL-terminated array of strings, where each string has the form `KEY=VALUE`. - + + filename="gio/gappinfo.c" + line="1547"> the child's environment @@ -6570,8 +6553,8 @@ the form `KEY=VALUE`. a #GAppLaunchContext + filename="gio/gappinfo.c" + line="1540">a #GAppLaunchContext @@ -6579,8 +6562,8 @@ the form `KEY=VALUE`. Initiates startup notification for the application and returns the + filename="gio/gappinfo.c" + line="1593">Initiates startup notification for the application and returns the `XDG_ACTIVATION_TOKEN` or `DESKTOP_STARTUP_ID` for the launched operation, if supported. @@ -6593,32 +6576,31 @@ and startup notification IDs are defined in the [freedesktop.org Startup Notification Protocol](http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt). Support for the XDG Activation Protocol was added in GLib 2.76. - + a startup notification ID for the application, or %NULL if + filename="gio/gappinfo.c" + line="1613">a startup notification ID for the application, or %NULL if not supported. a #GAppLaunchContext + filename="gio/gappinfo.c" + line="1595">a #GAppLaunchContext a #GAppInfo + filename="gio/gappinfo.c" + line="1596">a #GAppInfo a #GList of of #GFile objects + filename="gio/gappinfo.c" + line="1597">a #GList of #GFile objects @@ -6628,25 +6610,24 @@ Support for the XDG Activation Protocol was added in GLib 2.76. Called when an application has failed to launch, so that it can cancel + filename="gio/gappinfo.c" + line="1635">Called when an application has failed to launch, so that it can cancel the application startup notification started in g_app_launch_context_get_startup_notify_id(). - + a #GAppLaunchContext. + filename="gio/gappinfo.c" + line="1637">a #GAppLaunchContext. the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). + filename="gio/gappinfo.c" + line="1638">the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). @@ -6655,31 +6636,30 @@ the application startup notification started in g_app_launch_context_get_startup c:identifier="g_app_launch_context_setenv" version="2.32"> Arranges for @variable to be set to @value in the child's + filename="gio/gappinfo.c" + line="1487">Arranges for @variable to be set to @value in the child's environment when @context is used to launch an application. - + a #GAppLaunchContext + filename="gio/gappinfo.c" + line="1489">a #GAppLaunchContext the environment variable to set + filename="gio/gappinfo.c" + line="1490">the environment variable to set the value for to set the variable to. + filename="gio/gappinfo.c" + line="1491">the value for to set the variable to. @@ -6688,25 +6668,24 @@ environment when @context is used to launch an application. c:identifier="g_app_launch_context_unsetenv" version="2.32"> Arranges for @variable to be unset in the child's environment + filename="gio/gappinfo.c" + line="1514">Arranges for @variable to be unset in the child's environment when @context is used to launch an application. - + a #GAppLaunchContext + filename="gio/gappinfo.c" + line="1516">a #GAppLaunchContext the environment variable to remove + filename="gio/gappinfo.c" + line="1517">the environment variable to remove @@ -6720,8 +6699,8 @@ when @context is used to launch an application. The #GAppLaunchContext::launch-failed signal is emitted when a #GAppInfo launch + filename="gio/gappinfo.c" + line="1378">The #GAppLaunchContext::launch-failed signal is emitted when a #GAppInfo launch fails. The startup notification id is provided, so that the launcher can cancel the startup notification. @@ -6734,16 +6713,16 @@ times, one for each spawned instance. the startup notification id for the failed launch + filename="gio/gappinfo.c" + line="1381">the startup notification id for the failed launch The #GAppLaunchContext::launch-started signal is emitted when a #GAppInfo is + filename="gio/gappinfo.c" + line="1400">The #GAppLaunchContext::launch-started signal is emitted when a #GAppInfo is about to be launched. If non-null the @platform_data is an GVariant dictionary mapping strings to variants (ie `a{sv}`), which contains additional, platform-specific data about this launch. On @@ -6767,8 +6746,8 @@ times, one for each spawned instance. the #GAppInfo that is about to be launched + filename="gio/gappinfo.c" + line="1403">the #GAppInfo that is about to be launched nullable="1" allow-none="1"> additional platform-specific data for this launch + filename="gio/gappinfo.c" + line="1404">additional platform-specific data for this launch The #GAppLaunchContext::launched signal is emitted when a #GAppInfo is successfully + filename="gio/gappinfo.c" + line="1439">The #GAppLaunchContext::launched signal is emitted when a #GAppInfo is successfully launched. Because a launch operation may involve spawning multiple instances of the @@ -6811,14 +6790,14 @@ signal has been emitted, then you can duplicate `pid` using `DuplicateHandle()`. the #GAppInfo that was just launched + filename="gio/gappinfo.c" + line="1442">the #GAppInfo that was just launched additional platform-specific data for this launch + filename="gio/gappinfo.c" + line="1443">additional platform-specific data for this launch @@ -6827,38 +6806,36 @@ signal has been emitted, then you can duplicate `pid` using `DuplicateHandle()`. - + - + a display string for the display. + filename="gio/gappinfo.c" + line="1573">a display string for the display. a #GAppLaunchContext + filename="gio/gappinfo.c" + line="1565">a #GAppLaunchContext a #GAppInfo + filename="gio/gappinfo.c" + line="1566">a #GAppInfo a #GList of #GFile objects + filename="gio/gappinfo.c" + line="1567">a #GList of #GFile objects @@ -6868,32 +6845,31 @@ signal has been emitted, then you can duplicate `pid` using `DuplicateHandle()`. - + a startup notification ID for the application, or %NULL if + filename="gio/gappinfo.c" + line="1613">a startup notification ID for the application, or %NULL if not supported. a #GAppLaunchContext + filename="gio/gappinfo.c" + line="1595">a #GAppLaunchContext a #GAppInfo + filename="gio/gappinfo.c" + line="1596">a #GAppInfo a #GList of of #GFile objects + filename="gio/gappinfo.c" + line="1597">a #GList of #GFile objects @@ -6903,22 +6879,21 @@ signal has been emitted, then you can duplicate `pid` using `DuplicateHandle()`. - + a #GAppLaunchContext. + filename="gio/gappinfo.c" + line="1637">a #GAppLaunchContext. the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). + filename="gio/gappinfo.c" + line="1638">the startup notification id that was returned by g_app_launch_context_get_startup_notify_id(). @@ -6926,8 +6901,7 @@ signal has been emitted, then you can duplicate `pid` using `DuplicateHandle()`. - + @@ -6946,8 +6920,7 @@ signal has been emitted, then you can duplicate `pid` using `DuplicateHandle()`. - + @@ -6966,8 +6939,7 @@ signal has been emitted, then you can duplicate `pid` using `DuplicateHandle()`. - + @@ -6975,8 +6947,7 @@ signal has been emitted, then you can duplicate `pid` using `DuplicateHandle()`. - + @@ -6984,8 +6955,7 @@ signal has been emitted, then you can duplicate `pid` using `DuplicateHandle()`. - + @@ -6996,8 +6966,7 @@ signal has been emitted, then you can duplicate `pid` using `DuplicateHandle()`. c:type="GAppLaunchContextPrivate" disguised="1" opaque="1"> - + A #GApplication is the foundation of an application. It wraps some + filename="gio/gapplication.c" + line="48">`GApplication` is the core class for application support. + +A `GApplication` is the foundation of an application. It wraps some low-level platform-specific services and is intended to act as the foundation for higher-level application classes such as -#GtkApplication or #MxApplication. In general, you should not use +`GtkApplication` or `MxApplication`. In general, you should not use this class outside of a higher level framework. -GApplication provides convenient life cycle management by maintaining +`GApplication` provides convenient life-cycle management by maintaining a "use count" for the primary application instance. The use count can -be changed using g_application_hold() and g_application_release(). If -it drops to zero, the application exits. Higher-level classes such as -#GtkApplication employ the use count to ensure that the application -stays alive as long as it has any opened windows. +be changed using [method@Gio.Application.hold] and +[method@Gio.Application.release]. If it drops to zero, the application +exits. Higher-level classes such as `GtkApplication` employ the use count +to ensure that the application stays alive as long as it has any opened +windows. -Another feature that GApplication (optionally) provides is process +Another feature that `GApplication` (optionally) provides is process uniqueness. Applications can make use of this functionality by providing a unique application ID. If given, only one application with this ID can be running at a time per session. The session @@ -7034,53 +7006,54 @@ called the "primary instance"; for non-unique applications this is always the current instance. On Linux, the D-Bus session bus is used for communication. -The use of #GApplication differs from some other commonly-used +The use of `GApplication` differs from some other commonly-used uniqueness libraries (such as libunique) in important ways. The application is not expected to manually register itself and check if it is the primary instance. Instead, the main() function of a -#GApplication should do very little more than instantiating the +`GApplication` should do very little more than instantiating the application instance, possibly connecting signal handlers, then -calling g_application_run(). All checks for uniqueness are done +calling [method@Gio.Application.run]. All checks for uniqueness are done internally. If the application is the primary instance then the startup signal is emitted and the mainloop runs. If the application is not the primary instance then a signal is sent to the primary -instance and g_application_run() promptly returns. See the code +instance and [method@Gio.Application.run] promptly returns. See the code examples below. -If used, the expected form of an application identifier is the same as -that of of a +If used, the expected form of an application identifier is the +same as that of a [D-Bus well-known bus name](https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus). Examples include: `com.example.MyApp`, `org.example.internal_apps.Calculator`, `org._7_zip.Archiver`. -For details on valid application identifiers, see g_application_id_is_valid(). +For details on valid application identifiers, see [func@Gio.Application.id_is_valid]. On Linux, the application identifier is claimed as a well-known bus name -on the user's session bus. This means that the uniqueness of your -application is scoped to the current session. It also means that your +on the user's session bus. This means that the uniqueness of your +application is scoped to the current session. It also means that your application may provide additional services (through registration of other -object paths) at that bus name. The registration of these object paths -should be done with the shared GDBus session bus. Note that due to the +object paths) at that bus name. The registration of these object paths +should be done with the shared GDBus session bus. Note that due to the internal architecture of GDBus, method calls can be dispatched at any time -(even if a main loop is not running). For this reason, you must ensure that +(even if a main loop is not running). For this reason, you must ensure that any object paths that you wish to register are registered before #GApplication attempts to acquire the bus name of your application (which happens in -g_application_register()). Unfortunately, this means that you cannot use -g_application_get_is_remote() to decide if you want to register object paths. +[method@Gio.Application.register]). Unfortunately, this means that you cannot +use [property@Gio.Application:is-remote] to decide if you want to register +object paths. -GApplication also implements the #GActionGroup and #GActionMap +`GApplication` also implements the [iface@Gio.ActionGroup] and [iface@Gio.ActionMap] interfaces and lets you easily export actions by adding them with -g_action_map_add_action(). When invoking an action by calling -g_action_group_activate_action() on the application, it is always +[method@Gio.ActionMap.add_action]. When invoking an action by calling +[method@Gio.ActionGroup.activate_action] on the application, it is always invoked in the primary instance. The actions are also exported on -the session bus, and GIO provides the #GDBusActionGroup wrapper to -conveniently access them remotely. GIO provides a #GDBusMenuModel wrapper -for remote access to exported #GMenuModels. +the session bus, and GIO provides the [class@Gio.DBusActionGroup] wrapper to +conveniently access them remotely. GIO provides a [class@Gio.DBusMenuModel] wrapper +for remote access to exported [class@Gio.MenuModel]s. Note: Due to the fact that actions are exported on the session bus, using `maybe` parameters is not supported, since D-Bus does not support `maybe` types. -There is a number of different entry points into a GApplication: +There is a number of different entry points into a `GApplication`: - via 'Activate' (i.e. just starting the application) @@ -7090,63 +7063,62 @@ There is a number of different entry points into a GApplication: - via activating an action -The #GApplication::startup signal lets you handle the application +The [signal@Gio.Application::startup] signal lets you handle the application initialization for all of these in a single place. Regardless of which of these entry points is used to start the -application, GApplication passes some ‘platform data’ from the +application, `GApplication` passes some ‘platform data’ from the launching instance to the primary instance, in the form of a -#GVariant dictionary mapping strings to variants. To use platform -data, override the @before_emit or @after_emit virtual functions -in your #GApplication subclass. When dealing with -#GApplicationCommandLine objects, the platform data is -directly available via g_application_command_line_get_cwd(), -g_application_command_line_get_environ() and -g_application_command_line_get_platform_data(). +[struct@GLib.Variant] dictionary mapping strings to variants. To use platform +data, override the [vfunc@Gio.Application.before_emit] or +[vfunc@Gio.Application.after_emit] virtual functions +in your `GApplication` subclass. When dealing with +[class@Gio.ApplicationCommandLine] objects, the platform data is +directly available via [method@Gio.ApplicationCommandLine.get_cwd], +[method@Gio.ApplicationCommandLine.get_environ] and +[method@Gio.ApplicationCommandLine.get_platform_data]. As the name indicates, the platform data may vary depending on the operating system, but it always includes the current directory (key -"cwd"), and optionally the environment (ie the set of environment -variables and their values) of the calling process (key "environ"). +`cwd`), and optionally the environment (ie the set of environment +variables and their values) of the calling process (key `environ`). The environment is only added to the platform data if the -%G_APPLICATION_SEND_ENVIRONMENT flag is set. #GApplication subclasses -can add their own platform data by overriding the @add_platform_data -virtual function. For instance, #GtkApplication adds startup notification -data in this way. +`G_APPLICATION_SEND_ENVIRONMENT` flag is set. `GApplication` subclasses +can add their own platform data by overriding the +[vfunc@Gio.Application.add_platform_data] virtual function. For instance, +`GtkApplication` adds startup notification data in this way. To parse commandline arguments you may handle the -#GApplication::command-line signal or override the local_command_line() -vfunc, to parse them in either the primary instance or the local instance, -respectively. +[signal@Gio.Application::command-line] signal or override the +[vfunc@Gio.Application.local_command_line] virtual funcion, to parse them in +either the primary instance or the local instance, respectively. -For an example of opening files with a GApplication, see +For an example of opening files with a `GApplication`, see [gapplication-example-open.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-open.c). -For an example of using actions with GApplication, see +For an example of using actions with `GApplication`, see [gapplication-example-actions.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-actions.c). -For an example of using extra D-Bus hooks with GApplication, see +For an example of using extra D-Bus hooks with `GApplication`, see [gapplication-example-dbushooks.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-dbushooks.c). - + Creates a new #GApplication instance. + filename="gio/gapplication.c" + line="1866">Creates a new #GApplication instance. If non-%NULL, the application id must be valid. See g_application_id_is_valid(). If no application ID is given then some features of #GApplication (most notably application uniqueness) will be disabled. - + a new #GApplication instance + filename="gio/gapplication.c" + line="1879">a new #GApplication instance @@ -7155,14 +7127,14 @@ If no application ID is given then some features of #GApplication nullable="1" allow-none="1"> the application id + filename="gio/gapplication.c" + line="1868">the application id the application flags + filename="gio/gapplication.c" + line="1869">the application flags @@ -7171,27 +7143,26 @@ If no application ID is given then some features of #GApplication c:identifier="g_application_get_default" version="2.32"> Returns the default #GApplication instance for this process. + filename="gio/gapplication.c" + line="2895">Returns the default #GApplication instance for this process. Normally there is only one #GApplication per process and it becomes the default when it is created. You can exercise more control over this by using g_application_set_default(). If there is no default application then %NULL is returned. - + the default application for this process, or %NULL + filename="gio/gapplication.c" + line="2906">the default application for this process, or %NULL Checks if @application_id is a valid application identifier. + filename="gio/gapplication.c" + line="1806">Checks if @application_id is a valid application identifier. A valid ID is required for calls to g_application_new() and g_application_set_application_id(). @@ -7236,49 +7207,50 @@ hyphen/minus characters they should be replaced by underscores, and if it contains leading digits they should be escaped by prepending an underscore. For example, if the owner of 7-zip.org used an application identifier for an archiving application, it might be named `org._7_zip.Archiver`. - + %TRUE if @application_id is valid + filename="gio/gapplication.c" + line="1856">%TRUE if @application_id is valid a potential application identifier + filename="gio/gapplication.c" + line="1808">a potential application identifier Activates the application. + filename="gio/gapplication.c" + line="2427">Activates the application. In essence, this results in the #GApplication::activate signal being emitted in the primary instance. The application must be registered before calling this function. - + a #GApplication + filename="gio/gapplication.c" + line="2429">a #GApplication - + invoked (locally) to add 'platform data' to be sent to + the primary instance when activating, opening or invoking actions + @@ -7292,8 +7264,12 @@ The application must be registered before calling this function. - + invoked on the primary instance after 'activate', 'open', + 'command-line' or any action invocation, gets the 'platform data' from + the calling instance + @@ -7307,8 +7283,12 @@ The application must be registered before calling this function. - + invoked on the primary instance before 'activate', 'open', + 'command-line' or any action invocation, gets the 'platform data' from + the calling instance + @@ -7322,8 +7302,11 @@ The application must be registered before calling this function. - + invoked on the primary instance when a command-line is + not handled locally + @@ -7338,8 +7321,16 @@ The application must be registered before calling this function. - + invoked locally during registration, if the application is + using its D-Bus backend. You can use this to export extra objects on the + bus, that need to exist before the application tries to own the bus name. + The function is passed the #GDBusConnection to to session bus, and the + object path that #GApplication will use to export its D-Bus API. + If this function returns %TRUE, registration will proceed; otherwise + registration will abort. Since: 2.34 + @@ -7356,8 +7347,12 @@ The application must be registered before calling this function. - + invoked locally during unregistration, if the application + is using its D-Bus backend. Use this to undo anything done by + the @dbus_register vfunc. Since: 2.34 + @@ -7374,8 +7369,11 @@ The application must be registered before calling this function. - + invoked locally after the parsing of the commandline + options has occurred. Since: 2.40 + @@ -7390,7 +7388,7 @@ The application must be registered before calling this function. This virtual function is always invoked in the local instance. It gets passed a pointer to a %NULL-terminated copy of @argv and is expected to remove arguments that it handled (shifting up remaining @@ -7401,18 +7399,17 @@ variable which can used to set the exit status that is returned from g_application_run(). See g_application_run() for more details on #GApplication startup. - + %TRUE if the commandline has been completely handled a #GApplication @@ -7421,7 +7418,7 @@ See g_application_run() for more details on #GApplication startup. caller-allocates="0" transfer-ownership="full"> array of command line arguments @@ -7432,15 +7429,17 @@ See g_application_run() for more details on #GApplication startup. caller-allocates="0" transfer-ownership="full"> exit status to fill after processing the command line. - + invoked when another instance is taking over the name. Since: 2.60 + @@ -7452,8 +7451,8 @@ See g_application_run() for more details on #GApplication startup. Opens the given files. + filename="gio/gapplication.c" + line="2454">Opens the given files. In essence, this results in the #GApplication::open signal being emitted in the primary instance. @@ -7467,43 +7466,46 @@ for this functionality, you should use "". The application must be registered before calling this function and it must have the %G_APPLICATION_HANDLES_OPEN flag set. - + a #GApplication + filename="gio/gapplication.c" + line="2456">a #GApplication an array of #GFiles to open + filename="gio/gapplication.c" + line="2457">an array of #GFiles to open the length of the @files array + filename="gio/gapplication.c" + line="2458">the length of the @files array a hint (or ""), but never %NULL + filename="gio/gapplication.c" + line="2459">a hint (or ""), but never %NULL - + Used to be invoked on the primary instance when the use + count of the application drops to zero (and after any inactivity + timeout, if requested). Not used anymore since 2.32 + @@ -7514,8 +7516,13 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. - + Used to be invoked on the primary instance from + g_application_run() if the use-count is non-zero. Since 2.32, + GApplication is iterating the main context directly and is not + using @run_mainloop anymore + @@ -7526,8 +7533,11 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. - + invoked only on the registered primary instance immediately + after the main loop terminates + @@ -7538,8 +7548,10 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. - + invoked on the primary instance immediately after registration + @@ -7553,23 +7565,22 @@ and it must have the %G_APPLICATION_HANDLES_OPEN flag set. c:identifier="g_application_activate" version="2.28"> Activates the application. + filename="gio/gapplication.c" + line="2427">Activates the application. In essence, this results in the #GApplication::activate signal being emitted in the primary instance. The application must be registered before calling this function. - + a #GApplication + filename="gio/gapplication.c" + line="2429">a #GApplication @@ -7578,8 +7589,8 @@ The application must be registered before calling this function. c:identifier="g_application_add_main_option" version="2.42"> Add an option to be handled by @application. + filename="gio/gapplication.c" + line="768">Add an option to be handled by @application. Calling this function is the equivalent of calling g_application_add_main_option_entries() with a single #GOptionEntry @@ -7592,46 +7603,45 @@ be sent to the primary instance. See g_application_add_main_option_entries() for more details. See #GOptionEntry for more documentation of the arguments. - + the #GApplication + filename="gio/gapplication.c" + line="770">the #GApplication the long name of an option used to specify it in a commandline + filename="gio/gapplication.c" + line="771">the long name of an option used to specify it in a commandline the short name of an option + filename="gio/gapplication.c" + line="772">the short name of an option flags from #GOptionFlags + filename="gio/gapplication.c" + line="773">flags from #GOptionFlags the type of the option, as a #GOptionArg + filename="gio/gapplication.c" + line="774">the type of the option, as a #GOptionArg the description for the option in `--help` output + filename="gio/gapplication.c" + line="775">the description for the option in `--help` output nullable="1" allow-none="1"> the placeholder to use for the extra argument + filename="gio/gapplication.c" + line="776">the placeholder to use for the extra argument parsed by the option in `--help` output @@ -7650,8 +7660,8 @@ See #GOptionEntry for more documentation of the arguments. c:identifier="g_application_add_main_option_entries" version="2.40"> Adds main option entries to be handled by @application. + filename="gio/gapplication.c" + line="672">Adds main option entries to be handled by @application. This function is comparable to g_option_context_add_main_entries(). @@ -7707,23 +7717,22 @@ the options with g_variant_dict_lookup(): - for %G_OPTION_ARG_FILENAME, use `^&ay` - for %G_OPTION_ARG_STRING_ARRAY, use `^a&s` - for %G_OPTION_ARG_FILENAME_ARRAY, use `^a&ay` - + a #GApplication + filename="gio/gapplication.c" + line="674">a #GApplication a - %NULL-terminated list of #GOptionEntrys + filename="gio/gapplication.c" + line="675">the + main options for the application @@ -7734,8 +7743,8 @@ the options with g_variant_dict_lookup(): c:identifier="g_application_add_option_group" version="2.40"> Adds a #GOptionGroup to the commandline handling of @application. + filename="gio/gapplication.c" + line="826">Adds a #GOptionGroup to the commandline handling of @application. This function is comparable to g_option_context_add_group(). @@ -7760,22 +7769,21 @@ Calling this function will cause the options in the supplied option group to be parsed, but it does not cause you to be "opted in" to the new functionality whereby unrecognised options are rejected even if %G_APPLICATION_HANDLES_COMMAND_LINE was given. - + the #GApplication + filename="gio/gapplication.c" + line="828">the #GApplication a #GOptionGroup + filename="gio/gapplication.c" + line="829">a #GOptionGroup @@ -7784,35 +7792,34 @@ new functionality whereby unrecognised options are rejected even if c:identifier="g_application_bind_busy_property" version="2.44"> Marks @application as busy (see g_application_mark_busy()) while + filename="gio/gapplication.c" + line="3188">Marks @application as busy (see g_application_mark_busy()) while @property on @object is %TRUE. The binding holds a reference to @application while it is active, but not to @object. Instead, the binding is destroyed when @object is finalized. - + a #GApplication + filename="gio/gapplication.c" + line="3190">a #GApplication a #GObject + filename="gio/gapplication.c" + line="3191">a #GObject the name of a boolean property of @object + filename="gio/gapplication.c" + line="3192">the name of a boolean property of @object @@ -7822,21 +7829,20 @@ finalized. glib:get-property="application-id" version="2.28"> Gets the unique identifier for @application. - + filename="gio/gapplication.c" + line="1894">Gets the unique identifier for @application. + the identifier for @application, owned by @application + filename="gio/gapplication.c" + line="1900">the identifier for @application, owned by @application a #GApplication + filename="gio/gapplication.c" + line="1896">a #GApplication @@ -7845,8 +7851,8 @@ finalized. c:identifier="g_application_get_dbus_connection" version="2.34"> Gets the #GDBusConnection being used by the application, or %NULL. + filename="gio/gapplication.c" + line="2217">Gets the #GDBusConnection being used by the application, or %NULL. If #GApplication is using its D-Bus backend then this function will return the #GDBusConnection being used for uniqueness and @@ -7859,19 +7865,18 @@ normally be in use but we were unable to connect to the bus. This function must not be called before the application has been registered. See g_application_get_is_registered(). - + a #GDBusConnection, or %NULL + filename="gio/gapplication.c" + line="2235">a #GDBusConnection, or %NULL a #GApplication + filename="gio/gapplication.c" + line="2219">a #GApplication @@ -7880,8 +7885,8 @@ registered. See g_application_get_is_registered(). c:identifier="g_application_get_dbus_object_path" version="2.34"> Gets the D-Bus object path being used by the application, or %NULL. + filename="gio/gapplication.c" + line="2248">Gets the D-Bus object path being used by the application, or %NULL. If #GApplication is using its D-Bus backend then this function will return the D-Bus object path that #GApplication is using. If the @@ -7895,19 +7900,18 @@ normally be in use but we were unable to connect to the bus. This function must not be called before the application has been registered. See g_application_get_is_registered(). - + the object path, or %NULL + filename="gio/gapplication.c" + line="2267">the object path, or %NULL a #GApplication + filename="gio/gapplication.c" + line="2250">a #GApplication @@ -7917,23 +7921,22 @@ registered. See g_application_get_is_registered(). glib:get-property="flags" version="2.28"> Gets the flags for @application. + filename="gio/gapplication.c" + line="1989">Gets the flags for @application. See #GApplicationFlags. - + the flags for @application + filename="gio/gapplication.c" + line="1997">the flags for @application a #GApplication + filename="gio/gapplication.c" + line="1991">a #GApplication @@ -7943,24 +7946,23 @@ See #GApplicationFlags. glib:get-property="inactivity-timeout" version="2.28"> Gets the current inactivity timeout for the application. + filename="gio/gapplication.c" + line="2117">Gets the current inactivity timeout for the application. This is the amount of time (in milliseconds) after the last call to g_application_release() before the application stops running. - + the timeout, in milliseconds + filename="gio/gapplication.c" + line="2126">the timeout, in milliseconds a #GApplication + filename="gio/gapplication.c" + line="2119">a #GApplication @@ -7970,22 +7972,21 @@ g_application_release() before the application stops running. glib:get-property="is-busy" version="2.44"> Gets the application's current busy state, as set through + filename="gio/gapplication.c" + line="3029">Gets the application's current busy state, as set through g_application_mark_busy() or g_application_bind_busy_property(). - + %TRUE if @application is currently marked as busy + filename="gio/gapplication.c" + line="3036">%TRUE if @application is currently marked as busy a #GApplication + filename="gio/gapplication.c" + line="3031">a #GApplication @@ -7995,24 +7996,23 @@ g_application_mark_busy() or g_application_bind_busy_property(). glib:get-property="is-registered" version="2.28"> Checks if @application is registered. + filename="gio/gapplication.c" + line="2168">Checks if @application is registered. An application is registered if g_application_register() has been successfully called. - + %TRUE if @application is registered + filename="gio/gapplication.c" + line="2177">%TRUE if @application is registered a #GApplication + filename="gio/gapplication.c" + line="2170">a #GApplication @@ -8022,8 +8022,8 @@ successfully called. glib:get-property="is-remote" version="2.28"> Checks if @application is remote. + filename="gio/gapplication.c" + line="2189">Checks if @application is remote. If @application is remote then it means that another instance of application already exists (the 'primary' instance). Calls to @@ -8033,19 +8033,18 @@ performed by the primary instance. The value of this property cannot be accessed before g_application_register() has been called. See g_application_get_is_registered(). - + %TRUE if @application is remote + filename="gio/gapplication.c" + line="2204">%TRUE if @application is remote a #GApplication + filename="gio/gapplication.c" + line="2191">a #GApplication @@ -8055,47 +8054,68 @@ g_application_get_is_registered(). glib:get-property="resource-base-path" version="2.42"> Gets the resource base path of @application. + filename="gio/gapplication.c" + line="2039">Gets the resource base path of @application. See g_application_set_resource_base_path() for more information. - + the base resource path, if one is set + filename="gio/gapplication.c" + line="2047">the base resource path, if one is set a #GApplication + filename="gio/gapplication.c" + line="2041">a #GApplication + + + + + + Gets the version of @application. + + + the version of @application + + + + + a #GApplication Increases the use count of @application. + filename="gio/gapplication.c" + line="2365">Increases the use count of @application. Use this function to indicate that the application has a reason to continue to run. For example, g_application_hold() is called by GTK when a toplevel window is on the screen. To cancel the hold, call g_application_release(). - + a #GApplication + filename="gio/gapplication.c" + line="2367">a #GApplication @@ -8104,8 +8124,8 @@ To cancel the hold, call g_application_release(). c:identifier="g_application_mark_busy" version="2.38"> Increases the busy count of @application. + filename="gio/gapplication.c" + line="2963">Increases the busy count of @application. Use this function to indicate that the application is busy, for instance while a long running operation is pending. @@ -8117,24 +8137,23 @@ spinner). To cancel the busy indication, use g_application_unmark_busy(). The application must be registered before calling this function. - + a #GApplication + filename="gio/gapplication.c" + line="2965">a #GApplication Opens the given files. + filename="gio/gapplication.c" + line="2454">Opens the given files. In essence, this results in the #GApplication::open signal being emitted in the primary instance. @@ -8148,44 +8167,43 @@ for this functionality, you should use "". The application must be registered before calling this function and it must have the %G_APPLICATION_HANDLES_OPEN flag set. - + a #GApplication + filename="gio/gapplication.c" + line="2456">a #GApplication an array of #GFiles to open + filename="gio/gapplication.c" + line="2457">an array of #GFiles to open the length of the @files array + filename="gio/gapplication.c" + line="2458">the length of the @files array a hint (or ""), but never %NULL + filename="gio/gapplication.c" + line="2459">a hint (or ""), but never %NULL Immediately quits the application. + filename="gio/gapplication.c" + line="2935">Immediately quits the application. Upon return to the mainloop, g_application_run() will return, calling only the 'shutdown' function before doing so. @@ -8198,16 +8216,15 @@ through gtk_application_add_window().) The result of calling g_application_run() again after it returns is unspecified. - + a #GApplication + filename="gio/gapplication.c" + line="2937">a #GApplication @@ -8217,8 +8234,8 @@ unspecified. version="2.28" throws="1"> Attempts registration of the application. + filename="gio/gapplication.c" + line="2282">Attempts registration of the application. This is the point at which the application discovers if it is the primary instance or merely acting as a remote for an already-existing @@ -8248,19 +8265,18 @@ is set appropriately. Note: the return value of this function is not an indicator that this instance is or is not the primary instance of the application. See g_application_get_is_remote() for that. - + %TRUE if registration succeeded + filename="gio/gapplication.c" + line="2319">%TRUE if registration succeeded a #GApplication + filename="gio/gapplication.c" + line="2284">a #GApplication nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gapplication.c" + line="2285">a #GCancellable, or %NULL Decrease the use count of @application. + filename="gio/gapplication.c" + line="2402">Decrease the use count of @application. When the use count reaches zero, the application will stop running. Never call this function except to cancel the effect of a previous call to g_application_hold(). - + a #GApplication + filename="gio/gapplication.c" + line="2404">a #GApplication Runs the application. + filename="gio/gapplication.c" + line="2500">Runs the application. This function is intended to be run from main() and its return value is intended to be returned by main(). Although you are expected to pass @@ -8375,25 +8390,24 @@ approach is suitable for use by most graphical applications but should not be used from applications like editors that need precise control over when processes invoked via the commandline will exit and what their exit status will be. - + the exit status + filename="gio/gapplication.c" + line="2583">the exit status a #GApplication + filename="gio/gapplication.c" + line="2502">a #GApplication the argc from main() (or 0 if @argv is %NULL) + filename="gio/gapplication.c" + line="2503">the argc from main() (or 0 if @argv is %NULL) nullable="1" allow-none="1"> + filename="gio/gapplication.c" + line="2504"> the argv from main(), or %NULL @@ -8414,8 +8428,8 @@ what their exit status will be. c:identifier="g_application_send_notification" version="2.40"> Sends a notification on behalf of @application to the desktop shell. + filename="gio/gapplication.c" + line="3050">Sends a notification on behalf of @application to the desktop shell. There is no guarantee that the notification is displayed immediately, or even at all. @@ -8440,17 +8454,19 @@ execution of the application, as long as @id is the same string. notifications without an id. If @notification is no longer relevant, it can be withdrawn with -g_application_withdraw_notification(). - +g_application_withdraw_notification(). + +It is an error to call this function if @application has no +application ID. + a #GApplication + filename="gio/gapplication.c" + line="3052">a #GApplication nullable="1" allow-none="1"> id of the notification, or %NULL + filename="gio/gapplication.c" + line="3053">id of the notification, or %NULL the #GNotification to send + filename="gio/gapplication.c" + line="3054">the #GNotification to send @@ -8477,24 +8493,23 @@ g_application_withdraw_notification(). deprecated="1" deprecated-version="2.32"> This used to be how actions were associated with a #GApplication. + filename="gio/gapplication.c" + line="1299">This used to be how actions were associated with a #GApplication. Now there is #GActionMap for that. Use the #GActionMap interface instead. Never ever mix use of this API with use of #GActionMap on the same @application or things will go very badly wrong. This function is known to introduce buggy behaviour (ie: signals not emitted on changes to the action group), so you should really use #GActionMap instead. - + a #GApplication + filename="gio/gapplication.c" + line="1301">a #GApplication nullable="1" allow-none="1"> a #GActionGroup, or %NULL + filename="gio/gapplication.c" + line="1302">a #GActionGroup, or %NULL @@ -8513,24 +8528,23 @@ action group), so you should really use #GActionMap instead. glib:set-property="application-id" version="2.28"> Sets the unique identifier for @application. + filename="gio/gapplication.c" + line="1912">Sets the unique identifier for @application. The application id can only be modified if @application has not yet been registered. If non-%NULL, the application id must be valid. See g_application_id_is_valid(). - + a #GApplication + filename="gio/gapplication.c" + line="1914">a #GApplication nullable="1" allow-none="1"> the identifier for @application + filename="gio/gapplication.c" + line="1915">the identifier for @application @@ -8548,15 +8562,14 @@ g_application_id_is_valid(). c:identifier="g_application_set_default" version="2.32"> Sets or unsets the default application for the process, as returned + filename="gio/gapplication.c" + line="2916">Sets or unsets the default application for the process, as returned by g_application_get_default(). This function does not take its own reference on @application. If @application is destroyed then the default application will revert back to %NULL. - + @@ -8566,8 +8579,8 @@ back to %NULL. nullable="1" allow-none="1"> the application to set as default, or %NULL + filename="gio/gapplication.c" + line="2918">the application to set as default, or %NULL @@ -8577,29 +8590,28 @@ back to %NULL. glib:set-property="flags" version="2.28"> Sets the flags for @application. + filename="gio/gapplication.c" + line="2009">Sets the flags for @application. The flags can only be modified if @application has not yet been registered. See #GApplicationFlags. - + a #GApplication + filename="gio/gapplication.c" + line="2011">a #GApplication the flags for @application + filename="gio/gapplication.c" + line="2012">the flags for @application @@ -8609,8 +8621,8 @@ See #GApplicationFlags. glib:set-property="inactivity-timeout" version="2.28"> Sets the current inactivity timeout for the application. + filename="gio/gapplication.c" + line="2138">Sets the current inactivity timeout for the application. This is the amount of time (in milliseconds) after the last call to g_application_release() before the application stops running. @@ -8618,22 +8630,21 @@ g_application_release() before the application stops running. This call has no side effects of its own. The value set here is only used for next time g_application_release() drops the use count to zero. Any timeouts currently in progress are not impacted. - + a #GApplication + filename="gio/gapplication.c" + line="2140">a #GApplication the timeout, in milliseconds + filename="gio/gapplication.c" + line="2141">the timeout, in milliseconds @@ -8642,20 +8653,19 @@ zero. Any timeouts currently in progress are not impacted. c:identifier="g_application_set_option_context_description" version="2.56"> Adds a description to the @application option context. + filename="gio/gapplication.c" + line="916">Adds a description to the @application option context. See g_option_context_set_description() for more information. - + the #GApplication + filename="gio/gapplication.c" + line="918">the #GApplication nullable="1" allow-none="1"> a string to be shown in `--help` output + filename="gio/gapplication.c" + line="919">a string to be shown in `--help` output after the list of options, or %NULL @@ -8674,23 +8684,22 @@ See g_option_context_set_description() for more information. c:identifier="g_application_set_option_context_parameter_string" version="2.56"> Sets the parameter string to be used by the commandline handling of @application. + filename="gio/gapplication.c" + line="869">Sets the parameter string to be used by the commandline handling of @application. This function registers the argument to be passed to g_option_context_new() when the internal #GOptionContext of @application is created. See g_option_context_new() for more information about @parameter_string. - + the #GApplication + filename="gio/gapplication.c" + line="871">the #GApplication nullable="1" allow-none="1"> a string which is displayed + filename="gio/gapplication.c" + line="872">a string which is displayed in the first line of `--help` output, after the usage summary `programname [OPTION...]`. @@ -8709,20 +8718,19 @@ See g_option_context_new() for more information about @parameter_string. c:identifier="g_application_set_option_context_summary" version="2.56"> Adds a summary to the @application option context. + filename="gio/gapplication.c" + line="894">Adds a summary to the @application option context. See g_option_context_set_summary() for more information. - + the #GApplication + filename="gio/gapplication.c" + line="896">the #GApplication nullable="1" allow-none="1"> a string to be shown in `--help` output + filename="gio/gapplication.c" + line="897">a string to be shown in `--help` output before the list of options, or %NULL @@ -8742,8 +8750,8 @@ See g_option_context_set_summary() for more information. glib:set-property="resource-base-path" version="2.42"> Sets (or unsets) the base resource path of @application. + filename="gio/gapplication.c" + line="2059">Sets (or unsets) the base resource path of @application. The path is used to automatically load various [application resources][gresource] such as menu layouts and action descriptions. @@ -8776,16 +8784,15 @@ a sub-class of #GApplication you should either set the this function during the instance initialization. Alternatively, you can call this function in the #GApplicationClass.startup virtual function, before chaining up to the parent implementation. - + a #GApplication + filename="gio/gapplication.c" + line="2061">a #GApplication nullable="1" allow-none="1"> the resource path to use + filename="gio/gapplication.c" + line="2062">the resource path to use + + + + + + Sets the version number of @application. This will be used to implement +a `--version` command line argument + +The application version can only be modified if @application has not yet +been registered. + + + + + + + a #GApplication + + + + the version of @application @@ -8803,32 +8840,31 @@ before chaining up to the parent implementation. c:identifier="g_application_unbind_busy_property" version="2.44"> Destroys a binding between @property and the busy state of + filename="gio/gapplication.c" + line="3243">Destroys a binding between @property and the busy state of @application that was previously created with g_application_bind_busy_property(). - + a #GApplication + filename="gio/gapplication.c" + line="3245">a #GApplication a #GObject + filename="gio/gapplication.c" + line="3246">a #GObject the name of a boolean property of @object + filename="gio/gapplication.c" + line="3247">the name of a boolean property of @object @@ -8837,24 +8873,23 @@ g_application_bind_busy_property(). c:identifier="g_application_unmark_busy" version="2.38"> Decreases the busy count of @application. + filename="gio/gapplication.c" + line="3000">Decreases the busy count of @application. When the busy count reaches zero, the new state will be propagated to other processes. This function must only be called to cancel the effect of a previous call to g_application_mark_busy(). - + a #GApplication + filename="gio/gapplication.c" + line="3002">a #GApplication @@ -8863,8 +8898,8 @@ call to g_application_mark_busy(). c:identifier="g_application_withdraw_notification" version="2.40"> Withdraws a notification that was sent with + filename="gio/gapplication.c" + line="3115">Withdraws a notification that was sent with g_application_send_notification(). This call does nothing if a notification with @id doesn't exist or @@ -8877,56 +8912,71 @@ the sent notification. Note that notifications are dismissed when the user clicks on one of the buttons in a notification or triggers its default action, so there is no need to explicitly withdraw the notification in that case. - + a #GApplication + filename="gio/gapplication.c" + line="3117">a #GApplication id of a previously sent notification + filename="gio/gapplication.c" + line="3118">id of a previously sent notification + The group of actions that the application exports. + The unique identifier for the application. + Flags specifying the behaviour of the application. + Time (in milliseconds) to stay alive after becoming idle. getter="get_is_busy" default-value="FALSE"> Whether the application is currently marked as busy through + filename="gio/gapplication.c" + line="1623">Whether the application is currently marked as busy through g_application_mark_busy() or g_application_bind_busy_property(). + Whether [method@Gio.Application.register] has been called. + Whether this application instance is remote. + The base resource path for the application. + + + + The human-readable version number of the application. @@ -8968,8 +9042,8 @@ g_application_mark_busy() or g_application_bind_busy_property(). The ::activate signal is emitted on the primary instance when an + filename="gio/gapplication.c" + line="1659">The ::activate signal is emitted on the primary instance when an activation occurs. See g_application_activate(). @@ -8977,22 +9051,22 @@ activation occurs. See g_application_activate(). The ::command-line signal is emitted on the primary instance when + filename="gio/gapplication.c" + line="1692">The ::command-line signal is emitted on the primary instance when a commandline is not handled locally. See g_application_run() and the #GApplicationCommandLine documentation for more information. An integer that is set as the exit status for the calling + filename="gio/gapplication.c" + line="1702">An integer that is set as the exit status for the calling process. See g_application_command_line_set_exit_status(). a #GApplicationCommandLine representing the + filename="gio/gapplication.c" + line="1695">a #GApplicationCommandLine representing the passed commandline @@ -9000,8 +9074,8 @@ the #GApplicationCommandLine documentation for more information. The ::handle-local-options signal is emitted on the local instance + filename="gio/gapplication.c" + line="1715">The ::handle-local-options signal is emitted on the local instance after the parsing of the commandline options has occurred. You can add options to be recognised during commandline option @@ -9044,8 +9118,8 @@ capabilities than what is provided here, but this should not normally be required. an exit code. If you have handled your options and want + filename="gio/gapplication.c" + line="1762">an exit code. If you have handled your options and want to exit the process, return a non-negative option, 0 for success, and a positive value for failure. To continue, return -1 to let the default option processing continue. @@ -9054,31 +9128,31 @@ the default option processing continue. the options dictionary + filename="gio/gapplication.c" + line="1718">the options dictionary The ::name-lost signal is emitted only on the registered primary instance + filename="gio/gapplication.c" + line="1779">The ::name-lost signal is emitted only on the registered primary instance when a new instance has taken over. This can only happen if the application is using the %G_APPLICATION_ALLOW_REPLACEMENT flag. The default handler for this signal calls g_application_quit(). %TRUE if the signal has been handled + filename="gio/gapplication.c" + line="1789">%TRUE if the signal has been handled The ::open signal is emitted on the primary instance when there are + filename="gio/gapplication.c" + line="1672">The ::open signal is emitted on the primary instance when there are files to open. See g_application_open() for more information. @@ -9086,30 +9160,30 @@ files to open. See g_application_open() for more information. an array of #GFiles + filename="gio/gapplication.c" + line="1675">an array of #GFiles the length of @files + filename="gio/gapplication.c" + line="1676">the length of @files a hint provided by the calling instance + filename="gio/gapplication.c" + line="1677">a hint provided by the calling instance The ::shutdown signal is emitted only on the registered primary instance + filename="gio/gapplication.c" + line="1647">The ::shutdown signal is emitted only on the registered primary instance immediately after the main loop terminates. @@ -9117,8 +9191,8 @@ immediately after the main loop terminates. The ::startup signal is emitted on the primary instance immediately + filename="gio/gapplication.c" + line="1635">The ::startup signal is emitted on the primary instance immediately after registration. See g_application_register(). @@ -9130,17 +9204,18 @@ after registration. See g_application_register(). glib:is-gtype-struct-for="Application" version="2.28"> Virtual function table for #GApplication. - + filename="gio/gapplication.c" + line="178">Virtual function table for #GApplication. + + invoked on the primary instance immediately after registration - + @@ -9152,63 +9227,70 @@ after registration. See g_application_register(). + invoked on the primary instance when an activation occurs - + a #GApplication + filename="gio/gapplication.c" + line="2429">a #GApplication + invoked on the primary instance when there are files to open - + a #GApplication + filename="gio/gapplication.c" + line="2456">a #GApplication an array of #GFiles to open + filename="gio/gapplication.c" + line="2457">an array of #GFiles to open the length of the @files array + filename="gio/gapplication.c" + line="2458">the length of the @files array a hint (or ""), but never %NULL + filename="gio/gapplication.c" + line="2459">a hint (or ""), but never %NULL + invoked on the primary instance when a command-line is + not handled locally - + @@ -9224,19 +9306,25 @@ after registration. See g_application_register(). + invoked (locally). The virtual function has the chance + to inspect (and possibly replace) command line arguments. See + g_application_run() for more information. Also see the + #GApplication::handle-local-options signal, which is a simpler + alternative to handling some commandline options locally - + %TRUE if the commandline has been completely handled a #GApplication @@ -9245,7 +9333,7 @@ after registration. See g_application_register(). caller-allocates="0" transfer-ownership="full"> array of command line arguments @@ -9256,7 +9344,7 @@ after registration. See g_application_register(). caller-allocates="0" transfer-ownership="full"> exit status to fill after processing the command line. @@ -9264,9 +9352,13 @@ after registration. See g_application_register(). + invoked on the primary instance before 'activate', 'open', + 'command-line' or any action invocation, gets the 'platform data' from + the calling instance - + @@ -9281,9 +9373,13 @@ after registration. See g_application_register(). + invoked on the primary instance after 'activate', 'open', + 'command-line' or any action invocation, gets the 'platform data' from + the calling instance - + @@ -9298,9 +9394,12 @@ after registration. See g_application_register(). + invoked (locally) to add 'platform data' to be sent to + the primary instance when activating, opening or invoking actions - + @@ -9315,9 +9414,13 @@ after registration. See g_application_register(). + Used to be invoked on the primary instance when the use + count of the application drops to zero (and after any inactivity + timeout, if requested). Not used anymore since 2.32 - + @@ -9329,9 +9432,14 @@ after registration. See g_application_register(). + Used to be invoked on the primary instance from + g_application_run() if the use-count is non-zero. Since 2.32, + GApplication is iterating the main context directly and is not + using @run_mainloop anymore - + @@ -9343,9 +9451,12 @@ after registration. See g_application_register(). + invoked only on the registered primary instance immediately + after the main loop terminates - + @@ -9357,9 +9468,17 @@ after registration. See g_application_register(). + invoked locally during registration, if the application is + using its D-Bus backend. You can use this to export extra objects on the + bus, that need to exist before the application tries to own the bus name. + The function is passed the #GDBusConnection to to session bus, and the + object path that #GApplication will use to export its D-Bus API. + If this function returns %TRUE, registration will proceed; otherwise + registration will abort. Since: 2.34 - + @@ -9377,9 +9496,13 @@ after registration. See g_application_register(). + invoked locally during unregistration, if the application + is using its D-Bus backend. Use this to undo anything done by + the @dbus_register vfunc. Since: 2.34 - + @@ -9397,9 +9520,12 @@ after registration. See g_application_register(). + invoked locally after the parsing of the commandline + options has occurred. Since: 2.40 - + @@ -9414,9 +9540,11 @@ after registration. See g_application_register(). + invoked when another instance is taking over the name. Since: 2.60 - + @@ -9441,31 +9569,34 @@ after registration. See g_application_register(). glib:get-type="g_application_command_line_get_type" glib:type-struct="ApplicationCommandLineClass"> #GApplicationCommandLine represents a command-line invocation of -an application. It is created by #GApplication and emitted -in the #GApplication::command-line signal and virtual function. + filename="gio/gapplicationcommandline.c" + line="42">`GApplicationCommandLine` represents a command-line invocation of +an application. + +It is created by [class@Gio.Application] and emitted +in the [signal@Gio.Application::command-line] signal and virtual function. The class contains the list of arguments that the program was invoked -with. It is also possible to query if the commandline invocation was +with. It is also possible to query if the commandline invocation was local (ie: the current process is running in direct response to the invocation) or remote (ie: some other process forwarded the commandline to this process). -The GApplicationCommandLine object can provide the @argc and @argv -parameters for use with the #GOptionContext command-line parsing API, -with the g_application_command_line_get_arguments() function. See +The `GApplicationCommandLine` object can provide the @argc and @argv +parameters for use with the [struct@GLib.OptionContext] command-line parsing API, +with the [method@Gio.ApplicationCommandLine.get_arguments] function. See [gapplication-example-cmdline3.c][gapplication-example-cmdline3] for an example. The exit status of the originally-invoked process may be set and -messages can be printed to stdout or stderr of that process. The -lifecycle of the originally-invoked process is tied to the lifecycle -of this object (ie: the process exits when the last reference is -dropped). +messages can be printed to stdout or stderr of that process. + +For remote invocation, the originally-invoked process exits when +[method@Gio.ApplicationCommandLine.done] method is called. This method is +also automatically called when the object is disposed. -The main use for #GApplicationCommandLine (and the -#GApplication::command-line signal) is 'Emacs server' like use cases: +The main use for `GApplicationCommandLine` (and the +[signal@Gio.Application::command-line] signal) is 'Emacs server' like use cases: You can set the `EDITOR` environment variable to have e.g. git use your favourite editor to edit commit messages, and if you already have an instance of the editor running, the editing will happen @@ -9474,11 +9605,12 @@ aspect of this use case is that the process that gets started by git does not return until the editing is done. Normally, the commandline is completely handled in the -#GApplication::command-line handler. The launching instance exits +[signal@Gio.Application::command-line] handler. The launching instance exits once the signal handler in the primary instance has returned, and the return value of the signal handler becomes the exit status of the launching instance. -|[<!-- language="C" --> + +```c static int command_line (GApplication *application, GApplicationCommandLine *cmdline) @@ -9500,13 +9632,15 @@ command_line (GApplication *application, return 0; } -]| +``` + The complete example can be found here: [gapplication-example-cmdline.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-cmdline.c) In more complicated cases, the handling of the commandline can be split between the launcher and the primary instance. -|[<!-- language="C" --> + +```c static gboolean test_local_cmdline (GApplication *application, gchar ***arguments, @@ -9552,18 +9686,19 @@ test_application_class_init (TestApplicationClass *class) ... } -]| +``` + In this example of split commandline handling, options that start with `--local-` are handled locally, all other options are passed -to the #GApplication::command-line handler which runs in the primary +to the [signal@Gio.Application::command-line] handler which runs in the primary instance. The complete example can be found here: [gapplication-example-cmdline2.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-cmdline2.c) -If handling the commandline requires a lot of work, it may -be better to defer it. -|[<!-- language="C" --> +If handling the commandline requires a lot of work, it may be better to defer it. + +```c static gboolean my_cmdline_handler (gpointer data) { @@ -9593,21 +9728,53 @@ command_line (GApplication *application, return 0; } -]| +``` + In this example the commandline is not completely handled before -the #GApplication::command-line handler returns. Instead, we keep -a reference to the #GApplicationCommandLine object and handle it +the [signal@Gio.Application::command-line] handler returns. Instead, we keep +a reference to the `GApplicationCommandLine` object and handle it later (in this example, in an idle). Note that it is necessary to hold the application until you are done with the commandline. The complete example can be found here: [gapplication-example-cmdline3.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gapplication-example-cmdline3.c) - + + + Signals that command line processing is completed. + +For remote invocation, it causes the invoking process to terminate. + +For local invocation, it does nothing. + +This method should be called in the [signal@Gio.Application::command-line] +handler, after the exit status is set and all messages are printed. + +After this call, g_application_command_line_set_exit_status() has no effect. +Subsequent calls to this method are no-ops. + +This method is automatically called when the #GApplicationCommandLine +object is disposed — so you can omit the call in non-garbage collected +languages. + + + + + + + a #GApplicationCommandLine + + + + Gets the stdin of the invoking process. + filename="gio/gapplicationcommandline.c" + line="565">Gets the stdin of the invoking process. The #GInputStream can be used to read data passed to the standard input of the invoking process. @@ -9617,52 +9784,79 @@ If stdin is not available then %NULL will be returned. In the future, support may be expanded to other platforms. You must only call this function once per commandline invocation. - + a #GInputStream for stdin + filename="gio/gapplicationcommandline.c" + line="580">a #GInputStream for stdin a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="567">a #GApplicationCommandLine - - + + Prints a message using the stdout print handler in the invoking process. + +Unlike g_application_command_line_print(), @message is not a `printf()`-style +format string. Use this function if @message contains text you don't have +control over, that could include `printf()` escape sequences. + + a #GApplicationCommandLine + the message - - + + Prints a message using the stderr print handler in the invoking process. + +Unlike g_application_command_line_printerr(), @message is not +a `printf()`-style format string. Use this function if @message contains text +you don't have control over, that could include `printf()` escape sequences. + + a #GApplicationCommandLine + the message @@ -9671,43 +9865,76 @@ You must only call this function once per commandline invocation. c:identifier="g_application_command_line_create_file_for_arg" version="2.36"> Creates a #GFile corresponding to a filename that was given as part + filename="gio/gapplicationcommandline.c" + line="910">Creates a #GFile corresponding to a filename that was given as part of the invocation of @cmdline. This differs from g_file_new_for_commandline_arg() in that it resolves relative pathnames using the current working directory of the invoking process rather than the local process. - + a new #GFile + filename="gio/gapplicationcommandline.c" + line="922">a new #GFile a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="912">a #GApplicationCommandLine an argument from @cmdline + filename="gio/gapplicationcommandline.c" + line="913">an argument from @cmdline + + Signals that command line processing is completed. + +For remote invocation, it causes the invoking process to terminate. + +For local invocation, it does nothing. + +This method should be called in the [signal@Gio.Application::command-line] +handler, after the exit status is set and all messages are printed. + +After this call, g_application_command_line_set_exit_status() has no effect. +Subsequent calls to this method are no-ops. + +This method is automatically called when the #GApplicationCommandLine +object is disposed — so you can omit the call in non-garbage collected +languages. + + + + + + + a #GApplicationCommandLine + + + + Gets the list of arguments that was passed on the command line. + filename="gio/gapplicationcommandline.c" + line="494">Gets the list of arguments that was passed on the command line. The strings in the array may contain non-UTF-8 data on UNIX (such as filenames or arguments given in the system locale) but are always in @@ -9718,12 +9945,11 @@ use g_option_context_parse_strv(). The return value is %NULL-terminated and should be freed using g_strfreev(). - + + filename="gio/gapplicationcommandline.c" + line="511"> the string array containing the arguments (the argv) @@ -9732,8 +9958,8 @@ g_strfreev(). a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="496">a #GApplicationCommandLine @@ -9744,8 +9970,8 @@ g_strfreev(). optional="1" allow-none="1"> the length of the arguments array, or %NULL + filename="gio/gapplicationcommandline.c" + line="497">the length of the arguments array, or %NULL @@ -9754,8 +9980,8 @@ g_strfreev(). c:identifier="g_application_command_line_get_cwd" version="2.28"> Gets the working directory of the command line invocation. + filename="gio/gapplicationcommandline.c" + line="590">Gets the working directory of the command line invocation. The string may contain non-utf8 data. It is possible that the remote application did not send a working @@ -9763,19 +9989,18 @@ directory, so this may be %NULL. The return value should not be modified or freed and is valid for as long as @cmdline exists. - + the current directory, or %NULL + filename="gio/gapplicationcommandline.c" + line="603">the current directory, or %NULL a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="592">a #GApplicationCommandLine @@ -9785,8 +10010,8 @@ long as @cmdline exists. c:identifier="g_application_command_line_get_environ" version="2.28"> Gets the contents of the 'environ' variable of the command line + filename="gio/gapplicationcommandline.c" + line="613">Gets the contents of the 'environ' variable of the command line invocation, as would be returned by g_get_environ(), ie as a %NULL-terminated list of strings in the form 'NAME=VALUE'. The strings may contain non-utf8 data. @@ -9801,12 +10026,11 @@ long as @cmdline exists. See g_application_command_line_getenv() if you are only interested in the value of a single environment variable. - + + filename="gio/gapplicationcommandline.c" + line="633"> the environment strings, or %NULL if they were not sent @@ -9815,8 +10039,8 @@ in the value of a single environment variable. a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="615">a #GApplicationCommandLine @@ -9826,22 +10050,21 @@ in the value of a single environment variable. c:identifier="g_application_command_line_get_exit_status" version="2.28"> Gets the exit status of @cmdline. See + filename="gio/gapplicationcommandline.c" + line="860">Gets the exit status of @cmdline. See g_application_command_line_set_exit_status() for more information. - + the exit status + filename="gio/gapplicationcommandline.c" + line="867">the exit status a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="862">a #GApplicationCommandLine @@ -9852,21 +10075,20 @@ g_application_command_line_set_exit_status() for more information. glib:get-property="is-remote" version="2.28"> Determines if @cmdline represents a remote invocation. - + filename="gio/gapplicationcommandline.c" + line="682">Determines if @cmdline represents a remote invocation. + %TRUE if the invocation was remote + filename="gio/gapplicationcommandline.c" + line="688">%TRUE if the invocation was remote a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="684">a #GApplicationCommandLine @@ -9876,8 +10098,8 @@ g_application_command_line_set_exit_status() for more information. c:identifier="g_application_command_line_get_options_dict" version="2.40"> Gets the options that were passed to g_application_command_line(). + filename="gio/gapplicationcommandline.c" + line="533">Gets the options that were passed to g_application_command_line(). If you did not override local_command_line() then these are the same options that were parsed according to the #GOptionEntrys added to the @@ -9889,19 +10111,18 @@ you don't need to check for %NULL. The data has been passed via an untrusted external process, so the types of all values must be checked before being used. - + a #GVariantDict with the options + filename="gio/gapplicationcommandline.c" + line="550">a #GVariantDict with the options a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="535">a #GApplicationCommandLine @@ -9911,8 +10132,8 @@ all values must be checked before being used. c:identifier="g_application_command_line_get_platform_data" version="2.28"> Gets the platform data associated with the invocation of @cmdline. + filename="gio/gapplicationcommandline.c" + line="879">Gets the platform data associated with the invocation of @cmdline. This is a #GVariant dictionary containing information about the context in which the invocation occurred. It typically contains @@ -9923,19 +10144,18 @@ It comes from an untrusted external process and hence the types of all values must be validated before being used. For local invocation, it will be %NULL. - + the platform data, or %NULL + filename="gio/gapplicationcommandline.c" + line="895">the platform data, or %NULL #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="881">#GApplicationCommandLine @@ -9945,8 +10165,8 @@ For local invocation, it will be %NULL. c:identifier="g_application_command_line_get_stdin" version="2.34"> Gets the stdin of the invoking process. + filename="gio/gapplicationcommandline.c" + line="565">Gets the stdin of the invoking process. The #GInputStream can be used to read data passed to the standard input of the invoking process. @@ -9956,19 +10176,18 @@ If stdin is not available then %NULL will be returned. In the future, support may be expanded to other platforms. You must only call this function once per commandline invocation. - + a #GInputStream for stdin + filename="gio/gapplicationcommandline.c" + line="580">a #GInputStream for stdin a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="567">a #GApplicationCommandLine @@ -9978,8 +10197,8 @@ You must only call this function once per commandline invocation. c:identifier="g_application_command_line_getenv" version="2.28"> Gets the value of a particular environment variable of the command + filename="gio/gapplicationcommandline.c" + line="644">Gets the value of a particular environment variable of the command line invocation, as would be returned by g_getenv(). The strings may contain non-utf8 data. @@ -9990,26 +10209,25 @@ to invocation messages from other applications). The return value should not be modified or freed and is valid for as long as @cmdline exists. - + the value of the variable, or %NULL if unset or unsent + filename="gio/gapplicationcommandline.c" + line="661">the value of the variable, or %NULL if unset or unsent a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="646">a #GApplicationCommandLine the environment variable to get + filename="gio/gapplicationcommandline.c" + line="647">the environment variable to get @@ -10019,85 +10237,143 @@ long as @cmdline exists. version="2.28" introspectable="0"> Formats a message and prints it using the stdout print handler in the + filename="gio/gapplicationcommandline.c" + line="746">Formats a message and prints it using the stdout print handler in the invoking process. If @cmdline is a local invocation then this is exactly equivalent to g_print(). If @cmdline is remote then this is equivalent to calling g_print() in the invoking process. - + a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="748">a #GApplicationCommandLine a printf-style format string + filename="gio/gapplicationcommandline.c" + line="749">a printf-style format string arguments, as per @format + filename="gio/gapplicationcommandline.c" + line="750">arguments, as per @format + + Prints a message using the stdout print handler in the invoking process. + +Unlike g_application_command_line_print(), @message is not a `printf()`-style +format string. Use this function if @message contains text you don't have +control over, that could include `printf()` escape sequences. + + + + + + + a #GApplicationCommandLine + + + + the message + + + + Formats a message and prints it using the stderr print handler in the + filename="gio/gapplicationcommandline.c" + line="781">Formats a message and prints it using the stderr print handler in the invoking process. If @cmdline is a local invocation then this is exactly equivalent to g_printerr(). If @cmdline is remote then this is equivalent to calling g_printerr() in the invoking process. - + a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="783">a #GApplicationCommandLine a printf-style format string + filename="gio/gapplicationcommandline.c" + line="784">a printf-style format string arguments, as per @format + filename="gio/gapplicationcommandline.c" + line="785">arguments, as per @format + + Prints a message using the stderr print handler in the invoking process. + +Unlike g_application_command_line_printerr(), @message is not +a `printf()`-style format string. Use this function if @message contains text +you don't have control over, that could include `printf()` escape sequences. + + + + + + + a #GApplicationCommandLine + + + + the message + + + + Sets the exit status that will be used when the invoking process + filename="gio/gapplicationcommandline.c" + line="816">Sets the exit status that will be used when the invoking process exits. The return value of the #GApplication::command-line signal is @@ -10117,53 +10393,72 @@ in the mainloop running (ie: because the use-count of the application increased to a non-zero value) then the application is considered to have been 'successful' in a certain sense, and the exit status is always zero. If the application use count is zero, though, the exit -status of the local #GApplicationCommandLine is used. - +status of the local #GApplicationCommandLine is used. + +This method is a no-op if g_application_command_line_done() has +been called. + a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="818">a #GApplicationCommandLine the exit status + filename="gio/gapplicationcommandline.c" + line="819">the exit status + The commandline that caused this [signal@Gio.Application::command-line] +signal emission. + Whether this is a remote commandline. + The options sent along with the commandline. + Platform-specific data for the commandline. @@ -10179,27 +10474,31 @@ status of the local #GApplicationCommandLine is used. glib:is-gtype-struct-for="ApplicationCommandLine" version="2.28"> The #GApplicationCommandLineClass-struct + filename="gio/gapplicationcommandline.c" + line="215">The #GApplicationCommandLineClass-struct contains private data only. - + - + + a #GApplicationCommandLine + the message @@ -10207,17 +10506,22 @@ contains private data only. - + + a #GApplicationCommandLine + the message @@ -10225,19 +10529,35 @@ contains private data only. - + a #GInputStream for stdin + filename="gio/gapplicationcommandline.c" + line="580">a #GInputStream for stdin a #GApplicationCommandLine + filename="gio/gapplicationcommandline.c" + line="567">a #GApplicationCommandLine + + + + + + + + + + + + + + a #GApplicationCommandLine @@ -10245,7 +10565,7 @@ contains private data only. - + @@ -10254,8 +10574,7 @@ contains private data only. c:type="GApplicationCommandLinePrivate" disguised="1" opaque="1"> - + glib:get-type="g_application_flags_get_type" c:type="GApplicationFlags"> Flags used to define the behaviour of a #GApplication. + filename="gio/gioenums.h" + line="1497">Flags used to define the behaviour of a #GApplication. Default. Deprecated in 2.74, use + filename="gio/gioenums.h" + line="1499">Default. Deprecated in 2.74, use %G_APPLICATION_DEFAULT_FLAGS instead glib:nick="default-flags" glib:name="G_APPLICATION_DEFAULT_FLAGS"> Default flags. Since: 2.74 + filename="gio/gioenums.h" + line="1501">Default flags. Since: 2.74 glib:nick="is-service" glib:name="G_APPLICATION_IS_SERVICE"> Run as a service. In this mode, registration + filename="gio/gioenums.h" + line="1502">Run as a service. In this mode, registration fails if the service is already running, and the application will initially wait up to 10 seconds for an initial activation message to arrive. @@ -10302,8 +10621,8 @@ contains private data only. glib:nick="is-launcher" glib:name="G_APPLICATION_IS_LAUNCHER"> Don't try to become the primary instance. + filename="gio/gioenums.h" + line="1506">Don't try to become the primary instance. glib:nick="handles-open" glib:name="G_APPLICATION_HANDLES_OPEN"> This application handles opening files (in + filename="gio/gioenums.h" + line="1507">This application handles opening files (in the primary instance). Note that this flag only affects the default implementation of local_command_line(), and has no effect if %G_APPLICATION_HANDLES_COMMAND_LINE is given. @@ -10324,8 +10643,8 @@ contains private data only. glib:nick="handles-command-line" glib:name="G_APPLICATION_HANDLES_COMMAND_LINE"> This application handles command line + filename="gio/gioenums.h" + line="1512">This application handles command line arguments (in the primary instance). Note that this flag only affect the default implementation of local_command_line(). See g_application_run() for details. @@ -10336,8 +10655,8 @@ contains private data only. glib:nick="send-environment" glib:name="G_APPLICATION_SEND_ENVIRONMENT"> Send the environment of the + filename="gio/gioenums.h" + line="1516">Send the environment of the launching process to the primary instance. Set this flag if your application is expected to behave differently depending on certain environment variables. For instance, an editor might be expected @@ -10352,8 +10671,8 @@ contains private data only. glib:nick="non-unique" glib:name="G_APPLICATION_NON_UNIQUE"> Make no attempts to do any of the typical + filename="gio/gioenums.h" + line="1524">Make no attempts to do any of the typical single-instance application negotiation, even if the application ID is given. The application neither attempts to become the owner of the application ID nor does it check if an existing @@ -10366,8 +10685,8 @@ contains private data only. glib:nick="can-override-app-id" glib:name="G_APPLICATION_CAN_OVERRIDE_APP_ID"> Allow users to override the + filename="gio/gioenums.h" + line="1530">Allow users to override the application ID from the command line with `--gapplication-app-id`. Since: 2.48 @@ -10377,8 +10696,8 @@ contains private data only. glib:nick="allow-replacement" glib:name="G_APPLICATION_ALLOW_REPLACEMENT"> Allow another instance to take over + filename="gio/gioenums.h" + line="1533">Allow another instance to take over the bus name. Since: 2.60 glib:nick="replace" glib:name="G_APPLICATION_REPLACE"> Take over from another instance. This flag is + filename="gio/gioenums.h" + line="1535">Take over from another instance. This flag is usually set by passing `--gapplication-replace` on the commandline. Since: 2.60 @@ -10397,16 +10716,15 @@ contains private data only. c:type="GApplicationPrivate" disguised="1" opaque="1"> - + #GAskPasswordFlags are used to request specific information from the + filename="gio/gioenums.h" + line="595">#GAskPasswordFlags are used to request specific information from the user, or to notify the user of their choices in an authentication situation. glib:nick="need-password" glib:name="G_ASK_PASSWORD_NEED_PASSWORD"> operation requires a password. + filename="gio/gioenums.h" + line="597">operation requires a password. glib:nick="need-username" glib:name="G_ASK_PASSWORD_NEED_USERNAME"> operation requires a username. + filename="gio/gioenums.h" + line="598">operation requires a username. glib:nick="need-domain" glib:name="G_ASK_PASSWORD_NEED_DOMAIN"> operation requires a domain. + filename="gio/gioenums.h" + line="599">operation requires a domain. glib:nick="saving-supported" glib:name="G_ASK_PASSWORD_SAVING_SUPPORTED"> operation supports saving settings. + filename="gio/gioenums.h" + line="600">operation supports saving settings. glib:nick="anonymous-supported" glib:name="G_ASK_PASSWORD_ANONYMOUS_SUPPORTED"> operation supports anonymous users. + filename="gio/gioenums.h" + line="601">operation supports anonymous users. glib:nick="tcrypt" glib:name="G_ASK_PASSWORD_TCRYPT"> operation takes TCRYPT parameters (Since: 2.58) + filename="gio/gioenums.h" + line="602">operation takes TCRYPT parameters (Since: 2.58) glib:get-type="g_async_initable_get_type" glib:type-struct="AsyncInitableIface"> This is the asynchronous version of #GInitable; it behaves the same + filename="gio/gasyncinitable.c" + line="31">`GAsyncInitable` is an interface for asynchronously initializable objects. + +This is the asynchronous version of [iface@Gio.Initable]; it behaves the same in all ways except that initialization is asynchronous. For more details -see the descriptions on #GInitable. +see the descriptions on `GInitable`. -A class may implement both the #GInitable and #GAsyncInitable interfaces. +A class may implement both the `GInitable` and `GAsyncInitable` interfaces. Users of objects implementing this are not intended to use the interface method directly; instead it will be used automatically in various ways. -For C applications you generally just call g_async_initable_new_async() +For C applications you generally just call [func@Gio.AsyncInitable.new_async] directly, or indirectly via a foo_thing_new_async() wrapper. This will call -g_async_initable_init_async() under the cover, calling back with %NULL and -a set %GError on failure. +[method@Gio.AsyncInitable.init_async] under the covers, calling back with `NULL` +and a set `GError` on failure. A typical implementation might look something like this: -|[<!-- language="C" --> +```c enum { NOT_INITIALIZED, INITIALIZING, @@ -10571,37 +10891,35 @@ foo_async_initable_iface_init (gpointer g_iface, iface->init_async = foo_init_async; iface->init_finish = foo_init_finish; } -]| - +``` + Helper function for constructing #GAsyncInitable object. This is + filename="gio/gasyncinitable.c" + line="313">Helper function for constructing #GAsyncInitable object. This is similar to g_object_new() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can then call g_async_initable_new_finish() to get the new object and check for any errors. - + a #GType supporting #GAsyncInitable. + filename="gio/gasyncinitable.c" + line="315">a #GType supporting #GAsyncInitable. the [I/O priority][io-priority] of the operation + filename="gio/gasyncinitable.c" + line="316">the [I/O priority][io-priority] of the operation nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gasyncinitable.c" + line="317">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback to call when the initialization is + filename="gio/gasyncinitable.c" + line="318">a #GAsyncReadyCallback to call when the initialization is finished @@ -10630,8 +10948,8 @@ for any errors. nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gasyncinitable.c" + line="320">the data to pass to callback function nullable="1" allow-none="1"> the name of the first property, or %NULL if no + filename="gio/gasyncinitable.c" + line="321">the name of the first property, or %NULL if no properties the value of the first property, followed by other property + filename="gio/gasyncinitable.c" + line="323">the value of the first property, followed by other property value pairs, and ended by %NULL. @@ -10658,43 +10976,42 @@ for any errors. version="2.22" introspectable="0"> Helper function for constructing #GAsyncInitable object. This is + filename="gio/gasyncinitable.c" + line="399">Helper function for constructing #GAsyncInitable object. This is similar to g_object_new_valist() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can then call g_async_initable_new_finish() to get the new object and check for any errors. - + a #GType supporting #GAsyncInitable. + filename="gio/gasyncinitable.c" + line="401">a #GType supporting #GAsyncInitable. the name of the first property, followed by + filename="gio/gasyncinitable.c" + line="402">the name of the first property, followed by the value, and other property value pairs, and ended by %NULL. The var args list generated from @first_property_name. + filename="gio/gasyncinitable.c" + line="404">The var args list generated from @first_property_name. the [I/O priority][io-priority] of the operation + filename="gio/gasyncinitable.c" + line="405">the [I/O priority][io-priority] of the operation nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gasyncinitable.c" + line="406">optional #GCancellable object, %NULL to ignore. scope="async" closure="6"> a #GAsyncReadyCallback to call when the initialization is + filename="gio/gasyncinitable.c" + line="407">a #GAsyncReadyCallback to call when the initialization is finished @@ -10723,8 +11040,8 @@ the value, and other property value pairs, and ended by %NULL. nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gasyncinitable.c" + line="409">the data to pass to callback function @@ -10735,8 +11052,8 @@ the value, and other property value pairs, and ended by %NULL. deprecated="1" deprecated-version="2.54"> Helper function for constructing #GAsyncInitable object. This is + filename="gio/gasyncinitable.c" + line="354">Helper function for constructing #GAsyncInitable object. This is similar to g_object_newv() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can @@ -10744,34 +11061,33 @@ then call g_async_initable_new_finish() to get the new object and check for any errors. Use g_object_new_with_properties() and g_async_initable_init_async() instead. See #GParameter for more information. - + a #GType supporting #GAsyncInitable. + filename="gio/gasyncinitable.c" + line="356">a #GType supporting #GAsyncInitable. the number of parameters in @parameters + filename="gio/gasyncinitable.c" + line="357">the number of parameters in @parameters the parameters to use to construct the object + filename="gio/gasyncinitable.c" + line="358">the parameters to use to construct the object the [I/O priority][io-priority] of the operation + filename="gio/gasyncinitable.c" + line="359">the [I/O priority][io-priority] of the operation optional #GCancellable object, %NULL to ignore. + filename="gio/gasyncinitable.c" + line="360">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the initialization is + filename="gio/gasyncinitable.c" + line="361">a #GAsyncReadyCallback to call when the initialization is finished @@ -10800,16 +11116,19 @@ g_async_initable_init_async() instead. See #GParameter for more information. the data to pass to callback function + filename="gio/gasyncinitable.c" + line="363">the data to pass to callback function - + Starts asynchronous initialization of the object implementing the + filename="gio/gasyncinitable.c" + line="160">Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead. @@ -10845,22 +11164,21 @@ implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods. - + a #GAsyncInitable. + filename="gio/gasyncinitable.c" + line="162">a #GAsyncInitable. the [I/O priority][io-priority] of the operation + filename="gio/gasyncinitable.c" + line="163">the [I/O priority][io-priority] of the operation nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gasyncinitable.c" + line="164">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gasyncinitable.c" + line="165">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gasyncinitable.c" + line="166">the data to pass to callback function @@ -10900,39 +11218,39 @@ any interface methods. version="2.22" throws="1"> Finishes asynchronous initialization and returns the result. + filename="gio/gasyncinitable.c" + line="223">Finishes asynchronous initialization and returns the result. See g_async_initable_init_async(). - + %TRUE if successful. If an error has occurred, this function + filename="gio/gasyncinitable.c" + line="233">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. a #GAsyncInitable. + filename="gio/gasyncinitable.c" + line="225">a #GAsyncInitable. a #GAsyncResult. + filename="gio/gasyncinitable.c" + line="226">a #GAsyncResult. + version="2.22" + glib:finish-func="init_finish"> Starts asynchronous initialization of the object implementing the + filename="gio/gasyncinitable.c" + line="160">Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead. @@ -10968,22 +11286,21 @@ implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods. - + a #GAsyncInitable. + filename="gio/gasyncinitable.c" + line="162">a #GAsyncInitable. the [I/O priority][io-priority] of the operation + filename="gio/gasyncinitable.c" + line="163">the [I/O priority][io-priority] of the operation nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gasyncinitable.c" + line="164">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gasyncinitable.c" + line="165">a #GAsyncReadyCallback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gasyncinitable.c" + line="166">the data to pass to callback function @@ -11022,29 +11339,28 @@ any interface methods. version="2.22" throws="1"> Finishes asynchronous initialization and returns the result. + filename="gio/gasyncinitable.c" + line="223">Finishes asynchronous initialization and returns the result. See g_async_initable_init_async(). - + %TRUE if successful. If an error has occurred, this function + filename="gio/gasyncinitable.c" + line="233">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. a #GAsyncInitable. + filename="gio/gasyncinitable.c" + line="225">a #GAsyncInitable. a #GAsyncResult. + filename="gio/gasyncinitable.c" + line="226">a #GAsyncResult. @@ -11054,29 +11370,28 @@ will return %FALSE and set @error appropriately if present. version="2.22" throws="1"> Finishes the async construction for the various g_async_initable_new + filename="gio/gasyncinitable.c" + line="444">Finishes the async construction for the various g_async_initable_new calls, returning the created object or %NULL on error. - + a newly created #GObject, + filename="gio/gasyncinitable.c" + line="453">a newly created #GObject, or %NULL on error. Free with g_object_unref(). the #GAsyncInitable from the callback + filename="gio/gasyncinitable.c" + line="446">the #GAsyncInitable from the callback the #GAsyncResult from the callback + filename="gio/gasyncinitable.c" + line="447">the #GAsyncResult from the callback @@ -11087,35 +11402,36 @@ calls, returning the created object or %NULL on error. glib:is-gtype-struct-for="AsyncInitable" version="2.22"> Provides an interface for asynchronous initializing object such that + filename="gio/gasyncinitable.h" + line="43">Provides an interface for asynchronous initializing object such that initialization may fail. - + The parent interface. + filename="gio/gasyncinitable.h" + line="45">The parent interface. + Starts initialization of the object. - + a #GAsyncInitable. + filename="gio/gasyncinitable.c" + line="162">a #GAsyncInitable. the [I/O priority][io-priority] of the operation + filename="gio/gasyncinitable.c" + line="163">the [I/O priority][io-priority] of the operation nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gasyncinitable.c" + line="164">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gasyncinitable.c" + line="165">a #GAsyncReadyCallback to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gasyncinitable.c" + line="166">the data to pass to callback function + Finishes initialization of the object. - + %TRUE if successful. If an error has occurred, this function + filename="gio/gasyncinitable.c" + line="233">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. a #GAsyncInitable. + filename="gio/gasyncinitable.c" + line="225">a #GAsyncInitable. a #GAsyncResult. + filename="gio/gasyncinitable.c" + line="226">a #GAsyncResult. @@ -11181,8 +11499,8 @@ will return %FALSE and set @error appropriately if present. Type definition for a function that will be called back when an asynchronous + filename="gio/giotypes.h" + line="171">Type definition for a function that will be called back when an asynchronous operation within GIO has been completed. #GAsyncReadyCallback callbacks from #GTask are guaranteed to be invoked in a later iteration of the @@ -11194,8 +11512,7 @@ later iteration of the main context. The asynchronous operation is guaranteed to have held a reference to @source_object from the time when the `*_async()` function was called, until after this callback returns. - + @@ -11205,14 +11522,14 @@ after this callback returns. nullable="1" allow-none="1"> the object the asynchronous operation was started with. + filename="gio/giotypes.h" + line="173">the object the asynchronous operation was started with. a #GAsyncResult. + filename="gio/giotypes.h" + line="174">a #GAsyncResult. nullable="1" allow-none="1"> user data passed to the callback. + filename="gio/giotypes.h" + line="175">user data passed to the callback. @@ -11233,38 +11550,39 @@ after this callback returns. glib:get-type="g_async_result_get_type" glib:type-struct="AsyncResultIface"> Provides a base class for implementing asynchronous function results. + filename="gio/gasyncresult.c" + line="29">`GAsyncResult` provides a base class for implementing asynchronous function results. Asynchronous operations are broken up into two separate operations -which are chained together by a #GAsyncReadyCallback. To begin -an asynchronous operation, provide a #GAsyncReadyCallback to the +which are chained together by a `GAsyncReadyCallback`. To begin +an asynchronous operation, provide a `GAsyncReadyCallback` to the asynchronous function. This callback will be triggered when the operation has completed, and must be run in a later iteration of -the [thread-default main context][g-main-context-push-thread-default] -from where the operation was initiated. It will be passed a -#GAsyncResult instance filled with the details of the operation's -success or failure, the object the asynchronous function was -started for and any error codes returned. The asynchronous callback -function is then expected to call the corresponding "_finish()" +the thread-default main context (see +[method@GLib.MainContext.push_thread_default]) from where the operation was +initiated. It will be passed a `GAsyncResult` instance filled with the +details of the operation's success or failure, the object the asynchronous +function was started for and any error codes returned. The asynchronous +callback function is then expected to call the corresponding `_finish()` function, passing the object the function was called for, the -#GAsyncResult instance, and (optionally) an @error to grab any +`GAsyncResult` instance, and (optionally) an @error to grab any error conditions that may have occurred. -The "_finish()" function for an operation takes the generic result -(of type #GAsyncResult) and returns the specific result that the -operation in question yields (e.g. a #GFileEnumerator for a +The `_finish()` function for an operation takes the generic result +(of type `GAsyncResult`) and returns the specific result that the +operation in question yields (e.g. a [class@Gio.FileEnumerator] for a "enumerate children" operation). If the result or error status of the -operation is not needed, there is no need to call the "_finish()" +operation is not needed, there is no need to call the `_finish()` function; GIO will take care of cleaning up the result and error -information after the #GAsyncReadyCallback returns. You can pass -%NULL for the #GAsyncReadyCallback if you don't need to take any +information after the `GAsyncReadyCallback` returns. You can pass +`NULL` for the `GAsyncReadyCallback` if you don't need to take any action at all after the operation completes. Applications may also -take a reference to the #GAsyncResult and call "_finish()" later; -however, the "_finish()" function may be called at most once. +take a reference to the `GAsyncResult` and call `_finish()` later; +however, the `_finish()` function may be called at most once. Example of a typical asynchronous operation flow: -|[<!-- language="C" --> + +```c void _theoretical_frobnitz_async (Theoretical *t, GCancellable *c, GAsyncReadyCallback cb, @@ -11303,85 +11621,81 @@ int main (int argc, void *argv[]) ... } -]| +``` The callback for an asynchronous operation is called only once, and is always called, even in the case of a cancelled operation. On cancellation -the result is a %G_IO_ERROR_CANCELLED error. +the result is a `G_IO_ERROR_CANCELLED` error. -## I/O Priority # {#io-priority} +## I/O Priority Many I/O-related asynchronous operations have a priority parameter, which is used in certain cases to determine the order in which operations are executed. They are not used to determine system-wide I/O scheduling. Priorities are integers, with lower numbers indicating higher priority. It is recommended to choose priorities between -%G_PRIORITY_LOW and %G_PRIORITY_HIGH, with %G_PRIORITY_DEFAULT +`G_PRIORITY_LOW` and `G_PRIORITY_HIGH`, with `G_PRIORITY_DEFAULT` as a default. - + Gets the source object from a #GAsyncResult. - + filename="gio/gasyncresult.c" + line="147">Gets the source object from a #GAsyncResult. + a new reference to the source + filename="gio/gasyncresult.c" + line="153">a new reference to the source object for the @res, or %NULL if there is none. a #GAsyncResult + filename="gio/gasyncresult.c" + line="149">a #GAsyncResult Gets the user data from a #GAsyncResult. - + filename="gio/gasyncresult.c" + line="127">Gets the user data from a #GAsyncResult. + the user data for @res. + filename="gio/gasyncresult.c" + line="133">the user data for @res. a #GAsyncResult. + filename="gio/gasyncresult.c" + line="129">a #GAsyncResult. Checks if @res has the given @source_tag (generally a function + filename="gio/gasyncresult.c" + line="210">Checks if @res has the given @source_tag (generally a function pointer indicating the function @res was created by). - + %TRUE if @res has the indicated @source_tag, %FALSE if + filename="gio/gasyncresult.c" + line="218">%TRUE if @res has the indicated @source_tag, %FALSE if not. a #GAsyncResult + filename="gio/gasyncresult.c" + line="212">a #GAsyncResult nullable="1" allow-none="1"> an application-defined tag + filename="gio/gasyncresult.c" + line="213">an application-defined tag @@ -11398,43 +11712,41 @@ pointer indicating the function @res was created by). Gets the source object from a #GAsyncResult. - + filename="gio/gasyncresult.c" + line="147">Gets the source object from a #GAsyncResult. + a new reference to the source + filename="gio/gasyncresult.c" + line="153">a new reference to the source object for the @res, or %NULL if there is none. a #GAsyncResult + filename="gio/gasyncresult.c" + line="149">a #GAsyncResult Gets the user data from a #GAsyncResult. - + filename="gio/gasyncresult.c" + line="127">Gets the user data from a #GAsyncResult. + the user data for @res. + filename="gio/gasyncresult.c" + line="133">the user data for @res. a #GAsyncResult. + filename="gio/gasyncresult.c" + line="129">a #GAsyncResult. @@ -11443,23 +11755,22 @@ pointer indicating the function @res was created by). c:identifier="g_async_result_is_tagged" version="2.34"> Checks if @res has the given @source_tag (generally a function + filename="gio/gasyncresult.c" + line="210">Checks if @res has the given @source_tag (generally a function pointer indicating the function @res was created by). - + %TRUE if @res has the indicated @source_tag, %FALSE if + filename="gio/gasyncresult.c" + line="218">%TRUE if @res has the indicated @source_tag, %FALSE if not. a #GAsyncResult + filename="gio/gasyncresult.c" + line="212">a #GAsyncResult nullable="1" allow-none="1"> an application-defined tag + filename="gio/gasyncresult.c" + line="213">an application-defined tag @@ -11478,8 +11789,8 @@ pointer indicating the function @res was created by). version="2.34" throws="1"> If @res is a #GSimpleAsyncResult, this is equivalent to + filename="gio/gasyncresult.c" + line="168">If @res is a #GSimpleAsyncResult, this is equivalent to g_simple_async_result_propagate_error(). Otherwise it returns %FALSE. @@ -11489,20 +11800,19 @@ error returns themselves rather than calling into the virtual method. This should not be used in new code; #GAsyncResult errors that are set by virtual methods should also be extracted by virtual methods, to enable subclasses to chain up correctly. - + %TRUE if @error is has been filled in with an error from + filename="gio/gasyncresult.c" + line="184">%TRUE if @error is has been filled in with an error from @res, %FALSE if not. a #GAsyncResult + filename="gio/gasyncresult.c" + line="170">a #GAsyncResult @@ -11512,73 +11822,78 @@ to enable subclasses to chain up correctly. c:type="GAsyncResultIface" glib:is-gtype-struct-for="AsyncResult"> Interface definition for #GAsyncResult. - + filename="gio/gasyncresult.h" + line="42">Interface definition for #GAsyncResult. + The parent interface. + filename="gio/gasyncresult.h" + line="44">The parent interface. + Gets the user data passed to the callback. - + the user data for @res. + filename="gio/gasyncresult.c" + line="133">the user data for @res. a #GAsyncResult. + filename="gio/gasyncresult.c" + line="129">a #GAsyncResult. + Gets the source object that issued the asynchronous operation. - + a new reference to the source + filename="gio/gasyncresult.c" + line="153">a new reference to the source object for the @res, or %NULL if there is none. a #GAsyncResult + filename="gio/gasyncresult.c" + line="149">a #GAsyncResult + Checks if a result is tagged with a particular source. - + %TRUE if @res has the indicated @source_tag, %FALSE if + filename="gio/gasyncresult.c" + line="218">%TRUE if @res has the indicated @source_tag, %FALSE if not. a #GAsyncResult + filename="gio/gasyncresult.c" + line="212">a #GAsyncResult nullable="1" allow-none="1"> an application-defined tag + filename="gio/gasyncresult.c" + line="213">an application-defined tag @@ -11597,8 +11912,7 @@ to enable subclasses to chain up correctly. - + @@ -11607,8 +11921,7 @@ to enable subclasses to chain up correctly. - + @@ -11617,8 +11930,7 @@ to enable subclasses to chain up correctly. - + @@ -11627,8 +11939,7 @@ to enable subclasses to chain up correctly. - + @@ -11637,8 +11948,7 @@ to enable subclasses to chain up correctly. - + @@ -11647,8 +11957,7 @@ to enable subclasses to chain up correctly. - + @@ -11657,8 +11966,7 @@ to enable subclasses to chain up correctly. - + @@ -11672,42 +11980,39 @@ to enable subclasses to chain up correctly. glib:get-type="g_buffered_input_stream_get_type" glib:type-struct="BufferedInputStreamClass"> Buffered input stream implements #GFilterInputStream and provides + filename="gio/gbufferedinputstream.c" + line="36">Buffered input stream implements #GFilterInputStream and provides for buffered reads. -By default, #GBufferedInputStream's buffer size is set at 4 kilobytes. +By default, `GBufferedInputStream`'s buffer size is set at 4 kilobytes. -To create a buffered input stream, use g_buffered_input_stream_new(), -or g_buffered_input_stream_new_sized() to specify the buffer's size at +To create a buffered input stream, use [ctor@Gio.BufferedInputStream.new], +or [ctor@Gio.BufferedInputStream.new_sized] to specify the buffer's size at construction. To get the size of a buffer within a buffered input stream, use -g_buffered_input_stream_get_buffer_size(). To change the size of a -buffered input stream's buffer, use -g_buffered_input_stream_set_buffer_size(). Note that the buffer's size -cannot be reduced below the size of the data within the buffer. - +[method@Gio.BufferedInputStream.get_buffer_size]. To change the size of a +buffered input stream's buffer, use [method@Gio.BufferedInputStream.set_buffer_size]. +Note that the buffer's size cannot be reduced below the size of the data within the buffer. + Creates a new #GInputStream from the given @base_stream, with + filename="gio/gbufferedinputstream.c" + line="320">Creates a new #GInputStream from the given @base_stream, with a buffer set to the default size (4 kilobytes). - + a #GInputStream for the given @base_stream. + filename="gio/gbufferedinputstream.c" + line="327">a #GInputStream for the given @base_stream. a #GInputStream + filename="gio/gbufferedinputstream.c" + line="322">a #GInputStream @@ -11715,36 +12020,38 @@ a buffer set to the default size (4 kilobytes). Creates a new #GBufferedInputStream from the given @base_stream, + filename="gio/gbufferedinputstream.c" + line="343">Creates a new #GBufferedInputStream from the given @base_stream, with a buffer set to @size. - + a #GInputStream. + filename="gio/gbufferedinputstream.c" + line="351">a #GInputStream. a #GInputStream + filename="gio/gbufferedinputstream.c" + line="345">a #GInputStream a #gsize + filename="gio/gbufferedinputstream.c" + line="346">a #gsize - + Tries to read @count bytes from the stream into the buffer. + filename="gio/gbufferedinputstream.c" + line="369">Tries to read @count bytes from the stream into the buffer. Will block during this read. If @count is zero, returns zero and does nothing. A value of @count @@ -11768,26 +12075,25 @@ On error -1 is returned and @error is set accordingly. For the asynchronous, non-blocking, version of this function, see g_buffered_input_stream_fill_async(). - + the number of bytes read into @stream's buffer, up to @count, + filename="gio/gbufferedinputstream.c" + line="401">the number of bytes read into @stream's buffer, up to @count, or -1 on error. a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="371">a #GBufferedInputStream the number of bytes that will be read from the stream + filename="gio/gbufferedinputstream.c" + line="372">the number of bytes that will be read from the stream nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gbufferedinputstream.c" + line="373">optional #GCancellable object, %NULL to ignore - + Reads data into @stream's buffer asynchronously, up to @count size. + filename="gio/gbufferedinputstream.c" + line="454">Reads data into @stream's buffer asynchronously, up to @count size. @io_priority can be used to prioritize reads. For the synchronous version of this function, see g_buffered_input_stream_fill(). If @count is -1 then the attempted read size is equal to the number of bytes that are required to fill the buffer. - + a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="456">a #GBufferedInputStream the number of bytes that will be read from the stream + filename="gio/gbufferedinputstream.c" + line="457">the number of bytes that will be read from the stream the [I/O priority][io-priority] of the request + filename="gio/gbufferedinputstream.c" + line="458">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object + filename="gio/gbufferedinputstream.c" + line="459">optional #GCancellable object scope="async" closure="4"> a #GAsyncReadyCallback + filename="gio/gbufferedinputstream.c" + line="460">a #GAsyncReadyCallback allow-none="1" closure="4"> a #gpointer + filename="gio/gbufferedinputstream.c" + line="461">a #gpointer Finishes an asynchronous read. - + filename="gio/gbufferedinputstream.c" + line="520">Finishes an asynchronous read. + a #gssize of the read stream, or `-1` on an error. + filename="gio/gbufferedinputstream.c" + line="528">a #gssize of the read stream, or `-1` on an error. a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="522">a #GBufferedInputStream a #GAsyncResult + filename="gio/gbufferedinputstream.c" + line="523">a #GAsyncResult + throws="1" + glib:async-func="fill_async"> Tries to read @count bytes from the stream into the buffer. + filename="gio/gbufferedinputstream.c" + line="369">Tries to read @count bytes from the stream into the buffer. Will block during this read. If @count is zero, returns zero and does nothing. A value of @count @@ -11922,26 +12230,25 @@ On error -1 is returned and @error is set accordingly. For the asynchronous, non-blocking, version of this function, see g_buffered_input_stream_fill_async(). - + the number of bytes read into @stream's buffer, up to @count, + filename="gio/gbufferedinputstream.c" + line="401">the number of bytes read into @stream's buffer, up to @count, or -1 on error. a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="371">a #GBufferedInputStream the number of bytes that will be read from the stream + filename="gio/gbufferedinputstream.c" + line="372">the number of bytes that will be read from the stream nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gbufferedinputstream.c" + line="373">optional #GCancellable object, %NULL to ignore + c:identifier="g_buffered_input_stream_fill_async" + glib:finish-func="fill_finish" + glib:sync-func="fill"> Reads data into @stream's buffer asynchronously, up to @count size. + filename="gio/gbufferedinputstream.c" + line="454">Reads data into @stream's buffer asynchronously, up to @count size. @io_priority can be used to prioritize reads. For the synchronous version of this function, see g_buffered_input_stream_fill(). If @count is -1 then the attempted read size is equal to the number of bytes that are required to fill the buffer. - + a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="456">a #GBufferedInputStream the number of bytes that will be read from the stream + filename="gio/gbufferedinputstream.c" + line="457">the number of bytes that will be read from the stream the [I/O priority][io-priority] of the request + filename="gio/gbufferedinputstream.c" + line="458">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object + filename="gio/gbufferedinputstream.c" + line="459">optional #GCancellable object scope="async" closure="4"> a #GAsyncReadyCallback + filename="gio/gbufferedinputstream.c" + line="460">a #GAsyncReadyCallback nullable="1" allow-none="1"> a #gpointer + filename="gio/gbufferedinputstream.c" + line="461">a #gpointer @@ -12024,27 +12332,26 @@ of bytes that are required to fill the buffer. c:identifier="g_buffered_input_stream_fill_finish" throws="1"> Finishes an asynchronous read. - + filename="gio/gbufferedinputstream.c" + line="520">Finishes an asynchronous read. + a #gssize of the read stream, or `-1` on an error. + filename="gio/gbufferedinputstream.c" + line="528">a #gssize of the read stream, or `-1` on an error. a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="522">a #GBufferedInputStream a #GAsyncResult + filename="gio/gbufferedinputstream.c" + line="523">a #GAsyncResult @@ -12052,21 +12359,20 @@ of bytes that are required to fill the buffer. Gets the size of the available data within the stream. - + filename="gio/gbufferedinputstream.c" + line="549">Gets the size of the available data within the stream. + size of the available stream. + filename="gio/gbufferedinputstream.c" + line="555">size of the available stream. #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="551">#GBufferedInputStream @@ -12075,49 +12381,47 @@ of bytes that are required to fill the buffer. c:identifier="g_buffered_input_stream_get_buffer_size" glib:get-property="buffer-size"> Gets the size of the input buffer. - + filename="gio/gbufferedinputstream.c" + line="177">Gets the size of the input buffer. + the current buffer size. + filename="gio/gbufferedinputstream.c" + line="183">the current buffer size. a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="179">a #GBufferedInputStream Peeks in the buffer, copying data of size @count into @buffer, + filename="gio/gbufferedinputstream.c" + line="565">Peeks in the buffer, copying data of size @count into @buffer, offset @offset bytes. - + a #gsize of the number of bytes peeked, or -1 on error. + filename="gio/gbufferedinputstream.c" + line="576">a #gsize of the number of bytes peeked, or -1 on error. a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="567">a #GBufferedInputStream a pointer to + filename="gio/gbufferedinputstream.c" + line="568">a pointer to an allocated chunk of memory @@ -12125,14 +12429,14 @@ offset @offset bytes. a #gsize + filename="gio/gbufferedinputstream.c" + line="570">a #gsize a #gsize + filename="gio/gbufferedinputstream.c" + line="571">a #gsize @@ -12140,16 +12444,15 @@ offset @offset bytes. Returns the buffer with the currently available bytes. The returned + filename="gio/gbufferedinputstream.c" + line="602">Returns the buffer with the currently available bytes. The returned buffer must not be modified and will become invalid when reading from the stream or filling the buffer. - + + filename="gio/gbufferedinputstream.c" + line="611"> read-only buffer @@ -12158,8 +12461,8 @@ the stream or filling the buffer. a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="604">a #GBufferedInputStream caller-allocates="0" transfer-ownership="full"> a #gsize to get the number of bytes available in the buffer + filename="gio/gbufferedinputstream.c" + line="605">a #gsize to get the number of bytes available in the buffer @@ -12177,8 +12480,8 @@ the stream or filling the buffer. c:identifier="g_buffered_input_stream_read_byte" throws="1"> Tries to read a single byte from the stream or the buffer. Will block + filename="gio/gbufferedinputstream.c" + line="943">Tries to read a single byte from the stream or the buffer. Will block during this read. On success, the byte read from the stream is returned. On end of stream @@ -12191,19 +12494,18 @@ operation was partially finished when the operation was cancelled the partial result will be returned, without an error. On error -1 is returned and @error is set accordingly. - + the byte read from the @stream, or -1 on end of stream or error. + filename="gio/gbufferedinputstream.c" + line="963">the byte read from the @stream, or -1 on end of stream or error. a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="945">a #GBufferedInputStream nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gbufferedinputstream.c" + line="946">optional #GCancellable object, %NULL to ignore @@ -12221,26 +12523,25 @@ On error -1 is returned and @error is set accordingly. c:identifier="g_buffered_input_stream_set_buffer_size" glib:set-property="buffer-size"> Sets the size of the internal buffer of @stream to @size, or to the + filename="gio/gbufferedinputstream.c" + line="193">Sets the size of the internal buffer of @stream to @size, or to the size of the contents of the buffer. The buffer can never be resized smaller than its current contents. - + a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="195">a #GBufferedInputStream a #gsize + filename="gio/gbufferedinputstream.c" + line="196">a #gsize @@ -12252,6 +12553,9 @@ smaller than its current contents. setter="set_buffer_size" getter="get_buffer_size" default-value="4096"> + The size of the backend buffer, in bytes. @@ -12265,33 +12569,31 @@ smaller than its current contents. - + - + the number of bytes read into @stream's buffer, up to @count, + filename="gio/gbufferedinputstream.c" + line="401">the number of bytes read into @stream's buffer, up to @count, or -1 on error. a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="371">a #GBufferedInputStream the number of bytes that will be read from the stream + filename="gio/gbufferedinputstream.c" + line="372">the number of bytes that will be read from the stream nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gbufferedinputstream.c" + line="373">optional #GCancellable object, %NULL to ignore @@ -12308,28 +12610,27 @@ smaller than its current contents. - + a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="456">a #GBufferedInputStream the number of bytes that will be read from the stream + filename="gio/gbufferedinputstream.c" + line="457">the number of bytes that will be read from the stream the [I/O priority][io-priority] of the request + filename="gio/gbufferedinputstream.c" + line="458">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object + filename="gio/gbufferedinputstream.c" + line="459">optional #GCancellable object scope="async" closure="5"> a #GAsyncReadyCallback + filename="gio/gbufferedinputstream.c" + line="460">a #GAsyncReadyCallback allow-none="1" closure="5"> a #gpointer + filename="gio/gbufferedinputstream.c" + line="461">a #gpointer @@ -12367,25 +12668,24 @@ smaller than its current contents. - + a #gssize of the read stream, or `-1` on an error. + filename="gio/gbufferedinputstream.c" + line="528">a #gssize of the read stream, or `-1` on an error. a #GBufferedInputStream + filename="gio/gbufferedinputstream.c" + line="522">a #GBufferedInputStream a #GAsyncResult + filename="gio/gbufferedinputstream.c" + line="523">a #GAsyncResult @@ -12393,8 +12693,7 @@ smaller than its current contents. - + @@ -12402,8 +12701,7 @@ smaller than its current contents. - + @@ -12411,8 +12709,7 @@ smaller than its current contents. - + @@ -12420,8 +12717,7 @@ smaller than its current contents. - + @@ -12429,8 +12725,7 @@ smaller than its current contents. - + @@ -12441,8 +12736,7 @@ smaller than its current contents. c:type="GBufferedInputStreamPrivate" disguised="1" opaque="1"> - + glib:get-type="g_buffered_output_stream_get_type" glib:type-struct="BufferedOutputStreamClass"> Buffered output stream implements #GFilterOutputStream and provides + filename="gio/gbufferedoutputstream.c" + line="32">Buffered output stream implements [class@Gio.FilterOutputStream] and provides for buffered writes. -By default, #GBufferedOutputStream's buffer size is set at 4 kilobytes. +By default, `GBufferedOutputStream`'s buffer size is set at 4 kilobytes. -To create a buffered output stream, use g_buffered_output_stream_new(), -or g_buffered_output_stream_new_sized() to specify the buffer's size +To create a buffered output stream, use [ctor@Gio.BufferedOutputStream.new], +or [ctor@Gio.BufferedOutputStream.new_sized] to specify the buffer's size at construction. To get the size of a buffer within a buffered input stream, use -g_buffered_output_stream_get_buffer_size(). To change the size of a -buffered output stream's buffer, use -g_buffered_output_stream_set_buffer_size(). Note that the buffer's -size cannot be reduced below the size of the data within the buffer. - +[method@Gio.BufferedOutputStream.get_buffer_size]. To change the size of a +buffered output stream's buffer, use [method@Gio.BufferedOutputStream.set_buffer_size]. +Note that the buffer's size cannot be reduced below the size of the data within the buffer. + Creates a new buffered output stream for a base stream. - + filename="gio/gbufferedoutputstream.c" + line="362">Creates a new buffered output stream for a base stream. + a #GOutputStream for the given @base_stream. + filename="gio/gbufferedoutputstream.c" + line="368">a #GOutputStream for the given @base_stream. a #GOutputStream. + filename="gio/gbufferedoutputstream.c" + line="364">a #GOutputStream. @@ -12494,27 +12785,26 @@ size cannot be reduced below the size of the data within the buffer. Creates a new buffered output stream with a given buffer size. - + filename="gio/gbufferedoutputstream.c" + line="384">Creates a new buffered output stream with a given buffer size. + a #GOutputStream with an internal buffer set to @size. + filename="gio/gbufferedoutputstream.c" + line="391">a #GOutputStream with an internal buffer set to @size. a #GOutputStream. + filename="gio/gbufferedoutputstream.c" + line="386">a #GOutputStream. a #gsize. + filename="gio/gbufferedoutputstream.c" + line="387">a #gsize. @@ -12523,22 +12813,21 @@ size cannot be reduced below the size of the data within the buffer. c:identifier="g_buffered_output_stream_get_auto_grow" glib:get-property="auto-grow"> Checks if the buffer automatically grows as data is added. - + filename="gio/gbufferedoutputstream.c" + line="234">Checks if the buffer automatically grows as data is added. + %TRUE if the @stream's buffer automatically grows, + filename="gio/gbufferedoutputstream.c" + line="240">%TRUE if the @stream's buffer automatically grows, %FALSE otherwise. a #GBufferedOutputStream. + filename="gio/gbufferedoutputstream.c" + line="236">a #GBufferedOutputStream. @@ -12547,21 +12836,20 @@ size cannot be reduced below the size of the data within the buffer. c:identifier="g_buffered_output_stream_get_buffer_size" glib:get-property="buffer-size"> Gets the size of the buffer in the @stream. - + filename="gio/gbufferedoutputstream.c" + line="176">Gets the size of the buffer in the @stream. + the current size of the buffer. + filename="gio/gbufferedoutputstream.c" + line="182">the current size of the buffer. a #GBufferedOutputStream. + filename="gio/gbufferedoutputstream.c" + line="178">a #GBufferedOutputStream. @@ -12570,27 +12858,26 @@ size cannot be reduced below the size of the data within the buffer. c:identifier="g_buffered_output_stream_set_auto_grow" glib:set-property="auto-grow"> Sets whether or not the @stream's buffer should automatically grow. + filename="gio/gbufferedoutputstream.c" + line="251">Sets whether or not the @stream's buffer should automatically grow. If @auto_grow is true, then each write will just make the buffer larger, and you must manually flush the buffer to actually write out the data to the underlying stream. - + a #GBufferedOutputStream. + filename="gio/gbufferedoutputstream.c" + line="253">a #GBufferedOutputStream. a #gboolean. + filename="gio/gbufferedoutputstream.c" + line="254">a #gboolean. @@ -12599,24 +12886,23 @@ the data to the underlying stream. c:identifier="g_buffered_output_stream_set_buffer_size" glib:set-property="buffer-size"> Sets the size of the internal buffer to @size. - + filename="gio/gbufferedoutputstream.c" + line="192">Sets the size of the internal buffer to @size. + a #GBufferedOutputStream. + filename="gio/gbufferedoutputstream.c" + line="194">a #GBufferedOutputStream. a #gsize. + filename="gio/gbufferedoutputstream.c" + line="195">a #gsize. @@ -12627,6 +12913,9 @@ the data to the underlying stream. setter="set_auto_grow" getter="get_auto_grow" default-value="FALSE"> + Whether the buffer should automatically grow. setter="set_buffer_size" getter="get_buffer_size" default-value="4096"> + The size of the backend buffer, in bytes. @@ -12649,16 +12941,14 @@ the data to the underlying stream. - + - + @@ -12666,8 +12956,7 @@ the data to the underlying stream. - + @@ -12678,30 +12967,28 @@ the data to the underlying stream. c:type="GBufferedOutputStreamPrivate" disguised="1" opaque="1"> - + Invoked when a connection to a message bus has been obtained. - + The #GDBusConnection to a message bus. The name that is requested to be owned. @@ -12711,7 +12998,7 @@ the data to the underlying stream. allow-none="1" closure="2"> User data passed to g_bus_own_name(). @@ -12721,23 +13008,22 @@ the data to the underlying stream. c:type="GBusNameAcquiredCallback" version="2.26"> Invoked when the name is acquired. - + The #GDBusConnection on which to acquired the name. The name being owned. @@ -12747,7 +13033,7 @@ the data to the underlying stream. allow-none="1" closure="2"> User data passed to g_bus_own_name() or g_bus_own_name_on_connection(). @@ -12757,29 +13043,28 @@ the data to the underlying stream. c:type="GBusNameAppearedCallback" version="2.26"> Invoked when the name being watched is known to have to have an owner. - + The #GDBusConnection the name is being watched on. The name being watched. Unique name of the owner of the name being watched. @@ -12789,7 +13074,7 @@ the data to the underlying stream. allow-none="1" closure="3"> User data passed to g_bus_watch_name(). @@ -12799,24 +13084,23 @@ the data to the underlying stream. c:type="GBusNameLostCallback" version="2.26"> Invoked when the name is lost or @connection has been closed. - + The #GDBusConnection on which to acquire the name or %NULL if the connection was disconnected. The name being owned. @@ -12826,7 +13110,7 @@ the connection was disconnected. allow-none="1" closure="2"> User data passed to g_bus_own_name() or g_bus_own_name_on_connection(). @@ -12838,16 +13122,16 @@ the connection was disconnected. glib:get-type="g_bus_name_owner_flags_get_type" c:type="GBusNameOwnerFlags"> Flags used in g_bus_own_name(). + filename="gio/gioenums.h" + line="984">Flags used in g_bus_own_name(). No flags set. + filename="gio/gioenums.h" + line="986">No flags set. glib:nick="allow-replacement" glib:name="G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT"> Allow another message bus connection to claim the name. + filename="gio/gioenums.h" + line="987">Allow another message bus connection to claim the name. glib:nick="replace" glib:name="G_BUS_NAME_OWNER_FLAGS_REPLACE"> If another message bus connection owns the name and have + filename="gio/gioenums.h" + line="988">If another message bus connection owns the name and have specified %G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT, then take the name from the other connection. If another message bus connection owns the name, immediately + filename="gio/gioenums.h" + line="990">If another message bus connection owns the name, immediately return an error from g_bus_own_name() rather than entering the waiting queue for that name. (Since 2.54) @@ -12883,28 +13167,27 @@ return an error from g_bus_own_name() rather than entering the waiting queue for c:type="GBusNameVanishedCallback" version="2.26"> Invoked when the name being watched is known not to have to have an owner. This is also invoked when the #GDBusConnection on which the watch was established has been closed. In that case, @connection will be %NULL. - + The #GDBusConnection the name is being watched on, or %NULL. The name being watched. @@ -12914,7 +13197,7 @@ established has been closed. In that case, @connection will be allow-none="1" closure="2"> User data passed to g_bus_watch_name(). @@ -12926,16 +13209,16 @@ established has been closed. In that case, @connection will be glib:get-type="g_bus_name_watcher_flags_get_type" c:type="GBusNameWatcherFlags"> Flags used in g_bus_watch_name(). + filename="gio/gioenums.h" + line="1007">Flags used in g_bus_watch_name(). No flags set. + filename="gio/gioenums.h" + line="1009">No flags set. If no-one owns the name when + filename="gio/gioenums.h" + line="1010">If no-one owns the name when beginning to watch the name, ask the bus to launch an owner for the name. @@ -12955,16 +13238,16 @@ name. glib:get-type="g_bus_type_get_type" c:type="GBusType"> An enumeration for well-known message buses. + filename="gio/gioenums.h" + line="965">An enumeration for well-known message buses. An alias for the message bus that activated the process, if any. + filename="gio/gioenums.h" + line="967">An alias for the message bus that activated the process, if any. glib:nick="none" glib:name="G_BUS_TYPE_NONE"> Not a message bus. + filename="gio/gioenums.h" + line="968">Not a message bus. glib:nick="system" glib:name="G_BUS_TYPE_SYSTEM"> The system-wide message bus. + filename="gio/gioenums.h" + line="969">The system-wide message bus. glib:nick="session" glib:name="G_BUS_TYPE_SESSION"> The login session message bus. + filename="gio/gioenums.h" + line="970">The login session message bus. glib:type-name="GBytesIcon" glib:get-type="g_bytes_icon_get_type"> #GBytesIcon specifies an image held in memory in a common format (usually -png) to be used as icon. + filename="gio/gbytesicon.c" + line="35">`GBytesIcon` specifies an image held in memory in a common format (usually +PNG) to be used as icon. Creates a new icon for a bytes. + filename="gio/gbytesicon.c" + line="140">Creates a new icon for a bytes. This cannot fail, but loading and interpreting the bytes may fail later on (for example, if g_loadable_icon_load() is called) if the image is invalid. - + a #GIcon for the given + filename="gio/gbytesicon.c" + line="149">a #GIcon for the given @bytes. a #GBytes. + filename="gio/gbytesicon.c" + line="142">a #GBytes. @@ -13037,21 +13319,20 @@ This cannot fail, but loading and interpreting the bytes may fail later on glib:get-property="bytes" version="2.38"> Gets the #GBytes associated with the given @icon. - + filename="gio/gbytesicon.c" + line="162">Gets the #GBytes associated with the given @icon. + a #GBytes. + filename="gio/gbytesicon.c" + line="168">a #GBytes. a #GIcon. + filename="gio/gbytesicon.c" + line="164">a #GIcon. @@ -13062,16 +13343,15 @@ This cannot fail, but loading and interpreting the bytes may fail later on transfer-ownership="none" getter="get_bytes"> The bytes containing the icon. + filename="gio/gbytesicon.c" + line="124">The bytes containing the icon. - + @@ -13080,8 +13360,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13090,8 +13369,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13100,8 +13378,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13110,8 +13387,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13120,8 +13396,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13130,8 +13405,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13140,8 +13414,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13150,8 +13423,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13160,8 +13432,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13170,8 +13441,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13180,8 +13450,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13190,8 +13459,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13200,8 +13468,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13210,8 +13477,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13220,8 +13486,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13230,8 +13495,7 @@ This cannot fail, but loading and interpreting the bytes may fail later on - + @@ -13245,16 +13509,17 @@ This cannot fail, but loading and interpreting the bytes may fail later on glib:get-type="g_cancellable_get_type" glib:type-struct="CancellableClass"> GCancellable is a thread-safe operation cancellation stack used + filename="gio/gcancellable.c" + line="31">`GCancellable` allows operations to be cancelled. + +`GCancellable` is a thread-safe operation cancellation stack used throughout GIO to allow for cancellation of synchronous and asynchronous operations. - + Creates a new #GCancellable object. + filename="gio/gcancellable.c" + line="159">Creates a new #GCancellable object. Applications that want to start one or more operations that should be cancellable should create a #GCancellable @@ -13262,32 +13527,29 @@ and pass it to the operations. One #GCancellable can be used in multiple consecutive operations or in multiple concurrent operations. - + a #GCancellable. + filename="gio/gcancellable.c" + line="171">a #GCancellable. Gets the top cancellable from the stack. - + filename="gio/gcancellable.c" + line="225">Gets the top cancellable from the stack. + a #GCancellable from the top + filename="gio/gcancellable.c" + line="230">a #GCancellable from the top of the stack, or %NULL if the stack is empty. - + @@ -13302,8 +13564,8 @@ of the stack, or %NULL if the stack is empty. Will set @cancellable to cancelled, and will emit the + filename="gio/gcancellable.c" + line="472">Will set @cancellable to cancelled, and will emit the #GCancellable::cancelled signal. (However, see the warning about race conditions in the documentation for that signal if you are planning to connect to it.) @@ -13319,8 +13581,7 @@ operation causes it to complete asynchronously. That is, if you cancel the operation from the same thread in which it is running, then the operation's #GAsyncReadyCallback will not be invoked until the application returns to the main loop. - + @@ -13330,8 +13591,8 @@ the application returns to the main loop. nullable="1" allow-none="1"> a #GCancellable object. + filename="gio/gcancellable.c" + line="474">a #GCancellable object. @@ -13340,8 +13601,8 @@ the application returns to the main loop. c:identifier="g_cancellable_connect" version="2.22"> Convenience function to connect to the #GCancellable::cancelled + filename="gio/gcancellable.c" + line="533">Convenience function to connect to the #GCancellable::cancelled signal. Also handles the race condition that may happen if the cancellable is cancelled right before connecting. @@ -13359,12 +13620,11 @@ Since GLib 2.40, the lock protecting @cancellable is not held when @callback is invoked. This lifts a restriction in place for earlier GLib versions which now makes it easier to write cleanup code that unconditionally invokes e.g. g_cancellable_cancel(). - + The id of the signal handler or 0 if @cancellable has already + filename="gio/gcancellable.c" + line="559">The id of the signal handler or 0 if @cancellable has already been cancelled. @@ -13374,8 +13634,8 @@ code that unconditionally invokes e.g. g_cancellable_cancel(). nullable="1" allow-none="1"> A #GCancellable. + filename="gio/gcancellable.c" + line="535">A #GCancellable. closure="1" destroy="2"> The #GCallback to connect. + filename="gio/gcancellable.c" + line="536">The #GCallback to connect. nullable="1" allow-none="1"> Data to pass to @callback. + filename="gio/gcancellable.c" + line="537">Data to pass to @callback. allow-none="1" scope="async"> Free function for @data or %NULL. + filename="gio/gcancellable.c" + line="538">Free function for @data or %NULL. @@ -13413,8 +13673,8 @@ code that unconditionally invokes e.g. g_cancellable_cancel(). c:identifier="g_cancellable_disconnect" version="2.22"> Disconnects a handler from a cancellable instance similar to + filename="gio/gcancellable.c" + line="616">Disconnects a handler from a cancellable instance similar to g_signal_handler_disconnect(). Additionally, in the event that a signal handler is currently running, this call will block until the handler has finished. Calling this function from a @@ -13428,8 +13688,7 @@ details on how to use this. If @cancellable is %NULL or @handler_id is `0` this function does nothing. - + @@ -13439,22 +13698,22 @@ nothing. nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="gio/gcancellable.c" + line="618">A #GCancellable or %NULL. Handler id of the handler to be disconnected, or `0`. + filename="gio/gcancellable.c" + line="619">Handler id of the handler to be disconnected, or `0`. Gets the file descriptor for a cancellable job. This can be used to + filename="gio/gcancellable.c" + line="333">Gets the file descriptor for a cancellable job. This can be used to implement cancellable operations on Unix systems. The returned fd will turn readable when @cancellable is cancelled. @@ -13467,12 +13726,11 @@ g_cancellable_release_fd() to free up resources allocated for the returned file descriptor. See also g_cancellable_make_pollfd(). - + A valid file descriptor. `-1` if the file descriptor + filename="gio/gcancellable.c" + line="351">A valid file descriptor. `-1` if the file descriptor is not supported, or on errors. @@ -13482,22 +13740,21 @@ is not supported, or on errors. nullable="1" allow-none="1"> a #GCancellable. + filename="gio/gcancellable.c" + line="335">a #GCancellable. Checks if a cancellable job has been cancelled. - + filename="gio/gcancellable.c" + line="292">Checks if a cancellable job has been cancelled. + %TRUE if @cancellable is cancelled, + filename="gio/gcancellable.c" + line="298">%TRUE if @cancellable is cancelled, FALSE if called with %NULL or if item is not cancelled. @@ -13507,8 +13764,8 @@ FALSE if called with %NULL or if item is not cancelled. nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gcancellable.c" + line="294">a #GCancellable or %NULL @@ -13517,8 +13774,8 @@ FALSE if called with %NULL or if item is not cancelled. c:identifier="g_cancellable_make_pollfd" version="2.22"> Creates a #GPollFD corresponding to @cancellable; this can be passed + filename="gio/gcancellable.c" + line="375">Creates a #GPollFD corresponding to @cancellable; this can be passed to g_poll() and used to poll for cancellation. This is useful both for unix systems without a native poll and for portability to windows. @@ -13536,12 +13793,11 @@ these cases is to ignore the @cancellable. You are not supposed to read from the fd yourself, just check for readable status. Reading to unset the readable status is done with g_cancellable_reset(). - + %TRUE if @pollfd was successfully initialized, %FALSE on + filename="gio/gcancellable.c" + line="399">%TRUE if @pollfd was successfully initialized, %FALSE on failure to prepare the cancellable. @@ -13551,25 +13807,24 @@ with g_cancellable_reset(). nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gcancellable.c" + line="377">a #GCancellable or %NULL a pointer to a #GPollFD + filename="gio/gcancellable.c" + line="378">a pointer to a #GPollFD Pops @cancellable off the cancellable stack (verifying that @cancellable + filename="gio/gcancellable.c" + line="204">Pops @cancellable off the cancellable stack (verifying that @cancellable is on the top of the stack). - + @@ -13579,16 +13834,16 @@ is on the top of the stack). nullable="1" allow-none="1"> a #GCancellable object + filename="gio/gcancellable.c" + line="206">a #GCancellable object Pushes @cancellable onto the cancellable stack. The current + filename="gio/gcancellable.c" + line="179">Pushes @cancellable onto the cancellable stack. The current cancellable can then be received using g_cancellable_get_current(). This is useful when implementing cancellable operations in @@ -13596,8 +13851,7 @@ code that does not allow you to pass down the cancellable object. This is typically called automatically by e.g. #GFile operations, so you rarely have to call this yourself. - + @@ -13607,8 +13861,8 @@ so you rarely have to call this yourself. nullable="1" allow-none="1"> a #GCancellable object + filename="gio/gcancellable.c" + line="181">a #GCancellable object @@ -13617,8 +13871,8 @@ so you rarely have to call this yourself. c:identifier="g_cancellable_release_fd" version="2.22"> Releases a resources previously allocated by g_cancellable_get_fd() + filename="gio/gcancellable.c" + line="431">Releases a resources previously allocated by g_cancellable_get_fd() or g_cancellable_make_pollfd(). For compatibility reasons with older releases, calling this function @@ -13627,8 +13881,7 @@ when the @cancellable is finalized. However, the @cancellable will block scarce file descriptors until it is finalized if this function is not called. This can cause the application to run out of file descriptors when many #GCancellables are used at the same time. - + @@ -13638,16 +13891,16 @@ descriptors when many #GCancellables are used at the same time. nullable="1" allow-none="1"> a #GCancellable + filename="gio/gcancellable.c" + line="433">a #GCancellable Resets @cancellable to its uncancelled state. + filename="gio/gcancellable.c" + line="245">Resets @cancellable to its uncancelled state. If cancellable is currently in use by any cancellable operation then the behavior of this function is undefined. @@ -13658,8 +13911,7 @@ as this function might tempt you to do. The recommended practice is to drop the reference to a cancellable after cancelling it, and let it die with the outstanding async operations. You should create a fresh cancellable for further async operations. - + @@ -13669,8 +13921,8 @@ create a fresh cancellable for further async operations. nullable="1" allow-none="1"> a #GCancellable object. + filename="gio/gcancellable.c" + line="247">a #GCancellable object. @@ -13679,15 +13931,14 @@ create a fresh cancellable for further async operations. c:identifier="g_cancellable_set_error_if_cancelled" throws="1"> If the @cancellable is cancelled, sets the error to notify + filename="gio/gcancellable.c" + line="307">If the @cancellable is cancelled, sets the error to notify that the operation was cancelled. - + %TRUE if @cancellable was cancelled, %FALSE if it was not + filename="gio/gcancellable.c" + line="315">%TRUE if @cancellable was cancelled, %FALSE if it was not @@ -13696,8 +13947,8 @@ that the operation was cancelled. nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gcancellable.c" + line="309">a #GCancellable or %NULL @@ -13706,8 +13957,8 @@ that the operation was cancelled. c:identifier="g_cancellable_source_new" version="2.28"> Creates a source that triggers if @cancellable is cancelled and + filename="gio/gcancellable.c" + line="798">Creates a source that triggers if @cancellable is cancelled and calls its callback of type #GCancellableSourceFunc. This is primarily useful for attaching to another (non-cancellable) source with g_source_add_child_source() to add cancellability to it. @@ -13716,12 +13967,11 @@ For convenience, you can call this with a %NULL #GCancellable, in which case the source will never trigger. The new #GSource will hold a reference to the #GCancellable. - + the new #GSource. + filename="gio/gcancellable.c" + line="812">the new #GSource. @@ -13730,8 +13980,8 @@ The new #GSource will hold a reference to the #GCancellable. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gcancellable.c" + line="800">a #GCancellable, or %NULL @@ -13744,8 +13994,8 @@ The new #GSource will hold a reference to the #GCancellable. Emitted when the operation has been cancelled. + filename="gio/gcancellable.c" + line="86">Emitted when the operation has been cancelled. Can be used by implementations of cancellable operations. If the operation is cancelled from another thread, the signal will be @@ -13804,15 +14054,13 @@ cancellable signal should not do something that can block. - + - + @@ -13828,8 +14076,7 @@ cancellable signal should not do something that can block. - + @@ -13837,8 +14084,7 @@ cancellable signal should not do something that can block. - + @@ -13846,8 +14092,7 @@ cancellable signal should not do something that can block. - + @@ -13855,8 +14100,7 @@ cancellable signal should not do something that can block. - + @@ -13864,8 +14108,7 @@ cancellable signal should not do something that can block. - + @@ -13876,22 +14119,20 @@ cancellable signal should not do something that can block. c:type="GCancellablePrivate" disguised="1" opaque="1"> - + This is the function type of the callback used for the #GSource + filename="gio/giotypes.h" + line="484">This is the function type of the callback used for the #GSource returned by g_cancellable_source_new(). - + it should return %FALSE if the source should be removed. + filename="gio/giotypes.h" + line="492">it should return %FALSE if the source should be removed. @@ -13900,8 +14141,8 @@ returned by g_cancellable_source_new(). nullable="1" allow-none="1"> the #GCancellable + filename="gio/giotypes.h" + line="486">the #GCancellable nullable="1" allow-none="1"> data passed in by the user. + filename="gio/giotypes.h" + line="487">data passed in by the user. @@ -13923,11 +14164,10 @@ returned by g_cancellable_source_new(). glib:get-type="g_charset_converter_get_type" glib:type-struct="CharsetConverterClass"> #GCharsetConverter is an implementation of #GConverter based on -GIConv. - + filename="gio/gcharsetconverter.c" + line="41">`GCharsetConverter` is an implementation of [iface@Gio.Converter] based on +[struct@GLib.IConv]. + version="2.24" throws="1"> Creates a new #GCharsetConverter. - + filename="gio/gcharsetconverter.c" + line="205">Creates a new #GCharsetConverter. + a new #GCharsetConverter or %NULL on error. + filename="gio/gcharsetconverter.c" + line="213">a new #GCharsetConverter or %NULL on error. destination charset + filename="gio/gcharsetconverter.c" + line="207">destination charset source charset + filename="gio/gcharsetconverter.c" + line="208">source charset @@ -13964,21 +14203,20 @@ GIConv. c:identifier="g_charset_converter_get_num_fallbacks" version="2.24"> Gets the number of fallbacks that @converter has applied so far. - + filename="gio/gcharsetconverter.c" + line="419">Gets the number of fallbacks that @converter has applied so far. + the number of fallbacks that @converter has applied + filename="gio/gcharsetconverter.c" + line="425">the number of fallbacks that @converter has applied a #GCharsetConverter + filename="gio/gcharsetconverter.c" + line="421">a #GCharsetConverter @@ -13988,21 +14226,20 @@ GIConv. glib:get-property="use-fallback" version="2.24"> Gets the #GCharsetConverter:use-fallback property. - + filename="gio/gcharsetconverter.c" + line="403">Gets the #GCharsetConverter:use-fallback property. + %TRUE if fallbacks are used by @converter + filename="gio/gcharsetconverter.c" + line="409">%TRUE if fallbacks are used by @converter a #GCharsetConverter + filename="gio/gcharsetconverter.c" + line="405">a #GCharsetConverter @@ -14012,57 +14249,67 @@ GIConv. glib:set-property="use-fallback" version="2.24"> Sets the #GCharsetConverter:use-fallback property. - + filename="gio/gcharsetconverter.c" + line="381">Sets the #GCharsetConverter:use-fallback property. + a #GCharsetConverter + filename="gio/gcharsetconverter.c" + line="383">a #GCharsetConverter %TRUE to use fallbacks + filename="gio/gcharsetconverter.c" + line="384">%TRUE to use fallbacks + The character encoding to convert from. + The character encoding to convert to. + Use fallback (of form `\<hexval>`) for invalid bytes. - + @@ -14075,23 +14322,24 @@ GIConv. glib:get-type="g_converter_get_type" glib:type-struct="ConverterIface"> #GConverter is implemented by objects that convert + filename="gio/gconverter.c" + line="28">`GConverter` is an interface for streaming conversions. + +`GConverter` is implemented by objects that convert binary data in various ways. The conversion can be stateful and may fail at any place. Some example conversions are: character set conversion, compression, decompression and regular expression replace. - + This is the main operation used when converting data. It is to be called + filename="gio/gconverter.c" + line="53">This is the main operation used when converting data. It is to be called multiple times in a loop, and each time it will do some work, i.e. producing some output (in @outbuf) or consuming some input (from @inbuf) or both. If its not possible to do any work an error is returned. @@ -14173,19 +14421,18 @@ Flushing is not always possible (like if a charset converter flushes at a partial multibyte sequence). Converters are supposed to try to produce as much output as possible and then return an error (typically %G_IO_ERROR_PARTIAL_INPUT). - + a #GConverterResult, %G_CONVERTER_ERROR on error. + filename="gio/gconverter.c" + line="152">a #GConverterResult, %G_CONVERTER_ERROR on error. a #GConverter. + filename="gio/gconverter.c" + line="55">a #GConverter. the buffer + filename="gio/gconverter.c" + line="56">the buffer containing the data to convert. @@ -14202,14 +14449,14 @@ to produce as much output as possible and then return an error the number of bytes in @inbuf + filename="gio/gconverter.c" + line="58">the number of bytes in @inbuf a + filename="gio/gconverter.c" + line="59">a buffer to write converted data in. @@ -14217,14 +14464,14 @@ to produce as much output as possible and then return an error the number of bytes in @outbuf, must be at least one + filename="gio/gconverter.c" + line="61">the number of bytes in @outbuf, must be at least one a #GConverterFlags controlling the conversion details + filename="gio/gconverter.c" + line="62">a #GConverterFlags controlling the conversion details will be set to the number of bytes read + filename="gio/gconverter.c" + line="63">will be set to the number of bytes read from @inbuf on success @@ -14242,8 +14489,8 @@ to produce as much output as possible and then return an error caller-allocates="0" transfer-ownership="full"> will be set to the number of bytes + filename="gio/gconverter.c" + line="65">will be set to the number of bytes written to @outbuf on success @@ -14251,20 +14498,19 @@ to produce as much output as possible and then return an error Resets all internal state in the converter, making it behave + filename="gio/gconverter.c" + line="189">Resets all internal state in the converter, making it behave as if it was just created. If the converter has any internal state that would produce output then that output is lost. - + a #GConverter. + filename="gio/gconverter.c" + line="191">a #GConverter. @@ -14274,8 +14520,8 @@ state that would produce output then that output is lost. version="2.24" throws="1"> This is the main operation used when converting data. It is to be called + filename="gio/gconverter.c" + line="53">This is the main operation used when converting data. It is to be called multiple times in a loop, and each time it will do some work, i.e. producing some output (in @outbuf) or consuming some input (from @inbuf) or both. If its not possible to do any work an error is returned. @@ -14357,25 +14603,24 @@ Flushing is not always possible (like if a charset converter flushes at a partial multibyte sequence). Converters are supposed to try to produce as much output as possible and then return an error (typically %G_IO_ERROR_PARTIAL_INPUT). - + a #GConverterResult, %G_CONVERTER_ERROR on error. + filename="gio/gconverter.c" + line="152">a #GConverterResult, %G_CONVERTER_ERROR on error. a #GConverter. + filename="gio/gconverter.c" + line="55">a #GConverter. the buffer + filename="gio/gconverter.c" + line="56">the buffer containing the data to convert. @@ -14383,14 +14628,14 @@ to produce as much output as possible and then return an error the number of bytes in @inbuf + filename="gio/gconverter.c" + line="58">the number of bytes in @inbuf a + filename="gio/gconverter.c" + line="59">a buffer to write converted data in. @@ -14398,14 +14643,14 @@ to produce as much output as possible and then return an error the number of bytes in @outbuf, must be at least one + filename="gio/gconverter.c" + line="61">the number of bytes in @outbuf, must be at least one a #GConverterFlags controlling the conversion details + filename="gio/gconverter.c" + line="62">a #GConverterFlags controlling the conversion details will be set to the number of bytes read + filename="gio/gconverter.c" + line="63">will be set to the number of bytes read from @inbuf on success @@ -14423,8 +14668,8 @@ to produce as much output as possible and then return an error caller-allocates="0" transfer-ownership="full"> will be set to the number of bytes + filename="gio/gconverter.c" + line="65">will be set to the number of bytes written to @outbuf on success @@ -14432,20 +14677,19 @@ to produce as much output as possible and then return an error Resets all internal state in the converter, making it behave + filename="gio/gconverter.c" + line="189">Resets all internal state in the converter, making it behave as if it was just created. If the converter has any internal state that would produce output then that output is lost. - + a #GConverter. + filename="gio/gconverter.c" + line="191">a #GConverter. @@ -14457,7 +14701,7 @@ state that would produce output then that output is lost. glib:get-type="g_converter_flags_get_type" c:type="GConverterFlags"> Flags used when calling a g_converter_convert(). glib:nick="none" glib:name="G_CONVERTER_NO_FLAGS"> No flags. glib:nick="input-at-end" glib:name="G_CONVERTER_INPUT_AT_END"> At end of input data glib:nick="flush" glib:name="G_CONVERTER_FLUSH"> Flush data @@ -14492,33 +14736,34 @@ state that would produce output then that output is lost. glib:is-gtype-struct-for="Converter" version="2.24"> Provides an interface for converting data from one type + filename="gio/gconverter.h" + line="41">Provides an interface for converting data from one type to another type. The conversion can be stateful and may fail at any place. - + The parent interface. + filename="gio/gconverter.h" + line="43">The parent interface. + Converts data. - + a #GConverterResult, %G_CONVERTER_ERROR on error. + filename="gio/gconverter.c" + line="152">a #GConverterResult, %G_CONVERTER_ERROR on error. a #GConverter. + filename="gio/gconverter.c" + line="55">a #GConverter. nullable="1" allow-none="1"> the buffer + filename="gio/gconverter.c" + line="56">the buffer containing the data to convert. @@ -14535,14 +14780,14 @@ and may fail at any place. the number of bytes in @inbuf + filename="gio/gconverter.c" + line="58">the number of bytes in @inbuf a + filename="gio/gconverter.c" + line="59">a buffer to write converted data in. @@ -14550,14 +14795,14 @@ and may fail at any place. the number of bytes in @outbuf, must be at least one + filename="gio/gconverter.c" + line="61">the number of bytes in @outbuf, must be at least one a #GConverterFlags controlling the conversion details + filename="gio/gconverter.c" + line="62">a #GConverterFlags controlling the conversion details caller-allocates="0" transfer-ownership="full"> will be set to the number of bytes read + filename="gio/gconverter.c" + line="63">will be set to the number of bytes read from @inbuf on success @@ -14575,8 +14820,8 @@ and may fail at any place. caller-allocates="0" transfer-ownership="full"> will be set to the number of bytes + filename="gio/gconverter.c" + line="65">will be set to the number of bytes written to @outbuf on success @@ -14584,17 +14829,19 @@ and may fail at any place. + Reverts the internal state of the converter to its initial state. - + a #GConverter. + filename="gio/gconverter.c" + line="191">a #GConverter. @@ -14609,38 +14856,36 @@ and may fail at any place. glib:get-type="g_converter_input_stream_get_type" glib:type-struct="ConverterInputStreamClass"> Converter input stream implements #GInputStream and allows + filename="gio/gconverterinputstream.c" + line="35">Converter input stream implements [class@Gio.InputStream] and allows conversion of data of various types during reading. -As of GLib 2.34, #GConverterInputStream implements -#GPollableInputStream. - +As of GLib 2.34, `GConverterInputStream` implements +[iface@Gio.PollableInputStream]. + Creates a new converter input stream for the @base_stream. - + filename="gio/gconverterinputstream.c" + line="210">Creates a new converter input stream for the @base_stream. + a new #GInputStream. + filename="gio/gconverterinputstream.c" + line="217">a new #GInputStream. a #GInputStream + filename="gio/gconverterinputstream.c" + line="212">a #GInputStream a #GConverter + filename="gio/gconverterinputstream.c" + line="213">a #GConverter @@ -14650,22 +14895,21 @@ As of GLib 2.34, #GConverterInputStream implements glib:get-property="converter" version="2.24"> Gets the #GConverter that is used by @converter_stream. - + filename="gio/gconverterinputstream.c" + line="639">Gets the #GConverter that is used by @converter_stream. + the converter of the converter input stream + filename="gio/gconverterinputstream.c" + line="645">the converter of the converter input stream a #GConverterInputStream + filename="gio/gconverterinputstream.c" + line="641">a #GConverterInputStream @@ -14675,6 +14919,9 @@ As of GLib 2.34, #GConverterInputStream implements construct-only="1" transfer-ownership="none" getter="get_converter"> + The converter object. @@ -14688,15 +14935,13 @@ As of GLib 2.34, #GConverterInputStream implements - + - + @@ -14704,8 +14949,7 @@ As of GLib 2.34, #GConverterInputStream implements - + @@ -14713,8 +14957,7 @@ As of GLib 2.34, #GConverterInputStream implements - + @@ -14722,8 +14965,7 @@ As of GLib 2.34, #GConverterInputStream implements - + @@ -14731,8 +14973,7 @@ As of GLib 2.34, #GConverterInputStream implements - + @@ -14743,8 +14984,7 @@ As of GLib 2.34, #GConverterInputStream implements c:type="GConverterInputStreamPrivate" disguised="1" opaque="1"> - + Converter output stream implements #GOutputStream and allows + filename="gio/gconverteroutputstream.c" + line="35">Converter output stream implements [class@Gio.OutputStream] and allows conversion of data of various types during reading. -As of GLib 2.34, #GConverterOutputStream implements -#GPollableOutputStream. - +As of GLib 2.34, `GConverterOutputStream` implements +[iface@Gio.PollableOutputStream]. + Creates a new converter output stream for the @base_stream. - + filename="gio/gconverteroutputstream.c" + line="226">Creates a new converter output stream for the @base_stream. + a new #GOutputStream. + filename="gio/gconverteroutputstream.c" + line="233">a new #GOutputStream. a #GOutputStream + filename="gio/gconverteroutputstream.c" + line="228">a #GOutputStream a #GConverter + filename="gio/gconverteroutputstream.c" + line="229">a #GConverter @@ -14795,22 +15033,21 @@ As of GLib 2.34, #GConverterOutputStream implements glib:get-property="converter" version="2.24"> Gets the #GConverter that is used by @converter_stream. - + filename="gio/gconverteroutputstream.c" + line="677">Gets the #GConverter that is used by @converter_stream. + the converter of the converter output stream + filename="gio/gconverteroutputstream.c" + line="683">the converter of the converter output stream a #GConverterOutputStream + filename="gio/gconverteroutputstream.c" + line="679">a #GConverterOutputStream @@ -14821,6 +15058,9 @@ As of GLib 2.34, #GConverterOutputStream implements construct-only="1" transfer-ownership="none" getter="get_converter"> + The converter object. @@ -14834,16 +15074,14 @@ As of GLib 2.34, #GConverterOutputStream implements - + - + @@ -14851,8 +15089,7 @@ As of GLib 2.34, #GConverterOutputStream implements - + @@ -14860,8 +15097,7 @@ As of GLib 2.34, #GConverterOutputStream implements - + @@ -14869,8 +15105,7 @@ As of GLib 2.34, #GConverterOutputStream implements - + @@ -14878,8 +15113,7 @@ As of GLib 2.34, #GConverterOutputStream implements - + @@ -14890,8 +15124,7 @@ As of GLib 2.34, #GConverterOutputStream implements c:type="GConverterOutputStreamPrivate" disguised="1" opaque="1"> - + Results returned from g_converter_convert(). There was an error during conversion. Some data was consumed or produced The conversion is finished Flushing is finished @@ -14947,57 +15180,53 @@ As of GLib 2.34, #GConverterOutputStream implements glib:get-type="g_credentials_get_type" glib:type-struct="CredentialsClass"> The #GCredentials type is a reference-counted wrapper for native -credentials. This information is typically used for identifying, + filename="gio/gcredentials.c" + line="38">The `GCredentials` type is a reference-counted wrapper for native +credentials. + +The information in `GCredentials` is typically used for identifying, authenticating and authorizing other processes. -Some operating systems supports looking up the credentials of the -remote peer of a communication endpoint - see e.g. -g_socket_get_credentials(). +Some operating systems supports looking up the credentials of the remote +peer of a communication endpoint - see e.g. [method@Gio.Socket.get_credentials]. Some operating systems supports securely sending and receiving -credentials over a Unix Domain Socket, see -#GUnixCredentialsMessage, g_unix_connection_send_credentials() and -g_unix_connection_receive_credentials() for details. +credentials over a Unix Domain Socket, see [class@Gio.UnixCredentialsMessage], +[method@Gio.UnixConnection.send_credentials] and +[method@Gio.UnixConnection.receive_credentials] for details. On Linux, the native credential type is a `struct ucred` - see the -unix(7) man page for details. This corresponds to -%G_CREDENTIALS_TYPE_LINUX_UCRED. +[`unix(7)` man page](man:unix(7)) for details. This corresponds to +`G_CREDENTIALS_TYPE_LINUX_UCRED`. -On Apple operating systems (including iOS, tvOS, and macOS), -the native credential type is a `struct xucred`. -This corresponds to %G_CREDENTIALS_TYPE_APPLE_XUCRED. +On Apple operating systems (including iOS, tvOS, and macOS), the native credential +type is a `struct xucred`. This corresponds to `G_CREDENTIALS_TYPE_APPLE_XUCRED`. -On FreeBSD, Debian GNU/kFreeBSD, and GNU/Hurd, the native -credential type is a `struct cmsgcred`. This corresponds -to %G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED. +On FreeBSD, Debian GNU/kFreeBSD, and GNU/Hurd, the native credential type is a +`struct cmsgcred`. This corresponds to `G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED`. On NetBSD, the native credential type is a `struct unpcbid`. -This corresponds to %G_CREDENTIALS_TYPE_NETBSD_UNPCBID. +This corresponds to `G_CREDENTIALS_TYPE_NETBSD_UNPCBID`. On OpenBSD, the native credential type is a `struct sockpeercred`. -This corresponds to %G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED. +This corresponds to `G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED`. -On Solaris (including OpenSolaris and its derivatives), the native -credential type is a `ucred_t`. This corresponds to -%G_CREDENTIALS_TYPE_SOLARIS_UCRED. +On Solaris (including OpenSolaris and its derivatives), the native credential type +is a `ucred_t`. This corresponds to `G_CREDENTIALS_TYPE_SOLARIS_UCRED`. Since GLib 2.72, on Windows, the native credentials may contain the PID of a -process. This corresponds to %G_CREDENTIALS_TYPE_WIN32_PID. - +process. This corresponds to `G_CREDENTIALS_TYPE_WIN32_PID`. + Creates a new #GCredentials object with credentials matching the + filename="gio/gcredentials.c" + line="195">Creates a new #GCredentials object with credentials matching the the current process. - + A #GCredentials. Free with g_object_unref(). + filename="gio/gcredentials.c" + line="201">A #GCredentials. Free with g_object_unref(). @@ -15006,19 +15235,18 @@ the current process. version="2.26" introspectable="0"> Gets a pointer to native credentials of type @native_type from + filename="gio/gcredentials.c" + line="430">Gets a pointer to native credentials of type @native_type from @credentials. It is a programming error (which will cause a warning to be logged) to use this method if there is no #GCredentials support for the OS or if @native_type isn't supported by the OS. - + The pointer to native credentials or + filename="gio/gcredentials.c" + line="442">The pointer to native credentials or %NULL if there is no #GCredentials support for the OS or if @native_type isn't supported by the OS. Do not free the returned data, it is owned by @credentials. @@ -15027,14 +15255,14 @@ the OS or if @native_type isn't supported by the OS. A #GCredentials. + filename="gio/gcredentials.c" + line="432">A #GCredentials. The type of native credentials to get. + filename="gio/gcredentials.c" + line="433">The type of native credentials to get. @@ -15044,26 +15272,25 @@ the OS or if @native_type isn't supported by the OS. version="2.36" throws="1"> Tries to get the UNIX process identifier from @credentials. This + filename="gio/gcredentials.c" + line="566">Tries to get the UNIX process identifier from @credentials. This method is only available on UNIX platforms. This operation can fail if #GCredentials is not supported on the OS or if the native credentials type does not contain information about the UNIX process ID. - + The UNIX process ID, or `-1` if @error is set. + filename="gio/gcredentials.c" + line="578">The UNIX process ID, or `-1` if @error is set. A #GCredentials + filename="gio/gcredentials.c" + line="568">A #GCredentials @@ -15073,26 +15300,25 @@ about the UNIX process ID. version="2.26" throws="1"> Tries to get the UNIX user identifier from @credentials. This + filename="gio/gcredentials.c" + line="502">Tries to get the UNIX user identifier from @credentials. This method is only available on UNIX platforms. This operation can fail if #GCredentials is not supported on the OS or if the native credentials type does not contain information about the UNIX user. - + The UNIX user identifier or `-1` if @error is set. + filename="gio/gcredentials.c" + line="514">The UNIX user identifier or `-1` if @error is set. A #GCredentials + filename="gio/gcredentials.c" + line="504">A #GCredentials @@ -15102,31 +15328,30 @@ about the UNIX user. version="2.26" throws="1"> Checks if @credentials and @other_credentials is the same user. + filename="gio/gcredentials.c" + line="335">Checks if @credentials and @other_credentials is the same user. This operation can fail if #GCredentials is not supported on the the OS. - + %TRUE if @credentials and @other_credentials has the same + filename="gio/gcredentials.c" + line="346">%TRUE if @credentials and @other_credentials has the same user, %FALSE otherwise or if @error is set. A #GCredentials. + filename="gio/gcredentials.c" + line="337">A #GCredentials. A #GCredentials. + filename="gio/gcredentials.c" + line="338">A #GCredentials. @@ -15135,35 +15360,34 @@ user, %FALSE otherwise or if @error is set. c:identifier="g_credentials_set_native" version="2.26"> Copies the native credentials of type @native_type from @native + filename="gio/gcredentials.c" + line="467">Copies the native credentials of type @native_type from @native into @credentials. It is a programming error (which will cause a warning to be logged) to use this method if there is no #GCredentials support for the OS or if @native_type isn't supported by the OS. - + A #GCredentials. + filename="gio/gcredentials.c" + line="469">A #GCredentials. The type of native credentials to set. + filename="gio/gcredentials.c" + line="470">The type of native credentials to set. A pointer to native credentials. + filename="gio/gcredentials.c" + line="471">A pointer to native credentials. @@ -15173,33 +15397,32 @@ the OS or if @native_type isn't supported by the OS. version="2.26" throws="1"> Tries to set the UNIX user identifier on @credentials. This method + filename="gio/gcredentials.c" + line="624">Tries to set the UNIX user identifier on @credentials. This method is only available on UNIX platforms. This operation can fail if #GCredentials is not supported on the OS or if the native credentials type does not contain information about the UNIX user. It can also fail if the OS does not allow the use of "spoofed" credentials. - + %TRUE if @uid was set, %FALSE if error is set. + filename="gio/gcredentials.c" + line="638">%TRUE if @uid was set, %FALSE if error is set. A #GCredentials. + filename="gio/gcredentials.c" + line="626">A #GCredentials. The UNIX user identifier to set. + filename="gio/gcredentials.c" + line="627">The UNIX user identifier to set. @@ -15208,23 +15431,22 @@ use of "spoofed" credentials. c:identifier="g_credentials_to_string" version="2.26"> Creates a human-readable textual representation of @credentials + filename="gio/gcredentials.c" + line="213">Creates a human-readable textual representation of @credentials that can be used in logging and debug messages. The format of the returned string may change in future GLib release. - + A string that should be freed with g_free(). + filename="gio/gcredentials.c" + line="221">A string that should be freed with g_free(). A #GCredentials object. + filename="gio/gcredentials.c" + line="215">A #GCredentials object. @@ -15237,10 +15459,9 @@ returned string may change in future GLib release. glib:is-gtype-struct-for="Credentials" version="2.26"> Class structure for #GCredentials. - + filename="gio/gcredentials.c" + line="110">Class structure for #GCredentials. + glib:get-type="g_credentials_type_get_type" c:type="GCredentialsType"> Enumeration describing different kinds of native credential types. + filename="gio/gioenums.h" + line="1455">Enumeration describing different kinds of native credential types. Indicates an invalid native credential type. + filename="gio/gioenums.h" + line="1457">Indicates an invalid native credential type. glib:nick="linux-ucred" glib:name="G_CREDENTIALS_TYPE_LINUX_UCRED"> The native credentials type is a `struct ucred`. + filename="gio/gioenums.h" + line="1458">The native credentials type is a `struct ucred`. glib:nick="freebsd-cmsgcred" glib:name="G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED"> The native credentials type is a `struct cmsgcred`. + filename="gio/gioenums.h" + line="1459">The native credentials type is a `struct cmsgcred`. glib:nick="openbsd-sockpeercred" glib:name="G_CREDENTIALS_TYPE_OPENBSD_SOCKPEERCRED"> The native credentials type is a `struct sockpeercred`. Added in 2.30. + filename="gio/gioenums.h" + line="1460">The native credentials type is a `struct sockpeercred`. Added in 2.30. glib:nick="solaris-ucred" glib:name="G_CREDENTIALS_TYPE_SOLARIS_UCRED"> The native credentials type is a `ucred_t`. Added in 2.40. + filename="gio/gioenums.h" + line="1461">The native credentials type is a `ucred_t`. Added in 2.40. glib:nick="netbsd-unpcbid" glib:name="G_CREDENTIALS_TYPE_NETBSD_UNPCBID"> The native credentials type is a `struct unpcbid`. Added in 2.42. + filename="gio/gioenums.h" + line="1462">The native credentials type is a `struct unpcbid`. Added in 2.42. glib:nick="apple-xucred" glib:name="G_CREDENTIALS_TYPE_APPLE_XUCRED"> The native credentials type is a `struct xucred`. Added in 2.66. + filename="gio/gioenums.h" + line="1463">The native credentials type is a `struct xucred`. Added in 2.66. glib:nick="win32-pid" glib:name="G_CREDENTIALS_TYPE_WIN32_PID"> The native credentials type is a PID `DWORD`. Added in 2.72. + filename="gio/gioenums.h" + line="1464">The native credentials type is a PID `DWORD`. Added in 2.72. - + @@ -15336,8 +15556,7 @@ returned string may change in future GLib release. - + @@ -15346,8 +15565,7 @@ returned string may change in future GLib release. - + @@ -15356,8 +15574,7 @@ returned string may change in future GLib release. - + @@ -15366,8 +15583,7 @@ returned string may change in future GLib release. - + @@ -15376,8 +15592,7 @@ returned string may change in future GLib release. - + @@ -15386,8 +15601,7 @@ returned string may change in future GLib release. - + @@ -15396,8 +15610,7 @@ returned string may change in future GLib release. - + @@ -15406,8 +15619,7 @@ returned string may change in future GLib release. - + @@ -15416,8 +15628,7 @@ returned string may change in future GLib release. - + @@ -15426,8 +15637,7 @@ returned string may change in future GLib release. - + @@ -15436,8 +15646,7 @@ returned string may change in future GLib release. - + @@ -15446,8 +15655,7 @@ returned string may change in future GLib release. - + @@ -15456,8 +15664,7 @@ returned string may change in future GLib release. - + @@ -15466,8 +15673,7 @@ returned string may change in future GLib release. - + @@ -15476,8 +15682,7 @@ returned string may change in future GLib release. - + @@ -15486,8 +15691,7 @@ returned string may change in future GLib release. - + @@ -15496,8 +15700,7 @@ returned string may change in future GLib release. - + @@ -15506,8 +15709,7 @@ returned string may change in future GLib release. - + @@ -15516,8 +15718,7 @@ returned string may change in future GLib release. - + @@ -15526,8 +15727,7 @@ returned string may change in future GLib release. - + @@ -15538,7 +15738,7 @@ returned string may change in future GLib release. c:type="G_DBUS_METHOD_INVOCATION_HANDLED" version="2.68"> The value returned by handlers of the signals generated by the `gdbus-codegen` tool to indicate that a method call has been handled by an implementation. It is equal to %TRUE, but using @@ -15551,8 +15751,7 @@ use %TRUE instead, often written like this: g_dbus_method_invocation_return_error (invocation, ...); return TRUE; // handled ]| - + The value returned by handlers of the signals generated by the `gdbus-codegen` tool to indicate that a method call has not been handled by an implementation. It is equal to %FALSE, but using @@ -15568,15 +15767,13 @@ this macro is sometimes more readable. In code that needs to be backwards-compatible with older GLib, use %FALSE instead. - + - + @@ -15585,8 +15782,7 @@ use %FALSE instead. - + @@ -15595,8 +15791,7 @@ use %FALSE instead. - + @@ -15605,8 +15800,7 @@ use %FALSE instead. - + @@ -15615,8 +15809,7 @@ use %FALSE instead. - + @@ -15625,8 +15818,7 @@ use %FALSE instead. - + @@ -15635,8 +15827,7 @@ use %FALSE instead. - + @@ -15645,8 +15836,7 @@ use %FALSE instead. - + @@ -15655,8 +15845,7 @@ use %FALSE instead. - + @@ -15665,8 +15854,7 @@ use %FALSE instead. - + @@ -15675,8 +15863,7 @@ use %FALSE instead. - + @@ -15685,8 +15872,7 @@ use %FALSE instead. - + @@ -15695,8 +15881,7 @@ use %FALSE instead. - + @@ -15705,8 +15890,7 @@ use %FALSE instead. - + @@ -15715,8 +15899,7 @@ use %FALSE instead. - + @@ -15725,8 +15908,7 @@ use %FALSE instead. - + @@ -15735,8 +15917,7 @@ use %FALSE instead. - + @@ -15745,8 +15926,7 @@ use %FALSE instead. - + @@ -15755,8 +15935,7 @@ use %FALSE instead. - + @@ -15765,8 +15944,7 @@ use %FALSE instead. - + @@ -15779,18 +15957,20 @@ use %FALSE instead. glib:type-name="GDBusActionGroup" glib:get-type="g_dbus_action_group_get_type"> #GDBusActionGroup is an implementation of the #GActionGroup -interface that can be used as a proxy for an action group -that is exported over D-Bus with g_dbus_connection_export_action_group(). + filename="gio/gdbusactiongroup.c" + line="31">`GDBusActionGroup` is an implementation of the [iface@Gio.ActionGroup] +interface. + +`GDBusActionGroup` can be used as a proxy for an action group +that is exported over D-Bus with [method@Gio.DBusConnection.export_action_group]. Obtains a #GDBusActionGroup for the action group which is exported at + filename="gio/gdbusactiongroup.c" + line="468">Obtains a #GDBusActionGroup for the action group which is exported at the given @bus_name and @object_path. The thread default main context is taken at the time of this call. @@ -15803,19 +15983,18 @@ This call is non-blocking. The returned action group may or may not already be filled in. The correct thing to do is connect the signals for the action group to monitor for changes and then to call g_action_group_list_actions() to get the initial list. - + a #GDBusActionGroup + filename="gio/gdbusactiongroup.c" + line="489">a #GDBusActionGroup A #GDBusConnection + filename="gio/gdbusactiongroup.c" + line="470">A #GDBusConnection nullable="1" allow-none="1"> the bus name which exports the action + filename="gio/gdbusactiongroup.c" + line="471">the bus name which exports the action group or %NULL if @connection is not a message bus connection the object path at which the action group is exported + filename="gio/gdbusactiongroup.c" + line="473">the object path at which the action group is exported @@ -15844,31 +16023,30 @@ g_action_group_list_actions() to get the initial list. glib:get-type="g_dbus_annotation_info_get_type" c:symbol-prefix="dbus_annotation_info"> Information about an annotation. - + The reference count or -1 if statically allocated. The name of the annotation, e.g. "org.freedesktop.DBus.Deprecated". The value of the annotation. A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. @@ -15878,22 +16056,21 @@ g_action_group_list_actions() to get the initial list. c:identifier="g_dbus_annotation_info_ref" version="2.26"> If @info is statically allocated does nothing. Otherwise increases + filename="gio/gdbusintrospection.c" + line="202">If @info is statically allocated does nothing. Otherwise increases the reference count. - + The same @info. + filename="gio/gdbusintrospection.c" + line="209">The same @info. A #GDBusNodeInfo + filename="gio/gdbusintrospection.c" + line="204">A #GDBusNodeInfo @@ -15902,20 +16079,19 @@ the reference count. c:identifier="g_dbus_annotation_info_unref" version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + filename="gio/gdbusintrospection.c" + line="236">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. - + A #GDBusAnnotationInfo. + filename="gio/gdbusintrospection.c" + line="238">A #GDBusAnnotationInfo. @@ -15924,16 +16100,15 @@ the memory used is freed. c:identifier="g_dbus_annotation_info_lookup" version="2.26"> Looks up the value of an annotation. + filename="gio/gdbusintrospection.c" + line="1829">Looks up the value of an annotation. The cost of this function is O(n) in number of annotations. - + The value or %NULL if not found. Do not free, it is owned by @annotations. + filename="gio/gdbusintrospection.c" + line="1838">The value or %NULL if not found. Do not free, it is owned by @annotations. @@ -15942,16 +16117,16 @@ The cost of this function is O(n) in number of annotations. nullable="1" allow-none="1"> A %NULL-terminated array of annotations or %NULL. + filename="gio/gdbusintrospection.c" + line="1831">A %NULL-terminated array of annotations or %NULL. The name of the annotation to look up. + filename="gio/gdbusintrospection.c" + line="1832">The name of the annotation to look up. @@ -15964,31 +16139,30 @@ The cost of this function is O(n) in number of annotations. glib:get-type="g_dbus_arg_info_get_type" c:symbol-prefix="dbus_arg_info"> Information about an argument for a method or a signal. - + The reference count or -1 if statically allocated. Name of the argument, e.g. @unix_user_id. D-Bus signature of the argument (a single complete type). A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. @@ -15996,42 +16170,40 @@ The cost of this function is O(n) in number of annotations. If @info is statically allocated does nothing. Otherwise increases + filename="gio/gdbusintrospection.c" + line="182">If @info is statically allocated does nothing. Otherwise increases the reference count. - + The same @info. + filename="gio/gdbusintrospection.c" + line="189">The same @info. A #GDBusArgInfo + filename="gio/gdbusintrospection.c" + line="184">A #GDBusArgInfo If @info is statically allocated, does nothing. Otherwise decreases + filename="gio/gdbusintrospection.c" + line="260">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. - + A #GDBusArgInfo. + filename="gio/gdbusintrospection.c" + line="262">A #GDBusArgInfo. @@ -16045,23 +16217,24 @@ the memory used is freed. glib:type-name="GDBusAuthObserver" glib:get-type="g_dbus_auth_observer_get_type"> The #GDBusAuthObserver type provides a mechanism for participating -in how a #GDBusServer (or a #GDBusConnection) authenticates remote -peers. Simply instantiate a #GDBusAuthObserver and connect to the + filename="gio/gdbusauthobserver.c" + line="34">`GDBusAuthObserver` provides a mechanism for participating +in how a [class@Gio.DBusServer] (or a [class@Gio.DBusConnection]) +authenticates remote peers. + +Simply instantiate a `GDBusAuthObserver` and connect to the signals you are interested in. Note that new signals may be added -in the future +in the future. ## Controlling Authentication Mechanisms -By default, a #GDBusServer or server-side #GDBusConnection will allow -any authentication mechanism to be used. If you only -want to allow D-Bus connections with the `EXTERNAL` mechanism, -which makes use of credentials passing and is the recommended -mechanism for modern Unix platforms such as Linux and the BSD family, -you would use a signal handler like this: +By default, a `GDBusServer` or server-side `GDBusConnection` will allow +any authentication mechanism to be used. If you only want to allow D-Bus +connections with the `EXTERNAL` mechanism, which makes use of credentials +passing and is the recommended mechanism for modern Unix platforms such +as Linux and the BSD family, you would use a signal handler like this: -|[<!-- language="C" --> +```c static gboolean on_allow_mechanism (GDBusAuthObserver *observer, const gchar *mechanism, @@ -16074,19 +16247,19 @@ on_allow_mechanism (GDBusAuthObserver *observer, return FALSE; } -]| +``` -## Controlling Authorization # {#auth-observer} +## Controlling Authorization -By default, a #GDBusServer or server-side #GDBusConnection will accept +By default, a `GDBusServer` or server-side `GDBusConnection` will accept connections from any successfully authenticated user (but not from anonymous connections using the `ANONYMOUS` mechanism). If you only want to allow D-Bus connections from processes owned by the same uid as the server, since GLib 2.68, you should use the -%G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER flag. It’s equivalent +`G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER` flag. It’s equivalent to the following signal handler: -|[<!-- language="C" --> +```c static gboolean on_authorize_authenticated_peer (GDBusAuthObserver *observer, GIOStream *stream, @@ -16107,19 +16280,18 @@ on_authorize_authenticated_peer (GDBusAuthObserver *observer, return authorized; } -]| +``` Creates a new #GDBusAuthObserver object. - + filename="gio/gdbusauthobserver.c" + line="240">Creates a new #GDBusAuthObserver object. + A #GDBusAuthObserver. Free with g_object_unref(). + filename="gio/gdbusauthobserver.c" + line="245">A #GDBusAuthObserver. Free with g_object_unref(). @@ -16127,27 +16299,26 @@ on_authorize_authenticated_peer (GDBusAuthObserver *observer, c:identifier="g_dbus_auth_observer_allow_mechanism" version="2.34"> Emits the #GDBusAuthObserver::allow-mechanism signal on @observer. - + filename="gio/gdbusauthobserver.c" + line="286">Emits the #GDBusAuthObserver::allow-mechanism signal on @observer. + %TRUE if @mechanism can be used to authenticate the other peer, %FALSE if not. + filename="gio/gdbusauthobserver.c" + line="293">%TRUE if @mechanism can be used to authenticate the other peer, %FALSE if not. A #GDBusAuthObserver. + filename="gio/gdbusauthobserver.c" + line="288">A #GDBusAuthObserver. The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`. + filename="gio/gdbusauthobserver.c" + line="289">The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`. @@ -16156,27 +16327,26 @@ on_authorize_authenticated_peer (GDBusAuthObserver *observer, c:identifier="g_dbus_auth_observer_authorize_authenticated_peer" version="2.26"> Emits the #GDBusAuthObserver::authorize-authenticated-peer signal on @observer. - + filename="gio/gdbusauthobserver.c" + line="257">Emits the #GDBusAuthObserver::authorize-authenticated-peer signal on @observer. + %TRUE if the peer is authorized, %FALSE if not. + filename="gio/gdbusauthobserver.c" + line="265">%TRUE if the peer is authorized, %FALSE if not. A #GDBusAuthObserver. + filename="gio/gdbusauthobserver.c" + line="259">A #GDBusAuthObserver. A #GIOStream for the #GDBusConnection. + filename="gio/gdbusauthobserver.c" + line="260">A #GIOStream for the #GDBusConnection. Credentials received from the peer or %NULL. + filename="gio/gdbusauthobserver.c" + line="261">Credentials received from the peer or %NULL. Emitted to check if @mechanism is allowed to be used. + filename="gio/gdbusauthobserver.c" + line="208">Emitted to check if @mechanism is allowed to be used. %TRUE if @mechanism can be used to authenticate the other peer, %FALSE if not. + filename="gio/gdbusauthobserver.c" + line="215">%TRUE if @mechanism can be used to authenticate the other peer, %FALSE if not. The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`. + filename="gio/gdbusauthobserver.c" + line="211">The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`. @@ -16213,20 +16383,20 @@ on_authorize_authenticated_peer (GDBusAuthObserver *observer, when="last" version="2.26"> Emitted to check if a peer that is successfully authenticated + filename="gio/gdbusauthobserver.c" + line="179">Emitted to check if a peer that is successfully authenticated is authorized. %TRUE if the peer is authorized, %FALSE if not. + filename="gio/gdbusauthobserver.c" + line="188">%TRUE if the peer is authorized, %FALSE if not. A #GIOStream for the #GDBusConnection. + filename="gio/gdbusauthobserver.c" + line="182">A #GIOStream for the #GDBusConnection. nullable="1" allow-none="1"> Credentials received from the peer or %NULL. + filename="gio/gdbusauthobserver.c" + line="183">Credentials received from the peer or %NULL. @@ -16247,16 +16417,16 @@ is authorized. glib:get-type="g_dbus_call_flags_get_type" c:type="GDBusCallFlags"> Flags used in g_dbus_connection_call() and similar APIs. + filename="gio/gioenums.h" + line="1265">Flags used in g_dbus_connection_call() and similar APIs. No flags set. + filename="gio/gioenums.h" + line="1267">No flags set. glib:nick="no-auto-start" glib:name="G_DBUS_CALL_FLAGS_NO_AUTO_START"> The bus must not launch + filename="gio/gioenums.h" + line="1268">The bus must not launch an owner for the destination name in response to this method invocation. @@ -16275,8 +16445,8 @@ invocation. glib:nick="allow-interactive-authorization" glib:name="G_DBUS_CALL_FLAGS_ALLOW_INTERACTIVE_AUTHORIZATION"> the caller is prepared to + filename="gio/gioenums.h" + line="1271">the caller is prepared to wait for interactive authorization. Since 2.46. @@ -16286,16 +16456,16 @@ wait for interactive authorization. Since 2.46. glib:get-type="g_dbus_capability_flags_get_type" c:type="GDBusCapabilityFlags"> Capabilities negotiated with the remote peer. + filename="gio/gioenums.h" + line="1250">Capabilities negotiated with the remote peer. No flags set. + filename="gio/gioenums.h" + line="1252">No flags set. glib:nick="unix-fd-passing" glib:name="G_DBUS_CAPABILITY_FLAGS_UNIX_FD_PASSING"> The connection + filename="gio/gioenums.h" + line="1253">The connection supports exchanging UNIX file descriptors with the remote peer. @@ -16316,53 +16486,56 @@ supports exchanging UNIX file descriptors with the remote peer. glib:type-name="GDBusConnection" glib:get-type="g_dbus_connection_get_type"> The #GDBusConnection type is used for D-Bus connections to remote -peers such as a message buses. It is a low-level API that offers a -lot of flexibility. For instance, it lets you establish a connection -over any transport that can by represented as a #GIOStream. + filename="gio/gdbusconnection.c" + line="133">The `GDBusConnection` type is used for D-Bus connections to remote +peers such as a message buses. + +It is a low-level API that offers a lot of flexibility. For instance, +it lets you establish a connection over any transport that can by represented +as a [class@Gio.IOStream]. This class is rarely used directly in D-Bus clients. If you are writing -a D-Bus client, it is often easier to use the g_bus_own_name(), -g_bus_watch_name() or g_dbus_proxy_new_for_bus() APIs. +a D-Bus client, it is often easier to use the [func@Gio.bus_own_name], +[func@Gio.bus_watch_name] or [func@Gio.DBusProxy.new_for_bus] APIs. As an exception to the usual GLib rule that a particular object must not -be used by two threads at the same time, #GDBusConnection's methods may be -called from any thread. This is so that g_bus_get() and g_bus_get_sync() -can safely return the same #GDBusConnection when called from any thread. - -Most of the ways to obtain a #GDBusConnection automatically initialize it -(i.e. connect to D-Bus): for instance, g_dbus_connection_new() and -g_bus_get(), and the synchronous versions of those methods, give you an -initialized connection. Language bindings for GIO should use -g_initable_new() or g_async_initable_new_async(), which also initialize the -connection. - -If you construct an uninitialized #GDBusConnection, such as via -g_object_new(), you must initialize it via g_initable_init() or -g_async_initable_init_async() before using its methods or properties. -Calling methods or accessing properties on a #GDBusConnection that has not +be used by two threads at the same time, `GDBusConnection`s methods may be +called from any thread. This is so that [func@Gio.bus_get] and +[func@Gio.bus_get_sync] can safely return the same `GDBusConnection` when +called from any thread. + +Most of the ways to obtain a `GDBusConnection` automatically initialize it +(i.e. connect to D-Bus): for instance, [func@Gio.DBusConnection.new] and +[func@Gio.bus_get], and the synchronous versions of those methods, give you +an initialized connection. Language bindings for GIO should use +[func@Gio.Initable.new] or [func@Gio.AsyncInitable.new_async], which also +initialize the connection. + +If you construct an uninitialized `GDBusConnection`, such as via +[ctor@GObject.Object.new], you must initialize it via [method@Gio.Initable.init] or +[method@Gio.AsyncInitable.init_async] before using its methods or properties. +Calling methods or accessing properties on a `GDBusConnection` that has not completed initialization successfully is considered to be invalid, and leads to undefined behaviour. In particular, if initialization fails with a -#GError, the only valid thing you can do with that #GDBusConnection is to -free it with g_object_unref(). +`GError`, the only valid thing you can do with that `GDBusConnection` is to +free it with [method@GObject.Object.unref]. -## An example D-Bus server # {#gdbus-server} +## An example D-Bus server Here is an example for a D-Bus server: [gdbus-example-server.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-server.c) -## An example for exporting a subtree # {#gdbus-subtree-server} +## An example for exporting a subtree Here is an example for exporting a subtree: [gdbus-example-subtree.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-subtree.c) -## An example for file descriptor passing # {#gdbus-unix-fd-client} +## An example for file descriptor passing Here is an example for passing UNIX file descriptors: [gdbus-unix-fd-client.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-unix-fd-client.c) -## An example for exporting a GObject # {#gdbus-export} +## An example for exporting a GObject Here is an example for exporting a #GObject: [gdbus-example-export.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-export.c) @@ -16373,22 +16546,21 @@ Here is an example for exporting a #GObject: version="2.26" throws="1"> Finishes an operation started with g_dbus_connection_new(). - + filename="gio/gdbusconnection.c" + line="3101">Finishes an operation started with g_dbus_connection_new(). + a #GDBusConnection or %NULL if @error is set. Free + filename="gio/gdbusconnection.c" + line="3109">a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). a #GAsyncResult obtained from the #GAsyncReadyCallback + filename="gio/gdbusconnection.c" + line="3103">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new(). @@ -16399,22 +16571,21 @@ Here is an example for exporting a #GObject: version="2.26" throws="1"> Finishes an operation started with g_dbus_connection_new_for_address(). - + filename="gio/gdbusconnection.c" + line="3248">Finishes an operation started with g_dbus_connection_new_for_address(). + a #GDBusConnection or %NULL if @error is set. + filename="gio/gdbusconnection.c" + line="3256">a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). a #GAsyncResult obtained from the #GAsyncReadyCallback passed + filename="gio/gdbusconnection.c" + line="3250">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_new() @@ -16425,8 +16596,8 @@ Here is an example for exporting a #GObject: version="2.26" throws="1"> Synchronously connects and sets up a D-Bus client connection for + filename="gio/gdbusconnection.c" + line="3283">Synchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by @address which must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -16443,26 +16614,25 @@ g_dbus_connection_new_for_address() for the asynchronous version. If @observer is not %NULL it may be used to control the authentication process. - + a #GDBusConnection or %NULL if @error is set. + filename="gio/gdbusconnection.c" + line="3309">a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). a D-Bus address + filename="gio/gdbusconnection.c" + line="3285">a D-Bus address flags describing how to make the connection + filename="gio/gdbusconnection.c" + line="3286">flags describing how to make the connection nullable="1" allow-none="1"> a #GDBusAuthObserver or %NULL + filename="gio/gdbusconnection.c" + line="3287">a #GDBusAuthObserver or %NULL nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="3288">a #GCancellable or %NULL @@ -16490,8 +16660,8 @@ authentication process. version="2.26" throws="1"> Synchronously sets up a D-Bus connection for exchanging D-Bus messages + filename="gio/gdbusconnection.c" + line="3136">Synchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by @stream. If @stream is a #GSocketConnection, then the corresponding #GSocket @@ -16506,20 +16676,19 @@ authentication process. This is a synchronous failable constructor. See g_dbus_connection_new() for the asynchronous version. - + a #GDBusConnection or %NULL if @error is set. + filename="gio/gdbusconnection.c" + line="3161">a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). a #GIOStream + filename="gio/gdbusconnection.c" + line="3138">a #GIOStream nullable="1" allow-none="1"> the GUID to use if authenticating as a server or %NULL + filename="gio/gdbusconnection.c" + line="3139">the GUID to use if authenticating as a server or %NULL flags describing how to make the connection + filename="gio/gdbusconnection.c" + line="3140">flags describing how to make the connection nullable="1" allow-none="1"> a #GDBusAuthObserver or %NULL + filename="gio/gdbusconnection.c" + line="3141">a #GDBusAuthObserver or %NULL nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="3142">a #GCancellable or %NULL - + Asynchronously sets up a D-Bus connection for exchanging D-Bus messages + filename="gio/gdbusconnection.c" + line="3042">Asynchronously sets up a D-Bus connection for exchanging D-Bus messages with the end represented by @stream. If @stream is a #GSocketConnection, then the corresponding #GSocket @@ -16580,16 +16752,15 @@ operation. This is an asynchronous failable constructor. See g_dbus_connection_new_sync() for the synchronous version. - + a #GIOStream + filename="gio/gdbusconnection.c" + line="3044">a #GIOStream nullable="1" allow-none="1"> the GUID to use if authenticating as a server or %NULL + filename="gio/gdbusconnection.c" + line="3045">the GUID to use if authenticating as a server or %NULL flags describing how to make the connection + filename="gio/gdbusconnection.c" + line="3046">flags describing how to make the connection nullable="1" allow-none="1"> a #GDBusAuthObserver or %NULL + filename="gio/gdbusconnection.c" + line="3047">a #GDBusAuthObserver or %NULL nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="3048">a #GCancellable or %NULL scope="async" closure="6"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gdbusconnection.c" + line="3049">a #GAsyncReadyCallback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to @callback + filename="gio/gdbusconnection.c" + line="3050">the data to pass to @callback + version="2.26" + glib:finish-func="new_for_address_finish"> Asynchronously connects and sets up a D-Bus client connection for + filename="gio/gdbusconnection.c" + line="3190">Asynchronously connects and sets up a D-Bus client connection for exchanging D-Bus messages with an endpoint specified by @address which must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -16674,22 +16846,21 @@ authentication process. This is an asynchronous failable constructor. See g_dbus_connection_new_for_address_sync() for the synchronous version. - + a D-Bus address + filename="gio/gdbusconnection.c" + line="3192">a D-Bus address flags describing how to make the connection + filename="gio/gdbusconnection.c" + line="3193">flags describing how to make the connection nullable="1" allow-none="1"> a #GDBusAuthObserver or %NULL + filename="gio/gdbusconnection.c" + line="3194">a #GDBusAuthObserver or %NULL nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="3195">a #GCancellable or %NULL scope="async" closure="5"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gdbusconnection.c" + line="3196">a #GAsyncReadyCallback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to @callback + filename="gio/gdbusconnection.c" + line="3197">the data to pass to @callback @@ -16736,8 +16907,8 @@ version. c:identifier="g_dbus_connection_add_filter" version="2.26"> Adds a message filter. Filters are handlers that are run on all + filename="gio/gdbusconnection.c" + line="3473">Adds a message filter. Filters are handlers that are run on all incoming and outgoing messages, prior to standard dispatch. Filters are run in the order that they were added. The same handler can be added as a filter more than once, in which case it will be run more @@ -16764,20 +16935,19 @@ method from) at some point after @user_data is no longer needed. (It is not guaranteed to be called synchronously when the filter is removed, and may be called after @connection has been destroyed.) - + a filter identifier that can be used with + filename="gio/gdbusconnection.c" + line="3509">a filter identifier that can be used with g_dbus_connection_remove_filter() a #GDBusConnection + filename="gio/gdbusconnection.c" + line="3475">a #GDBusConnection closure="1" destroy="2"> a filter function + filename="gio/gdbusconnection.c" + line="3476">a filter function @@ -16796,25 +16966,29 @@ destroyed.) nullable="1" allow-none="1"> user data to pass to @filter_function + filename="gio/gdbusconnection.c" + line="3477">user data to pass to @filter_function function to free @user_data with when filter + filename="gio/gdbusconnection.c" + line="3478">function to free @user_data with when filter is removed or %NULL - + Asynchronously invokes the @method_name method on the + filename="gio/gdbusconnection.c" + line="6619">Asynchronously invokes the @method_name method on the @interface_name D-Bus interface on the remote object at @object_path owned by @bus_name. @@ -16859,16 +17033,15 @@ function. If @callback is %NULL then the D-Bus method call message will be sent with the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. - + a #GDBusConnection + filename="gio/gdbusconnection.c" + line="6621">a #GDBusConnection nullable="1" allow-none="1"> a unique or well-known bus name or %NULL if + filename="gio/gdbusconnection.c" + line="6622">a unique or well-known bus name or %NULL if @connection is not a message bus connection path of remote object + filename="gio/gdbusconnection.c" + line="6624">path of remote object D-Bus interface to invoke method on + filename="gio/gdbusconnection.c" + line="6625">D-Bus interface to invoke method on the name of the method to invoke + filename="gio/gdbusconnection.c" + line="6626">the name of the method to invoke nullable="1" allow-none="1"> a #GVariant tuple with parameters for the method + filename="gio/gdbusconnection.c" + line="6627">a #GVariant tuple with parameters for the method or %NULL if not passing parameters @@ -16914,21 +17087,21 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. nullable="1" allow-none="1"> the expected type of the reply (which will be a + filename="gio/gdbusconnection.c" + line="6629">the expected type of the reply (which will be a tuple), or %NULL flags from the #GDBusCallFlags enumeration + filename="gio/gdbusconnection.c" + line="6631">flags from the #GDBusCallFlags enumeration the timeout in milliseconds, -1 to use the default + filename="gio/gdbusconnection.c" + line="6632">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -16937,8 +17110,8 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="6634">a #GCancellable or %NULL scope="async" closure="10"> a #GAsyncReadyCallback to call when the request + filename="gio/gdbusconnection.c" + line="6635">a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation @@ -16959,8 +17132,8 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. nullable="1" allow-none="1"> the data to pass to @callback + filename="gio/gdbusconnection.c" + line="6638">the data to pass to @callback @@ -16970,28 +17143,27 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. version="2.26" throws="1"> Finishes an operation started with g_dbus_connection_call(). - + filename="gio/gdbusconnection.c" + line="6705">Finishes an operation started with g_dbus_connection_call(). + %NULL if @error is set. Otherwise a non-floating + filename="gio/gdbusconnection.c" + line="6713">%NULL if @error is set. Otherwise a non-floating #GVariant tuple with return values. Free with g_variant_unref(). a #GDBusConnection + filename="gio/gdbusconnection.c" + line="6707">a #GDBusConnection a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call() + filename="gio/gdbusconnection.c" + line="6708">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call() @@ -16999,10 +17171,11 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. + throws="1" + glib:async-func="call"> Synchronously invokes the @method_name method on the + filename="gio/gdbusconnection.c" + line="6726">Synchronously invokes the @method_name method on the @interface_name D-Bus interface on the remote object at @object_path owned by @bus_name. @@ -17038,20 +17211,19 @@ This allows convenient 'inline' use of g_variant_new(), e.g.: The calling thread is blocked until a reply is received. See g_dbus_connection_call() for the asynchronous version of this method. - + %NULL if @error is set. Otherwise a non-floating + filename="gio/gdbusconnection.c" + line="6780">%NULL if @error is set. Otherwise a non-floating #GVariant tuple with return values. Free with g_variant_unref(). a #GDBusConnection + filename="gio/gdbusconnection.c" + line="6728">a #GDBusConnection nullable="1" allow-none="1"> a unique or well-known bus name or %NULL if + filename="gio/gdbusconnection.c" + line="6729">a unique or well-known bus name or %NULL if @connection is not a message bus connection path of remote object + filename="gio/gdbusconnection.c" + line="6731">path of remote object D-Bus interface to invoke method on + filename="gio/gdbusconnection.c" + line="6732">D-Bus interface to invoke method on the name of the method to invoke + filename="gio/gdbusconnection.c" + line="6733">the name of the method to invoke nullable="1" allow-none="1"> a #GVariant tuple with parameters for the method + filename="gio/gdbusconnection.c" + line="6734">a #GVariant tuple with parameters for the method or %NULL if not passing parameters @@ -17097,20 +17269,20 @@ this method. nullable="1" allow-none="1"> the expected type of the reply, or %NULL + filename="gio/gdbusconnection.c" + line="6736">the expected type of the reply, or %NULL flags from the #GDBusCallFlags enumeration + filename="gio/gdbusconnection.c" + line="6737">flags from the #GDBusCallFlags enumeration the timeout in milliseconds, -1 to use the default + filename="gio/gdbusconnection.c" + line="6738">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -17119,18 +17291,20 @@ this method. nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="6740">a #GCancellable or %NULL + version="2.30" + glib:finish-func="call_with_unix_fd_list_finish" + glib:sync-func="call_with_unix_fd_list_sync"> Like g_dbus_connection_call() but also takes a #GUnixFDList object. + filename="gio/gdbusconnection.c" + line="6805">Like g_dbus_connection_call() but also takes a #GUnixFDList object. The file descriptors normally correspond to %G_VARIANT_TYPE_HANDLE values in the body of the message. For example, if a message contains @@ -17145,16 +17319,15 @@ access file descriptors if they are referenced in this way by a value of type %G_VARIANT_TYPE_HANDLE in the body of the message. This method is only available on UNIX. - + a #GDBusConnection + filename="gio/gdbusconnection.c" + line="6807">a #GDBusConnection nullable="1" allow-none="1"> a unique or well-known bus name or %NULL if + filename="gio/gdbusconnection.c" + line="6808">a unique or well-known bus name or %NULL if @connection is not a message bus connection path of remote object + filename="gio/gdbusconnection.c" + line="6810">path of remote object D-Bus interface to invoke method on + filename="gio/gdbusconnection.c" + line="6811">D-Bus interface to invoke method on the name of the method to invoke + filename="gio/gdbusconnection.c" + line="6812">the name of the method to invoke nullable="1" allow-none="1"> a #GVariant tuple with parameters for the method + filename="gio/gdbusconnection.c" + line="6813">a #GVariant tuple with parameters for the method or %NULL if not passing parameters @@ -17200,20 +17373,20 @@ This method is only available on UNIX. nullable="1" allow-none="1"> the expected type of the reply, or %NULL + filename="gio/gdbusconnection.c" + line="6815">the expected type of the reply, or %NULL flags from the #GDBusCallFlags enumeration + filename="gio/gdbusconnection.c" + line="6816">flags from the #GDBusCallFlags enumeration the timeout in milliseconds, -1 to use the default + filename="gio/gdbusconnection.c" + line="6817">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -17222,8 +17395,8 @@ This method is only available on UNIX. nullable="1" allow-none="1"> a #GUnixFDList or %NULL + filename="gio/gdbusconnection.c" + line="6819">a #GUnixFDList or %NULL nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="6820">a #GCancellable or %NULL scope="async" closure="11"> a #GAsyncReadyCallback to call when the request is + filename="gio/gdbusconnection.c" + line="6821">a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't * care about the result of the method invocation @@ -17253,8 +17426,8 @@ This method is only available on UNIX. nullable="1" allow-none="1"> The data to pass to @callback. + filename="gio/gdbusconnection.c" + line="6824">The data to pass to @callback. @@ -17264,8 +17437,8 @@ This method is only available on UNIX. version="2.30" throws="1"> Finishes an operation started with g_dbus_connection_call_with_unix_fd_list(). + filename="gio/gdbusconnection.c" + line="6862">Finishes an operation started with g_dbus_connection_call_with_unix_fd_list(). The file descriptors normally correspond to %G_VARIANT_TYPE_HANDLE values in the body of the message. For example, @@ -17277,20 +17450,19 @@ When designing D-Bus APIs that are intended to be interoperable, please note that non-GDBus implementations of D-Bus can usually only access file descriptors if they are referenced in this way by a value of type %G_VARIANT_TYPE_HANDLE in the body of the message. - + %NULL if @error is set. Otherwise a non-floating + filename="gio/gdbusconnection.c" + line="6883">%NULL if @error is set. Otherwise a non-floating #GVariant tuple with return values. Free with g_variant_unref(). a #GDBusConnection + filename="gio/gdbusconnection.c" + line="6864">a #GDBusConnection optional="1" allow-none="1"> return location for a #GUnixFDList or %NULL + filename="gio/gdbusconnection.c" + line="6865">return location for a #GUnixFDList or %NULL a #GAsyncResult obtained from the #GAsyncReadyCallback passed to + filename="gio/gdbusconnection.c" + line="6866">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_call_with_unix_fd_list() @@ -17316,28 +17488,28 @@ value of type %G_VARIANT_TYPE_HANDLE in the body of the message. + throws="1" + glib:async-func="call_with_unix_fd_list"> Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects. + filename="gio/gdbusconnection.c" + line="6897">Like g_dbus_connection_call_sync() but also takes and returns #GUnixFDList objects. See g_dbus_connection_call_with_unix_fd_list() and g_dbus_connection_call_with_unix_fd_list_finish() for more details. This method is only available on UNIX. - + %NULL if @error is set. Otherwise a non-floating + filename="gio/gdbusconnection.c" + line="6922">%NULL if @error is set. Otherwise a non-floating #GVariant tuple with return values. Free with g_variant_unref(). a #GDBusConnection + filename="gio/gdbusconnection.c" + line="6899">a #GDBusConnection nullable="1" allow-none="1"> a unique or well-known bus name or %NULL + filename="gio/gdbusconnection.c" + line="6900">a unique or well-known bus name or %NULL if @connection is not a message bus connection path of remote object + filename="gio/gdbusconnection.c" + line="6902">path of remote object D-Bus interface to invoke method on + filename="gio/gdbusconnection.c" + line="6903">D-Bus interface to invoke method on the name of the method to invoke + filename="gio/gdbusconnection.c" + line="6904">the name of the method to invoke nullable="1" allow-none="1"> a #GVariant tuple with parameters for + filename="gio/gdbusconnection.c" + line="6905">a #GVariant tuple with parameters for the method or %NULL if not passing parameters @@ -17383,20 +17555,20 @@ This method is only available on UNIX. nullable="1" allow-none="1"> the expected type of the reply, or %NULL + filename="gio/gdbusconnection.c" + line="6907">the expected type of the reply, or %NULL flags from the #GDBusCallFlags enumeration + filename="gio/gdbusconnection.c" + line="6908">flags from the #GDBusCallFlags enumeration the timeout in milliseconds, -1 to use the default + filename="gio/gdbusconnection.c" + line="6909">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -17405,8 +17577,8 @@ This method is only available on UNIX. nullable="1" allow-none="1"> a #GUnixFDList or %NULL + filename="gio/gdbusconnection.c" + line="6911">a #GUnixFDList or %NULL optional="1" allow-none="1"> return location for a #GUnixFDList or %NULL + filename="gio/gdbusconnection.c" + line="6912">return location for a #GUnixFDList or %NULL nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="6913">a #GCancellable or %NULL + version="2.26" + glib:finish-func="close_finish" + glib:sync-func="close_sync"> Closes @connection. Note that this never causes the process to + filename="gio/gdbusconnection.c" + line="1542">Closes @connection. Note that this never causes the process to exit (this might only happen if the other end of a shared message bus connection disconnects, see #GDBusConnection:exit-on-close). @@ -17460,16 +17634,15 @@ of the thread you are calling this method from. You can then call g_dbus_connection_close_finish() to get the result of the operation. See g_dbus_connection_close_sync() for the synchronous version. - + a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1544">a #GDBusConnection nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="1545">a #GCancellable or %NULL scope="async" closure="2"> a #GAsyncReadyCallback to call when the request is + filename="gio/gdbusconnection.c" + line="1546">a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result @@ -17498,8 +17671,8 @@ version. nullable="1" allow-none="1"> The data to pass to @callback + filename="gio/gdbusconnection.c" + line="1548">The data to pass to @callback @@ -17509,27 +17682,26 @@ version. version="2.26" throws="1"> Finishes an operation started with g_dbus_connection_close(). - + filename="gio/gdbusconnection.c" + line="1599">Finishes an operation started with g_dbus_connection_close(). + %TRUE if the operation succeeded, %FALSE if @error is set + filename="gio/gdbusconnection.c" + line="1608">%TRUE if the operation succeeded, %FALSE if @error is set a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1601">a #GDBusConnection a #GAsyncResult obtained from the #GAsyncReadyCallback passed + filename="gio/gdbusconnection.c" + line="1602">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_close() @@ -17538,26 +17710,26 @@ version. + throws="1" + glib:async-func="close"> Synchronously closes @connection. The calling thread is blocked + filename="gio/gdbusconnection.c" + line="1641">Synchronously closes @connection. The calling thread is blocked until this is done. See g_dbus_connection_close() for the asynchronous version of this method and more details about what it does. - + %TRUE if the operation succeeded, %FALSE if @error is set + filename="gio/gdbusconnection.c" + line="1652">%TRUE if the operation succeeded, %FALSE if @error is set a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1643">a #GDBusConnection nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="1644">a #GCancellable or %NULL @@ -17576,27 +17748,26 @@ does. version="2.26" throws="1"> Emits a signal. + filename="gio/gdbusconnection.c" + line="6119">Emits a signal. If the parameters GVariant is floating, it is consumed. This can only fail if @parameters is not compatible with the D-Bus protocol (%G_IO_ERROR_INVALID_ARGUMENT), or if @connection has been closed (%G_IO_ERROR_CLOSED). - + %TRUE unless @error is set + filename="gio/gdbusconnection.c" + line="6139">%TRUE unless @error is set a #GDBusConnection + filename="gio/gdbusconnection.c" + line="6121">a #GDBusConnection the unique bus name for the destination + filename="gio/gdbusconnection.c" + line="6122">the unique bus name for the destination for the signal or %NULL to emit to all listeners path of remote object + filename="gio/gdbusconnection.c" + line="6124">path of remote object D-Bus interface to emit a signal on + filename="gio/gdbusconnection.c" + line="6125">D-Bus interface to emit a signal on the name of the signal to emit + filename="gio/gdbusconnection.c" + line="6126">the name of the signal to emit a #GVariant tuple with parameters for the signal + filename="gio/gdbusconnection.c" + line="6127">a #GVariant tuple with parameters for the signal or %NULL if not passing parameters @@ -17644,8 +17815,8 @@ This can only fail if @parameters is not compatible with the D-Bus protocol version="2.32" throws="1"> Exports @action_group on @connection at @object_path. + filename="gio/gactiongroupexporter.c" + line="557">Exports @action_group on @connection at @object_path. The implemented D-Bus API should be considered private. It is subject to change in the future. @@ -17666,31 +17837,30 @@ Since incoming action activations and state change requests are rather likely to cause changes on the action group, this effectively limits a given action group to being exported from only one main context. - + the ID of the export (never zero), or 0 in case of failure + filename="gio/gactiongroupexporter.c" + line="586">the ID of the export (never zero), or 0 in case of failure a #GDBusConnection + filename="gio/gactiongroupexporter.c" + line="559">a #GDBusConnection a D-Bus object path + filename="gio/gactiongroupexporter.c" + line="560">a D-Bus object path a #GActionGroup + filename="gio/gactiongroupexporter.c" + line="561">a #GActionGroup @@ -17700,8 +17870,8 @@ context. version="2.32" throws="1"> Exports @menu on @connection at @object_path. + filename="gio/gmenuexporter.c" + line="754">Exports @menu on @connection at @object_path. The implemented D-Bus API should be considered private. It is subject to change in the future. @@ -17717,41 +17887,42 @@ undefined behavior. You can unexport the menu model using g_dbus_connection_unexport_menu_model() with the return value of this function. - + the ID of the export (never zero), or 0 in case of failure + filename="gio/gmenuexporter.c" + line="778">the ID of the export (never zero), or 0 in case of failure a #GDBusConnection + filename="gio/gmenuexporter.c" + line="756">a #GDBusConnection a D-Bus object path + filename="gio/gmenuexporter.c" + line="757">a D-Bus object path a #GMenuModel + filename="gio/gmenuexporter.c" + line="758">a #GMenuModel + version="2.26" + glib:finish-func="flush_finish" + glib:sync-func="flush_sync"> Asynchronously flushes @connection, that is, writes all queued + filename="gio/gdbusconnection.c" + line="1361">Asynchronously flushes @connection, that is, writes all queued outgoing message to the transport and then flushes the transport (using g_output_stream_flush_async()). This is useful in programs that wants to emit a D-Bus signal and then exit immediately. Without @@ -17765,16 +17936,15 @@ of the thread you are calling this method from. You can then call g_dbus_connection_flush_finish() to get the result of the operation. See g_dbus_connection_flush_sync() for the synchronous version. - + a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1363">a #GDBusConnection nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="1364">a #GCancellable or %NULL scope="async" closure="2"> a #GAsyncReadyCallback to call when the + filename="gio/gdbusconnection.c" + line="1365">a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result @@ -17803,8 +17973,8 @@ version. nullable="1" allow-none="1"> The data to pass to @callback + filename="gio/gdbusconnection.c" + line="1367">The data to pass to @callback @@ -17814,27 +17984,26 @@ version. version="2.26" throws="1"> Finishes an operation started with g_dbus_connection_flush(). - + filename="gio/gdbusconnection.c" + line="1402">Finishes an operation started with g_dbus_connection_flush(). + %TRUE if the operation succeeded, %FALSE if @error is set + filename="gio/gdbusconnection.c" + line="1411">%TRUE if the operation succeeded, %FALSE if @error is set a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1404">a #GDBusConnection a #GAsyncResult obtained from the #GAsyncReadyCallback passed + filename="gio/gdbusconnection.c" + line="1405">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_flush() @@ -17843,26 +18012,26 @@ version. + throws="1" + glib:async-func="flush"> Synchronously flushes @connection. The calling thread is blocked + filename="gio/gdbusconnection.c" + line="1427">Synchronously flushes @connection. The calling thread is blocked until this is done. See g_dbus_connection_flush() for the asynchronous version of this method and more details about what it does. - + %TRUE if the operation succeeded, %FALSE if @error is set + filename="gio/gdbusconnection.c" + line="1438">%TRUE if the operation succeeded, %FALSE if @error is set a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1429">a #GDBusConnection nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="1430">a #GCancellable or %NULL @@ -17881,21 +18050,20 @@ does. glib:get-property="capabilities" version="2.26"> Gets the capabilities negotiated with the remote peer - + filename="gio/gdbusconnection.c" + line="1298">Gets the capabilities negotiated with the remote peer + zero or more flags from the #GDBusCapabilityFlags enumeration + filename="gio/gdbusconnection.c" + line="1304">zero or more flags from the #GDBusCapabilityFlags enumeration a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1300">a #GDBusConnection @@ -17905,24 +18073,23 @@ does. glib:get-property="exit-on-close" version="2.26"> Gets whether the process is terminated when @connection is + filename="gio/gdbusconnection.c" + line="3369">Gets whether the process is terminated when @connection is closed by the remote peer. See #GDBusConnection:exit-on-close for more details. - + whether the process is terminated when @connection is + filename="gio/gdbusconnection.c" + line="3377">whether the process is terminated when @connection is closed by the remote peer a #GDBusConnection + filename="gio/gdbusconnection.c" + line="3371">a #GDBusConnection @@ -17932,21 +18099,20 @@ closed by the remote peer. See glib:get-property="flags" version="2.60"> Gets the flags used to construct this connection - + filename="gio/gdbusconnection.c" + line="1320">Gets the flags used to construct this connection + zero or more flags from the #GDBusConnectionFlags enumeration + filename="gio/gdbusconnection.c" + line="1326">zero or more flags from the #GDBusConnectionFlags enumeration a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1322">a #GDBusConnection @@ -17956,23 +18122,22 @@ closed by the remote peer. See glib:get-property="guid" version="2.26"> The GUID of the peer performing the role of server when + filename="gio/gdbusconnection.c" + line="3393">The GUID of the peer performing the role of server when authenticating. See #GDBusConnection:guid for more details. - + The GUID. Do not free this string, it is owned by + filename="gio/gdbusconnection.c" + line="3400">The GUID. Do not free this string, it is owned by @connection. a #GDBusConnection + filename="gio/gdbusconnection.c" + line="3395">a #GDBusConnection @@ -17981,26 +18146,25 @@ authenticating. See #GDBusConnection:guid for more details. c:identifier="g_dbus_connection_get_last_serial" version="2.34"> Retrieves the last serial number assigned to a #GDBusMessage on + filename="gio/gdbusconnection.c" + line="1693">Retrieves the last serial number assigned to a #GDBusMessage on the current thread. This includes messages sent via both low-level API such as g_dbus_connection_send_message() as well as high-level API such as g_dbus_connection_emit_signal(), g_dbus_connection_call() or g_dbus_proxy_call(). - + the last used serial or zero when no message has been sent + filename="gio/gdbusconnection.c" + line="1703">the last used serial or zero when no message has been sent within the current thread a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1695">a #GDBusConnection @@ -18009,8 +18173,8 @@ g_dbus_connection_call() or g_dbus_proxy_call(). c:identifier="g_dbus_connection_get_peer_credentials" version="2.26"> Gets the credentials of the authenticated peer. This will always + filename="gio/gdbusconnection.c" + line="3438">Gets the credentials of the authenticated peer. This will always return %NULL unless @connection acted as a server (e.g. %G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER was passed) when set up and the client passed credentials as part of the @@ -18019,20 +18183,19 @@ authentication process. In a message bus setup, the message bus is always the server and each application is a client. So this method will always return %NULL for message bus clients. - + a #GCredentials or %NULL if not + filename="gio/gdbusconnection.c" + line="3452">a #GCredentials or %NULL if not available. Do not free this object, it is owned by @connection. a #GDBusConnection + filename="gio/gdbusconnection.c" + line="3440">a #GDBusConnection @@ -18042,25 +18205,24 @@ each application is a client. So this method will always return glib:get-property="stream" version="2.26"> Gets the underlying stream used for IO. + filename="gio/gdbusconnection.c" + line="1226">Gets the underlying stream used for IO. While the #GDBusConnection is active, it will interact with this stream from a worker thread, so it is not safe to interact with the stream directly. - + the stream used for IO + filename="gio/gdbusconnection.c" + line="1236">the stream used for IO a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1228">a #GDBusConnection @@ -18070,16 +18232,15 @@ the stream directly. glib:get-property="unique-name" version="2.26"> Gets the unique name of @connection as assigned by the message + filename="gio/gdbusconnection.c" + line="3412">Gets the unique name of @connection as assigned by the message bus. This can also be used to figure out if @connection is a message bus connection. - + the unique name or %NULL if @connection is not a message + filename="gio/gdbusconnection.c" + line="3420">the unique name or %NULL if @connection is not a message bus connection. Do not free this string, it is owned by @connection. @@ -18087,8 +18248,8 @@ message bus connection. a #GDBusConnection + filename="gio/gdbusconnection.c" + line="3414">a #GDBusConnection @@ -18097,21 +18258,20 @@ message bus connection. c:identifier="g_dbus_connection_is_closed" version="2.26"> Gets whether @connection is closed. - + filename="gio/gdbusconnection.c" + line="1276">Gets whether @connection is closed. + %TRUE if the connection is closed, %FALSE otherwise + filename="gio/gdbusconnection.c" + line="1282">%TRUE if the connection is closed, %FALSE otherwise a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1278">a #GDBusConnection @@ -18122,8 +18282,8 @@ message bus connection. version="2.26" throws="1"> Registers callbacks for exported objects at @object_path with the + filename="gio/gdbusconnection.c" + line="5681">Registers callbacks for exported objects at @object_path with the D-Bus interface that is described in @interface_info. Calls to functions in @vtable (and @user_data_free_func) will happen @@ -18161,32 +18321,31 @@ reference count is -1, see g_dbus_interface_info_ref()) for as long as the object is exported. Also note that @vtable will be copied. See this [server][gdbus-server] for an example of how to use this method. - + 0 if @error is set, otherwise a registration id (never 0) + filename="gio/gdbusconnection.c" + line="5730">0 if @error is set, otherwise a registration id (never 0) that can be used with g_dbus_connection_unregister_object() a #GDBusConnection + filename="gio/gdbusconnection.c" + line="5683">a #GDBusConnection the object path to register at + filename="gio/gdbusconnection.c" + line="5684">the object path to register at introspection data for the interface + filename="gio/gdbusconnection.c" + line="5685">introspection data for the interface nullable="1" allow-none="1"> a #GDBusInterfaceVTable to call into or %NULL + filename="gio/gdbusconnection.c" + line="5686">a #GDBusInterfaceVTable to call into or %NULL @@ -18204,16 +18363,16 @@ See this [server][gdbus-server] for an example of how to use this method. nullable="1" allow-none="1"> data to pass to functions in @vtable + filename="gio/gdbusconnection.c" + line="5687">data to pass to functions in @vtable function to call when the object path is unregistered + filename="gio/gdbusconnection.c" + line="5688">function to call when the object path is unregistered @@ -18224,35 +18383,34 @@ See this [server][gdbus-server] for an example of how to use this method. version="2.46" throws="1"> Version of g_dbus_connection_register_object() using closures instead of a + filename="gio/gdbusconnection.c" + line="6070">Version of g_dbus_connection_register_object() using closures instead of a #GDBusInterfaceVTable for easier binding in other languages. - + 0 if @error is set, otherwise a registration ID (never 0) + filename="gio/gdbusconnection.c" + line="6083">0 if @error is set, otherwise a registration ID (never 0) that can be used with g_dbus_connection_unregister_object() . A #GDBusConnection. + filename="gio/gdbusconnection.c" + line="6072">A #GDBusConnection. The object path to register at. + filename="gio/gdbusconnection.c" + line="6073">The object path to register at. Introspection data for the interface. + filename="gio/gdbusconnection.c" + line="6074">Introspection data for the interface. nullable="1" allow-none="1"> #GClosure for handling incoming method calls. + filename="gio/gdbusconnection.c" + line="6075">#GClosure for handling incoming method calls. nullable="1" allow-none="1"> #GClosure for getting a property. + filename="gio/gdbusconnection.c" + line="6076">#GClosure for getting a property. nullable="1" allow-none="1"> #GClosure for setting a property. + filename="gio/gdbusconnection.c" + line="6077">#GClosure for setting a property. @@ -18289,8 +18447,8 @@ that can be used with g_dbus_connection_unregister_object() . version="2.26" throws="1"> Registers a whole subtree of dynamic objects. + filename="gio/gdbusconnection.c" + line="7361">Registers a whole subtree of dynamic objects. The @enumerate and @introspection functions in @vtable are used to convey, to remote callers, what nodes exist in the subtree rooted @@ -18324,39 +18482,38 @@ registration. See this [server][gdbus-subtree-server] for an example of how to use this method. - + 0 if @error is set, otherwise a subtree registration ID (never 0) + filename="gio/gdbusconnection.c" + line="7407">0 if @error is set, otherwise a subtree registration ID (never 0) that can be used with g_dbus_connection_unregister_subtree() a #GDBusConnection + filename="gio/gdbusconnection.c" + line="7363">a #GDBusConnection the object path to register the subtree at + filename="gio/gdbusconnection.c" + line="7364">the object path to register the subtree at a #GDBusSubtreeVTable to enumerate, introspect and + filename="gio/gdbusconnection.c" + line="7365">a #GDBusSubtreeVTable to enumerate, introspect and dispatch nodes in the subtree flags used to fine tune the behavior of the subtree + filename="gio/gdbusconnection.c" + line="7367">flags used to fine tune the behavior of the subtree nullable="1" allow-none="1"> data to pass to functions in @vtable + filename="gio/gdbusconnection.c" + line="7368">data to pass to functions in @vtable function to call when the subtree is unregistered + filename="gio/gdbusconnection.c" + line="7369">function to call when the subtree is unregistered @@ -18382,8 +18539,8 @@ that can be used with g_dbus_connection_unregister_subtree() c:identifier="g_dbus_connection_remove_filter" version="2.26"> Removes a filter. + filename="gio/gdbusconnection.c" + line="3550">Removes a filter. Note that since filters run in a different thread, there is a race condition where it is possible that the filter will be running even @@ -18391,22 +18548,21 @@ after calling g_dbus_connection_remove_filter(), so you cannot just free data that the filter might be using. Instead, you should pass a #GDestroyNotify to g_dbus_connection_add_filter(), which will be called when it is guaranteed that the data is no longer needed. - + a #GDBusConnection + filename="gio/gdbusconnection.c" + line="3552">a #GDBusConnection an identifier obtained from g_dbus_connection_add_filter() + filename="gio/gdbusconnection.c" + line="3553">an identifier obtained from g_dbus_connection_add_filter() @@ -18416,8 +18572,8 @@ called when it is guaranteed that the data is no longer needed. version="2.26" throws="1"> Asynchronously sends @message to the peer represented by @connection. + filename="gio/gdbusconnection.c" + line="1817">Asynchronously sends @message to the peer represented by @connection. Unless @flags contain the %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number @@ -18438,32 +18594,31 @@ UNIX file descriptors. Note that @message must be unlocked, unless @flags contain the %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag. - + %TRUE if the message was well-formed and queued for + filename="gio/gdbusconnection.c" + line="1848">%TRUE if the message was well-formed and queued for transmission, %FALSE if @error is set a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1819">a #GDBusConnection a #GDBusMessage + filename="gio/gdbusconnection.c" + line="1820">a #GDBusMessage flags affecting how the message is sent + filename="gio/gdbusconnection.c" + line="1821">flags affecting how the message is sent return location for serial number assigned + filename="gio/gdbusconnection.c" + line="1822">return location for serial number assigned to @message when sending it or %NULL @@ -18482,10 +18637,11 @@ Note that @message must be unlocked, unless @flags contain the + version="2.26" + glib:finish-func="send_message_with_reply_finish"> Asynchronously sends @message to the peer represented by @connection. + filename="gio/gdbusconnection.c" + line="2096">Asynchronously sends @message to the peer represented by @connection. Unless @flags contain the %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag, the serial number @@ -18514,34 +18670,33 @@ Note that @message must be unlocked, unless @flags contain the See this [server][gdbus-server] and [client][gdbus-unix-fd-client] for an example of how to use this low-level API to send and receive UNIX file descriptors. - + a #GDBusConnection + filename="gio/gdbusconnection.c" + line="2098">a #GDBusConnection a #GDBusMessage + filename="gio/gdbusconnection.c" + line="2099">a #GDBusMessage flags affecting how the message is sent + filename="gio/gdbusconnection.c" + line="2100">flags affecting how the message is sent the timeout in milliseconds, -1 to use the default + filename="gio/gdbusconnection.c" + line="2101">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -18552,8 +18707,8 @@ UNIX file descriptors. optional="1" allow-none="1"> return location for serial number assigned + filename="gio/gdbusconnection.c" + line="2103">return location for serial number assigned to @message when sending it or %NULL @@ -18562,8 +18717,8 @@ UNIX file descriptors. nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="2105">a #GCancellable or %NULL scope="async" closure="6"> a #GAsyncReadyCallback to call when the request + filename="gio/gdbusconnection.c" + line="2106">a #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result @@ -18583,8 +18738,8 @@ UNIX file descriptors. nullable="1" allow-none="1"> The data to pass to @callback + filename="gio/gdbusconnection.c" + line="2108">The data to pass to @callback @@ -18594,8 +18749,8 @@ UNIX file descriptors. version="2.26" throws="1"> Finishes an operation started with g_dbus_connection_send_message_with_reply(). + filename="gio/gdbusconnection.c" + line="2169">Finishes an operation started with g_dbus_connection_send_message_with_reply(). Note that @error is only set if a local in-process error occurred. That is to say that the returned #GDBusMessage object may @@ -18605,25 +18760,24 @@ g_dbus_message_to_gerror() to transcode this to a #GError. See this [server][gdbus-server] and [client][gdbus-unix-fd-client] for an example of how to use this low-level API to send and receive UNIX file descriptors. - + a locked #GDBusMessage or %NULL if @error is set + filename="gio/gdbusconnection.c" + line="2187">a locked #GDBusMessage or %NULL if @error is set a #GDBusConnection + filename="gio/gdbusconnection.c" + line="2171">a #GDBusConnection a #GAsyncResult obtained from the #GAsyncReadyCallback passed to + filename="gio/gdbusconnection.c" + line="2172">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_connection_send_message_with_reply() @@ -18634,8 +18788,8 @@ UNIX file descriptors. version="2.26" throws="1"> Synchronously sends @message to the peer represented by @connection + filename="gio/gdbusconnection.c" + line="2223">Synchronously sends @message to the peer represented by @connection and blocks the calling thread until a reply is received or the timeout is reached. See g_dbus_connection_send_message_with_reply() for the asynchronous version of this method. @@ -18665,38 +18819,37 @@ UNIX file descriptors. Note that @message must be unlocked, unless @flags contain the %G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL flag. - + a locked #GDBusMessage that is the reply + filename="gio/gdbusconnection.c" + line="2266">a locked #GDBusMessage that is the reply to @message or %NULL if @error is set a #GDBusConnection + filename="gio/gdbusconnection.c" + line="2225">a #GDBusConnection a #GDBusMessage + filename="gio/gdbusconnection.c" + line="2226">a #GDBusMessage flags affecting how the message is sent. + filename="gio/gdbusconnection.c" + line="2227">flags affecting how the message is sent. the timeout in milliseconds, -1 to use the default + filename="gio/gdbusconnection.c" + line="2228">the timeout in milliseconds, -1 to use the default timeout or %G_MAXINT for no timeout @@ -18707,8 +18860,8 @@ Note that @message must be unlocked, unless @flags contain the optional="1" allow-none="1"> return location for serial number + filename="gio/gdbusconnection.c" + line="2230">return location for serial number assigned to @message when sending it or %NULL @@ -18717,8 +18870,8 @@ Note that @message must be unlocked, unless @flags contain the nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="2232">a #GCancellable or %NULL @@ -18728,8 +18881,8 @@ Note that @message must be unlocked, unless @flags contain the glib:set-property="exit-on-close" version="2.26"> Sets whether the process should be terminated when @connection is + filename="gio/gdbusconnection.c" + line="3337">Sets whether the process should be terminated when @connection is closed by the remote peer. See #GDBusConnection:exit-on-close for more details. @@ -18739,22 +18892,21 @@ all of a user's applications to quit when their bus connection goes away. If you are setting @exit_on_close to %FALSE for the shared session bus connection, you should make sure that your application exits when the user session ends. - + a #GDBusConnection + filename="gio/gdbusconnection.c" + line="3339">a #GDBusConnection whether the process should be terminated + filename="gio/gdbusconnection.c" + line="3340">whether the process should be terminated when @connection is closed by the remote peer @@ -18764,8 +18916,8 @@ when the user session ends. c:identifier="g_dbus_connection_signal_subscribe" version="2.26"> Subscribes to signals on @connection and invokes @callback whenever + filename="gio/gdbusconnection.c" + line="3763">Subscribes to signals on @connection and invokes @callback whenever the signal is received. Note that @callback will be invoked in the [thread-default main context][g-main-context-push-thread-default] of the thread you are calling this method from. @@ -18814,19 +18966,18 @@ The returned subscription identifier is an opaque value which is guaranteed to never be zero. This function can never fail. - + a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe() + filename="gio/gdbusconnection.c" + line="3833">a subscription identifier that can be used with g_dbus_connection_signal_unsubscribe() a #GDBusConnection + filename="gio/gdbusconnection.c" + line="3765">a #GDBusConnection nullable="1" allow-none="1"> sender name to match on (unique or well-known name) + filename="gio/gdbusconnection.c" + line="3766">sender name to match on (unique or well-known name) or %NULL to listen from all senders @@ -18844,8 +18995,8 @@ This function can never fail. nullable="1" allow-none="1"> D-Bus interface name to match on or %NULL to + filename="gio/gdbusconnection.c" + line="3768">D-Bus interface name to match on or %NULL to match on all interfaces @@ -18854,8 +19005,8 @@ This function can never fail. nullable="1" allow-none="1"> D-Bus signal name to match on or %NULL to match on + filename="gio/gdbusconnection.c" + line="3770">D-Bus signal name to match on or %NULL to match on all signals @@ -18864,8 +19015,8 @@ This function can never fail. nullable="1" allow-none="1"> object path to match on or %NULL to match on + filename="gio/gdbusconnection.c" + line="3772">object path to match on or %NULL to match on all object paths @@ -18874,15 +19025,15 @@ This function can never fail. nullable="1" allow-none="1"> contents of first string argument to match on or %NULL + filename="gio/gdbusconnection.c" + line="3774">contents of first string argument to match on or %NULL to match on all kinds of arguments #GDBusSignalFlags describing how arg0 is used in subscribing to the + filename="gio/gdbusconnection.c" + line="3776">#GDBusSignalFlags describing how arg0 is used in subscribing to the signal @@ -18892,8 +19043,8 @@ This function can never fail. closure="7" destroy="8"> callback to invoke when there is a signal matching the requested data + filename="gio/gdbusconnection.c" + line="3778">callback to invoke when there is a signal matching the requested data nullable="1" allow-none="1"> user data to pass to @callback + filename="gio/gdbusconnection.c" + line="3779">user data to pass to @callback allow-none="1" scope="async"> function to free @user_data with when + filename="gio/gdbusconnection.c" + line="3780">function to free @user_data with when subscription is removed or %NULL @@ -18922,8 +19073,8 @@ This function can never fail. c:identifier="g_dbus_connection_signal_unsubscribe" version="2.26"> Unsubscribes from signals. + filename="gio/gdbusconnection.c" + line="4098">Unsubscribes from signals. Note that there may still be D-Bus traffic to process (relating to this signal subscription) in the current thread-default #GMainContext after this @@ -18935,22 +19086,21 @@ iterated. Alternatively, any idle source with a priority lower than %G_PRIORITY_DEFAULT that was scheduled after unsubscription, also indicates that all resources of this subscription are released. - + a #GDBusConnection + filename="gio/gdbusconnection.c" + line="4100">a #GDBusConnection a subscription id obtained from + filename="gio/gdbusconnection.c" + line="4101">a subscription id obtained from g_dbus_connection_signal_subscribe() @@ -18960,21 +19110,20 @@ of this subscription are released. c:identifier="g_dbus_connection_start_message_processing" version="2.26"> If @connection was created with + filename="gio/gdbusconnection.c" + line="1252">If @connection was created with %G_DBUS_CONNECTION_FLAGS_DELAY_MESSAGE_PROCESSING, this method starts processing messages. Does nothing on if @connection wasn't created with this flag or if the method has already been called. - + a #GDBusConnection + filename="gio/gdbusconnection.c" + line="1254">a #GDBusConnection @@ -18983,29 +19132,28 @@ created with this flag or if the method has already been called. c:identifier="g_dbus_connection_unexport_action_group" version="2.32"> Reverses the effect of a previous call to + filename="gio/gactiongroupexporter.c" + line="642">Reverses the effect of a previous call to g_dbus_connection_export_action_group(). It is an error to call this function with an ID that wasn't returned from g_dbus_connection_export_action_group() or to call it with the same ID more than once. - + a #GDBusConnection + filename="gio/gactiongroupexporter.c" + line="644">a #GDBusConnection the ID from g_dbus_connection_export_action_group() + filename="gio/gactiongroupexporter.c" + line="645">the ID from g_dbus_connection_export_action_group() @@ -19014,29 +19162,28 @@ same ID more than once. c:identifier="g_dbus_connection_unexport_menu_model" version="2.32"> Reverses the effect of a previous call to + filename="gio/gmenuexporter.c" + line="809">Reverses the effect of a previous call to g_dbus_connection_export_menu_model(). It is an error to call this function with an ID that wasn't returned from g_dbus_connection_export_menu_model() or to call it with the same ID more than once. - + a #GDBusConnection + filename="gio/gmenuexporter.c" + line="811">a #GDBusConnection the ID from g_dbus_connection_export_menu_model() + filename="gio/gmenuexporter.c" + line="812">the ID from g_dbus_connection_export_menu_model() @@ -19045,27 +19192,26 @@ same ID more than once. c:identifier="g_dbus_connection_unregister_object" version="2.26"> Unregisters an object. - + filename="gio/gdbusconnection.c" + line="5814">Unregisters an object. + %TRUE if the object was unregistered, %FALSE otherwise + filename="gio/gdbusconnection.c" + line="5822">%TRUE if the object was unregistered, %FALSE otherwise a #GDBusConnection + filename="gio/gdbusconnection.c" + line="5816">a #GDBusConnection a registration id obtained from + filename="gio/gdbusconnection.c" + line="5817">a registration id obtained from g_dbus_connection_register_object() @@ -19075,27 +19221,26 @@ same ID more than once. c:identifier="g_dbus_connection_unregister_subtree" version="2.26"> Unregisters a subtree. - + filename="gio/gdbusconnection.c" + line="7475">Unregisters a subtree. + %TRUE if the subtree was unregistered, %FALSE otherwise + filename="gio/gdbusconnection.c" + line="7483">%TRUE if the subtree was unregistered, %FALSE otherwise a #GDBusConnection + filename="gio/gdbusconnection.c" + line="7477">a #GDBusConnection a subtree registration id obtained from + filename="gio/gdbusconnection.c" + line="7478">a subtree registration id obtained from g_dbus_connection_register_subtree() @@ -19109,8 +19254,8 @@ same ID more than once. transfer-ownership="none" default-value="NULL"> A D-Bus address specifying potential endpoints that can be used + filename="gio/gdbusconnection.c" + line="976">A D-Bus address specifying potential endpoints that can be used when establishing the connection. @@ -19121,8 +19266,8 @@ when establishing the connection. construct-only="1" transfer-ownership="none"> A #GDBusAuthObserver object to assist in the authentication process or %NULL. + filename="gio/gdbusconnection.c" + line="1125">A #GDBusAuthObserver object to assist in the authentication process or %NULL. getter="get_capabilities" default-value="G_DBUS_CAPABILITY_FLAGS_NONE"> Flags from the #GDBusCapabilityFlags enumeration + filename="gio/gdbusconnection.c" + line="1107">Flags from the #GDBusCapabilityFlags enumeration representing connection features negotiated with the other peer. @@ -19141,8 +19286,8 @@ representing connection features negotiated with the other peer. transfer-ownership="none" default-value="FALSE"> A boolean specifying whether the connection has been closed. + filename="gio/gdbusconnection.c" + line="1069">A boolean specifying whether the connection has been closed. getter="get_exit_on_close" default-value="FALSE"> A boolean specifying whether the process will be terminated (by + filename="gio/gdbusconnection.c" + line="1085">A boolean specifying whether the process will be terminated (by calling `raise(SIGTERM)`) if the connection is closed by the remote peer. @@ -19170,8 +19315,8 @@ and g_bus_get_sync() will (usually) have this property set to %TRUE. getter="get_flags" default-value="G_DBUS_CONNECTION_FLAGS_NONE"> Flags from the #GDBusConnectionFlags enumeration. + filename="gio/gdbusconnection.c" + line="994">Flags from the #GDBusConnectionFlags enumeration. getter="get_guid" default-value="NULL"> The GUID of the peer performing the role of server when + filename="gio/gdbusconnection.c" + line="1013">The GUID of the peer performing the role of server when authenticating. If you are constructing a #GDBusConnection and pass @@ -19214,8 +19359,8 @@ GUID format. transfer-ownership="none" getter="get_stream"> The underlying #GIOStream used for I/O. + filename="gio/gdbusconnection.c" + line="951">The underlying #GIOStream used for I/O. If this is passed on construction and is a #GSocketConnection, then the corresponding #GSocket will be put into non-blocking mode. @@ -19231,15 +19376,15 @@ the stream directly. getter="get_unique_name" default-value="NULL"> The unique name as assigned by the message bus or %NULL if the + filename="gio/gdbusconnection.c" + line="1052">The unique name as assigned by the message bus or %NULL if the connection is not open or not a message bus connection. Emitted when the connection is closed. + filename="gio/gdbusconnection.c" + line="1142">Emitted when the connection is closed. The cause of this event can be @@ -19261,8 +19406,8 @@ once. %TRUE if @connection is closed because the + filename="gio/gdbusconnection.c" + line="1145">%TRUE if @connection is closed because the remote peer closed its end of the connection @@ -19271,8 +19416,8 @@ once. nullable="1" allow-none="1"> a #GError with more details about the event or %NULL + filename="gio/gdbusconnection.c" + line="1147">a #GError with more details about the event or %NULL @@ -19284,16 +19429,16 @@ once. glib:get-type="g_dbus_connection_flags_get_type" c:type="GDBusConnectionFlags"> Flags used when creating a new #GDBusConnection. + filename="gio/gioenums.h" + line="1214">Flags used when creating a new #GDBusConnection. No flags set. + filename="gio/gioenums.h" + line="1216">No flags set. glib:nick="authentication-client" glib:name="G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_CLIENT"> Perform authentication against server. + filename="gio/gioenums.h" + line="1217">Perform authentication against server. glib:nick="authentication-server" glib:name="G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_SERVER"> Perform authentication against client. + filename="gio/gioenums.h" + line="1218">Perform authentication against client. glib:nick="authentication-allow-anonymous" glib:name="G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS"> When + filename="gio/gioenums.h" + line="1219">When authenticating as a server, allow the anonymous authentication method. @@ -19330,8 +19475,8 @@ method. glib:nick="message-bus-connection" glib:name="G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION"> Pass this flag if connecting to a peer that is a + filename="gio/gioenums.h" + line="1222">Pass this flag if connecting to a peer that is a message bus. This means that the Hello() method will be invoked as part of the connection setup. If set, processing of D-Bus messages is + filename="gio/gioenums.h" + line="1224">If set, processing of D-Bus messages is delayed until g_dbus_connection_start_message_processing() is called. glib:nick="authentication-require-same-user" glib:name="G_DBUS_CONNECTION_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER"> When authenticating + filename="gio/gioenums.h" + line="1226">When authenticating as a server, require the UID of the peer to be the same as the UID of the server. (Since: 2.68) When authenticating, try to use + filename="gio/gioenums.h" + line="1228">When authenticating, try to use protocols that work across a Linux user namespace boundary, even if this reduces interoperability with older D-Bus implementations. This currently affects client-side `EXTERNAL` authentication, for which this flag makes @@ -19376,16 +19521,16 @@ as a server, require the UID of the peer to be the same as the UID of the server c:type="GDBusError" glib:error-domain="g-dbus-error-quark"> Error codes for the %G_DBUS_ERROR error domain. + filename="gio/gioenums.h" + line="1056">Error codes for the %G_DBUS_ERROR error domain. A generic error; "something went wrong" - see the error message for + filename="gio/gioenums.h" + line="1058">A generic error; "something went wrong" - see the error message for more. glib:nick="no-memory" glib:name="G_DBUS_ERROR_NO_MEMORY"> There was not enough memory to complete an operation. + filename="gio/gioenums.h" + line="1061">There was not enough memory to complete an operation. glib:nick="service-unknown" glib:name="G_DBUS_ERROR_SERVICE_UNKNOWN"> The bus doesn't know how to launch a service to supply the bus name + filename="gio/gioenums.h" + line="1063">The bus doesn't know how to launch a service to supply the bus name you wanted. glib:nick="name-has-no-owner" glib:name="G_DBUS_ERROR_NAME_HAS_NO_OWNER"> The bus name you referenced doesn't exist (i.e. no application owns + filename="gio/gioenums.h" + line="1066">The bus name you referenced doesn't exist (i.e. no application owns it). glib:nick="no-reply" glib:name="G_DBUS_ERROR_NO_REPLY"> No reply to a message expecting one, usually means a timeout occurred. + filename="gio/gioenums.h" + line="1069">No reply to a message expecting one, usually means a timeout occurred. glib:nick="io-error" glib:name="G_DBUS_ERROR_IO_ERROR"> Something went wrong reading or writing to a socket, for example. + filename="gio/gioenums.h" + line="1071">Something went wrong reading or writing to a socket, for example. glib:nick="bad-address" glib:name="G_DBUS_ERROR_BAD_ADDRESS"> A D-Bus bus address was malformed. + filename="gio/gioenums.h" + line="1073">A D-Bus bus address was malformed. glib:nick="not-supported" glib:name="G_DBUS_ERROR_NOT_SUPPORTED"> Requested operation isn't supported (like ENOSYS on UNIX). + filename="gio/gioenums.h" + line="1075">Requested operation isn't supported (like ENOSYS on UNIX). glib:nick="limits-exceeded" glib:name="G_DBUS_ERROR_LIMITS_EXCEEDED"> Some limited resource is exhausted. + filename="gio/gioenums.h" + line="1077">Some limited resource is exhausted. glib:nick="access-denied" glib:name="G_DBUS_ERROR_ACCESS_DENIED"> Security restrictions don't allow doing what you're trying to do. + filename="gio/gioenums.h" + line="1079">Security restrictions don't allow doing what you're trying to do. glib:nick="auth-failed" glib:name="G_DBUS_ERROR_AUTH_FAILED"> Authentication didn't work. + filename="gio/gioenums.h" + line="1081">Authentication didn't work. glib:nick="no-server" glib:name="G_DBUS_ERROR_NO_SERVER"> Unable to connect to server (probably caused by ECONNREFUSED on a + filename="gio/gioenums.h" + line="1083">Unable to connect to server (probably caused by ECONNREFUSED on a socket). glib:nick="timeout" glib:name="G_DBUS_ERROR_TIMEOUT"> Certain timeout errors, possibly ETIMEDOUT on a socket. Note that + filename="gio/gioenums.h" + line="1086">Certain timeout errors, possibly ETIMEDOUT on a socket. Note that %G_DBUS_ERROR_NO_REPLY is used for message reply timeouts. Warning: this is confusingly-named given that %G_DBUS_ERROR_TIMED_OUT also exists. We can't fix it for compatibility reasons so just be @@ -19509,8 +19654,8 @@ careful. glib:nick="no-network" glib:name="G_DBUS_ERROR_NO_NETWORK"> No network access (probably ENETUNREACH on a socket). + filename="gio/gioenums.h" + line="1092">No network access (probably ENETUNREACH on a socket). glib:nick="address-in-use" glib:name="G_DBUS_ERROR_ADDRESS_IN_USE"> Can't bind a socket since its address is in use (i.e. EADDRINUSE). + filename="gio/gioenums.h" + line="1094">Can't bind a socket since its address is in use (i.e. EADDRINUSE). glib:nick="disconnected" glib:name="G_DBUS_ERROR_DISCONNECTED"> The connection is disconnected and you're trying to use it. + filename="gio/gioenums.h" + line="1096">The connection is disconnected and you're trying to use it. glib:nick="invalid-args" glib:name="G_DBUS_ERROR_INVALID_ARGS"> Invalid arguments passed to a method call. + filename="gio/gioenums.h" + line="1098">Invalid arguments passed to a method call. glib:nick="file-not-found" glib:name="G_DBUS_ERROR_FILE_NOT_FOUND"> Missing file. + filename="gio/gioenums.h" + line="1100">Missing file. glib:nick="file-exists" glib:name="G_DBUS_ERROR_FILE_EXISTS"> Existing file and the operation you're using does not silently overwrite. + filename="gio/gioenums.h" + line="1102">Existing file and the operation you're using does not silently overwrite. glib:nick="unknown-method" glib:name="G_DBUS_ERROR_UNKNOWN_METHOD"> Method name you invoked isn't known by the object you invoked it on. + filename="gio/gioenums.h" + line="1104">Method name you invoked isn't known by the object you invoked it on. glib:nick="timed-out" glib:name="G_DBUS_ERROR_TIMED_OUT"> Certain timeout errors, e.g. while starting a service. Warning: this is + filename="gio/gioenums.h" + line="1114">Certain timeout errors, e.g. while starting a service. Warning: this is confusingly-named given that %G_DBUS_ERROR_TIMEOUT also exists. We can't fix it for compatibility reasons so just be careful. @@ -19583,8 +19728,8 @@ can't fix it for compatibility reasons so just be careful. glib:nick="match-rule-not-found" glib:name="G_DBUS_ERROR_MATCH_RULE_NOT_FOUND"> Tried to remove or modify a match rule that didn't exist. + filename="gio/gioenums.h" + line="1118">Tried to remove or modify a match rule that didn't exist. glib:nick="match-rule-invalid" glib:name="G_DBUS_ERROR_MATCH_RULE_INVALID"> The match rule isn't syntactically valid. + filename="gio/gioenums.h" + line="1120">The match rule isn't syntactically valid. glib:nick="spawn-exec-failed" glib:name="G_DBUS_ERROR_SPAWN_EXEC_FAILED"> While starting a new process, the exec() call failed. + filename="gio/gioenums.h" + line="1122">While starting a new process, the exec() call failed. glib:nick="spawn-fork-failed" glib:name="G_DBUS_ERROR_SPAWN_FORK_FAILED"> While starting a new process, the fork() call failed. + filename="gio/gioenums.h" + line="1124">While starting a new process, the fork() call failed. glib:nick="spawn-child-exited" glib:name="G_DBUS_ERROR_SPAWN_CHILD_EXITED"> While starting a new process, the child exited with a status code. + filename="gio/gioenums.h" + line="1126">While starting a new process, the child exited with a status code. glib:nick="spawn-child-signaled" glib:name="G_DBUS_ERROR_SPAWN_CHILD_SIGNALED"> While starting a new process, the child exited on a signal. + filename="gio/gioenums.h" + line="1128">While starting a new process, the child exited on a signal. glib:nick="spawn-failed" glib:name="G_DBUS_ERROR_SPAWN_FAILED"> While starting a new process, something went wrong. + filename="gio/gioenums.h" + line="1130">While starting a new process, something went wrong. glib:nick="spawn-setup-failed" glib:name="G_DBUS_ERROR_SPAWN_SETUP_FAILED"> We failed to setup the environment correctly. + filename="gio/gioenums.h" + line="1132">We failed to setup the environment correctly. glib:nick="spawn-config-invalid" glib:name="G_DBUS_ERROR_SPAWN_CONFIG_INVALID"> We failed to setup the config parser correctly. + filename="gio/gioenums.h" + line="1134">We failed to setup the config parser correctly. glib:nick="spawn-service-invalid" glib:name="G_DBUS_ERROR_SPAWN_SERVICE_INVALID"> Bus name was not valid. + filename="gio/gioenums.h" + line="1136">Bus name was not valid. glib:nick="spawn-service-not-found" glib:name="G_DBUS_ERROR_SPAWN_SERVICE_NOT_FOUND"> Service file not found in system-services directory. + filename="gio/gioenums.h" + line="1138">Service file not found in system-services directory. glib:nick="spawn-permissions-invalid" glib:name="G_DBUS_ERROR_SPAWN_PERMISSIONS_INVALID"> Permissions are incorrect on the setuid helper. + filename="gio/gioenums.h" + line="1140">Permissions are incorrect on the setuid helper. glib:nick="spawn-file-invalid" glib:name="G_DBUS_ERROR_SPAWN_FILE_INVALID"> Service file invalid (Name, User or Exec missing). + filename="gio/gioenums.h" + line="1142">Service file invalid (Name, User or Exec missing). glib:nick="spawn-no-memory" glib:name="G_DBUS_ERROR_SPAWN_NO_MEMORY"> Tried to get a UNIX process ID and it wasn't available. + filename="gio/gioenums.h" + line="1144">Tried to get a UNIX process ID and it wasn't available. glib:nick="unix-process-id-unknown" glib:name="G_DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN"> Tried to get a UNIX process ID and it wasn't available. + filename="gio/gioenums.h" + line="1146">Tried to get a UNIX process ID and it wasn't available. glib:nick="invalid-signature" glib:name="G_DBUS_ERROR_INVALID_SIGNATURE"> A type signature is not valid. + filename="gio/gioenums.h" + line="1148">A type signature is not valid. glib:nick="invalid-file-content" glib:name="G_DBUS_ERROR_INVALID_FILE_CONTENT"> A file contains invalid syntax or is otherwise broken. + filename="gio/gioenums.h" + line="1150">A file contains invalid syntax or is otherwise broken. glib:nick="selinux-security-context-unknown" glib:name="G_DBUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN"> Asked for SELinux security context and it wasn't available. + filename="gio/gioenums.h" + line="1152">Asked for SELinux security context and it wasn't available. glib:nick="adt-audit-data-unknown" glib:name="G_DBUS_ERROR_ADT_AUDIT_DATA_UNKNOWN"> Asked for ADT audit data and it wasn't available. + filename="gio/gioenums.h" + line="1154">Asked for ADT audit data and it wasn't available. glib:nick="object-path-in-use" glib:name="G_DBUS_ERROR_OBJECT_PATH_IN_USE"> There's already an object with the requested object path. + filename="gio/gioenums.h" + line="1156">There's already an object with the requested object path. glib:nick="unknown-object" glib:name="G_DBUS_ERROR_UNKNOWN_OBJECT"> Object you invoked a method on isn't known. Since 2.42 + filename="gio/gioenums.h" + line="1106">Object you invoked a method on isn't known. Since 2.42 glib:nick="unknown-interface" glib:name="G_DBUS_ERROR_UNKNOWN_INTERFACE"> Interface you invoked a method on isn't known by the object. Since 2.42 + filename="gio/gioenums.h" + line="1108">Interface you invoked a method on isn't known by the object. Since 2.42 glib:nick="unknown-property" glib:name="G_DBUS_ERROR_UNKNOWN_PROPERTY"> Property you tried to access isn't known by the object. Since 2.42 + filename="gio/gioenums.h" + line="1110">Property you tried to access isn't known by the object. Since 2.42 glib:nick="property-read-only" glib:name="G_DBUS_ERROR_PROPERTY_READ_ONLY"> Property you tried to set is read-only. Since 2.42 + filename="gio/gioenums.h" + line="1112">Property you tried to set is read-only. Since 2.42 Creates a D-Bus error name to use for @error. If @error matches + filename="gio/gdbuserror.c" + line="723">Creates a D-Bus error name to use for @error. If @error matches a registered error (cf. g_dbus_error_register_error()), the corresponding D-Bus error name will be returned. @@ -19809,20 +19954,19 @@ on the wire back to a #GError using g_dbus_error_new_for_dbus_error(). This function is typically only used in object mappings to put a #GError on the wire. Regular applications should not use it. - + A D-Bus error name (never %NULL). + filename="gio/gdbuserror.c" + line="739">A D-Bus error name (never %NULL). Free with g_free(). A #GError. + filename="gio/gdbuserror.c" + line="725">A #GError. @@ -19831,27 +19975,26 @@ This function is typically only used in object mappings to put a c:identifier="g_dbus_error_get_remote_error" version="2.26"> Gets the D-Bus error name used for @error, if any. + filename="gio/gdbuserror.c" + line="430">Gets the D-Bus error name used for @error, if any. This function is guaranteed to return a D-Bus error name for all #GErrors returned from functions handling remote method calls (e.g. g_dbus_connection_call_finish()) unless g_dbus_error_strip_remote_error() has been used on @error. - + an allocated string or %NULL if the + filename="gio/gdbuserror.c" + line="441">an allocated string or %NULL if the D-Bus error name could not be found. Free with g_free(). a #GError + filename="gio/gdbuserror.c" + line="432">a #GError @@ -19860,23 +20003,22 @@ g_dbus_error_strip_remote_error() has been used on @error. c:identifier="g_dbus_error_is_remote_error" version="2.26"> Checks if @error represents an error received via D-Bus from a remote peer. If so, + filename="gio/gdbuserror.c" + line="410">Checks if @error represents an error received via D-Bus from a remote peer. If so, use g_dbus_error_get_remote_error() to get the name of the error. - + %TRUE if @error represents an error from a remote peer, + filename="gio/gdbuserror.c" + line="417">%TRUE if @error represents an error from a remote peer, %FALSE otherwise. A #GError. + filename="gio/gdbuserror.c" + line="412">A #GError. @@ -19885,8 +20027,8 @@ use g_dbus_error_get_remote_error() to get the name of the error. c:identifier="g_dbus_error_new_for_dbus_error" version="2.26"> Creates a #GError based on the contents of @dbus_error_name and + filename="gio/gdbuserror.c" + line="497">Creates a #GError based on the contents of @dbus_error_name and @dbus_error_message. Errors registered with g_dbus_error_register_error() will be looked @@ -19912,25 +20054,24 @@ returned #GError using the g_dbus_error_get_remote_error() function This function is typically only used in object mappings to prepare #GError instances for applications. Regular applications should not use it. - + An allocated #GError. Free with g_error_free(). + filename="gio/gdbuserror.c" + line="529">An allocated #GError. Free with g_error_free(). D-Bus error name. + filename="gio/gdbuserror.c" + line="499">D-Bus error name. D-Bus error message. + filename="gio/gdbuserror.c" + line="500">D-Bus error message. @@ -19944,38 +20085,37 @@ it. c:identifier="g_dbus_error_register_error" version="2.26"> Creates an association to map between @dbus_error_name and + filename="gio/gdbuserror.c" + line="271">Creates an association to map between @dbus_error_name and #GErrors specified by @error_domain and @error_code. This is typically done in the routine that returns the #GQuark for an error domain. - + %TRUE if the association was created, %FALSE if it already + filename="gio/gdbuserror.c" + line="283">%TRUE if the association was created, %FALSE if it already exists. A #GQuark for an error domain. + filename="gio/gdbuserror.c" + line="273">A #GQuark for an error domain. An error code. + filename="gio/gdbuserror.c" + line="274">An error code. A D-Bus error name. + filename="gio/gdbuserror.c" + line="275">A D-Bus error name. @@ -19984,33 +20124,32 @@ exists. c:identifier="g_dbus_error_register_error_domain" version="2.26"> Helper function for associating a #GError error domain with D-Bus error names. + filename="gio/gdbuserror.c" + line="97">Helper function for associating a #GError error domain with D-Bus error names. While @quark_volatile has a `volatile` qualifier, this is a historical artifact and the argument passed to it should not be `volatile`. - + The error domain name. + filename="gio/gdbuserror.c" + line="99">The error domain name. A pointer where to store the #GQuark. + filename="gio/gdbuserror.c" + line="100">A pointer where to store the #GQuark. A pointer to @num_entries #GDBusErrorEntry struct items. + filename="gio/gdbuserror.c" + line="101">A pointer to @num_entries #GDBusErrorEntry struct items. @@ -20019,8 +20158,8 @@ artifact and the argument passed to it should not be `volatile`. Number of items to register. + filename="gio/gdbuserror.c" + line="102">Number of items to register. @@ -20030,32 +20169,31 @@ artifact and the argument passed to it should not be `volatile`. version="2.26" introspectable="0"> Does nothing if @error is %NULL. Otherwise sets *@error to + filename="gio/gdbuserror.c" + line="592">Does nothing if @error is %NULL. Otherwise sets *@error to a new #GError created with g_dbus_error_new_for_dbus_error() with @dbus_error_message prepend with @format (unless %NULL). - + A pointer to a #GError or %NULL. + filename="gio/gdbuserror.c" + line="594">A pointer to a #GError or %NULL. D-Bus error name. + filename="gio/gdbuserror.c" + line="595">D-Bus error name. D-Bus error message. + filename="gio/gdbuserror.c" + line="596">D-Bus error message. nullable="1" allow-none="1"> printf()-style format to prepend to @dbus_error_message or %NULL. + filename="gio/gdbuserror.c" + line="597">printf()-style format to prepend to @dbus_error_message or %NULL. Arguments for @format. + filename="gio/gdbuserror.c" + line="598">Arguments for @format. @@ -20080,30 +20218,29 @@ with @dbus_error_message prepend with @format (unless %NULL). version="2.26" introspectable="0"> Like g_dbus_error_set_dbus_error() but intended for language bindings. - + filename="gio/gdbuserror.c" + line="637">Like g_dbus_error_set_dbus_error() but intended for language bindings. + A pointer to a #GError or %NULL. + filename="gio/gdbuserror.c" + line="639">A pointer to a #GError or %NULL. D-Bus error name. + filename="gio/gdbuserror.c" + line="640">D-Bus error name. D-Bus error message. + filename="gio/gdbuserror.c" + line="641">D-Bus error message. nullable="1" allow-none="1"> printf()-style format to prepend to @dbus_error_message or %NULL. + filename="gio/gdbuserror.c" + line="642">printf()-style format to prepend to @dbus_error_message or %NULL. Arguments for @format. + filename="gio/gdbuserror.c" + line="643">Arguments for @format. @@ -20127,26 +20264,25 @@ with @dbus_error_message prepend with @format (unless %NULL). c:identifier="g_dbus_error_strip_remote_error" version="2.26"> Looks for extra information in the error message used to recover + filename="gio/gdbuserror.c" + line="679">Looks for extra information in the error message used to recover the D-Bus error name and strips it if found. If stripped, the message field in @error will correspond exactly to what was received on the wire. This is typically used when presenting errors to the end user. - + %TRUE if information was stripped, %FALSE otherwise. + filename="gio/gdbuserror.c" + line="690">%TRUE if information was stripped, %FALSE otherwise. A #GError. + filename="gio/gdbuserror.c" + line="681">A #GError. @@ -20155,33 +20291,32 @@ This is typically used when presenting errors to the end user. c:identifier="g_dbus_error_unregister_error" version="2.26"> Destroys an association previously set up with g_dbus_error_register_error(). - + filename="gio/gdbuserror.c" + line="337">Destroys an association previously set up with g_dbus_error_register_error(). + %TRUE if the association was destroyed, %FALSE if it wasn't found. + filename="gio/gdbuserror.c" + line="345">%TRUE if the association was destroyed, %FALSE if it wasn't found. A #GQuark for an error domain. + filename="gio/gdbuserror.c" + line="339">A #GQuark for an error domain. An error code. + filename="gio/gdbuserror.c" + line="340">An error code. A D-Bus error name. + filename="gio/gdbuserror.c" + line="341">A D-Bus error name. @@ -20189,19 +20324,18 @@ This is typically used when presenting errors to the end user. Struct used in g_dbus_error_register_error_domain(). - + An error code. The D-Bus error name to associate with @error_code. @@ -20214,52 +20348,51 @@ This is typically used when presenting errors to the end user. glib:get-type="g_dbus_interface_get_type" glib:type-struct="DBusInterfaceIface"> The #GDBusInterface type is the base type for D-Bus interfaces both -on the service side (see #GDBusInterfaceSkeleton) and client side -(see #GDBusProxy). - + filename="gio/gdbusinterface.c" + line="30">Base type for D-Bus interfaces. + +The `GDBusInterface` type is the base type for D-Bus interfaces both +on the service side (see [class@Gio.DBusInterfaceSkeleton]) and client side +(see [class@Gio.DBusProxy]). + Gets the #GDBusObject that @interface_ belongs to, if any. - + filename="gio/gdbusinterface.c" + line="92">Gets the #GDBusObject that @interface_ belongs to, if any. + A #GDBusObject or %NULL. The returned + filename="gio/gdbusinterface.c" + line="98">A #GDBusObject or %NULL. The returned reference should be freed with g_object_unref(). An exported D-Bus interface. + filename="gio/gdbusinterface.c" + line="94">An exported D-Bus interface. Gets D-Bus introspection information for the D-Bus interface + filename="gio/gdbusinterface.c" + line="52">Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. - + A #GDBusInterfaceInfo. Do not free. + filename="gio/gdbusinterface.c" + line="59">A #GDBusInterfaceInfo. Do not free. An exported D-Bus interface. + filename="gio/gdbusinterface.c" + line="54">An exported D-Bus interface. @@ -20269,46 +20402,44 @@ implemented by @interface_. version="2.30" introspectable="0"> Gets the #GDBusObject that @interface_ belongs to, if any. + filename="gio/gdbusinterface.c" + line="70">Gets the #GDBusObject that @interface_ belongs to, if any. It is not safe to use the returned object if @interface_ or the returned object is being used from other threads. See g_dbus_interface_dup_object() for a thread-safe alternative. - + A #GDBusObject or %NULL. The returned + filename="gio/gdbusinterface.c" + line="80">A #GDBusObject or %NULL. The returned reference belongs to @interface_ and should not be freed. An exported D-Bus interface + filename="gio/gdbusinterface.c" + line="72">An exported D-Bus interface Sets the #GDBusObject for @interface_ to @object. + filename="gio/gdbusinterface.c" + line="123">Sets the #GDBusObject for @interface_ to @object. Note that @interface_ will hold a weak reference to @object. - + An exported D-Bus interface. + filename="gio/gdbusinterface.c" + line="125">An exported D-Bus interface. nullable="1" allow-none="1"> A #GDBusObject or %NULL. + filename="gio/gdbusinterface.c" + line="126">A #GDBusObject or %NULL. @@ -20327,22 +20458,21 @@ Note that @interface_ will hold a weak reference to @object. shadows="get_object" version="2.32"> Gets the #GDBusObject that @interface_ belongs to, if any. - + filename="gio/gdbusinterface.c" + line="92">Gets the #GDBusObject that @interface_ belongs to, if any. + A #GDBusObject or %NULL. The returned + filename="gio/gdbusinterface.c" + line="98">A #GDBusObject or %NULL. The returned reference should be freed with g_object_unref(). An exported D-Bus interface. + filename="gio/gdbusinterface.c" + line="94">An exported D-Bus interface. @@ -20351,22 +20481,21 @@ reference should be freed with g_object_unref(). c:identifier="g_dbus_interface_get_info" version="2.30"> Gets D-Bus introspection information for the D-Bus interface + filename="gio/gdbusinterface.c" + line="52">Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. - + A #GDBusInterfaceInfo. Do not free. + filename="gio/gdbusinterface.c" + line="59">A #GDBusInterfaceInfo. Do not free. An exported D-Bus interface. + filename="gio/gdbusinterface.c" + line="54">An exported D-Bus interface. @@ -20377,26 +20506,25 @@ implemented by @interface_. version="2.30" introspectable="0"> Gets the #GDBusObject that @interface_ belongs to, if any. + filename="gio/gdbusinterface.c" + line="70">Gets the #GDBusObject that @interface_ belongs to, if any. It is not safe to use the returned object if @interface_ or the returned object is being used from other threads. See g_dbus_interface_dup_object() for a thread-safe alternative. - + A #GDBusObject or %NULL. The returned + filename="gio/gdbusinterface.c" + line="80">A #GDBusObject or %NULL. The returned reference belongs to @interface_ and should not be freed. An exported D-Bus interface + filename="gio/gdbusinterface.c" + line="72">An exported D-Bus interface @@ -20405,20 +20533,19 @@ g_dbus_interface_dup_object() for a thread-safe alternative. c:identifier="g_dbus_interface_set_object" version="2.30"> Sets the #GDBusObject for @interface_ to @object. + filename="gio/gdbusinterface.c" + line="123">Sets the #GDBusObject for @interface_ to @object. Note that @interface_ will hold a weak reference to @object. - + An exported D-Bus interface. + filename="gio/gdbusinterface.c" + line="125">An exported D-Bus interface. nullable="1" allow-none="1"> A #GDBusObject or %NULL. + filename="gio/gdbusinterface.c" + line="126">A #GDBusObject or %NULL. @@ -20437,13 +20564,12 @@ Note that @interface_ will hold a weak reference to @object. c:type="GDBusInterfaceGetPropertyFunc" version="2.26"> The type of the @get_property function in #GDBusInterfaceVTable. - + A #GVariant with the value for @property_name or %NULL if @error is set. If the returned #GVariant is floating, it is consumed - otherwise its reference count is decreased by one. @@ -20452,37 +20578,37 @@ Note that @interface_ will hold a weak reference to @object. A #GDBusConnection. The unique bus name of the remote caller. The object path that the method was invoked on. The D-Bus interface name for the property. The name of the property to get the value of. Return location for error. @@ -20492,7 +20618,7 @@ Note that @interface_ will hold a weak reference to @object. allow-none="1" closure="6"> The @user_data #gpointer passed to g_dbus_connection_register_object(). @@ -20503,69 +20629,74 @@ Note that @interface_ will hold a weak reference to @object. glib:is-gtype-struct-for="DBusInterface" version="2.30"> Base type for D-Bus interfaces. - + filename="gio/gdbusinterface.h" + line="37">Base type for D-Bus interfaces. + The parent interface. + filename="gio/gdbusinterface.h" + line="39">The parent interface. + Returns a #GDBusInterfaceInfo. See g_dbus_interface_get_info(). - + A #GDBusInterfaceInfo. Do not free. + filename="gio/gdbusinterface.c" + line="59">A #GDBusInterfaceInfo. Do not free. An exported D-Bus interface. + filename="gio/gdbusinterface.c" + line="54">An exported D-Bus interface. + Gets the enclosing #GDBusObject. See g_dbus_interface_get_object(). - + A #GDBusObject or %NULL. The returned + filename="gio/gdbusinterface.c" + line="80">A #GDBusObject or %NULL. The returned reference belongs to @interface_ and should not be freed. An exported D-Bus interface + filename="gio/gdbusinterface.c" + line="72">An exported D-Bus interface + Sets the enclosing #GDBusObject. See g_dbus_interface_set_object(). - + An exported D-Bus interface. + filename="gio/gdbusinterface.c" + line="125">An exported D-Bus interface. nullable="1" allow-none="1"> A #GDBusObject or %NULL. + filename="gio/gdbusinterface.c" + line="126">A #GDBusObject or %NULL. + Gets a reference to the enclosing #GDBusObject. See g_dbus_interface_dup_object(). Added in 2.32. - + A #GDBusObject or %NULL. The returned + filename="gio/gdbusinterface.c" + line="98">A #GDBusObject or %NULL. The returned reference should be freed with g_object_unref(). An exported D-Bus interface. + filename="gio/gdbusinterface.c" + line="94">An exported D-Bus interface. @@ -20609,25 +20742,24 @@ reference should be freed with g_object_unref(). glib:get-type="g_dbus_interface_info_get_type" c:symbol-prefix="dbus_interface_info"> Information about a D-Bus interface. - + The reference count or -1 if statically allocated. The name of the D-Bus interface, e.g. "org.freedesktop.DBus.Properties". A pointer to a %NULL-terminated array of pointers to #GDBusMethodInfo structures or %NULL if there are no methods. @@ -20635,7 +20767,7 @@ reference should be freed with g_object_unref(). A pointer to a %NULL-terminated array of pointers to #GDBusSignalInfo structures or %NULL if there are no signals. @@ -20643,7 +20775,7 @@ reference should be freed with g_object_unref(). A pointer to a %NULL-terminated array of pointers to #GDBusPropertyInfo structures or %NULL if there are no properties. @@ -20651,7 +20783,7 @@ reference should be freed with g_object_unref(). A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. @@ -20661,8 +20793,8 @@ reference should be freed with g_object_unref(). c:identifier="g_dbus_interface_info_cache_build" version="2.30"> Builds a lookup-cache to speed up + filename="gio/gdbusintrospection.c" + line="2058">Builds a lookup-cache to speed up g_dbus_interface_info_lookup_method(), g_dbus_interface_info_lookup_signal() and g_dbus_interface_info_lookup_property(). @@ -20672,16 +20804,15 @@ used and its use count is increased. Note that @info cannot be modified until g_dbus_interface_info_cache_release() is called. - + A #GDBusInterfaceInfo. + filename="gio/gdbusintrospection.c" + line="2060">A #GDBusInterfaceInfo. @@ -20690,20 +20821,19 @@ g_dbus_interface_info_cache_release() is called. c:identifier="g_dbus_interface_info_cache_release" version="2.30"> Decrements the usage count for the cache for @info built by + filename="gio/gdbusintrospection.c" + line="2106">Decrements the usage count for the cache for @info built by g_dbus_interface_info_cache_build() (if any) and frees the resources used by the cache if the usage count drops to zero. - + A GDBusInterfaceInfo + filename="gio/gdbusintrospection.c" + line="2108">A GDBusInterfaceInfo @@ -20712,35 +20842,34 @@ resources used by the cache if the usage count drops to zero. c:identifier="g_dbus_interface_info_generate_xml" version="2.26"> Appends an XML representation of @info (and its children) to @string_builder. + filename="gio/gdbusintrospection.c" + line="763">Appends an XML representation of @info (and its children) to @string_builder. This function is typically used for generating introspection XML documents at run-time for handling the `org.freedesktop.DBus.Introspectable.Introspect` method. - + A #GDBusNodeInfo + filename="gio/gdbusintrospection.c" + line="765">A #GDBusNodeInfo Indentation level. + filename="gio/gdbusintrospection.c" + line="766">Indentation level. A #GString to to append XML data to. + filename="gio/gdbusintrospection.c" + line="767">A #GString to to append XML data to. @@ -20749,30 +20878,29 @@ method. c:identifier="g_dbus_interface_info_lookup_method" version="2.26"> Looks up information about a method. + filename="gio/gdbusintrospection.c" + line="1896">Looks up information about a method. The cost of this function is O(n) in number of methods unless g_dbus_interface_info_cache_build() has been used on @info. - + A #GDBusMethodInfo or %NULL if not found. Do not free, it is owned by @info. + filename="gio/gdbusintrospection.c" + line="1906">A #GDBusMethodInfo or %NULL if not found. Do not free, it is owned by @info. A #GDBusInterfaceInfo. + filename="gio/gdbusintrospection.c" + line="1898">A #GDBusInterfaceInfo. A D-Bus method name (typically in CamelCase) + filename="gio/gdbusintrospection.c" + line="1899">A D-Bus method name (typically in CamelCase) @@ -20781,30 +20909,29 @@ g_dbus_interface_info_cache_build() has been used on @info. c:identifier="g_dbus_interface_info_lookup_property" version="2.26"> Looks up information about a property. + filename="gio/gdbusintrospection.c" + line="2004">Looks up information about a property. The cost of this function is O(n) in number of properties unless g_dbus_interface_info_cache_build() has been used on @info. - + A #GDBusPropertyInfo or %NULL if not found. Do not free, it is owned by @info. + filename="gio/gdbusintrospection.c" + line="2014">A #GDBusPropertyInfo or %NULL if not found. Do not free, it is owned by @info. A #GDBusInterfaceInfo. + filename="gio/gdbusintrospection.c" + line="2006">A #GDBusInterfaceInfo. A D-Bus property name (typically in CamelCase). + filename="gio/gdbusintrospection.c" + line="2007">A D-Bus property name (typically in CamelCase). @@ -20813,30 +20940,29 @@ g_dbus_interface_info_cache_build() has been used on @info. c:identifier="g_dbus_interface_info_lookup_signal" version="2.26"> Looks up information about a signal. + filename="gio/gdbusintrospection.c" + line="1950">Looks up information about a signal. The cost of this function is O(n) in number of signals unless g_dbus_interface_info_cache_build() has been used on @info. - + A #GDBusSignalInfo or %NULL if not found. Do not free, it is owned by @info. + filename="gio/gdbusintrospection.c" + line="1960">A #GDBusSignalInfo or %NULL if not found. Do not free, it is owned by @info. A #GDBusInterfaceInfo. + filename="gio/gdbusintrospection.c" + line="1952">A #GDBusInterfaceInfo. A D-Bus signal name (typically in CamelCase) + filename="gio/gdbusintrospection.c" + line="1953">A D-Bus signal name (typically in CamelCase) @@ -20845,22 +20971,21 @@ g_dbus_interface_info_cache_build() has been used on @info. c:identifier="g_dbus_interface_info_ref" version="2.26"> If @info is statically allocated does nothing. Otherwise increases + filename="gio/gdbusintrospection.c" + line="102">If @info is statically allocated does nothing. Otherwise increases the reference count. - + The same @info. + filename="gio/gdbusintrospection.c" + line="109">The same @info. A #GDBusInterfaceInfo + filename="gio/gdbusintrospection.c" + line="104">A #GDBusInterfaceInfo @@ -20869,20 +20994,19 @@ the reference count. c:identifier="g_dbus_interface_info_unref" version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + filename="gio/gdbusintrospection.c" + line="357">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. - + A #GDBusInterfaceInfo. + filename="gio/gdbusintrospection.c" + line="359">A #GDBusInterfaceInfo. @@ -20892,53 +21016,52 @@ the memory used is freed. c:type="GDBusInterfaceMethodCallFunc" version="2.26"> The type of the @method_call function in #GDBusInterfaceVTable. - + A #GDBusConnection. The unique bus name of the remote caller. The object path that the method was invoked on. The D-Bus interface name the method was invoked on. The name of the method that was invoked. A #GVariant tuple with parameters. A #GDBusMethodInvocation object that must be used to return a value or error. @@ -20948,7 +21071,7 @@ the memory used is freed. allow-none="1" closure="7"> The @user_data #gpointer passed to g_dbus_connection_register_object(). @@ -20958,56 +21081,55 @@ the memory used is freed. c:type="GDBusInterfaceSetPropertyFunc" version="2.26"> The type of the @set_property function in #GDBusInterfaceVTable. - + %TRUE if the property was set to @value, %FALSE if @error is set. A #GDBusConnection. The unique bus name of the remote caller. The object path that the method was invoked on. The D-Bus interface name for the property. The name of the property to get the value of. The value to set the property to. Return location for error. @@ -21017,7 +21139,7 @@ the memory used is freed. allow-none="1" closure="7"> The @user_data #gpointer passed to g_dbus_connection_register_object(). @@ -21033,15 +21155,14 @@ the memory used is freed. glib:get-type="g_dbus_interface_skeleton_get_type" glib:type-struct="DBusInterfaceSkeletonClass"> Abstract base class for D-Bus interfaces on the service side. - + filename="gio/gdbusinterfaceskeleton.c" + line="38">Abstract base class for D-Bus interfaces on the service side. + If @interface_ has outstanding changes, request for these changes to be + filename="gio/gdbusinterfaceskeleton.c" + line="379">If @interface_ has outstanding changes, request for these changes to be emitted immediately. For example, an exported D-Bus interface may queue up property @@ -21049,24 +21170,25 @@ changes and emit the `org.freedesktop.DBus.Properties.PropertiesChanged` signal later (e.g. in an idle handler). This technique is useful for collapsing multiple property changes into one. - + A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="381">A #GDBusInterfaceSkeleton. - + Signal class handler for the #GDBusInterfaceSkeleton::g-authorize-method signal. + @@ -21082,22 +21204,21 @@ for collapsing multiple property changes into one. Gets D-Bus introspection information for the D-Bus interface + filename="gio/gdbusinterfaceskeleton.c" + line="315">Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. - + A #GDBusInterfaceInfo (never %NULL). Do not free. + filename="gio/gdbusinterfaceskeleton.c" + line="322">A #GDBusInterfaceInfo (never %NULL). Do not free. A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="317">A #GDBusInterfaceSkeleton. @@ -21107,14 +21228,13 @@ implemented by @interface_. invoker="get_properties" version="2.30"> Gets all D-Bus properties for @interface_. - + filename="gio/gdbusinterfaceskeleton.c" + line="358">Gets all D-Bus properties for @interface_. + A #GVariant of type + filename="gio/gdbusinterfaceskeleton.c" + line="364">A #GVariant of type ['a{sv}'][G-VARIANT-TYPE-VARDICT:CAPS]. Free with g_variant_unref(). @@ -21122,35 +21242,31 @@ Free with g_variant_unref(). A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="360">A #GDBusInterfaceSkeleton. - + Gets the interface vtable for the D-Bus interface implemented by + filename="gio/gdbusinterfaceskeleton.c" + line="336">Gets the interface vtable for the D-Bus interface implemented by @interface_. The returned function pointers should expect @interface_ itself to be passed as @user_data. - - + + A #GDBusInterfaceVTable (never %NULL). + filename="gio/gdbusinterfaceskeleton.c" + line="344">the vtable of the D-Bus interface implemented by the skeleton A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="338">A #GDBusInterfaceSkeleton. @@ -21161,41 +21277,40 @@ itself to be passed as @user_data. version="2.30" throws="1"> Exports @interface_ at @object_path on @connection. + filename="gio/gdbusinterfaceskeleton.c" + line="899">Exports @interface_ at @object_path on @connection. This can be called multiple times to export the same @interface_ onto multiple connections however the @object_path provided must be the same for all connections. Use g_dbus_interface_skeleton_unexport() to unexport the object. - + %TRUE if the interface was exported on @connection, otherwise %FALSE with + filename="gio/gdbusinterfaceskeleton.c" + line="914">%TRUE if the interface was exported on @connection, otherwise %FALSE with @error set. The D-Bus interface to export. + filename="gio/gdbusinterfaceskeleton.c" + line="901">The D-Bus interface to export. A #GDBusConnection to export @interface_ on. + filename="gio/gdbusinterfaceskeleton.c" + line="902">A #GDBusConnection to export @interface_ on. The path to export the interface at. + filename="gio/gdbusinterfaceskeleton.c" + line="903">The path to export the interface at. @@ -21204,8 +21319,8 @@ Use g_dbus_interface_skeleton_unexport() to unexport the object. c:identifier="g_dbus_interface_skeleton_flush" version="2.30"> If @interface_ has outstanding changes, request for these changes to be + filename="gio/gdbusinterfaceskeleton.c" + line="379">If @interface_ has outstanding changes, request for these changes to be emitted immediately. For example, an exported D-Bus interface may queue up property @@ -21213,16 +21328,15 @@ changes and emit the `org.freedesktop.DBus.Properties.PropertiesChanged` signal later (e.g. in an idle handler). This technique is useful for collapsing multiple property changes into one. - + A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="381">A #GDBusInterfaceSkeleton. @@ -21232,22 +21346,21 @@ for collapsing multiple property changes into one. c:identifier="g_dbus_interface_skeleton_get_connection" version="2.30"> Gets the first connection that @interface_ is exported on, if any. - + filename="gio/gdbusinterfaceskeleton.c" + line="768">Gets the first connection that @interface_ is exported on, if any. + A #GDBusConnection or %NULL if @interface_ is + filename="gio/gdbusinterfaceskeleton.c" + line="774">A #GDBusConnection or %NULL if @interface_ is not exported anywhere. Do not free, the object belongs to @interface_. A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="770">A #GDBusInterfaceSkeleton. @@ -21257,14 +21370,13 @@ not exported anywhere. Do not free, the object belongs to @interface_. c:identifier="g_dbus_interface_skeleton_get_connections" version="2.32"> Gets a list of the connections that @interface_ is exported on. - + filename="gio/gdbusinterfaceskeleton.c" + line="801">Gets a list of the connections that @interface_ is exported on. + A list of + filename="gio/gdbusinterfaceskeleton.c" + line="807">A list of all the connections that @interface_ is exported on. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -21275,8 +21387,8 @@ not exported anywhere. Do not free, the object belongs to @interface_. A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="803">A #GDBusInterfaceSkeleton. @@ -21286,23 +21398,22 @@ not exported anywhere. Do not free, the object belongs to @interface_. c:identifier="g_dbus_interface_skeleton_get_flags" version="2.30"> Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior + filename="gio/gdbusinterfaceskeleton.c" + line="270">Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior of @interface_ - + One or more flags from the #GDBusInterfaceSkeletonFlags enumeration. + filename="gio/gdbusinterfaceskeleton.c" + line="277">One or more flags from the #GDBusInterfaceSkeletonFlags enumeration. A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="272">A #GDBusInterfaceSkeleton. @@ -21312,22 +21423,21 @@ of @interface_ c:identifier="g_dbus_interface_skeleton_get_info" version="2.30"> Gets D-Bus introspection information for the D-Bus interface + filename="gio/gdbusinterfaceskeleton.c" + line="315">Gets D-Bus introspection information for the D-Bus interface implemented by @interface_. - + A #GDBusInterfaceInfo (never %NULL). Do not free. + filename="gio/gdbusinterfaceskeleton.c" + line="322">A #GDBusInterfaceInfo (never %NULL). Do not free. A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="317">A #GDBusInterfaceSkeleton. @@ -21337,22 +21447,21 @@ implemented by @interface_. c:identifier="g_dbus_interface_skeleton_get_object_path" version="2.30"> Gets the object path that @interface_ is exported on, if any. - + filename="gio/gdbusinterfaceskeleton.c" + line="877">Gets the object path that @interface_ is exported on, if any. + A string owned by @interface_ or %NULL if @interface_ is not exported + filename="gio/gdbusinterfaceskeleton.c" + line="883">A string owned by @interface_ or %NULL if @interface_ is not exported anywhere. Do not free, the string belongs to @interface_. A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="879">A #GDBusInterfaceSkeleton. @@ -21362,14 +21471,13 @@ anywhere. Do not free, the string belongs to @interface_. c:identifier="g_dbus_interface_skeleton_get_properties" version="2.30"> Gets all D-Bus properties for @interface_. - + filename="gio/gdbusinterfaceskeleton.c" + line="358">Gets all D-Bus properties for @interface_. + A #GVariant of type + filename="gio/gdbusinterfaceskeleton.c" + line="364">A #GVariant of type ['a{sv}'][G-VARIANT-TYPE-VARDICT:CAPS]. Free with g_variant_unref(). @@ -21377,8 +21485,8 @@ Free with g_variant_unref(). A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="360">A #GDBusInterfaceSkeleton. @@ -21386,26 +21494,24 @@ Free with g_variant_unref(). + version="2.30"> Gets the interface vtable for the D-Bus interface implemented by + filename="gio/gdbusinterfaceskeleton.c" + line="336">Gets the interface vtable for the D-Bus interface implemented by @interface_. The returned function pointers should expect @interface_ itself to be passed as @user_data. - - + + A #GDBusInterfaceVTable (never %NULL). + filename="gio/gdbusinterfaceskeleton.c" + line="344">the vtable of the D-Bus interface implemented by the skeleton A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="338">A #GDBusInterfaceSkeleton. @@ -21415,28 +21521,27 @@ itself to be passed as @user_data. c:identifier="g_dbus_interface_skeleton_has_connection" version="2.32"> Checks if @interface_ is exported on @connection. - + filename="gio/gdbusinterfaceskeleton.c" + line="839">Checks if @interface_ is exported on @connection. + %TRUE if @interface_ is exported on @connection, %FALSE otherwise. + filename="gio/gdbusinterfaceskeleton.c" + line="846">%TRUE if @interface_ is exported on @connection, %FALSE otherwise. A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="841">A #GDBusInterfaceSkeleton. A #GDBusConnection. + filename="gio/gdbusinterfaceskeleton.c" + line="842">A #GDBusConnection. @@ -21445,25 +21550,24 @@ itself to be passed as @user_data. c:identifier="g_dbus_interface_skeleton_set_flags" version="2.30"> Sets flags describing what the behavior of @skeleton should be. - + filename="gio/gdbusinterfaceskeleton.c" + line="288">Sets flags describing what the behavior of @skeleton should be. + A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="290">A #GDBusInterfaceSkeleton. Flags from the #GDBusInterfaceSkeletonFlags enumeration. + filename="gio/gdbusinterfaceskeleton.c" + line="291">Flags from the #GDBusInterfaceSkeletonFlags enumeration. @@ -21473,21 +21577,20 @@ itself to be passed as @user_data. c:identifier="g_dbus_interface_skeleton_unexport" version="2.30"> Stops exporting @interface_ on all connections it is exported on. + filename="gio/gdbusinterfaceskeleton.c" + line="948">Stops exporting @interface_ on all connections it is exported on. To unexport @interface_ from only a single connection, use g_dbus_interface_skeleton_unexport_from_connection() - + A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="950">A #GDBusInterfaceSkeleton. @@ -21497,28 +21600,27 @@ g_dbus_interface_skeleton_unexport_from_connection() c:identifier="g_dbus_interface_skeleton_unexport_from_connection" version="2.32"> Stops exporting @interface_ on @connection. + filename="gio/gdbusinterfaceskeleton.c" + line="984">Stops exporting @interface_ on @connection. To stop exporting on all connections the interface is exported on, use g_dbus_interface_skeleton_unexport(). - + A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="986">A #GDBusInterfaceSkeleton. A #GDBusConnection. + filename="gio/gdbusinterfaceskeleton.c" + line="987">A #GDBusConnection. @@ -21529,8 +21631,8 @@ use g_dbus_interface_skeleton_unexport(). transfer-ownership="none" default-value="G_DBUS_INTERFACE_SKELETON_FLAGS_NONE"> Flags from the #GDBusInterfaceSkeletonFlags enumeration. + filename="gio/gdbusinterfaceskeleton.c" + line="186">Flags from the #GDBusInterfaceSkeletonFlags enumeration. @@ -21542,8 +21644,8 @@ use g_dbus_interface_skeleton_unexport(). Emitted when a method is invoked by a remote caller and used to + filename="gio/gdbusinterfaceskeleton.c" + line="202">Emitted when a method is invoked by a remote caller and used to determine if the method call is authorized. Note that this signal is emitted in a thread dedicated to @@ -21578,15 +21680,15 @@ handled in the same thread as the object that @interface belongs to was exported in. %TRUE if the call is authorized, %FALSE otherwise. + filename="gio/gdbusinterfaceskeleton.c" + line="241">%TRUE if the call is authorized, %FALSE otherwise. A #GDBusMethodInvocation. + filename="gio/gdbusinterfaceskeleton.c" + line="205">A #GDBusMethodInvocation. @@ -21597,52 +21699,55 @@ to was exported in. glib:is-gtype-struct-for="DBusInterfaceSkeleton" version="2.30"> Class structure for #GDBusInterfaceSkeleton. - + filename="gio/gdbusinterfaceskeleton.h" + line="47">Class structure for #GDBusInterfaceSkeleton. + The parent class. + filename="gio/gdbusinterfaceskeleton.h" + line="49">The parent class. + Returns a #GDBusInterfaceInfo. See g_dbus_interface_skeleton_get_info() for details. - + A #GDBusInterfaceInfo (never %NULL). Do not free. + filename="gio/gdbusinterfaceskeleton.c" + line="322">A #GDBusInterfaceInfo (never %NULL). Do not free. A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="317">A #GDBusInterfaceSkeleton. - - - - + + Returns a #GDBusInterfaceVTable. See g_dbus_interface_skeleton_get_vtable() for details. + + + A #GDBusInterfaceVTable (never %NULL). + filename="gio/gdbusinterfaceskeleton.c" + line="344">the vtable of the D-Bus interface implemented by the skeleton A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="338">A #GDBusInterfaceSkeleton. @@ -21650,13 +21755,15 @@ to was exported in. + Returns a #GVariant with all properties. See g_dbus_interface_skeleton_get_properties(). - + A #GVariant of type + filename="gio/gdbusinterfaceskeleton.c" + line="364">A #GVariant of type ['a{sv}'][G-VARIANT-TYPE-VARDICT:CAPS]. Free with g_variant_unref(). @@ -21664,8 +21771,8 @@ Free with g_variant_unref(). A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="360">A #GDBusInterfaceSkeleton. @@ -21673,17 +21780,19 @@ Free with g_variant_unref(). + Emits outstanding changes, if any. See g_dbus_interface_skeleton_flush(). - + A #GDBusInterfaceSkeleton. + filename="gio/gdbusinterfaceskeleton.c" + line="381">A #GDBusInterfaceSkeleton. @@ -21696,9 +21805,11 @@ Free with g_variant_unref(). + Signal class handler for the #GDBusInterfaceSkeleton::g-authorize-method signal. - + @@ -21726,16 +21837,16 @@ Free with g_variant_unref(). glib:get-type="g_dbus_interface_skeleton_flags_get_type" c:type="GDBusInterfaceSkeletonFlags"> Flags describing the behavior of a #GDBusInterfaceSkeleton instance. + filename="gio/gioenums.h" + line="1793">Flags describing the behavior of a #GDBusInterfaceSkeleton instance. No flags set. + filename="gio/gioenums.h" + line="1795">No flags set. glib:nick="handle-method-invocations-in-thread" glib:name="G_DBUS_INTERFACE_SKELETON_FLAGS_HANDLE_METHOD_INVOCATIONS_IN_THREAD"> Each method invocation is handled in + filename="gio/gioenums.h" + line="1796">Each method invocation is handled in a thread dedicated to the invocation. This means that the method implementation can use blocking IO without blocking any other part of the process. It also means that the method implementation must use locking to access data structures used by other threads. @@ -21754,14 +21865,13 @@ Free with g_variant_unref(). c:type="GDBusInterfaceSkeletonPrivate" disguised="1" opaque="1"> - + Virtual table for handling properties and method calls for a D-Bus interface. @@ -21803,25 +21913,24 @@ If you have writable properties specified in your interface info, you must ensure that you either provide a non-%NULL @set_property() function or provide an implementation of the `Set` call. If implementing the call, you must return the value of type %G_VARIANT_TYPE_UNIT. - + Function for handling incoming method calls. Function for getting a property. Function for setting a property. @@ -21839,14 +21948,14 @@ the call, you must return the value of type %G_VARIANT_TYPE_UNIT. glib:type-name="GDBusMenuModel" glib:get-type="g_dbus_menu_model_get_type"> #GDBusMenuModel is an implementation of #GMenuModel that can be used -as a proxy for a menu model that is exported over D-Bus with -g_dbus_connection_export_menu_model(). + filename="gio/gdbusmenumodel.c" + line="31">`GDBusMenuModel` is an implementation of [class@Gio.MenuModel] that can be +used as a proxy for a menu model that is exported over D-Bus with +[method@Gio.DBusConnection.export_menu_model]. Obtains a #GDBusMenuModel for the menu model which is exported + filename="gio/gdbusmenumodel.c" + line="873">Obtains a #GDBusMenuModel for the menu model which is exported at the given @bus_name and @object_path. The thread default main context is taken at the time of this call. @@ -21854,20 +21963,19 @@ All signals on the menu model (and any linked models) are reported with respect to this context. All calls on the returned menu model (and linked models) must also originate from this same context, with the thread default main context unchanged. - + a #GDBusMenuModel object. Free with + filename="gio/gdbusmenumodel.c" + line="889">a #GDBusMenuModel object. Free with g_object_unref(). a #GDBusConnection + filename="gio/gdbusmenumodel.c" + line="875">a #GDBusConnection nullable="1" allow-none="1"> the bus name which exports the menu model + filename="gio/gdbusmenumodel.c" + line="876">the bus name which exports the menu model or %NULL if @connection is not a message bus connection the object path at which the menu model is exported + filename="gio/gdbusmenumodel.c" + line="878">the object path at which the menu model is exported @@ -21897,19 +22005,18 @@ the thread default main context unchanged. glib:type-name="GDBusMessage" glib:get-type="g_dbus_message_get_type"> A type for representing D-Bus messages that can be sent or received -on a #GDBusConnection. + filename="gio/gdbusmessage.c" + line="480">A type for representing D-Bus messages that can be sent or received +on a [class@Gio.DBusConnection]. Creates a new empty #GDBusMessage. - + filename="gio/gdbusmessage.c" + line="601">Creates a new empty #GDBusMessage. + A #GDBusMessage. Free with g_object_unref(). + filename="gio/gdbusmessage.c" + line="606">A #GDBusMessage. Free with g_object_unref(). @@ -21918,41 +22025,40 @@ on a #GDBusConnection. version="2.26" throws="1"> Creates a new #GDBusMessage from the data stored at @blob. The byte + filename="gio/gdbusmessage.c" + line="2310">Creates a new #GDBusMessage from the data stored at @blob. The byte order that the message was in can be retrieved using g_dbus_message_get_byte_order(). If the @blob cannot be parsed, contains invalid fields, or contains invalid headers, %G_IO_ERROR_INVALID_ARGUMENT will be returned. - + A new #GDBusMessage or %NULL if @error is set. Free with + filename="gio/gdbusmessage.c" + line="2324">A new #GDBusMessage or %NULL if @error is set. Free with g_object_unref(). A blob representing a binary D-Bus message. + filename="gio/gdbusmessage.c" + line="2312">A blob representing a binary D-Bus message. The length of @blob. + filename="gio/gdbusmessage.c" + line="2313">The length of @blob. A #GDBusCapabilityFlags describing what protocol features are supported. + filename="gio/gdbusmessage.c" + line="2314">A #GDBusCapabilityFlags describing what protocol features are supported. @@ -21961,14 +22067,13 @@ g_object_unref(). c:identifier="g_dbus_message_new_method_call" version="2.26"> Creates a new #GDBusMessage for a method call. - + filename="gio/gdbusmessage.c" + line="616">Creates a new #GDBusMessage for a method call. + A #GDBusMessage. Free with g_object_unref(). + filename="gio/gdbusmessage.c" + line="625">A #GDBusMessage. Free with g_object_unref(). @@ -21977,14 +22082,14 @@ g_object_unref(). nullable="1" allow-none="1"> A valid D-Bus name or %NULL. + filename="gio/gdbusmessage.c" + line="618">A valid D-Bus name or %NULL. A valid object path. + filename="gio/gdbusmessage.c" + line="619">A valid object path. nullable="1" allow-none="1"> A valid D-Bus interface name or %NULL. + filename="gio/gdbusmessage.c" + line="620">A valid D-Bus interface name or %NULL. A valid method name. + filename="gio/gdbusmessage.c" + line="621">A valid method name. @@ -22008,33 +22113,32 @@ g_object_unref(). c:identifier="g_dbus_message_new_signal" version="2.26"> Creates a new #GDBusMessage for a signal emission. - + filename="gio/gdbusmessage.c" + line="655">Creates a new #GDBusMessage for a signal emission. + A #GDBusMessage. Free with g_object_unref(). + filename="gio/gdbusmessage.c" + line="663">A #GDBusMessage. Free with g_object_unref(). A valid object path. + filename="gio/gdbusmessage.c" + line="657">A valid object path. A valid D-Bus interface name. + filename="gio/gdbusmessage.c" + line="658">A valid D-Bus interface name. A valid signal name. + filename="gio/gdbusmessage.c" + line="659">A valid signal name. @@ -22044,15 +22148,14 @@ g_object_unref(). version="2.26" throws="1"> Utility function to calculate how many bytes are needed to + filename="gio/gdbusmessage.c" + line="2242">Utility function to calculate how many bytes are needed to completely deserialize the D-Bus message stored at @blob. - + Number of bytes needed or -1 if @error is set (e.g. if + filename="gio/gdbusmessage.c" + line="2251">Number of bytes needed or -1 if @error is set (e.g. if @blob contains invalid data or not enough data is available to determine the size). @@ -22060,16 +22163,16 @@ determine the size). A blob representing a binary D-Bus message. + filename="gio/gdbusmessage.c" + line="2244">A blob representing a binary D-Bus message. The length of @blob (must be at least 16). + filename="gio/gdbusmessage.c" + line="2245">The length of @blob (must be at least 16). @@ -22079,27 +22182,26 @@ determine the size). version="2.26" throws="1"> Copies @message. The copy is a deep copy and the returned + filename="gio/gdbusmessage.c" + line="3958">Copies @message. The copy is a deep copy and the returned #GDBusMessage is completely identical except that it is guaranteed to not be locked. This operation can fail if e.g. @message contains file descriptors and the per-process or system-wide open files limit is reached. - + A new #GDBusMessage or %NULL if @error is set. + filename="gio/gdbusmessage.c" + line="3970">A new #GDBusMessage or %NULL if @error is set. Free with g_object_unref(). A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3960">A #GDBusMessage. @@ -22108,22 +22210,49 @@ and the per-process or system-wide open files limit is reached. c:identifier="g_dbus_message_get_arg0" version="2.26"> Convenience to get the first item in the body of @message. - + filename="gio/gdbusmessage.c" + line="3530">Convenience to get the first item in the body of @message. + +See [method@Gio.DBusMessage.get_arg0_path] for returning object-path-typed +arg0 values. + The string item or %NULL if the first item in the body of + filename="gio/gdbusmessage.c" + line="3539">The string item or %NULL if the first item in the body of @message is not a string. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3532">A #GDBusMessage. + + + + + + Convenience to get the first item in the body of @message. + +See [method@Gio.DBusMessage.get_arg0] for returning string-typed arg0 values. + + + The object path item or `NULL` if the first item in the + body of @message is not an object path. + + + + + A `GDBusMessage`. @@ -22132,22 +22261,21 @@ and the per-process or system-wide open files limit is reached. c:identifier="g_dbus_message_get_body" version="2.26"> Gets the body of a message. - + filename="gio/gdbusmessage.c" + line="1112">Gets the body of a message. + A #GVariant or %NULL if the body is + filename="gio/gdbusmessage.c" + line="1118">A #GVariant or %NULL if the body is empty. Do not free, it is owned by @message. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="1114">A #GDBusMessage. @@ -22155,21 +22283,20 @@ empty. Do not free, it is owned by @message. Gets the byte order of @message. - + filename="gio/gdbusmessage.c" + line="835">Gets the byte order of @message. + The byte order. + filename="gio/gdbusmessage.c" + line="841">The byte order. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="837">A #GDBusMessage. @@ -22178,21 +22305,20 @@ empty. Do not free, it is owned by @message. c:identifier="g_dbus_message_get_destination" version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. - + filename="gio/gdbusmessage.c" + line="3413">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. + The value. + filename="gio/gdbusmessage.c" + line="3419">The value. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3415">A #GDBusMessage. @@ -22201,21 +22327,20 @@ empty. Do not free, it is owned by @message. c:identifier="g_dbus_message_get_error_name" version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. - + filename="gio/gdbusmessage.c" + line="3450">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. + The value. + filename="gio/gdbusmessage.c" + line="3456">The value. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3452">A #GDBusMessage. @@ -22224,21 +22349,20 @@ empty. Do not free, it is owned by @message. c:identifier="g_dbus_message_get_flags" version="2.26"> Gets the flags for @message. - + filename="gio/gdbusmessage.c" + line="922">Gets the flags for @message. + Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together). + filename="gio/gdbusmessage.c" + line="928">Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together). A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="924">A #GDBusMessage. @@ -22247,31 +22371,30 @@ empty. Do not free, it is owned by @message. c:identifier="g_dbus_message_get_header" version="2.26"> Gets a header field on @message. + filename="gio/gdbusmessage.c" + line="1012">Gets a header field on @message. The caller is responsible for checking the type of the returned #GVariant matches what is expected. - + A #GVariant with the value if the header was found, %NULL + filename="gio/gdbusmessage.c" + line="1022">A #GVariant with the value if the header was found, %NULL otherwise. Do not free, it is owned by @message. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="1014">A #GDBusMessage. A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) + filename="gio/gdbusmessage.c" + line="1015">A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) @@ -22281,14 +22404,13 @@ otherwise. Do not free, it is owned by @message. c:identifier="g_dbus_message_get_header_fields" version="2.26"> Gets an array of all header fields on @message that are set. - + filename="gio/gdbusmessage.c" + line="1072">Gets an array of all header fields on @message that are set. + An array of header fields + filename="gio/gdbusmessage.c" + line="1078">An array of header fields terminated by %G_DBUS_MESSAGE_HEADER_FIELD_INVALID. Each element is a #guchar. Free with g_free(). @@ -22298,8 +22420,8 @@ is a #guchar. Free with g_free(). A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="1074">A #GDBusMessage. @@ -22308,21 +22430,20 @@ is a #guchar. Free with g_free(). c:identifier="g_dbus_message_get_interface" version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. - + filename="gio/gdbusmessage.c" + line="3265">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. + The value. + filename="gio/gdbusmessage.c" + line="3271">The value. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3267">A #GDBusMessage. @@ -22332,23 +22453,22 @@ is a #guchar. Free with g_free(). glib:get-property="locked" version="2.26"> Checks whether @message is locked. To monitor changes to this + filename="gio/gdbusmessage.c" + line="3916">Checks whether @message is locked. To monitor changes to this value, conncet to the #GObject::notify signal to listen for changes on the #GDBusMessage:locked property. - + %TRUE if @message is locked, %FALSE otherwise. + filename="gio/gdbusmessage.c" + line="3924">%TRUE if @message is locked, %FALSE otherwise. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3918">A #GDBusMessage. @@ -22357,21 +22477,20 @@ on the #GDBusMessage:locked property. c:identifier="g_dbus_message_get_member" version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. - + filename="gio/gdbusmessage.c" + line="3302">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. + The value. + filename="gio/gdbusmessage.c" + line="3308">The value. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3304">A #GDBusMessage. @@ -22380,21 +22499,20 @@ on the #GDBusMessage:locked property. c:identifier="g_dbus_message_get_message_type" version="2.26"> Gets the type of @message. - + filename="gio/gdbusmessage.c" + line="876">Gets the type of @message. + A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). + filename="gio/gdbusmessage.c" + line="882">A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="878">A #GDBusMessage. @@ -22403,21 +22521,20 @@ on the #GDBusMessage:locked property. c:identifier="g_dbus_message_get_num_unix_fds" version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. - + filename="gio/gdbusmessage.c" + line="3583">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. + The value. + filename="gio/gdbusmessage.c" + line="3589">The value. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3585">A #GDBusMessage. @@ -22426,21 +22543,20 @@ on the #GDBusMessage:locked property. c:identifier="g_dbus_message_get_path" version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. - + filename="gio/gdbusmessage.c" + line="3339">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. + The value. + filename="gio/gdbusmessage.c" + line="3345">The value. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3341">A #GDBusMessage. @@ -22449,21 +22565,20 @@ on the #GDBusMessage:locked property. c:identifier="g_dbus_message_get_reply_serial" version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. - + filename="gio/gdbusmessage.c" + line="3229">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. + The value. + filename="gio/gdbusmessage.c" + line="3235">The value. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3231">A #GDBusMessage. @@ -22472,21 +22587,20 @@ on the #GDBusMessage:locked property. c:identifier="g_dbus_message_get_sender" version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. - + filename="gio/gdbusmessage.c" + line="3376">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. + The value. + filename="gio/gdbusmessage.c" + line="3382">The value. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3378">A #GDBusMessage. @@ -22495,21 +22609,20 @@ on the #GDBusMessage:locked property. c:identifier="g_dbus_message_get_serial" version="2.26"> Gets the serial for @message. - + filename="gio/gdbusmessage.c" + line="967">Gets the serial for @message. + A #guint32. + filename="gio/gdbusmessage.c" + line="973">A #guint32. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="969">A #GDBusMessage. @@ -22518,23 +22631,22 @@ on the #GDBusMessage:locked property. c:identifier="g_dbus_message_get_signature" version="2.26"> Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. + filename="gio/gdbusmessage.c" + line="3487">Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. This will always be non-%NULL, but may be an empty string. - + The value. + filename="gio/gdbusmessage.c" + line="3495">The value. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3489">A #GDBusMessage. @@ -22543,8 +22655,8 @@ This will always be non-%NULL, but may be an empty string. c:identifier="g_dbus_message_get_unix_fd_list" version="2.26"> Gets the UNIX file descriptors associated with @message, if any. + filename="gio/gdbusmessage.c" + line="1190">Gets the UNIX file descriptors associated with @message, if any. This method is only available on UNIX. @@ -22553,38 +22665,36 @@ values in the body of the message. For example, if g_variant_get_handle() returns 5, that is intended to be a reference to the file descriptor that can be accessed by `g_unix_fd_list_get (list, 5, ...)`. - + A #GUnixFDList or %NULL if no file descriptors are + filename="gio/gdbusmessage.c" + line="1204">A #GUnixFDList or %NULL if no file descriptors are associated. Do not free, this object is owned by @message. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="1192">A #GDBusMessage. If @message is locked, does nothing. Otherwise locks the message. - + filename="gio/gdbusmessage.c" + line="3935">If @message is locked, does nothing. Otherwise locks the message. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3937">A #GDBusMessage. @@ -22594,41 +22704,40 @@ associated. Do not free, this object is owned by @message. version="2.26" introspectable="0"> Creates a new #GDBusMessage that is an error reply to @method_call_message. - + filename="gio/gdbusmessage.c" + line="725">Creates a new #GDBusMessage that is an error reply to @method_call_message. + A #GDBusMessage. Free with g_object_unref(). + filename="gio/gdbusmessage.c" + line="735">A #GDBusMessage. Free with g_object_unref(). A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + filename="gio/gdbusmessage.c" + line="727">A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. A valid D-Bus error name. + filename="gio/gdbusmessage.c" + line="729">A valid D-Bus error name. The D-Bus error message in a printf() format. + filename="gio/gdbusmessage.c" + line="730">The D-Bus error message in a printf() format. Arguments for @error_message_format. + filename="gio/gdbusmessage.c" + line="731">Arguments for @error_message_format. @@ -22637,35 +22746,34 @@ create a reply message to. c:identifier="g_dbus_message_new_method_error_literal" version="2.26"> Creates a new #GDBusMessage that is an error reply to @method_call_message. - + filename="gio/gdbusmessage.c" + line="758">Creates a new #GDBusMessage that is an error reply to @method_call_message. + A #GDBusMessage. Free with g_object_unref(). + filename="gio/gdbusmessage.c" + line="767">A #GDBusMessage. Free with g_object_unref(). A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + filename="gio/gdbusmessage.c" + line="760">A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. A valid D-Bus error name. + filename="gio/gdbusmessage.c" + line="762">A valid D-Bus error name. The D-Bus error message. + filename="gio/gdbusmessage.c" + line="763">The D-Bus error message. @@ -22675,41 +22783,40 @@ create a reply message to. version="2.26" introspectable="0"> Like g_dbus_message_new_method_error() but intended for language bindings. - + filename="gio/gdbusmessage.c" + line="802">Like g_dbus_message_new_method_error() but intended for language bindings. + A #GDBusMessage. Free with g_object_unref(). + filename="gio/gdbusmessage.c" + line="812">A #GDBusMessage. Free with g_object_unref(). A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + filename="gio/gdbusmessage.c" + line="804">A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. A valid D-Bus error name. + filename="gio/gdbusmessage.c" + line="806">A valid D-Bus error name. The D-Bus error message in a printf() format. + filename="gio/gdbusmessage.c" + line="807">The D-Bus error message in a printf() format. Arguments for @error_message_format. + filename="gio/gdbusmessage.c" + line="808">Arguments for @error_message_format. @@ -22718,22 +22825,21 @@ create a reply message to. c:identifier="g_dbus_message_new_method_reply" version="2.26"> Creates a new #GDBusMessage that is a reply to @method_call_message. - + filename="gio/gdbusmessage.c" + line="690">Creates a new #GDBusMessage that is a reply to @method_call_message. + #GDBusMessage. Free with g_object_unref(). + filename="gio/gdbusmessage.c" + line="697">#GDBusMessage. Free with g_object_unref(). A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to + filename="gio/gdbusmessage.c" + line="692">A message of type %G_DBUS_MESSAGE_TYPE_METHOD_CALL to create a reply message to. @@ -22741,13 +22847,13 @@ create a reply message to. Produces a human-readable multi-line description of @message. + filename="gio/gdbusmessage.c" + line="3746">Produces a human-readable multi-line description of @message. The contents of the description has no ABI guarantees, the contents and formatting is subject to change at any time. Typical output looks something like this: -|[ +``` Flags: none Version: 0 Serial: 4 @@ -22759,9 +22865,9 @@ Headers: Body: () UNIX File Descriptors: (none) -]| +``` or -|[ +``` Flags: no-reply-expected Version: 0 Serial: 477 @@ -22773,26 +22879,25 @@ Headers: Body: () UNIX File Descriptors: fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635 -]| - +``` + A string that should be freed with g_free(). + filename="gio/gdbusmessage.c" + line="3786">A string that should be freed with [func@GLib.free]. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3748">A #GDBusMessage. Indentation level. + filename="gio/gdbusmessage.c" + line="3749">Indentation level. @@ -22801,28 +22906,27 @@ UNIX File Descriptors: c:identifier="g_dbus_message_set_body" version="2.26"> Sets the body @message. As a side-effect the + filename="gio/gdbusmessage.c" + line="1130">Sets the body @message. As a side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the type string of @body (or cleared if @body is %NULL). If @body is floating, @message assumes ownership of @body. - + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="1132">A #GDBusMessage. Either %NULL or a #GVariant that is a tuple. + filename="gio/gdbusmessage.c" + line="1133">Either %NULL or a #GVariant that is a tuple. @@ -22830,24 +22934,23 @@ If @body is floating, @message assumes ownership of @body. Sets the byte order of @message. - + filename="gio/gdbusmessage.c" + line="850">Sets the byte order of @message. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="852">A #GDBusMessage. The byte order. + filename="gio/gdbusmessage.c" + line="853">The byte order. @@ -22856,18 +22959,17 @@ If @body is floating, @message assumes ownership of @body. c:identifier="g_dbus_message_set_destination" version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. - + filename="gio/gdbusmessage.c" + line="3430">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3432">A #GDBusMessage. nullable="1" allow-none="1"> The value to set. + filename="gio/gdbusmessage.c" + line="3433">The value to set. @@ -22885,10 +22987,9 @@ If @body is floating, @message assumes ownership of @body. c:identifier="g_dbus_message_set_error_name" version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. - + filename="gio/gdbusmessage.c" + line="3467">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field. + @@ -22898,14 +22999,14 @@ If @body is floating, @message assumes ownership of @body. nullable="1" allow-none="1"> A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3469">A #GDBusMessage. The value to set. + filename="gio/gdbusmessage.c" + line="3470">The value to set. @@ -22914,24 +23015,23 @@ If @body is floating, @message assumes ownership of @body. c:identifier="g_dbus_message_set_flags" version="2.26"> Sets the flags to set on @message. - + filename="gio/gdbusmessage.c" + line="939">Sets the flags to set on @message. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="941">A #GDBusMessage. Flags for @message that are set (typically values from the #GDBusMessageFlags + filename="gio/gdbusmessage.c" + line="942">Flags for @message that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together). @@ -22941,26 +23041,25 @@ enumeration bitwise ORed together). c:identifier="g_dbus_message_set_header" version="2.26"> Sets a header field on @message. + filename="gio/gdbusmessage.c" + line="1036">Sets a header field on @message. If @value is floating, @message assumes ownership of @value. - + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="1038">A #GDBusMessage. A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) + filename="gio/gdbusmessage.c" + line="1039">A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration) @@ -22969,8 +23068,8 @@ If @value is floating, @message assumes ownership of @value. nullable="1" allow-none="1"> A #GVariant to set the header field or %NULL to clear the header field. + filename="gio/gdbusmessage.c" + line="1040">A #GVariant to set the header field or %NULL to clear the header field. @@ -22979,18 +23078,17 @@ If @value is floating, @message assumes ownership of @value. c:identifier="g_dbus_message_set_interface" version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. - + filename="gio/gdbusmessage.c" + line="3282">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3284">A #GDBusMessage. nullable="1" allow-none="1"> The value to set. + filename="gio/gdbusmessage.c" + line="3285">The value to set. @@ -23008,18 +23106,17 @@ If @value is floating, @message assumes ownership of @value. c:identifier="g_dbus_message_set_member" version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. - + filename="gio/gdbusmessage.c" + line="3319">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3321">A #GDBusMessage. nullable="1" allow-none="1"> The value to set. + filename="gio/gdbusmessage.c" + line="3322">The value to set. @@ -23037,24 +23134,23 @@ If @value is floating, @message assumes ownership of @value. c:identifier="g_dbus_message_set_message_type" version="2.26"> Sets @message to be of @type. - + filename="gio/gdbusmessage.c" + line="893">Sets @message to be of @type. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="895">A #GDBusMessage. A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). + filename="gio/gdbusmessage.c" + line="896">A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration). @@ -23063,24 +23159,23 @@ If @value is floating, @message assumes ownership of @value. c:identifier="g_dbus_message_set_num_unix_fds" version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. - + filename="gio/gdbusmessage.c" + line="3600">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3602">A #GDBusMessage. The value to set. + filename="gio/gdbusmessage.c" + line="3603">The value to set. @@ -23089,18 +23184,17 @@ If @value is floating, @message assumes ownership of @value. c:identifier="g_dbus_message_set_path" version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. - + filename="gio/gdbusmessage.c" + line="3356">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3358">A #GDBusMessage. nullable="1" allow-none="1"> The value to set. + filename="gio/gdbusmessage.c" + line="3359">The value to set. @@ -23118,24 +23212,23 @@ If @value is floating, @message assumes ownership of @value. c:identifier="g_dbus_message_set_reply_serial" version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. - + filename="gio/gdbusmessage.c" + line="3246">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3248">A #GDBusMessage. The value to set. + filename="gio/gdbusmessage.c" + line="3249">The value to set. @@ -23144,18 +23237,17 @@ If @value is floating, @message assumes ownership of @value. c:identifier="g_dbus_message_set_sender" version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. - + filename="gio/gdbusmessage.c" + line="3393">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3395">A #GDBusMessage. nullable="1" allow-none="1"> The value to set. + filename="gio/gdbusmessage.c" + line="3396">The value to set. @@ -23173,24 +23265,23 @@ If @value is floating, @message assumes ownership of @value. c:identifier="g_dbus_message_set_serial" version="2.26"> Sets the serial for @message. - + filename="gio/gdbusmessage.c" + line="984">Sets the serial for @message. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="986">A #GDBusMessage. A #guint32. + filename="gio/gdbusmessage.c" + line="987">A #guint32. @@ -23199,18 +23290,17 @@ If @value is floating, @message assumes ownership of @value. c:identifier="g_dbus_message_set_signature" version="2.26"> Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. - + filename="gio/gdbusmessage.c" + line="3510">Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field. + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3512">A #GDBusMessage. nullable="1" allow-none="1"> The value to set. + filename="gio/gdbusmessage.c" + line="3513">The value to set. @@ -23228,8 +23318,8 @@ If @value is floating, @message assumes ownership of @value. c:identifier="g_dbus_message_set_unix_fd_list" version="2.26"> Sets the UNIX file descriptors associated with @message. As a + filename="gio/gdbusmessage.c" + line="1216">Sets the UNIX file descriptors associated with @message. As a side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field is set to the number of fds in @fd_list (or cleared if @fd_list is %NULL). @@ -23240,16 +23330,15 @@ When designing D-Bus APIs that are intended to be interoperable, please note that non-GDBus implementations of D-Bus can usually only access file descriptors if they are referenced by a value of type %G_VARIANT_TYPE_HANDLE in the body of the message. - + A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="1218">A #GDBusMessage. A #GUnixFDList or %NULL. + filename="gio/gdbusmessage.c" + line="1219">A #GUnixFDList or %NULL. @@ -23268,15 +23357,14 @@ access file descriptors if they are referenced by a value of type version="2.26" throws="1"> Serializes @message to a blob. The byte order returned by + filename="gio/gdbusmessage.c" + line="2930">Serializes @message to a blob. The byte order returned by g_dbus_message_get_byte_order() will be used. - + A pointer to a + filename="gio/gdbusmessage.c" + line="2940">A pointer to a valid binary D-Bus message of @out_size bytes generated by @message or %NULL if @error is set. Free with g_free(). @@ -23286,8 +23374,8 @@ or %NULL if @error is set. Free with g_free(). A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="2932">A #GDBusMessage. caller-allocates="0" transfer-ownership="full"> Return location for size of generated blob. + filename="gio/gdbusmessage.c" + line="2933">Return location for size of generated blob. A #GDBusCapabilityFlags describing what protocol features are supported. + filename="gio/gdbusmessage.c" + line="2934">A #GDBusCapabilityFlags describing what protocol features are supported. @@ -23312,27 +23400,26 @@ or %NULL if @error is set. Free with g_free(). version="2.26" throws="1"> If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does + filename="gio/gdbusmessage.c" + line="3619">If @message is not of type %G_DBUS_MESSAGE_TYPE_ERROR does nothing and returns %FALSE. Otherwise this method encodes the error in @message as a #GError using g_dbus_error_set_dbus_error() using the information in the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of @message as well as the first string item in @message's body. - + %TRUE if @error was set, %FALSE otherwise. + filename="gio/gdbusmessage.c" + line="3632">%TRUE if @error was set, %FALSE otherwise. A #GDBusMessage. + filename="gio/gdbusmessage.c" + line="3621">A #GDBusMessage. @@ -23350,16 +23437,16 @@ well as the first string item in @message's body. glib:get-type="g_dbus_message_byte_order_get_type" c:type="GDBusMessageByteOrder"> Enumeration used to describe the byte order of a D-Bus message. + filename="gio/gioenums.h" + line="1482">Enumeration used to describe the byte order of a D-Bus message. The byte order is big endian. + filename="gio/gioenums.h" + line="1484">The byte order is big endian. glib:nick="little-endian" glib:name="G_DBUS_MESSAGE_BYTE_ORDER_LITTLE_ENDIAN"> The byte order is little endian. + filename="gio/gioenums.h" + line="1485">The byte order is little endian. Signature for function used in g_dbus_connection_add_filter(). A filter function is passed a #GDBusMessage and expected to return @@ -23435,11 +23522,10 @@ descriptors, not compatible with @connection), then a warning is logged to standard error. Applications can check this ahead of time using g_dbus_message_to_blob() passing a #GDBusCapabilityFlags value obtained from @connection. - + A #GDBusMessage that will be freed with g_object_unref() or %NULL to drop the message. Passive filter functions can simply return the passed @message object. @@ -23448,19 +23534,19 @@ functions can simply return the passed @message object. A #GDBusConnection. A locked #GDBusMessage that the filter function takes ownership of. %TRUE if it is a message received from the other peer, %FALSE if it is a message to be sent to the other peer. @@ -23471,7 +23557,7 @@ a message to be sent to the other peer. allow-none="1" closure="3"> User data passed when adding the filter. @@ -23483,16 +23569,16 @@ a message to be sent to the other peer. glib:get-type="g_dbus_message_flags_get_type" c:type="GDBusMessageFlags"> Message flags used in #GDBusMessage. + filename="gio/gioenums.h" + line="1305">Message flags used in #GDBusMessage. No flags set. + filename="gio/gioenums.h" + line="1307">No flags set. glib:nick="no-reply-expected" glib:name="G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED"> A reply is not expected. + filename="gio/gioenums.h" + line="1308">A reply is not expected. glib:nick="no-auto-start" glib:name="G_DBUS_MESSAGE_FLAGS_NO_AUTO_START"> The bus must not launch an + filename="gio/gioenums.h" + line="1309">The bus must not launch an owner for the destination name in response to this message. glib:nick="allow-interactive-authorization" glib:name="G_DBUS_MESSAGE_FLAGS_ALLOW_INTERACTIVE_AUTHORIZATION"> If set on a method + filename="gio/gioenums.h" + line="1311">If set on a method call, this flag means that the caller is prepared to wait for interactive authorization. Since 2.46. @@ -23531,16 +23617,16 @@ authorization. Since 2.46. glib:get-type="g_dbus_message_header_field_get_type" c:type="GDBusMessageHeaderField"> Header fields used in #GDBusMessage. + filename="gio/gioenums.h" + line="1326">Header fields used in #GDBusMessage. Not a valid header field. + filename="gio/gioenums.h" + line="1328">Not a valid header field. glib:nick="path" glib:name="G_DBUS_MESSAGE_HEADER_FIELD_PATH"> The object path. + filename="gio/gioenums.h" + line="1329">The object path. glib:nick="interface" glib:name="G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE"> The interface name. + filename="gio/gioenums.h" + line="1330">The interface name. glib:nick="member" glib:name="G_DBUS_MESSAGE_HEADER_FIELD_MEMBER"> The method or signal name. + filename="gio/gioenums.h" + line="1331">The method or signal name. glib:nick="error-name" glib:name="G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME"> The name of the error that occurred. + filename="gio/gioenums.h" + line="1332">The name of the error that occurred. glib:nick="reply-serial" glib:name="G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL"> The serial number the message is a reply to. + filename="gio/gioenums.h" + line="1333">The serial number the message is a reply to. glib:nick="destination" glib:name="G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION"> The name the message is intended for. + filename="gio/gioenums.h" + line="1334">The name the message is intended for. glib:nick="sender" glib:name="G_DBUS_MESSAGE_HEADER_FIELD_SENDER"> Unique name of the sender of the message (filled in by the bus). + filename="gio/gioenums.h" + line="1335">Unique name of the sender of the message (filled in by the bus). glib:nick="signature" glib:name="G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE"> The signature of the message body. + filename="gio/gioenums.h" + line="1336">The signature of the message body. glib:nick="num-unix-fds" glib:name="G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS"> The number of UNIX file descriptors that accompany the message. + filename="gio/gioenums.h" + line="1337">The number of UNIX file descriptors that accompany the message. glib:get-type="g_dbus_message_type_get_type" c:type="GDBusMessageType"> Message types used in #GDBusMessage. + filename="gio/gioenums.h" + line="1285">Message types used in #GDBusMessage. Message is of invalid type. + filename="gio/gioenums.h" + line="1287">Message is of invalid type. glib:nick="method-call" glib:name="G_DBUS_MESSAGE_TYPE_METHOD_CALL"> Method call. + filename="gio/gioenums.h" + line="1288">Method call. glib:nick="method-return" glib:name="G_DBUS_MESSAGE_TYPE_METHOD_RETURN"> Method reply. + filename="gio/gioenums.h" + line="1289">Method reply. glib:nick="error" glib:name="G_DBUS_MESSAGE_TYPE_ERROR"> Error reply. + filename="gio/gioenums.h" + line="1290">Error reply. glib:nick="signal" glib:name="G_DBUS_MESSAGE_TYPE_SIGNAL"> Signal emission. + filename="gio/gioenums.h" + line="1291">Signal emission. glib:get-type="g_dbus_method_info_get_type" c:symbol-prefix="dbus_method_info"> Information about a method on an D-Bus interface. - + The reference count or -1 if statically allocated. The name of the D-Bus method, e.g. @RequestName. A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no in arguments. @@ -23711,7 +23796,7 @@ authorization. Since 2.46. A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no out arguments. @@ -23719,7 +23804,7 @@ authorization. Since 2.46. A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. @@ -23727,22 +23812,21 @@ authorization. Since 2.46. If @info is statically allocated does nothing. Otherwise increases + filename="gio/gdbusintrospection.c" + line="122">If @info is statically allocated does nothing. Otherwise increases the reference count. - + The same @info. + filename="gio/gdbusintrospection.c" + line="129">The same @info. A #GDBusMethodInfo + filename="gio/gdbusintrospection.c" + line="124">A #GDBusMethodInfo @@ -23751,20 +23835,19 @@ the reference count. c:identifier="g_dbus_method_info_unref" version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + filename="gio/gdbusintrospection.c" + line="284">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. - + A #GDBusMethodInfo. + filename="gio/gdbusintrospection.c" + line="286">A #GDBusMethodInfo. @@ -23778,33 +23861,33 @@ the memory used is freed. glib:type-name="GDBusMethodInvocation" glib:get-type="g_dbus_method_invocation_get_type"> Instances of the #GDBusMethodInvocation class are used when + filename="gio/gdbusmethodinvocation.c" + line="42">Instances of the `GDBusMethodInvocation` class are used when handling D-Bus method calls. It provides a way to asynchronously return results and errors. -The normal way to obtain a #GDBusMethodInvocation object is to receive -it as an argument to the handle_method_call() function in a -#GDBusInterfaceVTable that was passed to g_dbus_connection_register_object(). +The normal way to obtain a `GDBusMethodInvocation` object is to receive +it as an argument to the `handle_method_call()` function in a +[type@Gio.DBusInterfaceVTable] that was passed to +[method@Gio.DBusConnection.register_object]. Gets the #GDBusConnection the method was invoked on. - + filename="gio/gdbusmethodinvocation.c" + line="247">Gets the #GDBusConnection the method was invoked on. + A #GDBusConnection. Do not free, it is owned by @invocation. + filename="gio/gdbusmethodinvocation.c" + line="253">A #GDBusConnection. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="249">A #GDBusMethodInvocation. @@ -23813,26 +23896,25 @@ it as an argument to the handle_method_call() function in a c:identifier="g_dbus_method_invocation_get_interface_name" version="2.26"> Gets the name of the D-Bus interface the method was invoked on. + filename="gio/gdbusmethodinvocation.c" + line="159">Gets the name of the D-Bus interface the method was invoked on. If this method call is a property Get, Set or GetAll call that has been redirected to the method call handler then "org.freedesktop.DBus.Properties" will be returned. See #GDBusInterfaceVTable for more information. - + A string. Do not free, it is owned by @invocation. + filename="gio/gdbusmethodinvocation.c" + line="170">A string. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="161">A #GDBusMethodInvocation. @@ -23841,8 +23923,8 @@ been redirected to the method call handler then c:identifier="g_dbus_method_invocation_get_message" version="2.26"> Gets the #GDBusMessage for the method invocation. This is useful if + filename="gio/gdbusmethodinvocation.c" + line="264">Gets the #GDBusMessage for the method invocation. This is useful if you need to use low-level protocol features, such as UNIX file descriptor passing, that cannot be properly expressed in the #GVariant API. @@ -23850,19 +23932,18 @@ descriptor passing, that cannot be properly expressed in the See this [server][gdbus-server] and [client][gdbus-unix-fd-client] for an example of how to use this low-level API to send and receive UNIX file descriptors. - + #GDBusMessage. Do not free, it is owned by @invocation. + filename="gio/gdbusmethodinvocation.c" + line="277">#GDBusMessage. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="266">A #GDBusMethodInvocation. @@ -23871,26 +23952,25 @@ UNIX file descriptors. c:identifier="g_dbus_method_invocation_get_method_info" version="2.26"> Gets information about the method call, if any. + filename="gio/gdbusmethodinvocation.c" + line="181">Gets information about the method call, if any. If this method invocation is a property Get, Set or GetAll call that has been redirected to the method call handler then %NULL will be returned. See g_dbus_method_invocation_get_property_info() and #GDBusInterfaceVTable for more information. - + A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation. + filename="gio/gdbusmethodinvocation.c" + line="192">A #GDBusMethodInfo or %NULL. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="183">A #GDBusMethodInvocation. @@ -23899,21 +23979,20 @@ returned. See g_dbus_method_invocation_get_property_info() and c:identifier="g_dbus_method_invocation_get_method_name" version="2.26"> Gets the name of the method that was invoked. - + filename="gio/gdbusmethodinvocation.c" + line="230">Gets the name of the method that was invoked. + A string. Do not free, it is owned by @invocation. + filename="gio/gdbusmethodinvocation.c" + line="236">A string. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="232">A #GDBusMethodInvocation. @@ -23922,21 +24001,20 @@ returned. See g_dbus_method_invocation_get_property_info() and c:identifier="g_dbus_method_invocation_get_object_path" version="2.26"> Gets the object path the method was invoked on. - + filename="gio/gdbusmethodinvocation.c" + line="142">Gets the object path the method was invoked on. + A string. Do not free, it is owned by @invocation. + filename="gio/gdbusmethodinvocation.c" + line="148">A string. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="144">A #GDBusMethodInvocation. @@ -23945,22 +24023,21 @@ returned. See g_dbus_method_invocation_get_property_info() and c:identifier="g_dbus_method_invocation_get_parameters" version="2.26"> Gets the parameters of the method invocation. If there are no input + filename="gio/gdbusmethodinvocation.c" + line="288">Gets the parameters of the method invocation. If there are no input parameters then this will return a GVariant with 0 children rather than NULL. - + A #GVariant tuple. Do not unref this because it is owned by @invocation. + filename="gio/gdbusmethodinvocation.c" + line="295">A #GVariant tuple. Do not unref this because it is owned by @invocation. A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="290">A #GDBusMethodInvocation. @@ -23969,8 +24046,8 @@ parameters then this will return a GVariant with 0 children rather than NULL. Gets information about the property that this method call is for, if + filename="gio/gdbusmethodinvocation.c" + line="203">Gets information about the property that this method call is for, if any. This will only be set in the case of an invocation in response to a @@ -23981,19 +24058,18 @@ property_set() vtable pointers being unset. See #GDBusInterfaceVTable for more information. If the call was GetAll, %NULL will be returned. - + a #GDBusPropertyInfo or %NULL + filename="gio/gdbusmethodinvocation.c" + line="219">a #GDBusPropertyInfo or %NULL A #GDBusMethodInvocation + filename="gio/gdbusmethodinvocation.c" + line="205">A #GDBusMethodInvocation @@ -24002,21 +24078,20 @@ If the call was GetAll, %NULL will be returned. c:identifier="g_dbus_method_invocation_get_sender" version="2.26"> Gets the bus name that invoked the method. - + filename="gio/gdbusmethodinvocation.c" + line="125">Gets the bus name that invoked the method. + A string. Do not free, it is owned by @invocation. + filename="gio/gdbusmethodinvocation.c" + line="131">A string. Do not free, it is owned by @invocation. A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="127">A #GDBusMethodInvocation. @@ -24026,21 +24101,20 @@ If the call was GetAll, %NULL will be returned. version="2.26" introspectable="0"> Gets the @user_data #gpointer passed to g_dbus_connection_register_object(). - + filename="gio/gdbusmethodinvocation.c" + line="306">Gets the @user_data #gpointer passed to g_dbus_connection_register_object(). + A #gpointer. + filename="gio/gdbusmethodinvocation.c" + line="312">A #gpointer. A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="308">A #GDBusMethodInvocation. @@ -24049,34 +24123,33 @@ If the call was GetAll, %NULL will be returned. c:identifier="g_dbus_method_invocation_return_dbus_error" version="2.26"> Finishes handling a D-Bus method call by returning an error. + filename="gio/gdbusmethodinvocation.c" + line="777">Finishes handling a D-Bus method call by returning an error. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="779">A #GDBusMethodInvocation. A valid D-Bus error name. + filename="gio/gdbusmethodinvocation.c" + line="780">A valid D-Bus error name. A valid D-Bus error message. + filename="gio/gdbusmethodinvocation.c" + line="781">A valid D-Bus error message. @@ -24086,8 +24159,8 @@ This method will take ownership of @invocation. See version="2.26" introspectable="0"> Finishes handling a D-Bus method call by returning an error. + filename="gio/gdbusmethodinvocation.c" + line="602">Finishes handling a D-Bus method call by returning an error. See g_dbus_error_encode_gerror() for details about what error name will be returned on the wire. In a nutshell, if the given error is @@ -24107,40 +24180,39 @@ This method will take ownership of @invocation. See Since 2.48, if the method call requested for a reply not to be sent then this call will free @invocation but otherwise do nothing (as per the recommendations of the D-Bus specification). - + A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="604">A #GDBusMethodInvocation. A #GQuark for the #GError error domain. + filename="gio/gdbusmethodinvocation.c" + line="605">A #GQuark for the #GError error domain. The error code. + filename="gio/gdbusmethodinvocation.c" + line="606">The error code. printf()-style format. + filename="gio/gdbusmethodinvocation.c" + line="607">printf()-style format. Parameters for @format. + filename="gio/gdbusmethodinvocation.c" + line="608">Parameters for @format. @@ -24149,40 +24221,39 @@ the recommendations of the D-Bus specification). c:identifier="g_dbus_method_invocation_return_error_literal" version="2.26"> Like g_dbus_method_invocation_return_error() but without printf()-style formatting. + filename="gio/gdbusmethodinvocation.c" + line="691">Like g_dbus_method_invocation_return_error() but without printf()-style formatting. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="693">A #GDBusMethodInvocation. A #GQuark for the #GError error domain. + filename="gio/gdbusmethodinvocation.c" + line="694">A #GQuark for the #GError error domain. The error code. + filename="gio/gdbusmethodinvocation.c" + line="695">The error code. The error message. + filename="gio/gdbusmethodinvocation.c" + line="696">The error message. @@ -24192,47 +24263,46 @@ This method will take ownership of @invocation. See version="2.26" introspectable="0"> Like g_dbus_method_invocation_return_error() but intended for + filename="gio/gdbusmethodinvocation.c" + line="654">Like g_dbus_method_invocation_return_error() but intended for language bindings. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="656">A #GDBusMethodInvocation. A #GQuark for the #GError error domain. + filename="gio/gdbusmethodinvocation.c" + line="657">A #GQuark for the #GError error domain. The error code. + filename="gio/gdbusmethodinvocation.c" + line="658">The error code. printf()-style format. + filename="gio/gdbusmethodinvocation.c" + line="659">printf()-style format. #va_list of parameters for @format. + filename="gio/gdbusmethodinvocation.c" + line="660">#va_list of parameters for @format. @@ -24241,29 +24311,28 @@ This method will take ownership of @invocation. See c:identifier="g_dbus_method_invocation_return_gerror" version="2.26"> Like g_dbus_method_invocation_return_error() but takes a #GError + filename="gio/gdbusmethodinvocation.c" + line="722">Like g_dbus_method_invocation_return_error() but takes a #GError instead of the error domain, error code and message. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="724">A #GDBusMethodInvocation. A #GError. + filename="gio/gdbusmethodinvocation.c" + line="725">A #GError. @@ -24272,8 +24341,8 @@ This method will take ownership of @invocation. See c:identifier="g_dbus_method_invocation_return_value" version="2.26"> Finishes handling a D-Bus method call by returning @parameters. + filename="gio/gdbusmethodinvocation.c" + line="527">Finishes handling a D-Bus method call by returning @parameters. If the @parameters GVariant is floating, it is consumed. It is an error if @parameters is not of the right format: it must be a tuple @@ -24305,16 +24374,15 @@ Since 2.48, if the method call requested for a reply not to be sent then this call will sink @parameters and free @invocation, but otherwise do nothing (as per the recommendations of the D-Bus specification). - + A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="529">A #GDBusMethodInvocation. nullable="1" allow-none="1"> A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. + filename="gio/gdbusmethodinvocation.c" + line="530">A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. @@ -24332,24 +24400,23 @@ specification). c:identifier="g_dbus_method_invocation_return_value_with_unix_fd_list" version="2.30"> Like g_dbus_method_invocation_return_value() but also takes a #GUnixFDList. + filename="gio/gdbusmethodinvocation.c" + line="575">Like g_dbus_method_invocation_return_value() but also takes a #GUnixFDList. This method is only available on UNIX. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="577">A #GDBusMethodInvocation. A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. + filename="gio/gdbusmethodinvocation.c" + line="578">A #GVariant tuple with out parameters for the method or %NULL if not passing any parameters. A #GUnixFDList or %NULL. + filename="gio/gdbusmethodinvocation.c" + line="579">A #GUnixFDList or %NULL. @@ -24377,29 +24444,28 @@ This method will take ownership of @invocation. See version="2.30" introspectable="0"> Like g_dbus_method_invocation_return_gerror() but takes ownership + filename="gio/gdbusmethodinvocation.c" + line="753">Like g_dbus_method_invocation_return_gerror() but takes ownership of @error so the caller does not need to free it. This method will take ownership of @invocation. See #GDBusInterfaceVTable for more information about the ownership of @invocation. - + A #GDBusMethodInvocation. + filename="gio/gdbusmethodinvocation.c" + line="755">A #GDBusMethodInvocation. A #GError. + filename="gio/gdbusmethodinvocation.c" + line="756">A #GError. @@ -24412,25 +24478,24 @@ This method will take ownership of @invocation. See glib:get-type="g_dbus_node_info_get_type" c:symbol-prefix="dbus_node_info"> Information about nodes in a remote object hierarchy. - + The reference count or -1 if statically allocated. The path of the node or %NULL if omitted. Note that this may be a relative path. See the D-Bus specification for more details. A pointer to a %NULL-terminated array of pointers to #GDBusInterfaceInfo structures or %NULL if there are no interfaces. @@ -24438,7 +24503,7 @@ This method will take ownership of @invocation. See A pointer to a %NULL-terminated array of pointers to #GDBusNodeInfo structures or %NULL if there are no nodes. @@ -24446,7 +24511,7 @@ This method will take ownership of @invocation. See A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. @@ -24457,8 +24522,8 @@ This method will take ownership of @invocation. See version="2.26" throws="1"> Parses @xml_data and returns a #GDBusNodeInfo representing the data. + filename="gio/gdbusintrospection.c" + line="1742">Parses @xml_data and returns a #GDBusNodeInfo representing the data. The introspection XML must contain exactly one top-level <node> element. @@ -24466,20 +24531,19 @@ The introspection XML must contain exactly one top-level Note that this routine is using a [GMarkup][glib-Simple-XML-Subset-Parser.description]-based parser that only accepts a subset of valid XML documents. - + A #GDBusNodeInfo structure or %NULL if @error is set. Free + filename="gio/gdbusintrospection.c" + line="1756">A #GDBusNodeInfo structure or %NULL if @error is set. Free with g_dbus_node_info_unref(). Valid D-Bus introspection XML. + filename="gio/gdbusintrospection.c" + line="1744">Valid D-Bus introspection XML. @@ -24488,33 +24552,32 @@ with g_dbus_node_info_unref(). c:identifier="g_dbus_node_info_generate_xml" version="2.26"> Appends an XML representation of @info (and its children) to @string_builder. + filename="gio/gdbusintrospection.c" + line="812">Appends an XML representation of @info (and its children) to @string_builder. This function is typically used for generating introspection XML documents at run-time for handling the `org.freedesktop.DBus.Introspectable.Introspect` method. - + A #GDBusNodeInfo. + filename="gio/gdbusintrospection.c" + line="814">A #GDBusNodeInfo. Indentation level. + filename="gio/gdbusintrospection.c" + line="815">Indentation level. A #GString to to append XML data to. + filename="gio/gdbusintrospection.c" + line="816">A #GString to to append XML data to. @@ -24523,51 +24586,49 @@ handling the `org.freedesktop.DBus.Introspectable.Introspect` method. c:identifier="g_dbus_node_info_lookup_interface" version="2.26"> Looks up information about an interface. + filename="gio/gdbusintrospection.c" + line="2147">Looks up information about an interface. The cost of this function is O(n) in number of interfaces. - + A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @info. + filename="gio/gdbusintrospection.c" + line="2156">A #GDBusInterfaceInfo or %NULL if not found. Do not free, it is owned by @info. A #GDBusNodeInfo. + filename="gio/gdbusintrospection.c" + line="2149">A #GDBusNodeInfo. A D-Bus interface name. + filename="gio/gdbusintrospection.c" + line="2150">A D-Bus interface name. If @info is statically allocated does nothing. Otherwise increases + filename="gio/gdbusintrospection.c" + line="82">If @info is statically allocated does nothing. Otherwise increases the reference count. - + The same @info. + filename="gio/gdbusintrospection.c" + line="89">The same @info. A #GDBusNodeInfo + filename="gio/gdbusintrospection.c" + line="84">A #GDBusNodeInfo @@ -24576,20 +24637,19 @@ the reference count. c:identifier="g_dbus_node_info_unref" version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + filename="gio/gdbusintrospection.c" + line="383">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. - + A #GDBusNodeInfo. + filename="gio/gdbusintrospection.c" + line="385">A #GDBusNodeInfo. @@ -24602,40 +24662,38 @@ the memory used is freed. glib:get-type="g_dbus_object_get_type" glib:type-struct="DBusObjectIface"> The #GDBusObject type is the base type for D-Bus objects on both -the service side (see #GDBusObjectSkeleton) and the client side -(see #GDBusObjectProxy). It is essentially just a container of + filename="gio/gdbusobject.c" + line="31">The `GDBusObject` type is the base type for D-Bus objects on both +the service side (see [class@Gio.DBusObjectSkeleton]) and the client side +(see [class@Gio.DBusObjectProxy]). It is essentially just a container of interfaces. - + Gets the D-Bus interface with name @interface_name associated with + filename="gio/gdbusobject.c" + line="125">Gets the D-Bus interface with name @interface_name associated with @object, if any. - + %NULL if not found, otherwise a + filename="gio/gdbusobject.c" + line="133">%NULL if not found, otherwise a #GDBusInterface that must be freed with g_object_unref(). A #GDBusObject. + filename="gio/gdbusobject.c" + line="127">A #GDBusObject. A D-Bus interface name. + filename="gio/gdbusobject.c" + line="128">A D-Bus interface name. @@ -24644,14 +24702,13 @@ interfaces. invoker="get_interfaces" version="2.30"> Gets the D-Bus interfaces associated with @object. - + filename="gio/gdbusobject.c" + line="106">Gets the D-Bus interfaces associated with @object. + A list of #GDBusInterface instances. + filename="gio/gdbusobject.c" + line="112">A list of #GDBusInterface instances. The returned list must be freed by g_list_free() after each element has been freed with g_object_unref(). @@ -24661,8 +24718,8 @@ interfaces. A #GDBusObject. + filename="gio/gdbusobject.c" + line="108">A #GDBusObject. @@ -24671,28 +24728,29 @@ interfaces. invoker="get_object_path" version="2.30"> Gets the object path for @object. - + filename="gio/gdbusobject.c" + line="89">Gets the object path for @object. + A string owned by @object. Do not free. + filename="gio/gdbusobject.c" + line="95">A string owned by @object. Do not free. A #GDBusObject. + filename="gio/gdbusobject.c" + line="91">A #GDBusObject. - + Signal handler for the #GDBusObject::interface-added signal. + @@ -24706,8 +24764,10 @@ interfaces. - + Signal handler for the #GDBusObject::interface-removed signal. + @@ -24724,29 +24784,28 @@ interfaces. c:identifier="g_dbus_object_get_interface" version="2.30"> Gets the D-Bus interface with name @interface_name associated with + filename="gio/gdbusobject.c" + line="125">Gets the D-Bus interface with name @interface_name associated with @object, if any. - + %NULL if not found, otherwise a + filename="gio/gdbusobject.c" + line="133">%NULL if not found, otherwise a #GDBusInterface that must be freed with g_object_unref(). A #GDBusObject. + filename="gio/gdbusobject.c" + line="127">A #GDBusObject. A D-Bus interface name. + filename="gio/gdbusobject.c" + line="128">A D-Bus interface name. @@ -24755,14 +24814,13 @@ interfaces. c:identifier="g_dbus_object_get_interfaces" version="2.30"> Gets the D-Bus interfaces associated with @object. - + filename="gio/gdbusobject.c" + line="106">Gets the D-Bus interfaces associated with @object. + A list of #GDBusInterface instances. + filename="gio/gdbusobject.c" + line="112">A list of #GDBusInterface instances. The returned list must be freed by g_list_free() after each element has been freed with g_object_unref(). @@ -24772,8 +24830,8 @@ interfaces. A #GDBusObject. + filename="gio/gdbusobject.c" + line="108">A #GDBusObject. @@ -24782,53 +24840,52 @@ interfaces. c:identifier="g_dbus_object_get_object_path" version="2.30"> Gets the object path for @object. - + filename="gio/gdbusobject.c" + line="89">Gets the object path for @object. + A string owned by @object. Do not free. + filename="gio/gdbusobject.c" + line="95">A string owned by @object. Do not free. A #GDBusObject. + filename="gio/gdbusobject.c" + line="91">A #GDBusObject. Emitted when @interface is added to @object. + filename="gio/gdbusobject.c" + line="46">Emitted when @interface is added to @object. The #GDBusInterface that was added. + filename="gio/gdbusobject.c" + line="49">The #GDBusInterface that was added. Emitted when @interface is removed from @object. + filename="gio/gdbusobject.c" + line="66">Emitted when @interface is removed from @object. The #GDBusInterface that was removed. + filename="gio/gdbusobject.c" + line="69">The #GDBusInterface that was removed. @@ -24839,44 +24896,47 @@ interfaces. glib:is-gtype-struct-for="DBusObject" version="2.30"> Base object type for D-Bus objects. - + The parent interface. + Returns the object path. See g_dbus_object_get_object_path(). - + A string owned by @object. Do not free. + filename="gio/gdbusobject.c" + line="95">A string owned by @object. Do not free. A #GDBusObject. + filename="gio/gdbusobject.c" + line="91">A #GDBusObject. + Returns all interfaces. See g_dbus_object_get_interfaces(). - + A list of #GDBusInterface instances. + filename="gio/gdbusobject.c" + line="112">A list of #GDBusInterface instances. The returned list must be freed by g_list_free() after each element has been freed with g_object_unref(). @@ -24886,44 +24946,48 @@ interfaces. A #GDBusObject. + filename="gio/gdbusobject.c" + line="108">A #GDBusObject. + Returns an interface by name. See g_dbus_object_get_interface(). - + %NULL if not found, otherwise a + filename="gio/gdbusobject.c" + line="133">%NULL if not found, otherwise a #GDBusInterface that must be freed with g_object_unref(). A #GDBusObject. + filename="gio/gdbusobject.c" + line="127">A #GDBusObject. A D-Bus interface name. + filename="gio/gdbusobject.c" + line="128">A D-Bus interface name. + Signal handler for the #GDBusObject::interface-added signal. - + @@ -24938,9 +25002,11 @@ interfaces. + Signal handler for the #GDBusObject::interface-removed signal. - + @@ -24962,77 +25028,74 @@ interfaces. glib:get-type="g_dbus_object_manager_get_type" glib:type-struct="DBusObjectManagerIface"> The #GDBusObjectManager type is the base type for service- and + filename="gio/gdbusobjectmanager.c" + line="33">The `GDBusObjectManager` type is the base type for service- and client-side implementations of the standardized -[org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) +[`org.freedesktop.DBus.ObjectManager`](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) interface. -See #GDBusObjectManagerClient for the client-side implementation -and #GDBusObjectManagerServer for the service-side implementation. - +See [class@Gio.DBusObjectManagerClient] for the client-side implementation +and [class@Gio.DBusObjectManagerServer] for the service-side implementation. + Gets the interface proxy for @interface_name at @object_path, if + filename="gio/gdbusobjectmanager.c" + line="223">Gets the interface proxy for @interface_name at @object_path, if any. - + A #GDBusInterface instance or %NULL. Free + filename="gio/gdbusobjectmanager.c" + line="232">A #GDBusInterface instance or %NULL. Free with g_object_unref(). A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="225">A #GDBusObjectManager. Object path to look up. + filename="gio/gdbusobjectmanager.c" + line="226">Object path to look up. D-Bus interface name to look up. + filename="gio/gdbusobjectmanager.c" + line="227">D-Bus interface name to look up. Gets the #GDBusObject at @object_path, if any. - + filename="gio/gdbusobjectmanager.c" + line="202">Gets the #GDBusObject at @object_path, if any. + A #GDBusObject or %NULL. Free with + filename="gio/gdbusobjectmanager.c" + line="209">A #GDBusObject or %NULL. Free with g_object_unref(). A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="204">A #GDBusObjectManager. Object path to look up. + filename="gio/gdbusobjectmanager.c" + line="205">Object path to look up. @@ -25041,35 +25104,33 @@ any. invoker="get_object_path" version="2.30"> Gets the object path that @manager is for. - + filename="gio/gdbusobjectmanager.c" + line="165">Gets the object path that @manager is for. + A string owned by @manager. Do not free. + filename="gio/gdbusobjectmanager.c" + line="171">A string owned by @manager. Do not free. A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="167">A #GDBusObjectManager. Gets all #GDBusObject objects known to @manager. - + filename="gio/gdbusobjectmanager.c" + line="182">Gets all #GDBusObject objects known to @manager. + A list of + filename="gio/gdbusobjectmanager.c" + line="188">A list of #GDBusObject objects. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -25080,15 +25141,17 @@ any. A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="184">A #GDBusObjectManager. - + Signal handler for the #GDBusObjectManager::interface-added signal. + @@ -25105,8 +25168,10 @@ any. - + Signal handler for the #GDBusObjectManager::interface-removed signal. + @@ -25123,8 +25188,10 @@ any. - + Signal handler for the #GDBusObjectManager::object-added signal. + @@ -25138,8 +25205,10 @@ any. - + Signal handler for the #GDBusObjectManager::object-removed signal. + @@ -25156,35 +25225,34 @@ any. c:identifier="g_dbus_object_manager_get_interface" version="2.30"> Gets the interface proxy for @interface_name at @object_path, if + filename="gio/gdbusobjectmanager.c" + line="223">Gets the interface proxy for @interface_name at @object_path, if any. - + A #GDBusInterface instance or %NULL. Free + filename="gio/gdbusobjectmanager.c" + line="232">A #GDBusInterface instance or %NULL. Free with g_object_unref(). A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="225">A #GDBusObjectManager. Object path to look up. + filename="gio/gdbusobjectmanager.c" + line="226">Object path to look up. D-Bus interface name to look up. + filename="gio/gdbusobjectmanager.c" + line="227">D-Bus interface name to look up. @@ -25193,28 +25261,27 @@ any. c:identifier="g_dbus_object_manager_get_object" version="2.30"> Gets the #GDBusObject at @object_path, if any. - + filename="gio/gdbusobjectmanager.c" + line="202">Gets the #GDBusObject at @object_path, if any. + A #GDBusObject or %NULL. Free with + filename="gio/gdbusobjectmanager.c" + line="209">A #GDBusObject or %NULL. Free with g_object_unref(). A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="204">A #GDBusObjectManager. Object path to look up. + filename="gio/gdbusobjectmanager.c" + line="205">Object path to look up. @@ -25223,21 +25290,20 @@ any. c:identifier="g_dbus_object_manager_get_object_path" version="2.30"> Gets the object path that @manager is for. - + filename="gio/gdbusobjectmanager.c" + line="165">Gets the object path that @manager is for. + A string owned by @manager. Do not free. + filename="gio/gdbusobjectmanager.c" + line="171">A string owned by @manager. Do not free. A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="167">A #GDBusObjectManager. @@ -25246,14 +25312,13 @@ any. c:identifier="g_dbus_object_manager_get_objects" version="2.30"> Gets all #GDBusObject objects known to @manager. - + filename="gio/gdbusobjectmanager.c" + line="182">Gets all #GDBusObject objects known to @manager. + A list of + filename="gio/gdbusobjectmanager.c" + line="188">A list of #GDBusObject objects. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -25264,16 +25329,16 @@ any. A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="184">A #GDBusObjectManager. Emitted when @interface is added to @object. + filename="gio/gdbusobjectmanager.c" + line="103">Emitted when @interface is added to @object. This signal exists purely as a convenience to avoid having to connect signals to all objects managed by @manager. @@ -25283,22 +25348,22 @@ connect signals to all objects managed by @manager. The #GDBusObject on which an interface was added. + filename="gio/gdbusobjectmanager.c" + line="106">The #GDBusObject on which an interface was added. The #GDBusInterface that was added. + filename="gio/gdbusobjectmanager.c" + line="107">The #GDBusInterface that was added. Emitted when @interface has been removed from @object. + filename="gio/gdbusobjectmanager.c" + line="132">Emitted when @interface has been removed from @object. This signal exists purely as a convenience to avoid having to connect signals to all objects managed by @manager. @@ -25308,46 +25373,46 @@ connect signals to all objects managed by @manager. The #GDBusObject on which an interface was removed. + filename="gio/gdbusobjectmanager.c" + line="135">The #GDBusObject on which an interface was removed. The #GDBusInterface that was removed. + filename="gio/gdbusobjectmanager.c" + line="136">The #GDBusInterface that was removed. Emitted when @object is added to @manager. + filename="gio/gdbusobjectmanager.c" + line="61">Emitted when @object is added to @manager. The #GDBusObject that was added. + filename="gio/gdbusobjectmanager.c" + line="64">The #GDBusObject that was added. Emitted when @object is removed from @manager. + filename="gio/gdbusobjectmanager.c" + line="82">Emitted when @object is removed from @manager. The #GDBusObject that was removed. + filename="gio/gdbusobjectmanager.c" + line="85">The #GDBusObject that was removed. @@ -25362,84 +25427,86 @@ connect signals to all objects managed by @manager. glib:get-type="g_dbus_object_manager_client_get_type" glib:type-struct="DBusObjectManagerClientClass"> #GDBusObjectManagerClient is used to create, monitor and delete object -proxies for remote objects exported by a #GDBusObjectManagerServer (or any -code implementing the + filename="gio/gdbusobjectmanagerclient.c" + line="45">`GDBusObjectManagerClient` is used to create, monitor and delete object +proxies for remote objects exported by a [class@Gio.DBusObjectManagerServer] +(or any code implementing the [org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) interface). Once an instance of this type has been created, you can connect to -the #GDBusObjectManager::object-added and -#GDBusObjectManager::object-removed signals and inspect the -#GDBusObjectProxy objects returned by -g_dbus_object_manager_get_objects(). +the [signal@Gio.DBusObjectManager::object-added] and +[signal@Gio.DBusObjectManager::object-removed signals] and inspect the +[class@Gio.DBusObjectProxy] objects returned by +[method@Gio.DBusObjectManager.get_objects]. -If the name for a #GDBusObjectManagerClient is not owned by anyone at +If the name for a `GDBusObjectManagerClient` is not owned by anyone at object construction time, the default behavior is to request the message bus to launch an owner for the name. This behavior can be -disabled using the %G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_DO_NOT_AUTO_START -flag. It's also worth noting that this only works if the name of +disabled using the `G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_DO_NOT_AUTO_START` +flag. It’s also worth noting that this only works if the name of interest is activatable in the first place. E.g. in some cases it is not possible to launch an owner for the requested name. In this -case, #GDBusObjectManagerClient object construction still succeeds but +case, `GDBusObjectManagerClient` object construction still succeeds but there will be no object proxies -(e.g. g_dbus_object_manager_get_objects() returns the empty list) and -the #GDBusObjectManagerClient:name-owner property is %NULL. +(e.g. [method@Gio.DBusObjectManager.get_objects] returns the empty list) and +the [property@Gio.DBusObjectManagerClient:name-owner] property is `NULL`. The owner of the requested name can come and go (for example -consider a system service being restarted) – #GDBusObjectManagerClient -handles this case too; simply connect to the #GObject::notify -signal to watch for changes on the #GDBusObjectManagerClient:name-owner -property. When the name owner vanishes, the behavior is that -#GDBusObjectManagerClient:name-owner is set to %NULL (this includes -emission of the #GObject::notify signal) and then -#GDBusObjectManager::object-removed signals are synthesized +consider a system service being restarted) – `GDBusObjectManagerClient` +handles this case too; simply connect to the [signal@GObject.Object::notify] +signal to watch for changes on the +[property@Gio.DBusObjectManagerClient:name-owner] property. When the name +owner vanishes, the behavior is that +[property@Gio.DBusObjectManagerClient:name-owner] is set to `NULL` (this +includes emission of the [signal@GObject.Object::notify] signal) and then +[signal@Gio.DBusObjectManager::object-removed] signals are synthesized for all currently existing object proxies. Since -#GDBusObjectManagerClient:name-owner is %NULL when this happens, you can -use this information to disambiguate a synthesized signal from a -genuine signal caused by object removal on the remote -#GDBusObjectManager. Similarly, when a new name owner appears, -#GDBusObjectManager::object-added signals are synthesized -while #GDBusObjectManagerClient:name-owner is still %NULL. Only when all -object proxies have been added, the #GDBusObjectManagerClient:name-owner -is set to the new name owner (this includes emission of the -#GObject::notify signal). Furthermore, you are guaranteed that -#GDBusObjectManagerClient:name-owner will alternate between a name owner -(e.g. `:1.42`) and %NULL even in the case where +[property@Gio.DBusObjectManagerClient:name-owner] is `NULL` when this +happens, you can use this information to disambiguate a synthesized signal +from a genuine signal caused by object removal on the remote +[iface@Gio.DBusObjectManager]. Similarly, when a new name owner appears, +[signal@Gio.DBusObjectManager::object-added] signals are synthesized +while [property@Gio.DBusObjectManagerClient:name-owner] is still `NULL`. Only +when all object proxies have been added, the +[property@Gio.DBusObjectManagerClient:name-owner] is set to the new name +owner (this includes emission of the [signal@GObject.Object::notify] signal). +Furthermore, you are guaranteed that +[property@Gio.DBusObjectManagerClient:name-owner] will alternate between a +name owner (e.g. `:1.42`) and `NULL` even in the case where the name of interest is atomically replaced -Ultimately, #GDBusObjectManagerClient is used to obtain #GDBusProxy -instances. All signals (including the -org.freedesktop.DBus.Properties::PropertiesChanged signal) -delivered to #GDBusProxy instances are guaranteed to originate +Ultimately, `GDBusObjectManagerClient` is used to obtain +[class@Gio.DBusProxy] instances. All signals (including the +`org.freedesktop.DBus.Properties::PropertiesChanged` signal) +delivered to [class@Gio.DBusProxy] instances are guaranteed to originate from the name owner. This guarantee along with the behavior described above, means that certain race conditions including the -"half the proxy is from the old owner and the other half is from -the new owner" problem cannot happen. +“half the proxy is from the old owner and the other half is from +the new owner” problem cannot happen. To avoid having the application connect to signals on the returned -#GDBusObjectProxy and #GDBusProxy objects, the -#GDBusObject::interface-added, -#GDBusObject::interface-removed, -#GDBusProxy::g-properties-changed and -#GDBusProxy::g-signal signals -are also emitted on the #GDBusObjectManagerClient instance managing these +[class@Gio.DBusObjectProxy] and [class@Gio.DBusProxy] objects, the +[signal@Gio.DBusObject::interface-added], +[signal@Gio.DBusObject::interface-removed], +[signal@Gio.DBusProxy::g-properties-changed] and +[signal@Gio.DBusProxy::g-signal] signals +are also emitted on the `GDBusObjectManagerClient` instance managing these objects. The signals emitted are -#GDBusObjectManager::interface-added, -#GDBusObjectManager::interface-removed, -#GDBusObjectManagerClient::interface-proxy-properties-changed and -#GDBusObjectManagerClient::interface-proxy-signal. +[signal@Gio.DBusObjectManager::interface-added], +[signal@Gio.DBusObjectManager::interface-removed], +[signal@Gio.DBusObjectManagerClient::interface-proxy-properties-changed] and +[signal@Gio.DBusObjectManagerClient::interface-proxy-signal]. Note that all callbacks and signals are emitted in the -[thread-default main context][g-main-context-push-thread-default] -that the #GDBusObjectManagerClient object was constructed -in. Additionally, the #GDBusObjectProxy and #GDBusProxy objects -originating from the #GDBusObjectManagerClient object will be created in +thread-default main context (see +[method@GLib.MainContext.push_thread_default]) that the +`GDBusObjectManagerClient` object was constructed in. Additionally, the +[class@Gio.DBusObjectProxy] and [class@Gio.DBusProxy] objects +originating from the `GDBusObjectManagerClient` object will be created in the same context and, consequently, will deliver signals in the same main loop. - + @@ -25448,14 +25515,13 @@ same main loop. version="2.30" throws="1"> Finishes an operation started with g_dbus_object_manager_client_new(). - + filename="gio/gdbusobjectmanagerclient.c" + line="718">Finishes an operation started with g_dbus_object_manager_client_new(). + A + filename="gio/gdbusobjectmanagerclient.c" + line="725">A #GDBusObjectManagerClient object or %NULL if @error is set. Free with g_object_unref(). @@ -25463,8 +25529,8 @@ same main loop. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new(). + filename="gio/gdbusobjectmanagerclient.c" + line="720">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new(). @@ -25474,14 +25540,13 @@ same main loop. version="2.30" throws="1"> Finishes an operation started with g_dbus_object_manager_client_new_for_bus(). - + filename="gio/gdbusobjectmanagerclient.c" + line="870">Finishes an operation started with g_dbus_object_manager_client_new_for_bus(). + A + filename="gio/gdbusobjectmanagerclient.c" + line="877">A #GDBusObjectManagerClient object or %NULL if @error is set. Free with g_object_unref(). @@ -25489,8 +25554,8 @@ same main loop. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new_for_bus(). + filename="gio/gdbusobjectmanagerclient.c" + line="872">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_object_manager_client_new_for_bus(). @@ -25500,19 +25565,18 @@ same main loop. version="2.30" throws="1"> Like g_dbus_object_manager_client_new_sync() but takes a #GBusType instead + filename="gio/gdbusobjectmanagerclient.c" + line="754">Like g_dbus_object_manager_client_new_sync() but takes a #GBusType instead of a #GDBusConnection. This is a synchronous failable constructor - the calling thread is blocked until a reply is received. See g_dbus_object_manager_client_new_for_bus() for the asynchronous version. - + A + filename="gio/gdbusobjectmanagerclient.c" + line="773">A #GDBusObjectManagerClient object or %NULL if @error is set. Free with g_object_unref(). @@ -25520,27 +25584,27 @@ for the asynchronous version. A #GBusType. + filename="gio/gdbusobjectmanagerclient.c" + line="756">A #GBusType. Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. + filename="gio/gdbusobjectmanagerclient.c" + line="757">Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. The owner of the control object (unique or well-known name). + filename="gio/gdbusobjectmanagerclient.c" + line="758">The owner of the control object (unique or well-known name). The object path of the control object. + filename="gio/gdbusobjectmanagerclient.c" + line="759">The object path of the control object. closure="5" destroy="6"> A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. + filename="gio/gdbusobjectmanagerclient.c" + line="760">A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. nullable="1" allow-none="1"> User data to pass to @get_proxy_type_func. + filename="gio/gdbusobjectmanagerclient.c" + line="761">User data to pass to @get_proxy_type_func. allow-none="1" scope="async"> Free function for @get_proxy_type_user_data or %NULL. + filename="gio/gdbusobjectmanagerclient.c" + line="762">Free function for @get_proxy_type_user_data or %NULL. nullable="1" allow-none="1"> A #GCancellable or %NULL + filename="gio/gdbusobjectmanagerclient.c" + line="763">A #GCancellable or %NULL @@ -25590,18 +25654,17 @@ for the asynchronous version. version="2.30" throws="1"> Creates a new #GDBusObjectManagerClient object. + filename="gio/gdbusobjectmanagerclient.c" + line="602">Creates a new #GDBusObjectManagerClient object. This is a synchronous failable constructor - the calling thread is blocked until a reply is received. See g_dbus_object_manager_client_new() for the asynchronous version. - + A + filename="gio/gdbusobjectmanagerclient.c" + line="620">A #GDBusObjectManagerClient object or %NULL if @error is set. Free with g_object_unref(). @@ -25609,14 +25672,14 @@ for the asynchronous version. A #GDBusConnection. + filename="gio/gdbusobjectmanagerclient.c" + line="604">A #GDBusConnection. Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. + filename="gio/gdbusobjectmanagerclient.c" + line="605">Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. @@ -25625,14 +25688,14 @@ for the asynchronous version. nullable="1" allow-none="1"> The owner of the control object (unique or well-known name), or %NULL when not using a message bus connection. + filename="gio/gdbusobjectmanagerclient.c" + line="606">The owner of the control object (unique or well-known name), or %NULL when not using a message bus connection. The object path of the control object. + filename="gio/gdbusobjectmanagerclient.c" + line="607">The object path of the control object. closure="5" destroy="6"> A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. + filename="gio/gdbusobjectmanagerclient.c" + line="608">A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. nullable="1" allow-none="1"> User data to pass to @get_proxy_type_func. + filename="gio/gdbusobjectmanagerclient.c" + line="609">User data to pass to @get_proxy_type_func. allow-none="1" scope="async"> Free function for @get_proxy_type_user_data or %NULL. + filename="gio/gdbusobjectmanagerclient.c" + line="610">Free function for @get_proxy_type_user_data or %NULL. nullable="1" allow-none="1"> A #GCancellable or %NULL + filename="gio/gdbusobjectmanagerclient.c" + line="611">A #GCancellable or %NULL + version="2.30" + glib:finish-func="new_finish"> Asynchronously creates a new #GDBusObjectManagerClient object. + filename="gio/gdbusobjectmanagerclient.c" + line="662">Asynchronously creates a new #GDBusObjectManagerClient object. This is an asynchronous failable constructor. When the result is ready, @callback will be invoked in the @@ -25690,35 +25754,34 @@ ready, @callback will be invoked in the of the thread you are calling this method from. You can then call g_dbus_object_manager_client_new_finish() to get the result. See g_dbus_object_manager_client_new_sync() for the synchronous version. - + A #GDBusConnection. + filename="gio/gdbusobjectmanagerclient.c" + line="664">A #GDBusConnection. Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. + filename="gio/gdbusobjectmanagerclient.c" + line="665">Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. The owner of the control object (unique or well-known name). + filename="gio/gdbusobjectmanagerclient.c" + line="666">The owner of the control object (unique or well-known name). The object path of the control object. + filename="gio/gdbusobjectmanagerclient.c" + line="667">The object path of the control object. closure="5" destroy="6"> A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. + filename="gio/gdbusobjectmanagerclient.c" + line="668">A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. nullable="1" allow-none="1"> User data to pass to @get_proxy_type_func. + filename="gio/gdbusobjectmanagerclient.c" + line="669">User data to pass to @get_proxy_type_func. allow-none="1" scope="async"> Free function for @get_proxy_type_user_data or %NULL. + filename="gio/gdbusobjectmanagerclient.c" + line="670">Free function for @get_proxy_type_user_data or %NULL. nullable="1" allow-none="1"> A #GCancellable or %NULL + filename="gio/gdbusobjectmanagerclient.c" + line="671">A #GCancellable or %NULL scope="async" closure="9"> A #GAsyncReadyCallback to call when the request is satisfied. + filename="gio/gdbusobjectmanagerclient.c" + line="672">A #GAsyncReadyCallback to call when the request is satisfied. nullable="1" allow-none="1"> The data to pass to @callback. + filename="gio/gdbusobjectmanagerclient.c" + line="673">The data to pass to @callback. + version="2.30" + glib:finish-func="new_for_bus_finish"> Like g_dbus_object_manager_client_new() but takes a #GBusType instead of a + filename="gio/gdbusobjectmanagerclient.c" + line="814">Like g_dbus_object_manager_client_new() but takes a #GBusType instead of a #GDBusConnection. This is an asynchronous failable constructor. When the result is @@ -25797,35 +25861,34 @@ ready, @callback will be invoked in the of the thread you are calling this method from. You can then call g_dbus_object_manager_client_new_for_bus_finish() to get the result. See g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. - + A #GBusType. + filename="gio/gdbusobjectmanagerclient.c" + line="816">A #GBusType. Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. + filename="gio/gdbusobjectmanagerclient.c" + line="817">Zero or more flags from the #GDBusObjectManagerClientFlags enumeration. The owner of the control object (unique or well-known name). + filename="gio/gdbusobjectmanagerclient.c" + line="818">The owner of the control object (unique or well-known name). The object path of the control object. + filename="gio/gdbusobjectmanagerclient.c" + line="819">The object path of the control object. A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. + filename="gio/gdbusobjectmanagerclient.c" + line="820">A #GDBusProxyTypeFunc function or %NULL to always construct #GDBusProxy proxies. User data to pass to @get_proxy_type_func. + filename="gio/gdbusobjectmanagerclient.c" + line="821">User data to pass to @get_proxy_type_func. Free function for @get_proxy_type_user_data or %NULL. + filename="gio/gdbusobjectmanagerclient.c" + line="822">Free function for @get_proxy_type_user_data or %NULL. A #GCancellable or %NULL + filename="gio/gdbusobjectmanagerclient.c" + line="823">A #GCancellable or %NULL A #GAsyncReadyCallback to call when the request is satisfied. + filename="gio/gdbusobjectmanagerclient.c" + line="824">A #GAsyncReadyCallback to call when the request is satisfied. The data to pass to @callback. + filename="gio/gdbusobjectmanagerclient.c" + line="825">The data to pass to @callback. - + Signal class handler for the #GDBusObjectManagerClient::interface-proxy-properties-changed signal. + @@ -25916,8 +25981,10 @@ g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. - + Signal class handler for the #GDBusObjectManagerClient::interface-proxy-signal signal. + @@ -25948,22 +26015,21 @@ g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. Gets the #GDBusConnection used by @manager. - + filename="gio/gdbusobjectmanagerclient.c" + line="906">Gets the #GDBusConnection used by @manager. + A #GDBusConnection object. Do not free, + filename="gio/gdbusobjectmanagerclient.c" + line="912">A #GDBusConnection object. Do not free, the object belongs to @manager. A #GDBusObjectManagerClient + filename="gio/gdbusobjectmanagerclient.c" + line="908">A #GDBusObjectManagerClient @@ -25974,14 +26040,13 @@ g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version. Gets the flags that @manager was constructed with. - + filename="gio/gdbusobjectmanagerclient.c" + line="951">Gets the flags that @manager was constructed with. + Zero of more flags from the #GDBusObjectManagerClientFlags + filename="gio/gdbusobjectmanagerclient.c" + line="957">Zero of more flags from the #GDBusObjectManagerClientFlags enumeration. @@ -25989,8 +26054,8 @@ enumeration. A #GDBusObjectManagerClient + filename="gio/gdbusobjectmanagerclient.c" + line="953">A #GDBusObjectManagerClient @@ -26001,23 +26066,22 @@ enumeration. glib:get-property="name" version="2.30"> Gets the name that @manager is for, or %NULL if not a message bus + filename="gio/gdbusobjectmanagerclient.c" + line="928">Gets the name that @manager is for, or %NULL if not a message bus connection. - + A unique or well-known name. Do not free, the string + filename="gio/gdbusobjectmanagerclient.c" + line="935">A unique or well-known name. Do not free, the string belongs to @manager. A #GDBusObjectManagerClient + filename="gio/gdbusobjectmanagerclient.c" + line="930">A #GDBusObjectManagerClient @@ -26028,25 +26092,24 @@ belongs to @manager. glib:get-property="name-owner" version="2.30"> The unique name that owns the name that @manager is for or %NULL if + filename="gio/gdbusobjectmanagerclient.c" + line="973">The unique name that owns the name that @manager is for or %NULL if no-one currently owns that name. You can connect to the #GObject::notify signal to track changes to the #GDBusObjectManagerClient:name-owner property. - + The name owner or %NULL if no name owner + filename="gio/gdbusobjectmanagerclient.c" + line="982">The name owner or %NULL if no name owner exists. Free with g_free(). A #GDBusObjectManagerClient. + filename="gio/gdbusobjectmanagerclient.c" + line="975">A #GDBusObjectManagerClient. @@ -26060,8 +26123,8 @@ exists. Free with g_free(). transfer-ownership="none" default-value="G_BUS_TYPE_NONE"> If this property is not %G_BUS_TYPE_NONE, then + filename="gio/gdbusobjectmanagerclient.c" + line="373">If this property is not %G_BUS_TYPE_NONE, then #GDBusObjectManagerClient:connection must be %NULL and will be set to the #GDBusConnection obtained by calling g_bus_get() with the value of this property. @@ -26074,8 +26137,8 @@ of this property. transfer-ownership="none" getter="get_connection"> The #GDBusConnection to use. + filename="gio/gdbusobjectmanagerclient.c" + line="357">The #GDBusConnection to use. getter="get_flags" default-value="G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_NONE"> Flags from the #GDBusObjectManagerClientFlags enumeration. + filename="gio/gdbusobjectmanagerclient.c" + line="394">Flags from the #GDBusObjectManagerClientFlags enumeration. construct-only="1" transfer-ownership="none"> A #GDestroyNotify for the #gpointer user_data in #GDBusObjectManagerClient:get-proxy-type-user-data. + filename="gio/gdbusobjectmanagerclient.c" + line="492">A #GDestroyNotify for the #gpointer user_data in #GDBusObjectManagerClient:get-proxy-type-user-data. construct-only="1" transfer-ownership="none"> The #GDBusProxyTypeFunc to use when determining what #GType to + filename="gio/gdbusobjectmanagerclient.c" + line="461">The #GDBusProxyTypeFunc to use when determining what #GType to use for interface proxies or %NULL. @@ -26117,8 +26180,8 @@ use for interface proxies or %NULL. construct-only="1" transfer-ownership="none"> The #gpointer user_data to pass to #GDBusObjectManagerClient:get-proxy-type-func. + filename="gio/gdbusobjectmanagerclient.c" + line="477">The #gpointer user_data to pass to #GDBusObjectManagerClient:get-proxy-type-func. getter="get_name" default-value="NULL"> The well-known name or unique name that the manager is for. + filename="gio/gdbusobjectmanagerclient.c" + line="429">The well-known name or unique name that the manager is for. getter="get_name_owner" default-value="NULL"> The unique name that owns #GDBusObjectManagerClient:name or %NULL if + filename="gio/gdbusobjectmanagerclient.c" + line="445">The unique name that owns #GDBusObjectManagerClient:name or %NULL if no-one is currently owning the name. Connect to the #GObject::notify signal to track changes to this property. @@ -26152,8 +26215,8 @@ no-one is currently owning the name. Connect to the transfer-ownership="none" default-value="NULL"> The object path the manager is for. + filename="gio/gdbusobjectmanagerclient.c" + line="413">The object path the manager is for. @@ -26167,8 +26230,8 @@ no-one is currently owning the name. Connect to the when="last" version="2.30"> Emitted when one or more D-Bus properties on proxy changes. The + filename="gio/gdbusobjectmanagerclient.c" + line="546">Emitted when one or more D-Bus properties on proxy changes. The local cache has already been updated when this signal fires. Note that both @changed_properties and @invalidated_properties are guaranteed to never be %NULL (either may be empty though). @@ -26185,26 +26248,26 @@ that @manager was constructed in. The #GDBusObjectProxy on which an interface has properties that are changing. + filename="gio/gdbusobjectmanagerclient.c" + line="549">The #GDBusObjectProxy on which an interface has properties that are changing. The #GDBusProxy that has properties that are changing. + filename="gio/gdbusobjectmanagerclient.c" + line="550">The #GDBusProxy that has properties that are changing. A #GVariant containing the properties that changed (type: `a{sv}`). + filename="gio/gdbusobjectmanagerclient.c" + line="551">A #GVariant containing the properties that changed (type: `a{sv}`). A %NULL terminated + filename="gio/gdbusobjectmanagerclient.c" + line="552">A %NULL terminated array of properties that were invalidated. @@ -26214,8 +26277,8 @@ that @manager was constructed in. Emitted when a D-Bus signal is received on @interface_proxy. + filename="gio/gdbusobjectmanagerclient.c" + line="507">Emitted when a D-Bus signal is received on @interface_proxy. This signal exists purely as a convenience to avoid having to connect signals to all interface proxies managed by @manager. @@ -26229,32 +26292,32 @@ that @manager was constructed in. The #GDBusObjectProxy on which an interface is emitting a D-Bus signal. + filename="gio/gdbusobjectmanagerclient.c" + line="510">The #GDBusObjectProxy on which an interface is emitting a D-Bus signal. The #GDBusProxy that is emitting a D-Bus signal. + filename="gio/gdbusobjectmanagerclient.c" + line="511">The #GDBusProxy that is emitting a D-Bus signal. The sender of the signal or NULL if the connection is not a bus connection. + filename="gio/gdbusobjectmanagerclient.c" + line="512">The sender of the signal or NULL if the connection is not a bus connection. The signal name. + filename="gio/gdbusobjectmanagerclient.c" + line="513">The signal name. A #GVariant tuple with parameters for the signal. + filename="gio/gdbusobjectmanagerclient.c" + line="514">A #GVariant tuple with parameters for the signal. @@ -26265,20 +26328,22 @@ that @manager was constructed in. glib:is-gtype-struct-for="DBusObjectManagerClient" version="2.30"> Class structure for #GDBusObjectManagerClient. - + filename="gio/gdbusobjectmanagerclient.h" + line="47">Class structure for #GDBusObjectManagerClient. + The parent class. + filename="gio/gdbusobjectmanagerclient.h" + line="49">The parent class. + Signal class handler for the #GDBusObjectManagerClient::interface-proxy-signal signal. - + @@ -26306,9 +26371,12 @@ that @manager was constructed in. + Signal class handler for the #GDBusObjectManagerClient::interface-proxy-properties-changed signal. - + @@ -26344,16 +26412,16 @@ that @manager was constructed in. glib:get-type="g_dbus_object_manager_client_flags_get_type" c:type="GDBusObjectManagerClientFlags"> Flags used when constructing a #GDBusObjectManagerClient. + filename="gio/gioenums.h" + line="1811">Flags used when constructing a #GDBusObjectManagerClient. No flags set. + filename="gio/gioenums.h" + line="1813">No flags set. glib:nick="do-not-auto-start" glib:name="G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_DO_NOT_AUTO_START"> If not set and the + filename="gio/gioenums.h" + line="1814">If not set and the manager is for a well-known name, then request the bus to launch an owner for the name if no-one owns the name. This flag can only be used in managers for well-known names. @@ -26372,52 +26440,54 @@ that @manager was constructed in. c:type="GDBusObjectManagerClientPrivate" disguised="1" opaque="1"> - + Base type for D-Bus object managers. - + The parent interface. + Virtual function for g_dbus_object_manager_get_object_path(). - + A string owned by @manager. Do not free. + filename="gio/gdbusobjectmanager.c" + line="171">A string owned by @manager. Do not free. A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="167">A #GDBusObjectManager. + Virtual function for g_dbus_object_manager_get_objects(). - + A list of + filename="gio/gdbusobjectmanager.c" + line="188">A list of #GDBusObject objects. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref(). @@ -26428,77 +26498,83 @@ that @manager was constructed in. A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="184">A #GDBusObjectManager. + Virtual function for g_dbus_object_manager_get_object(). - + A #GDBusObject or %NULL. Free with + filename="gio/gdbusobjectmanager.c" + line="209">A #GDBusObject or %NULL. Free with g_object_unref(). A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="204">A #GDBusObjectManager. Object path to look up. + filename="gio/gdbusobjectmanager.c" + line="205">Object path to look up. + Virtual function for g_dbus_object_manager_get_interface(). - + A #GDBusInterface instance or %NULL. Free + filename="gio/gdbusobjectmanager.c" + line="232">A #GDBusInterface instance or %NULL. Free with g_object_unref(). A #GDBusObjectManager. + filename="gio/gdbusobjectmanager.c" + line="225">A #GDBusObjectManager. Object path to look up. + filename="gio/gdbusobjectmanager.c" + line="226">Object path to look up. D-Bus interface name to look up. + filename="gio/gdbusobjectmanager.c" + line="227">D-Bus interface name to look up. + Signal handler for the #GDBusObjectManager::object-added signal. - + @@ -26513,9 +26589,11 @@ that @manager was constructed in. + Signal handler for the #GDBusObjectManager::object-removed signal. - + @@ -26530,9 +26608,11 @@ that @manager was constructed in. + Signal handler for the #GDBusObjectManager::interface-added signal. - + @@ -26550,9 +26630,11 @@ that @manager was constructed in. + Signal handler for the #GDBusObjectManager::interface-removed signal. - + @@ -26579,10 +26661,10 @@ that @manager was constructed in. glib:get-type="g_dbus_object_manager_server_get_type" glib:type-struct="DBusObjectManagerServerClass"> #GDBusObjectManagerServer is used to export #GDBusObject instances using -the standardized -[org.freedesktop.DBus.ObjectManager](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) + filename="gio/gdbusobjectmanagerserver.c" + line="39">`GDBusObjectManagerServer` is used to export [iface@Gio.DBusObject] instances +using the standardized +[`org.freedesktop.DBus.ObjectManager`](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) interface. For example, remote D-Bus clients can get all objects and properties in a single call. Additionally, any change in the object hierarchy is broadcast using signals. This means that D-Bus @@ -26598,39 +26680,36 @@ below (to allow for multiple object managers in a service). It is supported, but not recommended, to export an object manager at the root path, `/`. -See #GDBusObjectManagerClient for the client-side code that is -intended to be used with #GDBusObjectManagerServer or any D-Bus -object implementing the org.freedesktop.DBus.ObjectManager -interface. - +See [class@Gio.DBusObjectManagerClient] for the client-side code that is +intended to be used with `GDBusObjectManagerServer` or any D-Bus +object implementing the `org.freedesktop.DBus.ObjectManager` interface. + Creates a new #GDBusObjectManagerServer object. + filename="gio/gdbusobjectmanagerserver.c" + line="246">Creates a new #GDBusObjectManagerServer object. The returned server isn't yet exported on any connection. To do so, use g_dbus_object_manager_server_set_connection(). Normally you want to export all of your objects before doing so to avoid [InterfacesAdded](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) signals being emitted. - + A #GDBusObjectManagerServer object. Free with g_object_unref(). + filename="gio/gdbusobjectmanagerserver.c" + line="258">A #GDBusObjectManagerServer object. Free with g_object_unref(). The object path to export the manager object at. + filename="gio/gdbusobjectmanagerserver.c" + line="248">The object path to export the manager object at. @@ -26639,8 +26718,8 @@ signals being emitted. c:identifier="g_dbus_object_manager_server_export" version="2.30"> Exports @object on @manager. + filename="gio/gdbusobjectmanagerserver.c" + line="548">Exports @object on @manager. If there is already a #GDBusObject exported at the object path, then the old object is removed. @@ -26650,23 +26729,22 @@ object path for @manager. Note that @manager will take a reference on @object for as long as it is exported. - + A #GDBusObjectManagerServer. + filename="gio/gdbusobjectmanagerserver.c" + line="550">A #GDBusObjectManagerServer. A #GDBusObjectSkeleton. + filename="gio/gdbusobjectmanagerserver.c" + line="551">A #GDBusObjectSkeleton. @@ -26675,28 +26753,27 @@ it is exported. c:identifier="g_dbus_object_manager_server_export_uniquely" version="2.30"> Like g_dbus_object_manager_server_export() but appends a string of + filename="gio/gdbusobjectmanagerserver.c" + line="577">Like g_dbus_object_manager_server_export() but appends a string of the form _N (with N being a natural number) to @object's object path if an object with the given path already exists. As such, the #GDBusObjectProxy:g-object-path property of @object may be modified. - + A #GDBusObjectManagerServer. + filename="gio/gdbusobjectmanagerserver.c" + line="579">A #GDBusObjectManagerServer. An object. + filename="gio/gdbusobjectmanagerserver.c" + line="580">An object. @@ -26706,14 +26783,13 @@ if an object with the given path already exists. As such, the glib:get-property="connection" version="2.30"> Gets the #GDBusConnection used by @manager. - + filename="gio/gdbusobjectmanagerserver.c" + line="312">Gets the #GDBusConnection used by @manager. + A #GDBusConnection object or %NULL if + filename="gio/gdbusobjectmanagerserver.c" + line="318">A #GDBusConnection object or %NULL if @manager isn't exported on a connection. The returned object should be freed with g_object_unref(). @@ -26721,8 +26797,8 @@ if an object with the given path already exists. As such, the A #GDBusObjectManagerServer + filename="gio/gdbusobjectmanagerserver.c" + line="314">A #GDBusObjectManagerServer @@ -26732,28 +26808,27 @@ if an object with the given path already exists. As such, the c:identifier="g_dbus_object_manager_server_is_exported" version="2.34"> Returns whether @object is currently exported on @manager. - + filename="gio/gdbusobjectmanagerserver.c" + line="633">Returns whether @object is currently exported on @manager. + %TRUE if @object is exported + filename="gio/gdbusobjectmanagerserver.c" + line="640">%TRUE if @object is exported A #GDBusObjectManagerServer. + filename="gio/gdbusobjectmanagerserver.c" + line="635">A #GDBusObjectManagerServer. An object. + filename="gio/gdbusobjectmanagerserver.c" + line="636">An object. @@ -26762,19 +26837,18 @@ if an object with the given path already exists. As such, the c:identifier="g_dbus_object_manager_server_set_connection" glib:set-property="connection"> Exports all objects managed by @manager on @connection. If + filename="gio/gdbusobjectmanagerserver.c" + line="271">Exports all objects managed by @manager on @connection. If @connection is %NULL, stops exporting objects. - + A #GDBusObjectManagerServer. + filename="gio/gdbusobjectmanagerserver.c" + line="273">A #GDBusObjectManagerServer. @@ -26783,8 +26857,8 @@ if an object with the given path already exists. As such, the nullable="1" allow-none="1"> A #GDBusConnection or %NULL. + filename="gio/gdbusobjectmanagerserver.c" + line="274">A #GDBusConnection or %NULL. @@ -26793,32 +26867,31 @@ if an object with the given path already exists. As such, the c:identifier="g_dbus_object_manager_server_unexport" version="2.30"> If @manager has an object at @path, removes the object. Otherwise + filename="gio/gdbusobjectmanagerserver.c" + line="705">If @manager has an object at @path, removes the object. Otherwise does nothing. Note that @object_path must be in the hierarchy rooted by the object path for @manager. - + %TRUE if object at @object_path was removed, %FALSE otherwise. + filename="gio/gdbusobjectmanagerserver.c" + line="716">%TRUE if object at @object_path was removed, %FALSE otherwise. A #GDBusObjectManagerServer. + filename="gio/gdbusobjectmanagerserver.c" + line="707">A #GDBusObjectManagerServer. An object path. + filename="gio/gdbusobjectmanagerserver.c" + line="708">An object path. @@ -26830,8 +26903,8 @@ object path for @manager. setter="set_connection" getter="get_connection"> The #GDBusConnection to export objects on. + filename="gio/gdbusobjectmanagerserver.c" + line="203">The #GDBusConnection to export objects on. transfer-ownership="none" default-value="NULL"> The object path to register the manager object at. + filename="gio/gdbusobjectmanagerserver.c" + line="218">The object path to register the manager object at. @@ -26858,14 +26931,13 @@ object path for @manager. glib:is-gtype-struct-for="DBusObjectManagerServer" version="2.30"> Class structure for #GDBusObjectManagerServer. - + filename="gio/gdbusobjectmanagerserver.h" + line="47">Class structure for #GDBusObjectManagerServer. + The parent class. + filename="gio/gdbusobjectmanagerserver.h" + line="49">The parent class. @@ -26878,8 +26950,7 @@ object path for @manager. c:type="GDBusObjectManagerServerPrivate" disguised="1" opaque="1"> - + glib:get-type="g_dbus_object_proxy_get_type" glib:type-struct="DBusObjectProxyClass"> A #GDBusObjectProxy is an object used to represent a remote object -with one or more D-Bus interfaces. Normally, you don't instantiate -a #GDBusObjectProxy yourself - typically #GDBusObjectManagerClient + filename="gio/gdbusobjectproxy.c" + line="34">A `GDBusObjectProxy` is an object used to represent a remote object +with one or more D-Bus interfaces. Normally, you don’t instantiate +a `GDBusObjectProxy` yourself — typically [class@Gio.DBusObjectManagerClient] is used to obtain it. - + Creates a new #GDBusObjectProxy for the given connection and + filename="gio/gdbusobjectproxy.c" + line="260">Creates a new #GDBusObjectProxy for the given connection and object path. - + a new #GDBusObjectProxy + filename="gio/gdbusobjectproxy.c" + line="268">a new #GDBusObjectProxy a #GDBusConnection + filename="gio/gdbusobjectproxy.c" + line="262">a #GDBusConnection the object path + filename="gio/gdbusobjectproxy.c" + line="263">the object path @@ -26932,22 +27001,21 @@ object path. c:identifier="g_dbus_object_proxy_get_connection" version="2.30"> Gets the connection that @proxy is for. - + filename="gio/gdbusobjectproxy.c" + line="199">Gets the connection that @proxy is for. + A #GDBusConnection. Do not free, the + filename="gio/gdbusobjectproxy.c" + line="205">A #GDBusConnection. Do not free, the object is owned by @proxy. a #GDBusObjectProxy + filename="gio/gdbusobjectproxy.c" + line="201">a #GDBusObjectProxy @@ -26958,8 +27026,8 @@ object path. construct-only="1" transfer-ownership="none"> The connection of the proxy. + filename="gio/gdbusobjectproxy.c" + line="161">The connection of the proxy. transfer-ownership="none" default-value="NULL"> The object path of the proxy. + filename="gio/gdbusobjectproxy.c" + line="146">The object path of the proxy. @@ -26985,14 +27053,13 @@ object path. glib:is-gtype-struct-for="DBusObjectProxy" version="2.30"> Class structure for #GDBusObjectProxy. - + filename="gio/gdbusobjectproxy.h" + line="47">Class structure for #GDBusObjectProxy. + The parent class. + filename="gio/gdbusobjectproxy.h" + line="49">The parent class. @@ -27005,8 +27072,7 @@ object path. c:type="GDBusObjectProxyPrivate" disguised="1" opaque="1"> - + glib:get-type="g_dbus_object_skeleton_get_type" glib:type-struct="DBusObjectSkeletonClass"> A #GDBusObjectSkeleton instance is essentially a group of D-Bus + filename="gio/gdbusobjectskeleton.c" + line="36">A `GDBusObjectSkeleton` instance is essentially a group of D-Bus interfaces. The set of exported interfaces on the object may be dynamic and change at runtime. -This type is intended to be used with #GDBusObjectManager. - +This type is intended to be used with [iface@Gio.DBusObjectManager]. + Creates a new #GDBusObjectSkeleton. - + filename="gio/gdbusobjectskeleton.c" + line="211">Creates a new #GDBusObjectSkeleton. + A #GDBusObjectSkeleton. Free with g_object_unref(). + filename="gio/gdbusobjectskeleton.c" + line="217">A #GDBusObjectSkeleton. Free with g_object_unref(). An object path. + filename="gio/gdbusobjectskeleton.c" + line="213">An object path. - + Signal class handler for the #GDBusObjectSkeleton::authorize-method signal. + @@ -27072,30 +27138,29 @@ This type is intended to be used with #GDBusObjectManager. c:identifier="g_dbus_object_skeleton_add_interface" version="2.30"> Adds @interface_ to @object. + filename="gio/gdbusobjectskeleton.c" + line="271">Adds @interface_ to @object. If @object already contains a #GDBusInterfaceSkeleton with the same interface name, it is removed before @interface_ is added. Note that @object takes its own reference on @interface_ and holds it until removed. - + A #GDBusObjectSkeleton. + filename="gio/gdbusobjectskeleton.c" + line="273">A #GDBusObjectSkeleton. A #GDBusInterfaceSkeleton. + filename="gio/gdbusobjectskeleton.c" + line="274">A #GDBusInterfaceSkeleton. @@ -27105,20 +27170,19 @@ it until removed. c:identifier="g_dbus_object_skeleton_flush" version="2.30"> This method simply calls g_dbus_interface_skeleton_flush() on all + filename="gio/gdbusobjectskeleton.c" + line="461">This method simply calls g_dbus_interface_skeleton_flush() on all interfaces belonging to @object. See that method for when flushing is useful. - + A #GDBusObjectSkeleton. + filename="gio/gdbusobjectskeleton.c" + line="463">A #GDBusObjectSkeleton. @@ -27127,24 +27191,23 @@ is useful. c:identifier="g_dbus_object_skeleton_remove_interface" version="2.30"> Removes @interface_ from @object. - + filename="gio/gdbusobjectskeleton.c" + line="329">Removes @interface_ from @object. + A #GDBusObjectSkeleton. + filename="gio/gdbusobjectskeleton.c" + line="331">A #GDBusObjectSkeleton. A #GDBusInterfaceSkeleton. + filename="gio/gdbusobjectskeleton.c" + line="332">A #GDBusInterfaceSkeleton. @@ -27154,27 +27217,26 @@ is useful. c:identifier="g_dbus_object_skeleton_remove_interface_by_name" version="2.30"> Removes the #GDBusInterface with @interface_name from @object. + filename="gio/gdbusobjectskeleton.c" + line="385">Removes the #GDBusInterface with @interface_name from @object. If no D-Bus interface of the given interface exists, this function does nothing. - + A #GDBusObjectSkeleton. + filename="gio/gdbusobjectskeleton.c" + line="387">A #GDBusObjectSkeleton. A D-Bus interface name. + filename="gio/gdbusobjectskeleton.c" + line="388">A D-Bus interface name. @@ -27183,24 +27245,23 @@ does nothing. c:identifier="g_dbus_object_skeleton_set_object_path" version="2.30"> Sets the object path for @object. - + filename="gio/gdbusobjectskeleton.c" + line="230">Sets the object path for @object. + A #GDBusObjectSkeleton. + filename="gio/gdbusobjectskeleton.c" + line="232">A #GDBusObjectSkeleton. A valid D-Bus object path. + filename="gio/gdbusobjectskeleton.c" + line="233">A valid D-Bus object path. @@ -27212,8 +27273,8 @@ does nothing. transfer-ownership="none" default-value="NULL"> The object path where the object is exported. + filename="gio/gdbusobjectskeleton.c" + line="151">The object path where the object is exported. @@ -27225,8 +27286,8 @@ does nothing. Emitted when a method is invoked by a remote caller and used to + filename="gio/gdbusobjectskeleton.c" + line="167">Emitted when a method is invoked by a remote caller and used to determine if the method call is authorized. This signal is like #GDBusInterfaceSkeleton's @@ -27236,21 +27297,21 @@ except that it is for the enclosing object. The default class handler just returns %TRUE. %TRUE if the call is authorized, %FALSE otherwise. + filename="gio/gdbusobjectskeleton.c" + line="182">%TRUE if the call is authorized, %FALSE otherwise. The #GDBusInterfaceSkeleton that @invocation is for. + filename="gio/gdbusobjectskeleton.c" + line="170">The #GDBusInterfaceSkeleton that @invocation is for. A #GDBusMethodInvocation. + filename="gio/gdbusobjectskeleton.c" + line="171">A #GDBusMethodInvocation. @@ -27261,20 +27322,21 @@ The default class handler just returns %TRUE. glib:is-gtype-struct-for="DBusObjectSkeleton" version="2.30"> Class structure for #GDBusObjectSkeleton. - + filename="gio/gdbusobjectskeleton.h" + line="47">Class structure for #GDBusObjectSkeleton. + The parent class. + filename="gio/gdbusobjectskeleton.h" + line="49">The parent class. + Signal class handler for the #GDBusObjectSkeleton::authorize-method signal. - + @@ -27303,8 +27365,7 @@ The default class handler just returns %TRUE. c:type="GDBusObjectSkeletonPrivate" disguised="1" opaque="1"> - + glib:get-type="g_dbus_property_info_get_type" c:symbol-prefix="dbus_property_info"> Information about a D-Bus property on a D-Bus interface. - + The reference count or -1 if statically allocated. The name of the D-Bus property, e.g. "SupportedFilesystems". The D-Bus signature of the property (a single complete type). Access control flags for the property. A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. @@ -27353,22 +27413,21 @@ The default class handler just returns %TRUE. c:identifier="g_dbus_property_info_ref" version="2.26"> If @info is statically allocated does nothing. Otherwise increases + filename="gio/gdbusintrospection.c" + line="162">If @info is statically allocated does nothing. Otherwise increases the reference count. - + The same @info. + filename="gio/gdbusintrospection.c" + line="169">The same @info. A #GDBusPropertyInfo + filename="gio/gdbusintrospection.c" + line="164">A #GDBusPropertyInfo @@ -27377,20 +27436,19 @@ the reference count. c:identifier="g_dbus_property_info_unref" version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + filename="gio/gdbusintrospection.c" + line="333">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. - + A #GDBusPropertyInfo. + filename="gio/gdbusintrospection.c" + line="335">A #GDBusPropertyInfo. @@ -27402,16 +27460,16 @@ the memory used is freed. glib:get-type="g_dbus_property_info_flags_get_type" c:type="GDBusPropertyInfoFlags"> Flags describing the access control of a D-Bus property. + filename="gio/gioenums.h" + line="1356">Flags describing the access control of a D-Bus property. No flags set. + filename="gio/gioenums.h" + line="1358">No flags set. glib:nick="readable" glib:name="G_DBUS_PROPERTY_INFO_FLAGS_READABLE"> Property is readable. + filename="gio/gioenums.h" + line="1359">Property is readable. glib:nick="writable" glib:name="G_DBUS_PROPERTY_INFO_FLAGS_WRITABLE"> Property is writable. + filename="gio/gioenums.h" + line="1360">Property is writable. glib:get-type="g_dbus_proxy_get_type" glib:type-struct="DBusProxyClass"> #GDBusProxy is a base class used for proxies to access a D-Bus -interface on a remote object. A #GDBusProxy can be constructed for + filename="gio/gdbusproxy.c" + line="49">`GDBusProxy` is a base class used for proxies to access a D-Bus +interface on a remote object. A `GDBusProxy` can be constructed for both well-known and unique names. -By default, #GDBusProxy will cache all properties (and listen to +By default, `GDBusProxy` will cache all properties (and listen to changes) of the remote object, and proxy all signals that get emitted. This behaviour can be changed by passing suitable -#GDBusProxyFlags when the proxy is created. If the proxy is for a +[flags@Gio.DBusProxyFlags] when the proxy is created. If the proxy is for a well-known name, the property cache is flushed when the name owner vanishes and reloaded when a name owner appears. -The unique name owner of the proxy's name is tracked and can be read from -#GDBusProxy:g-name-owner. Connect to the #GObject::notify signal to -get notified of changes. Additionally, only signals and property -changes emitted from the current name owner are considered and -calls are always sent to the current name owner. This avoids a -number of race conditions when the name is lost by one owner and -claimed by another. However, if no name owner currently exists, +The unique name owner of the proxy’s name is tracked and can be read from +[property@Gio.DBusProxy:g-name-owner]. Connect to the +[signal@GObject.Object::notify] signal to get notified of changes. +Additionally, only signals and property changes emitted from the current name +owner are considered and calls are always sent to the current name owner. +This avoids a number of race conditions when the name is lost by one owner +and claimed by another. However, if no name owner currently exists, then calls will be sent to the well-known name which may result in the message bus launching an owner (unless -%G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is set). +`G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START` is set). If the proxy is for a stateless D-Bus service, where the name owner may -be started and stopped between calls, the #GDBusProxy:g-name-owner tracking -of #GDBusProxy will cause the proxy to drop signal and property changes from -the service after it has restarted for the first time. When interacting -with a stateless D-Bus service, do not use #GDBusProxy — use direct D-Bus -method calls and signal connections. - -The generic #GDBusProxy::g-properties-changed and -#GDBusProxy::g-signal signals are not very convenient to work with. -Therefore, the recommended way of working with proxies is to subclass -#GDBusProxy, and have more natural properties and signals in your derived -class. This [example][gdbus-example-gdbus-codegen] shows how this can -easily be done using the [gdbus-codegen][gdbus-codegen] tool. - -A #GDBusProxy instance can be used from multiple threads but note -that all signals (e.g. #GDBusProxy::g-signal, #GDBusProxy::g-properties-changed -and #GObject::notify) are emitted in the -[thread-default main context][g-main-context-push-thread-default] -of the thread where the instance was constructed. +be started and stopped between calls, the +[property@Gio.DBusProxy:g-name-owner] tracking of `GDBusProxy` will cause the +proxy to drop signal and property changes from the service after it has +restarted for the first time. When interacting with a stateless D-Bus +service, do not use `GDBusProxy` — use direct D-Bus method calls and signal +connections. + +The generic [signal@Gio.DBusProxy::g-properties-changed] and +[signal@Gio.DBusProxy::g-signal] signals are not very convenient to work +with. Therefore, the recommended way of working with proxies is to subclass +`GDBusProxy`, and have more natural properties and signals in your derived +class. This [example](migrating-gdbus.html#using-gdbus-codegen) shows how +this can easily be done using the [`gdbus-codegen`](gdbus-codegen.html) tool. + +A `GDBusProxy` instance can be used from multiple threads but note +that all signals (e.g. [signal@Gio.DBusProxy::g-signal], +[signal@Gio.DBusProxy::g-properties-changed] and +[signal@GObject.Object::notify]) are emitted in the thread-default main +context (see [method@GLib.MainContext.push_thread_default]) of the thread +where the instance was constructed. An example using a proxy for a well-known name can be found in -[gdbus-example-watch-proxy.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-watch-proxy.c) - +[`gdbus-example-watch-proxy.c`](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-watch-proxy.c). + @@ -27496,22 +27555,21 @@ An example using a proxy for a well-known name can be found in version="2.26" throws="1"> Finishes creating a #GDBusProxy. - + filename="gio/gdbusproxy.c" + line="1997">Finishes creating a #GDBusProxy. + A #GDBusProxy or %NULL if @error is set. + filename="gio/gdbusproxy.c" + line="2004">A #GDBusProxy or %NULL if @error is set. Free with g_object_unref(). A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new(). + filename="gio/gdbusproxy.c" + line="1999">A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new(). @@ -27521,22 +27579,21 @@ An example using a proxy for a well-known name can be found in version="2.26" throws="1"> Finishes creating a #GDBusProxy. - + filename="gio/gdbusproxy.c" + line="2154">Finishes creating a #GDBusProxy. + A #GDBusProxy or %NULL if @error is set. + filename="gio/gdbusproxy.c" + line="2161">A #GDBusProxy or %NULL if @error is set. Free with g_object_unref(). A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new_for_bus(). + filename="gio/gdbusproxy.c" + line="2156">A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to g_dbus_proxy_new_for_bus(). @@ -27546,30 +27603,29 @@ An example using a proxy for a well-known name can be found in version="2.26" throws="1"> Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. + filename="gio/gdbusproxy.c" + line="2173">Like g_dbus_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. #GDBusProxy is used in this [example][gdbus-wellknown-proxy]. - + A #GDBusProxy or %NULL if error is set. + filename="gio/gdbusproxy.c" + line="2189">A #GDBusProxy or %NULL if error is set. Free with g_object_unref(). A #GBusType. + filename="gio/gdbusproxy.c" + line="2175">A #GBusType. Flags used when constructing the proxy. + filename="gio/gdbusproxy.c" + line="2176">Flags used when constructing the proxy. A #GDBusInterfaceInfo specifying the minimal interface + filename="gio/gdbusproxy.c" + line="2177">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. A bus name (well-known or unique). + filename="gio/gdbusproxy.c" + line="2179">A bus name (well-known or unique). An object path. + filename="gio/gdbusproxy.c" + line="2180">An object path. A D-Bus interface name. + filename="gio/gdbusproxy.c" + line="2181">A D-Bus interface name. A #GCancellable or %NULL. + filename="gio/gdbusproxy.c" + line="2182">A #GCancellable or %NULL. @@ -27616,8 +27672,8 @@ An example using a proxy for a well-known name can be found in version="2.26" throws="1"> Creates a proxy for accessing @interface_name on the remote object + filename="gio/gdbusproxy.c" + line="2030">Creates a proxy for accessing @interface_name on the remote object at @object_path owned by @name at @connection and synchronously loads D-Bus properties unless the %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. @@ -27639,26 +27695,25 @@ This is a synchronous failable constructor. See g_dbus_proxy_new() and g_dbus_proxy_new_finish() for the asynchronous version. #GDBusProxy is used in this [example][gdbus-wellknown-proxy]. - + A #GDBusProxy or %NULL if error is set. + filename="gio/gdbusproxy.c" + line="2064">A #GDBusProxy or %NULL if error is set. Free with g_object_unref(). A #GDBusConnection. + filename="gio/gdbusproxy.c" + line="2032">A #GDBusConnection. Flags used when constructing the proxy. + filename="gio/gdbusproxy.c" + line="2033">Flags used when constructing the proxy. A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. + filename="gio/gdbusproxy.c" + line="2034">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + filename="gio/gdbusproxy.c" + line="2035">A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. An object path. + filename="gio/gdbusproxy.c" + line="2036">An object path. A D-Bus interface name. + filename="gio/gdbusproxy.c" + line="2037">A D-Bus interface name. A #GCancellable or %NULL. + filename="gio/gdbusproxy.c" + line="2038">A #GCancellable or %NULL. - + Creates a proxy for accessing @interface_name on the remote object + filename="gio/gdbusproxy.c" + line="1923">Creates a proxy for accessing @interface_name on the remote object at @object_path owned by @name at @connection and asynchronously loads D-Bus properties unless the %G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES flag is used. Connect to @@ -27732,22 +27790,21 @@ g_dbus_proxy_new_finish() to get the result. See g_dbus_proxy_new_sync() and for a synchronous version of this constructor. #GDBusProxy is used in this [example][gdbus-wellknown-proxy]. - + A #GDBusConnection. + filename="gio/gdbusproxy.c" + line="1925">A #GDBusConnection. Flags used when constructing the proxy. + filename="gio/gdbusproxy.c" + line="1926">Flags used when constructing the proxy. A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. + filename="gio/gdbusproxy.c" + line="1927">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. + filename="gio/gdbusproxy.c" + line="1928">A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. An object path. + filename="gio/gdbusproxy.c" + line="1929">An object path. A D-Bus interface name. + filename="gio/gdbusproxy.c" + line="1930">A D-Bus interface name. A #GCancellable or %NULL. + filename="gio/gdbusproxy.c" + line="1931">A #GCancellable or %NULL. Callback function to invoke when the proxy is ready. + filename="gio/gdbusproxy.c" + line="1932">Callback function to invoke when the proxy is ready. User data to pass to @callback. + filename="gio/gdbusproxy.c" + line="1933">User data to pass to @callback. + version="2.26" + glib:finish-func="new_for_bus_finish"> Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection. + filename="gio/gdbusproxy.c" + line="2105">Like g_dbus_proxy_new() but takes a #GBusType instead of a #GDBusConnection. #GDBusProxy is used in this [example][gdbus-wellknown-proxy]. - + A #GBusType. + filename="gio/gdbusproxy.c" + line="2107">A #GBusType. Flags used when constructing the proxy. + filename="gio/gdbusproxy.c" + line="2108">Flags used when constructing the proxy. A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. + filename="gio/gdbusproxy.c" + line="2109">A #GDBusInterfaceInfo specifying the minimal interface that @proxy conforms to or %NULL. A bus name (well-known or unique). + filename="gio/gdbusproxy.c" + line="2110">A bus name (well-known or unique). An object path. + filename="gio/gdbusproxy.c" + line="2111">An object path. A D-Bus interface name. + filename="gio/gdbusproxy.c" + line="2112">A D-Bus interface name. A #GCancellable or %NULL. + filename="gio/gdbusproxy.c" + line="2113">A #GCancellable or %NULL. Callback function to invoke when the proxy is ready. + filename="gio/gdbusproxy.c" + line="2114">Callback function to invoke when the proxy is ready. User data to pass to @callback. + filename="gio/gdbusproxy.c" + line="2115">User data to pass to @callback. - + Signal class handler for the #GDBusProxy::g-properties-changed signal. + @@ -27914,8 +27973,10 @@ See g_dbus_proxy_new_sync() and for a synchronous version of this constructor. - + Signal class handler for the #GDBusProxy::g-signal signal. + @@ -27934,10 +27995,14 @@ See g_dbus_proxy_new_sync() and for a synchronous version of this constructor. - + Asynchronously invokes the @method_name method on @proxy. + filename="gio/gdbusproxy.c" + line="2871">Asynchronously invokes the @method_name method on @proxy. If @method_name contains any dots, then @name is split into interface and method name parts. This allows using @proxy for invoking methods on @@ -27979,22 +28044,21 @@ version of this method. If @callback is %NULL then the D-Bus method call message will be sent with the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. - + A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="2873">A #GDBusProxy. Name of method to invoke. + filename="gio/gdbusproxy.c" + line="2874">Name of method to invoke. nullable="1" allow-none="1"> A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. + filename="gio/gdbusproxy.c" + line="2875">A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. Flags from the #GDBusCallFlags enumeration. + filename="gio/gdbusproxy.c" + line="2876">Flags from the #GDBusCallFlags enumeration. The timeout in milliseconds (with %G_MAXINT meaning + filename="gio/gdbusproxy.c" + line="2877">The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. @@ -28024,8 +28088,8 @@ the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set. nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="gio/gdbusproxy.c" + line="2879">A #GCancellable or %NULL. scope="async" closure="6"> A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't + filename="gio/gdbusproxy.c" + line="2880">A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation. @@ -28045,8 +28109,8 @@ care about the result of the method invocation. nullable="1" allow-none="1"> The data to pass to @callback. + filename="gio/gdbusproxy.c" + line="2882">The data to pass to @callback. @@ -28056,28 +28120,27 @@ care about the result of the method invocation. version="2.26" throws="1"> Finishes an operation started with g_dbus_proxy_call(). - + filename="gio/gdbusproxy.c" + line="2942">Finishes an operation started with g_dbus_proxy_call(). + %NULL if @error is set. Otherwise a #GVariant tuple with + filename="gio/gdbusproxy.c" + line="2950">%NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="2944">A #GDBusProxy. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call(). + filename="gio/gdbusproxy.c" + line="2945">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call(). @@ -28085,10 +28148,11 @@ return values. Free with g_variant_unref(). + throws="1" + glib:async-func="call"> Synchronously invokes the @method_name method on @proxy. + filename="gio/gdbusproxy.c" + line="2963">Synchronously invokes the @method_name method on @proxy. If @method_name contains any dots, then @name is split into interface and method name parts. This allows using @proxy for invoking methods on @@ -28122,26 +28186,25 @@ method. If @proxy has an expected interface (see #GDBusProxy:g-interface-info) and @method_name is referenced by it, then the return value is checked against the return type. - + %NULL if @error is set. Otherwise a #GVariant tuple with + filename="gio/gdbusproxy.c" + line="3010">%NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="2965">A #GDBusProxy. Name of method to invoke. + filename="gio/gdbusproxy.c" + line="2966">Name of method to invoke. nullable="1" allow-none="1"> A #GVariant tuple with parameters for the signal + filename="gio/gdbusproxy.c" + line="2967">A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. Flags from the #GDBusCallFlags enumeration. + filename="gio/gdbusproxy.c" + line="2969">Flags from the #GDBusCallFlags enumeration. The timeout in milliseconds (with %G_MAXINT meaning + filename="gio/gdbusproxy.c" + line="2970">The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. @@ -28172,36 +28235,37 @@ return values. Free with g_variant_unref(). nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="gio/gdbusproxy.c" + line="2972">A #GCancellable or %NULL. + version="2.30" + glib:finish-func="call_with_unix_fd_list_finish" + glib:sync-func="call_with_unix_fd_list_sync"> Like g_dbus_proxy_call() but also takes a #GUnixFDList object. + filename="gio/gdbusproxy.c" + line="3031">Like g_dbus_proxy_call() but also takes a #GUnixFDList object. This method is only available on UNIX. - + A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="3033">A #GDBusProxy. Name of method to invoke. + filename="gio/gdbusproxy.c" + line="3034">Name of method to invoke. nullable="1" allow-none="1"> A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. + filename="gio/gdbusproxy.c" + line="3035">A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. Flags from the #GDBusCallFlags enumeration. + filename="gio/gdbusproxy.c" + line="3036">Flags from the #GDBusCallFlags enumeration. The timeout in milliseconds (with %G_MAXINT meaning + filename="gio/gdbusproxy.c" + line="3037">The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. @@ -28231,8 +28295,8 @@ This method is only available on UNIX. nullable="1" allow-none="1"> A #GUnixFDList or %NULL. + filename="gio/gdbusproxy.c" + line="3039">A #GUnixFDList or %NULL. nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="gio/gdbusproxy.c" + line="3040">A #GCancellable or %NULL. scope="async" closure="7"> A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't + filename="gio/gdbusproxy.c" + line="3041">A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation. @@ -28261,8 +28325,8 @@ care about the result of the method invocation. nullable="1" allow-none="1"> The data to pass to @callback. + filename="gio/gdbusproxy.c" + line="3043">The data to pass to @callback. @@ -28272,22 +28336,21 @@ care about the result of the method invocation. version="2.30" throws="1"> Finishes an operation started with g_dbus_proxy_call_with_unix_fd_list(). - + filename="gio/gdbusproxy.c" + line="3065">Finishes an operation started with g_dbus_proxy_call_with_unix_fd_list(). + %NULL if @error is set. Otherwise a #GVariant tuple with + filename="gio/gdbusproxy.c" + line="3074">%NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="3067">A #GDBusProxy. optional="1" allow-none="1"> Return location for a #GUnixFDList or %NULL. + filename="gio/gdbusproxy.c" + line="3068">Return location for a #GUnixFDList or %NULL. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call_with_unix_fd_list(). + filename="gio/gdbusproxy.c" + line="3069">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call_with_unix_fd_list(). @@ -28312,32 +28375,32 @@ return values. Free with g_variant_unref(). + throws="1" + glib:async-func="call_with_unix_fd_list"> Like g_dbus_proxy_call_sync() but also takes and returns #GUnixFDList objects. + filename="gio/gdbusproxy.c" + line="3088">Like g_dbus_proxy_call_sync() but also takes and returns #GUnixFDList objects. This method is only available on UNIX. - + %NULL if @error is set. Otherwise a #GVariant tuple with + filename="gio/gdbusproxy.c" + line="3106">%NULL if @error is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref(). A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="3090">A #GDBusProxy. Name of method to invoke. + filename="gio/gdbusproxy.c" + line="3091">Name of method to invoke. nullable="1" allow-none="1"> A #GVariant tuple with parameters for the signal + filename="gio/gdbusproxy.c" + line="3092">A #GVariant tuple with parameters for the signal or %NULL if not passing parameters. Flags from the #GDBusCallFlags enumeration. + filename="gio/gdbusproxy.c" + line="3094">Flags from the #GDBusCallFlags enumeration. The timeout in milliseconds (with %G_MAXINT meaning + filename="gio/gdbusproxy.c" + line="3095">The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout. @@ -28368,8 +28431,8 @@ return values. Free with g_variant_unref(). nullable="1" allow-none="1"> A #GUnixFDList or %NULL. + filename="gio/gdbusproxy.c" + line="3097">A #GUnixFDList or %NULL. optional="1" allow-none="1"> Return location for a #GUnixFDList or %NULL. + filename="gio/gdbusproxy.c" + line="3098">Return location for a #GUnixFDList or %NULL. nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="gio/gdbusproxy.c" + line="3099">A #GCancellable or %NULL. @@ -28398,19 +28461,18 @@ return values. Free with g_variant_unref(). c:identifier="g_dbus_proxy_get_cached_property" version="2.26"> Looks up the value for a property from the cache. This call does no + filename="gio/gdbusproxy.c" + line="680">Looks up the value for a property from the cache. This call does no blocking IO. If @proxy has an expected interface (see #GDBusProxy:g-interface-info) and @property_name is referenced by it, then @value is checked against the type of the property. - + A reference to the #GVariant instance + filename="gio/gdbusproxy.c" + line="692">A reference to the #GVariant instance that holds the value for @property_name or %NULL if the value is not in the cache. The returned reference must be freed with g_variant_unref(). @@ -28418,14 +28480,14 @@ it, then @value is checked against the type of the property. A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="682">A #GDBusProxy. Property name. + filename="gio/gdbusproxy.c" + line="683">Property name. @@ -28434,14 +28496,13 @@ it, then @value is checked against the type of the property. c:identifier="g_dbus_proxy_get_cached_property_names" version="2.26"> Gets the names of all cached properties on @proxy. - + filename="gio/gdbusproxy.c" + line="618">Gets the names of all cached properties on @proxy. + A + filename="gio/gdbusproxy.c" + line="624">A %NULL-terminated array of strings or %NULL if @proxy has no cached properties. Free the returned array with g_strfreev(). @@ -28452,8 +28513,8 @@ it, then @value is checked against the type of the property. A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="620">A #GDBusProxy. @@ -28462,21 +28523,20 @@ it, then @value is checked against the type of the property. c:identifier="g_dbus_proxy_get_connection" version="2.26"> Gets the connection @proxy is for. - + filename="gio/gdbusproxy.c" + line="2230">Gets the connection @proxy is for. + A #GDBusConnection owned by @proxy. Do not free. + filename="gio/gdbusproxy.c" + line="2236">A #GDBusConnection owned by @proxy. Do not free. A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="2232">A #GDBusProxy. @@ -28485,25 +28545,24 @@ it, then @value is checked against the type of the property. c:identifier="g_dbus_proxy_get_default_timeout" version="2.26"> Gets the timeout to use if -1 (specifying default timeout) is + filename="gio/gdbusproxy.c" + line="2346">Gets the timeout to use if -1 (specifying default timeout) is passed as @timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions. See the #GDBusProxy:g-default-timeout property for more details. - + Timeout to use for @proxy. + filename="gio/gdbusproxy.c" + line="2356">Timeout to use for @proxy. A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="2348">A #GDBusProxy. @@ -28512,21 +28571,20 @@ See the #GDBusProxy:g-default-timeout property for more details. c:identifier="g_dbus_proxy_get_flags" version="2.26"> Gets the flags that @proxy was constructed with. - + filename="gio/gdbusproxy.c" + line="2247">Gets the flags that @proxy was constructed with. + Flags from the #GDBusProxyFlags enumeration. + filename="gio/gdbusproxy.c" + line="2253">Flags from the #GDBusProxyFlags enumeration. A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="2249">A #GDBusProxy. @@ -28535,24 +28593,23 @@ See the #GDBusProxy:g-default-timeout property for more details. c:identifier="g_dbus_proxy_get_interface_info" version="2.26"> Returns the #GDBusInterfaceInfo, if any, specifying the interface + filename="gio/gdbusproxy.c" + line="2408">Returns the #GDBusInterfaceInfo, if any, specifying the interface that @proxy conforms to. See the #GDBusProxy:g-interface-info property for more details. - + A #GDBusInterfaceInfo or %NULL. + filename="gio/gdbusproxy.c" + line="2416">A #GDBusInterfaceInfo or %NULL. Do not unref the returned object, it is owned by @proxy. A #GDBusProxy + filename="gio/gdbusproxy.c" + line="2410">A #GDBusProxy @@ -28561,21 +28618,20 @@ property for more details. c:identifier="g_dbus_proxy_get_interface_name" version="2.26"> Gets the D-Bus interface name @proxy is for. - + filename="gio/gdbusproxy.c" + line="2329">Gets the D-Bus interface name @proxy is for. + A string owned by @proxy. Do not free. + filename="gio/gdbusproxy.c" + line="2335">A string owned by @proxy. Do not free. A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="2331">A #GDBusProxy. @@ -28584,25 +28640,24 @@ property for more details. c:identifier="g_dbus_proxy_get_name" version="2.26"> Gets the name that @proxy was constructed for. + filename="gio/gdbusproxy.c" + line="2264">Gets the name that @proxy was constructed for. When connected to a message bus, this will usually be non-%NULL. However, it may be %NULL for a proxy that communicates using a peer-to-peer pattern. - + A string owned by @proxy. Do not free. + filename="gio/gdbusproxy.c" + line="2274">A string owned by @proxy. Do not free. A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="2266">A #GDBusProxy. @@ -28611,25 +28666,24 @@ pattern. c:identifier="g_dbus_proxy_get_name_owner" version="2.26"> The unique name that owns the name that @proxy is for or %NULL if + filename="gio/gdbusproxy.c" + line="2285">The unique name that owns the name that @proxy is for or %NULL if no-one currently owns that name. You may connect to the #GObject::notify signal to track changes to the #GDBusProxy:g-name-owner property. - + The name owner or %NULL if no name + filename="gio/gdbusproxy.c" + line="2294">The name owner or %NULL if no name owner exists. Free with g_free(). A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="2287">A #GDBusProxy. @@ -28638,21 +28692,20 @@ no-one currently owns that name. You may connect to the c:identifier="g_dbus_proxy_get_object_path" version="2.26"> Gets the object path @proxy is for. - + filename="gio/gdbusproxy.c" + line="2312">Gets the object path @proxy is for. + A string owned by @proxy. Do not free. + filename="gio/gdbusproxy.c" + line="2318">A string owned by @proxy. Do not free. A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="2314">A #GDBusProxy. @@ -28661,8 +28714,8 @@ no-one currently owns that name. You may connect to the c:identifier="g_dbus_proxy_set_cached_property" version="2.26"> If @value is not %NULL, sets the cached value for the property with + filename="gio/gdbusproxy.c" + line="737">If @value is not %NULL, sets the cached value for the property with name @property_name to the value in @value. If @value is %NULL, then the cached value is removed from the @@ -28695,22 +28748,21 @@ transmitting the same (long) array every time the property changes, it is more efficient to only transmit the delta using e.g. signals `ChatroomParticipantJoined(String name)` and `ChatroomParticipantParted(String name)`. - + A #GDBusProxy + filename="gio/gdbusproxy.c" + line="739">A #GDBusProxy Property name. + filename="gio/gdbusproxy.c" + line="740">Property name. Value for the property or %NULL to remove it from the cache. + filename="gio/gdbusproxy.c" + line="741">Value for the property or %NULL to remove it from the cache. @@ -28728,28 +28780,27 @@ it is more efficient to only transmit the delta using e.g. signals c:identifier="g_dbus_proxy_set_default_timeout" version="2.26"> Sets the timeout to use if -1 (specifying default timeout) is + filename="gio/gdbusproxy.c" + line="2373">Sets the timeout to use if -1 (specifying default timeout) is passed as @timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions. See the #GDBusProxy:g-default-timeout property for more details. - + A #GDBusProxy. + filename="gio/gdbusproxy.c" + line="2375">A #GDBusProxy. Timeout in milliseconds. + filename="gio/gdbusproxy.c" + line="2376">Timeout in milliseconds. @@ -28758,20 +28809,19 @@ See the #GDBusProxy:g-default-timeout property for more details. c:identifier="g_dbus_proxy_set_interface_info" version="2.26"> Ensure that interactions with @proxy conform to the given + filename="gio/gdbusproxy.c" + line="2437">Ensure that interactions with @proxy conform to the given interface. See the #GDBusProxy:g-interface-info property for more details. - + A #GDBusProxy + filename="gio/gdbusproxy.c" + line="2439">A #GDBusProxy nullable="1" allow-none="1"> Minimum interface this proxy conforms to + filename="gio/gdbusproxy.c" + line="2440">Minimum interface this proxy conforms to or %NULL to unset. @@ -28794,8 +28844,8 @@ details. transfer-ownership="none" default-value="G_BUS_TYPE_NONE"> If this property is not %G_BUS_TYPE_NONE, then + filename="gio/gdbusproxy.c" + line="398">If this property is not %G_BUS_TYPE_NONE, then #GDBusProxy:g-connection must be %NULL and will be set to the #GDBusConnection obtained by calling g_bus_get() with the value of this property. @@ -28807,8 +28857,8 @@ of this property. construct-only="1" transfer-ownership="none"> The #GDBusConnection the proxy is for. + filename="gio/gdbusproxy.c" + line="380">The #GDBusConnection the proxy is for. transfer-ownership="none" default-value="-1"> The timeout to use if -1 (specifying default timeout) is passed + filename="gio/gdbusproxy.c" + line="510">The timeout to use if -1 (specifying default timeout) is passed as @timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions. @@ -28836,8 +28886,8 @@ the default timeout (typically 25 seconds) is used. If set to transfer-ownership="none" default-value="G_DBUS_PROXY_FLAGS_NONE"> Flags from the #GDBusProxyFlags enumeration. + filename="gio/gdbusproxy.c" + line="419">Flags from the #GDBusProxyFlags enumeration. Ensure that interactions with this proxy conform to the given + filename="gio/gdbusproxy.c" + line="340">Ensure that interactions with this proxy conform to the given interface. This is mainly to ensure that malformed data received from the other peer is ignored. The given #GDBusInterfaceInfo is said to be the "expected interface". @@ -28879,8 +28929,8 @@ service-side is not considered an ABI break. transfer-ownership="none" default-value="NULL"> The D-Bus interface name the proxy is for. + filename="gio/gdbusproxy.c" + line="492">The D-Bus interface name the proxy is for. transfer-ownership="none" default-value="NULL"> The well-known or unique name that the proxy is for. + filename="gio/gdbusproxy.c" + line="438">The well-known or unique name that the proxy is for. transfer-ownership="none" default-value="NULL"> The unique name that owns #GDBusProxy:g-name or %NULL if no-one + filename="gio/gdbusproxy.c" + line="456">The unique name that owns #GDBusProxy:g-name or %NULL if no-one currently owns that name. You may connect to #GObject::notify signal to track changes to this property. @@ -28912,8 +28962,8 @@ track changes to this property. transfer-ownership="none" default-value="NULL"> The object path the proxy is for. + filename="gio/gdbusproxy.c" + line="474">The object path the proxy is for. @@ -28924,8 +28974,8 @@ track changes to this property. Emitted when one or more D-Bus properties on @proxy changes. The + filename="gio/gdbusproxy.c" + line="537">Emitted when one or more D-Bus properties on @proxy changes. The local cache has already been updated when this signal fires. Note that both @changed_properties and @invalidated_properties are guaranteed to never be %NULL (either may be empty though). @@ -28943,14 +28993,14 @@ This signal corresponds to the A #GVariant containing the properties that changed (type: `a{sv}`) + filename="gio/gdbusproxy.c" + line="540">A #GVariant containing the properties that changed (type: `a{sv}`) A %NULL terminated array of properties that was invalidated + filename="gio/gdbusproxy.c" + line="541">A %NULL terminated array of properties that was invalidated @@ -28959,8 +29009,8 @@ This signal corresponds to the Emitted when a signal from the remote object and interface that @proxy is for, has been received. + filename="gio/gdbusproxy.c" + line="573">Emitted when a signal from the remote object and interface that @proxy is for, has been received. Since 2.72 this signal supports detailed connections. You can connect to the detailed signal `g-signal::x` in order to receive callbacks only when @@ -28974,20 +29024,20 @@ signal `x` is received from the remote object. nullable="1" allow-none="1"> The sender of the signal or %NULL if the connection is not a bus connection. + filename="gio/gdbusproxy.c" + line="576">The sender of the signal or %NULL if the connection is not a bus connection. The name of the signal. + filename="gio/gdbusproxy.c" + line="577">The name of the signal. A #GVariant tuple with parameters for the signal. + filename="gio/gdbusproxy.c" + line="578">A #GVariant tuple with parameters for the signal. @@ -28998,17 +29048,18 @@ signal `x` is received from the remote object. glib:is-gtype-struct-for="DBusProxy" version="2.26"> Class structure for #GDBusProxy. - + filename="gio/gdbusproxy.h" + line="52">Class structure for #GDBusProxy. + + Signal class handler for the #GDBusProxy::g-properties-changed signal. - + @@ -29026,9 +29077,11 @@ signal `x` is received from the remote object. + Signal class handler for the #GDBusProxy::g-signal signal. - + @@ -29060,16 +29113,16 @@ signal `x` is received from the remote object. glib:get-type="g_dbus_proxy_flags_get_type" c:type="GDBusProxyFlags"> Flags used when constructing an instance of a #GDBusProxy derived class. + filename="gio/gioenums.h" + line="1024">Flags used when constructing an instance of a #GDBusProxy derived class. No flags set. + filename="gio/gioenums.h" + line="1026">No flags set. glib:nick="do-not-load-properties" glib:name="G_DBUS_PROXY_FLAGS_DO_NOT_LOAD_PROPERTIES"> Don't load properties. + filename="gio/gioenums.h" + line="1027">Don't load properties. glib:nick="do-not-connect-signals" glib:name="G_DBUS_PROXY_FLAGS_DO_NOT_CONNECT_SIGNALS"> Don't connect to signals on the remote object. + filename="gio/gioenums.h" + line="1028">Don't connect to signals on the remote object. glib:nick="do-not-auto-start" glib:name="G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START"> If the proxy is for a well-known name, + filename="gio/gioenums.h" + line="1029">If the proxy is for a well-known name, do not ask the bus to launch an owner during proxy initialization or a method call. This flag is only meaningful in proxies for well-known names. @@ -29106,8 +29159,8 @@ This flag is only meaningful in proxies for well-known names. glib:nick="get-invalidated-properties" glib:name="G_DBUS_PROXY_FLAGS_GET_INVALIDATED_PROPERTIES"> If set, the property value for any __invalidated property__ will be (asynchronously) retrieved upon receiving the [`PropertiesChanged`](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties) D-Bus signal and the property will not cause emission of the #GDBusProxy::g-properties-changed signal. When the value is received the #GDBusProxy::g-properties-changed signal is emitted for the property along with the retrieved value. Since 2.32. + filename="gio/gioenums.h" + line="1032">If set, the property value for any __invalidated property__ will be (asynchronously) retrieved upon receiving the [`PropertiesChanged`](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties) D-Bus signal and the property will not cause emission of the #GDBusProxy::g-properties-changed signal. When the value is received the #GDBusProxy::g-properties-changed signal is emitted for the property along with the retrieved value. Since 2.32. glib:nick="do-not-auto-start-at-construction" glib:name="G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START_AT_CONSTRUCTION"> If the proxy is for a well-known name, + filename="gio/gioenums.h" + line="1033">If the proxy is for a well-known name, do not ask the bus to launch an owner during proxy initialization, but allow it to be autostarted by a method call. This flag is only meaningful in proxies for well-known names, and only if %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is not also specified. @@ -29127,8 +29180,8 @@ and only if %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is not also specified. glib:nick="no-match-rule" glib:name="G_DBUS_PROXY_FLAGS_NO_MATCH_RULE"> Don't actually send the AddMatch D-Bus + filename="gio/gioenums.h" + line="1037">Don't actually send the AddMatch D-Bus call for this signal subscription. This gives you more control over which match rules you add (but you must add them manually). (Since: 2.72) @@ -29137,27 +29190,25 @@ and only if %G_DBUS_PROXY_FLAGS_DO_NOT_AUTO_START is not also specified. c:type="GDBusProxyPrivate" disguised="1" opaque="1"> - + Function signature for a function used to determine the #GType to + filename="gio/giotypes.h" + line="524">Function signature for a function used to determine the #GType to use for an interface proxy (if @interface_name is not %NULL) or object proxy (if @interface_name is %NULL). This function is called in the [thread-default main loop][g-main-context-push-thread-default] that @manager was constructed in. - + A #GType to use for the remote object. The returned type + filename="gio/giotypes.h" + line="539">A #GType to use for the remote object. The returned type must be a #GDBusProxy or #GDBusObjectProxy -derived type. @@ -29165,15 +29216,15 @@ that @manager was constructed in. A #GDBusObjectManagerClient. + filename="gio/giotypes.h" + line="526">A #GDBusObjectManagerClient. The object path of the remote object. + filename="gio/giotypes.h" + line="527">The object path of the remote object. nullable="1" allow-none="1"> The interface name of the remote object or %NULL if a #GDBusObjectProxy #GType is requested. + filename="gio/giotypes.h" + line="528">The interface name of the remote object or %NULL if a #GDBusObjectProxy #GType is requested. nullable="1" allow-none="1"> data passed in by the user. + filename="gio/giotypes.h" + line="529">data passed in by the user. @@ -29202,16 +29253,16 @@ that @manager was constructed in. glib:get-type="g_dbus_send_message_flags_get_type" c:type="GDBusSendMessageFlags"> Flags used when sending #GDBusMessages on a #GDBusConnection. + filename="gio/gioenums.h" + line="1437">Flags used when sending #GDBusMessages on a #GDBusConnection. No flags set. + filename="gio/gioenums.h" + line="1439">No flags set. glib:nick="preserve-serial" glib:name="G_DBUS_SEND_MESSAGE_FLAGS_PRESERVE_SERIAL"> Do not automatically + filename="gio/gioenums.h" + line="1440">Do not automatically assign a serial number from the #GDBusConnection object when sending a message. @@ -29233,33 +29284,35 @@ sending a message. glib:type-name="GDBusServer" glib:get-type="g_dbus_server_get_type"> #GDBusServer is a helper for listening to and accepting D-Bus + filename="gio/gdbusserver.c" + line="65">`GDBusServer` is a helper for listening to and accepting D-Bus connections. This can be used to create a new D-Bus server, allowing two peers to use the D-Bus protocol for their own specialized communication. A server instance provided in this way will not perform message routing or -implement the org.freedesktop.DBus interface. +implement the +[`org.freedesktop.DBus` interface](https://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-messages). To just export an object on a well-known name on a message bus, such as the -session or system bus, you should instead use g_bus_own_name(). +session or system bus, you should instead use [func@Gio.bus_own_name]. An example of peer-to-peer communication with GDBus can be found in [gdbus-example-peer.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-peer.c). -Note that a minimal #GDBusServer will accept connections from any -peer. In many use-cases it will be necessary to add a #GDBusAuthObserver -that only accepts connections that have successfully authenticated -as the same user that is running the #GDBusServer. Since GLib 2.68 this can -be achieved more simply by passing the -%G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER flag to the server. +Note that a minimal `GDBusServer` will accept connections from any +peer. In many use-cases it will be necessary to add a +[class@Gio.DBusAuthObserver] that only accepts connections that have +successfully authenticated as the same user that is running the +`GDBusServer`. Since GLib 2.68 this can be achieved more simply by passing +the `G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER` flag to the +server. Creates a new D-Bus server that listens on the first address in + filename="gio/gdbusserver.c" + line="458">Creates a new D-Bus server that listens on the first address in @address that works. Once constructed, you can use g_dbus_server_get_client_address() to @@ -29279,32 +29332,31 @@ g_dbus_server_start(). This is a synchronous failable constructor. There is currently no asynchronous version. - + A #GDBusServer or %NULL if @error is set. Free with + filename="gio/gdbusserver.c" + line="488">A #GDBusServer or %NULL if @error is set. Free with g_object_unref(). A D-Bus address. + filename="gio/gdbusserver.c" + line="460">A D-Bus address. Flags from the #GDBusServerFlags enumeration. + filename="gio/gdbusserver.c" + line="461">Flags from the #GDBusServerFlags enumeration. A D-Bus GUID. + filename="gio/gdbusserver.c" + line="462">A D-Bus GUID. nullable="1" allow-none="1"> A #GDBusAuthObserver or %NULL. + filename="gio/gdbusserver.c" + line="463">A #GDBusAuthObserver or %NULL. nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="gio/gdbusserver.c" + line="464">A #GCancellable or %NULL. @@ -29332,26 +29384,25 @@ g_object_unref(). glib:get-property="client-address" version="2.26"> Gets a + filename="gio/gdbusserver.c" + line="520">Gets a [D-Bus address](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses) string that can be used by clients to connect to @server. This is valid and non-empty if initializing the #GDBusServer succeeded. - + A D-Bus address string. Do not free, the string is owned + filename="gio/gdbusserver.c" + line="530">A D-Bus address string. Do not free, the string is owned by @server. A #GDBusServer. + filename="gio/gdbusserver.c" + line="522">A #GDBusServer. @@ -29361,21 +29412,20 @@ by @server. glib:get-property="flags" version="2.26"> Gets the flags for @server. - + filename="gio/gdbusserver.c" + line="559">Gets the flags for @server. + A set of flags from the #GDBusServerFlags enumeration. + filename="gio/gdbusserver.c" + line="565">A set of flags from the #GDBusServerFlags enumeration. A #GDBusServer. + filename="gio/gdbusserver.c" + line="561">A #GDBusServer. @@ -29385,21 +29435,20 @@ by @server. glib:get-property="guid" version="2.26"> Gets the GUID for @server, as provided to g_dbus_server_new_sync(). - + filename="gio/gdbusserver.c" + line="542">Gets the GUID for @server, as provided to g_dbus_server_new_sync(). + A D-Bus GUID. Do not free this string, it is owned by @server. + filename="gio/gdbusserver.c" + line="548">A D-Bus GUID. Do not free this string, it is owned by @server. A #GDBusServer. + filename="gio/gdbusserver.c" + line="544">A #GDBusServer. @@ -29408,57 +29457,54 @@ by @server. c:identifier="g_dbus_server_is_active" version="2.26"> Gets whether @server is active. - + filename="gio/gdbusserver.c" + line="576">Gets whether @server is active. + %TRUE if server is active, %FALSE otherwise. + filename="gio/gdbusserver.c" + line="582">%TRUE if server is active, %FALSE otherwise. A #GDBusServer. + filename="gio/gdbusserver.c" + line="578">A #GDBusServer. Starts @server. - + filename="gio/gdbusserver.c" + line="593">Starts @server. + A #GDBusServer. + filename="gio/gdbusserver.c" + line="595">A #GDBusServer. Stops @server. - + filename="gio/gdbusserver.c" + line="620">Stops @server. + A #GDBusServer. + filename="gio/gdbusserver.c" + line="622">A #GDBusServer. @@ -29468,8 +29514,8 @@ by @server. transfer-ownership="none" default-value="FALSE"> Whether the server is currently active. + filename="gio/gdbusserver.c" + line="365">Whether the server is currently active. transfer-ownership="none" default-value="NULL"> The D-Bus address to listen on. + filename="gio/gdbusserver.c" + line="331">The D-Bus address to listen on. construct-only="1" transfer-ownership="none"> A #GDBusAuthObserver object to assist in the authentication process or %NULL. + filename="gio/gdbusserver.c" + line="381">A #GDBusAuthObserver object to assist in the authentication process or %NULL. getter="get_client_address" default-value="NULL"> The D-Bus address that clients can use. + filename="gio/gdbusserver.c" + line="349">The D-Bus address that clients can use. getter="get_flags" default-value="G_DBUS_SERVER_FLAGS_NONE"> Flags from the #GDBusServerFlags enumeration. + filename="gio/gdbusserver.c" + line="292">Flags from the #GDBusServerFlags enumeration. getter="get_guid" default-value="NULL"> The GUID of the server. + filename="gio/gdbusserver.c" + line="311">The GUID of the server. See #GDBusConnection:guid for more details. Emitted when a new authenticated connection has been made. Use + filename="gio/gdbusserver.c" + line="399">Emitted when a new authenticated connection has been made. Use g_dbus_connection_get_peer_credentials() to figure out what identity (if any), was authenticated. @@ -29555,16 +29601,16 @@ that it's suitable to call g_dbus_connection_register_object() or similar from the signal handler. %TRUE to claim @connection, %FALSE to let other handlers + filename="gio/gdbusserver.c" + line="426">%TRUE to claim @connection, %FALSE to let other handlers run. A #GDBusConnection for the new connection. + filename="gio/gdbusserver.c" + line="402">A #GDBusConnection for the new connection. @@ -29576,16 +29622,16 @@ run. glib:get-type="g_dbus_server_flags_get_type" c:type="GDBusServerFlags"> Flags used when creating a #GDBusServer. + filename="gio/gioenums.h" + line="1390">Flags used when creating a #GDBusServer. No flags set. + filename="gio/gioenums.h" + line="1392">No flags set. glib:nick="run-in-thread" glib:name="G_DBUS_SERVER_FLAGS_RUN_IN_THREAD"> All #GDBusServer::new-connection + filename="gio/gioenums.h" + line="1393">All #GDBusServer::new-connection signals will run in separated dedicated threads (see signal for details). @@ -29604,8 +29650,8 @@ details). glib:nick="authentication-allow-anonymous" glib:name="G_DBUS_SERVER_FLAGS_AUTHENTICATION_ALLOW_ANONYMOUS"> Allow the anonymous + filename="gio/gioenums.h" + line="1396">Allow the anonymous authentication method. glib:nick="authentication-require-same-user" glib:name="G_DBUS_SERVER_FLAGS_AUTHENTICATION_REQUIRE_SAME_USER"> Require the UID of the + filename="gio/gioenums.h" + line="1398">Require the UID of the peer to be the same as the UID of the server when authenticating. (Since: 2.68) @@ -29623,17 +29669,16 @@ peer to be the same as the UID of the server when authenticating. (Since: 2.68)< c:type="GDBusSignalCallback" version="2.26"> Signature for callback function used in g_dbus_connection_signal_subscribe(). - + A #GDBusConnection. @@ -29642,32 +29687,32 @@ peer to be the same as the UID of the server when authenticating. (Since: 2.68)< nullable="1" allow-none="1"> The unique bus name of the sender of the signal, or %NULL on a peer-to-peer D-Bus connection. The object path that the signal was emitted on. The name of the interface. The name of the signal. A #GVariant tuple with parameters for the signal. @@ -29677,7 +29722,7 @@ peer to be the same as the UID of the server when authenticating. (Since: 2.68)< allow-none="1" closure="6"> User data passed when subscribing to the signal. @@ -29689,16 +29734,16 @@ peer to be the same as the UID of the server when authenticating. (Since: 2.68)< glib:get-type="g_dbus_signal_flags_get_type" c:type="GDBusSignalFlags"> Flags used when subscribing to signals via g_dbus_connection_signal_subscribe(). + filename="gio/gioenums.h" + line="1413">Flags used when subscribing to signals via g_dbus_connection_signal_subscribe(). No flags set. + filename="gio/gioenums.h" + line="1415">No flags set. Don't actually send the AddMatch + filename="gio/gioenums.h" + line="1416">Don't actually send the AddMatch D-Bus call for this signal subscription. This gives you more control over which match rules you add (but you must add them manually). @@ -29717,8 +29762,8 @@ over which match rules you add (but you must add them manually). glib:nick="match-arg0-namespace" glib:name="G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_NAMESPACE"> Match first arguments that + filename="gio/gioenums.h" + line="1419">Match first arguments that contain a bus or interface name with the given namespace. glib:nick="match-arg0-path" glib:name="G_DBUS_SIGNAL_FLAGS_MATCH_ARG0_PATH"> Match first arguments that + filename="gio/gioenums.h" + line="1421">Match first arguments that contain an object path that is either equivalent to the given path, or one of the paths is a subpath of the other. @@ -29740,25 +29785,24 @@ or one of the paths is a subpath of the other. glib:get-type="g_dbus_signal_info_get_type" c:symbol-prefix="dbus_signal_info"> Information about a signal on a D-Bus interface. - + The reference count or -1 if statically allocated. The name of the D-Bus signal, e.g. "NameOwnerChanged". A pointer to a %NULL-terminated array of pointers to #GDBusArgInfo structures or %NULL if there are no arguments. @@ -29766,7 +29810,7 @@ or one of the paths is a subpath of the other. A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations. @@ -29774,22 +29818,21 @@ or one of the paths is a subpath of the other. If @info is statically allocated does nothing. Otherwise increases + filename="gio/gdbusintrospection.c" + line="142">If @info is statically allocated does nothing. Otherwise increases the reference count. - + The same @info. + filename="gio/gdbusintrospection.c" + line="149">The same @info. A #GDBusSignalInfo + filename="gio/gdbusintrospection.c" + line="144">A #GDBusSignalInfo @@ -29798,20 +29841,19 @@ the reference count. c:identifier="g_dbus_signal_info_unref" version="2.26"> If @info is statically allocated, does nothing. Otherwise decreases + filename="gio/gdbusintrospection.c" + line="309">If @info is statically allocated, does nothing. Otherwise decreases the reference count of @info. When its reference count drops to 0, the memory used is freed. - + A #GDBusSignalInfo. + filename="gio/gdbusintrospection.c" + line="311">A #GDBusSignalInfo. @@ -29821,53 +29863,52 @@ the memory used is freed. c:type="GDBusSubtreeDispatchFunc" version="2.26"> The type of the @dispatch function in #GDBusSubtreeVTable. Subtrees are flat. @node, if non-%NULL, is always exactly one segment of the object path (ie: it never contains a slash). - + A #GDBusInterfaceVTable or %NULL if you don't want to handle the methods. A #GDBusConnection. The unique bus name of the remote caller. The object path that was registered with g_dbus_connection_register_subtree(). The D-Bus interface name that the method call or property access is for. A node that is a child of @object_path (relative to @object_path) or %NULL for the root of the subtree. Return location for user data to pass to functions in the returned #GDBusInterfaceVTable. @@ -29877,7 +29918,7 @@ segment of the object path (ie: it never contains a slash). allow-none="1" closure="6"> The @user_data #gpointer passed to g_dbus_connection_register_subtree(). @@ -29887,7 +29928,7 @@ segment of the object path (ie: it never contains a slash). c:type="GDBusSubtreeEnumerateFunc" version="2.26"> The type of the @enumerate function in #GDBusSubtreeVTable. This function is called when generating introspection data and also @@ -29899,11 +29940,10 @@ Hierarchies are not supported; the items that you return should not contain the `/` character. The return value will be freed with g_strfreev(). - + A newly allocated array of strings for node names that are children of @object_path. @@ -29912,19 +29952,19 @@ The return value will be freed with g_strfreev(). A #GDBusConnection. The unique bus name of the remote caller. The object path that was registered with g_dbus_connection_register_subtree(). @@ -29934,7 +29974,7 @@ The return value will be freed with g_strfreev(). allow-none="1" closure="3"> The @user_data #gpointer passed to g_dbus_connection_register_subtree(). @@ -29946,16 +29986,16 @@ The return value will be freed with g_strfreev(). glib:get-type="g_dbus_subtree_flags_get_type" c:type="GDBusSubtreeFlags"> Flags passed to g_dbus_connection_register_subtree(). + filename="gio/gioenums.h" + line="1373">Flags passed to g_dbus_connection_register_subtree(). No flags set. + filename="gio/gioenums.h" + line="1375">No flags set. glib:nick="dispatch-to-unenumerated-nodes" glib:name="G_DBUS_SUBTREE_FLAGS_DISPATCH_TO_UNENUMERATED_NODES"> Method calls to objects not in the enumerated range + filename="gio/gioenums.h" + line="1376">Method calls to objects not in the enumerated range will still be dispatched. This is useful if you want to dynamically spawn objects in the subtree. @@ -29973,7 +30013,7 @@ The return value will be freed with g_strfreev(). c:type="GDBusSubtreeIntrospectFunc" version="2.26"> The type of the @introspect function in #GDBusSubtreeVTable. Subtrees are flat. @node, if non-%NULL, is always exactly one @@ -29992,11 +30032,10 @@ The difference between returning %NULL and an array containing zero items is that the standard DBus interfaces will returned to the remote introspector in the empty array case, but not in the %NULL case. - + A %NULL-terminated array of pointers to #GDBusInterfaceInfo, or %NULL. @@ -30005,25 +30044,25 @@ case. A #GDBusConnection. The unique bus name of the remote caller. The object path that was registered with g_dbus_connection_register_subtree(). A node that is a child of @object_path (relative to @object_path) or %NULL for the root of the subtree. @@ -30033,7 +30072,7 @@ case. allow-none="1" closure="4"> The @user_data #gpointer passed to g_dbus_connection_register_subtree(). @@ -30043,27 +30082,26 @@ case. c:type="GDBusSubtreeVTable" version="2.26"> Virtual table for handling subtrees registered with g_dbus_connection_register_subtree(). - + Function for enumerating child nodes. Function for introspecting a child node. Function for dispatching a remote call on a child node. @@ -30077,8 +30115,7 @@ case. - + @@ -30089,28 +30126,1042 @@ case. c:type="G_DEBUG_CONTROLLER_EXTENSION_POINT_NAME" version="2.72"> Extension point for debug control functionality. See [Extending GIO][extending-gio]. - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -30119,8 +31170,7 @@ See [Extending GIO][extending-gio]. - + @@ -30129,8 +31179,7 @@ See [Extending GIO][extending-gio]. - + @@ -30139,8 +31188,7 @@ See [Extending GIO][extending-gio]. - + @@ -30152,28 +31200,25 @@ See [Extending GIO][extending-gio]. deprecated="1" deprecated-version="2.28"> Extension point for default handler to URI association. See [Extending GIO][extending-gio]. The #GDesktopAppInfoLookup interface is deprecated and unused by GIO. - + - + - + @@ -30182,8 +31227,7 @@ See [Extending GIO][extending-gio]. - + @@ -30194,17 +31238,15 @@ See [Extending GIO][extending-gio]. c:type="G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE" version="2.58"> The string used to obtain a Unix device path with g_drive_get_identifier(). - + - + @@ -30213,8 +31255,7 @@ See [Extending GIO][extending-gio]. - + @@ -30223,8 +31264,7 @@ See [Extending GIO][extending-gio]. - + @@ -30233,8 +31273,7 @@ See [Extending GIO][extending-gio]. - + @@ -30243,8 +31282,7 @@ See [Extending GIO][extending-gio]. - + @@ -30253,8 +31291,7 @@ See [Extending GIO][extending-gio]. - + @@ -30268,29 +31305,27 @@ See [Extending GIO][extending-gio]. glib:get-type="g_data_input_stream_get_type" glib:type-struct="DataInputStreamClass"> Data input stream implements #GInputStream and includes functions for -reading structured data directly from a binary input stream. - + filename="gio/gdatainputstream.c" + line="35">Data input stream implements [class@Gio.InputStream] and includes functions +for reading structured data directly from a binary input stream. + Creates a new data input stream for the @base_stream. - + filename="gio/gdatainputstream.c" + line="167">Creates a new data input stream for the @base_stream. + a new #GDataInputStream. + filename="gio/gdatainputstream.c" + line="173">a new #GDataInputStream. a #GInputStream. + filename="gio/gdatainputstream.c" + line="169">a #GInputStream. @@ -30299,21 +31334,20 @@ reading structured data directly from a binary input stream. c:identifier="g_data_input_stream_get_byte_order" glib:get-property="byte-order"> Gets the byte order for the data input stream. - + filename="gio/gdatainputstream.c" + line="216">Gets the byte order for the data input stream. + the @stream's current #GDataStreamByteOrder. + filename="gio/gdatainputstream.c" + line="222">the @stream's current #GDataStreamByteOrder. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="218">a given #GDataInputStream. @@ -30322,21 +31356,20 @@ reading structured data directly from a binary input stream. c:identifier="g_data_input_stream_get_newline_type" glib:get-property="newline-type"> Gets the current newline type for the @stream. - + filename="gio/gdatainputstream.c" + line="262">Gets the current newline type for the @stream. + #GDataStreamNewlineType for the given @stream. + filename="gio/gdatainputstream.c" + line="268">#GDataStreamNewlineType for the given @stream. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="264">a given #GDataInputStream. @@ -30345,22 +31378,21 @@ reading structured data directly from a binary input stream. c:identifier="g_data_input_stream_read_byte" throws="1"> Reads an unsigned 8-bit/1-byte value from @stream. - + filename="gio/gdatainputstream.c" + line="312">Reads an unsigned 8-bit/1-byte value from @stream. + an unsigned 8-bit/1-byte value read from the @stream or `0` + filename="gio/gdatainputstream.c" + line="320">an unsigned 8-bit/1-byte value read from the @stream or `0` if an error occurred. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="314">a given #GDataInputStream. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="315">optional #GCancellable object, %NULL to ignore. @@ -30378,25 +31410,24 @@ if an error occurred. c:identifier="g_data_input_stream_read_int16" throws="1"> Reads a 16-bit/2-byte value from @stream. + filename="gio/gdatainputstream.c" + line="339">Reads a 16-bit/2-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). - + a signed 16-bit/2-byte value read from @stream or `0` if + filename="gio/gdatainputstream.c" + line="350">a signed 16-bit/2-byte value read from @stream or `0` if an error occurred. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="341">a given #GDataInputStream. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="342">optional #GCancellable object, %NULL to ignore. @@ -30414,8 +31445,8 @@ an error occurred. c:identifier="g_data_input_stream_read_int32" throws="1"> Reads a signed 32-bit/4-byte value from @stream. + filename="gio/gdatainputstream.c" + line="427">Reads a signed 32-bit/4-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). @@ -30423,20 +31454,19 @@ see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order( If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a signed 32-bit/4-byte value read from the @stream or `0` if + filename="gio/gdatainputstream.c" + line="442">a signed 32-bit/4-byte value read from the @stream or `0` if an error occurred. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="429">a given #GDataInputStream. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="430">optional #GCancellable object, %NULL to ignore. @@ -30454,8 +31484,8 @@ an error occurred. c:identifier="g_data_input_stream_read_int64" throws="1"> Reads a 64-bit/8-byte value from @stream. + filename="gio/gdatainputstream.c" + line="523">Reads a 64-bit/8-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). @@ -30463,20 +31493,19 @@ see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order( If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a signed 64-bit/8-byte value read from @stream or `0` if + filename="gio/gdatainputstream.c" + line="538">a signed 64-bit/8-byte value read from @stream or `0` if an error occurred. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="525">a given #GDataInputStream. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="526">optional #GCancellable object, %NULL to ignore. + throws="1" + glib:async-func="read_line_async"> Reads a line from the data input stream. Note that no encoding + filename="gio/gdatainputstream.c" + line="717">Reads a line from the data input stream. Note that no encoding checks or conversion is performed; the input is not guaranteed to be UTF-8, and may in fact have embedded NUL characters. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + + filename="gio/gdatainputstream.c" + line="732"> a NUL terminated byte array with the line that was read in (without the newlines). Set @length to a #gsize to get the length of the read line. On an error, it will return %NULL and @error @@ -30520,8 +31549,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="719">a given #GDataInputStream. optional="1" allow-none="1"> a #gsize to get the length of the data read in. + filename="gio/gdatainputstream.c" + line="720">a #gsize to get the length of the data read in. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="721">optional #GCancellable object, %NULL to ignore. + version="2.20" + glib:finish-func="read_line_finish" + glib:sync-func="read_line"> The asynchronous version of g_data_input_stream_read_line(). It is + filename="gio/gdatainputstream.c" + line="1117">The asynchronous version of g_data_input_stream_read_line(). It is an error to have two outstanding calls to this function. When the operation is finished, @callback will be called. You can then call g_data_input_stream_read_line_finish() to get the result of the operation. - + a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="1119">a given #GDataInputStream. the [I/O priority][io-priority] of the request + filename="gio/gdatainputstream.c" + line="1120">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="1121">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> callback to call when the request is satisfied. + filename="gio/gdatainputstream.c" + line="1122">callback to call when the request is satisfied. nullable="1" allow-none="1"> the data to pass to callback function. + filename="gio/gdatainputstream.c" + line="1123">the data to pass to callback function. @@ -30611,17 +31641,16 @@ the result of the operation. version="2.20" throws="1"> Finish an asynchronous call started by + filename="gio/gdatainputstream.c" + line="1193">Finish an asynchronous call started by g_data_input_stream_read_line_async(). Note the warning about string encoding in g_data_input_stream_read_line() applies here as well. - + + filename="gio/gdatainputstream.c" + line="1205"> a NUL-terminated byte array with the line that was read in (without the newlines). Set @length to a #gsize to get the length of the read line. On an error, it will return %NULL and @error @@ -30634,14 +31663,14 @@ well. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="1195">a given #GDataInputStream. the #GAsyncResult that was provided to the callback. + filename="gio/gdatainputstream.c" + line="1196">the #GAsyncResult that was provided to the callback. optional="1" allow-none="1"> a #gsize to get the length of the data read in. + filename="gio/gdatainputstream.c" + line="1197">a #gsize to get the length of the data read in. @@ -30662,15 +31691,14 @@ well. version="2.30" throws="1"> Finish an asynchronous call started by + filename="gio/gdatainputstream.c" + line="1225">Finish an asynchronous call started by g_data_input_stream_read_line_async(). - + a string with the line that + filename="gio/gdatainputstream.c" + line="1235">a string with the line that was read in (without the newlines). Set @length to a #gsize to get the length of the read line. On an error, it will return %NULL and @error will be set. For UTF-8 conversion errors, the set @@ -30681,14 +31709,14 @@ g_data_input_stream_read_line_async(). a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="1227">a given #GDataInputStream. the #GAsyncResult that was provided to the callback. + filename="gio/gdatainputstream.c" + line="1228">the #GAsyncResult that was provided to the callback. optional="1" allow-none="1"> a #gsize to get the length of the data read in. + filename="gio/gdatainputstream.c" + line="1229">a #gsize to get the length of the data read in. @@ -30709,18 +31737,17 @@ g_data_input_stream_read_line_async(). version="2.30" throws="1"> Reads a UTF-8 encoded line from the data input stream. + filename="gio/gdatainputstream.c" + line="803">Reads a UTF-8 encoded line from the data input stream. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a NUL terminated UTF-8 string + filename="gio/gdatainputstream.c" + line="816">a NUL terminated UTF-8 string with the line that was read in (without the newlines). Set @length to a #gsize to get the length of the read line. On an error, it will return %NULL and @error will be set. For UTF-8 @@ -30732,8 +31759,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="805">a given #GDataInputStream. optional="1" allow-none="1"> a #gsize to get the length of the data read in. + filename="gio/gdatainputstream.c" + line="806">a #gsize to get the length of the data read in. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="807">optional #GCancellable object, %NULL to ignore. @@ -30762,25 +31789,24 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_data_input_stream_read_uint16" throws="1"> Reads an unsigned 16-bit/2-byte value from @stream. + filename="gio/gdatainputstream.c" + line="383">Reads an unsigned 16-bit/2-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). - + an unsigned 16-bit/2-byte value read from the @stream or `0` if + filename="gio/gdatainputstream.c" + line="394">an unsigned 16-bit/2-byte value read from the @stream or `0` if an error occurred. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="385">a given #GDataInputStream. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="386">optional #GCancellable object, %NULL to ignore. @@ -30798,8 +31824,8 @@ an error occurred. c:identifier="g_data_input_stream_read_uint32" throws="1"> Reads an unsigned 32-bit/4-byte value from @stream. + filename="gio/gdatainputstream.c" + line="475">Reads an unsigned 32-bit/4-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order(). @@ -30807,20 +31833,19 @@ see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order( If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + an unsigned 32-bit/4-byte value read from the @stream or `0` if + filename="gio/gdatainputstream.c" + line="490">an unsigned 32-bit/4-byte value read from the @stream or `0` if an error occurred. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="477">a given #GDataInputStream. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="478">optional #GCancellable object, %NULL to ignore. @@ -30838,8 +31863,8 @@ an error occurred. c:identifier="g_data_input_stream_read_uint64" throws="1"> Reads an unsigned 64-bit/8-byte value from @stream. + filename="gio/gdatainputstream.c" + line="571">Reads an unsigned 64-bit/8-byte value from @stream. In order to get the correct byte order for this read operation, see g_data_input_stream_get_byte_order(). @@ -30847,20 +31872,19 @@ see g_data_input_stream_get_byte_order(). If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + an unsigned 64-bit/8-byte read from @stream or `0` if + filename="gio/gdatainputstream.c" + line="586">an unsigned 64-bit/8-byte read from @stream or `0` if an error occurred. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="573">a given #GDataInputStream. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="574">optional #GCancellable object, %NULL to ignore. @@ -30878,10 +31902,11 @@ an error occurred. c:identifier="g_data_input_stream_read_until" deprecated="1" deprecated-version="2.56" - throws="1"> + throws="1" + glib:async-func="read_until_async"> Reads a string from the data input stream, up to the first + filename="gio/gdatainputstream.c" + line="888">Reads a string from the data input stream, up to the first occurrence of any of the stop characters. Note that, in contrast to g_data_input_stream_read_until_async(), @@ -30894,12 +31919,11 @@ g_data_input_stream_read_upto() instead, but note that that function does not consume the stop character. Use g_data_input_stream_read_upto() instead, which has more consistent behaviour regarding the stop character. - + a string with the data that was read + filename="gio/gdatainputstream.c" + line="908">a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error. @@ -30908,14 +31932,14 @@ does not consume the stop character. a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="890">a given #GDataInputStream. characters to terminate the read. + filename="gio/gdatainputstream.c" + line="891">characters to terminate the read. optional="1" allow-none="1"> a #gsize to get the length of the data read in. + filename="gio/gdatainputstream.c" + line="892">a #gsize to get the length of the data read in. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="893">optional #GCancellable object, %NULL to ignore. @@ -30944,10 +31968,12 @@ does not consume the stop character. c:identifier="g_data_input_stream_read_until_async" version="2.20" deprecated="1" - deprecated-version="2.56"> + deprecated-version="2.56" + glib:finish-func="read_until_finish" + glib:sync-func="read_until"> The asynchronous version of g_data_input_stream_read_until(). + filename="gio/gdatainputstream.c" + line="1148">The asynchronous version of g_data_input_stream_read_until(). It is an error to have two outstanding calls to this function. Note that, in contrast to g_data_input_stream_read_until(), @@ -30964,28 +31990,27 @@ will be marked as deprecated in a future release. Use g_data_input_stream_read_upto_async() instead. Use g_data_input_stream_read_upto_async() instead, which has more consistent behaviour regarding the stop character. - + a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="1150">a given #GDataInputStream. characters to terminate the read. + filename="gio/gdatainputstream.c" + line="1151">characters to terminate the read. the [I/O priority][io-priority] of the request + filename="gio/gdatainputstream.c" + line="1152">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdatainputstream.c" + line="1153">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> callback to call when the request is satisfied. + filename="gio/gdatainputstream.c" + line="1154">callback to call when the request is satisfied. nullable="1" allow-none="1"> the data to pass to callback function. + filename="gio/gdatainputstream.c" + line="1155">the data to pass to callback function. @@ -31026,17 +32051,16 @@ g_data_input_stream_read_upto_async() instead. deprecated-version="2.56" throws="1"> Finish an asynchronous call started by + filename="gio/gdatainputstream.c" + line="1267">Finish an asynchronous call started by g_data_input_stream_read_until_async(). Use g_data_input_stream_read_upto_finish() instead, which has more consistent behaviour regarding the stop character. - + a string with the data that was read + filename="gio/gdatainputstream.c" + line="1279">a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error. @@ -31045,14 +32069,14 @@ g_data_input_stream_read_until_async(). a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="1269">a given #GDataInputStream. the #GAsyncResult that was provided to the callback. + filename="gio/gdatainputstream.c" + line="1270">the #GAsyncResult that was provided to the callback. optional="1" allow-none="1"> a #gsize to get the length of the data read in. + filename="gio/gdatainputstream.c" + line="1271">a #gsize to get the length of the data read in. @@ -31071,10 +32095,11 @@ g_data_input_stream_read_until_async(). + throws="1" + glib:async-func="read_upto_async"> Reads a string from the data input stream, up to the first + filename="gio/gdatainputstream.c" + line="1297">Reads a string from the data input stream, up to the first occurrence of any of the stop characters. In contrast to g_data_input_stream_read_until(), this function @@ -31086,12 +32111,11 @@ Note that @stop_chars may contain '\0' if @stop_chars_len is specified. The returned string will always be nul-terminated on success. - + a string with the data that was read + filename="gio/gdatainputstream.c" + line="1320">a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error @@ -31100,20 +32124,20 @@ The returned string will always be nul-terminated on success. a #GDataInputStream + filename="gio/gdatainputstream.c" + line="1299">a #GDataInputStream characters to terminate the read + filename="gio/gdatainputstream.c" + line="1300">characters to terminate the read length of @stop_chars. May be -1 if @stop_chars is + filename="gio/gdatainputstream.c" + line="1301">length of @stop_chars. May be -1 if @stop_chars is nul-terminated @@ -31124,8 +32148,8 @@ The returned string will always be nul-terminated on success. optional="1" allow-none="1"> a #gsize to get the length of the data read in + filename="gio/gdatainputstream.c" + line="1303">a #gsize to get the length of the data read in nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gdatainputstream.c" + line="1304">optional #GCancellable object, %NULL to ignore + version="2.26" + glib:finish-func="read_upto_finish" + glib:sync-func="read_upto"> The asynchronous version of g_data_input_stream_read_upto(). + filename="gio/gdatainputstream.c" + line="1394">The asynchronous version of g_data_input_stream_read_upto(). It is an error to have two outstanding calls to this function. In contrast to g_data_input_stream_read_until(), this function @@ -31158,35 +32184,34 @@ specified. When the operation is finished, @callback will be called. You can then call g_data_input_stream_read_upto_finish() to get the result of the operation. - + a #GDataInputStream + filename="gio/gdatainputstream.c" + line="1396">a #GDataInputStream characters to terminate the read + filename="gio/gdatainputstream.c" + line="1397">characters to terminate the read length of @stop_chars. May be -1 if @stop_chars is + filename="gio/gdatainputstream.c" + line="1398">length of @stop_chars. May be -1 if @stop_chars is nul-terminated the [I/O priority][io-priority] of the request + filename="gio/gdatainputstream.c" + line="1400">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gdatainputstream.c" + line="1401">optional #GCancellable object, %NULL to ignore scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/gdatainputstream.c" + line="1402">callback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gdatainputstream.c" + line="1403">the data to pass to callback function @@ -31225,8 +32250,8 @@ the result of the operation. version="2.24" throws="1"> Finish an asynchronous call started by + filename="gio/gdatainputstream.c" + line="1439">Finish an asynchronous call started by g_data_input_stream_read_upto_async(). Note that this function does not consume the stop character. You @@ -31234,12 +32259,11 @@ have to use g_data_input_stream_read_byte() to get it before calling g_data_input_stream_read_upto_async() again. The returned string will always be nul-terminated on success. - + a string with the data that was read + filename="gio/gdatainputstream.c" + line="1455">a string with the data that was read before encountering any of the stop characters. Set @length to a #gsize to get the length of the string. This function will return %NULL on an error. @@ -31248,14 +32272,14 @@ The returned string will always be nul-terminated on success. a #GDataInputStream + filename="gio/gdatainputstream.c" + line="1441">a #GDataInputStream the #GAsyncResult that was provided to the callback + filename="gio/gdatainputstream.c" + line="1442">the #GAsyncResult that was provided to the callback optional="1" allow-none="1"> a #gsize to get the length of the data read in + filename="gio/gdatainputstream.c" + line="1443">a #gsize to get the length of the data read in @@ -31275,25 +32299,24 @@ The returned string will always be nul-terminated on success. c:identifier="g_data_input_stream_set_byte_order" glib:set-property="byte-order"> This function sets the byte order for the given @stream. All subsequent + filename="gio/gdatainputstream.c" + line="189">This function sets the byte order for the given @stream. All subsequent reads from the @stream will be read in the given @order. - + a given #GDataInputStream. + filename="gio/gdatainputstream.c" + line="191">a given #GDataInputStream. a #GDataStreamByteOrder to set. + filename="gio/gdatainputstream.c" + line="192">a #GDataStreamByteOrder to set. @@ -31302,28 +32325,27 @@ reads from the @stream will be read in the given @order. c:identifier="g_data_input_stream_set_newline_type" glib:set-property="newline-type"> Sets the newline type for the @stream. + filename="gio/gdatainputstream.c" + line="232">Sets the newline type for the @stream. Note that using G_DATA_STREAM_NEWLINE_TYPE_ANY is slightly unsafe. If a read chunk ends in "CR" we must read an additional byte to know if this is "CR" or "CR LF", and this might block if there is no more data available. - + a #GDataInputStream. + filename="gio/gdatainputstream.c" + line="234">a #GDataInputStream. the type of new line return as #GDataStreamNewlineType. + filename="gio/gdatainputstream.c" + line="235">the type of new line return as #GDataStreamNewlineType. @@ -31336,8 +32358,8 @@ chunk ends in "CR" we must read an additional byte to know if this is "CR" or getter="get_byte_order" default-value="G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN"> The :byte-order property determines the byte ordering that + filename="gio/gdatainputstream.c" + line="76">The :byte-order property determines the byte ordering that is used when reading multi-byte entities (such as integers) from the stream. @@ -31349,8 +32371,8 @@ from the stream. getter="get_newline_type" default-value="G_DATA_STREAM_NEWLINE_TYPE_LF"> The :newline-type property determines what is considered + filename="gio/gdatainputstream.c" + line="90">The :newline-type property determines what is considered as a line ending when reading complete lines from the stream. @@ -31364,16 +32386,14 @@ as a line ending when reading complete lines from the stream. - + - + @@ -31381,8 +32401,7 @@ as a line ending when reading complete lines from the stream. - + @@ -31390,8 +32409,7 @@ as a line ending when reading complete lines from the stream. - + @@ -31399,8 +32417,7 @@ as a line ending when reading complete lines from the stream. - + @@ -31408,8 +32425,7 @@ as a line ending when reading complete lines from the stream. - + @@ -31420,8 +32436,7 @@ as a line ending when reading complete lines from the stream. c:type="GDataInputStreamPrivate" disguised="1" opaque="1"> - + glib:get-type="g_data_output_stream_get_type" glib:type-struct="DataOutputStreamClass"> Data output stream implements #GOutputStream and includes functions for -writing data directly to an output stream. - + filename="gio/gdataoutputstream.c" + line="32">Data output stream implements [class@Gio.OutputStream] and includes functions +for writing data directly to an output stream. + Creates a new data output stream for @base_stream. - + filename="gio/gdataoutputstream.c" + line="167">Creates a new data output stream for @base_stream. + #GDataOutputStream. + filename="gio/gdataoutputstream.c" + line="173">#GDataOutputStream. a #GOutputStream. + filename="gio/gdataoutputstream.c" + line="169">a #GOutputStream. @@ -31462,21 +32475,20 @@ writing data directly to an output stream. c:identifier="g_data_output_stream_get_byte_order" glib:get-property="byte-order"> Gets the byte order for the stream. - + filename="gio/gdataoutputstream.c" + line="210">Gets the byte order for the stream. + the #GDataStreamByteOrder for the @stream. + filename="gio/gdataoutputstream.c" + line="216">the #GDataStreamByteOrder for the @stream. a #GDataOutputStream. + filename="gio/gdataoutputstream.c" + line="212">a #GDataOutputStream. @@ -31485,27 +32497,26 @@ writing data directly to an output stream. c:identifier="g_data_output_stream_put_byte" throws="1"> Puts a byte into the output stream. - + filename="gio/gdataoutputstream.c" + line="226">Puts a byte into the output stream. + %TRUE if @data was successfully added to the @stream. + filename="gio/gdataoutputstream.c" + line="235">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + filename="gio/gdataoutputstream.c" + line="228">a #GDataOutputStream. a #guchar. + filename="gio/gdataoutputstream.c" + line="229">a #guchar. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdataoutputstream.c" + line="230">optional #GCancellable object, %NULL to ignore. @@ -31523,27 +32534,26 @@ writing data directly to an output stream. c:identifier="g_data_output_stream_put_int16" throws="1"> Puts a signed 16-bit integer into the output stream. - + filename="gio/gdataoutputstream.c" + line="253">Puts a signed 16-bit integer into the output stream. + %TRUE if @data was successfully added to the @stream. + filename="gio/gdataoutputstream.c" + line="262">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + filename="gio/gdataoutputstream.c" + line="255">a #GDataOutputStream. a #gint16. + filename="gio/gdataoutputstream.c" + line="256">a #gint16. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdataoutputstream.c" + line="257">optional #GCancellable object, %NULL to ignore. @@ -31561,27 +32571,26 @@ writing data directly to an output stream. c:identifier="g_data_output_stream_put_int32" throws="1"> Puts a signed 32-bit integer into the output stream. - + filename="gio/gdataoutputstream.c" + line="333">Puts a signed 32-bit integer into the output stream. + %TRUE if @data was successfully added to the @stream. + filename="gio/gdataoutputstream.c" + line="342">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + filename="gio/gdataoutputstream.c" + line="335">a #GDataOutputStream. a #gint32. + filename="gio/gdataoutputstream.c" + line="336">a #gint32. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdataoutputstream.c" + line="337">optional #GCancellable object, %NULL to ignore. @@ -31599,27 +32608,26 @@ writing data directly to an output stream. c:identifier="g_data_output_stream_put_int64" throws="1"> Puts a signed 64-bit integer into the stream. - + filename="gio/gdataoutputstream.c" + line="413">Puts a signed 64-bit integer into the stream. + %TRUE if @data was successfully added to the @stream. + filename="gio/gdataoutputstream.c" + line="422">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + filename="gio/gdataoutputstream.c" + line="415">a #GDataOutputStream. a #gint64. + filename="gio/gdataoutputstream.c" + line="416">a #gint64. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdataoutputstream.c" + line="417">optional #GCancellable object, %NULL to ignore. @@ -31637,27 +32645,26 @@ writing data directly to an output stream. c:identifier="g_data_output_stream_put_string" throws="1"> Puts a string into the output stream. - + filename="gio/gdataoutputstream.c" + line="493">Puts a string into the output stream. + %TRUE if @string was successfully added to the @stream. + filename="gio/gdataoutputstream.c" + line="502">%TRUE if @string was successfully added to the @stream. a #GDataOutputStream. + filename="gio/gdataoutputstream.c" + line="495">a #GDataOutputStream. a string. + filename="gio/gdataoutputstream.c" + line="496">a string. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdataoutputstream.c" + line="497">optional #GCancellable object, %NULL to ignore. @@ -31675,27 +32682,26 @@ writing data directly to an output stream. c:identifier="g_data_output_stream_put_uint16" throws="1"> Puts an unsigned 16-bit integer into the output stream. - + filename="gio/gdataoutputstream.c" + line="293">Puts an unsigned 16-bit integer into the output stream. + %TRUE if @data was successfully added to the @stream. + filename="gio/gdataoutputstream.c" + line="302">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + filename="gio/gdataoutputstream.c" + line="295">a #GDataOutputStream. a #guint16. + filename="gio/gdataoutputstream.c" + line="296">a #guint16. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdataoutputstream.c" + line="297">optional #GCancellable object, %NULL to ignore. @@ -31713,27 +32719,26 @@ writing data directly to an output stream. c:identifier="g_data_output_stream_put_uint32" throws="1"> Puts an unsigned 32-bit integer into the stream. - + filename="gio/gdataoutputstream.c" + line="373">Puts an unsigned 32-bit integer into the stream. + %TRUE if @data was successfully added to the @stream. + filename="gio/gdataoutputstream.c" + line="382">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + filename="gio/gdataoutputstream.c" + line="375">a #GDataOutputStream. a #guint32. + filename="gio/gdataoutputstream.c" + line="376">a #guint32. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdataoutputstream.c" + line="377">optional #GCancellable object, %NULL to ignore. @@ -31751,27 +32756,26 @@ writing data directly to an output stream. c:identifier="g_data_output_stream_put_uint64" throws="1"> Puts an unsigned 64-bit integer into the stream. - + filename="gio/gdataoutputstream.c" + line="453">Puts an unsigned 64-bit integer into the stream. + %TRUE if @data was successfully added to the @stream. + filename="gio/gdataoutputstream.c" + line="462">%TRUE if @data was successfully added to the @stream. a #GDataOutputStream. + filename="gio/gdataoutputstream.c" + line="455">a #GDataOutputStream. a #guint64. + filename="gio/gdataoutputstream.c" + line="456">a #guint64. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdataoutputstream.c" + line="457">optional #GCancellable object, %NULL to ignore. @@ -31789,24 +32793,23 @@ writing data directly to an output stream. c:identifier="g_data_output_stream_set_byte_order" glib:set-property="byte-order"> Sets the byte order of the data output stream to @order. - + filename="gio/gdataoutputstream.c" + line="189">Sets the byte order of the data output stream to @order. + a #GDataOutputStream. + filename="gio/gdataoutputstream.c" + line="191">a #GDataOutputStream. a %GDataStreamByteOrder. + filename="gio/gdataoutputstream.c" + line="192">a %GDataStreamByteOrder. @@ -31818,8 +32821,8 @@ writing data directly to an output stream. getter="get_byte_order" default-value="G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN"> Determines the byte ordering that is used when writing + filename="gio/gdataoutputstream.c" + line="89">Determines the byte ordering that is used when writing multi-byte entities (such as integers) to the stream. @@ -31834,16 +32837,14 @@ multi-byte entities (such as integers) to the stream. - + - + @@ -31851,8 +32852,7 @@ multi-byte entities (such as integers) to the stream. - + @@ -31860,8 +32860,7 @@ multi-byte entities (such as integers) to the stream. - + @@ -31869,8 +32868,7 @@ multi-byte entities (such as integers) to the stream. - + @@ -31878,8 +32876,7 @@ multi-byte entities (such as integers) to the stream. - + @@ -31890,15 +32887,14 @@ multi-byte entities (such as integers) to the stream. c:type="GDataOutputStreamPrivate" disguised="1" opaque="1"> - + #GDataStreamByteOrder is used to ensure proper endianness of streaming data sources across various machine architectures. glib:nick="big-endian" glib:name="G_DATA_STREAM_BYTE_ORDER_BIG_ENDIAN"> Selects Big Endian byte order. glib:nick="little-endian" glib:name="G_DATA_STREAM_BYTE_ORDER_LITTLE_ENDIAN"> Selects Little Endian byte order. glib:nick="host-endian" glib:name="G_DATA_STREAM_BYTE_ORDER_HOST_ENDIAN"> Selects endianness based on host machine's architecture. @@ -31934,7 +32930,7 @@ across various machine architectures. glib:get-type="g_data_stream_newline_type_get_type" c:type="GDataStreamNewlineType"> #GDataStreamNewlineType is used when checking for or setting the line endings for a given file. glib:nick="lf" glib:name="G_DATA_STREAM_NEWLINE_TYPE_LF"> Selects "LF" line endings, common on most modern UNIX platforms. glib:nick="cr" glib:name="G_DATA_STREAM_NEWLINE_TYPE_CR"> Selects "CR" line endings. glib:nick="cr-lf" glib:name="G_DATA_STREAM_NEWLINE_TYPE_CR_LF"> Selects "CR, LF" line ending, common on Microsoft Windows. glib:nick="any" glib:name="G_DATA_STREAM_NEWLINE_TYPE_ANY"> Automatically try to handle any line ending type. @@ -31981,62 +32977,63 @@ across various machine architectures. glib:get-type="g_datagram_based_get_type" glib:type-struct="DatagramBasedInterface"> A #GDatagramBased is a networking interface for representing datagram-based + filename="gio/gdatagrambased.c" + line="34">Interface for socket-like objects with datagram semantics. + +A `GDatagramBased` is a networking interface for representing datagram-based communications. It is a more or less direct mapping of the core parts of the BSD socket API in a portable GObject interface. It is implemented by -#GSocket, which wraps the UNIX socket API on UNIX and winsock2 on Windows. +[class@Gio.Socket], which wraps the UNIX socket API on UNIX and winsock2 on Windows. -#GDatagramBased is entirely platform independent, and is intended to be used -alongside higher-level networking APIs such as #GIOStream. +`GDatagramBased` is entirely platform independent, and is intended to be used +alongside higher-level networking APIs such as [class@Gio.IOStream]. It uses vectored scatter/gather I/O by default, allowing for many messages to be sent or received in a single call. Where possible, implementations of the interface should take advantage of vectored I/O to minimise processing -or system calls. For example, #GSocket uses recvmmsg() and sendmmsg() where -possible. Callers should take advantage of scatter/gather I/O (the use of +or system calls. For example, `GSocket` uses `recvmmsg()` and `sendmmsg()` +where possible. Callers should take advantage of scatter/gather I/O (the use of multiple buffers per message) to avoid unnecessary copying of data to assemble or disassemble a message. -Each #GDatagramBased operation has a timeout parameter which may be negative +Each `GDatagramBased` operation has a timeout parameter which may be negative for blocking behaviour, zero for non-blocking behaviour, or positive for timeout behaviour. A blocking operation blocks until finished or there is an error. A non-blocking operation will return immediately with a -%G_IO_ERROR_WOULD_BLOCK error if it cannot make progress. A timeout operation +`G_IO_ERROR_WOULD_BLOCK` error if it cannot make progress. A timeout operation will block until the operation is complete or the timeout expires; if the timeout expires it will return what progress it made, or -%G_IO_ERROR_TIMED_OUT if no progress was made. To know when a call would -successfully run you can call g_datagram_based_condition_check() or -g_datagram_based_condition_wait(). You can also use -g_datagram_based_create_source() and attach it to a #GMainContext to get -callbacks when I/O is possible. +`G_IO_ERROR_TIMED_OUT` if no progress was made. To know when a call would +successfully run you can call [method@Gio.DatagramBased.condition_check] or +[method@Gio.DatagramBased.condition_wait]. You can also use +[method@Gio.DatagramBased.create_source] and attach it to a [struct@GLib.MainContext] +to get callbacks when I/O is possible. When running a non-blocking operation applications should always be able to -handle getting a %G_IO_ERROR_WOULD_BLOCK error even when some other function +handle getting a `G_IO_ERROR_WOULD_BLOCK` error even when some other function said that I/O was possible. This can easily happen in case of a race condition in the application, but it can also happen for other reasons. For instance, on Windows a socket is always seen as writable until a write -returns %G_IO_ERROR_WOULD_BLOCK. +returns `G_IO_ERROR_WOULD_BLOCK`. -As with #GSocket, #GDatagramBaseds can be either connection oriented (for -example, SCTP) or connectionless (for example, UDP). #GDatagramBaseds must be +As with `GSocket`, `GDatagramBased`s can be either connection oriented (for +example, SCTP) or connectionless (for example, UDP). `GDatagramBased`s must be datagram-based, not stream-based. The interface does not cover connection establishment — use methods on the underlying type to establish a connection -before sending and receiving data through the #GDatagramBased API. For +before sending and receiving data through the `GDatagramBased` API. For connectionless socket types the target/source address is specified or received in each I/O operation. -Like most other APIs in GLib, #GDatagramBased is not inherently thread safe. -To use a #GDatagramBased concurrently from multiple threads, you must +Like most other APIs in GLib, `GDatagramBased` is not inherently thread safe. +To use a `GDatagramBased` concurrently from multiple threads, you must implement your own locking. - + Checks on the readiness of @datagram_based to perform operations. The + filename="gio/gdatagrambased.c" + line="353">Checks on the readiness of @datagram_based to perform operations. The operations specified in @condition are checked for and masked against the currently-satisfied conditions on @datagram_based. The result is returned. @@ -32072,25 +33069,24 @@ conditions will always be set in the output if they are true. Apart from these flags, the output is guaranteed to be masked by @condition. This call never blocks. - + the #GIOCondition mask of the current state + filename="gio/gdatagrambased.c" + line="395">the #GIOCondition mask of the current state a #GDatagramBased + filename="gio/gdatagrambased.c" + line="355">a #GDatagramBased a #GIOCondition mask to check + filename="gio/gdatagrambased.c" + line="356">a #GIOCondition mask to check @@ -32100,38 +33096,37 @@ This call never blocks. version="2.48" throws="1"> Waits for up to @timeout microseconds for condition to become true on + filename="gio/gdatagrambased.c" + line="426">Waits for up to @timeout microseconds for condition to become true on @datagram_based. If the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if @timeout is reached before the condition is met, then %FALSE is returned and @error is set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). - + %TRUE if the condition was met, %FALSE otherwise + filename="gio/gdatagrambased.c" + line="442">%TRUE if the condition was met, %FALSE otherwise a #GDatagramBased + filename="gio/gdatagrambased.c" + line="428">a #GDatagramBased a #GIOCondition mask to wait for + filename="gio/gdatagrambased.c" + line="429">a #GIOCondition mask to wait for the maximum time (in microseconds) to wait, 0 to not block, or -1 + filename="gio/gdatagrambased.c" + line="430">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -32140,8 +33135,8 @@ set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). nullable="1" allow-none="1"> a #GCancellable + filename="gio/gdatagrambased.c" + line="432">a #GCancellable @@ -32150,8 +33145,8 @@ set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). invoker="create_source" version="2.48"> Creates a #GSource that can be attached to a #GMainContext to monitor for + filename="gio/gdatagrambased.c" + line="311">Creates a #GSource that can be attached to a #GMainContext to monitor for the availability of the specified @condition on the #GDatagramBased. The #GSource keeps a reference to the @datagram_based. @@ -32165,25 +33160,24 @@ cause the source to trigger, reporting the current condition (which is likely 0 unless cancellation happened at the same time as a condition change). You can check for this in the callback using g_cancellable_is_cancelled(). - + a newly allocated #GSource + filename="gio/gdatagrambased.c" + line="332">a newly allocated #GSource a #GDatagramBased + filename="gio/gdatagrambased.c" + line="313">a #GDatagramBased a #GIOCondition mask to monitor + filename="gio/gdatagrambased.c" + line="314">a #GIOCondition mask to monitor nullable="1" allow-none="1"> a #GCancellable + filename="gio/gdatagrambased.c" + line="315">a #GCancellable @@ -32202,8 +33196,8 @@ g_cancellable_is_cancelled(). version="2.48" throws="1"> Receive one or more data messages from @datagram_based in one go. + filename="gio/gdatagrambased.c" + line="98">Receive one or more data messages from @datagram_based in one go. @messages must point to an array of #GInputMessage structs and @num_messages must be the length of this array. Each #GInputMessage @@ -32253,12 +33247,11 @@ be returned if zero messages could be received; otherwise the number of messages successfully received before the error will be returned. If @cancellable is cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. - + number of messages received, or -1 on error. Note that the number + filename="gio/gdatagrambased.c" + line="160">number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if @timeout is zero or positive, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -32268,34 +33261,34 @@ other error. a #GDatagramBased + filename="gio/gdatagrambased.c" + line="100">a #GDatagramBased an array of #GInputMessage structs + filename="gio/gdatagrambased.c" + line="101">an array of #GInputMessage structs the number of elements in @messages + filename="gio/gdatagrambased.c" + line="102">the number of elements in @messages an int containing #GSocketMsgFlags flags for the overall operation + filename="gio/gdatagrambased.c" + line="103">an int containing #GSocketMsgFlags flags for the overall operation the maximum time (in microseconds) to wait, 0 to not block, or -1 + filename="gio/gdatagrambased.c" + line="104">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -32304,8 +33297,8 @@ other error. nullable="1" allow-none="1"> a %GCancellable + filename="gio/gdatagrambased.c" + line="106">a %GCancellable @@ -32315,8 +33308,8 @@ other error. version="2.48" throws="1"> Send one or more data messages from @datagram_based in one go. + filename="gio/gdatagrambased.c" + line="209">Send one or more data messages from @datagram_based in one go. @messages must point to an array of #GOutputMessage structs and @num_messages must be the length of this array. Each #GOutputMessage @@ -32357,12 +33350,11 @@ On error -1 is returned and @error is set accordingly. An error will only be returned if zero messages could be sent; otherwise the number of messages successfully sent before the error will be returned. If @cancellable is cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. - + number of messages sent, or -1 on error. Note that the number of + filename="gio/gdatagrambased.c" + line="262">number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if @timeout is zero or positive, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try to send the remaining messages. @@ -32371,34 +33363,34 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. a #GDatagramBased + filename="gio/gdatagrambased.c" + line="211">a #GDatagramBased an array of #GOutputMessage structs + filename="gio/gdatagrambased.c" + line="212">an array of #GOutputMessage structs the number of elements in @messages + filename="gio/gdatagrambased.c" + line="213">the number of elements in @messages an int containing #GSocketMsgFlags flags + filename="gio/gdatagrambased.c" + line="214">an int containing #GSocketMsgFlags flags the maximum time (in microseconds) to wait, 0 to not block, or -1 + filename="gio/gdatagrambased.c" + line="215">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -32407,8 +33399,8 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. nullable="1" allow-none="1"> a %GCancellable + filename="gio/gdatagrambased.c" + line="217">a %GCancellable @@ -32417,8 +33409,8 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. c:identifier="g_datagram_based_condition_check" version="2.48"> Checks on the readiness of @datagram_based to perform operations. The + filename="gio/gdatagrambased.c" + line="353">Checks on the readiness of @datagram_based to perform operations. The operations specified in @condition are checked for and masked against the currently-satisfied conditions on @datagram_based. The result is returned. @@ -32454,25 +33446,24 @@ conditions will always be set in the output if they are true. Apart from these flags, the output is guaranteed to be masked by @condition. This call never blocks. - + the #GIOCondition mask of the current state + filename="gio/gdatagrambased.c" + line="395">the #GIOCondition mask of the current state a #GDatagramBased + filename="gio/gdatagrambased.c" + line="355">a #GDatagramBased a #GIOCondition mask to check + filename="gio/gdatagrambased.c" + line="356">a #GIOCondition mask to check @@ -32482,38 +33473,37 @@ This call never blocks. version="2.48" throws="1"> Waits for up to @timeout microseconds for condition to become true on + filename="gio/gdatagrambased.c" + line="426">Waits for up to @timeout microseconds for condition to become true on @datagram_based. If the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if @timeout is reached before the condition is met, then %FALSE is returned and @error is set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). - + %TRUE if the condition was met, %FALSE otherwise + filename="gio/gdatagrambased.c" + line="442">%TRUE if the condition was met, %FALSE otherwise a #GDatagramBased + filename="gio/gdatagrambased.c" + line="428">a #GDatagramBased a #GIOCondition mask to wait for + filename="gio/gdatagrambased.c" + line="429">a #GIOCondition mask to wait for the maximum time (in microseconds) to wait, 0 to not block, or -1 + filename="gio/gdatagrambased.c" + line="430">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -32522,8 +33512,8 @@ set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). nullable="1" allow-none="1"> a #GCancellable + filename="gio/gdatagrambased.c" + line="432">a #GCancellable @@ -32532,8 +33522,8 @@ set appropriately (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). c:identifier="g_datagram_based_create_source" version="2.48"> Creates a #GSource that can be attached to a #GMainContext to monitor for + filename="gio/gdatagrambased.c" + line="311">Creates a #GSource that can be attached to a #GMainContext to monitor for the availability of the specified @condition on the #GDatagramBased. The #GSource keeps a reference to the @datagram_based. @@ -32547,25 +33537,24 @@ cause the source to trigger, reporting the current condition (which is likely 0 unless cancellation happened at the same time as a condition change). You can check for this in the callback using g_cancellable_is_cancelled(). - + a newly allocated #GSource + filename="gio/gdatagrambased.c" + line="332">a newly allocated #GSource a #GDatagramBased + filename="gio/gdatagrambased.c" + line="313">a #GDatagramBased a #GIOCondition mask to monitor + filename="gio/gdatagrambased.c" + line="314">a #GIOCondition mask to monitor nullable="1" allow-none="1"> a #GCancellable + filename="gio/gdatagrambased.c" + line="315">a #GCancellable @@ -32584,8 +33573,8 @@ g_cancellable_is_cancelled(). version="2.48" throws="1"> Receive one or more data messages from @datagram_based in one go. + filename="gio/gdatagrambased.c" + line="98">Receive one or more data messages from @datagram_based in one go. @messages must point to an array of #GInputMessage structs and @num_messages must be the length of this array. Each #GInputMessage @@ -32635,12 +33624,11 @@ be returned if zero messages could be received; otherwise the number of messages successfully received before the error will be returned. If @cancellable is cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. - + number of messages received, or -1 on error. Note that the number + filename="gio/gdatagrambased.c" + line="160">number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if @timeout is zero or positive, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -32650,34 +33638,34 @@ other error. a #GDatagramBased + filename="gio/gdatagrambased.c" + line="100">a #GDatagramBased an array of #GInputMessage structs + filename="gio/gdatagrambased.c" + line="101">an array of #GInputMessage structs the number of elements in @messages + filename="gio/gdatagrambased.c" + line="102">the number of elements in @messages an int containing #GSocketMsgFlags flags for the overall operation + filename="gio/gdatagrambased.c" + line="103">an int containing #GSocketMsgFlags flags for the overall operation the maximum time (in microseconds) to wait, 0 to not block, or -1 + filename="gio/gdatagrambased.c" + line="104">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -32686,8 +33674,8 @@ other error. nullable="1" allow-none="1"> a %GCancellable + filename="gio/gdatagrambased.c" + line="106">a %GCancellable @@ -32697,8 +33685,8 @@ other error. version="2.48" throws="1"> Send one or more data messages from @datagram_based in one go. + filename="gio/gdatagrambased.c" + line="209">Send one or more data messages from @datagram_based in one go. @messages must point to an array of #GOutputMessage structs and @num_messages must be the length of this array. Each #GOutputMessage @@ -32739,12 +33727,11 @@ On error -1 is returned and @error is set accordingly. An error will only be returned if zero messages could be sent; otherwise the number of messages successfully sent before the error will be returned. If @cancellable is cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. - + number of messages sent, or -1 on error. Note that the number of + filename="gio/gdatagrambased.c" + line="262">number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if @timeout is zero or positive, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try to send the remaining messages. @@ -32753,34 +33740,34 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. a #GDatagramBased + filename="gio/gdatagrambased.c" + line="211">a #GDatagramBased an array of #GOutputMessage structs + filename="gio/gdatagrambased.c" + line="212">an array of #GOutputMessage structs the number of elements in @messages + filename="gio/gdatagrambased.c" + line="213">the number of elements in @messages an int containing #GSocketMsgFlags flags + filename="gio/gdatagrambased.c" + line="214">an int containing #GSocketMsgFlags flags the maximum time (in microseconds) to wait, 0 to not block, or -1 + filename="gio/gdatagrambased.c" + line="215">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -32789,8 +33776,8 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. nullable="1" allow-none="1"> a %GCancellable + filename="gio/gdatagrambased.c" + line="217">a %GCancellable @@ -32801,28 +33788,29 @@ cancelled, %G_IO_ERROR_CANCELLED is returned as with any other error. glib:is-gtype-struct-for="DatagramBased" version="2.48"> Provides an interface for socket-like objects which have datagram semantics, + filename="gio/gdatagrambased.h" + line="46">Provides an interface for socket-like objects which have datagram semantics, following the Berkeley sockets API. The interface methods are thin wrappers around the corresponding virtual methods, and no pre-processing of inputs is implemented — so implementations of this API must handle all functionality documented in the interface methods. - + The parent interface. + filename="gio/gdatagrambased.h" + line="48">The parent interface. + Virtual method for g_datagram_based_receive_messages(). - + number of messages received, or -1 on error. Note that the number + filename="gio/gdatagrambased.c" + line="160">number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if @timeout is zero or positive, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -32832,34 +33820,34 @@ documented in the interface methods. a #GDatagramBased + filename="gio/gdatagrambased.c" + line="100">a #GDatagramBased an array of #GInputMessage structs + filename="gio/gdatagrambased.c" + line="101">an array of #GInputMessage structs the number of elements in @messages + filename="gio/gdatagrambased.c" + line="102">the number of elements in @messages an int containing #GSocketMsgFlags flags for the overall operation + filename="gio/gdatagrambased.c" + line="103">an int containing #GSocketMsgFlags flags for the overall operation the maximum time (in microseconds) to wait, 0 to not block, or -1 + filename="gio/gdatagrambased.c" + line="104">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -32868,21 +33856,23 @@ documented in the interface methods. nullable="1" allow-none="1"> a %GCancellable + filename="gio/gdatagrambased.c" + line="106">a %GCancellable + Virtual method for g_datagram_based_send_messages(). - + number of messages sent, or -1 on error. Note that the number of + filename="gio/gdatagrambased.c" + line="262">number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if @timeout is zero or positive, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try to send the remaining messages. @@ -32891,34 +33881,34 @@ documented in the interface methods. a #GDatagramBased + filename="gio/gdatagrambased.c" + line="211">a #GDatagramBased an array of #GOutputMessage structs + filename="gio/gdatagrambased.c" + line="212">an array of #GOutputMessage structs the number of elements in @messages + filename="gio/gdatagrambased.c" + line="213">the number of elements in @messages an int containing #GSocketMsgFlags flags + filename="gio/gdatagrambased.c" + line="214">an int containing #GSocketMsgFlags flags the maximum time (in microseconds) to wait, 0 to not block, or -1 + filename="gio/gdatagrambased.c" + line="215">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -32927,34 +33917,36 @@ documented in the interface methods. nullable="1" allow-none="1"> a %GCancellable + filename="gio/gdatagrambased.c" + line="217">a %GCancellable + Virtual method for g_datagram_based_create_source(). - + a newly allocated #GSource + filename="gio/gdatagrambased.c" + line="332">a newly allocated #GSource a #GDatagramBased + filename="gio/gdatagrambased.c" + line="313">a #GDatagramBased a #GIOCondition mask to monitor + filename="gio/gdatagrambased.c" + line="314">a #GIOCondition mask to monitor nullable="1" allow-none="1"> a #GCancellable + filename="gio/gdatagrambased.c" + line="315">a #GCancellable + Virtual method for g_datagram_based_condition_check(). - + the #GIOCondition mask of the current state + filename="gio/gdatagrambased.c" + line="395">the #GIOCondition mask of the current state a #GDatagramBased + filename="gio/gdatagrambased.c" + line="355">a #GDatagramBased a #GIOCondition mask to check + filename="gio/gdatagrambased.c" + line="356">a #GIOCondition mask to check + Virtual method for + g_datagram_based_condition_wait(). - + %TRUE if the condition was met, %FALSE otherwise + filename="gio/gdatagrambased.c" + line="442">%TRUE if the condition was met, %FALSE otherwise a #GDatagramBased + filename="gio/gdatagrambased.c" + line="428">a #GDatagramBased a #GIOCondition mask to wait for + filename="gio/gdatagrambased.c" + line="429">a #GIOCondition mask to wait for the maximum time (in microseconds) to wait, 0 to not block, or -1 + filename="gio/gdatagrambased.c" + line="430">the maximum time (in microseconds) to wait, 0 to not block, or -1 to block indefinitely @@ -33030,8 +34027,8 @@ documented in the interface methods. nullable="1" allow-none="1"> a #GCancellable + filename="gio/gdatagrambased.c" + line="432">a #GCancellable @@ -33042,29 +34039,28 @@ documented in the interface methods. c:type="GDatagramBasedSourceFunc" version="2.48"> This is the function type of the callback used for the #GSource + filename="gio/giotypes.h" + line="319">This is the function type of the callback used for the #GSource returned by g_datagram_based_create_source(). - + %G_SOURCE_REMOVE if the source should be removed, + filename="gio/giotypes.h" + line="328">%G_SOURCE_REMOVE if the source should be removed, %G_SOURCE_CONTINUE otherwise the #GDatagramBased + filename="gio/giotypes.h" + line="321">the #GDatagramBased the current condition at the source fired + filename="gio/giotypes.h" + line="322">the current condition at the source fired nullable="1" allow-none="1"> data passed in by the user + filename="gio/giotypes.h" + line="323">data passed in by the user @@ -33086,45 +34082,44 @@ returned by g_datagram_based_create_source(). glib:get-type="g_debug_controller_get_type" glib:type-struct="DebugControllerInterface"> #GDebugController is an interface to expose control of debugging features and + filename="gio/gdebugcontroller.c" + line="31">`GDebugController` is an interface to expose control of debugging features and debug output. -It is implemented on Linux using #GDebugControllerDBus, which exposes a D-Bus -interface to allow authenticated peers to control debug features in this -process. +It is implemented on Linux using [class@Gio.DebugControllerDBus], which +exposes a D-Bus interface to allow authenticated peers to control debug +features in this process. Whether debug output is enabled is exposed as -#GDebugController:debug-enabled. This controls g_log_set_debug_enabled() by -default. Application code may connect to the #GObject::notify signal for it +[property@Gio.DebugController:debug-enabled]. This controls +[func@GLib.log_set_debug_enabled] by default. Application code may +connect to the [signal@GObject.Object::notify] signal for it to control other parts of its debug infrastructure as necessary. If your application or service is using the default GLib log writer function, -creating one of the built-in implementations of #GDebugController should be +creating one of the built-in implementations of `GDebugController` should be all that’s needed to dynamically enable or disable debug output. - + Get the value of #GDebugController:debug-enabled. - + filename="gio/gdebugcontroller.c" + line="76">Get the value of #GDebugController:debug-enabled. + %TRUE if debug output should be exposed, %FALSE otherwise + filename="gio/gdebugcontroller.c" + line="82">%TRUE if debug output should be exposed, %FALSE otherwise a #GDebugController + filename="gio/gdebugcontroller.c" + line="78">a #GDebugController @@ -33134,24 +34129,23 @@ all that’s needed to dynamically enable or disable debug output. glib:set-property="debug-enabled" version="2.72"> Set the value of #GDebugController:debug-enabled. - + filename="gio/gdebugcontroller.c" + line="99">Set the value of #GDebugController:debug-enabled. + a #GDebugController + filename="gio/gdebugcontroller.c" + line="101">a #GDebugController %TRUE if debug output should be exposed, %FALSE otherwise + filename="gio/gdebugcontroller.c" + line="102">%TRUE if debug output should be exposed, %FALSE otherwise @@ -33164,8 +34158,8 @@ all that’s needed to dynamically enable or disable debug output. getter="get_debug_enabled" default-value="FALSE"> %TRUE if debug output should be exposed (for example by forwarding it to + filename="gio/gdebugcontroller.c" + line="60">%TRUE if debug output should be exposed (for example by forwarding it to the journal), %FALSE otherwise. @@ -33179,31 +34173,33 @@ the journal), %FALSE otherwise. glib:get-type="g_debug_controller_dbus_get_type" glib:type-struct="DebugControllerDBusClass"> #GDebugControllerDBus is an implementation of #GDebugController which exposes -debug settings as a D-Bus object. + filename="gio/gdebugcontrollerdbus.c" + line="33">`GDebugControllerDBus` is an implementation of [iface@Gio.DebugController] +which exposes debug settings as a D-Bus object. -It is a #GInitable object, and will register an object at +It is a [iface@Gio.Initable] object, and will register an object at `/org/gtk/Debugging` on the bus given as -#GDebugControllerDBus:connection once it’s initialized. The object will be -unregistered when the last reference to the #GDebugControllerDBus is dropped. +[property@Gio.DebugControllerDBus:connection] once it’s initialized. The +object will be unregistered when the last reference to the +`GDebugControllerDBus` is dropped. This D-Bus object can be used by remote processes to enable or disable debug output in this process. Remote processes calling `org.gtk.Debugging.SetDebugEnabled()` will affect the value of -#GDebugController:debug-enabled and, by default, g_log_get_debug_enabled(). -default. +[property@Gio.DebugController:debug-enabled] and, by default, +[func@GLib.log_get_debug_enabled]. By default, no processes are allowed to call `SetDebugEnabled()` unless a -#GDebugControllerDBus::authorize signal handler is installed. This is because -the process may be privileged, or might expose sensitive information in its -debug output. You may want to restrict the ability to enable debug output to -privileged users or processes. +[signal@Gio.DebugControllerDBus::authorize] signal handler is installed. This +is because the process may be privileged, or might expose sensitive +information in its debug output. You may want to restrict the ability to +enable debug output to privileged users or processes. One option is to install a D-Bus security policy which restricts access to `SetDebugEnabled()`, installing something like the following in `$datadir/dbus-1/system.d/`: -|[<!-- language="XML" --> + +```xml <?xml version="1.0"?> <!--*-nxml-*--> <!DOCTYPE busconfig PUBLIC "-//freedesktop//DTD D-BUS Bus Configuration 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd"> @@ -33215,7 +34211,7 @@ One option is to install a D-Bus security policy which restricts access to <deny send_destination="com.example.MyService" send_interface="org.gtk.Debugging"/> </policy> </busconfig> -]| +``` This will prevent the `SetDebugEnabled()` method from being called by all except root. It will not prevent the `DebugEnabled` property from being read, @@ -33223,9 +34219,10 @@ as it’s accessed through the `org.freedesktop.DBus.Properties` interface. Another option is to use polkit to allow or deny requests on a case-by-case basis, allowing for the possibility of dynamic authorisation. To do this, -connect to the #GDebugControllerDBus::authorize signal and query polkit in -it: -|[<!-- language="C" --> +connect to the [signal@Gio.DebugControllerDBus::authorize] signal and query +polkit in it: + +```c g_autoptr(GError) child_error = NULL; g_autoptr(GDBusConnection) connection = g_bus_get_sync (G_BUS_TYPE_SYSTEM, NULL, NULL); gulong debug_controller_authorize_id = 0; @@ -33286,9 +34283,8 @@ it: return polkit_authorization_result_get_is_authorized (auth_result); } -]| - +``` + Create a new #GDebugControllerDBus and synchronously initialize it. + filename="gio/gdebugcontrollerdbus.c" + line="628">Create a new #GDebugControllerDBus and synchronously initialize it. Initializing the object will export the debug object on @connection. The object will remain registered until the last reference to the #GDebugControllerDBus is dropped. Initialization may fail if registering the object on @connection fails. - + a new #GDebugControllerDBus, or %NULL + filename="gio/gdebugcontrollerdbus.c" + line="642">a new #GDebugControllerDBus, or %NULL on failure a #GDBusConnection to register the debug object on + filename="gio/gdebugcontrollerdbus.c" + line="630">a #GDBusConnection to register the debug object on nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdebugcontrollerdbus.c" + line="631">a #GCancellable, or %NULL - + Default handler for the #GDebugControllerDBus::authorize signal. + @@ -33350,8 +34347,8 @@ Initialization may fail if registering the object on @connection fails. c:identifier="g_debug_controller_dbus_stop" version="2.72"> Stop the debug controller, unregistering its object from the bus. + filename="gio/gdebugcontrollerdbus.c" + line="662">Stop the debug controller, unregistering its object from the bus. Any pending method calls to the object will complete successfully, but new ones will return an error. This method will block until all pending @@ -33367,16 +34364,15 @@ reference count cycles. Calling this method from within a #GDebugControllerDBus::authorize signal handler will cause a deadlock and must not be done. - + a #GDebugControllerDBus + filename="gio/gdebugcontrollerdbus.c" + line="664">a #GDebugControllerDBus @@ -33387,8 +34383,8 @@ handler will cause a deadlock and must not be done. construct-only="1" transfer-ownership="none"> The D-Bus connection to expose the debugging interface on. + filename="gio/gdebugcontrollerdbus.c" + line="552">The D-Bus connection to expose the debugging interface on. Typically this will be the same connection (to the system or session bus) which the rest of the application or service’s D-Bus objects are registered @@ -33400,8 +34396,8 @@ on. Emitted when a D-Bus peer is trying to change the debug settings and used + filename="gio/gdebugcontrollerdbus.c" + line="574">Emitted when a D-Bus peer is trying to change the debug settings and used to determine if that is authorized. This signal is emitted in a dedicated worker thread, so handlers are @@ -33420,15 +34416,15 @@ Signal handlers must not modify @invocation, or cause it to return a value. The default class handler just returns %TRUE. %TRUE if the call is authorized, %FALSE otherwise. + filename="gio/gdebugcontrollerdbus.c" + line="597">%TRUE if the call is authorized, %FALSE otherwise. A #GDBusMethodInvocation. + filename="gio/gdebugcontrollerdbus.c" + line="577">A #GDBusMethodInvocation. @@ -33439,20 +34435,21 @@ The default class handler just returns %TRUE. glib:is-gtype-struct-for="DebugControllerDBus" version="2.72"> The virtual function table for #GDebugControllerDBus. - + filename="gio/gdebugcontrollerdbus.h" + line="35">The virtual function table for #GDebugControllerDBus. + The parent class. + filename="gio/gdebugcontrollerdbus.h" + line="37">The parent class. + Default handler for the #GDebugControllerDBus::authorize signal. - + @@ -33478,14 +34475,13 @@ The default class handler just returns %TRUE. glib:is-gtype-struct-for="DebugController" version="2.72"> The virtual function table for #GDebugController. - + filename="gio/gdebugcontroller.h" + line="52">The virtual function table for #GDebugController. + The parent interface. + filename="gio/gdebugcontroller.h" + line="54">The parent interface. @@ -33497,20 +34493,19 @@ The default class handler just returns %TRUE. glib:get-type="g_desktop_app_info_get_type" glib:type-struct="DesktopAppInfoClass"> #GDesktopAppInfo is an implementation of #GAppInfo based on + filename="gio/gdesktopappinfo.c" + line="65">`GDesktopAppInfo` is an implementation of [iface@Gio.AppInfo] based on desktop files. Note that `<gio/gdesktopappinfo.h>` belongs to the UNIX-specific GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config -file when using it. - +file or the `GioUnix-2.0` GIR namespace when using it. + Creates a new #GDesktopAppInfo based on a desktop file id. + filename="gio/gdesktopappinfo.c" + line="2116">Creates a new #GDesktopAppInfo based on a desktop file id. A desktop file id is the basename of the desktop file, including the .desktop extension. GIO is looking for a desktop file with this name @@ -33521,20 +34516,19 @@ prefix-to-subdirectory mapping that is described in the [Menu Spec](http://standards.freedesktop.org/menu-spec/latest/) (i.e. a desktop id of kde-foo.desktop will match `/usr/share/applications/kde/foo.desktop`). - + a new #GDesktopAppInfo, or %NULL if no desktop + filename="gio/gdesktopappinfo.c" + line="2132">a new #GDesktopAppInfo, or %NULL if no desktop file with that id exists. the desktop file id + filename="gio/gdesktopappinfo.c" + line="2118">the desktop file id @@ -33542,21 +34536,20 @@ prefix-to-subdirectory mapping that is described in the Creates a new #GDesktopAppInfo. - + filename="gio/gdesktopappinfo.c" + line="2093">Creates a new #GDesktopAppInfo. + a new #GDesktopAppInfo or %NULL on error. + filename="gio/gdesktopappinfo.c" + line="2100">a new #GDesktopAppInfo or %NULL on error. the path of a desktop file, in the GLib + filename="gio/gdesktopappinfo.c" + line="2095">the path of a desktop file, in the GLib filename encoding @@ -33566,21 +34559,20 @@ prefix-to-subdirectory mapping that is described in the c:identifier="g_desktop_app_info_new_from_keyfile" version="2.18"> Creates a new #GDesktopAppInfo. - + filename="gio/gdesktopappinfo.c" + line="2065">Creates a new #GDesktopAppInfo. + a new #GDesktopAppInfo or %NULL on error. + filename="gio/gdesktopappinfo.c" + line="2071">a new #GDesktopAppInfo or %NULL on error. an opened #GKeyFile + filename="gio/gdesktopappinfo.c" + line="2067">an opened #GKeyFile @@ -33589,17 +34581,16 @@ prefix-to-subdirectory mapping that is described in the c:identifier="g_desktop_app_info_get_implementations" version="2.42"> Gets all applications that implement @interface. + filename="gio/gdesktopappinfo.c" + line="4746">Gets all applications that implement @interface. An application implements an interface if that interface is listed in the Implements= line of the desktop file of the application. - + a list of #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="4755">a list of #GDesktopAppInfo objects. @@ -33608,16 +34599,16 @@ objects. the name of the interface + filename="gio/gdesktopappinfo.c" + line="4748">the name of the interface Searches desktop files for ones that match @search_string. + filename="gio/gdesktopappinfo.c" + line="4795">Searches desktop files for ones that match @search_string. The return value is an array of strvs. Each strv contains a list of applications that matched @search_string with an equal score. The @@ -33632,12 +34623,11 @@ the executable referenced by a result exists), and so it is possible for g_desktop_app_info_new() to return %NULL when passed an app ID returned by this function. It is expected that calling code will do this when subsequently creating a #GDesktopAppInfo for each result. - + a + filename="gio/gdesktopappinfo.c" + line="4815">a list of strvs. Free each item with g_strfreev() and free the outer list with g_free(). @@ -33649,8 +34639,8 @@ subsequently creating a #GDesktopAppInfo for each result. the search string to use + filename="gio/gdesktopappinfo.c" + line="4797">the search string to use @@ -33660,8 +34650,8 @@ subsequently creating a #GDesktopAppInfo for each result. deprecated="1" deprecated-version="2.42"> Sets the name of the desktop that the application is running in. + filename="gio/gdesktopappinfo.c" + line="3656">Sets the name of the desktop that the application is running in. This is used by g_app_info_should_show() and g_desktop_app_info_get_show_in() to evaluate the `OnlyShowIn` and `NotShowIn` @@ -33670,16 +34660,15 @@ desktop entry fields. Should be called only once; subsequent calls are ignored. do not use this API. Since 2.42 the value of the `XDG_CURRENT_DESKTOP` environment variable will be used. - + a string specifying what desktop this is + filename="gio/gdesktopappinfo.c" + line="3658">a string specifying what desktop this is @@ -33688,31 +34677,30 @@ Should be called only once; subsequent calls are ignored. c:identifier="g_desktop_app_info_get_action_name" version="2.38"> Gets the user-visible display name of the "additional application + filename="gio/gdesktopappinfo.c" + line="5182">Gets the user-visible display name of the "additional application action" specified by @action_name. This corresponds to the "Name" key within the keyfile group for the action. - + the locale-specific action name + filename="gio/gdesktopappinfo.c" + line="5194">the locale-specific action name a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="5184">a #GDesktopAppInfo the name of the action as from + filename="gio/gdesktopappinfo.c" + line="5185">the name of the action as from g_desktop_app_info_list_actions() @@ -33722,30 +34710,29 @@ action. c:identifier="g_desktop_app_info_get_boolean" version="2.36"> Looks up a boolean value in the keyfile backing @info. + filename="gio/gdesktopappinfo.c" + line="5072">Looks up a boolean value in the keyfile backing @info. The @key is looked up in the "Desktop Entry" group. - + the boolean value, or %FALSE if the key + filename="gio/gdesktopappinfo.c" + line="5081">the boolean value, or %FALSE if the key is not found a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="5074">a #GDesktopAppInfo the key to look up + filename="gio/gdesktopappinfo.c" + line="5075">the key to look up @@ -33753,22 +34740,21 @@ The @key is looked up in the "Desktop Entry" group. Gets the categories from the desktop file. - + filename="gio/gdesktopappinfo.c" + line="2314">Gets the categories from the desktop file. + The unparsed Categories key from the desktop file; + filename="gio/gdesktopappinfo.c" + line="2320">The unparsed Categories key from the desktop file; i.e. no attempt is made to split it by ';' or validate it. a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="2316">a #GDesktopAppInfo @@ -33778,24 +34764,23 @@ The @key is looked up in the "Desktop Entry" group. glib:get-property="filename" version="2.24"> When @info was created from a known filename, return it. In some + filename="gio/gdesktopappinfo.c" + line="2264">When @info was created from a known filename, return it. In some situations such as the #GDesktopAppInfo returned from g_desktop_app_info_new_from_keyfile(), this function will return %NULL. - + The full path to the file for @info, + filename="gio/gdesktopappinfo.c" + line="2272">The full path to the file for @info, or %NULL if not known. a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="2266">a #GDesktopAppInfo @@ -33803,21 +34788,20 @@ g_desktop_app_info_new_from_keyfile(), this function will return %NULL. Gets the generic name from the desktop file. - + filename="gio/gdesktopappinfo.c" + line="2345">Gets the generic name from the desktop file. + The value of the GenericName key + filename="gio/gdesktopappinfo.c" + line="2351">The value of the GenericName key a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="2347">a #GDesktopAppInfo @@ -33825,22 +34809,21 @@ g_desktop_app_info_new_from_keyfile(), this function will return %NULL. A desktop file is hidden if the Hidden key in it is + filename="gio/gdesktopappinfo.c" + line="2249">A desktop file is hidden if the Hidden key in it is set to True. - + %TRUE if hidden, %FALSE otherwise. + filename="gio/gdesktopappinfo.c" + line="2256">%TRUE if hidden, %FALSE otherwise. a #GDesktopAppInfo. + filename="gio/gdesktopappinfo.c" + line="2251">a #GDesktopAppInfo. @@ -33849,14 +34832,13 @@ set to True. c:identifier="g_desktop_app_info_get_keywords" version="2.32"> Gets the keywords from the desktop file. - + filename="gio/gdesktopappinfo.c" + line="2329">Gets the keywords from the desktop file. + The value of the Keywords key + filename="gio/gdesktopappinfo.c" + line="2335">The value of the Keywords key @@ -33864,8 +34846,8 @@ set to True. a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="2331">a #GDesktopAppInfo @@ -33874,31 +34856,30 @@ set to True. c:identifier="g_desktop_app_info_get_locale_string" version="2.56"> Looks up a localized string value in the keyfile backing @info + filename="gio/gdesktopappinfo.c" + line="5045">Looks up a localized string value in the keyfile backing @info translated to the current locale. The @key is looked up in the "Desktop Entry" group. - + a newly allocated string, or %NULL if the key + filename="gio/gdesktopappinfo.c" + line="5055">a newly allocated string, or %NULL if the key is not found a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="5047">a #GDesktopAppInfo the key to look up + filename="gio/gdesktopappinfo.c" + line="5048">the key to look up @@ -33907,23 +34888,22 @@ The @key is looked up in the "Desktop Entry" group. c:identifier="g_desktop_app_info_get_nodisplay" version="2.30"> Gets the value of the NoDisplay key, which helps determine if the + filename="gio/gdesktopappinfo.c" + line="2359">Gets the value of the NoDisplay key, which helps determine if the application info should be shown in menus. See %G_KEY_FILE_DESKTOP_KEY_NO_DISPLAY and g_app_info_should_show(). - + The value of the NoDisplay key + filename="gio/gdesktopappinfo.c" + line="2367">The value of the NoDisplay key a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="2361">a #GDesktopAppInfo @@ -33932,8 +34912,8 @@ application info should be shown in menus. See c:identifier="g_desktop_app_info_get_show_in" version="2.30"> Checks if the application info should be shown in menus that list available + filename="gio/gdesktopappinfo.c" + line="2377">Checks if the application info should be shown in menus that list available applications for a specific name of the desktop, based on the `OnlyShowIn` and `NotShowIn` keys. @@ -33944,12 +34924,11 @@ but this is not recommended. Note that g_app_info_should_show() for @info will include this check (with %NULL for @desktop_env) as well as additional checks. - + %TRUE if the @info should be shown in @desktop_env according to the + filename="gio/gdesktopappinfo.c" + line="2394">%TRUE if the @info should be shown in @desktop_env according to the `OnlyShowIn` and `NotShowIn` keys, %FALSE otherwise. @@ -33957,8 +34936,8 @@ otherwise. a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="2379">a #GDesktopAppInfo nullable="1" allow-none="1"> a string specifying a desktop name + filename="gio/gdesktopappinfo.c" + line="2380">a string specifying a desktop name @@ -33976,24 +34955,23 @@ otherwise. c:identifier="g_desktop_app_info_get_startup_wm_class" version="2.34"> Retrieves the StartupWMClass field from @info. This represents the + filename="gio/gdesktopappinfo.c" + line="5000">Retrieves the StartupWMClass field from @info. This represents the WM_CLASS property of the main window of the application, if launched through @info. - + the startup WM class, or %NULL if none is set + filename="gio/gdesktopappinfo.c" + line="5008">the startup WM class, or %NULL if none is set in the desktop file. a #GDesktopAppInfo that supports startup notify + filename="gio/gdesktopappinfo.c" + line="5002">a #GDesktopAppInfo that supports startup notify @@ -34002,30 +34980,29 @@ in the desktop file. c:identifier="g_desktop_app_info_get_string" version="2.36"> Looks up a string value in the keyfile backing @info. + filename="gio/gdesktopappinfo.c" + line="5021">Looks up a string value in the keyfile backing @info. The @key is looked up in the "Desktop Entry" group. - + a newly allocated string, or %NULL if the key + filename="gio/gdesktopappinfo.c" + line="5030">a newly allocated string, or %NULL if the key is not found a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="5023">a #GDesktopAppInfo the key to look up + filename="gio/gdesktopappinfo.c" + line="5024">the key to look up @@ -34034,16 +35011,15 @@ The @key is looked up in the "Desktop Entry" group. c:identifier="g_desktop_app_info_get_string_list" version="2.60"> Looks up a string list value in the keyfile backing @info. + filename="gio/gdesktopappinfo.c" + line="5096">Looks up a string list value in the keyfile backing @info. The @key is looked up in the "Desktop Entry" group. - + + filename="gio/gdesktopappinfo.c" + line="5106"> a %NULL-terminated string array or %NULL if the specified key cannot be found. The array should be freed with g_strfreev(). @@ -34053,14 +35029,14 @@ The @key is looked up in the "Desktop Entry" group. a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="5098">a #GDesktopAppInfo the key to look up + filename="gio/gdesktopappinfo.c" + line="5099">the key to look up optional="1" allow-none="1"> return location for the number of returned strings, or %NULL + filename="gio/gdesktopappinfo.c" + line="5100">return location for the number of returned strings, or %NULL @@ -34080,28 +35056,27 @@ The @key is looked up in the "Desktop Entry" group. c:identifier="g_desktop_app_info_has_key" version="2.36"> Returns whether @key exists in the "Desktop Entry" group + filename="gio/gdesktopappinfo.c" + line="5123">Returns whether @key exists in the "Desktop Entry" group of the keyfile backing @info. - + %TRUE if the @key exists + filename="gio/gdesktopappinfo.c" + line="5131">%TRUE if the @key exists a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="5125">a #GDesktopAppInfo the key to look up + filename="gio/gdesktopappinfo.c" + line="5126">the key to look up @@ -34110,8 +35085,8 @@ of the keyfile backing @info. c:identifier="g_desktop_app_info_launch_action" version="2.38"> Activates the named application action. + filename="gio/gdesktopappinfo.c" + line="5224">Activates the named application action. You may only call this function on action names that were returned from g_desktop_app_info_list_actions(). @@ -34126,22 +35101,21 @@ actions, as per the desktop file specification. As with g_app_info_launch() there is no way to detect failures that occur while using this function. - + a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="5226">a #GDesktopAppInfo the name of the action as from + filename="gio/gdesktopappinfo.c" + line="5227">the name of the action as from g_desktop_app_info_list_actions() @@ -34150,8 +35124,8 @@ occur while using this function. nullable="1" allow-none="1"> a #GAppLaunchContext + filename="gio/gdesktopappinfo.c" + line="5229">a #GAppLaunchContext @@ -34160,8 +35134,8 @@ occur while using this function. c:identifier="g_desktop_app_info_launch_uris_as_manager" throws="1"> This function performs the equivalent of g_app_info_launch_uris(), + filename="gio/gdesktopappinfo.c" + line="3600">This function performs the equivalent of g_app_info_launch_uris(), but is intended primarily for operating system components that launch applications. Ordinary applications should use g_app_info_launch_uris(). @@ -34176,25 +35150,24 @@ optimized posix_spawn() codepath to be used. If application launching occurs via some other mechanism (eg: D-Bus activation) then @spawn_flags, @user_setup, @user_setup_data, @pid_callback and @pid_callback_data are ignored. - + %TRUE on successful launch, %FALSE otherwise. + filename="gio/gdesktopappinfo.c" + line="3629">%TRUE on successful launch, %FALSE otherwise. a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="3602">a #GDesktopAppInfo List of URIs + filename="gio/gdesktopappinfo.c" + line="3603">List of URIs @@ -34204,14 +35177,14 @@ activation) then @spawn_flags, @user_setup, @user_setup_data, nullable="1" allow-none="1"> a #GAppLaunchContext + filename="gio/gdesktopappinfo.c" + line="3604">a #GAppLaunchContext #GSpawnFlags, used for each process + filename="gio/gdesktopappinfo.c" + line="3605">#GSpawnFlags, used for each process a #GSpawnChildSetupFunc, used once + filename="gio/gdesktopappinfo.c" + line="3606">a #GSpawnChildSetupFunc, used once for each process. @@ -34233,8 +35206,8 @@ activation) then @spawn_flags, @user_setup, @user_setup_data, allow-none="1" closure="3"> User data for @user_setup + filename="gio/gdesktopappinfo.c" + line="3608">User data for @user_setup Callback for child processes + filename="gio/gdesktopappinfo.c" + line="3609">Callback for child processes @@ -34255,8 +35228,8 @@ activation) then @spawn_flags, @user_setup, @user_setup_data, allow-none="1" closure="5"> User data for @callback + filename="gio/gdesktopappinfo.c" + line="3610">User data for @callback @@ -34266,32 +35239,31 @@ activation) then @spawn_flags, @user_setup, @user_setup_data, version="2.58" throws="1"> Equivalent to g_desktop_app_info_launch_uris_as_manager() but allows + filename="gio/gdesktopappinfo.c" + line="3545">Equivalent to g_desktop_app_info_launch_uris_as_manager() but allows you to pass in file descriptors for the stdin, stdout and stderr streams of the launched process. If application launching occurs via some non-spawn mechanism (e.g. D-Bus activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored. - + %TRUE on successful launch, %FALSE otherwise. + filename="gio/gdesktopappinfo.c" + line="3568">%TRUE on successful launch, %FALSE otherwise. a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="3547">a #GDesktopAppInfo List of URIs + filename="gio/gdesktopappinfo.c" + line="3548">List of URIs @@ -34301,14 +35273,14 @@ activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored. nullable="1" allow-none="1"> a #GAppLaunchContext + filename="gio/gdesktopappinfo.c" + line="3549">a #GAppLaunchContext #GSpawnFlags, used for each process + filename="gio/gdesktopappinfo.c" + line="3550">#GSpawnFlags, used for each process scope="async" closure="4"> a #GSpawnChildSetupFunc, used once + filename="gio/gdesktopappinfo.c" + line="3551">a #GSpawnChildSetupFunc, used once for each process. @@ -34329,8 +35301,8 @@ activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored. nullable="1" allow-none="1"> User data for @user_setup + filename="gio/gdesktopappinfo.c" + line="3553">User data for @user_setup scope="call" closure="6"> Callback for child processes + filename="gio/gdesktopappinfo.c" + line="3554">Callback for child processes @@ -34350,26 +35322,26 @@ activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored. nullable="1" allow-none="1"> User data for @callback + filename="gio/gdesktopappinfo.c" + line="3555">User data for @callback file descriptor to use for child's stdin, or -1 + filename="gio/gdesktopappinfo.c" + line="3556">file descriptor to use for child's stdin, or -1 file descriptor to use for child's stdout, or -1 + filename="gio/gdesktopappinfo.c" + line="3557">file descriptor to use for child's stdout, or -1 file descriptor to use for child's stderr, or -1 + filename="gio/gdesktopappinfo.c" + line="3558">file descriptor to use for child's stderr, or -1 @@ -34378,18 +35350,17 @@ activation) then @stdin_fd, @stdout_fd and @stderr_fd are ignored. c:identifier="g_desktop_app_info_list_actions" version="2.38"> Returns the list of "additional application actions" supported on the + filename="gio/gdesktopappinfo.c" + line="5147">Returns the list of "additional application actions" supported on the desktop file, as per the desktop file specification. As per the specification, this is the list of actions that are explicitly listed in the "Actions" key of the [Desktop Entry] group. - + a list of strings, always non-%NULL + filename="gio/gdesktopappinfo.c" + line="5157">a list of strings, always non-%NULL @@ -34397,8 +35368,8 @@ explicitly listed in the "Actions" key of the [Desktop Entry] group. a #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="5149">a #GDesktopAppInfo @@ -34410,16 +35381,15 @@ explicitly listed in the "Actions" key of the [Desktop Entry] group. getter="get_filename" default-value="NULL"> The origin filename of this #GDesktopAppInfo + filename="gio/gdesktopappinfo.c" + line="1777">The origin filename of this #GDesktopAppInfo - + @@ -34433,20 +35403,19 @@ explicitly listed in the "Actions" key of the [Desktop Entry] group. glib:get-type="g_desktop_app_info_lookup_get_type" glib:type-struct="DesktopAppInfoLookupIface"> #GDesktopAppInfoLookup is an opaque data structure and can only be accessed + filename="gio/gdesktopappinfo.c" + line="4941">#GDesktopAppInfoLookup is an opaque data structure and can only be accessed using the following functions. The #GDesktopAppInfoLookup interface is deprecated and unused by GIO. - + Gets the default application for launching applications + filename="gio/gdesktopappinfo.c" + line="4963">Gets the default application for launching applications using this URI scheme for a particular #GDesktopAppInfoLookup implementation. @@ -34456,26 +35425,25 @@ in a GIO module. There is no reason for applications to use it directly. Applications should use g_app_info_get_default_for_uri_scheme(). The #GDesktopAppInfoLookup interface is deprecated and unused by GIO. - + #GAppInfo for given @uri_scheme or + filename="gio/gdesktopappinfo.c" + line="4977">#GAppInfo for given @uri_scheme or %NULL on error. a #GDesktopAppInfoLookup + filename="gio/gdesktopappinfo.c" + line="4965">a #GDesktopAppInfoLookup a string containing a URI scheme. + filename="gio/gdesktopappinfo.c" + line="4966">a string containing a URI scheme. @@ -34485,8 +35453,8 @@ directly. Applications should use g_app_info_get_default_for_uri_scheme(). deprecated="1" deprecated-version="2.28"> Gets the default application for launching applications + filename="gio/gdesktopappinfo.c" + line="4963">Gets the default application for launching applications using this URI scheme for a particular #GDesktopAppInfoLookup implementation. @@ -34496,26 +35464,25 @@ in a GIO module. There is no reason for applications to use it directly. Applications should use g_app_info_get_default_for_uri_scheme(). The #GDesktopAppInfoLookup interface is deprecated and unused by GIO. - + #GAppInfo for given @uri_scheme or + filename="gio/gdesktopappinfo.c" + line="4977">#GAppInfo for given @uri_scheme or %NULL on error. a #GDesktopAppInfoLookup + filename="gio/gdesktopappinfo.c" + line="4965">a #GDesktopAppInfoLookup a string containing a URI scheme. + filename="gio/gdesktopappinfo.c" + line="4966">a string containing a URI scheme. @@ -34525,37 +35492,39 @@ directly. Applications should use g_app_info_get_default_for_uri_scheme(). c:type="GDesktopAppInfoLookupIface" glib:is-gtype-struct-for="DesktopAppInfoLookup"> Interface that is used by backends to associate default handlers with URI schemes. - + + Virtual method for + g_desktop_app_info_lookup_get_default_for_uri_scheme(). - + #GAppInfo for given @uri_scheme or + filename="gio/gdesktopappinfo.c" + line="4977">#GAppInfo for given @uri_scheme or %NULL on error. a #GDesktopAppInfoLookup + filename="gio/gdesktopappinfo.c" + line="4965">a #GDesktopAppInfoLookup a string containing a URI scheme. + filename="gio/gdesktopappinfo.c" + line="4966">a string containing a URI scheme. @@ -34565,25 +35534,24 @@ handlers with URI schemes. During invocation, g_desktop_app_info_launch_uris_as_manager() may create one or more child processes. This callback is invoked once for each, providing the process ID. - + a #GDesktopAppInfo Process identifier @@ -34593,7 +35561,7 @@ for each, providing the process ID. allow-none="1" closure="2"> User data @@ -34606,95 +35574,91 @@ for each, providing the process ID. glib:get-type="g_drive_get_type" glib:type-struct="DriveIface"> #GDrive - this represent a piece of hardware connected to the machine. -It's generally only created for removable hardware or hardware with + filename="gio/gdrive.c" + line="33">`GDrive` represents a piece of hardware connected to the machine. +It’s generally only created for removable hardware or hardware with removable media. -#GDrive is a container class for #GVolume objects that stem from -the same piece of media. As such, #GDrive abstracts a drive with +`GDrive` is a container class for [iface@Gio.Volume] objects that stem from +the same piece of media. As such, `GDrive` abstracts a drive with (or without) removable media and provides operations for querying whether media is available, determining whether media change is automatically detected and ejecting the media. -If the #GDrive reports that media isn't automatically detected, one +If the `GDrive` reports that media isn’t automatically detected, one can poll for media; typically one should not do this periodically as a poll for media operation is potentially expensive and may spin up the drive creating noise. -#GDrive supports starting and stopping drives with authentication +`GDrive` supports starting and stopping drives with authentication support for the former. This can be used to support a diverse set of use cases including connecting/disconnecting iSCSI devices, powering down external disk enclosures and starting/stopping multi-disk devices such as RAID devices. Note that the actual -semantics and side-effects of starting/stopping a #GDrive may vary +semantics and side-effects of starting/stopping a `GDrive` may vary according to implementation. To choose the correct verbs in e.g. a -file manager, use g_drive_get_start_stop_type(). +file manager, use [method@Gio.Drive.get_start_stop_type]. -For porting from GnomeVFS note that there is no equivalent of -#GDrive in that API. - +For [porting from GnomeVFS](migrating-gnome-vfs.html) note that there is no +equivalent of `GDrive` in that API. + Checks if a drive can be ejected. - + filename="gio/gdrive.c" + line="336">Checks if a drive can be ejected. + %TRUE if the @drive can be ejected, %FALSE otherwise. + filename="gio/gdrive.c" + line="342">%TRUE if the @drive can be ejected, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="338">a #GDrive. Checks if a drive can be polled for media changes. - + filename="gio/gdrive.c" + line="359">Checks if a drive can be polled for media changes. + %TRUE if the @drive can be polled for media changes, + filename="gio/gdrive.c" + line="365">%TRUE if the @drive can be polled for media changes, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="361">a #GDrive. Checks if a drive can be started. - + filename="gio/gdrive.c" + line="691">Checks if a drive can be started. + %TRUE if the @drive can be started, %FALSE otherwise. + filename="gio/gdrive.c" + line="697">%TRUE if the @drive can be started, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="693">a #GDrive. @@ -34703,49 +35667,49 @@ For porting from GnomeVFS note that there is no equivalent of invoker="can_start_degraded" version="2.22"> Checks if a drive can be started degraded. - + filename="gio/gdrive.c" + line="716">Checks if a drive can be started degraded. + %TRUE if the @drive can be started degraded, %FALSE otherwise. + filename="gio/gdrive.c" + line="722">%TRUE if the @drive can be started degraded, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="718">a #GDrive. Checks if a drive can be stopped. - + filename="gio/gdrive.c" + line="818">Checks if a drive can be stopped. + %TRUE if the @drive can be stopped, %FALSE otherwise. + filename="gio/gdrive.c" + line="824">%TRUE if the @drive can be stopped, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="820">a #GDrive. - + Signal emitted when the drive is changed. + @@ -34756,8 +35720,10 @@ For porting from GnomeVFS note that there is no equivalent of - + The removed signal that is emitted when the #GDrive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized. + @@ -34770,31 +35736,31 @@ For porting from GnomeVFS note that there is no equivalent of + deprecated-version="2.22" + glib:finish-func="eject_finish"> Asynchronously ejects a drive. + filename="gio/gdrive.c" + line="383">Asynchronously ejects a drive. When the operation is finished, @callback will be called. You can then call g_drive_eject_finish() to obtain the result of the operation. Use g_drive_eject_with_operation() instead. - + a #GDrive. + filename="gio/gdrive.c" + line="385">a #GDrive. flags affecting the unmount if required for eject + filename="gio/gdrive.c" + line="386">flags affecting the unmount if required for eject nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="387">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="388">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="3"> user data to pass to @callback + filename="gio/gdrive.c" + line="389">user data to pass to @callback - + Signal emitted when the physical eject button (if any) of a drive have been pressed. + @@ -34847,57 +35815,56 @@ result of the operation. deprecated-version="2.22" throws="1"> Finishes ejecting a drive. + filename="gio/gdrive.c" + line="424">Finishes ejecting a drive. Use g_drive_eject_with_operation_finish() instead. - + %TRUE if the drive has been ejected successfully, + filename="gio/gdrive.c" + line="432">%TRUE if the drive has been ejected successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="426">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="427">a #GAsyncResult. + version="2.22" + glib:finish-func="eject_with_operation_finish"> Ejects a drive. This is an asynchronous operation, and is + filename="gio/gdrive.c" + line="457">Ejects a drive. This is an asynchronous operation, and is finished by calling g_drive_eject_with_operation_finish() with the @drive and #GAsyncResult data returned in the @callback. - + a #GDrive. + filename="gio/gdrive.c" + line="459">a #GDrive. flags affecting the unmount if required for eject + filename="gio/gdrive.c" + line="460">flags affecting the unmount if required for eject nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gdrive.c" + line="461">a #GMountOperation or %NULL to avoid user interaction. @@ -34915,8 +35882,8 @@ and #GAsyncResult data returned in the @callback. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="463">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="464">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="4"> user data passed to @callback. + filename="gio/gdrive.c" + line="465">user data passed to @callback. @@ -34947,28 +35914,27 @@ and #GAsyncResult data returned in the @callback. version="2.22" throws="1"> Finishes ejecting a drive. If any errors occurred during the operation, + filename="gio/gdrive.c" + line="505">Finishes ejecting a drive. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + %TRUE if the drive was successfully ejected. %FALSE otherwise. + filename="gio/gdrive.c" + line="515">%TRUE if the drive was successfully ejected. %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="507">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="508">a #GAsyncResult. @@ -34976,16 +35942,15 @@ and #GAsyncResult data returned in the @callback. Gets the kinds of identifiers that @drive has. + filename="gio/gdrive.c" + line="639">Gets the kinds of identifiers that @drive has. Use g_drive_get_identifier() to obtain the identifiers themselves. - + a %NULL-terminated + filename="gio/gdrive.c" + line="647">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -34995,46 +35960,44 @@ themselves. a #GDrive + filename="gio/gdrive.c" + line="641">a #GDrive Gets the icon for @drive. - + filename="gio/gdrive.c" + line="155">Gets the icon for @drive. + #GIcon for the @drive. + filename="gio/gdrive.c" + line="161">#GIcon for the @drive. Free the returned object with g_object_unref(). a #GDrive. + filename="gio/gdrive.c" + line="157">a #GDrive. Gets the identifier of the given kind for @drive. The only + filename="gio/gdrive.c" + line="609">Gets the identifier of the given kind for @drive. The only identifier currently available is %G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE. - + a newly allocated string containing the + filename="gio/gdrive.c" + line="618">a newly allocated string containing the requested identifier, or %NULL if the #GDrive doesn't have this kind of identifier. @@ -35042,36 +36005,35 @@ identifier currently available is a #GDrive + filename="gio/gdrive.c" + line="611">a #GDrive the kind of identifier to return + filename="gio/gdrive.c" + line="612">the kind of identifier to return Gets the name of @drive. - + filename="gio/gdrive.c" + line="134">Gets the name of @drive. + a string containing @drive's name. The returned + filename="gio/gdrive.c" + line="140">a string containing @drive's name. The returned string should be freed when no longer needed. a #GDrive. + filename="gio/gdrive.c" + line="136">a #GDrive. @@ -35080,21 +36042,20 @@ identifier currently available is invoker="get_sort_key" version="2.32"> Gets the sort key for @drive, if any. - + filename="gio/gdrive.c" + line="920">Gets the sort key for @drive, if any. + Sorting key for @drive or %NULL if no such key is available. + filename="gio/gdrive.c" + line="926">Sorting key for @drive or %NULL if no such key is available. A #GDrive. + filename="gio/gdrive.c" + line="922">A #GDrive. @@ -35103,21 +36064,20 @@ identifier currently available is invoker="get_start_stop_type" version="2.22"> Gets a hint about how a drive can be started/stopped. - + filename="gio/gdrive.c" + line="665">Gets a hint about how a drive can be started/stopped. + A value from the #GDriveStartStopType enumeration. + filename="gio/gdrive.c" + line="671">A value from the #GDriveStartStopType enumeration. a #GDrive. + filename="gio/gdrive.c" + line="667">a #GDrive. @@ -35126,39 +36086,37 @@ identifier currently available is invoker="get_symbolic_icon" version="2.34"> Gets the icon for @drive. - + filename="gio/gdrive.c" + line="176">Gets the icon for @drive. + symbolic #GIcon for the @drive. + filename="gio/gdrive.c" + line="182">symbolic #GIcon for the @drive. Free the returned object with g_object_unref(). a #GDrive. + filename="gio/gdrive.c" + line="178">a #GDrive. Get a list of mountable volumes for @drive. + filename="gio/gdrive.c" + line="225">Get a list of mountable volumes for @drive. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - + #GList containing any #GVolume objects on the given @drive. + filename="gio/gdrive.c" + line="234">#GList containing any #GVolume objects on the given @drive. @@ -35166,52 +36124,50 @@ its elements have been unreffed with g_object_unref(). a #GDrive. + filename="gio/gdrive.c" + line="227">a #GDrive. Checks if the @drive has media. Note that the OS may not be polling + filename="gio/gdrive.c" + line="314">Checks if the @drive has media. Note that the OS may not be polling the drive for media changes; see g_drive_is_media_check_automatic() for more details. - + %TRUE if @drive has media, %FALSE otherwise. + filename="gio/gdrive.c" + line="322">%TRUE if @drive has media, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="316">a #GDrive. Check if @drive has any mountable volumes. - + filename="gio/gdrive.c" + line="205">Check if @drive has any mountable volumes. + %TRUE if the @drive contains volumes, %FALSE otherwise. + filename="gio/gdrive.c" + line="211">%TRUE if the @drive contains volumes, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="207">a #GDrive. @@ -35219,43 +36175,41 @@ for more details. Checks if @drive is capable of automatically detecting media changes. - + filename="gio/gdrive.c" + line="248">Checks if @drive is capable of automatically detecting media changes. + %TRUE if the @drive is capable of automatically detecting + filename="gio/gdrive.c" + line="254">%TRUE if the @drive is capable of automatically detecting media changes, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="250">a #GDrive. Checks if the @drive supports removable media. - + filename="gio/gdrive.c" + line="294">Checks if the @drive supports removable media. + %TRUE if @drive supports removable media, %FALSE otherwise. + filename="gio/gdrive.c" + line="300">%TRUE if @drive supports removable media, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="296">a #GDrive. @@ -35264,44 +36218,44 @@ for more details. invoker="is_removable" version="2.50"> Checks if the #GDrive and/or its media is considered removable by the user. + filename="gio/gdrive.c" + line="269">Checks if the #GDrive and/or its media is considered removable by the user. See g_drive_is_media_removable(). - + %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + filename="gio/gdrive.c" + line="276">%TRUE if @drive and/or its media is considered removable, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="271">a #GDrive. - + Asynchronously polls @drive to see if media has been inserted or removed. + filename="gio/gdrive.c" + line="541">Asynchronously polls @drive to see if media has been inserted or removed. When the operation is finished, @callback will be called. You can then call g_drive_poll_for_media_finish() to obtain the result of the operation. - + a #GDrive. + filename="gio/gdrive.c" + line="543">a #GDrive. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="544">optional #GCancellable object, %NULL to ignore. scope="async" closure="2"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="545">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="2"> user data to pass to @callback + filename="gio/gdrive.c" + line="546">user data to pass to @callback @@ -35340,56 +36294,57 @@ result of the operation. invoker="poll_for_media_finish" throws="1"> Finishes an operation started with g_drive_poll_for_media() on a drive. - + filename="gio/gdrive.c" + line="578">Finishes an operation started with g_drive_poll_for_media() on a drive. + %TRUE if the drive has been poll_for_mediaed successfully, + filename="gio/gdrive.c" + line="586">%TRUE if the drive has been poll_for_mediaed successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="580">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="581">a #GAsyncResult. - + Asynchronously starts a drive. + filename="gio/gdrive.c" + line="741">Asynchronously starts a drive. When the operation is finished, @callback will be called. You can then call g_drive_start_finish() to obtain the result of the operation. - + a #GDrive. + filename="gio/gdrive.c" + line="743">a #GDrive. flags affecting the start operation. + filename="gio/gdrive.c" + line="744">flags affecting the start operation. nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gdrive.c" + line="745">a #GMountOperation or %NULL to avoid user interaction. @@ -35407,8 +36362,8 @@ result of the operation. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="747">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="748">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="4"> user data to pass to @callback + filename="gio/gdrive.c" + line="749">user data to pass to @callback @@ -35439,56 +36394,57 @@ result of the operation. version="2.22" throws="1"> Finishes starting a drive. - + filename="gio/gdrive.c" + line="785">Finishes starting a drive. + %TRUE if the drive has been started successfully, + filename="gio/gdrive.c" + line="793">%TRUE if the drive has been started successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="787">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="788">a #GAsyncResult. - + Asynchronously stops a drive. + filename="gio/gdrive.c" + line="843">Asynchronously stops a drive. When the operation is finished, @callback will be called. You can then call g_drive_stop_finish() to obtain the result of the operation. - + a #GDrive. + filename="gio/gdrive.c" + line="845">a #GDrive. flags affecting the unmount if required for stopping. + filename="gio/gdrive.c" + line="846">flags affecting the unmount if required for stopping. nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gdrive.c" + line="847">a #GMountOperation or %NULL to avoid user interaction. @@ -35506,8 +36462,8 @@ result of the operation. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="849">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="850">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="4"> user data to pass to @callback + filename="gio/gdrive.c" + line="851">user data to pass to @callback - + Signal emitted when the physical stop button (if any) of a drive have been pressed. Since 2.22. + @@ -35550,49 +36508,47 @@ result of the operation. version="2.22" throws="1"> Finishes stopping a drive. - + filename="gio/gdrive.c" + line="887">Finishes stopping a drive. + %TRUE if the drive has been stopped successfully, + filename="gio/gdrive.c" + line="895">%TRUE if the drive has been stopped successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="889">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="890">a #GAsyncResult. Checks if a drive can be ejected. - + filename="gio/gdrive.c" + line="336">Checks if a drive can be ejected. + %TRUE if the @drive can be ejected, %FALSE otherwise. + filename="gio/gdrive.c" + line="342">%TRUE if the @drive can be ejected, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="338">a #GDrive. @@ -35600,43 +36556,41 @@ result of the operation. Checks if a drive can be polled for media changes. - + filename="gio/gdrive.c" + line="359">Checks if a drive can be polled for media changes. + %TRUE if the @drive can be polled for media changes, + filename="gio/gdrive.c" + line="365">%TRUE if the @drive can be polled for media changes, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="361">a #GDrive. Checks if a drive can be started. - + filename="gio/gdrive.c" + line="691">Checks if a drive can be started. + %TRUE if the @drive can be started, %FALSE otherwise. + filename="gio/gdrive.c" + line="697">%TRUE if the @drive can be started, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="693">a #GDrive. @@ -35645,42 +36599,40 @@ result of the operation. c:identifier="g_drive_can_start_degraded" version="2.22"> Checks if a drive can be started degraded. - + filename="gio/gdrive.c" + line="716">Checks if a drive can be started degraded. + %TRUE if the @drive can be started degraded, %FALSE otherwise. + filename="gio/gdrive.c" + line="722">%TRUE if the @drive can be started degraded, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="718">a #GDrive. Checks if a drive can be stopped. - + filename="gio/gdrive.c" + line="818">Checks if a drive can be stopped. + %TRUE if the @drive can be stopped, %FALSE otherwise. + filename="gio/gdrive.c" + line="824">%TRUE if the @drive can be stopped, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="820">a #GDrive. @@ -35688,31 +36640,31 @@ result of the operation. + deprecated-version="2.22" + glib:finish-func="eject_finish"> Asynchronously ejects a drive. + filename="gio/gdrive.c" + line="383">Asynchronously ejects a drive. When the operation is finished, @callback will be called. You can then call g_drive_eject_finish() to obtain the result of the operation. Use g_drive_eject_with_operation() instead. - + a #GDrive. + filename="gio/gdrive.c" + line="385">a #GDrive. flags affecting the unmount if required for eject + filename="gio/gdrive.c" + line="386">flags affecting the unmount if required for eject nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="387">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="388">a #GAsyncReadyCallback, or %NULL. nullable="1" allow-none="1"> user data to pass to @callback + filename="gio/gdrive.c" + line="389">user data to pass to @callback @@ -35752,57 +36704,56 @@ result of the operation. deprecated-version="2.22" throws="1"> Finishes ejecting a drive. + filename="gio/gdrive.c" + line="424">Finishes ejecting a drive. Use g_drive_eject_with_operation_finish() instead. - + %TRUE if the drive has been ejected successfully, + filename="gio/gdrive.c" + line="432">%TRUE if the drive has been ejected successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="426">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="427">a #GAsyncResult. + version="2.22" + glib:finish-func="eject_with_operation_finish"> Ejects a drive. This is an asynchronous operation, and is + filename="gio/gdrive.c" + line="457">Ejects a drive. This is an asynchronous operation, and is finished by calling g_drive_eject_with_operation_finish() with the @drive and #GAsyncResult data returned in the @callback. - + a #GDrive. + filename="gio/gdrive.c" + line="459">a #GDrive. flags affecting the unmount if required for eject + filename="gio/gdrive.c" + line="460">flags affecting the unmount if required for eject nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gdrive.c" + line="461">a #GMountOperation or %NULL to avoid user interaction. @@ -35820,8 +36771,8 @@ and #GAsyncResult data returned in the @callback. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="463">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="464">a #GAsyncReadyCallback, or %NULL. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gdrive.c" + line="465">user data passed to @callback. @@ -35851,28 +36802,27 @@ and #GAsyncResult data returned in the @callback. version="2.22" throws="1"> Finishes ejecting a drive. If any errors occurred during the operation, + filename="gio/gdrive.c" + line="505">Finishes ejecting a drive. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + %TRUE if the drive was successfully ejected. %FALSE otherwise. + filename="gio/gdrive.c" + line="515">%TRUE if the drive was successfully ejected. %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="507">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="508">a #GAsyncResult. @@ -35880,16 +36830,15 @@ and #GAsyncResult data returned in the @callback. Gets the kinds of identifiers that @drive has. + filename="gio/gdrive.c" + line="639">Gets the kinds of identifiers that @drive has. Use g_drive_get_identifier() to obtain the identifiers themselves. - + a %NULL-terminated + filename="gio/gdrive.c" + line="647">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -35899,46 +36848,44 @@ themselves. a #GDrive + filename="gio/gdrive.c" + line="641">a #GDrive Gets the icon for @drive. - + filename="gio/gdrive.c" + line="155">Gets the icon for @drive. + #GIcon for the @drive. + filename="gio/gdrive.c" + line="161">#GIcon for the @drive. Free the returned object with g_object_unref(). a #GDrive. + filename="gio/gdrive.c" + line="157">a #GDrive. Gets the identifier of the given kind for @drive. The only + filename="gio/gdrive.c" + line="609">Gets the identifier of the given kind for @drive. The only identifier currently available is %G_DRIVE_IDENTIFIER_KIND_UNIX_DEVICE. - + a newly allocated string containing the + filename="gio/gdrive.c" + line="618">a newly allocated string containing the requested identifier, or %NULL if the #GDrive doesn't have this kind of identifier. @@ -35946,36 +36893,35 @@ identifier currently available is a #GDrive + filename="gio/gdrive.c" + line="611">a #GDrive the kind of identifier to return + filename="gio/gdrive.c" + line="612">the kind of identifier to return Gets the name of @drive. - + filename="gio/gdrive.c" + line="134">Gets the name of @drive. + a string containing @drive's name. The returned + filename="gio/gdrive.c" + line="140">a string containing @drive's name. The returned string should be freed when no longer needed. a #GDrive. + filename="gio/gdrive.c" + line="136">a #GDrive. @@ -35984,21 +36930,20 @@ identifier currently available is c:identifier="g_drive_get_sort_key" version="2.32"> Gets the sort key for @drive, if any. - + filename="gio/gdrive.c" + line="920">Gets the sort key for @drive, if any. + Sorting key for @drive or %NULL if no such key is available. + filename="gio/gdrive.c" + line="926">Sorting key for @drive or %NULL if no such key is available. A #GDrive. + filename="gio/gdrive.c" + line="922">A #GDrive. @@ -36007,21 +36952,20 @@ identifier currently available is c:identifier="g_drive_get_start_stop_type" version="2.22"> Gets a hint about how a drive can be started/stopped. - + filename="gio/gdrive.c" + line="665">Gets a hint about how a drive can be started/stopped. + A value from the #GDriveStartStopType enumeration. + filename="gio/gdrive.c" + line="671">A value from the #GDriveStartStopType enumeration. a #GDrive. + filename="gio/gdrive.c" + line="667">a #GDrive. @@ -36030,39 +36974,37 @@ identifier currently available is c:identifier="g_drive_get_symbolic_icon" version="2.34"> Gets the icon for @drive. - + filename="gio/gdrive.c" + line="176">Gets the icon for @drive. + symbolic #GIcon for the @drive. + filename="gio/gdrive.c" + line="182">symbolic #GIcon for the @drive. Free the returned object with g_object_unref(). a #GDrive. + filename="gio/gdrive.c" + line="178">a #GDrive. Get a list of mountable volumes for @drive. + filename="gio/gdrive.c" + line="225">Get a list of mountable volumes for @drive. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - + #GList containing any #GVolume objects on the given @drive. + filename="gio/gdrive.c" + line="234">#GList containing any #GVolume objects on the given @drive. @@ -36070,52 +37012,50 @@ its elements have been unreffed with g_object_unref(). a #GDrive. + filename="gio/gdrive.c" + line="227">a #GDrive. Checks if the @drive has media. Note that the OS may not be polling + filename="gio/gdrive.c" + line="314">Checks if the @drive has media. Note that the OS may not be polling the drive for media changes; see g_drive_is_media_check_automatic() for more details. - + %TRUE if @drive has media, %FALSE otherwise. + filename="gio/gdrive.c" + line="322">%TRUE if @drive has media, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="316">a #GDrive. Check if @drive has any mountable volumes. - + filename="gio/gdrive.c" + line="205">Check if @drive has any mountable volumes. + %TRUE if the @drive contains volumes, %FALSE otherwise. + filename="gio/gdrive.c" + line="211">%TRUE if the @drive contains volumes, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="207">a #GDrive. @@ -36123,22 +37063,21 @@ for more details. Checks if @drive is capable of automatically detecting media changes. - + filename="gio/gdrive.c" + line="248">Checks if @drive is capable of automatically detecting media changes. + %TRUE if the @drive is capable of automatically detecting + filename="gio/gdrive.c" + line="254">%TRUE if the @drive is capable of automatically detecting media changes, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="250">a #GDrive. @@ -36146,21 +37085,20 @@ for more details. Checks if the @drive supports removable media. - + filename="gio/gdrive.c" + line="294">Checks if the @drive supports removable media. + %TRUE if @drive supports removable media, %FALSE otherwise. + filename="gio/gdrive.c" + line="300">%TRUE if @drive supports removable media, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="296">a #GDrive. @@ -36169,44 +37107,44 @@ for more details. c:identifier="g_drive_is_removable" version="2.50"> Checks if the #GDrive and/or its media is considered removable by the user. + filename="gio/gdrive.c" + line="269">Checks if the #GDrive and/or its media is considered removable by the user. See g_drive_is_media_removable(). - + %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + filename="gio/gdrive.c" + line="276">%TRUE if @drive and/or its media is considered removable, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="271">a #GDrive. - + Asynchronously polls @drive to see if media has been inserted or removed. + filename="gio/gdrive.c" + line="541">Asynchronously polls @drive to see if media has been inserted or removed. When the operation is finished, @callback will be called. You can then call g_drive_poll_for_media_finish() to obtain the result of the operation. - + a #GDrive. + filename="gio/gdrive.c" + line="543">a #GDrive. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="544">optional #GCancellable object, %NULL to ignore. scope="async" closure="2"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="545">a #GAsyncReadyCallback, or %NULL. nullable="1" allow-none="1"> user data to pass to @callback + filename="gio/gdrive.c" + line="546">user data to pass to @callback @@ -36244,56 +37182,57 @@ result of the operation. c:identifier="g_drive_poll_for_media_finish" throws="1"> Finishes an operation started with g_drive_poll_for_media() on a drive. - + filename="gio/gdrive.c" + line="578">Finishes an operation started with g_drive_poll_for_media() on a drive. + %TRUE if the drive has been poll_for_mediaed successfully, + filename="gio/gdrive.c" + line="586">%TRUE if the drive has been poll_for_mediaed successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="580">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="581">a #GAsyncResult. - + Asynchronously starts a drive. + filename="gio/gdrive.c" + line="741">Asynchronously starts a drive. When the operation is finished, @callback will be called. You can then call g_drive_start_finish() to obtain the result of the operation. - + a #GDrive. + filename="gio/gdrive.c" + line="743">a #GDrive. flags affecting the start operation. + filename="gio/gdrive.c" + line="744">flags affecting the start operation. nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gdrive.c" + line="745">a #GMountOperation or %NULL to avoid user interaction. @@ -36311,8 +37250,8 @@ result of the operation. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="747">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="748">a #GAsyncReadyCallback, or %NULL. nullable="1" allow-none="1"> user data to pass to @callback + filename="gio/gdrive.c" + line="749">user data to pass to @callback @@ -36342,56 +37281,57 @@ result of the operation. version="2.22" throws="1"> Finishes starting a drive. - + filename="gio/gdrive.c" + line="785">Finishes starting a drive. + %TRUE if the drive has been started successfully, + filename="gio/gdrive.c" + line="793">%TRUE if the drive has been started successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="787">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="788">a #GAsyncResult. - + Asynchronously stops a drive. + filename="gio/gdrive.c" + line="843">Asynchronously stops a drive. When the operation is finished, @callback will be called. You can then call g_drive_stop_finish() to obtain the result of the operation. - + a #GDrive. + filename="gio/gdrive.c" + line="845">a #GDrive. flags affecting the unmount if required for stopping. + filename="gio/gdrive.c" + line="846">flags affecting the unmount if required for stopping. nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gdrive.c" + line="847">a #GMountOperation or %NULL to avoid user interaction. @@ -36409,8 +37349,8 @@ result of the operation. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="849">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="850">a #GAsyncReadyCallback, or %NULL. nullable="1" allow-none="1"> user data to pass to @callback + filename="gio/gdrive.c" + line="851">user data to pass to @callback @@ -36440,44 +37380,43 @@ result of the operation. version="2.22" throws="1"> Finishes stopping a drive. - + filename="gio/gdrive.c" + line="887">Finishes stopping a drive. + %TRUE if the drive has been stopped successfully, + filename="gio/gdrive.c" + line="895">%TRUE if the drive has been stopped successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="889">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="890">a #GAsyncResult. Emitted when the drive's state has changed. + filename="gio/gdrive.c" + line="70">Emitted when the drive's state has changed. This signal is emitted when the #GDrive have been + filename="gio/gdrive.c" + line="84">This signal is emitted when the #GDrive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized. @@ -36487,8 +37426,8 @@ finalized. Emitted when the physical eject button (if any) of a drive has + filename="gio/gdrive.c" + line="101">Emitted when the physical eject button (if any) of a drive has been pressed. @@ -36496,8 +37435,8 @@ been pressed. Emitted when the physical stop button (if any) of a drive has + filename="gio/gdrive.c" + line="116">Emitted when the physical stop button (if any) of a drive has been pressed. @@ -36508,20 +37447,21 @@ been pressed. c:type="GDriveIface" glib:is-gtype-struct-for="Drive"> Interface for creating #GDrive implementations. - + The parent interface. + Signal emitted when the drive is changed. - + @@ -36533,9 +37473,11 @@ been pressed. + The removed signal that is emitted when the #GDrive have been disconnected. If the recipient is holding references to the object they should release them so the object can be finalized. - + @@ -36547,9 +37489,11 @@ been pressed. + Signal emitted when the physical eject button (if any) of a drive have been pressed. - + @@ -36561,75 +37505,83 @@ been pressed. + Returns the name for the given #GDrive. - + a string containing @drive's name. The returned + filename="gio/gdrive.c" + line="140">a string containing @drive's name. The returned string should be freed when no longer needed. a #GDrive. + filename="gio/gdrive.c" + line="136">a #GDrive. + Returns a #GIcon for the given #GDrive. - + #GIcon for the @drive. + filename="gio/gdrive.c" + line="161">#GIcon for the @drive. Free the returned object with g_object_unref(). a #GDrive. + filename="gio/gdrive.c" + line="157">a #GDrive. + Returns %TRUE if the #GDrive has mountable volumes. - + %TRUE if the @drive contains volumes, %FALSE otherwise. + filename="gio/gdrive.c" + line="211">%TRUE if the @drive contains volumes, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="207">a #GDrive. + Returns a list #GList of #GVolume for the #GDrive. - + #GList containing any #GVolume objects on the given @drive. + filename="gio/gdrive.c" + line="234">#GList containing any #GVolume objects on the given @drive. @@ -36637,133 +37589,145 @@ been pressed. a #GDrive. + filename="gio/gdrive.c" + line="227">a #GDrive. + Returns %TRUE if the #GDrive supports removal and insertion of media. - + %TRUE if @drive supports removable media, %FALSE otherwise. + filename="gio/gdrive.c" + line="300">%TRUE if @drive supports removable media, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="296">a #GDrive. + Returns %TRUE if the #GDrive has media inserted. - + %TRUE if @drive has media, %FALSE otherwise. + filename="gio/gdrive.c" + line="322">%TRUE if @drive has media, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="316">a #GDrive. + Returns %TRUE if the #GDrive is capable of automatically detecting media changes. - + %TRUE if the @drive is capable of automatically detecting + filename="gio/gdrive.c" + line="254">%TRUE if the @drive is capable of automatically detecting media changes, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="250">a #GDrive. + Returns %TRUE if the #GDrive can eject media. - + %TRUE if the @drive can be ejected, %FALSE otherwise. + filename="gio/gdrive.c" + line="342">%TRUE if the @drive can be ejected, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="338">a #GDrive. + Returns %TRUE if the #GDrive is capable of manually polling for media change. - + %TRUE if the @drive can be polled for media changes, + filename="gio/gdrive.c" + line="365">%TRUE if the @drive can be polled for media changes, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="361">a #GDrive. + Ejects a #GDrive. - + a #GDrive. + filename="gio/gdrive.c" + line="385">a #GDrive. flags affecting the unmount if required for eject + filename="gio/gdrive.c" + line="386">flags affecting the unmount if required for eject nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="387">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="388">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="4"> user data to pass to @callback + filename="gio/gdrive.c" + line="389">user data to pass to @callback + Finishes an eject operation. - + %TRUE if the drive has been ejected successfully, + filename="gio/gdrive.c" + line="432">%TRUE if the drive has been ejected successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="426">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="427">a #GAsyncResult. + Poll for media insertion/removal on a #GDrive. - + a #GDrive. + filename="gio/gdrive.c" + line="543">a #GDrive. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="544">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="545">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="3"> user data to pass to @callback + filename="gio/gdrive.c" + line="546">user data to pass to @callback + Finishes a media poll operation. - + %TRUE if the drive has been poll_for_mediaed successfully, + filename="gio/gdrive.c" + line="586">%TRUE if the drive has been poll_for_mediaed successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="580">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="581">a #GAsyncResult. + Returns the identifier of the given kind, or %NULL if + the #GDrive doesn't have one. - + a newly allocated string containing the + filename="gio/gdrive.c" + line="618">a newly allocated string containing the requested identifier, or %NULL if the #GDrive doesn't have this kind of identifier. @@ -36915,27 +37888,30 @@ been pressed. a #GDrive + filename="gio/gdrive.c" + line="611">a #GDrive the kind of identifier to return + filename="gio/gdrive.c" + line="612">the kind of identifier to return + Returns an array strings listing the kinds + of identifiers which the #GDrive has. - + a %NULL-terminated + filename="gio/gdrive.c" + line="647">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -36945,91 +37921,99 @@ been pressed. a #GDrive + filename="gio/gdrive.c" + line="641">a #GDrive + Gets a #GDriveStartStopType with details about starting/stopping the drive. Since 2.22. - + A value from the #GDriveStartStopType enumeration. + filename="gio/gdrive.c" + line="671">A value from the #GDriveStartStopType enumeration. a #GDrive. + filename="gio/gdrive.c" + line="667">a #GDrive. + Returns %TRUE if a #GDrive can be started. Since 2.22. - + %TRUE if the @drive can be started, %FALSE otherwise. + filename="gio/gdrive.c" + line="697">%TRUE if the @drive can be started, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="693">a #GDrive. + Returns %TRUE if a #GDrive can be started degraded. Since 2.22. - + %TRUE if the @drive can be started degraded, %FALSE otherwise. + filename="gio/gdrive.c" + line="722">%TRUE if the @drive can be started degraded, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="718">a #GDrive. + Starts a #GDrive. Since 2.22. - + a #GDrive. + filename="gio/gdrive.c" + line="743">a #GDrive. flags affecting the start operation. + filename="gio/gdrive.c" + line="744">flags affecting the start operation. nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gdrive.c" + line="745">a #GMountOperation or %NULL to avoid user interaction. @@ -37047,8 +38031,8 @@ been pressed. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="747">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="748">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="5"> user data to pass to @callback + filename="gio/gdrive.c" + line="749">user data to pass to @callback + Finishes a start operation. Since 2.22. - + %TRUE if the drive has been started successfully, + filename="gio/gdrive.c" + line="793">%TRUE if the drive has been started successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="787">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="788">a #GAsyncResult. + Returns %TRUE if a #GDrive can be stopped. Since 2.22. - + %TRUE if the @drive can be stopped, %FALSE otherwise. + filename="gio/gdrive.c" + line="824">%TRUE if the @drive can be stopped, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="820">a #GDrive. + Stops a #GDrive. Since 2.22. - + a #GDrive. + filename="gio/gdrive.c" + line="845">a #GDrive. flags affecting the unmount if required for stopping. + filename="gio/gdrive.c" + line="846">flags affecting the unmount if required for stopping. nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gdrive.c" + line="847">a #GMountOperation or %NULL to avoid user interaction. @@ -37157,8 +38147,8 @@ been pressed. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="849">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="850">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="5"> user data to pass to @callback + filename="gio/gdrive.c" + line="851">user data to pass to @callback + Finishes a stop operation. Since 2.22. - + %TRUE if the drive has been stopped successfully, + filename="gio/gdrive.c" + line="895">%TRUE if the drive has been stopped successfully, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="889">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="890">a #GAsyncResult. + Signal emitted when the physical stop button (if any) of a drive have been pressed. Since 2.22. - + @@ -37227,23 +38221,25 @@ been pressed. + Starts ejecting a #GDrive using a #GMountOperation. Since 2.22. - + a #GDrive. + filename="gio/gdrive.c" + line="459">a #GDrive. flags affecting the unmount if required for eject + filename="gio/gdrive.c" + line="460">flags affecting the unmount if required for eject nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gdrive.c" + line="461">a #GMountOperation or %NULL to avoid user interaction. @@ -37261,8 +38257,8 @@ been pressed. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gdrive.c" + line="463">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gdrive.c" + line="464">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="5"> user data passed to @callback. + filename="gio/gdrive.c" + line="465">user data passed to @callback. + Finishes an eject operation using a #GMountOperation. Since 2.22. - + %TRUE if the drive was successfully ejected. %FALSE otherwise. + filename="gio/gdrive.c" + line="515">%TRUE if the drive was successfully ejected. %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="507">a #GDrive. a #GAsyncResult. + filename="gio/gdrive.c" + line="508">a #GAsyncResult. + Gets a key used for sorting #GDrive instances or %NULL if no such key exists. Since 2.32. - + Sorting key for @drive or %NULL if no such key is available. + filename="gio/gdrive.c" + line="926">Sorting key for @drive or %NULL if no such key is available. A #GDrive. + filename="gio/gdrive.c" + line="922">A #GDrive. + Returns a symbolic #GIcon for the given #GDrive. Since 2.34. - + symbolic #GIcon for the @drive. + filename="gio/gdrive.c" + line="182">symbolic #GIcon for the @drive. Free the returned object with g_object_unref(). a #GDrive. + filename="gio/gdrive.c" + line="178">a #GDrive. + Returns %TRUE if the #GDrive and/or its media is considered removable by the user. Since 2.50. - + %TRUE if @drive and/or its media is considered removable, %FALSE otherwise. + filename="gio/gdrive.c" + line="276">%TRUE if @drive and/or its media is considered removable, %FALSE otherwise. a #GDrive. + filename="gio/gdrive.c" + line="271">a #GDrive. @@ -37383,7 +38387,7 @@ been pressed. glib:get-type="g_drive_start_flags_get_type" c:type="GDriveStartFlags"> Flags used when starting a drive. glib:nick="none" glib:name="G_DRIVE_START_NONE"> No flags set. @@ -37401,7 +38405,7 @@ been pressed. glib:get-type="g_drive_start_stop_type_get_type" c:type="GDriveStartStopType"> Enumeration describing how a drive can be started/stopped. glib:nick="unknown" glib:name="G_DRIVE_START_STOP_TYPE_UNKNOWN"> Unknown or drive doesn't support start/stop. @@ -37419,7 +38423,7 @@ been pressed. glib:nick="shutdown" glib:name="G_DRIVE_START_STOP_TYPE_SHUTDOWN"> The stop method will physically shut down the drive and e.g. power down the port the drive is attached to. @@ -37430,7 +38434,7 @@ been pressed. glib:nick="network" glib:name="G_DRIVE_START_STOP_TYPE_NETWORK"> The start/stop methods are used for connecting/disconnect to the drive over the network. @@ -37440,7 +38444,7 @@ been pressed. glib:nick="multidisk" glib:name="G_DRIVE_START_STOP_TYPE_MULTIDISK"> The start/stop methods will assemble/disassemble a virtual drive from several physical drives. @@ -37451,7 +38455,7 @@ been pressed. glib:nick="password" glib:name="G_DRIVE_START_STOP_TYPE_PASSWORD"> The start/stop methods will unlock/lock the disk (for example using the ATA <quote>SECURITY UNLOCK DEVICE</quote> command) @@ -37465,11 +38469,10 @@ been pressed. glib:get-type="g_dtls_client_connection_get_type" glib:type-struct="DtlsClientConnectionInterface"> #GDtlsClientConnection is the client-side subclass of -#GDtlsConnection, representing a client-side DTLS connection. - + filename="gio/gdtlsclientconnection.c" + line="34">`GDtlsClientConnection` is the client-side subclass of +[iface@Gio.DtlsConnection], representing a client-side DTLS connection. + version="2.48" throws="1"> Creates a new #GDtlsClientConnection wrapping @base_socket which is + filename="gio/gdtlsclientconnection.c" + line="126">Creates a new #GDtlsClientConnection wrapping @base_socket which is assumed to communicate with the server identified by @server_identity. - + the new + filename="gio/gdtlsclientconnection.c" + line="135">the new #GDtlsClientConnection, or %NULL on error the #GDatagramBased to wrap + filename="gio/gdtlsclientconnection.c" + line="128">the #GDatagramBased to wrap nullable="1" allow-none="1"> the expected identity of the server + filename="gio/gdtlsclientconnection.c" + line="129">the expected identity of the server @@ -37512,20 +38514,19 @@ assumed to communicate with the server identified by @server_identity. glib:get-property="accepted-cas" version="2.48"> Gets the list of distinguished names of the Certificate Authorities + filename="gio/gdtlsclientconnection.c" + line="256">Gets the list of distinguished names of the Certificate Authorities that the server will accept certificates from. This will be set during the TLS handshake if the server requests a certificate. Otherwise, it will be %NULL. Each item in the list is a #GByteArray which contains the complete subject DN of the certificate authority. - + the list of + filename="gio/gdtlsclientconnection.c" + line="268">the list of CA DNs. You should unref each element with g_byte_array_unref() and then the free the list with g_list_free(). @@ -37537,8 +38538,8 @@ the free the list with g_list_free(). the #GDtlsClientConnection + filename="gio/gdtlsclientconnection.c" + line="258">the #GDtlsClientConnection @@ -37548,14 +38549,13 @@ the free the list with g_list_free(). glib:get-property="server-identity" version="2.48"> Gets @conn's expected server identity - + filename="gio/gdtlsclientconnection.c" + line="210">Gets @conn's expected server identity + a #GSocketConnectable describing the + filename="gio/gdtlsclientconnection.c" + line="216">a #GSocketConnectable describing the expected server identity, or %NULL if the expected identity is not known. @@ -37563,8 +38563,8 @@ known. the #GDtlsClientConnection + filename="gio/gdtlsclientconnection.c" + line="212">the #GDtlsClientConnection @@ -37576,26 +38576,25 @@ known. deprecated="1" deprecated-version="2.74"> Gets @conn's validation flags + filename="gio/gdtlsclientconnection.c" + line="157">Gets @conn's validation flags This function does not work as originally designed and is impossible to use correctly. See #GDtlsClientConnection:validation-flags for more information. Do not attempt to ignore validation errors. - + the validation flags + filename="gio/gdtlsclientconnection.c" + line="167">the validation flags the #GDtlsClientConnection + filename="gio/gdtlsclientconnection.c" + line="159">the #GDtlsClientConnection @@ -37605,27 +38604,26 @@ information. glib:set-property="server-identity" version="2.48"> Sets @conn's expected server identity, which is used both to tell + filename="gio/gdtlsclientconnection.c" + line="235">Sets @conn's expected server identity, which is used both to tell servers on virtual hosts which certificate to present, and also to let @conn know what name to look for in the certificate when performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. - + the #GDtlsClientConnection + filename="gio/gdtlsclientconnection.c" + line="237">the #GDtlsClientConnection a #GSocketConnectable describing the expected server identity + filename="gio/gdtlsclientconnection.c" + line="238">a #GSocketConnectable describing the expected server identity @@ -37637,8 +38635,8 @@ performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. deprecated="1" deprecated-version="2.74"> Sets @conn's validation flags, to override the default set of + filename="gio/gdtlsclientconnection.c" + line="184">Sets @conn's validation flags, to override the default set of checks performed when validating a server certificate. By default, %G_TLS_CERTIFICATE_VALIDATE_ALL is used. @@ -37646,22 +38644,21 @@ This function does not work as originally designed and is impossible to use correctly. See #GDtlsClientConnection:validation-flags for more information. Do not attempt to ignore validation errors. - + the #GDtlsClientConnection + filename="gio/gdtlsclientconnection.c" + line="186">the #GDtlsClientConnection the #GTlsCertificateFlags to use + filename="gio/gdtlsclientconnection.c" + line="187">the #GTlsCertificateFlags to use @@ -37671,8 +38668,8 @@ information. transfer-ownership="none" getter="get_accepted_cas"> A list of the distinguished names of the Certificate Authorities + filename="gio/gdtlsclientconnection.c" + line="107">A list of the distinguished names of the Certificate Authorities that the server will accept client certificates signed by. If the server requests a client certificate during the handshake, then this property will be set after the handshake completes. @@ -37691,8 +38688,8 @@ subject DN of the certificate authority. setter="set_server_identity" getter="get_server_identity"> A #GSocketConnectable describing the identity of the server that + filename="gio/gdtlsclientconnection.c" + line="80">A #GSocketConnectable describing the identity of the server that is expected on the other end of the connection. If the %G_TLS_CERTIFICATE_BAD_IDENTITY flag is set in @@ -37719,8 +38716,8 @@ virtual hosts. getter="get_validation_flags" default-value="G_TLS_CERTIFICATE_UNKNOWN_CA | G_TLS_CERTIFICATE_BAD_IDENTITY | G_TLS_CERTIFICATE_NOT_ACTIVATED | G_TLS_CERTIFICATE_EXPIRED | G_TLS_CERTIFICATE_REVOKED | G_TLS_CERTIFICATE_INSECURE | G_TLS_CERTIFICATE_GENERIC_ERROR"> What steps to perform when validating a certificate received from + filename="gio/gdtlsclientconnection.c" + line="48">What steps to perform when validating a certificate received from a server. Server certificates that fail to validate in any of the ways indicated here will be rejected unless the application overrides the default via #GDtlsConnection::accept-certificate. @@ -37745,13 +38742,12 @@ connect to #GDtlsConnection::accept-certificate. glib:is-gtype-struct-for="DtlsClientConnection" version="2.48"> vtable for a #GDtlsClientConnection implementation. - + The parent interface. @@ -37764,32 +38760,35 @@ connect to #GDtlsConnection::accept-certificate. glib:get-type="g_dtls_connection_get_type" glib:type-struct="DtlsConnectionInterface"> #GDtlsConnection is the base DTLS connection class type, which wraps -a #GDatagramBased and provides DTLS encryption on top of it. Its -subclasses, #GDtlsClientConnection and #GDtlsServerConnection, -implement client-side and server-side DTLS, respectively. + filename="gio/gdtlsconnection.c" + line="38">`GDtlsConnection` is the base DTLS connection class type, which wraps +a [iface@Gio.DatagramBased] and provides DTLS encryption on top of it. Its +subclasses, [iface@Gio.DtlsClientConnection] and +[iface@Gio.DtlsServerConnection], implement client-side and server-side DTLS, +respectively. -For TLS support, see #GTlsConnection. +For TLS support, see [class@Gio.TlsConnection]. -As DTLS is datagram based, #GDtlsConnection implements #GDatagramBased, -presenting a datagram-socket-like API for the encrypted connection. This -operates over a base datagram connection, which is also a #GDatagramBased -(#GDtlsConnection:base-socket). +As DTLS is datagram based, `GDtlsConnection` implements +[iface@Gio.DatagramBased], presenting a datagram-socket-like API for the +encrypted connection. This operates over a base datagram connection, which is +also a `GDatagramBased` ([property@Gio.DtlsConnection:base-socket]). -To close a DTLS connection, use g_dtls_connection_close(). +To close a DTLS connection, use [method@Gio.DtlsConnection.close]. -Neither #GDtlsServerConnection or #GDtlsClientConnection set the peer address -on their base #GDatagramBased if it is a #GSocket — it is up to the caller to -do that if they wish. If they do not, and g_socket_close() is called on the -base socket, the #GDtlsConnection will not raise a %G_IO_ERROR_NOT_CONNECTED -error on further I/O. - +Neither [iface@Gio.DtlsServerConnection] or [iface@Gio.DtlsClientConnection] +set the peer address on their base [iface@Gio.DatagramBased] if it is a +[class@Gio.Socket] — it is up to the caller to do that if they wish. If they +do not, and [method@Gio.Socket.close] is called on the base socket, the +`GDtlsConnection` will not raise a `G_IO_ERROR_NOT_CONNECTED` error on +further I/O. + - + Check whether to accept a certificate. + @@ -37806,8 +38805,10 @@ error on further I/O. - + Retrieve TLS channel binding data (Since: 2.66) + @@ -37830,27 +38831,26 @@ error on further I/O. invoker="get_negotiated_protocol" version="2.60"> Gets the name of the application-layer protocol negotiated during + filename="gio/gdtlsconnection.c" + line="1084">Gets the name of the application-layer protocol negotiated during the handshake. If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of @conn's protocols, or the TLS backend does not support ALPN, then this will be %NULL. See g_dtls_connection_set_advertised_protocols(). - + the negotiated protocol, or %NULL + filename="gio/gdtlsconnection.c" + line="1096">the negotiated protocol, or %NULL a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="1086">a #GDtlsConnection @@ -37858,10 +38858,11 @@ g_dtls_connection_set_advertised_protocols(). + throws="1" + glib:async-func="handshake_async"> Attempts a TLS handshake on @conn. + filename="gio/gdtlsconnection.c" + line="707">Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -37887,19 +38888,18 @@ the initial handshake will no longer do anything. #GDtlsConnection::accept_certificate may be emitted during the handshake. - + success or failure + filename="gio/gdtlsconnection.c" + line="740">success or failure a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="709">a #GDtlsConnection nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="710">a #GCancellable, or %NULL + version="2.48" + glib:finish-func="handshake_finish" + glib:sync-func="handshake"> Asynchronously performs a TLS handshake on @conn. See + filename="gio/gdtlsconnection.c" + line="755">Asynchronously performs a TLS handshake on @conn. See g_dtls_connection_handshake() for more information. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="757">a #GDtlsConnection the [I/O priority][io-priority] of the request + filename="gio/gdtlsconnection.c" + line="758">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="759">a #GCancellable, or %NULL scope="async" closure="3"> callback to call when the handshake is complete + filename="gio/gdtlsconnection.c" + line="760">callback to call when the handshake is complete allow-none="1" closure="3"> the data to pass to the callback function + filename="gio/gdtlsconnection.c" + line="761">the data to pass to the callback function @@ -37975,29 +38976,28 @@ g_dtls_connection_handshake() for more information. version="2.48" throws="1"> Finish an asynchronous TLS handshake operation. See + filename="gio/gdtlsconnection.c" + line="782">Finish an asynchronous TLS handshake operation. See g_dtls_connection_handshake() for more information. - + %TRUE on success, %FALSE on failure, in which + filename="gio/gdtlsconnection.c" + line="791">%TRUE on success, %FALSE on failure, in which case @error will be set. a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="784">a #GDtlsConnection a #GAsyncResult. + filename="gio/gdtlsconnection.c" + line="785">a #GAsyncResult. @@ -38006,8 +39006,8 @@ case @error will be set. invoker="set_advertised_protocols" version="2.60"> Sets the list of application-layer protocols to advertise that the + filename="gio/gdtlsconnection.c" + line="1052">Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use @@ -38017,16 +39017,15 @@ of @protocols will disable ALPN negotiation. See [IANA TLS ALPN Protocol IDs](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids) for a list of registered protocol IDs. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="1054">a #GDtlsConnection nullable="1" allow-none="1"> a %NULL-terminated + filename="gio/gdtlsconnection.c" + line="1055">a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -38046,10 +39045,11 @@ for a list of registered protocol IDs. + throws="1" + glib:async-func="shutdown_async"> Shut down part or all of a DTLS connection. + filename="gio/gdtlsconnection.c" + line="808">Shut down part or all of a DTLS connection. If @shutdown_read is %TRUE then the receiving side of the connection is shut down, and further reading is disallowed. Subsequent calls to @@ -38065,31 +39065,30 @@ is equivalent to calling g_dtls_connection_close(). If @cancellable is cancelled, the #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call g_dtls_connection_shutdown() again to complete closing the #GDtlsConnection. - + %TRUE on success, %FALSE otherwise + filename="gio/gdtlsconnection.c" + line="833">%TRUE on success, %FALSE otherwise a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="810">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + filename="gio/gdtlsconnection.c" + line="811">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + filename="gio/gdtlsconnection.c" + line="812">%TRUE to stop sending outgoing datagrams a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="813">a #GCancellable, or %NULL + version="2.48" + glib:finish-func="shutdown_finish" + glib:sync-func="shutdown"> Asynchronously shut down part or all of the DTLS connection. See + filename="gio/gdtlsconnection.c" + line="861">Asynchronously shut down part or all of the DTLS connection. See g_dtls_connection_shutdown() for more information. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="863">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + filename="gio/gdtlsconnection.c" + line="864">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + filename="gio/gdtlsconnection.c" + line="865">%TRUE to stop sending outgoing datagrams the [I/O priority][io-priority] of the request + filename="gio/gdtlsconnection.c" + line="866">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="867">a #GCancellable, or %NULL scope="async" closure="5"> callback to call when the shutdown operation is complete + filename="gio/gdtlsconnection.c" + line="868">callback to call when the shutdown operation is complete allow-none="1" closure="5"> the data to pass to the callback function + filename="gio/gdtlsconnection.c" + line="869">the data to pass to the callback function @@ -38177,29 +39177,28 @@ g_dtls_connection_shutdown() for more information. version="2.48" throws="1"> Finish an asynchronous TLS shutdown operation. See + filename="gio/gdtlsconnection.c" + line="897">Finish an asynchronous TLS shutdown operation. See g_dtls_connection_shutdown() for more information. - + %TRUE on success, %FALSE on failure, in which + filename="gio/gdtlsconnection.c" + line="906">%TRUE on success, %FALSE on failure, in which case @error will be set a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="899">a #GDtlsConnection a #GAsyncResult + filename="gio/gdtlsconnection.c" + line="900">a #GAsyncResult @@ -38207,10 +39206,11 @@ case @error will be set + throws="1" + glib:async-func="close_async"> Close the DTLS connection. This is equivalent to calling + filename="gio/gdtlsconnection.c" + line="927">Close the DTLS connection. This is equivalent to calling g_dtls_connection_shutdown() to shut down both sides of the connection. Closing a #GDtlsConnection waits for all buffered but untransmitted data to @@ -38229,19 +39229,18 @@ released as early as possible. If @cancellable is cancelled, the #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call g_dtls_connection_close() again to complete closing the #GDtlsConnection. - + %TRUE on success, %FALSE otherwise + filename="gio/gdtlsconnection.c" + line="953">%TRUE on success, %FALSE otherwise a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="929">a #GDtlsConnection nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="930">a #GCancellable, or %NULL + version="2.48" + glib:finish-func="close_finish" + glib:sync-func="close"> Asynchronously close the DTLS connection. See g_dtls_connection_close() for + filename="gio/gdtlsconnection.c" + line="971">Asynchronously close the DTLS connection. See g_dtls_connection_close() for more information. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="973">a #GDtlsConnection the [I/O priority][io-priority] of the request + filename="gio/gdtlsconnection.c" + line="974">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="975">a #GCancellable, or %NULL scope="async" closure="3"> callback to call when the close operation is complete + filename="gio/gdtlsconnection.c" + line="976">callback to call when the close operation is complete nullable="1" allow-none="1"> the data to pass to the callback function + filename="gio/gdtlsconnection.c" + line="977">the data to pass to the callback function @@ -38316,29 +39316,28 @@ more information. version="2.48" throws="1"> Finish an asynchronous TLS close operation. See g_dtls_connection_close() + filename="gio/gdtlsconnection.c" + line="1000">Finish an asynchronous TLS close operation. See g_dtls_connection_close() for more information. - + %TRUE on success, %FALSE on failure, in which + filename="gio/gdtlsconnection.c" + line="1009">%TRUE on success, %FALSE on failure, in which case @error will be set a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="1002">a #GDtlsConnection a #GAsyncResult + filename="gio/gdtlsconnection.c" + line="1003">a #GAsyncResult @@ -38347,35 +39346,34 @@ case @error will be set c:identifier="g_dtls_connection_emit_accept_certificate" version="2.48"> Used by #GDtlsConnection implementations to emit the + filename="gio/gdtlsconnection.c" + line="1026">Used by #GDtlsConnection implementations to emit the #GDtlsConnection::accept-certificate signal. - + %TRUE if one of the signal handlers has returned + filename="gio/gdtlsconnection.c" + line="1035">%TRUE if one of the signal handlers has returned %TRUE to accept @peer_cert a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="1028">a #GDtlsConnection the peer's #GTlsCertificate + filename="gio/gdtlsconnection.c" + line="1029">the peer's #GTlsCertificate the problems with @peer_cert + filename="gio/gdtlsconnection.c" + line="1030">the problems with @peer_cert @@ -38385,22 +39383,21 @@ case @error will be set glib:get-property="certificate" version="2.48"> Gets @conn's certificate, as set by + filename="gio/gdtlsconnection.c" + line="452">Gets @conn's certificate, as set by g_dtls_connection_set_certificate(). - + @conn's certificate, or %NULL + filename="gio/gdtlsconnection.c" + line="459">@conn's certificate, or %NULL a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="454">a #GDtlsConnection @@ -38410,8 +39407,8 @@ g_dtls_connection_set_certificate(). version="2.66" throws="1"> Query the TLS backend for TLS channel binding data of @type for @conn. + filename="gio/gdtlsconnection.c" + line="1112">Query the TLS backend for TLS channel binding data of @type for @conn. This call retrieves TLS channel binding data as specified in RFC [5056](https://tools.ietf.org/html/rfc5056), RFC @@ -38424,25 +39421,24 @@ is supported by the TLS backend). It does not guarantee that the data will be available though. That could happen if TLS connection does not support @type or the binding data is not available yet due to additional negotiation or input required. - + %TRUE on success, %FALSE otherwise + filename="gio/gdtlsconnection.c" + line="1134">%TRUE on success, %FALSE otherwise a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="1114">a #GDtlsConnection #GTlsChannelBindingType type of data to fetch + filename="gio/gdtlsconnection.c" + line="1115">#GTlsChannelBindingType type of data to fetch @@ -38453,8 +39449,8 @@ negotiation or input required. optional="1" allow-none="1"> #GByteArray is + filename="gio/gdtlsconnection.c" + line="1116">#GByteArray is filled with the binding data, or %NULL @@ -38467,8 +39463,8 @@ negotiation or input required. glib:get-property="ciphersuite-name" version="2.70"> Returns the name of the current DTLS ciphersuite, or %NULL if the + filename="gio/gdtlsconnection.c" + line="1193">Returns the name of the current DTLS ciphersuite, or %NULL if the connection has not handshaked or has been closed. Beware that the TLS backend may use any of multiple different naming conventions, because OpenSSL and GnuTLS have their own ciphersuite naming conventions that @@ -38476,19 +39472,18 @@ are different from each other and different from the standard, IANA- registered ciphersuite names. The ciphersuite name is intended to be displayed to the user for informative purposes only, and parsing it is not recommended. - + The name of the current DTLS ciphersuite, or %NULL + filename="gio/gdtlsconnection.c" + line="1206">The name of the current DTLS ciphersuite, or %NULL a #GDTlsConnection + filename="gio/gdtlsconnection.c" + line="1195">a #GDTlsConnection @@ -38498,22 +39493,21 @@ is not recommended. glib:get-property="database" version="2.48"> Gets the certificate database that @conn uses to verify + filename="gio/gdtlsconnection.c" + line="390">Gets the certificate database that @conn uses to verify peer certificates. See g_dtls_connection_set_database(). - + the certificate database that @conn uses or %NULL + filename="gio/gdtlsconnection.c" + line="397">the certificate database that @conn uses or %NULL a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="392">a #GDtlsConnection @@ -38523,23 +39517,22 @@ peer certificates. See g_dtls_connection_set_database(). glib:get-property="interaction" version="2.48"> Get the object that will be used to interact with the user. It will be used + filename="gio/gdtlsconnection.c" + line="501">Get the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. If %NULL is returned, then no user interaction will occur for this connection. - + The interaction object. + filename="gio/gdtlsconnection.c" + line="509">The interaction object. a connection + filename="gio/gdtlsconnection.c" + line="503">a connection @@ -38549,27 +39542,26 @@ no user interaction will occur for this connection. glib:get-property="negotiated-protocol" version="2.60"> Gets the name of the application-layer protocol negotiated during + filename="gio/gdtlsconnection.c" + line="1084">Gets the name of the application-layer protocol negotiated during the handshake. If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of @conn's protocols, or the TLS backend does not support ALPN, then this will be %NULL. See g_dtls_connection_set_advertised_protocols(). - + the negotiated protocol, or %NULL + filename="gio/gdtlsconnection.c" + line="1096">the negotiated protocol, or %NULL a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="1086">a #GDtlsConnection @@ -38579,23 +39571,22 @@ g_dtls_connection_set_advertised_protocols(). glib:get-property="peer-certificate" version="2.48"> Gets @conn's peer's certificate after the handshake has completed + filename="gio/gdtlsconnection.c" + line="527">Gets @conn's peer's certificate after the handshake has completed or failed. (It is not set during the emission of #GDtlsConnection::accept-certificate.) - + @conn's peer's certificate, or %NULL + filename="gio/gdtlsconnection.c" + line="535">@conn's peer's certificate, or %NULL a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="529">a #GDtlsConnection @@ -38605,23 +39596,22 @@ or failed. (It is not set during the emission of glib:get-property="peer-certificate-errors" version="2.48"> Gets the errors associated with validating @conn's peer's + filename="gio/gdtlsconnection.c" + line="553">Gets the errors associated with validating @conn's peer's certificate, after the handshake has completed or failed. (It is not set during the emission of #GDtlsConnection::accept-certificate.) - + @conn's peer's certificate errors + filename="gio/gdtlsconnection.c" + line="561">@conn's peer's certificate errors a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="555">a #GDtlsConnection @@ -38631,24 +39621,23 @@ not set during the emission of #GDtlsConnection::accept-certificate.) glib:get-property="protocol-version" version="2.70"> Returns the current DTLS protocol version, which may be + filename="gio/gdtlsconnection.c" + line="1161">Returns the current DTLS protocol version, which may be %G_TLS_PROTOCOL_VERSION_UNKNOWN if the connection has not handshaked, or has been closed, or if the TLS backend has implemented a protocol version that is not a recognized #GTlsProtocolVersion. - + The current DTLS protocol version + filename="gio/gdtlsconnection.c" + line="1170">The current DTLS protocol version a #GDTlsConnection + filename="gio/gdtlsconnection.c" + line="1163">a #GDTlsConnection @@ -38660,25 +39649,24 @@ that is not a recognized #GTlsProtocolVersion. deprecated="1" deprecated-version="2.64."> Gets @conn rehandshaking mode. See + filename="gio/gdtlsconnection.c" + line="674">Gets @conn rehandshaking mode. See g_dtls_connection_set_rehandshake_mode() for details. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - + %G_TLS_REHANDSHAKE_SAFELY + filename="gio/gdtlsconnection.c" + line="681">%G_TLS_REHANDSHAKE_SAFELY a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="676">a #GDtlsConnection @@ -38688,23 +39676,22 @@ g_dtls_connection_set_rehandshake_mode() for details. glib:get-property="require-close-notify" version="2.48"> Tests whether or not @conn expects a proper TLS close notification + filename="gio/gdtlsconnection.c" + line="620">Tests whether or not @conn expects a proper TLS close notification when the connection is closed. See g_dtls_connection_set_require_close_notify() for details. - + %TRUE if @conn requires a proper TLS close notification. + filename="gio/gdtlsconnection.c" + line="628">%TRUE if @conn requires a proper TLS close notification. a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="622">a #GDtlsConnection @@ -38712,10 +39699,11 @@ g_dtls_connection_set_require_close_notify() for details. + throws="1" + glib:async-func="handshake_async"> Attempts a TLS handshake on @conn. + filename="gio/gdtlsconnection.c" + line="707">Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -38741,19 +39729,18 @@ the initial handshake will no longer do anything. #GDtlsConnection::accept_certificate may be emitted during the handshake. - + success or failure + filename="gio/gdtlsconnection.c" + line="740">success or failure a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="709">a #GDtlsConnection nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="710">a #GCancellable, or %NULL + version="2.48" + glib:finish-func="handshake_finish" + glib:sync-func="handshake"> Asynchronously performs a TLS handshake on @conn. See + filename="gio/gdtlsconnection.c" + line="755">Asynchronously performs a TLS handshake on @conn. See g_dtls_connection_handshake() for more information. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="757">a #GDtlsConnection the [I/O priority][io-priority] of the request + filename="gio/gdtlsconnection.c" + line="758">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="759">a #GCancellable, or %NULL scope="async" closure="3"> callback to call when the handshake is complete + filename="gio/gdtlsconnection.c" + line="760">callback to call when the handshake is complete nullable="1" allow-none="1"> the data to pass to the callback function + filename="gio/gdtlsconnection.c" + line="761">the data to pass to the callback function @@ -38828,29 +39816,28 @@ g_dtls_connection_handshake() for more information. version="2.48" throws="1"> Finish an asynchronous TLS handshake operation. See + filename="gio/gdtlsconnection.c" + line="782">Finish an asynchronous TLS handshake operation. See g_dtls_connection_handshake() for more information. - + %TRUE on success, %FALSE on failure, in which + filename="gio/gdtlsconnection.c" + line="791">%TRUE on success, %FALSE on failure, in which case @error will be set. a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="784">a #GDtlsConnection a #GAsyncResult. + filename="gio/gdtlsconnection.c" + line="785">a #GAsyncResult. @@ -38860,8 +39847,8 @@ case @error will be set. glib:set-property="advertised-protocols" version="2.60"> Sets the list of application-layer protocols to advertise that the + filename="gio/gdtlsconnection.c" + line="1052">Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use @@ -38871,16 +39858,15 @@ of @protocols will disable ALPN negotiation. See [IANA TLS ALPN Protocol IDs](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids) for a list of registered protocol IDs. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="1054">a #GDtlsConnection nullable="1" allow-none="1"> a %NULL-terminated + filename="gio/gdtlsconnection.c" + line="1055">a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -38902,8 +39888,8 @@ for a list of registered protocol IDs. glib:set-property="certificate" version="2.48"> This sets the certificate that @conn will present to its peer + filename="gio/gdtlsconnection.c" + line="416">This sets the certificate that @conn will present to its peer during the TLS handshake. For a #GDtlsServerConnection, it is mandatory to set this, and that will normally be done at construct time. @@ -38921,22 +39907,21 @@ or without a certificate; in that case, if you don't provide a certificate, you can tell that the server requested one by the fact that g_dtls_client_connection_get_accepted_cas() will return non-%NULL.) - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="418">a #GDtlsConnection the certificate to use for @conn + filename="gio/gdtlsconnection.c" + line="419">the certificate to use for @conn @@ -38946,8 +39931,8 @@ non-%NULL.) glib:set-property="database" version="2.48"> Sets the certificate database that is used to verify peer certificates. + filename="gio/gdtlsconnection.c" + line="359">Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See g_tls_backend_get_default_database(). If set to %NULL, then peer certificate validation will always set the @@ -38958,16 +39943,15 @@ client-side connections, unless that bit is not set in There are nonintuitive security implications when using a non-default database. See #GDtlsConnection:database for details. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="361">a #GDtlsConnection nullable="1" allow-none="1"> a #GTlsDatabase + filename="gio/gdtlsconnection.c" + line="362">a #GTlsDatabase @@ -38986,23 +39970,22 @@ database. See #GDtlsConnection:database for details. glib:set-property="interaction" version="2.48"> Set the object that will be used to interact with the user. It will be used + filename="gio/gdtlsconnection.c" + line="477">Set the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. The @interaction argument will normally be a derived subclass of #GTlsInteraction. %NULL can also be provided if no user interaction should occur for this connection. - + a connection + filename="gio/gdtlsconnection.c" + line="479">a connection nullable="1" allow-none="1"> an interaction object, or %NULL + filename="gio/gdtlsconnection.c" + line="480">an interaction object, or %NULL @@ -39023,30 +40006,29 @@ should occur for this connection. deprecated="1" deprecated-version="2.60."> Since GLib 2.64, changing the rehandshake mode is no longer supported + filename="gio/gdtlsconnection.c" + line="645">Since GLib 2.64, changing the rehandshake mode is no longer supported and will have no effect. With TLS 1.3, rehandshaking has been removed from the TLS protocol, replaced by separate post-handshake authentication and rekey operations. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="647">a #GDtlsConnection the rehandshaking mode + filename="gio/gdtlsconnection.c" + line="648">the rehandshaking mode @@ -39056,8 +40038,8 @@ rekey operations. glib:set-property="require-close-notify" version="2.48"> Sets whether or not @conn expects a proper TLS close notification + filename="gio/gdtlsconnection.c" + line="576">Sets whether or not @conn expects a proper TLS close notification before the connection is closed. If this is %TRUE (the default), then @conn will expect to receive a TLS close notification from its peer before the connection is closed, and will return a @@ -39082,22 +40064,21 @@ connection; when the application calls g_dtls_connection_close_async() on setting of this property. If you explicitly want to do an unclean close, you can close @conn's #GDtlsConnection:base-socket rather than closing @conn itself. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="578">a #GDtlsConnection whether or not to require close notification + filename="gio/gdtlsconnection.c" + line="579">whether or not to require close notification @@ -39105,10 +40086,11 @@ than closing @conn itself. + throws="1" + glib:async-func="shutdown_async"> Shut down part or all of a DTLS connection. + filename="gio/gdtlsconnection.c" + line="808">Shut down part or all of a DTLS connection. If @shutdown_read is %TRUE then the receiving side of the connection is shut down, and further reading is disallowed. Subsequent calls to @@ -39124,31 +40106,30 @@ is equivalent to calling g_dtls_connection_close(). If @cancellable is cancelled, the #GDtlsConnection may be left partially-closed and any pending untransmitted data may be lost. Call g_dtls_connection_shutdown() again to complete closing the #GDtlsConnection. - + %TRUE on success, %FALSE otherwise + filename="gio/gdtlsconnection.c" + line="833">%TRUE on success, %FALSE otherwise a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="810">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + filename="gio/gdtlsconnection.c" + line="811">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + filename="gio/gdtlsconnection.c" + line="812">%TRUE to stop sending outgoing datagrams a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="813">a #GCancellable, or %NULL + version="2.48" + glib:finish-func="shutdown_finish" + glib:sync-func="shutdown"> Asynchronously shut down part or all of the DTLS connection. See + filename="gio/gdtlsconnection.c" + line="861">Asynchronously shut down part or all of the DTLS connection. See g_dtls_connection_shutdown() for more information. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="863">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + filename="gio/gdtlsconnection.c" + line="864">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + filename="gio/gdtlsconnection.c" + line="865">%TRUE to stop sending outgoing datagrams the [I/O priority][io-priority] of the request + filename="gio/gdtlsconnection.c" + line="866">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="867">a #GCancellable, or %NULL scope="async" closure="5"> callback to call when the shutdown operation is complete + filename="gio/gdtlsconnection.c" + line="868">callback to call when the shutdown operation is complete nullable="1" allow-none="1"> the data to pass to the callback function + filename="gio/gdtlsconnection.c" + line="869">the data to pass to the callback function @@ -39235,29 +40217,28 @@ g_dtls_connection_shutdown() for more information. version="2.48" throws="1"> Finish an asynchronous TLS shutdown operation. See + filename="gio/gdtlsconnection.c" + line="897">Finish an asynchronous TLS shutdown operation. See g_dtls_connection_shutdown() for more information. - + %TRUE on success, %FALSE on failure, in which + filename="gio/gdtlsconnection.c" + line="906">%TRUE on success, %FALSE on failure, in which case @error will be set a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="899">a #GDtlsConnection a #GAsyncResult + filename="gio/gdtlsconnection.c" + line="900">a #GAsyncResult @@ -39268,8 +40249,8 @@ case @error will be set transfer-ownership="none" setter="set_advertised_protocols"> The list of application-layer protocols that the connection + filename="gio/gdtlsconnection.c" + line="233">The list of application-layer protocols that the connection advertises that it is willing to speak. See g_dtls_connection_set_advertised_protocols(). @@ -39282,8 +40263,8 @@ g_dtls_connection_set_advertised_protocols(). construct-only="1" transfer-ownership="none"> The #GDatagramBased that the connection wraps. Note that this may be any + filename="gio/gdtlsconnection.c" + line="90">The #GDatagramBased that the connection wraps. Note that this may be any implementation of #GDatagramBased, not just a #GSocket. @@ -39294,8 +40275,8 @@ implementation of #GDatagramBased, not just a #GSocket. setter="set_certificate" getter="get_certificate"> The connection's certificate; see + filename="gio/gdtlsconnection.c" + line="177">The connection's certificate; see g_dtls_connection_set_certificate(). @@ -39305,8 +40286,8 @@ g_dtls_connection_set_certificate(). getter="get_ciphersuite_name" default-value="NULL"> The name of the DTLS ciphersuite in use. See g_dtls_connection_get_ciphersuite_name(). + filename="gio/gdtlsconnection.c" + line="275">The name of the DTLS ciphersuite in use. See g_dtls_connection_get_ciphersuite_name(). setter="set_database" getter="get_database"> The certificate database to use when verifying this TLS connection. + filename="gio/gdtlsconnection.c" + line="104">The certificate database to use when verifying this TLS connection. If no certificate database is set, then the default database will be used. See g_tls_backend_get_default_database(). @@ -39342,8 +40323,8 @@ unusual security requirements. setter="set_interaction" getter="get_interaction"> A #GTlsInteraction object to be used when the connection or certificate + filename="gio/gdtlsconnection.c" + line="131">A #GTlsInteraction object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary. @@ -39354,8 +40335,8 @@ user for passwords where necessary. getter="get_negotiated_protocol" default-value="NULL"> The application-layer protocol negotiated during the TLS + filename="gio/gdtlsconnection.c" + line="247">The application-layer protocol negotiated during the TLS handshake. See g_dtls_connection_get_negotiated_protocol(). @@ -39364,8 +40345,8 @@ handshake. See g_dtls_connection_get_negotiated_protocol(). transfer-ownership="none" getter="get_peer_certificate"> The connection's peer's certificate, after the TLS handshake has + filename="gio/gdtlsconnection.c" + line="190">The connection's peer's certificate, after the TLS handshake has completed or failed. Note in particular that this is not yet set during the emission of #GDtlsConnection::accept-certificate. @@ -39379,8 +40360,8 @@ detect when a handshake has occurred.) getter="get_peer_certificate_errors" default-value="G_TLS_CERTIFICATE_NO_FLAGS"> The errors noticed while verifying + filename="gio/gdtlsconnection.c" + line="207">The errors noticed while verifying #GDtlsConnection:peer-certificate. Normally this should be 0, but it may not be if #GDtlsClientConnection:validation-flags is not %G_TLS_CERTIFICATE_VALIDATE_ALL, or if @@ -39402,8 +40383,8 @@ error flag set even if other problems exist with the certificate. getter="get_protocol_version" default-value="G_TLS_PROTOCOL_VERSION_UNKNOWN"> The DTLS protocol version in use. See g_dtls_connection_get_protocol_version(). + filename="gio/gdtlsconnection.c" + line="261">The DTLS protocol version in use. See g_dtls_connection_get_protocol_version(). getter="get_rehandshake_mode" default-value="G_TLS_REHANDSHAKE_NEVER"> The rehandshaking mode. See + filename="gio/gdtlsconnection.c" + line="159">The rehandshaking mode. See g_dtls_connection_set_rehandshake_mode(). The rehandshake mode is ignored. @@ -39432,15 +40413,15 @@ g_dtls_connection_set_rehandshake_mode(). getter="get_require_close_notify" default-value="TRUE"> Whether or not proper TLS close notification is required. + filename="gio/gdtlsconnection.c" + line="145">Whether or not proper TLS close notification is required. See g_dtls_connection_set_require_close_notify(). Emitted during the TLS handshake after the peer certificate has + filename="gio/gdtlsconnection.c" + line="288">Emitted during the TLS handshake after the peer certificate has been received. You can examine @peer_cert's certification path by calling g_tls_certificate_get_issuer() on it. @@ -39484,8 +40465,8 @@ need to worry about this, and can simply block in the signal handler until the UI thread returns an answer. %TRUE to accept @peer_cert (which will also + filename="gio/gdtlsconnection.c" + line="337">%TRUE to accept @peer_cert (which will also immediately end the signal emission). %FALSE to allow the signal emission to continue, which will cause the handshake to fail if no one else overrides it. @@ -39494,14 +40475,14 @@ no one else overrides it. the peer's #GTlsCertificate + filename="gio/gdtlsconnection.c" + line="291">the peer's #GTlsCertificate the problems with @peer_cert. + filename="gio/gdtlsconnection.c" + line="292">the problems with @peer_cert. @@ -39512,20 +40493,21 @@ no one else overrides it. glib:is-gtype-struct-for="DtlsConnection" version="2.48"> Virtual method table for a #GDtlsConnection implementation. - + The parent interface. + Check whether to accept a certificate. - + @@ -39543,20 +40525,22 @@ no one else overrides it. + Perform a handshake operation. - + success or failure + filename="gio/gdtlsconnection.c" + line="740">success or failure a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="709">a #GDtlsConnection nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="710">a #GCancellable, or %NULL + Start an asynchronous handshake operation. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="757">a #GDtlsConnection the [I/O priority][io-priority] of the request + filename="gio/gdtlsconnection.c" + line="758">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="759">a #GCancellable, or %NULL scope="async" closure="4"> callback to call when the handshake is complete + filename="gio/gdtlsconnection.c" + line="760">callback to call when the handshake is complete allow-none="1" closure="4"> the data to pass to the callback function + filename="gio/gdtlsconnection.c" + line="761">the data to pass to the callback function + Finish an asynchronous handshake operation. - + %TRUE on success, %FALSE on failure, in which + filename="gio/gdtlsconnection.c" + line="791">%TRUE on success, %FALSE on failure, in which case @error will be set. a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="784">a #GDtlsConnection a #GAsyncResult. + filename="gio/gdtlsconnection.c" + line="785">a #GAsyncResult. + Shut down one or both directions of the connection. - + %TRUE on success, %FALSE otherwise + filename="gio/gdtlsconnection.c" + line="833">%TRUE on success, %FALSE otherwise a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="810">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + filename="gio/gdtlsconnection.c" + line="811">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + filename="gio/gdtlsconnection.c" + line="812">%TRUE to stop sending outgoing datagrams nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="813">a #GCancellable, or %NULL + Start an asynchronous shutdown operation. - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="863">a #GDtlsConnection %TRUE to stop reception of incoming datagrams + filename="gio/gdtlsconnection.c" + line="864">%TRUE to stop reception of incoming datagrams %TRUE to stop sending outgoing datagrams + filename="gio/gdtlsconnection.c" + line="865">%TRUE to stop sending outgoing datagrams the [I/O priority][io-priority] of the request + filename="gio/gdtlsconnection.c" + line="866">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gdtlsconnection.c" + line="867">a #GCancellable, or %NULL scope="async" closure="6"> callback to call when the shutdown operation is complete + filename="gio/gdtlsconnection.c" + line="868">callback to call when the shutdown operation is complete allow-none="1" closure="6"> the data to pass to the callback function + filename="gio/gdtlsconnection.c" + line="869">the data to pass to the callback function + Finish an asynchronous shutdown operation. - + %TRUE on success, %FALSE on failure, in which + filename="gio/gdtlsconnection.c" + line="906">%TRUE on success, %FALSE on failure, in which case @error will be set a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="899">a #GDtlsConnection a #GAsyncResult + filename="gio/gdtlsconnection.c" + line="900">a #GAsyncResult + Set APLN protocol list (Since: 2.60) - + a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="1054">a #GDtlsConnection nullable="1" allow-none="1"> a %NULL-terminated + filename="gio/gdtlsconnection.c" + line="1055">a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -39814,29 +40810,33 @@ case @error will be set + Get ALPN-negotiated protocol (Since: 2.60) - + the negotiated protocol, or %NULL + filename="gio/gdtlsconnection.c" + line="1096">the negotiated protocol, or %NULL a #GDtlsConnection + filename="gio/gdtlsconnection.c" + line="1086">a #GDtlsConnection + Retrieve TLS channel binding data (Since: 2.66) - + @@ -39865,11 +40865,10 @@ case @error will be set glib:get-type="g_dtls_server_connection_get_type" glib:type-struct="DtlsServerConnectionInterface"> #GDtlsServerConnection is the server-side subclass of #GDtlsConnection, -representing a server-side DTLS connection. - + filename="gio/gdtlsserverconnection.c" + line="33">`GDtlsServerConnection` is the server-side subclass of +[iface@Gio.DtlsConnection], representing a server-side DTLS connection. + version="2.48" throws="1"> Creates a new #GDtlsServerConnection wrapping @base_socket. - + filename="gio/gdtlsserverconnection.c" + line="64">Creates a new #GDtlsServerConnection wrapping @base_socket. + the new + filename="gio/gdtlsserverconnection.c" + line="72">the new #GDtlsServerConnection, or %NULL on error the #GDatagramBased to wrap + filename="gio/gdtlsserverconnection.c" + line="66">the #GDatagramBased to wrap nullable="1" allow-none="1"> the default server certificate, or %NULL + filename="gio/gdtlsserverconnection.c" + line="67">the default server certificate, or %NULL @@ -39912,8 +40910,8 @@ representing a server-side DTLS connection. transfer-ownership="none" default-value="G_TLS_AUTHENTICATION_NONE"> The #GTlsAuthenticationMode for the server. This can be changed + filename="gio/gdtlsserverconnection.c" + line="47">The #GTlsAuthenticationMode for the server. This can be changed before calling g_dtls_connection_handshake() if you want to rehandshake with a different mode from the initial handshake. @@ -39924,20 +40922,18 @@ rehandshake with a different mode from the initial handshake. glib:is-gtype-struct-for="DtlsServerConnection" version="2.48"> vtable for a #GDtlsServerConnection implementation. - + filename="gio/gdtlsserverconnection.h" + line="40">vtable for a #GDtlsServerConnection implementation. + The parent interface. + filename="gio/gdtlsserverconnection.h" + line="42">The parent interface. - + @@ -39946,8 +40942,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -39956,8 +40951,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -39966,8 +40960,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -39976,8 +40969,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -39986,8 +40978,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -40001,33 +40992,31 @@ rehandshake with a different mode from the initial handshake. glib:get-type="g_emblem_get_type" glib:type-struct="EmblemClass"> #GEmblem is an implementation of #GIcon that supports + filename="gio/gemblem.c" + line="33">`GEmblem` is an implementation of [iface@Gio.Icon] that supports having an emblem, which is an icon with additional properties. -It can than be added to a #GEmblemedIcon. +It can than be added to a [class@Gio.EmblemedIcon]. Currently, only metainformation about the emblem's origin is supported. More may be added in the future. - + Creates a new emblem for @icon. - + filename="gio/gemblem.c" + line="171">Creates a new emblem for @icon. + a new #GEmblem. + filename="gio/gemblem.c" + line="177">a new #GEmblem. a GIcon containing the icon. + filename="gio/gemblem.c" + line="173">a GIcon containing the icon. @@ -40036,27 +41025,26 @@ supported. More may be added in the future. c:identifier="g_emblem_new_with_origin" version="2.18"> Creates a new emblem for @icon. - + filename="gio/gemblem.c" + line="197">Creates a new emblem for @icon. + a new #GEmblem. + filename="gio/gemblem.c" + line="204">a new #GEmblem. a GIcon containing the icon. + filename="gio/gemblem.c" + line="199">a GIcon containing the icon. a GEmblemOrigin enum defining the emblem's origin + filename="gio/gemblem.c" + line="200">a GEmblemOrigin enum defining the emblem's origin @@ -40066,22 +41054,21 @@ supported. More may be added in the future. glib:get-property="icon" version="2.18"> Gives back the icon from @emblem. - + filename="gio/gemblem.c" + line="225">Gives back the icon from @emblem. + a #GIcon. The returned object belongs to + filename="gio/gemblem.c" + line="231">a #GIcon. The returned object belongs to the emblem and should not be modified or freed. a #GEmblem from which the icon should be extracted. + filename="gio/gemblem.c" + line="227">a #GEmblem from which the icon should be extracted. @@ -40091,38 +41078,45 @@ supported. More may be added in the future. glib:get-property="origin" version="2.18"> Gets the origin of the emblem. - + filename="gio/gemblem.c" + line="245">Gets the origin of the emblem. + the origin of the emblem + filename="gio/gemblem.c" + line="251">the origin of the emblem a #GEmblem + filename="gio/gemblem.c" + line="247">a #GEmblem + The actual icon of the emblem. + The origin the emblem is derived from. @@ -40131,8 +41125,7 @@ supported. More may be added in the future. disguised="1" opaque="1" glib:is-gtype-struct-for="Emblem"> - + glib:get-type="g_emblem_origin_get_type" c:type="GEmblemOrigin"> GEmblemOrigin is used to add information about the origin of the emblem + filename="gio/gioenums.h" + line="693">GEmblemOrigin is used to add information about the origin of the emblem to #GEmblem. glib:nick="unknown" glib:name="G_EMBLEM_ORIGIN_UNKNOWN"> Emblem of unknown origin + filename="gio/gioenums.h" + line="695">Emblem of unknown origin glib:nick="device" glib:name="G_EMBLEM_ORIGIN_DEVICE"> Emblem adds device-specific information + filename="gio/gioenums.h" + line="696">Emblem adds device-specific information glib:nick="livemetadata" glib:name="G_EMBLEM_ORIGIN_LIVEMETADATA"> Emblem depicts live metadata, such as "readonly" + filename="gio/gioenums.h" + line="697">Emblem depicts live metadata, such as "readonly" glib:nick="tag" glib:name="G_EMBLEM_ORIGIN_TAG"> Emblem comes from a user-defined tag, e.g. set by nautilus (in the future) + filename="gio/gioenums.h" + line="698">Emblem comes from a user-defined tag, e.g. set by nautilus (in the future) glib:get-type="g_emblemed_icon_get_type" glib:type-struct="EmblemedIconClass"> #GEmblemedIcon is an implementation of #GIcon that supports + filename="gio/gemblemedicon.c" + line="35">`GEmblemedIcon` is an implementation of [iface@Gio.Icon] that supports adding an emblem to an icon. Adding multiple emblems to an -icon is ensured via g_emblemed_icon_add_emblem(). +icon is ensured via [method@Gio.EmblemedIcon.add_emblem]. -Note that #GEmblemedIcon allows no control over the position -of the emblems. See also #GEmblem for more information. - +Note that `GEmblemedIcon` allows no control over the position +of the emblems. See also [class@Gio.Emblem] for more information. + Creates a new emblemed icon for @icon with the emblem @emblem. - + filename="gio/gemblemedicon.c" + line="147">Creates a new emblemed icon for @icon with the emblem @emblem. + a new #GIcon + filename="gio/gemblemedicon.c" + line="154">a new #GIcon a #GIcon + filename="gio/gemblemedicon.c" + line="149">a #GIcon nullable="1" allow-none="1"> a #GEmblem, or %NULL + filename="gio/gemblemedicon.c" + line="150">a #GEmblem, or %NULL @@ -40234,24 +41225,23 @@ of the emblems. See also #GEmblem for more information. c:identifier="g_emblemed_icon_add_emblem" version="2.18"> Adds @emblem to the #GList of #GEmblems. - + filename="gio/gemblemedicon.c" + line="252">Adds @emblem to the #GList of #GEmblems. + a #GEmblemedIcon + filename="gio/gemblemedicon.c" + line="254">a #GEmblemedIcon a #GEmblem + filename="gio/gemblemedicon.c" + line="255">a #GEmblem @@ -40260,18 +41250,17 @@ of the emblems. See also #GEmblem for more information. c:identifier="g_emblemed_icon_clear_emblems" version="2.28"> Removes all the emblems from @icon. - + filename="gio/gemblemedicon.c" + line="216">Removes all the emblems from @icon. + a #GEmblemedIcon + filename="gio/gemblemedicon.c" + line="218">a #GEmblemedIcon @@ -40280,14 +41269,13 @@ of the emblems. See also #GEmblem for more information. c:identifier="g_emblemed_icon_get_emblems" version="2.18"> Gets the list of emblems for the @icon. - + filename="gio/gemblemedicon.c" + line="196">Gets the list of emblems for the @icon. + a #GList of + filename="gio/gemblemedicon.c" + line="202">a #GList of #GEmblems that is owned by @emblemed @@ -40296,8 +41284,8 @@ of the emblems. See also #GEmblem for more information. a #GEmblemedIcon + filename="gio/gemblemedicon.c" + line="198">a #GEmblemedIcon @@ -40306,29 +41294,32 @@ of the emblems. See also #GEmblem for more information. c:identifier="g_emblemed_icon_get_icon" version="2.18"> Gets the main icon for @emblemed. - + filename="gio/gemblemedicon.c" + line="178">Gets the main icon for @emblemed. + a #GIcon that is owned by @emblemed + filename="gio/gemblemedicon.c" + line="184">a #GIcon that is owned by @emblemed a #GEmblemedIcon + filename="gio/gemblemedicon.c" + line="180">a #GEmblemedIcon + The [iface@Gio.Icon] to attach emblems to. @@ -40341,8 +41332,7 @@ of the emblems. See also #GEmblem for more information. - + @@ -40351,12 +41341,10 @@ of the emblems. See also #GEmblem for more information. c:type="GEmblemedIconPrivate" disguised="1" opaque="1"> - + - + @@ -40365,8 +41353,7 @@ of the emblems. See also #GEmblem for more information. - + @@ -40375,8 +41362,7 @@ of the emblems. See also #GEmblem for more information. - + @@ -40385,8 +41371,7 @@ of the emblems. See also #GEmblem for more information. - + @@ -40396,93 +41381,87 @@ of the emblems. See also #GEmblem for more information. value="access::can-delete" c:type="G_FILE_ATTRIBUTE_ACCESS_CAN_DELETE"> A key in the "access" namespace for checking deletion privileges. + filename="gio/gfileinfo.h" + line="365">A key in the "access" namespace for checking deletion privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to delete the file. - + A key in the "access" namespace for getting execution privileges. + filename="gio/gfileinfo.h" + line="354">A key in the "access" namespace for getting execution privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to execute the file. - + A key in the "access" namespace for getting read privileges. + filename="gio/gfileinfo.h" + line="332">A key in the "access" namespace for getting read privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to read the file. - + A key in the "access" namespace for checking renaming privileges. + filename="gio/gfileinfo.h" + line="388">A key in the "access" namespace for checking renaming privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to rename the file. - + A key in the "access" namespace for checking trashing privileges. + filename="gio/gfileinfo.h" + line="376">A key in the "access" namespace for checking trashing privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to move the file to the trash. - + A key in the "access" namespace for getting write privileges. + filename="gio/gfileinfo.h" + line="343">A key in the "access" namespace for getting write privileges. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. This attribute will be %TRUE if the user is able to write to the file. - + A key in the "dos" namespace for checking if the file's archive flag + filename="gio/gfileinfo.h" + line="817">A key in the "dos" namespace for checking if the file's archive flag is set. This attribute is %TRUE if the archive flag is set. @@ -40490,8 +41469,7 @@ This attribute is %TRUE if the archive flag is set. This attribute is only available for DOS file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_DOS_IS_MOUNTPOINT" version="2.60"> A key in the "dos" namespace for checking if the file is a NTFS mount point + filename="gio/gfileinfo.h" + line="845">A key in the "dos" namespace for checking if the file is a NTFS mount point (a volume mount or a junction point). This attribute is %TRUE if file is a reparse point of type @@ -40509,16 +41487,15 @@ This attribute is %TRUE if file is a reparse point of type This attribute is only available for DOS file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "dos" namespace for checking if the file's backup flag + filename="gio/gfileinfo.h" + line="831">A key in the "dos" namespace for checking if the file's backup flag is set. This attribute is %TRUE if the backup flag is set. @@ -40526,8 +41503,7 @@ This attribute is %TRUE if the backup flag is set. This attribute is only available for DOS file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_DOS_REPARSE_POINT_TAG" version="2.60"> A key in the "dos" namespace for getting the file NTFS reparse tag. + filename="gio/gfileinfo.h" + line="862">A key in the "dos" namespace for getting the file NTFS reparse tag. This value is 0 for files that are not reparse points. @@ -40544,89 +41520,82 @@ See the [Reparse Tags](https://msdn.microsoft.com/en-us/library/dd541667.aspx) page for possible reparse tag values. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "etag" namespace for getting the value of the file's + filename="gio/gfileinfo.h" + line="291">A key in the "etag" namespace for getting the value of the file's entity tag. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "filesystem" namespace for getting the number of bytes + filename="gio/gfileinfo.h" + line="1153">A key in the "filesystem" namespace for getting the number of bytes of free space left on the file system. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + A key in the "filesystem" namespace for checking if the file system + filename="gio/gfileinfo.h" + line="1184">A key in the "filesystem" namespace for checking if the file system is read only. Is set to %TRUE if the file system is read only. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "filesystem" namespace for checking if the file system + filename="gio/gfileinfo.h" + line="1207">A key in the "filesystem" namespace for checking if the file system is remote. Is set to %TRUE if the file system is remote. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "filesystem" namespace for getting the total size (in + filename="gio/gfileinfo.h" + line="1143">A key in the "filesystem" namespace for getting the total size (in bytes) of the file system, used in g_file_query_filesystem_info(). Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + A key in the "filesystem" namespace for getting the file system's type. + filename="gio/gfileinfo.h" + line="1175">A key in the "filesystem" namespace for getting the file system's type. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + c:type="G_FILE_ATTRIBUTE_FILESYSTEM_USED" version="2.32"> A key in the "filesystem" namespace for getting the number of bytes + filename="gio/gfileinfo.h" + line="1163">A key in the "filesystem" namespace for getting the number of bytes used by data on the file system. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + A key in the "filesystem" namespace for hinting a file manager + filename="gio/gfileinfo.h" + line="1196">A key in the "filesystem" namespace for hinting a file manager application whether it should preview (e.g. thumbnail) files on the file system. The value for this key contain a #GFilesystemPreviewType. - + A key in the "gvfs" namespace that gets the name of the current + filename="gio/gfileinfo.h" + line="1219">A key in the "gvfs" namespace that gets the name of the current GVFS backend in use. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "id" namespace for getting a file identifier. + filename="gio/gfileinfo.h" + line="305">A key in the "id" namespace for getting a file identifier. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. An example use would be during listing files, to avoid recursive directory scanning. - + A key in the "id" namespace for getting the file system identifier. + filename="gio/gfileinfo.h" + line="317">A key in the "id" namespace for getting the file system identifier. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. An example use would be during drag and drop to see if the source and target are on the same filesystem (default to move) or not (default to copy). - + A key in the "mountable" namespace for checking if a file (of + filename="gio/gfileinfo.h" + line="423">A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be ejected. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "mountable" namespace for checking if a file (of + filename="gio/gfileinfo.h" + line="403">A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is mountable. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_CAN_POLL" version="2.22"> A key in the "mountable" namespace for checking if a file (of + filename="gio/gfileinfo.h" + line="510">A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be polled. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START" version="2.22"> A key in the "mountable" namespace for checking if a file (of + filename="gio/gfileinfo.h" + line="463">A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_CAN_START_DEGRADED" version="2.22"> A key in the "mountable" namespace for checking if a file (of + filename="gio/gfileinfo.h" + line="475">A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be started degraded. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_CAN_STOP" version="2.22"> A key in the "mountable" namespace for checking if a file (of + filename="gio/gfileinfo.h" + line="487">A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) can be stopped. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "mountable" namespace for checking if a file (of + filename="gio/gfileinfo.h" + line="413">A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is unmountable. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "mountable" namespace for getting the HAL UDI for the mountable + filename="gio/gfileinfo.h" + line="453">A key in the "mountable" namespace for getting the HAL UDI for the mountable file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_IS_MEDIA_CHECK_AUTOMATIC" version="2.22"> A key in the "mountable" namespace for checking if a file (of + filename="gio/gfileinfo.h" + line="522">A key in the "mountable" namespace for checking if a file (of type G_FILE_TYPE_MOUNTABLE) is automatically polled for media. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_START_STOP_TYPE" version="2.22"> A key in the "mountable" namespace for getting the #GDriveStartStopType. + filename="gio/gfileinfo.h" + line="499">A key in the "mountable" namespace for getting the #GDriveStartStopType. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "mountable" namespace for getting the unix device. + filename="gio/gfileinfo.h" + line="433">A key in the "mountable" namespace for getting the unix device. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + c:type="G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILE" version="2.22"> A key in the "mountable" namespace for getting the unix device file. + filename="gio/gfileinfo.h" + line="442">A key in the "mountable" namespace for getting the unix device file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "owner" namespace for getting the file owner's group. + filename="gio/gfileinfo.h" + line="900">A key in the "owner" namespace for getting the file owner's group. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "owner" namespace for getting the user name of the + filename="gio/gfileinfo.h" + line="880">A key in the "owner" namespace for getting the user name of the file's owner. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "owner" namespace for getting the real name of the + filename="gio/gfileinfo.h" + line="890">A key in the "owner" namespace for getting the real name of the user that owns the file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + c:type="G_FILE_ATTRIBUTE_PREVIEW_ICON" version="2.20"> A key in the "preview" namespace for getting a #GIcon that can be + filename="gio/gfileinfo.h" + line="1125">A key in the "preview" namespace for getting a #GIcon that can be used to get preview of the file. For example, it may be a low resolution thumbnail without metadata. @@ -40913,8 +41862,7 @@ For example, it may be a low resolution thumbnail without metadata. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. The value for this key should contain a #GIcon. - + c:type="G_FILE_ATTRIBUTE_RECENT_MODIFIED" version="2.52"> A key in the "recent" namespace for getting time, when the metadata for the + filename="gio/gfileinfo.h" + line="1278">A key in the "recent" namespace for getting time, when the metadata for the file in `recent:///` was last changed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_INT64. - + A key in the "selinux" namespace for getting the file's SELinux + filename="gio/gfileinfo.h" + line="1229">A key in the "selinux" namespace for getting the file's SELinux context. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. Note that this attribute is only available if GLib has been built with SELinux support. - + c:type="G_FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZE" version="2.20"> A key in the "standard" namespace for getting the amount of disk space + filename="gio/gfileinfo.h" + line="240">A key in the "standard" namespace for getting the amount of disk space that is consumed by the file (in bytes). This will generally be larger than the file size (due to block size overhead) but can occasionally be smaller (for example, for sparse files). Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + A key in the "standard" namespace for getting the content type of the file. + filename="gio/gfileinfo.h" + line="206">A key in the "standard" namespace for getting the content type of the file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. The value for this key should contain a valid content type. - + A key in the "standard" namespace for getting the copy name of the file. + filename="gio/gfileinfo.h" + line="152">A key in the "standard" namespace for getting the copy name of the file. The copy name is an optional version of the name. If available it's always in UTF8, and corresponds directly to the original filename (only transcoded to @@ -40992,16 +41936,15 @@ might have a different encoding. If the filename is not a valid string in the encoding selected for the filesystem it is in then the copy name will not be set. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "standard" namespace for getting the description of the file. + filename="gio/gfileinfo.h" + line="167">A key in the "standard" namespace for getting the description of the file. The description is a utf8 string that describes the file, generally containing the filename, but can also contain further information. Example descriptions @@ -41010,31 +41953,29 @@ for a file in the trash. This is useful for instance as the window title when displaying a directory or for a bookmarks menu. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "standard" namespace for getting the display name of the file. + filename="gio/gfileinfo.h" + line="126">A key in the "standard" namespace for getting the display name of the file. A display name is guaranteed to be in UTF-8 and can thus be displayed in the UI. It is guaranteed to be set on every file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "standard" namespace for edit name of the file. + filename="gio/gfileinfo.h" + line="138">A key in the "standard" namespace for edit name of the file. An edit name is similar to the display name, but it is meant to be used when you want to rename the file in the UI. The display name @@ -41042,90 +41983,83 @@ might contain information you don't want in the new filename (such as "(invalid unicode)" if the filename was in an invalid encoding). Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "standard" namespace for getting the fast content type. + filename="gio/gfileinfo.h" + line="217">A key in the "standard" namespace for getting the fast content type. The fast content type isn't as reliable as the regular one, as it only uses the filename to guess it, but it is faster to calculate than the regular content type. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "standard" namespace for getting the icon for the file. + filename="gio/gfileinfo.h" + line="182">A key in the "standard" namespace for getting the icon for the file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. The value for this key should contain a #GIcon. - + A key in the "standard" namespace for checking if a file is a backup file. + filename="gio/gfileinfo.h" + line="65">A key in the "standard" namespace for checking if a file is a backup file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "standard" namespace for checking if a file is hidden. + filename="gio/gfileinfo.h" + line="56">A key in the "standard" namespace for checking if a file is hidden. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "standard" namespace for checking if the file is a symlink. + filename="gio/gfileinfo.h" + line="74">A key in the "standard" namespace for checking if the file is a symlink. Typically the actual type is something else, if we followed the symlink to get the type. On Windows NTFS mountpoints are considered to be symlinks as well. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "standard" namespace for checking if a file is virtual. + filename="gio/gfileinfo.h" + line="87">A key in the "standard" namespace for checking if a file is virtual. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_STANDARD_IS_VOLATILE" version="2.46"> A key in the "standard" namespace for checking if a file is + filename="gio/gfileinfo.h" + line="96">A key in the "standard" namespace for checking if a file is volatile. This is meant for opaque, non-POSIX-like backends to indicate that the URI is not persistent. Applications should look at %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET for the persistent URI. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "standard" namespace for getting the name of the file. + filename="gio/gfileinfo.h" + line="110">A key in the "standard" namespace for getting the name of the file. The name is the on-disk filename which may not be in any known encoding, and can thus not be generally displayed as is. It is guaranteed to be set on @@ -41159,28 +42092,26 @@ Use %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME if you need to display the name in a user interface. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + A key in the "standard" namespace for getting the file's size (in bytes). + filename="gio/gfileinfo.h" + line="231">A key in the "standard" namespace for getting the file's size (in bytes). Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + A key in the "standard" namespace for setting the sort order of a file. + filename="gio/gfileinfo.h" + line="275">A key in the "standard" namespace for setting the sort order of a file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_INT32. @@ -41188,8 +42119,7 @@ An example use would be in file managers, which would use this key to set the order files are displayed. Files with smaller sort order should be sorted first, and files without sort order as if sort order was zero. - + c:type="G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON" version="2.34"> A key in the "standard" namespace for getting the symbolic icon for the file. + filename="gio/gfileinfo.h" + line="193">A key in the "standard" namespace for getting the symbolic icon for the file. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_OBJECT. The value for this key should contain a #GIcon. - + A key in the "standard" namespace for getting the symlink target, if the file + filename="gio/gfileinfo.h" + line="255">A key in the "standard" namespace for getting the symlink target, if the file is a symlink. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + A key in the "standard" namespace for getting the target URI for the file, in + filename="gio/gfileinfo.h" + line="265">A key in the "standard" namespace for getting the target URI for the file, in the case of %G_FILE_TYPE_SHORTCUT or %G_FILE_TYPE_MOUNTABLE files. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "standard" namespace for storing file types. + filename="gio/gfileinfo.h" + line="45">A key in the "standard" namespace for storing file types. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. The value for this key should contain a #GFileType. - + A key in the "thumbnail" namespace for checking if thumbnailing failed. + filename="gio/gfileinfo.h" + line="920">A key in the "thumbnail" namespace for checking if thumbnailing failed. This attribute is %TRUE if thumbnailing failed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_THUMBNAILING_FAILED_LARGE" version="2.76"> A key in the "thumbnail" namespace for checking if thumbnailing failed + filename="gio/gfileinfo.h" + line="1002">A key in the "thumbnail" namespace for checking if thumbnailing failed for the large image. This attribute is %TRUE if thumbnailing failed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_THUMBNAILING_FAILED_NORMAL" version="2.76"> A key in the "thumbnail" namespace for checking if thumbnailing failed + filename="gio/gfileinfo.h" + line="958">A key in the "thumbnail" namespace for checking if thumbnailing failed for the normal image. This attribute is %TRUE if thumbnailing failed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_THUMBNAILING_FAILED_XLARGE" version="2.76"> A key in the "thumbnail" namespace for checking if thumbnailing failed + filename="gio/gfileinfo.h" + line="1046">A key in the "thumbnail" namespace for checking if thumbnailing failed for the x-large image. This attribute is %TRUE if thumbnailing failed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_THUMBNAILING_FAILED_XXLARGE" version="2.76"> A key in the "thumbnail" namespace for checking if thumbnailing failed + filename="gio/gfileinfo.h" + line="1090">A key in the "thumbnail" namespace for checking if thumbnailing failed for the xx-large image. This attribute is %TRUE if thumbnailing failed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_THUMBNAIL_IS_VALID" version="2.40"> A key in the "thumbnail" namespace for checking whether the thumbnail is outdated. + filename="gio/gfileinfo.h" + line="930">A key in the "thumbnail" namespace for checking whether the thumbnail is outdated. This attribute is %TRUE if the thumbnail is up-to-date with the file it represents, and %FALSE if the file has been modified since the thumbnail was generated. @@ -41340,8 +42261,7 @@ If %G_FILE_ATTRIBUTE_THUMBNAILING_FAILED is %TRUE and this attribute is %FALSE, it indicates that thumbnailing may be attempted again and may succeed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_THUMBNAIL_IS_VALID_LARGE" version="2.76"> A key in the "thumbnail" namespace for checking whether the large + filename="gio/gfileinfo.h" + line="1015">A key in the "thumbnail" namespace for checking whether the large thumbnail is outdated. This attribute is %TRUE if the large thumbnail is up-to-date with the file @@ -41362,8 +42282,7 @@ is %FALSE, it indicates that thumbnailing may be attempted again and may succeed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_THUMBNAIL_IS_VALID_NORMAL" version="2.76"> A key in the "thumbnail" namespace for checking whether the normal + filename="gio/gfileinfo.h" + line="971">A key in the "thumbnail" namespace for checking whether the normal thumbnail is outdated. This attribute is %TRUE if the normal thumbnail is up-to-date with the file @@ -41384,8 +42303,7 @@ is %FALSE, it indicates that thumbnailing may be attempted again and may succeed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_THUMBNAIL_IS_VALID_XLARGE" version="2.76"> A key in the "thumbnail" namespace for checking whether the x-large + filename="gio/gfileinfo.h" + line="1059">A key in the "thumbnail" namespace for checking whether the x-large thumbnail is outdated. This attribute is %TRUE if the x-large thumbnail is up-to-date with the file @@ -41406,8 +42324,7 @@ is %FALSE, it indicates that thumbnailing may be attempted again and may succeed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + c:type="G_FILE_ATTRIBUTE_THUMBNAIL_IS_VALID_XXLARGE" version="2.76"> A key in the "thumbnail" namespace for checking whether the xx-large + filename="gio/gfileinfo.h" + line="1103">A key in the "thumbnail" namespace for checking whether the xx-large thumbnail is outdated. This attribute is %TRUE if the x-large thumbnail is up-to-date with the file @@ -41428,21 +42345,19 @@ is %FALSE, it indicates that thumbnailing may be attempted again and may succeed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "thumbnail" namespace for getting the path to the thumbnail + filename="gio/gfileinfo.h" + line="911">A key in the "thumbnail" namespace for getting the path to the thumbnail image with the biggest size available. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + c:type="G_FILE_ATTRIBUTE_THUMBNAIL_PATH_LARGE" version="2.76"> A key in the "thumbnail" namespace for getting the path to the large + filename="gio/gfileinfo.h" + line="991">A key in the "thumbnail" namespace for getting the path to the large thumbnail image. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + c:type="G_FILE_ATTRIBUTE_THUMBNAIL_PATH_NORMAL" version="2.76"> A key in the "thumbnail" namespace for getting the path to the normal + filename="gio/gfileinfo.h" + line="947">A key in the "thumbnail" namespace for getting the path to the normal thumbnail image. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + c:type="G_FILE_ATTRIBUTE_THUMBNAIL_PATH_XLARGE" version="2.76"> A key in the "thumbnail" namespace for getting the path to the x-large + filename="gio/gfileinfo.h" + line="1035">A key in the "thumbnail" namespace for getting the path to the x-large thumbnail image. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + c:type="G_FILE_ATTRIBUTE_THUMBNAIL_PATH_XXLARGE" version="2.76"> A key in the "thumbnail" namespace for getting the path to the xx-large + filename="gio/gfileinfo.h" + line="1079">A key in the "thumbnail" namespace for getting the path to the xx-large thumbnail image. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + A key in the "time" namespace for getting the time the file was last + filename="gio/gfileinfo.h" + line="572">A key in the "time" namespace for getting the time the file was last accessed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the file was last accessed, in seconds since the UNIX epoch. - + c:type="G_FILE_ATTRIBUTE_TIME_ACCESS_NSEC" version="2.74"> A key in the "time" namespace for getting the nanoseconds of the time + filename="gio/gfileinfo.h" + line="596">A key in the "time" namespace for getting the nanoseconds of the time the file was last accessed. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_ACCESS. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "time" namespace for getting the microseconds of the time + filename="gio/gfileinfo.h" + line="584">A key in the "time" namespace for getting the microseconds of the time the file was last accessed. This should be used in conjunction with %G_FILE_ATTRIBUTE_TIME_ACCESS. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "time" namespace for getting the time the file was last + filename="gio/gfileinfo.h" + line="608">A key in the "time" namespace for getting the time the file was last changed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, @@ -41558,8 +42466,7 @@ and contains the time since the file was last changed, in seconds since the UNIX epoch. This corresponds to the traditional UNIX ctime. - + c:type="G_FILE_ATTRIBUTE_TIME_CHANGED_NSEC" version="2.74"> A key in the "time" namespace for getting the nanoseconds of the time + filename="gio/gfileinfo.h" + line="634">A key in the "time" namespace for getting the nanoseconds of the time the file was last changed. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_CHANGED. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "time" namespace for getting the microseconds of the time + filename="gio/gfileinfo.h" + line="622">A key in the "time" namespace for getting the microseconds of the time the file was last changed. This should be used in conjunction with %G_FILE_ATTRIBUTE_TIME_CHANGED. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "time" namespace for getting the time the file was created. + filename="gio/gfileinfo.h" + line="646">A key in the "time" namespace for getting the time the file was created. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the file was created, in seconds since the UNIX @@ -41604,8 +42509,7 @@ epoch. This may correspond to Linux `stx_btime`, FreeBSD `st_birthtim`, NetBSD `st_birthtime` or NTFS `ctime`. - + A key in the "time" namespace for getting the nanoseconds of the time + filename="gio/gfileinfo.h" + line="672">A key in the "time" namespace for getting the nanoseconds of the time the file was created. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_CREATED. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "time" namespace for getting the microseconds of the time + filename="gio/gfileinfo.h" + line="660">A key in the "time" namespace for getting the microseconds of the time the file was created. This should be used in conjunction with %G_FILE_ATTRIBUTE_TIME_CREATED. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "time" namespace for getting the time the file was last + filename="gio/gfileinfo.h" + line="536">A key in the "time" namespace for getting the time the file was last modified. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the file was modified, in seconds since the UNIX epoch. - + c:type="G_FILE_ATTRIBUTE_TIME_MODIFIED_NSEC" version="2.74"> A key in the "time" namespace for getting the nanoseconds of the time + filename="gio/gfileinfo.h" + line="560">A key in the "time" namespace for getting the nanoseconds of the time the file was last modified. This should be used in conjunction with #G_FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "time" namespace for getting the microseconds of the time + filename="gio/gfileinfo.h" + line="548">A key in the "time" namespace for getting the microseconds of the time the file was last modified. This should be used in conjunction with %G_FILE_ATTRIBUTE_TIME_MODIFIED. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + c:type="G_FILE_ATTRIBUTE_TRASH_DELETION_DATE" version="2.24"> A key in the "trash" namespace for getting the deletion date and time + filename="gio/gfileinfo.h" + line="1264">A key in the "trash" namespace for getting the deletion date and time of a file inside the `trash:///` folder. The format of the returned string is `YYYY-MM-DDThh:mm:ss`. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_STRING. - + A key in the "trash" namespace for getting the number of (toplevel) items + filename="gio/gfileinfo.h" + line="1242">A key in the "trash" namespace for getting the number of (toplevel) items that are present in the `trash:///` folder. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + c:type="G_FILE_ATTRIBUTE_TRASH_ORIG_PATH" version="2.24"> A key in the "trash" namespace for getting the original path of a file + filename="gio/gfileinfo.h" + line="1252">A key in the "trash" namespace for getting the original path of a file inside the `trash:///` folder before it was trashed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING. - + A key in the "unix" namespace for getting the number of blocks allocated + filename="gio/gfileinfo.h" + line="787">A key in the "unix" namespace for getting the number of blocks allocated for the file. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + A key in the "unix" namespace for getting the block size for the file + filename="gio/gfileinfo.h" + line="775">A key in the "unix" namespace for getting the block size for the file system. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "unix" namespace for getting the device id of the device the + filename="gio/gfileinfo.h" + line="686">A key in the "unix" namespace for getting the device id of the device the file is located on (see stat() documentation). This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "unix" namespace for getting the group ID for the file. + filename="gio/gfileinfo.h" + line="750">A key in the "unix" namespace for getting the group ID for the file. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "unix" namespace for getting the inode of the file. + filename="gio/gfileinfo.h" + line="698">A key in the "unix" namespace for getting the inode of the file. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64. - + A key in the "unix" namespace for checking if the file represents a + filename="gio/gfileinfo.h" + line="799">A key in the "unix" namespace for checking if the file represents a UNIX mount point. This attribute is %TRUE if the file is a UNIX mount point. @@ -41812,16 +42703,15 @@ Since 2.58, `/` is considered to be a mount point. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN. - + A key in the "unix" namespace for getting the mode of the file + filename="gio/gfileinfo.h" + line="709">A key in the "unix" namespace for getting the mode of the file (e.g. whether the file is a regular file, symlink, etc). See the documentation for `lstat()`: this attribute is equivalent to @@ -41831,16 +42721,15 @@ and permissions. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "unix" namespace for getting the number of hard links + filename="gio/gfileinfo.h" + line="725">A key in the "unix" namespace for getting the number of hard links for a file. See the documentation for `lstat()`. @@ -41848,16 +42737,15 @@ See the documentation for `lstat()`. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "unix" namespace for getting the device ID for the file + filename="gio/gfileinfo.h" + line="761">A key in the "unix" namespace for getting the device ID for the file (if it is a special file). See the documentation for `lstat()`. @@ -41865,29 +42753,26 @@ See the documentation for `lstat()`. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + A key in the "unix" namespace for getting the user ID for the file. + filename="gio/gfileinfo.h" + line="739">A key in the "unix" namespace for getting the user ID for the file. This attribute is only available for UNIX file systems. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + - + @@ -41896,8 +42781,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -41906,8 +42790,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -41916,8 +42799,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -41926,8 +42808,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -41936,8 +42817,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -41946,8 +42826,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -41956,8 +42835,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -41966,8 +42844,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -41976,8 +42853,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -41986,8 +42862,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -41996,8 +42871,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42006,8 +42880,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42016,8 +42889,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42026,8 +42898,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42036,8 +42907,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42046,8 +42916,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42056,8 +42925,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42066,8 +42934,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42076,8 +42943,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42086,8 +42952,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42096,8 +42961,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42106,8 +42970,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42116,8 +42979,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42126,8 +42988,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42136,8 +42997,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42146,8 +43006,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42156,8 +43015,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42166,8 +43024,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42176,8 +43033,7 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. - + @@ -42190,122 +43046,128 @@ Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32. glib:get-type="g_file_get_type" glib:type-struct="FileIface"> #GFile is a high level abstraction for manipulating files on a -virtual file system. #GFiles are lightweight, immutable objects + filename="gio/gfile.c" + line="88">`GFile` is a high level abstraction for manipulating files on a +virtual file system. `GFile`s are lightweight, immutable objects that do no I/O upon creation. It is necessary to understand that -#GFile objects do not represent files, merely an identifier for a +`GFile` objects do not represent files, merely an identifier for a file. All file content I/O is implemented as streaming operations -(see #GInputStream and #GOutputStream). - -To construct a #GFile, you can use: -- g_file_new_for_path() if you have a path. -- g_file_new_for_uri() if you have a URI. -- g_file_new_for_commandline_arg() for a command line argument. -- g_file_new_tmp() to create a temporary file from a template. -- g_file_new_tmp_async() to asynchronously create a temporary file. -- g_file_new_tmp_dir_async() to asynchronously create a temporary directory. -- g_file_parse_name() from a UTF-8 string gotten from g_file_get_parse_name(). -- g_file_new_build_filename() or g_file_new_build_filenamev() to create a file from path elements. - -One way to think of a #GFile is as an abstraction of a pathname. For +(see [class@Gio.InputStream] and [class@Gio.OutputStream]). + +To construct a `GFile`, you can use: + +- [func@Gio.File.new_for_path] if you have a path. +- [func@Gio.File.new_for_uri] if you have a URI. +- [func@Gio.File.new_for_commandline_arg] or + [func@Gio.File.new_for_commandline_arg_and_cwd] for a command line + argument. +- [func@Gio.File.new_tmp] to create a temporary file from a template. +- [func@Gio.File.new_tmp_async] to asynchronously create a temporary file. +- [func@Gio.File.new_tmp_dir_async] to asynchronously create a temporary + directory. +- [func@Gio.File.parse_name] from a UTF-8 string gotten from + [method@Gio.File.get_parse_name]. +- [func@Gio.File.new_build_filename] or [func@Gio.File.new_build_filenamev] + to create a file from path elements. + +One way to think of a `GFile` is as an abstraction of a pathname. For normal files the system pathname is what is stored internally, but as -#GFiles are extensible it could also be something else that corresponds +`GFile`s are extensible it could also be something else that corresponds to a pathname in a userspace implementation of a filesystem. -#GFiles make up hierarchies of directories and files that correspond to +`GFile`s make up hierarchies of directories and files that correspond to the files on a filesystem. You can move through the file system with -#GFile using g_file_get_parent() to get an identifier for the parent -directory, g_file_get_child() to get a child within a directory, -g_file_resolve_relative_path() to resolve a relative path between two -#GFiles. There can be multiple hierarchies, so you may not end up at -the same root if you repeatedly call g_file_get_parent() on two different -files. - -All #GFiles have a basename (get with g_file_get_basename()). These names -are byte strings that are used to identify the file on the filesystem +`GFile` using [method@Gio.File.get_parent] to get an identifier for the +parent directory, [method@Gio.File.get_child] to get a child within a +directory, and [method@Gio.File.resolve_relative_path] to resolve a relative +path between two `GFile`s. There can be multiple hierarchies, so you may not +end up at the same root if you repeatedly call [method@Gio.File.get_parent] +on two different files. + +All `GFile`s have a basename (get with [method@Gio.File.get_basename]). These +names are byte strings that are used to identify the file on the filesystem (relative to its parent directory) and there is no guarantees that they have any particular charset encoding or even make any sense at all. If you want to use filenames in a user interface you should use the display name that you can get by requesting the -%G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info(). -This is guaranteed to be in UTF-8 and can be used in a user interface. -But always store the real basename or the #GFile to use to actually -access the file, because there is no way to go from a display name to -the actual name. +`G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME` attribute with +[method@Gio.File.query_info]. This is guaranteed to be in UTF-8 and can be +used in a user interface. But always store the real basename or the `GFile` +to use to actually access the file, because there is no way to go from a +display name to the actual name. -Using #GFile as an identifier has the same weaknesses as using a path +Using `GFile` as an identifier has the same weaknesses as using a path in that there may be multiple aliases for the same file. For instance, -hard or soft links may cause two different #GFiles to refer to the same +hard or soft links may cause two different `GFile`s to refer to the same file. Other possible causes for aliases are: case insensitive filesystems, short and long names on FAT/NTFS, or bind mounts in Linux. If you want to -check if two #GFiles point to the same file you can query for the -%G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial +check if two `GFile`s point to the same file you can query for the +`G_FILE_ATTRIBUTE_ID_FILE` attribute. Note that `GFile` does some trivial canonicalization of pathnames passed in, so that trivial differences in the path string used at creation (duplicated slashes, slash at end of -path, "." or ".." path segments, etc) does not create different #GFiles. +path, `.` or `..` path segments, etc) does not create different `GFile`s. -Many #GFile operations have both synchronous and asynchronous versions +Many `GFile` operations have both synchronous and asynchronous versions to suit your application. Asynchronous versions of synchronous functions -simply have _async() appended to their function names. The asynchronous -I/O functions call a #GAsyncReadyCallback which is then used to finalize -the operation, producing a GAsyncResult which is then passed to the -function's matching _finish() operation. +simply have `_async()` appended to their function names. The asynchronous +I/O functions call a [callback@Gio.AsyncReadyCallback] which is then used to +finalize the operation, producing a [iface@Gio.AsyncResult] which is then +passed to the function’s matching `_finish()` operation. It is highly recommended to use asynchronous calls when running within a shared main loop, such as in the main thread of an application. This avoids I/O operations blocking other sources on the main loop from being dispatched. Synchronous I/O operations should be performed from worker threads. See the -[introduction to asynchronous programming section][async-programming] for -more. +[introduction to asynchronous programming section](overview.html#asynchronous-programming) +for more. -Some #GFile operations almost always take a noticeable amount of time, and +Some `GFile` operations almost always take a noticeable amount of time, and so do not have synchronous analogs. Notable cases include: -- g_file_mount_mountable() to mount a mountable file. -- g_file_unmount_mountable_with_operation() to unmount a mountable file. -- g_file_eject_mountable_with_operation() to eject a mountable file. -## Entity Tags # {#gfile-etag} +- [method@Gio.File.mount_mountable] to mount a mountable file. +- [method@Gio.File.unmount_mountable_with_operation] to unmount a mountable + file. +- [method@Gio.File.eject_mountable_with_operation] to eject a mountable file. + +## Entity Tags -One notable feature of #GFiles are entity tags, or "etags" for +One notable feature of `GFile`s are entity tags, or ‘etags’ for short. Entity tags are somewhat like a more abstract version of the traditional mtime, and can be used to quickly determine if the file has been modified from the version on the file system. See the HTTP 1.1 [specification](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html) -for HTTP Etag headers, which are a very similar concept. - +for HTTP `ETag` headers, which are a very similar concept. + Constructs a #GFile from a series of elements using the correct + filename="gio/gfile.c" + line="7380">Constructs a #GFile from a series of elements using the correct separator for filenames. Using this function is equivalent to calling g_build_filename(), followed by g_file_new_for_path() on the result. - + a new #GFile + filename="gio/gfile.c" + line="7391">a new #GFile the first element in the path + filename="gio/gfile.c" + line="7382">the first element in the path remaining elements in path, terminated by %NULL + filename="gio/gfile.c" + line="7383">remaining elements in path, terminated by %NULL @@ -42314,25 +43176,24 @@ followed by g_file_new_for_path() on the result. c:identifier="g_file_new_build_filenamev" version="2.78"> Constructs a #GFile from a vector of elements using the correct + filename="gio/gfile.c" + line="7416">Constructs a #GFile from a vector of elements using the correct separator for filenames. Using this function is equivalent to calling g_build_filenamev(), followed by g_file_new_for_path() on the result. - + a new #GFile + filename="gio/gfile.c" + line="7427">a new #GFile %NULL-terminated + filename="gio/gfile.c" + line="7418">%NULL-terminated array of strings containing the path elements. @@ -42343,8 +43204,8 @@ followed by g_file_new_for_path() on the result. Creates a #GFile with the given argument from the command line. + filename="gio/gfile.c" + line="7500">Creates a #GFile with the given argument from the command line. The value of @arg can be either a URI, an absolute path or a relative path resolved relative to the current working directory. This operation never fails, but the returned object might not @@ -42358,20 +43219,19 @@ the commandline. #GApplication also uses UTF-8 but g_application_command_line_create_file_for_arg() may be more useful for you there. It is also always possible to use this function with #GOptionContext arguments of type %G_OPTION_ARG_FILENAME. - + a new #GFile. + filename="gio/gfile.c" + line="7519">a new #GFile. Free the returned object with g_object_unref(). a command line string + filename="gio/gfile.c" + line="7502">a command line string @@ -42380,8 +43240,8 @@ for you there. It is also always possible to use this function with c:identifier="g_file_new_for_commandline_arg_and_cwd" version="2.36"> Creates a #GFile with the given argument from the command line. + filename="gio/gfile.c" + line="7530">Creates a #GFile with the given argument from the command line. This function is similar to g_file_new_for_commandline_arg() except that it allows for passing the current working directory as an @@ -42392,49 +43252,47 @@ This is useful if the commandline argument was given in a context other than the invocation of the current process. See also g_application_command_line_create_file_for_arg(). - + a new #GFile + filename="gio/gfile.c" + line="7547">a new #GFile a command line string + filename="gio/gfile.c" + line="7532">a command line string the current working directory of the commandline + filename="gio/gfile.c" + line="7533">the current working directory of the commandline Constructs a #GFile for a given path. This operation never + filename="gio/gfile.c" + line="7025">Constructs a #GFile for a given path. This operation never fails, but the returned object might not support any I/O operation if @path is malformed. - + a new #GFile for the given @path. + filename="gio/gfile.c" + line="7034">a new #GFile for the given @path. Free the returned object with g_object_unref(). a string containing a relative or absolute path. + filename="gio/gfile.c" + line="7027">a string containing a relative or absolute path. The string must be encoded in the glib filename encoding. @@ -42442,25 +43300,24 @@ operation if @path is malformed. Constructs a #GFile for a given URI. This operation never + filename="gio/gfile.c" + line="7045">Constructs a #GFile for a given URI. This operation never fails, but the returned object might not support any I/O operation if @uri is malformed or if the uri type is not supported. - + a new #GFile for the given @uri. + filename="gio/gfile.c" + line="7054">a new #GFile for the given @uri. Free the returned object with g_object_unref(). a UTF-8 string containing a URI + filename="gio/gfile.c" + line="7047">a UTF-8 string containing a URI @@ -42468,10 +43325,11 @@ not supported. + throws="1" + glib:async-func="new_tmp_async"> Opens a file in the preferred directory for temporary files (as + filename="gio/gfile.c" + line="7065">Opens a file in the preferred directory for temporary files (as returned by g_get_tmp_dir()) and returns a #GFile and #GFileIOStream pointing to it. @@ -42481,12 +43339,11 @@ directory components. If it is %NULL, a default template is used. Unlike the other #GFile constructors, this will return %NULL if a temporary file could not be created. - + a new #GFile. + filename="gio/gfile.c" + line="7083">a new #GFile. Free the returned object with g_object_unref(). @@ -42496,8 +43353,8 @@ a temporary file could not be created. nullable="1" allow-none="1"> Template for the file + filename="gio/gfile.c" + line="7067">Template for the file name, as in g_file_open_tmp(), or %NULL for a default template @@ -42506,25 +43363,26 @@ a temporary file could not be created. caller-allocates="0" transfer-ownership="full"> on return, a #GFileIOStream for the created file + filename="gio/gfile.c" + line="7069">on return, a #GFileIOStream for the created file + version="2.74" + glib:finish-func="new_tmp_finish" + glib:sync-func="new_tmp"> Asynchronously opens a file in the preferred directory for temporary files + filename="gio/gfile.c" + line="7175">Asynchronously opens a file in the preferred directory for temporary files (as returned by g_get_tmp_dir()) as g_file_new_tmp(). @tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, and containing no directory components. If it is %NULL, a default template is used. - + @@ -42534,15 +43392,15 @@ directory components. If it is %NULL, a default template is used. nullable="1" allow-none="1"> Template for the file + filename="gio/gfile.c" + line="7177">Template for the file name, as in g_file_open_tmp(), or %NULL for a default template the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="7179">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="7180">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gfile.c" + line="7181">a #GAsyncReadyCallback to call when the request is done nullable="1" allow-none="1"> data to pass to @callback + filename="gio/gfile.c" + line="7182">data to pass to @callback + version="2.74" + glib:finish-func="new_tmp_dir_finish"> Asynchronously creates a directory in the preferred directory for + filename="gio/gfile.c" + line="7298">Asynchronously creates a directory in the preferred directory for temporary files (as returned by g_get_tmp_dir()) as g_dir_make_tmp(). @tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, and containing no directory components. If it is %NULL, a default template is used. - + @@ -42598,15 +43456,15 @@ directory components. If it is %NULL, a default template is used. nullable="1" allow-none="1"> Template for the file + filename="gio/gfile.c" + line="7300">Template for the file name, as in g_dir_make_tmp(), or %NULL for a default template the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="7302">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="7303">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gfile.c" + line="7304">a #GAsyncReadyCallback to call when the request is done nullable="1" allow-none="1"> data to pass to @callback + filename="gio/gfile.c" + line="7305">data to pass to @callback @@ -42645,23 +43503,22 @@ directory components. If it is %NULL, a default template is used. version="2.74" throws="1"> Finishes a temporary directory creation started by + filename="gio/gfile.c" + line="7336">Finishes a temporary directory creation started by g_file_new_tmp_dir_async(). - + a new #GFile. + filename="gio/gfile.c" + line="7344">a new #GFile. Free the returned object with g_object_unref(). a #GAsyncResult + filename="gio/gfile.c" + line="7338">a #GAsyncResult @@ -42671,22 +43528,21 @@ g_file_new_tmp_dir_async(). version="2.74" throws="1"> Finishes a temporary file creation started by g_file_new_tmp_async(). - + filename="gio/gfile.c" + line="7213">Finishes a temporary file creation started by g_file_new_tmp_async(). + a new #GFile. + filename="gio/gfile.c" + line="7221">a new #GFile. Free the returned object with g_object_unref(). a #GAsyncResult + filename="gio/gfile.c" + line="7215">a #GAsyncResult caller-allocates="0" transfer-ownership="full"> on return, a #GFileIOStream for the created file + filename="gio/gfile.c" + line="7216">on return, a #GFileIOStream for the created file Constructs a #GFile with the given @parse_name (i.e. something + filename="gio/gfile.c" + line="7361">Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()). This operation never fails, but the returned object might not support any I/O operation if the @parse_name cannot be parsed. - + a new #GFile. + filename="gio/gfile.c" + line="7370">a new #GFile. a file name or path to be parsed + filename="gio/gfile.c" + line="7363">a file name or path to be parsed - + Gets an output stream for appending data to the file. + filename="gio/gfile.c" + line="1725">Gets an output stream for appending data to the file. If the file doesn't already exist it is created. By default files created are generally readable by everyone, @@ -42744,26 +43602,25 @@ Some file systems don't allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error. If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + a #GFileOutputStream, or %NULL on error. + filename="gio/gfile.c" + line="1751">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1727">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1728">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1729">optional #GCancellable object, %NULL to ignore - + Asynchronously opens @file for appending. + filename="gio/gfile.c" + line="2165">Asynchronously opens @file for appending. For more details, see g_file_append_to() which is the synchronous version of this call. @@ -42789,28 +43649,27 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_append_to_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2167">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2168">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2169">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2170">optional #GCancellable object, %NULL to ignore @@ -42830,9 +43689,9 @@ of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2172">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="2174">the data to pass to callback function @@ -42851,15 +43710,14 @@ of the operation. invoker="append_to_finish" throws="1"> Finishes an asynchronous file append operation started with + filename="gio/gfile.c" + line="2206">Finishes an asynchronous file append operation started with g_file_append_to_async(). - + a valid #GFileOutputStream + filename="gio/gfile.c" + line="2215">a valid #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -42867,22 +43725,25 @@ g_file_append_to_async(). input #GFile + filename="gio/gfile.c" + line="2208">input #GFile #GAsyncResult + filename="gio/gfile.c" + line="2209">#GAsyncResult - + Copies the file @source to the location specified by @destination. + filename="gio/gfile.c" + line="3638">Copies the file @source to the location specified by @destination. Can not handle recursive copies of directories. If the flag %G_FILE_COPY_OVERWRITE is specified an already @@ -42922,31 +43783,30 @@ If the source is a directory and the target does not exist, or If you are interested in copying the #GFile object itself (not the on-disk file), see g_file_dup(). - + %TRUE on success, %FALSE otherwise. + filename="gio/gfile.c" + line="3691">%TRUE on success, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="3640">input #GFile destination #GFile + filename="gio/gfile.c" + line="3641">destination #GFile set of #GFileCopyFlags + filename="gio/gfile.c" + line="3642">set of #GFileCopyFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3643">optional #GCancellable object, %NULL to ignore @@ -42966,8 +43826,8 @@ file), see g_file_dup(). scope="call" closure="4"> function to callback with + filename="gio/gfile.c" + line="3645">function to callback with progress information, or %NULL if progress information is not needed @@ -42976,16 +43836,19 @@ file), see g_file_dup(). nullable="1" allow-none="1"> user data to pass to @progress_callback + filename="gio/gfile.c" + line="3647">user data to pass to @progress_callback - + Copies the file @source to the location specified by @destination + filename="gio/gfile.c" + line="3766">Copies the file @source to the location specified by @destination asynchronously. For details of the behaviour, see g_file_copy(). If @progress_callback is not %NULL, then that function that will be called @@ -42995,34 +43858,33 @@ run in. When the operation is finished, @callback will be called. You can then call g_file_copy_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="3768">input #GFile destination #GFile + filename="gio/gfile.c" + line="3769">destination #GFile set of #GFileCopyFlags + filename="gio/gfile.c" + line="3770">set of #GFileCopyFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="3771">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3772">optional #GCancellable object, %NULL to ignore @@ -43042,19 +43904,19 @@ g_file_copy_finish() to get the result of the operation. scope="notified" closure="5"> function to callback with progress - information, or %NULL if progress information is not needed + filename="gio/gfile.c" + line="3774"> + function to callback with progress information, or %NULL if + progress information is not needed + allow-none="1"> user data to pass to @progress_callback + filename="gio/gfile.c" + line="3777">user data to pass to @progress_callback scope="async" closure="7"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfile.c" + line="3778">a #GAsyncReadyCallback + to call when the request is satisfied + closure="7"> the data to pass to callback function + filename="gio/gfile.c" + line="3780">the data to pass to callback Finishes copying the file started with g_file_copy_async(). - + filename="gio/gfile.c" + line="3821">Finishes copying the file started with g_file_copy_async(). + a %TRUE on success, %FALSE on error. + filename="gio/gfile.c" + line="3829">a %TRUE on success, %FALSE on error. input #GFile + filename="gio/gfile.c" + line="3823">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="3824">a #GAsyncResult - + Creates a new file and returns an output stream for writing to it. + filename="gio/gfile.c" + line="1780">Creates a new file and returns an output stream for writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -43129,12 +43994,11 @@ allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + a #GFileOutputStream for the newly created + filename="gio/gfile.c" + line="1808">a #GFileOutputStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -43142,14 +44006,14 @@ of filesystem the file is on. input #GFile + filename="gio/gfile.c" + line="1782">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1783">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1784">optional #GCancellable object, %NULL to ignore - + Asynchronously creates a new file and returns an output stream + filename="gio/gfile.c" + line="2236">Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist. For more details, see g_file_create() which is @@ -43176,28 +44043,27 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_create_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2238">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2239">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2240">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2241">optional #GCancellable object, %NULL to ignore @@ -43217,9 +44083,9 @@ of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2243">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="2245">the data to pass to callback function Finishes an asynchronous file create operation started with + filename="gio/gfile.c" + line="2278">Finishes an asynchronous file create operation started with g_file_create_async(). - + a #GFileOutputStream or %NULL on error. + filename="gio/gfile.c" + line="2287">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2280">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2281">a #GAsyncResult @@ -43266,10 +44131,11 @@ g_file_create_async(). + throws="1" + glib:async-func="create_readwrite_async"> Creates a new file and returns a stream for reading and + filename="gio/gfile.c" + line="1979">Creates a new file and returns a stream for reading and writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -43292,12 +44158,11 @@ kind of filesystem the file is on. Note that in many non-local file cases read and write streams are not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing. - + a #GFileIOStream for the newly created + filename="gio/gfile.c" + line="2011">a #GFileIOStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -43305,14 +44170,14 @@ streaming, rather than just opening for reading or writing. a #GFile + filename="gio/gfile.c" + line="1981">a #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1982">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1983">optional #GCancellable object, %NULL to ignore @@ -43329,10 +44194,12 @@ streaming, rather than just opening for reading or writing. + version="2.22" + glib:finish-func="create_readwrite_finish" + glib:sync-func="create_readwrite"> Asynchronously creates a new file and returns a stream + filename="gio/gfile.c" + line="2456">Asynchronously creates a new file and returns a stream for reading and writing to it. The file must not already exist. For more details, see g_file_create_readwrite() which is @@ -43341,28 +44208,27 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_create_readwrite_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2458">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2459">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2460">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2461">optional #GCancellable object, %NULL to ignore @@ -43382,9 +44248,9 @@ the result of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2463">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="2465">the data to pass to callback function @@ -43404,37 +44270,39 @@ the result of the operation. version="2.22" throws="1"> Finishes an asynchronous file create operation started with + filename="gio/gfile.c" + line="2500">Finishes an asynchronous file create operation started with g_file_create_readwrite_async(). - + a #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="2509">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2502">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2503">a #GAsyncResult - + Deletes a file. If the @file is a directory, it will only be + filename="gio/gfile.c" + line="4466">Deletes a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). If @file doesn’t exist, %G_IO_ERROR_NOT_FOUND will be returned. This allows @@ -43455,19 +44323,18 @@ if (!g_file_delete (my_file, my_cancellable, &local_error) && If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the file was deleted. %FALSE otherwise. + filename="gio/gfile.c" + line="4495">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4468">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4469">optional #GCancellable object, %NULL to ignore @@ -43484,28 +44351,29 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + version="2.34" + glib:finish-func="delete_file_finish" + glib:sync-func="delete_file"> Asynchronously delete a file. If the @file is a directory, it will + filename="gio/gfile.c" + line="4522">Asynchronously delete a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). - + input #GFile + filename="gio/gfile.c" + line="4524">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4525">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4526">optional #GCancellable object, %NULL to ignore @@ -43525,8 +44393,8 @@ g_unlink(). scope="async" closure="3"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4528">a #GAsyncReadyCallback to call when the request is satisfied @@ -43536,8 +44404,8 @@ g_unlink(). allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gfile.c" + line="4530">the data to pass to callback function @@ -43547,35 +44415,34 @@ g_unlink(). version="2.34" throws="1"> Finishes deleting a file started with g_file_delete_async(). - + filename="gio/gfile.c" + line="4557">Finishes deleting a file started with g_file_delete_async(). + %TRUE if the file was deleted. %FALSE otherwise. + filename="gio/gfile.c" + line="4565">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4559">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4560">a #GAsyncResult Duplicates a #GFile handle. This operation does not duplicate + filename="gio/gfile.c" + line="724">Duplicates a #GFile handle. This operation does not duplicate the actual file or directory represented by the #GFile; see g_file_copy() if attempting to copy a file. @@ -43585,20 +44452,19 @@ within the same thread, use g_object_ref() to increment the existing object’s reference count. This call does no blocking I/O. - + a new #GFile that is a duplicate + filename="gio/gfile.c" + line="739">a new #GFile that is a duplicate of the given #GFile. input #GFile + filename="gio/gfile.c" + line="726">input #GFile @@ -43606,10 +44472,11 @@ This call does no blocking I/O. + deprecated-version="2.22" + glib:finish-func="eject_mountable_finish"> Starts an asynchronous eject on a mountable. + filename="gio/gfile.c" + line="5625">Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_finish(). @@ -43618,22 +44485,21 @@ If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Use g_file_eject_mountable_with_operation() instead. - + input #GFile + filename="gio/gfile.c" + line="5627">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5628">flags affecting the operation nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5629">optional #GCancellable object, %NULL to ignore @@ -43653,9 +44519,9 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. scope="async" closure="3"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5631">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gfile.c" + line="5633">the data to pass to callback function @@ -43676,41 +44542,41 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. deprecated-version="2.22" throws="1"> Finishes an asynchronous eject operation started by + filename="gio/gfile.c" + line="5675">Finishes an asynchronous eject operation started by g_file_eject_mountable(). Use g_file_eject_mountable_with_operation_finish() instead. - + %TRUE if the @file was ejected successfully. + filename="gio/gfile.c" + line="5684">%TRUE if the @file was ejected successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5677">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5678">a #GAsyncResult + version="2.22" + glib:finish-func="eject_mountable_with_operation_finish"> Starts an asynchronous eject on a mountable. + filename="gio/gfile.c" + line="5709">Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_with_operation_finish(). @@ -43718,22 +44584,21 @@ g_file_eject_mountable_with_operation_finish(). If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + input #GFile + filename="gio/gfile.c" + line="5711">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5712">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="5713">a #GMountOperation, or %NULL to avoid user interaction @@ -43751,8 +44616,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5715">optional #GCancellable object, %NULL to ignore @@ -43763,9 +44628,9 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5717">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="5719">the data to pass to callback function @@ -43785,39 +44650,39 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.22" throws="1"> Finishes an asynchronous eject operation started by + filename="gio/gfile.c" + line="5770">Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation(). - + %TRUE if the @file was ejected successfully. + filename="gio/gfile.c" + line="5779">%TRUE if the @file was ejected successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5772">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5773">a #GAsyncResult + throws="1" + glib:async-func="enumerate_children_async"> Gets the requested information about the files in a directory. + filename="gio/gfile.c" + line="1047">Gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -43842,32 +44707,31 @@ returned. If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is not a directory, the %G_IO_ERROR_NOT_DIRECTORY error will be returned. Other errors are possible too. - + A #GFileEnumerator if successful, + filename="gio/gfile.c" + line="1082">A #GFileEnumerator if successful, %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1049">input #GFile an attribute query string + filename="gio/gfile.c" + line="1050">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1051">a set of #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1052">optional #GCancellable object, %NULL to ignore + invoker="enumerate_children_async" + glib:finish-func="enumerate_children_finish" + glib:sync-func="enumerate_children"> Asynchronously gets the requested information about the files + filename="gio/gfile.c" + line="1113">Asynchronously gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -43896,34 +44762,33 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_enumerate_children_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="1115">input #GFile an attribute query string + filename="gio/gfile.c" + line="1116">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1117">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1118">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1119">optional #GCancellable object, %NULL to ignore @@ -43943,9 +44808,9 @@ the operation. scope="async" closure="5"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gfile.c" + line="1121">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="1123">the data to pass to callback function @@ -43964,15 +44829,14 @@ the operation. invoker="enumerate_children_finish" throws="1"> Finishes an async enumerate children operation. + filename="gio/gfile.c" + line="1159">Finishes an async enumerate children operation. See g_file_enumerate_children_async(). - + a #GFileEnumerator or %NULL + filename="gio/gfile.c" + line="1168">a #GFileEnumerator or %NULL if an error occurred. Free the returned object with g_object_unref(). @@ -43980,57 +44844,57 @@ See g_file_enumerate_children_async(). input #GFile + filename="gio/gfile.c" + line="1161">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1162">a #GAsyncResult Checks if the two given #GFiles refer to the same file. + filename="gio/gfile.c" + line="779">Checks if the two given #GFiles refer to the same file. Note that two #GFiles that differ can still refer to the same file on the filesystem due to various forms of filename aliasing. This call does no blocking I/O. - + %TRUE if @file1 and @file2 are equal. + filename="gio/gfile.c" + line="792">%TRUE if @file1 and @file2 are equal. the first #GFile + filename="gio/gfile.c" + line="781">the first #GFile the second #GFile + filename="gio/gfile.c" + line="782">the second #GFile + throws="1" + glib:async-func="find_enclosing_mount_async"> Gets a #GMount for the #GFile. + filename="gio/gfile.c" + line="1562">Gets a #GMount for the #GFile. #GMount is returned only for user interesting locations, see #GVolumeMonitor. If the #GFileIface for @file does not have a #mount, @@ -44039,12 +44903,11 @@ This call does no blocking I/O. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GMount where the @file is located + filename="gio/gfile.c" + line="1579">a #GMount where the @file is located or %NULL on error. Free the returned object with g_object_unref(). @@ -44052,8 +44915,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + filename="gio/gfile.c" + line="1564">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1565">optional #GCancellable object, %NULL to ignore + invoker="find_enclosing_mount_async" + glib:finish-func="find_enclosing_mount_finish" + glib:sync-func="find_enclosing_mount"> Asynchronously gets the mount for the file. + filename="gio/gfile.c" + line="1611">Asynchronously gets the mount for the file. For more details, see g_file_find_enclosing_mount() which is the synchronous version of this call. @@ -44080,22 +44945,21 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_find_enclosing_mount_finish() to get the result of the operation. - + a #GFile + filename="gio/gfile.c" + line="1613">a #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1614">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1615">optional #GCancellable object, %NULL to ignore @@ -44115,9 +44979,9 @@ get the result of the operation. scope="async" closure="3"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="1617">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gfile.c" + line="1619">the data to pass to callback function @@ -44136,37 +45000,36 @@ get the result of the operation. invoker="find_enclosing_mount_finish" throws="1"> Finishes an asynchronous find mount request. + filename="gio/gfile.c" + line="1649">Finishes an asynchronous find mount request. See g_file_find_enclosing_mount_async(). - + #GMount for given @file or %NULL on error. + filename="gio/gfile.c" + line="1658">#GMount for given @file or %NULL on error. Free the returned object with g_object_unref(). a #GFile + filename="gio/gfile.c" + line="1651">a #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1652">a #GAsyncResult Gets the base name (the last component of the path) for a given #GFile. + filename="gio/gfile.c" + line="536">Gets the base name (the last component of the path) for a given #GFile. If called for the top level of a system (such as the filesystem root or a uri like sftp://host/) it will return a single directory separator @@ -44179,12 +45042,11 @@ can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info(). This call does no blocking I/O. - + string containing the #GFile's + filename="gio/gfile.c" + line="554">string containing the #GFile's base name, or %NULL if given #GFile is invalid. The returned string should be freed with g_free() when no longer needed. @@ -44192,8 +45054,8 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="538">input #GFile @@ -44202,8 +45064,8 @@ This call does no blocking I/O. invoker="get_child_for_display_name" throws="1"> Gets the child of @file for a given @display_name (i.e. a UTF-8 + filename="gio/gfile.c" + line="911">Gets the child of @file for a given @display_name (i.e. a UTF-8 version of the name). If this function fails, it returns %NULL and @error will be set. This is very useful when constructing a #GFile for a new file and the user entered the filename in the @@ -44211,12 +45073,11 @@ user interface, for instance when you select a directory and type a filename in the file selector. This call does no blocking I/O. - + a #GFile to the specified child, or + filename="gio/gfile.c" + line="926">a #GFile to the specified child, or %NULL if the display name couldn't be converted. Free the returned object with g_object_unref(). @@ -44224,32 +45085,31 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="913">input #GFile string to a possible child + filename="gio/gfile.c" + line="914">string to a possible child Gets the parent directory for the @file. + filename="gio/gfile.c" + line="815">Gets the parent directory for the @file. If the @file represents the root directory of the file system, then %NULL will be returned. This call does no blocking I/O. - + a #GFile structure to the + filename="gio/gfile.c" + line="825">a #GFile structure to the parent of the given #GFile or %NULL if there is no parent. Free the returned object with g_object_unref(). @@ -44257,16 +45117,16 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="817">input #GFile Gets the parse name of the @file. + filename="gio/gfile.c" + line="689">Gets the parse name of the @file. A parse name is a UTF-8 string that describes the file such that one can get the #GFile back using g_file_parse_name(). @@ -44280,12 +45140,11 @@ to UTF-8 the pathname is used, otherwise the IRI is used (a form of URI that allows UTF-8 characters unescaped). This call does no blocking I/O. - + a string containing the #GFile's parse name. + filename="gio/gfile.c" + line="708">a string containing the #GFile's parse name. The returned string should be freed with g_free() when no longer needed. @@ -44293,25 +45152,24 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="691">input #GFile Gets the local pathname for #GFile, if one exists. If non-%NULL, this is + filename="gio/gfile.c" + line="570">Gets the local pathname for #GFile, if one exists. If non-%NULL, this is guaranteed to be an absolute, canonical path. It might contain symlinks. This call does no blocking I/O. - + string containing the #GFile's path, + filename="gio/gfile.c" + line="579">string containing the #GFile's path, or %NULL if no such path exists. The returned string should be freed with g_free() when no longer needed. @@ -44319,24 +45177,23 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="572">input #GFile Gets the path for @descendant relative to @parent. + filename="gio/gfile.c" + line="988">Gets the path for @descendant relative to @parent. This call does no blocking I/O. - + string with the relative path from + filename="gio/gfile.c" + line="997">string with the relative path from @descendant to @parent, or %NULL if @descendant doesn't have @parent as prefix. The returned string should be freed with g_free() when no longer needed. @@ -44345,30 +45202,29 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="990">input #GFile input #GFile + filename="gio/gfile.c" + line="991">input #GFile Gets the URI for the @file. + filename="gio/gfile.c" + line="664">Gets the URI for the @file. This call does no blocking I/O. - + a string containing the #GFile's URI. If the #GFile was constructed + filename="gio/gfile.c" + line="672">a string containing the #GFile's URI. If the #GFile was constructed with an invalid URI, an invalid URI is returned. The returned string should be freed with g_free() when no longer needed. @@ -44377,16 +45233,16 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="666">input #GFile Gets the URI scheme for a #GFile. + filename="gio/gfile.c" + line="503">Gets the URI scheme for a #GFile. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] @@ -44397,12 +45253,11 @@ The scheme can be different from the one used to construct the #GFile, in that it might be replaced with one that is logically equivalent to the #GFile. This call does no blocking I/O. - + a string containing the URI scheme for the given + filename="gio/gfile.c" + line="519">a string containing the URI scheme for the given #GFile or %NULL if the #GFile was constructed with an invalid URI. The returned string should be freed with g_free() when no longer needed. @@ -44410,24 +45265,23 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="505">input #GFile Checks to see if a #GFile has a given URI scheme. + filename="gio/gfile.c" + line="475">Checks to see if a #GFile has a given URI scheme. This call does no blocking I/O. - + %TRUE if #GFile's backend supports the + filename="gio/gfile.c" + line="484">%TRUE if #GFile's backend supports the given URI scheme, %FALSE if URI scheme is %NULL, not supported, or #GFile is invalid. @@ -44435,30 +45289,29 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="477">input #GFile a string containing a URI scheme + filename="gio/gfile.c" + line="478">a string containing a URI scheme Creates a hash value for a #GFile. + filename="gio/gfile.c" + line="754">Creates a hash value for a #GFile. This call does no blocking I/O. - + 0 if @file is not a valid #GFile, otherwise an + filename="gio/gfile.c" + line="762">0 if @file is not a valid #GFile, otherwise an integer that can be used as hash value for the #GFile. This function is intended for easily hashing a #GFile to add to a #GHashTable or similar data structure. @@ -44467,16 +45320,16 @@ This call does no blocking I/O. #gconstpointer to a #GFile + filename="gio/gfile.c" + line="756">#gconstpointer to a #GFile Checks to see if a file is native to the platform. + filename="gio/gfile.c" + line="444">Checks to see if a file is native to the platform. A native file is one expressed in the platform-native filename format, e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local, @@ -44487,29 +45340,29 @@ filesystem via a userspace filesystem (FUSE), in these cases this call will return %FALSE, but g_file_get_path() will still return a native path. This call does no blocking I/O. - + %TRUE if @file is native + filename="gio/gfile.c" + line="460">%TRUE if @file is native input #GFile + filename="gio/gfile.c" + line="446">input #GFile + throws="1" + glib:async-func="make_directory_async"> Creates a directory. Note that this will only create a child directory + filename="gio/gfile.c" + line="4066">Creates a directory. Note that this will only create a child directory of the immediate parent directory of the path or URI given by the #GFile. To recursively create directories, see g_file_make_directory_with_parents(). This function will fail if the parent directory does not exist, setting @@ -44523,19 +45376,18 @@ For a local #GFile the newly created directory will have the default If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE on successful creation, %FALSE otherwise. + filename="gio/gfile.c" + line="4088">%TRUE on successful creation, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4068">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4069">optional #GCancellable object, %NULL to ignore @@ -44552,26 +45404,27 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + version="2.38" + glib:finish-func="make_directory_finish" + glib:sync-func="make_directory"> Asynchronously creates a directory. - + filename="gio/gfile.c" + line="4115">Asynchronously creates a directory. + input #GFile + filename="gio/gfile.c" + line="4117">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4118">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4119">optional #GCancellable object, %NULL to ignore @@ -44591,8 +45444,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. scope="async" closure="3"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4121">a #GAsyncReadyCallback to call when the request is satisfied @@ -44602,8 +45455,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gfile.c" + line="4123">the data to pass to callback function @@ -44613,62 +45466,61 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.38" throws="1"> Finishes an asynchronous directory creation, started with + filename="gio/gfile.c" + line="4148">Finishes an asynchronous directory creation, started with g_file_make_directory_async(). - + %TRUE on successful directory creation, %FALSE otherwise. + filename="gio/gfile.c" + line="4157">%TRUE on successful directory creation, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4150">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4151">a #GAsyncResult + throws="1" + glib:async-func="make_symbolic_link_async"> Creates a symbolic link named @file which contains the string + filename="gio/gfile.c" + line="4296">Creates a symbolic link named @file which contains the string @symlink_value. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE on the creation of a new symlink, %FALSE otherwise. + filename="gio/gfile.c" + line="4312">%TRUE on the creation of a new symlink, %FALSE otherwise. a #GFile with the name of the symlink to create + filename="gio/gfile.c" + line="4298">a #GFile with the name of the symlink to create a string with the path for the target + filename="gio/gfile.c" + line="4299">a string with the path for the target of the new symlink @@ -44677,8 +45529,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4301">optional #GCancellable object, %NULL to ignore @@ -44686,34 +45538,35 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + version="2.74" + glib:finish-func="make_symbolic_link_finish" + glib:sync-func="make_symbolic_link"> Asynchronously creates a symbolic link named @file which contains the + filename="gio/gfile.c" + line="4387">Asynchronously creates a symbolic link named @file which contains the string @symlink_value. - + a #GFile with the name of the symlink to create + filename="gio/gfile.c" + line="4389">a #GFile with the name of the symlink to create a string with the path for the target + filename="gio/gfile.c" + line="4390">a string with the path for the target of the new symlink the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4392">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4393">optional #GCancellable object, %NULL to ignore @@ -44733,8 +45586,8 @@ string @symlink_value. scope="async" closure="4"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4395">a #GAsyncReadyCallback to call when the request is satisfied @@ -44744,8 +45597,8 @@ string @symlink_value. allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="4397">the data to pass to callback function @@ -44755,28 +45608,27 @@ string @symlink_value. version="2.74" throws="1"> Finishes an asynchronous symbolic link creation, started with + filename="gio/gfile.c" + line="4437">Finishes an asynchronous symbolic link creation, started with g_file_make_symbolic_link_async(). - + %TRUE on successful directory creation, %FALSE otherwise. + filename="gio/gfile.c" + line="4446">%TRUE on successful directory creation, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4439">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4440">a #GAsyncResult @@ -44784,11 +45636,11 @@ g_file_make_symbolic_link_async(). + throws="1" + glib:async-func="measure_disk_usage_async"> Recursively measures the disk usage of @file. + filename="gio/gfile.c" + line="8837">Recursively measures the disk usage of @file. This is essentially an analog of the 'du' command, but it also reports the number of directories and non-directory files encountered @@ -44806,26 +45658,25 @@ in a user interface. periodic progress updates while scanning. See the documentation for #GFileMeasureProgressCallback for information about when and how the callback will be invoked. - + %TRUE if successful, with the out parameters set. + filename="gio/gfile.c" + line="8868">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. a #GFile + filename="gio/gfile.c" + line="8839">a #GFile #GFileMeasureFlags + filename="gio/gfile.c" + line="8840">#GFileMeasureFlags nullable="1" allow-none="1"> optional #GCancellable + filename="gio/gfile.c" + line="8841">optional #GCancellable a #GFileMeasureProgressCallback + filename="gio/gfile.c" + line="8842">a #GFileMeasureProgressCallback @@ -44853,8 +45705,8 @@ callback will be invoked. nullable="1" allow-none="1"> user_data for @progress_callback + filename="gio/gfile.c" + line="8843">user_data for @progress_callback optional="1" allow-none="1"> the number of bytes of disk space used + filename="gio/gfile.c" + line="8844">the number of bytes of disk space used optional="1" allow-none="1"> the number of directories encountered + filename="gio/gfile.c" + line="8845">the number of directories encountered optional="1" allow-none="1"> the number of non-directories encountered + filename="gio/gfile.c" + line="8846">the number of non-directories encountered @@ -44895,35 +45747,36 @@ callback will be invoked. + introspectable="0" + glib:finish-func="measure_disk_usage_finish" + glib:sync-func="measure_disk_usage"> Recursively measures the disk usage of @file. + filename="gio/gfile.c" + line="8894">Recursively measures the disk usage of @file. This is the asynchronous version of g_file_measure_disk_usage(). See there for more information. - + a #GFile + filename="gio/gfile.c" + line="8896">a #GFile #GFileMeasureFlags + filename="gio/gfile.c" + line="8897">#GFileMeasureFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="8898">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable + filename="gio/gfile.c" + line="8899">optional #GCancellable allow-none="1" closure="4"> a #GFileMeasureProgressCallback + filename="gio/gfile.c" + line="8900">a #GFileMeasureProgressCallback @@ -44951,8 +45804,8 @@ there for more information. nullable="1" allow-none="1"> user_data for @progress_callback + filename="gio/gfile.c" + line="8901">user_data for @progress_callback scope="async" closure="6"> a #GAsyncReadyCallback to call when complete + filename="gio/gfile.c" + line="8902">a #GAsyncReadyCallback to call when complete allow-none="1" closure="6"> the data to pass to callback function + filename="gio/gfile.c" + line="8903">the data to pass to callback function @@ -44983,30 +45836,29 @@ there for more information. version="2.38" throws="1"> Collects the results from an earlier call to + filename="gio/gfile.c" + line="8930">Collects the results from an earlier call to g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for more information. - + %TRUE if successful, with the out parameters set. + filename="gio/gfile.c" + line="8943">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. a #GFile + filename="gio/gfile.c" + line="8932">a #GFile the #GAsyncResult passed to your #GAsyncReadyCallback + filename="gio/gfile.c" + line="8933">the #GAsyncResult passed to your #GAsyncReadyCallback optional="1" allow-none="1"> the number of bytes of disk space used + filename="gio/gfile.c" + line="8934">the number of bytes of disk space used optional="1" allow-none="1"> the number of directories encountered + filename="gio/gfile.c" + line="8935">the number of directories encountered optional="1" allow-none="1"> the number of non-directories encountered + filename="gio/gfile.c" + line="8936">the number of non-directories encountered @@ -45048,8 +45900,8 @@ more information. invoker="monitor_directory" throws="1"> Obtains a directory monitor for the given file. + filename="gio/gfile.c" + line="5806">Obtains a directory monitor for the given file. This may fail if directory monitoring is not supported. If @cancellable is not %NULL, then the operation can be cancelled by @@ -45061,27 +45913,25 @@ It does not make sense for @flags to contain directories. It is not possible to monitor all the files in a directory for changes made via hard links; if you want to do this then you must register individual watches with g_file_monitor(). - + a #GFileMonitor for the given @file, - or %NULL on error. - Free the returned object with g_object_unref(). + filename="gio/gfile.c" + line="5827">a #GFileMonitor for the given @file, + or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="5808">input #GFile a set of #GFileMonitorFlags + filename="gio/gfile.c" + line="5809">a set of #GFileMonitorFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5810">optional #GCancellable object, %NULL to ignore @@ -45098,8 +45948,8 @@ you must register individual watches with g_file_monitor(). Obtains a file monitor for the given file. If no file notification + filename="gio/gfile.c" + line="5857">Obtains a file monitor for the given file. If no file notification mechanism exists, then regular polling of the file is used. If @cancellable is not %NULL, then the operation can be cancelled by @@ -45113,12 +45963,11 @@ changes made through the filename contained in @file to be reported. Using this flag may result in an increase in resource usage, and may not have any effect depending on the #GFileMonitor backend and/or filesystem type. - + a #GFileMonitor for the given @file, + filename="gio/gfile.c" + line="5880">a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -45126,14 +45975,14 @@ backend and/or filesystem type. input #GFile + filename="gio/gfile.c" + line="5859">input #GFile a set of #GFileMonitorFlags + filename="gio/gfile.c" + line="5860">a set of #GFileMonitorFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5861">optional #GCancellable object, %NULL to ignore + invoker="mount_enclosing_volume" + glib:finish-func="mount_enclosing_volume_finish"> Starts a @mount_operation, mounting the volume that contains + filename="gio/gfile.c" + line="7561">Starts a @mount_operation, mounting the volume that contains the file @location. When this operation has completed, @callback will be called with @@ -45162,22 +46012,21 @@ g_file_mount_enclosing_volume_finish(). If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + input #GFile + filename="gio/gfile.c" + line="7563">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="7564">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation + filename="gio/gfile.c" + line="7565">a #GMountOperation or %NULL to avoid user interaction @@ -45195,8 +46044,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="7567">optional #GCancellable object, %NULL to ignore @@ -45207,8 +46056,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. scope="async" closure="4"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="7569">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -45218,8 +46067,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="7571">the data to pass to callback function @@ -45228,14 +46077,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. invoker="mount_enclosing_volume_finish" throws="1"> Finishes a mount operation started by g_file_mount_enclosing_volume(). - + filename="gio/gfile.c" + line="7611">Finishes a mount operation started by g_file_mount_enclosing_volume(). + %TRUE if successful. If an error has occurred, + filename="gio/gfile.c" + line="7619">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -45243,22 +46091,24 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + filename="gio/gfile.c" + line="7613">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="7614">a #GAsyncResult - + Mounts a file of type G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="5349">Mounts a file of type G_FILE_TYPE_MOUNTABLE. Using @mount_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -45269,22 +46119,21 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="5351">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5352">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="5353">a #GMountOperation, or %NULL to avoid user interaction @@ -45302,8 +46151,8 @@ the result of the operation. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5355">optional #GCancellable object, %NULL to ignore @@ -45314,9 +46163,9 @@ the result of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5357">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="5359">the data to pass to callback function @@ -45335,39 +46184,41 @@ the result of the operation. invoker="mount_mountable_finish" throws="1"> Finishes a mount operation. See g_file_mount_mountable() for details. + filename="gio/gfile.c" + line="5404">Finishes a mount operation. See g_file_mount_mountable() for details. Finish an asynchronous mount operation that was started with g_file_mount_mountable(). - + a #GFile or %NULL on error. + filename="gio/gfile.c" + line="5415">a #GFile or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="5406">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5407">a #GAsyncResult - + Tries to move the file or directory @source to the location specified + filename="gio/gfile.c" + line="3848">Tries to move the file or directory @source to the location specified by @destination. If native move operations are supported then this is used, otherwise a copy + delete fallback is used. The native implementation may support moving directories (for instance on moves @@ -45400,31 +46251,30 @@ If the source is a directory and the target does not exist, or %G_FILE_COPY_OVERWRITE is specified and the target is a file, then the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native move operation isn't available). - + %TRUE on successful move, %FALSE otherwise. + filename="gio/gfile.c" + line="3895">%TRUE on successful move, %FALSE otherwise. #GFile pointing to the source location + filename="gio/gfile.c" + line="3850">#GFile pointing to the source location #GFile pointing to the destination location + filename="gio/gfile.c" + line="3851">#GFile pointing to the destination location set of #GFileCopyFlags + filename="gio/gfile.c" + line="3852">set of #GFileCopyFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3853">optional #GCancellable object, %NULL to ignore @@ -45444,8 +46294,8 @@ move operation isn't available). scope="call" closure="4"> #GFileProgressCallback + filename="gio/gfile.c" + line="3855">#GFileProgressCallback function for updates @@ -45454,17 +46304,21 @@ move operation isn't available). nullable="1" allow-none="1"> gpointer to user data for + filename="gio/gfile.c" + line="3857">gpointer to user data for the callback function - + Asynchronously moves a file @source to the location of @destination. For details of the behaviour, see g_file_move(). + filename="gio/gfile.c" + line="3982">Asynchronously moves a file @source to the location of @destination. For details of the behaviour, see g_file_move(). If @progress_callback is not %NULL, then that function that will be called just like in g_file_move(). The callback will run in the default main context @@ -45473,34 +46327,33 @@ run in. When the operation is finished, @callback will be called. You can then call g_file_move_finish() to get the result of the operation. - + #GFile pointing to the source location + filename="gio/gfile.c" + line="3984">#GFile pointing to the source location #GFile pointing to the destination location + filename="gio/gfile.c" + line="3985">#GFile pointing to the destination location set of #GFileCopyFlags + filename="gio/gfile.c" + line="3986">set of #GFileCopyFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="3987">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3988">optional #GCancellable object, %NULL to ignore @@ -45520,9 +46373,9 @@ g_file_move_finish() to get the result of the operation. scope="call" closure="5"> #GFileProgressCallback - function for updates + filename="gio/gfile.c" + line="3990"> + #GFileProgressCallback function for updates nullable="1" allow-none="1"> gpointer to user data for - the callback function + filename="gio/gfile.c" + line="3992">gpointer to user data for the callback function scope="async" closure="7"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="3993">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="7"> the data to pass to callback function + filename="gio/gfile.c" + line="3995">the data to pass to callback function @@ -45564,28 +46416,27 @@ g_file_move_finish() to get the result of the operation. version="2.72" throws="1"> Finishes an asynchronous file movement, started with + filename="gio/gfile.c" + line="4038">Finishes an asynchronous file movement, started with g_file_move_async(). - + %TRUE on successful file move, %FALSE otherwise. + filename="gio/gfile.c" + line="4047">%TRUE on successful file move, %FALSE otherwise. input source #GFile + filename="gio/gfile.c" + line="4040">input source #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4041">a #GAsyncResult @@ -45593,10 +46444,11 @@ g_file_move_async(). + throws="1" + glib:async-func="open_readwrite_async"> Opens an existing file for reading and writing. The result is + filename="gio/gfile.c" + line="1926">Opens an existing file for reading and writing. The result is a #GFileIOStream that can be used to read and write the contents of the file. @@ -45612,20 +46464,19 @@ what kind of filesystem the file is on. Note that in many non-local file cases read and write streams are not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing. - + #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="1949">#GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). #GFile to open + filename="gio/gfile.c" + line="1928">#GFile to open nullable="1" allow-none="1"> a #GCancellable + filename="gio/gfile.c" + line="1929">a #GCancellable + version="2.22" + glib:finish-func="open_readwrite_finish" + glib:sync-func="open_readwrite"> Asynchronously opens @file for reading and writing. + filename="gio/gfile.c" + line="2385">Asynchronously opens @file for reading and writing. For more details, see g_file_open_readwrite() which is the synchronous version of this call. @@ -45652,22 +46505,21 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_open_readwrite_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2387">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2388">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2389">optional #GCancellable object, %NULL to ignore @@ -45687,9 +46539,9 @@ the result of the operation. scope="async" closure="3"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2391">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gfile.c" + line="2393">the data to pass to callback function @@ -45709,39 +46561,39 @@ the result of the operation. version="2.22" throws="1"> Finishes an asynchronous file read operation started with + filename="gio/gfile.c" + line="2425">Finishes an asynchronous file read operation started with g_file_open_readwrite_async(). - + a #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="2434">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2427">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2428">a #GAsyncResult + version="2.22" + glib:finish-func="poll_mountable_finish"> Polls a file of type %G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="9141">Polls a file of type %G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -45750,16 +46602,15 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="9143">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="9144">optional #GCancellable object, %NULL to ignore scope="async" closure="2"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="9145">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -45789,8 +46640,8 @@ the result of the operation. allow-none="1" closure="2"> the data to pass to callback function + filename="gio/gfile.c" + line="9147">the data to pass to callback function @@ -45800,39 +46651,38 @@ the result of the operation. version="2.22" throws="1"> Finishes a poll operation. See g_file_poll_mountable() for details. + filename="gio/gfile.c" + line="9188">Finishes a poll operation. See g_file_poll_mountable() for details. Finish an asynchronous poll operation that was polled with g_file_poll_mountable(). - + %TRUE if the operation finished successfully. %FALSE + filename="gio/gfile.c" + line="9199">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="9190">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="9191">a #GAsyncResult Checks whether @file has the prefix specified by @prefix. + filename="gio/gfile.c" + line="945">Checks whether @file has the prefix specified by @prefix. In other words, if the names of initial elements of @file's pathname match @prefix. Only full pathname elements are matched, @@ -45846,36 +46696,36 @@ This call does no I/O, as it works purely on names. As such it can sometimes return %FALSE even if @file is inside a @prefix (from a filesystem point of view), because the prefix of @file is an alias of @prefix. - + %TRUE if the @file's parent, grandparent, etc is @prefix, + filename="gio/gfile.c" + line="965">%TRUE if the @file's parent, grandparent, etc is @prefix, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="948">input #GFile input #GFile + filename="gio/gfile.c" + line="947">input #GFile + throws="1" + glib:async-func="query_filesystem_info_async"> Similar to g_file_query_info(), but obtains information + filename="gio/gfile.c" + line="1425">Similar to g_file_query_info(), but obtains information about the filesystem the @file is on, rather than the file itself. For instance the amount of space available and the type of the filesystem. @@ -45900,26 +46750,25 @@ returned. If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + a #GFileInfo or %NULL if there was an error. + filename="gio/gfile.c" + line="1459">a #GFileInfo or %NULL if there was an error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1427">input #GFile an attribute query string + filename="gio/gfile.c" + line="1428">an attribute query string nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1429">optional #GCancellable object, %NULL to ignore + invoker="query_filesystem_info_async" + glib:finish-func="query_filesystem_info_finish" + glib:sync-func="query_filesystem_info"> Asynchronously gets the requested information about the filesystem + filename="gio/gfile.c" + line="1488">Asynchronously gets the requested information about the filesystem that the specified @file is on. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -45949,28 +46800,27 @@ synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_query_info_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="1490">input #GFile an attribute query string + filename="gio/gfile.c" + line="1491">an attribute query string the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1492">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1493">optional #GCancellable object, %NULL to ignore @@ -45990,9 +46840,9 @@ operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="1495">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="1497">the data to pass to callback function @@ -46011,15 +46861,14 @@ operation. invoker="query_filesystem_info_finish" throws="1"> Finishes an asynchronous filesystem info query. + filename="gio/gfile.c" + line="1532">Finishes an asynchronous filesystem info query. See g_file_query_filesystem_info_async(). - + #GFileInfo for given @file + filename="gio/gfile.c" + line="1541">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -46027,22 +46876,25 @@ See g_file_query_filesystem_info_async(). input #GFile + filename="gio/gfile.c" + line="1534">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1535">a #GAsyncResult - + Gets the requested information about specified @file. + filename="gio/gfile.c" + line="1280">Gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as the type or size of the file). @@ -46072,32 +46924,31 @@ about the symlink itself will be returned. If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + a #GFileInfo for the given @file, or %NULL + filename="gio/gfile.c" + line="1320">a #GFileInfo for the given @file, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1282">input #GFile an attribute query string + filename="gio/gfile.c" + line="1283">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1284">a set of #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1285">optional #GCancellable object, %NULL to ignore - + Asynchronously gets the requested information about specified @file. + filename="gio/gfile.c" + line="1350">Asynchronously gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -46124,34 +46978,33 @@ version of this call. When the operation is finished, @callback will be called. You can then call g_file_query_info_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="1352">input #GFile an attribute query string + filename="gio/gfile.c" + line="1353">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1354">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1355">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1356">optional #GCancellable object, %NULL to ignore @@ -46171,9 +47024,9 @@ then call g_file_query_info_finish() to get the result of the operation. scope="async" closure="5"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gfile.c" + line="1358">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="1360">the data to pass to callback function @@ -46192,15 +47045,14 @@ then call g_file_query_info_finish() to get the result of the operation. invoker="query_info_finish" throws="1"> Finishes an asynchronous file info query. + filename="gio/gfile.c" + line="1395">Finishes an asynchronous file info query. See g_file_query_info_async(). - + #GFileInfo for given @file + filename="gio/gfile.c" + line="1404">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -46208,14 +47060,14 @@ See g_file_query_info_async(). input #GFile + filename="gio/gfile.c" + line="1397">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1398">a #GAsyncResult @@ -46224,8 +47076,8 @@ See g_file_query_info_async(). invoker="query_settable_attributes" throws="1"> Obtain the list of settable attributes for the file. + filename="gio/gfile.c" + line="4816">Obtain the list of settable attributes for the file. Returns the type and full attribute name of all the attributes that can be set on this file. This doesn't mean setting it will @@ -46235,12 +47087,11 @@ specific file may not support a specific attribute. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GFileAttributeInfoList describing the settable attributes. + filename="gio/gfile.c" + line="4834">a #GFileAttributeInfoList describing the settable attributes. When you are done with it, release it with g_file_attribute_info_list_unref() @@ -46248,8 +47099,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + filename="gio/gfile.c" + line="4818">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4819">optional #GCancellable object, %NULL to ignore @@ -46268,20 +47119,19 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. invoker="query_writable_namespaces" throws="1"> Obtain the list of attribute namespaces where new attributes + filename="gio/gfile.c" + line="4874">Obtain the list of attribute namespaces where new attributes can be created by a user. An example of this is extended attributes (in the "xattr" namespace). If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GFileAttributeInfoList describing the writable namespaces. + filename="gio/gfile.c" + line="4889">a #GFileAttributeInfoList describing the writable namespaces. When you are done with it, release it with g_file_attribute_info_list_unref() @@ -46289,8 +47139,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + filename="gio/gfile.c" + line="4876">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4877">optional #GCancellable object, %NULL to ignore - + Asynchronously opens @file for reading. + filename="gio/gfile.c" + line="2098">Asynchronously opens @file for reading. For more details, see g_file_read() which is the synchronous version of this call. @@ -46316,22 +47168,21 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_read_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2100">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2101">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2102">optional #GCancellable object, %NULL to ignore @@ -46351,9 +47202,9 @@ of the operation. scope="async" closure="3"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2104">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gfile.c" + line="2106">the data to pass to callback function Finishes an asynchronous file read operation started with + filename="gio/gfile.c" + line="2136">Finishes an asynchronous file read operation started with g_file_read_async(). - + a #GFileInputStream or %NULL on error. + filename="gio/gfile.c" + line="2145">a #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2138">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2139">a #GAsyncResult Opens a file for reading. The result is a #GFileInputStream that + filename="gio/gfile.c" + line="1679">Opens a file for reading. The result is a #GFileInputStream that can be used to read the contents of the file. If @cancellable is not %NULL, then the operation can be cancelled by @@ -46411,20 +47261,19 @@ If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + #GFileInputStream or %NULL on error. + filename="gio/gfile.c" + line="1697">#GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). #GFile to read + filename="gio/gfile.c" + line="1681">#GFile to read nullable="1" allow-none="1"> a #GCancellable + filename="gio/gfile.c" + line="1682">a #GCancellable - + Returns an output stream for overwriting the file, possibly + filename="gio/gfile.c" + line="1838">Returns an output stream for overwriting the file, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -46482,20 +47334,19 @@ file systems don't allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + a #GFileOutputStream or %NULL on error. + filename="gio/gfile.c" + line="1891">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1840">input #GFile nullable="1" allow-none="1"> an optional [entity tag][gfile-etag] + filename="gio/gfile.c" + line="1841">an optional [entity tag](#entity-tags) for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="1843">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1844">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1845">optional #GCancellable object, %NULL to ignore - + Asynchronously overwrites the file, replacing the contents, + filename="gio/gfile.c" + line="2307">Asynchronously overwrites the file, replacing the contents, possibly creating a backup copy of the file first. For more details, see g_file_replace() which is @@ -46544,16 +47398,15 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_replace_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2309">input #GFile nullable="1" allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + filename="gio/gfile.c" + line="2310">an [entity tag](#entity-tags) for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="2312">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2313">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2314">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2315">optional #GCancellable object, %NULL to ignore @@ -46601,9 +47454,9 @@ of the operation. scope="async" closure="6"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2317">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="6"> the data to pass to callback function + filename="gio/gfile.c" + line="2319">the data to pass to callback function @@ -46622,29 +47475,28 @@ of the operation. invoker="replace_finish" throws="1"> Finishes an asynchronous file replace operation started with + filename="gio/gfile.c" + line="2356">Finishes an asynchronous file replace operation started with g_file_replace_async(). - + a #GFileOutputStream, or %NULL on error. + filename="gio/gfile.c" + line="2365">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2358">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2359">a #GAsyncResult @@ -46652,10 +47504,11 @@ g_file_replace_async(). + throws="1" + glib:async-func="replace_readwrite_async"> Returns an output stream for overwriting the file in readwrite mode, + filename="gio/gfile.c" + line="2043">Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -46665,20 +47518,19 @@ same thing but returns an output stream only. Note that in many non-local file cases read and write streams are not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing. - + a #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="2065">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). a #GFile + filename="gio/gfile.c" + line="2045">a #GFile nullable="1" allow-none="1"> an optional [entity tag][gfile-etag] + filename="gio/gfile.c" + line="2046">an optional [entity tag](#entity-tags) for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="2048">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2049">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2050">optional #GCancellable object, %NULL to ignore @@ -46717,10 +47569,12 @@ rather than just opening for reading or writing. + version="2.22" + glib:finish-func="replace_readwrite_finish" + glib:sync-func="replace_readwrite"> Asynchronously overwrites the file in read-write mode, + filename="gio/gfile.c" + line="2531">Asynchronously overwrites the file in read-write mode, replacing the contents, possibly creating a backup copy of the file first. @@ -46730,16 +47584,15 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_replace_readwrite_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2533">input #GFile nullable="1" allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + filename="gio/gfile.c" + line="2534">an [entity tag](#entity-tags) for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="2536">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2537">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2538">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2539">optional #GCancellable object, %NULL to ignore @@ -46787,9 +47640,9 @@ the result of the operation. scope="async" closure="6"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2541">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="6"> the data to pass to callback function + filename="gio/gfile.c" + line="2543">the data to pass to callback function @@ -46809,29 +47662,28 @@ the result of the operation. version="2.22" throws="1"> Finishes an asynchronous file replace operation started with + filename="gio/gfile.c" + line="2583">Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async(). - + a #GFileIOStream, or %NULL on error. + filename="gio/gfile.c" + line="2592">a #GFileIOStream, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2585">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2586">a #GAsyncResult @@ -46839,40 +47691,39 @@ g_file_replace_readwrite_async(). Resolves a relative path for @file to an absolute path. + filename="gio/gfile.c" + line="1019">Resolves a relative path for @file to an absolute path. This call does no blocking I/O. If the @relative_path is an absolute path name, the resolution is done absolutely (without taking @file path as base). - + a #GFile for the resolved path. + filename="gio/gfile.c" + line="1031">a #GFile for the resolved path. input #GFile + filename="gio/gfile.c" + line="1021">input #GFile a given relative path string + filename="gio/gfile.c" + line="1022">a given relative path string Sets an attribute in the file with attribute name @attribute to @value_p. + filename="gio/gfile.c" + line="4934">Sets an attribute in the file with attribute name @attribute to @value_p. Some attributes can be unset by setting @type to %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL. @@ -46880,31 +47731,30 @@ Some attributes can be unset by setting @type to If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the attribute was set, %FALSE otherwise. + filename="gio/gfile.c" + line="4955">%TRUE if the attribute was set, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4936">input #GFile a string containing the attribute's name + filename="gio/gfile.c" + line="4937">a string containing the attribute's name The type of the attribute + filename="gio/gfile.c" + line="4938">The type of the attribute nullable="1" allow-none="1"> a pointer to the value (or the pointer + filename="gio/gfile.c" + line="4939">a pointer to the value (or the pointer itself if the type is a pointer type) a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="4941">a set of #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4942">optional #GCancellable object, %NULL to ignore + invoker="set_attributes_async" + glib:finish-func="set_attributes_finish"> Asynchronously sets the attributes of @file with @info. + filename="gio/gfile.c" + line="5078">Asynchronously sets the attributes of @file with @info. For more details, see g_file_set_attributes_from_info(), which is the synchronous version of this call. @@ -46947,34 +47798,33 @@ which is the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_set_attributes_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="5080">input #GFile a #GFileInfo + filename="gio/gfile.c" + line="5081">a #GFileInfo a #GFileQueryInfoFlags + filename="gio/gfile.c" + line="5082">a #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="5083">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5084">optional #GCancellable object, %NULL to ignore @@ -46994,8 +47844,9 @@ the result of the operation. scope="async" closure="5"> a #GAsyncReadyCallback + filename="gio/gfile.c" + line="5086">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> a #gpointer + filename="gio/gfile.c" + line="5088">the data to pass to callback function @@ -47014,27 +47865,26 @@ the result of the operation. invoker="set_attributes_finish" throws="1"> Finishes setting an attribute started in g_file_set_attributes_async(). - + filename="gio/gfile.c" + line="5123">Finishes setting an attribute started in g_file_set_attributes_async(). + %TRUE if the attributes were set correctly, %FALSE otherwise. + filename="gio/gfile.c" + line="5132">%TRUE if the attributes were set correctly, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5125">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5126">a #GAsyncResult caller-allocates="0" transfer-ownership="full"> a #GFileInfo + filename="gio/gfile.c" + line="5127">a #GFileInfo @@ -47052,8 +47902,8 @@ the result of the operation. invoker="set_attributes_from_info" throws="1"> Tries to set all attributes in the #GFileInfo on the target + filename="gio/gfile.c" + line="4987">Tries to set all attributes in the #GFileInfo on the target values, not stopping on the first error. If there is any error during this operation then @error will @@ -47065,31 +47915,30 @@ also detect further errors. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %FALSE if there was any error, %TRUE otherwise. + filename="gio/gfile.c" + line="5009">%FALSE if there was any error, %TRUE otherwise. input #GFile + filename="gio/gfile.c" + line="4989">input #GFile a #GFileInfo + filename="gio/gfile.c" + line="4990">a #GFileInfo #GFileQueryInfoFlags + filename="gio/gfile.c" + line="4991">#GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4992">optional #GCancellable object, %NULL to ignore @@ -47106,10 +47955,11 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + throws="1" + glib:async-func="set_display_name_async"> Renames @file to the specified display name. + filename="gio/gfile.c" + line="4689">Renames @file to the specified display name. The display name is converted from UTF-8 to the correct encoding for the target filesystem if possible and the @file is renamed to this. @@ -47124,12 +47974,11 @@ On success the resulting converted filename is returned. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GFile specifying what @file was renamed to, + filename="gio/gfile.c" + line="4713">a #GFile specifying what @file was renamed to, or %NULL if there was an error. Free the returned object with g_object_unref(). @@ -47137,14 +47986,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + filename="gio/gfile.c" + line="4691">input #GFile a string + filename="gio/gfile.c" + line="4692">a string nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4693">optional #GCancellable object, %NULL to ignore + invoker="set_display_name_async" + glib:finish-func="set_display_name_finish" + glib:sync-func="set_display_name"> Asynchronously sets the display name for a given #GFile. + filename="gio/gfile.c" + line="4745">Asynchronously sets the display name for a given #GFile. For more details, see g_file_set_display_name() which is the synchronous version of this call. @@ -47171,28 +48022,27 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_set_display_name_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="4747">input #GFile a string + filename="gio/gfile.c" + line="4748">a string the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4749">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4750">optional #GCancellable object, %NULL to ignore @@ -47212,9 +48062,9 @@ the result of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="4752">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="4754">the data to pass to callback function @@ -47233,39 +48083,39 @@ the result of the operation. invoker="set_display_name_finish" throws="1"> Finishes setting a display name started with + filename="gio/gfile.c" + line="4787">Finishes setting a display name started with g_file_set_display_name_async(). - + a #GFile or %NULL on error. + filename="gio/gfile.c" + line="4796">a #GFile or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="4789">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4790">a #GAsyncResult + version="2.22" + glib:finish-func="start_mountable_finish"> Starts a file of type %G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="8962">Starts a file of type %G_FILE_TYPE_MOUNTABLE. Using @start_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -47276,22 +48126,21 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="8964">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="8965">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, or %NULL to avoid user interaction + filename="gio/gfile.c" + line="8966">a #GMountOperation, or %NULL to avoid user interaction nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="8967">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="8968">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="8969">the data to pass to callback function @@ -47340,41 +48189,41 @@ the result of the operation. version="2.22" throws="1"> Finishes a start operation. See g_file_start_mountable() for details. + filename="gio/gfile.c" + line="9016">Finishes a start operation. See g_file_start_mountable() for details. Finish an asynchronous start operation that was started with g_file_start_mountable(). - + %TRUE if the operation finished successfully. %FALSE + filename="gio/gfile.c" + line="9027">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="9018">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="9019">a #GAsyncResult + version="2.22" + glib:finish-func="stop_mountable_finish"> Stops a file of type %G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="9051">Stops a file of type %G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -47383,22 +48232,21 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_stop_mountable_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="9053">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="9054">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="9055">a #GMountOperation, or %NULL to avoid user interaction. @@ -47416,8 +48264,8 @@ the result of the operation. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="9057">optional #GCancellable object, %NULL to ignore @@ -47428,8 +48276,8 @@ the result of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="9059">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -47439,8 +48287,8 @@ the result of the operation. allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="9061">the data to pass to callback function @@ -47450,39 +48298,41 @@ the result of the operation. version="2.22" throws="1"> Finishes a stop operation, see g_file_stop_mountable() for details. + filename="gio/gfile.c" + line="9106">Finishes a stop operation, see g_file_stop_mountable() for details. Finish an asynchronous stop operation that was started with g_file_stop_mountable(). - + %TRUE if the operation finished successfully. + filename="gio/gfile.c" + line="9117">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="9108">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="9109">a #GAsyncResult - + Sends @file to the "Trashcan", if possible. This is similar to + filename="gio/gfile.c" + line="4585">Sends @file to the "Trashcan", if possible. This is similar to deleting it, but the user can recover it before emptying the trashcan. Not all file systems support trashing, so this call can return the %G_IO_ERROR_NOT_SUPPORTED error. Since GLib 2.66, the `x-gvfs-notrash` unix @@ -47492,19 +48342,18 @@ mounts, the %G_IO_ERROR_NOT_SUPPORTED error will be returned in that case. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE on successful trash, %FALSE otherwise. + filename="gio/gfile.c" + line="4603">%TRUE on successful trash, %FALSE otherwise. #GFile to send to trash + filename="gio/gfile.c" + line="4587">#GFile to send to trash nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4588">optional #GCancellable object, %NULL to ignore - + Asynchronously sends @file to the Trash location, if possible. - + filename="gio/gfile.c" + line="4630">Asynchronously sends @file to the Trash location, if possible. + input #GFile + filename="gio/gfile.c" + line="4632">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4633">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4634">optional #GCancellable object, %NULL to ignore @@ -47558,8 +48410,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. scope="async" closure="3"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4636">a #GAsyncReadyCallback to call when the request is satisfied @@ -47569,8 +48421,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gfile.c" + line="4638">the data to pass to callback function @@ -47580,28 +48432,27 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.38" throws="1"> Finishes an asynchronous file trashing operation, started with + filename="gio/gfile.c" + line="4663">Finishes an asynchronous file trashing operation, started with g_file_trash_async(). - + %TRUE on successful trash, %FALSE otherwise. + filename="gio/gfile.c" + line="4672">%TRUE on successful trash, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4665">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4666">a #GAsyncResult @@ -47609,10 +48460,11 @@ g_file_trash_async(). + deprecated-version="2.22" + glib:finish-func="unmount_mountable_finish"> Unmounts a file of type G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="5437">Unmounts a file of type G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -47622,22 +48474,21 @@ When the operation is finished, @callback will be called. You can then call g_file_unmount_mountable_finish() to get the result of the operation. Use g_file_unmount_mountable_with_operation() instead. - + input #GFile + filename="gio/gfile.c" + line="5439">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5440">flags affecting the operation nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5441">optional #GCancellable object, %NULL to ignore @@ -47657,9 +48508,9 @@ the result of the operation. scope="async" closure="3"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5443">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gfile.c" + line="5445">the data to pass to callback function @@ -47680,43 +48531,43 @@ the result of the operation. deprecated-version="2.22" throws="1"> Finishes an unmount operation, see g_file_unmount_mountable() for details. + filename="gio/gfile.c" + line="5488">Finishes an unmount operation, see g_file_unmount_mountable() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable(). Use g_file_unmount_mountable_with_operation_finish() instead. - + %TRUE if the operation finished successfully. + filename="gio/gfile.c" + line="5499">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5490">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5491">a #GAsyncResult + version="2.22" + glib:finish-func="unmount_mountable_with_operation_finish"> Unmounts a file of type %G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="5524">Unmounts a file of type %G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -47725,22 +48576,21 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_unmount_mountable_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="5526">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5527">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="5528">a #GMountOperation, or %NULL to avoid user interaction @@ -47758,8 +48608,8 @@ the result of the operation. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5530">optional #GCancellable object, %NULL to ignore @@ -47770,9 +48620,9 @@ the result of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5532">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="5534">the data to pass to callback function @@ -47792,40 +48642,42 @@ the result of the operation. version="2.22" throws="1"> Finishes an unmount operation, + filename="gio/gfile.c" + line="5586">Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable_with_operation(). - + %TRUE if the operation finished successfully. + filename="gio/gfile.c" + line="5598">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5588">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5589">a #GAsyncResult - + Gets an output stream for appending data to the file. + filename="gio/gfile.c" + line="1725">Gets an output stream for appending data to the file. If the file doesn't already exist it is created. By default files created are generally readable by everyone, @@ -47842,26 +48694,25 @@ Some file systems don't allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error. If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + a #GFileOutputStream, or %NULL on error. + filename="gio/gfile.c" + line="1751">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1727">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1728">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1729">optional #GCancellable object, %NULL to ignore - + Asynchronously opens @file for appending. + filename="gio/gfile.c" + line="2165">Asynchronously opens @file for appending. For more details, see g_file_append_to() which is the synchronous version of this call. @@ -47887,28 +48741,27 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_append_to_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2167">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2168">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2169">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2170">optional #GCancellable object, %NULL to ignore @@ -47928,9 +48781,9 @@ of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2172">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="2174">the data to pass to callback function @@ -47948,15 +48801,14 @@ of the operation. c:identifier="g_file_append_to_finish" throws="1"> Finishes an asynchronous file append operation started with + filename="gio/gfile.c" + line="2206">Finishes an asynchronous file append operation started with g_file_append_to_async(). - + a valid #GFileOutputStream + filename="gio/gfile.c" + line="2215">a valid #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -47964,14 +48816,14 @@ g_file_append_to_async(). input #GFile + filename="gio/gfile.c" + line="2208">input #GFile #GAsyncResult + filename="gio/gfile.c" + line="2209">#GAsyncResult @@ -47981,8 +48833,8 @@ g_file_append_to_async(). version="2.68" throws="1"> Prepares the file attribute query string for copying to @file. + filename="gio/gfile.c" + line="2760">Prepares the file attribute query string for copying to @file. This function prepares an attribute query string to be passed to g_file_query_info() to get a list of attributes @@ -47991,26 +48843,25 @@ for the detailed description). This function is used by the implementation of g_file_copy_attributes() and is useful when one needs to query and set the attributes in two stages (e.g., for recursive move of a directory). - + an attribute query string for g_file_query_info(), + filename="gio/gfile.c" + line="2778">an attribute query string for g_file_query_info(), or %NULL if an error occurs. a #GFile to copy attributes to + filename="gio/gfile.c" + line="2762">a #GFile to copy attributes to a set of #GFileCopyFlags + filename="gio/gfile.c" + line="2763">a set of #GFileCopyFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2764">optional #GCancellable object, %NULL to ignore - + Copies the file @source to the location specified by @destination. + filename="gio/gfile.c" + line="3638">Copies the file @source to the location specified by @destination. Can not handle recursive copies of directories. If the flag %G_FILE_COPY_OVERWRITE is specified an already @@ -48068,31 +48922,30 @@ If the source is a directory and the target does not exist, or If you are interested in copying the #GFile object itself (not the on-disk file), see g_file_dup(). - + %TRUE on success, %FALSE otherwise. + filename="gio/gfile.c" + line="3691">%TRUE on success, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="3640">input #GFile destination #GFile + filename="gio/gfile.c" + line="3641">destination #GFile set of #GFileCopyFlags + filename="gio/gfile.c" + line="3642">set of #GFileCopyFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3643">optional #GCancellable object, %NULL to ignore @@ -48112,8 +48965,8 @@ file), see g_file_dup(). scope="call" closure="4"> function to callback with + filename="gio/gfile.c" + line="3645">function to callback with progress information, or %NULL if progress information is not needed @@ -48122,16 +48975,19 @@ file), see g_file_dup(). nullable="1" allow-none="1"> user data to pass to @progress_callback + filename="gio/gfile.c" + line="3647">user data to pass to @progress_callback - + Copies the file @source to the location specified by @destination + filename="gio/gfile.c" + line="3766">Copies the file @source to the location specified by @destination asynchronously. For details of the behaviour, see g_file_copy(). If @progress_callback is not %NULL, then that function that will be called @@ -48141,34 +48997,33 @@ run in. When the operation is finished, @callback will be called. You can then call g_file_copy_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="3768">input #GFile destination #GFile + filename="gio/gfile.c" + line="3769">destination #GFile set of #GFileCopyFlags + filename="gio/gfile.c" + line="3770">set of #GFileCopyFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="3771">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3772">optional #GCancellable object, %NULL to ignore @@ -48188,19 +49043,19 @@ g_file_copy_finish() to get the result of the operation. scope="notified" closure="5"> function to callback with progress - information, or %NULL if progress information is not needed + filename="gio/gfile.c" + line="3774"> + function to callback with progress information, or %NULL if + progress information is not needed + allow-none="1"> user data to pass to @progress_callback + filename="gio/gfile.c" + line="3777">user data to pass to @progress_callback scope="async" closure="7"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfile.c" + line="3778">a #GAsyncReadyCallback + to call when the request is satisfied + allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="3780">the data to pass to callback @@ -48230,8 +49085,8 @@ g_file_copy_finish() to get the result of the operation. c:identifier="g_file_copy_attributes" throws="1"> Copies the file attributes from @source to @destination. + filename="gio/gfile.c" + line="2874">Copies the file attributes from @source to @destination. Normally only a subset of the file attributes are copied, those that are copies in a normal file copy operation @@ -48239,32 +49094,31 @@ those that are copies in a normal file copy operation if %G_FILE_COPY_ALL_METADATA is specified in @flags, then all the metadata that is possible to copy is copied. This is useful when implementing move by copy + delete source. - + %TRUE if the attributes were copied successfully, + filename="gio/gfile.c" + line="2892">%TRUE if the attributes were copied successfully, %FALSE otherwise. a #GFile with attributes + filename="gio/gfile.c" + line="2876">a #GFile with attributes a #GFile to copy attributes to + filename="gio/gfile.c" + line="2877">a #GFile to copy attributes to a set of #GFileCopyFlags + filename="gio/gfile.c" + line="2878">a set of #GFileCopyFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2879">optional #GCancellable object, %NULL to ignore @@ -48281,35 +49135,37 @@ is useful when implementing move by copy + delete source. Finishes copying the file started with g_file_copy_async(). - + filename="gio/gfile.c" + line="3821">Finishes copying the file started with g_file_copy_async(). + a %TRUE on success, %FALSE on error. + filename="gio/gfile.c" + line="3829">a %TRUE on success, %FALSE on error. input #GFile + filename="gio/gfile.c" + line="3823">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="3824">a #GAsyncResult - + Creates a new file and returns an output stream for writing to it. + filename="gio/gfile.c" + line="1780">Creates a new file and returns an output stream for writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -48328,12 +49184,11 @@ allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + a #GFileOutputStream for the newly created + filename="gio/gfile.c" + line="1808">a #GFileOutputStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -48341,14 +49196,14 @@ of filesystem the file is on. input #GFile + filename="gio/gfile.c" + line="1782">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1783">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1784">optional #GCancellable object, %NULL to ignore - + Asynchronously creates a new file and returns an output stream + filename="gio/gfile.c" + line="2236">Asynchronously creates a new file and returns an output stream for writing to it. The file must not already exist. For more details, see g_file_create() which is @@ -48375,28 +49233,27 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_create_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2238">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2239">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2240">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2241">optional #GCancellable object, %NULL to ignore @@ -48416,9 +49273,9 @@ of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2243">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="2245">the data to pass to callback function @@ -48436,29 +49293,28 @@ of the operation. c:identifier="g_file_create_finish" throws="1"> Finishes an asynchronous file create operation started with + filename="gio/gfile.c" + line="2278">Finishes an asynchronous file create operation started with g_file_create_async(). - + a #GFileOutputStream or %NULL on error. + filename="gio/gfile.c" + line="2287">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2280">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2281">a #GAsyncResult @@ -48466,10 +49322,11 @@ g_file_create_async(). + throws="1" + glib:async-func="create_readwrite_async"> Creates a new file and returns a stream for reading and + filename="gio/gfile.c" + line="1979">Creates a new file and returns a stream for reading and writing to it. The file must not already exist. By default files created are generally readable by everyone, @@ -48492,12 +49349,11 @@ kind of filesystem the file is on. Note that in many non-local file cases read and write streams are not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing. - + a #GFileIOStream for the newly created + filename="gio/gfile.c" + line="2011">a #GFileIOStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -48505,14 +49361,14 @@ streaming, rather than just opening for reading or writing. a #GFile + filename="gio/gfile.c" + line="1981">a #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1982">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1983">optional #GCancellable object, %NULL to ignore @@ -48529,10 +49385,12 @@ streaming, rather than just opening for reading or writing. + version="2.22" + glib:finish-func="create_readwrite_finish" + glib:sync-func="create_readwrite"> Asynchronously creates a new file and returns a stream + filename="gio/gfile.c" + line="2456">Asynchronously creates a new file and returns a stream for reading and writing to it. The file must not already exist. For more details, see g_file_create_readwrite() which is @@ -48541,28 +49399,27 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_create_readwrite_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2458">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2459">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2460">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2461">optional #GCancellable object, %NULL to ignore @@ -48582,9 +49439,9 @@ the result of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2463">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="2465">the data to pass to callback function @@ -48603,37 +49460,39 @@ the result of the operation. version="2.22" throws="1"> Finishes an asynchronous file create operation started with + filename="gio/gfile.c" + line="2500">Finishes an asynchronous file create operation started with g_file_create_readwrite_async(). - + a #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="2509">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2502">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2503">a #GAsyncResult - + Deletes a file. If the @file is a directory, it will only be + filename="gio/gfile.c" + line="4466">Deletes a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). If @file doesn’t exist, %G_IO_ERROR_NOT_FOUND will be returned. This allows @@ -48654,19 +49513,18 @@ if (!g_file_delete (my_file, my_cancellable, &local_error) && If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the file was deleted. %FALSE otherwise. + filename="gio/gfile.c" + line="4495">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4468">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4469">optional #GCancellable object, %NULL to ignore @@ -48683,28 +49541,29 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + version="2.34" + glib:finish-func="delete_finish" + glib:sync-func="delete"> Asynchronously delete a file. If the @file is a directory, it will + filename="gio/gfile.c" + line="4522">Asynchronously delete a file. If the @file is a directory, it will only be deleted if it is empty. This has the same semantics as g_unlink(). - + input #GFile + filename="gio/gfile.c" + line="4524">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4525">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4526">optional #GCancellable object, %NULL to ignore @@ -48724,8 +49583,8 @@ g_unlink(). scope="async" closure="3"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4528">a #GAsyncReadyCallback to call when the request is satisfied @@ -48734,8 +49593,8 @@ g_unlink(). nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="4530">the data to pass to callback function @@ -48745,35 +49604,34 @@ g_unlink(). version="2.34" throws="1"> Finishes deleting a file started with g_file_delete_async(). - + filename="gio/gfile.c" + line="4557">Finishes deleting a file started with g_file_delete_async(). + %TRUE if the file was deleted. %FALSE otherwise. + filename="gio/gfile.c" + line="4565">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4559">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4560">a #GAsyncResult Duplicates a #GFile handle. This operation does not duplicate + filename="gio/gfile.c" + line="724">Duplicates a #GFile handle. This operation does not duplicate the actual file or directory represented by the #GFile; see g_file_copy() if attempting to copy a file. @@ -48783,20 +49641,19 @@ within the same thread, use g_object_ref() to increment the existing object’s reference count. This call does no blocking I/O. - + a new #GFile that is a duplicate + filename="gio/gfile.c" + line="739">a new #GFile that is a duplicate of the given #GFile. input #GFile + filename="gio/gfile.c" + line="726">input #GFile @@ -48804,10 +49661,11 @@ This call does no blocking I/O. + deprecated-version="2.22" + glib:finish-func="eject_mountable_finish"> Starts an asynchronous eject on a mountable. + filename="gio/gfile.c" + line="5625">Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_finish(). @@ -48816,22 +49674,21 @@ If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Use g_file_eject_mountable_with_operation() instead. - + input #GFile + filename="gio/gfile.c" + line="5627">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5628">flags affecting the operation nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5629">optional #GCancellable object, %NULL to ignore @@ -48851,9 +49708,9 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. scope="async" closure="3"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5631">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="5633">the data to pass to callback function @@ -48873,41 +49730,41 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. deprecated-version="2.22" throws="1"> Finishes an asynchronous eject operation started by + filename="gio/gfile.c" + line="5675">Finishes an asynchronous eject operation started by g_file_eject_mountable(). Use g_file_eject_mountable_with_operation_finish() instead. - + %TRUE if the @file was ejected successfully. + filename="gio/gfile.c" + line="5684">%TRUE if the @file was ejected successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5677">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5678">a #GAsyncResult + version="2.22" + glib:finish-func="eject_mountable_with_operation_finish"> Starts an asynchronous eject on a mountable. + filename="gio/gfile.c" + line="5709">Starts an asynchronous eject on a mountable. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_eject_mountable_with_operation_finish(). @@ -48915,22 +49772,21 @@ g_file_eject_mountable_with_operation_finish(). If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + input #GFile + filename="gio/gfile.c" + line="5711">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5712">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="5713">a #GMountOperation, or %NULL to avoid user interaction @@ -48948,8 +49804,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5715">optional #GCancellable object, %NULL to ignore @@ -48960,9 +49816,9 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5717">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="5719">the data to pass to callback function @@ -48981,39 +49837,39 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.22" throws="1"> Finishes an asynchronous eject operation started by + filename="gio/gfile.c" + line="5770">Finishes an asynchronous eject operation started by g_file_eject_mountable_with_operation(). - + %TRUE if the @file was ejected successfully. + filename="gio/gfile.c" + line="5779">%TRUE if the @file was ejected successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5772">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5773">a #GAsyncResult + throws="1" + glib:async-func="enumerate_children_async"> Gets the requested information about the files in a directory. + filename="gio/gfile.c" + line="1047">Gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -49038,32 +49894,31 @@ returned. If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is not a directory, the %G_IO_ERROR_NOT_DIRECTORY error will be returned. Other errors are possible too. - + A #GFileEnumerator if successful, + filename="gio/gfile.c" + line="1082">A #GFileEnumerator if successful, %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1049">input #GFile an attribute query string + filename="gio/gfile.c" + line="1050">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1051">a set of #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1052">optional #GCancellable object, %NULL to ignore + c:identifier="g_file_enumerate_children_async" + glib:finish-func="enumerate_children_finish" + glib:sync-func="enumerate_children"> Asynchronously gets the requested information about the files + filename="gio/gfile.c" + line="1113">Asynchronously gets the requested information about the files in a directory. The result is a #GFileEnumerator object that will give out #GFileInfo objects for all the files in the directory. @@ -49092,34 +49949,33 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_enumerate_children_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="1115">input #GFile an attribute query string + filename="gio/gfile.c" + line="1116">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1117">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1118">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1119">optional #GCancellable object, %NULL to ignore @@ -49139,9 +49995,9 @@ the operation. scope="async" closure="5"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gfile.c" + line="1121">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="1123">the data to pass to callback function @@ -49159,15 +50015,14 @@ the operation. c:identifier="g_file_enumerate_children_finish" throws="1"> Finishes an async enumerate children operation. + filename="gio/gfile.c" + line="1159">Finishes an async enumerate children operation. See g_file_enumerate_children_async(). - + a #GFileEnumerator or %NULL + filename="gio/gfile.c" + line="1168">a #GFileEnumerator or %NULL if an error occurred. Free the returned object with g_object_unref(). @@ -49175,57 +50030,57 @@ See g_file_enumerate_children_async(). input #GFile + filename="gio/gfile.c" + line="1161">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1162">a #GAsyncResult Checks if the two given #GFiles refer to the same file. + filename="gio/gfile.c" + line="779">Checks if the two given #GFiles refer to the same file. Note that two #GFiles that differ can still refer to the same file on the filesystem due to various forms of filename aliasing. This call does no blocking I/O. - + %TRUE if @file1 and @file2 are equal. + filename="gio/gfile.c" + line="792">%TRUE if @file1 and @file2 are equal. the first #GFile + filename="gio/gfile.c" + line="781">the first #GFile the second #GFile + filename="gio/gfile.c" + line="782">the second #GFile + throws="1" + glib:async-func="find_enclosing_mount_async"> Gets a #GMount for the #GFile. + filename="gio/gfile.c" + line="1562">Gets a #GMount for the #GFile. #GMount is returned only for user interesting locations, see #GVolumeMonitor. If the #GFileIface for @file does not have a #mount, @@ -49234,12 +50089,11 @@ This call does no blocking I/O. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GMount where the @file is located + filename="gio/gfile.c" + line="1579">a #GMount where the @file is located or %NULL on error. Free the returned object with g_object_unref(). @@ -49247,8 +50101,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + filename="gio/gfile.c" + line="1564">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1565">optional #GCancellable object, %NULL to ignore + c:identifier="g_file_find_enclosing_mount_async" + glib:finish-func="find_enclosing_mount_finish" + glib:sync-func="find_enclosing_mount"> Asynchronously gets the mount for the file. + filename="gio/gfile.c" + line="1611">Asynchronously gets the mount for the file. For more details, see g_file_find_enclosing_mount() which is the synchronous version of this call. @@ -49275,22 +50131,21 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_find_enclosing_mount_finish() to get the result of the operation. - + a #GFile + filename="gio/gfile.c" + line="1613">a #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1614">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1615">optional #GCancellable object, %NULL to ignore @@ -49310,9 +50165,9 @@ get the result of the operation. scope="async" closure="3"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="1617">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="1619">the data to pass to callback function @@ -49330,37 +50185,36 @@ get the result of the operation. c:identifier="g_file_find_enclosing_mount_finish" throws="1"> Finishes an asynchronous find mount request. + filename="gio/gfile.c" + line="1649">Finishes an asynchronous find mount request. See g_file_find_enclosing_mount_async(). - + #GMount for given @file or %NULL on error. + filename="gio/gfile.c" + line="1658">#GMount for given @file or %NULL on error. Free the returned object with g_object_unref(). a #GFile + filename="gio/gfile.c" + line="1651">a #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1652">a #GAsyncResult Gets the base name (the last component of the path) for a given #GFile. + filename="gio/gfile.c" + line="536">Gets the base name (the last component of the path) for a given #GFile. If called for the top level of a system (such as the filesystem root or a uri like sftp://host/) it will return a single directory separator @@ -49373,12 +50227,11 @@ can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info(). This call does no blocking I/O. - + string containing the #GFile's + filename="gio/gfile.c" + line="554">string containing the #GFile's base name, or %NULL if given #GFile is invalid. The returned string should be freed with g_free() when no longer needed. @@ -49386,42 +50239,41 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="538">input #GFile Gets a child of @file with basename equal to @name. + filename="gio/gfile.c" + line="884">Gets a child of @file with basename equal to @name. Note that the file with that specific name might not exist, but you can still have a #GFile that points to it. You can use this for instance to create that file. This call does no blocking I/O. - + a #GFile to a child specified by @name. + filename="gio/gfile.c" + line="897">a #GFile to a child specified by @name. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="886">input #GFile string containing the child's basename + filename="gio/gfile.c" + line="887">string containing the child's basename @@ -49430,8 +50282,8 @@ This call does no blocking I/O. c:identifier="g_file_get_child_for_display_name" throws="1"> Gets the child of @file for a given @display_name (i.e. a UTF-8 + filename="gio/gfile.c" + line="911">Gets the child of @file for a given @display_name (i.e. a UTF-8 version of the name). If this function fails, it returns %NULL and @error will be set. This is very useful when constructing a #GFile for a new file and the user entered the filename in the @@ -49439,12 +50291,11 @@ user interface, for instance when you select a directory and type a filename in the file selector. This call does no blocking I/O. - + a #GFile to the specified child, or + filename="gio/gfile.c" + line="926">a #GFile to the specified child, or %NULL if the display name couldn't be converted. Free the returned object with g_object_unref(). @@ -49452,32 +50303,31 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="913">input #GFile string to a possible child + filename="gio/gfile.c" + line="914">string to a possible child Gets the parent directory for the @file. + filename="gio/gfile.c" + line="815">Gets the parent directory for the @file. If the @file represents the root directory of the file system, then %NULL will be returned. This call does no blocking I/O. - + a #GFile structure to the + filename="gio/gfile.c" + line="825">a #GFile structure to the parent of the given #GFile or %NULL if there is no parent. Free the returned object with g_object_unref(). @@ -49485,16 +50335,16 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="817">input #GFile Gets the parse name of the @file. + filename="gio/gfile.c" + line="689">Gets the parse name of the @file. A parse name is a UTF-8 string that describes the file such that one can get the #GFile back using g_file_parse_name(). @@ -49508,12 +50358,11 @@ to UTF-8 the pathname is used, otherwise the IRI is used (a form of URI that allows UTF-8 characters unescaped). This call does no blocking I/O. - + a string containing the #GFile's parse name. + filename="gio/gfile.c" + line="708">a string containing the #GFile's parse name. The returned string should be freed with g_free() when no longer needed. @@ -49521,25 +50370,24 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="691">input #GFile Gets the local pathname for #GFile, if one exists. If non-%NULL, this is + filename="gio/gfile.c" + line="570">Gets the local pathname for #GFile, if one exists. If non-%NULL, this is guaranteed to be an absolute, canonical path. It might contain symlinks. This call does no blocking I/O. - + string containing the #GFile's path, + filename="gio/gfile.c" + line="579">string containing the #GFile's path, or %NULL if no such path exists. The returned string should be freed with g_free() when no longer needed. @@ -49547,24 +50395,23 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="572">input #GFile Gets the path for @descendant relative to @parent. + filename="gio/gfile.c" + line="988">Gets the path for @descendant relative to @parent. This call does no blocking I/O. - + string with the relative path from + filename="gio/gfile.c" + line="997">string with the relative path from @descendant to @parent, or %NULL if @descendant doesn't have @parent as prefix. The returned string should be freed with g_free() when no longer needed. @@ -49573,30 +50420,29 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="990">input #GFile input #GFile + filename="gio/gfile.c" + line="991">input #GFile Gets the URI for the @file. + filename="gio/gfile.c" + line="664">Gets the URI for the @file. This call does no blocking I/O. - + a string containing the #GFile's URI. If the #GFile was constructed + filename="gio/gfile.c" + line="672">a string containing the #GFile's URI. If the #GFile was constructed with an invalid URI, an invalid URI is returned. The returned string should be freed with g_free() when no longer needed. @@ -49605,16 +50451,16 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="666">input #GFile Gets the URI scheme for a #GFile. + filename="gio/gfile.c" + line="503">Gets the URI scheme for a #GFile. RFC 3986 decodes the scheme as: |[ URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] @@ -49625,12 +50471,11 @@ The scheme can be different from the one used to construct the #GFile, in that it might be replaced with one that is logically equivalent to the #GFile. This call does no blocking I/O. - + a string containing the URI scheme for the given + filename="gio/gfile.c" + line="519">a string containing the URI scheme for the given #GFile or %NULL if the #GFile was constructed with an invalid URI. The returned string should be freed with g_free() when no longer needed. @@ -49638,8 +50483,8 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="505">input #GFile @@ -49648,26 +50493,25 @@ This call does no blocking I/O. c:identifier="g_file_has_parent" version="2.24"> Checks if @file has a parent, and optionally, if it is @parent. + filename="gio/gfile.c" + line="841">Checks if @file has a parent, and optionally, if it is @parent. If @parent is %NULL then this function returns %TRUE if @file has any parent at all. If @parent is non-%NULL then %TRUE is only returned if @file is an immediate child of @parent. - + %TRUE if @file is an immediate child of @parent (or any parent in + filename="gio/gfile.c" + line="852">%TRUE if @file is an immediate child of @parent (or any parent in the case that @parent is %NULL). input #GFile + filename="gio/gfile.c" + line="843">input #GFile nullable="1" allow-none="1"> the parent to check for, or %NULL + filename="gio/gfile.c" + line="844">the parent to check for, or %NULL Checks whether @file has the prefix specified by @prefix. + filename="gio/gfile.c" + line="945">Checks whether @file has the prefix specified by @prefix. In other words, if the names of initial elements of @file's pathname match @prefix. Only full pathname elements are matched, @@ -49698,42 +50542,40 @@ This call does no I/O, as it works purely on names. As such it can sometimes return %FALSE even if @file is inside a @prefix (from a filesystem point of view), because the prefix of @file is an alias of @prefix. - + %TRUE if the @file's parent, grandparent, etc is @prefix, + filename="gio/gfile.c" + line="965">%TRUE if the @file's parent, grandparent, etc is @prefix, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="947">input #GFile input #GFile + filename="gio/gfile.c" + line="948">input #GFile Checks to see if a #GFile has a given URI scheme. + filename="gio/gfile.c" + line="475">Checks to see if a #GFile has a given URI scheme. This call does no blocking I/O. - + %TRUE if #GFile's backend supports the + filename="gio/gfile.c" + line="484">%TRUE if #GFile's backend supports the given URI scheme, %FALSE if URI scheme is %NULL, not supported, or #GFile is invalid. @@ -49741,30 +50583,29 @@ This call does no blocking I/O. input #GFile + filename="gio/gfile.c" + line="477">input #GFile a string containing a URI scheme + filename="gio/gfile.c" + line="478">a string containing a URI scheme Creates a hash value for a #GFile. + filename="gio/gfile.c" + line="754">Creates a hash value for a #GFile. This call does no blocking I/O. - + 0 if @file is not a valid #GFile, otherwise an + filename="gio/gfile.c" + line="762">0 if @file is not a valid #GFile, otherwise an integer that can be used as hash value for the #GFile. This function is intended for easily hashing a #GFile to add to a #GHashTable or similar data structure. @@ -49773,16 +50614,16 @@ This call does no blocking I/O. #gconstpointer to a #GFile + filename="gio/gfile.c" + line="756">#gconstpointer to a #GFile Checks to see if a file is native to the platform. + filename="gio/gfile.c" + line="444">Checks to see if a file is native to the platform. A native file is one expressed in the platform-native filename format, e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local, @@ -49793,19 +50634,18 @@ filesystem via a userspace filesystem (FUSE), in these cases this call will return %FALSE, but g_file_get_path() will still return a native path. This call does no blocking I/O. - + %TRUE if @file is native + filename="gio/gfile.c" + line="460">%TRUE if @file is native input #GFile + filename="gio/gfile.c" + line="446">input #GFile @@ -49813,10 +50653,11 @@ This call does no blocking I/O. + throws="1" + glib:async-func="load_bytes_async"> Loads the contents of @file and returns it as #GBytes. + filename="gio/gfile.c" + line="9247">Loads the contents of @file and returns it as #GBytes. If @file is a resource:// based URI, the resulting bytes will reference the embedded resource instead of a copy. Otherwise, this is equivalent to calling @@ -49827,19 +50668,18 @@ For resources, @etag_out will be set to %NULL. The data contained in the resulting #GBytes is always zero-terminated, but this is not included in the #GBytes length. The resulting #GBytes should be freed with g_bytes_unref() when no longer in use. - + a #GBytes or %NULL and @error is set + filename="gio/gfile.c" + line="9267">a #GBytes or %NULL and @error is set a #GFile + filename="gio/gfile.c" + line="9249">a #GFile nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gfile.c" + line="9250">a #GCancellable or %NULL optional="1" allow-none="1"> a location to place the current + filename="gio/gfile.c" + line="9251">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed @@ -49868,10 +50708,12 @@ freed with g_bytes_unref() when no longer in use. + version="2.56" + glib:finish-func="load_bytes_finish" + glib:sync-func="load_bytes"> Asynchronously loads the contents of @file as #GBytes. + filename="gio/gfile.c" + line="9334">Asynchronously loads the contents of @file as #GBytes. If @file is a resource:// based URI, the resulting bytes will reference the embedded resource instead of a copy. Otherwise, this is equivalent to calling @@ -49881,16 +50723,15 @@ g_file_load_contents_async() and g_bytes_new_take(). asynchronous operation. See g_file_load_bytes() for more information. - + a #GFile + filename="gio/gfile.c" + line="9336">a #GFile nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gfile.c" + line="9337">a #GCancellable or %NULL scope="async" closure="2"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gfile.c" + line="9338">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="9340">the data to pass to callback function @@ -49930,8 +50771,8 @@ See g_file_load_bytes() for more information. version="2.56" throws="1"> Completes an asynchronous request to g_file_load_bytes_async(). + filename="gio/gfile.c" + line="9392">Completes an asynchronous request to g_file_load_bytes_async(). For resources, @etag_out will be set to %NULL. @@ -49940,25 +50781,24 @@ this is not included in the #GBytes length. The resulting #GBytes should be freed with g_bytes_unref() when no longer in use. See g_file_load_bytes() for more information. - + a #GBytes or %NULL and @error is set + filename="gio/gfile.c" + line="9410">a #GBytes or %NULL and @error is set a #GFile + filename="gio/gfile.c" + line="9394">a #GFile a #GAsyncResult provided to the callback + filename="gio/gfile.c" + line="9395">a #GAsyncResult provided to the callback optional="1" allow-none="1"> a location to place the current + filename="gio/gfile.c" + line="9396">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed @@ -49978,10 +50818,11 @@ See g_file_load_bytes() for more information. + throws="1" + glib:async-func="load_contents_async"> Loads the content of the file into memory. The data is always + filename="gio/gfile.c" + line="7904">Loads the content of the file into memory. The data is always zero-terminated, but this is not included in the resultant @length. The returned @contents should be freed with g_free() when no longer needed. @@ -49989,20 +50830,19 @@ needed. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the @file's contents were successfully loaded. + filename="gio/gfile.c" + line="7924">%TRUE if the @file's contents were successfully loaded. %FALSE if there were errors. input #GFile + filename="gio/gfile.c" + line="7906">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="7907">optional #GCancellable object, %NULL to ignore caller-allocates="0" transfer-ownership="full"> a location to place the contents of the file + filename="gio/gfile.c" + line="7908">a location to place the contents of the file @@ -50032,8 +50872,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. optional="1" allow-none="1"> a location to place the length of the contents of the file, + filename="gio/gfile.c" + line="7909">a location to place the length of the contents of the file, or %NULL if the length is not needed @@ -50045,18 +50885,20 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. optional="1" allow-none="1"> a location to place the current entity tag for the file, + filename="gio/gfile.c" + line="7911">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed + c:identifier="g_file_load_contents_async" + glib:finish-func="load_contents_finish" + glib:sync-func="load_contents"> Starts an asynchronous load of the @file's contents. + filename="gio/gfile.c" + line="8257">Starts an asynchronous load of the @file's contents. For more details, see g_file_load_contents() which is the synchronous version of this call. @@ -50069,16 +50911,15 @@ the @callback. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + input #GFile + filename="gio/gfile.c" + line="8259">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="8260">optional #GCancellable object, %NULL to ignore scope="async" closure="2"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfile.c" + line="8261">a #GAsyncReadyCallback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="8262">the data to pass to callback function @@ -50116,32 +50957,31 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_load_contents_finish" throws="1"> Finishes an asynchronous load of the @file's contents. + filename="gio/gfile.c" + line="8290">Finishes an asynchronous load of the @file's contents. The contents are placed in @contents, and @length is set to the size of the @contents string. The @contents should be freed with g_free() when no longer needed. If @etag_out is present, it will be set to the new entity tag for the @file. - + %TRUE if the load was successful. If %FALSE and @error is + filename="gio/gfile.c" + line="8307">%TRUE if the load was successful. If %FALSE and @error is present, it will be set appropriately. input #GFile + filename="gio/gfile.c" + line="8292">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="8293">a #GAsyncResult caller-allocates="0" transfer-ownership="full"> a location to place the contents of the file + filename="gio/gfile.c" + line="8294">a location to place the contents of the file @@ -50162,8 +51002,8 @@ set to the new entity tag for the @file. optional="1" allow-none="1"> a location to place the length of the contents of the file, + filename="gio/gfile.c" + line="8295">a location to place the length of the contents of the file, or %NULL if the length is not needed @@ -50175,8 +51015,8 @@ set to the new entity tag for the @file. optional="1" allow-none="1"> a location to place the current entity tag for the file, + filename="gio/gfile.c" + line="8297">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed @@ -50184,10 +51024,11 @@ set to the new entity tag for the @file. + introspectable="0" + glib:finish-func="load_partial_contents_finish"> Reads the partial contents of a file. A #GFileReadMoreCallback should + filename="gio/gfile.c" + line="8143">Reads the partial contents of a file. A #GFileReadMoreCallback should be used to stop reading from the file when appropriate, else this function will behave exactly as g_file_load_contents_async(). This operation can be finished by g_file_load_partial_contents_finish(). @@ -50198,16 +51039,15 @@ both the @read_more_callback and the @callback. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + input #GFile + filename="gio/gfile.c" + line="8145">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="8146">optional #GCancellable object, %NULL to ignore scope="call" closure="3"> a + filename="gio/gfile.c" + line="8147">a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read @@ -50237,8 +51077,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. scope="async" closure="3"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="8150">a #GAsyncReadyCallback to call when the request is satisfied @@ -50247,8 +51087,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. nullable="1" allow-none="1"> the data to pass to the callback functions + filename="gio/gfile.c" + line="8152">the data to pass to the callback functions @@ -50257,32 +51097,31 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_load_partial_contents_finish" throws="1"> Finishes an asynchronous partial load operation that was started + filename="gio/gfile.c" + line="8192">Finishes an asynchronous partial load operation that was started with g_file_load_partial_contents_async(). The data is always zero-terminated, but this is not included in the resultant @length. The returned @contents should be freed with g_free() when no longer needed. - + %TRUE if the load was successful. If %FALSE and @error is + filename="gio/gfile.c" + line="8209">%TRUE if the load was successful. If %FALSE and @error is present, it will be set appropriately. input #GFile + filename="gio/gfile.c" + line="8194">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="8195">a #GAsyncResult caller-allocates="0" transfer-ownership="full"> a location to place the contents of the file + filename="gio/gfile.c" + line="8196">a location to place the contents of the file @@ -50303,8 +51142,8 @@ needed. optional="1" allow-none="1"> a location to place the length of the contents of the file, + filename="gio/gfile.c" + line="8197">a location to place the length of the contents of the file, or %NULL if the length is not needed @@ -50316,8 +51155,8 @@ needed. optional="1" allow-none="1"> a location to place the current entity tag for the file, + filename="gio/gfile.c" + line="8199">a location to place the current entity tag for the file, or %NULL if the entity tag is not needed @@ -50325,10 +51164,11 @@ needed. + throws="1" + glib:async-func="make_directory_async"> Creates a directory. Note that this will only create a child directory + filename="gio/gfile.c" + line="4066">Creates a directory. Note that this will only create a child directory of the immediate parent directory of the path or URI given by the #GFile. To recursively create directories, see g_file_make_directory_with_parents(). This function will fail if the parent directory does not exist, setting @@ -50342,19 +51182,18 @@ For a local #GFile the newly created directory will have the default If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE on successful creation, %FALSE otherwise. + filename="gio/gfile.c" + line="4088">%TRUE on successful creation, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4068">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4069">optional #GCancellable object, %NULL to ignore @@ -50371,26 +51210,27 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + version="2.38" + glib:finish-func="make_directory_finish" + glib:sync-func="make_directory"> Asynchronously creates a directory. - + filename="gio/gfile.c" + line="4115">Asynchronously creates a directory. + input #GFile + filename="gio/gfile.c" + line="4117">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4118">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4119">optional #GCancellable object, %NULL to ignore @@ -50410,8 +51250,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. scope="async" closure="3"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4121">a #GAsyncReadyCallback to call when the request is satisfied @@ -50420,8 +51260,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="4123">the data to pass to callback function @@ -50431,28 +51271,27 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.38" throws="1"> Finishes an asynchronous directory creation, started with + filename="gio/gfile.c" + line="4148">Finishes an asynchronous directory creation, started with g_file_make_directory_async(). - + %TRUE on successful directory creation, %FALSE otherwise. + filename="gio/gfile.c" + line="4157">%TRUE on successful directory creation, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4150">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4151">a #GAsyncResult @@ -50462,8 +51301,8 @@ g_file_make_directory_async(). version="2.18" throws="1"> Creates a directory and any parent directories that may not + filename="gio/gfile.c" + line="4174">Creates a directory and any parent directories that may not exist similar to 'mkdir -p'. If the file system does not support creating directories, this function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists, @@ -50476,20 +51315,19 @@ For a local #GFile the newly created directories will have the default If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if all directories have been successfully created, %FALSE + filename="gio/gfile.c" + line="4195">%TRUE if all directories have been successfully created, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4176">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4177">optional #GCancellable object, %NULL to ignore @@ -50506,34 +51344,34 @@ otherwise. + throws="1" + glib:async-func="make_symbolic_link_async"> Creates a symbolic link named @file which contains the string + filename="gio/gfile.c" + line="4296">Creates a symbolic link named @file which contains the string @symlink_value. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE on the creation of a new symlink, %FALSE otherwise. + filename="gio/gfile.c" + line="4312">%TRUE on the creation of a new symlink, %FALSE otherwise. a #GFile with the name of the symlink to create + filename="gio/gfile.c" + line="4298">a #GFile with the name of the symlink to create a string with the path for the target + filename="gio/gfile.c" + line="4299">a string with the path for the target of the new symlink @@ -50542,8 +51380,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4301">optional #GCancellable object, %NULL to ignore @@ -50551,34 +51389,35 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + version="2.74" + glib:finish-func="make_symbolic_link_finish" + glib:sync-func="make_symbolic_link"> Asynchronously creates a symbolic link named @file which contains the + filename="gio/gfile.c" + line="4387">Asynchronously creates a symbolic link named @file which contains the string @symlink_value. - + a #GFile with the name of the symlink to create + filename="gio/gfile.c" + line="4389">a #GFile with the name of the symlink to create a string with the path for the target + filename="gio/gfile.c" + line="4390">a string with the path for the target of the new symlink the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4392">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4393">optional #GCancellable object, %NULL to ignore @@ -50598,8 +51437,8 @@ string @symlink_value. scope="async" closure="4"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4395">a #GAsyncReadyCallback to call when the request is satisfied @@ -50608,8 +51447,8 @@ string @symlink_value. nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="4397">the data to pass to callback function @@ -50619,28 +51458,27 @@ string @symlink_value. version="2.74" throws="1"> Finishes an asynchronous symbolic link creation, started with + filename="gio/gfile.c" + line="4437">Finishes an asynchronous symbolic link creation, started with g_file_make_symbolic_link_async(). - + %TRUE on successful directory creation, %FALSE otherwise. + filename="gio/gfile.c" + line="4446">%TRUE on successful directory creation, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4439">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4440">a #GAsyncResult @@ -50648,11 +51486,11 @@ g_file_make_symbolic_link_async(). + throws="1" + glib:async-func="measure_disk_usage_async"> Recursively measures the disk usage of @file. + filename="gio/gfile.c" + line="8837">Recursively measures the disk usage of @file. This is essentially an analog of the 'du' command, but it also reports the number of directories and non-directory files encountered @@ -50670,26 +51508,25 @@ in a user interface. periodic progress updates while scanning. See the documentation for #GFileMeasureProgressCallback for information about when and how the callback will be invoked. - + %TRUE if successful, with the out parameters set. + filename="gio/gfile.c" + line="8868">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. a #GFile + filename="gio/gfile.c" + line="8839">a #GFile #GFileMeasureFlags + filename="gio/gfile.c" + line="8840">#GFileMeasureFlags nullable="1" allow-none="1"> optional #GCancellable + filename="gio/gfile.c" + line="8841">optional #GCancellable a #GFileMeasureProgressCallback + filename="gio/gfile.c" + line="8842">a #GFileMeasureProgressCallback @@ -50717,8 +51555,8 @@ callback will be invoked. nullable="1" allow-none="1"> user_data for @progress_callback + filename="gio/gfile.c" + line="8843">user_data for @progress_callback optional="1" allow-none="1"> the number of bytes of disk space used + filename="gio/gfile.c" + line="8844">the number of bytes of disk space used optional="1" allow-none="1"> the number of directories encountered + filename="gio/gfile.c" + line="8845">the number of directories encountered optional="1" allow-none="1"> the number of non-directories encountered + filename="gio/gfile.c" + line="8846">the number of non-directories encountered @@ -50759,35 +51597,36 @@ callback will be invoked. + introspectable="0" + glib:finish-func="measure_disk_usage_finish" + glib:sync-func="measure_disk_usage"> Recursively measures the disk usage of @file. + filename="gio/gfile.c" + line="8894">Recursively measures the disk usage of @file. This is the asynchronous version of g_file_measure_disk_usage(). See there for more information. - + a #GFile + filename="gio/gfile.c" + line="8896">a #GFile #GFileMeasureFlags + filename="gio/gfile.c" + line="8897">#GFileMeasureFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="8898">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable + filename="gio/gfile.c" + line="8899">optional #GCancellable allow-none="1" closure="4"> a #GFileMeasureProgressCallback + filename="gio/gfile.c" + line="8900">a #GFileMeasureProgressCallback @@ -50815,8 +51654,8 @@ there for more information. nullable="1" allow-none="1"> user_data for @progress_callback + filename="gio/gfile.c" + line="8901">user_data for @progress_callback scope="async" closure="6"> a #GAsyncReadyCallback to call when complete + filename="gio/gfile.c" + line="8902">a #GAsyncReadyCallback to call when complete nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="8903">the data to pass to callback function @@ -50846,30 +51685,29 @@ there for more information. version="2.38" throws="1"> Collects the results from an earlier call to + filename="gio/gfile.c" + line="8930">Collects the results from an earlier call to g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for more information. - + %TRUE if successful, with the out parameters set. + filename="gio/gfile.c" + line="8943">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. a #GFile + filename="gio/gfile.c" + line="8932">a #GFile the #GAsyncResult passed to your #GAsyncReadyCallback + filename="gio/gfile.c" + line="8933">the #GAsyncResult passed to your #GAsyncReadyCallback optional="1" allow-none="1"> the number of bytes of disk space used + filename="gio/gfile.c" + line="8934">the number of bytes of disk space used optional="1" allow-none="1"> the number of directories encountered + filename="gio/gfile.c" + line="8935">the number of directories encountered optional="1" allow-none="1"> the number of non-directories encountered + filename="gio/gfile.c" + line="8936">the number of non-directories encountered @@ -50912,19 +51750,18 @@ more information. version="2.18" throws="1"> Obtains a file or directory monitor for the given file, + filename="gio/gfile.c" + line="5912">Obtains a file or directory monitor for the given file, depending on the type of the file. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GFileMonitor for the given @file, + filename="gio/gfile.c" + line="5927">a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -50932,14 +51769,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + filename="gio/gfile.c" + line="5914">input #GFile a set of #GFileMonitorFlags + filename="gio/gfile.c" + line="5915">a set of #GFileMonitorFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5916">optional #GCancellable object, %NULL to ignore @@ -50958,8 +51795,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_monitor_directory" throws="1"> Obtains a directory monitor for the given file. + filename="gio/gfile.c" + line="5806">Obtains a directory monitor for the given file. This may fail if directory monitoring is not supported. If @cancellable is not %NULL, then the operation can be cancelled by @@ -50971,27 +51808,25 @@ It does not make sense for @flags to contain directories. It is not possible to monitor all the files in a directory for changes made via hard links; if you want to do this then you must register individual watches with g_file_monitor(). - + a #GFileMonitor for the given @file, - or %NULL on error. - Free the returned object with g_object_unref(). + filename="gio/gfile.c" + line="5827">a #GFileMonitor for the given @file, + or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="5808">input #GFile a set of #GFileMonitorFlags + filename="gio/gfile.c" + line="5809">a set of #GFileMonitorFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5810">optional #GCancellable object, %NULL to ignore @@ -51010,8 +51845,8 @@ you must register individual watches with g_file_monitor(). c:identifier="g_file_monitor_file" throws="1"> Obtains a file monitor for the given file. If no file notification + filename="gio/gfile.c" + line="5857">Obtains a file monitor for the given file. If no file notification mechanism exists, then regular polling of the file is used. If @cancellable is not %NULL, then the operation can be cancelled by @@ -51025,12 +51860,11 @@ changes made through the filename contained in @file to be reported. Using this flag may result in an increase in resource usage, and may not have any effect depending on the #GFileMonitor backend and/or filesystem type. - + a #GFileMonitor for the given @file, + filename="gio/gfile.c" + line="5880">a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -51038,14 +51872,14 @@ backend and/or filesystem type. input #GFile + filename="gio/gfile.c" + line="5859">input #GFile a set of #GFileMonitorFlags + filename="gio/gfile.c" + line="5860">a set of #GFileMonitorFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5861">optional #GCancellable object, %NULL to ignore + c:identifier="g_file_mount_enclosing_volume" + glib:finish-func="mount_enclosing_volume_finish"> Starts a @mount_operation, mounting the volume that contains + filename="gio/gfile.c" + line="7561">Starts a @mount_operation, mounting the volume that contains the file @location. When this operation has completed, @callback will be called with @@ -51074,22 +51909,21 @@ g_file_mount_enclosing_volume_finish(). If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + input #GFile + filename="gio/gfile.c" + line="7563">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="7564">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation + filename="gio/gfile.c" + line="7565">a #GMountOperation or %NULL to avoid user interaction @@ -51107,8 +51941,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="7567">optional #GCancellable object, %NULL to ignore @@ -51119,8 +51953,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. scope="async" closure="4"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="7569">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -51129,8 +51963,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="7571">the data to pass to callback function @@ -51139,14 +51973,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_mount_enclosing_volume_finish" throws="1"> Finishes a mount operation started by g_file_mount_enclosing_volume(). - + filename="gio/gfile.c" + line="7611">Finishes a mount operation started by g_file_mount_enclosing_volume(). + %TRUE if successful. If an error has occurred, + filename="gio/gfile.c" + line="7619">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -51154,22 +51987,24 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + filename="gio/gfile.c" + line="7613">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="7614">a #GAsyncResult - + Mounts a file of type G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="5349">Mounts a file of type G_FILE_TYPE_MOUNTABLE. Using @mount_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -51180,22 +52015,21 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="5351">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5352">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="5353">a #GMountOperation, or %NULL to avoid user interaction @@ -51213,8 +52047,8 @@ the result of the operation. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5355">optional #GCancellable object, %NULL to ignore @@ -51225,9 +52059,9 @@ the result of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5357">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="5359">the data to pass to callback function @@ -51245,39 +52079,41 @@ the result of the operation. c:identifier="g_file_mount_mountable_finish" throws="1"> Finishes a mount operation. See g_file_mount_mountable() for details. + filename="gio/gfile.c" + line="5404">Finishes a mount operation. See g_file_mount_mountable() for details. Finish an asynchronous mount operation that was started with g_file_mount_mountable(). - + a #GFile or %NULL on error. + filename="gio/gfile.c" + line="5415">a #GFile or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="5406">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5407">a #GAsyncResult - + Tries to move the file or directory @source to the location specified + filename="gio/gfile.c" + line="3848">Tries to move the file or directory @source to the location specified by @destination. If native move operations are supported then this is used, otherwise a copy + delete fallback is used. The native implementation may support moving directories (for instance on moves @@ -51310,31 +52146,30 @@ If the source is a directory and the target does not exist, or %G_FILE_COPY_OVERWRITE is specified and the target is a file, then the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native move operation isn't available). - + %TRUE on successful move, %FALSE otherwise. + filename="gio/gfile.c" + line="3895">%TRUE on successful move, %FALSE otherwise. #GFile pointing to the source location + filename="gio/gfile.c" + line="3850">#GFile pointing to the source location #GFile pointing to the destination location + filename="gio/gfile.c" + line="3851">#GFile pointing to the destination location set of #GFileCopyFlags + filename="gio/gfile.c" + line="3852">set of #GFileCopyFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3853">optional #GCancellable object, %NULL to ignore @@ -51354,8 +52189,8 @@ move operation isn't available). scope="call" closure="4"> #GFileProgressCallback + filename="gio/gfile.c" + line="3855">#GFileProgressCallback function for updates @@ -51364,8 +52199,8 @@ move operation isn't available). nullable="1" allow-none="1"> gpointer to user data for + filename="gio/gfile.c" + line="3857">gpointer to user data for the callback function @@ -51373,10 +52208,12 @@ move operation isn't available). + version="2.72" + glib:finish-func="move_finish" + glib:sync-func="move"> Asynchronously moves a file @source to the location of @destination. For details of the behaviour, see g_file_move(). + filename="gio/gfile.c" + line="3982">Asynchronously moves a file @source to the location of @destination. For details of the behaviour, see g_file_move(). If @progress_callback is not %NULL, then that function that will be called just like in g_file_move(). The callback will run in the default main context @@ -51385,34 +52222,33 @@ run in. When the operation is finished, @callback will be called. You can then call g_file_move_finish() to get the result of the operation. - + #GFile pointing to the source location + filename="gio/gfile.c" + line="3984">#GFile pointing to the source location #GFile pointing to the destination location + filename="gio/gfile.c" + line="3985">#GFile pointing to the destination location set of #GFileCopyFlags + filename="gio/gfile.c" + line="3986">set of #GFileCopyFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="3987">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3988">optional #GCancellable object, %NULL to ignore @@ -51432,9 +52268,9 @@ g_file_move_finish() to get the result of the operation. scope="call" closure="5"> #GFileProgressCallback - function for updates + filename="gio/gfile.c" + line="3990"> + #GFileProgressCallback function for updates nullable="1" allow-none="1"> gpointer to user data for - the callback function + filename="gio/gfile.c" + line="3992">gpointer to user data for the callback function scope="async" closure="7"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="3993">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="3995">the data to pass to callback function @@ -51475,28 +52310,27 @@ g_file_move_finish() to get the result of the operation. version="2.72" throws="1"> Finishes an asynchronous file movement, started with + filename="gio/gfile.c" + line="4038">Finishes an asynchronous file movement, started with g_file_move_async(). - + %TRUE on successful file move, %FALSE otherwise. + filename="gio/gfile.c" + line="4047">%TRUE on successful file move, %FALSE otherwise. input source #GFile + filename="gio/gfile.c" + line="4040">input source #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4041">a #GAsyncResult @@ -51504,10 +52338,11 @@ g_file_move_async(). + throws="1" + glib:async-func="open_readwrite_async"> Opens an existing file for reading and writing. The result is + filename="gio/gfile.c" + line="1926">Opens an existing file for reading and writing. The result is a #GFileIOStream that can be used to read and write the contents of the file. @@ -51523,20 +52358,19 @@ what kind of filesystem the file is on. Note that in many non-local file cases read and write streams are not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing. - + #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="1949">#GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). #GFile to open + filename="gio/gfile.c" + line="1928">#GFile to open nullable="1" allow-none="1"> a #GCancellable + filename="gio/gfile.c" + line="1929">a #GCancellable + version="2.22" + glib:finish-func="open_readwrite_finish" + glib:sync-func="open_readwrite"> Asynchronously opens @file for reading and writing. + filename="gio/gfile.c" + line="2385">Asynchronously opens @file for reading and writing. For more details, see g_file_open_readwrite() which is the synchronous version of this call. @@ -51563,22 +52399,21 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_open_readwrite_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2387">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2388">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2389">optional #GCancellable object, %NULL to ignore @@ -51598,9 +52433,9 @@ the result of the operation. scope="async" closure="3"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2391">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="2393">the data to pass to callback function @@ -51619,67 +52454,66 @@ the result of the operation. version="2.22" throws="1"> Finishes an asynchronous file read operation started with + filename="gio/gfile.c" + line="2425">Finishes an asynchronous file read operation started with g_file_open_readwrite_async(). - + a #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="2434">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2427">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2428">a #GAsyncResult Exactly like g_file_get_path(), but caches the result via + filename="gio/gfile.c" + line="640">Exactly like g_file_get_path(), but caches the result via g_object_set_qdata_full(). This is useful for example in C applications which mix `g_file_*` APIs with native ones. It also avoids an extra duplicated string when possible, so will be generally more efficient. This call does no blocking I/O. - + string containing the #GFile's path, + filename="gio/gfile.c" + line="652">string containing the #GFile's path, or %NULL if no such path exists. The returned string is owned by @file. input #GFile + filename="gio/gfile.c" + line="642">input #GFile + version="2.22" + glib:finish-func="poll_mountable_finish"> Polls a file of type %G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="9141">Polls a file of type %G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -51688,16 +52522,15 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="9143">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="9144">optional #GCancellable object, %NULL to ignore scope="async" closure="2"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="9145">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -51726,8 +52559,8 @@ the result of the operation. nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="9147">the data to pass to callback function @@ -51737,52 +52570,51 @@ the result of the operation. version="2.22" throws="1"> Finishes a poll operation. See g_file_poll_mountable() for details. + filename="gio/gfile.c" + line="9188">Finishes a poll operation. See g_file_poll_mountable() for details. Finish an asynchronous poll operation that was polled with g_file_poll_mountable(). - + %TRUE if the operation finished successfully. %FALSE + filename="gio/gfile.c" + line="9199">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="9190">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="9191">a #GAsyncResult + throws="1" + glib:async-func="query_default_handler_async"> Returns the #GAppInfo that is registered as the default + filename="gio/gfile.c" + line="7647">Returns the #GAppInfo that is registered as the default application to handle the file specified by @file. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GAppInfo if the handle was found, + filename="gio/gfile.c" + line="7660">a #GAppInfo if the handle was found, %NULL if there were errors. When you are done with it, release it with g_object_unref() @@ -51790,8 +52622,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GFile to open + filename="gio/gfile.c" + line="7649">a #GFile to open nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="7650">optional #GCancellable object, %NULL to ignore + version="2.60" + glib:finish-func="query_default_handler_finish" + glib:sync-func="query_default_handler"> Async version of g_file_query_default_handler(). - + filename="gio/gfile.c" + line="7829">Async version of g_file_query_default_handler(). + a #GFile to open + filename="gio/gfile.c" + line="7831">a #GFile to open the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="7832">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="7833">optional #GCancellable object, %NULL to ignore scope="async" closure="3"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gfile.c" + line="7834">a #GAsyncReadyCallback to call when the request is done nullable="1" allow-none="1"> data to pass to @callback + filename="gio/gfile.c" + line="7835">data to pass to @callback @@ -51865,14 +52698,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.60" throws="1"> Finishes a g_file_query_default_handler_async() operation. - + filename="gio/gfile.c" + line="7877">Finishes a g_file_query_default_handler_async() operation. + a #GAppInfo if the handle was found, + filename="gio/gfile.c" + line="7885">a #GAppInfo if the handle was found, %NULL if there were errors. When you are done with it, release it with g_object_unref() @@ -51880,22 +52712,22 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GFile to open + filename="gio/gfile.c" + line="7879">a #GFile to open a #GAsyncResult + filename="gio/gfile.c" + line="7880">a #GAsyncResult Utility function to check if a particular file exists. This is + filename="gio/gfile.c" + line="1189">Utility function to check if a particular file exists. This is implemented using g_file_query_info() and as such does blocking I/O. Note that in many cases it is [racy to first check for file existence](https://en.wikipedia.org/wiki/Time_of_check_to_time_of_use) @@ -51917,20 +52749,19 @@ for instance to make a menu item sensitive/insensitive, so that you don't have to fool users that something is possible and then just show an error dialog. If you do this, you should make sure to also handle the errors that can happen due to races when you execute the operation. - + %TRUE if the file exists (and can be detected without error), + filename="gio/gfile.c" + line="1218">%TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled). input #GFile + filename="gio/gfile.c" + line="1191">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1192">optional #GCancellable object, %NULL to ignore @@ -51949,32 +52780,31 @@ that can happen due to races when you execute the operation. c:identifier="g_file_query_file_type" version="2.18"> Utility function to inspect the #GFileType of a file. This is + filename="gio/gfile.c" + line="1240">Utility function to inspect the #GFileType of a file. This is implemented using g_file_query_info() and as such does blocking I/O. The primary use case of this method is to check if a file is a regular file, directory, or symlink. - + The #GFileType of the file and %G_FILE_TYPE_UNKNOWN + filename="gio/gfile.c" + line="1253">The #GFileType of the file and %G_FILE_TYPE_UNKNOWN if the file does not exist input #GFile + filename="gio/gfile.c" + line="1242">input #GFile a set of #GFileQueryInfoFlags passed to g_file_query_info() + filename="gio/gfile.c" + line="1243">a set of #GFileQueryInfoFlags passed to g_file_query_info() nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1244">optional #GCancellable object, %NULL to ignore @@ -51991,10 +52821,11 @@ a regular file, directory, or symlink. + throws="1" + glib:async-func="query_filesystem_info_async"> Similar to g_file_query_info(), but obtains information + filename="gio/gfile.c" + line="1425">Similar to g_file_query_info(), but obtains information about the filesystem the @file is on, rather than the file itself. For instance the amount of space available and the type of the filesystem. @@ -52019,26 +52850,25 @@ returned. If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + a #GFileInfo or %NULL if there was an error. + filename="gio/gfile.c" + line="1459">a #GFileInfo or %NULL if there was an error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1427">input #GFile an attribute query string + filename="gio/gfile.c" + line="1428">an attribute query string nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1429">optional #GCancellable object, %NULL to ignore + c:identifier="g_file_query_filesystem_info_async" + glib:finish-func="query_filesystem_info_finish" + glib:sync-func="query_filesystem_info"> Asynchronously gets the requested information about the filesystem + filename="gio/gfile.c" + line="1488">Asynchronously gets the requested information about the filesystem that the specified @file is on. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -52068,28 +52900,27 @@ synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_query_info_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="1490">input #GFile an attribute query string + filename="gio/gfile.c" + line="1491">an attribute query string the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1492">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1493">optional #GCancellable object, %NULL to ignore @@ -52109,9 +52940,9 @@ operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="1495">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="1497">the data to pass to callback function @@ -52129,15 +52960,14 @@ operation. c:identifier="g_file_query_filesystem_info_finish" throws="1"> Finishes an asynchronous filesystem info query. + filename="gio/gfile.c" + line="1532">Finishes an asynchronous filesystem info query. See g_file_query_filesystem_info_async(). - + #GFileInfo for given @file + filename="gio/gfile.c" + line="1541">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -52145,22 +52975,25 @@ See g_file_query_filesystem_info_async(). input #GFile + filename="gio/gfile.c" + line="1534">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1535">a #GAsyncResult - + Gets the requested information about specified @file. + filename="gio/gfile.c" + line="1280">Gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as the type or size of the file). @@ -52190,32 +53023,31 @@ about the symlink itself will be returned. If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + a #GFileInfo for the given @file, or %NULL + filename="gio/gfile.c" + line="1320">a #GFileInfo for the given @file, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1282">input #GFile an attribute query string + filename="gio/gfile.c" + line="1283">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1284">a set of #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1285">optional #GCancellable object, %NULL to ignore - + Asynchronously gets the requested information about specified @file. + filename="gio/gfile.c" + line="1350">Asynchronously gets the requested information about specified @file. The result is a #GFileInfo object that contains key-value attributes (such as type or size for the file). @@ -52242,34 +53077,33 @@ version of this call. When the operation is finished, @callback will be called. You can then call g_file_query_info_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="1352">input #GFile an attribute query string + filename="gio/gfile.c" + line="1353">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1354">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1355">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1356">optional #GCancellable object, %NULL to ignore @@ -52289,9 +53123,9 @@ then call g_file_query_info_finish() to get the result of the operation. scope="async" closure="5"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gfile.c" + line="1358">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="1360">the data to pass to callback function @@ -52309,15 +53143,14 @@ then call g_file_query_info_finish() to get the result of the operation. c:identifier="g_file_query_info_finish" throws="1"> Finishes an asynchronous file info query. + filename="gio/gfile.c" + line="1395">Finishes an asynchronous file info query. See g_file_query_info_async(). - + #GFileInfo for given @file + filename="gio/gfile.c" + line="1404">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -52325,14 +53158,14 @@ See g_file_query_info_async(). input #GFile + filename="gio/gfile.c" + line="1397">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1398">a #GAsyncResult @@ -52341,8 +53174,8 @@ See g_file_query_info_async(). c:identifier="g_file_query_settable_attributes" throws="1"> Obtain the list of settable attributes for the file. + filename="gio/gfile.c" + line="4816">Obtain the list of settable attributes for the file. Returns the type and full attribute name of all the attributes that can be set on this file. This doesn't mean setting it will @@ -52352,12 +53185,11 @@ specific file may not support a specific attribute. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GFileAttributeInfoList describing the settable attributes. + filename="gio/gfile.c" + line="4834">a #GFileAttributeInfoList describing the settable attributes. When you are done with it, release it with g_file_attribute_info_list_unref() @@ -52365,8 +53197,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + filename="gio/gfile.c" + line="4818">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4819">optional #GCancellable object, %NULL to ignore @@ -52385,20 +53217,19 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_query_writable_namespaces" throws="1"> Obtain the list of attribute namespaces where new attributes + filename="gio/gfile.c" + line="4874">Obtain the list of attribute namespaces where new attributes can be created by a user. An example of this is extended attributes (in the "xattr" namespace). If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GFileAttributeInfoList describing the writable namespaces. + filename="gio/gfile.c" + line="4889">a #GFileAttributeInfoList describing the writable namespaces. When you are done with it, release it with g_file_attribute_info_list_unref() @@ -52406,8 +53237,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + filename="gio/gfile.c" + line="4876">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4877">optional #GCancellable object, %NULL to ignore - + Opens a file for reading. The result is a #GFileInputStream that + filename="gio/gfile.c" + line="1679">Opens a file for reading. The result is a #GFileInputStream that can be used to read the contents of the file. If @cancellable is not %NULL, then the operation can be cancelled by @@ -52436,20 +53270,19 @@ If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + #GFileInputStream or %NULL on error. + filename="gio/gfile.c" + line="1697">#GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). #GFile to read + filename="gio/gfile.c" + line="1681">#GFile to read nullable="1" allow-none="1"> a #GCancellable + filename="gio/gfile.c" + line="1682">a #GCancellable - + Asynchronously opens @file for reading. + filename="gio/gfile.c" + line="2098">Asynchronously opens @file for reading. For more details, see g_file_read() which is the synchronous version of this call. @@ -52474,22 +53310,21 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_read_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2100">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2101">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2102">optional #GCancellable object, %NULL to ignore @@ -52509,9 +53344,9 @@ of the operation. scope="async" closure="3"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2104">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="2106">the data to pass to callback function Finishes an asynchronous file read operation started with + filename="gio/gfile.c" + line="2136">Finishes an asynchronous file read operation started with g_file_read_async(). - + a #GFileInputStream or %NULL on error. + filename="gio/gfile.c" + line="2145">a #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2138">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2139">a #GAsyncResult - + Returns an output stream for overwriting the file, possibly + filename="gio/gfile.c" + line="1838">Returns an output stream for overwriting the file, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -52598,20 +53435,19 @@ file systems don't allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on. - + a #GFileOutputStream or %NULL on error. + filename="gio/gfile.c" + line="1891">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1840">input #GFile nullable="1" allow-none="1"> an optional [entity tag][gfile-etag] + filename="gio/gfile.c" + line="1841">an optional [entity tag](#entity-tags) for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="1843">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1844">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1845">optional #GCancellable object, %NULL to ignore - + Asynchronously overwrites the file, replacing the contents, + filename="gio/gfile.c" + line="2307">Asynchronously overwrites the file, replacing the contents, possibly creating a backup copy of the file first. For more details, see g_file_replace() which is @@ -52660,16 +53499,15 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_replace_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2309">input #GFile nullable="1" allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + filename="gio/gfile.c" + line="2310">an [entity tag](#entity-tags) for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="2312">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2313">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2314">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2315">optional #GCancellable object, %NULL to ignore @@ -52717,9 +53555,9 @@ of the operation. scope="async" closure="6"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2317">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="2319">the data to pass to callback function + throws="1" + glib:async-func="replace_contents_async"> Replaces the contents of @file with @contents of @length bytes. + filename="gio/gfile.c" + line="8326">Replaces the contents of @file with @contents of @length bytes. If @etag is specified (not %NULL), any existing file must have that etag, or the error %G_IO_ERROR_WRONG_ETAG will be returned. @@ -52754,34 +53593,33 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. The returned @new_etag can be used to verify that the file hasn't changed the next time it is saved over. - + %TRUE if successful. If an error has occurred, this function + filename="gio/gfile.c" + line="8358">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. input #GFile + filename="gio/gfile.c" + line="8328">input #GFile a string containing the new contents for @file + filename="gio/gfile.c" + line="8329">a string containing the new contents for @file the length of @contents in bytes + filename="gio/gfile.c" + line="8330">the length of @contents in bytes nullable="1" allow-none="1"> the old [entity-tag][gfile-etag] for the document, + filename="gio/gfile.c" + line="8331">the old [entity-tag](#entity-tags) for the document, or %NULL %TRUE if a backup should be created + filename="gio/gfile.c" + line="8333">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="8334">a set of #GFileCreateFlags optional="1" allow-none="1"> a location to a new [entity tag][gfile-etag] + filename="gio/gfile.c" + line="8335">a location to a new [entity tag](#entity-tags) for the document. This should be freed with g_free() when no longer needed, or %NULL @@ -52825,17 +53663,19 @@ changed the next time it is saved over. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="8338">optional #GCancellable object, %NULL to ignore + c:identifier="g_file_replace_contents_async" + glib:finish-func="replace_contents_finish" + glib:sync-func="replace_contents"> Starts an asynchronous replacement of @file with the given + filename="gio/gfile.c" + line="8533">Starts an asynchronous replacement of @file with the given @contents of @length bytes. @etag will replace the document's current entity tag. @@ -52854,30 +53694,29 @@ Note that no copy of @contents will be made, so it must stay valid until @callback is called. See g_file_replace_contents_bytes_async() for a #GBytes version that will automatically hold a reference to the contents (without copying) for the duration of the call. - + input #GFile + filename="gio/gfile.c" + line="8535">input #GFile string of contents to replace the file with + filename="gio/gfile.c" + line="8536">string of contents to replace the file with the length of @contents in bytes + filename="gio/gfile.c" + line="8537">the length of @contents in bytes nullable="1" allow-none="1"> a new [entity tag][gfile-etag] for the @file, or %NULL + filename="gio/gfile.c" + line="8538">a new [entity tag](#entity-tags) for the @file, or %NULL %TRUE if a backup should be created + filename="gio/gfile.c" + line="8539">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="8540">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="8541">optional #GCancellable object, %NULL to ignore scope="async" closure="7"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfile.c" + line="8542">a #GAsyncReadyCallback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="8543">the data to pass to callback function @@ -52936,8 +53775,8 @@ contents (without copying) for the duration of the call. c:identifier="g_file_replace_contents_bytes_async" version="2.40"> Same as g_file_replace_contents_async() but takes a #GBytes input instead. + filename="gio/gfile.c" + line="8584">Same as g_file_replace_contents_async() but takes a #GBytes input instead. This function will keep a ref on @contents until the operation is done. Unlike g_file_replace_contents_async() this allows forgetting about the content without waiting for the callback. @@ -52945,22 +53784,21 @@ content without waiting for the callback. When this operation has completed, @callback will be called with @user_user data, and the operation can be finalized with g_file_replace_contents_finish(). - + input #GFile + filename="gio/gfile.c" + line="8586">input #GFile a #GBytes + filename="gio/gfile.c" + line="8587">a #GBytes nullable="1" allow-none="1"> a new [entity tag][gfile-etag] for the @file, or %NULL + filename="gio/gfile.c" + line="8588">a new [entity tag](#entity-tags) for the @file, or %NULL %TRUE if a backup should be created + filename="gio/gfile.c" + line="8589">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="8590">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="8591">optional #GCancellable object, %NULL to ignore scope="async" closure="6"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfile.c" + line="8592">a #GAsyncReadyCallback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="8593">the data to pass to callback function @@ -53019,29 +53857,28 @@ g_file_replace_contents_finish(). c:identifier="g_file_replace_contents_finish" throws="1"> Finishes an asynchronous replace of the given @file. See + filename="gio/gfile.c" + line="8639">Finishes an asynchronous replace of the given @file. See g_file_replace_contents_async(). Sets @new_etag to the new entity tag for the document, if present. - + %TRUE on success, %FALSE on failure. + filename="gio/gfile.c" + line="8652">%TRUE on success, %FALSE on failure. input #GFile + filename="gio/gfile.c" + line="8641">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="8642">a #GAsyncResult optional="1" allow-none="1"> a location of a new [entity tag][gfile-etag] + filename="gio/gfile.c" + line="8643">a location of a new [entity tag](#entity-tags) for the document. This should be freed with g_free() when it is no longer needed, or %NULL @@ -53064,29 +53901,28 @@ tag for the document, if present. c:identifier="g_file_replace_finish" throws="1"> Finishes an asynchronous file replace operation started with + filename="gio/gfile.c" + line="2356">Finishes an asynchronous file replace operation started with g_file_replace_async(). - + a #GFileOutputStream, or %NULL on error. + filename="gio/gfile.c" + line="2365">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2358">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2359">a #GAsyncResult @@ -53094,10 +53930,11 @@ g_file_replace_async(). + throws="1" + glib:async-func="replace_readwrite_async"> Returns an output stream for overwriting the file in readwrite mode, + filename="gio/gfile.c" + line="2043">Returns an output stream for overwriting the file in readwrite mode, possibly creating a backup copy of the file first. If the file doesn't exist, it will be created. @@ -53107,20 +53944,19 @@ same thing but returns an output stream only. Note that in many non-local file cases read and write streams are not supported, so make sure you really need to do read and write streaming, rather than just opening for reading or writing. - + a #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="2065">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). a #GFile + filename="gio/gfile.c" + line="2045">a #GFile nullable="1" allow-none="1"> an optional [entity tag][gfile-etag] + filename="gio/gfile.c" + line="2046">an optional [entity tag](#entity-tags) for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="2048">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2049">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2050">optional #GCancellable object, %NULL to ignore @@ -53159,10 +53995,12 @@ rather than just opening for reading or writing. + version="2.22" + glib:finish-func="replace_readwrite_finish" + glib:sync-func="replace_readwrite"> Asynchronously overwrites the file in read-write mode, + filename="gio/gfile.c" + line="2531">Asynchronously overwrites the file in read-write mode, replacing the contents, possibly creating a backup copy of the file first. @@ -53172,16 +54010,15 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_replace_readwrite_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="2533">input #GFile nullable="1" allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + filename="gio/gfile.c" + line="2534">an [entity tag](#entity-tags) for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="2536">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2537">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2538">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2539">optional #GCancellable object, %NULL to ignore @@ -53229,9 +54066,9 @@ the result of the operation. scope="async" closure="6"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2541">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="2543">the data to pass to callback function @@ -53250,29 +54087,28 @@ the result of the operation. version="2.22" throws="1"> Finishes an asynchronous file replace operation started with + filename="gio/gfile.c" + line="2583">Finishes an asynchronous file replace operation started with g_file_replace_readwrite_async(). - + a #GFileIOStream, or %NULL on error. + filename="gio/gfile.c" + line="2592">a #GFileIOStream, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2585">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2586">a #GAsyncResult @@ -53280,32 +54116,31 @@ g_file_replace_readwrite_async(). Resolves a relative path for @file to an absolute path. + filename="gio/gfile.c" + line="1019">Resolves a relative path for @file to an absolute path. This call does no blocking I/O. If the @relative_path is an absolute path name, the resolution is done absolutely (without taking @file path as base). - + a #GFile for the resolved path. + filename="gio/gfile.c" + line="1031">a #GFile for the resolved path. input #GFile + filename="gio/gfile.c" + line="1021">input #GFile a given relative path string + filename="gio/gfile.c" + line="1022">a given relative path string @@ -53314,8 +54149,8 @@ is done absolutely (without taking @file path as base). c:identifier="g_file_set_attribute" throws="1"> Sets an attribute in the file with attribute name @attribute to @value_p. + filename="gio/gfile.c" + line="4934">Sets an attribute in the file with attribute name @attribute to @value_p. Some attributes can be unset by setting @type to %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL. @@ -53323,31 +54158,30 @@ Some attributes can be unset by setting @type to If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the attribute was set, %FALSE otherwise. + filename="gio/gfile.c" + line="4955">%TRUE if the attribute was set, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4936">input #GFile a string containing the attribute's name + filename="gio/gfile.c" + line="4937">a string containing the attribute's name The type of the attribute + filename="gio/gfile.c" + line="4938">The type of the attribute nullable="1" allow-none="1"> a pointer to the value (or the pointer + filename="gio/gfile.c" + line="4939">a pointer to the value (or the pointer itself if the type is a pointer type) a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="4941">a set of #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4942">optional #GCancellable object, %NULL to ignore @@ -53382,46 +54216,45 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_set_attribute_byte_string" throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. + filename="gio/gfile.c" + line="5184">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. If @attribute is of a different type, this operation will fail, returning %FALSE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the @attribute was successfully set to @value + filename="gio/gfile.c" + line="5202">%TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5186">input #GFile a string containing the attribute's name + filename="gio/gfile.c" + line="5187">a string containing the attribute's name a string containing the attribute's new value + filename="gio/gfile.c" + line="5188">a string containing the attribute's new value a #GFileQueryInfoFlags + filename="gio/gfile.c" + line="5189">a #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5190">optional #GCancellable object, %NULL to ignore @@ -53440,45 +54273,44 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_set_attribute_int32" throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value. + filename="gio/gfile.c" + line="5251">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the @attribute was successfully set to @value + filename="gio/gfile.c" + line="5268">%TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5253">input #GFile a string containing the attribute's name + filename="gio/gfile.c" + line="5254">a string containing the attribute's name a #gint32 containing the attribute's new value + filename="gio/gfile.c" + line="5255">a #gint32 containing the attribute's new value a #GFileQueryInfoFlags + filename="gio/gfile.c" + line="5256">a #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5257">optional #GCancellable object, %NULL to ignore @@ -53497,44 +54329,43 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_set_attribute_int64" throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value. + filename="gio/gfile.c" + line="5317">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the @attribute was successfully set, %FALSE otherwise. + filename="gio/gfile.c" + line="5334">%TRUE if the @attribute was successfully set, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5319">input #GFile a string containing the attribute's name + filename="gio/gfile.c" + line="5320">a string containing the attribute's name a #guint64 containing the attribute's new value + filename="gio/gfile.c" + line="5321">a #guint64 containing the attribute's new value a #GFileQueryInfoFlags + filename="gio/gfile.c" + line="5322">a #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5323">optional #GCancellable object, %NULL to ignore @@ -53553,44 +54384,43 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_set_attribute_string" throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value. + filename="gio/gfile.c" + line="5152">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the @attribute was successfully set, %FALSE otherwise. + filename="gio/gfile.c" + line="5169">%TRUE if the @attribute was successfully set, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5154">input #GFile a string containing the attribute's name + filename="gio/gfile.c" + line="5155">a string containing the attribute's name a string containing the attribute's value + filename="gio/gfile.c" + line="5156">a string containing the attribute's value #GFileQueryInfoFlags + filename="gio/gfile.c" + line="5157">#GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5158">optional #GCancellable object, %NULL to ignore @@ -53609,45 +54439,44 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_set_attribute_uint32" throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value. + filename="gio/gfile.c" + line="5218">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the @attribute was successfully set to @value + filename="gio/gfile.c" + line="5235">%TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5220">input #GFile a string containing the attribute's name + filename="gio/gfile.c" + line="5221">a string containing the attribute's name a #guint32 containing the attribute's new value + filename="gio/gfile.c" + line="5222">a #guint32 containing the attribute's new value a #GFileQueryInfoFlags + filename="gio/gfile.c" + line="5223">a #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5224">optional #GCancellable object, %NULL to ignore @@ -53666,45 +54495,44 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. c:identifier="g_file_set_attribute_uint64" throws="1"> Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value. + filename="gio/gfile.c" + line="5284">Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value. If @attribute is of a different type, this operation will fail. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if the @attribute was successfully set to @value + filename="gio/gfile.c" + line="5301">%TRUE if the @attribute was successfully set to @value in the @file, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5286">input #GFile a string containing the attribute's name + filename="gio/gfile.c" + line="5287">a string containing the attribute's name a #guint64 containing the attribute's new value + filename="gio/gfile.c" + line="5288">a #guint64 containing the attribute's new value a #GFileQueryInfoFlags + filename="gio/gfile.c" + line="5289">a #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5290">optional #GCancellable object, %NULL to ignore + c:identifier="g_file_set_attributes_async" + glib:finish-func="set_attributes_finish"> Asynchronously sets the attributes of @file with @info. + filename="gio/gfile.c" + line="5078">Asynchronously sets the attributes of @file with @info. For more details, see g_file_set_attributes_from_info(), which is the synchronous version of this call. @@ -53731,34 +54560,33 @@ which is the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_set_attributes_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="5080">input #GFile a #GFileInfo + filename="gio/gfile.c" + line="5081">a #GFileInfo a #GFileQueryInfoFlags + filename="gio/gfile.c" + line="5082">a #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="5083">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5084">optional #GCancellable object, %NULL to ignore @@ -53778,8 +54606,9 @@ the result of the operation. scope="async" closure="5"> a #GAsyncReadyCallback + filename="gio/gfile.c" + line="5086">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> a #gpointer + filename="gio/gfile.c" + line="5088">the data to pass to callback function @@ -53797,27 +54626,26 @@ the result of the operation. c:identifier="g_file_set_attributes_finish" throws="1"> Finishes setting an attribute started in g_file_set_attributes_async(). - + filename="gio/gfile.c" + line="5123">Finishes setting an attribute started in g_file_set_attributes_async(). + %TRUE if the attributes were set correctly, %FALSE otherwise. + filename="gio/gfile.c" + line="5132">%TRUE if the attributes were set correctly, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5125">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5126">a #GAsyncResult caller-allocates="0" transfer-ownership="full"> a #GFileInfo + filename="gio/gfile.c" + line="5127">a #GFileInfo @@ -53835,8 +54663,8 @@ the result of the operation. c:identifier="g_file_set_attributes_from_info" throws="1"> Tries to set all attributes in the #GFileInfo on the target + filename="gio/gfile.c" + line="4987">Tries to set all attributes in the #GFileInfo on the target values, not stopping on the first error. If there is any error during this operation then @error will @@ -53848,31 +54676,30 @@ also detect further errors. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %FALSE if there was any error, %TRUE otherwise. + filename="gio/gfile.c" + line="5009">%FALSE if there was any error, %TRUE otherwise. input #GFile + filename="gio/gfile.c" + line="4989">input #GFile a #GFileInfo + filename="gio/gfile.c" + line="4990">a #GFileInfo #GFileQueryInfoFlags + filename="gio/gfile.c" + line="4991">#GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4992">optional #GCancellable object, %NULL to ignore @@ -53889,10 +54716,11 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + throws="1" + glib:async-func="set_display_name_async"> Renames @file to the specified display name. + filename="gio/gfile.c" + line="4689">Renames @file to the specified display name. The display name is converted from UTF-8 to the correct encoding for the target filesystem if possible and the @file is renamed to this. @@ -53907,12 +54735,11 @@ On success the resulting converted filename is returned. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GFile specifying what @file was renamed to, + filename="gio/gfile.c" + line="4713">a #GFile specifying what @file was renamed to, or %NULL if there was an error. Free the returned object with g_object_unref(). @@ -53920,14 +54747,14 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. input #GFile + filename="gio/gfile.c" + line="4691">input #GFile a string + filename="gio/gfile.c" + line="4692">a string nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4693">optional #GCancellable object, %NULL to ignore + c:identifier="g_file_set_display_name_async" + glib:finish-func="set_display_name_finish" + glib:sync-func="set_display_name"> Asynchronously sets the display name for a given #GFile. + filename="gio/gfile.c" + line="4745">Asynchronously sets the display name for a given #GFile. For more details, see g_file_set_display_name() which is the synchronous version of this call. @@ -53954,28 +54783,27 @@ the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_file_set_display_name_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="4747">input #GFile a string + filename="gio/gfile.c" + line="4748">a string the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4749">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4750">optional #GCancellable object, %NULL to ignore @@ -53995,9 +54823,9 @@ the result of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="4752">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="4754">the data to pass to callback function @@ -54015,39 +54843,39 @@ the result of the operation. c:identifier="g_file_set_display_name_finish" throws="1"> Finishes setting a display name started with + filename="gio/gfile.c" + line="4787">Finishes setting a display name started with g_file_set_display_name_async(). - + a #GFile or %NULL on error. + filename="gio/gfile.c" + line="4796">a #GFile or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="4789">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4790">a #GAsyncResult + version="2.22" + glib:finish-func="start_mountable_finish"> Starts a file of type %G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="8962">Starts a file of type %G_FILE_TYPE_MOUNTABLE. Using @start_operation, you can request callbacks when, for instance, passwords are needed during authentication. @@ -54058,22 +54886,21 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_mount_mountable_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="8964">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="8965">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, or %NULL to avoid user interaction + filename="gio/gfile.c" + line="8966">a #GMountOperation, or %NULL to avoid user interaction nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="8967">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="8968">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="8969">the data to pass to callback function @@ -54121,41 +54948,41 @@ the result of the operation. version="2.22" throws="1"> Finishes a start operation. See g_file_start_mountable() for details. + filename="gio/gfile.c" + line="9016">Finishes a start operation. See g_file_start_mountable() for details. Finish an asynchronous start operation that was started with g_file_start_mountable(). - + %TRUE if the operation finished successfully. %FALSE + filename="gio/gfile.c" + line="9027">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="9018">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="9019">a #GAsyncResult + version="2.22" + glib:finish-func="stop_mountable_finish"> Stops a file of type %G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="9051">Stops a file of type %G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -54164,22 +54991,21 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_stop_mountable_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="9053">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="9054">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="9055">a #GMountOperation, or %NULL to avoid user interaction. @@ -54197,8 +55023,8 @@ the result of the operation. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="9057">optional #GCancellable object, %NULL to ignore @@ -54209,8 +55035,8 @@ the result of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="9059">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -54219,8 +55045,8 @@ the result of the operation. nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="9061">the data to pass to callback function @@ -54230,31 +55056,30 @@ the result of the operation. version="2.22" throws="1"> Finishes a stop operation, see g_file_stop_mountable() for details. + filename="gio/gfile.c" + line="9106">Finishes a stop operation, see g_file_stop_mountable() for details. Finish an asynchronous stop operation that was started with g_file_stop_mountable(). - + %TRUE if the operation finished successfully. + filename="gio/gfile.c" + line="9117">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="9108">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="9109">a #GAsyncResult @@ -54263,32 +55088,34 @@ with g_file_stop_mountable(). c:identifier="g_file_supports_thread_contexts" version="2.22"> Checks if @file supports + filename="gio/gfile.c" + line="9223">Checks if @file supports [thread-default contexts][g-main-context-push-thread-default-context]. If this returns %FALSE, you cannot perform asynchronous operations on @file in a thread that has a thread-default context. - + Whether or not @file supports thread-default contexts. + filename="gio/gfile.c" + line="9232">Whether or not @file supports thread-default contexts. a #GFile + filename="gio/gfile.c" + line="9225">a #GFile - + Sends @file to the "Trashcan", if possible. This is similar to + filename="gio/gfile.c" + line="4585">Sends @file to the "Trashcan", if possible. This is similar to deleting it, but the user can recover it before emptying the trashcan. Not all file systems support trashing, so this call can return the %G_IO_ERROR_NOT_SUPPORTED error. Since GLib 2.66, the `x-gvfs-notrash` unix @@ -54298,19 +55125,18 @@ mounts, the %G_IO_ERROR_NOT_SUPPORTED error will be returned in that case. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE on successful trash, %FALSE otherwise. + filename="gio/gfile.c" + line="4603">%TRUE on successful trash, %FALSE otherwise. #GFile to send to trash + filename="gio/gfile.c" + line="4587">#GFile to send to trash nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4588">optional #GCancellable object, %NULL to ignore @@ -54327,26 +55153,27 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + version="2.38" + glib:finish-func="trash_finish" + glib:sync-func="trash"> Asynchronously sends @file to the Trash location, if possible. - + filename="gio/gfile.c" + line="4630">Asynchronously sends @file to the Trash location, if possible. + input #GFile + filename="gio/gfile.c" + line="4632">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4633">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4634">optional #GCancellable object, %NULL to ignore @@ -54366,8 +55193,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. scope="async" closure="3"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4636">a #GAsyncReadyCallback to call when the request is satisfied @@ -54376,8 +55203,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="4638">the data to pass to callback function @@ -54387,28 +55214,27 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. version="2.38" throws="1"> Finishes an asynchronous file trashing operation, started with + filename="gio/gfile.c" + line="4663">Finishes an asynchronous file trashing operation, started with g_file_trash_async(). - + %TRUE on successful trash, %FALSE otherwise. + filename="gio/gfile.c" + line="4672">%TRUE on successful trash, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4665">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4666">a #GAsyncResult @@ -54416,10 +55242,11 @@ g_file_trash_async(). + deprecated-version="2.22" + glib:finish-func="unmount_mountable_finish"> Unmounts a file of type G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="5437">Unmounts a file of type G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -54429,22 +55256,21 @@ When the operation is finished, @callback will be called. You can then call g_file_unmount_mountable_finish() to get the result of the operation. Use g_file_unmount_mountable_with_operation() instead. - + input #GFile + filename="gio/gfile.c" + line="5439">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5440">flags affecting the operation nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5441">optional #GCancellable object, %NULL to ignore @@ -54464,9 +55290,9 @@ the result of the operation. scope="async" closure="3"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5443">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="5445">the data to pass to callback function @@ -54486,43 +55312,43 @@ the result of the operation. deprecated-version="2.22" throws="1"> Finishes an unmount operation, see g_file_unmount_mountable() for details. + filename="gio/gfile.c" + line="5488">Finishes an unmount operation, see g_file_unmount_mountable() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable(). Use g_file_unmount_mountable_with_operation_finish() instead. - + %TRUE if the operation finished successfully. + filename="gio/gfile.c" + line="5499">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5490">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5491">a #GAsyncResult + version="2.22" + glib:finish-func="unmount_mountable_with_operation_finish"> Unmounts a file of type %G_FILE_TYPE_MOUNTABLE. + filename="gio/gfile.c" + line="5524">Unmounts a file of type %G_FILE_TYPE_MOUNTABLE. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -54531,22 +55357,21 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. When the operation is finished, @callback will be called. You can then call g_file_unmount_mountable_finish() to get the result of the operation. - + input #GFile + filename="gio/gfile.c" + line="5526">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5527">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="5528">a #GMountOperation, or %NULL to avoid user interaction @@ -54564,8 +55389,8 @@ the result of the operation. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5530">optional #GCancellable object, %NULL to ignore @@ -54576,9 +55401,9 @@ the result of the operation. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5532">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfile.c" + line="5534">the data to pass to callback function @@ -54597,32 +55422,31 @@ the result of the operation. version="2.22" throws="1"> Finishes an unmount operation, + filename="gio/gfile.c" + line="5586">Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details. Finish an asynchronous unmount operation that was started with g_file_unmount_mountable_with_operation(). - + %TRUE if the operation finished successfully. + filename="gio/gfile.c" + line="5598">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5588">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5589">a #GAsyncResult @@ -54630,25 +55454,24 @@ with g_file_unmount_mountable_with_operation(). Information about a specific attribute. - + the name of the attribute. the #GFileAttributeType type of the attribute. a set of #GFileAttributeInfoFlags. @@ -54658,7 +55481,7 @@ with g_file_unmount_mountable_with_operation(). glib:get-type="g_file_attribute_info_flags_get_type" c:type="GFileAttributeInfoFlags"> Flags specifying the behaviour of an attribute. glib:nick="none" glib:name="G_FILE_ATTRIBUTE_INFO_NONE"> no flags set. glib:nick="copy-with-file" glib:name="G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE"> copy the attribute values when the file is copied. glib:nick="copy-when-moved" glib:name="G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED"> copy the attribute values when the file is moved. @@ -54694,70 +55517,67 @@ with g_file_unmount_mountable_with_operation(). glib:get-type="g_file_attribute_info_list_get_type" c:symbol-prefix="file_attribute_info_list"> Acts as a lightweight registry for possible valid file attributes. The registry stores Key-Value pair formats as #GFileAttributeInfos. - + an array of #GFileAttributeInfos. the number of values in the array. Creates a new file attribute info list. - + filename="gio/gfileattribute.c" + line="689">Creates a new file attribute info list. + a #GFileAttributeInfoList. + filename="gio/gfileattribute.c" + line="694">a #GFileAttributeInfoList. Adds a new attribute with @name to the @list, setting + filename="gio/gfileattribute.c" + line="840">Adds a new attribute with @name to the @list, setting its @type and @flags. - + a #GFileAttributeInfoList. + filename="gio/gfileattribute.c" + line="842">a #GFileAttributeInfoList. the name of the attribute to add. + filename="gio/gfileattribute.c" + line="843">the name of the attribute to add. the #GFileAttributeType for the attribute. + filename="gio/gfileattribute.c" + line="844">the #GFileAttributeType for the attribute. #GFileAttributeInfoFlags for the attribute. + filename="gio/gfileattribute.c" + line="845">#GFileAttributeInfoFlags for the attribute. @@ -54765,21 +55585,20 @@ its @type and @flags. Makes a duplicate of a file attribute info list. - + filename="gio/gfileattribute.c" + line="711">Makes a duplicate of a file attribute info list. + a copy of the given @list. + filename="gio/gfileattribute.c" + line="717">a copy of the given @list. a #GFileAttributeInfoList to duplicate. + filename="gio/gfileattribute.c" + line="713">a #GFileAttributeInfoList to duplicate. @@ -54787,50 +55606,48 @@ its @type and @flags. Gets the file attribute with the name @name from @list. - + filename="gio/gfileattribute.c" + line="813">Gets the file attribute with the name @name from @list. + a #GFileAttributeInfo for the @name, or %NULL if an + filename="gio/gfileattribute.c" + line="820">a #GFileAttributeInfo for the @name, or %NULL if an attribute isn't found. a #GFileAttributeInfoList. + filename="gio/gfileattribute.c" + line="815">a #GFileAttributeInfoList. the name of the attribute to look up. + filename="gio/gfileattribute.c" + line="816">the name of the attribute to look up. References a file attribute info list. - + filename="gio/gfileattribute.c" + line="743">References a file attribute info list. + #GFileAttributeInfoList or %NULL on error. + filename="gio/gfileattribute.c" + line="749">#GFileAttributeInfoList or %NULL on error. a #GFileAttributeInfoList to reference. + filename="gio/gfileattribute.c" + line="745">a #GFileAttributeInfoList to reference. @@ -54838,19 +55655,18 @@ attribute isn't found. Removes a reference from the given @list. If the reference count + filename="gio/gfileattribute.c" + line="765">Removes a reference from the given @list. If the reference count falls to zero, the @list is deleted. - + The #GFileAttributeInfoList to unreference. + filename="gio/gfileattribute.c" + line="767">The #GFileAttributeInfoList to unreference. @@ -54864,14 +55680,13 @@ falls to zero, the @list is deleted. glib:get-type="g_file_attribute_matcher_get_type" c:symbol-prefix="file_attribute_matcher"> Determines if a string matches a file attribute. - + filename="gio/giotypes.h" + line="77">Determines if a string matches a file attribute. + Creates a new file attribute matcher, which matches attributes + filename="gio/gfileinfo.c" + line="2687">Creates a new file attribute matcher, which matches attributes against a given string. #GFileAttributeMatchers are reference counted structures, and are created with a reference count of 1. If the number of references falls to 0, the #GFileAttributeMatcher is @@ -54890,19 +55705,18 @@ The wildcard "*" may be used to match all keys and namespaces, or standard namespace. - `"standard::type,unix::*"`: matches the type key in the standard namespace and all keys in the unix namespace. - + a #GFileAttributeMatcher + filename="gio/gfileinfo.c" + line="2711">a #GFileAttributeMatcher an attribute string to match. + filename="gio/gfileinfo.c" + line="2689">an attribute string to match. @@ -54910,33 +55724,32 @@ The wildcard "*" may be used to match all keys and namespaces, or Checks if the matcher will match all of the keys in a given namespace. + filename="gio/gfileinfo.c" + line="2978">Checks if the matcher will match all of the keys in a given namespace. This will always return %TRUE if a wildcard character is in use (e.g. if matcher was created with "standard::*" and @ns is "standard", or if matcher was created using "*" and namespace is anything.) TODO: this is awkwardly worded. - + %TRUE if the matcher matches all of the entries + filename="gio/gfileinfo.c" + line="2990">%TRUE if the matcher matches all of the entries in the given @ns, %FALSE otherwise. a #GFileAttributeMatcher. + filename="gio/gfileinfo.c" + line="2980">a #GFileAttributeMatcher. a string containing a file attribute namespace. + filename="gio/gfileinfo.c" + line="2981">a string containing a file attribute namespace. @@ -54944,51 +55757,49 @@ in the given @ns, %FALSE otherwise. Gets the next matched attribute from a #GFileAttributeMatcher. - + filename="gio/gfileinfo.c" + line="3028">Gets the next matched attribute from a #GFileAttributeMatcher. + a string containing the next attribute or, %NULL if + filename="gio/gfileinfo.c" + line="3034">a string containing the next attribute or, %NULL if no more attribute exist. a #GFileAttributeMatcher. + filename="gio/gfileinfo.c" + line="3030">a #GFileAttributeMatcher. Checks if an attribute will be matched by an attribute matcher. If + filename="gio/gfileinfo.c" + line="2950">Checks if an attribute will be matched by an attribute matcher. If the matcher was created with the "*" matching string, this function will always return %TRUE. - + %TRUE if @attribute matches @matcher. %FALSE otherwise. + filename="gio/gfileinfo.c" + line="2959">%TRUE if @attribute matches @matcher. %FALSE otherwise. a #GFileAttributeMatcher. + filename="gio/gfileinfo.c" + line="2952">a #GFileAttributeMatcher. a file attribute key. + filename="gio/gfileinfo.c" + line="2953">a file attribute key. @@ -54996,57 +55807,55 @@ will always return %TRUE. Checks if an attribute matcher only matches a given attribute. Always + filename="gio/gfileinfo.c" + line="2882">Checks if an attribute matcher only matches a given attribute. Always returns %FALSE if "*" was used when creating the matcher. - + %TRUE if the matcher only matches @attribute. %FALSE otherwise. + filename="gio/gfileinfo.c" + line="2890">%TRUE if the matcher only matches @attribute. %FALSE otherwise. a #GFileAttributeMatcher. + filename="gio/gfileinfo.c" + line="2884">a #GFileAttributeMatcher. a file attribute key. + filename="gio/gfileinfo.c" + line="2885">a file attribute key. References a file attribute matcher. - + filename="gio/gfileinfo.c" + line="2838">References a file attribute matcher. + a #GFileAttributeMatcher. + filename="gio/gfileinfo.c" + line="2844">a #GFileAttributeMatcher. a #GFileAttributeMatcher. + filename="gio/gfileinfo.c" + line="2840">a #GFileAttributeMatcher. Subtracts all attributes of @subtract from @matcher and returns + filename="gio/gfileinfo.c" + line="2767">Subtracts all attributes of @subtract from @matcher and returns a matcher that supports those attributes. Note that currently it is not possible to remove a single @@ -55054,12 +55863,11 @@ attribute when the @matcher matches the whole namespace - or remove a namespace or attribute when the matcher matches everything. This is a limitation of the current implementation, but may be fixed in the future. - + A file attribute matcher matching all attributes of + filename="gio/gfileinfo.c" + line="2781">A file attribute matcher matching all attributes of @matcher that are not matched by @subtract @@ -55069,8 +55877,8 @@ in the future. nullable="1" allow-none="1"> Matcher to subtract from + filename="gio/gfileinfo.c" + line="2769">Matcher to subtract from nullable="1" allow-none="1"> The matcher to subtract + filename="gio/gfileinfo.c" + line="2770">The matcher to subtract @@ -55088,17 +55896,16 @@ in the future. c:identifier="g_file_attribute_matcher_to_string" version="2.32"> Prints what the matcher is matching against. The format will be + filename="gio/gfileinfo.c" + line="3065">Prints what the matcher is matching against. The format will be equal to the format passed to g_file_attribute_matcher_new(). The output however, might not be identical, as the matcher may decide to use a different order or omit needless parts. - + a string describing the attributes the matcher matches + filename="gio/gfileinfo.c" + line="3074">a string describing the attributes the matcher matches against or %NULL if @matcher was %NULL. @@ -55108,27 +55915,26 @@ decide to use a different order or omit needless parts. nullable="1" allow-none="1"> a #GFileAttributeMatcher. + filename="gio/gfileinfo.c" + line="3067">a #GFileAttributeMatcher. Unreferences @matcher. If the reference count falls below 1, + filename="gio/gfileinfo.c" + line="2857">Unreferences @matcher. If the reference count falls below 1, the @matcher is automatically freed. - + a #GFileAttributeMatcher. + filename="gio/gfileinfo.c" + line="2859">a #GFileAttributeMatcher. @@ -55139,7 +55945,7 @@ the @matcher is automatically freed. glib:get-type="g_file_attribute_status_get_type" c:type="GFileAttributeStatus"> Used by g_file_set_attributes_from_info() when setting file attributes. glib:nick="unset" glib:name="G_FILE_ATTRIBUTE_STATUS_UNSET"> Attribute value is unset (empty). glib:nick="set" glib:name="G_FILE_ATTRIBUTE_STATUS_SET"> Attribute value is set. glib:nick="error-setting" glib:name="G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING"> Indicates an error in setting the value. @@ -55174,7 +55980,7 @@ the @matcher is automatically freed. glib:get-type="g_file_attribute_type_get_type" c:type="GFileAttributeType"> The data types for file attributes. glib:nick="invalid" glib:name="G_FILE_ATTRIBUTE_TYPE_INVALID"> indicates an invalid or uninitialized type. glib:nick="string" glib:name="G_FILE_ATTRIBUTE_TYPE_STRING"> a null terminated UTF8 string. glib:nick="byte-string" glib:name="G_FILE_ATTRIBUTE_TYPE_BYTE_STRING"> a zero terminated string of non-zero bytes. glib:nick="boolean" glib:name="G_FILE_ATTRIBUTE_TYPE_BOOLEAN"> a boolean value. glib:nick="uint32" glib:name="G_FILE_ATTRIBUTE_TYPE_UINT32"> an unsigned 4-byte/32-bit integer. glib:nick="int32" glib:name="G_FILE_ATTRIBUTE_TYPE_INT32"> a signed 4-byte/32-bit integer. glib:nick="uint64" glib:name="G_FILE_ATTRIBUTE_TYPE_UINT64"> an unsigned 8-byte/64-bit integer. glib:nick="int64" glib:name="G_FILE_ATTRIBUTE_TYPE_INT64"> a signed 8-byte/64-bit integer. glib:nick="object" glib:name="G_FILE_ATTRIBUTE_TYPE_OBJECT"> a #GObject. glib:nick="stringv" glib:name="G_FILE_ATTRIBUTE_TYPE_STRINGV"> a %NULL terminated char **. Since 2.22 @@ -55272,7 +56078,7 @@ the @matcher is automatically freed. glib:get-type="g_file_copy_flags_get_type" c:type="GFileCopyFlags"> Flags used when copying or moving files. glib:nick="none" glib:name="G_FILE_COPY_NONE"> No flags set. glib:nick="overwrite" glib:name="G_FILE_COPY_OVERWRITE"> Overwrite any existing files glib:nick="backup" glib:name="G_FILE_COPY_BACKUP"> Make a backup of any existing files. glib:nick="nofollow-symlinks" glib:name="G_FILE_COPY_NOFOLLOW_SYMLINKS"> Don't follow symlinks. glib:nick="all-metadata" glib:name="G_FILE_COPY_ALL_METADATA"> Copy all file metadata instead of just default set used for copy (see #GFileInfo). glib:nick="no-fallback-for-move" glib:name="G_FILE_COPY_NO_FALLBACK_FOR_MOVE"> Don't use copy and delete fallback if native move not supported. glib:nick="target-default-perms" glib:name="G_FILE_COPY_TARGET_DEFAULT_PERMS"> Leaves target file with default perms, instead of setting the source file perms. + + Use default modification + timestamps instead of copying them from the source file. Since 2.80 + Flags used when an operation may create a file. glib:nick="none" glib:name="G_FILE_CREATE_NONE"> No flags set. glib:nick="private" glib:name="G_FILE_CREATE_PRIVATE"> Create a file that can only be accessed by the current user. @@ -55370,7 +56186,7 @@ the @matcher is automatically freed. glib:nick="replace-destination" glib:name="G_FILE_CREATE_REPLACE_DESTINATION"> Replace the destination as if it didn't exist before. Don't try to keep any old permissions, replace instead of following links. This @@ -55391,32 +56207,32 @@ the @matcher is automatically freed. glib:get-type="g_file_descriptor_based_get_type" glib:type-struct="FileDescriptorBasedIface"> #GFileDescriptorBased is implemented by streams (implementations of -#GInputStream or #GOutputStream) that are based on file descriptors. + filename="gio/gfiledescriptorbased.c" + line="28">`GFileDescriptorBased` is an interface for file descriptor based IO. + +It is implemented by streams (implementations of [class@Gio.InputStream] or +[class@Gio.OutputStream]) that are based on file descriptors. Note that `<gio/gfiledescriptorbased.h>` belongs to the UNIX-specific GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config -file when using it. - +file or the `GioUnix-2.0` GIR namespace when using it. + Gets the underlying file descriptor. - + filename="gio/gfiledescriptorbased.c" + line="51">Gets the underlying file descriptor. + The file descriptor + filename="gio/gfiledescriptorbased.c" + line="57">The file descriptor a #GFileDescriptorBased. + filename="gio/gfiledescriptorbased.c" + line="53">a #GFileDescriptorBased. @@ -55425,21 +56241,20 @@ file when using it. c:identifier="g_file_descriptor_based_get_fd" version="2.24"> Gets the underlying file descriptor. - + filename="gio/gfiledescriptorbased.c" + line="51">Gets the underlying file descriptor. + The file descriptor + filename="gio/gfiledescriptorbased.c" + line="57">The file descriptor a #GFileDescriptorBased. + filename="gio/gfiledescriptorbased.c" + line="53">a #GFileDescriptorBased. @@ -55449,31 +56264,32 @@ file when using it. c:type="GFileDescriptorBasedIface" glib:is-gtype-struct-for="FileDescriptorBased"> An interface for file descriptor based io objects. - + filename="gio/gfiledescriptorbased.h" + line="39">An interface for file descriptor based io objects. + The parent interface. + filename="gio/gfiledescriptorbased.h" + line="41">The parent interface. + Gets the underlying file descriptor. - + The file descriptor + filename="gio/gfiledescriptorbased.c" + line="57">The file descriptor a #GFileDescriptorBased. + filename="gio/gfiledescriptorbased.c" + line="53">a #GFileDescriptorBased. @@ -55488,20 +56304,20 @@ file when using it. glib:get-type="g_file_enumerator_get_type" glib:type-struct="FileEnumeratorClass"> #GFileEnumerator allows you to operate on a set of #GFiles, -returning a #GFileInfo structure for each file enumerated (e.g. -g_file_enumerate_children() will return a #GFileEnumerator for each + filename="gio/gfileenumerator.c" + line="41">`GFileEnumerator` allows you to operate on a set of [iface@Gio.File] objects, +returning a [class@Gio.FileInfo] structure for each file enumerated (e.g. +[method@Gio.File.enumerate_children] will return a `GFileEnumerator` for each of the children within a directory). -To get the next file's information from a #GFileEnumerator, use -g_file_enumerator_next_file() or its asynchronous version, -g_file_enumerator_next_files_async(). Note that the asynchronous -version will return a list of #GFileInfos, whereas the +To get the next file's information from a `GFileEnumerator`, use +[method@Gio.FileEnumerator.next_file] or its asynchronous version, +[method@Gio.FileEnumerator.next_files_async]. Note that the asynchronous +version will return a list of [class@Gio.FileInfo] objects, whereas the synchronous will only return the next file in the enumerator. The ordering of returned files is unspecified for non-Unix -platforms; for more information, see g_dir_read_name(). On Unix, +platforms; for more information, see [method@GLib.Dir.read_name]. On Unix, when operating on local files, returned files will be sorted by inode number. Effectively you can assume that the ordering of returned files will be stable between successive calls (and @@ -55511,37 +56327,37 @@ If your application needs a specific ordering, such as by name or modification time, you will have to implement that in your application code. -To close a #GFileEnumerator, use g_file_enumerator_close(), or -its asynchronous version, g_file_enumerator_close_async(). Once -a #GFileEnumerator is closed, no further actions may be performed -on it, and it should be freed with g_object_unref(). - - +To close a `GFileEnumerator`, use [method@Gio.FileEnumerator.close], or +its asynchronous version, [method@Gio.FileEnumerator.close_async]. Once +a `GFileEnumerator` is closed, no further actions may be performed +on it, and it should be freed with [method@GObject.Object.unref]. + + Asynchronously closes the file enumerator. + filename="gio/gfileenumerator.c" + line="486">Asynchronously closes the file enumerator. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned in g_file_enumerator_close_finish(). - + a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="488">a #GFileEnumerator. the [I/O priority][io-priority] of the request + filename="gio/gfileenumerator.c" + line="489">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileenumerator.c" + line="490">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfileenumerator.c" + line="491">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gfileenumerator.c" + line="493">the data to pass to callback function Finishes closing a file enumerator, started from g_file_enumerator_close_async(). + filename="gio/gfileenumerator.c" + line="540">Finishes closing a file enumerator, started from g_file_enumerator_close_async(). If the file enumerator was already closed when g_file_enumerator_close_async() was called, then this function will report %G_IO_ERROR_CLOSED in @error, and @@ -55589,32 +56406,30 @@ return %FALSE. If @cancellable was not %NULL, then the operation may have been cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %FALSE will be returned. - + %TRUE if the close operation has finished successfully. + filename="gio/gfileenumerator.c" + line="558">%TRUE if the close operation has finished successfully. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="542">a #GFileEnumerator. a #GAsyncResult. + filename="gio/gfileenumerator.c" + line="543">a #GAsyncResult. - + @@ -55632,8 +56447,8 @@ returned. Returns information for the next file in the enumerated object. + filename="gio/gfileenumerator.c" + line="180">Returns information for the next file in the enumerated object. Will block until the information is available. The #GFileInfo returned from this function will contain attributes that match the attribute string that was passed when the #GFileEnumerator was created. @@ -55644,12 +56459,11 @@ order of returned files. On error, returns %NULL and sets @error to the error. If the enumerator is at the end, %NULL will be returned and @error will be unset. - + A #GFileInfo or %NULL on error + filename="gio/gfileenumerator.c" + line="198">A #GFileInfo or %NULL on error or end of enumerator. Free the returned object with g_object_unref() when no longer needed. @@ -55657,8 +56471,8 @@ be unset. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="182">a #GFileEnumerator. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileenumerator.c" + line="183">optional #GCancellable object, %NULL to ignore. - + Request information for a number of files from the enumerator asynchronously. + filename="gio/gfileenumerator.c" + line="313">Request information for a number of files from the enumerator asynchronously. When all I/O for the operation is finished the @callback will be called with the requested information. @@ -55739,28 +56555,27 @@ result in %G_IO_ERROR_PENDING errors. Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is %G_PRIORITY_DEFAULT. - + a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="315">a #GFileEnumerator. the number of file info objects to request + filename="gio/gfileenumerator.c" + line="316">the number of file info objects to request the [I/O priority][io-priority] of the request + filename="gio/gfileenumerator.c" + line="317">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileenumerator.c" + line="318">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfileenumerator.c" + line="319">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfileenumerator.c" + line="321">the data to pass to callback function @@ -55799,14 +56615,13 @@ priority is %G_PRIORITY_DEFAULT. invoker="next_files_finish" throws="1"> Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). - + filename="gio/gfileenumerator.c" + line="440">Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). + a #GList of #GFileInfos. You must free the list with + filename="gio/gfileenumerator.c" + line="449">a #GList of #GFileInfos. You must free the list with g_list_free() and unref the infos with g_object_unref() when you're done with them. @@ -55816,40 +56631,42 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="442">a #GFileEnumerator. a #GAsyncResult. + filename="gio/gfileenumerator.c" + line="443">a #GAsyncResult. - + Releases all resources used by this enumerator, making the + filename="gio/gfileenumerator.c" + line="249">Releases all resources used by this enumerator, making the enumerator return %G_IO_ERROR_CLOSED on all calls. This will be automatically called when the last reference is dropped, but you might want to call this function to make sure resources are released as early as possible. - + #TRUE on success or #FALSE on error. + filename="gio/gfileenumerator.c" + line="262">#TRUE on success or #FALSE on error. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="251">a #GFileEnumerator. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileenumerator.c" + line="252">optional #GCancellable object, %NULL to ignore. - + Asynchronously closes the file enumerator. + filename="gio/gfileenumerator.c" + line="486">Asynchronously closes the file enumerator. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned in g_file_enumerator_close_finish(). - + a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="488">a #GFileEnumerator. the [I/O priority][io-priority] of the request + filename="gio/gfileenumerator.c" + line="489">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileenumerator.c" + line="490">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfileenumerator.c" + line="491">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfileenumerator.c" + line="493">the data to pass to callback function @@ -55925,8 +56745,8 @@ g_file_enumerator_close_finish(). c:identifier="g_file_enumerator_close_finish" throws="1"> Finishes closing a file enumerator, started from g_file_enumerator_close_async(). + filename="gio/gfileenumerator.c" + line="540">Finishes closing a file enumerator, started from g_file_enumerator_close_async(). If the file enumerator was already closed when g_file_enumerator_close_async() was called, then this function will report %G_IO_ERROR_CLOSED in @error, and @@ -55936,25 +56756,24 @@ return %FALSE. If @cancellable was not %NULL, then the operation may have been cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %FALSE will be returned. - + %TRUE if the close operation has finished successfully. + filename="gio/gfileenumerator.c" + line="558">%TRUE if the close operation has finished successfully. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="542">a #GFileEnumerator. a #GAsyncResult. + filename="gio/gfileenumerator.c" + line="543">a #GAsyncResult. @@ -55963,8 +56782,8 @@ returned. c:identifier="g_file_enumerator_get_child" version="2.36"> Return a new #GFile which refers to the file named by @info in the source + filename="gio/gfileenumerator.c" + line="765">Return a new #GFile which refers to the file named by @info in the source directory of @enumerator. This function is primarily intended to be used inside loops with g_file_enumerator_next_file(). @@ -55977,25 +56796,24 @@ This is a convenience method that's equivalent to: GFile *child = g_file_get_child (g_file_enumerator_get_container (enumr), name); ]| - + a #GFile for the #GFileInfo passed it. + filename="gio/gfileenumerator.c" + line="785">a #GFile for the #GFileInfo passed it. a #GFileEnumerator + filename="gio/gfileenumerator.c" + line="767">a #GFileEnumerator a #GFileInfo gotten from g_file_enumerator_next_file() + filename="gio/gfileenumerator.c" + line="768">a #GFileInfo gotten from g_file_enumerator_next_file() or the async equivalents. @@ -56005,63 +56823,60 @@ This is a convenience method that's equivalent to: c:identifier="g_file_enumerator_get_container" version="2.18"> Get the #GFile container which is being enumerated. - + filename="gio/gfileenumerator.c" + line="747">Get the #GFile container which is being enumerated. + the #GFile which is being enumerated. + filename="gio/gfileenumerator.c" + line="753">the #GFile which is being enumerated. a #GFileEnumerator + filename="gio/gfileenumerator.c" + line="749">a #GFileEnumerator Checks if the file enumerator has pending operations. - + filename="gio/gfileenumerator.c" + line="595">Checks if the file enumerator has pending operations. + %TRUE if the @enumerator has pending operations. + filename="gio/gfileenumerator.c" + line="601">%TRUE if the @enumerator has pending operations. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="597">a #GFileEnumerator. Checks if the file enumerator has been closed. - + filename="gio/gfileenumerator.c" + line="579">Checks if the file enumerator has been closed. + %TRUE if the @enumerator is closed. + filename="gio/gfileenumerator.c" + line="585">%TRUE if the @enumerator is closed. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="581">a #GFileEnumerator. @@ -56071,8 +56886,8 @@ This is a convenience method that's equivalent to: version="2.44" throws="1"> This is a version of g_file_enumerator_next_file() that's easier to + filename="gio/gfileenumerator.c" + line="627">This is a version of g_file_enumerator_next_file() that's easier to use correctly from C programs. With g_file_enumerator_next_file(), the gboolean return value signifies "end of iteration or error", which requires allocation of a temporary #GError. @@ -56110,16 +56925,15 @@ while (TRUE) out: g_object_unref (direnum); // Note: frees the last @info ]| - + an open #GFileEnumerator + filename="gio/gfileenumerator.c" + line="629">an open #GFileEnumerator Output location for the next #GFileInfo, or %NULL + filename="gio/gfileenumerator.c" + line="630">Output location for the next #GFileInfo, or %NULL Output location for the next #GFile, or %NULL + filename="gio/gfileenumerator.c" + line="631">Output location for the next #GFile, or %NULL a #GCancellable + filename="gio/gfileenumerator.c" + line="632">a #GCancellable @@ -56159,8 +56973,8 @@ out: c:identifier="g_file_enumerator_next_file" throws="1"> Returns information for the next file in the enumerated object. + filename="gio/gfileenumerator.c" + line="180">Returns information for the next file in the enumerated object. Will block until the information is available. The #GFileInfo returned from this function will contain attributes that match the attribute string that was passed when the #GFileEnumerator was created. @@ -56171,12 +56985,11 @@ order of returned files. On error, returns %NULL and sets @error to the error. If the enumerator is at the end, %NULL will be returned and @error will be unset. - + A #GFileInfo or %NULL on error + filename="gio/gfileenumerator.c" + line="198">A #GFileInfo or %NULL on error or end of enumerator. Free the returned object with g_object_unref() when no longer needed. @@ -56184,8 +56997,8 @@ be unset. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="182">a #GFileEnumerator. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileenumerator.c" + line="183">optional #GCancellable object, %NULL to ignore. + c:identifier="g_file_enumerator_next_files_async" + glib:finish-func="next_files_finish"> Request information for a number of files from the enumerator asynchronously. + filename="gio/gfileenumerator.c" + line="313">Request information for a number of files from the enumerator asynchronously. When all I/O for the operation is finished the @callback will be called with the requested information. @@ -56267,28 +57081,27 @@ result in %G_IO_ERROR_PENDING errors. Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is %G_PRIORITY_DEFAULT. - + a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="315">a #GFileEnumerator. the number of file info objects to request + filename="gio/gfileenumerator.c" + line="316">the number of file info objects to request the [I/O priority][io-priority] of the request + filename="gio/gfileenumerator.c" + line="317">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileenumerator.c" + line="318">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfileenumerator.c" + line="319">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfileenumerator.c" + line="321">the data to pass to callback function @@ -56326,14 +57140,13 @@ priority is %G_PRIORITY_DEFAULT. c:identifier="g_file_enumerator_next_files_finish" throws="1"> Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). - + filename="gio/gfileenumerator.c" + line="440">Finishes the asynchronous operation started with g_file_enumerator_next_files_async(). + a #GList of #GFileInfos. You must free the list with + filename="gio/gfileenumerator.c" + line="449">a #GList of #GFileInfos. You must free the list with g_list_free() and unref the infos with g_object_unref() when you're done with them. @@ -56343,38 +57156,37 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="442">a #GFileEnumerator. a #GAsyncResult. + filename="gio/gfileenumerator.c" + line="443">a #GAsyncResult. Sets the file enumerator as having pending operations. - + filename="gio/gfileenumerator.c" + line="611">Sets the file enumerator as having pending operations. + a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="613">a #GFileEnumerator. a boolean value. + filename="gio/gfileenumerator.c" + line="614">a boolean value. @@ -56384,6 +57196,9 @@ priority is %G_PRIORITY_DEFAULT. writable="1" construct-only="1" transfer-ownership="none"> + The container that is being enumerated. @@ -56396,19 +57211,17 @@ priority is %G_PRIORITY_DEFAULT. - + - + A #GFileInfo or %NULL on error + filename="gio/gfileenumerator.c" + line="198">A #GFileInfo or %NULL on error or end of enumerator. Free the returned object with g_object_unref() when no longer needed. @@ -56416,8 +57229,8 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="182">a #GFileEnumerator. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileenumerator.c" + line="183">optional #GCancellable object, %NULL to ignore. @@ -56434,8 +57247,7 @@ priority is %G_PRIORITY_DEFAULT. - + @@ -56454,28 +57266,27 @@ priority is %G_PRIORITY_DEFAULT. - + a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="315">a #GFileEnumerator. the number of file info objects to request + filename="gio/gfileenumerator.c" + line="316">the number of file info objects to request the [I/O priority][io-priority] of the request + filename="gio/gfileenumerator.c" + line="317">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileenumerator.c" + line="318">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfileenumerator.c" + line="319">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfileenumerator.c" + line="321">the data to pass to callback function @@ -56513,12 +57325,11 @@ priority is %G_PRIORITY_DEFAULT. - + a #GList of #GFileInfos. You must free the list with + filename="gio/gfileenumerator.c" + line="449">a #GList of #GFileInfos. You must free the list with g_list_free() and unref the infos with g_object_unref() when you're done with them. @@ -56528,14 +57339,14 @@ priority is %G_PRIORITY_DEFAULT. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="442">a #GFileEnumerator. a #GAsyncResult. + filename="gio/gfileenumerator.c" + line="443">a #GAsyncResult. @@ -56543,22 +57354,21 @@ priority is %G_PRIORITY_DEFAULT. - + a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="488">a #GFileEnumerator. the [I/O priority][io-priority] of the request + filename="gio/gfileenumerator.c" + line="489">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileenumerator.c" + line="490">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfileenumerator.c" + line="491">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfileenumerator.c" + line="493">the data to pass to callback function @@ -56596,25 +57407,24 @@ priority is %G_PRIORITY_DEFAULT. - + %TRUE if the close operation has finished successfully. + filename="gio/gfileenumerator.c" + line="558">%TRUE if the close operation has finished successfully. a #GFileEnumerator. + filename="gio/gfileenumerator.c" + line="542">a #GFileEnumerator. a #GAsyncResult. + filename="gio/gfileenumerator.c" + line="543">a #GAsyncResult. @@ -56622,8 +57432,7 @@ priority is %G_PRIORITY_DEFAULT. - + @@ -56631,8 +57440,7 @@ priority is %G_PRIORITY_DEFAULT. - + @@ -56640,8 +57448,7 @@ priority is %G_PRIORITY_DEFAULT. - + @@ -56649,8 +57456,7 @@ priority is %G_PRIORITY_DEFAULT. - + @@ -56658,8 +57464,7 @@ priority is %G_PRIORITY_DEFAULT. - + @@ -56667,8 +57472,7 @@ priority is %G_PRIORITY_DEFAULT. - + @@ -56676,8 +57480,7 @@ priority is %G_PRIORITY_DEFAULT. - + @@ -56688,8 +57491,7 @@ priority is %G_PRIORITY_DEFAULT. c:type="GFileEnumeratorPrivate" disguised="1" opaque="1"> - + glib:get-type="g_file_io_stream_get_type" glib:type-struct="FileIOStreamClass"> GFileIOStream provides io streams that both read and write to the same + filename="gio/gfileiostream.c" + line="36">`GFileIOStream` provides I/O streams that both read and write to the same file handle. -GFileIOStream implements #GSeekable, which allows the io +`GFileIOStream` implements [iface@Gio.Seekable], which allows the I/O stream to jump to arbitrary positions in the file and to truncate the file, provided the filesystem of the file supports these operations. -To find the position of a file io stream, use -g_seekable_tell(). +To find the position of a file I/O stream, use [method@Gio.Seekable.tell]. -To find out if a file io stream supports seeking, use g_seekable_can_seek(). -To position a file io stream, use g_seekable_seek(). -To find out if a file io stream supports truncating, use -g_seekable_can_truncate(). To truncate a file io -stream, use g_seekable_truncate(). +To find out if a file I/O stream supports seeking, use +[method@Gio.Seekable.can_seek]. To position a file I/O stream, use +[method@Gio.Seekable.seek]. To find out if a file I/O stream supports +truncating, use [method@Gio.Seekable.can_truncate]. To truncate a file I/O +stream, use [method@Gio.Seekable.truncate]. -The default implementation of all the #GFileIOStream operations -and the implementation of #GSeekable just call into the same operations -on the output stream. - +The default implementation of all the `GFileIOStream` operations +and the implementation of [iface@Gio.Seekable] just call into the same +operations on the output stream. + - + @@ -56737,8 +57536,7 @@ on the output stream. - + @@ -56750,23 +57548,22 @@ on the output stream. Gets the entity tag for the file when it has been written. + filename="gio/gfileiostream.c" + line="273">Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - + the entity tag for the stream. + filename="gio/gfileiostream.c" + line="281">the entity tag for the stream. a #GFileIOStream. + filename="gio/gfileiostream.c" + line="275">a #GFileIOStream. @@ -56774,10 +57571,11 @@ and closed, as the etag can change while writing. + throws="1" + glib:async-func="query_info_async"> Queries a file io stream for the given @attributes. + filename="gio/gfileiostream.c" + line="110">Queries a file io stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_io_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -56794,25 +57592,24 @@ If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will be returned. - + a #GFileInfo for the @stream, or %NULL on error. + filename="gio/gfileiostream.c" + line="135">a #GFileInfo for the @stream, or %NULL on error. a #GFileIOStream. + filename="gio/gfileiostream.c" + line="112">a #GFileIOStream. a file attribute query string. + filename="gio/gfileiostream.c" + line="113">a file attribute query string. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileiostream.c" + line="114">optional #GCancellable object, %NULL to ignore. + version="2.22" + glib:finish-func="query_info_finish" + glib:sync-func="query_info"> Asynchronously queries the @stream for a #GFileInfo. When completed, + filename="gio/gfileiostream.c" + line="189">Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_io_stream_query_info_finish(). For the synchronous version of this function, see g_file_io_stream_query_info(). - + a #GFileIOStream. + filename="gio/gfileiostream.c" + line="191">a #GFileIOStream. a file attribute query string. + filename="gio/gfileiostream.c" + line="192">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + filename="gio/gfileiostream.c" + line="193">the [I/O priority](iface.AsyncResult.html#io-priority) of the + request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileiostream.c" + line="195">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/gfileiostream.c" + line="196">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfileiostream.c" + line="198">the data to pass to callback function @@ -56898,35 +57698,33 @@ g_file_io_stream_query_info(). version="2.22" throws="1"> Finalizes the asynchronous query started + filename="gio/gfileiostream.c" + line="241">Finalizes the asynchronous query started by g_file_io_stream_query_info_async(). - + A #GFileInfo for the finished query. + filename="gio/gfileiostream.c" + line="250">A #GFileInfo for the finished query. a #GFileIOStream. + filename="gio/gfileiostream.c" + line="243">a #GFileIOStream. a #GAsyncResult. + filename="gio/gfileiostream.c" + line="244">a #GAsyncResult. - + @@ -56949,8 +57747,7 @@ by g_file_io_stream_query_info_async(). - + @@ -56961,8 +57758,7 @@ by g_file_io_stream_query_info_async(). - + @@ -56985,23 +57781,22 @@ by g_file_io_stream_query_info_async(). c:identifier="g_file_io_stream_get_etag" version="2.22"> Gets the entity tag for the file when it has been written. + filename="gio/gfileiostream.c" + line="273">Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - + the entity tag for the stream. + filename="gio/gfileiostream.c" + line="281">the entity tag for the stream. a #GFileIOStream. + filename="gio/gfileiostream.c" + line="275">a #GFileIOStream. @@ -57009,10 +57804,11 @@ and closed, as the etag can change while writing. + throws="1" + glib:async-func="query_info_async"> Queries a file io stream for the given @attributes. + filename="gio/gfileiostream.c" + line="110">Queries a file io stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_io_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -57029,25 +57825,24 @@ If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will be returned. - + a #GFileInfo for the @stream, or %NULL on error. + filename="gio/gfileiostream.c" + line="135">a #GFileInfo for the @stream, or %NULL on error. a #GFileIOStream. + filename="gio/gfileiostream.c" + line="112">a #GFileIOStream. a file attribute query string. + filename="gio/gfileiostream.c" + line="113">a file attribute query string. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileiostream.c" + line="114">optional #GCancellable object, %NULL to ignore. + version="2.22" + glib:finish-func="query_info_finish" + glib:sync-func="query_info"> Asynchronously queries the @stream for a #GFileInfo. When completed, + filename="gio/gfileiostream.c" + line="189">Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_io_stream_query_info_finish(). For the synchronous version of this function, see g_file_io_stream_query_info(). - + a #GFileIOStream. + filename="gio/gfileiostream.c" + line="191">a #GFileIOStream. a file attribute query string. + filename="gio/gfileiostream.c" + line="192">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + filename="gio/gfileiostream.c" + line="193">the [I/O priority](iface.AsyncResult.html#io-priority) of the + request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileiostream.c" + line="195">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/gfileiostream.c" + line="196">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfileiostream.c" + line="198">the data to pass to callback function @@ -57132,28 +57930,27 @@ g_file_io_stream_query_info(). version="2.22" throws="1"> Finalizes the asynchronous query started + filename="gio/gfileiostream.c" + line="241">Finalizes the asynchronous query started by g_file_io_stream_query_info_async(). - + A #GFileInfo for the finished query. + filename="gio/gfileiostream.c" + line="250">A #GFileInfo for the finished query. a #GFileIOStream. + filename="gio/gfileiostream.c" + line="243">a #GFileIOStream. a #GAsyncResult. + filename="gio/gfileiostream.c" + line="244">a #GAsyncResult. @@ -57168,15 +57965,13 @@ by g_file_io_stream_query_info_async(). - + - + @@ -57189,8 +57984,7 @@ by g_file_io_stream_query_info_async(). - + @@ -57203,8 +57997,7 @@ by g_file_io_stream_query_info_async(). - + @@ -57229,8 +58022,7 @@ by g_file_io_stream_query_info_async(). - + @@ -57243,8 +58035,7 @@ by g_file_io_stream_query_info_async(). - + @@ -57266,25 +58057,24 @@ by g_file_io_stream_query_info_async(). - + a #GFileInfo for the @stream, or %NULL on error. + filename="gio/gfileiostream.c" + line="135">a #GFileInfo for the @stream, or %NULL on error. a #GFileIOStream. + filename="gio/gfileiostream.c" + line="112">a #GFileIOStream. a file attribute query string. + filename="gio/gfileiostream.c" + line="113">a file attribute query string. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileiostream.c" + line="114">optional #GCancellable object, %NULL to ignore. @@ -57301,28 +58091,28 @@ by g_file_io_stream_query_info_async(). - + a #GFileIOStream. + filename="gio/gfileiostream.c" + line="191">a #GFileIOStream. a file attribute query string. + filename="gio/gfileiostream.c" + line="192">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + filename="gio/gfileiostream.c" + line="193">the [I/O priority](iface.AsyncResult.html#io-priority) of the + request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileiostream.c" + line="195">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/gfileiostream.c" + line="196">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfileiostream.c" + line="198">the data to pass to callback function @@ -57360,25 +58151,24 @@ by g_file_io_stream_query_info_async(). - + A #GFileInfo for the finished query. + filename="gio/gfileiostream.c" + line="250">A #GFileInfo for the finished query. a #GFileIOStream. + filename="gio/gfileiostream.c" + line="243">a #GFileIOStream. a #GAsyncResult. + filename="gio/gfileiostream.c" + line="244">a #GAsyncResult. @@ -57386,19 +58176,18 @@ by g_file_io_stream_query_info_async(). - + the entity tag for the stream. + filename="gio/gfileiostream.c" + line="281">the entity tag for the stream. a #GFileIOStream. + filename="gio/gfileiostream.c" + line="275">a #GFileIOStream. @@ -57406,8 +58195,7 @@ by g_file_io_stream_query_info_async(). - + @@ -57415,8 +58203,7 @@ by g_file_io_stream_query_info_async(). - + @@ -57424,8 +58211,7 @@ by g_file_io_stream_query_info_async(). - + @@ -57433,8 +58219,7 @@ by g_file_io_stream_query_info_async(). - + @@ -57442,8 +58227,7 @@ by g_file_io_stream_query_info_async(). - + @@ -57454,8 +58238,7 @@ by g_file_io_stream_query_info_async(). c:type="GFileIOStreamPrivate" disguised="1" opaque="1"> - + glib:get-type="g_file_icon_get_type" glib:type-struct="FileIconClass"> #GFileIcon specifies an icon by pointing to an image file -to be used as icon. - + filename="gio/gfileicon.c" + line="35">`GFileIcon` specifies an icon by pointing to an image file +to be used as icon. + +It implements [iface@Gio.LoadableIcon]. + Creates a new icon for a file. - + filename="gio/gfileicon.c" + line="166">Creates a new icon for a file. + a #GIcon for the given + filename="gio/gfileicon.c" + line="172">a #GIcon for the given @file, or %NULL on error. a #GFile. + filename="gio/gfileicon.c" + line="168">a #GFile. @@ -57498,21 +58281,20 @@ to be used as icon. c:identifier="g_file_icon_get_file" glib:get-property="file"> Gets the #GFile associated with the given @icon. - + filename="gio/gfileicon.c" + line="183">Gets the #GFile associated with the given @icon. + a #GFile. + filename="gio/gfileicon.c" + line="189">a #GFile. a #GIcon. + filename="gio/gfileicon.c" + line="185">a #GIcon. @@ -57523,8 +58305,8 @@ to be used as icon. transfer-ownership="none" getter="get_file"> The file containing the icon. + filename="gio/gfileicon.c" + line="150">The file containing the icon. @@ -57533,52 +58315,54 @@ to be used as icon. disguised="1" opaque="1" glib:is-gtype-struct-for="FileIcon"> - + An interface for writing VFS file handles. - + filename="gio/gfile.h" + line="42">An interface for writing VFS file handles. + The parent interface. + filename="gio/gfile.h" + line="44">The parent interface. + Duplicates a #GFile. - + a new #GFile that is a duplicate + filename="gio/gfile.c" + line="739">a new #GFile that is a duplicate of the given #GFile. input #GFile + filename="gio/gfile.c" + line="726">input #GFile + Creates a hash of a #GFile. - + 0 if @file is not a valid #GFile, otherwise an + filename="gio/gfile.c" + line="762">0 if @file is not a valid #GFile, otherwise an integer that can be used as hash value for the #GFile. This function is intended for easily hashing a #GFile to add to a #GHashTable or similar data structure. @@ -57587,67 +58371,73 @@ to be used as icon. #gconstpointer to a #GFile + filename="gio/gfile.c" + line="756">#gconstpointer to a #GFile + Checks equality of two given #GFiles. - + %TRUE if @file1 and @file2 are equal. + filename="gio/gfile.c" + line="792">%TRUE if @file1 and @file2 are equal. the first #GFile + filename="gio/gfile.c" + line="781">the first #GFile the second #GFile + filename="gio/gfile.c" + line="782">the second #GFile + Checks to see if a file is native to the system. - + %TRUE if @file is native + filename="gio/gfile.c" + line="460">%TRUE if @file is native input #GFile + filename="gio/gfile.c" + line="446">input #GFile + Checks to see if a #GFile has a given URI scheme. - + %TRUE if #GFile's backend supports the + filename="gio/gfile.c" + line="484">%TRUE if #GFile's backend supports the given URI scheme, %FALSE if URI scheme is %NULL, not supported, or #GFile is invalid. @@ -57655,27 +58445,29 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="477">input #GFile a string containing a URI scheme + filename="gio/gfile.c" + line="478">a string containing a URI scheme + Gets the URI scheme for a #GFile. - + a string containing the URI scheme for the given + filename="gio/gfile.c" + line="519">a string containing the URI scheme for the given #GFile or %NULL if the #GFile was constructed with an invalid URI. The returned string should be freed with g_free() when no longer needed. @@ -57683,21 +58475,23 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="505">input #GFile + Gets the basename for a given #GFile. - + string containing the #GFile's + filename="gio/gfile.c" + line="554">string containing the #GFile's base name, or %NULL if given #GFile is invalid. The returned string should be freed with g_free() when no longer needed. @@ -57705,21 +58499,23 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="538">input #GFile + Gets the current path within a #GFile. - + string containing the #GFile's path, + filename="gio/gfile.c" + line="579">string containing the #GFile's path, or %NULL if no such path exists. The returned string should be freed with g_free() when no longer needed. @@ -57727,21 +58523,23 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="572">input #GFile + Gets a URI for the path within a #GFile. - + a string containing the #GFile's URI. If the #GFile was constructed + filename="gio/gfile.c" + line="672">a string containing the #GFile's URI. If the #GFile was constructed with an invalid URI, an invalid URI is returned. The returned string should be freed with g_free() when no longer needed. @@ -57750,21 +58548,23 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="666">input #GFile + Gets the parsed name for the #GFile. - + a string containing the #GFile's parse name. + filename="gio/gfile.c" + line="708">a string containing the #GFile's parse name. The returned string should be freed with g_free() when no longer needed. @@ -57772,21 +58572,23 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="691">input #GFile + Gets the parent directory for the #GFile. - + a #GFile structure to the + filename="gio/gfile.c" + line="825">a #GFile structure to the parent of the given #GFile or %NULL if there is no parent. Free the returned object with g_object_unref(). @@ -57794,48 +58596,52 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="817">input #GFile + Checks whether a #GFile contains a specified file. - + %TRUE if the @file's parent, grandparent, etc is @prefix, + filename="gio/gfile.c" + line="965">%TRUE if the @file's parent, grandparent, etc is @prefix, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="948">input #GFile input #GFile + filename="gio/gfile.c" + line="947">input #GFile + Gets the path for a #GFile relative to a given path. - + string with the relative path from + filename="gio/gfile.c" + line="997">string with the relative path from @descendant to @parent, or %NULL if @descendant doesn't have @parent as prefix. The returned string should be freed with g_free() when no longer needed. @@ -57844,53 +58650,57 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="990">input #GFile input #GFile + filename="gio/gfile.c" + line="991">input #GFile + Resolves a relative path for a #GFile to an absolute path. - + a #GFile for the resolved path. + filename="gio/gfile.c" + line="1031">a #GFile for the resolved path. input #GFile + filename="gio/gfile.c" + line="1021">input #GFile a given relative path string + filename="gio/gfile.c" + line="1022">a given relative path string + Gets the child #GFile for a given display name. - + a #GFile to the specified child, or + filename="gio/gfile.c" + line="926">a #GFile to the specified child, or %NULL if the display name couldn't be converted. Free the returned object with g_object_unref(). @@ -57898,47 +58708,49 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="913">input #GFile string to a possible child + filename="gio/gfile.c" + line="914">string to a possible child + Gets a #GFileEnumerator with the children of a #GFile. - + A #GFileEnumerator if successful, + filename="gio/gfile.c" + line="1082">A #GFileEnumerator if successful, %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1049">input #GFile an attribute query string + filename="gio/gfile.c" + line="1050">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1051">a set of #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1052">optional #GCancellable object, %NULL to ignore @@ -57955,35 +58767,37 @@ to be used as icon. + Asynchronously gets a #GFileEnumerator with the children of a #GFile. - + input #GFile + filename="gio/gfile.c" + line="1115">input #GFile an attribute query string + filename="gio/gfile.c" + line="1116">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1117">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1118">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1119">optional #GCancellable object, %NULL to ignore @@ -58003,9 +58817,9 @@ to be used as icon. scope="async" closure="6"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gfile.c" + line="1121">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="6"> the data to pass to callback function + filename="gio/gfile.c" + line="1123">the data to pass to callback function + Finishes asynchronously enumerating the children. - + a #GFileEnumerator or %NULL + filename="gio/gfile.c" + line="1168">a #GFileEnumerator or %NULL if an error occurred. Free the returned object with g_object_unref(). @@ -58036,47 +58852,49 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="1161">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1162">a #GAsyncResult + Gets the #GFileInfo for a #GFile. - + a #GFileInfo for the given @file, or %NULL + filename="gio/gfile.c" + line="1320">a #GFileInfo for the given @file, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1282">input #GFile an attribute query string + filename="gio/gfile.c" + line="1283">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1284">a set of #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1285">optional #GCancellable object, %NULL to ignore @@ -58093,35 +58911,37 @@ to be used as icon. + Asynchronously gets the #GFileInfo for a #GFile. - + input #GFile + filename="gio/gfile.c" + line="1352">input #GFile an attribute query string + filename="gio/gfile.c" + line="1353">an attribute query string a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="1354">a set of #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1355">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1356">optional #GCancellable object, %NULL to ignore @@ -58141,9 +58961,9 @@ to be used as icon. scope="async" closure="6"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gfile.c" + line="1358">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="6"> the data to pass to callback function + filename="gio/gfile.c" + line="1360">the data to pass to callback function + Finishes an asynchronous query info operation. - + #GFileInfo for given @file + filename="gio/gfile.c" + line="1404">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -58174,41 +58996,43 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="1397">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1398">a #GAsyncResult + Gets a #GFileInfo for the file system #GFile is on. - + a #GFileInfo or %NULL if there was an error. + filename="gio/gfile.c" + line="1459">a #GFileInfo or %NULL if there was an error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1427">input #GFile an attribute query string + filename="gio/gfile.c" + line="1428">an attribute query string nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1429">optional #GCancellable object, %NULL to ignore @@ -58225,29 +59049,31 @@ to be used as icon. + Asynchronously gets a #GFileInfo for the file system #GFile is on. - + input #GFile + filename="gio/gfile.c" + line="1490">input #GFile an attribute query string + filename="gio/gfile.c" + line="1491">an attribute query string the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1492">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1493">optional #GCancellable object, %NULL to ignore @@ -58267,9 +59093,9 @@ to be used as icon. scope="async" closure="5"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="1495">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="1497">the data to pass to callback function + Finishes asynchronously getting the file system info. - + #GFileInfo for given @file + filename="gio/gfile.c" + line="1541">#GFileInfo for given @file or %NULL on error. Free the returned object with g_object_unref(). @@ -58300,27 +59128,29 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="1534">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1535">a #GAsyncResult + Gets a #GMount for the #GFile. - + a #GMount where the @file is located + filename="gio/gfile.c" + line="1579">a #GMount where the @file is located or %NULL on error. Free the returned object with g_object_unref(). @@ -58328,8 +59158,8 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="1564">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1565">optional #GCancellable object, %NULL to ignore @@ -58346,23 +59176,25 @@ to be used as icon. + Asynchronously gets the #GMount for a #GFile. - + a #GFile + filename="gio/gfile.c" + line="1613">a #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="1614">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1615">optional #GCancellable object, %NULL to ignore @@ -58382,9 +59214,9 @@ to be used as icon. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="1617">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="1619">the data to pass to callback function + Finishes asynchronously getting the volume. - + #GMount for given @file or %NULL on error. + filename="gio/gfile.c" + line="1658">#GMount for given @file or %NULL on error. Free the returned object with g_object_unref(). a #GFile + filename="gio/gfile.c" + line="1651">a #GFile a #GAsyncResult + filename="gio/gfile.c" + line="1652">a #GAsyncResult + Sets the display name for a #GFile. - + a #GFile specifying what @file was renamed to, + filename="gio/gfile.c" + line="4713">a #GFile specifying what @file was renamed to, or %NULL if there was an error. Free the returned object with g_object_unref(). @@ -58442,14 +59278,14 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="4691">input #GFile a string + filename="gio/gfile.c" + line="4692">a string nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4693">optional #GCancellable object, %NULL to ignore @@ -58466,29 +59302,31 @@ to be used as icon. + Asynchronously sets a #GFile's display name. - + input #GFile + filename="gio/gfile.c" + line="4747">input #GFile a string + filename="gio/gfile.c" + line="4748">a string the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4749">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4750">optional #GCancellable object, %NULL to ignore @@ -58508,9 +59346,9 @@ to be used as icon. scope="async" closure="5"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="4752">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="4754">the data to pass to callback function + Finishes asynchronously setting a #GFile's display name. - + a #GFile or %NULL on error. + filename="gio/gfile.c" + line="4796">a #GFile or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="4789">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4790">a #GAsyncResult + Returns a list of #GFileAttributeInfos that can be set. - + a #GFileAttributeInfoList describing the settable attributes. + filename="gio/gfile.c" + line="4834">a #GFileAttributeInfoList describing the settable attributes. When you are done with it, release it with g_file_attribute_info_list_unref() input #GFile + filename="gio/gfile.c" + line="4818">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4819">optional #GCancellable object, %NULL to ignore @@ -58587,31 +59429,37 @@ to be used as icon. + Asynchronously gets a list of #GFileAttributeInfos that can be set. - + + Finishes asynchronously querying settable attributes. - + + Returns a list of #GFileAttributeInfo namespaces that are writable. - + a #GFileAttributeInfoList describing the writable namespaces. + filename="gio/gfile.c" + line="4889">a #GFileAttributeInfoList describing the writable namespaces. When you are done with it, release it with g_file_attribute_info_list_unref() input #GFile + filename="gio/gfile.c" + line="4876">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4877">optional #GCancellable object, %NULL to ignore @@ -58638,50 +59486,56 @@ to be used as icon. + Asynchronously gets a list of #GFileAttributeInfo namespaces that are writable. - + + Finishes asynchronously querying the writable namespaces. - + + Sets a #GFileAttributeInfo. - + %TRUE if the attribute was set, %FALSE otherwise. + filename="gio/gfile.c" + line="4955">%TRUE if the attribute was set, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4936">input #GFile a string containing the attribute's name + filename="gio/gfile.c" + line="4937">a string containing the attribute's name The type of the attribute + filename="gio/gfile.c" + line="4938">The type of the attribute nullable="1" allow-none="1"> a pointer to the value (or the pointer + filename="gio/gfile.c" + line="4939">a pointer to the value (or the pointer itself if the type is a pointer type) a set of #GFileQueryInfoFlags + filename="gio/gfile.c" + line="4941">a set of #GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4942">optional #GCancellable object, %NULL to ignore @@ -58714,32 +59568,34 @@ to be used as icon. + Sets a #GFileAttributeInfo with information from a #GFileInfo. - + %FALSE if there was any error, %TRUE otherwise. + filename="gio/gfile.c" + line="5009">%FALSE if there was any error, %TRUE otherwise. input #GFile + filename="gio/gfile.c" + line="4989">input #GFile a #GFileInfo + filename="gio/gfile.c" + line="4990">a #GFileInfo #GFileQueryInfoFlags + filename="gio/gfile.c" + line="4991">#GFileQueryInfoFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4992">optional #GCancellable object, %NULL to ignore @@ -58756,35 +59612,37 @@ to be used as icon. + Asynchronously sets a file's attributes. - + input #GFile + filename="gio/gfile.c" + line="5080">input #GFile a #GFileInfo + filename="gio/gfile.c" + line="5081">a #GFileInfo a #GFileQueryInfoFlags + filename="gio/gfile.c" + line="5082">a #GFileQueryInfoFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="5083">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5084">optional #GCancellable object, %NULL to ignore @@ -58804,8 +59662,9 @@ to be used as icon. scope="async" closure="6"> a #GAsyncReadyCallback + filename="gio/gfile.c" + line="5086">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="6"> a #gpointer + filename="gio/gfile.c" + line="5088">the data to pass to callback function + Finishes setting a file's attributes asynchronously. - + %TRUE if the attributes were set correctly, %FALSE otherwise. + filename="gio/gfile.c" + line="5132">%TRUE if the attributes were set correctly, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5125">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5126">a #GAsyncResult caller-allocates="0" transfer-ownership="full"> a #GFileInfo + filename="gio/gfile.c" + line="5127">a #GFileInfo + Reads a file asynchronously. - + #GFileInputStream or %NULL on error. + filename="gio/gfile.c" + line="1697">#GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). #GFile to read + filename="gio/gfile.c" + line="1681">#GFile to read nullable="1" allow-none="1"> a #GCancellable + filename="gio/gfile.c" + line="1682">a #GCancellable + Asynchronously reads a file. - + input #GFile + filename="gio/gfile.c" + line="2100">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2101">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2102">optional #GCancellable object, %NULL to ignore @@ -58923,9 +59788,9 @@ to be used as icon. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2104">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="2106">the data to pass to callback function + Finishes asynchronously reading a file. - + a #GFileInputStream or %NULL on error. + filename="gio/gfile.c" + line="2145">a #GFileInputStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2138">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2139">a #GAsyncResult + Writes to the end of a file. - + a #GFileOutputStream, or %NULL on error. + filename="gio/gfile.c" + line="1751">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1727">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1728">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1729">optional #GCancellable object, %NULL to ignore @@ -59006,29 +59875,31 @@ to be used as icon. + Asynchronously writes to the end of a file. - + input #GFile + filename="gio/gfile.c" + line="2167">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2168">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2169">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2170">optional #GCancellable object, %NULL to ignore @@ -59048,9 +59919,9 @@ to be used as icon. scope="async" closure="5"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2172">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="2174">the data to pass to callback function + Finishes an asynchronous file append operation. - + a valid #GFileOutputStream + filename="gio/gfile.c" + line="2215">a valid #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). @@ -59081,27 +59954,29 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="2208">input #GFile #GAsyncResult + filename="gio/gfile.c" + line="2209">#GAsyncResult + Creates a new file. - + a #GFileOutputStream for the newly created + filename="gio/gfile.c" + line="1808">a #GFileOutputStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -59109,14 +59984,14 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="1782">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1783">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1784">optional #GCancellable object, %NULL to ignore @@ -59133,29 +60008,31 @@ to be used as icon. + Asynchronously creates a file. - + input #GFile + filename="gio/gfile.c" + line="2238">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2239">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2240">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2241">optional #GCancellable object, %NULL to ignore @@ -59175,9 +60052,9 @@ to be used as icon. scope="async" closure="5"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2243">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="2245">the data to pass to callback function + Finishes asynchronously creating a file. - + a #GFileOutputStream or %NULL on error. + filename="gio/gfile.c" + line="2287">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2280">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2281">a #GAsyncResult + Replaces the contents of a file. - + a #GFileOutputStream or %NULL on error. + filename="gio/gfile.c" + line="1891">a #GFileOutputStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="1840">input #GFile nullable="1" allow-none="1"> an optional [entity tag][gfile-etag] + filename="gio/gfile.c" + line="1841">an optional [entity tag](#entity-tags) for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="1843">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1844">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1845">optional #GCancellable object, %NULL to ignore @@ -59274,17 +60155,19 @@ to be used as icon. + Asynchronously replaces the contents of a file. - + input #GFile + filename="gio/gfile.c" + line="2309">input #GFile nullable="1" allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + filename="gio/gfile.c" + line="2310">an [entity tag](#entity-tags) for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="2312">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2313">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2314">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2315">optional #GCancellable object, %NULL to ignore @@ -59332,9 +60215,9 @@ to be used as icon. scope="async" closure="7"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2317">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="7"> the data to pass to callback function + filename="gio/gfile.c" + line="2319">the data to pass to callback function + Finishes asynchronously replacing a file. - + a #GFileOutputStream, or %NULL on error. + filename="gio/gfile.c" + line="2365">a #GFileOutputStream, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2358">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2359">a #GAsyncResult + Deletes a file. - + %TRUE if the file was deleted. %FALSE otherwise. + filename="gio/gfile.c" + line="4495">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4468">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4469">optional #GCancellable object, %NULL to ignore @@ -59408,23 +60295,25 @@ to be used as icon. + Asynchronously deletes a file. - + input #GFile + filename="gio/gfile.c" + line="4524">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4525">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4526">optional #GCancellable object, %NULL to ignore @@ -59444,8 +60333,8 @@ to be used as icon. scope="async" closure="4"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4528">a #GAsyncReadyCallback to call when the request is satisfied @@ -59455,54 +60344,58 @@ to be used as icon. allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="4530">the data to pass to callback function + Finishes an asynchronous delete. - + %TRUE if the file was deleted. %FALSE otherwise. + filename="gio/gfile.c" + line="4565">%TRUE if the file was deleted. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4559">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4560">a #GAsyncResult + Sends a #GFile to the Trash location. - + %TRUE on successful trash, %FALSE otherwise. + filename="gio/gfile.c" + line="4603">%TRUE on successful trash, %FALSE otherwise. #GFile to send to trash + filename="gio/gfile.c" + line="4587">#GFile to send to trash nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4588">optional #GCancellable object, %NULL to ignore @@ -59519,23 +60412,25 @@ to be used as icon. + Asynchronously sends a #GFile to the Trash location. - + input #GFile + filename="gio/gfile.c" + line="4632">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4633">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4634">optional #GCancellable object, %NULL to ignore @@ -59555,8 +60450,8 @@ to be used as icon. scope="async" closure="4"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4636">a #GAsyncReadyCallback to call when the request is satisfied @@ -59566,54 +60461,58 @@ to be used as icon. allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="4638">the data to pass to callback function + Finishes an asynchronous file trashing operation. - + %TRUE on successful trash, %FALSE otherwise. + filename="gio/gfile.c" + line="4672">%TRUE on successful trash, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4665">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4666">a #GAsyncResult + Makes a directory. - + %TRUE on successful creation, %FALSE otherwise. + filename="gio/gfile.c" + line="4088">%TRUE on successful creation, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4068">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4069">optional #GCancellable object, %NULL to ignore @@ -59630,23 +60529,25 @@ to be used as icon. + Asynchronously makes a directory. - + input #GFile + filename="gio/gfile.c" + line="4117">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4118">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4119">optional #GCancellable object, %NULL to ignore @@ -59666,8 +60567,8 @@ to be used as icon. scope="async" closure="4"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4121">a #GAsyncReadyCallback to call when the request is satisfied @@ -59677,60 +60578,65 @@ to be used as icon. allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="4123">the data to pass to callback function + Finishes making a directory asynchronously. - + %TRUE on successful directory creation, %FALSE otherwise. + filename="gio/gfile.c" + line="4157">%TRUE on successful directory creation, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4150">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4151">a #GAsyncResult + Makes a symbolic link. %NULL if symbolic + links are unsupported. - + %TRUE on the creation of a new symlink, %FALSE otherwise. + filename="gio/gfile.c" + line="4312">%TRUE on the creation of a new symlink, %FALSE otherwise. a #GFile with the name of the symlink to create + filename="gio/gfile.c" + line="4298">a #GFile with the name of the symlink to create a string with the path for the target + filename="gio/gfile.c" + line="4299">a string with the path for the target of the new symlink @@ -59739,8 +60645,8 @@ to be used as icon. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4301">optional #GCancellable object, %NULL to ignore @@ -59748,30 +60654,32 @@ to be used as icon. + Asynchronously makes a symbolic link - + a #GFile with the name of the symlink to create + filename="gio/gfile.c" + line="4389">a #GFile with the name of the symlink to create a string with the path for the target + filename="gio/gfile.c" + line="4390">a string with the path for the target of the new symlink the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="4392">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="4393">optional #GCancellable object, %NULL to ignore @@ -59791,8 +60699,8 @@ to be used as icon. scope="async" closure="5"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="4395">a #GAsyncReadyCallback to call when the request is satisfied @@ -59802,66 +60710,72 @@ to be used as icon. allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="4397">the data to pass to callback function + Finishes making a symbolic link asynchronously. - + %TRUE on successful directory creation, %FALSE otherwise. + filename="gio/gfile.c" + line="4446">%TRUE on successful directory creation, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="4439">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4440">a #GAsyncResult + Copies a file. %NULL if copying is unsupported, which will + cause `GFile` to use a fallback copy method where it reads from the + source and writes to the destination. - + %TRUE on success, %FALSE otherwise. + filename="gio/gfile.c" + line="3691">%TRUE on success, %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="3640">input #GFile destination #GFile + filename="gio/gfile.c" + line="3641">destination #GFile set of #GFileCopyFlags + filename="gio/gfile.c" + line="3642">set of #GFileCopyFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3643">optional #GCancellable object, %NULL to ignore @@ -59881,8 +60795,8 @@ to be used as icon. scope="call" closure="5"> function to callback with + filename="gio/gfile.c" + line="3645">function to callback with progress information, or %NULL if progress information is not needed @@ -59892,43 +60806,45 @@ to be used as icon. nullable="1" allow-none="1"> user data to pass to @progress_callback + filename="gio/gfile.c" + line="3647">user data to pass to @progress_callback + Asynchronously copies a file. - + input #GFile + filename="gio/gfile.c" + line="3768">input #GFile destination #GFile + filename="gio/gfile.c" + line="3769">destination #GFile set of #GFileCopyFlags + filename="gio/gfile.c" + line="3770">set of #GFileCopyFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="3771">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3772">optional #GCancellable object, %NULL to ignore @@ -59948,20 +60864,20 @@ to be used as icon. scope="notified" closure="6"> function to callback with progress - information, or %NULL if progress information is not needed + filename="gio/gfile.c" + line="3774"> + function to callback with progress information, or %NULL if + progress information is not needed + allow-none="1"> user data to pass to @progress_callback + filename="gio/gfile.c" + line="3777">user data to pass to @progress_callback scope="async" closure="8"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gfile.c" + line="3778">a #GAsyncReadyCallback + to call when the request is satisfied + closure="8"> the data to pass to callback function + filename="gio/gfile.c" + line="3780">the data to pass to callback + Finishes an asynchronous copy operation. - + a %TRUE on success, %FALSE on error. + filename="gio/gfile.c" + line="3829">a %TRUE on success, %FALSE on error. input #GFile + filename="gio/gfile.c" + line="3823">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="3824">a #GAsyncResult + Moves a file. - + %TRUE on successful move, %FALSE otherwise. + filename="gio/gfile.c" + line="3895">%TRUE on successful move, %FALSE otherwise. #GFile pointing to the source location + filename="gio/gfile.c" + line="3850">#GFile pointing to the source location #GFile pointing to the destination location + filename="gio/gfile.c" + line="3851">#GFile pointing to the destination location set of #GFileCopyFlags + filename="gio/gfile.c" + line="3852">set of #GFileCopyFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3853">optional #GCancellable object, %NULL to ignore @@ -60060,8 +60981,8 @@ to be used as icon. scope="call" closure="5"> #GFileProgressCallback + filename="gio/gfile.c" + line="3855">#GFileProgressCallback function for updates @@ -60071,8 +60992,8 @@ to be used as icon. nullable="1" allow-none="1"> gpointer to user data for + filename="gio/gfile.c" + line="3857">gpointer to user data for the callback function @@ -60080,35 +61001,37 @@ to be used as icon. + Asynchronously moves a file. Since: 2.72 - + #GFile pointing to the source location + filename="gio/gfile.c" + line="3984">#GFile pointing to the source location #GFile pointing to the destination location + filename="gio/gfile.c" + line="3985">#GFile pointing to the destination location set of #GFileCopyFlags + filename="gio/gfile.c" + line="3986">set of #GFileCopyFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="3987">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="3988">optional #GCancellable object, %NULL to ignore @@ -60128,9 +61051,9 @@ to be used as icon. scope="call" closure="6"> #GFileProgressCallback - function for updates + filename="gio/gfile.c" + line="3990"> + #GFileProgressCallback function for updates @@ -60139,9 +61062,8 @@ to be used as icon. nullable="1" allow-none="1"> gpointer to user data for - the callback function + filename="gio/gfile.c" + line="3992">gpointer to user data for the callback function scope="async" closure="8"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="3993">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="8"> the data to pass to callback function + filename="gio/gfile.c" + line="3995">the data to pass to callback function + Finishes an asynchronous move operation. Since: 2.72 - + %TRUE on successful file move, %FALSE otherwise. + filename="gio/gfile.c" + line="4047">%TRUE on successful file move, %FALSE otherwise. input source #GFile + filename="gio/gfile.c" + line="4040">input source #GFile a #GAsyncResult + filename="gio/gfile.c" + line="4041">a #GAsyncResult + Mounts a mountable object. - + input #GFile + filename="gio/gfile.c" + line="5351">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5352">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="5353">a #GMountOperation, or %NULL to avoid user interaction @@ -60230,8 +61156,8 @@ to be used as icon. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5355">optional #GCancellable object, %NULL to ignore @@ -60242,9 +61168,9 @@ to be used as icon. scope="async" closure="5"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5357">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="5359">the data to pass to callback function + Finishes a mounting operation. - + a #GFile or %NULL on error. + filename="gio/gfile.c" + line="5415">a #GFile or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="5406">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5407">a #GAsyncResult + Unmounts a mountable object. - + input #GFile + filename="gio/gfile.c" + line="5439">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5440">flags affecting the operation nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5441">optional #GCancellable object, %NULL to ignore @@ -60324,9 +61254,9 @@ to be used as icon. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5443">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="5445">the data to pass to callback function + Finishes an unmount operation. - + %TRUE if the operation finished successfully. + filename="gio/gfile.c" + line="5499">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5490">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5491">a #GAsyncResult + Ejects a mountable. - + input #GFile + filename="gio/gfile.c" + line="5627">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5628">flags affecting the operation nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5629">optional #GCancellable object, %NULL to ignore @@ -60406,9 +61340,9 @@ to be used as icon. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5631">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="5633">the data to pass to callback function + Finishes an eject operation. - + %TRUE if the @file was ejected successfully. + filename="gio/gfile.c" + line="5684">%TRUE if the @file was ejected successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5677">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5678">a #GAsyncResult + Mounts a specified location. - + input #GFile + filename="gio/gfile.c" + line="7563">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="7564">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation + filename="gio/gfile.c" + line="7565">a #GMountOperation or %NULL to avoid user interaction @@ -60486,8 +61424,8 @@ to be used as icon. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="7567">optional #GCancellable object, %NULL to ignore @@ -60498,8 +61436,8 @@ to be used as icon. scope="async" closure="5"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="7569">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -60509,21 +61447,23 @@ to be used as icon. allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="7571">the data to pass to callback function + Finishes mounting a specified location. - + %TRUE if successful. If an error has occurred, + filename="gio/gfile.c" + line="7619">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -60531,42 +61471,43 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="7613">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="7614">a #GAsyncResult + Creates a #GFileMonitor for the location. - + a #GFileMonitor for the given @file, - or %NULL on error. - Free the returned object with g_object_unref(). + filename="gio/gfile.c" + line="5827">a #GFileMonitor for the given @file, + or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="5808">input #GFile a set of #GFileMonitorFlags + filename="gio/gfile.c" + line="5809">a set of #GFileMonitorFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5810">optional #GCancellable object, %NULL to ignore @@ -60583,13 +61524,15 @@ to be used as icon. + Creates a #GFileMonitor for the location. - + a #GFileMonitor for the given @file, + filename="gio/gfile.c" + line="5880">a #GFileMonitor for the given @file, or %NULL on error. Free the returned object with g_object_unref(). @@ -60597,14 +61540,14 @@ to be used as icon. input #GFile + filename="gio/gfile.c" + line="5859">input #GFile a set of #GFileMonitorFlags + filename="gio/gfile.c" + line="5860">a set of #GFileMonitorFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5861">optional #GCancellable object, %NULL to ignore @@ -60621,21 +61564,23 @@ to be used as icon. + Open file read/write. Since 2.22. - + #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="1949">#GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). #GFile to open + filename="gio/gfile.c" + line="1928">#GFile to open nullable="1" allow-none="1"> a #GCancellable + filename="gio/gfile.c" + line="1929">a #GCancellable + Asynchronously opens file read/write. Since 2.22. - + input #GFile + filename="gio/gfile.c" + line="2387">input #GFile the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2388">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2389">optional #GCancellable object, %NULL to ignore @@ -60687,9 +61634,9 @@ to be used as icon. scope="async" closure="4"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2391">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfile.c" + line="2393">the data to pass to callback function + Finishes an asynchronous open read/write. Since 2.22. - + a #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="2434">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2427">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2428">a #GAsyncResult + Creates file read/write. Since 2.22. - + a #GFileIOStream for the newly created + filename="gio/gfile.c" + line="2011">a #GFileIOStream for the newly created file, or %NULL on error. Free the returned object with g_object_unref(). @@ -60747,14 +61698,14 @@ to be used as icon. a #GFile + filename="gio/gfile.c" + line="1981">a #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="1982">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="1983">optional #GCancellable object, %NULL to ignore @@ -60771,29 +61722,31 @@ to be used as icon. + Asynchronously creates file read/write. Since 2.22. - + input #GFile + filename="gio/gfile.c" + line="2458">input #GFile a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2459">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2460">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2461">optional #GCancellable object, %NULL to ignore @@ -60813,9 +61766,9 @@ to be used as icon. scope="async" closure="5"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2463">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="2465">the data to pass to callback function + Finishes an asynchronous creates read/write. Since 2.22. - + a #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="2509">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2502">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2503">a #GAsyncResult + Replaces file read/write. Since 2.22. - + a #GFileIOStream or %NULL on error. + filename="gio/gfile.c" + line="2065">a #GFileIOStream or %NULL on error. Free the returned object with g_object_unref(). a #GFile + filename="gio/gfile.c" + line="2045">a #GFile nullable="1" allow-none="1"> an optional [entity tag][gfile-etag] + filename="gio/gfile.c" + line="2046">an optional [entity tag](#entity-tags) for the current #GFile, or #NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="2048">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2049">a set of #GFileCreateFlags nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2050">optional #GCancellable object, %NULL to ignore @@ -60912,17 +61869,19 @@ to be used as icon. + Asynchronously replaces file read/write. Since 2.22. - + input #GFile + filename="gio/gfile.c" + line="2533">input #GFile nullable="1" allow-none="1"> an [entity tag][gfile-etag] for the current #GFile, + filename="gio/gfile.c" + line="2534">an [entity tag](#entity-tags) for the current #GFile, or %NULL to ignore %TRUE if a backup should be created + filename="gio/gfile.c" + line="2536">%TRUE if a backup should be created a set of #GFileCreateFlags + filename="gio/gfile.c" + line="2537">a set of #GFileCreateFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="2538">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="2539">optional #GCancellable object, %NULL to ignore @@ -60970,9 +61929,9 @@ to be used as icon. scope="async" closure="7"> a #GAsyncReadyCallback to call - when the request is satisfied + filename="gio/gfile.c" + line="2541">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="7"> the data to pass to callback function + filename="gio/gfile.c" + line="2543">the data to pass to callback function + Finishes an asynchronous replace read/write. Since 2.22. - + a #GFileIOStream, or %NULL on error. + filename="gio/gfile.c" + line="2592">a #GFileIOStream, or %NULL on error. Free the returned object with g_object_unref(). input #GFile + filename="gio/gfile.c" + line="2585">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="2586">a #GAsyncResult + Starts a mountable object. Since 2.22. - + input #GFile + filename="gio/gfile.c" + line="8964">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="8965">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, or %NULL to avoid user interaction + filename="gio/gfile.c" + line="8966">a #GMountOperation, or %NULL to avoid user interaction nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="8967">optional #GCancellable object, %NULL to ignore scope="async" closure="5"> a #GAsyncReadyCallback to call when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="8968">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="8969">the data to pass to callback function + Finishes a start operation. Since 2.22. - + %TRUE if the operation finished successfully. %FALSE + filename="gio/gfile.c" + line="9027">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="9018">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="9019">a #GAsyncResult + Stops a mountable. Since 2.22. - + input #GFile + filename="gio/gfile.c" + line="9053">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="9054">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="9055">a #GMountOperation, or %NULL to avoid user interaction. @@ -61139,8 +62106,8 @@ otherwise. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="9057">optional #GCancellable object, %NULL to ignore @@ -61151,8 +62118,8 @@ otherwise. scope="async" closure="5"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="9059">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -61162,35 +62129,37 @@ otherwise. allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="9061">the data to pass to callback function + Finishes a stop operation. Since 2.22. - + %TRUE if the operation finished successfully. + filename="gio/gfile.c" + line="9117">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="9108">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="9109">a #GAsyncResult @@ -61198,28 +62167,30 @@ otherwise. a boolean that indicates whether the #GFile implementation supports thread-default contexts. Since 2.22. + filename="gio/gfile.h" + line="141">a boolean that indicates whether the #GFile implementation supports thread-default contexts. Since 2.22. + Unmounts a mountable object using a #GMountOperation. Since 2.22. - + input #GFile + filename="gio/gfile.c" + line="5526">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5527">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="5528">a #GMountOperation, or %NULL to avoid user interaction @@ -61237,8 +62208,8 @@ otherwise. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5530">optional #GCancellable object, %NULL to ignore @@ -61249,9 +62220,9 @@ otherwise. scope="async" closure="5"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5532">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="5534">the data to pass to callback function + Finishes an unmount operation using a #GMountOperation. Since 2.22. - + %TRUE if the operation finished successfully. + filename="gio/gfile.c" + line="5598">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5588">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5589">a #GAsyncResult + Ejects a mountable object using a #GMountOperation. Since 2.22. - + input #GFile + filename="gio/gfile.c" + line="5711">input #GFile flags affecting the operation + filename="gio/gfile.c" + line="5712">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation, + filename="gio/gfile.c" + line="5713">a #GMountOperation, or %NULL to avoid user interaction @@ -61329,8 +62304,8 @@ otherwise. nullable="1" allow-none="1"> optional #GCancellable object, + filename="gio/gfile.c" + line="5715">optional #GCancellable object, %NULL to ignore @@ -61341,9 +62316,9 @@ otherwise. scope="async" closure="5"> a #GAsyncReadyCallback to call - when the request is satisfied, or %NULL + filename="gio/gfile.c" + line="5717">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfile.c" + line="5719">the data to pass to callback function + Finishes an eject operation using a #GMountOperation. Since 2.22. - + %TRUE if the @file was ejected successfully. + filename="gio/gfile.c" + line="5779">%TRUE if the @file was ejected successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="5772">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="5773">a #GAsyncResult + Polls a mountable object for media changes. Since 2.22. - + input #GFile + filename="gio/gfile.c" + line="9143">input #GFile nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="9144">optional #GCancellable object, %NULL to ignore scope="async" closure="3"> a #GAsyncReadyCallback to call + filename="gio/gfile.c" + line="9145">a #GAsyncReadyCallback to call when the request is satisfied, or %NULL @@ -61427,62 +62406,66 @@ otherwise. allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gfile.c" + line="9147">the data to pass to callback function + Finishes a poll operation for media changes. Since 2.22. - + %TRUE if the operation finished successfully. %FALSE + filename="gio/gfile.c" + line="9199">%TRUE if the operation finished successfully. %FALSE otherwise. input #GFile + filename="gio/gfile.c" + line="9190">input #GFile a #GAsyncResult + filename="gio/gfile.c" + line="9191">a #GAsyncResult - - - + + Recursively measures the disk usage of @file. Since 2.38 + + %TRUE if successful, with the out parameters set. + filename="gio/gfile.c" + line="8868">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. a #GFile + filename="gio/gfile.c" + line="8839">a #GFile #GFileMeasureFlags + filename="gio/gfile.c" + line="8840">#GFileMeasureFlags nullable="1" allow-none="1"> optional #GCancellable + filename="gio/gfile.c" + line="8841">optional #GCancellable a #GFileMeasureProgressCallback + filename="gio/gfile.c" + line="8842">a #GFileMeasureProgressCallback @@ -61510,8 +62494,8 @@ otherwise. nullable="1" allow-none="1"> user_data for @progress_callback + filename="gio/gfile.c" + line="8843">user_data for @progress_callback optional="1" allow-none="1"> the number of bytes of disk space used + filename="gio/gfile.c" + line="8844">the number of bytes of disk space used optional="1" allow-none="1"> the number of directories encountered + filename="gio/gfile.c" + line="8845">the number of directories encountered optional="1" allow-none="1"> the number of non-directories encountered + filename="gio/gfile.c" + line="8846">the number of non-directories encountered + Asynchronously recursively measures the disk usage of @file. Since 2.38 - + a #GFile + filename="gio/gfile.c" + line="8896">a #GFile #GFileMeasureFlags + filename="gio/gfile.c" + line="8897">#GFileMeasureFlags the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="8898">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable + filename="gio/gfile.c" + line="8899">optional #GCancellable allow-none="1" closure="5"> a #GFileMeasureProgressCallback + filename="gio/gfile.c" + line="8900">a #GFileMeasureProgressCallback @@ -61601,8 +62587,8 @@ otherwise. nullable="1" allow-none="1"> user_data for @progress_callback + filename="gio/gfile.c" + line="8901">user_data for @progress_callback scope="async" closure="7"> a #GAsyncReadyCallback to call when complete + filename="gio/gfile.c" + line="8902">a #GAsyncReadyCallback to call when complete allow-none="1" closure="7"> the data to pass to callback function + filename="gio/gfile.c" + line="8903">the data to pass to callback function + Finishes an asynchronous recursive measurement of the disk usage of @file. Since 2.38 - + %TRUE if successful, with the out parameters set. + filename="gio/gfile.c" + line="8943">%TRUE if successful, with the out parameters set. %FALSE otherwise, with @error set. a #GFile + filename="gio/gfile.c" + line="8932">a #GFile the #GAsyncResult passed to your #GAsyncReadyCallback + filename="gio/gfile.c" + line="8933">the #GAsyncResult passed to your #GAsyncReadyCallback optional="1" allow-none="1"> the number of bytes of disk space used + filename="gio/gfile.c" + line="8934">the number of bytes of disk space used optional="1" allow-none="1"> the number of directories encountered + filename="gio/gfile.c" + line="8935">the number of directories encountered optional="1" allow-none="1"> the number of non-directories encountered + filename="gio/gfile.c" + line="8936">the number of non-directories encountered @@ -61698,116 +62686,113 @@ otherwise. glib:get-type="g_file_info_get_type" glib:type-struct="FileInfoClass"> Functionality for manipulating basic metadata for files. #GFileInfo + filename="gio/gfileinfo.c" + line="23">Stores information about a file system object referenced by a [iface@Gio.File]. + +Functionality for manipulating basic metadata for files. `GFileInfo` implements methods for getting information that all files should contain, and allows for manipulation of extended attributes. -See [GFileAttribute][gio-GFileAttribute] for more information on how -GIO handles file attributes. +See [file-attributes.html](file attributes) for more information on how GIO +handles file attributes. -To obtain a #GFileInfo for a #GFile, use g_file_query_info() (or its -async variant). To obtain a #GFileInfo for a file input or output -stream, use g_file_input_stream_query_info() or -g_file_output_stream_query_info() (or their async variants). +To obtain a `GFileInfo` for a [iface@Gio.File], use +[method@Gio.File.query_info] (or its async variant). To obtain a `GFileInfo` +for a file input or output stream, use [method@Gio.FileInputStream.query_info] +or [method@Gio.FileOutputStream.query_info] (or their async variants). To change the actual attributes of a file, you should then set the -attribute in the #GFileInfo and call g_file_set_attributes_from_info() -or g_file_set_attributes_async() on a GFile. +attribute in the `GFileInfo` and call [method@Gio.File.set_attributes_from_info] +or [method@Gio.File.set_attributes_async] on a `GFile`. However, not all attributes can be changed in the file. For instance, -the actual size of a file cannot be changed via g_file_info_set_size(). -You may call g_file_query_settable_attributes() and -g_file_query_writable_namespaces() to discover the settable attributes +the actual size of a file cannot be changed via [method@Gio.FileInfo.set_size]. +You may call [method@Gio.File.query_settable_attributes] and +[method@Gio.File.query_writable_namespaces] to discover the settable attributes of a particular file at runtime. -The direct accessors, such as g_file_info_get_name(), are slightly more +The direct accessors, such as [method@Gio.FileInfo.get_name], are slightly more optimized than the generic attribute accessors, such as -g_file_info_get_attribute_byte_string().This optimization will matter +[method@Gio.FileInfo.get_attribute_byte_string].This optimization will matter only if calling the API in a tight loop. It is an error to call these accessors without specifying their required file -attributes when creating the #GFileInfo. Use g_file_info_has_attribute() or -g_file_info_list_attributes() to check what attributes are specified for a -#GFileInfo. - -#GFileAttributeMatcher allows for searching through a #GFileInfo for -attributes. - +attributes when creating the `GFileInfo`. Use +[method@Gio.FileInfo.has_attribute] or [method@Gio.FileInfo.list_attributes] +to check what attributes are specified for a `GFileInfo`. + +[struct@Gio.FileAttributeMatcher] allows for searching through a `GFileInfo` +for attributes. + Creates a new file info structure. - + filename="gio/gfileinfo.c" + line="380">Creates a new file info structure. + a #GFileInfo. + filename="gio/gfileinfo.c" + line="385">a #GFileInfo. Clears the status information from @info. - + filename="gio/gfileinfo.c" + line="511">Clears the status information from @info. + a #GFileInfo. + filename="gio/gfileinfo.c" + line="513">a #GFileInfo. First clears all of the [GFileAttribute][gio-GFileAttribute] of @dest_info, + filename="gio/gfileinfo.c" + line="393">First clears all of the [GFileAttribute][gio-GFileAttribute] of @dest_info, and then copies all of the file attributes from @src_info to @dest_info. - + source to copy attributes from. + filename="gio/gfileinfo.c" + line="395">source to copy attributes from. destination to copy attributes to. + filename="gio/gfileinfo.c" + line="396">destination to copy attributes to. Duplicates a file info structure. - + filename="gio/gfileinfo.c" + line="437">Duplicates a file info structure. + a duplicate #GFileInfo of @other. + filename="gio/gfileinfo.c" + line="443">a duplicate #GFileInfo of @other. a #GFileInfo. + filename="gio/gfileinfo.c" + line="439">a #GFileInfo. @@ -61816,8 +62801,8 @@ and then copies all of the file attributes from @src_info to @dest_info. c:identifier="g_file_info_get_access_date_time" version="2.70"> Gets the access time of the current @info and returns it as a + filename="gio/gfileinfo.c" + line="1945">Gets the access time of the current @info and returns it as a #GDateTime. It is an error to call this if the #GFileInfo does not contain @@ -61827,19 +62812,18 @@ precision. If nanosecond precision is needed, %G_FILE_ATTRIBUTE_TIME_ACCESS_NSEC must be queried separately using g_file_info_get_attribute_uint32(). - + access time, or %NULL if unknown + filename="gio/gfileinfo.c" + line="1960">access time, or %NULL if unknown a #GFileInfo. + filename="gio/gfileinfo.c" + line="1947">a #GFileInfo. @@ -61847,16 +62831,15 @@ be queried separately using g_file_info_get_attribute_uint32(). Gets the value of an attribute, formatted as a string. + filename="gio/gfileinfo.c" + line="871">Gets the value of an attribute, formatted as a string. This escapes things as needed to make the string valid UTF-8. - + a UTF-8 string associated with the given @attribute, or + filename="gio/gfileinfo.c" + line="880">a UTF-8 string associated with the given @attribute, or %NULL if the attribute wasn’t set. When you're done with the string it must be freed with g_free(). @@ -61864,14 +62847,14 @@ UTF-8. a #GFileInfo. + filename="gio/gfileinfo.c" + line="873">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="874">a file attribute key. @@ -61879,28 +62862,27 @@ UTF-8. Gets the value of a boolean attribute. If the attribute does not + filename="gio/gfileinfo.c" + line="1018">Gets the value of a boolean attribute. If the attribute does not contain a boolean value, %FALSE will be returned. - + the boolean value contained within the attribute. + filename="gio/gfileinfo.c" + line="1026">the boolean value contained within the attribute. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1020">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1021">a file attribute key. @@ -61908,29 +62890,28 @@ contain a boolean value, %FALSE will be returned. Gets the value of a byte string attribute. If the attribute does + filename="gio/gfileinfo.c" + line="944">Gets the value of a byte string attribute. If the attribute does not contain a byte string, %NULL will be returned. - + the contents of the @attribute value as a byte string, or + filename="gio/gfileinfo.c" + line="952">the contents of the @attribute value as a byte string, or %NULL otherwise. a #GFileInfo. + filename="gio/gfileinfo.c" + line="946">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="947">a file attribute key. @@ -61938,28 +62919,27 @@ not contain a byte string, %NULL will be returned. Gets the attribute type, value and status for an attribute key. - + filename="gio/gfileinfo.c" + line="754">Gets the attribute type, value and status for an attribute key. + %TRUE if @info has an attribute named @attribute, + filename="gio/gfileinfo.c" + line="765">%TRUE if @info has an attribute named @attribute, %FALSE otherwise. a #GFileInfo + filename="gio/gfileinfo.c" + line="756">a #GFileInfo a file attribute key + filename="gio/gfileinfo.c" + line="757">a file attribute key optional="1" allow-none="1"> return location for the attribute type, or %NULL + filename="gio/gfileinfo.c" + line="758">return location for the attribute type, or %NULL optional="1" allow-none="1"> return location for the + filename="gio/gfileinfo.c" + line="759">return location for the attribute value, or %NULL; the attribute value will not be %NULL @@ -61992,38 +62972,71 @@ not contain a byte string, %NULL will be returned. optional="1" allow-none="1"> return location for the attribute status, or %NULL + filename="gio/gfileinfo.c" + line="761">return location for the attribute status, or %NULL + + Gets the value of a byte string attribute as a file path. + +If the attribute does not contain a byte string, `NULL` will be returned. + +This function is meant to be used by language bindings that have specific +handling for Unix paths. + + + the contents of the @attribute value as +a file path, or %NULL otherwise. + + + + + a #GFileInfo. + + + + a file attribute key. + + + + Gets a signed 32-bit integer contained within the attribute. If the + filename="gio/gfileinfo.c" + line="1065">Gets a signed 32-bit integer contained within the attribute. If the attribute does not contain a signed 32-bit integer, or is invalid, 0 will be returned. - + a signed 32-bit integer from the attribute. + filename="gio/gfileinfo.c" + line="1074">a signed 32-bit integer from the attribute. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1067">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1068">a file attribute key. @@ -62031,29 +63044,28 @@ attribute does not contain a signed 32-bit integer, or is invalid, Gets a signed 64-bit integer contained within the attribute. If the + filename="gio/gfileinfo.c" + line="1113">Gets a signed 64-bit integer contained within the attribute. If the attribute does not contain a signed 64-bit integer, or is invalid, 0 will be returned. - + a signed 64-bit integer from the attribute. + filename="gio/gfileinfo.c" + line="1122">a signed 64-bit integer from the attribute. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1115">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1116">a file attribute key. @@ -62061,29 +63073,28 @@ attribute does not contain a signed 64-bit integer, or is invalid, Gets the value of a #GObject attribute. If the attribute does + filename="gio/gfileinfo.c" + line="896">Gets the value of a #GObject attribute. If the attribute does not contain a #GObject, %NULL will be returned. - + a #GObject associated with the given @attribute, + filename="gio/gfileinfo.c" + line="904">a #GObject associated with the given @attribute, or %NULL otherwise. a #GFileInfo. + filename="gio/gfileinfo.c" + line="898">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="899">a file attribute key. @@ -62091,28 +63102,27 @@ or %NULL otherwise. Gets the attribute status for an attribute key. - + filename="gio/gfileinfo.c" + line="796">Gets the attribute status for an attribute key. + a #GFileAttributeStatus for the given @attribute, or + filename="gio/gfileinfo.c" + line="803">a #GFileAttributeStatus for the given @attribute, or %G_FILE_ATTRIBUTE_STATUS_UNSET if the key is invalid. a #GFileInfo + filename="gio/gfileinfo.c" + line="798">a #GFileInfo a file attribute key + filename="gio/gfileinfo.c" + line="799">a file attribute key @@ -62120,29 +63130,28 @@ or %NULL otherwise. Gets the value of a string attribute. If the attribute does + filename="gio/gfileinfo.c" + line="920">Gets the value of a string attribute. If the attribute does not contain a string, %NULL will be returned. - + the contents of the @attribute value as a UTF-8 string, + filename="gio/gfileinfo.c" + line="928">the contents of the @attribute value as a UTF-8 string, or %NULL otherwise. a #GFileInfo. + filename="gio/gfileinfo.c" + line="922">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="923">a file attribute key. @@ -62151,15 +63160,14 @@ or %NULL otherwise. c:identifier="g_file_info_get_attribute_stringv" version="2.22"> Gets the value of a stringv attribute. If the attribute does + filename="gio/gfileinfo.c" + line="992">Gets the value of a stringv attribute. If the attribute does not contain a stringv, %NULL will be returned. - + the contents of the @attribute value as a stringv, + filename="gio/gfileinfo.c" + line="1000">the contents of the @attribute value as a stringv, or %NULL otherwise. Do not free. These returned strings are UTF-8. @@ -62168,14 +63176,14 @@ or %NULL otherwise. Do not free. These returned strings are UTF-8. a #GFileInfo. + filename="gio/gfileinfo.c" + line="994">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="995">a file attribute key. @@ -62183,28 +63191,27 @@ or %NULL otherwise. Do not free. These returned strings are UTF-8. Gets the attribute type for an attribute key. - + filename="gio/gfileinfo.c" + line="685">Gets the attribute type for an attribute key. + a #GFileAttributeType for the given @attribute, or + filename="gio/gfileinfo.c" + line="692">a #GFileAttributeType for the given @attribute, or %G_FILE_ATTRIBUTE_TYPE_INVALID if the key is not set. a #GFileInfo. + filename="gio/gfileinfo.c" + line="687">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="688">a file attribute key. @@ -62212,29 +63219,28 @@ or %NULL otherwise. Do not free. These returned strings are UTF-8. Gets an unsigned 32-bit integer contained within the attribute. If the + filename="gio/gfileinfo.c" + line="1041">Gets an unsigned 32-bit integer contained within the attribute. If the attribute does not contain an unsigned 32-bit integer, or is invalid, 0 will be returned. - + an unsigned 32-bit integer from the attribute. + filename="gio/gfileinfo.c" + line="1050">an unsigned 32-bit integer from the attribute. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1043">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1044">a file attribute key. @@ -62242,29 +63248,28 @@ attribute does not contain an unsigned 32-bit integer, or is invalid, Gets a unsigned 64-bit integer contained within the attribute. If the + filename="gio/gfileinfo.c" + line="1089">Gets a unsigned 64-bit integer contained within the attribute. If the attribute does not contain an unsigned 64-bit integer, or is invalid, 0 will be returned. - + a unsigned 64-bit integer from the attribute. + filename="gio/gfileinfo.c" + line="1098">a unsigned 64-bit integer from the attribute. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1091">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1092">a file attribute key. @@ -62272,25 +63277,24 @@ attribute does not contain an unsigned 64-bit integer, or is invalid, Gets the file's content type. + filename="gio/gfileinfo.c" + line="1802">Gets the file's content type. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE. - + a string containing the file's content type, + filename="gio/gfileinfo.c" + line="1811">a string containing the file's content type, or %NULL if unknown. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1804">a #GFileInfo. @@ -62299,8 +63303,8 @@ or %NULL if unknown. c:identifier="g_file_info_get_creation_date_time" version="2.70"> Gets the creation time of the current @info and returns it as a + filename="gio/gfileinfo.c" + line="1994">Gets the creation time of the current @info and returns it as a #GDateTime. It is an error to call this if the #GFileInfo does not contain @@ -62310,19 +63314,18 @@ precision. If nanosecond precision is needed, %G_FILE_ATTRIBUTE_TIME_CREATED_NSEC must be queried separately using g_file_info_get_attribute_uint32(). - + creation time, or %NULL if unknown + filename="gio/gfileinfo.c" + line="2009">creation time, or %NULL if unknown a #GFileInfo. + filename="gio/gfileinfo.c" + line="1996">a #GFileInfo. @@ -62331,23 +63334,22 @@ be queried separately using g_file_info_get_attribute_uint32(). c:identifier="g_file_info_get_deletion_date" version="2.36"> Returns the #GDateTime representing the deletion date of the file, as + filename="gio/gfileinfo.c" + line="1553">Returns the #GDateTime representing the deletion date of the file, as available in %G_FILE_ATTRIBUTE_TRASH_DELETION_DATE. If the %G_FILE_ATTRIBUTE_TRASH_DELETION_DATE attribute is unset, %NULL is returned. - + a #GDateTime, or %NULL. + filename="gio/gfileinfo.c" + line="1561">a #GDateTime, or %NULL. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1555">a #GFileInfo. @@ -62355,194 +63357,186 @@ available in %G_FILE_ATTRIBUTE_TRASH_DELETION_DATE. If the Gets a display name for a file. This is guaranteed to always be set. + filename="gio/gfileinfo.c" + line="1702">Gets a display name for a file. This is guaranteed to always be set. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME. - + a string containing the display name. + filename="gio/gfileinfo.c" + line="1711">a string containing the display name. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1704">a #GFileInfo. Gets the edit name for a file. + filename="gio/gfileinfo.c" + line="1724">Gets the edit name for a file. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME. - + a string containing the edit name. + filename="gio/gfileinfo.c" + line="1733">a string containing the edit name. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1726">a #GFileInfo. Gets the [entity tag][gfile-etag] for a given + filename="gio/gfileinfo.c" + line="2065">Gets the [entity tag](iface.File.html#entity-tags) for a given #GFileInfo. See %G_FILE_ATTRIBUTE_ETAG_VALUE. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_ETAG_VALUE. - + a string containing the value of the "etag:value" attribute. + filename="gio/gfileinfo.c" + line="2075">a string containing the value of the "etag:value" attribute. a #GFileInfo. + filename="gio/gfileinfo.c" + line="2067">a #GFileInfo. Gets a file's type (whether it is a regular file, symlink, etc). + filename="gio/gfileinfo.c" + line="1591">Gets a file's type (whether it is a regular file, symlink, etc). This is different from the file's content type, see g_file_info_get_content_type(). It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_TYPE. - + a #GFileType for the given file. + filename="gio/gfileinfo.c" + line="1601">a #GFileType for the given file. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1593">a #GFileInfo. Gets the icon for a file. + filename="gio/gfileinfo.c" + line="1746">Gets the icon for a file. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_ICON. - + #GIcon for the given @info. + filename="gio/gfileinfo.c" + line="1755">#GIcon for the given @info. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1748">a #GFileInfo. Checks if a file is a backup file. + filename="gio/gfileinfo.c" + line="1636">Checks if a file is a backup file. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_IS_BACKUP. - + %TRUE if file is a backup file, %FALSE otherwise. + filename="gio/gfileinfo.c" + line="1645">%TRUE if file is a backup file, %FALSE otherwise. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1638">a #GFileInfo. Checks if a file is hidden. + filename="gio/gfileinfo.c" + line="1614">Checks if a file is hidden. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN. - + %TRUE if the file is a hidden file, %FALSE otherwise. + filename="gio/gfileinfo.c" + line="1623">%TRUE if the file is a hidden file, %FALSE otherwise. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1616">a #GFileInfo. Checks if a file is a symlink. + filename="gio/gfileinfo.c" + line="1658">Checks if a file is a symlink. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK. - + %TRUE if the given @info is a symlink. + filename="gio/gfileinfo.c" + line="1667">%TRUE if the given @info is a symlink. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1660">a #GFileInfo. @@ -62551,8 +63545,8 @@ It is an error to call this if the #GFileInfo does not contain c:identifier="g_file_info_get_modification_date_time" version="2.62"> Gets the modification time of the current @info and returns it as a + filename="gio/gfileinfo.c" + line="1896">Gets the modification time of the current @info and returns it as a #GDateTime. It is an error to call this if the #GFileInfo does not contain @@ -62562,19 +63556,18 @@ precision. If nanosecond precision is needed, %G_FILE_ATTRIBUTE_TIME_MODIFIED_NSEC must be queried separately using g_file_info_get_attribute_uint32(). - + modification time, or %NULL if unknown + filename="gio/gfileinfo.c" + line="1911">modification time, or %NULL if unknown a #GFileInfo. + filename="gio/gfileinfo.c" + line="1898">a #GFileInfo. @@ -62584,8 +63577,8 @@ be queried separately using g_file_info_get_attribute_uint32(). deprecated="1" deprecated-version="2.62"> Gets the modification time of the current @info and sets it + filename="gio/gfileinfo.c" + line="1849">Gets the modification time of the current @info and sets it in @result. It is an error to call this if the #GFileInfo does not contain @@ -62593,16 +63586,15 @@ It is an error to call this if the #GFileInfo does not contain provided it will be used too. Use g_file_info_get_modification_date_time() instead, as #GTimeVal is deprecated due to the year 2038 problem. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="1851">a #GFileInfo. caller-allocates="1" transfer-ownership="none"> a #GTimeVal. + filename="gio/gfileinfo.c" + line="1852">a #GTimeVal. Gets the name for a file. This is guaranteed to always be set. + filename="gio/gfileinfo.c" + line="1680">Gets the name for a file. This is guaranteed to always be set. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_NAME. - + a string containing the file name. + filename="gio/gfileinfo.c" + line="1689">a string containing the file name. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1682">a #GFileInfo. Gets the file's size (in bytes). The size is retrieved through the value of + filename="gio/gfileinfo.c" + line="1825">Gets the file's size (in bytes). The size is retrieved through the value of the %G_FILE_ATTRIBUTE_STANDARD_SIZE attribute and is converted from #guint64 to #goffset before returning the result. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_SIZE. - + a #goffset containing the file's size (in bytes). + filename="gio/gfileinfo.c" + line="1836">a #goffset containing the file's size (in bytes). a #GFileInfo. + filename="gio/gfileinfo.c" + line="1827">a #GFileInfo. Gets the value of the sort_order attribute from the #GFileInfo. + filename="gio/gfileinfo.c" + line="2088">Gets the value of the sort_order attribute from the #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. - + a #gint32 containing the value of the "standard::sort_order" attribute. + filename="gio/gfileinfo.c" + line="2098">a #gint32 containing the value of the "standard::sort_order" attribute. a #GFileInfo. + filename="gio/gfileinfo.c" + line="2090">a #GFileInfo. @@ -62695,24 +63684,23 @@ It is an error to call this if the #GFileInfo does not contain c:identifier="g_file_info_get_symbolic_icon" version="2.34"> Gets the symbolic icon for a file. + filename="gio/gfileinfo.c" + line="1773">Gets the symbolic icon for a file. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON. - + #GIcon for the given @info. + filename="gio/gfileinfo.c" + line="1782">#GIcon for the given @info. a #GFileInfo. + filename="gio/gfileinfo.c" + line="1775">a #GFileInfo. @@ -62720,52 +63708,50 @@ It is an error to call this if the #GFileInfo does not contain Gets the symlink target for a given #GFileInfo. + filename="gio/gfileinfo.c" + line="2043">Gets the symlink target for a given #GFileInfo. It is an error to call this if the #GFileInfo does not contain %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET. - + a string containing the symlink target. + filename="gio/gfileinfo.c" + line="2052">a string containing the symlink target. a #GFileInfo. + filename="gio/gfileinfo.c" + line="2045">a #GFileInfo. Checks if a file info structure has an attribute named @attribute. - + filename="gio/gfileinfo.c" + line="587">Checks if a file info structure has an attribute named @attribute. + %TRUE if @info has an attribute named @attribute, + filename="gio/gfileinfo.c" + line="594">%TRUE if @info has an attribute named @attribute, %FALSE otherwise. a #GFileInfo. + filename="gio/gfileinfo.c" + line="589">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="590">a file attribute key. @@ -62774,29 +63760,28 @@ It is an error to call this if the #GFileInfo does not contain c:identifier="g_file_info_has_namespace" version="2.22"> Checks if a file info structure has an attribute in the + filename="gio/gfileinfo.c" + line="610">Checks if a file info structure has an attribute in the specified @name_space. - + %TRUE if @info has an attribute in @name_space, + filename="gio/gfileinfo.c" + line="618">%TRUE if @info has an attribute in @name_space, %FALSE otherwise. a #GFileInfo. + filename="gio/gfileinfo.c" + line="612">a #GFileInfo. a file attribute namespace. + filename="gio/gfileinfo.c" + line="613">a file attribute namespace. @@ -62804,14 +63789,13 @@ specified @name_space. Lists the file info structure's attributes. - + filename="gio/gfileinfo.c" + line="646">Lists the file info structure's attributes. + a + filename="gio/gfileinfo.c" + line="654">a null-terminated array of strings of all of the possible attribute types for the given @name_space, or %NULL on error. @@ -62821,8 +63805,8 @@ types for the given @name_space, or %NULL on error. a #GFileInfo. + filename="gio/gfileinfo.c" + line="648">a #GFileInfo. nullable="1" allow-none="1"> a file attribute key's namespace, or %NULL to list + filename="gio/gfileinfo.c" + line="649">a file attribute key's namespace, or %NULL to list all attributes. @@ -62840,24 +63824,23 @@ types for the given @name_space, or %NULL on error. Removes all cases of @attribute from @info if it exists. - + filename="gio/gfileinfo.c" + line="733">Removes all cases of @attribute from @info if it exists. + a #GFileInfo. + filename="gio/gfileinfo.c" + line="735">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="736">a file attribute key. @@ -62866,65 +63849,63 @@ types for the given @name_space, or %NULL on error. c:identifier="g_file_info_set_access_date_time" version="2.70"> Sets the %G_FILE_ATTRIBUTE_TIME_ACCESS and + filename="gio/gfileinfo.c" + line="2455">Sets the %G_FILE_ATTRIBUTE_TIME_ACCESS and %G_FILE_ATTRIBUTE_TIME_ACCESS_USEC attributes in the file info to the given date/time value. %G_FILE_ATTRIBUTE_TIME_ACCESS_NSEC will be cleared. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2457">a #GFileInfo. a #GDateTime. + filename="gio/gfileinfo.c" + line="2458">a #GDateTime. Sets the @attribute to contain the given value, if possible. To unset the + filename="gio/gfileinfo.c" + line="1179">Sets the @attribute to contain the given value, if possible. To unset the attribute, use %G_FILE_ATTRIBUTE_TYPE_INVALID for @type. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="1181">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1182">a file attribute key. a #GFileAttributeType + filename="gio/gfileinfo.c" + line="1183">a #GFileAttributeType pointer to the value + filename="gio/gfileinfo.c" + line="1184">pointer to the value @@ -62932,31 +63913,30 @@ attribute, use %G_FILE_ATTRIBUTE_TYPE_INVALID for @type. Sets the @attribute to contain the given @attr_value, + filename="gio/gfileinfo.c" + line="1378">Sets the @attribute to contain the given @attr_value, if possible. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="1380">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1381">a file attribute key. a boolean value. + filename="gio/gfileinfo.c" + line="1382">a boolean value. @@ -62964,63 +63944,96 @@ if possible. Sets the @attribute to contain the given @attr_value, + filename="gio/gfileinfo.c" + line="1321">Sets the @attribute to contain the given @attr_value, if possible. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="1323">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1324">a file attribute key. a byte string. + filename="gio/gfileinfo.c" + line="1325">a byte string. + + + + + + Sets the @attribute to contain the given @attr_value, +if possible. + +This function is meant to be used by language bindings that have specific +handling for Unix paths. + + + + + + + a #GFileInfo. + + + + a file attribute key. + + a file path. + + Sets the @attribute to contain the given @attr_value, + filename="gio/gfileinfo.c" + line="1446">Sets the @attribute to contain the given @attr_value, if possible. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="1448">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1449">a file attribute key. a signed 32-bit integer + filename="gio/gfileinfo.c" + line="1450">a signed 32-bit integer @@ -63028,31 +64041,30 @@ if possible. Sets the @attribute to contain the given @attr_value, + filename="gio/gfileinfo.c" + line="1514">Sets the @attribute to contain the given @attr_value, if possible. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="1516">a #GFileInfo. attribute name to set. + filename="gio/gfileinfo.c" + line="1517">attribute name to set. int64 value to set attribute to. + filename="gio/gfileinfo.c" + line="1518">int64 value to set attribute to. @@ -63060,24 +64072,23 @@ if possible. Sets @mask on @info to match specific attribute types. - + filename="gio/gfileinfo.c" + line="457">Sets @mask on @info to match specific attribute types. + a #GFileInfo. + filename="gio/gfileinfo.c" + line="459">a #GFileInfo. a #GFileAttributeMatcher. + filename="gio/gfileinfo.c" + line="460">a #GFileAttributeMatcher. @@ -63085,31 +64096,30 @@ if possible. Sets the @attribute to contain the given @attr_value, + filename="gio/gfileinfo.c" + line="1213">Sets the @attribute to contain the given @attr_value, if possible. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="1215">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1216">a file attribute key. a #GObject. + filename="gio/gfileinfo.c" + line="1217">a #GObject. @@ -63118,38 +64128,37 @@ if possible. c:identifier="g_file_info_set_attribute_status" version="2.22"> Sets the attribute status for an attribute key. This is only + filename="gio/gfileinfo.c" + line="823">Sets the attribute status for an attribute key. This is only needed by external code that implement g_file_set_attributes_from_info() or similar functions. The attribute must exist in @info for this to work. Otherwise %FALSE is returned and @info is unchanged. - + %TRUE if the status was changed, %FALSE if the key was not set. + filename="gio/gfileinfo.c" + line="836">%TRUE if the status was changed, %FALSE if the key was not set. a #GFileInfo + filename="gio/gfileinfo.c" + line="825">a #GFileInfo a file attribute key + filename="gio/gfileinfo.c" + line="826">a file attribute key a #GFileAttributeStatus + filename="gio/gfileinfo.c" + line="827">a #GFileAttributeStatus @@ -63157,31 +64166,30 @@ is returned and @info is unchanged. Sets the @attribute to contain the given @attr_value, + filename="gio/gfileinfo.c" + line="1286">Sets the @attribute to contain the given @attr_value, if possible. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="1288">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1289">a file attribute key. a UTF-8 string. + filename="gio/gfileinfo.c" + line="1290">a UTF-8 string. @@ -63189,33 +64197,32 @@ if possible. Sets the @attribute to contain the given @attr_value, + filename="gio/gfileinfo.c" + line="1248">Sets the @attribute to contain the given @attr_value, if possible. Sinze: 2.22 - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="1250">a #GFileInfo. a file attribute key + filename="gio/gfileinfo.c" + line="1251">a file attribute key a %NULL + filename="gio/gfileinfo.c" + line="1252">a %NULL terminated array of UTF-8 strings. @@ -63226,31 +64233,30 @@ Sinze: 2.22 Sets the @attribute to contain the given @attr_value, + filename="gio/gfileinfo.c" + line="1412">Sets the @attribute to contain the given @attr_value, if possible. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="1414">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1415">a file attribute key. an unsigned 32-bit integer. + filename="gio/gfileinfo.c" + line="1416">an unsigned 32-bit integer. @@ -63258,31 +64264,30 @@ if possible. Sets the @attribute to contain the given @attr_value, + filename="gio/gfileinfo.c" + line="1480">Sets the @attribute to contain the given @attr_value, if possible. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="1482">a #GFileInfo. a file attribute key. + filename="gio/gfileinfo.c" + line="1483">a file attribute key. an unsigned 64-bit integer. + filename="gio/gfileinfo.c" + line="1484">an unsigned 64-bit integer. @@ -63290,25 +64295,24 @@ if possible. Sets the content type attribute for a given #GFileInfo. + filename="gio/gfileinfo.c" + line="2319">Sets the content type attribute for a given #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2321">a #GFileInfo. a content type. See [GContentType][gio-GContentType] + filename="gio/gfileinfo.c" + line="2322">a content type. See [GContentType][gio-GContentType] @@ -63317,28 +64321,27 @@ See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE. c:identifier="g_file_info_set_creation_date_time" version="2.70"> Sets the %G_FILE_ATTRIBUTE_TIME_CREATED and + filename="gio/gfileinfo.c" + line="2496">Sets the %G_FILE_ATTRIBUTE_TIME_CREATED and %G_FILE_ATTRIBUTE_TIME_CREATED_USEC attributes in the file info to the given date/time value. %G_FILE_ATTRIBUTE_TIME_CREATED_NSEC will be cleared. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2498">a #GFileInfo. a #GDateTime. + filename="gio/gfileinfo.c" + line="2499">a #GDateTime. @@ -63346,150 +64349,144 @@ given date/time value. Sets the display name for the current #GFileInfo. + filename="gio/gfileinfo.c" + line="2213">Sets the display name for the current #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2215">a #GFileInfo. a string containing a display name. + filename="gio/gfileinfo.c" + line="2216">a string containing a display name. Sets the edit name for the current file. + filename="gio/gfileinfo.c" + line="2239">Sets the edit name for the current file. See %G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2241">a #GFileInfo. a string containing an edit name. + filename="gio/gfileinfo.c" + line="2242">a string containing an edit name. Sets the file type in a #GFileInfo to @type. + filename="gio/gfileinfo.c" + line="2112">Sets the file type in a #GFileInfo to @type. See %G_FILE_ATTRIBUTE_STANDARD_TYPE. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2114">a #GFileInfo. a #GFileType. + filename="gio/gfileinfo.c" + line="2115">a #GFileType. Sets the icon for a given #GFileInfo. + filename="gio/gfileinfo.c" + line="2265">Sets the icon for a given #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_ICON. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2267">a #GFileInfo. a #GIcon. + filename="gio/gfileinfo.c" + line="2268">a #GIcon. Sets the "is_hidden" attribute in a #GFileInfo according to @is_hidden. + filename="gio/gfileinfo.c" + line="2137">Sets the "is_hidden" attribute in a #GFileInfo according to @is_hidden. See %G_FILE_ATTRIBUTE_STANDARD_IS_HIDDEN. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2139">a #GFileInfo. a #gboolean. + filename="gio/gfileinfo.c" + line="2140">a #gboolean. Sets the "is_symlink" attribute in a #GFileInfo according to @is_symlink. + filename="gio/gfileinfo.c" + line="2162">Sets the "is_symlink" attribute in a #GFileInfo according to @is_symlink. See %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2164">a #GFileInfo. a #gboolean. + filename="gio/gfileinfo.c" + line="2165">a #gboolean. @@ -63498,28 +64495,27 @@ See %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK. c:identifier="g_file_info_set_modification_date_time" version="2.62"> Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED and + filename="gio/gfileinfo.c" + line="2414">Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED and %G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC attributes in the file info to the given date/time value. %G_FILE_ATTRIBUTE_TIME_MODIFIED_NSEC will be cleared. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2416">a #GFileInfo. a #GDateTime. + filename="gio/gfileinfo.c" + line="2417">a #GDateTime. @@ -63529,105 +64525,101 @@ given date/time value. deprecated="1" deprecated-version="2.62"> Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED and + filename="gio/gfileinfo.c" + line="2370">Sets the %G_FILE_ATTRIBUTE_TIME_MODIFIED and %G_FILE_ATTRIBUTE_TIME_MODIFIED_USEC attributes in the file info to the given time value. %G_FILE_ATTRIBUTE_TIME_MODIFIED_NSEC will be cleared. Use g_file_info_set_modification_date_time() instead, as #GTimeVal is deprecated due to the year 2038 problem. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2372">a #GFileInfo. a #GTimeVal. + filename="gio/gfileinfo.c" + line="2373">a #GTimeVal. Sets the name attribute for the current #GFileInfo. + filename="gio/gfileinfo.c" + line="2187">Sets the name attribute for the current #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_NAME. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2189">a #GFileInfo. a string containing a name. + filename="gio/gfileinfo.c" + line="2190">a string containing a name. Sets the %G_FILE_ATTRIBUTE_STANDARD_SIZE attribute in the file info + filename="gio/gfileinfo.c" + line="2345">Sets the %G_FILE_ATTRIBUTE_STANDARD_SIZE attribute in the file info to the given size. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2347">a #GFileInfo. a #goffset containing the file's size. + filename="gio/gfileinfo.c" + line="2348">a #goffset containing the file's size. Sets the sort order attribute in the file info structure. See + filename="gio/gfileinfo.c" + line="2563">Sets the sort order attribute in the file info structure. See %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDER. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2565">a #GFileInfo. a sort order integer. + filename="gio/gfileinfo.c" + line="2566">a sort order integer. @@ -63636,25 +64628,24 @@ to the given size. c:identifier="g_file_info_set_symbolic_icon" version="2.34"> Sets the symbolic icon for a given #GFileInfo. + filename="gio/gfileinfo.c" + line="2291">Sets the symbolic icon for a given #GFileInfo. See %G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2293">a #GFileInfo. a #GIcon. + filename="gio/gfileinfo.c" + line="2294">a #GIcon. @@ -63662,25 +64653,24 @@ See %G_FILE_ATTRIBUTE_STANDARD_SYMBOLIC_ICON. Sets the %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info + filename="gio/gfileinfo.c" + line="2537">Sets the %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET attribute in the file info to the given symlink target. - + a #GFileInfo. + filename="gio/gfileinfo.c" + line="2539">a #GFileInfo. a static string containing a path to a symlink target. + filename="gio/gfileinfo.c" + line="2540">a static string containing a path to a symlink target. @@ -63688,19 +64678,18 @@ to the given symlink target. Unsets a mask set by g_file_info_set_attribute_mask(), if one + filename="gio/gfileinfo.c" + line="494">Unsets a mask set by g_file_info_set_attribute_mask(), if one is set. - + #GFileInfo. + filename="gio/gfileinfo.c" + line="496">#GFileInfo. @@ -63711,8 +64700,7 @@ is set. disguised="1" opaque="1" glib:is-gtype-struct-for="FileInfo"> - + glib:get-type="g_file_input_stream_get_type" glib:type-struct="FileInputStreamClass"> GFileInputStream provides input streams that take their + filename="gio/gfileinputstream.c" + line="35">`GFileInputStream` provides input streams that take their content from a file. -GFileInputStream implements #GSeekable, which allows the input +`GFileInputStream` implements [iface@Gio.Seekable], which allows the input stream to jump to arbitrary positions in the file, provided the filesystem of the file allows it. To find the position of a file -input stream, use g_seekable_tell(). To find out if a file input -stream supports seeking, use g_seekable_can_seek(). -To position a file input stream, use g_seekable_seek(). - +input stream, use [method@Gio.Seekable.tell]. To find out if a file input +stream supports seeking, use [vfunc@Gio.Seekable.can_seek]. +To position a file input stream, use [vfunc@Gio.Seekable.seek]. + - + @@ -63747,33 +64733,35 @@ To position a file input stream, use g_seekable_seek(). - + Queries a file input stream the given @attributes. This function blocks + filename="gio/gfileinputstream.c" + line="105">Queries a file input stream the given @attributes. This function blocks while querying the stream. For the asynchronous (non-blocking) version of this function, see g_file_input_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag internally, and any other operations on the stream will fail with %G_IO_ERROR_PENDING. - + a #GFileInfo, or %NULL on error. + filename="gio/gfileinputstream.c" + line="119">a #GFileInfo, or %NULL on error. a #GFileInputStream. + filename="gio/gfileinputstream.c" + line="107">a #GFileInputStream. a file attribute query string. + filename="gio/gfileinputstream.c" + line="108">a file attribute query string. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileinputstream.c" + line="109">optional #GCancellable object, %NULL to ignore. - + Queries the stream information asynchronously. + filename="gio/gfileinputstream.c" + line="171">Queries the stream information asynchronously. When the operation is finished @callback will be called. You can then call g_file_input_stream_query_info_finish() to get the result of the operation. @@ -63801,28 +64792,27 @@ see g_file_input_stream_query_info(). If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + a #GFileInputStream. + filename="gio/gfileinputstream.c" + line="173">a #GFileInputStream. a file attribute query string. + filename="gio/gfileinputstream.c" + line="174">a file attribute query string. the [I/O priority][io-priority] of the request + filename="gio/gfileinputstream.c" + line="175">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileinputstream.c" + line="176">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/gfileinputstream.c" + line="177">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfileinputstream.c" + line="179">the data to pass to callback function @@ -63861,34 +64852,32 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set invoker="query_info_finish" throws="1"> Finishes an asynchronous info query operation. - + filename="gio/gfileinputstream.c" + line="226">Finishes an asynchronous info query operation. + #GFileInfo. + filename="gio/gfileinputstream.c" + line="235">#GFileInfo. a #GFileInputStream. + filename="gio/gfileinputstream.c" + line="228">a #GFileInputStream. a #GAsyncResult. + filename="gio/gfileinputstream.c" + line="229">a #GAsyncResult. - + @@ -63911,8 +64900,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + @@ -63924,33 +64912,33 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set + throws="1" + glib:async-func="query_info_async"> Queries a file input stream the given @attributes. This function blocks + filename="gio/gfileinputstream.c" + line="105">Queries a file input stream the given @attributes. This function blocks while querying the stream. For the asynchronous (non-blocking) version of this function, see g_file_input_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag internally, and any other operations on the stream will fail with %G_IO_ERROR_PENDING. - + a #GFileInfo, or %NULL on error. + filename="gio/gfileinputstream.c" + line="119">a #GFileInfo, or %NULL on error. a #GFileInputStream. + filename="gio/gfileinputstream.c" + line="107">a #GFileInputStream. a file attribute query string. + filename="gio/gfileinputstream.c" + line="108">a file attribute query string. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileinputstream.c" + line="109">optional #GCancellable object, %NULL to ignore. + c:identifier="g_file_input_stream_query_info_async" + glib:finish-func="query_info_finish" + glib:sync-func="query_info"> Queries the stream information asynchronously. + filename="gio/gfileinputstream.c" + line="171">Queries the stream information asynchronously. When the operation is finished @callback will be called. You can then call g_file_input_stream_query_info_finish() to get the result of the operation. @@ -63979,28 +64969,27 @@ see g_file_input_stream_query_info(). If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + a #GFileInputStream. + filename="gio/gfileinputstream.c" + line="173">a #GFileInputStream. a file attribute query string. + filename="gio/gfileinputstream.c" + line="174">a file attribute query string. the [I/O priority][io-priority] of the request + filename="gio/gfileinputstream.c" + line="175">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileinputstream.c" + line="176">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/gfileinputstream.c" + line="177">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfileinputstream.c" + line="179">the data to pass to callback function @@ -64038,27 +65028,26 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set c:identifier="g_file_input_stream_query_info_finish" throws="1"> Finishes an asynchronous info query operation. - + filename="gio/gfileinputstream.c" + line="226">Finishes an asynchronous info query operation. + #GFileInfo. + filename="gio/gfileinputstream.c" + line="235">#GFileInfo. a #GFileInputStream. + filename="gio/gfileinputstream.c" + line="228">a #GFileInputStream. a #GAsyncResult. + filename="gio/gfileinputstream.c" + line="229">a #GAsyncResult. @@ -64073,15 +65062,13 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + - + @@ -64094,8 +65081,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + @@ -64108,8 +65094,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + @@ -64134,25 +65119,24 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + a #GFileInfo, or %NULL on error. + filename="gio/gfileinputstream.c" + line="119">a #GFileInfo, or %NULL on error. a #GFileInputStream. + filename="gio/gfileinputstream.c" + line="107">a #GFileInputStream. a file attribute query string. + filename="gio/gfileinputstream.c" + line="108">a file attribute query string. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileinputstream.c" + line="109">optional #GCancellable object, %NULL to ignore. @@ -64169,28 +65153,27 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + a #GFileInputStream. + filename="gio/gfileinputstream.c" + line="173">a #GFileInputStream. a file attribute query string. + filename="gio/gfileinputstream.c" + line="174">a file attribute query string. the [I/O priority][io-priority] of the request + filename="gio/gfileinputstream.c" + line="175">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileinputstream.c" + line="176">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/gfileinputstream.c" + line="177">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfileinputstream.c" + line="179">the data to pass to callback function @@ -64228,25 +65212,24 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + #GFileInfo. + filename="gio/gfileinputstream.c" + line="235">#GFileInfo. a #GFileInputStream. + filename="gio/gfileinputstream.c" + line="228">a #GFileInputStream. a #GAsyncResult. + filename="gio/gfileinputstream.c" + line="229">a #GAsyncResult. @@ -64254,8 +65237,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + @@ -64263,8 +65245,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + @@ -64272,8 +65253,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + @@ -64281,8 +65261,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + @@ -64290,8 +65269,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set - + @@ -64302,8 +65280,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set c:type="GFileInputStreamPrivate" disguised="1" opaque="1"> - + glib:get-type="g_file_measure_flags_get_type" c:type="GFileMeasureFlags"> Flags that can be used with g_file_measure_disk_usage(). glib:nick="none" glib:name="G_FILE_MEASURE_NONE"> No flags set. glib:nick="report-any-error" glib:name="G_FILE_MEASURE_REPORT_ANY_ERROR"> Report any error encountered while traversing the directory tree. Normally errors are only reported for the toplevel file. @@ -64339,7 +65316,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set glib:nick="apparent-size" glib:name="G_FILE_MEASURE_APPARENT_SIZE"> Tally usage based on apparent file sizes. Normally, the block-size is used, if available, as this is a more accurate representation of disk space used. @@ -64354,7 +65331,7 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set glib:nick="no-xdev" glib:name="G_FILE_MEASURE_NO_XDEV"> Do not cross mount point boundaries. Compare with `du -x`. @@ -64363,8 +65340,8 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be set c:type="GFileMeasureProgressCallback" version="2.38"> This callback type is used by g_file_measure_disk_usage() to make + filename="gio/giotypes.h" + line="225">This callback type is used by g_file_measure_disk_usage() to make periodic progress reports when measuring the amount of disk spaced used by a directory. @@ -64391,34 +65368,33 @@ ideally about once every 200ms. The last progress callback may or may not be equal to the final result. Always check the async result to get the final value. - + %TRUE if more reports will come + filename="gio/giotypes.h" + line="227">%TRUE if more reports will come the current cumulative size measurement + filename="gio/giotypes.h" + line="228">the current cumulative size measurement the number of directories visited so far + filename="gio/giotypes.h" + line="229">the number of directories visited so far the number of non-directory files encountered + filename="gio/giotypes.h" + line="230">the number of non-directory files encountered nullable="1" allow-none="1"> the data passed to the original request for this callback + filename="gio/giotypes.h" + line="231">the data passed to the original request for this callback @@ -64441,47 +65417,43 @@ result. Always check the async result to get the final value. glib:get-type="g_file_monitor_get_type" glib:type-struct="FileMonitorClass"> Monitors a file or directory for changes. + filename="gio/gfilemonitor.c" + line="33">Monitors a file or directory for changes. -To obtain a #GFileMonitor for a file or directory, use -g_file_monitor(), g_file_monitor_file(), or -g_file_monitor_directory(). +To obtain a `GFileMonitor` for a file or directory, use +[method@Gio.File.monitor], [method@Gio.File.monitor_file], or +[method@Gio.File.monitor_directory]. To get informed about changes to the file or directory you are -monitoring, connect to the #GFileMonitor::changed signal. The -signal will be emitted in the -[thread-default main context][g-main-context-push-thread-default] -of the thread that the monitor was created in -(though if the global default main context is blocked, this may -cause notifications to be blocked even if the thread-default +monitoring, connect to the [signal@Gio.FileMonitor::changed] signal. The +signal will be emitted in the thread-default main context (see +[method@GLib.MainContext.push_thread_default]) of the thread that the monitor +was created in (though if the global default main context is blocked, this +may cause notifications to be blocked even if the thread-default context is still running). - + Cancels a file monitor. - + filename="gio/gfilemonitor.c" + line="231">Cancels a file monitor. + always %TRUE + filename="gio/gfilemonitor.c" + line="237">always %TRUE a #GFileMonitor. + filename="gio/gfilemonitor.c" + line="233">a #GFileMonitor. - + @@ -64502,84 +65474,81 @@ context is still running). Cancels a file monitor. - + filename="gio/gfilemonitor.c" + line="231">Cancels a file monitor. + always %TRUE + filename="gio/gfilemonitor.c" + line="237">always %TRUE a #GFileMonitor. + filename="gio/gfilemonitor.c" + line="233">a #GFileMonitor. Emits the #GFileMonitor::changed signal if a change + filename="gio/gfilemonitor.c" + line="271">Emits the #GFileMonitor::changed signal if a change has taken place. Should be called from file monitor implementations only. Implementations are responsible to call this method from the [thread-default main context][g-main-context-push-thread-default] of the thread that the monitor was created in. - + a #GFileMonitor. + filename="gio/gfilemonitor.c" + line="273">a #GFileMonitor. a #GFile. + filename="gio/gfilemonitor.c" + line="274">a #GFile. a #GFile. + filename="gio/gfilemonitor.c" + line="275">a #GFile. a set of #GFileMonitorEvent flags. + filename="gio/gfilemonitor.c" + line="276">a set of #GFileMonitorEvent flags. Returns whether the monitor is canceled. - + filename="gio/gfilemonitor.c" + line="211">Returns whether the monitor is canceled. + %TRUE if monitor is canceled. %FALSE otherwise. + filename="gio/gfilemonitor.c" + line="217">%TRUE if monitor is canceled. %FALSE otherwise. a #GFileMonitor + filename="gio/gfilemonitor.c" + line="213">a #GFileMonitor @@ -64588,25 +65557,24 @@ thread that the monitor was created in. c:identifier="g_file_monitor_set_rate_limit" glib:set-property="rate-limit"> Sets the rate limit to which the @monitor will report + filename="gio/gfilemonitor.c" + line="255">Sets the rate limit to which the @monitor will report consecutive change events to the same file. - + a #GFileMonitor. + filename="gio/gfilemonitor.c" + line="257">a #GFileMonitor. a non-negative integer with the limit in milliseconds + filename="gio/gfilemonitor.c" + line="258">a non-negative integer with the limit in milliseconds to poll for changes @@ -64615,6 +65583,9 @@ consecutive change events to the same file. + Whether the monitor has been cancelled. transfer-ownership="none" setter="set_rate_limit" default-value="800"> + The limit of the monitor to watch for changes, in milliseconds. @@ -64632,8 +65606,8 @@ consecutive change events to the same file. Emitted when @file has been changed. + filename="gio/gfilemonitor.c" + line="143">Emitted when @file has been changed. If using %G_FILE_MONITOR_WATCH_MOVES on a directory monitor, and the information is available (and if supported by the backend), @@ -64667,8 +65641,8 @@ In all the other cases, @other_file will be set to #NULL. a #GFile. + filename="gio/gfilemonitor.c" + line="146">a #GFile. nullable="1" allow-none="1"> a #GFile or #NULL. + filename="gio/gfilemonitor.c" + line="147">a #GFile or #NULL. a #GFileMonitorEvent. + filename="gio/gfilemonitor.c" + line="148">a #GFileMonitorEvent. @@ -64692,15 +65666,13 @@ In all the other cases, @other_file will be set to #NULL. - + - + @@ -64722,19 +65694,18 @@ In all the other cases, @other_file will be set to #NULL. - + always %TRUE + filename="gio/gfilemonitor.c" + line="237">always %TRUE a #GFileMonitor. + filename="gio/gfilemonitor.c" + line="233">a #GFileMonitor. @@ -64742,8 +65713,7 @@ In all the other cases, @other_file will be set to #NULL. - + @@ -64751,8 +65721,7 @@ In all the other cases, @other_file will be set to #NULL. - + @@ -64760,8 +65729,7 @@ In all the other cases, @other_file will be set to #NULL. - + @@ -64769,8 +65737,7 @@ In all the other cases, @other_file will be set to #NULL. - + @@ -64778,8 +65745,7 @@ In all the other cases, @other_file will be set to #NULL. - + @@ -64791,16 +65757,16 @@ In all the other cases, @other_file will be set to #NULL. glib:get-type="g_file_monitor_event_get_type" c:type="GFileMonitorEvent"> Specifies what type of event a monitor event is. + filename="gio/gioenums.h" + line="413">Specifies what type of event a monitor event is. a file changed. + filename="gio/gioenums.h" + line="415">a file changed. glib:nick="changes-done-hint" glib:name="G_FILE_MONITOR_EVENT_CHANGES_DONE_HINT"> a hint that this was probably the last change in a set of changes. + filename="gio/gioenums.h" + line="416">a hint that this was probably the last change in a set of changes. glib:nick="deleted" glib:name="G_FILE_MONITOR_EVENT_DELETED"> a file was deleted. + filename="gio/gioenums.h" + line="417">a file was deleted. glib:nick="created" glib:name="G_FILE_MONITOR_EVENT_CREATED"> a file was created. + filename="gio/gioenums.h" + line="418">a file was created. glib:nick="attribute-changed" glib:name="G_FILE_MONITOR_EVENT_ATTRIBUTE_CHANGED"> a file attribute was changed. + filename="gio/gioenums.h" + line="419">a file attribute was changed. glib:nick="pre-unmount" glib:name="G_FILE_MONITOR_EVENT_PRE_UNMOUNT"> the file location will soon be unmounted. + filename="gio/gioenums.h" + line="420">the file location will soon be unmounted. glib:nick="unmounted" glib:name="G_FILE_MONITOR_EVENT_UNMOUNTED"> the file location was unmounted. + filename="gio/gioenums.h" + line="421">the file location was unmounted. glib:nick="moved" glib:name="G_FILE_MONITOR_EVENT_MOVED"> the file was moved -- only sent if the + filename="gio/gioenums.h" + line="422">the file was moved -- only sent if the (deprecated) %G_FILE_MONITOR_SEND_MOVED flag is set glib:nick="renamed" glib:name="G_FILE_MONITOR_EVENT_RENAMED"> the file was renamed within the + filename="gio/gioenums.h" + line="424">the file was renamed within the current directory -- only sent if the %G_FILE_MONITOR_WATCH_MOVES flag is set. Since: 2.46. @@ -64883,8 +65849,8 @@ In all the other cases, @other_file will be set to #NULL. glib:nick="moved-in" glib:name="G_FILE_MONITOR_EVENT_MOVED_IN"> the file was moved into the + filename="gio/gioenums.h" + line="427">the file was moved into the monitored directory from another location -- only sent if the %G_FILE_MONITOR_WATCH_MOVES flag is set. Since: 2.46. @@ -64894,8 +65860,8 @@ In all the other cases, @other_file will be set to #NULL. glib:nick="moved-out" glib:name="G_FILE_MONITOR_EVENT_MOVED_OUT"> the file was moved out of the + filename="gio/gioenums.h" + line="430">the file was moved out of the monitored directory to another location -- only sent if the %G_FILE_MONITOR_WATCH_MOVES flag is set. Since: 2.46 @@ -64905,16 +65871,16 @@ In all the other cases, @other_file will be set to #NULL. glib:get-type="g_file_monitor_flags_get_type" c:type="GFileMonitorFlags"> Flags used to set what a #GFileMonitor will watch for. + filename="gio/gioenums.h" + line="334">Flags used to set what a #GFileMonitor will watch for. No flags set. + filename="gio/gioenums.h" + line="336">No flags set. glib:nick="watch-mounts" glib:name="G_FILE_MONITOR_WATCH_MOUNTS"> Watch for mount events. + filename="gio/gioenums.h" + line="337">Watch for mount events. glib:nick="send-moved" glib:name="G_FILE_MONITOR_SEND_MOVED"> Pair DELETED and CREATED events caused + filename="gio/gioenums.h" + line="338">Pair DELETED and CREATED events caused by file renames (moves) and send a single G_FILE_MONITOR_EVENT_MOVED event instead (NB: not supported on all backends; the default behaviour -without specifying this flag- is to send single DELETED @@ -64945,8 +65911,8 @@ In all the other cases, @other_file will be set to #NULL. glib:nick="watch-hard-links" glib:name="G_FILE_MONITOR_WATCH_HARD_LINKS"> Watch for changes to the file made + filename="gio/gioenums.h" + line="344">Watch for changes to the file made via another hard link. Since 2.36. glib:nick="watch-moves" glib:name="G_FILE_MONITOR_WATCH_MOVES"> Watch for rename operations on a + filename="gio/gioenums.h" + line="346">Watch for rename operations on a monitored directory. This causes %G_FILE_MONITOR_EVENT_RENAMED, %G_FILE_MONITOR_EVENT_MOVED_IN and %G_FILE_MONITOR_EVENT_MOVED_OUT events to be emitted when possible. Since: 2.46. @@ -64966,8 +65932,7 @@ In all the other cases, @other_file will be set to #NULL. c:type="GFileMonitorPrivate" disguised="1" opaque="1"> - + glib:get-type="g_file_output_stream_get_type" glib:type-struct="FileOutputStreamClass"> GFileOutputStream provides output streams that write their + filename="gio/gfileoutputstream.c" + line="35">`GFileOutputStream` provides output streams that write their content to a file. -GFileOutputStream implements #GSeekable, which allows the output +`GFileOutputStream` implements [iface@Gio.Seekable], which allows the output stream to jump to arbitrary positions in the file and to truncate the file, provided the filesystem of the file supports these operations. -To find the position of a file output stream, use g_seekable_tell(). +To find the position of a file output stream, use [method@Gio.Seekable.tell]. To find out if a file output stream supports seeking, use -g_seekable_can_seek().To position a file output stream, use -g_seekable_seek(). To find out if a file output stream supports -truncating, use g_seekable_can_truncate(). To truncate a file output -stream, use g_seekable_truncate(). - +[method@Gio.Seekable.can_seek].To position a file output stream, use +[method@Gio.Seekable.seek]. To find out if a file output stream supports +truncating, use [method@Gio.Seekable.can_truncate]. To truncate a file output +stream, use [method@Gio.Seekable.truncate]. + - + @@ -65008,8 +65971,7 @@ stream, use g_seekable_truncate(). - + @@ -65021,31 +65983,33 @@ stream, use g_seekable_truncate(). Gets the entity tag for the file when it has been written. + filename="gio/gfileoutputstream.c" + line="266">Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - + the entity tag for the stream. + filename="gio/gfileoutputstream.c" + line="274">the entity tag for the stream. a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="268">a #GFileOutputStream. - + Queries a file output stream for the given @attributes. + filename="gio/gfileoutputstream.c" + line="109">Queries a file output stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_output_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -65062,25 +66026,24 @@ If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will be returned. - + a #GFileInfo for the @stream, or %NULL on error. + filename="gio/gfileoutputstream.c" + line="134">a #GFileInfo for the @stream, or %NULL on error. a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="111">a #GFileOutputStream. a file attribute query string. + filename="gio/gfileoutputstream.c" + line="112">a file attribute query string. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileoutputstream.c" + line="113">optional #GCancellable object, %NULL to ignore. - + Asynchronously queries the @stream for a #GFileInfo. When completed, + filename="gio/gfileoutputstream.c" + line="186">Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_output_stream_query_info_finish(). For the synchronous version of this function, see g_file_output_stream_query_info(). - + a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="188">a #GFileOutputStream. a file attribute query string. + filename="gio/gfileoutputstream.c" + line="189">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + filename="gio/gfileoutputstream.c" + line="190">the [I/O priority](iface.AsyncResult.html#io-priority) of the + request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileoutputstream.c" + line="192">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/gfileoutputstream.c" + line="193">callback to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gfileoutputstream.c" + line="194">the data to pass to callback function @@ -65163,35 +66129,33 @@ g_file_output_stream_query_info(). invoker="query_info_finish" throws="1"> Finalizes the asynchronous query started + filename="gio/gfileoutputstream.c" + line="236">Finalizes the asynchronous query started by g_file_output_stream_query_info_async(). - + A #GFileInfo for the finished query. + filename="gio/gfileoutputstream.c" + line="245">A #GFileInfo for the finished query. a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="238">a #GFileOutputStream. a #GAsyncResult. + filename="gio/gfileoutputstream.c" + line="239">a #GAsyncResult. - + @@ -65214,8 +66178,7 @@ by g_file_output_stream_query_info_async(). - + @@ -65226,8 +66189,7 @@ by g_file_output_stream_query_info_async(). - + @@ -65248,33 +66210,33 @@ by g_file_output_stream_query_info_async(). Gets the entity tag for the file when it has been written. + filename="gio/gfileoutputstream.c" + line="266">Gets the entity tag for the file when it has been written. This must be called after the stream has been written and closed, as the etag can change while writing. - + the entity tag for the stream. + filename="gio/gfileoutputstream.c" + line="274">the entity tag for the stream. a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="268">a #GFileOutputStream. + throws="1" + glib:async-func="query_info_async"> Queries a file output stream for the given @attributes. + filename="gio/gfileoutputstream.c" + line="109">Queries a file output stream for the given @attributes. This function blocks while querying the stream. For the asynchronous version of this function, see g_file_output_stream_query_info_async(). While the stream is blocked, the stream will set the pending flag @@ -65291,25 +66253,24 @@ If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be set, and %NULL will be returned. - + a #GFileInfo for the @stream, or %NULL on error. + filename="gio/gfileoutputstream.c" + line="134">a #GFileInfo for the @stream, or %NULL on error. a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="111">a #GFileOutputStream. a file attribute query string. + filename="gio/gfileoutputstream.c" + line="112">a file attribute query string. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileoutputstream.c" + line="113">optional #GCancellable object, %NULL to ignore. + c:identifier="g_file_output_stream_query_info_async" + glib:finish-func="query_info_finish" + glib:sync-func="query_info"> Asynchronously queries the @stream for a #GFileInfo. When completed, + filename="gio/gfileoutputstream.c" + line="186">Asynchronously queries the @stream for a #GFileInfo. When completed, @callback will be called with a #GAsyncResult which can be used to finish the operation with g_file_output_stream_query_info_finish(). For the synchronous version of this function, see g_file_output_stream_query_info(). - + a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="188">a #GFileOutputStream. a file attribute query string. + filename="gio/gfileoutputstream.c" + line="189">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + filename="gio/gfileoutputstream.c" + line="190">the [I/O priority](iface.AsyncResult.html#io-priority) of the + request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileoutputstream.c" + line="192">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/gfileoutputstream.c" + line="193">callback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gfileoutputstream.c" + line="194">the data to pass to callback function @@ -65392,28 +66355,27 @@ g_file_output_stream_query_info(). c:identifier="g_file_output_stream_query_info_finish" throws="1"> Finalizes the asynchronous query started + filename="gio/gfileoutputstream.c" + line="236">Finalizes the asynchronous query started by g_file_output_stream_query_info_async(). - + A #GFileInfo for the finished query. + filename="gio/gfileoutputstream.c" + line="245">A #GFileInfo for the finished query. a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="238">a #GFileOutputStream. a #GAsyncResult. + filename="gio/gfileoutputstream.c" + line="239">a #GAsyncResult. @@ -65429,15 +66391,13 @@ by g_file_output_stream_query_info_async(). - + - + @@ -65450,8 +66410,7 @@ by g_file_output_stream_query_info_async(). - + @@ -65464,8 +66423,7 @@ by g_file_output_stream_query_info_async(). - + @@ -65490,8 +66448,7 @@ by g_file_output_stream_query_info_async(). - + @@ -65504,8 +66461,7 @@ by g_file_output_stream_query_info_async(). - + @@ -65527,25 +66483,24 @@ by g_file_output_stream_query_info_async(). - + a #GFileInfo for the @stream, or %NULL on error. + filename="gio/gfileoutputstream.c" + line="134">a #GFileInfo for the @stream, or %NULL on error. a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="111">a #GFileOutputStream. a file attribute query string. + filename="gio/gfileoutputstream.c" + line="112">a file attribute query string. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileoutputstream.c" + line="113">optional #GCancellable object, %NULL to ignore. @@ -65562,28 +66517,28 @@ by g_file_output_stream_query_info_async(). - + a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="188">a #GFileOutputStream. a file attribute query string. + filename="gio/gfileoutputstream.c" + line="189">a file attribute query string. the [I/O priority][gio-GIOScheduler] of the request + filename="gio/gfileoutputstream.c" + line="190">the [I/O priority](iface.AsyncResult.html#io-priority) of the + request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gfileoutputstream.c" + line="192">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/gfileoutputstream.c" + line="193">callback to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/gfileoutputstream.c" + line="194">the data to pass to callback function @@ -65621,25 +66576,24 @@ by g_file_output_stream_query_info_async(). - + A #GFileInfo for the finished query. + filename="gio/gfileoutputstream.c" + line="245">A #GFileInfo for the finished query. a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="238">a #GFileOutputStream. a #GAsyncResult. + filename="gio/gfileoutputstream.c" + line="239">a #GAsyncResult. @@ -65647,19 +66601,18 @@ by g_file_output_stream_query_info_async(). - + the entity tag for the stream. + filename="gio/gfileoutputstream.c" + line="274">the entity tag for the stream. a #GFileOutputStream. + filename="gio/gfileoutputstream.c" + line="268">a #GFileOutputStream. @@ -65667,8 +66620,7 @@ by g_file_output_stream_query_info_async(). - + @@ -65676,8 +66628,7 @@ by g_file_output_stream_query_info_async(). - + @@ -65685,8 +66636,7 @@ by g_file_output_stream_query_info_async(). - + @@ -65694,8 +66644,7 @@ by g_file_output_stream_query_info_async(). - + @@ -65703,8 +66652,7 @@ by g_file_output_stream_query_info_async(). - + @@ -65715,31 +66663,29 @@ by g_file_output_stream_query_info_async(). c:type="GFileOutputStreamPrivate" disguised="1" opaque="1"> - + When doing file operations that may take a while, such as moving + filename="gio/giotypes.h" + line="194">When doing file operations that may take a while, such as moving a file or copying a file, a progress callback is used to pass how far along that operation is to the application. - + the current number of bytes in the operation. + filename="gio/giotypes.h" + line="196">the current number of bytes in the operation. the total number of bytes in the operation. + filename="gio/giotypes.h" + line="197">the total number of bytes in the operation. nullable="1" allow-none="1"> user data passed to the callback. + filename="gio/giotypes.h" + line="198">user data passed to the callback. @@ -65758,7 +66704,7 @@ far along that operation is to the application. glib:get-type="g_file_query_info_flags_get_type" c:type="GFileQueryInfoFlags"> Flags used when querying a #GFileInfo. glib:nick="none" glib:name="G_FILE_QUERY_INFO_NONE"> No flags set. glib:nick="nofollow-symlinks" glib:name="G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS"> Don't follow symlinks. When loading the partial contents of a file with g_file_load_partial_contents_async(), + filename="gio/giotypes.h" + line="208">When loading the partial contents of a file with g_file_load_partial_contents_async(), it may become necessary to determine if any more data from the file should be loaded. A #GFileReadMoreCallback function facilitates this by returning %TRUE if more data should be read, or %FALSE otherwise. - + %TRUE if more data should be read back. %FALSE otherwise. + filename="gio/giotypes.h" + line="219">%TRUE if more data should be read back. %FALSE otherwise. the data as currently read. + filename="gio/giotypes.h" + line="210">the data as currently read. the size of the data currently read. + filename="gio/giotypes.h" + line="211">the size of the data currently read. nullable="1" allow-none="1"> data passed to the callback. + filename="gio/giotypes.h" + line="212">data passed to the callback. @@ -65823,8 +66768,8 @@ should be read, or %FALSE otherwise. glib:get-type="g_file_type_get_type" c:type="GFileType"> Indicates the file's on-disk type. + filename="gio/gioenums.h" + line="362">Indicates the file's on-disk type. On Windows systems a file will never have %G_FILE_TYPE_SYMBOLIC_LINK type; use #GFileInfo and %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINK to determine @@ -65840,8 +66785,8 @@ which is why all Windows symlinks will continue to be reported as glib:nick="unknown" glib:name="G_FILE_TYPE_UNKNOWN"> File's type is unknown. + filename="gio/gioenums.h" + line="364">File's type is unknown. File handle represents a regular file. + filename="gio/gioenums.h" + line="365">File handle represents a regular file. File handle represents a directory. + filename="gio/gioenums.h" + line="366">File handle represents a directory. File handle represents a symbolic link + filename="gio/gioenums.h" + line="367">File handle represents a symbolic link (Unix systems). File is a "special" file, such as a socket, fifo, + filename="gio/gioenums.h" + line="369">File is a "special" file, such as a socket, fifo, block device, or character device. File is a shortcut (Windows systems). + filename="gio/gioenums.h" + line="371">File is a shortcut (Windows systems). File is a mountable location. + filename="gio/gioenums.h" + line="372">File is a mountable location. Completes partial file and directory names given a partial string by + filename="gio/gfilenamecompleter.c" + line="34">Completes partial file and directory names given a partial string by looking in the file system for clues. Can return a list of possible completion strings for widget implementations. - + Creates a new filename completer. - + filename="gio/gfilenamecompleter.c" + line="116">Creates a new filename completer. + a #GFilenameCompleter. + filename="gio/gfilenamecompleter.c" + line="121">a #GFilenameCompleter. - + @@ -65943,14 +66885,13 @@ completion strings for widget implementations. Obtains a completion for @initial_text from @completer. - + filename="gio/gfilenamecompleter.c" + line="399">Obtains a completion for @initial_text from @completer. + a completed string, or %NULL if no + filename="gio/gfilenamecompleter.c" + line="406">a completed string, or %NULL if no completion exists. This string is not owned by GIO, so remember to g_free() it when finished. @@ -65958,14 +66899,14 @@ completion strings for widget implementations. the filename completer. + filename="gio/gfilenamecompleter.c" + line="401">the filename completer. text to be completed. + filename="gio/gfilenamecompleter.c" + line="402">text to be completed. @@ -65973,14 +66914,13 @@ completion strings for widget implementations. Gets an array of completion strings for a given initial text. - + filename="gio/gfilenamecompleter.c" + line="453">Gets an array of completion strings for a given initial text. + array of strings with possible completions for @initial_text. + filename="gio/gfilenamecompleter.c" + line="460">array of strings with possible completions for @initial_text. This array must be freed by g_strfreev() when finished. @@ -65989,14 +66929,14 @@ This array must be freed by g_strfreev() when finished. the filename completer. + filename="gio/gfilenamecompleter.c" + line="455">the filename completer. text to be completed. + filename="gio/gfilenamecompleter.c" + line="456">text to be completed. @@ -66004,33 +66944,32 @@ This array must be freed by g_strfreev() when finished. If @dirs_only is %TRUE, @completer will only + filename="gio/gfilenamecompleter.c" + line="494">If @dirs_only is %TRUE, @completer will only complete directory names, and not file names. - + the filename completer. + filename="gio/gfilenamecompleter.c" + line="496">the filename completer. a #gboolean. + filename="gio/gfilenamecompleter.c" + line="497">a #gboolean. Emitted when the file name completion information comes available. + filename="gio/gfilenamecompleter.c" + line="97">Emitted when the file name completion information comes available. @@ -66039,15 +66978,13 @@ complete directory names, and not file names. - + - + @@ -66060,8 +66997,7 @@ complete directory names, and not file names. - + @@ -66069,8 +67005,7 @@ complete directory names, and not file names. - + @@ -66078,8 +67013,7 @@ complete directory names, and not file names. - + @@ -66091,8 +67025,8 @@ complete directory names, and not file names. glib:get-type="g_filesystem_preview_type_get_type" c:type="GFilesystemPreviewType"> Indicates a hint from the file system whether files should be + filename="gio/gioenums.h" + line="396">Indicates a hint from the file system whether files should be previewed in a file manager. Returned as the value of the key %G_FILE_ATTRIBUTE_FILESYSTEM_USE_PREVIEW. Only preview files if user has explicitly requested it. + filename="gio/gioenums.h" + line="398">Only preview files if user has explicitly requested it. Preview files if user has requested preview of "local" files. + filename="gio/gioenums.h" + line="399">Preview files if user has requested preview of "local" files. Never preview files. + filename="gio/gioenums.h" + line="400">Never preview files. Base class for input stream implementations that perform some + filename="gio/gfilterinputstream.c" + line="29">Base class for input stream implementations that perform some kind of filtering operation on a base stream. Typical examples of filtering operations are character set conversion, compression and byte order flipping. - + Gets the base stream for the filter stream. - + filename="gio/gfilterinputstream.c" + line="192">Gets the base stream for the filter stream. + a #GInputStream. + filename="gio/gfilterinputstream.c" + line="198">a #GInputStream. a #GFilterInputStream. + filename="gio/gfilterinputstream.c" + line="194">a #GFilterInputStream. @@ -66166,22 +67098,21 @@ and byte order flipping. c:identifier="g_filter_input_stream_get_close_base_stream" glib:get-property="close-base-stream"> Returns whether the base stream will be closed when @stream is + filename="gio/gfilterinputstream.c" + line="208">Returns whether the base stream will be closed when @stream is closed. - + %TRUE if the base stream will be closed. + filename="gio/gfilterinputstream.c" + line="215">%TRUE if the base stream will be closed. a #GFilterInputStream. + filename="gio/gfilterinputstream.c" + line="210">a #GFilterInputStream. @@ -66190,24 +67121,23 @@ closed. c:identifier="g_filter_input_stream_set_close_base_stream" glib:set-property="close-base-stream"> Sets whether the base stream will be closed when @stream is closed. - + filename="gio/gfilterinputstream.c" + line="229">Sets whether the base stream will be closed when @stream is closed. + a #GFilterInputStream. + filename="gio/gfilterinputstream.c" + line="231">a #GFilterInputStream. %TRUE to close the base stream. + filename="gio/gfilterinputstream.c" + line="232">%TRUE to close the base stream. @@ -66217,6 +67147,9 @@ closed. construct-only="1" transfer-ownership="none" getter="get_base_stream"> + The underlying base stream on which the I/O ops will be done. setter="set_close_base_stream" getter="get_close_base_stream" default-value="TRUE"> + Whether the base stream should be closed when the filter stream is closed. @@ -66238,15 +67174,13 @@ closed. - + - + @@ -66254,8 +67188,7 @@ closed. - + @@ -66263,8 +67196,7 @@ closed. - + @@ -66280,32 +67212,30 @@ closed. glib:get-type="g_filter_output_stream_get_type" glib:type-struct="FilterOutputStreamClass"> Base class for output stream implementations that perform some + filename="gio/gfilteroutputstream.c" + line="29">Base class for output stream implementations that perform some kind of filtering operation on a base stream. Typical examples of filtering operations are character set conversion, compression and byte order flipping. - + Gets the base stream for the filter stream. - + filename="gio/gfilteroutputstream.c" + line="196">Gets the base stream for the filter stream. + a #GOutputStream. + filename="gio/gfilteroutputstream.c" + line="202">a #GOutputStream. a #GFilterOutputStream. + filename="gio/gfilteroutputstream.c" + line="198">a #GFilterOutputStream. @@ -66314,22 +67244,21 @@ and byte order flipping. c:identifier="g_filter_output_stream_get_close_base_stream" glib:get-property="close-base-stream"> Returns whether the base stream will be closed when @stream is + filename="gio/gfilteroutputstream.c" + line="212">Returns whether the base stream will be closed when @stream is closed. - + %TRUE if the base stream will be closed. + filename="gio/gfilteroutputstream.c" + line="219">%TRUE if the base stream will be closed. a #GFilterOutputStream. + filename="gio/gfilteroutputstream.c" + line="214">a #GFilterOutputStream. @@ -66337,24 +67266,23 @@ closed. Sets whether the base stream will be closed when @stream is closed. - + filename="gio/gfilteroutputstream.c" + line="233">Sets whether the base stream will be closed when @stream is closed. + a #GFilterOutputStream. + filename="gio/gfilteroutputstream.c" + line="235">a #GFilterOutputStream. %TRUE to close the base stream. + filename="gio/gfilteroutputstream.c" + line="236">%TRUE to close the base stream. @@ -66372,6 +67300,9 @@ closed. transfer-ownership="none" getter="get_close_base_stream" default-value="TRUE"> + Whether the base stream should be closed when the filter stream is closed. @@ -66384,15 +67315,13 @@ closed. - + - + @@ -66400,8 +67329,7 @@ closed. - + @@ -66409,8 +67337,7 @@ closed. - + @@ -66418,8 +67345,7 @@ closed. - + @@ -66428,8 +67354,7 @@ closed. - + @@ -66438,8 +67363,7 @@ closed. - + @@ -66448,8 +67372,7 @@ closed. - + @@ -66458,8 +67381,7 @@ closed. - + @@ -66468,8 +67390,7 @@ closed. - + @@ -66478,8 +67399,7 @@ closed. - + @@ -66488,8 +67408,7 @@ closed. - + @@ -66498,8 +67417,7 @@ closed. - + @@ -66508,8 +67426,7 @@ closed. - + @@ -66518,8 +67435,7 @@ closed. - + @@ -66528,8 +67444,7 @@ closed. - + @@ -66538,8 +67453,7 @@ closed. - + @@ -66548,8 +67462,7 @@ closed. - + @@ -66558,8 +67471,7 @@ closed. - + @@ -66568,8 +67480,7 @@ closed. - + @@ -66581,8 +67492,8 @@ closed. c:type="GIOErrorEnum" glib:error-domain="g-io-error-quark"> Error codes returned by GIO functions. + filename="gio/gioenums.h" + line="456">Error codes returned by GIO functions. Note that this domain may be extended in future GLib releases. In general, new error codes either only apply to new APIs, or else @@ -66606,8 +67517,8 @@ See also #GPollableReturn for a cheaper way of returning glib:nick="failed" glib:name="G_IO_ERROR_FAILED"> Generic error condition for when an operation fails + filename="gio/gioenums.h" + line="458">Generic error condition for when an operation fails and no more specific #GIOErrorEnum value is defined. File not found. + filename="gio/gioenums.h" + line="460">File not found. File already exists. + filename="gio/gioenums.h" + line="461">File already exists. File is a directory. + filename="gio/gioenums.h" + line="462">File is a directory. File is not a directory. + filename="gio/gioenums.h" + line="463">File is not a directory. File is a directory that isn't empty. + filename="gio/gioenums.h" + line="464">File is a directory that isn't empty. File is not a regular file. + filename="gio/gioenums.h" + line="465">File is not a regular file. File is not a symbolic link. + filename="gio/gioenums.h" + line="466">File is not a symbolic link. File cannot be mounted. + filename="gio/gioenums.h" + line="467">File cannot be mounted. Filename is too many characters. + filename="gio/gioenums.h" + line="468">Filename is too many characters. Filename is invalid or contains invalid characters. + filename="gio/gioenums.h" + line="469">Filename is invalid or contains invalid characters. File contains too many symbolic links. + filename="gio/gioenums.h" + line="470">File contains too many symbolic links. No space left on drive. + filename="gio/gioenums.h" + line="471">No space left on drive. Invalid argument. + filename="gio/gioenums.h" + line="472">Invalid argument. Permission denied. + filename="gio/gioenums.h" + line="473">Permission denied. Operation (or one of its parameters) not supported + filename="gio/gioenums.h" + line="474">Operation (or one of its parameters) not supported File isn't mounted. + filename="gio/gioenums.h" + line="475">File isn't mounted. File is already mounted. + filename="gio/gioenums.h" + line="476">File is already mounted. File was closed. + filename="gio/gioenums.h" + line="477">File was closed. Operation was cancelled. See #GCancellable. + filename="gio/gioenums.h" + line="478">Operation was cancelled. See #GCancellable. Operations are still pending. + filename="gio/gioenums.h" + line="479">Operations are still pending. File is read only. + filename="gio/gioenums.h" + line="480">File is read only. Backup couldn't be created. + filename="gio/gioenums.h" + line="481">Backup couldn't be created. File's Entity Tag was incorrect. + filename="gio/gioenums.h" + line="482">File's Entity Tag was incorrect. Operation timed out. + filename="gio/gioenums.h" + line="483">Operation timed out. Operation would be recursive. + filename="gio/gioenums.h" + line="484">Operation would be recursive. File is busy. + filename="gio/gioenums.h" + line="485">File is busy. Operation would block. + filename="gio/gioenums.h" + line="486">Operation would block. Host couldn't be found (remote operations). + filename="gio/gioenums.h" + line="487">Host couldn't be found (remote operations). Operation would merge files. + filename="gio/gioenums.h" + line="488">Operation would merge files. Operation failed and a helper program has + filename="gio/gioenums.h" + line="489">Operation failed and a helper program has already interacted with the user. Do not display any error dialog. The current process has too many files + filename="gio/gioenums.h" + line="491">The current process has too many files open and can't open any more. Duplicate descriptors do count toward this limit. Since 2.20 @@ -66898,8 +67809,8 @@ See also #GPollableReturn for a cheaper way of returning glib:nick="not-initialized" glib:name="G_IO_ERROR_NOT_INITIALIZED"> The object has not been initialized. Since 2.22 + filename="gio/gioenums.h" + line="494">The object has not been initialized. Since 2.22 The requested address is already in use. Since 2.22 + filename="gio/gioenums.h" + line="495">The requested address is already in use. Since 2.22 Need more input to finish operation. Since 2.24 + filename="gio/gioenums.h" + line="496">Need more input to finish operation. Since 2.24 The input data was invalid. Since 2.24 + filename="gio/gioenums.h" + line="497">The input data was invalid. Since 2.24 A remote object generated an error that + filename="gio/gioenums.h" + line="498">A remote object generated an error that doesn't correspond to a locally registered #GError error domain. Use g_dbus_error_get_remote_error() to extract the D-Bus error name and g_dbus_error_strip_remote_error() to fix up the @@ -66947,8 +67858,8 @@ See also #GPollableReturn for a cheaper way of returning glib:nick="host-unreachable" glib:name="G_IO_ERROR_HOST_UNREACHABLE"> Host unreachable. Since 2.26 + filename="gio/gioenums.h" + line="503">Host unreachable. Since 2.26 Network unreachable. Since 2.26 + filename="gio/gioenums.h" + line="504">Network unreachable. Since 2.26 Connection refused. Since 2.26 + filename="gio/gioenums.h" + line="505">Connection refused. Since 2.26 Connection to proxy server failed. Since 2.26 + filename="gio/gioenums.h" + line="506">Connection to proxy server failed. Since 2.26 Proxy authentication failed. Since 2.26 + filename="gio/gioenums.h" + line="507">Proxy authentication failed. Since 2.26 Proxy server needs authentication. Since 2.26 + filename="gio/gioenums.h" + line="508">Proxy server needs authentication. Since 2.26 Proxy connection is not allowed by ruleset. + filename="gio/gioenums.h" + line="509">Proxy connection is not allowed by ruleset. Since 2.26 Broken pipe. Since 2.36 + filename="gio/gioenums.h" + line="511">Broken pipe. Since 2.36 Connection closed by peer. Note that this + filename="gio/gioenums.h" + line="512">Connection closed by peer. Note that this is the same code as %G_IO_ERROR_BROKEN_PIPE; before 2.44 some "connection closed" errors returned %G_IO_ERROR_BROKEN_PIPE, but others returned %G_IO_ERROR_FAILED. Now they should all return the same @@ -67033,8 +67944,8 @@ See also #GPollableReturn for a cheaper way of returning glib:nick="not-connected" glib:name="G_IO_ERROR_NOT_CONNECTED"> Transport endpoint is not connected. Since 2.44 + filename="gio/gioenums.h" + line="517">Transport endpoint is not connected. Since 2.44 Message too large. Since 2.48. + filename="gio/gioenums.h" + line="518">Message too large. Since 2.48. No such device found. Since 2.74 + filename="gio/gioenums.h" + line="519">No such device found. Since 2.74 + + + Destination address unset. Since 2.80 #GIOExtension is an opaque data structure and can only be accessed + filename="gio/giomodule.c" + line="252">#GIOExtension is an opaque data structure and can only be accessed using the following functions. - + Gets the name under which @extension was registered. + filename="gio/giomodule.c" + line="1675">Gets the name under which @extension was registered. Note that the same type may be registered as extension for multiple extension points, under different names. - + the name of @extension. + filename="gio/giomodule.c" + line="1684">the name of @extension. a #GIOExtension + filename="gio/giomodule.c" + line="1677">a #GIOExtension Gets the priority with which @extension was registered. - + filename="gio/giomodule.c" + line="1692">Gets the priority with which @extension was registered. + the priority of @extension + filename="gio/giomodule.c" + line="1698">the priority of @extension a #GIOExtension + filename="gio/giomodule.c" + line="1694">a #GIOExtension Gets the type associated with @extension. - + filename="gio/giomodule.c" + line="1661">Gets the type associated with @extension. + the type of @extension + filename="gio/giomodule.c" + line="1667">the type of @extension a #GIOExtension + filename="gio/giomodule.c" + line="1663">a #GIOExtension @@ -67132,22 +68048,21 @@ for multiple extension points, under different names. c:identifier="g_io_extension_ref_class" introspectable="0"> Gets a reference to the class for the type that is + filename="gio/giomodule.c" + line="1646">Gets a reference to the class for the type that is associated with @extension. - + the #GTypeClass for the type of @extension + filename="gio/giomodule.c" + line="1653">the #GTypeClass for the type of @extension a #GIOExtension + filename="gio/giomodule.c" + line="1648">a #GIOExtension @@ -67158,36 +68073,83 @@ associated with @extension. disguised="1" opaque="1"> #GIOExtensionPoint is an opaque data structure and can only be accessed -using the following functions. - + filename="gio/giomodule.c" + line="87">`GIOExtensionPoint` provides a mechanism for modules to extend the +functionality of the library or application that loaded it in an +organized fashion. + +An extension point is identified by a name, and it may optionally +require that any implementation must be of a certain type (or derived +thereof). Use [func@Gio.IOExtensionPoint.register] to register an +extension point, and [method@Gio.IOExtensionPoint.set_required_type] to +set a required type. + +A module can implement an extension point by specifying the +[type@GObject.Type] that implements the functionality. Additionally, each +implementation of an extension point has a name, and a priority. Use +[func@Gio.IOExtensionPoint.implement] to implement an extension point. + +```c +GIOExtensionPoint *ep; + +// Register an extension point +ep = g_io_extension_point_register ("my-extension-point"); +g_io_extension_point_set_required_type (ep, MY_TYPE_EXAMPLE); +``` + +```c +// Implement an extension point +G_DEFINE_TYPE (MyExampleImpl, my_example_impl, MY_TYPE_EXAMPLE) +g_io_extension_point_implement ("my-extension-point", + my_example_impl_get_type (), + "my-example", + 10); +``` + + It is up to the code that registered the extension point how + it uses the implementations that have been associated with it. + Depending on the use case, it may use all implementations, or + only the one with the highest priority, or pick a specific + one by name. + + To avoid opening all modules just to find out what extension + points they implement, GIO makes use of a caching mechanism, + see [gio-querymodules](gio-querymodules.html). + You are expected to run this command after installing a + GIO module. + + The `GIO_EXTRA_MODULES` environment variable can be used to + specify additional directories to automatically load modules + from. This environment variable has the same syntax as the + `PATH`. If two modules have the same base name in different + directories, then the latter one will be ignored. If additional + directories are specified GIO will load modules from the built-in + directory last. + Finds a #GIOExtension for an extension point by name. - + filename="gio/giomodule.c" + line="1536">Finds a #GIOExtension for an extension point by name. + the #GIOExtension for @extension_point that has the + filename="gio/giomodule.c" + line="1543">the #GIOExtension for @extension_point that has the given name, or %NULL if there is no extension with that name a #GIOExtensionPoint + filename="gio/giomodule.c" + line="1538">a #GIOExtensionPoint the name of the extension to get + filename="gio/giomodule.c" + line="1539">the name of the extension to get @@ -67195,15 +68157,14 @@ using the following functions. Gets a list of all extensions that implement this extension point. + filename="gio/giomodule.c" + line="1516">Gets a list of all extensions that implement this extension point. The list is sorted by priority, beginning with the highest priority. - + a #GList of + filename="gio/giomodule.c" + line="1523">a #GList of #GIOExtensions. The list is owned by GIO and should not be modified. @@ -67213,8 +68174,8 @@ The list is sorted by priority, beginning with the highest priority. a #GIOExtensionPoint + filename="gio/giomodule.c" + line="1518">a #GIOExtensionPoint @@ -67222,22 +68183,21 @@ The list is sorted by priority, beginning with the highest priority. Gets the required type for @extension_point. - + filename="gio/giomodule.c" + line="1480">Gets the required type for @extension_point. + the #GType that all implementations must have, + filename="gio/giomodule.c" + line="1486">the #GType that all implementations must have, or %G_TYPE_INVALID if the extension point has no required type a #GIOExtensionPoint + filename="gio/giomodule.c" + line="1482">a #GIOExtensionPoint @@ -67245,112 +68205,108 @@ The list is sorted by priority, beginning with the highest priority. Sets the required type for @extension_point to @type. + filename="gio/giomodule.c" + line="1465">Sets the required type for @extension_point to @type. All implementations must henceforth have this type. - + a #GIOExtensionPoint + filename="gio/giomodule.c" + line="1467">a #GIOExtensionPoint the #GType to require + filename="gio/giomodule.c" + line="1468">the #GType to require Registers @type as extension for the extension point with name + filename="gio/giomodule.c" + line="1582">Registers @type as extension for the extension point with name @extension_point_name. If @type has already been registered as an extension for this extension point, the existing #GIOExtension object is returned. - + a #GIOExtension object for #GType + filename="gio/giomodule.c" + line="1595">a #GIOExtension object for #GType the name of the extension point + filename="gio/giomodule.c" + line="1584">the name of the extension point the #GType to register as extension + filename="gio/giomodule.c" + line="1585">the #GType to register as extension the name for the extension + filename="gio/giomodule.c" + line="1586">the name for the extension the priority for the extension + filename="gio/giomodule.c" + line="1587">the priority for the extension Looks up an existing extension point. - + filename="gio/giomodule.c" + line="1440">Looks up an existing extension point. + the #GIOExtensionPoint, or %NULL if there + filename="gio/giomodule.c" + line="1446">the #GIOExtensionPoint, or %NULL if there is no registered extension point with the given name. the name of the extension point + filename="gio/giomodule.c" + line="1442">the name of the extension point Registers an extension point. - + filename="gio/giomodule.c" + line="1402">Registers an extension point. + the new #GIOExtensionPoint. This object is + filename="gio/giomodule.c" + line="1408">the new #GIOExtensionPoint. This object is owned by GIO and should not be freed. The name of the extension point + filename="gio/giomodule.c" + line="1404">The name of the extension point @@ -67364,40 +68320,38 @@ extension point, the existing #GIOExtension object is returned. glib:get-type="g_io_module_get_type" glib:type-struct="IOModuleClass"> Provides an interface and default functions for loading and unloading + filename="gio/giomodule.c" + line="79">Provides an interface and default functions for loading and unloading modules. This is used internally to make GIO extensible, but can also be used by others to implement module loading. - + Creates a new GIOModule that will load the specific + filename="gio/giomodule.c" + line="391">Creates a new GIOModule that will load the specific shared library when in use. - + a #GIOModule from given @filename, + filename="gio/giomodule.c" + line="398">a #GIOModule from given @filename, or %NULL on error. filename of the shared library module. + filename="gio/giomodule.c" + line="393">filename of the shared library module. Optional API for GIO modules to implement. + filename="gio/giomodule.h" + line="148">Optional API for GIO modules to implement. Should return a list of all the extension points that may be implemented in this module. @@ -67428,12 +68382,11 @@ throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`. Using the new symbol names avoids name clashes when building modules statically. The old symbol names continue to be supported, but cannot be used for static builds. - + A %NULL-terminated array of strings, + filename="gio/giomodule.h" + line="183">A %NULL-terminated array of strings, listing the supported extension points of the module. The array must be suitable for freeing with g_strfreev(). @@ -67443,8 +68396,8 @@ for static builds. Required API for GIO modules to implement. + filename="gio/giomodule.h" + line="107">Required API for GIO modules to implement. This function is run after the module has been loaded into GIO, to initialize the module. Typically, this function will call @@ -67457,16 +68410,15 @@ throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`. Using the new symbol names avoids name clashes when building modules statically. The old symbol names continue to be supported, but cannot be used for static builds. - + a #GIOModule. + filename="gio/giomodule.h" + line="109">a #GIOModule. @@ -67475,8 +68427,8 @@ for static builds. c:identifier="g_io_module_unload" introspectable="0"> Required API for GIO modules to implement. + filename="gio/giomodule.h" + line="128">Required API for GIO modules to implement. This function is run when the module is being unloaded from GIO, to finalize the module. @@ -67488,16 +68440,15 @@ throughout. For example, `libgiognutls-helper.so` becomes `gnutls_helper`. Using the new symbol names avoids name clashes when building modules statically. The old symbol names continue to be supported, but cannot be used for static builds. - + a #GIOModule. + filename="gio/giomodule.h" + line="130">a #GIOModule. @@ -67508,8 +68459,7 @@ for static builds. disguised="1" opaque="1" glib:is-gtype-struct-for="IOModule"> - + opaque="1" version="2.30"> Represents a scope for loading IO modules. A scope can be used for blocking + filename="gio/giomodule.c" + line="143">Represents a scope for loading IO modules. A scope can be used for blocking duplicate modules, or blocking a module you don't want to load. The scope can be used with g_io_modules_load_all_in_directory_with_scope() or g_io_modules_scan_all_in_directory_with_scope(). - + Block modules with the given @basename from being loaded when + filename="gio/giomodule.c" + line="200">Block modules with the given @basename from being loaded when this scope is used with g_io_modules_scan_all_in_directory_with_scope() or g_io_modules_load_all_in_directory_with_scope(). - + a module loading scope + filename="gio/giomodule.c" + line="202">a module loading scope the basename to block + filename="gio/giomodule.c" + line="203">the basename to block Free a module scope. - + filename="gio/giomodule.c" + line="183">Free a module scope. + a module loading scope + filename="gio/giomodule.c" + line="185">a module loading scope @@ -67576,26 +68523,25 @@ or g_io_modules_load_all_in_directory_with_scope(). version="2.30" introspectable="0"> Create a new scope for loading of IO modules. A scope can be used for + filename="gio/giomodule.c" + line="159">Create a new scope for loading of IO modules. A scope can be used for blocking duplicate modules, or blocking a module you don't want to load. Specify the %G_IO_MODULE_SCOPE_BLOCK_DUPLICATES flag to block modules which have the same base name as a module that has already been seen in this scope. - + the new module scope + filename="gio/giomodule.c" + line="170">the new module scope flags for the new scope + filename="gio/giomodule.c" + line="161">flags for the new scope @@ -67607,16 +68553,16 @@ in this scope. glib:get-type="g_io_module_scope_flags_get_type" c:type="GIOModuleScopeFlags"> Flags for use with g_io_module_scope_new(). + filename="gio/gioenums.h" + line="1906">Flags for use with g_io_module_scope_new(). No module scan flags + filename="gio/gioenums.h" + line="1908">No module scan flags glib:nick="block-duplicates" glib:name="G_IO_MODULE_SCOPE_BLOCK_DUPLICATES"> When using this scope to load or + filename="gio/gioenums.h" + line="1909">When using this scope to load or scan modules, automatically block a modules which has the same base basename as previously loaded module. @@ -67633,34 +68579,37 @@ in this scope. - Opaque class for defining and scheduling IO jobs. - + opaque="1" + deprecated="1" + deprecated-version="2.36"> + Opaque class for defining and scheduling IO jobs. + Use [struct@GLib.ThreadPool] or + [method@Gio.Task.run_in_thread] + + deprecated="1" + deprecated-version="2.36"> Used from an I/O job to send a callback to be run in the thread + filename="gio/gioscheduler.c" + line="214">Used from an I/O job to send a callback to be run in the thread that the job was started from, waiting for the result (and thus blocking the I/O job). Use g_main_context_invoke(). - + The return value of @func + filename="gio/gioscheduler.c" + line="225">The return value of @func a #GIOSchedulerJob + filename="gio/gioscheduler.c" + line="216">a #GIOSchedulerJob closure="1" destroy="2"> a #GSourceFunc callback that will be called in the original thread + filename="gio/gioscheduler.c" + line="217">a #GSourceFunc callback that will be called in the original thread nullable="1" allow-none="1"> data to pass to @func + filename="gio/gioscheduler.c" + line="218">data to pass to @func allow-none="1" scope="async"> a #GDestroyNotify for @user_data, or %NULL + filename="gio/gioscheduler.c" + line="219">a #GDestroyNotify for @user_data, or %NULL + deprecated="1" + deprecated-version="2.36"> Used from an I/O job to send a callback to be run asynchronously in + filename="gio/gioscheduler.c" + line="269">Used from an I/O job to send a callback to be run asynchronously in the thread that the job was started from. The callback will be run when the main loop is available, but at that time the I/O job might have finished. The return value from the callback is ignored. @@ -67709,16 +68659,15 @@ on to this function you have to ensure that it is not freed before @func is called, either by passing %NULL as @notify to g_io_scheduler_push_job() or by using refcounting for @user_data. Use g_main_context_invoke(). - + a #GIOSchedulerJob + filename="gio/gioscheduler.c" + line="271">a #GIOSchedulerJob closure="1" destroy="2"> a #GSourceFunc callback that will be called in the original thread + filename="gio/gioscheduler.c" + line="272">a #GSourceFunc callback that will be called in the original thread nullable="1" allow-none="1"> data to pass to @func + filename="gio/gioscheduler.c" + line="273">data to pass to @func allow-none="1" scope="async"> a #GDestroyNotify for @user_data, or %NULL + filename="gio/gioscheduler.c" + line="274">a #GDestroyNotify for @user_data, or %NULL - + I/O Job function. + filename="gio/giotypes.h" + line="269">I/O Job function. Long-running jobs should periodically check the @cancellable to see if they have been cancelled. - + Use [struct@GLib.ThreadPool] or + [method@Gio.Task.run_in_thread] + %TRUE if this function should be called again to + filename="gio/giotypes.h" + line="280">%TRUE if this function should be called again to complete the job, %FALSE if the job is complete (or cancelled) a #GIOSchedulerJob. + filename="gio/giotypes.h" + line="271">a #GIOSchedulerJob. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/giotypes.h" + line="272">optional #GCancellable object, %NULL to ignore. nullable="1" allow-none="1"> data passed to the callback function + filename="gio/giotypes.h" + line="273">data passed to the callback function @@ -67806,83 +68759,86 @@ to see if they have been cancelled. glib:get-type="g_io_stream_get_type" glib:type-struct="IOStreamClass"> GIOStream represents an object that has both read and write streams. + filename="gio/giostream.c" + line="34">`GIOStream` represents an object that has both read and write streams. Generally the two streams act as separate input and output streams, but they share some common resources and state. For instance, for seekable streams, both streams may use the same position. -Examples of #GIOStream objects are #GSocketConnection, which represents -a two-way network connection; and #GFileIOStream, which represents a +Examples of `GIOStream` objects are [class@Gio.SocketConnection], which represents +a two-way network connection; and [class@Gio.FileIOStream], which represents a file handle opened in read-write mode. To do the actual reading and writing you need to get the substreams -with g_io_stream_get_input_stream() and g_io_stream_get_output_stream(). +with [method@Gio.IOStream.get_input_stream] and +[method@Gio.IOStream.get_output_stream]. -The #GIOStream object owns the input and the output streams, not the other -way around, so keeping the substreams alive will not keep the #GIOStream -object alive. If the #GIOStream object is freed it will be closed, thus +The `GIOStream` object owns the input and the output streams, not the other +way around, so keeping the substreams alive will not keep the `GIOStream` +object alive. If the `GIOStream` object is freed it will be closed, thus closing the substreams, so even if the substreams stay alive they will -always return %G_IO_ERROR_CLOSED for all operations. +always return `G_IO_ERROR_CLOSED` for all operations. -To close a stream use g_io_stream_close() which will close the common +To close a stream use [method@Gio.IOStream.close] which will close the common stream object and also the individual substreams. You can also close the substreams themselves. In most cases this only marks the substream as closed, so further I/O on it fails but common state in the -#GIOStream may still be open. However, some streams may support -"half-closed" states where one direction of the stream is actually shut down. - -Operations on #GIOStreams cannot be started while another operation on the -#GIOStream or its substreams is in progress. Specifically, an application can -read from the #GInputStream and write to the #GOutputStream simultaneously -(either in separate threads, or as asynchronous operations in the same -thread), but an application cannot start any #GIOStream operation while there -is a #GIOStream, #GInputStream or #GOutputStream operation in progress, and -an application can’t start any #GInputStream or #GOutputStream operation -while there is a #GIOStream operation in progress. +`GIOStream` may still be open. However, some streams may support +‘half-closed’ states where one direction of the stream is actually shut down. + +Operations on `GIOStream`s cannot be started while another operation on the +`GIOStream` or its substreams is in progress. Specifically, an application can +read from the [class@Gio.InputStream] and write to the +[class@Gio.OutputStream] simultaneously (either in separate threads, or as +asynchronous operations in the same thread), but an application cannot start +any `GIOStream` operation while there is a `GIOStream`, `GInputStream` or +`GOutputStream` operation in progress, and an application can’t start any +`GInputStream` or `GOutputStream` operation while there is a `GIOStream` +operation in progress. This is a product of individual stream operations being associated with a -given #GMainContext (the thread-default context at the time the operation was -started), rather than entire streams being associated with a single -#GMainContext. +given [type@GLib.MainContext] (the thread-default context at the time the +operation was started), rather than entire streams being associated with a +single `GMainContext`. -GIO may run operations on #GIOStreams from other (worker) threads, and this +GIO may run operations on `GIOStream`s from other (worker) threads, and this may be exposed to application code in the behaviour of wrapper streams, such -as #GBufferedInputStream or #GTlsConnection. With such wrapper APIs, -application code may only run operations on the base (wrapped) stream when -the wrapper stream is idle. Note that the semantics of such operations may -not be well-defined due to the state the wrapper stream leaves the base -stream in (though they are guaranteed not to crash). - +as [class@Gio.BufferedInputStream] or [class@Gio.TlsConnection]. With such +wrapper APIs, application code may only run operations on the base (wrapped) +stream when the wrapper stream is idle. Note that the semantics of such +operations may not be well-defined due to the state the wrapper stream leaves +the base stream in (though they are guaranteed not to crash). + Finishes an asynchronous io stream splice operation. - + filename="gio/giostream.c" + line="920">Finishes an asynchronous io stream splice operation. + %TRUE on success, %FALSE otherwise. + filename="gio/giostream.c" + line="928">%TRUE on success, %FALSE otherwise. a #GAsyncResult. + filename="gio/giostream.c" + line="922">a #GAsyncResult. - + Requests an asynchronous close of the stream, releasing resources + filename="gio/giostream.c" + line="477">Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_io_stream_close_finish() to get the result of the operation. @@ -67892,22 +68848,21 @@ For behaviour details see g_io_stream_close(). The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all. - + a #GIOStream + filename="gio/giostream.c" + line="479">a #GIOStream the io priority of the request + filename="gio/giostream.c" + line="480">the io priority of the request nullable="1" allow-none="1"> optional cancellable object + filename="gio/giostream.c" + line="481">optional cancellable object scope="async" closure="3"> callback to call when the request is satisfied + filename="gio/giostream.c" + line="482">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/giostream.c" + line="484">the data to pass to callback function @@ -67947,34 +68903,32 @@ classes. However, if you override one you must override all. version="2.22" throws="1"> Closes a stream. - + filename="gio/giostream.c" + line="535">Closes a stream. + %TRUE if stream was successfully closed, %FALSE otherwise. + filename="gio/giostream.c" + line="544">%TRUE if stream was successfully closed, %FALSE otherwise. a #GIOStream + filename="gio/giostream.c" + line="537">a #GIOStream a #GAsyncResult + filename="gio/giostream.c" + line="538">a #GAsyncResult - + @@ -67994,23 +68948,22 @@ classes. However, if you override one you must override all. invoker="get_input_stream" version="2.22"> Gets the input stream for this object. This is used + filename="gio/giostream.c" + line="229">Gets the input stream for this object. This is used for reading. - + a #GInputStream, owned by the #GIOStream. + filename="gio/giostream.c" + line="236">a #GInputStream, owned by the #GIOStream. Do not free. a #GIOStream + filename="gio/giostream.c" + line="231">a #GIOStream @@ -68019,23 +68972,22 @@ Do not free. invoker="get_output_stream" version="2.22"> Gets the output stream for this object. This is used for + filename="gio/giostream.c" + line="253">Gets the output stream for this object. This is used for writing. - + a #GOutputStream, owned by the #GIOStream. + filename="gio/giostream.c" + line="260">a #GOutputStream, owned by the #GIOStream. Do not free. a #GIOStream + filename="gio/giostream.c" + line="255">a #GIOStream @@ -68044,18 +68996,17 @@ Do not free. c:identifier="g_io_stream_clear_pending" version="2.22"> Clears the pending flag on @stream. - + filename="gio/giostream.c" + line="335">Clears the pending flag on @stream. + a #GIOStream + filename="gio/giostream.c" + line="337">a #GIOStream @@ -68063,10 +69014,11 @@ Do not free. + throws="1" + glib:async-func="close_async"> Closes the stream, releasing resources related to it. This will also + filename="gio/giostream.c" + line="372">Closes the stream, releasing resources related to it. This will also close the individual input and output streams, if they are not already closed. @@ -68099,19 +69051,18 @@ can use a faster close that doesn't block to e.g. check errors. The default implementation of this method just calls close on the individual input/output streams. - + %TRUE on success, %FALSE on failure + filename="gio/giostream.c" + line="412">%TRUE on success, %FALSE on failure a #GIOStream + filename="gio/giostream.c" + line="374">a #GIOStream nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/giostream.c" + line="375">optional #GCancellable object, %NULL to ignore + version="2.22" + glib:finish-func="close_finish" + glib:sync-func="close"> Requests an asynchronous close of the stream, releasing resources + filename="gio/giostream.c" + line="477">Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_io_stream_close_finish() to get the result of the operation. @@ -68140,22 +69093,21 @@ For behaviour details see g_io_stream_close(). The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all. - + a #GIOStream + filename="gio/giostream.c" + line="479">a #GIOStream the io priority of the request + filename="gio/giostream.c" + line="480">the io priority of the request nullable="1" allow-none="1"> optional cancellable object + filename="gio/giostream.c" + line="481">optional cancellable object scope="async" closure="3"> callback to call when the request is satisfied + filename="gio/giostream.c" + line="482">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/giostream.c" + line="484">the data to pass to callback function @@ -68194,27 +69147,26 @@ classes. However, if you override one you must override all. version="2.22" throws="1"> Closes a stream. - + filename="gio/giostream.c" + line="535">Closes a stream. + %TRUE if stream was successfully closed, %FALSE otherwise. + filename="gio/giostream.c" + line="544">%TRUE if stream was successfully closed, %FALSE otherwise. a #GIOStream + filename="gio/giostream.c" + line="537">a #GIOStream a #GAsyncResult + filename="gio/giostream.c" + line="538">a #GAsyncResult @@ -68224,23 +69176,22 @@ classes. However, if you override one you must override all. glib:get-property="input-stream" version="2.22"> Gets the input stream for this object. This is used + filename="gio/giostream.c" + line="229">Gets the input stream for this object. This is used for reading. - + a #GInputStream, owned by the #GIOStream. + filename="gio/giostream.c" + line="236">a #GInputStream, owned by the #GIOStream. Do not free. a #GIOStream + filename="gio/giostream.c" + line="231">a #GIOStream @@ -68250,23 +69201,22 @@ Do not free. glib:get-property="output-stream" version="2.22"> Gets the output stream for this object. This is used for + filename="gio/giostream.c" + line="253">Gets the output stream for this object. This is used for writing. - + a #GOutputStream, owned by the #GIOStream. + filename="gio/giostream.c" + line="260">a #GOutputStream, owned by the #GIOStream. Do not free. a #GIOStream + filename="gio/giostream.c" + line="255">a #GIOStream @@ -68275,21 +69225,20 @@ Do not free. c:identifier="g_io_stream_has_pending" version="2.22"> Checks if a stream has pending actions. - + filename="gio/giostream.c" + line="276">Checks if a stream has pending actions. + %TRUE if @stream has pending actions. + filename="gio/giostream.c" + line="282">%TRUE if @stream has pending actions. a #GIOStream + filename="gio/giostream.c" + line="278">a #GIOStream @@ -68298,21 +69247,20 @@ Do not free. c:identifier="g_io_stream_is_closed" version="2.22"> Checks if a stream is closed. - + filename="gio/giostream.c" + line="211">Checks if a stream is closed. + %TRUE if the stream is closed. + filename="gio/giostream.c" + line="217">%TRUE if the stream is closed. a #GIOStream + filename="gio/giostream.c" + line="213">a #GIOStream @@ -68322,23 +69270,22 @@ Do not free. version="2.22" throws="1"> Sets @stream to have actions pending. If the pending flag is + filename="gio/giostream.c" + line="294">Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return %FALSE and set @error. - + %TRUE if pending was previously unset and is now set. + filename="gio/giostream.c" + line="304">%TRUE if pending was previously unset and is now set. a #GIOStream + filename="gio/giostream.c" + line="296">a #GIOStream @@ -68347,42 +69294,41 @@ already set or @stream is closed, it will return %FALSE and set c:identifier="g_io_stream_splice_async" version="2.28"> Asynchronously splice the output stream of @stream1 to the input stream of + filename="gio/giostream.c" + line="841">Asynchronously splice the output stream of @stream1 to the input stream of @stream2, and splice the output stream of @stream2 to the input stream of @stream1. When the operation is finished @callback will be called. You can then call g_io_stream_splice_finish() to get the result of the operation. - + a #GIOStream. + filename="gio/giostream.c" + line="843">a #GIOStream. a #GIOStream. + filename="gio/giostream.c" + line="844">a #GIOStream. a set of #GIOStreamSpliceFlags. + filename="gio/giostream.c" + line="845">a set of #GIOStreamSpliceFlags. the io priority of the request. + filename="gio/giostream.c" + line="846">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/giostream.c" + line="847">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> a #GAsyncReadyCallback. + filename="gio/giostream.c" + line="848">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/giostream.c" + line="850">the data to pass to callback function - + + Whether the stream is closed. + The [class@Gio.InputStream] to read from. + The [class@Gio.OutputStream] to write to. @@ -68440,33 +69401,30 @@ result of the operation. c:type="GIOStreamAdapter" disguised="1" opaque="1"> - + - + - + a #GInputStream, owned by the #GIOStream. + filename="gio/giostream.c" + line="236">a #GInputStream, owned by the #GIOStream. Do not free. a #GIOStream + filename="gio/giostream.c" + line="231">a #GIOStream @@ -68474,20 +69432,19 @@ Do not free. - + a #GOutputStream, owned by the #GIOStream. + filename="gio/giostream.c" + line="260">a #GOutputStream, owned by the #GIOStream. Do not free. a #GIOStream + filename="gio/giostream.c" + line="255">a #GIOStream @@ -68495,8 +69452,7 @@ Do not free. - + @@ -68515,22 +69471,21 @@ Do not free. - + a #GIOStream + filename="gio/giostream.c" + line="479">a #GIOStream the io priority of the request + filename="gio/giostream.c" + line="480">the io priority of the request nullable="1" allow-none="1"> optional cancellable object + filename="gio/giostream.c" + line="481">optional cancellable object scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/giostream.c" + line="482">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/giostream.c" + line="484">the data to pass to callback function @@ -68568,25 +69524,24 @@ Do not free. - + %TRUE if stream was successfully closed, %FALSE otherwise. + filename="gio/giostream.c" + line="544">%TRUE if stream was successfully closed, %FALSE otherwise. a #GIOStream + filename="gio/giostream.c" + line="537">a #GIOStream a #GAsyncResult + filename="gio/giostream.c" + line="538">a #GAsyncResult @@ -68594,8 +69549,7 @@ Do not free. - + @@ -68603,8 +69557,7 @@ Do not free. - + @@ -68612,8 +69565,7 @@ Do not free. - + @@ -68621,8 +69573,7 @@ Do not free. - + @@ -68630,8 +69581,7 @@ Do not free. - + @@ -68639,8 +69589,7 @@ Do not free. - + @@ -68648,8 +69597,7 @@ Do not free. - + @@ -68657,8 +69605,7 @@ Do not free. - + @@ -68666,8 +69613,7 @@ Do not free. - + @@ -68675,8 +69621,7 @@ Do not free. - + @@ -68687,8 +69632,7 @@ Do not free. c:type="GIOStreamPrivate" disguised="1" opaque="1"> - + glib:get-type="g_io_stream_splice_flags_get_type" c:type="GIOStreamSpliceFlags"> GIOStreamSpliceFlags determine how streams should be spliced. + filename="gio/gioenums.h" + line="672">GIOStreamSpliceFlags determine how streams should be spliced. Do not close either stream. + filename="gio/gioenums.h" + line="674">Do not close either stream. glib:nick="close-stream1" glib:name="G_IO_STREAM_SPLICE_CLOSE_STREAM1"> Close the first stream after + filename="gio/gioenums.h" + line="675">Close the first stream after the splice. glib:nick="close-stream2" glib:name="G_IO_STREAM_SPLICE_CLOSE_STREAM2"> Close the second stream after + filename="gio/gioenums.h" + line="677">Close the second stream after the splice. glib:nick="wait-for-both" glib:name="G_IO_STREAM_SPLICE_WAIT_FOR_BOTH"> Wait for both splice operations to finish + filename="gio/gioenums.h" + line="679">Wait for both splice operations to finish before calling the callback. - + @@ -68751,8 +69694,7 @@ Do not free. - + @@ -68761,8 +69703,7 @@ Do not free. - + @@ -68771,8 +69712,7 @@ Do not free. - + @@ -68781,8 +69721,7 @@ Do not free. - + @@ -68791,8 +69730,7 @@ Do not free. - + @@ -68801,8 +69739,7 @@ Do not free. - + @@ -68811,8 +69748,7 @@ Do not free. - + @@ -68821,8 +69757,7 @@ Do not free. - + @@ -68831,8 +69766,7 @@ Do not free. - + @@ -68841,8 +69775,7 @@ Do not free. - + @@ -68851,8 +69784,7 @@ Do not free. - + @@ -68861,8 +69793,7 @@ Do not free. - + @@ -68871,8 +69802,7 @@ Do not free. - + @@ -68881,8 +69811,7 @@ Do not free. - + @@ -68891,8 +69820,7 @@ Do not free. - + @@ -68901,8 +69829,7 @@ Do not free. - + @@ -68911,8 +69838,7 @@ Do not free. - + @@ -68921,8 +69847,7 @@ Do not free. - + @@ -68931,8 +69856,7 @@ Do not free. - + @@ -68941,8 +69865,7 @@ Do not free. - + @@ -68951,8 +69874,7 @@ Do not free. - + @@ -68961,8 +69883,7 @@ Do not free. - + @@ -68971,8 +69892,7 @@ Do not free. - + @@ -68981,8 +69901,7 @@ Do not free. - + @@ -68991,8 +69910,7 @@ Do not free. - + @@ -69001,8 +69919,7 @@ Do not free. - + @@ -69011,8 +69928,7 @@ Do not free. - + @@ -69021,8 +69937,7 @@ Do not free. - + @@ -69031,8 +69946,7 @@ Do not free. - + @@ -69041,8 +69955,7 @@ Do not free. - + @@ -69051,8 +69964,7 @@ Do not free. - + @@ -69061,8 +69973,7 @@ Do not free. - + @@ -69071,8 +69982,7 @@ Do not free. - + @@ -69081,8 +69991,7 @@ Do not free. - + @@ -69091,8 +70000,7 @@ Do not free. - + @@ -69101,8 +70009,7 @@ Do not free. - + @@ -69111,8 +70018,7 @@ Do not free. - + @@ -69121,8 +70027,7 @@ Do not free. - + @@ -69131,8 +70036,7 @@ Do not free. - + @@ -69141,8 +70045,7 @@ Do not free. - + @@ -69151,8 +70054,7 @@ Do not free. - + @@ -69161,8 +70063,7 @@ Do not free. - + @@ -69171,8 +70072,7 @@ Do not free. - + @@ -69181,8 +70081,7 @@ Do not free. - + @@ -69191,8 +70090,7 @@ Do not free. - + @@ -69201,8 +70099,7 @@ Do not free. - + @@ -69211,8 +70108,7 @@ Do not free. - + @@ -69221,8 +70117,7 @@ Do not free. - + @@ -69231,8 +70126,7 @@ Do not free. - + @@ -69241,8 +70135,7 @@ Do not free. - + @@ -69251,8 +70144,7 @@ Do not free. - + @@ -69261,8 +70153,7 @@ Do not free. - + @@ -69271,8 +70162,7 @@ Do not free. - + @@ -69281,8 +70171,7 @@ Do not free. - + @@ -69291,8 +70180,7 @@ Do not free. - + @@ -69301,8 +70189,7 @@ Do not free. - + @@ -69311,8 +70198,7 @@ Do not free. - + @@ -69321,8 +70207,7 @@ Do not free. - + @@ -69331,8 +70216,7 @@ Do not free. - + @@ -69341,8 +70225,7 @@ Do not free. - + @@ -69351,8 +70234,7 @@ Do not free. - + @@ -69361,8 +70243,7 @@ Do not free. - + @@ -69371,8 +70252,7 @@ Do not free. - + @@ -69381,8 +70261,7 @@ Do not free. - + @@ -69391,8 +70270,7 @@ Do not free. - + @@ -69401,8 +70279,7 @@ Do not free. - + @@ -69411,8 +70288,7 @@ Do not free. - + @@ -69421,8 +70297,7 @@ Do not free. - + @@ -69431,8 +70306,7 @@ Do not free. - + @@ -69441,8 +70315,7 @@ Do not free. - + @@ -69451,8 +70324,7 @@ Do not free. - + @@ -69461,8 +70333,7 @@ Do not free. - + @@ -69471,8 +70342,7 @@ Do not free. - + @@ -69481,8 +70351,7 @@ Do not free. - + @@ -69491,8 +70360,7 @@ Do not free. - + @@ -69501,16 +70369,14 @@ Do not free. - + - + @@ -69519,8 +70385,7 @@ Do not free. - + @@ -69529,8 +70394,7 @@ Do not free. - + @@ -69539,8 +70403,7 @@ Do not free. - + @@ -69549,8 +70412,7 @@ Do not free. - + @@ -69559,8 +70421,7 @@ Do not free. - + @@ -69569,8 +70430,7 @@ Do not free. - + @@ -69579,8 +70439,7 @@ Do not free. - + @@ -69589,8 +70448,7 @@ Do not free. - + @@ -69599,8 +70457,7 @@ Do not free. - + @@ -69609,8 +70466,7 @@ Do not free. - + @@ -69619,8 +70475,7 @@ Do not free. - + @@ -69629,8 +70484,7 @@ Do not free. - + @@ -69639,8 +70493,7 @@ Do not free. - + @@ -69649,8 +70502,7 @@ Do not free. - + @@ -69659,8 +70511,7 @@ Do not free. - + @@ -69669,8 +70520,7 @@ Do not free. - + @@ -69679,8 +70529,7 @@ Do not free. - + @@ -69689,8 +70538,7 @@ Do not free. - + @@ -69699,8 +70547,7 @@ Do not free. - + @@ -69709,8 +70556,7 @@ Do not free. - + @@ -69719,16 +70565,14 @@ Do not free. - + - + @@ -69737,8 +70581,7 @@ Do not free. - + @@ -69747,8 +70590,7 @@ Do not free. - + @@ -69757,8 +70599,7 @@ Do not free. - + @@ -69767,8 +70608,7 @@ Do not free. - + @@ -69777,8 +70617,7 @@ Do not free. - + @@ -69787,8 +70626,7 @@ Do not free. - + @@ -69797,8 +70635,7 @@ Do not free. - + @@ -69807,8 +70644,7 @@ Do not free. - + @@ -69817,8 +70653,7 @@ Do not free. - + @@ -69827,8 +70662,7 @@ Do not free. - + @@ -69837,8 +70671,7 @@ Do not free. - + @@ -69847,8 +70680,7 @@ Do not free. - + @@ -69857,8 +70689,7 @@ Do not free. - + @@ -69867,8 +70698,7 @@ Do not free. - + @@ -69877,8 +70707,7 @@ Do not free. - + @@ -69887,8 +70716,7 @@ Do not free. - + @@ -69897,16 +70725,14 @@ Do not free. - + - + @@ -69915,8 +70741,7 @@ Do not free. - + @@ -69925,8 +70750,7 @@ Do not free. - + @@ -69935,8 +70759,7 @@ Do not free. - + @@ -69945,8 +70768,7 @@ Do not free. - + @@ -69955,8 +70777,7 @@ Do not free. - + @@ -69965,8 +70786,7 @@ Do not free. - + @@ -69975,8 +70795,7 @@ Do not free. - + @@ -69985,8 +70804,7 @@ Do not free. - + @@ -69995,8 +70813,7 @@ Do not free. - + @@ -70005,8 +70822,7 @@ Do not free. - + @@ -70015,8 +70831,7 @@ Do not free. - + @@ -70025,8 +70840,7 @@ Do not free. - + @@ -70035,8 +70849,7 @@ Do not free. - + @@ -70045,8 +70858,7 @@ Do not free. - + @@ -70055,8 +70867,7 @@ Do not free. - + @@ -70065,8 +70876,7 @@ Do not free. - + @@ -70075,8 +70885,7 @@ Do not free. - + @@ -70085,8 +70894,7 @@ Do not free. - + @@ -70095,8 +70903,7 @@ Do not free. - + @@ -70105,8 +70912,7 @@ Do not free. - + @@ -70115,8 +70921,7 @@ Do not free. - + @@ -70125,8 +70930,7 @@ Do not free. - + @@ -70135,8 +70939,7 @@ Do not free. - + @@ -70145,8 +70948,7 @@ Do not free. - + @@ -70155,8 +70957,7 @@ Do not free. - + @@ -70165,8 +70966,7 @@ Do not free. - + @@ -70175,8 +70975,7 @@ Do not free. - + @@ -70185,8 +70984,7 @@ Do not free. - + @@ -70195,8 +70993,7 @@ Do not free. - + @@ -70205,8 +71002,7 @@ Do not free. - + @@ -70215,8 +71011,7 @@ Do not free. - + @@ -70225,8 +71020,7 @@ Do not free. - + @@ -70235,8 +71029,7 @@ Do not free. - + @@ -70245,8 +71038,7 @@ Do not free. - + @@ -70255,8 +71047,7 @@ Do not free. - + @@ -70265,8 +71056,7 @@ Do not free. - + @@ -70275,8 +71065,7 @@ Do not free. - + @@ -70285,8 +71074,7 @@ Do not free. - + @@ -70295,8 +71083,7 @@ Do not free. - + @@ -70305,8 +71092,7 @@ Do not free. - + @@ -70315,8 +71101,7 @@ Do not free. - + @@ -70325,8 +71110,7 @@ Do not free. - + @@ -70335,8 +71119,7 @@ Do not free. - + @@ -70345,8 +71128,7 @@ Do not free. - + @@ -70355,8 +71137,7 @@ Do not free. - + @@ -70365,8 +71146,7 @@ Do not free. - + @@ -70375,8 +71155,7 @@ Do not free. - + @@ -70385,8 +71164,7 @@ Do not free. - + @@ -70395,8 +71173,7 @@ Do not free. - + @@ -70405,8 +71182,7 @@ Do not free. - + @@ -70415,8 +71191,7 @@ Do not free. - + @@ -70425,8 +71200,7 @@ Do not free. - + @@ -70435,8 +71209,7 @@ Do not free. - + @@ -70445,8 +71218,7 @@ Do not free. - + @@ -70455,8 +71227,7 @@ Do not free. - + @@ -70465,8 +71236,7 @@ Do not free. - + @@ -70475,8 +71245,7 @@ Do not free. - + @@ -70485,8 +71254,7 @@ Do not free. - + @@ -70495,8 +71263,7 @@ Do not free. - + @@ -70505,8 +71272,7 @@ Do not free. - + @@ -70515,8 +71281,7 @@ Do not free. - + @@ -70525,8 +71290,7 @@ Do not free. - + @@ -70535,8 +71299,7 @@ Do not free. - + @@ -70545,8 +71308,7 @@ Do not free. - + @@ -70555,8 +71317,7 @@ Do not free. - + @@ -70565,8 +71326,7 @@ Do not free. - + @@ -70575,8 +71335,7 @@ Do not free. - + @@ -70585,8 +71344,7 @@ Do not free. - + @@ -70595,8 +71353,7 @@ Do not free. - + @@ -70605,16 +71362,14 @@ Do not free. - + - + @@ -70623,8 +71378,7 @@ Do not free. - + @@ -70633,8 +71387,7 @@ Do not free. - + @@ -70643,8 +71396,7 @@ Do not free. - + @@ -70653,8 +71405,7 @@ Do not free. - + @@ -70663,8 +71414,7 @@ Do not free. - + @@ -70673,8 +71423,7 @@ Do not free. - + @@ -70683,8 +71432,7 @@ Do not free. - + @@ -70693,8 +71441,7 @@ Do not free. - + @@ -70703,8 +71450,7 @@ Do not free. - + @@ -70713,8 +71459,7 @@ Do not free. - + @@ -70723,8 +71468,7 @@ Do not free. - + @@ -70733,8 +71477,7 @@ Do not free. - + @@ -70743,8 +71486,7 @@ Do not free. - + @@ -70753,8 +71495,7 @@ Do not free. - + @@ -70763,8 +71504,7 @@ Do not free. - + @@ -70773,8 +71513,7 @@ Do not free. - + @@ -70783,8 +71522,7 @@ Do not free. - + @@ -70793,8 +71531,7 @@ Do not free. - + @@ -70803,8 +71540,7 @@ Do not free. - + @@ -70813,8 +71549,7 @@ Do not free. - + @@ -70823,8 +71558,7 @@ Do not free. - + @@ -70833,8 +71567,7 @@ Do not free. - + @@ -70843,8 +71576,7 @@ Do not free. - + @@ -70853,8 +71585,7 @@ Do not free. - + @@ -70863,8 +71594,7 @@ Do not free. - + @@ -70873,8 +71603,7 @@ Do not free. - + @@ -70883,8 +71612,7 @@ Do not free. - + @@ -70893,8 +71621,7 @@ Do not free. - + @@ -70903,8 +71630,7 @@ Do not free. - + @@ -70913,8 +71639,7 @@ Do not free. - + @@ -70923,8 +71648,7 @@ Do not free. - + @@ -70933,8 +71657,7 @@ Do not free. - + @@ -70943,8 +71666,7 @@ Do not free. - + @@ -70953,8 +71675,7 @@ Do not free. - + @@ -70963,8 +71684,7 @@ Do not free. - + @@ -70973,8 +71693,7 @@ Do not free. - + @@ -70983,8 +71702,7 @@ Do not free. - + @@ -70993,8 +71711,7 @@ Do not free. - + @@ -71003,8 +71720,7 @@ Do not free. - + @@ -71013,16 +71729,14 @@ Do not free. - + - + @@ -71031,8 +71745,7 @@ Do not free. - + @@ -71041,8 +71754,7 @@ Do not free. - + @@ -71051,8 +71763,7 @@ Do not free. - + @@ -71061,8 +71772,7 @@ Do not free. - + @@ -71071,8 +71781,7 @@ Do not free. - + @@ -71081,8 +71790,7 @@ Do not free. - + @@ -71091,8 +71799,7 @@ Do not free. - + @@ -71101,8 +71808,7 @@ Do not free. - + @@ -71115,56 +71821,56 @@ Do not free. glib:get-type="g_icon_get_type" glib:type-struct="IconIface"> #GIcon is a very minimal interface for icons. It provides functions + filename="gio/gicon.c" + line="43">`GIcon` is a very minimal interface for icons. It provides functions for checking the equality of two icons, hashing of icons and serializing an icon to and from strings. -#GIcon does not provide the actual pixmap for the icon as this is out -of GIO's scope, however implementations of #GIcon may contain the name -of an icon (see #GThemedIcon), or the path to an icon (see #GLoadableIcon). +`GIcon` does not provide the actual pixmap for the icon as this is out +of GIO's scope, however implementations of `GIcon` may contain the name +of an icon (see [class@Gio.ThemedIcon]), or the path to an icon +(see [iface@Gio.LoadableIcon]). -To obtain a hash of a #GIcon, see g_icon_hash(). +To obtain a hash of a `GIcon`, see [method@Gio.Icon.hash]. -To check if two #GIcons are equal, see g_icon_equal(). +To check if two `GIcon`s are equal, see [method@Gio.Icon.equal]. -For serializing a #GIcon, use g_icon_serialize() and -g_icon_deserialize(). +For serializing a `GIcon`, use [method@Gio.Icon.serialize] and +[func@Gio.Icon.deserialize]. -If you want to consume #GIcon (for example, in a toolkit) you must +If you want to consume `GIcon` (for example, in a toolkit) you must be prepared to handle at least the three following cases: -#GLoadableIcon, #GThemedIcon and #GEmblemedIcon. It may also make -sense to have fast-paths for other cases (like handling #GdkPixbuf -directly, for example) but all compliant #GIcon implementations -outside of GIO must implement #GLoadableIcon. +[iface@Gio.LoadableIcon], [class@Gio.ThemedIcon] and [class@Gio.EmblemedIcon]. +It may also make sense to have fast-paths for other cases (like handling +[`GdkPixbuf`](https://docs.gtk.org/gdk-pixbuf/class.Pixbuf.html) directly, +for example) but all compliant `GIcon` implementations outside of GIO must +implement [iface@Gio.LoadableIcon]. -If your application or library provides one or more #GIcon +If your application or library provides one or more `GIcon` implementations you need to ensure that your new implementation also -implements #GLoadableIcon. Additionally, you must provide an -implementation of g_icon_serialize() that gives a result that is -understood by g_icon_deserialize(), yielding one of the built-in icon -types. - +implements [iface@Gio.LoadableIcon]. Additionally, you must provide an +implementation of [method@Gio.Icon.serialize] that gives a result that is +understood by [func@Gio.Icon.deserialize], yielding one of the built-in +icon types. + Deserializes a #GIcon previously serialized using g_icon_serialize(). - + filename="gio/gicon.c" + line="559">Deserializes a #GIcon previously serialized using g_icon_serialize(). + a #GIcon, or %NULL when deserialization fails. + filename="gio/gicon.c" + line="565">a #GIcon, or %NULL when deserialization fails. a #GVariant created with g_icon_serialize() + filename="gio/gicon.c" + line="561">a #GVariant created with g_icon_serialize() @@ -71174,41 +71880,39 @@ types. version="2.20" throws="1"> Generate a #GIcon instance from @str. This function can fail if + filename="gio/gicon.c" + line="425">Generate a #GIcon instance from @str. This function can fail if @str is not valid - see g_icon_to_string() for discussion. If your application or library provides one or more #GIcon implementations you need to ensure that each #GType is registered with the type system prior to calling g_icon_new_for_string(). - + An object implementing the #GIcon + filename="gio/gicon.c" + line="437">An object implementing the #GIcon interface or %NULL if @error is set. A string obtained via g_icon_to_string(). + filename="gio/gicon.c" + line="427">A string obtained via g_icon_to_string(). Checks if two icons are equal. - + filename="gio/gicon.c" + line="107">Checks if two icons are equal. + %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. + filename="gio/gicon.c" + line="114">%TRUE if @icon1 is equal to @icon2. %FALSE otherwise. @@ -71217,8 +71921,8 @@ with the type system prior to calling g_icon_new_for_string(). nullable="1" allow-none="1"> pointer to the first #GIcon. + filename="gio/gicon.c" + line="109">pointer to the first #GIcon. nullable="1" allow-none="1"> pointer to the second #GIcon. + filename="gio/gicon.c" + line="110">pointer to the second #GIcon. Gets a hash for an icon. - + filename="gio/gicon.c" + line="86">Gets a hash for an icon. + a #guint containing a hash for the @icon, suitable for -use in a #GHashTable or similar data structure. + filename="gio/gicon.c" + line="92">a #guint containing a hash for the @icon, suitable for + use in a #GHashTable or similar data structure. #gconstpointer to an icon object. + filename="gio/gicon.c" + line="88">#gconstpointer to an icon object. Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved + filename="gio/gicon.c" + line="646">Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved back by calling g_icon_deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the #GVariant between processes on the same machine, (as opposed to over the network), and within the same file system namespace. - + a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. + filename="gio/gicon.c" + line="656">a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. a #GIcon + filename="gio/gicon.c" + line="648">a #GIcon Serializes the @icon into string tokens. + filename="gio/gicon.h" + line="68">Serializes the @icon into string tokens. This is can be invoked when g_icon_new_for_string() is called. - + %TRUE if serialization took place, %FALSE otherwise + filename="gio/gicon.h" + line="78">%TRUE if serialization took place, %FALSE otherwise The #GIcon + filename="gio/gicon.h" + line="70">The #GIcon caller-allocates="1" transfer-ownership="none"> + filename="gio/gicon.h" + line="71"> The array to fill with tokens @@ -71316,22 +72017,21 @@ This is can be invoked when g_icon_new_for_string() is called. caller-allocates="0" transfer-ownership="full"> version of serialized tokens + filename="gio/gicon.h" + line="73">version of serialized tokens Checks if two icons are equal. - + filename="gio/gicon.c" + line="107">Checks if two icons are equal. + %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. + filename="gio/gicon.c" + line="114">%TRUE if @icon1 is equal to @icon2. %FALSE otherwise. @@ -71340,8 +72040,8 @@ This is can be invoked when g_icon_new_for_string() is called. nullable="1" allow-none="1"> pointer to the first #GIcon. + filename="gio/gicon.c" + line="109">pointer to the first #GIcon. nullable="1" allow-none="1"> pointer to the second #GIcon. + filename="gio/gicon.c" + line="110">pointer to the second #GIcon. Gets a hash for an icon. - + filename="gio/gicon.c" + line="86">Gets a hash for an icon. + a #guint containing a hash for the @icon, suitable for -use in a #GHashTable or similar data structure. + filename="gio/gicon.c" + line="92">a #guint containing a hash for the @icon, suitable for + use in a #GHashTable or similar data structure. #gconstpointer to an icon object. + filename="gio/gicon.c" + line="88">#gconstpointer to an icon object. Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved + filename="gio/gicon.c" + line="646">Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved back by calling g_icon_deserialize() on the returned value. As serialization will avoid using raw icon data when possible, it only makes sense to transfer the #GVariant between processes on the same machine, (as opposed to over the network), and within the same file system namespace. - + a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. + filename="gio/gicon.c" + line="656">a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. a #GIcon + filename="gio/gicon.c" + line="648">a #GIcon Generates a textual representation of @icon that can be used for + filename="gio/gicon.c" + line="185">Generates a textual representation of @icon that can be used for serialization such as when passing @icon to a different process or saving it to persistent storage. Use g_icon_new_for_string() to get @icon back from the returned string. @@ -71421,20 +72119,19 @@ in the following two cases - If @icon is a #GThemedIcon with exactly one name and no fallbacks, the encoding is simply the name (such as `network-server`). - + An allocated NUL-terminated UTF8 string or + filename="gio/gicon.c" + line="206">An allocated NUL-terminated UTF8 string or %NULL if @icon can't be serialized. Use g_free() to free. a #GIcon. + filename="gio/gicon.c" + line="187">a #GIcon. @@ -71444,47 +72141,50 @@ in the following two cases c:type="GIconIface" glib:is-gtype-struct-for="Icon"> GIconIface is used to implement GIcon types for various + filename="gio/gicon.h" + line="41">GIconIface is used to implement GIcon types for various different systems. See #GThemedIcon and #GLoadableIcon for examples of how to implement this interface. - + The parent interface. + filename="gio/gicon.h" + line="43">The parent interface. + A hash for a given #GIcon. - + a #guint containing a hash for the @icon, suitable for -use in a #GHashTable or similar data structure. + filename="gio/gicon.c" + line="92">a #guint containing a hash for the @icon, suitable for + use in a #GHashTable or similar data structure. #gconstpointer to an icon object. + filename="gio/gicon.c" + line="88">#gconstpointer to an icon object. + Checks if two #GIcons are equal. - + %TRUE if @icon1 is equal to @icon2. %FALSE otherwise. + filename="gio/gicon.c" + line="114">%TRUE if @icon1 is equal to @icon2. %FALSE otherwise. @@ -71493,8 +72193,8 @@ use in a #GHashTable or similar data structure. nullable="1" allow-none="1"> pointer to the first #GIcon. + filename="gio/gicon.c" + line="109">pointer to the first #GIcon. nullable="1" allow-none="1"> pointer to the second #GIcon. + filename="gio/gicon.c" + line="110">pointer to the second #GIcon. + Serializes a #GIcon into tokens. The tokens must not +contain any whitespace. Don't implement if the #GIcon can't be +serialized (Since 2.20). - + %TRUE if serialization took place, %FALSE otherwise + filename="gio/gicon.h" + line="78">%TRUE if serialization took place, %FALSE otherwise The #GIcon + filename="gio/gicon.h" + line="70">The #GIcon caller-allocates="1" transfer-ownership="none"> + filename="gio/gicon.h" + line="71"> The array to fill with tokens @@ -71543,17 +72247,21 @@ use in a #GHashTable or similar data structure. caller-allocates="0" transfer-ownership="full"> version of serialized tokens + filename="gio/gicon.h" + line="73">version of serialized tokens + Constructs a #GIcon from tokens. Set the #GError if +the tokens are malformed. Don't implement if the #GIcon can't be +serialized (Since 2.20). - + @@ -71571,20 +72279,22 @@ use in a #GHashTable or similar data structure. + Serializes a #GIcon into a #GVariant. Since: 2.38 - + a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. + filename="gio/gicon.c" + line="656">a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating. a #GIcon + filename="gio/gicon.c" + line="648">a #GIcon @@ -71599,32 +72309,30 @@ use in a #GHashTable or similar data structure. glib:get-type="g_inet_address_get_type" glib:type-struct="InetAddressClass"> #GInetAddress represents an IPv4 or IPv6 internet address. Use -g_resolver_lookup_by_name() or g_resolver_lookup_by_name_async() to -look up the #GInetAddress for a hostname. Use -g_resolver_lookup_by_address() or -g_resolver_lookup_by_address_async() to look up the hostname for a -#GInetAddress. + filename="gio/ginetaddress.c" + line="47">`GInetAddress` represents an IPv4 or IPv6 internet address. Use +[method@Gio.Resolver.lookup_by_name] or +[method@Gio.Resolver.lookup_by_name_async] to look up the `GInetAddress` for +a hostname. Use [method@Gio.Resolver.lookup_by_address] or +[method@Gio.Resolver.lookup_by_address_async] to look up the hostname for a +`GInetAddress`. To actually connect to a remote host, you will need a -#GInetSocketAddress (which includes a #GInetAddress as well as a +[class@Gio.InetSocketAddress] (which includes a `GInetAddress` as well as a port number). - + Creates a #GInetAddress for the "any" address (unassigned/"don't + filename="gio/ginetaddress.c" + line="461">Creates a #GInetAddress for the "any" address (unassigned/"don't care") for @family. - + a new #GInetAddress corresponding to the "any" address + filename="gio/ginetaddress.c" + line="468">a new #GInetAddress corresponding to the "any" address for @family. Free the returned object with g_object_unref(). @@ -71632,8 +72340,8 @@ for @family. the address family + filename="gio/ginetaddress.c" + line="463">the address family @@ -71642,32 +72350,31 @@ for @family. c:identifier="g_inet_address_new_from_bytes" version="2.22"> Creates a new #GInetAddress from the given @family and @bytes. + filename="gio/ginetaddress.c" + line="404">Creates a new #GInetAddress from the given @family and @bytes. @bytes should be 4 bytes for %G_SOCKET_FAMILY_IPV4 and 16 bytes for %G_SOCKET_FAMILY_IPV6. - + a new #GInetAddress corresponding to @family and @bytes. + filename="gio/ginetaddress.c" + line="413">a new #GInetAddress corresponding to @family and @bytes. Free the returned object with g_object_unref(). raw address data + filename="gio/ginetaddress.c" + line="406">raw address data the address family of @bytes + filename="gio/ginetaddress.c" + line="407">the address family of @bytes @@ -71676,14 +72383,13 @@ for @family. c:identifier="g_inet_address_new_from_string" version="2.22"> Parses @string as an IP address and creates a new #GInetAddress. - + filename="gio/ginetaddress.c" + line="364">Parses @string as an IP address and creates a new #GInetAddress. + a new #GInetAddress corresponding + filename="gio/ginetaddress.c" + line="370">a new #GInetAddress corresponding to @string, or %NULL if @string could not be parsed. Free the returned object with g_object_unref(). @@ -71691,8 +72397,8 @@ to @string, or %NULL if @string could not be parsed. a string representation of an IP address + filename="gio/ginetaddress.c" + line="366">a string representation of an IP address @@ -71701,14 +72407,13 @@ to @string, or %NULL if @string could not be parsed. c:identifier="g_inet_address_new_loopback" version="2.22"> Creates a #GInetAddress for the loopback address for @family. - + filename="gio/ginetaddress.c" + line="430">Creates a #GInetAddress for the loopback address for @family. + a new #GInetAddress corresponding to the loopback address + filename="gio/ginetaddress.c" + line="436">a new #GInetAddress corresponding to the loopback address for @family. Free the returned object with g_object_unref(). @@ -71716,8 +72421,8 @@ for @family. the address family + filename="gio/ginetaddress.c" + line="432">the address family @@ -71727,14 +72432,13 @@ for @family. version="2.22" introspectable="0"> Gets the raw binary address data from @address. - + filename="gio/ginetaddress.c" + line="528">Gets the raw binary address data from @address. + a pointer to an internal array of the bytes in @address, + filename="gio/ginetaddress.c" + line="534">a pointer to an internal array of the bytes in @address, which should not be modified, stored, or freed. The size of this array can be gotten with g_inet_address_get_native_size(). @@ -71742,57 +72446,55 @@ array can be gotten with g_inet_address_get_native_size(). a #GInetAddress + filename="gio/ginetaddress.c" + line="530">a #GInetAddress Converts @address to string form. - + filename="gio/ginetaddress.c" + line="494">Converts @address to string form. + a representation of @address as a string, which should be + filename="gio/ginetaddress.c" + line="500">a representation of @address as a string, which should be freed after use. a #GInetAddress + filename="gio/ginetaddress.c" + line="496">a #GInetAddress Checks if two #GInetAddress instances are equal, e.g. the same address. - + filename="gio/ginetaddress.c" + line="869">Checks if two #GInetAddress instances are equal, e.g. the same address. + %TRUE if @address and @other_address are equal, %FALSE otherwise. + filename="gio/ginetaddress.c" + line="876">%TRUE if @address and @other_address are equal, %FALSE otherwise. A #GInetAddress. + filename="gio/ginetaddress.c" + line="871">A #GInetAddress. Another #GInetAddress. + filename="gio/ginetaddress.c" + line="872">Another #GInetAddress. @@ -71802,21 +72504,20 @@ freed after use. glib:get-property="family" version="2.22"> Gets @address's family - + filename="gio/ginetaddress.c" + line="571">Gets @address's family + @address's family + filename="gio/ginetaddress.c" + line="577">@address's family a #GInetAddress + filename="gio/ginetaddress.c" + line="573">a #GInetAddress @@ -71826,21 +72527,20 @@ freed after use. glib:get-property="is-any" version="2.22"> Tests whether @address is the "any" address for its family. - + filename="gio/ginetaddress.c" + line="589">Tests whether @address is the "any" address for its family. + %TRUE if @address is the "any" address for its family. + filename="gio/ginetaddress.c" + line="595">%TRUE if @address is the "any" address for its family. a #GInetAddress + filename="gio/ginetaddress.c" + line="591">a #GInetAddress @@ -71850,23 +72550,22 @@ freed after use. glib:get-property="is-link-local" version="2.22"> Tests whether @address is a link-local address (that is, if it + filename="gio/ginetaddress.c" + line="648">Tests whether @address is a link-local address (that is, if it identifies a host on a local network that is not connected to the Internet). - + %TRUE if @address is a link-local address. + filename="gio/ginetaddress.c" + line="656">%TRUE if @address is a link-local address. a #GInetAddress + filename="gio/ginetaddress.c" + line="650">a #GInetAddress @@ -71876,21 +72575,20 @@ Internet). glib:get-property="is-loopback" version="2.22"> Tests whether @address is the loopback address for its family. - + filename="gio/ginetaddress.c" + line="618">Tests whether @address is the loopback address for its family. + %TRUE if @address is the loopback address for its family. + filename="gio/ginetaddress.c" + line="624">%TRUE if @address is the loopback address for its family. a #GInetAddress + filename="gio/ginetaddress.c" + line="620">a #GInetAddress @@ -71900,21 +72598,20 @@ Internet). glib:get-property="is-mc-global" version="2.22"> Tests whether @address is a global multicast address. - + filename="gio/ginetaddress.c" + line="744">Tests whether @address is a global multicast address. + %TRUE if @address is a global multicast address. + filename="gio/ginetaddress.c" + line="750">%TRUE if @address is a global multicast address. a #GInetAddress + filename="gio/ginetaddress.c" + line="746">a #GInetAddress @@ -71924,21 +72621,20 @@ Internet). glib:get-property="is-mc-link-local" version="2.22"> Tests whether @address is a link-local multicast address. - + filename="gio/ginetaddress.c" + line="769">Tests whether @address is a link-local multicast address. + %TRUE if @address is a link-local multicast address. + filename="gio/ginetaddress.c" + line="775">%TRUE if @address is a link-local multicast address. a #GInetAddress + filename="gio/ginetaddress.c" + line="771">a #GInetAddress @@ -71948,21 +72644,20 @@ Internet). glib:get-property="is-mc-node-local" version="2.22"> Tests whether @address is a node-local multicast address. - + filename="gio/ginetaddress.c" + line="794">Tests whether @address is a node-local multicast address. + %TRUE if @address is a node-local multicast address. + filename="gio/ginetaddress.c" + line="800">%TRUE if @address is a node-local multicast address. a #GInetAddress + filename="gio/ginetaddress.c" + line="796">a #GInetAddress @@ -71972,21 +72667,20 @@ Internet). glib:get-property="is-mc-org-local" version="2.22"> Tests whether @address is an organization-local multicast address. - + filename="gio/ginetaddress.c" + line="819">Tests whether @address is an organization-local multicast address. + %TRUE if @address is an organization-local multicast address. + filename="gio/ginetaddress.c" + line="825">%TRUE if @address is an organization-local multicast address. a #GInetAddress + filename="gio/ginetaddress.c" + line="821">a #GInetAddress @@ -71996,21 +72690,20 @@ Internet). glib:get-property="is-mc-site-local" version="2.22"> Tests whether @address is a site-local multicast address. - + filename="gio/ginetaddress.c" + line="844">Tests whether @address is a site-local multicast address. + %TRUE if @address is a site-local multicast address. + filename="gio/ginetaddress.c" + line="850">%TRUE if @address is a site-local multicast address. a #GInetAddress + filename="gio/ginetaddress.c" + line="846">a #GInetAddress @@ -72020,21 +72713,20 @@ Internet). glib:get-property="is-multicast" version="2.22"> Tests whether @address is a multicast address. - + filename="gio/ginetaddress.c" + line="715">Tests whether @address is a multicast address. + %TRUE if @address is a multicast address. + filename="gio/ginetaddress.c" + line="721">%TRUE if @address is a multicast address. a #GInetAddress + filename="gio/ginetaddress.c" + line="717">a #GInetAddress @@ -72044,24 +72736,23 @@ Internet). glib:get-property="is-site-local" version="2.22"> Tests whether @address is a site-local address such as 10.0.0.1 + filename="gio/ginetaddress.c" + line="680">Tests whether @address is a site-local address such as 10.0.0.1 (that is, the address identifies a host on a local network that can not be reached directly from the Internet, but which may have outgoing Internet connectivity via a NAT or firewall). - + %TRUE if @address is a site-local address. + filename="gio/ginetaddress.c" + line="689">%TRUE if @address is a site-local address. a #GInetAddress + filename="gio/ginetaddress.c" + line="682">a #GInetAddress @@ -72070,22 +72761,21 @@ outgoing Internet connectivity via a NAT or firewall). c:identifier="g_inet_address_get_native_size" version="2.22"> Gets the size of the native raw binary address for @address. This + filename="gio/ginetaddress.c" + line="548">Gets the size of the native raw binary address for @address. This is the size of the data that you get from g_inet_address_to_bytes(). - + the number of bytes used for the native version of @address. + filename="gio/ginetaddress.c" + line="555">the number of bytes used for the native version of @address. a #GInetAddress + filename="gio/ginetaddress.c" + line="550">a #GInetAddress @@ -72095,14 +72785,13 @@ is the size of the data that you get from g_inet_address_to_bytes(). version="2.22" introspectable="0"> Gets the raw binary address data from @address. - + filename="gio/ginetaddress.c" + line="528">Gets the raw binary address data from @address. + a pointer to an internal array of the bytes in @address, + filename="gio/ginetaddress.c" + line="534">a pointer to an internal array of the bytes in @address, which should not be modified, stored, or freed. The size of this array can be gotten with g_inet_address_get_native_size(). @@ -72110,8 +72799,8 @@ array can be gotten with g_inet_address_get_native_size(). a #GInetAddress + filename="gio/ginetaddress.c" + line="530">a #GInetAddress @@ -72120,38 +72809,45 @@ array can be gotten with g_inet_address_get_native_size(). c:identifier="g_inet_address_to_string" version="2.22"> Converts @address to string form. - + filename="gio/ginetaddress.c" + line="494">Converts @address to string form. + a representation of @address as a string, which should be + filename="gio/ginetaddress.c" + line="500">a representation of @address as a string, which should be freed after use. a #GInetAddress + filename="gio/ginetaddress.c" + line="496">a #GInetAddress + The raw address data. + The address family (IPv4 or IPv6). getter="get_is_any" default-value="FALSE"> Whether this is the "any" address for its family. + filename="gio/ginetaddress.c" + line="216">Whether this is the "any" address for its family. See g_inet_address_get_is_any(). @@ -72171,8 +72867,8 @@ See g_inet_address_get_is_any(). getter="get_is_link_local" default-value="FALSE"> Whether this is a link-local address. + filename="gio/ginetaddress.c" + line="230">Whether this is a link-local address. See g_inet_address_get_is_link_local(). @@ -72182,8 +72878,8 @@ See g_inet_address_get_is_link_local(). getter="get_is_loopback" default-value="FALSE"> Whether this is the loopback address for its family. + filename="gio/ginetaddress.c" + line="244">Whether this is the loopback address for its family. See g_inet_address_get_is_loopback(). @@ -72193,8 +72889,8 @@ See g_inet_address_get_is_loopback(). getter="get_is_mc_global" default-value="FALSE"> Whether this is a global multicast address. + filename="gio/ginetaddress.c" + line="286">Whether this is a global multicast address. See g_inet_address_get_is_mc_global(). @@ -72204,8 +72900,8 @@ See g_inet_address_get_is_mc_global(). getter="get_is_mc_link_local" default-value="FALSE"> Whether this is a link-local multicast address. + filename="gio/ginetaddress.c" + line="301">Whether this is a link-local multicast address. See g_inet_address_get_is_mc_link_local(). @@ -72215,8 +72911,8 @@ See g_inet_address_get_is_mc_link_local(). getter="get_is_mc_node_local" default-value="FALSE"> Whether this is a node-local multicast address. + filename="gio/ginetaddress.c" + line="315">Whether this is a node-local multicast address. See g_inet_address_get_is_mc_node_local(). @@ -72226,8 +72922,8 @@ See g_inet_address_get_is_mc_node_local(). getter="get_is_mc_org_local" default-value="FALSE"> Whether this is an organization-local multicast address. + filename="gio/ginetaddress.c" + line="329">Whether this is an organization-local multicast address. See g_inet_address_get_is_mc_org_local(). @@ -72237,8 +72933,8 @@ See g_inet_address_get_is_mc_org_local(). getter="get_is_mc_site_local" default-value="FALSE"> Whether this is a site-local multicast address. + filename="gio/ginetaddress.c" + line="343">Whether this is a site-local multicast address. See g_inet_address_get_is_mc_site_local(). @@ -72248,8 +72944,8 @@ See g_inet_address_get_is_mc_site_local(). getter="get_is_multicast" default-value="FALSE"> Whether this is a multicast address. + filename="gio/ginetaddress.c" + line="272">Whether this is a multicast address. See g_inet_address_get_is_multicast(). @@ -72259,8 +72955,8 @@ See g_inet_address_get_is_multicast(). getter="get_is_site_local" default-value="FALSE"> Whether this is a site-local address. + filename="gio/ginetaddress.c" + line="258">Whether this is a site-local address. See g_inet_address_get_is_loopback(). @@ -72274,27 +72970,25 @@ See g_inet_address_get_is_loopback(). - + - + a representation of @address as a string, which should be + filename="gio/ginetaddress.c" + line="500">a representation of @address as a string, which should be freed after use. a #GInetAddress + filename="gio/ginetaddress.c" + line="496">a #GInetAddress @@ -72302,12 +72996,11 @@ freed after use. - + a pointer to an internal array of the bytes in @address, + filename="gio/ginetaddress.c" + line="534">a pointer to an internal array of the bytes in @address, which should not be modified, stored, or freed. The size of this array can be gotten with g_inet_address_get_native_size(). @@ -72315,8 +73008,8 @@ array can be gotten with g_inet_address_get_native_size(). a #GInetAddress + filename="gio/ginetaddress.c" + line="530">a #GInetAddress @@ -72332,41 +73025,39 @@ array can be gotten with g_inet_address_get_native_size(). glib:get-type="g_inet_address_mask_get_type" glib:type-struct="InetAddressMaskClass"> #GInetAddressMask represents a range of IPv4 or IPv6 addresses + filename="gio/ginetaddressmask.c" + line="33">`GInetAddressMask` represents a range of IPv4 or IPv6 addresses described by a base address and a length indicating how many bits of the base address are relevant for matching purposes. These are -often given in string form. Eg, "10.0.0.0/8", or "fe80::/10". - +often given in string form. For example, `10.0.0.0/8`, or `fe80::/10`. + Creates a new #GInetAddressMask representing all addresses whose + filename="gio/ginetaddressmask.c" + line="252">Creates a new #GInetAddressMask representing all addresses whose first @length bits match @addr. - + a new #GInetAddressMask, or %NULL on error + filename="gio/ginetaddressmask.c" + line="261">a new #GInetAddressMask, or %NULL on error a #GInetAddress + filename="gio/ginetaddressmask.c" + line="254">a #GInetAddress number of bits of @addr to use + filename="gio/ginetaddressmask.c" + line="255">number of bits of @addr to use @@ -72376,25 +73067,24 @@ first @length bits match @addr. version="2.32" throws="1"> Parses @mask_string as an IP address and (optional) length, and + filename="gio/ginetaddressmask.c" + line="276">Parses @mask_string as an IP address and (optional) length, and creates a new #GInetAddressMask. The length, if present, is delimited by a "/". If it is not present, then the length is assumed to be the full length of the address. - + a new #GInetAddressMask corresponding to @string, or %NULL + filename="gio/ginetaddressmask.c" + line="286">a new #GInetAddressMask corresponding to @string, or %NULL on error. an IP address or address/length string + filename="gio/ginetaddressmask.c" + line="278">an IP address or address/length string @@ -72403,27 +73093,26 @@ on error. c:identifier="g_inet_address_mask_equal" version="2.32"> Tests if @mask and @mask2 are the same mask. - + filename="gio/ginetaddressmask.c" + line="463">Tests if @mask and @mask2 are the same mask. + whether @mask and @mask2 are the same mask + filename="gio/ginetaddressmask.c" + line="470">whether @mask and @mask2 are the same mask a #GInetAddressMask + filename="gio/ginetaddressmask.c" + line="465">a #GInetAddressMask another #GInetAddressMask + filename="gio/ginetaddressmask.c" + line="466">another #GInetAddressMask @@ -72433,21 +73122,20 @@ on error. glib:get-property="address" version="2.32"> Gets @mask's base address - + filename="gio/ginetaddressmask.c" + line="383">Gets @mask's base address + @mask's base address + filename="gio/ginetaddressmask.c" + line="389">@mask's base address a #GInetAddressMask + filename="gio/ginetaddressmask.c" + line="385">a #GInetAddressMask @@ -72457,21 +73145,20 @@ on error. glib:get-property="family" version="2.32"> Gets the #GSocketFamily of @mask's address - + filename="gio/ginetaddressmask.c" + line="365">Gets the #GSocketFamily of @mask's address + the #GSocketFamily of @mask's address + filename="gio/ginetaddressmask.c" + line="371">the #GSocketFamily of @mask's address a #GInetAddressMask + filename="gio/ginetaddressmask.c" + line="367">a #GInetAddressMask @@ -72481,21 +73168,20 @@ on error. glib:get-property="length" version="2.32"> Gets @mask's length - + filename="gio/ginetaddressmask.c" + line="401">Gets @mask's length + @mask's length + filename="gio/ginetaddressmask.c" + line="407">@mask's length a #GInetAddressMask + filename="gio/ginetaddressmask.c" + line="403">a #GInetAddressMask @@ -72504,28 +73190,27 @@ on error. c:identifier="g_inet_address_mask_matches" version="2.32"> Tests if @address falls within the range described by @mask. - + filename="gio/ginetaddressmask.c" + line="419">Tests if @address falls within the range described by @mask. + whether @address falls within the range described by + filename="gio/ginetaddressmask.c" + line="426">whether @address falls within the range described by @mask. a #GInetAddressMask + filename="gio/ginetaddressmask.c" + line="421">a #GInetAddressMask a #GInetAddress + filename="gio/ginetaddressmask.c" + line="422">a #GInetAddress @@ -72534,42 +73219,53 @@ on error. c:identifier="g_inet_address_mask_to_string" version="2.32"> Converts @mask back to its corresponding string form. - + filename="gio/ginetaddressmask.c" + line="337">Converts @mask back to its corresponding string form. + a string corresponding to @mask. + filename="gio/ginetaddressmask.c" + line="343">a string corresponding to @mask. a #GInetAddressMask + filename="gio/ginetaddressmask.c" + line="339">a #GInetAddressMask + The base address. + The address family (IPv4 or IPv6). + The prefix length, in bytes. @@ -72582,8 +73278,7 @@ on error. - + @@ -72592,15 +73287,13 @@ on error. c:type="GInetAddressMaskPrivate" disguised="1" opaque="1"> - + - + glib:get-type="g_inet_socket_address_get_type" glib:type-struct="InetSocketAddressClass"> An IPv4 or IPv6 socket address; that is, the combination of a -#GInetAddress and a port number. - + filename="gio/ginetsocketaddress.c" + line="36">An IPv4 or IPv6 socket address. That is, the combination of a +[class@Gio.InetAddress] and a port number. + +In UNIX terms, `GInetSocketAddress` corresponds to a +[`struct sockaddr_in` or `struct sockaddr_in6`](man:sockaddr(3type)). + Creates a new #GInetSocketAddress for @address and @port. - + filename="gio/ginetsocketaddress.c" + line="372">Creates a new #GInetSocketAddress for @address and @port. + a new #GInetSocketAddress + filename="gio/ginetsocketaddress.c" + line="379">a new #GInetSocketAddress a #GInetAddress + filename="gio/ginetsocketaddress.c" + line="374">a #GInetAddress a port number + filename="gio/ginetsocketaddress.c" + line="375">a port number @@ -72649,31 +73343,30 @@ on error. c:identifier="g_inet_socket_address_new_from_string" version="2.40"> Creates a new #GInetSocketAddress for @address and @port. + filename="gio/ginetsocketaddress.c" + line="393">Creates a new #GInetSocketAddress for @address and @port. If @address is an IPv6 address, it can also contain a scope ID (separated from the address by a `%`). - + a new #GInetSocketAddress, + filename="gio/ginetsocketaddress.c" + line="403">a new #GInetSocketAddress, or %NULL if @address cannot be parsed. the string form of an IP address + filename="gio/ginetsocketaddress.c" + line="395">the string form of an IP address a port number + filename="gio/ginetsocketaddress.c" + line="396">a port number @@ -72683,22 +73376,21 @@ or %NULL if @address cannot be parsed. glib:get-property="address" version="2.22"> Gets @address's #GInetAddress. - + filename="gio/ginetsocketaddress.c" + line="469">Gets @address's #GInetAddress. + the #GInetAddress for @address, which must be + filename="gio/ginetsocketaddress.c" + line="475">the #GInetAddress for @address, which must be g_object_ref()'d if it will be stored a #GInetSocketAddress + filename="gio/ginetsocketaddress.c" + line="471">a #GInetSocketAddress @@ -72708,22 +73400,21 @@ g_object_ref()'d if it will be stored glib:get-property="flowinfo" version="2.32"> Gets the `sin6_flowinfo` field from @address, + filename="gio/ginetsocketaddress.c" + line="507">Gets the `sin6_flowinfo` field from @address, which must be an IPv6 address. - + the flowinfo field + filename="gio/ginetsocketaddress.c" + line="514">the flowinfo field a %G_SOCKET_FAMILY_IPV6 #GInetSocketAddress + filename="gio/ginetsocketaddress.c" + line="509">a %G_SOCKET_FAMILY_IPV6 #GInetSocketAddress @@ -72733,21 +73424,20 @@ which must be an IPv6 address. glib:get-property="port" version="2.22"> Gets @address's port. - + filename="gio/ginetsocketaddress.c" + line="488">Gets @address's port. + the port for @address + filename="gio/ginetsocketaddress.c" + line="494">the port for @address a #GInetSocketAddress + filename="gio/ginetsocketaddress.c" + line="490">a #GInetSocketAddress @@ -72757,31 +73447,34 @@ which must be an IPv6 address. glib:get-property="scope-id" version="2.32"> Gets the `sin6_scope_id` field from @address, + filename="gio/ginetsocketaddress.c" + line="527">Gets the `sin6_scope_id` field from @address, which must be an IPv6 address. - + the scope id field + filename="gio/ginetsocketaddress.c" + line="534">the scope id field a %G_SOCKET_FAMILY_IPV6 #GInetAddress + filename="gio/ginetsocketaddress.c" + line="529">a %G_SOCKET_FAMILY_IPV6 #GInetAddress + The address. getter="get_flowinfo" default-value="0"> The `sin6_flowinfo` field, for IPv6 addresses. + filename="gio/ginetsocketaddress.c" + line="280">The `sin6_flowinfo` field, for IPv6 addresses. + The port. + The `sin6_scope_id` field, for IPv6 addresses. @@ -72823,8 +73524,7 @@ which must be an IPv6 address. - + @@ -72833,8 +73533,7 @@ which must be an IPv6 address. c:type="GInetSocketAddressPrivate" disguised="1" opaque="1"> - + glib:get-type="g_initable_get_type" glib:type-struct="InitableIface"> #GInitable is implemented by objects that can fail during + filename="gio/ginitable.c" + line="28">`GInitable` is implemented by objects that can fail during initialization. If an object implements this interface then it must be initialized as the first thing after construction, -either via g_initable_init() or g_async_initable_init_async() -(the latter is only available if it also implements #GAsyncInitable). +either via [method@Gio.Initable.init] or [method@Gio.AsyncInitable.init_async] +(the latter is only available if it also implements [iface@Gio.AsyncInitable]). If the object is not initialized, or initialization returns with an -error, then all operations on the object except g_object_ref() and -g_object_unref() are considered to be invalid, and have undefined -behaviour. They will often fail with g_critical() or g_warning(), but -this must not be relied on. +error, then all operations on the object except `g_object_ref()` and +`g_object_unref()` are considered to be invalid, and have undefined +behaviour. They will often fail with [func@GLib.critical] or +[func@GLib.warning], but this must not be relied on. Users of objects implementing this are not intended to use the interface method directly, instead it will be used automatically in various ways. For C applications you generally just call -g_initable_new() directly, or indirectly via a foo_thing_new() wrapper. -This will call g_initable_init() under the cover, returning %NULL and -setting a #GError on failure (at which point the instance is +[func@Gio.Initable.new] directly, or indirectly via a `foo_thing_new()` wrapper. +This will call [method@Gio.Initable.init] under the cover, returning `NULL` +and setting a `GError` on failure (at which point the instance is unreferenced). For bindings in languages where the native constructor supports -exceptions the binding could check for objects implementing %GInitable +exceptions the binding could check for objects implementing `GInitable` during normal construction and automatically initialize them, throwing an exception on failure. - + Helper function for constructing #GInitable object. This is + filename="gio/ginitable.c" + line="132">Helper function for constructing #GInitable object. This is similar to g_object_new() but also initializes the object and returns %NULL, setting an error on failure. - + a newly allocated + filename="gio/ginitable.c" + line="147">a newly allocated #GObject, or %NULL on error a #GType supporting #GInitable. + filename="gio/ginitable.c" + line="134">a #GType supporting #GInitable. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginitable.c" + line="135">optional #GCancellable object, %NULL to ignore. a #GError location to store the error occurring, or %NULL to + filename="gio/ginitable.c" + line="136">a #GError location to store the error occurring, or %NULL to ignore. @@ -72917,15 +73614,15 @@ and returns %NULL, setting an error on failure. nullable="1" allow-none="1"> the name of the first property, or %NULL if no + filename="gio/ginitable.c" + line="138">the name of the first property, or %NULL if no properties the value if the first property, followed by and other property + filename="gio/ginitable.c" + line="140">the value if the first property, followed by and other property value pairs, and ended by %NULL. @@ -72937,37 +73634,36 @@ and returns %NULL, setting an error on failure. introspectable="0" throws="1"> Helper function for constructing #GInitable object. This is + filename="gio/ginitable.c" + line="215">Helper function for constructing #GInitable object. This is similar to g_object_new_valist() but also initializes the object and returns %NULL, setting an error on failure. - + a newly allocated + filename="gio/ginitable.c" + line="229">a newly allocated #GObject, or %NULL on error a #GType supporting #GInitable. + filename="gio/ginitable.c" + line="217">a #GType supporting #GInitable. the name of the first property, followed by + filename="gio/ginitable.c" + line="218">the name of the first property, followed by the value, and other property value pairs, and ended by %NULL. The var args list generated from @first_property_name. + filename="gio/ginitable.c" + line="220">The var args list generated from @first_property_name. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginitable.c" + line="221">optional #GCancellable object, %NULL to ignore. @@ -72988,38 +73684,37 @@ the value, and other property value pairs, and ended by %NULL. deprecated-version="2.54" throws="1"> Helper function for constructing #GInitable object. This is + filename="gio/ginitable.c" + line="171">Helper function for constructing #GInitable object. This is similar to g_object_newv() but also initializes the object and returns %NULL, setting an error on failure. Use g_object_new_with_properties() and g_initable_init() instead. See #GParameter for more information. - + a newly allocated + filename="gio/ginitable.c" + line="184">a newly allocated #GObject, or %NULL on error a #GType supporting #GInitable. + filename="gio/ginitable.c" + line="173">a #GType supporting #GInitable. the number of parameters in @parameters + filename="gio/ginitable.c" + line="174">the number of parameters in @parameters the parameters to use to construct the object + filename="gio/ginitable.c" + line="175">the parameters to use to construct the object @@ -73029,16 +73724,16 @@ g_initable_init() instead. See #GParameter for more information. optional #GCancellable object, %NULL to ignore. + filename="gio/ginitable.c" + line="176">optional #GCancellable object, %NULL to ignore. Initializes the object implementing the interface. + filename="gio/ginitable.c" + line="67">Initializes the object implementing the interface. This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead. @@ -73076,20 +73771,19 @@ it is designed to be used via the singleton pattern, with a In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance. - + %TRUE if successful. If an error has occurred, this function will + filename="gio/ginitable.c" + line="113">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. a #GInitable. + filename="gio/ginitable.c" + line="69">a #GInitable. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginitable.c" + line="70">optional #GCancellable object, %NULL to ignore. @@ -73108,8 +73802,8 @@ instance. version="2.22" throws="1"> Initializes the object implementing the interface. + filename="gio/ginitable.c" + line="67">Initializes the object implementing the interface. This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead. @@ -73147,20 +73841,19 @@ it is designed to be used via the singleton pattern, with a In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance. - + %TRUE if successful. If an error has occurred, this function will + filename="gio/ginitable.c" + line="113">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. a #GInitable. + filename="gio/ginitable.c" + line="69">a #GInitable. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginitable.c" + line="70">optional #GCancellable object, %NULL to ignore. @@ -73180,33 +73873,34 @@ instance. glib:is-gtype-struct-for="Initable" version="2.22"> Provides an interface for initializing object such that initialization + filename="gio/ginitable.h" + line="42">Provides an interface for initializing object such that initialization may fail. - + The parent interface. + filename="gio/ginitable.h" + line="44">The parent interface. + Initializes the object. - + %TRUE if successful. If an error has occurred, this function will + filename="gio/ginitable.c" + line="113">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. a #GInitable. + filename="gio/ginitable.c" + line="69">a #GInitable. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginitable.c" + line="70">optional #GCancellable object, %NULL to ignore. @@ -73224,8 +73918,8 @@ may fail. Structure used for scatter/gather data input when receiving multiple + filename="gio/giotypes.h" + line="356">Structure used for scatter/gather data input when receiving multiple messages or packets in one go. You generally pass in an array of empty #GInputVectors and the operation will use all the buffers as if they were one buffer, and will set @bytes_received to the total number of bytes @@ -73244,19 +73938,18 @@ this array, which may be zero. Flags relevant to this message will be returned in @flags. For example, `MSG_EOR` or `MSG_TRUNC`. - + return location + filename="gio/giotypes.h" + line="358">return location for a #GSocketAddress, or %NULL pointer to an + filename="gio/giotypes.h" + line="360">pointer to an array of input vectors @@ -73264,28 +73957,28 @@ Flags relevant to this message will be returned in @flags. For example, the number of input vectors pointed to by @vectors + filename="gio/giotypes.h" + line="362">the number of input vectors pointed to by @vectors will be set to the number of bytes that have been + filename="gio/giotypes.h" + line="363">will be set to the number of bytes that have been received collection of #GSocketMsgFlags for the received message, + filename="gio/giotypes.h" + line="365">collection of #GSocketMsgFlags for the received message, outputted by the call return location for a + filename="gio/giotypes.h" + line="367">return location for a caller-allocated array of #GSocketControlMessages, or %NULL return location for the number of + filename="gio/giotypes.h" + line="370">return location for the number of elements in @control_messages @@ -73310,24 +74003,27 @@ Flags relevant to this message will be returned in @flags. For example, glib:get-type="g_input_stream_get_type" glib:type-struct="InputStreamClass"> #GInputStream has functions to read from a stream (g_input_stream_read()), -to close a stream (g_input_stream_close()) and to skip some content -(g_input_stream_skip()). + filename="gio/ginputstream.c" + line="35">`GInputStream` is a base class for implementing streaming input. + +It has functions to read from a stream ([method@Gio.InputStream.read]), +to close a stream ([method@Gio.InputStream.close]) and to skip some content +([method@Gio.InputStream.skip]). To copy the content of an input stream to an output stream without -manually handling the reads and writes, use g_output_stream_splice(). +manually handling the reads and writes, use [method@Gio.OutputStream.splice]. -See the documentation for #GIOStream for details of thread safety of -streaming APIs. +See the documentation for [class@Gio.IOStream] for details of thread safety +of streaming APIs. All of these functions have async variants too. - - + + Requests an asynchronous closes of the stream, releasing resources related to it. + filename="gio/ginputstream.c" + line="1106">Requests an asynchronous closes of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_input_stream_close_finish() to get the result of the operation. @@ -73337,22 +74033,21 @@ For behaviour details see g_input_stream_close(). The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all. - + A #GInputStream. + filename="gio/ginputstream.c" + line="1108">A #GInputStream. the [I/O priority][io-priority] of the request + filename="gio/ginputstream.c" + line="1109">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional cancellable object + filename="gio/ginputstream.c" + line="1110">optional cancellable object scope="async" closure="3"> callback to call when the request is satisfied + filename="gio/ginputstream.c" + line="1111">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/ginputstream.c" + line="1113">the data to pass to callback function Finishes closing a stream asynchronously, started from g_input_stream_close_async(). - + filename="gio/ginputstream.c" + line="1164">Finishes closing a stream asynchronously, started from g_input_stream_close_async(). + %TRUE if the stream was closed successfully. + filename="gio/ginputstream.c" + line="1173">%TRUE if the stream was closed successfully. a #GInputStream. + filename="gio/ginputstream.c" + line="1166">a #GInputStream. a #GAsyncResult. + filename="gio/ginputstream.c" + line="1167">a #GAsyncResult. - + @@ -73432,10 +74126,12 @@ override one you must override all. - + Request an asynchronous read of @count bytes from the stream into the buffer + filename="gio/ginputstream.c" + line="583">Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer. When the operation is finished @callback will be called. You can then call g_input_stream_read_finish() to get the result of the operation. @@ -73458,16 +74154,15 @@ priority is %G_PRIORITY_DEFAULT. The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all. - + A #GInputStream. + filename="gio/ginputstream.c" + line="585">A #GInputStream. transfer-ownership="none" nullable="1"> + filename="gio/ginputstream.c" + line="586"> a buffer to read data into (which should be at least count bytes long). @@ -73485,14 +74180,14 @@ override one you must override all. the number of bytes that will be read from the stream + filename="gio/ginputstream.c" + line="588">the number of bytes that will be read from the stream the [I/O priority][io-priority] + filename="gio/ginputstream.c" + line="589">the [I/O priority][io-priority] of the request. @@ -73501,8 +74196,8 @@ of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="591">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/ginputstream.c" + line="592">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/ginputstream.c" + line="594">the data to pass to callback function Finishes an asynchronous stream read operation. - + filename="gio/ginputstream.c" + line="671">Finishes an asynchronous stream read operation. + number of bytes read in, or -1 on error, or 0 on end of file. + filename="gio/ginputstream.c" + line="680">number of bytes read in, or -1 on error, or 0 on end of file. a #GInputStream. + filename="gio/ginputstream.c" + line="673">a #GInputStream. a #GAsyncResult. + filename="gio/ginputstream.c" + line="674">a #GAsyncResult. - + @@ -73582,10 +74276,13 @@ of the request. - + Tries to skip @count bytes from the stream. Will block during the operation. + filename="gio/ginputstream.c" + line="340">Tries to skip @count bytes from the stream. Will block during the operation. This is identical to g_input_stream_read(), from a behaviour standpoint, but the bytes that are skipped are not returned to the user. Some @@ -73599,25 +74296,24 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error. - + Number of bytes skipped, or -1 on error + filename="gio/ginputstream.c" + line="362">Number of bytes skipped, or -1 on error a #GInputStream. + filename="gio/ginputstream.c" + line="342">a #GInputStream. the number of bytes that will be skipped from the stream + filename="gio/ginputstream.c" + line="343">the number of bytes that will be skipped from the stream nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="344">optional #GCancellable object, %NULL to ignore. - + Request an asynchronous skip of @count bytes from the stream. + filename="gio/ginputstream.c" + line="993">Request an asynchronous skip of @count bytes from the stream. When the operation is finished @callback will be called. You can then call g_input_stream_skip_finish() to get the result of the operation. @@ -73657,28 +74356,27 @@ Default priority is %G_PRIORITY_DEFAULT. The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one, you must override all. - + A #GInputStream. + filename="gio/ginputstream.c" + line="995">A #GInputStream. the number of bytes that will be skipped from the stream + filename="gio/ginputstream.c" + line="996">the number of bytes that will be skipped from the stream the [I/O priority][io-priority] of the request + filename="gio/ginputstream.c" + line="997">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="998">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/ginputstream.c" + line="999">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/ginputstream.c" + line="1001">the data to pass to callback function Finishes a stream skip operation. - + filename="gio/ginputstream.c" + line="1076">Finishes a stream skip operation. + the size of the bytes skipped, or `-1` on error. + filename="gio/ginputstream.c" + line="1085">the size of the bytes skipped, or `-1` on error. a #GInputStream. + filename="gio/ginputstream.c" + line="1078">a #GInputStream. a #GAsyncResult. + filename="gio/ginputstream.c" + line="1079">a #GAsyncResult. Clears the pending flag on @stream. - + filename="gio/ginputstream.c" + line="1264">Clears the pending flag on @stream. + input stream + filename="gio/ginputstream.c" + line="1266">input stream - + Closes the stream, releasing resources related to it. + filename="gio/ginputstream.c" + line="488">Closes the stream, releasing resources related to it. Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. Closing a stream multiple times will not return an error. @@ -73784,19 +74484,18 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. Cancelling a close will still leave the stream closed, but some streams can use a faster close that doesn't block to e.g. check errors. - + %TRUE on success, %FALSE on failure + filename="gio/ginputstream.c" + line="518">%TRUE on success, %FALSE on failure A #GInputStream. + filename="gio/ginputstream.c" + line="490">A #GInputStream. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="491">optional #GCancellable object, %NULL to ignore. - + Requests an asynchronous closes of the stream, releasing resources related to it. + filename="gio/ginputstream.c" + line="1106">Requests an asynchronous closes of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_input_stream_close_finish() to get the result of the operation. @@ -73823,22 +74525,21 @@ For behaviour details see g_input_stream_close(). The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all. - + A #GInputStream. + filename="gio/ginputstream.c" + line="1108">A #GInputStream. the [I/O priority][io-priority] of the request + filename="gio/ginputstream.c" + line="1109">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional cancellable object + filename="gio/ginputstream.c" + line="1110">optional cancellable object scope="async" closure="3"> callback to call when the request is satisfied + filename="gio/ginputstream.c" + line="1111">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/ginputstream.c" + line="1113">the data to pass to callback function @@ -73876,77 +74578,74 @@ override one you must override all. c:identifier="g_input_stream_close_finish" throws="1"> Finishes closing a stream asynchronously, started from g_input_stream_close_async(). - + filename="gio/ginputstream.c" + line="1164">Finishes closing a stream asynchronously, started from g_input_stream_close_async(). + %TRUE if the stream was closed successfully. + filename="gio/ginputstream.c" + line="1173">%TRUE if the stream was closed successfully. a #GInputStream. + filename="gio/ginputstream.c" + line="1166">a #GInputStream. a #GAsyncResult. + filename="gio/ginputstream.c" + line="1167">a #GAsyncResult. Checks if an input stream has pending actions. - + filename="gio/ginputstream.c" + line="1210">Checks if an input stream has pending actions. + %TRUE if @stream has pending actions. + filename="gio/ginputstream.c" + line="1216">%TRUE if @stream has pending actions. input stream. + filename="gio/ginputstream.c" + line="1212">input stream. Checks if an input stream is closed. - + filename="gio/ginputstream.c" + line="1194">Checks if an input stream is closed. + %TRUE if the stream is closed. + filename="gio/ginputstream.c" + line="1200">%TRUE if the stream is closed. input stream. + filename="gio/ginputstream.c" + line="1196">input stream. Tries to read @count bytes from the stream into the buffer starting at + filename="gio/ginputstream.c" + line="129">Tries to read @count bytes from the stream into the buffer starting at @buffer. Will block during this read. If count is zero returns zero and does nothing. A value of @count @@ -73967,19 +74666,18 @@ operation was partially finished when the operation was cancelled the partial result will be returned, without an error. On error -1 is returned and @error is set accordingly. - + Number of bytes read, or -1 on error, or 0 on end of file. + filename="gio/ginputstream.c" + line="160">Number of bytes read, or -1 on error, or 0 on end of file. a #GInputStream. + filename="gio/ginputstream.c" + line="131">a #GInputStream. caller-allocates="1" transfer-ownership="none"> + filename="gio/ginputstream.c" + line="132"> a buffer to read data into (which should be at least count bytes long). @@ -73996,8 +74694,8 @@ On error -1 is returned and @error is set accordingly. the number of bytes that will be read from the stream + filename="gio/ginputstream.c" + line="134">the number of bytes that will be read from the stream nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="135">optional #GCancellable object, %NULL to ignore. @@ -74015,8 +74713,8 @@ On error -1 is returned and @error is set accordingly. c:identifier="g_input_stream_read_all" throws="1"> Tries to read @count bytes from the stream into the buffer starting at + filename="gio/ginputstream.c" + line="210">Tries to read @count bytes from the stream into the buffer starting at @buffer. Will block during this read. This function is similar to g_input_stream_read(), except it tries to @@ -74035,19 +74733,18 @@ use #GError, if this function returns %FALSE (and sets @error) then read before the error was encountered. This functionality is only available from C. If you need it from another language then you must write your own loop around g_input_stream_read(). - + %TRUE on success, %FALSE if there was an error + filename="gio/ginputstream.c" + line="240">%TRUE on success, %FALSE if there was an error a #GInputStream. + filename="gio/ginputstream.c" + line="212">a #GInputStream. caller-allocates="1" transfer-ownership="none"> + filename="gio/ginputstream.c" + line="213"> a buffer to read data into (which should be at least count bytes long). @@ -74064,8 +74761,8 @@ write your own loop around g_input_stream_read(). the number of bytes that will be read from the stream + filename="gio/ginputstream.c" + line="215">the number of bytes that will be read from the stream caller-allocates="0" transfer-ownership="full"> location to store the number of bytes that was read from the stream + filename="gio/ginputstream.c" + line="216">location to store the number of bytes that was read from the stream nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="217">optional #GCancellable object, %NULL to ignore. + version="2.44" + glib:finish-func="read_all_finish"> Request an asynchronous read of @count bytes from the stream into the + filename="gio/ginputstream.c" + line="776">Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer. This is the asynchronous equivalent of g_input_stream_read_all(). @@ -74103,16 +74801,15 @@ Call g_input_stream_read_all_finish() to collect the result. Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is %G_PRIORITY_DEFAULT. - + A #GInputStream + filename="gio/ginputstream.c" + line="778">A #GInputStream caller-allocates="1" transfer-ownership="none"> + filename="gio/ginputstream.c" + line="779"> a buffer to read data into (which should be at least count bytes long) @@ -74129,14 +74826,14 @@ priority. Default priority is %G_PRIORITY_DEFAULT. the number of bytes that will be read from the stream + filename="gio/ginputstream.c" + line="781">the number of bytes that will be read from the stream the [I/O priority][io-priority] of the request + filename="gio/ginputstream.c" + line="782">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/ginputstream.c" + line="783">optional #GCancellable object, %NULL to ignore scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/ginputstream.c" + line="784">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/ginputstream.c" + line="786">the data to pass to callback function @@ -74175,8 +74873,8 @@ priority. Default priority is %G_PRIORITY_DEFAULT. version="2.44" throws="1"> Finishes an asynchronous stream read operation started with + filename="gio/ginputstream.c" + line="838">Finishes an asynchronous stream read operation started with g_input_stream_read_all_async(). As a special exception to the normal conventions for functions that @@ -74185,25 +74883,24 @@ use #GError, if this function returns %FALSE (and sets @error) then read before the error was encountered. This functionality is only available from C. If you need it from another language then you must write your own loop around g_input_stream_read_async(). - + %TRUE on success, %FALSE if there was an error + filename="gio/ginputstream.c" + line="855">%TRUE on success, %FALSE if there was an error a #GInputStream + filename="gio/ginputstream.c" + line="840">a #GInputStream a #GAsyncResult + filename="gio/ginputstream.c" + line="841">a #GAsyncResult caller-allocates="0" transfer-ownership="full"> location to store the number of bytes that was read from the stream + filename="gio/ginputstream.c" + line="842">location to store the number of bytes that was read from the stream - + Request an asynchronous read of @count bytes from the stream into the buffer + filename="gio/ginputstream.c" + line="583">Request an asynchronous read of @count bytes from the stream into the buffer starting at @buffer. When the operation is finished @callback will be called. You can then call g_input_stream_read_finish() to get the result of the operation. @@ -74243,16 +74942,15 @@ priority is %G_PRIORITY_DEFAULT. The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all. - + A #GInputStream. + filename="gio/ginputstream.c" + line="585">A #GInputStream. caller-allocates="1" transfer-ownership="none"> + filename="gio/ginputstream.c" + line="586"> a buffer to read data into (which should be at least count bytes long). @@ -74269,14 +74967,14 @@ override one you must override all. the number of bytes that will be read from the stream + filename="gio/ginputstream.c" + line="588">the number of bytes that will be read from the stream the [I/O priority][io-priority] + filename="gio/ginputstream.c" + line="589">the [I/O priority][io-priority] of the request. @@ -74285,8 +74983,8 @@ of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="591">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/ginputstream.c" + line="592">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/ginputstream.c" + line="594">the data to pass to callback function @@ -74314,10 +75013,11 @@ of the request. + throws="1" + glib:async-func="read_bytes_async"> Like g_input_stream_read(), this tries to read @count bytes from + filename="gio/ginputstream.c" + line="279">Like g_input_stream_read(), this tries to read @count bytes from the stream in a blocking fashion. However, rather than reading into a user-supplied buffer, this will create a new #GBytes containing the data that was read. This may be easier to use from language @@ -74340,25 +75040,24 @@ operation was partially finished when the operation was cancelled the partial result will be returned, without an error. On error %NULL is returned and @error is set accordingly. - + a new #GBytes, or %NULL on error + filename="gio/ginputstream.c" + line="311">a new #GBytes, or %NULL on error a #GInputStream. + filename="gio/ginputstream.c" + line="281">a #GInputStream. maximum number of bytes that will be read from the stream. Common + filename="gio/ginputstream.c" + line="282">maximum number of bytes that will be read from the stream. Common values include 4096 and 8192. @@ -74367,18 +75066,20 @@ values include 4096 and 8192. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="284">optional #GCancellable object, %NULL to ignore. + version="2.34" + glib:finish-func="read_bytes_finish" + glib:sync-func="read_bytes"> Request an asynchronous read of @count bytes from the stream into a + filename="gio/ginputstream.c" + line="914">Request an asynchronous read of @count bytes from the stream into a new #GBytes. When the operation is finished @callback will be called. You can then call g_input_stream_read_bytes_finish() to get the result of the operation. @@ -74398,28 +75099,27 @@ many bytes as requested. Zero is returned on end of file (or if Any outstanding I/O request with higher priority (lower numerical value) will be executed before an outstanding request with lower priority. Default priority is %G_PRIORITY_DEFAULT. - + A #GInputStream. + filename="gio/ginputstream.c" + line="916">A #GInputStream. the number of bytes that will be read from the stream + filename="gio/ginputstream.c" + line="917">the number of bytes that will be read from the stream the [I/O priority][io-priority] of the request + filename="gio/ginputstream.c" + line="918">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="919">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/ginputstream.c" + line="920">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/ginputstream.c" + line="922">the data to pass to callback function @@ -74458,27 +75159,26 @@ priority. Default priority is %G_PRIORITY_DEFAULT. version="2.34" throws="1"> Finishes an asynchronous stream read-into-#GBytes operation. - + filename="gio/ginputstream.c" + line="969">Finishes an asynchronous stream read-into-#GBytes operation. + the newly-allocated #GBytes, or %NULL on error + filename="gio/ginputstream.c" + line="978">the newly-allocated #GBytes, or %NULL on error a #GInputStream. + filename="gio/ginputstream.c" + line="971">a #GInputStream. a #GAsyncResult. + filename="gio/ginputstream.c" + line="972">a #GAsyncResult. @@ -74487,27 +75187,26 @@ priority. Default priority is %G_PRIORITY_DEFAULT. c:identifier="g_input_stream_read_finish" throws="1"> Finishes an asynchronous stream read operation. - + filename="gio/ginputstream.c" + line="671">Finishes an asynchronous stream read operation. + number of bytes read in, or -1 on error, or 0 on end of file. + filename="gio/ginputstream.c" + line="680">number of bytes read in, or -1 on error, or 0 on end of file. a #GInputStream. + filename="gio/ginputstream.c" + line="673">a #GInputStream. a #GAsyncResult. + filename="gio/ginputstream.c" + line="674">a #GAsyncResult. @@ -74516,31 +75215,33 @@ priority. Default priority is %G_PRIORITY_DEFAULT. c:identifier="g_input_stream_set_pending" throws="1"> Sets @stream to have actions pending. If the pending flag is + filename="gio/ginputstream.c" + line="1226">Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return %FALSE and set @error. - + %TRUE if pending was previously unset and is now set. + filename="gio/ginputstream.c" + line="1236">%TRUE if pending was previously unset and is now set. input stream + filename="gio/ginputstream.c" + line="1228">input stream - + Tries to skip @count bytes from the stream. Will block during the operation. + filename="gio/ginputstream.c" + line="340">Tries to skip @count bytes from the stream. Will block during the operation. This is identical to g_input_stream_read(), from a behaviour standpoint, but the bytes that are skipped are not returned to the user. Some @@ -74554,25 +75255,24 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error. - + Number of bytes skipped, or -1 on error + filename="gio/ginputstream.c" + line="362">Number of bytes skipped, or -1 on error a #GInputStream. + filename="gio/ginputstream.c" + line="342">a #GInputStream. the number of bytes that will be skipped from the stream + filename="gio/ginputstream.c" + line="343">the number of bytes that will be skipped from the stream nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="344">optional #GCancellable object, %NULL to ignore. - + Request an asynchronous skip of @count bytes from the stream. + filename="gio/ginputstream.c" + line="993">Request an asynchronous skip of @count bytes from the stream. When the operation is finished @callback will be called. You can then call g_input_stream_skip_finish() to get the result of the operation. @@ -74612,28 +75315,27 @@ Default priority is %G_PRIORITY_DEFAULT. The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one, you must override all. - + A #GInputStream. + filename="gio/ginputstream.c" + line="995">A #GInputStream. the number of bytes that will be skipped from the stream + filename="gio/ginputstream.c" + line="996">the number of bytes that will be skipped from the stream the [I/O priority][io-priority] of the request + filename="gio/ginputstream.c" + line="997">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="998">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/ginputstream.c" + line="999">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/ginputstream.c" + line="1001">the data to pass to callback function @@ -74671,27 +75374,26 @@ However, if you override one, you must override all. c:identifier="g_input_stream_skip_finish" throws="1"> Finishes a stream skip operation. - + filename="gio/ginputstream.c" + line="1076">Finishes a stream skip operation. + the size of the bytes skipped, or `-1` on error. + filename="gio/ginputstream.c" + line="1085">the size of the bytes skipped, or `-1` on error. a #GInputStream. + filename="gio/ginputstream.c" + line="1078">a #GInputStream. a #GAsyncResult. + filename="gio/ginputstream.c" + line="1079">a #GAsyncResult. @@ -74706,15 +75408,13 @@ However, if you override one, you must override all. - + - + @@ -74742,25 +75442,24 @@ However, if you override one, you must override all. - + Number of bytes skipped, or -1 on error + filename="gio/ginputstream.c" + line="362">Number of bytes skipped, or -1 on error a #GInputStream. + filename="gio/ginputstream.c" + line="342">a #GInputStream. the number of bytes that will be skipped from the stream + filename="gio/ginputstream.c" + line="343">the number of bytes that will be skipped from the stream nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="344">optional #GCancellable object, %NULL to ignore. @@ -74777,8 +75476,7 @@ However, if you override one, you must override all. - + @@ -74797,16 +75495,15 @@ However, if you override one, you must override all. - + A #GInputStream. + filename="gio/ginputstream.c" + line="585">A #GInputStream. transfer-ownership="none" nullable="1"> + filename="gio/ginputstream.c" + line="586"> a buffer to read data into (which should be at least count bytes long). @@ -74824,14 +75521,14 @@ However, if you override one, you must override all. the number of bytes that will be read from the stream + filename="gio/ginputstream.c" + line="588">the number of bytes that will be read from the stream the [I/O priority][io-priority] + filename="gio/ginputstream.c" + line="589">the [I/O priority][io-priority] of the request. @@ -74840,8 +75537,8 @@ of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="591">optional #GCancellable object, %NULL to ignore. scope="async" closure="6"> callback to call when the request is satisfied + filename="gio/ginputstream.c" + line="592">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="6"> the data to pass to callback function + filename="gio/ginputstream.c" + line="594">the data to pass to callback function @@ -74870,25 +75568,24 @@ of the request. - + number of bytes read in, or -1 on error, or 0 on end of file. + filename="gio/ginputstream.c" + line="680">number of bytes read in, or -1 on error, or 0 on end of file. a #GInputStream. + filename="gio/ginputstream.c" + line="673">a #GInputStream. a #GAsyncResult. + filename="gio/ginputstream.c" + line="674">a #GAsyncResult. @@ -74896,28 +75593,27 @@ of the request. - + A #GInputStream. + filename="gio/ginputstream.c" + line="995">A #GInputStream. the number of bytes that will be skipped from the stream + filename="gio/ginputstream.c" + line="996">the number of bytes that will be skipped from the stream the [I/O priority][io-priority] of the request + filename="gio/ginputstream.c" + line="997">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/ginputstream.c" + line="998">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/ginputstream.c" + line="999">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/ginputstream.c" + line="1001">the data to pass to callback function @@ -74955,25 +75652,24 @@ of the request. - + the size of the bytes skipped, or `-1` on error. + filename="gio/ginputstream.c" + line="1085">the size of the bytes skipped, or `-1` on error. a #GInputStream. + filename="gio/ginputstream.c" + line="1078">a #GInputStream. a #GAsyncResult. + filename="gio/ginputstream.c" + line="1079">a #GAsyncResult. @@ -74981,22 +75677,21 @@ of the request. - + A #GInputStream. + filename="gio/ginputstream.c" + line="1108">A #GInputStream. the [I/O priority][io-priority] of the request + filename="gio/ginputstream.c" + line="1109">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional cancellable object + filename="gio/ginputstream.c" + line="1110">optional cancellable object scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/ginputstream.c" + line="1111">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/ginputstream.c" + line="1113">the data to pass to callback function @@ -75034,25 +75730,24 @@ of the request. - + %TRUE if the stream was closed successfully. + filename="gio/ginputstream.c" + line="1173">%TRUE if the stream was closed successfully. a #GInputStream. + filename="gio/ginputstream.c" + line="1166">a #GInputStream. a #GAsyncResult. + filename="gio/ginputstream.c" + line="1167">a #GAsyncResult. @@ -75060,8 +75755,7 @@ of the request. - + @@ -75069,8 +75763,7 @@ of the request. - + @@ -75078,8 +75771,7 @@ of the request. - + @@ -75087,8 +75779,7 @@ of the request. - + @@ -75096,8 +75787,7 @@ of the request. - + @@ -75108,36 +75798,33 @@ of the request. c:type="GInputStreamPrivate" disguised="1" opaque="1"> - + Structure used for scatter/gather data input. + filename="gio/giotypes.h" + line="337">Structure used for scatter/gather data input. You generally pass in an array of #GInputVectors and the operation will store the read data starting in the first buffer, switching to the next as needed. - + Pointer to a buffer where data will be written. + filename="gio/giotypes.h" + line="339">Pointer to a buffer where data will be written. the available size in @buffer. + filename="gio/giotypes.h" + line="340">the available size in @buffer. - + @@ -75146,8 +75833,7 @@ first buffer, switching to the next as needed. - + @@ -75160,98 +75846,100 @@ first buffer, switching to the next as needed. glib:get-type="g_list_model_get_type" glib:type-struct="ListModelInterface"> #GListModel is an interface that represents a mutable list of -#GObjects. Its main intention is as a model for various widgets in -user interfaces, such as list views, but it can also be used as a + filename="gio/glistmodel.c" + line="33">`GListModel` is an interface that represents a mutable list of +[class@GObject.Object]. Its main intention is as a model for various widgets +in user interfaces, such as list views, but it can also be used as a convenient method of returning lists of data, with support for updates. Each object in the list may also report changes in itself via some -mechanism (normally the #GObject::notify signal). Taken together -with the #GListModel::items-changed signal, this provides for a list -that can change its membership, and in which the members can change -their individual properties. +mechanism (normally the [signal@GObject.Object::notify] signal). Taken +together with the [signal@Gio.ListModel::items-changed] signal, this provides +for a list that can change its membership, and in which the members can +change their individual properties. A good example would be the list of visible wireless network access points, where each access point can report dynamic properties such as signal strength. -It is important to note that the #GListModel itself does not report +It is important to note that the `GListModel` itself does not report changes to the individual items. It only reports changes to the list membership. If you want to observe changes to the objects themselves then you need to connect signals to the objects that you are interested in. -All items in a #GListModel are of (or derived from) the same type. -g_list_model_get_item_type() returns that type. The type may be an +All items in a `GListModel` are of (or derived from) the same type. +[method@Gio.ListModel.get_item_type] returns that type. The type may be an interface, in which case all objects in the list must implement it. The semantics are close to that of an array: -g_list_model_get_n_items() returns the number of items in the list and -g_list_model_get_item() returns an item at a (0-based) position. In -order to allow implementations to calculate the list length lazily, +[method@Gio.ListModel.get_n_items] returns the number of items in the list +and [method@Gio.ListModel.get_item] returns an item at a (0-based) position. +In order to allow implementations to calculate the list length lazily, you can also iterate over items: starting from 0, repeatedly call -g_list_model_get_item() until it returns %NULL. +[method@Gio.ListModel.get_item] until it returns `NULL`. An implementation may create objects lazily, but must take care to return the same object for a given position until all references to it are gone. On the other side, a consumer is expected only to hold references on -objects that are currently "user visible", in order to facilitate the +objects that are currently ‘user visible’, in order to facilitate the maximum level of laziness in the implementation of the list and to reduce the required number of signal connections at a given time. This interface is intended only to be used from a single thread. The thread in which it is appropriate to use it depends on the particular implementation, but typically it will be from the thread that owns -the [thread-default main context][g-main-context-push-thread-default] -in effect at the time that the model was created. +the thread-default main context (see +[method@GLib.MainContext.push_thread_default]) in effect at the time that the +model was created. -Over time, it has established itself as good practice for listmodel +Over time, it has established itself as good practice for list model implementations to provide properties `item-type` and `n-items` to ease working with them. While it is not required, it is recommended that implementations provide these two properties. They should return -the values of g_list_model_get_item_type() and g_list_model_get_n_items() -respectively and be defined as such: -|[<!-- language="C" --> +the values of [method@Gio.ListModel.get_item_type] and +[method@Gio.ListModel.get_n_items] respectively and be defined as such: + +```c properties[PROP_ITEM_TYPE] = - g_param_spec_gtype ("item-type", "", "", G_TYPE_OBJECT, + g_param_spec_gtype ("item-type", NULL, NULL, G_TYPE_OBJECT, G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS); properties[PROP_N_ITEMS] = - g_param_spec_uint ("n-items", "", "", 0, G_MAXUINT, 0, + g_param_spec_uint ("n-items", NULL, NULL, 0, G_MAXUINT, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS); -]| - +``` + Get the item at @position. If @position is greater than the number of + filename="gio/glistmodel.c" + line="114">Get the item at @position. If @position is greater than the number of items in @list, %NULL is returned. %NULL is never returned for an index that is smaller than the length -of the list. See g_list_model_get_n_items(). - +of the list. See g_list_model_get_n_items(). + +The same #GObject instance may not appear more than once in a #GListModel. + the object at @position. + filename="gio/glistmodel.c" + line="127">the object at @position. a #GListModel + filename="gio/glistmodel.c" + line="116">a #GListModel the position of the item to fetch + filename="gio/glistmodel.c" + line="117">the position of the item to fetch @@ -75260,8 +75948,8 @@ of the list. See g_list_model_get_n_items(). invoker="get_item_type" version="2.44"> Gets the type of the items in @list. + filename="gio/glistmodel.c" + line="166">Gets the type of the items in @list. All items returned from g_list_model_get_item() are of the type returned by this function, or a subtype, or if the type is an @@ -75269,44 +75957,42 @@ interface, they are an implementation of that interface. The item type of a #GListModel can not change during the life of the model. - + the #GType of the items contained in @list. + filename="gio/glistmodel.c" + line="179">the #GType of the items contained in @list. a #GListModel + filename="gio/glistmodel.c" + line="168">a #GListModel Gets the number of items in @list. + filename="gio/glistmodel.c" + line="191">Gets the number of items in @list. Depending on the model implementation, calling this function may be less efficient than iterating the list with increasing values for @position until g_list_model_get_item() returns %NULL. - + the number of items in @list. + filename="gio/glistmodel.c" + line="201">the number of items in @list. a #GListModel + filename="gio/glistmodel.c" + line="193">a #GListModel @@ -75317,8 +76003,8 @@ less efficient than iterating the list with increasing values for version="2.44" introspectable="0"> Get the item at @position. + filename="gio/glistmodel.c" + line="213">Get the item at @position. If @position is greater than the number of items in @list, %NULL is returned. @@ -75327,25 +76013,24 @@ returned. of the list. See also: g_list_model_get_n_items() - + the item at @position. + filename="gio/glistmodel.c" + line="228">the item at @position. a #GListModel + filename="gio/glistmodel.c" + line="215">a #GListModel the position of the item to fetch + filename="gio/glistmodel.c" + line="216">the position of the item to fetch @@ -75354,8 +76039,8 @@ See also: g_list_model_get_n_items() c:identifier="g_list_model_get_item_type" version="2.44"> Gets the type of the items in @list. + filename="gio/glistmodel.c" + line="166">Gets the type of the items in @list. All items returned from g_list_model_get_item() are of the type returned by this function, or a subtype, or if the type is an @@ -75363,19 +76048,18 @@ interface, they are an implementation of that interface. The item type of a #GListModel can not change during the life of the model. - + the #GType of the items contained in @list. + filename="gio/glistmodel.c" + line="179">the #GType of the items contained in @list. a #GListModel + filename="gio/glistmodel.c" + line="168">a #GListModel @@ -75384,25 +76068,24 @@ model. c:identifier="g_list_model_get_n_items" version="2.44"> Gets the number of items in @list. + filename="gio/glistmodel.c" + line="191">Gets the number of items in @list. Depending on the model implementation, calling this function may be less efficient than iterating the list with increasing values for @position until g_list_model_get_item() returns %NULL. - + the number of items in @list. + filename="gio/glistmodel.c" + line="201">the number of items in @list. a #GListModel + filename="gio/glistmodel.c" + line="193">a #GListModel @@ -75412,8 +76095,8 @@ less efficient than iterating the list with increasing values for shadows="get_item" version="2.44"> Get the item at @position. + filename="gio/glistmodel.c" + line="241">Get the item at @position. If @position is greater than the number of items in @list, %NULL is returned. @@ -75425,25 +76108,24 @@ This function is meant to be used by language bindings in place of g_list_model_get_item(). See also: g_list_model_get_n_items() - + the object at @position. + filename="gio/glistmodel.c" + line="259">the object at @position. a #GListModel + filename="gio/glistmodel.c" + line="243">a #GListModel the position of the item to fetch + filename="gio/glistmodel.c" + line="244">the position of the item to fetch @@ -75452,8 +76134,8 @@ See also: g_list_model_get_n_items() c:identifier="g_list_model_items_changed" version="2.44"> Emits the #GListModel::items-changed signal on @list. + filename="gio/glistmodel.c" + line="276">Emits the #GListModel::items-changed signal on @list. This function should only be called by classes implementing #GListModel. It has to be called after the internal representation @@ -75473,42 +76155,41 @@ Stated another way: in general, it is assumed that code making a series of accesses to the model via the API, without returning to the mainloop, and without calling other code, will continue to view the same contents of the model. - + a #GListModel + filename="gio/glistmodel.c" + line="278">a #GListModel the position at which @list changed + filename="gio/glistmodel.c" + line="279">the position at which @list changed the number of items removed + filename="gio/glistmodel.c" + line="280">the number of items removed the number of items added + filename="gio/glistmodel.c" + line="281">the number of items added This signal is emitted whenever items were added to or removed + filename="gio/glistmodel.c" + line="137">This signal is emitted whenever items were added to or removed from @list. At @position, @removed items were removed and @added items were added in their place. @@ -75520,20 +76201,20 @@ in the model change. the position at which @list changed + filename="gio/glistmodel.c" + line="140">the position at which @list changed the number of items removed + filename="gio/glistmodel.c" + line="141">the number of items removed the number of items added + filename="gio/glistmodel.c" + line="142">the number of items added @@ -75544,77 +76225,82 @@ in the model change. glib:is-gtype-struct-for="ListModel" version="2.44"> The virtual function table for #GListModel. - + filename="gio/glistmodel.c" + line="102">The virtual function table for #GListModel. + parent #GTypeInterface + filename="gio/glistmodel.c" + line="104">parent #GTypeInterface + the virtual function pointer for g_list_model_get_item_type() - + the #GType of the items contained in @list. + filename="gio/glistmodel.c" + line="179">the #GType of the items contained in @list. a #GListModel + filename="gio/glistmodel.c" + line="168">a #GListModel + the virtual function pointer for g_list_model_get_n_items() - + the number of items in @list. + filename="gio/glistmodel.c" + line="201">the number of items in @list. a #GListModel + filename="gio/glistmodel.c" + line="193">a #GListModel + the virtual function pointer for g_list_model_get_item() - + the object at @position. + filename="gio/glistmodel.c" + line="127">the object at @position. a #GListModel + filename="gio/glistmodel.c" + line="116">a #GListModel the position of the item to fetch + filename="gio/glistmodel.c" + line="117">the position of the item to fetch @@ -75629,95 +76315,91 @@ in the model change. glib:get-type="g_list_store_get_type" glib:type-struct="ListStoreClass"> #GListStore is a simple implementation of #GListModel that stores all -items in memory. + filename="gio/gliststore.c" + line="30">`GListStore` is a simple implementation of [iface@Gio.ListModel] that stores +all items in memory. It provides insertions, deletions, and lookups in logarithmic time with a fast path for the common case of iterating the list linearly. - + Creates a new #GListStore with items of type @item_type. @item_type + filename="gio/gliststore.c" + line="237">Creates a new #GListStore with items of type @item_type. @item_type must be a subclass of #GObject. - + a new #GListStore + filename="gio/gliststore.c" + line="244">a new #GListStore the #GType of items in the list + filename="gio/gliststore.c" + line="239">the #GType of items in the list Appends @item to @store. @item must be of type #GListStore:item-type. + filename="gio/gliststore.c" + line="361">Appends @item to @store. @item must be of type #GListStore:item-type. This function takes a ref on @item. Use g_list_store_splice() to append multiple items at the same time efficiently. - + a #GListStore + filename="gio/gliststore.c" + line="363">a #GListStore the new item + filename="gio/gliststore.c" + line="364">the new item Looks up the given @item in the list store by looping over the items until + filename="gio/gliststore.c" + line="611">Looks up the given @item in the list store by looping over the items until the first occurrence of @item. If @item was not found, then @position will not be set, and this method will return %FALSE. If you need to compare the two items with a custom comparison function, use g_list_store_find_with_equal_func() with a custom #GEqualFunc instead. - + Whether @store contains @item. If it was found, @position will be + filename="gio/gliststore.c" + line="624">Whether @store contains @item. If it was found, @position will be set to the position where @item occurred for the first time. a #GListStore + filename="gio/gliststore.c" + line="613">a #GListStore an item + filename="gio/gliststore.c" + line="614">an item optional="1" allow-none="1"> the first position of @item, if it was found. + filename="gio/gliststore.c" + line="615">the first position of @item, if it was found. @@ -75737,8 +76419,8 @@ set to the position where @item occurred for the first time. c:identifier="g_list_store_find_with_equal_func" version="2.64"> Looks up the given @item in the list store by looping over the items and + filename="gio/gliststore.c" + line="520">Looks up the given @item in the list store by looping over the items and comparing them with @equal_func until the first occurrence of @item which matches. If @item was not found, then @position will not be set, and this method will return %FALSE. @@ -75746,20 +76428,19 @@ method will return %FALSE. @item is always passed as second parameter to @equal_func. Since GLib 2.76 it is possible to pass `NULL` for @item. - + Whether @store contains @item. If it was found, @position will be + filename="gio/gliststore.c" + line="536">Whether @store contains @item. If it was found, @position will be set to the position where @item occurred for the first time. a #GListStore + filename="gio/gliststore.c" + line="522">a #GListStore nullable="1" allow-none="1"> an item + filename="gio/gliststore.c" + line="523">an item A custom equality check function + filename="gio/gliststore.c" + line="524">A custom equality check function optional="1" allow-none="1"> the first position of @item, if it was found. + filename="gio/gliststore.c" + line="525">the first position of @item, if it was found. @@ -75794,27 +76475,26 @@ set to the position where @item occurred for the first time. c:identifier="g_list_store_find_with_equal_func_full" version="2.74"> Like g_list_store_find_with_equal_func() but with an additional @user_data + filename="gio/gliststore.c" + line="553">Like g_list_store_find_with_equal_func() but with an additional @user_data that is passed to @equal_func. @item is always passed as second parameter to @equal_func. Since GLib 2.76 it is possible to pass `NULL` for @item. - + Whether @store contains @item. If it was found, @position will be + filename="gio/gliststore.c" + line="568">Whether @store contains @item. If it was found, @position will be set to the position where @item occurred for the first time. a #GListStore + filename="gio/gliststore.c" + line="555">a #GListStore nullable="1" allow-none="1"> an item + filename="gio/gliststore.c" + line="556">an item scope="call" closure="2"> A custom equality check function + filename="gio/gliststore.c" + line="557">A custom equality check function nullable="1" allow-none="1"> user data for @equal_func + filename="gio/gliststore.c" + line="558">user data for @equal_func optional="1" allow-none="1"> the first position of @item, if it was found. + filename="gio/gliststore.c" + line="559">the first position of @item, if it was found. Inserts @item into @store at @position. @item must be of type + filename="gio/gliststore.c" + line="260">Inserts @item into @store at @position. @item must be of type #GListStore:item-type or derived from it. @position must be smaller than the length of the list, or equal to it to append. @@ -75868,28 +76548,27 @@ This function takes a ref on @item. Use g_list_store_splice() to insert multiple items at the same time efficiently. - + a #GListStore + filename="gio/gliststore.c" + line="262">a #GListStore the position at which to insert the new item + filename="gio/gliststore.c" + line="263">the position at which to insert the new item the new item + filename="gio/gliststore.c" + line="264">the new item @@ -75898,8 +76577,8 @@ efficiently. c:identifier="g_list_store_insert_sorted" version="2.44"> Inserts @item into @store at a position to be determined by the + filename="gio/gliststore.c" + line="294">Inserts @item into @store at a position to be determined by the @compare_func. The list must already be sorted before calling this function or the @@ -75907,25 +76586,24 @@ result is undefined. Usually you would approach this by only ever inserting items by way of this function. This function takes a ref on @item. - + the position at which @item was inserted + filename="gio/gliststore.c" + line="310">the position at which @item was inserted a #GListStore + filename="gio/gliststore.c" + line="296">a #GListStore the new item + filename="gio/gliststore.c" + line="297">the new item scope="call" closure="2"> pairwise comparison function for sorting + filename="gio/gliststore.c" + line="298">pairwise comparison function for sorting nullable="1" allow-none="1"> user data for @compare_func + filename="gio/gliststore.c" + line="299">user data for @compare_func Removes the item from @store that is at @position. @position must be + filename="gio/gliststore.c" + line="390">Removes the item from @store that is at @position. @position must be smaller than the current length of the list. Use g_list_store_splice() to remove multiple items at the same time efficiently. - + a #GListStore + filename="gio/gliststore.c" + line="392">a #GListStore the position of the item that is to be removed + filename="gio/gliststore.c" + line="393">the position of the item that is to be removed @@ -75980,36 +76657,34 @@ efficiently. c:identifier="g_list_store_remove_all" version="2.44"> Removes all items from @store. - + filename="gio/gliststore.c" + line="418">Removes all items from @store. + a #GListStore + filename="gio/gliststore.c" + line="420">a #GListStore Sort the items in @store according to @compare_func. - + filename="gio/gliststore.c" + line="335">Sort the items in @store according to @compare_func. + a #GListStore + filename="gio/gliststore.c" + line="337">a #GListStore scope="call" closure="1"> pairwise comparison function for sorting + filename="gio/gliststore.c" + line="338">pairwise comparison function for sorting nullable="1" allow-none="1"> user data for @compare_func + filename="gio/gliststore.c" + line="339">user data for @compare_func Changes @store by removing @n_removals items and adding @n_additions + filename="gio/gliststore.c" + line="440">Changes @store by removing @n_removals items and adding @n_additions items to it. @additions must contain @n_additions items of type #GListStore:item-type. %NULL is not permitted. @@ -76048,42 +76723,41 @@ This function takes a ref on each item in @additions. The parameters @position and @n_removals must be correct (ie: @position + @n_removals must be less than or equal to the length of the list at the time this function is called). - + a #GListStore + filename="gio/gliststore.c" + line="442">a #GListStore the position at which to make the change + filename="gio/gliststore.c" + line="443">the position at which to make the change the number of items to remove + filename="gio/gliststore.c" + line="444">the number of items to remove the items to add + filename="gio/gliststore.c" + line="445">the items to add the number of items to add + filename="gio/gliststore.c" + line="446">the number of items to add @@ -76094,8 +76768,8 @@ the list at the time this function is called). construct-only="1" transfer-ownership="none"> The type of items contained in this list store. Items must be + filename="gio/gliststore.c" + line="149">The type of items contained in this list store. Items must be subclasses of #GObject. @@ -76104,16 +76778,15 @@ subclasses of #GObject. transfer-ownership="none" default-value="0"> The number of items contained in this list store. + filename="gio/gliststore.c" + line="161">The number of items contained in this list store. - + @@ -76125,36 +76798,37 @@ subclasses of #GObject. glib:get-type="g_loadable_icon_get_type" glib:type-struct="LoadableIconIface"> Extends the #GIcon interface and adds the ability to -load icons from streams. - + filename="gio/gloadableicon.c" + line="31">`GLoadableIcon` extends the [iface@Gio.Icon] interface and adds the ability +to load icons from streams. + - + Loads a loadable icon. For the asynchronous version of this function, + filename="gio/gloadableicon.c" + line="58">Loads a loadable icon. For the asynchronous version of this function, see g_loadable_icon_load_async(). - + a #GInputStream to read the icon from. + filename="gio/gloadableicon.c" + line="72">a #GInputStream to read the icon from. a #GLoadableIcon. + filename="gio/gloadableicon.c" + line="60">a #GLoadableIcon. an integer. + filename="gio/gloadableicon.c" + line="61">an integer. optional="1" allow-none="1"> a location to store the type of the loaded + filename="gio/gloadableicon.c" + line="62">a location to store the type of the loaded icon, %NULL to ignore. @@ -76174,35 +76848,37 @@ icon, %NULL to ignore. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to + filename="gio/gloadableicon.c" + line="64">optional #GCancellable object, %NULL to ignore. - + Loads an icon asynchronously. To finish this function, see + filename="gio/gloadableicon.c" + line="90">Loads an icon asynchronously. To finish this function, see g_loadable_icon_load_finish(). For the synchronous, blocking version of this function, see g_loadable_icon_load(). - + a #GLoadableIcon. + filename="gio/gloadableicon.c" + line="92">a #GLoadableIcon. an integer. + filename="gio/gloadableicon.c" + line="93">an integer. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gloadableicon.c" + line="94">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gloadableicon.c" + line="95">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gloadableicon.c" + line="97">the data to pass to callback function Finishes an asynchronous icon load started in g_loadable_icon_load_async(). - + filename="gio/gloadableicon.c" + line="119">Finishes an asynchronous icon load started in g_loadable_icon_load_async(). + a #GInputStream to read the icon from. + filename="gio/gloadableicon.c" + line="130">a #GInputStream to read the icon from. a #GLoadableIcon. + filename="gio/gloadableicon.c" + line="121">a #GLoadableIcon. a #GAsyncResult. + filename="gio/gloadableicon.c" + line="122">a #GAsyncResult. optional="1" allow-none="1"> a location to store the type of the loaded + filename="gio/gloadableicon.c" + line="123">a location to store the type of the loaded icon, %NULL to ignore. - + Loads a loadable icon. For the asynchronous version of this function, + filename="gio/gloadableicon.c" + line="58">Loads a loadable icon. For the asynchronous version of this function, see g_loadable_icon_load_async(). - + a #GInputStream to read the icon from. + filename="gio/gloadableicon.c" + line="72">a #GInputStream to read the icon from. a #GLoadableIcon. + filename="gio/gloadableicon.c" + line="60">a #GLoadableIcon. an integer. + filename="gio/gloadableicon.c" + line="61">an integer. optional="1" allow-none="1"> a location to store the type of the loaded + filename="gio/gloadableicon.c" + line="62">a location to store the type of the loaded icon, %NULL to ignore. @@ -76320,35 +76997,37 @@ icon, %NULL to ignore. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to + filename="gio/gloadableicon.c" + line="64">optional #GCancellable object, %NULL to ignore. - + Loads an icon asynchronously. To finish this function, see + filename="gio/gloadableicon.c" + line="90">Loads an icon asynchronously. To finish this function, see g_loadable_icon_load_finish(). For the synchronous, blocking version of this function, see g_loadable_icon_load(). - + a #GLoadableIcon. + filename="gio/gloadableicon.c" + line="92">a #GLoadableIcon. an integer. + filename="gio/gloadableicon.c" + line="93">an integer. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gloadableicon.c" + line="94">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gloadableicon.c" + line="95">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gloadableicon.c" + line="97">the data to pass to callback function @@ -76387,27 +77066,26 @@ version of this function, see g_loadable_icon_load(). c:identifier="g_loadable_icon_load_finish" throws="1"> Finishes an asynchronous icon load started in g_loadable_icon_load_async(). - + filename="gio/gloadableicon.c" + line="119">Finishes an asynchronous icon load started in g_loadable_icon_load_async(). + a #GInputStream to read the icon from. + filename="gio/gloadableicon.c" + line="130">a #GInputStream to read the icon from. a #GLoadableIcon. + filename="gio/gloadableicon.c" + line="121">a #GLoadableIcon. a #GAsyncResult. + filename="gio/gloadableicon.c" + line="122">a #GAsyncResult. optional="1" allow-none="1"> a location to store the type of the loaded + filename="gio/gloadableicon.c" + line="123">a location to store the type of the loaded icon, %NULL to ignore. @@ -76429,37 +77107,38 @@ version of this function, see g_loadable_icon_load(). c:type="GLoadableIconIface" glib:is-gtype-struct-for="LoadableIcon"> Interface for icons that can be loaded as a stream. - + filename="gio/gloadableicon.h" + line="41">Interface for icons that can be loaded as a stream. + The parent interface. + filename="gio/gloadableicon.h" + line="43">The parent interface. + Loads an icon. - + a #GInputStream to read the icon from. + filename="gio/gloadableicon.c" + line="72">a #GInputStream to read the icon from. a #GLoadableIcon. + filename="gio/gloadableicon.c" + line="60">a #GLoadableIcon. an integer. + filename="gio/gloadableicon.c" + line="61">an integer. optional="1" allow-none="1"> a location to store the type of the loaded + filename="gio/gloadableicon.c" + line="62">a location to store the type of the loaded icon, %NULL to ignore. @@ -76479,8 +77158,8 @@ icon, %NULL to ignore. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to + filename="gio/gloadableicon.c" + line="64">optional #GCancellable object, %NULL to ignore. @@ -76488,23 +77167,25 @@ ignore. + Loads an icon asynchronously. - + a #GLoadableIcon. + filename="gio/gloadableicon.c" + line="92">a #GLoadableIcon. an integer. + filename="gio/gloadableicon.c" + line="93">an integer. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gloadableicon.c" + line="94">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gloadableicon.c" + line="95">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gloadableicon.c" + line="97">the data to pass to callback function + Finishes an asynchronous icon load. - + a #GInputStream to read the icon from. + filename="gio/gloadableicon.c" + line="130">a #GInputStream to read the icon from. a #GLoadableIcon. + filename="gio/gloadableicon.c" + line="121">a #GLoadableIcon. a #GAsyncResult. + filename="gio/gloadableicon.c" + line="122">a #GAsyncResult. optional="1" allow-none="1"> a location to store the type of the loaded + filename="gio/gloadableicon.c" + line="123">a location to store the type of the loaded icon, %NULL to ignore. @@ -76583,8 +77266,7 @@ ignore. - + @@ -76593,8 +77275,7 @@ ignore. - + @@ -76603,8 +77284,7 @@ ignore. - + @@ -76613,8 +77293,7 @@ ignore. - + @@ -76625,18 +77304,16 @@ ignore. c:type="G_MEMORY_MONITOR_EXTENSION_POINT_NAME" version="2.64"> Extension point for memory usage monitoring functionality. See [Extending GIO][extending-gio]. - + - + @@ -76645,8 +77322,7 @@ See [Extending GIO][extending-gio]. - + @@ -76655,8 +77331,7 @@ See [Extending GIO][extending-gio]. - + @@ -76665,16 +77340,14 @@ See [Extending GIO][extending-gio]. - + - + @@ -76685,15 +77358,14 @@ See [Extending GIO][extending-gio]. c:type="G_MENU_ATTRIBUTE_ACTION" version="2.32"> The menu item attribute which holds the action name of the item. Action names are namespaced with an identifier for the action group in which the action resides. For example, "win." for window-specific actions and "app." for application-wide actions. See also g_menu_model_get_item_attribute() and g_menu_item_set_attribute(). - + The menu item attribute that holds the namespace for all action names in menus that are linked from this item. - + c:type="G_MENU_ATTRIBUTE_ICON" version="2.38"> The menu item attribute which holds the icon of the item. The icon is stored in the format returned by g_icon_serialize(). @@ -76721,15 +77392,13 @@ The icon is stored in the format returned by g_icon_serialize(). This attribute is intended only to represent 'noun' icons such as favicons for a webpage, or application icons. It should not be used for 'verbs' (ie: stock icons). - + - + @@ -76738,8 +77407,7 @@ for 'verbs' (ie: stock icons). - + @@ -76748,8 +77416,7 @@ for 'verbs' (ie: stock icons). - + @@ -76760,10 +77427,9 @@ for 'verbs' (ie: stock icons). c:type="G_MENU_ATTRIBUTE_LABEL" version="2.32"> The menu item attribute which holds the label of the item. - + c:type="G_MENU_ATTRIBUTE_TARGET" version="2.32"> The menu item attribute which holds the target with which the item's action will be activated. See also g_menu_item_set_action_and_target() - + c:type="G_MENU_EXPORTER_MAX_SECTION_SIZE" version="2.76"> The maximum number of entries in a menu section supported by g_dbus_connection_export_menu_model(). The exact value of the limit may change in future GLib versions. - + - + @@ -76807,8 +77470,7 @@ The exact value of the limit may change in future GLib versions. - + @@ -76817,8 +77479,7 @@ The exact value of the limit may change in future GLib versions. - + @@ -76827,8 +77488,7 @@ The exact value of the limit may change in future GLib versions. - + @@ -76839,14 +77499,13 @@ The exact value of the limit may change in future GLib versions. c:type="G_MENU_LINK_SECTION" version="2.32"> The name of the link that associates a menu item with a section. The linked menu will usually be shown in place of the menu item, using the item's label as a header. See also g_menu_item_set_link(). - + c:type="G_MENU_LINK_SUBMENU" version="2.32"> The name of the link that associates a menu item with a submenu. See also g_menu_item_set_link(). - + - + @@ -76875,8 +77532,7 @@ See also g_menu_item_set_link(). - + @@ -76885,16 +77541,14 @@ See also g_menu_item_set_link(). - + - + @@ -76903,8 +77557,7 @@ See also g_menu_item_set_link(). - + @@ -76913,8 +77566,7 @@ See also g_menu_item_set_link(). - + @@ -76923,8 +77575,7 @@ See also g_menu_item_set_link(). - + @@ -76933,8 +77584,7 @@ See also g_menu_item_set_link(). - + @@ -76948,26 +77598,24 @@ See also g_menu_item_set_link(). glib:get-type="g_memory_input_stream_get_type" glib:type-struct="MemoryInputStreamClass"> #GMemoryInputStream is a class for using arbitrary + filename="gio/gmemoryinputstream.c" + line="34">`GMemoryInputStream` is a class for using arbitrary memory chunks as input for GIO streaming input operations. -As of GLib 2.34, #GMemoryInputStream implements -#GPollableInputStream. - +As of GLib 2.34, `GMemoryInputStream` implements +[iface@Gio.PollableInputStream]. + Creates a new empty #GMemoryInputStream. - + filename="gio/gmemoryinputstream.c" + line="167">Creates a new empty #GMemoryInputStream. + a new #GInputStream + filename="gio/gmemoryinputstream.c" + line="172">a new #GInputStream @@ -76975,21 +77623,20 @@ As of GLib 2.34, #GMemoryInputStream implements c:identifier="g_memory_input_stream_new_from_bytes" version="2.34"> Creates a new #GMemoryInputStream with data from the given @bytes. - + filename="gio/gmemoryinputstream.c" + line="209">Creates a new #GMemoryInputStream with data from the given @bytes. + new #GInputStream read from @bytes + filename="gio/gmemoryinputstream.c" + line="215">new #GInputStream read from @bytes a #GBytes + filename="gio/gmemoryinputstream.c" + line="211">a #GBytes @@ -76997,29 +77644,28 @@ As of GLib 2.34, #GMemoryInputStream implements Creates a new #GMemoryInputStream with data in memory of a given size. - + filename="gio/gmemoryinputstream.c" + line="184">Creates a new #GMemoryInputStream with data in memory of a given size. + new #GInputStream read from @data of @len bytes. + filename="gio/gmemoryinputstream.c" + line="192">new #GInputStream read from @data of @len bytes. input data + filename="gio/gmemoryinputstream.c" + line="186">input data length of the data, may be -1 if @data is a nul-terminated string + filename="gio/gmemoryinputstream.c" + line="187">length of the data, may be -1 if @data is a nul-terminated string function that is called to free @data, or %NULL + filename="gio/gmemoryinputstream.c" + line="188">function that is called to free @data, or %NULL @@ -77038,56 +77684,54 @@ As of GLib 2.34, #GMemoryInputStream implements c:identifier="g_memory_input_stream_add_bytes" version="2.34"> Appends @bytes to data that can be read from the input stream. - + filename="gio/gmemoryinputstream.c" + line="263">Appends @bytes to data that can be read from the input stream. + a #GMemoryInputStream + filename="gio/gmemoryinputstream.c" + line="265">a #GMemoryInputStream input data + filename="gio/gmemoryinputstream.c" + line="266">input data Appends @data to data that can be read from the input stream - + filename="gio/gmemoryinputstream.c" + line="233">Appends @data to data that can be read from the input stream + a #GMemoryInputStream + filename="gio/gmemoryinputstream.c" + line="235">a #GMemoryInputStream input data + filename="gio/gmemoryinputstream.c" + line="236">input data length of the data, may be -1 if @data is a nul-terminated string + filename="gio/gmemoryinputstream.c" + line="237">length of the data, may be -1 if @data is a nul-terminated string function that is called to free @data, or %NULL + filename="gio/gmemoryinputstream.c" + line="238">function that is called to free @data, or %NULL @@ -77113,15 +77757,13 @@ As of GLib 2.34, #GMemoryInputStream implements - + - + @@ -77129,8 +77771,7 @@ As of GLib 2.34, #GMemoryInputStream implements - + @@ -77138,8 +77779,7 @@ As of GLib 2.34, #GMemoryInputStream implements - + @@ -77147,8 +77787,7 @@ As of GLib 2.34, #GMemoryInputStream implements - + @@ -77156,8 +77795,7 @@ As of GLib 2.34, #GMemoryInputStream implements - + @@ -77168,8 +77806,7 @@ As of GLib 2.34, #GMemoryInputStream implements c:type="GMemoryInputStreamPrivate" disguised="1" opaque="1"> - + #GMemoryMonitor will monitor system memory and suggest to the application + filename="gio/gmemorymonitor.c" + line="33">`GMemoryMonitor` will monitor system memory and suggest to the application when to free memory so as to leave more room for other applications. -It is implemented on Linux using the [Low Memory Monitor](https://gitlab.freedesktop.org/hadess/low-memory-monitor/) +It is implemented on Linux using the +[Low Memory Monitor](https://gitlab.freedesktop.org/hadess/low-memory-monitor/) ([API documentation](https://hadess.pages.freedesktop.org/low-memory-monitor/)). There is also an implementation for use inside Flatpak sandboxes. @@ -77190,11 +77828,11 @@ There is also an implementation for use inside Flatpak sandboxes. Possible actions to take when the signal is received are: - Free caches - - Save files that haven't been looked at in a while to disk, ready to be reopened when needed + - Save files that haven’t been looked at in a while to disk, ready to be reopened when needed - Run a garbage collection cycle - Try and compress fragmented allocations - Exit on idle if the process has no reason to stay around - - Call [`malloc_trim(3)`](man:malloc_trim) to return cached heap pages to + - Call [`malloc_trim(3)`](man:malloc_trim(3)) to return cached heap pages to the kernel (if supported by your libc) Note that some actions may not always improve system performance, and so @@ -77202,9 +77840,10 @@ should be profiled for your application. `malloc_trim()`, for example, may make future heap allocations slower (due to releasing cached heap pages back to the kernel). -See #GMemoryMonitorWarningLevel for details on the various warning levels. +See [type@Gio.MemoryMonitorWarningLevel] for details on the various warning +levels. -|[<!-- language="C" --> +```c static void warning_cb (GMemoryMonitor *m, GMemoryMonitorWarningLevel level) { @@ -77222,31 +77861,32 @@ monitor_low_memory (void) G_CALLBACK (warning_cb), NULL); return m; } -]| +``` -Don't forget to disconnect the #GMemoryMonitor::low-memory-warning -signal, and unref the #GMemoryMonitor itself when exiting. - +Don’t forget to disconnect the [signal@Gio.MemoryMonitor::low-memory-warning] +signal, and unref the `GMemoryMonitor` itself when exiting. + Gets a reference to the default #GMemoryMonitor for the system. - + filename="gio/gmemorymonitor.c" + line="109">Gets a reference to the default #GMemoryMonitor for the system. + a new reference to the default #GMemoryMonitor + filename="gio/gmemorymonitor.c" + line="114">a new reference to the default #GMemoryMonitor - + the virtual function pointer for the + #GMemoryMonitor::low-memory-warning signal. + @@ -77262,8 +77902,8 @@ signal, and unref the #GMemoryMonitor itself when exiting. Emitted when the system is running low on free memory. The signal + filename="gio/gmemorymonitor.c" + line="129">Emitted when the system is running low on free memory. The signal handler should then take the appropriate action depending on the warning level. See the #GMemoryMonitorWarningLevel documentation for details. @@ -77273,8 +77913,8 @@ details. the #GMemoryMonitorWarningLevel warning level + filename="gio/gmemorymonitor.c" + line="132">the #GMemoryMonitorWarningLevel warning level @@ -77285,20 +77925,22 @@ details. glib:is-gtype-struct-for="MemoryMonitor" version="2.64"> The virtual function table for #GMemoryMonitor. - + filename="gio/gmemorymonitor.c" + line="88">The virtual function table for #GMemoryMonitor. + The parent interface. + filename="gio/gmemorymonitor.c" + line="90">The parent interface. + the virtual function pointer for the + #GMemoryMonitor::low-memory-warning signal. - + @@ -77320,8 +77962,8 @@ details. glib:get-type="g_memory_monitor_warning_level_get_type" c:type="GMemoryMonitorWarningLevel"> Memory availability warning levels. + filename="gio/gioenums.h" + line="2123">Memory availability warning levels. Note that because new values might be added, it is recommended that applications check #GMemoryMonitorWarningLevel as ranges, for example: @@ -77335,8 +77977,8 @@ if (warning_level > G_MEMORY_MONITOR_WARNING_LEVEL_LOW) glib:nick="low" glib:name="G_MEMORY_MONITOR_WARNING_LEVEL_LOW"> Memory on the device is low, processes + filename="gio/gioenums.h" + line="2125">Memory on the device is low, processes should free up unneeded resources (for example, in-memory caches) so they can be used elsewhere. @@ -77346,8 +77988,8 @@ if (warning_level > G_MEMORY_MONITOR_WARNING_LEVEL_LOW) glib:nick="medium" glib:name="G_MEMORY_MONITOR_WARNING_LEVEL_MEDIUM"> Same as @G_MEMORY_MONITOR_WARNING_LEVEL_LOW + filename="gio/gioenums.h" + line="2128">Same as @G_MEMORY_MONITOR_WARNING_LEVEL_LOW but the device has even less free memory, so processes should try harder to free up unneeded resources. If your process does not need to stay running, it is a good time for it to quit. @@ -77358,8 +78000,8 @@ if (warning_level > G_MEMORY_MONITOR_WARNING_LEVEL_LOW) glib:nick="critical" glib:name="G_MEMORY_MONITOR_WARNING_LEVEL_CRITICAL"> The system will soon start terminating + filename="gio/gioenums.h" + line="2132">The system will soon start terminating processes to reclaim memory, including background processes. @@ -77371,22 +78013,21 @@ if (warning_level > G_MEMORY_MONITOR_WARNING_LEVEL_LOW) glib:get-type="g_memory_output_stream_get_type" glib:type-struct="MemoryOutputStreamClass"> #GMemoryOutputStream is a class for using arbitrary + filename="gio/gmemoryoutputstream.c" + line="37">`GMemoryOutputStream` is a class for using arbitrary memory chunks as output for GIO streaming output operations. -As of GLib 2.34, #GMemoryOutputStream trivially implements -#GPollableOutputStream: it always polls as ready. - +As of GLib 2.34, `GMemoryOutputStream` trivially implements +[iface@Gio.PollableOutputStream]: it always polls as ready. + Creates a new #GMemoryOutputStream. + filename="gio/gmemoryoutputstream.c" + line="321">Creates a new #GMemoryOutputStream. In most cases this is not the function you want. See g_memory_output_stream_new_resizable() instead. @@ -77427,12 +78068,11 @@ stream2 = g_memory_output_stream_new (NULL, 0, g_realloc, g_free); data = malloc (200); stream3 = g_memory_output_stream_new (data, 200, NULL, free); ]| - + A newly created #GMemoryOutputStream object. + filename="gio/gmemoryoutputstream.c" + line="372">A newly created #GMemoryOutputStream object. @@ -77441,14 +78081,14 @@ stream3 = g_memory_output_stream_new (data, 200, NULL, free); nullable="1" allow-none="1"> pointer to a chunk of memory to use, or %NULL + filename="gio/gmemoryoutputstream.c" + line="323">pointer to a chunk of memory to use, or %NULL the size of @data + filename="gio/gmemoryoutputstream.c" + line="324">the size of @data a function with realloc() semantics (like g_realloc()) + filename="gio/gmemoryoutputstream.c" + line="325">a function with realloc() semantics (like g_realloc()) to be called when @data needs to be grown, or %NULL @@ -77469,8 +78109,8 @@ stream3 = g_memory_output_stream_new (data, 200, NULL, free); allow-none="1" scope="async"> a function to be called on @data when the stream is + filename="gio/gmemoryoutputstream.c" + line="327">a function to be called on @data when the stream is finalized, or %NULL @@ -77480,11 +78120,10 @@ stream3 = g_memory_output_stream_new (data, 200, NULL, free); c:identifier="g_memory_output_stream_new_resizable" version="2.36"> Creates a new #GMemoryOutputStream, using g_realloc() and g_free() + filename="gio/gmemoryoutputstream.c" + line="392">Creates a new #GMemoryOutputStream, using g_realloc() and g_free() for memory allocation. - + @@ -77493,25 +78132,24 @@ for memory allocation. c:identifier="g_memory_output_stream_get_data" glib:get-property="data"> Gets any loaded data from the @ostream. + filename="gio/gmemoryoutputstream.c" + line="406">Gets any loaded data from the @ostream. Note that the returned pointer may become invalid on the next write or truncate operation on the stream. - + pointer to the stream's data, or %NULL if the data + filename="gio/gmemoryoutputstream.c" + line="415">pointer to the stream's data, or %NULL if the data has been stolen a #GMemoryOutputStream + filename="gio/gmemoryoutputstream.c" + line="408">a #GMemoryOutputStream @@ -77521,22 +78159,21 @@ write or truncate operation on the stream. glib:get-property="data-size" version="2.18"> Returns the number of bytes from the start up to including the last + filename="gio/gmemoryoutputstream.c" + line="456">Returns the number of bytes from the start up to including the last byte written in the stream that has not been truncated away. - + the number of bytes written to the stream + filename="gio/gmemoryoutputstream.c" + line="463">the number of bytes written to the stream a #GMemoryOutputStream + filename="gio/gmemoryoutputstream.c" + line="458">a #GMemoryOutputStream @@ -77545,8 +78182,8 @@ byte written in the stream that has not been truncated away. c:identifier="g_memory_output_stream_get_size" glib:get-property="size"> Gets the size of the currently allocated data area (available from + filename="gio/gmemoryoutputstream.c" + line="426">Gets the size of the currently allocated data area (available from g_memory_output_stream_get_data()). You probably don't want to use this function on resizable streams. @@ -77561,19 +78198,18 @@ stream and further writes will return %G_IO_ERROR_NO_SPACE. In any case, if you want the number of bytes currently written to the stream, use g_memory_output_stream_get_data_size(). - + the number of bytes allocated for the data buffer + filename="gio/gmemoryoutputstream.c" + line="446">the number of bytes allocated for the data buffer a #GMemoryOutputStream + filename="gio/gmemoryoutputstream.c" + line="428">a #GMemoryOutputStream @@ -77582,22 +78218,21 @@ stream, use g_memory_output_stream_get_data_size(). c:identifier="g_memory_output_stream_steal_as_bytes" version="2.34"> Returns data from the @ostream as a #GBytes. @ostream must be + filename="gio/gmemoryoutputstream.c" + line="505">Returns data from the @ostream as a #GBytes. @ostream must be closed before calling this function. - + the stream's data + filename="gio/gmemoryoutputstream.c" + line="512">the stream's data a #GMemoryOutputStream + filename="gio/gmemoryoutputstream.c" + line="507">a #GMemoryOutputStream @@ -77606,27 +78241,26 @@ closed before calling this function. c:identifier="g_memory_output_stream_steal_data" version="2.26"> Gets any loaded data from the @ostream. Ownership of the data + filename="gio/gmemoryoutputstream.c" + line="475">Gets any loaded data from the @ostream. Ownership of the data is transferred to the caller; when no longer needed it must be freed using the free function set in @ostream's #GMemoryOutputStream:destroy-function property. @ostream must be closed before calling this function. - + the stream's data, or %NULL if it has previously + filename="gio/gmemoryoutputstream.c" + line="486">the stream's data, or %NULL if it has previously been stolen a #GMemoryOutputStream + filename="gio/gmemoryoutputstream.c" + line="477">a #GMemoryOutputStream @@ -77638,8 +78272,8 @@ freed using the free function set in @ostream's transfer-ownership="none" getter="get_data"> Pointer to buffer where data will be written. + filename="gio/gmemoryoutputstream.c" + line="145">Pointer to buffer where data will be written. Size of data written to the buffer. + filename="gio/gmemoryoutputstream.c" + line="172">Size of data written to the buffer. Function called with the buffer as argument when the stream is destroyed. + filename="gio/gmemoryoutputstream.c" + line="199">Function called with the buffer as argument when the stream is destroyed. Function with realloc semantics called to enlarge the buffer. + filename="gio/gmemoryoutputstream.c" + line="186">Function with realloc semantics called to enlarge the buffer. Current size of the data buffer. + filename="gio/gmemoryoutputstream.c" + line="158">Current size of the data buffer. @@ -77697,15 +78331,13 @@ freed using the free function set in @ostream's - + - + @@ -77713,8 +78345,7 @@ freed using the free function set in @ostream's - + @@ -77722,8 +78353,7 @@ freed using the free function set in @ostream's - + @@ -77731,8 +78361,7 @@ freed using the free function set in @ostream's - + @@ -77740,8 +78369,7 @@ freed using the free function set in @ostream's - + @@ -77752,8 +78380,7 @@ freed using the free function set in @ostream's c:type="GMemoryOutputStreamPrivate" disguised="1" opaque="1"> - + #GMenu is a simple implementation of #GMenuModel. -You populate a #GMenu by adding #GMenuItem instances to it. + filename="gio/gmenu.c" + line="31">`GMenu` is a simple implementation of [class@Gio.MenuModel]. +You populate a `GMenu` by adding [class@Gio.MenuItem] instances to it. There are some convenience functions to allow you to directly -add items (avoiding #GMenuItem) for the common cases. To add -a regular item, use g_menu_insert(). To add a section, use -g_menu_insert_section(). To add a submenu, use -g_menu_insert_submenu(). +add items (avoiding [class@Gio.MenuItem]) for the common cases. To add +a regular item, use [method@Gio.Menu.insert]. To add a section, use +[method@Gio.Menu.insert_section]. To add a submenu, use +[method@Gio.Menu.insert_submenu]. Creates a new #GMenu. + filename="gio/gmenu.c" + line="227">Creates a new #GMenu. The new menu has no items. - + a new #GMenu + filename="gio/gmenu.c" + line="234">a new #GMenu Convenience function for appending a normal menu item to the end of + filename="gio/gmenu.c" + line="290">Convenience function for appending a normal menu item to the end of @menu. Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative. - + a #GMenu + filename="gio/gmenu.c" + line="292">a #GMenu nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="293">the section label, or %NULL nullable="1" allow-none="1"> the detailed action string, or %NULL + filename="gio/gmenu.c" + line="294">the detailed action string, or %NULL @@ -77829,26 +78454,25 @@ flexible alternative. c:identifier="g_menu_append_item" version="2.32"> Appends @item to the end of @menu. + filename="gio/gmenu.c" + line="186">Appends @item to the end of @menu. See g_menu_insert_item() for more information. - + a #GMenu + filename="gio/gmenu.c" + line="188">a #GMenu a #GMenuItem to append + filename="gio/gmenu.c" + line="189">a #GMenuItem to append @@ -77857,20 +78481,19 @@ See g_menu_insert_item() for more information. c:identifier="g_menu_append_section" version="2.32"> Convenience function for appending a section menu item to the end of + filename="gio/gmenu.c" + line="357">Convenience function for appending a section menu item to the end of @menu. Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative. - + a #GMenu + filename="gio/gmenu.c" + line="359">a #GMenu nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="360">the section label, or %NULL a #GMenuModel with the items of the section + filename="gio/gmenu.c" + line="361">a #GMenuModel with the items of the section @@ -77894,20 +78517,19 @@ more flexible alternative. c:identifier="g_menu_append_submenu" version="2.32"> Convenience function for appending a submenu menu item to the end of + filename="gio/gmenu.c" + line="423">Convenience function for appending a submenu menu item to the end of @menu. Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative. - + a #GMenu + filename="gio/gmenu.c" + line="425">a #GMenu nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="426">the section label, or %NULL a #GMenuModel with the items of the submenu + filename="gio/gmenu.c" + line="427">a #GMenuModel with the items of the submenu Marks @menu as frozen. + filename="gio/gmenu.c" + line="204">Marks @menu as frozen. After the menu is frozen, it is an error to attempt to make any changes to it. In effect this means that the #GMenu API must no @@ -77938,42 +78560,40 @@ longer be used. This function causes g_menu_model_is_mutable() to begin returning %FALSE, which has some positive performance implications. - + a #GMenu + filename="gio/gmenu.c" + line="206">a #GMenu Convenience function for inserting a normal menu item into @menu. + filename="gio/gmenu.c" + line="244">Convenience function for inserting a normal menu item into @menu. Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative. - + a #GMenu + filename="gio/gmenu.c" + line="246">a #GMenu the position at which to insert the item + filename="gio/gmenu.c" + line="247">the position at which to insert the item nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="248">the section label, or %NULL nullable="1" allow-none="1"> the detailed action string, or %NULL + filename="gio/gmenu.c" + line="249">the detailed action string, or %NULL @@ -78000,8 +78620,8 @@ alternative. c:identifier="g_menu_insert_item" version="2.32"> Inserts @item into @menu. + filename="gio/gmenu.c" + line="121">Inserts @item into @menu. The "insertion" is actually done by copying all of the attribute and link values of @item and using them to form a new item within @menu. @@ -78018,28 +78638,27 @@ There are many convenience functions to take care of common cases. See g_menu_insert(), g_menu_insert_section() and g_menu_insert_submenu() as well as "prepend" and "append" variants of each of these functions. - + a #GMenu + filename="gio/gmenu.c" + line="123">a #GMenu the position at which to insert the item + filename="gio/gmenu.c" + line="124">the position at which to insert the item the #GMenuItem to insert + filename="gio/gmenu.c" + line="125">the #GMenuItem to insert @@ -78048,26 +78667,25 @@ each of these functions. c:identifier="g_menu_insert_section" version="2.32"> Convenience function for inserting a section menu item into @menu. + filename="gio/gmenu.c" + line="310">Convenience function for inserting a section menu item into @menu. Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative. - + a #GMenu + filename="gio/gmenu.c" + line="312">a #GMenu the position at which to insert the item + filename="gio/gmenu.c" + line="313">the position at which to insert the item nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="314">the section label, or %NULL a #GMenuModel with the items of the section + filename="gio/gmenu.c" + line="315">a #GMenuModel with the items of the section @@ -78091,26 +78709,25 @@ flexible alternative. c:identifier="g_menu_insert_submenu" version="2.32"> Convenience function for inserting a submenu menu item into @menu. + filename="gio/gmenu.c" + line="377">Convenience function for inserting a submenu menu item into @menu. Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative. - + a #GMenu + filename="gio/gmenu.c" + line="379">a #GMenu the position at which to insert the item + filename="gio/gmenu.c" + line="380">the position at which to insert the item nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="381">the section label, or %NULL a #GMenuModel with the items of the submenu + filename="gio/gmenu.c" + line="382">a #GMenuModel with the items of the submenu Convenience function for prepending a normal menu item to the start + filename="gio/gmenu.c" + line="270">Convenience function for prepending a normal menu item to the start of @menu. Combine g_menu_item_new() and g_menu_insert_item() for a more flexible alternative. - + a #GMenu + filename="gio/gmenu.c" + line="272">a #GMenu nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="273">the section label, or %NULL nullable="1" allow-none="1"> the detailed action string, or %NULL + filename="gio/gmenu.c" + line="274">the detailed action string, or %NULL @@ -78172,26 +78788,25 @@ flexible alternative. c:identifier="g_menu_prepend_item" version="2.32"> Prepends @item to the start of @menu. + filename="gio/gmenu.c" + line="168">Prepends @item to the start of @menu. See g_menu_insert_item() for more information. - + a #GMenu + filename="gio/gmenu.c" + line="170">a #GMenu a #GMenuItem to prepend + filename="gio/gmenu.c" + line="171">a #GMenuItem to prepend @@ -78200,20 +78815,19 @@ See g_menu_insert_item() for more information. c:identifier="g_menu_prepend_section" version="2.32"> Convenience function for prepending a section menu item to the start + filename="gio/gmenu.c" + line="337">Convenience function for prepending a section menu item to the start of @menu. Combine g_menu_item_new_section() and g_menu_insert_item() for a more flexible alternative. - + a #GMenu + filename="gio/gmenu.c" + line="339">a #GMenu nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="340">the section label, or %NULL a #GMenuModel with the items of the section + filename="gio/gmenu.c" + line="341">a #GMenuModel with the items of the section @@ -78237,20 +78851,19 @@ a more flexible alternative. c:identifier="g_menu_prepend_submenu" version="2.32"> Convenience function for prepending a submenu menu item to the start + filename="gio/gmenu.c" + line="403">Convenience function for prepending a submenu menu item to the start of @menu. Combine g_menu_item_new_submenu() and g_menu_insert_item() for a more flexible alternative. - + a #GMenu + filename="gio/gmenu.c" + line="405">a #GMenu nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="406">the section label, or %NULL a #GMenuModel with the items of the submenu + filename="gio/gmenu.c" + line="407">a #GMenuModel with the items of the submenu Removes an item from the menu. + filename="gio/gmenu.c" + line="452">Removes an item from the menu. @position gives the index of the item to remove. @@ -78283,22 +78896,21 @@ less than the number of items in the menu. It is not possible to remove items by identity since items are added to the menu simply by copying their links and attributes (ie: identity of the item itself is not preserved). - + a #GMenu + filename="gio/gmenu.c" + line="454">a #GMenu the position of the item to remove + filename="gio/gmenu.c" + line="455">the position of the item to remove @@ -78307,18 +78919,17 @@ identity of the item itself is not preserved). c:identifier="g_menu_remove_all" version="2.38"> Removes all items in the menu. - + filename="gio/gmenu.c" + line="482">Removes all items in the menu. + a #GMenu + filename="gio/gmenu.c" + line="484">a #GMenu @@ -78334,15 +78945,14 @@ identity of the item itself is not preserved). glib:get-type="g_menu_attribute_iter_get_type" glib:type-struct="MenuAttributeIterClass"> #GMenuAttributeIter is an opaque structure type. You must access it + filename="gio/gmenumodel.c" + line="150">#GMenuAttributeIter is an opaque structure type. You must access it using the functions below. - + This function combines g_menu_attribute_iter_next() with + filename="gio/gmenumodel.c" + line="699">This function combines g_menu_attribute_iter_next() with g_menu_attribute_iter_get_name() and g_menu_attribute_iter_get_value(). First the iterator is advanced to the next (possibly first) attribute. @@ -78357,20 +78967,19 @@ return the same values again. The value returned in @name remains valid for as long as the iterator remains at the current position. The value returned in @value must be unreffed using g_variant_unref() when it is no longer in use. - + %TRUE on success, or %FALSE if there is no additional + filename="gio/gmenumodel.c" + line="721">%TRUE on success, or %FALSE if there is no additional attribute a #GMenuAttributeIter + filename="gio/gmenumodel.c" + line="701">a #GMenuAttributeIter optional="1" allow-none="1"> the type of the attribute + filename="gio/gmenumodel.c" + line="702">the type of the attribute optional="1" allow-none="1"> the attribute value + filename="gio/gmenumodel.c" + line="703">the attribute value @@ -78401,24 +79010,23 @@ be unreffed using g_variant_unref() when it is no longer in use. c:identifier="g_menu_attribute_iter_get_name" version="2.32"> Gets the name of the attribute at the current iterator position, as + filename="gio/gmenumodel.c" + line="779">Gets the name of the attribute at the current iterator position, as a string. The iterator is not advanced. - + the name of the attribute + filename="gio/gmenumodel.c" + line="788">the name of the attribute a #GMenuAttributeIter + filename="gio/gmenumodel.c" + line="781">a #GMenuAttributeIter @@ -78427,8 +79035,8 @@ The iterator is not advanced. c:identifier="g_menu_attribute_iter_get_next" version="2.32"> This function combines g_menu_attribute_iter_next() with + filename="gio/gmenumodel.c" + line="699">This function combines g_menu_attribute_iter_next() with g_menu_attribute_iter_get_name() and g_menu_attribute_iter_get_value(). First the iterator is advanced to the next (possibly first) attribute. @@ -78443,20 +79051,19 @@ return the same values again. The value returned in @name remains valid for as long as the iterator remains at the current position. The value returned in @value must be unreffed using g_variant_unref() when it is no longer in use. - + %TRUE on success, or %FALSE if there is no additional + filename="gio/gmenumodel.c" + line="721">%TRUE on success, or %FALSE if there is no additional attribute a #GMenuAttributeIter + filename="gio/gmenumodel.c" + line="701">a #GMenuAttributeIter optional="1" allow-none="1"> the type of the attribute + filename="gio/gmenumodel.c" + line="702">the type of the attribute optional="1" allow-none="1"> the attribute value + filename="gio/gmenumodel.c" + line="703">the attribute value @@ -78487,23 +79094,22 @@ be unreffed using g_variant_unref() when it is no longer in use. c:identifier="g_menu_attribute_iter_get_value" version="2.32"> Gets the value of the attribute at the current iterator position. + filename="gio/gmenumodel.c" + line="800">Gets the value of the attribute at the current iterator position. The iterator is not advanced. - + the value of the current attribute + filename="gio/gmenumodel.c" + line="808">the value of the current attribute a #GMenuAttributeIter + filename="gio/gmenumodel.c" + line="802">a #GMenuAttributeIter @@ -78512,8 +79118,8 @@ The iterator is not advanced. c:identifier="g_menu_attribute_iter_next" version="2.32"> Attempts to advance the iterator to the next (possibly first) + filename="gio/gmenumodel.c" + line="755">Attempts to advance the iterator to the next (possibly first) attribute. %TRUE is returned on success, or %FALSE if there are no more @@ -78522,19 +79128,18 @@ attributes. You must call this function when you first acquire the iterator to advance it to the first attribute (and determine if the first attribute exists at all). - + %TRUE on success, or %FALSE when there are no more attributes + filename="gio/gmenumodel.c" + line="769">%TRUE on success, or %FALSE when there are no more attributes a #GMenuAttributeIter + filename="gio/gmenumodel.c" + line="757">a #GMenuAttributeIter @@ -78550,27 +79155,25 @@ attribute exists at all). - + - + %TRUE on success, or %FALSE if there is no additional + filename="gio/gmenumodel.c" + line="721">%TRUE on success, or %FALSE if there is no additional attribute a #GMenuAttributeIter + filename="gio/gmenumodel.c" + line="701">a #GMenuAttributeIter optional="1" allow-none="1"> the type of the attribute + filename="gio/gmenumodel.c" + line="702">the type of the attribute optional="1" allow-none="1"> the attribute value + filename="gio/gmenumodel.c" + line="703">the attribute value @@ -78603,8 +79206,7 @@ attribute exists at all). c:type="GMenuAttributeIterPrivate" disguised="1" opaque="1"> - + glib:type-name="GMenuItem" glib:get-type="g_menu_item_get_type"> #GMenuItem is an opaque structure type. You must access it using the + filename="gio/gmenu.c" + line="46">#GMenuItem is an opaque structure type. You must access it using the functions below. Creates a new #GMenuItem. + filename="gio/gmenu.c" + line="1105">Creates a new #GMenuItem. If @label is non-%NULL it is used to set the "label" attribute of the new item. @@ -78628,12 +79230,11 @@ new item. If @detailed_action is non-%NULL it is used to set the "action" and possibly the "target" attribute of the new item. See g_menu_item_set_detailed_action() for more information. - + a new #GMenuItem + filename="gio/gmenu.c" + line="1119">a new #GMenuItem @@ -78642,8 +79243,8 @@ g_menu_item_set_detailed_action() for more information. nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="1107">the section label, or %NULL nullable="1" allow-none="1"> the detailed action string, or %NULL + filename="gio/gmenu.c" + line="1108">the detailed action string, or %NULL @@ -78661,31 +79262,30 @@ g_menu_item_set_detailed_action() for more information. c:identifier="g_menu_item_new_from_model" version="2.34"> Creates a #GMenuItem as an exact copy of an existing menu item in a + filename="gio/gmenu.c" + line="1256">Creates a #GMenuItem as an exact copy of an existing menu item in a #GMenuModel. @item_index must be valid (ie: be sure to call g_menu_model_get_n_items() first). - + a new #GMenuItem. + filename="gio/gmenu.c" + line="1267">a new #GMenuItem. a #GMenuModel + filename="gio/gmenu.c" + line="1258">a #GMenuModel the index of an item in @model + filename="gio/gmenu.c" + line="1259">the index of an item in @model @@ -78694,8 +79294,8 @@ g_menu_model_get_n_items() first). c:identifier="g_menu_item_new_section" version="2.32"> Creates a new #GMenuItem representing a section. + filename="gio/gmenu.c" + line="1170">Creates a new #GMenuItem representing a section. This is a convenience API around g_menu_item_new() and g_menu_item_set_section(). @@ -78755,12 +79355,11 @@ purpose of understanding what is really going on). </item> </menu> ]| - + a new #GMenuItem + filename="gio/gmenu.c" + line="1236">a new #GMenuItem @@ -78769,14 +79368,14 @@ purpose of understanding what is really going on). nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="1172">the section label, or %NULL a #GMenuModel with the items of the section + filename="gio/gmenu.c" + line="1173">a #GMenuModel with the items of the section @@ -78785,17 +79384,16 @@ purpose of understanding what is really going on). c:identifier="g_menu_item_new_submenu" version="2.32"> Creates a new #GMenuItem representing a submenu. + filename="gio/gmenu.c" + line="1140">Creates a new #GMenuItem representing a submenu. This is a convenience API around g_menu_item_new() and g_menu_item_set_submenu(). - + a new #GMenuItem + filename="gio/gmenu.c" + line="1150">a new #GMenuItem @@ -78804,14 +79402,14 @@ g_menu_item_set_submenu(). nullable="1" allow-none="1"> the section label, or %NULL + filename="gio/gmenu.c" + line="1142">the section label, or %NULL a #GMenuModel with the items of the submenu + filename="gio/gmenu.c" + line="1143">a #GMenuModel with the items of the submenu @@ -78821,8 +79419,8 @@ g_menu_item_set_submenu(). version="2.34" introspectable="0"> Queries the named @attribute on @menu_item. + filename="gio/gmenu.c" + line="803">Queries the named @attribute on @menu_item. If the attribute exists and matches the #GVariantType corresponding to @format_string then @format_string is used to deconstruct the @@ -78831,38 +79429,37 @@ value into the positional parameters and %TRUE is returned. If the attribute does not exist, or it does exist but has the wrong type, then the positional parameters are ignored and %FALSE is returned. - + %TRUE if the named attribute was found with the expected + filename="gio/gmenu.c" + line="820">%TRUE if the named attribute was found with the expected type a #GMenuItem + filename="gio/gmenu.c" + line="805">a #GMenuItem the attribute name to query + filename="gio/gmenu.c" + line="806">the attribute name to query a #GVariant format string + filename="gio/gmenu.c" + line="807">a #GVariant format string positional parameters, as per @format_string + filename="gio/gmenu.c" + line="808">positional parameters, as per @format_string @@ -78871,31 +79468,30 @@ returned. c:identifier="g_menu_item_get_attribute_value" version="2.34"> Queries the named @attribute on @menu_item. + filename="gio/gmenu.c" + line="764">Queries the named @attribute on @menu_item. If @expected_type is specified and the attribute does not have this type, %NULL is returned. %NULL is also returned if the attribute simply does not exist. - + the attribute value, or %NULL + filename="gio/gmenu.c" + line="776">the attribute value, or %NULL a #GMenuItem + filename="gio/gmenu.c" + line="766">a #GMenuItem the attribute name to query + filename="gio/gmenu.c" + line="767">the attribute name to query nullable="1" allow-none="1"> the expected type of the attribute + filename="gio/gmenu.c" + line="768">the expected type of the attribute @@ -78913,27 +79509,26 @@ simply does not exist. c:identifier="g_menu_item_get_link" version="2.34"> Queries the named @link on @menu_item. - + filename="gio/gmenu.c" + line="853">Queries the named @link on @menu_item. + the link, or %NULL + filename="gio/gmenu.c" + line="860">the link, or %NULL a #GMenuItem + filename="gio/gmenu.c" + line="855">a #GMenuItem the link name to query + filename="gio/gmenu.c" + line="856">the link name to query @@ -78943,8 +79538,8 @@ simply does not exist. version="2.32" introspectable="0"> Sets or unsets the "action" and "target" attributes of @menu_item. + filename="gio/gmenu.c" + line="1018">Sets or unsets the "action" and "target" attributes of @menu_item. If @action is %NULL then both the "action" and "target" attributes are unset (and @format_string is ignored along with the positional @@ -78963,16 +79558,15 @@ works with string-typed targets. See also g_menu_item_set_action_and_target_value() for a description of the semantics of the action and target attributes. - + a #GMenuItem + filename="gio/gmenu.c" + line="1020">a #GMenuItem nullable="1" allow-none="1"> the name of the action for this item + filename="gio/gmenu.c" + line="1021">the name of the action for this item nullable="1" allow-none="1"> a GVariant format string + filename="gio/gmenu.c" + line="1022">a GVariant format string positional parameters, as per @format_string + filename="gio/gmenu.c" + line="1023">positional parameters, as per @format_string @@ -79005,8 +79599,8 @@ description of the semantics of the action and target attributes. c:identifier="g_menu_item_set_action_and_target_value" version="2.32"> Sets or unsets the "action" and "target" attributes of @menu_item. + filename="gio/gmenu.c" + line="952">Sets or unsets the "action" and "target" attributes of @menu_item. If @action is %NULL then both the "action" and "target" attributes are unset (and @target_value is ignored). @@ -79042,16 +79636,15 @@ state is equal to the value of the @target property. See g_menu_item_set_action_and_target() or g_menu_item_set_detailed_action() for two equivalent calls that are probably more convenient for most uses. - + a #GMenuItem + filename="gio/gmenu.c" + line="954">a #GMenuItem nullable="1" allow-none="1"> the name of the action for this item + filename="gio/gmenu.c" + line="955">the name of the action for this item nullable="1" allow-none="1"> a #GVariant to use as the action target + filename="gio/gmenu.c" + line="956">a #GVariant to use as the action target @@ -79079,8 +79672,8 @@ probably more convenient for most uses. version="2.32" introspectable="0"> Sets or unsets an attribute on @menu_item. + filename="gio/gmenu.c" + line="679">Sets or unsets an attribute on @menu_item. The attribute to set or unset is specified by @attribute. This can be one of the standard attribute names %G_MENU_ATTRIBUTE_LABEL, @@ -79097,22 +79690,21 @@ and the named attribute is unset. See also g_menu_item_set_attribute_value() for an equivalent call that directly accepts a #GVariant. - + a #GMenuItem + filename="gio/gmenu.c" + line="681">a #GMenuItem the attribute to set + filename="gio/gmenu.c" + line="682">the attribute to set nullable="1" allow-none="1"> a #GVariant format string, or %NULL + filename="gio/gmenu.c" + line="683">a #GVariant format string, or %NULL positional parameters, as per @format_string + filename="gio/gmenu.c" + line="684">positional parameters, as per @format_string @@ -79136,8 +79728,8 @@ that directly accepts a #GVariant. c:identifier="g_menu_item_set_attribute_value" version="2.32"> Sets or unsets an attribute on @menu_item. + filename="gio/gmenu.c" + line="634">Sets or unsets an attribute on @menu_item. The attribute to set or unset is specified by @attribute. This can be one of the standard attribute names %G_MENU_ATTRIBUTE_LABEL, @@ -79156,22 +79748,21 @@ the @value #GVariant is floating, it is consumed. See also g_menu_item_set_attribute() for a more convenient way to do the same. - + a #GMenuItem + filename="gio/gmenu.c" + line="636">a #GMenuItem the attribute to set + filename="gio/gmenu.c" + line="637">the attribute to set nullable="1" allow-none="1"> a #GVariant to use as the value, or %NULL + filename="gio/gmenu.c" + line="638">a #GVariant to use as the value, or %NULL @@ -79189,8 +79780,8 @@ the same. c:identifier="g_menu_item_set_detailed_action" version="2.32"> Sets the "action" and possibly the "target" attribute of @menu_item. + filename="gio/gmenu.c" + line="1069">Sets the "action" and possibly the "target" attribute of @menu_item. The format of @detailed_action is the same format parsed by g_action_parse_detailed_name(). @@ -79201,22 +79792,21 @@ slightly less convenient) alternatives. See also g_menu_item_set_action_and_target_value() for a description of the semantics of the action and target attributes. - + a #GMenuItem + filename="gio/gmenu.c" + line="1071">a #GMenuItem the "detailed" action string + filename="gio/gmenu.c" + line="1072">the "detailed" action string @@ -79225,8 +79815,8 @@ the semantics of the action and target attributes. c:identifier="g_menu_item_set_icon" version="2.38"> Sets (or unsets) the icon on @menu_item. + filename="gio/gmenu.c" + line="1343">Sets (or unsets) the icon on @menu_item. This call is the same as calling g_icon_serialize() and using the result as the value to g_menu_item_set_attribute_value() for @@ -79238,22 +79828,21 @@ menu items corresponding to verbs (eg: stock icons for 'Save' or 'Quit'). If @icon is %NULL then the icon is unset. - + a #GMenuItem + filename="gio/gmenu.c" + line="1345">a #GMenuItem a #GIcon, or %NULL + filename="gio/gmenu.c" + line="1346">a #GIcon, or %NULL @@ -79262,21 +79851,20 @@ If @icon is %NULL then the icon is unset. c:identifier="g_menu_item_set_label" version="2.32"> Sets or unsets the "label" attribute of @menu_item. + filename="gio/gmenu.c" + line="882">Sets or unsets the "label" attribute of @menu_item. If @label is non-%NULL it is used as the label for the menu item. If it is %NULL then the label attribute is unset. - + a #GMenuItem + filename="gio/gmenu.c" + line="884">a #GMenuItem nullable="1" allow-none="1"> the label to set, or %NULL to unset + filename="gio/gmenu.c" + line="885">the label to set, or %NULL to unset @@ -79294,8 +79882,8 @@ it is %NULL then the label attribute is unset. c:identifier="g_menu_item_set_link" version="2.32"> Creates a link from @menu_item to @model if non-%NULL, or unsets it. + filename="gio/gmenu.c" + line="728">Creates a link from @menu_item to @model if non-%NULL, or unsets it. Links are used to establish a relationship between a particular menu item and another menu. For example, %G_MENU_LINK_SUBMENU is used to @@ -79305,22 +79893,21 @@ is no guarantee that clients will be able to make sense of them. Link types are restricted to lowercase characters, numbers and '-'. Furthermore, the names must begin with a lowercase character, must not end with a '-', and must not contain consecutive dashes. - + a #GMenuItem + filename="gio/gmenu.c" + line="730">a #GMenuItem type of link to establish or unset + filename="gio/gmenu.c" + line="731">type of link to establish or unset nullable="1" allow-none="1"> the #GMenuModel to link to (or %NULL to unset) + filename="gio/gmenu.c" + line="732">the #GMenuModel to link to (or %NULL to unset) @@ -79338,24 +79925,23 @@ must not end with a '-', and must not contain consecutive dashes. c:identifier="g_menu_item_set_section" version="2.32"> Sets or unsets the "section" link of @menu_item to @section. + filename="gio/gmenu.c" + line="930">Sets or unsets the "section" link of @menu_item to @section. The effect of having one menu appear as a section of another is exactly as it sounds: the items from @section become a direct part of the menu that @menu_item is added to. See g_menu_item_new_section() for more information about what it means for a menu item to be a section. - + a #GMenuItem + filename="gio/gmenu.c" + line="932">a #GMenuItem nullable="1" allow-none="1"> a #GMenuModel, or %NULL + filename="gio/gmenu.c" + line="933">a #GMenuModel, or %NULL @@ -79373,24 +79959,23 @@ section. c:identifier="g_menu_item_set_submenu" version="2.32"> Sets or unsets the "submenu" link of @menu_item to @submenu. + filename="gio/gmenu.c" + line="908">Sets or unsets the "submenu" link of @menu_item to @submenu. If @submenu is non-%NULL, it is linked to. If it is %NULL then the link is unset. The effect of having one menu appear as a submenu of another is exactly as it sounds. - + a #GMenuItem + filename="gio/gmenu.c" + line="910">a #GMenuItem nullable="1" allow-none="1"> a #GMenuModel, or %NULL + filename="gio/gmenu.c" + line="911">a #GMenuModel, or %NULL @@ -79415,15 +80000,14 @@ exactly as it sounds. glib:get-type="g_menu_link_iter_get_type" glib:type-struct="MenuLinkIterClass"> #GMenuLinkIter is an opaque structure type. You must access it using + filename="gio/gmenumodel.c" + line="159">#GMenuLinkIter is an opaque structure type. You must access it using the functions below. - + This function combines g_menu_link_iter_next() with + filename="gio/gmenumodel.c" + line="855">This function combines g_menu_link_iter_next() with g_menu_link_iter_get_name() and g_menu_link_iter_get_value(). First the iterator is advanced to the next (possibly first) link. @@ -79437,19 +80021,18 @@ same values again. The value returned in @out_link remains valid for as long as the iterator remains at the current position. The value returned in @value must be unreffed using g_object_unref() when it is no longer in use. - + %TRUE on success, or %FALSE if there is no additional link + filename="gio/gmenumodel.c" + line="876">%TRUE on success, or %FALSE if there is no additional link a #GMenuLinkIter + filename="gio/gmenumodel.c" + line="857">a #GMenuLinkIter optional="1" allow-none="1"> the name of the link + filename="gio/gmenumodel.c" + line="858">the name of the link optional="1" allow-none="1"> the linked #GMenuModel + filename="gio/gmenumodel.c" + line="859">the linked #GMenuModel @@ -79480,23 +80063,22 @@ be unreffed using g_object_unref() when it is no longer in use. c:identifier="g_menu_link_iter_get_name" version="2.32"> Gets the name of the link at the current iterator position. + filename="gio/gmenumodel.c" + line="934">Gets the name of the link at the current iterator position. The iterator is not advanced. - + the type of the link + filename="gio/gmenumodel.c" + line="942">the type of the link a #GMenuLinkIter + filename="gio/gmenumodel.c" + line="936">a #GMenuLinkIter @@ -79505,8 +80087,8 @@ The iterator is not advanced. c:identifier="g_menu_link_iter_get_next" version="2.32"> This function combines g_menu_link_iter_next() with + filename="gio/gmenumodel.c" + line="855">This function combines g_menu_link_iter_next() with g_menu_link_iter_get_name() and g_menu_link_iter_get_value(). First the iterator is advanced to the next (possibly first) link. @@ -79520,19 +80102,18 @@ same values again. The value returned in @out_link remains valid for as long as the iterator remains at the current position. The value returned in @value must be unreffed using g_object_unref() when it is no longer in use. - + %TRUE on success, or %FALSE if there is no additional link + filename="gio/gmenumodel.c" + line="876">%TRUE on success, or %FALSE if there is no additional link a #GMenuLinkIter + filename="gio/gmenumodel.c" + line="857">a #GMenuLinkIter optional="1" allow-none="1"> the name of the link + filename="gio/gmenumodel.c" + line="858">the name of the link optional="1" allow-none="1"> the linked #GMenuModel + filename="gio/gmenumodel.c" + line="859">the linked #GMenuModel @@ -79563,31 +80144,30 @@ be unreffed using g_object_unref() when it is no longer in use. c:identifier="g_menu_link_iter_get_value" version="2.32"> Gets the linked #GMenuModel at the current iterator position. + filename="gio/gmenumodel.c" + line="954">Gets the linked #GMenuModel at the current iterator position. The iterator is not advanced. - + the #GMenuModel that is linked to + filename="gio/gmenumodel.c" + line="962">the #GMenuModel that is linked to a #GMenuLinkIter + filename="gio/gmenumodel.c" + line="956">a #GMenuLinkIter Attempts to advance the iterator to the next (possibly first) + filename="gio/gmenumodel.c" + line="911">Attempts to advance the iterator to the next (possibly first) link. %TRUE is returned on success, or %FALSE if there are no more links. @@ -79595,19 +80175,18 @@ link. You must call this function when you first acquire the iterator to advance it to the first link (and determine if the first link exists at all). - + %TRUE on success, or %FALSE when there are no more links + filename="gio/gmenumodel.c" + line="924">%TRUE on success, or %FALSE when there are no more links a #GMenuLinkIter + filename="gio/gmenumodel.c" + line="913">a #GMenuLinkIter @@ -79622,26 +80201,24 @@ at all). - + - + %TRUE on success, or %FALSE if there is no additional link + filename="gio/gmenumodel.c" + line="876">%TRUE on success, or %FALSE if there is no additional link a #GMenuLinkIter + filename="gio/gmenumodel.c" + line="857">a #GMenuLinkIter optional="1" allow-none="1"> the name of the link + filename="gio/gmenumodel.c" + line="858">the name of the link optional="1" allow-none="1"> the linked #GMenuModel + filename="gio/gmenumodel.c" + line="859">the linked #GMenuModel @@ -79674,8 +80251,7 @@ at all). c:type="GMenuLinkIterPrivate" disguised="1" opaque="1"> - + glib:get-type="g_menu_model_get_type" glib:type-struct="MenuModelClass"> #GMenuModel represents the contents of a menu -- an ordered list of + filename="gio/gmenumodel.c" + line="29">`GMenuModel` represents the contents of a menu — an ordered list of menu items. The items are associated with actions, which can be activated through them. Items can be grouped in sections, and may have submenus associated with them. Both items and sections usually @@ -79696,20 +80272,20 @@ have some representation data, such as labels or icons. The type of the associated action (ie whether it is stateful, and what kind of state it has) can influence the representation of the item. -The conceptual model of menus in #GMenuModel is hierarchical: -sections and submenus are again represented by #GMenuModels. +The conceptual model of menus in `GMenuModel` is hierarchical: +sections and submenus are again represented by `GMenuModel`s. Menus themselves do not define their own roles. Rather, the role -of a particular #GMenuModel is defined by the item that references -it (or, in the case of the 'root' menu, is defined by the context +of a particular `GMenuModel` is defined by the item that references +it (or, in the case of the ‘root’ menu, is defined by the context in which it is used). As an example, consider the visible portions of this menu: -## An example menu # {#menu-example} +## An example menu ![](menu-example.png) -There are 8 "menus" visible in the screenshot: one menubar, two +There are 8 ‘menus’ visible in the screenshot: one menubar, two submenus and 5 sections: - the toplevel menubar (containing 4 items) @@ -79721,17 +80297,17 @@ submenus and 5 sections: - the Sources section (containing 2 items) - the Markup section (containing 2 items) -The [example][menu-model] illustrates the conceptual connection between +The [example](#a-menu-example) illustrates the conceptual connection between these 8 menus. Each large block in the figure represents a menu and the smaller blocks within the large block represent items in that menu. Some items contain references to other menus. -## A menu example # {#menu-model} +## A menu example ![](menu-model.png) -Notice that the separators visible in the [example][menu-example] -appear nowhere in the [menu model][menu-model]. This is because +Notice that the separators visible in the [example](#an-example-menu) +appear nowhere in the [menu model](#a-menu-example). This is because separators are not explicitly represented in the menu model. Instead, a separator is inserted between any two non-empty sections of a menu. Section items can have labels just like any other item. In that case, @@ -79740,32 +80316,33 @@ a display system may show a section header instead of a separator. The motivation for this abstract model of application controls is that modern user interfaces tend to make these controls available outside the application. Examples include global menus, jumplists, -dash boards, etc. To support such uses, it is necessary to 'export' +dash boards, etc. To support such uses, it is necessary to ‘export’ information about actions and their representation in menus, which -is exactly what the [GActionGroup exporter][gio-GActionGroup-exporter] -and the [GMenuModel exporter][gio-GMenuModel-exporter] do for -#GActionGroup and #GMenuModel. The client-side counterparts to -make use of the exported information are #GDBusActionGroup and -#GDBusMenuModel. - -The API of #GMenuModel is very generic, with iterators for the -attributes and links of an item, see g_menu_model_iterate_item_attributes() -and g_menu_model_iterate_item_links(). The 'standard' attributes and -link types have predefined names: %G_MENU_ATTRIBUTE_LABEL, -%G_MENU_ATTRIBUTE_ACTION, %G_MENU_ATTRIBUTE_TARGET, %G_MENU_LINK_SECTION -and %G_MENU_LINK_SUBMENU. - -Items in a #GMenuModel represent active controls if they refer to +is exactly what the action group exporter and the menu model exporter do for +[iface@Gio.ActionGroup] and [class@Gio.MenuModel]. The client-side +counterparts to make use of the exported information are +[class@Gio.DBusActionGroup] and [class@Gio.DBusMenuModel]. + +The API of `GMenuModel` is very generic, with iterators for the +attributes and links of an item, see +[method@Gio.MenuModel.iterate_item_attributes] and +[method@Gio.MenuModel.iterate_item_links]. The ‘standard’ attributes and +link types have predefined names: `G_MENU_ATTRIBUTE_LABEL`, +`G_MENU_ATTRIBUTE_ACTION`, `G_MENU_ATTRIBUTE_TARGET`, `G_MENU_LINK_SECTION` +and `G_MENU_LINK_SUBMENU`. + +Items in a `GMenuModel` represent active controls if they refer to an action that can get activated when the user interacts with the -menu item. The reference to the action is encoded by the string id -in the %G_MENU_ATTRIBUTE_ACTION attribute. An action id uniquely +menu item. The reference to the action is encoded by the string ID +in the `G_MENU_ATTRIBUTE_ACTION` attribute. An action ID uniquely identifies an action in an action group. Which action group(s) provide actions depends on the context in which the menu model is used. E.g. when the model is exported as the application menu of a -#GtkApplication, actions can be application-wide or window-specific -(and thus come from two different action groups). By convention, the -application-wide actions have names that start with "app.", while the -names of window-specific actions start with "win.". +[`GtkApplication`](https://docs.gtk.org/gtk4/class.Application.html), +actions can be application-wide or window-specific (and thus come from +two different action groups). By convention, the application-wide actions +have names that start with `app.`, while the names of window-specific +actions start with `win.`. While a wide variety of stateful actions is possible, the following is the minimum that is expected to be supported by all users of exported @@ -79782,12 +80359,12 @@ Selecting such a menu item will activate the action (with no parameter). ## Boolean State -An action with a boolean state will most typically be used with a "toggle" -or "switch" menu item. The state can be set directly, but activating the +An action with a boolean state will most typically be used with a ‘toggle’ +or ‘switch’ menu item. The state can be set directly, but activating the action (with no parameter) results in the state being toggled. Selecting a toggle menu item will activate the action. The menu item should -be rendered as "checked" when the state is true. +be rendered as ‘checked’ when the state is true. ## String Parameter and State @@ -79799,16 +80376,15 @@ equivalent to setting that parameter as the state. Radio menu items, in addition to being associated with the action, will have a target value. Selecting that menu item will result in activation of the action with the target value as the parameter. The menu item should -be rendered as "selected" when the state of the action is equal to the +be rendered as ‘selected’ when the state of the action is equal to the target value of the menu item. - + Queries the item at position @item_index in @model for the attribute + filename="gio/gmenumodel.c" + line="516">Queries the item at position @item_index in @model for the attribute specified by @attribute. If @expected_type is non-%NULL then it specifies the expected type of @@ -79819,31 +80395,30 @@ expected type is unspecified) then the value is returned. If the attribute does not exist, or does not match the expected type then %NULL is returned. - + the value of the attribute + filename="gio/gmenumodel.c" + line="536">the value of the attribute a #GMenuModel + filename="gio/gmenumodel.c" + line="518">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="519">the index of the item the attribute to query + filename="gio/gmenumodel.c" + line="520">the attribute to query nullable="1" allow-none="1"> the expected type of the attribute, or + filename="gio/gmenumodel.c" + line="521">the expected type of the attribute, or %NULL @@ -79860,23 +80435,22 @@ then %NULL is returned. Gets all the attributes associated with the item in the menu model. - + the #GMenuModel to query The #GMenuItem to query @@ -79885,7 +80459,7 @@ then %NULL is returned. caller-allocates="0" transfer-ownership="full"> Attributes on the item @@ -79898,60 +80472,58 @@ then %NULL is returned. invoker="get_item_link" version="2.32"> Queries the item at position @item_index in @model for the link + filename="gio/gmenumodel.c" + line="631">Queries the item at position @item_index in @model for the link specified by @link. If the link exists, the linked #GMenuModel is returned. If the link does not exist, %NULL is returned. - + the linked #GMenuModel, or %NULL + filename="gio/gmenumodel.c" + line="643">the linked #GMenuModel, or %NULL a #GMenuModel + filename="gio/gmenumodel.c" + line="633">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="634">the index of the item the link to query + filename="gio/gmenumodel.c" + line="635">the link to query Gets all the links associated with the item in the menu model. - + the #GMenuModel to query The #GMenuItem to query @@ -79960,7 +80532,7 @@ does not exist, %NULL is returned. caller-allocates="0" transfer-ownership="full"> Links from the item @@ -79971,46 +80543,44 @@ does not exist, %NULL is returned. Query the number of items in @model. - + filename="gio/gmenumodel.c" + line="477">Query the number of items in @model. + the number of items + filename="gio/gmenumodel.c" + line="483">the number of items a #GMenuModel + filename="gio/gmenumodel.c" + line="479">a #GMenuModel Queries if @model is mutable. + filename="gio/gmenumodel.c" + line="456">Queries if @model is mutable. An immutable #GMenuModel will never emit the #GMenuModel::items-changed signal. Consumers of the model may make optimisations accordingly. - + %TRUE if the model is mutable (ie: "items-changed" may be + filename="gio/gmenumodel.c" + line="465">%TRUE if the model is mutable (ie: "items-changed" may be emitted). a #GMenuModel + filename="gio/gmenumodel.c" + line="458">a #GMenuModel @@ -80019,30 +80589,29 @@ signal. Consumers of the model may make optimisations accordingly. invoker="iterate_item_attributes" version="2.32"> Creates a #GMenuAttributeIter to iterate over the attributes of + filename="gio/gmenumodel.c" + line="494">Creates a #GMenuAttributeIter to iterate over the attributes of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. - + a new #GMenuAttributeIter + filename="gio/gmenumodel.c" + line="504">a new #GMenuAttributeIter a #GMenuModel + filename="gio/gmenumodel.c" + line="496">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="497">the index of the item @@ -80051,30 +80620,29 @@ You must free the iterator with g_object_unref() when you are done. invoker="iterate_item_links" version="2.32"> Creates a #GMenuLinkIter to iterate over the links of the item at + filename="gio/gmenumodel.c" + line="609">Creates a #GMenuLinkIter to iterate over the links of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. - + a new #GMenuLinkIter + filename="gio/gmenumodel.c" + line="619">a new #GMenuLinkIter a #GMenuModel + filename="gio/gmenumodel.c" + line="611">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="612">the index of the item @@ -80084,8 +80652,8 @@ You must free the iterator with g_object_unref() when you are done. version="2.32" introspectable="0"> Queries item at position @item_index in @model for the attribute + filename="gio/gmenumodel.c" + line="550">Queries item at position @item_index in @model for the attribute specified by @attribute. If the attribute exists and matches the #GVariantType corresponding @@ -80101,44 +80669,43 @@ g_variant_get(), followed by a g_variant_unref(). As such, @format_string must make a complete copy of the data (since the #GVariant may go away after the call to g_variant_unref()). In particular, no '&' characters are allowed in @format_string. - + %TRUE if the named attribute was found with the expected + filename="gio/gmenumodel.c" + line="575">%TRUE if the named attribute was found with the expected type a #GMenuModel + filename="gio/gmenumodel.c" + line="552">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="553">the index of the item the attribute to query + filename="gio/gmenumodel.c" + line="554">the attribute to query a #GVariant format string + filename="gio/gmenumodel.c" + line="555">a #GVariant format string positional parameters, as per @format_string + filename="gio/gmenumodel.c" + line="556">positional parameters, as per @format_string @@ -80147,8 +80714,8 @@ particular, no '&' characters are allowed in @format_string. c:identifier="g_menu_model_get_item_attribute_value" version="2.32"> Queries the item at position @item_index in @model for the attribute + filename="gio/gmenumodel.c" + line="516">Queries the item at position @item_index in @model for the attribute specified by @attribute. If @expected_type is non-%NULL then it specifies the expected type of @@ -80159,31 +80726,30 @@ expected type is unspecified) then the value is returned. If the attribute does not exist, or does not match the expected type then %NULL is returned. - + the value of the attribute + filename="gio/gmenumodel.c" + line="536">the value of the attribute a #GMenuModel + filename="gio/gmenumodel.c" + line="518">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="519">the index of the item the attribute to query + filename="gio/gmenumodel.c" + line="520">the attribute to query nullable="1" allow-none="1"> the expected type of the attribute, or + filename="gio/gmenumodel.c" + line="521">the expected type of the attribute, or %NULL @@ -80202,37 +80768,36 @@ then %NULL is returned. c:identifier="g_menu_model_get_item_link" version="2.32"> Queries the item at position @item_index in @model for the link + filename="gio/gmenumodel.c" + line="631">Queries the item at position @item_index in @model for the link specified by @link. If the link exists, the linked #GMenuModel is returned. If the link does not exist, %NULL is returned. - + the linked #GMenuModel, or %NULL + filename="gio/gmenumodel.c" + line="643">the linked #GMenuModel, or %NULL a #GMenuModel + filename="gio/gmenumodel.c" + line="633">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="634">the index of the item the link to query + filename="gio/gmenumodel.c" + line="635">the link to query @@ -80241,21 +80806,20 @@ does not exist, %NULL is returned. c:identifier="g_menu_model_get_n_items" version="2.32"> Query the number of items in @model. - + filename="gio/gmenumodel.c" + line="477">Query the number of items in @model. + the number of items + filename="gio/gmenumodel.c" + line="483">the number of items a #GMenuModel + filename="gio/gmenumodel.c" + line="479">a #GMenuModel @@ -80264,25 +80828,24 @@ does not exist, %NULL is returned. c:identifier="g_menu_model_is_mutable" version="2.32"> Queries if @model is mutable. + filename="gio/gmenumodel.c" + line="456">Queries if @model is mutable. An immutable #GMenuModel will never emit the #GMenuModel::items-changed signal. Consumers of the model may make optimisations accordingly. - + %TRUE if the model is mutable (ie: "items-changed" may be + filename="gio/gmenumodel.c" + line="465">%TRUE if the model is mutable (ie: "items-changed" may be emitted). a #GMenuModel + filename="gio/gmenumodel.c" + line="458">a #GMenuModel @@ -80291,8 +80854,8 @@ signal. Consumers of the model may make optimisations accordingly. c:identifier="g_menu_model_items_changed" version="2.32"> Requests emission of the #GMenuModel::items-changed signal on @model. + filename="gio/gmenumodel.c" + line="656">Requests emission of the #GMenuModel::items-changed signal on @model. This function should never be called except by #GMenuModel subclasses. Any other calls to this function will very likely lead @@ -80307,34 +80870,33 @@ The implementation must dispatch this call directly from a mainloop entry and not in response to calls -- particularly those from the #GMenuModel API. Said another way: the menu must not change while user code is running without returning to the mainloop. - + a #GMenuModel + filename="gio/gmenumodel.c" + line="658">a #GMenuModel the position of the change + filename="gio/gmenumodel.c" + line="659">the position of the change the number of items removed + filename="gio/gmenumodel.c" + line="660">the number of items removed the number of items added + filename="gio/gmenumodel.c" + line="661">the number of items added @@ -80343,30 +80905,29 @@ user code is running without returning to the mainloop. c:identifier="g_menu_model_iterate_item_attributes" version="2.32"> Creates a #GMenuAttributeIter to iterate over the attributes of + filename="gio/gmenumodel.c" + line="494">Creates a #GMenuAttributeIter to iterate over the attributes of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. - + a new #GMenuAttributeIter + filename="gio/gmenumodel.c" + line="504">a new #GMenuAttributeIter a #GMenuModel + filename="gio/gmenumodel.c" + line="496">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="497">the index of the item @@ -80375,30 +80936,29 @@ You must free the iterator with g_object_unref() when you are done. c:identifier="g_menu_model_iterate_item_links" version="2.32"> Creates a #GMenuLinkIter to iterate over the links of the item at + filename="gio/gmenumodel.c" + line="609">Creates a #GMenuLinkIter to iterate over the links of the item at position @item_index in @model. You must free the iterator with g_object_unref() when you are done. - + a new #GMenuLinkIter + filename="gio/gmenumodel.c" + line="619">a new #GMenuLinkIter a #GMenuModel + filename="gio/gmenumodel.c" + line="611">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="612">the index of the item @@ -80411,8 +80971,8 @@ You must free the iterator with g_object_unref() when you are done. Emitted when a change has occurred to the menu. + filename="gio/gmenumodel.c" + line="417">Emitted when a change has occurred to the menu. The only changes that can occur to a menu is that items are removed or added. Items may not change (except by being removed and added @@ -80438,20 +80998,20 @@ reported. The signal is emitted after the modification. the position of the change + filename="gio/gmenumodel.c" + line="420">the position of the change the number of items removed + filename="gio/gmenumodel.c" + line="421">the number of items removed the number of items added + filename="gio/gmenumodel.c" + line="422">the number of items added @@ -80460,27 +81020,25 @@ reported. The signal is emitted after the modification. - + - + %TRUE if the model is mutable (ie: "items-changed" may be + filename="gio/gmenumodel.c" + line="465">%TRUE if the model is mutable (ie: "items-changed" may be emitted). a #GMenuModel + filename="gio/gmenumodel.c" + line="458">a #GMenuModel @@ -80488,19 +81046,18 @@ reported. The signal is emitted after the modification. - + the number of items + filename="gio/gmenumodel.c" + line="483">the number of items a #GMenuModel + filename="gio/gmenumodel.c" + line="479">a #GMenuModel @@ -80508,21 +81065,20 @@ reported. The signal is emitted after the modification. - + the #GMenuModel to query The #GMenuItem to query @@ -80531,7 +81087,7 @@ reported. The signal is emitted after the modification. caller-allocates="0" transfer-ownership="full"> Attributes on the item @@ -80543,25 +81099,24 @@ reported. The signal is emitted after the modification. - + a new #GMenuAttributeIter + filename="gio/gmenumodel.c" + line="504">a new #GMenuAttributeIter a #GMenuModel + filename="gio/gmenumodel.c" + line="496">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="497">the index of the item @@ -80569,31 +81124,30 @@ reported. The signal is emitted after the modification. - + the value of the attribute + filename="gio/gmenumodel.c" + line="536">the value of the attribute a #GMenuModel + filename="gio/gmenumodel.c" + line="518">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="519">the index of the item the attribute to query + filename="gio/gmenumodel.c" + line="520">the attribute to query nullable="1" allow-none="1"> the expected type of the attribute, or + filename="gio/gmenumodel.c" + line="521">the expected type of the attribute, or %NULL @@ -80611,21 +81165,20 @@ reported. The signal is emitted after the modification. - + the #GMenuModel to query The #GMenuItem to query @@ -80634,7 +81187,7 @@ reported. The signal is emitted after the modification. caller-allocates="0" transfer-ownership="full"> Links from the item @@ -80646,25 +81199,24 @@ reported. The signal is emitted after the modification. - + a new #GMenuLinkIter + filename="gio/gmenumodel.c" + line="619">a new #GMenuLinkIter a #GMenuModel + filename="gio/gmenumodel.c" + line="611">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="612">the index of the item @@ -80672,31 +81224,30 @@ reported. The signal is emitted after the modification. - + the linked #GMenuModel, or %NULL + filename="gio/gmenumodel.c" + line="643">the linked #GMenuModel, or %NULL a #GMenuModel + filename="gio/gmenumodel.c" + line="633">a #GMenuModel the index of the item + filename="gio/gmenumodel.c" + line="634">the index of the item the link to query + filename="gio/gmenumodel.c" + line="635">the link to query @@ -80707,8 +81258,7 @@ reported. The signal is emitted after the modification. c:type="GMenuModelPrivate" disguised="1" opaque="1"> - + glib:get-type="g_mount_get_type" glib:type-struct="MountIface"> The #GMount interface represents user-visible mounts. Note, when -porting from GnomeVFS, #GMount is the moral equivalent of #GnomeVFSVolume. + filename="gio/gmount.c" + line="39">The `GMount` interface represents user-visible mounts. Note, when +[porting from GnomeVFS](migrating-gnome-vfs.html), `GMount` is the moral +equivalent of `GnomeVFSVolume`. -#GMount is a "mounted" filesystem that you can access. Mounted is in -quotes because it's not the same as a unix mount, it might be a gvfs +`GMount` is a ‘mounted’ filesystem that you can access. Mounted is in +quotes because it’s not the same as a UNIX mount, it might be a GVFS mount, but you can still access the files on it if you use GIO. Might or might not be related to a volume object. -Unmounting a #GMount instance is an asynchronous operation. For -more information about asynchronous operations, see #GAsyncResult -and #GTask. To unmount a #GMount instance, first call -g_mount_unmount_with_operation() with (at least) the #GMount instance and a -#GAsyncReadyCallback. The callback will be fired when the -operation has resolved (either with success or failure), and a -#GAsyncResult structure will be passed to the callback. That -callback should then call g_mount_unmount_with_operation_finish() with the #GMount -and the #GAsyncResult data to see if the operation was completed -successfully. If an @error is present when g_mount_unmount_with_operation_finish() -is called, then it will be filled with any error information. - +Unmounting a `GMount` instance is an asynchronous operation. For +more information about asynchronous operations, see [iface@Gio.AsyncResult] +and [class@Gio.Task]. To unmount a `GMount` instance, first call +[method@Gio.Mount.unmount_with_operation] with (at least) the `GMount` +instance and a [type@Gio.AsyncReadyCallback]. The callback will be fired +when the operation has resolved (either with success or failure), and a +[iface@Gio.AsyncResult] structure will be passed to the callback. That +callback should then call [method@Gio.Mount.unmount_with_operation_finish] +with the `GMount` and the [iface@Gio.AsyncResult] data to see if the +operation was completed successfully. If an `error` is present when +[method@Gio.Mount.unmount_with_operation_finish] is called, then it will be +filled with any error information. + Checks if @mount can be ejected. - + filename="gio/gmount.c" + line="345">Checks if @mount can be ejected. + %TRUE if the @mount can be ejected. + filename="gio/gmount.c" + line="351">%TRUE if the @mount can be ejected. a #GMount. + filename="gio/gmount.c" + line="347">a #GMount. Checks if @mount can be unmounted. - + filename="gio/gmount.c" + line="325">Checks if @mount can be unmounted. + %TRUE if the @mount can be unmounted. + filename="gio/gmount.c" + line="331">%TRUE if the @mount can be unmounted. a #GMount. + filename="gio/gmount.c" + line="327">a #GMount. - + Changed signal that is emitted when the mount's state has changed. + @@ -80796,29 +81347,29 @@ is called, then it will be filled with any error information. + deprecated-version="2.22" + glib:finish-func="eject_finish"> Ejects a mount. This is an asynchronous operation, and is + filename="gio/gmount.c" + line="441">Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_eject_with_operation() instead. - + a #GMount. + filename="gio/gmount.c" + line="443">a #GMount. flags affecting the unmount if required for eject + filename="gio/gmount.c" + line="444">flags affecting the unmount if required for eject nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="445">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="446">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="3"> user data passed to @callback. + filename="gio/gmount.c" + line="447">user data passed to @callback. @@ -80859,57 +81410,56 @@ and #GAsyncResult data returned in the @callback. deprecated-version="2.22" throws="1"> Finishes ejecting a mount. If any errors occurred during the operation, + filename="gio/gmount.c" + line="483">Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_eject_with_operation_finish() instead. - + %TRUE if the mount was successfully ejected. %FALSE otherwise. + filename="gio/gmount.c" + line="493">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="485">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="486">a #GAsyncResult. + version="2.22" + glib:finish-func="eject_with_operation_finish"> Ejects a mount. This is an asynchronous operation, and is + filename="gio/gmount.c" + line="601">Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. - + a #GMount. + filename="gio/gmount.c" + line="603">a #GMount. flags affecting the unmount if required for eject + filename="gio/gmount.c" + line="604">flags affecting the unmount if required for eject nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gmount.c" + line="605">a #GMountOperation or %NULL to avoid user interaction. @@ -80927,8 +81477,8 @@ and #GAsyncResult data returned in the @callback. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="607">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="608">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="4"> user data passed to @callback. + filename="gio/gmount.c" + line="609">user data passed to @callback. @@ -80959,28 +81509,27 @@ and #GAsyncResult data returned in the @callback. version="2.22" throws="1"> Finishes ejecting a mount. If any errors occurred during the operation, + filename="gio/gmount.c" + line="649">Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + %TRUE if the mount was successfully ejected. %FALSE otherwise. + filename="gio/gmount.c" + line="659">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="651">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="652">a #GAsyncResult. @@ -80988,16 +81537,15 @@ and #GAsyncResult data returned in the @callback. Gets the default location of @mount. The default location of the given + filename="gio/gmount.c" + line="144">Gets the default location of @mount. The default location of the given @mount is a path that reflects the main entry point for the user (e.g. the home directory, or the root of the volume). - + a #GFile. + filename="gio/gmount.c" + line="152">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -81005,25 +81553,24 @@ the home directory, or the root of the volume). a #GMount. + filename="gio/gmount.c" + line="146">a #GMount. Gets the drive for the @mount. + filename="gio/gmount.c" + line="299">Gets the drive for the @mount. This is a convenience method for getting the #GVolume and then using that object to get the #GDrive. - + a #GDrive or %NULL if @mount is not + filename="gio/gmount.c" + line="308">a #GDrive or %NULL if @mount is not associated with a volume or a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -81032,22 +81579,21 @@ using that object to get the #GDrive. a #GMount. + filename="gio/gmount.c" + line="301">a #GMount. Gets the icon for @mount. - + filename="gio/gmount.c" + line="197">Gets the icon for @mount. + a #GIcon. + filename="gio/gmount.c" + line="203">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -81055,22 +81601,21 @@ using that object to get the #GDrive. a #GMount. + filename="gio/gmount.c" + line="199">a #GMount. Gets the name of @mount. - + filename="gio/gmount.c" + line="175">Gets the name of @mount. + the name for the given @mount. + filename="gio/gmount.c" + line="181">the name for the given @mount. The returned string should be freed with g_free() when no longer needed. @@ -81078,22 +81623,21 @@ using that object to get the #GDrive. a #GMount. + filename="gio/gmount.c" + line="177">a #GMount. Gets the root directory on @mount. - + filename="gio/gmount.c" + line="122">Gets the root directory on @mount. + a #GFile. + filename="gio/gmount.c" + line="128">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -81101,8 +81645,8 @@ using that object to get the #GDrive. a #GMount. + filename="gio/gmount.c" + line="124">a #GMount. @@ -81111,21 +81655,20 @@ using that object to get the #GDrive. invoker="get_sort_key" version="2.32"> Gets the sort key for @mount, if any. - + filename="gio/gmount.c" + line="1038">Gets the sort key for @mount, if any. + Sorting key for @mount or %NULL if no such key is available. + filename="gio/gmount.c" + line="1044">Sorting key for @mount or %NULL if no such key is available. A #GMount. + filename="gio/gmount.c" + line="1040">A #GMount. @@ -81134,14 +81677,13 @@ using that object to get the #GDrive. invoker="get_symbolic_icon" version="2.34"> Gets the symbolic icon for @mount. - + filename="gio/gmount.c" + line="220">Gets the symbolic icon for @mount. + a #GIcon. + filename="gio/gmount.c" + line="226">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -81149,25 +81691,24 @@ using that object to get the #GDrive. a #GMount. + filename="gio/gmount.c" + line="222">a #GMount. Gets the UUID for the @mount. The reference is typically based on + filename="gio/gmount.c" + line="250">Gets the UUID for the @mount. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available. - + the UUID for @mount or %NULL if no UUID + filename="gio/gmount.c" + line="259">the UUID for @mount or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -81176,22 +81717,21 @@ available. a #GMount. + filename="gio/gmount.c" + line="252">a #GMount. Gets the volume for the @mount. - + filename="gio/gmount.c" + line="276">Gets the volume for the @mount. + a #GVolume or %NULL if @mount is not + filename="gio/gmount.c" + line="282">a #GVolume or %NULL if @mount is not associated with a volume. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -81200,18 +81740,20 @@ available. a #GMount. + filename="gio/gmount.c" + line="278">a #GMount. + version="2.18" + glib:finish-func="guess_content_type_finish" + glib:sync-func="guess_content_type_sync"> Tries to guess the type of content stored on @mount. Returns one or + filename="gio/gmount.c" + line="765">Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -81222,22 +81764,21 @@ This is an asynchronous operation (see g_mount_guess_content_type_sync() for the synchronous version), and is finished by calling g_mount_guess_content_type_finish() with the @mount and #GAsyncResult data returned in the @callback. - + a #GMount + filename="gio/gmount.c" + line="767">a #GMount Whether to force a rescan of the content. + filename="gio/gmount.c" + line="768">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -81246,8 +81787,8 @@ is finished by calling g_mount_guess_content_type_finish() with the nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gmount.c" + line="770">optional #GCancellable object, %NULL to ignore a #GAsyncReadyCallback + filename="gio/gmount.c" + line="771">a #GAsyncReadyCallback user data passed to @callback + filename="gio/gmount.c" + line="772">user data passed to @callback @@ -81278,18 +81819,17 @@ is finished by calling g_mount_guess_content_type_finish() with the version="2.18" throws="1"> Finishes guessing content types of @mount. If any errors occurred + filename="gio/gmount.c" + line="816">Finishes guessing content types of @mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. In particular, you may get an %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content guessing. - + a %NULL-terminated array of content types or %NULL on error. + filename="gio/gmount.c" + line="829">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -81298,14 +81838,14 @@ guessing. a #GMount + filename="gio/gmount.c" + line="818">a #GMount a #GAsyncResult + filename="gio/gmount.c" + line="819">a #GAsyncResult @@ -81313,10 +81853,11 @@ guessing. + throws="1" + glib:async-func="guess_content_type"> Tries to guess the type of content stored on @mount. Returns one or + filename="gio/gmount.c" + line="853">Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -81325,12 +81866,11 @@ specification for more on x-content types. This is a synchronous operation and as such may block doing IO; see g_mount_guess_content_type() for the asynchronous version. - + a %NULL-terminated array of content types or %NULL on error. + filename="gio/gmount.c" + line="872">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -81339,14 +81879,14 @@ see g_mount_guess_content_type() for the asynchronous version. a #GMount + filename="gio/gmount.c" + line="855">a #GMount Whether to force a rescan of the content. + filename="gio/gmount.c" + line="856">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -81355,15 +81895,17 @@ see g_mount_guess_content_type() for the asynchronous version. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gmount.c" + line="858">optional #GCancellable object, %NULL to ignore - + The ::pre-unmount signal that is emitted when the #GMount will soon be emitted. If the recipient is somehow holding the mount open by keeping an open file on it it should close the file. + @@ -81373,10 +81915,12 @@ see g_mount_guess_content_type() for the asynchronous version. - + Remounts a mount. This is an asynchronous operation, and is + filename="gio/gmount.c" + line="685">Remounts a mount. This is an asynchronous operation, and is finished by calling g_mount_remount_finish() with the @mount and #GAsyncResults data returned in the @callback. @@ -81385,22 +81929,21 @@ of the volume has been changed, as these may need a remount to take affect. While this is semantically equivalent with unmounting and then remounting not all backends might need to actually be unmounted. - + a #GMount. + filename="gio/gmount.c" + line="687">a #GMount. flags affecting the operation + filename="gio/gmount.c" + line="688">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gmount.c" + line="689">a #GMountOperation or %NULL to avoid user interaction. @@ -81418,8 +81961,8 @@ unmounted. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="691">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="692">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="4"> user data passed to @callback. + filename="gio/gmount.c" + line="693">user data passed to @callback. @@ -81449,28 +81992,27 @@ unmounted. invoker="remount_finish" throws="1"> Finishes remounting a mount. If any errors occurred during the operation, + filename="gio/gmount.c" + line="734">Finishes remounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + %TRUE if the mount was successfully remounted. %FALSE otherwise. + filename="gio/gmount.c" + line="744">%TRUE if the mount was successfully remounted. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="736">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="737">a #GAsyncResult. @@ -81478,29 +82020,29 @@ unmounted. + deprecated-version="2.22" + glib:finish-func="unmount_finish"> Unmounts a mount. This is an asynchronous operation, and is + filename="gio/gmount.c" + line="365">Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_unmount_with_operation() instead. - + a #GMount. + filename="gio/gmount.c" + line="367">a #GMount. flags affecting the operation + filename="gio/gmount.c" + line="368">flags affecting the operation nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="369">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="370">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="3"> user data passed to @callback. + filename="gio/gmount.c" + line="371">user data passed to @callback. @@ -81541,57 +82083,56 @@ and #GAsyncResult data returned in the @callback. deprecated-version="2.22" throws="1"> Finishes unmounting a mount. If any errors occurred during the operation, + filename="gio/gmount.c" + line="407">Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_unmount_with_operation_finish() instead. - + %TRUE if the mount was successfully unmounted. %FALSE otherwise. + filename="gio/gmount.c" + line="417">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="409">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="410">a #GAsyncResult. + version="2.22" + glib:finish-func="unmount_with_operation_finish"> Unmounts a mount. This is an asynchronous operation, and is + filename="gio/gmount.c" + line="516">Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. - + a #GMount. + filename="gio/gmount.c" + line="518">a #GMount. flags affecting the operation + filename="gio/gmount.c" + line="519">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gmount.c" + line="520">a #GMountOperation or %NULL to avoid user interaction. @@ -81609,8 +82150,8 @@ and #GAsyncResult data returned in the @callback. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="522">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="523">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="4"> user data passed to @callback. + filename="gio/gmount.c" + line="524">user data passed to @callback. @@ -81641,35 +82182,36 @@ and #GAsyncResult data returned in the @callback. version="2.22" throws="1"> Finishes unmounting a mount. If any errors occurred during the operation, + filename="gio/gmount.c" + line="564">Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + %TRUE if the mount was successfully unmounted. %FALSE otherwise. + filename="gio/gmount.c" + line="574">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="566">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="567">a #GAsyncResult. - + The unmounted signal that is emitted when the #GMount have been unmounted. If the recipient is holding references to the object they should release them so the object can be finalized. + @@ -81681,42 +82223,40 @@ and #GAsyncResult data returned in the @callback. Checks if @mount can be ejected. - + filename="gio/gmount.c" + line="345">Checks if @mount can be ejected. + %TRUE if the @mount can be ejected. + filename="gio/gmount.c" + line="351">%TRUE if the @mount can be ejected. a #GMount. + filename="gio/gmount.c" + line="347">a #GMount. Checks if @mount can be unmounted. - + filename="gio/gmount.c" + line="325">Checks if @mount can be unmounted. + %TRUE if the @mount can be unmounted. + filename="gio/gmount.c" + line="331">%TRUE if the @mount can be unmounted. a #GMount. + filename="gio/gmount.c" + line="327">a #GMount. @@ -81724,29 +82264,29 @@ and #GAsyncResult data returned in the @callback. + deprecated-version="2.22" + glib:finish-func="eject_finish"> Ejects a mount. This is an asynchronous operation, and is + filename="gio/gmount.c" + line="441">Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_eject_with_operation() instead. - + a #GMount. + filename="gio/gmount.c" + line="443">a #GMount. flags affecting the unmount if required for eject + filename="gio/gmount.c" + line="444">flags affecting the unmount if required for eject nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="445">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="446">a #GAsyncReadyCallback, or %NULL. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gmount.c" + line="447">user data passed to @callback. @@ -81786,57 +82326,56 @@ and #GAsyncResult data returned in the @callback. deprecated-version="2.22" throws="1"> Finishes ejecting a mount. If any errors occurred during the operation, + filename="gio/gmount.c" + line="483">Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_eject_with_operation_finish() instead. - + %TRUE if the mount was successfully ejected. %FALSE otherwise. + filename="gio/gmount.c" + line="493">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="485">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="486">a #GAsyncResult. + version="2.22" + glib:finish-func="eject_with_operation_finish"> Ejects a mount. This is an asynchronous operation, and is + filename="gio/gmount.c" + line="601">Ejects a mount. This is an asynchronous operation, and is finished by calling g_mount_eject_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. - + a #GMount. + filename="gio/gmount.c" + line="603">a #GMount. flags affecting the unmount if required for eject + filename="gio/gmount.c" + line="604">flags affecting the unmount if required for eject nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gmount.c" + line="605">a #GMountOperation or %NULL to avoid user interaction. @@ -81854,8 +82393,8 @@ and #GAsyncResult data returned in the @callback. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="607">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="608">a #GAsyncReadyCallback, or %NULL. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gmount.c" + line="609">user data passed to @callback. @@ -81885,28 +82424,27 @@ and #GAsyncResult data returned in the @callback. version="2.22" throws="1"> Finishes ejecting a mount. If any errors occurred during the operation, + filename="gio/gmount.c" + line="649">Finishes ejecting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + %TRUE if the mount was successfully ejected. %FALSE otherwise. + filename="gio/gmount.c" + line="659">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="651">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="652">a #GAsyncResult. @@ -81914,16 +82452,15 @@ and #GAsyncResult data returned in the @callback. Gets the default location of @mount. The default location of the given + filename="gio/gmount.c" + line="144">Gets the default location of @mount. The default location of the given @mount is a path that reflects the main entry point for the user (e.g. the home directory, or the root of the volume). - + a #GFile. + filename="gio/gmount.c" + line="152">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -81931,25 +82468,24 @@ the home directory, or the root of the volume). a #GMount. + filename="gio/gmount.c" + line="146">a #GMount. Gets the drive for the @mount. + filename="gio/gmount.c" + line="299">Gets the drive for the @mount. This is a convenience method for getting the #GVolume and then using that object to get the #GDrive. - + a #GDrive or %NULL if @mount is not + filename="gio/gmount.c" + line="308">a #GDrive or %NULL if @mount is not associated with a volume or a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -81958,22 +82494,21 @@ using that object to get the #GDrive. a #GMount. + filename="gio/gmount.c" + line="301">a #GMount. Gets the icon for @mount. - + filename="gio/gmount.c" + line="197">Gets the icon for @mount. + a #GIcon. + filename="gio/gmount.c" + line="203">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -81981,22 +82516,21 @@ using that object to get the #GDrive. a #GMount. + filename="gio/gmount.c" + line="199">a #GMount. Gets the name of @mount. - + filename="gio/gmount.c" + line="175">Gets the name of @mount. + the name for the given @mount. + filename="gio/gmount.c" + line="181">the name for the given @mount. The returned string should be freed with g_free() when no longer needed. @@ -82004,22 +82538,21 @@ using that object to get the #GDrive. a #GMount. + filename="gio/gmount.c" + line="177">a #GMount. Gets the root directory on @mount. - + filename="gio/gmount.c" + line="122">Gets the root directory on @mount. + a #GFile. + filename="gio/gmount.c" + line="128">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -82027,8 +82560,8 @@ using that object to get the #GDrive. a #GMount. + filename="gio/gmount.c" + line="124">a #GMount. @@ -82037,21 +82570,20 @@ using that object to get the #GDrive. c:identifier="g_mount_get_sort_key" version="2.32"> Gets the sort key for @mount, if any. - + filename="gio/gmount.c" + line="1038">Gets the sort key for @mount, if any. + Sorting key for @mount or %NULL if no such key is available. + filename="gio/gmount.c" + line="1044">Sorting key for @mount or %NULL if no such key is available. A #GMount. + filename="gio/gmount.c" + line="1040">A #GMount. @@ -82060,14 +82592,13 @@ using that object to get the #GDrive. c:identifier="g_mount_get_symbolic_icon" version="2.34"> Gets the symbolic icon for @mount. - + filename="gio/gmount.c" + line="220">Gets the symbolic icon for @mount. + a #GIcon. + filename="gio/gmount.c" + line="226">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -82075,25 +82606,24 @@ using that object to get the #GDrive. a #GMount. + filename="gio/gmount.c" + line="222">a #GMount. Gets the UUID for the @mount. The reference is typically based on + filename="gio/gmount.c" + line="250">Gets the UUID for the @mount. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available. - + the UUID for @mount or %NULL if no UUID + filename="gio/gmount.c" + line="259">the UUID for @mount or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -82102,22 +82632,21 @@ available. a #GMount. + filename="gio/gmount.c" + line="252">a #GMount. Gets the volume for the @mount. - + filename="gio/gmount.c" + line="276">Gets the volume for the @mount. + a #GVolume or %NULL if @mount is not + filename="gio/gmount.c" + line="282">a #GVolume or %NULL if @mount is not associated with a volume. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -82126,18 +82655,20 @@ available. a #GMount. + filename="gio/gmount.c" + line="278">a #GMount. + version="2.18" + glib:finish-func="guess_content_type_finish" + glib:sync-func="guess_content_type_sync"> Tries to guess the type of content stored on @mount. Returns one or + filename="gio/gmount.c" + line="765">Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -82148,22 +82679,21 @@ This is an asynchronous operation (see g_mount_guess_content_type_sync() for the synchronous version), and is finished by calling g_mount_guess_content_type_finish() with the @mount and #GAsyncResult data returned in the @callback. - + a #GMount + filename="gio/gmount.c" + line="767">a #GMount Whether to force a rescan of the content. + filename="gio/gmount.c" + line="768">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -82172,8 +82702,8 @@ is finished by calling g_mount_guess_content_type_finish() with the nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gmount.c" + line="770">optional #GCancellable object, %NULL to ignore a #GAsyncReadyCallback + filename="gio/gmount.c" + line="771">a #GAsyncReadyCallback user data passed to @callback + filename="gio/gmount.c" + line="772">user data passed to @callback @@ -82203,18 +82733,17 @@ is finished by calling g_mount_guess_content_type_finish() with the version="2.18" throws="1"> Finishes guessing content types of @mount. If any errors occurred + filename="gio/gmount.c" + line="816">Finishes guessing content types of @mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. In particular, you may get an %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content guessing. - + a %NULL-terminated array of content types or %NULL on error. + filename="gio/gmount.c" + line="829">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -82223,14 +82752,14 @@ guessing. a #GMount + filename="gio/gmount.c" + line="818">a #GMount a #GAsyncResult + filename="gio/gmount.c" + line="819">a #GAsyncResult @@ -82238,10 +82767,11 @@ guessing. + throws="1" + glib:async-func="guess_content_type"> Tries to guess the type of content stored on @mount. Returns one or + filename="gio/gmount.c" + line="853">Tries to guess the type of content stored on @mount. Returns one or more textual identifiers of well-known content types (typically prefixed with "x-content/"), e.g. x-content/image-dcf for camera memory cards. See the @@ -82250,12 +82780,11 @@ specification for more on x-content types. This is a synchronous operation and as such may block doing IO; see g_mount_guess_content_type() for the asynchronous version. - + a %NULL-terminated array of content types or %NULL on error. + filename="gio/gmount.c" + line="872">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -82264,14 +82793,14 @@ see g_mount_guess_content_type() for the asynchronous version. a #GMount + filename="gio/gmount.c" + line="855">a #GMount Whether to force a rescan of the content. + filename="gio/gmount.c" + line="856">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -82280,8 +82809,8 @@ see g_mount_guess_content_type() for the asynchronous version. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gmount.c" + line="858">optional #GCancellable object, %NULL to ignore @@ -82290,8 +82819,8 @@ see g_mount_guess_content_type() for the asynchronous version. c:identifier="g_mount_is_shadowed" version="2.20"> Determines if @mount is shadowed. Applications or libraries should + filename="gio/gmount.c" + line="940">Determines if @mount is shadowed. Applications or libraries should avoid displaying @mount in the user interface if it is shadowed. A mount is said to be shadowed if there exists one or more user @@ -82314,27 +82843,28 @@ root) that would shadow the original mount. The proxy monitor in GVfs 2.26 and later, automatically creates and manage shadow mounts (and shadows the underlying mount) if the activation root on a #GVolume is set. - + %TRUE if @mount is shadowed. + filename="gio/gmount.c" + line="968">%TRUE if @mount is shadowed. A #GMount. + filename="gio/gmount.c" + line="942">A #GMount. - + Remounts a mount. This is an asynchronous operation, and is + filename="gio/gmount.c" + line="685">Remounts a mount. This is an asynchronous operation, and is finished by calling g_mount_remount_finish() with the @mount and #GAsyncResults data returned in the @callback. @@ -82343,22 +82873,21 @@ of the volume has been changed, as these may need a remount to take affect. While this is semantically equivalent with unmounting and then remounting not all backends might need to actually be unmounted. - + a #GMount. + filename="gio/gmount.c" + line="687">a #GMount. flags affecting the operation + filename="gio/gmount.c" + line="688">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gmount.c" + line="689">a #GMountOperation or %NULL to avoid user interaction. @@ -82376,8 +82905,8 @@ unmounted. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="691">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="692">a #GAsyncReadyCallback, or %NULL. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gmount.c" + line="693">user data passed to @callback. @@ -82406,49 +82935,47 @@ unmounted. c:identifier="g_mount_remount_finish" throws="1"> Finishes remounting a mount. If any errors occurred during the operation, + filename="gio/gmount.c" + line="734">Finishes remounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + %TRUE if the mount was successfully remounted. %FALSE otherwise. + filename="gio/gmount.c" + line="744">%TRUE if the mount was successfully remounted. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="736">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="737">a #GAsyncResult. Increments the shadow count on @mount. Usually used by + filename="gio/gmount.c" + line="988">Increments the shadow count on @mount. Usually used by #GVolumeMonitor implementations when creating a shadow mount for @mount, see g_mount_is_shadowed() for more information. The caller will need to emit the #GMount::changed signal on @mount manually. - + A #GMount. + filename="gio/gmount.c" + line="990">A #GMount. @@ -82456,29 +82983,29 @@ will need to emit the #GMount::changed signal on @mount manually. + deprecated-version="2.22" + glib:finish-func="unmount_finish"> Unmounts a mount. This is an asynchronous operation, and is + filename="gio/gmount.c" + line="365">Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_finish() with the @mount and #GAsyncResult data returned in the @callback. Use g_mount_unmount_with_operation() instead. - + a #GMount. + filename="gio/gmount.c" + line="367">a #GMount. flags affecting the operation + filename="gio/gmount.c" + line="368">flags affecting the operation nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="369">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="370">a #GAsyncReadyCallback, or %NULL. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gmount.c" + line="371">user data passed to @callback. @@ -82518,57 +83045,56 @@ and #GAsyncResult data returned in the @callback. deprecated-version="2.22" throws="1"> Finishes unmounting a mount. If any errors occurred during the operation, + filename="gio/gmount.c" + line="407">Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_mount_unmount_with_operation_finish() instead. - + %TRUE if the mount was successfully unmounted. %FALSE otherwise. + filename="gio/gmount.c" + line="417">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="409">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="410">a #GAsyncResult. + version="2.22" + glib:finish-func="unmount_with_operation_finish"> Unmounts a mount. This is an asynchronous operation, and is + filename="gio/gmount.c" + line="516">Unmounts a mount. This is an asynchronous operation, and is finished by calling g_mount_unmount_with_operation_finish() with the @mount and #GAsyncResult data returned in the @callback. - + a #GMount. + filename="gio/gmount.c" + line="518">a #GMount. flags affecting the operation + filename="gio/gmount.c" + line="519">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gmount.c" + line="520">a #GMountOperation or %NULL to avoid user interaction. @@ -82586,8 +83112,8 @@ and #GAsyncResult data returned in the @callback. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="522">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="523">a #GAsyncReadyCallback, or %NULL. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gmount.c" + line="524">user data passed to @callback. @@ -82617,65 +83143,63 @@ and #GAsyncResult data returned in the @callback. version="2.22" throws="1"> Finishes unmounting a mount. If any errors occurred during the operation, + filename="gio/gmount.c" + line="564">Finishes unmounting a mount. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + %TRUE if the mount was successfully unmounted. %FALSE otherwise. + filename="gio/gmount.c" + line="574">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="566">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="567">a #GAsyncResult. Decrements the shadow count on @mount. Usually used by + filename="gio/gmount.c" + line="1012">Decrements the shadow count on @mount. Usually used by #GVolumeMonitor implementations when destroying a shadow mount for @mount, see g_mount_is_shadowed() for more information. The caller will need to emit the #GMount::changed signal on @mount manually. - + A #GMount. + filename="gio/gmount.c" + line="1014">A #GMount. Emitted when the mount has been changed. + filename="gio/gmount.c" + line="71">Emitted when the mount has been changed. This signal may be emitted when the #GMount is about to be + filename="gio/gmount.c" + line="101">This signal may be emitted when the #GMount is about to be unmounted. This signal depends on the backend and is only emitted if @@ -82686,8 +83210,8 @@ GIO was used to unmount. This signal is emitted when the #GMount have been + filename="gio/gmount.c" + line="85">This signal is emitted when the #GMount have been unmounted. If the recipient is holding references to the object they should release them so the object can be finalized. @@ -82700,20 +83224,21 @@ finalized. c:type="GMountIface" glib:is-gtype-struct-for="Mount"> Interface for implementing operations for mounts. - + The parent interface. + Changed signal that is emitted when the mount's state has changed. - + @@ -82725,9 +83250,11 @@ finalized. + The unmounted signal that is emitted when the #GMount have been unmounted. If the recipient is holding references to the object they should release them so the object can be finalized. - + @@ -82739,13 +83266,15 @@ finalized. + Gets a #GFile to the root directory of the #GMount. - + a #GFile. + filename="gio/gmount.c" + line="128">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -82753,21 +83282,23 @@ finalized. a #GMount. + filename="gio/gmount.c" + line="124">a #GMount. + Gets a string containing the name of the #GMount. - + the name for the given @mount. + filename="gio/gmount.c" + line="181">the name for the given @mount. The returned string should be freed with g_free() when no longer needed. @@ -82775,21 +83306,23 @@ finalized. a #GMount. + filename="gio/gmount.c" + line="177">a #GMount. + Gets a #GIcon for the #GMount. - + a #GIcon. + filename="gio/gmount.c" + line="203">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -82797,21 +83330,23 @@ finalized. a #GMount. + filename="gio/gmount.c" + line="199">a #GMount. + Gets the UUID for the #GMount. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available. - + the UUID for @mount or %NULL if no UUID + filename="gio/gmount.c" + line="259">the UUID for @mount or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -82820,21 +83355,23 @@ finalized. a #GMount. + filename="gio/gmount.c" + line="252">a #GMount. + Gets a #GVolume the mount is located on. Returns %NULL if the #GMount is not associated with a #GVolume. - + a #GVolume or %NULL if @mount is not + filename="gio/gmount.c" + line="282">a #GVolume or %NULL if @mount is not associated with a volume. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -82843,21 +83380,23 @@ finalized. a #GMount. + filename="gio/gmount.c" + line="278">a #GMount. + Gets a #GDrive the volume of the mount is located on. Returns %NULL if the #GMount is not associated with a #GDrive or a #GVolume. This is convenience method for getting the #GVolume and using that to get the #GDrive. - + a #GDrive or %NULL if @mount is not + filename="gio/gmount.c" + line="308">a #GDrive or %NULL if @mount is not associated with a volume or a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -82866,71 +83405,77 @@ finalized. a #GMount. + filename="gio/gmount.c" + line="301">a #GMount. + Checks if a #GMount can be unmounted. - + %TRUE if the @mount can be unmounted. + filename="gio/gmount.c" + line="331">%TRUE if the @mount can be unmounted. a #GMount. + filename="gio/gmount.c" + line="327">a #GMount. + Checks if a #GMount can be ejected. - + %TRUE if the @mount can be ejected. + filename="gio/gmount.c" + line="351">%TRUE if the @mount can be ejected. a #GMount. + filename="gio/gmount.c" + line="347">a #GMount. + Starts unmounting a #GMount. - + a #GMount. + filename="gio/gmount.c" + line="367">a #GMount. flags affecting the operation + filename="gio/gmount.c" + line="368">flags affecting the operation nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="369">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="370">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="4"> user data passed to @callback. + filename="gio/gmount.c" + line="371">user data passed to @callback. + Finishes an unmounting operation. - + %TRUE if the mount was successfully unmounted. %FALSE otherwise. + filename="gio/gmount.c" + line="417">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="409">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="410">a #GAsyncResult. + Starts ejecting a #GMount. - + a #GMount. + filename="gio/gmount.c" + line="443">a #GMount. flags affecting the unmount if required for eject + filename="gio/gmount.c" + line="444">flags affecting the unmount if required for eject nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="445">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="446">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="4"> user data passed to @callback. + filename="gio/gmount.c" + line="447">user data passed to @callback. + Finishes an eject operation. - + %TRUE if the mount was successfully ejected. %FALSE otherwise. + filename="gio/gmount.c" + line="493">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="485">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="486">a #GAsyncResult. + Starts remounting a #GMount. - + a #GMount. + filename="gio/gmount.c" + line="687">a #GMount. flags affecting the operation + filename="gio/gmount.c" + line="688">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gmount.c" + line="689">a #GMountOperation or %NULL to avoid user interaction. @@ -83106,8 +83659,8 @@ finalized. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="691">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="692">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="5"> user data passed to @callback. + filename="gio/gmount.c" + line="693">user data passed to @callback. + Finishes a remounting operation. - + %TRUE if the mount was successfully remounted. %FALSE otherwise. + filename="gio/gmount.c" + line="744">%TRUE if the mount was successfully remounted. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="736">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="737">a #GAsyncResult. + Starts guessing the type of the content of a #GMount. + See g_mount_guess_content_type() for more information on content + type guessing. This operation was added in 2.18. - + a #GMount + filename="gio/gmount.c" + line="767">a #GMount Whether to force a rescan of the content. + filename="gio/gmount.c" + line="768">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -83186,8 +83745,8 @@ finalized. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gmount.c" + line="770">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback + filename="gio/gmount.c" + line="771">a #GAsyncReadyCallback allow-none="1" closure="4"> user data passed to @callback + filename="gio/gmount.c" + line="772">user data passed to @callback + Finishes a content type guessing operation. Added in 2.18. - + a %NULL-terminated array of content types or %NULL on error. + filename="gio/gmount.c" + line="829">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -83230,27 +83791,29 @@ finalized. a #GMount + filename="gio/gmount.c" + line="818">a #GMount a #GAsyncResult + filename="gio/gmount.c" + line="819">a #GAsyncResult + Synchronous variant of @guess_content_type. Added in 2.18 - + a %NULL-terminated array of content types or %NULL on error. + filename="gio/gmount.c" + line="872">a %NULL-terminated array of content types or %NULL on error. Caller should free this array with g_strfreev() when done with it. @@ -83259,14 +83822,14 @@ finalized. a #GMount + filename="gio/gmount.c" + line="855">a #GMount Whether to force a rescan of the content. + filename="gio/gmount.c" + line="856">Whether to force a rescan of the content. Otherwise a cached result will be used if available @@ -83275,17 +83838,19 @@ finalized. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gmount.c" + line="858">optional #GCancellable object, %NULL to ignore + The ::pre-unmount signal that is emitted when the #GMount will soon be emitted. If the recipient is somehow holding the mount open by keeping an open file on it it should close the file. - + @@ -83297,23 +83862,25 @@ finalized. + Starts unmounting a #GMount using a #GMountOperation. Since 2.22. - + a #GMount. + filename="gio/gmount.c" + line="518">a #GMount. flags affecting the operation + filename="gio/gmount.c" + line="519">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gmount.c" + line="520">a #GMountOperation or %NULL to avoid user interaction. @@ -83331,8 +83898,8 @@ finalized. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="522">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="523">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="5"> user data passed to @callback. + filename="gio/gmount.c" + line="524">user data passed to @callback. + Finishes an unmounting operation using a #GMountOperation. Since 2.22. - + %TRUE if the mount was successfully unmounted. %FALSE otherwise. + filename="gio/gmount.c" + line="574">%TRUE if the mount was successfully unmounted. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="566">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="567">a #GAsyncResult. + Starts ejecting a #GMount using a #GMountOperation. Since 2.22. - + a #GMount. + filename="gio/gmount.c" + line="603">a #GMount. flags affecting the unmount if required for eject + filename="gio/gmount.c" + line="604">flags affecting the unmount if required for eject nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid + filename="gio/gmount.c" + line="605">a #GMountOperation or %NULL to avoid user interaction. @@ -83420,8 +83991,8 @@ finalized. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gmount.c" + line="607">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> a #GAsyncReadyCallback, or %NULL. + filename="gio/gmount.c" + line="608">a #GAsyncReadyCallback, or %NULL. allow-none="1" closure="5"> user data passed to @callback. + filename="gio/gmount.c" + line="609">user data passed to @callback. + Finishes an eject operation using a #GMountOperation. Since 2.22. - + %TRUE if the mount was successfully ejected. %FALSE otherwise. + filename="gio/gmount.c" + line="659">%TRUE if the mount was successfully ejected. %FALSE otherwise. a #GMount. + filename="gio/gmount.c" + line="651">a #GMount. a #GAsyncResult. + filename="gio/gmount.c" + line="652">a #GAsyncResult. + Gets a #GFile indication a start location that can be use as the entry point for this mount. Since 2.24. - + a #GFile. + filename="gio/gmount.c" + line="152">a #GFile. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -83489,41 +84064,45 @@ finalized. a #GMount. + filename="gio/gmount.c" + line="146">a #GMount. + Gets a key used for sorting #GMount instance or %NULL if no such key exists. Since 2.32. - + Sorting key for @mount or %NULL if no such key is available. + filename="gio/gmount.c" + line="1044">Sorting key for @mount or %NULL if no such key is available. A #GMount. + filename="gio/gmount.c" + line="1040">A #GMount. + Gets a symbolic #GIcon for the #GMount. Since 2.34. - + a #GIcon. + filename="gio/gmount.c" + line="226">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -83531,8 +84110,8 @@ finalized. a #GMount. + filename="gio/gmount.c" + line="222">a #GMount. @@ -83544,7 +84123,7 @@ finalized. glib:get-type="g_mount_mount_flags_get_type" c:type="GMountMountFlags"> Flags used when mounting a mount. glib:nick="none" glib:name="G_MOUNT_MOUNT_NONE"> No flags set. @@ -83564,46 +84143,44 @@ finalized. glib:get-type="g_mount_operation_get_type" glib:type-struct="MountOperationClass"> #GMountOperation provides a mechanism for interacting with the user. + filename="gio/gmountoperation.c" + line="33">`GMountOperation` provides a mechanism for interacting with the user. It can be used for authenticating mountable operations, such as loop mounting files, hard drive partitions or server locations. It can also be used to ask the user questions or show a list of applications preventing unmount or eject operations from completing. -Note that #GMountOperation is used for more than just #GMount -objects – for example it is also used in g_drive_start() and -g_drive_stop(). +Note that `GMountOperation` is used for more than just [iface@Gio.Mount] +objects – for example it is also used in [method@Gio.Drive.start] and +[method@Gio.Drive.stop]. Users should instantiate a subclass of this that implements all the various callbacks to show the required dialogs, such as -#GtkMountOperation. If no user interaction is desired (for example -when automounting filesystems at login time), usually %NULL can be -passed, see each method taking a #GMountOperation for details. +[`GtkMountOperation`](https://docs.gtk.org/gtk4/class.MountOperation.html). +If no user interaction is desired (for example when automounting +filesystems at login time), usually `NULL` can be passed, see each method +taking a `GMountOperation` for details. -The term ‘TCRYPT’ is used to mean ‘compatible with TrueCrypt and VeraCrypt’. +Throughout the API, the term ‘TCRYPT’ is used to mean ‘compatible with TrueCrypt and VeraCrypt’. [TrueCrypt](https://en.wikipedia.org/wiki/TrueCrypt) is a discontinued system for encrypting file containers, partitions or whole disks, typically used with Windows. [VeraCrypt](https://www.veracrypt.fr/) is a maintained fork of TrueCrypt with various improvements and auditing fixes. - + Creates a new mount operation. - + filename="gio/gmountoperation.c" + line="605">Creates a new mount operation. + a #GMountOperation. + filename="gio/gmountoperation.c" + line="610">a #GMountOperation. - + @@ -83614,8 +84191,7 @@ improvements and auditing fixes. - + @@ -83639,30 +84215,29 @@ improvements and auditing fixes. Virtual implementation of #GMountOperation::ask-question. - + filename="gio/gmountoperation.h" + line="63">Virtual implementation of #GMountOperation::ask-question. + a #GMountOperation + filename="gio/gmountoperation.h" + line="65">a #GMountOperation string containing a message to display to the user + filename="gio/gmountoperation.h" + line="66">string containing a message to display to the user an array of + filename="gio/gmountoperation.h" + line="67">an array of strings for each possible choice @@ -83672,54 +84247,52 @@ improvements and auditing fixes. Emits the #GMountOperation::reply signal. - + filename="gio/gmountoperation.c" + line="953">Emits the #GMountOperation::reply signal. + a #GMountOperation + filename="gio/gmountoperation.c" + line="955">a #GMountOperation a #GMountOperationResult + filename="gio/gmountoperation.c" + line="956">a #GMountOperationResult Virtual implementation of #GMountOperation::show-processes. - + filename="gio/gmountoperation.h" + line="81">Virtual implementation of #GMountOperation::show-processes. + a #GMountOperation + filename="gio/gmountoperation.h" + line="83">a #GMountOperation string containing a message to display to the user + filename="gio/gmountoperation.h" + line="84">string containing a message to display to the user an array of #GPid for processes blocking + filename="gio/gmountoperation.h" + line="85">an array of #GPid for processes blocking the operation @@ -83727,8 +84300,8 @@ improvements and auditing fixes. an array of + filename="gio/gmountoperation.h" + line="87">an array of strings for each possible choice @@ -83737,8 +84310,7 @@ improvements and auditing fixes. - + @@ -83761,22 +84333,21 @@ improvements and auditing fixes. c:identifier="g_mount_operation_get_anonymous" glib:get-property="anonymous"> Check to see whether the mount operation is being used + filename="gio/gmountoperation.c" + line="683">Check to see whether the mount operation is being used for an anonymous user. - + %TRUE if mount operation is anonymous. + filename="gio/gmountoperation.c" + line="690">%TRUE if mount operation is anonymous. a #GMountOperation. + filename="gio/gmountoperation.c" + line="685">a #GMountOperation. @@ -83785,22 +84356,21 @@ for an anonymous user. c:identifier="g_mount_operation_get_choice" glib:get-property="choice"> Gets a choice from the mount operation. - + filename="gio/gmountoperation.c" + line="792">Gets a choice from the mount operation. + an integer containing an index of the user's choice from + filename="gio/gmountoperation.c" + line="798">an integer containing an index of the user's choice from the choice's list, or `0`. a #GMountOperation. + filename="gio/gmountoperation.c" + line="794">a #GMountOperation. @@ -83809,21 +84379,20 @@ the choice's list, or `0`. c:identifier="g_mount_operation_get_domain" glib:get-property="domain"> Gets the domain of the mount operation. - + filename="gio/gmountoperation.c" + line="721">Gets the domain of the mount operation. + a string set to the domain. + filename="gio/gmountoperation.c" + line="727">a string set to the domain. a #GMountOperation. + filename="gio/gmountoperation.c" + line="723">a #GMountOperation. @@ -83833,22 +84402,21 @@ the choice's list, or `0`. glib:get-property="is-tcrypt-hidden-volume" version="2.58"> Check to see whether the mount operation is being used + filename="gio/gmountoperation.c" + line="829">Check to see whether the mount operation is being used for a TCRYPT hidden volume. - + %TRUE if mount operation is for hidden volume. + filename="gio/gmountoperation.c" + line="836">%TRUE if mount operation is for hidden volume. a #GMountOperation. + filename="gio/gmountoperation.c" + line="831">a #GMountOperation. @@ -83858,22 +84426,21 @@ for a TCRYPT hidden volume. glib:get-property="is-tcrypt-system-volume" version="2.58"> Check to see whether the mount operation is being used + filename="gio/gmountoperation.c" + line="871">Check to see whether the mount operation is being used for a TCRYPT system volume. - + %TRUE if mount operation is for system volume. + filename="gio/gmountoperation.c" + line="878">%TRUE if mount operation is for system volume. a #GMountOperation. + filename="gio/gmountoperation.c" + line="873">a #GMountOperation. @@ -83882,21 +84449,20 @@ for a TCRYPT system volume. c:identifier="g_mount_operation_get_password" glib:get-property="password"> Gets a password from the mount operation. - + filename="gio/gmountoperation.c" + line="650">Gets a password from the mount operation. + a string containing the password within @op. + filename="gio/gmountoperation.c" + line="656">a string containing the password within @op. a #GMountOperation. + filename="gio/gmountoperation.c" + line="652">a #GMountOperation. @@ -83905,21 +84471,20 @@ for a TCRYPT system volume. c:identifier="g_mount_operation_get_password_save" glib:get-property="password-save"> Gets the state of saving passwords for the mount operation. - + filename="gio/gmountoperation.c" + line="753">Gets the state of saving passwords for the mount operation. + a #GPasswordSave flag. + filename="gio/gmountoperation.c" + line="759">a #GPasswordSave flag. a #GMountOperation. + filename="gio/gmountoperation.c" + line="755">a #GMountOperation. @@ -83929,21 +84494,20 @@ for a TCRYPT system volume. glib:get-property="pim" version="2.58"> Gets a PIM from the mount operation. - + filename="gio/gmountoperation.c" + line="913">Gets a PIM from the mount operation. + The VeraCrypt PIM within @op. + filename="gio/gmountoperation.c" + line="919">The VeraCrypt PIM within @op. a #GMountOperation. + filename="gio/gmountoperation.c" + line="915">a #GMountOperation. @@ -83952,45 +84516,43 @@ for a TCRYPT system volume. c:identifier="g_mount_operation_get_username" glib:get-property="username"> Get the user name from the mount operation. - + filename="gio/gmountoperation.c" + line="618">Get the user name from the mount operation. + a string containing the user name. + filename="gio/gmountoperation.c" + line="624">a string containing the user name. a #GMountOperation. + filename="gio/gmountoperation.c" + line="620">a #GMountOperation. Emits the #GMountOperation::reply signal. - + filename="gio/gmountoperation.c" + line="953">Emits the #GMountOperation::reply signal. + a #GMountOperation + filename="gio/gmountoperation.c" + line="955">a #GMountOperation a #GMountOperationResult + filename="gio/gmountoperation.c" + line="956">a #GMountOperationResult @@ -83999,24 +84561,23 @@ for a TCRYPT system volume. c:identifier="g_mount_operation_set_anonymous" glib:set-property="anonymous"> Sets the mount operation to use an anonymous user if @anonymous is %TRUE. - + filename="gio/gmountoperation.c" + line="699">Sets the mount operation to use an anonymous user if @anonymous is %TRUE. + a #GMountOperation. + filename="gio/gmountoperation.c" + line="701">a #GMountOperation. boolean value. + filename="gio/gmountoperation.c" + line="702">boolean value. @@ -84025,24 +84586,23 @@ for a TCRYPT system volume. c:identifier="g_mount_operation_set_choice" glib:set-property="choice"> Sets a default choice for the mount operation. - + filename="gio/gmountoperation.c" + line="808">Sets a default choice for the mount operation. + a #GMountOperation. + filename="gio/gmountoperation.c" + line="810">a #GMountOperation. an integer. + filename="gio/gmountoperation.c" + line="811">an integer. @@ -84051,18 +84611,17 @@ for a TCRYPT system volume. c:identifier="g_mount_operation_set_domain" glib:set-property="domain"> Sets the mount operation's domain. - + filename="gio/gmountoperation.c" + line="736">Sets the mount operation's domain. + a #GMountOperation. + filename="gio/gmountoperation.c" + line="738">a #GMountOperation. nullable="1" allow-none="1"> the domain to set. + filename="gio/gmountoperation.c" + line="739">the domain to set. @@ -84081,24 +84640,23 @@ for a TCRYPT system volume. glib:set-property="is-tcrypt-hidden-volume" version="2.58"> Sets the mount operation to use a hidden volume if @hidden_volume is %TRUE. - + filename="gio/gmountoperation.c" + line="847">Sets the mount operation to use a hidden volume if @hidden_volume is %TRUE. + a #GMountOperation. + filename="gio/gmountoperation.c" + line="849">a #GMountOperation. boolean value. + filename="gio/gmountoperation.c" + line="850">boolean value. @@ -84108,24 +84666,23 @@ for a TCRYPT system volume. glib:set-property="is-tcrypt-system-volume" version="2.58"> Sets the mount operation to use a system volume if @system_volume is %TRUE. - + filename="gio/gmountoperation.c" + line="889">Sets the mount operation to use a system volume if @system_volume is %TRUE. + a #GMountOperation. + filename="gio/gmountoperation.c" + line="891">a #GMountOperation. boolean value. + filename="gio/gmountoperation.c" + line="892">boolean value. @@ -84134,18 +84691,17 @@ for a TCRYPT system volume. c:identifier="g_mount_operation_set_password" glib:set-property="password"> Sets the mount operation's password to @password. - + filename="gio/gmountoperation.c" + line="665">Sets the mount operation's password to @password. + a #GMountOperation. + filename="gio/gmountoperation.c" + line="667">a #GMountOperation. nullable="1" allow-none="1"> password to set. + filename="gio/gmountoperation.c" + line="668">password to set. @@ -84163,24 +84719,23 @@ for a TCRYPT system volume. c:identifier="g_mount_operation_set_password_save" glib:set-property="password-save"> Sets the state of saving passwords for the mount operation. - + filename="gio/gmountoperation.c" + line="769">Sets the state of saving passwords for the mount operation. + a #GMountOperation. + filename="gio/gmountoperation.c" + line="771">a #GMountOperation. a set of #GPasswordSave flags. + filename="gio/gmountoperation.c" + line="772">a set of #GPasswordSave flags. @@ -84190,24 +84745,23 @@ for a TCRYPT system volume. glib:set-property="pim" version="2.58"> Sets the mount operation's PIM to @pim. - + filename="gio/gmountoperation.c" + line="930">Sets the mount operation's PIM to @pim. + a #GMountOperation. + filename="gio/gmountoperation.c" + line="932">a #GMountOperation. an unsigned integer. + filename="gio/gmountoperation.c" + line="933">an unsigned integer. @@ -84216,18 +84770,17 @@ for a TCRYPT system volume. c:identifier="g_mount_operation_set_username" glib:set-property="username"> Sets the user name within @op to @username. - + filename="gio/gmountoperation.c" + line="633">Sets the user name within @op to @username. + a #GMountOperation. + filename="gio/gmountoperation.c" + line="635">a #GMountOperation. nullable="1" allow-none="1"> input username. + filename="gio/gmountoperation.c" + line="636">input username. @@ -84248,8 +84801,8 @@ for a TCRYPT system volume. getter="get_anonymous" default-value="FALSE"> Whether to use an anonymous user when authenticating. + filename="gio/gmountoperation.c" + line="500">Whether to use an anonymous user when authenticating. getter="get_choice" default-value="0"> The index of the user's choice when a question is asked during the + filename="gio/gmountoperation.c" + line="537">The index of the user's choice when a question is asked during the mount operation. See the #GMountOperation::ask-question signal. @@ -84271,8 +84824,8 @@ mount operation. See the #GMountOperation::ask-question signal. getter="get_domain" default-value="NULL"> The domain to use for the mount operation. + filename="gio/gmountoperation.c" + line="512">The domain to use for the mount operation. getter="get_is_tcrypt_hidden_volume" default-value="FALSE"> Whether the device to be unlocked is a TCRYPT hidden volume. + filename="gio/gmountoperation.c" + line="550">Whether the device to be unlocked is a TCRYPT hidden volume. See [the VeraCrypt documentation](https://www.veracrypt.fr/en/Hidden%20Volume.html). @@ -84296,8 +84849,8 @@ See [the VeraCrypt documentation](https://www.veracrypt.fr/en/Hidden%20Volume.ht getter="get_is_tcrypt_system_volume" default-value="FALSE"> Whether the device to be unlocked is a TCRYPT system volume. + filename="gio/gmountoperation.c" + line="565">Whether the device to be unlocked is a TCRYPT system volume. In this context, a system volume is a volume with a bootloader and operating system installed. This is only supported for Windows operating systems. For further documentation, see @@ -84311,8 +84864,8 @@ operating systems. For further documentation, see getter="get_password" default-value="NULL"> The password that is used for authentication when carrying out + filename="gio/gmountoperation.c" + line="487">The password that is used for authentication when carrying out the mount operation. @@ -84323,8 +84876,8 @@ the mount operation. getter="get_password_save" default-value="G_PASSWORD_SAVE_NEVER"> Determines if and how the password information should be saved. + filename="gio/gmountoperation.c" + line="524">Determines if and how the password information should be saved. getter="get_pim" default-value="0"> The VeraCrypt PIM value, when unlocking a VeraCrypt volume. See + filename="gio/gmountoperation.c" + line="583">The VeraCrypt PIM value, when unlocking a VeraCrypt volume. See [the VeraCrypt documentation](https://www.veracrypt.fr/en/Personal%20Iterations%20Multiplier%20(PIM).html). @@ -84347,8 +84900,8 @@ the mount operation. getter="get_username" default-value="NULL"> The user name that is used for authentication when carrying out + filename="gio/gmountoperation.c" + line="474">The user name that is used for authentication when carrying out the mount operation. @@ -84360,8 +84913,8 @@ the mount operation. Emitted by the backend when e.g. a device becomes unavailable + filename="gio/gmountoperation.c" + line="376">Emitted by the backend when e.g. a device becomes unavailable while a mount operation is in progress. Implementations of GMountOperation should handle this signal @@ -84372,8 +84925,8 @@ by dismissing open password dialogs. Emitted when a mount operation asks the user for a password. + filename="gio/gmountoperation.c" + line="306">Emitted when a mount operation asks the user for a password. If the message contains a line break, the first line should be presented as a heading. For example, it may be used as the @@ -84384,34 +84937,34 @@ primary text in a #GtkMessageDialog. string containing a message to display to the user. + filename="gio/gmountoperation.c" + line="309">string containing a message to display to the user. string containing the default user name. + filename="gio/gmountoperation.c" + line="310">string containing the default user name. string containing the default domain. + filename="gio/gmountoperation.c" + line="311">string containing the default domain. a set of #GAskPasswordFlags. + filename="gio/gmountoperation.c" + line="312">a set of #GAskPasswordFlags. Emitted when asking the user a question and gives a list of + filename="gio/gmountoperation.c" + line="333">Emitted when asking the user a question and gives a list of choices for the user to choose from. If the message contains a line break, the first line should be @@ -84423,14 +84976,14 @@ primary text in a #GtkMessageDialog. string containing a message to display to the user. + filename="gio/gmountoperation.c" + line="336">string containing a message to display to the user. an array of strings for each possible choice. + filename="gio/gmountoperation.c" + line="337">an array of strings for each possible choice. @@ -84439,24 +84992,24 @@ primary text in a #GtkMessageDialog. Emitted when the user has replied to the mount operation. + filename="gio/gmountoperation.c" + line="359">Emitted when the user has replied to the mount operation. a #GMountOperationResult indicating how the request was handled + filename="gio/gmountoperation.c" + line="362">a #GMountOperationResult indicating how the request was handled Emitted when one or more processes are blocking an operation + filename="gio/gmountoperation.c" + line="396">Emitted when one or more processes are blocking an operation e.g. unmounting/ejecting a #GMount or stopping a #GDrive. Note that this signal may be emitted several times to update the @@ -84474,14 +85027,14 @@ primary text in a #GtkMessageDialog. string containing a message to display to the user. + filename="gio/gmountoperation.c" + line="399">string containing a message to display to the user. an array of #GPid for processes + filename="gio/gmountoperation.c" + line="400">an array of #GPid for processes blocking the operation. @@ -84489,8 +85042,8 @@ primary text in a #GtkMessageDialog. an array of strings for each possible choice. + filename="gio/gmountoperation.c" + line="402">an array of strings for each possible choice. @@ -84499,8 +85052,8 @@ primary text in a #GtkMessageDialog. Emitted when an unmount operation has been busy for more than some time + filename="gio/gmountoperation.c" + line="432">Emitted when an unmount operation has been busy for more than some time (typically 1.5 seconds). When unmounting or ejecting a volume, the kernel might need to flush @@ -84522,21 +85075,21 @@ primary text in a #GtkMessageDialog. string containing a message to display to the user + filename="gio/gmountoperation.c" + line="435">string containing a message to display to the user the estimated time left before the operation completes, + filename="gio/gmountoperation.c" + line="436">the estimated time left before the operation completes, in microseconds, or -1 the amount of bytes to be written before the operation + filename="gio/gmountoperation.c" + line="438">the amount of bytes to be written before the operation completes (or -1 if such amount is not known), or zero if the operation is completed @@ -84547,15 +85100,13 @@ primary text in a #GtkMessageDialog. - + - + @@ -84580,28 +85131,27 @@ primary text in a #GtkMessageDialog. - + a #GMountOperation + filename="gio/gmountoperation.h" + line="65">a #GMountOperation string containing a message to display to the user + filename="gio/gmountoperation.h" + line="66">string containing a message to display to the user an array of + filename="gio/gmountoperation.h" + line="67">an array of strings for each possible choice @@ -84612,22 +85162,21 @@ primary text in a #GtkMessageDialog. - + a #GMountOperation + filename="gio/gmountoperation.c" + line="955">a #GMountOperation a #GMountOperationResult + filename="gio/gmountoperation.c" + line="956">a #GMountOperationResult @@ -84636,8 +85185,7 @@ primary text in a #GtkMessageDialog. - + @@ -84650,28 +85198,27 @@ primary text in a #GtkMessageDialog. - + a #GMountOperation + filename="gio/gmountoperation.h" + line="83">a #GMountOperation string containing a message to display to the user + filename="gio/gmountoperation.h" + line="84">string containing a message to display to the user an array of #GPid for processes blocking + filename="gio/gmountoperation.h" + line="85">an array of #GPid for processes blocking the operation @@ -84679,8 +85226,8 @@ primary text in a #GtkMessageDialog. an array of + filename="gio/gmountoperation.h" + line="87">an array of strings for each possible choice @@ -84691,8 +85238,7 @@ primary text in a #GtkMessageDialog. - + @@ -84714,8 +85260,7 @@ primary text in a #GtkMessageDialog. - + @@ -84723,8 +85268,7 @@ primary text in a #GtkMessageDialog. - + @@ -84732,8 +85276,7 @@ primary text in a #GtkMessageDialog. - + @@ -84741,8 +85284,7 @@ primary text in a #GtkMessageDialog. - + @@ -84750,8 +85292,7 @@ primary text in a #GtkMessageDialog. - + @@ -84759,8 +85300,7 @@ primary text in a #GtkMessageDialog. - + @@ -84768,8 +85308,7 @@ primary text in a #GtkMessageDialog. - + @@ -84777,8 +85316,7 @@ primary text in a #GtkMessageDialog. - + @@ -84786,8 +85324,7 @@ primary text in a #GtkMessageDialog. - + @@ -84798,16 +85335,15 @@ primary text in a #GtkMessageDialog. c:type="GMountOperationPrivate" disguised="1" opaque="1"> - + #GMountOperationResult is returned as a result when a request for + filename="gio/gioenums.h" + line="636">#GMountOperationResult is returned as a result when a request for information is send by the mounting operation. glib:nick="handled" glib:name="G_MOUNT_OPERATION_HANDLED"> The request was fulfilled and the + filename="gio/gioenums.h" + line="638">The request was fulfilled and the user specified data is now available glib:nick="aborted" glib:name="G_MOUNT_OPERATION_ABORTED"> The user requested the mount operation + filename="gio/gioenums.h" + line="640">The user requested the mount operation to be aborted glib:nick="unhandled" glib:name="G_MOUNT_OPERATION_UNHANDLED"> The request was unhandled (i.e. not + filename="gio/gioenums.h" + line="642">The request was unhandled (i.e. not implemented) @@ -84845,7 +85381,7 @@ information is send by the mounting operation. glib:get-type="g_mount_unmount_flags_get_type" c:type="GMountUnmountFlags"> Flags used when an unmounting a mount. glib:nick="none" glib:name="G_MOUNT_UNMOUNT_NONE"> No flags set. glib:nick="force" glib:name="G_MOUNT_UNMOUNT_FORCE"> Unmount even if there are outstanding file operations on the mount. @@ -84870,8 +85406,7 @@ information is send by the mounting operation. - + @@ -84880,8 +85415,7 @@ information is send by the mounting operation. - + @@ -84890,8 +85424,7 @@ information is send by the mounting operation. - + @@ -84900,8 +85433,7 @@ information is send by the mounting operation. - + @@ -84910,8 +85442,7 @@ information is send by the mounting operation. - + @@ -84920,15 +85451,13 @@ information is send by the mounting operation. - + - + @@ -84937,8 +85466,7 @@ information is send by the mounting operation. - + @@ -84947,8 +85475,7 @@ information is send by the mounting operation. - + @@ -84957,8 +85484,7 @@ information is send by the mounting operation. - + @@ -84969,18 +85495,16 @@ information is send by the mounting operation. c:type="G_NETWORK_MONITOR_EXTENSION_POINT_NAME" version="2.30"> Extension point for network status monitoring functionality. See [Extending GIO][extending-gio]. - + - + @@ -84989,8 +85513,7 @@ See [Extending GIO][extending-gio]. - + @@ -84999,8 +85522,7 @@ See [Extending GIO][extending-gio]. - + @@ -85009,8 +85531,7 @@ See [Extending GIO][extending-gio]. - + @@ -85019,8 +85540,7 @@ See [Extending GIO][extending-gio]. - + @@ -85029,28 +85549,30 @@ See [Extending GIO][extending-gio]. A socket address of some unknown native type. - + filename="gio/gnativesocketaddress.c" + line="34">A socket address of some unknown native type. + +This corresponds to a general `struct sockaddr` of a type not otherwise +handled by GLib. + Creates a new #GNativeSocketAddress for @native and @len. - + filename="gio/gnativesocketaddress.c" + line="134">Creates a new #GNativeSocketAddress for @native and @len. + a new #GNativeSocketAddress + filename="gio/gnativesocketaddress.c" + line="141">a new #GNativeSocketAddress @@ -85059,14 +85581,14 @@ See [Extending GIO][extending-gio]. nullable="1" allow-none="1"> a native address object + filename="gio/gnativesocketaddress.c" + line="136">a native address object the length of @native, in bytes + filename="gio/gnativesocketaddress.c" + line="137">the length of @native, in bytes @@ -85082,8 +85604,7 @@ See [Extending GIO][extending-gio]. - + @@ -85092,8 +85613,7 @@ See [Extending GIO][extending-gio]. c:type="GNativeSocketAddressPrivate" disguised="1" opaque="1"> - + glib:type-name="GNativeVolumeMonitor" glib:get-type="g_native_volume_monitor_get_type" glib:type-struct="NativeVolumeMonitorClass"> - + @@ -85112,15 +85631,13 @@ See [Extending GIO][extending-gio]. - + - + @@ -85143,8 +85660,8 @@ See [Extending GIO][extending-gio]. glib:get-type="g_network_address_get_type" glib:type-struct="NetworkAddressClass"> #GNetworkAddress provides an easy way to resolve a hostname and + filename="gio/gnetworkaddress.c" + line="48">`GNetworkAddress` provides an easy way to resolve a hostname and then attempt to connect to that host, handling the possibility of multiple IP addresses and multiple address families. @@ -85152,17 +85669,16 @@ The enumeration results of resolved addresses *may* be cached as long as this object is kept alive which may have unexpected results if alive for too long. -See #GSocketConnectable for an example of using the connectable +See [iface@Gio.SocketConnectable] for an example of using the connectable interface. - + Creates a new #GSocketConnectable for connecting to the given + filename="gio/gnetworkaddress.c" + line="302">Creates a new #GSocketConnectable for connecting to the given @hostname and @port. Note that depending on the configuration of the machine, a @@ -85170,25 +85686,24 @@ Note that depending on the configuration of the machine, a only, or to both IPv4 and IPv6; use g_network_address_new_loopback() to create a #GNetworkAddress that is guaranteed to resolve to both addresses. - + the new #GNetworkAddress + filename="gio/gnetworkaddress.c" + line="316">the new #GNetworkAddress the hostname + filename="gio/gnetworkaddress.c" + line="304">the hostname the port + filename="gio/gnetworkaddress.c" + line="305">the port @@ -85197,8 +85712,8 @@ is guaranteed to resolve to both addresses. c:identifier="g_network_address_new_loopback" version="2.44"> Creates a new #GSocketConnectable for connecting to the local host + filename="gio/gnetworkaddress.c" + line="330">Creates a new #GSocketConnectable for connecting to the local host over a loopback connection to the given @port. This is intended for use in connecting to local services which may be running on IPv4 or IPv6. @@ -85210,19 +85725,18 @@ resolving `localhost`, and an IPv6 address for `localhost6`. g_network_address_get_hostname() will always return `localhost` for a #GNetworkAddress created with this constructor. - + the new #GNetworkAddress + filename="gio/gnetworkaddress.c" + line="347">the new #GNetworkAddress the port + filename="gio/gnetworkaddress.c" + line="332">the port @@ -85232,8 +85746,8 @@ a #GNetworkAddress created with this constructor. version="2.22" throws="1"> Creates a new #GSocketConnectable for connecting to the given + filename="gio/gnetworkaddress.c" + line="369">Creates a new #GSocketConnectable for connecting to the given @hostname and @port. May fail and return %NULL in case parsing @host_and_port fails. @@ -85254,26 +85768,25 @@ and @default_port is expected to be provided by the application. service name rather than as a numeric port, but this functionality is deprecated, because it depends on the contents of /etc/services, which is generally quite sparse on platforms other than Linux.) - + the new + filename="gio/gnetworkaddress.c" + line="397">the new #GNetworkAddress, or %NULL on error the hostname and optionally a port + filename="gio/gnetworkaddress.c" + line="371">the hostname and optionally a port the default port if not in @host_and_port + filename="gio/gnetworkaddress.c" + line="372">the default port if not in @host_and_port @@ -85283,33 +85796,32 @@ which is generally quite sparse on platforms other than Linux.) version="2.26" throws="1"> Creates a new #GSocketConnectable for connecting to the given + filename="gio/gnetworkaddress.c" + line="525">Creates a new #GSocketConnectable for connecting to the given @uri. May fail and return %NULL in case parsing @uri fails. Using this rather than g_network_address_new() or g_network_address_parse() allows #GSocketClient to determine when to use application-specific proxy protocols. - + the new + filename="gio/gnetworkaddress.c" + line="538">the new #GNetworkAddress, or %NULL on error the hostname and optionally a port + filename="gio/gnetworkaddress.c" + line="527">the hostname and optionally a port The default port if none is found in the URI + filename="gio/gnetworkaddress.c" + line="528">The default port if none is found in the URI @@ -85319,22 +85831,21 @@ when to use application-specific proxy protocols. glib:get-property="hostname" version="2.22"> Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded, + filename="gio/gnetworkaddress.c" + line="575">Gets @addr's hostname. This might be either UTF-8 or ASCII-encoded, depending on what @addr was created with. - + @addr's hostname + filename="gio/gnetworkaddress.c" + line="582">@addr's hostname a #GNetworkAddress + filename="gio/gnetworkaddress.c" + line="577">a #GNetworkAddress @@ -85344,21 +85855,20 @@ depending on what @addr was created with. glib:get-property="port" version="2.22"> Gets @addr's port number - + filename="gio/gnetworkaddress.c" + line="594">Gets @addr's port number + @addr's port (which may be 0) + filename="gio/gnetworkaddress.c" + line="600">@addr's port (which may be 0) a #GNetworkAddress + filename="gio/gnetworkaddress.c" + line="596">a #GNetworkAddress @@ -85368,47 +85878,58 @@ depending on what @addr was created with. glib:get-property="scheme" version="2.26"> Gets @addr's scheme - + filename="gio/gnetworkaddress.c" + line="612">Gets @addr's scheme + @addr's scheme (%NULL if not built from URI) + filename="gio/gnetworkaddress.c" + line="618">@addr's scheme (%NULL if not built from URI) a #GNetworkAddress + filename="gio/gnetworkaddress.c" + line="614">a #GNetworkAddress + Hostname to resolve. + Network port. + URI scheme. @@ -85421,8 +85942,7 @@ depending on what @addr was created with. - + @@ -85431,8 +85951,7 @@ depending on what @addr was created with. c:type="GNetworkAddressPrivate" disguised="1" opaque="1"> - + glib:get-type="g_network_connectivity_get_type" c:type="GNetworkConnectivity"> The host's network connectivity state, as reported by #GNetworkMonitor. + filename="gio/gioenums.h" + line="2075">The host's network connectivity state, as reported by #GNetworkMonitor. The host is not configured with a + filename="gio/gioenums.h" + line="2077">The host is not configured with a route to the Internet; it may or may not be connected to a local network. @@ -85459,8 +85978,8 @@ depending on what @addr was created with. glib:nick="limited" glib:name="G_NETWORK_CONNECTIVITY_LIMITED"> The host is connected to a network, but + filename="gio/gioenums.h" + line="2080">The host is connected to a network, but does not appear to be able to reach the full Internet, perhaps due to upstream network problems. @@ -85470,8 +85989,8 @@ depending on what @addr was created with. glib:nick="portal" glib:name="G_NETWORK_CONNECTIVITY_PORTAL"> The host is behind a captive portal and + filename="gio/gioenums.h" + line="2083">The host is behind a captive portal and cannot reach the full Internet. glib:nick="full" glib:name="G_NETWORK_CONNECTIVITY_FULL"> The host is connected to a network, and + filename="gio/gioenums.h" + line="2085">The host is connected to a network, and appears to be able to reach the full Internet. @@ -85493,28 +86012,26 @@ depending on what @addr was created with. glib:get-type="g_network_monitor_get_type" glib:type-struct="NetworkMonitorInterface"> #GNetworkMonitor provides an easy-to-use cross-platform API + filename="gio/gnetworkmonitor.c" + line="33">`GNetworkMonitor` provides an easy-to-use cross-platform API for monitoring network connectivity. On Linux, the available implementations are based on the kernel's netlink interface and on NetworkManager. There is also an implementation for use inside Flatpak sandboxes. - + Gets the default #GNetworkMonitor for the system. - + filename="gio/gnetworkmonitor.c" + line="74">Gets the default #GNetworkMonitor for the system. + a #GNetworkMonitor, which will be + filename="gio/gnetworkmonitor.c" + line="79">a #GNetworkMonitor, which will be a dummy object if no network monitor is available @@ -85522,10 +86039,11 @@ There is also an implementation for use inside Flatpak sandboxes. + throws="1" + glib:async-func="can_reach_async"> Attempts to determine whether or not the host pointed to by + filename="gio/gnetworkmonitor.c" + line="181">Attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -85542,25 +86060,24 @@ Note that although this does not attempt to connect to @connectable, it may still block for a brief period of time (eg, trying to do multicast DNS on the local network), so if you do not want to block, you should use g_network_monitor_can_reach_async(). - + %TRUE if @connectable is reachable, %FALSE if not. + filename="gio/gnetworkmonitor.c" + line="206">%TRUE if @connectable is reachable, %FALSE if not. a #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="183">a #GNetworkMonitor a #GSocketConnectable + filename="gio/gnetworkmonitor.c" + line="184">a #GSocketConnectable nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gnetworkmonitor.c" + line="185">a #GCancellable, or %NULL - + Asynchronously attempts to determine whether or not the host + filename="gio/gnetworkmonitor.c" + line="242">Asynchronously attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -85586,22 +86106,21 @@ For more details, see g_network_monitor_can_reach(). When the operation is finished, @callback will be called. You can then call g_network_monitor_can_reach_finish() to get the result of the operation. - + a #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="244">a #GNetworkMonitor a #GSocketConnectable + filename="gio/gnetworkmonitor.c" + line="245">a #GSocketConnectable nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gnetworkmonitor.c" + line="246">a #GCancellable, or %NULL scope="async" closure="3"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gnetworkmonitor.c" + line="247">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gnetworkmonitor.c" + line="249">the data to pass to callback function @@ -85641,35 +86160,37 @@ to get the result of the operation. invoker="can_reach_finish" throws="1"> Finishes an async network connectivity test. + filename="gio/gnetworkmonitor.c" + line="284">Finishes an async network connectivity test. See g_network_monitor_can_reach_async(). - + %TRUE if network is reachable, %FALSE if not. + filename="gio/gnetworkmonitor.c" + line="293">%TRUE if network is reachable, %FALSE if not. a #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="286">a #GNetworkMonitor a #GAsyncResult + filename="gio/gnetworkmonitor.c" + line="287">a #GAsyncResult - + the virtual function pointer for the + GNetworkMonitor::network-changed signal. + @@ -85685,10 +86206,11 @@ See g_network_monitor_can_reach_async(). + throws="1" + glib:async-func="can_reach_async"> Attempts to determine whether or not the host pointed to by + filename="gio/gnetworkmonitor.c" + line="181">Attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -85705,25 +86227,24 @@ Note that although this does not attempt to connect to @connectable, it may still block for a brief period of time (eg, trying to do multicast DNS on the local network), so if you do not want to block, you should use g_network_monitor_can_reach_async(). - + %TRUE if @connectable is reachable, %FALSE if not. + filename="gio/gnetworkmonitor.c" + line="206">%TRUE if @connectable is reachable, %FALSE if not. a #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="183">a #GNetworkMonitor a #GSocketConnectable + filename="gio/gnetworkmonitor.c" + line="184">a #GSocketConnectable nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gnetworkmonitor.c" + line="185">a #GCancellable, or %NULL + c:identifier="g_network_monitor_can_reach_async" + glib:finish-func="can_reach_finish" + glib:sync-func="can_reach"> Asynchronously attempts to determine whether or not the host + filename="gio/gnetworkmonitor.c" + line="242">Asynchronously attempts to determine whether or not the host pointed to by @connectable can be reached, without actually trying to connect to it. @@ -85750,22 +86273,21 @@ For more details, see g_network_monitor_can_reach(). When the operation is finished, @callback will be called. You can then call g_network_monitor_can_reach_finish() to get the result of the operation. - + a #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="244">a #GNetworkMonitor a #GSocketConnectable + filename="gio/gnetworkmonitor.c" + line="245">a #GSocketConnectable nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gnetworkmonitor.c" + line="246">a #GCancellable, or %NULL scope="async" closure="3"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gnetworkmonitor.c" + line="247">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/gnetworkmonitor.c" + line="249">the data to pass to callback function @@ -85804,28 +86326,27 @@ to get the result of the operation. c:identifier="g_network_monitor_can_reach_finish" throws="1"> Finishes an async network connectivity test. + filename="gio/gnetworkmonitor.c" + line="284">Finishes an async network connectivity test. See g_network_monitor_can_reach_async(). - + %TRUE if network is reachable, %FALSE if not. + filename="gio/gnetworkmonitor.c" + line="293">%TRUE if network is reachable, %FALSE if not. a #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="286">a #GNetworkMonitor a #GAsyncResult + filename="gio/gnetworkmonitor.c" + line="287">a #GAsyncResult @@ -85835,8 +86356,8 @@ See g_network_monitor_can_reach_async(). glib:get-property="connectivity" version="2.44"> Gets a more detailed networking state than + filename="gio/gnetworkmonitor.c" + line="143">Gets a more detailed networking state than g_network_monitor_get_network_available(). If #GNetworkMonitor:network-available is %FALSE, then the @@ -85855,19 +86376,18 @@ Note that in the case of %G_NETWORK_CONNECTIVITY_LIMITED and reachable but others are not. In this case, applications can attempt to connect to remote servers, but should gracefully fall back to their "offline" behavior if the connection attempt fails. - + the network connectivity state + filename="gio/gnetworkmonitor.c" + line="167">the network connectivity state the #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="145">the #GNetworkMonitor @@ -85877,24 +86397,23 @@ back to their "offline" behavior if the connection attempt fails. glib:get-property="network-available" version="2.32"> Checks if the network is available. "Available" here means that the + filename="gio/gnetworkmonitor.c" + line="101">Checks if the network is available. "Available" here means that the system has a default route available for at least one of IPv4 or IPv6. It does not necessarily imply that the public Internet is reachable. See #GNetworkMonitor:network-available for more details. - + whether the network is available + filename="gio/gnetworkmonitor.c" + line="110">whether the network is available the #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="103">the #GNetworkMonitor @@ -85904,22 +86423,21 @@ reachable. See #GNetworkMonitor:network-available for more details. glib:get-property="network-metered" version="2.46"> Checks if the network is metered. + filename="gio/gnetworkmonitor.c" + line="123">Checks if the network is metered. See #GNetworkMonitor:network-metered for more details. - + whether the connection is metered + filename="gio/gnetworkmonitor.c" + line="130">whether the connection is metered the #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="125">the #GNetworkMonitor @@ -85930,8 +86448,8 @@ See #GNetworkMonitor:network-metered for more details. getter="get_connectivity" default-value="G_NETWORK_CONNECTIVITY_FULL"> More detailed information about the host's network connectivity. + filename="gio/gnetworkmonitor.c" + line="393">More detailed information about the host's network connectivity. See g_network_monitor_get_connectivity() and #GNetworkConnectivity for more details. @@ -85942,8 +86460,8 @@ See g_network_monitor_get_connectivity() and getter="get_network_available" default-value="FALSE"> Whether the network is considered available. That is, whether the + filename="gio/gnetworkmonitor.c" + line="331">Whether the network is considered available. That is, whether the system has a default route for at least one of IPv4 or IPv6. Real-world networks are of course much more complicated than @@ -85968,15 +86486,19 @@ See also #GNetworkMonitor::network-changed. getter="get_network_metered" default-value="FALSE"> Whether the network is considered metered. That is, whether the + filename="gio/gnetworkmonitor.c" + line="360">Whether the network is considered metered. + +That is, whether the system has traffic flowing through the default connection that is subject to limitations set by service providers. For example, traffic might be billed by the amount of data transmitted, or there might be a quota on the amount of traffic per month. This is typical with tethered connections (3G and 4G) and in such situations, bandwidth intensive applications may wish to avoid network activity where possible if it will -cost the user money or use up their limited quota. +cost the user money or use up their limited quota. Anything more than a +few hundreds of kilobytes of data usage per hour should be avoided without +asking permission from the user. If more information is required about specific devices then the system network management API should be used instead (for example, @@ -85990,16 +86512,16 @@ See also #GNetworkMonitor:network-available. Emitted when the network configuration changes. + filename="gio/gnetworkmonitor.c" + line="312">Emitted when the network configuration changes. the current value of #GNetworkMonitor:network-available + filename="gio/gnetworkmonitor.c" + line="315">the current value of #GNetworkMonitor:network-available @@ -86010,20 +86532,22 @@ See also #GNetworkMonitor:network-available. glib:is-gtype-struct-for="NetworkMonitor" version="2.32"> The virtual function table for #GNetworkMonitor. - + filename="gio/gnetworkmonitor.c" + line="46">The virtual function table for #GNetworkMonitor. + The parent interface. + filename="gio/gnetworkmonitor.c" + line="48">The parent interface. + the virtual function pointer for the + GNetworkMonitor::network-changed signal. - + @@ -86038,26 +86562,28 @@ See also #GNetworkMonitor:network-available. + the virtual function pointer for g_network_monitor_can_reach() - + %TRUE if @connectable is reachable, %FALSE if not. + filename="gio/gnetworkmonitor.c" + line="206">%TRUE if @connectable is reachable, %FALSE if not. a #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="183">a #GNetworkMonitor a #GSocketConnectable + filename="gio/gnetworkmonitor.c" + line="184">a #GSocketConnectable nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gnetworkmonitor.c" + line="185">a #GCancellable, or %NULL + the virtual function pointer for + g_network_monitor_can_reach_async() - + a #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="244">a #GNetworkMonitor a #GSocketConnectable + filename="gio/gnetworkmonitor.c" + line="245">a #GSocketConnectable nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gnetworkmonitor.c" + line="246">a #GCancellable, or %NULL scope="async" closure="4"> a #GAsyncReadyCallback to call when the - request is satisfied + filename="gio/gnetworkmonitor.c" + line="247">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/gnetworkmonitor.c" + line="249">the data to pass to callback function + the virtual function pointer for + g_network_monitor_can_reach_finish() - + %TRUE if network is reachable, %FALSE if not. + filename="gio/gnetworkmonitor.c" + line="293">%TRUE if network is reachable, %FALSE if not. a #GNetworkMonitor + filename="gio/gnetworkmonitor.c" + line="286">a #GNetworkMonitor a #GAsyncResult + filename="gio/gnetworkmonitor.c" + line="287">a #GAsyncResult @@ -86161,52 +86693,50 @@ See also #GNetworkMonitor:network-available. glib:get-type="g_network_service_get_type" glib:type-struct="NetworkServiceClass"> Like #GNetworkAddress does with hostnames, #GNetworkService + filename="gio/gnetworkservice.c" + line="45">Like [class@Gio.NetworkAddress] does with hostnames, `GNetworkService` provides an easy way to resolve a SRV record, and then attempt to connect to one of the hosts that implements that service, handling service priority/weighting, multiple IP addresses, and multiple address families. -See #GSrvTarget for more information about SRV records, and see -#GSocketConnectable for an example of using the connectable +See [struct@Gio.SrvTarget] for more information about SRV records, and see +[iface@Gio.SocketConnectable] for an example of using the connectable interface. - + Creates a new #GNetworkService representing the given @service, + filename="gio/gnetworkservice.c" + line="252">Creates a new #GNetworkService representing the given @service, @protocol, and @domain. This will initially be unresolved; use the #GSocketConnectable interface to resolve it. - + a new #GNetworkService + filename="gio/gnetworkservice.c" + line="262">a new #GNetworkService the service type to look up (eg, "ldap") + filename="gio/gnetworkservice.c" + line="254">the service type to look up (eg, "ldap") the networking protocol to use for @service (eg, "tcp") + filename="gio/gnetworkservice.c" + line="255">the networking protocol to use for @service (eg, "tcp") the DNS domain to look up the service in + filename="gio/gnetworkservice.c" + line="256">the DNS domain to look up the service in @@ -86216,22 +86746,21 @@ interface. glib:get-property="domain" version="2.22"> Gets the domain that @srv serves. This might be either UTF-8 or + filename="gio/gnetworkservice.c" + line="314">Gets the domain that @srv serves. This might be either UTF-8 or ASCII-encoded, depending on what @srv was created with. - + @srv's domain name + filename="gio/gnetworkservice.c" + line="321">@srv's domain name a #GNetworkService + filename="gio/gnetworkservice.c" + line="316">a #GNetworkService @@ -86241,21 +86770,20 @@ ASCII-encoded, depending on what @srv was created with. glib:get-property="protocol" version="2.22"> Gets @srv's protocol name (eg, "tcp"). - + filename="gio/gnetworkservice.c" + line="296">Gets @srv's protocol name (eg, "tcp"). + @srv's protocol name + filename="gio/gnetworkservice.c" + line="302">@srv's protocol name a #GNetworkService + filename="gio/gnetworkservice.c" + line="298">a #GNetworkService @@ -86265,22 +86793,21 @@ ASCII-encoded, depending on what @srv was created with. glib:get-property="scheme" version="2.26"> Gets the URI scheme used to resolve proxies. By default, the service name + filename="gio/gnetworkservice.c" + line="333">Gets the URI scheme used to resolve proxies. By default, the service name is used as scheme. - + @srv's scheme name + filename="gio/gnetworkservice.c" + line="340">@srv's scheme name a #GNetworkService + filename="gio/gnetworkservice.c" + line="335">a #GNetworkService @@ -86290,21 +86817,20 @@ is used as scheme. glib:get-property="service" version="2.22"> Gets @srv's service name (eg, "ldap"). - + filename="gio/gnetworkservice.c" + line="278">Gets @srv's service name (eg, "ldap"). + @srv's service name + filename="gio/gnetworkservice.c" + line="284">@srv's service name a #GNetworkService + filename="gio/gnetworkservice.c" + line="280">a #GNetworkService @@ -86314,59 +86840,74 @@ is used as scheme. glib:set-property="scheme" version="2.26"> Set's the URI scheme used to resolve proxies. By default, the service name + filename="gio/gnetworkservice.c" + line="355">Set's the URI scheme used to resolve proxies. By default, the service name is used as scheme. - + a #GNetworkService + filename="gio/gnetworkservice.c" + line="357">a #GNetworkService a URI scheme + filename="gio/gnetworkservice.c" + line="358">a URI scheme + Network domain, for example `example.com`. + Network protocol, for example `tcp`. + Network scheme (default is to use service). + Service name, for example `ldap`. @@ -86379,8 +86920,7 @@ is used as scheme. - + @@ -86389,8 +86929,7 @@ is used as scheme. c:type="GNetworkServicePrivate" disguised="1" opaque="1"> - + glib:type-name="GNotification" glib:get-type="g_notification_get_type"> #GNotification is a mechanism for creating a notification to be shown -to the user -- typically as a pop-up notification presented by the + filename="gio/gnotification.c" + line="30">`GNotification` is a mechanism for creating a notification to be shown +to the user — typically as a pop-up notification presented by the desktop environment shell. -The key difference between #GNotification and other similar APIs is +The key difference between `GNotification` and other similar APIs is that, if supported by the desktop environment, notifications sent -with #GNotification will persist after the application has exited, +with `GNotification` will persist after the application has exited, and even across system reboots. Since the user may click on a notification while the application is -not running, applications using #GNotification should be able to be -started as a D-Bus service, using #GApplication. +not running, applications using `GNotification` should be able to be +started as a D-Bus service, using [class@Gio.Application]. -In order for #GNotification to work, the application must have installed +In order for `GNotification` to work, the application must have installed a `.desktop` file. For example: -|[ - [Desktop Entry] - Name=Test Application - Comment=Description of what Test Application does - Exec=gnome-test-application - Icon=org.gnome.TestApplication - Terminal=false - Type=Application - Categories=GNOME;GTK;TestApplication Category; - StartupNotify=true - DBusActivatable=true - X-GNOME-UsesNotifications=true -]| +``` +[Desktop Entry] +Name=Test Application +Comment=Description of what Test Application does +Exec=gnome-test-application +Icon=org.gnome.TestApplication +Terminal=false +Type=Application +Categories=GNOME;GTK;TestApplication Category; +StartupNotify=true +DBusActivatable=true +X-GNOME-UsesNotifications=true +``` The `X-GNOME-UsesNotifications` key indicates to GNOME Control Center that this application uses notifications, so it can be listed in the Control Center’s ‘Notifications’ panel. The `.desktop` file must be named as `org.gnome.TestApplication.desktop`, -where `org.gnome.TestApplication` is the ID passed to g_application_new(). +where `org.gnome.TestApplication` is the ID passed to +[ctor@Gio.Application.new]. User interaction with a notification (either the default action, or buttons) must be associated with actions on the application (ie: -"app." actions). It is not possible to route user interaction +`app.` actions). It is not possible to route user interaction through the notification itself, because the object will not exist if the application is autostarted as a result of a notification being clicked. -A notification can be sent with g_application_send_notification(). +A notification can be sent with [method@Gio.Application.send_notification]. Creates a new #GNotification with @title as its title. + filename="gio/gnotification.c" + line="161">Creates a new #GNotification with @title as its title. After populating @notification with more details, it can be sent to the desktop shell with g_application_send_notification(). Changing any properties after this call will not have any effect until resending @notification. - + a new #GNotification instance + filename="gio/gnotification.c" + line="172">a new #GNotification instance the title of the notification + filename="gio/gnotification.c" + line="163">the title of the notification @@ -86475,8 +87014,8 @@ resending @notification. c:identifier="g_notification_add_button" version="2.40"> Adds a button to @notification that activates the action in + filename="gio/gnotification.c" + line="407">Adds a button to @notification that activates the action in @detailed_action when clicked. That action must be an application-wide action (starting with "app."). If @detailed_action contains a target, the action will be activated with that target as @@ -86484,28 +87023,27 @@ its parameter. See g_action_parse_detailed_name() for a description of the format for @detailed_action. - + a #GNotification + filename="gio/gnotification.c" + line="409">a #GNotification label of the button + filename="gio/gnotification.c" + line="410">label of the button a detailed action name + filename="gio/gnotification.c" + line="411">a detailed action name @@ -86516,36 +87054,35 @@ for @detailed_action. version="2.40" introspectable="0"> Adds a button to @notification that activates @action when clicked. + filename="gio/gnotification.c" + line="449">Adds a button to @notification that activates @action when clicked. @action must be an application-wide action (it must start with "app."). If @target_format is given, it is used to collect remaining positional parameters into a #GVariant instance, similar to g_variant_new(). @action will be activated with that #GVariant as its parameter. - + a #GNotification + filename="gio/gnotification.c" + line="451">a #GNotification label of the button + filename="gio/gnotification.c" + line="452">label of the button an action name + filename="gio/gnotification.c" + line="453">an action name nullable="1" allow-none="1"> a #GVariant format string, or %NULL + filename="gio/gnotification.c" + line="454">a #GVariant format string, or %NULL positional parameters, as determined by @target_format + filename="gio/gnotification.c" + line="455">positional parameters, as determined by @target_format @@ -86570,34 +87107,33 @@ parameter. shadows="add_button_with_target" version="2.40"> Adds a button to @notification that activates @action when clicked. + filename="gio/gnotification.c" + line="487">Adds a button to @notification that activates @action when clicked. @action must be an application-wide action (it must start with "app."). If @target is non-%NULL, @action will be activated with @target as its parameter. - + a #GNotification + filename="gio/gnotification.c" + line="489">a #GNotification label of the button + filename="gio/gnotification.c" + line="490">label of the button an action name + filename="gio/gnotification.c" + line="491">an action name nullable="1" allow-none="1"> a #GVariant to use as @action's parameter, or %NULL + filename="gio/gnotification.c" + line="492">a #GVariant to use as @action's parameter, or %NULL @@ -86615,18 +87151,17 @@ its parameter. c:identifier="g_notification_set_body" version="2.40"> Sets the body of @notification to @body. - + filename="gio/gnotification.c" + line="246">Sets the body of @notification to @body. + a #GNotification + filename="gio/gnotification.c" + line="248">a #GNotification nullable="1" allow-none="1"> the new body for @notification, or %NULL + filename="gio/gnotification.c" + line="249">the new body for @notification, or %NULL @@ -86644,23 +87179,22 @@ its parameter. c:identifier="g_notification_set_category" version="2.70"> Sets the type of @notification to @category. Categories have a main + filename="gio/gnotification.c" + line="364">Sets the type of @notification to @category. Categories have a main type like `email`, `im` or `device` and can have a detail separated by a `.`, e.g. `im.received` or `email.arrived`. Setting the category helps the notification server to select proper feedback to the user. Standard categories are [listed in the specification](https://specifications.freedesktop.org/notification-spec/latest/ar01s06.html). - + a #GNotification + filename="gio/gnotification.c" + line="366">a #GNotification the category for @notification, or %NULL for no category + filename="gio/gnotification.c" + line="367">the category for @notification, or %NULL for no category @@ -86678,8 +87212,8 @@ Standard categories are [listed in the specification](https://specifications.fre c:identifier="g_notification_set_default_action" version="2.40"> Sets the default action of @notification to @detailed_action. This + filename="gio/gnotification.c" + line="643">Sets the default action of @notification to @detailed_action. This action is activated when the notification is clicked on. The action in @detailed_action must be an application-wide action (it @@ -86690,22 +87224,21 @@ for @detailed_action. When no default action is set, the application that the notification was sent on is activated. - + a #GNotification + filename="gio/gnotification.c" + line="645">a #GNotification a detailed action name + filename="gio/gnotification.c" + line="646">a detailed action name @@ -86716,8 +87249,8 @@ was sent on is activated. version="2.40" introspectable="0"> Sets the default action of @notification to @action. This action is + filename="gio/gnotification.c" + line="684">Sets the default action of @notification to @action. This action is activated when the notification is clicked on. It must be an application-wide action (it must start with "app."). @@ -86728,22 +87261,21 @@ parameter. When no default action is set, the application that the notification was sent on is activated. - + a #GNotification + filename="gio/gnotification.c" + line="686">a #GNotification an action name + filename="gio/gnotification.c" + line="687">an action name nullable="1" allow-none="1"> a #GVariant format string, or %NULL + filename="gio/gnotification.c" + line="688">a #GVariant format string, or %NULL positional parameters, as determined by @target_format + filename="gio/gnotification.c" + line="689">positional parameters, as determined by @target_format @@ -86768,8 +87300,8 @@ was sent on is activated. shadows="set_default_action_and_target" version="2.40"> Sets the default action of @notification to @action. This action is + filename="gio/gnotification.c" + line="724">Sets the default action of @notification to @action. This action is activated when the notification is clicked on. It must be an application-wide action (start with "app."). @@ -86778,22 +87310,21 @@ its parameter. If @target is floating, it will be consumed. When no default action is set, the application that the notification was sent on is activated. - + a #GNotification + filename="gio/gnotification.c" + line="726">a #GNotification an action name + filename="gio/gnotification.c" + line="727">an action name nullable="1" allow-none="1"> a #GVariant to use as @action's parameter, or %NULL + filename="gio/gnotification.c" + line="728">a #GVariant to use as @action's parameter, or %NULL @@ -86811,49 +87342,47 @@ was sent on is activated. c:identifier="g_notification_set_icon" version="2.40"> Sets the icon of @notification to @icon. - + filename="gio/gnotification.c" + line="285">Sets the icon of @notification to @icon. + a #GNotification + filename="gio/gnotification.c" + line="287">a #GNotification the icon to be shown in @notification, as a #GIcon + filename="gio/gnotification.c" + line="288">the icon to be shown in @notification, as a #GIcon Sets the priority of @notification to @priority. See + filename="gio/gnotification.c" + line="390">Sets the priority of @notification to @priority. See #GNotificationPriority for possible values. - + a #GNotification + filename="gio/gnotification.c" + line="392">a #GNotification a #GNotificationPriority + filename="gio/gnotification.c" + line="393">a #GNotificationPriority @@ -86862,24 +87391,23 @@ was sent on is activated. c:identifier="g_notification_set_title" version="2.40"> Sets the title of @notification to @title. - + filename="gio/gnotification.c" + line="207">Sets the title of @notification to @title. + a #GNotification + filename="gio/gnotification.c" + line="209">a #GNotification the new title for @notification + filename="gio/gnotification.c" + line="210">the new title for @notification @@ -86890,26 +87418,25 @@ was sent on is activated. deprecated="1" deprecated-version="2.42"> Deprecated in favor of g_notification_set_priority(). + filename="gio/gnotification.c" + line="322">Deprecated in favor of g_notification_set_priority(). Since 2.42, this has been deprecated in favour of g_notification_set_priority(). - + a #GNotification + filename="gio/gnotification.c" + line="324">a #GNotification %TRUE if @notification is urgent + filename="gio/gnotification.c" + line="325">%TRUE if @notification is urgent @@ -86921,16 +87448,16 @@ was sent on is activated. glib:get-type="g_notification_priority_get_type" c:type="GNotificationPriority"> Priority levels for #GNotifications. + filename="gio/gioenums.h" + line="2049">Priority levels for #GNotifications. the default priority, to be used for the + filename="gio/gioenums.h" + line="2054">the default priority, to be used for the majority of notifications (for example email messages, software updates, completed download/sync operations) @@ -86940,8 +87467,8 @@ was sent on is activated. glib:nick="low" glib:name="G_NOTIFICATION_PRIORITY_LOW"> for notifications that do not require + filename="gio/gioenums.h" + line="2051">for notifications that do not require immediate attention - typically used for contextual background information, such as contact birthdays or local weather @@ -86951,8 +87478,8 @@ was sent on is activated. glib:nick="high" glib:name="G_NOTIFICATION_PRIORITY_HIGH"> for events that require more attention, + filename="gio/gioenums.h" + line="2057">for events that require more attention, usually because responses are time-sensitive (for example chat and SMS messages or alarms) @@ -86962,8 +87489,8 @@ was sent on is activated. glib:nick="urgent" glib:name="G_NOTIFICATION_PRIORITY_URGENT"> for urgent notifications, or notifications + filename="gio/gioenums.h" + line="2060">for urgent notifications, or notifications that require a response in a short space of time (for example phone calls or emergency warnings) @@ -86971,8 +87498,7 @@ was sent on is activated. - + @@ -86981,8 +87507,7 @@ was sent on is activated. - + @@ -86991,8 +87516,7 @@ was sent on is activated. - + @@ -87000,45 +87524,44 @@ was sent on is activated. Structure used for scatter/gather data output when sending multiple + filename="gio/giotypes.h" + line="429">Structure used for scatter/gather data output when sending multiple messages or packets in one go. You generally pass in an array of #GOutputVectors and the operation will use all the buffers as if they were one buffer. If @address is %NULL then the message is sent to the default receiver (as previously set by g_socket_connect()). - + a #GSocketAddress, or %NULL + filename="gio/giotypes.h" + line="431">a #GSocketAddress, or %NULL pointer to an array of output vectors + filename="gio/giotypes.h" + line="432">pointer to an array of output vectors the number of output vectors pointed to by @vectors. + filename="gio/giotypes.h" + line="433">the number of output vectors pointed to by @vectors. initialize to 0. Will be set to the number of bytes + filename="gio/giotypes.h" + line="434">initialize to 0. Will be set to the number of bytes that have been sent a pointer + filename="gio/giotypes.h" + line="436">a pointer to an array of #GSocketControlMessages, or %NULL. @@ -87046,8 +87569,8 @@ If @address is %NULL then the message is sent to the default receiver number of elements in @control_messages. + filename="gio/giotypes.h" + line="438">number of elements in @control_messages. @@ -87060,24 +87583,31 @@ If @address is %NULL then the message is sent to the default receiver glib:get-type="g_output_stream_get_type" glib:type-struct="OutputStreamClass"> #GOutputStream has functions to write to a stream (g_output_stream_write()), -to close a stream (g_output_stream_close()) and to flush pending writes -(g_output_stream_flush()). + filename="gio/goutputstream.c" + line="35">`GOutputStream` is a base class for implementing streaming output. + +It has functions to write to a stream ([method@Gio.OutputStream.write]), +to close a stream ([method@Gio.OutputStream.close]) and to flush pending +writes ([method@Gio.OutputStream.flush]). To copy the content of an input stream to an output stream without -manually handling the reads and writes, use g_output_stream_splice(). +manually handling the reads and writes, use [method@Gio.OutputStream.splice]. -See the documentation for #GIOStream for details of thread safety of -streaming APIs. +See the documentation for [class@Gio.IOStream] for details of thread safety +of streaming APIs. -All of these functions have async variants too. - - +All of these functions have async variants too. + +All classes derived from `GOutputStream` *should* implement synchronous +writing, splicing, flushing and closing streams, but *may* implement +asynchronous versions. + + Requests an asynchronous close of the stream, releasing resources + filename="gio/goutputstream.c" + line="2004">Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_output_stream_close_finish() to get the result of the operation. @@ -87087,22 +87617,21 @@ For behaviour details see g_output_stream_close(). The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all. - + A #GOutputStream. + filename="gio/goutputstream.c" + line="2006">A #GOutputStream. the io priority of the request. + filename="gio/goutputstream.c" + line="2007">the io priority of the request. nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="2008">optional cancellable object scope="async" closure="3"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="2009">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/goutputstream.c" + line="2011">the data to pass to callback function Closes an output stream. - + filename="gio/goutputstream.c" + line="2108">Closes an output stream. + %TRUE if stream was successfully closed, %FALSE otherwise. + filename="gio/goutputstream.c" + line="2117">%TRUE if stream was successfully closed, %FALSE otherwise. a #GOutputStream. + filename="gio/goutputstream.c" + line="2110">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="2111">a #GAsyncResult. - + @@ -87182,10 +87710,13 @@ classes. However, if you override one you must override all. - + Forces a write of all user-space buffered data for the given + filename="gio/goutputstream.c" + line="655">Forces a write of all user-space buffered data for the given @stream. Will block during the operation. Closing the stream will implicitly cause a flush. @@ -87194,19 +87725,18 @@ This function is optional for inherited classes. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE on success, %FALSE on error + filename="gio/goutputstream.c" + line="671">%TRUE on success, %FALSE on error a #GOutputStream. + filename="gio/goutputstream.c" + line="657">a #GOutputStream. nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="658">optional cancellable object - + Forces an asynchronous write of all user-space buffered data for + filename="gio/goutputstream.c" + line="1844">Forces an asynchronous write of all user-space buffered data for the given @stream. For behaviour details see g_output_stream_flush(). When the operation is finished @callback will be called. You can then call g_output_stream_flush_finish() to get the result of the operation. - + a #GOutputStream. + filename="gio/goutputstream.c" + line="1846">a #GOutputStream. the io priority of the request. + filename="gio/goutputstream.c" + line="1847">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="1848">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/goutputstream.c" + line="1849">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/goutputstream.c" + line="1851">the data to pass to callback function Finishes flushing an output stream. - + filename="gio/goutputstream.c" + line="1899">Finishes flushing an output stream. + %TRUE if flush operation succeeded, %FALSE otherwise. + filename="gio/goutputstream.c" + line="1908">%TRUE if flush operation succeeded, %FALSE otherwise. a #GOutputStream. + filename="gio/goutputstream.c" + line="1901">a #GOutputStream. a GAsyncResult. + filename="gio/goutputstream.c" + line="1902">a GAsyncResult. - + Splices an input stream into an output stream. - + filename="gio/goutputstream.c" + line="705">Splices an input stream into an output stream. + a #gssize containing the size of the data spliced, or + filename="gio/goutputstream.c" + line="716">a #gssize containing the size of the data spliced, or -1 if an error occurred. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number @@ -87326,20 +87860,20 @@ result of the operation. a #GOutputStream. + filename="gio/goutputstream.c" + line="707">a #GOutputStream. a #GInputStream. + filename="gio/goutputstream.c" + line="708">a #GInputStream. a set of #GOutputStreamSpliceFlags. + filename="gio/goutputstream.c" + line="709">a set of #GOutputStreamSpliceFlags. @@ -87348,51 +87882,53 @@ result of the operation. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="710">optional #GCancellable object, %NULL to ignore. - + Splices a stream asynchronously. + filename="gio/goutputstream.c" + line="1725">Splices a stream asynchronously. When the operation is finished @callback will be called. You can then call g_output_stream_splice_finish() to get the result of the operation. For the synchronous, blocking version of this function, see g_output_stream_splice(). - + a #GOutputStream. + filename="gio/goutputstream.c" + line="1727">a #GOutputStream. a #GInputStream. + filename="gio/goutputstream.c" + line="1728">a #GInputStream. a set of #GOutputStreamSpliceFlags. + filename="gio/goutputstream.c" + line="1729">a set of #GOutputStreamSpliceFlags. the io priority of the request. + filename="gio/goutputstream.c" + line="1730">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="1731">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> a #GAsyncReadyCallback. + filename="gio/goutputstream.c" + line="1732">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> user data passed to @callback. + filename="gio/goutputstream.c" + line="1734">the data to pass to callback function Finishes an asynchronous stream splice operation. - + filename="gio/goutputstream.c" + line="1787">Finishes an asynchronous stream splice operation. + a #gssize of the number of bytes spliced. Note that if the + filename="gio/goutputstream.c" + line="1796">a #gssize of the number of bytes spliced. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number of bytes spliced. @@ -87445,22 +87981,24 @@ g_output_stream_splice(). a #GOutputStream. + filename="gio/goutputstream.c" + line="1789">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="1790">a #GAsyncResult. - + Request an asynchronous write of @count bytes from @buffer into + filename="gio/goutputstream.c" + line="975">Request an asynchronous write of @count bytes from @buffer into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_write_finish() to get the result of the operation. @@ -87495,16 +88033,15 @@ Note that no copy of @buffer will be made, so it must stay valid until @callback is called. See g_output_stream_write_bytes_async() for a #GBytes version that will automatically hold a reference to the contents (without copying) for the duration of the call. - + A #GOutputStream. + filename="gio/goutputstream.c" + line="977">A #GOutputStream. nullable="1" allow-none="1"> the buffer containing the data to write. + filename="gio/goutputstream.c" + line="978">the buffer containing the data to write. the number of bytes to write + filename="gio/goutputstream.c" + line="979">the number of bytes to write the io priority of the request. + filename="gio/goutputstream.c" + line="980">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="981">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="982">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/goutputstream.c" + line="984">the data to pass to callback function Finishes a stream write operation. - + filename="gio/goutputstream.c" + line="1071">Finishes a stream write operation. + a #gssize containing the number of bytes written to the stream. + filename="gio/goutputstream.c" + line="1080">a #gssize containing the number of bytes written to the stream. a #GOutputStream. + filename="gio/goutputstream.c" + line="1073">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="1074">a #GAsyncResult. Tries to write @count bytes from @buffer into the stream. Will block + filename="gio/goutputstream.c" + line="177">Tries to write @count bytes from @buffer into the stream. Will block during the operation. If count is 0, returns 0 and does nothing. A value of @count @@ -87612,19 +88149,18 @@ operation was partially finished when the operation was cancelled the partial result will be returned, without an error. On error -1 is returned and @error is set accordingly. - + Number of bytes written, or -1 on error + filename="gio/goutputstream.c" + line="206">Number of bytes written, or -1 on error a #GOutputStream. + filename="gio/goutputstream.c" + line="179">a #GOutputStream. nullable="1" allow-none="1"> the buffer containing the data to write. + filename="gio/goutputstream.c" + line="180">the buffer containing the data to write. the number of bytes to write + filename="gio/goutputstream.c" + line="181">the number of bytes to write nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="182">optional cancellable object + version="2.60" + glib:finish-func="writev_finish"> Request an asynchronous write of the bytes contained in @n_vectors @vectors into + filename="gio/goutputstream.c" + line="1281">Request an asynchronous write of the bytes contained in @n_vectors @vectors into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_writev_finish() to get the result of the operation. @@ -87690,22 +88227,21 @@ g_output_stream_writev(). Note that no copy of @vectors will be made, so it must stay valid until @callback is called. - + A #GOutputStream. + filename="gio/goutputstream.c" + line="1283">A #GOutputStream. the buffer containing the #GOutputVectors to write. + filename="gio/goutputstream.c" + line="1284">the buffer containing the #GOutputVectors to write. @@ -87714,14 +88250,14 @@ until @callback is called. the number of vectors to write + filename="gio/goutputstream.c" + line="1285">the number of vectors to write the I/O priority of the request. + filename="gio/goutputstream.c" + line="1286">the I/O priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="1287">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="1288">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="5"> the data to pass to callback function + filename="gio/goutputstream.c" + line="1290">the data to pass to callback function @@ -87761,27 +88298,26 @@ until @callback is called. version="2.60" throws="1"> Finishes a stream writev operation. - + filename="gio/goutputstream.c" + line="1347">Finishes a stream writev operation. + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="1357">%TRUE on success, %FALSE if there was an error a #GOutputStream. + filename="gio/goutputstream.c" + line="1349">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="1350">a #GAsyncResult. optional="1" allow-none="1"> location to store the number of bytes that were written to the stream + filename="gio/goutputstream.c" + line="1351">location to store the number of bytes that were written to the stream @@ -87802,8 +88338,8 @@ until @callback is called. version="2.60" throws="1"> Tries to write the bytes contained in the @n_vectors @vectors into the + filename="gio/goutputstream.c" + line="324">Tries to write the bytes contained in the @n_vectors @vectors into the stream. Will block during the operation. If @n_vectors is 0 or the sum of all bytes in @vectors is 0, returns 0 and @@ -87826,25 +88362,24 @@ Some implementations of g_output_stream_writev() may have limitations on the aggregate buffer size, and will return %G_IO_ERROR_INVALID_ARGUMENT if these are exceeded. For example, when writing to a local file on UNIX platforms, the aggregate buffer size must not exceed %G_MAXSSIZE bytes. - + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="358">%TRUE on success, %FALSE if there was an error a #GOutputStream. + filename="gio/goutputstream.c" + line="326">a #GOutputStream. the buffer containing the #GOutputVectors to write. + filename="gio/goutputstream.c" + line="327">the buffer containing the #GOutputVectors to write. @@ -87853,8 +88388,8 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. the number of vectors to write + filename="gio/goutputstream.c" + line="328">the number of vectors to write optional="1" allow-none="1"> location to store the number of bytes that were + filename="gio/goutputstream.c" + line="329">location to store the number of bytes that were written to the stream @@ -87874,8 +88409,8 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="331">optional cancellable object @@ -87883,26 +88418,28 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. Clears the pending flag on @stream. - + filename="gio/goutputstream.c" + line="2226">Clears the pending flag on @stream. + output stream + filename="gio/goutputstream.c" + line="2228">output stream - + Closes the stream, releasing resources related to it. + filename="gio/goutputstream.c" + line="887">Closes the stream, releasing resources related to it. Once the stream is closed, all other operations will return %G_IO_ERROR_CLOSED. Closing a stream multiple times will not return an error. @@ -87931,19 +88468,18 @@ Cancelling a close will still leave the stream closed, but there some streams can use a faster close that doesn't block to e.g. check errors. On cancellation (as with any error) there is no guarantee that all written data will reach the target. - + %TRUE on success, %FALSE on failure + filename="gio/goutputstream.c" + line="923">%TRUE on success, %FALSE on failure A #GOutputStream. + filename="gio/goutputstream.c" + line="889">A #GOutputStream. nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="890">optional cancellable object - + Requests an asynchronous close of the stream, releasing resources + filename="gio/goutputstream.c" + line="2004">Requests an asynchronous close of the stream, releasing resources related to it. When the operation is finished @callback will be called. You can then call g_output_stream_close_finish() to get the result of the operation. @@ -87970,22 +88509,21 @@ For behaviour details see g_output_stream_close(). The asynchronous methods have a default fallback that uses threads to implement asynchronicity, so they are optional for inheriting classes. However, if you override one you must override all. - + A #GOutputStream. + filename="gio/goutputstream.c" + line="2006">A #GOutputStream. the io priority of the request. + filename="gio/goutputstream.c" + line="2007">the io priority of the request. nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="2008">optional cancellable object scope="async" closure="3"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="2009">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/goutputstream.c" + line="2011">the data to pass to callback function @@ -88023,35 +88562,37 @@ classes. However, if you override one you must override all. c:identifier="g_output_stream_close_finish" throws="1"> Closes an output stream. - + filename="gio/goutputstream.c" + line="2108">Closes an output stream. + %TRUE if stream was successfully closed, %FALSE otherwise. + filename="gio/goutputstream.c" + line="2117">%TRUE if stream was successfully closed, %FALSE otherwise. a #GOutputStream. + filename="gio/goutputstream.c" + line="2110">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="2111">a #GAsyncResult. - + Forces a write of all user-space buffered data for the given + filename="gio/goutputstream.c" + line="655">Forces a write of all user-space buffered data for the given @stream. Will block during the operation. Closing the stream will implicitly cause a flush. @@ -88060,19 +88601,18 @@ This function is optional for inherited classes. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE on success, %FALSE on error + filename="gio/goutputstream.c" + line="671">%TRUE on success, %FALSE on error a #GOutputStream. + filename="gio/goutputstream.c" + line="657">a #GOutputStream. nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="658">optional cancellable object - + Forces an asynchronous write of all user-space buffered data for + filename="gio/goutputstream.c" + line="1844">Forces an asynchronous write of all user-space buffered data for the given @stream. For behaviour details see g_output_stream_flush(). When the operation is finished @callback will be called. You can then call g_output_stream_flush_finish() to get the result of the operation. - + a #GOutputStream. + filename="gio/goutputstream.c" + line="1846">a #GOutputStream. the io priority of the request. + filename="gio/goutputstream.c" + line="1847">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="1848">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/goutputstream.c" + line="1849">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/goutputstream.c" + line="1851">the data to pass to callback function @@ -88149,69 +88692,66 @@ result of the operation. c:identifier="g_output_stream_flush_finish" throws="1"> Finishes flushing an output stream. - + filename="gio/goutputstream.c" + line="1899">Finishes flushing an output stream. + %TRUE if flush operation succeeded, %FALSE otherwise. + filename="gio/goutputstream.c" + line="1908">%TRUE if flush operation succeeded, %FALSE otherwise. a #GOutputStream. + filename="gio/goutputstream.c" + line="1901">a #GOutputStream. a GAsyncResult. + filename="gio/goutputstream.c" + line="1902">a GAsyncResult. Checks if an output stream has pending actions. - + filename="gio/goutputstream.c" + line="2171">Checks if an output stream has pending actions. + %TRUE if @stream has pending actions. + filename="gio/goutputstream.c" + line="2177">%TRUE if @stream has pending actions. a #GOutputStream. + filename="gio/goutputstream.c" + line="2173">a #GOutputStream. Checks if an output stream has already been closed. - + filename="gio/goutputstream.c" + line="2134">Checks if an output stream has already been closed. + %TRUE if @stream is closed. %FALSE otherwise. + filename="gio/goutputstream.c" + line="2140">%TRUE if @stream is closed. %FALSE otherwise. a #GOutputStream. + filename="gio/goutputstream.c" + line="2136">a #GOutputStream. @@ -88220,24 +88760,23 @@ result of the operation. c:identifier="g_output_stream_is_closing" version="2.24"> Checks if an output stream is being closed. This can be + filename="gio/goutputstream.c" + line="2150">Checks if an output stream is being closed. This can be used inside e.g. a flush implementation to see if the flush (or other i/o operation) is called from within the closing operation. - + %TRUE if @stream is being closed. %FALSE otherwise. + filename="gio/goutputstream.c" + line="2159">%TRUE if @stream is being closed. %FALSE otherwise. a #GOutputStream. + filename="gio/goutputstream.c" + line="2152">a #GOutputStream. @@ -88247,8 +88786,8 @@ the closing operation. version="2.40" introspectable="0"> This is a utility function around g_output_stream_write_all(). It + filename="gio/goutputstream.c" + line="519">This is a utility function around g_output_stream_write_all(). It uses g_strdup_vprintf() to turn @format and @... into a string that is then written to @stream. @@ -88260,19 +88799,18 @@ function due to the variable length of the written string, if you need precise control over partial write failures, you need to create you own printf()-like wrapper around g_output_stream_write() or g_output_stream_write_all(). - + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="544">%TRUE on success, %FALSE if there was an error a #GOutputStream. + filename="gio/goutputstream.c" + line="521">a #GOutputStream. optional="1" allow-none="1"> location to store the number of bytes that was + filename="gio/goutputstream.c" + line="522">location to store the number of bytes that was written to the stream @@ -88292,26 +88830,26 @@ or g_output_stream_write_all(). nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="524">optional #GCancellable object, %NULL to ignore. location to store the error occurring, or %NULL to ignore + filename="gio/goutputstream.c" + line="525">location to store the error occurring, or %NULL to ignore the format string. See the printf() documentation + filename="gio/goutputstream.c" + line="526">the format string. See the printf() documentation the parameters to insert into the format string + filename="gio/goutputstream.c" + line="527">the parameters to insert into the format string @@ -88320,37 +88858,38 @@ or g_output_stream_write_all(). c:identifier="g_output_stream_set_pending" throws="1"> Sets @stream to have actions pending. If the pending flag is + filename="gio/goutputstream.c" + line="2187">Sets @stream to have actions pending. If the pending flag is already set or @stream is closed, it will return %FALSE and set @error. - + %TRUE if pending was previously unset and is now set. + filename="gio/goutputstream.c" + line="2197">%TRUE if pending was previously unset and is now set. a #GOutputStream. + filename="gio/goutputstream.c" + line="2189">a #GOutputStream. - + Splices an input stream into an output stream. - + filename="gio/goutputstream.c" + line="705">Splices an input stream into an output stream. + a #gssize containing the size of the data spliced, or + filename="gio/goutputstream.c" + line="716">a #gssize containing the size of the data spliced, or -1 if an error occurred. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number @@ -88360,20 +88899,20 @@ already set or @stream is closed, it will return %FALSE and set a #GOutputStream. + filename="gio/goutputstream.c" + line="707">a #GOutputStream. a #GInputStream. + filename="gio/goutputstream.c" + line="708">a #GInputStream. a set of #GOutputStreamSpliceFlags. + filename="gio/goutputstream.c" + line="709">a set of #GOutputStreamSpliceFlags. @@ -88382,51 +88921,53 @@ already set or @stream is closed, it will return %FALSE and set nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="710">optional #GCancellable object, %NULL to ignore. - + Splices a stream asynchronously. + filename="gio/goutputstream.c" + line="1725">Splices a stream asynchronously. When the operation is finished @callback will be called. You can then call g_output_stream_splice_finish() to get the result of the operation. For the synchronous, blocking version of this function, see g_output_stream_splice(). - + a #GOutputStream. + filename="gio/goutputstream.c" + line="1727">a #GOutputStream. a #GInputStream. + filename="gio/goutputstream.c" + line="1728">a #GInputStream. a set of #GOutputStreamSpliceFlags. + filename="gio/goutputstream.c" + line="1729">a set of #GOutputStreamSpliceFlags. the io priority of the request. + filename="gio/goutputstream.c" + line="1730">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="1731">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> a #GAsyncReadyCallback. + filename="gio/goutputstream.c" + line="1732">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/goutputstream.c" + line="1734">the data to pass to callback function @@ -88464,14 +89006,13 @@ g_output_stream_splice(). c:identifier="g_output_stream_splice_finish" throws="1"> Finishes an asynchronous stream splice operation. - + filename="gio/goutputstream.c" + line="1787">Finishes an asynchronous stream splice operation. + a #gssize of the number of bytes spliced. Note that if the + filename="gio/goutputstream.c" + line="1796">a #gssize of the number of bytes spliced. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number of bytes spliced. @@ -88480,14 +89021,14 @@ g_output_stream_splice(). a #GOutputStream. + filename="gio/goutputstream.c" + line="1789">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="1790">a #GAsyncResult. @@ -88497,8 +89038,8 @@ g_output_stream_splice(). version="2.40" introspectable="0"> This is a utility function around g_output_stream_write_all(). It + filename="gio/goutputstream.c" + line="565">This is a utility function around g_output_stream_write_all(). It uses g_strdup_vprintf() to turn @format and @args into a string that is then written to @stream. @@ -88510,19 +89051,18 @@ function due to the variable length of the written string, if you need precise control over partial write failures, you need to create you own printf()-like wrapper around g_output_stream_write() or g_output_stream_write_all(). - + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="590">%TRUE on success, %FALSE if there was an error a #GOutputStream. + filename="gio/goutputstream.c" + line="567">a #GOutputStream. optional="1" allow-none="1"> location to store the number of bytes that was + filename="gio/goutputstream.c" + line="568">location to store the number of bytes that was written to the stream @@ -88542,34 +89082,37 @@ or g_output_stream_write_all(). nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="570">optional #GCancellable object, %NULL to ignore. location to store the error occurring, or %NULL to ignore + filename="gio/goutputstream.c" + line="571">location to store the error occurring, or %NULL to ignore the format string. See the printf() documentation + filename="gio/goutputstream.c" + line="572">the format string. See the printf() documentation the parameters to insert into the format string + filename="gio/goutputstream.c" + line="573">the parameters to insert into the format string - + Tries to write @count bytes from @buffer into the stream. Will block + filename="gio/goutputstream.c" + line="177">Tries to write @count bytes from @buffer into the stream. Will block during the operation. If count is 0, returns 0 and does nothing. A value of @count @@ -88589,33 +89132,32 @@ operation was partially finished when the operation was cancelled the partial result will be returned, without an error. On error -1 is returned and @error is set accordingly. - + Number of bytes written, or -1 on error + filename="gio/goutputstream.c" + line="206">Number of bytes written, or -1 on error a #GOutputStream. + filename="gio/goutputstream.c" + line="179">a #GOutputStream. the buffer containing the data to write. + filename="gio/goutputstream.c" + line="180">the buffer containing the data to write. the number of bytes to write + filename="gio/goutputstream.c" + line="181">the number of bytes to write nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="182">optional cancellable object + throws="1" + glib:async-func="write_all_async"> Tries to write @count bytes from @buffer into the stream. Will block + filename="gio/goutputstream.c" + line="256">Tries to write @count bytes from @buffer into the stream. Will block during the operation. This function is similar to g_output_stream_write(), except it tries to @@ -88653,33 +89196,32 @@ successfully written before the error was encountered. This functionality is only available from C. If you need it from another language then you must write your own loop around g_output_stream_write(). - + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="286">%TRUE on success, %FALSE if there was an error a #GOutputStream. + filename="gio/goutputstream.c" + line="258">a #GOutputStream. the buffer containing the data to write. + filename="gio/goutputstream.c" + line="259">the buffer containing the data to write. the number of bytes to write + filename="gio/goutputstream.c" + line="260">the number of bytes to write optional="1" allow-none="1"> location to store the number of bytes that was + filename="gio/goutputstream.c" + line="261">location to store the number of bytes that was written to the stream @@ -88699,18 +89241,20 @@ g_output_stream_write(). nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="263">optional #GCancellable object, %NULL to ignore. + version="2.44" + glib:finish-func="write_all_finish" + glib:sync-func="write_all"> Request an asynchronous write of @count bytes from @buffer into + filename="gio/goutputstream.c" + line="1170">Request an asynchronous write of @count bytes from @buffer into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_write_all_finish() to get the result of the operation. @@ -88725,36 +89269,35 @@ priority. Default priority is %G_PRIORITY_DEFAULT. Note that no copy of @buffer will be made, so it must stay valid until @callback is called. - + A #GOutputStream + filename="gio/goutputstream.c" + line="1172">A #GOutputStream the buffer containing the data to write + filename="gio/goutputstream.c" + line="1173">the buffer containing the data to write the number of bytes to write + filename="gio/goutputstream.c" + line="1174">the number of bytes to write the io priority of the request + filename="gio/goutputstream.c" + line="1175">the io priority of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/goutputstream.c" + line="1176">optional #GCancellable object, %NULL to ignore scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="1177">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/goutputstream.c" + line="1179">the data to pass to callback function @@ -88793,8 +89337,8 @@ until @callback is called. version="2.44" throws="1"> Finishes an asynchronous stream write operation started with + filename="gio/goutputstream.c" + line="1236">Finishes an asynchronous stream write operation started with g_output_stream_write_all_async(). As a special exception to the normal conventions for functions that @@ -88804,25 +89348,24 @@ successfully written before the error was encountered. This functionality is only available from C. If you need it from another language then you must write your own loop around g_output_stream_write_async(). - + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="1254">%TRUE on success, %FALSE if there was an error a #GOutputStream + filename="gio/goutputstream.c" + line="1238">a #GOutputStream a #GAsyncResult + filename="gio/goutputstream.c" + line="1239">a #GAsyncResult optional="1" allow-none="1"> location to store the number of bytes that was written to the stream + filename="gio/goutputstream.c" + line="1240">location to store the number of bytes that was written to the stream - + Request an asynchronous write of @count bytes from @buffer into + filename="gio/goutputstream.c" + line="975">Request an asynchronous write of @count bytes from @buffer into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_write_finish() to get the result of the operation. @@ -88876,36 +89422,35 @@ Note that no copy of @buffer will be made, so it must stay valid until @callback is called. See g_output_stream_write_bytes_async() for a #GBytes version that will automatically hold a reference to the contents (without copying) for the duration of the call. - + A #GOutputStream. + filename="gio/goutputstream.c" + line="977">A #GOutputStream. the buffer containing the data to write. + filename="gio/goutputstream.c" + line="978">the buffer containing the data to write. the number of bytes to write + filename="gio/goutputstream.c" + line="979">the number of bytes to write the io priority of the request. + filename="gio/goutputstream.c" + line="980">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="981">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="982">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/goutputstream.c" + line="984">the data to pass to callback function + throws="1" + glib:async-func="write_bytes_async"> A wrapper function for g_output_stream_write() which takes a + filename="gio/goutputstream.c" + line="617">A wrapper function for g_output_stream_write() which takes a #GBytes as input. This can be more convenient for use by language bindings or in other cases where the refcounted nature of #GBytes is helpful over a bare pointer interface. @@ -88955,25 +89502,24 @@ writing, you will need to create a new #GBytes containing just the remaining bytes, using g_bytes_new_from_bytes(). Passing the same #GBytes instance multiple times potentially can result in duplicated data in the output stream. - + Number of bytes written, or -1 on error + filename="gio/goutputstream.c" + line="636">Number of bytes written, or -1 on error a #GOutputStream. + filename="gio/goutputstream.c" + line="619">a #GOutputStream. the #GBytes to write + filename="gio/goutputstream.c" + line="620">the #GBytes to write nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="621">optional cancellable object + c:identifier="g_output_stream_write_bytes_async" + glib:finish-func="write_bytes_finish" + glib:sync-func="write_bytes"> This function is similar to g_output_stream_write_async(), but + filename="gio/goutputstream.c" + line="1624">This function is similar to g_output_stream_write_async(), but takes a #GBytes as input. Due to the refcounted nature of #GBytes, this allows the stream to avoid taking a copy of the data. @@ -89004,28 +89552,27 @@ data in the output stream. For the synchronous, blocking version of this function, see g_output_stream_write_bytes(). - + A #GOutputStream. + filename="gio/goutputstream.c" + line="1626">A #GOutputStream. The bytes to write + filename="gio/goutputstream.c" + line="1627">The bytes to write the io priority of the request. + filename="gio/goutputstream.c" + line="1628">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="1629">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="1630">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/goutputstream.c" + line="1632">the data to pass to callback function @@ -89063,27 +89611,26 @@ g_output_stream_write_bytes(). c:identifier="g_output_stream_write_bytes_finish" throws="1"> Finishes a stream write-from-#GBytes operation. - + filename="gio/goutputstream.c" + line="1675">Finishes a stream write-from-#GBytes operation. + a #gssize containing the number of bytes written to the stream. + filename="gio/goutputstream.c" + line="1684">a #gssize containing the number of bytes written to the stream. a #GOutputStream. + filename="gio/goutputstream.c" + line="1677">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="1678">a #GAsyncResult. @@ -89092,27 +89639,26 @@ g_output_stream_write_bytes(). c:identifier="g_output_stream_write_finish" throws="1"> Finishes a stream write operation. - + filename="gio/goutputstream.c" + line="1071">Finishes a stream write operation. + a #gssize containing the number of bytes written to the stream. + filename="gio/goutputstream.c" + line="1080">a #gssize containing the number of bytes written to the stream. a #GOutputStream. + filename="gio/goutputstream.c" + line="1073">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="1074">a #GAsyncResult. @@ -89120,10 +89666,11 @@ g_output_stream_write_bytes(). + throws="1" + glib:async-func="writev_async"> Tries to write the bytes contained in the @n_vectors @vectors into the + filename="gio/goutputstream.c" + line="324">Tries to write the bytes contained in the @n_vectors @vectors into the stream. Will block during the operation. If @n_vectors is 0 or the sum of all bytes in @vectors is 0, returns 0 and @@ -89146,25 +89693,24 @@ Some implementations of g_output_stream_writev() may have limitations on the aggregate buffer size, and will return %G_IO_ERROR_INVALID_ARGUMENT if these are exceeded. For example, when writing to a local file on UNIX platforms, the aggregate buffer size must not exceed %G_MAXSSIZE bytes. - + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="358">%TRUE on success, %FALSE if there was an error a #GOutputStream. + filename="gio/goutputstream.c" + line="326">a #GOutputStream. the buffer containing the #GOutputVectors to write. + filename="gio/goutputstream.c" + line="327">the buffer containing the #GOutputVectors to write. @@ -89173,8 +89719,8 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. the number of vectors to write + filename="gio/goutputstream.c" + line="328">the number of vectors to write optional="1" allow-none="1"> location to store the number of bytes that were + filename="gio/goutputstream.c" + line="329">location to store the number of bytes that were written to the stream @@ -89194,8 +89740,8 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="331">optional cancellable object @@ -89203,10 +89749,11 @@ the aggregate buffer size must not exceed %G_MAXSSIZE bytes. + throws="1" + glib:async-func="writev_all_async"> Tries to write the bytes contained in the @n_vectors @vectors into the + filename="gio/goutputstream.c" + line="411">Tries to write the bytes contained in the @n_vectors @vectors into the stream. Will block during the operation. This function is similar to g_output_stream_writev(), except it tries to @@ -89228,33 +89775,32 @@ g_output_stream_write(). The content of the individual elements of @vectors might be changed by this function. - + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="444">%TRUE on success, %FALSE if there was an error a #GOutputStream. + filename="gio/goutputstream.c" + line="413">a #GOutputStream. the buffer containing the #GOutputVectors to write. + filename="gio/goutputstream.c" + line="414">the buffer containing the #GOutputVectors to write. the number of vectors to write + filename="gio/goutputstream.c" + line="415">the number of vectors to write optional="1" allow-none="1"> location to store the number of bytes that were + filename="gio/goutputstream.c" + line="416">location to store the number of bytes that were written to the stream @@ -89274,18 +89820,20 @@ function. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="418">optional #GCancellable object, %NULL to ignore. + version="2.60" + glib:finish-func="writev_all_finish" + glib:sync-func="writev_all"> Request an asynchronous write of the bytes contained in the @n_vectors @vectors into + filename="gio/goutputstream.c" + line="1476">Request an asynchronous write of the bytes contained in the @n_vectors @vectors into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_writev_all_finish() to get the result of the operation. @@ -89301,36 +89849,35 @@ priority. Default priority is %G_PRIORITY_DEFAULT. Note that no copy of @vectors will be made, so it must stay valid until @callback is called. The content of the individual elements of @vectors might be changed by this function. - + A #GOutputStream + filename="gio/goutputstream.c" + line="1478">A #GOutputStream the buffer containing the #GOutputVectors to write. + filename="gio/goutputstream.c" + line="1479">the buffer containing the #GOutputVectors to write. the number of vectors to write + filename="gio/goutputstream.c" + line="1480">the number of vectors to write the I/O priority of the request + filename="gio/goutputstream.c" + line="1481">the I/O priority of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/goutputstream.c" + line="1482">optional #GCancellable object, %NULL to ignore scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="1483">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/goutputstream.c" + line="1485">the data to pass to callback function @@ -89369,8 +89917,8 @@ of @vectors might be changed by this function. version="2.60" throws="1"> Finishes an asynchronous stream write operation started with + filename="gio/goutputstream.c" + line="1560">Finishes an asynchronous stream write operation started with g_output_stream_writev_all_async(). As a special exception to the normal conventions for functions that @@ -89380,25 +89928,24 @@ successfully written before the error was encountered. This functionality is only available from C. If you need it from another language then you must write your own loop around g_output_stream_writev_async(). - + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="1578">%TRUE on success, %FALSE if there was an error a #GOutputStream + filename="gio/goutputstream.c" + line="1562">a #GOutputStream a #GAsyncResult + filename="gio/goutputstream.c" + line="1563">a #GAsyncResult optional="1" allow-none="1"> location to store the number of bytes that were written to the stream + filename="gio/goutputstream.c" + line="1564">location to store the number of bytes that were written to the stream + version="2.60" + glib:finish-func="writev_finish" + glib:sync-func="writev"> Request an asynchronous write of the bytes contained in @n_vectors @vectors into + filename="gio/goutputstream.c" + line="1281">Request an asynchronous write of the bytes contained in @n_vectors @vectors into the stream. When the operation is finished @callback will be called. You can then call g_output_stream_writev_finish() to get the result of the operation. @@ -89449,22 +89998,21 @@ g_output_stream_writev(). Note that no copy of @vectors will be made, so it must stay valid until @callback is called. - + A #GOutputStream. + filename="gio/goutputstream.c" + line="1283">A #GOutputStream. the buffer containing the #GOutputVectors to write. + filename="gio/goutputstream.c" + line="1284">the buffer containing the #GOutputVectors to write. @@ -89473,14 +90021,14 @@ until @callback is called. the number of vectors to write + filename="gio/goutputstream.c" + line="1285">the number of vectors to write the I/O priority of the request. + filename="gio/goutputstream.c" + line="1286">the I/O priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="1287">optional #GCancellable object, %NULL to ignore. scope="async" closure="5"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="1288">a #GAsyncReadyCallback + to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="gio/goutputstream.c" + line="1290">the data to pass to callback function @@ -89519,27 +90068,26 @@ until @callback is called. version="2.60" throws="1"> Finishes a stream writev operation. - + filename="gio/goutputstream.c" + line="1347">Finishes a stream writev operation. + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="1357">%TRUE on success, %FALSE if there was an error a #GOutputStream. + filename="gio/goutputstream.c" + line="1349">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="1350">a #GAsyncResult. optional="1" allow-none="1"> location to store the number of bytes that were written to the stream + filename="gio/goutputstream.c" + line="1351">location to store the number of bytes that were written to the stream @@ -89565,26 +90113,24 @@ until @callback is called. - + - + Number of bytes written, or -1 on error + filename="gio/goutputstream.c" + line="206">Number of bytes written, or -1 on error a #GOutputStream. + filename="gio/goutputstream.c" + line="179">a #GOutputStream. nullable="1" allow-none="1"> the buffer containing the data to write. + filename="gio/goutputstream.c" + line="180">the buffer containing the data to write. the number of bytes to write + filename="gio/goutputstream.c" + line="181">the number of bytes to write nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="182">optional cancellable object @@ -89618,12 +90164,11 @@ until @callback is called. - + a #gssize containing the size of the data spliced, or + filename="gio/goutputstream.c" + line="716">a #gssize containing the size of the data spliced, or -1 if an error occurred. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number @@ -89633,20 +90178,20 @@ until @callback is called. a #GOutputStream. + filename="gio/goutputstream.c" + line="707">a #GOutputStream. a #GInputStream. + filename="gio/goutputstream.c" + line="708">a #GInputStream. a set of #GOutputStreamSpliceFlags. + filename="gio/goutputstream.c" + line="709">a set of #GOutputStreamSpliceFlags. @@ -89655,8 +90200,8 @@ until @callback is called. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="710">optional #GCancellable object, %NULL to ignore. @@ -89664,19 +90209,18 @@ until @callback is called. - + %TRUE on success, %FALSE on error + filename="gio/goutputstream.c" + line="671">%TRUE on success, %FALSE on error a #GOutputStream. + filename="gio/goutputstream.c" + line="657">a #GOutputStream. nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="658">optional cancellable object @@ -89693,8 +90237,7 @@ until @callback is called. - + @@ -89713,16 +90256,15 @@ until @callback is called. - + A #GOutputStream. + filename="gio/goutputstream.c" + line="977">A #GOutputStream. nullable="1" allow-none="1"> the buffer containing the data to write. + filename="gio/goutputstream.c" + line="978">the buffer containing the data to write. the number of bytes to write + filename="gio/goutputstream.c" + line="979">the number of bytes to write the io priority of the request. + filename="gio/goutputstream.c" + line="980">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="981">optional #GCancellable object, %NULL to ignore. scope="async" closure="6"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="982">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="6"> the data to pass to callback function + filename="gio/goutputstream.c" + line="984">the data to pass to callback function @@ -89783,25 +90326,24 @@ until @callback is called. - + a #gssize containing the number of bytes written to the stream. + filename="gio/goutputstream.c" + line="1080">a #gssize containing the number of bytes written to the stream. a #GOutputStream. + filename="gio/goutputstream.c" + line="1073">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="1074">a #GAsyncResult. @@ -89809,35 +90351,34 @@ until @callback is called. - + a #GOutputStream. + filename="gio/goutputstream.c" + line="1727">a #GOutputStream. a #GInputStream. + filename="gio/goutputstream.c" + line="1728">a #GInputStream. a set of #GOutputStreamSpliceFlags. + filename="gio/goutputstream.c" + line="1729">a set of #GOutputStreamSpliceFlags. the io priority of the request. + filename="gio/goutputstream.c" + line="1730">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="1731">optional #GCancellable object, %NULL to ignore. scope="async" closure="6"> a #GAsyncReadyCallback. + filename="gio/goutputstream.c" + line="1732">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="6"> user data passed to @callback. + filename="gio/goutputstream.c" + line="1734">the data to pass to callback function @@ -89875,12 +90417,11 @@ until @callback is called. - + a #gssize of the number of bytes spliced. Note that if the + filename="gio/goutputstream.c" + line="1796">a #gssize of the number of bytes spliced. Note that if the number of bytes spliced is greater than %G_MAXSSIZE, then that will be returned, and there is no way to determine the actual number of bytes spliced. @@ -89889,14 +90430,14 @@ until @callback is called. a #GOutputStream. + filename="gio/goutputstream.c" + line="1789">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="1790">a #GAsyncResult. @@ -89904,22 +90445,21 @@ until @callback is called. - + a #GOutputStream. + filename="gio/goutputstream.c" + line="1846">a #GOutputStream. the io priority of the request. + filename="gio/goutputstream.c" + line="1847">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="1848">optional #GCancellable object, %NULL to ignore. scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/goutputstream.c" + line="1849">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/goutputstream.c" + line="1851">the data to pass to callback function @@ -89957,25 +90498,24 @@ until @callback is called. - + %TRUE if flush operation succeeded, %FALSE otherwise. + filename="gio/goutputstream.c" + line="1908">%TRUE if flush operation succeeded, %FALSE otherwise. a #GOutputStream. + filename="gio/goutputstream.c" + line="1901">a #GOutputStream. a GAsyncResult. + filename="gio/goutputstream.c" + line="1902">a GAsyncResult. @@ -89983,22 +90523,21 @@ until @callback is called. - + A #GOutputStream. + filename="gio/goutputstream.c" + line="2006">A #GOutputStream. the io priority of the request. + filename="gio/goutputstream.c" + line="2007">the io priority of the request. nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="2008">optional cancellable object scope="async" closure="4"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="2009">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="4"> the data to pass to callback function + filename="gio/goutputstream.c" + line="2011">the data to pass to callback function @@ -90036,25 +90576,24 @@ until @callback is called. - + %TRUE if stream was successfully closed, %FALSE otherwise. + filename="gio/goutputstream.c" + line="2117">%TRUE if stream was successfully closed, %FALSE otherwise. a #GOutputStream. + filename="gio/goutputstream.c" + line="2110">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="2111">a #GAsyncResult. @@ -90062,25 +90601,24 @@ until @callback is called. - + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="358">%TRUE on success, %FALSE if there was an error a #GOutputStream. + filename="gio/goutputstream.c" + line="326">a #GOutputStream. the buffer containing the #GOutputVectors to write. + filename="gio/goutputstream.c" + line="327">the buffer containing the #GOutputVectors to write. @@ -90089,8 +90627,8 @@ until @callback is called. the number of vectors to write + filename="gio/goutputstream.c" + line="328">the number of vectors to write optional="1" allow-none="1"> location to store the number of bytes that were + filename="gio/goutputstream.c" + line="329">location to store the number of bytes that were written to the stream @@ -90110,8 +90648,8 @@ until @callback is called. nullable="1" allow-none="1"> optional cancellable object + filename="gio/goutputstream.c" + line="331">optional cancellable object @@ -90119,22 +90657,21 @@ until @callback is called. - + A #GOutputStream. + filename="gio/goutputstream.c" + line="1283">A #GOutputStream. the buffer containing the #GOutputVectors to write. + filename="gio/goutputstream.c" + line="1284">the buffer containing the #GOutputVectors to write. @@ -90143,14 +90680,14 @@ until @callback is called. the number of vectors to write + filename="gio/goutputstream.c" + line="1285">the number of vectors to write the I/O priority of the request. + filename="gio/goutputstream.c" + line="1286">the I/O priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/goutputstream.c" + line="1287">optional #GCancellable object, %NULL to ignore. scope="async" closure="6"> callback to call when the request is satisfied + filename="gio/goutputstream.c" + line="1288">a #GAsyncReadyCallback + to call when the request is satisfied allow-none="1" closure="6"> the data to pass to callback function + filename="gio/goutputstream.c" + line="1290">the data to pass to callback function @@ -90188,25 +90726,24 @@ until @callback is called. - + %TRUE on success, %FALSE if there was an error + filename="gio/goutputstream.c" + line="1357">%TRUE on success, %FALSE if there was an error a #GOutputStream. + filename="gio/goutputstream.c" + line="1349">a #GOutputStream. a #GAsyncResult. + filename="gio/goutputstream.c" + line="1350">a #GAsyncResult. optional="1" allow-none="1"> location to store the number of bytes that were written to the stream + filename="gio/goutputstream.c" + line="1351">location to store the number of bytes that were written to the stream @@ -90225,8 +90762,7 @@ until @callback is called. - + @@ -90234,8 +90770,7 @@ until @callback is called. - + @@ -90243,8 +90778,7 @@ until @callback is called. - + @@ -90252,8 +90786,7 @@ until @callback is called. - + @@ -90261,8 +90794,7 @@ until @callback is called. - + @@ -90273,24 +90805,23 @@ until @callback is called. c:type="GOutputStreamPrivate" disguised="1" opaque="1"> - + GOutputStreamSpliceFlags determine how streams should be spliced. + filename="gio/gioenums.h" + line="655">GOutputStreamSpliceFlags determine how streams should be spliced. Do not close either stream. + filename="gio/gioenums.h" + line="657">Do not close either stream. glib:nick="close-source" glib:name="G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE"> Close the source stream after + filename="gio/gioenums.h" + line="658">Close the source stream after the splice. glib:nick="close-target" glib:name="G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET"> Close the target stream after + filename="gio/gioenums.h" + line="660">Close the target stream after the splice. Structure used for scatter/gather data output. + filename="gio/giotypes.h" + line="410">Structure used for scatter/gather data output. You generally pass in an array of #GOutputVectors and the operation will use all the buffers as if they were one buffer. - + Pointer to a buffer of data to read. + filename="gio/giotypes.h" + line="412">Pointer to a buffer of data to read. the size of @buffer. + filename="gio/giotypes.h" + line="413">the size of @buffer. - + @@ -90348,8 +90877,7 @@ one buffer. - + @@ -90358,8 +90886,7 @@ one buffer. - + @@ -90368,8 +90895,7 @@ one buffer. - + @@ -90378,8 +90904,7 @@ one buffer. - + @@ -90388,8 +90913,7 @@ one buffer. - + @@ -90398,8 +90922,7 @@ one buffer. - + @@ -90408,8 +90931,7 @@ one buffer. - + @@ -90420,18 +90942,16 @@ one buffer. c:type="G_POWER_PROFILE_MONITOR_EXTENSION_POINT_NAME" version="2.70"> Extension point for power profile usage monitoring functionality. See [Extending GIO][extending-gio]. - + - + @@ -90440,16 +90960,14 @@ See [Extending GIO][extending-gio]. - + - + @@ -90458,8 +90976,7 @@ See [Extending GIO][extending-gio]. - + @@ -90468,8 +90985,7 @@ See [Extending GIO][extending-gio]. - + @@ -90478,8 +90994,7 @@ See [Extending GIO][extending-gio]. - + @@ -90488,8 +91003,7 @@ See [Extending GIO][extending-gio]. - + @@ -90498,8 +91012,7 @@ See [Extending GIO][extending-gio]. - + @@ -90508,8 +91021,7 @@ See [Extending GIO][extending-gio]. - + @@ -90520,18 +91032,16 @@ See [Extending GIO][extending-gio]. c:type="G_PROXY_EXTENSION_POINT_NAME" version="2.26"> Extension point for proxy functionality. See [Extending GIO][extending-gio]. - + - + @@ -90540,8 +91050,7 @@ See [Extending GIO][extending-gio]. - + @@ -90551,18 +91060,16 @@ See [Extending GIO][extending-gio]. value="gio-proxy-resolver" c:type="G_PROXY_RESOLVER_EXTENSION_POINT_NAME"> Extension point for proxy resolving functionality. See [Extending GIO][extending-gio]. - + - + @@ -90573,8 +91080,8 @@ See [Extending GIO][extending-gio]. glib:get-type="g_password_save_get_type" c:type="GPasswordSave"> #GPasswordSave is used to indicate the lifespan of a saved password. + filename="gio/gioenums.h" + line="618">#GPasswordSave is used to indicate the lifespan of a saved password. #Gvfs stores passwords in the Gnome keyring when this flag allows it to, and later retrieves it again from there. @@ -90584,8 +91091,8 @@ to, and later retrieves it again from there. glib:nick="never" glib:name="G_PASSWORD_SAVE_NEVER"> never save a password. + filename="gio/gioenums.h" + line="620">never save a password. glib:nick="for-session" glib:name="G_PASSWORD_SAVE_FOR_SESSION"> save a password for the session. + filename="gio/gioenums.h" + line="621">save a password for the session. glib:nick="permanently" glib:name="G_PASSWORD_SAVE_PERMANENTLY"> save a password permanently. + filename="gio/gioenums.h" + line="622">save a password permanently. glib:get-type="g_permission_get_type" glib:type-struct="PermissionClass"> A #GPermission represents the status of the caller's permission to + filename="gio/gpermission.c" + line="33">A `GPermission` represents the status of the caller’s permission to perform a certain action. You can query if the action is currently allowed and if it is @@ -90626,20 +91133,20 @@ in the future. There is also an API to actually acquire the permission and one to release it. -As an example, a #GPermission might represent the ability for the -user to write to a #GSettings object. This #GPermission object could -then be used to decide if it is appropriate to show a "Click here to -unlock" button in a dialog and to provide the mechanism to invoke +As an example, a `GPermission` might represent the ability for the +user to write to a [class@Gio.Settings] object. This `GPermission` object +could then be used to decide if it is appropriate to show a “Click here to +unlock” button in a dialog and to provide the mechanism to invoke when that button is clicked. - + + throws="1" + glib:async-func="acquire_async"> Attempts to acquire the permission represented by @permission. + filename="gio/gpermission.c" + line="69">Attempts to acquire the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. A simple example is @@ -90654,19 +91161,18 @@ If the permission is acquired then %TRUE is returned. Otherwise, This call is blocking, likely for a very long time (in the case that user interaction is required). See g_permission_acquire_async() for the non-blocking version. - + %TRUE if the permission was successfully acquired + filename="gio/gpermission.c" + line="91">%TRUE if the permission was successfully acquired a #GPermission instance + filename="gio/gpermission.c" + line="71">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="72">a #GCancellable, or %NULL + version="2.26" + glib:finish-func="acquire_finish" + glib:sync-func="acquire"> Attempts to acquire the permission represented by @permission. + filename="gio/gpermission.c" + line="105">Attempts to acquire the permission represented by @permission. This is the first half of the asynchronous version of g_permission_acquire(). - + a #GPermission instance + filename="gio/gpermission.c" + line="107">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="108">a #GCancellable, or %NULL scope="async" closure="2"> the #GAsyncReadyCallback to call when done + filename="gio/gpermission.c" + line="109">the #GAsyncReadyCallback to call when done allow-none="1" closure="2"> the user data to pass to @callback + filename="gio/gpermission.c" + line="110">the user data to pass to @callback @@ -90738,31 +91245,30 @@ g_permission_acquire(). version="2.26" throws="1"> Collects the result of attempting to acquire the permission + filename="gio/gpermission.c" + line="130">Collects the result of attempting to acquire the permission represented by @permission. This is the second half of the asynchronous version of g_permission_acquire(). - + %TRUE if the permission was successfully acquired + filename="gio/gpermission.c" + line="142">%TRUE if the permission was successfully acquired a #GPermission instance + filename="gio/gpermission.c" + line="132">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + filename="gio/gpermission.c" + line="133">the #GAsyncResult given to the #GAsyncReadyCallback @@ -90770,10 +91276,11 @@ g_permission_acquire(). + throws="1" + glib:async-func="release_async"> Attempts to release the permission represented by @permission. + filename="gio/gpermission.c" + line="156">Attempts to release the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. In most cases the @@ -90788,19 +91295,18 @@ If the permission is released then %TRUE is returned. Otherwise, This call is blocking, likely for a very long time (in the case that user interaction is required). See g_permission_release_async() for the non-blocking version. - + %TRUE if the permission was successfully released + filename="gio/gpermission.c" + line="178">%TRUE if the permission was successfully released a #GPermission instance + filename="gio/gpermission.c" + line="158">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="159">a #GCancellable, or %NULL + version="2.26" + glib:finish-func="release_finish" + glib:sync-func="release"> Attempts to release the permission represented by @permission. + filename="gio/gpermission.c" + line="192">Attempts to release the permission represented by @permission. This is the first half of the asynchronous version of g_permission_release(). - + a #GPermission instance + filename="gio/gpermission.c" + line="194">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="195">a #GCancellable, or %NULL scope="async" closure="2"> the #GAsyncReadyCallback to call when done + filename="gio/gpermission.c" + line="196">the #GAsyncReadyCallback to call when done allow-none="1" closure="2"> the user data to pass to @callback + filename="gio/gpermission.c" + line="197">the user data to pass to @callback @@ -90872,31 +91379,30 @@ g_permission_release(). version="2.26" throws="1"> Collects the result of attempting to release the permission + filename="gio/gpermission.c" + line="217">Collects the result of attempting to release the permission represented by @permission. This is the second half of the asynchronous version of g_permission_release(). - + %TRUE if the permission was successfully released + filename="gio/gpermission.c" + line="229">%TRUE if the permission was successfully released a #GPermission instance + filename="gio/gpermission.c" + line="219">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + filename="gio/gpermission.c" + line="220">the #GAsyncResult given to the #GAsyncReadyCallback @@ -90904,10 +91410,11 @@ g_permission_release(). + throws="1" + glib:async-func="acquire_async"> Attempts to acquire the permission represented by @permission. + filename="gio/gpermission.c" + line="69">Attempts to acquire the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. A simple example is @@ -90922,19 +91429,18 @@ If the permission is acquired then %TRUE is returned. Otherwise, This call is blocking, likely for a very long time (in the case that user interaction is required). See g_permission_acquire_async() for the non-blocking version. - + %TRUE if the permission was successfully acquired + filename="gio/gpermission.c" + line="91">%TRUE if the permission was successfully acquired a #GPermission instance + filename="gio/gpermission.c" + line="71">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="72">a #GCancellable, or %NULL + version="2.26" + glib:finish-func="acquire_finish" + glib:sync-func="acquire"> Attempts to acquire the permission represented by @permission. + filename="gio/gpermission.c" + line="105">Attempts to acquire the permission represented by @permission. This is the first half of the asynchronous version of g_permission_acquire(). - + a #GPermission instance + filename="gio/gpermission.c" + line="107">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="108">a #GCancellable, or %NULL scope="async" closure="2"> the #GAsyncReadyCallback to call when done + filename="gio/gpermission.c" + line="109">the #GAsyncReadyCallback to call when done nullable="1" allow-none="1"> the user data to pass to @callback + filename="gio/gpermission.c" + line="110">the user data to pass to @callback @@ -91005,31 +91512,30 @@ g_permission_acquire(). version="2.26" throws="1"> Collects the result of attempting to acquire the permission + filename="gio/gpermission.c" + line="130">Collects the result of attempting to acquire the permission represented by @permission. This is the second half of the asynchronous version of g_permission_acquire(). - + %TRUE if the permission was successfully acquired + filename="gio/gpermission.c" + line="142">%TRUE if the permission was successfully acquired a #GPermission instance + filename="gio/gpermission.c" + line="132">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + filename="gio/gpermission.c" + line="133">the #GAsyncResult given to the #GAsyncReadyCallback @@ -91039,23 +91545,22 @@ g_permission_acquire(). glib:get-property="allowed" version="2.26"> Gets the value of the 'allowed' property. This property is %TRUE if + filename="gio/gpermission.c" + line="243">Gets the value of the 'allowed' property. This property is %TRUE if the caller currently has permission to perform the action that @permission represents the permission to perform. - + the value of the 'allowed' property + filename="gio/gpermission.c" + line="251">the value of the 'allowed' property a #GPermission instance + filename="gio/gpermission.c" + line="245">a #GPermission instance @@ -91065,23 +91570,22 @@ the caller currently has permission to perform the action that glib:get-property="can-acquire" version="2.26"> Gets the value of the 'can-acquire' property. This property is %TRUE + filename="gio/gpermission.c" + line="262">Gets the value of the 'can-acquire' property. This property is %TRUE if it is generally possible to acquire the permission by calling g_permission_acquire(). - + the value of the 'can-acquire' property + filename="gio/gpermission.c" + line="270">the value of the 'can-acquire' property a #GPermission instance + filename="gio/gpermission.c" + line="264">a #GPermission instance @@ -91091,23 +91595,22 @@ g_permission_acquire(). glib:get-property="can-release" version="2.26"> Gets the value of the 'can-release' property. This property is %TRUE + filename="gio/gpermission.c" + line="281">Gets the value of the 'can-release' property. This property is %TRUE if it is generally possible to release the permission by calling g_permission_release(). - + the value of the 'can-release' property + filename="gio/gpermission.c" + line="289">the value of the 'can-release' property a #GPermission instance + filename="gio/gpermission.c" + line="283">a #GPermission instance @@ -91116,40 +91619,39 @@ g_permission_release(). c:identifier="g_permission_impl_update" version="2.26"> This function is called by the #GPermission implementation to update + filename="gio/gpermission.c" + line="300">This function is called by the #GPermission implementation to update the properties of the permission. You should never call this function except from a #GPermission implementation. GObject notify signals are generated, as appropriate. - + a #GPermission instance + filename="gio/gpermission.c" + line="302">a #GPermission instance the new value for the 'allowed' property + filename="gio/gpermission.c" + line="303">the new value for the 'allowed' property the new value for the 'can-acquire' property + filename="gio/gpermission.c" + line="304">the new value for the 'can-acquire' property the new value for the 'can-release' property + filename="gio/gpermission.c" + line="305">the new value for the 'can-release' property @@ -91157,10 +91659,11 @@ GObject notify signals are generated, as appropriate. + throws="1" + glib:async-func="release_async"> Attempts to release the permission represented by @permission. + filename="gio/gpermission.c" + line="156">Attempts to release the permission represented by @permission. The precise method by which this happens depends on the permission and the underlying authentication mechanism. In most cases the @@ -91175,19 +91678,18 @@ If the permission is released then %TRUE is returned. Otherwise, This call is blocking, likely for a very long time (in the case that user interaction is required). See g_permission_release_async() for the non-blocking version. - + %TRUE if the permission was successfully released + filename="gio/gpermission.c" + line="178">%TRUE if the permission was successfully released a #GPermission instance + filename="gio/gpermission.c" + line="158">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="159">a #GCancellable, or %NULL + version="2.26" + glib:finish-func="release_finish" + glib:sync-func="release"> Attempts to release the permission represented by @permission. + filename="gio/gpermission.c" + line="192">Attempts to release the permission represented by @permission. This is the first half of the asynchronous version of g_permission_release(). - + a #GPermission instance + filename="gio/gpermission.c" + line="194">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="195">a #GCancellable, or %NULL scope="async" closure="2"> the #GAsyncReadyCallback to call when done + filename="gio/gpermission.c" + line="196">the #GAsyncReadyCallback to call when done nullable="1" allow-none="1"> the user data to pass to @callback + filename="gio/gpermission.c" + line="197">the user data to pass to @callback @@ -91258,31 +91761,30 @@ g_permission_release(). version="2.26" throws="1"> Collects the result of attempting to release the permission + filename="gio/gpermission.c" + line="217">Collects the result of attempting to release the permission represented by @permission. This is the second half of the asynchronous version of g_permission_release(). - + %TRUE if the permission was successfully released + filename="gio/gpermission.c" + line="229">%TRUE if the permission was successfully released a #GPermission instance + filename="gio/gpermission.c" + line="219">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + filename="gio/gpermission.c" + line="220">the #GAsyncResult given to the #GAsyncReadyCallback @@ -91292,8 +91794,8 @@ g_permission_release(). getter="get_allowed" default-value="FALSE"> %TRUE if the caller currently has permission to perform the action that + filename="gio/gpermission.c" + line="429">%TRUE if the caller currently has permission to perform the action that @permission represents the permission to perform. @@ -91302,8 +91804,8 @@ g_permission_release(). getter="get_can_acquire" default-value="FALSE"> %TRUE if it is generally possible to acquire the permission by calling + filename="gio/gpermission.c" + line="440">%TRUE if it is generally possible to acquire the permission by calling g_permission_acquire(). @@ -91312,8 +91814,8 @@ g_permission_acquire(). getter="get_can_release" default-value="FALSE"> %TRUE if it is generally possible to release the permission by calling + filename="gio/gpermission.c" + line="451">%TRUE if it is generally possible to release the permission by calling g_permission_release(). @@ -91327,26 +91829,24 @@ g_permission_release(). - + - + %TRUE if the permission was successfully acquired + filename="gio/gpermission.c" + line="91">%TRUE if the permission was successfully acquired a #GPermission instance + filename="gio/gpermission.c" + line="71">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="72">a #GCancellable, or %NULL @@ -91363,16 +91863,15 @@ g_permission_release(). - + a #GPermission instance + filename="gio/gpermission.c" + line="107">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="108">a #GCancellable, or %NULL scope="async" closure="3"> the #GAsyncReadyCallback to call when done + filename="gio/gpermission.c" + line="109">the #GAsyncReadyCallback to call when done allow-none="1" closure="3"> the user data to pass to @callback + filename="gio/gpermission.c" + line="110">the user data to pass to @callback @@ -91410,25 +91909,24 @@ g_permission_release(). - + %TRUE if the permission was successfully acquired + filename="gio/gpermission.c" + line="142">%TRUE if the permission was successfully acquired a #GPermission instance + filename="gio/gpermission.c" + line="132">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + filename="gio/gpermission.c" + line="133">the #GAsyncResult given to the #GAsyncReadyCallback @@ -91436,19 +91934,18 @@ g_permission_release(). - + %TRUE if the permission was successfully released + filename="gio/gpermission.c" + line="178">%TRUE if the permission was successfully released a #GPermission instance + filename="gio/gpermission.c" + line="158">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="159">a #GCancellable, or %NULL @@ -91465,16 +91962,15 @@ g_permission_release(). - + a #GPermission instance + filename="gio/gpermission.c" + line="194">a #GPermission instance nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpermission.c" + line="195">a #GCancellable, or %NULL scope="async" closure="3"> the #GAsyncReadyCallback to call when done + filename="gio/gpermission.c" + line="196">the #GAsyncReadyCallback to call when done allow-none="1" closure="3"> the user data to pass to @callback + filename="gio/gpermission.c" + line="197">the user data to pass to @callback @@ -91512,25 +92008,24 @@ g_permission_release(). - + %TRUE if the permission was successfully released + filename="gio/gpermission.c" + line="229">%TRUE if the permission was successfully released a #GPermission instance + filename="gio/gpermission.c" + line="219">a #GPermission instance the #GAsyncResult given to the #GAsyncReadyCallback + filename="gio/gpermission.c" + line="220">the #GAsyncResult given to the #GAsyncReadyCallback @@ -91546,8 +92041,7 @@ g_permission_release(). c:type="GPermissionPrivate" disguised="1" opaque="1"> - + glib:get-type="g_pollable_input_stream_get_type" glib:type-struct="PollableInputStreamInterface"> #GPollableInputStream is implemented by #GInputStreams that + filename="gio/gpollableinputstream.c" + line="29">`GPollableInputStream` is implemented by [class@Gio.InputStream]s that can be polled for readiness to read. This can be used when interfacing with a non-GIO API that expects UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. -Some classes may implement #GPollableInputStream but have only certain -instances of that class be pollable. If g_pollable_input_stream_can_poll() -returns %FALSE, then the behavior of other #GPollableInputStream methods is +Some classes may implement `GPollableInputStream` but have only certain +instances of that class be pollable. If [method@Gio.PollableInputStream.can_poll] +returns false, then the behavior of other `GPollableInputStream` methods is undefined. - + Checks if @stream is actually pollable. Some classes may implement + filename="gio/gpollableinputstream.c" + line="66">Checks if @stream is actually pollable. Some classes may implement #GPollableInputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableInputStream methods is undefined. For any given stream, the value returned by this method is constant; a stream cannot switch from pollable to non-pollable or vice versa. - + %TRUE if @stream is pollable, %FALSE if not. + filename="gio/gpollableinputstream.c" + line="78">%TRUE if @stream is pollable, %FALSE if not. a #GPollableInputStream. + filename="gio/gpollableinputstream.c" + line="68">a #GPollableInputStream. @@ -91601,8 +92093,8 @@ a stream cannot switch from pollable to non-pollable or vice versa. invoker="create_source" version="2.28"> Creates a #GSource that triggers when @stream can be read, or + filename="gio/gpollableinputstream.c" + line="121">Creates a #GSource that triggers when @stream can be read, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -91613,19 +92105,18 @@ rather than g_input_stream_read() from the callback. The behaviour of this method is undefined if g_pollable_input_stream_can_poll() returns %FALSE for @stream. - + a new #GSource + filename="gio/gpollableinputstream.c" + line="138">a new #GSource a #GPollableInputStream. + filename="gio/gpollableinputstream.c" + line="123">a #GPollableInputStream. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpollableinputstream.c" + line="124">a #GCancellable, or %NULL Checks if @stream can be read. + filename="gio/gpollableinputstream.c" + line="90">Checks if @stream can be read. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_input_stream_read() @@ -91653,12 +92144,11 @@ g_pollable_input_stream_read_nonblocking(), which will return a The behaviour of this method is undefined if g_pollable_input_stream_can_poll() returns %FALSE for @stream. - + %TRUE if @stream is readable, %FALSE if not. If an error + filename="gio/gpollableinputstream.c" + line="106">%TRUE if @stream is readable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_input_stream_is_readable() returning %TRUE, and the next attempt to read will return the error. @@ -91667,8 +92157,8 @@ g_pollable_input_stream_can_poll() returns %FALSE for @stream. a #GPollableInputStream. + filename="gio/gpollableinputstream.c" + line="92">a #GPollableInputStream. @@ -91677,8 +92167,8 @@ g_pollable_input_stream_can_poll() returns %FALSE for @stream. invoker="read_nonblocking" throws="1"> Attempts to read up to @count bytes from @stream into @buffer, as + filename="gio/gpollableinputstream.c" + line="169">Attempts to read up to @count bytes from @stream into @buffer, as with g_input_stream_read(). If @stream is not currently readable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_input_stream_create_source() to create a #GSource @@ -91692,20 +92182,19 @@ to having been cancelled. The behaviour of this method is undefined if g_pollable_input_stream_can_poll() returns %FALSE for @stream. - + the number of bytes read, or -1 on error (including + filename="gio/gpollableinputstream.c" + line="193">the number of bytes read, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). a #GPollableInputStream + filename="gio/gpollableinputstream.c" + line="171">a #GPollableInputStream transfer-ownership="none" nullable="1"> a + filename="gio/gpollableinputstream.c" + line="172">a buffer to read data into (which should be at least @count bytes long). @@ -91723,8 +92212,8 @@ g_pollable_input_stream_can_poll() returns %FALSE for @stream. the number of bytes you want to read + filename="gio/gpollableinputstream.c" + line="174">the number of bytes you want to read @@ -91733,27 +92222,26 @@ g_pollable_input_stream_can_poll() returns %FALSE for @stream. c:identifier="g_pollable_input_stream_can_poll" version="2.28"> Checks if @stream is actually pollable. Some classes may implement + filename="gio/gpollableinputstream.c" + line="66">Checks if @stream is actually pollable. Some classes may implement #GPollableInputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableInputStream methods is undefined. For any given stream, the value returned by this method is constant; a stream cannot switch from pollable to non-pollable or vice versa. - + %TRUE if @stream is pollable, %FALSE if not. + filename="gio/gpollableinputstream.c" + line="78">%TRUE if @stream is pollable, %FALSE if not. a #GPollableInputStream. + filename="gio/gpollableinputstream.c" + line="68">a #GPollableInputStream. @@ -91762,8 +92250,8 @@ a stream cannot switch from pollable to non-pollable or vice versa. c:identifier="g_pollable_input_stream_create_source" version="2.28"> Creates a #GSource that triggers when @stream can be read, or + filename="gio/gpollableinputstream.c" + line="121">Creates a #GSource that triggers when @stream can be read, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -91774,19 +92262,18 @@ rather than g_input_stream_read() from the callback. The behaviour of this method is undefined if g_pollable_input_stream_can_poll() returns %FALSE for @stream. - + a new #GSource + filename="gio/gpollableinputstream.c" + line="138">a new #GSource a #GPollableInputStream. + filename="gio/gpollableinputstream.c" + line="123">a #GPollableInputStream. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpollableinputstream.c" + line="124">a #GCancellable, or %NULL @@ -91804,8 +92291,8 @@ g_pollable_input_stream_can_poll() returns %FALSE for @stream. c:identifier="g_pollable_input_stream_is_readable" version="2.28"> Checks if @stream can be read. + filename="gio/gpollableinputstream.c" + line="90">Checks if @stream can be read. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_input_stream_read() @@ -91816,12 +92303,11 @@ g_pollable_input_stream_read_nonblocking(), which will return a The behaviour of this method is undefined if g_pollable_input_stream_can_poll() returns %FALSE for @stream. - + %TRUE if @stream is readable, %FALSE if not. If an error + filename="gio/gpollableinputstream.c" + line="106">%TRUE if @stream is readable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_input_stream_is_readable() returning %TRUE, and the next attempt to read will return the error. @@ -91830,8 +92316,8 @@ g_pollable_input_stream_can_poll() returns %FALSE for @stream. a #GPollableInputStream. + filename="gio/gpollableinputstream.c" + line="92">a #GPollableInputStream. @@ -91840,8 +92326,8 @@ g_pollable_input_stream_can_poll() returns %FALSE for @stream. c:identifier="g_pollable_input_stream_read_nonblocking" throws="1"> Attempts to read up to @count bytes from @stream into @buffer, as + filename="gio/gpollableinputstream.c" + line="169">Attempts to read up to @count bytes from @stream into @buffer, as with g_input_stream_read(). If @stream is not currently readable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_input_stream_create_source() to create a #GSource @@ -91855,20 +92341,19 @@ to having been cancelled. The behaviour of this method is undefined if g_pollable_input_stream_can_poll() returns %FALSE for @stream. - + the number of bytes read, or -1 on error (including + filename="gio/gpollableinputstream.c" + line="193">the number of bytes read, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). a #GPollableInputStream + filename="gio/gpollableinputstream.c" + line="171">a #GPollableInputStream caller-allocates="1" transfer-ownership="none"> a + filename="gio/gpollableinputstream.c" + line="172">a buffer to read data into (which should be at least @count bytes long). @@ -91885,8 +92370,8 @@ g_pollable_input_stream_can_poll() returns %FALSE for @stream. the number of bytes you want to read + filename="gio/gpollableinputstream.c" + line="174">the number of bytes you want to read nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpollableinputstream.c" + line="175">a #GCancellable, or %NULL @@ -91906,8 +92391,8 @@ g_pollable_input_stream_can_poll() returns %FALSE for @stream. glib:is-gtype-struct-for="PollableInputStream" version="2.28"> The interface for pollable input streams. + filename="gio/gpollableinputstream.h" + line="39">The interface for pollable input streams. The default implementation of @can_poll always returns %TRUE. @@ -91917,42 +92402,45 @@ g_input_stream_read() if it returns %TRUE. This means you only need to override it if it is possible that your @is_readable implementation may return %TRUE when the stream is not actually readable. - + The parent interface. + filename="gio/gpollableinputstream.h" + line="41">The parent interface. + Checks if the #GPollableInputStream instance is actually pollable - + %TRUE if @stream is pollable, %FALSE if not. + filename="gio/gpollableinputstream.c" + line="78">%TRUE if @stream is pollable, %FALSE if not. a #GPollableInputStream. + filename="gio/gpollableinputstream.c" + line="68">a #GPollableInputStream. + Checks if the stream is readable - + %TRUE if @stream is readable, %FALSE if not. If an error + filename="gio/gpollableinputstream.c" + line="106">%TRUE if @stream is readable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_input_stream_is_readable() returning %TRUE, and the next attempt to read will return the error. @@ -91961,28 +92449,30 @@ readable. a #GPollableInputStream. + filename="gio/gpollableinputstream.c" + line="92">a #GPollableInputStream. + Creates a #GSource to poll the stream - + a new #GSource + filename="gio/gpollableinputstream.c" + line="138">a new #GSource a #GPollableInputStream. + filename="gio/gpollableinputstream.c" + line="123">a #GPollableInputStream. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpollableinputstream.c" + line="124">a #GCancellable, or %NULL + Does a non-blocking read or returns + %G_IO_ERROR_WOULD_BLOCK - + the number of bytes read, or -1 on error (including + filename="gio/gpollableinputstream.c" + line="193">the number of bytes read, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). a #GPollableInputStream + filename="gio/gpollableinputstream.c" + line="171">a #GPollableInputStream transfer-ownership="none" nullable="1"> a + filename="gio/gpollableinputstream.c" + line="172">a buffer to read data into (which should be at least @count bytes long). @@ -92030,8 +92523,8 @@ readable. the number of bytes you want to read + filename="gio/gpollableinputstream.c" + line="174">the number of bytes you want to read @@ -92046,42 +92539,40 @@ readable. glib:get-type="g_pollable_output_stream_get_type" glib:type-struct="PollableOutputStreamInterface"> #GPollableOutputStream is implemented by #GOutputStreams that + filename="gio/gpollableoutputstream.c" + line="30">`GPollableOutputStream` is implemented by [class@Gio.OutputStream]s that can be polled for readiness to write. This can be used when interfacing with a non-GIO API that expects UNIX-file-descriptor-style asynchronous I/O rather than GIO-style. -Some classes may implement #GPollableOutputStream but have only certain -instances of that class be pollable. If g_pollable_output_stream_can_poll() -returns %FALSE, then the behavior of other #GPollableOutputStream methods is +Some classes may implement `GPollableOutputStream` but have only certain +instances of that class be pollable. If [method@Gio.PollableOutputStream.can_poll] +returns false, then the behavior of other `GPollableOutputStream` methods is undefined. - + Checks if @stream is actually pollable. Some classes may implement + filename="gio/gpollableoutputstream.c" + line="73">Checks if @stream is actually pollable. Some classes may implement #GPollableOutputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableOutputStream methods is undefined. For any given stream, the value returned by this method is constant; a stream cannot switch from pollable to non-pollable or vice versa. - + %TRUE if @stream is pollable, %FALSE if not. + filename="gio/gpollableoutputstream.c" + line="85">%TRUE if @stream is pollable, %FALSE if not. a #GPollableOutputStream. + filename="gio/gpollableoutputstream.c" + line="75">a #GPollableOutputStream. @@ -92090,8 +92581,8 @@ a stream cannot switch from pollable to non-pollable or vice versa. invoker="create_source" version="2.28"> Creates a #GSource that triggers when @stream can be written, or + filename="gio/gpollableoutputstream.c" + line="128">Creates a #GSource that triggers when @stream can be written, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -92102,19 +92593,18 @@ rather than g_output_stream_write() from the callback. The behaviour of this method is undefined if g_pollable_output_stream_can_poll() returns %FALSE for @stream. - + a new #GSource + filename="gio/gpollableoutputstream.c" + line="145">a new #GSource a #GPollableOutputStream. + filename="gio/gpollableoutputstream.c" + line="130">a #GPollableOutputStream. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpollableoutputstream.c" + line="131">a #GCancellable, or %NULL Checks if @stream can be written. + filename="gio/gpollableoutputstream.c" + line="97">Checks if @stream can be written. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_output_stream_write() @@ -92142,12 +92632,11 @@ g_pollable_output_stream_write_nonblocking(), which will return a The behaviour of this method is undefined if g_pollable_output_stream_can_poll() returns %FALSE for @stream. - + %TRUE if @stream is writable, %FALSE if not. If an error + filename="gio/gpollableoutputstream.c" + line="113">%TRUE if @stream is writable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_output_stream_is_writable() returning %TRUE, and the next attempt to write will return the error. @@ -92156,8 +92645,8 @@ g_pollable_output_stream_can_poll() returns %FALSE for @stream. a #GPollableOutputStream. + filename="gio/gpollableoutputstream.c" + line="99">a #GPollableOutputStream. @@ -92166,8 +92655,8 @@ g_pollable_output_stream_can_poll() returns %FALSE for @stream. invoker="write_nonblocking" throws="1"> Attempts to write up to @count bytes from @buffer to @stream, as + filename="gio/gpollableoutputstream.c" + line="237">Attempts to write up to @count bytes from @buffer to @stream, as with g_output_stream_write(). If @stream is not currently writable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -92185,20 +92674,19 @@ transports like D/TLS require that you re-send the same @buffer and The behaviour of this method is undefined if g_pollable_output_stream_can_poll() returns %FALSE for @stream. - + the number of bytes written, or -1 on error (including + filename="gio/gpollableoutputstream.c" + line="265">the number of bytes written, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). a #GPollableOutputStream + filename="gio/gpollableoutputstream.c" + line="239">a #GPollableOutputStream nullable="1" allow-none="1"> a buffer to write + filename="gio/gpollableoutputstream.c" + line="240">a buffer to write data from @@ -92215,8 +92703,8 @@ g_pollable_output_stream_can_poll() returns %FALSE for @stream. the number of bytes you want to write + filename="gio/gpollableoutputstream.c" + line="242">the number of bytes you want to write @@ -92226,8 +92714,8 @@ g_pollable_output_stream_can_poll() returns %FALSE for @stream. version="2.60" throws="1"> Attempts to write the bytes contained in the @n_vectors @vectors to @stream, + filename="gio/gpollableoutputstream.c" + line="305">Attempts to write the bytes contained in the @n_vectors @vectors to @stream, as with g_output_stream_writev(). If @stream is not currently writable, this will immediately return %@G_POLLABLE_RETURN_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -92246,12 +92734,11 @@ transports like D/TLS require that you re-send the same @vectors and The behaviour of this method is undefined if g_pollable_output_stream_can_poll() returns %FALSE for @stream. - + %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK + filename="gio/gpollableoutputstream.c" + line="335">%@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK if the stream is not currently writable (and @error is *not* set), or %G_POLLABLE_RETURN_FAILED if there was an error in which case @error will be set. @@ -92260,14 +92747,14 @@ be set. a #GPollableOutputStream + filename="gio/gpollableoutputstream.c" + line="307">a #GPollableOutputStream the buffer containing the #GOutputVectors to write. + filename="gio/gpollableoutputstream.c" + line="308">the buffer containing the #GOutputVectors to write. @@ -92276,8 +92763,8 @@ be set. the number of vectors to write + filename="gio/gpollableoutputstream.c" + line="309">the number of vectors to write optional="1" allow-none="1"> location to store the number of bytes that were + filename="gio/gpollableoutputstream.c" + line="310">location to store the number of bytes that were written to the stream @@ -92298,27 +92785,26 @@ be set. c:identifier="g_pollable_output_stream_can_poll" version="2.28"> Checks if @stream is actually pollable. Some classes may implement + filename="gio/gpollableoutputstream.c" + line="73">Checks if @stream is actually pollable. Some classes may implement #GPollableOutputStream but have only certain instances of that class be pollable. If this method returns %FALSE, then the behavior of other #GPollableOutputStream methods is undefined. For any given stream, the value returned by this method is constant; a stream cannot switch from pollable to non-pollable or vice versa. - + %TRUE if @stream is pollable, %FALSE if not. + filename="gio/gpollableoutputstream.c" + line="85">%TRUE if @stream is pollable, %FALSE if not. a #GPollableOutputStream. + filename="gio/gpollableoutputstream.c" + line="75">a #GPollableOutputStream. @@ -92327,8 +92813,8 @@ a stream cannot switch from pollable to non-pollable or vice versa. c:identifier="g_pollable_output_stream_create_source" version="2.28"> Creates a #GSource that triggers when @stream can be written, or + filename="gio/gpollableoutputstream.c" + line="128">Creates a #GSource that triggers when @stream can be written, or @cancellable is triggered or an error occurs. The callback on the source is of the #GPollableSourceFunc type. @@ -92339,19 +92825,18 @@ rather than g_output_stream_write() from the callback. The behaviour of this method is undefined if g_pollable_output_stream_can_poll() returns %FALSE for @stream. - + a new #GSource + filename="gio/gpollableoutputstream.c" + line="145">a new #GSource a #GPollableOutputStream. + filename="gio/gpollableoutputstream.c" + line="130">a #GPollableOutputStream. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpollableoutputstream.c" + line="131">a #GCancellable, or %NULL @@ -92369,8 +92854,8 @@ g_pollable_output_stream_can_poll() returns %FALSE for @stream. c:identifier="g_pollable_output_stream_is_writable" version="2.28"> Checks if @stream can be written. + filename="gio/gpollableoutputstream.c" + line="97">Checks if @stream can be written. Note that some stream types may not be able to implement this 100% reliably, and it is possible that a call to g_output_stream_write() @@ -92381,12 +92866,11 @@ g_pollable_output_stream_write_nonblocking(), which will return a The behaviour of this method is undefined if g_pollable_output_stream_can_poll() returns %FALSE for @stream. - + %TRUE if @stream is writable, %FALSE if not. If an error + filename="gio/gpollableoutputstream.c" + line="113">%TRUE if @stream is writable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_output_stream_is_writable() returning %TRUE, and the next attempt to write will return the error. @@ -92395,8 +92879,8 @@ g_pollable_output_stream_can_poll() returns %FALSE for @stream. a #GPollableOutputStream. + filename="gio/gpollableoutputstream.c" + line="99">a #GPollableOutputStream. @@ -92405,8 +92889,8 @@ g_pollable_output_stream_can_poll() returns %FALSE for @stream. c:identifier="g_pollable_output_stream_write_nonblocking" throws="1"> Attempts to write up to @count bytes from @buffer to @stream, as + filename="gio/gpollableoutputstream.c" + line="237">Attempts to write up to @count bytes from @buffer to @stream, as with g_output_stream_write(). If @stream is not currently writable, this will immediately return %G_IO_ERROR_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -92424,26 +92908,25 @@ transports like D/TLS require that you re-send the same @buffer and The behaviour of this method is undefined if g_pollable_output_stream_can_poll() returns %FALSE for @stream. - + the number of bytes written, or -1 on error (including + filename="gio/gpollableoutputstream.c" + line="265">the number of bytes written, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). a #GPollableOutputStream + filename="gio/gpollableoutputstream.c" + line="239">a #GPollableOutputStream a buffer to write + filename="gio/gpollableoutputstream.c" + line="240">a buffer to write data from @@ -92451,8 +92934,8 @@ g_pollable_output_stream_can_poll() returns %FALSE for @stream. the number of bytes you want to write + filename="gio/gpollableoutputstream.c" + line="242">the number of bytes you want to write nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpollableoutputstream.c" + line="243">a #GCancellable, or %NULL @@ -92471,8 +92954,8 @@ g_pollable_output_stream_can_poll() returns %FALSE for @stream. version="2.60" throws="1"> Attempts to write the bytes contained in the @n_vectors @vectors to @stream, + filename="gio/gpollableoutputstream.c" + line="305">Attempts to write the bytes contained in the @n_vectors @vectors to @stream, as with g_output_stream_writev(). If @stream is not currently writable, this will immediately return %@G_POLLABLE_RETURN_WOULD_BLOCK, and you can use g_pollable_output_stream_create_source() to create a #GSource @@ -92491,12 +92974,11 @@ transports like D/TLS require that you re-send the same @vectors and The behaviour of this method is undefined if g_pollable_output_stream_can_poll() returns %FALSE for @stream. - + %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK + filename="gio/gpollableoutputstream.c" + line="335">%@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK if the stream is not currently writable (and @error is *not* set), or %G_POLLABLE_RETURN_FAILED if there was an error in which case @error will be set. @@ -92505,14 +92987,14 @@ be set. a #GPollableOutputStream + filename="gio/gpollableoutputstream.c" + line="307">a #GPollableOutputStream the buffer containing the #GOutputVectors to write. + filename="gio/gpollableoutputstream.c" + line="308">the buffer containing the #GOutputVectors to write. @@ -92521,8 +93003,8 @@ be set. the number of vectors to write + filename="gio/gpollableoutputstream.c" + line="309">the number of vectors to write optional="1" allow-none="1"> location to store the number of bytes that were + filename="gio/gpollableoutputstream.c" + line="310">location to store the number of bytes that were written to the stream @@ -92542,8 +93024,8 @@ be set. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpollableoutputstream.c" + line="312">a #GCancellable, or %NULL @@ -92554,8 +93036,8 @@ be set. glib:is-gtype-struct-for="PollableOutputStream" version="2.28"> The interface for pollable output streams. + filename="gio/gpollableoutputstream.h" + line="39">The interface for pollable output streams. The default implementation of @can_poll always returns %TRUE. @@ -92571,29 +93053,30 @@ g_pollable_output_stream_write_nonblocking() for each vector, and converts its return value and error (if set) to a #GPollableReturn. You should override this where possible to avoid having to allocate a #GError to return %G_IO_ERROR_WOULD_BLOCK. - + The parent interface. + filename="gio/gpollableoutputstream.h" + line="41">The parent interface. + Checks if the #GPollableOutputStream instance is actually pollable - + %TRUE if @stream is pollable, %FALSE if not. + filename="gio/gpollableoutputstream.c" + line="85">%TRUE if @stream is pollable, %FALSE if not. a #GPollableOutputStream. + filename="gio/gpollableoutputstream.c" + line="75">a #GPollableOutputStream. @@ -92601,13 +93084,15 @@ override this where possible to avoid having to allocate a #GError to return + Checks if the stream is writable - + %TRUE if @stream is writable, %FALSE if not. If an error + filename="gio/gpollableoutputstream.c" + line="113">%TRUE if @stream is writable, %FALSE if not. If an error has occurred on @stream, this will result in g_pollable_output_stream_is_writable() returning %TRUE, and the next attempt to write will return the error. @@ -92616,8 +93101,8 @@ override this where possible to avoid having to allocate a #GError to return a #GPollableOutputStream. + filename="gio/gpollableoutputstream.c" + line="99">a #GPollableOutputStream. @@ -92625,20 +93110,22 @@ override this where possible to avoid having to allocate a #GError to return + Creates a #GSource to poll the stream - + a new #GSource + filename="gio/gpollableoutputstream.c" + line="145">a new #GSource a #GPollableOutputStream. + filename="gio/gpollableoutputstream.c" + line="130">a #GPollableOutputStream. @@ -92647,29 +93134,32 @@ override this where possible to avoid having to allocate a #GError to return nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gpollableoutputstream.c" + line="131">a #GCancellable, or %NULL + Does a non-blocking write or returns + %G_IO_ERROR_WOULD_BLOCK - + the number of bytes written, or -1 on error (including + filename="gio/gpollableoutputstream.c" + line="265">the number of bytes written, or -1 on error (including %G_IO_ERROR_WOULD_BLOCK). a #GPollableOutputStream + filename="gio/gpollableoutputstream.c" + line="239">a #GPollableOutputStream @@ -92678,8 +93168,8 @@ override this where possible to avoid having to allocate a #GError to return nullable="1" allow-none="1"> a buffer to write + filename="gio/gpollableoutputstream.c" + line="240">a buffer to write data from @@ -92687,21 +93177,24 @@ override this where possible to avoid having to allocate a #GError to return the number of bytes you want to write + filename="gio/gpollableoutputstream.c" + line="242">the number of bytes you want to write + Does a vectored non-blocking write, or returns + %G_POLLABLE_RETURN_WOULD_BLOCK - + %@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK + filename="gio/gpollableoutputstream.c" + line="335">%@G_POLLABLE_RETURN_OK on success, %G_POLLABLE_RETURN_WOULD_BLOCK if the stream is not currently writable (and @error is *not* set), or %G_POLLABLE_RETURN_FAILED if there was an error in which case @error will be set. @@ -92710,15 +93203,15 @@ be set. a #GPollableOutputStream + filename="gio/gpollableoutputstream.c" + line="307">a #GPollableOutputStream the buffer containing the #GOutputVectors to write. + filename="gio/gpollableoutputstream.c" + line="308">the buffer containing the #GOutputVectors to write. @@ -92727,8 +93220,8 @@ be set. the number of vectors to write + filename="gio/gpollableoutputstream.c" + line="309">the number of vectors to write optional="1" allow-none="1"> location to store the number of bytes that were + filename="gio/gpollableoutputstream.c" + line="310">location to store the number of bytes that were written to the stream @@ -92753,8 +93246,8 @@ be set. glib:get-type="g_pollable_return_get_type" c:type="GPollableReturn"> Return value for various IO operations that signal errors via the + filename="gio/gioenums.h" + line="2099">Return value for various IO operations that signal errors via the return value and not necessarily via a #GError. This enum exists to be able to return errors to callers without having to @@ -92769,8 +93262,8 @@ operation to give details about the error that happened. glib:nick="failed" glib:name="G_POLLABLE_RETURN_FAILED"> Generic error condition for when an operation fails. + filename="gio/gioenums.h" + line="2101">Generic error condition for when an operation fails. glib:nick="ok" glib:name="G_POLLABLE_RETURN_OK"> The operation was successfully finished. + filename="gio/gioenums.h" + line="2102">The operation was successfully finished. glib:nick="would-block" glib:name="G_POLLABLE_RETURN_WOULD_BLOCK"> The operation would block. + filename="gio/gioenums.h" + line="2103">The operation would block. This is the function type of the callback used for the #GSource + filename="gio/giotypes.h" + line="499">This is the function type of the callback used for the #GSource returned by g_pollable_input_stream_create_source() and g_pollable_output_stream_create_source(). - + it should return %FALSE if the source should be removed. + filename="gio/giotypes.h" + line="508">it should return %FALSE if the source should be removed. the #GPollableInputStream or #GPollableOutputStream + filename="gio/giotypes.h" + line="501">the #GPollableInputStream or #GPollableOutputStream nullable="1" allow-none="1"> data passed in by the user. + filename="gio/giotypes.h" + line="502">data passed in by the user. @@ -92833,11 +93325,11 @@ g_pollable_output_stream_create_source(). glib:get-type="g_power_profile_monitor_get_type" glib:type-struct="PowerProfileMonitorInterface"> #GPowerProfileMonitor makes it possible for applications as well as OS components -to monitor system power profiles and act upon them. It currently only exports -whether the system is in “Power Saver” mode (known as “Low Power” mode on -some systems). + filename="gio/gpowerprofilemonitor.c" + line="34">`GPowerProfileMonitor` makes it possible for applications as well as OS +components to monitor system power profiles and act upon them. It currently +only exports whether the system is in “Power Saver” mode (known as +“Low Power” mode on some systems). When in “Low Power” mode, it is recommended that applications: - disable automatic downloads; @@ -92854,23 +93346,22 @@ monitor the battery discharge rate, `powertop` to check on the background activi or activity at all), `sysprof` to inspect CPU usage, and `intel_gpu_time` to profile GPU usage. -Don't forget to disconnect the #GPowerProfileMonitor::notify::power-saver-enabled -signal, and unref the #GPowerProfileMonitor itself when exiting. - +Don’t forget to disconnect the [signal@GObject.Object::notify] signal for +[property@Gio.PowerProfileMonitor:power-saver-enabled], and unref the +`GPowerProfileMonitor` itself when exiting. + Gets a reference to the default #GPowerProfileMonitor for the system. - + filename="gio/gpowerprofilemonitor.c" + line="77">Gets a reference to the default #GPowerProfileMonitor for the system. + a new reference to the default #GPowerProfileMonitor + filename="gio/gpowerprofilemonitor.c" + line="82">a new reference to the default #GPowerProfileMonitor @@ -92879,25 +93370,24 @@ signal, and unref the #GPowerProfileMonitor itself when exiting. glib:get-property="power-saver-enabled" version="2.70"> Gets whether the system is in “Power Saver” mode. + filename="gio/gpowerprofilemonitor.c" + line="94">Gets whether the system is in “Power Saver” mode. You are expected to listen to the #GPowerProfileMonitor::notify::power-saver-enabled signal to know when the profile has changed. - + Whether the system is in “Power Saver” mode. + filename="gio/gpowerprofilemonitor.c" + line="104">Whether the system is in “Power Saver” mode. a #GPowerProfileMonitor + filename="gio/gpowerprofilemonitor.c" + line="96">a #GPowerProfileMonitor @@ -92908,8 +93398,8 @@ changed. getter="get_power_saver_enabled" default-value="FALSE"> Whether “Power Saver” mode is enabled on the system. + filename="gio/gpowerprofilemonitor.c" + line="119">Whether “Power Saver” mode is enabled on the system. @@ -92918,14 +93408,13 @@ changed. glib:is-gtype-struct-for="PowerProfileMonitor" version="2.70"> The virtual function table for #GPowerProfileMonitor. - + filename="gio/gpowerprofilemonitor.c" + line="64">The virtual function table for #GPowerProfileMonitor. + The parent interface. + filename="gio/gpowerprofilemonitor.c" + line="66">The parent interface. @@ -92937,13 +93426,13 @@ changed. glib:type-name="GPropertyAction" glib:get-type="g_property_action_get_type"> A #GPropertyAction is a way to get a #GAction with a state value -reflecting and controlling the value of a #GObject property. + filename="gio/gpropertyaction.c" + line="30">A `GPropertyAction` is a way to get a [iface@Gio.Action] with a state value +reflecting and controlling the value of a [class@GObject.Object] property. The state of the action will correspond to the value of the property. Changing it will change the property (assuming the requested value -matches the requirements as specified in the #GParamSpec). +matches the requirements as specified in the [type@GObject.ParamSpec]). Only the most common types are presently supported. Booleans are mapped to booleans, strings to strings, signed/unsigned integers to @@ -92951,16 +93440,16 @@ int32/uint32 and floats and doubles to doubles. If the property is an enum then the state will be string-typed and conversion will automatically be performed between the enum value and -"nick" string as per the #GEnumValue table. +‘nick’ string as per the [type@GObject.EnumValue] table. Flags types are not currently supported. Properties of object types, boxed types and pointer types are not supported and probably never will be. -Properties of #GVariant types are not currently supported. +Properties of [type@GLib.Variant] types are not currently supported. -If the property is boolean-valued then the action will have a NULL +If the property is boolean-valued then the action will have a `NULL` parameter type, and activating the action (with no parameter) will toggle the value of the property. @@ -92969,33 +93458,34 @@ the property. The general idea here is to reduce the number of locations where a particular piece of state is kept (and therefore has to be synchronised -between). #GPropertyAction does not have a separate state that is kept -in sync with the property value -- its state is the property value. - -For example, it might be useful to create a #GAction corresponding to -the "visible-child-name" property of a #GtkStack so that the current -page can be switched from a menu. The active radio indication in the -menu is then directly determined from the active page of the -#GtkStack. - -An anti-example would be binding the "active-id" property on a -#GtkComboBox. This is because the state of the combobox itself is -probably uninteresting and is actually being used to control -something else. - -Another anti-example would be to bind to the "visible-child-name" -property of a #GtkStack if this value is actually stored in -#GSettings. In that case, the real source of the value is -#GSettings. If you want a #GAction to control a setting stored in -#GSettings, see g_settings_create_action() instead, and possibly -combine its use with g_settings_bind(). +between). `GPropertyAction` does not have a separate state that is kept +in sync with the property value — its state is the property value. + +For example, it might be useful to create a [iface@Gio.Action] corresponding +to the `visible-child-name` property of a [`GtkStack`](https://docs.gtk.org/gtk4/class.Stack.html) +so that the current page can be switched from a menu. The active radio +indication in the menu is then directly determined from the active page of +the `GtkStack`. + +An anti-example would be binding the `active-id` property on a +[`GtkComboBox`](https://docs.gtk.org/gtk4/class.ComboBox.html). This is +because the state of the combo box itself is probably uninteresting and is +actually being used to control something else. + +Another anti-example would be to bind to the `visible-child-name` +property of a [`GtkStack`](https://docs.gtk.org/gtk4/class.Stack.html) if +this value is actually stored in [class@Gio.Settings]. In that case, the +real source of the value is* [class@Gio.Settings]. If you want +a [iface@Gio.Action] to control a setting stored in [class@Gio.Settings], +see [method@Gio.Settings.create_action] instead, and possibly combine its +use with [method@Gio.Settings.bind]. Creates a #GAction corresponding to the value of property + filename="gio/gpropertyaction.c" + line="584">Creates a #GAction corresponding to the value of property @property_name on @object. The property must be existent and readable and writable (and not @@ -93003,32 +93493,31 @@ construct-only). This function takes a reference on @object and doesn't release it until the action is destroyed. - + a new #GPropertyAction + filename="gio/gpropertyaction.c" + line="600">a new #GPropertyAction the name of the action to create + filename="gio/gpropertyaction.c" + line="586">the name of the action to create the object that has the property + filename="gio/gpropertyaction.c" + line="587">the object that has the property to wrap the name of the property + filename="gio/gpropertyaction.c" + line="589">the name of the property @@ -93038,8 +93527,8 @@ until the action is destroyed. transfer-ownership="none" default-value="TRUE"> If @action is currently enabled. + filename="gio/gpropertyaction.c" + line="491">If @action is currently enabled. If the action is disabled then calls to g_action_activate() and g_action_change_state() have no effect. @@ -93052,8 +93541,8 @@ g_action_change_state() have no effect. transfer-ownership="none" default-value="FALSE"> If %TRUE, the state of the action will be the negation of the + filename="gio/gpropertyaction.c" + line="568">If %TRUE, the state of the action will be the negation of the property value, provided the property is boolean. @@ -93064,8 +93553,8 @@ property value, provided the property is boolean. transfer-ownership="none" default-value="NULL"> The name of the action. This is mostly meaningful for identifying + filename="gio/gpropertyaction.c" + line="462">The name of the action. This is mostly meaningful for identifying the action once it has been added to a #GActionMap. @@ -93076,16 +93565,16 @@ the action once it has been added to a #GActionMap. construct-only="1" transfer-ownership="none"> The object to wrap a property on. + filename="gio/gpropertyaction.c" + line="535">The object to wrap a property on. The object must be a non-%NULL #GObject with properties. The type of the parameter that must be given when activating the + filename="gio/gpropertyaction.c" + line="477">The type of the parameter that must be given when activating the action. @@ -93097,8 +93586,8 @@ action. transfer-ownership="none" default-value="NULL"> The name of the property to wrap on the object. + filename="gio/gpropertyaction.c" + line="551">The name of the property to wrap on the object. The property must exist on the passed-in object and it must be readable and writable (and not construct-only). @@ -93106,14 +93595,14 @@ readable and writable (and not construct-only). The state of the action, or %NULL if the action is stateless. + filename="gio/gpropertyaction.c" + line="521">The state of the action, or %NULL if the action is stateless. The #GVariantType of the state that the action has, or %NULL if the + filename="gio/gpropertyaction.c" + line="507">The #GVariantType of the state that the action has, or %NULL if the action is stateless. @@ -93126,36 +93615,34 @@ action is stateless. glib:get-type="g_proxy_get_type" glib:type-struct="ProxyInterface"> A #GProxy handles connecting to a remote host via a given type of -proxy server. It is implemented by the 'gio-proxy' extension point. + filename="gio/gproxy.c" + line="31">A `GProxy` handles connecting to a remote host via a given type of +proxy server. It is implemented by the `gio-proxy` extension point. The extensions are named after their proxy protocol name. As an example, a SOCKS5 proxy implementation can be retrieved with the -name 'socks5' using the function -g_io_extension_point_get_extension_by_name(). - +name `socks5` using the function +[method@Gio.IOExtensionPoint.get_extension_by_name]. + Find the `gio-proxy` extension point for a proxy implementation that supports + filename="gio/gproxy.c" + line="51">Find the `gio-proxy` extension point for a proxy implementation that supports the specified protocol. - + return a #GProxy or NULL if protocol + filename="gio/gproxy.c" + line="58">return a #GProxy or NULL if protocol is not supported. the proxy protocol name (e.g. http, socks, etc) + filename="gio/gproxy.c" + line="53">the proxy protocol name (e.g. http, socks, etc) @@ -93163,19 +93650,19 @@ the specified protocol. + throws="1" + glib:async-func="connect_async"> Given @connection to communicate with a proxy (eg, a + filename="gio/gproxy.c" + line="82">Given @connection to communicate with a proxy (eg, a #GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to @proxy_address, and if required, wraps the #GIOStream to handle proxy payload. - + a #GIOStream that will replace @connection. This might + filename="gio/gproxy.c" + line="95">a #GIOStream that will replace @connection. This might be the same as @connection, in which case a reference will be added. @@ -93183,20 +93670,20 @@ required, wraps the #GIOStream to handle proxy payload. a #GProxy + filename="gio/gproxy.c" + line="84">a #GProxy a #GIOStream + filename="gio/gproxy.c" + line="85">a #GIOStream a #GProxyAddress + filename="gio/gproxy.c" + line="86">a #GProxyAddress nullable="1" allow-none="1"> a #GCancellable + filename="gio/gproxy.c" + line="87">a #GCancellable + version="2.26" + glib:finish-func="connect_finish" + glib:sync-func="connect"> Asynchronous version of g_proxy_connect(). - + filename="gio/gproxy.c" + line="121">Asynchronous version of g_proxy_connect(). + a #GProxy + filename="gio/gproxy.c" + line="123">a #GProxy a #GIOStream + filename="gio/gproxy.c" + line="124">a #GIOStream a #GProxyAddress + filename="gio/gproxy.c" + line="125">a #GProxyAddress nullable="1" allow-none="1"> a #GCancellable + filename="gio/gproxy.c" + line="126">a #GCancellable scope="async" closure="4"> a #GAsyncReadyCallback + filename="gio/gproxy.c" + line="127">a #GAsyncReadyCallback allow-none="1" closure="4"> callback data + filename="gio/gproxy.c" + line="128">callback data @@ -93277,27 +93765,26 @@ required, wraps the #GIOStream to handle proxy payload. version="2.26" throws="1"> See g_proxy_connect(). - + filename="gio/gproxy.c" + line="156">See g_proxy_connect(). + a #GIOStream. + filename="gio/gproxy.c" + line="164">a #GIOStream. a #GProxy + filename="gio/gproxy.c" + line="158">a #GProxy a #GAsyncResult + filename="gio/gproxy.c" + line="159">a #GAsyncResult @@ -93306,27 +93793,26 @@ required, wraps the #GIOStream to handle proxy payload. invoker="supports_hostname" version="2.26"> Some proxy protocols expect to be passed a hostname, which they + filename="gio/gproxy.c" + line="182">Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. Others, like SOCKS4, do not allow this. This function will return %FALSE if @proxy is implementing such a protocol. When %FALSE is returned, the caller should resolve the destination hostname first, and then pass a #GProxyAddress containing the stringified IP address to g_proxy_connect() or g_proxy_connect_async(). - + %TRUE if hostname resolution is supported. + filename="gio/gproxy.c" + line="194">%TRUE if hostname resolution is supported. a #GProxy + filename="gio/gproxy.c" + line="184">a #GProxy @@ -93334,19 +93820,19 @@ g_proxy_connect() or g_proxy_connect_async(). + throws="1" + glib:async-func="connect_async"> Given @connection to communicate with a proxy (eg, a + filename="gio/gproxy.c" + line="82">Given @connection to communicate with a proxy (eg, a #GSocketConnection that is connected to the proxy server), this does the necessary handshake to connect to @proxy_address, and if required, wraps the #GIOStream to handle proxy payload. - + a #GIOStream that will replace @connection. This might + filename="gio/gproxy.c" + line="95">a #GIOStream that will replace @connection. This might be the same as @connection, in which case a reference will be added. @@ -93354,20 +93840,20 @@ required, wraps the #GIOStream to handle proxy payload. a #GProxy + filename="gio/gproxy.c" + line="84">a #GProxy a #GIOStream + filename="gio/gproxy.c" + line="85">a #GIOStream a #GProxyAddress + filename="gio/gproxy.c" + line="86">a #GProxyAddress nullable="1" allow-none="1"> a #GCancellable + filename="gio/gproxy.c" + line="87">a #GCancellable + version="2.26" + glib:finish-func="connect_finish" + glib:sync-func="connect"> Asynchronous version of g_proxy_connect(). - + filename="gio/gproxy.c" + line="121">Asynchronous version of g_proxy_connect(). + a #GProxy + filename="gio/gproxy.c" + line="123">a #GProxy a #GIOStream + filename="gio/gproxy.c" + line="124">a #GIOStream a #GProxyAddress + filename="gio/gproxy.c" + line="125">a #GProxyAddress nullable="1" allow-none="1"> a #GCancellable + filename="gio/gproxy.c" + line="126">a #GCancellable scope="async" closure="4"> a #GAsyncReadyCallback + filename="gio/gproxy.c" + line="127">a #GAsyncReadyCallback nullable="1" allow-none="1"> callback data + filename="gio/gproxy.c" + line="128">callback data @@ -93447,27 +93934,26 @@ required, wraps the #GIOStream to handle proxy payload. version="2.26" throws="1"> See g_proxy_connect(). - + filename="gio/gproxy.c" + line="156">See g_proxy_connect(). + a #GIOStream. + filename="gio/gproxy.c" + line="164">a #GIOStream. a #GProxy + filename="gio/gproxy.c" + line="158">a #GProxy a #GAsyncResult + filename="gio/gproxy.c" + line="159">a #GAsyncResult @@ -93476,27 +93962,26 @@ required, wraps the #GIOStream to handle proxy payload. c:identifier="g_proxy_supports_hostname" version="2.26"> Some proxy protocols expect to be passed a hostname, which they + filename="gio/gproxy.c" + line="182">Some proxy protocols expect to be passed a hostname, which they will resolve to an IP address themselves. Others, like SOCKS4, do not allow this. This function will return %FALSE if @proxy is implementing such a protocol. When %FALSE is returned, the caller should resolve the destination hostname first, and then pass a #GProxyAddress containing the stringified IP address to g_proxy_connect() or g_proxy_connect_async(). - + %TRUE if hostname resolution is supported. + filename="gio/gproxy.c" + line="194">%TRUE if hostname resolution is supported. a #GProxy + filename="gio/gproxy.c" + line="184">a #GProxy @@ -93511,59 +93996,57 @@ g_proxy_connect() or g_proxy_connect_async(). glib:get-type="g_proxy_address_get_type" glib:type-struct="ProxyAddressClass"> Support for proxied #GInetSocketAddress. - + filename="gio/gproxyaddress.c" + line="32">A [class@Gio.InetSocketAddress] representing a connection via a proxy server. + Creates a new #GProxyAddress for @inetaddr with @protocol that should + filename="gio/gproxyaddress.c" + line="308">Creates a new #GProxyAddress for @inetaddr with @protocol that should tunnel through @dest_hostname and @dest_port. (Note that this method doesn't set the #GProxyAddress:uri or #GProxyAddress:destination-protocol fields; use g_object_new() directly if you want to set those.) - + a new #GProxyAddress + filename="gio/gproxyaddress.c" + line="327">a new #GProxyAddress The proxy server #GInetAddress. + filename="gio/gproxyaddress.c" + line="310">The proxy server #GInetAddress. The proxy server port. + filename="gio/gproxyaddress.c" + line="311">The proxy server port. The proxy protocol to support, in lower case (e.g. socks, http). + filename="gio/gproxyaddress.c" + line="312">The proxy protocol to support, in lower case (e.g. socks, http). The destination hostname the proxy should tunnel to. + filename="gio/gproxyaddress.c" + line="313">The destination hostname the proxy should tunnel to. The destination port to tunnel to. + filename="gio/gproxyaddress.c" + line="314">The destination port to tunnel to. nullable="1" allow-none="1"> The username to authenticate to the proxy server + filename="gio/gproxyaddress.c" + line="315">The username to authenticate to the proxy server (or %NULL). @@ -93581,8 +94064,8 @@ directly if you want to set those.) nullable="1" allow-none="1"> The password to authenticate to the proxy server + filename="gio/gproxyaddress.c" + line="317">The password to authenticate to the proxy server (or %NULL). @@ -93593,23 +94076,22 @@ directly if you want to set those.) glib:get-property="destination-hostname" version="2.26"> Gets @proxy's destination hostname; that is, the name of the host + filename="gio/gproxyaddress.c" + line="385">Gets @proxy's destination hostname; that is, the name of the host that will be connected to via the proxy, not the name of the proxy itself. - + the @proxy's destination hostname + filename="gio/gproxyaddress.c" + line="393">the @proxy's destination hostname a #GProxyAddress + filename="gio/gproxyaddress.c" + line="387">a #GProxyAddress @@ -93619,23 +94101,22 @@ itself. glib:get-property="destination-port" version="2.26"> Gets @proxy's destination port; that is, the port on the + filename="gio/gproxyaddress.c" + line="403">Gets @proxy's destination port; that is, the port on the destination host that will be connected to via the proxy, not the port number of the proxy itself. - + the @proxy's destination port + filename="gio/gproxyaddress.c" + line="411">the @proxy's destination port a #GProxyAddress + filename="gio/gproxyaddress.c" + line="405">a #GProxyAddress @@ -93645,22 +94126,21 @@ port number of the proxy itself. glib:get-property="destination-protocol" version="2.34"> Gets the protocol that is being spoken to the destination + filename="gio/gproxyaddress.c" + line="368">Gets the protocol that is being spoken to the destination server; eg, "http" or "ftp". - + the @proxy's destination protocol + filename="gio/gproxyaddress.c" + line="375">the @proxy's destination protocol a #GProxyAddress + filename="gio/gproxyaddress.c" + line="370">a #GProxyAddress @@ -93670,21 +94150,20 @@ server; eg, "http" or "ftp". glib:get-property="password" version="2.26"> Gets @proxy's password. - + filename="gio/gproxyaddress.c" + line="437">Gets @proxy's password. + the @proxy's password + filename="gio/gproxyaddress.c" + line="443">the @proxy's password a #GProxyAddress + filename="gio/gproxyaddress.c" + line="439">a #GProxyAddress @@ -93694,21 +94173,20 @@ server; eg, "http" or "ftp". glib:get-property="protocol" version="2.26"> Gets @proxy's protocol. eg, "socks" or "http" - + filename="gio/gproxyaddress.c" + line="352">Gets @proxy's protocol. eg, "socks" or "http" + the @proxy's protocol + filename="gio/gproxyaddress.c" + line="358">the @proxy's protocol a #GProxyAddress + filename="gio/gproxyaddress.c" + line="354">a #GProxyAddress @@ -93718,21 +94196,20 @@ server; eg, "http" or "ftp". glib:get-property="uri" version="2.34"> Gets the proxy URI that @proxy was constructed from. - + filename="gio/gproxyaddress.c" + line="454">Gets the proxy URI that @proxy was constructed from. + the @proxy's URI, or %NULL if unknown + filename="gio/gproxyaddress.c" + line="460">the @proxy's URI, or %NULL if unknown a #GProxyAddress + filename="gio/gproxyaddress.c" + line="456">a #GProxyAddress @@ -93742,39 +94219,46 @@ server; eg, "http" or "ftp". glib:get-property="username" version="2.26"> Gets @proxy's username. - + filename="gio/gproxyaddress.c" + line="421">Gets @proxy's username. + the @proxy's username + filename="gio/gproxyaddress.c" + line="427">the @proxy's username a #GProxyAddress + filename="gio/gproxyaddress.c" + line="423">a #GProxyAddress + The proxy destination hostname. + The proxy destination port. getter="get_destination_protocol" default-value="NULL"> The protocol being spoke to the destination host, or %NULL if + filename="gio/gproxyaddress.c" + line="234">The protocol being spoke to the destination host, or %NULL if the #GProxyAddress doesn't know. + The proxy password. + The proxy protocol. getter="get_uri" default-value="NULL"> The URI string that the proxy was constructed from (or %NULL + filename="gio/gproxyaddress.c" + line="280">The URI string that the proxy was constructed from (or %NULL if the creator didn't specify this). + The proxy username. @@ -93839,10 +94335,9 @@ if the creator didn't specify this). glib:is-gtype-struct-for="ProxyAddress" version="2.26"> Class structure for #GProxyAddress. - + filename="gio/gproxyaddress.c" + line="40">Class structure for #GProxyAddress. + @@ -93855,22 +94350,25 @@ if the creator didn't specify this). glib:get-type="g_proxy_address_enumerator_get_type" glib:type-struct="ProxyAddressEnumeratorClass"> #GProxyAddressEnumerator is a wrapper around #GSocketAddressEnumerator which -takes the #GSocketAddress instances returned by the #GSocketAddressEnumerator -and wraps them in #GProxyAddress instances, using the given -#GProxyAddressEnumerator:proxy-resolver. + filename="gio/gproxyaddressenumerator.c" + line="44">`GProxyAddressEnumerator` is a wrapper around +[class@Gio.SocketAddressEnumerator] which takes the [class@Gio.SocketAddress] +instances returned by the [class@Gio.SocketAddressEnumerator] +and wraps them in [class@Gio.ProxyAddress] instances, using the given +[property@Gio.ProxyAddressEnumerator:proxy-resolver]. This enumerator will be returned (for example, by -g_socket_connectable_enumerate()) as appropriate when a proxy is configured; -there should be no need to manually wrap a #GSocketAddressEnumerator instance -with one. - +[method@Gio.SocketConnectable.enumerate]) as appropriate when a proxy is +configured; there should be no need to manually wrap a +[class@Gio.SocketAddressEnumerator] instance with one. + + The connectable being enumerated. transfer-ownership="none" default-value="0"> The default port to use if #GProxyAddressEnumerator:uri does not + filename="gio/gproxyaddressenumerator.c" + line="771">The default port to use if #GProxyAddressEnumerator:uri does not specify one. @@ -93891,8 +94389,8 @@ specify one. construct="1" transfer-ownership="none"> The proxy resolver to use. + filename="gio/gproxyaddressenumerator.c" + line="800">The proxy resolver to use. construct-only="1" transfer-ownership="none" default-value="NULL"> + The destination URI. Use `none://` for a generic socket. @@ -93915,18 +94416,16 @@ specify one. c:type="GProxyAddressEnumeratorClass" glib:is-gtype-struct-for="ProxyAddressEnumerator"> Class structure for #GProxyAddressEnumerator. - + filename="gio/gproxyaddressenumerator.h" + line="51">Class structure for #GProxyAddressEnumerator. + - + @@ -93934,8 +94433,7 @@ specify one. - + @@ -93943,8 +94441,7 @@ specify one. - + @@ -93952,8 +94449,7 @@ specify one. - + @@ -93961,8 +94457,7 @@ specify one. - + @@ -93970,8 +94465,7 @@ specify one. - + @@ -93979,8 +94473,7 @@ specify one. - + @@ -93991,39 +94484,39 @@ specify one. c:type="GProxyAddressEnumeratorPrivate" disguised="1" opaque="1"> - + - + Provides an interface for handling proxy connection and payload. - + filename="gio/gproxy.h" + line="53">Provides an interface for handling proxy connection and payload. + The parent interface. + filename="gio/gproxy.h" + line="55">The parent interface. + Connect to proxy server and wrap (if required) the #connection + to handle payload. - + a #GIOStream that will replace @connection. This might + filename="gio/gproxy.c" + line="95">a #GIOStream that will replace @connection. This might be the same as @connection, in which case a reference will be added. @@ -94031,20 +94524,20 @@ specify one. a #GProxy + filename="gio/gproxy.c" + line="84">a #GProxy a #GIOStream + filename="gio/gproxy.c" + line="85">a #GIOStream a #GProxyAddress + filename="gio/gproxy.c" + line="86">a #GProxyAddress nullable="1" allow-none="1"> a #GCancellable + filename="gio/gproxy.c" + line="87">a #GCancellable + Same as connect() but asynchronous. - + a #GProxy + filename="gio/gproxy.c" + line="123">a #GProxy a #GIOStream + filename="gio/gproxy.c" + line="124">a #GIOStream a #GProxyAddress + filename="gio/gproxy.c" + line="125">a #GProxyAddress nullable="1" allow-none="1"> a #GCancellable + filename="gio/gproxy.c" + line="126">a #GCancellable scope="async" closure="5"> a #GAsyncReadyCallback + filename="gio/gproxy.c" + line="127">a #GAsyncReadyCallback allow-none="1" closure="5"> callback data + filename="gio/gproxy.c" + line="128">callback data + Returns the result of connect_async() - + a #GIOStream. + filename="gio/gproxy.c" + line="164">a #GIOStream. a #GProxy + filename="gio/gproxy.c" + line="158">a #GProxy a #GAsyncResult + filename="gio/gproxy.c" + line="159">a #GAsyncResult + Returns whether the proxy supports hostname lookups. - + %TRUE if hostname resolution is supported. + filename="gio/gproxy.c" + line="194">%TRUE if hostname resolution is supported. a #GProxy + filename="gio/gproxy.c" + line="184">a #GProxy @@ -94173,28 +94672,27 @@ specify one. glib:get-type="g_proxy_resolver_get_type" glib:type-struct="ProxyResolverInterface"> #GProxyResolver provides synchronous and asynchronous network proxy -resolution. #GProxyResolver is used within #GSocketClient through -the method g_socket_connectable_proxy_enumerate(). + filename="gio/gproxyresolver.c" + line="38">`GProxyResolver` provides synchronous and asynchronous network proxy +resolution. `GProxyResolver` is used within [class@Gio.SocketClient] through +the method [method@Gio.SocketConnectable.proxy_enumerate]. -Implementations of #GProxyResolver based on libproxy and GNOME settings can -be found in glib-networking. GIO comes with an implementation for use inside -Flatpak portals. - +Implementations of `GProxyResolver` based on +[libproxy](https://github.com/libproxy/libproxy) and GNOME settings can be +found in [glib-networking](https://gitlab.gnome.org/GNOME/glib-networking). +GIO comes with an implementation for use inside Flatpak portals. + Gets the default #GProxyResolver for the system. - + filename="gio/gproxyresolver.c" + line="75">Gets the default #GProxyResolver for the system. + the default #GProxyResolver, which + filename="gio/gproxyresolver.c" + line="80">the default #GProxyResolver, which will be a dummy object if no proxy resolver is available @@ -94203,31 +94701,34 @@ Flatpak portals. invoker="is_supported" version="2.26"> Checks if @resolver can be used on this system. (This is used + filename="gio/gproxyresolver.c" + line="102">Checks if @resolver can be used on this system. (This is used internally; g_proxy_resolver_get_default() will only return a proxy resolver that returns %TRUE for this method.) - + %TRUE if @resolver is supported. + filename="gio/gproxyresolver.c" + line="110">%TRUE if @resolver is supported. a #GProxyResolver + filename="gio/gproxyresolver.c" + line="104">a #GProxyResolver - + Looks into the system proxy configuration to determine what proxy, + filename="gio/gproxyresolver.c" + line="126">Looks into the system proxy configuration to determine what proxy, if any, to use to connect to @uri. The returned proxy URIs are of the form `<protocol>://[user[:password]@]host[:port]` or `direct://`, where <protocol> could be http, rtsp, socks @@ -94242,12 +94743,11 @@ In this case, the resolver might still return a generic proxy type `direct://` is used when no proxy is needed. Direct connection should not be attempted unless it is part of the returned array of proxies. - + A + filename="gio/gproxyresolver.c" + line="149">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -94257,14 +94757,14 @@ returned array of proxies. a #GProxyResolver + filename="gio/gproxyresolver.c" + line="128">a #GProxyResolver a URI representing the destination to connect to + filename="gio/gproxyresolver.c" + line="129">a URI representing the destination to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gproxyresolver.c" + line="130">a #GCancellable, or %NULL + version="2.26" + glib:finish-func="lookup_finish" + glib:sync-func="lookup"> Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more + filename="gio/gproxyresolver.c" + line="182">Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more details. - + a #GProxyResolver + filename="gio/gproxyresolver.c" + line="184">a #GProxyResolver a URI representing the destination to connect to + filename="gio/gproxyresolver.c" + line="185">a URI representing the destination to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gproxyresolver.c" + line="186">a #GCancellable, or %NULL scope="async" closure="3"> callback to call after resolution completes + filename="gio/gproxyresolver.c" + line="187">callback to call after resolution completes allow-none="1" closure="3"> data for @callback + filename="gio/gproxyresolver.c" + line="188">data for @callback @@ -94340,16 +94841,15 @@ details. version="2.26" throws="1"> Call this function to obtain the array of proxy URIs when + filename="gio/gproxyresolver.c" + line="223">Call this function to obtain the array of proxy URIs when g_proxy_resolver_lookup_async() is complete. See g_proxy_resolver_lookup() for more details. - + A + filename="gio/gproxyresolver.c" + line="233">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -94359,14 +94859,14 @@ g_proxy_resolver_lookup() for more details. a #GProxyResolver + filename="gio/gproxyresolver.c" + line="225">a #GProxyResolver the result passed to your #GAsyncReadyCallback + filename="gio/gproxyresolver.c" + line="226">the result passed to your #GAsyncReadyCallback @@ -94375,23 +94875,22 @@ g_proxy_resolver_lookup() for more details. c:identifier="g_proxy_resolver_is_supported" version="2.26"> Checks if @resolver can be used on this system. (This is used + filename="gio/gproxyresolver.c" + line="102">Checks if @resolver can be used on this system. (This is used internally; g_proxy_resolver_get_default() will only return a proxy resolver that returns %TRUE for this method.) - + %TRUE if @resolver is supported. + filename="gio/gproxyresolver.c" + line="110">%TRUE if @resolver is supported. a #GProxyResolver + filename="gio/gproxyresolver.c" + line="104">a #GProxyResolver @@ -94399,10 +94898,11 @@ resolver that returns %TRUE for this method.) + throws="1" + glib:async-func="lookup_async"> Looks into the system proxy configuration to determine what proxy, + filename="gio/gproxyresolver.c" + line="126">Looks into the system proxy configuration to determine what proxy, if any, to use to connect to @uri. The returned proxy URIs are of the form `<protocol>://[user[:password]@]host[:port]` or `direct://`, where <protocol> could be http, rtsp, socks @@ -94417,12 +94917,11 @@ In this case, the resolver might still return a generic proxy type `direct://` is used when no proxy is needed. Direct connection should not be attempted unless it is part of the returned array of proxies. - + A + filename="gio/gproxyresolver.c" + line="149">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -94432,14 +94931,14 @@ returned array of proxies. a #GProxyResolver + filename="gio/gproxyresolver.c" + line="128">a #GProxyResolver a URI representing the destination to connect to + filename="gio/gproxyresolver.c" + line="129">a URI representing the destination to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gproxyresolver.c" + line="130">a #GCancellable, or %NULL + version="2.26" + glib:finish-func="lookup_finish" + glib:sync-func="lookup"> Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more + filename="gio/gproxyresolver.c" + line="182">Asynchronous lookup of proxy. See g_proxy_resolver_lookup() for more details. - + a #GProxyResolver + filename="gio/gproxyresolver.c" + line="184">a #GProxyResolver a URI representing the destination to connect to + filename="gio/gproxyresolver.c" + line="185">a URI representing the destination to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gproxyresolver.c" + line="186">a #GCancellable, or %NULL scope="async" closure="3"> callback to call after resolution completes + filename="gio/gproxyresolver.c" + line="187">callback to call after resolution completes nullable="1" allow-none="1"> data for @callback + filename="gio/gproxyresolver.c" + line="188">data for @callback @@ -94514,16 +95014,15 @@ details. version="2.26" throws="1"> Call this function to obtain the array of proxy URIs when + filename="gio/gproxyresolver.c" + line="223">Call this function to obtain the array of proxy URIs when g_proxy_resolver_lookup_async() is complete. See g_proxy_resolver_lookup() for more details. - + A + filename="gio/gproxyresolver.c" + line="233">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -94533,14 +95032,14 @@ g_proxy_resolver_lookup() for more details. a #GProxyResolver + filename="gio/gproxyresolver.c" + line="225">a #GProxyResolver the result passed to your #GAsyncReadyCallback + filename="gio/gproxyresolver.c" + line="226">the result passed to your #GAsyncReadyCallback @@ -94550,44 +95049,47 @@ g_proxy_resolver_lookup() for more details. c:type="GProxyResolverInterface" glib:is-gtype-struct-for="ProxyResolver"> The virtual function table for #GProxyResolver. - + filename="gio/gproxyresolver.c" + line="53">The virtual function table for #GProxyResolver. + The parent interface. + filename="gio/gproxyresolver.c" + line="55">The parent interface. + the virtual function pointer for g_proxy_resolver_is_supported() - + %TRUE if @resolver is supported. + filename="gio/gproxyresolver.c" + line="110">%TRUE if @resolver is supported. a #GProxyResolver + filename="gio/gproxyresolver.c" + line="104">a #GProxyResolver + the virtual function pointer for g_proxy_resolver_lookup() - + A + filename="gio/gproxyresolver.c" + line="149">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -94597,14 +95099,14 @@ g_proxy_resolver_lookup() for more details. a #GProxyResolver + filename="gio/gproxyresolver.c" + line="128">a #GProxyResolver a URI representing the destination to connect to + filename="gio/gproxyresolver.c" + line="129">a URI representing the destination to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gproxyresolver.c" + line="130">a #GCancellable, or %NULL + the virtual function pointer for + g_proxy_resolver_lookup_async() - + a #GProxyResolver + filename="gio/gproxyresolver.c" + line="184">a #GProxyResolver a URI representing the destination to connect to + filename="gio/gproxyresolver.c" + line="185">a URI representing the destination to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gproxyresolver.c" + line="186">a #GCancellable, or %NULL scope="async" closure="4"> callback to call after resolution completes + filename="gio/gproxyresolver.c" + line="187">callback to call after resolution completes allow-none="1" closure="4"> data for @callback + filename="gio/gproxyresolver.c" + line="188">data for @callback + the virtual function pointer for + g_proxy_resolver_lookup_finish() - + A + filename="gio/gproxyresolver.c" + line="233">A NULL-terminated array of proxy URIs. Must be freed with g_strfreev(). @@ -94689,14 +95197,14 @@ g_proxy_resolver_lookup() for more details. a #GProxyResolver + filename="gio/gproxyresolver.c" + line="225">a #GProxyResolver the result passed to your #GAsyncReadyCallback + filename="gio/gproxyresolver.c" + line="226">the result passed to your #GAsyncReadyCallback @@ -94706,8 +95214,7 @@ g_proxy_resolver_lookup() for more details. - + @@ -94716,8 +95223,7 @@ g_proxy_resolver_lookup() for more details. - + @@ -94726,8 +95232,7 @@ g_proxy_resolver_lookup() for more details. - + @@ -94736,8 +95241,7 @@ g_proxy_resolver_lookup() for more details. - + @@ -94746,8 +95250,7 @@ g_proxy_resolver_lookup() for more details. - + @@ -94755,17 +95258,16 @@ g_proxy_resolver_lookup() for more details. Changes the size of the memory block pointed to by @data to + filename="gio/gmemoryoutputstream.h" + line="65">Changes the size of the memory block pointed to by @data to @size bytes. The function should have the same semantics as realloc(). - + a pointer to the reallocated memory + filename="gio/gmemoryoutputstream.h" + line="75">a pointer to the reallocated memory @@ -94774,14 +95276,14 @@ The function should have the same semantics as realloc(). nullable="1" allow-none="1"> memory block to reallocate + filename="gio/gmemoryoutputstream.h" + line="67">memory block to reallocate size to reallocate @data to + filename="gio/gmemoryoutputstream.h" + line="68">size to reallocate @data to @@ -94794,37 +95296,36 @@ The function should have the same semantics as realloc(). glib:get-type="g_remote_action_group_get_type" glib:type-struct="RemoteActionGroupInterface"> The GRemoteActionGroup interface is implemented by #GActionGroup + filename="gio/gremoteactiongroup.c" + line="29">The `GRemoteActionGroup` interface is implemented by [iface@Gio.ActionGroup] instances that either transmit action invocations to other processes or receive action invocations in the local process from other processes. The interface has `_full` variants of the two -methods on #GActionGroup used to activate actions: -g_action_group_activate_action() and -g_action_group_change_action_state(). These variants allow a -"platform data" #GVariant to be specified: a dictionary providing +methods on [iface@Gio.ActionGroup] used to activate actions: +[method@Gio.ActionGroup.activate_action] and +[method@Gio.ActionGroup.change_action_state]. These variants allow a +‘platform data’ [struct@GLib.Variant] to be specified: a dictionary providing context for the action invocation (for example: timestamps, startup notification IDs, etc). -#GDBusActionGroup implements #GRemoteActionGroup. This provides a +[class@Gio.DBusActionGroup] implements `GRemoteActionGroup`. This provides a mechanism to send platform data for action invocations over D-Bus. -Additionally, g_dbus_connection_export_action_group() will check if -the exported #GActionGroup implements #GRemoteActionGroup and use the -`_full` variants of the calls if available. This +Additionally, [method@Gio.DBusConnection.export_action_group] will check if +the exported [iface@Gio.ActionGroup] implements `GRemoteActionGroup` and use +the `_full` variants of the calls if available. This provides a mechanism by which to receive platform data for action invocations that arrive by way of D-Bus. - + Activates the remote action. + filename="gio/gremoteactiongroup.c" + line="78">Activates the remote action. This is the same as g_action_group_activate_action() except that it allows for provision of "platform data" to be sent along with the @@ -94833,22 +95334,21 @@ interaction timestamp or startup notification information. @platform_data must be non-%NULL and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed. - + a #GDBusActionGroup + filename="gio/gremoteactiongroup.c" + line="80">a #GDBusActionGroup the name of the action to activate + filename="gio/gremoteactiongroup.c" + line="81">the name of the action to activate the optional parameter to the activation + filename="gio/gremoteactiongroup.c" + line="82">the optional parameter to the activation the platform data to send + filename="gio/gremoteactiongroup.c" + line="83">the platform data to send @@ -94872,8 +95372,8 @@ interaction timestamp or startup notification information. invoker="change_action_state_full" version="2.32"> Changes the state of a remote action. + filename="gio/gremoteactiongroup.c" + line="107">Changes the state of a remote action. This is the same as g_action_group_change_action_state() except that it allows for provision of "platform data" to be sent along with the @@ -94882,34 +95382,33 @@ user interaction timestamp or startup notification information. @platform_data must be non-%NULL and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed. - + a #GRemoteActionGroup + filename="gio/gremoteactiongroup.c" + line="109">a #GRemoteActionGroup the name of the action to change the state of + filename="gio/gremoteactiongroup.c" + line="110">the name of the action to change the state of the new requested value for the state + filename="gio/gremoteactiongroup.c" + line="111">the new requested value for the state the platform data to send + filename="gio/gremoteactiongroup.c" + line="112">the platform data to send @@ -94918,8 +95417,8 @@ user interaction timestamp or startup notification information. c:identifier="g_remote_action_group_activate_action_full" version="2.32"> Activates the remote action. + filename="gio/gremoteactiongroup.c" + line="78">Activates the remote action. This is the same as g_action_group_activate_action() except that it allows for provision of "platform data" to be sent along with the @@ -94928,22 +95427,21 @@ interaction timestamp or startup notification information. @platform_data must be non-%NULL and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed. - + a #GDBusActionGroup + filename="gio/gremoteactiongroup.c" + line="80">a #GDBusActionGroup the name of the action to activate + filename="gio/gremoteactiongroup.c" + line="81">the name of the action to activate the optional parameter to the activation + filename="gio/gremoteactiongroup.c" + line="82">the optional parameter to the activation the platform data to send + filename="gio/gremoteactiongroup.c" + line="83">the platform data to send @@ -94967,8 +95465,8 @@ interaction timestamp or startup notification information. c:identifier="g_remote_action_group_change_action_state_full" version="2.32"> Changes the state of a remote action. + filename="gio/gremoteactiongroup.c" + line="107">Changes the state of a remote action. This is the same as g_action_group_change_action_state() except that it allows for provision of "platform data" to be sent along with the @@ -94977,34 +95475,33 @@ user interaction timestamp or startup notification information. @platform_data must be non-%NULL and must have the type %G_VARIANT_TYPE_VARDICT. If it is floating, it will be consumed. - + a #GRemoteActionGroup + filename="gio/gremoteactiongroup.c" + line="109">a #GRemoteActionGroup the name of the action to change the state of + filename="gio/gremoteactiongroup.c" + line="110">the name of the action to change the state of the new requested value for the state + filename="gio/gremoteactiongroup.c" + line="111">the new requested value for the state the platform data to send + filename="gio/gremoteactiongroup.c" + line="112">the platform data to send @@ -95015,31 +95512,32 @@ user interaction timestamp or startup notification information. glib:is-gtype-struct-for="RemoteActionGroup" version="2.32"> The virtual function table for #GRemoteActionGroup. - + filename="gio/gremoteactiongroup.c" + line="57">The virtual function table for #GRemoteActionGroup. + + the virtual function pointer for g_remote_action_group_activate_action_full() - + a #GDBusActionGroup + filename="gio/gremoteactiongroup.c" + line="80">a #GDBusActionGroup the name of the action to activate + filename="gio/gremoteactiongroup.c" + line="81">the name of the action to activate the optional parameter to the activation + filename="gio/gremoteactiongroup.c" + line="82">the optional parameter to the activation the platform data to send + filename="gio/gremoteactiongroup.c" + line="83">the platform data to send + the virtual function pointer for g_remote_action_group_change_action_state_full() - + a #GRemoteActionGroup + filename="gio/gremoteactiongroup.c" + line="109">a #GRemoteActionGroup the name of the action to change the state of + filename="gio/gremoteactiongroup.c" + line="110">the name of the action to change the state of the new requested value for the state + filename="gio/gremoteactiongroup.c" + line="111">the new requested value for the state the platform data to send + filename="gio/gremoteactiongroup.c" + line="112">the platform data to send @@ -95105,41 +95605,46 @@ user interaction timestamp or startup notification information. glib:get-type="g_resolver_get_type" glib:type-struct="ResolverClass"> #GResolver provides cancellable synchronous and asynchronous DNS -resolution, for hostnames (g_resolver_lookup_by_address(), -g_resolver_lookup_by_name() and their async variants) and SRV -(service) records (g_resolver_lookup_service()). - -#GNetworkAddress and #GNetworkService provide wrappers around -#GResolver functionality that also implement #GSocketConnectable, -making it easy to connect to a remote host/service. - -The default resolver (see g_resolver_get_default()) has a timeout of 30s set -on it since GLib 2.78. Earlier versions of GLib did not support resolver -timeouts. - + filename="gio/gresolver.c" + line="45">The object that handles DNS resolution. Use [func@Gio.Resolver.get_default] +to get the default resolver. + +`GResolver` provides cancellable synchronous and asynchronous DNS +resolution, for hostnames ([method@Gio.Resolver.lookup_by_address], +[method@Gio.Resolver.lookup_by_name] and their async variants) and SRV +(service) records ([method@Gio.Resolver.lookup_service]). + +[class@Gio.NetworkAddress] and [class@Gio.NetworkService] provide wrappers +around `GResolver` functionality that also implement +[iface@Gio.SocketConnectable], making it easy to connect to a remote +host/service. + +The default resolver (see [func@Gio.Resolver.get_default]) has a timeout of +30s set on it since GLib 2.78. Earlier versions of GLib did not support +resolver timeouts. + +This is an abstract type; subclasses of it implement different resolvers for +different platforms and situations. + Frees @addresses (which should be the return value from + filename="gio/gresolver.c" + line="876">Frees @addresses (which should be the return value from g_resolver_lookup_by_name() or g_resolver_lookup_by_name_finish()). (This is a convenience method; you can also simply free the results by hand.) - + a #GList of #GInetAddress + filename="gio/gresolver.c" + line="878">a #GList of #GInetAddress @@ -95151,21 +95656,20 @@ by hand.) version="2.22" introspectable="0"> Frees @targets (which should be the return value from + filename="gio/gresolver.c" + line="1166">Frees @targets (which should be the return value from g_resolver_lookup_service() or g_resolver_lookup_service_finish()). (This is a convenience method; you can also simply free the results by hand.) - + a #GList of #GSrvTarget + filename="gio/gresolver.c" + line="1168">a #GList of #GSrvTarget @@ -95176,26 +95680,26 @@ results by hand.) c:identifier="g_resolver_get_default" version="2.22"> Gets the default #GResolver. You should unref it when you are done + filename="gio/gresolver.c" + line="282">Gets the default #GResolver. You should unref it when you are done with it. #GResolver may use its reference count as a hint about how many threads it should allocate for concurrent DNS resolutions. - + the default #GResolver. + filename="gio/gresolver.c" + line="289">the default #GResolver. + throws="1" + glib:async-func="lookup_by_address_async"> Synchronously reverse-resolves @address to determine its + filename="gio/gresolver.c" + line="897">Synchronously reverse-resolves @address to determine its associated hostname. If the DNS resolution fails, @error (if non-%NULL) will be set to @@ -95204,26 +95708,25 @@ a value from #GResolverError. If @cancellable is non-%NULL, it can be used to cancel the operation, in which case @error (if non-%NULL) will be set to %G_IO_ERROR_CANCELLED. - + a hostname (either ASCII-only, or in ASCII-encoded + filename="gio/gresolver.c" + line="914">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. a #GResolver + filename="gio/gresolver.c" + line="899">a #GResolver the address to reverse-resolve + filename="gio/gresolver.c" + line="900">the address to reverse-resolve a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="901">a #GCancellable, or %NULL + version="2.22" + glib:finish-func="lookup_by_address_finish" + glib:sync-func="lookup_by_address"> Begins asynchronously reverse-resolving @address to determine its + filename="gio/gresolver.c" + line="933">Begins asynchronously reverse-resolving @address to determine its associated hostname, and eventually calls @callback, which must call g_resolver_lookup_by_address_finish() to get the final result. - + a #GResolver + filename="gio/gresolver.c" + line="935">a #GResolver the address to reverse-resolve + filename="gio/gresolver.c" + line="936">the address to reverse-resolve nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="937">a #GCancellable, or %NULL scope="async" closure="3"> callback to call after resolution completes + filename="gio/gresolver.c" + line="938">callback to call after resolution completes allow-none="1" closure="3"> data for @callback + filename="gio/gresolver.c" + line="939">data for @callback @@ -95300,33 +95804,32 @@ call g_resolver_lookup_by_address_finish() to get the final result. version="2.22" throws="1"> Retrieves the result of a previous call to + filename="gio/gresolver.c" + line="962">Retrieves the result of a previous call to g_resolver_lookup_by_address_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - + a hostname (either ASCII-only, or in ASCII-encoded + filename="gio/gresolver.c" + line="975">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. a #GResolver + filename="gio/gresolver.c" + line="964">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="965">the result passed to your #GAsyncReadyCallback @@ -95334,10 +95837,11 @@ form), or %NULL on error. + throws="1" + glib:async-func="lookup_by_name_async"> Synchronously resolves @hostname to determine its associated IP + filename="gio/gresolver.c" + line="558">Synchronously resolves @hostname to determine its associated IP address(es). @hostname may be an ASCII-only or UTF-8 hostname, or the textual form of an IP address (in which case this just becomes a wrapper around g_inet_address_new_from_string()). @@ -95360,12 +95864,11 @@ operation, in which case @error (if non-%NULL) will be set to If you are planning to connect to a socket on the resolved IP address, it may be easier to create a #GNetworkAddress and use its #GSocketConnectable interface. - + a non-empty #GList + filename="gio/gresolver.c" + line="589">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -95376,14 +95879,14 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + filename="gio/gresolver.c" + line="560">a #GResolver the hostname to look up + filename="gio/gresolver.c" + line="561">the hostname to look up nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="562">a #GCancellable, or %NULL + version="2.22" + glib:finish-func="lookup_by_name_finish" + glib:sync-func="lookup_by_name"> Begins asynchronously resolving @hostname to determine its + filename="gio/gresolver.c" + line="786">Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_finish() to get the result. See g_resolver_lookup_by_name() for more details. - + a #GResolver + filename="gio/gresolver.c" + line="788">a #GResolver the hostname to look up the address of + filename="gio/gresolver.c" + line="789">the hostname to look up the address of nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="790">a #GCancellable, or %NULL scope="async" closure="3"> callback to call after resolution completes + filename="gio/gresolver.c" + line="791">callback to call after resolution completes allow-none="1" closure="3"> data for @callback + filename="gio/gresolver.c" + line="792">data for @callback @@ -95461,19 +95965,18 @@ See g_resolver_lookup_by_name() for more details. version="2.22" throws="1"> Retrieves the result of a call to + filename="gio/gresolver.c" + line="816">Retrieves the result of a call to g_resolver_lookup_by_name_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - + a #GList + filename="gio/gresolver.c" + line="829">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -95483,14 +95986,14 @@ for more details. a #GResolver + filename="gio/gresolver.c" + line="818">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="819">the result passed to your #GAsyncReadyCallback @@ -95498,18 +96001,18 @@ for more details. + throws="1" + glib:async-func="lookup_by_name_with_flags_async"> This differs from g_resolver_lookup_by_name() in that you can modify + filename="gio/gresolver.c" + line="609">This differs from g_resolver_lookup_by_name() in that you can modify the lookup behavior with @flags. For example this can be used to limit results with %G_RESOLVER_NAME_LOOKUP_FLAGS_IPV4_ONLY. - + a non-empty #GList + filename="gio/gresolver.c" + line="621">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -95520,20 +96023,20 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + filename="gio/gresolver.c" + line="611">a #GResolver the hostname to look up + filename="gio/gresolver.c" + line="612">the hostname to look up extra #GResolverNameLookupFlags for the lookup + filename="gio/gresolver.c" + line="613">extra #GResolverNameLookupFlags for the lookup @@ -95542,43 +96045,44 @@ done with it. (You can use g_resolver_free_addresses() to do this.) nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="614">a #GCancellable, or %NULL + version="2.60" + glib:finish-func="lookup_by_name_with_flags_finish" + glib:sync-func="lookup_by_name_with_flags"> Begins asynchronously resolving @hostname to determine its + filename="gio/gresolver.c" + line="754">Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_with_flags_finish() to get the result. See g_resolver_lookup_by_name() for more details. - + a #GResolver + filename="gio/gresolver.c" + line="756">a #GResolver the hostname to look up the address of + filename="gio/gresolver.c" + line="757">the hostname to look up the address of extra #GResolverNameLookupFlags for the lookup + filename="gio/gresolver.c" + line="758">extra #GResolverNameLookupFlags for the lookup @@ -95587,8 +96091,8 @@ See g_resolver_lookup_by_name() for more details. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="759">a #GCancellable, or %NULL scope="async" closure="4"> callback to call after resolution completes + filename="gio/gresolver.c" + line="760">callback to call after resolution completes allow-none="1" closure="4"> data for @callback + filename="gio/gresolver.c" + line="761">data for @callback @@ -95619,19 +96123,18 @@ See g_resolver_lookup_by_name() for more details. version="2.60" throws="1"> Retrieves the result of a call to + filename="gio/gresolver.c" + line="846">Retrieves the result of a call to g_resolver_lookup_by_name_with_flags_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - + a #GList + filename="gio/gresolver.c" + line="859">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -95641,14 +96144,14 @@ for more details. a #GResolver + filename="gio/gresolver.c" + line="848">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="849">the result passed to your #GAsyncReadyCallback @@ -95656,10 +96159,11 @@ for more details. + throws="1" + glib:async-func="lookup_records_async"> Synchronously performs a DNS record lookup for the given @rrname and returns + filename="gio/gresolver.c" + line="1187">Synchronously performs a DNS record lookup for the given @rrname and returns a list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain for each @record_type. @@ -95669,12 +96173,11 @@ a value from #GResolverError and %NULL will be returned. If @cancellable is non-%NULL, it can be used to cancel the operation, in which case @error (if non-%NULL) will be set to %G_IO_ERROR_CANCELLED. - + a non-empty #GList of + filename="gio/gresolver.c" + line="1206">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -95685,20 +96188,20 @@ g_variant_unref() to do this.) a #GResolver + filename="gio/gresolver.c" + line="1189">a #GResolver the DNS name to look up the record for + filename="gio/gresolver.c" + line="1190">the DNS name to look up the record for the type of DNS record to look up + filename="gio/gresolver.c" + line="1191">the type of DNS record to look up nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="1192">a #GCancellable, or %NULL + version="2.34" + glib:finish-func="lookup_records_finish" + glib:sync-func="lookup_records"> Begins asynchronously performing a DNS lookup for the given + filename="gio/gresolver.c" + line="1232">Begins asynchronously performing a DNS lookup for the given @rrname, and eventually calls @callback, which must call g_resolver_lookup_records_finish() to get the final result. See g_resolver_lookup_records() for more details. - + a #GResolver + filename="gio/gresolver.c" + line="1234">a #GResolver the DNS name to look up the record for + filename="gio/gresolver.c" + line="1235">the DNS name to look up the record for the type of DNS record to look up + filename="gio/gresolver.c" + line="1236">the type of DNS record to look up nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="1237">a #GCancellable, or %NULL scope="async" closure="4"> callback to call after resolution completes + filename="gio/gresolver.c" + line="1238">callback to call after resolution completes allow-none="1" closure="4"> data for @callback + filename="gio/gresolver.c" + line="1239">data for @callback @@ -95782,8 +96286,8 @@ g_resolver_lookup_records() for more details. version="2.34" throws="1"> Retrieves the result of a previous call to + filename="gio/gresolver.c" + line="1264">Retrieves the result of a previous call to g_resolver_lookup_records_async(). Returns a non-empty list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain. @@ -95791,12 +96295,11 @@ records contain. If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - + a non-empty #GList of + filename="gio/gresolver.c" + line="1279">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -95807,21 +96310,23 @@ g_variant_unref() to do this.) a #GResolver + filename="gio/gresolver.c" + line="1266">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="1267">the result passed to your #GAsyncReadyCallback - - + + @@ -95842,9 +96347,10 @@ g_variant_unref() to do this.) - - + + @@ -95883,19 +96389,18 @@ g_variant_unref() to do this.) version="2.22" throws="1"> Retrieves the result of a previous call to + filename="gio/gresolver.c" + line="1133">Retrieves the result of a previous call to g_resolver_lookup_service_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - + a non-empty #GList of + filename="gio/gresolver.c" + line="1146">a non-empty #GList of #GSrvTarget, or %NULL on error. See g_resolver_lookup_service() for more details. @@ -95905,21 +96410,20 @@ details. a #GResolver + filename="gio/gresolver.c" + line="1135">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="1136">the result passed to your #GAsyncReadyCallback - + @@ -95934,21 +96438,20 @@ details. glib:get-property="timeout" version="2.78"> Get the timeout applied to all resolver lookups. See #GResolver:timeout. - + filename="gio/gresolver.c" + line="1316">Get the timeout applied to all resolver lookups. See #GResolver:timeout. + the resolver timeout, in milliseconds, or `0` for no timeout + filename="gio/gresolver.c" + line="1322">the resolver timeout, in milliseconds, or `0` for no timeout a #GResolver + filename="gio/gresolver.c" + line="1318">a #GResolver @@ -95956,10 +96459,11 @@ details. + throws="1" + glib:async-func="lookup_by_address_async"> Synchronously reverse-resolves @address to determine its + filename="gio/gresolver.c" + line="897">Synchronously reverse-resolves @address to determine its associated hostname. If the DNS resolution fails, @error (if non-%NULL) will be set to @@ -95968,26 +96472,25 @@ a value from #GResolverError. If @cancellable is non-%NULL, it can be used to cancel the operation, in which case @error (if non-%NULL) will be set to %G_IO_ERROR_CANCELLED. - + a hostname (either ASCII-only, or in ASCII-encoded + filename="gio/gresolver.c" + line="914">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. a #GResolver + filename="gio/gresolver.c" + line="899">a #GResolver the address to reverse-resolve + filename="gio/gresolver.c" + line="900">the address to reverse-resolve a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="901">a #GCancellable, or %NULL + version="2.22" + glib:finish-func="lookup_by_address_finish" + glib:sync-func="lookup_by_address"> Begins asynchronously reverse-resolving @address to determine its + filename="gio/gresolver.c" + line="933">Begins asynchronously reverse-resolving @address to determine its associated hostname, and eventually calls @callback, which must call g_resolver_lookup_by_address_finish() to get the final result. - + a #GResolver + filename="gio/gresolver.c" + line="935">a #GResolver the address to reverse-resolve + filename="gio/gresolver.c" + line="936">the address to reverse-resolve nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="937">a #GCancellable, or %NULL scope="async" closure="3"> callback to call after resolution completes + filename="gio/gresolver.c" + line="938">callback to call after resolution completes nullable="1" allow-none="1"> data for @callback + filename="gio/gresolver.c" + line="939">data for @callback @@ -96063,33 +96567,32 @@ call g_resolver_lookup_by_address_finish() to get the final result. version="2.22" throws="1"> Retrieves the result of a previous call to + filename="gio/gresolver.c" + line="962">Retrieves the result of a previous call to g_resolver_lookup_by_address_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - + a hostname (either ASCII-only, or in ASCII-encoded + filename="gio/gresolver.c" + line="975">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. a #GResolver + filename="gio/gresolver.c" + line="964">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="965">the result passed to your #GAsyncReadyCallback @@ -96097,10 +96600,11 @@ form), or %NULL on error. + throws="1" + glib:async-func="lookup_by_name_async"> Synchronously resolves @hostname to determine its associated IP + filename="gio/gresolver.c" + line="558">Synchronously resolves @hostname to determine its associated IP address(es). @hostname may be an ASCII-only or UTF-8 hostname, or the textual form of an IP address (in which case this just becomes a wrapper around g_inet_address_new_from_string()). @@ -96123,12 +96627,11 @@ operation, in which case @error (if non-%NULL) will be set to If you are planning to connect to a socket on the resolved IP address, it may be easier to create a #GNetworkAddress and use its #GSocketConnectable interface. - + a non-empty #GList + filename="gio/gresolver.c" + line="589">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -96139,14 +96642,14 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + filename="gio/gresolver.c" + line="560">a #GResolver the hostname to look up + filename="gio/gresolver.c" + line="561">the hostname to look up nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="562">a #GCancellable, or %NULL + version="2.22" + glib:finish-func="lookup_by_name_finish" + glib:sync-func="lookup_by_name"> Begins asynchronously resolving @hostname to determine its + filename="gio/gresolver.c" + line="786">Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_finish() to get the result. See g_resolver_lookup_by_name() for more details. - + a #GResolver + filename="gio/gresolver.c" + line="788">a #GResolver the hostname to look up the address of + filename="gio/gresolver.c" + line="789">the hostname to look up the address of nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="790">a #GCancellable, or %NULL scope="async" closure="3"> callback to call after resolution completes + filename="gio/gresolver.c" + line="791">callback to call after resolution completes nullable="1" allow-none="1"> data for @callback + filename="gio/gresolver.c" + line="792">data for @callback @@ -96223,19 +96727,18 @@ See g_resolver_lookup_by_name() for more details. version="2.22" throws="1"> Retrieves the result of a call to + filename="gio/gresolver.c" + line="816">Retrieves the result of a call to g_resolver_lookup_by_name_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - + a #GList + filename="gio/gresolver.c" + line="829">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -96245,14 +96748,14 @@ for more details. a #GResolver + filename="gio/gresolver.c" + line="818">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="819">the result passed to your #GAsyncReadyCallback @@ -96260,18 +96763,18 @@ for more details. + throws="1" + glib:async-func="lookup_by_name_with_flags_async"> This differs from g_resolver_lookup_by_name() in that you can modify + filename="gio/gresolver.c" + line="609">This differs from g_resolver_lookup_by_name() in that you can modify the lookup behavior with @flags. For example this can be used to limit results with %G_RESOLVER_NAME_LOOKUP_FLAGS_IPV4_ONLY. - + a non-empty #GList + filename="gio/gresolver.c" + line="621">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -96282,20 +96785,20 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + filename="gio/gresolver.c" + line="611">a #GResolver the hostname to look up + filename="gio/gresolver.c" + line="612">the hostname to look up extra #GResolverNameLookupFlags for the lookup + filename="gio/gresolver.c" + line="613">extra #GResolverNameLookupFlags for the lookup @@ -96304,43 +96807,44 @@ done with it. (You can use g_resolver_free_addresses() to do this.) nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="614">a #GCancellable, or %NULL + version="2.60" + glib:finish-func="lookup_by_name_with_flags_finish" + glib:sync-func="lookup_by_name_with_flags"> Begins asynchronously resolving @hostname to determine its + filename="gio/gresolver.c" + line="754">Begins asynchronously resolving @hostname to determine its associated IP address(es), and eventually calls @callback, which must call g_resolver_lookup_by_name_with_flags_finish() to get the result. See g_resolver_lookup_by_name() for more details. - + a #GResolver + filename="gio/gresolver.c" + line="756">a #GResolver the hostname to look up the address of + filename="gio/gresolver.c" + line="757">the hostname to look up the address of extra #GResolverNameLookupFlags for the lookup + filename="gio/gresolver.c" + line="758">extra #GResolverNameLookupFlags for the lookup @@ -96349,8 +96853,8 @@ See g_resolver_lookup_by_name() for more details. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="759">a #GCancellable, or %NULL scope="async" closure="4"> callback to call after resolution completes + filename="gio/gresolver.c" + line="760">callback to call after resolution completes nullable="1" allow-none="1"> data for @callback + filename="gio/gresolver.c" + line="761">data for @callback @@ -96380,19 +96884,18 @@ See g_resolver_lookup_by_name() for more details. version="2.60" throws="1"> Retrieves the result of a call to + filename="gio/gresolver.c" + line="846">Retrieves the result of a call to g_resolver_lookup_by_name_with_flags_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - + a #GList + filename="gio/gresolver.c" + line="859">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -96402,14 +96905,14 @@ for more details. a #GResolver + filename="gio/gresolver.c" + line="848">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="849">the result passed to your #GAsyncReadyCallback @@ -96417,10 +96920,11 @@ for more details. + throws="1" + glib:async-func="lookup_records_async"> Synchronously performs a DNS record lookup for the given @rrname and returns + filename="gio/gresolver.c" + line="1187">Synchronously performs a DNS record lookup for the given @rrname and returns a list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain for each @record_type. @@ -96430,12 +96934,11 @@ a value from #GResolverError and %NULL will be returned. If @cancellable is non-%NULL, it can be used to cancel the operation, in which case @error (if non-%NULL) will be set to %G_IO_ERROR_CANCELLED. - + a non-empty #GList of + filename="gio/gresolver.c" + line="1206">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -96446,20 +96949,20 @@ g_variant_unref() to do this.) a #GResolver + filename="gio/gresolver.c" + line="1189">a #GResolver the DNS name to look up the record for + filename="gio/gresolver.c" + line="1190">the DNS name to look up the record for the type of DNS record to look up + filename="gio/gresolver.c" + line="1191">the type of DNS record to look up nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="1192">a #GCancellable, or %NULL + version="2.34" + glib:finish-func="lookup_records_finish" + glib:sync-func="lookup_records"> Begins asynchronously performing a DNS lookup for the given + filename="gio/gresolver.c" + line="1232">Begins asynchronously performing a DNS lookup for the given @rrname, and eventually calls @callback, which must call g_resolver_lookup_records_finish() to get the final result. See g_resolver_lookup_records() for more details. - + a #GResolver + filename="gio/gresolver.c" + line="1234">a #GResolver the DNS name to look up the record for + filename="gio/gresolver.c" + line="1235">the DNS name to look up the record for the type of DNS record to look up + filename="gio/gresolver.c" + line="1236">the type of DNS record to look up nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="1237">a #GCancellable, or %NULL scope="async" closure="4"> callback to call after resolution completes + filename="gio/gresolver.c" + line="1238">callback to call after resolution completes nullable="1" allow-none="1"> data for @callback + filename="gio/gresolver.c" + line="1239">data for @callback @@ -96542,8 +97046,8 @@ g_resolver_lookup_records() for more details. version="2.34" throws="1"> Retrieves the result of a previous call to + filename="gio/gresolver.c" + line="1264">Retrieves the result of a previous call to g_resolver_lookup_records_async(). Returns a non-empty list of records as #GVariant tuples. See #GResolverRecordType for information on what the records contain. @@ -96551,12 +97055,11 @@ records contain. If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - + a non-empty #GList of + filename="gio/gresolver.c" + line="1279">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -96567,14 +97070,14 @@ g_variant_unref() to do this.) a #GResolver + filename="gio/gresolver.c" + line="1266">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="1267">the result passed to your #GAsyncReadyCallback @@ -96582,10 +97085,11 @@ g_variant_unref() to do this.) + throws="1" + glib:async-func="lookup_service_async"> Synchronously performs a DNS SRV lookup for the given @service and + filename="gio/gresolver.c" + line="1012">Synchronously performs a DNS SRV lookup for the given @service and @protocol in the given @domain and returns an array of #GSrvTarget. @domain may be an ASCII-only or UTF-8 hostname. Note also that the @service and @protocol arguments do not include the leading underscore @@ -96606,12 +97110,11 @@ operation, in which case @error (if non-%NULL) will be set to If you are planning to connect to the service, it is usually easier to create a #GNetworkService and use its #GSocketConnectable interface. - + a non-empty #GList of + filename="gio/gresolver.c" + line="1043">a non-empty #GList of #GSrvTarget, or %NULL on error. You must free each of the targets and the list when you are done with it. (You can use g_resolver_free_targets() to do this.) @@ -96622,26 +97125,26 @@ this.) a #GResolver + filename="gio/gresolver.c" + line="1014">a #GResolver the service type to look up (eg, "ldap") + filename="gio/gresolver.c" + line="1015">the service type to look up (eg, "ldap") the networking protocol to use for @service (eg, "tcp") + filename="gio/gresolver.c" + line="1016">the networking protocol to use for @service (eg, "tcp") the DNS domain to look up the service in + filename="gio/gresolver.c" + line="1017">the DNS domain to look up the service in nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="1018">a #GCancellable, or %NULL + version="2.22" + glib:finish-func="lookup_service_finish" + glib:sync-func="lookup_service"> Begins asynchronously performing a DNS SRV lookup for the given + filename="gio/gresolver.c" + line="1082">Begins asynchronously performing a DNS SRV lookup for the given @service and @protocol in the given @domain, and eventually calls @callback, which must call g_resolver_lookup_service_finish() to get the final result. See g_resolver_lookup_service() for more details. - + a #GResolver + filename="gio/gresolver.c" + line="1084">a #GResolver the service type to look up (eg, "ldap") + filename="gio/gresolver.c" + line="1085">the service type to look up (eg, "ldap") the networking protocol to use for @service (eg, "tcp") + filename="gio/gresolver.c" + line="1086">the networking protocol to use for @service (eg, "tcp") the DNS domain to look up the service in + filename="gio/gresolver.c" + line="1087">the DNS domain to look up the service in nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="1088">a #GCancellable, or %NULL scope="async" closure="5"> callback to call after resolution completes + filename="gio/gresolver.c" + line="1089">callback to call after resolution completes nullable="1" allow-none="1"> data for @callback + filename="gio/gresolver.c" + line="1090">data for @callback @@ -96731,19 +97235,18 @@ details. version="2.22" throws="1"> Retrieves the result of a previous call to + filename="gio/gresolver.c" + line="1133">Retrieves the result of a previous call to g_resolver_lookup_service_async(). If the DNS resolution failed, @error (if non-%NULL) will be set to a value from #GResolverError. If the operation was cancelled, @error will be set to %G_IO_ERROR_CANCELLED. - + a non-empty #GList of + filename="gio/gresolver.c" + line="1146">a non-empty #GList of #GSrvTarget, or %NULL on error. See g_resolver_lookup_service() for more details. @@ -96753,14 +97256,14 @@ details. a #GResolver + filename="gio/gresolver.c" + line="1135">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="1136">the result passed to your #GAsyncReadyCallback @@ -96769,8 +97272,8 @@ details. c:identifier="g_resolver_set_default" version="2.22"> Sets @resolver to be the application's default resolver (reffing + filename="gio/gresolver.c" + line="309">Sets @resolver to be the application's default resolver (reffing @resolver, and unreffing the previous default resolver, if any). Future calls to g_resolver_get_default() will return this resolver. @@ -96779,16 +97282,15 @@ caching or "pinning"; it can implement its own #GResolver that calls the original default resolver for DNS operations, and implements its own cache policies on top of that, and then set itself as the default resolver for all later code to use. - + the new default #GResolver + filename="gio/gresolver.c" + line="311">the new default #GResolver @@ -96798,24 +97300,23 @@ itself as the default resolver for all later code to use. glib:set-property="timeout" version="2.78"> Set the timeout applied to all resolver lookups. See #GResolver:timeout. - + filename="gio/gresolver.c" + line="1336">Set the timeout applied to all resolver lookups. See #GResolver:timeout. + a #GResolver + filename="gio/gresolver.c" + line="1338">a #GResolver timeout in milliseconds, or `0` for no timeouts + filename="gio/gresolver.c" + line="1339">timeout in milliseconds, or `0` for no timeouts @@ -96828,8 +97329,8 @@ itself as the default resolver for all later code to use. getter="get_timeout" default-value="0"> The timeout applied to all resolver lookups, in milliseconds. + filename="gio/gresolver.c" + line="222">The timeout applied to all resolver lookups, in milliseconds. This may be changed through the lifetime of the #GResolver. The new value will apply to any lookups started after the change, but not to any @@ -96849,8 +97350,8 @@ GLib 2.78. Emitted when the resolver notices that the system resolver + filename="gio/gresolver.c" + line="245">Emitted when the resolver notices that the system resolver configuration has changed. @@ -96860,15 +97361,13 @@ configuration has changed. - + - + @@ -96881,12 +97380,11 @@ configuration has changed. - + a non-empty #GList + filename="gio/gresolver.c" + line="589">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -96897,14 +97395,14 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + filename="gio/gresolver.c" + line="560">a #GResolver the hostname to look up + filename="gio/gresolver.c" + line="561">the hostname to look up nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="562">a #GCancellable, or %NULL @@ -96921,22 +97419,21 @@ done with it. (You can use g_resolver_free_addresses() to do this.) - + a #GResolver + filename="gio/gresolver.c" + line="788">a #GResolver the hostname to look up the address of + filename="gio/gresolver.c" + line="789">the hostname to look up the address of nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="790">a #GCancellable, or %NULL scope="async" closure="4"> callback to call after resolution completes + filename="gio/gresolver.c" + line="791">callback to call after resolution completes allow-none="1" closure="4"> data for @callback + filename="gio/gresolver.c" + line="792">data for @callback @@ -96974,12 +97471,11 @@ done with it. (You can use g_resolver_free_addresses() to do this.) - + a #GList + filename="gio/gresolver.c" + line="829">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -96989,14 +97485,14 @@ for more details. a #GResolver + filename="gio/gresolver.c" + line="818">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="819">the result passed to your #GAsyncReadyCallback @@ -97004,26 +97500,25 @@ for more details. - + a hostname (either ASCII-only, or in ASCII-encoded + filename="gio/gresolver.c" + line="914">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. a #GResolver + filename="gio/gresolver.c" + line="899">a #GResolver the address to reverse-resolve + filename="gio/gresolver.c" + line="900">the address to reverse-resolve nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="901">a #GCancellable, or %NULL @@ -97040,22 +97535,21 @@ for more details. - + a #GResolver + filename="gio/gresolver.c" + line="935">a #GResolver the address to reverse-resolve + filename="gio/gresolver.c" + line="936">the address to reverse-resolve nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="937">a #GCancellable, or %NULL scope="async" closure="4"> callback to call after resolution completes + filename="gio/gresolver.c" + line="938">callback to call after resolution completes allow-none="1" closure="4"> data for @callback + filename="gio/gresolver.c" + line="939">data for @callback @@ -97093,26 +97587,25 @@ for more details. - + a hostname (either ASCII-only, or in ASCII-encoded + filename="gio/gresolver.c" + line="975">a hostname (either ASCII-only, or in ASCII-encoded form), or %NULL on error. a #GResolver + filename="gio/gresolver.c" + line="964">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="965">the result passed to your #GAsyncReadyCallback @@ -97120,8 +97613,7 @@ form), or %NULL on error. - + @@ -97145,8 +97637,7 @@ form), or %NULL on error. - + @@ -97183,12 +97674,11 @@ form), or %NULL on error. - + a non-empty #GList of + filename="gio/gresolver.c" + line="1146">a non-empty #GList of #GSrvTarget, or %NULL on error. See g_resolver_lookup_service() for more details. @@ -97198,14 +97688,14 @@ details. a #GResolver + filename="gio/gresolver.c" + line="1135">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="1136">the result passed to your #GAsyncReadyCallback @@ -97213,12 +97703,11 @@ details. - + a non-empty #GList of + filename="gio/gresolver.c" + line="1206">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -97229,20 +97718,20 @@ g_variant_unref() to do this.) a #GResolver + filename="gio/gresolver.c" + line="1189">a #GResolver the DNS name to look up the record for + filename="gio/gresolver.c" + line="1190">the DNS name to look up the record for the type of DNS record to look up + filename="gio/gresolver.c" + line="1191">the type of DNS record to look up nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="1192">a #GCancellable, or %NULL @@ -97259,28 +97748,27 @@ g_variant_unref() to do this.) - + a #GResolver + filename="gio/gresolver.c" + line="1234">a #GResolver the DNS name to look up the record for + filename="gio/gresolver.c" + line="1235">the DNS name to look up the record for the type of DNS record to look up + filename="gio/gresolver.c" + line="1236">the type of DNS record to look up nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="1237">a #GCancellable, or %NULL scope="async" closure="5"> callback to call after resolution completes + filename="gio/gresolver.c" + line="1238">callback to call after resolution completes allow-none="1" closure="5"> data for @callback + filename="gio/gresolver.c" + line="1239">data for @callback @@ -97318,12 +97806,11 @@ g_variant_unref() to do this.) - + a non-empty #GList of + filename="gio/gresolver.c" + line="1279">a non-empty #GList of #GVariant, or %NULL on error. You must free each of the records and the list when you are done with it. (You can use g_list_free_full() with g_variant_unref() to do this.) @@ -97334,14 +97821,14 @@ g_variant_unref() to do this.) a #GResolver + filename="gio/gresolver.c" + line="1266">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="1267">the result passed to your #GAsyncReadyCallback @@ -97349,28 +97836,27 @@ g_variant_unref() to do this.) - + a #GResolver + filename="gio/gresolver.c" + line="756">a #GResolver the hostname to look up the address of + filename="gio/gresolver.c" + line="757">the hostname to look up the address of extra #GResolverNameLookupFlags for the lookup + filename="gio/gresolver.c" + line="758">extra #GResolverNameLookupFlags for the lookup @@ -97379,8 +97865,8 @@ g_variant_unref() to do this.) nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="759">a #GCancellable, or %NULL scope="async" closure="5"> callback to call after resolution completes + filename="gio/gresolver.c" + line="760">callback to call after resolution completes allow-none="1" closure="5"> data for @callback + filename="gio/gresolver.c" + line="761">data for @callback @@ -97409,12 +97895,11 @@ g_variant_unref() to do this.) - + a #GList + filename="gio/gresolver.c" + line="859">a #GList of #GInetAddress, or %NULL on error. See g_resolver_lookup_by_name() for more details. @@ -97424,14 +97909,14 @@ for more details. a #GResolver + filename="gio/gresolver.c" + line="848">a #GResolver the result passed to your #GAsyncReadyCallback + filename="gio/gresolver.c" + line="849">the result passed to your #GAsyncReadyCallback @@ -97439,12 +97924,11 @@ for more details. - + a non-empty #GList + filename="gio/gresolver.c" + line="621">a non-empty #GList of #GInetAddress, or %NULL on error. You must unref each of the addresses and free the list when you are done with it. (You can use g_resolver_free_addresses() to do this.) @@ -97455,20 +97939,20 @@ done with it. (You can use g_resolver_free_addresses() to do this.) a #GResolver + filename="gio/gresolver.c" + line="611">a #GResolver the hostname to look up + filename="gio/gresolver.c" + line="612">the hostname to look up extra #GResolverNameLookupFlags for the lookup + filename="gio/gresolver.c" + line="613">extra #GResolverNameLookupFlags for the lookup @@ -97477,8 +97961,8 @@ done with it. (You can use g_resolver_free_addresses() to do this.) nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gresolver.c" + line="614">a #GCancellable, or %NULL @@ -97492,8 +97976,8 @@ done with it. (You can use g_resolver_free_addresses() to do this.) c:type="GResolverError" glib:error-domain="g-resolver-error-quark"> An error code used with %G_RESOLVER_ERROR in a #GError returned + filename="gio/gioenums.h" + line="712">An error code used with %G_RESOLVER_ERROR in a #GError returned from a #GResolver routine. glib:nick="not-found" glib:name="G_RESOLVER_ERROR_NOT_FOUND"> the requested name/address/service was not + filename="gio/gioenums.h" + line="714">the requested name/address/service was not found glib:nick="temporary-failure" glib:name="G_RESOLVER_ERROR_TEMPORARY_FAILURE"> the requested information could not + filename="gio/gioenums.h" + line="716">the requested information could not be looked up due to a network error or similar problem glib:nick="internal" glib:name="G_RESOLVER_ERROR_INTERNAL"> unknown error + filename="gio/gioenums.h" + line="718">unknown error Gets the #GResolver Error Quark. + filename="gio/gresolver.c" + line="1360">Gets the #GResolver Error Quark. a #GQuark. + filename="gio/gresolver.c" + line="1365">a #GQuark. @@ -97544,7 +98028,7 @@ from a #GResolver routine. glib:get-type="g_resolver_name_lookup_flags_get_type" c:type="GResolverNameLookupFlags"> Flags to modify lookup behavior. glib:nick="default" glib:name="G_RESOLVER_NAME_LOOKUP_FLAGS_DEFAULT"> default behavior (same as g_resolver_lookup_by_name()) glib:nick="ipv4-only" glib:name="G_RESOLVER_NAME_LOOKUP_FLAGS_IPV4_ONLY"> only resolve ipv4 addresses glib:nick="ipv6-only" glib:name="G_RESOLVER_NAME_LOOKUP_FLAGS_IPV6_ONLY"> only resolve ipv6 addresses @@ -97578,8 +98062,7 @@ from a #GResolver routine. c:type="GResolverPrivate" disguised="1" opaque="1"> - + glib:get-type="g_resolver_record_type_get_type" c:type="GResolverRecordType"> The type of record that g_resolver_lookup_records() or + filename="gio/gioenums.h" + line="731">The type of record that g_resolver_lookup_records() or g_resolver_lookup_records_async() should retrieve. The records are returned as lists of #GVariant tuples. Each record type has different values in the variant tuples returned. @@ -97624,8 +98107,8 @@ as a `guint32`, and the TTL as a `guint32`. glib:nick="srv" glib:name="G_RESOLVER_RECORD_SRV"> look up DNS SRV records for a domain + filename="gio/gioenums.h" + line="733">look up DNS SRV records for a domain look up DNS MX records for a domain + filename="gio/gioenums.h" + line="734">look up DNS MX records for a domain look up DNS TXT records for a name + filename="gio/gioenums.h" + line="735">look up DNS TXT records for a name look up DNS SOA records for a zone + filename="gio/gioenums.h" + line="736">look up DNS SOA records for a zone look up DNS NS records for a domain + filename="gio/gioenums.h" + line="737">look up DNS NS records for a domain Applications and libraries often contain binary or textual data that is + filename="gio/gresource.c" + line="50">Applications and libraries often contain binary or textual data that is really part of the application, rather than user data. For instance -#GtkBuilder .ui files, splashscreen images, GMenu markup XML, CSS files, -icons, etc. These are often shipped as files in `$datadir/appname`, or -manually included as literal strings in the code. - -The #GResource API and the [glib-compile-resources][glib-compile-resources] program -provide a convenient and efficient alternative to this which has some nice properties. You -maintain the files as normal files, so its easy to edit them, but during the build the files -are combined into a binary bundle that is linked into the executable. This means that loading -the resource files are efficient (as they are already in memory, shared with other instances) and -simple (no need to check for things like I/O errors or locate the files in the filesystem). It +[`GtkBuilder`](https://docs.gtk.org/gtk4/class.Builder.html) `.ui` files, +splashscreen images, [class@Gio.Menu] markup XML, CSS files, icons, etc. +These are often shipped as files in `$datadir/appname`, or manually +included as literal strings in the code. + +The `GResource` API and the +[`glib-compile-resources`](glib-compile-resources.html) program provide a +convenient and efficient alternative to this which has some nice properties. +You maintain the files as normal files, so it’s easy to edit them, but during +the build the files are combined into a binary bundle that is linked into the +executable. This means that loading the resource files are efficient (as they +are already in memory, shared with other instances) and simple (no need to +check for things like I/O errors or locate the files in the filesystem). It also makes it easier to create relocatable applications. -Resource files can also be marked as compressed. Such files will be included in the resource bundle -in a compressed form, but will be automatically uncompressed when the resource is used. This -is very useful e.g. for larger text files that are parsed once (or rarely) and then thrown away. +Resource files can also be marked as compressed. Such files will be included +in the resource bundle in a compressed form, but will be automatically +uncompressed when the resource is used. This is very useful e.g. for larger +text files that are parsed once (or rarely) and then thrown away. Resource files can also be marked to be preprocessed, by setting the value of the `preprocess` attribute to a comma-separated list of preprocessing options. The only options currently supported are: -`xml-stripblanks` which will use the xmllint command -to strip ignorable whitespace from the XML file. For this to work, -the `XMLLINT` environment variable must be set to the full path to -the xmllint executable, or xmllint must be in the `PATH`; otherwise -the preprocessing step is skipped. - -`to-pixdata` (deprecated since gdk-pixbuf 2.32) which will use the -`gdk-pixbuf-pixdata` command to convert images to the #GdkPixdata format, -which allows you to create pixbufs directly using the data inside the -resource file, rather than an (uncompressed) copy of it. For this, the -`gdk-pixbuf-pixdata` program must be in the `PATH`, or the -`GDK_PIXBUF_PIXDATA` environment variable must be set to the full path to the -`gdk-pixbuf-pixdata` executable; otherwise the resource compiler will abort. -`to-pixdata` has been deprecated since gdk-pixbuf 2.32, as #GResource -supports embedding modern image formats just as well. Instead of using it, -embed a PNG or SVG file in your #GResource. - -`json-stripblanks` which will use the `json-glib-format` command to strip -ignorable whitespace from the JSON file. For this to work, the -`JSON_GLIB_FORMAT` environment variable must be set to the full path to the -`json-glib-format` executable, or it must be in the `PATH`; -otherwise the preprocessing step is skipped. In addition, at least version -1.6 of `json-glib-format` is required. - -Resource files will be exported in the GResource namespace using the + - `xml-stripblanks` which will use the [`xmllint`](man:xmllint(1)) command + to strip ignorable whitespace from the XML file. For this to work, + the `XMLLINT` environment variable must be set to the full path to + the xmllint executable, or xmllint must be in the `PATH`; otherwise + the preprocessing step is skipped. + + - `to-pixdata` (deprecated since gdk-pixbuf 2.32) which will use the + `gdk-pixbuf-pixdata` command to convert images to the [`GdkPixdata`](https://docs.gtk.org/gdk-pixbuf/class.Pixdata.html) + format, which allows you to create pixbufs directly using the data inside + the resource file, rather than an (uncompressed) copy of it. For this, the + `gdk-pixbuf-pixdata` program must be in the `PATH`, or the + `GDK_PIXBUF_PIXDATA` environment variable must be set to the full path to + the `gdk-pixbuf-pixdata` executable; otherwise the resource compiler will + abort. `to-pixdata` has been deprecated since gdk-pixbuf 2.32, as + `GResource` supports embedding modern image formats just as well. Instead + of using it, embed a PNG or SVG file in your `GResource`. + + - `json-stripblanks` which will use the + [`json-glib-format`](man:json-glib-format(1)) command to strip ignorable + whitespace from the JSON file. For this to work, the `JSON_GLIB_FORMAT` + environment variable must be set to the full path to the + `json-glib-format` executable, or it must be in the `PATH`; otherwise the + preprocessing step is skipped. In addition, at least version 1.6 of + `json-glib-format` is required. + +Resource files will be exported in the `GResource` namespace using the combination of the given `prefix` and the filename from the `file` element. The `alias` attribute can be used to alter the filename to expose them at a different location in the resource namespace. Typically, this is used to include files from a different source directory without exposing the source directory in the resource namespace, as in the example below. -Resource bundles are created by the [glib-compile-resources][glib-compile-resources] program -which takes an XML file that describes the bundle, and a set of files that the XML references. These -are combined into a binary resource bundle. +Resource bundles are created by the +[`glib-compile-resources`](glib-compile-resources.html) program +which takes an XML file that describes the bundle, and a set of files that +the XML references. These are combined into a binary resource bundle. An example resource description: -|[ +```xml <?xml version="1.0" encoding="UTF-8"?> <gresources> <gresource prefix="/org/gtk/Example"> @@ -97741,83 +98230,101 @@ An example resource description: <file alias="example.css">data/example.css</file> </gresource> </gresources> -]| +``` This will create a resource bundle with the following files: -|[ +``` /org/gtk/Example/data/splashscreen.png /org/gtk/Example/dialog.ui /org/gtk/Example/menumarkup.xml /org/gtk/Example/example.css -]| +``` -Note that all resources in the process share the same namespace, so use Java-style -path prefixes (like in the above example) to avoid conflicts. +Note that all resources in the process share the same namespace, so use +Java-style path prefixes (like in the above example) to avoid conflicts. -You can then use [glib-compile-resources][glib-compile-resources] to compile the XML to a -binary bundle that you can load with g_resource_load(). However, its more common to use the --generate-source and ---generate-header arguments to create a source file and header to link directly into your application. +You can then use [`glib-compile-resources`](glib-compile-resources.html) to +compile the XML to a binary bundle that you can load with +[func@Gio.Resource.load]. However, it’s more common to use the +`--generate-source` and `--generate-header` arguments to create a source file +and header to link directly into your application. This will generate `get_resource()`, `register_resource()` and `unregister_resource()` functions, prefixed by the `--c-name` argument passed -to [glib-compile-resources][glib-compile-resources]. `get_resource()` returns -the generated #GResource object. The register and unregister functions -register the resource so its files can be accessed using -g_resources_lookup_data(). - -Once a #GResource has been created and registered all the data in it can be accessed globally in the process by -using API calls like g_resources_open_stream() to stream the data or g_resources_lookup_data() to get a direct pointer -to the data. You can also use URIs like "resource:///org/gtk/Example/data/splashscreen.png" with #GFile to access -the resource data. - -Some higher-level APIs, such as #GtkApplication, will automatically load -resources from certain well-known paths in the resource namespace as a -convenience. See the documentation for those APIs for details. - -There are two forms of the generated source, the default version uses the compiler support for constructor -and destructor functions (where available) to automatically create and register the #GResource on startup -or library load time. If you pass `--manual-register`, two functions to register/unregister the resource are created -instead. This requires an explicit initialization call in your application/library, but it works on all platforms, -even on the minor ones where constructors are not supported. (Constructor support is available for at least Win32, Mac OS and Linux.) - -Note that resource data can point directly into the data segment of e.g. a library, so if you are unloading libraries -during runtime you need to be very careful with keeping around pointers to data from a resource, as this goes away -when the library is unloaded. However, in practice this is not generally a problem, since most resource accesses -are for your own resources, and resource data is often used once, during parsing, and then released. - -When debugging a program or testing a change to an installed version, it is often useful to be able to -replace resources in the program or library, without recompiling, for debugging or quick hacking and testing -purposes. Since GLib 2.50, it is possible to use the `G_RESOURCE_OVERLAYS` environment variable to selectively overlay -resources with replacements from the filesystem. It is a %G_SEARCHPATH_SEPARATOR-separated list of substitutions to perform -during resource lookups. It is ignored when running in a setuid process. +to [`glib-compile-resources`](glib-compile-resources.html). `get_resource()` +returns the generated `GResource` object. The register and unregister +functions register the resource so its files can be accessed using +[func@Gio.resources_lookup_data]. + +Once a `GResource` has been created and registered all the data in it can be +accessed globally in the process by using API calls like +[func@Gio.resources_open_stream] to stream the data or +[func@Gio.resources_lookup_data] to get a direct pointer to the data. You can +also use URIs like `resource:///org/gtk/Example/data/splashscreen.png` with +[iface@Gio.File] to access the resource data. + +Some higher-level APIs, such as [`GtkApplication`](https://docs.gtk.org/gtk4/class.Application.html), +will automatically load resources from certain well-known paths in the +resource namespace as a convenience. See the documentation for those APIs +for details. + +There are two forms of the generated source, the default version uses the +compiler support for constructor and destructor functions (where available) +to automatically create and register the `GResource` on startup or library +load time. If you pass `--manual-register`, two functions to +register/unregister the resource are created instead. This requires an +explicit initialization call in your application/library, but it works on all +platforms, even on the minor ones where constructors are not supported. +(Constructor support is available for at least Win32, Mac OS and Linux.) + +Note that resource data can point directly into the data segment of e.g. a +library, so if you are unloading libraries during runtime you need to be very +careful with keeping around pointers to data from a resource, as this goes +away when the library is unloaded. However, in practice this is not generally +a problem, since most resource accesses are for your own resources, and +resource data is often used once, during parsing, and then released. + +# Overlays + +When debugging a program or testing a change to an installed version, it is +often useful to be able to replace resources in the program or library, +without recompiling, for debugging or quick hacking and testing purposes. +Since GLib 2.50, it is possible to use the `G_RESOURCE_OVERLAYS` environment +variable to selectively overlay resources with replacements from the +filesystem. It is a `G_SEARCHPATH_SEPARATOR`-separated list of substitutions +to perform during resource lookups. It is ignored when running in a setuid +process. A substitution has the form -|[ - /org/gtk/libgtk=/home/desrt/gtk-overlay -]| +``` +/org/gtk/libgtk=/home/desrt/gtk-overlay +``` -The part before the `=` is the resource subpath for which the overlay applies. The part after is a -filesystem path which contains files and subdirectories as you would like to be loaded as resources with the +The part before the `=` is the resource subpath for which the overlay +applies. The part after is a filesystem path which contains files and +subdirectories as you would like to be loaded as resources with the equivalent names. -In the example above, if an application tried to load a resource with the resource path -`/org/gtk/libgtk/ui/gtkdialog.ui` then GResource would check the filesystem path -`/home/desrt/gtk-overlay/ui/gtkdialog.ui`. If a file was found there, it would be used instead. This is an -overlay, not an outright replacement, which means that if a file is not found at that path, the built-in -version will be used instead. Whiteouts are not currently supported. - -Substitutions must start with a slash, and must not contain a trailing slash before the '='. The path after -the slash should ideally be absolute, but this is not strictly required. It is possible to overlay the -location of a single resource with an individual file. - +In the example above, if an application tried to load a resource with the +resource path `/org/gtk/libgtk/ui/gtkdialog.ui` then `GResource` would check +the filesystem path `/home/desrt/gtk-overlay/ui/gtkdialog.ui`. If a file was +found there, it would be used instead. This is an overlay, not an outright +replacement, which means that if a file is not found at that path, the +built-in version will be used instead. Whiteouts are not currently +supported. + +Substitutions must start with a slash, and must not contain a trailing slash +before the `=`. The path after the slash should ideally be absolute, but +this is not strictly required. It is possible to overlay the location of a +single resource with an individual file. + Creates a GResource from a reference to the binary resource bundle. + filename="gio/gresource.c" + line="590">Creates a GResource from a reference to the binary resource bundle. This will keep a reference to @data while the resource lives, so the data should not be modified or freed. @@ -97829,19 +98336,18 @@ Otherwise this function will internally create a copy of the memory since GLib 2.56, or in older versions fail and exit the process. If @data is empty or corrupt, %G_RESOURCE_ERROR_INTERNAL will be returned. - + a new #GResource, or %NULL on error + filename="gio/gresource.c" + line="608">a new #GResource, or %NULL on error A #GBytes + filename="gio/gresource.c" + line="592">A #GBytes @@ -97851,20 +98357,19 @@ If @data is empty or corrupt, %G_RESOURCE_ERROR_INTERNAL will be returned. moved-to="resources_register" version="2.32"> Registers the resource with the process-global set of resources. + filename="gio/gresource.c" + line="1043">Registers the resource with the process-global set of resources. Once a resource is registered the files in it can be accessed with the global resource lookup functions like g_resources_lookup_data(). - + A #GResource + filename="gio/gresource.c" + line="1045">A #GResource @@ -97874,18 +98379,17 @@ with the global resource lookup functions like g_resources_lookup_data(). moved-to="resources_unregister" version="2.32"> Unregisters the resource from the process-global set of resources. - + filename="gio/gresource.c" + line="1061">Unregisters the resource from the process-global set of resources. + A #GResource + filename="gio/gresource.c" + line="1063">A #GResource @@ -97895,8 +98399,8 @@ with the global resource lookup functions like g_resources_lookup_data(). version="2.32" throws="1"> Returns all the names of children at the specified @path in the resource. + filename="gio/gresource.c" + line="926">Returns all the names of children at the specified @path in the resource. The return result is a %NULL terminated list of strings which should be released with g_strfreev(). @@ -97904,12 +98408,11 @@ If @path is invalid or does not exist in the #GResource, %G_RESOURCE_ERROR_NOT_FOUND will be returned. @lookup_flags controls the behaviour of the lookup. - + an array of constant strings + filename="gio/gresource.c" + line="942">an array of constant strings @@ -97917,20 +98420,20 @@ If @path is invalid or does not exist in the #GResource, A #GResource + filename="gio/gresource.c" + line="928">A #GResource A pathname inside the resource + filename="gio/gresource.c" + line="929">A pathname inside the resource A #GResourceLookupFlags + filename="gio/gresource.c" + line="930">A #GResourceLookupFlags @@ -97940,36 +98443,35 @@ If @path is invalid or does not exist in the #GResource, version="2.32" throws="1"> Looks for a file at the specified @path in the resource and + filename="gio/gresource.c" + line="895">Looks for a file at the specified @path in the resource and if found returns information about it. @lookup_flags controls the behaviour of the lookup. - + %TRUE if the file was found. %FALSE if there were errors + filename="gio/gresource.c" + line="911">%TRUE if the file was found. %FALSE if there were errors A #GResource + filename="gio/gresource.c" + line="897">A #GResource A pathname inside the resource + filename="gio/gresource.c" + line="898">A pathname inside the resource A #GResourceLookupFlags + filename="gio/gresource.c" + line="899">A #GResourceLookupFlags a location to place the length of the contents of the file, + filename="gio/gresource.c" + line="900">a location to place the length of the contents of the file, or %NULL if the length is not needed @@ -97991,8 +98493,8 @@ if found returns information about it. optional="1" allow-none="1"> a location to place the flags about the file, + filename="gio/gresource.c" + line="902">a location to place the flags about the file, or %NULL if the length is not needed @@ -98003,8 +98505,8 @@ if found returns information about it. version="2.32" throws="1"> Looks for a file at the specified @path in the resource and + filename="gio/gresource.c" + line="796">Looks for a file at the specified @path in the resource and returns a #GBytes that lets you directly access the data in memory. @@ -98018,32 +98520,31 @@ in the program binary. For compressed files we allocate memory on the heap and automatically uncompress the data. @lookup_flags controls the behaviour of the lookup. - + #GBytes or %NULL on error. + filename="gio/gresource.c" + line="818">#GBytes or %NULL on error. Free the returned object with g_bytes_unref() A #GResource + filename="gio/gresource.c" + line="798">A #GResource A pathname inside the resource + filename="gio/gresource.c" + line="799">A pathname inside the resource A #GResourceLookupFlags + filename="gio/gresource.c" + line="800">A #GResourceLookupFlags @@ -98053,80 +98554,77 @@ the heap and automatically uncompress the data. version="2.32" throws="1"> Looks for a file at the specified @path in the resource and + filename="gio/gresource.c" + line="746">Looks for a file at the specified @path in the resource and returns a #GInputStream that lets you read the data. @lookup_flags controls the behaviour of the lookup. - + #GInputStream or %NULL on error. + filename="gio/gresource.c" + line="758">#GInputStream or %NULL on error. Free the returned object with g_object_unref() A #GResource + filename="gio/gresource.c" + line="748">A #GResource A pathname inside the resource + filename="gio/gresource.c" + line="749">A pathname inside the resource A #GResourceLookupFlags + filename="gio/gresource.c" + line="750">A #GResourceLookupFlags Atomically increments the reference count of @resource by one. This + filename="gio/gresource.c" + line="520">Atomically increments the reference count of @resource by one. This function is MT-safe and may be called from any thread. - + The passed in #GResource + filename="gio/gresource.c" + line="527">The passed in #GResource A #GResource + filename="gio/gresource.c" + line="522">A #GResource Atomically decrements the reference count of @resource by one. If the + filename="gio/gresource.c" + line="538">Atomically decrements the reference count of @resource by one. If the reference count drops to 0, all memory allocated by the resource is released. This function is MT-safe and may be called from any thread. - + A #GResource + filename="gio/gresource.c" + line="540">A #GResource @@ -98136,8 +98634,8 @@ thread. version="2.32" throws="1"> Loads a binary resource bundle and creates a #GResource representation of it, allowing + filename="gio/gresource.c" + line="641">Loads a binary resource bundle and creates a #GResource representation of it, allowing you to query it for data. If you want to use this resource in the global resource namespace you need @@ -98147,19 +98645,18 @@ If @filename is empty or the data in it is corrupt, %G_RESOURCE_ERROR_INTERNAL will be returned. If @filename doesn’t exist, or there is an error in reading it, an error from g_mapped_file_new() will be returned. - + a new #GResource, or %NULL on error + filename="gio/gresource.c" + line="657">a new #GResource, or %NULL on error the path of a filename to load, in the GLib filename encoding + filename="gio/gresource.c" + line="643">the path of a filename to load, in the GLib filename encoding @@ -98172,8 +98669,8 @@ returned. c:type="GResourceError" glib:error-domain="g-resource-error-quark"> An error code used with %G_RESOURCE_ERROR in a #GError returned + filename="gio/gioenums.h" + line="780">An error code used with %G_RESOURCE_ERROR in a #GError returned from a #GResource routine. glib:nick="not-found" glib:name="G_RESOURCE_ERROR_NOT_FOUND"> no file was found at the requested path + filename="gio/gioenums.h" + line="782">no file was found at the requested path glib:nick="internal" glib:name="G_RESOURCE_ERROR_INTERNAL"> unknown error + filename="gio/gioenums.h" + line="783">unknown error Gets the #GResource Error Quark. + filename="gio/gresource.c" + line="509">Gets the #GResource Error Quark. a #GQuark + filename="gio/gresource.c" + line="514">a #GQuark @@ -98213,8 +98710,8 @@ from a #GResource routine. glib:get-type="g_resource_flags_get_type" c:type="GResourceFlags"> GResourceFlags give information about a particular file inside a resource + filename="gio/gioenums.h" + line="795">GResourceFlags give information about a particular file inside a resource bundle. glib:nick="none" glib:name="G_RESOURCE_FLAGS_NONE"> No flags set. + filename="gio/gioenums.h" + line="797">No flags set. glib:nick="compressed" glib:name="G_RESOURCE_FLAGS_COMPRESSED"> The file is compressed. + filename="gio/gioenums.h" + line="798">The file is compressed. glib:get-type="g_resource_lookup_flags_get_type" c:type="GResourceLookupFlags"> GResourceLookupFlags determine how resource path lookups are handled. + filename="gio/gioenums.h" + line="810">GResourceLookupFlags determine how resource path lookups are handled. No flags set. + filename="gio/gioenums.h" + line="812">No flags set. - + @@ -98266,8 +98762,7 @@ bundle. - + @@ -98276,8 +98771,7 @@ bundle. - + @@ -98286,8 +98780,7 @@ bundle. - + @@ -98296,8 +98789,7 @@ bundle. - + @@ -98307,17 +98799,15 @@ bundle. value="gsettings-backend" c:type="G_SETTINGS_BACKEND_EXTENSION_POINT_NAME"> Extension point for #GSettingsBackend functionality. - + - + @@ -98326,8 +98816,7 @@ bundle. - + @@ -98336,8 +98825,7 @@ bundle. - + @@ -98346,8 +98834,7 @@ bundle. - + @@ -98356,8 +98843,7 @@ bundle. - + @@ -98366,8 +98852,7 @@ bundle. - + @@ -98376,8 +98861,7 @@ bundle. - + @@ -98386,8 +98870,7 @@ bundle. - + @@ -98396,8 +98879,7 @@ bundle. - + @@ -98406,8 +98888,7 @@ bundle. - + @@ -98416,8 +98897,7 @@ bundle. - + @@ -98426,8 +98906,7 @@ bundle. - + @@ -98436,8 +98915,7 @@ bundle. - + @@ -98446,8 +98924,7 @@ bundle. - + @@ -98456,16 +98933,14 @@ bundle. - + - + @@ -98474,8 +98949,7 @@ bundle. - + @@ -98484,8 +98958,7 @@ bundle. - + @@ -98494,8 +98967,7 @@ bundle. - + @@ -98504,8 +98976,7 @@ bundle. - + @@ -98514,8 +98985,7 @@ bundle. - + @@ -98524,8 +98994,7 @@ bundle. - + @@ -98534,8 +99003,7 @@ bundle. - + @@ -98544,8 +99012,7 @@ bundle. - + @@ -98554,8 +99021,7 @@ bundle. - + @@ -98564,8 +99030,7 @@ bundle. - + @@ -98574,8 +99039,7 @@ bundle. - + @@ -98584,8 +99048,7 @@ bundle. - + @@ -98594,8 +99057,7 @@ bundle. - + @@ -98604,8 +99066,7 @@ bundle. - + @@ -98614,8 +99075,7 @@ bundle. - + @@ -98624,8 +99084,7 @@ bundle. - + @@ -98634,8 +99093,7 @@ bundle. - + @@ -98644,8 +99102,7 @@ bundle. - + @@ -98654,8 +99111,7 @@ bundle. - + @@ -98664,8 +99120,7 @@ bundle. - + @@ -98674,8 +99129,7 @@ bundle. - + @@ -98684,8 +99138,7 @@ bundle. - + @@ -98694,8 +99147,7 @@ bundle. - + @@ -98704,8 +99156,7 @@ bundle. - + @@ -98714,8 +99165,7 @@ bundle. - + @@ -98724,8 +99174,7 @@ bundle. - + @@ -98734,8 +99183,7 @@ bundle. - + @@ -98748,70 +99196,67 @@ bundle. glib:get-type="g_seekable_get_type" glib:type-struct="SeekableIface"> #GSeekable is implemented by streams (implementations of -#GInputStream or #GOutputStream) that support seeking. + filename="gio/gseekable.c" + line="28">`GSeekable` is implemented by streams (implementations of +[class@Gio.InputStream] or [class@Gio.OutputStream]) that support seeking. Seekable streams largely fall into two categories: resizable and fixed-size. -#GSeekable on fixed-sized streams is approximately the same as POSIX -lseek() on a block device (for example: attempting to seek past the -end of the device is an error). Fixed streams typically cannot be +`GSeekable` on fixed-sized streams is approximately the same as POSIX +[`lseek()`](man:lseek(2)) on a block device (for example: attempting to seek +past the end of the device is an error). Fixed streams typically cannot be truncated. -#GSeekable on resizable streams is approximately the same as POSIX -lseek() on a normal file. Seeking past the end and writing data will -usually cause the stream to resize by introducing zero bytes. - +`GSeekable` on resizable streams is approximately the same as POSIX +[`lseek()`](man:lseek(2)) on a normal file. Seeking past the end and writing +data will usually cause the stream to resize by introducing zero bytes. + Tests if the stream supports the #GSeekableIface. - + filename="gio/gseekable.c" + line="76">Tests if the stream supports the #GSeekableIface. + %TRUE if @seekable can be seeked. %FALSE otherwise. + filename="gio/gseekable.c" + line="82">%TRUE if @seekable can be seeked. %FALSE otherwise. a #GSeekable. + filename="gio/gseekable.c" + line="78">a #GSeekable. Tests if the length of the stream can be adjusted with + filename="gio/gseekable.c" + line="140">Tests if the length of the stream can be adjusted with g_seekable_truncate(). - + %TRUE if the stream can be truncated, %FALSE otherwise. + filename="gio/gseekable.c" + line="147">%TRUE if the stream can be truncated, %FALSE otherwise. a #GSeekable. + filename="gio/gseekable.c" + line="142">a #GSeekable. Seeks in the stream by the given @offset, modified by @type. + filename="gio/gseekable.c" + line="96">Seeks in the stream by the given @offset, modified by @type. Attempting to seek past the end of the stream will have different results depending on if the stream is fixed-sized or resizable. If @@ -98825,12 +99270,11 @@ Any operation that would result in a negative offset will fail. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if successful. If an error + filename="gio/gseekable.c" + line="120">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -98838,20 +99282,20 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GSeekable. + filename="gio/gseekable.c" + line="98">a #GSeekable. a #goffset. + filename="gio/gseekable.c" + line="99">a #goffset. a #GSeekType. + filename="gio/gseekable.c" + line="100">a #GSeekType. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gseekable.c" + line="101">optional #GCancellable object, %NULL to ignore. Tells the current position within the stream. - + filename="gio/gseekable.c" + line="55">Tells the current position within the stream. + the (positive or zero) offset from the beginning of the + filename="gio/gseekable.c" + line="61">the (positive or zero) offset from the beginning of the buffer, zero if the target is not seekable. a #GSeekable. + filename="gio/gseekable.c" + line="57">a #GSeekable. Sets the length of the stream to @offset. If the stream was previously + filename="gio/gseekable.c" + line="161">Sets the length of the stream to @offset. If the stream was previously larger than @offset, the extra data is discarded. If the stream was previously shorter than @offset, it is extended with NUL ('\0') bytes. @@ -98899,12 +99342,11 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error. - + %TRUE if successful. If an error + filename="gio/gseekable.c" + line="179">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -98912,14 +99354,14 @@ partial result will be returned, without an error. a #GSeekable. + filename="gio/gseekable.c" + line="163">a #GSeekable. new length for @seekable, in bytes. + filename="gio/gseekable.c" + line="164">new length for @seekable, in bytes. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gseekable.c" + line="165">optional #GCancellable object, %NULL to ignore. Tests if the stream supports the #GSeekableIface. - + filename="gio/gseekable.c" + line="76">Tests if the stream supports the #GSeekableIface. + %TRUE if @seekable can be seeked. %FALSE otherwise. + filename="gio/gseekable.c" + line="82">%TRUE if @seekable can be seeked. %FALSE otherwise. a #GSeekable. + filename="gio/gseekable.c" + line="78">a #GSeekable. Tests if the length of the stream can be adjusted with + filename="gio/gseekable.c" + line="140">Tests if the length of the stream can be adjusted with g_seekable_truncate(). - + %TRUE if the stream can be truncated, %FALSE otherwise. + filename="gio/gseekable.c" + line="147">%TRUE if the stream can be truncated, %FALSE otherwise. a #GSeekable. + filename="gio/gseekable.c" + line="142">a #GSeekable. Seeks in the stream by the given @offset, modified by @type. + filename="gio/gseekable.c" + line="96">Seeks in the stream by the given @offset, modified by @type. Attempting to seek past the end of the stream will have different results depending on if the stream is fixed-sized or resizable. If @@ -98993,12 +99433,11 @@ Any operation that would result in a negative offset will fail. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + %TRUE if successful. If an error + filename="gio/gseekable.c" + line="120">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -99006,20 +99445,20 @@ was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. a #GSeekable. + filename="gio/gseekable.c" + line="98">a #GSeekable. a #goffset. + filename="gio/gseekable.c" + line="99">a #goffset. a #GSeekType. + filename="gio/gseekable.c" + line="100">a #GSeekType. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gseekable.c" + line="101">optional #GCancellable object, %NULL to ignore. Tells the current position within the stream. - + filename="gio/gseekable.c" + line="55">Tells the current position within the stream. + the (positive or zero) offset from the beginning of the + filename="gio/gseekable.c" + line="61">the (positive or zero) offset from the beginning of the buffer, zero if the target is not seekable. a #GSeekable. + filename="gio/gseekable.c" + line="57">a #GSeekable. Sets the length of the stream to @offset. If the stream was previously + filename="gio/gseekable.c" + line="161">Sets the length of the stream to @offset. If the stream was previously larger than @offset, the extra data is discarded. If the stream was previously shorter than @offset, it is extended with NUL ('\0') bytes. @@ -99067,12 +99505,11 @@ triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an operation was partially finished when the operation was cancelled the partial result will be returned, without an error. - + %TRUE if successful. If an error + filename="gio/gseekable.c" + line="179">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -99080,14 +99517,14 @@ partial result will be returned, without an error. a #GSeekable. + filename="gio/gseekable.c" + line="163">a #GSeekable. new length for @seekable, in bytes. + filename="gio/gseekable.c" + line="164">new length for @seekable, in bytes. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gseekable.c" + line="165">optional #GCancellable object, %NULL to ignore. @@ -99106,65 +99543,70 @@ partial result will be returned, without an error. c:type="GSeekableIface" glib:is-gtype-struct-for="Seekable"> Provides an interface for implementing seekable functionality on I/O Streams. - + filename="gio/gseekable.h" + line="41">Provides an interface for implementing seekable functionality on I/O Streams. + The parent interface. + filename="gio/gseekable.h" + line="43">The parent interface. + Tells the current location within a stream. - + the (positive or zero) offset from the beginning of the + filename="gio/gseekable.c" + line="61">the (positive or zero) offset from the beginning of the buffer, zero if the target is not seekable. a #GSeekable. + filename="gio/gseekable.c" + line="57">a #GSeekable. + Checks if seeking is supported by the stream. - + %TRUE if @seekable can be seeked. %FALSE otherwise. + filename="gio/gseekable.c" + line="82">%TRUE if @seekable can be seeked. %FALSE otherwise. a #GSeekable. + filename="gio/gseekable.c" + line="78">a #GSeekable. + Seeks to a location within a stream. - + %TRUE if successful. If an error + filename="gio/gseekable.c" + line="120">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -99172,20 +99614,20 @@ buffer, zero if the target is not seekable. a #GSeekable. + filename="gio/gseekable.c" + line="98">a #GSeekable. a #goffset. + filename="gio/gseekable.c" + line="99">a #goffset. a #GSeekType. + filename="gio/gseekable.c" + line="100">a #GSeekType. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gseekable.c" + line="101">optional #GCancellable object, %NULL to ignore. + Checks if truncation is supported by the stream. - + %TRUE if the stream can be truncated, %FALSE otherwise. + filename="gio/gseekable.c" + line="147">%TRUE if the stream can be truncated, %FALSE otherwise. a #GSeekable. + filename="gio/gseekable.c" + line="142">a #GSeekable. + Truncates a stream. - + %TRUE if successful. If an error + filename="gio/gseekable.c" + line="179">%TRUE if successful. If an error has occurred, this function will return %FALSE and set @error appropriately if present. @@ -99235,14 +99681,14 @@ buffer, zero if the target is not seekable. a #GSeekable. + filename="gio/gseekable.c" + line="163">a #GSeekable. new length for @seekable, in bytes. + filename="gio/gseekable.c" + line="164">new length for @seekable, in bytes. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gseekable.c" + line="165">optional #GCancellable object, %NULL to ignore. @@ -99266,113 +99712,114 @@ buffer, zero if the target is not seekable. glib:get-type="g_settings_get_type" glib:type-struct="SettingsClass"> The #GSettings class provides a convenient API for storing and retrieving + filename="gio/gsettings.c" + line="39">The `GSettings` class provides a convenient API for storing and retrieving application settings. Reads and writes can be considered to be non-blocking. Reading -settings with #GSettings is typically extremely fast: on +settings with `GSettings` is typically extremely fast: on approximately the same order of magnitude (but slower than) a -#GHashTable lookup. Writing settings is also extremely fast in terms -of time to return to your application, but can be extremely expensive +[struct@GLib.HashTable] lookup. Writing settings is also extremely fast in +terms of time to return to your application, but can be extremely expensive for other threads and other processes. Many settings backends (including dconf) have lazy initialisation which means in the common case of the user using their computer without modifying any settings -a lot of work can be avoided. For dconf, the D-Bus service doesn't +a lot of work can be avoided. For dconf, the D-Bus service doesn’t even need to be started in this case. For this reason, you should -only ever modify #GSettings keys in response to explicit user action. +only ever modify `GSettings` keys in response to explicit user action. Particular care should be paid to ensure that modifications are not -made during startup -- for example, when setting the initial value -of preferences widgets. The built-in g_settings_bind() functionality -is careful not to write settings in response to notify signals as a -result of modifications that it makes to widgets. +made during startup — for example, when setting the initial value +of preferences widgets. The built-in [method@Gio.Settings.bind] +functionality is careful not to write settings in response to notify signals +as a result of modifications that it makes to widgets. -When creating a GSettings instance, you have to specify a schema +When creating a `GSettings` instance, you have to specify a schema that describes the keys in your settings and their types and default values, as well as some other information. Normally, a schema has a fixed path that determines where the settings are stored in the conceptual global tree of settings. However, schemas -can also be '[relocatable][gsettings-relocatable]', i.e. not equipped with +can also be ‘[relocatable](#relocatable-schemas)’, i.e. not equipped with a fixed path. This is -useful e.g. when the schema describes an 'account', and you want to be +useful e.g. when the schema describes an ‘account’, and you want to be able to store a arbitrary number of accounts. -Paths must start with and end with a forward slash character ('/') +Paths must start with and end with a forward slash character (`/`) and must not contain two sequential slash characters. Paths should be chosen based on a domain name associated with the program or library to which the settings belong. Examples of paths are -"/org/gtk/settings/file-chooser/" and "/ca/desrt/dconf-editor/". -Paths should not start with "/apps/", "/desktop/" or "/system/" as +`/org/gtk/settings/file-chooser/` and `/ca/desrt/dconf-editor/`. +Paths should not start with `/apps/`, `/desktop/` or `/system/` as they often did in GConf. Unlike other configuration systems (like GConf), GSettings does not restrict keys to basic types like strings and numbers. GSettings stores -values as #GVariant, and allows any #GVariantType for keys. Key names -are restricted to lowercase characters, numbers and '-'. Furthermore, -the names must begin with a lowercase character, must not end -with a '-', and must not contain consecutive dashes. +values as [struct@GLib.Variant], and allows any [type@GLib.VariantType] for +keys. Key names are restricted to lowercase characters, numbers and `-`. +Furthermore, the names must begin with a lowercase character, must not end +with a `-`, and must not contain consecutive dashes. Similar to GConf, the default values in GSettings schemas can be localized, but the localized values are stored in gettext catalogs and looked up with the domain that is specified in the -`gettext-domain` attribute of the <schemalist> or <schema> +`gettext-domain` attribute of the `<schemalist>` or `<schema>` elements and the category that is specified in the `l10n` attribute of -the <default> element. The string which is translated includes all text in -the <default> element, including any surrounding quotation marks. +the `<default>` element. The string which is translated includes all text in +the `<default>` element, including any surrounding quotation marks. The `l10n` attribute must be set to `messages` or `time`, and sets the [locale category for translation](https://www.gnu.org/software/gettext/manual/html_node/Aspects.html#index-locale-categories-1). The `messages` category should be used by default; use `time` for translatable date or time formats. A translation comment can be added as an -XML comment immediately above the <default> element — it is recommended to +XML comment immediately above the `<default>` element — it is recommended to add these comments to aid translators understand the meaning and implications of the default value. An optional translation `context` -attribute can be set on the <default> element to disambiguate multiple +attribute can be set on the `<default>` element to disambiguate multiple defaults which use the same string. For example: -|[ +```xml <!-- Translators: A list of words which are not allowed to be typed, in GVariant serialization syntax. See: https://developer.gnome.org/glib/stable/gvariant-text.html --> <default l10n='messages' context='Banned words'>['bad', 'words']</default> -]| +``` Translations of default values must remain syntactically valid serialized -#GVariants (e.g. retaining any surrounding quotation marks) or runtime -errors will occur. +[struct@GLib.Variant]s (e.g. retaining any surrounding quotation marks) or +runtime errors will occur. GSettings uses schemas in a compact binary form that is created -by the [glib-compile-schemas][glib-compile-schemas] +by the [`glib-compile-schemas`](glib-compile-schemas.html) utility. The input is a schema description in an XML format. A DTD for the gschema XML format can be found here: [gschema.dtd](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/gschema.dtd) -The [glib-compile-schemas][glib-compile-schemas] tool expects schema +The [`glib-compile-schemas`](glib-compile-schemas.html) tool expects schema files to have the extension `.gschema.xml`. -At runtime, schemas are identified by their id (as specified in the -id attribute of the <schema> element). The convention for schema -ids is to use a dotted name, similar in style to a D-Bus bus name, -e.g. "org.gnome.SessionManager". In particular, if the settings are +At runtime, schemas are identified by their ID (as specified in the +`id` attribute of the `<schema>` element). The convention for schema +IDs is to use a dotted name, similar in style to a D-Bus bus name, +e.g. `org.gnome.SessionManager`. In particular, if the settings are for a specific service that owns a D-Bus bus name, the D-Bus bus name -and schema id should match. For schemas which deal with settings not -associated with one named application, the id should not use -StudlyCaps, e.g. "org.gnome.font-rendering". - -In addition to #GVariant types, keys can have types that have -enumerated types. These can be described by a <choice>, -<enum> or <flags> element, as seen in the -[example][schema-enumerated]. The underlying type of such a key -is string, but you can use g_settings_get_enum(), g_settings_set_enum(), -g_settings_get_flags(), g_settings_set_flags() access the numeric values -corresponding to the string value of enum and flags keys. +and schema ID should match. For schemas which deal with settings not +associated with one named application, the ID should not use +StudlyCaps, e.g. `org.gnome.font-rendering`. + +In addition to [struct@GLib.Variant] types, keys can have types that have +enumerated types. These can be described by a `<choice>`, +`<enum>` or `<flags>` element, as seen in the +second example below. The underlying type of such a key +is string, but you can use [method@Gio.Settings.get_enum], +[method@Gio.Settings.set_enum], [method@Gio.Settings.get_flags], +[method@Gio.Settings.set_flags] access the numeric values corresponding to +the string value of enum and flags keys. An example for default value: -|[ +```xml <schemalist> <schema id="org.gtk.Test" path="/org/gtk/Test/" gettext-domain="test"> @@ -99395,10 +99842,10 @@ An example for default value: </schema> </schemalist> -]| +``` An example for ranges, choices and enumerated types: -|[ +```xml <schemalist> <enum id="org.gtk.Test.myenum"> @@ -99441,7 +99888,7 @@ An example for ranges, choices and enumerated types: </key> </schema> </schemalist> -]| +``` ## Vendor overrides @@ -99449,41 +99896,42 @@ Default values are defined in the schemas that get installed by an application. Sometimes, it is necessary for a vendor or distributor to adjust these defaults. Since patching the XML source for the schema is inconvenient and error-prone, -[glib-compile-schemas][glib-compile-schemas] reads so-called vendor -override' files. These are keyfiles in the same directory as the XML -schema sources which can override default values. The schema id serves +[`glib-compile-schemas`](glib-compile-schemas.html) reads so-called ‘vendor +override’ files. These are keyfiles in the same directory as the XML +schema sources which can override default values. The schema ID serves as the group name in the key file, and the values are expected in -serialized GVariant form, as in the following example: -|[ - [org.gtk.Example] - key1='string' - key2=1.5 -]| - -glib-compile-schemas expects schema files to have the extension +serialized [struct@GLib.Variant] form, as in the following example: +``` +[org.gtk.Example] +key1='string' +key2=1.5 +``` + +`glib-compile-schemas` expects schema files to have the extension `.gschema.override`. ## Binding -A very convenient feature of GSettings lets you bind #GObject properties -directly to settings, using g_settings_bind(). Once a GObject property -has been bound to a setting, changes on either side are automatically -propagated to the other side. GSettings handles details like mapping -between GObject and GVariant types, and preventing infinite cycles. +A very convenient feature of GSettings lets you bind [class@GObject.Object] +properties directly to settings, using [method@Gio.Settings.bind]. Once a +[class@GObject.Object] property has been bound to a setting, changes on +either side are automatically propagated to the other side. GSettings handles +details like mapping between [class@GObject.Object] and [struct@GLib.Variant] +types, and preventing infinite cycles. This makes it very easy to hook up a preferences dialog to the underlying settings. To make this even more convenient, GSettings -looks for a boolean property with the name "sensitivity" and +looks for a boolean property with the name `sensitivity` and automatically binds it to the writability of the bound setting. -If this 'magic' gets in the way, it can be suppressed with the -%G_SETTINGS_BIND_NO_SENSITIVITY flag. +If this ‘magic’ gets in the way, it can be suppressed with the +`G_SETTINGS_BIND_NO_SENSITIVITY` flag. -## Relocatable schemas # {#gsettings-relocatable} +## Relocatable schemas A relocatable schema is one with no `path` attribute specified on its -<schema> element. By using g_settings_new_with_path(), a #GSettings object -can be instantiated for a relocatable schema, assigning a path to the -instance. Paths passed to g_settings_new_with_path() will typically be +`<schema>` element. By using [ctor@Gio.Settings.new_with_path], a `GSettings` +object can be instantiated for a relocatable schema, assigning a path to the +instance. Paths passed to [ctor@Gio.Settings.new_with_path] will typically be constructed dynamically from a constant prefix plus some form of instance identifier; but they must still be valid GSettings paths. Paths could also be constant and used with a globally installed schema originating from a @@ -99494,59 +99942,59 @@ for different windows in an application. If the schema ID was `org.foo.MyApp.Window`, it could be instantiated for paths `/org/foo/MyApp/main/`, `/org/foo/MyApp/document-1/`, `/org/foo/MyApp/document-2/`, etc. If any of the paths are well-known -they can be specified as <child> elements in the parent schema, e.g.: -|[ +they can be specified as `<child>` elements in the parent schema, e.g.: +```xml <schema id="org.foo.MyApp" path="/org/foo/MyApp/"> <child name="main" schema="org.foo.MyApp.Window"/> </schema> -]| +``` -## Build system integration # {#gsettings-build-system} +## Build system integration GSettings comes with autotools integration to simplify compiling and installing schemas. To add GSettings support to an application, add the following to your `configure.ac`: -|[ +``` GLIB_GSETTINGS -]| +``` In the appropriate `Makefile.am`, use the following snippet to compile and install the named schema: -|[ +``` gsettings_SCHEMAS = org.foo.MyApp.gschema.xml EXTRA_DIST = $(gsettings_SCHEMAS) @GSETTINGS_RULES@ -]| +``` No changes are needed to the build system to mark a schema XML file for translation. Assuming it sets the `gettext-domain` attribute, a schema may be marked for translation by adding it to `POTFILES.in`, assuming gettext 0.19 is in use (the preferred method for translation): -|[ +``` data/org.foo.MyApp.gschema.xml -]| +``` Alternatively, if intltool 0.50.1 is in use: -|[ +``` [type: gettext/gsettings]data/org.foo.MyApp.gschema.xml -]| +``` -GSettings will use gettext to look up translations for the <summary> and -<description> elements, and also any <default> elements which have a `l10n` -attribute set. Translations must not be included in the `.gschema.xml` file -by the build system, for example by using intltool XML rules with a +GSettings will use gettext to look up translations for the `<summary>` and +`<description>` elements, and also any `<default>` elements which have a +`l10n` attribute set. Translations must not be included in the `.gschema.xml` +file by the build system, for example by using intltool XML rules with a `.gschema.xml.in` template. If an enumerated type defined in a C header file is to be used in a GSettings -schema, it can either be defined manually using an <enum> element in the +schema, it can either be defined manually using an `<enum>` element in the schema XML, or it can be extracted automatically from the C header. This approach is preferred, as it ensures the two representations are always synchronised. To do so, add the following to the relevant `Makefile.am`: -|[ +``` gsettings_ENUM_NAMESPACE = org.foo.MyApp gsettings_ENUM_FILES = my-app-enums.h my-app-misc.h -]| +``` `gsettings_ENUM_NAMESPACE` specifies the schema namespace for the enum files, which are specified in `gsettings_ENUM_FILES`. This will generate a @@ -99554,12 +100002,11 @@ which are specified in `gsettings_ENUM_FILES`. This will generate a automatically included in the schema compilation, install and uninstall rules. It should not be committed to version control or included in `EXTRA_DIST`. - + Creates a new #GSettings object with the schema specified by + filename="gio/gsettings.c" + line="936">Creates a new #GSettings object with the schema specified by @schema_id. It is an error for the schema to not exist: schemas are an @@ -99572,19 +100019,18 @@ Signals on the newly created #GSettings object will be dispatched via the thread-default #GMainContext in effect at the time of the call to g_settings_new(). The new #GSettings will hold a reference on the context. See g_main_context_push_thread_default(). - + a new #GSettings object + filename="gio/gsettings.c" + line="954">a new #GSettings object the id of the schema + filename="gio/gsettings.c" + line="938">the id of the schema @@ -99593,8 +100039,8 @@ on the context. See g_main_context_push_thread_default(). c:identifier="g_settings_new_full" version="2.32"> Creates a new #GSettings object with a given schema, backend and + filename="gio/gsettings.c" + line="1082">Creates a new #GSettings object with a given schema, backend and path. It should be extremely rare that you ever want to use this function. @@ -99617,19 +100063,18 @@ If @path is %NULL then the path from the schema is used. It is an error if @path is %NULL and the schema has no path of its own or if @path is non-%NULL and not equal to the path that the schema does have. - + a new #GSettings object + filename="gio/gsettings.c" + line="1112">a new #GSettings object a #GSettingsSchema + filename="gio/gsettings.c" + line="1084">a #GSettingsSchema nullable="1" allow-none="1"> a #GSettingsBackend + filename="gio/gsettings.c" + line="1085">a #GSettingsBackend nullable="1" allow-none="1"> the path to use + filename="gio/gsettings.c" + line="1086">the path to use @@ -99656,8 +100101,8 @@ have. c:identifier="g_settings_new_with_backend" version="2.26"> Creates a new #GSettings object with the schema specified by + filename="gio/gsettings.c" + line="1019">Creates a new #GSettings object with the schema specified by @schema_id and a given #GSettingsBackend. Creating a #GSettings object with a different backend allows accessing @@ -99665,25 +100110,24 @@ settings from a database other than the usual one. For example, it may make sense to pass a backend corresponding to the "defaults" settings database on the system to get a settings object that modifies the system default settings instead of the settings for this user. - + a new #GSettings object + filename="gio/gsettings.c" + line="1033">a new #GSettings object the id of the schema + filename="gio/gsettings.c" + line="1021">the id of the schema the #GSettingsBackend to use + filename="gio/gsettings.c" + line="1022">the #GSettingsBackend to use @@ -99692,37 +100136,36 @@ settings instead of the settings for this user. c:identifier="g_settings_new_with_backend_and_path" version="2.26"> Creates a new #GSettings object with the schema specified by + filename="gio/gsettings.c" + line="1050">Creates a new #GSettings object with the schema specified by @schema_id and a given #GSettingsBackend and path. This is a mix of g_settings_new_with_backend() and g_settings_new_with_path(). - + a new #GSettings object + filename="gio/gsettings.c" + line="1062">a new #GSettings object the id of the schema + filename="gio/gsettings.c" + line="1052">the id of the schema the #GSettingsBackend to use + filename="gio/gsettings.c" + line="1053">the #GSettingsBackend to use the path to use + filename="gio/gsettings.c" + line="1054">the path to use @@ -99731,8 +100174,8 @@ g_settings_new_with_path(). c:identifier="g_settings_new_with_path" version="2.26"> Creates a new #GSettings object with the relocatable schema specified + filename="gio/gsettings.c" + line="983">Creates a new #GSettings object with the relocatable schema specified by @schema_id and a given path. You only need to do this if you want to directly create a settings @@ -99745,25 +100188,24 @@ has an explicitly specified path. It is a programmer error if @path is not a valid path. A valid path begins and ends with '/' and does not contain two consecutive '/' characters. - + a new #GSettings object + filename="gio/gsettings.c" + line="1002">a new #GSettings object the id of the schema + filename="gio/gsettings.c" + line="985">the id of the schema the path to use + filename="gio/gsettings.c" + line="986">the path to use @@ -99774,15 +100216,14 @@ characters. deprecated="1" deprecated-version="2.40"> Deprecated. + filename="gio/gsettingsschema.c" + line="892">Deprecated. Use g_settings_schema_source_list_schemas() instead - + a list of + filename="gio/gsettingsschema.c" + line="897">a list of relocatable #GSettings schemas that are available, in no defined order. The list must not be modified or freed. @@ -99796,18 +100237,17 @@ characters. deprecated="1" deprecated-version="2.40"> Deprecated. + filename="gio/gsettingsschema.c" + line="868">Deprecated. Use g_settings_schema_source_list_schemas() instead. If you used g_settings_list_schemas() to check for the presence of a particular schema, use g_settings_schema_source_lookup() instead of your whole loop. - + a list of + filename="gio/gsettingsschema.c" + line="873">a list of #GSettings schemas that are available, in no defined order. The list must not be modified or freed. @@ -99817,8 +100257,8 @@ of your whole loop. Ensures that all pending operations are complete for the default backend. + filename="gio/gsettings.c" + line="2350">Ensures that all pending operations are complete for the default backend. Writes made to a #GSettings are handled asynchronously. For this reason, it is very unlikely that the changes have it to disk by the @@ -99828,43 +100268,40 @@ This call will block until all of the writes have made it to the backend. Since the mainloop is not running, no change notifications will be dispatched during this call (but some may be queued by the time the call is done). - + Removes an existing binding for @property on @object. + filename="gio/gsettings.c" + line="3109">Removes an existing binding for @property on @object. Note that bindings are automatically removed when the object is finalized, so it is rarely necessary to call this function. - + the object + filename="gio/gsettings.c" + line="3111">the object the property whose binding is removed + filename="gio/gsettings.c" + line="3112">the property whose binding is removed - + @@ -99881,8 +100318,7 @@ function. - + @@ -99896,8 +100332,7 @@ function. - + @@ -99911,8 +100346,7 @@ function. - + @@ -99927,29 +100361,28 @@ function. Applies any changes that have been made to the settings. This + filename="gio/gsettings.c" + line="2259">Applies any changes that have been made to the settings. This function does nothing unless @settings is in 'delay-apply' mode; see g_settings_delay(). In the normal case settings are always applied immediately. - + a #GSettings instance + filename="gio/gsettings.c" + line="2261">a #GSettings instance Create a binding between the @key in the @settings object + filename="gio/gsettings.c" + line="2760">Create a binding between the @key in the @settings object and the property @property of @object. The binding uses the default GIO mapping functions to map @@ -99969,40 +100402,39 @@ Note that the lifecycle of the binding is tied to @object, and that you can have only one binding per object property. If you bind the same property twice on the same object, the second binding overrides the first one. - + a #GSettings object + filename="gio/gsettings.c" + line="2762">a #GSettings object the key to bind + filename="gio/gsettings.c" + line="2763">the key to bind a #GObject + filename="gio/gsettings.c" + line="2764">a #GObject the name of the property to bind + filename="gio/gsettings.c" + line="2765">the name of the property to bind flags for the binding + filename="gio/gsettings.c" + line="2766">flags for the binding @@ -100012,8 +100444,8 @@ binding overrides the first one. version="2.26" introspectable="0"> Create a binding between the @key in the @settings object + filename="gio/gsettings.c" + line="2814">Create a binding between the @key in the @settings object and the property @property of @object. The binding uses the provided mapping functions to map between @@ -100023,46 +100455,45 @@ Note that the lifecycle of the binding is tied to @object, and that you can have only one binding per object property. If you bind the same property twice on the same object, the second binding overrides the first one. - + a #GSettings object + filename="gio/gsettings.c" + line="2816">a #GSettings object the key to bind + filename="gio/gsettings.c" + line="2817">the key to bind a #GObject + filename="gio/gsettings.c" + line="2818">a #GObject the name of the property to bind + filename="gio/gsettings.c" + line="2819">the name of the property to bind flags for the binding + filename="gio/gsettings.c" + line="2820">flags for the binding a function that gets called to convert values + filename="gio/gsettings.c" + line="2821">a function that gets called to convert values from @settings to @object, or %NULL to use the default GIO mapping @@ -100073,8 +100504,8 @@ binding overrides the first one. closure="6" destroy="7"> a function that gets called to convert values + filename="gio/gsettings.c" + line="2823">a function that gets called to convert values from @object to @settings, or %NULL to use the default GIO mapping @@ -100084,14 +100515,14 @@ binding overrides the first one. nullable="1" allow-none="1"> data that gets passed to @get_mapping and @set_mapping + filename="gio/gsettings.c" + line="2825">data that gets passed to @get_mapping and @set_mapping #GDestroyNotify function for @user_data + filename="gio/gsettings.c" + line="2826">#GDestroyNotify function for @user_data @@ -100100,8 +100531,8 @@ binding overrides the first one. c:identifier="g_settings_bind_writable" version="2.26"> Create a binding between the writability of @key in the + filename="gio/gsettings.c" + line="3034">Create a binding between the writability of @key in the @settings object and the property @property of @object. The property must be boolean; "sensitive" or "visible" properties of widgets are the most likely candidates. @@ -100118,40 +100549,39 @@ Note that the lifecycle of the binding is tied to @object, and that you can have only one binding per object property. If you bind the same property twice on the same object, the second binding overrides the first one. - + a #GSettings object + filename="gio/gsettings.c" + line="3036">a #GSettings object the key to bind + filename="gio/gsettings.c" + line="3037">the key to bind a #GObject + filename="gio/gsettings.c" + line="3038">a #GObject the name of a boolean property to bind + filename="gio/gsettings.c" + line="3039">the name of a boolean property to bind whether to 'invert' the value + filename="gio/gsettings.c" + line="3040">whether to 'invert' the value @@ -100160,8 +100590,8 @@ binding overrides the first one. c:identifier="g_settings_create_action" version="2.32"> Creates a #GAction corresponding to a given #GSettings key. + filename="gio/gsettings.c" + line="3343">Creates a #GAction corresponding to a given #GSettings key. The action has the same name as the key. @@ -100175,45 +100605,43 @@ For boolean-valued keys, action activations take no parameter and result in the toggling of the value. For all other types, activations take the new value for the key (which must have the correct type). - + a new #GAction + filename="gio/gsettings.c" + line="3363">a new #GAction a #GSettings + filename="gio/gsettings.c" + line="3345">a #GSettings the name of a key in @settings + filename="gio/gsettings.c" + line="3346">the name of a key in @settings Changes the #GSettings object into 'delay-apply' mode. In this + filename="gio/gsettings.c" + line="2225">Changes the #GSettings object into 'delay-apply' mode. In this mode, changes to @settings are not immediately propagated to the backend, but kept locally until g_settings_apply() is called. - + a #GSettings object + filename="gio/gsettings.c" + line="2227">a #GSettings object @@ -100223,8 +100651,8 @@ backend, but kept locally until g_settings_apply() is called. version="2.26" introspectable="0"> Gets the value that is stored at @key in @settings. + filename="gio/gsettings.c" + line="1593">Gets the value that is stored at @key in @settings. A convenience function that combines g_settings_get_value() with g_variant_get(). @@ -100232,34 +100660,33 @@ g_variant_get(). It is a programmer error to give a @key that isn't contained in the schema for @settings or for the #GVariantType of @format to mismatch the type given in the schema. - + a #GSettings object + filename="gio/gsettings.c" + line="1595">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="1596">the key to get the value for a #GVariant format string + filename="gio/gsettings.c" + line="1597">a #GVariant format string arguments as per @format + filename="gio/gsettings.c" + line="1598">arguments as per @format @@ -100268,32 +100695,31 @@ the type given in the schema. c:identifier="g_settings_get_boolean" version="2.26"> Gets the value that is stored at @key in @settings. + filename="gio/gsettings.c" + line="2104">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for booleans. It is a programmer error to give a @key that isn't specified as having a boolean type in the schema for @settings. - + a boolean + filename="gio/gsettings.c" + line="2116">a boolean a #GSettings object + filename="gio/gsettings.c" + line="2106">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="2107">the key to get the value for @@ -100302,8 +100728,8 @@ having a boolean type in the schema for @settings. c:identifier="g_settings_get_child" version="2.26"> Creates a child settings object which has a base path of + filename="gio/gsettings.c" + line="2397">Creates a child settings object which has a base path of `base-path/@name`, where `base-path` is the base path of @settings. @@ -100312,25 +100738,24 @@ in the schema of @settings using a `<child>` element. The created child settings object will inherit the #GSettings:delay-apply mode from @settings. - + a 'child' settings object + filename="gio/gsettings.c" + line="2412">a 'child' settings object a #GSettings object + filename="gio/gsettings.c" + line="2399">a #GSettings object the name of the child schema + filename="gio/gsettings.c" + line="2400">the name of the child schema @@ -100339,8 +100764,8 @@ mode from @settings. c:identifier="g_settings_get_default_value" version="2.40"> Gets the "default value" of a key. + filename="gio/gsettings.c" + line="1259">Gets the "default value" of a key. This is the value that would be read if g_settings_reset() were to be called on the key. @@ -100361,25 +100786,24 @@ the default value was before the user set it. It is a programmer error to give a @key that isn't contained in the schema for @settings. - + the default value + filename="gio/gsettings.c" + line="1286">the default value a #GSettings object + filename="gio/gsettings.c" + line="1261">a #GSettings object the key to get the default value for + filename="gio/gsettings.c" + line="1262">the key to get the default value for @@ -100388,32 +100812,31 @@ schema for @settings. c:identifier="g_settings_get_double" version="2.26"> Gets the value that is stored at @key in @settings. + filename="gio/gsettings.c" + line="2048">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for doubles. It is a programmer error to give a @key that isn't specified as having a 'double' type in the schema for @settings. - + a double + filename="gio/gsettings.c" + line="2060">a double a #GSettings object + filename="gio/gsettings.c" + line="2050">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="2051">the key to get the value for @@ -100422,8 +100845,8 @@ having a 'double' type in the schema for @settings. c:identifier="g_settings_get_enum" version="2.26"> Gets the value that is stored in @settings for @key and converts it + filename="gio/gsettings.c" + line="1311">Gets the value that is stored in @settings for @key and converts it to the enum value that it represents. In order to use this function the type of the value must be a string @@ -100435,25 +100858,24 @@ schema for @settings or is not marked as an enumerated type. If the value stored in the configuration database is not a valid value for the enumerated type then this function will return the default value. - + the enum value + filename="gio/gsettings.c" + line="1329">the enum value a #GSettings object + filename="gio/gsettings.c" + line="1313">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="1314">the key to get the value for @@ -100462,8 +100884,8 @@ default value. c:identifier="g_settings_get_flags" version="2.26"> Gets the value that is stored in @settings for @key and converts it + filename="gio/gsettings.c" + line="1421">Gets the value that is stored in @settings for @key and converts it to the flags value that it represents. In order to use this function the type of the value must be an array @@ -100475,25 +100897,24 @@ schema for @settings or is not marked as a flags type. If the value stored in the configuration database is not a valid value for the flags type then this function will return the default value. - + the flags value + filename="gio/gsettings.c" + line="1439">the flags value a #GSettings object + filename="gio/gsettings.c" + line="1423">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="1424">the key to get the value for @@ -100503,54 +100924,52 @@ value. glib:get-property="has-unapplied" version="2.26"> Returns whether the #GSettings object has any unapplied + filename="gio/gsettings.c" + line="2303">Returns whether the #GSettings object has any unapplied changes. This can only be the case if it is in 'delayed-apply' mode. - + %TRUE if @settings has unapplied changes + filename="gio/gsettings.c" + line="2310">%TRUE if @settings has unapplied changes a #GSettings object + filename="gio/gsettings.c" + line="2305">a #GSettings object Gets the value that is stored at @key in @settings. + filename="gio/gsettings.c" + line="1820">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 32-bit integers. It is a programmer error to give a @key that isn't specified as having a int32 type in the schema for @settings. - + an integer + filename="gio/gsettings.c" + line="1832">an integer a #GSettings object + filename="gio/gsettings.c" + line="1822">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="1823">the key to get the value for @@ -100559,40 +100978,39 @@ having a int32 type in the schema for @settings. c:identifier="g_settings_get_int64" version="2.50"> Gets the value that is stored at @key in @settings. + filename="gio/gsettings.c" + line="1876">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 64-bit integers. It is a programmer error to give a @key that isn't specified as having a int64 type in the schema for @settings. - + a 64-bit integer + filename="gio/gsettings.c" + line="1888">a 64-bit integer a #GSettings object + filename="gio/gsettings.c" + line="1878">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="1879">the key to get the value for Gets the value that is stored at @key in @settings, subject to + filename="gio/gsettings.c" + line="1673">Gets the value that is stored at @key in @settings, subject to application-level validation/mapping. You should use this function when the application needs to perform @@ -100619,25 +101037,24 @@ The result parameter for the @mapping function is pointed to a to each invocation of @mapping. The final value of that #gpointer is what is returned by this function. %NULL is valid; it is returned just as any other value would be. - + the result, which may be %NULL + filename="gio/gsettings.c" + line="1709">the result, which may be %NULL a #GSettings object + filename="gio/gsettings.c" + line="1675">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="1676">the key to get the value for scope="call" closure="2"> the function to map the value in the + filename="gio/gsettings.c" + line="1677">the function to map the value in the settings database to the value used by the application @@ -100655,8 +101072,8 @@ just as any other value would be. nullable="1" allow-none="1"> user data for @mapping + filename="gio/gsettings.c" + line="1679">user data for @mapping @@ -100667,25 +101084,24 @@ just as any other value would be. deprecated="1" deprecated-version="2.40"> Queries the range of a key. + filename="gio/gsettings.c" + line="2490">Queries the range of a key. Use g_settings_schema_key_get_range() instead. - + a #GSettings + filename="gio/gsettings.c" + line="2492">a #GSettings the key to query the range of + filename="gio/gsettings.c" + line="2493">the key to query the range of @@ -100694,32 +101110,31 @@ just as any other value would be. c:identifier="g_settings_get_string" version="2.26"> Gets the value that is stored at @key in @settings. + filename="gio/gsettings.c" + line="1764">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for strings. It is a programmer error to give a @key that isn't specified as having a string type in the schema for @settings. - + a newly-allocated string + filename="gio/gsettings.c" + line="1776">a newly-allocated string a #GSettings object + filename="gio/gsettings.c" + line="1766">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="1767">the key to get the value for @@ -100728,17 +101143,16 @@ having a string type in the schema for @settings. c:identifier="g_settings_get_strv" version="2.26"> A convenience variant of g_settings_get() for string arrays. + filename="gio/gsettings.c" + line="2160">A convenience variant of g_settings_get() for string arrays. It is a programmer error to give a @key that isn't specified as having an array of strings type in the schema for @settings. - + a + filename="gio/gsettings.c" + line="2170">a newly-allocated, %NULL-terminated array of strings, the value that is stored at @key in @settings. @@ -100748,14 +101162,14 @@ is stored at @key in @settings. a #GSettings object + filename="gio/gsettings.c" + line="2162">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="2163">the key to get the value for @@ -100764,33 +101178,32 @@ is stored at @key in @settings. c:identifier="g_settings_get_uint" version="2.30"> Gets the value that is stored at @key in @settings. + filename="gio/gsettings.c" + line="1932">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 32-bit unsigned integers. It is a programmer error to give a @key that isn't specified as having a uint32 type in the schema for @settings. - + an unsigned integer + filename="gio/gsettings.c" + line="1945">an unsigned integer a #GSettings object + filename="gio/gsettings.c" + line="1934">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="1935">the key to get the value for @@ -100799,33 +101212,32 @@ having a uint32 type in the schema for @settings. c:identifier="g_settings_get_uint64" version="2.50"> Gets the value that is stored at @key in @settings. + filename="gio/gsettings.c" + line="1990">Gets the value that is stored at @key in @settings. A convenience variant of g_settings_get() for 64-bit unsigned integers. It is a programmer error to give a @key that isn't specified as having a uint64 type in the schema for @settings. - + a 64-bit unsigned integer + filename="gio/gsettings.c" + line="2003">a 64-bit unsigned integer a #GSettings object + filename="gio/gsettings.c" + line="1992">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="1993">the key to get the value for @@ -100834,8 +101246,8 @@ having a uint64 type in the schema for @settings. c:identifier="g_settings_get_user_value" version="2.40"> Checks the "user value" of a key, if there is one. + filename="gio/gsettings.c" + line="1214">Checks the "user value" of a key, if there is one. The user value of a key is the last value that was set by the user. @@ -100853,25 +101265,24 @@ for providing indication that a particular value has been changed. It is a programmer error to give a @key that isn't contained in the schema for @settings. - + the user's value, if set + filename="gio/gsettings.c" + line="1238">the user's value, if set a #GSettings object + filename="gio/gsettings.c" + line="1216">a #GSettings object the key to get the user value for + filename="gio/gsettings.c" + line="1217">the key to get the user value for @@ -100880,30 +101291,29 @@ schema for @settings. c:identifier="g_settings_get_value" version="2.26"> Gets the value that is stored in @settings for @key. + filename="gio/gsettings.c" + line="1179">Gets the value that is stored in @settings for @key. It is a programmer error to give a @key that isn't contained in the schema for @settings. - + a new #GVariant + filename="gio/gsettings.c" + line="1189">a new #GVariant a #GSettings object + filename="gio/gsettings.c" + line="1181">a #GSettings object the key to get the value for + filename="gio/gsettings.c" + line="1182">the key to get the value for @@ -100912,35 +101322,34 @@ schema for @settings. c:identifier="g_settings_is_writable" version="2.26"> Finds out if a key can be written or not - + filename="gio/gsettings.c" + line="2370">Finds out if a key can be written or not + %TRUE if the key @name is writable + filename="gio/gsettings.c" + line="2377">%TRUE if the key @name is writable a #GSettings object + filename="gio/gsettings.c" + line="2372">a #GSettings object the name of a key + filename="gio/gsettings.c" + line="2373">the name of a key Gets the list of children on @settings. + filename="gio/gsettings.c" + line="2465">Gets the list of children on @settings. The list is exactly the list of strings for which it is not an error to call g_settings_get_child(). @@ -100951,12 +101360,11 @@ may still be useful there for introspection reasons, however. You should free the return value with g_strfreev() when you are done with it. - + a list of the children + filename="gio/gsettings.c" + line="2481">a list of the children on @settings, in no defined order @@ -100965,8 +101373,8 @@ with it. a #GSettings object + filename="gio/gsettings.c" + line="2467">a #GSettings object @@ -100976,8 +101384,8 @@ with it. deprecated="1" deprecated-version="2.46"> Introspects the list of keys on @settings. + filename="gio/gsettings.c" + line="2442">Introspects the list of keys on @settings. You should probably not be calling this function from "normal" code (since you should already know what keys are in your schema). This @@ -100986,12 +101394,11 @@ function is intended for introspection reasons. You should free the return value with g_strfreev() when you are done with it. Use g_settings_schema_list_keys() instead. - + a list + filename="gio/gsettings.c" + line="2455">a list of the keys on @settings, in no defined order @@ -101000,8 +101407,8 @@ with it. a #GSettings object + filename="gio/gsettings.c" + line="2444">a #GSettings object @@ -101012,86 +101419,83 @@ with it. deprecated="1" deprecated-version="2.40"> Checks if the given @value is of the correct type and within the + filename="gio/gsettings.c" + line="2515">Checks if the given @value is of the correct type and within the permitted range for @key. Use g_settings_schema_key_range_check() instead. - + %TRUE if @value is valid for @key + filename="gio/gsettings.c" + line="2524">%TRUE if @value is valid for @key a #GSettings + filename="gio/gsettings.c" + line="2517">a #GSettings the key to check + filename="gio/gsettings.c" + line="2518">the key to check the value to check + filename="gio/gsettings.c" + line="2519">the value to check Resets @key to its default value. + filename="gio/gsettings.c" + line="2325">Resets @key to its default value. This call resets the key, as much as possible, to its default value. That might be the value specified in the schema or the one set by the administrator. - + a #GSettings object + filename="gio/gsettings.c" + line="2327">a #GSettings object the name of a key + filename="gio/gsettings.c" + line="2328">the name of a key Reverts all non-applied changes to the settings. This function + filename="gio/gsettings.c" + line="2280">Reverts all non-applied changes to the settings. This function does nothing unless @settings is in 'delay-apply' mode; see g_settings_delay(). In the normal case settings are always applied immediately. Change notifications will be emitted for affected keys. - + a #GSettings instance + filename="gio/gsettings.c" + line="2282">a #GSettings instance @@ -101101,8 +101505,8 @@ Change notifications will be emitted for affected keys. version="2.26" introspectable="0"> Sets @key in @settings to @value. + filename="gio/gsettings.c" + line="1636">Sets @key in @settings to @value. A convenience function that combines g_settings_set_value() with g_variant_new(). @@ -101110,38 +101514,37 @@ g_variant_new(). It is a programmer error to give a @key that isn't contained in the schema for @settings or for the #GVariantType of @format to mismatch the type given in the schema. - + %TRUE if setting the key succeeded, + filename="gio/gsettings.c" + line="1652">%TRUE if setting the key succeeded, %FALSE if the key was not writable a #GSettings object + filename="gio/gsettings.c" + line="1638">a #GSettings object the name of the key to set + filename="gio/gsettings.c" + line="1639">the name of the key to set a #GVariant format string + filename="gio/gsettings.c" + line="1640">a #GVariant format string arguments as per @format + filename="gio/gsettings.c" + line="1641">arguments as per @format @@ -101150,39 +101553,38 @@ the type given in the schema. c:identifier="g_settings_set_boolean" version="2.26"> Sets @key in @settings to @value. + filename="gio/gsettings.c" + line="2134">Sets @key in @settings to @value. A convenience variant of g_settings_set() for booleans. It is a programmer error to give a @key that isn't specified as having a boolean type in the schema for @settings. - + %TRUE if setting the key succeeded, + filename="gio/gsettings.c" + line="2147">%TRUE if setting the key succeeded, %FALSE if the key was not writable a #GSettings object + filename="gio/gsettings.c" + line="2136">a #GSettings object the name of the key to set + filename="gio/gsettings.c" + line="2137">the name of the key to set the value to set it to + filename="gio/gsettings.c" + line="2138">the value to set it to @@ -101191,47 +101593,46 @@ having a boolean type in the schema for @settings. c:identifier="g_settings_set_double" version="2.26"> Sets @key in @settings to @value. + filename="gio/gsettings.c" + line="2078">Sets @key in @settings to @value. A convenience variant of g_settings_set() for doubles. It is a programmer error to give a @key that isn't specified as having a 'double' type in the schema for @settings. - + %TRUE if setting the key succeeded, + filename="gio/gsettings.c" + line="2091">%TRUE if setting the key succeeded, %FALSE if the key was not writable a #GSettings object + filename="gio/gsettings.c" + line="2080">a #GSettings object the name of the key to set + filename="gio/gsettings.c" + line="2081">the name of the key to set the value to set it to + filename="gio/gsettings.c" + line="2082">the value to set it to Looks up the enumerated type nick for @value and writes it to @key, + filename="gio/gsettings.c" + line="1366">Looks up the enumerated type nick for @value and writes it to @key, within @settings. It is a programmer error to give a @key that isn't contained in the @@ -101241,39 +101642,38 @@ schema for @settings or is not marked as an enumerated type, or for After performing the write, accessing @key directly with g_settings_get_string() will return the 'nick' associated with @value. - + %TRUE, if the set succeeds + filename="gio/gsettings.c" + line="1383">%TRUE, if the set succeeds a #GSettings object + filename="gio/gsettings.c" + line="1368">a #GSettings object a key, within @settings + filename="gio/gsettings.c" + line="1369">a key, within @settings an enumerated value + filename="gio/gsettings.c" + line="1370">an enumerated value Looks up the flags type nicks for the bits specified by @value, puts + filename="gio/gsettings.c" + line="1476">Looks up the flags type nicks for the bits specified by @value, puts them in an array of strings and writes the array to @key, within @settings. @@ -101284,70 +101684,68 @@ to contain any bits that are not value for the named type. After performing the write, accessing @key directly with g_settings_get_strv() will return an array of 'nicks'; one for each bit in @value. - + %TRUE, if the set succeeds + filename="gio/gsettings.c" + line="1494">%TRUE, if the set succeeds a #GSettings object + filename="gio/gsettings.c" + line="1478">a #GSettings object a key, within @settings + filename="gio/gsettings.c" + line="1479">a key, within @settings a flags value + filename="gio/gsettings.c" + line="1480">a flags value Sets @key in @settings to @value. + filename="gio/gsettings.c" + line="1850">Sets @key in @settings to @value. A convenience variant of g_settings_set() for 32-bit integers. It is a programmer error to give a @key that isn't specified as having a int32 type in the schema for @settings. - + %TRUE if setting the key succeeded, + filename="gio/gsettings.c" + line="1863">%TRUE if setting the key succeeded, %FALSE if the key was not writable a #GSettings object + filename="gio/gsettings.c" + line="1852">a #GSettings object the name of the key to set + filename="gio/gsettings.c" + line="1853">the name of the key to set the value to set it to + filename="gio/gsettings.c" + line="1854">the value to set it to @@ -101356,39 +101754,38 @@ having a int32 type in the schema for @settings. c:identifier="g_settings_set_int64" version="2.50"> Sets @key in @settings to @value. + filename="gio/gsettings.c" + line="1906">Sets @key in @settings to @value. A convenience variant of g_settings_set() for 64-bit integers. It is a programmer error to give a @key that isn't specified as having a int64 type in the schema for @settings. - + %TRUE if setting the key succeeded, + filename="gio/gsettings.c" + line="1919">%TRUE if setting the key succeeded, %FALSE if the key was not writable a #GSettings object + filename="gio/gsettings.c" + line="1908">a #GSettings object the name of the key to set + filename="gio/gsettings.c" + line="1909">the name of the key to set the value to set it to + filename="gio/gsettings.c" + line="1910">the value to set it to @@ -101397,39 +101794,38 @@ having a int64 type in the schema for @settings. c:identifier="g_settings_set_string" version="2.26"> Sets @key in @settings to @value. + filename="gio/gsettings.c" + line="1794">Sets @key in @settings to @value. A convenience variant of g_settings_set() for strings. It is a programmer error to give a @key that isn't specified as having a string type in the schema for @settings. - + %TRUE if setting the key succeeded, + filename="gio/gsettings.c" + line="1807">%TRUE if setting the key succeeded, %FALSE if the key was not writable a #GSettings object + filename="gio/gsettings.c" + line="1796">a #GSettings object the name of the key to set + filename="gio/gsettings.c" + line="1797">the name of the key to set the value to set it to + filename="gio/gsettings.c" + line="1798">the value to set it to @@ -101438,34 +101834,33 @@ having a string type in the schema for @settings. c:identifier="g_settings_set_strv" version="2.26"> Sets @key in @settings to @value. + filename="gio/gsettings.c" + line="2190">Sets @key in @settings to @value. A convenience variant of g_settings_set() for string arrays. If @value is %NULL, then @key is set to be the empty array. It is a programmer error to give a @key that isn't specified as having an array of strings type in the schema for @settings. - + %TRUE if setting the key succeeded, + filename="gio/gsettings.c" + line="2204">%TRUE if setting the key succeeded, %FALSE if the key was not writable a #GSettings object + filename="gio/gsettings.c" + line="2192">a #GSettings object the name of the key to set + filename="gio/gsettings.c" + line="2193">the name of the key to set nullable="1" allow-none="1"> the value to set it to, or %NULL + filename="gio/gsettings.c" + line="2194">the value to set it to, or %NULL @@ -101485,40 +101880,39 @@ having an array of strings type in the schema for @settings. c:identifier="g_settings_set_uint" version="2.30"> Sets @key in @settings to @value. + filename="gio/gsettings.c" + line="1963">Sets @key in @settings to @value. A convenience variant of g_settings_set() for 32-bit unsigned integers. It is a programmer error to give a @key that isn't specified as having a uint32 type in the schema for @settings. - + %TRUE if setting the key succeeded, + filename="gio/gsettings.c" + line="1977">%TRUE if setting the key succeeded, %FALSE if the key was not writable a #GSettings object + filename="gio/gsettings.c" + line="1965">a #GSettings object the name of the key to set + filename="gio/gsettings.c" + line="1966">the name of the key to set the value to set it to + filename="gio/gsettings.c" + line="1967">the value to set it to @@ -101527,40 +101921,39 @@ having a uint32 type in the schema for @settings. c:identifier="g_settings_set_uint64" version="2.50"> Sets @key in @settings to @value. + filename="gio/gsettings.c" + line="2021">Sets @key in @settings to @value. A convenience variant of g_settings_set() for 64-bit unsigned integers. It is a programmer error to give a @key that isn't specified as having a uint64 type in the schema for @settings. - + %TRUE if setting the key succeeded, + filename="gio/gsettings.c" + line="2035">%TRUE if setting the key succeeded, %FALSE if the key was not writable a #GSettings object + filename="gio/gsettings.c" + line="2023">a #GSettings object the name of the key to set + filename="gio/gsettings.c" + line="2024">the name of the key to set the value to set it to + filename="gio/gsettings.c" + line="2025">the value to set it to @@ -101569,40 +101962,39 @@ having a uint64 type in the schema for @settings. c:identifier="g_settings_set_value" version="2.26"> Sets @key in @settings to @value. + filename="gio/gsettings.c" + line="1532">Sets @key in @settings to @value. It is a programmer error to give a @key that isn't contained in the schema for @settings or for @value to have the incorrect type, per the schema. If @value is floating then this function consumes the reference. - + %TRUE if setting the key succeeded, + filename="gio/gsettings.c" + line="1546">%TRUE if setting the key succeeded, %FALSE if the key was not writable a #GSettings object + filename="gio/gsettings.c" + line="1534">a #GSettings object the name of the key to set + filename="gio/gsettings.c" + line="1535">the name of the key to set a #GVariant of the correct type + filename="gio/gsettings.c" + line="1536">a #GVariant of the correct type @@ -101612,8 +102004,8 @@ If @value is floating then this function consumes the reference. construct-only="1" transfer-ownership="none"> The name of the context that the settings are stored in. + filename="gio/gsettings.c" + line="838">The name of the context that the settings are stored in. transfer-ownership="none" default-value="FALSE"> Whether the #GSettings object is in 'delay-apply' mode. See + filename="gio/gsettings.c" + line="921">Whether the #GSettings object is in 'delay-apply' mode. See g_settings_delay() for details. @@ -101631,8 +102023,8 @@ g_settings_delay() for details. getter="get_has_unapplied" default-value="FALSE"> If this property is %TRUE, the #GSettings object has outstanding + filename="gio/gsettings.c" + line="910">If this property is %TRUE, the #GSettings object has outstanding changes that will be applied when g_settings_apply() is called. @@ -101642,8 +102034,8 @@ changes that will be applied when g_settings_apply() is called. transfer-ownership="none" default-value="NULL"> The path within the backend where the settings are stored. + filename="gio/gsettings.c" + line="899">The path within the backend where the settings are stored. transfer-ownership="none" default-value="NULL"> The name of the schema that describes the types of keys + filename="gio/gsettings.c" + line="865">The name of the schema that describes the types of keys for this #GSettings object. The type of this property is *not* #GSettingsSchema. @@ -101674,8 +102066,8 @@ version, this property may instead refer to a #GSettingsSchema. transfer-ownership="none" default-value="NULL"> The name of the schema that describes the types of keys + filename="gio/gsettings.c" + line="887">The name of the schema that describes the types of keys for this #GSettings object. @@ -101684,8 +102076,8 @@ for this #GSettings object. construct-only="1" transfer-ownership="none"> The #GSettingsSchema describing the types of keys for this + filename="gio/gsettings.c" + line="848">The #GSettingsSchema describing the types of keys for this #GSettings object. Ideally, this property would be called 'schema'. #GSettingsSchema @@ -101702,8 +102094,8 @@ than the schema itself. Take care. The "change-event" signal is emitted once per change event that + filename="gio/gsettings.c" + line="743">The "change-event" signal is emitted once per change event that affects this settings object. You should connect to this signal only if you are interested in viewing groups of changes before they are split out into multiple emissions of the "changed" signal. @@ -101720,8 +102112,8 @@ for each affected key. If any other connected handler returns %TRUE then this default functionality will be suppressed. %TRUE to stop other handlers from being invoked for the + filename="gio/gsettings.c" + line="766">%TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further. @@ -101731,8 +102123,8 @@ for each affected key. If any other connected handler returns nullable="1" allow-none="1"> + filename="gio/gsettings.c" + line="746"> an array of #GQuarks for the changed keys, or %NULL @@ -101740,16 +102132,16 @@ for each affected key. If any other connected handler returns the length of the @keys array, or 0 + filename="gio/gsettings.c" + line="748">the length of the @keys array, or 0 The "changed" signal is emitted when a key has potentially changed. + filename="gio/gsettings.c" + line="720">The "changed" signal is emitted when a key has potentially changed. You should call one of the g_settings_get() calls to check the new value. @@ -101765,16 +102157,16 @@ least once while a signal handler was already connected for @key. the name of the key that changed + filename="gio/gsettings.c" + line="723">the name of the key that changed The "writable-change-event" signal is emitted once per writability + filename="gio/gsettings.c" + line="800">The "writable-change-event" signal is emitted once per writability change event that affects this settings object. You should connect to this signal if you are interested in viewing groups of changes before they are split out into multiple emissions of the @@ -101794,24 +102186,24 @@ connected handler returns %TRUE then this default functionality will be suppressed. %TRUE to stop other handlers from being invoked for the + filename="gio/gsettings.c" + line="824">%TRUE to stop other handlers from being invoked for the event. FALSE to propagate the event further. the quark of the key, or 0 + filename="gio/gsettings.c" + line="803">the quark of the key, or 0 The "writable-changed" signal is emitted when the writability of a + filename="gio/gsettings.c" + line="780">The "writable-changed" signal is emitted when the writability of a key has potentially changed. You should call g_settings_is_writable() in order to determine the new status. @@ -101824,8 +102216,8 @@ callbacks when the writability of "x" changes. the key + filename="gio/gsettings.c" + line="783">the key @@ -101840,12 +102232,12 @@ callbacks when the writability of "x" changes. glib:get-type="g_settings_backend_get_type" glib:type-struct="SettingsBackendClass"> The #GSettingsBackend interface defines a generic interface for + filename="gio/gsettingsbackend.c" + line="54">The `GSettingsBackend` interface defines a generic interface for non-strictly-typed data that is stored in a hierarchy. To implement -an alternative storage backend for #GSettings, you need to implement -the #GSettingsBackend interface and then make it implement the -extension point %G_SETTINGS_BACKEND_EXTENSION_POINT_NAME. +an alternative storage backend for [class@Gio.Settings], you need to +implement the `GSettingsBackend` interface and then make it implement the +extension point `G_SETTINGS_BACKEND_EXTENSION_POINT_NAME`. The interface defines methods for reading and writing values, a method for determining if writing of certain values will fail @@ -101855,40 +102247,37 @@ The semantics of the interface are very precisely defined and implementations must carefully adhere to the expectations of callers that are documented on each of the interface methods. -Some of the #GSettingsBackend functions accept or return a #GTree. -These trees always have strings as keys and #GVariant as values. -g_settings_backend_create_tree() is a convenience function to create -suitable trees. +Some of the `GSettingsBackend` functions accept or return a +[struct@GLib.Tree]. These trees always have strings as keys and +[struct@GLib.Variant] as values. -The #GSettingsBackend API is exported to allow third-party +The `GSettingsBackend` API is exported to allow third-party implementations, but does not carry the same stability guarantees as the public GIO API. For this reason, you have to define the -C preprocessor symbol %G_SETTINGS_ENABLE_BACKEND before including +C preprocessor symbol `G_SETTINGS_ENABLE_BACKEND` before including `gio/gsettingsbackend.h`. - + Calculate the longest common prefix of all keys in a tree and write + filename="gio/gsettingsbackend.c" + line="595">Calculate the longest common prefix of all keys in a tree and write out an array of the key names relative to that prefix and, optionally, the value to store at each of those keys. You must free the value returned in @path, @keys and @values using g_free(). You should not attempt to free or unref the contents of @keys or @values. - + a #GTree containing the changes + filename="gio/gsettingsbackend.c" + line="597">a #GTree containing the changes the location to save the path + filename="gio/gsettingsbackend.c" + line="598">the location to save the path the + filename="gio/gsettingsbackend.c" + line="599">the location to save the relative keys @@ -101919,8 +102308,8 @@ g_free(). You should not attempt to free or unref the contents of optional="1" allow-none="1"> + filename="gio/gsettingsbackend.c" + line="601"> the location to save the values, or %NULL @@ -101932,26 +102321,27 @@ g_free(). You should not attempt to free or unref the contents of c:identifier="g_settings_backend_get_default" version="2.28"> Returns the default #GSettingsBackend. It is possible to override + filename="gio/gsettingsbackend.c" + line="998">Returns the default #GSettingsBackend. It is possible to override the default by setting the `GSETTINGS_BACKEND` environment variable to the name of a settings backend. The user gets a reference to the backend. - + the default #GSettingsBackend, + filename="gio/gsettingsbackend.c" + line="1007">the default #GSettingsBackend, which will be a dummy (memory) settings backend if no other settings backend is available. - + virtual method to get permission of a key + @@ -101965,8 +102355,10 @@ The user gets a reference to the backend. - + virtual method to get if a key is writable + @@ -101980,8 +102372,10 @@ The user gets a reference to the backend. - + virtual method to read a key's value + @@ -102001,8 +102395,10 @@ The user gets a reference to the backend. - + virtual method to read user's key value + @@ -102019,8 +102415,10 @@ The user gets a reference to the backend. - + virtual method to reset state + @@ -102040,8 +102438,10 @@ The user gets a reference to the backend. - + virtual method to subscribe to key changes + @@ -102055,8 +102455,10 @@ The user gets a reference to the backend. - + virtual method to sync state + @@ -102067,8 +102469,10 @@ The user gets a reference to the backend. - + virtual method to unsubscribe to key changes + @@ -102082,8 +102486,10 @@ The user gets a reference to the backend. - + virtual method to change key's value + @@ -102106,8 +102512,10 @@ The user gets a reference to the backend. - + virtual method to change a tree of keys + @@ -102130,8 +102538,8 @@ The user gets a reference to the backend. c:identifier="g_settings_backend_changed" version="2.26"> Signals that a single key has possibly changed. Backend + filename="gio/gsettingsbackend.c" + line="344">Signals that a single key has possibly changed. Backend implementations should call this if a key has possibly changed its value. @@ -102153,22 +102561,21 @@ g_settings_backend_write()). In the case that this call is in response to a call to g_settings_backend_write() then @origin_tag must be set to the same value that was passed to that call. - + a #GSettingsBackend implementation + filename="gio/gsettingsbackend.c" + line="346">a #GSettingsBackend implementation the name of the key + filename="gio/gsettingsbackend.c" + line="347">the name of the key nullable="1" allow-none="1"> the origin tag + filename="gio/gsettingsbackend.c" + line="348">the origin tag @@ -102186,26 +102593,25 @@ value that was passed to that call. c:identifier="g_settings_backend_changed_tree" version="2.26"> This call is a convenience wrapper. It gets the list of changes from + filename="gio/gsettingsbackend.c" + line="642">This call is a convenience wrapper. It gets the list of changes from @tree, computes the longest common prefix and calls g_settings_backend_changed(). - + a #GSettingsBackend implementation + filename="gio/gsettingsbackend.c" + line="644">a #GSettingsBackend implementation a #GTree containing the changes + filename="gio/gsettingsbackend.c" + line="645">a #GTree containing the changes nullable="1" allow-none="1"> the origin tag + filename="gio/gsettingsbackend.c" + line="646">the origin tag @@ -102223,8 +102629,8 @@ g_settings_backend_changed(). c:identifier="g_settings_backend_keys_changed" version="2.26"> Signals that a list of keys have possibly changed. Backend + filename="gio/gsettingsbackend.c" + line="389">Signals that a list of keys have possibly changed. Backend implementations should call this if keys have possibly changed their values. @@ -102245,28 +102651,27 @@ case g_settings_backend_changed() is definitely preferred). For efficiency reasons, the implementation should strive for @path to be as long as possible (ie: the longest common prefix of all of the keys that were changed) but this is not strictly required. - + a #GSettingsBackend implementation + filename="gio/gsettingsbackend.c" + line="391">a #GSettingsBackend implementation the path containing the changes + filename="gio/gsettingsbackend.c" + line="392">the path containing the changes the %NULL-terminated list of changed keys + filename="gio/gsettingsbackend.c" + line="393">the %NULL-terminated list of changed keys @@ -102276,8 +102681,8 @@ keys that were changed) but this is not strictly required. nullable="1" allow-none="1"> the origin tag + filename="gio/gsettingsbackend.c" + line="394">the origin tag @@ -102286,8 +102691,8 @@ keys that were changed) but this is not strictly required. c:identifier="g_settings_backend_path_changed" version="2.26"> Signals that all keys below a given path may have possibly changed. + filename="gio/gsettingsbackend.c" + line="438">Signals that all keys below a given path may have possibly changed. Backend implementations should call this if an entire path of keys have possibly changed their values. @@ -102308,22 +102713,21 @@ be as long as possible (ie: the longest common prefix of all of the keys that were changed) but this is not strictly required. As an example, if this function is called with the path of "/" then every single key in the application will be notified of a possible change. - + a #GSettingsBackend implementation + filename="gio/gsettingsbackend.c" + line="440">a #GSettingsBackend implementation the path containing the changes + filename="gio/gsettingsbackend.c" + line="441">the path containing the changes nullable="1" allow-none="1"> the origin tag + filename="gio/gsettingsbackend.c" + line="442">the origin tag @@ -102341,28 +102745,27 @@ single key in the application will be notified of a possible change. c:identifier="g_settings_backend_path_writable_changed" version="2.26"> Signals that the writability of all keys below a given path may have + filename="gio/gsettingsbackend.c" + line="507">Signals that the writability of all keys below a given path may have changed. Since GSettings performs no locking operations for itself, this call will always be made in response to external events. - + a #GSettingsBackend implementation + filename="gio/gsettingsbackend.c" + line="509">a #GSettingsBackend implementation the name of the path + filename="gio/gsettingsbackend.c" + line="510">the name of the path @@ -102371,27 +102774,26 @@ will always be made in response to external events. c:identifier="g_settings_backend_writable_changed" version="2.26"> Signals that the writability of a single key has possibly changed. + filename="gio/gsettingsbackend.c" + line="482">Signals that the writability of a single key has possibly changed. Since GSettings performs no locking operations for itself, this call will always be made in response to external events. - + a #GSettingsBackend implementation + filename="gio/gsettingsbackend.c" + line="484">a #GSettingsBackend implementation the name of the key + filename="gio/gsettingsbackend.c" + line="485">the name of the key @@ -102407,17 +102809,18 @@ will always be made in response to external events. c:type="GSettingsBackendClass" glib:is-gtype-struct-for="SettingsBackend"> Class structure for #GSettingsBackend. - + filename="gio/gsettingsbackend.h" + line="59">Class structure for #GSettingsBackend. + + virtual method to read a key's value - + @@ -102438,9 +102841,11 @@ will always be made in response to external events. + virtual method to get if a key is writable - + @@ -102455,9 +102860,11 @@ will always be made in response to external events. + virtual method to change key's value - + @@ -102481,9 +102888,11 @@ will always be made in response to external events. + virtual method to change a tree of keys - + @@ -102504,9 +102913,11 @@ will always be made in response to external events. + virtual method to reset state - + @@ -102527,9 +102938,11 @@ will always be made in response to external events. + virtual method to subscribe to key changes - + @@ -102544,9 +102957,11 @@ will always be made in response to external events. + virtual method to unsubscribe to key changes - + @@ -102561,9 +102976,11 @@ will always be made in response to external events. + virtual method to sync state - + @@ -102575,9 +102992,11 @@ will always be made in response to external events. + virtual method to get permission of a key - + @@ -102592,9 +103011,11 @@ will always be made in response to external events. + virtual method to read user's key value - + @@ -102621,15 +103042,14 @@ will always be made in response to external events. c:type="GSettingsBackendPrivate" disguised="1" opaque="1"> - + Flags used when creating a binding. These flags determine in which direction the binding works. The default is to synchronize in both directions. @@ -102639,7 +103059,7 @@ directions. glib:nick="default" glib:name="G_SETTINGS_BIND_DEFAULT"> Equivalent to `G_SETTINGS_BIND_GET|G_SETTINGS_BIND_SET` glib:nick="get" glib:name="G_SETTINGS_BIND_GET"> Update the #GObject property when the setting changes. It is an error to use this flag if the property is not writable. @@ -102658,7 +103078,7 @@ directions. glib:nick="set" glib:name="G_SETTINGS_BIND_SET"> Update the setting when the #GObject property changes. It is an error to use this flag if the property is not readable. @@ -102668,7 +103088,7 @@ directions. glib:nick="no-sensitivity" glib:name="G_SETTINGS_BIND_NO_SENSITIVITY"> Do not try to bind a "sensitivity" property to the writability of the setting glib:nick="get-no-changes" glib:name="G_SETTINGS_BIND_GET_NO_CHANGES"> When set in addition to %G_SETTINGS_BIND_GET, set the #GObject property value initially from the setting, but do not listen for changes of the setting @@ -102687,7 +103107,7 @@ directions. glib:nick="invert-boolean" glib:name="G_SETTINGS_BIND_INVERT_BOOLEAN"> When passed to g_settings_bind(), uses a pair of mapping functions that invert the boolean value when mapping between the setting and the property. The setting and property must both be booleans. You cannot pass this flag to g_settings_bind_with_mapping(). @@ -102695,28 +103115,27 @@ directions. The type for the function that is used to convert from #GSettings to an object property. The @value is already initialized to hold values of the appropriate type. - + %TRUE if the conversion succeeded, %FALSE in case of an error return location for the property value the #GVariant @@ -102726,7 +103145,7 @@ of the appropriate type. allow-none="1" closure="2"> user data that was specified when the binding was created @@ -102734,14 +103153,13 @@ of the appropriate type. The type for the function that is used to convert an object property value to a #GVariant for storing it in #GSettings. - + a new #GVariant holding the data from @value, or %NULL in case of an error @@ -102749,13 +103167,13 @@ value to a #GVariant for storing it in #GSettings. a #GValue containing the property value to map the #GVariantType to create @@ -102765,7 +103183,7 @@ value to a #GVariant for storing it in #GSettings. allow-none="1" closure="2"> user data that was specified when the binding was created @@ -102774,15 +103192,13 @@ value to a #GVariant for storing it in #GSettings. - + - + @@ -102798,8 +103214,7 @@ value to a #GVariant for storing it in #GSettings. - + @@ -102815,8 +103230,7 @@ value to a #GVariant for storing it in #GSettings. - + @@ -102832,8 +103246,7 @@ value to a #GVariant for storing it in #GSettings. - + @@ -102858,7 +103271,7 @@ value to a #GVariant for storing it in #GSettings. The type of the function that is used to convert from a value stored in a #GSettings to a value that is useful to the application. @@ -102869,18 +103282,17 @@ is not in the right format) then %FALSE should be returned. If @value is %NULL then it means that the mapping function is being given a "last chance" to successfully return a valid value. %TRUE must be returned in this case. - + %TRUE if the conversion succeeded, %FALSE in case of an error the #GVariant to map, or %NULL @@ -102890,7 +103302,7 @@ must be returned in this case. transfer-ownership="full" nullable="1"> the result of the mapping @@ -102900,7 +103312,7 @@ must be returned in this case. allow-none="1" closure="2"> the user data that was passed to g_settings_get_mapped() @@ -102911,8 +103323,7 @@ g_settings_get_mapped() c:type="GSettingsPrivate" disguised="1" opaque="1"> - + glib:get-type="g_settings_schema_get_type" c:symbol-prefix="settings_schema"> The #GSettingsSchemaSource and #GSettingsSchema APIs provide a + filename="gio/gsettingsschema.c" + line="40">The [struct@Gio.SettingsSchemaSource] and `GSettingsSchema` APIs provide a mechanism for advanced control over the loading of schemas and a mechanism for introspecting their content. @@ -102933,20 +103344,20 @@ settings visible to GSettings. Typically, a plugin will want to ship the schema along with itself and it won't be installed into the standard system directories for schemas. -#GSettingsSchemaSource provides a mechanism for dealing with this by -allowing the creation of a new 'schema source' from which schemas can +[struct@Gio.SettingsSchemaSource] provides a mechanism for dealing with this +by allowing the creation of a new ‘schema source’ from which schemas can be acquired. This schema source can then become part of the metadata associated with the plugin and queried whenever the plugin requires access to some settings. Consider the following example: -|[<!-- language="C" --> +```c typedef struct { - ... + … GSettingsSchemaSource *schema_source; - ... + … } Plugin; Plugin * @@ -102954,18 +103365,18 @@ initialise_plugin (const gchar *dir) { Plugin *plugin; - ... + … plugin->schema_source = g_settings_schema_source_new_from_directory (dir, g_settings_schema_source_get_default (), FALSE, NULL); - ... + … return plugin; } -... +… GSettings * plugin_get_settings (Plugin *plugin, @@ -102981,12 +103392,12 @@ plugin_get_settings (Plugin *plugin, if (schema == NULL) { - ... disable the plugin or abort, etc ... + … disable the plugin or abort, etc … } return g_settings_new_full (schema, NULL, NULL); } -]| +``` The code above shows how hooks should be added to the code that initialises (or enables) the plugin to create the schema source and @@ -102998,40 +103409,38 @@ From the standpoint of the plugin, it would need to ensure that it ships a gschemas.compiled file as part of itself, and then simply do the following: -|[<!-- language="C" --> +```c { GSettings *settings; gint some_value; settings = plugin_get_settings (self, NULL); some_value = g_settings_get_int (settings, "some-value"); - ... + … } -]| +``` It's also possible that the plugin system expects the schema source -files (ie: .gschema.xml files) instead of a gschemas.compiled file. +files (ie: `.gschema.xml` files) instead of a `gschemas.compiled` file. In that case, the plugin loading system must compile the schemas for itself before attempting to create the settings source. - + Get the ID of @schema. - + filename="gio/gsettingsschema.c" + line="1248">Get the ID of @schema. + the ID + filename="gio/gsettingsschema.c" + line="1254">the ID a #GSettingsSchema + filename="gio/gsettingsschema.c" + line="1250">a #GSettingsSchema @@ -103040,30 +103449,29 @@ itself before attempting to create the settings source. c:identifier="g_settings_schema_get_key" version="2.40"> Gets the key named @name from @schema. + filename="gio/gsettingsschema.c" + line="1641">Gets the key named @name from @schema. It is a programmer error to request a key that does not exist. See g_settings_schema_list_keys(). - + the #GSettingsSchemaKey for @name + filename="gio/gsettingsschema.c" + line="1651">the #GSettingsSchemaKey for @name a #GSettingsSchema + filename="gio/gsettingsschema.c" + line="1643">a #GSettingsSchema the name of a key + filename="gio/gsettingsschema.c" + line="1644">the name of a key @@ -103072,8 +103480,8 @@ g_settings_schema_list_keys(). c:identifier="g_settings_schema_get_path" version="2.32"> Gets the path associated with @schema, or %NULL. + filename="gio/gsettingsschema.c" + line="1013">Gets the path associated with @schema, or %NULL. Schemas may be single-instance or relocatable. Single-instance schemas correspond to exactly one set of keys in the backend @@ -103082,19 +103490,18 @@ database: those located at the path returned by this function. Relocatable schemas can be referenced by other schemas and can therefore describe multiple sets of keys at different locations. For relocatable schemas, this function will return %NULL. - + the path of the schema, or %NULL + filename="gio/gsettingsschema.c" + line="1027">the path of the schema, or %NULL a #GSettingsSchema + filename="gio/gsettingsschema.c" + line="1015">a #GSettingsSchema @@ -103103,27 +103510,26 @@ relocatable schemas, this function will return %NULL. c:identifier="g_settings_schema_has_key" version="2.40"> Checks if @schema has a key named @name. - + filename="gio/gsettingsschema.c" + line="1043">Checks if @schema has a key named @name. + %TRUE if such a key exists + filename="gio/gsettingsschema.c" + line="1050">%TRUE if such a key exists a #GSettingsSchema + filename="gio/gsettingsschema.c" + line="1045">a #GSettingsSchema the name of a key + filename="gio/gsettingsschema.c" + line="1046">the name of a key @@ -103132,17 +103538,16 @@ relocatable schemas, this function will return %NULL. c:identifier="g_settings_schema_list_children" version="2.44"> Gets the list of children in @schema. + filename="gio/gsettingsschema.c" + line="1061">Gets the list of children in @schema. You should free the return value with g_strfreev() when you are done with it. - + a list of + filename="gio/gsettingsschema.c" + line="1070">a list of the children on @settings, in no defined order @@ -103151,8 +103556,8 @@ with it. a #GSettingsSchema + filename="gio/gsettingsschema.c" + line="1063">a #GSettingsSchema @@ -103161,18 +103566,17 @@ with it. c:identifier="g_settings_schema_list_keys" version="2.46"> Introspects the list of keys on @schema. + filename="gio/gsettingsschema.c" + line="1105">Introspects the list of keys on @schema. You should probably not be calling this function from "normal" code (since you should already know what keys are in your schema). This function is intended for introspection reasons. - + a list + filename="gio/gsettingsschema.c" + line="1115">a list of the keys on @schema, in no defined order @@ -103181,29 +103585,28 @@ function is intended for introspection reasons. a #GSettingsSchema + filename="gio/gsettingsschema.c" + line="1107">a #GSettingsSchema Increase the reference count of @schema, returning a new reference. - + filename="gio/gsettingsschema.c" + line="913">Increase the reference count of @schema, returning a new reference. + a new reference to @schema + filename="gio/gsettingsschema.c" + line="919">a new reference to @schema a #GSettingsSchema + filename="gio/gsettingsschema.c" + line="915">a #GSettingsSchema @@ -103212,18 +103615,17 @@ function is intended for introspection reasons. c:identifier="g_settings_schema_unref" version="2.32"> Decrease the reference count of @schema, possibly freeing it. - + filename="gio/gsettingsschema.c" + line="931">Decrease the reference count of @schema, possibly freeing it. + a #GSettingsSchema + filename="gio/gsettingsschema.c" + line="933">a #GSettingsSchema @@ -103236,33 +103638,31 @@ function is intended for introspection reasons. glib:get-type="g_settings_schema_key_get_type" c:symbol-prefix="settings_schema_key"> #GSettingsSchemaKey is an opaque data structure and can only be accessed + filename="gio/gsettingsschema.c" + line="137">#GSettingsSchemaKey is an opaque data structure and can only be accessed using the following functions. - + Gets the default value for @key. + filename="gio/gsettingsschema.c" + line="1776">Gets the default value for @key. Note that this is the default value according to the schema. System administrator defaults and lockdown are not visible via this API. - + the default value for the key + filename="gio/gsettingsschema.c" + line="1785">the default value for the key a #GSettingsSchemaKey + filename="gio/gsettingsschema.c" + line="1778">a #GSettingsSchemaKey @@ -103271,8 +103671,8 @@ administrator defaults and lockdown are not visible via this API. c:identifier="g_settings_schema_key_get_description" version="2.34"> Gets the description for @key. + filename="gio/gsettingsschema.c" + line="1723">Gets the description for @key. If no description has been provided in the schema for @key, returns %NULL. @@ -103286,19 +103686,18 @@ This function is slow. The summary and description information for the schemas is not stored in the compiled schema database so this function has to parse all of the source XML files in the schema directory. - + the description for @key, or %NULL + filename="gio/gsettingsschema.c" + line="1742">the description for @key, or %NULL a #GSettingsSchemaKey + filename="gio/gsettingsschema.c" + line="1725">a #GSettingsSchemaKey @@ -103307,21 +103706,20 @@ directory. c:identifier="g_settings_schema_key_get_name" version="2.44"> Gets the name of @key. - + filename="gio/gsettingsschema.c" + line="1671">Gets the name of @key. + the name of @key. + filename="gio/gsettingsschema.c" + line="1677">the name of @key. a #GSettingsSchemaKey + filename="gio/gsettingsschema.c" + line="1673">a #GSettingsSchemaKey @@ -103330,8 +103728,8 @@ directory. c:identifier="g_settings_schema_key_get_range" version="2.40"> Queries the range of a key. + filename="gio/gsettingsschema.c" + line="1807">Queries the range of a key. This function will return a #GVariant that fully describes the range of values that are valid for @key. @@ -103367,19 +103765,18 @@ forms may be added to the possibilities described above. You should free the returned value with g_variant_unref() when it is no longer needed. - + a #GVariant describing the range + filename="gio/gsettingsschema.c" + line="1848">a #GVariant describing the range a #GSettingsSchemaKey + filename="gio/gsettingsschema.c" + line="1809">a #GSettingsSchemaKey @@ -103388,8 +103785,8 @@ no longer needed. c:identifier="g_settings_schema_key_get_summary" version="2.34"> Gets the summary for @key. + filename="gio/gsettingsschema.c" + line="1689">Gets the summary for @key. If no summary has been provided in the schema for @key, returns %NULL. @@ -103402,19 +103799,18 @@ This function is slow. The summary and description information for the schemas is not stored in the compiled schema database so this function has to parse all of the source XML files in the schema directory. - + the summary for @key, or %NULL + filename="gio/gsettingsschema.c" + line="1707">the summary for @key, or %NULL a #GSettingsSchemaKey + filename="gio/gsettingsschema.c" + line="1691">a #GSettingsSchemaKey @@ -103423,21 +103819,20 @@ directory. c:identifier="g_settings_schema_key_get_value_type" version="2.40"> Gets the #GVariantType of @key. - + filename="gio/gsettingsschema.c" + line="1758">Gets the #GVariantType of @key. + the type of @key + filename="gio/gsettingsschema.c" + line="1764">the type of @key a #GSettingsSchemaKey + filename="gio/gsettingsschema.c" + line="1760">a #GSettingsSchemaKey @@ -103446,31 +103841,30 @@ directory. c:identifier="g_settings_schema_key_range_check" version="2.40"> Checks if the given @value is within the + filename="gio/gsettingsschema.c" + line="1877">Checks if the given @value is within the permitted range for @key. It is a programmer error if @value is not of the correct type — you must check for this first. - + %TRUE if @value is valid for @key + filename="gio/gsettingsschema.c" + line="1888">%TRUE if @value is valid for @key a #GSettingsSchemaKey + filename="gio/gsettingsschema.c" + line="1879">a #GSettingsSchemaKey the value to check + filename="gio/gsettingsschema.c" + line="1880">the value to check @@ -103479,21 +103873,20 @@ must check for this first. c:identifier="g_settings_schema_key_ref" version="2.40"> Increase the reference count of @key, returning a new reference. - + filename="gio/gsettingsschema.c" + line="1600">Increase the reference count of @key, returning a new reference. + a new reference to @key + filename="gio/gsettingsschema.c" + line="1606">a new reference to @key a #GSettingsSchemaKey + filename="gio/gsettingsschema.c" + line="1602">a #GSettingsSchemaKey @@ -103502,18 +103895,17 @@ must check for this first. c:identifier="g_settings_schema_key_unref" version="2.40"> Decrease the reference count of @key, possibly freeing it. - + filename="gio/gsettingsschema.c" + line="1620">Decrease the reference count of @key, possibly freeing it. + a #GSettingsSchemaKey + filename="gio/gsettingsschema.c" + line="1622">a #GSettingsSchemaKey @@ -103527,17 +103919,16 @@ must check for this first. glib:get-type="g_settings_schema_source_get_type" c:symbol-prefix="settings_schema_source"> This is an opaque structure type. You may not access it directly. - + filename="gio/gsettingsschema.c" + line="177">This is an opaque structure type. You may not access it directly. + Attempts to create a new schema source corresponding to the contents + filename="gio/gsettingsschema.c" + line="246">Attempts to create a new schema source corresponding to the contents of the given directory. This function is not required for normal uses of #GSettings but it @@ -103568,16 +103959,15 @@ from the @parent. For this second reason, except in very unusual situations, the @parent should probably be given as the default schema source, as returned by g_settings_schema_source_get_default(). - + the filename of a directory + filename="gio/gsettingsschema.c" + line="248">the filename of a directory nullable="1" allow-none="1"> a #GSettingsSchemaSource, or %NULL + filename="gio/gsettingsschema.c" + line="249">a #GSettingsSchemaSource, or %NULL %TRUE, if the directory is trusted + filename="gio/gsettingsschema.c" + line="250">%TRUE, if the directory is trusted @@ -103601,8 +103991,8 @@ returned by g_settings_schema_source_get_default(). c:identifier="g_settings_schema_source_list_schemas" version="2.40"> Lists the schemas in a given source. + filename="gio/gsettingsschema.c" + line="754">Lists the schemas in a given source. If @recursive is %TRUE then include parent sources. If %FALSE then only include the schemas from one source (ie: one directory). You @@ -103614,22 +104004,21 @@ use g_settings_new_with_path(). Do not call this function from normal programs. This is designed for use by database editors, commandline tools, etc. - + a #GSettingsSchemaSource + filename="gio/gsettingsschema.c" + line="756">a #GSettingsSchemaSource if we should recurse + filename="gio/gsettingsschema.c" + line="757">if we should recurse caller-allocates="0" transfer-ownership="full"> the + filename="gio/gsettingsschema.c" + line="758">the list of non-relocatable schemas, in no defined order @@ -103649,8 +104038,8 @@ use by database editors, commandline tools, etc. caller-allocates="0" transfer-ownership="full"> the list + filename="gio/gsettingsschema.c" + line="760">the list of relocatable schemas, in no defined order @@ -103662,8 +104051,8 @@ use by database editors, commandline tools, etc. c:identifier="g_settings_schema_source_lookup" version="2.32"> Looks up a schema with the identifier @schema_id in @source. + filename="gio/gsettingsschema.c" + line="405">Looks up a schema with the identifier @schema_id in @source. This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems or to those who @@ -103673,31 +104062,30 @@ If the schema isn't found directly in @source and @recursive is %TRUE then the parent sources will also be checked. If the schema isn't found, %NULL is returned. - + a new #GSettingsSchema + filename="gio/gsettingsschema.c" + line="422">a new #GSettingsSchema a #GSettingsSchemaSource + filename="gio/gsettingsschema.c" + line="407">a #GSettingsSchemaSource a schema ID + filename="gio/gsettingsschema.c" + line="408">a schema ID %TRUE if the lookup should be recursive + filename="gio/gsettingsschema.c" + line="409">%TRUE if the lookup should be recursive @@ -103706,21 +104094,20 @@ If the schema isn't found, %NULL is returned. c:identifier="g_settings_schema_source_ref" version="2.32"> Increase the reference count of @source, returning a new reference. - + filename="gio/gsettingsschema.c" + line="196">Increase the reference count of @source, returning a new reference. + a new reference to @source + filename="gio/gsettingsschema.c" + line="202">a new reference to @source a #GSettingsSchemaSource + filename="gio/gsettingsschema.c" + line="198">a #GSettingsSchemaSource @@ -103729,18 +104116,17 @@ If the schema isn't found, %NULL is returned. c:identifier="g_settings_schema_source_unref" version="2.32"> Decrease the reference count of @source, possibly freeing it. - + filename="gio/gsettingsschema.c" + line="214">Decrease the reference count of @source, possibly freeing it. + a #GSettingsSchemaSource + filename="gio/gsettingsschema.c" + line="216">a #GSettingsSchemaSource @@ -103749,8 +104135,8 @@ If the schema isn't found, %NULL is returned. c:identifier="g_settings_schema_source_get_default" version="2.32"> Gets the default system schema source. + filename="gio/gsettingsschema.c" + line="376">Gets the default system schema source. This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems or to those who @@ -103763,12 +104149,11 @@ from different directories, depending on which directories were given in `XDG_DATA_DIRS` and `GSETTINGS_SCHEMA_DIR`. For this reason, all lookups performed against the default source should probably be done recursively. - + the default schema source + filename="gio/gsettingsschema.c" + line="393">the default schema source @@ -103780,35 +104165,32 @@ recursively. glib:type-name="GSimpleAction" glib:get-type="g_simple_action_get_type"> A #GSimpleAction is the obvious simple implementation of the #GAction -interface. This is the easiest way to create an action for purposes of -adding it to a #GSimpleActionGroup. - -See also #GtkAction. + filename="gio/gsimpleaction.c" + line="29">A `GSimpleAction` is the obvious simple implementation of the +[iface@Gio.Action] interface. This is the easiest way to create an action for +purposes of adding it to a [class@Gio.SimpleActionGroup]. Creates a new action. + filename="gio/gsimpleaction.c" + line="575">Creates a new action. The created action is stateless. See g_simple_action_new_stateful() to create an action that has state. - + a new #GSimpleAction + filename="gio/gsimpleaction.c" + line="586">a new #GSimpleAction the name of the action + filename="gio/gsimpleaction.c" + line="577">the name of the action nullable="1" allow-none="1"> the type of parameter that will be passed to + filename="gio/gsimpleaction.c" + line="578">the type of parameter that will be passed to handlers for the #GSimpleAction::activate signal, or %NULL for no parameter @@ -103827,26 +104209,25 @@ an action that has state. c:identifier="g_simple_action_new_stateful" version="2.28"> Creates a new stateful action. + filename="gio/gsimpleaction.c" + line="602">Creates a new stateful action. All future state values must have the same #GVariantType as the initial @state. If the @state #GVariant is floating, it is consumed. - + a new #GSimpleAction + filename="gio/gsimpleaction.c" + line="616">a new #GSimpleAction the name of the action + filename="gio/gsimpleaction.c" + line="604">the name of the action nullable="1" allow-none="1"> the type of the parameter that will be passed to + filename="gio/gsimpleaction.c" + line="605">the type of the parameter that will be passed to handlers for the #GSimpleAction::activate signal, or %NULL for no parameter the initial state of the action + filename="gio/gsimpleaction.c" + line="607">the initial state of the action @@ -103872,30 +104253,29 @@ If the @state #GVariant is floating, it is consumed. glib:set-property="enabled" version="2.28"> Sets the action as enabled or not. + filename="gio/gsimpleaction.c" + line="517">Sets the action as enabled or not. An action must be enabled in order to be activated or in order to have its state changed from outside callers. This should only be called by the implementor of the action. Users of the action should not attempt to modify its enabled flag. - + a #GSimpleAction + filename="gio/gsimpleaction.c" + line="519">a #GSimpleAction whether the action is enabled + filename="gio/gsimpleaction.c" + line="520">whether the action is enabled @@ -103905,8 +104285,8 @@ of the action should not attempt to modify its enabled flag. glib:set-property="state" version="2.30"> Sets the state of the action. + filename="gio/gsimpleaction.c" + line="137">Sets the state of the action. This directly updates the 'state' property to the given value. @@ -103916,22 +104296,21 @@ property. Instead, they should call g_action_change_state() to request the change. If the @value GVariant is floating, it is consumed. - + a #GSimpleAction + filename="gio/gsimpleaction.c" + line="139">a #GSimpleAction the new #GVariant for the state + filename="gio/gsimpleaction.c" + line="140">the new #GVariant for the state @@ -103940,21 +104319,20 @@ If the @value GVariant is floating, it is consumed. c:identifier="g_simple_action_set_state_hint" version="2.44"> Sets the state hint for the action. + filename="gio/gsimpleaction.c" + line="547">Sets the state hint for the action. See g_action_get_state_hint() for more information about action state hints. - + a #GSimpleAction + filename="gio/gsimpleaction.c" + line="549">a #GSimpleAction nullable="1" allow-none="1"> a #GVariant representing the state hint + filename="gio/gsimpleaction.c" + line="550">a #GVariant representing the state hint @@ -103975,8 +104353,8 @@ action state hints. setter="set_enabled" default-value="TRUE"> If @action is currently enabled. + filename="gio/gsimpleaction.c" + line="472">If @action is currently enabled. If the action is disabled then calls to g_action_activate() and g_action_change_state() have no effect. @@ -103989,8 +104367,8 @@ g_action_change_state() have no effect. transfer-ownership="none" default-value="NULL"> The name of the action. This is mostly meaningful for identifying + filename="gio/gsimpleaction.c" + line="442">The name of the action. This is mostly meaningful for identifying the action once it has been added to a #GSimpleActionGroup. @@ -104000,8 +104378,8 @@ the action once it has been added to a #GSimpleActionGroup. construct-only="1" transfer-ownership="none"> The type of the parameter that must be given when activating the + filename="gio/gsimpleaction.c" + line="457">The type of the parameter that must be given when activating the action. @@ -104012,21 +104390,21 @@ action. transfer-ownership="none" setter="set_state"> The state of the action, or %NULL if the action is stateless. + filename="gio/gsimpleaction.c" + line="502">The state of the action, or %NULL if the action is stateless. The #GVariantType of the state that the action has, or %NULL if the + filename="gio/gsimpleaction.c" + line="488">The #GVariantType of the state that the action has, or %NULL if the action is stateless. Indicates that the action was just activated. + filename="gio/gsimpleaction.c" + line="361">Indicates that the action was just activated. @parameter will always be of the expected type, i.e. the parameter type specified when the action was created. If an incorrect type is given when @@ -104048,8 +104426,8 @@ of #GSimpleAction to connect only one handler or the other. nullable="1" allow-none="1"> the parameter to the activation, or %NULL if it has + filename="gio/gsimpleaction.c" + line="364">the parameter to the activation, or %NULL if it has no parameter @@ -104057,8 +104435,8 @@ of #GSimpleAction to connect only one handler or the other. Indicates that the action just received a request to change its + filename="gio/gsimpleaction.c" + line="392">Indicates that the action just received a request to change its state. @value will always be of the correct state type, i.e. the type of the @@ -104100,8 +104478,8 @@ It could set it to any value at all, or take some other action. nullable="1" allow-none="1"> the requested value for the state + filename="gio/gsimpleaction.c" + line="395">the requested value for the state @@ -104116,25 +104494,24 @@ It could set it to any value at all, or take some other action. glib:get-type="g_simple_action_group_get_type" glib:type-struct="SimpleActionGroupClass"> #GSimpleActionGroup is a hash table filled with #GAction objects, -implementing the #GActionGroup and #GActionMap interfaces. - + filename="gio/gsimpleactiongroup.c" + line="30">`GSimpleActionGroup` is a hash table filled with [iface@Gio.Action] objects, +implementing the [iface@Gio.ActionGroup] and [iface@Gio.ActionMap] +interfaces. + Creates a new, empty, #GSimpleActionGroup. - + filename="gio/gsimpleactiongroup.c" + line="293">Creates a new, empty, #GSimpleActionGroup. + a new #GSimpleActionGroup + filename="gio/gsimpleactiongroup.c" + line="298">a new #GSimpleActionGroup @@ -104144,26 +104521,25 @@ implementing the #GActionGroup and #GActionMap interfaces. deprecated="1" deprecated-version="2.38"> A convenience function for creating multiple #GSimpleAction instances + filename="gio/gsimpleactiongroup.c" + line="380">A convenience function for creating multiple #GSimpleAction instances and adding them to the action group. Use g_action_map_add_action_entries() - + a #GSimpleActionGroup + filename="gio/gsimpleactiongroup.c" + line="382">a #GSimpleActionGroup a pointer to the first item in + filename="gio/gsimpleactiongroup.c" + line="383">a pointer to the first item in an array of #GActionEntry structs @@ -104171,8 +104547,8 @@ and adding them to the action group. the length of @entries, or -1 + filename="gio/gsimpleactiongroup.c" + line="385">the length of @entries, or -1 nullable="1" allow-none="1"> the user data for signal connections + filename="gio/gsimpleactiongroup.c" + line="386">the user data for signal connections @@ -104192,30 +104568,29 @@ and adding them to the action group. deprecated="1" deprecated-version="2.38"> Adds an action to the action group. + filename="gio/gsimpleactiongroup.c" + line="332">Adds an action to the action group. If the action group already contains an action with the same name as @action then the old action is dropped from the group. The action group takes its own reference on @action. Use g_action_map_add_action() - + a #GSimpleActionGroup + filename="gio/gsimpleactiongroup.c" + line="334">a #GSimpleActionGroup a #GAction + filename="gio/gsimpleactiongroup.c" + line="335">a #GAction @@ -104226,30 +104601,29 @@ The action group takes its own reference on @action. deprecated="1" deprecated-version="2.38"> Looks up the action with the name @action_name in the group. + filename="gio/gsimpleactiongroup.c" + line="308">Looks up the action with the name @action_name in the group. If no such action exists, returns %NULL. Use g_action_map_lookup_action() - + a #GAction, or %NULL + filename="gio/gsimpleactiongroup.c" + line="317">a #GAction, or %NULL a #GSimpleActionGroup + filename="gio/gsimpleactiongroup.c" + line="310">a #GSimpleActionGroup the name of an action + filename="gio/gsimpleactiongroup.c" + line="311">the name of an action @@ -104260,27 +104634,26 @@ If no such action exists, returns %NULL. deprecated="1" deprecated-version="2.38"> Removes the named action from the action group. + filename="gio/gsimpleactiongroup.c" + line="357">Removes the named action from the action group. If no action of this name is in the group then nothing happens. Use g_action_map_remove_action() - + a #GSimpleActionGroup + filename="gio/gsimpleactiongroup.c" + line="359">a #GSimpleActionGroup the name of the action + filename="gio/gsimpleactiongroup.c" + line="360">the name of the action @@ -104296,8 +104669,7 @@ If no action of this name is in the group then nothing happens. - + @@ -104311,8 +104683,7 @@ If no action of this name is in the group then nothing happens. c:type="GSimpleActionGroupPrivate" disguised="1" opaque="1"> - + glib:get-type="g_simple_async_result_get_type" glib:type-struct="SimpleAsyncResultClass"> As of GLib 2.46, #GSimpleAsyncResult is deprecated in favor of -#GTask, which provides a simpler API. + filename="gio/gsimpleasyncresult.c" + line="35">As of GLib 2.46, `GSimpleAsyncResult` is deprecated in favor of +[class@Gio.Task], which provides a simpler API. -#GSimpleAsyncResult implements #GAsyncResult. +`GSimpleAsyncResult` implements [iface@Gio.AsyncResult]. -GSimpleAsyncResult handles #GAsyncReadyCallbacks, error +`GSimpleAsyncResult` handles [type@Gio.AsyncReadyCallback]s, error reporting, operation cancellation and the final state of an operation, completely transparent to the application. Results can be returned as a pointer e.g. for functions that return data that is collected asynchronously, a boolean value for checking the success or failure -of an operation, or a #gssize for operations which return the number +of an operation, or a `gssize` for operations which return the number of bytes modified by the operation; all of the simple return cases are covered. Most of the time, an application will not need to know of the details of this API; it is handled transparently, and any necessary operations -are handled by #GAsyncResult's interface. However, if implementing a -new GIO module, for writing language bindings, or for complex +are handled by [iface@Gio.AsyncResult]’s interface. However, if implementing +a new GIO module, for writing language bindings, or for complex applications that need better control of how asynchronous operations are completed, it is important to understand this functionality. -GSimpleAsyncResults are tagged with the calling function to ensure +`GSimpleAsyncResult`s are tagged with the calling function to ensure that asynchronous functions and their finishing functions are used together correctly. -To create a new #GSimpleAsyncResult, call g_simple_async_result_new(). -If the result needs to be created for a #GError, use -g_simple_async_result_new_from_error() or -g_simple_async_result_new_take_error(). If a #GError is not available -(e.g. the asynchronous operation's doesn't take a #GError argument), +To create a new `GSimpleAsyncResult`, call [ctor@Gio.SimpleAsyncResult.new]. +If the result needs to be created for a `GError`, use +[ctor@Gio.SimpleAsyncResult.new_from_error] or +[ctor@Gio.SimpleAsyncResult.new_take_error]. If a `GError` is not available +(e.g. the asynchronous operation doesn’t take a `GError` argument), but the result still needs to be created for an error condition, use -g_simple_async_result_new_error() (or g_simple_async_result_set_error_va() -if your application or binding requires passing a variable argument list -directly), and the error can then be propagated through the use of -g_simple_async_result_propagate_error(). +[ctor@Gio.SimpleAsyncResult.new_error] (or +[method@Gio.SimpleAsyncResult.set_error_va] if your application or binding +requires passing a variable argument list directly), and the error can then +be propagated through the use of +[method@Gio.SimpleAsyncResult.propagate_error]. An asynchronous operation can be made to ignore a cancellation event by -calling g_simple_async_result_set_handle_cancellation() with a -#GSimpleAsyncResult for the operation and %FALSE. This is useful for +calling [method@Gio.SimpleAsyncResult.set_handle_cancellation] with a +`GSimpleAsyncResult` for the operation and `FALSE`. This is useful for operations that are dangerous to cancel, such as close (which would cause a leak if cancelled before being run). -GSimpleAsyncResult can integrate into GLib's event loop, #GMainLoop, -or it can use #GThreads. -g_simple_async_result_complete() will finish an I/O task directly -from the point where it is called. g_simple_async_result_complete_in_idle() -will finish it from an idle handler in the -[thread-default main context][g-main-context-push-thread-default] -where the #GSimpleAsyncResult was created. -g_simple_async_result_run_in_thread() will run the job in a -separate thread and then use -g_simple_async_result_complete_in_idle() to deliver the result. +`GSimpleAsyncResult` can integrate into GLib’s event loop, +[type@GLib.MainLoop], or it can use [type@GLib.Thread]s. +[method@Gio.SimpleAsyncResult.complete] will finish an I/O task directly +from the point where it is called. +[method@Gio.SimpleAsyncResult.complete_in_idle] will finish it from an idle +handler in the thread-default main context (see +[method@GLib.MainContext.push_thread_default]) where the `GSimpleAsyncResult` +was created. [method@Gio.SimpleAsyncResult.run_in_thread] will run the job in +a separate thread and then use +[method@Gio.SimpleAsyncResult.complete_in_idle] to deliver the result. To set the results of an asynchronous function, -g_simple_async_result_set_op_res_gpointer(), -g_simple_async_result_set_op_res_gboolean(), and -g_simple_async_result_set_op_res_gssize() -are provided, setting the operation's result to a gpointer, gboolean, or -gssize, respectively. +[method@Gio.SimpleAsyncResult.set_op_res_gpointer], +[method@Gio.SimpleAsyncResult.set_op_res_gboolean], and +[method@Gio.SimpleAsyncResult.set_op_res_gssize] +are provided, setting the operation's result to a `gpointer`, `gboolean`, or +`gssize`, respectively. Likewise, to get the result of an asynchronous function, -g_simple_async_result_get_op_res_gpointer(), -g_simple_async_result_get_op_res_gboolean(), and -g_simple_async_result_get_op_res_gssize() are -provided, getting the operation's result as a gpointer, gboolean, and -gssize, respectively. +[method@Gio.SimpleAsyncResult.get_op_res_gpointer], +[method@Gio.SimpleAsyncResult.get_op_res_gboolean], and +[method@Gio.SimpleAsyncResult.get_op_res_gssize] are +provided, getting the operation’s result as a `gpointer`, `gboolean`, and +`gssize`, respectively. For the details of the requirements implementations must respect, see -#GAsyncResult. A typical implementation of an asynchronous operation -using GSimpleAsyncResult looks something like this: +[iface@Gio.AsyncResult]. A typical implementation of an asynchronous +operation using `GSimpleAsyncResult` looks something like this: -|[<!-- language="C" --> +```c static void baked_cb (Cake *cake, gpointer user_data) @@ -104487,17 +104859,16 @@ baker_bake_cake_finish (Baker *self, cake = CAKE (g_simple_async_result_get_op_res_gpointer (simple)); return g_object_ref (cake); } -]| - +``` + Creates a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="292">Creates a #GSimpleAsyncResult. The common convention is to create the #GSimpleAsyncResult in the function that starts the asynchronous operation and use that same @@ -104508,12 +104879,11 @@ probably should) then you should provide the user's cancellable to g_simple_async_result_set_check_cancellable() immediately after this function returns. Use g_task_new() instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="310">a #GSimpleAsyncResult. @@ -104522,8 +104892,8 @@ this function returns. nullable="1" allow-none="1"> a #GObject, or %NULL. + filename="gio/gsimpleasyncresult.c" + line="294">a #GObject, or %NULL. scope="async" closure="2"> a #GAsyncReadyCallback. + filename="gio/gsimpleasyncresult.c" + line="295">a #GAsyncReadyCallback. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gsimpleasyncresult.c" + line="296">user data passed to @callback. nullable="1" allow-none="1"> the asynchronous function. + filename="gio/gsimpleasyncresult.c" + line="297">the asynchronous function. @@ -104563,15 +104933,14 @@ this function returns. deprecated="1" deprecated-version="2.46"> Creates a new #GSimpleAsyncResult with a set error. + filename="gio/gsimpleasyncresult.c" + line="401">Creates a new #GSimpleAsyncResult with a set error. Use g_task_new() and g_task_return_new_error() instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="413">a #GSimpleAsyncResult. @@ -104580,8 +104949,8 @@ this function returns. nullable="1" allow-none="1"> a #GObject, or %NULL. + filename="gio/gsimpleasyncresult.c" + line="403">a #GObject, or %NULL. scope="async" closure="2"> a #GAsyncReadyCallback. + filename="gio/gsimpleasyncresult.c" + line="404">a #GAsyncReadyCallback. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gsimpleasyncresult.c" + line="405">user data passed to @callback. a #GQuark. + filename="gio/gsimpleasyncresult.c" + line="406">a #GQuark. an error code. + filename="gio/gsimpleasyncresult.c" + line="407">an error code. a string with format characters. + filename="gio/gsimpleasyncresult.c" + line="408">a string with format characters. a list of values to insert into @format. + filename="gio/gsimpleasyncresult.c" + line="409">a list of values to insert into @format. @@ -104635,15 +105004,14 @@ this function returns. deprecated="1" deprecated-version="2.46"> Creates a #GSimpleAsyncResult from an error condition. + filename="gio/gsimpleasyncresult.c" + line="336">Creates a #GSimpleAsyncResult from an error condition. Use g_task_new() and g_task_return_error() instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="345">a #GSimpleAsyncResult. @@ -104652,8 +105020,8 @@ this function returns. nullable="1" allow-none="1"> a #GObject, or %NULL. + filename="gio/gsimpleasyncresult.c" + line="338">a #GObject, or %NULL. scope="async" closure="2"> a #GAsyncReadyCallback. + filename="gio/gsimpleasyncresult.c" + line="339">a #GAsyncReadyCallback. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gsimpleasyncresult.c" + line="340">user data passed to @callback. a #GError + filename="gio/gsimpleasyncresult.c" + line="341">a #GError @@ -104691,16 +105059,15 @@ this function returns. deprecated="1" deprecated-version="2.46"> Creates a #GSimpleAsyncResult from an error condition, and takes over the + filename="gio/gsimpleasyncresult.c" + line="367">Creates a #GSimpleAsyncResult from an error condition, and takes over the caller's ownership of @error, so the caller does not need to free it anymore. Use g_task_new() and g_task_return_error() instead. - + a #GSimpleAsyncResult + filename="gio/gsimpleasyncresult.c" + line="377">a #GSimpleAsyncResult @@ -104709,8 +105076,8 @@ caller's ownership of @error, so the caller does not need to free it anymore. a #GObject, or %NULL + filename="gio/gsimpleasyncresult.c" + line="369">a #GObject, or %NULL a #GAsyncReadyCallback + filename="gio/gsimpleasyncresult.c" + line="370">a #GAsyncReadyCallback. user data passed to @callback + filename="gio/gsimpleasyncresult.c" + line="371">user data passed to @callback. a #GError + filename="gio/gsimpleasyncresult.c" + line="372">a #GError @@ -104747,8 +105114,8 @@ caller's ownership of @error, so the caller does not need to free it anymore. Ensures that the data passed to the _finish function of an async + filename="gio/gsimpleasyncresult.c" + line="952">Ensures that the data passed to the _finish function of an async operation is consistent. Three checks are performed. First, @result is checked to ensure that it is really a @@ -104761,19 +105128,18 @@ which this function is called). (Alternatively, if either @source_tag or @result's source tag is %NULL, then the source tag check is skipped.) Use #GTask and g_task_is_valid() instead. - + #TRUE if all checks passed or #FALSE if any failed. + filename="gio/gsimpleasyncresult.c" + line="971">#TRUE if all checks passed or #FALSE if any failed. the #GAsyncResult passed to the _finish function. + filename="gio/gsimpleasyncresult.c" + line="954">the #GAsyncResult passed to the _finish function. nullable="1" allow-none="1"> the #GObject passed to the _finish function. + filename="gio/gsimpleasyncresult.c" + line="955">the #GObject passed to the _finish function. nullable="1" allow-none="1"> the asynchronous function. + filename="gio/gsimpleasyncresult.c" + line="956">the asynchronous function. @@ -104801,8 +105167,8 @@ check is skipped.) deprecated="1" deprecated-version="2.46"> Completes an asynchronous I/O job immediately. Must be called in + filename="gio/gsimpleasyncresult.c" + line="765">Completes an asynchronous I/O job immediately. Must be called in the thread where the asynchronous result was to be delivered, as it invokes the callback directly. If you are in a different thread use g_simple_async_result_complete_in_idle(). @@ -104810,16 +105176,15 @@ g_simple_async_result_complete_in_idle(). Calling this function takes a reference to @simple for as long as is needed to complete the call. Use #GTask instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="767">a #GSimpleAsyncResult. @@ -104829,8 +105194,8 @@ is needed to complete the call. deprecated="1" deprecated-version="2.46"> Completes an asynchronous function in an idle handler in the + filename="gio/gsimpleasyncresult.c" + line="819">Completes an asynchronous function in an idle handler in the [thread-default main context][g-main-context-push-thread-default] of the thread that @simple was initially created in (and re-pushes that context around the invocation of the callback). @@ -104838,16 +105203,15 @@ of the thread that @simple was initially created in Calling this function takes a reference to @simple for as long as is needed to complete the call. Use #GTask instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="821">a #GSimpleAsyncResult. @@ -104857,23 +105221,22 @@ is needed to complete the call. deprecated="1" deprecated-version="2.46"> Gets the operation result boolean from within the asynchronous result. + filename="gio/gsimpleasyncresult.c" + line="640">Gets the operation result boolean from within the asynchronous result. Use #GTask and g_task_propagate_boolean() instead. - + %TRUE if the operation's result was %TRUE, %FALSE + filename="gio/gsimpleasyncresult.c" + line="646">%TRUE if the operation's result was %TRUE, %FALSE if the operation's result was %FALSE. a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="642">a #GSimpleAsyncResult. @@ -104884,22 +105247,21 @@ is needed to complete the call. deprecated="1" deprecated-version="2.46"> Gets a pointer result as returned by the asynchronous function. + filename="gio/gsimpleasyncresult.c" + line="569">Gets a pointer result as returned by the asynchronous function. Use #GTask and g_task_propagate_pointer() instead. - + a pointer from the result. + filename="gio/gsimpleasyncresult.c" + line="575">a pointer from the result. a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="571">a #GSimpleAsyncResult. @@ -104909,22 +105271,21 @@ is needed to complete the call. deprecated="1" deprecated-version="2.46"> Gets a gssize from the asynchronous result. + filename="gio/gsimpleasyncresult.c" + line="605">Gets a gssize from the asynchronous result. Use #GTask and g_task_propagate_int() instead. - + a gssize returned from the asynchronous function. + filename="gio/gsimpleasyncresult.c" + line="611">a gssize returned from the asynchronous function. a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="607">a #GSimpleAsyncResult. @@ -104935,22 +105296,21 @@ is needed to complete the call. deprecated="1" deprecated-version="2.46."> Gets the source tag for the #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="495">Gets the source tag for the #GSimpleAsyncResult. Use #GTask and g_task_get_source_tag() instead. - + a #gpointer to the source object for the #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="501">a #gpointer to the source object for the #GSimpleAsyncResult. a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="497">a #GSimpleAsyncResult. @@ -104961,27 +105321,26 @@ is needed to complete the call. deprecated-version="2.46" throws="1"> Propagates an error from within the simple asynchronous result to + filename="gio/gsimpleasyncresult.c" + line="512">Propagates an error from within the simple asynchronous result to a given destination. If the #GCancellable given to a prior call to g_simple_async_result_set_check_cancellable() is cancelled then this function will return %TRUE with @dest set appropriately. Use #GTask instead. - + %TRUE if the error was propagated to @dest. %FALSE otherwise. + filename="gio/gsimpleasyncresult.c" + line="524">%TRUE if the error was propagated to @dest. %FALSE otherwise. a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="514">a #GSimpleAsyncResult. @@ -104992,37 +105351,36 @@ function will return %TRUE with @dest set appropriately. deprecated="1" deprecated-version="2.46"> Runs the asynchronous job in a separate thread and then calls + filename="gio/gsimpleasyncresult.c" + line="914">Runs the asynchronous job in a separate thread and then calls g_simple_async_result_complete_in_idle() on @simple to return the result to the appropriate main loop. Calling this function takes a reference to @simple for as long as is needed to run the job and report its completion. Use #GTask and g_task_run_in_thread() instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="916">a #GSimpleAsyncResult. a #GSimpleAsyncThreadFunc. + filename="gio/gsimpleasyncresult.c" + line="917">a #GSimpleAsyncThreadFunc. the io priority of the request. + filename="gio/gsimpleasyncresult.c" + line="918">the io priority of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gsimpleasyncresult.c" + line="919">optional #GCancellable object, %NULL to ignore. @@ -105042,8 +105400,8 @@ is needed to run the job and report its completion. deprecated="1" deprecated-version="2.46"> Sets a #GCancellable to check before dispatching results. + filename="gio/gsimpleasyncresult.c" + line="1114">Sets a #GCancellable to check before dispatching results. This function has one very specific purpose: the provided cancellable is checked at the time of g_simple_async_result_propagate_error() If @@ -105059,16 +105417,15 @@ already been sent as an idle to the main context to be dispatched). The checking described above is done regardless of any call to the unrelated g_simple_async_result_set_handle_cancellation() function. Use #GTask instead. - + a #GSimpleAsyncResult + filename="gio/gsimpleasyncresult.c" + line="1116">a #GSimpleAsyncResult nullable="1" allow-none="1"> a #GCancellable to check, or %NULL to unset + filename="gio/gsimpleasyncresult.c" + line="1117">a #GCancellable to check, or %NULL to unset @@ -105088,43 +105445,42 @@ unrelated g_simple_async_result_set_handle_cancellation() function. deprecated="1" deprecated-version="2.46"> Sets an error within the asynchronous result without a #GError. + filename="gio/gsimpleasyncresult.c" + line="735">Sets an error within the asynchronous result without a #GError. Use #GTask and g_task_return_new_error() instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="737">a #GSimpleAsyncResult. a #GQuark (usually %G_IO_ERROR). + filename="gio/gsimpleasyncresult.c" + line="738">a #GQuark (usually %G_IO_ERROR). an error code. + filename="gio/gsimpleasyncresult.c" + line="739">an error code. a formatted error reporting string. + filename="gio/gsimpleasyncresult.c" + line="740">a formatted error reporting string. a list of variables to fill in @format. + filename="gio/gsimpleasyncresult.c" + line="741">a list of variables to fill in @format. @@ -105135,44 +105491,43 @@ unrelated g_simple_async_result_set_handle_cancellation() function. deprecated="1" deprecated-version="2.46"> Sets an error within the asynchronous result without a #GError. + filename="gio/gsimpleasyncresult.c" + line="705">Sets an error within the asynchronous result without a #GError. Unless writing a binding, see g_simple_async_result_set_error(). Use #GTask and g_task_return_error() instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="707">a #GSimpleAsyncResult. a #GQuark (usually %G_IO_ERROR). + filename="gio/gsimpleasyncresult.c" + line="708">a #GQuark (usually %G_IO_ERROR). an error code. + filename="gio/gsimpleasyncresult.c" + line="709">an error code. a formatted error reporting string. + filename="gio/gsimpleasyncresult.c" + line="710">a formatted error reporting string. va_list of arguments. + filename="gio/gsimpleasyncresult.c" + line="711">va_list of arguments. @@ -105182,25 +105537,24 @@ Unless writing a binding, see g_simple_async_result_set_error(). deprecated="1" deprecated-version="2.46"> Sets the result from a #GError. + filename="gio/gsimpleasyncresult.c" + line="658">Sets the result from a #GError. Use #GTask and g_task_return_error() instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="660">a #GSimpleAsyncResult. #GError. + filename="gio/gsimpleasyncresult.c" + line="661">#GError. @@ -105210,28 +105564,27 @@ Unless writing a binding, see g_simple_async_result_set_error(). deprecated="1" deprecated-version="2.46"> Sets whether to handle cancellation within the asynchronous operation. + filename="gio/gsimpleasyncresult.c" + line="474">Sets whether to handle cancellation within the asynchronous operation. This function has nothing to do with g_simple_async_result_set_check_cancellable(). It only refers to the #GCancellable passed to g_simple_async_result_run_in_thread(). - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="476">a #GSimpleAsyncResult. a #gboolean. + filename="gio/gsimpleasyncresult.c" + line="477">a #gboolean. @@ -105241,25 +105594,24 @@ g_simple_async_result_set_check_cancellable(). It only refers to the deprecated="1" deprecated-version="2.46"> Sets the operation result to a boolean within the asynchronous result. + filename="gio/gsimpleasyncresult.c" + line="622">Sets the operation result to a boolean within the asynchronous result. Use #GTask and g_task_return_boolean() instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="624">a #GSimpleAsyncResult. a #gboolean. + filename="gio/gsimpleasyncresult.c" + line="625">a #gboolean. @@ -105270,19 +105622,18 @@ g_simple_async_result_set_check_cancellable(). It only refers to the deprecated="1" deprecated-version="2.46"> Sets the operation result within the asynchronous result to a pointer. + filename="gio/gsimpleasyncresult.c" + line="547">Sets the operation result within the asynchronous result to a pointer. Use #GTask and g_task_return_pointer() instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="549">a #GSimpleAsyncResult. a pointer result from an asynchronous function. + filename="gio/gsimpleasyncresult.c" + line="550">a pointer result from an asynchronous function. a #GDestroyNotify function. + filename="gio/gsimpleasyncresult.c" + line="551">a #GDestroyNotify function. @@ -105309,26 +105660,25 @@ g_simple_async_result_set_check_cancellable(). It only refers to the deprecated="1" deprecated-version="2.46"> Sets the operation result within the asynchronous result to + filename="gio/gsimpleasyncresult.c" + line="586">Sets the operation result within the asynchronous result to the given @op_res. Use #GTask and g_task_return_int() instead. - + a #GSimpleAsyncResult. + filename="gio/gsimpleasyncresult.c" + line="588">a #GSimpleAsyncResult. a #gssize. + filename="gio/gsimpleasyncresult.c" + line="589">a #gssize. @@ -105340,26 +105690,25 @@ the given @op_res. deprecated="1" deprecated-version="2.46"> Sets the result from @error, and takes over the caller's ownership + filename="gio/gsimpleasyncresult.c" + line="680">Sets the result from @error, and takes over the caller's ownership of @error, so the caller does not need to free it any more. Use #GTask and g_task_return_error() instead. - + a #GSimpleAsyncResult + filename="gio/gsimpleasyncresult.c" + line="682">a #GSimpleAsyncResult a #GError + filename="gio/gsimpleasyncresult.c" + line="683">a #GError @@ -105370,30 +105719,28 @@ of @error, so the caller does not need to free it any more. disguised="1" opaque="1" glib:is-gtype-struct-for="SimpleAsyncResult"> - + Simple thread function that runs an asynchronous operation and + filename="gio/giotypes.h" + line="289">Simple thread function that runs an asynchronous operation and checks for cancellation. - + a #GSimpleAsyncResult. + filename="gio/giotypes.h" + line="291">a #GSimpleAsyncResult. a #GObject. + filename="gio/giotypes.h" + line="292">a #GObject. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/giotypes.h" + line="293">optional #GCancellable object, %NULL to ignore. @@ -105415,41 +105762,42 @@ checks for cancellation. glib:type-name="GSimpleIOStream" glib:get-type="g_simple_io_stream_get_type"> GSimpleIOStream creates a #GIOStream from an arbitrary #GInputStream and -#GOutputStream. This allows any pair of input and output streams to be used -with #GIOStream methods. - -This is useful when you obtained a #GInputStream and a #GOutputStream -by other means, for instance creating them with platform specific methods as -g_unix_input_stream_new() or g_win32_input_stream_new(), and you want -to take advantage of the methods provided by #GIOStream. + filename="gio/gsimpleiostream.c" + line="30">`GSimpleIOStream` creates a [class@Gio.IOStream] from an arbitrary +[class@Gio.InputStream] and [class@Gio.OutputStream]. This allows any pair of +input and output streams to be used with [class@Gio.IOStream] methods. + +This is useful when you obtained a [class@Gio.InputStream] and a +[class@Gio.OutputStream] by other means, for instance creating them with +platform specific methods as +[`g_unix_input_stream_new()`](../gio-unix/ctor.UnixInputStream.new.html) +(from `gio-unix-2.0.pc` / `GioUnix-2.0`), and you want to +take advantage of the methods provided by [class@Gio.IOStream]. Creates a new #GSimpleIOStream wrapping @input_stream and @output_stream. + filename="gio/gsimpleiostream.c" + line="195">Creates a new #GSimpleIOStream wrapping @input_stream and @output_stream. See also #GIOStream. - + a new #GSimpleIOStream instance. + filename="gio/gsimpleiostream.c" + line="203">a new #GSimpleIOStream instance. a #GInputStream. + filename="gio/gsimpleiostream.c" + line="197">a #GInputStream. a #GOutputStream. + filename="gio/gsimpleiostream.c" + line="198">a #GOutputStream. @@ -105459,6 +105807,9 @@ See also #GIOStream. writable="1" construct-only="1" transfer-ownership="none"> + The [class@Gio.InputStream] to read from. writable="1" construct-only="1" transfer-ownership="none"> + The [class@Gio.OutputStream] to write to. @@ -105476,32 +105830,32 @@ See also #GIOStream. glib:type-name="GSimplePermission" glib:get-type="g_simple_permission_get_type"> #GSimplePermission is a trivial implementation of #GPermission that -represents a permission that is either always or never allowed. The -value is given at construction and doesn't change. + filename="gio/gsimplepermission.c" + line="28">`GSimplePermission` is a trivial implementation of [class@Gio.Permission] +that represents a permission that is either always or never allowed. The +value is given at construction and doesn’t change. -Calling request or release will result in errors. +Calling [method@Gio.Permission.acquire] or [method@Gio.Permission.release] +on a `GSimplePermission` will result in errors. Creates a new #GPermission instance that represents an action that is + filename="gio/gsimplepermission.c" + line="58">Creates a new #GPermission instance that represents an action that is either always or never allowed. - + the #GSimplePermission, as a #GPermission + filename="gio/gsimplepermission.c" + line="65">the #GSimplePermission, as a #GPermission %TRUE if the action is allowed + filename="gio/gsimplepermission.c" + line="60">%TRUE if the action is allowed @@ -105516,33 +105870,31 @@ either always or never allowed. glib:get-type="g_simple_proxy_resolver_get_type" glib:type-struct="SimpleProxyResolverClass"> #GSimpleProxyResolver is a simple #GProxyResolver implementation + filename="gio/gsimpleproxyresolver.c" + line="35">`GSimpleProxyResolver` is a simple [iface@Gio.ProxyResolver] implementation that handles a single default proxy, multiple URI-scheme-specific proxies, and a list of hosts that proxies should not be used for. -#GSimpleProxyResolver is never the default proxy resolver, but it +`GSimpleProxyResolver` is never the default proxy resolver, but it can be used as the base class for another proxy resolver implementation, or it can be created and used manually, such as -with g_socket_client_set_proxy_resolver(). - +with [method@Gio.SocketClient.set_proxy_resolver]. + Creates a new #GSimpleProxyResolver. See + filename="gio/gsimpleproxyresolver.c" + line="487">Creates a new #GSimpleProxyResolver. See #GSimpleProxyResolver:default-proxy and #GSimpleProxyResolver:ignore-hosts for more details on how the arguments are interpreted. - + a new #GSimpleProxyResolver + filename="gio/gsimpleproxyresolver.c" + line="499">a new #GSimpleProxyResolver @@ -105551,8 +105903,8 @@ arguments are interpreted. nullable="1" allow-none="1"> the default proxy to use, eg + filename="gio/gsimpleproxyresolver.c" + line="489">the default proxy to use, eg "socks://192.168.1.1" @@ -105561,8 +105913,8 @@ arguments are interpreted. nullable="1" allow-none="1"> an optional list of hosts/IP addresses + filename="gio/gsimpleproxyresolver.c" + line="491">an optional list of hosts/IP addresses to not use a proxy for. @@ -105575,24 +105927,23 @@ arguments are interpreted. glib:set-property="default-proxy" version="2.36"> Sets the default proxy on @resolver, to be used for any URIs that + filename="gio/gsimpleproxyresolver.c" + line="513">Sets the default proxy on @resolver, to be used for any URIs that don't match #GSimpleProxyResolver:ignore-hosts or a proxy set via g_simple_proxy_resolver_set_uri_proxy(). If @default_proxy starts with "socks://", #GSimpleProxyResolver will treat it as referring to all three of the socks5, socks4a, and socks4 proxy types. - + a #GSimpleProxyResolver + filename="gio/gsimpleproxyresolver.c" + line="515">a #GSimpleProxyResolver nullable="1" allow-none="1"> the default proxy to use + filename="gio/gsimpleproxyresolver.c" + line="516">the default proxy to use @@ -105611,27 +105962,26 @@ the socks5, socks4a, and socks4 proxy types. glib:set-property="ignore-hosts" version="2.36"> Sets the list of ignored hosts. + filename="gio/gsimpleproxyresolver.c" + line="540">Sets the list of ignored hosts. See #GSimpleProxyResolver:ignore-hosts for more details on how the @ignore_hosts argument is interpreted. - + a #GSimpleProxyResolver + filename="gio/gsimpleproxyresolver.c" + line="542">a #GSimpleProxyResolver %NULL-terminated list of hosts/IP addresses + filename="gio/gsimpleproxyresolver.c" + line="543">%NULL-terminated list of hosts/IP addresses to not use a proxy for @@ -105643,8 +105993,8 @@ See #GSimpleProxyResolver:ignore-hosts for more details on how the c:identifier="g_simple_proxy_resolver_set_uri_proxy" version="2.36"> Adds a URI-scheme-specific proxy to @resolver; URIs whose scheme + filename="gio/gsimpleproxyresolver.c" + line="565">Adds a URI-scheme-specific proxy to @resolver; URIs whose scheme matches @uri_scheme (and which don't match #GSimpleProxyResolver:ignore-hosts) will be proxied via @proxy. @@ -105652,28 +106002,27 @@ As with #GSimpleProxyResolver:default-proxy, if @proxy starts with "socks://", #GSimpleProxyResolver will treat it as referring to all three of the socks5, socks4a, and socks4 proxy types. - + a #GSimpleProxyResolver + filename="gio/gsimpleproxyresolver.c" + line="567">a #GSimpleProxyResolver the URI scheme to add a proxy for + filename="gio/gsimpleproxyresolver.c" + line="568">the URI scheme to add a proxy for the proxy to use for @uri_scheme + filename="gio/gsimpleproxyresolver.c" + line="569">the proxy to use for @uri_scheme @@ -105684,8 +106033,8 @@ types. setter="set_default_proxy" default-value="NULL"> The default proxy URI that will be used for any URI that doesn't + filename="gio/gsimpleproxyresolver.c" + line="416">The default proxy URI that will be used for any URI that doesn't match #GSimpleProxyResolver:ignore-hosts, and doesn't match any of the schemes set with g_simple_proxy_resolver_set_uri_proxy(). @@ -105699,8 +106048,8 @@ to all three of the socks5, socks4a, and socks4 proxy types. transfer-ownership="none" setter="set_ignore_hosts"> A list of hostnames and IP addresses that the resolver should + filename="gio/gsimpleproxyresolver.c" + line="433">A list of hostnames and IP addresses that the resolver should allow direct connections to. Entries can be in one of 4 formats: @@ -105749,15 +106098,13 @@ commonly used by other applications. - + - + @@ -105765,8 +106112,7 @@ commonly used by other applications. - + @@ -105774,8 +106120,7 @@ commonly used by other applications. - + @@ -105783,8 +106128,7 @@ commonly used by other applications. - + @@ -105792,8 +106136,7 @@ commonly used by other applications. - + @@ -105804,8 +106147,7 @@ commonly used by other applications. c:type="GSimpleProxyResolverPrivate" disguised="1" opaque="1"> - + glib:get-type="g_socket_get_type" glib:type-struct="SocketClass"> A #GSocket is a low-level networking primitive. It is a more or less + filename="gio/gsocket.c" + line="85">A `GSocket` is a low-level networking primitive. It is a more or less direct mapping of the BSD socket API in a portable GObject based API. It supports both the UNIX socket implementations and winsock2 on Windows. -#GSocket is the platform independent base upon which the higher level +`GSocket` is the platform independent base upon which the higher level network primitives are based. Applications are not typically meant to -use it directly, but rather through classes like #GSocketClient, -#GSocketService and #GSocketConnection. However there may be cases where -direct use of #GSocket is useful. - -#GSocket implements the #GInitable interface, so if it is manually constructed -by e.g. g_object_new() you must call g_initable_init() and check the -results before using the object. This is done automatically in -g_socket_new() and g_socket_new_from_fd(), so these functions can return -%NULL. +use it directly, but rather through classes like [class@Gio.SocketClient], +[class@Gio.SocketService] and [class@Gio.SocketConnection]. However there may +be cases where direct use of `GSocket` is useful. + +`GSocket` implements the [iface@Gio.Initable] interface, so if it is manually +constructed by e.g. [ctor@GObject.Object.new] you must call +[method@Gio.Initable.init] and check the results before using the object. +This is done automatically in [ctor@Gio.Socket.new] and +[ctor@Gio.Socket.new_from_fd], so these functions can return `NULL`. Sockets operate in two general modes, blocking or non-blocking. When in blocking mode all operations (which don’t take an explicit blocking parameter) block until the requested operation is finished or there is an error. In non-blocking mode all calls that -would block return immediately with a %G_IO_ERROR_WOULD_BLOCK error. -To know when a call would successfully run you can call g_socket_condition_check(), -or g_socket_condition_wait(). You can also use g_socket_create_source() and -attach it to a #GMainContext to get callbacks when I/O is possible. +would block return immediately with a `G_IO_ERROR_WOULD_BLOCK` error. +To know when a call would successfully run you can call +[method@Gio.Socket.condition_check], or [method@Gio.Socket.condition_wait]. +You can also use [method@Gio.Socket.create_source] and attach it to a +[type@GLib.MainContext] to get callbacks when I/O is possible. Note that all sockets are always set to non blocking mode in the system, and -blocking mode is emulated in GSocket. +blocking mode is emulated in `GSocket`. When working in non-blocking mode applications should always be able to -handle getting a %G_IO_ERROR_WOULD_BLOCK error even when some other +handle getting a `G_IO_ERROR_WOULD_BLOCK` error even when some other function said that I/O was possible. This can easily happen in case of a race condition in the application, but it can also happen for other reasons. For instance, on Windows a socket is always seen as writable -until a write returns %G_IO_ERROR_WOULD_BLOCK. +until a write returns `G_IO_ERROR_WOULD_BLOCK`. -#GSockets can be either connection oriented or datagram based. +`GSocket`s can be either connection oriented or datagram based. For connection oriented types you must first establish a connection by either connecting to an address or accepting a connection from another address. For connectionless socket types the target/source address is @@ -105859,17 +106202,34 @@ specified or received in each I/O operation. All socket file descriptors are set to be close-on-exec. -Note that creating a #GSocket causes the signal %SIGPIPE to be +Note that creating a `GSocket` causes the signal `SIGPIPE` to be ignored for the remainder of the program. If you are writing a -command-line utility that uses #GSocket, you may need to take into +command-line utility that uses `GSocket`, you may need to take into account the fact that your program will not automatically be killed -if it tries to write to %stdout after it has been closed. +if it tries to write to `stdout` after it has been closed. + +Like most other APIs in GLib, `GSocket` is not inherently thread safe. To use +a `GSocket` concurrently from multiple threads, you must implement your own +locking. -Like most other APIs in GLib, #GSocket is not inherently thread safe. To use -a #GSocket concurrently from multiple threads, you must implement your own -locking. - +## Nagle’s algorithm + +Since GLib 2.80, `GSocket` will automatically set the `TCP_NODELAY` option on +all `G_SOCKET_TYPE_STREAM` sockets. This disables +[Nagle’s algorithm](https://en.wikipedia.org/wiki/Nagle%27s_algorithm) as it +typically does more harm than good on modern networks. + +If your application needs Nagle’s algorithm enabled, call +[method@Gio.Socket.set_option] after constructing a `GSocket` to enable it: +```c +socket = g_socket_new (…, G_SOCKET_TYPE_STREAM, …); +if (socket != NULL) + { + g_socket_set_option (socket, IPPROTO_TCP, TCP_NODELAY, FALSE, &local_error); + // handle error if needed + } +``` + version="2.22" throws="1"> Creates a new #GSocket with the defined family, type and protocol. + filename="gio/gsocket.c" + line="1337">Creates a new #GSocket with the defined family, type and protocol. If @protocol is 0 (%G_SOCKET_PROTOCOL_DEFAULT) the default protocol type for the family and type is used. @@ -105891,32 +106251,31 @@ the family and type. The protocol id is passed directly to the operating system, so you can use protocols not listed in #GSocketProtocol if you know the protocol number used for it. - + a #GSocket or %NULL on error. + filename="gio/gsocket.c" + line="1358">a #GSocket or %NULL on error. Free the returned object with g_object_unref(). the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4. + filename="gio/gsocket.c" + line="1339">the socket family to use, e.g. %G_SOCKET_FAMILY_IPV4. the socket type to use. + filename="gio/gsocket.c" + line="1340">the socket type to use. the id of the protocol to use, or 0 for default. + filename="gio/gsocket.c" + line="1341">the id of the protocol to use, or 0 for default. @@ -105926,8 +106285,8 @@ know the protocol number used for it. version="2.22" throws="1"> Creates a new #GSocket from a native file descriptor + filename="gio/gsocket.c" + line="1377">Creates a new #GSocket from a native file descriptor or winsock SOCKET handle. This reads all the settings from the file descriptor so that @@ -105940,20 +106299,19 @@ caller must close @fd themselves. Since GLib 2.46, it is no longer a fatal error to call this on a non-socket descriptor. Instead, a GError will be set with code %G_IO_ERROR_FAILED - + a #GSocket or %NULL on error. + filename="gio/gsocket.c" + line="1396">a #GSocket or %NULL on error. Free the returned object with g_object_unref(). a native socket file descriptor. + filename="gio/gsocket.c" + line="1379">a native socket file descriptor. @@ -105963,8 +106321,8 @@ descriptor. Instead, a GError will be set with code %G_IO_ERROR_FAILED version="2.22" throws="1"> Accept incoming connections on a connection-based socket. This removes + filename="gio/gsocket.c" + line="2900">Accept incoming connections on a connection-based socket. This removes the first outstanding connection request from the listening socket and creates a #GSocket object for it. @@ -105974,20 +106332,19 @@ must be listening for incoming connections (g_socket_listen()). If there are no outstanding connections then the operation will block or return %G_IO_ERROR_WOULD_BLOCK if non-blocking I/O is enabled. To be notified of an incoming connection, wait for the %G_IO_IN condition. - + a new #GSocket, or %NULL on error. + filename="gio/gsocket.c" + line="2917">a new #GSocket, or %NULL on error. Free the returned object with g_object_unref(). a #GSocket. + filename="gio/gsocket.c" + line="2902">a #GSocket. nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="2903">a %GCancellable or %NULL @@ -106006,8 +106363,8 @@ To be notified of an incoming connection, wait for the %G_IO_IN condition. version="2.22" throws="1"> When a socket is created it is attached to an address family, but it + filename="gio/gsocket.c" + line="2188">When a socket is created it is attached to an address family, but it doesn't have an address in this family. g_socket_bind() assigns the address (sometimes called name) of the socket. @@ -106030,31 +106387,30 @@ time. In particular, you can have several UDP sockets bound to the same address, and they will all receive all of the multicast and broadcast packets sent to that address. (The behavior of unicast UDP packets to an address with multiple listeners is not defined.) - + %TRUE on success, %FALSE on error. + filename="gio/gsocket.c" + line="2219">%TRUE on success, %FALSE on error. a #GSocket. + filename="gio/gsocket.c" + line="2190">a #GSocket. a #GSocketAddress specifying the local address. + filename="gio/gsocket.c" + line="2191">a #GSocketAddress specifying the local address. whether to allow reusing this address + filename="gio/gsocket.c" + line="2192">whether to allow reusing this address @@ -106064,23 +106420,22 @@ UDP packets to an address with multiple listeners is not defined.) version="2.22" throws="1"> Checks and resets the pending connect error for the socket. + filename="gio/gsocket.c" + line="3138">Checks and resets the pending connect error for the socket. This is used to check for errors when g_socket_connect() is used in non-blocking mode. - + %TRUE if no error, %FALSE otherwise, setting @error to the error + filename="gio/gsocket.c" + line="3147">%TRUE if no error, %FALSE otherwise, setting @error to the error a #GSocket + filename="gio/gsocket.c" + line="3140">a #GSocket @@ -106090,8 +106445,8 @@ used in non-blocking mode. version="2.22" throws="1"> Closes the socket, shutting down any active connection. + filename="gio/gsocket.c" + line="3894">Closes the socket, shutting down any active connection. Closing a socket does not wait for all outstanding I/O operations to finish, so the caller should not rely on them to be guaranteed @@ -106120,19 +106475,18 @@ connection, after which the server can safely call g_socket_close(). g_tcp_connection_set_graceful_disconnect(). But of course, this only works if the client will close its connection after the server does.) - + %TRUE on success, %FALSE on error + filename="gio/gsocket.c" + line="3929">%TRUE on success, %FALSE on error a #GSocket + filename="gio/gsocket.c" + line="3896">a #GSocket @@ -106141,8 +106495,8 @@ does.) c:identifier="g_socket_condition_check" version="2.22"> Checks on the readiness of @socket to perform operations. + filename="gio/gsocket.c" + line="4436">Checks on the readiness of @socket to perform operations. The operations specified in @condition are checked for and masked against the currently-satisfied conditions on @socket. The result is returned. @@ -106159,25 +106513,24 @@ It is meaningless to specify %G_IO_ERR or %G_IO_HUP in condition; these conditions will always be set in the output if they are true. This call never blocks. - + the @GIOCondition mask of the current state + filename="gio/gsocket.c" + line="4459">the @GIOCondition mask of the current state a #GSocket + filename="gio/gsocket.c" + line="4438">a #GSocket a #GIOCondition mask to check + filename="gio/gsocket.c" + line="4439">a #GIOCondition mask to check @@ -106187,8 +106540,8 @@ This call never blocks. version="2.32" throws="1"> Waits for up to @timeout_us microseconds for @condition to become true + filename="gio/gsocket.c" + line="4534">Waits for up to @timeout_us microseconds for @condition to become true on @socket. If the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if @@ -106204,31 +106557,30 @@ Note that although @timeout_us is in microseconds for consistency with other GLib APIs, this function actually only has millisecond resolution, and the behavior is undefined if @timeout_us is not an exact number of milliseconds. - + %TRUE if the condition was met, %FALSE otherwise + filename="gio/gsocket.c" + line="4559">%TRUE if the condition was met, %FALSE otherwise a #GSocket + filename="gio/gsocket.c" + line="4536">a #GSocket a #GIOCondition mask to wait for + filename="gio/gsocket.c" + line="4537">a #GIOCondition mask to wait for the maximum time (in microseconds) to wait, or -1 + filename="gio/gsocket.c" + line="4538">the maximum time (in microseconds) to wait, or -1 nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsocket.c" + line="4539">a #GCancellable, or %NULL @@ -106247,8 +106599,8 @@ exact number of milliseconds. version="2.22" throws="1"> Waits for @condition to become true on @socket. When the condition + filename="gio/gsocket.c" + line="4500">Waits for @condition to become true on @socket. When the condition is met, %TRUE is returned. If @cancellable is cancelled before the condition is met, or if the @@ -106258,25 +106610,24 @@ the appropriate value (%G_IO_ERROR_CANCELLED or %G_IO_ERROR_TIMED_OUT). See also g_socket_condition_timed_wait(). - + %TRUE if the condition was met, %FALSE otherwise + filename="gio/gsocket.c" + line="4518">%TRUE if the condition was met, %FALSE otherwise a #GSocket + filename="gio/gsocket.c" + line="4502">a #GSocket a #GIOCondition mask to wait for + filename="gio/gsocket.c" + line="4503">a #GIOCondition mask to wait for nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsocket.c" + line="4504">a #GCancellable, or %NULL @@ -106295,8 +106646,8 @@ See also g_socket_condition_timed_wait(). version="2.22" throws="1"> Connect the socket to the specified remote address. + filename="gio/gsocket.c" + line="3036">Connect the socket to the specified remote address. For connection oriented socket this generally means we attempt to make a connection to the @address. For a connection-less socket it sets @@ -106312,25 +106663,24 @@ non-blocking I/O is enabled. Then %G_IO_ERROR_PENDING is returned and the user can be notified of the connection finishing by waiting for the G_IO_OUT condition. The result of the connection must then be checked with g_socket_check_connect_result(). - + %TRUE if connected, %FALSE on error. + filename="gio/gsocket.c" + line="3060">%TRUE if connected, %FALSE on error. a #GSocket. + filename="gio/gsocket.c" + line="3038">a #GSocket. a #GSocketAddress specifying the remote address. + filename="gio/gsocket.c" + line="3039">a #GSocketAddress specifying the remote address. nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="3040">a %GCancellable or %NULL @@ -106348,22 +106698,21 @@ checked with g_socket_check_connect_result(). c:identifier="g_socket_connection_factory_create_connection" version="2.22"> Creates a #GSocketConnection subclass of the right type for + filename="gio/gsocketconnection.c" + line="675">Creates a #GSocketConnection subclass of the right type for @socket. - + a #GSocketConnection + filename="gio/gsocketconnection.c" + line="682">a #GSocketConnection a #GSocket + filename="gio/gsocketconnection.c" + line="677">a #GSocket @@ -106373,8 +106722,8 @@ checked with g_socket_check_connect_result(). version="2.22" introspectable="0"> Creates a #GSource that can be attached to a %GMainContext to monitor + filename="gio/gsocket.c" + line="4395">Creates a #GSource that can be attached to a %GMainContext to monitor for the availability of the specified @condition on the socket. The #GSource keeps a reference to the @socket. @@ -106394,25 +106743,24 @@ occurs, the source will then trigger anyway, reporting %G_IO_IN or %G_IO_OUT depending on @condition. However, @socket will have been marked as having had a timeout, and so the next #GSocket I/O method you call will then fail with a %G_IO_ERROR_TIMED_OUT. - + a newly allocated %GSource, free with g_source_unref(). + filename="gio/gsocket.c" + line="4422">a newly allocated %GSource, free with g_source_unref(). a #GSocket + filename="gio/gsocket.c" + line="4397">a #GSocket a #GIOCondition mask to monitor + filename="gio/gsocket.c" + line="4398">a #GIOCondition mask to monitor nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="4399">a %GCancellable or %NULL @@ -106430,8 +106778,8 @@ you call will then fail with a %G_IO_ERROR_TIMED_OUT. c:identifier="g_socket_get_available_bytes" version="2.32"> Get the amount of data pending in the OS input buffer, without blocking. + filename="gio/gsocket.c" + line="3189">Get the amount of data pending in the OS input buffer, without blocking. If @socket is a UDP or SCTP socket, this will return the size of just the next packet, even if additional packets are buffered after @@ -106443,20 +106791,19 @@ of the incoming packet, it is better to just do a g_socket_receive() with a buffer of that size, rather than calling g_socket_get_available_bytes() first and then doing a receive of exactly the right size. - + the number of bytes that can be read from the socket + filename="gio/gsocket.c" + line="3206">the number of bytes that can be read from the socket without blocking or truncating, or -1 on error. a #GSocket + filename="gio/gsocket.c" + line="3191">a #GSocket @@ -106466,22 +106813,21 @@ without blocking or truncating, or -1 on error. glib:get-property="blocking" version="2.22"> Gets the blocking mode of the socket. For details on blocking I/O, + filename="gio/gsocket.c" + line="1443">Gets the blocking mode of the socket. For details on blocking I/O, see g_socket_set_blocking(). - + %TRUE if blocking I/O is used, %FALSE otherwise. + filename="gio/gsocket.c" + line="1450">%TRUE if blocking I/O is used, %FALSE otherwise. a #GSocket. + filename="gio/gsocket.c" + line="1445">a #GSocket. @@ -106491,23 +106837,22 @@ see g_socket_set_blocking(). glib:get-property="broadcast" version="2.32"> Gets the broadcast setting on @socket; if %TRUE, + filename="gio/gsocket.c" + line="1721">Gets the broadcast setting on @socket; if %TRUE, it is possible to send packets to broadcast addresses. - + the broadcast setting on @socket + filename="gio/gsocket.c" + line="1729">the broadcast setting on @socket a #GSocket. + filename="gio/gsocket.c" + line="1723">a #GSocket. @@ -106517,8 +106862,8 @@ addresses. version="2.26" throws="1"> Returns the credentials of the foreign process connected to this + filename="gio/gsocket.c" + line="6224">Returns the credentials of the foreign process connected to this socket, if any (e.g. it is only supported for %G_SOCKET_FAMILY_UNIX sockets). @@ -106538,20 +106883,19 @@ Other ways to obtain credentials from a foreign peer includes the #GUnixCredentialsMessage type and g_unix_connection_send_credentials() / g_unix_connection_receive_credentials() functions. - + %NULL if @error is set, otherwise a #GCredentials object + filename="gio/gsocket.c" + line="6250">%NULL if @error is set, otherwise a #GCredentials object that must be freed with g_object_unref(). a #GSocket. + filename="gio/gsocket.c" + line="6226">a #GSocket. @@ -106561,21 +106905,20 @@ that must be freed with g_object_unref(). glib:get-property="family" version="2.22"> Gets the socket family of the socket. - + filename="gio/gsocket.c" + line="1960">Gets the socket family of the socket. + a #GSocketFamily + filename="gio/gsocket.c" + line="1966">a #GSocketFamily a #GSocket. + filename="gio/gsocket.c" + line="1962">a #GSocket. @@ -106585,25 +106928,24 @@ that must be freed with g_object_unref(). glib:get-property="fd" version="2.22"> Returns the underlying OS socket object. On unix this + filename="gio/gsocket.c" + line="2015">Returns the underlying OS socket object. On unix this is a socket file descriptor, and on Windows this is a Winsock2 SOCKET handle. This may be useful for doing platform specific or otherwise unusual operations on the socket. - + the file descriptor of the socket. + filename="gio/gsocket.c" + line="2025">the file descriptor of the socket. a #GSocket. + filename="gio/gsocket.c" + line="2017">a #GSocket. @@ -106613,22 +106955,21 @@ on the socket. glib:get-property="keepalive" version="2.22"> Gets the keepalive mode of the socket. For details on this, + filename="gio/gsocket.c" + line="1509">Gets the keepalive mode of the socket. For details on this, see g_socket_set_keepalive(). - + %TRUE if keepalive is active, %FALSE otherwise. + filename="gio/gsocket.c" + line="1516">%TRUE if keepalive is active, %FALSE otherwise. a #GSocket. + filename="gio/gsocket.c" + line="1511">a #GSocket. @@ -106638,22 +106979,21 @@ see g_socket_set_keepalive(). glib:get-property="listen-backlog" version="2.22"> Gets the listen backlog setting of the socket. For details on this, + filename="gio/gsocket.c" + line="1528">Gets the listen backlog setting of the socket. For details on this, see g_socket_set_listen_backlog(). - + the maximum number of pending connections. + filename="gio/gsocket.c" + line="1535">the maximum number of pending connections. a #GSocket. + filename="gio/gsocket.c" + line="1530">a #GSocket. @@ -106664,24 +107004,23 @@ see g_socket_set_listen_backlog(). version="2.22" throws="1"> Try to get the local address of a bound socket. This is only + filename="gio/gsocket.c" + line="2037">Try to get the local address of a bound socket. This is only useful if the socket has been bound to a local address, either explicitly or implicitly when connecting. - + a #GSocketAddress or %NULL on error. + filename="gio/gsocket.c" + line="2046">a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). a #GSocket. + filename="gio/gsocket.c" + line="2039">a #GSocket. @@ -106691,23 +107030,22 @@ either explicitly or implicitly when connecting. glib:get-property="multicast-loopback" version="2.32"> Gets the multicast loopback setting on @socket; if %TRUE (the + filename="gio/gsocket.c" + line="1784">Gets the multicast loopback setting on @socket; if %TRUE (the default), outgoing multicast packets will be looped back to multicast listeners on the same host. - + the multicast loopback setting on @socket + filename="gio/gsocket.c" + line="1792">the multicast loopback setting on @socket a #GSocket. + filename="gio/gsocket.c" + line="1786">a #GSocket. @@ -106717,22 +107055,21 @@ multicast listeners on the same host. glib:get-property="multicast-ttl" version="2.32"> Gets the multicast time-to-live setting on @socket; see + filename="gio/gsocket.c" + line="1874">Gets the multicast time-to-live setting on @socket; see g_socket_set_multicast_ttl() for more details. - + the multicast time-to-live setting on @socket + filename="gio/gsocket.c" + line="1881">the multicast time-to-live setting on @socket a #GSocket. + filename="gio/gsocket.c" + line="1876">a #GSocket. @@ -106742,8 +107079,8 @@ g_socket_set_multicast_ttl() for more details. version="2.36" throws="1"> Gets the value of an integer-valued option on @socket, as with + filename="gio/gsocket.c" + line="6418">Gets the value of an integer-valued option on @socket, as with getsockopt(). (If you need to fetch a non-integer-valued option, you will need to call getsockopt() directly.) @@ -106756,12 +107093,11 @@ headers. Note that even for socket options that are a single byte in size, @value is still a pointer to a #gint variable, not a #guchar; g_socket_get_option() will handle the conversion internally. - + success or failure. On failure, @error will be set, and + filename="gio/gsocket.c" + line="6440">success or failure. On failure, @error will be set, and the system error value (`errno` or WSAGetLastError()) will still be set to the result of the getsockopt() call. @@ -106769,20 +107105,20 @@ g_socket_get_option() will handle the conversion internally. a #GSocket + filename="gio/gsocket.c" + line="6420">a #GSocket the "API level" of the option (eg, `SOL_SOCKET`) + filename="gio/gsocket.c" + line="6421">the "API level" of the option (eg, `SOL_SOCKET`) the "name" of the option (eg, `SO_BROADCAST`) + filename="gio/gsocket.c" + line="6422">the "name" of the option (eg, `SO_BROADCAST`) caller-allocates="0" transfer-ownership="full"> return location for the option value + filename="gio/gsocket.c" + line="6423">return location for the option value @@ -106801,22 +107137,21 @@ g_socket_get_option() will handle the conversion internally. glib:get-property="protocol" version="2.22"> Gets the socket protocol id the socket was created with. + filename="gio/gsocket.c" + line="1996">Gets the socket protocol id the socket was created with. In case the protocol is unknown, -1 is returned. - + a protocol id, or -1 if unknown + filename="gio/gsocket.c" + line="2003">a protocol id, or -1 if unknown a #GSocket. + filename="gio/gsocket.c" + line="1998">a #GSocket. @@ -106827,23 +107162,22 @@ In case the protocol is unknown, -1 is returned. version="2.22" throws="1"> Try to get the remote address of a connected socket. This is only + filename="gio/gsocket.c" + line="2074">Try to get the remote address of a connected socket. This is only useful for connection oriented sockets that have been connected. - + a #GSocketAddress or %NULL on error. + filename="gio/gsocket.c" + line="2082">a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). a #GSocket. + filename="gio/gsocket.c" + line="2076">a #GSocket. @@ -106852,21 +107186,20 @@ useful for connection oriented sockets that have been connected. c:identifier="g_socket_get_socket_type" version="2.22"> Gets the socket type of the socket. - + filename="gio/gsocket.c" + line="1978">Gets the socket type of the socket. + a #GSocketType + filename="gio/gsocket.c" + line="1984">a #GSocketType a #GSocket. + filename="gio/gsocket.c" + line="1980">a #GSocket. @@ -106876,22 +107209,21 @@ useful for connection oriented sockets that have been connected. glib:get-property="timeout" version="2.26"> Gets the timeout setting of the socket. For details on this, see + filename="gio/gsocket.c" + line="1576">Gets the timeout setting of the socket. For details on this, see g_socket_set_timeout(). - + the timeout in seconds + filename="gio/gsocket.c" + line="1583">the timeout in seconds a #GSocket. + filename="gio/gsocket.c" + line="1578">a #GSocket. @@ -106901,22 +107233,21 @@ g_socket_set_timeout(). glib:get-property="ttl" version="2.32"> Gets the unicast time-to-live setting on @socket; see + filename="gio/gsocket.c" + line="1636">Gets the unicast time-to-live setting on @socket; see g_socket_set_ttl() for more details. - + the time-to-live setting on @socket + filename="gio/gsocket.c" + line="1643">the time-to-live setting on @socket a #GSocket. + filename="gio/gsocket.c" + line="1638">a #GSocket. @@ -106925,21 +107256,20 @@ g_socket_set_ttl() for more details. c:identifier="g_socket_is_closed" version="2.22"> Checks whether a socket is closed. - + filename="gio/gsocket.c" + line="3983">Checks whether a socket is closed. + %TRUE if socket is closed, %FALSE otherwise + filename="gio/gsocket.c" + line="3989">%TRUE if socket is closed, %FALSE otherwise a #GSocket + filename="gio/gsocket.c" + line="3985">a #GSocket @@ -106948,27 +107278,26 @@ g_socket_set_ttl() for more details. c:identifier="g_socket_is_connected" version="2.22"> Check whether the socket is connected. This is only useful for + filename="gio/gsocket.c" + line="2123">Check whether the socket is connected. This is only useful for connection-oriented sockets. If using g_socket_shutdown(), this function will return %TRUE until the socket has been shut down for reading and writing. If you do a non-blocking connect, this function will not return %TRUE until after you call g_socket_check_connect_result(). - + %TRUE if socket is connected, %FALSE otherwise. + filename="gio/gsocket.c" + line="2135">%TRUE if socket is connected, %FALSE otherwise. a #GSocket. + filename="gio/gsocket.c" + line="2125">a #GSocket. @@ -106978,8 +107307,8 @@ g_socket_check_connect_result(). version="2.32" throws="1"> Registers @socket to receive multicast messages sent to @group. + filename="gio/gsocket.c" + line="2504">Registers @socket to receive multicast messages sent to @group. @socket must be a %G_SOCKET_TYPE_DATAGRAM socket, and must have been bound to an appropriate interface and port with g_socket_bind(). @@ -106993,31 +107322,30 @@ with a %G_IO_ERROR_NOT_SUPPORTED error. To bind to a given source-specific multicast address, use g_socket_join_multicast_group_ssm() instead. - + %TRUE on success, %FALSE on error. + filename="gio/gsocket.c" + line="2527">%TRUE on success, %FALSE on error. a #GSocket. + filename="gio/gsocket.c" + line="2506">a #GSocket. a #GInetAddress specifying the group address to join. + filename="gio/gsocket.c" + line="2507">a #GInetAddress specifying the group address to join. %TRUE if source-specific multicast should be used + filename="gio/gsocket.c" + line="2509">%TRUE if source-specific multicast should be used nullable="1" allow-none="1"> Name of the interface to use, or %NULL + filename="gio/gsocket.c" + line="2508">Name of the interface to use, or %NULL @@ -107036,8 +107364,8 @@ g_socket_join_multicast_group_ssm() instead. version="2.56" throws="1"> Registers @socket to receive multicast messages sent to @group. + filename="gio/gsocket.c" + line="2782">Registers @socket to receive multicast messages sent to @group. @socket must be a %G_SOCKET_TYPE_DATAGRAM socket, and must have been bound to an appropriate interface and port with g_socket_bind(). @@ -107052,25 +107380,24 @@ with a %G_IO_ERROR_NOT_SUPPORTED error. Note that this function can be called multiple times for the same @group with different @source_specific in order to receive multicast packets from more than one source. - + %TRUE on success, %FALSE on error. + filename="gio/gsocket.c" + line="2807">%TRUE on success, %FALSE on error. a #GSocket. + filename="gio/gsocket.c" + line="2784">a #GSocket. a #GInetAddress specifying the group address to join. + filename="gio/gsocket.c" + line="2785">a #GInetAddress specifying the group address to join. nullable="1" allow-none="1"> a #GInetAddress specifying the + filename="gio/gsocket.c" + line="2786">a #GInetAddress specifying the source-specific multicast address or %NULL to ignore. @@ -107088,8 +107415,8 @@ source-specific multicast address or %NULL to ignore. nullable="1" allow-none="1"> Name of the interface to use, or %NULL + filename="gio/gsocket.c" + line="2788">Name of the interface to use, or %NULL @@ -107099,8 +107426,8 @@ source-specific multicast address or %NULL to ignore. version="2.32" throws="1"> Removes @socket from the multicast group defined by @group, @iface, + filename="gio/gsocket.c" + line="2541">Removes @socket from the multicast group defined by @group, @iface, and @source_specific (which must all have the same values they had when you joined the group). @@ -107109,31 +107436,30 @@ unicast messages after calling this. To unbind to a given source-specific multicast address, use g_socket_leave_multicast_group_ssm() instead. - + %TRUE on success, %FALSE on error. + filename="gio/gsocket.c" + line="2559">%TRUE on success, %FALSE on error. a #GSocket. + filename="gio/gsocket.c" + line="2543">a #GSocket. a #GInetAddress specifying the group address to leave. + filename="gio/gsocket.c" + line="2544">a #GInetAddress specifying the group address to leave. %TRUE if source-specific multicast was used + filename="gio/gsocket.c" + line="2546">%TRUE if source-specific multicast was used nullable="1" allow-none="1"> Interface used + filename="gio/gsocket.c" + line="2545">Interface used @@ -107152,32 +107478,31 @@ g_socket_leave_multicast_group_ssm() instead. version="2.56" throws="1"> Removes @socket from the multicast group defined by @group, @iface, + filename="gio/gsocket.c" + line="2822">Removes @socket from the multicast group defined by @group, @iface, and @source_specific (which must all have the same values they had when you joined the group). @socket remains bound to its address and port, and can still receive unicast messages after calling this. - + %TRUE on success, %FALSE on error. + filename="gio/gsocket.c" + line="2838">%TRUE on success, %FALSE on error. a #GSocket. + filename="gio/gsocket.c" + line="2824">a #GSocket. a #GInetAddress specifying the group address to leave. + filename="gio/gsocket.c" + line="2825">a #GInetAddress specifying the group address to leave. nullable="1" allow-none="1"> a #GInetAddress specifying the + filename="gio/gsocket.c" + line="2826">a #GInetAddress specifying the source-specific multicast address or %NULL to ignore. @@ -107195,8 +107520,8 @@ source-specific multicast address or %NULL to ignore. nullable="1" allow-none="1"> Name of the interface to use, or %NULL + filename="gio/gsocket.c" + line="2828">Name of the interface to use, or %NULL @@ -107206,8 +107531,8 @@ source-specific multicast address or %NULL to ignore. version="2.22" throws="1"> Marks the socket as a server socket, i.e. a socket that is used + filename="gio/gsocket.c" + line="2147">Marks the socket as a server socket, i.e. a socket that is used to accept incoming requests using g_socket_accept(). Before calling this the socket must be bound to a local address using @@ -107215,19 +107540,18 @@ g_socket_bind(). To set the maximum amount of outstanding clients, use g_socket_set_listen_backlog(). - + %TRUE on success, %FALSE on error. + filename="gio/gsocket.c" + line="2161">%TRUE on success, %FALSE on error. a #GSocket. + filename="gio/gsocket.c" + line="2149">a #GSocket. @@ -107237,8 +107561,8 @@ g_socket_set_listen_backlog(). version="2.22" throws="1"> Receive data (up to @size bytes) from a socket. This is mainly used by + filename="gio/gsocket.c" + line="3431">Receive data (up to @size bytes) from a socket. This is mainly used by connection-oriented sockets; it is identical to g_socket_receive_from() with @address set to %NULL. @@ -107261,20 +107585,19 @@ returned. To be notified when data is available, wait for the %G_IO_IN condition. On error -1 is returned and @error is set accordingly. - + Number of bytes read, or 0 if the connection was closed by + filename="gio/gsocket.c" + line="3464">Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error a #GSocket + filename="gio/gsocket.c" + line="3433">a #GSocket caller-allocates="1" transfer-ownership="none"> + filename="gio/gsocket.c" + line="3434"> a buffer to read data into (which should be at least @size bytes long). @@ -107291,17 +107614,141 @@ the peer, or -1 on error the number of bytes you want to read from the socket + filename="gio/gsocket.c" + line="3436">the number of bytes you want to read from the socket + + + + a %GCancellable or %NULL + + + + + + Receives data (up to @size bytes) from a socket. + +This function is a variant of [method@Gio.Socket.receive] which returns a +[struct@GLib.Bytes] rather than a plain buffer. + +Pass `-1` to @timeout_us to block indefinitely until data is received (or +the connection is closed, or there is an error). Pass `0` to use the default +timeout from [property@Gio.Socket:timeout], or pass a positive number to wait +for that many microseconds for data before returning `G_IO_ERROR_TIMED_OUT`. + + + a bytes buffer containing the + received bytes, or `NULL` on error + + + + + a #GSocket + + + + the number of bytes you want to read from the socket + + + + the timeout to wait for, in microseconds, or `-1` to block + indefinitely + + + + a %GCancellable, or `NULL` + + + + + + Receive data (up to @size bytes) from a socket. + +This function is a variant of [method@Gio.Socket.receive_from] which returns +a [struct@GLib.Bytes] rather than a plain buffer. + +If @address is non-%NULL then @address will be set equal to the +source address of the received packet. + +The @address is owned by the caller. + +Pass `-1` to @timeout_us to block indefinitely until data is received (or +the connection is closed, or there is an error). Pass `0` to use the default +timeout from [property@Gio.Socket:timeout], or pass a positive number to wait +for that many microseconds for data before returning `G_IO_ERROR_TIMED_OUT`. + + + a bytes buffer containing the + received bytes, or `NULL` on error + + + + + a #GSocket + + + + return location for a #GSocketAddress + + + + the number of bytes you want to read from the socket + + the timeout to wait for, in microseconds, or `-1` to block + indefinitely + + a %GCancellable or %NULL + filename="gio/gsocket.c" + line="3519">a #GCancellable, or `NULL` @@ -107311,28 +107758,27 @@ the peer, or -1 on error version="2.22" throws="1"> Receive data (up to @size bytes) from a socket. + filename="gio/gsocket.c" + line="3591">Receive data (up to @size bytes) from a socket. If @address is non-%NULL then @address will be set equal to the source address of the received packet. @address is owned by the caller. See g_socket_receive() for additional information. - + Number of bytes read, or 0 if the connection was closed by + filename="gio/gsocket.c" + line="3610">Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error a #GSocket + filename="gio/gsocket.c" + line="3593">a #GSocket optional="1" allow-none="1"> a pointer to a #GSocketAddress + filename="gio/gsocket.c" + line="3594">a pointer to a #GSocketAddress pointer, or %NULL @@ -107352,8 +107798,8 @@ the peer, or -1 on error caller-allocates="1" transfer-ownership="none"> + filename="gio/gsocket.c" + line="3596"> a buffer to read data into (which should be at least @size bytes long). @@ -107361,8 +107807,8 @@ the peer, or -1 on error the number of bytes you want to read from the socket + filename="gio/gsocket.c" + line="3598">the number of bytes you want to read from the socket nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="3599">a %GCancellable or %NULL @@ -107381,8 +107827,8 @@ the peer, or -1 on error version="2.22" throws="1"> Receive data from a socket. For receiving multiple messages, see + filename="gio/gsocket.c" + line="6124">Receive data from a socket. For receiving multiple messages, see g_socket_receive_messages(); for easier use, see g_socket_receive() and g_socket_receive_from(). @@ -107441,20 +107887,19 @@ returned. To be notified when data is available, wait for the %G_IO_IN condition. On error -1 is returned and @error is set accordingly. - + Number of bytes read, or 0 if the connection was closed by + filename="gio/gsocket.c" + line="6201">Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error a #GSocket + filename="gio/gsocket.c" + line="6126">a #GSocket optional="1" allow-none="1"> a pointer to a #GSocketAddress + filename="gio/gsocket.c" + line="6127">a pointer to a #GSocketAddress pointer, or %NULL an array of #GInputVector structs + filename="gio/gsocket.c" + line="6129">an array of #GInputVector structs the number of elements in @vectors, or -1 + filename="gio/gsocket.c" + line="6130">the number of elements in @vectors, or -1 optional="1" allow-none="1"> a pointer + filename="gio/gsocket.c" + line="6131">a pointer which may be filled with an array of #GSocketControlMessages, or %NULL caller-allocates="0" transfer-ownership="full"> a pointer which will be filled with the number of + filename="gio/gsocket.c" + line="6133">a pointer which will be filled with the number of elements in @messages, or %NULL @@ -107516,8 +107961,8 @@ the peer, or -1 on error caller-allocates="0" transfer-ownership="full"> a pointer to an int containing #GSocketMsgFlags flags, + filename="gio/gsocket.c" + line="6135">a pointer to an int containing #GSocketMsgFlags flags, which may additionally contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) @@ -107527,8 +107972,8 @@ the peer, or -1 on error nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="6138">a %GCancellable or %NULL @@ -107538,8 +107983,8 @@ the peer, or -1 on error version="2.48" throws="1"> Receive multiple data messages from @socket in one go. This is the most + filename="gio/gsocket.c" + line="5845">Receive multiple data messages from @socket in one go. This is the most complicated and fully-featured version of this call. For easier use, see g_socket_receive(), g_socket_receive_from(), and g_socket_receive_message(). @@ -107587,12 +108032,11 @@ g_socket_receive_messages() will return 0 (with no error set). On error -1 is returned and @error is set accordingly. An error will only be returned if zero messages could be received; otherwise the number of messages successfully received before the error will be returned. - + number of messages received, or -1 on error. Note that the number + filename="gio/gsocket.c" + line="5905">number of messages received, or -1 on error. Note that the number of messages received may be smaller than @num_messages if in non-blocking mode, if the peer closed the connection, or if @num_messages was larger than `UIO_MAXIOV` (1024), in which case the caller may re-try @@ -107602,28 +108046,28 @@ messages successfully received before the error will be returned. a #GSocket + filename="gio/gsocket.c" + line="5847">a #GSocket an array of #GInputMessage structs + filename="gio/gsocket.c" + line="5848">an array of #GInputMessage structs the number of elements in @messages + filename="gio/gsocket.c" + line="5849">the number of elements in @messages an int containing #GSocketMsgFlags flags for the overall operation, + filename="gio/gsocket.c" + line="5850">an int containing #GSocketMsgFlags flags for the overall operation, which may additionally contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) @@ -107633,8 +108077,8 @@ messages successfully received before the error will be returned. nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="5853">a %GCancellable or %NULL @@ -107644,24 +108088,23 @@ messages successfully received before the error will be returned. version="2.26" throws="1"> This behaves exactly the same as g_socket_receive(), except that + filename="gio/gsocket.c" + line="3481">This behaves exactly the same as g_socket_receive(), except that the choice of blocking or non-blocking behavior is determined by the @blocking argument rather than by @socket's properties. - + Number of bytes read, or 0 if the connection was closed by + filename="gio/gsocket.c" + line="3495">Number of bytes read, or 0 if the connection was closed by the peer, or -1 on error a #GSocket + filename="gio/gsocket.c" + line="3483">a #GSocket caller-allocates="1" transfer-ownership="none"> + filename="gio/gsocket.c" + line="3484"> a buffer to read data into (which should be at least @size bytes long). @@ -107678,14 +108121,14 @@ the peer, or -1 on error the number of bytes you want to read from the socket + filename="gio/gsocket.c" + line="3486">the number of bytes you want to read from the socket whether to do blocking or non-blocking I/O + filename="gio/gsocket.c" + line="3487">whether to do blocking or non-blocking I/O nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="3488">a %GCancellable or %NULL @@ -107704,8 +108147,8 @@ the peer, or -1 on error version="2.22" throws="1"> Tries to send @size bytes from @buffer on the socket. This is + filename="gio/gsocket.c" + line="3704">Tries to send @size bytes from @buffer on the socket. This is mainly used by connection-oriented sockets; it is identical to g_socket_send_to() with @address set to %NULL. @@ -107719,26 +108162,25 @@ notified of a %G_IO_OUT condition. (On Windows in particular, this is very common due to the way the underlying APIs work.) On error -1 is returned and @error is set accordingly. - + Number of bytes written (which may be less than @size), or -1 + filename="gio/gsocket.c" + line="3728">Number of bytes written (which may be less than @size), or -1 on error a #GSocket + filename="gio/gsocket.c" + line="3706">a #GSocket the buffer + filename="gio/gsocket.c" + line="3707">the buffer containing the data to send. @@ -107746,8 +108188,8 @@ on error the number of bytes to send + filename="gio/gsocket.c" + line="3709">the number of bytes to send nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="3710">a %GCancellable or %NULL @@ -107766,8 +108208,8 @@ on error version="2.22" throws="1"> Send data to @address on @socket. For sending multiple messages see + filename="gio/gsocket.c" + line="4962">Send data to @address on @socket. For sending multiple messages see g_socket_send_messages(); for easier use, see g_socket_send() and g_socket_send_to(). @@ -107809,20 +108251,19 @@ then it is mandatory to use the g_socket_send_message_with_timeout() function. On error -1 is returned and @error is set accordingly. - + Number of bytes written (which may be less than @size), or -1 + filename="gio/gsocket.c" + line="5019">Number of bytes written (which may be less than @size), or -1 on error a #GSocket + filename="gio/gsocket.c" + line="4964">a #GSocket nullable="1" allow-none="1"> a #GSocketAddress, or %NULL + filename="gio/gsocket.c" + line="4965">a #GSocketAddress, or %NULL an array of #GOutputVector structs + filename="gio/gsocket.c" + line="4966">an array of #GOutputVector structs the number of elements in @vectors, or -1 + filename="gio/gsocket.c" + line="4967">the number of elements in @vectors, or -1 nullable="1" allow-none="1"> a pointer to an + filename="gio/gsocket.c" + line="4968">a pointer to an array of #GSocketControlMessages, or %NULL. number of elements in @messages, or -1. + filename="gio/gsocket.c" + line="4970">number of elements in @messages, or -1. an int containing #GSocketMsgFlags flags, which may additionally + filename="gio/gsocket.c" + line="4971">an int containing #GSocketMsgFlags flags, which may additionally contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) @@ -107881,8 +108322,8 @@ on error nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="4973">a %GCancellable or %NULL @@ -107892,20 +108333,19 @@ on error version="2.60" throws="1"> This behaves exactly the same as g_socket_send_message(), except that + filename="gio/gsocket.c" + line="5102">This behaves exactly the same as g_socket_send_message(), except that the choice of timeout behavior is determined by the @timeout_us argument rather than by @socket's properties. On error %G_POLLABLE_RETURN_FAILED is returned and @error is set accordingly, or if the socket is currently not writable %G_POLLABLE_RETURN_WOULD_BLOCK is returned. @bytes_written will contain 0 in both cases. - + %G_POLLABLE_RETURN_OK if all data was successfully written, + filename="gio/gsocket.c" + line="5126">%G_POLLABLE_RETURN_OK if all data was successfully written, %G_POLLABLE_RETURN_WOULD_BLOCK if the socket is currently not writable, or %G_POLLABLE_RETURN_FAILED if an error happened and @error is set. @@ -107913,8 +108353,8 @@ returned. @bytes_written will contain 0 in both cases. a #GSocket + filename="gio/gsocket.c" + line="5104">a #GSocket nullable="1" allow-none="1"> a #GSocketAddress, or %NULL + filename="gio/gsocket.c" + line="5105">a #GSocketAddress, or %NULL an array of #GOutputVector structs + filename="gio/gsocket.c" + line="5106">an array of #GOutputVector structs @@ -107938,8 +108378,8 @@ returned. @bytes_written will contain 0 in both cases. the number of elements in @vectors, or -1 + filename="gio/gsocket.c" + line="5107">the number of elements in @vectors, or -1 nullable="1" allow-none="1"> a pointer to an + filename="gio/gsocket.c" + line="5108">a pointer to an array of #GSocketControlMessages, or %NULL. number of elements in @messages, or -1. + filename="gio/gsocket.c" + line="5110">number of elements in @messages, or -1. an int containing #GSocketMsgFlags flags, which may additionally + filename="gio/gsocket.c" + line="5111">an int containing #GSocketMsgFlags flags, which may additionally contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) the maximum time (in microseconds) to wait, or -1 + filename="gio/gsocket.c" + line="5113">the maximum time (in microseconds) to wait, or -1 optional="1" allow-none="1"> location to store the number of bytes that were written to the socket + filename="gio/gsocket.c" + line="5114">location to store the number of bytes that were written to the socket nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="5115">a %GCancellable or %NULL @@ -108003,8 +108443,8 @@ returned. @bytes_written will contain 0 in both cases. version="2.44" throws="1"> Send multiple data messages from @socket in one go. This is the most + filename="gio/gsocket.c" + line="5340">Send multiple data messages from @socket in one go. This is the most complicated and fully-featured version of this call. For easier use, see g_socket_send(), g_socket_send_to(), and g_socket_send_message(). @@ -108038,12 +108478,11 @@ very common due to the way the underlying APIs work.) On error -1 is returned and @error is set accordingly. An error will only be returned if zero messages could be sent; otherwise the number of messages successfully sent before the error will be returned. - + number of messages sent, or -1 on error. Note that the number of + filename="gio/gsocket.c" + line="5385">number of messages sent, or -1 on error. Note that the number of messages sent may be smaller than @num_messages if the socket is non-blocking or if @num_messages was larger than UIO_MAXIOV (1024), in which case the caller may re-try to send the remaining messages. @@ -108052,28 +108491,28 @@ successfully sent before the error will be returned. a #GSocket + filename="gio/gsocket.c" + line="5342">a #GSocket an array of #GOutputMessage structs + filename="gio/gsocket.c" + line="5343">an array of #GOutputMessage structs the number of elements in @messages + filename="gio/gsocket.c" + line="5344">the number of elements in @messages an int containing #GSocketMsgFlags flags, which may additionally + filename="gio/gsocket.c" + line="5345">an int containing #GSocketMsgFlags flags, which may additionally contain [other platform specific flags](http://man7.org/linux/man-pages/man2/recv.2.html) @@ -108082,8 +108521,8 @@ successfully sent before the error will be returned. nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="5347">a %GCancellable or %NULL @@ -108093,26 +108532,25 @@ successfully sent before the error will be returned. version="2.22" throws="1"> Tries to send @size bytes from @buffer to @address. If @address is + filename="gio/gsocket.c" + line="3776">Tries to send @size bytes from @buffer to @address. If @address is %NULL then the message is sent to the default receiver (set by g_socket_connect()). See g_socket_send() for additional information. - + Number of bytes written (which may be less than @size), or -1 + filename="gio/gsocket.c" + line="3792">Number of bytes written (which may be less than @size), or -1 on error a #GSocket + filename="gio/gsocket.c" + line="3778">a #GSocket nullable="1" allow-none="1"> a #GSocketAddress, or %NULL + filename="gio/gsocket.c" + line="3779">a #GSocketAddress, or %NULL the buffer + filename="gio/gsocket.c" + line="3780">the buffer containing the data to send. @@ -108135,8 +108573,8 @@ on error the number of bytes to send + filename="gio/gsocket.c" + line="3782">the number of bytes to send nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="3783">a %GCancellable or %NULL @@ -108155,30 +108593,29 @@ on error version="2.26" throws="1"> This behaves exactly the same as g_socket_send(), except that + filename="gio/gsocket.c" + line="3745">This behaves exactly the same as g_socket_send(), except that the choice of blocking or non-blocking behavior is determined by the @blocking argument rather than by @socket's properties. - + Number of bytes written (which may be less than @size), or -1 + filename="gio/gsocket.c" + line="3759">Number of bytes written (which may be less than @size), or -1 on error a #GSocket + filename="gio/gsocket.c" + line="3747">a #GSocket the buffer + filename="gio/gsocket.c" + line="3748">the buffer containing the data to send. @@ -108186,14 +108623,14 @@ on error the number of bytes to send + filename="gio/gsocket.c" + line="3750">the number of bytes to send whether to do blocking or non-blocking I/O + filename="gio/gsocket.c" + line="3751">whether to do blocking or non-blocking I/O nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocket.c" + line="3752">a %GCancellable or %NULL @@ -108212,8 +108649,8 @@ on error glib:set-property="blocking" version="2.22"> Sets the blocking mode of the socket. In blocking mode + filename="gio/gsocket.c" + line="1411">Sets the blocking mode of the socket. In blocking mode all operations (which don’t take an explicit blocking parameter) block until they succeed or there is an error. In non-blocking mode all functions return results immediately or @@ -108222,22 +108659,21 @@ with a %G_IO_ERROR_WOULD_BLOCK error. All sockets are created in blocking mode. However, note that the platform level socket is always non-blocking, and blocking mode is a GSocket level feature. - + a #GSocket. + filename="gio/gsocket.c" + line="1413">a #GSocket. Whether to use blocking I/O or not. + filename="gio/gsocket.c" + line="1414">Whether to use blocking I/O or not. @@ -108247,25 +108683,24 @@ is a GSocket level feature. glib:set-property="broadcast" version="2.32"> Sets whether @socket should allow sending to broadcast addresses. + filename="gio/gsocket.c" + line="1752">Sets whether @socket should allow sending to broadcast addresses. This is %FALSE by default. - + a #GSocket. + filename="gio/gsocket.c" + line="1754">a #GSocket. whether @socket should allow sending to broadcast + filename="gio/gsocket.c" + line="1755">whether @socket should allow sending to broadcast addresses @@ -108276,8 +108711,8 @@ This is %FALSE by default. glib:set-property="keepalive" version="2.22"> Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When + filename="gio/gsocket.c" + line="1462">Sets or unsets the %SO_KEEPALIVE flag on the underlying socket. When this flag is set on a socket, the system will attempt to verify that the remote socket endpoint is still present if a sufficiently long period of time passes with no data being exchanged. If the system is unable to @@ -108292,22 +108727,21 @@ normally be at least two hours. Most commonly, you would set this flag on a server socket if you want to allow clients to remain idle for long periods of time, but also want to ensure that connections are eventually garbage-collected if clients crash or become unreachable. - + a #GSocket. + filename="gio/gsocket.c" + line="1464">a #GSocket. Value for the keepalive flag + filename="gio/gsocket.c" + line="1465">Value for the keepalive flag @@ -108317,30 +108751,29 @@ garbage-collected if clients crash or become unreachable. glib:set-property="listen-backlog" version="2.22"> Sets the maximum number of outstanding connections allowed + filename="gio/gsocket.c" + line="1547">Sets the maximum number of outstanding connections allowed when listening on this socket. If more clients than this are connecting to the socket and the application is not handling them on time then the new connections will be refused. Note that this must be called before g_socket_listen() and has no effect if called after that. - + a #GSocket. + filename="gio/gsocket.c" + line="1549">a #GSocket. the maximum number of pending connections. + filename="gio/gsocket.c" + line="1550">the maximum number of pending connections. @@ -108350,26 +108783,25 @@ effect if called after that. glib:set-property="multicast-loopback" version="2.32"> Sets whether outgoing multicast packets will be received by sockets + filename="gio/gsocket.c" + line="1827">Sets whether outgoing multicast packets will be received by sockets listening on that multicast address on the same host. This is %TRUE by default. - + a #GSocket. + filename="gio/gsocket.c" + line="1829">a #GSocket. whether @socket should receive messages sent to its + filename="gio/gsocket.c" + line="1830">whether @socket should receive messages sent to its multicast groups from the local host @@ -108380,26 +108812,25 @@ by default. glib:set-property="multicast-ttl" version="2.32"> Sets the time-to-live for outgoing multicast datagrams on @socket. + filename="gio/gsocket.c" + line="1916">Sets the time-to-live for outgoing multicast datagrams on @socket. By default, this is 1, meaning that multicast packets will not leave the local network. - + a #GSocket. + filename="gio/gsocket.c" + line="1918">a #GSocket. the time-to-live value for all multicast datagrams on @socket + filename="gio/gsocket.c" + line="1919">the time-to-live value for all multicast datagrams on @socket @@ -108409,8 +108840,8 @@ the local network. version="2.36" throws="1"> Sets the value of an integer-valued option on @socket, as with + filename="gio/gsocket.c" + line="6490">Sets the value of an integer-valued option on @socket, as with setsockopt(). (If you need to set a non-integer-valued option, you will need to call setsockopt() directly.) @@ -108419,12 +108850,11 @@ header pulls in system headers that will define most of the standard/portable socket options. For unusual socket protocols or platform-dependent options, you may need to include additional headers. - + success or failure. On failure, @error will be set, and + filename="gio/gsocket.c" + line="6508">success or failure. On failure, @error will be set, and the system error value (`errno` or WSAGetLastError()) will still be set to the result of the setsockopt() call. @@ -108432,26 +108862,26 @@ headers. a #GSocket + filename="gio/gsocket.c" + line="6492">a #GSocket the "API level" of the option (eg, `SOL_SOCKET`) + filename="gio/gsocket.c" + line="6493">the "API level" of the option (eg, `SOL_SOCKET`) the "name" of the option (eg, `SO_BROADCAST`) + filename="gio/gsocket.c" + line="6494">the "name" of the option (eg, `SO_BROADCAST`) the value to set the option to + filename="gio/gsocket.c" + line="6495">the value to set the option to @@ -108461,8 +108891,8 @@ headers. glib:set-property="timeout" version="2.26"> Sets the time in seconds after which I/O operations on @socket will + filename="gio/gsocket.c" + line="1595">Sets the time in seconds after which I/O operations on @socket will time out if they have not yet completed. On a blocking socket, this means that any blocking #GSocket @@ -108482,22 +108912,21 @@ on their own. Note that if an I/O operation is interrupted by a signal, this may cause the timeout to be reset. - + a #GSocket. + filename="gio/gsocket.c" + line="1597">a #GSocket. the timeout for @socket, in seconds, or 0 for none + filename="gio/gsocket.c" + line="1598">the timeout for @socket, in seconds, or 0 for none @@ -108507,25 +108936,24 @@ cause the timeout to be reset. glib:set-property="ttl" version="2.32"> Sets the time-to-live for outgoing unicast packets on @socket. + filename="gio/gsocket.c" + line="1678">Sets the time-to-live for outgoing unicast packets on @socket. By default the platform-specific default value is used. - + a #GSocket. + filename="gio/gsocket.c" + line="1680">a #GSocket. the time-to-live value for all unicast packets on @socket + filename="gio/gsocket.c" + line="1681">the time-to-live value for all unicast packets on @socket @@ -108535,8 +108963,8 @@ By default the platform-specific default value is used. version="2.22" throws="1"> Shut down part or all of a full-duplex connection. + filename="gio/gsocket.c" + line="3819">Shut down part or all of a full-duplex connection. If @shutdown_read is %TRUE then the receiving side of the connection is shut down, and further reading is disallowed. @@ -108550,31 +108978,30 @@ One example where it is useful to shut down only one side of a connection is graceful disconnect for TCP connections where you close the sending side, then wait for the other side to close the connection, thus ensuring that the other side saw all sent data. - + %TRUE on success, %FALSE on error + filename="gio/gsocket.c" + line="3841">%TRUE on success, %FALSE on error a #GSocket + filename="gio/gsocket.c" + line="3821">a #GSocket whether to shut down the read side + filename="gio/gsocket.c" + line="3822">whether to shut down the read side whether to shut down the write side + filename="gio/gsocket.c" + line="3823">whether to shut down the write side @@ -108583,8 +109010,8 @@ other side saw all sent data. c:identifier="g_socket_speaks_ipv4" version="2.22"> Checks if a socket is capable of speaking IPv4. + filename="gio/gsocket.c" + line="2853">Checks if a socket is capable of speaking IPv4. IPv4 sockets are capable of speaking IPv4. On some operating systems and under some combinations of circumstances IPv6 sockets are also @@ -108593,29 +109020,32 @@ information. No other types of sockets are currently considered as being capable of speaking IPv4. - + %TRUE if this socket can be used with IPv4. + filename="gio/gsocket.c" + line="2867">%TRUE if this socket can be used with IPv4. a #GSocket + filename="gio/gsocket.c" + line="2855">a #GSocket + Whether I/O on this socket is blocking. getter="get_broadcast" default-value="FALSE"> Whether the socket should allow sending to broadcast addresses. + filename="gio/gsocket.c" + line="1118">Whether the socket should allow sending to broadcast addresses. + The socket’s address family. + The socket’s file descriptor. + Whether to keep the connection alive by sending periodic pings. + The number of outstanding connections in the listen queue. + The local address the socket is bound to. getter="get_multicast_loopback" default-value="TRUE"> Whether outgoing multicast packets loop back to the local host. + filename="gio/gsocket.c" + line="1144">Whether outgoing multicast packets loop back to the local host. getter="get_multicast_ttl" default-value="1"> Time-to-live out outgoing multicast packets + filename="gio/gsocket.c" + line="1157">Time-to-live out outgoing multicast packets + The ID of the protocol to use, or `-1` for unknown. + The remote address the socket is connected to. getter="get_timeout" default-value="0"> The timeout in seconds on socket I/O + filename="gio/gsocket.c" + line="1103">The timeout in seconds on socket I/O getter="get_ttl" default-value="0"> Time-to-live for outgoing unicast packets + filename="gio/gsocket.c" + line="1131">Time-to-live for outgoing unicast packets + The socket’s type. @@ -108751,61 +109213,59 @@ of speaking IPv4. glib:get-type="g_socket_address_get_type" glib:type-struct="SocketAddressClass"> #GSocketAddress is the equivalent of struct sockaddr in the BSD -sockets API. This is an abstract class; use #GInetSocketAddress -for internet sockets, or #GUnixSocketAddress for UNIX domain sockets. - + filename="gio/gsocketaddress.c" + line="47">`GSocketAddress` is the equivalent of +[`struct sockaddr`](man:sockaddr(3type)) and its subtypes in the BSD sockets +API. This is an abstract class; use [class@Gio.InetSocketAddress] for +internet sockets, or [class@Gio.UnixSocketAddress] for UNIX domain sockets. + Creates a #GSocketAddress subclass corresponding to the native + filename="gio/gsocketaddress.c" + line="193">Creates a #GSocketAddress subclass corresponding to the native struct sockaddr @native. - + a new #GSocketAddress if @native could successfully + filename="gio/gsocketaddress.c" + line="201">a new #GSocketAddress if @native could successfully be converted, otherwise %NULL a pointer to a struct sockaddr + filename="gio/gsocketaddress.c" + line="195">a pointer to a struct sockaddr the size of the memory location pointed to by @native + filename="gio/gsocketaddress.c" + line="196">the size of the memory location pointed to by @native Gets the socket family type of @address. - + filename="gio/gsocketaddress.c" + line="70">Gets the socket family type of @address. + the socket family type of @address + filename="gio/gsocketaddress.c" + line="76">the socket family type of @address a #GSocketAddress + filename="gio/gsocketaddress.c" + line="72">a #GSocketAddress @@ -108814,24 +109274,23 @@ struct sockaddr @native. invoker="get_native_size" version="2.22"> Gets the size of @address's native struct sockaddr. + filename="gio/gsocketaddress.c" + line="141">Gets the size of @address's native struct sockaddr. You can use this to allocate memory to pass to g_socket_address_to_native(). - + the size of the native struct sockaddr that + filename="gio/gsocketaddress.c" + line="149">the size of the native struct sockaddr that @address represents a #GSocketAddress + filename="gio/gsocketaddress.c" + line="143">a #GSocketAddress @@ -108841,26 +109300,25 @@ g_socket_address_to_native(). version="2.22" throws="1"> Converts a #GSocketAddress to a native struct sockaddr, which can + filename="gio/gsocketaddress.c" + line="162">Converts a #GSocketAddress to a native struct sockaddr, which can be passed to low-level functions like connect() or bind(). If not enough space is available, a %G_IO_ERROR_NO_SPACE error is returned. If the address type is not known on the system then a %G_IO_ERROR_NOT_SUPPORTED error is returned. - + %TRUE if @dest was filled in, %FALSE on error + filename="gio/gsocketaddress.c" + line="178">%TRUE if @dest was filled in, %FALSE on error a #GSocketAddress + filename="gio/gsocketaddress.c" + line="164">a #GSocketAddress nullable="1" allow-none="1"> a pointer to a memory location that will contain the native + filename="gio/gsocketaddress.c" + line="165">a pointer to a memory location that will contain the native struct sockaddr the size of @dest. Must be at least as large as + filename="gio/gsocketaddress.c" + line="167">the size of @dest. Must be at least as large as g_socket_address_get_native_size() @@ -108887,21 +109345,20 @@ struct sockaddr glib:get-property="family" version="2.22"> Gets the socket family type of @address. - + filename="gio/gsocketaddress.c" + line="70">Gets the socket family type of @address. + the socket family type of @address + filename="gio/gsocketaddress.c" + line="76">the socket family type of @address a #GSocketAddress + filename="gio/gsocketaddress.c" + line="72">a #GSocketAddress @@ -108910,24 +109367,23 @@ struct sockaddr c:identifier="g_socket_address_get_native_size" version="2.22"> Gets the size of @address's native struct sockaddr. + filename="gio/gsocketaddress.c" + line="141">Gets the size of @address's native struct sockaddr. You can use this to allocate memory to pass to g_socket_address_to_native(). - + the size of the native struct sockaddr that + filename="gio/gsocketaddress.c" + line="149">the size of the native struct sockaddr that @address represents a #GSocketAddress + filename="gio/gsocketaddress.c" + line="143">a #GSocketAddress @@ -108937,26 +109393,25 @@ g_socket_address_to_native(). version="2.22" throws="1"> Converts a #GSocketAddress to a native struct sockaddr, which can + filename="gio/gsocketaddress.c" + line="162">Converts a #GSocketAddress to a native struct sockaddr, which can be passed to low-level functions like connect() or bind(). If not enough space is available, a %G_IO_ERROR_NO_SPACE error is returned. If the address type is not known on the system then a %G_IO_ERROR_NOT_SUPPORTED error is returned. - + %TRUE if @dest was filled in, %FALSE on error + filename="gio/gsocketaddress.c" + line="178">%TRUE if @dest was filled in, %FALSE on error a #GSocketAddress + filename="gio/gsocketaddress.c" + line="164">a #GSocketAddress nullable="1" allow-none="1"> a pointer to a memory location that will contain the native + filename="gio/gsocketaddress.c" + line="165">a pointer to a memory location that will contain the native struct sockaddr the size of @dest. Must be at least as large as + filename="gio/gsocketaddress.c" + line="167">the size of @dest. Must be at least as large as g_socket_address_get_native_size() + The family of the socket address. @@ -108991,26 +109450,24 @@ struct sockaddr - + - + the socket family type of @address + filename="gio/gsocketaddress.c" + line="76">the socket family type of @address a #GSocketAddress + filename="gio/gsocketaddress.c" + line="72">a #GSocketAddress @@ -109018,20 +109475,19 @@ struct sockaddr - + the size of the native struct sockaddr that + filename="gio/gsocketaddress.c" + line="149">the size of the native struct sockaddr that @address represents a #GSocketAddress + filename="gio/gsocketaddress.c" + line="143">a #GSocketAddress @@ -109039,19 +109495,18 @@ struct sockaddr - + %TRUE if @dest was filled in, %FALSE on error + filename="gio/gsocketaddress.c" + line="178">%TRUE if @dest was filled in, %FALSE on error a #GSocketAddress + filename="gio/gsocketaddress.c" + line="164">a #GSocketAddress nullable="1" allow-none="1"> a pointer to a memory location that will contain the native + filename="gio/gsocketaddress.c" + line="165">a pointer to a memory location that will contain the native struct sockaddr the size of @dest. Must be at least as large as + filename="gio/gsocketaddress.c" + line="167">the size of @dest. Must be at least as large as g_socket_address_get_native_size() @@ -109084,27 +109539,30 @@ struct sockaddr glib:get-type="g_socket_address_enumerator_get_type" glib:type-struct="SocketAddressEnumeratorClass"> #GSocketAddressEnumerator is an enumerator type for #GSocketAddress -instances. It is returned by enumeration functions such as -g_socket_connectable_enumerate(), which returns a #GSocketAddressEnumerator -to list each #GSocketAddress which could be used to connect to that -#GSocketConnectable. + filename="gio/gsocketaddressenumerator.c" + line="27">`GSocketAddressEnumerator` is an enumerator type for +[class@Gio.SocketAddress] instances. It is returned by enumeration functions +such as [method@Gio.SocketConnectable.enumerate], which returns a +`GSocketAddressEnumerator` to list each [class@Gio.SocketAddress] which could +be used to connect to that [iface@Gio.SocketConnectable]. Enumeration is typically a blocking operation, so the asynchronous methods -g_socket_address_enumerator_next_async() and -g_socket_address_enumerator_next_finish() should be used where possible. +[method@Gio.SocketAddressEnumerator.next_async] and +[method@Gio.SocketAddressEnumerator.next_finish] should be used where +possible. -Each #GSocketAddressEnumerator can only be enumerated once. Once -g_socket_address_enumerator_next() has returned %NULL, further -enumeration with that #GSocketAddressEnumerator is not possible, and it can +Each `GSocketAddressEnumerator` can only be enumerated once. Once +[method@Gio.SocketAddressEnumerator.next] has returned `NULL`, further +enumeration with that `GSocketAddressEnumerator` is not possible, and it can be unreffed. - - - Retrieves the next #GSocketAddress from @enumerator. Note that this + + + Retrieves the next #GSocketAddress from @enumerator. Note that this may block for some amount of time. (Eg, a #GNetworkAddress may need to do a DNS lookup before it can return an address.) Use g_socket_address_enumerator_next_async() if you need to avoid @@ -109117,12 +109575,11 @@ in *@error. However, if the first call to g_socket_address_enumerator_next() succeeds, then any further internal errors (other than @cancellable being triggered) will be ignored. - + a #GSocketAddress (owned by the caller), or %NULL on + filename="gio/gsocketaddressenumerator.c" + line="89">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -109130,8 +109587,8 @@ ignored. a #GSocketAddressEnumerator + filename="gio/gsocketaddressenumerator.c" + line="71">a #GSocketAddressEnumerator @@ -109140,30 +109597,32 @@ ignored. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gsocketaddressenumerator.c" + line="72">optional #GCancellable object, %NULL to ignore. - + Asynchronously retrieves the next #GSocketAddress from @enumerator + filename="gio/gsocketaddressenumerator.c" + line="133">Asynchronously retrieves the next #GSocketAddress from @enumerator and then calls @callback, which must call g_socket_address_enumerator_next_finish() to get the result. It is an error to call this multiple times before the previous callback has finished. - + a #GSocketAddressEnumerator + filename="gio/gsocketaddressenumerator.c" + line="135">a #GSocketAddressEnumerator @@ -109172,8 +109631,8 @@ It is an error to call this multiple times before the previous callback has fini nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gsocketaddressenumerator.c" + line="136">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the request - is satisfied + filename="gio/gsocketaddressenumerator.c" + line="137">a #GAsyncReadyCallback to call + when the request is satisfied the data to pass to callback function + filename="gio/gsocketaddressenumerator.c" + line="139">the data to pass to callback function Retrieves the result of a completed call to + filename="gio/gsocketaddressenumerator.c" + line="172">Retrieves the result of a completed call to g_socket_address_enumerator_next_async(). See g_socket_address_enumerator_next() for more information about error handling. - + a #GSocketAddress (owned by the caller), or %NULL on + filename="gio/gsocketaddressenumerator.c" + line="183">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -109220,25 +109678,26 @@ error handling. a #GSocketAddressEnumerator + filename="gio/gsocketaddressenumerator.c" + line="174">a #GSocketAddressEnumerator a #GAsyncResult + filename="gio/gsocketaddressenumerator.c" + line="175">a #GAsyncResult + throws="1" + glib:async-func="next_async"> Retrieves the next #GSocketAddress from @enumerator. Note that this + filename="gio/gsocketaddressenumerator.c" + line="69">Retrieves the next #GSocketAddress from @enumerator. Note that this may block for some amount of time. (Eg, a #GNetworkAddress may need to do a DNS lookup before it can return an address.) Use g_socket_address_enumerator_next_async() if you need to avoid @@ -109251,12 +109710,11 @@ in *@error. However, if the first call to g_socket_address_enumerator_next() succeeds, then any further internal errors (other than @cancellable being triggered) will be ignored. - + a #GSocketAddress (owned by the caller), or %NULL on + filename="gio/gsocketaddressenumerator.c" + line="89">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -109264,8 +109722,8 @@ ignored. a #GSocketAddressEnumerator + filename="gio/gsocketaddressenumerator.c" + line="71">a #GSocketAddressEnumerator @@ -109274,31 +109732,32 @@ ignored. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gsocketaddressenumerator.c" + line="72">optional #GCancellable object, %NULL to ignore. + c:identifier="g_socket_address_enumerator_next_async" + glib:finish-func="next_finish" + glib:sync-func="next"> Asynchronously retrieves the next #GSocketAddress from @enumerator + filename="gio/gsocketaddressenumerator.c" + line="133">Asynchronously retrieves the next #GSocketAddress from @enumerator and then calls @callback, which must call g_socket_address_enumerator_next_finish() to get the result. It is an error to call this multiple times before the previous callback has finished. - + a #GSocketAddressEnumerator + filename="gio/gsocketaddressenumerator.c" + line="135">a #GSocketAddressEnumerator @@ -109307,8 +109766,8 @@ It is an error to call this multiple times before the previous callback has fini nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gsocketaddressenumerator.c" + line="136">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the request - is satisfied + filename="gio/gsocketaddressenumerator.c" + line="137">a #GAsyncReadyCallback to call + when the request is satisfied the data to pass to callback function + filename="gio/gsocketaddressenumerator.c" + line="139">the data to pass to callback function @@ -109338,17 +109797,16 @@ It is an error to call this multiple times before the previous callback has fini c:identifier="g_socket_address_enumerator_next_finish" throws="1"> Retrieves the result of a completed call to + filename="gio/gsocketaddressenumerator.c" + line="172">Retrieves the result of a completed call to g_socket_address_enumerator_next_async(). See g_socket_address_enumerator_next() for more information about error handling. - + a #GSocketAddress (owned by the caller), or %NULL on + filename="gio/gsocketaddressenumerator.c" + line="183">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -109356,15 +109814,15 @@ error handling. a #GSocketAddressEnumerator + filename="gio/gsocketaddressenumerator.c" + line="174">a #GSocketAddressEnumerator a #GAsyncResult + filename="gio/gsocketaddressenumerator.c" + line="175">a #GAsyncResult @@ -109377,21 +109835,23 @@ error handling. c:type="GSocketAddressEnumeratorClass" glib:is-gtype-struct-for="SocketAddressEnumerator"> Class structure for #GSocketAddressEnumerator. - + filename="gio/gsocketaddressenumerator.h" + line="47">Class structure for #GSocketAddressEnumerator. + + Virtual method for g_socket_address_enumerator_next(). - + a #GSocketAddress (owned by the caller), or %NULL on + filename="gio/gsocketaddressenumerator.c" + line="89">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -109399,8 +109859,8 @@ error handling. a #GSocketAddressEnumerator + filename="gio/gsocketaddressenumerator.c" + line="71">a #GSocketAddressEnumerator @@ -109409,25 +109869,28 @@ error handling. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gsocketaddressenumerator.c" + line="72">optional #GCancellable object, %NULL to ignore. + Virtual method for g_socket_address_enumerator_next_async(). - + a #GSocketAddressEnumerator + filename="gio/gsocketaddressenumerator.c" + line="135">a #GSocketAddressEnumerator @@ -109436,8 +109899,8 @@ error handling. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gsocketaddressenumerator.c" + line="136">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback to call when the request - is satisfied + filename="gio/gsocketaddressenumerator.c" + line="137">a #GAsyncReadyCallback to call + when the request is satisfied allow-none="1" closure="3"> the data to pass to callback function + filename="gio/gsocketaddressenumerator.c" + line="139">the data to pass to callback function + Virtual method for g_socket_address_enumerator_next_finish(). - + a #GSocketAddress (owned by the caller), or %NULL on + filename="gio/gsocketaddressenumerator.c" + line="183">a #GSocketAddress (owned by the caller), or %NULL on error (in which case *@error will be set) or if there are no more addresses. @@ -109480,15 +109946,15 @@ error handling. a #GSocketAddressEnumerator + filename="gio/gsocketaddressenumerator.c" + line="174">a #GSocketAddressEnumerator a #GAsyncResult + filename="gio/gsocketaddressenumerator.c" + line="175">a #GAsyncResult @@ -109498,15 +109964,13 @@ error handling. - + - + @@ -109514,8 +109978,7 @@ error handling. - + @@ -109523,8 +109986,7 @@ error handling. - + @@ -109532,8 +109994,7 @@ error handling. - + @@ -109541,8 +110002,7 @@ error handling. - + @@ -109550,8 +110010,7 @@ error handling. - + @@ -109559,8 +110018,7 @@ error handling. - + @@ -109568,8 +110026,7 @@ error handling. - + @@ -109577,8 +110034,7 @@ error handling. - + @@ -109586,8 +110042,7 @@ error handling. - + @@ -109603,41 +110058,38 @@ error handling. glib:get-type="g_socket_client_get_type" glib:type-struct="SocketClientClass"> #GSocketClient is a lightweight high-level utility class for connecting to + filename="gio/gsocketclient.c" + line="68">`GSocketClient` is a lightweight high-level utility class for connecting to a network host using a connection oriented socket type. -You create a #GSocketClient object, set any options you want, and then -call a sync or async connect operation, which returns a #GSocketConnection -subclass on success. +You create a `GSocketClient` object, set any options you want, and then +call a sync or async connect operation, which returns a +[class@Gio.SocketConnection] subclass on success. -The type of the #GSocketConnection object returned depends on the type of -the underlying socket that is in use. For instance, for a TCP/IP connection -it will be a #GTcpConnection. +The type of the [class@Gio.SocketConnection] object returned depends on the +type of the underlying socket that is in use. For instance, for a TCP/IP +connection it will be a [class@Gio.TcpConnection]. -As #GSocketClient is a lightweight object, you don't need to cache it. You +As `GSocketClient` is a lightweight object, you don't need to cache it. You can just create a new one any time you need one. - + Creates a new #GSocketClient with the default options. - + filename="gio/gsocketclient.c" + line="225">Creates a new #GSocketClient with the default options. + a #GSocketClient. + filename="gio/gsocketclient.c" + line="230">a #GSocketClient. Free the returned object with g_object_unref(). - + @@ -109659,8 +110111,8 @@ can just create a new one any time you need one. Enable proxy protocols to be handled by the application. When the + filename="gio/gsocketclient.c" + line="2435">Enable proxy protocols to be handled by the application. When the indicated proxy protocol is returned by the #GProxyResolver, #GSocketClient will consider this protocol as supported but will not try to find a #GProxy instance to handle handshaking. The @@ -109679,22 +110131,21 @@ be use as generic socket proxy through the HTTP CONNECT method. When the proxy is detected as being an application proxy, TLS handshake will be skipped. This is required to let the application do the proxy specific handshake. - + a #GSocketClient + filename="gio/gsocketclient.c" + line="2437">a #GSocketClient The proxy protocol + filename="gio/gsocketclient.c" + line="2438">The proxy protocol @@ -109702,10 +110153,11 @@ specific handshake. + throws="1" + glib:async-func="connect_async"> Tries to resolve the @connectable and make a network connection to it. + filename="gio/gsocketclient.c" + line="1094">Tries to resolve the @connectable and make a network connection to it. Upon a successful connection, a new #GSocketConnection is constructed and returned. The caller owns this new object and must drop their @@ -109723,25 +110175,24 @@ g_socket_client_set_socket_type(). If a local address is specified with g_socket_client_set_local_address() the socket will be bound to this address before connecting. - + a #GSocketConnection on success, %NULL on error. + filename="gio/gsocketclient.c" + line="1120">a #GSocketConnection on success, %NULL on error. a #GSocketClient. + filename="gio/gsocketclient.c" + line="1096">a #GSocketClient. a #GSocketConnectable specifying the remote address. + filename="gio/gsocketclient.c" + line="1097">a #GSocketConnectable specifying the remote address. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gsocketclient.c" + line="1098">optional #GCancellable object, %NULL to ignore. + version="2.22" + glib:finish-func="connect_finish" + glib:sync-func="connect"> This is the asynchronous version of g_socket_client_connect(). + filename="gio/gsocketclient.c" + line="2117">This is the asynchronous version of g_socket_client_connect(). You may wish to prefer the asynchronous version even in synchronous command line programs because, since 2.60, it implements @@ -109774,22 +110227,21 @@ the future.) When the operation is finished @callback will be called. You can then call g_socket_client_connect_finish() to get the result of the operation. - + a #GSocketClient + filename="gio/gsocketclient.c" + line="2119">a #GSocketClient a #GSocketConnectable specifying the remote address. + filename="gio/gsocketclient.c" + line="2120">a #GSocketConnectable specifying the remote address. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsocketclient.c" + line="2121">a #GCancellable, or %NULL scope="async" closure="3"> a #GAsyncReadyCallback + filename="gio/gsocketclient.c" + line="2122">a #GAsyncReadyCallback nullable="1" allow-none="1"> user data for the callback + filename="gio/gsocketclient.c" + line="2123">user data for the callback @@ -109828,27 +110280,26 @@ the result of the operation. version="2.22" throws="1"> Finishes an async connect operation. See g_socket_client_connect_async() - + filename="gio/gsocketclient.c" + line="2349">Finishes an async connect operation. See g_socket_client_connect_async() + a #GSocketConnection on success, %NULL on error. + filename="gio/gsocketclient.c" + line="2358">a #GSocketConnection on success, %NULL on error. a #GSocketClient. + filename="gio/gsocketclient.c" + line="2351">a #GSocketClient. a #GAsyncResult. + filename="gio/gsocketclient.c" + line="2352">a #GAsyncResult. @@ -109856,10 +110307,11 @@ the result of the operation. + throws="1" + glib:async-func="connect_to_host_async"> This is a helper function for g_socket_client_connect(). + filename="gio/gsocketclient.c" + line="1329">This is a helper function for g_socket_client_connect(). Attempts to create a TCP connection to the named host. @@ -109889,31 +110341,30 @@ reference to it when finished with it. In the event of any failure (DNS error, service not found, no hosts connectable) %NULL is returned and @error (if non-%NULL) is set accordingly. - + a #GSocketConnection on success, %NULL on error. + filename="gio/gsocketclient.c" + line="1368">a #GSocketConnection on success, %NULL on error. a #GSocketClient + filename="gio/gsocketclient.c" + line="1331">a #GSocketClient the name and optionally port of the host to connect to + filename="gio/gsocketclient.c" + line="1332">the name and optionally port of the host to connect to the default port to connect to + filename="gio/gsocketclient.c" + line="1333">the default port to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsocketclient.c" + line="1334">a #GCancellable, or %NULL + version="2.22" + glib:finish-func="connect_to_host_finish" + glib:sync-func="connect_to_host"> This is the asynchronous version of g_socket_client_connect_to_host(). + filename="gio/gsocketclient.c" + line="2225">This is the asynchronous version of g_socket_client_connect_to_host(). When the operation is finished @callback will be called. You can then call g_socket_client_connect_to_host_finish() to get the result of the operation. - + a #GSocketClient + filename="gio/gsocketclient.c" + line="2227">a #GSocketClient the name and optionally the port of the host to connect to + filename="gio/gsocketclient.c" + line="2228">the name and optionally the port of the host to connect to the default port to connect to + filename="gio/gsocketclient.c" + line="2229">the default port to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsocketclient.c" + line="2230">a #GCancellable, or %NULL scope="async" closure="4"> a #GAsyncReadyCallback + filename="gio/gsocketclient.c" + line="2231">a #GAsyncReadyCallback nullable="1" allow-none="1"> user data for the callback + filename="gio/gsocketclient.c" + line="2232">user data for the callback @@ -109997,37 +110449,37 @@ the result of the operation. version="2.22" throws="1"> Finishes an async connect operation. See g_socket_client_connect_to_host_async() - + filename="gio/gsocketclient.c" + line="2372">Finishes an async connect operation. See g_socket_client_connect_to_host_async() + a #GSocketConnection on success, %NULL on error. + filename="gio/gsocketclient.c" + line="2381">a #GSocketConnection on success, %NULL on error. a #GSocketClient. + filename="gio/gsocketclient.c" + line="2374">a #GSocketClient. a #GAsyncResult. + filename="gio/gsocketclient.c" + line="2375">a #GAsyncResult. + throws="1" + glib:async-func="connect_to_service_async"> Attempts to create a TCP connection to a service. + filename="gio/gsocketclient.c" + line="1393">Attempts to create a TCP connection to a service. This call looks up the SRV record for @service at @domain for the "tcp" protocol. It then attempts to connect, in turn, to each of @@ -110041,31 +110493,30 @@ reference to it when finished with it. In the event of any failure (DNS error, service not found, no hosts connectable) %NULL is returned and @error (if non-%NULL) is set accordingly. - + a #GSocketConnection if successful, or %NULL on error + filename="gio/gsocketclient.c" + line="1416">a #GSocketConnection if successful, or %NULL on error a #GSocketConnection + filename="gio/gsocketclient.c" + line="1395">a #GSocketConnection a domain name + filename="gio/gsocketclient.c" + line="1396">a domain name the name of the service to connect to + filename="gio/gsocketclient.c" + line="1397">the name of the service to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsocketclient.c" + line="1398">a #GCancellable, or %NULL + version="2.22" + glib:finish-func="connect_to_service_finish" + glib:sync-func="connect_to_service"> This is the asynchronous version of + filename="gio/gsocketclient.c" + line="2271">This is the asynchronous version of g_socket_client_connect_to_service(). - + a #GSocketClient + filename="gio/gsocketclient.c" + line="2273">a #GSocketClient a domain name + filename="gio/gsocketclient.c" + line="2274">a domain name the name of the service to connect to + filename="gio/gsocketclient.c" + line="2275">the name of the service to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsocketclient.c" + line="2276">a #GCancellable, or %NULL scope="async" closure="4"> a #GAsyncReadyCallback + filename="gio/gsocketclient.c" + line="2277">a #GAsyncReadyCallback nullable="1" allow-none="1"> user data for the callback + filename="gio/gsocketclient.c" + line="2278">user data for the callback @@ -110146,27 +110598,26 @@ g_socket_client_connect_to_service(). version="2.22" throws="1"> Finishes an async connect operation. See g_socket_client_connect_to_service_async() - + filename="gio/gsocketclient.c" + line="2393">Finishes an async connect operation. See g_socket_client_connect_to_service_async() + a #GSocketConnection on success, %NULL on error. + filename="gio/gsocketclient.c" + line="2402">a #GSocketConnection on success, %NULL on error. a #GSocketClient. + filename="gio/gsocketclient.c" + line="2395">a #GSocketClient. a #GAsyncResult. + filename="gio/gsocketclient.c" + line="2396">a #GAsyncResult. @@ -110174,10 +110625,11 @@ g_socket_client_connect_to_service(). + throws="1" + glib:async-func="connect_to_uri_async"> This is a helper function for g_socket_client_connect(). + filename="gio/gsocketclient.c" + line="1436">This is a helper function for g_socket_client_connect(). Attempts to create a TCP connection with a network URI. @@ -110198,31 +110650,30 @@ reference to it when finished with it. In the event of any failure (DNS error, service not found, no hosts connectable) %NULL is returned and @error (if non-%NULL) is set accordingly. - + a #GSocketConnection on success, %NULL on error. + filename="gio/gsocketclient.c" + line="1466">a #GSocketConnection on success, %NULL on error. a #GSocketClient + filename="gio/gsocketclient.c" + line="1438">a #GSocketClient A network URI + filename="gio/gsocketclient.c" + line="1439">A network URI the default port to connect to + filename="gio/gsocketclient.c" + line="1440">the default port to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsocketclient.c" + line="1441">a #GCancellable, or %NULL + version="2.26" + glib:finish-func="connect_to_uri_finish" + glib:sync-func="connect_to_uri"> This is the asynchronous version of g_socket_client_connect_to_uri(). + filename="gio/gsocketclient.c" + line="2302">This is the asynchronous version of g_socket_client_connect_to_uri(). When the operation is finished @callback will be called. You can then call g_socket_client_connect_to_uri_finish() to get the result of the operation. - + a #GSocketClient + filename="gio/gsocketclient.c" + line="2304">a #GSocketClient a network uri + filename="gio/gsocketclient.c" + line="2305">a network uri the default port to connect to + filename="gio/gsocketclient.c" + line="2306">the default port to connect to nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsocketclient.c" + line="2307">a #GCancellable, or %NULL scope="async" closure="4"> a #GAsyncReadyCallback + filename="gio/gsocketclient.c" + line="2308">a #GAsyncReadyCallback nullable="1" allow-none="1"> user data for the callback + filename="gio/gsocketclient.c" + line="2309">user data for the callback @@ -110306,27 +110758,26 @@ the result of the operation. version="2.26" throws="1"> Finishes an async connect operation. See g_socket_client_connect_to_uri_async() - + filename="gio/gsocketclient.c" + line="2414">Finishes an async connect operation. See g_socket_client_connect_to_uri_async() + a #GSocketConnection on success, %NULL on error. + filename="gio/gsocketclient.c" + line="2423">a #GSocketConnection on success, %NULL on error. a #GSocketClient. + filename="gio/gsocketclient.c" + line="2416">a #GSocketClient. a #GAsyncResult. + filename="gio/gsocketclient.c" + line="2417">a #GAsyncResult. @@ -110336,21 +110787,20 @@ the result of the operation. glib:get-property="enable-proxy" version="2.26"> Gets the proxy enable state; see g_socket_client_set_enable_proxy() - + filename="gio/gsocketclient.c" + line="583">Gets the proxy enable state; see g_socket_client_set_enable_proxy() + whether proxying is enabled + filename="gio/gsocketclient.c" + line="589">whether proxying is enabled a #GSocketClient. + filename="gio/gsocketclient.c" + line="585">a #GSocketClient. @@ -110360,23 +110810,22 @@ the result of the operation. glib:get-property="family" version="2.22"> Gets the socket family of the socket client. + filename="gio/gsocketclient.c" + line="360">Gets the socket family of the socket client. See g_socket_client_set_family() for details. - + a #GSocketFamily + filename="gio/gsocketclient.c" + line="368">a #GSocketFamily a #GSocketClient. + filename="gio/gsocketclient.c" + line="362">a #GSocketClient. @@ -110386,23 +110835,22 @@ See g_socket_client_set_family() for details. glib:get-property="local-address" version="2.22"> Gets the local address of the socket client. + filename="gio/gsocketclient.c" + line="491">Gets the local address of the socket client. See g_socket_client_set_local_address() for details. - + a #GSocketAddress or %NULL. Do not free. + filename="gio/gsocketclient.c" + line="499">a #GSocketAddress or %NULL. Do not free. a #GSocketClient. + filename="gio/gsocketclient.c" + line="493">a #GSocketClient. @@ -110412,23 +110860,22 @@ See g_socket_client_set_local_address() for details. glib:get-property="protocol" version="2.22"> Gets the protocol name type of the socket client. + filename="gio/gsocketclient.c" + line="448">Gets the protocol name type of the socket client. See g_socket_client_set_protocol() for details. - + a #GSocketProtocol + filename="gio/gsocketclient.c" + line="456">a #GSocketProtocol a #GSocketClient + filename="gio/gsocketclient.c" + line="450">a #GSocketClient @@ -110438,24 +110885,23 @@ See g_socket_client_set_protocol() for details. glib:get-property="proxy-resolver" version="2.36"> Gets the #GProxyResolver being used by @client. Normally, this will + filename="gio/gsocketclient.c" + line="730">Gets the #GProxyResolver being used by @client. Normally, this will be the resolver returned by g_proxy_resolver_get_default(), but you can override it with g_socket_client_set_proxy_resolver(). - + The #GProxyResolver being used by + filename="gio/gsocketclient.c" + line="738">The #GProxyResolver being used by @client. a #GSocketClient. + filename="gio/gsocketclient.c" + line="732">a #GSocketClient. @@ -110464,23 +110910,22 @@ can override it with g_socket_client_set_proxy_resolver(). c:identifier="g_socket_client_get_socket_type" version="2.22"> Gets the socket type of the socket client. + filename="gio/gsocketclient.c" + line="405">Gets the socket type of the socket client. See g_socket_client_set_socket_type() for details. - + a #GSocketFamily + filename="gio/gsocketclient.c" + line="413">a #GSocketFamily a #GSocketClient. + filename="gio/gsocketclient.c" + line="407">a #GSocketClient. @@ -110490,23 +110935,22 @@ See g_socket_client_set_socket_type() for details. glib:get-property="timeout" version="2.26"> Gets the I/O timeout time for sockets created by @client. + filename="gio/gsocketclient.c" + line="539">Gets the I/O timeout time for sockets created by @client. See g_socket_client_set_timeout() for details. - + the timeout in seconds + filename="gio/gsocketclient.c" + line="547">the timeout in seconds a #GSocketClient + filename="gio/gsocketclient.c" + line="541">a #GSocketClient @@ -110516,22 +110960,21 @@ See g_socket_client_set_timeout() for details. glib:get-property="tls" version="2.28"> Gets whether @client creates TLS connections. See + filename="gio/gsocketclient.c" + line="625">Gets whether @client creates TLS connections. See g_socket_client_set_tls() for details. - + whether @client uses TLS + filename="gio/gsocketclient.c" + line="632">whether @client uses TLS a #GSocketClient. + filename="gio/gsocketclient.c" + line="627">a #GSocketClient. @@ -110543,27 +110986,26 @@ g_socket_client_set_tls() for details. deprecated="1" deprecated-version="2.72"> Gets the TLS validation flags used creating TLS connections via + filename="gio/gsocketclient.c" + line="680">Gets the TLS validation flags used creating TLS connections via @client. This function does not work as originally designed and is impossible to use correctly. See #GSocketClient:tls-validation-flags for more information. Do not attempt to ignore validation errors. - + the TLS validation flags + filename="gio/gsocketclient.c" + line="691">the TLS validation flags a #GSocketClient. + filename="gio/gsocketclient.c" + line="682">a #GSocketClient. @@ -110573,29 +111015,28 @@ information. glib:set-property="enable-proxy" version="2.26"> Sets whether or not @client attempts to make connections via a + filename="gio/gsocketclient.c" + line="599">Sets whether or not @client attempts to make connections via a proxy server. When enabled (the default), #GSocketClient will use a #GProxyResolver to determine if a proxy protocol such as SOCKS is needed, and automatically do the necessary proxy negotiation. See also g_socket_client_set_proxy_resolver(). - + a #GSocketClient. + filename="gio/gsocketclient.c" + line="601">a #GSocketClient. whether to enable proxies + filename="gio/gsocketclient.c" + line="602">whether to enable proxies @@ -110605,8 +111046,8 @@ See also g_socket_client_set_proxy_resolver(). glib:set-property="family" version="2.22"> Sets the socket family of the socket client. + filename="gio/gsocketclient.c" + line="378">Sets the socket family of the socket client. If this is set to something other than %G_SOCKET_FAMILY_INVALID then the sockets created by this object will be of the specified family. @@ -110614,22 +111055,21 @@ family. This might be useful for instance if you want to force the local connection to be an ipv4 socket, even though the address might be an ipv6 mapped to ipv4 address. - + a #GSocketClient. + filename="gio/gsocketclient.c" + line="380">a #GSocketClient. a #GSocketFamily + filename="gio/gsocketclient.c" + line="381">a #GSocketFamily @@ -110639,24 +111079,23 @@ be an ipv6 mapped to ipv4 address. glib:set-property="local-address" version="2.22"> Sets the local address of the socket client. + filename="gio/gsocketclient.c" + line="509">Sets the local address of the socket client. The sockets created by this object will bound to the specified address (if not %NULL) before connecting. This is useful if you want to ensure that the local side of the connection is on a specific port, or on a specific interface. - + a #GSocketClient. + filename="gio/gsocketclient.c" + line="511">a #GSocketClient. nullable="1" allow-none="1"> a #GSocketAddress, or %NULL + filename="gio/gsocketclient.c" + line="512">a #GSocketAddress, or %NULL @@ -110675,29 +111114,28 @@ a specific interface. glib:set-property="protocol" version="2.22"> Sets the protocol of the socket client. + filename="gio/gsocketclient.c" + line="466">Sets the protocol of the socket client. The sockets created by this object will use of the specified protocol. If @protocol is %G_SOCKET_PROTOCOL_DEFAULT that means to use the default protocol for the socket family and type. - + a #GSocketClient. + filename="gio/gsocketclient.c" + line="468">a #GSocketClient. a #GSocketProtocol + filename="gio/gsocketclient.c" + line="469">a #GSocketProtocol @@ -110707,24 +111145,23 @@ protocol for the socket family and type. glib:set-property="proxy-resolver" version="2.36"> Overrides the #GProxyResolver used by @client. You can call this if + filename="gio/gsocketclient.c" + line="752">Overrides the #GProxyResolver used by @client. You can call this if you want to use specific proxies, rather than using the system default proxy settings. Note that whether or not the proxy resolver is actually used depends on the setting of #GSocketClient:enable-proxy, which is not changed by this function (but which is %TRUE by default) - + a #GSocketClient. + filename="gio/gsocketclient.c" + line="754">a #GSocketClient. nullable="1" allow-none="1"> a #GProxyResolver, or %NULL for the + filename="gio/gsocketclient.c" + line="755">a #GProxyResolver, or %NULL for the default. @@ -110743,29 +111180,28 @@ changed by this function (but which is %TRUE by default) c:identifier="g_socket_client_set_socket_type" version="2.22"> Sets the socket type of the socket client. + filename="gio/gsocketclient.c" + line="423">Sets the socket type of the socket client. The sockets created by this object will be of the specified type. It doesn't make sense to specify a type of %G_SOCKET_TYPE_DATAGRAM, as GSocketClient is used for connection oriented services. - + a #GSocketClient. + filename="gio/gsocketclient.c" + line="425">a #GSocketClient. a #GSocketType + filename="gio/gsocketclient.c" + line="426">a #GSocketType @@ -110775,29 +111211,28 @@ as GSocketClient is used for connection oriented services. glib:set-property="timeout" version="2.26"> Sets the I/O timeout for sockets created by @client. @timeout is a + filename="gio/gsocketclient.c" + line="558">Sets the I/O timeout for sockets created by @client. @timeout is a time in seconds, or 0 for no timeout (the default). The timeout value affects the initial connection attempt as well, so setting this may cause calls to g_socket_client_connect(), etc, to fail with %G_IO_ERROR_TIMED_OUT. - + a #GSocketClient. + filename="gio/gsocketclient.c" + line="560">a #GSocketClient. the timeout + filename="gio/gsocketclient.c" + line="561">the timeout @@ -110807,8 +111242,8 @@ to fail with %G_IO_ERROR_TIMED_OUT. glib:set-property="tls" version="2.28"> Sets whether @client creates TLS (aka SSL) connections. If @tls is + filename="gio/gsocketclient.c" + line="642">Sets whether @client creates TLS (aka SSL) connections. If @tls is %TRUE, @client will wrap its connections in a #GTlsClientConnection and perform a TLS handshake when connecting. @@ -110826,22 +111261,21 @@ setting a client-side certificate to use, or connecting to the emitted with %G_SOCKET_CLIENT_TLS_HANDSHAKING, which will give you a chance to see the #GTlsClientConnection before the handshake starts. - + a #GSocketClient. + filename="gio/gsocketclient.c" + line="644">a #GSocketClient. whether to use TLS + filename="gio/gsocketclient.c" + line="645">whether to use TLS @@ -110853,67 +111287,82 @@ starts. deprecated="1" deprecated-version="2.72"> Sets the TLS validation flags used when creating TLS connections + filename="gio/gsocketclient.c" + line="703">Sets the TLS validation flags used when creating TLS connections via @client. The default value is %G_TLS_CERTIFICATE_VALIDATE_ALL. This function does not work as originally designed and is impossible to use correctly. See #GSocketClient:tls-validation-flags for more information. Do not attempt to ignore validation errors. - + a #GSocketClient. + filename="gio/gsocketclient.c" + line="705">a #GSocketClient. the validation flags + filename="gio/gsocketclient.c" + line="706">the validation flags + Enable proxy support. + The address family to use for socket construction. + The local address constructed sockets will be bound to. + The protocol to use for socket construction, or `0` for default. setter="set_proxy_resolver" getter="get_proxy_resolver"> The proxy resolver to use + filename="gio/gsocketclient.c" + line="1003">The proxy resolver to use + The I/O timeout for sockets, in seconds, or `0` for none. + Whether to create TLS connections. getter="get_tls_validation_flags" default-value="G_TLS_CERTIFICATE_UNKNOWN_CA | G_TLS_CERTIFICATE_BAD_IDENTITY | G_TLS_CERTIFICATE_NOT_ACTIVATED | G_TLS_CERTIFICATE_EXPIRED | G_TLS_CERTIFICATE_REVOKED | G_TLS_CERTIFICATE_INSECURE | G_TLS_CERTIFICATE_GENERIC_ERROR"> The TLS validation flags used when creating TLS connections. The + filename="gio/gsocketclient.c" + line="972">The TLS validation flags used when creating TLS connections. The default value is %G_TLS_CERTIFICATE_VALIDATE_ALL. GLib guarantees that if certificate verification fails, at least one @@ -110977,10 +111434,14 @@ connect to #GTlsConnection::accept-certificate. + The type to use for socket construction. @@ -110991,8 +111452,8 @@ connect to #GTlsConnection::accept-certificate. Emitted when @client's activity on @connectable changes state. + filename="gio/gsocketclient.c" + line="797">Emitted when @client's activity on @connectable changes state. Among other things, this can be used to provide progress information about a network connection in the UI. The meanings of the different @event values are as follows: @@ -111047,14 +111508,14 @@ the future; unrecognized @event values should be ignored. the event that is occurring + filename="gio/gsocketclient.c" + line="800">the event that is occurring the #GSocketConnectable that @event is occurring on + filename="gio/gsocketclient.c" + line="801">the #GSocketConnectable that @event is occurring on nullable="1" allow-none="1"> the current representation of the connection + filename="gio/gsocketclient.c" + line="802">the current representation of the connection @@ -111072,15 +111533,13 @@ the future; unrecognized @event values should be ignored. - + - + @@ -111102,8 +111561,7 @@ the future; unrecognized @event values should be ignored. - + @@ -111111,8 +111569,7 @@ the future; unrecognized @event values should be ignored. - + @@ -111120,8 +111577,7 @@ the future; unrecognized @event values should be ignored. - + @@ -111129,8 +111585,7 @@ the future; unrecognized @event values should be ignored. - + @@ -111143,8 +111598,8 @@ the future; unrecognized @event values should be ignored. glib:get-type="g_socket_client_event_get_type" c:type="GSocketClientEvent"> Describes an event occurring on a #GSocketClient. See the + filename="gio/gioenums.h" + line="1922">Describes an event occurring on a #GSocketClient. See the #GSocketClient::event signal for more details. Additional values may be added to this type in the future. @@ -111154,8 +111609,8 @@ Additional values may be added to this type in the future. glib:nick="resolving" glib:name="G_SOCKET_CLIENT_RESOLVING"> The client is doing a DNS lookup. + filename="gio/gioenums.h" + line="1924">The client is doing a DNS lookup. glib:nick="resolved" glib:name="G_SOCKET_CLIENT_RESOLVED"> The client has completed a DNS lookup. + filename="gio/gioenums.h" + line="1925">The client has completed a DNS lookup. glib:nick="connecting" glib:name="G_SOCKET_CLIENT_CONNECTING"> The client is connecting to a remote + filename="gio/gioenums.h" + line="1926">The client is connecting to a remote host (either a proxy or the destination server). glib:nick="connected" glib:name="G_SOCKET_CLIENT_CONNECTED"> The client has connected to a remote + filename="gio/gioenums.h" + line="1928">The client has connected to a remote host. glib:nick="proxy-negotiating" glib:name="G_SOCKET_CLIENT_PROXY_NEGOTIATING"> The client is negotiating + filename="gio/gioenums.h" + line="1930">The client is negotiating with a proxy to connect to the destination server. glib:nick="proxy-negotiated" glib:name="G_SOCKET_CLIENT_PROXY_NEGOTIATED"> The client has negotiated + filename="gio/gioenums.h" + line="1932">The client has negotiated with the proxy server. glib:nick="tls-handshaking" glib:name="G_SOCKET_CLIENT_TLS_HANDSHAKING"> The client is performing a + filename="gio/gioenums.h" + line="1934">The client is performing a TLS handshake. glib:nick="tls-handshaked" glib:name="G_SOCKET_CLIENT_TLS_HANDSHAKED"> The client has performed a + filename="gio/gioenums.h" + line="1936">The client has performed a TLS handshake. glib:nick="complete" glib:name="G_SOCKET_CLIENT_COMPLETE"> The client is done with a particular + filename="gio/gioenums.h" + line="1938">The client is done with a particular #GSocketConnectable. @@ -111241,8 +111696,7 @@ Additional values may be added to this type in the future. c:type="GSocketClientPrivate" disguised="1" opaque="1"> - + glib:get-type="g_socket_connectable_get_type" glib:type-struct="SocketConnectableIface"> Objects that describe one or more potential socket endpoints -implement #GSocketConnectable. Callers can then use -g_socket_connectable_enumerate() to get a #GSocketAddressEnumerator -to try out each socket address in turn until one succeeds, as shown -in the sample code below. + filename="gio/gsocketconnectable.c" + line="26">Objects that describe one or more potential socket endpoints +implement `GSocketConnectable`. Callers can then use +[method@Gio.SocketConnectable.enumerate] to get a +[class@Gio.SocketAddressEnumerator] to try out each socket address in turn +until one succeeds, as shown in the sample code below. -|[<!-- language="C" --> +```c MyConnectionType * connect_to_host (const char *hostname, guint16 port, @@ -111308,27 +111762,25 @@ connect_to_host (const char *hostname, return NULL; } } -]| - +``` + Creates a #GSocketAddressEnumerator for @connectable. - + filename="gio/gsocketconnectable.c" + line="97">Creates a #GSocketAddressEnumerator for @connectable. + a new #GSocketAddressEnumerator. + filename="gio/gsocketconnectable.c" + line="103">a new #GSocketAddressEnumerator. a #GSocketConnectable + filename="gio/gsocketconnectable.c" + line="99">a #GSocketConnectable @@ -111337,55 +111789,53 @@ connect_to_host (const char *hostname, invoker="proxy_enumerate" version="2.26"> Creates a #GSocketAddressEnumerator for @connectable that will + filename="gio/gsocketconnectable.c" + line="119">Creates a #GSocketAddressEnumerator for @connectable that will return a #GProxyAddress for each of its addresses that you must connect to via a proxy. If @connectable does not implement g_socket_connectable_proxy_enumerate(), this will fall back to calling g_socket_connectable_enumerate(). - + a new #GSocketAddressEnumerator. + filename="gio/gsocketconnectable.c" + line="131">a new #GSocketAddressEnumerator. a #GSocketConnectable + filename="gio/gsocketconnectable.c" + line="121">a #GSocketConnectable Format a #GSocketConnectable as a string. This is a human-readable format for + filename="gio/gsocketconnectable.c" + line="150">Format a #GSocketConnectable as a string. This is a human-readable format for use in debugging output, and is not a stable serialization format. It is not suitable for use in user interfaces as it exposes too much information for a user. If the #GSocketConnectable implementation does not support string formatting, the implementation’s type name will be returned as a fallback. - + the formatted string + filename="gio/gsocketconnectable.c" + line="162">the formatted string a #GSocketConnectable + filename="gio/gsocketconnectable.c" + line="152">a #GSocketConnectable @@ -111394,22 +111844,21 @@ the implementation’s type name will be returned as a fallback. c:identifier="g_socket_connectable_enumerate" version="2.22"> Creates a #GSocketAddressEnumerator for @connectable. - + filename="gio/gsocketconnectable.c" + line="97">Creates a #GSocketAddressEnumerator for @connectable. + a new #GSocketAddressEnumerator. + filename="gio/gsocketconnectable.c" + line="103">a new #GSocketAddressEnumerator. a #GSocketConnectable + filename="gio/gsocketconnectable.c" + line="99">a #GSocketConnectable @@ -111418,28 +111867,27 @@ the implementation’s type name will be returned as a fallback. c:identifier="g_socket_connectable_proxy_enumerate" version="2.26"> Creates a #GSocketAddressEnumerator for @connectable that will + filename="gio/gsocketconnectable.c" + line="119">Creates a #GSocketAddressEnumerator for @connectable that will return a #GProxyAddress for each of its addresses that you must connect to via a proxy. If @connectable does not implement g_socket_connectable_proxy_enumerate(), this will fall back to calling g_socket_connectable_enumerate(). - + a new #GSocketAddressEnumerator. + filename="gio/gsocketconnectable.c" + line="131">a new #GSocketAddressEnumerator. a #GSocketConnectable + filename="gio/gsocketconnectable.c" + line="121">a #GSocketConnectable @@ -111448,27 +111896,26 @@ calling g_socket_connectable_enumerate(). c:identifier="g_socket_connectable_to_string" version="2.48"> Format a #GSocketConnectable as a string. This is a human-readable format for + filename="gio/gsocketconnectable.c" + line="150">Format a #GSocketConnectable as a string. This is a human-readable format for use in debugging output, and is not a stable serialization format. It is not suitable for use in user interfaces as it exposes too much information for a user. If the #GSocketConnectable implementation does not support string formatting, the implementation’s type name will be returned as a fallback. - + the formatted string + filename="gio/gsocketconnectable.c" + line="162">the formatted string a #GSocketConnectable + filename="gio/gsocketconnectable.c" + line="152">a #GSocketConnectable @@ -111478,74 +111925,80 @@ the implementation’s type name will be returned as a fallback. c:type="GSocketConnectableIface" glib:is-gtype-struct-for="SocketConnectable"> Provides an interface for returning a #GSocketAddressEnumerator + filename="gio/gsocketconnectable.h" + line="39">Provides an interface for returning a #GSocketAddressEnumerator and #GProxyAddressEnumerator - + The parent interface. + filename="gio/gsocketconnectable.h" + line="41">The parent interface. + Creates a #GSocketAddressEnumerator - + a new #GSocketAddressEnumerator. + filename="gio/gsocketconnectable.c" + line="103">a new #GSocketAddressEnumerator. a #GSocketConnectable + filename="gio/gsocketconnectable.c" + line="99">a #GSocketConnectable + Creates a #GProxyAddressEnumerator - + a new #GSocketAddressEnumerator. + filename="gio/gsocketconnectable.c" + line="131">a new #GSocketAddressEnumerator. a #GSocketConnectable + filename="gio/gsocketconnectable.c" + line="121">a #GSocketConnectable + Format the connectable’s address as a string for debugging. + Implementing this is optional. (Since: 2.48) - + the formatted string + filename="gio/gsocketconnectable.c" + line="162">the formatted string a #GSocketConnectable + filename="gio/gsocketconnectable.c" + line="152">a #GSocketConnectable @@ -111561,59 +112014,57 @@ and #GProxyAddressEnumerator glib:get-type="g_socket_connection_get_type" glib:type-struct="SocketConnectionClass"> #GSocketConnection is a #GIOStream for a connected socket. They -can be created either by #GSocketClient when connecting to a host, -or by #GSocketListener when accepting a new client. + filename="gio/gsocketconnection.c" + line="42">`GSocketConnection` is a [class@Gio.IOStream] for a connected socket. They +can be created either by [class@Gio.SocketClient] when connecting to a host, +or by [class@Gio.SocketListener] when accepting a new client. -The type of the #GSocketConnection object returned from these calls +The type of the `GSocketConnection` object returned from these calls depends on the type of the underlying socket that is in use. For -instance, for a TCP/IP connection it will be a #GTcpConnection. +instance, for a TCP/IP connection it will be a [class@Gio.TcpConnection]. Choosing what type of object to construct is done with the socket -connection factory, and it is possible for 3rd parties to register +connection factory, and it is possible for third parties to register custom socket connection types for specific combination of socket -family/type/protocol using g_socket_connection_factory_register_type(). +family/type/protocol using [func@Gio.SocketConnection.factory_register_type]. -To close a #GSocketConnection, use g_io_stream_close(). Closing both -substreams of the #GIOStream separately will not close the underlying -#GSocket. - +To close a `GSocketConnection`, use [method@Gio.IOStream.close]. Closing both +substreams of the [class@Gio.IOStream] separately will not close the +underlying [class@Gio.Socket]. + Looks up the #GType to be used when creating socket connections on + filename="gio/gsocketconnection.c" + line="630">Looks up the #GType to be used when creating socket connections on sockets with the specified @family, @type and @protocol_id. If no type is registered, the #GSocketConnection base type is returned. - + a #GType + filename="gio/gsocketconnection.c" + line="641">a #GType a #GSocketFamily + filename="gio/gsocketconnection.c" + line="632">a #GSocketFamily a #GSocketType + filename="gio/gsocketconnection.c" + line="633">a #GSocketType a protocol id + filename="gio/gsocketconnection.c" + line="634">a protocol id @@ -111622,39 +112073,38 @@ If no type is registered, the #GSocketConnection base type is returned. c:identifier="g_socket_connection_factory_register_type" version="2.22"> Looks up the #GType to be used when creating socket connections on + filename="gio/gsocketconnection.c" + line="579">Looks up the #GType to be used when creating socket connections on sockets with the specified @family, @type and @protocol. If no type is registered, the #GSocketConnection base type is returned. - + a #GType, inheriting from %G_TYPE_SOCKET_CONNECTION + filename="gio/gsocketconnection.c" + line="581">a #GType, inheriting from %G_TYPE_SOCKET_CONNECTION a #GSocketFamily + filename="gio/gsocketconnection.c" + line="582">a #GSocketFamily a #GSocketType + filename="gio/gsocketconnection.c" + line="583">a #GSocketType a protocol id + filename="gio/gsocketconnection.c" + line="584">a protocol id @@ -111662,29 +112112,29 @@ If no type is registered, the #GSocketConnection base type is returned. + throws="1" + glib:async-func="connect_async"> Connect @connection to the specified remote address. - + filename="gio/gsocketconnection.c" + line="137">Connect @connection to the specified remote address. + %TRUE if the connection succeeded, %FALSE on error + filename="gio/gsocketconnection.c" + line="146">%TRUE if the connection succeeded, %FALSE on error a #GSocketConnection + filename="gio/gsocketconnection.c" + line="139">a #GSocketConnection a #GSocketAddress specifying the remote address. + filename="gio/gsocketconnection.c" + line="140">a #GSocketAddress specifying the remote address. nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocketconnection.c" + line="141">a %GCancellable or %NULL + version="2.32" + glib:finish-func="connect_finish" + glib:sync-func="connect"> Asynchronously connect @connection to the specified remote address. + filename="gio/gsocketconnection.c" + line="167">Asynchronously connect @connection to the specified remote address. This clears the #GSocket:blocking flag on @connection's underlying socket if it is currently set. +If #GSocket:timeout is set, the operation will time out and return +%G_IO_ERROR_TIMED_OUT after that period. Otherwise, it will continue +indefinitely until operating system timeouts (if any) are hit. + Use g_socket_connection_connect_finish() to retrieve the result. - + a #GSocketConnection + filename="gio/gsocketconnection.c" + line="169">a #GSocketConnection a #GSocketAddress specifying the remote address. + filename="gio/gsocketconnection.c" + line="170">a #GSocketAddress specifying the remote address. nullable="1" allow-none="1"> a %GCancellable or %NULL + filename="gio/gsocketconnection.c" + line="171">a %GCancellable or %NULL scope="async" closure="3"> a #GAsyncReadyCallback + filename="gio/gsocketconnection.c" + line="172">a #GAsyncReadyCallback nullable="1" allow-none="1"> user data for the callback + filename="gio/gsocketconnection.c" + line="173">user data for the callback @@ -111763,27 +112218,26 @@ Use g_socket_connection_connect_finish() to retrieve the result. version="2.32" throws="1"> Gets the result of a g_socket_connection_connect_async() call. - + filename="gio/gsocketconnection.c" + line="248">Gets the result of a g_socket_connection_connect_async() call. + %TRUE if the connection succeeded, %FALSE on error + filename="gio/gsocketconnection.c" + line="256">%TRUE if the connection succeeded, %FALSE on error a #GSocketConnection + filename="gio/gsocketconnection.c" + line="250">a #GSocketConnection the #GAsyncResult + filename="gio/gsocketconnection.c" + line="251">the #GAsyncResult @@ -111793,22 +112247,21 @@ Use g_socket_connection_connect_finish() to retrieve the result. version="2.22" throws="1"> Try to get the local address of a socket connection. - + filename="gio/gsocketconnection.c" + line="291">Try to get the local address of a socket connection. + a #GSocketAddress or %NULL on error. + filename="gio/gsocketconnection.c" + line="298">a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). a #GSocketConnection + filename="gio/gsocketconnection.c" + line="293">a #GSocketConnection @@ -111818,8 +112271,8 @@ Use g_socket_connection_connect_finish() to retrieve the result. version="2.22" throws="1"> Try to get the remote address of a socket connection. + filename="gio/gsocketconnection.c" + line="310">Try to get the remote address of a socket connection. Since GLib 2.40, when used with g_socket_client_connect() or g_socket_client_connect_async(), during emission of @@ -111827,20 +112280,19 @@ g_socket_client_connect_async(), during emission of address that will be used for the connection. This allows applications to print e.g. "Connecting to example.com (10.42.77.3)...". - + a #GSocketAddress or %NULL on error. + filename="gio/gsocketconnection.c" + line="324">a #GSocketAddress or %NULL on error. Free the returned object with g_object_unref(). a #GSocketConnection + filename="gio/gsocketconnection.c" + line="312">a #GSocketConnection @@ -111850,23 +112302,22 @@ applications to print e.g. "Connecting to example.com glib:get-property="socket" version="2.22"> Gets the underlying #GSocket object of the connection. + filename="gio/gsocketconnection.c" + line="271">Gets the underlying #GSocket object of the connection. This can be useful if you want to do something unusual on it not supported by the #GSocketConnection APIs. - + a #GSocket or %NULL on error. + filename="gio/gsocketconnection.c" + line="279">a #GSocket or %NULL on error. a #GSocketConnection + filename="gio/gsocketconnection.c" + line="273">a #GSocketConnection @@ -111875,31 +112326,34 @@ not supported by the #GSocketConnection APIs. c:identifier="g_socket_connection_is_connected" version="2.32"> Checks if @connection is connected. This is equivalent to calling + filename="gio/gsocketconnection.c" + line="120">Checks if @connection is connected. This is equivalent to calling g_socket_is_connected() on @connection's underlying #GSocket. - + whether @connection is connected + filename="gio/gsocketconnection.c" + line="127">whether @connection is connected a #GSocketConnection + filename="gio/gsocketconnection.c" + line="122">a #GSocketConnection + The underlying [class@Gio.Socket]. @@ -111913,15 +112367,13 @@ g_socket_is_connected() on @connection's underlying #GSocket. - + - + @@ -111929,8 +112381,7 @@ g_socket_is_connected() on @connection's underlying #GSocket. - + @@ -111938,8 +112389,7 @@ g_socket_is_connected() on @connection's underlying #GSocket. - + @@ -111947,8 +112397,7 @@ g_socket_is_connected() on @connection's underlying #GSocket. - + @@ -111956,8 +112405,7 @@ g_socket_is_connected() on @connection's underlying #GSocket. - + @@ -111965,8 +112413,7 @@ g_socket_is_connected() on @connection's underlying #GSocket. - + @@ -111977,8 +112424,7 @@ g_socket_is_connected() on @connection's underlying #GSocket. c:type="GSocketConnectionPrivate" disguised="1" opaque="1"> - + glib:get-type="g_socket_control_message_get_type" glib:type-struct="SocketControlMessageClass"> A #GSocketControlMessage is a special-purpose utility message that -can be sent to or received from a #GSocket. These types of -messages are often called "ancillary data". + filename="gio/gsocketcontrolmessage.c" + line="17">A `GSocketControlMessage` is a special-purpose utility message that +can be sent to or received from a [class@Gio.Socket]. These types of +messages are often called ‘ancillary data’. The message can represent some sort of special instruction to or information from the socket or can represent a special kind of transfer to the peer (for example, sending a file descriptor over a UNIX socket). -These messages are sent with g_socket_send_message() and received -with g_socket_receive_message(). +These messages are sent with [method@Gio.Socket.send_message] and received +with [method@Gio.Socket.receive_message]. To extend the set of control message that can be sent, subclass this -class and override the get_size, get_level, get_type and serialize +class and override the `get_size`, `get_level`, `get_type` and `serialize` methods. To extend the set of control messages that can be received, subclass -this class and implement the deserialize method. Also, make sure your -class is registered with the GType typesystem before calling -g_socket_receive_message() to read such a message. - +this class and implement the `deserialize` method. Also, make sure your +class is registered with the [type@GObject.Type] type system before calling +[method@Gio.Socket.receive_message] to read such a message. + Tries to deserialize a socket control message of a given + filename="gio/gsocketcontrolmessage.c" + line="148">Tries to deserialize a socket control message of a given @level and @type. This will ask all known (to GType) subclasses of #GSocketControlMessage if they can understand this kind of message and if so deserialize it into a #GSocketControlMessage. If there is no implementation for this kind of control message, %NULL will be returned. - + the deserialized message or %NULL + filename="gio/gsocketcontrolmessage.c" + line="163">the deserialized message or %NULL a socket level + filename="gio/gsocketcontrolmessage.c" + line="150">a socket level a socket control message type for the given @level + filename="gio/gsocketcontrolmessage.c" + line="151">a socket control message type for the given @level the size of the data in bytes + filename="gio/gsocketcontrolmessage.c" + line="152">the size of the data in bytes pointer to the message data + filename="gio/gsocketcontrolmessage.c" + line="153">pointer to the message data @@ -112064,51 +112508,51 @@ will be returned. Returns the "level" (i.e. the originating protocol) of the control message. + filename="gio/gsocketcontrolmessage.c" + line="76">Returns the "level" (i.e. the originating protocol) of the control message. This is often SOL_SOCKET. - + an integer describing the level + filename="gio/gsocketcontrolmessage.c" + line="83">an integer describing the level a #GSocketControlMessage + filename="gio/gsocketcontrolmessage.c" + line="78">a #GSocketControlMessage Returns the space required for the control message, not including + filename="gio/gsocketcontrolmessage.c" + line="57">Returns the space required for the control message, not including headers or alignment. - + The number of bytes required. + filename="gio/gsocketcontrolmessage.c" + line="64">The number of bytes required. a #GSocketControlMessage + filename="gio/gsocketcontrolmessage.c" + line="59">a #GSocketControlMessage - + gets the protocol specific type of the message. + @@ -112120,29 +112564,28 @@ headers or alignment. Converts the data in the message to bytes placed in the + filename="gio/gsocketcontrolmessage.c" + line="114">Converts the data in the message to bytes placed in the message. @data is guaranteed to have enough space to fit the size returned by g_socket_control_message_get_size() on this object. - + a #GSocketControlMessage + filename="gio/gsocketcontrolmessage.c" + line="116">a #GSocketControlMessage A buffer to write data to + filename="gio/gsocketcontrolmessage.c" + line="117">A buffer to write data to @@ -112151,22 +112594,21 @@ object. c:identifier="g_socket_control_message_get_level" version="2.22"> Returns the "level" (i.e. the originating protocol) of the control message. + filename="gio/gsocketcontrolmessage.c" + line="76">Returns the "level" (i.e. the originating protocol) of the control message. This is often SOL_SOCKET. - + an integer describing the level + filename="gio/gsocketcontrolmessage.c" + line="83">an integer describing the level a #GSocketControlMessage + filename="gio/gsocketcontrolmessage.c" + line="78">a #GSocketControlMessage @@ -112175,22 +112617,21 @@ This is often SOL_SOCKET. c:identifier="g_socket_control_message_get_msg_type" version="2.22"> Returns the protocol specific type of the control message. + filename="gio/gsocketcontrolmessage.c" + line="95">Returns the protocol specific type of the control message. For instance, for UNIX fd passing this would be SCM_RIGHTS. - + an integer describing the type of control message + filename="gio/gsocketcontrolmessage.c" + line="102">an integer describing the type of control message a #GSocketControlMessage + filename="gio/gsocketcontrolmessage.c" + line="97">a #GSocketControlMessage @@ -112199,22 +112640,21 @@ For instance, for UNIX fd passing this would be SCM_RIGHTS. c:identifier="g_socket_control_message_get_size" version="2.22"> Returns the space required for the control message, not including + filename="gio/gsocketcontrolmessage.c" + line="57">Returns the space required for the control message, not including headers or alignment. - + The number of bytes required. + filename="gio/gsocketcontrolmessage.c" + line="64">The number of bytes required. a #GSocketControlMessage + filename="gio/gsocketcontrolmessage.c" + line="59">a #GSocketControlMessage @@ -112223,29 +112663,28 @@ headers or alignment. c:identifier="g_socket_control_message_serialize" version="2.22"> Converts the data in the message to bytes placed in the + filename="gio/gsocketcontrolmessage.c" + line="114">Converts the data in the message to bytes placed in the message. @data is guaranteed to have enough space to fit the size returned by g_socket_control_message_get_size() on this object. - + a #GSocketControlMessage + filename="gio/gsocketcontrolmessage.c" + line="116">a #GSocketControlMessage A buffer to write data to + filename="gio/gsocketcontrolmessage.c" + line="117">A buffer to write data to @@ -112262,28 +112701,29 @@ object. c:type="GSocketControlMessageClass" glib:is-gtype-struct-for="SocketControlMessage"> Class structure for #GSocketControlMessage. - + + gets the size of the message. - + The number of bytes required. + filename="gio/gsocketcontrolmessage.c" + line="64">The number of bytes required. a #GSocketControlMessage + filename="gio/gsocketcontrolmessage.c" + line="59">a #GSocketControlMessage @@ -112291,20 +112731,22 @@ object. + gets the protocol of the message. - + an integer describing the level + filename="gio/gsocketcontrolmessage.c" + line="83">an integer describing the level a #GSocketControlMessage + filename="gio/gsocketcontrolmessage.c" + line="78">a #GSocketControlMessage @@ -112312,9 +112754,11 @@ object. + gets the protocol specific type of the message. - + @@ -112327,33 +112771,37 @@ object. + Writes out the message data. - + a #GSocketControlMessage + filename="gio/gsocketcontrolmessage.c" + line="116">a #GSocketControlMessage A buffer to write data to + filename="gio/gsocketcontrolmessage.c" + line="117">A buffer to write data to + Tries to deserialize a message. - + @@ -112375,8 +112823,7 @@ object. - + @@ -112384,8 +112831,7 @@ object. - + @@ -112393,8 +112839,7 @@ object. - + @@ -112402,8 +112847,7 @@ object. - + @@ -112411,8 +112855,7 @@ object. - + @@ -112423,8 +112866,7 @@ object. c:type="GSocketControlMessagePrivate" disguised="1" opaque="1"> - + glib:get-type="g_socket_family_get_type" c:type="GSocketFamily"> The protocol family of a #GSocketAddress. (These values are + filename="gio/gioenums.h" + line="822">The protocol family of a #GSocketAddress. (These values are identical to the system defines %AF_INET, %AF_INET6 and %AF_UNIX, if available.) glib:nick="invalid" glib:name="G_SOCKET_FAMILY_INVALID"> no address family + filename="gio/gioenums.h" + line="824">no address family glib:nick="unix" glib:name="G_SOCKET_FAMILY_UNIX"> the UNIX domain family + filename="gio/gioenums.h" + line="827">the UNIX domain family glib:nick="ipv4" glib:name="G_SOCKET_FAMILY_IPV4"> the IPv4 family + filename="gio/gioenums.h" + line="825">the IPv4 family glib:nick="ipv6" glib:name="G_SOCKET_FAMILY_IPV6"> the IPv6 family + filename="gio/gioenums.h" + line="826">the IPv6 family glib:get-type="g_socket_listener_get_type" glib:type-struct="SocketListenerClass"> A #GSocketListener is an object that keeps track of a set + filename="gio/gsocketlistener.c" + line="44">A `GSocketListener` is an object that keeps track of a set of server sockets and helps you accept sockets from any of the socket, either sync or async. -Add addresses and ports to listen on using g_socket_listener_add_address() -and g_socket_listener_add_inet_port(). These will be listened on until -g_socket_listener_close() is called. Dropping your final reference to the -#GSocketListener will not cause g_socket_listener_close() to be called -implicitly, as some references to the #GSocketListener may be held +Add addresses and ports to listen on using +[method@Gio.SocketListener.add_address] and +[method@Gio.SocketListener.add_inet_port]. These will be listened on until +[method@Gio.SocketListener.close] is called. Dropping your final reference to +the `GSocketListener` will not cause [method@Gio.SocketListener.close] to be +called implicitly, as some references to the `GSocketListener` may be held internally. -If you want to implement a network server, also look at #GSocketService -and #GThreadedSocketService which are subclasses of #GSocketListener -that make this even easier. - +If you want to implement a network server, also look at +[class@Gio.SocketService] and [class@Gio.ThreadedSocketService] which are +subclasses of `GSocketListener` that make this even easier. + Creates a new #GSocketListener with no sockets to listen for. + filename="gio/gsocketlistener.c" + line="211">Creates a new #GSocketListener with no sockets to listen for. New listeners can be added with e.g. g_socket_listener_add_address() or g_socket_listener_add_inet_port(). - + a new #GSocketListener. + filename="gio/gsocketlistener.c" + line="218">a new #GSocketListener. - + virtual method called when the set of socket listened to changes + @@ -112529,8 +112972,7 @@ or g_socket_listener_add_inet_port(). - + @@ -112549,10 +112991,11 @@ or g_socket_listener_add_inet_port(). + throws="1" + glib:async-func="accept_async"> Blocks waiting for a client to connect to any of the sockets added + filename="gio/gsocketlistener.c" + line="741">Blocks waiting for a client to connect to any of the sockets added to the listener. Returns a #GSocketConnection for the socket that was accepted. @@ -112563,19 +113006,18 @@ to the listener. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GSocketConnection on success, %NULL on error. + filename="gio/gsocketlistener.c" + line="760">a #GSocketConnection on success, %NULL on error. a #GSocketListener + filename="gio/gsocketlistener.c" + line="743">a #GSocketListener optional="1" allow-none="1"> location where #GObject pointer will be stored, or %NULL + filename="gio/gsocketlistener.c" + line="744">location where #GObject pointer will be stored, or %NULL nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gsocketlistener.c" + line="745">optional #GCancellable object, %NULL to ignore. + version="2.22" + glib:finish-func="accept_finish" + glib:sync-func="accept"> This is the asynchronous version of g_socket_listener_accept(). + filename="gio/gsocketlistener.c" + line="911">This is the asynchronous version of g_socket_listener_accept(). When the operation is finished @callback will be called. You can then call g_socket_listener_accept_finish() to get the result of the operation. - + a #GSocketListener + filename="gio/gsocketlistener.c" + line="913">a #GSocketListener nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsocketlistener.c" + line="914">a #GCancellable, or %NULL scope="async" closure="2"> a #GAsyncReadyCallback + filename="gio/gsocketlistener.c" + line="915">a #GAsyncReadyCallback nullable="1" allow-none="1"> user data for the callback + filename="gio/gsocketlistener.c" + line="916">user data for the callback @@ -112659,27 +113102,26 @@ to get the result of the operation. version="2.22" throws="1"> Finishes an async accept operation. See g_socket_listener_accept_async() - + filename="gio/gsocketlistener.c" + line="938">Finishes an async accept operation. See g_socket_listener_accept_async() + a #GSocketConnection on success, %NULL on error. + filename="gio/gsocketlistener.c" + line="948">a #GSocketConnection on success, %NULL on error. a #GSocketListener + filename="gio/gsocketlistener.c" + line="940">a #GSocketListener a #GAsyncResult. + filename="gio/gsocketlistener.c" + line="941">a #GAsyncResult. optional="1" allow-none="1"> Optional #GObject identifying this source + filename="gio/gsocketlistener.c" + line="942">Optional #GObject identifying this source @@ -112699,10 +113141,11 @@ to get the result of the operation. + throws="1" + glib:async-func="accept_socket_async"> Blocks waiting for a client to connect to any of the sockets added + filename="gio/gsocketlistener.c" + line="664">Blocks waiting for a client to connect to any of the sockets added to the listener. Returns the #GSocket that was accepted. If you want to accept the high-level #GSocketConnection, not a #GSocket, @@ -112716,19 +113159,18 @@ to the listener. If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - + a #GSocket on success, %NULL on error. + filename="gio/gsocketlistener.c" + line="686">a #GSocket on success, %NULL on error. a #GSocketListener + filename="gio/gsocketlistener.c" + line="666">a #GSocketListener optional="1" allow-none="1"> location where #GObject pointer will be stored, or %NULL. + filename="gio/gsocketlistener.c" + line="667">location where #GObject pointer will be stored, or %NULL. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gsocketlistener.c" + line="668">optional #GCancellable object, %NULL to ignore. + version="2.22" + glib:finish-func="accept_socket_finish" + glib:sync-func="accept_socket"> This is the asynchronous version of g_socket_listener_accept_socket(). + filename="gio/gsocketlistener.c" + line="836">This is the asynchronous version of g_socket_listener_accept_socket(). When the operation is finished @callback will be called. You can then call g_socket_listener_accept_socket_finish() to get the result of the operation. - + a #GSocketListener + filename="gio/gsocketlistener.c" + line="838">a #GSocketListener nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsocketlistener.c" + line="839">a #GCancellable, or %NULL scope="async" closure="2"> a #GAsyncReadyCallback + filename="gio/gsocketlistener.c" + line="840">a #GAsyncReadyCallback nullable="1" allow-none="1"> user data for the callback + filename="gio/gsocketlistener.c" + line="841">user data for the callback @@ -112812,27 +113255,26 @@ to get the result of the operation. version="2.22" throws="1"> Finishes an async accept operation. See g_socket_listener_accept_socket_async() - + filename="gio/gsocketlistener.c" + line="882">Finishes an async accept operation. See g_socket_listener_accept_socket_async() + a #GSocket on success, %NULL on error. + filename="gio/gsocketlistener.c" + line="892">a #GSocket on success, %NULL on error. a #GSocketListener + filename="gio/gsocketlistener.c" + line="884">a #GSocketListener a #GAsyncResult. + filename="gio/gsocketlistener.c" + line="885">a #GAsyncResult. optional="1" allow-none="1"> Optional #GObject identifying this source + filename="gio/gsocketlistener.c" + line="886">Optional #GObject identifying this source @@ -112854,8 +113296,8 @@ to get the result of the operation. version="2.22" throws="1"> Creates a socket of type @type and protocol @protocol, binds + filename="gio/gsocketlistener.c" + line="299">Creates a socket of type @type and protocol @protocol, binds it to @address and adds it to the set of sockets we're accepting sockets from. @@ -112878,37 +113320,36 @@ requested, belongs to the caller and must be freed. Call g_socket_listener_close() to stop listening on @address; this will not be done automatically when you drop your final reference to @listener, as references may be held internally. - + %TRUE on success, %FALSE on error. + filename="gio/gsocketlistener.c" + line="333">%TRUE on success, %FALSE on error. a #GSocketListener + filename="gio/gsocketlistener.c" + line="301">a #GSocketListener a #GSocketAddress + filename="gio/gsocketlistener.c" + line="302">a #GSocketAddress a #GSocketType + filename="gio/gsocketlistener.c" + line="303">a #GSocketType a #GSocketProtocol + filename="gio/gsocketlistener.c" + line="304">a #GSocketProtocol nullable="1" allow-none="1"> Optional #GObject identifying this source + filename="gio/gsocketlistener.c" + line="305">Optional #GObject identifying this source optional="1" allow-none="1"> location to store the address that was bound to, or %NULL. + filename="gio/gsocketlistener.c" + line="306">location to store the address that was bound to, or %NULL. @@ -112938,8 +113379,8 @@ references may be held internally. version="2.24" throws="1"> Listens for TCP connections on any available port number for both + filename="gio/gsocketlistener.c" + line="1032">Listens for TCP connections on any available port number for both IPv6 and IPv4 (if each is available). This is useful if you need to have a socket for incoming connections @@ -112949,19 +113390,18 @@ but don't care about the specific port number. to accept to identify this particular source, which is useful if you're listening on multiple addresses and do different things depending on what address is connected to. - + the port number, or 0 in case of failure. + filename="gio/gsocketlistener.c" + line="1050">the port number, or 0 in case of failure. a #GSocketListener + filename="gio/gsocketlistener.c" + line="1034">a #GSocketListener nullable="1" allow-none="1"> Optional #GObject identifying this source + filename="gio/gsocketlistener.c" + line="1035">Optional #GObject identifying this source @@ -112980,8 +113420,8 @@ different things depending on what address is connected to. version="2.22" throws="1"> Helper function for g_socket_listener_add_address() that + filename="gio/gsocketlistener.c" + line="412">Helper function for g_socket_listener_add_address() that creates a TCP/IP socket listening on IPv4 and IPv6 (if supported) on the specified port on all interfaces. @@ -112993,25 +113433,24 @@ different things depending on what address is connected to. Call g_socket_listener_close() to stop listening on @port; this will not be done automatically when you drop your final reference to @listener, as references may be held internally. - + %TRUE on success, %FALSE on error. + filename="gio/gsocketlistener.c" + line="432">%TRUE on success, %FALSE on error. a #GSocketListener + filename="gio/gsocketlistener.c" + line="414">a #GSocketListener an IP port number (non-zero) + filename="gio/gsocketlistener.c" + line="415">an IP port number (non-zero) nullable="1" allow-none="1"> Optional #GObject identifying this source + filename="gio/gsocketlistener.c" + line="416">Optional #GObject identifying this source @@ -113030,8 +113469,8 @@ references may be held internally. version="2.22" throws="1"> Adds @socket to the set of sockets that we try to accept + filename="gio/gsocketlistener.c" + line="242">Adds @socket to the set of sockets that we try to accept new clients from. The socket must be bound to a local address and listened to. @@ -113044,25 +113483,24 @@ The @socket will not be automatically closed when the @listener is finalized unless the listener held the final reference to the socket. Before GLib 2.42, the @socket was automatically closed on finalization of the @listener, even if references to it were held elsewhere. - + %TRUE on success, %FALSE on error. + filename="gio/gsocketlistener.c" + line="263">%TRUE on success, %FALSE on error. a #GSocketListener + filename="gio/gsocketlistener.c" + line="244">a #GSocketListener a listening #GSocket + filename="gio/gsocketlistener.c" + line="245">a listening #GSocket nullable="1" allow-none="1"> Optional #GObject identifying this source + filename="gio/gsocketlistener.c" + line="246">Optional #GObject identifying this source @@ -113080,18 +113518,17 @@ if references to it were held elsewhere. c:identifier="g_socket_listener_close" version="2.22"> Closes all the sockets in the listener. - + filename="gio/gsocketlistener.c" + line="1005">Closes all the sockets in the listener. + a #GSocketListener + filename="gio/gsocketlistener.c" + line="1007">a #GSocketListener @@ -113100,37 +113537,40 @@ if references to it were held elsewhere. c:identifier="g_socket_listener_set_backlog" version="2.22"> Sets the listen backlog on the sockets in the listener. This must be called + filename="gio/gsocketlistener.c" + line="973">Sets the listen backlog on the sockets in the listener. This must be called before adding any sockets, addresses or ports to the #GSocketListener (for example, by calling g_socket_listener_add_inet_port()) to be effective. See g_socket_set_listen_backlog() for details - + a #GSocketListener + filename="gio/gsocketlistener.c" + line="975">a #GSocketListener an integer + filename="gio/gsocketlistener.c" + line="976">an integer + The number of outstanding connections in the listen queue. @@ -113141,8 +113581,8 @@ See g_socket_set_listen_backlog() for details Emitted when @listener's activity on @socket changes state. + filename="gio/gsocketlistener.c" + line="172">Emitted when @listener's activity on @socket changes state. Note that when @listener is used to listen on both IPv4 and IPv6, a separate set of signals will be emitted for each, and the order they happen in is undefined. @@ -113152,14 +113592,14 @@ the order they happen in is undefined. the event that is occurring + filename="gio/gsocketlistener.c" + line="175">the event that is occurring the #GSocket the event is occurring on + filename="gio/gsocketlistener.c" + line="176">the #GSocket the event is occurring on @@ -113169,17 +113609,18 @@ the order they happen in is undefined. c:type="GSocketListenerClass" glib:is-gtype-struct-for="SocketListener"> Class structure for #GSocketListener. - + + virtual method called when the set of socket listened to changes - + @@ -113192,8 +113633,7 @@ the order they happen in is undefined. - + @@ -113212,8 +113652,7 @@ the order they happen in is undefined. - + @@ -113221,8 +113660,7 @@ the order they happen in is undefined. - + @@ -113230,8 +113668,7 @@ the order they happen in is undefined. - + @@ -113239,8 +113676,7 @@ the order they happen in is undefined. - + @@ -113248,8 +113684,7 @@ the order they happen in is undefined. - + @@ -113262,8 +113697,8 @@ the order they happen in is undefined. glib:get-type="g_socket_listener_event_get_type" c:type="GSocketListenerEvent"> Describes an event occurring on a #GSocketListener. See the + filename="gio/gioenums.h" + line="1960">Describes an event occurring on a #GSocketListener. See the #GSocketListener::event signal for more details. Additional values may be added to this type in the future. @@ -113273,8 +113708,8 @@ Additional values may be added to this type in the future. glib:nick="binding" glib:name="G_SOCKET_LISTENER_BINDING"> The listener is about to bind a socket. + filename="gio/gioenums.h" + line="1962">The listener is about to bind a socket. glib:nick="bound" glib:name="G_SOCKET_LISTENER_BOUND"> The listener has bound a socket. + filename="gio/gioenums.h" + line="1963">The listener has bound a socket. glib:nick="listening" glib:name="G_SOCKET_LISTENER_LISTENING"> The listener is about to start + filename="gio/gioenums.h" + line="1964">The listener is about to start listening on this socket. glib:nick="listened" glib:name="G_SOCKET_LISTENER_LISTENED"> The listener is now listening on + filename="gio/gioenums.h" + line="1966">The listener is now listening on this socket. @@ -113310,8 +113745,7 @@ Additional values may be added to this type in the future. c:type="GSocketListenerPrivate" disguised="1" opaque="1"> - + glib:get-type="g_socket_msg_flags_get_type" c:type="GSocketMsgFlags"> Flags used in g_socket_receive_message() and g_socket_send_message(). + filename="gio/gioenums.h" + line="864">Flags used in g_socket_receive_message() and g_socket_send_message(). The flags listed in the enum are some commonly available flags, but the values used for them are the same as on the platform, and any other flags are passed in/out as is. So to use a platform specific flag, just include @@ -113331,8 +113765,8 @@ the right system header and pass in the flag. glib:nick="none" glib:name="G_SOCKET_MSG_NONE"> No flags. + filename="gio/gioenums.h" + line="866">No flags. glib:nick="oob" glib:name="G_SOCKET_MSG_OOB"> Request to send/receive out of band data. + filename="gio/gioenums.h" + line="867">Request to send/receive out of band data. glib:nick="peek" glib:name="G_SOCKET_MSG_PEEK"> Read data from the socket without removing it from + filename="gio/gioenums.h" + line="868">Read data from the socket without removing it from the queue. glib:nick="dontroute" glib:name="G_SOCKET_MSG_DONTROUTE"> Don't use a gateway to send out the packet, + filename="gio/gioenums.h" + line="870">Don't use a gateway to send out the packet, only send to hosts on directly connected networks. @@ -113368,8 +113802,7 @@ the right system header and pass in the flag. c:type="GSocketPrivate" disguised="1" opaque="1"> - + glib:get-type="g_socket_protocol_get_type" c:type="GSocketProtocol"> A protocol identifier is specified when creating a #GSocket, which is a + filename="gio/gioenums.h" + line="889">A protocol identifier is specified when creating a #GSocket, which is a family/type specific identifier, where 0 means the default protocol for the particular family/type. @@ -113391,8 +113824,8 @@ use protocols not listed here. glib:nick="unknown" glib:name="G_SOCKET_PROTOCOL_UNKNOWN"> The protocol type is unknown + filename="gio/gioenums.h" + line="891">The protocol type is unknown glib:nick="default" glib:name="G_SOCKET_PROTOCOL_DEFAULT"> The default protocol for the family/type + filename="gio/gioenums.h" + line="892">The default protocol for the family/type glib:nick="tcp" glib:name="G_SOCKET_PROTOCOL_TCP"> TCP over IP + filename="gio/gioenums.h" + line="893">TCP over IP glib:nick="udp" glib:name="G_SOCKET_PROTOCOL_UDP"> UDP over IP + filename="gio/gioenums.h" + line="894">UDP over IP glib:nick="sctp" glib:name="G_SOCKET_PROTOCOL_SCTP"> SCTP over IP + filename="gio/gioenums.h" + line="895">SCTP over IP glib:get-type="g_socket_service_get_type" glib:type-struct="SocketServiceClass"> A #GSocketService is an object that represents a service that + filename="gio/gsocketservice.c" + line="25">A `GSocketService` is an object that represents a service that is provided to the network or over local sockets. When a new -connection is made to the service the #GSocketService::incoming +connection is made to the service the [signal@Gio.SocketService::incoming] signal is emitted. -A #GSocketService is a subclass of #GSocketListener and you need +A `GSocketService` is a subclass of [class@Gio.SocketListener] and you need to add the addresses you want to accept connections on with the -#GSocketListener APIs. +[class@Gio.SocketListener] APIs. There are two options for implementing a network service based on -#GSocketService. The first is to create the service using -g_socket_service_new() and to connect to the #GSocketService::incoming -signal. The second is to subclass #GSocketService and override the -default signal handler implementation. +`GSocketService`. The first is to create the service using +[ctor@Gio.SocketService.new] and to connect to the +[signal@Gio.SocketService::incoming] signal. The second is to subclass +`GSocketService` and override the default signal handler implementation. In either case, the handler must immediately return, or else it will block additional incoming connections from being serviced. If you are interested in writing connection handlers that contain -blocking code then see #GThreadedSocketService. +blocking code then see [class@Gio.ThreadedSocketService]. The socket service runs on the main loop of the -[thread-default context][g-main-context-push-thread-default-context] -of the thread it is created in, and is not -threadsafe in general. However, the calls to start and stop the -service are thread-safe so these can be used from threads that +thread-default context (see +[method@GLib.MainContext.push_thread_default]) of the thread it is +created in, and is not threadsafe in general. However, the calls to start and +stop the service are thread-safe so these can be used from threads that handle incoming clients. - + Creates a new #GSocketService with no sockets to listen for. + filename="gio/gsocketservice.c" + line="404">Creates a new #GSocketService with no sockets to listen for. New listeners can be added with e.g. g_socket_listener_add_address() or g_socket_listener_add_inet_port(). New services are created active, there is no need to call g_socket_service_start(), unless g_socket_service_stop() has been called before. - + a new #GSocketService. + filename="gio/gsocketservice.c" + line="415">a new #GSocketService. - + signal emitted when new connections are accepted + @@ -113512,24 +113945,23 @@ called before. c:identifier="g_socket_service_is_active" version="2.22"> Check whether the service is active or not. An active + filename="gio/gsocketservice.c" + line="228">Check whether the service is active or not. An active service will accept new clients that connect, while a non-active service will let connecting clients queue up until the service is started. - + %TRUE if the service is active, %FALSE otherwise + filename="gio/gsocketservice.c" + line="237">%TRUE if the service is active, %FALSE otherwise a #GSocketService + filename="gio/gsocketservice.c" + line="230">a #GSocketService @@ -113538,32 +113970,31 @@ up until the service is started. c:identifier="g_socket_service_start" version="2.22"> Restarts the service, i.e. start accepting connections + filename="gio/gsocketservice.c" + line="249">Restarts the service, i.e. start accepting connections from the added sockets when the mainloop runs. This only needs to be called after the service has been stopped from g_socket_service_stop(). This call is thread-safe, so it may be called from a thread handling an incoming client request. - + a #GSocketService + filename="gio/gsocketservice.c" + line="251">a #GSocketService Stops the service, i.e. stops accepting connections + filename="gio/gsocketservice.c" + line="271">Stops the service, i.e. stops accepting connections from the added sockets when the mainloop runs. This call is thread-safe, so it may be called from a thread @@ -113578,16 +114009,15 @@ will happen automatically when the #GSocketService is finalized.) This must be called before calling g_socket_listener_close() as the socket service will start accepting connections immediately when a new socket is added. - + a #GSocketService + filename="gio/gsocketservice.c" + line="273">a #GSocketService @@ -113599,8 +114029,8 @@ when a new socket is added. transfer-ownership="none" default-value="TRUE"> Whether the service is currently accepting connections. + filename="gio/gsocketservice.c" + line="355">Whether the service is currently accepting connections. @@ -113611,8 +114041,8 @@ when a new socket is added. The ::incoming signal is emitted when a new incoming connection + filename="gio/gsocketservice.c" + line="325">The ::incoming signal is emitted when a new incoming connection to @service needs to be handled. The handler must initiate the handling of @connection, but may not block; in essence, asynchronous operations must be used. @@ -113621,15 +114051,15 @@ asynchronous operations must be used. so you need to ref it yourself if you are planning to use it. %TRUE to stop other handlers from being called + filename="gio/gsocketservice.c" + line="340">%TRUE to stop other handlers from being called a new #GSocketConnection object + filename="gio/gsocketservice.c" + line="328">a new #GSocketConnection object nullable="1" allow-none="1"> the source_object passed to + filename="gio/gsocketservice.c" + line="329">the source_object passed to g_socket_listener_add_address() @@ -113649,17 +114079,18 @@ so you need to ref it yourself if you are planning to use it. c:type="GSocketServiceClass" glib:is-gtype-struct-for="SocketService"> Class structure for #GSocketService. - + + signal emitted when new connections are accepted - + @@ -113678,8 +114109,7 @@ so you need to ref it yourself if you are planning to use it. - + @@ -113687,8 +114117,7 @@ so you need to ref it yourself if you are planning to use it. - + @@ -113696,8 +114125,7 @@ so you need to ref it yourself if you are planning to use it. - + @@ -113705,8 +114133,7 @@ so you need to ref it yourself if you are planning to use it. - + @@ -113714,8 +114141,7 @@ so you need to ref it yourself if you are planning to use it. - + @@ -113723,8 +114149,7 @@ so you need to ref it yourself if you are planning to use it. - + @@ -113735,35 +114160,33 @@ so you need to ref it yourself if you are planning to use it. c:type="GSocketServicePrivate" disguised="1" opaque="1"> - + This is the function type of the callback used for the #GSource + filename="gio/giotypes.h" + line="302">This is the function type of the callback used for the #GSource returned by g_socket_create_source(). - + it should return %FALSE if the source should be removed. + filename="gio/giotypes.h" + line="311">it should return %FALSE if the source should be removed. the #GSocket + filename="gio/giotypes.h" + line="304">the #GSocket the current condition at the source fired. + filename="gio/giotypes.h" + line="305">the current condition at the source fired. nullable="1" allow-none="1"> data passed in by the user. + filename="gio/giotypes.h" + line="306">data passed in by the user. @@ -113783,8 +114206,8 @@ returned by g_socket_create_source(). glib:get-type="g_socket_type_get_type" c:type="GSocketType"> Flags used when creating a #GSocket. Some protocols may not implement + filename="gio/gioenums.h" + line="842">Flags used when creating a #GSocket. Some protocols may not implement all the socket types. glib:nick="invalid" glib:name="G_SOCKET_TYPE_INVALID"> Type unknown or wrong + filename="gio/gioenums.h" + line="844">Type unknown or wrong glib:nick="stream" glib:name="G_SOCKET_TYPE_STREAM"> Reliable connection-based byte streams (e.g. TCP). + filename="gio/gioenums.h" + line="845">Reliable connection-based byte streams (e.g. TCP). glib:nick="datagram" glib:name="G_SOCKET_TYPE_DATAGRAM"> Connectionless, unreliable datagram passing. + filename="gio/gioenums.h" + line="846">Connectionless, unreliable datagram passing. (e.g. UDP) glib:nick="seqpacket" glib:name="G_SOCKET_TYPE_SEQPACKET"> Reliable connection-based passing of datagrams + filename="gio/gioenums.h" + line="848">Reliable connection-based passing of datagrams of fixed maximum length (e.g. SCTP). @@ -113832,100 +114255,98 @@ all the socket types. glib:get-type="g_srv_target_get_type" c:symbol-prefix="srv_target"> SRV (service) records are used by some network protocols to provide + filename="gio/gsrvtarget.c" + line="33">A single target host/port that a network service is running on. + +SRV (service) records are used by some network protocols to provide service-specific aliasing and load-balancing. For example, XMPP (Jabber) uses SRV records to locate the XMPP server for a domain; -rather than connecting directly to "example.com" or assuming a -specific server hostname like "xmpp.example.com", an XMPP client -would look up the "xmpp-client" SRV record for "example.com", and +rather than connecting directly to ‘example.com’ or assuming a +specific server hostname like ‘xmpp.example.com’, an XMPP client +would look up the `xmpp-client` SRV record for ‘example.com’, and then connect to whatever host was pointed to by that record. -You can use g_resolver_lookup_service() or -g_resolver_lookup_service_async() to find the #GSrvTargets +You can use [method@Gio.Resolver.lookup_service] or +[method@Gio.Resolver.lookup_service_async] to find the `GSrvTarget`s for a given service. However, if you are simply planning to connect -to the remote service, you can use #GNetworkService's -#GSocketConnectable interface and not need to worry about -#GSrvTarget at all. - +to the remote service, you can use [class@Gio.NetworkService]’s +[iface@Gio.SocketConnectable] interface and not need to worry about +`GSrvTarget` at all. + Creates a new #GSrvTarget with the given parameters. + filename="gio/gsrvtarget.c" + line="65">Creates a new #GSrvTarget with the given parameters. You should not need to use this; normally #GSrvTargets are created by #GResolver. - + a new #GSrvTarget. + filename="gio/gsrvtarget.c" + line="77">a new #GSrvTarget. the host that the service is running on + filename="gio/gsrvtarget.c" + line="67">the host that the service is running on the port that the service is running on + filename="gio/gsrvtarget.c" + line="68">the port that the service is running on the target's priority + filename="gio/gsrvtarget.c" + line="69">the target's priority the target's weight + filename="gio/gsrvtarget.c" + line="70">the target's weight Copies @target - + filename="gio/gsrvtarget.c" + line="97">Copies @target + a copy of @target + filename="gio/gsrvtarget.c" + line="103">a copy of @target a #GSrvTarget + filename="gio/gsrvtarget.c" + line="99">a #GSrvTarget Frees @target - + filename="gio/gsrvtarget.c" + line="114">Frees @target + a #GSrvTarget + filename="gio/gsrvtarget.c" + line="116">a #GSrvTarget @@ -113934,24 +114355,23 @@ created by #GResolver. c:identifier="g_srv_target_get_hostname" version="2.22"> Gets @target's hostname (in ASCII form; if you are going to present + filename="gio/gsrvtarget.c" + line="129">Gets @target's hostname (in ASCII form; if you are going to present this to the user, you should use g_hostname_is_ascii_encoded() to check if it contains encoded Unicode segments, and use g_hostname_to_unicode() to convert it if it does.) - + @target's hostname + filename="gio/gsrvtarget.c" + line="138">@target's hostname a #GSrvTarget + filename="gio/gsrvtarget.c" + line="131">a #GSrvTarget @@ -113960,21 +114380,20 @@ g_hostname_to_unicode() to convert it if it does.) c:identifier="g_srv_target_get_port" version="2.22"> Gets @target's port - + filename="gio/gsrvtarget.c" + line="148">Gets @target's port + @target's port + filename="gio/gsrvtarget.c" + line="154">@target's port a #GSrvTarget + filename="gio/gsrvtarget.c" + line="150">a #GSrvTarget @@ -113983,23 +114402,22 @@ g_hostname_to_unicode() to convert it if it does.) c:identifier="g_srv_target_get_priority" version="2.22"> Gets @target's priority. You should not need to look at this; + filename="gio/gsrvtarget.c" + line="164">Gets @target's priority. You should not need to look at this; #GResolver already sorts the targets according to the algorithm in RFC 2782. - + @target's priority + filename="gio/gsrvtarget.c" + line="172">@target's priority a #GSrvTarget + filename="gio/gsrvtarget.c" + line="166">a #GSrvTarget @@ -114008,23 +114426,22 @@ RFC 2782. c:identifier="g_srv_target_get_weight" version="2.22"> Gets @target's weight. You should not need to look at this; + filename="gio/gsrvtarget.c" + line="182">Gets @target's weight. You should not need to look at this; #GResolver already sorts the targets according to the algorithm in RFC 2782. - + @target's weight + filename="gio/gsrvtarget.c" + line="190">@target's weight a #GSrvTarget + filename="gio/gsrvtarget.c" + line="184">a #GSrvTarget @@ -114034,14 +114451,13 @@ RFC 2782. version="2.22" introspectable="0"> Sorts @targets in place according to the algorithm in RFC 2782. - + filename="gio/gsrvtarget.c" + line="218">Sorts @targets in place according to the algorithm in RFC 2782. + the head of the sorted list. + filename="gio/gsrvtarget.c" + line="224">the head of the sorted list. @@ -114049,8 +114465,8 @@ RFC 2782. a #GList of #GSrvTarget + filename="gio/gsrvtarget.c" + line="220">a #GList of #GSrvTarget @@ -114060,11 +114476,10 @@ RFC 2782. #GStaticResource is an opaque data structure and can only be accessed + filename="gio/gresource.c" + line="218">#GStaticResource is an opaque data structure and can only be accessed using the following functions. - + @@ -114082,22 +114497,21 @@ using the following functions. Finalized a GResource initialized by g_static_resource_init(). + filename="gio/gresource.c" + line="1447">Finalized a GResource initialized by g_static_resource_init(). This is normally used by code generated by [glib-compile-resources][glib-compile-resources] and is not typically used by other code. - + pointer to a static #GStaticResource + filename="gio/gresource.c" + line="1449">pointer to a static #GStaticResource @@ -114106,48 +114520,46 @@ and is not typically used by other code. c:identifier="g_static_resource_get_resource" version="2.32"> Gets the GResource that was registered by a call to g_static_resource_init(). + filename="gio/gresource.c" + line="1482">Gets the GResource that was registered by a call to g_static_resource_init(). This is normally used by code generated by [glib-compile-resources][glib-compile-resources] and is not typically used by other code. - + a #GResource + filename="gio/gresource.c" + line="1492">a #GResource pointer to a static #GStaticResource + filename="gio/gresource.c" + line="1484">pointer to a static #GStaticResource Initializes a GResource from static data using a + filename="gio/gresource.c" + line="1421">Initializes a GResource from static data using a GStaticResource. This is normally used by code generated by [glib-compile-resources][glib-compile-resources] and is not typically used by other code. - + pointer to a static #GStaticResource + filename="gio/gresource.c" + line="1423">pointer to a static #GStaticResource @@ -114161,13 +114573,13 @@ and is not typically used by other code. glib:type-name="GSubprocess" glib:get-type="g_subprocess_get_type"> #GSubprocess allows the creation of and interaction with child + filename="gio/gsubprocess.c" + line="19">`GSubprocess` allows the creation of and interaction with child processes. Processes can be communicated with using standard GIO-style APIs (ie: -#GInputStream, #GOutputStream). There are GIO-style APIs to wait for -process termination (ie: cancellable and with an asynchronous +[class@Gio.InputStream], [class@Gio.OutputStream]). There are GIO-style APIs +to wait for process termination (ie: cancellable and with an asynchronous variant). There is an API to force a process to terminate, as well as a @@ -114175,50 +114587,50 @@ race-free API for sending UNIX signals to a subprocess. One major advantage that GIO brings over the core GLib library is comprehensive API for asynchronous I/O, such -g_output_stream_splice_async(). This makes GSubprocess +[method@Gio.OutputStream.splice_async]. This makes `GSubprocess` significantly more powerful and flexible than equivalent APIs in some other languages such as the `subprocess.py` -included with Python. For example, using #GSubprocess one could +included with Python. For example, using `GSubprocess` one could create two child processes, reading standard output from the first, processing it, and writing to the input stream of the second, all without blocking the main loop. -A powerful g_subprocess_communicate() API is provided similar to the +A powerful [method@Gio.Subprocess.communicate] API is provided similar to the `communicate()` method of `subprocess.py`. This enables very easy interaction with a subprocess that has been opened with pipes. -#GSubprocess defaults to tight control over the file descriptors open -in the child process, avoiding dangling-fd issues that are caused by -a simple fork()/exec(). The only open file descriptors in the +`GSubprocess` defaults to tight control over the file descriptors open +in the child process, avoiding dangling-FD issues that are caused by +a simple `fork()`/`exec()`. The only open file descriptors in the spawned process are ones that were explicitly specified by the -#GSubprocess API (unless %G_SUBPROCESS_FLAGS_INHERIT_FDS was +`GSubprocess` API (unless `G_SUBPROCESS_FLAGS_INHERIT_FDS` was specified). -#GSubprocess will quickly reap all child processes as they exit, -avoiding "zombie processes" remaining around for long periods of -time. g_subprocess_wait() can be used to wait for this to happen, +`GSubprocess` will quickly reap all child processes as they exit, +avoiding ‘zombie processes’ remaining around for long periods of +time. [method@Gio.Subprocess.wait] can be used to wait for this to happen, but it will happen even without the call being explicitly made. -As a matter of principle, #GSubprocess has no API that accepts +As a matter of principle, `GSubprocess` has no API that accepts shell-style space-separated strings. It will, however, match the -typical shell behaviour of searching the PATH for executables that do +typical shell behaviour of searching the `PATH` for executables that do not contain a directory separator in their name. By default, the `PATH` of the current process is used. You can specify -%G_SUBPROCESS_FLAGS_SEARCH_PATH_FROM_ENVP to use the `PATH` of the +`G_SUBPROCESS_FLAGS_SEARCH_PATH_FROM_ENVP` to use the `PATH` of the launcher environment instead. -#GSubprocess attempts to have a very simple API for most uses (ie: +`GSubprocess` attempts to have a very simple API for most uses (ie: spawning a subprocess with arguments and support for most typical -kinds of input and output redirection). See g_subprocess_new(). The -#GSubprocessLauncher API is provided for more complicated cases +kinds of input and output redirection). See [ctor@Gio.Subprocess.new]. The +[class@Gio.SubprocessLauncher] API is provided for more complicated cases (advanced types of redirection, environment variable manipulation, change of working directory, child setup functions, etc). -A typical use of #GSubprocess will involve calling -g_subprocess_new(), followed by g_subprocess_wait_async() or -g_subprocess_wait(). After the process exits, the status can be -checked using functions such as g_subprocess_get_if_exited() (which -are similar to the familiar WIFEXITED-style POSIX macros). +A typical use of `GSubprocess` will involve calling +[ctor@Gio.Subprocess.new], followed by [method@Gio.Subprocess.wait_async] or +[method@Gio.Subprocess.wait]. After the process exits, the status can be +checked using functions such as [method@Gio.Subprocess.get_if_exited] (which +are similar to the familiar `WIFEXITED`-style POSIX macros). version="2.40" introspectable="0"> Create a new process with the given flags and varargs argument + filename="gio/gsubprocess.c" + line="524">Create a new process with the given flags and varargs argument list. By default, matching the g_spawn_async() defaults, the child's stdin will be set to the system null device, and stdout/stderr will be inherited from the parent. You can use @flags to control this behavior. The argument list must be terminated with %NULL. - + A newly created #GSubprocess, or %NULL on error (and @error + filename="gio/gsubprocess.c" + line="539">A newly created #GSubprocess, or %NULL on error (and @error will be set) flags that define the behaviour of the subprocess + filename="gio/gsubprocess.c" + line="526">flags that define the behaviour of the subprocess nullable="1" allow-none="1"> return location for an error, or %NULL + filename="gio/gsubprocess.c" + line="527">return location for an error, or %NULL first commandline argument to pass to the subprocess + filename="gio/gsubprocess.c" + line="528">first commandline argument to pass to the subprocess more commandline arguments, followed by %NULL + filename="gio/gsubprocess.c" + line="529">more commandline arguments, followed by %NULL @@ -114279,32 +114690,31 @@ The argument list must be terminated with %NULL. version="2.40" throws="1"> Create a new process with the given flags and argument list. + filename="gio/gsubprocess.c" + line="574">Create a new process with the given flags and argument list. The argument list is expected to be %NULL-terminated. - + A newly created #GSubprocess, or %NULL on error (and @error + filename="gio/gsubprocess.c" + line="584">A newly created #GSubprocess, or %NULL on error (and @error will be set) commandline arguments for the subprocess + filename="gio/gsubprocess.c" + line="576">commandline arguments for the subprocess flags that define the behaviour of the subprocess + filename="gio/gsubprocess.c" + line="577">flags that define the behaviour of the subprocess @@ -114312,10 +114722,11 @@ The argument list is expected to be %NULL-terminated. + throws="1" + glib:async-func="communicate_async"> Communicate with the subprocess until it terminates, and all input + filename="gio/gsubprocess.c" + line="1506">Communicate with the subprocess until it terminates, and all input and output has been completed. If @stdin_buf is given, the subprocess must have been created with @@ -114356,19 +114767,18 @@ starting this function, since they may be left in strange states, even if the operation was cancelled. You should especially not attempt to interact with the pipes while the operation is in progress (either from another thread or if using the asynchronous version). - + %TRUE if successful + filename="gio/gsubprocess.c" + line="1557">%TRUE if successful a #GSubprocess + filename="gio/gsubprocess.c" + line="1508">a #GSubprocess data to send to the stdin of the subprocess, or %NULL + filename="gio/gsubprocess.c" + line="1509">data to send to the stdin of the subprocess, or %NULL a #GCancellable + filename="gio/gsubprocess.c" + line="1510">a #GCancellable data read from the subprocess stdout + filename="gio/gsubprocess.c" + line="1511">data read from the subprocess stdout data read from the subprocess stderr + filename="gio/gsubprocess.c" + line="1512">data read from the subprocess stderr + c:identifier="g_subprocess_communicate_async" + glib:finish-func="communicate_finish" + glib:sync-func="communicate"> Asynchronous version of g_subprocess_communicate(). Complete + filename="gio/gsubprocess.c" + line="1587">Asynchronous version of g_subprocess_communicate(). Complete invocation with g_subprocess_communicate_finish(). - + Self + filename="gio/gsubprocess.c" + line="1589">Self nullable="1" allow-none="1"> Input data, or %NULL + filename="gio/gsubprocess.c" + line="1590">Input data, or %NULL nullable="1" allow-none="1"> Cancellable + filename="gio/gsubprocess.c" + line="1591">Cancellable scope="async" closure="3"> Callback + filename="gio/gsubprocess.c" + line="1592">Callback nullable="1" allow-none="1"> User data + filename="gio/gsubprocess.c" + line="1593">User data @@ -114477,24 +114888,23 @@ invocation with g_subprocess_communicate_finish(). c:identifier="g_subprocess_communicate_finish" throws="1"> Complete an invocation of g_subprocess_communicate_async(). - + filename="gio/gsubprocess.c" + line="1612">Complete an invocation of g_subprocess_communicate_async(). + Self + filename="gio/gsubprocess.c" + line="1614">Self Result + filename="gio/gsubprocess.c" + line="1615">Result optional="1" allow-none="1"> Return location for stdout data + filename="gio/gsubprocess.c" + line="1616">Return location for stdout data optional="1" allow-none="1"> Return location for stderr data + filename="gio/gsubprocess.c" + line="1617">Return location for stderr data + throws="1" + glib:async-func="communicate_utf8_async"> Like g_subprocess_communicate(), but validates the output of the + filename="gio/gsubprocess.c" + line="1653">Like g_subprocess_communicate(), but validates the output of the process as UTF-8, and returns it as a regular NUL terminated string. On error, @stdout_buf and @stderr_buf will be set to undefined values and should not be used. - + a #GSubprocess + filename="gio/gsubprocess.c" + line="1655">a #GSubprocess nullable="1" allow-none="1"> data to send to the stdin of the subprocess, or %NULL + filename="gio/gsubprocess.c" + line="1656">data to send to the stdin of the subprocess, or %NULL nullable="1" allow-none="1"> a #GCancellable + filename="gio/gsubprocess.c" + line="1657">a #GCancellable optional="1" allow-none="1"> data read from the subprocess stdout + filename="gio/gsubprocess.c" + line="1658">data read from the subprocess stdout optional="1" allow-none="1"> data read from the subprocess stderr + filename="gio/gsubprocess.c" + line="1659">data read from the subprocess stderr + c:identifier="g_subprocess_communicate_utf8_async" + glib:finish-func="communicate_utf8_finish" + glib:sync-func="communicate_utf8"> Asynchronous version of g_subprocess_communicate_utf8(). Complete + filename="gio/gsubprocess.c" + line="1701">Asynchronous version of g_subprocess_communicate_utf8(). Complete invocation with g_subprocess_communicate_utf8_finish(). - + Self + filename="gio/gsubprocess.c" + line="1703">Self nullable="1" allow-none="1"> Input data, or %NULL + filename="gio/gsubprocess.c" + line="1704">Input data, or %NULL nullable="1" allow-none="1"> Cancellable + filename="gio/gsubprocess.c" + line="1705">Cancellable scope="async" closure="3"> Callback + filename="gio/gsubprocess.c" + line="1706">Callback nullable="1" allow-none="1"> User data + filename="gio/gsubprocess.c" + line="1707">User data @@ -114651,24 +115062,23 @@ invocation with g_subprocess_communicate_utf8_finish(). c:identifier="g_subprocess_communicate_utf8_finish" throws="1"> Complete an invocation of g_subprocess_communicate_utf8_async(). - + filename="gio/gsubprocess.c" + line="1765">Complete an invocation of g_subprocess_communicate_utf8_async(). + Self + filename="gio/gsubprocess.c" + line="1767">Self Result + filename="gio/gsubprocess.c" + line="1768">Result optional="1" allow-none="1"> Return location for stdout data + filename="gio/gsubprocess.c" + line="1769">Return location for stdout data optional="1" allow-none="1"> Return location for stderr data + filename="gio/gsubprocess.c" + line="1770">Return location for stderr data @@ -114701,24 +115111,23 @@ invocation with g_subprocess_communicate_utf8_finish(). c:identifier="g_subprocess_force_exit" version="2.40"> Use an operating-system specific method to attempt an immediate, + filename="gio/gsubprocess.c" + line="1040">Use an operating-system specific method to attempt an immediate, forceful termination of the process. There is no mechanism to determine whether or not the request itself was successful; however, you can use g_subprocess_wait() to monitor the status of the process after calling this function. On Unix, this function sends %SIGKILL. - + a #GSubprocess + filename="gio/gsubprocess.c" + line="1042">a #GSubprocess @@ -114727,8 +115136,8 @@ On Unix, this function sends %SIGKILL. c:identifier="g_subprocess_get_exit_status" version="2.40"> Check the exit status of the subprocess, given that it exited + filename="gio/gsubprocess.c" + line="1152">Check the exit status of the subprocess, given that it exited normally. This is the value passed to the exit() system call or the return value from main. @@ -114736,19 +115145,18 @@ This is equivalent to the system WEXITSTATUS macro. It is an error to call this function before g_subprocess_wait() and unless g_subprocess_get_if_exited() returned %TRUE. - + the exit status + filename="gio/gsubprocess.c" + line="1165">the exit status a #GSubprocess + filename="gio/gsubprocess.c" + line="1154">a #GSubprocess @@ -114757,24 +115165,23 @@ unless g_subprocess_get_if_exited() returned %TRUE. c:identifier="g_subprocess_get_identifier" version="2.40"> On UNIX, returns the process ID as a decimal string. + filename="gio/gsubprocess.c" + line="602">On UNIX, returns the process ID as a decimal string. On Windows, returns the result of GetProcessId() also as a string. If the subprocess has terminated, this will return %NULL. - + the subprocess identifier, or %NULL if the subprocess + filename="gio/gsubprocess.c" + line="610">the subprocess identifier, or %NULL if the subprocess has terminated a #GSubprocess + filename="gio/gsubprocess.c" + line="604">a #GSubprocess @@ -114783,27 +115190,26 @@ If the subprocess has terminated, this will return %NULL. c:identifier="g_subprocess_get_if_exited" version="2.40"> Check if the given subprocess exited normally (ie: by way of exit() + filename="gio/gsubprocess.c" + line="1123">Check if the given subprocess exited normally (ie: by way of exit() or return from main()). This is equivalent to the system WIFEXITED macro. It is an error to call this function before g_subprocess_wait() has returned. - + %TRUE if the case of a normal exit + filename="gio/gsubprocess.c" + line="1135">%TRUE if the case of a normal exit a #GSubprocess + filename="gio/gsubprocess.c" + line="1125">a #GSubprocess @@ -114812,26 +115218,25 @@ returned. c:identifier="g_subprocess_get_if_signaled" version="2.40"> Check if the given subprocess terminated in response to a signal. + filename="gio/gsubprocess.c" + line="1184">Check if the given subprocess terminated in response to a signal. This is equivalent to the system WIFSIGNALED macro. It is an error to call this function before g_subprocess_wait() has returned. - + %TRUE if the case of termination due to a signal + filename="gio/gsubprocess.c" + line="1195">%TRUE if the case of termination due to a signal a #GSubprocess + filename="gio/gsubprocess.c" + line="1186">a #GSubprocess @@ -114840,8 +115245,8 @@ returned. c:identifier="g_subprocess_get_status" version="2.40"> Gets the raw status code of the process, as from waitpid(). + filename="gio/gsubprocess.c" + line="1066">Gets the raw status code of the process, as from waitpid(). This value has no particular meaning, but it can be used with the macros defined by the system headers such as WIFEXITED. It can also @@ -114852,19 +115257,18 @@ followed by g_subprocess_get_exit_status(). It is an error to call this function before g_subprocess_wait() has returned. - + the (meaningless) waitpid() exit status from the kernel + filename="gio/gsubprocess.c" + line="1082">the (meaningless) waitpid() exit status from the kernel a #GSubprocess + filename="gio/gsubprocess.c" + line="1068">a #GSubprocess @@ -114873,25 +115277,24 @@ returned. c:identifier="g_subprocess_get_stderr_pipe" version="2.40"> Gets the #GInputStream from which to read the stderr output of + filename="gio/gsubprocess.c" + line="669">Gets the #GInputStream from which to read the stderr output of @subprocess. The process must have been created with %G_SUBPROCESS_FLAGS_STDERR_PIPE, otherwise %NULL will be returned. - + the stderr pipe + filename="gio/gsubprocess.c" + line="679">the stderr pipe a #GSubprocess + filename="gio/gsubprocess.c" + line="671">a #GSubprocess @@ -114900,25 +115303,24 @@ otherwise %NULL will be returned. c:identifier="g_subprocess_get_stdin_pipe" version="2.40"> Gets the #GOutputStream that you can write to in order to give data + filename="gio/gsubprocess.c" + line="625">Gets the #GOutputStream that you can write to in order to give data to the stdin of @subprocess. The process must have been created with %G_SUBPROCESS_FLAGS_STDIN_PIPE and not %G_SUBPROCESS_FLAGS_STDIN_INHERIT, otherwise %NULL will be returned. - + the stdout pipe + filename="gio/gsubprocess.c" + line="635">the stdout pipe a #GSubprocess + filename="gio/gsubprocess.c" + line="627">a #GSubprocess @@ -114927,25 +115329,24 @@ not %G_SUBPROCESS_FLAGS_STDIN_INHERIT, otherwise %NULL will be returned. c:identifier="g_subprocess_get_stdout_pipe" version="2.40"> Gets the #GInputStream from which to read the stdout output of + filename="gio/gsubprocess.c" + line="647">Gets the #GInputStream from which to read the stdout output of @subprocess. The process must have been created with %G_SUBPROCESS_FLAGS_STDOUT_PIPE, otherwise %NULL will be returned. - + the stdout pipe + filename="gio/gsubprocess.c" + line="657">the stdout pipe a #GSubprocess + filename="gio/gsubprocess.c" + line="649">a #GSubprocess @@ -114954,26 +115355,25 @@ otherwise %NULL will be returned. c:identifier="g_subprocess_get_successful" version="2.40"> Checks if the process was "successful". A process is considered + filename="gio/gsubprocess.c" + line="1095">Checks if the process was "successful". A process is considered successful if it exited cleanly with an exit status of 0, either by way of the exit() system call or return from main(). It is an error to call this function before g_subprocess_wait() has returned. - + %TRUE if the process exited cleanly with a exit status of 0 + filename="gio/gsubprocess.c" + line="1106">%TRUE if the process exited cleanly with a exit status of 0 a #GSubprocess + filename="gio/gsubprocess.c" + line="1097">a #GSubprocess @@ -114982,27 +115382,26 @@ returned. c:identifier="g_subprocess_get_term_sig" version="2.40"> Get the signal number that caused the subprocess to terminate, given + filename="gio/gsubprocess.c" + line="1212">Get the signal number that caused the subprocess to terminate, given that it terminated due to a signal. This is equivalent to the system WTERMSIG macro. It is an error to call this function before g_subprocess_wait() and unless g_subprocess_get_if_signaled() returned %TRUE. - + the signal causing termination + filename="gio/gsubprocess.c" + line="1224">the signal causing termination a #GSubprocess + filename="gio/gsubprocess.c" + line="1214">a #GSubprocess @@ -115011,30 +115410,29 @@ unless g_subprocess_get_if_signaled() returned %TRUE. c:identifier="g_subprocess_send_signal" version="2.40"> Sends the UNIX signal @signal_num to the subprocess, if it is still + filename="gio/gsubprocess.c" + line="1015">Sends the UNIX signal @signal_num to the subprocess, if it is still running. This API is race-free. If the subprocess has terminated, it will not be signalled. This API is not available on Windows. - + a #GSubprocess + filename="gio/gsubprocess.c" + line="1017">a #GSubprocess the signal number to send + filename="gio/gsubprocess.c" + line="1018">the signal number to send @@ -115042,10 +115440,11 @@ This API is not available on Windows. + throws="1" + glib:async-func="wait_async"> Synchronously wait for the subprocess to terminate. + filename="gio/gsubprocess.c" + line="839">Synchronously wait for the subprocess to terminate. After the process terminates you can query its exit status with functions such as g_subprocess_get_if_exited() and @@ -115056,19 +115455,18 @@ abnormal termination. See g_subprocess_wait_check() for that. Cancelling @cancellable doesn't kill the subprocess. Call g_subprocess_force_exit() if it is desirable. - + %TRUE on success, %FALSE if @cancellable was cancelled + filename="gio/gsubprocess.c" + line="857">%TRUE on success, %FALSE if @cancellable was cancelled a #GSubprocess + filename="gio/gsubprocess.c" + line="841">a #GSubprocess nullable="1" allow-none="1"> a #GCancellable + filename="gio/gsubprocess.c" + line="842">a #GCancellable + version="2.40" + glib:finish-func="wait_finish" + glib:sync-func="wait"> Wait for the subprocess to terminate. + filename="gio/gsubprocess.c" + line="738">Wait for the subprocess to terminate. This is the asynchronous version of g_subprocess_wait(). - + a #GSubprocess + filename="gio/gsubprocess.c" + line="740">a #GSubprocess nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsubprocess.c" + line="741">a #GCancellable, or %NULL scope="async" closure="2"> a #GAsyncReadyCallback to call when the operation is complete + filename="gio/gsubprocess.c" + line="742">a #GAsyncReadyCallback to call when the operation is complete nullable="1" allow-none="1"> user_data for @callback + filename="gio/gsubprocess.c" + line="743">user_data for @callback @@ -115136,24 +115535,24 @@ This is the asynchronous version of g_subprocess_wait(). + throws="1" + glib:async-func="wait_check_async"> Combines g_subprocess_wait() with g_spawn_check_wait_status(). - + filename="gio/gsubprocess.c" + line="898">Combines g_subprocess_wait() with g_spawn_check_wait_status(). + %TRUE on success, %FALSE if process exited abnormally, or + filename="gio/gsubprocess.c" + line="906">%TRUE on success, %FALSE if process exited abnormally, or @cancellable was cancelled a #GSubprocess + filename="gio/gsubprocess.c" + line="900">a #GSubprocess nullable="1" allow-none="1"> a #GCancellable + filename="gio/gsubprocess.c" + line="901">a #GCancellable + version="2.40" + glib:finish-func="wait_check_finish" + glib:sync-func="wait_check"> Combines g_subprocess_wait_async() with g_spawn_check_wait_status(). + filename="gio/gsubprocess.c" + line="920">Combines g_subprocess_wait_async() with g_spawn_check_wait_status(). This is the asynchronous version of g_subprocess_wait_check(). - + a #GSubprocess + filename="gio/gsubprocess.c" + line="922">a #GSubprocess nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gsubprocess.c" + line="923">a #GCancellable, or %NULL scope="async" closure="2"> a #GAsyncReadyCallback to call when the operation is complete + filename="gio/gsubprocess.c" + line="924">a #GAsyncReadyCallback to call when the operation is complete nullable="1" allow-none="1"> user_data for @callback + filename="gio/gsubprocess.c" + line="925">user_data for @callback @@ -115223,28 +115623,27 @@ This is the asynchronous version of g_subprocess_wait_check(). version="2.40" throws="1"> Collects the result of a previous call to + filename="gio/gsubprocess.c" + line="942">Collects the result of a previous call to g_subprocess_wait_check_async(). - + %TRUE if successful, or %FALSE with @error set + filename="gio/gsubprocess.c" + line="951">%TRUE if successful, or %FALSE with @error set a #GSubprocess + filename="gio/gsubprocess.c" + line="944">a #GSubprocess the #GAsyncResult passed to your #GAsyncReadyCallback + filename="gio/gsubprocess.c" + line="945">the #GAsyncResult passed to your #GAsyncReadyCallback @@ -115254,47 +115653,54 @@ g_subprocess_wait_check_async(). version="2.40" throws="1"> Collects the result of a previous call to + filename="gio/gsubprocess.c" + line="787">Collects the result of a previous call to g_subprocess_wait_async(). - + %TRUE if successful, or %FALSE with @error set + filename="gio/gsubprocess.c" + line="796">%TRUE if successful, or %FALSE with @error set a #GSubprocess + filename="gio/gsubprocess.c" + line="789">a #GSubprocess the #GAsyncResult passed to your #GAsyncReadyCallback + filename="gio/gsubprocess.c" + line="790">the #GAsyncResult passed to your #GAsyncReadyCallback + Argument vector. + Subprocess flags. @@ -115304,8 +115710,8 @@ g_subprocess_wait_async(). glib:get-type="g_subprocess_flags_get_type" c:type="GSubprocessFlags"> Flags to define the behaviour of a #GSubprocess. + filename="gio/gioenums.h" + line="1995">Flags to define the behaviour of a #GSubprocess. Note that the default for stdin is to redirect from `/dev/null`. For stdout and stderr the default are for them to inherit the @@ -115320,8 +115726,8 @@ example, you may not request both %G_SUBPROCESS_FLAGS_STDOUT_PIPE and glib:nick="none" glib:name="G_SUBPROCESS_FLAGS_NONE"> No flags. + filename="gio/gioenums.h" + line="1997">No flags. create a pipe for the stdin of the + filename="gio/gioenums.h" + line="1998">create a pipe for the stdin of the spawned process that can be accessed with g_subprocess_get_stdin_pipe(). @@ -115340,8 +115746,8 @@ example, you may not request both %G_SUBPROCESS_FLAGS_STDOUT_PIPE and glib:nick="stdin-inherit" glib:name="G_SUBPROCESS_FLAGS_STDIN_INHERIT"> stdin is inherited from the + filename="gio/gioenums.h" + line="2001">stdin is inherited from the calling process. create a pipe for the stdout of the + filename="gio/gioenums.h" + line="2003">create a pipe for the stdout of the spawned process that can be accessed with g_subprocess_get_stdout_pipe(). @@ -115361,8 +115767,8 @@ example, you may not request both %G_SUBPROCESS_FLAGS_STDOUT_PIPE and glib:nick="stdout-silence" glib:name="G_SUBPROCESS_FLAGS_STDOUT_SILENCE"> silence the stdout of the spawned + filename="gio/gioenums.h" + line="2006">silence the stdout of the spawned process (ie: redirect to `/dev/null`). create a pipe for the stderr of the + filename="gio/gioenums.h" + line="2008">create a pipe for the stderr of the spawned process that can be accessed with g_subprocess_get_stderr_pipe(). @@ -115382,8 +115788,8 @@ example, you may not request both %G_SUBPROCESS_FLAGS_STDOUT_PIPE and glib:nick="stderr-silence" glib:name="G_SUBPROCESS_FLAGS_STDERR_SILENCE"> silence the stderr of the spawned + filename="gio/gioenums.h" + line="2011">silence the stderr of the spawned process (ie: redirect to `/dev/null`). merge the stderr of the spawned + filename="gio/gioenums.h" + line="2013">merge the stderr of the spawned process with whatever the stdout happens to be. This is a good way of directing both streams to a common log file, for example. @@ -115403,8 +115809,8 @@ example, you may not request both %G_SUBPROCESS_FLAGS_STDOUT_PIPE and glib:nick="inherit-fds" glib:name="G_SUBPROCESS_FLAGS_INHERIT_FDS"> spawned processes will inherit the + filename="gio/gioenums.h" + line="2016">spawned processes will inherit the file descriptors of their parent, unless those descriptors have been explicitly marked as close-on-exec. This flag has no effect over the "standard" file descriptors (stdin, stdout, stderr). @@ -115415,8 +115821,8 @@ example, you may not request both %G_SUBPROCESS_FLAGS_STDOUT_PIPE and glib:nick="search-path-from-envp" glib:name="G_SUBPROCESS_FLAGS_SEARCH_PATH_FROM_ENVP"> if path searching is + filename="gio/gioenums.h" + line="2020">if path searching is needed when spawning the subprocess, use the `PATH` in the launcher environment. (Since: 2.72) @@ -115429,12 +115835,12 @@ example, you may not request both %G_SUBPROCESS_FLAGS_STDOUT_PIPE and glib:type-name="GSubprocessLauncher" glib:get-type="g_subprocess_launcher_get_type"> This class contains a set of options for launching child processes, + filename="gio/gsubprocesslauncher.c" + line="19">This class contains a set of options for launching child processes, such as where its standard input and output will be directed, the argument list, the environment, and more. -While the #GSubprocess class has high level functions covering +While the [class@Gio.Subprocess] class has high level functions covering popular cases, use of this class allows access to more advanced options. It can also be used to launch multiple subprocesses with a similar configuration. @@ -115442,22 +115848,21 @@ a similar configuration. c:identifier="g_subprocess_launcher_new" version="2.40"> Creates a new #GSubprocessLauncher. + filename="gio/gsubprocesslauncher.c" + line="192">Creates a new #GSubprocessLauncher. The launcher is created with the default options. A copy of the environment of the calling process is made at the time of this call and will be used as the environment that the process is launched in. - + #GSubprocessFlags + filename="gio/gsubprocesslauncher.c" + line="194">#GSubprocessFlags @@ -115466,8 +115871,8 @@ and will be used as the environment that the process is launched in. c:identifier="g_subprocess_launcher_close" version="2.68"> Closes all the file descriptors previously passed to the object with + filename="gio/gsubprocesslauncher.c" + line="629">Closes all the file descriptors previously passed to the object with g_subprocess_launcher_take_fd(), g_subprocess_launcher_take_stderr_fd(), etc. After calling this method, any subsequent calls to g_subprocess_launcher_spawn() or g_subprocess_launcher_spawnv() will @@ -115477,16 +115882,15 @@ called more than once. This function is called automatically when the #GSubprocessLauncher is disposed, but is provided separately so that garbage collected language bindings can call it earlier to guarantee when FDs are closed. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="631">a #GSubprocessLauncher @@ -115495,32 +115899,31 @@ language bindings can call it earlier to guarantee when FDs are closed. c:identifier="g_subprocess_launcher_getenv" version="2.40"> Returns the value of the environment variable @variable in the + filename="gio/gsubprocesslauncher.c" + line="301">Returns the value of the environment variable @variable in the environment of processes launched from this launcher. On UNIX, the returned string can be an arbitrary byte string. On Windows, it will be UTF-8. - + the value of the environment variable, + filename="gio/gsubprocesslauncher.c" + line="312">the value of the environment variable, %NULL if unset a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="303">a #GSubprocessLauncher the environment variable to get + filename="gio/gsubprocesslauncher.c" + line="304">the environment variable to get @@ -115530,8 +115933,8 @@ On Windows, it will be UTF-8. version="2.40" introspectable="0"> Sets up a child setup function. + filename="gio/gsubprocesslauncher.c" + line="682">Sets up a child setup function. The child setup function will be called after fork() but before exec() on the child's side. @@ -115544,16 +115947,15 @@ given. %NULL can be given as @child_setup to disable the functionality. Child setup functions are only available on UNIX. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="684">a #GSubprocessLauncher closure="1" destroy="2"> a #GSpawnChildSetupFunc to use as the child setup function + filename="gio/gsubprocesslauncher.c" + line="685">a #GSpawnChildSetupFunc to use as the child setup function @@ -115572,16 +115974,16 @@ Child setup functions are only available on UNIX. nullable="1" allow-none="1"> user data for @child_setup + filename="gio/gsubprocesslauncher.c" + line="686">user data for @child_setup a #GDestroyNotify for @user_data + filename="gio/gsubprocesslauncher.c" + line="687">a #GDestroyNotify for @user_data @@ -115590,28 +115992,27 @@ Child setup functions are only available on UNIX. c:identifier="g_subprocess_launcher_set_cwd" version="2.40"> Sets the current working directory that processes will be launched + filename="gio/gsubprocesslauncher.c" + line="324">Sets the current working directory that processes will be launched with. By default processes are launched with the current working directory of the launching process at the time of launch. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="326">a #GSubprocessLauncher the cwd for launched processes + filename="gio/gsubprocesslauncher.c" + line="327">the cwd for launched processes @@ -115620,8 +116021,8 @@ of the launching process at the time of launch. c:identifier="g_subprocess_launcher_set_environ" version="2.40"> Replace the entire environment of processes launched from this + filename="gio/gsubprocesslauncher.c" + line="215">Replace the entire environment of processes launched from this launcher with the given 'environ' variable. Typically you will build this variable by using g_listenv() to copy @@ -115640,22 +116041,21 @@ etc.) before launching the subprocess. On UNIX, all strings in this array can be arbitrary byte strings. On Windows, they should be in UTF-8. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="217">a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="218"> the replacement environment @@ -115667,8 +116067,8 @@ On Windows, they should be in UTF-8. c:identifier="g_subprocess_launcher_set_flags" version="2.40"> Sets the flags on the launcher. + filename="gio/gsubprocesslauncher.c" + line="345">Sets the flags on the launcher. The default flags are %G_SUBPROCESS_FLAGS_NONE. @@ -115680,22 +116080,21 @@ handle a particular stdio stream (eg: specifying both You may also not set a flag that conflicts with a previous call to a function like g_subprocess_launcher_set_stdin_file_path() or g_subprocess_launcher_take_stdout_fd(). - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="347">a #GSubprocessLauncher #GSubprocessFlags + filename="gio/gsubprocesslauncher.c" + line="348">#GSubprocessFlags @@ -115704,8 +116103,8 @@ g_subprocess_launcher_take_stdout_fd(). c:identifier="g_subprocess_launcher_set_stderr_file_path" version="2.40"> Sets the file path to use as the stderr for spawned processes. + filename="gio/gsubprocesslauncher.c" + line="533">Sets the file path to use as the stderr for spawned processes. If @path is %NULL then any previously given path is unset. @@ -115719,16 +116118,15 @@ You may not set a stderr file path if a stderr fd is already set or if the launcher flags contain any flags directing stderr elsewhere. This feature is only available on UNIX. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="535">a #GSubprocessLauncher nullable="1" allow-none="1"> a filename or %NULL + filename="gio/gsubprocesslauncher.c" + line="536">a filename or %NULL @@ -115746,8 +116144,8 @@ This feature is only available on UNIX. c:identifier="g_subprocess_launcher_set_stdin_file_path" version="2.40"> Sets the file path to use as the stdin for spawned processes. + filename="gio/gsubprocesslauncher.c" + line="407">Sets the file path to use as the stdin for spawned processes. If @path is %NULL then any previously given path is unset. @@ -115757,20 +116155,25 @@ You may not set a stdin file path if a stdin fd is already set or if the launcher flags contain any flags directing stdin elsewhere. This feature is only available on UNIX. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="409">a #GSubprocessLauncher - - + + a filename or %NULL + @@ -115778,8 +116181,8 @@ This feature is only available on UNIX. c:identifier="g_subprocess_launcher_set_stdout_file_path" version="2.40"> Sets the file path to use as the stdout for spawned processes. + filename="gio/gsubprocesslauncher.c" + line="470">Sets the file path to use as the stdout for spawned processes. If @path is %NULL then any previously given path is unset. @@ -115790,16 +116193,15 @@ You may not set a stdout file path if a stdout fd is already set or if the launcher flags contain any flags directing stdout elsewhere. This feature is only available on UNIX. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="472">a #GSubprocessLauncher nullable="1" allow-none="1"> a filename or %NULL + filename="gio/gsubprocesslauncher.c" + line="473">a filename or %NULL @@ -115817,42 +116219,41 @@ This feature is only available on UNIX. c:identifier="g_subprocess_launcher_setenv" version="2.40"> Sets the environment variable @variable in the environment of + filename="gio/gsubprocesslauncher.c" + line="254">Sets the environment variable @variable in the environment of processes launched from this launcher. On UNIX, both the variable's name and value can be arbitrary byte strings, except that the variable's name cannot contain '='. On Windows, they should be in UTF-8. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="256">a #GSubprocessLauncher the environment variable to set, + filename="gio/gsubprocesslauncher.c" + line="257">the environment variable to set, must not contain '=' the new value for the variable + filename="gio/gsubprocesslauncher.c" + line="259">the new value for the variable whether to change the variable if it already exists + filename="gio/gsubprocesslauncher.c" + line="260">whether to change the variable if it already exists @@ -115862,39 +116263,38 @@ On Windows, they should be in UTF-8. version="2.40" introspectable="0"> Creates a #GSubprocess given a provided varargs list of arguments. - + filename="gio/gsubprocesslauncher.c" + line="720">Creates a #GSubprocess given a provided varargs list of arguments. + A new #GSubprocess, or %NULL on error (and @error will be set) + filename="gio/gsubprocesslauncher.c" + line="730">A new #GSubprocess, or %NULL on error (and @error will be set) a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="722">a #GSubprocessLauncher Error + filename="gio/gsubprocesslauncher.c" + line="723">Error Command line arguments + filename="gio/gsubprocesslauncher.c" + line="724">Command line arguments Continued arguments, %NULL terminated + filename="gio/gsubprocesslauncher.c" + line="725">Continued arguments, %NULL terminated @@ -115904,27 +116304,26 @@ On Windows, they should be in UTF-8. version="2.40" throws="1"> Creates a #GSubprocess given a provided array of arguments. - + filename="gio/gsubprocesslauncher.c" + line="764">Creates a #GSubprocess given a provided array of arguments. + A new #GSubprocess, or %NULL on error (and @error will be set) + filename="gio/gsubprocesslauncher.c" + line="773">A new #GSubprocess, or %NULL on error (and @error will be set) a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="766">a #GSubprocessLauncher Command line arguments + filename="gio/gsubprocesslauncher.c" + line="767">Command line arguments @@ -115933,8 +116332,8 @@ On Windows, they should be in UTF-8. Transfer an arbitrary file descriptor from parent process to the + filename="gio/gsubprocesslauncher.c" + line="598">Transfer an arbitrary file descriptor from parent process to the child. This function takes ownership of the @source_fd; it will be closed in the parent when @self is freed. @@ -115946,28 +116345,27 @@ descriptor in the child. An example use case is GNUPG, which has a command line argument `--passphrase-fd` providing a file descriptor number where it expects the passphrase to be written. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="600">a #GSubprocessLauncher File descriptor in parent process + filename="gio/gsubprocesslauncher.c" + line="601">File descriptor in parent process Target descriptor for child process + filename="gio/gsubprocesslauncher.c" + line="602">Target descriptor for child process @@ -115976,8 +116374,8 @@ the passphrase to be written. c:identifier="g_subprocess_launcher_take_stderr_fd" version="2.40"> Sets the file descriptor to use as the stderr for spawned processes. + filename="gio/gsubprocesslauncher.c" + line="566">Sets the file descriptor to use as the stderr for spawned processes. If @fd is -1 then any previously given fd is unset. @@ -115993,22 +116391,21 @@ You may not set a stderr fd if a stderr file path is already set or if the launcher flags contain any flags directing stderr elsewhere. This feature is only available on UNIX. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="568">a #GSubprocessLauncher a file descriptor, or -1 + filename="gio/gsubprocesslauncher.c" + line="569">a file descriptor, or -1 @@ -116017,8 +116414,8 @@ This feature is only available on UNIX. c:identifier="g_subprocess_launcher_take_stdin_fd" version="2.40"> Sets the file descriptor to use as the stdin for spawned processes. + filename="gio/gsubprocesslauncher.c" + line="436">Sets the file descriptor to use as the stdin for spawned processes. If @fd is -1 then any previously given fd is unset. @@ -116036,22 +116433,21 @@ You may not set a stdin fd if a stdin file path is already set or if the launcher flags contain any flags directing stdin elsewhere. This feature is only available on UNIX. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="438">a #GSubprocessLauncher a file descriptor, or -1 + filename="gio/gsubprocesslauncher.c" + line="439">a file descriptor, or -1 @@ -116060,8 +116456,8 @@ This feature is only available on UNIX. c:identifier="g_subprocess_launcher_take_stdout_fd" version="2.40"> Sets the file descriptor to use as the stdout for spawned processes. + filename="gio/gsubprocesslauncher.c" + line="500">Sets the file descriptor to use as the stdout for spawned processes. If @fd is -1 then any previously given fd is unset. @@ -116078,22 +116474,21 @@ You may not set a stdout fd if a stdout file path is already set or if the launcher flags contain any flags directing stdout elsewhere. This feature is only available on UNIX. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="502">a #GSubprocessLauncher a file descriptor, or -1 + filename="gio/gsubprocesslauncher.c" + line="503">a file descriptor, or -1 @@ -116102,45 +116497,47 @@ This feature is only available on UNIX. c:identifier="g_subprocess_launcher_unsetenv" version="2.40"> Removes the environment variable @variable from the environment of + filename="gio/gsubprocesslauncher.c" + line="280">Removes the environment variable @variable from the environment of processes launched from this launcher. On UNIX, the variable's name can be an arbitrary byte string not containing '='. On Windows, it should be in UTF-8. - + a #GSubprocessLauncher + filename="gio/gsubprocesslauncher.c" + line="282">a #GSubprocessLauncher the environment variable to unset, + filename="gio/gsubprocesslauncher.c" + line="283">the environment variable to unset, must not contain '=' + [flags@Gio.SubprocessFlags] for launched processes. - + @@ -116149,8 +116546,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116159,8 +116555,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116169,8 +116564,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116179,8 +116573,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116189,8 +116582,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116199,8 +116591,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116209,8 +116600,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116219,8 +116609,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116229,8 +116618,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116239,8 +116627,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116249,8 +116636,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116259,8 +116645,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116269,8 +116654,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116279,8 +116663,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116289,8 +116672,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116299,8 +116681,7 @@ containing '='. On Windows, it should be in UTF-8. - + @@ -116310,18 +116691,16 @@ containing '='. On Windows, it should be in UTF-8. value="gio-tls-backend" c:type="G_TLS_BACKEND_EXTENSION_POINT_NAME"> Extension point for TLS functionality via #GTlsBackend. See [Extending GIO][extending-gio]. - + - + @@ -116330,8 +116709,7 @@ See [Extending GIO][extending-gio]. - + @@ -116340,8 +116718,7 @@ See [Extending GIO][extending-gio]. - + @@ -116350,8 +116727,7 @@ See [Extending GIO][extending-gio]. - + @@ -116360,8 +116736,7 @@ See [Extending GIO][extending-gio]. - + @@ -116370,8 +116745,7 @@ See [Extending GIO][extending-gio]. - + @@ -116380,8 +116754,7 @@ See [Extending GIO][extending-gio]. - + @@ -116390,8 +116763,7 @@ See [Extending GIO][extending-gio]. - + @@ -116400,8 +116772,7 @@ See [Extending GIO][extending-gio]. - + @@ -116410,8 +116781,7 @@ See [Extending GIO][extending-gio]. - + @@ -116420,8 +116790,7 @@ See [Extending GIO][extending-gio]. - + @@ -116430,8 +116799,7 @@ See [Extending GIO][extending-gio]. - + @@ -116441,29 +116809,26 @@ See [Extending GIO][extending-gio]. value="1.3.6.1.5.5.7.3.2" c:type="G_TLS_DATABASE_PURPOSE_AUTHENTICATE_CLIENT"> The purpose used to verify the client certificate in a TLS connection. + filename="gio/gtlsdatabase.c" + line="102">The purpose used to verify the client certificate in a TLS connection. Used by TLS servers. - + The purpose used to verify the server certificate in a TLS connection. This + filename="gio/gtlsdatabase.c" + line="95">The purpose used to verify the server certificate in a TLS connection. This is the most common purpose in use. Used by TLS clients. - + - + @@ -116472,8 +116837,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116482,8 +116846,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116492,8 +116855,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116502,8 +116864,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116512,8 +116873,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116522,8 +116882,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116532,8 +116891,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116542,8 +116900,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116552,8 +116909,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116562,8 +116918,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116572,8 +116927,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116582,8 +116936,7 @@ is the most common purpose in use. Used by TLS clients. - + @@ -116597,515 +116950,517 @@ is the most common purpose in use. Used by TLS clients. glib:get-type="g_task_get_type" glib:type-struct="TaskClass"> A #GTask represents and manages a cancellable "task". + filename="gio/gtask.c" + line="35">A `GTask` represents and manages a cancellable ‘task’. ## Asynchronous operations -The most common usage of #GTask is as a #GAsyncResult, to +The most common usage of `GTask` is as a [iface@Gio.AsyncResult], to manage data during an asynchronous operation. You call -g_task_new() in the "start" method, followed by -g_task_set_task_data() and the like if you need to keep some +[ctor@Gio.Task.new] in the ‘start’ method, followed by +[method@Gio.Task.set_task_data] and the like if you need to keep some additional data associated with the task, and then pass the task object around through your asynchronous operation. Eventually, you will call a method such as -g_task_return_pointer() or g_task_return_error(), which will -save the value you give it and then invoke the task's callback -function in the -[thread-default main context][g-main-context-push-thread-default] +[method@Gio.Task.return_pointer] or [method@Gio.Task.return_error], which +will save the value you give it and then invoke the task’s callback +function in the thread-default main context (see +[method@GLib.MainContext.push_thread_default]) where it was created (waiting until the next iteration of the main -loop first, if necessary). The caller will pass the #GTask back to -the operation's finish function (as a #GAsyncResult), and you can -use g_task_propagate_pointer() or the like to extract the +loop first, if necessary). The caller will pass the `GTask` back to +the operation’s finish function (as a [iface@Gio.AsyncResult]), and you can +use [method@Gio.Task.propagate_pointer] or the like to extract the return value. -Using #GTask requires the thread-default #GMainContext from when the -#GTask was constructed to be running at least until the task has completed -and its data has been freed. +Using `GTask` requires the thread-default [struct@GLib.MainContext] from when +the `GTask` was constructed to be running at least until the task has +completed and its data has been freed. -If a #GTask has been constructed and its callback set, it is an error to +If a `GTask` has been constructed and its callback set, it is an error to not call `g_task_return_*()` on it. GLib will warn at runtime if this happens (since 2.76). -Here is an example for using GTask as a GAsyncResult: -|[<!-- language="C" --> - typedef struct { - CakeFrostingType frosting; - char *message; - } DecorationData; +Here is an example for using `GTask` as a [iface@Gio.AsyncResult]: +```c +typedef struct { + CakeFrostingType frosting; + char *message; +} DecorationData; + +static void +decoration_data_free (DecorationData *decoration) +{ + g_free (decoration->message); + g_slice_free (DecorationData, decoration); +} + +static void +baked_cb (Cake *cake, + gpointer user_data) +{ + GTask *task = user_data; + DecorationData *decoration = g_task_get_task_data (task); + GError *error = NULL; - static void - decoration_data_free (DecorationData *decoration) + if (cake == NULL) { - g_free (decoration->message); - g_slice_free (DecorationData, decoration); + g_task_return_new_error (task, BAKER_ERROR, BAKER_ERROR_NO_FLOUR, + "Go to the supermarket"); + g_object_unref (task); + return; } - static void - baked_cb (Cake *cake, - gpointer user_data) + if (!cake_decorate (cake, decoration->frosting, decoration->message, &error)) { - GTask *task = user_data; - DecorationData *decoration = g_task_get_task_data (task); - GError *error = NULL; + g_object_unref (cake); + // g_task_return_error() takes ownership of error + g_task_return_error (task, error); + g_object_unref (task); + return; + } - if (cake == NULL) - { - g_task_return_new_error (task, BAKER_ERROR, BAKER_ERROR_NO_FLOUR, - "Go to the supermarket"); - g_object_unref (task); - return; - } + g_task_return_pointer (task, cake, g_object_unref); + g_object_unref (task); +} - if (!cake_decorate (cake, decoration->frosting, decoration->message, &error)) - { - g_object_unref (cake); - // g_task_return_error() takes ownership of error - g_task_return_error (task, error); - g_object_unref (task); - return; - } +void +baker_bake_cake_async (Baker *self, + guint radius, + CakeFlavor flavor, + CakeFrostingType frosting, + const char *message, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) +{ + GTask *task; + DecorationData *decoration; + Cake *cake; - g_task_return_pointer (task, cake, g_object_unref); + task = g_task_new (self, cancellable, callback, user_data); + if (radius < 3) + { + g_task_return_new_error (task, BAKER_ERROR, BAKER_ERROR_TOO_SMALL, + "%ucm radius cakes are silly", + radius); g_object_unref (task); + return; } - void - baker_bake_cake_async (Baker *self, - guint radius, - CakeFlavor flavor, - CakeFrostingType frosting, - const char *message, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + cake = _baker_get_cached_cake (self, radius, flavor, frosting, message); + if (cake != NULL) { - GTask *task; - DecorationData *decoration; - Cake *cake; - - task = g_task_new (self, cancellable, callback, user_data); - if (radius < 3) - { - g_task_return_new_error (task, BAKER_ERROR, BAKER_ERROR_TOO_SMALL, - "%ucm radius cakes are silly", - radius); - g_object_unref (task); - return; - } - - cake = _baker_get_cached_cake (self, radius, flavor, frosting, message); - if (cake != NULL) - { - // _baker_get_cached_cake() returns a reffed cake - g_task_return_pointer (task, cake, g_object_unref); - g_object_unref (task); - return; - } + // _baker_get_cached_cake() returns a reffed cake + g_task_return_pointer (task, cake, g_object_unref); + g_object_unref (task); + return; + } - decoration = g_slice_new (DecorationData); - decoration->frosting = frosting; - decoration->message = g_strdup (message); - g_task_set_task_data (task, decoration, (GDestroyNotify) decoration_data_free); + decoration = g_slice_new (DecorationData); + decoration->frosting = frosting; + decoration->message = g_strdup (message); + g_task_set_task_data (task, decoration, (GDestroyNotify) decoration_data_free); - _baker_begin_cake (self, radius, flavor, cancellable, baked_cb, task); - } + _baker_begin_cake (self, radius, flavor, cancellable, baked_cb, task); +} - Cake * - baker_bake_cake_finish (Baker *self, - GAsyncResult *result, - GError **error) - { - g_return_val_if_fail (g_task_is_valid (result, self), NULL); +Cake * +baker_bake_cake_finish (Baker *self, + GAsyncResult *result, + GError **error) +{ + g_return_val_if_fail (g_task_is_valid (result, self), NULL); - return g_task_propagate_pointer (G_TASK (result), error); - } -]| + return g_task_propagate_pointer (G_TASK (result), error); +} +``` ## Chained asynchronous operations -#GTask also tries to simplify asynchronous operations that +`GTask` also tries to simplify asynchronous operations that internally chain together several smaller asynchronous -operations. g_task_get_cancellable(), g_task_get_context(), -and g_task_get_priority() allow you to get back the task's -#GCancellable, #GMainContext, and [I/O priority][io-priority] -when starting a new subtask, so you don't have to keep track -of them yourself. g_task_attach_source() simplifies the case +operations. [method@Gio.Task.get_cancellable], [method@Gio.Task.get_context], +and [method@Gio.Task.get_priority] allow you to get back the task’s +[class@Gio.Cancellable], [struct@GLib.MainContext], and +[I/O priority](iface.AsyncResult.html#io-priority) +when starting a new subtask, so you don’t have to keep track +of them yourself. [method@Gio.Task.attach_source] simplifies the case of waiting for a source to fire (automatically using the correct -#GMainContext and priority). +[struct@GLib.MainContext] and priority). Here is an example for chained asynchronous operations: - |[<!-- language="C" --> - typedef struct { - Cake *cake; - CakeFrostingType frosting; - char *message; - } BakingData; - - static void - decoration_data_free (BakingData *bd) - { - if (bd->cake) - g_object_unref (bd->cake); - g_free (bd->message); - g_slice_free (BakingData, bd); - } +```c +typedef struct { + Cake *cake; + CakeFrostingType frosting; + char *message; +} BakingData; - static void - decorated_cb (Cake *cake, - GAsyncResult *result, - gpointer user_data) - { - GTask *task = user_data; - GError *error = NULL; +static void +decoration_data_free (BakingData *bd) +{ + if (bd->cake) + g_object_unref (bd->cake); + g_free (bd->message); + g_slice_free (BakingData, bd); +} - if (!cake_decorate_finish (cake, result, &error)) - { - g_object_unref (cake); - g_task_return_error (task, error); - g_object_unref (task); - return; - } +static void +decorated_cb (Cake *cake, + GAsyncResult *result, + gpointer user_data) +{ + GTask *task = user_data; + GError *error = NULL; - // baking_data_free() will drop its ref on the cake, so we have to - // take another here to give to the caller. - g_task_return_pointer (task, g_object_ref (cake), g_object_unref); + if (!cake_decorate_finish (cake, result, &error)) + { + g_object_unref (cake); + g_task_return_error (task, error); g_object_unref (task); + return; } - static gboolean - decorator_ready (gpointer user_data) - { - GTask *task = user_data; - BakingData *bd = g_task_get_task_data (task); - - cake_decorate_async (bd->cake, bd->frosting, bd->message, - g_task_get_cancellable (task), - decorated_cb, task); + // baking_data_free() will drop its ref on the cake, so we have to + // take another here to give to the caller. + g_task_return_pointer (task, g_object_ref (cake), g_object_unref); + g_object_unref (task); +} - return G_SOURCE_REMOVE; - } +static gboolean +decorator_ready (gpointer user_data) +{ + GTask *task = user_data; + BakingData *bd = g_task_get_task_data (task); - static void - baked_cb (Cake *cake, - gpointer user_data) - { - GTask *task = user_data; - BakingData *bd = g_task_get_task_data (task); - GError *error = NULL; + cake_decorate_async (bd->cake, bd->frosting, bd->message, + g_task_get_cancellable (task), + decorated_cb, task); - if (cake == NULL) - { - g_task_return_new_error (task, BAKER_ERROR, BAKER_ERROR_NO_FLOUR, - "Go to the supermarket"); - g_object_unref (task); - return; - } + return G_SOURCE_REMOVE; +} - bd->cake = cake; +static void +baked_cb (Cake *cake, + gpointer user_data) +{ + GTask *task = user_data; + BakingData *bd = g_task_get_task_data (task); + GError *error = NULL; - // Bail out now if the user has already cancelled - if (g_task_return_error_if_cancelled (task)) - { - g_object_unref (task); - return; - } + if (cake == NULL) + { + g_task_return_new_error (task, BAKER_ERROR, BAKER_ERROR_NO_FLOUR, + "Go to the supermarket"); + g_object_unref (task); + return; + } - if (cake_decorator_available (cake)) - decorator_ready (task); - else - { - GSource *source; + bd->cake = cake; - source = cake_decorator_wait_source_new (cake); - // Attach @source to @task's GMainContext and have it call - // decorator_ready() when it is ready. - g_task_attach_source (task, source, decorator_ready); - g_source_unref (source); - } + // Bail out now if the user has already cancelled + if (g_task_return_error_if_cancelled (task)) + { + g_object_unref (task); + return; } - void - baker_bake_cake_async (Baker *self, - guint radius, - CakeFlavor flavor, - CakeFrostingType frosting, - const char *message, - gint priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + if (cake_decorator_available (cake)) + decorator_ready (task); + else { - GTask *task; - BakingData *bd; + GSource *source; - task = g_task_new (self, cancellable, callback, user_data); - g_task_set_priority (task, priority); + source = cake_decorator_wait_source_new (cake); + // Attach @source to @task’s GMainContext and have it call + // decorator_ready() when it is ready. + g_task_attach_source (task, source, decorator_ready); + g_source_unref (source); + } +} - bd = g_slice_new0 (BakingData); - bd->frosting = frosting; - bd->message = g_strdup (message); - g_task_set_task_data (task, bd, (GDestroyNotify) baking_data_free); +void +baker_bake_cake_async (Baker *self, + guint radius, + CakeFlavor flavor, + CakeFrostingType frosting, + const char *message, + gint priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) +{ + GTask *task; + BakingData *bd; - _baker_begin_cake (self, radius, flavor, cancellable, baked_cb, task); - } + task = g_task_new (self, cancellable, callback, user_data); + g_task_set_priority (task, priority); - Cake * - baker_bake_cake_finish (Baker *self, - GAsyncResult *result, - GError **error) - { - g_return_val_if_fail (g_task_is_valid (result, self), NULL); + bd = g_slice_new0 (BakingData); + bd->frosting = frosting; + bd->message = g_strdup (message); + g_task_set_task_data (task, bd, (GDestroyNotify) baking_data_free); - return g_task_propagate_pointer (G_TASK (result), error); - } -]| + _baker_begin_cake (self, radius, flavor, cancellable, baked_cb, task); +} + +Cake * +baker_bake_cake_finish (Baker *self, + GAsyncResult *result, + GError **error) +{ + g_return_val_if_fail (g_task_is_valid (result, self), NULL); + + return g_task_propagate_pointer (G_TASK (result), error); +} +``` ## Asynchronous operations from synchronous ones -You can use g_task_run_in_thread() to turn a synchronous +You can use [method@Gio.Task.run_in_thread] to turn a synchronous operation into an asynchronous one, by running it in a thread. -When it completes, the result will be dispatched to the -[thread-default main context][g-main-context-push-thread-default] -where the #GTask was created. +When it completes, the result will be dispatched to the thread-default main +context (see [method@GLib.MainContext.push_thread_default]) where the `GTask` +was created. Running a task in a thread: - |[<!-- language="C" --> - typedef struct { - guint radius; - CakeFlavor flavor; - CakeFrostingType frosting; - char *message; - } CakeData; - - static void - cake_data_free (CakeData *cake_data) - { - g_free (cake_data->message); - g_slice_free (CakeData, cake_data); - } +```c +typedef struct { + guint radius; + CakeFlavor flavor; + CakeFrostingType frosting; + char *message; +} CakeData; - static void - bake_cake_thread (GTask *task, - gpointer source_object, - gpointer task_data, - GCancellable *cancellable) - { - Baker *self = source_object; - CakeData *cake_data = task_data; - Cake *cake; - GError *error = NULL; - - cake = bake_cake (baker, cake_data->radius, cake_data->flavor, - cake_data->frosting, cake_data->message, - cancellable, &error); - if (cake) - g_task_return_pointer (task, cake, g_object_unref); - else - g_task_return_error (task, error); - } +static void +cake_data_free (CakeData *cake_data) +{ + g_free (cake_data->message); + g_slice_free (CakeData, cake_data); +} - void - baker_bake_cake_async (Baker *self, - guint radius, - CakeFlavor flavor, - CakeFrostingType frosting, - const char *message, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) - { - CakeData *cake_data; - GTask *task; - - cake_data = g_slice_new (CakeData); - cake_data->radius = radius; - cake_data->flavor = flavor; - cake_data->frosting = frosting; - cake_data->message = g_strdup (message); - task = g_task_new (self, cancellable, callback, user_data); - g_task_set_task_data (task, cake_data, (GDestroyNotify) cake_data_free); - g_task_run_in_thread (task, bake_cake_thread); - g_object_unref (task); - } +static void +bake_cake_thread (GTask *task, + gpointer source_object, + gpointer task_data, + GCancellable *cancellable) +{ + Baker *self = source_object; + CakeData *cake_data = task_data; + Cake *cake; + GError *error = NULL; + + cake = bake_cake (baker, cake_data->radius, cake_data->flavor, + cake_data->frosting, cake_data->message, + cancellable, &error); + if (cake) + g_task_return_pointer (task, cake, g_object_unref); + else + g_task_return_error (task, error); +} - Cake * - baker_bake_cake_finish (Baker *self, - GAsyncResult *result, - GError **error) - { - g_return_val_if_fail (g_task_is_valid (result, self), NULL); +void +baker_bake_cake_async (Baker *self, + guint radius, + CakeFlavor flavor, + CakeFrostingType frosting, + const char *message, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) +{ + CakeData *cake_data; + GTask *task; - return g_task_propagate_pointer (G_TASK (result), error); - } -]| + cake_data = g_slice_new (CakeData); + cake_data->radius = radius; + cake_data->flavor = flavor; + cake_data->frosting = frosting; + cake_data->message = g_strdup (message); + task = g_task_new (self, cancellable, callback, user_data); + g_task_set_task_data (task, cake_data, (GDestroyNotify) cake_data_free); + g_task_run_in_thread (task, bake_cake_thread); + g_object_unref (task); +} + +Cake * +baker_bake_cake_finish (Baker *self, + GAsyncResult *result, + GError **error) +{ + g_return_val_if_fail (g_task_is_valid (result, self), NULL); + + return g_task_propagate_pointer (G_TASK (result), error); +} +``` ## Adding cancellability to uncancellable tasks -Finally, g_task_run_in_thread() and g_task_run_in_thread_sync() -can be used to turn an uncancellable operation into a -cancellable one. If you call g_task_set_return_on_cancel(), -passing %TRUE, then if the task's #GCancellable is cancelled, -it will return control back to the caller immediately, while -allowing the task thread to continue running in the background -(and simply discarding its result when it finally does finish). +Finally, [method@Gio.Task.run_in_thread] and +[method@Gio.Task.run_in_thread_sync] can be used to turn an uncancellable +operation into a cancellable one. If you call +[method@Gio.Task.set_return_on_cancel], passing `TRUE`, then if the task’s +[class@Gio.Cancellable] is cancelled, it will return control back to the +caller immediately, while allowing the task thread to continue running in the +background (and simply discarding its result when it finally does finish). Provided that the task thread is careful about how it uses locks and other externally-visible resources, this allows you -to make "GLib-friendly" asynchronous and cancellable +to make ‘GLib-friendly’ asynchronous and cancellable synchronous variants of blocking APIs. Cancelling a task: - |[<!-- language="C" --> - static void - bake_cake_thread (GTask *task, - gpointer source_object, - gpointer task_data, - GCancellable *cancellable) +```c +static void +bake_cake_thread (GTask *task, + gpointer source_object, + gpointer task_data, + GCancellable *cancellable) +{ + Baker *self = source_object; + CakeData *cake_data = task_data; + Cake *cake; + GError *error = NULL; + + cake = bake_cake (baker, cake_data->radius, cake_data->flavor, + cake_data->frosting, cake_data->message, + &error); + if (error) { - Baker *self = source_object; - CakeData *cake_data = task_data; - Cake *cake; - GError *error = NULL; - - cake = bake_cake (baker, cake_data->radius, cake_data->flavor, - cake_data->frosting, cake_data->message, - &error); - if (error) - { - g_task_return_error (task, error); - return; - } - - // If the task has already been cancelled, then we don't want to add - // the cake to the cake cache. Likewise, we don't want to have the - // task get cancelled in the middle of updating the cache. - // g_task_set_return_on_cancel() will return %TRUE here if it managed - // to disable return-on-cancel, or %FALSE if the task was cancelled - // before it could. - if (g_task_set_return_on_cancel (task, FALSE)) - { - // If the caller cancels at this point, their - // GAsyncReadyCallback won't be invoked until we return, - // so we don't have to worry that this code will run at - // the same time as that code does. But if there were - // other functions that might look at the cake cache, - // then we'd probably need a GMutex here as well. - baker_add_cake_to_cache (baker, cake); - g_task_return_pointer (task, cake, g_object_unref); - } + g_task_return_error (task, error); + return; } - void - baker_bake_cake_async (Baker *self, - guint radius, - CakeFlavor flavor, - CakeFrostingType frosting, - const char *message, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + // If the task has already been cancelled, then we don’t want to add + // the cake to the cake cache. Likewise, we don’t want to have the + // task get cancelled in the middle of updating the cache. + // g_task_set_return_on_cancel() will return %TRUE here if it managed + // to disable return-on-cancel, or %FALSE if the task was cancelled + // before it could. + if (g_task_set_return_on_cancel (task, FALSE)) { - CakeData *cake_data; - GTask *task; + // If the caller cancels at this point, their + // GAsyncReadyCallback won’t be invoked until we return, + // so we don’t have to worry that this code will run at + // the same time as that code does. But if there were + // other functions that might look at the cake cache, + // then we’d probably need a GMutex here as well. + baker_add_cake_to_cache (baker, cake); + g_task_return_pointer (task, cake, g_object_unref); + } +} - cake_data = g_slice_new (CakeData); +void +baker_bake_cake_async (Baker *self, + guint radius, + CakeFlavor flavor, + CakeFrostingType frosting, + const char *message, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) +{ + CakeData *cake_data; + GTask *task; - ... + cake_data = g_slice_new (CakeData); - task = g_task_new (self, cancellable, callback, user_data); - g_task_set_task_data (task, cake_data, (GDestroyNotify) cake_data_free); - g_task_set_return_on_cancel (task, TRUE); - g_task_run_in_thread (task, bake_cake_thread); - } + ... - Cake * - baker_bake_cake_sync (Baker *self, - guint radius, - CakeFlavor flavor, - CakeFrostingType frosting, - const char *message, - GCancellable *cancellable, - GError **error) - { - CakeData *cake_data; - GTask *task; - Cake *cake; + task = g_task_new (self, cancellable, callback, user_data); + g_task_set_task_data (task, cake_data, (GDestroyNotify) cake_data_free); + g_task_set_return_on_cancel (task, TRUE); + g_task_run_in_thread (task, bake_cake_thread); +} - cake_data = g_slice_new (CakeData); +Cake * +baker_bake_cake_sync (Baker *self, + guint radius, + CakeFlavor flavor, + CakeFrostingType frosting, + const char *message, + GCancellable *cancellable, + GError **error) +{ + CakeData *cake_data; + GTask *task; + Cake *cake; - ... + cake_data = g_slice_new (CakeData); - task = g_task_new (self, cancellable, NULL, NULL); - g_task_set_task_data (task, cake_data, (GDestroyNotify) cake_data_free); - g_task_set_return_on_cancel (task, TRUE); - g_task_run_in_thread_sync (task, bake_cake_thread); + ... - cake = g_task_propagate_pointer (task, error); - g_object_unref (task); - return cake; - } -]| + task = g_task_new (self, cancellable, NULL, NULL); + g_task_set_task_data (task, cake_data, (GDestroyNotify) cake_data_free); + g_task_set_return_on_cancel (task, TRUE); + g_task_run_in_thread_sync (task, bake_cake_thread); + + cake = g_task_propagate_pointer (task, error); + g_object_unref (task); + return cake; +} +``` -## Porting from GSimpleAsyncResult +## Porting from [class@Gio.SimpleAsyncResult] -#GTask's API attempts to be simpler than #GSimpleAsyncResult's +`GTask`’s API attempts to be simpler than [class@Gio.SimpleAsyncResult]’s in several ways: -- You can save task-specific data with g_task_set_task_data(), and - retrieve it later with g_task_get_task_data(). This replaces the - abuse of g_simple_async_result_set_op_res_gpointer() for the same - purpose with #GSimpleAsyncResult. -- In addition to the task data, #GTask also keeps track of the - [priority][io-priority], #GCancellable, and - #GMainContext associated with the task, so tasks that consist of - a chain of simpler asynchronous operations will have easy access + +- You can save task-specific data with [method@Gio.Task.set_task_data], and + retrieve it later with [method@Gio.Task.get_task_data]. This replaces the + abuse of [method@Gio.SimpleAsyncResult.set_op_res_gpointer] for the same + purpose with [class@Gio.SimpleAsyncResult]. +- In addition to the task data, `GTask` also keeps track of the + [priority](iface.AsyncResult.html#io-priority), [class@Gio.Cancellable], + and [struct@GLib.MainContext] associated with the task, so tasks that + consist of a chain of simpler asynchronous operations will have easy access to those values when starting each sub-task. -- g_task_return_error_if_cancelled() provides simplified +- [method@Gio.Task.return_error_if_cancelled] provides simplified handling for cancellation. In addition, cancellation - overrides any other #GTask return value by default, like - #GSimpleAsyncResult does when - g_simple_async_result_set_check_cancellable() is called. - (You can use g_task_set_check_cancellable() to turn off that - behavior.) On the other hand, g_task_run_in_thread() + overrides any other `GTask` return value by default, like + [class@Gio.SimpleAsyncResult] does when + [method@Gio.SimpleAsyncResult.set_check_cancellable] is called. + (You can use [method@Gio.Task.set_check_cancellable] to turn off that + behavior.) On the other hand, [method@Gio.Task.run_in_thread] guarantees that it will always run your - `task_func`, even if the task's #GCancellable + `task_func`, even if the task’s [class@Gio.Cancellable] is already cancelled before the task gets a chance to run; you can start your `task_func` with a - g_task_return_error_if_cancelled() check if you need the + [method@Gio.Task.return_error_if_cancelled] check if you need the old behavior. -- The "return" methods (eg, g_task_return_pointer()) - automatically cause the task to be "completed" as well, and - there is no need to worry about the "complete" vs "complete - in idle" distinction. (#GTask automatically figures out - whether the task's callback can be invoked directly, or - if it needs to be sent to another #GMainContext, or delayed - until the next iteration of the current #GMainContext.) -- The "finish" functions for #GTask based operations are generally - much simpler than #GSimpleAsyncResult ones, normally consisting - of only a single call to g_task_propagate_pointer() or the like. - Since g_task_propagate_pointer() "steals" the return value from - the #GTask, it is not necessary to juggle pointers around to +- The ‘return’ methods (eg, [method@Gio.Task.return_pointer]) + automatically cause the task to be ‘completed’ as well, and + there is no need to worry about the ‘complete’ vs ‘complete in idle’ + distinction. (`GTask` automatically figures out + whether the task’s callback can be invoked directly, or + if it needs to be sent to another [struct@GLib.MainContext], or delayed + until the next iteration of the current [struct@GLib.MainContext].) +- The ‘finish’ functions for `GTask` based operations are generally + much simpler than [class@Gio.SimpleAsyncResult] ones, normally consisting + of only a single call to [method@Gio.Task.propagate_pointer] or the like. + Since [method@Gio.Task.propagate_pointer] ‘steals’ the return value from + the `GTask`, it is not necessary to juggle pointers around to prevent it from being freed twice. -- With #GSimpleAsyncResult, it was common to call - g_simple_async_result_propagate_error() from the +- With [class@Gio.SimpleAsyncResult], it was common to call + [method@Gio.SimpleAsyncResult.propagate_error] from the `_finish()` wrapper function, and have virtual method implementations only deal with successful returns. This behavior is deprecated, because it makes it - difficult for a subclass to chain to a parent class's async + difficult for a subclass to chain to a parent class’s async methods. Instead, the wrapper function should just be a simple wrapper, and the virtual method should call an appropriate `g_task_propagate_` function. Note that wrapper methods can now use - g_async_result_legacy_propagate_error() to do old-style - #GSimpleAsyncResult error-returning behavior, and - g_async_result_is_tagged() to check if a result is tagged as + [method@Gio.AsyncResult.legacy_propagate_error] to do old-style + [class@Gio.SimpleAsyncResult] error-returning behavior, and + [method@Gio.AsyncResult.is_tagged] to check if a result is tagged as having come from the `_async()` wrapper - function (for "short-circuit" results, such as when passing - 0 to g_input_stream_read_async()). + function (for ‘short-circuit’ results, such as when passing + `0` to [method@Gio.InputStream.read_async]). ## Thread-safety considerations Due to some infelicities in the API design, there is a -thread-safety concern that users of GTask have to be aware of: +thread-safety concern that users of `GTask` have to be aware of: If the `main` thread drops its last reference to the source object or the task data before the task is finalized, then the finalizers @@ -117115,17 +117470,15 @@ This is a problem if the finalizers use non-threadsafe API, and can lead to hard-to-debug crashes. Possible workarounds include: - Clear task data in a signal handler for `notify::completed` - - Keep iterating a main context in the main thread and defer dropping the reference to the source object to that main context when the task is finalized - + Creates a #GTask acting on @source_object, which will eventually be + filename="gio/gtask.c" + line="790">Creates a #GTask acting on @source_object, which will eventually be used to invoke @callback in the current [thread-default main context][g-main-context-push-thread-default]. @@ -117141,12 +117494,11 @@ simplified handling in cases where cancellation may imply that other objects that the task depends on have been destroyed. If you do not want this behavior, you can use g_task_set_check_cancellable() to change it. - + a #GTask. + filename="gio/gtask.c" + line="815">a #GTask. @@ -117155,8 +117507,8 @@ g_task_set_check_cancellable() to change it. nullable="1" allow-none="1"> the #GObject that owns + filename="gio/gtask.c" + line="792">the #GObject that owns this task, or %NULL. @@ -117165,8 +117517,8 @@ g_task_set_check_cancellable() to change it. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gtask.c" + line="794">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback. + filename="gio/gtask.c" + line="795">a #GAsyncReadyCallback. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gtask.c" + line="796">user data passed to @callback. Checks that @result is a #GTask, and that @source_object is its + filename="gio/gtask.c" + line="2335">Checks that @result is a #GTask, and that @source_object is its source object (or that @source_object is %NULL and @result has no source object). This can be used in g_return_if_fail() checks. - + %TRUE if @result and @source_object are valid, %FALSE + filename="gio/gtask.c" + line="2345">%TRUE if @result and @source_object are valid, %FALSE if not A #GAsyncResult + filename="gio/gtask.c" + line="2337">A #GAsyncResult nullable="1" allow-none="1"> the source object + filename="gio/gtask.c" + line="2338">the source object expected to be associated with the task @@ -117229,8 +117580,8 @@ if not c:identifier="g_task_report_error" version="2.36"> Creates a #GTask and then immediately calls g_task_return_error() + filename="gio/gtask.c" + line="845">Creates a #GTask and then immediately calls g_task_return_error() on it. Use this in the wrapper function of an asynchronous method when you want to avoid even calling the virtual method. You can then use g_async_result_is_tagged() in the finish method wrapper to @@ -117238,8 +117589,7 @@ check if the result there is tagged as having been created by the wrapper method, and deal with it appropriately if so. See also g_task_report_new_error(). - + @@ -117249,8 +117599,8 @@ See also g_task_report_new_error(). nullable="1" allow-none="1"> the #GObject that owns + filename="gio/gtask.c" + line="847">the #GObject that owns this task, or %NULL. @@ -117261,8 +117611,8 @@ See also g_task_report_new_error(). scope="async" closure="2"> a #GAsyncReadyCallback. + filename="gio/gtask.c" + line="849">a #GAsyncReadyCallback. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gtask.c" + line="850">user data passed to @callback. nullable="1" allow-none="1"> an opaque pointer indicating the source of this task + filename="gio/gtask.c" + line="851">an opaque pointer indicating the source of this task error to report + filename="gio/gtask.c" + line="852">error to report @@ -117296,8 +117646,8 @@ See also g_task_report_new_error(). version="2.36" introspectable="0"> Creates a #GTask and then immediately calls + filename="gio/gtask.c" + line="881">Creates a #GTask and then immediately calls g_task_return_new_error() on it. Use this in the wrapper function of an asynchronous method when you want to avoid even calling the virtual method. You can then use g_async_result_is_tagged() in the @@ -117306,8 +117656,7 @@ having been created by the wrapper method, and deal with it appropriately if so. See also g_task_report_error(). - + @@ -117317,8 +117666,8 @@ See also g_task_report_error(). nullable="1" allow-none="1"> the #GObject that owns + filename="gio/gtask.c" + line="883">the #GObject that owns this task, or %NULL. @@ -117329,8 +117678,8 @@ See also g_task_report_error(). scope="async" closure="2"> a #GAsyncReadyCallback. + filename="gio/gtask.c" + line="885">a #GAsyncReadyCallback. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gtask.c" + line="886">user data passed to @callback. nullable="1" allow-none="1"> an opaque pointer indicating the source of this task + filename="gio/gtask.c" + line="887">an opaque pointer indicating the source of this task a #GQuark. + filename="gio/gtask.c" + line="888">a #GQuark. an error code. + filename="gio/gtask.c" + line="889">an error code. a string with format characters. + filename="gio/gtask.c" + line="890">a string with format characters. a list of values to insert into @format. + filename="gio/gtask.c" + line="891">a list of values to insert into @format. @@ -117382,39 +117731,39 @@ See also g_task_report_error(). version="2.36" introspectable="0"> A utility function for dealing with async operations where you need + filename="gio/gtask.c" + line="1772">A utility function for dealing with async operations where you need to wait for a #GSource to trigger. Attaches @source to @task's -#GMainContext with @task's [priority][io-priority], and sets @source's -callback to @callback, with @task as the callback's `user_data`. +#GMainContext with @task's [priority](iface.AsyncResult.html#io-priority), +and sets @source's callback to @callback, with @task as the callback's +`user_data`. It will set the @source’s name to the task’s name (as set with g_task_set_name()), if one has been set on the task and the source doesn’t yet have a name. This takes a reference on @task until @source is destroyed. - + a #GTask + filename="gio/gtask.c" + line="1774">a #GTask the source to attach + filename="gio/gtask.c" + line="1775">the source to attach the callback to invoke when @source triggers + filename="gio/gtask.c" + line="1776">the callback to invoke when @source triggers @@ -117423,21 +117772,20 @@ This takes a reference on @task until @source is destroyed. c:identifier="g_task_get_cancellable" version="2.36"> Gets @task's #GCancellable - + filename="gio/gtask.c" + line="1262">Gets @task's #GCancellable + @task's #GCancellable + filename="gio/gtask.c" + line="1268">@task's #GCancellable a #GTask + filename="gio/gtask.c" + line="1264">a #GTask @@ -117446,19 +117794,18 @@ This takes a reference on @task until @source is destroyed. c:identifier="g_task_get_check_cancellable" version="2.36"> Gets @task's check-cancellable flag. See + filename="gio/gtask.c" + line="1280">Gets @task's check-cancellable flag. See g_task_set_check_cancellable() for more details. - + the #GTask + filename="gio/gtask.c" + line="1282">the #GTask @@ -117468,23 +117815,22 @@ g_task_set_check_cancellable() for more details. glib:get-property="completed" version="2.44"> Gets the value of #GTask:completed. This changes from %FALSE to %TRUE after + filename="gio/gtask.c" + line="2314">Gets the value of #GTask:completed. This changes from %FALSE to %TRUE after the task’s callback is invoked, and will return %FALSE if called from inside the callback. - + %TRUE if the task has completed, %FALSE otherwise. + filename="gio/gtask.c" + line="2322">%TRUE if the task has completed, %FALSE otherwise. a #GTask. + filename="gio/gtask.c" + line="2316">a #GTask. @@ -117493,48 +117839,46 @@ the callback. c:identifier="g_task_get_context" version="2.36"> Gets the #GMainContext that @task will return its result in (that + filename="gio/gtask.c" + line="1238">Gets the #GMainContext that @task will return its result in (that is, the context that was the [thread-default main context][g-main-context-push-thread-default] at the point when @task was created). This will always return a non-%NULL value, even if the task's context is the default #GMainContext. - + @task's #GMainContext + filename="gio/gtask.c" + line="1250">@task's #GMainContext a #GTask + filename="gio/gtask.c" + line="1240">a #GTask Gets @task’s name. See g_task_set_name(). - + filename="gio/gtask.c" + line="1334">Gets @task’s name. See g_task_set_name(). + @task’s name, or %NULL + filename="gio/gtask.c" + line="1340">@task’s name, or %NULL a #GTask + filename="gio/gtask.c" + line="1336">a #GTask @@ -117543,21 +117887,20 @@ context is the default #GMainContext. c:identifier="g_task_get_priority" version="2.36"> Gets @task's priority - + filename="gio/gtask.c" + line="1220">Gets @task's priority + @task's priority + filename="gio/gtask.c" + line="1226">@task's priority a #GTask + filename="gio/gtask.c" + line="1222">a #GTask @@ -117566,19 +117909,18 @@ context is the default #GMainContext. c:identifier="g_task_get_return_on_cancel" version="2.36"> Gets @task's return-on-cancel flag. See + filename="gio/gtask.c" + line="1298">Gets @task's return-on-cancel flag. See g_task_set_return_on_cancel() for more details. - + the #GTask + filename="gio/gtask.c" + line="1300">the #GTask @@ -117587,22 +117929,21 @@ g_task_set_return_on_cancel() for more details. c:identifier="g_task_get_source_object" version="2.36"> Gets the source object from @task. Like + filename="gio/gtask.c" + line="1172">Gets the source object from @task. Like g_async_result_get_source_object(), but does not ref the object. - + @task's source object, or %NULL + filename="gio/gtask.c" + line="1179">@task's source object, or %NULL a #GTask + filename="gio/gtask.c" + line="1174">a #GTask @@ -117611,21 +117952,20 @@ g_async_result_get_source_object(), but does not ref the object. c:identifier="g_task_get_source_tag" version="2.36"> Gets @task's source tag. See g_task_set_source_tag(). - + filename="gio/gtask.c" + line="1316">Gets @task's source tag. See g_task_set_source_tag(). + @task's source tag + filename="gio/gtask.c" + line="1322">@task's source tag a #GTask + filename="gio/gtask.c" + line="1318">a #GTask @@ -117634,42 +117974,40 @@ g_async_result_get_source_object(), but does not ref the object. c:identifier="g_task_get_task_data" version="2.36"> Gets @task's `task_data`. - + filename="gio/gtask.c" + line="1202">Gets @task's `task_data`. + @task's `task_data`. + filename="gio/gtask.c" + line="1208">@task's `task_data`. a #GTask + filename="gio/gtask.c" + line="1204">a #GTask Tests if @task resulted in an error. - + filename="gio/gtask.c" + line="2196">Tests if @task resulted in an error. + %TRUE if the task resulted in an error, %FALSE otherwise. + filename="gio/gtask.c" + line="2202">%TRUE if the task resulted in an error, %FALSE otherwise. a #GTask. + filename="gio/gtask.c" + line="2198">a #GTask. @@ -117679,27 +118017,26 @@ g_async_result_get_source_object(), but does not ref the object. version="2.36" throws="1"> Gets the result of @task as a #gboolean. + filename="gio/gtask.c" + line="1987">Gets the result of @task as a #gboolean. If the task resulted in an error, or was cancelled, then this will instead return %FALSE and set @error. Since this method transfers ownership of the return value (or error) to the caller, you may only call it once. - + the task result, or %FALSE on error + filename="gio/gtask.c" + line="2000">the task result, or %FALSE on error a #GTask. + filename="gio/gtask.c" + line="1989">a #GTask. @@ -117709,27 +118046,26 @@ error) to the caller, you may only call it once. version="2.36" throws="1"> Gets the result of @task as an integer (#gssize). + filename="gio/gtask.c" + line="1932">Gets the result of @task as an integer (#gssize). If the task resulted in an error, or was cancelled, then this will instead return -1 and set @error. Since this method transfers ownership of the return value (or error) to the caller, you may only call it once. - + the task result, or -1 on error + filename="gio/gtask.c" + line="1945">the task result, or -1 on error a #GTask. + filename="gio/gtask.c" + line="1934">a #GTask. @@ -117739,8 +118075,8 @@ error) to the caller, you may only call it once. version="2.36" throws="1"> Gets the result of @task as a pointer, and transfers ownership + filename="gio/gtask.c" + line="1875">Gets the result of @task as a pointer, and transfers ownership of that value to the caller. If the task resulted in an error, or was cancelled, then this will @@ -117748,19 +118084,18 @@ instead return %NULL and set @error. Since this method transfers ownership of the return value (or error) to the caller, you may only call it once. - + the task result, or %NULL on error + filename="gio/gtask.c" + line="1889">the task result, or %NULL on error a #GTask + filename="gio/gtask.c" + line="1877">a #GTask @@ -117770,8 +118105,8 @@ error) to the caller, you may only call it once. version="2.64" throws="1"> Gets the result of @task as a #GValue, and transfers ownership of + filename="gio/gtask.c" + line="2269">Gets the result of @task as a #GValue, and transfers ownership of that value to the caller. As with g_task_return_value(), this is a generic low-level method; g_task_propagate_pointer() and the like will usually be more useful for C code. @@ -117781,19 +118116,18 @@ instead set @error and return %FALSE. Since this method transfers ownership of the return value (or error) to the caller, you may only call it once. - + %TRUE if @task succeeded, %FALSE on error. + filename="gio/gtask.c" + line="2286">%TRUE if @task succeeded, %FALSE on error. a #GTask + filename="gio/gtask.c" + line="2271">a #GTask caller-allocates="1" transfer-ownership="none"> return location for the #GValue + filename="gio/gtask.c" + line="2272">return location for the #GValue @@ -117811,26 +118145,25 @@ error) to the caller, you may only call it once. c:identifier="g_task_return_boolean" version="2.36"> Sets @task's result to @result and completes the task (see + filename="gio/gtask.c" + line="1964">Sets @task's result to @result and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). - + a #GTask. + filename="gio/gtask.c" + line="1966">a #GTask. the #gboolean result of a task function. + filename="gio/gtask.c" + line="1967">the #gboolean result of a task function. @@ -117839,8 +118172,8 @@ means). c:identifier="g_task_return_error" version="2.36"> Sets @task's result to @error (which @task assumes ownership of) + filename="gio/gtask.c" + line="2019">Sets @task's result to @error (which @task assumes ownership of) and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). @@ -117850,23 +118183,23 @@ you cannot assume that @error is still valid after calling this. Call g_error_copy() on the error if you need to keep a local copy as well. -See also g_task_return_new_error(). - +See also [method@Gio.Task.return_new_error], +[method@Gio.Task.return_new_error_literal]. + a #GTask. + filename="gio/gtask.c" + line="2021">a #GTask. the #GError result of a task function. + filename="gio/gtask.c" + line="2022">the #GError result of a task function. @@ -117875,24 +118208,23 @@ See also g_task_return_new_error(). c:identifier="g_task_return_error_if_cancelled" version="2.36"> Checks if @task's #GCancellable has been cancelled, and if so, sets + filename="gio/gtask.c" + line="2160">Checks if @task's #GCancellable has been cancelled, and if so, sets @task's error accordingly and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). - + %TRUE if @task has been cancelled, %FALSE if not + filename="gio/gtask.c" + line="2169">%TRUE if @task has been cancelled, %FALSE if not a #GTask + filename="gio/gtask.c" + line="2162">a #GTask @@ -117901,26 +118233,25 @@ means). c:identifier="g_task_return_int" version="2.36"> Sets @task's result to @result and completes the task (see + filename="gio/gtask.c" + line="1909">Sets @task's result to @result and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). - + a #GTask. + filename="gio/gtask.c" + line="1911">a #GTask. the integer (#gssize) result of a task function. + filename="gio/gtask.c" + line="1912">the integer (#gssize) result of a task function. @@ -117930,57 +118261,99 @@ means). version="2.36" introspectable="0"> Sets @task's result to a new #GError created from @domain, @code, + filename="gio/gtask.c" + line="2100">Sets @task's result to a new #GError created from @domain, @code, @format, and the remaining arguments, and completes the task (see g_task_return_pointer() for more discussion of exactly what this means). See also g_task_return_error(). - + a #GTask. + filename="gio/gtask.c" + line="2102">a #GTask. a #GQuark. + filename="gio/gtask.c" + line="2103">a #GQuark. an error code. + filename="gio/gtask.c" + line="2104">an error code. a string with format characters. + filename="gio/gtask.c" + line="2105">a string with format characters. a list of values to insert into @format. + filename="gio/gtask.c" + line="2106">a list of values to insert into @format. + + Sets @task’s result to a new [type@GLib.Error] created from @domain, @code, +@message and completes the task. + +See [method@Gio.Task.return_pointer] for more discussion of exactly what +‘completing the task’ means. + +See also [method@Gio.Task.return_new_error]. + + + + + + + a #GTask. + + + + a #GQuark. + + + + an error code. + + + + an error message + + + + Sets @task's result to @result and completes the task. If @result + filename="gio/gtask.c" + line="1833">Sets @task's result to @result and completes the task. If @result is not %NULL, then @result_destroy will be used to free @result if the caller does not take ownership of it with g_task_propagate_pointer(). @@ -117998,16 +118371,15 @@ Note that since the task may be completed before returning from g_task_return_pointer(), you cannot assume that @result is still valid after calling this, unless you are still holding another reference on it. - + a #GTask + filename="gio/gtask.c" + line="1835">a #GTask nullable="1" allow-none="1"> the pointer result of a task + filename="gio/gtask.c" + line="1836">the pointer result of a task function @@ -118026,18 +118398,67 @@ reference on it. allow-none="1" scope="async"> a #GDestroyNotify function. + filename="gio/gtask.c" + line="1838">a #GDestroyNotify function. + + Sets @task's result to @error (which @task assumes ownership of), with +the message prefixed according to @format, and completes the task +(see g_task_return_pointer() for more discussion of exactly what this +means). + +Note that since the task takes ownership of @error, and since the +task may be completed before returning from g_task_return_prefixed_error(), +you cannot assume that @error is still valid after calling this. +Call g_error_copy() on the error if you need to keep a local copy +as well. + +See also g_task_return_error(), g_prefix_error(). + + + + + + + a #GTask. + + + + the #GError result of a task function. + + + + a string with format characters. + + + + a list of values to insert into @format. + + + + Sets @task's result to @result (by copying it) and completes the task. + filename="gio/gtask.c" + line="2227">Sets @task's result to @result (by copying it) and completes the task. If @result is %NULL then a #GValue of type %G_TYPE_POINTER with a value of %NULL will be used for the result. @@ -118045,16 +118466,15 @@ with a value of %NULL will be used for the result. This is a very generic low-level method intended primarily for use by language bindings; for C code, g_task_return_pointer() and the like will normally be much easier to use. - + a #GTask + filename="gio/gtask.c" + line="2229">a #GTask nullable="1" allow-none="1"> the #GValue result of + filename="gio/gtask.c" + line="2230">the #GValue result of a task function @@ -118073,8 +118493,8 @@ like will normally be much easier to use. c:identifier="g_task_run_in_thread" version="2.36"> Runs @task_func in another thread. When @task_func returns, @task's + filename="gio/gtask.c" + line="1671">Runs @task_func in another thread. When @task_func returns, @task's #GAsyncReadyCallback will be invoked in @task's #GMainContext. This takes a ref on @task until the task completes. @@ -118093,22 +118513,21 @@ and enough of them (around 10) execute in a dependency chain, as that will exhaust the thread pool. If this situation is possible, consider using a separate worker thread or thread pool explicitly, rather than using g_task_run_in_thread(). - + a #GTask + filename="gio/gtask.c" + line="1673">a #GTask a #GTaskThreadFunc + filename="gio/gtask.c" + line="1674">a #GTaskThreadFunc @@ -118117,8 +118536,8 @@ g_task_run_in_thread(). c:identifier="g_task_run_in_thread_sync" version="2.36"> Runs @task_func in another thread, and waits for it to return or be + filename="gio/gtask.c" + line="1721">Runs @task_func in another thread, and waits for it to return or be cancelled. You can use g_task_propagate_pointer(), etc, afterward to get the result of @task_func. @@ -118134,22 +118553,21 @@ g_task_run_in_thread_sync(), you should not assume that it will always do this. If you have a very large number of tasks to run, but don't want them to all run at once, you should only queue a limited number of them at a time. - + a #GTask + filename="gio/gtask.c" + line="1723">a #GTask a #GTaskThreadFunc + filename="gio/gtask.c" + line="1724">a #GTaskThreadFunc @@ -118158,8 +118576,8 @@ limited number of them at a time. c:identifier="g_task_set_check_cancellable" version="2.36"> Sets or clears @task's check-cancellable flag. If this is %TRUE + filename="gio/gtask.c" + line="978">Sets or clears @task's check-cancellable flag. If this is %TRUE (the default), then g_task_propagate_pointer(), etc, and g_task_had_error() will check the task's #GCancellable first, and if it has been cancelled, then they will consider the task to have @@ -118173,22 +118591,21 @@ via g_task_return_error_if_cancelled()). If you are using g_task_set_return_on_cancel() as well, then you must leave check-cancellable set %TRUE. - + the #GTask + filename="gio/gtask.c" + line="980">the #GTask whether #GTask will check the state of + filename="gio/gtask.c" + line="981">whether #GTask will check the state of its #GCancellable for you. @@ -118196,8 +118613,8 @@ you must leave check-cancellable set %TRUE. Sets @task’s name, used in debugging and profiling. The name defaults to + filename="gio/gtask.c" + line="1116">Sets @task’s name, used in debugging and profiling. The name defaults to %NULL. The task name should describe in a human readable way what the task does. @@ -118207,16 +118624,15 @@ name of the #GSource used for idle completion of the task. This function may only be called before the @task is first used in a thread other than the one it was constructed in. It is called automatically by g_task_set_source_tag() if not called already. - + a #GTask + filename="gio/gtask.c" + line="1118">a #GTask nullable="1" allow-none="1"> a human readable name for the task, or %NULL to unset it + filename="gio/gtask.c" + line="1119">a human readable name for the task, or %NULL to unset it @@ -118234,30 +118650,29 @@ g_task_set_source_tag() if not called already. c:identifier="g_task_set_priority" version="2.36"> Sets @task's priority. If you do not call this, it will default to + filename="gio/gtask.c" + line="952">Sets @task's priority. If you do not call this, it will default to %G_PRIORITY_DEFAULT. This will affect the priority of #GSources created with g_task_attach_source() and the scheduling of tasks run in threads, and can also be explicitly retrieved later via g_task_get_priority(). - + the #GTask + filename="gio/gtask.c" + line="954">the #GTask the [priority][io-priority] of the request + filename="gio/gtask.c" + line="955">the [priority](iface.AsyncResult.html#io-priority) of the request @@ -118266,8 +118681,8 @@ g_task_get_priority(). c:identifier="g_task_set_return_on_cancel" version="2.36"> Sets or clears @task's return-on-cancel flag. This is only + filename="gio/gtask.c" + line="1013">Sets or clears @task's return-on-cancel flag. This is only meaningful for tasks run via g_task_run_in_thread() or g_task_run_in_thread_sync(). @@ -118295,12 +118710,11 @@ If the task's #GCancellable is already cancelled before you call g_task_run_in_thread()/g_task_run_in_thread_sync(), then the #GTaskThreadFunc will still be run (for consistency), but the task will also be completed right away. - + %TRUE if @task's return-on-cancel flag was changed to + filename="gio/gtask.c" + line="1048">%TRUE if @task's return-on-cancel flag was changed to match @return_on_cancel. %FALSE if @task has already been cancelled. @@ -118308,14 +118722,14 @@ will also be completed right away. the #GTask + filename="gio/gtask.c" + line="1015">the #GTask whether the task returns automatically when + filename="gio/gtask.c" + line="1016">whether the task returns automatically when it is cancelled. @@ -118325,8 +118739,8 @@ will also be completed right away. c:identifier="g_task_set_source_tag" version="2.36"> Sets @task's source tag. + filename="gio/gtask.c" + line="1085">Sets @task's source tag. You can use this to tag a task return value with a particular pointer (usually a pointer to the function @@ -118338,16 +118752,15 @@ particular place. A macro wrapper around this function will automatically set the task’s name to the string form of @source_tag if it’s not already set, for convenience. - + the #GTask + filename="gio/gtask.c" + line="1087">the #GTask nullable="1" allow-none="1"> an opaque pointer indicating the source of this task + filename="gio/gtask.c" + line="1088">an opaque pointer indicating the source of this task @@ -118365,20 +118778,19 @@ set, for convenience. c:identifier="g_task_set_static_name" version="2.76"> Sets @task’s name, used in debugging and profiling. + filename="gio/gtask.c" + line="1149">Sets @task’s name, used in debugging and profiling. This is a variant of g_task_set_name() that avoids copying @name. - + a #GTask + filename="gio/gtask.c" + line="1151">a #GTask nullable="1" allow-none="1"> a human readable name for the task. Must be a string literal + filename="gio/gtask.c" + line="1152">a human readable name for the task. Must be a string literal @@ -118396,18 +118808,17 @@ This is a variant of g_task_set_name() that avoids copying @name. c:identifier="g_task_set_task_data" version="2.36"> Sets @task's task data (freeing the existing task data, if any). - + filename="gio/gtask.c" + line="926">Sets @task's task data (freeing the existing task data, if any). + the #GTask + filename="gio/gtask.c" + line="928">the #GTask nullable="1" allow-none="1"> task-specific data + filename="gio/gtask.c" + line="929">task-specific data allow-none="1" scope="async"> #GDestroyNotify for @task_data + filename="gio/gtask.c" + line="930">#GDestroyNotify for @task_data @@ -118437,11 +118848,20 @@ This is a variant of g_task_set_name() that avoids copying @name. getter="get_completed" default-value="FALSE"> Whether the task has completed, meaning its callback (if set) has been -invoked. This can only happen after g_task_return_pointer(), + filename="gio/gtask.c" + line="2453">Whether the task has completed, meaning its callback (if set) has been +invoked. + +This can only happen after g_task_return_pointer(), g_task_return_error() or one of the other return functions have been called -on the task. +on the task. However, it is not guaranteed to happen immediately after +those functions are called, as the task’s callback may need to be scheduled +to run in a different thread. + +That means it is **not safe** to use this property to track whether a +return function has been called on the #GTask. Callers must do that +tracking themselves, typically by linking the lifetime of the #GTask to the +control flow of their code. This property is guaranteed to change from %FALSE to %TRUE exactly once. @@ -118455,13 +118875,12 @@ context as the task’s callback, immediately after that callback is invoked. - + The prototype for a task function to be run in a thread via + filename="gio/gtask.c" + line="1460">The prototype for a task function to be run in a thread via g_task_run_in_thread() or g_task_run_in_thread_sync(). If the return-on-cancel flag is set on @task, and @cancellable gets @@ -118476,22 +118895,21 @@ g_task_set_return_on_cancel() for more details. Other than in that case, @task will be completed when the #GTaskThreadFunc returns, not when it calls a `g_task_return_` function. - + the #GTask + filename="gio/gtask.c" + line="1462">the #GTask @task's source object + filename="gio/gtask.c" + line="1463">@task's source object @task's task data + filename="gio/gtask.c" + line="1464">@task's task data @task's #GCancellable, or %NULL + filename="gio/gtask.c" + line="1465">@task's #GCancellable, or %NULL @@ -118523,32 +118941,30 @@ Other than in that case, @task will be completed when the glib:get-type="g_tcp_connection_get_type" glib:type-struct="TcpConnectionClass"> This is the subclass of #GSocketConnection that is created + filename="gio/gtcpconnection.c" + line="15">This is the subclass of [class@Gio.SocketConnection] that is created for TCP/IP sockets. - + Checks if graceful disconnects are used. See + filename="gio/gtcpconnection.c" + line="321">Checks if graceful disconnects are used. See g_tcp_connection_set_graceful_disconnect(). - + %TRUE if graceful disconnect is used on close, %FALSE otherwise + filename="gio/gtcpconnection.c" + line="328">%TRUE if graceful disconnect is used on close, %FALSE otherwise a #GTcpConnection + filename="gio/gtcpconnection.c" + line="323">a #GTcpConnection @@ -118558,8 +118974,8 @@ g_tcp_connection_set_graceful_disconnect(). glib:set-property="graceful-disconnect" version="2.22"> This enables graceful disconnects on close. A graceful disconnect + filename="gio/gtcpconnection.c" + line="292">This enables graceful disconnects on close. A graceful disconnect means that we signal the receiving end that the connection is terminated and wait for it to close the connection before closing the connection. @@ -118568,32 +118984,35 @@ all the outstanding data to the other end, or get an error reported. However, it also means we have to wait for all the data to reach the other side and for it to acknowledge this by closing the socket, which may take a while. For this reason it is disabled by default. - + a #GTcpConnection + filename="gio/gtcpconnection.c" + line="294">a #GTcpConnection Whether to do graceful disconnects or not + filename="gio/gtcpconnection.c" + line="295">Whether to do graceful disconnects or not + Whether [method@Gio.IOStream.close] does a graceful disconnect. @@ -118606,8 +119025,7 @@ take a while. For this reason it is disabled by default. - + @@ -118616,8 +119034,7 @@ take a while. For this reason it is disabled by default. c:type="GTcpConnectionPrivate" disguised="1" opaque="1"> - + glib:get-type="g_tcp_wrapper_connection_get_type" glib:type-struct="TcpWrapperConnectionClass"> A #GTcpWrapperConnection can be used to wrap a #GIOStream that is -based on a #GSocket, but which is not actually a -#GSocketConnection. This is used by #GSocketClient so that it can -always return a #GSocketConnection, even when the connection it has -actually created is not directly a #GSocketConnection. - + filename="gio/gtcpwrapperconnection.c" + line="23">A `GTcpWrapperConnection` can be used to wrap a [class@Gio.IOStream] that is +based on a [class@Gio.Socket], but which is not actually a +[class@Gio.SocketConnection]. This is used by [class@Gio.SocketClient] so +that it can always return a [class@Gio.SocketConnection], even when the +connection it has actually created is not directly a +[class@Gio.SocketConnection]. + Wraps @base_io_stream and @socket together as a #GSocketConnection. - + filename="gio/gtcpwrapperconnection.c" + line="156">Wraps @base_io_stream and @socket together as a #GSocketConnection. + the new #GSocketConnection. + filename="gio/gtcpwrapperconnection.c" + line="163">the new #GSocketConnection. the #GIOStream to wrap + filename="gio/gtcpwrapperconnection.c" + line="158">the #GIOStream to wrap the #GSocket associated with @base_io_stream + filename="gio/gtcpwrapperconnection.c" + line="159">the #GSocket associated with @base_io_stream @@ -118669,30 +119085,33 @@ actually created is not directly a #GSocketConnection. c:identifier="g_tcp_wrapper_connection_get_base_io_stream" glib:get-property="base-io-stream"> Gets @conn's base #GIOStream - + filename="gio/gtcpwrapperconnection.c" + line="183">Gets @conn's base #GIOStream + @conn's base #GIOStream + filename="gio/gtcpwrapperconnection.c" + line="189">@conn's base #GIOStream a #GTcpWrapperConnection + filename="gio/gtcpwrapperconnection.c" + line="185">a #GTcpWrapperConnection + The wrapped [class@Gio.IOStream]. @@ -118706,8 +119125,7 @@ actually created is not directly a #GSocketConnection. - + @@ -118716,8 +119134,7 @@ actually created is not directly a #GSocketConnection. c:type="GTcpWrapperConnectionPrivate" disguised="1" opaque="1"> - + glib:type-name="GTestDBus" glib:get-type="g_test_dbus_get_type"> A helper class for testing code which uses D-Bus without touching the user's + filename="gio/gtestdbus.c" + line="335">A helper class for testing code which uses D-Bus without touching the user’s session bus. -Note that #GTestDBus modifies the user’s environment, calling setenv(). -This is not thread-safe, so all #GTestDBus calls should be completed before -threads are spawned, or should have appropriate locking to ensure no access -conflicts to environment variables shared between #GTestDBus and other -threads. +Note that `GTestDBus` modifies the user’s environment, calling +[`setenv()`](man:setenv(3)). This is not thread-safe, so all `GTestDBus` +calls should be completed before threads are spawned, or should have +appropriate locking to ensure no access conflicts to environment variables +shared between `GTestDBus` and other threads. -## Creating unit tests using GTestDBus +## Creating unit tests using `GTestDBus` Testing of D-Bus services can be tricky because normally we only ever run D-Bus services over an existing instance of the D-Bus daemon thus we -usually don't activate D-Bus services that are not yet installed into the -target system. The #GTestDBus object makes this easier for us by taking care +usually don’t activate D-Bus services that are not yet installed into the +target system. The `GTestDBus` object makes this easier for us by taking care of the lower level tasks such as running a private D-Bus daemon and looking up uninstalled services in customizable locations, typically in your source code tree. @@ -118755,20 +119172,24 @@ The service file should list your service along with an absolute path to the uninstalled service executable in your source tree. Using autotools we would achieve this by adding a file such as `my-server.service.in` in the services directory and have it processed by configure. -|[ - [D-BUS Service] - Name=org.gtk.GDBus.Examples.ObjectManager - Exec=@abs_top_builddir@/gio/tests/gdbus-example-objectmanager-server -]| + +``` +[D-BUS Service] +Name=org.gtk.GDBus.Examples.ObjectManager +Exec=@abs_top_builddir@/gio/tests/gdbus-example-objectmanager-server +``` + You will also need to indicate this service directory in your test fixtures, so you will need to pass the path while compiling your test cases. Typically this is done with autotools with an added preprocessor flag specified to compile your tests such as: -|[ - -DTEST_SERVICES=\""$(abs_top_builddir)/tests/services"\" -]| - Once you have a service definition file which is local to your source tree, -you can proceed to set up a GTest fixture using the #GTestDBus scaffolding. + +``` +-DTEST_SERVICES=\""$(abs_top_builddir)/tests/services"\" +``` + +Once you have a service definition file which is local to your source tree, +you can proceed to set up a GTest fixture using the `GTestDBus` scaffolding. An example of a test fixture for D-Bus services can be found here: @@ -118777,61 +119198,62 @@ here: Note that these examples only deal with isolating the D-Bus aspect of your service. To successfully run isolated unit tests on your service you may need some additional modifications to your test case fixture. For example; if your -service uses GSettings and installs a schema then it is important that your test service -not load the schema in the ordinary installed location (chances are that your service -and schema files are not yet installed, or worse; there is an older version of the -schema file sitting in the install location). +service uses [class@Gio.Settings] and installs a schema then it is important +that your test service not load the schema in the ordinary installed location +(chances are that your service and schema files are not yet installed, or +worse; there is an older version of the schema file sitting in the install +location). Most of the time we can work around these obstacles using the environment. Since the environment is inherited by the D-Bus daemon -created by #GTestDBus and then in turn inherited by any services the +created by `GTestDBus` and then in turn inherited by any services the D-Bus daemon activates, using the setup routine for your fixture is a practical place to help sandbox your runtime environment. For the rather typical GSettings case we can work around this by setting `GSETTINGS_SCHEMA_DIR` to the in tree directory holding your schemas -in the above fixture_setup() routine. +in the above `fixture_setup()` routine. -The GSettings schemas need to be locally pre-compiled for this to work. This can be achieved -by compiling the schemas locally as a step before running test cases, an autotools setup might -do the following in the directory holding schemas: -|[ +The GSettings schemas need to be locally pre-compiled for this to work. This +can be achieved by compiling the schemas locally as a step before running +test cases, an autotools setup might do the following in the directory +holding schemas: + +``` all-am: $(GLIB_COMPILE_SCHEMAS) . CLEANFILES += gschemas.compiled -]| +``` Create a new #GTestDBus object. - + filename="gio/gtestdbus.c" + line="722">Create a new #GTestDBus object. + a new #GTestDBus. + filename="gio/gtestdbus.c" + line="728">a new #GTestDBus. a #GTestDBusFlags + filename="gio/gtestdbus.c" + line="724">a #GTestDBusFlags Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test + filename="gio/gtestdbus.c" + line="871">Unset DISPLAY and DBUS_SESSION_BUS_ADDRESS env variables to ensure the test won't use user's session bus. This is useful for unit tests that want to verify behaviour when no session bus is running. It is not necessary to call this if unit test already calls g_test_dbus_up() before acquiring the session bus. - + @@ -118839,47 +119261,45 @@ g_test_dbus_up() before acquiring the session bus. Add a path where dbus-daemon will look up .service files. This can't be + filename="gio/gtestdbus.c" + line="772">Add a path where dbus-daemon will look up .service files. This can't be called after g_test_dbus_up(). - + a #GTestDBus + filename="gio/gtestdbus.c" + line="774">a #GTestDBus path to a directory containing .service files + filename="gio/gtestdbus.c" + line="775">path to a directory containing .service files Stop the session bus started by g_test_dbus_up(). + filename="gio/gtestdbus.c" + line="838">Stop the session bus started by g_test_dbus_up(). This will wait for the singleton returned by g_bus_get() or g_bus_get_sync() to be destroyed. This is done to ensure that the next unit test won't get a leaked singleton from this test. - + a #GTestDBus + filename="gio/gtestdbus.c" + line="840">a #GTestDBus @@ -118887,23 +119307,22 @@ leaked singleton from this test. Get the address on which dbus-daemon is running. If g_test_dbus_up() has not + filename="gio/gtestdbus.c" + line="754">Get the address on which dbus-daemon is running. If g_test_dbus_up() has not been called yet, %NULL is returned. This can be used with g_dbus_connection_new_for_address(). - + the address of the bus, or %NULL. + filename="gio/gtestdbus.c" + line="762">the address of the bus, or %NULL. a #GTestDBus + filename="gio/gtestdbus.c" + line="756">a #GTestDBus @@ -118912,52 +119331,50 @@ g_dbus_connection_new_for_address(). c:identifier="g_test_dbus_get_flags" glib:get-property="flags"> Get the flags of the #GTestDBus object. - + filename="gio/gtestdbus.c" + line="738">Get the flags of the #GTestDBus object. + the value of #GTestDBus:flags property + filename="gio/gtestdbus.c" + line="744">the value of #GTestDBus:flags property a #GTestDBus + filename="gio/gtestdbus.c" + line="740">a #GTestDBus Stop the session bus started by g_test_dbus_up(). + filename="gio/gtestdbus.c" + line="818">Stop the session bus started by g_test_dbus_up(). Unlike g_test_dbus_down(), this won't verify the #GDBusConnection singleton returned by g_bus_get() or g_bus_get_sync() is destroyed. Unit tests wanting to verify behaviour after the session bus has been stopped can use this function but should still call g_test_dbus_down() when done. - + a #GTestDBus + filename="gio/gtestdbus.c" + line="820">a #GTestDBus Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this + filename="gio/gtestdbus.c" + line="790">Start a dbus-daemon instance and set DBUS_SESSION_BUS_ADDRESS. After this call, it is safe for unit tests to start sending messages on the session bus. If this function is called from setup callback of g_test_add(), @@ -118965,16 +119382,15 @@ g_test_dbus_down() must be called in its teardown callback. If this function is called from unit test's main(), then g_test_dbus_down() must be called after g_test_run(). - + a #GTestDBus + filename="gio/gtestdbus.c" + line="792">a #GTestDBus @@ -118987,8 +119403,8 @@ must be called after g_test_run(). getter="get_flags" default-value="G_TEST_DBUS_NONE"> #GTestDBusFlags specifying the behaviour of the D-Bus session. + filename="gio/gtestdbus.c" + line="528">#GTestDBusFlags specifying the behaviour of the D-Bus session. @@ -118998,16 +119414,16 @@ must be called after g_test_run(). glib:get-type="g_test_dbus_flags_get_type" c:type="GTestDBusFlags"> Flags to define future #GTestDBus behaviour. + filename="gio/gioenums.h" + line="1983">Flags to define future #GTestDBus behaviour. No flags. + filename="gio/gioenums.h" + line="1985">No flags. glib:get-type="g_themed_icon_get_type" glib:type-struct="ThemedIconClass"> #GThemedIcon is an implementation of #GIcon that supports icon themes. -#GThemedIcon contains a list of all of the icons present in an icon -theme, so that icons can be looked up quickly. #GThemedIcon does + filename="gio/gthemedicon.c" + line="33">`GThemedIcon` is an implementation of [iface@Gio.Icon] that supports icon +themes. + +`GThemedIcon` contains a list of all of the icons present in an icon +theme, so that icons can be looked up quickly. `GThemedIcon` does not provide actual pixmaps for icons, just the icon names. -Ideally something like gtk_icon_theme_choose_icon() should be used to +Ideally something like [method@Gtk.IconTheme.choose_icon] should be used to resolve the list of names so that fallback icons work nicely with themes that inherit other themes. - + Creates a new themed icon for @iconname. - + filename="gio/gthemedicon.c" + line="356">Creates a new themed icon for @iconname. + a new #GThemedIcon. + filename="gio/gthemedicon.c" + line="362">a new #GThemedIcon. a string containing an icon name. + filename="gio/gthemedicon.c" + line="358">a string containing an icon name. @@ -119053,29 +119469,28 @@ themes that inherit other themes. Creates a new themed icon for @iconnames. - + filename="gio/gthemedicon.c" + line="372">Creates a new themed icon for @iconnames. + a new #GThemedIcon + filename="gio/gthemedicon.c" + line="380">a new #GThemedIcon an array of strings containing icon names. + filename="gio/gthemedicon.c" + line="374">an array of strings containing icon names. the length of the @iconnames array, or -1 if @iconnames is + filename="gio/gthemedicon.c" + line="375">the length of the @iconnames array, or -1 if @iconnames is %NULL-terminated @@ -119084,8 +119499,8 @@ themes that inherit other themes. Creates a new themed icon for @iconname, and all the names + filename="gio/gthemedicon.c" + line="412">Creates a new themed icon for @iconname, and all the names that can be created by shortening @iconname at '-' characters. In the following example, @icon1 and @icon2 are equivalent: @@ -119100,46 +119515,44 @@ const char *names[] = { icon1 = g_themed_icon_new_from_names (names, 4); icon2 = g_themed_icon_new_with_default_fallbacks ("gnome-dev-cdrom-audio"); ]| - + a new #GThemedIcon. + filename="gio/gthemedicon.c" + line="432">a new #GThemedIcon. a string containing an icon name + filename="gio/gthemedicon.c" + line="414">a string containing an icon name Append a name to the list of icons from within @icon. + filename="gio/gthemedicon.c" + line="458">Append a name to the list of icons from within @icon. Note that doing so invalidates the hash computed by prior calls to g_icon_hash(). - + a #GThemedIcon + filename="gio/gthemedicon.c" + line="460">a #GThemedIcon name of icon to append to list of icons from within @icon. + filename="gio/gthemedicon.c" + line="461">name of icon to append to list of icons from within @icon. @@ -119148,14 +119561,13 @@ to g_icon_hash(). c:identifier="g_themed_icon_get_names" glib:get-property="names"> Gets the names of icons from within @icon. - + filename="gio/gthemedicon.c" + line="443">Gets the names of icons from within @icon. + a list of icon names. + filename="gio/gthemedicon.c" + line="449">a list of icon names. @@ -119163,8 +119575,8 @@ to g_icon_hash(). a #GThemedIcon. + filename="gio/gthemedicon.c" + line="445">a #GThemedIcon. @@ -119173,27 +119585,26 @@ to g_icon_hash(). c:identifier="g_themed_icon_prepend_name" version="2.18"> Prepend a name to the list of icons from within @icon. + filename="gio/gthemedicon.c" + line="485">Prepend a name to the list of icons from within @icon. Note that doing so invalidates the hash computed by prior calls to g_icon_hash(). - + a #GThemedIcon + filename="gio/gthemedicon.c" + line="487">a #GThemedIcon name of icon to prepend to list of icons from within @icon. + filename="gio/gthemedicon.c" + line="488">name of icon to prepend to list of icons from within @icon. @@ -119205,8 +119616,8 @@ to g_icon_hash(). transfer-ownership="none" default-value="NULL"> The icon name. + filename="gio/gthemedicon.c" + line="176">The icon name. transfer-ownership="none" getter="get_names"> A %NULL-terminated array of icon names. + filename="gio/gthemedicon.c" + line="186">A %NULL-terminated array of icon names. @@ -119227,8 +119638,8 @@ to g_icon_hash(). transfer-ownership="none" default-value="FALSE"> Whether to use the default fallbacks found by shortening the icon name + filename="gio/gthemedicon.c" + line="196">Whether to use the default fallbacks found by shortening the icon name at '-' characters. If the "names" array has more than one element, ignores any past the first. @@ -119251,8 +119662,29 @@ would become disguised="1" opaque="1" glib:is-gtype-struct-for="ThemedIcon"> - + + + + #GThreadedResolver is an implementation of #GResolver which calls the libc +lookup functions in threads to allow them to run asynchronously. + + + + + + + A #GThreadedSocketService is a simple subclass of #GSocketService + filename="gio/gthreadedsocketservice.c" + line="25">A `GThreadedSocketService` is a simple subclass of [class@Gio.SocketService] that handles incoming connections by creating a worker thread and dispatching the connection to it by emitting the -#GThreadedSocketService::run signal in the new thread. +[signal@Gio.ThreadedSocketService::run signal] in the new thread. -The signal handler may perform blocking IO and need not return +The signal handler may perform blocking I/O and need not return until the connection is closed. The service is implemented using a thread pool, so there is a limited amount of threads available to serve incoming requests. -The service automatically stops the #GSocketService from accepting +The service automatically stops the [class@Gio.SocketService] from accepting new connections when all threads are busy. -As with #GSocketService, you may connect to #GThreadedSocketService::run, -or subclass and override the default handler. - +As with [class@Gio.SocketService], you may connect to +[signal@Gio.ThreadedSocketService::run], or subclass and override the default +handler. + Creates a new #GThreadedSocketService with no listeners. Listeners + filename="gio/gthreadedsocketservice.c" + line="265">Creates a new #GThreadedSocketService with no listeners. Listeners must be added with one of the #GSocketListener "add" methods. - + a new #GSocketService. + filename="gio/gthreadedsocketservice.c" + line="273">a new #GSocketService. the maximal number of threads to execute concurrently + filename="gio/gthreadedsocketservice.c" + line="267">the maximal number of threads to execute concurrently handling incoming clients, -1 means no limit - + @@ -119326,10 +119756,14 @@ must be added with one of the #GSocketListener "add" methods. + The maximum number of threads handling clients for this service. @@ -119341,22 +119775,22 @@ must be added with one of the #GSocketListener "add" methods. The ::run signal is emitted in a worker thread in response to an + filename="gio/gthreadedsocketservice.c" + line="226">The ::run signal is emitted in a worker thread in response to an incoming connection. This thread is dedicated to handling @connection and may perform blocking IO. The signal handler need not return until the connection is closed. %TRUE to stop further signal handlers from being called + filename="gio/gthreadedsocketservice.c" + line="237">%TRUE to stop further signal handlers from being called a new #GSocketConnection object. + filename="gio/gthreadedsocketservice.c" + line="229">a new #GSocketConnection object. nullable="1" allow-none="1"> the source_object passed to g_socket_listener_add_address(). + filename="gio/gthreadedsocketservice.c" + line="230">the source_object passed to g_socket_listener_add_address(). @@ -119374,15 +119808,13 @@ not return until the connection is closed. - + - + @@ -119402,8 +119834,7 @@ not return until the connection is closed. - + @@ -119411,8 +119842,7 @@ not return until the connection is closed. - + @@ -119420,8 +119850,7 @@ not return until the connection is closed. - + @@ -119429,8 +119858,7 @@ not return until the connection is closed. - + @@ -119438,8 +119866,7 @@ not return until the connection is closed. - + @@ -119450,8 +119877,7 @@ not return until the connection is closed. c:type="GThreadedSocketServicePrivate" disguised="1" opaque="1"> - + glib:get-type="g_tls_authentication_mode_get_type" c:type="GTlsAuthenticationMode"> The client authentication mode for a #GTlsServerConnection. + filename="gio/gioenums.h" + line="1646">The client authentication mode for a #GTlsServerConnection. client authentication not required + filename="gio/gioenums.h" + line="1648">client authentication not required glib:nick="requested" glib:name="G_TLS_AUTHENTICATION_REQUESTED"> client authentication is requested + filename="gio/gioenums.h" + line="1649">client authentication is requested glib:nick="required" glib:name="G_TLS_AUTHENTICATION_REQUIRED"> client authentication is required + filename="gio/gioenums.h" + line="1650">client authentication is required glib:get-type="g_tls_backend_get_type" glib:type-struct="TlsBackendInterface"> TLS (Transport Layer Security, aka SSL) and DTLS backend. - + filename="gio/gtlsbackend.c" + line="31">TLS (Transport Layer Security, aka SSL) and DTLS backend. This is an +internal type used to coordinate the different classes implemented +by a TLS backend. + Gets the default #GTlsBackend for the system. - + filename="gio/gtlsbackend.c" + line="53">Gets the default #GTlsBackend for the system. + a #GTlsBackend, which will be a + filename="gio/gtlsbackend.c" + line="58">a #GTlsBackend, which will be a dummy object if no TLS backend is available @@ -119521,22 +119947,21 @@ not return until the connection is closed. invoker="get_default_database" version="2.30"> Gets the default #GTlsDatabase used to verify TLS connections. - + filename="gio/gtlsbackend.c" + line="122">Gets the default #GTlsDatabase used to verify TLS connections. + the default database, which should be + filename="gio/gtlsbackend.c" + line="128">the default database, which should be unreffed when done. the #GTlsBackend + filename="gio/gtlsbackend.c" + line="124">the #GTlsBackend @@ -119545,22 +119970,21 @@ not return until the connection is closed. invoker="supports_dtls" version="2.48"> Checks if DTLS is supported. DTLS support may not be available even if TLS + filename="gio/gtlsbackend.c" + line="102">Checks if DTLS is supported. DTLS support may not be available even if TLS support is available, and vice-versa. - + whether DTLS is supported + filename="gio/gtlsbackend.c" + line="109">whether DTLS is supported the #GTlsBackend + filename="gio/gtlsbackend.c" + line="104">the #GTlsBackend @@ -119569,22 +119993,21 @@ support is available, and vice-versa. invoker="supports_tls" version="2.28"> Checks if TLS is supported; if this returns %FALSE for the default + filename="gio/gtlsbackend.c" + line="80">Checks if TLS is supported; if this returns %FALSE for the default #GTlsBackend, it means no "real" TLS backend is available. - + whether or not TLS is supported + filename="gio/gtlsbackend.c" + line="87">whether or not TLS is supported the #GTlsBackend + filename="gio/gtlsbackend.c" + line="82">the #GTlsBackend @@ -119593,22 +120016,21 @@ support is available, and vice-versa. c:identifier="g_tls_backend_get_certificate_type" version="2.28"> Gets the #GType of @backend's #GTlsCertificate implementation. - + filename="gio/gtlsbackend.c" + line="182">Gets the #GType of @backend's #GTlsCertificate implementation. + the #GType of @backend's #GTlsCertificate + filename="gio/gtlsbackend.c" + line="188">the #GType of @backend's #GTlsCertificate implementation. the #GTlsBackend + filename="gio/gtlsbackend.c" + line="184">the #GTlsBackend @@ -119617,22 +120039,21 @@ support is available, and vice-versa. c:identifier="g_tls_backend_get_client_connection_type" version="2.28"> Gets the #GType of @backend's #GTlsClientConnection implementation. - + filename="gio/gtlsbackend.c" + line="199">Gets the #GType of @backend's #GTlsClientConnection implementation. + the #GType of @backend's #GTlsClientConnection + filename="gio/gtlsbackend.c" + line="205">the #GType of @backend's #GTlsClientConnection implementation. the #GTlsBackend + filename="gio/gtlsbackend.c" + line="201">the #GTlsBackend @@ -119641,22 +120062,21 @@ support is available, and vice-versa. c:identifier="g_tls_backend_get_default_database" version="2.30"> Gets the default #GTlsDatabase used to verify TLS connections. - + filename="gio/gtlsbackend.c" + line="122">Gets the default #GTlsDatabase used to verify TLS connections. + the default database, which should be + filename="gio/gtlsbackend.c" + line="128">the default database, which should be unreffed when done. the #GTlsBackend + filename="gio/gtlsbackend.c" + line="124">the #GTlsBackend @@ -119665,22 +120085,21 @@ support is available, and vice-versa. c:identifier="g_tls_backend_get_dtls_client_connection_type" version="2.48"> Gets the #GType of @backend’s #GDtlsClientConnection implementation. - + filename="gio/gtlsbackend.c" + line="233">Gets the #GType of @backend’s #GDtlsClientConnection implementation. + the #GType of @backend’s #GDtlsClientConnection + filename="gio/gtlsbackend.c" + line="239">the #GType of @backend’s #GDtlsClientConnection implementation, or %G_TYPE_INVALID if this backend doesn’t support DTLS. the #GTlsBackend + filename="gio/gtlsbackend.c" + line="235">the #GTlsBackend @@ -119689,22 +120108,21 @@ support is available, and vice-versa. c:identifier="g_tls_backend_get_dtls_server_connection_type" version="2.48"> Gets the #GType of @backend’s #GDtlsServerConnection implementation. - + filename="gio/gtlsbackend.c" + line="258">Gets the #GType of @backend’s #GDtlsServerConnection implementation. + the #GType of @backend’s #GDtlsServerConnection + filename="gio/gtlsbackend.c" + line="264">the #GType of @backend’s #GDtlsServerConnection implementation, or %G_TYPE_INVALID if this backend doesn’t support DTLS. the #GTlsBackend + filename="gio/gtlsbackend.c" + line="260">the #GTlsBackend @@ -119713,21 +120131,20 @@ support is available, and vice-versa. c:identifier="g_tls_backend_get_file_database_type" version="2.30"> Gets the #GType of @backend's #GTlsFileDatabase implementation. - + filename="gio/gtlsbackend.c" + line="283">Gets the #GType of @backend's #GTlsFileDatabase implementation. + the #GType of backend's #GTlsFileDatabase implementation. + filename="gio/gtlsbackend.c" + line="289">the #GType of backend's #GTlsFileDatabase implementation. the #GTlsBackend + filename="gio/gtlsbackend.c" + line="285">the #GTlsBackend @@ -119736,22 +120153,21 @@ support is available, and vice-versa. c:identifier="g_tls_backend_get_server_connection_type" version="2.28"> Gets the #GType of @backend's #GTlsServerConnection implementation. - + filename="gio/gtlsbackend.c" + line="216">Gets the #GType of @backend's #GTlsServerConnection implementation. + the #GType of @backend's #GTlsServerConnection + filename="gio/gtlsbackend.c" + line="222">the #GType of @backend's #GTlsServerConnection implementation. the #GTlsBackend + filename="gio/gtlsbackend.c" + line="218">the #GTlsBackend @@ -119760,8 +120176,8 @@ support is available, and vice-versa. c:identifier="g_tls_backend_set_default_database" version="2.60"> Set the default #GTlsDatabase used to verify TLS connections + filename="gio/gtlsbackend.c" + line="154">Set the default #GTlsDatabase used to verify TLS connections Any subsequent call to g_tls_backend_get_default_database() will return the database set in this call. Existing databases and connections are not @@ -119769,16 +120185,15 @@ modified. Setting a %NULL default database will reset to using the system default database as if g_tls_backend_set_default_database() had never been called. - + the #GTlsBackend + filename="gio/gtlsbackend.c" + line="156">the #GTlsBackend nullable="1" allow-none="1"> the #GTlsDatabase + filename="gio/gtlsbackend.c" + line="157">the #GTlsDatabase @@ -119796,22 +120211,21 @@ database as if g_tls_backend_set_default_database() had never been called. c:identifier="g_tls_backend_supports_dtls" version="2.48"> Checks if DTLS is supported. DTLS support may not be available even if TLS + filename="gio/gtlsbackend.c" + line="102">Checks if DTLS is supported. DTLS support may not be available even if TLS support is available, and vice-versa. - + whether DTLS is supported + filename="gio/gtlsbackend.c" + line="109">whether DTLS is supported the #GTlsBackend + filename="gio/gtlsbackend.c" + line="104">the #GTlsBackend @@ -119820,22 +120234,21 @@ support is available, and vice-versa. c:identifier="g_tls_backend_supports_tls" version="2.28"> Checks if TLS is supported; if this returns %FALSE for the default + filename="gio/gtlsbackend.c" + line="80">Checks if TLS is supported; if this returns %FALSE for the default #GTlsBackend, it means no "real" TLS backend is available. - + whether or not TLS is supported + filename="gio/gtlsbackend.c" + line="87">whether or not TLS is supported the #GTlsBackend + filename="gio/gtlsbackend.c" + line="82">the #GTlsBackend @@ -119846,126 +120259,143 @@ support is available, and vice-versa. glib:is-gtype-struct-for="TlsBackend" version="2.28"> Provides an interface for describing TLS-related types. - + The parent interface. + returns whether the backend supports TLS. - + whether or not TLS is supported + filename="gio/gtlsbackend.c" + line="87">whether or not TLS is supported the #GTlsBackend + filename="gio/gtlsbackend.c" + line="82">the #GTlsBackend + returns the #GTlsCertificate implementation type - + + returns the #GTlsClientConnection implementation type - + + returns the #GTlsServerConnection implementation type - + + returns the #GTlsFileDatabase implementation type. - + + returns a default #GTlsDatabase instance. - + the default database, which should be + filename="gio/gtlsbackend.c" + line="128">the default database, which should be unreffed when done. the #GTlsBackend + filename="gio/gtlsbackend.c" + line="124">the #GTlsBackend + returns whether the backend supports DTLS - + whether DTLS is supported + filename="gio/gtlsbackend.c" + line="109">whether DTLS is supported the #GTlsBackend + filename="gio/gtlsbackend.c" + line="104">the #GTlsBackend + returns the #GDtlsClientConnection implementation type - + + returns the #GDtlsServerConnection implementation type - + @@ -119982,21 +120412,20 @@ support is available, and vice-versa. glib:get-type="g_tls_certificate_get_type" glib:type-struct="TlsCertificateClass"> A certificate used for TLS authentication and encryption. + filename="gio/gtlscertificate.c" + line="31">A certificate used for TLS authentication and encryption. This can represent either a certificate only (eg, the certificate received by a client from a server), or the combination of a certificate and a private key (which is needed when acting as a -#GTlsServerConnection). - +[iface@Gio.TlsServerConnection]). + Creates a #GTlsCertificate from the data in @file. + filename="gio/gtlscertificate.c" + line="814">Creates a #GTlsCertificate from the data in @file. As of 2.72, if the filename ends in `.p12` or `.pfx` the data is loaded by g_tls_certificate_new_from_pkcs12() otherwise it is loaded by @@ -120005,19 +120434,18 @@ exact details. If @file cannot be read or parsed, the function will return %NULL and set @error. - + the new certificate, or %NULL on error + filename="gio/gtlscertificate.c" + line="829">the new certificate, or %NULL on error file containing a certificate to import + filename="gio/gtlscertificate.c" + line="816">file containing a certificate to import @@ -120027,8 +120455,8 @@ set @error. version="2.72" throws="1"> Creates a #GTlsCertificate from the data in @file. + filename="gio/gtlscertificate.c" + line="766">Creates a #GTlsCertificate from the data in @file. If @file cannot be read or parsed, the function will return %NULL and set @error. @@ -120036,25 +120464,24 @@ set @error. Any unknown file types will error with %G_IO_ERROR_NOT_SUPPORTED. Currently only `.p12` and `.pfx` files are supported. See g_tls_certificate_new_from_pkcs12() for more details. - + the new certificate, or %NULL on error + filename="gio/gtlscertificate.c" + line="781">the new certificate, or %NULL on error file containing a certificate to import + filename="gio/gtlscertificate.c" + line="768">file containing a certificate to import password for PKCS #12 files + filename="gio/gtlscertificate.c" + line="769">password for PKCS #12 files @@ -120064,8 +120491,8 @@ See g_tls_certificate_new_from_pkcs12() for more details. version="2.28" throws="1"> Creates a #GTlsCertificate from the PEM-encoded data in @cert_file + filename="gio/gtlscertificate.c" + line="856">Creates a #GTlsCertificate from the PEM-encoded data in @cert_file and @key_file. The returned certificate will be the first certificate found in @cert_file. As of GLib 2.44, if @cert_file contains more certificates it will try to load a certificate chain. All @@ -120079,26 +120506,25 @@ still be returned. If either file cannot be read or parsed, the function will return %NULL and set @error. Otherwise, this behaves like g_tls_certificate_new_from_pem(). - + the new certificate, or %NULL on error + filename="gio/gtlscertificate.c" + line="879">the new certificate, or %NULL on error file containing one or more PEM-encoded + filename="gio/gtlscertificate.c" + line="858">file containing one or more PEM-encoded certificates to import file containing a PEM-encoded private key + filename="gio/gtlscertificate.c" + line="860">file containing a PEM-encoded private key to import @@ -120109,8 +120535,8 @@ g_tls_certificate_new_from_pem(). version="2.28" throws="1"> Creates a #GTlsCertificate from the PEM-encoded data in @data. If + filename="gio/gtlscertificate.c" + line="642">Creates a #GTlsCertificate from the PEM-encoded data in @data. If @data includes both a certificate and a private key, then the returned certificate will include the private key data as well. (See the #GTlsCertificate:private-key-pem property for information about @@ -120124,25 +120550,24 @@ file) and the #GTlsCertificate:issuer property of each certificate will be set accordingly if the verification succeeds. If any certificate in the chain cannot be verified, the first certificate in the file will still be returned. - + the new certificate, or %NULL if @data is invalid + filename="gio/gtlscertificate.c" + line="663">the new certificate, or %NULL if @data is invalid PEM-encoded certificate data + filename="gio/gtlscertificate.c" + line="644">PEM-encoded certificate data the length of @data, or -1 if it's 0-terminated. + filename="gio/gtlscertificate.c" + line="645">the length of @data, or -1 if it's 0-terminated. @@ -120152,8 +120577,8 @@ the file will still be returned. version="2.68" throws="1"> Creates a #GTlsCertificate from a + filename="gio/gtlscertificate.c" + line="913">Creates a #GTlsCertificate from a [PKCS \#11](https://docs.oasis-open.org/pkcs11/pkcs11-base/v3.0/os/pkcs11-base-v3.0-os.html) URI. An example @pkcs11_uri would be `pkcs11:model=Model;manufacturer=Manufacture;serial=1;token=My%20Client%20Certificate;id=%01` @@ -120177,19 +120602,18 @@ In this case the certificate and private key would both be detected and used as @private_key_pkcs11_uri allows using a private key exposed under a different URI. Note that the private key is not accessed until usage and may fail or require a PIN later. - + the new certificate, or %NULL on error + filename="gio/gtlscertificate.c" + line="944">the new certificate, or %NULL on error A PKCS \#11 URI + filename="gio/gtlscertificate.c" + line="915">A PKCS \#11 URI A PKCS \#11 URI + filename="gio/gtlscertificate.c" + line="916">A PKCS \#11 URI @@ -120208,8 +120632,8 @@ Note that the private key is not accessed until usage and may fail or require a version="2.72" throws="1"> Creates a #GTlsCertificate from the data in @data. It must contain + filename="gio/gtlscertificate.c" + line="695">Creates a #GTlsCertificate from the data in @data. It must contain a certificate and matching private key. If extra certificates are included they will be verified as a chain @@ -120226,27 +120650,26 @@ If support is missing it will error with %G_IO_ERROR_NOT_SUPPORTED. Other parsing failures will error with %G_TLS_ERROR_BAD_CERTIFICATE. - + the new certificate, or %NULL if @data is invalid + filename="gio/gtlscertificate.c" + line="720">the new certificate, or %NULL if @data is invalid DER-encoded PKCS #12 format certificate data + filename="gio/gtlscertificate.c" + line="697">DER-encoded PKCS #12 format certificate data the length of @data + filename="gio/gtlscertificate.c" + line="698">the length of @data nullable="1" allow-none="1"> optional password for encrypted certificate data + filename="gio/gtlscertificate.c" + line="699">optional password for encrypted certificate data @@ -120265,18 +120688,17 @@ Other parsing failures will error with %G_TLS_ERROR_BAD_CERTIFICATE. version="2.28" throws="1"> Creates one or more #GTlsCertificates from the PEM-encoded + filename="gio/gtlscertificate.c" + line="985">Creates one or more #GTlsCertificates from the PEM-encoded data in @file. If @file cannot be read or parsed, the function will return %NULL and set @error. If @file does not contain any PEM-encoded certificates, this will return an empty list and not set @error. - + a + filename="gio/gtlscertificate.c" + line="996">a #GList containing #GTlsCertificate objects. You must free the list and its contents when you are done with it. @@ -120286,16 +120708,16 @@ and its contents when you are done with it. file containing PEM-encoded certificates to import + filename="gio/gtlscertificate.c" + line="987">file containing PEM-encoded certificates to import This verifies @cert and returns a set of #GTlsCertificateFlags + filename="gio/gtlscertificate.c" + line="1070">This verifies @cert and returns a set of #GTlsCertificateFlags indicating any problems found with it. This can be used to verify a certificate outside the context of making a connection, or to check a certificate against a CA that is not part of the system @@ -120328,19 +120750,18 @@ For example, certificate constraints may not be honored, and revocation checks may not be performed. The best way to verify TLS certificates used by a TLS connection is to let #GTlsConnection handle the verification. - + the appropriate #GTlsCertificateFlags + filename="gio/gtlscertificate.c" + line="1110">the appropriate #GTlsCertificateFlags a #GTlsCertificate + filename="gio/gtlscertificate.c" + line="1072">a #GTlsCertificate nullable="1" allow-none="1"> the expected peer identity + filename="gio/gtlscertificate.c" + line="1073">the expected peer identity nullable="1" allow-none="1"> the certificate of a trusted authority + filename="gio/gtlscertificate.c" + line="1074">the certificate of a trusted authority @@ -120368,14 +120789,13 @@ handle the verification. glib:get-property="dns-names" version="2.70"> Gets the value of #GTlsCertificate:dns-names. - + filename="gio/gtlscertificate.c" + line="1248">Gets the value of #GTlsCertificate:dns-names. + A #GPtrArray of + filename="gio/gtlscertificate.c" + line="1254">A #GPtrArray of #GBytes elements, or %NULL if it's not available. @@ -120384,8 +120804,8 @@ handle the verification. a #GTlsCertificate + filename="gio/gtlscertificate.c" + line="1250">a #GTlsCertificate @@ -120395,14 +120815,13 @@ handle the verification. glib:get-property="ip-addresses" version="2.70"> Gets the value of #GTlsCertificate:ip-addresses. - + filename="gio/gtlscertificate.c" + line="1271">Gets the value of #GTlsCertificate:ip-addresses. + A #GPtrArray + filename="gio/gtlscertificate.c" + line="1277">A #GPtrArray of #GInetAddress elements, or %NULL if it's not available. @@ -120411,8 +120830,8 @@ of #GInetAddress elements, or %NULL if it's not available. a #GTlsCertificate + filename="gio/gtlscertificate.c" + line="1273">a #GTlsCertificate @@ -120422,14 +120841,13 @@ of #GInetAddress elements, or %NULL if it's not available. glib:get-property="issuer" version="2.28"> Gets the #GTlsCertificate representing @cert's issuer, if known - + filename="gio/gtlscertificate.c" + line="1046">Gets the #GTlsCertificate representing @cert's issuer, if known + The certificate of @cert's issuer, + filename="gio/gtlscertificate.c" + line="1052">The certificate of @cert's issuer, or %NULL if @cert is self-signed or signed with an unknown certificate. @@ -120437,8 +120855,8 @@ certificate. a #GTlsCertificate + filename="gio/gtlscertificate.c" + line="1048">a #GTlsCertificate @@ -120448,21 +120866,20 @@ certificate. glib:get-property="issuer-name" version="2.70"> Returns the issuer name from the certificate. - + filename="gio/gtlscertificate.c" + line="1226">Returns the issuer name from the certificate. + The issuer name, or %NULL if it's not available. + filename="gio/gtlscertificate.c" + line="1232">The issuer name, or %NULL if it's not available. a #GTlsCertificate + filename="gio/gtlscertificate.c" + line="1228">a #GTlsCertificate @@ -120472,21 +120889,20 @@ certificate. glib:get-property="not-valid-after" version="2.70"> Returns the time at which the certificate became or will become invalid. - + filename="gio/gtlscertificate.c" + line="1182">Returns the time at which the certificate became or will become invalid. + The not-valid-after date, or %NULL if it's not available. + filename="gio/gtlscertificate.c" + line="1188">The not-valid-after date, or %NULL if it's not available. a #GTlsCertificate + filename="gio/gtlscertificate.c" + line="1184">a #GTlsCertificate @@ -120496,21 +120912,20 @@ certificate. glib:get-property="not-valid-before" version="2.70"> Returns the time at which the certificate became or will become valid. - + filename="gio/gtlscertificate.c" + line="1160">Returns the time at which the certificate became or will become valid. + The not-valid-before date, or %NULL if it's not available. + filename="gio/gtlscertificate.c" + line="1166">The not-valid-before date, or %NULL if it's not available. a #GTlsCertificate + filename="gio/gtlscertificate.c" + line="1162">a #GTlsCertificate @@ -120520,21 +120935,20 @@ certificate. glib:get-property="subject-name" version="2.70"> Returns the subject name from the certificate. - + filename="gio/gtlscertificate.c" + line="1204">Returns the subject name from the certificate. + The subject name, or %NULL if it's not available. + filename="gio/gtlscertificate.c" + line="1210">The subject name, or %NULL if it's not available. a #GTlsCertificate + filename="gio/gtlscertificate.c" + line="1206">a #GTlsCertificate @@ -120543,31 +120957,30 @@ certificate. c:identifier="g_tls_certificate_is_same" version="2.34"> Check if two #GTlsCertificate objects represent the same certificate. + filename="gio/gtlscertificate.c" + line="1122">Check if two #GTlsCertificate objects represent the same certificate. The raw DER byte data of the two certificates are checked for equality. This has the effect that two certificates may compare equal even if their #GTlsCertificate:issuer, #GTlsCertificate:private-key, or #GTlsCertificate:private-key-pem properties differ. - + whether the same or not + filename="gio/gtlscertificate.c" + line="1133">whether the same or not first certificate to compare + filename="gio/gtlscertificate.c" + line="1124">first certificate to compare second certificate to compare + filename="gio/gtlscertificate.c" + line="1125">second certificate to compare @@ -120576,8 +120989,8 @@ their #GTlsCertificate:issuer, #GTlsCertificate:private-key, or c:identifier="g_tls_certificate_verify" version="2.28"> This verifies @cert and returns a set of #GTlsCertificateFlags + filename="gio/gtlscertificate.c" + line="1070">This verifies @cert and returns a set of #GTlsCertificateFlags indicating any problems found with it. This can be used to verify a certificate outside the context of making a connection, or to check a certificate against a CA that is not part of the system @@ -120610,19 +121023,18 @@ For example, certificate constraints may not be honored, and revocation checks may not be performed. The best way to verify TLS certificates used by a TLS connection is to let #GTlsConnection handle the verification. - + the appropriate #GTlsCertificateFlags + filename="gio/gtlscertificate.c" + line="1110">the appropriate #GTlsCertificateFlags a #GTlsCertificate + filename="gio/gtlscertificate.c" + line="1072">a #GTlsCertificate nullable="1" allow-none="1"> the expected peer identity + filename="gio/gtlscertificate.c" + line="1073">the expected peer identity nullable="1" allow-none="1"> the certificate of a trusted authority + filename="gio/gtlscertificate.c" + line="1074">the certificate of a trusted authority @@ -120651,8 +121063,8 @@ handle the verification. construct-only="1" transfer-ownership="none"> The DER (binary) encoded representation of the certificate. + filename="gio/gtlscertificate.c" + line="157">The DER (binary) encoded representation of the certificate. This property and the #GTlsCertificate:certificate-pem property represent the same data, just in different forms. @@ -120666,8 +121078,8 @@ represent the same data, just in different forms. transfer-ownership="none" default-value="NULL"> The PEM (ASCII) encoded representation of the certificate. + filename="gio/gtlscertificate.c" + line="172">The PEM (ASCII) encoded representation of the certificate. This property and the #GTlsCertificate:certificate property represent the same data, just in different forms. @@ -120677,8 +121089,8 @@ property represent the same data, just in different forms. transfer-ownership="container" getter="get_dns_names"> The DNS names from the certificate's Subject Alternative Names (SANs), + filename="gio/gtlscertificate.c" + line="363">The DNS names from the certificate's Subject Alternative Names (SANs), %NULL if unavailable. @@ -120689,8 +121101,8 @@ property represent the same data, just in different forms. transfer-ownership="container" getter="get_ip_addresses"> The IP addresses from the certificate's Subject Alternative Names (SANs), + filename="gio/gtlscertificate.c" + line="377">The IP addresses from the certificate's Subject Alternative Names (SANs), %NULL if unavailable. @@ -120703,8 +121115,8 @@ property represent the same data, just in different forms. transfer-ownership="none" getter="get_issuer"> A #GTlsCertificate representing the entity that issued this + filename="gio/gtlscertificate.c" + line="246">A #GTlsCertificate representing the entity that issued this certificate. If %NULL, this means that the certificate is either self-signed, or else the certificate of the issuer is not available. @@ -120728,8 +121140,8 @@ GLib itself should make security decisions about TLS certificates. getter="get_issuer_name" default-value="NULL"> The issuer from the certificate, + filename="gio/gtlscertificate.c" + line="349">The issuer from the certificate, %NULL if unavailable. @@ -120738,8 +121150,8 @@ GLib itself should make security decisions about TLS certificates. transfer-ownership="none" getter="get_not_valid_after"> The time at which this cert is no longer valid, + filename="gio/gtlscertificate.c" + line="322">The time at which this cert is no longer valid, %NULL if unavailable. @@ -120748,8 +121160,8 @@ GLib itself should make security decisions about TLS certificates. transfer-ownership="none" getter="get_not_valid_before"> The time at which this cert is considered to be valid, + filename="gio/gtlscertificate.c" + line="308">The time at which this cert is considered to be valid, %NULL if unavailable. @@ -120761,8 +121173,8 @@ GLib itself should make security decisions about TLS certificates. transfer-ownership="none" default-value="NULL"> An optional password used when constructed with GTlsCertificate:pkcs12-data. + filename="gio/gtlscertificate.c" + line="144">An optional password used when constructed with GTlsCertificate:pkcs12-data. transfer-ownership="none" default-value="NULL"> A URI referencing the [PKCS \#11](https://docs.oasis-open.org/pkcs11/pkcs11-base/v3.0/os/pkcs11-base-v3.0-os.html) + filename="gio/gtlscertificate.c" + line="275">A URI referencing the [PKCS \#11](https://docs.oasis-open.org/pkcs11/pkcs11-base/v3.0/os/pkcs11-base-v3.0-os.html) objects containing an X.509 certificate and optionally a private key. If %NULL, the certificate is either not backed by PKCS \#11 or the @@ -120787,8 +121199,8 @@ If %NULL, the certificate is either not backed by PKCS \#11 or the construct-only="1" transfer-ownership="none"> The PKCS #12 formatted data used to construct the object. + filename="gio/gtlscertificate.c" + line="128">The PKCS #12 formatted data used to construct the object. See also: g_tls_certificate_new_from_pkcs12() @@ -120801,8 +121213,8 @@ See also: g_tls_certificate_new_from_pkcs12() construct-only="1" transfer-ownership="none"> The DER (binary) encoded representation of the certificate's + filename="gio/gtlscertificate.c" + line="187">The DER (binary) encoded representation of the certificate's private key, in either [PKCS \#1 format](https://datatracker.ietf.org/doc/html/rfc8017) or unencrypted [PKCS \#8 format.](https://datatracker.ietf.org/doc/html/rfc5208) PKCS \#8 format is supported since 2.32; earlier releases only @@ -120830,8 +121242,8 @@ PKCS \#8. transfer-ownership="none" default-value="NULL"> The PEM (ASCII) encoded representation of the certificate's + filename="gio/gtlscertificate.c" + line="216">The PEM (ASCII) encoded representation of the certificate's private key in either [PKCS \#1 format](https://datatracker.ietf.org/doc/html/rfc8017) ("`BEGIN RSA PRIVATE KEY`") or unencrypted [PKCS \#8 format](https://datatracker.ietf.org/doc/html/rfc5208) @@ -120858,8 +121270,8 @@ PKCS \#8. transfer-ownership="none" default-value="NULL"> A URI referencing a [PKCS \#11](https://docs.oasis-open.org/pkcs11/pkcs11-base/v3.0/os/pkcs11-base-v3.0-os.html) + filename="gio/gtlscertificate.c" + line="293">A URI referencing a [PKCS \#11](https://docs.oasis-open.org/pkcs11/pkcs11-base/v3.0/os/pkcs11-base-v3.0-os.html) object containing a private key. @@ -120869,8 +121281,8 @@ object containing a private key. getter="get_subject_name" default-value="NULL"> The subject from the cert, + filename="gio/gtlscertificate.c" + line="336">The subject from the cert, %NULL if unavailable. @@ -120884,26 +121296,24 @@ object containing a private key. - + - + the appropriate #GTlsCertificateFlags + filename="gio/gtlscertificate.c" + line="1110">the appropriate #GTlsCertificateFlags a #GTlsCertificate + filename="gio/gtlscertificate.c" + line="1072">a #GTlsCertificate nullable="1" allow-none="1"> the expected peer identity + filename="gio/gtlscertificate.c" + line="1073">the expected peer identity nullable="1" allow-none="1"> the certificate of a trusted authority + filename="gio/gtlscertificate.c" + line="1074">the certificate of a trusted authority @@ -120939,8 +121349,8 @@ object containing a private key. glib:get-type="g_tls_certificate_flags_get_type" c:type="GTlsCertificateFlags"> A set of flags describing TLS certification validation. This can be + filename="gio/gioenums.h" + line="1600">A set of flags describing TLS certification validation. This can be used to describe why a particular certificate was rejected (for example, in #GTlsConnection::accept-certificate). @@ -120957,8 +121367,8 @@ other problems exist with the certificate. glib:nick="no-flags" glib:name="G_TLS_CERTIFICATE_NO_FLAGS"> No flags set. Since: 2.74 + filename="gio/gioenums.h" + line="1602">No flags set. Since: 2.74 glib:nick="unknown-ca" glib:name="G_TLS_CERTIFICATE_UNKNOWN_CA"> The signing certificate authority is + filename="gio/gioenums.h" + line="1603">The signing certificate authority is not known. glib:nick="bad-identity" glib:name="G_TLS_CERTIFICATE_BAD_IDENTITY"> The certificate does not match the + filename="gio/gioenums.h" + line="1605">The certificate does not match the expected identity of the site that it was retrieved from. glib:nick="not-activated" glib:name="G_TLS_CERTIFICATE_NOT_ACTIVATED"> The certificate's activation time + filename="gio/gioenums.h" + line="1607">The certificate's activation time is still in the future glib:nick="expired" glib:name="G_TLS_CERTIFICATE_EXPIRED"> The certificate has expired + filename="gio/gioenums.h" + line="1609">The certificate has expired glib:nick="revoked" glib:name="G_TLS_CERTIFICATE_REVOKED"> The certificate has been revoked + filename="gio/gioenums.h" + line="1610">The certificate has been revoked according to the #GTlsConnection's certificate revocation list. glib:nick="insecure" glib:name="G_TLS_CERTIFICATE_INSECURE"> The certificate's algorithm is + filename="gio/gioenums.h" + line="1612">The certificate's algorithm is considered insecure. glib:nick="generic-error" glib:name="G_TLS_CERTIFICATE_GENERIC_ERROR"> Some other error occurred validating + filename="gio/gioenums.h" + line="1614">Some other error occurred validating the certificate glib:nick="validate-all" glib:name="G_TLS_CERTIFICATE_VALIDATE_ALL"> the combination of all of the above + filename="gio/gioenums.h" + line="1616">the combination of all of the above flags @@ -121044,8 +121454,7 @@ other problems exist with the certificate. c:type="GTlsCertificatePrivate" disguised="1" opaque="1"> - + glib:get-type="g_tls_certificate_request_flags_get_type" c:type="GTlsCertificateRequestFlags"> Flags for g_tls_interaction_request_certificate(), + filename="gio/gioenums.h" + line="1858">Flags for g_tls_interaction_request_certificate(), g_tls_interaction_request_certificate_async(), and g_tls_interaction_invoke_request_certificate(). glib:nick="none" glib:name="G_TLS_CERTIFICATE_REQUEST_NONE"> No flags + filename="gio/gioenums.h" + line="1860">No flags c:type="GTlsChannelBindingError" glib:error-domain="g-tls-channel-binding-error-quark"> An error code used with %G_TLS_CHANNEL_BINDING_ERROR in a #GError to + filename="gio/gioenums.h" + line="1688">An error code used with %G_TLS_CHANNEL_BINDING_ERROR in a #GError to indicate a TLS channel binding retrieval error. glib:nick="not-implemented" glib:name="G_TLS_CHANNEL_BINDING_ERROR_NOT_IMPLEMENTED"> Either entire binding + filename="gio/gioenums.h" + line="1690">Either entire binding retrieval facility or specific binding type is not implemented in the TLS backend. @@ -121094,8 +121503,8 @@ indicate a TLS channel binding retrieval error. glib:nick="invalid-state" glib:name="G_TLS_CHANNEL_BINDING_ERROR_INVALID_STATE"> The handshake is not yet + filename="gio/gioenums.h" + line="1693">The handshake is not yet complete on the connection which is a strong requirement for any existing binding type. @@ -121105,8 +121514,8 @@ indicate a TLS channel binding retrieval error. glib:nick="not-available" glib:name="G_TLS_CHANNEL_BINDING_ERROR_NOT_AVAILABLE"> Handshake is complete but + filename="gio/gioenums.h" + line="1696">Handshake is complete but binding data is not available. That normally indicates the TLS implementation failed to provide the binding data. For example, some implementations do not provide a peer certificate for resumed connections. @@ -121117,8 +121526,8 @@ indicate a TLS channel binding retrieval error. glib:nick="not-supported" glib:name="G_TLS_CHANNEL_BINDING_ERROR_NOT_SUPPORTED"> Binding type is not supported + filename="gio/gioenums.h" + line="1700">Binding type is not supported on the current connection. This error could be triggered when requesting `tls-server-end-point` binding data for a certificate which has no hash function or uses multiple hash functions. @@ -121129,20 +121538,20 @@ indicate a TLS channel binding retrieval error. glib:nick="general-error" glib:name="G_TLS_CHANNEL_BINDING_ERROR_GENERAL_ERROR"> Any other backend error + filename="gio/gioenums.h" + line="1704">Any other backend error preventing binding data retrieval. Gets the TLS channel binding error quark. + filename="gio/gtlsconnection.c" + line="868">Gets the TLS channel binding error quark. a #GQuark. + filename="gio/gtlsconnection.c" + line="873">a #GQuark. @@ -121153,8 +121562,8 @@ indicate a TLS channel binding retrieval error. glib:get-type="g_tls_channel_binding_type_get_type" c:type="GTlsChannelBindingType"> The type of TLS channel binding data to retrieve from #GTlsConnection + filename="gio/gioenums.h" + line="1662">The type of TLS channel binding data to retrieve from #GTlsConnection or #GDtlsConnection, as documented by RFC 5929 or RFC 9266. The [`tls-unique-for-telnet`](https://tools.ietf.org/html/rfc5929#section-5) binding type is not currently implemented. @@ -121164,8 +121573,8 @@ binding type is not currently implemented. glib:nick="unique" glib:name="G_TLS_CHANNEL_BINDING_TLS_UNIQUE"> [`tls-unique`](https://tools.ietf.org/html/rfc5929#section-3) binding + filename="gio/gioenums.h" + line="1664">[`tls-unique`](https://tools.ietf.org/html/rfc5929#section-3) binding type glib:nick="server-end-point" glib:name="G_TLS_CHANNEL_BINDING_TLS_SERVER_END_POINT"> [`tls-server-end-point`](https://tools.ietf.org/html/rfc5929#section-4) + filename="gio/gioenums.h" + line="1667">[`tls-server-end-point`](https://tools.ietf.org/html/rfc5929#section-4) binding type glib:nick="exporter" glib:name="G_TLS_CHANNEL_BINDING_TLS_EXPORTER"> [`tls-exporter`](https://www.rfc-editor.org/rfc/rfc9266.html) binding + filename="gio/gioenums.h" + line="1670">[`tls-exporter`](https://www.rfc-editor.org/rfc/rfc9266.html) binding type. Since: 2.74 @@ -121197,39 +121606,37 @@ binding type is not currently implemented. glib:get-type="g_tls_client_connection_get_type" glib:type-struct="TlsClientConnectionInterface"> #GTlsClientConnection is the client-side subclass of -#GTlsConnection, representing a client-side TLS connection. - + filename="gio/gtlsclientconnection.c" + line="33">`GTlsClientConnection` is the client-side subclass of +[class@Gio.TlsConnection], representing a client-side TLS connection. + Creates a new #GTlsClientConnection wrapping @base_io_stream (which + filename="gio/gtlsclientconnection.c" + line="144">Creates a new #GTlsClientConnection wrapping @base_io_stream (which must have pollable input and output streams) which is assumed to communicate with the server identified by @server_identity. See the documentation for #GTlsConnection:base-io-stream for restrictions on when application code can run operations on the @base_io_stream after this function has returned. - + the new + filename="gio/gtlsclientconnection.c" + line="158">the new #GTlsClientConnection, or %NULL on error the #GIOStream to wrap + filename="gio/gtlsclientconnection.c" + line="146">the #GIOStream to wrap nullable="1" allow-none="1"> the expected identity of the server + filename="gio/gtlsclientconnection.c" + line="147">the expected identity of the server @@ -121247,8 +121654,8 @@ this function has returned. invoker="copy_session_state" version="2.46"> Possibly copies session state from one connection to another, for use + filename="gio/gtlsclientconnection.c" + line="361">Possibly copies session state from one connection to another, for use in TLS session resumption. This is not normally needed, but may be used when the same session needs to be used between different endpoints, as is required by some protocols, such as FTP over TLS. @@ -121276,22 +121683,21 @@ from the server, provided a ticket is available that has not previously been used for session resumption, since session ticket reuse would be a privacy weakness. Using this function causes the ticket to be copied without regard for privacy considerations. - + a #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="363">a #GTlsClientConnection a #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="364">a #GTlsClientConnection @@ -121300,8 +121706,8 @@ ticket to be copied without regard for privacy considerations. c:identifier="g_tls_client_connection_copy_session_state" version="2.46"> Possibly copies session state from one connection to another, for use + filename="gio/gtlsclientconnection.c" + line="361">Possibly copies session state from one connection to another, for use in TLS session resumption. This is not normally needed, but may be used when the same session needs to be used between different endpoints, as is required by some protocols, such as FTP over TLS. @@ -121329,22 +121735,21 @@ from the server, provided a ticket is available that has not previously been used for session resumption, since session ticket reuse would be a privacy weakness. Using this function causes the ticket to be copied without regard for privacy considerations. - + a #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="363">a #GTlsClientConnection a #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="364">a #GTlsClientConnection @@ -121354,20 +121759,19 @@ ticket to be copied without regard for privacy considerations. glib:get-property="accepted-cas" version="2.28"> Gets the list of distinguished names of the Certificate Authorities + filename="gio/gtlsclientconnection.c" + line="332">Gets the list of distinguished names of the Certificate Authorities that the server will accept certificates from. This will be set during the TLS handshake if the server requests a certificate. Otherwise, it will be %NULL. Each item in the list is a #GByteArray which contains the complete subject DN of the certificate authority. - + the list of + filename="gio/gtlsclientconnection.c" + line="344">the list of CA DNs. You should unref each element with g_byte_array_unref() and then the free the list with g_list_free(). @@ -121379,8 +121783,8 @@ the free the list with g_list_free(). the #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="334">the #GTlsClientConnection @@ -121390,14 +121794,13 @@ the free the list with g_list_free(). glib:get-property="server-identity" version="2.28"> Gets @conn's expected server identity - + filename="gio/gtlsclientconnection.c" + line="233">Gets @conn's expected server identity + a #GSocketConnectable describing the + filename="gio/gtlsclientconnection.c" + line="239">a #GSocketConnectable describing the expected server identity, or %NULL if the expected identity is not known. @@ -121405,8 +121808,8 @@ known. the #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="235">the #GTlsClientConnection @@ -121418,23 +121821,22 @@ known. deprecated="1" deprecated-version="2.56"> SSL 3.0 is no longer supported. See + filename="gio/gtlsclientconnection.c" + line="279">SSL 3.0 is no longer supported. See g_tls_client_connection_set_use_ssl3() for details. SSL 3.0 is insecure. - + %FALSE + filename="gio/gtlsclientconnection.c" + line="286">%FALSE the #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="281">the #GTlsClientConnection @@ -121446,26 +121848,25 @@ g_tls_client_connection_set_use_ssl3() for details. deprecated="1" deprecated-version="2.72"> Gets @conn's validation flags + filename="gio/gtlsclientconnection.c" + line="180">Gets @conn's validation flags This function does not work as originally designed and is impossible to use correctly. See #GTlsClientConnection:validation-flags for more information. Do not attempt to ignore validation errors. - + the validation flags + filename="gio/gtlsclientconnection.c" + line="190">the validation flags the #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="182">the #GTlsClientConnection @@ -121475,27 +121876,26 @@ information. glib:set-property="server-identity" version="2.28"> Sets @conn's expected server identity, which is used both to tell + filename="gio/gtlsclientconnection.c" + line="258">Sets @conn's expected server identity, which is used both to tell servers on virtual hosts which certificate to present, and also to let @conn know what name to look for in the certificate when performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. - + the #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="260">the #GTlsClientConnection a #GSocketConnectable describing the expected server identity + filename="gio/gtlsclientconnection.c" + line="261">a #GSocketConnectable describing the expected server identity @@ -121507,8 +121907,8 @@ performing %G_TLS_CERTIFICATE_BAD_IDENTITY validation, if enabled. deprecated="1" deprecated-version="2.56"> Since GLib 2.42.1, SSL 3.0 is no longer supported. + filename="gio/gtlsclientconnection.c" + line="303">Since GLib 2.42.1, SSL 3.0 is no longer supported. From GLib 2.42.1 through GLib 2.62, this function could be used to force use of TLS 1.0, the lowest-supported TLS protocol version at @@ -121519,22 +121919,21 @@ acceptable. Since GLib 2.64, this function does nothing. SSL 3.0 is insecure. - + the #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="305">the #GTlsClientConnection a #gboolean, ignored + filename="gio/gtlsclientconnection.c" + line="306">a #gboolean, ignored @@ -121546,8 +121945,8 @@ Since GLib 2.64, this function does nothing. deprecated="1" deprecated-version="2.72"> Sets @conn's validation flags, to override the default set of + filename="gio/gtlsclientconnection.c" + line="207">Sets @conn's validation flags, to override the default set of checks performed when validating a server certificate. By default, %G_TLS_CERTIFICATE_VALIDATE_ALL is used. @@ -121555,22 +121954,21 @@ This function does not work as originally designed and is impossible to use correctly. See #GTlsClientConnection:validation-flags for more information. Do not attempt to ignore validation errors. - + the #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="209">the #GTlsClientConnection the #GTlsCertificateFlags to use + filename="gio/gtlsclientconnection.c" + line="210">the #GTlsCertificateFlags to use @@ -121580,8 +121978,8 @@ information. transfer-ownership="none" getter="get_accepted_cas"> A list of the distinguished names of the Certificate Authorities + filename="gio/gtlsclientconnection.c" + line="125">A list of the distinguished names of the Certificate Authorities that the server will accept client certificates signed by. If the server requests a client certificate during the handshake, then this property will be set after the handshake completes. @@ -121600,8 +121998,8 @@ subject DN of the certificate authority. setter="set_server_identity" getter="get_server_identity"> A #GSocketConnectable describing the identity of the server that + filename="gio/gtlsclientconnection.c" + line="80">A #GSocketConnectable describing the identity of the server that is expected on the other end of the connection. If the %G_TLS_CERTIFICATE_BAD_IDENTITY flag is set in @@ -121628,8 +122026,8 @@ virtual hosts. getter="get_use_ssl3" default-value="FALSE"> SSL 3.0 is no longer supported. See + filename="gio/gtlsclientconnection.c" + line="107">SSL 3.0 is no longer supported. See g_tls_client_connection_set_use_ssl3() for details. SSL 3.0 is insecure. @@ -121645,8 +122043,8 @@ g_tls_client_connection_set_use_ssl3() for details. getter="get_validation_flags" default-value="G_TLS_CERTIFICATE_UNKNOWN_CA | G_TLS_CERTIFICATE_BAD_IDENTITY | G_TLS_CERTIFICATE_NOT_ACTIVATED | G_TLS_CERTIFICATE_EXPIRED | G_TLS_CERTIFICATE_REVOKED | G_TLS_CERTIFICATE_INSECURE | G_TLS_CERTIFICATE_GENERIC_ERROR"> What steps to perform when validating a certificate received from + filename="gio/gtlsclientconnection.c" + line="47">What steps to perform when validating a certificate received from a server. Server certificates that fail to validate in any of the ways indicated here will be rejected unless the application overrides the default via #GTlsConnection::accept-certificate. @@ -121671,34 +122069,35 @@ connect to #GTlsConnection::accept-certificate. glib:is-gtype-struct-for="TlsClientConnection" version="2.26"> vtable for a #GTlsClientConnection implementation. - + The parent interface. + Copies session state from one #GTlsClientConnection to another. - + a #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="363">a #GTlsClientConnection a #GTlsClientConnection + filename="gio/gtlsclientconnection.c" + line="364">a #GTlsClientConnection @@ -121715,18 +122114,20 @@ connect to #GTlsConnection::accept-certificate. glib:get-type="g_tls_connection_get_type" glib:type-struct="TlsConnectionClass"> #GTlsConnection is the base TLS connection class type, which wraps -a #GIOStream and provides TLS encryption on top of it. Its -subclasses, #GTlsClientConnection and #GTlsServerConnection, -implement client-side and server-side TLS, respectively. + filename="gio/gtlsconnection.c" + line="36">`GTlsConnection` is the base TLS connection class type, which wraps +a [class@Gio.IOStream] and provides TLS encryption on top of it. Its +subclasses, [iface@Gio.TlsClientConnection] and +[iface@Gio.TlsServerConnection], implement client-side and server-side TLS, +respectively. -For DTLS (Datagram TLS) support, see #GDtlsConnection. - +For DTLS (Datagram TLS) support, see [iface@Gio.DtlsConnection]. + - + Check whether to accept a certificate. + @@ -121743,8 +122144,10 @@ For DTLS (Datagram TLS) support, see #GDtlsConnection. - + Retrieve TLS channel binding data (Since: 2.66) + @@ -121767,27 +122170,26 @@ For DTLS (Datagram TLS) support, see #GDtlsConnection. invoker="get_negotiated_protocol" version="2.60"> Gets the name of the application-layer protocol negotiated during + filename="gio/gtlsconnection.c" + line="838">Gets the name of the application-layer protocol negotiated during the handshake. If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of @conn's protocols, or the TLS backend does not support ALPN, then this will be %NULL. See g_tls_connection_set_advertised_protocols(). - + the negotiated protocol, or %NULL + filename="gio/gtlsconnection.c" + line="850">the negotiated protocol, or %NULL a #GTlsConnection + filename="gio/gtlsconnection.c" + line="840">a #GTlsConnection @@ -121795,10 +122197,11 @@ g_tls_connection_set_advertised_protocols(). + throws="1" + glib:async-func="handshake_async"> Attempts a TLS handshake on @conn. + filename="gio/gtlsconnection.c" + line="928">Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -121829,19 +122232,18 @@ function manually is not recommended. #GTlsConnection::accept_certificate may be emitted during the handshake. - + success or failure + filename="gio/gtlsconnection.c" + line="966">success or failure a #GTlsConnection + filename="gio/gtlsconnection.c" + line="930">a #GTlsConnection nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsconnection.c" + line="931">a #GCancellable, or %NULL + version="2.28" + glib:finish-func="handshake_finish" + glib:sync-func="handshake"> Asynchronously performs a TLS handshake on @conn. See + filename="gio/gtlsconnection.c" + line="980">Asynchronously performs a TLS handshake on @conn. See g_tls_connection_handshake() for more information. - + a #GTlsConnection + filename="gio/gtlsconnection.c" + line="982">a #GTlsConnection the [I/O priority][io-priority] of the request + filename="gio/gtlsconnection.c" + line="983">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsconnection.c" + line="984">a #GCancellable, or %NULL scope="async" closure="3"> callback to call when the handshake is complete + filename="gio/gtlsconnection.c" + line="985">callback to call when the handshake is complete allow-none="1" closure="3"> the data to pass to the callback function + filename="gio/gtlsconnection.c" + line="986">the data to pass to the callback function @@ -121917,29 +122320,28 @@ g_tls_connection_handshake() for more information. version="2.28" throws="1"> Finish an asynchronous TLS handshake operation. See + filename="gio/gtlsconnection.c" + line="1007">Finish an asynchronous TLS handshake operation. See g_tls_connection_handshake() for more information. - + %TRUE on success, %FALSE on failure, in which + filename="gio/gtlsconnection.c" + line="1016">%TRUE on success, %FALSE on failure, in which case @error will be set. a #GTlsConnection + filename="gio/gtlsconnection.c" + line="1009">a #GTlsConnection a #GAsyncResult. + filename="gio/gtlsconnection.c" + line="1010">a #GAsyncResult. @@ -121948,35 +122350,34 @@ case @error will be set. c:identifier="g_tls_connection_emit_accept_certificate" version="2.28"> Used by #GTlsConnection implementations to emit the + filename="gio/gtlsconnection.c" + line="1105">Used by #GTlsConnection implementations to emit the #GTlsConnection::accept-certificate signal. - + %TRUE if one of the signal handlers has returned + filename="gio/gtlsconnection.c" + line="1114">%TRUE if one of the signal handlers has returned %TRUE to accept @peer_cert a #GTlsConnection + filename="gio/gtlsconnection.c" + line="1107">a #GTlsConnection the peer's #GTlsCertificate + filename="gio/gtlsconnection.c" + line="1108">the peer's #GTlsCertificate the problems with @peer_cert + filename="gio/gtlsconnection.c" + line="1109">the problems with @peer_cert @@ -121986,22 +122387,21 @@ case @error will be set. glib:get-property="certificate" version="2.28"> Gets @conn's certificate, as set by + filename="gio/gtlsconnection.c" + line="548">Gets @conn's certificate, as set by g_tls_connection_set_certificate(). - + @conn's certificate, or %NULL + filename="gio/gtlsconnection.c" + line="555">@conn's certificate, or %NULL a #GTlsConnection + filename="gio/gtlsconnection.c" + line="550">a #GTlsConnection @@ -122011,8 +122411,8 @@ g_tls_connection_set_certificate(). version="2.66" throws="1"> Query the TLS backend for TLS channel binding data of @type for @conn. + filename="gio/gtlsconnection.c" + line="879">Query the TLS backend for TLS channel binding data of @type for @conn. This call retrieves TLS channel binding data as specified in RFC [5056](https://tools.ietf.org/html/rfc5056), RFC @@ -122025,25 +122425,24 @@ is supported by the TLS backend). It does not guarantee that the data will be available though. That could happen if TLS connection does not support @type or the binding data is not available yet due to additional negotiation or input required. - + %TRUE on success, %FALSE otherwise + filename="gio/gtlsconnection.c" + line="901">%TRUE on success, %FALSE otherwise a #GTlsConnection + filename="gio/gtlsconnection.c" + line="881">a #GTlsConnection #GTlsChannelBindingType type of data to fetch + filename="gio/gtlsconnection.c" + line="882">#GTlsChannelBindingType type of data to fetch @@ -122054,8 +122453,8 @@ negotiation or input required. optional="1" allow-none="1"> #GByteArray is + filename="gio/gtlsconnection.c" + line="883">#GByteArray is filled with the binding data, or %NULL @@ -122068,8 +122467,8 @@ negotiation or input required. glib:get-property="ciphersuite-name" version="2.70"> Returns the name of the current TLS ciphersuite, or %NULL if the + filename="gio/gtlsconnection.c" + line="1063">Returns the name of the current TLS ciphersuite, or %NULL if the connection has not handshaked or has been closed. Beware that the TLS backend may use any of multiple different naming conventions, because OpenSSL and GnuTLS have their own ciphersuite naming conventions that @@ -122077,19 +122476,18 @@ are different from each other and different from the standard, IANA- registered ciphersuite names. The ciphersuite name is intended to be displayed to the user for informative purposes only, and parsing it is not recommended. - + The name of the current TLS ciphersuite, or %NULL + filename="gio/gtlsconnection.c" + line="1076">The name of the current TLS ciphersuite, or %NULL a #GTlsConnection + filename="gio/gtlsconnection.c" + line="1065">a #GTlsConnection @@ -122099,22 +122497,21 @@ is not recommended. glib:get-property="database" version="2.30"> Gets the certificate database that @conn uses to verify + filename="gio/gtlsconnection.c" + line="486">Gets the certificate database that @conn uses to verify peer certificates. See g_tls_connection_set_database(). - + the certificate database that @conn uses or %NULL + filename="gio/gtlsconnection.c" + line="493">the certificate database that @conn uses or %NULL a #GTlsConnection + filename="gio/gtlsconnection.c" + line="488">a #GTlsConnection @@ -122124,23 +122521,22 @@ peer certificates. See g_tls_connection_set_database(). glib:get-property="interaction" version="2.30"> Get the object that will be used to interact with the user. It will be used + filename="gio/gtlsconnection.c" + line="597">Get the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. If %NULL is returned, then no user interaction will occur for this connection. - + The interaction object. + filename="gio/gtlsconnection.c" + line="605">The interaction object. a connection + filename="gio/gtlsconnection.c" + line="599">a connection @@ -122150,27 +122546,26 @@ no user interaction will occur for this connection. glib:get-property="negotiated-protocol" version="2.60"> Gets the name of the application-layer protocol negotiated during + filename="gio/gtlsconnection.c" + line="838">Gets the name of the application-layer protocol negotiated during the handshake. If the peer did not use the ALPN extension, or did not advertise a protocol that matched one of @conn's protocols, or the TLS backend does not support ALPN, then this will be %NULL. See g_tls_connection_set_advertised_protocols(). - + the negotiated protocol, or %NULL + filename="gio/gtlsconnection.c" + line="850">the negotiated protocol, or %NULL a #GTlsConnection + filename="gio/gtlsconnection.c" + line="840">a #GTlsConnection @@ -122180,23 +122575,22 @@ g_tls_connection_set_advertised_protocols(). glib:get-property="peer-certificate" version="2.28"> Gets @conn's peer's certificate after the handshake has completed + filename="gio/gtlsconnection.c" + line="623">Gets @conn's peer's certificate after the handshake has completed or failed. (It is not set during the emission of #GTlsConnection::accept-certificate.) - + @conn's peer's certificate, or %NULL + filename="gio/gtlsconnection.c" + line="631">@conn's peer's certificate, or %NULL a #GTlsConnection + filename="gio/gtlsconnection.c" + line="625">a #GTlsConnection @@ -122206,25 +122600,24 @@ or failed. (It is not set during the emission of glib:get-property="peer-certificate-errors" version="2.28"> Gets the errors associated with validating @conn's peer's + filename="gio/gtlsconnection.c" + line="649">Gets the errors associated with validating @conn's peer's certificate, after the handshake has completed or failed. (It is not set during the emission of #GTlsConnection::accept-certificate.) See #GTlsConnection:peer-certificate-errors for more information. - + @conn's peer's certificate errors + filename="gio/gtlsconnection.c" + line="659">@conn's peer's certificate errors a #GTlsConnection + filename="gio/gtlsconnection.c" + line="651">a #GTlsConnection @@ -122234,24 +122627,23 @@ See #GTlsConnection:peer-certificate-errors for more information. glib:get-property="protocol-version" version="2.70"> Returns the current TLS protocol version, which may be + filename="gio/gtlsconnection.c" + line="1031">Returns the current TLS protocol version, which may be %G_TLS_PROTOCOL_VERSION_UNKNOWN if the connection has not handshaked, or has been closed, or if the TLS backend has implemented a protocol version that is not a recognized #GTlsProtocolVersion. - + The current TLS protocol version + filename="gio/gtlsconnection.c" + line="1040">The current TLS protocol version a #GTlsConnection + filename="gio/gtlsconnection.c" + line="1033">a #GTlsConnection @@ -122263,25 +122655,24 @@ that is not a recognized #GTlsProtocolVersion. deprecated="1" deprecated-version="2.60."> Gets @conn rehandshaking mode. See + filename="gio/gtlsconnection.c" + line="775">Gets @conn rehandshaking mode. See g_tls_connection_set_rehandshake_mode() for details. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - + %G_TLS_REHANDSHAKE_SAFELY + filename="gio/gtlsconnection.c" + line="782">%G_TLS_REHANDSHAKE_SAFELY a #GTlsConnection + filename="gio/gtlsconnection.c" + line="777">a #GTlsConnection @@ -122291,24 +122682,23 @@ g_tls_connection_set_rehandshake_mode() for details. glib:get-property="require-close-notify" version="2.28"> Tests whether or not @conn expects a proper TLS close notification + filename="gio/gtlsconnection.c" + line="720">Tests whether or not @conn expects a proper TLS close notification when the connection is closed. See g_tls_connection_set_require_close_notify() for details. - + %TRUE if @conn requires a proper TLS close + filename="gio/gtlsconnection.c" + line="728">%TRUE if @conn requires a proper TLS close notification. a #GTlsConnection + filename="gio/gtlsconnection.c" + line="722">a #GTlsConnection @@ -122319,23 +122709,22 @@ notification. deprecated="1" deprecated-version="2.30"> Gets whether @conn uses the system certificate database to verify + filename="gio/gtlsconnection.c" + line="431">Gets whether @conn uses the system certificate database to verify peer certificates. See g_tls_connection_set_use_system_certdb(). Use g_tls_connection_get_database() instead - + whether @conn uses the system certificate database + filename="gio/gtlsconnection.c" + line="438">whether @conn uses the system certificate database a #GTlsConnection + filename="gio/gtlsconnection.c" + line="433">a #GTlsConnection @@ -122343,10 +122732,11 @@ peer certificates. See g_tls_connection_set_use_system_certdb(). + throws="1" + glib:async-func="handshake_async"> Attempts a TLS handshake on @conn. + filename="gio/gtlsconnection.c" + line="928">Attempts a TLS handshake on @conn. On the client side, it is never necessary to call this method; although the connection needs to perform a handshake after @@ -122377,19 +122767,18 @@ function manually is not recommended. #GTlsConnection::accept_certificate may be emitted during the handshake. - + success or failure + filename="gio/gtlsconnection.c" + line="966">success or failure a #GTlsConnection + filename="gio/gtlsconnection.c" + line="930">a #GTlsConnection nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsconnection.c" + line="931">a #GCancellable, or %NULL + version="2.28" + glib:finish-func="handshake_finish" + glib:sync-func="handshake"> Asynchronously performs a TLS handshake on @conn. See + filename="gio/gtlsconnection.c" + line="980">Asynchronously performs a TLS handshake on @conn. See g_tls_connection_handshake() for more information. - + a #GTlsConnection + filename="gio/gtlsconnection.c" + line="982">a #GTlsConnection the [I/O priority][io-priority] of the request + filename="gio/gtlsconnection.c" + line="983">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsconnection.c" + line="984">a #GCancellable, or %NULL scope="async" closure="3"> callback to call when the handshake is complete + filename="gio/gtlsconnection.c" + line="985">callback to call when the handshake is complete nullable="1" allow-none="1"> the data to pass to the callback function + filename="gio/gtlsconnection.c" + line="986">the data to pass to the callback function @@ -122464,29 +122854,28 @@ g_tls_connection_handshake() for more information. version="2.28" throws="1"> Finish an asynchronous TLS handshake operation. See + filename="gio/gtlsconnection.c" + line="1007">Finish an asynchronous TLS handshake operation. See g_tls_connection_handshake() for more information. - + %TRUE on success, %FALSE on failure, in which + filename="gio/gtlsconnection.c" + line="1016">%TRUE on success, %FALSE on failure, in which case @error will be set. a #GTlsConnection + filename="gio/gtlsconnection.c" + line="1009">a #GTlsConnection a #GAsyncResult. + filename="gio/gtlsconnection.c" + line="1010">a #GAsyncResult. @@ -122496,8 +122885,8 @@ case @error will be set. glib:set-property="advertised-protocols" version="2.60"> Sets the list of application-layer protocols to advertise that the + filename="gio/gtlsconnection.c" + line="808">Sets the list of application-layer protocols to advertise that the caller is willing to speak on this connection. The Application-Layer Protocol Negotiation (ALPN) extension will be used to negotiate a compatible protocol with the peer; use @@ -122507,16 +122896,15 @@ of @protocols will disable ALPN negotiation. See [IANA TLS ALPN Protocol IDs](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids) for a list of registered protocol IDs. - + a #GTlsConnection + filename="gio/gtlsconnection.c" + line="810">a #GTlsConnection nullable="1" allow-none="1"> a %NULL-terminated + filename="gio/gtlsconnection.c" + line="811">a %NULL-terminated array of ALPN protocol names (eg, "http/1.1", "h2"), or %NULL @@ -122538,8 +122926,8 @@ for a list of registered protocol IDs. glib:set-property="certificate" version="2.28"> This sets the certificate that @conn will present to its peer + filename="gio/gtlsconnection.c" + line="512">This sets the certificate that @conn will present to its peer during the TLS handshake. For a #GTlsServerConnection, it is mandatory to set this, and that will normally be done at construct time. @@ -122557,22 +122945,21 @@ or without a certificate; in that case, if you don't provide a certificate, you can tell that the server requested one by the fact that g_tls_client_connection_get_accepted_cas() will return non-%NULL.) - + a #GTlsConnection + filename="gio/gtlsconnection.c" + line="514">a #GTlsConnection the certificate to use for @conn + filename="gio/gtlsconnection.c" + line="515">the certificate to use for @conn @@ -122582,8 +122969,8 @@ non-%NULL.) glib:set-property="database" version="2.30"> Sets the certificate database that is used to verify peer certificates. + filename="gio/gtlsconnection.c" + line="455">Sets the certificate database that is used to verify peer certificates. This is set to the default database by default. See g_tls_backend_get_default_database(). If set to %NULL, then peer certificate validation will always set the @@ -122594,16 +122981,15 @@ client-side connections, unless that bit is not set in There are nonintuitive security implications when using a non-default database. See #GTlsConnection:database for details. - + a #GTlsConnection + filename="gio/gtlsconnection.c" + line="457">a #GTlsConnection nullable="1" allow-none="1"> a #GTlsDatabase + filename="gio/gtlsconnection.c" + line="458">a #GTlsDatabase @@ -122622,23 +123008,22 @@ database. See #GTlsConnection:database for details. glib:set-property="interaction" version="2.30"> Set the object that will be used to interact with the user. It will be used + filename="gio/gtlsconnection.c" + line="573">Set the object that will be used to interact with the user. It will be used for things like prompting the user for passwords. The @interaction argument will normally be a derived subclass of #GTlsInteraction. %NULL can also be provided if no user interaction should occur for this connection. - + a connection + filename="gio/gtlsconnection.c" + line="575">a connection nullable="1" allow-none="1"> an interaction object, or %NULL + filename="gio/gtlsconnection.c" + line="576">an interaction object, or %NULL @@ -122659,30 +123044,29 @@ should occur for this connection. deprecated="1" deprecated-version="2.60."> Since GLib 2.64, changing the rehandshake mode is no longer supported + filename="gio/gtlsconnection.c" + line="746">Since GLib 2.64, changing the rehandshake mode is no longer supported and will have no effect. With TLS 1.3, rehandshaking has been removed from the TLS protocol, replaced by separate post-handshake authentication and rekey operations. Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed from the TLS protocol in TLS 1.3. - + a #GTlsConnection + filename="gio/gtlsconnection.c" + line="748">a #GTlsConnection the rehandshaking mode + filename="gio/gtlsconnection.c" + line="749">the rehandshaking mode @@ -122692,8 +123076,8 @@ rekey operations. glib:set-property="require-close-notify" version="2.28"> Sets whether or not @conn expects a proper TLS close notification + filename="gio/gtlsconnection.c" + line="674">Sets whether or not @conn expects a proper TLS close notification before the connection is closed. If this is %TRUE (the default), then @conn will expect to receive a TLS close notification from its peer before the connection is closed, and will return a @@ -122720,22 +123104,21 @@ setting of this property. If you explicitly want to do an unclean close, you can close @conn's #GTlsConnection:base-io-stream rather than closing @conn itself, but note that this may only be done when no other operations are pending on @conn or the base I/O stream. - + a #GTlsConnection + filename="gio/gtlsconnection.c" + line="676">a #GTlsConnection whether or not to require close notification + filename="gio/gtlsconnection.c" + line="677">whether or not to require close notification @@ -122746,8 +123129,8 @@ operations are pending on @conn or the base I/O stream. deprecated="1" deprecated-version="2.30"> Sets whether @conn uses the system certificate database to verify + filename="gio/gtlsconnection.c" + line="405">Sets whether @conn uses the system certificate database to verify peer certificates. This is %TRUE by default. If set to %FALSE, then peer certificate validation will always set the %G_TLS_CERTIFICATE_UNKNOWN_CA error (meaning @@ -122755,22 +123138,21 @@ peer certificate validation will always set the client-side connections, unless that bit is not set in #GTlsClientConnection:validation-flags). Use g_tls_connection_set_database() instead - + a #GTlsConnection + filename="gio/gtlsconnection.c" + line="407">a #GTlsConnection whether to use the system certificate database + filename="gio/gtlsconnection.c" + line="408">whether to use the system certificate database @@ -122781,8 +123163,8 @@ client-side connections, unless that bit is not set in transfer-ownership="none" setter="set_advertised_protocols"> The list of application-layer protocols that the connection + filename="gio/gtlsconnection.c" + line="256">The list of application-layer protocols that the connection advertises that it is willing to speak. See g_tls_connection_set_advertised_protocols(). @@ -122795,8 +123177,8 @@ g_tls_connection_set_advertised_protocols(). construct-only="1" transfer-ownership="none"> The #GIOStream that the connection wraps. The connection holds a reference + filename="gio/gtlsconnection.c" + line="94">The #GIOStream that the connection wraps. The connection holds a reference to this stream, and may run operations on the stream from other threads throughout its lifetime. Consequently, after the #GIOStream has been constructed, application code may only run its own operations on this @@ -122810,8 +123192,8 @@ stream when no #GIOStream operations are running. setter="set_certificate" getter="get_certificate"> The connection's certificate; see + filename="gio/gtlsconnection.c" + line="200">The connection's certificate; see g_tls_connection_set_certificate(). @@ -122821,8 +123203,8 @@ g_tls_connection_set_certificate(). getter="get_ciphersuite_name" default-value="NULL"> The name of the TLS ciphersuite in use. See g_tls_connection_get_ciphersuite_name(). + filename="gio/gtlsconnection.c" + line="298">The name of the TLS ciphersuite in use. See g_tls_connection_get_ciphersuite_name(). setter="set_database" getter="get_database"> The certificate database to use when verifying this TLS connection. + filename="gio/gtlsconnection.c" + line="127">The certificate database to use when verifying this TLS connection. If no certificate database is set, then the default database will be used. See g_tls_backend_get_default_database(). @@ -122858,8 +123240,8 @@ unusual security requirements. setter="set_interaction" getter="get_interaction"> A #GTlsInteraction object to be used when the connection or certificate + filename="gio/gtlsconnection.c" + line="154">A #GTlsInteraction object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary. @@ -122870,8 +123252,8 @@ user for passwords where necessary. getter="get_negotiated_protocol" default-value="NULL"> The application-layer protocol negotiated during the TLS + filename="gio/gtlsconnection.c" + line="270">The application-layer protocol negotiated during the TLS handshake. See g_tls_connection_get_negotiated_protocol(). @@ -122880,8 +123262,8 @@ handshake. See g_tls_connection_get_negotiated_protocol(). transfer-ownership="none" getter="get_peer_certificate"> The connection's peer's certificate, after the TLS handshake has + filename="gio/gtlsconnection.c" + line="213">The connection's peer's certificate, after the TLS handshake has completed or failed. Note in particular that this is not yet set during the emission of #GTlsConnection::accept-certificate. @@ -122895,8 +123277,8 @@ detect when a handshake has occurred.) getter="get_peer_certificate_errors" default-value="G_TLS_CERTIFICATE_NO_FLAGS"> The errors noticed while verifying + filename="gio/gtlsconnection.c" + line="230">The errors noticed while verifying #GTlsConnection:peer-certificate. Normally this should be 0, but it may not be if #GTlsClientConnection:validation-flags is not %G_TLS_CERTIFICATE_VALIDATE_ALL, or if @@ -122918,8 +123300,8 @@ error flag set even if other problems exist with the certificate. getter="get_protocol_version" default-value="G_TLS_PROTOCOL_VERSION_UNKNOWN"> The TLS protocol version in use. See g_tls_connection_get_protocol_version(). + filename="gio/gtlsconnection.c" + line="284">The TLS protocol version in use. See g_tls_connection_get_protocol_version(). getter="get_rehandshake_mode" default-value="G_TLS_REHANDSHAKE_SAFELY"> The rehandshaking mode. See + filename="gio/gtlsconnection.c" + line="182">The rehandshaking mode. See g_tls_connection_set_rehandshake_mode(). The rehandshake mode is ignored. @@ -122948,8 +123330,8 @@ g_tls_connection_set_rehandshake_mode(). getter="get_require_close_notify" default-value="TRUE"> Whether or not proper TLS close notification is required. + filename="gio/gtlsconnection.c" + line="168">Whether or not proper TLS close notification is required. See g_tls_connection_set_require_close_notify(). @@ -122963,8 +123345,8 @@ See g_tls_connection_set_require_close_notify(). getter="get_use_system_certdb" default-value="TRUE"> Whether or not the system certificate database will be used to + filename="gio/gtlsconnection.c" + line="111">Whether or not the system certificate database will be used to verify peer certificates. See g_tls_connection_set_use_system_certdb(). Use GTlsConnection:database instead @@ -122978,8 +123360,8 @@ g_tls_connection_set_use_system_certdb(). Emitted during the TLS handshake after the peer certificate has + filename="gio/gtlsconnection.c" + line="311">Emitted during the TLS handshake after the peer certificate has been received. You can examine @peer_cert's certification path by calling g_tls_certificate_get_issuer() on it. @@ -123023,8 +123405,8 @@ need to worry about this, and can simply block in the signal handler until the UI thread returns an answer. %TRUE to accept @peer_cert (which will also + filename="gio/gtlsconnection.c" + line="360">%TRUE to accept @peer_cert (which will also immediately end the signal emission). %FALSE to allow the signal emission to continue, which will cause the handshake to fail if no one else overrides it. @@ -123033,14 +123415,14 @@ no one else overrides it. the peer's #GTlsCertificate + filename="gio/gtlsconnection.c" + line="314">the peer's #GTlsCertificate the problems with @peer_cert. + filename="gio/gtlsconnection.c" + line="315">the problems with @peer_cert. @@ -123051,20 +123433,21 @@ no one else overrides it. glib:is-gtype-struct-for="TlsConnection" version="2.28"> The class structure for the #GTlsConnection type. - + The parent class. + Check whether to accept a certificate. - + @@ -123082,20 +123465,22 @@ no one else overrides it. + Perform a handshake operation. - + success or failure + filename="gio/gtlsconnection.c" + line="966">success or failure a #GTlsConnection + filename="gio/gtlsconnection.c" + line="930">a #GTlsConnection nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsconnection.c" + line="931">a #GCancellable, or %NULL + Start an asynchronous handshake operation. - + a #GTlsConnection + filename="gio/gtlsconnection.c" + line="982">a #GTlsConnection the [I/O priority][io-priority] of the request + filename="gio/gtlsconnection.c" + line="983">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsconnection.c" + line="984">a #GCancellable, or %NULL scope="async" closure="4"> callback to call when the handshake is complete + filename="gio/gtlsconnection.c" + line="985">callback to call when the handshake is complete allow-none="1" closure="4"> the data to pass to the callback function + filename="gio/gtlsconnection.c" + line="986">the data to pass to the callback function + Finish an asynchronous handshake operation. - + %TRUE on success, %FALSE on failure, in which + filename="gio/gtlsconnection.c" + line="1016">%TRUE on success, %FALSE on failure, in which case @error will be set. a #GTlsConnection + filename="gio/gtlsconnection.c" + line="1009">a #GTlsConnection a #GAsyncResult. + filename="gio/gtlsconnection.c" + line="1010">a #GAsyncResult. + Retrieve TLS channel binding data (Since: 2.66) - + @@ -123214,20 +123605,22 @@ case @error will be set. + Get ALPN-negotiated protocol (Since: 2.70) - + the negotiated protocol, or %NULL + filename="gio/gtlsconnection.c" + line="850">the negotiated protocol, or %NULL a #GTlsConnection + filename="gio/gtlsconnection.c" + line="840">a #GTlsConnection @@ -123243,8 +123636,7 @@ case @error will be set. c:type="GTlsConnectionPrivate" disguised="1" opaque="1"> - + glib:get-type="g_tls_database_get_type" glib:type-struct="TlsDatabaseClass"> #GTlsDatabase is used to look up certificates and other information + filename="gio/gtlsdatabase.c" + line="35">`GTlsDatabase` is used to look up certificates and other information from a certificate or key store. It is an abstract base class which TLS library specific subtypes override. -A #GTlsDatabase may be accessed from multiple threads by the TLS backend. +A `GTlsDatabase` may be accessed from multiple threads by the TLS backend. All implementations are required to be fully thread-safe. Most common client applications will not directly interact with -#GTlsDatabase. It is used internally by #GTlsConnection. - +`GTlsDatabase`. It is used internally by [class@Gio.TlsConnection]. + Create a handle string for the certificate. The database will only be able + filename="gio/gtlsdatabase.c" + line="643">Create a handle string for the certificate. The database will only be able to create a handle for certificates that originate from the database. In cases where the database cannot create a handle for a certificate, %NULL will be returned. @@ -123281,26 +123672,25 @@ will be returned. This handle should be stable across various instances of the application, and between applications. If a certificate is modified in the database, then it is not guaranteed that this handle will continue to point to it. - + a newly allocated string containing the + filename="gio/gtlsdatabase.c" + line="657">a newly allocated string containing the handle. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="645">a #GTlsDatabase certificate for which to create a handle. + filename="gio/gtlsdatabase.c" + line="646">certificate for which to create a handle. @@ -123308,10 +123698,11 @@ handle. + throws="1" + glib:async-func="lookup_certificate_for_handle_async"> Look up a certificate by its handle. + filename="gio/gtlsdatabase.c" + line="673">Look up a certificate by its handle. The handle should have been created by calling g_tls_database_create_certificate_handle() on a #GTlsDatabase object of @@ -123323,26 +123714,25 @@ this database, then %NULL will be returned. This function can block, use g_tls_database_lookup_certificate_for_handle_async() to perform the lookup operation asynchronously. - + a newly allocated + filename="gio/gtlsdatabase.c" + line="695">a newly allocated #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="675">a #GTlsDatabase a certificate handle + filename="gio/gtlsdatabase.c" + line="676">a certificate handle nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="677">used to interact with the user if necessary Flags which affect the lookup. + filename="gio/gtlsdatabase.c" + line="678">Flags which affect the lookup. @@ -123366,35 +123756,36 @@ the lookup operation asynchronously. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="679">a #GCancellable, or %NULL + version="2.30" + glib:finish-func="lookup_certificate_for_handle_finish" + glib:sync-func="lookup_certificate_for_handle"> Asynchronously look up a certificate by its handle in the database. See + filename="gio/gtlsdatabase.c" + line="723">Asynchronously look up a certificate by its handle in the database. See g_tls_database_lookup_certificate_for_handle() for more information. - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="725">a #GTlsDatabase a certificate handle + filename="gio/gtlsdatabase.c" + line="726">a certificate handle nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="727">used to interact with the user if necessary Flags which affect the lookup. + filename="gio/gtlsdatabase.c" + line="728">Flags which affect the lookup. @@ -123418,8 +123809,8 @@ g_tls_database_lookup_certificate_for_handle() for more information. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="729">a #GCancellable, or %NULL scope="async" closure="5"> callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="730">callback to call when the operation completes allow-none="1" closure="5"> the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="731">the data to pass to the callback function @@ -123450,32 +123841,31 @@ g_tls_database_lookup_certificate_for_handle() for more information. version="2.30" throws="1"> Finish an asynchronous lookup of a certificate by its handle. See + filename="gio/gtlsdatabase.c" + line="761">Finish an asynchronous lookup of a certificate by its handle. See g_tls_database_lookup_certificate_for_handle() for more information. If the handle is no longer valid, or does not point to a certificate in this database, then %NULL will be returned. - + a newly allocated #GTlsCertificate object. + filename="gio/gtlsdatabase.c" + line="773">a newly allocated #GTlsCertificate object. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="763">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="764">a #GAsyncResult. @@ -123483,10 +123873,11 @@ Use g_object_unref() to release the certificate. + throws="1" + glib:async-func="lookup_certificate_issuer_async"> Look up the issuer of @certificate in the database. The + filename="gio/gtlsdatabase.c" + line="792">Look up the issuer of @certificate in the database. The #GTlsCertificate:issuer property of @certificate is not modified, and the two certificates are not hooked into a chain. @@ -123506,26 +123897,25 @@ which certification path will actually be used when verifying a TLS certificate. Accordingly, this function cannot be used to make security-related decisions. Only GLib itself should make security decisions about TLS certificates. - + a newly allocated issuer #GTlsCertificate, + filename="gio/gtlsdatabase.c" + line="822">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="794">a #GTlsDatabase a #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="795">a #GTlsCertificate nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="796">used to interact with the user if necessary flags which affect the lookup operation + filename="gio/gtlsdatabase.c" + line="797">flags which affect the lookup operation @@ -123549,35 +123939,36 @@ or %NULL. Use g_object_unref() to release the certificate. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="798">a #GCancellable, or %NULL + version="2.30" + glib:finish-func="lookup_certificate_issuer_finish" + glib:sync-func="lookup_certificate_issuer"> Asynchronously look up the issuer of @certificate in the database. See + filename="gio/gtlsdatabase.c" + line="849">Asynchronously look up the issuer of @certificate in the database. See g_tls_database_lookup_certificate_issuer() for more information. - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="851">a #GTlsDatabase a #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="852">a #GTlsCertificate nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="853">used to interact with the user if necessary flags which affect the lookup operation + filename="gio/gtlsdatabase.c" + line="854">flags which affect the lookup operation @@ -123601,8 +123992,8 @@ g_tls_database_lookup_certificate_issuer() for more information. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="855">a #GCancellable, or %NULL scope="async" closure="5"> callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="856">callback to call when the operation completes allow-none="1" closure="5"> the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="857">the data to pass to the callback function @@ -123633,29 +124024,28 @@ g_tls_database_lookup_certificate_issuer() for more information. version="2.30" throws="1"> Finish an asynchronous lookup issuer operation. See + filename="gio/gtlsdatabase.c" + line="888">Finish an asynchronous lookup issuer operation. See g_tls_database_lookup_certificate_issuer() for more information. - + a newly allocated issuer #GTlsCertificate, + filename="gio/gtlsdatabase.c" + line="897">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="890">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="891">a #GAsyncResult. @@ -123663,19 +124053,19 @@ or %NULL. Use g_object_unref() to release the certificate. + throws="1" + glib:async-func="lookup_certificates_issued_by_async"> Look up certificates issued by this issuer in the database. + filename="gio/gtlsdatabase.c" + line="916">Look up certificates issued by this issuer in the database. This function can block, use g_tls_database_lookup_certificates_issued_by_async() to perform the lookup operation asynchronously. - + a newly allocated list of #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="930">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -123684,14 +124074,14 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="918">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + filename="gio/gtlsdatabase.c" + line="919">a #GByteArray which holds the DER encoded issuer DN. @@ -123701,14 +124091,14 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="920">used to interact with the user if necessary Flags which affect the lookup operation. + filename="gio/gtlsdatabase.c" + line="921">Flags which affect the lookup operation. @@ -123717,39 +124107,40 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="922">a #GCancellable, or %NULL + version="2.30" + glib:finish-func="lookup_certificates_issued_by_finish" + glib:sync-func="lookup_certificates_issued_by"> Asynchronously look up certificates issued by this issuer in the database. See + filename="gio/gtlsdatabase.c" + line="957">Asynchronously look up certificates issued by this issuer in the database. See g_tls_database_lookup_certificates_issued_by() for more information. The database may choose to hold a reference to the issuer byte array for the duration -of of this asynchronous operation. The byte array should not be modified during +of this asynchronous operation. The byte array should not be modified during this time. - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="959">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + filename="gio/gtlsdatabase.c" + line="960">a #GByteArray which holds the DER encoded issuer DN. @@ -123759,14 +124150,14 @@ this time. nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="961">used to interact with the user if necessary Flags which affect the lookup operation. + filename="gio/gtlsdatabase.c" + line="962">Flags which affect the lookup operation. @@ -123775,8 +124166,8 @@ this time. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="963">a #GCancellable, or %NULL scope="async" closure="5"> callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="964">callback to call when the operation completes allow-none="1" closure="5"> the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="965">the data to pass to the callback function @@ -123807,15 +124198,14 @@ this time. version="2.30" throws="1"> Finish an asynchronous lookup of certificates. See + filename="gio/gtlsdatabase.c" + line="1000">Finish an asynchronous lookup of certificates. See g_tls_database_lookup_certificates_issued_by() for more information. - + a newly allocated list of #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="1009">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -123824,14 +124214,14 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="1002">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="1003">a #GAsyncResult. @@ -123839,10 +124229,11 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele + throws="1" + glib:async-func="verify_chain_async"> Determines the validity of a certificate chain, outside the context + filename="gio/gtlsdatabase.c" + line="446">Determines the validity of a certificate chain, outside the context of a TLS session. @chain is a chain of #GTlsCertificate objects each pointing to the next @@ -123902,32 +124293,31 @@ certificates. This function can block. Use g_tls_database_verify_chain_async() to perform the verification operation asynchronously. - + the appropriate #GTlsCertificateFlags which represents the + filename="gio/gtlsdatabase.c" + line="518">the appropriate #GTlsCertificateFlags which represents the result of verification. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="448">a #GTlsDatabase a #GTlsCertificate chain + filename="gio/gtlsdatabase.c" + line="449">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + filename="gio/gtlsdatabase.c" + line="450">the purpose that this certificate chain will be used for. nullable="1" allow-none="1"> the expected peer identity + filename="gio/gtlsdatabase.c" + line="451">the expected peer identity nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="452">used to interact with the user if necessary additional verify flags + filename="gio/gtlsdatabase.c" + line="453">additional verify flags @@ -123960,42 +124350,43 @@ result of verification. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="454">a #GCancellable, or %NULL + version="2.30" + glib:finish-func="verify_chain_finish" + glib:sync-func="verify_chain"> Asynchronously determines the validity of a certificate chain after + filename="gio/gtlsdatabase.c" + line="556">Asynchronously determines the validity of a certificate chain after looking up and adding any missing certificates to the chain. See g_tls_database_verify_chain() for more information. - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="558">a #GTlsDatabase a #GTlsCertificate chain + filename="gio/gtlsdatabase.c" + line="559">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + filename="gio/gtlsdatabase.c" + line="560">the purpose that this certificate chain will be used for. nullable="1" allow-none="1"> the expected peer identity + filename="gio/gtlsdatabase.c" + line="561">the expected peer identity nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="562">used to interact with the user if necessary additional verify flags + filename="gio/gtlsdatabase.c" + line="563">additional verify flags @@ -124028,8 +124419,8 @@ g_tls_database_verify_chain() for more information. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="564">a #GCancellable, or %NULL scope="async" closure="7"> callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="565">callback to call when the operation completes allow-none="1" closure="7"> the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="566">the data to pass to the callback function @@ -124060,8 +124451,8 @@ g_tls_database_verify_chain() for more information. version="2.30" throws="1"> Finish an asynchronous verify chain operation. See + filename="gio/gtlsdatabase.c" + line="605">Finish an asynchronous verify chain operation. See g_tls_database_verify_chain() for more information. If @chain is found to be valid, then the return value will be 0. If @@ -124072,26 +124463,25 @@ before it completes) then the return value will be %G_TLS_CERTIFICATE_GENERIC_ERROR and @error will be set accordingly. @error is not set when @chain is successfully analyzed but found to be invalid. - + the appropriate #GTlsCertificateFlags which represents the + filename="gio/gtlsdatabase.c" + line="623">the appropriate #GTlsCertificateFlags which represents the result of verification. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="607">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="608">a #GAsyncResult. @@ -124100,8 +124490,8 @@ result of verification. c:identifier="g_tls_database_create_certificate_handle" version="2.30"> Create a handle string for the certificate. The database will only be able + filename="gio/gtlsdatabase.c" + line="643">Create a handle string for the certificate. The database will only be able to create a handle for certificates that originate from the database. In cases where the database cannot create a handle for a certificate, %NULL will be returned. @@ -124109,26 +124499,25 @@ will be returned. This handle should be stable across various instances of the application, and between applications. If a certificate is modified in the database, then it is not guaranteed that this handle will continue to point to it. - + a newly allocated string containing the + filename="gio/gtlsdatabase.c" + line="657">a newly allocated string containing the handle. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="645">a #GTlsDatabase certificate for which to create a handle. + filename="gio/gtlsdatabase.c" + line="646">certificate for which to create a handle. @@ -124136,10 +124525,11 @@ handle. + throws="1" + glib:async-func="lookup_certificate_for_handle_async"> Look up a certificate by its handle. + filename="gio/gtlsdatabase.c" + line="673">Look up a certificate by its handle. The handle should have been created by calling g_tls_database_create_certificate_handle() on a #GTlsDatabase object of @@ -124151,26 +124541,25 @@ this database, then %NULL will be returned. This function can block, use g_tls_database_lookup_certificate_for_handle_async() to perform the lookup operation asynchronously. - + a newly allocated + filename="gio/gtlsdatabase.c" + line="695">a newly allocated #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="675">a #GTlsDatabase a certificate handle + filename="gio/gtlsdatabase.c" + line="676">a certificate handle nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="677">used to interact with the user if necessary Flags which affect the lookup. + filename="gio/gtlsdatabase.c" + line="678">Flags which affect the lookup. @@ -124194,35 +124583,36 @@ the lookup operation asynchronously. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="679">a #GCancellable, or %NULL + version="2.30" + glib:finish-func="lookup_certificate_for_handle_finish" + glib:sync-func="lookup_certificate_for_handle"> Asynchronously look up a certificate by its handle in the database. See + filename="gio/gtlsdatabase.c" + line="723">Asynchronously look up a certificate by its handle in the database. See g_tls_database_lookup_certificate_for_handle() for more information. - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="725">a #GTlsDatabase a certificate handle + filename="gio/gtlsdatabase.c" + line="726">a certificate handle nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="727">used to interact with the user if necessary Flags which affect the lookup. + filename="gio/gtlsdatabase.c" + line="728">Flags which affect the lookup. @@ -124246,8 +124636,8 @@ g_tls_database_lookup_certificate_for_handle() for more information. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="729">a #GCancellable, or %NULL scope="async" closure="5"> callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="730">callback to call when the operation completes nullable="1" allow-none="1"> the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="731">the data to pass to the callback function @@ -124277,32 +124667,31 @@ g_tls_database_lookup_certificate_for_handle() for more information. version="2.30" throws="1"> Finish an asynchronous lookup of a certificate by its handle. See + filename="gio/gtlsdatabase.c" + line="761">Finish an asynchronous lookup of a certificate by its handle. See g_tls_database_lookup_certificate_for_handle() for more information. If the handle is no longer valid, or does not point to a certificate in this database, then %NULL will be returned. - + a newly allocated #GTlsCertificate object. + filename="gio/gtlsdatabase.c" + line="773">a newly allocated #GTlsCertificate object. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="763">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="764">a #GAsyncResult. @@ -124310,10 +124699,11 @@ Use g_object_unref() to release the certificate. + throws="1" + glib:async-func="lookup_certificate_issuer_async"> Look up the issuer of @certificate in the database. The + filename="gio/gtlsdatabase.c" + line="792">Look up the issuer of @certificate in the database. The #GTlsCertificate:issuer property of @certificate is not modified, and the two certificates are not hooked into a chain. @@ -124333,26 +124723,25 @@ which certification path will actually be used when verifying a TLS certificate. Accordingly, this function cannot be used to make security-related decisions. Only GLib itself should make security decisions about TLS certificates. - + a newly allocated issuer #GTlsCertificate, + filename="gio/gtlsdatabase.c" + line="822">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="794">a #GTlsDatabase a #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="795">a #GTlsCertificate nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="796">used to interact with the user if necessary flags which affect the lookup operation + filename="gio/gtlsdatabase.c" + line="797">flags which affect the lookup operation @@ -124376,35 +124765,36 @@ or %NULL. Use g_object_unref() to release the certificate. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="798">a #GCancellable, or %NULL + version="2.30" + glib:finish-func="lookup_certificate_issuer_finish" + glib:sync-func="lookup_certificate_issuer"> Asynchronously look up the issuer of @certificate in the database. See + filename="gio/gtlsdatabase.c" + line="849">Asynchronously look up the issuer of @certificate in the database. See g_tls_database_lookup_certificate_issuer() for more information. - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="851">a #GTlsDatabase a #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="852">a #GTlsCertificate nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="853">used to interact with the user if necessary flags which affect the lookup operation + filename="gio/gtlsdatabase.c" + line="854">flags which affect the lookup operation @@ -124428,8 +124818,8 @@ g_tls_database_lookup_certificate_issuer() for more information. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="855">a #GCancellable, or %NULL scope="async" closure="5"> callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="856">callback to call when the operation completes nullable="1" allow-none="1"> the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="857">the data to pass to the callback function @@ -124459,29 +124849,28 @@ g_tls_database_lookup_certificate_issuer() for more information. version="2.30" throws="1"> Finish an asynchronous lookup issuer operation. See + filename="gio/gtlsdatabase.c" + line="888">Finish an asynchronous lookup issuer operation. See g_tls_database_lookup_certificate_issuer() for more information. - + a newly allocated issuer #GTlsCertificate, + filename="gio/gtlsdatabase.c" + line="897">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="890">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="891">a #GAsyncResult. @@ -124489,19 +124878,19 @@ or %NULL. Use g_object_unref() to release the certificate. + throws="1" + glib:async-func="lookup_certificates_issued_by_async"> Look up certificates issued by this issuer in the database. + filename="gio/gtlsdatabase.c" + line="916">Look up certificates issued by this issuer in the database. This function can block, use g_tls_database_lookup_certificates_issued_by_async() to perform the lookup operation asynchronously. - + a newly allocated list of #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="930">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -124510,14 +124899,14 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="918">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + filename="gio/gtlsdatabase.c" + line="919">a #GByteArray which holds the DER encoded issuer DN. @@ -124527,14 +124916,14 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="920">used to interact with the user if necessary Flags which affect the lookup operation. + filename="gio/gtlsdatabase.c" + line="921">Flags which affect the lookup operation. @@ -124543,39 +124932,40 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="922">a #GCancellable, or %NULL + version="2.30" + glib:finish-func="lookup_certificates_issued_by_finish" + glib:sync-func="lookup_certificates_issued_by"> Asynchronously look up certificates issued by this issuer in the database. See + filename="gio/gtlsdatabase.c" + line="957">Asynchronously look up certificates issued by this issuer in the database. See g_tls_database_lookup_certificates_issued_by() for more information. The database may choose to hold a reference to the issuer byte array for the duration -of of this asynchronous operation. The byte array should not be modified during +of this asynchronous operation. The byte array should not be modified during this time. - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="959">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + filename="gio/gtlsdatabase.c" + line="960">a #GByteArray which holds the DER encoded issuer DN. @@ -124585,14 +124975,14 @@ this time. nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="961">used to interact with the user if necessary Flags which affect the lookup operation. + filename="gio/gtlsdatabase.c" + line="962">Flags which affect the lookup operation. @@ -124601,8 +124991,8 @@ this time. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="963">a #GCancellable, or %NULL scope="async" closure="5"> callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="964">callback to call when the operation completes nullable="1" allow-none="1"> the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="965">the data to pass to the callback function @@ -124632,15 +125022,14 @@ this time. version="2.30" throws="1"> Finish an asynchronous lookup of certificates. See + filename="gio/gtlsdatabase.c" + line="1000">Finish an asynchronous lookup of certificates. See g_tls_database_lookup_certificates_issued_by() for more information. - + a newly allocated list of #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="1009">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -124649,14 +125038,14 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="1002">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="1003">a #GAsyncResult. @@ -124664,10 +125053,11 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele + throws="1" + glib:async-func="verify_chain_async"> Determines the validity of a certificate chain, outside the context + filename="gio/gtlsdatabase.c" + line="446">Determines the validity of a certificate chain, outside the context of a TLS session. @chain is a chain of #GTlsCertificate objects each pointing to the next @@ -124727,32 +125117,31 @@ certificates. This function can block. Use g_tls_database_verify_chain_async() to perform the verification operation asynchronously. - + the appropriate #GTlsCertificateFlags which represents the + filename="gio/gtlsdatabase.c" + line="518">the appropriate #GTlsCertificateFlags which represents the result of verification. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="448">a #GTlsDatabase a #GTlsCertificate chain + filename="gio/gtlsdatabase.c" + line="449">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + filename="gio/gtlsdatabase.c" + line="450">the purpose that this certificate chain will be used for. nullable="1" allow-none="1"> the expected peer identity + filename="gio/gtlsdatabase.c" + line="451">the expected peer identity nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="452">used to interact with the user if necessary additional verify flags + filename="gio/gtlsdatabase.c" + line="453">additional verify flags @@ -124785,42 +125174,43 @@ result of verification. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="454">a #GCancellable, or %NULL + version="2.30" + glib:finish-func="verify_chain_finish" + glib:sync-func="verify_chain"> Asynchronously determines the validity of a certificate chain after + filename="gio/gtlsdatabase.c" + line="556">Asynchronously determines the validity of a certificate chain after looking up and adding any missing certificates to the chain. See g_tls_database_verify_chain() for more information. - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="558">a #GTlsDatabase a #GTlsCertificate chain + filename="gio/gtlsdatabase.c" + line="559">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + filename="gio/gtlsdatabase.c" + line="560">the purpose that this certificate chain will be used for. nullable="1" allow-none="1"> the expected peer identity + filename="gio/gtlsdatabase.c" + line="561">the expected peer identity nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="562">used to interact with the user if necessary additional verify flags + filename="gio/gtlsdatabase.c" + line="563">additional verify flags @@ -124853,8 +125243,8 @@ g_tls_database_verify_chain() for more information. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="564">a #GCancellable, or %NULL scope="async" closure="7"> callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="565">callback to call when the operation completes nullable="1" allow-none="1"> the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="566">the data to pass to the callback function @@ -124884,8 +125274,8 @@ g_tls_database_verify_chain() for more information. version="2.30" throws="1"> Finish an asynchronous verify chain operation. See + filename="gio/gtlsdatabase.c" + line="605">Finish an asynchronous verify chain operation. See g_tls_database_verify_chain() for more information. If @chain is found to be valid, then the return value will be 0. If @@ -124896,26 +125286,25 @@ before it completes) then the return value will be %G_TLS_CERTIFICATE_GENERIC_ERROR and @error will be set accordingly. @error is not set when @chain is successfully analyzed but found to be invalid. - + the appropriate #GTlsCertificateFlags which represents the + filename="gio/gtlsdatabase.c" + line="623">the appropriate #GTlsCertificateFlags which represents the result of verification. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="607">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="608">a #GAsyncResult. @@ -124932,43 +125321,45 @@ result of verification. glib:is-gtype-struct-for="TlsDatabase" version="2.30"> The class for #GTlsDatabase. Derived classes should implement the various + filename="gio/gtlsdatabase.c" + line="51">The class for #GTlsDatabase. Derived classes should implement the various virtual methods. _async and _finish methods have a default implementation that runs the corresponding sync method in a thread. - + + Virtual method implementing + g_tls_database_verify_chain(). - + the appropriate #GTlsCertificateFlags which represents the + filename="gio/gtlsdatabase.c" + line="518">the appropriate #GTlsCertificateFlags which represents the result of verification. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="448">a #GTlsDatabase a #GTlsCertificate chain + filename="gio/gtlsdatabase.c" + line="449">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + filename="gio/gtlsdatabase.c" + line="450">the purpose that this certificate chain will be used for. nullable="1" allow-none="1"> the expected peer identity + filename="gio/gtlsdatabase.c" + line="451">the expected peer identity nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="452">used to interact with the user if necessary additional verify flags + filename="gio/gtlsdatabase.c" + line="453">additional verify flags @@ -125001,37 +125392,40 @@ result of verification. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="454">a #GCancellable, or %NULL + Virtual method implementing + g_tls_database_verify_chain_async(). - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="558">a #GTlsDatabase a #GTlsCertificate chain + filename="gio/gtlsdatabase.c" + line="559">a #GTlsCertificate chain the purpose that this certificate chain will be used for. + filename="gio/gtlsdatabase.c" + line="560">the purpose that this certificate chain will be used for. nullable="1" allow-none="1"> the expected peer identity + filename="gio/gtlsdatabase.c" + line="561">the expected peer identity nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="562">used to interact with the user if necessary additional verify flags + filename="gio/gtlsdatabase.c" + line="563">additional verify flags @@ -125064,8 +125458,8 @@ result of verification. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="564">a #GCancellable, or %NULL scope="async" closure="8"> callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="565">callback to call when the operation completes allow-none="1" closure="8"> the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="566">the data to pass to the callback function + Virtual method implementing + g_tls_database_verify_chain_finish(). - + the appropriate #GTlsCertificateFlags which represents the + filename="gio/gtlsdatabase.c" + line="623">the appropriate #GTlsCertificateFlags which represents the result of verification. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="607">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="608">a #GAsyncResult. + Virtual method implementing + g_tls_database_create_certificate_handle(). - + a newly allocated string containing the + filename="gio/gtlsdatabase.c" + line="657">a newly allocated string containing the handle. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="645">a #GTlsDatabase certificate for which to create a handle. + filename="gio/gtlsdatabase.c" + line="646">certificate for which to create a handle. + Virtual method implementing + g_tls_database_lookup_certificate_for_handle(). - + a newly allocated + filename="gio/gtlsdatabase.c" + line="695">a newly allocated #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="675">a #GTlsDatabase a certificate handle + filename="gio/gtlsdatabase.c" + line="676">a certificate handle nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="677">used to interact with the user if necessary Flags which affect the lookup. + filename="gio/gtlsdatabase.c" + line="678">Flags which affect the lookup. @@ -125191,31 +125594,34 @@ handle. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="679">a #GCancellable, or %NULL + Virtual method implementing + g_tls_database_lookup_certificate_for_handle_async(). - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="725">a #GTlsDatabase a certificate handle + filename="gio/gtlsdatabase.c" + line="726">a certificate handle nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="727">used to interact with the user if necessary Flags which affect the lookup. + filename="gio/gtlsdatabase.c" + line="728">Flags which affect the lookup. @@ -125239,8 +125645,8 @@ handle. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="729">a #GCancellable, or %NULL scope="async" closure="6"> callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="730">callback to call when the operation completes allow-none="1" closure="6"> the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="731">the data to pass to the callback function + Virtual method implementing + g_tls_database_lookup_certificate_for_handle_finish(). - + a newly allocated #GTlsCertificate object. + filename="gio/gtlsdatabase.c" + line="773">a newly allocated #GTlsCertificate object. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="763">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="764">a #GAsyncResult. + Virtual method implementing + g_tls_database_lookup_certificate_issuer(). - + a newly allocated issuer #GTlsCertificate, + filename="gio/gtlsdatabase.c" + line="822">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="794">a #GTlsDatabase a #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="795">a #GTlsCertificate nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="796">used to interact with the user if necessary flags which affect the lookup operation + filename="gio/gtlsdatabase.c" + line="797">flags which affect the lookup operation @@ -125339,31 +125751,34 @@ or %NULL. Use g_object_unref() to release the certificate. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="798">a #GCancellable, or %NULL + Virtual method implementing + g_tls_database_lookup_certificate_issuer_async(). - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="851">a #GTlsDatabase a #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="852">a #GTlsCertificate nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="853">used to interact with the user if necessary flags which affect the lookup operation + filename="gio/gtlsdatabase.c" + line="854">flags which affect the lookup operation @@ -125387,8 +125802,8 @@ or %NULL. Use g_object_unref() to release the certificate. nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="855">a #GCancellable, or %NULL scope="async" closure="6"> callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="856">callback to call when the operation completes allow-none="1" closure="6"> the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="857">the data to pass to the callback function + Virtual method implementing + g_tls_database_lookup_certificate_issuer_finish(). - + a newly allocated issuer #GTlsCertificate, + filename="gio/gtlsdatabase.c" + line="897">a newly allocated issuer #GTlsCertificate, or %NULL. Use g_object_unref() to release the certificate. a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="890">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="891">a #GAsyncResult. + Virtual method implementing + g_tls_database_lookup_certificates_issued_by(). - + a newly allocated list of #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="930">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -125458,14 +125879,14 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="918">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + filename="gio/gtlsdatabase.c" + line="919">a #GByteArray which holds the DER encoded issuer DN. @@ -125475,14 +125896,14 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="920">used to interact with the user if necessary Flags which affect the lookup operation. + filename="gio/gtlsdatabase.c" + line="921">Flags which affect the lookup operation. @@ -125491,31 +125912,34 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="922">a #GCancellable, or %NULL + Virtual method implementing + g_tls_database_lookup_certificates_issued_by_async(). - + a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="959">a #GTlsDatabase a #GByteArray which holds the DER encoded issuer DN. + filename="gio/gtlsdatabase.c" + line="960">a #GByteArray which holds the DER encoded issuer DN. @@ -125525,14 +125949,14 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele nullable="1" allow-none="1"> used to interact with the user if necessary + filename="gio/gtlsdatabase.c" + line="961">used to interact with the user if necessary Flags which affect the lookup operation. + filename="gio/gtlsdatabase.c" + line="962">Flags which affect the lookup operation. @@ -125541,8 +125965,8 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="gio/gtlsdatabase.c" + line="963">a #GCancellable, or %NULL callback to call when the operation completes + filename="gio/gtlsdatabase.c" + line="964">callback to call when the operation completes the data to pass to the callback function + filename="gio/gtlsdatabase.c" + line="965">the data to pass to the callback function + Virtual method implementing + g_tls_database_lookup_certificates_issued_by_finish(). - + a newly allocated list of #GTlsCertificate + filename="gio/gtlsdatabase.c" + line="1009">a newly allocated list of #GTlsCertificate objects. Use g_object_unref() on each certificate, and g_list_free() on the release the list. @@ -125585,14 +126012,14 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele a #GTlsDatabase + filename="gio/gtlsdatabase.c" + line="1002">a #GTlsDatabase a #GAsyncResult. + filename="gio/gtlsdatabase.c" + line="1003">a #GAsyncResult. @@ -125610,8 +126037,8 @@ objects. Use g_object_unref() on each certificate, and g_list_free() on the rele glib:get-type="g_tls_database_lookup_flags_get_type" c:type="GTlsDatabaseLookupFlags"> Flags for g_tls_database_lookup_certificate_for_handle(), + filename="gio/gioenums.h" + line="1841">Flags for g_tls_database_lookup_certificate_for_handle(), g_tls_database_lookup_certificate_issuer(), and g_tls_database_lookup_certificates_issued_by(). glib:nick="none" glib:name="G_TLS_DATABASE_LOOKUP_NONE"> No lookup flags + filename="gio/gioenums.h" + line="1843">No lookup flags glib:nick="keypair" glib:name="G_TLS_DATABASE_LOOKUP_KEYPAIR"> Restrict lookup to certificates that have + filename="gio/gioenums.h" + line="1844">Restrict lookup to certificates that have a private key. @@ -125638,8 +126065,7 @@ and g_tls_database_lookup_certificates_issued_by(). c:type="GTlsDatabasePrivate" disguised="1" opaque="1"> - + glib:get-type="g_tls_database_verify_flags_get_type" c:type="GTlsDatabaseVerifyFlags"> Flags for g_tls_database_verify_chain(). + filename="gio/gioenums.h" + line="1829">Flags for g_tls_database_verify_chain(). No verification flags + filename="gio/gioenums.h" + line="1831">No verification flags c:type="GTlsError" glib:error-domain="g-tls-error-quark"> An error code used with %G_TLS_ERROR in a #GError returned from a + filename="gio/gioenums.h" + line="1561">An error code used with %G_TLS_ERROR in a #GError returned from a TLS-related routine. glib:nick="unavailable" glib:name="G_TLS_ERROR_UNAVAILABLE"> No TLS provider is available + filename="gio/gioenums.h" + line="1563">No TLS provider is available glib:nick="misc" glib:name="G_TLS_ERROR_MISC"> Miscellaneous TLS error + filename="gio/gioenums.h" + line="1564">Miscellaneous TLS error glib:nick="bad-certificate" glib:name="G_TLS_ERROR_BAD_CERTIFICATE"> The certificate presented could not + filename="gio/gioenums.h" + line="1565">The certificate presented could not be parsed or failed validation. glib:nick="not-tls" glib:name="G_TLS_ERROR_NOT_TLS"> The TLS handshake failed because the + filename="gio/gioenums.h" + line="1567">The TLS handshake failed because the peer does not seem to be a TLS server. glib:nick="handshake" glib:name="G_TLS_ERROR_HANDSHAKE"> The TLS handshake failed because the + filename="gio/gioenums.h" + line="1569">The TLS handshake failed because the peer's certificate was not acceptable. glib:nick="certificate-required" glib:name="G_TLS_ERROR_CERTIFICATE_REQUIRED"> The TLS handshake failed because + filename="gio/gioenums.h" + line="1571">The TLS handshake failed because the server requested a client-side certificate, but none was provided. See g_tls_connection_set_certificate(). @@ -125734,8 +126160,8 @@ TLS-related routine. glib:nick="eof" glib:name="G_TLS_ERROR_EOF"> The TLS connection was closed without proper + filename="gio/gioenums.h" + line="1574">The TLS connection was closed without proper notice, which may indicate an attack. See g_tls_connection_set_require_close_notify(). @@ -125745,8 +126171,8 @@ TLS-related routine. glib:nick="inappropriate-fallback" glib:name="G_TLS_ERROR_INAPPROPRIATE_FALLBACK"> The TLS handshake failed + filename="gio/gioenums.h" + line="1577">The TLS handshake failed because the client sent the fallback SCSV, indicating a protocol downgrade attack. Since: 2.60 @@ -125756,18 +126182,18 @@ TLS-related routine. glib:nick="bad-certificate-password" glib:name="G_TLS_ERROR_BAD_CERTIFICATE_PASSWORD"> The certificate failed + filename="gio/gioenums.h" + line="1580">The certificate failed to load because a password was incorrect. Since: 2.72 Gets the TLS error quark. + filename="gio/gtlsconnection.c" + line="1094">Gets the TLS error quark. a #GQuark. + filename="gio/gtlsconnection.c" + line="1099">a #GQuark. @@ -125780,37 +126206,35 @@ TLS-related routine. glib:get-type="g_tls_file_database_get_type" glib:type-struct="TlsFileDatabaseInterface"> #GTlsFileDatabase is implemented by #GTlsDatabase objects which load -their certificate information from a file. It is an interface which + filename="gio/gtlsfiledatabase.c" + line="32">`GTlsFileDatabase` is implemented by [class@Gio.TlsDatabase] objects which +load their certificate information from a file. It is an interface which TLS library specific subtypes implement. - + Creates a new #GTlsFileDatabase which uses anchor certificate authorities + filename="gio/gtlsfiledatabase.c" + line="65">Creates a new #GTlsFileDatabase which uses anchor certificate authorities in @anchors to verify certificate chains. The certificates in @anchors must be PEM encoded. - + the new + filename="gio/gtlsfiledatabase.c" + line="75">the new #GTlsFileDatabase, or %NULL on error filename of anchor certificate authorities. + filename="gio/gtlsfiledatabase.c" + line="67">filename of anchor certificate authorities. @@ -125822,8 +126246,8 @@ The certificates in @anchors must be PEM encoded. transfer-ownership="none" default-value="NULL"> The path to a file containing PEM encoded certificate authority + filename="gio/gtlsfiledatabase.c" + line="47">The path to a file containing PEM encoded certificate authority root anchors. The certificates in this file will be treated as root authorities for the purpose of verifying other certificates via the g_tls_database_verify_chain() operation. @@ -125834,13 +126258,12 @@ via the g_tls_database_verify_chain() operation. c:type="GTlsFileDatabaseInterface" glib:is-gtype-struct-for="TlsFileDatabase"> Provides an interface for #GTlsFileDatabase implementations. - + The parent interface. @@ -125859,36 +126282,36 @@ via the g_tls_database_verify_chain() operation. glib:get-type="g_tls_interaction_get_type" glib:type-struct="TlsInteractionClass"> #GTlsInteraction provides a mechanism for the TLS connection and database + filename="gio/gtlsinteraction.c" + line="38">`GTlsInteraction` provides a mechanism for the TLS connection and database code to interact with the user. It can be used to ask the user for passwords. -To use a #GTlsInteraction with a TLS connection use -g_tls_connection_set_interaction(). +To use a `GTlsInteraction` with a TLS connection use +[method@Gio.TlsConnection.set_interaction]. Callers should instantiate a derived class that implements the various interaction methods to show the required dialogs. Callers should use the 'invoke' functions like -g_tls_interaction_invoke_ask_password() to run interaction methods. These -functions make sure that the interaction is invoked in the main loop +[method@Gio.TlsInteraction.invoke_ask_password] to run interaction methods. +These functions make sure that the interaction is invoked in the main loop and not in the current thread, if the current thread is not running the main loop. -Derived classes can choose to implement whichever interactions methods they'd +Derived classes can choose to implement whichever interactions methods they’d like to support by overriding those virtual methods in their class initialization function. Any interactions not implemented will return -%G_TLS_INTERACTION_UNHANDLED. If a derived class implements an async method, +`G_TLS_INTERACTION_UNHANDLED`. If a derived class implements an async method, it must also implement the corresponding finish method. - + + throws="1" + glib:async-func="ask_password_async"> Run synchronous interaction to ask the user for a password. In general, + filename="gio/gtlsinteraction.c" + line="404">Run synchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -125901,25 +126324,24 @@ If the interaction is cancelled by the cancellation object, or by the user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - + The status of the ask password interaction. + filename="gio/gtlsinteraction.c" + line="425">The status of the ask password interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="406">a #GTlsInteraction object a #GTlsPassword object + filename="gio/gtlsinteraction.c" + line="407">a #GTlsPassword object nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="408">an optional #GCancellable cancellation object + version="2.30" + glib:finish-func="ask_password_finish" + glib:sync-func="ask_password"> Run asynchronous interaction to ask the user for a password. In general, + filename="gio/gtlsinteraction.c" + line="448">Run asynchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -125953,22 +126377,21 @@ contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. Certain implementations may not support immediate cancellation. - + a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="450">a #GTlsInteraction object a #GTlsPassword object + filename="gio/gtlsinteraction.c" + line="451">a #GTlsPassword object nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="452">an optional #GCancellable cancellation object scope="async" closure="3"> will be called when the interaction completes + filename="gio/gtlsinteraction.c" + line="453">will be called when the interaction completes allow-none="1" closure="3"> data to pass to the @callback + filename="gio/gtlsinteraction.c" + line="454">data to pass to the @callback @@ -126008,8 +126431,8 @@ Certain implementations may not support immediate cancellation. version="2.30" throws="1"> Complete an ask password user interaction request. This should be once + filename="gio/gtlsinteraction.c" + line="504">Complete an ask password user interaction request. This should be once the g_tls_interaction_ask_password_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsPassword passed @@ -126018,25 +126441,24 @@ to g_tls_interaction_ask_password() will have its password filled in. If the interaction is cancelled by the cancellation object, or by the user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. - + The status of the ask password interaction. + filename="gio/gtlsinteraction.c" + line="520">The status of the ask password interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="506">a #GTlsInteraction object the result passed to the callback + filename="gio/gtlsinteraction.c" + line="507">the result passed to the callback @@ -126044,10 +126466,11 @@ contains a %G_IO_ERROR_CANCELLED error code. + throws="1" + glib:async-func="request_certificate_async"> Run synchronous interaction to ask the user to choose a certificate to use + filename="gio/gtlsinteraction.c" + line="695">Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -126063,31 +126486,30 @@ If the interaction is cancelled by the cancellation object, or by the user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - + The status of the request certificate interaction. + filename="gio/gtlsinteraction.c" + line="720">The status of the request certificate interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="697">a #GTlsInteraction object a #GTlsConnection object + filename="gio/gtlsinteraction.c" + line="698">a #GTlsConnection object flags providing more information about the request + filename="gio/gtlsinteraction.c" + line="699">flags providing more information about the request @@ -126096,18 +126518,20 @@ not support immediate cancellation. nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="700">an optional #GCancellable cancellation object + version="2.40" + glib:finish-func="request_certificate_finish" + glib:sync-func="request_certificate"> Run asynchronous interaction to ask the user for a certificate to use with + filename="gio/gtlsinteraction.c" + line="744">Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -126115,28 +126539,27 @@ Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. @callback will be called when the operation completes. Alternatively the user may abort this certificate request, which will usually abort the TLS connection. - + a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="746">a #GTlsInteraction object a #GTlsConnection object + filename="gio/gtlsinteraction.c" + line="747">a #GTlsConnection object flags providing more information about the request + filename="gio/gtlsinteraction.c" + line="748">flags providing more information about the request @@ -126145,8 +126568,8 @@ request, which will usually abort the TLS connection. nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="749">an optional #GCancellable cancellation object scope="async" closure="4"> will be called when the interaction completes + filename="gio/gtlsinteraction.c" + line="750">will be called when the interaction completes allow-none="1" closure="4"> data to pass to the @callback + filename="gio/gtlsinteraction.c" + line="751">data to pass to the @callback @@ -126177,8 +126600,8 @@ request, which will usually abort the TLS connection. version="2.40" throws="1"> Complete a request certificate user interaction request. This should be once + filename="gio/gtlsinteraction.c" + line="795">Complete a request certificate user interaction request. This should be once the g_tls_interaction_request_certificate_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsConnection @@ -126188,25 +126611,24 @@ passed to g_tls_interaction_request_certificate_async() will have had its If the interaction is cancelled by the cancellation object, or by the user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. - + The status of the request certificate interaction. + filename="gio/gtlsinteraction.c" + line="812">The status of the request certificate interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="797">a #GTlsInteraction object the result passed to the callback + filename="gio/gtlsinteraction.c" + line="798">the result passed to the callback @@ -126214,10 +126636,11 @@ contains a %G_IO_ERROR_CANCELLED error code. + throws="1" + glib:async-func="ask_password_async"> Run synchronous interaction to ask the user for a password. In general, + filename="gio/gtlsinteraction.c" + line="404">Run synchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -126230,25 +126653,24 @@ If the interaction is cancelled by the cancellation object, or by the user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - + The status of the ask password interaction. + filename="gio/gtlsinteraction.c" + line="425">The status of the ask password interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="406">a #GTlsInteraction object a #GTlsPassword object + filename="gio/gtlsinteraction.c" + line="407">a #GTlsPassword object nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="408">an optional #GCancellable cancellation object + version="2.30" + glib:finish-func="ask_password_finish" + glib:sync-func="ask_password"> Run asynchronous interaction to ask the user for a password. In general, + filename="gio/gtlsinteraction.c" + line="448">Run asynchronous interaction to ask the user for a password. In general, g_tls_interaction_invoke_ask_password() should be used instead of this function. @@ -126282,22 +126706,21 @@ contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. Certain implementations may not support immediate cancellation. - + a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="450">a #GTlsInteraction object a #GTlsPassword object + filename="gio/gtlsinteraction.c" + line="451">a #GTlsPassword object nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="452">an optional #GCancellable cancellation object scope="async" closure="3"> will be called when the interaction completes + filename="gio/gtlsinteraction.c" + line="453">will be called when the interaction completes nullable="1" allow-none="1"> data to pass to the @callback + filename="gio/gtlsinteraction.c" + line="454">data to pass to the @callback @@ -126336,8 +126759,8 @@ Certain implementations may not support immediate cancellation. version="2.30" throws="1"> Complete an ask password user interaction request. This should be once + filename="gio/gtlsinteraction.c" + line="504">Complete an ask password user interaction request. This should be once the g_tls_interaction_ask_password_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsPassword passed @@ -126346,25 +126769,24 @@ to g_tls_interaction_ask_password() will have its password filled in. If the interaction is cancelled by the cancellation object, or by the user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. - + The status of the ask password interaction. + filename="gio/gtlsinteraction.c" + line="520">The status of the ask password interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="506">a #GTlsInteraction object the result passed to the callback + filename="gio/gtlsinteraction.c" + line="507">the result passed to the callback @@ -126374,8 +126796,8 @@ contains a %G_IO_ERROR_CANCELLED error code. version="2.30" throws="1"> Invoke the interaction to ask the user for a password. It invokes this + filename="gio/gtlsinteraction.c" + line="332">Invoke the interaction to ask the user for a password. It invokes this interaction in the main loop, specifically the #GMainContext returned by g_main_context_get_thread_default() when the interaction is created. This is called by called by #GTlsConnection or #GTlsDatabase to ask the user @@ -126394,25 +126816,24 @@ If the interaction is cancelled by the cancellation object, or by the user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - + The status of the ask password interaction. + filename="gio/gtlsinteraction.c" + line="359">The status of the ask password interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="334">a #GTlsInteraction object a #GTlsPassword object + filename="gio/gtlsinteraction.c" + line="335">a #GTlsPassword object nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="336">an optional #GCancellable cancellation object @@ -126431,8 +126852,8 @@ not support immediate cancellation. version="2.40" throws="1"> Invoke the interaction to ask the user to choose a certificate to + filename="gio/gtlsinteraction.c" + line="620">Invoke the interaction to ask the user to choose a certificate to use with the connection. It invokes this interaction in the main loop, specifically the #GMainContext returned by g_main_context_get_thread_default() when the interaction is @@ -126452,31 +126873,30 @@ If the interaction is cancelled by the cancellation object, or by the user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - + The status of the certificate request interaction. + filename="gio/gtlsinteraction.c" + line="649">The status of the certificate request interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="622">a #GTlsInteraction object a #GTlsConnection object + filename="gio/gtlsinteraction.c" + line="623">a #GTlsConnection object flags providing more information about the request + filename="gio/gtlsinteraction.c" + line="624">flags providing more information about the request @@ -126485,8 +126905,8 @@ not support immediate cancellation. nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="625">an optional #GCancellable cancellation object @@ -126494,10 +126914,11 @@ not support immediate cancellation. + throws="1" + glib:async-func="request_certificate_async"> Run synchronous interaction to ask the user to choose a certificate to use + filename="gio/gtlsinteraction.c" + line="695">Run synchronous interaction to ask the user to choose a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -126513,31 +126934,30 @@ If the interaction is cancelled by the cancellation object, or by the user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. Certain implementations may not support immediate cancellation. - + The status of the request certificate interaction. + filename="gio/gtlsinteraction.c" + line="720">The status of the request certificate interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="697">a #GTlsInteraction object a #GTlsConnection object + filename="gio/gtlsinteraction.c" + line="698">a #GTlsConnection object flags providing more information about the request + filename="gio/gtlsinteraction.c" + line="699">flags providing more information about the request @@ -126546,18 +126966,20 @@ not support immediate cancellation. nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="700">an optional #GCancellable cancellation object + version="2.40" + glib:finish-func="request_certificate_finish" + glib:sync-func="request_certificate"> Run asynchronous interaction to ask the user for a certificate to use with + filename="gio/gtlsinteraction.c" + line="744">Run asynchronous interaction to ask the user for a certificate to use with the connection. In general, g_tls_interaction_invoke_request_certificate() should be used instead of this function. @@ -126565,28 +126987,27 @@ Derived subclasses usually implement a certificate selector, although they may also choose to provide a certificate from elsewhere. @callback will be called when the operation completes. Alternatively the user may abort this certificate request, which will usually abort the TLS connection. - + a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="746">a #GTlsInteraction object a #GTlsConnection object + filename="gio/gtlsinteraction.c" + line="747">a #GTlsConnection object flags providing more information about the request + filename="gio/gtlsinteraction.c" + line="748">flags providing more information about the request @@ -126595,8 +127016,8 @@ request, which will usually abort the TLS connection. nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="749">an optional #GCancellable cancellation object scope="async" closure="4"> will be called when the interaction completes + filename="gio/gtlsinteraction.c" + line="750">will be called when the interaction completes nullable="1" allow-none="1"> data to pass to the @callback + filename="gio/gtlsinteraction.c" + line="751">data to pass to the @callback @@ -126626,8 +127047,8 @@ request, which will usually abort the TLS connection. version="2.40" throws="1"> Complete a request certificate user interaction request. This should be once + filename="gio/gtlsinteraction.c" + line="795">Complete a request certificate user interaction request. This should be once the g_tls_interaction_request_certificate_async() completion callback is called. If %G_TLS_INTERACTION_HANDLED is returned, then the #GTlsConnection @@ -126637,25 +127058,24 @@ passed to g_tls_interaction_request_certificate_async() will have had its If the interaction is cancelled by the cancellation object, or by the user then %G_TLS_INTERACTION_FAILED will be returned with an error that contains a %G_IO_ERROR_CANCELLED error code. - + The status of the request certificate interaction. + filename="gio/gtlsinteraction.c" + line="812">The status of the request certificate interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="797">a #GTlsInteraction object the result passed to the callback + filename="gio/gtlsinteraction.c" + line="798">the result passed to the callback @@ -126672,8 +127092,8 @@ contains a %G_IO_ERROR_CANCELLED error code. glib:is-gtype-struct-for="TlsInteraction" version="2.30"> The class for #GTlsInteraction. Derived classes implement the various + filename="gio/gtlsinteraction.c" + line="65">The class for #GTlsInteraction. Derived classes implement the various virtual interaction methods to handle TLS interactions. Derived classes can choose to implement whichever interactions methods they'd @@ -126687,32 +127107,36 @@ and the asynchronous methods to display modeless dialogs. If the user cancels an interaction, then the result should be %G_TLS_INTERACTION_FAILED and the error should be set with a domain of %G_IO_ERROR and code of %G_IO_ERROR_CANCELLED. - + + ask for a password synchronously. If the implementation + returns %G_TLS_INTERACTION_HANDLED, then the password argument should + have been filled in by using g_tls_password_set_value() or a similar + function. - + The status of the ask password interaction. + filename="gio/gtlsinteraction.c" + line="425">The status of the ask password interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="406">a #GTlsInteraction object a #GTlsPassword object + filename="gio/gtlsinteraction.c" + line="407">a #GTlsPassword object an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="408">an optional #GCancellable cancellation object + ask for a password asynchronously. - + a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="450">a #GTlsInteraction object a #GTlsPassword object + filename="gio/gtlsinteraction.c" + line="451">a #GTlsPassword object an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="452">an optional #GCancellable cancellation object will be called when the interaction completes + filename="gio/gtlsinteraction.c" + line="453">will be called when the interaction completes data to pass to the @callback + filename="gio/gtlsinteraction.c" + line="454">data to pass to the @callback + complete operation to ask for a password asynchronously. + If the implementation returns %G_TLS_INTERACTION_HANDLED, then the + password argument of the async method should have been filled in by using + g_tls_password_set_value() or a similar function. - + The status of the ask password interaction. + filename="gio/gtlsinteraction.c" + line="520">The status of the ask password interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="506">a #GTlsInteraction object the result passed to the callback + filename="gio/gtlsinteraction.c" + line="507">the result passed to the callback + ask for a certificate synchronously. If the + implementation returns %G_TLS_INTERACTION_HANDLED, then the connection + argument should have been filled in by using + g_tls_connection_set_certificate(). - + The status of the request certificate interaction. + filename="gio/gtlsinteraction.c" + line="720">The status of the request certificate interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="697">a #GTlsInteraction object a #GTlsConnection object + filename="gio/gtlsinteraction.c" + line="698">a #GTlsConnection object flags providing more information about the request + filename="gio/gtlsinteraction.c" + line="699">flags providing more information about the request @@ -126841,37 +127277,39 @@ If the user cancels an interaction, then the result should be nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="700">an optional #GCancellable cancellation object + ask for a certificate asynchronously. - + a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="746">a #GTlsInteraction object a #GTlsConnection object + filename="gio/gtlsinteraction.c" + line="747">a #GTlsConnection object flags providing more information about the request + filename="gio/gtlsinteraction.c" + line="748">flags providing more information about the request @@ -126880,8 +127318,8 @@ If the user cancels an interaction, then the result should be nullable="1" allow-none="1"> an optional #GCancellable cancellation object + filename="gio/gtlsinteraction.c" + line="749">an optional #GCancellable cancellation object will be called when the interaction completes + filename="gio/gtlsinteraction.c" + line="750">will be called when the interaction completes data to pass to the @callback + filename="gio/gtlsinteraction.c" + line="751">data to pass to the @callback + complete operation to ask for a certificate + asynchronously. If the implementation returns %G_TLS_INTERACTION_HANDLED, + then the connection argument of the async method should have been + filled in by using g_tls_connection_set_certificate(). - + The status of the request certificate interaction. + filename="gio/gtlsinteraction.c" + line="812">The status of the request certificate interaction. a #GTlsInteraction object + filename="gio/gtlsinteraction.c" + line="797">a #GTlsInteraction object the result passed to the callback + filename="gio/gtlsinteraction.c" + line="798">the result passed to the callback @@ -126944,8 +127387,7 @@ If the user cancels an interaction, then the result should be c:type="GTlsInteractionPrivate" disguised="1" opaque="1"> - + #GTlsInteractionResult is returned by various functions in #GTlsInteraction + filename="gio/gioenums.h" + line="1773">#GTlsInteractionResult is returned by various functions in #GTlsInteraction when finishing an interaction request. glib:nick="unhandled" glib:name="G_TLS_INTERACTION_UNHANDLED"> The interaction was unhandled (i.e. not + filename="gio/gioenums.h" + line="1775">The interaction was unhandled (i.e. not implemented). glib:nick="handled" glib:name="G_TLS_INTERACTION_HANDLED"> The interaction completed, and resulting data + filename="gio/gioenums.h" + line="1777">The interaction completed, and resulting data is available. glib:nick="failed" glib:name="G_TLS_INTERACTION_FAILED"> The interaction has failed, or was cancelled. + filename="gio/gioenums.h" + line="1779">The interaction has failed, or was cancelled. and the operation should be aborted. @@ -126996,40 +127438,42 @@ when finishing an interaction request. glib:get-type="g_tls_password_get_type" glib:type-struct="TlsPasswordClass"> Holds a password used in TLS. - + filename="gio/gtlspassword.c" + line="32">An abstract interface representing a password used in TLS. Often used in +user interaction such as unlocking a key storage token. + Create a new #GTlsPassword object. - + filename="gio/gtlspassword.c" + line="232">Create a new #GTlsPassword object. + The newly allocated password object + filename="gio/gtlspassword.c" + line="239">The newly allocated password object the password flags + filename="gio/gtlspassword.c" + line="234">the password flags description of what the password is for + filename="gio/gtlspassword.c" + line="235">description of what the password is for - + virtual method for g_tls_password_get_warning() if no + value has been set using g_tls_password_set_warning() + @@ -127041,18 +127485,17 @@ when finishing an interaction request. Get the password value. If @length is not %NULL then it will be + filename="gio/gtlspassword.c" + line="251">Get the password value. If @length is not %NULL then it will be filled in with the length of the password value. (Note that the password value is not nul-terminated, so you can only pass %NULL for @length in contexts where you know the password will have a certain fixed length.) - + The password value (owned by the password object). + filename="gio/gtlspassword.c" + line="262">The password value (owned by the password object). @@ -127060,25 +127503,27 @@ certain fixed length.) a #GTlsPassword object + filename="gio/gtlspassword.c" + line="253">a #GTlsPassword object + caller-allocates="1" + transfer-ownership="full" + optional="1" + allow-none="1"> location to place the length of the password. + filename="gio/gtlspassword.c" + line="254">location to place the length of the password. Provide the value for this password. + filename="gio/gtlspassword.c" + line="308">Provide the value for this password. The @value will be owned by the password object, and later freed using the @destroy function callback. @@ -127087,30 +127532,29 @@ Specify the @length, for a non-nul-terminated password. Pass -1 as @length if using a nul-terminated password, and @length will be calculated automatically. (Note that the terminating nul is not considered part of the password in this case.) - + a #GTlsPassword object + filename="gio/gtlspassword.c" + line="310">a #GTlsPassword object the value for the password + filename="gio/gtlspassword.c" + line="311">the value for the password the length of the password, or -1 + filename="gio/gtlspassword.c" + line="312">the length of the password, or -1 allow-none="1" scope="async"> a function to use to free the password. + filename="gio/gtlspassword.c" + line="313">a function to use to free the password. @@ -127130,21 +127574,20 @@ considered part of the password in this case.) glib:get-property="description" version="2.30"> Get a description string about what the password will be used for. - + filename="gio/gtlspassword.c" + line="375">Get a description string about what the password will be used for. + The description of the password. + filename="gio/gtlspassword.c" + line="381">The description of the password. a #GTlsPassword object + filename="gio/gtlspassword.c" + line="377">a #GTlsPassword object @@ -127154,21 +127597,20 @@ considered part of the password in this case.) glib:get-property="flags" version="2.30"> Get flags about the password. - + filename="gio/gtlspassword.c" + line="338">Get flags about the password. + The flags about the password. + filename="gio/gtlspassword.c" + line="344">The flags about the password. a #GTlsPassword object + filename="gio/gtlspassword.c" + line="340">a #GTlsPassword object @@ -127177,18 +127619,17 @@ considered part of the password in this case.) c:identifier="g_tls_password_get_value" version="2.30"> Get the password value. If @length is not %NULL then it will be + filename="gio/gtlspassword.c" + line="251">Get the password value. If @length is not %NULL then it will be filled in with the length of the password value. (Note that the password value is not nul-terminated, so you can only pass %NULL for @length in contexts where you know the password will have a certain fixed length.) - + The password value (owned by the password object). + filename="gio/gtlspassword.c" + line="262">The password value (owned by the password object). @@ -127196,17 +127637,19 @@ certain fixed length.) a #GTlsPassword object + filename="gio/gtlspassword.c" + line="253">a #GTlsPassword object + caller-allocates="1" + transfer-ownership="full" + optional="1" + allow-none="1"> location to place the length of the password. + filename="gio/gtlspassword.c" + line="254">location to place the length of the password. @@ -127216,23 +127659,22 @@ certain fixed length.) glib:get-property="warning" version="2.30"> Get a user readable translated warning. Usually this warning is a + filename="gio/gtlspassword.c" + line="416">Get a user readable translated warning. Usually this warning is a representation of the password flags returned from g_tls_password_get_flags(). - + The warning. + filename="gio/gtlspassword.c" + line="424">The warning. a #GTlsPassword object + filename="gio/gtlspassword.c" + line="418">a #GTlsPassword object @@ -127242,24 +127684,23 @@ g_tls_password_get_flags(). glib:set-property="description" version="2.30"> Set a description string about what the password will be used for. - + filename="gio/gtlspassword.c" + line="392">Set a description string about what the password will be used for. + a #GTlsPassword object + filename="gio/gtlspassword.c" + line="394">a #GTlsPassword object The description of the password + filename="gio/gtlspassword.c" + line="395">The description of the password @@ -127269,24 +127710,23 @@ g_tls_password_get_flags(). glib:set-property="flags" version="2.30"> Set flags about the password. - + filename="gio/gtlspassword.c" + line="355">Set flags about the password. + a #GTlsPassword object + filename="gio/gtlspassword.c" + line="357">a #GTlsPassword object The flags about the password + filename="gio/gtlspassword.c" + line="358">The flags about the password @@ -127295,38 +127735,37 @@ g_tls_password_get_flags(). c:identifier="g_tls_password_set_value" version="2.30"> Set the value for this password. The @value will be copied by the password + filename="gio/gtlspassword.c" + line="274">Set the value for this password. The @value will be copied by the password object. Specify the @length, for a non-nul-terminated password. Pass -1 as @length if using a nul-terminated password, and @length will be calculated automatically. (Note that the terminating nul is not considered part of the password in this case.) - + a #GTlsPassword object + filename="gio/gtlspassword.c" + line="276">a #GTlsPassword object the new password value + filename="gio/gtlspassword.c" + line="277">the new password value the length of the password, or -1 + filename="gio/gtlspassword.c" + line="278">the length of the password, or -1 @@ -127335,8 +127774,8 @@ considered part of the password in this case.) c:identifier="g_tls_password_set_value_full" version="2.30"> Provide the value for this password. + filename="gio/gtlspassword.c" + line="308">Provide the value for this password. The @value will be owned by the password object, and later freed using the @destroy function callback. @@ -127345,30 +127784,29 @@ Specify the @length, for a non-nul-terminated password. Pass -1 as @length if using a nul-terminated password, and @length will be calculated automatically. (Note that the terminating nul is not considered part of the password in this case.) - + a #GTlsPassword object + filename="gio/gtlspassword.c" + line="310">a #GTlsPassword object the value for the password + filename="gio/gtlspassword.c" + line="311">the value for the password the length of the password, or -1 + filename="gio/gtlspassword.c" + line="312">the length of the password, or -1 allow-none="1" scope="async"> a function to use to free the password. + filename="gio/gtlspassword.c" + line="313">a function to use to free the password. @@ -127388,52 +127826,63 @@ considered part of the password in this case.) glib:set-property="warning" version="2.30"> Set a user readable translated warning. Usually this warning is a + filename="gio/gtlspassword.c" + line="439">Set a user readable translated warning. Usually this warning is a representation of the password flags returned from g_tls_password_get_flags(). - + a #GTlsPassword object + filename="gio/gtlspassword.c" + line="441">a #GTlsPassword object The user readable warning + filename="gio/gtlspassword.c" + line="442">The user readable warning + Description of what the password is for. + Flags about the password. + Warning about the password. @@ -127447,21 +127896,22 @@ g_tls_password_get_flags(). c:type="GTlsPasswordClass" glib:is-gtype-struct-for="TlsPassword"> Class structure for #GTlsPassword. - + + virtual method for g_tls_password_get_value() - + The password value (owned by the password object). + filename="gio/gtlspassword.c" + line="262">The password value (owned by the password object). @@ -127469,48 +127919,52 @@ g_tls_password_get_flags(). a #GTlsPassword object + filename="gio/gtlspassword.c" + line="253">a #GTlsPassword object + caller-allocates="1" + transfer-ownership="full" + optional="1" + allow-none="1"> location to place the length of the password. + filename="gio/gtlspassword.c" + line="254">location to place the length of the password. + virtual method for g_tls_password_set_value() - + a #GTlsPassword object + filename="gio/gtlspassword.c" + line="310">a #GTlsPassword object the value for the password + filename="gio/gtlspassword.c" + line="311">the value for the password the length of the password, or -1 + filename="gio/gtlspassword.c" + line="312">the length of the password, or -1 allow-none="1" scope="async"> a function to use to free the password. + filename="gio/gtlspassword.c" + line="313">a function to use to free the password. + virtual method for g_tls_password_get_warning() if no + value has been set using g_tls_password_set_warning() - + @@ -127552,16 +128009,16 @@ g_tls_password_get_flags(). glib:get-type="g_tls_password_flags_get_type" c:type="GTlsPasswordFlags"> Various flags for the password. + filename="gio/gioenums.h" + line="1742">Various flags for the password. No flags + filename="gio/gioenums.h" + line="1744">No flags glib:nick="retry" glib:name="G_TLS_PASSWORD_RETRY"> The password was wrong, and the user should retry. + filename="gio/gioenums.h" + line="1745">The password was wrong, and the user should retry. glib:nick="many-tries" glib:name="G_TLS_PASSWORD_MANY_TRIES"> Hint to the user that the password has been + filename="gio/gioenums.h" + line="1746">Hint to the user that the password has been wrong many times, and the user may not have many chances left. glib:nick="final-try" glib:name="G_TLS_PASSWORD_FINAL_TRY"> Hint to the user that this is the last try to get + filename="gio/gioenums.h" + line="1748">Hint to the user that this is the last try to get this password right. glib:nick="pkcs11-user" glib:name="G_TLS_PASSWORD_PKCS11_USER"> For PKCS #11, the user PIN is required. + filename="gio/gioenums.h" + line="1750">For PKCS #11, the user PIN is required. Since: 2.70. glib:nick="pkcs11-security-officer" glib:name="G_TLS_PASSWORD_PKCS11_SECURITY_OFFICER"> For PKCS #11, the security officer + filename="gio/gioenums.h" + line="1752">For PKCS #11, the security officer PIN is required. Since: 2.70. glib:nick="pkcs11-context-specific" glib:name="G_TLS_PASSWORD_PKCS11_CONTEXT_SPECIFIC"> For PKCS #11, the context-specific + filename="gio/gioenums.h" + line="1754">For PKCS #11, the context-specific PIN is required. Since: 2.70. @@ -127627,8 +128084,7 @@ g_tls_password_get_flags(). c:type="GTlsPasswordPrivate" disguised="1" opaque="1"> - + glib:get-type="g_tls_protocol_version_get_type" c:type="GTlsProtocolVersion"> The TLS or DTLS protocol version used by a #GTlsConnection or + filename="gio/gioenums.h" + line="1872">The TLS or DTLS protocol version used by a #GTlsConnection or #GDtlsConnection. The integer values of these versions are sequential to ensure newer known protocol versions compare greater than older known versions. Any known DTLS protocol version will compare greater @@ -127652,8 +128108,8 @@ than the TLS protocol versions. glib:nick="unknown" glib:name="G_TLS_PROTOCOL_VERSION_UNKNOWN"> No protocol version or unknown protocol version + filename="gio/gioenums.h" + line="1874">No protocol version or unknown protocol version glib:nick="ssl-3-0" glib:name="G_TLS_PROTOCOL_VERSION_SSL_3_0"> SSL 3.0, which is insecure and should not be used + filename="gio/gioenums.h" + line="1875">SSL 3.0, which is insecure and should not be used glib:nick="tls-1-0" glib:name="G_TLS_PROTOCOL_VERSION_TLS_1_0"> TLS 1.0, which is insecure and should not be used + filename="gio/gioenums.h" + line="1876">TLS 1.0, which is insecure and should not be used glib:nick="tls-1-1" glib:name="G_TLS_PROTOCOL_VERSION_TLS_1_1"> TLS 1.1, which is insecure and should not be used + filename="gio/gioenums.h" + line="1877">TLS 1.1, which is insecure and should not be used glib:nick="tls-1-2" glib:name="G_TLS_PROTOCOL_VERSION_TLS_1_2"> TLS 1.2, defined by [RFC 5246](https://datatracker.ietf.org/doc/html/rfc5246) + filename="gio/gioenums.h" + line="1878">TLS 1.2, defined by [RFC 5246](https://datatracker.ietf.org/doc/html/rfc5246) glib:nick="tls-1-3" glib:name="G_TLS_PROTOCOL_VERSION_TLS_1_3"> TLS 1.3, defined by [RFC 8446](https://datatracker.ietf.org/doc/html/rfc8446) + filename="gio/gioenums.h" + line="1879">TLS 1.3, defined by [RFC 8446](https://datatracker.ietf.org/doc/html/rfc8446) glib:nick="dtls-1-0" glib:name="G_TLS_PROTOCOL_VERSION_DTLS_1_0"> DTLS 1.0, which is insecure and should not be used + filename="gio/gioenums.h" + line="1880">DTLS 1.0, which is insecure and should not be used glib:nick="dtls-1-2" glib:name="G_TLS_PROTOCOL_VERSION_DTLS_1_2"> DTLS 1.2, defined by [RFC 6347](https://datatracker.ietf.org/doc/html/rfc6347) + filename="gio/gioenums.h" + line="1881">DTLS 1.2, defined by [RFC 6347](https://datatracker.ietf.org/doc/html/rfc6347) glib:get-type="g_tls_rehandshake_mode_get_type" c:type="GTlsRehandshakeMode"> When to allow rehandshaking. See + filename="gio/gioenums.h" + line="1721">When to allow rehandshaking. See g_tls_connection_set_rehandshake_mode(). Changing the rehandshake mode is no longer required for compatibility. Also, rehandshaking has been removed @@ -127739,8 +128195,8 @@ g_tls_connection_set_rehandshake_mode(). glib:nick="never" glib:name="G_TLS_REHANDSHAKE_NEVER"> Never allow rehandshaking + filename="gio/gioenums.h" + line="1723">Never allow rehandshaking glib:nick="safely" glib:name="G_TLS_REHANDSHAKE_SAFELY"> Allow safe rehandshaking only + filename="gio/gioenums.h" + line="1724">Allow safe rehandshaking only glib:nick="unsafely" glib:name="G_TLS_REHANDSHAKE_UNSAFELY"> Allow unsafe rehandshaking + filename="gio/gioenums.h" + line="1725">Allow unsafe rehandshaking glib:get-type="g_tls_server_connection_get_type" glib:type-struct="TlsServerConnectionInterface"> #GTlsServerConnection is the server-side subclass of #GTlsConnection, -representing a server-side TLS connection. - + filename="gio/gtlsserverconnection.c" + line="32">`GTlsServerConnection` is the server-side subclass of +[class@Gio.TlsConnection], representing a server-side TLS connection. + Creates a new #GTlsServerConnection wrapping @base_io_stream (which + filename="gio/gtlsserverconnection.c" + line="63">Creates a new #GTlsServerConnection wrapping @base_io_stream (which must have pollable input and output streams). See the documentation for #GTlsConnection:base-io-stream for restrictions on when application code can run operations on the @base_io_stream after this function has returned. - + the new + filename="gio/gtlsserverconnection.c" + line="76">the new #GTlsServerConnection, or %NULL on error the #GIOStream to wrap + filename="gio/gtlsserverconnection.c" + line="65">the #GIOStream to wrap nullable="1" allow-none="1"> the default server certificate, or %NULL + filename="gio/gtlsserverconnection.c" + line="66">the default server certificate, or %NULL @@ -127820,8 +128274,8 @@ this function has returned. transfer-ownership="none" default-value="G_TLS_AUTHENTICATION_NONE"> The #GTlsAuthenticationMode for the server. This can be changed + filename="gio/gtlsserverconnection.c" + line="46">The #GTlsAuthenticationMode for the server. This can be changed before calling g_tls_connection_handshake() if you want to rehandshake with a different mode from the initial handshake. @@ -127832,22 +128286,42 @@ rehandshake with a different mode from the initial handshake. glib:is-gtype-struct-for="TlsServerConnection" version="2.26"> vtable for a #GTlsServerConnection implementation. - + filename="gio/gtlsserverconnection.h" + line="39">vtable for a #GTlsServerConnection implementation. + The parent interface. + filename="gio/gtlsserverconnection.h" + line="41">The parent interface. + + + + + + + + + + + + + + + + + + - + @@ -127856,8 +128330,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127866,8 +128339,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127876,8 +128348,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127886,8 +128357,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127896,8 +128366,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127906,8 +128375,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127916,8 +128384,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127926,8 +128393,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127936,8 +128402,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127946,8 +128411,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127956,8 +128420,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127966,8 +128429,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127976,8 +128438,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127986,8 +128447,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -127996,8 +128456,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -128006,8 +128465,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -128016,8 +128474,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -128026,8 +128483,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -128036,8 +128492,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -128046,8 +128501,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -128056,8 +128510,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -128066,8 +128519,7 @@ rehandshake with a different mode from the initial handshake. - + @@ -128082,28 +128534,28 @@ rehandshake with a different mode from the initial handshake. glib:get-type="g_unix_connection_get_type" glib:type-struct="UnixConnectionClass"> This is the subclass of #GSocketConnection that is created + filename="gio/gunixconnection.c" + line="33">This is the subclass of [class@Gio.SocketConnection] that is created for UNIX domain sockets. It contains functions to do some of the UNIX socket specific functionality like passing file descriptors. -Since GLib 2.72, #GUnixConnection is available on all platforms. It requires +Since GLib 2.72, `GUnixConnection` is available on all platforms. It requires underlying system support (such as Windows 10 with `AF_UNIX`) at run time. Before GLib 2.72, `<gio/gunixconnection.h>` belonged to the UNIX-specific GIO interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file when using it. This is no longer necessary since GLib 2.72. - + + throws="1" + glib:async-func="receive_credentials_async"> Receives credentials from the sending end of the connection. The + filename="gio/gunixconnection.c" + line="458">Receives credentials from the sending end of the connection. The sending end has to call g_unix_connection_send_credentials() (or similar) for this to work. @@ -128121,20 +128573,19 @@ This method can be expected to be available on the following platforms: Other ways to exchange credentials with a foreign peer includes the #GUnixCredentialsMessage type and g_socket_get_credentials() function. - + Received credentials on success (free with + filename="gio/gunixconnection.c" + line="483">Received credentials on success (free with g_object_unref()), %NULL if @error is set. A #GUnixConnection. + filename="gio/gunixconnection.c" + line="460">A #GUnixConnection. nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="gio/gunixconnection.c" + line="461">A #GCancellable or %NULL. + version="2.32" + glib:finish-func="receive_credentials_finish" + glib:sync-func="receive_credentials"> Asynchronously receive credentials. + filename="gio/gunixconnection.c" + line="678">Asynchronously receive credentials. For more details, see g_unix_connection_receive_credentials() which is the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_unix_connection_receive_credentials_finish() to get the result of the operation. - + A #GUnixConnection. + filename="gio/gunixconnection.c" + line="680">A #GUnixConnection. optional #GCancellable object, %NULL to ignore. + filename="gio/gunixconnection.c" + line="681">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gunixconnection.c" + line="682">a #GAsyncReadyCallback + to call when the request is satisfied the data to pass to callback function + filename="gio/gunixconnection.c" + line="684">the data to pass to callback function @@ -128208,29 +128661,28 @@ g_unix_connection_receive_credentials_finish() to get the result of the operatio version="2.32" throws="1"> Finishes an asynchronous receive credentials operation started with + filename="gio/gunixconnection.c" + line="709">Finishes an asynchronous receive credentials operation started with g_unix_connection_receive_credentials_async(). - + a #GCredentials, or %NULL on error. + filename="gio/gunixconnection.c" + line="718">a #GCredentials, or %NULL on error. Free the returned object with g_object_unref(). A #GUnixConnection. + filename="gio/gunixconnection.c" + line="711">A #GUnixConnection. a #GAsyncResult. + filename="gio/gunixconnection.c" + line="712">a #GAsyncResult. @@ -128240,27 +128692,26 @@ g_unix_connection_receive_credentials_async(). version="2.22" throws="1"> Receives a file descriptor from the sending end of the connection. + filename="gio/gunixconnection.c" + line="121">Receives a file descriptor from the sending end of the connection. The sending end has to call g_unix_connection_send_fd() for this to work. As well as reading the fd this also reads a single byte from the stream, as this is required for fd passing to work on some implementations. - + a file descriptor on success, -1 on error. + filename="gio/gunixconnection.c" + line="135">a file descriptor on success, -1 on error. a #GUnixConnection + filename="gio/gunixconnection.c" + line="123">a #GUnixConnection nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gunixconnection.c" + line="124">optional #GCancellable object, %NULL to ignore @@ -128277,10 +128728,11 @@ implementations. + throws="1" + glib:async-func="send_credentials_async"> Passes the credentials of the current user the receiving side + filename="gio/gunixconnection.c" + line="298">Passes the credentials of the current user the receiving side of the connection. The receiving end has to call g_unix_connection_receive_credentials() (or similar) to accept the credentials. @@ -128299,19 +128751,18 @@ This method can be expected to be available on the following platforms: Other ways to exchange credentials with a foreign peer includes the #GUnixCredentialsMessage type and g_socket_get_credentials() function. - + %TRUE on success, %FALSE if @error is set. + filename="gio/gunixconnection.c" + line="324">%TRUE on success, %FALSE if @error is set. A #GUnixConnection. + filename="gio/gunixconnection.c" + line="300">A #GUnixConnection. A #GCancellable or %NULL. + filename="gio/gunixconnection.c" + line="301">A #GCancellable or %NULL. + version="2.32" + glib:finish-func="send_credentials_finish" + glib:sync-func="send_credentials"> Asynchronously send credentials. + filename="gio/gunixconnection.c" + line="404">Asynchronously send credentials. For more details, see g_unix_connection_send_credentials() which is the synchronous version of this call. When the operation is finished, @callback will be called. You can then call g_unix_connection_send_credentials_finish() to get the result of the operation. - + A #GUnixConnection. + filename="gio/gunixconnection.c" + line="406">A #GUnixConnection. optional #GCancellable object, %NULL to ignore. + filename="gio/gunixconnection.c" + line="407">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gunixconnection.c" + line="408">a #GAsyncReadyCallback + to call when the request is satisfied the data to pass to callback function + filename="gio/gunixconnection.c" + line="410">the data to pass to callback function @@ -128385,28 +128838,27 @@ g_unix_connection_send_credentials_finish() to get the result of the operation.< version="2.32" throws="1"> Finishes an asynchronous send credentials operation started with + filename="gio/gunixconnection.c" + line="435">Finishes an asynchronous send credentials operation started with g_unix_connection_send_credentials_async(). - + %TRUE if the operation was successful, otherwise %FALSE. + filename="gio/gunixconnection.c" + line="444">%TRUE if the operation was successful, otherwise %FALSE. A #GUnixConnection. + filename="gio/gunixconnection.c" + line="437">A #GUnixConnection. a #GAsyncResult. + filename="gio/gunixconnection.c" + line="438">a #GAsyncResult. @@ -128416,33 +128868,32 @@ g_unix_connection_send_credentials_async(). version="2.22" throws="1"> Passes a file descriptor to the receiving side of the + filename="gio/gunixconnection.c" + line="60">Passes a file descriptor to the receiving side of the connection. The receiving end has to call g_unix_connection_receive_fd() to accept the file descriptor. As well as sending the fd this also writes a single byte to the stream, as this is required for fd passing to work on some implementations. - + a %TRUE on success, %NULL on error. + filename="gio/gunixconnection.c" + line="75">a %TRUE on success, %NULL on error. a #GUnixConnection + filename="gio/gunixconnection.c" + line="62">a #GUnixConnection a file descriptor + filename="gio/gunixconnection.c" + line="63">a file descriptor nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gunixconnection.c" + line="64">optional #GCancellable object, %NULL to ignore. @@ -128466,8 +128917,7 @@ implementations. - + @@ -128476,8 +128926,7 @@ implementations. c:type="GUnixConnectionPrivate" disguised="1" opaque="1"> - + glib:get-type="g_unix_credentials_message_get_type" glib:type-struct="UnixCredentialsMessageClass"> This #GSocketControlMessage contains a #GCredentials instance. It -may be sent using g_socket_send_message() and received using -g_socket_receive_message() over UNIX sockets (ie: sockets in the -%G_SOCKET_FAMILY_UNIX family). + filename="gio/gunixcredentialsmessage.c" + line="18">This [class@Gio.SocketControlMessage] contains a [class@Gio.Credentials] +instance. It may be sent using [method@Gio.Socket.send_message] and received +using [method@Gio.Socket.receive_message] over UNIX sockets (ie: sockets in +the `G_SOCKET_FAMILY_UNIX` family). For an easier way to send and receive credentials over stream-oriented UNIX sockets, see -g_unix_connection_send_credentials() and -g_unix_connection_receive_credentials(). To receive credentials of +[method@Gio.UnixConnection.send_credentials] and +[method@Gio.UnixConnection.receive_credentials]. To receive credentials of a foreign process connected to a socket, use -g_socket_get_credentials(). +[method@Gio.Socket.get_credentials]. -Since GLib 2.72, #GUnixCredentialMessage is available on all platforms. It +Since GLib 2.72, `GUnixCredentialMessage` is available on all platforms. It requires underlying system support (such as Windows 10 with `AF_UNIX`) at run time. Before GLib 2.72, `<gio/gunixcredentialsmessage.h>` belonged to the UNIX-specific GIO interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file when using it. This is no longer necessary since GLib 2.72. - + Creates a new #GUnixCredentialsMessage with credentials matching the current processes. - + filename="gio/gunixcredentialsmessage.c" + line="301">Creates a new #GUnixCredentialsMessage with credentials matching the current processes. + a new #GUnixCredentialsMessage + filename="gio/gunixcredentialsmessage.c" + line="306">a new #GUnixCredentialsMessage @@ -128529,21 +128976,20 @@ when using it. This is no longer necessary since GLib 2.72. c:identifier="g_unix_credentials_message_new_with_credentials" version="2.26"> Creates a new #GUnixCredentialsMessage holding @credentials. - + filename="gio/gunixcredentialsmessage.c" + line="318">Creates a new #GUnixCredentialsMessage holding @credentials. + a new #GUnixCredentialsMessage + filename="gio/gunixcredentialsmessage.c" + line="324">a new #GUnixCredentialsMessage A #GCredentials object. + filename="gio/gunixcredentialsmessage.c" + line="320">A #GCredentials object. @@ -128552,14 +128998,13 @@ when using it. This is no longer necessary since GLib 2.72. c:identifier="g_unix_credentials_message_is_supported" version="2.26"> Checks if passing #GCredentials on a #GSocket is supported on this platform. - + filename="gio/gunixcredentialsmessage.c" + line="280">Checks if passing #GCredentials on a #GSocket is supported on this platform. + %TRUE if supported, %FALSE otherwise + filename="gio/gunixcredentialsmessage.c" + line="285">%TRUE if supported, %FALSE otherwise @@ -128568,21 +129013,20 @@ when using it. This is no longer necessary since GLib 2.72. glib:get-property="credentials" version="2.26"> Gets the credentials stored in @message. - + filename="gio/gunixcredentialsmessage.c" + line="338">Gets the credentials stored in @message. + A #GCredentials instance. Do not free, it is owned by @message. + filename="gio/gunixcredentialsmessage.c" + line="344">A #GCredentials instance. Do not free, it is owned by @message. A #GUnixCredentialsMessage. + filename="gio/gunixcredentialsmessage.c" + line="340">A #GUnixCredentialsMessage. @@ -128595,8 +129039,8 @@ when using it. This is no longer necessary since GLib 2.72. transfer-ownership="none" getter="get_credentials"> The credentials stored in the message. + filename="gio/gunixcredentialsmessage.c" + line="258">The credentials stored in the message. @@ -128612,18 +129056,16 @@ when using it. This is no longer necessary since GLib 2.72. glib:is-gtype-struct-for="UnixCredentialsMessage" version="2.26"> Class structure for #GUnixCredentialsMessage. - + - + @@ -128631,8 +129073,7 @@ when using it. This is no longer necessary since GLib 2.72. - + @@ -128643,8 +129084,7 @@ when using it. This is no longer necessary since GLib 2.72. c:type="GUnixCredentialsMessagePrivate" disguised="1" opaque="1"> - + glib:get-type="g_unix_fd_list_get_type" glib:type-struct="UnixFDListClass"> A #GUnixFDList contains a list of file descriptors. It owns the file + filename="gio/gunixfdlist.c" + line="17">A `GUnixFDList` contains a list of file descriptors. It owns the file descriptors that it contains, closing them when finalized. -It may be wrapped in a #GUnixFDMessage and sent over a #GSocket in -the %G_SOCKET_FAMILY_UNIX family by using g_socket_send_message() -and received using g_socket_receive_message(). +It may be wrapped in a +[`GUnixFDMessage`](../gio-unix/class.UnixFDMessage.html) and sent over a +[class@Gio.Socket] in the `G_SOCKET_FAMILY_UNIX` family by using +[method@Gio.Socket.send_message] and received using +[method@Gio.Socket.receive_message]. Before 2.74, `<gio/gunixfdlist.h>` belonged to the UNIX-specific GIO interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file when using it. Since 2.74, the API is available for Windows. - + Creates a new #GUnixFDList containing no file descriptors. - + filename="gio/gunixfdlist.c" + line="151">Creates a new #GUnixFDList containing no file descriptors. + a new #GUnixFDList + filename="gio/gunixfdlist.c" + line="156">a new #GUnixFDList @@ -128686,8 +129126,8 @@ Since 2.74, the API is available for Windows. c:identifier="g_unix_fd_list_new_from_array" version="2.24"> Creates a new #GUnixFDList containing the file descriptors given in + filename="gio/gunixfdlist.c" + line="166">Creates a new #GUnixFDList containing the file descriptors given in @fds. The file descriptors become the property of the new list and may no longer be used by the caller. The array itself is owned by the caller. @@ -128695,27 +129135,26 @@ the caller. Each file descriptor in the array should be set to close-on-exec. If @n_fds is -1 then @fds must be terminated with -1. - + a new #GUnixFDList + filename="gio/gunixfdlist.c" + line="180">a new #GUnixFDList the initial list of file descriptors + filename="gio/gunixfdlist.c" + line="168">the initial list of file descriptors the length of #fds, or -1 + filename="gio/gunixfdlist.c" + line="169">the length of #fds, or -1 @@ -128725,8 +129164,8 @@ If @n_fds is -1 then @fds must be terminated with -1. version="2.24" throws="1"> Adds a file descriptor to @list. + filename="gio/gunixfdlist.c" + line="307">Adds a file descriptor to @list. The file descriptor is duplicated using dup(). You keep your copy of the descriptor and the copy contained in @list will be closed @@ -128738,26 +129177,25 @@ system-wide file descriptor limit. The index of the file descriptor in the list is returned. If you use this index with g_unix_fd_list_get() then you will receive back a duplicated copy of the same file descriptor. - + the index of the appended fd in case of success, else -1 + filename="gio/gunixfdlist.c" + line="326">the index of the appended fd in case of success, else -1 (and @error is set) a #GUnixFDList + filename="gio/gunixfdlist.c" + line="309">a #GUnixFDList a valid open file descriptor + filename="gio/gunixfdlist.c" + line="310">a valid open file descriptor @@ -128767,8 +129205,8 @@ duplicated copy of the same file descriptor. version="2.24" throws="1"> Gets a file descriptor out of @list. + filename="gio/gunixfdlist.c" + line="354">Gets a file descriptor out of @list. @index_ specifies the index of the file descriptor to get. It is a programmer error for @index_ to be out of range; see @@ -128780,25 +129218,24 @@ when you are done. A possible cause of failure is exceeding the per-process or system-wide file descriptor limit. - + the file descriptor, or -1 in case of error + filename="gio/gunixfdlist.c" + line="373">the file descriptor, or -1 in case of error a #GUnixFDList + filename="gio/gunixfdlist.c" + line="356">a #GUnixFDList the index into the list + filename="gio/gunixfdlist.c" + line="357">the index into the list @@ -128807,22 +129244,21 @@ system-wide file descriptor limit. c:identifier="g_unix_fd_list_get_length" version="2.24"> Gets the length of @list (ie: the number of file descriptors + filename="gio/gunixfdlist.c" + line="389">Gets the length of @list (ie: the number of file descriptors contained within). - + the length of @list + filename="gio/gunixfdlist.c" + line="396">the length of @list a #GUnixFDList + filename="gio/gunixfdlist.c" + line="391">a #GUnixFDList @@ -128831,8 +129267,8 @@ contained within). c:identifier="g_unix_fd_list_peek_fds" version="2.24"> Returns the array of file descriptors that is contained in this + filename="gio/gunixfdlist.c" + line="262">Returns the array of file descriptors that is contained in this object. After this call, the descriptors remain the property of @list. The @@ -128845,12 +129281,11 @@ terminated with -1. This function never returns %NULL. In case there are no file descriptors contained in @list, an empty array is returned. - + an array of file + filename="gio/gunixfdlist.c" + line="282">an array of file descriptors @@ -128859,8 +129294,8 @@ descriptors contained in @list, an empty array is returned. a #GUnixFDList + filename="gio/gunixfdlist.c" + line="264">a #GUnixFDList optional="1" allow-none="1"> pointer to the length of the returned + filename="gio/gunixfdlist.c" + line="265">pointer to the length of the returned array, or %NULL @@ -128881,8 +129316,8 @@ descriptors contained in @list, an empty array is returned. c:identifier="g_unix_fd_list_steal_fds" version="2.24"> Returns the array of file descriptors that is contained in this + filename="gio/gunixfdlist.c" + line="206">Returns the array of file descriptors that is contained in this object. After this call, the descriptors are no longer contained in @@ -128900,12 +129335,11 @@ terminated with -1. This function never returns %NULL. In case there are no file descriptors contained in @list, an empty array is returned. - + an array of file + filename="gio/gunixfdlist.c" + line="231">an array of file descriptors @@ -128914,8 +129348,8 @@ descriptors contained in @list, an empty array is returned. a #GUnixFDList + filename="gio/gunixfdlist.c" + line="208">a #GUnixFDList optional="1" allow-none="1"> pointer to the length of the returned + filename="gio/gunixfdlist.c" + line="209">pointer to the length of the returned array, or %NULL @@ -128942,15 +129376,13 @@ descriptors contained in @list, an empty array is returned. - + - + @@ -128958,8 +129390,7 @@ descriptors contained in @list, an empty array is returned. - + @@ -128967,8 +129398,7 @@ descriptors contained in @list, an empty array is returned. - + @@ -128976,8 +129406,7 @@ descriptors contained in @list, an empty array is returned. - + @@ -128985,8 +129414,7 @@ descriptors contained in @list, an empty array is returned. - + @@ -128997,8 +129425,7 @@ descriptors contained in @list, an empty array is returned. c:type="GUnixFDListPrivate" disguised="1" opaque="1"> - + glib:get-type="g_unix_fd_message_get_type" glib:type-struct="UnixFDMessageClass"> This #GSocketControlMessage contains a #GUnixFDList. -It may be sent using g_socket_send_message() and received using -g_socket_receive_message() over UNIX sockets (ie: sockets in the -%G_SOCKET_FAMILY_UNIX family). The file descriptors are copied + filename="gio/gunixfdmessage.c" + line="17">This [class@Gio.SocketControlMessage] contains a [class@Gio.UnixFDList]. +It may be sent using [method@Gio.Socket.send_message] and received using +[method@Gio.Socket.receive_message] over UNIX sockets (ie: sockets in the +`G_SOCKET_FAMILY_UNIX` family). The file descriptors are copied between processes by the kernel. For an easier way to send and receive file descriptors over -stream-oriented UNIX sockets, see g_unix_connection_send_fd() and -g_unix_connection_receive_fd(). +stream-oriented UNIX sockets, see [method@Gio.UnixConnection.send_fd] and +[method@Gio.UnixConnection.receive_fd]. Note that `<gio/gunixfdmessage.h>` belongs to the UNIX-specific GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config -file when using it. - +file or the `GioUnix-2.0` GIR namespace when using it. + Creates a new #GUnixFDMessage containing an empty file descriptor + filename="gio/gunixfdmessage.c" + line="229">Creates a new #GUnixFDMessage containing an empty file descriptor list. - + a new #GUnixFDMessage + filename="gio/gunixfdmessage.c" + line="235">a new #GUnixFDMessage @@ -129044,21 +129469,20 @@ list. c:identifier="g_unix_fd_message_new_with_fd_list" version="2.24"> Creates a new #GUnixFDMessage containing @list. - + filename="gio/gunixfdmessage.c" + line="245">Creates a new #GUnixFDMessage containing @list. + a new #GUnixFDMessage + filename="gio/gunixfdmessage.c" + line="251">a new #GUnixFDMessage a #GUnixFDList + filename="gio/gunixfdmessage.c" + line="247">a #GUnixFDList @@ -129068,8 +129492,8 @@ list. version="2.22" throws="1"> Adds a file descriptor to @message. + filename="gio/gunixfdmessage.c" + line="301">Adds a file descriptor to @message. The file descriptor is duplicated using dup(). You keep your copy of the descriptor and the copy contained in @message will be closed @@ -129077,25 +129501,24 @@ when @message is finalized. A possible cause of failure is exceeding the per-process or system-wide file descriptor limit. - + %TRUE in case of success, else %FALSE (and @error is set) + filename="gio/gunixfdmessage.c" + line="316">%TRUE in case of success, else %FALSE (and @error is set) a #GUnixFDMessage + filename="gio/gunixfdmessage.c" + line="303">a #GUnixFDMessage a valid open file descriptor + filename="gio/gunixfdmessage.c" + line="304">a valid open file descriptor @@ -129105,23 +129528,22 @@ system-wide file descriptor limit. glib:get-property="fd-list" version="2.24"> Gets the #GUnixFDList contained in @message. This function does not + filename="gio/gunixfdmessage.c" + line="155">Gets the #GUnixFDList contained in @message. This function does not return a reference to the caller, but the returned list is valid for the lifetime of @message. - + the #GUnixFDList from @message + filename="gio/gunixfdmessage.c" + line="163">the #GUnixFDList from @message a #GUnixFDMessage + filename="gio/gunixfdmessage.c" + line="157">a #GUnixFDMessage @@ -129130,8 +129552,8 @@ the lifetime of @message. c:identifier="g_unix_fd_message_steal_fds" version="2.22"> Returns the array of file descriptors that is contained in this + filename="gio/gunixfdmessage.c" + line="263">Returns the array of file descriptors that is contained in this object. After this call, the descriptors are no longer contained in @@ -129148,12 +129570,11 @@ terminated with -1. This function never returns %NULL. In case there are no file descriptors contained in @message, an empty array is returned. - + an array of file + filename="gio/gunixfdmessage.c" + line="287">an array of file descriptors @@ -129162,8 +129583,8 @@ descriptors contained in @message, an empty array is returned. a #GUnixFDMessage + filename="gio/gunixfdmessage.c" + line="265">a #GUnixFDMessage optional="1" allow-none="1"> pointer to the length of the returned + filename="gio/gunixfdmessage.c" + line="266">pointer to the length of the returned array, or %NULL + The [class@Gio.UnixFDList] object to send with the message. @@ -129197,16 +129622,14 @@ descriptors contained in @message, an empty array is returned. - + - + @@ -129214,8 +129637,7 @@ descriptors contained in @message, an empty array is returned. - + @@ -129226,8 +129648,7 @@ descriptors contained in @message, an empty array is returned. c:type="GUnixFDMessagePrivate" disguised="1" opaque="1"> - + glib:get-type="g_unix_input_stream_get_type" glib:type-struct="UnixInputStreamClass"> #GUnixInputStream implements #GInputStream for reading from a UNIX + filename="gio/gunixinputstream.c" + line="41">`GUnixInputStream` implements [class@Gio.InputStream] for reading from a UNIX file descriptor, including asynchronous operations. (If the file -descriptor refers to a socket or pipe, this will use poll() to do +descriptor refers to a socket or pipe, this will use `poll()` to do asynchronous I/O. If it refers to a regular file, it will fall back to doing asynchronous I/O in another thread.) Note that `<gio/gunixinputstream.h>` belongs to the UNIX-specific GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config -file when using it. - +file or the `GioUnix-2.0` GIR namespace when using it. + Creates a new #GUnixInputStream for the given @fd. + filename="gio/gunixinputstream.c" + line="224">Creates a new #GUnixInputStream for the given @fd. If @close_fd is %TRUE, the file descriptor will be closed when the stream is closed. - + a new #GUnixInputStream + filename="gio/gunixinputstream.c" + line="234">a new #GUnixInputStream a UNIX file descriptor + filename="gio/gunixinputstream.c" + line="226">a UNIX file descriptor %TRUE to close the file descriptor when done + filename="gio/gunixinputstream.c" + line="227">%TRUE to close the file descriptor when done @@ -129286,22 +129705,21 @@ when the stream is closed. glib:get-property="close-fd" version="2.20"> Returns whether the file descriptor of @stream will be + filename="gio/gunixinputstream.c" + line="276">Returns whether the file descriptor of @stream will be closed when the stream is closed. - + %TRUE if the file descriptor is closed when done + filename="gio/gunixinputstream.c" + line="283">%TRUE if the file descriptor is closed when done a #GUnixInputStream + filename="gio/gunixinputstream.c" + line="278">a #GUnixInputStream @@ -129311,21 +129729,20 @@ closed when the stream is closed. glib:get-property="fd" version="2.20"> Return the UNIX file descriptor that the stream reads from. - + filename="gio/gunixinputstream.c" + line="295">Return the UNIX file descriptor that the stream reads from. + The file descriptor of @stream + filename="gio/gunixinputstream.c" + line="301">The file descriptor of @stream a #GUnixInputStream + filename="gio/gunixinputstream.c" + line="297">a #GUnixInputStream @@ -129335,25 +129752,24 @@ closed when the stream is closed. glib:set-property="close-fd" version="2.20"> Sets whether the file descriptor of @stream shall be closed + filename="gio/gunixinputstream.c" + line="252">Sets whether the file descriptor of @stream shall be closed when the stream is closed. - + a #GUnixInputStream + filename="gio/gunixinputstream.c" + line="254">a #GUnixInputStream %TRUE to close the file descriptor when done + filename="gio/gunixinputstream.c" + line="255">%TRUE to close the file descriptor when done @@ -129366,8 +129782,8 @@ when the stream is closed. getter="get_close_fd" default-value="TRUE"> Whether to close the file descriptor when the stream is closed. + filename="gio/gunixinputstream.c" + line="140">Whether to close the file descriptor when the stream is closed. getter="get_fd" default-value="-1"> The file descriptor that the stream reads from. + filename="gio/gunixinputstream.c" + line="127">The file descriptor that the stream reads from. @@ -129392,15 +129808,13 @@ when the stream is closed. - + - + @@ -129408,8 +129822,7 @@ when the stream is closed. - + @@ -129417,8 +129830,7 @@ when the stream is closed. - + @@ -129426,8 +129838,7 @@ when the stream is closed. - + @@ -129435,8 +129846,7 @@ when the stream is closed. - + @@ -129447,8 +129857,7 @@ when the stream is closed. c:type="GUnixInputStreamPrivate" disguised="1" opaque="1"> - + glib:get-type="g_unix_mount_entry_get_type" c:symbol-prefix="unix_mount_entry"> Defines a Unix mount entry (e.g. <filename>/media/cdrom</filename>). This corresponds roughly to a mtab entry. - + glib:get-type="g_unix_mount_monitor_get_type" glib:type-struct="UnixMountMonitorClass"> Watches #GUnixMounts for changes. - + Deprecated alias for g_unix_mount_monitor_get(). + filename="gio/gunixmounts.c" + line="2242">Deprecated alias for g_unix_mount_monitor_get(). This function was never a true constructor, which is why it was renamed. Use g_unix_mount_monitor_get() instead. - + a #GUnixMountMonitor. + filename="gio/gunixmounts.c" + line="2250">a #GUnixMountMonitor. @@ -129499,8 +129905,8 @@ renamed. c:identifier="g_unix_mount_monitor_get" version="2.44"> Gets the #GUnixMountMonitor for the current thread-default main + filename="gio/gunixmounts.c" + line="2216">Gets the #GUnixMountMonitor for the current thread-default main context. The mount monitor can be used to monitor for changes to the list of @@ -129509,12 +129915,11 @@ entries). You must only call g_object_unref() on the return value from under the same main context as you called this function. - + the #GUnixMountMonitor. + filename="gio/gunixmounts.c" + line="2229">the #GUnixMountMonitor. @@ -129524,8 +129929,8 @@ the same main context as you called this function. deprecated="1" deprecated-version="2.44"> This function does nothing. + filename="gio/gunixmounts.c" + line="2192">This function does nothing. Before 2.44, this was a partially-effective way of controlling the rate at which events would be reported under some uncommon @@ -129533,22 +129938,21 @@ circumstances. Since @mount_monitor is a singleton, it also meant that calling this function would have side effects for other users of the monitor. This function does nothing. Don't call it. - + a #GUnixMountMonitor + filename="gio/gunixmounts.c" + line="2194">a #GUnixMountMonitor a integer with the limit in milliseconds to + filename="gio/gunixmounts.c" + line="2195">a integer with the limit in milliseconds to poll for changes. @@ -129556,16 +129960,16 @@ the monitor. Emitted when the unix mount points have changed. + filename="gio/gunixmounts.c" + line="2171">Emitted when the unix mount points have changed. Emitted when the unix mounts have changed. + filename="gio/gunixmounts.c" + line="2156">Emitted when the unix mounts have changed. @@ -129576,8 +129980,7 @@ the monitor. disguised="1" opaque="1" glib:is-gtype-struct-for="UnixMountMonitor"> - + glib:get-type="g_unix_mount_point_get_type" c:symbol-prefix="unix_mount_point"> Defines a Unix mount point (e.g. <filename>/dev</filename>). This corresponds roughly to a fstab entry. - + Compares two unix mount points. - + filename="gio/gunixmounts.c" + line="2533">Compares two unix mount points. + 1, 0 or -1 if @mount1 is greater than, equal to, + filename="gio/gunixmounts.c" + line="2540">1, 0 or -1 if @mount1 is greater than, equal to, or less than @mount2, respectively. a #GUnixMount. + filename="gio/gunixmounts.c" + line="2535">a #GUnixMount. a #GUnixMount. + filename="gio/gunixmounts.c" + line="2536">a #GUnixMount. @@ -129623,39 +130024,37 @@ or less than @mount2, respectively. c:identifier="g_unix_mount_point_copy" version="2.54"> Makes a copy of @mount_point. - + filename="gio/gunixmounts.c" + line="2327">Makes a copy of @mount_point. + a new #GUnixMountPoint + filename="gio/gunixmounts.c" + line="2333">a new #GUnixMountPoint a #GUnixMountPoint. + filename="gio/gunixmounts.c" + line="2329">a #GUnixMountPoint. Frees a unix mount point. - + filename="gio/gunixmounts.c" + line="2309">Frees a unix mount point. + unix mount point to free. + filename="gio/gunixmounts.c" + line="2311">unix mount point to free. @@ -129663,42 +130062,40 @@ or less than @mount2, respectively. Gets the device path for a unix mount point. - + filename="gio/gunixmounts.c" + line="2598">Gets the device path for a unix mount point. + a string containing the device path. + filename="gio/gunixmounts.c" + line="2604">a string containing the device path. a #GUnixMountPoint. + filename="gio/gunixmounts.c" + line="2600">a #GUnixMountPoint. Gets the file system type for the mount point. - + filename="gio/gunixmounts.c" + line="2614">Gets the file system type for the mount point. + a string containing the file system type. + filename="gio/gunixmounts.c" + line="2620">a string containing the file system type. a #GUnixMountPoint. + filename="gio/gunixmounts.c" + line="2616">a #GUnixMountPoint. @@ -129706,21 +130103,20 @@ or less than @mount2, respectively. Gets the mount path for a unix mount point. - + filename="gio/gunixmounts.c" + line="2582">Gets the mount path for a unix mount point. + a string containing the mount path. + filename="gio/gunixmounts.c" + line="2588">a string containing the mount path. a #GUnixMountPoint. + filename="gio/gunixmounts.c" + line="2584">a #GUnixMountPoint. @@ -129729,21 +130125,20 @@ or less than @mount2, respectively. c:identifier="g_unix_mount_point_get_options" version="2.32"> Gets the options for the mount point. - + filename="gio/gunixmounts.c" + line="2630">Gets the options for the mount point. + a string containing the options. + filename="gio/gunixmounts.c" + line="2636">a string containing the options. a #GUnixMountPoint. + filename="gio/gunixmounts.c" + line="2632">a #GUnixMountPoint. @@ -129751,65 +130146,62 @@ or less than @mount2, respectively. Guesses whether a Unix mount point can be ejected. - + filename="gio/gunixmounts.c" + line="3095">Guesses whether a Unix mount point can be ejected. + %TRUE if @mount_point is deemed to be ejectable. + filename="gio/gunixmounts.c" + line="3101">%TRUE if @mount_point is deemed to be ejectable. a #GUnixMountPoint + filename="gio/gunixmounts.c" + line="3097">a #GUnixMountPoint Guesses the icon of a Unix mount point. - + filename="gio/gunixmounts.c" + line="2957">Guesses the icon of a Unix mount point. + a #GIcon + filename="gio/gunixmounts.c" + line="2963">a #GIcon a #GUnixMountPoint + filename="gio/gunixmounts.c" + line="2959">a #GUnixMountPoint Guesses the name of a Unix mount point. + filename="gio/gunixmounts.c" + line="2934">Guesses the name of a Unix mount point. The result is a translated string. - + A newly allocated string that must + filename="gio/gunixmounts.c" + line="2941">A newly allocated string that must be freed with g_free() a #GUnixMountPoint + filename="gio/gunixmounts.c" + line="2936">a #GUnixMountPoint @@ -129818,63 +130210,60 @@ The result is a translated string. c:identifier="g_unix_mount_point_guess_symbolic_icon" version="2.34"> Guesses the symbolic icon of a Unix mount point. - + filename="gio/gunixmounts.c" + line="2971">Guesses the symbolic icon of a Unix mount point. + a #GIcon + filename="gio/gunixmounts.c" + line="2977">a #GIcon a #GUnixMountPoint + filename="gio/gunixmounts.c" + line="2973">a #GUnixMountPoint Checks if a unix mount point is a loopback device. - + filename="gio/gunixmounts.c" + line="2680">Checks if a unix mount point is a loopback device. + %TRUE if the mount point is a loopback. %FALSE otherwise. + filename="gio/gunixmounts.c" + line="2686">%TRUE if the mount point is a loopback. %FALSE otherwise. a #GUnixMountPoint. + filename="gio/gunixmounts.c" + line="2682">a #GUnixMountPoint. Checks if a unix mount point is read only. - + filename="gio/gunixmounts.c" + line="2648">Checks if a unix mount point is read only. + %TRUE if a mount point is read only. + filename="gio/gunixmounts.c" + line="2654">%TRUE if a mount point is read only. a #GUnixMountPoint. + filename="gio/gunixmounts.c" + line="2650">a #GUnixMountPoint. @@ -129882,48 +130271,46 @@ The result is a translated string. Checks if a unix mount point is mountable by the user. - + filename="gio/gunixmounts.c" + line="2664">Checks if a unix mount point is mountable by the user. + %TRUE if the mount point is user mountable. + filename="gio/gunixmounts.c" + line="2670">%TRUE if the mount point is user mountable. a #GUnixMountPoint. + filename="gio/gunixmounts.c" + line="2666">a #GUnixMountPoint. Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it + filename="gio/gunixmounts.c" + line="1727">Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it will be filled with a unix timestamp for checking if the mount points have changed since with g_unix_mount_points_changed_since(). If more mount points have the same mount path, the last matching mount point is returned. - + a #GUnixMountPoint, or %NULL if no match + filename="gio/gunixmounts.c" + line="1739">a #GUnixMountPoint, or %NULL if no match is found. path for a possible unix mount point. + filename="gio/gunixmounts.c" + line="1729">path for a possible unix mount point. optional="1" allow-none="1"> guint64 to contain a timestamp. + filename="gio/gunixmounts.c" + line="1730">guint64 to contain a timestamp. @@ -129948,46 +130335,44 @@ is found. glib:get-type="g_unix_output_stream_get_type" glib:type-struct="UnixOutputStreamClass"> #GUnixOutputStream implements #GOutputStream for writing to a UNIX + filename="gio/gunixoutputstream.c" + line="43">`GUnixOutputStream` implements [class@Gio.OutputStream] for writing to a UNIX file descriptor, including asynchronous operations. (If the file -descriptor refers to a socket or pipe, this will use poll() to do +descriptor refers to a socket or pipe, this will use `poll()` to do asynchronous I/O. If it refers to a regular file, it will fall back to doing asynchronous I/O in another thread.) Note that `<gio/gunixoutputstream.h>` belongs to the UNIX-specific GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file -when using it. - +file or the `GioUnix-2.0` GIR namespace when using it. + Creates a new #GUnixOutputStream for the given @fd. + filename="gio/gunixoutputstream.c" + line="224">Creates a new #GUnixOutputStream for the given @fd. If @close_fd, is %TRUE, the file descriptor will be closed when the output stream is destroyed. - + a new #GOutputStream + filename="gio/gunixoutputstream.c" + line="234">a new #GOutputStream a UNIX file descriptor + filename="gio/gunixoutputstream.c" + line="226">a UNIX file descriptor %TRUE to close the file descriptor when done + filename="gio/gunixoutputstream.c" + line="227">%TRUE to close the file descriptor when done @@ -129997,22 +130382,21 @@ the output stream is destroyed. glib:get-property="close-fd" version="2.20"> Returns whether the file descriptor of @stream will be + filename="gio/gunixoutputstream.c" + line="276">Returns whether the file descriptor of @stream will be closed when the stream is closed. - + %TRUE if the file descriptor is closed when done + filename="gio/gunixoutputstream.c" + line="283">%TRUE if the file descriptor is closed when done a #GUnixOutputStream + filename="gio/gunixoutputstream.c" + line="278">a #GUnixOutputStream @@ -130022,21 +130406,20 @@ closed when the stream is closed. glib:get-property="fd" version="2.20"> Return the UNIX file descriptor that the stream writes to. - + filename="gio/gunixoutputstream.c" + line="295">Return the UNIX file descriptor that the stream writes to. + The file descriptor of @stream + filename="gio/gunixoutputstream.c" + line="301">The file descriptor of @stream a #GUnixOutputStream + filename="gio/gunixoutputstream.c" + line="297">a #GUnixOutputStream @@ -130046,25 +130429,24 @@ closed when the stream is closed. glib:set-property="close-fd" version="2.20"> Sets whether the file descriptor of @stream shall be closed + filename="gio/gunixoutputstream.c" + line="252">Sets whether the file descriptor of @stream shall be closed when the stream is closed. - + a #GUnixOutputStream + filename="gio/gunixoutputstream.c" + line="254">a #GUnixOutputStream %TRUE to close the file descriptor when done + filename="gio/gunixoutputstream.c" + line="255">%TRUE to close the file descriptor when done @@ -130077,8 +130459,8 @@ when the stream is closed. getter="get_close_fd" default-value="TRUE"> Whether to close the file descriptor when the stream is closed. + filename="gio/gunixoutputstream.c" + line="139">Whether to close the file descriptor when the stream is closed. getter="get_fd" default-value="-1"> The file descriptor that the stream writes to. + filename="gio/gunixoutputstream.c" + line="126">The file descriptor that the stream writes to. @@ -130104,15 +130486,13 @@ when the stream is closed. - + - + @@ -130120,8 +130500,7 @@ when the stream is closed. - + @@ -130129,8 +130508,7 @@ when the stream is closed. - + @@ -130138,8 +130516,7 @@ when the stream is closed. - + @@ -130147,8 +130524,7 @@ when the stream is closed. - + @@ -130159,8 +130535,7 @@ when the stream is closed. c:type="GUnixOutputStreamPrivate" disguised="1" opaque="1"> - + glib:get-type="g_unix_socket_address_get_type" glib:type-struct="UnixSocketAddressClass"> Support for UNIX-domain (also known as local) sockets. + filename="gio/gunixsocketaddress.c" + line="37">Support for UNIX-domain (also known as local) sockets, corresponding to +`struct sockaddr_un`. UNIX domain sockets are generally visible in the filesystem. However, some systems support abstract socket names which are not visible in the filesystem and not affected by the filesystem permissions, visibility, etc. Currently this is only supported under Linux. If you attempt to use abstract sockets on other -systems, function calls may return %G_IO_ERROR_NOT_SUPPORTED -errors. You can use g_unix_socket_address_abstract_names_supported() +systems, function calls may return `G_IO_ERROR_NOT_SUPPORTED` +errors. You can use [func@Gio.UnixSocketAddress.abstract_names_supported] to see if abstract names are supported. -Since GLib 2.72, #GUnixSocketAddress is available on all platforms. It +Since GLib 2.72, `GUnixSocketAddress` is available on all platforms. It requires underlying system support (such as Windows 10 with `AF_UNIX`) at run time. Before GLib 2.72, `<gio/gunixsocketaddress.h>` belonged to the UNIX-specific GIO interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file when using it. This is no longer necessary since GLib 2.72. - + Creates a new #GUnixSocketAddress for @path. + filename="gio/gunixsocketaddress.c" + line="384">Creates a new #GUnixSocketAddress for @path. To create abstract socket addresses, on systems that support that, use g_unix_socket_address_new_abstract(). - + a new #GUnixSocketAddress + filename="gio/gunixsocketaddress.c" + line="393">a new #GUnixSocketAddress the socket path + filename="gio/gunixsocketaddress.c" + line="386">the socket path @@ -130222,31 +130596,30 @@ use g_unix_socket_address_new_abstract(). c:identifier="g_unix_socket_address_new_abstract" deprecated="1"> Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED + filename="gio/gunixsocketaddress.c" + line="406">Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED #GUnixSocketAddress for @path. Use g_unix_socket_address_new_with_type(). - + a new #GUnixSocketAddress + filename="gio/gunixsocketaddress.c" + line="414">a new #GUnixSocketAddress the abstract name + filename="gio/gunixsocketaddress.c" + line="408">the abstract name the length of @path, or -1 + filename="gio/gunixsocketaddress.c" + line="409">the length of @path, or -1 @@ -130255,8 +130628,8 @@ use g_unix_socket_address_new_abstract(). c:identifier="g_unix_socket_address_new_with_type" version="2.26"> Creates a new #GUnixSocketAddress of type @type with name @path. + filename="gio/gunixsocketaddress.c" + line="426">Creates a new #GUnixSocketAddress of type @type with name @path. If @type is %G_UNIX_SOCKET_ADDRESS_PATH, this is equivalent to calling g_unix_socket_address_new(). @@ -130287,33 +130660,32 @@ length of @path. when connecting to a server created by another process, you must use the appropriate type corresponding to how that process created its listening socket. - + a new #GUnixSocketAddress + filename="gio/gunixsocketaddress.c" + line="464">a new #GUnixSocketAddress the name + filename="gio/gunixsocketaddress.c" + line="428">the name the length of @path, or -1 + filename="gio/gunixsocketaddress.c" + line="429">the length of @path, or -1 a #GUnixSocketAddressType + filename="gio/gunixsocketaddress.c" + line="430">a #GUnixSocketAddressType @@ -130323,14 +130695,13 @@ its listening socket. c:identifier="g_unix_socket_address_abstract_names_supported" version="2.22"> Checks if abstract UNIX domain socket names are supported. - + filename="gio/gunixsocketaddress.c" + line="569">Checks if abstract UNIX domain socket names are supported. + %TRUE if supported, %FALSE otherwise + filename="gio/gunixsocketaddress.c" + line="574">%TRUE if supported, %FALSE otherwise @@ -130339,21 +130710,20 @@ its listening socket. glib:get-property="address-type" version="2.26"> Gets @address's type. - + filename="gio/gunixsocketaddress.c" + line="534">Gets @address's type. + a #GUnixSocketAddressType + filename="gio/gunixsocketaddress.c" + line="540">a #GUnixSocketAddressType a #GInetSocketAddress + filename="gio/gunixsocketaddress.c" + line="536">a #GInetSocketAddress @@ -130363,22 +130733,21 @@ its listening socket. version="2.22" deprecated="1"> Tests if @address is abstract. + filename="gio/gunixsocketaddress.c" + line="550">Tests if @address is abstract. Use g_unix_socket_address_get_address_type() - + %TRUE if the address is abstract, %FALSE otherwise + filename="gio/gunixsocketaddress.c" + line="556">%TRUE if the address is abstract, %FALSE otherwise a #GInetSocketAddress + filename="gio/gunixsocketaddress.c" + line="552">a #GInetSocketAddress @@ -130388,26 +130757,25 @@ its listening socket. glib:get-property="path" version="2.22"> Gets @address's path, or for abstract sockets the "name". + filename="gio/gunixsocketaddress.c" + line="495">Gets @address's path, or for abstract sockets the "name". Guaranteed to be zero-terminated, but an abstract socket may contain embedded zeros, and thus you should use g_unix_socket_address_get_path_len() to get the true length of this string. - + the path for @address + filename="gio/gunixsocketaddress.c" + line="506">the path for @address a #GInetSocketAddress + filename="gio/gunixsocketaddress.c" + line="497">a #GInetSocketAddress @@ -130416,23 +130784,22 @@ of this string. c:identifier="g_unix_socket_address_get_path_len" version="2.22"> Gets the length of @address's path. + filename="gio/gunixsocketaddress.c" + line="516">Gets the length of @address's path. For details, see g_unix_socket_address_get_path(). - + the length of the path + filename="gio/gunixsocketaddress.c" + line="524">the length of the path a #GInetSocketAddress + filename="gio/gunixsocketaddress.c" + line="518">a #GInetSocketAddress @@ -130444,33 +130811,45 @@ For details, see g_unix_socket_address_get_path(). transfer-ownership="none" default-value="FALSE"> Whether or not this is an abstract address + filename="gio/gunixsocketaddress.c" + line="299">Whether or not this is an abstract address Use #GUnixSocketAddress:address-type, which distinguishes between zero-padded and non-zero-padded abstract addresses. + The type of Unix socket address. + Unix socket path. + Unix socket path, as a byte array. @@ -130486,8 +130865,7 @@ abstract addresses. - + @@ -130496,8 +130874,7 @@ abstract addresses. c:type="GUnixSocketAddressPrivate" disguised="1" opaque="1"> - + glib:get-type="g_unix_socket_address_type_get_type" c:type="GUnixSocketAddressType"> The type of name used by a #GUnixSocketAddress. + filename="gio/gioenums.h" + line="932">The type of name used by a #GUnixSocketAddress. %G_UNIX_SOCKET_ADDRESS_PATH indicates a traditional unix domain socket bound to a filesystem path. %G_UNIX_SOCKET_ADDRESS_ANONYMOUS indicates a socket not bound to any name (eg, a client-side socket, @@ -130525,8 +130902,8 @@ pass an appropriate smaller length to bind() or connect(). This is glib:nick="invalid" glib:name="G_UNIX_SOCKET_ADDRESS_INVALID"> invalid + filename="gio/gioenums.h" + line="934">invalid anonymous + filename="gio/gioenums.h" + line="935">anonymous a filesystem path + filename="gio/gioenums.h" + line="936">a filesystem path an abstract name + filename="gio/gioenums.h" + line="937">an abstract name an abstract name, 0-padded + filename="gio/gioenums.h" + line="938">an abstract name, 0-padded to the full length of a unix socket name - + @@ -130577,8 +130953,7 @@ pass an appropriate smaller length to bind() or connect(). This is - + @@ -130588,26 +130963,23 @@ pass an appropriate smaller length to bind() or connect(). This is value="gio-vfs" c:type="G_VFS_EXTENSION_POINT_NAME"> Extension point for #GVfs functionality. See [Extending GIO][extending-gio]. - + - + - + @@ -130616,8 +130988,7 @@ See [Extending GIO][extending-gio]. - + @@ -130627,7 +130998,7 @@ See [Extending GIO][extending-gio]. value="class" c:type="G_VOLUME_IDENTIFIER_KIND_CLASS"> The string used to obtain the volume class with g_volume_get_identifier(). Known volume classes include `device`, `network`, and `loop`. Other @@ -130637,8 +131008,7 @@ This is intended to be used by applications to classify #GVolume instances into different sections - for example a file manager or file chooser can use this information to show `network` volumes under a "Network" heading and `device` volumes under a "Devices" heading. - + deprecated="1" deprecated-version="2.58"> The string used to obtain a Hal UDI with g_volume_get_identifier(). Do not use, HAL is deprecated. - + The string used to obtain a filesystem label with g_volume_get_identifier(). - + The string used to obtain a NFS mount with g_volume_get_identifier(). - + The string used to obtain a Unix device path with g_volume_get_identifier(). - + The string used to obtain a UUID with g_volume_get_identifier(). - + - + @@ -130707,8 +131071,7 @@ a "Network" heading and `device` volumes under a "Devices" heading. - + @@ -130718,18 +131081,16 @@ a "Network" heading and `device` volumes under a "Devices" heading. value="gio-volume-monitor" c:type="G_VOLUME_MONITOR_EXTENSION_POINT_NAME"> Extension point for volume monitor functionality. See [Extending GIO][extending-gio]. - + - + @@ -130743,40 +131104,36 @@ See [Extending GIO][extending-gio]. glib:get-type="g_vfs_get_type" glib:type-struct="VfsClass"> Entry point for using GIO functionality. - + filename="gio/gvfs.c" + line="33">Entry point for using GIO functionality. + Gets the default #GVfs for the system. - + filename="gio/gvfs.c" + line="341">Gets the default #GVfs for the system. + a #GVfs, which will be the local + filename="gio/gvfs.c" + line="346">a #GVfs, which will be the local file system #GVfs if no other implementation is available. Gets the local #GVfs for the system. - + filename="gio/gvfs.c" + line="369">Gets the local #GVfs for the system. + a #GVfs. + filename="gio/gvfs.c" + line="374">a #GVfs. - + @@ -130791,8 +131148,7 @@ See [Extending GIO][extending-gio]. - + @@ -130807,60 +131163,58 @@ See [Extending GIO][extending-gio]. Gets a #GFile for @path. - + filename="gio/gvfs.c" + line="144">Gets a #GFile for @path. + a #GFile. + filename="gio/gvfs.c" + line="151">a #GFile. Free the returned object with g_object_unref(). a #GVfs. + filename="gio/gvfs.c" + line="146">a #GVfs. a string containing a VFS path. + filename="gio/gvfs.c" + line="147">a string containing a VFS path. Gets a #GFile for @uri. + filename="gio/gvfs.c" + line="219">Gets a #GFile for @uri. This operation never fails, but the returned object might not support any I/O operation if the URI is malformed or if the URI scheme is not supported. - + a #GFile. + filename="gio/gvfs.c" + line="230">a #GFile. Free the returned object with g_object_unref(). a#GVfs. + filename="gio/gvfs.c" + line="221">a#GVfs. a string containing a URI + filename="gio/gvfs.c" + line="222">a string containing a URI @@ -130868,14 +131222,13 @@ is malformed or if the URI scheme is not supported. Gets a list of URI schemes supported by @vfs. - + filename="gio/gvfs.c" + line="254">Gets a list of URI schemes supported by @vfs. + a %NULL-terminated array of strings. + filename="gio/gvfs.c" + line="260">a %NULL-terminated array of strings. The returned array belongs to GIO and must not be freed or modified. @@ -130885,37 +131238,35 @@ is malformed or if the URI scheme is not supported. a #GVfs. + filename="gio/gvfs.c" + line="256">a #GVfs. Checks if the VFS is active. - + filename="gio/gvfs.c" + line="122">Checks if the VFS is active. + %TRUE if construction of the @vfs was successful + filename="gio/gvfs.c" + line="128">%TRUE if construction of the @vfs was successful and it is now active. a #GVfs. + filename="gio/gvfs.c" + line="124">a #GVfs. - + @@ -130955,8 +131306,7 @@ is malformed or if the URI scheme is not supported. - + @@ -130973,8 +131323,7 @@ is malformed or if the URI scheme is not supported. - + @@ -130988,8 +131337,7 @@ is malformed or if the URI scheme is not supported. - + @@ -131016,90 +131364,87 @@ is malformed or if the URI scheme is not supported. This operation never fails, but the returned object might + filename="gio/gvfs.c" + line="308">This operation never fails, but the returned object might not support any I/O operations if the @parse_name cannot be parsed by the #GVfs module. - + a #GFile for the given @parse_name. + filename="gio/gvfs.c" + line="317">a #GFile for the given @parse_name. Free the returned object with g_object_unref(). a #GVfs. + filename="gio/gvfs.c" + line="310">a #GVfs. a string to be parsed by the VFS module. + filename="gio/gvfs.c" + line="311">a string to be parsed by the VFS module. Gets a #GFile for @path. - + filename="gio/gvfs.c" + line="144">Gets a #GFile for @path. + a #GFile. + filename="gio/gvfs.c" + line="151">a #GFile. Free the returned object with g_object_unref(). a #GVfs. + filename="gio/gvfs.c" + line="146">a #GVfs. a string containing a VFS path. + filename="gio/gvfs.c" + line="147">a string containing a VFS path. Gets a #GFile for @uri. + filename="gio/gvfs.c" + line="219">Gets a #GFile for @uri. This operation never fails, but the returned object might not support any I/O operation if the URI is malformed or if the URI scheme is not supported. - + a #GFile. + filename="gio/gvfs.c" + line="230">a #GFile. Free the returned object with g_object_unref(). a#GVfs. + filename="gio/gvfs.c" + line="221">a#GVfs. a string containing a URI + filename="gio/gvfs.c" + line="222">a string containing a URI @@ -131107,14 +131452,13 @@ is malformed or if the URI scheme is not supported. Gets a list of URI schemes supported by @vfs. - + filename="gio/gvfs.c" + line="254">Gets a list of URI schemes supported by @vfs. + a %NULL-terminated array of strings. + filename="gio/gvfs.c" + line="260">a %NULL-terminated array of strings. The returned array belongs to GIO and must not be freed or modified. @@ -131124,60 +131468,58 @@ is malformed or if the URI scheme is not supported. a #GVfs. + filename="gio/gvfs.c" + line="256">a #GVfs. Checks if the VFS is active. - + filename="gio/gvfs.c" + line="122">Checks if the VFS is active. + %TRUE if construction of the @vfs was successful + filename="gio/gvfs.c" + line="128">%TRUE if construction of the @vfs was successful and it is now active. a #GVfs. + filename="gio/gvfs.c" + line="124">a #GVfs. This operation never fails, but the returned object might + filename="gio/gvfs.c" + line="308">This operation never fails, but the returned object might not support any I/O operations if the @parse_name cannot be parsed by the #GVfs module. - + a #GFile for the given @parse_name. + filename="gio/gvfs.c" + line="317">a #GFile for the given @parse_name. Free the returned object with g_object_unref(). a #GVfs. + filename="gio/gvfs.c" + line="310">a #GVfs. a string to be parsed by the VFS module. + filename="gio/gvfs.c" + line="311">a string to be parsed by the VFS module. @@ -131186,8 +131528,8 @@ be parsed by the #GVfs module. c:identifier="g_vfs_register_uri_scheme" version="2.50"> Registers @uri_func and @parse_name_func as the #GFile URI and parse name + filename="gio/gvfs.c" + line="387">Registers @uri_func and @parse_name_func as the #GFile URI and parse name lookup functions for URIs with a scheme matching @scheme. Note that @scheme is registered only within the running application, as opposed to desktop-wide as it happens with GVfs backends. @@ -131207,26 +131549,25 @@ g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme(). It's an error to call this function twice with the same scheme. To unregister a custom URI scheme, use g_vfs_unregister_uri_scheme(). - + %TRUE if @scheme was successfully registered, or %FALSE if a handler + filename="gio/gvfs.c" + line="424">%TRUE if @scheme was successfully registered, or %FALSE if a handler for @scheme already exists. a #GVfs + filename="gio/gvfs.c" + line="389">a #GVfs an URI scheme, e.g. "http" + filename="gio/gvfs.c" + line="390">an URI scheme, e.g. "http" closure="2" destroy="3"> a #GVfsFileLookupFunc + filename="gio/gvfs.c" + line="391">a #GVfsFileLookupFunc nullable="1" allow-none="1"> custom data passed to be passed to @uri_func, or %NULL + filename="gio/gvfs.c" + line="392">custom data passed to be passed to @uri_func, or %NULL allow-none="1" scope="async"> function to be called when unregistering the + filename="gio/gvfs.c" + line="393">function to be called when unregistering the URI scheme, or when @vfs is disposed, to free the resources used by the URI lookup function @@ -131270,8 +131611,8 @@ a custom URI scheme, use g_vfs_unregister_uri_scheme(). closure="5" destroy="6"> a #GVfsFileLookupFunc + filename="gio/gvfs.c" + line="396">a #GVfsFileLookupFunc nullable="1" allow-none="1"> custom data passed to be passed to + filename="gio/gvfs.c" + line="397">custom data passed to be passed to @parse_name_func, or %NULL @@ -131290,8 +131631,8 @@ a custom URI scheme, use g_vfs_unregister_uri_scheme(). allow-none="1" scope="async"> function to be called when unregistering the + filename="gio/gvfs.c" + line="399">function to be called when unregistering the URI scheme, or when @vfs is disposed, to free the resources used by the parse name lookup function @@ -131302,29 +131643,28 @@ a custom URI scheme, use g_vfs_unregister_uri_scheme(). c:identifier="g_vfs_unregister_uri_scheme" version="2.50"> Unregisters the URI handler for @scheme previously registered with + filename="gio/gvfs.c" + line="472">Unregisters the URI handler for @scheme previously registered with g_vfs_register_uri_scheme(). - + %TRUE if @scheme was successfully unregistered, or %FALSE if a + filename="gio/gvfs.c" + line="480">%TRUE if @scheme was successfully unregistered, or %FALSE if a handler for @scheme does not exist. a #GVfs + filename="gio/gvfs.c" + line="474">a #GVfs an URI scheme, e.g. "http" + filename="gio/gvfs.c" + line="475">an URI scheme, e.g. "http" @@ -131334,27 +131674,25 @@ g_vfs_register_uri_scheme(). - + - + %TRUE if construction of the @vfs was successful + filename="gio/gvfs.c" + line="128">%TRUE if construction of the @vfs was successful and it is now active. a #GVfs. + filename="gio/gvfs.c" + line="124">a #GVfs. @@ -131362,26 +131700,25 @@ g_vfs_register_uri_scheme(). - + a #GFile. + filename="gio/gvfs.c" + line="151">a #GFile. Free the returned object with g_object_unref(). a #GVfs. + filename="gio/gvfs.c" + line="146">a #GVfs. a string containing a VFS path. + filename="gio/gvfs.c" + line="147">a string containing a VFS path. @@ -131389,26 +131726,25 @@ g_vfs_register_uri_scheme(). - + a #GFile. + filename="gio/gvfs.c" + line="230">a #GFile. Free the returned object with g_object_unref(). a#GVfs. + filename="gio/gvfs.c" + line="221">a#GVfs. a string containing a URI + filename="gio/gvfs.c" + line="222">a string containing a URI @@ -131416,12 +131752,11 @@ g_vfs_register_uri_scheme(). - + a %NULL-terminated array of strings. + filename="gio/gvfs.c" + line="260">a %NULL-terminated array of strings. The returned array belongs to GIO and must not be freed or modified. @@ -131431,8 +131766,8 @@ g_vfs_register_uri_scheme(). a #GVfs. + filename="gio/gvfs.c" + line="256">a #GVfs. @@ -131440,26 +131775,25 @@ g_vfs_register_uri_scheme(). - + a #GFile for the given @parse_name. + filename="gio/gvfs.c" + line="317">a #GFile for the given @parse_name. Free the returned object with g_object_unref(). a #GVfs. + filename="gio/gvfs.c" + line="310">a #GVfs. a string to be parsed by the VFS module. + filename="gio/gvfs.c" + line="311">a string to be parsed by the VFS module. @@ -131467,8 +131801,7 @@ g_vfs_register_uri_scheme(). - + @@ -131511,8 +131844,7 @@ g_vfs_register_uri_scheme(). - + @@ -131529,8 +131861,7 @@ g_vfs_register_uri_scheme(). - + @@ -131558,8 +131889,7 @@ g_vfs_register_uri_scheme(). - + @@ -131575,8 +131905,7 @@ g_vfs_register_uri_scheme(). - + @@ -131595,8 +131924,7 @@ g_vfs_register_uri_scheme(). - + @@ -131612,8 +131940,7 @@ g_vfs_register_uri_scheme(). - + @@ -131621,8 +131948,7 @@ g_vfs_register_uri_scheme(). - + @@ -131630,8 +131956,7 @@ g_vfs_register_uri_scheme(). - + @@ -131639,8 +131964,7 @@ g_vfs_register_uri_scheme(). - + @@ -131648,8 +131972,7 @@ g_vfs_register_uri_scheme(). - + @@ -131657,8 +131980,7 @@ g_vfs_register_uri_scheme(). - + @@ -131669,31 +131991,30 @@ g_vfs_register_uri_scheme(). c:type="GVfsFileLookupFunc" version="2.50"> This function type is used by g_vfs_register_uri_scheme() to make it possible for a client to associate an URI scheme to a different #GFile implementation. The client should return a reference to the new file that has been created for @uri, or %NULL to continue with the default implementation. - + a #GFile for @identifier. a #GVfs the identifier to look up a #GFile for. This can either be an URI or a parse name as returned by g_file_get_parse_name() @@ -131704,7 +132025,7 @@ created for @uri, or %NULL to continue with the default implementation. allow-none="1" closure="2"> user data passed to the function @@ -131717,95 +132038,94 @@ created for @uri, or %NULL to continue with the default implementation. glib:get-type="g_volume_get_type" glib:type-struct="VolumeIface"> The #GVolume interface represents user-visible objects that can be -mounted. Note, when porting from GnomeVFS, #GVolume is the moral -equivalent of #GnomeVFSDrive. + filename="gio/gvolume.c" + line="34">The `GVolume` interface represents user-visible objects that can be +mounted. Note, when [porting from GnomeVFS](migrating-gnome-vfs.html), +`GVolume` is the moral equivalent of `GnomeVFSDrive`. -Mounting a #GVolume instance is an asynchronous operation. For more -information about asynchronous operations, see #GAsyncResult and -#GTask. To mount a #GVolume, first call g_volume_mount() with (at -least) the #GVolume instance, optionally a #GMountOperation object -and a #GAsyncReadyCallback. +Mounting a `GVolume` instance is an asynchronous operation. For more +information about asynchronous operations, see [iface@Gio.AsyncResult] and +[class@Gio.Task]. To mount a `GVolume`, first call [method@Gio.Volume.mount] +with (at least) the `GVolume` instance, optionally a +[class@Gio.MountOperation] object and a [type@Gio.AsyncReadyCallback]. -Typically, one will only want to pass %NULL for the -#GMountOperation if automounting all volumes when a desktop session -starts since it's not desirable to put up a lot of dialogs asking +Typically, one will only want to pass `NULL` for the +[class@Gio.MountOperation] if automounting all volumes when a desktop session +starts since it’s not desirable to put up a lot of dialogs asking for credentials. The callback will be fired when the operation has resolved (either -with success or failure), and a #GAsyncResult instance will be +with success or failure), and a [iface@Gio.AsyncResult] instance will be passed to the callback. That callback should then call -g_volume_mount_finish() with the #GVolume instance and the -#GAsyncResult data to see if the operation was completed -successfully. If an @error is present when g_volume_mount_finish() -is called, then it will be filled with any error information. +[method@Gio.Volume.mount_finish] with the `GVolume` instance and the +[iface@Gio.AsyncResult] data to see if the operation was completed +successfully. If a [type@GLib.Error] is present when +[method@Gio.Volume.mount_finish] is called, then it will be filled with any +error information. -## Volume Identifiers # {#volume-identifier} +## Volume Identifiers It is sometimes necessary to directly access the underlying operating system object behind a volume (e.g. for passing a volume -to an application via the commandline). For this purpose, GIO -allows to obtain an 'identifier' for the volume. There can be +to an application via the command line). For this purpose, GIO +allows to obtain an ‘identifier’ for the volume. There can be different kinds of identifiers, such as Hal UDIs, filesystem labels, traditional Unix devices (e.g. `/dev/sda2`), UUIDs. GIO uses predefined strings as names for the different kinds of identifiers: -%G_VOLUME_IDENTIFIER_KIND_UUID, %G_VOLUME_IDENTIFIER_KIND_LABEL, etc. -Use g_volume_get_identifier() to obtain an identifier for a volume. +`G_VOLUME_IDENTIFIER_KIND_UUID`, `G_VOLUME_IDENTIFIER_KIND_LABEL`, etc. +Use [method@Gio.Volume.get_identifier] to obtain an identifier for a volume. - -Note that %G_VOLUME_IDENTIFIER_KIND_HAL_UDI will only be available -when the gvfs hal volume monitor is in use. Other volume monitors -will generally be able to provide the %G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE +Note that `G_VOLUME_IDENTIFIER_KIND_HAL_UDI` will only be available +when the GVFS hal volume monitor is in use. Other volume monitors +will generally be able to provide the `G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE` identifier, which can be used to obtain a hal device by means of -libhal_manager_find_device_string_match(). - +`libhal_manager_find_device_string_match()`. + Checks if a volume can be ejected. - + filename="gio/gvolume.c" + line="283">Checks if a volume can be ejected. + %TRUE if the @volume can be ejected. %FALSE otherwise + filename="gio/gvolume.c" + line="289">%TRUE if the @volume can be ejected. %FALSE otherwise a #GVolume + filename="gio/gvolume.c" + line="285">a #GVolume Checks if a volume can be mounted. - + filename="gio/gvolume.c" + line="260">Checks if a volume can be mounted. + %TRUE if the @volume can be mounted. %FALSE otherwise + filename="gio/gvolume.c" + line="266">%TRUE if the @volume can be mounted. %FALSE otherwise a #GVolume + filename="gio/gvolume.c" + line="262">a #GVolume - + Changed signal that is emitted when the volume's state has changed. + @@ -131818,29 +132138,29 @@ libhal_manager_find_device_string_match(). + deprecated-version="2.22" + glib:finish-func="eject_finish"> Ejects a volume. This is an asynchronous operation, and is + filename="gio/gvolume.c" + line="404">Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_finish() with the @volume and #GAsyncResult returned in the @callback. Use g_volume_eject_with_operation() instead. - + a #GVolume + filename="gio/gvolume.c" + line="406">a #GVolume flags affecting the unmount if required for eject + filename="gio/gvolume.c" + line="407">flags affecting the unmount if required for eject nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gvolume.c" + line="408">optional #GCancellable object, %NULL to ignore scope="async" closure="3"> a #GAsyncReadyCallback, or %NULL + filename="gio/gvolume.c" + line="409">a #GAsyncReadyCallback, or %NULL allow-none="1" closure="3"> user data that gets passed to @callback + filename="gio/gvolume.c" + line="410">user data that gets passed to @callback @@ -131881,57 +132201,56 @@ and #GAsyncResult returned in the @callback. deprecated-version="2.22" throws="1"> Finishes ejecting a volume. If any errors occurred during the operation, + filename="gio/gvolume.c" + line="443">Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_volume_eject_with_operation_finish() instead. - + %TRUE, %FALSE if operation failed + filename="gio/gvolume.c" + line="452">%TRUE, %FALSE if operation failed pointer to a #GVolume + filename="gio/gvolume.c" + line="445">pointer to a #GVolume a #GAsyncResult + filename="gio/gvolume.c" + line="446">a #GAsyncResult + version="2.22" + glib:finish-func="eject_with_operation_finish"> Ejects a volume. This is an asynchronous operation, and is + filename="gio/gvolume.c" + line="475">Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_with_operation_finish() with the @volume and #GAsyncResult data returned in the @callback. - + a #GVolume + filename="gio/gvolume.c" + line="477">a #GVolume flags affecting the unmount if required for eject + filename="gio/gvolume.c" + line="478">flags affecting the unmount if required for eject nullable="1" allow-none="1"> a #GMountOperation or %NULL to + filename="gio/gvolume.c" + line="479">a #GMountOperation or %NULL to avoid user interaction @@ -131949,8 +132268,8 @@ and #GAsyncResult data returned in the @callback. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gvolume.c" + line="481">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL + filename="gio/gvolume.c" + line="482">a #GAsyncReadyCallback, or %NULL allow-none="1" closure="4"> user data passed to @callback + filename="gio/gvolume.c" + line="483">user data passed to @callback @@ -131981,28 +132300,27 @@ and #GAsyncResult data returned in the @callback. version="2.22" throws="1"> Finishes ejecting a volume. If any errors occurred during the operation, + filename="gio/gvolume.c" + line="523">Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + %TRUE if the volume was successfully ejected. %FALSE otherwise + filename="gio/gvolume.c" + line="532">%TRUE if the volume was successfully ejected. %FALSE otherwise a #GVolume + filename="gio/gvolume.c" + line="525">a #GVolume a #GAsyncResult + filename="gio/gvolume.c" + line="526">a #GAsyncResult @@ -132010,15 +132328,14 @@ and #GAsyncResult data returned in the @callback. Gets the kinds of [identifiers][volume-identifier] that @volume has. + filename="gio/gvolume.c" + line="588">Gets the kinds of [identifiers](#volume-identifiers) that @volume has. Use g_volume_get_identifier() to obtain the identifiers themselves. - + a %NULL-terminated array + filename="gio/gvolume.c" + line="595">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -132027,8 +132344,8 @@ Use g_volume_get_identifier() to obtain the identifiers themselves. a #GVolume + filename="gio/gvolume.c" + line="590">a #GVolume @@ -132037,8 +132354,8 @@ Use g_volume_get_identifier() to obtain the identifiers themselves. invoker="get_activation_root" version="2.18"> Gets the activation root for a #GVolume if it is known ahead of + filename="gio/gvolume.c" + line="612">Gets the activation root for a #GVolume if it is known ahead of mount time. Returns %NULL otherwise. If not %NULL and if @volume is mounted, then the result of g_mount_get_root() on the #GMount object obtained from g_volume_get_mount() will always @@ -132064,34 +132381,32 @@ will always be %TRUE. Activation roots are typically used in #GVolumeMonitor implementations to find the underlying mount to shadow, see g_mount_is_shadowed() for more details. - + the activation root of @volume + filename="gio/gvolume.c" + line="643">the activation root of @volume or %NULL. Use g_object_unref() to free. a #GVolume + filename="gio/gvolume.c" + line="614">a #GVolume Gets the drive for the @volume. - + filename="gio/gvolume.c" + line="215">Gets the drive for the @volume. + a #GDrive or %NULL if @volume is not + filename="gio/gvolume.c" + line="221">a #GDrive or %NULL if @volume is not associated with a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -132099,22 +132414,21 @@ g_mount_is_shadowed() for more details. a #GVolume + filename="gio/gvolume.c" + line="217">a #GVolume Gets the icon for @volume. - + filename="gio/gvolume.c" + line="136">Gets the icon for @volume. + a #GIcon. + filename="gio/gvolume.c" + line="142">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -132122,24 +132436,23 @@ g_mount_is_shadowed() for more details. a #GVolume + filename="gio/gvolume.c" + line="138">a #GVolume Gets the identifier of the given kind for @volume. -See the [introduction][volume-identifier] for more + filename="gio/gvolume.c" + line="558">Gets the identifier of the given kind for @volume. +See the [introduction](#volume-identifiers) for more information about volume identifiers. - + a newly allocated string containing the + filename="gio/gvolume.c" + line="567">a newly allocated string containing the requested identifier, or %NULL if the #GVolume doesn't have this kind of identifier @@ -132147,28 +132460,27 @@ information about volume identifiers. a #GVolume + filename="gio/gvolume.c" + line="560">a #GVolume the kind of identifier to return + filename="gio/gvolume.c" + line="561">the kind of identifier to return Gets the mount for the @volume. - + filename="gio/gvolume.c" + line="237">Gets the mount for the @volume. + a #GMount or %NULL if @volume isn't mounted. + filename="gio/gvolume.c" + line="243">a #GMount or %NULL if @volume isn't mounted. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -132176,30 +132488,29 @@ information about volume identifiers. a #GVolume + filename="gio/gvolume.c" + line="239">a #GVolume Gets the name of @volume. - + filename="gio/gvolume.c" + line="115">Gets the name of @volume. + the name for the given @volume. The returned string should + filename="gio/gvolume.c" + line="121">the name for the given @volume. The returned string should be freed with g_free() when no longer needed. a #GVolume + filename="gio/gvolume.c" + line="117">a #GVolume @@ -132208,21 +132519,20 @@ information about volume identifiers. invoker="get_sort_key" version="2.32"> Gets the sort key for @volume, if any. - + filename="gio/gvolume.c" + line="662">Gets the sort key for @volume, if any. + Sorting key for @volume or %NULL if no such key is available + filename="gio/gvolume.c" + line="668">Sorting key for @volume or %NULL if no such key is available a #GVolume + filename="gio/gvolume.c" + line="664">a #GVolume @@ -132231,14 +132541,13 @@ information about volume identifiers. invoker="get_symbolic_icon" version="2.34"> Gets the symbolic icon for @volume. - + filename="gio/gvolume.c" + line="158">Gets the symbolic icon for @volume. + a #GIcon. + filename="gio/gvolume.c" + line="164">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -132246,25 +132555,24 @@ information about volume identifiers. a #GVolume + filename="gio/gvolume.c" + line="160">a #GVolume Gets the UUID for the @volume. The reference is typically based on + filename="gio/gvolume.c" + line="189">Gets the UUID for the @volume. The reference is typically based on the file system UUID for the volume in question and should be considered an opaque string. Returns %NULL if there is no UUID available. - + the UUID for @volume or %NULL if no UUID + filename="gio/gvolume.c" + line="198">the UUID for @volume or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -132273,67 +132581,65 @@ available. a #GVolume + filename="gio/gvolume.c" + line="191">a #GVolume Finishes mounting a volume. If any errors occurred during the operation, + filename="gio/gvolume.c" + line="369">Finishes mounting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. If the mount operation succeeded, g_volume_get_mount() on @volume is guaranteed to return the mount right after calling this function; there's no need to listen for the 'mount-added' signal on #GVolumeMonitor. - + %TRUE, %FALSE if operation failed + filename="gio/gvolume.c" + line="383">%TRUE, %FALSE if operation failed a #GVolume + filename="gio/gvolume.c" + line="371">a #GVolume a #GAsyncResult + filename="gio/gvolume.c" + line="372">a #GAsyncResult Mounts a volume. This is an asynchronous operation, and is + filename="gio/gvolume.c" + line="330">Mounts a volume. This is an asynchronous operation, and is finished by calling g_volume_mount_finish() with the @volume and #GAsyncResult returned in the @callback. - + a #GVolume + filename="gio/gvolume.c" + line="332">a #GVolume flags affecting the operation + filename="gio/gvolume.c" + line="333">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid user interaction + filename="gio/gvolume.c" + line="334">a #GMountOperation or %NULL to avoid user interaction nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gvolume.c" + line="335">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL + filename="gio/gvolume.c" + line="336">a #GAsyncReadyCallback, or %NULL allow-none="1" closure="4"> user data that gets passed to @callback + filename="gio/gvolume.c" + line="337">user data that gets passed to @callback - + The removed signal that is emitted when the #GVolume have been removed. If the recipient is holding references to the object they should release them so the object can be finalized. + @@ -132391,63 +132699,60 @@ and #GAsyncResult returned in the @callback. Returns whether the volume should be automatically mounted. - + filename="gio/gvolume.c" + line="306">Returns whether the volume should be automatically mounted. + %TRUE if the volume should be automatically mounted + filename="gio/gvolume.c" + line="312">%TRUE if the volume should be automatically mounted a #GVolume + filename="gio/gvolume.c" + line="308">a #GVolume Checks if a volume can be ejected. - + filename="gio/gvolume.c" + line="283">Checks if a volume can be ejected. + %TRUE if the @volume can be ejected. %FALSE otherwise + filename="gio/gvolume.c" + line="289">%TRUE if the @volume can be ejected. %FALSE otherwise a #GVolume + filename="gio/gvolume.c" + line="285">a #GVolume Checks if a volume can be mounted. - + filename="gio/gvolume.c" + line="260">Checks if a volume can be mounted. + %TRUE if the @volume can be mounted. %FALSE otherwise + filename="gio/gvolume.c" + line="266">%TRUE if the @volume can be mounted. %FALSE otherwise a #GVolume + filename="gio/gvolume.c" + line="262">a #GVolume @@ -132455,29 +132760,29 @@ and #GAsyncResult returned in the @callback. + deprecated-version="2.22" + glib:finish-func="eject_finish"> Ejects a volume. This is an asynchronous operation, and is + filename="gio/gvolume.c" + line="404">Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_finish() with the @volume and #GAsyncResult returned in the @callback. Use g_volume_eject_with_operation() instead. - + a #GVolume + filename="gio/gvolume.c" + line="406">a #GVolume flags affecting the unmount if required for eject + filename="gio/gvolume.c" + line="407">flags affecting the unmount if required for eject nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gvolume.c" + line="408">optional #GCancellable object, %NULL to ignore scope="async" closure="3"> a #GAsyncReadyCallback, or %NULL + filename="gio/gvolume.c" + line="409">a #GAsyncReadyCallback, or %NULL nullable="1" allow-none="1"> user data that gets passed to @callback + filename="gio/gvolume.c" + line="410">user data that gets passed to @callback @@ -132517,57 +132822,56 @@ and #GAsyncResult returned in the @callback. deprecated-version="2.22" throws="1"> Finishes ejecting a volume. If any errors occurred during the operation, + filename="gio/gvolume.c" + line="443">Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. Use g_volume_eject_with_operation_finish() instead. - + %TRUE, %FALSE if operation failed + filename="gio/gvolume.c" + line="452">%TRUE, %FALSE if operation failed pointer to a #GVolume + filename="gio/gvolume.c" + line="445">pointer to a #GVolume a #GAsyncResult + filename="gio/gvolume.c" + line="446">a #GAsyncResult + version="2.22" + glib:finish-func="eject_with_operation_finish"> Ejects a volume. This is an asynchronous operation, and is + filename="gio/gvolume.c" + line="475">Ejects a volume. This is an asynchronous operation, and is finished by calling g_volume_eject_with_operation_finish() with the @volume and #GAsyncResult data returned in the @callback. - + a #GVolume + filename="gio/gvolume.c" + line="477">a #GVolume flags affecting the unmount if required for eject + filename="gio/gvolume.c" + line="478">flags affecting the unmount if required for eject nullable="1" allow-none="1"> a #GMountOperation or %NULL to + filename="gio/gvolume.c" + line="479">a #GMountOperation or %NULL to avoid user interaction @@ -132585,8 +132889,8 @@ and #GAsyncResult data returned in the @callback. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gvolume.c" + line="481">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL + filename="gio/gvolume.c" + line="482">a #GAsyncReadyCallback, or %NULL nullable="1" allow-none="1"> user data passed to @callback + filename="gio/gvolume.c" + line="483">user data passed to @callback @@ -132616,28 +132920,27 @@ and #GAsyncResult data returned in the @callback. version="2.22" throws="1"> Finishes ejecting a volume. If any errors occurred during the operation, + filename="gio/gvolume.c" + line="523">Finishes ejecting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. - + %TRUE if the volume was successfully ejected. %FALSE otherwise + filename="gio/gvolume.c" + line="532">%TRUE if the volume was successfully ejected. %FALSE otherwise a #GVolume + filename="gio/gvolume.c" + line="525">a #GVolume a #GAsyncResult + filename="gio/gvolume.c" + line="526">a #GAsyncResult @@ -132645,15 +132948,14 @@ and #GAsyncResult data returned in the @callback. Gets the kinds of [identifiers][volume-identifier] that @volume has. + filename="gio/gvolume.c" + line="588">Gets the kinds of [identifiers](#volume-identifiers) that @volume has. Use g_volume_get_identifier() to obtain the identifiers themselves. - + a %NULL-terminated array + filename="gio/gvolume.c" + line="595">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -132662,8 +132964,8 @@ Use g_volume_get_identifier() to obtain the identifiers themselves. a #GVolume + filename="gio/gvolume.c" + line="590">a #GVolume @@ -132672,8 +132974,8 @@ Use g_volume_get_identifier() to obtain the identifiers themselves. c:identifier="g_volume_get_activation_root" version="2.18"> Gets the activation root for a #GVolume if it is known ahead of + filename="gio/gvolume.c" + line="612">Gets the activation root for a #GVolume if it is known ahead of mount time. Returns %NULL otherwise. If not %NULL and if @volume is mounted, then the result of g_mount_get_root() on the #GMount object obtained from g_volume_get_mount() will always @@ -132699,34 +133001,32 @@ will always be %TRUE. Activation roots are typically used in #GVolumeMonitor implementations to find the underlying mount to shadow, see g_mount_is_shadowed() for more details. - + the activation root of @volume + filename="gio/gvolume.c" + line="643">the activation root of @volume or %NULL. Use g_object_unref() to free. a #GVolume + filename="gio/gvolume.c" + line="614">a #GVolume Gets the drive for the @volume. - + filename="gio/gvolume.c" + line="215">Gets the drive for the @volume. + a #GDrive or %NULL if @volume is not + filename="gio/gvolume.c" + line="221">a #GDrive or %NULL if @volume is not associated with a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -132734,22 +133034,21 @@ g_mount_is_shadowed() for more details. a #GVolume + filename="gio/gvolume.c" + line="217">a #GVolume Gets the icon for @volume. - + filename="gio/gvolume.c" + line="136">Gets the icon for @volume. + a #GIcon. + filename="gio/gvolume.c" + line="142">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -132757,24 +133056,23 @@ g_mount_is_shadowed() for more details. a #GVolume + filename="gio/gvolume.c" + line="138">a #GVolume Gets the identifier of the given kind for @volume. -See the [introduction][volume-identifier] for more + filename="gio/gvolume.c" + line="558">Gets the identifier of the given kind for @volume. +See the [introduction](#volume-identifiers) for more information about volume identifiers. - + a newly allocated string containing the + filename="gio/gvolume.c" + line="567">a newly allocated string containing the requested identifier, or %NULL if the #GVolume doesn't have this kind of identifier @@ -132782,28 +133080,27 @@ information about volume identifiers. a #GVolume + filename="gio/gvolume.c" + line="560">a #GVolume the kind of identifier to return + filename="gio/gvolume.c" + line="561">the kind of identifier to return Gets the mount for the @volume. - + filename="gio/gvolume.c" + line="237">Gets the mount for the @volume. + a #GMount or %NULL if @volume isn't mounted. + filename="gio/gvolume.c" + line="243">a #GMount or %NULL if @volume isn't mounted. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -132811,30 +133108,29 @@ information about volume identifiers. a #GVolume + filename="gio/gvolume.c" + line="239">a #GVolume Gets the name of @volume. - + filename="gio/gvolume.c" + line="115">Gets the name of @volume. + the name for the given @volume. The returned string should + filename="gio/gvolume.c" + line="121">the name for the given @volume. The returned string should be freed with g_free() when no longer needed. a #GVolume + filename="gio/gvolume.c" + line="117">a #GVolume @@ -132843,21 +133139,20 @@ information about volume identifiers. c:identifier="g_volume_get_sort_key" version="2.32"> Gets the sort key for @volume, if any. - + filename="gio/gvolume.c" + line="662">Gets the sort key for @volume, if any. + Sorting key for @volume or %NULL if no such key is available + filename="gio/gvolume.c" + line="668">Sorting key for @volume or %NULL if no such key is available a #GVolume + filename="gio/gvolume.c" + line="664">a #GVolume @@ -132866,14 +133161,13 @@ information about volume identifiers. c:identifier="g_volume_get_symbolic_icon" version="2.34"> Gets the symbolic icon for @volume. - + filename="gio/gvolume.c" + line="158">Gets the symbolic icon for @volume. + a #GIcon. + filename="gio/gvolume.c" + line="164">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -132881,25 +133175,24 @@ information about volume identifiers. a #GVolume + filename="gio/gvolume.c" + line="160">a #GVolume Gets the UUID for the @volume. The reference is typically based on + filename="gio/gvolume.c" + line="189">Gets the UUID for the @volume. The reference is typically based on the file system UUID for the volume in question and should be considered an opaque string. Returns %NULL if there is no UUID available. - + the UUID for @volume or %NULL if no UUID + filename="gio/gvolume.c" + line="198">the UUID for @volume or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -132908,34 +133201,35 @@ available. a #GVolume + filename="gio/gvolume.c" + line="191">a #GVolume - + Mounts a volume. This is an asynchronous operation, and is + filename="gio/gvolume.c" + line="330">Mounts a volume. This is an asynchronous operation, and is finished by calling g_volume_mount_finish() with the @volume and #GAsyncResult returned in the @callback. - + a #GVolume + filename="gio/gvolume.c" + line="332">a #GVolume flags affecting the operation + filename="gio/gvolume.c" + line="333">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid user interaction + filename="gio/gvolume.c" + line="334">a #GMountOperation or %NULL to avoid user interaction nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gvolume.c" + line="335">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL + filename="gio/gvolume.c" + line="336">a #GAsyncReadyCallback, or %NULL nullable="1" allow-none="1"> user data that gets passed to @callback + filename="gio/gvolume.c" + line="337">user data that gets passed to @callback @@ -132982,70 +133276,68 @@ and #GAsyncResult returned in the @callback. c:identifier="g_volume_mount_finish" throws="1"> Finishes mounting a volume. If any errors occurred during the operation, + filename="gio/gvolume.c" + line="369">Finishes mounting a volume. If any errors occurred during the operation, @error will be set to contain the errors and %FALSE will be returned. If the mount operation succeeded, g_volume_get_mount() on @volume is guaranteed to return the mount right after calling this function; there's no need to listen for the 'mount-added' signal on #GVolumeMonitor. - + %TRUE, %FALSE if operation failed + filename="gio/gvolume.c" + line="383">%TRUE, %FALSE if operation failed a #GVolume + filename="gio/gvolume.c" + line="371">a #GVolume a #GAsyncResult + filename="gio/gvolume.c" + line="372">a #GAsyncResult Returns whether the volume should be automatically mounted. - + filename="gio/gvolume.c" + line="306">Returns whether the volume should be automatically mounted. + %TRUE if the volume should be automatically mounted + filename="gio/gvolume.c" + line="312">%TRUE if the volume should be automatically mounted a #GVolume + filename="gio/gvolume.c" + line="308">a #GVolume Emitted when the volume has been changed. + filename="gio/gvolume.c" + line="86">Emitted when the volume has been changed. This signal is emitted when the #GVolume have been removed. If + filename="gio/gvolume.c" + line="99">This signal is emitted when the #GVolume have been removed. If the recipient is holding references to the object they should release them so the object can be finalized. @@ -133057,20 +133349,21 @@ release them so the object can be finalized. c:type="GVolumeIface" glib:is-gtype-struct-for="Volume"> Interface for implementing operations for mountable volumes. - + The parent interface. + Changed signal that is emitted when the volume's state has changed. - + @@ -133082,9 +133375,11 @@ release them so the object can be finalized. + The removed signal that is emitted when the #GVolume have been removed. If the recipient is holding references to the object they should release them so the object can be finalized. - + @@ -133096,34 +133391,38 @@ release them so the object can be finalized. + Gets a string containing the name of the #GVolume. - + the name for the given @volume. The returned string should + filename="gio/gvolume.c" + line="121">the name for the given @volume. The returned string should be freed with g_free() when no longer needed. a #GVolume + filename="gio/gvolume.c" + line="117">a #GVolume + Gets a #GIcon for the #GVolume. - + a #GIcon. + filename="gio/gvolume.c" + line="142">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -133131,21 +133430,23 @@ release them so the object can be finalized. a #GVolume + filename="gio/gvolume.c" + line="138">a #GVolume + Gets the UUID for the #GVolume. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available. - + the UUID for @volume or %NULL if no UUID + filename="gio/gvolume.c" + line="198">the UUID for @volume or %NULL if no UUID can be computed. The returned string should be freed with g_free() when no longer needed. @@ -133154,21 +133455,23 @@ release them so the object can be finalized. a #GVolume + filename="gio/gvolume.c" + line="191">a #GVolume + Gets a #GDrive the volume is located on. Returns %NULL if the #GVolume is not associated with a #GDrive. - + a #GDrive or %NULL if @volume is not + filename="gio/gvolume.c" + line="221">a #GDrive or %NULL if @volume is not associated with a drive. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -133176,21 +133479,23 @@ release them so the object can be finalized. a #GVolume + filename="gio/gvolume.c" + line="217">a #GVolume + Gets a #GMount representing the mounted volume. Returns %NULL if the #GVolume is not mounted. - + a #GMount or %NULL if @volume isn't mounted. + filename="gio/gvolume.c" + line="243">a #GMount or %NULL if @volume isn't mounted. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -133198,71 +133503,80 @@ release them so the object can be finalized. a #GVolume + filename="gio/gvolume.c" + line="239">a #GVolume + Returns %TRUE if the #GVolume can be mounted. - + %TRUE if the @volume can be mounted. %FALSE otherwise + filename="gio/gvolume.c" + line="266">%TRUE if the @volume can be mounted. %FALSE otherwise a #GVolume + filename="gio/gvolume.c" + line="262">a #GVolume + Checks if a #GVolume can be ejected. - + %TRUE if the @volume can be ejected. %FALSE otherwise + filename="gio/gvolume.c" + line="289">%TRUE if the @volume can be ejected. %FALSE otherwise a #GVolume + filename="gio/gvolume.c" + line="285">a #GVolume + Mounts a given #GVolume. + #GVolume implementations must emit the #GMountOperation::aborted + signal before completing a mount operation that is aborted while + awaiting input from the user through a #GMountOperation instance. - + a #GVolume + filename="gio/gvolume.c" + line="332">a #GVolume flags affecting the operation + filename="gio/gvolume.c" + line="333">flags affecting the operation nullable="1" allow-none="1"> a #GMountOperation or %NULL to avoid user interaction + filename="gio/gvolume.c" + line="334">a #GMountOperation or %NULL to avoid user interaction nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gvolume.c" + line="335">optional #GCancellable object, %NULL to ignore scope="async" closure="5"> a #GAsyncReadyCallback, or %NULL + filename="gio/gvolume.c" + line="336">a #GAsyncReadyCallback, or %NULL allow-none="1" closure="5"> user data that gets passed to @callback + filename="gio/gvolume.c" + line="337">user data that gets passed to @callback + Finishes a mount operation. - + %TRUE, %FALSE if operation failed + filename="gio/gvolume.c" + line="383">%TRUE, %FALSE if operation failed a #GVolume + filename="gio/gvolume.c" + line="371">a #GVolume a #GAsyncResult + filename="gio/gvolume.c" + line="372">a #GAsyncResult + Ejects a given #GVolume. - + a #GVolume + filename="gio/gvolume.c" + line="406">a #GVolume flags affecting the unmount if required for eject + filename="gio/gvolume.c" + line="407">flags affecting the unmount if required for eject nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gvolume.c" + line="408">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback, or %NULL + filename="gio/gvolume.c" + line="409">a #GAsyncReadyCallback, or %NULL allow-none="1" closure="4"> user data that gets passed to @callback + filename="gio/gvolume.c" + line="410">user data that gets passed to @callback + Finishes an eject operation. - + %TRUE, %FALSE if operation failed + filename="gio/gvolume.c" + line="452">%TRUE, %FALSE if operation failed pointer to a #GVolume + filename="gio/gvolume.c" + line="445">pointer to a #GVolume a #GAsyncResult + filename="gio/gvolume.c" + line="446">a #GAsyncResult + Returns the [identifier](#volume-identifiers) of the given kind, or %NULL if + the #GVolume doesn't have one. - + a newly allocated string containing the + filename="gio/gvolume.c" + line="567">a newly allocated string containing the requested identifier, or %NULL if the #GVolume doesn't have this kind of identifier @@ -133427,27 +133750,30 @@ release them so the object can be finalized. a #GVolume + filename="gio/gvolume.c" + line="560">a #GVolume the kind of identifier to return + filename="gio/gvolume.c" + line="561">the kind of identifier to return + Returns an array strings listing the kinds + of [identifiers](#volume-identifiers) which the #GVolume has. - + a %NULL-terminated array + filename="gio/gvolume.c" + line="595">a %NULL-terminated array of strings containing kinds of identifiers. Use g_strfreev() to free. @@ -133456,72 +133782,79 @@ release them so the object can be finalized. a #GVolume + filename="gio/gvolume.c" + line="590">a #GVolume + Returns %TRUE if the #GVolume should be automatically mounted. - + %TRUE if the volume should be automatically mounted + filename="gio/gvolume.c" + line="312">%TRUE if the volume should be automatically mounted a #GVolume + filename="gio/gvolume.c" + line="308">a #GVolume + Returns the activation root for the #GVolume if it is known in advance or %NULL if + it is not known. - + the activation root of @volume + filename="gio/gvolume.c" + line="643">the activation root of @volume or %NULL. Use g_object_unref() to free. a #GVolume + filename="gio/gvolume.c" + line="614">a #GVolume + Starts ejecting a #GVolume using a #GMountOperation. Since 2.22. - + a #GVolume + filename="gio/gvolume.c" + line="477">a #GVolume flags affecting the unmount if required for eject + filename="gio/gvolume.c" + line="478">flags affecting the unmount if required for eject nullable="1" allow-none="1"> a #GMountOperation or %NULL to + filename="gio/gvolume.c" + line="479">a #GMountOperation or %NULL to avoid user interaction @@ -133539,8 +133872,8 @@ release them so the object can be finalized. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gvolume.c" + line="481">optional #GCancellable object, %NULL to ignore scope="async" closure="5"> a #GAsyncReadyCallback, or %NULL + filename="gio/gvolume.c" + line="482">a #GAsyncReadyCallback, or %NULL allow-none="1" closure="5"> user data passed to @callback + filename="gio/gvolume.c" + line="483">user data passed to @callback + Finishes an eject operation using a #GMountOperation. Since 2.22. - + %TRUE if the volume was successfully ejected. %FALSE otherwise + filename="gio/gvolume.c" + line="532">%TRUE if the volume was successfully ejected. %FALSE otherwise a #GVolume + filename="gio/gvolume.c" + line="525">a #GVolume a #GAsyncResult + filename="gio/gvolume.c" + line="526">a #GAsyncResult + Gets a key used for sorting #GVolume instance or %NULL if no such key exists. Since 2.32. - + Sorting key for @volume or %NULL if no such key is available + filename="gio/gvolume.c" + line="668">Sorting key for @volume or %NULL if no such key is available a #GVolume + filename="gio/gvolume.c" + line="664">a #GVolume + Gets a symbolic #GIcon for the #GVolume. Since 2.34. - + a #GIcon. + filename="gio/gvolume.c" + line="164">a #GIcon. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -133628,8 +133967,8 @@ release them so the object can be finalized. a #GVolume + filename="gio/gvolume.c" + line="160">a #GVolume @@ -133644,27 +133983,26 @@ release them so the object can be finalized. glib:get-type="g_volume_monitor_get_type" glib:type-struct="VolumeMonitorClass"> #GVolumeMonitor is for listing the user interesting devices and volumes + filename="gio/gvolumemonitor.c" + line="34">`GVolumeMonitor` is for listing the user interesting devices and volumes on the computer. In other words, what a file selector or file manager would show in a sidebar. -#GVolumeMonitor is not -[thread-default-context aware][g-main-context-push-thread-default], -and so should not be used other than from the main thread, with no -thread-default-context active. +`GVolumeMonitor` is not +thread-default-context aware (see +[method@GLib.MainContext.push_thread_default]), and so should not be used +other than from the main thread, with no thread-default-context active. In order to receive updates about volumes and mounts monitored through GVFS, a main loop must be running. - + This function should be called by any #GVolumeMonitor + filename="gio/gunionvolumemonitor.c" + line="562">This function should be called by any #GVolumeMonitor implementation when a new #GMount object is created that is not associated with a #GVolume object. It must be called just before emitting the @mount_added signal. @@ -133697,41 +134035,38 @@ implementations should instead create shadow mounts with the URI of the mount they intend to adopt. See the proxy volume monitor in gvfs for an example of this. Also see g_mount_is_shadowed(), g_mount_shadow() and g_mount_unshadow() functions. - + the #GVolume object that is the parent for @mount or %NULL + filename="gio/gunionvolumemonitor.c" + line="595">the #GVolume object that is the parent for @mount or %NULL if no wants to adopt the #GMount. a #GMount object to find a parent for + filename="gio/gunionvolumemonitor.c" + line="564">a #GMount object to find a parent for Gets the volume monitor used by gio. - + filename="gio/gunionvolumemonitor.c" + line="504">Gets the volume monitor used by gio. + a reference to the #GVolumeMonitor used by gio. Call + filename="gio/gunionvolumemonitor.c" + line="509">a reference to the #GVolumeMonitor used by gio. Call g_object_unref() when done with it. - + @@ -133745,8 +134080,7 @@ if no wants to adopt the #GMount. - + @@ -133760,8 +134094,7 @@ if no wants to adopt the #GMount. - + @@ -133775,8 +134108,7 @@ if no wants to adopt the #GMount. - + @@ -133790,8 +134122,7 @@ if no wants to adopt the #GMount. - + @@ -133807,17 +134138,16 @@ if no wants to adopt the #GMount. Gets a list of drives connected to the system. + filename="gio/gvolumemonitor.c" + line="279">Gets a list of drives connected to the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - + a #GList of connected #GDrive objects. + filename="gio/gvolumemonitor.c" + line="288">a #GList of connected #GDrive objects. @@ -133825,53 +134155,51 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="281">a #GVolumeMonitor. Finds a #GMount object by its UUID (see g_mount_get_uuid()) - + filename="gio/gvolumemonitor.c" + line="372">Finds a #GMount object by its UUID (see g_mount_get_uuid()) + a #GMount or %NULL if no such mount is available. + filename="gio/gvolumemonitor.c" + line="379">a #GMount or %NULL if no such mount is available. Free the returned object with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="374">a #GVolumeMonitor. the UUID to look for + filename="gio/gvolumemonitor.c" + line="375">the UUID to look for Gets a list of the mounts on the system. + filename="gio/gvolumemonitor.c" + line="325">Gets a list of the mounts on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - + a #GList of #GMount objects. + filename="gio/gvolumemonitor.c" + line="334">a #GList of #GMount objects. @@ -133879,53 +134207,51 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="327">a #GVolumeMonitor. Finds a #GVolume object by its UUID (see g_volume_get_uuid()) - + filename="gio/gvolumemonitor.c" + line="348">Finds a #GVolume object by its UUID (see g_volume_get_uuid()) + a #GVolume or %NULL if no such volume is available. + filename="gio/gvolumemonitor.c" + line="355">a #GVolume or %NULL if no such volume is available. Free the returned object with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="350">a #GVolumeMonitor. the UUID to look for + filename="gio/gvolumemonitor.c" + line="351">the UUID to look for Gets a list of the volumes on the system. + filename="gio/gvolumemonitor.c" + line="302">Gets a list of the volumes on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - + a #GList of #GVolume objects. + filename="gio/gvolumemonitor.c" + line="311">a #GList of #GVolume objects. @@ -133933,15 +134259,14 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="304">a #GVolumeMonitor. - + @@ -133955,8 +134280,7 @@ its elements have been unreffed with g_object_unref(). - + @@ -133970,8 +134294,7 @@ its elements have been unreffed with g_object_unref(). - + @@ -133985,8 +134308,7 @@ its elements have been unreffed with g_object_unref(). - + @@ -134000,8 +134322,7 @@ its elements have been unreffed with g_object_unref(). - + @@ -134015,8 +134336,7 @@ its elements have been unreffed with g_object_unref(). - + @@ -134030,8 +134350,7 @@ its elements have been unreffed with g_object_unref(). - + @@ -134047,17 +134366,16 @@ its elements have been unreffed with g_object_unref(). Gets a list of drives connected to the system. + filename="gio/gvolumemonitor.c" + line="279">Gets a list of drives connected to the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - + a #GList of connected #GDrive objects. + filename="gio/gvolumemonitor.c" + line="288">a #GList of connected #GDrive objects. @@ -134065,8 +134383,8 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="281">a #GVolumeMonitor. @@ -134074,45 +134392,43 @@ its elements have been unreffed with g_object_unref(). Finds a #GMount object by its UUID (see g_mount_get_uuid()) - + filename="gio/gvolumemonitor.c" + line="372">Finds a #GMount object by its UUID (see g_mount_get_uuid()) + a #GMount or %NULL if no such mount is available. + filename="gio/gvolumemonitor.c" + line="379">a #GMount or %NULL if no such mount is available. Free the returned object with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="374">a #GVolumeMonitor. the UUID to look for + filename="gio/gvolumemonitor.c" + line="375">the UUID to look for Gets a list of the mounts on the system. + filename="gio/gvolumemonitor.c" + line="325">Gets a list of the mounts on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - + a #GList of #GMount objects. + filename="gio/gvolumemonitor.c" + line="334">a #GList of #GMount objects. @@ -134120,8 +134436,8 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="327">a #GVolumeMonitor. @@ -134129,45 +134445,43 @@ its elements have been unreffed with g_object_unref(). Finds a #GVolume object by its UUID (see g_volume_get_uuid()) - + filename="gio/gvolumemonitor.c" + line="348">Finds a #GVolume object by its UUID (see g_volume_get_uuid()) + a #GVolume or %NULL if no such volume is available. + filename="gio/gvolumemonitor.c" + line="355">a #GVolume or %NULL if no such volume is available. Free the returned object with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="350">a #GVolumeMonitor. the UUID to look for + filename="gio/gvolumemonitor.c" + line="351">the UUID to look for Gets a list of the volumes on the system. + filename="gio/gvolumemonitor.c" + line="302">Gets a list of the volumes on the system. The returned list should be freed with g_list_free(), after its elements have been unreffed with g_object_unref(). - + a #GList of #GVolume objects. + filename="gio/gvolumemonitor.c" + line="311">a #GList of #GVolume objects. @@ -134175,8 +134489,8 @@ its elements have been unreffed with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="304">a #GVolumeMonitor. @@ -134189,120 +134503,120 @@ its elements have been unreffed with g_object_unref(). Emitted when a drive changes. + filename="gio/gvolumemonitor.c" + line="222">Emitted when a drive changes. the drive that changed + filename="gio/gvolumemonitor.c" + line="225">the drive that changed Emitted when a drive is connected to the system. + filename="gio/gvolumemonitor.c" + line="192">Emitted when a drive is connected to the system. a #GDrive that was connected. + filename="gio/gvolumemonitor.c" + line="195">a #GDrive that was connected. Emitted when a drive is disconnected from the system. + filename="gio/gvolumemonitor.c" + line="207">Emitted when a drive is disconnected from the system. a #GDrive that was disconnected. + filename="gio/gvolumemonitor.c" + line="210">a #GDrive that was disconnected. Emitted when the eject button is pressed on @drive. + filename="gio/gvolumemonitor.c" + line="237">Emitted when the eject button is pressed on @drive. the drive where the eject button was pressed + filename="gio/gvolumemonitor.c" + line="240">the drive where the eject button was pressed Emitted when the stop button is pressed on @drive. + filename="gio/gvolumemonitor.c" + line="254">Emitted when the stop button is pressed on @drive. the drive where the stop button was pressed + filename="gio/gvolumemonitor.c" + line="257">the drive where the stop button was pressed Emitted when a mount is added. + filename="gio/gvolumemonitor.c" + line="129">Emitted when a mount is added. a #GMount that was added. + filename="gio/gvolumemonitor.c" + line="132">a #GMount that was added. Emitted when a mount changes. + filename="gio/gvolumemonitor.c" + line="177">Emitted when a mount changes. a #GMount that changed. + filename="gio/gvolumemonitor.c" + line="180">a #GMount that changed. May be emitted when a mount is about to be removed. + filename="gio/gvolumemonitor.c" + line="159">May be emitted when a mount is about to be removed. This signal depends on the backend and is only emitted if GIO was used to unmount. @@ -134312,72 +134626,72 @@ GIO was used to unmount. a #GMount that is being unmounted. + filename="gio/gvolumemonitor.c" + line="162">a #GMount that is being unmounted. Emitted when a mount is removed. + filename="gio/gvolumemonitor.c" + line="144">Emitted when a mount is removed. a #GMount that was removed. + filename="gio/gvolumemonitor.c" + line="147">a #GMount that was removed. Emitted when a mountable volume is added to the system. + filename="gio/gvolumemonitor.c" + line="84">Emitted when a mountable volume is added to the system. a #GVolume that was added. + filename="gio/gvolumemonitor.c" + line="87">a #GVolume that was added. Emitted when mountable volume is changed. + filename="gio/gvolumemonitor.c" + line="114">Emitted when mountable volume is changed. a #GVolume that changed. + filename="gio/gvolumemonitor.c" + line="117">a #GVolume that changed. Emitted when a mountable volume is removed from the system. + filename="gio/gvolumemonitor.c" + line="99">Emitted when a mountable volume is removed from the system. a #GVolume that was removed. + filename="gio/gvolumemonitor.c" + line="102">a #GVolume that was removed. @@ -134386,15 +134700,13 @@ GIO was used to unmount. - + - + @@ -134410,8 +134722,7 @@ GIO was used to unmount. - + @@ -134427,8 +134738,7 @@ GIO was used to unmount. - + @@ -134444,8 +134754,7 @@ GIO was used to unmount. - + @@ -134461,8 +134770,7 @@ GIO was used to unmount. - + @@ -134478,8 +134786,7 @@ GIO was used to unmount. - + @@ -134495,8 +134802,7 @@ GIO was used to unmount. - + @@ -134512,8 +134818,7 @@ GIO was used to unmount. - + @@ -134529,8 +134834,7 @@ GIO was used to unmount. - + @@ -134546,8 +134850,7 @@ GIO was used to unmount. - + @@ -134563,8 +134866,7 @@ GIO was used to unmount. - + @@ -134572,12 +134874,11 @@ GIO was used to unmount. - + a #GList of connected #GDrive objects. + filename="gio/gvolumemonitor.c" + line="288">a #GList of connected #GDrive objects. @@ -134585,8 +134886,8 @@ GIO was used to unmount. a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="281">a #GVolumeMonitor. @@ -134594,12 +134895,11 @@ GIO was used to unmount. - + a #GList of #GVolume objects. + filename="gio/gvolumemonitor.c" + line="311">a #GList of #GVolume objects. @@ -134607,8 +134907,8 @@ GIO was used to unmount. a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="304">a #GVolumeMonitor. @@ -134616,12 +134916,11 @@ GIO was used to unmount. - + a #GList of #GMount objects. + filename="gio/gvolumemonitor.c" + line="334">a #GList of #GMount objects. @@ -134629,8 +134928,8 @@ GIO was used to unmount. a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="327">a #GVolumeMonitor. @@ -134638,26 +134937,25 @@ GIO was used to unmount. - + a #GVolume or %NULL if no such volume is available. + filename="gio/gvolumemonitor.c" + line="355">a #GVolume or %NULL if no such volume is available. Free the returned object with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="350">a #GVolumeMonitor. the UUID to look for + filename="gio/gvolumemonitor.c" + line="351">the UUID to look for @@ -134665,26 +134963,25 @@ GIO was used to unmount. - + a #GMount or %NULL if no such mount is available. + filename="gio/gvolumemonitor.c" + line="379">a #GMount or %NULL if no such mount is available. Free the returned object with g_object_unref(). a #GVolumeMonitor. + filename="gio/gvolumemonitor.c" + line="374">a #GVolumeMonitor. the UUID to look for + filename="gio/gvolumemonitor.c" + line="375">the UUID to look for @@ -134692,8 +134989,7 @@ GIO was used to unmount. - + @@ -134709,8 +135005,7 @@ GIO was used to unmount. - + @@ -134726,8 +135021,7 @@ GIO was used to unmount. - + @@ -134743,8 +135037,7 @@ GIO was used to unmount. - + @@ -134752,8 +135045,7 @@ GIO was used to unmount. - + @@ -134761,8 +135053,7 @@ GIO was used to unmount. - + @@ -134770,8 +135061,7 @@ GIO was used to unmount. - + @@ -134779,8 +135069,7 @@ GIO was used to unmount. - + @@ -134788,8 +135077,7 @@ GIO was used to unmount. - + @@ -134799,8 +135087,7 @@ GIO was used to unmount. - + @@ -134809,8 +135096,7 @@ GIO was used to unmount. - + @@ -134819,8 +135105,7 @@ GIO was used to unmount. - + @@ -134829,8 +135114,7 @@ GIO was used to unmount. - + @@ -134839,8 +135123,7 @@ GIO was used to unmount. - + @@ -134849,8 +135132,7 @@ GIO was used to unmount. - + @@ -134864,37 +135146,35 @@ GIO was used to unmount. glib:get-type="g_zlib_compressor_get_type" glib:type-struct="ZlibCompressorClass"> #GZlibCompressor is an implementation of #GConverter that + filename="gio/gzlibcompressor.c" + line="45">`GZlibCompressor` is an implementation of [iface@Gio.Converter] that compresses data using zlib. - + Creates a new #GZlibCompressor. - + filename="gio/gzlibcompressor.c" + line="273">Creates a new #GZlibCompressor. + a new #GZlibCompressor + filename="gio/gzlibcompressor.c" + line="280">a new #GZlibCompressor The format to use for the compressed data + filename="gio/gzlibcompressor.c" + line="275">The format to use for the compressed data compression level (0-9), -1 for default + filename="gio/gzlibcompressor.c" + line="276">compression level (0-9), -1 for default @@ -134904,21 +135184,20 @@ compresses data using zlib. glib:get-property="file-info" version="2.26"> Returns the #GZlibCompressor:file-info property. - + filename="gio/gzlibcompressor.c" + line="298">Returns the #GZlibCompressor:file-info property. + a #GFileInfo, or %NULL + filename="gio/gzlibcompressor.c" + line="304">a #GFileInfo, or %NULL a #GZlibCompressor + filename="gio/gzlibcompressor.c" + line="300">a #GZlibCompressor @@ -134928,8 +135207,8 @@ compresses data using zlib. glib:set-property="file-info" version="2.26"> Sets @file_info in @compressor. If non-%NULL, and @compressor's + filename="gio/gzlibcompressor.c" + line="316">Sets @file_info in @compressor. If non-%NULL, and @compressor's #GZlibCompressor:format property is %G_ZLIB_COMPRESSOR_FORMAT_GZIP, it will be used to set the file name and modification time in the GZIP header of the compressed data. @@ -134937,16 +135216,15 @@ the GZIP header of the compressed data. Note: it is an error to call this function while a compression is in progress; it may only be called immediately after creation of @compressor, or after resetting it with g_converter_reset(). - + a #GZlibCompressor + filename="gio/gzlibcompressor.c" + line="318">a #GZlibCompressor nullable="1" allow-none="1"> a #GFileInfo + filename="gio/gzlibcompressor.c" + line="319">a #GFileInfo @@ -134967,32 +135245,40 @@ or after resetting it with g_converter_reset(). setter="set_file_info" getter="get_file_info"> If set to a non-%NULL #GFileInfo object, and #GZlibCompressor:format is + filename="gio/gzlibcompressor.c" + line="256">If set to a non-%NULL #GFileInfo object, and #GZlibCompressor:format is %G_ZLIB_COMPRESSOR_FORMAT_GZIP, the compressor will write the file name and modification time from the file info to the GZIP header. + The format of the compressed data. + The level of compression from `0` (no compression) to `9` (most +compression). `-1` for the default level. - + @@ -135003,8 +135289,8 @@ and modification time from the file info to the GZIP header. glib:get-type="g_zlib_compressor_format_get_type" c:type="GZlibCompressorFormat"> Used to select the type of data format to use for #GZlibDecompressor + filename="gio/gioenums.h" + line="915">Used to select the type of data format to use for #GZlibDecompressor and #GZlibCompressor. glib:nick="zlib" glib:name="G_ZLIB_COMPRESSOR_FORMAT_ZLIB"> deflate compression with zlib header + filename="gio/gioenums.h" + line="917">deflate compression with zlib header glib:nick="gzip" glib:name="G_ZLIB_COMPRESSOR_FORMAT_GZIP"> gzip file format + filename="gio/gioenums.h" + line="918">gzip file format glib:nick="raw" glib:name="G_ZLIB_COMPRESSOR_FORMAT_RAW"> deflate compression with no header + filename="gio/gioenums.h" + line="919">deflate compression with no header glib:get-type="g_zlib_decompressor_get_type" glib:type-struct="ZlibDecompressorClass"> #GZlibDecompressor is an implementation of #GConverter that + filename="gio/gzlibdecompressor.c" + line="44">`GZlibDecompressor` is an implementation of [iface@Gio.Converter] that decompresses data compressed with zlib. - + Creates a new #GZlibDecompressor. - + filename="gio/gzlibdecompressor.c" + line="251">Creates a new #GZlibDecompressor. + a new #GZlibDecompressor + filename="gio/gzlibdecompressor.c" + line="257">a new #GZlibDecompressor The format to use for the compressed data + filename="gio/gzlibdecompressor.c" + line="253">The format to use for the compressed data @@ -135076,25 +135360,24 @@ decompresses data compressed with zlib. glib:get-property="file-info" version="2.26"> Retrieves the #GFileInfo constructed from the GZIP header data + filename="gio/gzlibdecompressor.c" + line="273">Retrieves the #GFileInfo constructed from the GZIP header data of compressed data processed by @compressor, or %NULL if @decompressor's #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP, or the header data was not fully processed yet, or it not present in the data stream at all. - + a #GFileInfo, or %NULL + filename="gio/gzlibdecompressor.c" + line="283">a #GFileInfo, or %NULL a #GZlibDecompressor + filename="gio/gzlibdecompressor.c" + line="275">a #GZlibDecompressor @@ -135104,26 +135387,29 @@ data stream at all. transfer-ownership="none" getter="get_file_info"> A #GFileInfo containing the information found in the GZIP header + filename="gio/gzlibdecompressor.c" + line="233">A #GFileInfo containing the information found in the GZIP header of the data stream processed, or %NULL if the header was not yet fully processed, is not present at all, or the compressor's #GZlibDecompressor:format property is not %G_ZLIB_COMPRESSOR_FORMAT_GZIP. + The format of the compressed data. - + @@ -135133,27 +135419,26 @@ fully processed, is not present at all, or the compressor's moved-to="Action.name_is_valid" version="2.38"> Checks if @action_name is valid. + filename="gio/gaction.c" + line="386">Checks if @action_name is valid. @action_name is valid if it consists only of alphanumeric characters, plus '-' and '.'. The empty string is not a valid action name. It is an error to call this function with a non-utf8 @action_name. @action_name must not be %NULL. - + %TRUE if @action_name is valid + filename="gio/gaction.c" + line="398">%TRUE if @action_name is valid a potential action name + filename="gio/gaction.c" + line="388">a potential action name @@ -135164,8 +135449,8 @@ It is an error to call this function with a non-utf8 @action_name. version="2.38" throws="1"> Parses a detailed action name into its separate name and target + filename="gio/gaction.c" + line="417">Parses a detailed action name into its separate name and target components. Detailed action names can have three formats. @@ -135195,19 +135480,18 @@ in @action_name (if a pointer is passed in). A %NULL value may still be returned in @target_value, as the @detailed_name may not contain a target. If returned, the #GVariant in @target_value is guaranteed to not be floating. - + %TRUE if successful, else %FALSE with @error set + filename="gio/gaction.c" + line="456">%TRUE if successful, else %FALSE with @error set a detailed action name + filename="gio/gaction.c" + line="419">a detailed action name the action name + filename="gio/gaction.c" + line="420">the action name the target value, + filename="gio/gaction.c" + line="421">the target value, or %NULL for no target @@ -135241,8 +135525,8 @@ If returned, the #GVariant in @target_value is guaranteed to not be floating. Formats a detailed action name from @action_name and @target_value. + filename="gio/gaction.c" + line="531">Formats a detailed action name from @action_name and @target_value. It is an error to call this function with an invalid action name. @@ -135252,19 +135536,18 @@ and @target_value by that function. See that function for the types of strings that will be printed by this function. - + a detailed format string + filename="gio/gaction.c" + line="547">a detailed format string a valid action name + filename="gio/gaction.c" + line="533">a valid action name nullable="1" allow-none="1"> a #GVariant target value, or %NULL + filename="gio/gaction.c" + line="534">a #GVariant target value, or %NULL @@ -135283,27 +135566,26 @@ this function. moved-to="AppInfo.create_from_commandline" throws="1"> Creates a new #GAppInfo from the given information. + filename="gio/gdesktopappinfo.c" + line="4317">Creates a new #GAppInfo from the given information. Note that for @commandline, the quoting rules of the Exec key of the [freedesktop.org Desktop Entry Specification](http://freedesktop.org/Standards/desktop-entry-spec) are applied. For example, if the @commandline contains percent-encoded URIs, the percent-character must be doubled in order to prevent it from being swallowed by Exec key unquoting. See the specification for exact quoting rules. - + new #GAppInfo for given command. + filename="gio/gdesktopappinfo.c" + line="4332">new #GAppInfo for given command. the commandline to use + filename="gio/gdesktopappinfo.c" + line="4319">the commandline to use the application name, or %NULL to use @commandline + filename="gio/gdesktopappinfo.c" + line="4320">the application name, or %NULL to use @commandline flags that can specify details of the created #GAppInfo + filename="gio/gdesktopappinfo.c" + line="4321">flags that can specify details of the created #GAppInfo @@ -135327,8 +135609,8 @@ being swallowed by Exec key unquoting. See the specification for exact quoting r c:identifier="g_app_info_get_all" moved-to="AppInfo.get_all"> Gets a list of all of the applications currently registered + filename="gio/gdesktopappinfo.c" + line="4894">Gets a list of all of the applications currently registered on this system. For desktop files, this includes applications that have @@ -135336,12 +135618,11 @@ For desktop files, this includes applications that have of `OnlyShowIn` or `NotShowIn`. See g_app_info_should_show(). The returned list does not include applications which have the `Hidden` key set. - + a newly allocated #GList of references to #GAppInfos. + filename="gio/gdesktopappinfo.c" + line="4906">a newly allocated #GList of references to #GAppInfos. @@ -135351,17 +135632,16 @@ the `Hidden` key set. c:identifier="g_app_info_get_all_for_type" moved-to="AppInfo.get_all_for_type"> Gets a list of all #GAppInfos for a given content type, + filename="gio/gdesktopappinfo.c" + line="4581">Gets a list of all #GAppInfos for a given content type, including the recommended and fallback #GAppInfos. See g_app_info_get_recommended_for_type() and g_app_info_get_fallback_for_type(). - + #GList of #GAppInfos + filename="gio/gdesktopappinfo.c" + line="4590">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -135370,38 +135650,38 @@ g_app_info_get_fallback_for_type(). the content type to find a #GAppInfo for + filename="gio/gdesktopappinfo.c" + line="4583">the content type to find a #GAppInfo for + moved-to="AppInfo.get_default_for_type" + glib:async-func="app_info_get_default_for_type_async"> Gets the default #GAppInfo for a given content type. - + filename="gio/gdesktopappinfo.c" + line="4639">Gets the default #GAppInfo for a given content type. + #GAppInfo for given @content_type or + filename="gio/gdesktopappinfo.c" + line="4647">#GAppInfo for given @content_type or %NULL on error. the content type to find a #GAppInfo for + filename="gio/gdesktopappinfo.c" + line="4641">the content type to find a #GAppInfo for if %TRUE, the #GAppInfo is expected to + filename="gio/gdesktopappinfo.c" + line="4642">if %TRUE, the #GAppInfo is expected to support URIs @@ -135410,26 +135690,27 @@ g_app_info_get_fallback_for_type(). + version="2.74" + glib:finish-func="app_info_get_default_for_type_finish" + glib:sync-func="app_info_get_default_for_type"> Asynchronously gets the default #GAppInfo for a given content type. - + filename="gio/gappinfo.c" + line="822">Asynchronously gets the default #GAppInfo for a given content type. + the content type to find a #GAppInfo for + filename="gio/gappinfo.c" + line="824">the content type to find a #GAppInfo for if %TRUE, the #GAppInfo is expected to + filename="gio/gappinfo.c" + line="825">if %TRUE, the #GAppInfo is expected to support URIs @@ -135438,8 +135719,8 @@ g_app_info_get_fallback_for_type(). nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gappinfo.c" + line="827">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gappinfo.c" + line="828">a #GAsyncReadyCallback to call when the request is done nullable="1" allow-none="1"> data to pass to @callback + filename="gio/gappinfo.c" + line="829">data to pass to @callback @@ -135470,52 +135751,51 @@ g_app_info_get_fallback_for_type(). version="2.74" throws="1"> Finishes a default #GAppInfo lookup started by + filename="gio/gappinfo.c" + line="942">Finishes a default #GAppInfo lookup started by g_app_info_get_default_for_type_async(). If no #GAppInfo is found, then @error will be set to %G_IO_ERROR_NOT_FOUND. - + #GAppInfo for given @content_type or + filename="gio/gappinfo.c" + line="952">#GAppInfo for given @content_type or %NULL on error. a #GAsyncResult + filename="gio/gappinfo.c" + line="944">a #GAsyncResult + moved-to="AppInfo.get_default_for_uri_scheme" + glib:async-func="app_info_get_default_for_uri_scheme_async"> Gets the default application for handling URIs with + filename="gio/gdesktopappinfo.c" + line="4715">Gets the default application for handling URIs with the given URI scheme. A URI scheme is the initial part of the URI, up to but not including the ':', e.g. "http", "ftp" or "sip". - + #GAppInfo for given @uri_scheme or + filename="gio/gdesktopappinfo.c" + line="4724">#GAppInfo for given @uri_scheme or %NULL on error. a string containing a URI scheme. + filename="gio/gdesktopappinfo.c" + line="4717">a string containing a URI scheme. @@ -135523,23 +135803,24 @@ of the URI, up to but not including the ':', e.g. "http", + version="2.74" + glib:finish-func="app_info_get_default_for_uri_scheme_finish" + glib:sync-func="app_info_get_default_for_uri_scheme"> Asynchronously gets the default application for handling URIs with + filename="gio/gappinfo.c" + line="882">Asynchronously gets the default application for handling URIs with the given URI scheme. A URI scheme is the initial part of the URI, up to but not including the ':', e.g. "http", "ftp" or "sip". - + a string containing a URI scheme. + filename="gio/gappinfo.c" + line="884">a string containing a URI scheme. optional #GCancellable object, %NULL to ignore + filename="gio/gappinfo.c" + line="885">optional #GCancellable object, %NULL to ignore a #GAsyncReadyCallback to call when the request is done + filename="gio/gappinfo.c" + line="886">a #GAsyncReadyCallback to call when the request is done data to pass to @callback + filename="gio/gappinfo.c" + line="887">data to pass to @callback @@ -135579,25 +135860,24 @@ of the URI, up to but not including the ':', e.g. "http", version="2.74" throws="1"> Finishes a default #GAppInfo lookup started by + filename="gio/gappinfo.c" + line="915">Finishes a default #GAppInfo lookup started by g_app_info_get_default_for_uri_scheme_async(). If no #GAppInfo is found, then @error will be set to %G_IO_ERROR_NOT_FOUND. - + #GAppInfo for given @uri_scheme or + filename="gio/gappinfo.c" + line="925">#GAppInfo for given @uri_scheme or %NULL on error. a #GAsyncResult + filename="gio/gappinfo.c" + line="917">a #GAsyncResult @@ -135607,16 +135887,15 @@ If no #GAppInfo is found, then @error will be set to %G_IO_ERROR_NOT_FOUND. Gets a list of fallback #GAppInfos for a given content type, i.e. + filename="gio/gdesktopappinfo.c" + line="4529">Gets a list of fallback #GAppInfos for a given content type, i.e. those applications which claim to support the given content type by MIME type subclassing and not directly. - + #GList of #GAppInfos + filename="gio/gdesktopappinfo.c" + line="4537">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -135625,8 +135904,8 @@ by MIME type subclassing and not directly. the content type to find a #GAppInfo for + filename="gio/gdesktopappinfo.c" + line="4531">the content type to find a #GAppInfo for @@ -135636,19 +135915,18 @@ by MIME type subclassing and not directly. moved-to="AppInfo.get_recommended_for_type" version="2.28"> Gets a list of recommended #GAppInfos for a given content type, i.e. + filename="gio/gdesktopappinfo.c" + line="4487">Gets a list of recommended #GAppInfos for a given content type, i.e. those applications which claim to support the given content type exactly, and not by MIME type subclassing. Note that the first application of the list is the last used one, i.e. the last one for which g_app_info_set_as_last_used_for_type() has been called. - + #GList of #GAppInfos + filename="gio/gdesktopappinfo.c" + line="4498">#GList of #GAppInfos for given @content_type or %NULL on error. @@ -135657,8 +135935,8 @@ called. the content type to find a #GAppInfo for + filename="gio/gdesktopappinfo.c" + line="4489">the content type to find a #GAppInfo for @@ -135666,10 +135944,11 @@ called. + throws="1" + glib:async-func="app_info_launch_default_for_uri_async"> Utility function that launches the default application + filename="gio/gappinfo.c" + line="969">Utility function that launches the default application registered to handle the specified uri. Synchronous I/O is done on the uri to detect the type of the file if required. @@ -135677,19 +135956,18 @@ required. The D-Bus–activated applications don't have to be started if your application terminates too soon after this function. To prevent this, use g_app_info_launch_default_for_uri_async() instead. - + %TRUE on success, %FALSE on error. + filename="gio/gappinfo.c" + line="984">%TRUE on success, %FALSE on error. the uri to show + filename="gio/gappinfo.c" + line="971">the uri to show nullable="1" allow-none="1"> an optional #GAppLaunchContext + filename="gio/gappinfo.c" + line="972">an optional #GAppLaunchContext @@ -135706,10 +135984,12 @@ g_app_info_launch_default_for_uri_async() instead. + version="2.50" + glib:finish-func="app_info_launch_default_for_uri_finish" + glib:sync-func="app_info_launch_default_for_uri"> Async version of g_app_info_launch_default_for_uri(). + filename="gio/gappinfo.c" + line="1197">Async version of g_app_info_launch_default_for_uri(). This version is useful if you are interested in receiving error information in the case where the application is @@ -135719,16 +135999,15 @@ dialog to the user. This is also useful if you want to be sure that the D-Bus–activated applications are really started before termination and if you are interested in receiving error information from their activation. - + the uri to show + filename="gio/gappinfo.c" + line="1199">the uri to show nullable="1" allow-none="1"> an optional #GAppLaunchContext + filename="gio/gappinfo.c" + line="1200">an optional #GAppLaunchContext nullable="1" allow-none="1"> a #GCancellable + filename="gio/gappinfo.c" + line="1201">a #GCancellable scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gappinfo.c" + line="1202">a #GAsyncReadyCallback to call when the request is done nullable="1" allow-none="1"> data to pass to @callback + filename="gio/gappinfo.c" + line="1203">data to pass to @callback @@ -135777,21 +136056,20 @@ in receiving error information from their activation. version="2.50" throws="1"> Finishes an asynchronous launch-default-for-uri operation. - + filename="gio/gappinfo.c" + line="1259">Finishes an asynchronous launch-default-for-uri operation. + %TRUE if the launch was successful, %FALSE if @error is set + filename="gio/gappinfo.c" + line="1266">%TRUE if the launch was successful, %FALSE if @error is set a #GAsyncResult + filename="gio/gappinfo.c" + line="1261">a #GAsyncResult @@ -135801,22 +136079,21 @@ in receiving error information from their activation. moved-to="AppInfo.reset_type_associations" version="2.20"> Removes all changes to the type associations done by + filename="gio/gdesktopappinfo.c" + line="4619">Removes all changes to the type associations done by g_app_info_set_as_default_for_type(), g_app_info_set_as_default_for_extension(), g_app_info_add_supports_type() or g_app_info_remove_supports_type(). - + a content type + filename="gio/gdesktopappinfo.c" + line="4621">a content type @@ -135828,8 +136105,8 @@ g_app_info_remove_supports_type(). deprecated="1" deprecated-version="2.54"> Helper function for constructing #GAsyncInitable object. This is + filename="gio/gasyncinitable.c" + line="354">Helper function for constructing #GAsyncInitable object. This is similar to g_object_newv() but also initializes the object asynchronously. When the initialization is finished, @callback will be called. You can @@ -135837,34 +136114,33 @@ then call g_async_initable_new_finish() to get the new object and check for any errors. Use g_object_new_with_properties() and g_async_initable_init_async() instead. See #GParameter for more information. - + a #GType supporting #GAsyncInitable. + filename="gio/gasyncinitable.c" + line="356">a #GType supporting #GAsyncInitable. the number of parameters in @parameters + filename="gio/gasyncinitable.c" + line="357">the number of parameters in @parameters the parameters to use to construct the object + filename="gio/gasyncinitable.c" + line="358">the parameters to use to construct the object the [I/O priority][io-priority] of the operation + filename="gio/gasyncinitable.c" + line="359">the [I/O priority][io-priority] of the operation optional #GCancellable object, %NULL to ignore. + filename="gio/gasyncinitable.c" + line="360">optional #GCancellable object, %NULL to ignore. a #GAsyncReadyCallback to call when the initialization is + filename="gio/gasyncinitable.c" + line="361">a #GAsyncReadyCallback to call when the initialization is finished @@ -135893,32 +136169,35 @@ g_async_initable_init_async() instead. See #GParameter for more information. the data to pass to callback function + filename="gio/gasyncinitable.c" + line="363">the data to pass to callback function - + Asynchronously connects to the message bus specified by @bus_type. + filename="gio/gdbusconnection.c" + line="7969">Asynchronously connects to the message bus specified by @bus_type. When the operation is finished, @callback will be invoked. You can then call g_bus_get_finish() to get the result of the operation. This is an asynchronous failable function. See g_bus_get_sync() for the synchronous version. - + a #GBusType + filename="gio/gdbusconnection.c" + line="7971">a #GBusType nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="7972">a #GCancellable or %NULL scope="async" closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + filename="gio/gdbusconnection.c" + line="7973">a #GAsyncReadyCallback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to @callback + filename="gio/gdbusconnection.c" + line="7974">the data to pass to @callback @@ -135957,8 +136236,8 @@ the synchronous version. version="2.26" throws="1"> Finishes an operation started with g_bus_get(). + filename="gio/gdbusconnection.c" + line="8018">Finishes an operation started with g_bus_get(). The returned object is a singleton, that is, shared with other callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the @@ -135970,20 +136249,19 @@ G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION flags. Note that the returned #GDBusConnection object will (usually) have the #GDBusConnection:exit-on-close property set to %TRUE. - + a #GDBusConnection or %NULL if @error is set. + filename="gio/gdbusconnection.c" + line="8037">a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). a #GAsyncResult obtained from the #GAsyncReadyCallback passed + filename="gio/gdbusconnection.c" + line="8020">a #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_bus_get() @@ -135992,10 +136270,11 @@ the #GDBusConnection:exit-on-close property set to %TRUE. + throws="1" + glib:async-func="bus_get"> Synchronously connects to the message bus specified by @bus_type. + filename="gio/gdbusconnection.c" + line="7891">Synchronously connects to the message bus specified by @bus_type. Note that the returned object may shared with other callers, e.g. if two separate parts of a process calls this function with the same @bus_type, they will share the same object. @@ -136013,20 +136292,19 @@ G_DBUS_CONNECTION_FLAGS_MESSAGE_BUS_CONNECTION flags. Note that the returned #GDBusConnection object will (usually) have the #GDBusConnection:exit-on-close property set to %TRUE. - + a #GDBusConnection or %NULL if @error is set. + filename="gio/gdbusconnection.c" + line="7916">a #GDBusConnection or %NULL if @error is set. Free with g_object_unref(). a #GBusType + filename="gio/gdbusconnection.c" + line="7893">a #GBusType nullable="1" allow-none="1"> a #GCancellable or %NULL + filename="gio/gdbusconnection.c" + line="7894">a #GCancellable or %NULL @@ -136043,11 +136321,10 @@ the #GDBusConnection:exit-on-close property set to %TRUE. + version="2.26"> Starts acquiring @name on the bus specified by @bus_type and calls + filename="gio/gdbusnameowning.c" + line="571">Starts acquiring @name on the bus specified by @bus_type and calls @name_acquired_handler and @name_lost_handler when the name is acquired respectively lost. Callbacks will be invoked in the [thread-default main context][g-main-context-push-thread-default] @@ -136096,50 +136373,53 @@ This behavior makes it very simple to write applications that wants to [own names][gdbus-owning-names] and export objects. Simply register objects to be exported in @bus_acquired_handler and unregister the objects (if any) in @name_lost_handler. - + an identifier (never 0) that can be used with + filename="gio/gdbusnameowning.c" + line="635">an identifier (never 0) that can be used with g_bus_unown_name() to stop owning the name. the type of bus to own a name on + filename="gio/gdbusnameowning.c" + line="573">the type of bus to own a name on the well-known name to own + filename="gio/gdbusnameowning.c" + line="574">the well-known name to own a set of flags from the #GBusNameOwnerFlags enumeration + filename="gio/gdbusnameowning.c" + line="575">a set of flags from the #GBusNameOwnerFlags enumeration + allow-none="1" + scope="notified"> handler to invoke when connected to the bus of type @bus_type or %NULL + filename="gio/gdbusnameowning.c" + line="576">handler to invoke when + connected to the bus of type @bus_type or %NULL + allow-none="1" + scope="notified"> handler to invoke when @name is acquired or %NULL + filename="gio/gdbusnameowning.c" + line="578">handler to invoke when + @name is acquired or %NULL @@ -136151,8 +136431,9 @@ unregister the objects (if any) in @name_lost_handler. closure="6" destroy="7"> handler to invoke when @name is lost or %NULL + filename="gio/gdbusnameowning.c" + line="580">handler to invoke when @name + is lost or %NULL nullable="1" allow-none="1"> user data to pass to handlers + filename="gio/gdbusnameowning.c" + line="582">user data to pass to handlers allow-none="1" scope="async"> function for freeing @user_data or %NULL + filename="gio/gdbusnameowning.c" + line="583">function for freeing @user_data or %NULL @@ -136179,47 +136460,47 @@ unregister the objects (if any) in @name_lost_handler. + version="2.26"> Like g_bus_own_name() but takes a #GDBusConnection instead of a + filename="gio/gdbusnameowning.c" + line="507">Like g_bus_own_name() but takes a #GDBusConnection instead of a #GBusType. - + an identifier (never 0) that can be used with + filename="gio/gdbusnameowning.c" + line="522">an identifier (never 0) that can be used with g_bus_unown_name() to stop owning the name a #GDBusConnection + filename="gio/gdbusnameowning.c" + line="509">a #GDBusConnection the well-known name to own + filename="gio/gdbusnameowning.c" + line="510">the well-known name to own a set of flags from the #GBusNameOwnerFlags enumeration + filename="gio/gdbusnameowning.c" + line="511">a set of flags from the #GBusNameOwnerFlags enumeration + allow-none="1" + scope="notified"> handler to invoke when @name is acquired or %NULL + filename="gio/gdbusnameowning.c" + line="512">handler to invoke when + @name is acquired or %NULL @@ -136231,8 +136512,9 @@ unregister the objects (if any) in @name_lost_handler. closure="5" destroy="6"> handler to invoke when @name is lost or %NULL + filename="gio/gdbusnameowning.c" + line="514">handler to invoke when @name + is lost or %NULL nullable="1" allow-none="1"> user data to pass to handlers + filename="gio/gdbusnameowning.c" + line="516">user data to pass to handlers allow-none="1" scope="async"> function for freeing @user_data or %NULL + filename="gio/gdbusnameowning.c" + line="517">function for freeing @user_data or %NULL @@ -136261,35 +136543,34 @@ unregister the objects (if any) in @name_lost_handler. shadows="bus_own_name_on_connection" version="2.26"> Version of g_bus_own_name_on_connection() using closures instead of + filename="gio/gdbusnameowning.c" + line="845">Version of g_bus_own_name_on_connection() using closures instead of callbacks for easier binding in other languages. - + an identifier (never 0) that can be used with + filename="gio/gdbusnameowning.c" + line="858">an identifier (never 0) that can be used with g_bus_unown_name() to stop owning the name. a #GDBusConnection + filename="gio/gdbusnameowning.c" + line="847">a #GDBusConnection the well-known name to own + filename="gio/gdbusnameowning.c" + line="848">the well-known name to own a set of flags from the #GBusNameOwnerFlags enumeration + filename="gio/gdbusnameowning.c" + line="849">a set of flags from the #GBusNameOwnerFlags enumeration nullable="1" allow-none="1"> #GClosure to invoke when @name is + filename="gio/gdbusnameowning.c" + line="850">#GClosure to invoke when @name is acquired or %NULL @@ -136307,8 +136588,8 @@ callbacks for easier binding in other languages. nullable="1" allow-none="1"> #GClosure to invoke when @name is lost + filename="gio/gdbusnameowning.c" + line="852">#GClosure to invoke when @name is lost or %NULL @@ -136319,35 +136600,34 @@ callbacks for easier binding in other languages. shadows="bus_own_name" version="2.26"> Version of g_bus_own_name() using closures instead of callbacks for + filename="gio/gdbusnameowning.c" + line="805">Version of g_bus_own_name() using closures instead of callbacks for easier binding in other languages. - + an identifier (never 0) that can be used with + filename="gio/gdbusnameowning.c" + line="820">an identifier (never 0) that can be used with g_bus_unown_name() to stop owning the name. the type of bus to own a name on + filename="gio/gdbusnameowning.c" + line="807">the type of bus to own a name on the well-known name to own + filename="gio/gdbusnameowning.c" + line="808">the well-known name to own a set of flags from the #GBusNameOwnerFlags enumeration + filename="gio/gdbusnameowning.c" + line="809">a set of flags from the #GBusNameOwnerFlags enumeration nullable="1" allow-none="1"> #GClosure to invoke when connected to + filename="gio/gdbusnameowning.c" + line="810">#GClosure to invoke when connected to the bus of type @bus_type or %NULL @@ -136365,8 +136645,8 @@ easier binding in other languages. nullable="1" allow-none="1"> #GClosure to invoke when @name is + filename="gio/gdbusnameowning.c" + line="812">#GClosure to invoke when @name is acquired or %NULL @@ -136375,8 +136655,8 @@ easier binding in other languages. nullable="1" allow-none="1"> #GClosure to invoke when @name is lost or + filename="gio/gdbusnameowning.c" + line="814">#GClosure to invoke when @name is lost or %NULL @@ -136386,8 +136666,8 @@ easier binding in other languages. c:identifier="g_bus_unown_name" version="2.26"> Stops owning a name. + filename="gio/gdbusnameowning.c" + line="881">Stops owning a name. Note that there may still be D-Bus traffic to process (relating to owning and unowning the name) in the current thread-default #GMainContext after @@ -136395,16 +136675,15 @@ this function has returned. You should continue to iterate the #GMainContext until the #GDestroyNotify function passed to g_bus_own_name() is called, in order to avoid memory leaks through callbacks queued on the #GMainContext after it’s stopped being iterated. - + an identifier obtained from g_bus_own_name() + filename="gio/gdbusnameowning.c" + line="883">an identifier obtained from g_bus_own_name() @@ -136413,8 +136692,8 @@ after it’s stopped being iterated. c:identifier="g_bus_unwatch_name" version="2.26"> Stops watching a name. + filename="gio/gdbusnamewatching.c" + line="873">Stops watching a name. Note that there may still be D-Bus traffic to process (relating to watching and unwatching the name) in the current thread-default #GMainContext after @@ -136422,16 +136701,15 @@ this function has returned. You should continue to iterate the #GMainContext until the #GDestroyNotify function passed to g_bus_watch_name() is called, in order to avoid memory leaks through callbacks queued on the #GMainContext after it’s stopped being iterated. - + An identifier obtained from g_bus_watch_name() + filename="gio/gdbusnamewatching.c" + line="875">An identifier obtained from g_bus_watch_name() @@ -136439,11 +136717,10 @@ after it’s stopped being iterated. + version="2.26"> Starts watching @name on the bus specified by @bus_type and calls + filename="gio/gdbusnamewatching.c" + line="562">Starts watching @name on the bus specified by @bus_type and calls @name_appeared_handler and @name_vanished_handler when the name is known to have an owner respectively known to lose its owner. Callbacks will be invoked in the @@ -136472,41 +136749,42 @@ to take action when a certain [name exists][gdbus-watching-names]. Basically, the application should create object proxies in @name_appeared_handler and destroy them again (if any) in @name_vanished_handler. - + An identifier (never 0) that can be used with + filename="gio/gdbusnamewatching.c" + line="604">An identifier (never 0) that can be used with g_bus_unwatch_name() to stop watching the name. The type of bus to watch a name on. + filename="gio/gdbusnamewatching.c" + line="564">The type of bus to watch a name on. The name (well-known or unique) to watch. + filename="gio/gdbusnamewatching.c" + line="565">The name (well-known or unique) to watch. Flags from the #GBusNameWatcherFlags enumeration. + filename="gio/gdbusnamewatching.c" + line="566">Flags from the #GBusNameWatcherFlags enumeration. + allow-none="1" + scope="notified"> Handler to invoke when @name is known to exist or %NULL. + filename="gio/gdbusnamewatching.c" + line="567">Handler to invoke when + @name is known to exist or %NULL. @@ -136518,8 +136796,9 @@ g_bus_unwatch_name() to stop watching the name. closure="5" destroy="6"> Handler to invoke when @name is known to not exist or %NULL. + filename="gio/gdbusnamewatching.c" + line="569">Handler to invoke when + @name is known to not exist or %NULL. @@ -136528,8 +136807,8 @@ g_bus_unwatch_name() to stop watching the name. nullable="1" allow-none="1"> User data to pass to handlers. + filename="gio/gdbusnamewatching.c" + line="571">User data to pass to handlers. allow-none="1" scope="async"> Function for freeing @user_data or %NULL. + filename="gio/gdbusnamewatching.c" + line="572">Function for freeing @user_data or %NULL. @@ -136547,47 +136826,47 @@ g_bus_unwatch_name() to stop watching the name. + version="2.26"> Like g_bus_watch_name() but takes a #GDBusConnection instead of a + filename="gio/gdbusnamewatching.c" + line="653">Like g_bus_watch_name() but takes a #GDBusConnection instead of a #GBusType. - + An identifier (never 0) that can be used with + filename="gio/gdbusnamewatching.c" + line="668">An identifier (never 0) that can be used with g_bus_unwatch_name() to stop watching the name. A #GDBusConnection. + filename="gio/gdbusnamewatching.c" + line="655">A #GDBusConnection. The name (well-known or unique) to watch. + filename="gio/gdbusnamewatching.c" + line="656">The name (well-known or unique) to watch. Flags from the #GBusNameWatcherFlags enumeration. + filename="gio/gdbusnamewatching.c" + line="657">Flags from the #GBusNameWatcherFlags enumeration. + allow-none="1" + scope="notified"> Handler to invoke when @name is known to exist or %NULL. + filename="gio/gdbusnamewatching.c" + line="658">Handler to invoke when + @name is known to exist or %NULL. @@ -136599,8 +136878,9 @@ g_bus_unwatch_name() to stop watching the name. closure="5" destroy="6"> Handler to invoke when @name is known to not exist or %NULL. + filename="gio/gdbusnamewatching.c" + line="660">Handler to invoke when + @name is known to not exist or %NULL. @@ -136609,8 +136889,8 @@ g_bus_unwatch_name() to stop watching the name. nullable="1" allow-none="1"> User data to pass to handlers. + filename="gio/gdbusnamewatching.c" + line="662">User data to pass to handlers. allow-none="1" scope="async"> Function for freeing @user_data or %NULL. + filename="gio/gdbusnamewatching.c" + line="663">Function for freeing @user_data or %NULL. @@ -136630,35 +136910,34 @@ g_bus_unwatch_name() to stop watching the name. shadows="bus_watch_name_on_connection" version="2.26"> Version of g_bus_watch_name_on_connection() using closures instead of callbacks for + filename="gio/gdbusnamewatching.c" + line="839">Version of g_bus_watch_name_on_connection() using closures instead of callbacks for easier binding in other languages. - + An identifier (never 0) that can be used with + filename="gio/gdbusnamewatching.c" + line="852">An identifier (never 0) that can be used with g_bus_unwatch_name() to stop watching the name. A #GDBusConnection. + filename="gio/gdbusnamewatching.c" + line="841">A #GDBusConnection. The name (well-known or unique) to watch. + filename="gio/gdbusnamewatching.c" + line="842">The name (well-known or unique) to watch. Flags from the #GBusNameWatcherFlags enumeration. + filename="gio/gdbusnamewatching.c" + line="843">Flags from the #GBusNameWatcherFlags enumeration. nullable="1" allow-none="1"> #GClosure to invoke when @name is known + filename="gio/gdbusnamewatching.c" + line="844">#GClosure to invoke when @name is known to exist or %NULL. @@ -136676,8 +136955,8 @@ to exist or %NULL. nullable="1" allow-none="1"> #GClosure to invoke when @name is known + filename="gio/gdbusnamewatching.c" + line="846">#GClosure to invoke when @name is known to not exist or %NULL. @@ -136688,35 +136967,34 @@ to not exist or %NULL. shadows="bus_watch_name" version="2.26"> Version of g_bus_watch_name() using closures instead of callbacks for + filename="gio/gdbusnamewatching.c" + line="805">Version of g_bus_watch_name() using closures instead of callbacks for easier binding in other languages. - + An identifier (never 0) that can be used with + filename="gio/gdbusnamewatching.c" + line="818">An identifier (never 0) that can be used with g_bus_unwatch_name() to stop watching the name. The type of bus to watch a name on. + filename="gio/gdbusnamewatching.c" + line="807">The type of bus to watch a name on. The name (well-known or unique) to watch. + filename="gio/gdbusnamewatching.c" + line="808">The name (well-known or unique) to watch. Flags from the #GBusNameWatcherFlags enumeration. + filename="gio/gdbusnamewatching.c" + line="809">Flags from the #GBusNameWatcherFlags enumeration. nullable="1" allow-none="1"> #GClosure to invoke when @name is known + filename="gio/gdbusnamewatching.c" + line="810">#GClosure to invoke when @name is known to exist or %NULL. @@ -136734,8 +137012,8 @@ to exist or %NULL. nullable="1" allow-none="1"> #GClosure to invoke when @name is known + filename="gio/gdbusnamewatching.c" + line="812">#GClosure to invoke when @name is known to not exist or %NULL. @@ -136744,51 +137022,49 @@ to not exist or %NULL. Checks if a content type can be executable. Note that for instance + filename="gio/gcontenttype.c" + line="675">Checks if a content type can be executable. Note that for instance things like text files can be executables (i.e. scripts and batch files). - + %TRUE if the file type corresponds to a type that + filename="gio/gcontenttype.c" + line="682">%TRUE if the file type corresponds to a type that can be executable, %FALSE otherwise. a content type string + filename="gio/gcontenttype.c" + line="677">a content type string Compares two content types for equality. - + filename="gio/gcontenttype.c" + line="228">Compares two content types for equality. + %TRUE if the two strings are identical or equivalent, + filename="gio/gcontenttype.c" + line="235">%TRUE if the two strings are identical or equivalent, %FALSE otherwise. a content type string + filename="gio/gcontenttype.c" + line="230">a content type string a content type string + filename="gio/gcontenttype.c" + line="231">a content type string @@ -136797,22 +137073,21 @@ things like text files can be executables (i.e. scripts and batch files). c:identifier="g_content_type_from_mime_type" version="2.18"> Tries to find a content type based on the mime type name. - + filename="gio/gcontenttype.c" + line="715">Tries to find a content type based on the mime type name. + Newly allocated string with content type or + filename="gio/gcontenttype.c" + line="721">Newly allocated string with content type or %NULL. Free with g_free() a mime type string + filename="gio/gcontenttype.c" + line="717">a mime type string @@ -136820,22 +137095,21 @@ things like text files can be executables (i.e. scripts and batch files). Gets the human readable description of the content type. - + filename="gio/gcontenttype.c" + line="473">Gets the human readable description of the content type. + a short description of the content type @type. Free the + filename="gio/gcontenttype.c" + line="479">a short description of the content type @type. Free the returned string with g_free() a content type string + filename="gio/gcontenttype.c" + line="475">a content type string @@ -136844,26 +137118,25 @@ things like text files can be executables (i.e. scripts and batch files). c:identifier="g_content_type_get_generic_icon_name" version="2.34"> Gets the generic icon name for a content type. + filename="gio/gcontenttype.c" + line="624">Gets the generic icon name for a content type. See the [shared-mime-info](http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec) specification for more on the generic icon name. - + the registered generic icon name for the given @type, + filename="gio/gcontenttype.c" + line="634">the registered generic icon name for the given @type, or %NULL if unknown. Free with g_free() a content type string + filename="gio/gcontenttype.c" + line="626">a content type string @@ -136871,22 +137144,21 @@ specification for more on the generic icon name. Gets the icon for a content type. - + filename="gio/gcontenttype.c" + line="592">Gets the icon for a content type. + #GIcon corresponding to the content type. Free the returned + filename="gio/gcontenttype.c" + line="598">#GIcon corresponding to the content type. Free the returned object with g_object_unref() a content type string + filename="gio/gcontenttype.c" + line="594">a content type string @@ -136895,15 +137167,14 @@ specification for more on the generic icon name. c:identifier="g_content_type_get_mime_dirs" version="2.60"> Get the list of directories which MIME data is loaded from. See + filename="gio/gcontenttype.c" + line="198">Get the list of directories which MIME data is loaded from. See g_content_type_set_mime_dirs() for details. - + %NULL-terminated list of + filename="gio/gcontenttype.c" + line="204">%NULL-terminated list of directories to load MIME data from, including any `mime/` subdirectory, and with the first directory to try listed first @@ -136914,22 +137185,21 @@ g_content_type_set_mime_dirs() for details. Gets the mime type for the content type, if one is registered. - + filename="gio/gcontenttype.c" + line="522">Gets the mime type for the content type, if one is registered. + the registered mime type for the + filename="gio/gcontenttype.c" + line="528">the registered mime type for the given @type, or %NULL if unknown; free with g_free(). a content type string + filename="gio/gcontenttype.c" + line="524">a content type string @@ -136938,39 +137208,37 @@ g_content_type_set_mime_dirs() for details. c:identifier="g_content_type_get_symbolic_icon" version="2.34"> Gets the symbolic icon for a content type. - + filename="gio/gcontenttype.c" + line="607">Gets the symbolic icon for a content type. + symbolic #GIcon corresponding to the content type. + filename="gio/gcontenttype.c" + line="613">symbolic #GIcon corresponding to the content type. Free the returned object with g_object_unref() a content type string + filename="gio/gcontenttype.c" + line="609">a content type string Guesses the content type based on example data. If the function is + filename="gio/gcontenttype.c" + line="743">Guesses the content type based on example data. If the function is uncertain, @result_uncertain will be set to %TRUE. Either @filename or @data may be %NULL, in which case the guess will be based solely on the other argument. - + a string indicating a guessed content type for the + filename="gio/gcontenttype.c" + line="756">a string indicating a guessed content type for the given data. Free with g_free() @@ -136980,8 +137248,8 @@ on the other argument. nullable="1" allow-none="1"> a path, or %NULL + filename="gio/gcontenttype.c" + line="745">a path, or %NULL nullable="1" allow-none="1"> a stream of data, or %NULL + filename="gio/gcontenttype.c" + line="746">a stream of data, or %NULL the size of @data + filename="gio/gcontenttype.c" + line="747">the size of @data optional="1" allow-none="1"> return location for the certainty + filename="gio/gcontenttype.c" + line="748">return location for the certainty of the result, or %NULL @@ -137019,8 +137287,8 @@ on the other argument. c:identifier="g_content_type_guess_for_tree" version="2.18"> Tries to guess the type of the tree with root @root, by + filename="gio/gcontenttype.c" + line="1536">Tries to guess the type of the tree with root @root, by looking at the files it contains. The result is an array of content types, with the best guess coming first. @@ -137032,12 +137300,11 @@ specification for more on x-content types. This function is useful in the implementation of g_mount_guess_content_type(). - + an %NULL-terminated + filename="gio/gcontenttype.c" + line="1553">an %NULL-terminated array of zero or more content types. Free with g_strfreev() @@ -137046,36 +137313,35 @@ g_mount_guess_content_type(). the root of the tree to guess a type for + filename="gio/gcontenttype.c" + line="1538">the root of the tree to guess a type for Determines if @type is a subset of @supertype. - + filename="gio/gcontenttype.c" + line="256">Determines if @type is a subset of @supertype. + %TRUE if @type is a kind of @supertype, + filename="gio/gcontenttype.c" + line="263">%TRUE if @type is a kind of @supertype, %FALSE otherwise. a content type string + filename="gio/gcontenttype.c" + line="258">a content type string a content type string + filename="gio/gcontenttype.c" + line="259">a content type string @@ -137084,29 +137350,28 @@ g_mount_guess_content_type(). c:identifier="g_content_type_is_mime_type" version="2.52"> Determines if @type is a subset of @mime_type. + filename="gio/gcontenttype.c" + line="284">Determines if @type is a subset of @mime_type. Convenience wrapper around g_content_type_is_a(). - + %TRUE if @type is a kind of @mime_type, + filename="gio/gcontenttype.c" + line="292">%TRUE if @type is a kind of @mime_type, %FALSE otherwise. a content type string + filename="gio/gcontenttype.c" + line="286">a content type string a mime type string + filename="gio/gcontenttype.c" + line="287">a mime type string @@ -137114,24 +137379,23 @@ Convenience wrapper around g_content_type_is_a(). Checks if the content type is the generic "unknown" type. + filename="gio/gcontenttype.c" + line="304">Checks if the content type is the generic "unknown" type. On UNIX this is the "application/octet-stream" mimetype, while on win32 it is "*" and on OSX it is a dynamic type or octet-stream. - + %TRUE if the type is the unknown type. + filename="gio/gcontenttype.c" + line="313">%TRUE if the type is the unknown type. a content type string + filename="gio/gcontenttype.c" + line="306">a content type string @@ -137140,8 +137404,8 @@ or octet-stream. c:identifier="g_content_type_set_mime_dirs" version="2.60"> Set the list of directories used by GIO to load the MIME database. + filename="gio/gcontenttype.c" + line="157">Set the list of directories used by GIO to load the MIME database. If @dirs is %NULL, the directories used are the default: - the `mime` subdirectory of the directory in `$XDG_DATA_HOME` @@ -137164,8 +137428,7 @@ with @dirs set to %NULL before calling g_test_init(), for instance: return g_test_run (); ]| - + @@ -137175,8 +137438,8 @@ with @dirs set to %NULL before calling g_test_init(), for instance: nullable="1" allow-none="1"> %NULL-terminated list of + filename="gio/gcontenttype.c" + line="159">%NULL-terminated list of directories to load MIME data from, including any `mime/` subdirectory, and with the first directory to try listed first @@ -137188,16 +137451,15 @@ with @dirs set to %NULL before calling g_test_init(), for instance: Gets a list of strings containing all the registered content types + filename="gio/gcontenttype.c" + line="936">Gets a list of strings containing all the registered content types known to the system. The list and its data should be freed using `g_list_free_full (list, g_free)`. - + list of the registered + filename="gio/gcontenttype.c" + line="943">list of the registered content types @@ -137208,28 +137470,27 @@ known to the system. The list and its data should be freed using c:identifier="g_dbus_address_escape_value" version="2.36"> Escape @string so it can appear in a D-Bus address as the value + filename="gio/gdbusaddress.c" + line="1426">Escape @string so it can appear in a D-Bus address as the value part of a key-value pair. For instance, if @string is `/run/bus-for-:0`, this function would return `/run/bus-for-%3A0`, which could be used in a D-Bus address like `unix:nonce-tcp:host=127.0.0.1,port=42,noncefile=/run/bus-for-%3A0`. - + a copy of @string with all + filename="gio/gdbusaddress.c" + line="1439">a copy of @string with all non-optionally-escaped bytes escaped an unescaped string to be included in a D-Bus address + filename="gio/gdbusaddress.c" + line="1428">an unescaped string to be included in a D-Bus address as the value in a key-value pair @@ -137240,27 +137501,26 @@ which could be used in a D-Bus address like version="2.26" throws="1"> Synchronously looks up the D-Bus address for the well-known message + filename="gio/gdbusaddress.c" + line="1263">Synchronously looks up the D-Bus address for the well-known message bus instance specified by @bus_type. This may involve using various platform specific mechanisms. The returned address will be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). - + a valid D-Bus address string for @bus_type or + filename="gio/gdbusaddress.c" + line="1276">a valid D-Bus address string for @bus_type or %NULL if @error is set a #GBusType + filename="gio/gdbusaddress.c" + line="1265">a #GBusType a #GCancellable or %NULL + filename="gio/gdbusaddress.c" + line="1266">a #GCancellable or %NULL + version="2.26" + glib:finish-func="dbus_address_get_stream_finish" + glib:sync-func="dbus_address_get_stream_sync"> Asynchronously connects to an endpoint specified by @address and + filename="gio/gdbusaddress.c" + line="859">Asynchronously connects to an endpoint specified by @address and sets up the connection so it is in a state to run the client-side of the D-Bus authentication conversation. @address must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -137290,16 +137552,15 @@ the operation. This is an asynchronous failable function. See g_dbus_address_get_stream_sync() for the synchronous version. - + A valid D-Bus address. + filename="gio/gdbusaddress.c" + line="861">A valid D-Bus address. nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="gio/gdbusaddress.c" + line="862">A #GCancellable or %NULL. scope="async" closure="3"> A #GAsyncReadyCallback to call when the request is satisfied. + filename="gio/gdbusaddress.c" + line="863">A #GAsyncReadyCallback to call when the request is satisfied. nullable="1" allow-none="1"> Data to pass to @callback. + filename="gio/gdbusaddress.c" + line="864">Data to pass to @callback. @@ -137338,24 +137599,23 @@ g_dbus_address_get_stream_sync() for the synchronous version. version="2.26" throws="1"> Finishes an operation started with g_dbus_address_get_stream(). + filename="gio/gdbusaddress.c" + line="901">Finishes an operation started with g_dbus_address_get_stream(). A server is not required to set a GUID, so @out_guid may be set to %NULL even on success. - + A #GIOStream or %NULL if @error is set. + filename="gio/gdbusaddress.c" + line="912">A #GIOStream or %NULL if @error is set. A #GAsyncResult obtained from the GAsyncReadyCallback passed to g_dbus_address_get_stream(). + filename="gio/gdbusaddress.c" + line="903">A #GAsyncResult obtained from the GAsyncReadyCallback passed to g_dbus_address_get_stream(). optional="1" allow-none="1"> %NULL or return location to store the GUID extracted from @address, if any. + filename="gio/gdbusaddress.c" + line="904">%NULL or return location to store the GUID extracted from @address, if any. @@ -137375,10 +137635,11 @@ even on success. + throws="1" + glib:async-func="dbus_address_get_stream"> Synchronously connects to an endpoint specified by @address and + filename="gio/gdbusaddress.c" + line="941">Synchronously connects to an endpoint specified by @address and sets up the connection so it is in a state to run the client-side of the D-Bus authentication conversation. @address must be in the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). @@ -137388,19 +137649,18 @@ even on success. This is a synchronous failable function. See g_dbus_address_get_stream() for the asynchronous version. - + A #GIOStream or %NULL if @error is set. + filename="gio/gdbusaddress.c" + line="959">A #GIOStream or %NULL if @error is set. A valid D-Bus address. + filename="gio/gdbusaddress.c" + line="943">A valid D-Bus address. optional="1" allow-none="1"> %NULL or return location to store the GUID extracted from @address, if any. + filename="gio/gdbusaddress.c" + line="944">%NULL or return location to store the GUID extracted from @address, if any. nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="gio/gdbusaddress.c" + line="945">A #GCancellable or %NULL. @@ -137431,16 +137691,15 @@ g_dbus_address_get_stream() for the asynchronous version. moved-to="DBusAnnotationInfo.lookup" version="2.26"> Looks up the value of an annotation. + filename="gio/gdbusintrospection.c" + line="1829">Looks up the value of an annotation. The cost of this function is O(n) in number of annotations. - + The value or %NULL if not found. Do not free, it is owned by @annotations. + filename="gio/gdbusintrospection.c" + line="1838">The value or %NULL if not found. Do not free, it is owned by @annotations. @@ -137449,16 +137708,16 @@ The cost of this function is O(n) in number of annotations. nullable="1" allow-none="1"> A %NULL-terminated array of annotations or %NULL. + filename="gio/gdbusintrospection.c" + line="1831">A %NULL-terminated array of annotations or %NULL. The name of the annotation to look up. + filename="gio/gdbusintrospection.c" + line="1832">The name of the annotation to look up. @@ -137468,8 +137727,8 @@ The cost of this function is O(n) in number of annotations. moved-to="DBusError.encode_gerror" version="2.26"> Creates a D-Bus error name to use for @error. If @error matches + filename="gio/gdbuserror.c" + line="723">Creates a D-Bus error name to use for @error. If @error matches a registered error (cf. g_dbus_error_register_error()), the corresponding D-Bus error name will be returned. @@ -137480,20 +137739,19 @@ on the wire back to a #GError using g_dbus_error_new_for_dbus_error(). This function is typically only used in object mappings to put a #GError on the wire. Regular applications should not use it. - + A D-Bus error name (never %NULL). + filename="gio/gdbuserror.c" + line="739">A D-Bus error name (never %NULL). Free with g_free(). A #GError. + filename="gio/gdbuserror.c" + line="725">A #GError. @@ -137503,27 +137761,26 @@ This function is typically only used in object mappings to put a moved-to="DBusError.get_remote_error" version="2.26"> Gets the D-Bus error name used for @error, if any. + filename="gio/gdbuserror.c" + line="430">Gets the D-Bus error name used for @error, if any. This function is guaranteed to return a D-Bus error name for all #GErrors returned from functions handling remote method calls (e.g. g_dbus_connection_call_finish()) unless g_dbus_error_strip_remote_error() has been used on @error. - + an allocated string or %NULL if the + filename="gio/gdbuserror.c" + line="441">an allocated string or %NULL if the D-Bus error name could not be found. Free with g_free(). a #GError + filename="gio/gdbuserror.c" + line="432">a #GError @@ -137533,23 +137790,22 @@ g_dbus_error_strip_remote_error() has been used on @error. moved-to="DBusError.is_remote_error" version="2.26"> Checks if @error represents an error received via D-Bus from a remote peer. If so, + filename="gio/gdbuserror.c" + line="410">Checks if @error represents an error received via D-Bus from a remote peer. If so, use g_dbus_error_get_remote_error() to get the name of the error. - + %TRUE if @error represents an error from a remote peer, + filename="gio/gdbuserror.c" + line="417">%TRUE if @error represents an error from a remote peer, %FALSE otherwise. A #GError. + filename="gio/gdbuserror.c" + line="412">A #GError. @@ -137559,8 +137815,8 @@ use g_dbus_error_get_remote_error() to get the name of the error. moved-to="DBusError.new_for_dbus_error" version="2.26"> Creates a #GError based on the contents of @dbus_error_name and + filename="gio/gdbuserror.c" + line="497">Creates a #GError based on the contents of @dbus_error_name and @dbus_error_message. Errors registered with g_dbus_error_register_error() will be looked @@ -137586,25 +137842,24 @@ returned #GError using the g_dbus_error_get_remote_error() function This function is typically only used in object mappings to prepare #GError instances for applications. Regular applications should not use it. - + An allocated #GError. Free with g_error_free(). + filename="gio/gdbuserror.c" + line="529">An allocated #GError. Free with g_error_free(). D-Bus error name. + filename="gio/gdbuserror.c" + line="499">D-Bus error name. D-Bus error message. + filename="gio/gdbuserror.c" + line="500">D-Bus error message. @@ -137621,38 +137876,37 @@ it. moved-to="DBusError.register_error" version="2.26"> Creates an association to map between @dbus_error_name and + filename="gio/gdbuserror.c" + line="271">Creates an association to map between @dbus_error_name and #GErrors specified by @error_domain and @error_code. This is typically done in the routine that returns the #GQuark for an error domain. - + %TRUE if the association was created, %FALSE if it already + filename="gio/gdbuserror.c" + line="283">%TRUE if the association was created, %FALSE if it already exists. A #GQuark for an error domain. + filename="gio/gdbuserror.c" + line="273">A #GQuark for an error domain. An error code. + filename="gio/gdbuserror.c" + line="274">An error code. A D-Bus error name. + filename="gio/gdbuserror.c" + line="275">A D-Bus error name. @@ -137662,33 +137916,32 @@ exists. moved-to="DBusError.register_error_domain" version="2.26"> Helper function for associating a #GError error domain with D-Bus error names. + filename="gio/gdbuserror.c" + line="97">Helper function for associating a #GError error domain with D-Bus error names. While @quark_volatile has a `volatile` qualifier, this is a historical artifact and the argument passed to it should not be `volatile`. - + The error domain name. + filename="gio/gdbuserror.c" + line="99">The error domain name. A pointer where to store the #GQuark. + filename="gio/gdbuserror.c" + line="100">A pointer where to store the #GQuark. A pointer to @num_entries #GDBusErrorEntry struct items. + filename="gio/gdbuserror.c" + line="101">A pointer to @num_entries #GDBusErrorEntry struct items. @@ -137697,8 +137950,8 @@ artifact and the argument passed to it should not be `volatile`. Number of items to register. + filename="gio/gdbuserror.c" + line="102">Number of items to register. @@ -137708,26 +137961,25 @@ artifact and the argument passed to it should not be `volatile`. moved-to="DBusError.strip_remote_error" version="2.26"> Looks for extra information in the error message used to recover + filename="gio/gdbuserror.c" + line="679">Looks for extra information in the error message used to recover the D-Bus error name and strips it if found. If stripped, the message field in @error will correspond exactly to what was received on the wire. This is typically used when presenting errors to the end user. - + %TRUE if information was stripped, %FALSE otherwise. + filename="gio/gdbuserror.c" + line="690">%TRUE if information was stripped, %FALSE otherwise. A #GError. + filename="gio/gdbuserror.c" + line="681">A #GError. @@ -137737,33 +137989,32 @@ This is typically used when presenting errors to the end user. moved-to="DBusError.unregister_error" version="2.26"> Destroys an association previously set up with g_dbus_error_register_error(). - + filename="gio/gdbuserror.c" + line="337">Destroys an association previously set up with g_dbus_error_register_error(). + %TRUE if the association was destroyed, %FALSE if it wasn't found. + filename="gio/gdbuserror.c" + line="345">%TRUE if the association was destroyed, %FALSE if it wasn't found. A #GQuark for an error domain. + filename="gio/gdbuserror.c" + line="339">A #GQuark for an error domain. An error code. + filename="gio/gdbuserror.c" + line="340">An error code. A D-Bus error name. + filename="gio/gdbuserror.c" + line="341">A D-Bus error name. @@ -137772,21 +138023,20 @@ This is typically used when presenting errors to the end user. c:identifier="g_dbus_escape_object_path" version="2.68"> This is a language binding friendly version of g_dbus_escape_object_path_bytestring(). - + filename="gio/gdbusutils.c" + line="767">This is a language binding friendly version of g_dbus_escape_object_path_bytestring(). + an escaped version of @s. Free with g_free(). + filename="gio/gdbusutils.c" + line="773">an escaped version of @s. Free with g_free(). the string to escape + filename="gio/gdbusutils.c" + line="769">the string to escape @@ -137795,8 +138045,8 @@ This is typically used when presenting errors to the end user. c:identifier="g_dbus_escape_object_path_bytestring" version="2.68"> Escapes @bytes for use in a D-Bus object path component. + filename="gio/gdbusutils.c" + line="718">Escapes @bytes for use in a D-Bus object path component. @bytes is an array of zero or more nonzero bytes in an unspecified encoding, followed by a single zero byte. @@ -137812,19 +138062,18 @@ Other escaping algorithms are also valid to use with D-Bus object paths. This can be reversed with g_dbus_unescape_object_path(). - + an escaped version of @bytes. Free with g_free(). + filename="gio/gdbusutils.c" + line="739">an escaped version of @bytes. Free with g_free(). the string of bytes to escape + filename="gio/gdbusutils.c" + line="720">the string of bytes to escape @@ -137835,8 +138084,8 @@ This can be reversed with g_dbus_unescape_object_path(). c:identifier="g_dbus_generate_guid" version="2.26"> Generate a D-Bus GUID that can be used with + filename="gio/gdbusutils.c" + line="292">Generate a D-Bus GUID that can be used with e.g. g_dbus_connection_new(). See the @@ -137847,12 +138096,11 @@ these as ‘UUIDs’ whereas GLib (for historical reasons) refers to them as Note that D-Bus GUIDs do not follow [RFC 4122](https://datatracker.ietf.org/doc/html/rfc4122). - + A valid D-Bus GUID. Free with g_free(). + filename="gio/gdbusutils.c" + line="307">A valid D-Bus GUID. Free with g_free(). @@ -137860,8 +138108,8 @@ Note that D-Bus GUIDs do not follow c:identifier="g_dbus_gvalue_to_gvariant" version="2.30"> Converts a #GValue to a #GVariant of the type indicated by the @type + filename="gio/gdbusutils.c" + line="523">Converts a #GValue to a #GVariant of the type indicated by the @type parameter. The conversion is using the following rules: @@ -137889,12 +138137,11 @@ returned (e.g. 0 for scalar types, the empty string for string types, See the g_dbus_gvariant_to_gvalue() function for how to convert a #GVariant to a #GValue. - + A #GVariant (never floating) of + filename="gio/gdbusutils.c" + line="557">A #GVariant (never floating) of #GVariantType @type holding the data from @gvalue or an empty #GVariant in case of failure. Free with g_variant_unref(). @@ -137902,14 +138149,14 @@ See the g_dbus_gvariant_to_gvalue() function for how to convert a A #GValue to convert to a #GVariant + filename="gio/gdbusutils.c" + line="525">A #GValue to convert to a #GVariant A #GVariantType + filename="gio/gdbusutils.c" + line="526">A #GVariantType @@ -137918,8 +138165,8 @@ See the g_dbus_gvariant_to_gvalue() function for how to convert a c:identifier="g_dbus_gvariant_to_gvalue" version="2.30"> Converts a #GVariant to a #GValue. If @value is floating, it is consumed. + filename="gio/gdbusutils.c" + line="374">Converts a #GVariant to a #GValue. If @value is floating, it is consumed. The rules specified in the g_dbus_gvalue_to_gvariant() function are used - this function is essentially its reverse form. So, a #GVariant @@ -137930,16 +138177,15 @@ variant, tuple, dict entry) will be converted to a #GValue containing that The conversion never fails - a valid #GValue is always returned in @out_gvalue. - + A #GVariant. + filename="gio/gdbusutils.c" + line="376">A #GVariant. Return location pointing to a zero-filled (uninitialized) #GValue. + filename="gio/gdbusutils.c" + line="377">Return location pointing to a zero-filled (uninitialized) #GValue. @@ -137957,26 +138203,25 @@ The conversion never fails - a valid #GValue is always returned in c:identifier="g_dbus_is_address" version="2.26"> Checks if @string is a + filename="gio/gdbusaddress.c" + line="84">Checks if @string is a [D-Bus address](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). This doesn't check if @string is actually supported by #GDBusServer or #GDBusConnection - use g_dbus_is_supported_address() to do more checks. - + %TRUE if @string is a valid D-Bus address, %FALSE otherwise. + filename="gio/gdbusaddress.c" + line="95">%TRUE if @string is a valid D-Bus address, %FALSE otherwise. A string. + filename="gio/gdbusaddress.c" + line="86">A string. @@ -137985,49 +138230,47 @@ checks. c:identifier="g_dbus_is_error_name" version="2.70"> Check whether @string is a valid D-Bus error name. + filename="gio/gdbusutils.c" + line="264">Check whether @string is a valid D-Bus error name. This function returns the same result as g_dbus_is_interface_name(), because D-Bus error names are defined to have exactly the same syntax as interface names. - + %TRUE if valid, %FALSE otherwise. + filename="gio/gdbusutils.c" + line="274">%TRUE if valid, %FALSE otherwise. The string to check. + filename="gio/gdbusutils.c" + line="266">The string to check. Checks if @string is a D-Bus GUID. + filename="gio/gdbusutils.c" + line="335">Checks if @string is a D-Bus GUID. See the documentation for g_dbus_generate_guid() for more information about the format of a GUID. - + %TRUE if @string is a GUID, %FALSE otherwise. + filename="gio/gdbusutils.c" + line="344">%TRUE if @string is a GUID, %FALSE otherwise. The string to check. + filename="gio/gdbusutils.c" + line="337">The string to check. @@ -138036,21 +138279,20 @@ the format of a GUID. c:identifier="g_dbus_is_interface_name" version="2.26"> Checks if @string is a valid D-Bus interface name. - + filename="gio/gdbusutils.c" + line="224">Checks if @string is a valid D-Bus interface name. + %TRUE if valid, %FALSE otherwise. + filename="gio/gdbusutils.c" + line="230">%TRUE if valid, %FALSE otherwise. The string to check. + filename="gio/gdbusutils.c" + line="226">The string to check. @@ -138059,42 +138301,40 @@ the format of a GUID. c:identifier="g_dbus_is_member_name" version="2.26"> Checks if @string is a valid D-Bus member (e.g. signal or method) name. - + filename="gio/gdbusutils.c" + line="187">Checks if @string is a valid D-Bus member (e.g. signal or method) name. + %TRUE if valid, %FALSE otherwise. + filename="gio/gdbusutils.c" + line="193">%TRUE if valid, %FALSE otherwise. The string to check. + filename="gio/gdbusutils.c" + line="189">The string to check. Checks if @string is a valid D-Bus bus name (either unique or well-known). - + filename="gio/gdbusutils.c" + line="103">Checks if @string is a valid D-Bus bus name (either unique or well-known). + %TRUE if valid, %FALSE otherwise. + filename="gio/gdbusutils.c" + line="109">%TRUE if valid, %FALSE otherwise. The string to check. + filename="gio/gdbusutils.c" + line="105">The string to check. @@ -138104,25 +138344,24 @@ the format of a GUID. version="2.26" throws="1"> Like g_dbus_is_address() but also checks if the library supports the + filename="gio/gdbusaddress.c" + line="368">Like g_dbus_is_address() but also checks if the library supports the transports in @string and that key/value pairs for each transport are valid. See the specification of the [D-Bus address format](https://dbus.freedesktop.org/doc/dbus-specification.html#addresses). - + %TRUE if @string is a valid D-Bus address that is + filename="gio/gdbusaddress.c" + line="378">%TRUE if @string is a valid D-Bus address that is supported by this library, %FALSE if @error is set. A string. + filename="gio/gdbusaddress.c" + line="370">A string. @@ -138131,21 +138370,20 @@ supported by this library, %FALSE if @error is set. c:identifier="g_dbus_is_unique_name" version="2.26"> Checks if @string is a valid D-Bus unique bus name. - + filename="gio/gdbusutils.c" + line="151">Checks if @string is a valid D-Bus unique bus name. + %TRUE if valid, %FALSE otherwise. + filename="gio/gdbusutils.c" + line="157">%TRUE if valid, %FALSE otherwise. The string to check. + filename="gio/gdbusutils.c" + line="153">The string to check. @@ -138154,8 +138392,8 @@ supported by this library, %FALSE if @error is set. c:identifier="g_dbus_unescape_object_path" version="2.68"> Unescapes an string that was previously escaped with + filename="gio/gdbusutils.c" + line="783">Unescapes an string that was previously escaped with g_dbus_escape_object_path(). If the string is in a format that could not have been returned by g_dbus_escape_object_path(), this function returns %NULL. @@ -138163,12 +138401,11 @@ returns %NULL. Encoding alphanumeric characters which do not need to be encoded is not allowed (e.g `_63` is not valid, the string should contain `c` instead). - + an + filename="gio/gdbusutils.c" + line="796">an unescaped version of @s, or %NULL if @s is not a string returned from g_dbus_escape_object_path(). Free with g_free(). @@ -138178,8 +138415,8 @@ should contain `c` instead). the string to unescape + filename="gio/gdbusutils.c" + line="785">the string to unescape @@ -138190,23 +138427,22 @@ should contain `c` instead). version="2.48" throws="1"> Creates a new #GDtlsClientConnection wrapping @base_socket which is + filename="gio/gdtlsclientconnection.c" + line="126">Creates a new #GDtlsClientConnection wrapping @base_socket which is assumed to communicate with the server identified by @server_identity. - + the new + filename="gio/gdtlsclientconnection.c" + line="135">the new #GDtlsClientConnection, or %NULL on error the #GDatagramBased to wrap + filename="gio/gdtlsclientconnection.c" + line="128">the #GDatagramBased to wrap nullable="1" allow-none="1"> the expected identity of the server + filename="gio/gdtlsclientconnection.c" + line="129">the expected identity of the server @@ -138226,22 +138462,21 @@ assumed to communicate with the server identified by @server_identity. version="2.48" throws="1"> Creates a new #GDtlsServerConnection wrapping @base_socket. - + filename="gio/gdtlsserverconnection.c" + line="64">Creates a new #GDtlsServerConnection wrapping @base_socket. + the new + filename="gio/gdtlsserverconnection.c" + line="72">the new #GDtlsServerConnection, or %NULL on error the #GDatagramBased to wrap + filename="gio/gdtlsserverconnection.c" + line="66">the #GDatagramBased to wrap nullable="1" allow-none="1"> the default server certificate, or %NULL + filename="gio/gdtlsserverconnection.c" + line="67">the default server certificate, or %NULL - - #GIOExtensionPoint provides a mechanism for modules to extend the -functionality of the library or application that loaded it in an -organized fashion. - -An extension point is identified by a name, and it may optionally -require that any implementation must be of a certain type (or derived -thereof). Use g_io_extension_point_register() to register an -extension point, and g_io_extension_point_set_required_type() to -set a required type. - -A module can implement an extension point by specifying the #GType -that implements the functionality. Additionally, each implementation -of an extension point has a name, and a priority. Use -g_io_extension_point_implement() to implement an extension point. - - |[<!-- language="C" --> - GIOExtensionPoint *ep; - - // Register an extension point - ep = g_io_extension_point_register ("my-extension-point"); - g_io_extension_point_set_required_type (ep, MY_TYPE_EXAMPLE); - ]| - - |[<!-- language="C" --> - // Implement an extension point - G_DEFINE_TYPE (MyExampleImpl, my_example_impl, MY_TYPE_EXAMPLE) - g_io_extension_point_implement ("my-extension-point", - my_example_impl_get_type (), - "my-example", - 10); - ]| - - It is up to the code that registered the extension point how - it uses the implementations that have been associated with it. - Depending on the use case, it may use all implementations, or - only the one with the highest priority, or pick a specific - one by name. - - To avoid opening all modules just to find out what extension - points they implement, GIO makes use of a caching mechanism, - see [gio-querymodules][gio-querymodules]. - You are expected to run this command after installing a - GIO module. - - The `GIO_EXTRA_MODULES` environment variable can be used to - specify additional directories to automatically load modules - from. This environment variable has the same syntax as the - `PATH`. If two modules have the same base name in different - directories, then the latter one will be ignored. If additional - directories are specified GIO will load modules from the built-in - directory last. - Constructs a #GFile from a vector of elements using the correct + filename="gio/gfile.c" + line="7416">Constructs a #GFile from a vector of elements using the correct separator for filenames. Using this function is equivalent to calling g_build_filenamev(), followed by g_file_new_for_path() on the result. - + a new #GFile + filename="gio/gfile.c" + line="7427">a new #GFile %NULL-terminated + filename="gio/gfile.c" + line="7418">%NULL-terminated array of strings containing the path elements. @@ -138345,8 +138524,8 @@ followed by g_file_new_for_path() on the result. c:identifier="g_file_new_for_commandline_arg" moved-to="File.new_for_commandline_arg"> Creates a #GFile with the given argument from the command line. + filename="gio/gfile.c" + line="7500">Creates a #GFile with the given argument from the command line. The value of @arg can be either a URI, an absolute path or a relative path resolved relative to the current working directory. This operation never fails, but the returned object might not @@ -138360,20 +138539,19 @@ the commandline. #GApplication also uses UTF-8 but g_application_command_line_create_file_for_arg() may be more useful for you there. It is also always possible to use this function with #GOptionContext arguments of type %G_OPTION_ARG_FILENAME. - + a new #GFile. + filename="gio/gfile.c" + line="7519">a new #GFile. Free the returned object with g_object_unref(). a command line string + filename="gio/gfile.c" + line="7502">a command line string @@ -138383,8 +138561,8 @@ for you there. It is also always possible to use this function with moved-to="File.new_for_commandline_arg_and_cwd" version="2.36"> Creates a #GFile with the given argument from the command line. + filename="gio/gfile.c" + line="7530">Creates a #GFile with the given argument from the command line. This function is similar to g_file_new_for_commandline_arg() except that it allows for passing the current working directory as an @@ -138395,25 +138573,24 @@ This is useful if the commandline argument was given in a context other than the invocation of the current process. See also g_application_command_line_create_file_for_arg(). - + a new #GFile + filename="gio/gfile.c" + line="7547">a new #GFile a command line string + filename="gio/gfile.c" + line="7532">a command line string the current working directory of the commandline + filename="gio/gfile.c" + line="7533">the current working directory of the commandline @@ -138422,24 +138599,23 @@ See also g_application_command_line_create_file_for_arg(). c:identifier="g_file_new_for_path" moved-to="File.new_for_path"> Constructs a #GFile for a given path. This operation never + filename="gio/gfile.c" + line="7025">Constructs a #GFile for a given path. This operation never fails, but the returned object might not support any I/O operation if @path is malformed. - + a new #GFile for the given @path. + filename="gio/gfile.c" + line="7034">a new #GFile for the given @path. Free the returned object with g_object_unref(). a string containing a relative or absolute path. + filename="gio/gfile.c" + line="7027">a string containing a relative or absolute path. The string must be encoded in the glib filename encoding. @@ -138449,25 +138625,24 @@ operation if @path is malformed. c:identifier="g_file_new_for_uri" moved-to="File.new_for_uri"> Constructs a #GFile for a given URI. This operation never + filename="gio/gfile.c" + line="7045">Constructs a #GFile for a given URI. This operation never fails, but the returned object might not support any I/O operation if @uri is malformed or if the uri type is not supported. - + a new #GFile for the given @uri. + filename="gio/gfile.c" + line="7054">a new #GFile for the given @uri. Free the returned object with g_object_unref(). a UTF-8 string containing a URI + filename="gio/gfile.c" + line="7047">a UTF-8 string containing a URI @@ -138476,10 +138651,11 @@ not supported. c:identifier="g_file_new_tmp" moved-to="File.new_tmp" version="2.32" - throws="1"> + throws="1" + glib:async-func="file_new_tmp_async"> Opens a file in the preferred directory for temporary files (as + filename="gio/gfile.c" + line="7065">Opens a file in the preferred directory for temporary files (as returned by g_get_tmp_dir()) and returns a #GFile and #GFileIOStream pointing to it. @@ -138489,12 +138665,11 @@ directory components. If it is %NULL, a default template is used. Unlike the other #GFile constructors, this will return %NULL if a temporary file could not be created. - + a new #GFile. + filename="gio/gfile.c" + line="7083">a new #GFile. Free the returned object with g_object_unref(). @@ -138504,8 +138679,8 @@ a temporary file could not be created. nullable="1" allow-none="1"> Template for the file + filename="gio/gfile.c" + line="7067">Template for the file name, as in g_file_open_tmp(), or %NULL for a default template @@ -138514,8 +138689,8 @@ a temporary file could not be created. caller-allocates="0" transfer-ownership="full"> on return, a #GFileIOStream for the created file + filename="gio/gfile.c" + line="7069">on return, a #GFileIOStream for the created file @@ -138523,17 +138698,18 @@ a temporary file could not be created. + version="2.74" + glib:finish-func="file_new_tmp_finish" + glib:sync-func="file_new_tmp"> Asynchronously opens a file in the preferred directory for temporary files + filename="gio/gfile.c" + line="7175">Asynchronously opens a file in the preferred directory for temporary files (as returned by g_get_tmp_dir()) as g_file_new_tmp(). @tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, and containing no directory components. If it is %NULL, a default template is used. - + @@ -138543,15 +138719,15 @@ directory components. If it is %NULL, a default template is used. nullable="1" allow-none="1"> Template for the file + filename="gio/gfile.c" + line="7177">Template for the file name, as in g_file_open_tmp(), or %NULL for a default template the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="7179">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="7180">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gfile.c" + line="7181">a #GAsyncReadyCallback to call when the request is done nullable="1" allow-none="1"> data to pass to @callback + filename="gio/gfile.c" + line="7182">data to pass to @callback @@ -138588,17 +138764,17 @@ directory components. If it is %NULL, a default template is used. + version="2.74" + glib:finish-func="file_new_tmp_dir_finish"> Asynchronously creates a directory in the preferred directory for + filename="gio/gfile.c" + line="7298">Asynchronously creates a directory in the preferred directory for temporary files (as returned by g_get_tmp_dir()) as g_dir_make_tmp(). @tmpl should be a string in the GLib file name encoding containing a sequence of six 'X' characters, and containing no directory components. If it is %NULL, a default template is used. - + @@ -138608,15 +138784,15 @@ directory components. If it is %NULL, a default template is used. nullable="1" allow-none="1"> Template for the file + filename="gio/gfile.c" + line="7300">Template for the file name, as in g_dir_make_tmp(), or %NULL for a default template the [I/O priority][io-priority] of the request + filename="gio/gfile.c" + line="7302">the [I/O priority][io-priority] of the request nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="gio/gfile.c" + line="7303">optional #GCancellable object, %NULL to ignore scope="async" closure="4"> a #GAsyncReadyCallback to call when the request is done + filename="gio/gfile.c" + line="7304">a #GAsyncReadyCallback to call when the request is done nullable="1" allow-none="1"> data to pass to @callback + filename="gio/gfile.c" + line="7305">data to pass to @callback @@ -138656,23 +138832,22 @@ directory components. If it is %NULL, a default template is used. version="2.74" throws="1"> Finishes a temporary directory creation started by + filename="gio/gfile.c" + line="7336">Finishes a temporary directory creation started by g_file_new_tmp_dir_async(). - + a new #GFile. + filename="gio/gfile.c" + line="7344">a new #GFile. Free the returned object with g_object_unref(). a #GAsyncResult + filename="gio/gfile.c" + line="7338">a #GAsyncResult @@ -138683,22 +138858,21 @@ g_file_new_tmp_dir_async(). version="2.74" throws="1"> Finishes a temporary file creation started by g_file_new_tmp_async(). - + filename="gio/gfile.c" + line="7213">Finishes a temporary file creation started by g_file_new_tmp_async(). + a new #GFile. + filename="gio/gfile.c" + line="7221">a new #GFile. Free the returned object with g_object_unref(). a #GAsyncResult + filename="gio/gfile.c" + line="7215">a #GAsyncResult caller-allocates="0" transfer-ownership="full"> on return, a #GFileIOStream for the created file + filename="gio/gfile.c" + line="7216">on return, a #GFileIOStream for the created file @@ -138716,439 +138890,46 @@ g_file_new_tmp_dir_async(). c:identifier="g_file_parse_name" moved-to="File.parse_name"> Constructs a #GFile with the given @parse_name (i.e. something + filename="gio/gfile.c" + line="7361">Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()). This operation never fails, but the returned object might not support any I/O operation if the @parse_name cannot be parsed. - + a new #GFile. + filename="gio/gfile.c" + line="7370">a new #GFile. a file name or path to be parsed + filename="gio/gfile.c" + line="7363">a file name or path to be parsed - - These functions support exporting a #GActionGroup on D-Bus. -The D-Bus interface that is used is a private implementation -detail. - -To access an exported #GActionGroup remotely, use -g_dbus_action_group_get() to obtain a #GDBusActionGroup. - - - A content type is a platform specific string that defines the type -of a file. On UNIX it is a -[MIME type](http://www.wikipedia.org/wiki/Internet_media_type) -like `text/plain` or `image/png`. -On Win32 it is an extension string like `.doc`, `.txt` or a perceived -string like `audio`. Such strings can be looked up in the registry at -`HKEY_CLASSES_ROOT`. -On macOS it is a [Uniform Type Identifier](https://en.wikipedia.org/wiki/Uniform_Type_Identifier) -such as `com.apple.application`. - - - Routines for working with D-Bus addresses. A D-Bus address is a string -like `unix:tmpdir=/tmp/my-app-name`. The exact format of addresses -is explained in detail in the -[D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html#addresses). - -TCP D-Bus connections are supported, but accessing them via a proxy is -currently not supported. - -Since GLib 2.72, `unix:` addresses are supported on Windows with `AF_UNIX` -support (Windows 10). - - - All facilities that return errors from remote methods (such as -g_dbus_connection_call_sync()) use #GError to represent both D-Bus -errors (e.g. errors returned from the other peer) and locally -in-process generated errors. - -To check if a returned #GError is an error from a remote peer, use -g_dbus_error_is_remote_error(). To get the actual D-Bus error name, -use g_dbus_error_get_remote_error(). Before presenting an error, -always use g_dbus_error_strip_remote_error(). - -In addition, facilities used to return errors to a remote peer also -use #GError. See g_dbus_method_invocation_return_error() for -discussion about how the D-Bus error name is set. - -Applications can associate a #GError error domain with a set of D-Bus errors in order to -automatically map from D-Bus errors to #GError and back. This -is typically done in the function returning the #GQuark for the -error domain: -|[<!-- language="C" --> -// foo-bar-error.h: - -#define FOO_BAR_ERROR (foo_bar_error_quark ()) -GQuark foo_bar_error_quark (void); - -typedef enum -{ - FOO_BAR_ERROR_FAILED, - FOO_BAR_ERROR_ANOTHER_ERROR, - FOO_BAR_ERROR_SOME_THIRD_ERROR, - FOO_BAR_N_ERRORS / *< skip >* / -} FooBarError; - -// foo-bar-error.c: - -static const GDBusErrorEntry foo_bar_error_entries[] = -{ - {FOO_BAR_ERROR_FAILED, "org.project.Foo.Bar.Error.Failed"}, - {FOO_BAR_ERROR_ANOTHER_ERROR, "org.project.Foo.Bar.Error.AnotherError"}, - {FOO_BAR_ERROR_SOME_THIRD_ERROR, "org.project.Foo.Bar.Error.SomeThirdError"}, -}; - -// Ensure that every error code has an associated D-Bus error name -G_STATIC_ASSERT (G_N_ELEMENTS (foo_bar_error_entries) == FOO_BAR_N_ERRORS); - -GQuark -foo_bar_error_quark (void) -{ - static gsize quark = 0; - g_dbus_error_register_error_domain ("foo-bar-error-quark", - &quark, - foo_bar_error_entries, - G_N_ELEMENTS (foo_bar_error_entries)); - return (GQuark) quark; -} -]| -With this setup, a D-Bus peer can transparently pass e.g. %FOO_BAR_ERROR_ANOTHER_ERROR and -other peers will see the D-Bus error name org.project.Foo.Bar.Error.AnotherError. - -If the other peer is using GDBus, and has registered the association with -g_dbus_error_register_error_domain() in advance (e.g. by invoking the %FOO_BAR_ERROR quark -generation itself in the previous example) the peer will see also %FOO_BAR_ERROR_ANOTHER_ERROR instead -of %G_IO_ERROR_DBUS_ERROR. Note that GDBus clients can still recover -org.project.Foo.Bar.Error.AnotherError using g_dbus_error_get_remote_error(). - -Note that the %G_DBUS_ERROR error domain is intended only -for returning errors from a remote message bus process. Errors -generated locally in-process by e.g. #GDBusConnection should use the -%G_IO_ERROR domain. - - - Various data structures and convenience routines to parse and -generate D-Bus introspection XML. Introspection information is -used when registering objects with g_dbus_connection_register_object(). - -The format of D-Bus introspection XML is specified in the -[D-Bus specification](http://dbus.freedesktop.org/doc/dbus-specification.html#introspection-format) - - - Convenience API for owning bus names. - -A simple example for owning a name can be found in -[gdbus-example-own-name.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-own-name.c) - - - Convenience API for watching bus names. - -A simple example for watching a name can be found in -[gdbus-example-watch-name.c](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/gio/tests/gdbus-example-watch-name.c) - - - Various utility routines related to D-Bus. - - - File attributes in GIO consist of a list of key-value pairs. - -Keys are strings that contain a key namespace and a key name, separated -by a colon, e.g. "namespace::keyname". Namespaces are included to sort -key-value pairs by namespaces for relevance. Keys can be retrieved -using wildcards, e.g. "standard::*" will return all of the keys in the -"standard" namespace. - -The list of possible attributes for a filesystem (pointed to by a #GFile) is -available as a #GFileAttributeInfoList. This list is queryable by key names -as indicated earlier. - -Information is stored within the list in #GFileAttributeInfo structures. -The info structure can store different types, listed in the enum -#GFileAttributeType. Upon creation of a #GFileAttributeInfo, the type will -be set to %G_FILE_ATTRIBUTE_TYPE_INVALID. - -Classes that implement #GFileIface will create a #GFileAttributeInfoList and -install default keys and values for their given file system, architecture, -and other possible implementation details (e.g., on a UNIX system, a file -attribute key will be registered for the user id for a given file). - -## Default Namespaces - -- `"standard"`: The "Standard" namespace. General file information that - any application may need should be put in this namespace. Examples - include the file's name, type, and size. -- `"etag`: The [Entity Tag][gfile-etag] namespace. Currently, the only key - in this namespace is "value", which contains the value of the current - entity tag. -- `"id"`: The "Identification" namespace. This namespace is used by file - managers and applications that list directories to check for loops and - to uniquely identify files. -- `"access"`: The "Access" namespace. Used to check if a user has the - proper privileges to access files and perform file operations. Keys in - this namespace are made to be generic and easily understood, e.g. the - "can_read" key is %TRUE if the current user has permission to read the - file. UNIX permissions and NTFS ACLs in Windows should be mapped to - these values. -- `"mountable"`: The "Mountable" namespace. Includes simple boolean keys - for checking if a file or path supports mount operations, e.g. mount, - unmount, eject. These are used for files of type %G_FILE_TYPE_MOUNTABLE. -- `"time"`: The "Time" namespace. Includes file access, changed, created - times. -- `"unix"`: The "Unix" namespace. Includes UNIX-specific information and - may not be available for all files. Examples include the UNIX "UID", - "GID", etc. -- `"dos"`: The "DOS" namespace. Includes DOS-specific information and may - not be available for all files. Examples include "is_system" for checking - if a file is marked as a system file, and "is_archive" for checking if a - file is marked as an archive file. -- `"owner"`: The "Owner" namespace. Includes information about who owns a - file. May not be available for all file systems. Examples include "user" - for getting the user name of the file owner. This information is often - mapped from some backend specific data such as a UNIX UID. -- `"thumbnail"`: The "Thumbnail" namespace. Includes information about file - thumbnails and their location within the file system. Examples of keys in - this namespace include "path" to get the location of a thumbnail, "failed" - to check if thumbnailing of the file failed, and "is-valid" to check if - the thumbnail is outdated. -- `"filesystem"`: The "Filesystem" namespace. Gets information about the - file system where a file is located, such as its type, how much space is - left available, and the overall size of the file system. -- `"gvfs"`: The "GVFS" namespace. Keys in this namespace contain information - about the current GVFS backend in use. -- `"xattr"`: The "xattr" namespace. Gets information about extended - user attributes. See attr(5). The "user." prefix of the extended user - attribute name is stripped away when constructing keys in this namespace, - e.g. "xattr::mime_type" for the extended attribute with the name - "user.mime_type". Note that this information is only available if - GLib has been built with extended attribute support. -- `"xattr-sys"`: The "xattr-sys" namespace. Gets information about - extended attributes which are not user-specific. See attr(5). Note - that this information is only available if GLib has been built with - extended attribute support. -- `"selinux"`: The "SELinux" namespace. Includes information about the - SELinux context of files. Note that this information is only available - if GLib has been built with SELinux support. - -Please note that these are not all of the possible namespaces. -More namespaces can be added from GIO modules or by individual applications. -For more information about writing GIO modules, see #GIOModule. - -<!-- TODO: Implementation note about using extended attributes on supported -file systems --> - -## Default Keys - -For a list of the built-in keys and their types, see the -[GFileInfo][GFileInfo] documentation. - -Note that there are no predefined keys in the "xattr" and "xattr-sys" -namespaces. Keys for the "xattr" namespace are constructed by stripping -away the "user." prefix from the extended user attribute, and prepending -"xattr::". Keys for the "xattr-sys" namespace are constructed by -concatenating "xattr-sys::" with the extended attribute name. All extended -attribute values are returned as hex-encoded strings in which bytes outside -the ASCII range are encoded as escape sequences of the form \x`nn` -where `nn` is a 2-digit hexadecimal number. - - - Contains helper functions for reporting errors to the user. - - - As of GLib 2.36, #GIOScheduler is deprecated in favor of -#GThreadPool and #GTask. - -Schedules asynchronous I/O operations. #GIOScheduler integrates -into the main event loop (#GMainLoop) and uses threads. - - - These functions support exporting a #GMenuModel on D-Bus. -The D-Bus interface that is used is a private implementation -detail. - -To access an exported #GMenuModel remotely, use -g_dbus_menu_model_get() to obtain a #GDBusMenuModel. - - - The `<gio/gnetworking.h>` header can be included to get -various low-level networking-related system headers, automatically -taking care of certain portability issues for you. - -This can be used, for example, if you want to call setsockopt() -on a #GSocket. - -Note that while WinSock has many of the same APIs as the -traditional UNIX socket API, most of them behave at least slightly -differently (particularly with respect to error handling). If you -want your code to work under both UNIX and Windows, you will need -to take these differences into account. - -Also, under GNU libc, certain non-portable functions are only visible -in the headers if you define %_GNU_SOURCE before including them. Note -that this symbol must be defined before including any headers, or it -may not take effect. - - - Utility functions for #GPollableInputStream and -#GPollableOutputStream implementations. - - - #GTlsConnection and related classes provide TLS (Transport Layer -Security, previously known as SSL, Secure Sockets Layer) support for -gio-based network streams. - -#GDtlsConnection and related classes provide DTLS (Datagram TLS) support for -GIO-based network sockets, using the #GDatagramBased interface. The TLS and -DTLS APIs are almost identical, except TLS is stream-based and DTLS is -datagram-based. They share certificate and backend infrastructure. - -In the simplest case, for a client TLS connection, you can just set the -#GSocketClient:tls flag on a #GSocketClient, and then any -connections created by that client will have TLS negotiated -automatically, using appropriate default settings, and rejecting -any invalid or self-signed certificates (unless you change that -default by setting the #GSocketClient:tls-validation-flags -property). The returned object will be a #GTcpWrapperConnection, -which wraps the underlying #GTlsClientConnection. - -For greater control, you can create your own #GTlsClientConnection, -wrapping a #GSocketConnection (or an arbitrary #GIOStream with -pollable input and output streams) and then connect to its signals, -such as #GTlsConnection::accept-certificate, before starting the -handshake. - -Server-side TLS is similar, using #GTlsServerConnection. At the -moment, there is no support for automatically wrapping server-side -connections in the way #GSocketClient does for client-side -connections. - - - Routines for managing mounted UNIX mount points and paths. - -Note that `<gio/gunixmounts.h>` belongs to the UNIX-specific GIO -interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config -file when using it. - - - #GWin32InputStream implements #GInputStream for reading from a -Windows file handle. - -Note that `<gio/gwin32inputstream.h>` belongs to the Windows-specific GIO -interfaces, thus you have to use the `gio-windows-2.0.pc` pkg-config file -when using it. - - - #GWin32OutputStream implements #GOutputStream for writing to a -Windows file handle. - -Note that `<gio/gwin32outputstream.h>` belongs to the Windows-specific GIO -interfaces, thus you have to use the `gio-windows-2.0.pc` pkg-config file -when using it. - - - #GWin32RegistryKey represents a single Windows Registry key. - -#GWin32RegistryKey is used by a number of helper functions that read -Windows Registry. All keys are opened with read-only access, and at -the moment there is no API for writing into registry keys or creating -new ones. - -#GWin32RegistryKey implements the #GInitable interface, so if it is manually -constructed by e.g. g_object_new() you must call g_initable_init() and check -the results before using the object. This is done automatically -in g_win32_registry_key_new() and g_win32_registry_key_get_child(), so these -functions can return %NULL. - -To increase efficiency, a UTF-16 variant is available for all functions -that deal with key or value names in the registry. Use these to perform -deep registry queries or other operations that require querying a name -of a key or a value and then opening it (or querying its data). The use -of UTF-16 functions avoids the overhead of converting names to UTF-8 and -back. - -All functions operate in current user's context (it is not possible to -access registry tree of a different user). - -Key paths must use '\\' as a separator, '/' is not supported. Key names -must not include '\\', because it's used as a separator. Value names -can include '\\'. - -Key and value names are not case sensitive. - -Full key name (excluding the pre-defined ancestor's name) can't exceed -255 UTF-16 characters, give or take. Value name can't exceed 16383 UTF-16 -characters. Tree depth is limited to 512 levels. - Deserializes a #GIcon previously serialized using g_icon_serialize(). - + filename="gio/gicon.c" + line="559">Deserializes a #GIcon previously serialized using g_icon_serialize(). + a #GIcon, or %NULL when deserialization fails. + filename="gio/gicon.c" + line="565">a #GIcon, or %NULL when deserialization fails. a #GVariant created with g_icon_serialize() + filename="gio/gicon.c" + line="561">a #GVariant created with g_icon_serialize() @@ -139159,27 +138940,26 @@ characters. Tree depth is limited to 512 levels. version="2.20" throws="1"> Generate a #GIcon instance from @str. This function can fail if + filename="gio/gicon.c" + line="425">Generate a #GIcon instance from @str. This function can fail if @str is not valid - see g_icon_to_string() for discussion. If your application or library provides one or more #GIcon implementations you need to ensure that each #GType is registered with the type system prior to calling g_icon_new_for_string(). - + An object implementing the #GIcon + filename="gio/gicon.c" + line="437">An object implementing the #GIcon interface or %NULL if @error is set. A string obtained via g_icon_to_string(). + filename="gio/gicon.c" + line="427">A string obtained via g_icon_to_string(). @@ -139192,38 +138972,37 @@ with the type system prior to calling g_icon_new_for_string(). deprecated-version="2.54" throws="1"> Helper function for constructing #GInitable object. This is + filename="gio/ginitable.c" + line="171">Helper function for constructing #GInitable object. This is similar to g_object_newv() but also initializes the object and returns %NULL, setting an error on failure. Use g_object_new_with_properties() and g_initable_init() instead. See #GParameter for more information. - + a newly allocated + filename="gio/ginitable.c" + line="184">a newly allocated #GObject, or %NULL on error a #GType supporting #GInitable. + filename="gio/ginitable.c" + line="173">a #GType supporting #GInitable. the number of parameters in @parameters + filename="gio/ginitable.c" + line="174">the number of parameters in @parameters the parameters to use to construct the object + filename="gio/ginitable.c" + line="175">the parameters to use to construct the object @@ -139233,35 +139012,46 @@ g_initable_init() instead. See #GParameter for more information. optional #GCancellable object, %NULL to ignore. + filename="gio/ginitable.c" + line="176">optional #GCancellable object, %NULL to ignore. Converts errno.h error codes into GIO error codes. The fallback -value %G_IO_ERROR_FAILED is returned for error codes not currently -handled (but note that future GLib releases may return a more + filename="gio/gioerror.c" + line="42">Converts `errno.h` error codes into GIO error codes. + +The fallback value %G_IO_ERROR_FAILED is returned for error codes not +currently handled (but note that future GLib releases may return a more specific value instead). -As %errno is global and may be modified by intermediate function -calls, you should save its value as soon as the call which sets it - +As `errno` is global and may be modified by intermediate function +calls, you should save its value immediately after the call returns, +and use the saved value instead of `errno`: + + +|[<!-- language="C" --> + int saved_errno; + + ret = read (blah); + saved_errno = errno; + + g_io_error_from_errno (saved_errno); +]| + #GIOErrorEnum value for the given errno.h error number. + filename="gio/gioerror.c" + line="66">#GIOErrorEnum value for the given `errno.h` error number Error number as defined in errno.h. + filename="gio/gioerror.c" + line="44">Error number as defined in errno.h. @@ -139270,33 +139060,32 @@ calls, you should save its value as soon as the call which sets it c:identifier="g_io_error_from_file_error" version="2.74"> Converts #GFileError error codes into GIO error codes. - + filename="gio/gioerror.c" + line="247">Converts #GFileError error codes into GIO error codes. + #GIOErrorEnum value for the given #GFileError error value. + filename="gio/gioerror.c" + line="253">#GIOErrorEnum value for the given #GFileError error value. a #GFileError. + filename="gio/gioerror.c" + line="249">a #GFileError. Gets the GIO Error Quark. + filename="gio/gioerror.c" + line="33">Gets the GIO Error Quark. a #GQuark. + filename="gio/gioerror.c" + line="38">a #GQuark. @@ -139304,43 +139093,42 @@ calls, you should save its value as soon as the call which sets it c:identifier="g_io_extension_point_implement" moved-to="IOExtensionPoint.implement"> Registers @type as extension for the extension point with name + filename="gio/giomodule.c" + line="1582">Registers @type as extension for the extension point with name @extension_point_name. If @type has already been registered as an extension for this extension point, the existing #GIOExtension object is returned. - + a #GIOExtension object for #GType + filename="gio/giomodule.c" + line="1595">a #GIOExtension object for #GType the name of the extension point + filename="gio/giomodule.c" + line="1584">the name of the extension point the #GType to register as extension + filename="gio/giomodule.c" + line="1585">the #GType to register as extension the name for the extension + filename="gio/giomodule.c" + line="1586">the name for the extension the priority for the extension + filename="gio/giomodule.c" + line="1587">the priority for the extension @@ -139349,22 +139137,21 @@ extension point, the existing #GIOExtension object is returned. c:identifier="g_io_extension_point_lookup" moved-to="IOExtensionPoint.lookup"> Looks up an existing extension point. - + filename="gio/giomodule.c" + line="1440">Looks up an existing extension point. + the #GIOExtensionPoint, or %NULL if there + filename="gio/giomodule.c" + line="1446">the #GIOExtensionPoint, or %NULL if there is no registered extension point with the given name. the name of the extension point + filename="gio/giomodule.c" + line="1442">the name of the extension point @@ -139373,22 +139160,21 @@ extension point, the existing #GIOExtension object is returned. c:identifier="g_io_extension_point_register" moved-to="IOExtensionPoint.register"> Registers an extension point. - + filename="gio/giomodule.c" + line="1402">Registers an extension point. + the new #GIOExtensionPoint. This object is + filename="gio/giomodule.c" + line="1408">the new #GIOExtensionPoint. This object is owned by GIO and should not be freed. The name of the extension point + filename="gio/giomodule.c" + line="1404">The name of the extension point @@ -139396,18 +139182,17 @@ extension point, the existing #GIOExtension object is returned. Loads all the modules in the specified directory. + filename="gio/giomodule.c" + line="692">Loads all the modules in the specified directory. If don't require all modules to be initialized (and thus registering all gtypes) then you can use g_io_modules_scan_all_in_directory() which allows delayed/lazy loading of modules. - + a list of #GIOModules loaded + filename="gio/giomodule.c" + line="703">a list of #GIOModules loaded from the directory, All the modules are loaded into memory, if you want to unload them (enabling on-demand loading) you must call @@ -139420,8 +139205,8 @@ which allows delayed/lazy loading of modules. pathname for a directory containing modules + filename="gio/giomodule.c" + line="694">pathname for a directory containing modules to load. @@ -139431,18 +139216,17 @@ which allows delayed/lazy loading of modules. c:identifier="g_io_modules_load_all_in_directory_with_scope" version="2.30"> Loads all the modules in the specified directory. + filename="gio/giomodule.c" + line="626">Loads all the modules in the specified directory. If don't require all modules to be initialized (and thus registering all gtypes) then you can use g_io_modules_scan_all_in_directory() which allows delayed/lazy loading of modules. - + a list of #GIOModules loaded + filename="gio/giomodule.c" + line="638">a list of #GIOModules loaded from the directory, All the modules are loaded into memory, if you want to unload them (enabling on-demand loading) you must call @@ -139455,15 +139239,15 @@ which allows delayed/lazy loading of modules. pathname for a directory containing modules + filename="gio/giomodule.c" + line="628">pathname for a directory containing modules to load. a scope to use when scanning the modules. + filename="gio/giomodule.c" + line="630">a scope to use when scanning the modules. @@ -139472,8 +139256,8 @@ which allows delayed/lazy loading of modules. c:identifier="g_io_modules_scan_all_in_directory" version="2.24"> Scans all the modules in the specified directory, ensuring that + filename="gio/giomodule.c" + line="601">Scans all the modules in the specified directory, ensuring that any extension point implemented by a module is registered. This may not actually load and initialize all the types in each @@ -139484,16 +139268,15 @@ g_io_extension_point_get_extension_by_name(). If you need to guarantee that all types are loaded in all the modules, use g_io_modules_load_all_in_directory(). - + pathname for a directory containing modules + filename="gio/giomodule.c" + line="603">pathname for a directory containing modules to scan. @@ -139503,8 +139286,8 @@ use g_io_modules_load_all_in_directory(). c:identifier="g_io_modules_scan_all_in_directory_with_scope" version="2.30"> Scans all the modules in the specified directory, ensuring that + filename="gio/giomodule.c" + line="448">Scans all the modules in the specified directory, ensuring that any extension point implemented by a module is registered. This may not actually load and initialize all the types in each @@ -139515,51 +139298,51 @@ g_io_extension_point_get_extension_by_name(). If you need to guarantee that all types are loaded in all the modules, use g_io_modules_load_all_in_directory(). - + pathname for a directory containing modules + filename="gio/giomodule.c" + line="450">pathname for a directory containing modules to scan. a scope to use when scanning the modules + filename="gio/giomodule.c" + line="452">a scope to use when scanning the modules + deprecated="1" + deprecated-version="2.36"> Cancels all cancellable I/O jobs. + filename="gio/gioscheduler.c" + line="140">Cancels all cancellable I/O jobs. A job is cancellable if a #GCancellable was passed into g_io_scheduler_push_job(). You should never call this function, since you don't know how other libraries in your program might be making use of gioscheduler. - + + deprecated="1" + deprecated-version="2.36"> Schedules the I/O job to run in another thread. + filename="gio/gioscheduler.c" + line="83">Schedules the I/O job to run in another thread. @notify will be called on @user_data after @job_func has returned, regardless whether the job was cancelled or has run to completion. @@ -139568,8 +139351,7 @@ If @cancellable is not %NULL, it can be used to cancel the I/O job by calling g_cancellable_cancel() or by calling g_io_scheduler_cancel_all_jobs(). use #GThreadPool or g_task_run_in_thread() - + @@ -139580,8 +139362,8 @@ g_io_scheduler_cancel_all_jobs(). closure="1" destroy="2"> a #GIOSchedulerJobFunc. + filename="gio/gioscheduler.c" + line="85">a #GIOSchedulerJobFunc. nullable="1" allow-none="1"> data to pass to @job_func + filename="gio/gioscheduler.c" + line="86">data to pass to @job_func allow-none="1" scope="async"> a #GDestroyNotify for @user_data, or %NULL + filename="gio/gioscheduler.c" + line="87">a #GDestroyNotify for @user_data, or %NULL the [I/O priority][io-priority] + filename="gio/gioscheduler.c" + line="88">the [I/O priority][io-priority] of the request. @@ -139615,8 +139397,8 @@ of the request. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gioscheduler.c" + line="90">optional #GCancellable object, %NULL to ignore. @@ -139624,8 +139406,8 @@ of the request. Creates a keyfile-backed #GSettingsBackend. + filename="gio/gkeyfilesettingsbackend.c" + line="952">Creates a keyfile-backed #GSettingsBackend. The filename of the keyfile to use is given by @filename. @@ -139674,25 +139456,24 @@ The backend reads default values from a keyfile called `defaults` in the directory specified by the #GKeyfileSettingsBackend:defaults-dir property, and a list of locked keys from a text file with the name `locks` in the same location. - + a keyfile-backed #GSettingsBackend + filename="gio/gkeyfilesettingsbackend.c" + line="1009">a keyfile-backed #GSettingsBackend the filename of the keyfile + filename="gio/gkeyfilesettingsbackend.c" + line="954">the filename of the keyfile the path under which all settings keys appear + filename="gio/gkeyfilesettingsbackend.c" + line="955">the path under which all settings keys appear nullable="1" allow-none="1"> the group name corresponding to + filename="gio/gkeyfilesettingsbackend.c" + line="956">the group name corresponding to @root_path, or %NULL @@ -139712,14 +139493,13 @@ the same location. moved-to="MemoryMonitor.dup_default" version="2.64"> Gets a reference to the default #GMemoryMonitor for the system. - + filename="gio/gmemorymonitor.c" + line="109">Gets a reference to the default #GMemoryMonitor for the system. + a new reference to the default #GMemoryMonitor + filename="gio/gmemorymonitor.c" + line="114">a new reference to the default #GMemoryMonitor @@ -139727,18 +139507,17 @@ the same location. c:identifier="g_memory_settings_backend_new" version="2.28"> Creates a memory-backed #GSettingsBackend. + filename="gio/gmemorysettingsbackend.c" + line="178">Creates a memory-backed #GSettingsBackend. This backend allows changes to settings, but does not write them to any backing storage, so the next time you run your application, the memory backend will start out with the default values again. - + a newly created #GSettingsBackend + filename="gio/gmemorysettingsbackend.c" + line="187">a newly created #GSettingsBackend @@ -139747,14 +139526,13 @@ the memory backend will start out with the default values again. moved-to="NetworkMonitor.get_default" version="2.32"> Gets the default #GNetworkMonitor for the system. - + filename="gio/gnetworkmonitor.c" + line="74">Gets the default #GNetworkMonitor for the system. + a #GNetworkMonitor, which will be + filename="gio/gnetworkmonitor.c" + line="79">a #GNetworkMonitor, which will be a dummy object if no network monitor is available @@ -139763,13 +139541,12 @@ the memory backend will start out with the default values again. c:identifier="g_networking_init" version="2.36"> Initializes the platform networking libraries (eg, on Windows, this + filename="gio/gnetworking.c" + line="28">Initializes the platform networking libraries (eg, on Windows, this calls WSAStartup()). GLib will call this itself if it is needed, so you only need to call it if you directly call system networking functions (without calling any GLib networking functions first). - + @@ -139778,17 +139555,16 @@ functions (without calling any GLib networking functions first). c:identifier="g_null_settings_backend_new" version="2.28"> Creates a readonly #GSettingsBackend. + filename="gio/gnullsettingsbackend.c" + line="123">Creates a readonly #GSettingsBackend. This backend does not allow changes to settings, so all settings will always have their default values. - + a newly created #GSettingsBackend + filename="gio/gnullsettingsbackend.c" + line="132">a newly created #GSettingsBackend @@ -139796,25 +139572,24 @@ will always have their default values. c:identifier="g_pollable_source_new" version="2.28"> Utility method for #GPollableInputStream and #GPollableOutputStream + filename="gio/gpollableutils.c" + line="88">Utility method for #GPollableInputStream and #GPollableOutputStream implementations. Creates a new #GSource that expects a callback of type #GPollableSourceFunc. The new source does not actually do anything on its own; use g_source_add_child_source() to add other sources to it to cause it to trigger. - + the new #GSource. + filename="gio/gpollableutils.c" + line="98">the new #GSource. the stream associated with the new source + filename="gio/gpollableutils.c" + line="90">the stream associated with the new source @@ -139823,24 +139598,23 @@ sources to it to cause it to trigger. c:identifier="g_pollable_source_new_full" version="2.34"> Utility method for #GPollableInputStream and #GPollableOutputStream + filename="gio/gpollableutils.c" + line="119">Utility method for #GPollableInputStream and #GPollableOutputStream implementations. Creates a new #GSource, as with g_pollable_source_new(), but also attaching @child_source (with a dummy callback), and @cancellable, if they are non-%NULL. - + the new #GSource. + filename="gio/gpollableutils.c" + line="131">the new #GSource. the stream associated with the + filename="gio/gpollableutils.c" + line="121">the stream associated with the new source @@ -139849,8 +139623,8 @@ dummy callback), and @cancellable, if they are non-%NULL. nullable="1" allow-none="1"> optional child source to attach + filename="gio/gpollableutils.c" + line="123">optional child source to attach nullable="1" allow-none="1"> optional #GCancellable to attach + filename="gio/gpollableutils.c" + line="124">optional #GCancellable to attach @@ -139869,8 +139643,8 @@ dummy callback), and @cancellable, if they are non-%NULL. version="2.34" throws="1"> Tries to read from @stream, as with g_input_stream_read() (if + filename="gio/gpollableutils.c" + line="163">Tries to read from @stream, as with g_input_stream_read() (if @blocking is %TRUE) or g_pollable_input_stream_read_nonblocking() (if @blocking is %FALSE). This can be used to more easily share code between blocking and non-blocking implementations of a method. @@ -139879,25 +139653,24 @@ If @blocking is %FALSE, then @stream must be a #GPollableInputStream for which g_pollable_input_stream_can_poll() returns %TRUE, or else the behavior is undefined. If @blocking is %TRUE, then @stream does not need to be a #GPollableInputStream. - + the number of bytes read, or -1 on error. + filename="gio/gpollableutils.c" + line="183">the number of bytes read, or -1 on error. a #GInputStream + filename="gio/gpollableutils.c" + line="165">a #GInputStream a buffer to + filename="gio/gpollableutils.c" + line="166">a buffer to read data into @@ -139905,14 +139678,14 @@ returns %TRUE, or else the behavior is undefined. If @blocking is the number of bytes to read + filename="gio/gpollableutils.c" + line="168">the number of bytes to read whether to do blocking I/O + filename="gio/gpollableutils.c" + line="169">whether to do blocking I/O optional #GCancellable object, %NULL to ignore. + filename="gio/gpollableutils.c" + line="170">optional #GCancellable object, %NULL to ignore. @@ -139931,8 +139704,8 @@ returns %TRUE, or else the behavior is undefined. If @blocking is version="2.34" throws="1"> Tries to write to @stream, as with g_output_stream_write() (if + filename="gio/gpollableutils.c" + line="209">Tries to write to @stream, as with g_output_stream_write() (if @blocking is %TRUE) or g_pollable_output_stream_write_nonblocking() (if @blocking is %FALSE). This can be used to more easily share code between blocking and non-blocking implementations of a method. @@ -139942,25 +139715,24 @@ If @blocking is %FALSE, then @stream must be a g_pollable_output_stream_can_poll() returns %TRUE or else the behavior is undefined. If @blocking is %TRUE, then @stream does not need to be a #GPollableOutputStream. - + the number of bytes written, or -1 on error. + filename="gio/gpollableutils.c" + line="230">the number of bytes written, or -1 on error. a #GOutputStream. + filename="gio/gpollableutils.c" + line="211">a #GOutputStream. the buffer + filename="gio/gpollableutils.c" + line="212">the buffer containing the data to write. @@ -139968,14 +139740,14 @@ need to be a #GPollableOutputStream. the number of bytes to write + filename="gio/gpollableutils.c" + line="214">the number of bytes to write whether to do blocking I/O + filename="gio/gpollableutils.c" + line="215">whether to do blocking I/O nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gpollableutils.c" + line="216">optional #GCancellable object, %NULL to ignore. @@ -139994,8 +139766,8 @@ need to be a #GPollableOutputStream. version="2.34" throws="1"> Tries to write @count bytes to @stream, as with + filename="gio/gpollableutils.c" + line="256">Tries to write @count bytes to @stream, as with g_output_stream_write_all(), but using g_pollable_stream_write() rather than g_output_stream_write(). @@ -140013,25 +139785,24 @@ As with g_pollable_stream_write(), if @blocking is %FALSE, then g_pollable_output_stream_can_poll() returns %TRUE or else the behavior is undefined. If @blocking is %TRUE, then @stream does not need to be a #GPollableOutputStream. - + %TRUE on success, %FALSE if there was an error + filename="gio/gpollableutils.c" + line="287">%TRUE on success, %FALSE if there was an error a #GOutputStream. + filename="gio/gpollableutils.c" + line="258">a #GOutputStream. the buffer + filename="gio/gpollableutils.c" + line="259">the buffer containing the data to write. @@ -140039,14 +139810,14 @@ need to be a #GPollableOutputStream. the number of bytes to write + filename="gio/gpollableutils.c" + line="261">the number of bytes to write whether to do blocking I/O + filename="gio/gpollableutils.c" + line="262">whether to do blocking I/O caller-allocates="0" transfer-ownership="full"> location to store the number of bytes that was + filename="gio/gpollableutils.c" + line="263">location to store the number of bytes that was written to the stream @@ -140064,8 +139835,8 @@ need to be a #GPollableOutputStream. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="gio/gpollableutils.c" + line="265">optional #GCancellable object, %NULL to ignore. @@ -140075,14 +139846,13 @@ need to be a #GPollableOutputStream. moved-to="PowerProfileMonitor.dup_default" version="2.70"> Gets a reference to the default #GPowerProfileMonitor for the system. - + filename="gio/gpowerprofilemonitor.c" + line="77">Gets a reference to the default #GPowerProfileMonitor for the system. + a new reference to the default #GPowerProfileMonitor + filename="gio/gpowerprofilemonitor.c" + line="82">a new reference to the default #GPowerProfileMonitor @@ -140091,23 +139861,22 @@ need to be a #GPollableOutputStream. moved-to="Proxy.get_default_for_protocol" version="2.26"> Find the `gio-proxy` extension point for a proxy implementation that supports + filename="gio/gproxy.c" + line="51">Find the `gio-proxy` extension point for a proxy implementation that supports the specified protocol. - + return a #GProxy or NULL if protocol + filename="gio/gproxy.c" + line="58">return a #GProxy or NULL if protocol is not supported. the proxy protocol name (e.g. http, socks, etc) + filename="gio/gproxy.c" + line="53">the proxy protocol name (e.g. http, socks, etc) @@ -140117,14 +139886,13 @@ the specified protocol. moved-to="ProxyResolver.get_default" version="2.26"> Gets the default #GProxyResolver for the system. - + filename="gio/gproxyresolver.c" + line="75">Gets the default #GProxyResolver for the system. + the default #GProxyResolver, which + filename="gio/gproxyresolver.c" + line="80">the default #GProxyResolver, which will be a dummy object if no proxy resolver is available @@ -140134,12 +139902,12 @@ the specified protocol. moved-to="ResolverError.quark" version="2.22"> Gets the #GResolver Error Quark. + filename="gio/gresolver.c" + line="1360">Gets the #GResolver Error Quark. a #GQuark. + filename="gio/gresolver.c" + line="1365">a #GQuark. @@ -140148,12 +139916,12 @@ the specified protocol. moved-to="ResourceError.quark" version="2.32"> Gets the #GResource Error Quark. + filename="gio/gresource.c" + line="509">Gets the #GResource Error Quark. a #GQuark + filename="gio/gresource.c" + line="514">a #GQuark @@ -140163,8 +139931,8 @@ the specified protocol. version="2.32" throws="1"> Loads a binary resource bundle and creates a #GResource representation of it, allowing + filename="gio/gresource.c" + line="641">Loads a binary resource bundle and creates a #GResource representation of it, allowing you to query it for data. If you want to use this resource in the global resource namespace you need @@ -140174,19 +139942,18 @@ If @filename is empty or the data in it is corrupt, %G_RESOURCE_ERROR_INTERNAL will be returned. If @filename doesn’t exist, or there is an error in reading it, an error from g_mapped_file_new() will be returned. - + a new #GResource, or %NULL on error + filename="gio/gresource.c" + line="657">a new #GResource, or %NULL on error the path of a filename to load, in the GLib filename encoding + filename="gio/gresource.c" + line="643">the path of a filename to load, in the GLib filename encoding @@ -140196,19 +139963,18 @@ returned. version="2.32" throws="1"> Returns all the names of children at the specified @path in the set of + filename="gio/gresource.c" + line="1212">Returns all the names of children at the specified @path in the set of globally registered resources. The return result is a %NULL terminated list of strings which should be released with g_strfreev(). @lookup_flags controls the behaviour of the lookup. - + an array of constant strings + filename="gio/gresource.c" + line="1225">an array of constant strings @@ -140216,14 +139982,14 @@ be released with g_strfreev(). A pathname inside the resource + filename="gio/gresource.c" + line="1214">A pathname inside the resource A #GResourceLookupFlags + filename="gio/gresource.c" + line="1215">A #GResourceLookupFlags @@ -140233,30 +139999,29 @@ be released with g_strfreev(). version="2.32" throws="1"> Looks for a file at the specified @path in the set of + filename="gio/gresource.c" + line="1292">Looks for a file at the specified @path in the set of globally registered resources and if found returns information about it. @lookup_flags controls the behaviour of the lookup. - + %TRUE if the file was found. %FALSE if there were errors + filename="gio/gresource.c" + line="1307">%TRUE if the file was found. %FALSE if there were errors A pathname inside the resource + filename="gio/gresource.c" + line="1294">A pathname inside the resource A #GResourceLookupFlags + filename="gio/gresource.c" + line="1295">A #GResourceLookupFlags a location to place the length of the contents of the file, + filename="gio/gresource.c" + line="1296">a location to place the length of the contents of the file, or %NULL if the length is not needed @@ -140278,8 +140043,8 @@ globally registered resources and if found returns information about it. optional="1" allow-none="1"> a location to place the #GResourceFlags about the file, + filename="gio/gresource.c" + line="1298">a location to place the #GResourceFlags about the file, or %NULL if the flags are not needed @@ -140290,8 +140055,8 @@ globally registered resources and if found returns information about it. version="2.32" throws="1"> Looks for a file at the specified @path in the set of + filename="gio/gresource.c" + line="1140">Looks for a file at the specified @path in the set of globally registered resources and returns a #GBytes that lets you directly access the data in memory. @@ -140305,26 +140070,25 @@ in the program binary. For compressed files we allocate memory on the heap and automatically uncompress the data. @lookup_flags controls the behaviour of the lookup. - + #GBytes or %NULL on error. + filename="gio/gresource.c" + line="1161">#GBytes or %NULL on error. Free the returned object with g_bytes_unref() A pathname inside the resource + filename="gio/gresource.c" + line="1142">A pathname inside the resource A #GResourceLookupFlags + filename="gio/gresource.c" + line="1143">A #GResourceLookupFlags @@ -140334,32 +140098,31 @@ the heap and automatically uncompress the data. version="2.32" throws="1"> Looks for a file at the specified @path in the set of + filename="gio/gresource.c" + line="1077">Looks for a file at the specified @path in the set of globally registered resources and returns a #GInputStream that lets you read the data. @lookup_flags controls the behaviour of the lookup. - + #GInputStream or %NULL on error. + filename="gio/gresource.c" + line="1089">#GInputStream or %NULL on error. Free the returned object with g_object_unref() A pathname inside the resource + filename="gio/gresource.c" + line="1079">A pathname inside the resource A #GResourceLookupFlags + filename="gio/gresource.c" + line="1080">A #GResourceLookupFlags @@ -140368,20 +140131,19 @@ that lets you read the data. c:identifier="g_resources_register" version="2.32"> Registers the resource with the process-global set of resources. + filename="gio/gresource.c" + line="1043">Registers the resource with the process-global set of resources. Once a resource is registered the files in it can be accessed with the global resource lookup functions like g_resources_lookup_data(). - + A #GResource + filename="gio/gresource.c" + line="1045">A #GResource @@ -140390,18 +140152,17 @@ with the global resource lookup functions like g_resources_lookup_data(). c:identifier="g_resources_unregister" version="2.32"> Unregisters the resource from the process-global set of resources. - + filename="gio/gresource.c" + line="1061">Unregisters the resource from the process-global set of resources. + A #GResource + filename="gio/gresource.c" + line="1063">A #GResource @@ -140411,8 +140172,8 @@ with the global resource lookup functions like g_resources_lookup_data(). moved-to="SettingsSchemaSource.get_default" version="2.32"> Gets the default system schema source. + filename="gio/gsettingsschema.c" + line="376">Gets the default system schema source. This function is not required for normal uses of #GSettings but it may be useful to authors of plugin management systems or to those who @@ -140425,12 +140186,11 @@ from different directories, depending on which directories were given in `XDG_DATA_DIRS` and `GSETTINGS_SCHEMA_DIR`. For this reason, all lookups performed against the default source should probably be done recursively. - + the default schema source + filename="gio/gsettingsschema.c" + line="393">the default schema source @@ -140440,13 +140200,12 @@ recursively. deprecated="1" deprecated-version="2.46"> Reports an error in an asynchronous function in an idle function by + filename="gio/gsimpleasyncresult.c" + line="1005">Reports an error in an asynchronous function in an idle function by directly setting the contents of the #GAsyncResult with the given error information. Use g_task_report_error(). - + @@ -140456,8 +140215,8 @@ information. nullable="1" allow-none="1"> a #GObject, or %NULL. + filename="gio/gsimpleasyncresult.c" + line="1007">a #GObject, or %NULL. scope="async" closure="2"> a #GAsyncReadyCallback. + filename="gio/gsimpleasyncresult.c" + line="1008">a #GAsyncReadyCallback. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gsimpleasyncresult.c" + line="1009">user data passed to @callback. a #GQuark containing the error domain (usually %G_IO_ERROR). + filename="gio/gsimpleasyncresult.c" + line="1010">a #GQuark containing the error domain (usually %G_IO_ERROR). a specific error code. + filename="gio/gsimpleasyncresult.c" + line="1011">a specific error code. a formatted error reporting string. + filename="gio/gsimpleasyncresult.c" + line="1012">a formatted error reporting string. a list of variables to fill in @format. + filename="gio/gsimpleasyncresult.c" + line="1013">a list of variables to fill in @format. @@ -140511,13 +140270,12 @@ information. deprecated="1" deprecated-version="2.46"> Reports an error in an idle function. Similar to + filename="gio/gsimpleasyncresult.c" + line="1048">Reports an error in an idle function. Similar to g_simple_async_report_error_in_idle(), but takes a #GError rather than building a new one. Use g_task_report_error(). - + @@ -140527,8 +140285,8 @@ than building a new one. nullable="1" allow-none="1"> a #GObject, or %NULL + filename="gio/gsimpleasyncresult.c" + line="1050">a #GObject, or %NULL scope="async" closure="2"> a #GAsyncReadyCallback. + filename="gio/gsimpleasyncresult.c" + line="1051">a #GAsyncReadyCallback. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gsimpleasyncresult.c" + line="1052">user data passed to @callback. the #GError to report + filename="gio/gsimpleasyncresult.c" + line="1053">the #GError to report @@ -140566,13 +140324,12 @@ than building a new one. deprecated="1" deprecated-version="2.46"> Reports an error in an idle function. Similar to + filename="gio/gsimpleasyncresult.c" + line="1080">Reports an error in an idle function. Similar to g_simple_async_report_gerror_in_idle(), but takes over the caller's ownership of @error, so the caller does not have to free it any more. Use g_task_report_error(). - + @@ -140582,8 +140339,8 @@ ownership of @error, so the caller does not have to free it any more. nullable="1" allow-none="1"> a #GObject, or %NULL + filename="gio/gsimpleasyncresult.c" + line="1082">a #GObject, or %NULL scope="async" closure="2"> a #GAsyncReadyCallback. + filename="gio/gsimpleasyncresult.c" + line="1083">a #GAsyncReadyCallback. nullable="1" allow-none="1"> user data passed to @callback. + filename="gio/gsimpleasyncresult.c" + line="1084">user data passed to @callback. the #GError to report + filename="gio/gsimpleasyncresult.c" + line="1085">the #GError to report @@ -140620,14 +140377,13 @@ ownership of @error, so the caller does not have to free it any more. version="2.22" introspectable="0"> Sorts @targets in place according to the algorithm in RFC 2782. - + filename="gio/gsrvtarget.c" + line="218">Sorts @targets in place according to the algorithm in RFC 2782. + the head of the sorted list. + filename="gio/gsrvtarget.c" + line="224">the head of the sorted list. @@ -140635,8 +140391,8 @@ ownership of @error, so the caller does not have to free it any more. a #GList of #GSrvTarget + filename="gio/gsrvtarget.c" + line="220">a #GList of #GSrvTarget @@ -140648,14 +140404,13 @@ ownership of @error, so the caller does not have to free it any more. moved-to="TlsBackend.get_default" version="2.28"> Gets the default #GTlsBackend for the system. - + filename="gio/gtlsbackend.c" + line="53">Gets the default #GTlsBackend for the system. + a #GTlsBackend, which will be a + filename="gio/gtlsbackend.c" + line="58">a #GTlsBackend, which will be a dummy object if no TLS backend is available @@ -140665,12 +140420,12 @@ ownership of @error, so the caller does not have to free it any more. moved-to="TlsChannelBindingError.quark" version="2.66"> Gets the TLS channel binding error quark. + filename="gio/gtlsconnection.c" + line="868">Gets the TLS channel binding error quark. a #GQuark. + filename="gio/gtlsconnection.c" + line="873">a #GQuark. @@ -140680,28 +140435,27 @@ ownership of @error, so the caller does not have to free it any more. version="2.28" throws="1"> Creates a new #GTlsClientConnection wrapping @base_io_stream (which + filename="gio/gtlsclientconnection.c" + line="144">Creates a new #GTlsClientConnection wrapping @base_io_stream (which must have pollable input and output streams) which is assumed to communicate with the server identified by @server_identity. See the documentation for #GTlsConnection:base-io-stream for restrictions on when application code can run operations on the @base_io_stream after this function has returned. - + the new + filename="gio/gtlsclientconnection.c" + line="158">the new #GTlsClientConnection, or %NULL on error the #GIOStream to wrap + filename="gio/gtlsclientconnection.c" + line="146">the #GIOStream to wrap nullable="1" allow-none="1"> the expected identity of the server + filename="gio/gtlsclientconnection.c" + line="147">the expected identity of the server @@ -140720,12 +140474,12 @@ this function has returned. moved-to="TlsError.quark" version="2.28"> Gets the TLS error quark. + filename="gio/gtlsconnection.c" + line="1094">Gets the TLS error quark. a #GQuark. + filename="gio/gtlsconnection.c" + line="1099">a #GQuark. @@ -140735,25 +140489,24 @@ this function has returned. version="2.30" throws="1"> Creates a new #GTlsFileDatabase which uses anchor certificate authorities + filename="gio/gtlsfiledatabase.c" + line="65">Creates a new #GTlsFileDatabase which uses anchor certificate authorities in @anchors to verify certificate chains. The certificates in @anchors must be PEM encoded. - + the new + filename="gio/gtlsfiledatabase.c" + line="75">the new #GTlsFileDatabase, or %NULL on error filename of anchor certificate authorities. + filename="gio/gtlsfiledatabase.c" + line="67">filename of anchor certificate authorities. @@ -140764,27 +140517,26 @@ The certificates in @anchors must be PEM encoded. version="2.28" throws="1"> Creates a new #GTlsServerConnection wrapping @base_io_stream (which + filename="gio/gtlsserverconnection.c" + line="63">Creates a new #GTlsServerConnection wrapping @base_io_stream (which must have pollable input and output streams). See the documentation for #GTlsConnection:base-io-stream for restrictions on when application code can run operations on the @base_io_stream after this function has returned. - + the new + filename="gio/gtlsserverconnection.c" + line="76">the new #GTlsServerConnection, or %NULL on error the #GIOStream to wrap + filename="gio/gtlsserverconnection.c" + line="65">the #GIOStream to wrap nullable="1" allow-none="1"> the default server certificate, or %NULL + filename="gio/gtlsserverconnection.c" + line="66">the default server certificate, or %NULL @@ -140801,25 +140553,24 @@ this function has returned. Determines if @mount_path is considered an implementation of the + filename="gio/gunixmounts.c" + line="221">Determines if @mount_path is considered an implementation of the OS. This is primarily used for hiding mountable and mounted volumes that only are used in the OS and has little to no relevance to the casual user. - + %TRUE if @mount_path is considered an implementation detail + filename="gio/gunixmounts.c" + line="230">%TRUE if @mount_path is considered an implementation detail of the OS. a mount path, e.g. `/media/disk` or `/usr` + filename="gio/gunixmounts.c" + line="223">a mount path, e.g. `/media/disk` or `/usr` @@ -140828,28 +140579,27 @@ casual user. c:identifier="g_unix_is_system_device_path" version="2.56"> Determines if @device_path is considered a block device path which is only + filename="gio/gunixmounts.c" + line="368">Determines if @device_path is considered a block device path which is only used in implementation of the OS. This is primarily used for hiding mounted volumes that are intended as APIs for programs to read, and system administrators at a shell; rather than something that should, for example, appear in a GUI. For example, the Linux `/proc` filesystem. The list of device paths considered ‘system’ ones may change over time. - + %TRUE if @device_path is considered an implementation detail of + filename="gio/gunixmounts.c" + line="380">%TRUE if @device_path is considered an implementation detail of the OS. a device path, e.g. `/dev/loop0` or `nfsd` + filename="gio/gunixmounts.c" + line="370">a device path, e.g. `/dev/loop0` or `nfsd` @@ -140858,35 +140608,34 @@ The list of device paths considered ‘system’ ones may change over time. Determines if @fs_type is considered a type of file system which is only + filename="gio/gunixmounts.c" + line="299">Determines if @fs_type is considered a type of file system which is only used in implementation of the OS. This is primarily used for hiding mounted volumes that are intended as APIs for programs to read, and system administrators at a shell; rather than something that should, for example, appear in a GUI. For example, the Linux `/proc` filesystem. The list of file system types considered ‘system’ ones may change over time. - + %TRUE if @fs_type is considered an implementation detail of the OS. + filename="gio/gunixmounts.c" + line="311">%TRUE if @fs_type is considered an implementation detail of the OS. a file system type, e.g. `procfs` or `tmpfs` + filename="gio/gunixmounts.c" + line="301">a file system type, e.g. `procfs` or `tmpfs` Gets a #GUnixMountEntry for a given mount path. If @time_read + filename="gio/gunixmounts.c" + line="1591">Gets a #GUnixMountEntry for a given mount path. If @time_read is set, it will be filled with a unix timestamp for checking if the mounts have changed since with g_unix_mounts_changed_since(). @@ -140894,19 +140643,18 @@ If more mounts have the same mount path, the last matching mount is returned. This will return %NULL if there is no mount point at @mount_path. - + a #GUnixMountEntry. + filename="gio/gunixmounts.c" + line="1605">a #GUnixMountEntry. path for a possible unix mount. + filename="gio/gunixmounts.c" + line="1593">path for a possible unix mount. optional="1" allow-none="1"> guint64 to contain a timestamp. + filename="gio/gunixmounts.c" + line="1594">guint64 to contain a timestamp. Compares two unix mounts. - + filename="gio/gunixmounts.c" + line="2356">Compares two unix mounts. + 1, 0 or -1 if @mount1 is greater than, equal to, + filename="gio/gunixmounts.c" + line="2363">1, 0 or -1 if @mount1 is greater than, equal to, or less than @mount2, respectively. first #GUnixMountEntry to compare. + filename="gio/gunixmounts.c" + line="2358">first #GUnixMountEntry to compare. second #GUnixMountEntry to compare. + filename="gio/gunixmounts.c" + line="2359">second #GUnixMountEntry to compare. @@ -140954,21 +140701,20 @@ or less than @mount2, respectively. c:identifier="g_unix_mount_copy" version="2.54"> Makes a copy of @mount_entry. - + filename="gio/gunixmounts.c" + line="2280">Makes a copy of @mount_entry. + a new #GUnixMountEntry + filename="gio/gunixmounts.c" + line="2286">a new #GUnixMountEntry a #GUnixMountEntry. + filename="gio/gunixmounts.c" + line="2282">a #GUnixMountEntry. @@ -140977,8 +140723,8 @@ or less than @mount2, respectively. c:identifier="g_unix_mount_for" version="2.52"> Gets a #GUnixMountEntry for a given file path. If @time_read + filename="gio/gunixmounts.c" + line="1636">Gets a #GUnixMountEntry for a given file path. If @time_read is set, it will be filled with a unix timestamp for checking if the mounts have changed since with g_unix_mounts_changed_since(). @@ -140987,19 +140733,18 @@ is returned. This will return %NULL if looking up the mount entry fails, if @file_path doesn’t exist or there is an I/O error. - + a #GUnixMountEntry. + filename="gio/gunixmounts.c" + line="1651">a #GUnixMountEntry. file path on some unix mount. + filename="gio/gunixmounts.c" + line="1638">file path on some unix mount. guint64 to contain a timestamp. + filename="gio/gunixmounts.c" + line="1639">guint64 to contain a timestamp. Frees a unix mount. - + filename="gio/gunixmounts.c" + line="2261">Frees a unix mount. + a #GUnixMountEntry. + filename="gio/gunixmounts.c" + line="2263">a #GUnixMountEntry. @@ -141036,21 +140780,20 @@ This will return %NULL if looking up the mount entry fails, if Gets the device path for a unix mount. - + filename="gio/gunixmounts.c" + line="2417">Gets the device path for a unix mount. + a string containing the device path. + filename="gio/gunixmounts.c" + line="2423">a string containing the device path. a #GUnixMount. + filename="gio/gunixmounts.c" + line="2419">a #GUnixMount. @@ -141058,21 +140801,20 @@ This will return %NULL if looking up the mount entry fails, if Gets the filesystem type for the unix mount. - + filename="gio/gunixmounts.c" + line="2456">Gets the filesystem type for the unix mount. + a string containing the file system type. + filename="gio/gunixmounts.c" + line="2462">a string containing the file system type. a #GUnixMount. + filename="gio/gunixmounts.c" + line="2458">a #GUnixMount. @@ -141080,21 +140822,20 @@ This will return %NULL if looking up the mount entry fails, if Gets the mount path for a unix mount. - + filename="gio/gunixmounts.c" + line="2401">Gets the mount path for a unix mount. + the mount path for @mount_entry. + filename="gio/gunixmounts.c" + line="2407">the mount path for @mount_entry. input #GUnixMountEntry to get the mount path for. + filename="gio/gunixmounts.c" + line="2403">input #GUnixMountEntry to get the mount path for. @@ -141103,26 +140844,25 @@ This will return %NULL if looking up the mount entry fails, if c:identifier="g_unix_mount_get_options" version="2.58"> Gets a comma-separated list of mount options for the unix mount. For example, + filename="gio/gunixmounts.c" + line="2472">Gets a comma-separated list of mount options for the unix mount. For example, `rw,relatime,seclabel,data=ordered`. This is similar to g_unix_mount_point_get_options(), but it takes a #GUnixMountEntry as an argument. - + a string containing the options, or %NULL if not + filename="gio/gunixmounts.c" + line="2482">a string containing the options, or %NULL if not available. a #GUnixMountEntry. + filename="gio/gunixmounts.c" + line="2474">a #GUnixMountEntry. @@ -141131,26 +140871,25 @@ available. c:identifier="g_unix_mount_get_root_path" version="2.60"> Gets the root of the mount within the filesystem. This is useful e.g. for + filename="gio/gunixmounts.c" + line="2433">Gets the root of the mount within the filesystem. This is useful e.g. for mounts created by bind operation, or btrfs subvolumes. For example, the root path is equal to "/" for mount created by "mount /dev/sda1 /mnt/foo" and "/bar" for "mount --bind /mnt/foo/bar /mnt/bar". - + a string containing the root, or %NULL if not supported. + filename="gio/gunixmounts.c" + line="2444">a string containing the root, or %NULL if not supported. a #GUnixMountEntry. + filename="gio/gunixmounts.c" + line="2435">a #GUnixMountEntry. @@ -141158,21 +140897,20 @@ For example, the root path is equal to "/" for mount created by Guesses whether a Unix mount can be ejected. - + filename="gio/gunixmounts.c" + line="2987">Guesses whether a Unix mount can be ejected. + %TRUE if @mount_entry is deemed to be ejectable. + filename="gio/gunixmounts.c" + line="2993">%TRUE if @mount_entry is deemed to be ejectable. a #GUnixMountEntry + filename="gio/gunixmounts.c" + line="2989">a #GUnixMountEntry @@ -141180,21 +140918,20 @@ For example, the root path is equal to "/" for mount created by Guesses the icon of a Unix mount. - + filename="gio/gunixmounts.c" + line="2904">Guesses the icon of a Unix mount. + a #GIcon + filename="gio/gunixmounts.c" + line="2910">a #GIcon a #GUnixMountEntry + filename="gio/gunixmounts.c" + line="2906">a #GUnixMountEntry @@ -141202,23 +140939,22 @@ For example, the root path is equal to "/" for mount created by Guesses the name of a Unix mount. + filename="gio/gunixmounts.c" + line="2881">Guesses the name of a Unix mount. The result is a translated string. - + A newly allocated string that must + filename="gio/gunixmounts.c" + line="2888">A newly allocated string that must be freed with g_free() a #GUnixMountEntry + filename="gio/gunixmounts.c" + line="2883">a #GUnixMountEntry @@ -141226,21 +140962,20 @@ The result is a translated string. Guesses whether a Unix mount should be displayed in the UI. - + filename="gio/gunixmounts.c" + line="3008">Guesses whether a Unix mount should be displayed in the UI. + %TRUE if @mount_entry is deemed to be displayable. + filename="gio/gunixmounts.c" + line="3014">%TRUE if @mount_entry is deemed to be displayable. a #GUnixMountEntry + filename="gio/gunixmounts.c" + line="3010">a #GUnixMountEntry @@ -141249,21 +140984,20 @@ The result is a translated string. c:identifier="g_unix_mount_guess_symbolic_icon" version="2.34"> Guesses the symbolic icon of a Unix mount. - + filename="gio/gunixmounts.c" + line="2918">Guesses the symbolic icon of a Unix mount. + a #GIcon + filename="gio/gunixmounts.c" + line="2924">a #GIcon a #GUnixMountEntry + filename="gio/gunixmounts.c" + line="2920">a #GUnixMountEntry @@ -141271,21 +141005,20 @@ The result is a translated string. Checks if a unix mount is mounted read only. - + filename="gio/gunixmounts.c" + line="2495">Checks if a unix mount is mounted read only. + %TRUE if @mount_entry is read only. + filename="gio/gunixmounts.c" + line="2501">%TRUE if @mount_entry is read only. a #GUnixMount. + filename="gio/gunixmounts.c" + line="2497">a #GUnixMount. @@ -141293,26 +141026,25 @@ The result is a translated string. Checks if a Unix mount is a system mount. This is the Boolean OR of + filename="gio/gunixmounts.c" + line="2511">Checks if a Unix mount is a system mount. This is the Boolean OR of g_unix_is_system_fs_type(), g_unix_is_system_device_path() and g_unix_is_mount_path_system_internal() on @mount_entry’s properties. The definition of what a ‘system’ mount entry is may change over time as new file system types and device paths are ignored. - + %TRUE if the unix mount is for a system path. + filename="gio/gunixmounts.c" + line="2522">%TRUE if the unix mount is for a system path. a #GUnixMount. + filename="gio/gunixmounts.c" + line="2513">a #GUnixMount. @@ -141322,27 +141054,26 @@ file system types and device paths are ignored. moved-to="UnixMountPoint.at" version="2.66"> Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it + filename="gio/gunixmounts.c" + line="1727">Gets a #GUnixMountPoint for a given mount path. If @time_read is set, it will be filled with a unix timestamp for checking if the mount points have changed since with g_unix_mount_points_changed_since(). If more mount points have the same mount path, the last matching mount point is returned. - + a #GUnixMountPoint, or %NULL if no match + filename="gio/gunixmounts.c" + line="1739">a #GUnixMountPoint, or %NULL if no match is found. path for a possible unix mount point. + filename="gio/gunixmounts.c" + line="1729">path for a possible unix mount point. optional="1" allow-none="1"> guint64 to contain a timestamp. + filename="gio/gunixmounts.c" + line="1730">guint64 to contain a timestamp. @@ -141361,21 +141092,20 @@ is found. Checks if the unix mount points have changed since a given unix time. - + filename="gio/gunixmounts.c" + line="1787">Checks if the unix mount points have changed since a given unix time. + %TRUE if the mount points have changed since @time. + filename="gio/gunixmounts.c" + line="1793">%TRUE if the mount points have changed since @time. guint64 to contain a timestamp. + filename="gio/gunixmounts.c" + line="1789">guint64 to contain a timestamp. @@ -141383,17 +141113,16 @@ is found. Gets a #GList of #GUnixMountPoint containing the unix mount points. + filename="gio/gunixmounts.c" + line="1687">Gets a #GList of #GUnixMountPoint containing the unix mount points. If @time_read is set, it will be filled with the mount timestamp, allowing for checking if the mounts have changed with g_unix_mount_points_changed_since(). - + + filename="gio/gunixmounts.c" + line="1696"> a #GList of the UNIX mountpoints. @@ -141407,8 +141136,8 @@ g_unix_mount_points_changed_since(). optional="1" allow-none="1"> guint64 to contain a timestamp. + filename="gio/gunixmounts.c" + line="1689">guint64 to contain a timestamp. @@ -141416,38 +141145,36 @@ g_unix_mount_points_changed_since(). Checks if the unix mounts have changed since a given unix time. - + filename="gio/gunixmounts.c" + line="1773">Checks if the unix mounts have changed since a given unix time. + %TRUE if the mounts have changed since @time. + filename="gio/gunixmounts.c" + line="1779">%TRUE if the mounts have changed since @time. guint64 to contain a timestamp. + filename="gio/gunixmounts.c" + line="1775">guint64 to contain a timestamp. Gets a #GList of #GUnixMountEntry containing the unix mounts. + filename="gio/gunixmounts.c" + line="1570">Gets a #GList of #GUnixMountEntry containing the unix mounts. If @time_read is set, it will be filled with the mount timestamp, allowing for checking if the mounts have changed with g_unix_mounts_changed_since(). - + + filename="gio/gunixmounts.c" + line="1579"> a #GList of the UNIX mounts. @@ -141461,8 +141188,8 @@ with g_unix_mounts_changed_since(). optional="1" allow-none="1"> guint64 to contain a timestamp, or %NULL + filename="gio/gunixmounts.c" + line="1572">guint64 to contain a timestamp, or %NULL diff --git a/girs/GioUnix-2.0.gir b/girs/GioUnix-2.0.gir index 2d600d722..19ce17b0b 100644 --- a/girs/GioUnix-2.0.gir +++ b/girs/GioUnix-2.0.gir @@ -1057,6 +1057,10 @@ handlers with URI schemes. + Virtual method for + g_desktop_app_info_lookup_get_default_for_uri_scheme(). @@ -1434,6 +1438,9 @@ file or the `GioUnix-2.0` GIR namespace when using it. + Gets the underlying file descriptor. @@ -1834,7 +1841,7 @@ This corresponds roughly to a mtab entry. deprecated-version="2.44"> Deprecated alias for g_unix_mount_monitor_get(). + line="2242">Deprecated alias for g_unix_mount_monitor_get(). This function was never a true constructor, which is why it was renamed. @@ -1843,7 +1850,7 @@ renamed. a #GUnixMountMonitor. + line="2250">a #GUnixMountMonitor. @@ -1852,7 +1859,7 @@ renamed. version="2.44"> Gets the #GUnixMountMonitor for the current thread-default main + line="2216">Gets the #GUnixMountMonitor for the current thread-default main context. The mount monitor can be used to monitor for changes to the list of @@ -1865,7 +1872,7 @@ the same main context as you called this function. the #GUnixMountMonitor. + line="2229">the #GUnixMountMonitor. @@ -1876,7 +1883,7 @@ the same main context as you called this function. deprecated-version="2.44"> This function does nothing. + line="2192">This function does nothing. Before 2.44, this was a partially-effective way of controlling the rate at which events would be reported under some uncommon @@ -1892,13 +1899,13 @@ the monitor. a #GUnixMountMonitor + line="2194">a #GUnixMountMonitor a integer with the limit in milliseconds to + line="2195">a integer with the limit in milliseconds to poll for changes. @@ -1907,7 +1914,7 @@ the monitor. Emitted when the unix mount points have changed. + line="2171">Emitted when the unix mount points have changed. @@ -1915,7 +1922,7 @@ the monitor. Emitted when the unix mounts have changed. + line="2156">Emitted when the unix mounts have changed. @@ -1979,12 +1986,12 @@ is found. Compares two unix mount points. + line="2533">Compares two unix mount points. 1, 0 or -1 if @mount1 is greater than, equal to, + line="2540">1, 0 or -1 if @mount1 is greater than, equal to, or less than @mount2, respectively. @@ -1992,13 +1999,13 @@ or less than @mount2, respectively. a #GUnixMount. + line="2535">a #GUnixMount. a #GUnixMount. + line="2536">a #GUnixMount. @@ -2008,19 +2015,19 @@ or less than @mount2, respectively. version="2.54"> Makes a copy of @mount_point. + line="2327">Makes a copy of @mount_point. a new #GUnixMountPoint + line="2333">a new #GUnixMountPoint a #GUnixMountPoint. + line="2329">a #GUnixMountPoint. @@ -2028,7 +2035,7 @@ or less than @mount2, respectively. Frees a unix mount point. + line="2309">Frees a unix mount point. @@ -2037,7 +2044,7 @@ or less than @mount2, respectively. unix mount point to free. + line="2311">unix mount point to free. @@ -2046,19 +2053,19 @@ or less than @mount2, respectively. c:identifier="g_unix_mount_point_get_device_path"> Gets the device path for a unix mount point. + line="2598">Gets the device path for a unix mount point. a string containing the device path. + line="2604">a string containing the device path. a #GUnixMountPoint. + line="2600">a #GUnixMountPoint. @@ -2067,19 +2074,19 @@ or less than @mount2, respectively. c:identifier="g_unix_mount_point_get_fs_type"> Gets the file system type for the mount point. + line="2614">Gets the file system type for the mount point. a string containing the file system type. + line="2620">a string containing the file system type. a #GUnixMountPoint. + line="2616">a #GUnixMountPoint. @@ -2088,19 +2095,19 @@ or less than @mount2, respectively. c:identifier="g_unix_mount_point_get_mount_path"> Gets the mount path for a unix mount point. + line="2582">Gets the mount path for a unix mount point. a string containing the mount path. + line="2588">a string containing the mount path. a #GUnixMountPoint. + line="2584">a #GUnixMountPoint. @@ -2110,19 +2117,19 @@ or less than @mount2, respectively. version="2.32"> Gets the options for the mount point. + line="2630">Gets the options for the mount point. a string containing the options. + line="2636">a string containing the options. a #GUnixMountPoint. + line="2632">a #GUnixMountPoint. @@ -2131,19 +2138,19 @@ or less than @mount2, respectively. c:identifier="g_unix_mount_point_guess_can_eject"> Guesses whether a Unix mount point can be ejected. + line="3095">Guesses whether a Unix mount point can be ejected. %TRUE if @mount_point is deemed to be ejectable. + line="3101">%TRUE if @mount_point is deemed to be ejectable. a #GUnixMountPoint + line="3097">a #GUnixMountPoint @@ -2151,19 +2158,19 @@ or less than @mount2, respectively. Guesses the icon of a Unix mount point. + line="2957">Guesses the icon of a Unix mount point. a #GIcon + line="2963">a #GIcon a #GUnixMountPoint + line="2959">a #GUnixMountPoint @@ -2171,13 +2178,13 @@ or less than @mount2, respectively. Guesses the name of a Unix mount point. + line="2934">Guesses the name of a Unix mount point. The result is a translated string. A newly allocated string that must + line="2941">A newly allocated string that must be freed with g_free() @@ -2185,7 +2192,7 @@ The result is a translated string. a #GUnixMountPoint + line="2936">a #GUnixMountPoint @@ -2195,19 +2202,19 @@ The result is a translated string. version="2.34"> Guesses the symbolic icon of a Unix mount point. + line="2971">Guesses the symbolic icon of a Unix mount point. a #GIcon + line="2977">a #GIcon a #GUnixMountPoint + line="2973">a #GUnixMountPoint @@ -2216,19 +2223,19 @@ The result is a translated string. c:identifier="g_unix_mount_point_is_loopback"> Checks if a unix mount point is a loopback device. + line="2680">Checks if a unix mount point is a loopback device. %TRUE if the mount point is a loopback. %FALSE otherwise. + line="2686">%TRUE if the mount point is a loopback. %FALSE otherwise. a #GUnixMountPoint. + line="2682">a #GUnixMountPoint. @@ -2237,19 +2244,19 @@ The result is a translated string. c:identifier="g_unix_mount_point_is_readonly"> Checks if a unix mount point is read only. + line="2648">Checks if a unix mount point is read only. %TRUE if a mount point is read only. + line="2654">%TRUE if a mount point is read only. a #GUnixMountPoint. + line="2650">a #GUnixMountPoint. @@ -2258,19 +2265,19 @@ The result is a translated string. c:identifier="g_unix_mount_point_is_user_mountable"> Checks if a unix mount point is mountable by the user. + line="2664">Checks if a unix mount point is mountable by the user. %TRUE if the mount point is user mountable. + line="2670">%TRUE if the mount point is user mountable. a #GUnixMountPoint. + line="2666">a #GUnixMountPoint. @@ -2694,12 +2701,12 @@ This will return %NULL if there is no mount point at @mount_path. Compares two unix mounts. + line="2356">Compares two unix mounts. 1, 0 or -1 if @mount1 is greater than, equal to, + line="2363">1, 0 or -1 if @mount1 is greater than, equal to, or less than @mount2, respectively. @@ -2707,13 +2714,13 @@ or less than @mount2, respectively. first #GUnixMountEntry to compare. + line="2358">first #GUnixMountEntry to compare. second #GUnixMountEntry to compare. + line="2359">second #GUnixMountEntry to compare. @@ -2723,19 +2730,19 @@ or less than @mount2, respectively. version="2.54"> Makes a copy of @mount_entry. + line="2280">Makes a copy of @mount_entry. a new #GUnixMountEntry + line="2286">a new #GUnixMountEntry a #GUnixMountEntry. + line="2282">a #GUnixMountEntry. @@ -2782,7 +2789,7 @@ This will return %NULL if looking up the mount entry fails, if Frees a unix mount. + line="2261">Frees a unix mount. @@ -2791,7 +2798,7 @@ This will return %NULL if looking up the mount entry fails, if a #GUnixMountEntry. + line="2263">a #GUnixMountEntry. @@ -2800,19 +2807,19 @@ This will return %NULL if looking up the mount entry fails, if c:identifier="g_unix_mount_get_device_path"> Gets the device path for a unix mount. + line="2417">Gets the device path for a unix mount. a string containing the device path. + line="2423">a string containing the device path. a #GUnixMount. + line="2419">a #GUnixMount. @@ -2820,19 +2827,19 @@ This will return %NULL if looking up the mount entry fails, if Gets the filesystem type for the unix mount. + line="2456">Gets the filesystem type for the unix mount. a string containing the file system type. + line="2462">a string containing the file system type. a #GUnixMount. + line="2458">a #GUnixMount. @@ -2841,19 +2848,19 @@ This will return %NULL if looking up the mount entry fails, if c:identifier="g_unix_mount_get_mount_path"> Gets the mount path for a unix mount. + line="2401">Gets the mount path for a unix mount. the mount path for @mount_entry. + line="2407">the mount path for @mount_entry. input #GUnixMountEntry to get the mount path for. + line="2403">input #GUnixMountEntry to get the mount path for. @@ -2863,7 +2870,7 @@ This will return %NULL if looking up the mount entry fails, if version="2.58"> Gets a comma-separated list of mount options for the unix mount. For example, + line="2472">Gets a comma-separated list of mount options for the unix mount. For example, `rw,relatime,seclabel,data=ordered`. This is similar to g_unix_mount_point_get_options(), but it takes @@ -2872,7 +2879,7 @@ a #GUnixMountEntry as an argument. a string containing the options, or %NULL if not + line="2482">a string containing the options, or %NULL if not available. @@ -2880,7 +2887,7 @@ available. a #GUnixMountEntry. + line="2474">a #GUnixMountEntry. @@ -2890,7 +2897,7 @@ available. version="2.60"> Gets the root of the mount within the filesystem. This is useful e.g. for + line="2433">Gets the root of the mount within the filesystem. This is useful e.g. for mounts created by bind operation, or btrfs subvolumes. For example, the root path is equal to "/" for mount created by @@ -2900,14 +2907,14 @@ For example, the root path is equal to "/" for mount created by a string containing the root, or %NULL if not supported. + line="2444">a string containing the root, or %NULL if not supported. a #GUnixMountEntry. + line="2435">a #GUnixMountEntry. @@ -2916,19 +2923,19 @@ For example, the root path is equal to "/" for mount created by c:identifier="g_unix_mount_guess_can_eject"> Guesses whether a Unix mount can be ejected. + line="2987">Guesses whether a Unix mount can be ejected. %TRUE if @mount_entry is deemed to be ejectable. + line="2993">%TRUE if @mount_entry is deemed to be ejectable. a #GUnixMountEntry + line="2989">a #GUnixMountEntry @@ -2936,19 +2943,19 @@ For example, the root path is equal to "/" for mount created by Guesses the icon of a Unix mount. + line="2904">Guesses the icon of a Unix mount. a #GIcon + line="2910">a #GIcon a #GUnixMountEntry + line="2906">a #GUnixMountEntry @@ -2956,13 +2963,13 @@ For example, the root path is equal to "/" for mount created by Guesses the name of a Unix mount. + line="2881">Guesses the name of a Unix mount. The result is a translated string. A newly allocated string that must + line="2888">A newly allocated string that must be freed with g_free() @@ -2970,7 +2977,7 @@ The result is a translated string. a #GUnixMountEntry + line="2883">a #GUnixMountEntry @@ -2979,19 +2986,19 @@ The result is a translated string. c:identifier="g_unix_mount_guess_should_display"> Guesses whether a Unix mount should be displayed in the UI. + line="3008">Guesses whether a Unix mount should be displayed in the UI. %TRUE if @mount_entry is deemed to be displayable. + line="3014">%TRUE if @mount_entry is deemed to be displayable. a #GUnixMountEntry + line="3010">a #GUnixMountEntry @@ -3001,19 +3008,19 @@ The result is a translated string. version="2.34"> Guesses the symbolic icon of a Unix mount. + line="2918">Guesses the symbolic icon of a Unix mount. a #GIcon + line="2924">a #GIcon a #GUnixMountEntry + line="2920">a #GUnixMountEntry @@ -3021,19 +3028,19 @@ The result is a translated string. Checks if a unix mount is mounted read only. + line="2495">Checks if a unix mount is mounted read only. %TRUE if @mount_entry is read only. + line="2501">%TRUE if @mount_entry is read only. a #GUnixMount. + line="2497">a #GUnixMount. @@ -3042,7 +3049,7 @@ The result is a translated string. c:identifier="g_unix_mount_is_system_internal"> Checks if a Unix mount is a system mount. This is the Boolean OR of + line="2511">Checks if a Unix mount is a system mount. This is the Boolean OR of g_unix_is_system_fs_type(), g_unix_is_system_device_path() and g_unix_is_mount_path_system_internal() on @mount_entry’s properties. @@ -3052,14 +3059,14 @@ file system types and device paths are ignored. %TRUE if the unix mount is for a system path. + line="2522">%TRUE if the unix mount is for a system path. a #GUnixMount. + line="2513">a #GUnixMount. @@ -3109,12 +3116,12 @@ is found. moved-to="MountPoint.compare"> Compares two unix mount points. + line="2533">Compares two unix mount points. 1, 0 or -1 if @mount1 is greater than, equal to, + line="2540">1, 0 or -1 if @mount1 is greater than, equal to, or less than @mount2, respectively. @@ -3122,13 +3129,13 @@ or less than @mount2, respectively. a #GUnixMount. + line="2535">a #GUnixMount. a #GUnixMount. + line="2536">a #GUnixMount. @@ -3139,19 +3146,19 @@ or less than @mount2, respectively. version="2.54"> Makes a copy of @mount_point. + line="2327">Makes a copy of @mount_point. a new #GUnixMountPoint + line="2333">a new #GUnixMountPoint a #GUnixMountPoint. + line="2329">a #GUnixMountPoint. @@ -3161,7 +3168,7 @@ or less than @mount2, respectively. moved-to="MountPoint.free"> Frees a unix mount point. + line="2309">Frees a unix mount point. @@ -3170,7 +3177,7 @@ or less than @mount2, respectively. unix mount point to free. + line="2311">unix mount point to free. @@ -3180,19 +3187,19 @@ or less than @mount2, respectively. moved-to="MountPoint.get_device_path"> Gets the device path for a unix mount point. + line="2598">Gets the device path for a unix mount point. a string containing the device path. + line="2604">a string containing the device path. a #GUnixMountPoint. + line="2600">a #GUnixMountPoint. @@ -3202,19 +3209,19 @@ or less than @mount2, respectively. moved-to="MountPoint.get_fs_type"> Gets the file system type for the mount point. + line="2614">Gets the file system type for the mount point. a string containing the file system type. + line="2620">a string containing the file system type. a #GUnixMountPoint. + line="2616">a #GUnixMountPoint. @@ -3224,19 +3231,19 @@ or less than @mount2, respectively. moved-to="MountPoint.get_mount_path"> Gets the mount path for a unix mount point. + line="2582">Gets the mount path for a unix mount point. a string containing the mount path. + line="2588">a string containing the mount path. a #GUnixMountPoint. + line="2584">a #GUnixMountPoint. @@ -3247,19 +3254,19 @@ or less than @mount2, respectively. version="2.32"> Gets the options for the mount point. + line="2630">Gets the options for the mount point. a string containing the options. + line="2636">a string containing the options. a #GUnixMountPoint. + line="2632">a #GUnixMountPoint. @@ -3269,19 +3276,19 @@ or less than @mount2, respectively. moved-to="MountPoint.guess_can_eject"> Guesses whether a Unix mount point can be ejected. + line="3095">Guesses whether a Unix mount point can be ejected. %TRUE if @mount_point is deemed to be ejectable. + line="3101">%TRUE if @mount_point is deemed to be ejectable. a #GUnixMountPoint + line="3097">a #GUnixMountPoint @@ -3291,19 +3298,19 @@ or less than @mount2, respectively. moved-to="MountPoint.guess_icon"> Guesses the icon of a Unix mount point. + line="2957">Guesses the icon of a Unix mount point. a #GIcon + line="2963">a #GIcon a #GUnixMountPoint + line="2959">a #GUnixMountPoint @@ -3313,13 +3320,13 @@ or less than @mount2, respectively. moved-to="MountPoint.guess_name"> Guesses the name of a Unix mount point. + line="2934">Guesses the name of a Unix mount point. The result is a translated string. A newly allocated string that must + line="2941">A newly allocated string that must be freed with g_free() @@ -3327,7 +3334,7 @@ The result is a translated string. a #GUnixMountPoint + line="2936">a #GUnixMountPoint @@ -3338,19 +3345,19 @@ The result is a translated string. version="2.34"> Guesses the symbolic icon of a Unix mount point. + line="2971">Guesses the symbolic icon of a Unix mount point. a #GIcon + line="2977">a #GIcon a #GUnixMountPoint + line="2973">a #GUnixMountPoint @@ -3360,19 +3367,19 @@ The result is a translated string. moved-to="MountPoint.is_loopback"> Checks if a unix mount point is a loopback device. + line="2680">Checks if a unix mount point is a loopback device. %TRUE if the mount point is a loopback. %FALSE otherwise. + line="2686">%TRUE if the mount point is a loopback. %FALSE otherwise. a #GUnixMountPoint. + line="2682">a #GUnixMountPoint. @@ -3382,19 +3389,19 @@ The result is a translated string. moved-to="MountPoint.is_readonly"> Checks if a unix mount point is read only. + line="2648">Checks if a unix mount point is read only. %TRUE if a mount point is read only. + line="2654">%TRUE if a mount point is read only. a #GUnixMountPoint. + line="2650">a #GUnixMountPoint. @@ -3404,19 +3411,19 @@ The result is a translated string. moved-to="MountPoint.is_user_mountable"> Checks if a unix mount point is mountable by the user. + line="2664">Checks if a unix mount point is mountable by the user. %TRUE if the mount point is user mountable. + line="2670">%TRUE if the mount point is user mountable. a #GUnixMountPoint. + line="2666">a #GUnixMountPoint. diff --git a/girs/Gitg-1.0.gir b/girs/Gitg-1.0.gir index 1257aa1c4..2c409c3e5 100644 --- a/girs/Gitg-1.0.gir +++ b/girs/Gitg-1.0.gir @@ -1,5 +1,5 @@ - + diff --git a/girs/GitgExt-1.0.gir b/girs/GitgExt-1.0.gir index 8e9383f7f..518faaca1 100644 --- a/girs/GitgExt-1.0.gir +++ b/girs/GitgExt-1.0.gir @@ -1,5 +1,5 @@ - + diff --git a/girs/Gkbd-3.0.gir b/girs/Gkbd-3.0.gir index ac565fdef..6fbae5d2d 100644 --- a/girs/Gkbd-3.0.gir +++ b/girs/Gkbd-3.0.gir @@ -22,10 +22,11 @@ and/or use gtk-doc annotations. --> glib:type-name="GkbdConfiguration" glib:get-type="gkbd_configuration_get_type" glib:type-struct="ConfigurationClass"> - + - + @@ -45,17 +46,19 @@ and/or use gtk-doc annotations. --> - + singleton of GkbdConfiguration - + @@ -70,7 +73,8 @@ and/or use gtk-doc annotations. --> - + @@ -84,7 +88,8 @@ and/or use gtk-doc annotations. --> - + @@ -94,7 +99,7 @@ and/or use gtk-doc annotations. --> list of images @@ -104,10 +109,11 @@ and/or use gtk-doc annotations. --> - + list of widgets/status icons/... @@ -121,7 +127,8 @@ and/or use gtk-doc annotations. --> - + @@ -133,7 +140,8 @@ and/or use gtk-doc annotations. --> - + @@ -145,7 +153,8 @@ and/or use gtk-doc annotations. --> - + @@ -157,10 +166,11 @@ and/or use gtk-doc annotations. --> - + group name @@ -175,10 +185,11 @@ and/or use gtk-doc annotations. --> - + full group names @@ -192,7 +203,8 @@ and/or use gtk-doc annotations. --> - + @@ -207,10 +219,11 @@ and/or use gtk-doc annotations. --> - + indicator config @@ -222,10 +235,11 @@ and/or use gtk-doc annotations. --> - + keyboard config @@ -237,7 +251,8 @@ and/or use gtk-doc annotations. --> - + @@ -249,7 +264,8 @@ and/or use gtk-doc annotations. --> - + @@ -261,10 +277,11 @@ and/or use gtk-doc annotations. --> - + short group names @@ -278,10 +295,11 @@ and/or use gtk-doc annotations. --> - + The engine used by GkbdConfiguration object @@ -293,7 +311,8 @@ and/or use gtk-doc annotations. --> - + @@ -305,7 +324,8 @@ and/or use gtk-doc annotations. --> - + @@ -316,10 +336,11 @@ and/or use gtk-doc annotations. --> - + list of images @@ -332,7 +353,8 @@ and/or use gtk-doc annotations. --> - + @@ -347,7 +369,8 @@ and/or use gtk-doc annotations. --> - + @@ -359,7 +382,8 @@ and/or use gtk-doc annotations. --> - + @@ -374,7 +398,8 @@ and/or use gtk-doc annotations. --> - + @@ -385,7 +410,8 @@ and/or use gtk-doc annotations. --> - + @@ -422,7 +448,7 @@ and/or use gtk-doc annotations. --> - + @@ -430,11 +456,11 @@ and/or use gtk-doc annotations. --> - + - + @@ -460,7 +486,8 @@ and/or use gtk-doc annotations. --> - + @@ -471,7 +498,8 @@ and/or use gtk-doc annotations. --> - + @@ -485,7 +513,8 @@ and/or use gtk-doc annotations. --> - + @@ -497,7 +526,8 @@ and/or use gtk-doc annotations. --> - + @@ -524,7 +554,8 @@ and/or use gtk-doc annotations. --> - + @@ -536,7 +567,8 @@ and/or use gtk-doc annotations. --> - + @@ -548,7 +580,8 @@ and/or use gtk-doc annotations. --> - + @@ -559,7 +592,8 @@ and/or use gtk-doc annotations. --> - + @@ -571,7 +605,8 @@ and/or use gtk-doc annotations. --> - + @@ -584,7 +619,7 @@ and/or use gtk-doc annotations. --> scope="notified" closure="1"> a function to call when settings are changed @@ -598,7 +633,8 @@ and/or use gtk-doc annotations. --> - + @@ -609,7 +645,8 @@ and/or use gtk-doc annotations. --> - + @@ -623,7 +660,8 @@ and/or use gtk-doc annotations. --> - + @@ -632,7 +670,7 @@ and/or use gtk-doc annotations. --> - + @@ -641,7 +679,7 @@ and/or use gtk-doc annotations. --> - + @@ -654,21 +692,21 @@ and/or use gtk-doc annotations. --> glib:type-name="GkbdIndicator" glib:get-type="gkbd_indicator_get_type" glib:type-struct="IndicatorClass"> - + - + - + List of group names @@ -677,7 +715,7 @@ and/or use gtk-doc annotations. --> - + @@ -689,23 +727,23 @@ and/or use gtk-doc annotations. --> - + - + The engine shared by all GkbdIndicator objects - + @@ -716,7 +754,7 @@ and/or use gtk-doc annotations. --> - + @@ -727,7 +765,7 @@ and/or use gtk-doc annotations. --> - + @@ -742,7 +780,7 @@ and/or use gtk-doc annotations. --> - + @@ -767,13 +805,13 @@ and/or use gtk-doc annotations. --> - + - + @@ -786,7 +824,8 @@ and/or use gtk-doc annotations. --> - + @@ -823,7 +862,8 @@ and/or use gtk-doc annotations. --> - + @@ -835,7 +875,8 @@ and/or use gtk-doc annotations. --> - + @@ -847,7 +888,8 @@ and/or use gtk-doc annotations. --> - + @@ -862,7 +904,8 @@ and/or use gtk-doc annotations. --> - + @@ -883,7 +926,8 @@ and/or use gtk-doc annotations. --> - + @@ -900,7 +944,8 @@ and/or use gtk-doc annotations. --> - + @@ -914,7 +959,8 @@ and/or use gtk-doc annotations. --> - + @@ -926,7 +972,8 @@ and/or use gtk-doc annotations. --> - + @@ -941,7 +988,8 @@ and/or use gtk-doc annotations. --> - + @@ -952,7 +1000,8 @@ and/or use gtk-doc annotations. --> - + @@ -964,7 +1013,8 @@ and/or use gtk-doc annotations. --> - + @@ -977,7 +1027,7 @@ and/or use gtk-doc annotations. --> scope="notified" closure="1"> a function to call when settings are changed @@ -991,7 +1041,8 @@ and/or use gtk-doc annotations. --> - + @@ -1002,7 +1053,8 @@ and/or use gtk-doc annotations. --> - + @@ -1016,7 +1068,8 @@ and/or use gtk-doc annotations. --> - + @@ -1025,7 +1078,8 @@ and/or use gtk-doc annotations. --> - + @@ -1034,17 +1088,20 @@ and/or use gtk-doc annotations. --> - + - + - + @@ -1064,7 +1121,8 @@ and/or use gtk-doc annotations. --> - + @@ -1075,7 +1133,8 @@ and/or use gtk-doc annotations. --> - + @@ -1089,7 +1148,8 @@ and/or use gtk-doc annotations. --> - + @@ -1103,7 +1163,8 @@ and/or use gtk-doc annotations. --> - + @@ -1118,7 +1179,8 @@ and/or use gtk-doc annotations. --> - + @@ -1133,7 +1195,8 @@ and/or use gtk-doc annotations. --> - + @@ -1147,7 +1210,8 @@ and/or use gtk-doc annotations. --> - + @@ -1159,7 +1223,8 @@ and/or use gtk-doc annotations. --> - + @@ -1172,7 +1237,7 @@ and/or use gtk-doc annotations. --> scope="notified" closure="1"> a function to call when settings are changed @@ -1186,7 +1251,8 @@ and/or use gtk-doc annotations. --> - + @@ -1197,7 +1263,8 @@ and/or use gtk-doc annotations. --> - + @@ -1208,7 +1275,8 @@ and/or use gtk-doc annotations. --> - + @@ -1220,10 +1288,11 @@ and/or use gtk-doc annotations. --> - + List of options @@ -1243,7 +1312,8 @@ and/or use gtk-doc annotations. --> - + @@ -1258,7 +1328,8 @@ and/or use gtk-doc annotations. --> - + @@ -1285,7 +1356,8 @@ and/or use gtk-doc annotations. --> - + @@ -1300,7 +1372,8 @@ and/or use gtk-doc annotations. --> - + @@ -1324,25 +1397,29 @@ and/or use gtk-doc annotations. --> glib:type-name="GkbdKeyboardDrawing" glib:get-type="gkbd_keyboard_drawing_get_type" glib:type-struct="KeyboardDrawingClass"> - + - + - + - + @@ -1360,7 +1437,8 @@ and/or use gtk-doc annotations. --> - + @@ -1377,7 +1455,8 @@ and/or use gtk-doc annotations. --> - + @@ -1392,7 +1471,8 @@ and/or use gtk-doc annotations. --> - + @@ -1404,7 +1484,8 @@ and/or use gtk-doc annotations. --> - + @@ -1416,7 +1497,8 @@ and/or use gtk-doc annotations. --> - + @@ -1428,7 +1510,8 @@ and/or use gtk-doc annotations. --> - + @@ -1439,7 +1522,8 @@ and/or use gtk-doc annotations. --> - + @@ -1450,7 +1534,8 @@ and/or use gtk-doc annotations. --> - + @@ -1468,57 +1553,58 @@ and/or use gtk-doc annotations. --> Renders a keyboard layout to a cairo_t context. @cr and @layout can be got from e.g. a GtkWidget or a GtkPrintContext. @cr and @layout may be modified by the function but will not be unreffed. - + %TRUE on success, %FALSE on failure keyboard layout to render Cairo context to render to Pango layout to use to render text left coordinate (pixels) of region to render in top coordinate (pixels) of region to render in width (pixels) of region to render in height (pixels) of region to render in @@ -1532,7 +1618,8 @@ by the function but will not be unreffed. - + @@ -1549,7 +1636,8 @@ by the function but will not be unreffed. - + @@ -1564,7 +1652,8 @@ by the function but will not be unreffed. - + @@ -1579,7 +1668,8 @@ by the function but will not be unreffed. - + @@ -1594,7 +1684,8 @@ by the function but will not be unreffed. - + @@ -1677,13 +1768,15 @@ by the function but will not be unreffed. - + - + @@ -1699,7 +1792,8 @@ by the function but will not be unreffed. - + @@ -1725,7 +1819,8 @@ by the function but will not be unreffed. - + @@ -1735,7 +1830,8 @@ by the function but will not be unreffed. - + @@ -1766,7 +1862,8 @@ by the function but will not be unreffed. - + @@ -1786,7 +1883,8 @@ by the function but will not be unreffed. - + @@ -1805,7 +1903,8 @@ by the function but will not be unreffed. - + @@ -1834,7 +1933,8 @@ by the function but will not be unreffed. - + @@ -1860,7 +1960,7 @@ by the function but will not be unreffed. - + @@ -1869,7 +1969,7 @@ by the function but will not be unreffed. - + @@ -1878,7 +1978,7 @@ by the function but will not be unreffed. - + @@ -1891,19 +1991,19 @@ by the function but will not be unreffed. glib:type-name="GkbdStatus" glib:get-type="gkbd_status_get_type" glib:type-struct="StatusClass"> - + - + - + List of group names @@ -1912,7 +2012,7 @@ by the function but will not be unreffed. - + @@ -1924,16 +2024,16 @@ by the function but will not be unreffed. - + The engine shared by all GkbdStatus objects - + @@ -1953,7 +2053,7 @@ by the function but will not be unreffed. - + @@ -1962,11 +2062,11 @@ by the function but will not be unreffed. c:type="GkbdStatusPrivate" disguised="1" opaque="1"> - + - + @@ -1974,10 +2074,11 @@ by the function but will not be unreffed. - + List of options @@ -1998,7 +2099,8 @@ by the function but will not be unreffed. - + @@ -2014,7 +2116,8 @@ by the function but will not be unreffed. - + @@ -2042,7 +2145,8 @@ by the function but will not be unreffed. - + @@ -2058,7 +2162,8 @@ by the function but will not be unreffed. - + @@ -2076,17 +2181,17 @@ by the function but will not be unreffed. - + A rectangle to use - + @@ -2097,10 +2202,10 @@ by the function but will not be unreffed. - + Append string to strv array @@ -2116,7 +2221,7 @@ by the function but will not be unreffed. - + @@ -2127,7 +2232,7 @@ by the function but will not be unreffed. - + diff --git a/girs/GnomeBluetooth-1.0.gir b/girs/GnomeBluetooth-1.0.gir index 2fcc20d57..8e1430074 100644 --- a/girs/GnomeBluetooth-1.0.gir +++ b/girs/GnomeBluetooth-1.0.gir @@ -15,34 +15,95 @@ and/or use gtk-doc annotations. --> shared-library="libgnome-bluetooth.so.13" c:identifier-prefixes="Bluetooth" c:symbol-prefixes="bluetooth"> + + + + + + + + + + + + + + + + + + + + + - A convenience value used to select the first device regardless of its address. + A convenience value used to select the first device regardless of its address. + + + + + + + + + + + + + + + - The category of a Bluetooth devices. + The category of a Bluetooth devices. + - all devices + all devices - paired devices + paired devices - trusted devices + trusted devices - neither paired, nor trusted devices + neither paired, nor trusted devices - paired and/or trusted devices + paired and/or trusted devices glib:type-name="BluetoothChooser" glib:get-type="bluetooth_chooser_get_type" glib:type-struct="ChooserClass"> - The <structname>BluetoothChooser</structname> struct contains + The <structname>BluetoothChooser</structname> struct contains only private fields and should not be directly accessed. + - Returns a new #BluetoothChooser widget. + Returns a new #BluetoothChooser widget. + - A #BluetoothChooser widget + A #BluetoothChooser widget + @@ -78,6 +148,7 @@ only private fields and should not be directly accessed. + @@ -92,154 +163,222 @@ only private fields and should not be directly accessed. - Prints all the known attributes for the currently selected device + Prints all the known attributes for the currently selected device on the standard output. Useful for debugging. + - A #BluetoothChooser widget. + A #BluetoothChooser widget. - Returns the #GtkScrolledWindow object for the #BluetoothChooser. + Returns the #GtkScrolledWindow object for the #BluetoothChooser. This is useful to set a minimum height to the chooser using gtk_scrolled_window_set_min_content_height() or to join the chooser with a toolbar. + - a #GtkScrolledWindow object. + a #GtkScrolledWindow object. - A #BluetoothChooser widget. + A #BluetoothChooser widget. - Returns the Bluetooth address for the currently selected device. + Returns the Bluetooth address for the currently selected device. + - the Bluetooth address for the currently selected device, or %NULL. + the Bluetooth address for the currently selected device, or %NULL. - a #BluetoothChooser widget. + a #BluetoothChooser widget. - Returns the icon name to use to represent the currently selected device. + Returns the icon name to use to represent the currently selected device. + - the icon name to use to represent the currently selected device, or %NULL. + the icon name to use to represent the currently selected device, or %NULL. - a #BluetoothChooser widget. + a #BluetoothChooser widget. - Returns whether the @value has been set. + Returns whether the @value has been set. + - %TRUE if the @value has been set. + %TRUE if the @value has been set. - A #BluetoothChooser widget. + A #BluetoothChooser widget. - The identifier for the field to get data for. + The identifier for the field to get data for. - An empty #GValue to set. + An empty #GValue to set. - Returns whether the selected device is connected to this computer. + Returns whether the selected device is connected to this computer. + - whether the selected device is connected to this computer, + whether the selected device is connected to this computer, will always be %FALSE if no devices are selected. - a #BluetoothChooser widget. + a #BluetoothChooser widget. - Returns the name for the currently selected device. + Returns the name for the currently selected device. + - the name for the currently selected device, or %NULL. + the name for the currently selected device, or %NULL. - a #BluetoothChooser widget. + a #BluetoothChooser widget. - Returns the #BluetoothType of the device selected. + Returns the #BluetoothType of the device selected. + - the #BluetoothType of the device selected, or '0' if unknown. + the #BluetoothType of the device selected, or '0' if unknown. - a #BluetoothChooser widget. + a #BluetoothChooser widget. - Starts a discovery on the default Bluetooth adapter. Note that this will + Starts a discovery on the default Bluetooth adapter. Note that this will only work if the Search label is visible, as otherwise the user has no visual feedback that the process is on-going. See also: #BluetoothChooser:show-searching + - a #BluetoothChooser widget. + a #BluetoothChooser widget. - Stops a discovery started with #bluetooth_chooser_start_discovery. + Stops a discovery started with #bluetooth_chooser_start_discovery. + - a #BluetoothChooser widget. + a #BluetoothChooser widget. @@ -248,82 +387,109 @@ See also: #BluetoothChooser:show-searching introspectable="0" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="BLUETOOTH_CATEGORY_ALL"> - + + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="1"> + transfer-ownership="none" + default-value="TRUE"> - + + transfer-ownership="none" + default-value="TRUE"> + transfer-ownership="none" + default-value="TRUE"> + transfer-ownership="none" + default-value="TRUE"> - + - + - The #BluetoothChooser::selected-device-activated signal is launched when a + The #BluetoothChooser::selected-device-activated signal is launched when a device is double-clicked in the chooser. - the Bluetooth address for the currently selected device, or %NULL + the Bluetooth address for the currently selected device, or %NULL - The #BluetoothChooser::selected-device-changed signal is launched when the + The #BluetoothChooser::selected-device-changed signal is launched when the selected device is changed, it will be %NULL if a device was unselected. - the Bluetooth address for the currently selected device, or %NULL + the Bluetooth address for the currently selected device, or %NULL @@ -336,20 +502,29 @@ selected device is changed, it will be %NULL if a device was unselected. glib:type-name="BluetoothChooserButton" glib:get-type="bluetooth_chooser_button_get_type" glib:type-struct="ChooserButtonClass"> - The <structname>BluetoothChooserButton</structname> struct contains + The <structname>BluetoothChooserButton</structname> struct contains only private fields and should not be directly accessed. + - Returns a new #BluetoothChooserButton widget. + Returns a new #BluetoothChooserButton widget. + - a #BluetoothChooserButton widget. + a #BluetoothChooserButton widget. + @@ -364,14 +539,21 @@ only private fields and should not be directly accessed. - Returns whether there is a powered Bluetooth adapter. + Returns whether there is a powered Bluetooth adapter. + - %TRUE if there is a powered Bluetooth adapter available, and the button should be sensitive. + %TRUE if there is a powered Bluetooth adapter available, and the button should be sensitive. - a #BluetoothChooserButton + a #BluetoothChooserButton @@ -379,18 +561,27 @@ only private fields and should not be directly accessed. - The Bluetooth address of the selected device or %NULL. + transfer-ownership="none" + default-value="NULL"> + The Bluetooth address of the selected device or %NULL. - - %TRUE if there is a powered Bluetooth adapter available. + + %TRUE if there is a powered Bluetooth adapter available. See also: bluetooth_chooser_button_available() - The signal is sent when a popup dialogue is created for the user to select + The signal is sent when a popup dialogue is created for the user to select a device. This signal allows you to change the configuration and filtering of the tree from its defaults. @@ -398,7 +589,9 @@ of the tree from its defaults. - a #BluetoothChooser widget + a #BluetoothChooser widget @@ -407,11 +600,14 @@ of the tree from its defaults. + + @@ -429,11 +625,13 @@ of the tree from its defaults. + + @@ -449,6 +647,7 @@ of the tree from its defaults. + @@ -470,48 +669,41 @@ of the tree from its defaults. glib:type-name="BluetoothChooserCombo" glib:get-type="bluetooth_chooser_combo_get_type" glib:type-struct="ChooserComboClass"> - The <structname>BluetoothChooserCombo</structname> struct contains -only private fields and should not be directly accessed. + - Returns a new #BluetoothChooserCombo widget. + Returns a new #BluetoothChooserCombo widget. + - a #BluetoothChooserCombo widget. + a #BluetoothChooserCombo widget. - - - - - - - - - - - - - - The #BluetoothChooser used in the widget + The #BluetoothChooser used in the widget - - The Bluetooth address of the selected device or %NULL + + The Bluetooth address of the selected device or %NULL - - - - - - - The signal is sent when a popup dialogue is created for the user to select + The signal is sent when a popup dialogue is created for the user to select a device. This signal allows you to change the configuration and filtering of the tree from its defaults. @@ -519,7 +711,9 @@ of the tree from its defaults. - a #BluetoothChooser widget + a #BluetoothChooser widget @@ -528,28 +722,10 @@ of the tree from its defaults. + - - - - - - - - - - - - - - - - - glib:type-name="BluetoothClient" glib:get-type="bluetooth_client_get_type" glib:type-struct="ClientClass"> - The <structname>BluetoothClient</structname> struct contains + The <structname>BluetoothClient</structname> struct contains only private fields and should not be directly accessed. + - Returns a reference to the #BluetoothClient singleton. Use g_object_unref() when done with the object. + Returns a reference to the #BluetoothClient singleton. Use g_object_unref() when done with the object. + - a #BluetoothClient object. + a #BluetoothClient object. - When the connection operation is finished, @callback will be called. You can + When the connection operation is finished, @callback will be called. You can then call bluetooth_client_connect_service_finish() to get the result of the operation. + - a #BluetoothClient + a #BluetoothClient - the object path on which to operate + the object path on which to operate - Whether try to connect or disconnect from services on a device + Whether try to connect or disconnect from services on a device - optional #GCancellable object, %NULL to ignore + optional #GCancellable object, %NULL to ignore allow-none="1" scope="async" closure="4"> - a #GAsyncReadyCallback to call when the connection is complete + a #GAsyncReadyCallback to call when the connection is complete - - the data to pass to callback function + + the data to pass to callback function @@ -613,63 +815,93 @@ operation. - Finishes the connection operation. See bluetooth_client_connect_service(). + Finishes the connection operation. See bluetooth_client_connect_service(). + - %TRUE if the connection operation succeeded, %FALSE otherwise. + %TRUE if the connection operation succeeded, %FALSE otherwise. - a #BluetoothClient + a #BluetoothClient - a #GAsyncResult + a #GAsyncResult - Returns a #GtkTreeModelFilter with only adapters present. + Returns a #GtkTreeModelFilter with only adapters present. + - a #GtkTreeModel object. + a #GtkTreeModel object. - a #BluetoothClient object + a #BluetoothClient object - Returns a #GtkTreeModelFilter with only devices belonging to the default adapter listed. + Returns a #GtkTreeModelFilter with only devices belonging to the default adapter listed. Note that the model will follow a specific adapter, and will not follow the default adapter. Also note that due to the way #GtkTreeModelFilter works, you will probably want to monitor signals on the "child-model" #GtkTreeModel to monitor for changes. + - a #GtkTreeModel object. + a #GtkTreeModel object. - a #BluetoothClient object + a #BluetoothClient object - Returns a #GtkTreeModelFilter of devices filtered using the @func, @data and @destroy arguments to pass to gtk_tree_model_filter_set_visible_func(). + Returns a #GtkTreeModelFilter of devices filtered using the @func, @data and @destroy arguments to pass to gtk_tree_model_filter_set_visible_func(). + - a #GtkTreeModel object. + a #GtkTreeModel object. - a #BluetoothClient object + a #BluetoothClient object scope="notified" closure="1" destroy="2"> - a #GtkTreeModelFilterVisibleFunc + a #GtkTreeModelFilterVisibleFunc - - user data to pass to gtk_tree_model_filter_set_visible_func() + + user data to pass to gtk_tree_model_filter_set_visible_func() - a destroy function for gtk_tree_model_filter_set_visible_func() + a destroy function for gtk_tree_model_filter_set_visible_func() - Returns an unfiltered #GtkTreeModel representing the adapter and devices available on the system. + Returns an unfiltered #GtkTreeModel representing the adapter and devices available on the system. + - a #GtkTreeModel object. + a #GtkTreeModel object. - a #BluetoothClient object + a #BluetoothClient object - - The D-Bus path of the default Bluetooth adapter or %NULL. + + The D-Bus path of the default Bluetooth adapter or %NULL. - %TRUE if the default Bluetooth adapter is discoverable. + transfer-ownership="none" + default-value="FALSE"> + %TRUE if the default Bluetooth adapter is discoverable during discovery. - %TRUE if the default Bluetooth adapter is discovering. + transfer-ownership="none" + default-value="FALSE"> + %TRUE if the default Bluetooth adapter is discovering. - - The name of the default Bluetooth adapter or %NULL. + + The name of the default Bluetooth adapter or %NULL. - - %TRUE if the default Bluetooth adapter is powered. + + %TRUE if the default Bluetooth adapter is powered. - The #BluetoothClient::device-removed signal is launched when a + The #BluetoothClient::device-removed signal is launched when a device gets removed from the model. - the D-Bus object path for the now-removed device + the D-Bus object path for the now-removed device @@ -748,76 +1018,114 @@ device gets removed from the model. + - A column identifier to pass to bluetooth_chooser_get_selected_device_info(). + A column identifier to pass to bluetooth_chooser_get_selected_device_info(). + - a #GDBusProxy object + a #GDBusProxy object - a #GDBusProxy object for DBus.Properties + Used to be #GDBusProxy object for DBus.Properties, now always %NULL - a string representing a Bluetooth address + a string representing a Bluetooth address - a string to use for display (the name of the device, or its address if the name is not known). Only available for devices. + a string to use for display (the name of the device, or its address if the name is not known). Only available for devices. - a string representing the device or adapter's name + a string representing the device or adapter's name - the #BluetoothType of the device. Only available for devices. + the #BluetoothType of the device. Only available for devices. - a string representing the icon name for the device. Only available for devices. + a string representing the icon name for the device. Only available for devices. - whether the adapter is the default one. Only available for adapters. + whether the adapter is the default one. Only available for adapters. - whether the device is paired to its parent adapter. Only available for devices. + whether the device is paired to its parent adapter. Only available for devices. - whether the device is trusted. Only available for devices. + whether the device is trusted. Only available for devices. - whether the device is connected. Only available for devices. + whether the device is connected. Only available for devices. - whether the adapter is discoverable/visible. Only available for adapters. + whether the adapter is discoverable/visible. Only available for adapters. - whether the adapter is discovering. Only available for adapters. + whether the adapter is discovering. Only available for adapters. - whether the device does not support Bluetooth 2.1 Simple Secure Pairing. Only available for devices. + whether the device does not support Bluetooth 2.1 Simple Secure Pairing. Only available for devices. - whether the adapter is powered. Only available for adapters. + whether the adapter is powered. Only available for adapters. - an array of service names and #BluetoothStatus connection statuses. + an array of service names and #BluetoothStatus connection statuses. - a string array of human-readable UUIDs. + a string array of human-readable UUIDs. glib:type-name="BluetoothFilterWidget" glib:get-type="bluetooth_filter_widget_get_type" glib:type-struct="FilterWidgetClass"> + - Creates a new #BluetoothFilterWidget which can be bound to a #BluetoothChooser to + Creates a new #BluetoothFilterWidget which can be bound to a #BluetoothChooser to control filtering of that #BluetoothChooser. Usually used in conjunction with a #BluetoothChooser which has the "has-internal-filter" property set to FALSE. + - A #BluetoothFilterWidget widget + A #BluetoothFilterWidget widget Note: Must call bluetooth_filter_widget_bind_filter () to bind the #BluetoothFilterWidget to a #BluetoothChooser. @@ -845,37 +1159,51 @@ to a #BluetoothChooser. - Binds a #BluetoothFilterWidget to a #BluetoothChooser such that changing the + Binds a #BluetoothFilterWidget to a #BluetoothChooser such that changing the #BluetoothFilterWidget results in filters being applied on the #BluetoothChooser. Any properties set on a bound #BluetoothChooser will also be set on the #BluetoothFilterWidget. + - - a #BluetoothFilterWidget. + + a #BluetoothFilterWidget. - The #BluetoothChooser widget to bind the filter to. + The #BluetoothChooser widget to bind the filter to. - Used to set a different title for the #BluetoothFilterWidget than the default. + Used to set a different title for the #BluetoothFilterWidget than the default. + - - a #BluetoothFilterWidget. + + a #BluetoothFilterWidget. - Title for the #BluetoothFilterWidget. + Title for the #BluetoothFilterWidget. @@ -884,44 +1212,155 @@ Any properties set on a bound #BluetoothChooser will also be set on the introspectable="0" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="BLUETOOTH_CATEGORY_ALL"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="1"> + transfer-ownership="none" + default-value="TRUE"> + transfer-ownership="none" + default-value="TRUE"> - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - The <structname>BluetoothSettingsWidget</structname> struct contains + The <structname>BluetoothSettingsWidget</structname> struct contains only private fields and should not be directly accessed. + - Returns a new #BluetoothSettingsWidget widget. + Returns a new #BluetoothSettingsWidget widget. + - A #BluetoothSettingsWidget widget + A #BluetoothSettingsWidget widget + - Whether the default Bluetooth adapter is powered. + Whether the default Bluetooth adapter is powered. - a #BluetoothSettingsWidget widget. + a #BluetoothSettingsWidget widget. @@ -958,21 +1410,27 @@ only private fields and should not be directly accessed. - The #BluetoothChooser::adapter-status-changed signal is launched when the status + The #BluetoothChooser::adapter-status-changed signal is launched when the status of the adapter changes (powered, available, etc.). - The #BluetoothChooser::panel-changed signal is launched when a + The #BluetoothChooser::panel-changed signal is launched when a link to another settings panel is clicked. - the new panel that the Settings application should now open + the new panel that the Settings application should now open @@ -981,277 +1439,485 @@ link to another settings panel is clicked. + - The connection status of a service on a particular device. Note that @BLUETOOTH_STATUS_CONNECTING and @BLUETOOTH_STATUS_PLAYING might not be available for all services. + The connection status of a service on a particular device. Note that @BLUETOOTH_STATUS_CONNECTING and @BLUETOOTH_STATUS_PLAYING might not be available for all services. + - whether the status has been set yet + whether the status has been set yet - whether the service is disconnected + whether the service is disconnected - whether the service is connected + whether the service is connected - whether the service is connecting + whether the service is connecting - whether the service is playing (only used by the audio service) + whether the service is playing (only used by the audio service) - - Use this value to select any Bluetooth audio device where a #BluetoothType enum is required. + + Use this value to select any Bluetooth audio device where a #BluetoothType enum is required. + - - Use this value to select any Bluetooth input device where a #BluetoothType enum is required. + + Use this value to select any Bluetooth input device where a #BluetoothType enum is required. + - The type of a Bluetooth device. See also %BLUETOOTH_TYPE_INPUT and %BLUETOOTH_TYPE_AUDIO + The type of a Bluetooth device. See also %BLUETOOTH_TYPE_INPUT and %BLUETOOTH_TYPE_AUDIO + - any device, or a device of an unknown type + any device, or a device of an unknown type - a telephone (usually a cell/mobile phone) + a telephone (usually a cell/mobile phone) - a modem + a modem - a computer, can be a laptop, a wearable computer, etc. + a computer, can be a laptop, a wearable computer, etc. - a network device, such as a router + a network device, such as a router - a headset (usually a hands-free device) + a headset (usually a hands-free device) - headphones (covers two ears) + headphones (covers two ears) - another type of audio device + another type of audio device - a keyboard + a keyboard - a mouse + a mouse - a camera (still or moving) + a camera (still or moving) - a printer + a printer - a joypad, joystick, or other game controller + a joypad, joystick, or other game controller - a drawing tablet + a drawing tablet - a video device, such as a webcam + a video device, such as a webcam - a remote control + a remote control - a scanner + a scanner - a display + a display - a wearable computer + a wearable computer - a toy or game + a toy or game + + + audio speaker or speakers + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the type of device corresponding to the given @appearance value, +as usually found in the GAP service. + + + a #BluetoothType. + + + + + a Bluetooth device appearance + + + + + + A tree-like widget used to select Bluetooth devices. + + + A button used to select Bluetooth devices which will pop-up a +#BluetoothChooser widget inside a dialogue when clicked. + + + A combo box used to select Bluetooth devices. + + + The #BluetoothClient object is used to query the state of Bluetooth +devices and adapters. + + + Enumerations related to Bluetooth. + + + Those helper functions are used throughout the Bluetooth +management utilities. + - Returns the type of device corresponding to the given @class value. + Returns the type of device corresponding to the given @class value. + - a #BluetoothType. + a #BluetoothType. - a Bluetooth device class + a Bluetooth device class - Start a GUI application for transfering files over Bluetooth. + Start a GUI application for transfering files over Bluetooth. + - Remote device to use + Remote device to use - Remote device's name + Remote device's name + + Returns a human-readable string representation of @type usable for display to users, +when type filters are displayed. Do not free the return value. +The returned string is already translated with gettext(). + + + a string. + + + + + a #BluetoothType + + + + - Returns a human-readable string representation of @type usable for display to users. Do not free the return value. + Returns a human-readable string representation of @type usable for display to users. Do not free the return value. The returned string is already translated with gettext(). + - a string. + a string. - a #BluetoothType + a #BluetoothType - Returns a string representing a human-readable (but not usable for display to users) version of the @uuid. Do not free the return value. + Returns a string representing a human-readable (but not usable for display to users) version of the @uuid. Do not free the return value. + - a string. + a string. - a string representing a Bluetooth UUID + a string representing a Bluetooth UUID - Returns whether the string is a valid Bluetooth address. This does not contact the device in any way. + Returns whether the string is a valid Bluetooth address. This does not contact the device in any way. + - %TRUE if the address is valid, %FALSE if not. + %TRUE if the address is valid, %FALSE if not. - a string representing a Bluetooth address + a string representing a Bluetooth address diff --git a/girs/GnomeKeyring-1.0.gir b/girs/GnomeKeyring-1.0.gir index 513a747be..59853812f 100644 --- a/girs/GnomeKeyring-1.0.gir +++ b/girs/GnomeKeyring-1.0.gir @@ -14,33 +14,47 @@ and/or use gtk-doc annotations. --> c:identifier-prefixes="GnomeKeyring" c:symbol-prefixes="gnome_keyring"> + - A structure which contains access control information. + A structure which contains access control information. + - Create a new access control for an item. Combine the various access + Create a new access control for an item. Combine the various access rights allowed. Not needed when using libsecret. + - The new #GnomeKeyringAccessControl pointer. Use + The new #GnomeKeyringAccessControl pointer. Use gnome_keyring_access_control_free() to free the memory. - A #GnomeKeyringApplicationRef pointer + A #GnomeKeyringApplicationRef pointer - Access types allowed. + Access types allowed. @@ -48,16 +62,23 @@ gnome_keyring_access_control_free() to free the memory. - Copy an access control for an item. + Copy an access control for an item. Not needed when using libsecret. + - The new #GnomeKeyringAccessControl pointer. Use + The new #GnomeKeyringAccessControl pointer. Use gnome_keyring_access_control_free() to free the memory. - A #GnomeKeyringAccessControl pointer + A #GnomeKeyringAccessControl pointer @@ -65,14 +86,19 @@ gnome_keyring_access_control_free() to free the memory. - Free an access control for an item. + Free an access control for an item. Not needed when using libsecret. + - A #GnomeKeyringAccessControl pointer + A #GnomeKeyringAccessControl pointer @@ -81,60 +107,92 @@ gnome_keyring_access_control_free() to free the memory. - Type of access restriction. + Type of access restriction. No permission prompts are supported. + - Ask permission. + Ask permission. - Deny permission. + Deny permission. - Give permission. + Give permission. - Type of access. + Type of access. libsecret only supports string attributes. + - Read access + Read access - Write access + Write access - Delete access + Delete access + - Create a new application reference. + Create a new application reference. Not needed when using libsecret. + - A new #GnomeKeyringApplicationRef pointer. + A new #GnomeKeyringApplicationRef pointer. - Copy an application reference. + Copy an application reference. Not needed when using libsecret. + - A new #GnomeKeyringApplicationRef pointer. + A new #GnomeKeyringApplicationRef pointer. - A #GnomeKeyringApplicationRef pointer + A #GnomeKeyringApplicationRef pointer @@ -143,14 +201,19 @@ gnome_keyring_access_control_free() to free the memory. - Free an application reference. + Free an application reference. Not needed when using libsecret. + - A #GnomeKeyringApplicationRef pointer + A #GnomeKeyringApplicationRef pointer @@ -162,19 +225,27 @@ gnome_keyring_access_control_free() to free the memory. glib:type-name="GnomeKeyringAttribute" glib:get-type="gnome_keyring_attribute_get_type" c:symbol-prefix="attribute"> - An item attribute. Set <code>string</code> if data type is + An item attribute. Set <code>string</code> if data type is %GNOME_KEYRING_ATTRIBUTE_TYPE_STRING or <code>integer</code> if data type is %GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32 libsecret only supports string attributes. + - The name of the attribute. + The name of the attribute. - The data type. + The data type. + @@ -185,19 +256,26 @@ gnome_keyring_access_control_free() to free the memory. - Return the string value. It is an error to call this method if + Return the string value. It is an error to call this method if @attribute.type is not #GNOME_KEYRING_ATTRIBUTE_TYPE_STRING. This method is mostly useful for language bindings which do not provide union access. In C you should just use attribute->value.string. Not needed when using libsecret. + - The value.string pointer of @attribute. This is + The value.string pointer of @attribute. This is not a copy, do not free. - a #GnomeKeyringAttribute + a #GnomeKeyringAttribute @@ -205,18 +283,25 @@ not a copy, do not free. - Return the uint32 value. It is an error to call this method if + Return the uint32 value. It is an error to call this method if @attribute.type is not #GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32. This method is mostly useful for language bindings which do not provide union access. In C you should just use attribute->value.integer. Not needed when using libsecret. + - The value.integer of @attribute. + The value.integer of @attribute. - a #GnomeKeyringAttribute + a #GnomeKeyringAttribute @@ -224,23 +309,32 @@ you should just use attribute->value.integer. - Store a key-value-pair with a string value in @attributes. + Store a key-value-pair with a string value in @attributes. libsecret stores attributes as a #GHashTable containing string keys and values, use g_hash_table_replace() instead. + - A #GnomeKeyringAttributeList + A #GnomeKeyringAttributeList - The name of the new attribute + The name of the new attribute - The value to store in @attributes + The value to store in @attributes @@ -248,22 +342,31 @@ you should just use attribute->value.integer. - Store a key-value-pair with an unsigned 32bit number value in @attributes. + Store a key-value-pair with an unsigned 32bit number value in @attributes. libsecret does not support number attributes. + - A #GnomeKeyringAttributeList + A #GnomeKeyringAttributeList - The name of the new attribute + The name of the new attribute - The value to store in @attributes + The value to store in @attributes @@ -271,15 +374,22 @@ you should just use attribute->value.integer. - Copy a list of item attributes. + Copy a list of item attributes. Not needed when using libsecret. + - The new #GnomeKeyringAttributeList + The new #GnomeKeyringAttributeList - A #GnomeKeyringAttributeList to copy. + A #GnomeKeyringAttributeList to copy. @@ -287,17 +397,22 @@ you should just use attribute->value.integer. - Free the memory used by @attributes. + Free the memory used by @attributes. If a %NULL pointer is passed, it is ignored. libsecret stores attributes as a #GHashTable containing string keys and values, use g_hash_table_unref() instead. + - A #GnomeKeyringAttributeList + A #GnomeKeyringAttributeList @@ -305,11 +420,16 @@ If a %NULL pointer is passed, it is ignored. - Create a new #GnomeKeyringAttributeList. + Create a new #GnomeKeyringAttributeList. libsecret stores attributes as a #GHashTable containing string keys and values; use g_hash_table_new() instead. + - The new #GnomeKeyringAttributeList + The new #GnomeKeyringAttributeList @@ -317,11 +437,16 @@ If a %NULL pointer is passed, it is ignored. c:identifier="gnome_keyring_attribute_list_to_glist" version="3.4" deprecated="1"> - Create #GList of #GnomeKeyringAttribute pointers from @attributes. This is + Create #GList of #GnomeKeyringAttribute pointers from @attributes. This is mostly useful in language bindings which cannot directly use a #GArray. Not needed when using libsecret. + - #GList + #GList of #GnomeKeyringAttribute. @@ -329,13 +454,16 @@ of #GnomeKeyringAttribute. - A #GnomeKeyringAttributeList + A #GnomeKeyringAttributeList + @@ -345,43 +473,70 @@ of #GnomeKeyringAttribute. c:identifier="GNOME_KEYRING_ATTRIBUTE_TYPE_UINT32"> + + + + + + + - A found structure returned by a found operation. Use gnome_keyring_found_list_free() + A found structure returned by a found operation. Use gnome_keyring_found_list_free() to free a list of these structures. Not used with libsecret. + - The keyring the item was found in. + The keyring the item was found in. - The identifier for the item. + The identifier for the item. - The item's attributes. + The item's attributes. - The item's secret. + The item's secret. - Copy a #GnomeKeyringFound item. + Copy a #GnomeKeyringFound item. Not needed when using libsecret. + - The new #GnomeKeyringFound + The new #GnomeKeyringFound - a #GnomeKeyringFound + a #GnomeKeyringFound @@ -389,17 +544,22 @@ to free a list of these structures. - Free the memory used by a #GnomeKeyringFound item. + Free the memory used by a #GnomeKeyringFound item. You usually want to use gnome_keyring_found_list_free() on the list of results. Deprecated: Not needed when using libsecret. + - a #GnomeKeyringFound + a #GnomeKeyringFound @@ -407,14 +567,19 @@ results. - Free the memory used by the #GnomeKeyringFound items in @found_list. + Free the memory used by the #GnomeKeyringFound items in @found_list. Not needed when using libsecret. + - a #GList of #GnomeKeyringFound + a #GList of #GnomeKeyringFound @@ -425,36 +590,48 @@ results. + + + + - Copy a #GnomeKeyringInfo object. + Copy a #GnomeKeyringInfo object. Use #SecretCollection objects instead. + - The newly allocated #GnomeKeyringInfo. This must be freed with + The newly allocated #GnomeKeyringInfo. This must be freed with gnome_keyring_info_free() - The keyring info to copy. + The keyring info to copy. @@ -462,15 +639,20 @@ gnome_keyring_info_free() - Free a #GnomeKeyringInfo object. If a %NULL pointer is passed + Free a #GnomeKeyringInfo object. If a %NULL pointer is passed nothing occurs. Use #SecretCollection objects instead. + - The keyring info to free. + The keyring info to free. @@ -478,15 +660,22 @@ nothing occurs. - Get the time at which the keyring was created. + Get the time at which the keyring was created. Use secret_collection_get_created() instead. + - The created time. + The created time. - The keyring info. + The keyring info. @@ -494,15 +683,22 @@ nothing occurs. - Get whether the keyring is locked or not. + Get whether the keyring is locked or not. Use secret_collection_get_locked() instead. + - Whether the keyring is locked or not. + Whether the keyring is locked or not. - The keyring info. + The keyring info. @@ -510,17 +706,24 @@ nothing occurs. - Get whether or not to lock a keyring after a certain amount of idle time. + Get whether or not to lock a keyring after a certain amount of idle time. See also gnome_keyring_info_get_lock_timeout(). Not supported when using libsecret. + - Whether to lock or not. + Whether to lock or not. - The keyring info. + The keyring info. @@ -528,17 +731,24 @@ See also gnome_keyring_info_get_lock_timeout(). - Get the idle timeout, in seconds, after which to lock the keyring. + Get the idle timeout, in seconds, after which to lock the keyring. See also gnome_keyring_info_get_lock_on_idle(). Not supported when using libsecret. + - The idle timeout, in seconds. + The idle timeout, in seconds. - The keyring info. + The keyring info. @@ -546,15 +756,22 @@ See also gnome_keyring_info_get_lock_on_idle(). - Get the time at which the keyring was last modified. + Get the time at which the keyring was last modified. Use secret_collection_get_modified() instead. + - The last modified time. + The last modified time. - The keyring info. + The keyring info. @@ -562,20 +779,27 @@ See also gnome_keyring_info_get_lock_on_idle(). - Set whether or not to lock a keyring after a certain amount of idle time. + Set whether or not to lock a keyring after a certain amount of idle time. See also gnome_keyring_info_set_lock_timeout(). Not supported when using libsecret. + - The keyring info. + The keyring info. - Whether to lock or not. + Whether to lock or not. @@ -583,20 +807,27 @@ See also gnome_keyring_info_set_lock_timeout(). - Set the idle timeout, in seconds, after which to lock the keyring. + Set the idle timeout, in seconds, after which to lock the keyring. See also gnome_keyring_info_set_lock_on_idle(). Not supported when using libsecret. + - The keyring info. + The keyring info. - The lock timeout in seconds. + The lock timeout in seconds. @@ -604,32 +835,46 @@ See also gnome_keyring_info_set_lock_on_idle(). + - Create a new #GnomeKeyringItemInfo object. + Create a new #GnomeKeyringItemInfo object. Free the #GnomeKeyringItemInfo object. Use #SecretItem objects instead. + - A keyring item info pointer. + A keyring item info pointer. - Copy a #GnomeKeyringItemInfo object. + Copy a #GnomeKeyringItemInfo object. Use #SecretItem objects instead. + - A keyring item info pointer. + A keyring item info pointer. - A keyring item info pointer. + A keyring item info pointer. @@ -637,16 +882,21 @@ Free the #GnomeKeyringItemInfo object. - Free the #GnomeKeyringItemInfo object. + Free the #GnomeKeyringItemInfo object. A %NULL pointer may be passed, in which case it will be ignored. Use #SecretItem objects instead. + - The keyring item info pointer. + The keyring item info pointer. @@ -654,15 +904,22 @@ A %NULL pointer may be passed, in which case it will be ignored. - Get the item created time. + Get the item created time. Use secret_item_get_created() instead. + - The item created time. + The item created time. - A keyring item info pointer. + A keyring item info pointer. @@ -670,15 +927,22 @@ A %NULL pointer may be passed, in which case it will be ignored. - Get the item display name. + Get the item display name. Use secret_item_get_label() instead. + - The newly allocated string containing the item display name. + The newly allocated string containing the item display name. - A keyring item info pointer. + A keyring item info pointer. @@ -686,15 +950,22 @@ A %NULL pointer may be passed, in which case it will be ignored. - Get the item last modified time. + Get the item last modified time. Use secret_item_get_modified() instead. + - The item last modified time. + The item last modified time. - A keyring item info pointer. + A keyring item info pointer. @@ -702,15 +973,22 @@ A %NULL pointer may be passed, in which case it will be ignored. - Get the item secret. + Get the item secret. Use secret_item_get_secret() instead. + - The newly allocated string containing the item secret. + The newly allocated string containing the item secret. - A keyring item info pointer. + A keyring item info pointer. @@ -718,15 +996,22 @@ A %NULL pointer may be passed, in which case it will be ignored. - Get the item type. + Get the item type. Use secret_item_get_schema_name() instead. + - The item type + The item type - A keyring item info pointer. + A keyring item info pointer. @@ -734,18 +1019,25 @@ A %NULL pointer may be passed, in which case it will be ignored. - Set the display name on an item info. + Set the display name on an item info. Use secret_item_set_label() instead. + - A keyring item info pointer. + A keyring item info pointer. - The new display name. + The new display name. @@ -753,18 +1045,25 @@ A %NULL pointer may be passed, in which case it will be ignored. - Set the secret on an item info. + Set the secret on an item info. Use secret_item_set_secret() instead. + - A keyring item info pointer. + A keyring item info pointer. - The new item secret + The new item secret @@ -772,24 +1071,32 @@ A %NULL pointer may be passed, in which case it will be ignored. - Set the type on an item info. + Set the type on an item info. Use secret_item_set_attributes() instead. + - A keyring item info pointer. + A keyring item info pointer. - The new item type + The new item type + @@ -800,90 +1107,131 @@ A %NULL pointer may be passed, in which case it will be ignored. - The types of items. + The types of items. Use #SecretSchema instead. + - Generic secret + Generic secret - Network password + Network password - Note + Note - Keyring password + Keyring password - Password for encryption key + Password for encryption key - Key storage password + Key storage password - Not used + Not used - Network password info. + Network password info. Use #SECRET_SCHEMA_COMPAT_NETWORK instead. + - Keyring item stored in. + Keyring item stored in. - The identifier of the item. + The identifier of the item. - Network protocol or scheme. + Network protocol or scheme. - Server or host name. + Server or host name. - Share or other object on server. + Share or other object on server. - Type of authentication. + Type of authentication. - TCP port. + TCP port. - User name. + User name. - User domain + User domain - The password. + The password. + @@ -891,13 +1239,18 @@ A %NULL pointer may be passed, in which case it will be ignored. - + + @@ -908,13 +1261,18 @@ A %NULL pointer may be passed, in which case it will be ignored. - + + @@ -925,13 +1283,18 @@ A %NULL pointer may be passed, in which case it will be ignored. - + + @@ -942,13 +1305,18 @@ A %NULL pointer may be passed, in which case it will be ignored. - + + @@ -959,7 +1327,11 @@ A %NULL pointer may be passed, in which case it will be ignored. - + @@ -967,6 +1339,7 @@ A %NULL pointer may be passed, in which case it will be ignored. + @@ -979,36 +1352,53 @@ A %NULL pointer may be passed, in which case it will be ignored. - + + - result of the operation + result of the operation - the string, or %NULL + the string, or %NULL - - user data + + user data - Describes a password schema. Often you'll want to use a predefined schema such + Describes a password schema. Often you'll want to use a predefined schema such as %GNOME_KEYRING_NETWORK_PASSWORD. <para> @@ -1025,12 +1415,17 @@ The last attribute name in a schema must be %NULL. }; </programlisting> </para> + - The item type for this schema. + The item type for this schema. - list of attributes + list of attributes @@ -1047,81 +1442,119 @@ The last attribute name in a schema must be %NULL. - One attribute of a #GnomeKeyringPasswordSchema. + One attribute of a #GnomeKeyringPasswordSchema. + - the attribute name + the attribute name - the attribute data type + the attribute data type - Various result codes returned by functions. + Various result codes returned by functions. Errors are returned from libsecret functions as #GError. + - The operation completed successfully. + The operation completed successfully. - Either the user or daemon denied access. + Either the user or daemon denied access. - Keyring daemon is not available. + Keyring daemon is not available. - Keyring was already unlocked. + Keyring was already unlocked. - No such keyring exists. + No such keyring exists. - Bad arguments to function. + Bad arguments to function. - Problem communicating with daemon. + Problem communicating with daemon. - Operation was cancelled. + Operation was cancelled. - The keyring already exists. + The keyring already exists. - No such match found. + No such match found. - <para> + <para> A keyring only stored in memory. </para> + - Copy an access control list. + Copy an access control list. Not needed when using libsecret. + - + A new list of #GnomeKeyringAccessControl items. Use gnome_keyring_acl_free() to free the memory. @@ -1130,7 +1563,9 @@ to free the memory. - A list of + A list of #GnomeKeyringAccessControl pointers. @@ -1141,14 +1576,19 @@ to free the memory. - Free an access control list. + Free an access control list. Not needed when using libsecret. + - A list of + A list of #GnomeKeyringAccessControl pointers. @@ -1160,23 +1600,32 @@ to free the memory. c:identifier="gnome_keyring_attribute_list_append_string" moved-to="Attribute.list_append_string" deprecated="1"> - Store a key-value-pair with a string value in @attributes. + Store a key-value-pair with a string value in @attributes. libsecret stores attributes as a #GHashTable containing string keys and values, use g_hash_table_replace() instead. + - A #GnomeKeyringAttributeList + A #GnomeKeyringAttributeList - The name of the new attribute + The name of the new attribute - The value to store in @attributes + The value to store in @attributes @@ -1185,22 +1634,31 @@ to free the memory. c:identifier="gnome_keyring_attribute_list_append_uint32" moved-to="Attribute.list_append_uint32" deprecated="1"> - Store a key-value-pair with an unsigned 32bit number value in @attributes. + Store a key-value-pair with an unsigned 32bit number value in @attributes. libsecret does not support number attributes. + - A #GnomeKeyringAttributeList + A #GnomeKeyringAttributeList - The name of the new attribute + The name of the new attribute - The value to store in @attributes + The value to store in @attributes @@ -1209,15 +1667,22 @@ to free the memory. c:identifier="gnome_keyring_attribute_list_copy" moved-to="Attribute.list_copy" deprecated="1"> - Copy a list of item attributes. + Copy a list of item attributes. Not needed when using libsecret. + - The new #GnomeKeyringAttributeList + The new #GnomeKeyringAttributeList - A #GnomeKeyringAttributeList to copy. + A #GnomeKeyringAttributeList to copy. @@ -1226,36 +1691,58 @@ to free the memory. c:identifier="gnome_keyring_attribute_list_free" moved-to="Attribute.list_free" deprecated="1"> - Free the memory used by @attributes. + Free the memory used by @attributes. If a %NULL pointer is passed, it is ignored. libsecret stores attributes as a #GHashTable containing string keys and values, use g_hash_table_unref() instead. + - A #GnomeKeyringAttributeList + A #GnomeKeyringAttributeList + + + + + + + + + + - Create a new #GnomeKeyringAttributeList. + Create a new #GnomeKeyringAttributeList. libsecret stores attributes as a #GHashTable containing string keys and values; use g_hash_table_new() instead. + - The new #GnomeKeyringAttributeList + The new #GnomeKeyringAttributeList @@ -1264,11 +1751,16 @@ If a %NULL pointer is passed, it is ignored. moved-to="Attribute.list_to_glist" version="3.4" deprecated="1"> - Create #GList of #GnomeKeyringAttribute pointers from @attributes. This is + Create #GList of #GnomeKeyringAttribute pointers from @attributes. This is mostly useful in language bindings which cannot directly use a #GArray. Not needed when using libsecret. + - #GList + #GList of #GnomeKeyringAttribute. @@ -1276,7 +1768,9 @@ of #GnomeKeyringAttribute. - A #GnomeKeyringAttributeList + A #GnomeKeyringAttributeList @@ -1284,18 +1778,26 @@ of #GnomeKeyringAttribute. - Cancel an asynchronous request. + Cancel an asynchronous request. If a callback was registered when making the asynchronous request, that callback function will be called with a result of %GNOME_KEYRING_RESULT_CANCELLED When using libsecret, use #GCancellable to cancel asynchronous requests. + - - The request returned from the asynchronous call function. + + The request returned from the asynchronous call function. @@ -1304,27 +1806,36 @@ function will be called with a result of %GNOME_KEYRING_RESULT_CANCELLED c:identifier="gnome_keyring_change_password" introspectable="0" deprecated="1"> - Change the password for a @keyring. In most cases you would specify %NULL for + Change the password for a @keyring. In most cases you would specify %NULL for both the @original and @password arguments and allow the user to type the correct passwords. For a synchronous version of this function see gnome_keyring_change_password_sync(). Not used with libsecret. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). - The name of the keyring to change the password for. Cannot be %NULL. + The name of the keyring to change the password for. Cannot be %NULL. - The old keyring password, or %NULL to prompt the + The old keyring password, or %NULL to prompt the user for it. @@ -1332,7 +1843,9 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The new keyring password, or %NULL to prompt the + The new keyring password, or %NULL to prompt the user for it. @@ -1341,7 +1854,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="4" destroy="5"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -1349,12 +1864,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -1362,27 +1881,36 @@ to gnome_keyring_cancel_request(). - Change the password for @keyring. In most cases you would specify %NULL for + Change the password for @keyring. In most cases you would specify %NULL for both the @original and @password arguments and allow the user to type the correct passwords. For an asynchronous version of this function see gnome_keyring_change_password(). Not used with libsecret. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. - The name of the keyring to change the password for. Cannot be %NULL + The name of the keyring to change the password for. Cannot be %NULL - The old keyring password, or %NULL to prompt the + The old keyring password, or %NULL to prompt the user for it. @@ -1390,7 +1918,9 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The new keyring password, or %NULL to prompt the + The new keyring password, or %NULL to prompt the user for it. @@ -1400,27 +1930,36 @@ an error result otherwise. c:identifier="gnome_keyring_create" introspectable="0" deprecated="1"> - Create a new keyring with the specified name. In most cases %NULL will be + Create a new keyring with the specified name. In most cases %NULL will be passed as the @password, which will prompt the user to enter a password of their choice. For a synchronous version of this function see gnome_keyring_create_sync(). Use secret_collection_create() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). - The new keyring name. Must not be %NULL. + The new keyring name. Must not be %NULL. - The password for the new keyring. If %NULL user + The password for the new keyring. If %NULL user will be prompted. @@ -1429,7 +1968,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="3" destroy="4"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -1437,12 +1978,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -1450,27 +1995,36 @@ to gnome_keyring_cancel_request(). - Create a new keyring with the specified name. In most cases %NULL will be + Create a new keyring with the specified name. In most cases %NULL will be passed in as the @password, which will prompt the user to enter a password of their choice. For an asynchronous version of this function see gnome_keyring_create(). Use secret_collection_create_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. - The new keyring name. Must not be %NULL + The new keyring name. Must not be %NULL - The password for the new keyring. If %NULL user + The password for the new keyring. If %NULL user will be prompted. @@ -1480,8 +2034,11 @@ an error result otherwise. c:identifier="gnome_keyring_daemon_prepare_environment_sync" deprecated="1"> No longer supported, call is ignored. + - GNOME_KEYRING_RESULT_OK + GNOME_KEYRING_RESULT_OK @@ -1489,13 +2046,18 @@ an error result otherwise. c:identifier="gnome_keyring_daemon_set_display_sync" deprecated="1"> No longer supported, always fails. + - GNOME_KEYRING_RESULT_DENIED + GNOME_KEYRING_RESULT_DENIED - Deprecated + Deprecated @@ -1504,19 +2066,26 @@ an error result otherwise. c:identifier="gnome_keyring_delete" introspectable="0" deprecated="1"> - Delete @keyring. Once a keyring is deleted there is no mechanism for + Delete @keyring. Once a keyring is deleted there is no mechanism for recovery of its contents. For a synchronous version of this function see gnome_keyring_delete_sync(). Use secret_collection_delete() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). - The name of the keyring to delete. Cannot be %NULL. + The name of the keyring to delete. Cannot be %NULL. scope="notified" closure="2" destroy="3"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -1532,12 +2103,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -1547,7 +2122,9 @@ to gnome_keyring_cancel_request(). version="2.22" introspectable="0" deprecated="1"> - Delete a password that matches a given set of attributes. + Delete a password that matches a given set of attributes. Attributes which identify this password must be passed as additional arguments. Attributes passed must be defined in the schema. @@ -1555,14 +2132,19 @@ arguments. Attributes passed must be defined in the schema. Another more complex way to find items in the keyrings is using gnome_keyring_item_delete(). Use secret_password_clear() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). - The password schema. + The password schema. @@ -1571,7 +2153,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="2" destroy="3"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -1579,16 +2163,22 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. - The variable argument list should contain pairs of a) The attribute name as a null + The variable argument list should contain pairs of a) The attribute name as a null terminated string, followed by b) attribute value, either a character string, or 32-bit unsigned int, as defined in the password @schema. The list of attribtues should be terminated with a %NULL. @@ -1601,7 +2191,9 @@ to gnome_keyring_cancel_request(). version="2.22" introspectable="0" deprecated="1"> - Delete a password that matches a given set of attributes. + Delete a password that matches a given set of attributes. Attributes which identify this password must be passed as additional arguments. Attributes passed must be defined in the schema. @@ -1612,19 +2204,26 @@ remain responsive to the user, then use gnome_keyring_delete_password(). Another more complex way to find items in the keyrings is using gnome_keyring_item_delete_sync(). Use secret_password_clear_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. - The password schema. + The password schema. - The variable argument list should contain pairs of a) The attribute name as a null + The variable argument list should contain pairs of a) The attribute name as a null terminated string, followed by b) attribute value, either a character string, or 32-bit unsigned int, as defined in the password @schema. The list of attribtues should be terminated with a %NULL. @@ -1635,19 +2234,26 @@ an error result otherwise. - Delete @keyring. Once a keyring is deleted there is no mechanism for + Delete @keyring. Once a keyring is deleted there is no mechanism for recovery of its contents. For an asynchronous version of this function see gnome_keyring_delete(). Use secret_collection_delete_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. - The name of the keyring to delete. Cannot be %NULL + The name of the keyring to delete. Cannot be %NULL @@ -1656,7 +2262,9 @@ an error result otherwise. c:identifier="gnome_keyring_find_items" introspectable="0" deprecated="1"> - Searches through all keyrings for items that match the @attributes. The matches + Searches through all keyrings for items that match the @attributes. The matches are for exact equality. A %GList of GnomeKeyringFound structures are passed to the @callback. The @@ -1667,18 +2275,25 @@ have been prompted for access to the items if needed. For a synchronous version of this function see gnome_keyring_find_items_sync(). Use secret_password_lookup() or secret_service_search() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). - The type of items to find. + The type of items to find. - A list of attributes to search for. This cannot be an empty list. + A list of attributes to search for. This cannot be an empty list. scope="notified" closure="3" destroy="4"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -1694,12 +2311,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -1707,7 +2328,9 @@ to gnome_keyring_cancel_request(). - Searches through all keyrings for items that match the @attributes and @type. + Searches through all keyrings for items that match the @attributes and @type. The matches are for exact equality. A %GList of GnomeKeyringFound structures is returned in @found. The list may @@ -1719,25 +2342,34 @@ have been prompted for access to the items if needed. For an asynchronous version of this function see gnome_keyring_find_items(). Use secret_password_lookup_sync() or secret_service_search_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. - The type of items to find. + The type of items to find. - A list of attributes to search for. This cannot be an empty list. + A list of attributes to search for. This cannot be an empty list. - The location to return a + The location to return a list of #GnomeKeyringFound pointers. @@ -1749,7 +2381,9 @@ an error result otherwise. c:identifier="gnome_keyring_find_itemsv" introspectable="0" deprecated="1"> - Searches through all keyrings for items that match the specified attributes. + Searches through all keyrings for items that match the specified attributes. The matches are for exact equality. The variable argument list should contain a) The attribute name as a null @@ -1766,14 +2400,19 @@ have been prompted for access to the items if needed. For a synchronous version of this function see gnome_keyring_find_itemsv_sync(). Use secret_password_lookup() or secret_service_search() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). - The type of items to find. + The type of items to find. scope="notified" closure="2" destroy="3"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -1789,16 +2430,22 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. - Attribute name, followed by the attribute type, and string or 32-bit unsigned int value. Terminated with %NULL. + Attribute name, followed by the attribute type, and string or 32-bit unsigned int value. Terminated with %NULL. @@ -1807,7 +2454,9 @@ to gnome_keyring_cancel_request(). c:identifier="gnome_keyring_find_itemsv_sync" introspectable="0" deprecated="1"> - Searches through all keyrings for items that match the @attributes and @type. + Searches through all keyrings for items that match the @attributes and @type. The matches are for exact equality. The variable argument list should contain a) The attribute name as a null @@ -1825,28 +2474,37 @@ have been prompted for access to the items if needed. For an asynchronous version of this function see gnome_keyring_find_items(). Use secret_password_lookup_sync() or secret_service_search_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. - The type of items to find. + The type of items to find. - The location to return a + The location to return a list of #GnomeKeyringFound pointers. - Attribute name, followed by the attribute type, and string or 32-bit unsigned int value. Terminated with %NULL. + Attribute name, followed by the attribute type, and string or 32-bit unsigned int value. Terminated with %NULL. @@ -1855,7 +2513,9 @@ an error result otherwise. c:identifier="gnome_keyring_find_network_password" introspectable="0" deprecated="1"> - Find a previously stored network password. Searches all keyrings. + Find a previously stored network password. Searches all keyrings. A %GList of #GnomeKeyringNetworkPasswordData structures are passed to the @callback. The list and structures are freed after the callback returns. @@ -1865,8 +2525,11 @@ have been prompted for access to the items if needed. Network passwords are items with the item type %GNOME_KEYRING_ITEM_NETWORK_PASSWORD Use secret_password_lookup() with %SECRET_SCHEMA_COMPAT_NETWORK. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -1875,46 +2538,60 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The user name or %NULL for any user. + The user name or %NULL for any user. - The domain name or %NULL for any domain. + The domain name or %NULL for any domain. - The server or %NULL for any server. + The server or %NULL for any server. - The remote object or %NULL for any object. + The remote object or %NULL for any object. - The network protocol or %NULL for any protocol. + The network protocol or %NULL for any protocol. - The authentication type or %NULL for any type. + The authentication type or %NULL for any type. - The network port or zero for any port. + The network port or zero for any port. scope="notified" closure="8" destroy="9"> - Callback which is called when the operation completes + Callback which is called when the operation completes @@ -1930,11 +2609,15 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - Data to be passed to callback + Data to be passed to callback - Function to be called when data is no longer needed. + Function to be called when data is no longer needed. @@ -1942,7 +2625,9 @@ to gnome_keyring_cancel_request(). - Find a previously stored network password. Searches all keyrings. + Find a previously stored network password. Searches all keyrings. A %GList of #GnomeKeyringNetworkPasswordData structures are returned in the @out_list argument. The list should be freed with gnome_keyring_network_password_list_free() @@ -1952,8 +2637,11 @@ have been prompted for access to the items if needed. Network passwords are items with the item type %GNOME_KEYRING_ITEM_NETWORK_PASSWORD Use secret_password_lookup_sync() with %SECRET_SCHEMA_COMPAT_NETWORK. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -1962,53 +2650,69 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The user name or %NULL. + The user name or %NULL. - The domain name or %NULL. + The domain name or %NULL. - The server or %NULL. + The server or %NULL. - The remote object or %NULL. + The remote object or %NULL. - The network protocol or %NULL. + The network protocol or %NULL. - The authentication type or %NULL. + The authentication type or %NULL. - The network port or zero. + The network port or zero. - A location + A location to return a %GList of #GnomeKeyringNetworkPasswordData pointers. @@ -2021,7 +2725,9 @@ an error result otherwise. version="2.22" introspectable="0" deprecated="1"> - Find a password that matches a given set of attributes. + Find a password that matches a given set of attributes. Attributes which identify this password must be passed as additional arguments. Attributes passed must be defined in the schema. @@ -2032,14 +2738,19 @@ function returns. Another more complex way to find items in the keyrings is using gnome_keyring_find_items(). Use secret_password_lookup() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). - The password schema. + The password schema. @@ -2048,7 +2759,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="2" destroy="3"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -2056,16 +2769,22 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. - The variable argument list should contain pairs of a) The attribute name as a null + The variable argument list should contain pairs of a) The attribute name as a null terminated string, followed by b) attribute value, either a character string, or 32-bit unsigned int, as defined in the password @schema. The list of attribtues should be terminated with a %NULL. @@ -2078,7 +2797,9 @@ to gnome_keyring_cancel_request(). version="2.22" introspectable="0" deprecated="1"> - Find a password that matches a given set of attributes. + Find a password that matches a given set of attributes. Attributes which identify this password must be passed as additional arguments. Attributes passed must be defined in the schema. @@ -2089,14 +2810,19 @@ remain responsive to the user, then use gnome_keyring_find_password(). Another more complex way to find items in the keyrings is using gnome_keyring_find_items_sync(). Use secret_password_lookup_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. - The password schema. + The password schema. @@ -2104,12 +2830,16 @@ an error result otherwise. direction="out" caller-allocates="0" transfer-ownership="full"> - An address to store password that was found. The password + An address to store password that was found. The password must be freed with gnome_keyring_free_password(). - The variable argument list should contain pairs of a) The attribute name as a null + The variable argument list should contain pairs of a) The attribute name as a null terminated string, followed by b) attribute value, either a character string, or 32-bit unsigned int, as defined in the password @schema. The list of attribtues should be terminated with a %NULL. @@ -2121,14 +2851,19 @@ an error result otherwise. c:identifier="gnome_keyring_found_list_free" moved-to="Found.list_free" deprecated="1"> - Free the memory used by the #GnomeKeyringFound items in @found_list. + Free the memory used by the #GnomeKeyringFound items in @found_list. Not needed when using libsecret. + - a #GList of #GnomeKeyringFound + a #GList of #GnomeKeyringFound @@ -2138,16 +2873,21 @@ an error result otherwise. - Clears the memory used by password by filling with '\0' and frees the memory + Clears the memory used by password by filling with '\0' and frees the memory after doing this. You should use this function instead of g_free() for secret information. Use secret_password_free() instead. + - the password to be freed + the password to be freed @@ -2156,14 +2896,19 @@ secret information. c:identifier="gnome_keyring_get_default_keyring" introspectable="0" deprecated="1"> - Get the default keyring name, which will be passed to the @callback. If no + Get the default keyring name, which will be passed to the @callback. If no default keyring exists, then %NULL will be passed to the @callback. The string will be freed after @callback returns. For a synchronous version of this function see gnome_keyring_get_default_keyring_sync(). Use secret_collection_for_alias() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -2173,7 +2918,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="1" destroy="2"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -2181,12 +2928,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -2194,14 +2945,19 @@ to gnome_keyring_cancel_request(). - Get the default keyring name. + Get the default keyring name. The string returned in @keyring must be freed with g_free(). For an asynchronous version of this function see gnome_keyring_get_default_keyring(). Use secret_collection_for_alias_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -2210,7 +2966,9 @@ an error result otherwise. direction="out" caller-allocates="0" transfer-ownership="full"> - Location for the default keyring name to be returned. + Location for the default keyring name to be returned. @@ -2219,13 +2977,18 @@ an error result otherwise. c:identifier="gnome_keyring_get_info" introspectable="0" deprecated="1"> - Get information about the @keyring. The resulting #GnomeKeyringInfo structure + Get information about the @keyring. The resulting #GnomeKeyringInfo structure will be passed to @callback. The structure is freed after @callback returns. For a synchronous version of this function see gnome_keyring_get_info_sync(). Use #SecretCollection objects instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -2234,7 +2997,9 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring, or %NULL for the default + The name of the keyring, or %NULL for the default keyring. @@ -2243,7 +3008,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="2" destroy="3"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -2251,12 +3018,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -2264,15 +3035,20 @@ to gnome_keyring_cancel_request(). - Get information about @keyring. + Get information about @keyring. The #GnomeKeyringInfo structure returned in @info must be freed with gnome_keyring_info_free(). For an asynchronous version of this function see gnome_keyring_get_info(). Use #SecretCollection objects instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -2281,7 +3057,9 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring, or %NULL for the default + The name of the keyring, or %NULL for the default keyring. @@ -2289,19 +3067,224 @@ an error result otherwise. direction="out" caller-allocates="0" transfer-ownership="full"> - Location for the information about the keyring to be returned. + Location for the information about the keyring to be returned. + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +Each item has an access control list, which specifies the applications that +can read, write or delete an item. The read access applies only to reading the secret. +All applications can read other parts of the item. ACLs are accessed and changed +gnome_keyring_item_get_acl() and gnome_keyring_item_set_acl(). + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +Attributes allow various other pieces of information to be associated with an item. +These can also be used to search for relevant items. Use gnome_keyring_item_get_attributes() +or gnome_keyring_item_set_attributes(). + +Attributes are not stored in a secret or encrypted manner by gnome-keyring. Do +not store sensitive information in attributes. + +Each attribute has either a string, or unsigned integer value. + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +These functions are not used by most applications using Gnome Keyring. + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +A find operation searches through all keyrings for items that match the +attributes. The user may have been prompted to unlock necessary keyrings, and +user will have been prompted for access to the items if needed. + +A find operation may return multiple or zero results. + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +#GnomeKeyringItemInfo represents the basic information about a keyring item. +Use gnome_keyring_item_get_info() or gnome_keyring_item_set_info(). + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +A keyring contains multiple items. Each item has a secret, attributes and access +information associated with it. + +An item is identified by an unsigned integer unique to the keyring in which it +exists. An item's name is for displaying to the user. Each item has a single secret, +which is a null-terminated string. This secret is stored in non-pageable memory, and +encrypted on disk. All of this information is exposed via #GnomeKeyringItemInfo +pointers. + +Attributes allow various other pieces of information to be associated with an item. +These can also be used to search for relevant items. Attributes are accessed with +#GnomeKeyringAttribute structures and built into lists using #GnomeKeyringAttributeList. + +Attributes are not stored in a secret or encrypted manner by gnome-keyring. Do +not store sensitive information in attributes. + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +Use gnome_keyring_get_info() or gnome_keyring_get_info_sync() to get a #GnomeKeyringInfo +pointer to use with these functions. + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +<code>gnome-keyring-daemon</code> manages multiple keyrings. Each keyring can +store one or more items containing secrets. + +One of the keyrings is the default keyring, which can in many cases be used +by specifying %NULL for a keyring name. + +Each keyring can be in a locked or unlocked state. A password must be +specified, either by the user or the calling application, to unlock the +keyring. + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +Normal allocated memory can be paged to disk at the whim of the operating system. +This can be a serious problem for sensitive information like passwords, keys and secrets. + +GNOME Keyring holds passwords in non-pageable, or locked memory. This happens +both in the daemon and in the library. This is only possible if the OS contains +support for it. + +These functions allow applications to use to hold passwords and other +sensitive information. + + + All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead. + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +Networks passwords are a simple way of saving passwords associated with a +certain user/server/protocol and other fields. + +Attributes are not stored in a secret or encrypted manner by gnome-keyring. Do +not store sensitive information in attributes. + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +This is a simple API for storing passwords and retrieving passwords in the keyring. + +Each password is associated with a set of attributes. Attribute values can be either +strings or unsigned integers. + +The names and types of allowed attributes for a given password are defined with a +schema. Certain schemas are predefined such as %GNOME_KEYRING_NETWORK_PASSWORD. +Additional schemas can be defined via the %GnomeKeyringPasswordSchema structure. + +Attributes are not stored in a secret or encrypted manner by gnome-keyring. Do +not store sensitive information in attributes. + +Each function accepts a variable list of attributes names and their values. +Include a %NULL to terminate the list of attributes. + +<example> +<title>Passing attributes to the functions</title> +<programlisting> + res = gnome_keyring_delete_password_sync (GNOME_KEYRING_NETWORK_PASSWORD, + "user", "me", // A string attribute + "server, "example.gnome.org", + "port", "8080", // An integer attribute + NULL); +</programlisting></example> + + + <warning>All of these APIs are deprecated. Use +<ulink href="http://developer.gnome.org/libsecret/stable/">libsecret</ulink> +instead.</warning> + +<para> +Result codes used through out GNOME Keyring. Additional result codes may be +added from time to time and these should be handled gracefully. +</para> + - Check whether you can communicate with a gnome-keyring-daemon. + Check whether you can communicate with a gnome-keyring-daemon. Not needed when using libsecret. The gnome-keyring daemon is automatically started as needed. + - %FALSE if you can't communicate with the daemon (so you + %FALSE if you can't communicate with the daemon (so you can't load and save passwords). @@ -2309,15 +3292,22 @@ can't load and save passwords). - Get the application access rights for the access control. + Get the application access rights for the access control. Not supported when using libsecret. + - The access rights. + The access rights. - A #GnomeKeyringAccessControl pointer. + A #GnomeKeyringAccessControl pointer. @@ -2325,15 +3315,22 @@ can't load and save passwords). - Get the access control application's display name. + Get the access control application's display name. Not supported when using libsecret. + - A newly allocated string containing the display name. + A newly allocated string containing the display name. - A #GnomeKeyringAccessControl pointer. + A #GnomeKeyringAccessControl pointer. @@ -2341,15 +3338,22 @@ can't load and save passwords). - Get the access control application's full path name. + Get the access control application's full path name. Not supported when using libsecret. + - A newly allocated string containing the display name. + A newly allocated string containing the display name. - A #GnomeKeyringAccessControl pointer. + A #GnomeKeyringAccessControl pointer. @@ -2357,18 +3361,25 @@ can't load and save passwords). - Set the application access rights for the access control. + Set the application access rights for the access control. Not supported when using libsecret. + - A #GnomeKeyringAccessControl pointer. + A #GnomeKeyringAccessControl pointer. - The new access rights. + The new access rights. @@ -2376,18 +3387,25 @@ can't load and save passwords). - Set the access control application's display name. + Set the access control application's display name. Not supported when using libsecret. + - A #GnomeKeyringAccessControl pointer. + A #GnomeKeyringAccessControl pointer. - The new application display name. + The new application display name. @@ -2395,18 +3413,25 @@ can't load and save passwords). - Set the access control application's full path name. + Set the access control application's full path name. Not supported when using libsecret. + - A #GnomeKeyringAccessControl pointer + A #GnomeKeyringAccessControl pointer - The new application full path. + The new application full path. @@ -2415,7 +3440,9 @@ can't load and save passwords). c:identifier="gnome_keyring_item_create" introspectable="0" deprecated="1"> - Create a new item in a keyring. + Create a new item in a keyring. The @secret must be a null terminated string. It should be allocated using secure memory whenever possible. See gnome_keyring_memory_strdup() @@ -2432,8 +3459,11 @@ the @callback. For a synchronous version of this function see gnome_keyring_item_create_sync(). Use secret_password_store() or secret_item_create() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -2442,28 +3472,40 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which to create the item, + The name of the keyring in which to create the item, or %NULL for the default keyring. - The item type. + The item type. - The name of the item. This will be displayed to the user where necessary. + The name of the item. This will be displayed to the user where necessary. - A (possibly empty) list of attributes to store with the item. + A (possibly empty) list of attributes to store with the item. - The password or secret of the item. + The password or secret of the item. - If true, then another item matching the type, and attributes + If true, then another item matching the type, and attributes will be updated instead of creating a new item. @@ -2472,7 +3514,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="7" destroy="8"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -2480,12 +3524,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -2493,7 +3541,9 @@ to gnome_keyring_cancel_request(). - Create a new item in a keyring. + Create a new item in a keyring. The @secret must be a null terminated string. It should be allocated using secure memory whenever possible. See gnome_keyring_memory_strdup() @@ -2507,8 +3557,11 @@ to the previously existing item. For an asynchronous version of this function see gnome_keyring_item_create(). Use secret_password_store_sync() or secret_item_create_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -2517,28 +3570,40 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which to create the item, + The name of the keyring in which to create the item, or %NULL for the default keyring. - The item type. + The item type. - The name of the item. This will be displayed to the user where necessary. + The name of the item. This will be displayed to the user where necessary. - A (possibly empty) list of attributes to store with the item. + A (possibly empty) list of attributes to store with the item. - The password or secret of the item. + The password or secret of the item. - If true, then another item matching the type, and attributes + If true, then another item matching the type, and attributes will be updated instead of creating a new item. @@ -2546,7 +3611,9 @@ an error result otherwise. direction="out" caller-allocates="0" transfer-ownership="full"> - return location for the id of the created/updated keyring item. + return location for the id of the created/updated keyring item. @@ -2555,15 +3622,20 @@ an error result otherwise. c:identifier="gnome_keyring_item_delete" introspectable="0" deprecated="1"> - Delete an item in a keyring. + Delete an item in a keyring. The user may be prompted if the calling application doesn't have necessary access to delete the item. For an asynchronous version of this function see gnome_keyring_delete(). Use secret_password_clear() or secret_item_delete() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -2572,12 +3644,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring from which to delete the + The name of the keyring from which to delete the item, or %NULL for the default keyring. - The id of the item + The id of the item scope="notified" closure="3" destroy="4"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -2593,11 +3671,15 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the @callback. + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -2605,15 +3687,20 @@ to gnome_keyring_cancel_request(). - Delete an item in a keyring. + Delete an item in a keyring. The user may be prompted if the calling application doesn't have necessary access to delete the item. For an asynchronous version of this function see gnome_keyring_item_delete(). Use secret_password_clear_sync() or secret_item_delete_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -2622,12 +3709,16 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring from which to delete the + The name of the keyring from which to delete the item, or %NULL for the default keyring. - The id of the item + The id of the item @@ -2637,8 +3728,11 @@ an error result otherwise. introspectable="0" deprecated="1"> Never returns any ACL values. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -2647,12 +3741,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item scope="notified" closure="3" destroy="4"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -2668,12 +3768,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -2682,8 +3786,11 @@ to gnome_keyring_cancel_request(). c:identifier="gnome_keyring_item_get_acl_sync" deprecated="1"> Never returns any acls. + - Always %GNOME_KEYRING_RESULT_OK. + Always %GNOME_KEYRING_RESULT_OK. @@ -2691,19 +3798,25 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item - The location to return + The location to return a pointer to the access control list. @@ -2715,15 +3828,20 @@ a pointer to the access control list. c:identifier="gnome_keyring_item_get_attributes" introspectable="0" deprecated="1"> - Get all the attributes for an item. + Get all the attributes for an item. A #GnomeKeyringAttributeList will be passed to the @callback. This list will be freed after @callback returns. For a synchronous version of this function see gnome_keyring_item_get_attributes_sync(). Use secret_item_get_attributes() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -2732,12 +3850,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item scope="notified" closure="3" destroy="4"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -2753,12 +3877,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -2766,15 +3894,20 @@ to gnome_keyring_cancel_request(). - Get all attributes for an item. + Get all attributes for an item. A #GnomeKeyringAttributeList will be returned in @attributes. This should be freed using gnome_keyring_attribute_list_free(). For an asynchronous version of this function see gnome_keyring_item_get_attributes(). Use secret_item_get_attributes() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -2783,16 +3916,22 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item - The location to return a pointer to the attribute list. + The location to return a pointer to the attribute list. @@ -2801,7 +3940,9 @@ an error result otherwise. c:identifier="gnome_keyring_item_get_info" introspectable="0" deprecated="1"> - Get information about an item and its secret. + Get information about an item and its secret. The user may be prompted if the calling application doesn't have necessary access to read the item with its secret. @@ -2811,8 +3952,11 @@ will be freed after @callback returns. For a synchronous version of this function see gnome_keyring_item_get_info_sync(). Use #SecretItem objects instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -2821,12 +3965,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item scope="notified" closure="3" destroy="4"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -2842,11 +3992,15 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the @callback. + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -2855,7 +4009,9 @@ to gnome_keyring_cancel_request(). c:identifier="gnome_keyring_item_get_info_full" introspectable="0" deprecated="1"> - Get information about an item, optionally retrieving its secret. + Get information about an item, optionally retrieving its secret. If @flags includes %GNOME_KEYRING_ITEM_INFO_SECRET then the user may be prompted if the calling application doesn't have necessary access to read @@ -2867,8 +4023,11 @@ structure will be freed after @callback returns. For a synchronous version of this function see gnome_keyring_item_get_info_full_sync(). Use #SecretItem objects instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -2877,16 +4036,22 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item - The parts of the item to retrieve. + The parts of the item to retrieve. scope="notified" closure="4" destroy="5"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -2902,12 +4069,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -2915,7 +4086,9 @@ to gnome_keyring_cancel_request(). - Get information about an item, optionally retrieving its secret. + Get information about an item, optionally retrieving its secret. If @flags includes %GNOME_KEYRING_ITEM_INFO_SECRET then the user may be prompted if the calling application doesn't have necessary access to read @@ -2927,8 +4100,11 @@ This must be freed using gnome_keyring_item_info_free(). For an asynchronous version of this function see gnome_keyring_item_get_info_full(). Use #SecretItem objects instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -2937,23 +4113,31 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item - The parts of the item to retrieve. + The parts of the item to retrieve. - The location to return a #GnomeKeyringItemInfo pointer. + The location to return a #GnomeKeyringItemInfo pointer. @@ -2961,7 +4145,9 @@ an error result otherwise. - Get information about an item and its secret. + Get information about an item and its secret. The user may be prompted if the calling application doesn't have necessary access to read the item with its secret. @@ -2971,8 +4157,11 @@ freed using gnome_keyring_item_info_free(). For an asynchronous version of this function see gnome_keyring_item_get_info(). Use #SecretItem objects instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -2981,19 +4170,25 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item - The location to return a #GnomeKeyringItemInfo pointer. + The location to return a #GnomeKeyringItemInfo pointer. @@ -3004,8 +4199,11 @@ an error result otherwise. introspectable="0" deprecated="1"> This function no longer has any effect. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -3014,23 +4212,33 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The keyring name, or %NULL for the default keyring. + The keyring name, or %NULL for the default keyring. - The display name for the application, as returned by g_get_application_name(). + The display name for the application, as returned by g_get_application_name(). - The full filepath to the application. + The full filepath to the application. - The id of the item to grant access to. + The id of the item to grant access to. - The type of rights to grant. + The type of rights to grant. scope="notified" closure="6" destroy="7"> - Callback which is called when the operation completes + Callback which is called when the operation completes @@ -3046,11 +4256,15 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - Data to be passed to callback + Data to be passed to callback - Function to be called when data is no longer needed. + Function to be called when data is no longer needed. @@ -3058,11 +4272,16 @@ to gnome_keyring_cancel_request(). - Will grant the application access rights to the item, provided + Will grant the application access rights to the item, provided callee has write access to said item. This function no longer has any effect. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -3071,23 +4290,33 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The keyring name, or %NULL for the default keyring. + The keyring name, or %NULL for the default keyring. - The display name for the application, as returned by g_get_application_name(). + The display name for the application, as returned by g_get_application_name(). - The full filepath to the application. + The full filepath to the application. - The id of the item to grant access to. + The id of the item to grant access to. - The type of rights to grant. + The type of rights to grant. @@ -3097,8 +4326,11 @@ an error result otherwise. introspectable="0" deprecated="1"> This function no longer has any effect. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -3107,16 +4339,22 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item - The access control list to + The access control list to set on the item. @@ -3127,7 +4365,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="4" destroy="5"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -3135,12 +4375,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -3149,8 +4393,11 @@ to gnome_keyring_cancel_request(). c:identifier="gnome_keyring_item_set_acl_sync" deprecated="1"> This function no longer has any effect. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -3159,16 +4406,22 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item - The access control list to + The access control list to set on the item. @@ -3180,13 +4433,18 @@ an error result otherwise. c:identifier="gnome_keyring_item_set_attributes" introspectable="0" deprecated="1"> - Set all the attributes for an item. This will replace any previous attributes + Set all the attributes for an item. This will replace any previous attributes set on the item. For a synchronous version of this function see gnome_keyring_item_set_attributes_sync(). Use secret_item_set_attributes() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -3195,16 +4453,22 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item - The full list of attributes to set on the item. + The full list of attributes to set on the item. scope="notified" closure="4" destroy="5"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -3220,12 +4486,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -3233,13 +4503,18 @@ to gnome_keyring_cancel_request(). - Set all the attributes for an item. This will replace any previous attributes + Set all the attributes for an item. This will replace any previous attributes set on the item. For an asynchronous version of this function see gnome_keyring_item_set_attributes(). Use secret_item_set_attributes_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -3248,16 +4523,22 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item - The full list of attributes to set on the item. + The full list of attributes to set on the item. @@ -3266,15 +4547,20 @@ an error result otherwise. c:identifier="gnome_keyring_item_set_info" introspectable="0" deprecated="1"> - Set information on an item, like its display name, secret etc... + Set information on an item, like its display name, secret etc... Only the fields in the @info pointer that are non-null or non-zero will be set on the item. For a synchronous version of this function see gnome_keyring_item_set_info_sync(). Use #SecretItem objects instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -3283,16 +4569,22 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item - The item info to save into the item. + The item info to save into the item. scope="notified" closure="4" destroy="5"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -3308,12 +4602,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -3321,15 +4619,20 @@ to gnome_keyring_cancel_request(). - Set information on an item, like its display name, secret etc... + Set information on an item, like its display name, secret etc... Only the fields in the @info pointer that are non-null or non-zero will be set on the item. For an asynchronous version of this function see gnome_keyring_item_set_info(). Use #SecretItem objects instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -3338,16 +4641,22 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring in which the item exists, or + The name of the keyring in which the item exists, or %NULL for the default keyring. - The id of the item + The id of the item - The item info to save into the item. + The item info to save into the item. @@ -3356,7 +4665,9 @@ an error result otherwise. c:identifier="gnome_keyring_list_item_ids" introspectable="0" deprecated="1"> - Get a list of all the ids for items in @keyring. These are passed in a %GList + Get a list of all the ids for items in @keyring. These are passed in a %GList to the @callback. Use GPOINTER_TO_UINT() on the list to access the integer ids. The list is freed after @callback returns. @@ -3366,8 +4677,11 @@ included in the list. This includes items that the calling application may not For a synchronous version of this function see gnome_keyring_list_item_ids_sync(). Use secret_collection_get_items() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -3376,7 +4690,9 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring, or %NULL for the default + The name of the keyring, or %NULL for the default keyring. @@ -3385,7 +4701,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="2" destroy="3"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -3393,12 +4711,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -3406,15 +4728,20 @@ to gnome_keyring_cancel_request(). - Get a list of all the ids for items in @keyring. + Get a list of all the ids for items in @keyring. Use GPOINTER_TO_UINT() on the list to access the integer ids. The list should be freed with g_list_free(). For an asynchronous version of this function see gnome_keyring_list_item_ids(). Use secret_collection_get_items() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -3423,7 +4750,9 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring, or %NULL for the default + The name of the keyring, or %NULL for the default keyring. @@ -3431,7 +4760,9 @@ an error result otherwise. direction="out" caller-allocates="0" transfer-ownership="full"> - The location to store a %GList of item ids + The location to store a %GList of item ids (ie: unsigned integers). @@ -3443,7 +4774,9 @@ an error result otherwise. c:identifier="gnome_keyring_list_keyring_names" introspectable="0" deprecated="1"> - Get a list of keyring names. + Get a list of keyring names. A %GList of null terminated strings will be passed to the @callback. If no keyrings exist then an empty list will be passed to the @@ -3451,8 +4784,11 @@ the @callback. If no keyrings exist then an empty list will be passed to the For a synchronous version of this function see gnome_keyring_list_keyring_names_sync(). Use secret_service_get_collections() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -3462,7 +4798,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="1" destroy="2"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -3470,12 +4808,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -3483,15 +4825,20 @@ to gnome_keyring_cancel_request(). - Get a list of keyring names. + Get a list of keyring names. The list returned in in @keyrings must be freed using gnome_keyring_string_list_free(). For an asynchronous version of this function see gnome_keyring_list_keyring_names(). Use secret_service_get_collections() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -3500,7 +4847,9 @@ an error result otherwise. direction="out" caller-allocates="0" transfer-ownership="full"> - Location for a %GList of keyring names to be returned. + Location for a %GList of keyring names to be returned. @@ -3511,7 +4860,9 @@ an error result otherwise. c:identifier="gnome_keyring_lock" introspectable="0" deprecated="1"> - Lock a @keyring, so that its contents may not be accessed without first + Lock a @keyring, so that its contents may not be accessed without first supplying a password. Most keyring operations involving items require that you first unlock the @@ -3519,8 +4870,11 @@ keyring. One exception is gnome_keyring_find_items() and related functions. For a synchronous version of this function see gnome_keyring_lock_sync(). Use secret_service_lock() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -3529,7 +4883,9 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring to lock, or %NULL for the + The name of the keyring to lock, or %NULL for the default keyring. @@ -3538,7 +4894,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="2" destroy="3"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -3546,12 +4904,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -3560,13 +4922,18 @@ to gnome_keyring_cancel_request(). c:identifier="gnome_keyring_lock_all" introspectable="0" deprecated="1"> - Lock all the keyrings, so that their contents may not be accessed without + Lock all the keyrings, so that their contents may not be accessed without first unlocking them with a password. For a synchronous version of this function see gnome_keyring_lock_all_sync(). Use libsecret instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -3576,7 +4943,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="1" destroy="2"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -3584,12 +4953,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -3597,13 +4970,18 @@ to gnome_keyring_cancel_request(). - Lock all the keyrings, so that their contents may not eb accessed without + Lock all the keyrings, so that their contents may not eb accessed without first unlocking them with a password. For an asynchronous version of this function see gnome_keyring_lock_all(). Use libsecret instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -3611,7 +4989,9 @@ an error result otherwise. - Lock a @keyring, so that its contents may not be accessed without first + Lock a @keyring, so that its contents may not be accessed without first supplying a password. Most keyring opretaions involving items require that you first unlock the @@ -3619,8 +4999,11 @@ keyring. One exception is gnome_keyring_find_items_sync() and related functions. For an asynchronous version of this function see gnome_keyring_lock(). Use secret_service_lock_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -3629,7 +5012,9 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring to lock, or %NULL for the + The name of the keyring to lock, or %NULL for the default keyring. @@ -3639,19 +5024,26 @@ an error result otherwise. c:identifier="gnome_keyring_memory_alloc" introspectable="0" deprecated="1"> - Allocate a block of gnome-keyring non-pageable memory. + Allocate a block of gnome-keyring non-pageable memory. If non-pageable memory cannot be allocated then normal memory will be returned. Use gcr_secure_memory_alloc() instead. - - The new memory block which should be freed + + + The new memory block which should be freed with gnome_keyring_memory_free() - The new desired size of the memory block. + The new desired size of the memory block. @@ -3660,17 +5052,25 @@ with gnome_keyring_memory_free() c:identifier="gnome_keyring_memory_free" introspectable="0" deprecated="1"> - Free a block of gnome-keyring non-pageable memory. + Free a block of gnome-keyring non-pageable memory. Glib memory is also freed correctly when passed to this function. If called with a null pointer then no action is taken. Use gcr_secure_memory_free() instead. + - - The pointer to the beginning of the block of memory to free. + + The pointer to the beginning of the block of memory to free. @@ -3679,24 +5079,58 @@ with a null pointer then no action is taken. c:identifier="gnome_keyring_memory_is_secure" introspectable="0" deprecated="1"> - Check if a pointer is in non-pageable memory allocated by gnome-keyring. + Check if a pointer is in non-pageable memory allocated by gnome-keyring. Use gcr_secure_memory_is_secure() instead. + - Whether the memory is non-pageable or not + Whether the memory is non-pageable or not - - The pointer to check + + The pointer to check + + Allocate objects in non-pageable gnome-keyring memory. + Use gcr_secure_memory_alloc() instead. + + + + The C type of the objects to allocate + + + The number of objects to allocate. + + + - Reallocate a block of gnome-keyring non-pageable memory. + Reallocate a block of gnome-keyring non-pageable memory. Glib memory is also reallocated correctly. If called with a null pointer, then a new block of memory is allocated. If called with a zero size, @@ -3705,8 +5139,11 @@ then the block of memory is freed. If non-pageable memory cannot be allocated then normal memory will be returned. Use gcr_secure_memory_realloc() instead. - - The new block, or %NULL if the block was + + + The new block, or %NULL if the block was freed. The memory block should be freed with gnome_keyring_memory_free() @@ -3715,12 +5152,16 @@ freed. The memory block should be freed with gnome_keyring_memory_free() transfer-ownership="none" nullable="1" allow-none="1"> - The pointer to reallocate or %NULL to allocate a new + The pointer to reallocate or %NULL to allocate a new block. - The new desired size of the memory block, or 0 to free the memory. + The new desired size of the memory block, or 0 to free the memory. @@ -3729,16 +5170,23 @@ freed. The memory block should be freed with gnome_keyring_memory_free() c:identifier="gnome_keyring_memory_strdup" introspectable="0" deprecated="1"> - Copy a string into non-pageable memory. If the input string is %NULL, then + Copy a string into non-pageable memory. If the input string is %NULL, then %NULL will be returned. Use gcr_secure_memory_strdup() instead. + - The copied string, should be freed with gnome_keyring_memory_free() + The copied string, should be freed with gnome_keyring_memory_free() - The null terminated string to copy + The null terminated string to copy @@ -3747,18 +5195,25 @@ freed. The memory block should be freed with gnome_keyring_memory_free() c:identifier="gnome_keyring_memory_try_alloc" introspectable="0" deprecated="1"> - Allocate a block of gnome-keyring non-pageable memory. + Allocate a block of gnome-keyring non-pageable memory. If non-pageable memory cannot be allocated, then %NULL is returned. Use gcr_secure_memory_try_alloc() instead. - - The new block, or %NULL if memory cannot be + + + The new block, or %NULL if memory cannot be allocated. The memory block should be freed with gnome_keyring_memory_free() - The new desired size of the memory block. + The new desired size of the memory block. @@ -3767,7 +5222,9 @@ allocated. The memory block should be freed with gnome_keyring_memory_free() - Reallocate a block of gnome-keyring non-pageable memory. + Reallocate a block of gnome-keyring non-pageable memory. Glib memory is also reallocated correctly when passed to this function. If called with a null pointer, then a new block of memory is allocated. @@ -3776,8 +5233,11 @@ If called with a zero size, then the block of memory is freed. If memory cannot be allocated, %NULL is returned and the original block of memory remains intact. Use gcr_secure_memory_try_realloc() instead. - - The new block, or %NULL if memory cannot be + + + The new block, or %NULL if memory cannot be allocated. The memory block should be freed with gnome_keyring_memory_free() @@ -3786,11 +5246,15 @@ allocated. The memory block should be freed with gnome_keyring_memory_free() - The pointer to reallocate or %NULL to allocate a new block. + The pointer to reallocate or %NULL to allocate a new block. - The new desired size of the memory block. + The new desired size of the memory block. @@ -3798,9 +5262,12 @@ allocated. The memory block should be freed with gnome_keyring_memory_free() - Free a network password data pointer. If %NULL is passed in, + Free a network password data pointer. If %NULL is passed in, nothing happens. Not used with libsecret. + @@ -3809,7 +5276,9 @@ nothing happens. transfer-ownership="none" nullable="1" allow-none="1"> - A #GnomeKeyringNetworkPasswordData pointer. + A #GnomeKeyringNetworkPasswordData pointer. @@ -3818,14 +5287,19 @@ nothing happens. - Free a list of network password data. + Free a list of network password data. Not used with libsecret. + - A list of + A list of #GnomeKeyringNetworkPasswordData pointers. @@ -3836,7 +5310,9 @@ nothing happens. - The #GNOME_KEYRING_RESULT_OK and #GNOME_KEYRING_RESULT_CANCELLED + The #GNOME_KEYRING_RESULT_OK and #GNOME_KEYRING_RESULT_CANCELLED codes will return an empty string. Note that there are some results for which the application will need to @@ -3844,15 +5320,20 @@ take appropriate action rather than just display an error message to the user. libsecret returns errors as #GError directly. Use the error message field for a description. + - a string suitable for display to the user for a given + a string suitable for display to the user for a given #GnomeKeyringResult, or an empty string if the message wouldn't make sense to a user. - A #GnomeKeyringResult + A #GnomeKeyringResult @@ -3861,18 +5342,25 @@ sense to a user. c:identifier="gnome_keyring_set_default_keyring" introspectable="0" deprecated="1"> - Change the default keyring. + Change the default keyring. For a synchronous version of this function see gnome_keyring_set_default_keyring_sync(). Use secret_service_set_alias() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). - The keyring to make default + The keyring to make default scope="notified" closure="2" destroy="3"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -3888,12 +5378,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -3901,18 +5395,25 @@ to gnome_keyring_cancel_request(). - Change the default keyring. + Change the default keyring. For an asynchronous version of this function see gnome_keyring_set_default_keyring(). Use secret_service_set_alias_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. - The keyring to make default + The keyring to make default @@ -3921,13 +5422,18 @@ an error result otherwise. c:identifier="gnome_keyring_set_info" introspectable="0" deprecated="1"> - Set flags and info for the @keyring. The only fields in @info that are used + Set flags and info for the @keyring. The only fields in @info that are used are lock_on_idle and lock_timeout. For a synchronous version of this function see gnome_keyring_set_info_sync(). Use #SecretCollection objects instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -3936,12 +5442,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring, or %NULL for the default + The name of the keyring, or %NULL for the default keyring. - A structure containing flags and info for the keyring. + A structure containing flags and info for the keyring. scope="notified" closure="3" destroy="4"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -3957,12 +5469,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -3970,13 +5486,18 @@ to gnome_keyring_cancel_request(). - Set flags and info for @keyring. The only fields in @info that are used + Set flags and info for @keyring. The only fields in @info that are used are lock_on_idle and lock_timeout. For an asynchronous version of this function see gnome_keyring_set_info(). Use #SecretCollection objects instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -3985,12 +5506,16 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring, or %NULL for the default + The name of the keyring, or %NULL for the default keyring. - A structure containing flags and info for the keyring. + A structure containing flags and info for the keyring. @@ -3999,7 +5524,9 @@ an error result otherwise. c:identifier="gnome_keyring_set_network_password" introspectable="0" deprecated="1"> - Store a network password. + Store a network password. If an item already exists for with this network info (ie: user, server etc...) then it will be updated. @@ -4009,8 +5536,11 @@ the @callback. Network passwords are items with the item type %GNOME_KEYRING_ITEM_NETWORK_PASSWORD Use secret_password_store() with %SECRET_SCHEMA_COMPAT_NETWORK. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -4019,7 +5549,9 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The keyring to store the password in, or %NULL for + The keyring to store the password in, or %NULL for the default keyring. @@ -4027,50 +5559,66 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The user name or %NULL. + The user name or %NULL. - The domain name or %NULL. + The domain name or %NULL. - The server or %NULL. + The server or %NULL. - The remote object or %NULL. + The remote object or %NULL. - The network protocol or %NULL. + The network protocol or %NULL. - The authentication type or %NULL. + The authentication type or %NULL. - The network port or zero. + The network port or zero. - The password to store, must not be %NULL. + The password to store, must not be %NULL. scope="notified" closure="10" destroy="11"> - Callback which is called when the operation completes + Callback which is called when the operation completes @@ -4086,11 +5636,15 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - Data to be passed to callback + Data to be passed to callback - Function to be called when data is no longer needed. + Function to be called when data is no longer needed. @@ -4098,7 +5652,9 @@ to gnome_keyring_cancel_request(). - Store a network password. + Store a network password. If an item already exists for with this network info (ie: user, server etc...) then it will be updated. @@ -4107,8 +5663,11 @@ The created or updated item id will be returned in @item_id. Network passwords are items with the item type %GNOME_KEYRING_ITEM_NETWORK_PASSWORD Use secret_password_store_sync() with %SECRET_SCHEMA_COMPAT_NETWORK. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -4117,7 +5676,9 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The keyring to store the password in, or %NULL for + The keyring to store the password in, or %NULL for the default keyring. @@ -4125,57 +5686,75 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The user name or %NULL. + The user name or %NULL. - The domain name or %NULL. + The domain name or %NULL. - The server or %NULL. + The server or %NULL. - The remote object or %NULL. + The remote object or %NULL. - The network protocol or %NULL. + The network protocol or %NULL. - The authentication type or %NULL. + The authentication type or %NULL. - The network port or zero. + The network port or zero. - The password to store, must not be %NULL. + The password to store, must not be %NULL. - A location to store the resulting item's id. + A location to store the resulting item's id. @@ -4185,7 +5764,9 @@ an error result otherwise. version="2.22" introspectable="0" deprecated="1"> - Store a password associated with a given set of attributes. + Store a password associated with a given set of attributes. Attributes which identify this password must be passed as additional arguments. Attributes passed must be defined in the schema. @@ -4195,14 +5776,19 @@ then the password will be updated. Another more complex way to create a keyring item is using gnome_keyring_item_create(). Use secret_password_store() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). - The password schema. + The password schema. @@ -4210,17 +5796,23 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The keyring to store the password in. Specify %NULL + The keyring to store the password in. Specify %NULL for the default keyring. Use %GNOME_KEYRING_SESSION to store the password in memory only. - A human readable description of what the password is for. + A human readable description of what the password is for. - The password to store. + The password to store. scope="notified" closure="5" destroy="6"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -4236,16 +5830,22 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. - The variable argument list should contain pairs of a) The attribute name as a null + The variable argument list should contain pairs of a) The attribute name as a null terminated string, followed by b) attribute value, either a character string, or 32-bit unsigned int, as defined in the password @schema. The list of attribtues should be terminated with a %NULL. @@ -4258,7 +5858,9 @@ to gnome_keyring_cancel_request(). version="2.22" introspectable="0" deprecated="1"> - Store a password associated with a given set of attributes. + Store a password associated with a given set of attributes. Attributes which identify this password must be passed as additional arguments. Attributes passed must be defined in the schema. @@ -4272,14 +5874,19 @@ then the password will be updated. Another more complex way to create a keyring item is using gnome_keyring_item_create_sync(). Use secret_password_store_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. - The password schema. + The password schema. @@ -4287,21 +5894,29 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The keyring to store the password in. Specify %NULL + The keyring to store the password in. Specify %NULL for the default keyring. Use %GNOME_KEYRING_SESSION to store the password in memory only. - A human readable description of what the password is for. + A human readable description of what the password is for. - The password to store. + The password to store. - The variable argument list should contain pairs of a) The attribute name as a null + The variable argument list should contain pairs of a) The attribute name as a null terminated string, followed by b) attribute value, either a character string, or 32-bit unsigned int, as defined in the password @schema. The list of attribtues should be terminated with a %NULL. @@ -4312,14 +5927,19 @@ an error result otherwise. - Free a list of string pointers. + Free a list of string pointers. Not needed when using libsecret. + - A %GList of string pointers. + A %GList of string pointers. @@ -4330,7 +5950,9 @@ an error result otherwise. c:identifier="gnome_keyring_unlock" introspectable="0" deprecated="1"> - Unlock a @keyring, so that its contents may be accessed. In most cases %NULL + Unlock a @keyring, so that its contents may be accessed. In most cases %NULL will be passed as the @password, which will prompt the user to enter the correct password. @@ -4339,8 +5961,11 @@ keyring. One exception is gnome_keyring_find_items() and related functions. For a synchronous version of this function see gnome_keyring_unlock_sync(). Use secret_service_unlock() instead. - - The asynchronous request, which can be passed + + + The asynchronous request, which can be passed to gnome_keyring_cancel_request(). @@ -4349,7 +5974,9 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring to unlock, or %NULL for the + The name of the keyring to unlock, or %NULL for the default keyring. @@ -4357,7 +5984,9 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - The password to unlock the keyring with, or %NULL + The password to unlock the keyring with, or %NULL to prompt the user. @@ -4366,7 +5995,9 @@ to gnome_keyring_cancel_request(). scope="notified" closure="3" destroy="4"> - A callback which will be called when the request completes or fails. + A callback which will be called when the request completes or fails. @@ -4374,12 +6005,16 @@ to gnome_keyring_cancel_request(). transfer-ownership="none" nullable="1" allow-none="1"> - A pointer to arbitrary data that will be passed to the + A pointer to arbitrary data that will be passed to the @callback. - A function to free @data when it's no longer needed. + A function to free @data when it's no longer needed. @@ -4387,7 +6022,9 @@ to gnome_keyring_cancel_request(). - Unlock a @keyring, so that its contents may be accessed. In most cases %NULL + Unlock a @keyring, so that its contents may be accessed. In most cases %NULL will be passed in as the @password, which will prompt the user to enter the correct password. @@ -4396,8 +6033,11 @@ keyring. One exception is gnome_keyring_find_items_sync() and related functions. For an asynchronous version of this function see gnome_keyring_unlock(). Use secret_service_unlock_sync() instead. + - %GNOME_KEYRING_RESULT_OK if the operation was succcessful or + %GNOME_KEYRING_RESULT_OK if the operation was succcessful or an error result otherwise. @@ -4406,7 +6046,9 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The name of the keyring to unlock, or %NULL for the + The name of the keyring to unlock, or %NULL for the default keyring. @@ -4414,7 +6056,9 @@ an error result otherwise. transfer-ownership="none" nullable="1" allow-none="1"> - The password to unlock the keyring with, or %NULL + The password to unlock the keyring with, or %NULL to prompt the user. diff --git a/girs/GoVirt-1.0.gir b/girs/GoVirt-1.0.gir index b753351d9..71bb0ee18 100644 --- a/girs/GoVirt-1.0.gir +++ b/girs/GoVirt-1.0.gir @@ -6,16 +6,1455 @@ and/or use gtk-doc annotations. --> xmlns="http://www.gtk.org/introspection/core/1.0" xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This method does not initiate any network activity, the collection +must be fetched with ovirt_collection_fetch() before having up-to-date +content. + + + + + + + a #OvirtApi + + + + + + This method does not initiate any network activity, the collection +must be fetched with ovirt_collection_fetch() before having up-to-date +content. + + + + + + + a #OvirtApi + + + + + + This method does not initiate any network activity, the collection +must be fetched with ovirt_collection_fetch() before having up-to-date +content. + + + + + + + a #OvirtApi + + + + + + This method does not initiate any network activity, the collection +must be fetched with ovirt_collection_fetch() before having up-to-date +content. + + + + + + + a #OvirtApi + + + + + + This method does not initiate any network activity, the collection +must be fetched with ovirt_collection_fetch() before having up-to-date +content. + + + + + + + a #OvirtApi + + + + + + This method does not initiate any network activity, the collection +must be fetched with ovirt_collection_fetch() before having up-to-date +content. + + + + + + + a #OvirtApi + + + + + + + + + + + + a #OvirtApi + + + + search query + + + + + + + + + + + + a #OvirtApi + + + + search query + + + + + + + + + + + + a #OvirtApi + + + + search query + + + + + + + + + + + + a #OvirtApi + + + + search query + + + + + + + + + + + + a #OvirtApi + + + + search query + + + + + + + + + + + + a #OvirtApi + + + + search query + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets a #OvirtCluster representing the data center the cluster belongs +to. This method does not initiate any network activity, the remote data center must +be then be fetched using ovirt_resource_refresh() or +ovirt_resource_refresh_async(). + + + a #OvirtDataCenter representing data center +the @host belongs to. + + + + + a #OvirtCluster + + + + + + Gets a #OvirtCollection representing the list of remote hosts from a +cluster object. This method does not initiate any network +activity, the remote host list must be then be fetched using +ovirt_collection_fetch() or ovirt_collection_fetch_async(). + + + a #OvirtCollection representing the list +of hosts associated with @cluster. + + + + + a #OvirtCluster + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + a #OvirtCollection + + + + a #OvirtProxy + + + + + + + + + + + + a #OvirtCollection + + + + a #OvirtProxy + + + + + + + completion callback + + + + opaque data for callback + + + + + + + + TRUE if successful, FALSE otherwise, with @error set. + + + + + a #OvirtCollection + + + + async method result + + + + + + + + + + + + + + + + + + + + Looks up a resource in @collection whose name is @name. If it cannot be +found, NULL is returned. This method does not initiate any network +activity, the remote collection content must have been fetched with +ovirt_collection_fetch() or ovirt_collection_fetch_async() before +calling this function. + + + a #OvirtResource whose name is @name +or NULL + + + + + a #OvirtCollection + + + + name of the resource to lookup + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets a #OvirtCollection representing the list of remote clusters from a +data center object. This method does not initiate any network +activity, the remote cluster list must be then be fetched using +ovirt_collection_fetch() or ovirt_collection_fetch_async(). + + + a #OvirtCollection representing the list +of clusters associated with @data_center. + + + + + a #OvirtDataCenter + + + + + + Gets a #OvirtCollection representing the list of remote storage domains from a +data center object. This method does not initiate any network +activity, the remote storage domain list must be then be fetched using +ovirt_collection_fetch() or ovirt_collection_fetch_async(). + + + a #OvirtCollection representing the list +of storage_domains associated with @data_center. + + + + + a #OvirtDataCenter + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets a #OvirtCluster representing the cluster the host belongs +to. This method does not initiate any network activity, the remote host must +be then be fetched using ovirt_resource_refresh() or +ovirt_resource_refresh_async(). + + + a #OvirtCluster representing cluster the @host +belongs to. + + + + + a #OvirtHost + + + + + + Gets a #OvirtCollection representing the list of remote vms from a +host object. This method does not initiate any network +activity, the remote vm list must be then be fetched using +ovirt_collection_fetch() or ovirt_collection_fetch_async(). + + + a #OvirtCollection representing the list +of vms associated with @host. + + + + + a #OvirtHost + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="OvirtProxy" glib:get-type="ovirt_proxy_get_type" glib:type-struct="ProxyClass"> + + - + + + + + + + + + a #OvirtProxy + + + + + + + + + + + + a #OvirtProxy + + + + + + + completion callback + + + + opaque data for callback + + + + + + + + an #OvirtApi instance to interact with +oVirt/RHEV REST API. + + + + + a #OvirtProxy + + + + async method result + + + + + + + + + + + + + + - + @@ -66,43 +1603,69 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + a #OvirtProxy + + - completion callback + completion callback - - opaque data for callback + + opaque data for callback @@ -110,156 +1673,1098 @@ and/or use gtk-doc annotations. --> + + + the list of +#OvirtVm associated with #OvirtProxy. +The returned list should be freed with g_list_free(), and can become +invalid any time a #OvirtProxy call completes. + + + + + + + a #OvirtProxy + + + + async method result + + + + + + Gets the api entry point to access remote oVirt resources and collections. +This method does not initiate any network activity, the remote API entry point +must have been fetched with ovirt_proxy_fetch_api() or +ovirt_proxy_fetch_api_async() before calling this function. + + + an #OvirtApi instance used to interact with +oVirt REST API. + + + + + + + + + + Gets the list of remote VMs from the proxy object. +This method does not initiate any network activity, the remote VM list +must have been fetched with ovirt_proxy_fetch_vms() or +ovirt_proxy_fetch_vms_async() before calling this function. + + + the list of +#OvirtVm associated with #OvirtProxy. +The returned list should be freed with g_list_free(), and can become +invalid any time a #OvirtProxy call completes. + + + + + + + + + + + + Looks up a virtual machine whose name is @name. If it cannot be found, +NULL is returned. This method does not initiate any network activity, +the remote VM list must have been fetched with ovirt_proxy_fetch_vms() +or ovirt_proxy_fetch_vms_async() before calling this function. + + + a #OvirtVm whose name is @name or NULL + + + + + a #OvirtProxy + + + + name of the virtual machine to lookup + + + + + + Indicates whether to connect to the REST API as an admin, or as a regular user. +Different content will be shown for the same user depending on if they connect as +an admin or not. Connecting as an admin requires to have admin priviledges on the +oVirt instance. + + + + Path to a file containing the CA certificates to use for the HTTPS +REST API communication with the oVirt instance + + + + + + jsessionid cookie value. This allows to use the REST API without +authenticating first. This was used by oVirt 3.6 and is now replaced +by OvirtProxy:sso-token. + + + + Token to use for SSO. This allows to use the REST API without +authenticating first. This is used starting with oVirt 4.0. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + TRUE if the call was successful, FALSE otherwise. + +Sends an HTTP DELETE request to @resource. + +The calling thread is blocked until this request is processed, see +ovirt_resource_delete_async() for the asynchronous version of this method. + + + + + an #OvirtResource. + + + + an #OvirtProxy. + + + + + + Asynchronously send an HTTP DELETE request to @resource. + +When the call is complete, @callback will be invoked. You can then call +ovirt_resource_delete_finish() to get the result of the call. + + + + + + + an #OvirtResource. + + + + an #OvirtProxy. + + + + a #GCancellable or NULL. + + + + a #GAsyncReadyCallback to call when the call completes, or NULL +if you don't care about the result of the method invocation. + + + + data to pass to @callback. + + + + + + + + TRUE if the call was successful, FALSE otherwise. + +Finishes an asynchronous HTTP DELETE request on @resource. + + + + + an #OvirtResource. + + + + a #GAsyncResult. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets a #OvirtCollection representing the list of remote disks from a +storage domain object. This method does not initiate any network +activity, the remote file list must be then be fetched using +ovirt_collection_fetch() or ovirt_collection_fetch_async(). + - the list of #OvirtVm associated with #OvirtProxy. The returned list should not be freed nor modified, and can become invalid any time a #OvirtProxy call completes. - - - + a #OvirtCollection representing the list +of disks associated with @domain. + - - async method result - - + + a #OvirtStorageDomain + + - - Gets the list of remote VMs from the proxy object. -This method does not initiate any network activity, the remote VM list -must have been fetched with ovirt_proxy_fetch_vms() or -ovirt_proxy_fetch_vms_async() before calling this function. + + Gets a #OvirtCollection representing the list of remote files from a +storage domain object. This method does not initiate any network +activity, the remote file list must be then be fetched using +ovirt_collection_fetch() or ovirt_collection_fetch_async(). + - the list of #OvirtVm associated with #OvirtProxy. The returned list should not be freed nor modified, and can become invalid any time a #OvirtProxy call completes. - - - - - - - Looks up a virtual machine whose name is @name. If it cannot be found, -NULL is returned. This method does not initiate any network activity, -the remote VM list must have been fetched with ovirt_proxy_fetch_vms() -or ovirt_proxy_fetch_vms_async() before calling this function. - - a #OvirtVm whose name is @name or NULL - + a #OvirtCollection representing the list +of files associated with @domain. + - - name of the virtual machine to lookup - - + + a #OvirtStorageDomain + + - - + + - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + - + + - + + + + + + - - + + + c:identifier="OVIRT_STORAGE_DOMAIN_FORMAT_VERSION_V1"> - + c:identifier="OVIRT_STORAGE_DOMAIN_FORMAT_VERSION_V2"> - + c:identifier="OVIRT_STORAGE_DOMAIN_FORMAT_VERSION_V3"> + + + + - - - - - - + + - - + + + c:identifier="OVIRT_STORAGE_DOMAIN_STATE_ACTIVE"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets a #OvirtCollection representing the list of remote cdroms from a +virtual machine object. This method does not initiate any network +activity, the remote cdrom list must be then be fetched using +ovirt_collection_fetch() or ovirt_collection_fetch_async(). + + + a #OvirtCollection representing the list +of cdroms associated with @vm. + + + + + a #OvirtVm + + + + + + Gets a #OvirtCluster representing the cluster the virtual machine belongs +to. This method does not initiate any network activity, the remote host must +be then be fetched using ovirt_resource_refresh() or +ovirt_resource_refresh_async(). + + + a #OvirtCluster representing cluster the @vm +belongs to. + + + + + a #OvirtVm + + + + + + Gets a #OvirtHost representing the host the virtual machine belongs to. +This method does not initiate any network activity, the remote host must be +then be fetched using ovirt_resource_refresh() or +ovirt_resource_refresh_async(). + + + a #OvirtHost representing host the @vm +belongs to. + + + + + a #OvirtVm + + + + + + + + + + + + - + @@ -267,46 +2772,113 @@ or ovirt_proxy_fetch_vms_async() before calling this function. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -314,46 +2886,63 @@ or ovirt_proxy_fetch_vms_async() before calling this function. + + + + + + + + + + + + - + @@ -361,43 +2950,67 @@ or ovirt_proxy_fetch_vms_async() before calling this function. + + + + + + + + + + - - + + - - + + - - - - - + + - + + - + - + @@ -409,31 +3022,96 @@ or ovirt_proxy_fetch_vms_async() before calling this function. glib:type-name="OvirtVmDisplay" glib:get-type="ovirt_vm_display_get_type" glib:type-struct="VmDisplayClass"> + + + + + + + + + + + + + - - + + - - + + - - + + + + + + + + + + + + + + + + + + + - - + + - - + + - - + + - - + + @@ -445,69 +3123,261 @@ or ovirt_proxy_fetch_vms_async() before calling this function. + - + + disguised="1" + opaque="1"> + - - + + + - + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + + + + + + + + + - + + c:identifier="OVIRT_VM_STATE_REBOOTING"> + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + a #GOptionGroup for the commandline +arguments specific to libgovirt. You have to call +ovirt_set_proxy_options() after to set the options on a +#OvirtProxy. + + + + c:identifier="ovirt_rest_call_error_quark"> + + Set various properties on @proxy, according to the commandline +arguments given to ovirt_get_option_group() option group. + + + + + + + a #OvirtProxy to set options upon + + + + diff --git a/girs/Goa-1.0.gir b/girs/Goa-1.0.gir index d976ef504..9353f91ae 100644 --- a/girs/Goa-1.0.gir +++ b/girs/Goa-1.0.gir @@ -3420,7 +3420,9 @@ See goa_account_proxy_new() for the asynchronous version of this constructor. - + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Account.top_of_page">org.gnome.OnlineAccounts.Account</link>. See g_dbus_proxy_new() for more details. @@ -3493,7 +3495,8 @@ See goa_account_proxy_new_sync() for the synchronous, blocking version of this c + c:identifier="goa_account_proxy_new_for_bus" + glib:finish-func="new_for_bus_finish"> Like goa_account_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -4379,7 +4382,9 @@ See goa_calendar_proxy_new() for the asynchronous version of this constructor. - + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Calendar.top_of_page">org.gnome.OnlineAccounts.Calendar</link>. See g_dbus_proxy_new() for more details. @@ -4452,7 +4457,8 @@ See goa_calendar_proxy_new_sync() for the synchronous, blocking version of this + c:identifier="goa_calendar_proxy_new_for_bus" + glib:finish-func="new_for_bus_finish"> Like goa_calendar_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -4836,7 +4842,9 @@ See goa_chat_proxy_new() for the asynchronous version of this constructor. - + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Chat.top_of_page">org.gnome.OnlineAccounts.Chat</link>. See g_dbus_proxy_new() for more details. @@ -4908,7 +4916,9 @@ See goa_chat_proxy_new_sync() for the synchronous, blocking version of this cons - + Like goa_chat_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -5121,7 +5131,9 @@ g_object_unref() when done with it. - + Asynchronously gets a #GoaClient. When the operation is @@ -5819,7 +5831,9 @@ See goa_contacts_proxy_new() for the asynchronous version of this constructor. - + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Contacts.top_of_page">org.gnome.OnlineAccounts.Contacts</link>. See g_dbus_proxy_new() for more details. @@ -5892,7 +5906,8 @@ See goa_contacts_proxy_new_sync() for the synchronous, blocking version of this + c:identifier="goa_contacts_proxy_new_for_bus" + glib:finish-func="new_for_bus_finish"> Like goa_contacts_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -6369,7 +6384,8 @@ See goa_documents_proxy_new() for the asynchronous version of this constructor.< + deprecated="1" + glib:finish-func="new_finish"> Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Documents.top_of_page">org.gnome.OnlineAccounts.Documents</link>. See g_dbus_proxy_new() for more details. @@ -6444,7 +6460,8 @@ See goa_documents_proxy_new_sync() for the synchronous, blocking version of this + deprecated="1" + glib:finish-func="new_for_bus_finish"> Like goa_documents_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -7258,7 +7275,8 @@ See goa_exchange_proxy_new() for the asynchronous version of this constructor. + version="3.6.0" + glib:finish-func="new_finish"> Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Exchange.top_of_page">org.gnome.OnlineAccounts.Exchange</link>. See g_dbus_proxy_new() for more details. @@ -7332,7 +7350,8 @@ See goa_exchange_proxy_new_sync() for the synchronous, blocking version of this + version="3.6.0" + glib:finish-func="new_for_bus_finish"> Like goa_exchange_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -8062,7 +8081,10 @@ See goa_files_proxy_new() for the asynchronous version of this constructor. - + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Files.top_of_page">org.gnome.OnlineAccounts.Files</link>. See g_dbus_proxy_new() for more details. @@ -8136,7 +8158,8 @@ See goa_files_proxy_new_sync() for the synchronous, blocking version of this con + version="3.8.0" + glib:finish-func="new_for_bus_finish"> Like goa_files_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -9663,7 +9686,7 @@ linked against at application run time. - + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Mail.top_of_page">org.gnome.OnlineAccounts.Mail</link>. See g_dbus_proxy_new() for more details. @@ -12247,7 +12272,9 @@ See goa_mail_proxy_new_sync() for the synchronous, blocking version of this cons - + Like goa_mail_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -13238,7 +13265,9 @@ See goa_manager_proxy_new() for the asynchronous version of this constructor. - + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Manager.top_of_page">org.gnome.OnlineAccounts.Manager</link>. See g_dbus_proxy_new() for more details. @@ -13311,7 +13340,8 @@ See goa_manager_proxy_new_sync() for the synchronous, blocking version of this c + c:identifier="goa_manager_proxy_new_for_bus" + glib:finish-func="new_for_bus_finish"> Like goa_manager_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -13726,7 +13756,8 @@ See goa_maps_proxy_new() for the asynchronous version of this constructor. + deprecated="1" + glib:finish-func="new_finish"> Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Maps.top_of_page">org.gnome.OnlineAccounts.Maps</link>. See g_dbus_proxy_new() for more details. @@ -13802,7 +13833,8 @@ See goa_maps_proxy_new_sync() for the synchronous, blocking version of this cons + deprecated="1" + glib:finish-func="new_for_bus_finish"> Like goa_maps_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -14509,7 +14541,8 @@ See goa_media_server_proxy_new() for the asynchronous version of this constructo + deprecated="1" + glib:finish-func="new_finish"> Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-MediaServer.top_of_page">org.gnome.OnlineAccounts.MediaServer</link>. See g_dbus_proxy_new() for more details. @@ -14585,7 +14618,8 @@ See goa_media_server_proxy_new_sync() for the synchronous, blocking version of t + deprecated="1" + glib:finish-func="new_for_bus_finish"> Like goa_media_server_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -14994,7 +15028,10 @@ See goa_music_proxy_new() for the asynchronous version of this constructor. - + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Music.top_of_page">org.gnome.OnlineAccounts.Music</link>. See g_dbus_proxy_new() for more details. @@ -15068,7 +15105,8 @@ See goa_music_proxy_new_sync() for the synchronous, blocking version of this con + version="3.18.0" + glib:finish-func="new_for_bus_finish"> Like goa_music_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -16138,7 +16176,9 @@ See goa_oauth2_based_proxy_new() for the asynchronous version of this constructo - + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-OAuth2Based.top_of_page">org.gnome.OnlineAccounts.OAuth2Based</link>. See g_dbus_proxy_new() for more details. @@ -16211,7 +16251,8 @@ See goa_oauth2_based_proxy_new_sync() for the synchronous, blocking version of t + c:identifier="goa_oauth2_based_proxy_new_for_bus" + glib:finish-func="new_for_bus_finish"> Like goa_oauth2_based_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -17162,7 +17203,9 @@ See goa_oauth_based_proxy_new() for the asynchronous version of this constructor - + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-OAuthBased.top_of_page">org.gnome.OnlineAccounts.OAuthBased</link>. See g_dbus_proxy_new() for more details. @@ -17235,7 +17278,8 @@ See goa_oauth_based_proxy_new_sync() for the synchronous, blocking version of th + c:identifier="goa_oauth_based_proxy_new_for_bus" + glib:finish-func="new_for_bus_finish"> Like goa_oauth_based_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -18934,7 +18978,9 @@ See goa_object_manager_client_new() for the asynchronous version of this constru - + Asynchronously creates #GDBusObjectManagerClient using goa_object_manager_client_get_proxy_type() as the #GDBusProxyTypeFunc. See g_dbus_object_manager_client_new() for more details. @@ -19008,7 +19054,8 @@ See goa_object_manager_client_new_sync() for the synchronous, blocking version o + c:identifier="goa_object_manager_client_new_for_bus" + glib:finish-func="new_for_bus_finish"> Like goa_object_manager_client_new() but takes a #GBusType instead of a #GDBusConnection. @@ -20512,7 +20559,8 @@ See goa_password_based_proxy_new() for the asynchronous version of this construc + version="3.6.0" + glib:finish-func="new_finish"> Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-PasswordBased.top_of_page">org.gnome.OnlineAccounts.PasswordBased</link>. See g_dbus_proxy_new() for more details. @@ -20586,7 +20634,8 @@ See goa_password_based_proxy_new_sync() for the synchronous, blocking version of + version="3.6.0" + glib:finish-func="new_for_bus_finish"> Like goa_password_based_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -20986,7 +21035,10 @@ See goa_photos_proxy_new() for the asynchronous version of this constructor. - + Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Photos.top_of_page">org.gnome.OnlineAccounts.Photos</link>. See g_dbus_proxy_new() for more details. @@ -21060,7 +21112,8 @@ See goa_photos_proxy_new_sync() for the synchronous, blocking version of this co + version="3.8.0" + glib:finish-func="new_for_bus_finish"> Like goa_photos_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -21479,7 +21532,8 @@ See goa_printers_proxy_new() for the asynchronous version of this constructor. + deprecated="1" + glib:finish-func="new_finish"> Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Printers.top_of_page">org.gnome.OnlineAccounts.Printers</link>. See g_dbus_proxy_new() for more details. @@ -21555,7 +21609,8 @@ See goa_printers_proxy_new_sync() for the synchronous, blocking version of this + deprecated="1" + glib:finish-func="new_for_bus_finish"> Like goa_printers_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -22056,7 +22111,8 @@ See goa_read_later_proxy_new() for the asynchronous version of this constructor. + deprecated="1" + glib:finish-func="new_finish"> Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-ReadLater.top_of_page">org.gnome.OnlineAccounts.ReadLater</link>. See g_dbus_proxy_new() for more details. @@ -22132,7 +22188,8 @@ See goa_read_later_proxy_new_sync() for the synchronous, blocking version of thi + deprecated="1" + glib:finish-func="new_for_bus_finish"> Like goa_read_later_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -23033,7 +23090,8 @@ See goa_ticketing_proxy_new() for the asynchronous version of this constructor.< + version="3.6.0" + glib:finish-func="new_finish"> Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Ticketing.top_of_page">org.gnome.OnlineAccounts.Ticketing</link>. See g_dbus_proxy_new() for more details. @@ -23107,7 +23165,8 @@ See goa_ticketing_proxy_new_sync() for the synchronous, blocking version of this + version="3.6.0" + glib:finish-func="new_for_bus_finish"> Like goa_ticketing_proxy_new() but takes a #GBusType instead of a #GDBusConnection. @@ -23527,7 +23586,8 @@ See goa_todo_proxy_new() for the asynchronous version of this constructor. + deprecated="1" + glib:finish-func="new_finish"> Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-gnome-OnlineAccounts-Todo.top_of_page">org.gnome.OnlineAccounts.Todo</link>. See g_dbus_proxy_new() for more details. @@ -23603,7 +23663,8 @@ See goa_todo_proxy_new_sync() for the synchronous, blocking version of this cons + deprecated="1" + glib:finish-func="new_for_bus_finish"> Like goa_todo_proxy_new() but takes a #GBusType instead of a #GDBusConnection. diff --git a/girs/GooCanvas-2.0.gir b/girs/GooCanvas-2.0.gir index 0488e3b78..f8e5f1d64 100644 --- a/girs/GooCanvas-2.0.gir +++ b/girs/GooCanvas-2.0.gir @@ -686,22 +686,26 @@ See the #cairo_antialias_t documentation. + glib:nick="default" + glib:name="CAIRO_ANTIALIAS_DEFAULT"> + glib:nick="none" + glib:name="CAIRO_ANTIALIAS_NONE"> + glib:nick="gray" + glib:name="CAIRO_ANTIALIAS_GRAY"> + glib:nick="subpixel" + glib:name="CAIRO_ANTIALIAS_SUBPIXEL"> + glib:nick="winding" + glib:name="CAIRO_FILL_RULE_WINDING"> + glib:nick="even-odd" + glib:name="CAIRO_FILL_RULE_EVEN_ODD"> + glib:nick="default" + glib:name="CAIRO_HINT_METRICS_DEFAULT"> + glib:nick="off" + glib:name="CAIRO_HINT_METRICS_OFF"> + glib:nick="on" + glib:name="CAIRO_HINT_METRICS_ON"> + glib:nick="butt" + glib:name="CAIRO_LINE_CAP_BUTT"> + glib:nick="round" + glib:name="CAIRO_LINE_CAP_ROUND"> + glib:nick="square" + glib:name="CAIRO_LINE_CAP_SQUARE"> + glib:nick="miter" + glib:name="CAIRO_LINE_JOIN_MITER"> + glib:nick="round" + glib:name="CAIRO_LINE_JOIN_ROUND"> + glib:nick="bevel" + glib:name="CAIRO_LINE_JOIN_BEVEL"> + glib:nick="clear" + glib:name="CAIRO_OPERATOR_CLEAR"> + glib:nick="source" + glib:name="CAIRO_OPERATOR_SOURCE"> + glib:nick="over" + glib:name="CAIRO_OPERATOR_OVER"> + glib:nick="in" + glib:name="CAIRO_OPERATOR_IN"> + glib:nick="out" + glib:name="CAIRO_OPERATOR_OUT"> + glib:nick="atop" + glib:name="CAIRO_OPERATOR_ATOP"> + glib:nick="dest" + glib:name="CAIRO_OPERATOR_DEST"> + glib:nick="dest-over" + glib:name="CAIRO_OPERATOR_DEST_OVER"> + glib:nick="dest-in" + glib:name="CAIRO_OPERATOR_DEST_IN"> + glib:nick="dest-out" + glib:name="CAIRO_OPERATOR_DEST_OUT"> + glib:nick="dest-atop" + glib:name="CAIRO_OPERATOR_DEST_ATOP"> + glib:nick="xor" + glib:name="CAIRO_OPERATOR_XOR"> + glib:nick="add" + glib:name="CAIRO_OPERATOR_ADD"> + glib:nick="saturate" + glib:name="CAIRO_OPERATOR_SATURATE"> - + Gets the current scale of the canvas. @@ -2154,10 +2185,7 @@ same way that ordinary item models are added to the root item model. line="3546">the events to receive during the grab. - + the cursor to display during the grab, or NULL. @@ -2499,7 +2527,9 @@ of items in the model. Any current canvas items will be removed. - + Sets the scale of the canvas. @@ -2667,16 +2697,23 @@ new bounds so the display is updated correctly. - + - + + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="0"> + transfer-ownership="none" + default-value="TRUE"> - + - + - + + transfer-ownership="none" + default-value="FALSE"> - + - + - + - + - + - + - + - + - + - + @@ -2914,7 +2995,8 @@ a particular anchor point. + glib:nick="center" + glib:name="GOO_CANVAS_ANCHOR_CENTER"> the anchor is in the center of the object. @@ -2922,7 +3004,8 @@ a particular anchor point. + glib:nick="north" + glib:name="GOO_CANVAS_ANCHOR_NORTH"> the anchor is at the top of the object, centered horizontally. @@ -2930,7 +3013,8 @@ a particular anchor point. + glib:nick="north-west" + glib:name="GOO_CANVAS_ANCHOR_NORTH_WEST"> the anchor is at the top-left of the object. @@ -2938,7 +3022,8 @@ a particular anchor point. + glib:nick="north-east" + glib:name="GOO_CANVAS_ANCHOR_NORTH_EAST"> the anchor is at the top-right of the object. @@ -2946,7 +3031,8 @@ a particular anchor point. + glib:nick="south" + glib:name="GOO_CANVAS_ANCHOR_SOUTH"> the anchor is at the bottom of the object, centered horizontally. @@ -2954,7 +3040,8 @@ a particular anchor point. + glib:nick="south-west" + glib:name="GOO_CANVAS_ANCHOR_SOUTH_WEST"> the anchor is at the bottom-left of the object. @@ -2962,7 +3049,8 @@ a particular anchor point. + glib:nick="south-east" + glib:name="GOO_CANVAS_ANCHOR_SOUTH_EAST"> the anchor is at the bottom-right of the object. @@ -2970,7 +3058,8 @@ a particular anchor point. + glib:nick="west" + glib:name="GOO_CANVAS_ANCHOR_WEST"> the anchor is on the left of the object, centered vertically. @@ -2978,7 +3067,8 @@ a particular anchor point. + glib:nick="east" + glib:name="GOO_CANVAS_ANCHOR_EAST"> the anchor is on the right of the object, centered vertically. @@ -2986,7 +3076,8 @@ a particular anchor point. + glib:nick="n" + glib:name="GOO_CANVAS_ANCHOR_N"> see GOO_CANVAS_ANCHOR_NORTH. @@ -2994,7 +3085,8 @@ a particular anchor point. + glib:nick="nw" + glib:name="GOO_CANVAS_ANCHOR_NW"> see GOO_CANVAS_ANCHOR_NORTH_WEST. @@ -3002,7 +3094,8 @@ a particular anchor point. + glib:nick="ne" + glib:name="GOO_CANVAS_ANCHOR_NE"> see GOO_CANVAS_ANCHOR_NORTH_EAST. @@ -3010,7 +3103,8 @@ a particular anchor point. + glib:nick="s" + glib:name="GOO_CANVAS_ANCHOR_S"> see GOO_CANVAS_ANCHOR_SOUTH. @@ -3018,7 +3112,8 @@ a particular anchor point. + glib:nick="sw" + glib:name="GOO_CANVAS_ANCHOR_SW"> see GOO_CANVAS_ANCHOR_SOUTH_WEST. @@ -3026,7 +3121,8 @@ a particular anchor point. + glib:nick="se" + glib:name="GOO_CANVAS_ANCHOR_SE"> see GOO_CANVAS_ANCHOR_SOUTH_EAST. @@ -3034,7 +3130,8 @@ a particular anchor point. + glib:nick="w" + glib:name="GOO_CANVAS_ANCHOR_W"> see GOO_CANVAS_ANCHOR_WEST. @@ -3042,7 +3139,8 @@ a particular anchor point. + glib:nick="e" + glib:name="GOO_CANVAS_ANCHOR_E"> see GOO_CANVAS_ANCHOR_EAST. @@ -3059,7 +3157,8 @@ animation is reached. + glib:nick="freeze" + glib:name="GOO_CANVAS_ANIMATE_FREEZE"> the item remains in the final position. @@ -3067,7 +3166,8 @@ animation is reached. + glib:nick="reset" + glib:name="GOO_CANVAS_ANIMATE_RESET"> the item is moved back to the initial position. @@ -3075,7 +3175,8 @@ animation is reached. + glib:nick="restart" + glib:name="GOO_CANVAS_ANIMATE_RESTART"> the animation is restarted from the initial @@ -3084,7 +3185,8 @@ animation is reached. + glib:nick="bounce" + glib:name="GOO_CANVAS_ANIMATE_BOUNCE"> the animation bounces back and forth between the @@ -3339,28 +3441,52 @@ It is drawn with a red outline with a width of 5.0 and filled with blue: - + - + - + - + - + - + - + - + @@ -3523,28 +3649,52 @@ It is drawn with a red outline with a width of 5.0 and filled with blue: - + - + - + - + - + - + - + - + @@ -3739,7 +3889,8 @@ Here's an example showing how to create a grid: + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="0"> @@ -3765,16 +3917,23 @@ Here's an example showing how to create a grid: transfer-ownership="none"> - + - + + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="0"> + transfer-ownership="none" + default-value="-1.000000"> + transfer-ownership="none" + default-value="TRUE"> + transfer-ownership="none" + default-value="TRUE"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="0"> + transfer-ownership="none" + default-value="-1.000000"> + transfer-ownership="none" + default-value="FALSE"> - + - + - + - + - + - + - + @@ -4130,7 +4318,8 @@ Here's an example showing how to create a grid: + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="0"> @@ -4152,16 +4342,23 @@ Here's an example showing how to create a grid: transfer-ownership="none"> - + - + + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="0"> + transfer-ownership="none" + default-value="-1.000000"> + transfer-ownership="none" + default-value="TRUE"> + transfer-ownership="none" + default-value="TRUE"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="0"> + transfer-ownership="none" + default-value="-1.000000"> + transfer-ownership="none" + default-value="FALSE"> - + - + - + - + - + - + - + @@ -4369,16 +4595,28 @@ g_object_get() and g_object_set(). - + - + - + - + @@ -4494,16 +4732,28 @@ to the signal handlers of the corresponding #GooCanvasGroup objects. - + - + - + - + @@ -4654,10 +4904,16 @@ This example creates an image scaled to a size of 200x200: - + - + @@ -4669,16 +4925,28 @@ This example creates an image scaled to a size of 200x200: transfer-ownership="none"> - + - + - + - + @@ -4850,10 +5118,16 @@ This example creates an image scaled to a size of 200x200: - + - + @@ -4865,16 +5139,28 @@ This example creates an image scaled to a size of 200x200: transfer-ownership="none"> - + - + - + - + @@ -5009,7 +5295,7 @@ items, specifically layout container items such as #GooCanvasTable. It returns all child properties of a canvas item class. - + a newly allocated @@ -6703,7 +6989,9 @@ It gets the items at the given point. - + Gets the parent of the given item. @@ -6930,7 +7218,8 @@ its parent's style. + c:identifier="goo_canvas_item_get_transform" + glib:get-property="transform"> Gets the transformation matrix of an item. @@ -7474,7 +7763,9 @@ Containers should also pass on any changes in their own status to children. - + This function is only intended to be used when implementing new canvas @@ -7571,7 +7862,8 @@ To do that use the #GooCanvasItem:parent property. + c:identifier="goo_canvas_item_set_transform" + glib:set-property="transform"> Sets the transformation matrix of an item. @@ -7756,22 +8048,41 @@ Updates the item, if needed, and any children. - + - + - + - + - + - + The tooltip to display for the item, or %NULL to display no tooltip. @@ -7781,15 +8092,23 @@ Note that this property has no effect unless the containing this item. - + - + + transfer-ownership="none" + default-value="0.000000"> @@ -9419,7 +9738,7 @@ It returns all child properties of a canvas item class. line="1155"> a newly allocated array of #GParamSpec*. The array must be freed with g_free(). - + @@ -10140,7 +10459,8 @@ and rotation. + c:identifier="goo_canvas_item_model_get_parent" + glib:get-property="parent"> Gets the parent of the given model. @@ -10231,7 +10551,8 @@ return its parent's style. + c:identifier="goo_canvas_item_model_get_transform" + glib:get-property="transform"> Gets the transformation matrix of an item model. @@ -10570,7 +10891,8 @@ origin. + c:identifier="goo_canvas_item_model_set_parent" + glib:set-property="parent"> This function is only intended to be used when implementing new canvas @@ -10667,7 +10989,8 @@ To do that use the #GooCanvasItemModel:parent property. + c:identifier="goo_canvas_item_model_set_transform" + glib:set-property="transform"> Sets the transformation matrix of an item model. @@ -10814,33 +11137,60 @@ position. - + - + - + - + - + - + - + - + + transfer-ownership="none" + default-value="0.000000"> @@ -11480,16 +11830,23 @@ create_item() method of the #GooCanvasItemModel interface, to create the default canvas item to view the item model. - + - + + transfer-ownership="none" + default-value="NULL"> The sequence of commands describing the clip path of the item, specified @@ -11501,7 +11858,8 @@ Graphics (SVG)</ulink> path element. + transfer-ownership="none" + default-value="NULL"> transfer-ownership="none"> - + @@ -11521,42 +11882,65 @@ Graphics (SVG)</ulink> path element. transfer-ownership="none"> - + - + - + - + - + + transfer-ownership="none" + default-value="10.000000"> - + - + + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="0"> @@ -11833,7 +12218,8 @@ doesn't have its own style it uses the parent item's style. + c:identifier="goo_canvas_item_simple_get_line_width" + glib:get-property="line-width"> Gets the item's line width. @@ -12011,16 +12397,23 @@ needed. - + - + + transfer-ownership="none" + default-value="NULL"> The sequence of commands describing the clip path of the item, specified @@ -12032,7 +12425,8 @@ Graphics (SVG)</ulink> path element. + transfer-ownership="none" + default-value="NULL"> line="275">The color to use to paint the interior of the item, specified as a GdkRGBA. To disable painting set the 'fill-pattern' property to NULL. - + @@ -12056,42 +12453,66 @@ Graphics (SVG)</ulink> path element. transfer-ownership="none"> - + - + - + - + - + + transfer-ownership="none" + default-value="10.000000"> - + - + + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="0"> @@ -12388,7 +12810,8 @@ item is visible. + glib:nick="hidden" + glib:name="GOO_CANVAS_ITEM_HIDDEN"> the item is invisible, and is not allocated any @@ -12397,7 +12820,8 @@ item is visible. + glib:nick="invisible" + glib:name="GOO_CANVAS_ITEM_INVISIBLE"> the item is invisible, but it is still allocated @@ -12406,7 +12830,8 @@ item is visible. + glib:nick="visible" + glib:name="GOO_CANVAS_ITEM_VISIBLE"> the item is visible. @@ -12414,7 +12839,8 @@ item is visible. + glib:nick="visible-above-threshold" + glib:name="GOO_CANVAS_ITEM_VISIBLE_ABOVE_THRESHOLD"> the item is visible when the @@ -12677,7 +13103,8 @@ quarter missing: + transfer-ownership="none" + default-value="NULL"> The sequence of path commands, specified as a string using the same syntax @@ -12685,16 +13112,28 @@ as in the <ulink url="http://www.w3.org/Graphics/SVG/">Scalable Vector Graphics (SVG)</ulink> path element. - + - + - + - + @@ -12838,7 +13277,8 @@ Scalable Vector Graphics (SVG) specification</ulink> for more details. + glib:nick="move-to" + glib:name="GOO_CANVAS_PATH_MOVE_TO"> move to the given point. @@ -12846,7 +13286,8 @@ Scalable Vector Graphics (SVG) specification</ulink> for more details. + glib:nick="close-path" + glib:name="GOO_CANVAS_PATH_CLOSE_PATH"> close the current path, drawing a line from the @@ -12855,7 +13296,8 @@ Scalable Vector Graphics (SVG) specification</ulink> for more details. + glib:nick="line-to" + glib:name="GOO_CANVAS_PATH_LINE_TO"> draw a line to the given point. @@ -12863,7 +13305,8 @@ Scalable Vector Graphics (SVG) specification</ulink> for more details. + glib:nick="horizontal-line-to" + glib:name="GOO_CANVAS_PATH_HORIZONTAL_LINE_TO"> draw a horizontal line to the given @@ -12872,7 +13315,8 @@ Scalable Vector Graphics (SVG) specification</ulink> for more details. + glib:nick="vertical-line-to" + glib:name="GOO_CANVAS_PATH_VERTICAL_LINE_TO"> draw a vertical line to the given y @@ -12881,7 +13325,8 @@ Scalable Vector Graphics (SVG) specification</ulink> for more details. + glib:nick="curve-to" + glib:name="GOO_CANVAS_PATH_CURVE_TO"> draw a bezier curve using two control @@ -12890,7 +13335,8 @@ Scalable Vector Graphics (SVG) specification</ulink> for more details. + glib:nick="smooth-curve-to" + glib:name="GOO_CANVAS_PATH_SMOOTH_CURVE_TO"> draw a bezier curve using a reflection @@ -12900,7 +13346,8 @@ Scalable Vector Graphics (SVG) specification</ulink> for more details. + glib:nick="quadratic-curve-to" + glib:name="GOO_CANVAS_PATH_QUADRATIC_CURVE_TO"> draw a quadratic bezier curve using @@ -12909,7 +13356,8 @@ Scalable Vector Graphics (SVG) specification</ulink> for more details. + glib:nick="smooth-quadratic-curve-to" + glib:name="GOO_CANVAS_PATH_SMOOTH_QUADRATIC_CURVE_TO"> draw a quadratic bezier curve @@ -12919,7 +13367,8 @@ Scalable Vector Graphics (SVG) specification</ulink> for more details. + glib:nick="elliptical-arc" + glib:name="GOO_CANVAS_PATH_ELLIPTICAL_ARC"> draw an elliptical arc, using the given @@ -13040,19 +13489,32 @@ quarter missing: + transfer-ownership="none" + default-value="NULL"> - + - + - + - + @@ -13113,7 +13575,8 @@ quarter missing: + glib:nick="visible-mask" + glib:name="GOO_CANVAS_EVENTS_VISIBLE_MASK"> a mask indicating that the item only @@ -13122,7 +13585,8 @@ quarter missing: + glib:nick="painted-mask" + glib:name="GOO_CANVAS_EVENTS_PAINTED_MASK"> a mask indicating that the item only @@ -13131,7 +13595,8 @@ quarter missing: + glib:nick="fill-mask" + glib:name="GOO_CANVAS_EVENTS_FILL_MASK"> a mask indicating that the filled part of @@ -13140,7 +13605,8 @@ quarter missing: + glib:nick="stroke-mask" + glib:name="GOO_CANVAS_EVENTS_STROKE_MASK"> a mask indicating that the stroked part @@ -13149,7 +13615,8 @@ quarter missing: + glib:nick="none" + glib:name="GOO_CANVAS_EVENTS_NONE"> the item doesn't receive events at all. @@ -13157,7 +13624,8 @@ quarter missing: + glib:nick="visible-painted" + glib:name="GOO_CANVAS_EVENTS_VISIBLE_PAINTED"> the item receives events in its @@ -13166,7 +13634,8 @@ quarter missing: + glib:nick="visible-fill" + glib:name="GOO_CANVAS_EVENTS_VISIBLE_FILL"> the item's interior receives events @@ -13175,7 +13644,8 @@ quarter missing: + glib:nick="visible-stroke" + glib:name="GOO_CANVAS_EVENTS_VISIBLE_STROKE"> the item's perimeter receives @@ -13184,7 +13654,8 @@ quarter missing: + glib:nick="visible" + glib:name="GOO_CANVAS_EVENTS_VISIBLE"> the item receives events when it is visible, @@ -13193,7 +13664,8 @@ quarter missing: + glib:nick="painted" + glib:name="GOO_CANVAS_EVENTS_PAINTED"> the item receives events in its painted areas, @@ -13202,7 +13674,8 @@ quarter missing: + glib:nick="fill" + glib:name="GOO_CANVAS_EVENTS_FILL"> the item's interior receives events, whether it @@ -13211,7 +13684,8 @@ quarter missing: + glib:nick="stroke" + glib:name="GOO_CANVAS_EVENTS_STROKE"> the item's perimeter receives events, whether @@ -13220,7 +13694,8 @@ quarter missing: + glib:nick="all" + glib:name="GOO_CANVAS_EVENTS_ALL"> the item's perimeter and interior receive events, @@ -13540,37 +14015,67 @@ Here's an example showing how to create a line from (100,100) to (300,300). - + - + - + - + - + - + - + - + - + - + @@ -13827,37 +14332,67 @@ Here's an example showing how to create a line from (100,100) to (300,300). - + - + - + - + - + - + - + - + - + - + @@ -13997,22 +14532,40 @@ width of 200 and a height of 100. - + - + - + - + - + - + @@ -14176,22 +14729,40 @@ width of 200 and a height of 100. - + - + - + - + - + - + @@ -14643,34 +15214,52 @@ a triangle in it: - + + transfer-ownership="none" + default-value="FALSE"> - + + transfer-ownership="none" + default-value="0.000000"> - + + transfer-ownership="none" + default-value="0.000000"> - + - + @@ -14762,7 +15351,8 @@ a triangle in it: + disguised="1" + opaque="1"> - + + transfer-ownership="none" + default-value="FALSE"> - + + transfer-ownership="none" + default-value="0.000000"> - + + transfer-ownership="none" + default-value="0.000000"> - + - + @@ -15090,34 +15698,64 @@ in a layout container such as #GooCanvasTable. - + - + - + - + - + - + - + - + - + - + @@ -15301,34 +15939,64 @@ of the text box placed at (500,500): - + - + - + - + - + - + - + - + - + - + @@ -15484,22 +16152,37 @@ Here's an example showing how to create an entry widget centered at (100.0, - + - + - + - + - + @@ -16104,7 +16787,7 @@ items, specifically layout container items such as #GooCanvasTable. It returns all child properties of a canvas item class. - + a newly allocated @@ -16216,7 +16899,7 @@ It returns all child properties of a canvas item class. line="1155"> a newly allocated array of #GParamSpec*. The array must be freed with g_free(). - + diff --git a/girs/Granite-1.0.gir b/girs/Granite-1.0.gir index c91d96087..1a017a649 100644 --- a/girs/Granite-1.0.gir +++ b/girs/Granite-1.0.gir @@ -1,5 +1,5 @@ - + @@ -388,7 +388,7 @@ - + @@ -398,7 +398,7 @@ - + @@ -817,7 +817,7 @@ - + @@ -1756,7 +1756,7 @@ - + @@ -7744,7 +7744,7 @@ - + diff --git a/girs/Granite-7.0.gir b/girs/Granite-7.0.gir index ca465d69b..f146a35d2 100644 --- a/girs/Granite-7.0.gir +++ b/girs/Granite-7.0.gir @@ -1,5 +1,5 @@ - + @@ -1122,6 +1122,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2168,6 +2194,16 @@ + + + + + + + + + + diff --git a/girs/Graphene-1.0.gir b/girs/Graphene-1.0.gir index 4eb44f189..f615a6297 100644 --- a/girs/Graphene-1.0.gir +++ b/girs/Graphene-1.0.gir @@ -889,7 +889,7 @@ The returned value is owned by Graphene and should not be modified or freed. + line="137"/> @@ -899,17 +899,7 @@ The returned value is owned by Graphene and should not be modified or freed. - - - - - - - + line="203"/> @@ -919,7 +909,7 @@ The returned value is owned by Graphene and should not be modified or freed. + line="143"/> @@ -929,7 +919,7 @@ The returned value is owned by Graphene and should not be modified or freed. + line="158"/> @@ -939,7 +929,7 @@ The returned value is owned by Graphene and should not be modified or freed. + line="173"/> @@ -949,7 +939,7 @@ The returned value is owned by Graphene and should not be modified or freed. + line="188"/> @@ -2180,7 +2170,7 @@ The algorithm for decomposing a matrix is taken from the [CSS3 Transforms specification](http://dev.w3.org/csswg/css-transforms/); specifically, the decomposition code is based on the equivalent code published in "Graphics Gems II", edited by Jim Arvo, and -[available online](http://web.archive.org/web/20150512160205/http://tog.acm.org/resources/GraphicsGems/gemsii/unmatrix.c). +[available online](http://tog.acm.org/resources/GraphicsGems/gemsii/unmatrix.c). - - Computes the squared distance between @a and @b. - - - the distance between the two points, squared - - - - - a #graphene_point_t - - - - a #graphene_point_t - - - - version="1.0"> Linearly interpolates the coordinates of @a and @b using the + line="260">Linearly interpolates the coordinates of @a and @b using the given @factor. - + @@ -5294,19 +5256,19 @@ given @factor. a #graphene_point_t + line="262">a #graphene_point_t a #graphene_point_t + line="263">a #graphene_point_t the linear interpolation factor + line="264">the linear interpolation factor transfer-ownership="none"> return location for the interpolated + line="265">return location for the interpolated point @@ -5324,32 +5286,32 @@ given @factor. Checks whether the two points @a and @b are within + line="231">Checks whether the two points @a and @b are within the threshold of @epsilon. - + `true` if the distance is within @epsilon + line="240">`true` if the distance is within @epsilon a #graphene_point_t + line="233">a #graphene_point_t a #graphene_point_t + line="234">a #graphene_point_t threshold between the two points + line="235">threshold between the two points @@ -5359,9 +5321,9 @@ the threshold of @epsilon. version="1.4"> Stores the coordinates of the given #graphene_point_t into a + line="283">Stores the coordinates of the given #graphene_point_t into a #graphene_vec2_t. - + @@ -5369,7 +5331,7 @@ the threshold of @epsilon. a #graphene_point_t + line="285">a #graphene_point_t transfer-ownership="none"> return location for the vertex + line="286">return location for the vertex @@ -5386,12 +5348,12 @@ the threshold of @epsilon. Returns a point fixed at (0, 0). - + line="302">Returns a point fixed at (0, 0). + a fixed point + line="307">a fixed point @@ -7061,14 +7023,14 @@ be modified directly. version="1.4"> Allocates a new #graphene_ray_t structure. + line="60">Allocates a new #graphene_ray_t structure. The contents of the returned structure are undefined. the newly allocated #graphene_ray_t. + line="67">the newly allocated #graphene_ray_t. Use graphene_ray_free() to free the resources allocated by this function @@ -7077,25 +7039,25 @@ The contents of the returned structure are undefined. Checks whether the two given #graphene_ray_t are equal. + line="325">Checks whether the two given #graphene_ray_t are equal. `true` if the given rays are equal + line="332">`true` if the given rays are equal a #graphene_ray_t + line="327">a #graphene_ray_t a #graphene_ray_t + line="328">a #graphene_ray_t @@ -7103,7 +7065,7 @@ The contents of the returned structure are undefined. Frees the resources allocated by graphene_ray_alloc(). + line="79">Frees the resources allocated by graphene_ray_alloc(). @@ -7112,7 +7074,7 @@ The contents of the returned structure are undefined. a #graphene_ray_t + line="81">a #graphene_ray_t @@ -7122,7 +7084,7 @@ The contents of the returned structure are undefined. version="1.4"> Computes the point on the given #graphene_ray_t that is closest to the + line="343">Computes the point on the given #graphene_ray_t that is closest to the given point @p. @@ -7132,13 +7094,13 @@ given point @p. a #graphene_ray_t + line="345">a #graphene_ray_t a #graphene_point3d_t + line="346">a #graphene_point3d_t transfer-ownership="none"> return location for the closest point3d + line="347">return location for the closest point3d @@ -7157,7 +7119,7 @@ given point @p. version="1.4"> Retrieves the direction of the given #graphene_ray_t. + line="189">Retrieves the direction of the given #graphene_ray_t. @@ -7166,7 +7128,7 @@ given point @p. a #graphene_ray_t + line="191">a #graphene_ray_t transfer-ownership="none"> return location for the direction + line="192">return location for the direction @@ -7185,7 +7147,7 @@ given point @p. version="1.4"> Computes the distance of the origin of the given #graphene_ray_t from the + line="274">Computes the distance of the origin of the given #graphene_ray_t from the given plane. If the ray does not intersect the plane, this function returns `INFINITY`. @@ -7193,20 +7155,20 @@ If the ray does not intersect the plane, this function returns `INFINITY`. the distance of the origin of the ray from the plane + line="284">the distance of the origin of the ray from the plane a #graphene_ray_t + line="276">a #graphene_ray_t a #graphene_plane_t + line="277">a #graphene_plane_t @@ -7216,7 +7178,7 @@ If the ray does not intersect the plane, this function returns `INFINITY`. version="1.4"> Computes the distance of the closest approach between the + line="229">Computes the distance of the closest approach between the given #graphene_ray_t @r and the point @p. The closest approach to a ray from a point is the distance @@ -7226,20 +7188,20 @@ ray itself. the distance of the point + line="241">the distance of the point a #graphene_ray_t + line="231">a #graphene_ray_t a #graphene_point3d_t + line="232">a #graphene_point3d_t @@ -7249,7 +7211,7 @@ ray itself. version="1.4"> Retrieves the origin of the given #graphene_ray_t. + line="173">Retrieves the origin of the given #graphene_ray_t. @@ -7258,7 +7220,7 @@ ray itself. a #graphene_ray_t + line="175">a #graphene_ray_t transfer-ownership="none"> return location for the origin + line="176">return location for the origin @@ -7277,7 +7239,7 @@ ray itself. version="1.4"> Retrieves the coordinates of a point at the distance @t along the + line="205">Retrieves the coordinates of a point at the distance @t along the given #graphene_ray_t. @@ -7287,13 +7249,13 @@ given #graphene_ray_t. a #graphene_ray_t + line="207">a #graphene_ray_t the distance along the ray + line="208">the distance along the ray transfer-ownership="none"> return location for the position + line="209">return location for the position @@ -7310,20 +7272,20 @@ given #graphene_ray_t. Initializes the given #graphene_ray_t using the given @origin + line="93">Initializes the given #graphene_ray_t using the given @origin and @direction values. the initialized ray + line="102">the initialized ray the #graphene_ray_t to initialize + line="95">the #graphene_ray_t to initialize allow-none="1"> the origin of the ray + line="96">the origin of the ray allow-none="1"> the direction vector + line="97">the direction vector @@ -7351,26 +7313,26 @@ and @direction values. version="1.4"> Initializes the given #graphene_ray_t using the origin and direction + line="124">Initializes the given #graphene_ray_t using the origin and direction values of another #graphene_ray_t. the initialized ray + line="132">the initialized ray the #graphene_ray_t to initialize + line="126">the #graphene_ray_t to initialize a #graphene_ray_t + line="127">a #graphene_ray_t @@ -7380,19 +7342,19 @@ values of another #graphene_ray_t. version="1.4"> Initializes the given #graphene_ray_t using the given vectors. + line="143">Initializes the given #graphene_ray_t using the given vectors. the initialized ray + line="151">the initialized ray the #graphene_ray_t to initialize + line="145">the #graphene_ray_t to initialize allow-none="1"> a #graphene_vec3_t + line="146">a #graphene_vec3_t allow-none="1"> a #graphene_vec3_t + line="147">a #graphene_vec3_t @@ -7420,13 +7382,13 @@ values of another #graphene_ray_t. version="1.10"> Intersects the given #graphene_ray_t @r with the given + line="486">Intersects the given #graphene_ray_t @r with the given #graphene_box_t @b. the type of intersection + line="495">the type of intersection @@ -7434,13 +7396,13 @@ values of another #graphene_ray_t. a #graphene_ray_t + line="488">a #graphene_ray_t a #graphene_box_t + line="489">a #graphene_box_t transfer-ownership="full"> the distance of the point on the ray that intersects the box + line="490">the distance of the point on the ray that intersects the box @@ -7459,13 +7421,13 @@ values of another #graphene_ray_t. version="1.10"> Intersects the given #graphene_ray_t @r with the given + line="377">Intersects the given #graphene_ray_t @r with the given #graphene_sphere_t @s. the type of intersection + line="386">the type of intersection @@ -7473,13 +7435,13 @@ values of another #graphene_ray_t. a #graphene_ray_t + line="379">a #graphene_ray_t a #graphene_sphere_t + line="380">a #graphene_sphere_t transfer-ownership="full"> the distance of the point on the ray that intersects the sphere + line="381">the distance of the point on the ray that intersects the sphere @@ -7498,13 +7460,13 @@ values of another #graphene_ray_t. version="1.10"> Intersects the given #graphene_ray_t @r with the given + line="636">Intersects the given #graphene_ray_t @r with the given #graphene_triangle_t @t. the type of intersection + line="645">the type of intersection @@ -7512,13 +7474,13 @@ values of another #graphene_ray_t. a #graphene_ray_t + line="638">a #graphene_ray_t a #graphene_triangle_t + line="639">a #graphene_triangle_t transfer-ownership="full"> the distance of the point on the ray that intersects the triangle + line="640">the distance of the point on the ray that intersects the triangle @@ -7537,7 +7499,7 @@ values of another #graphene_ray_t. version="1.10"> Checks whether the given #graphene_ray_t @r intersects the + line="615">Checks whether the given #graphene_ray_t @r intersects the given #graphene_box_t @b. See also: graphene_ray_intersect_box() @@ -7545,20 +7507,20 @@ See also: graphene_ray_intersect_box() `true` if the ray intersects the box + line="625">`true` if the ray intersects the box a #graphene_ray_t + line="617">a #graphene_ray_t a #graphene_box_t + line="618">a #graphene_box_t @@ -7568,7 +7530,7 @@ See also: graphene_ray_intersect_box() version="1.10"> Checks if the given #graphene_ray_t @r intersects the + line="449">Checks if the given #graphene_ray_t @r intersects the given #graphene_sphere_t @s. See also: graphene_ray_intersect_sphere() @@ -7576,20 +7538,20 @@ See also: graphene_ray_intersect_sphere() `true` if the ray intersects the sphere + line="459">`true` if the ray intersects the sphere a #graphene_ray_t + line="451">a #graphene_ray_t a #graphene_sphere_t + line="452">a #graphene_sphere_t @@ -7599,7 +7561,7 @@ See also: graphene_ray_intersect_sphere() version="1.10"> Checks whether the given #graphene_ray_t @r intersects the + line="736">Checks whether the given #graphene_ray_t @r intersects the given #graphene_triangle_t @b. See also: graphene_ray_intersect_triangle() @@ -7607,20 +7569,20 @@ See also: graphene_ray_intersect_triangle() `true` if the ray intersects the triangle + line="746">`true` if the ray intersects the triangle a #graphene_ray_t + line="738">a #graphene_ray_t a #graphene_triangle_t + line="739">a #graphene_triangle_t @@ -8751,7 +8713,7 @@ declaring it, e.g.: - + @@ -8766,7 +8728,7 @@ declaring it, e.g.: - + @@ -13115,12 +13077,12 @@ Each vector type should be treated as an opaque data type. version="1.0"> Returns a point fixed at (0, 0). - + line="302">Returns a point fixed at (0, 0). + a fixed point + line="307">a fixed point diff --git a/girs/Grl-0.3.gir b/girs/Grl-0.3.gir index 004f3c31d..cd13251f5 100644 --- a/girs/Grl-0.3.gir +++ b/girs/Grl-0.3.gir @@ -14184,7 +14184,7 @@ representing a media resource. Deinitializes the Grilo library. + line="172">Deinitializes the Grilo library. Call this function after finalizing using Grilo, in order to free and clean up all the resources created. @@ -14420,7 +14420,7 @@ databases and store them in the #GrlMedia. version="0.1.6"> Returns a #GOptionGroup with Grilo's argument specifications. + line="197">Returns a #GOptionGroup with Grilo's argument specifications. This function is useful if you want to integrate Grilo with other libraries that use the GOption commandline parser @@ -14429,7 +14429,7 @@ libraries that use the GOption commandline parser a pointer to Grilo's option group. Should be dereferenced + line="206">a pointer to Grilo's option group. Should be dereferenced after use. diff --git a/girs/GrlPls-0.3.gir b/girs/GrlPls-0.3.gir index 80b96c653..918c3df39 100644 --- a/girs/GrlPls-0.3.gir +++ b/girs/GrlPls-0.3.gir @@ -261,7 +261,7 @@ list. version="0.2.0"> This function will update (if @content is non-%NULL) or create a + line="1195">This function will update (if @content is non-%NULL) or create a GrlMedia and populate it with information from @info. If @info is %NULL, a call to g_file_query_info() will be made. @@ -272,38 +272,38 @@ and want to easily create GrlMedia from filesystem information. a new #GrlMedia. + line="1212">a new #GrlMedia. an existing #GrlMedia for the file, or %NULL + line="1197">an existing #GrlMedia for the file, or %NULL a #GFile pointing to the file or directory in question + line="1198">a #GFile pointing to the file or directory in question an existing #GFileInfo, or %NULL + line="1199">an existing #GFileInfo, or %NULL Whether playlists should be handled as containers + line="1200">Whether playlists should be handled as containers a #GrlOperationOptions representing the options to apply + line="1201">a #GrlOperationOptions representing the options to apply to this operation. @@ -314,7 +314,7 @@ and want to easily create GrlMedia from filesystem information. version="0.2.0"> Returns the list of attributes to pass to + line="1378">Returns the list of attributes to pass to g_file_query_info() to make it possible to populate a GrlMedia using grl_pls_file_to_media(). @@ -323,7 +323,7 @@ Do not free the result of this function. a string containing the + line="1387">a string containing the list of attributes. diff --git a/girs/Grss-0.7.gir b/girs/Grss-0.7.gir index 2d44acd4c..58b0c0c24 100644 --- a/girs/Grss-0.7.gir +++ b/girs/Grss-0.7.gir @@ -496,13 +496,13 @@ otherwise. throws="1"> Utility to fetch and populate a #GrssFeedChannel, and retrieve all its + line="1122">Utility to fetch and populate a #GrssFeedChannel, and retrieve all its items. a GList + line="1131">a GList of #GrssFeedItem, to be completely unreferenced and freed when no longer in use, or %NULL if an error occurs. @@ -513,7 +513,7 @@ longer in use, or %NULL if an error occurs. a #GrssFeedChannel. + line="1124">a #GrssFeedChannel. @@ -522,7 +522,7 @@ longer in use, or %NULL if an error occurs. c:identifier="grss_feed_channel_fetch_all_async"> Similar to grss_feed_channel_fetch_all(), but asyncronous. + line="1211">Similar to grss_feed_channel_fetch_all(), but asyncronous. @@ -531,7 +531,7 @@ longer in use, or %NULL if an error occurs. a #GrssFeedChannel. + line="1213">a #GrssFeedChannel. closure="1"> function to invoke at the end of the download. + line="1214">function to invoke at the end of the download. allow-none="1"> data passed to the callback. + line="1215">data passed to the callback. @@ -561,13 +561,13 @@ longer in use, or %NULL if an error occurs. throws="1"> Finalizes an asyncronous operation started with + line="1239">Finalizes an asyncronous operation started with grss_feed_channel_fetch_all_async(). list of + line="1249">list of items fetched from the #GrssFeedChannel, or %NULL if @error is set. The list (and contained items) is freed at the end of the callback @@ -579,13 +579,13 @@ callback a #GrssFeedChannel. + line="1241">a #GrssFeedChannel. the #GAsyncResult passed to the callback. + line="1242">the #GAsyncResult passed to the callback. @@ -593,7 +593,7 @@ callback Similar to grss_feed_channel_fetch(), but asyncronous. + line="1090">Similar to grss_feed_channel_fetch(), but asyncronous. @@ -602,7 +602,7 @@ callback a #GrssFeedChannel. + line="1092">a #GrssFeedChannel. closure="1"> function to invoke at the end of the download. + line="1093">function to invoke at the end of the download. allow-none="1"> data passed to the callback. + line="1094">data passed to the callback. @@ -631,13 +631,13 @@ callback c:identifier="grss_feed_channel_fetch_cancel"> If a fetch operation was scheduled with grss_feed_channel_fetch_async() or + line="1263">If a fetch operation was scheduled with grss_feed_channel_fetch_async() or grss_feed_channel_fetch_all_async(), cancel it. %TRUE if a fetch was scheduled (and now cancelled), %FALSE if + line="1270">%TRUE if a fetch was scheduled (and now cancelled), %FALSE if this function had nothing to do @@ -645,7 +645,7 @@ this function had nothing to do a #GrssFeedChannel. + line="1265">a #GrssFeedChannel. @@ -655,13 +655,13 @@ this function had nothing to do throws="1"> Finalizes an asyncronous operation started with + line="1061">Finalizes an asyncronous operation started with grss_feed_channel_fetch_async(). %TRUE if @channel informations have been successfully fetched, + line="1071">%TRUE if @channel informations have been successfully fetched, %FALSE otherwise. @@ -669,13 +669,13 @@ grss_feed_channel_fetch_async(). a #GrssFeedChannel. + line="1063">a #GrssFeedChannel. the #GAsyncResult passed to the callback. + line="1064">the #GAsyncResult passed to the callback. @@ -1698,7 +1698,7 @@ written, or %NULL if an error occours. c:identifier="grss_feed_enclosure_fetch_async"> Similar to grss_feed_enclosure_fetch(), but asyncronous. + line="269">Similar to grss_feed_enclosure_fetch(), but asyncronous. @@ -1707,7 +1707,7 @@ written, or %NULL if an error occours. a #GrssFeedEnclosure. + line="271">a #GrssFeedEnclosure. closure="1"> function to invoke at the end of the download. + line="272">function to invoke at the end of the download. allow-none="1"> data passed to the callback. + line="273">data passed to the callback. @@ -1737,13 +1737,13 @@ written, or %NULL if an error occours. throws="1"> Finalizes an asyncronous operation started with + line="290">Finalizes an asyncronous operation started with grss_feed_enclosure_fetch_async(). temporary file where the contents have been + line="300">temporary file where the contents have been written, or %NULL if an error occours. @@ -1751,13 +1751,13 @@ written, or %NULL if an error occours. a #GrssFeedEnclosure. + line="292">a #GrssFeedEnclosure. the #GAsyncResult passed to the callback. + line="293">the #GAsyncResult passed to the callback. @@ -2153,7 +2153,7 @@ rappresentation of the given channel containing the given items. Adds a category to the @item. The complete list can be obtained with + line="258">Adds a category to the @item. The complete list can be obtained with grss_feed_item_get_categories(). @@ -2163,13 +2163,13 @@ grss_feed_item_get_categories(). a #GrssFeedItem. + line="260">a #GrssFeedItem. a new category to assign to the item. + line="261">a new category to assign to the item. @@ -2178,7 +2178,7 @@ grss_feed_item_get_categories(). c:identifier="grss_feed_item_add_contributor"> To add a contributor to the @item. + line="463">To add a contributor to the @item. @@ -2187,13 +2187,13 @@ grss_feed_item_get_categories(). a #GrssFeedItem. + line="465">a #GrssFeedItem. a #GrssPerson. + line="466">a #GrssPerson. @@ -2201,7 +2201,7 @@ grss_feed_item_get_categories(). Adds an enclosure to the @item. That external elements may be references + line="612">Adds an enclosure to the @item. That external elements may be references to images, videos, or other contents (usually multimedial) embedded in the element. @@ -2212,13 +2212,13 @@ element. a #GrssFeedItem. + line="614">a #GrssFeedItem. a #GrssFeedEnclosure to add to the item. + line="615">a #GrssFeedEnclosure to add to the item. @@ -2226,19 +2226,19 @@ element. Retrieves the author of @item. + line="449">Retrieves the author of @item. #GrssPerson, or %NULL. + line="455">#GrssPerson, or %NULL. a #GrssFeedItem. + line="451">a #GrssFeedItem. @@ -2247,12 +2247,12 @@ element. c:identifier="grss_feed_item_get_categories"> Retrieves list of categories assigned to the @item. + line="279">Retrieves list of categories assigned to the @item. list of strings, + line="285">list of strings, one for assigned category. Do not free or modify this list. @@ -2262,7 +2262,7 @@ one for assigned category. Do not free or modify this list. a #GrssFeedItem. + line="281">a #GrssFeedItem. @@ -2271,19 +2271,19 @@ one for assigned category. Do not free or modify this list. c:identifier="grss_feed_item_get_comments_url"> Retrieves the URL where to catch comments to the @item. + line="520">Retrieves the URL where to catch comments to the @item. URL to parse to read comments for @item, or %NULL. + line="526">URL to parse to read comments for @item, or %NULL. a #GrssFeedItem. + line="522">a #GrssFeedItem. @@ -2292,12 +2292,12 @@ one for assigned category. Do not free or modify this list. c:identifier="grss_feed_item_get_contributors"> Retrieves contributors for @item. + line="482">Retrieves contributors for @item. list of + line="488">list of contributors to the item. @@ -2307,7 +2307,7 @@ one for assigned category. Do not free or modify this list. a #GrssFeedItem. + line="484">a #GrssFeedItem. @@ -2315,19 +2315,19 @@ one for assigned category. Do not free or modify this list. Retrieves copyright reference for the @item. + line="417">Retrieves copyright reference for the @item. copyright mark, or %NULL. + line="423">copyright mark, or %NULL. a #GrssFeedItem. + line="419">a #GrssFeedItem. @@ -2336,19 +2336,19 @@ one for assigned category. Do not free or modify this list. c:identifier="grss_feed_item_get_description"> Retrieves the description of the @item. + line="244">Retrieves the description of the @item. description of @item. + line="250">description of @item. a #GrssFeedItem. + line="246">a #GrssFeedItem. @@ -2357,12 +2357,12 @@ one for assigned category. Do not free or modify this list. c:identifier="grss_feed_item_get_enclosures"> Retrieves the list of enclosures added with grss_feed_item_add_enclosure(). + line="630">Retrieves the list of enclosures added with grss_feed_item_add_enclosure(). a list of + line="636">a list of #GrssFeedEnclosure. This is a direct reference to the internal list, do not free or modify it. @@ -2373,7 +2373,7 @@ free or modify it. a #GrssFeedItem. + line="632">a #GrssFeedItem. @@ -2381,12 +2381,12 @@ free or modify it. Retrieves the geo reference of the @item. + line="560">Retrieves the geo reference of the @item. %TRUE if @item has geographic coordinates assigned and + line="568">%TRUE if @item has geographic coordinates assigned and @latitude and @longitude have been set, %FALSE if @item has not geo reference. @@ -2395,25 +2395,19 @@ reference. a #GrssFeedItem. + line="562">a #GrssFeedItem. - + will be assigned to the latitude of the point, or %NULL. + line="563">will be assigned to the latitude of the point, or %NULL. - + will be assigned to the longitude of the point, or %NULL. + line="564">will be assigned to the longitude of the point, or %NULL. @@ -2421,7 +2415,7 @@ reference. Retrieves the ID assigned to the @item. If no ID was set with + line="182">Retrieves the ID assigned to the @item. If no ID was set with grss_feed_item_set_id() this returns the same of grss_feed_item_get_source(). Pay attention to the fact this library do not check uniqueness of assigned IDs. @@ -2429,14 +2423,14 @@ IDs. ID of the item. + line="191">ID of the item. #GrssFeedItem from which retrieve the ID. + line="184">#GrssFeedItem from which retrieve the ID. @@ -2444,19 +2438,19 @@ IDs. Retrieves the feed from which the item belongs. + line="143">Retrieves the feed from which the item belongs. the parent feed, as set in grss_feed_item_new(). + line="149">the parent feed, as set in grss_feed_item_new(). a #GrssFeedItem. + line="145">a #GrssFeedItem. @@ -2465,21 +2459,21 @@ IDs. c:identifier="grss_feed_item_get_publish_time"> Retrieves the publish time of the item. By default this value is the + line="596">Retrieves the publish time of the item. By default this value is the current timestamp assigned when creating the #GrssFeedItem, and may be changed with grss_feed_item_set_publish_time(). publish time of @item. + line="604">publish time of @item. a #GrssFeedItem. + line="598">a #GrssFeedItem. @@ -2488,7 +2482,7 @@ changed with grss_feed_item_set_publish_time(). c:identifier="grss_feed_item_get_real_source"> Retrieves references to the real source of @item. + line="358">Retrieves references to the real source of @item. @@ -2497,19 +2491,19 @@ changed with grss_feed_item_set_publish_time(). a #GrssFeedItem. + line="360">a #GrssFeedItem. will be assigned to the URL of the real source, or %NULL. + line="361">will be assigned to the URL of the real source, or %NULL. will be assigned to the title of the real source, or %NULL. + line="362">will be assigned to the title of the real source, or %NULL. @@ -2517,19 +2511,19 @@ changed with grss_feed_item_set_publish_time(). Retrieves indication about posts related to @item. + line="389">Retrieves indication about posts related to @item. related posts, or %NULL. + line="395">related posts, or %NULL. a #GrssFeedItem. + line="391">a #GrssFeedItem. @@ -2537,19 +2531,19 @@ changed with grss_feed_item_set_publish_time(). Retrieves the URL where the @item can be found. + line="317">Retrieves the URL where the @item can be found. URL of the item, or %NULL. + line="323">URL of the item, or %NULL. a #GrssFeedItem. + line="319">a #GrssFeedItem. @@ -2557,19 +2551,19 @@ changed with grss_feed_item_set_publish_time(). Retrieves the title assigned to @item. + line="216">Retrieves the title assigned to @item. title of the element. + line="222">title of the element. a #GrssFeedItem. + line="218">a #GrssFeedItem. @@ -2577,7 +2571,7 @@ changed with grss_feed_item_set_publish_time(). To assign an author to the @item. + line="431">To assign an author to the @item. @@ -2586,13 +2580,13 @@ changed with grss_feed_item_set_publish_time(). a #GrssFeedItem. + line="433">a #GrssFeedItem. a #GrssPerson. + line="434">a #GrssPerson. @@ -2601,25 +2595,25 @@ changed with grss_feed_item_set_publish_time(). c:identifier="grss_feed_item_set_comments_url"> To assign the URL where to fetch comments for the item. + line="497">To assign the URL where to fetch comments for the item. %TRUE if @url is a valid URL, %FALSE otherwise + line="504">%TRUE if @url is a valid URL, %FALSE otherwise a #GrssFeedItem. + line="499">a #GrssFeedItem. URL where to retrieve comments to the item. + line="500">URL where to retrieve comments to the item. @@ -2627,7 +2621,7 @@ changed with grss_feed_item_set_publish_time(). To set a copyright reference to @item. + line="403">To set a copyright reference to @item. @@ -2636,13 +2630,13 @@ changed with grss_feed_item_set_publish_time(). a #GrssFeedItem. + line="405">a #GrssFeedItem. copyright declaration for the item. + line="406">copyright declaration for the item. @@ -2651,7 +2645,7 @@ changed with grss_feed_item_set_publish_time(). c:identifier="grss_feed_item_set_description"> To set the description of @item. Usually "description" means his content. + line="230">To set the description of @item. Usually "description" means his content. @@ -2660,13 +2654,13 @@ changed with grss_feed_item_set_publish_time(). a #GrssFeedItem. + line="232">a #GrssFeedItem. content of the item. + line="233">content of the item. @@ -2674,7 +2668,7 @@ changed with grss_feed_item_set_publish_time(). To assign geographic context to the @item. + line="534">To assign geographic context to the @item. Passing -1 as @latitude or @longitude, the relative value is untouched in the object. This is to easy assignment of coordinates in more than a single step. If both are -1, nothing happens. @@ -2686,19 +2680,19 @@ single step. If both are -1, nothing happens. a #GrssFeedItem. + line="536">a #GrssFeedItem. latitude of the point, or -1 to leave the previous one. + line="537">latitude of the point, or -1 to leave the previous one. longitude of the point, or -1 to leave the previous one. + line="538">longitude of the point, or -1 to leave the previous one. @@ -2706,7 +2700,7 @@ single step. If both are -1, nothing happens. To set the ID of the @item. This parameter has not a particular format: it + line="157">To set the ID of the @item. This parameter has not a particular format: it is just a string used to identify in unique way the item. @@ -2716,13 +2710,13 @@ is just a string used to identify in unique way the item. a #GrssFeedItem. + line="159">a #GrssFeedItem. the new ID to set. + line="160">the new ID to set. @@ -2731,7 +2725,7 @@ is just a string used to identify in unique way the item. c:identifier="grss_feed_item_set_publish_time"> To set the publish time of the item. + line="583">To set the publish time of the item. @@ -2740,13 +2734,13 @@ is just a string used to identify in unique way the item. a #GrssFeedItem. + line="585">a #GrssFeedItem. publishing timestamp of the item. + line="586">publishing timestamp of the item. @@ -2755,32 +2749,32 @@ is just a string used to identify in unique way the item. c:identifier="grss_feed_item_set_real_source"> To set an alternative real source for @item. This parameter is used by web + line="331">To set an alternative real source for @item. This parameter is used by web aggregators to explicit the origin of a content reproduced in them. %TRUE if @realsource is a valid URL, %FALSE otherwise + line="340">%TRUE if @realsource is a valid URL, %FALSE otherwise a #GrssFeedItem. + line="333">a #GrssFeedItem. URL of the real source for the item. + line="334">URL of the real source for the item. title of the real source. + line="335">title of the real source. @@ -2788,7 +2782,7 @@ aggregators to explicit the origin of a content reproduced in them. To set reference to a post related to @item. + line="375">To set reference to a post related to @item. @@ -2797,13 +2791,13 @@ aggregators to explicit the origin of a content reproduced in them. a #GrssFeedItem. + line="377">a #GrssFeedItem. reference to a related post. + line="378">reference to a related post. @@ -2811,25 +2805,25 @@ aggregators to explicit the origin of a content reproduced in them. To set the source of the @item. + line="294">To set the source of the @item. %TRUE if @source is a valid URL, %FALSE otherwise + line="301">%TRUE if @source is a valid URL, %FALSE otherwise a #GrssFeedItem. + line="296">a #GrssFeedItem. URL of the item. + line="297">URL of the item. @@ -2837,7 +2831,7 @@ aggregators to explicit the origin of a content reproduced in them. To set a title to the @item. + line="202">To set a title to the @item. @@ -2846,13 +2840,13 @@ aggregators to explicit the origin of a content reproduced in them. a #GrssFeedItem. + line="204">a #GrssFeedItem. title of the item. + line="205">title of the item. @@ -3049,8 +3043,8 @@ skips parsing of items into the document. throws="1"> Creates a new file with the list of @channels represented in the required -@format. If the file already exists at the @uri location, it is overwritten. + line="231">Creates a new file with the list of @channels rappresented in the required +@format. It a file already exists at the @uri location, it is overwritten. To access the internal #SoupSession used by the @pool to fetch items. + line="391">To access the internal #SoupSession used by the @pool to fetch items. instance of #SoupSession. Do not free it. + line="397">instance of #SoupSession. Do not free it. a #GrssFeedsPool. + line="393">a #GrssFeedsPool. @@ -3322,7 +3316,7 @@ are g_object_ref'd here. Permits to pause or resume the @pool fetching feeds. If @run is %TRUE, the + line="366">Permits to pause or resume the @pool fetching feeds. If @run is %TRUE, the @pool starts immediately. @@ -3332,13 +3326,13 @@ are g_object_ref'd here. a #GrssFeedsPool. + line="368">a #GrssFeedsPool. %TRUE to run the pool, %FALSE to pause it. + line="369">%TRUE to run the pool, %FALSE to pause it. @@ -3562,7 +3556,7 @@ freed when no longer in use. c:identifier="grss_feeds_publisher_hub_set_port"> To customize the port opened by the local server to deliver feeds and + line="894">To customize the port opened by the local server to deliver feeds and catch incoming subscriptions. By default this is 80. Changing the port while the hub is running imply restart the local server. @@ -3573,13 +3567,13 @@ while the hub is running imply restart the local server. a #GrssFeedsPublisher. + line="896">a #GrssFeedsPublisher. new listening port for the server. + line="897">new listening port for the server. @@ -3588,7 +3582,7 @@ while the hub is running imply restart the local server. c:identifier="grss_feeds_publisher_hub_set_topics"> To define a list of valid "topics" for which the #GrssFeedsPublisher will + line="916">To define a list of valid "topics" for which the #GrssFeedsPublisher will deliver contents. Sources of those channels, as retrieved by grss_feed_channel_get_source(), are accepted as "hub.topic" parameter in PubSubHubbub registration requests from remote subscribers. @@ -3602,13 +3596,13 @@ now rejected. a #GrssFeedsPublisher. + line="918">a #GrssFeedsPublisher. a list of #GrssFeedChannels. + line="919">a list of #GrssFeedChannels. @@ -3618,7 +3612,7 @@ now rejected. Permits to start and stop the webserver implemented by this object. + line="990">Permits to start and stop the webserver implemented by this object. @@ -3627,13 +3621,13 @@ now rejected. a #GrssFeedsPublisher. + line="992">a #GrssFeedsPublisher. %TRUE to run the local server, %FALSE to stop it. + line="993">%TRUE to run the local server, %FALSE to stop it. diff --git a/girs/Gsf-1.gir b/girs/Gsf-1.gir index db26ecdac..1be484a82 100644 --- a/girs/Gsf-1.gir +++ b/girs/Gsf-1.gir @@ -17,17 +17,17 @@ and/or use gtk-doc annotations. --> c:symbol-prefixes="gsf"> Data type to represent offsets (positions) within a data stream. FIXME: gsf_off_t is really supposed to be the widest type off_t can be configured to on the platform - + - + @@ -36,7 +36,7 @@ to on the platform - + @@ -45,7 +45,7 @@ to on the platform - + @@ -58,18 +58,18 @@ to on the platform glib:type-name="GsfBlob" glib:get-type="gsf_blob_get_type" glib:type-struct="BlobClass"> - + Creates a new #GsfBlob object to hold the specified data. The blob can then be used as a facility for reference-counting for the data. The data is copied internally, so the blob does not hold references to external chunks of memory. - + A newly-created #GsfBlob, or %NULL if the data could not be copied. Error domain: #GSF_ERROR @@ -80,13 +80,13 @@ Possible errors: #GSF_ERROR_OUT_OF_MEMORY if the @data_to_copy could not be copi Size of the data in bytes. Data which will be copied into the blob, or %NULL if @size is zero. @@ -97,19 +97,19 @@ Data which will be copied into the blob, or %NULL if @size is zero. Queries the size in bytes of the data stored in the blob. - + Size in bytes, or 0 if the data is %NULL. A #GsfBlob. @@ -117,15 +117,15 @@ Data which will be copied into the blob, or %NULL if @size is zero. Queries a pointer to the data stored in the blob. This does not copy the data for you; it returns a pointer to the actual buffer which the blob uses internally, so you should not free this buffer on your own. - + Pointer to the data stored in the blob, or %NULL if the size of the data is zero. @@ -133,7 +133,7 @@ blob, or %NULL if the size of the data is zero. A #GsfBlob. @@ -151,18 +151,18 @@ blob, or %NULL if the size of the data is zero. disguised="1" opaque="1" glib:is-gtype-struct-for="Blob"> - + - + - + @@ -171,7 +171,7 @@ blob, or %NULL if the size of the data is zero. - + @@ -180,7 +180,7 @@ blob, or %NULL if the size of the data is zero. - + @@ -193,30 +193,30 @@ blob, or %NULL if the size of the data is zero. glib:type-name="GsfClipData" glib:get-type="gsf_clip_data_get_type" glib:type-struct="ClipDataClass"> - + Creates a new #GsfClipData object. This function acquires a reference to the @data_blob, so you should unref the blob on your own if you no longer need it directly. - + A newly-created #GsfClipData. Format for the data inside the @data_blob Object which holds the binary contents for the #GsfClipData @@ -224,12 +224,12 @@ directly. Queries the data blob that actually stores a #GsfClipData's binary data. - + A new reference to the #GsfBlob that stores this @clip_data's binary data. You must use g_object_unref() to dispose of that data blob when you are done with it. @@ -238,7 +238,7 @@ you are done with it. A #GsfClipData. @@ -246,20 +246,20 @@ you are done with it. Queries the clipboard data format of a #GsfClipData. The format refers to the data blob inside the @clip_data; use gsf_clip_data_get_data_blob() to get that data blob. - + The format in which the #GsfClipData's data blob is stored. A #GsfClipData. @@ -269,13 +269,13 @@ blob inside the @clip_data; use gsf_clip_data_get_data_blob() to get that data b c:identifier="gsf_clip_data_get_windows_clipboard_format" throws="1"> Queries the Windows clipboard data format for a #GsfClipData. The @clip_data must have been created with #GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD. - + A #GsfClipFormatWindows value. Possible errors: #GSF_ERROR_INVALID_DATA if the data blob in the @clip_data is @@ -285,7 +285,7 @@ smaller than it should be; in this case GSF_CLIP_FORMAT_WINDOWS_ERROR will be re A #GsfClipData. @@ -295,17 +295,17 @@ smaller than it should be; in this case GSF_CLIP_FORMAT_WINDOWS_ERROR will be re c:identifier="gsf_clip_data_peek_real_data" throws="1"> Queries a pointer directly to the clipboard data of a #GsfClipData. The resulting pointer is not necessarily the same data pointer that was passed to gsf_blob_new() prior to creating the @clip_data. For example, if the data is in #GSF_CLIP_FORMAT_WINDOWS_CLIPBOARD format, then it will have extra header bytes in front of the actual metafile data. This function will skip over those header bytes if necessary and return a pointer to the "real" data. - + Pointer to the real clipboard data. The size in bytes of this buffer is returned in the @ret_size argument. @@ -313,13 +313,13 @@ buffer is returned in the @ret_size argument. A #GsfClipData. Location to return the size of the returned data buffer. @@ -337,93 +337,93 @@ buffer is returned in the @ret_size argument. disguised="1" opaque="1" glib:is-gtype-struct-for="ClipData"> - + - + - + Windows clipboard format Macintosh clipboard format GUID that contains a format identifier No clipboard data Custom clipboard format Unknown clipboard type or invalid data - + error unknown CF_METAFILEPICT CF_DIB CF_ENHMETAFILE - + @@ -432,7 +432,7 @@ buffer is returned in the @ret_size argument. - + @@ -445,30 +445,30 @@ buffer is returned in the @ret_size argument. glib:type-name="GsfDocMetaData" glib:get-type="gsf_doc_meta_data_get_type"> Class representing information about a document, such as creator and time of last modification. - + a new metadata property collection Iterate through each (key, value) pair in this collection - + the collection @@ -477,7 +477,7 @@ last modification. scope="call" closure="1"> the function called once for each element in the collection @@ -486,7 +486,7 @@ last modification. nullable="1" allow-none="1"> any supplied user data @@ -494,39 +494,39 @@ last modification. Take ownership of @name and @value and insert a property into @meta. If a property exists with @name, it is replaced (The link is lost) - + #GsfDocMetaData the id. #GValue - + the property with @name in @meta. The caller can modify the property value and link but not the name. @@ -534,7 +534,7 @@ modify the property value and link but not the name. #GsfDocMetaData @@ -547,22 +547,22 @@ modify the property value and link but not the name. c:identifier="gsf_doc_meta_data_odf_subtree" version="1.14.24"> Extend @xin so that it can parse a subtree in OpenDoc metadata format - + #GsfDocMetaData #GsfXMLInDoc @@ -572,26 +572,26 @@ modify the property value and link but not the name. c:identifier="gsf_doc_meta_data_read_from_msole" version="1.14.24"> Read a stream formated as a set of MS OLE properties from @in and store the results in @accum. - + A #GError if there was an error. #GsfDocMetaData #GsfInput @@ -601,26 +601,26 @@ results in @accum. c:identifier="gsf_doc_meta_data_read_from_odf" version="1.14.24"> Read an OpenDocument metadata stream from @input and store the properties into @md. Overwrite any existing properties with the same id. - + a #GError if there is a problem. #GsfDocMetaData #GsfInput @@ -628,57 +628,57 @@ into @md. Overwrite any existing properties with the same id. If @name does not exist in the collection, do nothing. If @name does exist, remove it and its value from the collection - + the collection the non-null string name of the property - + the number of items in this collection the collection - + the property with @name in @meta. #GsfDocMetaData @@ -688,20 +688,20 @@ remove it and its value from the collection - + #GsfDocMetaData #GsfDocProp @@ -710,29 +710,29 @@ remove it and its value from the collection - + %TRUE on success; #GsfDocMetaData #GsfOutput a kludge to differentiate DocumentSummary from Summary @@ -741,23 +741,23 @@ remove it and its value from the collection - + %TRUE if no error occured. #GsfDocMetaData a pointer to a #GsfOutput. @@ -771,21 +771,21 @@ remove it and its value from the collection glib:get-type="gsf_doc_prop_get_type" c:symbol-prefix="doc_prop"> Class representing a properties of a document. - + - + a new #GsfDocProp. The name of the property. @@ -793,17 +793,17 @@ remove it and its value from the collection A debugging utility to dump @prop as text via g_print New in 1.14.2 - + #GsfDocProp @@ -811,9 +811,9 @@ New in 1.14.2 Release the given property. - + @@ -823,58 +823,58 @@ New in 1.14.2 nullable="1" allow-none="1"> #GsfDocProp - + the current link descriptor of @prop. #GsfDocProp - + the name of the property #GsfDocProp - + the value of the property, the caller should not modify the result. the property @@ -882,16 +882,16 @@ New in 1.14.2 Sets @prop's link to @link - + #GsfDocProp @@ -900,7 +900,7 @@ New in 1.14.2 nullable="1" allow-none="1"> a link. @@ -908,32 +908,32 @@ New in 1.14.2 Assigns @val to @prop, and unsets and frees the current value. - + #GsfDocProp #GValue - + the current value of @prop, and replaces it with @val. @@ -941,13 +941,13 @@ New in 1.14.2 #GsfDocProp #GValue @@ -962,34 +962,34 @@ New in 1.14.2 glib:get-type="gsf_docprop_vector_get_type"> This function creates a new gsf_docprop_vector object. - + GsfDocPropVector* Insert a copy of @value as the last element of @vector. - + The vector to which the GValue will be added The GValue to add to @vector @@ -997,19 +997,19 @@ New in 1.14.2 This function returns a string which represents all the GValues in @vector. The caller is responsible for freeing the result. Returns (transfer full): a string of comma-separated values - + The #GsfDocPropVector from which GValues will be extracted. @@ -1019,24 +1019,24 @@ Returns (transfer full): a string of comma-separated values - + Memory allocation failed Invalid data encountered (e.g. not enough data) - + @@ -1045,7 +1045,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1054,7 +1054,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1063,7 +1063,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1072,7 +1072,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1081,7 +1081,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1090,14 +1090,14 @@ Returns (transfer full): a string of comma-separated values - + - + @@ -1106,7 +1106,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1115,7 +1115,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1124,7 +1124,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1133,7 +1133,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1142,7 +1142,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1151,7 +1151,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1160,7 +1160,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1169,7 +1169,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1178,7 +1178,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1187,7 +1187,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1196,7 +1196,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1205,7 +1205,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1214,7 +1214,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1223,7 +1223,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1232,7 +1232,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1241,7 +1241,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1250,7 +1250,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1259,7 +1259,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1268,7 +1268,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1277,7 +1277,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1286,7 +1286,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1295,7 +1295,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1304,7 +1304,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1313,7 +1313,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1322,7 +1322,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1331,7 +1331,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1340,7 +1340,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1349,7 +1349,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1358,7 +1358,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1367,7 +1367,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1376,7 +1376,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1385,7 +1385,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1394,7 +1394,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1403,7 +1403,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1412,7 +1412,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1421,7 +1421,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1430,7 +1430,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1439,7 +1439,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1448,7 +1448,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1457,7 +1457,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1466,7 +1466,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1475,7 +1475,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1484,7 +1484,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1493,7 +1493,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1502,7 +1502,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1511,7 +1511,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1520,7 +1520,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1529,7 +1529,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1538,7 +1538,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1553,11 +1553,11 @@ Returns (transfer full): a string of comma-separated values glib:get-type="gsf_infile_get_type" glib:type-struct="InfileClass"> Class representing an input file. - + - + @@ -1571,7 +1571,7 @@ Returns (transfer full): a string of comma-separated values - + @@ -1585,33 +1585,33 @@ Returns (transfer full): a string of comma-separated values - + the utf8 encoded name of the @i-th child An #GsfInfile zero-based index of child to find. - + the number of children the storage has, or -1 if the storage can not have children. @@ -1619,7 +1619,7 @@ Returns (transfer full): a string of comma-separated values the structured storage @@ -1627,7 +1627,7 @@ Returns (transfer full): a string of comma-separated values This function finds a child that is several directory levels down the tree. If, for example, the names "foo", "bar", and "baz" are given, then this function first finds the "foo" directory in the @@ -1636,23 +1636,23 @@ locates "baz" within that and returns the "baz" child. In other words, this function finds the "foo/bar/baz" child. New in 1.14.9. - + a newly created child which must be unrefed. #GsfInfile A %NULL terminated array of names (e.g. from g_strsplit) @@ -1662,25 +1662,25 @@ New in 1.14.9. TODO : For 2.0 api will change to include a #GError. - + a newly created child which must be unrefed. #GsfInfile target index @@ -1688,16 +1688,16 @@ New in 1.14.9. The function returns a named child of the given infile. This only works for an immediate child. If you need to go several levels down use gsf_infile_child_by_aname, for example. TODO : For 2.0 api will change to include a #GError. - + a newly created child which must be unrefed. @@ -1705,13 +1705,13 @@ unrefed. #GsfInfile target name @@ -1721,27 +1721,27 @@ unrefed. c:identifier="gsf_infile_child_by_vaname" introspectable="0"> Apart from argument types, this is the same as gsf_infile_child_by_aname. Please see the documentation there. New in 1.14.9. - + a newly created child which must be unrefed. #GsfInfile A %NULL terminated array of names (e.g. from g_strsplit) @@ -1751,59 +1751,59 @@ New in 1.14.9. c:identifier="gsf_infile_child_by_vname" introspectable="0"> Apart from the way arguments are specified, this is the same as gsf_infile_child_by_aname. Please see the documentation there. - + a newly created child which must be unrefed. a #GsfInfile A %NULL terminated list of names - + the utf8 encoded name of the @i-th child An #GsfInfile zero-based index of child to find. - + the number of children the storage has, or -1 if the storage can not have children. @@ -1811,7 +1811,7 @@ gsf_infile_child_by_aname. Please see the documentation there. the structured storage @@ -1824,16 +1824,16 @@ gsf_infile_child_by_aname. Please see the documentation there. - + - + the number of children the storage has, or -1 if the storage can not have children. @@ -1841,7 +1841,7 @@ gsf_infile_child_by_aname. Please see the documentation there. the structured storage @@ -1850,23 +1850,23 @@ gsf_infile_child_by_aname. Please see the documentation there. - + the utf8 encoded name of the @i-th child An #GsfInfile zero-based index of child to find. @@ -1875,7 +1875,7 @@ gsf_infile_child_by_aname. Please see the documentation there. - + @@ -1891,7 +1891,7 @@ gsf_infile_child_by_aname. Please see the documentation there. - + @@ -1914,20 +1914,20 @@ gsf_infile_child_by_aname. Please see the documentation there. glib:get-type="gsf_infile_msole_get_type"> Opens the root directory of an MS OLE file. <note>This adds a reference to @source.</note> - + the new ole file handler #GsfInput @@ -1935,26 +1935,26 @@ gsf_infile_child_by_aname. Please see the documentation there. Retrieves the 16 byte indentifier (often a GUID in MS Windows apps) stored within the directory associated with @ole and stores it in @res. - + TRUE on success a #GsfInfileMSOle 16 byte identifier (often a GUID in MS Windows apps) @@ -1968,7 +1968,7 @@ stored within the directory associated with @ole and stores it in @res. glib:type-name="GsfInfileMSVBA" glib:get-type="gsf_infile_msvba_get_type"> - + @@ -1980,12 +1980,12 @@ stored within the directory associated with @ole and stores it in @res. a collection of names and source code. - + A #GHashTable of names and source code (unknown encoding). @@ -1996,7 +1996,7 @@ A #GHashTable of names and source code (unknown encoding). #GsfInfile @@ -2005,12 +2005,12 @@ A #GHashTable of names and source code (unknown encoding). A collection of names and source code which the caller is responsible for destroying. - + A #GHashTable of names and source code (unknown encoding). @@ -2021,7 +2021,7 @@ A #GHashTable of names and source code (unknown encoding). #GsfInfile @@ -2035,17 +2035,17 @@ A #GHashTable of names and source code (unknown encoding). glib:type-name="GsfInfileStdio" glib:get-type="gsf_infile_stdio_get_type"> - + a new file or %NULL. in locale dependent encoding @@ -2060,20 +2060,20 @@ A #GHashTable of names and source code (unknown encoding). glib:get-type="gsf_infile_tar_get_type"> Opens the root directory of a Tar file. <note>This adds a reference to @source.</note> - + the new tar file handler A base #GsfInput @@ -2094,20 +2094,20 @@ A #GHashTable of names and source code (unknown encoding). glib:get-type="gsf_infile_zip_get_type"> Opens the root directory of a Zip file. <note>This adds a reference to @source.</note> - + the new zip file handler A base #GsfInput @@ -2117,7 +2117,7 @@ A #GHashTable of names and source code (unknown encoding). transfer-ownership="none" default-value="0"> Controls the level of compression used for new members. @@ -2147,52 +2147,52 @@ A #GHashTable of names and source code (unknown encoding). glib:get-type="gsf_input_get_type" glib:type-struct="InputClass"> Class representing an input stream. - + - + A new #GsfInputMemory The file on disk that you want to mmap - + A utility quark to flag a #GError as being an input problem. Duplicates @input leaving the new one at the same offset. - + the duplicate The input to duplicate @@ -2200,30 +2200,30 @@ A #GHashTable of names and source code (unknown encoding). UNIMPLEMENTED BY ANY BACKEND and it is probably unnecessary. gsf_input_get_container provides enough power to do what is necessary. Attempts to open a 'sibling' of @input. The caller is responsible for managing the resulting object. - + A related #GsfInput The input name. @@ -2231,14 +2231,14 @@ managing the resulting object. Read at least @num_bytes. Does not change the current position if there is an error. Will only read if the entire amount can be read. Invalidates the buffer associated with previous calls to gsf_input_read. - + pointer to the buffer or %NULL if there is an error or 0 bytes are requested. @@ -2248,13 +2248,13 @@ an error or 0 bytes are requested. the input stream number of bytes to read @@ -2263,7 +2263,7 @@ an error or 0 bytes are requested. nullable="1" allow-none="1"> Pointer to destination memory area @@ -2273,31 +2273,31 @@ an error or 0 bytes are requested. Move the current location in the input stream. - + %TRUE on error. the input stream target offset determines whether the offset is relative to the beginning or the end of the stream, or to the current location. @@ -2305,17 +2305,17 @@ an error or 0 bytes are requested. - + @input's container the input stream @@ -2323,28 +2323,28 @@ an error or 0 bytes are requested. Copy the contents from @input to @output from their respective current positions. So if you want to be sure to copy *everything*, make sure to call gsf_input_seek (input, 0, G_SEEK_SET) and gsf_output_seek (output, 0, G_SEEK_SET) first, if applicable. - + %TRUE on success a non-null #GsfInput a non-null #GsfOutput @@ -2352,22 +2352,22 @@ gsf_output_seek (output, 0, G_SEEK_SET) first, if applicable. Dumps @input's contents to STDOUT, optionally in hex format. - + a #GsfInput If %TRUE, dump in hexidecmal format @@ -2375,19 +2375,19 @@ gsf_output_seek (output, 0, G_SEEK_SET) first, if applicable. Duplicates @input leaving the new one at the same offset. - + the duplicate The input to duplicate @@ -2395,19 +2395,19 @@ gsf_output_seek (output, 0, G_SEEK_SET) first, if applicable. Are we at the end of the file? - + %TRUE if the input is at the eof. the input @@ -2415,19 +2415,19 @@ gsf_output_seek (output, 0, G_SEEK_SET) first, if applicable. A utility routine that attempts to find the VBA file withint a stream. - + a GsfInfile #GsfInput @@ -2436,10 +2436,10 @@ gsf_output_seek (output, 0, G_SEEK_SET) first, if applicable. - + A #GDateTime representing when the input was last modified, or %NULL if not known. @@ -2447,7 +2447,7 @@ was last modified, or %NULL if not known. the input stream @@ -2455,12 +2455,12 @@ was last modified, or %NULL if not known. The name of the input stream. - + @input's name in utf8 form, or %NULL if it has no name. @@ -2468,7 +2468,7 @@ has no name. the input stream @@ -2479,14 +2479,14 @@ has no name. shadowed-by="read0" introspectable="0"> Read at least @num_bytes. Does not change the current position if there is an error. Will only read if the entire amount can be read. Invalidates the buffer associated with previous calls to gsf_input_read. - + pointer to the buffer or %NULL if there is an error or 0 bytes are requested. @@ -2496,13 +2496,13 @@ an error or 0 bytes are requested. the input stream number of bytes to read @@ -2511,7 +2511,7 @@ an error or 0 bytes are requested. nullable="1" allow-none="1"> Pointer to destination memory area @@ -2521,13 +2521,13 @@ an error or 0 bytes are requested. Read @num_bytes. Does not change the current position if there is an error. Will only read if the entire amount can be read. - + the data read. @@ -2537,13 +2537,13 @@ the data read. the input stream number of bytes to read @@ -2552,24 +2552,24 @@ the data read. caller-allocates="0" transfer-ownership="full"> copy of @num_bytes - + the number of bytes left in the file. the input stream @@ -2577,31 +2577,31 @@ the data read. Move the current location in the input stream. - + %TRUE on error. the input stream target offset determines whether the offset is relative to the beginning or the end of the stream, or to the current location. @@ -2610,42 +2610,42 @@ the data read. Emulate forward seeks by reading. - + %TRUE if the emulation failed. stream to emulate seek for absolute position to seek to - + %TRUE if the assignment was ok. the input stream @@ -2659,19 +2659,19 @@ the data read. protected. - + %TRUE if the assignment was ok. the input stream @@ -2680,7 +2680,7 @@ the data read. nullable="1" allow-none="1"> the new modification time. @@ -2688,7 +2688,7 @@ the data read. - + @@ -2706,19 +2706,19 @@ the data read. protected. - + %TRUE if the assignment was ok. the input stream @@ -2727,7 +2727,7 @@ the data read. nullable="1" allow-none="1"> the new name of the stream @@ -2736,48 +2736,48 @@ the data read. protected. - + %TRUE if the assignment was ok. the input stream the (fs-sys encoded) filename - + %TRUE if the assignment was ok. the input stream the size of the stream @@ -2785,64 +2785,64 @@ the data read. UNIMPLEMENTED BY ANY BACKEND and it is probably unnecessary. gsf_input_get_container provides enough power to do what is necessary. Attempts to open a 'sibling' of @input. The caller is responsible for managing the resulting object. - + A related #GsfInput The input name. - + the total number of bytes in the input or -1 on error The input - + the current offset in the file. the input stream @@ -2850,13 +2850,13 @@ managing the resulting object. This functions takes ownership of the incoming reference and yields a new one as its output. - + A stream equivalent to the source stream, but uncompressed if the source was compressed. @@ -2864,7 +2864,7 @@ but uncompressed if the source was compressed. stream to be uncompressed. @@ -2872,7 +2872,7 @@ but uncompressed if the source was compressed. The container, optionally %NULL, in which this input lives. @@ -2881,13 +2881,13 @@ but uncompressed if the source was compressed. getter="eof" default-value="FALSE"> %TRUE if the end of the file has been reached. The time the input was last updated. This represents the timestamp from the originating file or @GsfInfile member. It is not supported by all derived classes. @@ -2898,19 +2898,19 @@ It is not supported by all derived classes. The current position in the input. The number of bytes remaining in the file. The total number of bytes in the file. @@ -2933,23 +2933,23 @@ It is not supported by all derived classes. - + - + the duplicate The input to duplicate @@ -2958,10 +2958,10 @@ It is not supported by all derived classes. - + pointer to the buffer or %NULL if there is an error or 0 bytes are requested. @@ -2971,13 +2971,13 @@ an error or 0 bytes are requested. the input stream number of bytes to read @@ -2986,7 +2986,7 @@ an error or 0 bytes are requested. nullable="1" allow-none="1"> Pointer to destination memory area @@ -2997,29 +2997,29 @@ an error or 0 bytes are requested. - + %TRUE on error. the input stream target offset determines whether the offset is relative to the beginning or the end of the stream, or to the current location. @@ -3029,23 +3029,23 @@ an error or 0 bytes are requested. - + A related #GsfInput The input name. @@ -3054,7 +3054,7 @@ an error or 0 bytes are requested. - + @@ -3062,7 +3062,7 @@ an error or 0 bytes are requested. - + @@ -3070,7 +3070,7 @@ an error or 0 bytes are requested. - + @@ -3078,7 +3078,7 @@ an error or 0 bytes are requested. - + @@ -3093,19 +3093,19 @@ an error or 0 bytes are requested. glib:get-type="gsf_input_gzip_get_type"> Adds a reference to @source. - + a new file or %NULL. The underlying data source. @@ -3139,10 +3139,10 @@ an error or 0 bytes are requested. glib:type-name="GsfInputGio" glib:get-type="gsf_input_gio_get_type"> - + A new #GsfInputGio or %NULL @@ -3155,10 +3155,10 @@ an error or 0 bytes are requested. - + A new #GsfInputGio or %NULL @@ -3171,10 +3171,10 @@ an error or 0 bytes are requested. - + A new #GsfInputGio or %NULL @@ -3192,17 +3192,17 @@ an error or 0 bytes are requested. glib:type-name="GsfInputHTTP" glib:get-type="gsf_input_http_get_type"> - + an open HTTP connection, ready for reading. A string containing the URL to retrieve @@ -3211,17 +3211,17 @@ an error or 0 bytes are requested. - + an allocated string containing the Content-Type field of the HTTP response. #GsfInputHTTP @@ -3230,17 +3230,17 @@ an error or 0 bytes are requested. - + an allocated string containing the URL used for input. #GsfInputHTTP @@ -3270,17 +3270,17 @@ an error or 0 bytes are requested. glib:type-name="GsfInputMemory" glib:get-type="gsf_input_memory_get_type"> - + A new #GsfInputMemory The input bytes @@ -3288,30 +3288,30 @@ an error or 0 bytes are requested. The length of @buf Whether you want this memory to be free'd at object destruction - + A new #GsfInputMemory The input bytes @@ -3319,7 +3319,7 @@ an error or 0 bytes are requested. The length of @buf @@ -3328,17 +3328,17 @@ an error or 0 bytes are requested. - + a new #GsfInputMemory or %NULL. a #GsfInput @@ -3347,17 +3347,17 @@ an error or 0 bytes are requested. - + a new #GsfInputMemory or %NULL. a #GIOChannel. @@ -3372,20 +3372,20 @@ an error or 0 bytes are requested. glib:get-type="gsf_input_proxy_get_type"> This creates a new proxy to the entire, given input source. See gsf_input_proxy_new_section for details. - + a new input object. The underlying data source. @@ -3394,7 +3394,7 @@ gsf_input_proxy_new_section for details. This creates a new proxy to a section of the given source. The new object will have its own current position, but any operation on it can change the source's position. @@ -3403,29 +3403,29 @@ If a proxy to a proxy is created, the intermediate proxy is short- circuited. This function will ref the source. - + a new input object. The underlying data source. Offset into source for start of section. Length of section. @@ -3439,17 +3439,17 @@ This function will ref the source. glib:type-name="GsfInputStdio" glib:get-type="gsf_input_stdio_get_type"> - + a new file or %NULL. in utf8. @@ -3457,13 +3457,13 @@ This function will ref the source. Assumes ownership of @file when succeeding. If @keep_open is true, ownership reverts to caller when the #GsfInput is closed. - + a new #GsfInput wrapper for @file. Note that if the file is not seekable, this function will make a local copy of the entire file. @@ -3471,7 +3471,7 @@ ownership reverts to caller when the #GsfInput is closed. The filename corresponding to @file. @@ -3480,13 +3480,13 @@ ownership reverts to caller when the #GsfInput is closed. nullable="1" allow-none="1"> an existing stdio <type>FILE</type> * Should @file be closed when the wrapper is closed @@ -3501,19 +3501,19 @@ ownership reverts to caller when the #GsfInput is closed. glib:get-type="gsf_input_textline_get_type"> <note>This adds a reference to @source.</note> - + a new file in some combination of ascii and utf8 @@ -3521,14 +3521,14 @@ ownership reverts to caller when the #GsfInput is closed. A utility routine to read things line by line from the underlying source. Trailing newlines and carriage returns are stripped, and the resultant buffer can be edited. - + the string read, or %NULL on eof. @@ -3537,7 +3537,7 @@ can be edited. #GsfInputTextline @@ -3545,14 +3545,14 @@ can be edited. A utility routine to read things line by line from the underlying source. Trailing newlines and carriage returns are stripped, and the resultant buffer can be edited. - + the string read, or %NULL on eof. @@ -3561,7 +3561,7 @@ can be edited. #GsfInputTextline @@ -3572,13 +3572,13 @@ can be edited. c:identifier="GSF_LE_GET_DOUBLE" introspectable="0"> Interpret binary data as a double in little endian order. - + pointer to storage @@ -3587,13 +3587,13 @@ can be edited. c:identifier="GSF_LE_GET_FLOAT" introspectable="0"> Interpret binary data as a float in little endian order. - + pointer to storage @@ -3602,13 +3602,13 @@ can be edited. c:identifier="GSF_LE_GET_GINT16" introspectable="0"> Interpret binary data as a signed 16-bit integer in little endian order. - + pointer to storage @@ -3617,13 +3617,13 @@ can be edited. c:identifier="GSF_LE_GET_GINT32" introspectable="0"> Interpret binary data as a signed 32-bit integer in little endian order. - + pointer to storage @@ -3632,13 +3632,13 @@ can be edited. c:identifier="GSF_LE_GET_GINT64" introspectable="0"> Interpret binary data as a signed 64-bit integer in little endian order. - + pointer to storage @@ -3647,13 +3647,13 @@ can be edited. c:identifier="GSF_LE_GET_GINT8" introspectable="0"> Interpret binary data as a signed 8-bit integer in little endian order. - + pointer to storage @@ -3662,13 +3662,13 @@ can be edited. c:identifier="GSF_LE_GET_GUINT16" introspectable="0"> Interpret binary data as an unsigned 16-bit integer in little endian order. - + pointer to storage @@ -3677,13 +3677,13 @@ can be edited. c:identifier="GSF_LE_GET_GUINT32" introspectable="0"> Interpret binary data as an unsigned 32-bit integer in little endian order. - + pointer to storage @@ -3692,13 +3692,13 @@ can be edited. c:identifier="GSF_LE_GET_GUINT64" introspectable="0"> Interpret binary data as an unsigned 64-bit integer in little endian order. - + pointer to storage @@ -3707,13 +3707,13 @@ can be edited. c:identifier="GSF_LE_GET_GUINT8" introspectable="0"> Interpret binary data as an unsigned 8-bit integer in little endian order. - + pointer to storage @@ -3722,18 +3722,18 @@ can be edited. c:identifier="GSF_LE_SET_DOUBLE" introspectable="0"> Store @dat in little endian order in memory pointed to by @p. - + pointer to storage double to be stored @@ -3742,18 +3742,18 @@ can be edited. c:identifier="GSF_LE_SET_FLOAT" introspectable="0"> Store @dat in little endian order in memory pointed to by @p. - + pointer to storage float to be stored @@ -3762,18 +3762,18 @@ can be edited. c:identifier="GSF_LE_SET_GINT16" introspectable="0"> Store @dat in little endian order in memory pointed to by @p. - + pointer to storage 16-bit signed integer @@ -3782,18 +3782,18 @@ can be edited. c:identifier="GSF_LE_SET_GINT32" introspectable="0"> Store @dat in little endian order in memory pointed to by @p. - + pointer to storage 32-bit signed integer @@ -3802,18 +3802,18 @@ can be edited. c:identifier="GSF_LE_SET_GINT64" introspectable="0"> Store @dat in little endian order in memory pointed to by @p. - + pointer to storage 64-bit signed integer @@ -3822,18 +3822,18 @@ can be edited. c:identifier="GSF_LE_SET_GINT8" introspectable="0"> Store @dat in little endian order in memory pointed to by @p. - + pointer to storage 8-bit signed integer @@ -3842,18 +3842,18 @@ can be edited. c:identifier="GSF_LE_SET_GUINT16" introspectable="0"> Store @dat in little endian order in memory pointed to by @p. - + pointer to storage 16-bit unsigned integer @@ -3862,18 +3862,18 @@ can be edited. c:identifier="GSF_LE_SET_GUINT32" introspectable="0"> Store @dat in little endian order in memory pointed to by @p. - + pointer to storage 32-bit unsigned integer @@ -3882,18 +3882,18 @@ can be edited. c:identifier="GSF_LE_SET_GUINT64" introspectable="0"> Store @dat in little endian order in memory pointed to by @p. - + pointer to storage 64-bit unsigned integer @@ -3902,18 +3902,18 @@ can be edited. c:identifier="GSF_LE_SET_GUINT8" introspectable="0"> Store @dat in little endian order in memory pointed to by @p. - + pointer to storage 8-bit unsigned integer @@ -3922,452 +3922,452 @@ can be edited. value="gsf:byte-count" c:type="GSF_META_NAME_BYTE_COUNT"> (Integer) Count of bytes in the document. - + (Unsigned Integer) Identifier representing the case-sensitiveness. <note>of what ?? why is it an integer ??</note> - + (String) Category of the document. <note>example???</note> - + (Integer) Count of cells in the spread-sheet document, if appropriate. - + (Integer) Count of characters in the document. TODO See how to sync this with ODF's document-statistic - + (UnsignedShort) The MS codepage to encode strings for metadata 1.14.0 Clarified that this is unique from _NAME_CODEPAGE in msole - + (String) Name of the company/organization that the "CREATOR" entity is associated with. 1.14.1 Moved from "gsf:company" to "dc:publisher". - + (String) An entity primarily responsible for making the content of the resource typically a person, organization, or service. 1.14.0 Moved from "gsf" to "dc". - + (Date as ISO String) A date associated with an event in the life cycle of the resource (creation/publication date). Moved from gsf:date-created to meta:creation-date. This way can be used correctly by OpenDocument and Gnumeric. - + (GsfTimestamp) The last time this document was saved. 1.14.0 Moved from dc:date-modified to dc:date. - + (String) An account of the content of the resource. - + (None) Reserved name (PID) for Dictionary - + (Vector of strings) Names of the 'interesting' parts of the document. In spreadsheets this is a list of the sheet names, and the named expressions. From MSOLE - + (Date as ISO String) The total-time taken until the last modification. Moved from "gsf" to "meta". This way can be used correctly by OpenDocument and Gnumeric. - + (String) The application that generated this document. AbiWord, Gnumeric, etc... 1.14.0 Moved from "gsf" to "meta". - + (Vector of string value pairs stored in alternating elements) Store the counts of objects in the document as names 'worksheet' and count '4' From MSOLE - + (Integer) Count of hidden-slides in the presentation document. - + (Integer) Count of images in the document, if appropriate. - + (String) Specifies the name of the person who created the document initially. 1.14.0 Moved from "gsf" to "meta". - + (String) Searchable, indexable keywords. Similar to PDF keywords or HTML's meta block. - + (GsfDocPropVector of String) Searchable, indexable keywords. Similar to PDF keywords or HTML's meta block. - + (String) The locale language of the intellectual content of the resource (basically xx_YY form for us). 1.14.0 Clarified that this is unique from _NAME_CODEPAGE in msole - + (GSF_META_NAME_HEADING_PAIRS) The last time this document was printed. 1.14.0 Moved from "gsf" to "dc". 1.14.1 Moved back to "gsf" from "dc". - + (String) The entity that made the last change to the document, typically a person, organization, or service. - + (Integer) Count of liness in the document. - + (Boolean) ??????? - + (Unsigned Integer) Identifier representing the default system locale. - + (String) Name of the manager of "CREATOR" entity. - + (Integer) Count of "multi-media" clips in the document. - + (Unknown) User-defined name - + (Unknown) User-defined name - + (Boolean) User-defined name - + (Unknown) User-defined name - + (Unknown) User-defined name - + (Boolean) User-defined name - + (i4) User-defined name - + (Integer) Count of "notes" in the document. - + (Integer) Count of objects (OLE and other graphics) in the document, if appropriate. - + (Integer) Count of pages in the document, if appropriate. - + (Integer) Count of paragraphs in the document, if appropriate. - + (String) Type of presentation, like "On-screen Show", "SlideView" etc. - + (String) Specifies the name of the last person who printed the document. 1.14.0 Moved from "gsf" to "meta". - + (GsfTimestamp) Specifies the date and time when the document was last printed. - + (Integer) Count of revision on the document, if appropriate. Moved from gsf:revision-count to meta:editing-cycles. This way can be used correctly by OpenDocument and Gnumeric. - + (Boolean) ????? - + (Integer) Level of security. <informaltable frame="none" role="params"> @@ -4382,83 +4382,83 @@ correctly by OpenDocument and Gnumeric. <row><entry>Read-only enforced</entry><entry>3</entry></row> <row><entry>Locked for annotations</entry><entry>4</entry></row> </tbody></tgroup></informaltable> - + (Integer) Count of slides in the presentation document. - + (Integer) Count of pages in the document, if appropriate. - + (String) The topic of the content of the resource, <emphasis>typically</emphasis> including keywords. - + (Integer) Count of tables in the document, if appropriate. - + (String) The template file that is been used to generate this document. 1.14.0 Moved from "gsf" to "meta" - + (GsfClipData) Thumbnail data of the document, typically a preview image of the document. - + (String) A formal name given to the resource. - + (Integer) Count of words in the document. - + glib:type-name="GsfMSOleSortingKey" glib:get-type="gsf_msole_sorting_key_get_type" c:symbol-prefix="msole_sorting_key"> - + - + @@ -4480,7 +4480,7 @@ preview image of the document. - + @@ -4494,7 +4494,7 @@ preview image of the document. - + @@ -4512,9 +4512,9 @@ preview image of the document. glib:type-name="GsfODFOut" glib:get-type="gsf_odf_out_get_type" glib:type-struct="ODFOutClass"> - + - + @@ -4526,7 +4526,7 @@ preview image of the document. - + @@ -4553,13 +4553,13 @@ preview image of the document. - + - + @@ -4567,7 +4567,7 @@ preview image of the document. - + @@ -4575,7 +4575,7 @@ preview image of the document. - + @@ -4583,7 +4583,7 @@ preview image of the document. - + @@ -4593,7 +4593,7 @@ preview image of the document. - + @@ -4602,7 +4602,7 @@ preview image of the document. - + @@ -4611,7 +4611,7 @@ preview image of the document. - + @@ -4620,7 +4620,7 @@ preview image of the document. - + @@ -4629,7 +4629,7 @@ preview image of the document. - + @@ -4638,7 +4638,7 @@ preview image of the document. - + @@ -4647,14 +4647,14 @@ preview image of the document. - + - + @@ -4663,7 +4663,7 @@ preview image of the document. - + @@ -4672,7 +4672,7 @@ preview image of the document. - + @@ -4681,7 +4681,7 @@ preview image of the document. - + @@ -4690,7 +4690,7 @@ preview image of the document. - + @@ -4699,7 +4699,7 @@ preview image of the document. - + @@ -4708,7 +4708,7 @@ preview image of the document. - + @@ -4717,7 +4717,7 @@ preview image of the document. - + @@ -4726,7 +4726,7 @@ preview image of the document. - + @@ -4735,14 +4735,14 @@ preview image of the document. - + - + @@ -4763,53 +4763,53 @@ preview image of the document. - + - + The target of @rel. #GsfOpenPkgRel - + The type of @rel. #GsfOpenPkgRel - + %TRUE if @rel has mode 'External' #GsfOpenPkgRel @@ -4820,7 +4820,7 @@ preview image of the document. c:type="GsfOpenPkgRels" disguised="1" opaque="1"> - + glib:get-type="gsf_outfile_get_type" glib:type-struct="OutfileClass"> Class representing an output file, counterpart to #GsfInfile. - + - + a newly created child A #GsfOutfile The name of the new child to create %TRUE to create a directory, %FALSE to create a plain file @@ -4872,29 +4872,29 @@ preview image of the document. - + a newly created child A #GsfOutfile The name of the new child to create %TRUE to create a directory, %FALSE to create a plain file @@ -4903,29 +4903,29 @@ preview image of the document. - + a newly created child A #GsfOutfile The name of the new child to create %TRUE to create a directory, %FALSE to create a plain file @@ -4940,29 +4940,29 @@ preview image of the document. - + a newly created child A #GsfOutfile The name of the new child to create %TRUE to create a directory, %FALSE to create a plain file @@ -4977,44 +4977,44 @@ preview image of the document. A convenience wrapper to create a child in @dir of @content_type then create a @type relation to @parent - + the new part. #GsfOutfile target name non-%NULL content type #GsfOutfile target type @@ -5027,35 +5027,35 @@ a @type relation to @parent - + - + a newly created child A #GsfOutfile The name of the new child to create %TRUE to create a directory, %FALSE to create a plain file @@ -5077,22 +5077,22 @@ a @type relation to @parent glib:get-type="gsf_outfile_msole_get_type"> Creates the root directory of an MS OLE file and manages the addition of children. <note>This adds a reference to @sink.</note> - + the new ole file handler. a #GsfOutput to hold the OLE2 file @@ -5100,34 +5100,34 @@ children. Creates the root directory of an MS OLE file and manages the addition of children. <note>This adds a reference to @sink.</note> - + the new ole file handler. a #GsfOutput to hold the OLE2 file. size of large blocks. size of small blocks. @@ -5136,25 +5136,25 @@ children. Write @clsid to the directory associated with @ole. - + %TRUE on success. a #GsfOutfileMSOle Identifier (often a GUID in MS Windows apps) @@ -5191,19 +5191,19 @@ children. glib:get-type="gsf_outfile_open_pkg_get_type"> Convenience routine to create a GsfOutfileOpenPkg inside @sink. - + a GsfOutfile that the caller is responsible for. #GsfOutfile @@ -5212,12 +5212,12 @@ children. Add an external relation to @parent. - + The id of the relation. The string is managed by the parent and should not be changed or freed by the caller. @@ -5226,19 +5226,19 @@ caller. #GsfOutfileOpenPkg target type target content @@ -5246,12 +5246,12 @@ caller. Create a relationship between @child and @parent of @type. - + the relID which the caller does not own but will live as long as @parent. @@ -5259,19 +5259,19 @@ caller. #GsfOutfileOpenPkg #GsfOutfileOpenPkg target type @@ -5279,14 +5279,14 @@ caller. - + #GsfOutfileOpenPkg @@ -5297,22 +5297,22 @@ caller. Assigns a GsfOutput (@sink) to store the package into. - + #GsfOutfileOpenPkg #GsfOutput @@ -5345,17 +5345,17 @@ caller. glib:type-name="GsfOutfileStdio" glib:get-type="gsf_outfile_stdio_get_type"> - + a new outfile or %NULL. root directory in utf8. @@ -5364,17 +5364,17 @@ caller. - + a new outfile or %NULL. root directory in utf8. @@ -5383,19 +5383,19 @@ caller. nullable="1" allow-none="1"> place to store a #GError if anything goes wrong name of first property to set value of first property, followed by more properties, %NULL-terminated @@ -5405,17 +5405,17 @@ caller. - + a new outfile or %NULL. root directory in utf8. @@ -5424,19 +5424,19 @@ caller. nullable="1" allow-none="1"> place to store a #GError if anything goes wrong name of first property to set a %NULL-terminated #va_list @@ -5451,22 +5451,22 @@ caller. glib:get-type="gsf_outfile_zip_get_type"> Creates the root directory of a Zip file and manages the addition of children. <note>This adds a reference to @sink.</note> - + the new zip file handler a #GsfOutput to hold the ZIP file @@ -5474,7 +5474,7 @@ children. - + @@ -5532,20 +5532,20 @@ children. glib:get-type="gsf_output_get_type" glib:type-struct="OutputClass"> Class representing an output stream, counterpart to #GsfInput. - + - + - + %TRUE if the unwrapping succeeded. @@ -5559,10 +5559,10 @@ children. - + %TRUE if the wrapping succeeded. @@ -5577,19 +5577,19 @@ children. Close a stream. - + %FALSE on error #GsfOutput @@ -5597,36 +5597,36 @@ children. Reposition in output stream @output. @whence specifies what the offset is relative to: the beginning of the stream (%G_SEEK_SET), current position in the stream (%G_SEEK_CUR) or the end of the stream (%G_SEEK_END). This function is similar to <citerefentry><refentrytitle>fseek</refentrytitle> <manvolnum>3</manvolnum></citerefentry>. - + %FALSE on error. #GsfOutput Relative amount to reposition What the offset is relative to. @@ -5634,33 +5634,33 @@ This function is similar to Output @args to @output using the format string @format, similar to <citerefentry><refentrytitle>vprintf</refentrytitle> <manvolnum>3</manvolnum></citerefentry>. - + number of bytes printed, a negative value if not successful A #GsfOutput The printf-style format string the arguments for @format @@ -5668,31 +5668,31 @@ This function is similar to Write @num_bytes of @data to @output. - + %FALSE on error. Output stream Number of bytes to write Data to write. @@ -5702,29 +5702,29 @@ This function is similar to Close a stream. - + %FALSE on error #GsfOutput - + @output's container @@ -5735,10 +5735,10 @@ This function is similar to - + the last error logged on the output @@ -5751,10 +5751,10 @@ This function is similar to - + A #GDateTime representing when the output was last modified @@ -5762,7 +5762,7 @@ the output was last modified the output stream @@ -5771,17 +5771,17 @@ the output was last modified - + %TRUE if @output has already been closed. #GsfOutput @@ -5789,19 +5789,19 @@ the output was last modified Give the name of @output. - + @output's name in utf8 form. #GsfOutput @@ -5811,33 +5811,33 @@ the output was last modified c:identifier="gsf_output_printf" introspectable="0"> Output @Varargs to @output using the format string @format, similar to <citerefentry><refentrytitle>printf</refentrytitle> <manvolnum>3</manvolnum></citerefentry>. - + %TRUE if successful, %FALSE if not A #GsfOutput The printf-style format string the arguments for @format @@ -5845,25 +5845,25 @@ the output was last modified Like fputs, this assumes that the line already ends with a newline - + %TRUE if successful, %FALSE if not A #GsfOutput Nul terminated string to write @@ -5871,36 +5871,36 @@ the output was last modified Reposition in output stream @output. @whence specifies what the offset is relative to: the beginning of the stream (%G_SEEK_SET), current position in the stream (%G_SEEK_CUR) or the end of the stream (%G_SEEK_END). This function is similar to <citerefentry><refentrytitle>fseek</refentrytitle> <manvolnum>3</manvolnum></citerefentry>. - + %FALSE on error. #GsfOutput Relative amount to reposition What the offset is relative to. @@ -5910,20 +5910,20 @@ This function is similar to c:identifier="gsf_output_set_container" glib:set-property="container"> <note>This is a utility routine that should only be used by derived outputs.</note> - + %TRUE if the assignment was ok. #GsfOutput @@ -5932,7 +5932,7 @@ outputs.</note> nullable="1" allow-none="1"> #GsfOutfile @@ -5942,55 +5942,55 @@ outputs.</note> c:identifier="gsf_output_set_error" introspectable="0"> <note>This is a utility routine that should only be used by derived outputs.</note> - + Always returns %FALSE to facilitate its use. #GsfOutput The error id printf style format string arguments for @format - + %TRUE if the assignment was ok. the output stream @@ -5999,7 +5999,7 @@ outputs.</note> nullable="1" allow-none="1"> the new modification time. @@ -6009,20 +6009,20 @@ outputs.</note> c:identifier="gsf_output_set_name" glib:set-property="name"> <note>This is a utility routine that should only be used by derived outputs.</note> - + %TRUE if the assignment was ok. #GsfOutput @@ -6031,7 +6031,7 @@ outputs.</note> nullable="1" allow-none="1"> the new name @@ -6040,20 +6040,20 @@ outputs.</note> <note>This is a utility routine that should only be used by derived outputs.</note> - + %TRUE if the assignment was ok. the output stream @@ -6062,7 +6062,7 @@ outputs.</note> nullable="1" allow-none="1"> the (fs-sys encoded) filename @@ -6070,19 +6070,19 @@ outputs.</note> Determine the size of the output stream @output. - + the size of the output, or -1 if it does not have a size. #GsfOutput @@ -6090,21 +6090,21 @@ outputs.</note> Tell the current position in @output, similar to <citerefentry><refentrytitle>ftell</refentrytitle> <manvolnum>3</manvolnum></citerefentry>. - + the current position in the file #GsfOutput @@ -6114,33 +6114,33 @@ outputs.</note> c:identifier="gsf_output_vprintf" introspectable="0"> Output @args to @output using the format string @format, similar to <citerefentry><refentrytitle>vprintf</refentrytitle> <manvolnum>3</manvolnum></citerefentry>. - + number of bytes printed, a negative value if not successful A #GsfOutput The printf-style format string the arguments for @format @@ -6148,31 +6148,31 @@ outputs.</note> Write @num_bytes of @data to @output. - + %FALSE on error. Output stream Number of bytes to write Data to write. @@ -6185,7 +6185,7 @@ outputs.</note> transfer-ownership="none" setter="set_container"> The container, optionally %NULL, in which this output lives. @@ -6194,7 +6194,7 @@ outputs.</note> getter="is_closed" default-value="FALSE"> %TRUE if the output has been closed. @@ -6204,7 +6204,7 @@ outputs.</note> transfer-ownership="none" getter="get_modtime"> The time the output was last updated. This must be set on object construction and represents the timestamp to put on the resulting file or #GsfOutfile member. Not all derived classes will actually @@ -6220,13 +6220,13 @@ do anything with this property. The current position in the output. The current file size. @@ -6269,19 +6269,19 @@ do anything with this property. glib:get-type="gsf_output_bzip_get_type"> Adds a reference to @sink. - + a new file or %NULL. The underlying data source. @@ -6291,23 +6291,23 @@ do anything with this property. - + - + %FALSE on error #GsfOutput @@ -6316,29 +6316,29 @@ do anything with this property. - + %FALSE on error. #GsfOutput Relative amount to reposition What the offset is relative to. @@ -6347,29 +6347,29 @@ do anything with this property. - + %FALSE on error. Output stream Number of bytes to write Data to write. @@ -6380,29 +6380,29 @@ do anything with this property. - + number of bytes printed, a negative value if not successful A #GsfOutput The printf-style format string the arguments for @format @@ -6417,9 +6417,9 @@ do anything with this property. glib:type-name="GsfOutputCsv" glib:get-type="gsf_output_csv_get_type" glib:type-struct="OutputCsvClass"> - + - + @@ -6430,7 +6430,7 @@ do anything with this property. - + @@ -6529,7 +6529,7 @@ do anything with this property. - + @@ -6539,7 +6539,7 @@ do anything with this property. glib:get-type="gsf_output_csv_quoting_mode_get_type" c:type="GsfOutputCsvQuotingMode"> Controls when to add quotes around fields. glib:nick="never" glib:name="GSF_OUTPUT_CSV_QUOTING_MODE_NEVER"> never add quotes around fields glib:nick="auto" glib:name="GSF_OUTPUT_CSV_QUOTING_MODE_AUTO"> add quotes around fields when needed glib:nick="always" glib:name="GSF_OUTPUT_CSV_QUOTING_MODE_ALWAYS"> always add quotes around fields @@ -6577,19 +6577,19 @@ do anything with this property. glib:get-type="gsf_output_gzip_get_type"> Adds a reference to @sink. - + a new file or %NULL. The underlying data source. @@ -6622,17 +6622,17 @@ do anything with this property. glib:type-name="GsfOutputGio" glib:get-type="gsf_output_gio_get_type"> - + A new #GsfOutputGio or %NULL an existing GFile @@ -6641,10 +6641,10 @@ do anything with this property. - + A new #GsfOutputGio or %NULL @@ -6657,10 +6657,10 @@ do anything with this property. - + A new #GsfOutputGio or %NULL @@ -6678,17 +6678,17 @@ do anything with this property. glib:type-name="GsfOutputIOChannel" glib:get-type="gsf_output_iochannel_get_type"> - + a new file or %NULL. A #GIOChannel @@ -6702,34 +6702,34 @@ do anything with this property. glib:type-name="GsfOutputIconv" glib:get-type="gsf_output_iconv_get_type" glib:type-struct="OutputIconvClass"> - + Adds a reference to @sink. - + a new GsfOutput object or %NULL. The underlying data source. The target character set. The source character set. @@ -6740,7 +6740,7 @@ do anything with this property. transfer-ownership="none" default-value="NULL"> Either NULL or a UTF-8 string (representable in the target encoding) to convert and output in place of characters that cannot be represented in the target encoding. NULL means use \u1234 or \U12345678 format. @@ -6770,7 +6770,7 @@ in the target encoding. NULL means use \u1234 or \U12345678 format. - + @@ -6782,19 +6782,19 @@ in the target encoding. NULL means use \u1234 or \U12345678 format. glib:type-name="GsfOutputMemory" glib:get-type="gsf_output_memory_get_type"> - + a new file. - + The data that has been written to @mem @@ -6803,17 +6803,17 @@ in the target encoding. NULL means use \u1234 or \U12345678 format. the output device. - + The data that has been written to @mem. The caller takes ownership and the buffer belonging to @mem is set to %NULL. @@ -6824,7 +6824,7 @@ to %NULL. the output device. @@ -6838,17 +6838,17 @@ to %NULL. glib:type-name="GsfOutputStdio" glib:get-type="gsf_output_stdio_get_type"> - + a new file or %NULL. name of file to create or replace. @@ -6858,13 +6858,13 @@ to %NULL. c:identifier="gsf_output_stdio_new_FILE" introspectable="0"> Assumes ownership of @file. If @keep_open is true, ownership reverts to caller when the GsfOutput is closed. - + a new GsfOutput wrapper for @file. Warning: the result will be seekable only if @file is seekable. If it is seekable, the resulting GsfOutput object will seek relative to @file's beginning, not its @@ -6874,7 +6874,7 @@ current location at the time the GsfOutput object is created. The filename corresponding to @file. @@ -6883,13 +6883,13 @@ current location at the time the GsfOutput object is created. nullable="1" allow-none="1"> an existing stdio <type>FILE</type> * Should @file be closed when the wrapper is closed @@ -6898,17 +6898,17 @@ current location at the time the GsfOutput object is created. - + a new file or %NULL. name of file to create or replace. @@ -6917,13 +6917,13 @@ current location at the time the GsfOutput object is created. nullable="1" allow-none="1"> place to store a #GError if anything goes wrong %NULL terminated list of properties @@ -6935,7 +6935,7 @@ current location at the time the GsfOutput object is created. - + @@ -6958,7 +6958,7 @@ current location at the time the GsfOutput object is created. - + @@ -6967,7 +6967,7 @@ current location at the time the GsfOutput object is created. - + @@ -6981,7 +6981,7 @@ current location at the time the GsfOutput object is created. glib:get-type="gsf_shared_memory_get_type"> - + @@ -6998,7 +6998,7 @@ current location at the time the GsfOutput object is created. - + @@ -7041,20 +7041,20 @@ current location at the time the GsfOutput object is created. glib:get-type="gsf_structured_blob_get_type"> Create a tree of binary blobs with unknown content from a #GsfInput or #GsfInfile and store it in a newly created #GsfStructuredBlob. - + a new #GsfStructuredBlob object which the caller is responsible for. An input (potentially a GsfInfile) holding the blob @@ -7062,26 +7062,26 @@ current location at the time the GsfOutput object is created. Dumps structured blob @blob onto the @container. Will fail if the output is not an Outfile and blob has multiple streams. - + %TRUE on success. #GsfStructuredBlob #GsfOutfile @@ -7094,47 +7094,47 @@ not an Outfile and blob has multiple streams. glib:get-type="gsf_timestamp_get_type" c:symbol-prefix="timestamp"> A point in time. - + #GDate in local timezone #glong number of seconds since @date. possibly blank #GString of the timezone as from g_date_time_to_unix. - + Produce a string representation (ISO 8601 format) of @stamp. - + a string representation of @stamp. When @stamp is invalid, the representation is "&lt;invalid&gt;". @@ -7142,7 +7142,7 @@ representation is "&lt;invalid&gt;". timestamp to be converted. @@ -7150,19 +7150,19 @@ representation is "&lt;invalid&gt;". Copies a timestamp. - + a separate copy of @stamp. timestamp to be copied @@ -7170,25 +7170,25 @@ representation is "&lt;invalid&gt;". Compare timestamps @a and @b. - + true if @a and @b represent the same point in time; false otherwise. a timestamp another timestamp @@ -7196,23 +7196,23 @@ representation is "&lt;invalid&gt;". Releases the memory in use for @stamp (if any). - + timestamp to be freed - + @@ -7226,32 +7226,32 @@ representation is "&lt;invalid&gt;". c:identifier="gsf_timestamp_load_from_string" version="1.14.24"> Parser for time stamps. Requires a ISO 8601 formatted string. - + %TRUE on success #GsfTimestamp The string to parse - + @@ -7268,22 +7268,22 @@ representation is "&lt;invalid&gt;". c:identifier="gsf_timestamp_to_value" version="1.14.24"> Calls g_value_set_box (value, stamp); - + #GsfTimestamp #GValue @@ -7293,7 +7293,7 @@ representation is "&lt;invalid&gt;". - + @@ -7302,66 +7302,66 @@ representation is "&lt;invalid&gt;". - + - + Controls the handling of character data within a parser node. - + filename="gsf/gsf-libxml.h" + line="57">Controls the handling of character data within a parser node. + node has no cstr contents + filename="gsf/gsf-libxml.h" + line="59">node has no cstr contents node has cstr contents + filename="gsf/gsf-libxml.h" + line="60">node has cstr contents node has contents that is shared with children + filename="gsf/gsf-libxml.h" + line="61">node has contents that is shared with children node is second or later occurrence + filename="gsf/gsf-libxml.h" + line="62">node is second or later occurrence - + user data the current node content Current document being parsed #GsfXMLInDoc current node (not on the stack) @@ -7372,12 +7372,12 @@ representation is "&lt;invalid&gt;". According to @state is @str in the namespace @ns_id ? - + a pointer to @str after the namespace if successful, otherwise %NULL. @@ -7385,19 +7385,19 @@ if successful, otherwise %NULL. #GsfXMLIn string to check the namespace id @@ -7405,19 +7405,19 @@ if successful, otherwise %NULL. (New in 1.14.2) - + (but does not reference) the stream being parsed. #GsfXMLIn @@ -7425,38 +7425,38 @@ if successful, otherwise %NULL. Checks to see if @str is the same as @ns_id::@name with either an explicit namespace or the current default namespace. - + %TRUE if @str == @ns_id:@name according to @state. The #GsfXMLIn we are reading from. The potentially namespace qualified node name. The name space id to check The target node name @@ -7464,22 +7464,22 @@ namespace or the current default namespace. Take the first node from @doc as the current node and call its start handler. - + #GsfXMLIn #GsfXMLInDoc @@ -7488,19 +7488,19 @@ namespace or the current default namespace. nullable="1" allow-none="1"> arbitrary content for the parser #GsfXMLInExtDtor array of xmlChar const * @@ -7511,25 +7511,25 @@ namespace or the current default namespace. (New in 1.14.33) This provides a means to silently ignore unknown tags in contexts where they are expected. - + #GsfXMLIn whether to be silent about unknown tags @@ -7542,24 +7542,24 @@ they are expected. glib:type-name="GsfXMLInDoc" glib:get-type="gsf_xml_in_doc_get_type" c:symbol-prefix="xml_in_doc"> - + Combine the nodes in the %NULL terminated array starting at @nodes with the name spaces in the %NULL terminated array starting at @ns. Prepare the data structures necessary to validate a doument based on that description. - + a #GsfXMLInDoc an array of node descriptors @@ -7567,7 +7567,7 @@ data structures necessary to validate a doument based on that description. an array of namespace identifiers @@ -7577,22 +7577,22 @@ data structures necessary to validate a doument based on that description. Adds additional nodes to the structure of @doc - + #GsfXMLInDoc %NULL terminated array of #GsfXMLInNode @@ -7602,16 +7602,16 @@ data structures necessary to validate a doument based on that description. Free up resources - + A #GsfXMLInDoc @@ -7619,26 +7619,26 @@ data structures necessary to validate a doument based on that description. Read an xml document from @input and parse based on the the descriptor in @doc - + %FALSE on error #GsfXMLInDoc #GsfInput @@ -7647,7 +7647,7 @@ data structures necessary to validate a doument based on that description. nullable="1" allow-none="1"> arbitrary content stored in the parser @@ -7656,22 +7656,22 @@ data structures necessary to validate a doument based on that description. Call the function @handler when an unexpected child node is found - + #GsfXMLInDoc The function to call @@ -7679,7 +7679,7 @@ data structures necessary to validate a doument based on that description. - + @@ -7700,9 +7700,11 @@ data structures necessary to validate a doument based on that description. glib:type-name="GsfXMLInNS" glib:get-type="gsf_xml_in_ns_get_type" c:symbol-prefix="xml_in_ns"> - + - URI + URI @@ -7710,34 +7712,34 @@ data structures necessary to validate a doument based on that description. - + identifier unique in the entire tree namespace identifier node name parent node identifier - + @@ -7753,7 +7755,7 @@ data structures necessary to validate a doument based on that description. - + @@ -7768,7 +7770,7 @@ data structures necessary to validate a doument based on that description. - + @@ -7784,25 +7786,25 @@ data structures necessary to validate a doument based on that description. whether the node has content whether to check namespace for children whether to share children with parent. - + @@ -7825,22 +7827,22 @@ data structures necessary to validate a doument based on that description. glib:type-name="GsfXMLOut" glib:get-type="gsf_xml_out_get_type" glib:type-struct="XMLOutClass"> - + Create an XML output stream. - + #GsfXMLOut #GsfOutput @@ -7848,16 +7850,16 @@ data structures necessary to validate a doument based on that description. Dump @len bytes in @data into the content of node @id using base64 - + #GsfXMLOut @@ -7866,13 +7868,13 @@ data structures necessary to validate a doument based on that description. nullable="1" allow-none="1"> tag id, or %NULL for node content Data to be written @@ -7880,7 +7882,7 @@ data structures necessary to validate a doument based on that description. Length of data @@ -7888,17 +7890,17 @@ data structures necessary to validate a doument based on that description. dump boolean value @val to an attribute named @id or as the nodes content Use '1' or '0' to simplify import - + #GsfXMLOut @@ -7907,13 +7909,13 @@ Use '1' or '0' to simplify import nullable="1" allow-none="1"> tag id, or %NULL for node content a boolean @@ -7921,16 +7923,16 @@ Use '1' or '0' to simplify import dump Color @r.@g.@b to an attribute named @id or as the nodes content - + #GsfXMLOut @@ -7939,25 +7941,25 @@ Use '1' or '0' to simplify import nullable="1" allow-none="1"> tag id, or %NULL for node content Red value Green value Blue value @@ -7965,18 +7967,18 @@ Use '1' or '0' to simplify import dump @val_utf8 to an attribute named @id or as the nodes content escaping characters as necessary. If @val_utf8 is %NULL do nothing (no warning, no output) - + #GsfXMLOut @@ -7985,7 +7987,7 @@ output) nullable="1" allow-none="1"> tag id, or %NULL for node content @@ -7994,7 +7996,7 @@ output) nullable="1" allow-none="1"> a utf8 encoded string @@ -8003,19 +8005,19 @@ output) dump @val_utf8 to an attribute named @id without checking to see if the content needs escaping. A useful performance enhancement when the application knows that structure of the content well. If @val_utf8 is %NULL do nothing (no warning, no output) - + #GsfXMLOut @@ -8024,7 +8026,7 @@ the application knows that structure of the content well. If nullable="1" allow-none="1"> tag id, or %NULL for node content @@ -8033,7 +8035,7 @@ the application knows that structure of the content well. If nullable="1" allow-none="1"> a utf8 encoded string to export @@ -8041,16 +8043,16 @@ the application knows that structure of the content well. If Output the name of value @val of enumeration type @etype. - + #GsfXMLOut @@ -8059,19 +8061,19 @@ the application knows that structure of the content well. If nullable="1" allow-none="1"> tag id, or %NULL for node content #GType enum element number @@ -8079,18 +8081,18 @@ the application knows that structure of the content well. If dump float value @val to an attribute named @id or as the nodes content with precision @precision. The number will be formattted according to the "C" locale. - + #GsfXMLOut @@ -8099,19 +8101,19 @@ according to the "C" locale. nullable="1" allow-none="1"> tag id, or %NULL for node content the value the number of significant digits to use, -1 meaning "enough". @@ -8119,17 +8121,17 @@ according to the "C" locale. Output the value of @val as a string. Does NOT store any type information with the string, just thevalue. - + #GsfXMLOut @@ -8138,13 +8140,13 @@ with the string, just thevalue. nullable="1" allow-none="1"> tag id, or %NULL for node content #GValue @@ -8152,16 +8154,16 @@ with the string, just thevalue. dump integer value @val to an attribute named @id or as the nodes content - + #GsfXMLOut @@ -8170,13 +8172,13 @@ with the string, just thevalue. nullable="1" allow-none="1"> tag id, or %NULL for node content the value @@ -8184,17 +8186,17 @@ with the string, just thevalue. dump unsigned integer value @val to an attribute named @id or as the nodes content - + #GsfXMLOut @@ -8203,13 +8205,13 @@ content nullable="1" allow-none="1"> tag id, or %NULL for node content the value @@ -8217,19 +8219,19 @@ content Closes/ends an XML element. - + the element that has been closed. #GsfXMLOut @@ -8237,19 +8239,19 @@ content Get the #GsfOutput we are writing to.. - + #GsfInput #GsfXMLOut @@ -8258,10 +8260,10 @@ content - + the current state of the pretty-print flag. Note, that gsf_xml_out_set_pretty_print will return the same value. @@ -8269,7 +8271,7 @@ gsf_xml_out_set_pretty_print will return the same value. #GsfXMLOut @@ -8277,22 +8279,22 @@ gsf_xml_out_set_pretty_print will return the same value. Store some optional &lt;!DOCTYPE .. &gt; content - + #GsfXMLOut the document type declaration @@ -8301,23 +8303,23 @@ gsf_xml_out_set_pretty_print will return the same value. - + the previous state of the pretty-print flag. #GsfXMLOut new state of pretty-print flag. @@ -8325,28 +8327,28 @@ gsf_xml_out_set_pretty_print will return the same value. Convenience routine to output a simple @id element with content @content. - + #GsfXMLOut Element name Content of the element @@ -8355,35 +8357,35 @@ gsf_xml_out_set_pretty_print will return the same value. Convenience routine to output an element @id with float value @val using @precision significant digits. - + #GsfXMLOut Element name Element value the number of significant digits to use, -1 meaning "enough". @@ -8392,28 +8394,28 @@ gsf_xml_out_set_pretty_print will return the same value. Convenience routine to output an element @id with integer value @val. - + #GsfXMLOut Element name Element value @@ -8421,22 +8423,22 @@ gsf_xml_out_set_pretty_print will return the same value. Output a start element @id, if necessary preceeded by an XML declaration. - + #GsfXMLOut Element name @@ -8469,13 +8471,13 @@ gsf_xml_out_set_pretty_print will return the same value. - + - + @@ -8483,7 +8485,7 @@ gsf_xml_out_set_pretty_print will return the same value. - + @@ -8491,7 +8493,7 @@ gsf_xml_out_set_pretty_print will return the same value. - + @@ -8499,7 +8501,7 @@ gsf_xml_out_set_pretty_print will return the same value. - + @@ -8507,7 +8509,7 @@ gsf_xml_out_set_pretty_print will return the same value. - + @@ -8541,7 +8543,7 @@ gsf_xml_out_set_pretty_print will return the same value. - + @@ -8550,7 +8552,7 @@ gsf_xml_out_set_pretty_print will return the same value. - + @@ -8581,19 +8583,19 @@ gsf_xml_out_set_pretty_print will return the same value. Decodes a chunk of base64 encoded data from @data back into @data. - + the number of bytes converted data stream @@ -8601,7 +8603,7 @@ gsf_xml_out_set_pretty_print will return the same value. max length of data to decode @@ -8609,19 +8611,19 @@ gsf_xml_out_set_pretty_print will return the same value. Decodes a chunk of base64 encoded data - + the number of bytes converted input stream @@ -8629,13 +8631,13 @@ gsf_xml_out_set_pretty_print will return the same value. max length of data to decode output stream @@ -8646,7 +8648,7 @@ gsf_xml_out_set_pretty_print will return the same value. caller-allocates="0" transfer-ownership="full"> holds the number of bits that are stored in @save @@ -8655,7 +8657,7 @@ gsf_xml_out_set_pretty_print will return the same value. caller-allocates="0" transfer-ownership="full"> leftover bits that have not yet been decoded @@ -8664,20 +8666,20 @@ gsf_xml_out_set_pretty_print will return the same value. This funcion should be called to when finished encoding everything, to flush off the last little bit. - + a count of the number of bytes in the final block. Data to be encoded @@ -8685,19 +8687,19 @@ flush off the last little bit. Length of data to be encoded Whether to use line breaks Encoded data. @@ -8708,7 +8710,7 @@ flush off the last little bit. caller-allocates="0" transfer-ownership="full"> holds the number of bits that are stored in @save @@ -8717,7 +8719,7 @@ flush off the last little bit. caller-allocates="0" transfer-ownership="full"> leftover bits that have not yet been decoded @@ -8726,19 +8728,19 @@ flush off the last little bit. Encodes data from @data back into @data using base64 encoding. - + the number of bytes encoded data stream @@ -8746,7 +8748,7 @@ flush off the last little bit. max length of data to encode @@ -8754,21 +8756,21 @@ flush off the last little bit. Performs an 'encode step', only encodes blocks of 3 characters from @in into the output @out at a time, saves left-over state in @state and @save (initialise to 0 on first invocation). - + the number of bytes encoded input stream @@ -8776,19 +8778,19 @@ the output @out at a time, saves left-over state in @state and @save max length of data to decode Whether to use line breaks output stream @@ -8799,7 +8801,7 @@ the output @out at a time, saves left-over state in @state and @save caller-allocates="0" transfer-ownership="full"> holds the number of bits that are stored in @save @@ -8808,14 +8810,14 @@ the output @out at a time, saves left-over state in @state and @save caller-allocates="0" transfer-ownership="full"> leftover bits that have not yet been decoded - + @@ -8827,16 +8829,16 @@ the output @out at a time, saves left-over state in @state and @save A debugging utility to dump the content of @meta via g_print - + #GsfDocMetaData @@ -8845,7 +8847,7 @@ the output @out at a time, saves left-over state in @state and @save the #GQuark used to identify libgsf errors in #GError structures. Specific error codes come from the #GsfError enumeration. @@ -8853,13 +8855,13 @@ the output @out at a time, saves left-over state in @state and @save Extracts the extension from the end of a filename (the part after the final '.' in the filename). - + A pointer to the extension part of the filename, or a pointer to the end of the string if the filename does not have an extension. @@ -8868,7 +8870,7 @@ does not have an extension. A filename or file path. @@ -8876,26 +8878,26 @@ does not have an extension. A utility wrapper to make sure filenames are valid utf8. Caller must g_free the result. - + @filename using utf-8 encoding for display file name suitable for open(2). if %TRUE, the resulting utf8 file name will be quoted (unless it is invalid). @@ -8906,16 +8908,16 @@ Caller must g_free the result. c:identifier="gsf_iconv_close" introspectable="0"> A utility wrapper to safely close an iconv handle. - + handle to be closed. @@ -8923,25 +8925,25 @@ Caller must g_free the result. Initializes the GSF library - + Initializes the GSF library and associates it with a type module @mod. - + #GTypeModule. @@ -8949,12 +8951,12 @@ Caller must g_free the result. Interpret binary data as a double in little endian order. - + interpreted data @@ -8964,7 +8966,7 @@ Caller must g_free the result. nullable="1" allow-none="1"> pointer to storage @@ -8972,12 +8974,12 @@ Caller must g_free the result. Interpret binary data as a float in little endian order. - + interpreted data @@ -8987,7 +8989,7 @@ Caller must g_free the result. nullable="1" allow-none="1"> pointer to storage @@ -8995,13 +8997,13 @@ Caller must g_free the result. Interpret binary data as a guint64 (8 byte unsigned integer type) in little endian order. - + interpreted data @@ -9011,7 +9013,7 @@ endian order. nullable="1" allow-none="1"> pointer to storage @@ -9019,9 +9021,9 @@ endian order. Store a value of type double in memory in little endian order - + @@ -9031,13 +9033,13 @@ endian order. nullable="1" allow-none="1"> pointer to storage double to be stored @@ -9045,9 +9047,9 @@ endian order. Store a value of type float in memory in little endian order. - + @@ -9057,13 +9059,13 @@ endian order. nullable="1" allow-none="1"> pointer to storage float to be stored @@ -9071,22 +9073,22 @@ endian order. Dump @len bytes from the memory location given by @ptr. - + memory area to be dumped. how many bytes will be dumped. @@ -9094,7 +9096,7 @@ endian order. - + @@ -9108,12 +9110,12 @@ endian order. c:identifier="gsf_msole_iconv_open_codepage_for_export" introspectable="0"> NOTE: skipped since GIConv is not exported to introspection. - + an iconv converter to go from utf8 -> to our best guess at a useful windows codepage. @@ -9121,7 +9123,7 @@ endian order. the target code page. @@ -9131,25 +9133,25 @@ endian order. c:identifier="gsf_msole_iconv_open_codepage_for_import" introspectable="0"> NOTE: skipped since GIConv is not exported to introspection. - + an iconv converter for @codepage -> utf8. the target encoding. the source code page. @@ -9159,12 +9161,12 @@ endian order. c:identifier="gsf_msole_iconv_open_codepages_for_export" introspectable="0"> NOTE: skipped since GIConv is not exported to introspection. - + an iconv converter to go from utf8 -> to our best guess at a useful windows codepage. @@ -9172,13 +9174,13 @@ endian order. the target code page. the source encoding. @@ -9188,12 +9190,12 @@ endian order. c:identifier="gsf_msole_iconv_open_for_export" introspectable="0"> NOTE: skipped since GIConv is not exported to introspection. - + an iconv convert to go from utf8 -> to our best guess at a useful windows codepage. @@ -9203,12 +9205,12 @@ endian order. c:identifier="gsf_msole_iconv_open_for_import" introspectable="0"> NOTE: skipped since GIConv is not exported to introspection. - + an iconv converter for single byte encodings @codepage -> utf8. Attempt to handle the semantics of a specification for multibyte encodings since this is only supposed to be used for single bytes. @@ -9217,7 +9219,7 @@ endian order. the source code page. @@ -9225,10 +9227,10 @@ endian order. - + our best guess at the applicable windows code page based on an environment variable or the current locale. @@ -9236,12 +9238,12 @@ endian order. Decompresses an LZ compressed stream. - + A GByteArray that the caller is responsible for freeing @@ -9250,13 +9252,13 @@ endian order. stream to read from offset into it for start byte of compresse stream @@ -9264,10 +9266,10 @@ endian order. - + the xx_YY style string (can be just xx or xxx) for the given LID. If the LID is not found, is set to 0x0400, or is set to 0x0000, will return "-none-" @@ -9276,7 +9278,7 @@ or is set to 0x0000, will return "-none-" numerical language id @@ -9284,10 +9286,10 @@ or is set to 0x0000, will return "-none-" - + the LID (Language Identifier) for the input language. If lang is %NULL, return 0x0400 ("-none-"), and not 0x0000 ("no proofing") @@ -9298,7 +9300,7 @@ or is set to 0x0000, will return "-none-" nullable="1" allow-none="1"> Language id, i.e., locale name. @@ -9306,17 +9308,17 @@ or is set to 0x0000, will return "-none-" - + our best guess at the codepage for the given language id numerical language id @@ -9324,10 +9326,10 @@ or is set to 0x0000, will return "-none-" - + the Iconv codepage string for the given LID. @@ -9335,7 +9337,7 @@ LID. numerical language id @@ -9344,10 +9346,10 @@ LID. - + the used ODF namespace @@ -9356,12 +9358,12 @@ LID. c:identifier="gsf_odf_get_version" version="1.14.24"> Gives the ODF version used by libgsf when writing Open Document files. - + the ODF version: 102. @@ -9370,18 +9372,18 @@ LID. c:identifier="gsf_odf_get_version_string" version="1.14.24"> Gives the ODF version used by libgsf when writing Open Document files. - + the ODF version as a string: "1.2". - + @@ -9389,18 +9391,18 @@ LID. New in 1.14.9 Walks each relationship associated with @opkg and calls @func with @user_data. - + #GsfInput @@ -9409,7 +9411,7 @@ Walks each relationship associated with @opkg and calls @func with @user_data. #GsfOpenPkgIter @@ -9418,7 +9420,7 @@ Walks each relationship associated with @opkg and calls @func with @user_data. gpointer @@ -9428,29 +9430,29 @@ Walks each relationship associated with @opkg and calls @func with @user_data. New in 1.14.6 Finds @opkg's relation with @id NOTE: skipping because gsf_open_pkg_rel_get_type() does not return a GType. - + A #GsfOpenPkgRel or %NULL #GsfInput identifier. @@ -9460,29 +9462,29 @@ NOTE: skipping because gsf_open_pkg_rel_get_type() does not return a GType. New in 1.14.6 Finds _a_ relation of @opkg with @type (no order is guaranteed) NOTE: skipping because gsf_open_pkg_rel_get_type() does not return a GType. - + A #GsfOpenPkgRel or %NULL #GsfInput target @@ -9491,23 +9493,23 @@ NOTE: skipping because gsf_open_pkg_rel_get_type() does not return a GType. - + a new #GsfInput which the called needs to unref, or %NULL and sets @err #GsfInput #GsfOpenPkgRel @@ -9517,27 +9519,27 @@ NOTE: skipping because gsf_open_pkg_rel_get_type() does not return a GType. New in 1.14.7 Open @opkg's relation @id - + A new GsfInput or %NULL, and sets @err if possible. #GsfInput target id @@ -9547,27 +9549,27 @@ Open @opkg's relation @id c:identifier="gsf_open_pkg_open_rel_by_type" throws="1"> New in 1.14.9 Open one of @opkg's relationships with type=@type. - + A new GsfInput or %NULL, and sets @err if possible. #GsfInput target type @@ -9576,37 +9578,37 @@ Open one of @opkg's relationships with type=@type. Convenience function to parse a related part. - + %NULL on success or a #GError on failure. #GsfXMLIn target id #GsfXMLInNode #GsfXMLInNS @@ -9615,7 +9617,7 @@ Open one of @opkg's relationships with type=@type. - + @@ -9641,22 +9643,22 @@ Open one of @opkg's relationships with type=@type. c:identifier="gsf_property_settings_collect_valist" introspectable="0"> This function builds a GParameter array suitable for g_object_newv. - + the GType for which the properties are being set. a pointer to the GParameter array that holds the properties. (Used for both input and output. This may point to a %NULL pointer if there are no properties collected yet.) @@ -9664,20 +9666,20 @@ Open one of @opkg's relationships with type=@type. a pointer to the number of properties collected. (Used for both input and output.) the name of the first property being set, or %NULL. a va_list holding the remainder of the property names and values, terminated by a %NULL. @@ -9686,7 +9688,7 @@ Open one of @opkg's relationships with type=@type. - + @@ -9706,7 +9708,7 @@ Open one of @opkg's relationships with type=@type. - + @@ -9723,27 +9725,27 @@ Open one of @opkg's relationships with type=@type. De-intializes the GSF library Currently does nothing. - + De-intializes the GSF library from a type module. Currently does nothing. - + currently unused @@ -9752,13 +9754,13 @@ Currently does nothing. This function returns the array of values inside #GsfDocPropVector. No additional references are created. - + A #GArray of #GValue @@ -9768,7 +9770,7 @@ of #GValue A GValue of type #GsfDocPropVector. @@ -9776,7 +9778,7 @@ of #GValue - + @@ -9789,20 +9791,20 @@ of #GValue This function returns a pointer to the GsfDocPropVector structure in @value. No additional references are created. - + A pointer to the #GsfDocPropVector structure in @value A GValue of type #GsfDocPropVector. @@ -9810,37 +9812,37 @@ No additional references are created. Decompresses VBA stream. - + A pointer to guint8 array stream to read from offset into it for start byte of compressed stream size of the returned array whenever add or not null at the end of array @@ -9848,25 +9850,25 @@ No additional references are created. Dumps the document @cur into @output. - + status from xmlSaveFormatFileTo. #GsfOutput #xmlDocPtr @@ -9875,13 +9877,13 @@ No additional references are created. nullable="1" allow-none="1"> The encoding to use. %TRUE to reformat the output. @@ -9890,12 +9892,12 @@ No additional references are created. Try to parse @str as a value of type @t into @res. - + True when parsing of @str as a value of type @t was succesfull; false otherwise. @@ -9903,19 +9905,19 @@ false otherwise. Result value Type of data Value string @@ -9925,7 +9927,7 @@ false otherwise. c:identifier="gsf_xml_parser_context" introspectable="0"> Create a libxml2 pull style parser context wrapper around gsf input @input. This signature will probably change to supply a SAX structure. @@ -9934,40 +9936,40 @@ This signature will probably change to supply a SAX structure. when we add other api changes. Its not worth bumping just for this.</note> NOTE: skipped since xmlParserCtxt is not exported to introspection. - + A parser context #GsfInput - + TRUE on success. #GsfInput #GsfXMLProbeFunc @@ -9975,7 +9977,7 @@ NOTE: skipped since xmlParserCtxt is not exported to introspection. #GsfInfile and #GsfOutfile support for zip files. diff --git a/girs/Gsk-4.0.gir b/girs/Gsk-4.0.gir index f6ae49faf..0c2380752 100644 --- a/girs/Gsk-4.0.gir +++ b/girs/Gsk-4.0.gir @@ -4628,10 +4628,10 @@ and end point. To add a closed path, use [method@Gsk.PathBuilder.add_path]. Adds an elliptical arc from the current point to @x3, @y3 + line="1138">Adds an elliptical arc from the current point to @x2, @y2 with @x1, @y1 determining the tangent directions. -After this, @x3, @y3 will be the new current point. +After this, @x2, @y2 will be the new current point. Note: Two points and their tangents do not determine a unique ellipse, so GSK just picks one. If you need more @@ -5095,7 +5095,7 @@ This function is intended primarily for language bindings. version="4.14"> Adds an elliptical arc from the current point to @x3, @y3 + line="1175">Adds an elliptical arc from the current point to @x2, @y2 with @x1, @y1 determining the tangent directions. All coordinates are given relative to the current point. diff --git a/girs/Gst-1.0.gir b/girs/Gst-1.0.gir index 287e27ba7..07bd52cc4 100644 --- a/girs/Gst-1.0.gir +++ b/girs/Gst-1.0.gir @@ -19,7 +19,7 @@ and/or use gtk-doc annotations. --> Alias for #GstMapInfo to be used with g_auto(): + line="804">Alias for #GstMapInfo to be used with g_auto(): ```c void my_func(GstBuffer *buf) { @@ -35,7 +35,7 @@ void my_func(GstBuffer *buf) needs to be unmapped using gst_buffer_unmap() or gst_memory_unmap(). See also #GstMemoryMapInfo. - + @@ -176,30 +176,30 @@ See also #GstBufferMapInfo. version="1.20"> Create a new #GstAllocationParams on the heap. This function is for + line="147">Create a new #GstAllocationParams on the heap. This function is for use in GStreamer language bindings. In your own code, you can just declare a #GstAllocationParams on the stack or in a struct, and call gst_allocation_params_init() to initialize it. You do not need to call gst_allocation_params_init() on the instance returned by this function. - + a new #GstAllocationParams + line="158">a new #GstAllocationParams Create a copy of @params. - + line="186">Create a copy of @params. + a new #GstAllocationParams. + line="192">a new #GstAllocationParams. @@ -209,7 +209,7 @@ returned by this function. allow-none="1"> a #GstAllocationParams + line="188">a #GstAllocationParams @@ -217,8 +217,8 @@ returned by this function. Free @params - + line="207">Free @params + @@ -226,7 +226,7 @@ returned by this function. a #GstAllocationParams + line="209">a #GstAllocationParams @@ -234,8 +234,8 @@ returned by this function. Initialize @params to its default values - + line="172">Initialize @params to its default values + @@ -243,7 +243,7 @@ returned by this function. a #GstAllocationParams + line="174">a #GstAllocationParams @@ -270,17 +270,17 @@ default allocator. New memory can be created with gst_memory_new_wrapped() that wraps the memory allocated elsewhere. - + Find a previously registered allocator with @name. When @name is %NULL, the + line="243">Find a previously registered allocator with @name. When @name is %NULL, the default allocator will be returned. - + a #GstAllocator or %NULL when + line="250">a #GstAllocator or %NULL when the allocator with @name was not registered. @@ -291,7 +291,7 @@ the allocator with @name was not registered. allow-none="1"> the name of the allocator + line="245">the name of the allocator @@ -299,8 +299,8 @@ the allocator with @name was not registered. Registers the memory @allocator with @name. - + line="219">Registers the memory @allocator with @name. + @@ -308,13 +308,13 @@ the allocator with @name was not registered. the name of the allocator + line="221">the name of the allocator #GstAllocator + line="222">#GstAllocator @@ -322,7 +322,7 @@ the allocator with @name was not registered. Use @allocator to allocate a new memory block with memory that is at least + line="293">Use @allocator to allocate a new memory block with memory that is at least @size big. The optional @params can specify the prefix and padding for the memory. If @@ -337,11 +337,11 @@ When @allocator is %NULL, the default allocator will be used. The alignment in @params is given as a bitmask so that @align + 1 equals the amount of bytes to align to. For example, to align to 8 bytes, use an alignment of 7. - + a new #GstMemory. + line="315">a new #GstMemory. @@ -351,13 +351,13 @@ use an alignment of 7. allow-none="1"> a #GstAllocator to use + line="295">a #GstAllocator to use size of the visible memory area + line="296">size of the visible memory area allow-none="1"> optional parameters + line="297">optional parameters @@ -374,8 +374,8 @@ use an alignment of 7. Free @memory that was previously allocated with gst_allocator_alloc(). - + line="343">Free @memory that was previously allocated with gst_allocator_alloc(). + @@ -383,13 +383,13 @@ use an alignment of 7. a #GstAllocator to use + line="345">a #GstAllocator to use the memory to free + line="346">the memory to free @@ -397,7 +397,7 @@ use an alignment of 7. Use @allocator to allocate a new memory block with memory that is at least + line="293">Use @allocator to allocate a new memory block with memory that is at least @size big. The optional @params can specify the prefix and padding for the memory. If @@ -412,11 +412,11 @@ When @allocator is %NULL, the default allocator will be used. The alignment in @params is given as a bitmask so that @align + 1 equals the amount of bytes to align to. For example, to align to 8 bytes, use an alignment of 7. - + a new #GstMemory. + line="315">a new #GstMemory. @@ -426,13 +426,13 @@ use an alignment of 7. allow-none="1"> a #GstAllocator to use + line="295">a #GstAllocator to use size of the visible memory area + line="296">size of the visible memory area allow-none="1"> optional parameters + line="297">optional parameters @@ -449,8 +449,8 @@ use an alignment of 7. Free @memory that was previously allocated with gst_allocator_alloc(). - + line="343">Free @memory that was previously allocated with gst_allocator_alloc(). + @@ -458,13 +458,13 @@ use an alignment of 7. a #GstAllocator to use + line="345">a #GstAllocator to use the memory to free + line="346">the memory to free @@ -472,8 +472,8 @@ use an alignment of 7. Set the default allocator. - + line="271">Set the default allocator. + @@ -481,7 +481,7 @@ use an alignment of 7. a #GstAllocator + line="273">a #GstAllocator @@ -495,44 +495,44 @@ use an alignment of 7. the implementation of the GstMemoryMapFunction + line="117">the implementation of the GstMemoryMapFunction the implementation of the GstMemoryUnmapFunction + line="118">the implementation of the GstMemoryUnmapFunction the implementation of the GstMemoryCopyFunction + line="119">the implementation of the GstMemoryCopyFunction the implementation of the GstMemoryShareFunction + line="120">the implementation of the GstMemoryShareFunction the implementation of the GstMemoryIsSpanFunction + line="121">the implementation of the GstMemoryIsSpanFunction the implementation of the GstMemoryMapFullFunction. + line="122">the implementation of the GstMemoryMapFullFunction. Will be used instead of @mem_map if present. (Since: 1.6) the implementation of the GstMemoryUnmapFullFunction. + line="124">the implementation of the GstMemoryUnmapFullFunction. Will be used instead of @mem_unmap if present. (Since: 1.6) @@ -551,21 +551,24 @@ use an alignment of 7. glib:is-gtype-struct-for="Allocator"> The #GstAllocator is used to create new memory. - + line="152">The #GstAllocator is used to create new memory. + Object parent class + line="154">Object parent class + implementation that acquires memory - + a new #GstMemory. + line="315">a new #GstMemory. @@ -575,13 +578,13 @@ use an alignment of 7. allow-none="1"> a #GstAllocator to use + line="295">a #GstAllocator to use size of the visible memory area + line="296">size of the visible memory area allow-none="1"> optional parameters + line="297">optional parameters + implementation that releases memory - + @@ -606,13 +612,13 @@ use an alignment of 7. a #GstAllocator to use + line="345">a #GstAllocator to use the memory to free + line="346">the memory to free @@ -638,7 +644,23 @@ use an alignment of 7. glib:name="GST_ALLOCATOR_FLAG_CUSTOM_ALLOC"> The allocator has a custom alloc function. + line="86">The allocator has a custom alloc function. + Only elements designed to work with this allocator should be using it, + other elements should ignore it from allocation propositions. + This implies %GST_ALLOCATOR_FLAG_NO_COPY. + + + When copying a #GstMemory allocated with this allocator, the copy will +instead be allocated using the default allocator. Use this when allocating a +new memory is an heavy opperation that should only be done with a +#GstBufferPool for example. glib:name="GST_ALLOCATOR_FLAG_LAST"> first flag that can be used for custom purposes + line="94">first flag that can be used for custom purposes Creates and adds a #GstCustomMeta for the desired @name. @name must have + line="2938">Creates and adds a #GstCustomMeta for the desired @name. @name must have been successfully registered with gst_meta_register_custom(). The #GstCustomMeta that was added to the buffer + line="2946">The #GstCustomMeta that was added to the buffer a #GstBuffer + line="2940">a #GstBuffer the registered name of the desired custom meta + line="2941">the registered name of the desired custom meta @@ -3101,26 +3123,26 @@ been successfully registered with gst_meta_register_custom(). version="1.6"> Attaches protection metadata to a #GstBuffer. + line="136">Attaches protection metadata to a #GstBuffer. a pointer to the added #GstProtectionMeta if successful + line="146">a pointer to the added #GstProtectionMeta if successful #GstBuffer holding an encrypted sample, to which protection + line="138">#GstBuffer holding an encrypted sample, to which protection metadata should be added. a #GstStructure holding cryptographic + line="140">a #GstStructure holding cryptographic information relating to the sample contained in @buffer. This function takes ownership of @info. @@ -3135,7 +3157,7 @@ been successfully registered with gst_meta_register_custom(). line="2721">Adds a #GstReferenceTimestampMeta to @buffer that holds a @timestamp and optionally @duration based on a specific timestamp @reference. See the documentation of #GstReferenceTimestampMeta for details. - + - - Creates a copy of the given buffer. This will only copy the buffer's -data to a newly allocated memory if needed (if the type of memory -requires it), otherwise the underlying data is just referenced. -Check gst_buffer_copy_deep() if you want to force the data -to be copied to newly allocated memory. - - - a new copy of @buf if the copy succeeded, %NULL otherwise. - - - - - a #GstBuffer. - - - - @@ -3690,25 +3688,25 @@ into one large #GstMemory. version="1.20"> Finds the first #GstCustomMeta on @buffer for the desired @name. + line="2969">Finds the first #GstCustomMeta on @buffer for the desired @name. the #GstCustomMeta + line="2976">the #GstCustomMeta a #GstBuffer + line="2971">a #GstBuffer the registered name of the custom meta to retrieve. + line="2972">the registered name of the custom meta to retrieve. @@ -3864,7 +3862,7 @@ and check the `meta->info.api` member for the API type. subset of @reference. Buffers can contain multiple #GstReferenceTimestampMeta metadata items. - + - - Increases the refcount of the given buffer by one. - -Note that the refcount affects the writability -of @buf and its metadata, see gst_buffer_is_writable(). -It is important to note that keeping additional references to -GstBuffer instances can potentially increase the number -of `memcpy` operations in a pipeline. - - - @buf - - - - - a #GstBuffer. - - - - - - Decreases the refcount of the buffer. If the refcount reaches 0, the buffer -with the associated metadata and memory will be freed. - - - - - - - a #GstBuffer. - - - - @@ -4919,49 +4873,6 @@ together to make room for the new block. - - Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The -modification is done atomically (so this is useful for ensuring thread safety -in some cases), and the reference counts are updated appropriately (the old -buffer is unreffed, the new is reffed). - -Either @nbuf or the #GstBuffer pointed to by @obuf may be %NULL. - - - %TRUE when @obuf was different from @nbuf. - - - - - pointer to a pointer to - a #GstBuffer to be replaced. - - - - pointer to a #GstBuffer that will - replace the buffer pointed to by @obuf. - - - - - - Creates a shallow copy of the given buffer list. This will make a newly -allocated copy of the source list with copies of buffer pointers. The -refcount of buffers pointed to will be increased by one. - - - a new copy of @list. - - - - - a #GstBufferList - - - - @@ -5529,31 +5416,6 @@ A -1 value for @idx will append the buffer at the end. - - Increases the refcount of the given buffer list by one. - -Note that the refcount affects the writability of @list and its data, see -gst_buffer_list_make_writable(). It is important to note that keeping -additional references to GstBufferList instances can potentially increase -the number of memcpy operations in a pipeline. - - - @list - - - - - a #GstBufferList - - - - - - Decreases the refcount of the buffer list. If the refcount reaches 0, the -buffer list will be freed. - - - - - - - a #GstBufferList - - - - - - Modifies a pointer to a #GstBufferList to point to a different -#GstBufferList. The modification is done atomically (so this is useful for -ensuring thread safety in some cases), and the reference counts are updated -appropriately (the old buffer list is unreffed, the new is reffed). - -Either @new_list or the #GstBufferList pointed to by @old_list may be %NULL. - - - %TRUE if @new_list was different from @old_list - - - - - pointer to a pointer to a - #GstBufferList to be replaced. - - - - pointer to a #GstBufferList that - will replace the buffer list pointed to by @old_list. - - - - - - Modifies a pointer to a #GstBufferList to point to a different -#GstBufferList. This function is similar to gst_buffer_list_replace() except -that it takes ownership of @new_list. - - - %TRUE if @new_list was different from @old_list - - - - - pointer to a pointer to a #GstBufferList - to be replaced. - - - - pointer to a #GstBufferList - that will replace the bufferlist pointed to by @old_list. - - - - Acquires a buffer from @pool. @buffer should point to a memory location that + line="1264">Acquires a buffer from @pool. @buffer should point to a memory location that can hold a pointer to the new buffer. When the pool is empty, this function will by default block until a buffer is released into the pool again or when the pool is set to flushing or deactivated. @@ -6164,7 +5927,7 @@ the pool is set to flushing or deactivated. a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is + line="1277">a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is inactive. @@ -6172,7 +5935,7 @@ inactive. a #GstBufferPool + line="1266">a #GstBufferPool nullable="1"> a location for a #GstBuffer + line="1267">a location for a #GstBuffer allow-none="1"> parameters. + line="1268">parameters. @@ -6328,7 +6091,7 @@ gst_buffer_pool_config_add_option(). Releases @buffer to @pool. @buffer should have previously been allocated from + line="1366">Releases @buffer to @pool. @buffer should have previously been allocated from @pool with gst_buffer_pool_acquire_buffer(). This function is usually called automatically when the last ref on @buffer @@ -6341,13 +6104,13 @@ disappears. a #GstBufferPool + line="1368">a #GstBufferPool a #GstBuffer + line="1369">a #GstBuffer @@ -6468,7 +6231,7 @@ returned to the pool. c:identifier="gst_buffer_pool_acquire_buffer"> Acquires a buffer from @pool. @buffer should point to a memory location that + line="1264">Acquires a buffer from @pool. @buffer should point to a memory location that can hold a pointer to the new buffer. When the pool is empty, this function will by default block until a buffer is released into the pool again or when the pool is set to flushing or deactivated. @@ -6478,7 +6241,7 @@ the pool is set to flushing or deactivated. a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is + line="1277">a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is inactive. @@ -6486,7 +6249,7 @@ inactive. a #GstBufferPool + line="1266">a #GstBufferPool nullable="1"> a location for a #GstBuffer + line="1267">a location for a #GstBuffer allow-none="1"> parameters. + line="1268">parameters. @@ -6608,7 +6371,7 @@ gst_buffer_pool_set_active() call. c:identifier="gst_buffer_pool_release_buffer"> Releases @buffer to @pool. @buffer should have previously been allocated from + line="1366">Releases @buffer to @pool. @buffer should have previously been allocated from @pool with gst_buffer_pool_acquire_buffer(). This function is usually called automatically when the last ref on @buffer @@ -6621,13 +6384,13 @@ disappears. a #GstBufferPool + line="1368">a #GstBufferPool a #GstBuffer + line="1369">a #GstBuffer @@ -6713,7 +6476,7 @@ This function takes ownership of @config. version="1.4"> Enables or disables the flushing state of a @pool without freeing or + line="1405">Enables or disables the flushing state of a @pool without freeing or allocating buffers. @@ -6723,13 +6486,13 @@ allocating buffers. a #GstBufferPool + line="1407">a #GstBufferPool whether to start or stop flushing + line="1408">whether to start or stop flushing @@ -6956,7 +6719,7 @@ return. a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is + line="1277">a #GstFlowReturn such as %GST_FLOW_FLUSHING when the pool is inactive. @@ -6964,7 +6727,7 @@ inactive. a #GstBufferPool + line="1266">a #GstBufferPool nullable="1"> a location for a #GstBuffer + line="1267">a location for a #GstBuffer allow-none="1"> parameters. + line="1268">parameters. @@ -7062,13 +6825,13 @@ successful. a #GstBufferPool + line="1368">a #GstBufferPool a #GstBuffer + line="1369">a #GstBuffer @@ -7236,12 +6999,12 @@ from READY to NULL state. Creates a new #GstBus instance. + line="298">Creates a new #GstBus instance. a new #GstBus instance + line="303">a new #GstBus instance @@ -7294,7 +7057,7 @@ from READY to NULL state. Adds a bus signal watch to the default main context with the default priority + line="1430">Adds a bus signal watch to the default main context with the default priority ( %G_PRIORITY_DEFAULT ). It is also possible to use a non-default main context set up using g_main_context_push_thread_default() (before one had to create a bus watch source and attach it to the desired main @@ -7314,7 +7077,7 @@ function is called. a #GstBus on which you want to receive the "message" signal + line="1432">a #GstBus on which you want to receive the "message" signal @@ -7323,7 +7086,7 @@ function is called. c:identifier="gst_bus_add_signal_watch_full"> Adds a bus signal watch to the default main context with the given @priority + line="1367">Adds a bus signal watch to the default main context with the given @priority (e.g. %G_PRIORITY_DEFAULT). It is also possible to use a non-default main context set up using g_main_context_push_thread_default() (before one had to create a bus watch source and attach it to the desired @@ -7346,13 +7109,13 @@ watch before you can set another type of watch. a #GstBus on which you want to receive the "message" signal + line="1369">a #GstBus on which you want to receive the "message" signal The priority of the watch. + line="1370">The priority of the watch. @@ -7363,7 +7126,7 @@ watch before you can set another type of watch. introspectable="0"> Adds a bus watch to the default main context with the default priority + line="1019">Adds a bus watch to the default main context with the default priority ( %G_PRIORITY_DEFAULT ). It is also possible to use a non-default main context set up using g_main_context_push_thread_default() (before one had to create a bus watch source and attach it to the desired main @@ -7385,20 +7148,20 @@ The bus watch will take its own reference to the @bus, so it is safe to unref The event source id or 0 if @bus already got an event source. + line="1044">The event source id or 0 if @bus already got an event source. a #GstBus to create the watch for + line="1021">a #GstBus to create the watch for A function to call when a message is received. + line="1022">A function to call when a message is received. user data passed to @func. + line="1023">user data passed to @func. @@ -7417,7 +7180,7 @@ The bus watch will take its own reference to the @bus, so it is safe to unref shadows="add_watch"> Adds a bus watch to the default main context with the given @priority (e.g. + line="972">Adds a bus watch to the default main context with the given @priority (e.g. %G_PRIORITY_DEFAULT). It is also possible to use a non-default main context set up using g_main_context_push_thread_default() (before one had to create a bus watch source and attach it to the desired main @@ -7442,20 +7205,20 @@ The bus watch will take its own reference to the @bus, so it is safe to unref The event source id or 0 if @bus already got an event source. + line="1002">The event source id or 0 if @bus already got an event source. a #GstBus to create the watch for. + line="974">a #GstBus to create the watch for. The priority of the watch. + line="975">The priority of the watch. A function to call when a message is received. + line="976">A function to call when a message is received. user data passed to @func. + line="977">user data passed to @func. the function to call when the source is removed. + line="978">the function to call when the source is removed. @@ -7489,26 +7252,26 @@ The bus watch will take its own reference to the @bus, so it is safe to unref c:identifier="gst_bus_async_signal_func"> A helper #GstBusFunc that can be used to convert all asynchronous messages + line="1258">A helper #GstBusFunc that can be used to convert all asynchronous messages into signals. %TRUE + line="1267">%TRUE a #GstBus + line="1260">a #GstBus the #GstMessage received + line="1261">the #GstMessage received allow-none="1"> user data + line="1262">user data @@ -7525,7 +7288,7 @@ into signals. Create watch for this bus. The #GSource will be dispatched whenever + line="906">Create watch for this bus. The #GSource will be dispatched whenever a message is on the bus. After the GSource is dispatched, the message is popped off the bus and unreffed. @@ -7535,14 +7298,14 @@ any signal watch added with #gst_bus_add_signal_watch. a #GSource that can be added to a #GMainLoop. + line="917">a #GSource that can be added to a #GMainLoop. a #GstBus to create the watch for + line="908">a #GstBus to create the watch for @@ -7551,7 +7314,7 @@ any signal watch added with #gst_bus_add_signal_watch. c:identifier="gst_bus_disable_sync_message_emission"> Instructs GStreamer to stop emitting the "sync-message" signal for this bus. + line="1341">Instructs GStreamer to stop emitting the "sync-message" signal for this bus. See gst_bus_enable_sync_message_emission() for more information. In the event that multiple pieces of code have called @@ -7568,7 +7331,7 @@ disable. a #GstBus on which you previously called + line="1343">a #GstBus on which you previously called gst_bus_enable_sync_message_emission() @@ -7578,7 +7341,7 @@ gst_bus_enable_sync_message_emission() c:identifier="gst_bus_enable_sync_message_emission"> Instructs GStreamer to emit the "sync-message" signal after running the bus's + line="1311">Instructs GStreamer to emit the "sync-message" signal after running the bus's sync handler. This function is here so that code can ensure that they can synchronously receive messages without having to affect what the bin's sync handler is. @@ -7601,7 +7364,7 @@ signal is marshalled to the main thread via the #GMainLoop. a #GstBus on which you want to receive the "sync-message" signal + line="1313">a #GstBus on which you want to receive the "sync-message" signal @@ -7611,7 +7374,7 @@ signal is marshalled to the main thread via the #GMainLoop. version="1.14"> Gets the file descriptor from the bus which can be used to get notified about + line="764">Gets the file descriptor from the bus which can be used to get notified about messages being available with functions like g_poll(), and allows integration into other event loops based on file descriptors. Whenever a message is available, the POLLIN / %G_IO_IN event is set. @@ -7627,7 +7390,7 @@ GstBus API, e.g. gst_bus_pop(). A #GstBus + line="766">A #GstBus transfer-ownership="none"> A GPollFD to fill + line="767">A GPollFD to fill @@ -7644,13 +7407,13 @@ GstBus API, e.g. gst_bus_pop(). Checks if there are pending messages on the bus that + line="455">Checks if there are pending messages on the bus that should be handled. %TRUE if there are messages on the bus to be handled, %FALSE + line="462">%TRUE if there are messages on the bus to be handled, %FALSE otherwise. @@ -7658,7 +7421,7 @@ otherwise. a #GstBus to check + line="457">a #GstBus to check @@ -7666,13 +7429,13 @@ otherwise. Peeks the message on the top of the bus' queue. The message will remain + line="695">Peeks the message on the top of the bus' queue. The message will remain on the bus' message queue. the #GstMessage that is on the + line="702">the #GstMessage that is on the bus, or %NULL if the bus is empty. @@ -7680,7 +7443,7 @@ on the bus' message queue. a #GstBus + line="697">a #GstBus @@ -7688,7 +7451,7 @@ on the bus' message queue. Polls the bus for messages. Will block while waiting for messages to come. + line="1165">Polls the bus for messages. Will block while waiting for messages to come. You can specify a maximum time to poll with the @timeout parameter. If @timeout is negative, this function will block indefinitely. @@ -7725,7 +7488,7 @@ from there. the message that was received, + line="1207">the message that was received, or %NULL if the poll timed out. @@ -7733,20 +7496,20 @@ from there. a #GstBus + line="1167">a #GstBus a mask of #GstMessageType, representing the set of message types to + line="1168">a mask of #GstMessageType, representing the set of message types to poll for (note special handling of extended message types below) the poll timeout, as a #GstClockTime, or #GST_CLOCK_TIME_NONE to poll + line="1170">the poll timeout, as a #GstClockTime, or #GST_CLOCK_TIME_NONE to poll indefinitely. @@ -7755,12 +7518,12 @@ indefinitely. Gets a message from the bus. + line="678">Gets a message from the bus. the #GstMessage that is on the + line="684">the #GstMessage that is on the bus, or %NULL if the bus is empty. @@ -7768,7 +7531,7 @@ indefinitely. a #GstBus to pop + line="680">a #GstBus to pop @@ -7776,7 +7539,7 @@ indefinitely. Gets a message matching @type from the bus. Will discard all messages on + line="654">Gets a message matching @type from the bus. Will discard all messages on the bus that do not match @type and that have been posted before the first message that does match @type. If there is no message matching @type on the bus, all messages will be discarded. It is not possible to use message @@ -7785,7 +7548,7 @@ enums beyond #GST_MESSAGE_EXTENDED in the @events mask. the next #GstMessage matching + line="665">the next #GstMessage matching @type that is on the bus, or %NULL if the bus is empty or there is no message matching @type. @@ -7794,13 +7557,13 @@ enums beyond #GST_MESSAGE_EXTENDED in the @events mask. a #GstBus to pop + line="656">a #GstBus to pop message types to take into account + line="657">message types to take into account @@ -7808,26 +7571,26 @@ enums beyond #GST_MESSAGE_EXTENDED in the @events mask. Posts a message on the given bus. Ownership of the message + line="319">Posts a message on the given bus. Ownership of the message is taken by the bus. %TRUE if the message could be posted, %FALSE if the bus is flushing. + line="327">%TRUE if the message could be posted, %FALSE if the bus is flushing. a #GstBus to post on + line="321">a #GstBus to post on the #GstMessage to post + line="322">the #GstMessage to post @@ -7836,7 +7599,7 @@ is taken by the bus. c:identifier="gst_bus_remove_signal_watch"> Removes a signal watch previously added with gst_bus_add_signal_watch(). + line="1453">Removes a signal watch previously added with gst_bus_add_signal_watch(). @@ -7845,7 +7608,7 @@ is taken by the bus. a #GstBus you previously added a signal watch to + line="1455">a #GstBus you previously added a signal watch to @@ -7855,19 +7618,19 @@ is taken by the bus. version="1.6"> Removes an installed bus watch from @bus. + line="1053">Removes an installed bus watch from @bus. %TRUE on success or %FALSE if @bus has no event source. + line="1059">%TRUE on success or %FALSE if @bus has no event source. a #GstBus to remove the watch from. + line="1055">a #GstBus to remove the watch from. @@ -7875,7 +7638,7 @@ is taken by the bus. If @flushing, flushes out and unrefs any messages queued in the bus. Releases + line="478">If @flushing, flushes out and unrefs any messages queued in the bus. Releases references to the message origin objects. Will flush future messages until gst_bus_set_flushing() sets @flushing to %FALSE. @@ -7886,13 +7649,13 @@ gst_bus_set_flushing() sets @flushing to %FALSE. a #GstBus + line="480">a #GstBus whether or not to flush the bus + line="481">whether or not to flush the bus @@ -7900,7 +7663,7 @@ gst_bus_set_flushing() sets @flushing to %FALSE. Sets the synchronous handler on the bus. The function will be called + line="723">Sets the synchronous handler on the bus. The function will be called every time a new message is posted on the bus. Note that the function will be called in the same thread context as the posting object. This function is usually only called by the creator of the bus. Applications @@ -7917,7 +7680,7 @@ clearing an existing handler with %NULL was not thread-safe. a #GstBus to install the handler on + line="725">a #GstBus to install the handler on destroy="2"> The handler function to install + line="726">The handler function to install allow-none="1"> User data that will be sent to the handler function. + line="727">User data that will be sent to the handler function. called when @user_data becomes unused + line="728">called when @user_data becomes unused @@ -7953,26 +7716,26 @@ clearing an existing handler with %NULL was not thread-safe. c:identifier="gst_bus_sync_signal_handler"> A helper #GstBusSyncHandler that can be used to convert all synchronous + line="1285">A helper #GstBusSyncHandler that can be used to convert all synchronous messages into signals. %GST_BUS_PASS + line="1294">%GST_BUS_PASS a #GstBus + line="1287">a #GstBus the #GstMessage received + line="1288">the #GstMessage received allow-none="1"> user data + line="1289">user data @@ -7989,7 +7752,7 @@ messages into signals. Gets a message from the bus, waiting up to the specified timeout. + line="631">Gets a message from the bus, waiting up to the specified timeout. If @timeout is 0, this function behaves like gst_bus_pop(). If @timeout is #GST_CLOCK_TIME_NONE, this function will block forever until a message was @@ -7998,7 +7761,7 @@ posted on the bus. the #GstMessage that is on the + line="642">the #GstMessage that is on the bus after the specified timeout or %NULL if the bus is empty after the timeout expired. @@ -8007,13 +7770,13 @@ posted on the bus. a #GstBus to pop + line="633">a #GstBus to pop a timeout + line="634">a timeout @@ -8022,7 +7785,7 @@ posted on the bus. c:identifier="gst_bus_timed_pop_filtered"> Gets a message from the bus whose type matches the message type mask @types, + line="514">Gets a message from the bus whose type matches the message type mask @types, waiting up to the specified timeout (and discarding any messages that do not match the mask provided). @@ -8033,7 +7796,7 @@ matching message was posted on the bus. a #GstMessage matching the + line="528">a #GstMessage matching the filter in @types, or %NULL if no matching message was found on the bus until the timeout expired. @@ -8042,19 +7805,19 @@ matching message was posted on the bus. a #GstBus to pop from + line="516">a #GstBus to pop from a timeout in nanoseconds, or %GST_CLOCK_TIME_NONE to wait forever + line="517">a timeout in nanoseconds, or %GST_CLOCK_TIME_NONE to wait forever message types to take into account, %GST_MESSAGE_ANY for any type + line="518">message types to take into account, %GST_MESSAGE_ANY for any type @@ -8067,7 +7830,7 @@ matching message was posted on the bus. default-value="TRUE"> Enables async message delivery support for bus watches, + line="200">Enables async message delivery support for bus watches, gst_bus_pop() and similar API. Without this only the synchronous message handlers are called. @@ -8092,7 +7855,7 @@ in #GstBin. A message has been posted on the bus. This signal is emitted from a + line="233">A message has been posted on the bus. This signal is emitted from a #GSource added to the mainloop. this signal will only be emitted when there is a #GMainLoop running. @@ -8102,7 +7865,7 @@ there is a #GMainLoop running. the message that has been posted asynchronously + line="236">the message that has been posted asynchronously @@ -8110,7 +7873,7 @@ there is a #GMainLoop running. A message has been posted on the bus. This signal is emitted from the + line="216">A message has been posted on the bus. This signal is emitted from the thread that posted the message so one has to be careful with locking. This signal will not be emitted by default, you have to call @@ -8122,7 +7885,7 @@ gst_bus_enable_sync_message_emission() before. the message that has been posted synchronously + line="219">the message that has been posted synchronously @@ -8340,6 +8103,56 @@ message should not be unreffed by the sync handler. line="60">pass message to async queue, continue if message is handled + + Interface for an array of bytes. It is expected to be subclassed to implement +@resize virtual method using language native array implementation, such as +GLib's #GByteArray, C++'s `std::vector<uint8_t>` or Rust's `Vec<u8>`. + +@resize implementation could allocate more than requested to avoid repeated +reallocations. It can return %FALSE, or be set to %NULL, in the case the +array cannot grow. + + + A pointer to an array of bytes. + + + + Number of bytes in @data. + + + + Reallocate @data. + + + + + + + + + + + + + + + + + + + + + @@ -9205,13 +9018,13 @@ The difference is calculated as @e - @s. introspectable="0"> Casts to a clock entry - + line="344">Casts to a clock entry + the entry to cast + line="346">the entry to cast @@ -9221,14 +9034,14 @@ The difference is calculated as @e - @s. deprecated="1"> Gets the owner clock of the entry + line="353">Gets the owner clock of the entry Use gst_clock_id_get_clock() instead. - + the entry to query + line="355">the entry to query @@ -9237,13 +9050,13 @@ The difference is calculated as @e - @s. introspectable="0"> Gets the interval of this periodic entry - + line="377">Gets the interval of this periodic entry + the entry to query + line="379">the entry to query @@ -9252,13 +9065,13 @@ The difference is calculated as @e - @s. introspectable="0"> The status of the entry - + line="384">The status of the entry + the entry to query + line="386">the entry to query @@ -9267,13 +9080,13 @@ The difference is calculated as @e - @s. introspectable="0"> Gets the requested time of this entry - + line="370">Gets the requested time of this entry + the entry to query + line="372">the entry to query @@ -9282,13 +9095,13 @@ The difference is calculated as @e - @s. introspectable="0"> Gets the type of the clock entry - + line="363">Gets the type of the clock entry + the entry to query + line="365">the entry to query @@ -9297,13 +9110,13 @@ The difference is calculated as @e - @s. introspectable="0"> Gets the #GstClockFlags clock flags. - + line="459">Gets the #GstClockFlags clock flags. + the clock to query + line="461">the clock to query @@ -9745,7 +9558,7 @@ be empty Creates a new #GstCaps as a copy of the old @caps. The new caps will have a + line="2699">Creates a new #GstCaps as a copy of the old @caps. The new caps will have a refcount of 1, owned by the caller. The structures are copied as well. Note that this function is the semantic equivalent of a gst_caps_ref() @@ -9755,14 +9568,14 @@ reference to the data, you should use gst_caps_ref(). the new #GstCaps + line="2710">the new #GstCaps a #GstCaps. + line="2701">a #GstCaps. @@ -9801,10 +9614,9 @@ contained in @caps. filename="gst/gstcaps.c" line="2641">Calls the provided function once for each structure and caps feature in the #GstCaps. In contrast to gst_caps_foreach(), the function may modify the -structure and features. In contrast to gst_caps_filter_and_map_in_place(), -the structure and features are removed from the caps if %FALSE is returned -from the function. -The caps must be mutable. +structure and features. In contrast to gst_caps_map_in_place(), the structure +and features are removed from the caps if %FALSE is returned from the +function. The caps must be mutable. @@ -10488,33 +10300,6 @@ reference to it with gst_caps_ref(). - - Adds a reference to a #GstCaps object. - -From this point on, until the caller calls gst_caps_unref() or -gst_caps_make_writable(), it is guaranteed that the caps object will not -change. This means its structures won't change, etc. To use a #GstCaps -object, you must always have a refcount on it -- either the one made -implicitly by e.g. gst_caps_new_simple(), or via taking one explicitly with -this function. - - - the same #GstCaps object. - - - - - the #GstCaps to reference - - - - - - Unrefs a #GstCaps and frees all its structures and the -structures' values when the refcount reaches 0. - - - - - - - a #GstCaps. - - - - - - Modifies a pointer to a #GstCaps to point to a different #GstCaps. The -modification is done atomically (so this is useful for ensuring thread safety -in some cases), and the reference counts are updated appropriately (the old -caps is unreffed, the new is reffed). - -Either @new_caps or the #GstCaps pointed to by @old_caps may be %NULL. - - - %TRUE if @new_caps was different from @old_caps - - - - - pointer to a pointer - to a #GstCaps to be replaced. - - - - pointer to a #GstCaps that will - replace the caps pointed to by @old_caps. - - - - - - Modifies a pointer to a #GstCaps to point to a different #GstCaps. This -function is similar to gst_caps_replace() except that it takes ownership -of @new_caps. - - - %TRUE if @new_caps was different from @old_caps - - - - - pointer to a pointer to a #GstCaps to be - replaced. - - - - pointer to a #GstCaps that will - replace the caps pointed to by @old_caps. - - - - + Fetch a child object by name @@ -12434,6 +12125,9 @@ usage. For plain #GObject @target is the same as @object. + Fetch a child object by index @@ -12460,6 +12154,9 @@ usage. For plain #GObject @target is the same as @object. + Get the number of children in @parent @@ -12479,6 +12176,9 @@ usage. For plain #GObject @target is the same as @object. + Called when @child is added to @parent @@ -12507,6 +12207,9 @@ usage. For plain #GObject @target is the same as @object. + Called when @child is removed from @parent @@ -12622,14 +12325,14 @@ The #GstClock:timeout property defines the interval to sample the master clock and run the calibration functions. #GstClock:window-size defines the number of samples to use when calibrating and #GstClock:window-threshold defines the minimum number of samples before the calibration is performed. - + Compares the two #GstClockID instances. This function can be used as a GCompareFunc when sorting ids. - + This function returns the underlying clock. - + Gets the time of the clock ID - + Increases the refcount of given @id. - + filename="gst/gstclock.c" line="388">Unrefs given @id. When the refcount reaches 0 the #GstClockID will be freed. - + @@ -12745,7 +12448,7 @@ as a GCompareFunc when sorting ids. be an outstanding async notification or a pending sync notification. After this call, @id cannot be used anymore to receive sync or async notifications, you need to create a new #GstClockID. - + @@ -12767,7 +12470,7 @@ async notifications, you need to create a new #GstClockID. @clock can be NULL, in which case the return value indicates whether the underlying clock has been freed. If this is the case, the @id is no longer usable and should be freed. - + - + - + Change the resolution of the clock. Not all values might + line="495">Change the resolution of the clock. Not all values might be acceptable. - + the new resolution + line="504">the new resolution the #GstClock + line="497">the #GstClock the previous resolution + line="498">the previous resolution the new resolution + line="499">the new resolution @@ -12928,7 +12631,7 @@ be acceptable. filename="gst/gstclock.c" line="1056">Gets the current internal time of the given clock. The time is returned unadjusted for the offset and the rate. - + filename="gst/gstclock.c" line="859">Gets the accuracy of the clock. The accuracy of the clock is the granularity of the values returned by gst_clock_get_time(). - + Unblock a blocking or async wait operation. - + line="562">Unblock a blocking or async wait operation. + @@ -12978,13 +12681,13 @@ of the values returned by gst_clock_get_time(). the #GstClock + line="564">the #GstClock the entry to unschedule + line="565">the entry to unschedule @@ -12992,13 +12695,13 @@ of the values returned by gst_clock_get_time(). Perform a blocking wait on the given #GstClockEntry and return + line="534">Perform a blocking wait on the given #GstClockEntry and return the jitter. - + the result of the blocking wait. #GST_CLOCK_EARLY will be returned + line="543">the result of the blocking wait. #GST_CLOCK_EARLY will be returned if the current clock time is past the time of @id, #GST_CLOCK_OK if @id was scheduled in time. #GST_CLOCK_UNSCHEDULED if @id was unscheduled with gst_clock_id_unschedule(). @@ -13008,13 +12711,13 @@ unscheduled with gst_clock_id_unschedule(). the #GstClock + line="536">the #GstClock the entry to wait on + line="537">the entry to wait on allow-none="1"> a pointer that will contain the jitter + line="538">a pointer that will contain the jitter @@ -13033,25 +12736,25 @@ unscheduled with gst_clock_id_unschedule(). Perform an asynchronous wait on the given #GstClockEntry. - + line="551">Perform an asynchronous wait on the given #GstClockEntry. + the result of the non blocking wait. + line="558">the result of the non blocking wait. the #GstClock + line="553">the #GstClock the entry to wait on + line="554">the entry to wait on @@ -13069,7 +12772,7 @@ correlation coefficient of the interpolation. A value of 1.0 means a perfect regression was performed. This value can be used to control the sampling frequency of the master and slave clocks. - + - + - + - + - + @@ -13364,7 +13067,7 @@ caller is not interested in the values. filename="gst/gstclock.c" line="1056">Gets the current internal time of the given clock. The time is returned unadjusted for the offset and the rate. - + filename="gst/gstclock.c" line="1348">Gets the master clock that @clock is slaved to or %NULL when the clock is not slaved to any master clock. - + filename="gst/gstclock.c" line="859">Gets the accuracy of the clock. The accuracy of the clock is the granularity of the values returned by gst_clock_get_time(). - + line="1100">Gets the current time of the given clock. The time is always monotonically increasing and adjusted according to the current offset and rate. - + Gets the amount of time that master and slave clocks are sampled. - + filename="gst/gstclock.c" line="1720">Checks if the clock is currently synced, by looking at whether %GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC is set. - + line="430">Gets an ID from @clock to trigger a periodic notification. The periodic notifications will start at time @start_time and will then be fired with the given @interval. - + filename="gst/gstclock.c" line="409">Gets a #GstClockID from @clock to trigger a single shot notification at the requested time. - + filename="gst/gstclock.c" line="322">Reinitializes the provided periodic @id to the provided start time and interval. Does not modify the reference count. - + - + @@ -13672,7 +13375,7 @@ calibration values with gst_clock_get_calibration(). @master can be %NULL in which case @clock will not be slaved anymore. It will however keep reporting its time adjusted with the last configured rate and time offsets. - + - + - + @@ -13765,7 +13468,7 @@ is set on the clock, and is intended to be called by subclasses only. filename="gst/gstclock.c" line="1561">Sets the amount of time, in nanoseconds, to sample master and slave clocks - + @@ -13790,7 +13493,7 @@ clocks filename="gst/gstclock.c" line="300">Reinitializes the provided single shot @id to the provided time. Does not modify the reference count. - + - + - + - + the parent structure + line="469">the parent structure @@ -14006,31 +13709,31 @@ the application's main thread. The function prototype of the callback. - + line="294">The function prototype of the callback. + %TRUE or %FALSE (currently unused) + line="303">%TRUE or %FALSE (currently unused) The clock that triggered the callback + line="296">The clock that triggered the callback The time it was triggered + line="297">The time it was triggered The #GstClockID that expired + line="298">The #GstClockID that expired closure="3"> user data passed in the gst_clock_id_wait_async() function + line="299">user data passed in the gst_clock_id_wait_async() function @@ -14050,41 +13753,41 @@ the application's main thread. glib:is-gtype-struct-for="Clock"> GStreamer clock class. Override the vmethods to implement the clock + line="482">GStreamer clock class. Override the vmethods to implement the clock functionality. - + the parent class structure + line="484">the parent class structure - + the new resolution + line="504">the new resolution the #GstClock + line="497">the #GstClock the previous resolution + line="498">the previous resolution the new resolution + line="499">the new resolution @@ -14092,7 +13795,7 @@ functionality. - + - + - + the result of the blocking wait. #GST_CLOCK_EARLY will be returned + line="543">the result of the blocking wait. #GST_CLOCK_EARLY will be returned if the current clock time is past the time of @id, #GST_CLOCK_OK if @id was scheduled in time. #GST_CLOCK_UNSCHEDULED if @id was unscheduled with gst_clock_id_unschedule(). @@ -14145,13 +13848,13 @@ unscheduled with gst_clock_id_unschedule(). the #GstClock + line="536">the #GstClock the entry to wait on + line="537">the entry to wait on allow-none="1"> a pointer that will contain the jitter + line="538">a pointer that will contain the jitter @@ -14170,24 +13873,24 @@ unscheduled with gst_clock_id_unschedule(). - + the result of the non blocking wait. + line="558">the result of the non blocking wait. the #GstClock + line="553">the #GstClock the entry to wait on + line="554">the entry to wait on @@ -14195,7 +13898,7 @@ unscheduled with gst_clock_id_unschedule(). - + @@ -14203,13 +13906,13 @@ unscheduled with gst_clock_id_unschedule(). the #GstClock + line="564">the #GstClock the entry to unschedule + line="565">the entry to unschedule @@ -14224,15 +13927,15 @@ unscheduled with gst_clock_id_unschedule(). All pending timeouts or periodic notifies are converted into + line="392">All pending timeouts or periodic notifies are converted into an entry. Note that GstClockEntry should be treated as an opaque structure. It must not be extended or allocated using a custom allocator. - + reference counter (read-only) + line="394">reference counter (read-only) @@ -14277,7 +13980,7 @@ not be extended or allocated using a custom allocator. c:type="GstClockEntryType"> The type of the clock entry + line="332">The type of the clock entry glib:name="GST_CLOCK_ENTRY_SINGLE"> a single shot timeout + line="334">a single shot timeout glib:name="GST_CLOCK_ENTRY_PERIODIC"> a periodic timeout request + line="335">a periodic timeout request c:type="GstClockFlags"> The capabilities of this clock + line="427">The capabilities of this clock glib:name="GST_CLOCK_FLAG_CAN_DO_SINGLE_SYNC"> clock can do a single sync timeout request + line="429">clock can do a single sync timeout request glib:name="GST_CLOCK_FLAG_CAN_DO_SINGLE_ASYNC"> clock can do a single async timeout request + line="430">clock can do a single async timeout request glib:name="GST_CLOCK_FLAG_CAN_DO_PERIODIC_SYNC"> clock can do sync periodic timeout requests + line="431">clock can do sync periodic timeout requests glib:name="GST_CLOCK_FLAG_CAN_DO_PERIODIC_ASYNC"> clock can do async periodic timeout callbacks + line="432">clock can do async periodic timeout callbacks glib:name="GST_CLOCK_FLAG_CAN_SET_RESOLUTION"> clock's resolution can be changed + line="433">clock's resolution can be changed glib:name="GST_CLOCK_FLAG_CAN_SET_MASTER"> clock can be slaved to a master clock + line="434">clock can be slaved to a master clock glib:name="GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC"> clock needs to be synced before it can be used + line="447">clock needs to be synced before it can be used glib:name="GST_CLOCK_FLAG_LAST"> subclasses can add additional flags starting from this flag + line="435">subclasses can add additional flags starting from this flag - + c:type="GstClockReturn"> The return value of a clock operation. + line="307">The return value of a clock operation. glib:name="GST_CLOCK_OK"> The operation succeeded. + line="309">The operation succeeded. glib:name="GST_CLOCK_EARLY"> The operation was scheduled too late. + line="310">The operation was scheduled too late. glib:name="GST_CLOCK_UNSCHEDULED"> The clockID was unscheduled + line="311">The clockID was unscheduled glib:name="GST_CLOCK_BUSY"> The ClockID is busy + line="312">The ClockID is busy glib:name="GST_CLOCK_BADTIME"> A bad time was provided to a function. + line="313">A bad time was provided to a function. glib:name="GST_CLOCK_ERROR"> An error occurred + line="314">An error occurred glib:name="GST_CLOCK_UNSUPPORTED"> Operation is not supported + line="315">Operation is not supported glib:name="GST_CLOCK_DONE"> The ClockID is done waiting + line="316">The ClockID is done waiting Creates a new context. - + - - Creates a copy of the context. Returns a copy of the context. - - - a new copy of @context. - -MT safe - - - - - the context to copy - - - - Gets the type of @context. - + Accesses the structure of the context. - + Checks if @context has @context_type. - + Checks if @context is persistent. - + - - Convenience macro to increase the reference count of the context. - - - @context (for convenience when doing assignments) - - - - - the context to ref - - - - - - Convenience macro to decrease the reference count of the context, possibly -freeing it. - - - - - - - the context to unref - - - - Gets a writable version of the structure. - + - - Modifies a pointer to a #GstContext to point to a different #GstContext. The -modification is done atomically (so this is useful for ensuring thread safety -in some cases), and the reference counts are updated appropriately (the old -context is unreffed, the new one is reffed). - -Either @new_context or the #GstContext pointed to by @old_context may be %NULL. - - - %TRUE if @new_context was different from @old_context - - - - - pointer to a pointer to a #GstContext - to be replaced. - - - - pointer to a #GstContext that will - replace the context pointed to by @old_context. - - - - Simple typing wrapper around #GstMeta - + line="130">Extra custom metadata. The @structure field is the same as returned by +gst_custom_meta_get_structure(). + +Since 1.24 it can be serialized using gst_meta_serialize() and +gst_meta_deserialize(), but only if the #GstStructure does not contain any +fields that cannot be serialized, see %GST_SERIALIZE_FLAG_STRICT. + + parent #GstMeta + + #GstStructure containing custom metadata. + + Retrieve the #GstStructure backing a custom meta, the structure's mutability + line="234">Retrieve the #GstStructure backing a custom meta, the structure's mutability is conditioned to the writability of the #GstBuffer @meta is attached to. - + the #GstStructure backing @meta + line="240">the #GstStructure backing @meta @@ -15887,12 +15503,12 @@ is conditioned to the writability of the #GstBuffer @meta is attached to. version="1.20"> Checks whether the name of the custom meta is @name - + line="253">Checks whether the name of the custom meta is @name + Whether @name is the name of the custom meta + line="258">Whether @name is the name of the custom meta @@ -15910,43 +15526,43 @@ is conditioned to the writability of the #GstBuffer @meta is attached to. version="1.20"> Function called for each @meta in @buffer as a result of performing a + line="222">Function called for each @meta in @buffer as a result of performing a transformation that yields @transbuf. Additional @type specific transform data is passed to the function as @data. Implementations should check the @type of the transform and parse additional type specific fields in @data that should be used to update the metadata on @transbuf. - + %TRUE if the transform could be performed + line="239">%TRUE if the transform could be performed a #GstBuffer + line="224">a #GstBuffer a #GstCustomMeta + line="225">a #GstCustomMeta a #GstBuffer + line="226">a #GstBuffer the transform type + line="227">the transform type allow-none="1"> transform specific data. + line="228">transform specific data. closure="5"> user data passed when registering the meta + line="229">user data passed when registering the meta @@ -18474,6 +18090,10 @@ device in the PLAYING state. + Creates the fully configured element to access this device. + Subclasses need to override this and return a new element. @@ -18504,6 +18124,11 @@ create a unique name. + This only needs to be implemented by subclasses if the + element can be reconfigured to use a different device. See the documentation + for gst_device_reconfigure_element(). @@ -18988,6 +18613,11 @@ from all relevant providers. + Returns a list of devices that are currently available. + This should never block. The devices should not have a parent and should + be floating. @@ -19480,6 +19110,11 @@ all devices again. + Returns a list of devices that are currently available. + This should never block. The devices should not have a parent and should + be floating. @@ -19495,6 +19130,10 @@ all devices again. + Starts monitoring for new devices. Only subclasses that can know + that devices have been added or remove need to implement this method. @@ -19514,6 +19153,10 @@ all devices again. + Stops monitoring for new devices. Only subclasses that implement + the start() method need to implement this method. @@ -21396,12 +21039,12 @@ specific situations. throws="1"> Creates an element for handling the given URI. + line="619">Creates an element for handling the given URI. a new element or %NULL if none + line="628">a new element or %NULL if none could be created @@ -21409,13 +21052,13 @@ could be created Whether to create a source or a sink + line="621">Whether to create a source or a sink URI to create an element for + line="622">URI to create an element for allow-none="1"> Name of created element, can be %NULL. + line="623">Name of created element, can be %NULL. @@ -21798,6 +21441,9 @@ MT safe. + called when a request pad is to be released @@ -22026,6 +21672,9 @@ MT safe. + called immediately after a new state was set. @@ -24984,6 +24633,9 @@ functionality. + called when a new pad is requested @@ -25030,6 +24682,9 @@ request. Can be %NULL. + called when a request pad is to be released @@ -25046,6 +24701,9 @@ request. Can be %NULL. + get the state of the element @@ -25101,6 +24759,9 @@ MT safe. + set a new state on the element @@ -25128,6 +24789,9 @@ MT safe. + called by @set_state to perform an incremental state change @@ -25153,6 +24817,9 @@ MT safe. + called immediately after a new state was set. @@ -25175,6 +24842,9 @@ MT safe. + set a #GstBus on the element @@ -25200,6 +24870,9 @@ MT safe. + gets the #GstClock provided by the element @@ -25222,6 +24895,9 @@ MT safe. + set the #GstClock on the element @@ -25254,6 +24930,9 @@ MT safe. + send a #GstEvent to the element @@ -25280,6 +24959,9 @@ as flushing seeks and steps) will emit %GST_MESSAGE_ASYNC_DONE. + perform a #GstQuery on the element @@ -25307,6 +24989,10 @@ MT safe. + called when a message is posted on the element. Chain up to + the parent class' handler to have it posted on the bus. @@ -25335,6 +25021,9 @@ MT safe. + set a #GstContext on the element @@ -27700,26 +27389,6 @@ given @uid. - - Copy the event using the event specific copy function. - - - the new event - - - - - The event to copy - - - - - - Increase the refcount of this event. - - - @event (for convenience when doing assignments) - - - - - The event to refcount - - - - @@ -29137,23 +28786,6 @@ MT safe. - - Decrease the refcount of an event, freeing it if the refcount reaches 0. - - - - - - - the event to refcount - - - - - - Modifies a pointer to a #GstEvent to point to a different #GstEvent. The -modification is done atomically (so this is useful for ensuring thread safety -in some cases), and the reference counts are updated appropriately (the old -event is unreffed, the new one is reffed). - -Either @new_event or the #GstEvent pointed to by @old_event may be %NULL. - - - %TRUE if @new_event was different from @old_event - - - - - pointer to a - pointer to a #GstEvent to be replaced. - - - - pointer to a #GstEvent that will - replace the event pointed to by @old_event. - - - - - - Atomically replace the #GstEvent pointed to by @old_event with %NULL and -return the original event. - - - the #GstEvent that was in @old_event - - - - - pointer to a - pointer to a #GstEvent to be stolen. - - - - - - Modifies a pointer to a #GstEvent to point to a different #GstEvent. This -function is similar to gst_event_replace() except that it takes ownership of -@new_event. - -Either @new_event or the #GstEvent pointed to by @old_event may be %NULL. - - - %TRUE if @new_event was different from @old_event - - - - - pointer to a - pointer to a #GstEvent to be stolen. - - - - pointer to a #GstEvent that will - replace the event pointed to by @old_event. - - - - version="1.6"> Create a new sub-class of #GST_TYPE_FLAG_SET + line="8492">Create a new sub-class of #GST_TYPE_FLAG_SET which will pretty-print the human-readable flags when serializing, for easier debugging. @@ -29913,7 +29435,7 @@ when serializing, for easier debugging. a #GType of a #G_TYPE_FLAGS type. + line="8494">a #GType of a #G_TYPE_FLAGS type. @@ -31266,6 +30788,15 @@ character, a newline character will be added automatically. + + + + + + + @@ -31377,7 +30908,7 @@ character, a newline character will be added automatically. - + @@ -33301,7 +32832,7 @@ was created. - + @@ -33312,13 +32843,13 @@ was created. introspectable="0"> A flags word containing #GstMetaFlags flags set on @meta - + line="57">A flags word containing #GstMetaFlags flags set on @meta + a #GstMeta. + line="59">a #GstMeta. @@ -33327,18 +32858,18 @@ was created. introspectable="0"> Gives the status of a specific flag on a metadata. - + line="64">Gives the status of a specific flag on a metadata. + a #GstMeta. + line="66">a #GstMeta. the #GstMetaFlags to check. + line="67">the #GstMetaFlags to check. @@ -33347,18 +32878,18 @@ was created. introspectable="0"> Sets a metadata flag on a metadata. - + line="72">Sets a metadata flag on a metadata. + a #GstMeta. + line="74">a #GstMeta. the #GstMetaFlags to set. + line="75">the #GstMetaFlags to set. @@ -33367,18 +32898,18 @@ was created. introspectable="0"> Clears a metadata flag. - + line="80">Clears a metadata flag. + a #GstMeta. + line="82">a #GstMeta. the #GstMetaFlags to clear. + line="83">the #GstMetaFlags to clear. @@ -33388,8 +32919,8 @@ was created. version="1.20.4"> This metadata stays relevant until a deep copy is made. - + line="100">This metadata stays relevant until a deep copy is made. + version="1.2"> This metadata stays relevant as long as memory layout is unchanged. + line="90">This metadata stays relevant as long as memory layout is unchanged. In hindsight, this tag should have been called "memory-layout". - + introspectable="0"> Check if the transform type is a copy transform - + line="178">Check if the transform type is a copy transform + a transform type + line="180">a transform type @@ -33769,28 +33300,28 @@ Memory can be efficiently merged when gst_memory_is_span() returns %TRUE. Allocate a new memory block that wraps the given @data. + line="632">Allocate a new memory block that wraps the given @data. The prefix/padding must be filled with 0 if @flags contains #GST_MEMORY_FLAG_ZERO_PREFIXED and #GST_MEMORY_FLAG_ZERO_PADDED respectively. - + a new #GstMemory. + line="648">a new #GstMemory. #GstMemoryFlags + line="634">#GstMemoryFlags data to + line="635">data to wrap @@ -33799,19 +33330,19 @@ The prefix/padding must be filled with 0 if @flags contains allocated size of @data + line="637">allocated size of @data offset in @data + line="638">offset in @data size of valid data + line="639">size of valid data user_data + line="640">user_data called with @user_data when the memory is freed + line="641">called with @user_data when the memory is freed @@ -34125,26 +33656,6 @@ should be done. - - Increase the refcount of this memory. - - - @memory (for convenience when doing assignments) - - - - - The memory to refcount - - - - - - Decrease the refcount of a memory, freeing it if the refcount reaches 0. - - - - - - - the memory to refcount - - - - Creates a copy of the message. Returns a copy of the message. - + - - Convenience macro to increase the reference count of the message. - - - @msg (for convenience when doing assignments) - - - - - the message to ref - - - - - - Convenience macro to decrease the reference count of the message, possibly -freeing it. - - - - - - - the message to unref - - - - @@ -38629,7 +38085,7 @@ in some cases), and the reference counts are updated appropriately (the old message is unreffed, the new one is reffed). Either @new_message or the #GstMessage pointed to by @old_message may be %NULL. - + - - Modifies a pointer to a #GstMessage to point to a different #GstMessage. This -function is similar to gst_message_replace() except that it takes ownership -of @new_message. - - - %TRUE if @new_message was different from @old_message - - - - - pointer to a pointer to a #GstMessage - to be replaced. - - - - pointer to a #GstMessage that - will replace the message pointed to by @old_message. - - - - - + extra flags for the metadata + line="111">extra flags for the metadata pointer to the #GstMetaInfo + line="112">pointer to the #GstMetaInfo version="1.16"> Meta sequence number compare function. Can be used as #GCompareFunc + line="609">Meta sequence number compare function. Can be used as #GCompareFunc or a #GCompareDataFunc. - + a negative number if @meta1 comes before @meta2, 0 if both metas + line="617">a negative number if @meta1 comes before @meta2, 0 if both metas have an equal sequence number, or a positive integer if @meta1 comes after @meta2. @@ -39234,13 +38654,13 @@ or a #GCompareDataFunc. a #GstMeta + line="611">a #GstMeta a #GstMeta + line="612">a #GstMeta @@ -39250,8 +38670,8 @@ or a #GCompareDataFunc. version="1.16"> Gets seqnum for this meta. - + line="587">Gets seqnum for this meta. + @@ -39259,19 +38679,89 @@ or a #GCompareDataFunc. a #GstMeta + line="589">a #GstMeta + + + + + + Serialize @meta into a format that can be stored or transmitted and later +deserialized by gst_meta_deserialize(). + +This is only supported for meta that implements #GstMetaInfo.serialize_func, +%FALSE is returned otherwise. + +Upon failure, @data->data pointer could have been reallocated, but @data->len +won't be modified. This is intended to be able to append multiple metas +into the same #GByteArray. + +Since serialization size is often the same for every buffer, caller may want +to remember the size of previous data to preallocate the next. + + + %TRUE on success, %FALSE otherwise. + + + + + a #GstMeta + + + + #GstByteArrayInterface to append serialization data + + + + + + Same as gst_meta_serialize() but with a #GByteArray instead of +#GstByteArrayInterface. + + + %TRUE on success, %FALSE otherwise. + + + + + a #GstMeta + + #GByteArray to append serialization data + + + + - + an array of tags as strings. + line="393">an array of tags as strings. @@ -39280,7 +38770,7 @@ or a #GCompareDataFunc. an API + line="391">an API @@ -39289,25 +38779,25 @@ or a #GCompareDataFunc. c:identifier="gst_meta_api_type_has_tag"> Check if @api was registered with @tag. - + line="371">Check if @api was registered with @tag. + %TRUE if @api was registered with @tag. + line="378">%TRUE if @api was registered with @tag. an API + line="373">an API the tag to check + line="374">the tag to check @@ -39316,42 +38806,93 @@ or a #GCompareDataFunc. c:identifier="gst_meta_api_type_register"> Register and return a GType for the @api and associate it with + line="111">Register and return a GType for the @api and associate it with @tags. - + a unique GType for @api. + line="119">a unique GType for @api. an API to register + line="113">an API to register tags for @api + line="114">tags for @api + + Recreate a #GstMeta from serialized data returned by +gst_meta_serialize() and add it to @buffer. + +Note that the meta must have been previously registered by calling one of +`gst_*_meta_get_info ()` functions. + +@consumed is set to the number of bytes that can be skipped from @data to +find the next meta serialization, if any. In case of parsing error that does +not allow to determine that size, @consumed is set to 0. + + + the metadata owned by @buffer, or %NULL. + + + + + a #GstBuffer + + + + serialization data obtained from gst_meta_serialize() + + + + size of @data + + + + total size used by this meta, could be less than @size + + + + Lookup a previously registered meta info structure by its implementation name + line="563">Lookup a previously registered meta info structure by its implementation name @impl. - + a #GstMetaInfo with @impl, or + line="570">a #GstMetaInfo with @impl, or %NULL when no such metainfo exists. @@ -39359,23 +38900,25 @@ or a #GCompareDataFunc. the name + line="565">the name - + Register a new #GstMeta implementation. + line="437">Register a new #GstMeta implementation. The same @info can be retrieved later with gst_meta_get_info() by using @impl as the key. - + a #GstMetaInfo that can be used to + line="451">a #GstMetaInfo that can be used to access metadata. @@ -39383,39 +38926,37 @@ access metadata. the type of the #GstMeta API + line="439">the type of the #GstMeta API the name of the #GstMeta implementation + line="440">the name of the #GstMeta implementation the size of the #GstMeta structure + line="441">the size of the #GstMeta structure - + a #GstMetaInitFunction + line="442">a #GstMetaInitFunction - + a #GstMetaFreeFunction + line="443">a #GstMetaFreeFunction - + a #GstMetaTransformFunction + line="444">a #GstMetaTransformFunction @@ -39426,7 +38967,7 @@ access metadata. version="1.20"> Register a new custom #GstMeta implementation, backed by an opaque + line="271">Register a new custom #GstMeta implementation, backed by an opaque structure holding a #GstStructure. The registered info can be retrieved later with gst_meta_get_info() by using @@ -39439,11 +38980,11 @@ writability of the buffer the meta is attached to. When @transform_func is %NULL, the meta and its backing #GstStructure will always be copied when the transform operation is copy, other operations are discarded, copy regions are ignored. - + a #GstMetaInfo that can be used to + line="293">a #GstMetaInfo that can be used to access metadata. @@ -39451,13 +38992,13 @@ access metadata. the name of the #GstMeta implementation + line="273">the name of the #GstMeta implementation tags for @api + line="274">tags for @api @@ -39471,7 +39012,7 @@ access metadata. destroy="4"> a #GstMetaTransformFunction + line="275">a #GstMetaTransformFunction @@ -39481,7 +39022,7 @@ access metadata. allow-none="1"> user data passed to @transform_func + line="276">user data passed to @transform_func scope="async"> #GDestroyNotify for user_data + line="277">#GDestroyNotify for user_data + + Simplified version of gst_meta_register_custom(), with no tags and no +transform function. + + + a #GstMetaInfo that can be used to access metadata. + + + + + the name of the #GstMeta implementation + + + + + + Clears the content of the meta. This will be called by the GstBufferPool +when a pooled buffer is returned. + + + + + + + a #GstBuffer + + + + a #GstMeta + + + + + + Recreate a #GstMeta from serialized data returned by +#GstMetaSerializeFunction and add it to @buffer. + + + the metadata owned by @buffer, or %NULL. + + + + + #GstMetaInfo of the meta + + + + a #GstBuffer + + + + data obtained from #GstMetaSerializeFunction + + + + size of data to avoid buffer overflow + + + + + + + Extra metadata flags. + line="38">Extra metadata flags. glib:name="GST_META_FLAG_NONE"> no flags + line="40">no flags glib:name="GST_META_FLAG_READONLY"> metadata should not be modified + line="41">metadata should not be modified glib:name="GST_META_FLAG_POOLED"> metadata is managed by a bufferpool + line="42">metadata is managed by a bufferpool glib:name="GST_META_FLAG_LOCKED"> metadata should not be removed + line="43">metadata should not be removed glib:name="GST_META_FLAG_LAST"> additional flags can be added starting from this flag. + line="44">additional flags can be added starting from this flag. Function called when @meta is freed in @buffer. - + line="161">Function called when @meta is freed in @buffer. + @@ -39560,13 +39194,13 @@ access metadata. a #GstMeta + line="163">a #GstMeta a #GstBuffer + line="164">a #GstBuffer @@ -39574,53 +39208,76 @@ access metadata. The #GstMetaInfo provides information about a specific metadata + line="323">The #GstMetaInfo provides information about a specific metadata structure. - + tag identifying the metadata structure and api + line="325">tag identifying the metadata structure and api type identifying the implementor of the api + line="326">type identifying the implementor of the api size of the metadata + line="327">size of the metadata function for initializing the metadata + line="328">function for initializing the metadata function for freeing the metadata + line="329">function for freeing the metadata function for transforming the metadata + line="330">function for transforming the metadata + + Function for serializing the metadata, or %NULL if not supported by this +meta. + + + + Function for deserializing the metadata, or %NULL if not supported by this +meta. + + + + Function for clearing the metadata, or %NULL if not supported by this +meta. This is called by the buffer pool when a buffer is returned for +pooled metas. + + - + whether @info was registered as a #GstCustomMeta with + line="359">whether @info was registered as a #GstCustomMeta with gst_meta_register_custom() @@ -39630,12 +39287,102 @@ structure. + + Registers a new meta. + +Use the structure returned by gst_meta_info_new(), it consumes it and the +structure shouldnt be used after. The one returned by the function can be +kept. + + + the registered meta + + + + + a new #GstMetaInfo created by gst_meta_info_new() + + + + + + Creates a new structure that needs to be filled before being +registered. This structure should filled and then registered with +gst_meta_info_register(). + +Example: +```c +const GstMetaInfo * +gst_my_meta_get_info (void) +{ + static const GstMetaInfo *meta_info = NULL; + + if (g_once_init_enter ((GstMetaInfo **) & meta_info)) { + GstMetaInfo *info = gst_meta_info_new ( + gst_my_meta_api_get_type (), + "GstMyMeta", + sizeof (GstMyMeta)); + const GstMetaInfo *meta = NULL; + + info->init_func = my_meta_init; + info->free_func = my_meta_free; + info->transform_func = my_meta_transform; + info->serialize_func = my_meta_serialize; + info->deserialize_func = my_meta_deserialize; + meta = gst_meta_info_register (info); + g_once_init_leave ((GstMetaInfo **) & meta_info, (GstMetaInfo *) meta); + } + + return meta_info; +} +``` + + + a new #GstMetaInfo that needs to be filled + + + + + the type of the #GstMeta API + + + + the name of the #GstMeta implementation + + + + the size of the #GstMeta structure + + + + Function called when @meta is initialized in @buffer. - + line="151">Function called when @meta is initialized in @buffer. + @@ -39643,7 +39390,7 @@ structure. a #GstMeta + line="153">a #GstMeta allow-none="1"> parameters passed to the init function + line="154">parameters passed to the init function a #GstBuffer + line="155">a #GstBuffer + + Serialize @meta into a format that can be stored or transmitted and later +deserialized by #GstMetaDeserializeFunction. + +By default version is set to 0, it should be bumped if incompatible changes +are made to the format so %GstMetaDeserializeFunction can deserialize each +version. + + + %TRUE on success, %FALSE otherwise. + + + + + a #GstMeta + + + + #GstByteArrayInterface to append serialization data + + + + version of the serialization format + + + + Extra data passed to a "gst-copy" transform #GstMetaTransformFunction. - + line="186">Extra data passed to a "gst-copy" transform #GstMetaTransformFunction. + %TRUE if only region is copied + line="188">%TRUE if only region is copied the offset to copy, 0 if @region is %FALSE, otherwise > 0 + line="189">the offset to copy, 0 if @region is %FALSE, otherwise > 0 the size to copy, -1 or the buffer size when @region is %FALSE + line="190">the size to copy, -1 or the buffer size when @region is %FALSE Function called for each @meta in @buffer as a result of performing a + line="200">Function called for each @meta in @buffer as a result of performing a transformation on @transbuf. Additional @type specific transform data is passed to the function as @data. Implementations should check the @type of the transform and parse additional type specific fields in @data that should be used to update the metadata on @transbuf. - + %TRUE if the transform could be performed + line="216">%TRUE if the transform could be performed a #GstBuffer + line="202">a #GstBuffer a #GstMeta + line="203">a #GstMeta a #GstBuffer + line="204">a #GstBuffer the transform type + line="205">the transform type allow-none="1"> transform specific data. + line="206">transform specific data. @@ -40558,6 +40347,44 @@ last ref and @obj is about to be freed. + + Declare a #GMutexLocker variable with g_autoptr() and lock the object. The +mutex will be unlocked automatically when leaving the scope. + +``` c +{ + GST_OBJECT_AUTO_LOCK (obj, locker); + + obj->stuff_with_lock(); + if (cond) { + // No need to unlock + return; + } + + // Unlock before end of scope + g_clear_pointer (&locker, g_mutex_locker_free); + obj->stuff_without_lock(); +} +``` + + + + a #GstObject to lock + + + a variable name to be declared + + + @@ -40590,13 +40417,13 @@ last ref and @obj is about to be freed. introspectable="0"> This macro returns the entire set of flags for the object. - + line="176">This macro returns the entire set of flags for the object. + a #GstObject + line="178">a #GstObject @@ -40605,18 +40432,18 @@ last ref and @obj is about to be freed. introspectable="0"> This macro checks to see if the given flag is set. - + line="183">This macro checks to see if the given flag is set. + a #GstObject + line="185">a #GstObject Flag to check for + line="186">Flag to check for @@ -40625,18 +40452,18 @@ last ref and @obj is about to be freed. introspectable="0"> This macro sets the given bits. - + line="191">This macro sets the given bits. + a #GstObject + line="193">a #GstObject Flag to set + line="194">Flag to set @@ -40645,18 +40472,18 @@ last ref and @obj is about to be freed. introspectable="0"> This macro unsets the given bits. - + line="199">This macro unsets the given bits. + a #GstObject + line="201">a #GstObject Flag to set + line="202">Flag to set @@ -40674,13 +40501,13 @@ last ref and @obj is about to be freed. introspectable="0"> Acquire a reference to the mutex of this object. - + line="96">Acquire a reference to the mutex of this object. + a #GstObject + line="98">a #GstObject @@ -40689,14 +40516,14 @@ last ref and @obj is about to be freed. introspectable="0"> This macro will obtain a lock on the object, making serialization possible. + line="103">This macro will obtain a lock on the object, making serialization possible. It blocks until the lock can be obtained. - + a #GstObject to lock + line="105">a #GstObject to lock @@ -40705,15 +40532,15 @@ It blocks until the lock can be obtained. introspectable="0"> Get the name of this object. This is not thread-safe by default + line="156">Get the name of this object. This is not thread-safe by default (i.e. you will have to make sure the object lock is taken yourself). If in doubt use gst_object_get_name() instead. - + a #GstObject + line="158">a #GstObject @@ -40722,15 +40549,15 @@ If in doubt use gst_object_get_name() instead. introspectable="0"> Get the parent of this object. This is not thread-safe by default + line="165">Get the parent of this object. This is not thread-safe by default (i.e. you will have to make sure the object lock is taken yourself). If in doubt use gst_object_get_parent() instead. - + a #GstObject + line="167">a #GstObject @@ -40739,13 +40566,13 @@ If in doubt use gst_object_get_parent() instead. introspectable="0"> Get access to the reference count field of the object. - + line="78">Get access to the reference count field of the object. + a #GstObject + line="80">a #GstObject @@ -40754,13 +40581,13 @@ If in doubt use gst_object_get_parent() instead. introspectable="0"> Get the reference count value of the object. - + line="85">Get the reference count value of the object. + a #GstObject + line="87">a #GstObject @@ -40769,14 +40596,14 @@ If in doubt use gst_object_get_parent() instead. introspectable="0"> This macro will try to obtain a lock on the object, but will return with + line="139">This macro will try to obtain a lock on the object, but will return with %FALSE if it can't get it immediately. - + a #GstObject. + line="141">a #GstObject. @@ -40785,13 +40612,13 @@ If in doubt use gst_object_get_parent() instead. introspectable="0"> This macro releases a lock on the object. - + line="147">This macro releases a lock on the object. + a #GstObject to unlock. + line="149">a #GstObject to unlock. @@ -40854,21 +40681,21 @@ What needs to be done in applications? Again it's not a lot to change. gst_timed_value_control_source_set ((GstTimedValueControlSource *)csource,1 * GST_SECOND, value2); * start your pipeline - + Checks to see if there is any object named @name in @list. This function + line="887">Checks to see if there is any object named @name in @list. This function does not do any locking of any kind. You might want to protect the provided list with the lock of the owner of the list. This function will lock each #GstObject in the list to compare the name, so be careful when passing a list with a locked object. - + %TRUE if a #GstObject named @name does not appear in @list, + line="899">%TRUE if a #GstObject named @name does not appear in @list, %FALSE if it does. MT safe. Grabs and releases the LOCK of each object in the list. @@ -40878,7 +40705,7 @@ MT safe. Grabs and releases the LOCK of each object in the list. a list of #GstObject to + line="889">a list of #GstObject to check through @@ -40887,7 +40714,7 @@ MT safe. Grabs and releases the LOCK of each object in the list. the name to search for + line="891">the name to search for @@ -40896,14 +40723,14 @@ MT safe. Grabs and releases the LOCK of each object in the list. c:identifier="gst_object_default_deep_notify"> A default deep_notify signal callback for an object. The user data + line="490">A default deep_notify signal callback for an object. The user data should contain a pointer to an array of strings that should be excluded from the notify. The default handler will print the new value of the property using g_print. MT safe. This function grabs and releases @object's LOCK for getting its path string. - + @@ -40911,19 +40738,19 @@ MT safe. This function grabs and releases @object's LOCK for getting its the #GObject that signalled the notify. + line="492">the #GObject that signalled the notify. a #GstObject that initiated the notify. + line="493">a #GstObject that initiated the notify. a #GParamSpec of the property. + line="494">a #GParamSpec of the property. + line="495"> a set of user-specified properties to exclude or %NULL to show all changes. @@ -40946,7 +40773,7 @@ MT safe. This function grabs and releases @object's LOCK for getting its introspectable="0"> Increase the reference count of @object, and possibly remove the floating + line="272">Increase the reference count of @object, and possibly remove the floating reference, if @object has a floating reference. In other words, if the object is floating, then this call "assumes ownership" @@ -40957,7 +40784,7 @@ reference count by one. For more background on "floating references" please see the #GObject documentation. - + @@ -40968,7 +40795,7 @@ documentation. allow-none="1"> a #GstObject to sink + line="274">a #GstObject to sink @@ -40976,16 +40803,16 @@ documentation. Atomically modifies a pointer to point to a new object. + line="325">Atomically modifies a pointer to point to a new object. The reference count of @oldobj is decreased and the reference count of @newobj is increased. Either @newobj and the value pointed to by @oldobj may be %NULL. - + %TRUE if @newobj was different from @oldobj + line="337">%TRUE if @newobj was different from @oldobj @@ -40997,7 +40824,7 @@ Either @newobj and the value pointed to by @oldobj may be %NULL. allow-none="1"> pointer to a place of + line="327">pointer to a place of a #GstObject to replace @@ -41007,13 +40834,16 @@ Either @newobj and the value pointed to by @oldobj may be %NULL. allow-none="1"> a new #GstObject + line="329">a new #GstObject - + default signal handler + @@ -41033,16 +40863,16 @@ Either @newobj and the value pointed to by @oldobj may be %NULL. c:identifier="gst_object_add_control_binding"> Attach the #GstControlBinding to the object. If there already was a + line="1241">Attach the #GstControlBinding to the object. If there already was a #GstControlBinding for this property it will be replaced. The object's reference count will be incremented, and any floating reference will be removed (see gst_object_ref_sink()) - + %FALSE if the given @binding has not been setup for this object or + line="1252">%FALSE if the given @binding has not been setup for this object or has been setup for a non suitable property, %TRUE otherwise. @@ -41050,13 +40880,13 @@ has been setup for a non suitable property, %TRUE otherwise. the controller object + line="1243">the controller object the #GstControlBinding that should be used + line="1244">the #GstControlBinding that should be used @@ -41100,13 +40930,13 @@ The default handler will simply print the error string using g_print. c:identifier="gst_object_get_control_binding"> Gets the corresponding #GstControlBinding for the property. This should be + line="1278">Gets the corresponding #GstControlBinding for the property. This should be unreferenced again after use. - + the #GstControlBinding for + line="1286">the #GstControlBinding for @property_name or %NULL if the property is not controlled. @@ -41114,13 +40944,13 @@ unreferenced again after use. the object + line="1280">the object name of the property + line="1281">name of the property @@ -41129,7 +40959,7 @@ unreferenced again after use. c:identifier="gst_object_get_control_rate"> Obtain the control-rate for this @object. Audio processing #GstElement + line="1457">Obtain the control-rate for this @object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst_object_sync_values() in between. The length of the processing segment should be up to @control-rate nanoseconds. @@ -41139,18 +40969,18 @@ If the @object is not under property control, this will return The control-rate is not expected to change if the element is in %GST_STATE_PAUSED or %GST_STATE_PLAYING. - + the control rate in nanoseconds + line="1472">the control rate in nanoseconds the object that has controlled properties + line="1459">the object that has controlled properties @@ -41159,54 +40989,54 @@ The control-rate is not expected to change if the element is in c:identifier="gst_object_get_g_value_array"> Gets a number of #GValues for the given controlled property starting at the + line="1415">Gets a number of #GValues for the given controlled property starting at the requested time. The array @values need to hold enough space for @n_values of #GValue. This function is useful if one wants to e.g. draw a graph of the control curve or apply a control curve sample by sample. - + %TRUE if the given array could be filled, %FALSE otherwise + line="1431">%TRUE if the given array could be filled, %FALSE otherwise the object that has controlled properties + line="1417">the object that has controlled properties the name of the property to get + line="1418">the name of the property to get the time that should be processed + line="1419">the time that should be processed the time spacing between subsequent values + line="1420">the time spacing between subsequent values the number of values + line="1421">the number of values array to put control-values in + line="1422">array to put control-values in @@ -41218,17 +41048,17 @@ curve or apply a control curve sample by sample. glib:get-property="name"> Returns a copy of the name of @object. + line="660">Returns a copy of the name of @object. Caller should g_free() the return value after usage. For a nameless object, this returns %NULL, which you can safely g_free() as well. Free-function: g_free - + the name of @object. g_free() + line="671">the name of @object. g_free() after usage. MT safe. This function grabs and releases @object's LOCK. @@ -41238,7 +41068,7 @@ MT safe. This function grabs and releases @object's LOCK. a #GstObject + line="662">a #GstObject @@ -41248,13 +41078,13 @@ MT safe. This function grabs and releases @object's LOCK. glib:get-property="parent"> Returns the parent of @object. This function increases the refcount + line="742">Returns the parent of @object. This function increases the refcount of the parent object so you should gst_object_unref() it after usage. - + parent of @object, this can be + line="749">parent of @object, this can be %NULL if @object has no parent. unref after usage. MT safe. Grabs and releases @object's LOCK. @@ -41264,7 +41094,7 @@ MT safe. Grabs and releases @object's LOCK. a #GstObject + line="744">a #GstObject @@ -41272,15 +41102,15 @@ MT safe. Grabs and releases @object's LOCK. Generates a string describing the path of @object in + line="972">Generates a string describing the path of @object in the object hierarchy. Only useful (or used) for debugging. Free-function: g_free - + a string describing the path of @object. You must + line="981">a string describing the path of @object. You must g_free() the string after usage. MT safe. Grabs and releases the #GstObject's LOCK for all objects @@ -41291,7 +41121,7 @@ MT safe. Grabs and releases the #GstObject's LOCK for all objects a #GstObject + line="974">a #GstObject @@ -41299,12 +41129,12 @@ MT safe. Grabs and releases the #GstObject's LOCK for all objects Gets the value for the given controlled property at the requested time. - + line="1339">Gets the value for the given controlled property at the requested time. + the GValue of the property at the given time, + line="1347">the GValue of the property at the given time, or %NULL if the property isn't controlled. @@ -41312,19 +41142,19 @@ or %NULL if the property isn't controlled. the object that has controlled properties + line="1341">the object that has controlled properties the name of the property to get + line="1342">the name of the property to get the time the control-change should be read from + line="1343">the time the control-change should be read from @@ -41334,7 +41164,7 @@ or %NULL if the property isn't controlled. introspectable="0"> Gets a number of values for the given controlled property starting at the + line="1370">Gets a number of values for the given controlled property starting at the requested time. The array @values need to hold enough space for @n_values of the same type as the objects property's type. @@ -41344,48 +41174,48 @@ curve or apply a control curve sample by sample. The values are unboxed and ready to be used. The similar function gst_object_get_g_value_array() returns the array as #GValues and is better suites for bindings. - + %TRUE if the given array could be filled, %FALSE otherwise + line="1390">%TRUE if the given array could be filled, %FALSE otherwise the object that has controlled properties + line="1372">the object that has controlled properties the name of the property to get + line="1373">the name of the property to get the time that should be processed + line="1374">the time that should be processed the time spacing between subsequent values + line="1375">the time spacing between subsequent values the number of values + line="1376">the number of values array to put control-values in + line="1377">array to put control-values in @@ -41396,19 +41226,19 @@ better suites for bindings. c:identifier="gst_object_has_active_control_bindings"> Check if the @object has active controlled properties. - + line="1165">Check if the @object has active controlled properties. + %TRUE if the object has active controlled properties + line="1171">%TRUE if the object has active controlled properties the object that has controlled properties + line="1167">the object that has controlled properties @@ -41418,29 +41248,29 @@ better suites for bindings. deprecated="1"> Check if @object has an ancestor @ancestor somewhere up in + line="865">Check if @object has an ancestor @ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline. Use gst_object_has_as_ancestor() instead. MT safe. Grabs and releases @object's locks. - + %TRUE if @ancestor is an ancestor of @object. + line="873">%TRUE if @ancestor is an ancestor of @object. a #GstObject to check + line="867">a #GstObject to check a #GstObject to check as ancestor + line="868">a #GstObject to check as ancestor @@ -41448,13 +41278,13 @@ MT safe. Grabs and releases @object's locks. Check if @object has an ancestor @ancestor somewhere up in + line="830">Check if @object has an ancestor @ancestor somewhere up in the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline. - + %TRUE if @ancestor is an ancestor of @object. + line="838">%TRUE if @ancestor is an ancestor of @object. MT safe. Grabs and releases @object's locks. @@ -41463,13 +41293,13 @@ MT safe. Grabs and releases @object's locks. a #GstObject to check + line="832">a #GstObject to check a #GstObject to check as ancestor + line="833">a #GstObject to check as ancestor @@ -41479,13 +41309,13 @@ MT safe. Grabs and releases @object's locks. version="1.6"> Check if @parent is the parent of @object. + line="802">Check if @parent is the parent of @object. E.g. a #GstElement can check if it owns a given #GstPad. - + %FALSE if either @object or @parent is %NULL. %TRUE if @parent is + line="810">%FALSE if either @object or @parent is %NULL. %TRUE if @parent is the parent of @object. Otherwise %FALSE. MT safe. Grabs and releases @object's locks. @@ -41495,13 +41325,13 @@ MT safe. Grabs and releases @object's locks. a #GstObject to check + line="804">a #GstObject to check a #GstObject to check as parent + line="805">a #GstObject to check as parent @@ -41509,25 +41339,25 @@ MT safe. Grabs and releases @object's locks. Increments the reference count on @object. This function + line="218">Increments the reference count on @object. This function does not take the lock on @object because it relies on atomic refcounting. This object returns the input parameter to ease writing constructs like : result = gst_object_ref (object->parent); - + A pointer to @object + line="230">A pointer to @object a #GstObject to reference + line="220">a #GstObject to reference @@ -41536,26 +41366,26 @@ constructs like : c:identifier="gst_object_remove_control_binding"> Removes the corresponding #GstControlBinding. If it was the + line="1306">Removes the corresponding #GstControlBinding. If it was the last ref of the binding, it will be disposed. - + %TRUE if the binding could be removed. + line="1314">%TRUE if the binding could be removed. the object + line="1308">the object the binding + line="1309">the binding @@ -41564,10 +41394,10 @@ last ref of the binding, it will be disposed. c:identifier="gst_object_set_control_binding_disabled"> This function is used to disable the control bindings on a property for + line="1213">This function is used to disable the control bindings on a property for some time, i.e. gst_object_sync_values() will do nothing for the property. - + @@ -41575,19 +41405,19 @@ property. the object that has controlled properties + line="1215">the object that has controlled properties property to disable + line="1216">property to disable boolean that specifies whether to disable the controller + line="1217">boolean that specifies whether to disable the controller or not. @@ -41597,9 +41427,9 @@ or not. c:identifier="gst_object_set_control_bindings_disabled"> This function is used to disable all controlled properties of the @object for + line="1189">This function is used to disable all controlled properties of the @object for some time, i.e. gst_object_sync_values() will do nothing. - + @@ -41607,13 +41437,13 @@ some time, i.e. gst_object_sync_values() will do nothing. the object that has controlled properties + line="1191">the object that has controlled properties boolean that specifies whether to disable the controller + line="1192">boolean that specifies whether to disable the controller or not. @@ -41623,14 +41453,14 @@ or not. c:identifier="gst_object_set_control_rate"> Change the control-rate for this @object. Audio processing #GstElement + line="1482">Change the control-rate for this @object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call gst_object_sync_values() in between. The length of the processing segment should be up to @control-rate nanoseconds. The control-rate should not change if the element is in %GST_STATE_PAUSED or %GST_STATE_PLAYING. - + @@ -41638,13 +41468,13 @@ The control-rate should not change if the element is in %GST_STATE_PAUSED or the object that has controlled properties + line="1484">the object that has controlled properties the new control-rate in nanoseconds. + line="1485">the new control-rate in nanoseconds. @@ -41654,15 +41484,15 @@ The control-rate should not change if the element is in %GST_STATE_PAUSED or glib:set-property="name"> Sets the name of @object, or gives @object a guaranteed unique + line="632">Sets the name of @object, or gives @object a guaranteed unique name (if @name is %NULL). This function makes a copy of the provided name, so the caller retains ownership of the name it sent. - + %TRUE if the name could be set. Since Objects that have + line="642">%TRUE if the name could be set. Since Objects that have a parent cannot be renamed, this function returns %FALSE in those cases. @@ -41673,7 +41503,7 @@ MT safe. This function grabs and releases @object's LOCK. a #GstObject + line="634">a #GstObject allow-none="1"> new name of object + line="635">new name of object @@ -41692,13 +41522,13 @@ MT safe. This function grabs and releases @object's LOCK. glib:set-property="parent"> Sets the parent of @object to @parent. The object's reference count will + line="690">Sets the parent of @object to @parent. The object's reference count will be incremented, and any floating reference will be removed (see gst_object_ref_sink()). - + %TRUE if @parent could be set or %FALSE when @object + line="698">%TRUE if @parent could be set or %FALSE when @object already had a parent or @object and @parent are the same. MT safe. Grabs and releases @object's LOCK. @@ -41708,13 +41538,13 @@ MT safe. Grabs and releases @object's LOCK. a #GstObject + line="692">a #GstObject new parent of object + line="693">new parent of object @@ -41723,13 +41553,13 @@ MT safe. Grabs and releases @object's LOCK. c:identifier="gst_object_suggest_next_sync"> Returns a suggestion for timestamps where buffers should be split + line="1091">Returns a suggestion for timestamps where buffers should be split to get best controller results. - + Returns the suggested timestamp or %GST_CLOCK_TIME_NONE + line="1098">Returns the suggested timestamp or %GST_CLOCK_TIME_NONE if no control-rate was set. @@ -41737,7 +41567,7 @@ if no control-rate was set. the object that has controlled properties + line="1093">the object that has controlled properties @@ -41745,16 +41575,16 @@ if no control-rate was set. Sets the properties of the object, according to the #GstControlSources that + line="1123">Sets the properties of the object, according to the #GstControlSources that (maybe) handle them and for the given timestamp. If this function fails, it is most likely the application developers fault. Most probably the control sources are not setup correctly. - + %TRUE if the controller values could be applied to the object + line="1134">%TRUE if the controller values could be applied to the object properties, %FALSE otherwise @@ -41762,13 +41592,13 @@ properties, %FALSE otherwise the object that has controlled properties + line="1125">the object that has controlled properties the time that should be processed + line="1126">the time that should be processed @@ -41776,11 +41606,11 @@ properties, %FALSE otherwise Clear the parent of @object, removing the associated reference. + line="770">Clear the parent of @object, removing the associated reference. This function decreases the refcount of @object. MT safe. Grabs and releases @object's lock. - + @@ -41788,7 +41618,7 @@ MT safe. Grabs and releases @object's lock. a #GstObject to unparent + line="772">a #GstObject to unparent @@ -41796,13 +41626,13 @@ MT safe. Grabs and releases @object's lock. Decrements the reference count on @object. If reference count hits + line="247">Decrements the reference count on @object. If reference count hits zero, destroy @object. This function does not take the lock on @object as it relies on atomic refcounting. The unref method should never be called with the LOCK held since this might deadlock the dispose function. - + @@ -41810,7 +41640,7 @@ this might deadlock the dispose function. a #GstObject to unreference + line="249">a #GstObject to unreference @@ -41831,7 +41661,7 @@ this might deadlock the dispose function. getter="get_parent"> The parent of the object. Please note, that when changing the 'parent' + line="161">The parent of the object. Please note, that when changing the 'parent' property, we don't emit #GObject::notify and #GstObject::deep-notify signals due to locking issues. In some cases one can use #GstBin::element-added or #GstBin::element-removed signals on the parent to @@ -41844,25 +41674,25 @@ achieve a similar effect. object LOCK + line="213">object LOCK The name of the object + line="214">The name of the object this object's parent, weak ref + line="215">this object's parent, weak ref flags for this object + line="216">flags for this object @@ -41886,7 +41716,7 @@ achieve a similar effect. no-hooks="1"> The deep notify signal is used to be notified of property changes. It is + line="177">The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin. @@ -41896,13 +41726,13 @@ the elements contained in that bin. the object that originated the signal + line="180">the object that originated the signal the property that changed + line="181">the property that changed @@ -41913,24 +41743,27 @@ the elements contained in that bin. glib:is-gtype-struct-for="Object"> GStreamer base object class. - + line="237">GStreamer base object class. + parent + line="239">parent separator used by gst_object_get_path_string() + line="240">separator used by gst_object_get_path_string() + default signal handler - + @@ -41959,7 +41792,7 @@ the elements contained in that bin. c:type="GstObjectFlags"> The standard flags that an gstobject may have. + line="55">The standard flags that an gstobject may have. glib:name="GST_OBJECT_FLAG_MAY_BE_LEAKED"> the object is expected to stay alive even + line="57">the object is expected to stay alive even after gst_deinit() has been called and so should be ignored by leak detection tools. (Since: 1.10) + + + Flag that's set when the object has been constructed. This can be used by +API such as base class setters to differentiate between the case where +they're called from a subclass's instance init function (and where the +object isn't fully constructed yet, and so one shouldn't do anything but +set values in the instance structure), and the case where the object is +constructed. glib:name="GST_OBJECT_FLAG_LAST"> subclasses can add additional flags starting from this flag + line="66">subclasses can add additional flags starting from this flag @@ -42021,7 +41869,7 @@ detection tools. (Since: 1.10) - + @@ -42030,7 +41878,7 @@ detection tools. (Since: 1.10) - + @@ -42039,7 +41887,7 @@ detection tools. (Since: 1.10) - + @@ -42048,7 +41896,7 @@ detection tools. (Since: 1.10) - + @@ -42459,13 +42307,13 @@ linked @pads instead of discarding them. introspectable="0"> Gets the last flow return on this pad - + line="1295">Gets the last flow return on this pad + a #GstPad + line="1297">a #GstPad @@ -42850,6 +42698,44 @@ queries explicitly if your element supports multiple scheduling modes. + + Declare a #GRecMutexLocker variable with g_autoptr() and lock the pad. The +recursive mutex will be unlocked automatically when leaving the scope. + +``` c +{ + GST_PAD_STREAM_AUTO_LOCK (pad, locker); + + gst_pad_push_event(pad, event1); + if (cond) { + // No need to unlock + return; + } + + // Unlock before end of scope + g_clear_pointer (&locker, g_rec_mutex_locker_free); + gst_pad_push_event(pad, event2); +} +``` + + + + a #GstPad + + + a variable name to be declared + + + @@ -42871,14 +42757,14 @@ when buffers or serialized downstream events are pushed on a pad. introspectable="0"> Try to take the pad's stream lock, and return %TRUE if the lock could be + line="1280">Try to take the pad's stream lock, and return %TRUE if the lock could be taken, and otherwise %FALSE. - + a #GstPad + line="1282">a #GstPad @@ -42887,13 +42773,13 @@ taken, and otherwise %FALSE. introspectable="0"> Release the pad's stream lock. - + line="1288">Release the pad's stream lock. + a #GstPad + line="1290">a #GstPad @@ -43469,7 +43355,7 @@ calls the plugin initialization function. - + @@ -43614,15 +43500,15 @@ respectively. Creates a new pad with the given name in the given direction. + line="832">Creates a new pad with the given name in the given direction. If name is %NULL, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name. - + a new #GstPad. + line="842">a new #GstPad. MT safe. @@ -43634,13 +43520,13 @@ MT safe. allow-none="1"> the name of the new pad. + line="834">the name of the new pad. the #GstPadDirection of the pad. + line="835">the #GstPadDirection of the pad. @@ -43649,28 +43535,28 @@ MT safe. c:identifier="gst_pad_new_from_static_template"> Creates a new pad with the given name from the given static template. + line="878">Creates a new pad with the given name from the given static template. If name is %NULL, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name. - + a new #GstPad. + line="888">a new #GstPad. the #GstStaticPadTemplate to use + line="880">the #GstStaticPadTemplate to use the name of the pad + line="881">the name of the pad @@ -43679,22 +43565,22 @@ This function makes a copy of the name so you can safely free the name. c:identifier="gst_pad_new_from_template"> Creates a new pad with the given name from the given template. + line="853">Creates a new pad with the given name from the given template. If name is %NULL, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name. - + a new #GstPad. + line="863">a new #GstPad. the pad template to use + line="855">the pad template to use allow-none="1"> the name of the pad + line="856">the name of the pad @@ -43761,15 +43647,15 @@ This function makes a copy of the name so you can safely free the name. Activates or deactivates the given pad in @mode via dispatching to the + line="1294">Activates or deactivates the given pad in @mode via dispatching to the pad's activatemodefunc. For use from within pad activation functions only. If you don't know what this is, you probably don't want to call it. - + %TRUE if the operation was successful. + line="1305">%TRUE if the operation was successful. MT safe. @@ -43778,19 +43664,19 @@ MT safe. the #GstPad to activate or deactivate. + line="1296">the #GstPad to activate or deactivate. the requested activation mode + line="1297">the requested activation mode whether or not the pad should be active. + line="1298">whether or not the pad should be active. @@ -43798,7 +43684,7 @@ MT safe. Be notified of different states of pads. The provided callback is called for + line="1407">Be notified of different states of pads. The provided callback is called for every state that matches @mask. Probes are called in groups: First GST_PAD_PROBE_TYPE_BLOCK probes are @@ -43807,11 +43693,11 @@ exception here are GST_PAD_PROBE_TYPE_IDLE probes that are called immediately if the pad is already idle while calling gst_pad_add_probe(). In each of the groups, probes are called in the order in which they were added. - + an id or 0 if no probe is pending. The id can be used to remove the + line="1426">an id or 0 if no probe is pending. The id can be used to remove the probe with gst_pad_remove_probe(). When using GST_PAD_PROBE_TYPE_IDLE it can happen that the probe can be run immediately and if the probe returns GST_PAD_PROBE_REMOVE this functions returns 0. @@ -43823,13 +43709,13 @@ MT safe. the #GstPad to add the probe to + line="1409">the #GstPad to add the probe to the probe mask + line="1410">the probe mask destroy="3"> #GstPadProbeCallback that will be called with notifications of + line="1411">#GstPadProbeCallback that will be called with notifications of the pad state @@ -43849,7 +43735,7 @@ MT safe. allow-none="1"> user data passed to the callback + line="1413">user data passed to the callback scope="async"> #GDestroyNotify for user_data + line="1414">#GDestroyNotify for user_data @@ -43865,26 +43751,26 @@ MT safe. Checks if the source pad and the sink pad are compatible so they can be + line="2477">Checks if the source pad and the sink pad are compatible so they can be linked. - + %TRUE if the pads can be linked. + line="2485">%TRUE if the pads can be linked. the source #GstPad. + line="2479">the source #GstPad. the sink #GstPad. + line="2480">the sink #GstPad. @@ -43892,7 +43778,7 @@ linked. Chain a buffer to @pad. + line="4611">Chain a buffer to @pad. The function returns #GST_FLOW_FLUSHING if the pad was flushing. @@ -43907,11 +43793,11 @@ chain function. In all cases, success or failure, the caller loses its reference to @buffer after calling this function. - + a #GstFlowReturn from the pad. + line="4633">a #GstFlowReturn from the pad. MT safe. @@ -43920,13 +43806,13 @@ MT safe. a sink #GstPad, returns GST_FLOW_ERROR if not. + line="4613">a sink #GstPad, returns GST_FLOW_ERROR if not. the #GstBuffer to send, return GST_FLOW_ERROR + line="4614">the #GstBuffer to send, return GST_FLOW_ERROR if not. @@ -43935,7 +43821,7 @@ MT safe. Chain a bufferlist to @pad. + line="4675">Chain a bufferlist to @pad. The function returns #GST_FLOW_FLUSHING if the pad was flushing. @@ -43951,24 +43837,24 @@ In all cases, success or failure, the caller loses its reference to @list after calling this function. MT safe. - + a #GstFlowReturn from the pad. + line="4698">a #GstFlowReturn from the pad. a sink #GstPad, returns GST_FLOW_ERROR if not. + line="4677">a sink #GstPad, returns GST_FLOW_ERROR if not. the #GstBufferList to send, return GST_FLOW_ERROR + line="4678">the #GstBufferList to send, return GST_FLOW_ERROR if not. @@ -43978,20 +43864,20 @@ MT safe. c:identifier="gst_pad_check_reconfigure"> Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE + line="1667">Check and clear the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE if the flag was set. - + %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad. + line="1674">%TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag was set on @pad. the #GstPad to check + line="1669">the #GstPad to check @@ -44160,25 +44046,25 @@ stream-id manually instead. Invokes the default event handler for the given pad. + line="3164">Invokes the default event handler for the given pad. The EOS event will pause the task associated with @pad before it is forwarded to all internally linked pads, The event is sent to all pads internally linked to @pad. This function takes ownership of @event. - + %TRUE if the event was sent successfully. + line="3178">%TRUE if the event was sent successfully. a #GstPad to call the default event handler on. + line="3166">a #GstPad to call the default event handler on. allow-none="1"> the parent of @pad or %NULL + line="3167">the parent of @pad or %NULL the #GstEvent to handle. + line="3168">the #GstEvent to handle. @@ -44201,23 +44087,23 @@ takes ownership of @event. Calls @forward for all internally linked pads of @pad. This function deals with + line="3065">Calls @forward for all internally linked pads of @pad. This function deals with dynamically changing internal pads and will make sure that the @forward function is only called once for each pad. When @forward returns %TRUE, no further pads will be processed. - + %TRUE if one of the dispatcher functions returned %TRUE. + line="3077">%TRUE if one of the dispatcher functions returned %TRUE. a #GstPad + line="3067">a #GstPad closure="1"> a #GstPadForwardFunction + line="3068">a #GstPadForwardFunction allow-none="1"> user data passed to @forward + line="3069">user data passed to @forward @@ -44243,17 +44129,17 @@ When @forward returns %TRUE, no further pads will be processed. Gets the capabilities of the allowed media types that can flow through + line="2822">Gets the capabilities of the allowed media types that can flow through @pad and its peer. The allowed capabilities is calculated as the intersection of the results of calling gst_pad_query_caps() on @pad and its peer. The caller owns a reference on the resulting caps. - + the allowed #GstCaps of the + line="2833">the allowed #GstCaps of the pad link. Unref the caps when you no longer need it. This function returns %NULL when @pad has no peer. @@ -44264,7 +44150,7 @@ MT safe. a #GstPad. + line="2824">a #GstPad. @@ -44272,13 +44158,13 @@ MT safe. Gets the capabilities currently configured on @pad with the last + line="2748">Gets the capabilities currently configured on @pad with the last #GST_EVENT_CAPS event. - + the current caps of the pad with + line="2755">the current caps of the pad with incremented ref-count or %NULL when pad has no caps. Unref after usage. @@ -44286,7 +44172,7 @@ incremented ref-count or %NULL when pad has no caps. Unref after usage. a #GstPad to get the current capabilities of. + line="2750">a #GstPad to get the current capabilities of. @@ -44296,14 +44182,14 @@ incremented ref-count or %NULL when pad has no caps. Unref after usage. glib:get-property="direction"> Gets the direction of the pad. The direction of the pad is + line="917">Gets the direction of the pad. The direction of the pad is decided at construction time so this function does not take the LOCK. - + the #GstPadDirection of the pad. + line="925">the #GstPadDirection of the pad. MT safe. @@ -44312,7 +44198,7 @@ MT safe. a #GstPad to get the direction of. + line="919">a #GstPad to get the direction of. @@ -44321,20 +44207,20 @@ MT safe. c:identifier="gst_pad_get_element_private"> Gets the private data of a pad. + line="6179">Gets the private data of a pad. No locking is performed in this function. - + a #gpointer to the private data. + line="6186">a #gpointer to the private data. the #GstPad to get the private data of. + line="6181">the #GstPad to get the private data of. @@ -44344,8 +44230,8 @@ No locking is performed in this function. version="1.4"> Gets the #GstFlowReturn return from the last data passed by this pad. - + line="6614">Gets the #GstFlowReturn return from the last data passed by this pad. + @@ -44353,7 +44239,7 @@ No locking is performed in this function. the #GstPad + line="6616">the #GstPad @@ -44363,20 +44249,20 @@ No locking is performed in this function. glib:get-property="offset"> Get the offset applied to the running time of @pad. @pad has to be a source + line="3982">Get the offset applied to the running time of @pad. @pad has to be a source pad. - + the offset. + line="3989">the offset. a #GstPad + line="3984">a #GstPad @@ -44384,12 +44270,12 @@ pad. Gets the template for @pad. - + line="2700">Gets the template for @pad. + the #GstPadTemplate from which + line="2706">the #GstPadTemplate from which this pad was instantiated, or %NULL if this pad has no template. Unref after usage. @@ -44398,7 +44284,7 @@ pad. a #GstPad. + line="2702">a #GstPad. @@ -44407,12 +44293,12 @@ pad. c:identifier="gst_pad_get_pad_template_caps"> Gets the capabilities for @pad's template. - + line="2775">Gets the capabilities for @pad's template. + the #GstCaps of this pad template. + line="2781">the #GstCaps of this pad template. Unref after usage. @@ -44420,7 +44306,7 @@ Unref after usage. a #GstPad to get the template capabilities from. + line="2777">a #GstPad to get the template capabilities from. @@ -44454,13 +44340,13 @@ MT safe. Gets the peer of @pad. This function refs the peer pad so + line="2795">Gets the peer of @pad. This function refs the peer pad so you need to unref it after use. - + the peer #GstPad. Unref after usage. + line="2802">the peer #GstPad. Unref after usage. MT safe. @@ -44469,7 +44355,7 @@ MT safe. a #GstPad to get the peer of. + line="2797">a #GstPad to get the peer of. @@ -44477,7 +44363,7 @@ MT safe. When @pad is flushing this function returns #GST_FLOW_FLUSHING + line="5096">When @pad is flushing this function returns #GST_FLOW_FLUSHING immediately and @buffer is %NULL. Calls the getrange function of @pad, see #GstPadGetRangeFunction for a @@ -44503,11 +44389,11 @@ When this function returns any other result value than #GST_FLOW_OK, @buffer will be unchanged. This is a lowlevel function. Usually gst_pad_pull_range() is used. - + a #GstFlowReturn from the pad. + line="5131">a #GstFlowReturn from the pad. MT safe. @@ -44516,19 +44402,19 @@ MT safe. a src #GstPad, returns #GST_FLOW_ERROR if not. + line="5098">a src #GstPad, returns #GST_FLOW_ERROR if not. The start offset of the buffer + line="5099">The start offset of the buffer The length of the buffer + line="5100">The length of the buffer transfer-ownership="full"> a pointer to hold the #GstBuffer, + line="5101">a pointer to hold the #GstBuffer, returns #GST_FLOW_ERROR if %NULL. @@ -44548,13 +44434,13 @@ MT safe. version="1.18"> If there is a single internal link of the given pad, this function will + line="2889">If there is a single internal link of the given pad, this function will return it. Otherwise, it will return NULL. - + a #GstPad, or %NULL if @pad has none + line="2896">a #GstPad, or %NULL if @pad has none or more than one internal links. Unref returned pad with gst_object_unref(). @@ -44563,7 +44449,7 @@ gst_object_unref(). the #GstPad to get the internal link of. + line="2891">the #GstPad to get the internal link of. @@ -44571,13 +44457,13 @@ gst_object_unref(). Returns a new reference of the sticky event of type @event_type + line="6194">Returns a new reference of the sticky event of type @event_type from the event. - + a #GstEvent of type + line="6203">a #GstEvent of type @event_type or %NULL when no event of @event_type was on @pad. Unref after usage. @@ -44586,19 +44472,19 @@ from the event. the #GstPad to get the event from. + line="6196">the #GstPad to get the event from. the #GstEventType that should be retrieved. + line="6197">the #GstEventType that should be retrieved. the index of the event + line="6198">the index of the event @@ -44666,20 +44552,20 @@ contents should not be interpreted. version="1.12"> Get @pad task state. If no task is currently + line="6441">Get @pad task state. If no task is currently set, #GST_TASK_STOPPED is returned. - + The current state of @pad's task. + line="6448">The current state of @pad's task. the #GstPad to get task state from + line="6443">the #GstPad to get task state from @@ -44687,19 +44573,19 @@ set, #GST_TASK_STOPPED is returned. Check if @pad has caps set on it with a #GST_EVENT_CAPS event. - + line="2722">Check if @pad has caps set on it with a #GST_EVENT_CAPS event. + %TRUE when @pad has caps associated with it. + line="2728">%TRUE when @pad has caps associated with it. a #GstPad to check + line="2724">a #GstPad to check @@ -44707,12 +44593,12 @@ set, #GST_TASK_STOPPED is returned. Query if a pad is active - + line="1350">Query if a pad is active + %TRUE if the pad is active. + line="1356">%TRUE if the pad is active. MT safe. @@ -44721,7 +44607,7 @@ MT safe. the #GstPad to query + line="1352">the #GstPad to query @@ -44729,14 +44615,14 @@ MT safe. Checks if the pad is blocked or not. This function returns the + line="1591">Checks if the pad is blocked or not. This function returns the last requested state of the pad. It is not certain that the pad is actually blocking at this point (see gst_pad_is_blocking()). - + %TRUE if the pad is blocked. + line="1599">%TRUE if the pad is blocked. MT safe. @@ -44745,7 +44631,7 @@ MT safe. the #GstPad to query + line="1593">the #GstPad to query @@ -44753,13 +44639,13 @@ MT safe. Checks if the pad is blocking or not. This is a guaranteed state + line="1617">Checks if the pad is blocking or not. This is a guaranteed state of whether the pad is actually blocking on a #GstBuffer or a #GstEvent. - + %TRUE if the pad is blocking. + line="1624">%TRUE if the pad is blocking. MT safe. @@ -44768,7 +44654,7 @@ MT safe. the #GstPad to query + line="1619">the #GstPad to query @@ -44776,12 +44662,12 @@ MT safe. Checks if a @pad is linked to another pad or not. - + line="2226">Checks if a @pad is linked to another pad or not. + %TRUE if the pad is linked, %FALSE otherwise. + line="2232">%TRUE if the pad is linked, %FALSE otherwise. MT safe. @@ -44790,7 +44676,7 @@ MT safe. pad to check + line="2228">pad to check @@ -44799,18 +44685,18 @@ MT safe. c:identifier="gst_pad_iterate_internal_links"> Gets an iterator for the pads to which the given pad is linked to inside + line="3021">Gets an iterator for the pads to which the given pad is linked to inside of the parent element. Each #GstPad element yielded by the iterator will have its refcount increased, so unref after use. Free-function: gst_iterator_free - + a new #GstIterator of #GstPad + line="3033">a new #GstIterator of #GstPad or %NULL when the pad does not have an iterator function configured. Use gst_iterator_free() after usage. @@ -44819,7 +44705,7 @@ Free-function: gst_iterator_free the GstPad to get the internal links of. + line="3023">the GstPad to get the internal links of. @@ -44828,17 +44714,17 @@ Free-function: gst_iterator_free c:identifier="gst_pad_iterate_internal_links_default"> Iterate the list of pads to which the given pad is linked to inside of + line="2955">Iterate the list of pads to which the given pad is linked to inside of the parent element. This is the default handler, and thus returns an iterator of all of the pads inside the parent element with opposite direction. The caller must free this iterator after use with gst_iterator_free(). - + a #GstIterator of #GstPad, or %NULL if @pad + line="2967">a #GstIterator of #GstPad, or %NULL if @pad has no parent. Unref each returned pad with gst_object_unref(). @@ -44846,7 +44732,7 @@ has no parent. Unref each returned pad with gst_object_unref(). the #GstPad to get the internal links of. + line="2957">the #GstPad to get the internal links of. allow-none="1"> the parent of @pad or %NULL + line="2958">the parent of @pad or %NULL @@ -44863,12 +44749,12 @@ has no parent. Unref each returned pad with gst_object_unref(). Links the source pad and the sink pad. - + line="2666">Links the source pad and the sink pad. + A result code indicating if the connection worked or + line="2673">A result code indicating if the connection worked or what went wrong. MT Safe. @@ -44878,13 +44764,13 @@ MT Safe. the source #GstPad to link. + line="2668">the source #GstPad to link. the sink #GstPad to link. + line="2669">the sink #GstPad to link. @@ -44892,7 +44778,7 @@ MT Safe. Links the source pad and the sink pad. + line="2513">Links the source pad and the sink pad. This variant of #gst_pad_link provides a more granular control on the checks being done when linking. While providing some considerable speedups @@ -44901,11 +44787,11 @@ can cause severe issues. Refer to the documentation of #GstPadLinkCheck for more information. MT Safe. - + A result code indicating if the connection worked or + line="2529">A result code indicating if the connection worked or what went wrong. @@ -44913,19 +44799,19 @@ MT Safe. the source #GstPad to link. + line="2515">the source #GstPad to link. the sink #GstPad to link. + line="2516">the sink #GstPad to link. the checks to validate when linking + line="2517">the checks to validate when linking @@ -45011,9 +44897,9 @@ pads with safety checks applied. Mark a pad for needing reconfiguration. The next call to + line="1694">Mark a pad for needing reconfiguration. The next call to gst_pad_check_reconfigure() will return %TRUE after this call. - + @@ -45021,7 +44907,7 @@ gst_pad_check_reconfigure() will return %TRUE after this call. the #GstPad to mark + line="1696">the #GstPad to mark @@ -45030,20 +44916,20 @@ gst_pad_check_reconfigure() will return %TRUE after this call. c:identifier="gst_pad_needs_reconfigure"> Check the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE + line="1643">Check the #GST_PAD_FLAG_NEED_RECONFIGURE flag on @pad and return %TRUE if the flag was set. - + %TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag is set on @pad. + line="1650">%TRUE is the GST_PAD_FLAG_NEED_RECONFIGURE flag is set on @pad. the #GstPad to check + line="1645">the #GstPad to check @@ -45051,14 +44937,14 @@ if the flag was set. Pause the task of @pad. This function will also wait until the + line="6395">Pause the task of @pad. This function will also wait until the function executed by the task is finished if this function is not called from the task function. - + a %TRUE if the task could be paused or %FALSE when the pad + line="6403">a %TRUE if the task could be paused or %FALSE when the pad has no task. @@ -45066,7 +44952,7 @@ has no task. the #GstPad to pause the task of + line="6397">the #GstPad to pause the task of @@ -45074,15 +44960,15 @@ has no task. Performs gst_pad_query() on the peer of @pad. + line="4306">Performs gst_pad_query() on the peer of @pad. The caller is responsible for both the allocation and deallocation of the query structure. - + %TRUE if the query could be performed. This function returns %FALSE + line="4316">%TRUE if the query could be performed. This function returns %FALSE if @pad has no peer. @@ -45090,13 +44976,13 @@ if @pad has no peer. a #GstPad to invoke the peer query on. + line="4308">a #GstPad to invoke the peer query on. the #GstQuery to perform. + line="4309">the #GstQuery to perform. @@ -45363,7 +45249,7 @@ the same caps. Two such elements are tee and adder. Pulls a @buffer from the peer pad or fills up a provided buffer. + line="5148">Pulls a @buffer from the peer pad or fills up a provided buffer. This function will first trigger the pad block signal if it was installed. @@ -45388,11 +45274,11 @@ accordingly. Note that less than @size bytes can be returned in @buffer when, for example, an EOS condition is near or when @buffer is not large enough to hold @size bytes. The caller should check the result buffer size to get the result size. - + a #GstFlowReturn from the peer pad. + line="5182">a #GstFlowReturn from the peer pad. MT safe. @@ -45401,19 +45287,19 @@ MT safe. a sink #GstPad, returns GST_FLOW_ERROR if not. + line="5150">a sink #GstPad, returns GST_FLOW_ERROR if not. The start offset of the buffer + line="5151">The start offset of the buffer The length of the buffer + line="5152">The length of the buffer transfer-ownership="full"> a pointer to hold the #GstBuffer, returns + line="5153">a pointer to hold the #GstBuffer, returns GST_FLOW_ERROR if %NULL. @@ -45431,7 +45317,7 @@ MT safe. Pushes a buffer to the peer of @pad. + line="4857">Pushes a buffer to the peer of @pad. This function will call installed block probes before triggering any installed data probes. @@ -45442,11 +45328,11 @@ be returned. In all cases, success or failure, the caller loses its reference to @buffer after calling this function. - + a #GstFlowReturn from the peer pad. + line="4875">a #GstFlowReturn from the peer pad. MT safe. @@ -45455,13 +45341,13 @@ MT safe. a source #GstPad, returns #GST_FLOW_ERROR if not. + line="4859">a source #GstPad, returns #GST_FLOW_ERROR if not. the #GstBuffer to push returns GST_FLOW_ERROR + line="4860">the #GstBuffer to push returns GST_FLOW_ERROR if not. @@ -45470,17 +45356,17 @@ MT safe. Sends the event to the peer of the given pad. This function is + line="5675">Sends the event to the peer of the given pad. This function is mainly used by elements to send events to their peer elements. This function takes ownership of the provided event so you should gst_event_ref() it if you want to reuse the event after this call. - + %TRUE if the event was handled. + line="5687">%TRUE if the event was handled. MT safe. @@ -45489,13 +45375,13 @@ MT safe. a #GstPad to push the event to. + line="5677">a #GstPad to push the event to. the #GstEvent to send to the pad. + line="5678">the #GstEvent to send to the pad. @@ -45503,7 +45389,7 @@ MT safe. Pushes a buffer list to the peer of @pad. + line="4895">Pushes a buffer list to the peer of @pad. This function will call installed block probes before triggering any installed data probes. @@ -45516,11 +45402,11 @@ chained via gst_pad_chain(). In all cases, success or failure, the caller loses its reference to @list after calling this function. - + a #GstFlowReturn from the peer pad. + line="4915">a #GstFlowReturn from the peer pad. MT safe. @@ -45529,13 +45415,13 @@ MT safe. a source #GstPad, returns #GST_FLOW_ERROR if not. + line="4897">a source #GstPad, returns #GST_FLOW_ERROR if not. the #GstBufferList to push returns GST_FLOW_ERROR + line="4898">the #GstBufferList to push returns GST_FLOW_ERROR if not. @@ -45544,7 +45430,7 @@ MT safe. Dispatches a query to a pad. The query should have been allocated by the + line="4168">Dispatches a query to a pad. The query should have been allocated by the caller via one of the type-specific allocation functions. The element that the pad belongs to is responsible for filling the query with an appropriate response, which should then be parsed with a type-specific query parsing @@ -45554,24 +45440,24 @@ Again, the caller is responsible for both the allocation and deallocation of the query structure. Please also note that some queries might need a running pipeline to work. - + %TRUE if the query could be performed. + line="4184">%TRUE if the query could be performed. a #GstPad to invoke the default query on. + line="4170">a #GstPad to invoke the default query on. the #GstQuery to perform. + line="4171">the #GstQuery to perform. @@ -45696,23 +45582,23 @@ gst_caps_make_writable() before modifying the caps. Invokes the default query handler for the given pad. + line="3492">Invokes the default query handler for the given pad. The query is sent to all pads internally linked to @pad. Note that if there are many possible sink pads that are internally linked to @pad, only one will be sent the query. Multi-sinkpad elements should implement custom query handlers. - + %TRUE if the query was performed successfully. + line="3504">%TRUE if the query was performed successfully. a #GstPad to call the default query handler on. + line="3494">a #GstPad to call the default query handler on. allow-none="1"> the parent of @pad or %NULL + line="3495">the parent of @pad or %NULL the #GstQuery to handle. + line="3496">the #GstQuery to handle. @@ -45810,10 +45696,10 @@ Multi-sinkpad elements should implement custom query handlers. Remove the probe with @id from @pad. + line="1554">Remove the probe with @id from @pad. MT safe. - + @@ -45821,13 +45707,13 @@ MT safe. the #GstPad with the probe + line="1556">the #GstPad with the probe the probe id to remove + line="1557">the probe id to remove @@ -45835,7 +45721,7 @@ MT safe. Sends the event to the pad. This function can be used + line="6093">Sends the event to the pad. This function can be used by applications to send events in the pipeline. If @pad is a source pad, @event should be an upstream event. If @pad is a @@ -45855,24 +45741,24 @@ all necessary locks and checks. This function takes ownership of the provided event so you should gst_event_ref() it if you want to reuse the event after this call. - + %TRUE if the event was handled. + line="6119">%TRUE if the event was handled. a #GstPad to send the event to. + line="6095">a #GstPad to send the event to. the #GstEvent to send to the pad. + line="6096">the #GstEvent to send to the pad. @@ -45881,12 +45767,12 @@ gst_event_ref() it if you want to reuse the event after this call. c:identifier="gst_pad_set_activate_function_full"> Sets the given activate function for @pad. The activate function will + line="1719">Sets the given activate function for @pad. The activate function will dispatch to gst_pad_activate_mode() to perform the actual activation. Only makes sense to set on sink pads. Call this function if your sink pad can start a pull-based task. - + @@ -45894,7 +45780,7 @@ Call this function if your sink pad can start a pull-based task. a #GstPad. + line="1721">a #GstPad. destroy="2"> the #GstPadActivateFunction to set. + line="1722">the #GstPadActivateFunction to set. allow-none="1"> user_data passed to @notify + line="1723">user_data passed to @notify notify called when @activate will not be used anymore. + line="1724">notify called when @activate will not be used anymore. @@ -45928,9 +45814,9 @@ Call this function if your sink pad can start a pull-based task. c:identifier="gst_pad_set_activatemode_function_full"> Sets the given activate_mode function for the pad. An activate_mode function + line="1756">Sets the given activate_mode function for the pad. An activate_mode function prepares the element for data passing. - + @@ -45938,7 +45824,7 @@ prepares the element for data passing. a #GstPad. + line="1758">a #GstPad. destroy="2"> the #GstPadActivateModeFunction to set. + line="1759">the #GstPadActivateModeFunction to set. @@ -45958,13 +45844,13 @@ prepares the element for data passing. allow-none="1"> user_data passed to @notify + line="1760">user_data passed to @notify notify called when @activatemode will not be used anymore. + line="1761">notify called when @activatemode will not be used anymore. @@ -45972,7 +45858,7 @@ prepares the element for data passing. Activates or deactivates the given pad. + line="1071">Activates or deactivates the given pad. Normally called from within core state change functions. If @active, makes sure the pad is active. If it is already active, either in @@ -45981,11 +45867,11 @@ function to perform the actual activation. If not @active, calls gst_pad_activate_mode() with the pad's current mode and a %FALSE argument. - + %TRUE if the operation was successful. + line="1086">%TRUE if the operation was successful. MT safe. @@ -45994,13 +45880,13 @@ MT safe. the #GstPad to activate or deactivate. + line="1073">the #GstPad to activate or deactivate. whether or not the pad should be active. + line="1074">whether or not the pad should be active. @@ -46009,9 +45895,9 @@ MT safe. c:identifier="gst_pad_set_chain_function_full"> Sets the given chain function for the pad. The chain function is called to + line="1791">Sets the given chain function for the pad. The chain function is called to process a #GstBuffer input buffer. see #GstPadChainFunction for more details. - + @@ -46019,7 +45905,7 @@ process a #GstBuffer input buffer. see #GstPadChainFunction for more details. a sink #GstPad. + line="1793">a sink #GstPad. the #GstPadChainFunction to set. + line="1794">the #GstPadChainFunction to set. user_data passed to @notify + line="1795">user_data passed to @notify notify called when @chain will not be used anymore. + line="1796">notify called when @chain will not be used anymore. @@ -46053,10 +45939,10 @@ process a #GstBuffer input buffer. see #GstPadChainFunction for more details. Sets the given chain list function for the pad. The chainlist function is + line="1826">Sets the given chain list function for the pad. The chainlist function is called to process a #GstBufferList input buffer list. See #GstPadChainListFunction for more details. - + @@ -46064,7 +45950,7 @@ called to process a #GstBufferList input buffer list. See a sink #GstPad. + line="1828">a sink #GstPad. the #GstPadChainListFunction to set. + line="1829">the #GstPadChainListFunction to set. @@ -46084,13 +45970,13 @@ called to process a #GstBufferList input buffer list. See allow-none="1"> user_data passed to @notify + line="1830">user_data passed to @notify notify called when @chainlist will not be used anymore. + line="1831">notify called when @chainlist will not be used anymore. @@ -46099,10 +45985,10 @@ called to process a #GstBufferList input buffer list. See c:identifier="gst_pad_set_element_private"> Set the given private data gpointer on the pad. + line="6164">Set the given private data gpointer on the pad. This function can only be used by the element that owns the pad. No locking is performed in this function. - + @@ -46110,7 +45996,7 @@ No locking is performed in this function. the #GstPad to set the private data of. + line="6166">the #GstPad to set the private data of. allow-none="1"> The private data to attach to the pad. + line="6167">The private data to attach to the pad. @@ -46129,8 +46015,8 @@ No locking is performed in this function. version="1.8"> Sets the given event handler for the pad. - + line="1943">Sets the given event handler for the pad. + @@ -46138,7 +46024,7 @@ No locking is performed in this function. a #GstPad of either direction. + line="1945">a #GstPad of either direction. destroy="2"> the #GstPadEventFullFunction to set. + line="1946">the #GstPadEventFullFunction to set. @@ -46158,13 +46044,13 @@ No locking is performed in this function. allow-none="1"> user_data passed to @notify + line="1947">user_data passed to @notify notify called when @event will not be used anymore. + line="1948">notify called when @event will not be used anymore. @@ -46173,8 +46059,8 @@ No locking is performed in this function. c:identifier="gst_pad_set_event_function_full"> Sets the given event handler for the pad. - + line="1899">Sets the given event handler for the pad. + @@ -46182,7 +46068,7 @@ No locking is performed in this function. a #GstPad of either direction. + line="1901">a #GstPad of either direction. destroy="2"> the #GstPadEventFunction to set. + line="1902">the #GstPadEventFunction to set. allow-none="1"> user_data passed to @notify + line="1903">user_data passed to @notify notify called when @event will not be used anymore. + line="1904">notify called when @event will not be used anymore. @@ -46216,10 +46102,10 @@ No locking is performed in this function. c:identifier="gst_pad_set_getrange_function_full"> Sets the given getrange function for the pad. The getrange function is + line="1863">Sets the given getrange function for the pad. The getrange function is called to produce a new #GstBuffer to start the processing pipeline. see #GstPadGetRangeFunction for a description of the getrange function. - + @@ -46227,7 +46113,7 @@ called to produce a new #GstBuffer to start the processing pipeline. see a source #GstPad. + line="1865">a source #GstPad. the #GstPadGetRangeFunction to set. + line="1866">the #GstPadGetRangeFunction to set. user_data passed to @notify + line="1867">user_data passed to @notify notify called when @get will not be used anymore. + line="1868">notify called when @get will not be used anymore. @@ -46261,8 +46147,8 @@ called to produce a new #GstBuffer to start the processing pipeline. see c:identifier="gst_pad_set_iterate_internal_links_function_full"> Sets the given internal link iterator function for the pad. - + line="2012">Sets the given internal link iterator function for the pad. + @@ -46270,7 +46156,7 @@ called to produce a new #GstBuffer to start the processing pipeline. see a #GstPad of either direction. + line="2014">a #GstPad of either direction. the #GstPadIterIntLinkFunction to set. + line="2015">the #GstPadIterIntLinkFunction to set. @@ -46290,13 +46176,13 @@ called to produce a new #GstBuffer to start the processing pipeline. see allow-none="1"> user_data passed to @notify + line="2016">user_data passed to @notify notify called when @iterintlink will not be used anymore. + line="2017">notify called when @iterintlink will not be used anymore. @@ -46305,7 +46191,7 @@ called to produce a new #GstBuffer to start the processing pipeline. see c:identifier="gst_pad_set_link_function_full"> Sets the given link function for the pad. It will be called when + line="2046">Sets the given link function for the pad. It will be called when the pad is linked with another pad. The return value #GST_PAD_LINK_OK should be used when the connection can be @@ -46316,7 +46202,7 @@ cannot be made for some reason. If @link is installed on a source pad, it should call the #GstPadLinkFunction of the peer sink pad, if present. - + @@ -46324,7 +46210,7 @@ of the peer sink pad, if present. a #GstPad. + line="2048">a #GstPad. destroy="2"> the #GstPadLinkFunction to set. + line="2049">the #GstPadLinkFunction to set. allow-none="1"> user_data passed to @notify + line="2050">user_data passed to @notify notify called when @link will not be used anymore. + line="2051">notify called when @link will not be used anymore. @@ -46359,8 +46245,8 @@ of the peer sink pad, if present. glib:set-property="offset"> Set the offset that will be applied to the running time of @pad. - + line="4012">Set the offset that will be applied to the running time of @pad. + @@ -46368,13 +46254,13 @@ of the peer sink pad, if present. a #GstPad + line="4014">a #GstPad the offset + line="4015">the offset @@ -46383,8 +46269,8 @@ of the peer sink pad, if present. c:identifier="gst_pad_set_query_function_full"> Set the given query function for the pad. - + line="1979">Set the given query function for the pad. + @@ -46392,7 +46278,7 @@ of the peer sink pad, if present. a #GstPad of either direction. + line="1981">a #GstPad of either direction. destroy="2"> the #GstPadQueryFunction to set. + line="1982">the #GstPadQueryFunction to set. allow-none="1"> user_data passed to @notify + line="1983">user_data passed to @notify notify called when @query will not be used anymore. + line="1984">notify called when @query will not be used anymore. @@ -46426,13 +46312,13 @@ of the peer sink pad, if present. c:identifier="gst_pad_set_unlink_function_full"> Sets the given unlink function for the pad. It will be called + line="2089">Sets the given unlink function for the pad. It will be called when the pad is unlinked. Note that the pad's lock is already held when the unlink function is called, so most pad functions cannot be called from within the callback. - + @@ -46440,7 +46326,7 @@ from within the callback. a #GstPad. + line="2091">a #GstPad. destroy="2"> the #GstPadUnlinkFunction to set. + line="2092">the #GstPadUnlinkFunction to set. allow-none="1"> user_data passed to @notify + line="2093">user_data passed to @notify notify called when @unlink will not be used anymore. + line="2094">notify called when @unlink will not be used anymore. @@ -46473,22 +46359,22 @@ from within the callback. Starts a task that repeatedly calls @func with @user_data. This function + line="6329">Starts a task that repeatedly calls @func with @user_data. This function is mostly used in pad activation functions to start the dataflow. The #GST_PAD_STREAM_LOCK of @pad will automatically be acquired before @func is called. - + a %TRUE if the task could be started. + line="6341">a %TRUE if the task could be started. the #GstPad to start the task of + line="6331">the #GstPad to start the task of destroy="2"> the task function to call + line="6332">the task function to call allow-none="1"> user data passed to the task function + line="6333">user data passed to the task function called when @user_data is no longer referenced + line="6334">called when @user_data is no longer referenced @@ -46522,9 +46408,9 @@ before @func is called. c:identifier="gst_pad_sticky_events_foreach"> Iterates all sticky events on @pad and calls @foreach_func for every + line="6248">Iterates all sticky events on @pad and calls @foreach_func for every event. If @foreach_func returns %FALSE the iteration is immediately stopped. - + @@ -46532,7 +46418,7 @@ event. If @foreach_func returns %FALSE the iteration is immediately stopped. the #GstPad that should be used for iteration. + line="6250">the #GstPad that should be used for iteration. the #GstPadStickyEventsForeachFunction that + line="6251">the #GstPadStickyEventsForeachFunction that should be called for every event. @@ -46552,7 +46438,7 @@ event. If @foreach_func returns %FALSE the iteration is immediately stopped. the optional user data. + line="6253">the optional user data. @@ -46560,7 +46446,7 @@ event. If @foreach_func returns %FALSE the iteration is immediately stopped. Stop the task of @pad. This function will also make sure that the + line="6477">Stop the task of @pad. This function will also make sure that the function executed by the task will effectively stop if not called from the GstTaskFunction. @@ -46569,18 +46455,18 @@ the task. Use gst_task_pause() instead. Regardless of whether the pad has a task, the stream lock is acquired and released so as to ensure that streaming through this pad has finished. - + a %TRUE if the task could be stopped or %FALSE on error. + line="6491">a %TRUE if the task could be stopped or %FALSE on error. the #GstPad to stop the task of + line="6479">the #GstPad to stop the task of @@ -46590,12 +46476,12 @@ released so as to ensure that streaming through this pad has finished. version="1.2"> Store the sticky @event on @pad - + line="5453">Store the sticky @event on @pad + #GST_FLOW_OK on success, #GST_FLOW_FLUSHING when the pad + line="5460">#GST_FLOW_OK on success, #GST_FLOW_FLUSHING when the pad was flushing or #GST_FLOW_EOS when the pad was EOS. @@ -46603,13 +46489,13 @@ was flushing or #GST_FLOW_EOS when the pad was EOS. a #GstPad + line="5455">a #GstPad a #GstEvent + line="5456">a #GstEvent @@ -46617,13 +46503,13 @@ was flushing or #GST_FLOW_EOS when the pad was EOS. Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked + line="2119">Unlinks the source pad from the sink pad. Will emit the #GstPad::unlinked signal on both pads. - + %TRUE if the pads were unlinked. This function returns %FALSE if + line="2127">%TRUE if the pads were unlinked. This function returns %FALSE if the pads were not linked together. MT safe. @@ -46633,13 +46519,13 @@ MT safe. the source #GstPad to unlink. + line="2121">the source #GstPad to unlink. the sink #GstPad to unlink. + line="2122">the sink #GstPad to unlink. @@ -47728,19 +47614,19 @@ pad operates in push or pull mode. Return the name of a pad mode, for use in debug messages mostly. + line="951">Return the name of a pad mode, for use in debug messages mostly. short mnemonic for pad mode @mode + line="957">short mnemonic for pad mode @mode the pad mode + line="953">the pad mode @@ -47881,14 +47767,14 @@ The callback is allowed to modify the data pointer in @info. The #GstBuffer from the probe + line="6588">The #GstBuffer from the probe a #GstPadProbeInfo + line="6586">a #GstPadProbeInfo @@ -47899,14 +47785,14 @@ The callback is allowed to modify the data pointer in @info. The #GstBufferList from the probe + line="6603">The #GstBufferList from the probe a #GstPadProbeInfo + line="6601">a #GstPadProbeInfo @@ -47916,14 +47802,14 @@ The callback is allowed to modify the data pointer in @info. The #GstEvent from the probe + line="6555">The #GstEvent from the probe a #GstPadProbeInfo + line="6553">a #GstPadProbeInfo @@ -47933,14 +47819,14 @@ The callback is allowed to modify the data pointer in @info. The #GstQuery from the probe + line="6572">The #GstQuery from the probe a #GstPadProbeInfo + line="6570">a #GstPadProbeInfo @@ -49226,12 +49112,12 @@ gst_element_set_start_time() method. Create a new pipeline with the given name. + line="337">Create a new pipeline with the given name. newly created GstPipeline + line="343">newly created GstPipeline MT safe. @@ -49243,7 +49129,7 @@ MT safe. allow-none="1"> name of new pipeline + line="339">name of new pipeline @@ -49251,7 +49137,7 @@ MT safe. Let @pipeline select a clock automatically. This is the default + line="906">Let @pipeline select a clock automatically. This is the default behaviour. Use this function if you previous forced a fixed clock with @@ -49267,7 +49153,7 @@ MT safe. a #GstPipeline + line="908">a #GstPipeline @@ -49277,13 +49163,13 @@ MT safe. glib:get-property="auto-flush-bus"> Check if @pipeline will automatically flush messages when going to + line="1019">Check if @pipeline will automatically flush messages when going to the NULL state. whether the pipeline will automatically flush its bus when + line="1026">whether the pipeline will automatically flush its bus when going from READY to NULL state or not. MT safe. @@ -49293,7 +49179,7 @@ MT safe. a #GstPipeline + line="1021">a #GstPipeline @@ -49301,13 +49187,13 @@ MT safe. Gets the #GstBus of @pipeline. The bus allows applications to receive + line="756">Gets the #GstBus of @pipeline. The bus allows applications to receive #GstMessage packets. a #GstBus, unref after usage. + line="763">a #GstBus, unref after usage. MT safe. @@ -49316,7 +49202,7 @@ MT safe. a #GstPipeline + line="758">a #GstPipeline @@ -49326,7 +49212,7 @@ MT safe. introspectable="0"> Gets the current clock used by @pipeline. Users of object + line="809">Gets the current clock used by @pipeline. Users of object oriented languages should use gst_pipeline_get_pipeline_clock() to avoid confusion with gst_element_get_clock() which has a different behavior. @@ -49336,14 +49222,39 @@ clock, even if the pipeline is not in the PLAYING state. a #GstClock, unref after usage. + line="820">a #GstClock, unref after usage. a #GstPipeline + line="811">a #GstPipeline + + + + + + Return the configured latency on @pipeline. + + + @pipeline configured latency, or %GST_CLOCK_TIME_NONE if none has been configured +because @pipeline did not reach the PLAYING state yet. + +MT safe. + + + + + a #GstPipeline @@ -49353,12 +49264,12 @@ clock, even if the pipeline is not in the PLAYING state. glib:get-property="delay"> Get the configured delay (see gst_pipeline_set_delay()). + line="964">Get the configured delay (see gst_pipeline_set_delay()). The configured delay. + line="970">The configured delay. MT safe. @@ -49367,7 +49278,7 @@ MT safe. a #GstPipeline + line="966">a #GstPipeline @@ -49378,20 +49289,20 @@ MT safe. version="1.6"> Gets the latency that should be configured on the pipeline. See + line="1076">Gets the latency that should be configured on the pipeline. See gst_pipeline_set_latency(). Latency to configure on the pipeline or GST_CLOCK_TIME_NONE + line="1083">Latency to configure on the pipeline or GST_CLOCK_TIME_NONE a #GstPipeline + line="1078">a #GstPipeline @@ -49401,7 +49312,7 @@ gst_pipeline_set_latency(). version="1.6"> Gets the current clock used by @pipeline. + line="828">Gets the current clock used by @pipeline. Unlike gst_element_get_clock(), this function will always return a clock, even if the pipeline is not in the PLAYING state. @@ -49409,14 +49320,38 @@ clock, even if the pipeline is not in the PLAYING state. a #GstClock, unref after usage. + line="837">a #GstClock, unref after usage. a #GstPipeline + line="830">a #GstPipeline + + + + + + Check if @pipeline is live. + + + %TRUE if @pipeline is live, %FALSE if not or if it did not reach the PAUSED state yet. + +MT safe. + + + + + a #GstPipeline @@ -49426,7 +49361,7 @@ clock, even if the pipeline is not in the PLAYING state. glib:set-property="auto-flush-bus"> Usually, when a pipeline goes from READY to NULL state, it automatically + line="988">Usually, when a pipeline goes from READY to NULL state, it automatically flushes all pending messages on the bus, which is done for refcounting purposes, to break circular references. @@ -49448,13 +49383,13 @@ MT safe. a #GstPipeline + line="990">a #GstPipeline whether or not to automatically flush the bus when + line="991">whether or not to automatically flush the bus when the pipeline goes from READY to NULL state @@ -49465,13 +49400,13 @@ the pipeline goes from READY to NULL state introspectable="0"> Set the clock for @pipeline. The clock will be distributed + line="882">Set the clock for @pipeline. The clock will be distributed to all the elements managed by the pipeline. %TRUE if the clock could be set on the pipeline. %FALSE if + line="890">%TRUE if the clock could be set on the pipeline. %FALSE if some element did not accept the clock. MT safe. @@ -49481,7 +49416,7 @@ MT safe. a #GstPipeline + line="884">a #GstPipeline allow-none="1"> the clock to set + line="885">the clock to set @@ -49500,7 +49435,7 @@ MT safe. glib:set-property="delay"> Set the expected delay needed for all elements to perform the + line="937">Set the expected delay needed for all elements to perform the PAUSED to PLAYING state change. @delay will be added to the base time of the elements so that they wait an additional @delay amount of time before starting to process buffers and cannot be @@ -49518,13 +49453,13 @@ MT safe. a #GstPipeline + line="939">a #GstPipeline the delay + line="940">the delay @@ -49535,7 +49470,7 @@ MT safe. version="1.6"> Sets the latency that should be configured on the pipeline. Setting + line="1045">Sets the latency that should be configured on the pipeline. Setting GST_CLOCK_TIME_NONE will restore the default behaviour of using the minimum latency from the LATENCY query. Setting this is usually not required and the pipeline will figure out an appropriate latency automatically. @@ -49550,13 +49485,13 @@ the LATENCY query, will most likely cause the pipeline to fail. a #GstPipeline + line="1047">a #GstPipeline latency to configure + line="1048">latency to configure @@ -49564,7 +49499,7 @@ the LATENCY query, will most likely cause the pipeline to fail. Force @pipeline to use the given @clock. The pipeline will + line="850">Force @pipeline to use the given @clock. The pipeline will always use the given clock even if new clock providers are added to this pipeline. @@ -49580,7 +49515,7 @@ MT safe. a #GstPipeline + line="852">a #GstPipeline allow-none="1"> the clock to use + line="853">the clock to use @@ -49602,7 +49537,7 @@ MT safe. default-value="TRUE"> Whether or not to automatically flush all messages on the + line="184">Whether or not to automatically flush all messages on the pipeline's bus when going from READY to NULL state. Please see gst_pipeline_set_auto_flush_bus() for more information on this option. @@ -49615,7 +49550,7 @@ gst_pipeline_set_auto_flush_bus() for more information on this option. default-value="0"> The expected delay needed for elements to spin up to the + line="171">The expected delay needed for elements to spin up to the PLAYING state expressed in nanoseconds. see gst_pipeline_set_delay() for more information on this option. @@ -49629,7 +49564,7 @@ see gst_pipeline_set_delay() for more information on this option. default-value="18446744073709551615"> Latency to configure on the pipeline. See gst_pipeline_set_latency(). + line="197">Latency to configure on the pipeline. See gst_pipeline_set_latency(). @@ -49744,8 +49679,8 @@ into memory. Unrefs each member of @list, then frees the list. - + line="1489">Unrefs each member of @list, then frees the list. + @@ -49753,7 +49688,7 @@ into memory. list of #GstPlugin + line="1491">list of #GstPlugin @@ -49763,12 +49698,12 @@ into memory. Load the named plugin. Refs the plugin. + line="1408">Load the named plugin. Refs the plugin. a reference to a loaded plugin, or + line="1414">a reference to a loaded plugin, or %NULL on error. @@ -49776,7 +49711,7 @@ into memory. name of plugin to load + line="1410">name of plugin to load @@ -49786,12 +49721,12 @@ into memory. throws="1"> Loads the given plugin and refs it. Caller needs to unref after use. + line="684">Loads the given plugin and refs it. Caller needs to unref after use. a reference to the existing loaded GstPlugin, a + line="691">a reference to the existing loaded GstPlugin, a reference to the newly-loaded GstPlugin, or %NULL if an error occurred. @@ -49799,7 +49734,7 @@ reference to the newly-loaded GstPlugin, or %NULL if an error occurred. the plugin filename to load + line="686">the plugin filename to load @@ -49808,7 +49743,7 @@ reference to the newly-loaded GstPlugin, or %NULL if an error occurred. c:identifier="gst_plugin_register_static"> Registers a static plugin, ie. a plugin which is private to an application + line="182">Registers a static plugin, ie. a plugin which is private to an application or library and contained within the application or library (as opposed to being shipped as a separate module file). @@ -49818,28 +49753,28 @@ via gst_init_get_option_group()) before calling this function. %TRUE if the plugin was registered correctly, otherwise %FALSE. + line="207">%TRUE if the plugin was registered correctly, otherwise %FALSE. the major version number of the GStreamer core that the + line="184">the major version number of the GStreamer core that the plugin was compiled for, you can just use GST_VERSION_MAJOR here the minor version number of the GStreamer core that the + line="186">the minor version number of the GStreamer core that the plugin was compiled for, you can just use GST_VERSION_MINOR here a unique name of the plugin (ideally prefixed with an application- or + line="188">a unique name of the plugin (ideally prefixed with an application- or library-specific namespace prefix in order to avoid name conflicts in case a similar plugin with the same name ever gets added to GStreamer) @@ -49847,44 +49782,44 @@ via gst_init_get_option_group()) before calling this function. description of the plugin + line="191">description of the plugin pointer to the init function of this plugin. + line="192">pointer to the init function of this plugin. version string of the plugin + line="193">version string of the plugin effective license of plugin. Must be one of the approved licenses + line="194">effective license of plugin. Must be one of the approved licenses (see #GstPluginDesc above) or the plugin will not be registered. source module plugin belongs to + line="196">source module plugin belongs to shipped package plugin belongs to + line="197">shipped package plugin belongs to URL to provider of plugin + line="198">URL to provider of plugin @@ -49893,7 +49828,7 @@ via gst_init_get_option_group()) before calling this function. c:identifier="gst_plugin_register_static_full"> Registers a static plugin, ie. a plugin which is private to an application + line="243">Registers a static plugin, ie. a plugin which is private to an application or library and contained within the application or library (as opposed to being shipped as a separate module file) with a #GstPluginInitFullFunc which allows user data to be passed to the callback function (useful @@ -49905,28 +49840,28 @@ via gst_init_get_option_group()) before calling this function. %TRUE if the plugin was registered correctly, otherwise %FALSE. + line="272">%TRUE if the plugin was registered correctly, otherwise %FALSE. the major version number of the GStreamer core that the + line="245">the major version number of the GStreamer core that the plugin was compiled for, you can just use GST_VERSION_MAJOR here the minor version number of the GStreamer core that the + line="247">the minor version number of the GStreamer core that the plugin was compiled for, you can just use GST_VERSION_MINOR here a unique name of the plugin (ideally prefixed with an application- or + line="249">a unique name of the plugin (ideally prefixed with an application- or library-specific namespace prefix in order to avoid name conflicts in case a similar plugin with the same name ever gets added to GStreamer) @@ -49934,7 +49869,7 @@ via gst_init_get_option_group()) before calling this function. description of the plugin + line="252">description of the plugin closure="10"> pointer to the init function with user data + line="253">pointer to the init function with user data of this plugin. version string of the plugin + line="255">version string of the plugin effective license of plugin. Must be one of the approved licenses + line="256">effective license of plugin. Must be one of the approved licenses (see #GstPluginDesc above) or the plugin will not be registered. source module plugin belongs to + line="258">source module plugin belongs to shipped package plugin belongs to + line="259">shipped package plugin belongs to URL to provider of plugin + line="260">URL to provider of plugin allow-none="1"> gpointer to user data + line="261">gpointer to user data @@ -49992,7 +49927,7 @@ via gst_init_get_option_group()) before calling this function. Make GStreamer aware of external dependencies which affect the feature + line="1922">Make GStreamer aware of external dependencies which affect the feature set of this plugin (ie. the elements or typefinders associated with it). GStreamer will re-inspect plugins with external dependencies whenever any @@ -50009,7 +49944,7 @@ codec libraries are currently installed. a #GstPlugin + line="1924">a #GstPlugin allow-none="1"> %NULL-terminated array of environment variables affecting the + line="1925">%NULL-terminated array of environment variables affecting the feature set of the plugin (e.g. an environment variable containing paths where to look for additional modules/plugins of a library), or %NULL. Environment variable names may be followed by a path component @@ -50034,7 +49969,7 @@ codec libraries are currently installed. allow-none="1"> %NULL-terminated array of directories/paths where dependent files + line="1931">%NULL-terminated array of directories/paths where dependent files may be, or %NULL. @@ -50046,7 +49981,7 @@ codec libraries are currently installed. allow-none="1"> %NULL-terminated array of file names (or file name suffixes, + line="1933">%NULL-terminated array of file names (or file name suffixes, depending on @flags) to be used in combination with the paths from @paths and/or the paths extracted from the environment variables in @env_vars, or %NULL. @@ -50057,7 +49992,7 @@ codec libraries are currently installed. optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE + line="1937">optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE @@ -50067,7 +50002,7 @@ codec libraries are currently installed. c:identifier="gst_plugin_add_dependency_simple"> Make GStreamer aware of external dependencies which affect the feature + line="1993">Make GStreamer aware of external dependencies which affect the feature set of this plugin (ie. the elements or typefinders associated with it). GStreamer will re-inspect plugins with external dependencies whenever any @@ -50088,7 +50023,7 @@ arguments separated by predefined delimiters (see above). the #GstPlugin + line="1995">the #GstPlugin allow-none="1"> one or more environment variables (separated by ':', ';' or ','), + line="1996">one or more environment variables (separated by ':', ';' or ','), or %NULL. Environment variable names may be followed by a path component which will be added to the content of the environment variable, e.g. "HOME/.mystuff/plugins:MYSTUFF_PLUGINS_PATH" @@ -50109,7 +50044,7 @@ arguments separated by predefined delimiters (see above). allow-none="1"> one ore more directory paths (separated by ':' or ';' or ','), + line="2000">one ore more directory paths (separated by ':' or ';' or ','), or %NULL. Example: "/usr/lib/mystuff/plugins" @@ -50119,29 +50054,95 @@ arguments separated by predefined delimiters (see above). allow-none="1"> one or more file names or file name suffixes (separated by commas), + line="2002">one or more file names or file name suffixes (separated by commas), or %NULL optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE + line="2004">optional flags, or #GST_PLUGIN_DEPENDENCY_FLAG_NONE + + + + + + + + a #GstPlugin + + + + the status error message + + + + + + + + + + + + a #GstPlugin + + + + the status info message + + + + + + + + + + + + a #GstPlugin + + + + the status warning message + + + + Gets the plugin specific data cache. If it is %NULL there is no cached data + line="1206">Gets the plugin specific data cache. If it is %NULL there is no cached data stored. This is the case when the registry is getting rebuilt. The cached data as a + line="1213">The cached data as a #GstStructure or %NULL. @@ -50149,7 +50150,7 @@ stored. This is the case when the registry is getting rebuilt. a plugin + line="1208">a plugin @@ -50157,19 +50158,19 @@ stored. This is the case when the registry is getting rebuilt. Get the long descriptive name of the plugin + line="1046">Get the long descriptive name of the plugin the long name of the plugin + line="1052">the long name of the plugin plugin to get long name of + line="1048">plugin to get long name of @@ -50177,19 +50178,19 @@ stored. This is the case when the registry is getting rebuilt. get the filename of the plugin + line="1062">get the filename of the plugin the filename of the plugin + line="1068">the filename of the plugin plugin to get the filename of + line="1064">plugin to get the filename of @@ -50197,19 +50198,19 @@ stored. This is the case when the registry is getting rebuilt. get the license of the plugin + line="1094">get the license of the plugin the license of the plugin + line="1100">the license of the plugin plugin to get the license of + line="1096">plugin to get the license of @@ -50217,19 +50218,19 @@ stored. This is the case when the registry is getting rebuilt. Get the short name of the plugin + line="1030">Get the short name of the plugin the name of the plugin + line="1036">the name of the plugin plugin to get the name of + line="1032">plugin to get the name of @@ -50237,19 +50238,19 @@ stored. This is the case when the registry is getting rebuilt. get the URL where the plugin comes from + line="1142">get the URL where the plugin comes from the origin of the plugin + line="1148">the origin of the plugin plugin to get the origin of + line="1144">plugin to get the origin of @@ -50257,19 +50258,19 @@ stored. This is the case when the registry is getting rebuilt. get the package the plugin belongs to. + line="1126">get the package the plugin belongs to. the package of the plugin + line="1132">the package of the plugin plugin to get the package of + line="1128">plugin to get the package of @@ -50278,7 +50279,7 @@ stored. This is the case when the registry is getting rebuilt. c:identifier="gst_plugin_get_release_date_string"> Get the release date (and possibly time) in form of a string, if available. + line="1158">Get the release date (and possibly time) in form of a string, if available. For normal GStreamer plugin releases this will usually just be a date in the form of "YYYY-MM-DD", while pre-releases and builds from git may contain @@ -50290,7 +50291,7 @@ There may be plugins that do not have a valid release date set on them. the date string of the plugin, or %NULL if not + line="1171">the date string of the plugin, or %NULL if not available. @@ -50298,7 +50299,7 @@ available. plugin to get the release date of + line="1160">plugin to get the release date of @@ -50306,19 +50307,82 @@ available. get the source module the plugin belongs to. + line="1110">get the source module the plugin belongs to. the source of the plugin + line="1116">the source of the plugin plugin to get the source of + line="1112">plugin to get the source of + + + + + + + + an array of plugin status error messages, or NULL + + + + + + + a #GstPlugin + + + + + + + + an array of plugin status info messages, or NULL + + + + + + + a #GstPlugin + + + + + + + + an array of plugin status warning messages, or NULL + + + + + + + a #GstPlugin @@ -50326,19 +50390,19 @@ available. get the version of the plugin + line="1078">get the version of the plugin the version of the plugin + line="1084">the version of the plugin plugin to get the version of + line="1080">plugin to get the version of @@ -50346,19 +50410,19 @@ available. queries if the plugin is loaded into memory + line="1182">queries if the plugin is loaded into memory %TRUE is loaded, %FALSE otherwise + line="1188">%TRUE is loaded, %FALSE otherwise plugin to query + line="1184">plugin to query @@ -50366,7 +50430,7 @@ available. Loads @plugin. Note that the *return value* is the loaded plugin; @plugin is + line="1448">Loads @plugin. Note that the *return value* is the loaded plugin; @plugin is untouched. The normal use pattern of this function goes like this: |[ @@ -50380,7 +50444,7 @@ plugin = loaded_plugin; a reference to a loaded plugin, or + line="1463">a reference to a loaded plugin, or %NULL on error. @@ -50388,7 +50452,7 @@ plugin = loaded_plugin; plugin to load + line="1450">plugin to load @@ -50396,7 +50460,7 @@ plugin = loaded_plugin; Adds plugin specific data to cache. Passes the ownership of the structure to + line="1224">Adds plugin specific data to cache. Passes the ownership of the structure to the @plugin. The cache is flushed every time the registry is rebuilt. @@ -50408,13 +50472,13 @@ The cache is flushed every time the registry is rebuilt. a plugin + line="1226">a plugin a structure containing the data to cache + line="1227">a structure containing the data to cache @@ -52324,6 +52388,9 @@ data @tag names can be something like e.g. "comment". Supplying %NULL for the + virtual method to get list of presets @@ -52346,6 +52413,9 @@ data @tag names can be something like e.g. "comment". Supplying %NULL for the + virtual methods to get properties that are persistent @@ -52368,6 +52438,9 @@ data @tag names can be something like e.g. "comment". Supplying %NULL for the + virtual methods to load a preset into properties @@ -52393,6 +52466,9 @@ data @tag names can be something like e.g. "comment". Supplying %NULL for the + virtual methods to save properties into a preset @@ -52418,6 +52494,9 @@ data @tag names can be something like e.g. "comment". Supplying %NULL for the + virtual methods to rename a preset @@ -52449,6 +52528,9 @@ data @tag names can be something like e.g. "comment". Supplying %NULL for the + virtual methods to remove a preset @@ -52474,6 +52556,9 @@ data @tag names can be something like e.g. "comment". Supplying %NULL for the + virtual methods to set textual meta data to a preset @@ -52514,6 +52599,9 @@ data @tag names can be something like e.g. "comment". Supplying %NULL for the + virtual methods to get textual meta data from a preset @@ -52676,19 +52764,19 @@ gst_promise_interrupt() or gst_promise_expire() and can be called from an arbitrary thread. #GstPromise using APIs can restrict this to a single thread or a subset of threads but that is entirely up to the API that uses #GstPromise. - + parent #GstMiniObject + line="68">parent #GstMiniObject - + a new #GstPromise + line="367">a new #GstPromise @@ -52697,14 +52785,14 @@ that uses #GstPromise. version="1.14"> @func will be called exactly once when transitioning out of + line="382">@func will be called exactly once when transitioning out of %GST_PROMISE_RESULT_PENDING into any of the other #GstPromiseResult states. - + a new #GstPromise + line="392">a new #GstPromise @@ -52715,7 +52803,7 @@ states. destroy="2"> a #GstPromiseChangeFunc to call + line="384">a #GstPromiseChangeFunc to call allow-none="1"> argument to call @func with + line="385">argument to call @func with notification function that @user_data is no longer needed + line="386">notification function that @user_data is no longer needed @@ -52738,10 +52826,10 @@ states. Expire a @promise. This will wake up any waiters with + line="284">Expire a @promise. This will wake up any waiters with %GST_PROMISE_RESULT_EXPIRED. Called by a message loop when the parent message is handled and/or destroyed (possibly unanswered). - + @@ -52749,7 +52837,7 @@ message is handled and/or destroyed (possibly unanswered). a #GstPromise + line="286">a #GstPromise @@ -52759,20 +52847,20 @@ message is handled and/or destroyed (possibly unanswered). version="1.14"> Retrieve the reply set on @promise. @promise must be in + line="216">Retrieve the reply set on @promise. @promise must be in %GST_PROMISE_RESULT_REPLIED and the returned structure is owned by @promise - + The reply set on @promise + line="223">The reply set on @promise a #GstPromise + line="218">a #GstPromise @@ -52782,10 +52870,10 @@ message is handled and/or destroyed (possibly unanswered). version="1.14"> Interrupt waiting for a @promise. This will wake up any waiters with + line="244">Interrupt waiting for a @promise. This will wake up any waiters with %GST_PROMISE_RESULT_INTERRUPTED. Called when the consumer does not want the value produced anymore. - + @@ -52793,27 +52881,7 @@ the value produced anymore. a #GstPromise - - - - - - Increases the refcount of the given @promise by one. - - - @promise - - - - - a #GstPromise. + line="246">a #GstPromise @@ -52827,7 +52895,7 @@ indicate success (or failure). If @promise has already been interrupted by the consumer, then this reply is not visible to the consumer. - + @@ -52852,31 +52920,13 @@ is not visible to the consumer. - - Decreases the refcount of the promise. If the refcount reaches 0, the -promise will be freed. - - - - - - - a #GstPromise. - - - - Wait for @promise to move out of the %GST_PROMISE_RESULT_PENDING state. If @promise is not in %GST_PROMISE_RESULT_PENDING then it will return immediately with the current result. - + - + @@ -52904,7 +52954,7 @@ immediately with the current result. a #GstPromise + line="59">a #GstPromise closure="1"> user data + line="60">user data @@ -52926,7 +52976,7 @@ immediately with the current result. c:type="GstPromiseResult"> The result of a #GstPromise + line="35">The result of a #GstPromise glib:name="GST_PROMISE_RESULT_PENDING"> Initial state. Waiting for transition to any + line="37">Initial state. Waiting for transition to any other state. glib:name="GST_PROMISE_RESULT_INTERRUPTED"> Interrupted by the consumer as it doesn't + line="39">Interrupted by the consumer as it doesn't want the value anymore. glib:name="GST_PROMISE_RESULT_REPLIED"> A producer marked a reply + line="41">A producer marked a reply glib:name="GST_PROMISE_RESULT_EXPIRED"> The promise expired (the carrying object + line="42">The promise expired (the carrying object lost all refs) and the promise will never be fulfilled. @@ -53416,21 +53466,21 @@ The following example shows how to query the duration of a pipeline: c:identifier="gst_query_new_accept_caps"> Constructs a new query object for querying if @caps are accepted. + line="2325">Constructs a new query object for querying if @caps are accepted. Free-function: gst_query_unref() a new #GstQuery + line="2333">a new #GstQuery a fixed #GstCaps + line="2327">a fixed #GstCaps @@ -53439,14 +53489,14 @@ Free-function: gst_query_unref() c:identifier="gst_query_new_allocation"> Constructs a new query object for querying the allocation properties. + line="1532">Constructs a new query object for querying the allocation properties. Free-function: gst_query_unref() a new #GstQuery + line="1541">a new #GstQuery @@ -53456,13 +53506,13 @@ Free-function: gst_query_unref() allow-none="1"> the negotiated caps + line="1534">the negotiated caps return a pool + line="1535">return a pool @@ -53472,21 +53522,21 @@ Free-function: gst_query_unref() version="1.16"> Constructs a new query object for querying the bitrate. + line="2658">Constructs a new query object for querying the bitrate. Free-function: gst_query_unref() a new #GstQuery + line="2665">a new #GstQuery Constructs a new query object for querying the buffering status of + line="1032">Constructs a new query object for querying the buffering status of a stream. Free-function: gst_query_unref() @@ -53494,14 +53544,14 @@ Free-function: gst_query_unref() a new #GstQuery + line="1041">a new #GstQuery the default #GstFormat for the new query + line="1034">the default #GstFormat for the new query @@ -53509,7 +53559,7 @@ Free-function: gst_query_unref() Constructs a new query object for querying the caps. + line="2411">Constructs a new query object for querying the caps. The CAPS query should return the allowable caps for a pad in the context of the element's state, its link to other elements, and the devices or files @@ -53533,14 +53583,14 @@ Free-function: gst_query_unref() a new #GstQuery + line="2436">a new #GstQuery a filter + line="2413">a filter @@ -53550,21 +53600,21 @@ Free-function: gst_query_unref() version="1.2"> Constructs a new query object for querying the pipeline-local context. + line="2548">Constructs a new query object for querying the pipeline-local context. Free-function: gst_query_unref() a new #GstQuery + line="2556">a new #GstQuery Context type to query + line="2550">Context type to query @@ -53572,7 +53622,7 @@ Free-function: gst_query_unref() Constructs a new convert query object. Use gst_query_unref() + line="461">Constructs a new convert query object. Use gst_query_unref() when done with it. A convert query is used to ask for a conversion between one format and another. @@ -53581,26 +53631,26 @@ Free-function: gst_query_unref() a #GstQuery + line="473">a #GstQuery the source #GstFormat for the new query + line="463">the source #GstFormat for the new query the value to convert + line="464">the value to convert the target #GstFormat + line="465">the target #GstFormat @@ -53608,7 +53658,7 @@ Free-function: gst_query_unref() Constructs a new custom query object. Use gst_query_unref() + line="661">Constructs a new custom query object. Use gst_query_unref() when done with it. Free-function: gst_query_unref() @@ -53616,14 +53666,14 @@ Free-function: gst_query_unref() a new #GstQuery + line="671">a new #GstQuery the query type + line="663">the query type allow-none="1"> a structure for the query + line="664">a structure for the query @@ -53640,21 +53690,21 @@ Free-function: gst_query_unref() Constructs a new query object for querying the drain state. + line="2527">Constructs a new query object for querying the drain state. Free-function: gst_query_unref() a new #GstQuery + line="2534">a new #GstQuery Constructs a new stream duration query object to query in the given format. + line="301">Constructs a new stream duration query object to query in the given format. Use gst_query_unref() when done with it. A duration query will give the total length of the stream. @@ -53663,14 +53713,14 @@ Free-function: gst_query_unref() a new #GstQuery + line="311">a new #GstQuery the #GstFormat for this duration query + line="303">the #GstFormat for this duration query @@ -53678,7 +53728,7 @@ Free-function: gst_query_unref() Constructs a new query object for querying formats of + line="873">Constructs a new query object for querying formats of the stream. Free-function: gst_query_unref() @@ -53686,14 +53736,14 @@ Free-function: gst_query_unref() a new #GstQuery + line="881">a new #GstQuery Constructs a new latency query object. + line="378">Constructs a new latency query object. Use gst_query_unref() when done with it. A latency query is usually performed by sinks to compensate for additional latency introduced by elements in the pipeline. @@ -53703,14 +53753,14 @@ Free-function: gst_query_unref() a #GstQuery + line="388">a #GstQuery Constructs a new query stream position query object. Use gst_query_unref() + line="222">Constructs a new query stream position query object. Use gst_query_unref() when done with it. A position query is used to query the current position of playback in the streams, in some format. @@ -53719,14 +53769,14 @@ Free-function: gst_query_unref() a new #GstQuery + line="232">a new #GstQuery the default #GstFormat for the new query + line="224">the default #GstFormat for the new query @@ -53735,21 +53785,21 @@ Free-function: gst_query_unref() c:identifier="gst_query_new_scheduling"> Constructs a new query object for querying the scheduling properties. + line="2111">Constructs a new query object for querying the scheduling properties. Free-function: gst_query_unref() a new #GstQuery + line="2118">a new #GstQuery Constructs a new query object for querying seeking properties of + line="756">Constructs a new query object for querying seeking properties of the stream. Free-function: gst_query_unref() @@ -53757,14 +53807,14 @@ Free-function: gst_query_unref() a new #GstQuery + line="765">a new #GstQuery the default #GstFormat for the new query + line="758">the default #GstFormat for the new query @@ -53772,7 +53822,7 @@ Free-function: gst_query_unref() Constructs a new segment query object. Use gst_query_unref() + line="558">Constructs a new segment query object. Use gst_query_unref() when done with it. A segment query is used to discover information about the currently configured segment for playback. @@ -53781,14 +53831,14 @@ Free-function: gst_query_unref() a new #GstQuery + line="568">a new #GstQuery the #GstFormat for the new query + line="560">the #GstFormat for the new query @@ -53798,21 +53848,21 @@ Free-function: gst_query_unref() version="1.22"> Constructs a new query object for querying the stream selection capability. + line="2730">Constructs a new query object for querying the stream selection capability. Free-function: gst_query_unref() a new #GstQuery + line="2737">a new #GstQuery Constructs a new query URI query object. Use gst_query_unref() + line="1364">Constructs a new query URI query object. Use gst_query_unref() when done with it. An URI query is used to query the current URI that is used by the source or sink. @@ -53821,7 +53871,7 @@ Free-function: gst_query_unref() a new #GstQuery + line="1373">a new #GstQuery @@ -53829,7 +53879,7 @@ Free-function: gst_query_unref() c:identifier="gst_query_add_allocation_meta"> Add @api with @params as one of the supported metadata API to @query. + line="1780">Add @api with @params as one of the supported metadata API to @query. @@ -53838,13 +53888,13 @@ Free-function: gst_query_unref() a GST_QUERY_ALLOCATION type query #GstQuery + line="1782">a GST_QUERY_ALLOCATION type query #GstQuery the metadata API + line="1783">the metadata API allow-none="1"> API specific parameters + line="1784">API specific parameters @@ -53862,7 +53912,7 @@ Free-function: gst_query_unref() c:identifier="gst_query_add_allocation_param"> Add @allocator and its @params as a supported memory allocator. + line="1949">Add @allocator and its @params as a supported memory allocator. @@ -53871,7 +53921,7 @@ Free-function: gst_query_unref() a GST_QUERY_ALLOCATION type query #GstQuery + line="1951">a GST_QUERY_ALLOCATION type query #GstQuery allow-none="1"> the memory allocator + line="1952">the memory allocator allow-none="1"> a #GstAllocationParams + line="1953">a #GstAllocationParams @@ -53898,7 +53948,7 @@ Free-function: gst_query_unref() c:identifier="gst_query_add_allocation_pool"> Set the pool parameters in @query. + line="1603">Set the pool parameters in @query. @@ -53907,7 +53957,7 @@ Free-function: gst_query_unref() A valid #GstQuery of type GST_QUERY_ALLOCATION. + line="1605">A valid #GstQuery of type GST_QUERY_ALLOCATION. allow-none="1"> the #GstBufferPool + line="1606">the #GstBufferPool the buffer size + line="1607">the buffer size the min buffers + line="1608">the min buffers the max buffers + line="1609">the max buffers @@ -53943,32 +53993,32 @@ Free-function: gst_query_unref() c:identifier="gst_query_add_buffering_range"> Set the buffering-ranges array field in @query. The current last + line="1256">Set the buffering-ranges array field in @query. The current last start position of the array should be inferior to @start. a #gboolean indicating if the range was added or not. + line="1265">a #gboolean indicating if the range was added or not. a GST_QUERY_BUFFERING type query #GstQuery + line="1258">a GST_QUERY_BUFFERING type query #GstQuery start position of the range + line="1259">start position of the range stop position of the range + line="1260">stop position of the range @@ -53977,7 +54027,7 @@ start position of the array should be inferior to @start. c:identifier="gst_query_add_scheduling_mode"> Add @mode as one of the supported scheduling modes to @query. + line="2189">Add @mode as one of the supported scheduling modes to @query. @@ -53986,64 +54036,42 @@ start position of the array should be inferior to @start. a GST_QUERY_SCHEDULING type query #GstQuery + line="2191">a GST_QUERY_SCHEDULING type query #GstQuery a #GstPadMode + line="2192">a #GstPadMode - - Copies the given query using the copy function of the parent #GstStructure. - -Free-function: gst_query_unref - - - a new copy of @q. - - - - - a #GstQuery to copy. - - - - Check if @query has metadata @api set. When this function returns %TRUE, + line="1897">Check if @query has metadata @api set. When this function returns %TRUE, @index will contain the index where the requested API and the parameters can be found. %TRUE when @api is in the list of metadata. + line="1907">%TRUE when @api is in the list of metadata. a GST_QUERY_ALLOCATION type query #GstQuery + line="1899">a GST_QUERY_ALLOCATION type query #GstQuery the metadata API + line="1900">the metadata API allow-none="1"> the index + line="1901">the index @@ -54063,20 +54091,20 @@ can be found. c:identifier="gst_query_get_n_allocation_metas"> Retrieve the number of values currently stored in the + line="1811">Retrieve the number of values currently stored in the meta API array of the query's structure. the metadata API array size as a #guint. + line="1818">the metadata API array size as a #guint. a GST_QUERY_ALLOCATION type query #GstQuery + line="1813">a GST_QUERY_ALLOCATION type query #GstQuery @@ -54085,7 +54113,7 @@ meta API array of the query's structure. c:identifier="gst_query_get_n_allocation_params"> Retrieve the number of values currently stored in the + line="1983">Retrieve the number of values currently stored in the allocator params array of the query's structure. If no memory allocator is specified, the downstream element can handle @@ -54096,14 +54124,14 @@ allocators should be ordered by preference with the preferred one first. the allocator array size as a #guint. + line="1995">the allocator array size as a #guint. a GST_QUERY_ALLOCATION type query #GstQuery + line="1985">a GST_QUERY_ALLOCATION type query #GstQuery @@ -54112,20 +54140,20 @@ allocators should be ordered by preference with the preferred one first. c:identifier="gst_query_get_n_allocation_pools"> Retrieve the number of values currently stored in the + line="1637">Retrieve the number of values currently stored in the pool array of the query's structure. the pool array size as a #guint. + line="1644">the pool array size as a #guint. a GST_QUERY_ALLOCATION type query #GstQuery + line="1639">a GST_QUERY_ALLOCATION type query #GstQuery @@ -54134,20 +54162,20 @@ pool array of the query's structure. c:identifier="gst_query_get_n_buffering_ranges"> Retrieve the number of values currently stored in the + line="1300">Retrieve the number of values currently stored in the buffered-ranges array of the query's structure. the range array size as a #guint. + line="1307">the range array size as a #guint. a GST_QUERY_BUFFERING type query #GstQuery + line="1302">a GST_QUERY_BUFFERING type query #GstQuery @@ -54156,20 +54184,20 @@ buffered-ranges array of the query's structure. c:identifier="gst_query_get_n_scheduling_modes"> Retrieve the number of values currently stored in the + line="2212">Retrieve the number of values currently stored in the scheduling mode array of the query's structure. the scheduling mode array size as a #guint. + line="2219">the scheduling mode array size as a #guint. a GST_QUERY_SCHEDULING type query #GstQuery + line="2214">a GST_QUERY_SCHEDULING type query #GstQuery @@ -54177,12 +54205,12 @@ scheduling mode array of the query's structure. Get the structure of a query. + line="707">Get the structure of a query. the #GstStructure of the query. The + line="713">the #GstStructure of the query. The structure is still owned by the query and will therefore be freed when the query is unreffed. @@ -54191,7 +54219,7 @@ scheduling mode array of the query's structure. a #GstQuery + line="709">a #GstQuery @@ -54200,7 +54228,7 @@ scheduling mode array of the query's structure. c:identifier="gst_query_has_scheduling_mode"> Check if @query has scheduling mode set. + line="2263">Check if @query has scheduling mode set. > When checking if upstream supports pull mode, it is usually not > enough to just check for GST_PAD_MODE_PULL with this function, you @@ -54211,20 +54239,20 @@ scheduling mode array of the query's structure. %TRUE when @mode is in the list of scheduling modes. + line="2276">%TRUE when @mode is in the list of scheduling modes. a GST_QUERY_SCHEDULING type query #GstQuery + line="2265">a GST_QUERY_SCHEDULING type query #GstQuery the scheduling mode + line="2266">the scheduling mode @@ -54233,13 +54261,13 @@ scheduling mode array of the query's structure. c:identifier="gst_query_has_scheduling_mode_with_flags"> Check if @query has scheduling mode set and @flags is set in + line="2299">Check if @query has scheduling mode set and @flags is set in query scheduling flags. %TRUE when @mode is in the list of scheduling modes + line="2308">%TRUE when @mode is in the list of scheduling modes and @flags are compatible with query flags. @@ -54247,19 +54275,19 @@ query scheduling flags. a GST_QUERY_SCHEDULING type query #GstQuery + line="2301">a GST_QUERY_SCHEDULING type query #GstQuery the scheduling mode + line="2302">the scheduling mode #GstSchedulingFlags + line="2303">#GstSchedulingFlags @@ -54268,7 +54296,7 @@ query scheduling flags. c:identifier="gst_query_parse_accept_caps"> Get the caps from @query. The caps remains valid as long as @query remains + line="2351">Get the caps from @query. The caps remains valid as long as @query remains valid. @@ -54278,7 +54306,7 @@ valid. The query to parse + line="2353">The query to parse transfer-ownership="none"> A pointer to the caps + line="2354">A pointer to the caps @@ -54296,7 +54324,7 @@ valid. c:identifier="gst_query_parse_accept_caps_result"> Parse the result from @query and store in @result. + line="2392">Parse the result from @query and store in @result. @@ -54305,7 +54333,7 @@ valid. a GST_QUERY_ACCEPT_CAPS type query #GstQuery + line="2394">a GST_QUERY_ACCEPT_CAPS type query #GstQuery nullable="1"> location for the result + line="2395">location for the result @@ -54324,7 +54352,7 @@ valid. c:identifier="gst_query_parse_allocation"> Parse an allocation query, writing the requested caps in @caps and + line="1558">Parse an allocation query, writing the requested caps in @caps and whether a pool is needed in @need_pool, if the respective parameters are non-%NULL. @@ -54338,7 +54366,7 @@ gst_query_parse_nth_allocation_pool(). a #GstQuery + line="1560">a #GstQuery allow-none="1"> The #GstCaps + line="1561">The #GstCaps allow-none="1"> Whether a #GstBufferPool is needed + line="1562">Whether a #GstBufferPool is needed @@ -54371,7 +54399,7 @@ gst_query_parse_nth_allocation_pool(). version="1.16"> Get the results of a bitrate query. See also gst_query_set_bitrate(). + line="2705">Get the results of a bitrate query. See also gst_query_set_bitrate(). @@ -54380,7 +54408,7 @@ gst_query_parse_nth_allocation_pool(). a GST_QUERY_BITRATE type #GstQuery + line="2707">a GST_QUERY_BITRATE type #GstQuery allow-none="1"> The resulting bitrate in bits per second + line="2708">The resulting bitrate in bits per second @@ -54400,7 +54428,7 @@ gst_query_parse_nth_allocation_pool(). c:identifier="gst_query_parse_buffering_percent"> Get the percentage of buffered data. This is a value between 0 and 100. + line="1092">Get the percentage of buffered data. This is a value between 0 and 100. The @busy indicator is %TRUE when the buffering is in progress. @@ -54410,7 +54438,7 @@ The @busy indicator is %TRUE when the buffering is in progress. A valid #GstQuery of type GST_QUERY_BUFFERING. + line="1094">A valid #GstQuery of type GST_QUERY_BUFFERING. allow-none="1"> if buffering is busy, or %NULL + line="1095">if buffering is busy, or %NULL allow-none="1"> a buffering percent, or %NULL + line="1096">a buffering percent, or %NULL @@ -54441,7 +54469,7 @@ The @busy indicator is %TRUE when the buffering is in progress. c:identifier="gst_query_parse_buffering_range"> Parse an available query, writing the format into @format, and + line="1210">Parse an available query, writing the format into @format, and other results into the passed parameters, if the respective parameters are non-%NULL @@ -54452,7 +54480,7 @@ are non-%NULL a GST_QUERY_BUFFERING type query #GstQuery + line="1212">a GST_QUERY_BUFFERING type query #GstQuery allow-none="1"> the format to set for the @segment_start + line="1213">the format to set for the @segment_start and @segment_end values, or %NULL @@ -54475,7 +54503,7 @@ are non-%NULL allow-none="1"> the start to set, or %NULL + line="1215">the start to set, or %NULL allow-none="1"> the stop to set, or %NULL + line="1216">the stop to set, or %NULL allow-none="1"> estimated total amount of download + line="1217">estimated total amount of download time remaining in milliseconds, or %NULL @@ -54507,7 +54535,7 @@ are non-%NULL c:identifier="gst_query_parse_buffering_stats"> Extracts the buffering stats values from @query. + line="1145">Extracts the buffering stats values from @query. @@ -54516,7 +54544,7 @@ are non-%NULL A valid #GstQuery of type GST_QUERY_BUFFERING. + line="1147">A valid #GstQuery of type GST_QUERY_BUFFERING. allow-none="1"> a buffering mode, or %NULL + line="1148">a buffering mode, or %NULL allow-none="1"> the average input rate, or %NULL + line="1149">the average input rate, or %NULL allow-none="1"> the average output rat, or %NULL + line="1150">the average output rat, or %NULL allow-none="1"> amount of buffering time left in + line="1151">amount of buffering time left in milliseconds, or %NULL @@ -54569,7 +54597,7 @@ are non-%NULL Get the filter from the caps @query. The caps remains valid as long as + line="2452">Get the filter from the caps @query. The caps remains valid as long as @query remains valid. @@ -54579,7 +54607,7 @@ are non-%NULL The query to parse + line="2454">The query to parse transfer-ownership="none"> A pointer to the caps filter + line="2455">A pointer to the caps filter @@ -54597,7 +54625,7 @@ are non-%NULL c:identifier="gst_query_parse_caps_result"> Get the caps result from @query. The caps remains valid as long as + line="2492">Get the caps result from @query. The caps remains valid as long as @query remains valid. @@ -54607,7 +54635,7 @@ are non-%NULL The query to parse + line="2494">The query to parse nullable="1"> A pointer to the caps + line="2495">A pointer to the caps @@ -54627,7 +54655,7 @@ are non-%NULL version="1.2"> Get the context from the context @query. The context remains valid as long as + line="2602">Get the context from the context @query. The context remains valid as long as @query remains valid. @@ -54637,7 +54665,7 @@ are non-%NULL The query to parse + line="2604">The query to parse nullable="1"> A pointer to store the #GstContext + line="2605">A pointer to store the #GstContext @@ -54657,19 +54685,19 @@ are non-%NULL version="1.2"> Parse a context type from an existing GST_QUERY_CONTEXT query. + line="2629">Parse a context type from an existing GST_QUERY_CONTEXT query. a #gboolean indicating if the parsing succeeded. + line="2636">a #gboolean indicating if the parsing succeeded. a GST_QUERY_CONTEXT type query + line="2631">a GST_QUERY_CONTEXT type query allow-none="1"> the context type, or %NULL + line="2632">the context type, or %NULL @@ -54688,7 +54716,7 @@ are non-%NULL Parse a convert query answer. Any of @src_format, @src_value, @dest_format, + line="519">Parse a convert query answer. Any of @src_format, @src_value, @dest_format, and @dest_value may be %NULL, in which case that value is omitted. @@ -54698,7 +54726,7 @@ and @dest_value may be %NULL, in which case that value is omitted. a #GstQuery + line="521">a #GstQuery allow-none="1"> the storage for the #GstFormat of the + line="522">the storage for the #GstFormat of the source value, or %NULL @@ -54721,7 +54749,7 @@ and @dest_value may be %NULL, in which case that value is omitted. allow-none="1"> the storage for the source value, or %NULL + line="524">the storage for the source value, or %NULL allow-none="1"> the storage for the #GstFormat of the + line="525">the storage for the #GstFormat of the destination value, or %NULL @@ -54744,7 +54772,7 @@ and @dest_value may be %NULL, in which case that value is omitted. allow-none="1"> the storage for the destination value, + line="527">the storage for the destination value, or %NULL @@ -54753,7 +54781,7 @@ and @dest_value may be %NULL, in which case that value is omitted. Parse a duration query answer. Write the format of the duration into @format, + line="350">Parse a duration query answer. Write the format of the duration into @format, and the value into @duration, if the respective variables are non-%NULL. @@ -54763,7 +54791,7 @@ and the value into @duration, if the respective variables are non-%NULL. a #GstQuery + line="352">a #GstQuery allow-none="1"> the storage for the #GstFormat of the duration + line="353">the storage for the #GstFormat of the duration value, or %NULL. @@ -54786,7 +54814,7 @@ and the value into @duration, if the respective variables are non-%NULL. allow-none="1"> the storage for the total duration, or %NULL. + line="355">the storage for the total duration, or %NULL. @@ -54794,7 +54822,7 @@ and the value into @duration, if the respective variables are non-%NULL. Parse a latency query answer. + line="431">Parse a latency query answer. @@ -54803,7 +54831,7 @@ and the value into @duration, if the respective variables are non-%NULL. a #GstQuery + line="433">a #GstQuery allow-none="1"> storage for live or %NULL + line="434">storage for live or %NULL allow-none="1"> the storage for the min latency or %NULL + line="435">the storage for the min latency or %NULL allow-none="1"> the storage for the max latency or %NULL + line="436">the storage for the max latency or %NULL @@ -54844,7 +54872,7 @@ and the value into @duration, if the respective variables are non-%NULL. Parse the number of formats in the formats @query. + line="972">Parse the number of formats in the formats @query. @@ -54853,7 +54881,7 @@ and the value into @duration, if the respective variables are non-%NULL. a #GstQuery + line="974">a #GstQuery allow-none="1"> the number of formats in this query. + line="975">the number of formats in this query. @@ -54873,26 +54901,26 @@ and the value into @duration, if the respective variables are non-%NULL. c:identifier="gst_query_parse_nth_allocation_meta"> Parse an available query and get the metadata API + line="1836">Parse an available query and get the metadata API at @index of the metadata API array. a #GType of the metadata API at @index. + line="1845">a #GType of the metadata API at @index. a GST_QUERY_ALLOCATION type query #GstQuery + line="1838">a GST_QUERY_ALLOCATION type query #GstQuery position in the metadata API array to read + line="1839">position in the metadata API array to read allow-none="1"> API specific parameters + line="1840">API specific parameters @@ -54912,7 +54940,7 @@ at @index of the metadata API array. c:identifier="gst_query_parse_nth_allocation_param"> Parse an available query and get the allocator and its params + line="2012">Parse an available query and get the allocator and its params at @index of the allocator array. @@ -54922,13 +54950,13 @@ at @index of the allocator array. a GST_QUERY_ALLOCATION type query #GstQuery + line="2014">a GST_QUERY_ALLOCATION type query #GstQuery position in the allocator array to read + line="2015">position in the allocator array to read allow-none="1"> variable to hold the result + line="2016">variable to hold the result allow-none="1"> parameters for the allocator + line="2017">parameters for the allocator @@ -54960,7 +54988,7 @@ at @index of the allocator array. c:identifier="gst_query_parse_nth_allocation_pool"> Get the pool parameters in @query. + line="1661">Get the pool parameters in @query. Unref @pool with gst_object_unref() when it's not needed any more. @@ -54971,13 +54999,13 @@ Unref @pool with gst_object_unref() when it's not needed any more. A valid #GstQuery of type GST_QUERY_ALLOCATION. + line="1663">A valid #GstQuery of type GST_QUERY_ALLOCATION. index to parse + line="1664">index to parse allow-none="1"> the #GstBufferPool + line="1665">the #GstBufferPool allow-none="1"> the buffer size + line="1666">the buffer size allow-none="1"> the min buffers + line="1667">the min buffers allow-none="1"> the max buffers + line="1668">the max buffers @@ -55031,26 +55059,26 @@ Unref @pool with gst_object_unref() when it's not needed any more. c:identifier="gst_query_parse_nth_buffering_range"> Parse an available query and get the start and stop values stored + line="1325">Parse an available query and get the start and stop values stored at the @index of the buffered ranges array. a #gboolean indicating if the parsing succeeded. + line="1335">a #gboolean indicating if the parsing succeeded. a GST_QUERY_BUFFERING type query #GstQuery + line="1327">a GST_QUERY_BUFFERING type query #GstQuery position in the buffered-ranges array to read + line="1328">position in the buffered-ranges array to read allow-none="1"> the start position to set, or %NULL + line="1329">the start position to set, or %NULL allow-none="1"> the stop position to set, or %NULL + line="1330">the stop position to set, or %NULL @@ -55081,7 +55109,7 @@ at the @index of the buffered ranges array. c:identifier="gst_query_parse_nth_format"> Parse the format query and retrieve the @nth format from it into + line="998">Parse the format query and retrieve the @nth format from it into @format. If the list contains less elements than @nth, @format will be set to GST_FORMAT_UNDEFINED. @@ -55092,13 +55120,13 @@ set to GST_FORMAT_UNDEFINED. a #GstQuery + line="1000">a #GstQuery the nth format to retrieve. + line="1001">the nth format to retrieve. allow-none="1"> a pointer to store the nth format + line="1002">a pointer to store the nth format @@ -55118,26 +55146,26 @@ set to GST_FORMAT_UNDEFINED. c:identifier="gst_query_parse_nth_scheduling_mode"> Parse an available query and get the scheduling mode + line="2236">Parse an available query and get the scheduling mode at @index of the scheduling modes array. a #GstPadMode of the scheduling mode at @index. + line="2244">a #GstPadMode of the scheduling mode at @index. a GST_QUERY_SCHEDULING type query #GstQuery + line="2238">a GST_QUERY_SCHEDULING type query #GstQuery position in the scheduling modes array to read + line="2239">position in the scheduling modes array to read @@ -55145,7 +55173,7 @@ at @index of the scheduling modes array. Parse a position query, writing the format into @format, and the position + line="273">Parse a position query, writing the format into @format, and the position into @cur, if the respective parameters are non-%NULL. @@ -55155,7 +55183,7 @@ into @cur, if the respective parameters are non-%NULL. a #GstQuery + line="275">a #GstQuery allow-none="1"> the storage for the #GstFormat of the + line="276">the storage for the #GstFormat of the position values (may be %NULL) @@ -55178,7 +55206,7 @@ into @cur, if the respective parameters are non-%NULL. allow-none="1"> the storage for the current position (may be %NULL) + line="278">the storage for the current position (may be %NULL) @@ -55187,7 +55215,7 @@ into @cur, if the respective parameters are non-%NULL. c:identifier="gst_query_parse_scheduling"> Set the scheduling properties. + line="2163">Set the scheduling properties. @@ -55196,7 +55224,7 @@ into @cur, if the respective parameters are non-%NULL. A valid #GstQuery of type GST_QUERY_SCHEDULING. + line="2165">A valid #GstQuery of type GST_QUERY_SCHEDULING. allow-none="1"> #GstSchedulingFlags + line="2166">#GstSchedulingFlags allow-none="1"> the suggested minimum size of pull requests + line="2167">the suggested minimum size of pull requests allow-none="1"> the suggested maximum size of pull requests: + line="2168">the suggested maximum size of pull requests: allow-none="1"> the suggested alignment of pull requests + line="2169">the suggested alignment of pull requests @@ -55248,7 +55276,7 @@ into @cur, if the respective parameters are non-%NULL. Parse a seeking query, writing the format into @format, and + line="811">Parse a seeking query, writing the format into @format, and other results into the passed parameters, if the respective parameters are non-%NULL @@ -55259,7 +55287,7 @@ are non-%NULL a GST_QUERY_SEEKING type query #GstQuery + line="813">a GST_QUERY_SEEKING type query #GstQuery allow-none="1"> the format to set for the @segment_start + line="814">the format to set for the @segment_start and @segment_end values, or %NULL @@ -55282,7 +55310,7 @@ are non-%NULL allow-none="1"> the seekable flag to set, or %NULL + line="816">the seekable flag to set, or %NULL allow-none="1"> the segment_start to set, or %NULL + line="817">the segment_start to set, or %NULL allow-none="1"> the segment_end to set, or %NULL + line="818">the segment_end to set, or %NULL @@ -55312,7 +55340,7 @@ are non-%NULL Parse a segment query answer. Any of @rate, @format, @start_value, and + line="623">Parse a segment query answer. Any of @rate, @format, @start_value, and @stop_value may be %NULL, which will cause this value to be omitted. See gst_query_set_segment() for an explanation of the function arguments. @@ -55324,7 +55352,7 @@ See gst_query_set_segment() for an explanation of the function arguments. a #GstQuery + line="625">a #GstQuery allow-none="1"> the storage for the rate of the segment, or %NULL + line="626">the storage for the rate of the segment, or %NULL allow-none="1"> the storage for the #GstFormat of the values, + line="627">the storage for the #GstFormat of the values, or %NULL @@ -55358,7 +55386,7 @@ See gst_query_set_segment() for an explanation of the function arguments. allow-none="1"> the storage for the start value, or %NULL + line="629">the storage for the start value, or %NULL allow-none="1"> the storage for the stop value, or %NULL + line="630">the storage for the stop value, or %NULL @@ -55379,7 +55407,7 @@ See gst_query_set_segment() for an explanation of the function arguments. version="1.22"> Get the results of a selectable query. See also gst_query_set_selectable(). + line="2776">Get the results of a selectable query. See also gst_query_set_selectable(). @@ -55388,7 +55416,7 @@ See gst_query_set_segment() for an explanation of the function arguments. a GST_QUERY_SELECTABLE type #GstQuery + line="2778">a GST_QUERY_SELECTABLE type #GstQuery allow-none="1"> The resulting stream selection capability + line="2779">The resulting stream selection capability @@ -55407,7 +55435,7 @@ See gst_query_set_segment() for an explanation of the function arguments. Parse an URI query, writing the URI into @uri as a newly + line="1408">Parse an URI query, writing the URI into @uri as a newly allocated string, if the respective parameters are non-%NULL. Free the string with g_free() after usage. @@ -55418,7 +55446,7 @@ Free the string with g_free() after usage. a #GstQuery + line="1410">a #GstQuery allow-none="1"> the storage for the current URI + line="1411">the storage for the current URI (may be %NULL) @@ -55441,7 +55469,7 @@ Free the string with g_free() after usage. version="1.2"> Parse an URI query, writing the URI into @uri as a newly + line="1453">Parse an URI query, writing the URI into @uri as a newly allocated string, if the respective parameters are non-%NULL. Free the string with g_free() after usage. @@ -55452,7 +55480,7 @@ Free the string with g_free() after usage. a #GstQuery + line="1455">a #GstQuery allow-none="1"> the storage for the redirect URI + line="1456">the storage for the redirect URI (may be %NULL) @@ -55475,7 +55503,7 @@ Free the string with g_free() after usage. version="1.4"> Parse an URI query, and set @permanent to %TRUE if there is a redirection + line="1503">Parse an URI query, and set @permanent to %TRUE if there is a redirection and it should be considered permanent. If a redirection is permanent, applications should update their internal storage of the URI, otherwise they should make all future requests to the original URI. @@ -55487,7 +55515,7 @@ they should make all future requests to the original URI. a #GstQuery + line="1505">a #GstQuery allow-none="1"> if the URI redirection is permanent + line="1506">if the URI redirection is permanent (may be %NULL) - - Increases the refcount of the given query by one. - - - @q - - - - - a #GstQuery to increase the refcount of. - - - - Remove the metadata API at @index of the metadata API array. + line="1872">Remove the metadata API at @index of the metadata API array. @@ -55537,13 +55545,13 @@ they should make all future requests to the original URI. a GST_QUERY_ALLOCATION type query #GstQuery + line="1874">a GST_QUERY_ALLOCATION type query #GstQuery position in the metadata API array to remove + line="1875">position in the metadata API array to remove @@ -55553,7 +55561,7 @@ they should make all future requests to the original URI. version="1.2"> Remove the allocation param at @index of the allocation param array. + line="2084">Remove the allocation param at @index of the allocation param array. @@ -55562,13 +55570,13 @@ they should make all future requests to the original URI. a GST_QUERY_ALLOCATION type query #GstQuery + line="2086">a GST_QUERY_ALLOCATION type query #GstQuery position in the allocation param array to remove + line="2087">position in the allocation param array to remove @@ -55578,7 +55586,7 @@ they should make all future requests to the original URI. version="1.2"> Remove the allocation pool at @index of the allocation pool array. + line="1740">Remove the allocation pool at @index of the allocation pool array. @@ -55587,13 +55595,13 @@ they should make all future requests to the original URI. a GST_QUERY_ALLOCATION type query #GstQuery + line="1742">a GST_QUERY_ALLOCATION type query #GstQuery position in the allocation pool array to remove + line="1743">position in the allocation pool array to remove @@ -55602,7 +55610,7 @@ they should make all future requests to the original URI. c:identifier="gst_query_set_accept_caps_result"> Set @result as the result for the @query. + line="2372">Set @result as the result for the @query. @@ -55611,13 +55619,13 @@ they should make all future requests to the original URI. a GST_QUERY_ACCEPT_CAPS type query #GstQuery + line="2374">a GST_QUERY_ACCEPT_CAPS type query #GstQuery the result to set + line="2375">the result to set @@ -55627,7 +55635,7 @@ they should make all future requests to the original URI. version="1.16"> Set the results of a bitrate query. The nominal bitrate is the average + line="2681">Set the results of a bitrate query. The nominal bitrate is the average bitrate expected over the length of the stream as advertised in file headers (or similar). @@ -55638,13 +55646,13 @@ headers (or similar). a GST_QUERY_BITRATE type #GstQuery + line="2683">a GST_QUERY_BITRATE type #GstQuery the nominal bitrate in bits per second + line="2684">the nominal bitrate in bits per second @@ -55653,7 +55661,7 @@ headers (or similar). c:identifier="gst_query_set_buffering_percent"> Set the percentage of buffered data. This is a value between 0 and 100. + line="1068">Set the percentage of buffered data. This is a value between 0 and 100. The @busy indicator is %TRUE when the buffering is in progress. @@ -55663,19 +55671,19 @@ The @busy indicator is %TRUE when the buffering is in progress. A valid #GstQuery of type GST_QUERY_BUFFERING. + line="1070">A valid #GstQuery of type GST_QUERY_BUFFERING. if buffering is busy + line="1071">if buffering is busy a buffering percent + line="1072">a buffering percent @@ -55684,7 +55692,7 @@ The @busy indicator is %TRUE when the buffering is in progress. c:identifier="gst_query_set_buffering_range"> Set the available query result fields in @query. + line="1182">Set the available query result fields in @query. @@ -55693,31 +55701,31 @@ The @busy indicator is %TRUE when the buffering is in progress. a #GstQuery + line="1184">a #GstQuery the format to set for the @start and @stop values + line="1185">the format to set for the @start and @stop values the start to set + line="1186">the start to set the stop to set + line="1187">the stop to set estimated total amount of download time remaining in + line="1188">estimated total amount of download time remaining in milliseconds @@ -55727,7 +55735,7 @@ The @busy indicator is %TRUE when the buffering is in progress. c:identifier="gst_query_set_buffering_stats"> Configures the buffering stats values in @query. + line="1118">Configures the buffering stats values in @query. @@ -55736,31 +55744,31 @@ The @busy indicator is %TRUE when the buffering is in progress. A valid #GstQuery of type GST_QUERY_BUFFERING. + line="1120">A valid #GstQuery of type GST_QUERY_BUFFERING. a buffering mode + line="1121">a buffering mode the average input rate + line="1122">the average input rate the average output rate + line="1123">the average output rate amount of buffering time left in milliseconds + line="1124">amount of buffering time left in milliseconds @@ -55768,7 +55776,7 @@ The @busy indicator is %TRUE when the buffering is in progress. Set the @caps result in @query. + line="2473">Set the @caps result in @query. @@ -55777,7 +55785,7 @@ The @busy indicator is %TRUE when the buffering is in progress. The query to use + line="2475">The query to use allow-none="1"> A pointer to the caps + line="2476">A pointer to the caps @@ -55796,7 +55804,7 @@ The @busy indicator is %TRUE when the buffering is in progress. version="1.2"> Answer a context query by setting the requested context. + line="2575">Answer a context query by setting the requested context. @@ -55805,7 +55813,7 @@ The @busy indicator is %TRUE when the buffering is in progress. a #GstQuery with query type GST_QUERY_CONTEXT + line="2577">a #GstQuery with query type GST_QUERY_CONTEXT allow-none="1"> the requested #GstContext + line="2578">the requested #GstContext @@ -55822,7 +55830,7 @@ The @busy indicator is %TRUE when the buffering is in progress. Answer a convert query by setting the requested values. + line="493">Answer a convert query by setting the requested values. @@ -55831,31 +55839,31 @@ The @busy indicator is %TRUE when the buffering is in progress. a #GstQuery + line="495">a #GstQuery the source #GstFormat + line="496">the source #GstFormat the source value + line="497">the source value the destination #GstFormat + line="498">the destination #GstFormat the destination value + line="499">the destination value @@ -55863,7 +55871,7 @@ The @busy indicator is %TRUE when the buffering is in progress. Answer a duration query by setting the requested value in the given format. + line="328">Answer a duration query by setting the requested value in the given format. @@ -55872,19 +55880,19 @@ The @busy indicator is %TRUE when the buffering is in progress. a #GstQuery + line="330">a #GstQuery the #GstFormat for the duration + line="331">the #GstFormat for the duration the duration of the stream + line="332">the duration of the stream @@ -55894,7 +55902,7 @@ The @busy indicator is %TRUE when the buffering is in progress. introspectable="0"> Set the formats query result fields in @query. The number of formats passed + line="906">Set the formats query result fields in @query. The number of formats passed must be equal to @n_formats. @@ -55904,19 +55912,19 @@ must be equal to @n_formats. a #GstQuery + line="908">a #GstQuery the number of formats to set. + line="909">the number of formats to set. A number of @GstFormats equal to @n_formats. + line="910">A number of @GstFormats equal to @n_formats. @@ -55924,7 +55932,7 @@ must be equal to @n_formats. Set the formats query result fields in @query. The number of formats passed + line="941">Set the formats query result fields in @query. The number of formats passed in the @formats array must be equal to @n_formats. @@ -55934,19 +55942,19 @@ in the @formats array must be equal to @n_formats. a #GstQuery + line="943">a #GstQuery the number of formats to set. + line="944">the number of formats to set. an array containing @n_formats + line="945">an array containing @n_formats @GstFormat values. @@ -55957,7 +55965,7 @@ in the @formats array must be equal to @n_formats. Answer a latency query by setting the requested values in the given format. + line="406">Answer a latency query by setting the requested values in the given format. @@ -55966,25 +55974,25 @@ in the @formats array must be equal to @n_formats. a #GstQuery + line="408">a #GstQuery if there is a live element upstream + line="409">if there is a live element upstream the minimal latency of the upstream elements + line="410">the minimal latency of the upstream elements the maximal latency of the upstream elements + line="411">the maximal latency of the upstream elements @@ -55993,7 +56001,7 @@ in the @formats array must be equal to @n_formats. c:identifier="gst_query_set_nth_allocation_param"> Parse an available query and get the allocator and its params + line="2046">Parse an available query and get the allocator and its params at @index of the allocator array. @@ -56003,13 +56011,13 @@ at @index of the allocator array. a GST_QUERY_ALLOCATION type query #GstQuery + line="2048">a GST_QUERY_ALLOCATION type query #GstQuery position in the allocator array to set + line="2049">position in the allocator array to set allow-none="1"> new allocator to set + line="2050">new allocator to set allow-none="1"> parameters for the allocator + line="2051">parameters for the allocator @@ -56036,7 +56044,7 @@ at @index of the allocator array. c:identifier="gst_query_set_nth_allocation_pool"> Set the pool parameters in @query. + line="1703">Set the pool parameters in @query. @@ -56045,13 +56053,13 @@ at @index of the allocator array. A valid #GstQuery of type GST_QUERY_ALLOCATION. + line="1706">A valid #GstQuery of type GST_QUERY_ALLOCATION. index to modify + line="1705">index to modify allow-none="1"> the #GstBufferPool + line="1707">the #GstBufferPool the buffer size + line="1708">the buffer size the min buffers + line="1709">the min buffers the max buffers + line="1710">the max buffers @@ -56086,7 +56094,7 @@ at @index of the allocator array. Answer a position query by setting the requested value in the given format. + line="249">Answer a position query by setting the requested value in the given format. @@ -56095,19 +56103,19 @@ at @index of the allocator array. a #GstQuery with query type GST_QUERY_POSITION + line="251">a #GstQuery with query type GST_QUERY_POSITION the requested #GstFormat + line="252">the requested #GstFormat the position to set + line="253">the position to set @@ -56115,7 +56123,7 @@ at @index of the allocator array. Set the scheduling properties. + line="2136">Set the scheduling properties. @@ -56124,31 +56132,31 @@ at @index of the allocator array. A valid #GstQuery of type GST_QUERY_SCHEDULING. + line="2138">A valid #GstQuery of type GST_QUERY_SCHEDULING. #GstSchedulingFlags + line="2139">#GstSchedulingFlags the suggested minimum size of pull requests + line="2140">the suggested minimum size of pull requests the suggested maximum size of pull requests + line="2141">the suggested maximum size of pull requests the suggested alignment of pull requests + line="2142">the suggested alignment of pull requests @@ -56156,7 +56164,7 @@ at @index of the allocator array. Set the seeking query result fields in @query. + line="784">Set the seeking query result fields in @query. @@ -56165,31 +56173,31 @@ at @index of the allocator array. a #GstQuery + line="786">a #GstQuery the format to set for the @segment_start and @segment_end values + line="787">the format to set for the @segment_start and @segment_end values the seekable flag to set + line="788">the seekable flag to set the segment_start to set + line="789">the segment_start to set the segment_end to set + line="790">the segment_end to set @@ -56197,7 +56205,7 @@ at @index of the allocator array. Answer a segment query by setting the requested values. The normal + line="587">Answer a segment query by setting the requested values. The normal playback segment of a pipeline is 0 to duration at the default rate of 1.0. If a seek was performed on the pipeline to play a different segment, this query will return the range specified in the last seek. @@ -56216,31 +56224,31 @@ negative rates, playback will actually happen from @stop_value to a #GstQuery + line="589">a #GstQuery the rate of the segment + line="590">the rate of the segment the #GstFormat of the segment values (@start_value and @stop_value) + line="591">the #GstFormat of the segment values (@start_value and @stop_value) the start value + line="592">the start value the stop value + line="593">the stop value @@ -56250,7 +56258,7 @@ negative rates, playback will actually happen from @stop_value to version="1.22"> Set the results of a selectable query. If the element answering the query can + line="2753">Set the results of a selectable query. If the element answering the query can handle stream selection, @selectable should be set to %TRUE. @@ -56260,13 +56268,13 @@ handle stream selection, @selectable should be set to %TRUE. a GST_QUERY_SELECTABLE type #GstQuery + line="2755">a GST_QUERY_SELECTABLE type #GstQuery Whether the element can handle stream selection. + line="2756">Whether the element can handle stream selection. @@ -56274,7 +56282,7 @@ handle stream selection, @selectable should be set to %TRUE. Answer a URI query by setting the requested URI. + line="1389">Answer a URI query by setting the requested URI. @@ -56283,7 +56291,7 @@ handle stream selection, @selectable should be set to %TRUE. a #GstQuery with query type GST_QUERY_URI + line="1391">a #GstQuery with query type GST_QUERY_URI allow-none="1"> the URI to set + line="1392">the URI to set @@ -56302,7 +56310,7 @@ handle stream selection, @selectable should be set to %TRUE. version="1.2"> Answer a URI query by setting the requested URI redirection. + line="1431">Answer a URI query by setting the requested URI redirection. @@ -56311,7 +56319,7 @@ handle stream selection, @selectable should be set to %TRUE. a #GstQuery with query type GST_QUERY_URI + line="1433">a #GstQuery with query type GST_QUERY_URI allow-none="1"> the URI to set + line="1434">the URI to set @@ -56330,7 +56338,7 @@ handle stream selection, @selectable should be set to %TRUE. version="1.4"> Answer a URI query by setting the requested URI redirection + line="1480">Answer a URI query by setting the requested URI redirection to permanent or not. @@ -56340,46 +56348,28 @@ to permanent or not. a #GstQuery with query type %GST_QUERY_URI + line="1482">a #GstQuery with query type %GST_QUERY_URI whether the redirect is permanent or not + line="1483">whether the redirect is permanent or not - - Decreases the refcount of the query. If the refcount reaches 0, the query -will be freed. - - - - - - - a #GstQuery to decrease the refcount of. - - - - Get the structure of a query. This method should be called with a writable + line="725">Get the structure of a query. This method should be called with a writable @query so that the returned structure is guaranteed to be writable. the #GstStructure of the query. The structure is + line="732">the #GstStructure of the query. The structure is still owned by the query and will therefore be freed when the query is unreffed. @@ -56388,94 +56378,11 @@ will be freed. a #GstQuery + line="727">a #GstQuery - - Modifies a pointer to a #GstQuery to point to a different #GstQuery. The -modification is done atomically (so this is useful for ensuring thread safety -in some cases), and the reference counts are updated appropriately (the old -query is unreffed, the new one is reffed). - -Either @new_query or the #GstQuery pointed to by @old_query may be %NULL. - - - %TRUE if @new_query was different from @old_query - - - - - pointer to a pointer to a - #GstQuery to be replaced. - - - - pointer to a #GstQuery that will - replace the query pointed to by @old_query. - - - - - - Modifies a pointer to a #GstQuery to point to a different #GstQuery. This -function is similar to gst_query_replace() except that it takes ownership of -@new_query. - -Either @new_query or the #GstQuery pointed to by @old_query may be %NULL. - - - %TRUE if @new_query was different from @old_query - - - - - pointer to a - pointer to a #GstQuery to be stolen. - - - - pointer to a #GstQuery that will - replace the query pointed to by @old_query. - - - - Gets the #GstQueryTypeFlags associated with @type. + line="170">Gets the #GstQueryTypeFlags associated with @type. a #GstQueryTypeFlags. + line="176">a #GstQueryTypeFlags. a #GstQueryType + line="172">a #GstQueryType @@ -56698,19 +56605,19 @@ Either @new_query or the #GstQuery pointed to by @old_query may be %NULL. Get a printable name for the given query type. Do not modify or free. + line="130">Get a printable name for the given query type. Do not modify or free. a reference to the static name of the query. + line="136">a reference to the static name of the query. the query type + line="132">the query type @@ -56718,19 +56625,19 @@ Either @new_query or the #GstQuery pointed to by @old_query may be %NULL. Get the unique quark for the given query type. + line="150">Get the unique quark for the given query type. the quark associated with the query type + line="156">the quark associated with the query type the query type + line="152">the query type @@ -57262,8 +57169,11 @@ references would be * `timestamp/x-ptp, version=IEEE1588-2008, domain=1`: for timestamps based on a given PTP clock. * `timestamp/x-unix`: for timestamps based on the UNIX epoch according to - the local clock. - + the local clock. + +Since 1.24 it can be serialized using gst_meta_serialize() and +gst_meta_deserialize(). + Gets the global #GstMetaInfo describing the #GstReferenceTimestampMeta meta. - + line="2906">Gets the global #GstMetaInfo describing the #GstReferenceTimestampMeta meta. + The #GstMetaInfo + line="2911">The #GstMetaInfo @@ -57375,17 +57285,17 @@ removed at the end of initialization. c:identifier="gst_registry_fork_is_enabled"> By default GStreamer will perform scanning and rebuilding of the + line="1957">By default GStreamer will perform scanning and rebuilding of the registry file using a helper child process. Applications might want to disable this behaviour with the gst_registry_fork_set_enabled() function, in which case new plugins are scanned (and loaded) into the application process. - + %TRUE if GStreamer will use the child helper process when + line="1967">%TRUE if GStreamer will use the child helper process when rebuilding the registry. @@ -57394,10 +57304,10 @@ rebuilding the registry. c:identifier="gst_registry_fork_set_enabled"> Applications might want to disable/enable spawning of a child helper process + line="1976">Applications might want to disable/enable spawning of a child helper process when rebuilding the registry. See gst_registry_fork_is_enabled() for more information. - + @@ -57405,7 +57315,7 @@ information. whether rebuilding the registry can use a temporary child helper process. + line="1978">whether rebuilding the registry can use a temporary child helper process. @@ -57719,20 +57629,20 @@ MT safe. c:identifier="gst_registry_get_feature_list_cookie"> Returns the registry's feature list cookie. This changes + line="2045">Returns the registry's feature list cookie. This changes every time a feature is added or removed from the registry. the feature list cookie. + line="2052">the feature list cookie. the registry + line="2047">the registry @@ -58571,14 +58481,14 @@ gst_info_strdup_printf() to pretty-print signed time (pointers to introspectable="0"> Formats @t for the #GST_STIME_FORMAT format string. Note: @t will be + line="268">Formats @t for the #GST_STIME_FORMAT format string. Note: @t will be evaluated more than once. - + a #GstClockTimeDiff or #gint64 + line="270">a #GstClockTimeDiff or #gint64 @@ -58589,7 +58499,7 @@ evaluated more than once. introspectable="0"> A string that can be used in printf-like format strings to display a signed + line="252">A string that can be used in printf-like format strings to display a signed #GstClockTimeDiff or #gint64 value in `h:m:s` format. Use GST_TIME_ARGS() to construct the matching arguments. @@ -58598,7 +58508,7 @@ Example: ``` C printf("%" GST_STIME_FORMAT "\n", GST_STIME_ARGS(ts)); ``` - + @@ -58674,7 +58584,7 @@ printf("%" GST_STIME_FORMAT "\n", GST_STIME_ARGS(ts)); - + @@ -58683,7 +58593,7 @@ printf("%" GST_STIME_FORMAT "\n", GST_STIME_ARGS(ts)); - + @@ -58830,30 +58740,6 @@ Free-function: gst_sample_unref - - Create a copy of the given sample. This will also make a newly allocated -copy of the data the source sample contains. - - - a new copy of @sample. - - - - - a #GstSample. - - - - - - Increases the refcount of the given sample by one. - - - @sample - - - - - a #GstSample - - - - @@ -59113,24 +58979,6 @@ and @info must not have a parent set already. - - Decreases the refcount of the sample. If the refcount reaches 0, the -sample will be freed. - - - - - - - a #GstSample - - - - glib:name="GST_SERIALIZE_FLAG_NONE"> No special flags specified. + line="46">No special flags specified. glib:name="GST_SERIALIZE_FLAG_BACKWARD_COMPAT"> Serialize using the old format for + line="47">Serialize using the old format for nested structures. + + Serialization fails if a value cannot be serialized instead of using +placeholder "NULL" value (e.g. pointers, objects). + + default signal handler for the stream-notify signal @@ -61654,6 +61516,9 @@ The caller should not modify the returned #GstStream transfer-ownership="none" getter="get_upstream_id" default-value="NULL"> + stream-id @@ -61676,14 +61541,24 @@ The caller should not modify the returned #GstStream no-recurse="1" detailed="1" no-hooks="1"> + The stream notify signal is used to be notified of property changes to +streams within the collection. - + + the #GstStream that originated the signal - + + the property that changed @@ -61703,6 +61578,9 @@ The caller should not modify the returned #GstStream + default signal handler for the stream-notify signal @@ -62203,13 +62081,13 @@ a-struct, nested=[nested-struct, nested=true] ``` > *note*: gst_structure_to_string() won't use that syntax for backward -> compatibility reason, gst_structure_serialize() has been added for +> compatibility reason, gst_structure_serialize_full() has been added for > that purpose. - + the GType of a structure + line="119">the GType of a structure @@ -62218,16 +62096,16 @@ a-struct, nested=[nested-struct, nested=true] Creates a #GstStructure from a string representation. + line="2427">Creates a #GstStructure from a string representation. If end is not %NULL, a pointer to the place inside the given string where parsing ended will be returned. Free-function: gst_structure_free - + a new #GstStructure or %NULL + line="2438">a new #GstStructure or %NULL when the string could not be parsed. Free with gst_structure_free() after use. @@ -62236,7 +62114,7 @@ Free-function: gst_structure_free a string representation of a #GstStructure. + line="2429">a string representation of a #GstStructure. skip="1"> pointer to store the end of the string in. + line="2430">pointer to store the end of the string in. @@ -62264,7 +62142,7 @@ Variable arguments should be passed as field name, field type, and value. Last variable argument should be %NULL. Free-function: gst_structure_free - + See gst_structure_set_name() for constraints on the @name parameter. Free-function: gst_structure_free - + version="1.2"> Creates a #GstStructure from a string representation. + line="2400">Creates a #GstStructure from a string representation. If end is not %NULL, a pointer to the place inside the given string where parsing ended will be returned. @@ -62331,11 +62209,11 @@ the gst_structure_serialize() function is used (without #GST_SERIALIZE_FLAG_BACKWARD_COMPAT) Free-function: gst_structure_free - + a new #GstStructure or %NULL + line="2415">a new #GstStructure or %NULL when the string could not be parsed. Free with gst_structure_free() after use. @@ -62344,7 +62222,7 @@ Free-function: gst_structure_free a string representation of a #GstStructure + line="2402">a string representation of a #GstStructure @@ -62362,7 +62240,7 @@ gst_structure_new_id_empty() and gst_structure_id_set(). The last variable argument must be %NULL (or 0). Free-function: gst_structure_free - + line="297">Creates a new, empty #GstStructure with the given name as a GQuark. Free-function: gst_structure_free - + - + Tries intersecting @struct1 and @struct2 and reports whether the result + line="3269">Tries intersecting @struct1 and @struct2 and reports whether the result would not be empty. - + %TRUE if intersection would not be empty + line="3277">%TRUE if intersection would not be empty a #GstStructure + line="3271">a #GstStructure a #GstStructure + line="3272">a #GstStructure @@ -62486,7 +62364,7 @@ would not be empty. line="480">Duplicates a #GstStructure and all its fields and values. Free-function: gst_structure_free - + - + @@ -62547,9 +62425,9 @@ The structure must be mutable. Fixate all values in @structure using gst_value_fixate(). + line="3358">Fixate all values in @structure using gst_value_fixate(). @structure will be modified in-place and should be writable. - + @@ -62557,7 +62435,7 @@ The structure must be mutable. a #GstStructure + line="3360">a #GstStructure @@ -62565,25 +62443,25 @@ The structure must be mutable. Fixates a #GstStructure by changing the given field with its fixated value. - + line="2855">Fixates a #GstStructure by changing the given field with its fixated value. + %TRUE if the structure field could be fixated + line="2862">%TRUE if the structure field could be fixated a #GstStructure + line="2857">a #GstStructure a field in @structure + line="2858">a field in @structure @@ -62592,32 +62470,32 @@ The structure must be mutable. c:identifier="gst_structure_fixate_field_boolean"> Fixates a #GstStructure by changing the given @field_name field to the given + line="2643">Fixates a #GstStructure by changing the given @field_name field to the given @target boolean if that field is not fixed yet. - + %TRUE if the structure could be fixated + line="2652">%TRUE if the structure could be fixated a #GstStructure + line="2645">a #GstStructure a field in @structure + line="2646">a field in @structure the target value of the fixation + line="2647">the target value of the fixation @@ -62626,32 +62504,32 @@ The structure must be mutable. c:identifier="gst_structure_fixate_field_nearest_double"> Fixates a #GstStructure by changing the given field to the nearest + line="2578">Fixates a #GstStructure by changing the given field to the nearest double to @target that is a subset of the existing field. - + %TRUE if the structure could be fixated + line="2587">%TRUE if the structure could be fixated a #GstStructure + line="2580">a #GstStructure a field in @structure + line="2581">a field in @structure the target value of the fixation + line="2582">the target value of the fixation @@ -62660,39 +62538,39 @@ double to @target that is a subset of the existing field. c:identifier="gst_structure_fixate_field_nearest_fraction"> Fixates a #GstStructure by changing the given field to the nearest + line="2749">Fixates a #GstStructure by changing the given field to the nearest fraction to @target_numerator/@target_denominator that is a subset of the existing field. - + %TRUE if the structure could be fixated + line="2760">%TRUE if the structure could be fixated a #GstStructure + line="2751">a #GstStructure a field in @structure + line="2752">a field in @structure The numerator of the target value of the fixation + line="2753">The numerator of the target value of the fixation The denominator of the target value of the fixation + line="2754">The denominator of the target value of the fixation @@ -62701,32 +62579,32 @@ of the existing field. c:identifier="gst_structure_fixate_field_nearest_int"> Fixates a #GstStructure by changing the given field to the nearest + line="2508">Fixates a #GstStructure by changing the given field to the nearest integer to @target that is a subset of the existing field. - + %TRUE if the structure could be fixated + line="2517">%TRUE if the structure could be fixated a #GstStructure + line="2510">a #GstStructure a field in @structure + line="2511">a field in @structure the target value of the fixation + line="2512">the target value of the fixation @@ -62735,32 +62613,32 @@ integer to @target that is a subset of the existing field. c:identifier="gst_structure_fixate_field_string"> Fixates a #GstStructure by changing the given @field_name field to the given + line="2696">Fixates a #GstStructure by changing the given @field_name field to the given @target string if that field is not fixed yet. - + %TRUE if the structure could be fixated + line="2705">%TRUE if the structure could be fixated a #GstStructure + line="2698">a #GstStructure a field in @structure + line="2699">a field in @structure the target value of the fixation + line="2700">the target value of the fixation @@ -62771,7 +62649,7 @@ integer to @target that is a subset of the existing field. line="1335">Calls the provided function once for each field in the #GstStructure. The function must not modify the fields. Also see gst_structure_map_in_place() and gst_structure_filter_and_map_in_place(). - + filename="gst/gststructure.c" line="517">Frees a #GstStructure and all its fields and values. The structure must not have a parent when this function is called. - + @@ -62828,7 +62706,7 @@ have a parent when this function is called. Parses the variable arguments and reads fields from @structure accordingly. + line="3039">Parses the variable arguments and reads fields from @structure accordingly. Variable arguments should be in the form field name, field type (as a GType), pointer(s) to a variable(s) to hold the return value(s). The last variable argument should be %NULL. @@ -62837,11 +62715,11 @@ For refcounted (mini)objects you will receive a new reference which you must release with a suitable _unref\() when no longer needed. For strings and boxed types you will receive a copy which you will need to release with either g_free() or the suitable function for the boxed type. - + %FALSE if there was a problem reading any of the fields (e.g. + line="3055">%FALSE if there was a problem reading any of the fields (e.g. because the field requested did not exist, or was of a type other than the type specified), otherwise %TRUE. @@ -62850,19 +62728,19 @@ release with either g_free() or the suitable function for the boxed type. a #GstStructure + line="3041">a #GstStructure the name of the first field to read + line="3042">the name of the first field to read variable arguments + line="3043">variable arguments @@ -62872,15 +62750,15 @@ release with either g_free() or the suitable function for the boxed type. version="1.12"> This is useful in language bindings where unknown #GValue types are not + line="3400">This is useful in language bindings where unknown #GValue types are not supported. This function will convert the %GST_TYPE_ARRAY into a newly allocated #GValueArray and return it through @array. Be aware that this is slower then getting the #GValue directly. - + %TRUE if the value could be set correctly. If there was no field + line="3411">%TRUE if the value could be set correctly. If there was no field with @fieldname or the existing field did not contain a %GST_TYPE_ARRAY, this function returns %FALSE. @@ -62889,13 +62767,13 @@ this function returns %FALSE. a #GstStructure + line="3402">a #GstStructure the name of a field + line="3403">the name of a field transfer-ownership="full"> a pointer to a #GValueArray + line="3404">a pointer to a #GValueArray @@ -62915,7 +62793,7 @@ this function returns %FALSE. line="1544">Sets the boolean pointed to by @value corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. - + line="1799">Sets the clock time pointed to by @value corresponding to the clock time of the given field. Caller is responsible for making sure the field exists and has the correct type. - + - + - + line="1820">Sets the double pointed to by @value corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. - + line="1886">Sets the int pointed to by @value corresponding to the value of the given field. Caller is responsible for making sure the field exists, has the correct type and that the enumtype is correct. - + line="1270">Finds the field with the given name, and returns the type of the value it contains. If the field is not found, G_TYPE_INVALID is returned. - + version="1.22"> Sets the unsigned int pointed to by @value corresponding to the value of the + line="3517">Sets the unsigned int pointed to by @value corresponding to the value of the given field. Caller is responsible for making sure the field exists, has the correct type and that the flagstype is correct. - + %TRUE if the value could be set correctly. If there was no field + line="3528">%TRUE if the value could be set correctly. If there was no field with @fieldname or the existing field did not contain flags or did not contain flags of the given type, this function returns %FALSE. @@ -63210,19 +63088,19 @@ did not contain flags of the given type, this function returns %FALSE. a #GstStructure + line="3519">a #GstStructure the name of a field + line="3520">the name of a field the flags type of a field + line="3521">the flags type of a field transfer-ownership="full"> a pointer to an unsigned int to set + line="3522">a pointer to an unsigned int to set @@ -63243,7 +63121,7 @@ did not contain flags of the given type, this function returns %FALSE. filename="gst/gststructure.c" line="1961">Read the GstFlagSet flags and mask out of the structure into the provided pointers. - + line="1924">Sets the integers pointed to by @value_numerator and @value_denominator corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. - + line="1577">Sets the int pointed to by @value corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. - + line="1645">Sets the #gint64 pointed to by @value corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. - + version="1.12"> This is useful in language bindings where unknown #GValue types are not + line="3425">This is useful in language bindings where unknown #GValue types are not supported. This function will convert the %GST_TYPE_LIST into a newly allocated GValueArray and return it through @array. Be aware that this is slower then getting the #GValue directly. - + %TRUE if the value could be set correctly. If there was no field + line="3436">%TRUE if the value could be set correctly. If there was no field with @fieldname or the existing field did not contain a %GST_TYPE_LIST, this function returns %FALSE. @@ -63439,13 +63317,13 @@ function returns %FALSE. a #GstStructure + line="3427">a #GstStructure the name of a field + line="3428">the name of a field transfer-ownership="full"> a pointer to a #GValueArray + line="3429">a pointer to a #GValueArray @@ -63463,7 +63341,7 @@ function returns %FALSE. Get the name of @structure as a string. - + Get the name of @structure as a GQuark. - + - + line="1611">Sets the uint pointed to by @value corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. - + line="1681">Sets the #guint64 pointed to by @value corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. - + introspectable="0"> Parses the variable arguments and reads fields from @structure accordingly. + line="2904">Parses the variable arguments and reads fields from @structure accordingly. valist-variant of gst_structure_get(). Look at the documentation of gst_structure_get() for more details. - + %TRUE, or %FALSE if there was a problem reading any of the fields + line="2914">%TRUE, or %FALSE if there was a problem reading any of the fields a #GstStructure + line="2906">a #GstStructure the name of the first field to read + line="2907">the name of the first field to read variable arguments + line="2908">variable arguments @@ -63651,7 +63529,7 @@ gst_structure_get() for more details. Get the value of the field with name @fieldname. - + Check if @structure contains a field named @fieldname. - + Check if @structure contains a field named @fieldname and with GType @type. - + Checks if the structure has the given name - + introspectable="0"> Parses the variable arguments and reads fields from @structure accordingly. + line="3076">Parses the variable arguments and reads fields from @structure accordingly. Variable arguments should be in the form field id quark, field type (as a GType), pointer(s) to a variable(s) to hold the return value(s). The last variable argument should be %NULL (technically it should be a @@ -63779,11 +63657,11 @@ For refcounted (mini)objects you will receive a new reference which you must release with a suitable _unref\() when no longer needed. For strings and boxed types you will receive a copy which you will need to release with either g_free() or the suitable function for the boxed type. - + %FALSE if there was a problem reading any of the fields (e.g. + line="3098">%FALSE if there was a problem reading any of the fields (e.g. because the field requested did not exist, or was of a type other than the type specified), otherwise %TRUE. @@ -63792,19 +63670,19 @@ release with either g_free() or the suitable function for the boxed type. a #GstStructure + line="3078">a #GstStructure the quark of the first field to read + line="3079">the quark of the first field to read variable arguments + line="3080">variable arguments @@ -63814,33 +63692,33 @@ release with either g_free() or the suitable function for the boxed type. introspectable="0"> Parses the variable arguments and reads fields from @structure accordingly. + line="2971">Parses the variable arguments and reads fields from @structure accordingly. valist-variant of gst_structure_id_get(). Look at the documentation of gst_structure_id_get() for more details. - + %TRUE, or %FALSE if there was a problem reading any of the fields + line="2981">%TRUE, or %FALSE if there was a problem reading any of the fields a #GstStructure + line="2973">a #GstStructure the quark of the first field to read + line="2974">the quark of the first field to read variable arguments + line="2975">variable arguments @@ -63849,7 +63727,7 @@ gst_structure_id_get() for more details. Get the value of the field with GQuark @field. - + Check if @structure contains a field named @field. - + Check if @structure contains a field named @field and with GType @type. - + - + @@ -63972,7 +63850,7 @@ The last variable argument must be %NULL. va_list form of gst_structure_id_set(). - + @@ -64003,7 +63881,7 @@ The last variable argument must be %NULL. line="705">Sets the field with the given GQuark @field to @value. If the field does not exist, it is created. If the field exists, the previous value is replaced and freed. - + @@ -64034,7 +63912,7 @@ value is replaced and freed. line="769">Sets the field with the given GQuark @field to @value. If the field does not exist, it is created. If the field exists, the previous value is replaced and freed. - + @@ -64062,25 +63940,25 @@ value is replaced and freed. Intersects @struct1 and @struct2 and returns the intersection. - + line="3165">Intersects @struct1 and @struct2 and returns the intersection. + Intersection of @struct1 and @struct2 + line="3172">Intersection of @struct1 and @struct2 a #GstStructure + line="3167">a #GstStructure a #GstStructure + line="3168">a #GstStructure @@ -64088,25 +63966,25 @@ value is replaced and freed. Tests if the two #GstStructure are equal. - + line="3135">Tests if the two #GstStructure are equal. + %TRUE if the two structures have the same name and field. + line="3142">%TRUE if the two structures have the same name and field. a #GstStructure. + line="3137">a #GstStructure. a #GstStructure. + line="3138">a #GstStructure. @@ -64114,27 +63992,27 @@ value is replaced and freed. Checks if @subset is a subset of @superset, i.e. has the same + line="3295">Checks if @subset is a subset of @superset, i.e. has the same structure name and for all fields that are existing in @superset, @subset has a value that is a subset of the value in @superset. - + %TRUE if @subset is a subset of @superset + line="3304">%TRUE if @subset is a subset of @superset a #GstStructure + line="3297">a #GstStructure a potentially greater #GstStructure + line="3298">a potentially greater #GstStructure @@ -64145,7 +64023,7 @@ structure name and for all fields that are existing in @superset, line="1372">Calls the provided function once for each field in the #GstStructure. In contrast to gst_structure_foreach(), the function may modify but not delete the fields. The structure must be mutable. - + Get the number of fields in the structure. - + Get the name of the given field number, counting from 0 onwards. - + Removes all fields in a GstStructure. - + @@ -64250,7 +64128,7 @@ fields. The structure must be mutable. filename="gst/gststructure.c" line="1162">Removes the field with the given name. If the field with the given name does not exist, the structure is unchanged. - + @@ -64276,7 +64154,7 @@ name does not exist, the structure is unchanged. filename="gst/gststructure.c" line="1197">Removes the fields with the given names. If a field does not exist, the argument is ignored. - + @@ -64307,7 +64185,7 @@ argument is ignored. va_list form of gst_structure_remove_fields(). - + @@ -64334,22 +64212,58 @@ argument is ignored. + version="1.20" + deprecated="1"> Converts @structure to a human-readable string representation. + line="2213">Converts @structure to a human-readable string representation. This version of the caps serialization function introduces support for nested structures and caps but the resulting strings won't be parsable with GStreamer prior to 1.20 unless #GST_SERIALIZE_FLAG_BACKWARD_COMPAT is passed as @flag. +%GST_SERIALIZE_FLAG_STRICT flags is not allowed because it would make this +function nullable which is an API break for bindings. +Use gst_structure_serialize_full() instead. + Free-function: g_free - + Use gst_structure_serialize_full() instead. + a pointer to string allocated by g_malloc(). + line="2231">a pointer to string allocated by g_malloc(). + g_free() after usage. + + + + + a #GstStructure + + + + The flags to use to serialize structure + + + + + + Alias for gst_structure_serialize() but with nullable annotation because it +can return %NULL when %GST_SERIALIZE_FLAG_STRICT flag is set. + + + a pointer to string allocated by g_malloc(). g_free() after usage. @@ -64357,13 +64271,13 @@ Free-function: g_free a #GstStructure + line="2247">a #GstStructure The flags to use to serialize structure + line="2248">The flags to use to serialize structure @@ -64375,7 +64289,7 @@ Free-function: g_free weren't already part of the structure are added as needed. Variable arguments should be in the form field name, field type (as a GType), value(s). The last variable argument should be %NULL. - + @@ -64405,11 +64319,11 @@ Variable arguments should be in the form field name, field type version="1.12"> This is useful in language bindings where unknown GValue types are not + line="3477">This is useful in language bindings where unknown GValue types are not supported. This function will convert a @array to %GST_TYPE_ARRAY and set the field specified by @fieldname. Be aware that this is slower then using %GST_TYPE_ARRAY in a #GValue directly. - + @@ -64417,19 +64331,19 @@ the field specified by @fieldname. Be aware that this is slower then using a #GstStructure + line="3479">a #GstStructure the name of a field + line="3480">the name of a field a pointer to a #GValueArray + line="3481">a pointer to a #GValueArray @@ -64439,11 +64353,11 @@ the field specified by @fieldname. Be aware that this is slower then using version="1.12"> This is useful in language bindings where unknown GValue types are not + line="3497">This is useful in language bindings where unknown GValue types are not supported. This function will convert a @array to %GST_TYPE_LIST and set the field specified by @fieldname. Be aware that this is slower then using %GST_TYPE_LIST in a #GValue directly. - + @@ -64451,19 +64365,19 @@ the field specified by @fieldname. Be aware that this is slower then using a #GstStructure + line="3499">a #GstStructure the name of a field + line="3500">the name of a field a pointer to a #GValueArray + line="3501">a pointer to a #GValueArray @@ -64474,7 +64388,7 @@ the field specified by @fieldname. Be aware that this is slower then using line="674">Sets the name of the structure to the given @name. The string provided is copied before being used. It must not be empty, start with a letter and can be followed by letters, numbers and any of "/-_.:". - + @@ -64501,7 +64415,7 @@ letter and can be followed by letters, numbers and any of "/-_.:". determine whether a structure is mutable or not. This function should only be called by code implementing parent objects of #GstStructure, as described in the MT Refcounting section of the design documents. - + va_list form of gst_structure_set(). - + @@ -64560,7 +64474,7 @@ the MT Refcounting section of the design documents. line="727">Sets the field with the given name @field to @value. If the field does not exist, it is created. If the field exists, the previous value is replaced and freed. - + @@ -64591,7 +64505,7 @@ value is replaced and freed. line="790">Sets the field with the given name @field to @value. If the field does not exist, it is created. If the field exists, the previous value is replaced and freed. The function will take ownership of @value. - + @@ -64619,7 +64533,7 @@ value is replaced and freed. The function will take ownership of @value. Converts @structure to a human-readable string representation. + line="2187">Converts @structure to a human-readable string representation. For debugging purposes its easier to do something like this: |[<!-- language="C" --> GST_LOG ("structure is %" GST_PTR_FORMAT, structure); @@ -64628,14 +64542,14 @@ This prints the structure in human readable form. This function will lead to unexpected results when there are nested #GstCaps / #GstStructure deeper than one level, you should user -gst_structure_serialize() instead for those cases. +gst_structure_serialize_full() instead for those cases. Free-function: g_free - + a pointer to string allocated by g_malloc(). + line="2204">a pointer to string allocated by g_malloc(). g_free() after usage. @@ -64643,7 +64557,7 @@ Free-function: g_free a #GstStructure + line="2189">a #GstStructure @@ -64659,7 +64573,7 @@ Either @newstr and the value pointed to by @oldstr_ptr may be %NULL. It is a programming error if both @newstr and the value pointed to by @oldstr_ptr refer to the same, non-%NULL structure. - + A function that will be called in gst_structure_filter_and_map_in_place(). + line="100">A function that will be called in gst_structure_filter_and_map_in_place(). The function may modify @value, and the value will be removed from the structure if %FALSE is returned. - + %TRUE if the field should be preserved, %FALSE if it + line="110">%TRUE if the field should be preserved, %FALSE if it should be removed. @@ -64735,13 +64649,13 @@ should be removed. the #GQuark of the field name + line="102">the #GQuark of the field name the #GValue of the field + line="103">the #GValue of the field closure="2"> user data + line="104">user data @@ -64759,13 +64673,13 @@ should be removed. A function that will be called in gst_structure_foreach(). The function may + line="68">A function that will be called in gst_structure_foreach(). The function may not modify @value. - + %TRUE if the foreach operation should continue, %FALSE if + line="77">%TRUE if the foreach operation should continue, %FALSE if the foreach operation should stop with %FALSE. @@ -64773,13 +64687,13 @@ the foreach operation should stop with %FALSE. the #GQuark of the field name + line="70">the #GQuark of the field name the #GValue of the field + line="71">the #GValue of the field closure="2"> user data + line="72">user data @@ -64797,13 +64711,13 @@ the foreach operation should stop with %FALSE. A function that will be called in gst_structure_map_in_place(). The function + line="84">A function that will be called in gst_structure_map_in_place(). The function may modify @value. - + %TRUE if the map operation should continue, %FALSE if + line="93">%TRUE if the map operation should continue, %FALSE if the map operation should stop with %FALSE. @@ -64811,13 +64725,13 @@ the map operation should stop with %FALSE. the #GQuark of the field name + line="86">the #GQuark of the field name the #GValue of the field + line="87">the #GValue of the field closure="2"> user data + line="88">user data @@ -64854,14 +64768,14 @@ wait operations. Get a handle to the default system clock. The refcount of the + line="815">Get a handle to the default system clock. The refcount of the clock will be increased so you need to unref the clock after usage. the default clock. + line="822">the default clock. MT safe. @@ -64872,7 +64786,7 @@ MT safe. version="1.4"> Sets the default system clock that can be obtained with + line="776">Sets the default system clock that can be obtained with gst_system_clock_obtain(). This is mostly used for testing and debugging purposes when you @@ -64891,7 +64805,7 @@ MT safe. allow-none="1"> a #GstClock + line="778">a #GstClock @@ -65142,6 +65056,19 @@ attachment) + + Unique identifier for the audio, video or text track this tag is associated +with. The mappings for several container formats are defined in the [Sourcing +In-band Media Resource Tracks from Media Containers into HTML +specification](https://dev.w3.org/html5/html-sourcing-inband-tracks/). + + + @@ -65979,13 +65906,13 @@ only be used on pointers to GstClockTime values. introspectable="0"> Converts a struct timespec (see `man pselect`) to a #GstClockTime. - + line="196">Converts a struct timespec (see `man pselect`) to a #GstClockTime. + the timespec to convert + line="198">the timespec to convert @@ -66009,14 +65936,14 @@ only be used on pointers to GstClockTime values. introspectable="0"> Formats @t for the #GST_TIME_FORMAT format string. Note: @t will be + line="236">Formats @t for the #GST_TIME_FORMAT format string. Note: @t will be evaluated more than once. - + a #GstClockTime + line="238">a #GstClockTime @@ -66086,7 +66013,7 @@ evaluated more than once. introspectable="0"> A string that can be used in printf-like format strings to display a + line="222">A string that can be used in printf-like format strings to display a #GstClockTime value in `h:m:s` format. Use GST_TIME_ARGS() to construct the matching arguments. @@ -66095,7 +66022,7 @@ Example: ``` C printf("%" GST_TIME_FORMAT "\n", GST_TIME_ARGS(ts)); ``` - + Converts a #GstClockTime to a struct timespec (see `man pselect`) - + line="203">Converts a #GstClockTime to a struct timespec (see `man pselect`) + The #GstClockTime to convert + line="205">The #GstClockTime to convert The target timespec + line="206">The target timespec @@ -66125,10 +66052,11 @@ printf("%" GST_TIME_FORMAT "\n", GST_TIME_ARGS(ts)); filename="gst/gstclock.h" line="171">Converts a #GstClockTime to a GTimeVal -> on 32-bit systems, a timeval has a range of only 2^32 - 1 seconds, -> which is about 68 years. Expect trouble if you want to schedule stuff -> in your pipeline for 2038. - +> on many 32-bit systems, a timeval has a range of only 2^32 - 1 seconds, +> which is about 68 years. Expect trouble if you want to schedule stuff +> in your pipeline for 2038. This macro asserts that this case does not +> happen. + introspectable="0"> Creates a new taglist and appends the values for the given tags. It expects + line="763">Creates a new taglist and appends the values for the given tags. It expects tag-value pairs like gst_tag_list_add(), and a %NULL terminator after the last pair. The type of the values is implicit and is documented in the API reference, but can also be queried at runtime with gst_tag_get_type(). It @@ -66653,7 +66581,7 @@ Free-function: gst_tag_list_unref a new #GstTagList. Free with gst_tag_list_unref() + line="782">a new #GstTagList. Free with gst_tag_list_unref() when no longer needed. @@ -66661,13 +66589,13 @@ Free-function: gst_tag_list_unref tag + line="765">tag %NULL-terminated list of values to set + line="766">%NULL-terminated list of values to set @@ -66675,14 +66603,14 @@ Free-function: gst_tag_list_unref Creates a new empty GstTagList. + line="743">Creates a new empty GstTagList. Free-function: gst_tag_list_unref An empty tag list + line="750">An empty tag list @@ -66690,12 +66618,12 @@ Free-function: gst_tag_list_unref c:identifier="gst_tag_list_new_from_string"> Deserializes a tag list. + line="879">Deserializes a tag list. a new #GstTagList, or %NULL in case of an + line="885">a new #GstTagList, or %NULL in case of an error. @@ -66703,7 +66631,7 @@ error. a string created with gst_tag_list_to_string() + line="881">a string created with gst_tag_list_to_string() @@ -66713,7 +66641,7 @@ error. introspectable="0"> Just like gst_tag_list_new(), only that it takes a va_list argument. + line="801">Just like gst_tag_list_new(), only that it takes a va_list argument. Useful mostly for language bindings. Free-function: gst_tag_list_unref @@ -66721,7 +66649,7 @@ Free-function: gst_tag_list_unref a new #GstTagList. Free with gst_tag_list_unref() + line="810">a new #GstTagList. Free with gst_tag_list_unref() when no longer needed. @@ -66729,7 +66657,7 @@ Free-function: gst_tag_list_unref tag / value pairs to set + line="803">tag / value pairs to set @@ -66737,7 +66665,7 @@ Free-function: gst_tag_list_unref Sets the values for the given tags using the specified mode. + line="1216">Sets the values for the given tags using the specified mode. @@ -66746,25 +66674,25 @@ Free-function: gst_tag_list_unref list to set tags in + line="1218">list to set tags in the mode to use + line="1219">the mode to use tag + line="1220">tag %NULL-terminated list of values to set + line="1221">%NULL-terminated list of values to set @@ -66774,7 +66702,7 @@ Free-function: gst_tag_list_unref introspectable="0"> Sets the values for the given tags using the specified mode. + line="1266">Sets the values for the given tags using the specified mode. @@ -66783,25 +66711,25 @@ Free-function: gst_tag_list_unref list to set tags in + line="1268">list to set tags in the mode to use + line="1269">the mode to use tag + line="1270">tag tag / value pairs to set + line="1271">tag / value pairs to set @@ -66811,7 +66739,7 @@ Free-function: gst_tag_list_unref introspectable="0"> Sets the GValues for the given tags using the specified mode. + line="1320">Sets the GValues for the given tags using the specified mode. @@ -66820,25 +66748,25 @@ Free-function: gst_tag_list_unref list to set tags in + line="1322">list to set tags in the mode to use + line="1323">the mode to use tag + line="1324">tag tag / GValue pairs to set + line="1325">tag / GValue pairs to set @@ -66846,7 +66774,7 @@ Free-function: gst_tag_list_unref Sets the GValue for a given tag using the specified mode. + line="1356">Sets the GValue for a given tag using the specified mode. @@ -66855,25 +66783,25 @@ Free-function: gst_tag_list_unref list to set tags in + line="1358">list to set tags in the mode to use + line="1359">the mode to use tag + line="1360">tag GValue for this tag + line="1361">GValue for this tag @@ -66883,7 +66811,7 @@ Free-function: gst_tag_list_unref introspectable="0"> Sets the GValues for the given tags using the specified mode. + line="1241">Sets the GValues for the given tags using the specified mode. @@ -66892,25 +66820,25 @@ Free-function: gst_tag_list_unref list to set tags in + line="1243">list to set tags in the mode to use + line="1244">the mode to use tag + line="1245">tag GValues to set + line="1246">GValues to set @@ -66918,7 +66846,7 @@ Free-function: gst_tag_list_unref Creates a new #GstTagList as a copy of the old @taglist. The new taglist + line="2068">Creates a new #GstTagList as a copy of the old @taglist. The new taglist will have a refcount of 1, owned by the caller, and will be writable as a result. @@ -66931,14 +66859,14 @@ When you are finished with the taglist, call gst_tag_list_unref() on it. the new #GstTagList + line="2082">the new #GstTagList a #GstTagList. + line="2070">a #GstTagList. @@ -66946,7 +66874,7 @@ When you are finished with the taglist, call gst_tag_list_unref() on it. Calls the given function for each tag inside the tag list. Note that if there + line="1412">Calls the given function for each tag inside the tag list. Note that if there is no tag, the function won't be called at all. @@ -66956,7 +66884,7 @@ is no tag, the function won't be called at all. list to iterate over + line="1414">list to iterate over closure="1"> function to be called for each tag + line="1415">function to be called for each tag allow-none="1"> user specified data + line="1416">user specified data @@ -66982,13 +66910,13 @@ is no tag, the function won't be called at all. Copies the contents for the given tag into the value, merging multiple values + line="1566">Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1575">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -66996,13 +66924,13 @@ into one if multiple values are associated with the tag. a #GstTagList to get the tag from + line="1568">a #GstTagList to get the tag from tag to read out + line="1569">tag to read out transfer-ownership="full"> location for the result + line="1570">location for the result @@ -67020,13 +66948,13 @@ into one if multiple values are associated with the tag. c:identifier="gst_tag_list_get_boolean_index"> Gets the value that is at the given index for the given tag in the given + line="1578">Gets the value that is at the given index for the given tag in the given list. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1588">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67034,19 +66962,19 @@ list. a #GstTagList to get the tag from + line="1580">a #GstTagList to get the tag from tag to read out + line="1581">tag to read out number of entry to read out + line="1582">number of entry to read out transfer-ownership="full"> location for the result + line="1583">location for the result @@ -67063,7 +66991,7 @@ list. Copies the first date for the given tag in the taglist into the variable + line="1867">Copies the first date for the given tag in the taglist into the variable pointed to by @value. Free the date with g_date_free() when it is no longer needed. @@ -67072,7 +67000,7 @@ Free-function: g_date_free %TRUE, if a date was copied, %FALSE if the tag didn't exist in the + line="1880">%TRUE, if a date was copied, %FALSE if the tag didn't exist in the given list or if it was %NULL. @@ -67080,13 +67008,13 @@ Free-function: g_date_free a #GstTagList to get the tag from + line="1869">a #GstTagList to get the tag from tag to read out + line="1870">tag to read out transfer-ownership="full"> address of a GDate pointer + line="1871">address of a GDate pointer variable to store the result into @@ -67104,7 +67032,7 @@ Free-function: g_date_free Gets the date that is at the given index for the given tag in the given + line="1900">Gets the date that is at the given index for the given tag in the given list and copies it into the variable pointed to by @value. Free the date with g_date_free() when it is no longer needed. @@ -67113,7 +67041,7 @@ Free-function: g_date_free %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1913">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list or if it was %NULL. @@ -67121,19 +67049,19 @@ Free-function: g_date_free a #GstTagList to get the tag from + line="1902">a #GstTagList to get the tag from tag to read out + line="1903">tag to read out number of entry to read out + line="1904">number of entry to read out transfer-ownership="full"> location for the result + line="1905">location for the result @@ -67150,7 +67078,7 @@ Free-function: g_date_free Copies the first datetime for the given tag in the taglist into the variable + line="1932">Copies the first datetime for the given tag in the taglist into the variable pointed to by @value. Unref the date with gst_date_time_unref() when it is no longer needed. @@ -67159,7 +67087,7 @@ Free-function: gst_date_time_unref %TRUE, if a datetime was copied, %FALSE if the tag didn't exist in + line="1945">%TRUE, if a datetime was copied, %FALSE if the tag didn't exist in the given list or if it was %NULL. @@ -67167,13 +67095,13 @@ Free-function: gst_date_time_unref a #GstTagList to get the tag from + line="1934">a #GstTagList to get the tag from tag to read out + line="1935">tag to read out transfer-ownership="full"> address of a #GstDateTime + line="1936">address of a #GstDateTime pointer variable to store the result into @@ -67192,7 +67120,7 @@ Free-function: gst_date_time_unref c:identifier="gst_tag_list_get_date_time_index"> Gets the datetime that is at the given index for the given tag in the given + line="1966">Gets the datetime that is at the given index for the given tag in the given list and copies it into the variable pointed to by @value. Unref the datetime with gst_date_time_unref() when it is no longer needed. @@ -67201,7 +67129,7 @@ Free-function: gst_date_time_unref %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1979">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list or if it was %NULL. @@ -67209,19 +67137,19 @@ Free-function: gst_date_time_unref a #GstTagList to get the tag from + line="1968">a #GstTagList to get the tag from tag to read out + line="1969">tag to read out number of entry to read out + line="1970">number of entry to read out transfer-ownership="full"> location for the result + line="1971">location for the result @@ -67238,13 +67166,13 @@ Free-function: gst_date_time_unref Copies the contents for the given tag into the value, merging multiple values + line="1722">Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1731">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67252,13 +67180,13 @@ into one if multiple values are associated with the tag. a #GstTagList to get the tag from + line="1724">a #GstTagList to get the tag from tag to read out + line="1725">tag to read out transfer-ownership="full"> location for the result + line="1726">location for the result @@ -67276,13 +67204,13 @@ into one if multiple values are associated with the tag. c:identifier="gst_tag_list_get_double_index"> Gets the value that is at the given index for the given tag in the given + line="1734">Gets the value that is at the given index for the given tag in the given list. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1744">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67290,19 +67218,19 @@ list. a #GstTagList to get the tag from + line="1736">a #GstTagList to get the tag from tag to read out + line="1737">tag to read out number of entry to read out + line="1738">number of entry to read out transfer-ownership="full"> location for the result + line="1739">location for the result @@ -67319,13 +67247,13 @@ list. Copies the contents for the given tag into the value, merging multiple values + line="1696">Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1705">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67333,13 +67261,13 @@ into one if multiple values are associated with the tag. a #GstTagList to get the tag from + line="1698">a #GstTagList to get the tag from tag to read out + line="1699">tag to read out transfer-ownership="full"> location for the result + line="1700">location for the result @@ -67357,13 +67285,13 @@ into one if multiple values are associated with the tag. c:identifier="gst_tag_list_get_float_index"> Gets the value that is at the given index for the given tag in the given + line="1708">Gets the value that is at the given index for the given tag in the given list. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1718">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67371,19 +67299,19 @@ list. a #GstTagList to get the tag from + line="1710">a #GstTagList to get the tag from tag to read out + line="1711">tag to read out number of entry to read out + line="1712">number of entry to read out transfer-ownership="full"> location for the result + line="1713">location for the result @@ -67400,13 +67328,13 @@ list. Copies the contents for the given tag into the value, merging multiple values + line="1592">Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1601">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67414,13 +67342,13 @@ into one if multiple values are associated with the tag. a #GstTagList to get the tag from + line="1594">a #GstTagList to get the tag from tag to read out + line="1595">tag to read out transfer-ownership="full"> location for the result + line="1596">location for the result @@ -67437,13 +67365,13 @@ into one if multiple values are associated with the tag. Copies the contents for the given tag into the value, merging multiple values + line="1644">Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1653">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67451,13 +67379,13 @@ into one if multiple values are associated with the tag. a #GstTagList to get the tag from + line="1646">a #GstTagList to get the tag from tag to read out + line="1647">tag to read out transfer-ownership="full"> location for the result + line="1648">location for the result @@ -67475,13 +67403,13 @@ into one if multiple values are associated with the tag. c:identifier="gst_tag_list_get_int64_index"> Gets the value that is at the given index for the given tag in the given + line="1656">Gets the value that is at the given index for the given tag in the given list. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1666">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67489,19 +67417,19 @@ list. a #GstTagList to get the tag from + line="1658">a #GstTagList to get the tag from tag to read out + line="1659">tag to read out number of entry to read out + line="1660">number of entry to read out transfer-ownership="full"> location for the result + line="1661">location for the result @@ -67518,13 +67446,13 @@ list. Gets the value that is at the given index for the given tag in the given + line="1604">Gets the value that is at the given index for the given tag in the given list. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1614">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67532,19 +67460,19 @@ list. a #GstTagList to get the tag from + line="1606">a #GstTagList to get the tag from tag to read out + line="1607">tag to read out number of entry to read out + line="1608">number of entry to read out transfer-ownership="full"> location for the result + line="1609">location for the result @@ -67561,13 +67489,13 @@ list. Copies the contents for the given tag into the value, merging multiple values + line="1748">Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1757">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67575,13 +67503,13 @@ into one if multiple values are associated with the tag. a #GstTagList to get the tag from + line="1750">a #GstTagList to get the tag from tag to read out + line="1751">tag to read out nullable="1"> location for the result + line="1752">location for the result @@ -67600,13 +67528,13 @@ into one if multiple values are associated with the tag. c:identifier="gst_tag_list_get_pointer_index"> Gets the value that is at the given index for the given tag in the given + line="1760">Gets the value that is at the given index for the given tag in the given list. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1770">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67614,19 +67542,19 @@ list. a #GstTagList to get the tag from + line="1762">a #GstTagList to get the tag from tag to read out + line="1763">tag to read out number of entry to read out + line="1764">number of entry to read out nullable="1"> location for the result + line="1765">location for the result @@ -67644,7 +67572,7 @@ list. Copies the first sample for the given tag in the taglist into the variable + line="1998">Copies the first sample for the given tag in the taglist into the variable pointed to by @sample. Free the sample with gst_sample_unref() when it is no longer needed. You can retrieve the buffer from the sample using gst_sample_get_buffer() and the associated caps (if any) with @@ -67655,7 +67583,7 @@ Free-function: gst_sample_unref %TRUE, if a sample was returned, %FALSE if the tag didn't exist in + line="2013">%TRUE, if a sample was returned, %FALSE if the tag didn't exist in the given list or if it was %NULL. @@ -67663,13 +67591,13 @@ Free-function: gst_sample_unref a #GstTagList to get the tag from + line="2000">a #GstTagList to get the tag from tag to read out + line="2001">tag to read out transfer-ownership="full"> address of a GstSample + line="2002">address of a GstSample pointer variable to store the result into @@ -67688,7 +67616,7 @@ Free-function: gst_sample_unref c:identifier="gst_tag_list_get_sample_index"> Gets the sample that is at the given index for the given tag in the given + line="2033">Gets the sample that is at the given index for the given tag in the given list and copies it into the variable pointed to by @sample. Free the sample with gst_sample_unref() when it is no longer needed. You can retrieve the buffer from the sample using gst_sample_get_buffer() and the associated @@ -67699,7 +67627,7 @@ Free-function: gst_sample_unref %TRUE, if a sample was copied, %FALSE if the tag didn't exist in the + line="2049">%TRUE, if a sample was copied, %FALSE if the tag didn't exist in the given list or if it was %NULL. @@ -67707,19 +67635,19 @@ Free-function: gst_sample_unref a #GstTagList to get the tag from + line="2035">a #GstTagList to get the tag from tag to read out + line="2036">tag to read out number of entry to read out + line="2037">number of entry to read out transfer-ownership="full"> address of a GstSample + line="2038">address of a GstSample pointer variable to store the result into @@ -67737,19 +67665,19 @@ Free-function: gst_sample_unref Gets the scope of @list. + line="845">Gets the scope of @list. The scope of @list + line="851">The scope of @list a #GstTagList + line="847">a #GstTagList @@ -67757,7 +67685,7 @@ Free-function: gst_sample_unref Copies the contents for the given tag into the value, possibly merging + line="1787">Copies the contents for the given tag into the value, possibly merging multiple values into one if multiple values are associated with the tag. Use gst_tag_list_get_string_index (list, tag, 0, value) if you want @@ -67772,7 +67700,7 @@ Free-function: g_free %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1805">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67780,13 +67708,13 @@ Free-function: g_free a #GstTagList to get the tag from + line="1789">a #GstTagList to get the tag from tag to read out + line="1790">tag to read out transfer-ownership="full"> location for the result + line="1791">location for the result @@ -67804,7 +67732,7 @@ Free-function: g_free c:identifier="gst_tag_list_get_string_index"> Gets the value that is at the given index for the given tag in the given + line="1808">Gets the value that is at the given index for the given tag in the given list. The resulting string in @value will be in UTF-8 encoding and should be @@ -67816,7 +67744,7 @@ Free-function: g_free %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1824">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67824,19 +67752,19 @@ Free-function: g_free a #GstTagList to get the tag from + line="1810">a #GstTagList to get the tag from tag to read out + line="1811">tag to read out number of entry to read out + line="1812">number of entry to read out transfer-ownership="full"> location for the result + line="1813">location for the result @@ -67853,25 +67781,25 @@ Free-function: g_free Checks how many value are stored in this tag list for the given tag. + line="1191">Checks how many value are stored in this tag list for the given tag. The number of tags stored + line="1198">The number of tags stored a taglist + line="1193">a taglist the tag to query + line="1194">the tag to query @@ -67879,13 +67807,13 @@ Free-function: g_free Copies the contents for the given tag into the value, merging multiple values + line="1618">Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1627">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67893,13 +67821,13 @@ into one if multiple values are associated with the tag. a #GstTagList to get the tag from + line="1620">a #GstTagList to get the tag from tag to read out + line="1621">tag to read out transfer-ownership="full"> location for the result + line="1622">location for the result @@ -67916,13 +67844,13 @@ into one if multiple values are associated with the tag. Copies the contents for the given tag into the value, merging multiple values + line="1670">Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1679">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67930,13 +67858,13 @@ into one if multiple values are associated with the tag. a #GstTagList to get the tag from + line="1672">a #GstTagList to get the tag from tag to read out + line="1673">tag to read out transfer-ownership="full"> location for the result + line="1674">location for the result @@ -67954,13 +67882,13 @@ into one if multiple values are associated with the tag. c:identifier="gst_tag_list_get_uint64_index"> Gets the value that is at the given index for the given tag in the given + line="1682">Gets the value that is at the given index for the given tag in the given list. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1692">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -67968,19 +67896,19 @@ list. a #GstTagList to get the tag from + line="1684">a #GstTagList to get the tag from tag to read out + line="1685">tag to read out number of entry to read out + line="1686">number of entry to read out transfer-ownership="full"> location for the result + line="1687">location for the result @@ -67997,13 +67925,13 @@ list. Gets the value that is at the given index for the given tag in the given + line="1630">Gets the value that is at the given index for the given tag in the given list. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1640">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -68011,19 +67939,19 @@ list. a #GstTagList to get the tag from + line="1632">a #GstTagList to get the tag from tag to read out + line="1633">tag to read out number of entry to read out + line="1634">number of entry to read out transfer-ownership="full"> location for the result + line="1635">location for the result @@ -68041,13 +67969,13 @@ list. c:identifier="gst_tag_list_get_value_index"> Gets the value that is at the given index for the given tag in the given + line="1437">Gets the value that is at the given index for the given tag in the given list. The GValue for the specified + line="1446">The GValue for the specified entry or %NULL if the tag wasn't available or the tag doesn't have as many entries @@ -68056,19 +67984,19 @@ list. a #GstTagList + line="1439">a #GstTagList tag to read out + line="1440">tag to read out number of entry to read out + line="1441">number of entry to read out @@ -68076,7 +68004,7 @@ list. Inserts the tags of the @from list into the first list using the given mode. + line="1122">Inserts the tags of the @from list into the first list using the given mode. @@ -68085,19 +68013,19 @@ list. list to merge into + line="1124">list to merge into list to merge from + line="1125">list to merge from the mode to use + line="1126">the mode to use @@ -68105,19 +68033,19 @@ list. Checks if the given taglist is empty. + line="941">Checks if the given taglist is empty. %TRUE if the taglist is empty, otherwise %FALSE. + line="947">%TRUE if the taglist is empty, otherwise %FALSE. A #GstTagList. + line="943">A #GstTagList. @@ -68125,25 +68053,25 @@ list. Checks if the two given taglists are equal. + line="990">Checks if the two given taglists are equal. %TRUE if the taglists are equal, otherwise %FALSE + line="997">%TRUE if the taglists are equal, otherwise %FALSE a #GstTagList. + line="992">a #GstTagList. a #GstTagList. + line="993">a #GstTagList. @@ -68151,7 +68079,7 @@ list. Merges the two given lists into a new list. If one of the lists is %NULL, a + line="1150">Merges the two given lists into a new list. If one of the lists is %NULL, a copy of the other is returned. If both lists are %NULL, %NULL is returned. Free-function: gst_tag_list_unref @@ -68159,7 +68087,7 @@ Free-function: gst_tag_list_unref the new list + line="1161">the new list @@ -68169,7 +68097,7 @@ Free-function: gst_tag_list_unref allow-none="1"> first list to merge + line="1152">first list to merge allow-none="1"> second list to merge + line="1153">second list to merge the mode to use + line="1154">the mode to use @@ -68192,19 +68120,19 @@ Free-function: gst_tag_list_unref Get the number of tags in @list. + line="906">Get the number of tags in @list. The number of tags in @list. + line="912">The number of tags in @list. A #GstTagList. + line="908">A #GstTagList. @@ -68212,25 +68140,25 @@ Free-function: gst_tag_list_unref Get the name of the tag in @list at @index. + line="923">Get the name of the tag in @list at @index. The name of the tag at @index. + line="930">The name of the tag at @index. A #GstTagList. + line="925">A #GstTagList. the index + line="926">the index @@ -68239,7 +68167,7 @@ Free-function: gst_tag_list_unref c:identifier="gst_tag_list_peek_string_index"> Peeks at the value that is at the given index for the given tag in the given + line="1834">Peeks at the value that is at the given index for the given tag in the given list. The resulting string in @value will be in UTF-8 encoding and doesn't need @@ -68249,7 +68177,7 @@ be non-%NULL and non-empty. %TRUE, if a value was set, %FALSE if the tag didn't exist in the + line="1848">%TRUE, if a value was set, %FALSE if the tag didn't exist in the given list. @@ -68257,19 +68185,19 @@ be non-%NULL and non-empty. a #GstTagList to get the tag from + line="1836">a #GstTagList to get the tag from tag to read out + line="1837">tag to read out number of entry to read out + line="1838">number of entry to read out transfer-ownership="none"> location for the result + line="1839">location for the result - - Add a reference to a #GstTagList mini object. - -From this point on, until the caller calls gst_tag_list_unref() or -gst_tag_list_make_writable(), it is guaranteed that the taglist object will -not change. To use a #GstTagList object, you must always have a refcount on -it -- either the one made implicitly by e.g. gst_tag_list_new(), or via -taking one explicitly with this function. - - - the same #GstTagList mini object. - - - - - the #GstTagList to reference - - - - Removes the given tag from the taglist. + line="1377">Removes the given tag from the taglist. @@ -68321,13 +68223,13 @@ taking one explicitly with this function. list to remove tag from + line="1379">list to remove tag from tag to remove + line="1380">tag to remove @@ -68335,7 +68237,7 @@ taking one explicitly with this function. Sets the scope of @list to @scope. By default the scope + line="827">Sets the scope of @list to @scope. By default the scope of a taglist is stream scope. @@ -68345,13 +68247,13 @@ of a taglist is stream scope. a #GstTagList + line="829">a #GstTagList new scope for @list + line="830">new scope for @list @@ -68359,12 +68261,12 @@ of a taglist is stream scope. Serializes a tag list to a string. + line="861">Serializes a tag list to a string. a newly-allocated string. + line="867">a newly-allocated string. The string must be freed with g_free() when no longer needed. @@ -68373,34 +68275,15 @@ of a taglist is stream scope. a #GstTagList + line="863">a #GstTagList - - Unref a #GstTagList, and and free all its memory when the refcount reaches 0. - - - - - - - a #GstTagList. - - - - Copies the contents for the given tag into the value, + line="1474">Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. You must g_value_unset() the value after use. @@ -68408,7 +68291,7 @@ You must g_value_unset() the value after use. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1485">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -68419,103 +68302,23 @@ You must g_value_unset() the value after use. transfer-ownership="none"> uninitialized #GValue to copy into + line="1476">uninitialized #GValue to copy into list to get the tag from + line="1477">list to get the tag from tag to read out + line="1478">tag to read out - - Modifies a pointer to a #GstTagList to point to a different #GstTagList. The -modification is done atomically (so this is useful for ensuring thread -safety in some cases), and the reference counts are updated appropriately -(the old tag list is unreffed, the new is reffed). - -Either @new_taglist or the #GstTagList pointed to by @old_taglist may be -%NULL. - - - %TRUE if @new_taglist was different from @old_taglist - - - - - pointer to a pointer to a - #GstTagList to be replaced. - - - - pointer to a #GstTagList that - will replace the tag list pointed to by @old_taglist. - - - - - - Modifies a pointer to a #GstTagList to point to a different #GstTagList. -This function is similar to gst_tag_list_replace() except that it takes -ownership of @new_taglist. - - - %TRUE if @new_taglist was different from @old_taglist - - - - - pointer to a pointer to a #GstTagList - to be replaced. - - - - pointer to a #GstTagList that - will replace the taglist pointed to by @old_taglist. - - - - Create a new Task that will repeatedly call the provided @func + line="466">Create a new Task that will repeatedly call the provided @func with @user_data as a parameter. Typically the task will run in a new thread. @@ -69103,7 +68906,7 @@ gst_task_set_lock() function. This lock will always be acquired while A new #GstTask. + line="486">A new #GstTask. MT safe. @@ -69116,7 +68919,7 @@ MT safe. destroy="2"> The #GstTaskFunction to use + line="468">The #GstTaskFunction to use allow-none="1"> User data to pass to @func + line="469">User data to pass to @func the function to call when @user_data is no longer needed. + line="470">the function to call when @user_data is no longer needed. @@ -69139,7 +68942,7 @@ MT safe. Wait for all tasks to be stopped. This is mainly used internally + line="438">Wait for all tasks to be stopped. This is mainly used internally to ensure proper cleanup of internal data structures in test suites. MT safe. @@ -69151,7 +68954,7 @@ MT safe. Get the #GstTaskPool that this task will use for its streaming + line="545">Get the #GstTaskPool that this task will use for its streaming threads. MT safe. @@ -69159,7 +68962,7 @@ MT safe. the #GstTaskPool used by @task. gst_object_unref() + line="554">the #GstTaskPool used by @task. gst_object_unref() after usage. @@ -69167,7 +68970,7 @@ after usage. a #GstTask + line="547">a #GstTask @@ -69175,12 +68978,12 @@ after usage. Get the current state of the task. + line="683">Get the current state of the task. The #GstTaskState of the task + line="689">The #GstTaskState of the task MT safe. @@ -69189,7 +68992,7 @@ MT safe. The #GstTask to query + line="685">The #GstTask to query @@ -69197,7 +69000,7 @@ MT safe. Joins @task. After this call, it is safe to unref the task + line="896">Joins @task. After this call, it is safe to unref the task and clean up the lock set with gst_task_set_lock(). The task will automatically be stopped with this call. @@ -69209,7 +69012,7 @@ g_warning. %TRUE if the task could be joined. + line="909">%TRUE if the task could be joined. MT safe. @@ -69218,7 +69021,7 @@ MT safe. The #GstTask to join + line="898">The #GstTask to join @@ -69226,7 +69029,7 @@ MT safe. Pauses @task. This method can also be called on a task in the + line="851">Pauses @task. This method can also be called on a task in the stopped state, in which case a thread will be started and will remain in the paused state. This function does not wait for the task to complete the paused state. @@ -69234,7 +69037,7 @@ the paused state. %TRUE if the task could be paused. + line="860">%TRUE if the task could be paused. MT safe. @@ -69243,7 +69046,7 @@ MT safe. The #GstTask to pause + line="853">The #GstTask to pause @@ -69251,13 +69054,13 @@ MT safe. Resume @task in case it was paused. If the task was stopped, it will + line="870">Resume @task in case it was paused. If the task was stopped, it will remain in that state and this function will return %FALSE. %TRUE if the task could be resumed. + line="877">%TRUE if the task could be resumed. MT safe. @@ -69266,7 +69069,7 @@ MT safe. The #GstTask to resume + line="872">The #GstTask to resume @@ -69275,7 +69078,7 @@ MT safe. c:identifier="gst_task_set_enter_callback"> Call @enter_func when the task function of @task is entered. @user_data will + line="607">Call @enter_func when the task function of @task is entered. @user_data will be passed to @enter_func and @notify will be called when @user_data is no longer referenced. @@ -69286,7 +69089,7 @@ longer referenced. The #GstTask to use + line="609">The #GstTask to use destroy="2"> a #GstTaskThreadFunc + line="610">a #GstTaskThreadFunc allow-none="1"> user data passed to @enter_func + line="611">user data passed to @enter_func called when @user_data is no longer referenced + line="612">called when @user_data is no longer referenced @@ -69320,7 +69123,7 @@ longer referenced. c:identifier="gst_task_set_leave_callback"> Call @leave_func when the task function of @task is left. @user_data will + line="645">Call @leave_func when the task function of @task is left. @user_data will be passed to @leave_func and @notify will be called when @user_data is no longer referenced. @@ -69331,7 +69134,7 @@ longer referenced. The #GstTask to use + line="647">The #GstTask to use destroy="2"> a #GstTaskThreadFunc + line="648">a #GstTaskThreadFunc allow-none="1"> user data passed to @leave_func + line="649">user data passed to @leave_func called when @user_data is no longer referenced + line="650">called when @user_data is no longer referenced @@ -69364,7 +69167,7 @@ longer referenced. Set the mutex used by the task. The mutex will be acquired before + line="510">Set the mutex used by the task. The mutex will be acquired before calling the #GstTaskFunction. This function has to be called before calling gst_task_pause() or @@ -69379,13 +69182,13 @@ MT safe. The #GstTask to use + line="512">The #GstTask to use The #GRecMutex to use + line="513">The #GRecMutex to use @@ -69393,7 +69196,7 @@ MT safe. Set @pool as the new GstTaskPool for @task. Any new streaming threads that + line="574">Set @pool as the new GstTaskPool for @task. Any new streaming threads that will be created by @task will now use @pool. MT safe. @@ -69405,13 +69208,13 @@ MT safe. a #GstTask + line="576">a #GstTask a #GstTaskPool + line="577">a #GstTaskPool @@ -69419,7 +69222,7 @@ MT safe. Sets the state of @task to @state. + line="787">Sets the state of @task to @state. The @task must have a lock associated with it using gst_task_set_lock() when going to GST_TASK_STARTED or GST_TASK_PAUSED or @@ -69430,20 +69233,20 @@ MT safe. %TRUE if the state could be changed. + line="800">%TRUE if the state could be changed. a #GstTask + line="789">a #GstTask the new task state + line="790">the new task state @@ -69451,13 +69254,13 @@ MT safe. Starts @task. The @task must have a lock associated with it using + line="816">Starts @task. The @task must have a lock associated with it using gst_task_set_lock() or this function will return %FALSE. %TRUE if the task could be started. + line="823">%TRUE if the task could be started. MT safe. @@ -69466,7 +69269,7 @@ MT safe. The #GstTask to start + line="818">The #GstTask to start @@ -69474,14 +69277,14 @@ MT safe. Stops @task. This method merely schedules the task to stop and + line="833">Stops @task. This method merely schedules the task to stop and will not wait for the task to have completely stopped. Use gst_task_join() to stop and wait for completion. %TRUE if the task could be stopped. + line="841">%TRUE if the task could be stopped. MT safe. @@ -69490,7 +69293,7 @@ MT safe. The #GstTask to stop + line="835">The #GstTask to stop @@ -69940,6 +69743,9 @@ instead. + prepare the threadpool @@ -69956,6 +69762,9 @@ instead. + make sure all threads are stopped @@ -69972,6 +69781,9 @@ instead. + start a new thread @@ -70014,6 +69826,9 @@ instead. + join a thread @@ -71503,6 +71318,9 @@ events may contain values for different #GstPads. stream. + Method to peek data. @@ -71522,6 +71340,9 @@ stream. + Method to suggest #GstCaps with a given probability. @@ -71547,6 +71368,9 @@ stream. + Returns the length of current data. @@ -72189,12 +72013,12 @@ Source and Sink plugins should implement this interface when possible. Gets the currently handled URI. + line="761">Gets the currently handled URI. the URI currently handled by + line="767">the URI currently handled by the @handler. Returns %NULL if there are no URI currently handled. The returned string must be freed with g_free() when no longer needed. @@ -72204,7 +72028,7 @@ Source and Sink plugins should implement this interface when possible. A #GstURIHandler + line="763">A #GstURIHandler @@ -72212,25 +72036,25 @@ Source and Sink plugins should implement this interface when possible. Tries to set the URI of the given handler. + line="790">Tries to set the URI of the given handler. %TRUE if the URI was set successfully, else %FALSE. + line="799">%TRUE if the URI was set successfully, else %FALSE. A #GstURIHandler + line="792">A #GstURIHandler URI to set + line="793">URI to set @@ -72239,13 +72063,13 @@ Source and Sink plugins should implement this interface when possible. c:identifier="gst_uri_handler_get_protocols"> Gets the list of protocols supported by @handler. This list may not be + line="731">Gets the list of protocols supported by @handler. This list may not be modified. the + line="738">the supported protocols. Returns %NULL if the @handler isn't implemented properly, or the @handler doesn't support any protocols. @@ -72257,7 +72081,7 @@ modified. A #GstURIHandler. + line="733">A #GstURIHandler. @@ -72265,12 +72089,12 @@ modified. Gets the currently handled URI. + line="761">Gets the currently handled URI. the URI currently handled by + line="767">the URI currently handled by the @handler. Returns %NULL if there are no URI currently handled. The returned string must be freed with g_free() when no longer needed. @@ -72280,7 +72104,7 @@ modified. A #GstURIHandler + line="763">A #GstURIHandler @@ -72288,12 +72112,12 @@ modified. Gets the type of the given URI handler + line="704">Gets the type of the given URI handler the #GstURIType of the URI handler. + line="710">the #GstURIType of the URI handler. Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly. @@ -72301,7 +72125,7 @@ Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly. A #GstURIHandler. + line="706">A #GstURIHandler. @@ -72309,25 +72133,25 @@ Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly. Tries to set the URI of the given handler. + line="790">Tries to set the URI of the given handler. %TRUE if the URI was set successfully, else %FALSE. + line="799">%TRUE if the URI was set successfully, else %FALSE. A #GstURIHandler + line="792">A #GstURIHandler URI to set + line="793">URI to set @@ -72347,6 +72171,9 @@ Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly. + Method to tell whether the element handles source or sink URI. @@ -72360,6 +72187,9 @@ Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly. + Method to return the list of protocols handled by the element. @@ -72375,12 +72205,15 @@ Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly. + Method to return the URI currently handled by the element. the URI currently handled by + line="767">the URI currently handled by the @handler. Returns %NULL if there are no URI currently handled. The returned string must be freed with g_free() when no longer needed. @@ -72390,32 +72223,35 @@ Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly. A #GstURIHandler + line="763">A #GstURIHandler + Method to set a new URI. %TRUE if the URI was set successfully, else %FALSE. + line="799">%TRUE if the URI was set successfully, else %FALSE. A #GstURIHandler + line="792">A #GstURIHandler URI to set + line="793">URI to set @@ -72530,21 +72366,21 @@ Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly. c:symbol-prefix="uri"> A #GstUri object can be used to parse and split a URI string into its + line="971">A #GstUri object can be used to parse and split a URI string into its constituent parts. Two #GstUri objects can be joined to make a new #GstUri using the algorithm described in RFC3986. Creates a new #GstUri object with the given URI parts. The path and query + line="1438">Creates a new #GstUri object with the given URI parts. The path and query strings will be broken down into their elements. All strings should not be escaped except where indicated. A new #GstUri object. + line="1455">A new #GstUri object. @@ -72554,7 +72390,7 @@ escaped except where indicated. allow-none="1"> The scheme for the new URI. + line="1440">The scheme for the new URI. allow-none="1"> The user-info for the new URI. + line="1441">The user-info for the new URI. allow-none="1"> The host name for the new URI. + line="1442">The host name for the new URI. The port number for the new URI or %GST_URI_NO_PORT. + line="1443">The port number for the new URI or %GST_URI_NO_PORT. allow-none="1"> The path for the new URI with '/' separating path + line="1444">The path for the new URI with '/' separating path elements. @@ -72597,7 +72433,7 @@ escaped except where indicated. allow-none="1"> The query string for the new URI with '&' separating + line="1446">The query string for the new URI with '&' separating query elements. Elements containing '&' characters should encode them as "&percnt;26". @@ -72608,7 +72444,7 @@ escaped except where indicated. allow-none="1"> The fragment name for the new URI. + line="1449">The fragment name for the new URI. @@ -72618,13 +72454,13 @@ escaped except where indicated. version="1.6"> Append a path onto the end of the path in the URI. The path is not + line="2534">Append a path onto the end of the path in the URI. The path is not normalized, call #gst_uri_normalize() to normalize the path. %TRUE if the path was appended successfully. + line="2542">%TRUE if the path was appended successfully. @@ -72634,7 +72470,7 @@ normalized, call #gst_uri_normalize() to normalize the path. allow-none="1"> The #GstUri to modify. + line="2536">The #GstUri to modify. allow-none="1"> Relative path to append to the end of the current path. + line="2537">Relative path to append to the end of the current path. @@ -72653,12 +72489,12 @@ normalized, call #gst_uri_normalize() to normalize the path. version="1.6"> Append a single path segment onto the end of the URI path. + line="2572">Append a single path segment onto the end of the URI path. %TRUE if the path was appended successfully. + line="2579">%TRUE if the path was appended successfully. @@ -72668,7 +72504,7 @@ normalized, call #gst_uri_normalize() to normalize the path. allow-none="1"> The #GstUri to modify. + line="2574">The #GstUri to modify. allow-none="1"> The path segment string to append to the URI path. + line="2575">The path segment string to append to the URI path. - - Create a new #GstUri object with the same data as this #GstUri object. -If @uri is %NULL then returns %NULL. - - - A new #GstUri object which is a copy of this - #GstUri or %NULL. - - - - - This #GstUri object. - - - - Compares two #GstUri objects to see if they represent the same normalized + line="1718">Compares two #GstUri objects to see if they represent the same normalized URI. %TRUE if the normalized versions of the two URI's would be equal. + line="1726">%TRUE if the normalized versions of the two URI's would be equal. First #GstUri to compare. + line="1720">First #GstUri to compare. Second #GstUri to compare. + line="1721">Second #GstUri to compare. @@ -72736,12 +72550,12 @@ URI. version="1.6"> Like gst_uri_from_string() but also joins with a base URI. + line="1689">Like gst_uri_from_string() but also joins with a base URI. A new #GstUri object. + line="1696">A new #GstUri object. @@ -72751,13 +72565,13 @@ URI. allow-none="1"> The base URI to join the new URI with. + line="1691">The base URI to join the new URI with. The URI string to parse. + line="1692">The URI string to parse. @@ -72767,13 +72581,13 @@ URI. version="1.6"> Get the fragment name from the URI or %NULL if it doesn't exist. + line="2933">Get the fragment name from the URI or %NULL if it doesn't exist. If @uri is %NULL then returns %NULL. The host name from the #GstUri object or %NULL. + line="2940">The host name from the #GstUri object or %NULL. @@ -72783,7 +72597,7 @@ If @uri is %NULL then returns %NULL. allow-none="1"> This #GstUri object. + line="2935">This #GstUri object. @@ -72791,13 +72605,13 @@ If @uri is %NULL then returns %NULL. Get the host name from the URI or %NULL if it doesn't exist. + line="2264">Get the host name from the URI or %NULL if it doesn't exist. If @uri is %NULL then returns %NULL. The host name from the #GstUri object or %NULL. + line="2271">The host name from the #GstUri object or %NULL. @@ -72807,7 +72621,7 @@ If @uri is %NULL then returns %NULL. allow-none="1"> This #GstUri object. + line="2266">This #GstUri object. @@ -72817,7 +72631,7 @@ If @uri is %NULL then returns %NULL. version="1.12"> Get the media fragment table from the URI, as defined by "Media Fragments URI 1.0". + line="2978">Get the media fragment table from the URI, as defined by "Media Fragments URI 1.0". Hash table returned by this API is a list of "key-value" pairs, and the each pair is generated by splitting "URI fragment" per "&" sub-delims, then "key" and "value" are split by "=" sub-delims. The "key" returned by this API may @@ -72832,7 +72646,7 @@ See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frag The + line="2994">The fragment hash table from the URI. @@ -72846,7 +72660,7 @@ See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frag allow-none="1"> The #GstUri to get the fragment table from. + line="2980">The #GstUri to get the fragment table from. @@ -72854,12 +72668,12 @@ See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frag Extract the path string from the URI object. + line="2350">Extract the path string from the URI object. The path from the URI. Once finished + line="2356">The path from the URI. Once finished with the string should be g_free()'d. @@ -72870,7 +72684,7 @@ See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frag allow-none="1"> The #GstUri to get the path from. + line="2352">The #GstUri to get the path from. @@ -72880,12 +72694,12 @@ See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frag version="1.6"> Get a list of path segments from the URI. + line="2478">Get a list of path segments from the URI. A #GList of path segment + line="2484">A #GList of path segment strings or %NULL if no path segments are available. Free the list when no longer needed with g_list_free_full(list, g_free). @@ -72899,7 +72713,7 @@ See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frag allow-none="1"> The #GstUri to get the path from. + line="2480">The #GstUri to get the path from. @@ -72909,12 +72723,12 @@ See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frag version="1.6"> Extract the path string from the URI object as a percent encoded URI path. + line="2413">Extract the path string from the URI object as a percent encoded URI path. The path from the URI. Once finished + line="2419">The path from the URI. Once finished with the string should be g_free()'d. @@ -72925,7 +72739,7 @@ See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frag allow-none="1"> The #GstUri to get the path from. + line="2415">The #GstUri to get the path from. @@ -72933,13 +72747,13 @@ See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frag Get the port number from the URI or %GST_URI_NO_PORT if it doesn't exist. + line="2309">Get the port number from the URI or %GST_URI_NO_PORT if it doesn't exist. If @uri is %NULL then returns %GST_URI_NO_PORT. The port number from the #GstUri object or %GST_URI_NO_PORT. + line="2316">The port number from the #GstUri object or %GST_URI_NO_PORT. @@ -72949,7 +72763,7 @@ If @uri is %NULL then returns %GST_URI_NO_PORT. allow-none="1"> This #GstUri object. + line="2311">This #GstUri object. @@ -72959,12 +72773,12 @@ If @uri is %NULL then returns %GST_URI_NO_PORT. version="1.6"> Get a list of the query keys from the URI. + line="2910">Get a list of the query keys from the URI. A list of keys from + line="2916">A list of keys from the URI query. Free the list with g_list_free(). @@ -72977,7 +72791,7 @@ If @uri is %NULL then returns %GST_URI_NO_PORT. allow-none="1"> The #GstUri to examine. + line="2912">The #GstUri to examine. @@ -72987,12 +72801,12 @@ If @uri is %NULL then returns %GST_URI_NO_PORT. version="1.6"> Get a percent encoded URI query string from the @uri. + line="2600">Get a percent encoded URI query string from the @uri. A percent encoded query string. Use + line="2606">A percent encoded query string. Use g_free() when no longer needed. @@ -73003,7 +72817,7 @@ If @uri is %NULL then returns %GST_URI_NO_PORT. allow-none="1"> The #GstUri to get the query string from. + line="2602">The #GstUri to get the query string from. @@ -73013,7 +72827,7 @@ If @uri is %NULL then returns %GST_URI_NO_PORT. version="1.24"> Get a percent encoded URI query string from the @uri, with query parameters + line="2671">Get a percent encoded URI query string from the @uri, with query parameters in the order provided by the @keys list. Only parameter keys in the list will be added to the resulting URI string. This method can be used by retrieving the keys with gst_uri_get_query_keys() and then sorting the list, for @@ -73022,7 +72836,7 @@ example. A percent encoded query string. Use + line="2683">A percent encoded query string. Use g_free() when no longer needed. @@ -73033,7 +72847,7 @@ g_free() when no longer needed. allow-none="1"> The #GstUri to get the query string from. + line="2673">The #GstUri to get the query string from. allow-none="1"> A GList containing the + line="2674">A GList containing the query argument key strings. @@ -73055,7 +72869,7 @@ g_free() when no longer needed. version="1.6"> Get the query table from the URI. Keys and values in the table are freed + line="2732">Get the query table from the URI. Keys and values in the table are freed with g_free when they are deleted. A value may be %NULL to indicate that the key should appear in the query string in the URI, but does not have a value. Free the returned #GHashTable with #g_hash_table_unref() when it is @@ -73065,7 +72879,7 @@ URI. The query + line="2743">The query hash table from the URI. @@ -73079,7 +72893,7 @@ URI. allow-none="1"> The #GstUri to get the query table from. + line="2734">The #GstUri to get the query table from. @@ -73089,7 +72903,7 @@ URI. version="1.6"> Get the value associated with the @query_key key. Will return %NULL if the + line="2883">Get the value associated with the @query_key key. Will return %NULL if the key has no value or if the key does not exist in the URI query table. Because %NULL is returned for both missing keys and keys with no value, you should use gst_uri_query_has_key() to determine if a key is present in the URI @@ -73098,7 +72912,7 @@ query. The value for the given key, or %NULL if not found. + line="2894">The value for the given key, or %NULL if not found. @@ -73108,13 +72922,13 @@ query. allow-none="1"> The #GstUri to examine. + line="2885">The #GstUri to examine. The key to lookup. + line="2886">The key to lookup. @@ -73122,13 +72936,13 @@ query. Get the scheme name from the URI or %NULL if it doesn't exist. + line="2177">Get the scheme name from the URI or %NULL if it doesn't exist. If @uri is %NULL then returns %NULL. The scheme from the #GstUri object or %NULL. + line="2184">The scheme from the #GstUri object or %NULL. @@ -73138,7 +72952,7 @@ If @uri is %NULL then returns %NULL. allow-none="1"> This #GstUri object. + line="2179">This #GstUri object. @@ -73148,13 +72962,13 @@ If @uri is %NULL then returns %NULL. version="1.6"> Get the userinfo (usually in the form "username:password") from the URI + line="2220">Get the userinfo (usually in the form "username:password") from the URI or %NULL if it doesn't exist. If @uri is %NULL then returns %NULL. The userinfo from the #GstUri object or %NULL. + line="2227">The userinfo from the #GstUri object or %NULL. @@ -73164,7 +72978,7 @@ or %NULL if it doesn't exist. If @uri is %NULL then returns %NULL. allow-none="1"> This #GstUri object. + line="2222">This #GstUri object. @@ -73174,13 +72988,13 @@ or %NULL if it doesn't exist. If @uri is %NULL then returns %NULL. version="1.6"> Tests the @uri to see if it is normalized. A %NULL @uri is considered to be + line="2102">Tests the @uri to see if it is normalized. A %NULL @uri is considered to be normalized. TRUE if the URI is normalized or is %NULL. + line="2109">TRUE if the URI is normalized or is %NULL. @@ -73190,7 +73004,7 @@ normalized. allow-none="1"> The #GstUri to test to see if it is normalized. + line="2104">The #GstUri to test to see if it is normalized. @@ -73200,7 +73014,7 @@ normalized. version="1.6"> Check if it is safe to write to this #GstUri. + line="1954">Check if it is safe to write to this #GstUri. Check if the refcount of @uri is exactly 1, meaning that no other reference exists to the #GstUri and that the #GstUri is therefore writable. @@ -73211,14 +73025,14 @@ writable. %TRUE if it is safe to write to the object. + line="1966">%TRUE if it is safe to write to the object. The #GstUri object to test. + line="1956">The #GstUri object to test. @@ -73226,14 +73040,14 @@ writable. Join a reference URI onto a base URI using the method from RFC 3986. + line="1829">Join a reference URI onto a base URI using the method from RFC 3986. If either URI is %NULL then the other URI will be returned with the ref count increased. A #GstUri which represents the base + line="1839">A #GstUri which represents the base with the reference URI joined on. @@ -73244,7 +73058,7 @@ increased. allow-none="1"> The base URI to join another to. + line="1831">The base URI to join another to. allow-none="1"> The reference URI to join onto the + line="1832">The reference URI to join onto the base URI. @@ -73264,7 +73078,7 @@ increased. version="1.6"> Make the #GstUri writable. + line="1977">Make the #GstUri writable. Checks if @uri is writable, and if so the original object is returned. If not, then a writable copy is made and returned. This gives away the @@ -73274,14 +73088,14 @@ If @uri is %NULL then %NULL is returned. A writable version of @uri. + line="1988">A writable version of @uri. The #GstUri object to make writable. + line="1979">The #GstUri object to make writable. @@ -73291,12 +73105,12 @@ If @uri is %NULL then %NULL is returned. version="1.6"> Like gst_uri_new(), but joins the new URI onto a base URI. + line="1479">Like gst_uri_new(), but joins the new URI onto a base URI. The new URI joined onto @base. + line="1495">The new URI joined onto @base. @@ -73306,7 +73120,7 @@ If @uri is %NULL then %NULL is returned. allow-none="1"> The base URI to join the new URI to. + line="1481">The base URI to join the new URI to. allow-none="1"> The scheme for the new URI. + line="1482">The scheme for the new URI. allow-none="1"> The user-info for the new URI. + line="1483">The user-info for the new URI. allow-none="1"> The host name for the new URI. + line="1484">The host name for the new URI. The port number for the new URI or %GST_URI_NO_PORT. + line="1485">The port number for the new URI or %GST_URI_NO_PORT. allow-none="1"> The path for the new URI with '/' separating path + line="1486">The path for the new URI with '/' separating path elements. @@ -73358,7 +73172,7 @@ If @uri is %NULL then %NULL is returned. allow-none="1"> The query string for the new URI with '&' separating + line="1488">The query string for the new URI with '&' separating query elements. Elements containing '&' characters should encode them as "&percnt;26". @@ -73369,7 +73183,7 @@ If @uri is %NULL then %NULL is returned. allow-none="1"> The fragment name for the new URI. + line="1491">The fragment name for the new URI. @@ -73377,7 +73191,7 @@ If @uri is %NULL then %NULL is returned. Normalization will remove extra path segments ("." and "..") from the URI. It + line="2149">Normalization will remove extra path segments ("." and "..") from the URI. It will also convert the scheme and host name to lower case and any percent-encoded values to uppercase. @@ -73387,14 +73201,14 @@ gst_uri_make_writable() first. TRUE if the URI was modified. + line="2160">TRUE if the URI was modified. The #GstUri to normalize. + line="2151">The #GstUri to normalize. @@ -73404,12 +73218,12 @@ gst_uri_make_writable() first. version="1.6"> Check if there is a query table entry for the @query_key key. + line="2860">Check if there is a query table entry for the @query_key key. %TRUE if @query_key exists in the URI query table. + line="2867">%TRUE if @query_key exists in the URI query table. @@ -73419,49 +73233,28 @@ gst_uri_make_writable() first. allow-none="1"> The #GstUri to examine. + line="2862">The #GstUri to examine. The key to lookup. + line="2863">The key to lookup. - - Add a reference to this #GstUri object. See gst_mini_object_ref() for further -info. - - - This object with the reference count incremented. - - - - - This #GstUri object. - - - - Remove an entry from the query table by key. + line="2829">Remove an entry from the query table by key. %TRUE if the key existed in the table and was removed. + line="2836">%TRUE if the key existed in the table and was removed. @@ -73471,13 +73264,13 @@ info. allow-none="1"> The #GstUri to modify. + line="2831">The #GstUri to modify. The key to remove. + line="2832">The key to remove. @@ -73487,13 +73280,13 @@ info. version="1.6"> Sets the fragment string in the URI. Use a value of %NULL in @fragment to + line="2951">Sets the fragment string in the URI. Use a value of %NULL in @fragment to unset the fragment string. %TRUE if the fragment was set/unset successfully. + line="2959">%TRUE if the fragment was set/unset successfully. @@ -73503,7 +73296,7 @@ unset the fragment string. allow-none="1"> The #GstUri to modify. + line="2953">The #GstUri to modify. allow-none="1"> The fragment string to set. + line="2954">The fragment string to set. @@ -73520,12 +73313,12 @@ unset the fragment string. Set or unset the host for the URI. + line="2282">Set or unset the host for the URI. %TRUE if the host was set/unset successfully. + line="2289">%TRUE if the host was set/unset successfully. @@ -73535,13 +73328,13 @@ unset the fragment string. allow-none="1"> The #GstUri to modify. + line="2284">The #GstUri to modify. The new host string to set or %NULL to unset. + line="2285">The new host string to set or %NULL to unset. @@ -73549,12 +73342,12 @@ unset the fragment string. Sets or unsets the path in the URI. + line="2388">Sets or unsets the path in the URI. %TRUE if the path was set successfully. + line="2396">%TRUE if the path was set successfully. @@ -73564,7 +73357,7 @@ unset the fragment string. allow-none="1"> The #GstUri to modify. + line="2390">The #GstUri to modify. allow-none="1"> The new path to set with path segments separated by '/', or use %NULL + line="2391">The new path to set with path segments separated by '/', or use %NULL to unset the path. @@ -73584,12 +73377,12 @@ unset the fragment string. version="1.6"> Replace the path segments list in the URI. + line="2504">Replace the path segments list in the URI. %TRUE if the path segments were set successfully. + line="2512">%TRUE if the path segments were set successfully. @@ -73599,7 +73392,7 @@ unset the fragment string. allow-none="1"> The #GstUri to modify. + line="2506">The #GstUri to modify. allow-none="1"> The new + line="2507">The new path list to set. @@ -73621,12 +73414,12 @@ unset the fragment string. version="1.6"> Sets or unsets the path in the URI. + line="2454">Sets or unsets the path in the URI. %TRUE if the path was set successfully. + line="2462">%TRUE if the path was set successfully. @@ -73636,13 +73429,13 @@ unset the fragment string. allow-none="1"> The #GstUri to modify. + line="2456">The #GstUri to modify. The new percent encoded path to set with path segments separated by + line="2457">The new percent encoded path to set with path segments separated by '/', or use %NULL to unset the path. @@ -73651,12 +73444,12 @@ unset the fragment string. Set or unset the port number for the URI. + line="2327">Set or unset the port number for the URI. %TRUE if the port number was set/unset successfully. + line="2334">%TRUE if the port number was set/unset successfully. @@ -73666,13 +73459,13 @@ unset the fragment string. allow-none="1"> The #GstUri to modify. + line="2329">The #GstUri to modify. The new port number to set or %GST_URI_NO_PORT to unset. + line="2330">The new port number to set or %GST_URI_NO_PORT to unset. @@ -73682,12 +73475,12 @@ unset the fragment string. version="1.6"> Sets or unsets the query table in the URI. + line="2644">Sets or unsets the query table in the URI. %TRUE if the query table was set successfully. + line="2652">%TRUE if the query table was set successfully. @@ -73697,7 +73490,7 @@ unset the fragment string. allow-none="1"> The #GstUri to modify. + line="2646">The #GstUri to modify. allow-none="1"> The new percent encoded query string to use to populate the query + line="2647">The new percent encoded query string to use to populate the query table, or use %NULL to unset the query table. @@ -73717,14 +73510,14 @@ unset the fragment string. version="1.6"> Set the query table to use in the URI. The old table is unreferenced and a + line="2760">Set the query table to use in the URI. The old table is unreferenced and a reference to the new one is used instead. A value if %NULL for @query_table will remove the query string from the URI. %TRUE if the new table was successfully used for the query table. + line="2770">%TRUE if the new table was successfully used for the query table. @@ -73734,7 +73527,7 @@ will remove the query string from the URI. allow-none="1"> The #GstUri to modify. + line="2762">The #GstUri to modify. allow-none="1"> The new + line="2763">The new query table to use. @@ -73757,14 +73550,14 @@ will remove the query string from the URI. version="1.6"> This inserts or replaces a key in the query table. A @query_value of %NULL + line="2797">This inserts or replaces a key in the query table. A @query_value of %NULL indicates that the key has no associated value, but will still be present in the query string. %TRUE if the query table was successfully updated. + line="2807">%TRUE if the query table was successfully updated. @@ -73774,13 +73567,13 @@ the query string. allow-none="1"> The #GstUri to modify. + line="2799">The #GstUri to modify. The key for the query entry. + line="2800">The key for the query entry. allow-none="1"> The value for the key. + line="2801">The value for the key. @@ -73799,12 +73592,12 @@ the query string. version="1.6"> Set or unset the scheme for the URI. + line="2193">Set or unset the scheme for the URI. %TRUE if the scheme was set/unset successfully. + line="2200">%TRUE if the scheme was set/unset successfully. @@ -73814,13 +73607,13 @@ the query string. allow-none="1"> The #GstUri to modify. + line="2195">The #GstUri to modify. The new scheme to set or %NULL to unset the scheme. + line="2196">The new scheme to set or %NULL to unset the scheme. @@ -73830,12 +73623,12 @@ the query string. version="1.6"> Set or unset the user information for the URI. + line="2238">Set or unset the user information for the URI. %TRUE if the user information was set/unset successfully. + line="2245">%TRUE if the user information was set/unset successfully. @@ -73845,13 +73638,13 @@ the query string. allow-none="1"> The #GstUri to modify. + line="2240">The #GstUri to modify. The new user-information string to set or %NULL to unset. + line="2241">The new user-information string to set or %NULL to unset. @@ -73859,7 +73652,7 @@ the query string. Convert the URI to a string. + line="2082">Convert the URI to a string. Returns the URI as held in this object as a #gchar* nul-terminated string. The caller should g_free() the string once they are finished with it. @@ -73868,14 +73661,14 @@ The string is put together as described in RFC 3986. The string version of the URI. + line="2092">The string version of the URI. This #GstUri to convert to a string. + line="2084">This #GstUri to convert to a string. @@ -73885,7 +73678,7 @@ The string is put together as described in RFC 3986. version="1.24"> Convert the URI to a string, with the query arguments in a specific order. + line="2000">Convert the URI to a string, with the query arguments in a specific order. Only the keys in the @keys list will be added to the resulting string. Returns the URI as held in this object as a #gchar* nul-terminated string. @@ -73895,7 +73688,7 @@ The string is put together as described in RFC 3986. The string version of the URI. + line="2013">The string version of the URI. @@ -73905,7 +73698,7 @@ The string is put together as described in RFC 3986. allow-none="1"> This #GstUri to convert to a string. + line="2002">This #GstUri to convert to a string. allow-none="1"> A GList containing + line="2003">A GList containing the query argument key strings. @@ -73922,27 +73715,6 @@ The string is put together as described in RFC 3986. - - Decrement the reference count to this #GstUri object. - -If the reference count drops to 0 then finalize this object. - -See gst_mini_object_unref() for further info. - - - - - - - This #GstUri object. - - - - @@ -73979,20 +73751,20 @@ Free-function: g_free version="1.6"> Parses a URI string into a new #GstUri object. Will return NULL if the URI + line="1644">Parses a URI string into a new #GstUri object. Will return NULL if the URI cannot be parsed. A new #GstUri object, or NULL. + line="1651">A new #GstUri object, or NULL. The URI string to parse. + line="1646">The URI string to parse. @@ -74002,7 +73774,7 @@ cannot be parsed. version="1.18"> Parses a URI string into a new #GstUri object. Will return NULL if the URI + line="1661">Parses a URI string into a new #GstUri object. Will return NULL if the URI cannot be parsed. This is identical to gst_uri_from_string() except that the userinfo and fragment components of the URI will not be unescaped while parsing. @@ -74019,14 +73791,14 @@ https://example.com/path#fragment which may contain a URI-escaped '#'. A new #GstUri object, or NULL. + line="1679">A new #GstUri object, or NULL. The URI string to parse. + line="1663">The URI string to parse. @@ -74131,13 +73903,13 @@ scheme followed by ":" and maybe a string identifying the location. version="1.6"> This is a convenience function to join two URI strings and return the result. + line="1918">This is a convenience function to join two URI strings and return the result. The returned string should be g_free()'d after use. A string representing the percent-encoded join of + line="1926">A string representing the percent-encoded join of the two URIs. @@ -74145,13 +73917,13 @@ The returned string should be g_free()'d after use. The percent-encoded base URI. + line="1920">The percent-encoded base URI. The percent-encoded reference URI to join to the @base_uri. + line="1921">The percent-encoded reference URI to join to the @base_uri. @@ -74160,27 +73932,27 @@ The returned string should be g_free()'d after use. c:identifier="gst_uri_protocol_is_supported"> Checks if an element exists that supports the given URI protocol. Note + line="592">Checks if an element exists that supports the given URI protocol. Note that a positive return value does not imply that a subsequent call to gst_element_make_from_uri() is guaranteed to work. %TRUE + line="601">%TRUE Whether to check for a source or a sink + line="594">Whether to check for a source or a sink Protocol that should be checked for (e.g. "http" or "smb") + line="595">Protocol that should be checked for (e.g. "http" or "smb") @@ -74476,21 +74248,21 @@ determine a order for the two provided values. - + The micro version of GStreamer at compile time: - + The minor version of GStreamer at compile time: - + The nano version of GStreamer at compile time: @@ -74512,7 +74284,7 @@ Actual releases have 0, GIT versions have 1, prerelease versions have 2-... Appends @append_value to the GstValueArray in @value. + line="1008">Appends @append_value to the GstValueArray in @value. @@ -74521,13 +74293,13 @@ Actual releases have 0, GIT versions have 1, prerelease versions have 2-... a #GValue of type #GST_TYPE_ARRAY + line="1010">a #GValue of type #GST_TYPE_ARRAY the value to append + line="1011">the value to append @@ -74536,7 +74308,7 @@ Actual releases have 0, GIT versions have 1, prerelease versions have 2-... Appends @append_value to the GstValueArray in @value. + line="980">Appends @append_value to the GstValueArray in @value. @@ -74545,13 +74317,13 @@ Actual releases have 0, GIT versions have 1, prerelease versions have 2-... a #GValue of type #GST_TYPE_ARRAY + line="982">a #GValue of type #GST_TYPE_ARRAY the value to append + line="983">the value to append @@ -74559,19 +74331,19 @@ Actual releases have 0, GIT versions have 1, prerelease versions have 2-... Gets the number of values contained in @value. + line="1049">Gets the number of values contained in @value. the number of values + line="1055">the number of values a #GValue of type #GST_TYPE_ARRAY + line="1051">a #GValue of type #GST_TYPE_ARRAY @@ -74579,26 +74351,26 @@ Actual releases have 0, GIT versions have 1, prerelease versions have 2-... Gets the value that is a member of the array contained in @value and + line="1065">Gets the value that is a member of the array contained in @value and has the index @index. the value at the given index + line="1073">the value at the given index a #GValue of type #GST_TYPE_ARRAY + line="1067">a #GValue of type #GST_TYPE_ARRAY index of value to get from the array + line="1068">index of value to get from the array @@ -74633,7 +74405,7 @@ has the index @index. c:identifier="gst_value_array_prepend_value"> Prepends @prepend_value to the GstValueArray in @value. + line="1028">Prepends @prepend_value to the GstValueArray in @value. @@ -74642,13 +74414,13 @@ has the index @index. a #GValue of type #GST_TYPE_ARRAY + line="1030">a #GValue of type #GST_TYPE_ARRAY the value to prepend + line="1031">the value to prepend @@ -74754,7 +74526,7 @@ or GST_VALUE_UNORDERED version="1.2"> Appends @append_value to the GstValueList in @value. + line="679">Appends @append_value to the GstValueList in @value. @@ -74763,13 +74535,13 @@ or GST_VALUE_UNORDERED a #GValue of type #GST_TYPE_LIST + line="681">a #GValue of type #GST_TYPE_LIST the value to append + line="682">the value to append @@ -74777,7 +74549,7 @@ or GST_VALUE_UNORDERED Appends @append_value to the GstValueList in @value. + line="699">Appends @append_value to the GstValueList in @value. @@ -74786,13 +74558,13 @@ or GST_VALUE_UNORDERED a #GValue of type #GST_TYPE_LIST + line="701">a #GValue of type #GST_TYPE_LIST the value to append + line="702">the value to append @@ -74800,7 +74572,7 @@ or GST_VALUE_UNORDERED Concatenates copies of @value1 and @value2 into a list. Values that are not + line="741">Concatenates copies of @value1 and @value2 into a list. Values that are not of type #GST_TYPE_LIST are treated as if they were lists of length 1. @dest will be initialized to the type #GST_TYPE_LIST. @@ -74814,19 +74586,19 @@ of type #GST_TYPE_LIST are treated as if they were lists of length 1. transfer-ownership="none"> an uninitialized #GValue to take the result + line="743">an uninitialized #GValue to take the result a #GValue + line="744">a #GValue a #GValue + line="745">a #GValue @@ -74834,19 +74606,19 @@ of type #GST_TYPE_LIST are treated as if they were lists of length 1. Gets the number of values contained in @value. + line="945">Gets the number of values contained in @value. the number of values + line="951">the number of values a #GValue of type #GST_TYPE_LIST + line="947">a #GValue of type #GST_TYPE_LIST @@ -74854,26 +74626,26 @@ of type #GST_TYPE_LIST are treated as if they were lists of length 1. Gets the value that is a member of the list contained in @value and + line="961">Gets the value that is a member of the list contained in @value and has the index @index. the value at the given index + line="969">the value at the given index a #GValue of type #GST_TYPE_LIST + line="963">a #GValue of type #GST_TYPE_LIST index of value to get from the list + line="964">index of value to get from the list @@ -74907,7 +74679,7 @@ has the index @index. Merges copies of @value1 and @value2. Values that are not + line="844">Merges copies of @value1 and @value2. Values that are not of type #GST_TYPE_LIST are treated as if they were lists of length 1. The result will be put into @dest and will either be a list that will not @@ -74924,19 +74696,19 @@ were equal). transfer-ownership="none"> an uninitialized #GValue to take the result + line="846">an uninitialized #GValue to take the result a #GValue + line="847">a #GValue a #GValue + line="848">a #GValue @@ -74945,7 +74717,7 @@ were equal). c:identifier="gst_value_list_prepend_value"> Prepends @prepend_value to the GstValueList in @value. + line="720">Prepends @prepend_value to the GstValueList in @value. @@ -74954,13 +74726,13 @@ were equal). a #GValue of type #GST_TYPE_LIST + line="722">a #GValue of type #GST_TYPE_LIST the value to prepend + line="723">the value to prepend @@ -75388,89 +75160,6 @@ copy will otherwise be made using gst_buffer_list_copy(). - - Modifies a pointer to a #GstBufferList to point to a different -#GstBufferList. The modification is done atomically (so this is useful for -ensuring thread safety in some cases), and the reference counts are updated -appropriately (the old buffer list is unreffed, the new is reffed). - -Either @new_list or the #GstBufferList pointed to by @old_list may be %NULL. - - - %TRUE if @new_list was different from @old_list - - - - - pointer to a pointer to a - #GstBufferList to be replaced. - - - - pointer to a #GstBufferList that - will replace the buffer list pointed to by @old_list. - - - - - - Modifies a pointer to a #GstBufferList to point to a different -#GstBufferList. This function is similar to gst_buffer_list_replace() except -that it takes ownership of @new_list. - - - %TRUE if @new_list was different from @old_list - - - - - pointer to a pointer to a #GstBufferList - to be replaced. - - - - pointer to a #GstBufferList - that will replace the bufferlist pointed to by @old_list. - - - - @@ -75512,57 +75201,13 @@ you have an additional reference to it. - - Modifies a pointer to a #GstBuffer to point to a different #GstBuffer. The -modification is done atomically (so this is useful for ensuring thread safety -in some cases), and the reference counts are updated appropriately (the old -buffer is unreffed, the new is reffed). - -Either @nbuf or the #GstBuffer pointed to by @obuf may be %NULL. - - - %TRUE when @obuf was different from @nbuf. - - - - - pointer to a pointer to - a #GstBuffer to be replaced. - - - - pointer to a #GstBuffer that will - replace the buffer pointed to by @obuf. - - - - Calculates the linear regression of the values @xy and places the + line="4510">Calculates the linear regression of the values @xy and places the result in @m_num, @m_denom, @b and @xbase, representing the function y(x) = m_num/m_denom * (x - xbase) + b that has the least-square distance from all points @x and @y. @@ -75582,26 +75227,26 @@ amount of memory allocated as @xy, i.e. 2*n*sizeof(GstClockTime). %TRUE if the linear regression was successfully calculated + line="4538">%TRUE if the linear regression was successfully calculated Pairs of (x,y) values + line="4512">Pairs of (x,y) values Temporary scratch space used by the function + line="4513">Temporary scratch space used by the function number of (x,y) pairs + line="4514">number of (x,y) pairs numerator of calculated slope + line="4515">numerator of calculated slope denominator of calculated slope + line="4516">denominator of calculated slope Offset at Y-axis + line="4517">Offset at Y-axis Offset at X-axis + line="4518">Offset at X-axis R-squared + line="4519">R-squared @@ -75741,214 +75386,6 @@ also: gst_caps_ref(). - - Modifies a pointer to a #GstCaps to point to a different #GstCaps. The -modification is done atomically (so this is useful for ensuring thread safety -in some cases), and the reference counts are updated appropriately (the old -caps is unreffed, the new is reffed). - -Either @new_caps or the #GstCaps pointed to by @old_caps may be %NULL. - - - %TRUE if @new_caps was different from @old_caps - - - - - pointer to a pointer - to a #GstCaps to be replaced. - - - - pointer to a #GstCaps that will - replace the caps pointed to by @old_caps. - - - - - - Modifies a pointer to a #GstCaps to point to a different #GstCaps. This -function is similar to gst_caps_replace() except that it takes ownership -of @new_caps. - - - %TRUE if @new_caps was different from @old_caps - - - - - pointer to a pointer to a #GstCaps to be - replaced. - - - - pointer to a #GstCaps that will - replace the caps pointed to by @old_caps. - - - - - - Clears a reference to a #GstBuffer. - -@buf_ptr must not be %NULL. - -If the reference is %NULL then this function does nothing. Otherwise, the -reference count of the buffer is decreased and the pointer is set to %NULL. - - - - - - - a pointer to a #GstBuffer reference - - - - - - Clears a reference to a #GstBufferList. - -@list_ptr must not be %NULL. - -If the reference is %NULL then this function does nothing. Otherwise, the -reference count of the list is decreased and the pointer is set to %NULL. - - - - - - - a pointer to a #GstBufferList reference - - - - - - Clears a reference to a #GstCaps. - -@caps_ptr must not be %NULL. - -If the reference is %NULL then this function does nothing. Otherwise, the -reference count of the caps is decreased and the pointer is set to %NULL. - - - - - - - a pointer to a #GstCaps reference - - - - - - Clears a reference to a #GstEvent. - -@event_ptr must not be %NULL. - -If the reference is %NULL then this function does nothing. Otherwise, the -reference count of the event is decreased and the pointer is set to %NULL. - - - - - - - a pointer to a #GstEvent reference - - - - - - Clears a reference to a #GstMessage. - -@msg_ptr must not be %NULL. - -If the reference is %NULL then this function does nothing. Otherwise, the -reference count of the message is decreased and the pointer is set to %NULL. - - - - - - - a pointer to a #GstMessage reference - - - - introspectable="0"> Clears a reference to a #GstObject. + line="301">Clears a reference to a #GstObject. @object_ptr must not be %NULL. @@ -75994,7 +75431,7 @@ gst_object_unref() and the pointer is set to %NULL. A macro is also included that allows this function to be used without pointer casts. - + @@ -76002,61 +75439,11 @@ pointer casts. a pointer to a #GstObject reference + line="303">a pointer to a #GstObject reference - - Clears a reference to a #GstQuery. - -@query_ptr must not be %NULL. - -If the reference is %NULL then this function does nothing. Otherwise, the -reference count of the query is decreased and the pointer is set to %NULL. - - - - - - - a pointer to a #GstQuery reference - - - - - - Clears a reference to a #GstSample - -@sample_ptr must not be %NULL. - -If the reference is %NULL then this function does nothing. Otherwise, the -reference count of the sample is decreased and the pointer is set to %NULL. - - - - - - - a pointer to a #GstSample reference - - - - - + @@ -76086,69 +75473,19 @@ pointer casts. - - Clears a reference to a #GstTagList. - -@taglist_ptr must not be %NULL. - -If the reference is %NULL then this function does nothing. Otherwise, the -reference count of the taglist is decreased and the pointer is set to %NULL. - - - - - - - a pointer to a #GstTagList reference - - - - - - Clears a reference to a #GstUri. - -@uri_ptr must not be %NULL. - -If the reference is %NULL then this function does nothing. Otherwise, the -reference count of the uri is decreased and the pointer is set to %NULL. - - - - - - - a pointer to a #GstUri reference - - - - Tests if you can safely write into a context's structure or validly + line="88">Tests if you can safely write into a context's structure or validly modify the seqnum and timestamp fields. - + a #GstContext + line="90">a #GstContext @@ -76157,59 +75494,17 @@ modify the seqnum and timestamp fields. introspectable="0"> Checks if a context is writable. If not, a writable copy is made and + line="96">Checks if a context is writable. If not, a writable copy is made and returned. - + the context to make writable + line="98">the context to make writable - - Modifies a pointer to a #GstContext to point to a different #GstContext. The -modification is done atomically (so this is useful for ensuring thread safety -in some cases), and the reference counts are updated appropriately (the old -context is unreffed, the new one is reffed). - -Either @new_context or the #GstContext pointed to by @old_context may be %NULL. - - - %TRUE if @new_context was different from @old_context - - - - - pointer to a pointer to a #GstContext - to be replaced. - - - - pointer to a #GstContext that will - replace the context pointed to by @old_context. - - - - @@ -76261,7 +75556,7 @@ Be sure to use #G_GNUC_NO_INSTRUMENT on that function, it is needed. version="1.14"> Adds a memory ringbuffer based debug logger that stores up to + line="3721">Adds a memory ringbuffer based debug logger that stores up to @max_size_per_thread bytes of logs per thread and times out threads after @thread_timeout seconds of inactivity. @@ -76276,13 +75571,13 @@ Only one logger at a time is possible. Maximum size of log per thread in bytes + line="3723">Maximum size of log per thread in bytes Timeout for threads in seconds + line="3724">Timeout for threads in seconds @@ -76485,7 +75780,7 @@ The caller has to free the list after use. a stack trace, if libunwind or glibc backtrace are + line="3456">a stack trace, if libunwind or glibc backtrace are present, else %NULL. @@ -76493,7 +75788,7 @@ present, else %NULL. A set of #GstStackTraceFlags to determine how the stack trace should + line="3453">A set of #GstStackTraceFlags to determine how the stack trace should look like. Pass #GST_STACK_TRACE_SHOW_NONE to retrieve a minimal backtrace. @@ -77064,7 +76359,7 @@ would write out. c:identifier="gst_debug_print_stack_trace"> If libunwind, glibc backtrace or DbgHelp are present + line="3486">If libunwind, glibc backtrace or DbgHelp are present a stack trace is printed. @@ -77126,7 +76421,7 @@ a stack trace is printed. version="1.14"> Removes any previously added ring buffer logger with + line="3762">Removes any previously added ring buffer logger with gst_debug_add_ring_buffer_logger(). @@ -77138,13 +76433,13 @@ gst_debug_add_ring_buffer_logger(). version="1.14"> Fetches the current logs per thread from the ring buffer logger. See + line="3655">Fetches the current logs per thread from the ring buffer logger. See gst_debug_add_ring_buffer_logger() for details. NULL-terminated array of + line="3661">NULL-terminated array of strings with the debug output per thread @@ -77350,7 +76645,7 @@ This function is therefore mostly used by testsuites and other memory profiling tools. After this call GStreamer (including this method) should not be used anymore. - + @@ -77567,123 +76862,6 @@ otherwise be made using gst_event_copy(). - - Modifies a pointer to a #GstEvent to point to a different #GstEvent. The -modification is done atomically (so this is useful for ensuring thread safety -in some cases), and the reference counts are updated appropriately (the old -event is unreffed, the new one is reffed). - -Either @new_event or the #GstEvent pointed to by @old_event may be %NULL. - - - %TRUE if @new_event was different from @old_event - - - - - pointer to a - pointer to a #GstEvent to be replaced. - - - - pointer to a #GstEvent that will - replace the event pointed to by @old_event. - - - - - - Atomically replace the #GstEvent pointed to by @old_event with %NULL and -return the original event. - - - the #GstEvent that was in @old_event - - - - - pointer to a - pointer to a #GstEvent to be stolen. - - - - - - Modifies a pointer to a #GstEvent to point to a different #GstEvent. This -function is similar to gst_event_replace() except that it takes ownership of -@new_event. - -Either @new_event or the #GstEvent pointed to by @old_event may be %NULL. - - - %TRUE if @new_event was different from @old_event - - - - - pointer to a - pointer to a #GstEvent to be stolen. - - - - pointer to a #GstEvent that will - replace the event pointed to by @old_event. - - - - @@ -77780,7 +76958,7 @@ A lower value represents a higher-priority event. throws="1"> Similar to g_filename_to_uri(), but attempts to handle relative file paths + line="910">Similar to g_filename_to_uri(), but attempts to handle relative file paths as well. Before converting @filename into an URI, it will be prefixed by the current working directory if it is a relative path, and then the path will be canonicalised so that it doesn't contain any './' or '../' segments. @@ -77790,7 +76968,7 @@ On Windows @filename should be in UTF-8 encoding. newly-allocated URI string, or NULL on error. The caller must + line="922">newly-allocated URI string, or NULL on error. The caller must free the URI string with g_free() when no longer needed. @@ -77798,7 +76976,7 @@ On Windows @filename should be in UTF-8 encoding. absolute or relative file name path + line="912">absolute or relative file name path @@ -78040,7 +77218,7 @@ their set of features. When a plugin is initialized from the gst-plugin-scanner external process, the returned path will be the same as from the parent process. - + +frame. + +In addition to the #GstProtectionMeta demuxers signal encrypted streams with +specific caps. The caps #GstStructure name will usually depend on the +encryption scheme, for instance Common Encryption will be signaled with +`application/x-cenc`. To prevent loss of information the media type of the +decrypted stream will be stored in a `original-media-type` string field. +Downstream elements can re-use that information, for instance decryptors can +set their source pad caps according to the `original-media-type` received on +their sink pad. introspectable="0"> Allocates, fills and returns a 0-terminated string from the printf style + line="2934">Allocates, fills and returns a 0-terminated string from the printf style @format string and corresponding arguments. See gst_info_vasprintf() for when this function is required. @@ -78367,20 +77554,20 @@ Free with g_free(). a newly allocated null terminated string or %NULL on any error + line="2946">a newly allocated null terminated string or %NULL on any error a printf style format string + line="2936">a printf style format string the printf arguments for @format + line="2937">the printf arguments for @format @@ -78391,7 +77578,7 @@ Free with g_free(). introspectable="0"> Allocates, fills and returns a null terminated string from the printf style + line="2907">Allocates, fills and returns a null terminated string from the printf style @format string and @args. See gst_info_vasprintf() for when this function is required. @@ -78401,20 +77588,20 @@ Free with g_free(). a newly allocated null terminated string or %NULL on any error + line="2919">a newly allocated null terminated string or %NULL on any error a printf style format string + line="2909">a printf style format string the va_list of printf arguments for @format + line="2910">the va_list of printf arguments for @format @@ -78425,7 +77612,7 @@ Free with g_free(). introspectable="0"> Allocates and fills a string large enough (including the terminating null + line="2881">Allocates and fills a string large enough (including the terminating null byte) to hold the specified printf style @format and @args. This function deals with the GStreamer specific printf specifiers @@ -78438,7 +77625,7 @@ Free @result with g_free(). the length of the string allocated into @result or -1 on any error + line="2897">the length of the string allocated into @result or -1 on any error @@ -78448,19 +77635,19 @@ Free @result with g_free(). transfer-ownership="full"> the resulting string + line="2883">the resulting string a printf style format string + line="2884">a printf style format string the va_list of printf arguments for @format + line="2885">the va_list of printf arguments for @format @@ -78481,7 +77668,7 @@ for how to disable automatic registry updates. WARNING: This function will terminate your program if it was unable to initialize GStreamer for some reason. If you want your program to fall back, use gst_init_check() instead. - + @@ -78521,7 +77708,7 @@ registering built-in elements, and loading standard plugins. This function will return %FALSE if GStreamer could not be initialized for some reason. If you want your program to fail fatally, use gst_init() instead. - + - + Use this function to check if GStreamer has been initialized with gst_init() or gst_init_check(). - + - + Modifies a pointer to a #GstMessage to point to a different #GstMessage. The @@ -78764,7 +77951,7 @@ in some cases), and the reference counts are updated appropriately (the old message is unreffed, the new one is reffed). Either @new_message or the #GstMessage pointed to by @old_message may be %NULL. - + - - - Modifies a pointer to a #GstMessage to point to a different #GstMessage. This -function is similar to gst_message_replace() except that it takes ownership -of @new_message. - - - %TRUE if @new_message was different from @old_message - - - - - pointer to a pointer to a #GstMessage - to be replaced. - - - - pointer to a #GstMessage that - will replace the message pointed to by @old_message. - - - - + @@ -78883,11 +78031,11 @@ of @new_message. c:identifier="gst_meta_api_type_get_tags" moved-to="Meta.api_type_get_tags" version="1.2"> - + an array of tags as strings. + line="393">an array of tags as strings. @@ -78896,7 +78044,7 @@ of @new_message. an API + line="391">an API @@ -78906,25 +78054,25 @@ of @new_message. moved-to="Meta.api_type_has_tag"> Check if @api was registered with @tag. - + line="371">Check if @api was registered with @tag. + %TRUE if @api was registered with @tag. + line="378">%TRUE if @api was registered with @tag. an API + line="373">an API the tag to check + line="374">the tag to check @@ -78934,44 +78082,96 @@ of @new_message. moved-to="Meta.api_type_register"> Register and return a GType for the @api and associate it with + line="111">Register and return a GType for the @api and associate it with @tags. - + a unique GType for @api. + line="119">a unique GType for @api. an API to register + line="113">an API to register tags for @api + line="114">tags for @api + + Recreate a #GstMeta from serialized data returned by +gst_meta_serialize() and add it to @buffer. + +Note that the meta must have been previously registered by calling one of +`gst_*_meta_get_info ()` functions. + +@consumed is set to the number of bytes that can be skipped from @data to +find the next meta serialization, if any. In case of parsing error that does +not allow to determine that size, @consumed is set to 0. + + + the metadata owned by @buffer, or %NULL. + + + + + a #GstBuffer + + + + serialization data obtained from gst_meta_serialize() + + + + size of @data + + + + total size used by this meta, could be less than @size + + + + Lookup a previously registered meta info structure by its implementation name + line="563">Lookup a previously registered meta info structure by its implementation name @impl. - + a #GstMetaInfo with @impl, or + line="570">a #GstMetaInfo with @impl, or %NULL when no such metainfo exists. @@ -78979,25 +78179,91 @@ of @new_message. the name + line="565">the name + + Creates a new structure that needs to be filled before being +registered. This structure should filled and then registered with +gst_meta_info_register(). + +Example: +```c +const GstMetaInfo * +gst_my_meta_get_info (void) +{ + static const GstMetaInfo *meta_info = NULL; + + if (g_once_init_enter ((GstMetaInfo **) & meta_info)) { + GstMetaInfo *info = gst_meta_info_new ( + gst_my_meta_api_get_type (), + "GstMyMeta", + sizeof (GstMyMeta)); + const GstMetaInfo *meta = NULL; + + info->init_func = my_meta_init; + info->free_func = my_meta_free; + info->transform_func = my_meta_transform; + info->serialize_func = my_meta_serialize; + info->deserialize_func = my_meta_deserialize; + meta = gst_meta_info_register (info); + g_once_init_leave ((GstMetaInfo **) & meta_info, (GstMetaInfo *) meta); + } + + return meta_info; +} +``` + + + a new #GstMetaInfo that needs to be filled + + + + + the type of the #GstMeta API + + + + the name of the #GstMeta implementation + + + + the size of the #GstMeta structure + + + + + moved-to="Meta.register" + introspectable="0"> Register a new #GstMeta implementation. + line="437">Register a new #GstMeta implementation. The same @info can be retrieved later with gst_meta_get_info() by using @impl as the key. - + a #GstMetaInfo that can be used to + line="451">a #GstMetaInfo that can be used to access metadata. @@ -79005,39 +78271,37 @@ access metadata. the type of the #GstMeta API + line="439">the type of the #GstMeta API the name of the #GstMeta implementation + line="440">the name of the #GstMeta implementation the size of the #GstMeta structure + line="441">the size of the #GstMeta structure - + a #GstMetaInitFunction + line="442">a #GstMetaInitFunction - + a #GstMetaFreeFunction + line="443">a #GstMetaFreeFunction - + a #GstMetaTransformFunction + line="444">a #GstMetaTransformFunction @@ -79049,7 +78313,7 @@ access metadata. version="1.20"> Register a new custom #GstMeta implementation, backed by an opaque + line="271">Register a new custom #GstMeta implementation, backed by an opaque structure holding a #GstStructure. The registered info can be retrieved later with gst_meta_get_info() by using @@ -79062,11 +78326,11 @@ writability of the buffer the meta is attached to. When @transform_func is %NULL, the meta and its backing #GstStructure will always be copied when the transform operation is copy, other operations are discarded, copy regions are ignored. - + a #GstMetaInfo that can be used to + line="293">a #GstMetaInfo that can be used to access metadata. @@ -79074,13 +78338,13 @@ access metadata. the name of the #GstMeta implementation + line="273">the name of the #GstMeta implementation tags for @api + line="274">tags for @api @@ -79094,7 +78358,7 @@ access metadata. destroy="4"> a #GstMetaTransformFunction + line="275">a #GstMetaTransformFunction @@ -79104,17 +78368,41 @@ access metadata. allow-none="1"> user data passed to @transform_func + line="276">user data passed to @transform_func #GDestroyNotify for user_data + line="277">#GDestroyNotify for user_data + + Simplified version of gst_meta_register_custom(), with no tags and no +transform function. + + + a #GstMetaInfo that can be used to access metadata. + + + + + the name of the #GstMeta implementation + + + + @@ -79235,15 +78523,15 @@ Either @newdata and the value pointed to by @olddata may be %NULL. introspectable="0"> Get a copy of the name of the pad. g_free() after usage. + line="1325">Get a copy of the name of the pad. g_free() after usage. MT safe. - + the pad to get the name from + line="1327">the pad to get the name from @@ -79252,17 +78540,17 @@ MT safe. introspectable="0"> Get the parent of @pad. This function increases the refcount + line="1334">Get the parent of @pad. This function increases the refcount of the parent object so you should gst_object_unref() it after usage. Can return %NULL if the pad did not have a parent. MT safe. - + the pad to get the parent of + line="1336">the pad to get the parent of @@ -79271,19 +78559,19 @@ MT safe. moved-to="PadMode.get_name"> Return the name of a pad mode, for use in debug messages mostly. + line="951">Return the name of a pad mode, for use in debug messages mostly. short mnemonic for pad mode @mode + line="957">short mnemonic for pad mode @mode the pad mode + line="953">the pad mode @@ -79302,19 +78590,19 @@ MT safe. introspectable="0"> Calls gst_pad_set_activate_function_full() with %NULL for the user_data and + line="1711">Calls gst_pad_set_activate_function_full() with %NULL for the user_data and notify. - + a #GstPad. + line="1713">a #GstPad. the #GstPadActivateFunction to set. + line="1714">the #GstPadActivateFunction to set. @@ -79323,19 +78611,19 @@ notify. introspectable="0"> Calls gst_pad_set_activatemode_function_full() with %NULL for the user_data and + line="1748">Calls gst_pad_set_activatemode_function_full() with %NULL for the user_data and notify. - + a #GstPad. + line="1750">a #GstPad. the #GstPadActivateModeFunction to set. + line="1751">the #GstPadActivateModeFunction to set. @@ -79344,19 +78632,19 @@ notify. introspectable="0"> Calls gst_pad_set_chain_function_full() with %NULL for the user_data and + line="1783">Calls gst_pad_set_chain_function_full() with %NULL for the user_data and notify. - + a sink #GstPad. + line="1785">a sink #GstPad. the #GstPadChainFunction to set. + line="1786">the #GstPadChainFunction to set. @@ -79365,19 +78653,19 @@ notify. introspectable="0"> Calls gst_pad_set_chain_list_function_full() with %NULL for the user_data and + line="1818">Calls gst_pad_set_chain_list_function_full() with %NULL for the user_data and notify. - + a sink #GstPad. + line="1820">a sink #GstPad. the #GstPadChainListFunction to set. + line="1821">the #GstPadChainListFunction to set. @@ -79386,19 +78674,19 @@ notify. introspectable="0"> Calls gst_pad_set_event_full_function_full() with %NULL for the user_data and + line="1935">Calls gst_pad_set_event_full_function_full() with %NULL for the user_data and notify. - + a #GstPad of either direction. + line="1937">a #GstPad of either direction. the #GstPadEventFullFunction to set. + line="1938">the #GstPadEventFullFunction to set. @@ -79407,19 +78695,19 @@ notify. introspectable="0"> Calls gst_pad_set_event_function_full() with %NULL for the user_data and + line="1891">Calls gst_pad_set_event_function_full() with %NULL for the user_data and notify. - + a #GstPad of either direction. + line="1893">a #GstPad of either direction. the #GstPadEventFunction to set. + line="1894">the #GstPadEventFunction to set. @@ -79428,19 +78716,19 @@ notify. introspectable="0"> Calls gst_pad_set_getrange_function_full() with %NULL for the user_data and + line="1855">Calls gst_pad_set_getrange_function_full() with %NULL for the user_data and notify. - + a source #GstPad. + line="1857">a source #GstPad. the #GstPadGetRangeFunction to set. + line="1858">the #GstPadGetRangeFunction to set. @@ -79449,19 +78737,19 @@ notify. introspectable="0"> Calls gst_pad_set_iterate_internal_links_function_full() with %NULL + line="2004">Calls gst_pad_set_iterate_internal_links_function_full() with %NULL for the user_data and notify. - + a #GstPad of either direction. + line="2006">a #GstPad of either direction. the #GstPadIterIntLinkFunction to set. + line="2007">the #GstPadIterIntLinkFunction to set. @@ -79470,19 +78758,19 @@ for the user_data and notify. introspectable="0"> Calls gst_pad_set_link_function_full() with %NULL + line="2038">Calls gst_pad_set_link_function_full() with %NULL for the user_data and notify. - + a #GstPad. + line="2040">a #GstPad. the #GstPadLinkFunction to set. + line="2041">the #GstPadLinkFunction to set. @@ -79491,19 +78779,19 @@ for the user_data and notify. introspectable="0"> Calls gst_pad_set_query_function_full() with %NULL for the user_data and + line="1971">Calls gst_pad_set_query_function_full() with %NULL for the user_data and notify. - + a #GstPad of either direction. + line="1973">a #GstPad of either direction. the #GstPadQueryFunction to set. + line="1974">the #GstPadQueryFunction to set. @@ -79512,19 +78800,19 @@ notify. introspectable="0"> Calls gst_pad_set_unlink_function_full() with %NULL + line="2081">Calls gst_pad_set_unlink_function_full() with %NULL for the user_data and notify. - + a #GstPad. + line="2083">a #GstPad. the #GstPadUnlinkFunction to set. + line="2084">the #GstPadUnlinkFunction to set. @@ -80078,7 +79366,7 @@ system presets. introspectable="0"> Outputs a formatted message via the GLib print handler. The default print + line="2963">Outputs a formatted message via the GLib print handler. The default print handler simply outputs the message to stdout. This function will not append a new-line character at the end, unlike @@ -80099,13 +79387,13 @@ This function is primarily for printing debug output. a printf style format string + line="2965">a printf style format string the printf arguments for @format + line="2966">the printf arguments for @format @@ -80116,7 +79404,7 @@ This function is primarily for printing debug output. introspectable="0"> Outputs a formatted message via the GLib error message handler. The default + line="3049">Outputs a formatted message via the GLib error message handler. The default handler simply outputs the message to stderr. This function will not append a new-line character at the end, unlike @@ -80137,13 +79425,13 @@ This function is primarily for printing debug output. a printf style format string + line="3051">a printf style format string the printf arguments for @format + line="3052">the printf arguments for @format @@ -80154,7 +79442,7 @@ This function is primarily for printing debug output. introspectable="0"> Outputs a formatted message via the GLib error message handler. The default + line="3092">Outputs a formatted message via the GLib error message handler. The default handler simply outputs the message to stderr. This function will append a new-line character at the end, unlike @@ -80175,13 +79463,13 @@ This function is primarily for printing debug output. a printf style format string + line="3094">a printf style format string the printf arguments for @format + line="3095">the printf arguments for @format @@ -80192,7 +79480,7 @@ This function is primarily for printing debug output. introspectable="0"> Outputs a formatted message via the GLib print handler. The default print + line="3006">Outputs a formatted message via the GLib print handler. The default print handler simply outputs the message to stdout. This function will append a new-line character at the end, unlike @@ -80213,13 +79501,13 @@ This function is primarily for printing debug output. a printf style format string + line="3008">a printf style format string the printf arguments for @format + line="3009">the printf arguments for @format @@ -80229,13 +79517,13 @@ This function is primarily for printing debug output. version="1.14"> Iterates the supplied list of UUIDs and checks the GstRegistry for + line="205">Iterates the supplied list of UUIDs and checks the GstRegistry for all the decryptors supporting one of the supplied UUIDs. + line="214"> A null terminated array containing all the @system_identifiers supported by the set of available decryptors, or %NULL if no matches were found. @@ -80247,7 +79535,7 @@ the @system_identifiers supported by the set of available decryptors, or + line="207"> A null terminated array of strings that contains the UUID values of each protection system that is to be checked. @@ -80277,14 +79565,14 @@ protection system that is to be checked. version="1.6"> Iterates the supplied list of UUIDs and checks the GstRegistry for + line="167">Iterates the supplied list of UUIDs and checks the GstRegistry for an element that supports one of the supplied UUIDs. If more than one element matches, the system ID of the highest ranked element is selected. One of the strings from + line="177">One of the strings from @system_identifiers that indicates the highest ranked element that implements the protection system indicated by that system ID, or %NULL if no element has been found. @@ -80294,7 +79582,7 @@ element has been found. A null terminated array of strings + line="169">A null terminated array of strings that contains the UUID values of each protection system that is to be checked. @@ -80333,111 +79621,24 @@ checked. - - Modifies a pointer to a #GstQuery to point to a different #GstQuery. The -modification is done atomically (so this is useful for ensuring thread safety -in some cases), and the reference counts are updated appropriately (the old -query is unreffed, the new one is reffed). - -Either @new_query or the #GstQuery pointed to by @old_query may be %NULL. - - - %TRUE if @new_query was different from @old_query - - - - - pointer to a pointer to a - #GstQuery to be replaced. - - - - pointer to a #GstQuery that will - replace the query pointed to by @old_query. - - - - - - Modifies a pointer to a #GstQuery to point to a different #GstQuery. This -function is similar to gst_query_replace() except that it takes ownership of -@new_query. - -Either @new_query or the #GstQuery pointed to by @old_query may be %NULL. - - - %TRUE if @new_query was different from @old_query - - - - - pointer to a - pointer to a #GstQuery to be stolen. - - - - pointer to a #GstQuery that will - replace the query pointed to by @old_query. - - - - Gets the #GstQueryTypeFlags associated with @type. + line="170">Gets the #GstQueryTypeFlags associated with @type. a #GstQueryTypeFlags. + line="176">a #GstQueryTypeFlags. a #GstQueryType + line="172">a #GstQueryType @@ -80447,19 +79648,19 @@ Either @new_query or the #GstQuery pointed to by @old_query may be %NULL. moved-to="QueryType.get_name"> Get a printable name for the given query type. Do not modify or free. + line="130">Get a printable name for the given query type. Do not modify or free. a reference to the static name of the query. + line="136">a reference to the static name of the query. the query type + line="132">the query type @@ -80469,19 +79670,19 @@ Either @new_query or the #GstQuery pointed to by @old_query may be %NULL. moved-to="QueryType.to_quark"> Get the unique quark for the given query type. + line="150">Get the unique quark for the given query type. the quark associated with the query type + line="156">the quark associated with the query type the query type + line="152">the query type @@ -80489,7 +79690,7 @@ Either @new_query or the #GstQuery pointed to by @old_query may be %NULL. - + @@ -80500,12 +79701,12 @@ Either @new_query or the #GstQuery pointed to by @old_query may be %NULL. version="1.14"> Gets the global #GstMetaInfo describing the #GstReferenceTimestampMeta meta. - + line="2906">Gets the global #GstMetaInfo describing the #GstReferenceTimestampMeta meta. + The #GstMetaInfo + line="2911">The #GstMetaInfo @@ -80574,7 +79775,7 @@ is enabled by default when loading plugins. Applications might want to disable this behaviour with the gst_segtrap_set_enabled() function. This is typically done if the application wants to install its own handler without GStreamer interfering. - + filename="gst/gst.c" line="1317">Applications might want to disable/enable the SIGSEGV handling of the GStreamer core. See gst_segtrap_is_enabled() for more information. - + @@ -80686,7 +79887,7 @@ Either @newstr and the value pointed to by @oldstr_ptr may be %NULL. It is a programming error if both @newstr and the value pointed to by @oldstr_ptr refer to the same, non-%NULL structure. - + Checks if the given type is already registered. + line="566">Checks if the given type is already registered. %TRUE if the type is already registered + line="572">%TRUE if the type is already registered name of the tag + line="568">name of the tag @@ -80741,20 +79942,20 @@ It is a programming error if both @newstr and the value pointed to by c:identifier="gst_tag_get_description"> Returns the human-readable description of this tag, You must not change or + line="627">Returns the human-readable description of this tag, You must not change or free this string. the human-readable description of this tag + line="634">the human-readable description of this tag the tag + line="629">the tag @@ -80762,19 +79963,19 @@ free this string. Gets the flag of @tag. + line="648">Gets the flag of @tag. the flag of this tag. + line="654">the flag of this tag. the tag + line="650">the tag @@ -80782,20 +79983,20 @@ free this string. Returns the human-readable name of this tag, You must not change or free + line="602">Returns the human-readable name of this tag, You must not change or free this string. the human-readable name of this tag + line="609">the human-readable name of this tag the tag + line="604">the tag @@ -80803,19 +80004,19 @@ this string. Gets the #GType used for this tag. + line="582">Gets the #GType used for this tag. the #GType of this tag + line="588">the #GType of this tag the tag + line="584">the tag @@ -80823,20 +80024,20 @@ this string. Checks if the given tag is fixed. A fixed tag can only contain one value. + line="668">Checks if the given tag is fixed. A fixed tag can only contain one value. Unfixed tags can contain lists of values. %TRUE, if the given tag is fixed. + line="675">%TRUE, if the given tag is fixed. tag to check + line="670">tag to check @@ -80846,7 +80047,7 @@ Unfixed tags can contain lists of values. moved-to="TagList.copy_value"> Copies the contents for the given tag into the value, + line="1474">Copies the contents for the given tag into the value, merging multiple values into one if multiple values are associated with the tag. You must g_value_unset() the value after use. @@ -80854,7 +80055,7 @@ You must g_value_unset() the value after use. %TRUE, if a value was copied, %FALSE if the tag didn't exist in the + line="1485">%TRUE, if a value was copied, %FALSE if the tag didn't exist in the given list. @@ -80865,19 +80066,19 @@ You must g_value_unset() the value after use. transfer-ownership="none"> uninitialized #GValue to copy into + line="1476">uninitialized #GValue to copy into list to get the tag from + line="1477">list to get the tag from tag to read out + line="1478">tag to read out @@ -80933,95 +80134,11 @@ function. See also: gst_tag_list_ref(). - - Modifies a pointer to a #GstTagList to point to a different #GstTagList. The -modification is done atomically (so this is useful for ensuring thread -safety in some cases), and the reference counts are updated appropriately -(the old tag list is unreffed, the new is reffed). - -Either @new_taglist or the #GstTagList pointed to by @old_taglist may be -%NULL. - - - %TRUE if @new_taglist was different from @old_taglist - - - - - pointer to a pointer to a - #GstTagList to be replaced. - - - - pointer to a #GstTagList that - will replace the tag list pointed to by @old_taglist. - - - - - - Modifies a pointer to a #GstTagList to point to a different #GstTagList. -This function is similar to gst_tag_list_replace() except that it takes -ownership of @new_taglist. - - - %TRUE if @new_taglist was different from @old_taglist - - - - - pointer to a pointer to a #GstTagList - to be replaced. - - - - pointer to a #GstTagList that - will replace the taglist pointed to by @old_taglist. - - - - This is a convenience function for the func argument of gst_tag_register(). + line="435">This is a convenience function for the func argument of gst_tag_register(). It concatenates all given strings using a comma. The tag must be registered as a G_TYPE_STRING or this function will fail. @@ -81035,13 +80152,13 @@ as a G_TYPE_STRING or this function will fail. transfer-ownership="none"> uninitialized GValue to store result in + line="437">uninitialized GValue to store result in GValue to copy from + line="438">GValue to copy from @@ -81050,7 +80167,7 @@ as a G_TYPE_STRING or this function will fail. c:identifier="gst_tag_merge_use_first"> This is a convenience function for the func argument of gst_tag_register(). + line="418">This is a convenience function for the func argument of gst_tag_register(). It creates a copy of the first value from the list. @@ -81063,13 +80180,13 @@ It creates a copy of the first value from the list. transfer-ownership="none"> uninitialized GValue to store result in + line="420">uninitialized GValue to store result in GValue to copy from + line="421">GValue to copy from @@ -81079,7 +80196,7 @@ It creates a copy of the first value from the list. introspectable="0"> Registers a new tag type for the use with GStreamer's type system. If a type + line="475">Registers a new tag type for the use with GStreamer's type system. If a type with that name is already registered, that one is used. The old registration may have used a different type however. So don't rely on your supplied values. @@ -81108,31 +80225,31 @@ gst_tag_merge_strings_with_comma(). the name or identifier string + line="477">the name or identifier string a flag describing the type of tag info + line="478">a flag describing the type of tag info the type this data is in + line="479">the type this data is in human-readable name + line="480">human-readable name a human-readable description about this tag + line="481">a human-readable description about this tag allow-none="1"> function for merging multiple values of this tag, or %NULL + line="482">function for merging multiple values of this tag, or %NULL @@ -81151,7 +80268,7 @@ gst_tag_merge_strings_with_comma(). introspectable="0"> Registers a new tag type for the use with GStreamer's type system. + line="519">Registers a new tag type for the use with GStreamer's type system. Same as gst_tag_register(), but @name, @nick, and @blurb must be static strings or inlined strings, as they will not be copied. (GStreamer @@ -81165,31 +80282,31 @@ even from dynamically loaded plugins.) the name or identifier string (string constant) + line="521">the name or identifier string (string constant) a flag describing the type of tag info + line="522">a flag describing the type of tag info the type this data is in + line="523">the type this data is in human-readable name or short description (string constant) + line="524">human-readable name or short description (string constant) a human-readable description for this tag (string constant) + line="525">a human-readable description for this tag (string constant) allow-none="1"> function for merging multiple values of this tag, or %NULL + line="526">function for merging multiple values of this tag, or %NULL @@ -81459,20 +80576,20 @@ This function is typically called during an element's plugin initialization. Checks if @type is plugin API. See gst_type_mark_as_plugin_api() for + line="4779">Checks if @type is plugin API. See gst_type_mark_as_plugin_api() for details. %TRUE if @type is plugin API or %FALSE otherwise. + line="4787">%TRUE if @type is plugin API or %FALSE otherwise. a GType + line="4781">a GType allow-none="1"> What #GstPluginAPIFlags the plugin was marked with + line="4782">What #GstPluginAPIFlags the plugin was marked with @@ -81493,7 +80610,7 @@ details. version="1.18"> Marks @type as plugin API. This should be called in `class_init` of + line="4753">Marks @type as plugin API. This should be called in `class_init` of elements that expose new types (i.e. enums, flags or internal GObjects) via properties, signals or pad templates. @@ -81511,13 +80628,13 @@ the plugin that defines it. a GType + line="4755">a GType a set of #GstPluginAPIFlags to further inform cache generation. + line="4756">a set of #GstPluginAPIFlags to further inform cache generation. @@ -81525,7 +80642,7 @@ the plugin that defines it. Forces GStreamer to re-scan its plugin paths and update the default + line="1990">Forces GStreamer to re-scan its plugin paths and update the default plugin registry. Applications will almost never need to call this function, it is only @@ -81541,11 +80658,11 @@ any elements or access the GStreamer registry while the update is in progress. Note that this function may block for a significant amount of time. - + %TRUE if the registry has been updated successfully (does not + line="2010">%TRUE if the registry has been updated successfully (does not imply that there were changes), otherwise %FALSE. @@ -81596,20 +80713,20 @@ Free-function: g_free version="1.6"> Parses a URI string into a new #GstUri object. Will return NULL if the URI + line="1644">Parses a URI string into a new #GstUri object. Will return NULL if the URI cannot be parsed. A new #GstUri object, or NULL. + line="1651">A new #GstUri object, or NULL. The URI string to parse. + line="1646">The URI string to parse. @@ -81620,7 +80737,7 @@ cannot be parsed. version="1.18"> Parses a URI string into a new #GstUri object. Will return NULL if the URI + line="1661">Parses a URI string into a new #GstUri object. Will return NULL if the URI cannot be parsed. This is identical to gst_uri_from_string() except that the userinfo and fragment components of the URI will not be unescaped while parsing. @@ -81637,14 +80754,14 @@ https://example.com/path#fragment which may contain a URI-escaped '#'. A new #GstUri object, or NULL. + line="1679">A new #GstUri object, or NULL. The URI string to parse. + line="1663">The URI string to parse. @@ -81758,13 +80875,13 @@ scheme followed by ":" and maybe a string identifying the location. version="1.6"> This is a convenience function to join two URI strings and return the result. + line="1918">This is a convenience function to join two URI strings and return the result. The returned string should be g_free()'d after use. A string representing the percent-encoded join of + line="1926">A string representing the percent-encoded join of the two URIs. @@ -81772,13 +80889,13 @@ The returned string should be g_free()'d after use. The percent-encoded base URI. + line="1920">The percent-encoded base URI. The percent-encoded reference URI to join to the @base_uri. + line="1921">The percent-encoded reference URI to join to the @base_uri. @@ -81788,27 +80905,27 @@ The returned string should be g_free()'d after use. moved-to="Uri.protocol_is_supported"> Checks if an element exists that supports the given URI protocol. Note + line="592">Checks if an element exists that supports the given URI protocol. Note that a positive return value does not imply that a subsequent call to gst_element_make_from_uri() is guaranteed to work. %TRUE + line="601">%TRUE Whether to check for a source or a sink + line="594">Whether to check for a source or a sink Protocol that should be checked for (e.g. "http" or "smb") + line="595">Protocol that should be checked for (e.g. "http" or "smb") @@ -81913,6 +81030,28 @@ element or %NULL if nothing was found + + Return a max num of log2. + + + a computed #guint val. + + + + + a #guint32 value. + + + + + + Compares the given filenames using natural ordering. + + + + + + + a filename to compare with @b + + + + a filename to compare with @a + + + + Determines if @value1 and @value2 can be compared. + line="6011">Determines if @value1 and @value2 can be compared. %TRUE if the values can be compared + line="6018">%TRUE if the values can be compared a value to compare + line="6013">a value to compare another value to compare + line="6014">another value to compare @@ -82810,27 +81974,27 @@ gst_util_uint64_scale_int_round(), gst_util_uint64_scale_int_ceil(). c:identifier="gst_value_can_intersect"> Determines if intersecting two values will produce a valid result. + line="6293">Determines if intersecting two values will produce a valid result. Two values will produce a valid intersection if they have the same type. %TRUE if the values can intersect + line="6302">%TRUE if the values can intersect a value to intersect + line="6295">a value to intersect another value to intersect + line="6296">another value to intersect @@ -82838,25 +82002,25 @@ type. Checks if it's possible to subtract @subtrahend from @minuend. + line="6533">Checks if it's possible to subtract @subtrahend from @minuend. %TRUE if a subtraction is possible + line="6540">%TRUE if a subtraction is possible the value to subtract from + line="6535">the value to subtract from the value to subtract + line="6536">the value to subtract @@ -82864,7 +82028,7 @@ type. Determines if @value1 and @value2 can be non-trivially unioned. + line="6186">Determines if @value1 and @value2 can be non-trivially unioned. Any two values can be trivially unioned by adding both of them to a GstValueList. However, certain types have the possibility to be unioned in a simpler way. For example, an integer range @@ -82875,7 +82039,7 @@ be unioned, this function returns %TRUE. %TRUE if there is a function allowing the two values to + line="6199">%TRUE if there is a function allowing the two values to be unioned. @@ -82883,13 +82047,13 @@ be unioned. a value to union + line="6188">a value to union another value to union + line="6189">another value to union @@ -82897,7 +82061,7 @@ be unioned. Compares @value1 and @value2. If @value1 and @value2 cannot be + line="6105">Compares @value1 and @value2. If @value1 and @value2 cannot be compared, the function returns GST_VALUE_UNORDERED. Otherwise, if @value1 is greater than @value2, GST_VALUE_GREATER_THAN is returned. If @value1 is less than @value2, GST_VALUE_LESS_THAN is returned. @@ -82906,20 +82070,20 @@ If the values are equal, GST_VALUE_EQUAL is returned. comparison result + line="6116">comparison result a value to compare + line="6107">a value to compare another value to compare + line="6108">another value to compare @@ -82927,13 +82091,13 @@ If the values are equal, GST_VALUE_EQUAL is returned. Tries to deserialize a string into the type specified by the given GValue. + line="6719">Tries to deserialize a string into the type specified by the given GValue. If the operation succeeds, %TRUE is returned, %FALSE otherwise. %TRUE on success + line="6728">%TRUE on success @@ -82943,14 +82107,14 @@ If the operation succeeds, %TRUE is returned, %FALSE otherwise. transfer-ownership="none"> #GValue to fill with contents of + line="6721">#GValue to fill with contents of deserialization string to deserialize + line="6723">string to deserialize @@ -82960,14 +82124,14 @@ If the operation succeeds, %TRUE is returned, %FALSE otherwise. version="1.20"> Tries to deserialize a string into the type specified by the given GValue. + line="6766">Tries to deserialize a string into the type specified by the given GValue. @pspec may be used to guide the deserializing of nested members. If the operation succeeds, %TRUE is returned, %FALSE otherwise. %TRUE on success + line="6777">%TRUE on success @@ -82977,14 +82141,14 @@ If the operation succeeds, %TRUE is returned, %FALSE otherwise. transfer-ownership="none"> #GValue to fill with contents of + line="6768">#GValue to fill with contents of deserialization string to deserialize + line="6770">string to deserialize allow-none="1"> the #GParamSpec describing the expected value + line="6771">the #GParamSpec describing the expected value @@ -83001,7 +82165,7 @@ If the operation succeeds, %TRUE is returned, %FALSE otherwise. Fixate @src into a new value @dest. + line="6876">Fixate @src into a new value @dest. For ranges, the first element is taken. For lists and arrays, the first item is fixated and returned. If @src is already fixed, this function returns %FALSE. @@ -83009,20 +82173,20 @@ If @src is already fixed, this function returns %FALSE. %TRUE if @dest contains a fixated version of @src. + line="6886">%TRUE if @dest contains a fixated version of @src. the #GValue destination + line="6878">the #GValue destination the #GValue to fixate + line="6879">the #GValue to fixate @@ -83031,32 +82195,32 @@ If @src is already fixed, this function returns %FALSE. c:identifier="gst_value_fraction_multiply"> Multiplies the two #GValue items containing a #GST_TYPE_FRACTION and sets + line="7102">Multiplies the two #GValue items containing a #GST_TYPE_FRACTION and sets @product to the product of the two fractions. %FALSE in case of an error (like integer overflow), %TRUE otherwise. + line="7111">%FALSE in case of an error (like integer overflow), %TRUE otherwise. a GValue initialized to #GST_TYPE_FRACTION + line="7104">a GValue initialized to #GST_TYPE_FRACTION a GValue initialized to #GST_TYPE_FRACTION + line="7105">a GValue initialized to #GST_TYPE_FRACTION a GValue initialized to #GST_TYPE_FRACTION + line="7106">a GValue initialized to #GST_TYPE_FRACTION @@ -83065,31 +82229,31 @@ If @src is already fixed, this function returns %FALSE. c:identifier="gst_value_fraction_subtract"> Subtracts the @subtrahend from the @minuend and sets @dest to the result. + line="7137">Subtracts the @subtrahend from the @minuend and sets @dest to the result. %FALSE in case of an error (like integer overflow), %TRUE otherwise. + line="7145">%FALSE in case of an error (like integer overflow), %TRUE otherwise. a GValue initialized to #GST_TYPE_FRACTION + line="7139">a GValue initialized to #GST_TYPE_FRACTION a GValue initialized to #GST_TYPE_FRACTION + line="7140">a GValue initialized to #GST_TYPE_FRACTION a GValue initialized to #GST_TYPE_FRACTION + line="7141">a GValue initialized to #GST_TYPE_FRACTION @@ -83097,19 +82261,19 @@ If @src is already fixed, this function returns %FALSE. Gets the bitmask specified by @value. + line="7616">Gets the bitmask specified by @value. the bitmask. + line="7622">the bitmask. a GValue initialized to #GST_TYPE_BITMASK + line="7618">a GValue initialized to #GST_TYPE_BITMASK @@ -83134,21 +82298,21 @@ a reference to @v. Gets the contents of @value. The reference count of the returned + line="2215">Gets the contents of @value. The reference count of the returned #GstCaps will not be modified, therefore the caller must take one before getting rid of the @value. the contents of @value + line="2223">the contents of @value a GValue initialized to GST_TYPE_CAPS + line="2217">a GValue initialized to GST_TYPE_CAPS @@ -83157,19 +82321,19 @@ before getting rid of the @value. c:identifier="gst_value_get_caps_features"> Gets the contents of @value. + line="3101">Gets the contents of @value. the contents of @value + line="3107">the contents of @value a GValue initialized to GST_TYPE_CAPS_FEATURES + line="3103">a GValue initialized to GST_TYPE_CAPS_FEATURES @@ -83178,19 +82342,19 @@ before getting rid of the @value. c:identifier="gst_value_get_double_range_max"> Gets the maximum of the range specified by @value. + line="1849">Gets the maximum of the range specified by @value. the maximum of the range + line="1855">the maximum of the range a GValue initialized to GST_TYPE_DOUBLE_RANGE + line="1851">a GValue initialized to GST_TYPE_DOUBLE_RANGE @@ -83199,19 +82363,19 @@ before getting rid of the @value. c:identifier="gst_value_get_double_range_min"> Gets the minimum of the range specified by @value. + line="1833">Gets the minimum of the range specified by @value. the minimum of the range + line="1839">the minimum of the range a GValue initialized to GST_TYPE_DOUBLE_RANGE + line="1835">a GValue initialized to GST_TYPE_DOUBLE_RANGE @@ -83221,19 +82385,19 @@ before getting rid of the @value. version="1.6"> Retrieve the flags field of a GstFlagSet @value. + line="7775">Retrieve the flags field of a GstFlagSet @value. the flags field of the flagset instance. + line="7781">the flags field of the flagset instance. a GValue initialized to #GST_TYPE_FLAG_SET + line="7777">a GValue initialized to #GST_TYPE_FLAG_SET @@ -83243,19 +82407,19 @@ before getting rid of the @value. version="1.6"> Retrieve the mask field of a GstFlagSet @value. + line="7793">Retrieve the mask field of a GstFlagSet @value. the mask field of the flagset instance. + line="7799">the mask field of the flagset instance. a GValue initialized to #GST_TYPE_FLAG_SET + line="7795">a GValue initialized to #GST_TYPE_FLAG_SET @@ -83264,19 +82428,19 @@ before getting rid of the @value. c:identifier="gst_value_get_fraction_denominator"> Gets the denominator of the fraction specified by @value. + line="7086">Gets the denominator of the fraction specified by @value. the denominator of the fraction. + line="7092">the denominator of the fraction. a GValue initialized to #GST_TYPE_FRACTION + line="7088">a GValue initialized to #GST_TYPE_FRACTION @@ -83285,19 +82449,19 @@ before getting rid of the @value. c:identifier="gst_value_get_fraction_numerator"> Gets the numerator of the fraction specified by @value. + line="7070">Gets the numerator of the fraction specified by @value. the numerator of the fraction. + line="7076">the numerator of the fraction. a GValue initialized to #GST_TYPE_FRACTION + line="7072">a GValue initialized to #GST_TYPE_FRACTION @@ -83306,19 +82470,19 @@ before getting rid of the @value. c:identifier="gst_value_get_fraction_range_max"> Gets the maximum of the range specified by @value. + line="2113">Gets the maximum of the range specified by @value. the maximum of the range + line="2119">the maximum of the range a GValue initialized to GST_TYPE_FRACTION_RANGE + line="2115">a GValue initialized to GST_TYPE_FRACTION_RANGE @@ -83327,19 +82491,19 @@ before getting rid of the @value. c:identifier="gst_value_get_fraction_range_min"> Gets the minimum of the range specified by @value. + line="2090">Gets the minimum of the range specified by @value. the minimum of the range + line="2096">the minimum of the range a GValue initialized to GST_TYPE_FRACTION_RANGE + line="2092">a GValue initialized to GST_TYPE_FRACTION_RANGE @@ -83348,19 +82512,19 @@ before getting rid of the @value. c:identifier="gst_value_get_int64_range_max"> Gets the maximum of the range specified by @value. + line="1670">Gets the maximum of the range specified by @value. the maximum of the range + line="1676">the maximum of the range a GValue initialized to GST_TYPE_INT64_RANGE + line="1672">a GValue initialized to GST_TYPE_INT64_RANGE @@ -83369,19 +82533,19 @@ before getting rid of the @value. c:identifier="gst_value_get_int64_range_min"> Gets the minimum of the range specified by @value. + line="1654">Gets the minimum of the range specified by @value. the minimum of the range + line="1660">the minimum of the range a GValue initialized to GST_TYPE_INT64_RANGE + line="1656">a GValue initialized to GST_TYPE_INT64_RANGE @@ -83390,19 +82554,19 @@ before getting rid of the @value. c:identifier="gst_value_get_int64_range_step"> Gets the step of the range specified by @value. + line="1686">Gets the step of the range specified by @value. the step of the range + line="1692">the step of the range a GValue initialized to GST_TYPE_INT64_RANGE + line="1688">a GValue initialized to GST_TYPE_INT64_RANGE @@ -83411,19 +82575,19 @@ before getting rid of the @value. c:identifier="gst_value_get_int_range_max"> Gets the maximum of the range specified by @value. + line="1424">Gets the maximum of the range specified by @value. the maximum of the range + line="1430">the maximum of the range a GValue initialized to GST_TYPE_INT_RANGE + line="1426">a GValue initialized to GST_TYPE_INT_RANGE @@ -83432,19 +82596,19 @@ before getting rid of the @value. c:identifier="gst_value_get_int_range_min"> Gets the minimum of the range specified by @value. + line="1408">Gets the minimum of the range specified by @value. the minimum of the range + line="1414">the minimum of the range a GValue initialized to GST_TYPE_INT_RANGE + line="1410">a GValue initialized to GST_TYPE_INT_RANGE @@ -83453,19 +82617,19 @@ before getting rid of the @value. c:identifier="gst_value_get_int_range_step"> Gets the step of the range specified by @value. + line="1440">Gets the step of the range specified by @value. the step of the range + line="1446">the step of the range a GValue initialized to GST_TYPE_INT_RANGE + line="1442">a GValue initialized to GST_TYPE_INT_RANGE @@ -83491,19 +82655,19 @@ a reference to @v. c:identifier="gst_value_get_structure"> Gets the contents of @value. + line="3003">Gets the contents of @value. the contents of @value + line="3009">the contents of @value a GValue initialized to GST_TYPE_STRUCTURE + line="3005">a GValue initialized to GST_TYPE_STRUCTURE @@ -83512,7 +82676,7 @@ a reference to @v. c:identifier="gst_value_init_and_copy"> Initialises the target value to be of the same type as source and then copies + line="6624">Initialises the target value to be of the same type as source and then copies the contents from source to target. @@ -83525,13 +82689,13 @@ the contents from source to target. transfer-ownership="none"> the target value + line="6626">the target value the source value + line="6627">the source value @@ -83539,7 +82703,7 @@ the contents from source to target. Calculates the intersection of two values. If the values have + line="6352">Calculates the intersection of two values. If the values have a non-empty intersection, the value representing the intersection is placed in @dest, unless %NULL. If the intersection is non-empty, @dest is not modified. @@ -83547,7 +82711,7 @@ is placed in @dest, unless %NULL. If the intersection is non-empty, %TRUE if the intersection is non-empty + line="6366">%TRUE if the intersection is non-empty @@ -83559,7 +82723,7 @@ is placed in @dest, unless %NULL. If the intersection is non-empty, allow-none="1"> + line="6354"> a uninitialized #GValue that will hold the calculated intersection value. May be %NULL if the resulting set if not needed. @@ -83568,13 +82732,13 @@ is placed in @dest, unless %NULL. If the intersection is non-empty, a value to intersect + line="6358">a value to intersect another value to intersect + line="6359">another value to intersect @@ -83582,7 +82746,7 @@ is placed in @dest, unless %NULL. If the intersection is non-empty, Tests if the given GValue, if available in a GstStructure (or any other + line="6828">Tests if the given GValue, if available in a GstStructure (or any other container) contains a "fixed" (which means: one value) or an "unfixed" (which means: multiple possible values, such as data lists or data ranges) value. @@ -83590,14 +82754,14 @@ ranges) value. true if the value is "fixed". + line="6837">true if the value is "fixed". the #GValue to check + line="6830">the #GValue to check @@ -83605,25 +82769,25 @@ ranges) value. Check that @value1 is a subset of @value2. + line="4506">Check that @value1 is a subset of @value2. %TRUE is @value1 is a subset of @value2 + line="4513">%TRUE is @value1 is a subset of @value2 a #GValue + line="4508">a #GValue a #GValue + line="4509">a #GValue @@ -83631,7 +82795,7 @@ ranges) value. Registers functions to perform calculations on #GValue items of a given + line="6599">Registers functions to perform calculations on #GValue items of a given type. Each type can only be added once. @@ -83641,7 +82805,7 @@ type. Each type can only be added once. structure containing functions to register + line="6601">structure containing functions to register @@ -83649,7 +82813,7 @@ type. Each type can only be added once. tries to transform the given @value into a string representation that allows + line="6667">tries to transform the given @value into a string representation that allows getting back this string later on using gst_value_deserialize(). Free-function: g_free @@ -83657,7 +82821,7 @@ Free-function: g_free the serialization for @value + line="6676">the serialization for @value or %NULL if none exists @@ -83665,7 +82829,7 @@ or %NULL if none exists a #GValue to serialize + line="6669">a #GValue to serialize @@ -83673,7 +82837,7 @@ or %NULL if none exists Sets @value to the bitmask specified by @bitmask. + line="7601">Sets @value to the bitmask specified by @bitmask. @@ -83682,13 +82846,13 @@ or %NULL if none exists a GValue initialized to #GST_TYPE_BITMASK + line="7603">a GValue initialized to #GST_TYPE_BITMASK the bitmask + line="7604">the bitmask @@ -83716,7 +82880,7 @@ or %NULL if none exists Sets the contents of @value to @caps. A reference to the + line="2197">Sets the contents of @value to @caps. A reference to the provided @caps will be taken by the @value. @@ -83726,13 +82890,13 @@ provided @caps will be taken by the @value. a GValue initialized to GST_TYPE_CAPS + line="2199">a GValue initialized to GST_TYPE_CAPS the caps to set the value to + line="2200">the caps to set the value to @@ -83741,7 +82905,7 @@ provided @caps will be taken by the @value. c:identifier="gst_value_set_caps_features"> Sets the contents of @value to @features. + line="3084">Sets the contents of @value to @features. @@ -83750,13 +82914,13 @@ provided @caps will be taken by the @value. a GValue initialized to GST_TYPE_CAPS_FEATURES + line="3086">a GValue initialized to GST_TYPE_CAPS_FEATURES the features to set the value to + line="3087">the features to set the value to @@ -83765,7 +82929,7 @@ provided @caps will be taken by the @value. c:identifier="gst_value_set_double_range"> Sets @value to the range specified by @start and @end. + line="1815">Sets @value to the range specified by @start and @end. @@ -83774,19 +82938,19 @@ provided @caps will be taken by the @value. a GValue initialized to GST_TYPE_DOUBLE_RANGE + line="1817">a GValue initialized to GST_TYPE_DOUBLE_RANGE the start of the range + line="1818">the start of the range the end of the range + line="1819">the end of the range @@ -83796,7 +82960,7 @@ provided @caps will be taken by the @value. version="1.6"> Sets @value to the flags and mask values provided in @flags and @mask. + line="7753">Sets @value to the flags and mask values provided in @flags and @mask. The @flags value indicates the values of flags, the @mask represents which bits in the flag value have been set, and which are "don't care" @@ -83807,19 +82971,19 @@ which bits in the flag value have been set, and which are "don't care" a GValue initialized to %GST_TYPE_FLAG_SET + line="7755">a GValue initialized to %GST_TYPE_FLAG_SET The value of the flags set or unset + line="7756">The value of the flags set or unset The mask indicate which flags bits must match for comparisons + line="7757">The mask indicate which flags bits must match for comparisons @@ -83827,7 +82991,7 @@ which bits in the flag value have been set, and which are "don't care" Sets @value to the fraction specified by @numerator over @denominator. + line="7031">Sets @value to the fraction specified by @numerator over @denominator. The fraction gets reduced to the smallest numerator and denominator, and if necessary the sign is moved to the numerator. @@ -83838,19 +83002,19 @@ and if necessary the sign is moved to the numerator. a GValue initialized to #GST_TYPE_FRACTION + line="7033">a GValue initialized to #GST_TYPE_FRACTION the numerator of the fraction + line="7034">the numerator of the fraction the denominator of the fraction + line="7035">the denominator of the fraction @@ -83859,7 +83023,7 @@ and if necessary the sign is moved to the numerator. c:identifier="gst_value_set_fraction_range"> Sets @value to the range specified by @start and @end. + line="2015">Sets @value to the range specified by @start and @end. @@ -83868,19 +83032,19 @@ and if necessary the sign is moved to the numerator. a GValue initialized to GST_TYPE_FRACTION_RANGE + line="2017">a GValue initialized to GST_TYPE_FRACTION_RANGE the start of the range (a GST_TYPE_FRACTION GValue) + line="2018">the start of the range (a GST_TYPE_FRACTION GValue) the end of the range (a GST_TYPE_FRACTION GValue) + line="2019">the end of the range (a GST_TYPE_FRACTION GValue) @@ -83889,7 +83053,7 @@ and if necessary the sign is moved to the numerator. c:identifier="gst_value_set_fraction_range_full"> Sets @value to the range specified by @numerator_start/@denominator_start + line="2044">Sets @value to the range specified by @numerator_start/@denominator_start and @numerator_end/@denominator_end. @@ -83899,31 +83063,31 @@ and @numerator_end/@denominator_end. a GValue initialized to GST_TYPE_FRACTION_RANGE + line="2046">a GValue initialized to GST_TYPE_FRACTION_RANGE the numerator start of the range + line="2047">the numerator start of the range the denominator start of the range + line="2048">the denominator start of the range the numerator end of the range + line="2049">the numerator end of the range the denominator end of the range + line="2050">the denominator end of the range @@ -83932,7 +83096,7 @@ and @numerator_end/@denominator_end. c:identifier="gst_value_set_int64_range"> Sets @value to the range specified by @start and @end. + line="1640">Sets @value to the range specified by @start and @end. @@ -83941,19 +83105,19 @@ and @numerator_end/@denominator_end. a GValue initialized to GST_TYPE_INT64_RANGE + line="1642">a GValue initialized to GST_TYPE_INT64_RANGE the start of the range + line="1643">the start of the range the end of the range + line="1644">the end of the range @@ -83962,7 +83126,7 @@ and @numerator_end/@denominator_end. c:identifier="gst_value_set_int64_range_step"> Sets @value to the range specified by @start, @end and @step. + line="1616">Sets @value to the range specified by @start, @end and @step. @@ -83971,25 +83135,25 @@ and @numerator_end/@denominator_end. a GValue initialized to GST_TYPE_INT64_RANGE + line="1618">a GValue initialized to GST_TYPE_INT64_RANGE the start of the range + line="1619">the start of the range the end of the range + line="1620">the end of the range the step of the range + line="1621">the step of the range @@ -83998,7 +83162,7 @@ and @numerator_end/@denominator_end. c:identifier="gst_value_set_int_range"> Sets @value to the range specified by @start and @end. + line="1394">Sets @value to the range specified by @start and @end. @@ -84007,19 +83171,19 @@ and @numerator_end/@denominator_end. a GValue initialized to GST_TYPE_INT_RANGE + line="1396">a GValue initialized to GST_TYPE_INT_RANGE the start of the range + line="1397">the start of the range the end of the range + line="1398">the end of the range @@ -84028,7 +83192,7 @@ and @numerator_end/@denominator_end. c:identifier="gst_value_set_int_range_step"> Sets @value to the range specified by @start, @end and @step. + line="1368">Sets @value to the range specified by @start, @end and @step. @@ -84037,25 +83201,25 @@ and @numerator_end/@denominator_end. a GValue initialized to GST_TYPE_INT_RANGE + line="1370">a GValue initialized to GST_TYPE_INT_RANGE the start of the range + line="1371">the start of the range the end of the range + line="1372">the end of the range the step of the range + line="1373">the step of the range @@ -84084,7 +83248,7 @@ and @numerator_end/@denominator_end. c:identifier="gst_value_set_structure"> Sets the contents of @value to @structure. + line="2986">Sets the contents of @value to @structure. @@ -84093,13 +83257,13 @@ and @numerator_end/@denominator_end. a GValue initialized to GST_TYPE_STRUCTURE + line="2988">a GValue initialized to GST_TYPE_STRUCTURE the structure to set the value to + line="2989">the structure to set the value to @@ -84107,13 +83271,13 @@ and @numerator_end/@denominator_end. Subtracts @subtrahend from @minuend and stores the result in @dest. + line="6468">Subtracts @subtrahend from @minuend and stores the result in @dest. Note that this means subtraction as in sets, not as in mathematics. %TRUE if the subtraction is not empty + line="6480">%TRUE if the subtraction is not empty @@ -84125,7 +83289,7 @@ Note that this means subtraction as in sets, not as in mathematics. allow-none="1"> the destination value + line="6470">the destination value for the result if the subtraction is not empty. May be %NULL, in which case the resulting set will not be computed, which can give a fair speedup. @@ -84134,13 +83298,13 @@ Note that this means subtraction as in sets, not as in mathematics. the value to subtract from + line="6474">the value to subtract from the value to subtract + line="6475">the value to subtract @@ -84188,12 +83352,12 @@ Note that this means subtraction as in sets, not as in mathematics. Creates a GValue corresponding to the union of @value1 and @value2. + line="6226">Creates a GValue corresponding to the union of @value1 and @value2. %TRUE if the union succeeded. + line="6234">%TRUE if the union succeeded. @@ -84203,19 +83367,19 @@ Note that this means subtraction as in sets, not as in mathematics. transfer-ownership="none"> the destination value + line="6228">the destination value a value to union + line="6229">a value to union another value to union + line="6230">another value to union @@ -84224,7 +83388,7 @@ Note that this means subtraction as in sets, not as in mathematics. Gets the version number of the GStreamer library. - + @@ -84272,7 +83436,7 @@ Note that this means subtraction as in sets, not as in mathematics. filename="gst/gst.c" line="1272">This function returns a string that is useful for describing this version of GStreamer to the outside world: user agent strings, logging, ... - + line="32"/> + + Name of this allocator, to be used for example with gst_allocator_find() and +gst_memory_is_type(). + + + + + Private intance object for #GstDRMDumbAllocator. + + + Creates a new #GstDRMDumbAllocator for the specific device path. This +function can fail if the path does not exist, is not a DRM device or if +the DRM device doesnot support DUMB allocation. + + + a new DRM Dumb allocator. Use gst_object_unref() + to release the allocator after usage. + + + + + path to the DRM device to open + + + + + + Creates a new #GstDRMDumbAllocator for the specific file desciptor. This +function can fail if the file descriptor is not a DRM device or if +the DRM device does not support DUMB allocation. + + + a new DRM Dumb allocator. Use gst_object_unref() + to release the allocator after usage. + + + + + file descriptor of the DRM device + + + + + + Allocated a DRM buffer object for the specific @drm_fourcc, @width and +@height. Note that the DRM Dumb allocation interface is agnostic to the +pixel format. This @drm_fourcc is converted into a bpp (bit-per-pixel) +number and the height is scaled according to the sub-sampling. + + + a new DRM Dumb #GstMemory. Use gst_memory_unref() + to release the memory after usage. + + + + + the allocator instance + + + + the DRM format to allocate for + + + + padded width for this allocation + + + + padded height for this allocation + + + + the pitch as returned by the driver + + + + + + This function allow verifying if the driver support dma-buf exportation. + + + %TRUE if the allocator support exporting dma-buf. + + + + + the #GstAllocator + + + + + + + + + + + + + + + Parent Class. + + + + + This is a subclass of #GstFdAllocator that implements the +gst_allocator_alloc() method using `memfd_create()` when available, POSIX +`shm_open()` otherwise. Platforms not supporting any of those (Windows) will +always return %NULL. + +Note that allocating new shared memories has a significant performance cost, +it is thus recommended to keep a pool of pre-allocated #GstMemory, using +#GstBufferPool. For that reason, this allocator has the +%GST_ALLOCATOR_FLAG_NO_COPY flag set. + + + Get the #GstShmAllocator singleton previously registered with +gst_shm_allocator_init_once(). + + + a #GstAllocator or %NULL if +gst_shm_allocator_init_once() has not been previously called. + + + + + Register a #GstShmAllocator using gst_allocator_register() with the name +%GST_ALLOCATOR_SHM. This is no-op after the first call. + + + + + + + + + + Parent Class. + + + @@ -546,6 +791,57 @@ The memory is only mmapped on gst_buffer_map() request. + + Exports a DMABuf from the DRM Bumb buffer object. One can check if this +feature is supported using gst_drm_dumb_allocator_has_prime_export(); + + + a #GstMemory from #GstDmaBufAllocator wrapping the exported dma-buf + file descriptor. + + + + + the memory to export from + + + + + + Return the DRM buffer object handle associated with @mem. + + + the DRM buffer object handle associated with the memory, or 0. + The handle is still owned by the GstMemory and cannot be used + beyond the lifetime of this GstMemory unless it is being passed + to DRM driver, which does handle a refcount internally. + + + + + the memory to get the handle from + + + + @@ -593,6 +889,26 @@ an fd. + + + + %TRUE if @mem is DRM Dumb memory, otherwise %FALSE + + + + + the memory to be checked + + + + diff --git a/girs/GstApp-1.0.gir b/girs/GstApp-1.0.gir index 945cfe8d7..2ce850b4c 100644 --- a/girs/GstApp-1.0.gir +++ b/girs/GstApp-1.0.gir @@ -131,8 +131,8 @@ which accept a timeout parameter to limit the amount of time to wait. Appsink will internally use a queue to collect buffers from the streaming thread. If the application is not pulling samples fast enough, this queue -will consume a lot of memory over time. The "max-buffers" property can be -used to limit the queue size. The "drop" property controls whether the +will consume a lot of memory over time. The "max-buffers", "max-time" and "max-bytes" +properties can be used to limit the queue size. The "drop" property controls whether the streaming thread blocks or if older buffers are dropped when the maximum queue size is reached. Note that blocking the streaming thread can negatively affect real-time performance and should be avoided. @@ -189,7 +189,7 @@ to avoid polling. Get the last preroll sample in @appsink. This was the sample that caused the + line="1784">Get the last preroll sample in @appsink. This was the sample that caused the appsink to preroll in the PAUSED state. This function is typically used when dealing with a pipeline in the PAUSED @@ -211,7 +211,7 @@ element is set to the READY/NULL state. a #GstSample or NULL when the appsink is stopped or EOS. + line="1807">a #GstSample or NULL when the appsink is stopped or EOS. Call gst_sample_unref() after usage. @@ -219,7 +219,7 @@ element is set to the READY/NULL state. a #GstAppSink + line="1786">a #GstAppSink @@ -227,7 +227,7 @@ element is set to the READY/NULL state. This function blocks until a sample or EOS becomes available or the appsink + line="1816">This function blocks until a sample or EOS becomes available or the appsink element is set to the READY/NULL state. This function will only return samples when the appsink is in the PLAYING @@ -242,7 +242,7 @@ If an EOS event was received before any buffers, this function returns a #GstSample or NULL when the appsink is stopped or EOS. + line="1832">a #GstSample or NULL when the appsink is stopped or EOS. Call gst_sample_unref() after usage. @@ -250,7 +250,7 @@ If an EOS event was received before any buffers, this function returns a #GstAppSink + line="1818">a #GstAppSink @@ -261,7 +261,7 @@ If an EOS event was received before any buffers, this function returns introspectable="0"> This function blocks until a sample or an event or EOS becomes available or the appsink + line="2020">This function blocks until a sample or an event or EOS becomes available or the appsink element is set to the READY/NULL state or the timeout expires. This function will only return samples when the appsink is in the PLAYING @@ -284,7 +284,7 @@ so make sure that your code is checking for the actual type it is handling. a #GstSample, or #GstEvent or NULL when the appsink is stopped or EOS or the timeout expires. + line="2045">a #GstSample, or #GstEvent or NULL when the appsink is stopped or EOS or the timeout expires. Call gst_mini_object_unref() after usage. @@ -292,13 +292,13 @@ Call gst_mini_object_unref() after usage. a #GstAppSink + line="2022">a #GstAppSink the maximum amount of time to wait for a sample + line="2023">the maximum amount of time to wait for a sample @@ -308,7 +308,7 @@ Call gst_mini_object_unref() after usage. version="1.10"> Get the last preroll sample in @appsink. This was the sample that caused the + line="1876">Get the last preroll sample in @appsink. This was the sample that caused the appsink to preroll in the PAUSED state. This function is typically used when dealing with a pipeline in the PAUSED @@ -331,7 +331,7 @@ element is set to the READY/NULL state, or the timeout expires. a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. + line="1901">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. Call gst_sample_unref() after usage. @@ -339,13 +339,13 @@ element is set to the READY/NULL state, or the timeout expires. a #GstAppSink + line="1878">a #GstAppSink the maximum amount of time to wait for the preroll sample + line="1879">the maximum amount of time to wait for the preroll sample @@ -355,7 +355,7 @@ element is set to the READY/NULL state, or the timeout expires. version="1.10"> This function blocks until a sample or EOS becomes available or the appsink + line="1979">This function blocks until a sample or EOS becomes available or the appsink element is set to the READY/NULL state or the timeout expires. This function will only return samples when the appsink is in the PLAYING @@ -371,7 +371,7 @@ condition. a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. + line="1997">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. Call gst_sample_unref() after usage. @@ -379,13 +379,13 @@ condition. a #GstAppSink + line="1981">a #GstAppSink the maximum amount of time to wait for a sample + line="1982">the maximum amount of time to wait for a sample @@ -395,19 +395,19 @@ condition. version="1.12"> Check if @appsink supports buffer lists. - + line="1704">Check if @appsink supports buffer lists. + %TRUE if @appsink supports buffer lists. + line="1710">%TRUE if @appsink supports buffer lists. a #GstAppSink + line="1706">a #GstAppSink @@ -417,19 +417,19 @@ condition. glib:get-property="caps"> Get the configured caps on @appsink. + line="1365">Get the configured caps on @appsink. the #GstCaps accepted by the sink. gst_caps_unref() after usage. + line="1371">the #GstCaps accepted by the sink. gst_caps_unref() after usage. a #GstAppSink + line="1367">a #GstAppSink @@ -439,13 +439,13 @@ condition. glib:get-property="drop"> Check if @appsink will drop old buffers when the maximum amount of queued -buffers is reached. - + line="1648">Check if @appsink will drop old buffers when the maximum amount of queued +data is reached (meaning max buffers, time or bytes limit, whichever is hit first). + %TRUE if @appsink is dropping old buffers when the queue is + line="1655">%TRUE if @appsink is dropping old buffers when the queue is filled. @@ -453,7 +453,7 @@ filled. a #GstAppSink + line="1650">a #GstAppSink @@ -463,12 +463,12 @@ filled. glib:get-property="emit-signals"> Check if appsink will emit the "new-preroll" and "new-sample" signals. + line="1460">Check if appsink will emit the "new-preroll" and "new-sample" signals. %TRUE if @appsink is emitting the "new-preroll" and "new-sample" + line="1466">%TRUE if @appsink is emitting the "new-preroll" and "new-sample" signals. @@ -476,7 +476,7 @@ signals. a #GstAppSink + line="1462">a #GstAppSink @@ -486,19 +486,65 @@ signals. glib:get-property="max-buffers"> Get the maximum amount of buffers that can be queued in @appsink. + line="1573">Get the maximum amount of buffers that can be queued in @appsink. The maximum amount of buffers that can be queued. + line="1579">The maximum amount of buffers that can be queued. a #GstAppSink + line="1575">a #GstAppSink + + + + + + Get the maximum total size, in bytes, that can be queued in @appsink. + + + The maximum amount of bytes that can be queued + + + + + a #GstAppSink + + + + + + Get the maximum total duration that can be queued in @appsink. + + + The maximum total duration that can be queued. + + + + + a #GstAppSink @@ -508,13 +554,13 @@ signals. glib:get-property="wait-on-eos"> Check if @appsink will wait for all buffers to be consumed when an EOS is + line="1757">Check if @appsink will wait for all buffers to be consumed when an EOS is received. - + %TRUE if @appsink will wait for all buffers to be consumed when an + line="1764">%TRUE if @appsink will wait for all buffers to be consumed when an EOS is received. @@ -522,7 +568,7 @@ EOS is received. a #GstAppSink + line="1759">a #GstAppSink @@ -530,7 +576,7 @@ EOS is received. Check if @appsink is EOS, which is when no more samples can be pulled because + line="1392">Check if @appsink is EOS, which is when no more samples can be pulled because an EOS event was received. This function also returns %TRUE when the appsink is not in the PAUSED or @@ -539,14 +585,14 @@ PLAYING state. %TRUE if no more samples can be pulled and the appsink is EOS. + line="1402">%TRUE if no more samples can be pulled and the appsink is EOS. a #GstAppSink + line="1394">a #GstAppSink @@ -557,7 +603,7 @@ PLAYING state. introspectable="0"> This function blocks until a sample or an event becomes available or the appsink + line="1841">This function blocks until a sample or an event becomes available or the appsink element is set to the READY/NULL state. This function will only return samples when the appsink is in the PLAYING @@ -576,11 +622,11 @@ to handle incoming events events as well as samples. Note that future releases may extend this API to return other object types so make sure that your code is checking for the actual type it is handling. - + a #GstSample, or a #GstEvent or NULL when the appsink is stopped or EOS. + line="1865">a #GstSample, or a #GstEvent or NULL when the appsink is stopped or EOS. Call gst_mini_object_unref() after usage. @@ -588,7 +634,7 @@ so make sure that your code is checking for the actual type it is handling. a #GstAppSink + line="1843">a #GstAppSink @@ -596,7 +642,7 @@ so make sure that your code is checking for the actual type it is handling. Get the last preroll sample in @appsink. This was the sample that caused the + line="1784">Get the last preroll sample in @appsink. This was the sample that caused the appsink to preroll in the PAUSED state. This function is typically used when dealing with a pipeline in the PAUSED @@ -614,11 +660,11 @@ If an EOS event was received before any buffers, this function returns This function blocks until a preroll sample or EOS is received or the appsink element is set to the READY/NULL state. - + a #GstSample or NULL when the appsink is stopped or EOS. + line="1807">a #GstSample or NULL when the appsink is stopped or EOS. Call gst_sample_unref() after usage. @@ -626,7 +672,7 @@ element is set to the READY/NULL state. a #GstAppSink + line="1786">a #GstAppSink @@ -634,7 +680,7 @@ element is set to the READY/NULL state. This function blocks until a sample or EOS becomes available or the appsink + line="1816">This function blocks until a sample or EOS becomes available or the appsink element is set to the READY/NULL state. This function will only return samples when the appsink is in the PLAYING @@ -645,11 +691,11 @@ especially when dealing with raw video frames. If an EOS event was received before any buffers, this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS condition. - + a #GstSample or NULL when the appsink is stopped or EOS. + line="1832">a #GstSample or NULL when the appsink is stopped or EOS. Call gst_sample_unref() after usage. @@ -657,7 +703,7 @@ If an EOS event was received before any buffers, this function returns a #GstAppSink + line="1818">a #GstAppSink @@ -667,11 +713,11 @@ If an EOS event was received before any buffers, this function returns version="1.12"> Instruct @appsink to enable or disable buffer list support. + line="1675">Instruct @appsink to enable or disable buffer list support. For backwards-compatibility reasons applications need to opt in to indicate that they will be able to handle buffer lists. - + @@ -679,13 +725,13 @@ to indicate that they will be able to handle buffer lists. a #GstAppSink + line="1677">a #GstAppSink enable or disable buffer list support + line="1678">enable or disable buffer list support @@ -695,7 +741,7 @@ to indicate that they will be able to handle buffer lists. introspectable="0"> Set callbacks which will be executed for each new preroll, new sample and eos. + line="2145">Set callbacks which will be executed for each new preroll, new sample and eos. This is an alternative to using the signals, it has lower overhead and is thus less expensive, but also less flexible. @@ -704,7 +750,7 @@ reasons. Before 1.16.3 it was not possible to change the callbacks in a thread-safe way. - + @@ -712,13 +758,13 @@ way. a #GstAppSink + line="2147">a #GstAppSink the callbacks + line="2148">the callbacks allow-none="1"> a user_data argument for the callbacks + line="2149">a user_data argument for the callbacks a destroy notify function + line="2150">a destroy notify function @@ -743,7 +789,7 @@ way. glib:set-property="caps"> Set the capabilities on the appsink element. This function takes + line="1332">Set the capabilities on the appsink element. This function takes a copy of the caps structure. After calling this method, the sink will only accept caps that match @caps. If @caps is non-fixed, or incomplete, you must check the caps on the samples to get the actual used caps. @@ -755,7 +801,7 @@ you must check the caps on the samples to get the actual used caps. a #GstAppSink + line="1334">a #GstAppSink allow-none="1"> caps to set + line="1335">caps to set @@ -774,9 +820,9 @@ you must check the caps on the samples to get the actual used caps. glib:set-property="drop"> Instruct @appsink to drop old buffers when the maximum amount of queued -buffers is reached. - + line="1622">Instruct @appsink to drop old buffers when the maximum amount of queued +data is reached, that is, when any configured limit is hit (max-buffers, max-time or max-bytes). + @@ -784,13 +830,13 @@ buffers is reached. a #GstAppSink + line="1624">a #GstAppSink the new state + line="1625">the new state @@ -800,7 +846,7 @@ buffers is reached. glib:set-property="emit-signals"> Make appsink emit the "new-preroll" and "new-sample" signals. This option is + line="1437">Make appsink emit the "new-preroll" and "new-sample" signals. This option is by default disabled because signal emission is expensive and unneeded when the application prefers to operate in pull mode. @@ -811,13 +857,13 @@ the application prefers to operate in pull mode. a #GstAppSink + line="1439">a #GstAppSink the new state + line="1440">the new state @@ -827,9 +873,10 @@ the application prefers to operate in pull mode. glib:set-property="max-buffers"> Set the maximum amount of buffers that can be queued in @appsink. After this + line="1521">Set the maximum amount of buffers that can be queued in @appsink. After this amount of buffers are queued in appsink, any more buffers will block upstream -elements until a sample is pulled from @appsink. +elements until a sample is pulled from @appsink, unless 'drop' is set, in which +case new buffers will be discarded. @@ -838,24 +885,82 @@ elements until a sample is pulled from @appsink. a #GstAppSink + line="1523">a #GstAppSink the maximum number of buffers to queue + line="1524">the maximum number of buffers to queue + + Set the maximum total size that can be queued in @appsink. After this +amount of buffers are queued in appsink, any more buffers will block upstream +elements until a sample is pulled from @appsink, unless 'drop' is set, in which +case new buffers will be discarded. + + + + + + + a #GstAppSink + + + + the maximum total size of buffers to queue, in bytes + + + + + + Set the maximum total duration that can be queued in @appsink. After this +amount of buffers are queued in appsink, any more buffers will block upstream +elements until a sample is pulled from @appsink, unless 'drop' is set, in which +case new buffers will be discarded. + + + + + + + a #GstAppSink + + + + the maximum total duration to queue + + + + Instruct @appsink to wait for all buffers to be consumed when an EOS is received. - + line="1731">Instruct @appsink to wait for all buffers to be consumed when an EOS is received. + @@ -863,13 +968,13 @@ elements until a sample is pulled from @appsink. a #GstAppSink + line="1733">a #GstAppSink the new state + line="1734">the new state @@ -880,7 +985,7 @@ elements until a sample is pulled from @appsink. introspectable="0"> This function blocks until a sample or an event or EOS becomes available or the appsink + line="2020">This function blocks until a sample or an event or EOS becomes available or the appsink element is set to the READY/NULL state or the timeout expires. This function will only return samples when the appsink is in the PLAYING @@ -899,11 +1004,11 @@ to handle incoming events events as well as samples. Note that future releases may extend this API to return other object types so make sure that your code is checking for the actual type it is handling. - + a #GstSample, or #GstEvent or NULL when the appsink is stopped or EOS or the timeout expires. + line="2045">a #GstSample, or #GstEvent or NULL when the appsink is stopped or EOS or the timeout expires. Call gst_mini_object_unref() after usage. @@ -911,13 +1016,13 @@ Call gst_mini_object_unref() after usage. a #GstAppSink + line="2022">a #GstAppSink the maximum amount of time to wait for a sample + line="2023">the maximum amount of time to wait for a sample @@ -927,7 +1032,7 @@ Call gst_mini_object_unref() after usage. version="1.10"> Get the last preroll sample in @appsink. This was the sample that caused the + line="1876">Get the last preroll sample in @appsink. This was the sample that caused the appsink to preroll in the PAUSED state. This function is typically used when dealing with a pipeline in the PAUSED @@ -946,11 +1051,11 @@ condition. This function blocks until a preroll sample or EOS is received, the appsink element is set to the READY/NULL state, or the timeout expires. - + a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. + line="1901">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. Call gst_sample_unref() after usage. @@ -958,13 +1063,13 @@ element is set to the READY/NULL state, or the timeout expires. a #GstAppSink + line="1878">a #GstAppSink the maximum amount of time to wait for the preroll sample + line="1879">the maximum amount of time to wait for the preroll sample @@ -974,7 +1079,7 @@ element is set to the READY/NULL state, or the timeout expires. version="1.10"> This function blocks until a sample or EOS becomes available or the appsink + line="1979">This function blocks until a sample or EOS becomes available or the appsink element is set to the READY/NULL state or the timeout expires. This function will only return samples when the appsink is in the PLAYING @@ -986,11 +1091,11 @@ especially when dealing with raw video frames. If an EOS event was received before any buffers or the timeout expires, this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS condition. - + a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. + line="1997">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. Call gst_sample_unref() after usage. @@ -998,13 +1103,13 @@ condition. a #GstAppSink + line="1981">a #GstAppSink the maximum amount of time to wait for a sample + line="1982">the maximum amount of time to wait for a sample @@ -1047,14 +1152,48 @@ condition. setter="set_max_buffers" getter="get_max_buffers" default-value="0"> + Maximum amount of buffers in the queue (0 = unlimited). + + Maximum amount of bytes in the queue (0 = unlimited) + + + + Maximum total duration of data in the queue (0 = unlimited) + + + Wait for all buffers to be processed after receiving an EOS. + +In cases where it is uncertain if an @appsink will have a consumer for its buffers +when it receives an EOS, set to %FALSE to ensure that the @appsink will not hang. @@ -1071,7 +1210,7 @@ condition. Signal that the end-of-stream has been reached. This signal is emitted from + line="327">Signal that the end-of-stream has been reached. This signal is emitted from the streaming thread. @@ -1080,7 +1219,7 @@ the streaming thread. Signal that a new preroll sample is available. + line="338">Signal that a new preroll sample is available. This signal is emitted from the streaming thread and only when the "emit-signals" property is %TRUE. @@ -1098,7 +1237,7 @@ set to %TRUE, which it is not by default for performance reasons. Signal that a new sample is available. + line="358">Signal that a new sample is available. This signal is emitted from the streaming thread and only when the "emit-signals" property is %TRUE. @@ -1116,7 +1255,7 @@ set to %TRUE, which it is not by default for performance reasons. Signal that a new downstream serialized event is available. + line="395">Signal that a new downstream serialized event is available. This signal is emitted from the streaming thread and only when the "emit-signals" property is %TRUE. @@ -1140,7 +1279,7 @@ skip basesink handling of the event, %FALSE otherwise. Signal that a new propose_allocation query is available. + line="379">Signal that a new propose_allocation query is available. This signal is emitted from the streaming thread and only when the "emit-signals" property is %TRUE. @@ -1151,7 +1290,7 @@ This signal is emitted from the streaming thread and only when the the allocation query + line="382">the allocation query @@ -1159,7 +1298,7 @@ This signal is emitted from the streaming thread and only when the Get the last preroll sample in @appsink. This was the sample that caused the + line="423">Get the last preroll sample in @appsink. This was the sample that caused the appsink to preroll in the PAUSED state. This function is typically used when dealing with a pipeline in the PAUSED @@ -1180,14 +1319,14 @@ element is set to the READY/NULL state. a #GstSample or %NULL when the appsink is stopped or EOS. + line="446">a #GstSample or %NULL when the appsink is stopped or EOS. This function blocks until a sample or EOS becomes available or the appsink + line="452">This function blocks until a sample or EOS becomes available or the appsink element is set to the READY/NULL state. This function will only return samples when the appsink is in the PLAYING @@ -1197,14 +1336,14 @@ can pull samples at its own rate. Note that when the application does not pull samples fast enough, the queued samples could consume a lot of memory, especially when dealing with raw video frames. It's possible to control the behaviour of the queue with -the "drop" and "max-buffers" properties. +the "drop" and "max-buffers" / "max-bytes" / "max-time" set of properties. If an EOS event was received before any buffers, this function returns %NULL. Use gst_app_sink_is_eos () to check for the EOS condition. a #GstSample or %NULL when the appsink is stopped or EOS. + line="471">a #GstSample or %NULL when the appsink is stopped or EOS. @@ -1214,7 +1353,7 @@ If an EOS event was received before any buffers, this function returns version="1.20"> This function blocks until a sample or an event becomes available or the appsink + line="544">This function blocks until a sample or an event becomes available or the appsink element is set to the READY/NULL state or the timeout expires. This function will only return samples when the appsink is in the PLAYING @@ -1225,7 +1364,7 @@ Events can be pulled when the appsink is in the READY, PAUSED or PLAYING state. Note that when the application does not pull samples fast enough, the queued samples could consume a lot of memory, especially when dealing with raw video frames. It's possible to control the behaviour of the queue with -the "drop" and "max-buffers" properties. +the "drop" and "max-buffers" / "max-bytes" / "max-time" set of properties. This function will only pull serialized events, excluding the EOS event for which this functions returns @@ -1239,14 +1378,14 @@ so make sure that your code is checking for the actual type it is handling. a #GstSample or a #GstEvent or NULL when the appsink is stopped or EOS or the timeout expires. + line="572">a #GstSample or a #GstEvent or NULL when the appsink is stopped or EOS or the timeout expires. the maximum amount of time to wait for a sample + line="547">the maximum amount of time to wait for a sample @@ -1257,7 +1396,7 @@ so make sure that your code is checking for the actual type it is handling. Get the last preroll sample in @appsink. This was the sample that caused the + line="478">Get the last preroll sample in @appsink. This was the sample that caused the appsink to preroll in the PAUSED state. This function is typically used when dealing with a pipeline in the PAUSED @@ -1279,7 +1418,7 @@ element is set to the READY/NULL state, or the timeout expires. a #GstSample or %NULL when the appsink + line="503">a #GstSample or %NULL when the appsink is stopped or EOS or the timeout expires. @@ -1287,7 +1426,7 @@ is stopped or EOS or the timeout expires. the maximum amount of time to wait for the preroll sample + line="481">the maximum amount of time to wait for the preroll sample @@ -1298,7 +1437,7 @@ is stopped or EOS or the timeout expires. version="1.10"> This function blocks until a sample or EOS becomes available or the appsink + line="513">This function blocks until a sample or EOS becomes available or the appsink element is set to the READY/NULL state or the timeout expires. This function will only return samples when the appsink is in the PLAYING @@ -1308,7 +1447,7 @@ can pull samples at its own rate. Note that when the application does not pull samples fast enough, the queued samples could consume a lot of memory, especially when dealing with raw video frames. It's possible to control the behaviour of the queue with -the "drop" and "max-buffers" properties. +the "drop" and "max-buffers" / "max-bytes" / "max-time" set of properties. If an EOS event was received before any buffers or the timeout expires, this function returns %NULL. Use gst_app_sink_is_eos () to check @@ -1316,14 +1455,14 @@ for the EOS condition. a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. + line="534">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. the maximum amount of time to wait for a sample + line="516">the maximum amount of time to wait for a sample @@ -1338,6 +1477,10 @@ for the EOS condition. gst_app_sink_set_callbacks(). + Called when the end-of-stream has been reached. This callback + is called from the streaming thread. @@ -1358,6 +1501,13 @@ gst_app_sink_set_callbacks(). + Called when a new preroll sample is available. + This callback is called from the streaming thread. + The new preroll sample can be retrieved with + gst_app_sink_pull_preroll() either from this callback + or from any other thread. @@ -1378,6 +1528,13 @@ gst_app_sink_set_callbacks(). + Called when a new sample is available. + This callback is called from the streaming thread. + The new sample can be retrieved with + gst_app_sink_pull_sample() either from this callback + or from any other thread. @@ -1398,6 +1555,16 @@ gst_app_sink_set_callbacks(). + Called when a new event is available. + This callback is called from the streaming thread. + The new event can be retrieved with + gst_app_sink_pull_event() either from this callback + or from any other thread. + The callback should return %TRUE if the event has been handled, + %FALSE otherwise. + Since: 1.20 @@ -1418,6 +1585,14 @@ gst_app_sink_set_callbacks(). + Called when the propose_allocation query is available. + This callback is called from the streaming thread. + The allocation query can be retrieved with + gst_app_sink_propose_allocation() either from this callback + or from any other thread. + Since: 1.24 @@ -1502,7 +1677,7 @@ gst_app_sink_set_callbacks(). a #GstSample or NULL when the appsink is stopped or EOS. + line="1807">a #GstSample or NULL when the appsink is stopped or EOS. Call gst_sample_unref() after usage. @@ -1510,7 +1685,7 @@ gst_app_sink_set_callbacks(). a #GstAppSink + line="1786">a #GstAppSink @@ -1523,7 +1698,7 @@ gst_app_sink_set_callbacks(). a #GstSample or NULL when the appsink is stopped or EOS. + line="1832">a #GstSample or NULL when the appsink is stopped or EOS. Call gst_sample_unref() after usage. @@ -1531,7 +1706,7 @@ gst_app_sink_set_callbacks(). a #GstAppSink + line="1818">a #GstAppSink @@ -1544,7 +1719,7 @@ gst_app_sink_set_callbacks(). a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. + line="1901">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. Call gst_sample_unref() after usage. @@ -1552,13 +1727,13 @@ gst_app_sink_set_callbacks(). a #GstAppSink + line="1878">a #GstAppSink the maximum amount of time to wait for the preroll sample + line="1879">the maximum amount of time to wait for the preroll sample @@ -1571,7 +1746,7 @@ gst_app_sink_set_callbacks(). a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. + line="1997">a #GstSample or NULL when the appsink is stopped or EOS or the timeout expires. Call gst_sample_unref() after usage. @@ -1579,13 +1754,13 @@ gst_app_sink_set_callbacks(). a #GstAppSink + line="1981">a #GstAppSink the maximum amount of time to wait for a sample + line="1982">the maximum amount of time to wait for a sample @@ -1598,7 +1773,7 @@ gst_app_sink_set_callbacks(). a #GstSample, or #GstEvent or NULL when the appsink is stopped or EOS or the timeout expires. + line="2045">a #GstSample, or #GstEvent or NULL when the appsink is stopped or EOS or the timeout expires. Call gst_mini_object_unref() after usage. @@ -1606,13 +1781,13 @@ Call gst_mini_object_unref() after usage. a #GstAppSink + line="2022">a #GstAppSink the maximum amount of time to wait for a sample + line="2023">the maximum amount of time to wait for a sample @@ -1709,13 +1884,13 @@ occurs or the state of the appsrc has gone through READY. Indicates to the appsrc element that the last buffer queued in the + line="2762">Indicates to the appsrc element that the last buffer queued in the element is the last buffer of the stream. #GST_FLOW_OK when the EOS was successfully queued. + line="2769">#GST_FLOW_OK when the EOS was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. @@ -1723,7 +1898,7 @@ element is the last buffer of the stream. a #GstAppSrc + line="2764">a #GstAppSrc @@ -1756,7 +1931,7 @@ element is the last buffer of the stream. Adds a buffer to the queue of buffers that the appsrc element will + line="2662">Adds a buffer to the queue of buffers that the appsrc element will push to its source pad. This function takes ownership of the buffer. When the block property is TRUE, this function can block until free @@ -1765,7 +1940,7 @@ space becomes available in the queue. #GST_FLOW_OK when the buffer was successfully queued. + line="2673">#GST_FLOW_OK when the buffer was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. #GST_FLOW_EOS when EOS occurred. @@ -1774,13 +1949,13 @@ space becomes available in the queue. a #GstAppSrc + line="2664">a #GstAppSrc a #GstBuffer to push + line="2665">a #GstBuffer to push @@ -1790,7 +1965,7 @@ space becomes available in the queue. version="1.14"> Adds a buffer list to the queue of buffers and buffer lists that the + line="2683">Adds a buffer list to the queue of buffers and buffer lists that the appsrc element will push to its source pad. This function takes ownership of @buffer_list. @@ -1800,7 +1975,7 @@ space becomes available in the queue. #GST_FLOW_OK when the buffer list was successfully queued. + line="2695">#GST_FLOW_OK when the buffer list was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. #GST_FLOW_EOS when EOS occurred. @@ -1809,13 +1984,13 @@ space becomes available in the queue. a #GstAppSrc + line="2685">a #GstAppSrc a #GstBufferList to push + line="2686">a #GstBufferList to push @@ -1823,7 +1998,7 @@ space becomes available in the queue. Extract a buffer from the provided sample and adds it to the queue of + line="2707">Extract a buffer from the provided sample and adds it to the queue of buffers that the appsrc element will push to its source pad. Any previous caps that were set on appsrc will be replaced by the caps associated with the sample if not equal. @@ -1837,7 +2012,7 @@ space becomes available in the queue. #GST_FLOW_OK when the buffer was successfully queued. + line="2724">#GST_FLOW_OK when the buffer was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. #GST_FLOW_EOS when EOS occurred. @@ -1846,13 +2021,13 @@ space becomes available in the queue. a #GstAppSrc + line="2709">a #GstAppSrc a #GstSample from which buffer and caps may be + line="2710">a #GstSample from which buffer and caps may be extracted @@ -1875,13 +2050,13 @@ extracted Indicates to the appsrc element that the last buffer queued in the + line="2762">Indicates to the appsrc element that the last buffer queued in the element is the last buffer of the stream. #GST_FLOW_OK when the EOS was successfully queued. + line="2769">#GST_FLOW_OK when the EOS was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. @@ -1889,7 +2064,7 @@ element is the last buffer of the stream. a #GstAppSrc + line="2764">a #GstAppSrc @@ -1899,19 +2074,19 @@ element is the last buffer of the stream. glib:get-property="caps"> Get the configured caps on @appsrc. + line="1794">Get the configured caps on @appsrc. the #GstCaps produced by the source. gst_caps_unref() after usage. + line="1800">the #GstCaps produced by the source. gst_caps_unref() after usage. a #GstAppSrc + line="1796">a #GstAppSrc @@ -1922,19 +2097,19 @@ element is the last buffer of the stream. version="1.20"> Get the number of currently queued buffers inside @appsrc. + line="2100">Get the number of currently queued buffers inside @appsrc. The number of currently queued buffers. + line="2106">The number of currently queued buffers. a #GstAppSrc + line="2102">a #GstAppSrc @@ -1945,19 +2120,19 @@ element is the last buffer of the stream. version="1.2"> Get the number of currently queued bytes inside @appsrc. + line="2048">Get the number of currently queued bytes inside @appsrc. The number of currently queued bytes. + line="2054">The number of currently queued bytes. a #GstAppSrc + line="2050">a #GstAppSrc @@ -1968,19 +2143,19 @@ element is the last buffer of the stream. version="1.20"> Get the amount of currently queued time inside @appsrc. + line="2152">Get the amount of currently queued time inside @appsrc. The amount of currently queued time. + line="2158">The amount of currently queued time. a #GstAppSrc + line="2154">a #GstAppSrc @@ -1991,20 +2166,20 @@ element is the last buffer of the stream. version="1.10"> Get the duration of the stream in nanoseconds. A value of GST_CLOCK_TIME_NONE means that the duration is + line="1895">Get the duration of the stream in nanoseconds. A value of GST_CLOCK_TIME_NONE means that the duration is not known. the duration of the stream previously set with gst_app_src_set_duration(); + line="1902">the duration of the stream previously set with gst_app_src_set_duration(); a #GstAppSrc + line="1897">a #GstAppSrc @@ -2014,12 +2189,12 @@ not known. glib:get-property="emit-signals"> Check if appsrc will emit the "new-preroll" and "new-buffer" signals. + line="2304">Check if appsrc will emit the "new-preroll" and "new-buffer" signals. %TRUE if @appsrc is emitting the "new-preroll" and "new-buffer" + line="2310">%TRUE if @appsrc is emitting the "new-preroll" and "new-buffer" signals. @@ -2027,7 +2202,7 @@ signals. a #GstAppSrc + line="2306">a #GstAppSrc @@ -2035,7 +2210,7 @@ signals. Retrieve the min and max latencies in @min and @max respectively. + line="2256">Retrieve the min and max latencies in @min and @max respectively. @@ -2044,7 +2219,7 @@ signals. a #GstAppSrc + line="2258">a #GstAppSrc transfer-ownership="full"> the min latency + line="2259">the min latency transfer-ownership="full"> the max latency + line="2260">the max latency @@ -2073,20 +2248,20 @@ signals. version="1.20"> Returns the currently set #GstAppLeakyType. See gst_app_src_set_leaky_type() + line="2222">Returns the currently set #GstAppLeakyType. See gst_app_src_set_leaky_type() for more details. The currently set #GstAppLeakyType. + line="2229">The currently set #GstAppLeakyType. a #GstAppSrc + line="2224">a #GstAppSrc @@ -2097,19 +2272,19 @@ for more details. version="1.20"> Get the maximum amount of buffers that can be queued in @appsrc. + line="2083">Get the maximum amount of buffers that can be queued in @appsrc. The maximum amount of buffers that can be queued. + line="2089">The maximum amount of buffers that can be queued. a #GstAppSrc + line="2085">a #GstAppSrc @@ -2119,19 +2294,19 @@ for more details. glib:get-property="max-bytes"> Get the maximum amount of bytes that can be queued in @appsrc. + line="2033">Get the maximum amount of bytes that can be queued in @appsrc. The maximum amount of bytes that can be queued. + line="2039">The maximum amount of bytes that can be queued. a #GstAppSrc + line="2035">a #GstAppSrc @@ -2142,19 +2317,19 @@ for more details. version="1.20"> Get the maximum amount of time that can be queued in @appsrc. + line="2135">Get the maximum amount of time that can be queued in @appsrc. The maximum amount of time that can be queued. + line="2141">The maximum amount of time that can be queued. a #GstAppSrc + line="2137">a #GstAppSrc @@ -2164,20 +2339,20 @@ for more details. glib:get-property="size"> Get the size of the stream in bytes. A value of -1 means that the size is + line="1842">Get the size of the stream in bytes. A value of -1 means that the size is not known. the size of the stream previously set with gst_app_src_set_size(); + line="1849">the size of the stream previously set with gst_app_src_set_size(); a #GstAppSrc + line="1844">a #GstAppSrc @@ -2187,20 +2362,20 @@ not known. glib:get-property="stream-type"> Get the stream type. Control the stream type of @appsrc + line="1950">Get the stream type. Control the stream type of @appsrc with gst_app_src_set_stream_type(). the stream type. + line="1957">the stream type. a #GstAppSrc + line="1952">a #GstAppSrc @@ -2208,7 +2383,7 @@ with gst_app_src_set_stream_type(). Adds a buffer to the queue of buffers that the appsrc element will + line="2662">Adds a buffer to the queue of buffers that the appsrc element will push to its source pad. This function takes ownership of the buffer. When the block property is TRUE, this function can block until free @@ -2217,7 +2392,7 @@ space becomes available in the queue. #GST_FLOW_OK when the buffer was successfully queued. + line="2673">#GST_FLOW_OK when the buffer was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. #GST_FLOW_EOS when EOS occurred. @@ -2226,13 +2401,13 @@ space becomes available in the queue. a #GstAppSrc + line="2664">a #GstAppSrc a #GstBuffer to push + line="2665">a #GstBuffer to push @@ -2242,7 +2417,7 @@ space becomes available in the queue. version="1.14"> Adds a buffer list to the queue of buffers and buffer lists that the + line="2683">Adds a buffer list to the queue of buffers and buffer lists that the appsrc element will push to its source pad. This function takes ownership of @buffer_list. @@ -2252,7 +2427,7 @@ space becomes available in the queue. #GST_FLOW_OK when the buffer list was successfully queued. + line="2695">#GST_FLOW_OK when the buffer list was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. #GST_FLOW_EOS when EOS occurred. @@ -2261,13 +2436,13 @@ space becomes available in the queue. a #GstAppSrc + line="2685">a #GstAppSrc a #GstBufferList to push + line="2686">a #GstBufferList to push @@ -2277,7 +2452,7 @@ space becomes available in the queue. version="1.6"> Extract a buffer from the provided sample and adds it to the queue of + line="2707">Extract a buffer from the provided sample and adds it to the queue of buffers that the appsrc element will push to its source pad. Any previous caps that were set on appsrc will be replaced by the caps associated with the sample if not equal. @@ -2291,7 +2466,7 @@ space becomes available in the queue. #GST_FLOW_OK when the buffer was successfully queued. + line="2724">#GST_FLOW_OK when the buffer was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. #GST_FLOW_EOS when EOS occurred. @@ -2300,13 +2475,13 @@ space becomes available in the queue. a #GstAppSrc + line="2709">a #GstAppSrc a #GstSample from which buffer and caps may be + line="2710">a #GstSample from which buffer and caps may be extracted @@ -2317,7 +2492,7 @@ extracted introspectable="0"> Set callbacks which will be executed when data is needed, enough data has + line="2803">Set callbacks which will be executed when data is needed, enough data has been collected or when a seek should be performed. This is an alternative to using the signals, it has lower overhead and is thus less expensive, but also less flexible. @@ -2335,13 +2510,13 @@ way. a #GstAppSrc + line="2805">a #GstAppSrc the callbacks + line="2806">the callbacks allow-none="1"> a user_data argument for the callbacks + line="2807">a user_data argument for the callbacks a destroy notify function + line="2808">a destroy notify function @@ -2366,7 +2541,7 @@ way. glib:set-property="caps"> Set the capabilities on the appsrc element. This function takes + line="1744">Set the capabilities on the appsrc element. This function takes a copy of the caps structure. After calling this method, the source will only produce caps that match @caps. @caps must be fixed and the caps on the buffers must match the caps or left NULL. @@ -2378,7 +2553,7 @@ buffers must match the caps or left NULL. a #GstAppSrc + line="1746">a #GstAppSrc allow-none="1"> caps to set + line="1747">caps to set @@ -2398,7 +2573,7 @@ buffers must match the caps or left NULL. version="1.10"> Set the duration of the stream in nanoseconds. A value of GST_CLOCK_TIME_NONE means that the duration is + line="1869">Set the duration of the stream in nanoseconds. A value of GST_CLOCK_TIME_NONE means that the duration is not known. @@ -2408,13 +2583,13 @@ not known. a #GstAppSrc + line="1871">a #GstAppSrc the duration to set + line="1872">the duration to set @@ -2424,7 +2599,7 @@ not known. glib:set-property="emit-signals"> Make appsrc emit the "new-preroll" and "new-buffer" signals. This option is + line="2281">Make appsrc emit the "new-preroll" and "new-buffer" signals. This option is by default disabled because signal emission is expensive and unneeded when the application prefers to operate in pull mode. @@ -2435,13 +2610,13 @@ the application prefers to operate in pull mode. a #GstAppSrc + line="2283">a #GstAppSrc the new state + line="2284">the new state @@ -2449,7 +2624,7 @@ the application prefers to operate in pull mode. Configure the @min and @max latency in @src. If @min is set to -1, the + line="2241">Configure the @min and @max latency in @src. If @min is set to -1, the default latency calculations for pseudo-live sources will be used. @@ -2459,19 +2634,19 @@ default latency calculations for pseudo-live sources will be used. a #GstAppSrc + line="2243">a #GstAppSrc the min latency + line="2244">the min latency the max latency + line="2245">the max latency @@ -2482,7 +2657,7 @@ default latency calculations for pseudo-live sources will be used. version="1.20"> When set to any other value than GST_APP_LEAKY_TYPE_NONE then the appsrc + line="2202">When set to any other value than GST_APP_LEAKY_TYPE_NONE then the appsrc will drop any buffers that are pushed into it once its internal queue is full. The selected type defines whether to drop the oldest or new buffers. @@ -2494,13 +2669,13 @@ buffers. a #GstAppSrc + line="2204">a #GstAppSrc the #GstAppLeakyType + line="2205">the #GstAppLeakyType @@ -2511,7 +2686,7 @@ buffers. version="1.20"> Set the maximum amount of buffers that can be queued in @appsrc. + line="2065">Set the maximum amount of buffers that can be queued in @appsrc. After the maximum amount of buffers are queued, @appsrc will emit the "enough-data" signal. @@ -2522,13 +2697,13 @@ After the maximum amount of buffers are queued, @appsrc will emit the a #GstAppSrc + line="2067">a #GstAppSrc the maximum number of buffers to queue + line="2068">the maximum number of buffers to queue @@ -2538,7 +2713,7 @@ After the maximum amount of buffers are queued, @appsrc will emit the glib:set-property="max-bytes"> Set the maximum amount of bytes that can be queued in @appsrc. + line="2017">Set the maximum amount of bytes that can be queued in @appsrc. After the maximum amount of bytes are queued, @appsrc will emit the "enough-data" signal. @@ -2549,13 +2724,13 @@ After the maximum amount of bytes are queued, @appsrc will emit the a #GstAppSrc + line="2019">a #GstAppSrc the maximum number of bytes to queue + line="2020">the maximum number of bytes to queue @@ -2566,7 +2741,7 @@ After the maximum amount of bytes are queued, @appsrc will emit the version="1.20"> Set the maximum amount of time that can be queued in @appsrc. + line="2117">Set the maximum amount of time that can be queued in @appsrc. After the maximum amount of time are queued, @appsrc will emit the "enough-data" signal. @@ -2577,13 +2752,13 @@ After the maximum amount of time are queued, @appsrc will emit the a #GstAppSrc + line="2119">a #GstAppSrc the maximum amonut of time to queue + line="2120">the maximum amonut of time to queue @@ -2593,7 +2768,7 @@ After the maximum amount of time are queued, @appsrc will emit the glib:set-property="size"> Set the size of the stream in bytes. A value of -1 means that the size is + line="1819">Set the size of the stream in bytes. A value of -1 means that the size is not known. @@ -2603,13 +2778,13 @@ not known. a #GstAppSrc + line="1821">a #GstAppSrc the size to set + line="1822">the size to set @@ -2619,7 +2794,7 @@ not known. glib:set-property="stream-type"> Set the stream type on @appsrc. For seekable streams, the "seek" signal must + line="1925">Set the stream type on @appsrc. For seekable streams, the "seek" signal must be connected to. A stream_type stream @@ -2631,13 +2806,13 @@ A stream_type stream a #GstAppSrc + line="1927">a #GstAppSrc the new state + line="1928">the new state @@ -2648,7 +2823,7 @@ A stream_type stream default-value="FALSE"> When max-bytes are queued and after the enough-data signal has been emitted, + line="414">When max-bytes are queued and after the enough-data signal has been emitted, block any further push-buffer calls until the amount of queued bytes drops below the max-bytes limit. @@ -2660,7 +2835,7 @@ below the max-bytes limit. getter="get_caps"> The GstCaps that will negotiated downstream and will be put + line="329">The GstCaps that will negotiated downstream and will be put on outgoing buffers. @@ -2671,7 +2846,7 @@ on outgoing buffers. default-value="0"> The number of currently queued buffers inside appsrc. + line="497">The number of currently queued buffers inside appsrc. default-value="0"> The number of currently queued bytes inside appsrc. + line="484">The number of currently queued bytes inside appsrc. default-value="0"> The amount of currently queued time inside appsrc. + line="510">The amount of currently queued time inside appsrc. default-value="18446744073709551615"> The total duration in nanoseconds of the data stream. If the total duration is known, it + line="523">The total duration in nanoseconds of the data stream. If the total duration is known, it is recommended to configure it with this property. @@ -2715,7 +2890,7 @@ is recommended to configure it with this property. default-value="TRUE"> Make appsrc emit the "need-data", "enough-data" and "seek-data" signals. + line="459">Make appsrc emit the "need-data", "enough-data" and "seek-data" signals. This option is by default enabled for backwards compatibility reasons but can disabled when needed because signal emission is expensive. @@ -2726,7 +2901,7 @@ can disabled when needed because signal emission is expensive. default-value="GST_FORMAT_BYTES"> The format to use for segment events. When the source is producing + line="339">The format to use for segment events. When the source is producing timestamped buffers this property should be set to GST_FORMAT_TIME. @@ -2737,7 +2912,7 @@ timestamped buffers this property should be set to GST_FORMAT_TIME. default-value="FALSE"> When enabled, appsrc will check GstSegment in GstSample which was + line="537">When enabled, appsrc will check GstSegment in GstSample which was pushed via gst_app_src_push_sample() or "push-sample" signal action. If a GstSegment is changed, corresponding segment event will be followed by next data flow. @@ -2753,7 +2928,7 @@ other formats. default-value="FALSE"> Instruct the source to behave like a live source. This includes that it + line="426">Instruct the source to behave like a live source. This includes that it will only push out buffers in the PLAYING state. @@ -2766,7 +2941,7 @@ will only push out buffers in the PLAYING state. default-value="GST_APP_LEAKY_TYPE_NONE"> When set to any other value than GST_APP_LEAKY_TYPE_NONE then the appsrc + line="560">When set to any other value than GST_APP_LEAKY_TYPE_NONE then the appsrc will drop any buffers that are pushed into it once its internal queue is full. The selected type defines whether to drop the oldest or new buffers. @@ -2781,7 +2956,7 @@ buffers. default-value="0"> The maximum amount of buffers that can be queued internally. + line="384">The maximum amount of buffers that can be queued internally. After the maximum amount of buffers are queued, appsrc will emit the "enough-data" signal. @@ -2794,7 +2969,7 @@ After the maximum amount of buffers are queued, appsrc will emit the default-value="200000"> The maximum amount of bytes that can be queued internally. + line="371">The maximum amount of bytes that can be queued internally. After the maximum amount of bytes are queued, appsrc will emit the "enough-data" signal. @@ -2814,7 +2989,7 @@ After the maximum amount of bytes are queued, appsrc will emit the default-value="0"> The maximum amount of time that can be queued internally. + line="399">The maximum amount of time that can be queued internally. After the maximum amount of time are queued, appsrc will emit the "enough-data" signal. @@ -2825,7 +3000,7 @@ After the maximum amount of time are queued, appsrc will emit the default-value="-1"> The minimum latency of the source. A value of -1 will use the default + line="436">The minimum latency of the source. A value of -1 will use the default latency calculations of #GstBaseSrc. @@ -2835,7 +3010,7 @@ latency calculations of #GstBaseSrc. default-value="0"> Make appsrc emit the "need-data" signal when the amount of bytes in the + line="472">Make appsrc emit the "need-data" signal when the amount of bytes in the queue drops below this percentage of max-bytes. @@ -2847,7 +3022,7 @@ queue drops below this percentage of max-bytes. default-value="-1"> The total size in bytes of the data stream. If the total size is known, it + line="349">The total size in bytes of the data stream. If the total size is known, it is recommended to configure it with this property. @@ -2859,7 +3034,7 @@ is recommended to configure it with this property. default-value="GST_APP_STREAM_TYPE_STREAM"> The type of stream that this source is producing. For seekable streams the + line="360">The type of stream that this source is producing. For seekable streams the application should connect to the seek-data signal. @@ -2877,7 +3052,7 @@ application should connect to the seek-data signal. Notify @appsrc that no more buffer are available. + line="698">Notify @appsrc that no more buffer are available. @@ -2885,7 +3060,7 @@ application should connect to the seek-data signal. Signal that the source has enough data. It is recommended that the + line="597">Signal that the source has enough data. It is recommended that the application stops calling push-buffer until the need-data signal is emitted again to avoid excessive buffer queueing. @@ -2895,7 +3070,7 @@ emitted again to avoid excessive buffer queueing. Signal that the source needs more data. In the callback or from another + line="578">Signal that the source needs more data. In the callback or from another thread you should call push-buffer or end-of-stream. @length is just a hint and when it is set to -1, any number of bytes can be @@ -2910,7 +3085,7 @@ fired. the amount of bytes needed. + line="581">the amount of bytes needed. @@ -2918,7 +3093,7 @@ fired. Adds a buffer to the queue of buffers that the appsrc element will + line="626">Adds a buffer to the queue of buffers that the appsrc element will push to its source pad. This function does not take ownership of the buffer, but it takes a @@ -2934,7 +3109,7 @@ becomes available in the queue. a buffer to push + line="629">a buffer to push @@ -2945,7 +3120,7 @@ becomes available in the queue. version="1.14"> Adds a buffer list to the queue of buffers and buffer lists that the + line="647">Adds a buffer list to the queue of buffers and buffer lists that the appsrc element will push to its source pad. This function does not take ownership of the buffer list, but it takes a @@ -2961,7 +3136,7 @@ becomes available in the queue. a buffer list to push + line="650">a buffer list to push @@ -2969,7 +3144,7 @@ becomes available in the queue. Extract a buffer from the provided sample and adds the extracted buffer + line="670">Extract a buffer from the provided sample and adds the extracted buffer to the queue of buffers that the appsrc element will push to its source pad. This function set the appsrc caps based on the caps in the sample and reset the caps if they change. @@ -2989,7 +3164,7 @@ becomes available in the queue. a sample from which extract buffer to push + line="673">a sample from which extract buffer to push @@ -2997,20 +3172,20 @@ becomes available in the queue. Seek to the given offset. The next push-buffer should produce buffers from + line="610">Seek to the given offset. The next push-buffer should produce buffers from the new @offset. This callback is only called for seekable stream types. %TRUE if the seek succeeded. + line="619">%TRUE if the seek succeeded. the offset to seek to + line="613">the offset to seek to @@ -3025,6 +3200,11 @@ This callback is only called for seekable stream types. gst_app_src_set_callbacks(). + Called when the appsrc needs more data. A buffer or EOS should be + pushed to appsrc from this thread or another thread. @length is just a hint + and when it is set to -1, any number of bytes can be pushed into @appsrc. @@ -3048,6 +3228,11 @@ gst_app_src_set_callbacks(). + Called when appsrc has enough data. It is recommended that the + application stops calling push-buffer until the need_data callback is + emitted again to avoid excessive buffer queueing. @@ -3068,6 +3253,11 @@ gst_app_src_set_callbacks(). + Called when a seek should be performed to the offset. + The next push-buffer should produce buffers from the new @offset. + This callback is only called for seekable stream types. @@ -3154,7 +3344,7 @@ gst_app_src_set_callbacks(). #GST_FLOW_OK when the buffer was successfully queued. + line="2673">#GST_FLOW_OK when the buffer was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. #GST_FLOW_EOS when EOS occurred. @@ -3163,13 +3353,13 @@ gst_app_src_set_callbacks(). a #GstAppSrc + line="2664">a #GstAppSrc a #GstBuffer to push + line="2665">a #GstBuffer to push @@ -3181,7 +3371,7 @@ gst_app_src_set_callbacks(). #GST_FLOW_OK when the EOS was successfully queued. + line="2769">#GST_FLOW_OK when the EOS was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. @@ -3189,7 +3379,7 @@ gst_app_src_set_callbacks(). a #GstAppSrc + line="2764">a #GstAppSrc @@ -3201,7 +3391,7 @@ gst_app_src_set_callbacks(). #GST_FLOW_OK when the buffer was successfully queued. + line="2724">#GST_FLOW_OK when the buffer was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. #GST_FLOW_EOS when EOS occurred. @@ -3210,13 +3400,13 @@ gst_app_src_set_callbacks(). a #GstAppSrc + line="2709">a #GstAppSrc a #GstSample from which buffer and caps may be + line="2710">a #GstSample from which buffer and caps may be extracted @@ -3229,7 +3419,7 @@ extracted #GST_FLOW_OK when the buffer list was successfully queued. + line="2695">#GST_FLOW_OK when the buffer list was successfully queued. #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING. #GST_FLOW_EOS when EOS occurred. @@ -3238,13 +3428,13 @@ extracted a #GstAppSrc + line="2685">a #GstAppSrc a #GstBufferList to push + line="2686">a #GstBufferList to push diff --git a/girs/GstAudio-1.0.gir b/girs/GstAudio-1.0.gir index 2d41b0400..691ac2a04 100644 --- a/girs/GstAudio-1.0.gir +++ b/girs/GstAudio-1.0.gir @@ -1569,7 +1569,7 @@ transition band for the kaiser window. 0.087 is the default. c:identifier="GST_AUDIO_RING_BUFFER" introspectable="0"> + line="35"/> @@ -1579,7 +1579,7 @@ transition band for the kaiser window. 0.087 is the default. c:identifier="GST_AUDIO_RING_BUFFER_BROADCAST" introspectable="0"> + line="187"/> @@ -1589,7 +1589,7 @@ transition band for the kaiser window. 0.087 is the default. c:identifier="GST_AUDIO_RING_BUFFER_CAST" introspectable="0"> + line="38"/> @@ -1599,7 +1599,7 @@ transition band for the kaiser window. 0.087 is the default. c:identifier="GST_AUDIO_RING_BUFFER_CLASS" introspectable="0"> + line="36"/> @@ -1609,7 +1609,7 @@ transition band for the kaiser window. 0.087 is the default. c:identifier="GST_AUDIO_RING_BUFFER_GET_CLASS" introspectable="0"> + line="37"/> @@ -1619,7 +1619,7 @@ transition band for the kaiser window. 0.087 is the default. c:identifier="GST_AUDIO_RING_BUFFER_GET_COND" introspectable="0"> + line="184"/> @@ -1629,17 +1629,97 @@ transition band for the kaiser window. 0.087 is the default. c:identifier="GST_AUDIO_RING_BUFFER_SIGNAL" introspectable="0"> + line="186"/> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + line="185"/> @@ -1849,7 +1929,7 @@ additional information in the info #GstStructure of the returned sample: default-value="FALSE"> Causes the element to aggregate on a timeout even when no live source is + line="745">Causes the element to aggregate on a timeout even when no live source is connected to its sinks. See #GstAggregator:min-upstream-latency for a companion property: in the vast majority of cases where you plan to plug in live sources with a non-zero latency, you should set it to a non-zero value. @@ -1862,7 +1942,7 @@ live sources with a non-zero latency, you should set it to a non-zero value. Don't wait for inactive pads when live. An inactive pad + line="725">Don't wait for inactive pads when live. An inactive pad is a pad that hasn't yet received a buffer, but that has been waited on at least once. @@ -1885,7 +1965,7 @@ but wants to configure it already. default-value="1/100"> Output block size in nanoseconds, expressed as a fraction. + line="694">Output block size in nanoseconds, expressed as a fraction. @@ -2207,7 +2287,7 @@ writing samples to the ringbuffer, synchronisation, clipping and flushing. Create and return the #GstAudioRingBuffer for @sink. This function will + line="2260">Create and return the #GstAudioRingBuffer for @sink. This function will call the ::create_ringbuffer vmethod and will set @sink as the parent of the returned buffer (see gst_object_set_parent()). The new ringbuffer of @sink. + line="2268">The new ringbuffer of @sink. a #GstAudioBaseSink. + line="2262">a #GstAudioBaseSink. @@ -2252,7 +2332,7 @@ the returned buffer (see gst_object_set_parent()). c:identifier="gst_audio_base_sink_create_ringbuffer"> Create and return the #GstAudioRingBuffer for @sink. This function will + line="2260">Create and return the #GstAudioRingBuffer for @sink. This function will call the ::create_ringbuffer vmethod and will set @sink as the parent of the returned buffer (see gst_object_set_parent()). The new ringbuffer of @sink. + line="2268">The new ringbuffer of @sink. a #GstAudioBaseSink. + line="2262">a #GstAudioBaseSink. @@ -2721,14 +2801,14 @@ functionality. The new ringbuffer of @sink. + line="2268">The new ringbuffer of @sink. a #GstAudioBaseSink. + line="2262">a #GstAudioBaseSink. @@ -2974,7 +3054,7 @@ reading samples from the ringbuffer, synchronisation and flushing. Create and return the #GstAudioRingBuffer for @src. This function will call + line="1081">Create and return the #GstAudioRingBuffer for @src. This function will call the ::create_ringbuffer vmethod and will set @src as the parent of the returned buffer (see gst_object_set_parent()). The new ringbuffer of @src. + line="1089">The new ringbuffer of @src. a #GstAudioBaseSrc. + line="1083">a #GstAudioBaseSrc. @@ -2998,7 +3078,7 @@ returned buffer (see gst_object_set_parent()). c:identifier="gst_audio_base_src_create_ringbuffer"> Create and return the #GstAudioRingBuffer for @src. This function will call + line="1081">Create and return the #GstAudioRingBuffer for @src. This function will call the ::create_ringbuffer vmethod and will set @src as the parent of the returned buffer (see gst_object_set_parent()). The new ringbuffer of @src. + line="1089">The new ringbuffer of @src. a #GstAudioBaseSrc. + line="1083">a #GstAudioBaseSrc. @@ -3023,21 +3103,21 @@ returned buffer (see gst_object_set_parent()). glib:get-property="provide-clock"> Queries whether @src will provide a clock or not. See also + line="359">Queries whether @src will provide a clock or not. See also gst_audio_base_src_set_provide_clock. %TRUE if @src will provide a clock. + line="366">%TRUE if @src will provide a clock. a #GstAudioBaseSrc + line="361">a #GstAudioBaseSrc @@ -3047,13 +3127,13 @@ gst_audio_base_src_set_provide_clock. glib:get-property="slave-method"> Get the current slave method used by @src. + line="400">Get the current slave method used by @src. The current slave method used by @src. + line="406">The current slave method used by @src. @@ -3061,7 +3141,7 @@ gst_audio_base_src_set_provide_clock. a #GstAudioBaseSrc + line="402">a #GstAudioBaseSrc @@ -3071,7 +3151,7 @@ gst_audio_base_src_set_provide_clock. glib:set-property="provide-clock"> Controls whether @src will provide a clock or not. If @provide is %TRUE, + line="337">Controls whether @src will provide a clock or not. If @provide is %TRUE, gst_element_provide_clock() will return a clock that reflects the datarate of @src. If @provide is %FALSE, gst_element_provide_clock() will return NULL. a #GstAudioBaseSrc + line="339">a #GstAudioBaseSrc new state + line="340">new state @@ -3099,7 +3179,7 @@ of @src. If @provide is %FALSE, gst_element_provide_clock() will return NULL. Controls how clock slaving will be performed in @src. + line="382">Controls how clock slaving will be performed in @src. @@ -3109,13 +3189,13 @@ of @src. If @provide is %FALSE, gst_element_provide_clock() will return NULL. a #GstAudioBaseSrc + line="384">a #GstAudioBaseSrc the new slave method + line="385">the new slave method @@ -3126,7 +3206,7 @@ of @src. If @provide is %FALSE, gst_element_provide_clock() will return NULL. Actual configured size of audio buffer in microseconds. + line="159">Actual configured size of audio buffer in microseconds. Actual configured audio latency in microseconds. + line="170">Actual configured audio latency in microseconds. The new ringbuffer of @src. + line="1089">The new ringbuffer of @src. a #GstAudioBaseSrc. + line="1083">a #GstAudioBaseSrc. @@ -3379,7 +3459,7 @@ gst_audio_buffer_map(). After calling this function the caller does not own a reference to @buffer anymore. - + c:identifier="gst_audio_buffer_reorder_channels"> Reorders @buffer from the channel positions @from to the channel + line="279">Reorders @buffer from the channel positions @from to the channel positions @to. @from and @to must contain the same number of positions and the same positions, only in a different order. @buffer must be writable. @@ -3497,32 +3577,32 @@ positions and the same positions, only in a different order. %TRUE if the reordering was possible. + line="292">%TRUE if the reordering was possible. The buffer to reorder. + line="281">The buffer to reorder. The %GstAudioFormat of the buffer. + line="282">The %GstAudioFormat of the buffer. The number of channels. + line="283">The number of channels. The channel positions in the buffer. + line="284">The channel positions in the buffer. @@ -3533,7 +3613,7 @@ positions and the same positions, only in a different order. The channel positions to convert to. + line="285">The channel positions to convert to. @@ -3560,7 +3640,7 @@ offset end will be preserved / updated. After calling this function the caller does not own a reference to @buffer anymore. - + c:identifier="gst_audio_channel_mixer_is_passthrough"> Check if @mix is in passthrough. + line="1004">Check if @mix is in passthrough. Only N x N mix identity matrices are considered passthrough, this is determined by comparing the contents of the matrix @@ -3980,14 +4060,14 @@ constitute an appropriate epsilon. %TRUE is @mix is passthrough. + line="1020">%TRUE is @mix is passthrough. a #GstAudioChannelMixer + line="1006">a #GstAudioChannelMixer @@ -3995,7 +4075,7 @@ constitute an appropriate epsilon. In case the samples are interleaved, @in and @out must point to an + line="1047">In case the samples are interleaved, @in and @out must point to an array with a single element pointing to a block of interleaved samples. If non-interleaved samples are used, @in and @out must point to an @@ -4012,7 +4092,7 @@ Perform channel mixing on @in_data and write the result to @out_data. a #GstAudioChannelMixer + line="1049">a #GstAudioChannelMixer input samples + line="1050">input samples output samples + line="1051">output samples number of samples + line="1052">number of samples @@ -4046,13 +4126,13 @@ Perform channel mixing on @in_data and write the result to @out_data. introspectable="0"> Create a new channel mixer object for the given parameters. + line="970">Create a new channel mixer object for the given parameters. a new #GstAudioChannelMixer object. + line="980">a new #GstAudioChannelMixer object. Free with gst_audio_channel_mixer_free() after usage. @@ -4060,7 +4140,7 @@ Perform channel mixing on @in_data and write the result to @out_data. #GstAudioChannelMixerFlags + line="972">#GstAudioChannelMixerFlags @@ -4070,26 +4150,26 @@ Perform channel mixing on @in_data and write the result to @out_data. number of input channels + line="973">number of input channels positions of input channels + line="974">positions of input channels number of output channels + line="975">number of output channels positions of output channels + line="976">positions of output channels @@ -5792,27 +5872,27 @@ negotiate fails. c:identifier="gst_audio_decoder_allocate_output_buffer"> Helper function that allocates a buffer to hold an audio frame + line="3781">Helper function that allocates a buffer to hold an audio frame for @dec's current output format. allocated buffer + line="3789">allocated buffer a #GstAudioDecoder + line="3783">a #GstAudioDecoder size of the buffer + line="3784">size of the buffer @@ -5911,7 +5991,7 @@ invalidated by a call to this function. c:identifier="gst_audio_decoder_get_allocator"> Lets #GstAudioDecoder sub-classes to know the memory @allocator + line="3832">Lets #GstAudioDecoder sub-classes to know the memory @allocator used by the base class and its @params. Unref the @allocator after use it. @@ -5924,7 +6004,7 @@ Unref the @allocator after use it. a #GstAudioDecoder + line="3834">a #GstAudioDecoder allow-none="1"> the #GstAllocator + line="3835">the #GstAllocator used @@ -5948,7 +6028,7 @@ used allow-none="1"> the + line="3837">the #GstAllocationParams of @allocator @@ -5961,14 +6041,14 @@ used a #GstAudioInfo describing the input audio format + line="3291">a #GstAudioInfo describing the input audio format a #GstAudioDecoder + line="3289">a #GstAudioDecoder @@ -5979,14 +6059,14 @@ used currently configured decoder delay + line="3363">currently configured decoder delay a #GstAudioDecoder + line="3361">a #GstAudioDecoder @@ -5995,13 +6075,13 @@ used c:identifier="gst_audio_decoder_get_drainable"> Queries decoder drain handling. + line="3670">Queries decoder drain handling. TRUE if drainable handling is enabled. + line="3676">TRUE if drainable handling is enabled. MT safe. @@ -6010,7 +6090,7 @@ MT safe. a #GstAudioDecoder + line="3672">a #GstAudioDecoder @@ -6022,14 +6102,14 @@ MT safe. currently configured byte to time conversion setting + line="3349">currently configured byte to time conversion setting a #GstAudioDecoder + line="3347">a #GstAudioDecoder @@ -6037,7 +6117,7 @@ MT safe. Sets the variables pointed to by @min and @max to the currently configured + line="3450">Sets the variables pointed to by @min and @max to the currently configured latency. @@ -6048,7 +6128,7 @@ latency. a #GstAudioDecoder + line="3452">a #GstAudioDecoder allow-none="1"> a pointer to storage to hold minimum latency + line="3453">a pointer to storage to hold minimum latency allow-none="1"> a pointer to storage to hold maximum latency + line="3454">a pointer to storage to hold maximum latency @@ -6083,14 +6163,14 @@ latency. currently configured decoder tolerated error count. + line="3395">currently configured decoder tolerated error count. a #GstAudioDecoder + line="3393">a #GstAudioDecoder @@ -6100,13 +6180,13 @@ latency. glib:get-property="min-latency"> Queries decoder's latency aggregation. + line="3580">Queries decoder's latency aggregation. aggregation latency. + line="3586">aggregation latency. MT safe. @@ -6115,7 +6195,7 @@ MT safe. a #GstAudioDecoder + line="3582">a #GstAudioDecoder @@ -6124,13 +6204,13 @@ MT safe. c:identifier="gst_audio_decoder_get_needs_format"> Queries decoder required format handling. + line="3718">Queries decoder required format handling. TRUE if required format handling is enabled. + line="3724">TRUE if required format handling is enabled. MT safe. @@ -6139,7 +6219,7 @@ MT safe. a #GstAudioDecoder + line="3720">a #GstAudioDecoder @@ -6148,7 +6228,7 @@ MT safe. c:identifier="gst_audio_decoder_get_parse_state"> Return current parsing (sync and eos) state. + line="3473">Return current parsing (sync and eos) state. @@ -6158,7 +6238,7 @@ MT safe. a #GstAudioDecoder + line="3475">a #GstAudioDecoder allow-none="1"> a pointer to a variable to hold the current sync state + line="3476">a pointer to a variable to hold the current sync state allow-none="1"> a pointer to a variable to hold the current eos state + line="3477">a pointer to a variable to hold the current eos state @@ -6190,13 +6270,13 @@ MT safe. glib:get-property="plc"> Queries decoder packet loss concealment handling. + line="3536">Queries decoder packet loss concealment handling. TRUE if packet loss concealment is enabled. + line="3542">TRUE if packet loss concealment is enabled. MT safe. @@ -6205,7 +6285,7 @@ MT safe. a #GstAudioDecoder + line="3538">a #GstAudioDecoder @@ -6217,14 +6297,14 @@ MT safe. currently configured plc handling + line="3320">currently configured plc handling a #GstAudioDecoder + line="3318">a #GstAudioDecoder @@ -6234,13 +6314,13 @@ MT safe. glib:get-property="tolerance"> Queries current audio jitter tolerance threshold. + line="3624">Queries current audio jitter tolerance threshold. decoder audio jitter tolerance threshold. + line="3630">decoder audio jitter tolerance threshold. MT safe. @@ -6249,7 +6329,7 @@ MT safe. a #GstAudioDecoder + line="3626">a #GstAudioDecoder @@ -6257,7 +6337,7 @@ MT safe. Sets the audio decoder tags and how they should be merged with any + line="3742">Sets the audio decoder tags and how they should be merged with any upstream stream tags. This will override any tags previously-set with gst_audio_decoder_merge_tags(). @@ -6272,7 +6352,7 @@ not required to use this and can still do tag handling on its own. a #GstAudioDecoder + line="3744">a #GstAudioDecoder allow-none="1"> a #GstTagList to merge, or NULL + line="3745">a #GstTagList to merge, or NULL the #GstTagMergeMode to use, usually #GST_TAG_MERGE_REPLACE + line="3746">the #GstTagMergeMode to use, usually #GST_TAG_MERGE_REPLACE @@ -6320,7 +6400,7 @@ negotiate fails. version="1.6"> Returns caps that express @caps (or sink template caps if @caps == NULL) + line="2779">Returns caps that express @caps (or sink template caps if @caps == NULL) restricted to rate/channels/... combinations supported by downstream elements. a #GstCaps owned by caller + line="2789">a #GstCaps owned by caller a #GstAudioDecoder + line="2781">a #GstAudioDecoder allow-none="1"> initial caps + line="2782">initial caps allow-none="1"> filter caps + line="2783">filter caps @@ -6363,7 +6443,7 @@ elements. version="1.10"> Sets a caps in allocation query which are different from the set + line="3493">Sets a caps in allocation query which are different from the set pad's caps. Use this function before calling gst_audio_decoder_negotiate(). Setting to %NULL the allocation query will use the caps from the pad. @@ -6376,7 +6456,7 @@ query will use the caps from the pad. a #GstAudioDecoder + line="3495">a #GstAudioDecoder allow-none="1"> a #GstCaps or %NULL + line="3496">a #GstCaps or %NULL @@ -6394,7 +6474,7 @@ query will use the caps from the pad. c:identifier="gst_audio_decoder_set_drainable"> Configures decoder drain handling. If drainable, subclass might + line="3648">Configures decoder drain handling. If drainable, subclass might be handed a NULL buffer to have it return any leftover decoded data. Otherwise, it is not considered so capable and will only ever be passed real data. @@ -6409,13 +6489,13 @@ MT safe. a #GstAudioDecoder + line="3650">a #GstAudioDecoder new state + line="3651">new state @@ -6424,7 +6504,7 @@ MT safe. c:identifier="gst_audio_decoder_set_estimate_rate"> Allows baseclass to perform byte to time estimated conversion. + line="3330">Allows baseclass to perform byte to time estimated conversion. @@ -6434,13 +6514,13 @@ MT safe. a #GstAudioDecoder + line="3332">a #GstAudioDecoder whether to enable byte to time conversion + line="3333">whether to enable byte to time conversion @@ -6448,7 +6528,7 @@ MT safe. Sets decoder latency. If the provided values changed from + line="3405">Sets decoder latency. If the provided values changed from previously provided ones, this will also post a LATENCY message on the bus so the pipeline can reconfigure its global latency. a #GstAudioDecoder + line="3407">a #GstAudioDecoder minimum latency + line="3408">minimum latency maximum latency + line="3409">maximum latency @@ -6482,7 +6562,7 @@ so the pipeline can reconfigure its global latency. glib:set-property="max-errors"> Sets numbers of tolerated decoder errors, where a tolerated one is then only + line="3373">Sets numbers of tolerated decoder errors, where a tolerated one is then only warned about, but more than tolerated will lead to fatal error. You can set -1 for never returning fatal errors. Default is set to GST_AUDIO_DECODER_MAX_ERRORS. @@ -6495,13 +6575,13 @@ GST_AUDIO_DECODER_MAX_ERRORS. a #GstAudioDecoder + line="3375">a #GstAudioDecoder max tolerated errors + line="3376">max tolerated errors @@ -6511,7 +6591,7 @@ GST_AUDIO_DECODER_MAX_ERRORS. glib:set-property="min-latency"> Sets decoder minimum aggregation latency. + line="3560">Sets decoder minimum aggregation latency. MT safe. a #GstAudioDecoder + line="3562">a #GstAudioDecoder new minimum latency + line="3563">new minimum latency @@ -6538,7 +6618,7 @@ MT safe. c:identifier="gst_audio_decoder_set_needs_format"> Configures decoder format needs. If enabled, subclass needs to be + line="3694">Configures decoder format needs. If enabled, subclass needs to be negotiated with format caps before it can process any data. It will then never be handed any data before it has been configured. Otherwise, it might be handed data without having been configured and @@ -6555,13 +6635,13 @@ MT safe. a #GstAudioDecoder + line="3696">a #GstAudioDecoder new state + line="3697">new state @@ -6631,7 +6711,7 @@ caps features. glib:set-property="plc"> Enable or disable decoder packet loss concealment, provided subclass + line="3514">Enable or disable decoder packet loss concealment, provided subclass and codec are capable and allow handling plc. MT safe. @@ -6644,13 +6724,13 @@ MT safe. a #GstAudioDecoder + line="3516">a #GstAudioDecoder new state + line="3517">new state @@ -6659,7 +6739,7 @@ MT safe. c:identifier="gst_audio_decoder_set_plc_aware"> Indicates whether or not subclass handles packet loss concealment (plc). + line="3301">Indicates whether or not subclass handles packet loss concealment (plc). @@ -6669,13 +6749,13 @@ MT safe. a #GstAudioDecoder + line="3303">a #GstAudioDecoder new plc state + line="3304">new plc state @@ -6685,7 +6765,7 @@ MT safe. glib:set-property="tolerance"> Configures decoder audio jitter tolerance threshold. + line="3604">Configures decoder audio jitter tolerance threshold. MT safe. a #GstAudioDecoder + line="3606">a #GstAudioDecoder new tolerance + line="3607">new tolerance @@ -6713,7 +6793,7 @@ MT safe. version="1.6"> Lets #GstAudioDecoder sub-classes decide if they want the sink pad + line="3859">Lets #GstAudioDecoder sub-classes decide if they want the sink pad to use the default pad query handler to reply to accept-caps queries. By setting this to true it is possible to further customize the default @@ -6728,13 +6808,13 @@ handler with %GST_PAD_SET_ACCEPT_INTERSECT and a #GstAudioDecoder + line="3861">a #GstAudioDecoder if the default pad accept-caps query handling should be used + line="3862">if the default pad accept-caps query handling should be used @@ -10528,25 +10608,25 @@ Note: This initializes @info first, no values are preserved. Meta containing Audio Level Indication: https://tools.ietf.org/html/rfc6464 + line="222">Meta containing Audio Level Indication: https://tools.ietf.org/html/rfc6464 + line="238"/> parent #GstMeta + line="224">parent #GstMeta the -dBov from 0-127 (127 is silence). + line="225">the -dBov from 0-127 (127 is silence). whether the buffer contains voice activity + line="226">whether the buffer contains voice activity version="1.20"> Return the #GstMetaInfo associated with #GstAudioLevelMeta. + line="660">Return the #GstMetaInfo associated with #GstAudioLevelMeta. + line="244"/> a #GstMetaInfo + line="665">a #GstMetaInfo @@ -10572,7 +10652,7 @@ Note: This initializes @info first, no values are preserved. audio buffers. These functions in this module help to create and attach the meta as well as extracting it. + line="188"/> + line="194"/> @@ -11427,14 +11507,14 @@ manner. The base class is sufficiently flexible to be used as an abstraction for DMA based ringbuffers as well as a pure software implementations. + line="296"/> Print debug info about the buffer sized in @spec to the debug log. + line="170">Print debug info about the buffer sized in @spec to the debug log. + line="321"/> @@ -11442,7 +11522,7 @@ implementations. the spec to debug + line="172">the spec to debug @@ -11451,9 +11531,9 @@ implementations. c:identifier="gst_audio_ring_buffer_debug_spec_caps"> Print debug info about the parsed caps in @spec to the debug log. + line="140">Print debug info about the parsed caps in @spec to the debug log. + line="318"/> @@ -11461,7 +11541,7 @@ implementations. the spec to debug + line="142">the spec to debug @@ -11470,26 +11550,26 @@ implementations. c:identifier="gst_audio_ring_buffer_parse_caps"> Parse @caps into @spec. + line="194">Parse @caps into @spec. + line="315"/> TRUE if the caps could be parsed. + line="201">TRUE if the caps could be parsed. a spec + line="196">a spec a #GstCaps + line="197">a #GstCaps @@ -11497,15 +11577,15 @@ implementations. Allocate the resources for the ringbuffer. This function fills + line="643">Allocate the resources for the ringbuffer. This function fills in the data pointer of the ring buffer with a valid #GstBuffer to which samples can be written. + line="274"/> TRUE if the device could be acquired, FALSE on error. + line="652">TRUE if the device could be acquired, FALSE on error. MT safe. @@ -11514,13 +11594,13 @@ MT safe. the #GstAudioRingBuffer to acquire + line="645">the #GstAudioRingBuffer to acquire the specs of the buffer + line="646">the specs of the buffer @@ -11528,15 +11608,15 @@ MT safe. Activate @buf to start or stop pulling data. + line="866">Activate @buf to start or stop pulling data. MT safe. + line="286"/> TRUE if the device could be activated in the requested mode, + line="875">TRUE if the device could be activated in the requested mode, FALSE on error. @@ -11544,13 +11624,13 @@ FALSE on error. the #GstAudioRingBuffer to activate + line="868">the #GstAudioRingBuffer to activate the new mode + line="869">the new mode @@ -11558,11 +11638,11 @@ FALSE on error. Clear all samples from the ringbuffer. + line="1417">Clear all samples from the ringbuffer. MT safe. + line="292"/> @@ -11570,7 +11650,7 @@ MT safe. the #GstAudioRingBuffer to clear + line="1419">the #GstAudioRingBuffer to clear @@ -11578,14 +11658,14 @@ MT safe. Close the audio device associated with the ring buffer. The ring buffer + line="552">Close the audio device associated with the ring buffer. The ring buffer should already have been released via gst_audio_ring_buffer_release(). + line="276"/> TRUE if the device could be closed, FALSE on error. + line="559">TRUE if the device could be closed, FALSE on error. MT safe. @@ -11594,7 +11674,7 @@ MT safe. the #GstAudioRingBuffer + line="554">the #GstAudioRingBuffer @@ -11602,7 +11682,7 @@ MT safe. Commit @in_samples samples pointed to by @data to the ringbuffer @buf. + line="1776">Commit @in_samples samples pointed to by @data to the ringbuffer @buf. @in_samples and @out_samples define the rate conversion to perform on the samples in @data. For negative rates, @out_samples must be negative and @@ -11622,11 +11702,11 @@ interrupted, one can resume the processing by passing the previously returned MT safe. + line="288"/> The number of samples written to the ringbuffer or -1 on error. The + line="1805">The number of samples written to the ringbuffer or -1 on error. The number of samples written can be less than @out_samples when @buf was interrupted with a flush or stop. @@ -11635,7 +11715,7 @@ with a flush or stop. the #GstAudioRingBuffer to commit + line="1778">the #GstAudioRingBuffer to commit transfer-ownership="full"> the sample position of the data + line="1779">the sample position of the data the data to commit + line="1780">the data to commit @@ -11658,13 +11738,13 @@ with a flush or stop. the number of samples in the data to commit + line="1781">the number of samples in the data to commit the number of samples to write to the ringbuffer + line="1782">the number of samples to write to the ringbuffer transfer-ownership="full"> accumulator for rate conversion. + line="1783">accumulator for rate conversion. @@ -11681,7 +11761,7 @@ with a flush or stop. Get the number of samples queued in the audio device. This is + line="1284">Get the number of samples queued in the audio device. This is usually less than the segment size but can be bigger when the implementation uses another internal buffer between the audio device. @@ -11692,11 +11772,11 @@ ringbuffer to the device but still not played. For capture ringbuffers this is the amount of samples in the device that are not yet transferred to the ringbuffer. + line="283"/> The number of samples queued in the audio device. + line="1299">The number of samples queued in the audio device. MT safe. @@ -11705,7 +11785,7 @@ MT safe. the #GstAudioRingBuffer to query + line="1286">the #GstAudioRingBuffer to query @@ -11713,15 +11793,15 @@ MT safe. Open the audio device associated with the ring buffer. Does not perform any + line="491">Open the audio device associated with the ring buffer. Does not perform any setup on the device. You must open the device before acquiring the ring buffer. + line="273"/> TRUE if the device could be opened, FALSE on error. + line="499">TRUE if the device could be opened, FALSE on error. MT safe. @@ -11730,7 +11810,7 @@ MT safe. the #GstAudioRingBuffer + line="493">the #GstAudioRingBuffer @@ -11738,13 +11818,13 @@ MT safe. Pause processing samples from the ringbuffer. + line="1173">Pause processing samples from the ringbuffer. + line="279"/> TRUE if the device could be paused, FALSE on error. + line="1179">TRUE if the device could be paused, FALSE on error. MT safe. @@ -11753,7 +11833,7 @@ MT safe. the #GstAudioRingBuffer to pause + line="1175">the #GstAudioRingBuffer to pause @@ -11761,13 +11841,13 @@ MT safe. Free the resources of the ringbuffer. + line="764">Free the resources of the ringbuffer. + line="275"/> TRUE if the device could be released, FALSE on error. + line="770">TRUE if the device could be released, FALSE on error. MT safe. @@ -11776,7 +11856,7 @@ MT safe. the #GstAudioRingBuffer to release + line="766">the #GstAudioRingBuffer to release @@ -11784,9 +11864,9 @@ MT safe. resume processing of samples after pause + line="256">resume processing of samples after pause + line="280"/> @@ -11799,13 +11879,13 @@ MT safe. Start processing samples from the ringbuffer. + line="1008">Start processing samples from the ringbuffer. + line="278"/> TRUE if the device could be started, FALSE on error. + line="1014">TRUE if the device could be started, FALSE on error. MT safe. @@ -11814,7 +11894,7 @@ MT safe. the #GstAudioRingBuffer to start + line="1010">the #GstAudioRingBuffer to start @@ -11822,13 +11902,13 @@ MT safe. Stop processing samples from the ringbuffer. + line="1217">Stop processing samples from the ringbuffer. + line="281"/> TRUE if the device could be stopped, FALSE on error. + line="1223">TRUE if the device could be stopped, FALSE on error. MT safe. @@ -11837,7 +11917,7 @@ MT safe. the #GstAudioRingBuffer to stop + line="1219">the #GstAudioRingBuffer to stop @@ -11845,15 +11925,15 @@ MT safe. Allocate the resources for the ringbuffer. This function fills + line="643">Allocate the resources for the ringbuffer. This function fills in the data pointer of the ring buffer with a valid #GstBuffer to which samples can be written. + line="342"/> TRUE if the device could be acquired, FALSE on error. + line="652">TRUE if the device could be acquired, FALSE on error. MT safe. @@ -11862,13 +11942,13 @@ MT safe. the #GstAudioRingBuffer to acquire + line="645">the #GstAudioRingBuffer to acquire the specs of the buffer + line="646">the specs of the buffer @@ -11876,15 +11956,15 @@ MT safe. Activate @buf to start or stop pulling data. + line="866">Activate @buf to start or stop pulling data. MT safe. + line="358"/> TRUE if the device could be activated in the requested mode, + line="875">TRUE if the device could be activated in the requested mode, FALSE on error. @@ -11892,13 +11972,13 @@ FALSE on error. the #GstAudioRingBuffer to activate + line="868">the #GstAudioRingBuffer to activate the new mode + line="869">the new mode @@ -11906,12 +11986,12 @@ FALSE on error. Subclasses should call this function to notify the fact that + line="2022">Subclasses should call this function to notify the fact that @advance segments are now processed by the device. MT safe. + line="433"/> @@ -11919,13 +11999,13 @@ MT safe. the #GstAudioRingBuffer to advance + line="2024">the #GstAudioRingBuffer to advance the number of segments written + line="2025">the number of segments written @@ -11933,12 +12013,12 @@ MT safe. Clear the given segment of the buffer with silence samples. + line="2051">Clear the given segment of the buffer with silence samples. This function is used by subclasses. MT safe. + line="430"/> @@ -11946,13 +12026,13 @@ MT safe. the #GstAudioRingBuffer to clear + line="2053">the #GstAudioRingBuffer to clear the segment to clear + line="2054">the segment to clear @@ -11960,11 +12040,11 @@ MT safe. Clear all samples from the ringbuffer. + line="1417">Clear all samples from the ringbuffer. MT safe. + line="399"/> @@ -11972,7 +12052,7 @@ MT safe. the #GstAudioRingBuffer to clear + line="1419">the #GstAudioRingBuffer to clear @@ -11981,14 +12061,14 @@ MT safe. c:identifier="gst_audio_ring_buffer_close_device"> Close the audio device associated with the ring buffer. The ring buffer + line="552">Close the audio device associated with the ring buffer. The ring buffer should already have been released via gst_audio_ring_buffer_release(). + line="334"/> TRUE if the device could be closed, FALSE on error. + line="559">TRUE if the device could be closed, FALSE on error. MT safe. @@ -11997,7 +12077,7 @@ MT safe. the #GstAudioRingBuffer + line="554">the #GstAudioRingBuffer @@ -12005,7 +12085,7 @@ MT safe. Commit @in_samples samples pointed to by @data to the ringbuffer @buf. + line="1776">Commit @in_samples samples pointed to by @data to the ringbuffer @buf. @in_samples and @out_samples define the rate conversion to perform on the samples in @data. For negative rates, @out_samples must be negative and @@ -12025,11 +12105,11 @@ interrupted, one can resume the processing by passing the previously returned MT safe. + line="404"/> The number of samples written to the ringbuffer or -1 on error. The + line="1805">The number of samples written to the ringbuffer or -1 on error. The number of samples written can be less than @out_samples when @buf was interrupted with a flush or stop. @@ -12038,7 +12118,7 @@ with a flush or stop. the #GstAudioRingBuffer to commit + line="1778">the #GstAudioRingBuffer to commit transfer-ownership="full"> the sample position of the data + line="1779">the sample position of the data the data to commit + line="1780">the data to commit @@ -12061,13 +12141,13 @@ with a flush or stop. the number of samples in the data to commit + line="1781">the number of samples in the data to commit the number of samples to write to the ringbuffer + line="1782">the number of samples to write to the ringbuffer transfer-ownership="full"> accumulator for rate conversion. + line="1783">accumulator for rate conversion. @@ -12084,39 +12164,39 @@ with a flush or stop. Convert @src_val in @src_fmt to the equivalent value in @dest_fmt. The result + line="407">Convert @src_val in @src_fmt to the equivalent value in @dest_fmt. The result will be put in @dest_val. + line="324"/> TRUE if the conversion succeeded. + line="418">TRUE if the conversion succeeded. the #GstAudioRingBuffer + line="409">the #GstAudioRingBuffer the source format + line="410">the source format the source value + line="411">the source value the destination format + line="412">the destination format transfer-ownership="full"> a location to store the converted value + line="413">a location to store the converted value @@ -12133,7 +12213,7 @@ will be put in @dest_val. Get the number of samples queued in the audio device. This is + line="1284">Get the number of samples queued in the audio device. This is usually less than the segment size but can be bigger when the implementation uses another internal buffer between the audio device. @@ -12144,11 +12224,11 @@ ringbuffer to the device but still not played. For capture ringbuffers this is the amount of samples in the device that are not yet transferred to the ringbuffer. + line="388"/> The number of samples queued in the audio device. + line="1299">The number of samples queued in the audio device. MT safe. @@ -12157,7 +12237,7 @@ MT safe. the #GstAudioRingBuffer to query + line="1286">the #GstAudioRingBuffer to query @@ -12166,13 +12246,13 @@ MT safe. c:identifier="gst_audio_ring_buffer_device_is_open"> Checks the status of the device associated with the ring buffer. + line="619">Checks the status of the device associated with the ring buffer. + line="337"/> TRUE if the device was open, FALSE if it was closed. + line="625">TRUE if the device was open, FALSE if it was closed. MT safe. @@ -12181,7 +12261,7 @@ MT safe. the #GstAudioRingBuffer + line="621">the #GstAudioRingBuffer @@ -12190,13 +12270,13 @@ MT safe. c:identifier="gst_audio_ring_buffer_is_acquired"> Check if the ringbuffer is acquired and ready to use. + line="842">Check if the ringbuffer is acquired and ready to use. + line="348"/> TRUE if the ringbuffer is acquired, FALSE on error. + line="848">TRUE if the ringbuffer is acquired, FALSE on error. MT safe. @@ -12205,7 +12285,7 @@ MT safe. the #GstAudioRingBuffer to check + line="844">the #GstAudioRingBuffer to check @@ -12213,22 +12293,22 @@ MT safe. Check if @buf is activated. + line="934">Check if @buf is activated. MT safe. + line="361"/> TRUE if the device is active. + line="942">TRUE if the device is active. the #GstAudioRingBuffer + line="936">the #GstAudioRingBuffer @@ -12237,22 +12317,22 @@ MT safe. c:identifier="gst_audio_ring_buffer_is_flushing"> Check if @buf is flushing. + line="984">Check if @buf is flushing. MT safe. + line="369"/> TRUE if the device is flushing. + line="992">TRUE if the device is flushing. the #GstAudioRingBuffer + line="986">the #GstAudioRingBuffer @@ -12260,12 +12340,12 @@ MT safe. Tell the ringbuffer that it is allowed to start playback when + line="2086">Tell the ringbuffer that it is allowed to start playback when the ringbuffer is filled with samples. MT safe. + line="436"/> @@ -12273,13 +12353,13 @@ MT safe. the #GstAudioRingBuffer + line="2088">the #GstAudioRingBuffer the new value + line="2089">the new value @@ -12288,15 +12368,15 @@ MT safe. c:identifier="gst_audio_ring_buffer_open_device"> Open the audio device associated with the ring buffer. Does not perform any + line="491">Open the audio device associated with the ring buffer. Does not perform any setup on the device. You must open the device before acquiring the ring buffer. + line="331"/> TRUE if the device could be opened, FALSE on error. + line="499">TRUE if the device could be opened, FALSE on error. MT safe. @@ -12305,7 +12385,7 @@ MT safe. the #GstAudioRingBuffer + line="493">the #GstAudioRingBuffer @@ -12313,13 +12393,13 @@ MT safe. Pause processing samples from the ringbuffer. + line="1173">Pause processing samples from the ringbuffer. + line="377"/> TRUE if the device could be paused, FALSE on error. + line="1179">TRUE if the device could be paused, FALSE on error. MT safe. @@ -12328,7 +12408,7 @@ MT safe. the #GstAudioRingBuffer to pause + line="1175">the #GstAudioRingBuffer to pause @@ -12337,14 +12417,14 @@ MT safe. c:identifier="gst_audio_ring_buffer_prepare_read"> Returns a pointer to memory where the data from segment @segment + line="1967">Returns a pointer to memory where the data from segment @segment can be found. This function is mostly used by subclasses. + line="426"/> FALSE if the buffer is not started. + line="1978">FALSE if the buffer is not started. MT safe. @@ -12353,7 +12433,7 @@ MT safe. the #GstAudioRingBuffer to read from + line="1969">the #GstAudioRingBuffer to read from transfer-ownership="full"> the segment to read + line="1970">the segment to read transfer-ownership="full"> + line="1971"> the pointer to the memory where samples can be read @@ -12383,7 +12463,7 @@ MT safe. transfer-ownership="full"> the number of bytes to read + line="1973">the number of bytes to read @@ -12391,7 +12471,7 @@ MT safe. Read @len samples from the ringbuffer into the memory pointed + line="1829">Read @len samples from the ringbuffer into the memory pointed to by @data. The first sample should be read from position @sample in the ringbuffer. @@ -12401,11 +12481,11 @@ although it is recommended. @timestamp will return the timestamp associated with the data returned. + line="411"/> The number of samples read from the ringbuffer or -1 on + line="1847">The number of samples read from the ringbuffer or -1 on error. MT safe. @@ -12415,19 +12495,19 @@ MT safe. the #GstAudioRingBuffer to read from + line="1831">the #GstAudioRingBuffer to read from the sample position of the data + line="1832">the sample position of the data where the data should be read + line="1833">where the data should be read @@ -12435,7 +12515,7 @@ MT safe. the number of samples in data to read + line="1834">the number of samples in data to read transfer-ownership="full"> where the timestamp is returned + line="1835">where the timestamp is returned @@ -12452,13 +12532,13 @@ MT safe. Free the resources of the ringbuffer. + line="764">Free the resources of the ringbuffer. + line="345"/> TRUE if the device could be released, FALSE on error. + line="770">TRUE if the device could be released, FALSE on error. MT safe. @@ -12467,7 +12547,7 @@ MT safe. the #GstAudioRingBuffer to release + line="766">the #GstAudioRingBuffer to release @@ -12476,15 +12556,15 @@ MT safe. c:identifier="gst_audio_ring_buffer_samples_done"> Get the number of samples that were processed by the ringbuffer + line="1330">Get the number of samples that were processed by the ringbuffer since it was last started. This does not include the number of samples not yet processed (see gst_audio_ring_buffer_delay()). + line="391"/> The number of samples processed by the ringbuffer. + line="1338">The number of samples processed by the ringbuffer. MT safe. @@ -12493,7 +12573,7 @@ MT safe. the #GstAudioRingBuffer to query + line="1332">the #GstAudioRingBuffer to query @@ -12504,12 +12584,12 @@ MT safe. introspectable="0"> Sets the given callback function on the buffer. This function + line="435">Sets the given callback function on the buffer. This function will be called every time a segment has been written to a device. MT safe. + line="304"/> @@ -12517,7 +12597,7 @@ MT safe. the #GstAudioRingBuffer to set the callback on + line="437">the #GstAudioRingBuffer to set the callback on closure="1"> the callback to set + line="438">the callback to set @@ -12537,7 +12617,7 @@ MT safe. allow-none="1"> user data passed to the callback + line="439">user data passed to the callback @@ -12548,12 +12628,12 @@ MT safe. version="1.12"> Sets the given callback function on the buffer. This function + line="453">Sets the given callback function on the buffer. This function will be called every time a segment has been written to a device. MT safe. + line="309"/> @@ -12561,7 +12641,7 @@ MT safe. the #GstAudioRingBuffer to set the callback on + line="455">the #GstAudioRingBuffer to set the callback on destroy="2"> the callback to set + line="456">the callback to set @@ -12583,13 +12663,13 @@ MT safe. allow-none="1"> user data passed to the callback + line="457">user data passed to the callback function to be called when @user_data is no longer needed + line="458">function to be called when @user_data is no longer needed @@ -12598,10 +12678,10 @@ MT safe. c:identifier="gst_audio_ring_buffer_set_channel_positions"> Tell the ringbuffer about the device's channel positions. This must + line="2122">Tell the ringbuffer about the device's channel positions. This must be called in when the ringbuffer is acquired. + line="353"/> @@ -12609,13 +12689,13 @@ be called in when the ringbuffer is acquired. the #GstAudioRingBuffer + line="2124">the #GstAudioRingBuffer the device channel positions + line="2125">the device channel positions @@ -12623,15 +12703,37 @@ be called in when the ringbuffer is acquired. + + Mark the ringbuffer as errored after it has started. + +MT safe. + + + + + + + the #GstAudioRingBuffer that has encountered an error + + + + Set the ringbuffer to flushing mode or normal mode. + line="959">Set the ringbuffer to flushing mode or normal mode. MT safe. + line="366"/> @@ -12639,13 +12741,13 @@ MT safe. the #GstAudioRingBuffer to flush + line="961">the #GstAudioRingBuffer to flush the new mode + line="962">the new mode @@ -12654,7 +12756,7 @@ MT safe. c:identifier="gst_audio_ring_buffer_set_sample"> Make sure that the next sample written to the device is + line="1359">Make sure that the next sample written to the device is accounted for as being the @sample sample written to the device. This value will be used in reporting the current sample position of the ringbuffer. @@ -12663,7 +12765,7 @@ This function will also clear the buffer with silence. MT safe. + line="394"/> @@ -12671,13 +12773,13 @@ MT safe. the #GstAudioRingBuffer to use + line="1361">the #GstAudioRingBuffer to use the sample number to set + line="1362">the sample number to set @@ -12685,7 +12787,7 @@ MT safe. + line="417"/> @@ -12704,13 +12806,13 @@ MT safe. Start processing samples from the ringbuffer. + line="1008">Start processing samples from the ringbuffer. + line="374"/> TRUE if the device could be started, FALSE on error. + line="1014">TRUE if the device could be started, FALSE on error. MT safe. @@ -12719,7 +12821,7 @@ MT safe. the #GstAudioRingBuffer to start + line="1010">the #GstAudioRingBuffer to start @@ -12727,13 +12829,13 @@ MT safe. Stop processing samples from the ringbuffer. + line="1217">Stop processing samples from the ringbuffer. + line="380"/> TRUE if the device could be stopped, FALSE on error. + line="1223">TRUE if the device could be stopped, FALSE on error. MT safe. @@ -12742,7 +12844,7 @@ MT safe. the #GstAudioRingBuffer to stop + line="1219">the #GstAudioRingBuffer to stop @@ -12753,31 +12855,31 @@ MT safe. used to signal start/stop/pause/resume actions + line="191">used to signal start/stop/pause/resume actions boolean indicating that the ringbuffer is open + line="192">boolean indicating that the ringbuffer is open boolean indicating that the ringbuffer is acquired + line="193">boolean indicating that the ringbuffer is acquired data in the ringbuffer + line="194">data in the ringbuffer size of data in the ringbuffer + line="195">size of data in the ringbuffer @@ -12786,43 +12888,43 @@ MT safe. format and layout of the ringbuffer data + line="196">format and layout of the ringbuffer data number of samples in one segment + line="197">number of samples in one segment pointer to memory holding one segment of silence samples + line="198">pointer to memory holding one segment of silence samples state of the buffer + line="199">state of the buffer readpointer in the ringbuffer + line="200">readpointer in the ringbuffer segment corresponding to segment 0 (unused) + line="201">segment corresponding to segment 0 (unused) is a reader or writer waiting for a free segment + line="202">is a reader or writer waiting for a free segment @@ -12862,10 +12964,10 @@ MT safe. c:type="GstAudioRingBufferCallback"> This function is set with gst_audio_ring_buffer_set_callback() and is + line="46">This function is set with gst_audio_ring_buffer_set_callback() and is called to fill the memory at @data with @len bytes of samples. + line="56"/> @@ -12873,13 +12975,13 @@ called to fill the memory at @data with @len bytes of samples. a #GstAudioRingBuffer + line="48">a #GstAudioRingBuffer target to fill + line="49">target to fill @@ -12887,7 +12989,7 @@ called to fill the memory at @data with @len bytes of samples. amount to fill + line="50">amount to fill closure="3"> user data + line="51">user data @@ -12907,26 +13009,26 @@ called to fill the memory at @data with @len bytes of samples. glib:is-gtype-struct-for="AudioRingBuffer"> The vmethods that subclasses can override to implement the ringbuffer. + line="247">The vmethods that subclasses can override to implement the ringbuffer. + line="296"/> parent class + line="249">parent class open the device, don't set any params or allocate anything + line="250">open the device, don't set any params or allocate anything + line="273"/> TRUE if the device could be opened, FALSE on error. + line="499">TRUE if the device could be opened, FALSE on error. MT safe. @@ -12935,7 +13037,7 @@ MT safe. the #GstAudioRingBuffer + line="493">the #GstAudioRingBuffer @@ -12944,14 +13046,14 @@ MT safe. allocate the resources for the ringbuffer using the given spec + line="251">allocate the resources for the ringbuffer using the given spec + line="274"/> TRUE if the device could be acquired, FALSE on error. + line="652">TRUE if the device could be acquired, FALSE on error. MT safe. @@ -12960,13 +13062,13 @@ MT safe. the #GstAudioRingBuffer to acquire + line="645">the #GstAudioRingBuffer to acquire the specs of the buffer + line="646">the specs of the buffer @@ -12976,14 +13078,14 @@ MT safe. free resources of the ringbuffer + line="252">free resources of the ringbuffer + line="275"/> TRUE if the device could be released, FALSE on error. + line="770">TRUE if the device could be released, FALSE on error. MT safe. @@ -12992,7 +13094,7 @@ MT safe. the #GstAudioRingBuffer to release + line="766">the #GstAudioRingBuffer to release @@ -13001,14 +13103,14 @@ MT safe. close the device + line="253">close the device + line="276"/> TRUE if the device could be closed, FALSE on error. + line="559">TRUE if the device could be closed, FALSE on error. MT safe. @@ -13017,7 +13119,7 @@ MT safe. the #GstAudioRingBuffer + line="554">the #GstAudioRingBuffer @@ -13026,14 +13128,14 @@ MT safe. start processing of samples + line="254">start processing of samples + line="278"/> TRUE if the device could be started, FALSE on error. + line="1014">TRUE if the device could be started, FALSE on error. MT safe. @@ -13042,7 +13144,7 @@ MT safe. the #GstAudioRingBuffer to start + line="1010">the #GstAudioRingBuffer to start @@ -13051,14 +13153,14 @@ MT safe. pause processing of samples + line="255">pause processing of samples + line="279"/> TRUE if the device could be paused, FALSE on error. + line="1179">TRUE if the device could be paused, FALSE on error. MT safe. @@ -13067,7 +13169,7 @@ MT safe. the #GstAudioRingBuffer to pause + line="1175">the #GstAudioRingBuffer to pause @@ -13076,10 +13178,10 @@ MT safe. resume processing of samples after pause + line="256">resume processing of samples after pause + line="280"/> @@ -13093,14 +13195,14 @@ MT safe. stop processing of samples + line="257">stop processing of samples + line="281"/> TRUE if the device could be stopped, FALSE on error. + line="1223">TRUE if the device could be stopped, FALSE on error. MT safe. @@ -13109,7 +13211,7 @@ MT safe. the #GstAudioRingBuffer to stop + line="1219">the #GstAudioRingBuffer to stop @@ -13118,14 +13220,14 @@ MT safe. get number of frames queued in device + line="258">get number of frames queued in device + line="283"/> The number of samples queued in the audio device. + line="1299">The number of samples queued in the audio device. MT safe. @@ -13134,7 +13236,7 @@ MT safe. the #GstAudioRingBuffer to query + line="1286">the #GstAudioRingBuffer to query @@ -13143,15 +13245,15 @@ MT safe. activate the thread that starts pulling and monitoring the + line="259">activate the thread that starts pulling and monitoring the consumed segments in the device. + line="286"/> TRUE if the device could be activated in the requested mode, + line="875">TRUE if the device could be activated in the requested mode, FALSE on error. @@ -13159,13 +13261,13 @@ FALSE on error. the #GstAudioRingBuffer to activate + line="868">the #GstAudioRingBuffer to activate the new mode + line="869">the new mode @@ -13174,14 +13276,14 @@ FALSE on error. write samples into the ringbuffer + line="261">write samples into the ringbuffer + line="288"/> The number of samples written to the ringbuffer or -1 on error. The + line="1805">The number of samples written to the ringbuffer or -1 on error. The number of samples written can be less than @out_samples when @buf was interrupted with a flush or stop. @@ -13190,7 +13292,7 @@ with a flush or stop. the #GstAudioRingBuffer to commit + line="1778">the #GstAudioRingBuffer to commit transfer-ownership="full"> the sample position of the data + line="1779">the sample position of the data the data to commit + line="1780">the data to commit @@ -13213,13 +13315,13 @@ with a flush or stop. the number of samples in the data to commit + line="1781">the number of samples in the data to commit the number of samples to write to the ringbuffer + line="1782">the number of samples to write to the ringbuffer transfer-ownership="full"> accumulator for rate conversion. + line="1783">accumulator for rate conversion. @@ -13237,13 +13339,13 @@ with a flush or stop. Optional. + line="262">Optional. Clear the entire ringbuffer. Subclasses should chain up to the parent implementation to invoke the default handler. + line="292"/> @@ -13251,7 +13353,7 @@ with a flush or stop. the #GstAudioRingBuffer to clear + line="1419">the #GstAudioRingBuffer to clear @@ -13269,7 +13371,7 @@ with a flush or stop. c:type="GstAudioRingBufferFormatType"> The format of the samples in the ringbuffer. + line="76">The format of the samples in the ringbuffer. glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_RAW"> samples in linear or float + line="78">samples in linear or float glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MU_LAW"> samples in mulaw + line="79">samples in mulaw glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_A_LAW"> samples in alaw + line="80">samples in alaw glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_IMA_ADPCM"> samples in ima adpcm + line="81">samples in ima adpcm glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG"> samples in mpeg audio (but not AAC) format + line="82">samples in mpeg audio (but not AAC) format glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_GSM"> samples in gsm format + line="83">samples in gsm format glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_IEC958"> samples in IEC958 frames (e.g. AC3) + line="84">samples in IEC958 frames (e.g. AC3) glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_AC3"> samples in AC3 format + line="85">samples in AC3 format glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_EAC3"> samples in EAC3 format + line="86">samples in EAC3 format glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_DTS"> samples in DTS format + line="87">samples in DTS format glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG2_AAC"> samples in MPEG-2 AAC ADTS format + line="88">samples in MPEG-2 AAC ADTS format glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG4_AAC"> samples in MPEG-4 AAC ADTS format + line="89">samples in MPEG-4 AAC ADTS format glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG2_AAC_RAW"> samples in MPEG-2 AAC raw format (Since: 1.12) + line="90">samples in MPEG-2 AAC raw format (Since: 1.12) glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG4_AAC_RAW"> samples in MPEG-4 AAC raw format (Since: 1.12) + line="91">samples in MPEG-4 AAC raw format (Since: 1.12) glib:name="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_FLAC"> samples in FLAC format (Since: 1.12) + line="92">samples in FLAC format (Since: 1.12) + + + samples in DSD format (Since: 1.24) The structure containing the format specification of the ringbuffer. + line="117">The structure containing the format specification of the ringbuffer. + +When @type is GST_AUDIO_RING_BUFFER_FORMAT_TYPE_DSD, the @dsd_format +is valid (otherwise it is unused). Also, when DSD is the sample type, +only the rate, channels, position, and bpf fields in @info are populated. + line="173"/> The caps that generated the Spec. + line="119">The caps that generated the Spec. the sample type + line="120">the sample type the #GstAudioInfo + line="121">the #GstAudioInfo the latency in microseconds + line="122">the latency in microseconds the total buffer size in microseconds + line="123">the total buffer size in microseconds the size of one segment in bytes + line="124">the size of one segment in bytes the total number of segments + line="125">the total number of segments number of segments queued in the lower level device, + line="126">number of segments queued in the lower level device, defaults to segtotal - - - - - + + + + + + + + + + + + + + c:type="GstAudioRingBufferState"> The state of the ringbuffer. + line="58">The state of the ringbuffer. glib:name="GST_AUDIO_RING_BUFFER_STATE_STOPPED"> The ringbuffer is stopped + line="60">The ringbuffer is stopped glib:name="GST_AUDIO_RING_BUFFER_STATE_PAUSED"> The ringbuffer is paused + line="61">The ringbuffer is paused glib:name="GST_AUDIO_RING_BUFFER_STATE_STARTED"> The ringbuffer is started + line="62">The ringbuffer is started glib:name="GST_AUDIO_RING_BUFFER_STATE_ERROR"> The ringbuffer has encountered an + line="63">The ringbuffer has encountered an error after it has been started, e.g. because the device was disconnected (Since: 1.2) @@ -14703,168 +14829,899 @@ rate differs this implicitly marks the next data as discontinuous. introspectable="0"> Calculate frames from @clocktime and sample @rate. - + line="53">Calculate frames from @clocktime and sample @rate. + clock time + line="55">clock time sampling rate + line="56">sampling rate - Calculate clocktime from sample @frames and @rate. - + filename="gst-libs/gst/audio/gstdsd.h" + line="37">Generic caps string for DSD audio, for use in pad templates. + - - sample frames - - + sampling rate - - - - - - - - - - - - - - + filename="gst-libs/gst/audio/gstdsd.h" + line="39">string format that describes the DSD bits grouping, + as string (e.g. "DSDU32BE", "DSDU8", etc.) - + List of all DSD formats, for use in template caps strings. + +Big endian formats are preferred, since little-endian ones flip around +the DSD bytes, and most DSD hardware uses big endian formats. + + + + - + - + - - + - + - - + - + - - + - + - - + - + - - - - - - + - - + - + - - + - + - - + Calculates the stride for a given #GstDsdInfo. + +Note that this is only useful if the info's audio layout +is GST_AUDIO_LAYOUT_INTERLEAVED. + - + - - + Calculates a valid DSD-44x rate (in bytes) from commonly used rate +multiplier specifications like DSD64, DSD128 etc. + +For example, to get the rate for DSD64-44x, use 64 as the multiplier +argument. + - + - - + Calculates a valid DSD-48x rate (in bytes) from commonly used rate +multiplier specifications like DSD64, DSD128 etc. + +For example, to get the rate for DSD64-48x, use 64 as the multiplier +argument. + - + + + + + + The GStreamer media type for DSD. + + + + + Silence pattern for DSD data. + +In DSD, a nullbyte does not correspond to silence. To fill memory regions +with "DSD silence", these regions must be filled with byte 0x69 instead +(this is the DSD silence pattern). This constant provides that pattern +in a more readable fashion. + + + + + Enum value describing how DSD bits are grouped. + + unknown / invalid DSD format + + + 8 DSD bits in 1 byte + + + 16 DSD bits in 2 bytes, little endian order + + + 16 DSD bits in 2 bytes, big endian order + + + 32 DSD bits in 4 bytes, little endian order + + + 32 DSD bits in 4 bytes, big endian order + + + number of valid DSD formats + + + 16 DSD bits in 2 bytes, native endianness + + + 32 DSD bits in 4 bytes, native endianness + + + Convert the DSD format string @str to its #GstDsdFormat. + + + the #GstDsdFormat for @format or GST_DSD_FORMAT_UNKNOWN when the +string is not a known format. + + + + + a DSD format string + + + + + + + + Number of bytes in this DSD grouping format. + + + + + a #GstDsdFormat + + + + + + Returns a string containing a descriptive name for +the #GstDsdFormat if there is one, or NULL otherwise. + + + the name corresponding to @format + + + + + a #GstDsdFormat + + + + + + + Information describing DSD audio properties. + +In DSD, the "sample format" is the bit. Unlike PCM, there are no further +"sample formats" in DSD. However, in software, DSD bits are grouped into +bytes (since dealing with individual bits is impractical), and these bytes +in turn are grouped into words. This becomes relevant when interleaving +channels and transmitting DSD data through audio APIs. The different +types of grouping DSD bytes are referred to as the "DSD grouping forma" +or just "DSD format". #GstDsdFormat has a list of valid ways of grouping +DSD bytes into words. + +DSD rates are equivalent to PCM sample rates, except that they specify +how many DSD bytes are consumed per second. This refers to the bytes per +second _per channel_; the rate does not change when the number of channel +changes. (Strictly speaking, it would be more correct to measure the +*bits* per second, since the bit is the DSD "sample format", but it is +more practical to use bytes.) In DSD, bit rates are always an integer +multiple of the CD audio rate (44100) or the DAT rate (48000). DSD64-44x +is 44100 * 64 = 2822400 bits per second, or 352800 bytes per second +(the latter would be used in this info structure). DSD64-48x is +48000 * 64 = 3072000 bits per second, or 384000 bytes per second. +#GST_DSD_MAKE_DSD_RATE_44x can be used for specifying DSD-44x rates, +*and #GST_DSD_MAKE_DSD_RATE_48x can be used for specifying DSD-48x ones. +Also, since DSD-48x is less well known, when the multiplier is given +without the 44x/48x specifier, 44x is typically implied. + +It is important to know that in DSD, different format widths correspond +to different playtimes. That is, a word with 32 DSD bits covers two times +as much playtime as a word with 16 DSD bits. This is in contrast to PCM, +where one word (= one PCM sample) always covers a time period of 1/samplerate, +no matter how many bits a PCM sample is made of. For this reason, DSD +and PCM widths and strides cannot be used the same way. + +Multiple channels are arranged in DSD data either interleaved or non- +interleaved. This is similar to PCM. Interleaved layouts rotate between +channels and words. First, word 0 of channel 0 is present. Then word +0 of channel 1 follows. Then word 0 of channel 2 etc. until all +channels are through, then comes word 1 of channel 0 etc. + +Non-interleaved data is planar. First, all words of channel 0 are +present, then all words of channel 1 etc. Unlike interleaved data, +non-interleaved data can be sparse, that is, there can be space in +between the planes. the @positions array specifies the plane offsets. + +In uncommon cases, the DSD bits in the data bytes can be stored in reverse +order. For example, normally, in DSDU8, the first byte contains DSD bits +0 to 7, and the most significant bit of that byte is DSD bit 0. If this +order is reversed, then bit 7 is the first one instead. In that ase, +@reversed_bytes is set to TRUE. + +Use the provided macros to access the info in this structure. + + + DSD grouping format + + + + DSD rate + + + + number of channels (must be at least 1) + + + + audio layout + + + + true if the DSD bits in the data bytes are reversed, + that is, the least significant bit comes first + + + + positions for each channel + + + + + + + + + + + + + + Allocate a new #GstDsdInfo that is also initialized with +gst_dsd_info_init(). + + + a new #GstDsdInfo. free with gst_dsd_info_free(). + + + + + Parse @caps to generate a #GstDsdInfo. + + + A #GstDsdInfo, or %NULL if @caps couldn't be parsed + + + + + a #GstCaps + + + + + + Copy a GstDsdInfo structure. + + + a new #GstDsdInfo. free with gst_dsd_info_free. + + + + + a #GstDsdInfo + + + + + + Free a GstDsdInfo structure previously allocated with gst_dsd_info_new() +or gst_dsd_info_copy(). + + + + + + + a #GstDsdInfo + + + + + + Compares two #GstDsdInfo and returns whether they are equal or not + + + %TRUE if @info and @other are equal, else %FALSE. + + + + + a #GstDsdInfo + + + + a #GstDsdInfo + + + + + + Set the default info for the DSD info of @format and @rate and @channels. + +Note: This initializes @info first, no values are preserved. + + + + + + + a #GstDsdInfo + + + + the format + + + + the DSD rate + + + + the number of channels + + + + the channel positions + + + + + + + + Convert the values of @info into a #GstCaps. + + + the new #GstCaps containing the + info of @info. + + + + + a #GstDsdInfo + + + + + + Parse @caps and update @info. + + + TRUE if @caps could be parsed + + + + + a #GstDsdInfo + + + + a #GstCaps + + + + + + Initialize @info with default values. + + + + + + + a #GstDsdInfo + + + + + + + Buffer metadata describing planar DSD contents in the buffer. This is not needed +for interleaved DSD data, and is required for non-interleaved (= planar) data. + +The different channels in @offsets are always in the GStreamer channel order. +Zero-copy channel reordering can be implemented by swapping the values in +@offsets. + +It is not allowed for channels to overlap in memory, +i.e. for each i in [0, channels), the range +[@offsets[i], @offsets[i] + @num_bytes_per_channel) must not overlap +with any other such range. + +It is, however, allowed to have parts of the buffer memory unused, by using +@offsets and @num_bytes_per_channel in such a way that leave gaps on it. +This is used to implement zero-copy clipping in non-interleaved buffers. + +Obviously, due to the above, it is not safe to infer the +number of valid bytes from the size of the buffer. You should always +use the @num_bytes_per_channel variable of this metadata. + + + parent #GstMeta + + + + number of channels in the DSD data + + + + the number of valid bytes per channel in the buffer + + + + the offsets (in bytes) where each channel plane starts in the buffer + + + + + + + + + + + + + + + + + + + + + Calculate clocktime from sample @frames and @rate. + + + + sample frames + + + sampling rate + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -14942,7 +15799,7 @@ rate differs this implicitly marks the next data as discontinuous. c:identifier="GST_IS_AUDIO_RING_BUFFER" introspectable="0"> + line="39"/> @@ -14952,7 +15809,7 @@ rate differs this implicitly marks the next data as discontinuous. c:identifier="GST_IS_AUDIO_RING_BUFFER_CLASS" introspectable="0"> + line="40"/> @@ -15000,8 +15857,8 @@ rate differs this implicitly marks the next data as discontinuous. version="1.2"> This metadata stays relevant as long as channels are unchanged. - + line="73">This metadata stays relevant as long as channels are unchanged. + version="1.8"> This metadata stays relevant as long as sample rate is unchanged. - + line="82">This metadata stays relevant as long as sample rate is unchanged. + version="1.2"> This metadata is relevant for audio streams. - + line="65">This metadata is relevant for audio streams. + + + + + This metadata stays relevant as long as the DSD plane offsets are unchanged. + After calling this function the caller does not own a reference to @buffer anymore. - + moved-to="AudioBuffer.reorder_channels"> Reorders @buffer from the channel positions @from to the channel + line="279">Reorders @buffer from the channel positions @from to the channel positions @to. @from and @to must contain the same number of positions and the same positions, only in a different order. @buffer must be writable. @@ -15371,32 +16238,32 @@ positions and the same positions, only in a different order. %TRUE if the reordering was possible. + line="292">%TRUE if the reordering was possible. The buffer to reorder. + line="281">The buffer to reorder. The %GstAudioFormat of the buffer. + line="282">The %GstAudioFormat of the buffer. The number of channels. + line="283">The number of channels. The channel positions in the buffer. + line="284">The channel positions in the buffer. @@ -15407,7 +16274,7 @@ positions and the same positions, only in a different order. The channel positions to convert to. + line="285">The channel positions to convert to. @@ -15435,7 +16302,7 @@ offset end will be preserved / updated. After calling this function the caller does not own a reference to @buffer anymore. - + version="1.8"> Get the fallback channel-mask for the given number of channels. + line="570">Get the fallback channel-mask for the given number of channels. This function returns a reasonable fallback channel-mask and should be called as a last resort when the specific channel map is unknown. @@ -15486,7 +16353,7 @@ called as a last resort when the specific channel map is unknown. a fallback channel-mask for @channels or 0 when there is no + line="579">a fallback channel-mask for @channels or 0 when there is no mask and mono. @@ -15494,7 +16361,7 @@ mask and mono. the number of channels + line="572">the number of channels @@ -15505,13 +16372,13 @@ mask and mono. introspectable="0"> Create a new channel mixer object for the given parameters. + line="970">Create a new channel mixer object for the given parameters. a new #GstAudioChannelMixer object. + line="980">a new #GstAudioChannelMixer object. Free with gst_audio_channel_mixer_free() after usage. @@ -15519,7 +16386,7 @@ mask and mono. #GstAudioChannelMixerFlags + line="972">#GstAudioChannelMixerFlags @@ -15529,25 +16396,25 @@ mask and mono. number of input channels + line="973">number of input channels positions of input channels + line="974">positions of input channels number of output channels + line="975">number of output channels positions of output channels + line="976">positions of output channels @@ -15609,7 +16476,7 @@ mask and mono. c:identifier="gst_audio_channel_positions_from_mask"> Convert the @channels present in @channel_mask to a @position array + line="368">Convert the @channels present in @channel_mask to a @position array (which should have at least @channels entries ensured by caller). If @channel_mask is set to 0, it is considered as 'not present' for purpose of conversion. @@ -15620,26 +16487,26 @@ of channels is considered valid. %TRUE if channel and channel mask are valid and could be converted + line="382">%TRUE if channel and channel mask are valid and could be converted The number of channels + line="370">The number of channels The input channel_mask + line="371">The input channel_mask The + line="372">The %GstAudioChannelPosition<!-- -->s c:identifier="gst_audio_channel_positions_to_mask"> Convert the @position array of @channels channels to a bitmask. + line="346">Convert the @position array of @channels channels to a bitmask. If @force_order is %TRUE it additionally checks if the channels are in the order required by GStreamer. @@ -15663,14 +16530,14 @@ in the order required by GStreamer. %TRUE if the channel positions are valid and could be converted. + line="358">%TRUE if the channel positions are valid and could be converted. The %GstAudioChannelPositions + line="348">The %GstAudioChannelPositions @@ -15681,13 +16548,13 @@ in the order required by GStreamer. The number of channels. + line="349">The number of channels. Only consider the GStreamer channel order. + line="350">Only consider the GStreamer channel order. transfer-ownership="full"> the output channel mask + line="351">the output channel mask @@ -15706,14 +16573,14 @@ in the order required by GStreamer. version="1.10"> Converts @position to a human-readable string representation for + line="668">Converts @position to a human-readable string representation for debugging purposes. a newly allocated string representing + line="677">a newly allocated string representing @position @@ -15721,7 +16588,7 @@ debugging purposes. The %GstAudioChannelPositions + line="670">The %GstAudioChannelPositions to convert. The number of channels. + line="672">The number of channels. @@ -15742,14 +16609,14 @@ debugging purposes. c:identifier="gst_audio_channel_positions_to_valid_order"> Reorders the channel positions in @position from any order to + line="493">Reorders the channel positions in @position from any order to the GStreamer channel order. %TRUE if the channel positions are valid and reordering + line="502">%TRUE if the channel positions are valid and reordering was successful. @@ -15757,7 +16624,7 @@ was successful. The channel positions to + line="495">The channel positions to reorder to. The number of channels. + line="497">The number of channels. @@ -15778,7 +16645,7 @@ was successful. c:identifier="gst_audio_check_valid_channel_positions"> Checks if @position contains valid channel positions for + line="326">Checks if @position contains valid channel positions for @channels channels. If @force_order is %TRUE it additionally checks if the channels are in the order required by GStreamer. %TRUE if the channel positions are valid. + line="337">%TRUE if the channel positions are valid. The %GstAudioChannelPositions + line="328">The %GstAudioChannelPositions to check. The number of channels. + line="330">The number of channels. Only consider the GStreamer channel order. + line="331">Only consider the GStreamer channel order. @@ -16029,7 +16896,7 @@ string is not a known format. c:identifier="gst_audio_get_channel_reorder_map"> Returns a reorder map for @from to @to that can be used in + line="430">Returns a reorder map for @from to @to that can be used in custom channel reordering code, e.g. to convert from or to the GStreamer channel order. @from and @to must contain the same number of positions and the same positions, only in a @@ -16042,7 +16909,7 @@ channel i of the input to channel reorder_map[i] of the output. %TRUE if the channel positions are valid and reordering + line="446">%TRUE if the channel positions are valid and reordering is possible. @@ -16050,13 +16917,13 @@ is possible. The number of channels. + line="432">The number of channels. The channel positions to reorder from. + line="433">The channel positions to reorder from. @@ -16067,7 +16934,7 @@ is possible. The channel positions to reorder to. + line="434">The channel positions to reorder to. @@ -16078,7 +16945,7 @@ is possible. Pointer to the reorder map. + line="435">Pointer to the reorder map. @@ -16229,13 +17096,13 @@ otherwise. version="1.20"> Return the #GType associated with #GstAudioLevelMeta. + line="607">Return the #GType associated with #GstAudioLevelMeta. + line="241"/> a #GType + line="612">a #GType @@ -16245,13 +17112,13 @@ otherwise. version="1.20"> Return the #GstMetaInfo associated with #GstAudioLevelMeta. + line="660">Return the #GstMetaInfo associated with #GstAudioLevelMeta. + line="244"/> a #GstMetaInfo + line="665">a #GstMetaInfo @@ -16300,7 +17167,7 @@ see gst_audio_formats_raw(). + line="191"/> @@ -16309,7 +17176,7 @@ see gst_audio_formats_raw(). c:identifier="gst_audio_meta_get_info" moved-to="AudioMeta.get_info"> + line="194"/> @@ -16553,38 +17420,38 @@ for @quality in @options. version="1.8"> Attaches #GstAudioClippingMeta metadata to @buffer with the given parameters. + line="249">Attaches #GstAudioClippingMeta metadata to @buffer with the given parameters. the #GstAudioClippingMeta on @buffer. + line="258">the #GstAudioClippingMeta on @buffer. a #GstBuffer + line="251">a #GstBuffer GstFormat of @start and @stop, GST_FORMAT_DEFAULT is samples + line="252">GstFormat of @start and @stop, GST_FORMAT_DEFAULT is samples Amount of audio to clip from start of buffer + line="253">Amount of audio to clip from start of buffer Amount of to clip from end of buffer + line="254">Amount of to clip from end of buffer @@ -16593,7 +17460,7 @@ for @quality in @options. c:identifier="gst_buffer_add_audio_downmix_meta"> Attaches #GstAudioDownmixMeta metadata to @buffer with the given parameters. + line="117">Attaches #GstAudioDownmixMeta metadata to @buffer with the given parameters. @matrix is an two-dimensional array of @to_channels times @from_channels coefficients, i.e. the i-th output channels is constructed by multiplicating @@ -16603,20 +17470,20 @@ of the results. the #GstAudioDownmixMeta on @buffer. + line="135">the #GstAudioDownmixMeta on @buffer. a #GstBuffer + line="119">a #GstBuffer the channel positions + line="120">the channel positions of the source The number of channels of the source + line="122">The number of channels of the source the channel positions of + line="123">the channel positions of the destination The number of channels of the destination + line="125">The number of channels of the destination The matrix coefficients. + line="126">The matrix coefficients. @@ -16662,32 +17529,32 @@ of the results. version="1.20"> Attaches audio level information to @buffer. (RFC 6464) + line="686">Attaches audio level information to @buffer. (RFC 6464) + line="247"/> the #GstAudioLevelMeta on @buffer. + line="694">the #GstAudioLevelMeta on @buffer. a #GstBuffer + line="688">a #GstBuffer the -dBov from 0-127 (127 is silence). + line="689">the -dBov from 0-127 (127 is silence). whether the buffer contains voice activity. + line="690">whether the buffer contains voice activity. @@ -16697,7 +17564,7 @@ of the results. version="1.16"> Allocates and attaches a #GstAudioMeta on @buffer, which must be writable + line="460">Allocates and attaches a #GstAudioMeta on @buffer, which must be writable for that purpose. The fields of the #GstAudioMeta are directly populated from the arguments of this function. @@ -16716,30 +17583,30 @@ It is, obviously, also not allowed to specify parameters that would cause out-of-bounds memory access on @buffer. This is also checked, which means that you must add enough memory on the @buffer before adding this meta. + line="200"/> the #GstAudioMeta that was attached on the @buffer + line="488">the #GstAudioMeta that was attached on the @buffer a #GstBuffer + line="462">a #GstBuffer the audio properties of the buffer + line="463">the audio properties of the buffer the number of valid samples in the buffer + line="464">the number of valid samples in the buffer allow-none="1"> the offsets (in bytes) where each channel plane starts + line="465">the offsets (in bytes) where each channel plane starts in the buffer or %NULL to calculate it (see below); must be %NULL also when @info->layout is %GST_AUDIO_LAYOUT_INTERLEAVED + + Allocates and attaches a #GstDsdPlaneOffsetMeta on @buffer, which must be +writable for that purpose. The fields of the #GstDsdPlaneOffsetMeta are +directly populated from the arguments of this function. + +If @offsets is NULL, then the meta's offsets field is left uninitialized. +This is useful if for example offset values are to be calculated in the +meta's offsets field in-place. Similarly, @num_bytes_per_channel can be +set to 0, but only if @offsets is NULL. This is useful if the number of +bytes per channel is known only later. + +It is not allowed for channels to overlap in memory, +i.e. for each i in [0, channels), the range +[@offsets[i], @offsets[i] + @num_bytes_per_channel) must not overlap +with any other such range. This function will assert if the parameters +specified cause this restriction to be violated. + +It is, obviously, also not allowed to specify parameters that would cause +out-of-bounds memory access on @buffer. This is also checked, which means +that you must add enough memory on the @buffer before adding this meta. + +This meta is only needed for non-interleaved (= planar) DSD data. + + + the #GstDsdPlaneOffsetMeta that was attached + on the @buffer + + + + + a #GstBuffer + + + + Number of channels in the DSD data + + + + Number of bytes per channel + + + + the offsets (in bytes) where each channel plane starts + in the buffer + + + + @@ -16778,26 +17710,26 @@ that you must add enough memory on the @buffer before adding this meta. c:identifier="gst_buffer_get_audio_downmix_meta_for_channels"> Find the #GstAudioDownmixMeta on @buffer for the given destination + line="85">Find the #GstAudioDownmixMeta on @buffer for the given destination channel positions. the #GstAudioDownmixMeta on @buffer. + line="95">the #GstAudioDownmixMeta on @buffer. a #GstBuffer + line="87">a #GstBuffer the channel positions of + line="88">the channel positions of the destination The number of channels of the destination + line="90">The number of channels of the destination @@ -16819,13 +17751,13 @@ channel positions. version="1.20"> Find the #GstAudioLevelMeta on @buffer. + line="717">Find the #GstAudioLevelMeta on @buffer. + line="251"/> the #GstAudioLevelMeta or %NULL when + line="723">the #GstAudioLevelMeta or %NULL when there is no such metadata on @buffer. @@ -16833,7 +17765,7 @@ there is no such metadata on @buffer. a #GstBuffer + line="719">a #GstBuffer @@ -16842,12 +17774,252 @@ there is no such metadata on @buffer. c:identifier="gst_buffer_get_audio_meta" introspectable="0"> + line="196"/> + + + + + + + + + Converts DSD data from one layout and grouping format to another. +@num_bytes must be an integer multiple of the width of both input +and output format. For example, if the input format is GST_DSD_FORMAT_U32LE, +and the output format is GST_DSD_FORMAT_U16BE, then @num_bytes must +be an integer multiple of both 4 (U32LE width) and 2 (U16BE width). + +@reverse_byte_bits is necessary if the bit order within the DSD bytes +needs to be reversed. This is rarely necessary, and is not to be +confused with the endianness of formats (which determines the ordering +of *bytes*). + +@input_plane_offsets must not be NULL if @input_layout is set to +#GST_AUDIO_LAYOUT_NON_INTERLEAVED. The same applies to @output_plane_offsets. +These plane offsets define the starting offset of the planes (there is +exactly one plane per channel) within @input_data and @output_data +respectively. If GST_AUDIO_LAYOUT_INTERLEAVED is used, the plane offsets +are ignored. + + + + + + + the DSD format conversion's input source + + + + the DSD format conversion's output destination + + + + DSD format of the input data to convert from + + + + DSD format of the output data to convert to + + + + Input data layout + + + + Output data layout + + + + Plane offsets for non-interleaved input data + + + + Plane offsets for non-interleaved output data + + + + How many bytes with DSD data to convert + + + + Number of channels (must be at least 1) + + + + If TRUE, reverse the bits in each DSD byte + + + + + + Convert the DSD format string @str to its #GstDsdFormat. + + + the #GstDsdFormat for @format or GST_DSD_FORMAT_UNKNOWN when the +string is not a known format. + + + + + a DSD format string + + + + + + + + Number of bytes in this DSD grouping format. + + + + + a #GstDsdFormat + + + + + + Returns a string containing a descriptive name for +the #GstDsdFormat if there is one, or NULL otherwise. + + + the name corresponding to @format + + + + + a #GstDsdFormat + + + + + + Parse @caps and update @info. + + + TRUE if @caps could be parsed + + + + + a #GstDsdInfo + + + + a #GstCaps + + + + + + Initialize @info with default values. + + + + + + + a #GstDsdInfo + + + + + + + + + + + + + + + + + Optional. + Sets up the allocation parameters for allocating output + buffers. The passed in query contains the result of the + downstream allocation query. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -343,6 +351,13 @@ is defined this way (this is all done by the base class automatically): + Always required. + Allocates an output buffer, fills it with decoded audio samples, and must be passed on to + *buffer . The number of decoded samples must be passed on to *num_samples. + If decoding finishes or the decoding is no longer possible (for example, due to an + unrecoverable error), this function returns FALSE, otherwise TRUE. @@ -362,6 +377,14 @@ is defined this way (this is all done by the base class automatically): + Optional. + Returns the current subsong. + If the current subsong mode is not GST_NONSTREAM_AUDIO_SUBSONG_MODE_SINGLE, this + function's return value is undefined. + If this function is implemented by the subclass, + @get_num_subsongs should be implemented as well. @@ -375,6 +398,15 @@ is defined this way (this is all done by the base class automatically): + Optional. + Returns a tag list containing the main song tags, or NULL if there are + no such tags. Returned tags will be unref'd. Use this vfunc instead of + manually pushing a tag event downstream to avoid edge cases where not yet + pushed sticky tag events get overwritten before they are pushed (can for + example happen with decodebin if tags are pushed downstream before the + decodebin pads are linked). @@ -388,6 +420,10 @@ is defined this way (this is all done by the base class automatically): + Optional. + Returns the number of loops for playback. @@ -401,6 +437,18 @@ is defined this way (this is all done by the base class automatically): + Optional. + Returns the number of subsongs available. + The return values 0 and 1 have a similar, but distinct, meaning. + If this function returns 0, then this decoder does not support subsongs at all. + @get_current_subsong must then also always return 0. In other words, this function + either never returns 0, or never returns anything else than 0. + A return value of 1 means that the media contains either only one or no subsongs + (the entire song is then considered to be one single subsong). 1 also means that only + this very media has no or just one subsong, and the decoder itself can + support multiple subsongs. @@ -414,6 +462,10 @@ is defined this way (this is all done by the base class automatically): + Optional. + Returns the duration of a subsong. Returns GST_CLOCK_TIME_NONE if duration is unknown. @@ -430,6 +482,11 @@ is defined this way (this is all done by the base class automatically): + Optional. + Returns tags for a subsong, or NULL if there are no tags. + Returned tags will be unref'd. @@ -446,6 +503,12 @@ is defined this way (this is all done by the base class automatically): + Always required. + Returns a bitmask containing the output modes the subclass supports. + The mask is formed by a bitwise OR combination of integers, which can be calculated + this way: 1 << GST_NONSTREAM_AUDIO_OUTPUT_MODE_<mode> , where mode is either STEADY or LOOPING @@ -459,6 +522,16 @@ is defined this way (this is all done by the base class automatically): + Required if loads_from_sinkpad is set to TRUE (the default value). + Loads the media from the given buffer. The entire media is supplied at once, + so after this call, loading should be finished. This function + can also make use of a suggested initial subsong & subsong mode and initial + playback position (but isn't required to). In case it chooses a different starting + position, the function must pass this position to *initial_position. + The subclass does not have to unref the input buffer; the base class does that + already. @@ -492,6 +565,12 @@ is defined this way (this is all done by the base class automatically): + Required if loads_from_sinkpad is set to FALSE. + Loads the media in a way defined by the custom sink. Data is not supplied; + the derived class has to handle this on its own. Otherwise, this function is + identical to @load_from_buffer. @@ -535,6 +614,12 @@ is defined this way (this is all done by the base class automatically): + Optional. + Proposes buffer allocation parameters for upstream elements. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -551,6 +636,16 @@ is defined this way (this is all done by the base class automatically): + Optional. + Called when a seek event is received by the parent class. + new_position is a pointer to a GstClockTime integer which + contains a position relative to the current subsong. + Minimum is 0, maximum is the subsong length. + After this function finishes, new_position is set to the + actual new position (which may differ from the request + position, depending on the decoder). @@ -567,6 +662,17 @@ is defined this way (this is all done by the base class automatically): + Optional. + Sets the current subsong. This function is allowed to switch to a different + subsong than the required one, and can optionally make use of the suggested initial + position. In case it chooses a different starting position, the function must pass + this position to *initial_position. + This function switches the subsong mode to GST_NONSTREAM_AUDIO_SUBSONG_MODE_SINGLE + automatically. + If this function is implemented by the subclass, @get_current_subsong and + @get_num_subsongs should be implemented as well. @@ -586,6 +692,21 @@ is defined this way (this is all done by the base class automatically): + Optional. + Sets the number of loops for playback. If this is called during playback, + the subclass must set any internal loop counters to zero. A loop value of -1 + means infinite looping; 0 means no looping; and when the num_loops is greater than 0, + playback should loop exactly num_loops times. If this function is implemented, + @get_num_loops should be implemented as well. The function can ignore the given values + and choose another; however, @get_num_loops should return this other value afterwards. + It is up to the subclass to define where the loop starts and ends. It can mean that only + a subset at the end or in the middle of a song is repeated, for example. + If the current subsong mode is GST_NONSTREAM_AUDIO_SUBSONG_MODE_SINGLE, then the subsong + is repeated this many times. If it is GST_NONSTREAM_AUDIO_SUBSONG_MODE_ALL, then all + subsongs are repeated this many times. With GST_NONSTREAM_AUDIO_SUBSONG_MODE_DECODER_DEFAULT, + the behavior is decoder specific. @@ -602,6 +723,13 @@ is defined this way (this is all done by the base class automatically): + Optional. + Sets the output mode the subclass has to use. Unlike with most other functions, the subclass + cannot choose a different mode; it must use the requested one. + If the output mode is set to LOOPING, @gst_nonstream_audio_decoder_handle_loop + must be called after playback moved back to the start of a loop. @@ -622,6 +750,15 @@ is defined this way (this is all done by the base class automatically): + Optional. + Sets the current subsong mode. Since this might influence the current playback position, + this function must set the initial_position integer argument to a defined value. + If the playback position is not affected at all, it must be set to GST_CLOCK_TIME_NONE. + If the subsong is restarted after the mode switch, it is recommended to set the value + to the position in the playback right after the switch (or 0 if the subsongs are always + reset back to the beginning). @@ -642,6 +779,13 @@ is defined this way (this is all done by the base class automatically): + Optional. + Called when a position query is received by the parent class. + The position that this function returns must be relative to + the current subsong. Thus, the minimum is 0, and the maximum + is the subsong length. @@ -1004,6 +1148,16 @@ loads_from_sinkpad is TRUE. + Optional. + Called when a seek event is received by the parent class. + new_position is a pointer to a GstClockTime integer which + contains a position relative to the current subsong. + Minimum is 0, maximum is the subsong length. + After this function finishes, new_position is set to the + actual new position (which may differ from the request + position, depending on the decoder). @@ -1022,6 +1176,13 @@ loads_from_sinkpad is TRUE. + Optional. + Called when a position query is received by the parent class. + The position that this function returns must be relative to + the current subsong. Thus, the minimum is 0, and the maximum + is the subsong length. @@ -1037,6 +1198,16 @@ loads_from_sinkpad is TRUE. + Required if loads_from_sinkpad is set to TRUE (the default value). + Loads the media from the given buffer. The entire media is supplied at once, + so after this call, loading should be finished. This function + can also make use of a suggested initial subsong & subsong mode and initial + playback position (but isn't required to). In case it chooses a different starting + position, the function must pass this position to *initial_position. + The subclass does not have to unref the input buffer; the base class does that + already. @@ -1072,6 +1243,12 @@ loads_from_sinkpad is TRUE. + Required if loads_from_sinkpad is set to FALSE. + Loads the media in a way defined by the custom sink. Data is not supplied; + the derived class has to handle this on its own. Otherwise, this function is + identical to @load_from_buffer. @@ -1104,6 +1281,15 @@ loads_from_sinkpad is TRUE. + Optional. + Returns a tag list containing the main song tags, or NULL if there are + no such tags. Returned tags will be unref'd. Use this vfunc instead of + manually pushing a tag event downstream to avoid edge cases where not yet + pushed sticky tag events get overwritten before they are pushed (can for + example happen with decodebin if tags are pushed downstream before the + decodebin pads are linked). @@ -1119,6 +1305,17 @@ loads_from_sinkpad is TRUE. + Optional. + Sets the current subsong. This function is allowed to switch to a different + subsong than the required one, and can optionally make use of the suggested initial + position. In case it chooses a different starting position, the function must pass + this position to *initial_position. + This function switches the subsong mode to GST_NONSTREAM_AUDIO_SUBSONG_MODE_SINGLE + automatically. + If this function is implemented by the subclass, @get_current_subsong and + @get_num_subsongs should be implemented as well. @@ -1140,6 +1337,14 @@ loads_from_sinkpad is TRUE. + Optional. + Returns the current subsong. + If the current subsong mode is not GST_NONSTREAM_AUDIO_SUBSONG_MODE_SINGLE, this + function's return value is undefined. + If this function is implemented by the subclass, + @get_num_subsongs should be implemented as well. @@ -1155,6 +1360,18 @@ loads_from_sinkpad is TRUE. + Optional. + Returns the number of subsongs available. + The return values 0 and 1 have a similar, but distinct, meaning. + If this function returns 0, then this decoder does not support subsongs at all. + @get_current_subsong must then also always return 0. In other words, this function + either never returns 0, or never returns anything else than 0. + A return value of 1 means that the media contains either only one or no subsongs + (the entire song is then considered to be one single subsong). 1 also means that only + this very media has no or just one subsong, and the decoder itself can + support multiple subsongs. @@ -1170,6 +1387,10 @@ loads_from_sinkpad is TRUE. + Optional. + Returns the duration of a subsong. Returns GST_CLOCK_TIME_NONE if duration is unknown. @@ -1188,6 +1409,11 @@ loads_from_sinkpad is TRUE. + Optional. + Returns tags for a subsong, or NULL if there are no tags. + Returned tags will be unref'd. @@ -1206,6 +1432,15 @@ loads_from_sinkpad is TRUE. + Optional. + Sets the current subsong mode. Since this might influence the current playback position, + this function must set the initial_position integer argument to a defined value. + If the playback position is not affected at all, it must be set to GST_CLOCK_TIME_NONE. + If the subsong is restarted after the mode switch, it is recommended to set the value + to the position in the playback right after the switch (or 0 if the subsongs are always + reset back to the beginning). @@ -1228,6 +1463,21 @@ loads_from_sinkpad is TRUE. + Optional. + Sets the number of loops for playback. If this is called during playback, + the subclass must set any internal loop counters to zero. A loop value of -1 + means infinite looping; 0 means no looping; and when the num_loops is greater than 0, + playback should loop exactly num_loops times. If this function is implemented, + @get_num_loops should be implemented as well. The function can ignore the given values + and choose another; however, @get_num_loops should return this other value afterwards. + It is up to the subclass to define where the loop starts and ends. It can mean that only + a subset at the end or in the middle of a song is repeated, for example. + If the current subsong mode is GST_NONSTREAM_AUDIO_SUBSONG_MODE_SINGLE, then the subsong + is repeated this many times. If it is GST_NONSTREAM_AUDIO_SUBSONG_MODE_ALL, then all + subsongs are repeated this many times. With GST_NONSTREAM_AUDIO_SUBSONG_MODE_DECODER_DEFAULT, + the behavior is decoder specific. @@ -1246,6 +1496,10 @@ loads_from_sinkpad is TRUE. + Optional. + Returns the number of loops for playback. @@ -1261,6 +1515,12 @@ loads_from_sinkpad is TRUE. + Always required. + Returns a bitmask containing the output modes the subclass supports. + The mask is formed by a bitwise OR combination of integers, which can be calculated + this way: 1 << GST_NONSTREAM_AUDIO_OUTPUT_MODE_<mode> , where mode is either STEADY or LOOPING @@ -1276,6 +1536,13 @@ loads_from_sinkpad is TRUE. + Optional. + Sets the output mode the subclass has to use. Unlike with most other functions, the subclass + cannot choose a different mode; it must use the requested one. + If the output mode is set to LOOPING, @gst_nonstream_audio_decoder_handle_loop + must be called after playback moved back to the start of a loop. @@ -1298,6 +1565,13 @@ loads_from_sinkpad is TRUE. + Always required. + Allocates an output buffer, fills it with decoded audio samples, and must be passed on to + *buffer . The number of decoded samples must be passed on to *num_samples. + If decoding finishes or the decoding is no longer possible (for example, due to an + unrecoverable error), this function returns FALSE, otherwise TRUE. @@ -1334,6 +1608,14 @@ loads_from_sinkpad is TRUE. + Optional. + Sets up the allocation parameters for allocating output + buffers. The passed in query contains the result of the + downstream allocation query. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -1352,6 +1634,12 @@ loads_from_sinkpad is TRUE. + Optional. + Proposes buffer allocation parameters for upstream elements. + Subclasses should chain up to the parent implementation to + invoke the default handler. diff --git a/girs/GstBase-1.0.gir b/girs/GstBase-1.0.gir index 295363cf0..c9091f80c 100644 --- a/girs/GstBase-1.0.gir +++ b/girs/GstBase-1.0.gir @@ -356,10 +356,7 @@ available before calling this function. line="583">the bytes offset in the adapter to start from - + the number of bytes to copy @@ -1497,7 +1494,7 @@ This class used to live in gst-plugins-bad and was moved to core. This method will push the provided output buffer downstream. If needed, + line="745">This method will push the provided output buffer downstream. If needed, mandatory events such as stream-start, caps, and segment events will be sent before pushing the buffer. @@ -1508,13 +1505,13 @@ sent before pushing the buffer. The #GstAggregator + line="747">The #GstAggregator the #GstBuffer to push. + line="748">the #GstBuffer to push. @@ -1524,7 +1521,7 @@ sent before pushing the buffer. version="1.18"> This method will push the provided output buffer list downstream. If needed, + line="784">This method will push the provided output buffer list downstream. If needed, mandatory events such as stream-start, caps, and segment events will be sent before pushing the buffer. @@ -1535,13 +1532,13 @@ sent before pushing the buffer. The #GstAggregator + line="786">The #GstAggregator the #GstBufferList to push. + line="787">the #GstBufferList to push. @@ -1605,21 +1602,21 @@ sent before pushing the buffer. Negotiates src pad caps with downstream elements. + line="1364">Negotiates src pad caps with downstream elements. Unmarks GST_PAD_FLAG_NEED_RECONFIGURE in any case. But marks it again if #GstAggregatorClass::negotiate fails. %TRUE if the negotiation succeeded, else %FALSE. + line="1372">%TRUE if the negotiation succeeded, else %FALSE. a #GstAggregator + line="1366">a #GstAggregator @@ -1647,7 +1644,7 @@ if #GstAggregatorClass::negotiate fails. version="1.18"> Use this function to determine what input buffers will be aggregated + line="335">Use this function to determine what input buffers will be aggregated to produce the next output buffer. This should only be called from a #GstAggregator::samples-selected handler, and can be used to precisely control aggregating parameters for a given set of input samples. @@ -1655,7 +1652,7 @@ control aggregating parameters for a given set of input samples. The sample that is about to be aggregated. It may hold a #GstBuffer + line="343">The sample that is about to be aggregated. It may hold a #GstBuffer or a #GstBufferList. The contents of its info structure is subclass-dependent, and documented on a subclass basis. The buffers held by the sample are not writable. @@ -1900,7 +1897,7 @@ control aggregating parameters for a given set of input samples. This method will push the provided output buffer downstream. If needed, + line="745">This method will push the provided output buffer downstream. If needed, mandatory events such as stream-start, caps, and segment events will be sent before pushing the buffer. @@ -1911,13 +1908,13 @@ sent before pushing the buffer. The #GstAggregator + line="747">The #GstAggregator the #GstBuffer to push. + line="748">the #GstBuffer to push. @@ -1927,7 +1924,7 @@ sent before pushing the buffer. version="1.18"> This method will push the provided output buffer list downstream. If needed, + line="784">This method will push the provided output buffer list downstream. If needed, mandatory events such as stream-start, caps, and segment events will be sent before pushing the buffer. @@ -1938,13 +1935,13 @@ sent before pushing the buffer. The #GstAggregator + line="786">The #GstAggregator the #GstBufferList to push. + line="787">the #GstBufferList to push. @@ -1952,7 +1949,7 @@ sent before pushing the buffer. Lets #GstAggregator sub-classes get the memory @allocator + line="3963">Lets #GstAggregator sub-classes get the memory @allocator acquired by the base class and its @params. Unref the @allocator after use it. @@ -1964,7 +1961,7 @@ Unref the @allocator after use it. a #GstAggregator + line="3965">a #GstAggregator allow-none="1"> the #GstAllocator + line="3966">the #GstAllocator used @@ -1988,7 +1985,7 @@ used allow-none="1"> the + line="3968">the #GstAllocationParams of @allocator @@ -2000,7 +1997,7 @@ used the instance of the #GstBufferPool used + line="3944">the instance of the #GstBufferPool used by @trans; free it after use it @@ -2008,7 +2005,7 @@ by @trans; free it after use it a #GstAggregator + line="3942">a #GstAggregator @@ -2018,13 +2015,13 @@ by @trans; free it after use it version="1.22"> Subclasses may use the return value to inform whether they should return + line="4136">Subclasses may use the return value to inform whether they should return %GST_FLOW_EOS from their aggregate implementation. whether live status was forced on @self. + line="4142">whether live status was forced on @self. @@ -2040,7 +2037,7 @@ by @trans; free it after use it whether inactive pads will not be waited on + line="4119">whether inactive pads will not be waited on @@ -2054,7 +2051,7 @@ by @trans; free it after use it glib:get-property="latency"> Retrieves the latency values reported by @self in response to the latency + line="2383">Retrieves the latency values reported by @self in response to the latency query, or %GST_CLOCK_TIME_NONE if there is not live source connected and the element will not wait for the clock. @@ -2063,14 +2060,14 @@ Typically only called by subclasses. The latency or %GST_CLOCK_TIME_NONE if the element does not sync + line="2393">The latency or %GST_CLOCK_TIME_NONE if the element does not sync a #GstAggregator + line="2385">a #GstAggregator @@ -2080,21 +2077,21 @@ Typically only called by subclasses. version="1.18"> Negotiates src pad caps with downstream elements. + line="1364">Negotiates src pad caps with downstream elements. Unmarks GST_PAD_FLAG_NEED_RECONFIGURE in any case. But marks it again if #GstAggregatorClass::negotiate fails. %TRUE if the negotiation succeeded, else %FALSE. + line="1372">%TRUE if the negotiation succeeded, else %FALSE. a #GstAggregator + line="1366">a #GstAggregator @@ -2104,7 +2101,7 @@ if #GstAggregatorClass::negotiate fails. version="1.18"> Use this function to determine what input buffers will be aggregated + line="335">Use this function to determine what input buffers will be aggregated to produce the next output buffer. This should only be called from a #GstAggregator::samples-selected handler, and can be used to precisely control aggregating parameters for a given set of input samples. @@ -2112,7 +2109,7 @@ control aggregating parameters for a given set of input samples. The sample that is about to be aggregated. It may hold a #GstBuffer + line="343">The sample that is about to be aggregated. It may hold a #GstBuffer or a #GstBufferList. The contents of its info structure is subclass-dependent, and documented on a subclass basis. The buffers held by the sample are not writable. @@ -2132,7 +2129,7 @@ control aggregating parameters for a given set of input samples. version="1.18"> Subclasses should call this when they have prepared the + line="4057">Subclasses should call this when they have prepared the buffers they will aggregate for each of their sink pads, but before using any of the properties of the pads that govern *how* aggregation should be performed, for example z-index @@ -2154,19 +2151,19 @@ function. The presentation timestamp of the next output buffer + line="4059">The presentation timestamp of the next output buffer The decoding timestamp of the next output buffer + line="4060">The decoding timestamp of the next output buffer The duration of the next output buffer + line="4061">The duration of the next output buffer allow-none="1"> a #GstStructure containing additional information + line="4062">a #GstStructure containing additional information @@ -2185,7 +2182,7 @@ function. version="1.22"> Subclasses should call this at construction time in order for @self to + line="4152">Subclasses should call this at construction time in order for @self to aggregate on a timeout even when no live source is connected. @@ -2205,7 +2202,7 @@ aggregate on a timeout even when no live source is connected. version="1.20"> Subclasses should call this when they don't want to time out + line="4093">Subclasses should call this when they don't want to time out waiting for a pad that hasn't yet received any buffers in live mode. @@ -2222,7 +2219,7 @@ sure upstream has had a fair chance to start up. whether inactive pads should not be waited on + line="4095">whether inactive pads should not be waited on @@ -2232,7 +2229,7 @@ sure upstream has had a fair chance to start up. glib:set-property="latency"> Lets #GstAggregator sub-classes tell the baseclass what their internal + line="3896">Lets #GstAggregator sub-classes tell the baseclass what their internal latency is. Will also post a LATENCY message on the bus so the pipeline can reconfigure its global latency if the values changed. @@ -2243,19 +2240,19 @@ can reconfigure its global latency if the values changed. a #GstAggregator + line="3898">a #GstAggregator minimum latency + line="3899">minimum latency maximum latency + line="3900">maximum latency @@ -2263,7 +2260,7 @@ can reconfigure its global latency if the values changed. Sets the caps to be used on the src pad. + line="695">Sets the caps to be used on the src pad. @@ -2272,13 +2269,13 @@ can reconfigure its global latency if the values changed. The #GstAggregator + line="697">The #GstAggregator The #GstCaps to set on the src pad. + line="698">The #GstCaps to set on the src pad. @@ -2288,7 +2285,7 @@ can reconfigure its global latency if the values changed. version="1.16"> This is a simple #GstAggregatorClass::get_next_time implementation that + line="3990">This is a simple #GstAggregatorClass::get_next_time implementation that just looks at the #GstSegment on the srcpad of the aggregator and bases the next time on the running time there. @@ -2298,14 +2295,14 @@ and you have a dead line based aggregator subclass. The running time based on the position + line="4001">The running time based on the position A #GstAggregator + line="3992">A #GstAggregator @@ -2315,7 +2312,7 @@ and you have a dead line based aggregator subclass. version="1.18"> Subclasses should use this to update the segment on their + line="4027">Subclasses should use this to update the segment on their source pad, instead of directly pushing new segment events downstream. @@ -2341,7 +2338,7 @@ if it is used at all. default-value="FALSE"> Enables the emission of signals such as #GstAggregator::samples-selected + line="3056">Enables the emission of signals such as #GstAggregator::samples-selected default-value="0"> Force minimum upstream latency (in nanoseconds). When sources with a + line="3022">Force minimum upstream latency (in nanoseconds). When sources with a higher latency are expected to be plugged in dynamically after the aggregator has started playing, this allows overriding the minimum latency reported by the initial source(s). This is only taken into @@ -2398,7 +2395,7 @@ account when larger than the actually reported minimum latency. Signals that the #GstAggregator subclass has selected the next set + line="3068">Signals that the #GstAggregator subclass has selected the next set of input samples it will aggregate. Handlers may call gst_aggregator_peek_next_sample() at that point. @@ -2408,25 +2405,25 @@ gst_aggregator_peek_next_sample() at that point. The #GstSegment the next output buffer is part of + line="3071">The #GstSegment the next output buffer is part of The presentation timestamp of the next output buffer + line="3072">The presentation timestamp of the next output buffer The decoding timestamp of the next output buffer + line="3073">The decoding timestamp of the next output buffer The duration of the next output buffer + line="3074">The duration of the next output buffer allow-none="1"> a #GstStructure containing additional information + line="3075">a #GstStructure containing additional information @@ -2530,13 +2527,13 @@ _finish_buffer from inside that function. The #GstAggregator + line="747">The #GstAggregator the #GstBuffer to push. + line="748">the #GstBuffer to push. @@ -2916,14 +2913,14 @@ _finish_buffer from inside that function. %TRUE if the negotiation succeeded, else %FALSE. + line="1372">%TRUE if the negotiation succeeded, else %FALSE. a #GstAggregator + line="1366">a #GstAggregator @@ -2990,13 +2987,13 @@ _finish_buffer from inside that function. The #GstAggregator + line="786">The #GstAggregator the #GstBufferList to push. + line="787">the #GstBufferList to push. @@ -3009,7 +3006,7 @@ _finish_buffer from inside that function. The sample that is about to be aggregated. It may hold a #GstBuffer + line="343">The sample that is about to be aggregated. It may hold a #GstBuffer or a #GstBufferList. The contents of its info structure is subclass-dependent, and documented on a subclass basis. The buffers held by the sample are not writable. @@ -3090,19 +3087,19 @@ This class used to live in gst-plugins-bad and was moved to core. Drop the buffer currently queued in @pad. + line="3720">Drop the buffer currently queued in @pad. TRUE if there was a buffer queued in @pad, or FALSE if not. + line="3726">TRUE if there was a buffer queued in @pad, or FALSE if not. the pad where to drop any pending buffer + line="3722">the pad where to drop any pending buffer @@ -3112,21 +3109,21 @@ This class used to live in gst-plugins-bad and was moved to core. version="1.14.1"> This checks if a pad has a buffer available that will be returned by + line="3779">This checks if a pad has a buffer available that will be returned by a call to gst_aggregator_pad_peek_buffer() or gst_aggregator_pad_pop_buffer(). %TRUE if the pad has a buffer available as the next thing. + line="3787">%TRUE if the pad has a buffer available as the next thing. the pad to check the buffer on + line="3781">the pad to check the buffer on @@ -3136,14 +3133,14 @@ gst_aggregator_pad_pop_buffer(). %TRUE if the pad is EOS, otherwise %FALSE. + line="3815">%TRUE if the pad is EOS, otherwise %FALSE. an aggregator pad + line="3813">an aggregator pad @@ -3153,12 +3150,12 @@ gst_aggregator_pad_pop_buffer(). version="1.20"> It is only valid to call this method from #GstAggregatorClass::aggregate() + line="3829">It is only valid to call this method from #GstAggregatorClass::aggregate() %TRUE if the pad is inactive, %FALSE otherwise. + line="3835">%TRUE if the pad is inactive, %FALSE otherwise. See gst_aggregator_ignore_inactive_pads() for more info. @@ -3166,7 +3163,7 @@ gst_aggregator_pad_pop_buffer(). an aggregator pad + line="3831">an aggregator pad @@ -3176,7 +3173,7 @@ gst_aggregator_pad_pop_buffer(). A reference to the buffer in @pad or + line="3746">A reference to the buffer in @pad or NULL if no buffer was queued. You should unref the buffer after usage. @@ -3185,7 +3182,7 @@ usage. the pad to get buffer from + line="3744">the pad to get buffer from @@ -3193,12 +3190,12 @@ usage. Steal the ref to the buffer currently queued in @pad. + line="3662">Steal the ref to the buffer currently queued in @pad. The buffer in @pad or NULL if no buffer was + line="3668">The buffer in @pad or NULL if no buffer was queued. You should unref the buffer after usage. @@ -3206,7 +3203,7 @@ usage. the pad to get buffer from + line="3664">the pad to get buffer from @@ -3218,7 +3215,7 @@ usage. default-value="FALSE"> Enables the emission of signals such as #GstAggregatorPad::buffer-consumed + line="3573">Enables the emission of signals such as #GstAggregatorPad::buffer-consumed @@ -4344,7 +4341,7 @@ to the new entry, etc. Drains the adapter until it is empty. It decreases the min_frame_size to + line="2779">Drains the adapter until it is empty. It decreases the min_frame_size to match the current adapter size and calls chain method until the adapter is emptied or chain returns with error. @@ -4355,7 +4352,7 @@ is emptied or chain returns with error. a #GstBaseParse + line="2781">a #GstBaseParse @@ -4363,10 +4360,13 @@ is emptied or chain returns with error. Collects parsed data and pushes this downstream. + line="2679">Collects parsed data and pushes it downstream. Source pad caps must be set when this is called. -If @frame's out_buffer is set, that will be used as subsequent frame data. +If @frame's out_buffer is set, that will be used as subsequent frame data, +and @size amount will be flushed from the input data. The output_buffer size +can differ from the consumed size indicated by @size. + Otherwise, @size samples will be taken from the input and used for output, and the output's metadata (timestamps etc) will be taken as (optionally) set by the subclass on @frame's (input) buffer (which is otherwise @@ -4378,7 +4378,7 @@ caller retains ownership of @frame. a #GstFlowReturn that should be escalated to caller (of caller) + line="2700">a #GstFlowReturn that should be escalated to caller (of caller) @@ -4407,7 +4407,7 @@ caller retains ownership of @frame. version="1.6"> Sets the parser subclass's tags and how they should be merged with any + line="5036">Sets the parser subclass's tags and how they should be merged with any upstream stream tags. This will override any tags previously-set with gst_base_parse_merge_tags(). @@ -4421,7 +4421,7 @@ not required to use this and can still do tag handling on its own. a #GstBaseParse + line="5038">a #GstBaseParse allow-none="1"> a #GstTagList to merge, or NULL to unset + line="5039">a #GstTagList to merge, or NULL to unset previously-set tags the #GstTagMergeMode to use, usually #GST_TAG_MERGE_REPLACE + line="5041">the #GstTagMergeMode to use, usually #GST_TAG_MERGE_REPLACE @@ -4476,7 +4476,7 @@ This must be called with sinkpad STREAM_LOCK held. c:identifier="gst_base_parse_set_average_bitrate"> Optionally sets the average bitrate detected in media (if non-zero), + line="3905">Optionally sets the average bitrate detected in media (if non-zero), e.g. based on metadata, as it will be posted to the application. By default, announced average bitrate is estimated. The average bitrate @@ -4491,13 +4491,13 @@ a seek position, if there's no index and the format is syncable #GstBaseParse. + line="3907">#GstBaseParse. average bitrate in bits/second + line="3908">average bitrate in bits/second @@ -4505,7 +4505,7 @@ a seek position, if there's no index and the format is syncable Sets the duration of the currently playing media. Subclass can use this + line="3854">Sets the duration of the currently playing media. Subclass can use this when it is able to determine duration and/or notices a change in the media duration. Alternatively, if @interval is non-zero (default), then stream duration is determined based on estimated bitrate, and updated every @interval @@ -4518,25 +4518,25 @@ frames. #GstBaseParse. + line="3856">#GstBaseParse. #GstFormat. + line="3857">#GstFormat. duration value. + line="3858">duration value. how often to update the duration estimate based on bitrate, or 0. + line="3859">how often to update the duration estimate based on bitrate, or 0. @@ -4545,7 +4545,7 @@ frames. c:identifier="gst_base_parse_set_frame_rate"> If frames per second is configured, parser can take care of buffer duration + line="3943">If frames per second is configured, parser can take care of buffer duration and timestamping. When performing segment clipping, or seeking to a specific location, a corresponding decoder might need an initial @lead_in and a following @lead_out number of frames to ensure the desired segment is @@ -4558,31 +4558,31 @@ entirely filled upon decoding. the #GstBaseParse to set + line="3945">the #GstBaseParse to set frames per second (numerator). + line="3946">frames per second (numerator). frames per second (denominator). + line="3947">frames per second (denominator). frames needed before a segment for subsequent decode + line="3948">frames needed before a segment for subsequent decode frames needed after a segment + line="3949">frames needed after a segment @@ -4591,7 +4591,7 @@ entirely filled upon decoding. c:identifier="gst_base_parse_set_has_timing_info"> Set if frames carry timing information which the subclass can (generally) + line="4000">Set if frames carry timing information which the subclass can (generally) parse and provide. In particular, intrinsic (rather than estimated) time can be obtained following a seek. @@ -4602,13 +4602,13 @@ can be obtained following a seek. a #GstBaseParse + line="4002">a #GstBaseParse whether frames carry timing information + line="4003">whether frames carry timing information @@ -4616,7 +4616,7 @@ can be obtained following a seek. By default, the base class might try to infer PTS from DTS and vice + line="4071">By default, the base class might try to infer PTS from DTS and vice versa. While this is generally correct for audio data, it may not be otherwise. Sub-classes implementing such formats should disable timestamp inferring. @@ -4628,13 +4628,13 @@ timestamp inferring. a #GstBaseParse + line="4073">a #GstBaseParse %TRUE if parser should infer DTS/PTS from each other + line="4074">%TRUE if parser should infer DTS/PTS from each other @@ -4642,7 +4642,7 @@ timestamp inferring. Sets the minimum and maximum (which may likely be equal) latency introduced + line="4088">Sets the minimum and maximum (which may likely be equal) latency introduced by the parsing process. If there is such a latency, which depends on the particular parsing of the format, it typically corresponds to 1 frame duration. @@ -4657,19 +4657,19 @@ global latency. a #GstBaseParse + line="4090">a #GstBaseParse minimum parse latency + line="4091">minimum parse latency maximum parse latency + line="4092">maximum parse latency @@ -4678,7 +4678,7 @@ global latency. c:identifier="gst_base_parse_set_min_frame_size"> Subclass can use this function to tell the base class that it needs to + line="3925">Subclass can use this function to tell the base class that it needs to be given buffers of at least @min_size bytes. @@ -4688,13 +4688,13 @@ be given buffers of at least @min_size bytes. #GstBaseParse. + line="3927">#GstBaseParse. Minimum size in bytes of the data that this base class should + line="3928">Minimum size in bytes of the data that this base class should give to subclass. @@ -4704,7 +4704,7 @@ be given buffers of at least @min_size bytes. c:identifier="gst_base_parse_set_passthrough"> Set if the nature of the format or configuration does not allow (much) + line="4032">Set if the nature of the format or configuration does not allow (much) parsing, and the parser should operate in passthrough mode (which only applies when operating in push mode). That is, incoming buffers are pushed through unmodified, i.e. no #GstBaseParseClass::handle_frame @@ -4719,13 +4719,13 @@ passthrough semantics in #GstBaseParseClass::pre_push_frame. a #GstBaseParse + line="4034">a #GstBaseParse %TRUE if parser should run in passthrough mode + line="4035">%TRUE if parser should run in passthrough mode @@ -4734,7 +4734,7 @@ passthrough semantics in #GstBaseParseClass::pre_push_frame. c:identifier="gst_base_parse_set_pts_interpolation"> By default, the base class will guess PTS timestamps using a simple + line="4052">By default, the base class will guess PTS timestamps using a simple interpolation (previous timestamp + duration), which is incorrect for data streams with reordering, where PTS can go backward. Sub-classes implementing such formats should disable PTS interpolation. @@ -4746,13 +4746,13 @@ implementing such formats should disable PTS interpolation. a #GstBaseParse + line="4054">a #GstBaseParse %TRUE if parser should interpolate PTS timestamps + line="4055">%TRUE if parser should interpolate PTS timestamps @@ -4760,7 +4760,7 @@ implementing such formats should disable PTS interpolation. Set if frame starts can be identified. This is set by default and + line="4016">Set if frame starts can be identified. This is set by default and determines whether seeking based on bitrate averages is possible for a format/stream. @@ -4771,13 +4771,13 @@ is possible for a format/stream. a #GstBaseParse + line="4018">a #GstBaseParse set if frame starts can be identified + line="4019">set if frame starts can be identified @@ -4787,7 +4787,7 @@ is possible for a format/stream. version="1.2"> This function should only be called from a @handle_frame implementation. + line="4996">This function should only be called from a @handle_frame implementation. #GstBaseParse creates initial timestamps for frames by using the last timestamp seen in the stream before the frame starts. In certain @@ -4803,13 +4803,13 @@ into the frame data that the picture starts. a #GstBaseParse + line="4998">a #GstBaseParse offset into current buffer + line="4999">offset into current buffer @@ -5498,16 +5498,16 @@ rate, for example. The #GstBaseSink:async property can be used to instruct the sink to never perform an ASYNC state change. This feature is mostly usable when dealing with non-synchronized streams or sparse streams. - + Subclasses should override this when they can provide an + line="129">Subclasses should override this when they can provide an alternate method of spawning a thread to drive the pipeline in pull mode. Should start or stop the pulling thread, depending on the value of the "active" argument. Called after actually activating the sink pad in pull mode. The default implementation starts a task on the sink pad. - + @@ -5523,8 +5523,8 @@ with non-synchronized streams or sparse streams. Override this to handle events arriving on the sink pad - + line="147">Override this to handle events arriving on the sink pad + @@ -5540,9 +5540,9 @@ with non-synchronized streams or sparse streams. Only useful in pull mode. Implement if you have + line="127">Only useful in pull mode. Implement if you have ideas about what should be the default values for the caps you support. - + @@ -5558,8 +5558,8 @@ with non-synchronized streams or sparse streams. Called to get sink pad caps from the subclass. - + line="168">Called to get sink pad caps from the subclass. + @@ -5578,8 +5578,8 @@ with non-synchronized streams or sparse streams. Get the start and end times for syncing on this buffer. - + line="183">Get the start and end times for syncing on this buffer. + @@ -5596,7 +5596,7 @@ with non-synchronized streams or sparse streams. transfer-ownership="full"> the start #GstClockTime + line="185">the start #GstClockTime transfer-ownership="full"> the end #GstClockTime + line="186">the end #GstClockTime @@ -5613,9 +5613,9 @@ with non-synchronized streams or sparse streams. Called to prepare the buffer for @render and @preroll. This + line="151">Called to prepare the buffer for @render and @preroll. This function is called before synchronisation is performed. - + @@ -5631,9 +5631,9 @@ with non-synchronized streams or sparse streams. Called to prepare the buffer list for @render_list. This + line="153">Called to prepare the buffer list for @render_list. This function is called before synchronisation is performed. - + @@ -5649,8 +5649,8 @@ with non-synchronized streams or sparse streams. Called to present the preroll buffer if desired. - + line="155">Called to present the preroll buffer if desired. + @@ -5666,8 +5666,8 @@ with non-synchronized streams or sparse streams. configure the allocation query - + line="136">configure the allocation query + @@ -5683,8 +5683,8 @@ with non-synchronized streams or sparse streams. perform a #GstQuery on the element. - + line="146">perform a #GstQuery on the element. + @@ -5700,9 +5700,9 @@ with non-synchronized streams or sparse streams. Called when a buffer should be presented or output, at the + line="156">Called when a buffer should be presented or output, at the correct moment if the #GstBaseSink has been set to sync to the clock. - + @@ -5718,9 +5718,9 @@ with non-synchronized streams or sparse streams. Same as @render but used with buffer lists instead of + line="158">Same as @render but used with buffer lists instead of buffers. - + @@ -5736,8 +5736,8 @@ with non-synchronized streams or sparse streams. Notify subclass of changed caps - + line="126">Notify subclass of changed caps + @@ -5753,8 +5753,8 @@ with non-synchronized streams or sparse streams. Start processing. Ideal for opening resources in the subclass - + line="137">Start processing. Ideal for opening resources in the subclass + @@ -5767,8 +5767,8 @@ with non-synchronized streams or sparse streams. Stop processing. Subclasses should use this to close resources. - + line="138">Stop processing. Subclasses should use this to close resources. + @@ -5781,9 +5781,9 @@ with non-synchronized streams or sparse streams. Unlock any pending access to the resource. Subclasses should + line="139">Unlock any pending access to the resource. Subclasses should unblock any blocked function ASAP and call gst_base_sink_wait_preroll() - + @@ -5796,12 +5796,12 @@ with non-synchronized streams or sparse streams. Clear the previous unlock request. Subclasses should clear + line="141">Clear the previous unlock request. Subclasses should clear any state they set during #GstBaseSinkClass::unlock, and be ready to continue where they left off after gst_base_sink_wait_preroll(), gst_base_sink_wait() or gst_wait_sink_wait_clock() return or #GstBaseSinkClass::render is called again. - + @@ -5814,10 +5814,10 @@ with non-synchronized streams or sparse streams. Override this to implement custom logic to wait for the event + line="148">Override this to implement custom logic to wait for the event time (for events like EOS and GAP). Subclasses should always first chain up to the default implementation. - + @@ -5839,7 +5839,7 @@ to preroll, this function will perform the preroll and will then block until the element state is changed. This function should be called with the PREROLL_LOCK held. - + Get the number of bytes that the sink will pull when it is operating in pull mode. - + filename="libs/gst/base/gstbasesink.c" line="810">Checks if @sink is currently configured to drop buffers which are outside the current segment - + - + Get the currently configured latency. - + Get the maximum amount of bits per second that the sink will render. - + filename="libs/gst/base/gstbasesink.c" line="856">Gets the max lateness value. See gst_base_sink_set_max_lateness() for more details. - + line="1535">Get the processing deadline of @sink. see gst_base_sink_set_processing_deadline() for more information about the processing deadline. - + filename="libs/gst/base/gstbasesink.c" line="1346">Get the render delay of @sink. see gst_base_sink_set_render_delay() for more information about the render delay. - + version="1.18"> Return various #GstBaseSink statistics. This function returns a #GstStructure + line="5918">Return various #GstBaseSink statistics. This function returns a #GstStructure with name `application/x-gst-base-sink-stats` with the following fields: - "average-rate" G_TYPE_DOUBLE average frame rate - "dropped" G_TYPE_UINT64 Number of dropped frames - "rendered" G_TYPE_UINT64 Number of rendered frames - + pointer to #GstStructure + line="5929">pointer to #GstStructure #GstBaseSink + line="5920">#GstBaseSink @@ -6089,7 +6089,7 @@ with name `application/x-gst-base-sink-stats` with the following fields: filename="libs/gst/base/gstbasesink.c" line="766">Checks if @sink is currently configured to synchronize against the clock. - + filename="libs/gst/base/gstbasesink.c" line="1433">Get the time that will be inserted between frames to control the maximum buffers per second. - + Get the synchronisation offset of @sink. - + filename="libs/gst/base/gstbasesink.c" line="938">Checks if @sink is currently configured to perform asynchronous state changes to PAUSED. - + filename="libs/gst/base/gstbasesink.c" line="1145">Checks if @sink is currently configured to store the last received sample in the last-sample property. - + filename="libs/gst/base/gstbasesink.c" line="896">Checks if @sink is currently configured to send Quality-of-Service events upstream. - + - + disabled, the sink will immediately go to PAUSED instead of waiting for a preroll buffer. This feature is useful if the sink does not synchronize against the clock or when it is dealing with sparse streams. - + @@ -6324,7 +6324,7 @@ against the clock or when it is dealing with sparse streams. filename="libs/gst/base/gstbasesink.c" line="1369">Set the number of bytes that the sink will pull when it is operating in pull mode. - + @@ -6349,7 +6349,7 @@ mode. Configure @sink to drop buffers which are outside the current segment - + @@ -6374,7 +6374,7 @@ mode. filename="libs/gst/base/gstbasesink.c" line="1122">Configures @sink to store the last received sample in the last-sample property. - + @@ -6400,7 +6400,7 @@ property. Set the maximum amount of bits per second that the sink will render. - + @@ -6428,7 +6428,7 @@ property. used to decide if a buffer should be dropped or not based on the buffer timestamp and the current clock time. A value of -1 means an unlimited time. - + @@ -6458,7 +6458,7 @@ for processing the buffer. This is added to the latency of live pipelines. This function is usually called by subclasses. - + @@ -6482,7 +6482,7 @@ This function is usually called by subclasses. Configures @sink to send Quality-of-Service events upstream. - + @@ -6515,7 +6515,7 @@ After calling this function, this sink will report additional latency and other sinks will adjust their latency to delay the rendering of their media. This function is usually called by subclasses. - + @@ -6544,7 +6544,7 @@ This function is usually called by subclasses. possible. If @sync is %TRUE, the timestamps of the incoming buffers will be used to schedule the exact render time of its contents. - + @@ -6571,7 +6571,7 @@ contents. line="1413">Set the time that will be inserted between rendered buffers. This can be used to control the maximum buffers per second that the sink will render. - + @@ -6599,7 +6599,7 @@ will render. render buffers earlier than their timestamp. A positive value will delay rendering. This function can be used to fix playback of badly timestamped buffers. - + @@ -6632,7 +6632,7 @@ receiving an EOS event in the ::event vmethod or when handling buffers in The @time argument should be the running_time of when the timeout should happen and will be adjusted with any latency and offset configured in the sink. - + - + - + glib:is-gtype-struct-for="BaseSink"> Subclasses can override any of the available virtual methods or not, as + line="122">Subclasses can override any of the available virtual methods or not, as needed. At the minimum, the @render method should be overridden to output/present buffers. - + Element parent class + line="124">Element parent class Called to get sink pad caps from the subclass + line="125">Called to get sink pad caps from the subclass - + @@ -7008,9 +7008,9 @@ output/present buffers. Notify subclass of changed caps + line="126">Notify subclass of changed caps - + @@ -7027,10 +7027,10 @@ output/present buffers. Only useful in pull mode. Implement if you have + line="127">Only useful in pull mode. Implement if you have ideas about what should be the default values for the caps you support. - + @@ -7047,13 +7047,13 @@ output/present buffers. Subclasses should override this when they can provide an + line="129">Subclasses should override this when they can provide an alternate method of spawning a thread to drive the pipeline in pull mode. Should start or stop the pulling thread, depending on the value of the "active" argument. Called after actually activating the sink pad in pull mode. The default implementation starts a task on the sink pad. - + @@ -7070,10 +7070,10 @@ output/present buffers. Called to get the start and end times for synchronising + line="134">Called to get the start and end times for synchronising the passed buffer to the clock - + @@ -7090,7 +7090,7 @@ output/present buffers. transfer-ownership="full"> the start #GstClockTime + line="185">the start #GstClockTime transfer-ownership="full"> the end #GstClockTime + line="186">the end #GstClockTime @@ -7108,9 +7108,9 @@ output/present buffers. configure the allocation query + line="136">configure the allocation query - + @@ -7127,9 +7127,9 @@ output/present buffers. Start processing. Ideal for opening resources in the subclass + line="137">Start processing. Ideal for opening resources in the subclass - + @@ -7143,9 +7143,9 @@ output/present buffers. Stop processing. Subclasses should use this to close resources. + line="138">Stop processing. Subclasses should use this to close resources. - + @@ -7159,10 +7159,10 @@ output/present buffers. Unlock any pending access to the resource. Subclasses should + line="139">Unlock any pending access to the resource. Subclasses should unblock any blocked function ASAP and call gst_base_sink_wait_preroll() - + @@ -7176,13 +7176,13 @@ output/present buffers. Clear the previous unlock request. Subclasses should clear + line="141">Clear the previous unlock request. Subclasses should clear any state they set during #GstBaseSinkClass::unlock, and be ready to continue where they left off after gst_base_sink_wait_preroll(), gst_base_sink_wait() or gst_wait_sink_wait_clock() return or #GstBaseSinkClass::render is called again. - + @@ -7196,9 +7196,9 @@ output/present buffers. perform a #GstQuery on the element. + line="146">perform a #GstQuery on the element. - + @@ -7215,9 +7215,9 @@ output/present buffers. Override this to handle events arriving on the sink pad + line="147">Override this to handle events arriving on the sink pad - + @@ -7234,11 +7234,11 @@ output/present buffers. Override this to implement custom logic to wait for the event + line="148">Override this to implement custom logic to wait for the event time (for events like EOS and GAP). Subclasses should always first chain up to the default implementation. - + @@ -7255,10 +7255,10 @@ output/present buffers. Called to prepare the buffer for @render and @preroll. This + line="151">Called to prepare the buffer for @render and @preroll. This function is called before synchronisation is performed. - + @@ -7275,10 +7275,10 @@ output/present buffers. Called to prepare the buffer list for @render_list. This + line="153">Called to prepare the buffer list for @render_list. This function is called before synchronisation is performed. - + @@ -7295,9 +7295,9 @@ output/present buffers. Called to present the preroll buffer if desired. + line="155">Called to present the preroll buffer if desired. - + @@ -7314,10 +7314,10 @@ output/present buffers. Called when a buffer should be presented or output, at the + line="156">Called when a buffer should be presented or output, at the correct moment if the #GstBaseSink has been set to sync to the clock. - + @@ -7334,10 +7334,10 @@ output/present buffers. Same as @render but used with buffer lists instead of + line="158">Same as @render but used with buffer lists instead of buffers. - + @@ -7361,7 +7361,7 @@ output/present buffers. c:type="GstBaseSinkPrivate" disguised="1" opaque="1"> - + Negotiates src pad caps with downstream elements. + line="3509">Negotiates src pad caps with downstream elements. Unmarks GST_PAD_FLAG_NEED_RECONFIGURE in any case. But marks it again if #GstBaseSrcClass::negotiate fails. @@ -7740,14 +7740,14 @@ buffer is allocated. %TRUE if the negotiation succeeded, else %FALSE. + line="3521">%TRUE if the negotiation succeeded, else %FALSE. base source instance + line="3511">base source instance @@ -7797,25 +7797,25 @@ buffer is allocated. Set new caps on the basesrc source pad. + line="1000">Set new caps on the basesrc source pad. %TRUE if the caps could be set + line="1007">%TRUE if the caps could be set a #GstBaseSrc + line="1002">a #GstBaseSrc a #GstCaps + line="1003">a #GstCaps @@ -7889,7 +7889,7 @@ buffer is allocated. Lets #GstBaseSrc sub-classes to know the memory @allocator + line="4137">Lets #GstBaseSrc sub-classes to know the memory @allocator used by the base class and its @params. Unref the @allocator after usage. @@ -7901,7 +7901,7 @@ Unref the @allocator after usage. a #GstBaseSrc + line="4139">a #GstBaseSrc allow-none="1"> the #GstAllocator + line="4140">the #GstAllocator used @@ -7925,7 +7925,7 @@ used allow-none="1"> the #GstAllocationParams of @allocator + line="4142">the #GstAllocationParams of @allocator @@ -7935,19 +7935,19 @@ used glib:get-property="blocksize"> Get the number of bytes that @src will push out with each buffer. + line="804">Get the number of bytes that @src will push out with each buffer. the number of bytes pushed with each buffer. + line="810">the number of bytes pushed with each buffer. the source + line="806">the source @@ -7958,7 +7958,7 @@ used the instance of the #GstBufferPool used + line="4119">the instance of the #GstBufferPool used by the src; unref it after usage. @@ -7966,7 +7966,7 @@ by the src; unref it after usage. a #GstBaseSrc + line="4117">a #GstBaseSrc @@ -7976,19 +7976,19 @@ by the src; unref it after usage. glib:get-property="do-timestamp"> Query if @src timestamps outgoing buffers based on the current running_time. + line="848">Query if @src timestamps outgoing buffers based on the current running_time. %TRUE if the base class will automatically timestamp outgoing buffers. + line="854">%TRUE if the base class will automatically timestamp outgoing buffers. the source + line="850">the source @@ -7996,19 +7996,19 @@ by the src; unref it after usage. Get the current async behaviour of @src. See also gst_base_src_set_async(). + line="714">Get the current async behaviour of @src. See also gst_base_src_set_async(). %TRUE if @src is operating in async mode. + line="720">%TRUE if @src is operating in async mode. base source instance + line="716">base source instance @@ -8016,19 +8016,19 @@ by the src; unref it after usage. Check if an element is in live mode. + line="605">Check if an element is in live mode. %TRUE if element is in live mode. + line="611">%TRUE if element is in live mode. base source instance + line="607">base source instance @@ -8038,7 +8038,7 @@ by the src; unref it after usage. version="1.18"> Negotiates src pad caps with downstream elements. + line="3509">Negotiates src pad caps with downstream elements. Unmarks GST_PAD_FLAG_NEED_RECONFIGURE in any case. But marks it again if #GstBaseSrcClass::negotiate fails. @@ -8049,14 +8049,14 @@ buffer is allocated. %TRUE if the negotiation succeeded, else %FALSE. + line="3521">%TRUE if the negotiation succeeded, else %FALSE. base source instance + line="3511">base source instance @@ -8067,7 +8067,7 @@ buffer is allocated. deprecated-version="1.18"> Prepare a new seamless segment for emission downstream. This function must + line="870">Prepare a new seamless segment for emission downstream. This function must only be called by derived sub-classes, and only from the #GstBaseSrcClass::create function, as the stream-lock needs to be held. @@ -8078,32 +8078,32 @@ configured with gst_base_src_set_format() %TRUE if preparation of the seamless segment succeeded. + line="884">%TRUE if preparation of the seamless segment succeeded. The source + line="872">The source The new start value for the segment + line="873">The new start value for the segment Stop value for the new segment + line="874">Stop value for the new segment The new time value for the start of the new segment + line="875">The new time value for the start of the new segment @@ -8113,7 +8113,7 @@ configured with gst_base_src_set_format() version="1.18"> Prepare a new segment for emission downstream. This function must + line="920">Prepare a new segment for emission downstream. This function must only be called by derived sub-classes, and only from the #GstBaseSrcClass::create function, as the stream-lock needs to be held. @@ -8126,20 +8126,61 @@ should be configured via gst_base_src_set_format() before calling this method. %TRUE if preparation of new segment succeeded. + line="935">%TRUE if preparation of new segment succeeded. + + + + + a #GstBaseSrc + + + + a pointer to a #GstSegment + + + + + + Send a new segment downstream. This function must +only be called by derived sub-classes, and only from the #GstBaseSrcClass::create function, +as the stream-lock needs to be held. +This method also requires that an out caps has been configured, so +gst_base_src_set_caps() needs to have been called before. + +The format for the @segment must be identical with the current format +of the source, as configured with gst_base_src_set_format(). + +The format of @src must not be %GST_FORMAT_UNDEFINED and the format +should be configured via gst_base_src_set_format() before calling this method. + +This is a variant of gst_base_src_new_segment() sending the segment right away, +which can be useful to ensure events ordering. + + + %TRUE if sending of new segment succeeded. a #GstBaseSrc + line="4205">a #GstBaseSrc a pointer to a #GstSegment + line="4206">a pointer to a #GstSegment @@ -8147,7 +8188,7 @@ should be configured via gst_base_src_set_format() before calling this method. Query the source for the latency parameters. @live will be %TRUE when @src is + line="737">Query the source for the latency parameters. @live will be %TRUE when @src is configured as a live source. @min_latency and @max_latency will be set to the difference between the running time and the timestamp of the first buffer. @@ -8157,14 +8198,14 @@ This function is mostly used by subclasses. %TRUE if the query succeeded. + line="751">%TRUE if the query succeeded. the source + line="739">the source allow-none="1"> if the source is live + line="740">if the source is live allow-none="1"> the min latency of the source + line="741">the min latency of the source allow-none="1"> the max latency of the source + line="742">the max latency of the source @@ -8205,7 +8246,7 @@ This function is mostly used by subclasses. Configure async behaviour in @src, no state change will block. The open, + line="694">Configure async behaviour in @src, no state change will block. The open, close, start, stop, play and pause virtual methods will be executed in a different thread and are thus allowed to perform blocking operations. Any blocking operation should be unblocked with the unlock vmethod. @@ -8217,23 +8258,24 @@ blocking operation should be unblocked with the unlock vmethod. base source instance + line="696">base source instance new async mode + line="697">new async mode If @automatic_eos is %TRUE, @src will automatically go EOS if a buffer + line="668">If @automatic_eos is %TRUE, @src will automatically go EOS if a buffer after the total size is returned. By default this is %TRUE but sources that can't return an authoritative size and only know that they're EOS when trying to read more should set this to %FALSE. @@ -8251,13 +8293,13 @@ returns %GST_FLOW_EOS. base source instance + line="670">base source instance automatic eos + line="671">automatic eos @@ -8267,7 +8309,7 @@ returns %GST_FLOW_EOS. glib:set-property="blocksize"> Set the number of bytes that @src will push out with each buffer. When + line="786">Set the number of bytes that @src will push out with each buffer. When @blocksize is set to -1, a default length will be used. @@ -8277,13 +8319,13 @@ returns %GST_FLOW_EOS. the source + line="788">the source the new blocksize in bytes + line="789">the new blocksize in bytes @@ -8291,25 +8333,25 @@ returns %GST_FLOW_EOS. Set new caps on the basesrc source pad. + line="1000">Set new caps on the basesrc source pad. %TRUE if the caps could be set + line="1007">%TRUE if the caps could be set a #GstBaseSrc + line="1002">a #GstBaseSrc a #GstCaps + line="1003">a #GstCaps @@ -8319,7 +8361,7 @@ returns %GST_FLOW_EOS. glib:set-property="do-timestamp"> Configure @src to automatically timestamp outgoing buffers based on the + line="827">Configure @src to automatically timestamp outgoing buffers based on the current running_time of the pipeline. This property is mostly useful for live sources. @@ -8330,13 +8372,13 @@ sources. the source + line="829">the source enable or disable timestamping + line="830">enable or disable timestamping @@ -8345,7 +8387,7 @@ sources. c:identifier="gst_base_src_set_dynamic_size"> If not @dynamic, size is only updated when needed, such as when trying to + line="651">If not @dynamic, size is only updated when needed, such as when trying to read past current tracked size. Otherwise, size is checked for upon each read. @@ -8356,13 +8398,13 @@ read. base source instance + line="653">base source instance new dynamic size mode + line="654">new dynamic size mode @@ -8370,7 +8412,7 @@ read. Sets the default format of the source. This will be the format used + line="627">Sets the default format of the source. This will be the format used for sending SEGMENT events and for performing seeks. If a format of GST_FORMAT_BYTES is set, the element will be able to @@ -8385,13 +8427,13 @@ This function must only be called in states < %GST_STATE_PAUSED. base source instance + line="629">base source instance the format to use + line="630">the format to use @@ -8399,7 +8441,7 @@ This function must only be called in states < %GST_STATE_PAUSED. If the element listens to a live source, @live should + line="581">If the element listens to a live source, @live should be set to %TRUE. A live source will not produce data in the PAUSED state and @@ -8415,13 +8457,13 @@ be GST_STATE_CHANGE_NO_PREROLL. base source instance + line="583">base source instance new live-mode + line="584">new live-mode @@ -8429,7 +8471,7 @@ be GST_STATE_CHANGE_NO_PREROLL. Complete an asynchronous start operation. When the subclass overrides the + line="3613">Complete an asynchronous start operation. When the subclass overrides the start method, it should call gst_base_src_start_complete() when the start operation completes either from the same thread or from an asynchronous helper thread. @@ -8441,13 +8483,13 @@ helper thread. base source instance + line="3615">base source instance a #GstFlowReturn + line="3616">a #GstFlowReturn @@ -8455,19 +8497,19 @@ helper thread. Wait until the start operation completes. + line="3753">Wait until the start operation completes. a #GstFlowReturn. + line="3759">a #GstFlowReturn. base source instance + line="3755">base source instance @@ -8477,7 +8519,7 @@ helper thread. version="1.14"> Subclasses can call this from their create virtual method implementation + line="4165">Subclasses can call this from their create virtual method implementation to submit a buffer list to be pushed out later. This is useful in cases where the create function wants to produce multiple buffers to be pushed out in one go in form of a #GstBufferList, which can reduce overhead @@ -8501,13 +8543,13 @@ mode. a #GstBaseSrc + line="4167">a #GstBaseSrc a #GstBufferList + line="4168">a #GstBufferList @@ -8515,7 +8557,7 @@ mode. If the #GstBaseSrcClass::create method performs its own synchronisation + line="551">If the #GstBaseSrcClass::create method performs its own synchronisation against the clock it must unblock when going from PLAYING to the PAUSED state and call this method before continuing to produce the remaining data. @@ -8527,7 +8569,7 @@ returns %GST_FLOW_FLUSHING). %GST_FLOW_OK if @src is PLAYING and processing can + line="564">%GST_FLOW_OK if @src is PLAYING and processing can continue. Any other return value should be returned from the create vmethod. @@ -8535,11 +8577,22 @@ continue. Any other return value should be returned from the create vmethod. the src + line="553">the src + + See gst_base_src_set_automatic_eos() + + %TRUE if the negotiation succeeded, else %FALSE. + line="3521">%TRUE if the negotiation succeeded, else %FALSE. base source instance + line="3511">base source instance @@ -8719,20 +8772,20 @@ buffers. %TRUE if the caps could be set + line="1007">%TRUE if the caps could be set a #GstBaseSrc + line="1002">a #GstBaseSrc a #GstCaps + line="1003">a #GstCaps @@ -18363,7 +18416,7 @@ caused by memory management by a large factor. introspectable="0"> Clears queue @array and frees all memory associated to it. + line="172">Clears queue @array and frees all memory associated to it. @@ -18372,7 +18425,7 @@ caused by memory management by a large factor. a #GstQueueArray object + line="174">a #GstQueueArray object @@ -18383,25 +18436,25 @@ caused by memory management by a large factor. introspectable="0"> Drops the queue element at position @idx from queue @array. + line="911">Drops the queue element at position @idx from queue @array. the dropped element + line="918">the dropped element a #GstQueueArray object + line="913">a #GstQueueArray object index to drop + line="914">index to drop @@ -18412,27 +18465,27 @@ caused by memory management by a large factor. introspectable="0"> Drops the queue element at position @idx from queue @array and copies the + line="793">Drops the queue element at position @idx from queue @array and copies the data of the element or structure that was removed into @p_struct if @p_struct is set (not NULL). TRUE on success, or FALSE on error + line="803">TRUE on success, or FALSE on error a #GstQueueArray object + line="795">a #GstQueueArray object index to drop + line="796">index to drop address into which to store the data of the dropped structure, or NULL + line="797">address into which to store the data of the dropped structure, or NULL @@ -18452,21 +18505,21 @@ data of the element or structure that was removed into @p_struct if introspectable="0"> Finds an element in the queue @array, either by comparing every element + line="933">Finds an element in the queue @array, either by comparing every element with @func or by looking up @data if no compare function @func is provided, and returning the index of the found element. Index of the found element or -1 if nothing was found. + line="943">Index of the found element or -1 if nothing was found. a #GstQueueArray object + line="935">a #GstQueueArray object closure="1"> comparison function, or %NULL to find @data by value + line="936">comparison function, or %NULL to find @data by value allow-none="1"> data for comparison function + line="937">data for comparison function @@ -18496,7 +18549,7 @@ and returning the index of the found element. introspectable="0"> Frees queue @array and all memory associated to it. + line="114">Frees queue @array and all memory associated to it. @@ -18505,7 +18558,7 @@ and returning the index of the found element. a #GstQueueArray object + line="116">a #GstQueueArray object @@ -18516,19 +18569,19 @@ and returning the index of the found element. introspectable="0"> Returns the length of the queue @array + line="981">Returns the length of the queue @array the length of the queue @array. + line="987">the length of the queue @array. a #GstQueueArray object + line="983">a #GstQueueArray object @@ -18539,19 +18592,19 @@ and returning the index of the found element. introspectable="0"> Checks if the queue @array is empty. + line="775">Checks if the queue @array is empty. %TRUE if the queue @array is empty + line="781">%TRUE if the queue @array is empty a #GstQueueArray object + line="777">a #GstQueueArray object @@ -18562,20 +18615,20 @@ and returning the index of the found element. introspectable="0"> Returns the head of the queue @array and does not + line="279">Returns the head of the queue @array and does not remove it from the queue. The head of the queue + line="286">The head of the queue a #GstQueueArray object + line="281">a #GstQueueArray object @@ -18586,12 +18639,12 @@ remove it from the queue. introspectable="0"> Returns the head of the queue @array without removing it from the queue. + line="256">Returns the head of the queue @array without removing it from the queue. pointer to element or struct, or NULL if @array was empty. The + line="262">pointer to element or struct, or NULL if @array was empty. The data pointed to by the returned pointer stays valid only as long as the queue array is not modified further! @@ -18600,7 +18653,7 @@ remove it from the queue. a #GstQueueArray object + line="258">a #GstQueueArray object @@ -18611,12 +18664,12 @@ remove it from the queue. introspectable="0"> Returns the item at @idx in @array, but does not remove it from the queue. + line="301">Returns the item at @idx in @array, but does not remove it from the queue. The item, or %NULL if @idx was out of bounds + line="306">The item, or %NULL if @idx was out of bounds @@ -18634,12 +18687,12 @@ remove it from the queue. introspectable="0"> Returns the item at @idx in @array, but does not remove it from the queue. + line="321">Returns the item at @idx in @array, but does not remove it from the queue. The item, or %NULL if @idx was out of bounds + line="326">The item, or %NULL if @idx was out of bounds @@ -18657,19 +18710,19 @@ remove it from the queue. introspectable="0"> Returns the tail of the queue @array, but does not remove it from the queue. + line="649">Returns the tail of the queue @array, but does not remove it from the queue. The tail of the queue + line="655">The tail of the queue a #GstQueueArray object + line="651">a #GstQueueArray object @@ -18680,19 +18733,19 @@ remove it from the queue. introspectable="0"> Returns the tail of the queue @array, but does not remove it from the queue. + line="677">Returns the tail of the queue @array, but does not remove it from the queue. The tail of the queue + line="683">The tail of the queue a #GstQueueArray object + line="679">a #GstQueueArray object @@ -18703,20 +18756,20 @@ remove it from the queue. introspectable="0"> Returns and head of the queue @array and removes + line="228">Returns and head of the queue @array and removes it from the queue. The head of the queue + line="235">The head of the queue a #GstQueueArray object + line="230">a #GstQueueArray object @@ -18727,12 +18780,12 @@ it from the queue. introspectable="0"> Returns the head of the queue @array and removes it from the queue. + line="198">Returns the head of the queue @array and removes it from the queue. pointer to element or struct, or NULL if @array was empty. The + line="204">pointer to element or struct, or NULL if @array was empty. The data pointed to by the returned pointer stays valid only as long as the queue array is not modified further! @@ -18741,7 +18794,7 @@ it from the queue. a #GstQueueArray object + line="200">a #GstQueueArray object @@ -18752,20 +18805,20 @@ it from the queue. introspectable="0"> Returns the tail of the queue @array and removes + line="705">Returns the tail of the queue @array and removes it from the queue. The tail of the queue + line="712">The tail of the queue a #GstQueueArray object + line="707">a #GstQueueArray object @@ -18776,22 +18829,126 @@ it from the queue. introspectable="0"> Returns the tail of the queue @array and removes + line="740">Returns the tail of the queue @array and removes it from the queue. The tail of the queue + line="747">The tail of the queue a #GstQueueArray object + line="742">a #GstQueueArray object + + + + + + Pushes @data to the queue @array, finding the correct position +by comparing @data with each array element using @func. + +This has a time complexity of O(n), so depending on the size of the queue +and expected access patterns, a different data structure might be better. + +Assumes that the array is already sorted. If it is not, make sure +to call gst_queue_array_sort() first. + + + + + + + a #GstQueueArray object + + + + object to push + + + + comparison function + + + + data for comparison function + + + + + + Pushes the element at address @p_struct into the queue @array +(copying the contents of a structure of the struct_size specified +when creating the queue into the array), finding the correct position +by comparing the element at @p_struct with each element in the array using @func. + +This has a time complexity of O(n), so depending on the size of the queue +and expected access patterns, a different data structure might be better. + +Assumes that the array is already sorted. If it is not, make sure +to call gst_queue_array_sort() first. + + + + + + + a #GstQueueArray object + + address of element or structure to push into the queue + + + + comparison function + + + + data for comparison function + + introspectable="0"> Pushes @data to the tail of the queue @array. + line="419">Pushes @data to the tail of the queue @array. @@ -18809,7 +18966,7 @@ it from the queue. a #GstQueueArray object + line="421">a #GstQueueArray object allow-none="1"> object to push + line="422">object to push @@ -18847,7 +19004,7 @@ it from the queue. introspectable="0"> Sets a function to clear an element of @array. + line="131">Sets a function to clear an element of @array. The @clear_func will be called when an element in the array data segment is removed and when the array is freed and data @@ -18865,37 +19022,73 @@ the array element it is given, but not free the element itself. a #GstQueueArray object + line="133">a #GstQueueArray object a function to clear an element of @array + line="134">a function to clear an element of @array + + Sorts the queue @array by comparing elements against each other using +the provided @compare_func. + + + + + + + a #GstQueueArray object + + + + comparison function + + + + data for comparison function + + + + Allocates a new #GstQueueArray object with an initial + line="93">Allocates a new #GstQueueArray object with an initial queue size of @initial_size. a new #GstQueueArray object + line="100">a new #GstQueueArray object Initial size of the new queue + line="95">Initial size of the new queue @@ -18906,26 +19099,26 @@ queue size of @initial_size. introspectable="0"> Allocates a new #GstQueueArray object for elements (e.g. structures) + line="62">Allocates a new #GstQueueArray object for elements (e.g. structures) of size @struct_size, with an initial queue size of @initial_size. a new #GstQueueArray object + line="70">a new #GstQueueArray object Size of each element (e.g. structure) in the array + line="64">Size of each element (e.g. structure) in the array Initial size of the new queue + line="65">Initial size of the new queue @@ -18953,7 +19146,7 @@ of size @struct_size, with an initial queue size of @initial_size. GstTypeFindData * to free + line="1141">GstTypeFindData * to free @@ -18964,20 +19157,20 @@ of size @struct_size, with an initial queue size of @initial_size. introspectable="0"> Returns #GstCaps associated with #GstTypeFindData + line="1082">Returns #GstCaps associated with #GstTypeFindData #GstCaps. + line="1088">#GstCaps. GstTypeFindData * + line="1084">GstTypeFindData * @@ -18988,13 +19181,13 @@ of size @struct_size, with an initial queue size of @initial_size. introspectable="0"> Returns #GstTypeFindProbability associated with #GstTypeFindData + line="1101">Returns #GstTypeFindProbability associated with #GstTypeFindData #GstTypeFindProbability. + line="1107">#GstTypeFindProbability. @@ -19002,7 +19195,7 @@ of size @struct_size, with an initial queue size of @initial_size. GstTypeFindData * + line="1103">GstTypeFindData * @@ -19013,20 +19206,20 @@ of size @struct_size, with an initial queue size of @initial_size. introspectable="0"> Returns #GstTypeFind associated with #GstTypeFindData + line="1120">Returns #GstTypeFind associated with #GstTypeFindData #GstTypeFind. + line="1126">#GstTypeFind. GstTypeFindData * + line="1122">GstTypeFindData * @@ -19037,13 +19230,13 @@ of size @struct_size, with an initial queue size of @initial_size. introspectable="0"> Free-function: gst_type_find_data_free + line="1044">Free-function: gst_type_find_data_free the #GstTypeFindData. The caller should free + line="1052">the #GstTypeFindData. The caller should free the returned #GstTypeFindData with gst_type_find_data_free(). @@ -19054,13 +19247,13 @@ of size @struct_size, with an initial queue size of @initial_size. allow-none="1"> object doing the typefinding, or %NULL (used for logging) + line="1046">object doing the typefinding, or %NULL (used for logging) a pointer with data to typefind + line="1047">a pointer with data to typefind @@ -19068,7 +19261,7 @@ of size @struct_size, with an initial queue size of @initial_size. the size of @data + line="1048">the size of @data @@ -19483,20 +19676,20 @@ typefinding in push mode from a chain function. introspectable="0"> Allocates a new #GstQueueArray object with an initial + line="93">Allocates a new #GstQueueArray object with an initial queue size of @initial_size. a new #GstQueueArray object + line="100">a new #GstQueueArray object Initial size of the new queue + line="95">Initial size of the new queue @@ -19508,26 +19701,26 @@ queue size of @initial_size. introspectable="0"> Allocates a new #GstQueueArray object for elements (e.g. structures) + line="62">Allocates a new #GstQueueArray object for elements (e.g. structures) of size @struct_size, with an initial queue size of @initial_size. a new #GstQueueArray object + line="70">a new #GstQueueArray object Size of each element (e.g. structure) in the array + line="64">Size of each element (e.g. structure) in the array Initial size of the new queue + line="65">Initial size of the new queue @@ -19539,12 +19732,12 @@ of size @struct_size, with an initial queue size of @initial_size. introspectable="0"> Free-function: gst_type_find_data_free + line="1044">Free-function: gst_type_find_data_free the #GstTypeFindData. The caller should free + line="1052">the #GstTypeFindData. The caller should free the returned #GstTypeFindData with gst_type_find_data_free(). @@ -19555,13 +19748,13 @@ of size @struct_size, with an initial queue size of @initial_size. allow-none="1"> object doing the typefinding, or %NULL (used for logging) + line="1046">object doing the typefinding, or %NULL (used for logging) a pointer with data to typefind + line="1047">a pointer with data to typefind @@ -19569,7 +19762,7 @@ of size @struct_size, with an initial queue size of @initial_size. the size of @data + line="1048">the size of @data @@ -19607,7 +19800,7 @@ Free-function: gst_caps_unref c:identifier="gst_type_find_helper_for_buffer"> Tries to find what type of data is contained in the given #GstBuffer, the + line="784">Tries to find what type of data is contained in the given #GstBuffer, the assumption being that the buffer represents the beginning of the stream or file. @@ -19623,7 +19816,7 @@ Free-function: gst_caps_unref the #GstCaps corresponding to the data, + line="804">the #GstCaps corresponding to the data, or %NULL if no type could be found. The caller should free the caps returned with gst_caps_unref(). @@ -19635,13 +19828,13 @@ Free-function: gst_caps_unref allow-none="1"> object doing the typefinding, or %NULL (used for logging) + line="786">object doing the typefinding, or %NULL (used for logging) a #GstBuffer with data to typefind + line="787">a #GstBuffer with data to typefind allow-none="1"> location to store the probability of the found + line="788">location to store the probability of the found caps, or %NULL @@ -19664,7 +19857,7 @@ Free-function: gst_caps_unref version="1.22"> Tries to find if type of media contained in the given #GstBuffer, matches + line="869">Tries to find if type of media contained in the given #GstBuffer, matches @caps specified, assumption being that the buffer represents the beginning of the stream or file. @@ -19681,7 +19874,7 @@ Free-function: gst_caps_unref the #GstCaps corresponding to the data, + line="891">the #GstCaps corresponding to the data, or %NULL if no type could be found. The caller should free the caps returned with gst_caps_unref(). @@ -19693,19 +19886,19 @@ Free-function: gst_caps_unref allow-none="1"> object doing the typefinding, or %NULL (used for logging) + line="871">object doing the typefinding, or %NULL (used for logging) a #GstBuffer with data to typefind + line="872">a #GstBuffer with data to typefind caps of the media + line="873">caps of the media allow-none="1"> location to store the probability of the found + line="874">location to store the probability of the found caps, or %NULL @@ -19728,7 +19921,7 @@ Free-function: gst_caps_unref version="1.16"> Tries to find what type of data is contained in the given #GstBuffer, the + line="815">Tries to find what type of data is contained in the given #GstBuffer, the assumption being that the buffer represents the beginning of the stream or file. @@ -19748,7 +19941,7 @@ Free-function: gst_caps_unref the #GstCaps corresponding to the data, + line="840">the #GstCaps corresponding to the data, or %NULL if no type could be found. The caller should free the caps returned with gst_caps_unref(). @@ -19760,13 +19953,13 @@ Free-function: gst_caps_unref allow-none="1"> object doing the typefinding, or %NULL (used for logging) + line="817">object doing the typefinding, or %NULL (used for logging) a #GstBuffer with data to typefind + line="818">a #GstBuffer with data to typefind allow-none="1"> extension of the media, or %NULL + line="819">extension of the media, or %NULL allow-none="1"> location to store the probability of the found + line="820">location to store the probability of the found caps, or %NULL @@ -20007,7 +20200,7 @@ Free-function: gst_caps_unref c:identifier="gst_type_find_helper_for_extension"> Tries to find the best #GstCaps associated with @extension. + line="923">Tries to find the best #GstCaps associated with @extension. All available typefinders will be checked against the extension in order of rank. The caps of the first typefinder that can handle @extension will be @@ -20018,7 +20211,7 @@ Free-function: gst_caps_unref the #GstCaps corresponding to + line="936">the #GstCaps corresponding to @extension, or %NULL if no type could be found. The caller should free the caps returned with gst_caps_unref(). @@ -20030,13 +20223,13 @@ Free-function: gst_caps_unref allow-none="1"> object doing the typefinding, or %NULL (used for logging) + line="925">object doing the typefinding, or %NULL (used for logging) an extension + line="926">an extension @@ -20216,7 +20409,7 @@ in many cases. version="1.22"> Tries to find the best #GstTypeFindFactory associated with @caps. + line="988">Tries to find the best #GstTypeFindFactory associated with @caps. The typefinder that can handle @caps will be returned. @@ -20225,7 +20418,7 @@ Free-function: g_list_free the list of #GstTypeFindFactory + line="999">the list of #GstTypeFindFactory corresponding to @caps, or %NULL if no typefinder could be found. Caller should free the returned list with g_list_free() and list elements with gst_object_unref(). @@ -20240,13 +20433,13 @@ Free-function: g_list_free allow-none="1"> object doing the typefinding, or %NULL (used for logging) + line="990">object doing the typefinding, or %NULL (used for logging) caps of the media + line="991">caps of the media diff --git a/girs/GstCheck-1.0.gir b/girs/GstCheck-1.0.gir index 58f152bb8..e071a939b 100644 --- a/girs/GstCheck-1.0.gir +++ b/girs/GstCheck-1.0.gir @@ -235,7 +235,7 @@ gst_harness_push_from_src (h); introspectable="0"> Adds a #GstElement to an empty #GstHarness + line="762">Adds a #GstElement to an empty #GstHarness MT safe. @@ -246,13 +246,13 @@ MT safe. a #GstHarness + line="764">a #GstHarness a #GstElement to add to the harness (transfer none) + line="765">a #GstElement to add to the harness (transfer none) allow-none="1"> a #GstStaticPadTemplate describing the harness srcpad. + line="766">a #GstStaticPadTemplate describing the harness srcpad. %NULL will not create a harness srcpad. @@ -271,7 +271,7 @@ MT safe. allow-none="1"> a #gchar with the name of the element + line="768">a #gchar with the name of the element sinkpad that is then linked to the harness srcpad. Can be a static or request or a sometimes pad that has been added. %NULL will not get/request a sinkpad from the element. (Like if the element is a src.) @@ -283,7 +283,7 @@ from the element. (Like if the element is a src.) allow-none="1"> a #GstStaticPadTemplate describing the harness sinkpad. + line="772">a #GstStaticPadTemplate describing the harness sinkpad. %NULL will not create a harness sinkpad. @@ -293,7 +293,7 @@ from the element. (Like if the element is a src.) allow-none="1"> a #gchar with the name of the element + line="774">a #gchar with the name of the element srcpad that is then linked to the harness sinkpad, similar to the @element_sinkpad_name. @@ -305,7 +305,7 @@ srcpad that is then linked to the harness sinkpad, similar to the version="1.6"> Links the specified #GstPad the @GstHarness srcpad. + line="1242">Links the specified #GstPad the @GstHarness srcpad. MT safe. @@ -316,13 +316,13 @@ MT safe. a #GstHarness + line="1244">a #GstHarness a #GstPad to link to the harness srcpad + line="1245">a #GstPad to link to the harness srcpad @@ -332,7 +332,7 @@ MT safe. version="1.6"> Links the specified #GstPad the @GstHarness sinkpad. This can be useful if + line="1216">Links the specified #GstPad the @GstHarness sinkpad. This can be useful if perhaps the srcpad did not exist at the time of creating the harness, like a demuxer that provides a sometimes-pad after receiving data. @@ -345,13 +345,13 @@ MT safe. a #GstHarness + line="1218">a #GstHarness a #GstPad to link to the harness sinkpad + line="1219">a #GstPad to link to the harness sinkpad @@ -362,7 +362,7 @@ MT safe. introspectable="0"> Parses the @launchline and puts that in a #GstBin, + line="994">Parses the @launchline and puts that in a #GstBin, and then attches the supplied #GstHarness to the bin. MT safe. @@ -374,13 +374,13 @@ MT safe. a #GstHarness + line="996">a #GstHarness a #gchar describing a gst-launch type line + line="997">a #gchar describing a gst-launch type line @@ -390,7 +390,7 @@ MT safe. version="1.6"> A convenience function to allows you to call gst_pad_add_probe on a + line="2831">A convenience function to allows you to call gst_pad_add_probe on a #GstPad of a #GstElement that are residing inside the #GstHarness, by using normal gst_pad_add_probe syntax @@ -403,25 +403,25 @@ MT safe. a #GstHarness + line="2833">a #GstHarness a #gchar with a #GstElementFactory name + line="2834">a #gchar with a #GstElementFactory name a #gchar with the name of the pad to attach the probe to + line="2835">a #gchar with the name of the pad to attach the probe to a #GstPadProbeType (see gst_pad_add_probe) + line="2836">a #GstPadProbeType (see gst_pad_add_probe) destroy="5"> a #GstPadProbeCallback (see gst_pad_add_probe) + line="2837">a #GstPadProbeCallback (see gst_pad_add_probe) allow-none="1"> a #gpointer (see gst_pad_add_probe) + line="2838">a #gpointer (see gst_pad_add_probe) scope="async"> a #GDestroyNotify (see gst_pad_add_probe) + line="2839">a #GDestroyNotify (see gst_pad_add_probe) @@ -458,7 +458,7 @@ MT safe. version="1.16"> Add api with params as one of the supported metadata API to propose when + line="2339">Add api with params as one of the supported metadata API to propose when receiving an allocation query. MT safe. @@ -470,13 +470,13 @@ MT safe. a #GstHarness + line="2341">a #GstHarness a metadata API + line="2342">a metadata API allow-none="1"> API specific parameters + line="2343">API specific parameters @@ -495,7 +495,7 @@ MT safe. version="1.6"> Similar to gst_harness_add_sink_harness, this is a convenience to + line="2620">Similar to gst_harness_add_sink_harness, this is a convenience to directly create a sink-harness using the @sink_element_name name specified. MT safe. @@ -507,13 +507,13 @@ MT safe. a #GstHarness + line="2622">a #GstHarness a #gchar with the name of a #GstElement + line="2623">a #gchar with the name of a #GstElement @@ -523,7 +523,7 @@ MT safe. version="1.6"> Similar to gst_harness_add_src, this allows you to send the data coming out + line="2568">Similar to gst_harness_add_src, this allows you to send the data coming out of your harnessed #GstElement to a sink-element, allowing to test different responses the element output might create in sink elements. An example might be an existing sink providing some analytical data on the input it receives that @@ -541,13 +541,13 @@ MT safe. a #GstHarness + line="2570">a #GstHarness a #GstHarness to be added as a sink-harness. + line="2571">a #GstHarness to be added as a sink-harness. @@ -557,7 +557,7 @@ MT safe. version="1.6"> Similar to gst_harness_add_sink, this allows you to specify a launch-line + line="2639">Similar to gst_harness_add_sink, this allows you to specify a launch-line instead of just an element name. See gst_harness_add_src_parse for details. MT safe. @@ -569,13 +569,13 @@ MT safe. a #GstHarness + line="2641">a #GstHarness a #gchar with the name of a #GstElement + line="2642">a #gchar with the name of a #GstElement @@ -583,7 +583,7 @@ MT safe. Similar to gst_harness_add_src_harness, this is a convenience to + line="2408">Similar to gst_harness_add_src_harness, this is a convenience to directly create a src-harness using the @src_element_name name specified. MT safe. @@ -595,19 +595,19 @@ MT safe. a #GstHarness + line="2410">a #GstHarness a #gchar with the name of a #GstElement + line="2411">a #gchar with the name of a #GstElement a #gboolean specifying if the #GstElement uses + line="2412">a #gboolean specifying if the #GstElement uses gst_clock_wait_id internally. @@ -618,7 +618,7 @@ gst_clock_wait_id internally. version="1.6"> A src-harness is a great way of providing the #GstHarness with data. + line="2371">A src-harness is a great way of providing the #GstHarness with data. By adding a src-type #GstElement, it is then easy to use functions like gst_harness_push_from_src or gst_harness_src_crank_and_push_many to provide your harnessed element with input. The @has_clock_wait variable @@ -637,19 +637,19 @@ MT safe. a #GstHarness + line="2373">a #GstHarness a #GstHarness to be added as a src-harness. + line="2374">a #GstHarness to be added as a src-harness. a #gboolean specifying if the #GstElement uses + line="2375">a #gboolean specifying if the #GstElement uses gst_clock_wait_id internally. @@ -660,7 +660,7 @@ gst_clock_wait_id internally. version="1.6"> Similar to gst_harness_add_src, this allows you to specify a launch-line, + line="2430">Similar to gst_harness_add_src, this allows you to specify a launch-line, which can be useful for both having more then one #GstElement acting as your src (Like a src producing raw buffers, and then an encoder, providing encoded data), but also by allowing you to set properties like "is-live" directly on @@ -675,19 +675,19 @@ MT safe. a #GstHarness + line="2432">a #GstHarness a #gchar describing a gst-launch type line + line="2433">a #gchar describing a gst-launch type line a #gboolean specifying if the #GstElement uses + line="2434">a #gboolean specifying if the #GstElement uses gst_clock_wait_id internally. @@ -698,21 +698,21 @@ gst_clock_wait_id internally. version="1.6"> The number of #GstBuffers currently in the #GstHarness sinkpad #GAsyncQueue + line="1843">The number of #GstBuffers currently in the #GstHarness sinkpad #GAsyncQueue MT safe. a #guint number of buffers in the queue + line="1851">a #guint number of buffers in the queue a #GstHarness + line="1845">a #GstHarness @@ -722,7 +722,7 @@ MT safe. version="1.6"> The total number of #GstBuffers that has arrived on the #GstHarness sinkpad. + line="1822">The total number of #GstBuffers that has arrived on the #GstHarness sinkpad. This number includes buffers that have been dropped as well as buffers that have already been pulled out. @@ -731,14 +731,14 @@ MT safe. a #guint number of buffers received + line="1832">a #guint number of buffers received a #GstHarness + line="1824">a #GstHarness @@ -748,7 +748,7 @@ MT safe. version="1.6"> Similar to gst_harness_crank_single_clock_wait(), this is the function to use + line="1513">Similar to gst_harness_crank_single_clock_wait(), this is the function to use if your harnessed element(s) are using more then one gst_clock_id_wait. Failing to do so can (and will) make it racy which #GstClockID you actually are releasing, where as this function will process all the waits at the @@ -760,20 +760,20 @@ MT safe. a @gboolean %TRUE if the "crank" was successful, %FALSE if not. + line="1527">a @gboolean %TRUE if the "crank" was successful, %FALSE if not. a #GstHarness + line="1515">a #GstHarness a #guint describing the number of #GstClockIDs to crank + line="1516">a #guint describing the number of #GstClockIDs to crank @@ -783,7 +783,7 @@ MT safe. version="1.6"> A "crank" consists of three steps: + line="1488">A "crank" consists of three steps: 1: Wait for a #GstClockID to be registered with the #GstTestClock. 2: Advance the #GstTestClock to the time the #GstClockID is waiting for. 3: Release the #GstClockID wait. @@ -797,14 +797,14 @@ MT safe. a @gboolean %TRUE if the "crank" was successful, %FALSE if not. + line="1503">a @gboolean %TRUE if the "crank" was successful, %FALSE if not. a #GstHarness + line="1490">a #GstHarness @@ -814,7 +814,7 @@ MT safe. version="1.6"> Allocates a buffer using a #GstBufferPool if present, or else using the + line="1639">Allocates a buffer using a #GstBufferPool if present, or else using the configured #GstAllocator and #GstAllocationParams MT safe. @@ -822,20 +822,20 @@ MT safe. a #GstBuffer of size @size + line="1649">a #GstBuffer of size @size a #GstHarness + line="1641">a #GstHarness a #gsize specifying the size of the buffer + line="1642">a #gsize specifying the size of the buffer @@ -845,7 +845,7 @@ MT safe. version="1.6"> Allows you to dump the #GstBuffers the #GstHarness sinkpad #GAsyncQueue + line="1974">Allows you to dump the #GstBuffers the #GstHarness sinkpad #GAsyncQueue to a file. MT safe. @@ -857,13 +857,13 @@ MT safe. a #GstHarness + line="1976">a #GstHarness a #gchar with a the name of a file + line="1977">a #gchar with a the name of a file @@ -873,21 +873,21 @@ MT safe. version="1.6"> The number of #GstEvents currently in the #GstHarness sinkpad #GAsyncQueue + line="2103">The number of #GstEvents currently in the #GstHarness sinkpad #GAsyncQueue MT safe. a #guint number of events in the queue + line="2111">a #guint number of events in the queue a #GstHarness + line="2105">a #GstHarness @@ -897,7 +897,7 @@ MT safe. version="1.6"> The total number of #GstEvents that has arrived on the #GstHarness sinkpad + line="2082">The total number of #GstEvents that has arrived on the #GstHarness sinkpad This number includes events handled by the harness as well as events that have already been pulled out. @@ -906,14 +906,14 @@ MT safe. a #guint number of events received + line="2092">a #guint number of events received a #GstHarness + line="2084">a #GstHarness @@ -923,7 +923,7 @@ MT safe. version="1.6"> Most useful in conjunction with gst_harness_new_parse, this will scan the + line="2709">Most useful in conjunction with gst_harness_new_parse, this will scan the #GstElements inside the #GstHarness, and check if any of them matches @element_name. Typical usecase being that you need to access one of the harnessed elements for properties and/or signals. @@ -933,20 +933,20 @@ MT safe. a #GstElement or %NULL if not found + line="2721">a #GstElement or %NULL if not found a #GstHarness + line="2711">a #GstHarness a #gchar with a #GstElementFactory name + line="2712">a #gchar with a #GstElementFactory name @@ -957,7 +957,7 @@ MT safe. introspectable="0"> A convenience function to allows you to call g_object_get on a #GstElement + line="2803">A convenience function to allows you to call g_object_get on a #GstElement that are residing inside the #GstHarness, by using normal g_object_get syntax. @@ -970,25 +970,25 @@ MT safe. a #GstHarness + line="2805">a #GstHarness a #gchar with a #GstElementFactory name + line="2806">a #gchar with a #GstElementFactory name a #gchar with the first property name + line="2807">a #gchar with the first property name return location for the first property, followed optionally by more + line="2808">return location for the first property, followed optionally by more name/return location pairs, followed by %NULL @@ -999,7 +999,7 @@ MT safe. version="1.6"> Gets the @allocator and its @params that has been decided to use after an + line="2289">Gets the @allocator and its @params that has been decided to use after an allocation query. MT safe. @@ -1011,7 +1011,7 @@ MT safe. a #GstHarness + line="2291">a #GstHarness allow-none="1"> the #GstAllocator used + line="2292">the #GstAllocator used allow-none="1"> the #GstAllocationParams of + line="2293">the #GstAllocationParams of @allocator @@ -1045,7 +1045,7 @@ MT safe. version="1.6"> Get the timestamp of the last #GstBuffer pushed on the #GstHarness srcpad, + line="2001">Get the timestamp of the last #GstBuffer pushed on the #GstHarness srcpad, typically with gst_harness_push or gst_harness_push_from_src. MT safe. @@ -1053,7 +1053,7 @@ MT safe. a #GstClockTime with the timestamp or %GST_CLOCK_TIME_NONE if no + line="2010">a #GstClockTime with the timestamp or %GST_CLOCK_TIME_NONE if no #GstBuffer has been pushed on the #GstHarness srcpad @@ -1061,7 +1061,7 @@ MT safe. a #GstHarness + line="2003">a #GstHarness @@ -1071,7 +1071,7 @@ MT safe. version="1.6"> Get the #GstTestClock. Useful if specific operations on the testclock is + line="1422">Get the #GstTestClock. Useful if specific operations on the testclock is needed. MT safe. @@ -1079,7 +1079,7 @@ MT safe. a #GstTestClock, or %NULL if the testclock is not + line="1431">a #GstTestClock, or %NULL if the testclock is not present. @@ -1087,7 +1087,7 @@ present. a #GstHarness + line="1424">a #GstHarness @@ -1095,7 +1095,7 @@ present. This will set the harnessed #GstElement to %GST_STATE_PLAYING. + line="1546">This will set the harnessed #GstElement to %GST_STATE_PLAYING. #GstElements without a sink-#GstPad and with the %GST_ELEMENT_FLAG_SOURCE flag set is considered a src #GstElement Non-src #GstElements (like sinks and filters) are automatically set to @@ -1112,7 +1112,7 @@ MT safe. a #GstHarness + line="1548">a #GstHarness @@ -1120,7 +1120,7 @@ MT safe. Pulls a #GstBuffer from the #GAsyncQueue on the #GstHarness sinkpad. The pull + line="1707">Pulls a #GstBuffer from the #GAsyncQueue on the #GstHarness sinkpad. The pull will timeout in 60 seconds. This is the standard way of getting a buffer from a harnessed #GstElement. @@ -1129,14 +1129,14 @@ MT safe. a #GstBuffer or %NULL if timed out. + line="1717">a #GstBuffer or %NULL if timed out. a #GstHarness + line="1709">a #GstHarness @@ -1146,7 +1146,7 @@ MT safe. version="1.6"> Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness sinkpad. + line="2041">Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness sinkpad. Timeouts after 60 seconds similar to gst_harness_pull. MT safe. @@ -1154,14 +1154,14 @@ MT safe. a #GstEvent or %NULL if timed out. + line="2050">a #GstEvent or %NULL if timed out. a #GstHarness + line="2043">a #GstHarness @@ -1171,21 +1171,21 @@ MT safe. version="1.18"> Pulls a #GstBuffer from the #GAsyncQueue on the #GstHarness sinkpad. The pull + line="1737">Pulls a #GstBuffer from the #GAsyncQueue on the #GstHarness sinkpad. The pull will block until an EOS event is received, or timeout in 60 seconds. MT safe. %TRUE on success, %FALSE on timeout. + line="1747">%TRUE on success, %FALSE on timeout. a #GstHarness + line="1739">a #GstHarness nullable="1"> A #GstBuffer, or %NULL if EOS or timeout occures + line="1740">A #GstBuffer, or %NULL if EOS or timeout occures first. @@ -1206,7 +1206,7 @@ MT safe. version="1.6"> Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness srcpad. + line="2144">Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness srcpad. Timeouts after 60 seconds similar to gst_harness_pull. MT safe. @@ -1214,14 +1214,14 @@ MT safe. a #GstEvent or %NULL if timed out. + line="2153">a #GstEvent or %NULL if timed out. a #GstHarness + line="2146">a #GstHarness @@ -1229,7 +1229,7 @@ MT safe. Pushes a #GstBuffer on the #GstHarness srcpad. The standard way of + line="1684">Pushes a #GstBuffer on the #GstHarness srcpad. The standard way of interacting with an harnessed element. MT safe. @@ -1237,20 +1237,20 @@ MT safe. a #GstFlowReturn with the result from the push + line="1694">a #GstFlowReturn with the result from the push a #GstHarness + line="1686">a #GstHarness a #GstBuffer to push + line="1687">a #GstBuffer to push @@ -1260,7 +1260,7 @@ MT safe. version="1.6"> Basically a gst_harness_push and a gst_harness_pull in one line. Reflects + line="1800">Basically a gst_harness_push and a gst_harness_pull in one line. Reflects the fact that you often want to do exactly this in your test: Push one buffer in, and inspect the outcome. @@ -1269,20 +1269,20 @@ MT safe. a #GstBuffer or %NULL if timed out. + line="1811">a #GstBuffer or %NULL if timed out. a #GstHarness + line="1802">a #GstHarness a #GstBuffer to push + line="1803">a #GstBuffer to push @@ -1292,27 +1292,27 @@ MT safe. version="1.6"> Pushes an #GstEvent on the #GstHarness srcpad. + line="2022">Pushes an #GstEvent on the #GstHarness srcpad. MT safe. a #gboolean with the result from the push + line="2031">a #gboolean with the result from the push a #GstHarness + line="2024">a #GstHarness a #GstEvent to push + line="2025">a #GstEvent to push @@ -1322,7 +1322,7 @@ MT safe. version="1.6"> Transfer data from the src-#GstHarness to the main-#GstHarness. It consists + line="2455">Transfer data from the src-#GstHarness to the main-#GstHarness. It consists of 4 steps: 1: Make sure the src is started. (see: gst_harness_play) 2: Crank the clock (see: gst_harness_crank_single_clock_wait) @@ -1334,14 +1334,14 @@ MT safe. a #GstFlowReturn with the result of the push + line="2468">a #GstFlowReturn with the result of the push a #GstHarness + line="2457">a #GstHarness @@ -1351,7 +1351,7 @@ MT safe. version="1.6"> Transfer one #GstBuffer from the main-#GstHarness to the sink-#GstHarness. + line="2658">Transfer one #GstBuffer from the main-#GstHarness to the sink-#GstHarness. See gst_harness_push_from_src for details. MT safe. @@ -1359,14 +1359,14 @@ MT safe. a #GstFlowReturn with the result of the push + line="2667">a #GstFlowReturn with the result of the push a #GstHarness + line="2660">a #GstHarness @@ -1376,27 +1376,27 @@ MT safe. version="1.6"> Pushes an #GstEvent on the #GstHarness sinkpad. + line="2122">Pushes an #GstEvent on the #GstHarness sinkpad. MT safe. a #gboolean with the result from the push + line="2131">a #gboolean with the result from the push a #GstHarness + line="2124">a #GstHarness a #GstEvent to push + line="2125">a #GstEvent to push @@ -1406,21 +1406,21 @@ MT safe. version="1.6"> Get the min latency reported by any harnessed #GstElement. + line="2225">Get the min latency reported by any harnessed #GstElement. MT safe. a #GstClockTime with min latency + line="2233">a #GstClockTime with min latency a #GstHarness + line="2227">a #GstHarness @@ -1431,7 +1431,7 @@ MT safe. introspectable="0"> A convenience function to allows you to call g_object_set on a #GstElement + line="2775">A convenience function to allows you to call g_object_set on a #GstElement that are residing inside the #GstHarness, by using normal g_object_set syntax. @@ -1444,25 +1444,25 @@ MT safe. a #GstHarness + line="2777">a #GstHarness a #gchar with a #GstElementFactory name + line="2778">a #gchar with a #GstElementFactory name a #gchar with the first property name + line="2779">a #gchar with the first property name value for the first property, followed optionally by more + line="2780">value for the first property, followed optionally by more name/value pairs, followed by %NULL @@ -1473,7 +1473,7 @@ MT safe. version="1.6"> Setting this will make the harness block in the chain-function, and + line="1574">Setting this will make the harness block in the chain-function, and then release when gst_harness_pull() or gst_harness_try_pull() is called. Can be useful when wanting to control a src-element that is not implementing gst_clock_id_wait() so it can't be controlled by the #GstTestClock, since @@ -1488,7 +1488,7 @@ MT safe. a #GstHarness + line="1576">a #GstHarness @@ -1498,7 +1498,7 @@ MT safe. version="1.6"> Sets the @GstHarness srcpad and sinkpad caps. + line="1314">Sets the @GstHarness srcpad and sinkpad caps. MT safe. @@ -1509,19 +1509,19 @@ MT safe. a #GstHarness + line="1316">a #GstHarness a #GstCaps to set on the harness srcpad + line="1317">a #GstCaps to set on the harness srcpad a #GstCaps to set on the harness sinkpad + line="1318">a #GstCaps to set on the harness sinkpad @@ -1531,7 +1531,7 @@ MT safe. version="1.6"> Sets the @GstHarness srcpad and sinkpad caps using strings. + line="1368">Sets the @GstHarness srcpad and sinkpad caps using strings. MT safe. @@ -1542,19 +1542,19 @@ MT safe. a #GstHarness + line="1370">a #GstHarness a @gchar describing a #GstCaps to set on the harness srcpad + line="1371">a @gchar describing a #GstCaps to set on the harness srcpad a @gchar describing a #GstCaps to set on the harness sinkpad + line="1372">a @gchar describing a #GstCaps to set on the harness sinkpad @@ -1564,7 +1564,7 @@ MT safe. version="1.6"> When set to %TRUE, instead of placing the buffers arriving from the harnessed + line="1862">When set to %TRUE, instead of placing the buffers arriving from the harnessed #GstElement inside the sinkpads #GAsyncQueue, they are instead unreffed. MT safe. @@ -1576,13 +1576,13 @@ MT safe. a #GstHarness + line="1864">a #GstHarness a #gboolean specifying to drop outgoing buffers or not + line="1865">a #gboolean specifying to drop outgoing buffers or not @@ -1592,7 +1592,7 @@ MT safe. version="1.6"> As a convenience, a src-harness will forward %GST_EVENT_STREAM_START, + line="1595">As a convenience, a src-harness will forward %GST_EVENT_STREAM_START, %GST_EVENT_CAPS and %GST_EVENT_SEGMENT to the main-harness if forwarding is enabled, and forward any sticky-events from the main-harness to the sink-harness. It will also forward the %GST_QUERY_ALLOCATION. @@ -1615,13 +1615,13 @@ MT safe. a #GstHarness + line="1597">a #GstHarness a #gboolean to enable/disable forwarding + line="1598">a #gboolean to enable/disable forwarding @@ -1631,7 +1631,7 @@ MT safe. version="1.20"> Sets the liveness reported by #GstHarness when receiving a latency-query. + line="2272">Sets the liveness reported by #GstHarness when receiving a latency-query. The default is %TRUE. @@ -1641,13 +1641,13 @@ The default is %TRUE. a #GstHarness + line="2274">a #GstHarness %TRUE for live, %FALSE for non-live + line="2275">%TRUE for live, %FALSE for non-live @@ -1657,7 +1657,7 @@ The default is %TRUE. version="1.6"> Sets the @allocator and @params to propose when receiving an allocation + line="2315">Sets the @allocator and @params to propose when receiving an allocation query. MT safe. @@ -1669,7 +1669,7 @@ MT safe. a #GstHarness + line="2317">a #GstHarness allow-none="1"> a #GstAllocator + line="2318">a #GstAllocator allow-none="1"> a #GstAllocationParams + line="2319">a #GstAllocationParams @@ -1698,7 +1698,7 @@ MT safe. version="1.6"> Sets the @GstHarness sinkpad caps. + line="1294">Sets the @GstHarness sinkpad caps. MT safe. @@ -1709,13 +1709,13 @@ MT safe. a #GstHarness + line="1296">a #GstHarness a #GstCaps to set on the harness sinkpad + line="1297">a #GstCaps to set on the harness sinkpad @@ -1725,7 +1725,7 @@ MT safe. version="1.6"> Sets the @GstHarness sinkpad caps using a string. + line="1351">Sets the @GstHarness sinkpad caps using a string. MT safe. @@ -1736,13 +1736,13 @@ MT safe. a #GstHarness + line="1353">a #GstHarness a @gchar describing a #GstCaps to set on the harness sinkpad + line="1354">a @gchar describing a #GstCaps to set on the harness sinkpad @@ -1752,7 +1752,7 @@ MT safe. version="1.6"> Sets the @GstHarness srcpad caps. This must be done before any buffers + line="1266">Sets the @GstHarness srcpad caps. This must be done before any buffers can legally be pushed from the harness to the element. MT safe. @@ -1764,13 +1764,13 @@ MT safe. a #GstHarness + line="1268">a #GstHarness a #GstCaps to set on the harness srcpad + line="1269">a #GstCaps to set on the harness srcpad @@ -1780,7 +1780,7 @@ MT safe. version="1.6"> Sets the @GstHarness srcpad caps using a string. This must be done before + line="1333">Sets the @GstHarness srcpad caps using a string. This must be done before any buffers can legally be pushed from the harness to the element. MT safe. @@ -1792,13 +1792,13 @@ MT safe. a #GstHarness + line="1335">a #GstHarness a @gchar describing a #GstCaps to set on the harness srcpad + line="1336">a @gchar describing a #GstCaps to set on the harness srcpad @@ -1808,27 +1808,27 @@ MT safe. version="1.6"> Advance the #GstTestClock to a specific time. + line="1442">Advance the #GstTestClock to a specific time. MT safe. a @gboolean %TRUE if the time could be set. %FALSE if not. + line="1451">a @gboolean %TRUE if the time could be set. %FALSE if not. a #GstHarness + line="1444">a #GstHarness a #GstClockTime to advance the clock to + line="1445">a #GstClockTime to advance the clock to @@ -1838,7 +1838,7 @@ MT safe. version="1.6"> Sets the min latency reported by #GstHarness when receiving a latency-query + line="2255">Sets the min latency reported by #GstHarness when receiving a latency-query @@ -1847,13 +1847,13 @@ MT safe. a #GstHarness + line="2257">a #GstHarness a #GstClockTime specifying the latency + line="2258">a #GstClockTime specifying the latency @@ -1863,7 +1863,7 @@ MT safe. version="1.6"> Convenience that calls gst_harness_push_to_sink @pushes number of times. + line="2681">Convenience that calls gst_harness_push_to_sink @pushes number of times. Will abort the pushing if any one push fails. MT safe. @@ -1871,20 +1871,20 @@ MT safe. a #GstFlowReturn with the result of the push + line="2691">a #GstFlowReturn with the result of the push a #GstHarness + line="2683">a #GstHarness a #gint with the number of calls to gst_harness_push_to_sink + line="2684">a #gint with the number of calls to gst_harness_push_to_sink @@ -1894,7 +1894,7 @@ MT safe. version="1.6"> Transfer data from the src-#GstHarness to the main-#GstHarness. Similar to + line="2494">Transfer data from the src-#GstHarness to the main-#GstHarness. Similar to gst_harness_push_from_src, this variant allows you to specify how many cranks and how many pushes to perform. This can be useful for both moving a lot of data at the same time, as well as cases when one crank does not equal one @@ -1905,26 +1905,26 @@ MT safe. a #GstFlowReturn with the result of the push + line="2508">a #GstFlowReturn with the result of the push a #GstHarness + line="2496">a #GstHarness a #gint with the number of calls to gst_harness_crank_single_clock_wait + line="2497">a #gint with the number of calls to gst_harness_crank_single_clock_wait a #gint with the number of calls to gst_harness_push + line="2498">a #gint with the number of calls to gst_harness_push @@ -1934,7 +1934,7 @@ MT safe. version="1.6"> Similar to what gst_harness_src_push does with #GstBuffers, this transfers + line="2539">Similar to what gst_harness_src_push does with #GstBuffers, this transfers a #GstEvent from the src-#GstHarness to the main-#GstHarness. Note that some #GstEvents are being transferred automagically. Look at sink_forward_pad for details. @@ -1944,14 +1944,14 @@ MT safe. a #gboolean with the result of the push + line="2550">a #gboolean with the result of the push a #GstHarness + line="2541">a #GstHarness @@ -1962,7 +1962,7 @@ MT safe. introspectable="0"> Start a custom stress-thread that will call your @callback for every + line="3228">Start a custom stress-thread that will call your @callback for every iteration allowing you to do something nasty. MT safe. @@ -1970,14 +1970,14 @@ MT safe. a #GstHarnessThread + line="3242">a #GstHarnessThread a #GstHarness + line="3230">a #GstHarness allow-none="1"> a #GFunc that is called initially and only once + line="3231">a #GFunc that is called initially and only once a #GFunc that is called as often as possible + line="3232">a #GFunc that is called as often as possible allow-none="1"> a #gpointer with custom data to pass to the @callback function + line="3233">a #gpointer with custom data to pass to the @callback function a #gulong specifying how long to sleep in (microseconds) for + line="3234">a #gulong specifying how long to sleep in (microseconds) for each call to the @callback @@ -2019,39 +2019,39 @@ each call to the @callback introspectable="0"> Call g_object_set with @name and @value in intervals of @sleep microseconds + line="3489">Call g_object_set with @name and @value in intervals of @sleep microseconds MT safe. a #GstHarnessThread + line="3501">a #GstHarnessThread a #GstHarness + line="3491">a #GstHarness a #gchar specifying a property name + line="3492">a #gchar specifying a property name a #GValue to set the property to + line="3493">a #GValue to set the property to a #gulong specifying how long to sleep in (microseconds) for + line="3494">a #gulong specifying how long to sleep in (microseconds) for each g_object_set with @name and @value @@ -2063,45 +2063,45 @@ each g_object_set with @name and @value introspectable="0"> Push a #GstBuffer in intervals of @sleep microseconds. + line="3301">Push a #GstBuffer in intervals of @sleep microseconds. MT safe. a #GstHarnessThread + line="3314">a #GstHarnessThread a #GstHarness + line="3303">a #GstHarness a #GstCaps for the #GstBuffer + line="3304">a #GstCaps for the #GstBuffer a #GstSegment + line="3305">a #GstSegment a #GstBuffer to push + line="3306">a #GstBuffer to push a #gulong specifying how long to sleep in (microseconds) for + line="3307">a #gulong specifying how long to sleep in (microseconds) for each call to gst_pad_push @@ -2113,33 +2113,33 @@ each call to gst_pad_push introspectable="0"> Push a #GstBuffer returned by @func in intervals of @sleep microseconds. + line="3327">Push a #GstBuffer returned by @func in intervals of @sleep microseconds. MT safe. a #GstHarnessThread + line="3343">a #GstHarnessThread a #GstHarness + line="3329">a #GstHarness a #GstCaps for the #GstBuffer + line="3330">a #GstCaps for the #GstBuffer a #GstSegment + line="3331">a #GstSegment destroy="4"> a #GstHarnessPrepareBufferFunc function called before every iteration + line="3332">a #GstHarnessPrepareBufferFunc function called before every iteration to prepare / create a #GstBuffer for pushing @@ -2160,19 +2160,19 @@ to prepare / create a #GstBuffer for pushing allow-none="1"> a #gpointer with data to the #GstHarnessPrepareBufferFunc function + line="3334">a #gpointer with data to the #GstHarnessPrepareBufferFunc function a #GDestroyNotify that is called when thread is stopped + line="3335">a #GDestroyNotify that is called when thread is stopped a #gulong specifying how long to sleep in (microseconds) for + line="3336">a #gulong specifying how long to sleep in (microseconds) for each call to gst_pad_push @@ -2184,7 +2184,7 @@ each call to gst_pad_push introspectable="0"> Push the @event onto the harnessed #GstElement sinkpad in intervals of + line="3367">Push the @event onto the harnessed #GstElement sinkpad in intervals of @sleep microseconds MT safe. @@ -2192,26 +2192,26 @@ MT safe. a #GstHarnessThread + line="3379">a #GstHarnessThread a #GstHarness + line="3369">a #GstHarness a #GstEvent to push + line="3370">a #GstEvent to push a #gulong specifying how long to sleep in (microseconds) for + line="3371">a #gulong specifying how long to sleep in (microseconds) for each gst_event_push with @event @@ -2223,7 +2223,7 @@ each gst_event_push with @event introspectable="0"> Push a #GstEvent returned by @func onto the harnessed #GstElement sinkpad + line="3392">Push a #GstEvent returned by @func onto the harnessed #GstElement sinkpad in intervals of @sleep microseconds. MT safe. @@ -2231,14 +2231,14 @@ MT safe. a #GstHarnessThread + line="3407">a #GstHarnessThread a #GstHarness + line="3394">a #GstHarness destroy="2"> a #GstHarnessPrepareEventFunc function called before every iteration + line="3395">a #GstHarnessPrepareEventFunc function called before every iteration to prepare / create a #GstEvent for pushing @@ -2259,19 +2259,19 @@ to prepare / create a #GstEvent for pushing allow-none="1"> a #gpointer with data to the #GstHarnessPrepareEventFunc function + line="3397">a #gpointer with data to the #GstHarnessPrepareEventFunc function a #GDestroyNotify that is called when thread is stopped + line="3398">a #GDestroyNotify that is called when thread is stopped a #gulong specifying how long to sleep in (microseconds) for + line="3399">a #gulong specifying how long to sleep in (microseconds) for each call to gst_pad_push @@ -2283,7 +2283,7 @@ each call to gst_pad_push introspectable="0"> Push the @event onto the harnessed #GstElement srcpad in intervals of + line="3428">Push the @event onto the harnessed #GstElement srcpad in intervals of @sleep microseconds. MT safe. @@ -2291,26 +2291,26 @@ MT safe. a #GstHarnessThread + line="3440">a #GstHarnessThread a #GstHarness + line="3430">a #GstHarness a #GstEvent to push + line="3431">a #GstEvent to push a #gulong specifying how long to sleep in (microseconds) for + line="3432">a #gulong specifying how long to sleep in (microseconds) for each gst_event_push with @event @@ -2322,7 +2322,7 @@ each gst_event_push with @event introspectable="0"> Push a #GstEvent returned by @func onto the harnessed #GstElement srcpad + line="3453">Push a #GstEvent returned by @func onto the harnessed #GstElement srcpad in intervals of @sleep microseconds. MT safe. @@ -2330,14 +2330,14 @@ MT safe. a #GstHarnessThread + line="3468">a #GstHarnessThread a #GstHarness + line="3455">a #GstHarness destroy="2"> a #GstHarnessPrepareEventFunc function called before every iteration + line="3456">a #GstHarnessPrepareEventFunc function called before every iteration to prepare / create a #GstEvent for pushing @@ -2358,19 +2358,19 @@ to prepare / create a #GstEvent for pushing allow-none="1"> a #gpointer with data to the #GstHarnessPrepareEventFunc function + line="3458">a #gpointer with data to the #GstHarnessPrepareEventFunc function a #GDestroyNotify that is called when thread is stopped + line="3459">a #GDestroyNotify that is called when thread is stopped a #gulong specifying how long to sleep in (microseconds) for + line="3460">a #gulong specifying how long to sleep in (microseconds) for each call to gst_pad_push @@ -2382,51 +2382,51 @@ each call to gst_pad_push introspectable="0"> Call gst_element_request_pad in intervals of @sleep microseconds + line="3521">Call gst_element_request_pad in intervals of @sleep microseconds MT safe. a #GstHarnessThread + line="3535">a #GstHarnessThread a #GstHarness + line="3523">a #GstHarness a #GstPadTemplate + line="3524">a #GstPadTemplate a #gchar + line="3525">a #gchar a #GstCaps + line="3526">a #GstCaps a #gboolean + line="3527">a #gboolean a #gulong specifying how long to sleep in (microseconds) for + line="3528">a #gulong specifying how long to sleep in (microseconds) for each gst_element_request_pad @@ -2438,7 +2438,7 @@ each gst_element_request_pad introspectable="0"> Change the state of your harnessed #GstElement from NULL to PLAYING and + line="3262">Change the state of your harnessed #GstElement from NULL to PLAYING and back again, only pausing for @sleep microseconds every time. MT safe. @@ -2446,20 +2446,20 @@ MT safe. a #GstHarnessThread + line="3273">a #GstHarnessThread a #GstHarness + line="3264">a #GstHarness a #gulong specifying how long to sleep in (microseconds) for + line="3265">a #gulong specifying how long to sleep in (microseconds) for each state-change @@ -2472,13 +2472,13 @@ each state-change introspectable="0"> Pulls all pending data from the harness and returns it as a single + line="1921">Pulls all pending data from the harness and returns it as a single data slice. a pointer to the data, newly allocated. Free + line="1929">a pointer to the data, newly allocated. Free with g_free() when no longer needed. Will return %NULL if there is no data. @@ -2487,7 +2487,7 @@ data slice. a #GstHarness + line="1923">a #GstHarness transfer-ownership="full"> the size of the data in bytes + line="1924">the size of the data in bytes @@ -2506,12 +2506,12 @@ data slice. version="1.14"> Pulls all pending data from the harness and returns it as a single buffer. + line="1881">Pulls all pending data from the harness and returns it as a single buffer. the data as a buffer. Unref with gst_buffer_unref() + line="1887">the data as a buffer. Unref with gst_buffer_unref() when no longer needed. @@ -2519,7 +2519,7 @@ data slice. a #GstHarness + line="1883">a #GstHarness @@ -2530,12 +2530,12 @@ data slice. version="1.14"> Pulls all pending data from the harness and returns it as a single #GBytes. + line="1950">Pulls all pending data from the harness and returns it as a single #GBytes. a pointer to the data, newly allocated. Free + line="1956">a pointer to the data, newly allocated. Free with g_free() when no longer needed. @@ -2543,7 +2543,7 @@ data slice. a #GstHarness + line="1952">a #GstHarness @@ -2553,7 +2553,7 @@ data slice. version="1.6"> Tears down a @GstHarness, freeing all resources allocated using it. + line="1090">Tears down a @GstHarness, freeing all resources allocated using it. MT safe. @@ -2564,7 +2564,7 @@ MT safe. a #GstHarness + line="1092">a #GstHarness @@ -2574,7 +2574,7 @@ MT safe. version="1.6"> Pulls a #GstBuffer from the #GAsyncQueue on the #GstHarness sinkpad. Unlike + line="1771">Pulls a #GstBuffer from the #GAsyncQueue on the #GstHarness sinkpad. Unlike gst_harness_pull this will not wait for any buffers if not any are present, and return %NULL straight away. @@ -2583,14 +2583,14 @@ MT safe. a #GstBuffer or %NULL if no buffers are present in the #GAsyncQueue + line="1781">a #GstBuffer or %NULL if no buffers are present in the #GAsyncQueue a #GstHarness + line="1773">a #GstHarness @@ -2600,7 +2600,7 @@ MT safe. version="1.6"> Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness sinkpad. + line="2062">Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness sinkpad. See gst_harness_try_pull for details. MT safe. @@ -2608,14 +2608,14 @@ MT safe. a #GstEvent or %NULL if no buffers are present in the #GAsyncQueue + line="2071">a #GstEvent or %NULL if no buffers are present in the #GAsyncQueue a #GstHarness + line="2064">a #GstHarness @@ -2625,7 +2625,7 @@ MT safe. version="1.6"> Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness srcpad. + line="2165">Pulls an #GstEvent from the #GAsyncQueue on the #GstHarness srcpad. See gst_harness_try_pull for details. MT safe. @@ -2633,14 +2633,14 @@ MT safe. a #GstEvent or %NULL if no buffers are present in the #GAsyncQueue + line="2174">a #GstEvent or %NULL if no buffers are present in the #GAsyncQueue a #GstHarness + line="2167">a #GstHarness @@ -2650,21 +2650,21 @@ MT safe. version="1.6"> The number of #GstEvents currently in the #GstHarness srcpad #GAsyncQueue + line="2206">The number of #GstEvents currently in the #GstHarness srcpad #GAsyncQueue MT safe. a #guint number of events in the queue + line="2214">a #guint number of events in the queue a #GstHarness + line="2208">a #GstHarness @@ -2674,7 +2674,7 @@ MT safe. version="1.6"> The total number of #GstEvents that has arrived on the #GstHarness srcpad + line="2185">The total number of #GstEvents that has arrived on the #GstHarness srcpad This number includes events handled by the harness as well as events that have already been pulled out. @@ -2683,14 +2683,14 @@ MT safe. a #guint number of events received + line="2195">a #guint number of events received a #GstHarness + line="2187">a #GstHarness @@ -2700,7 +2700,7 @@ MT safe. version="1.6"> Sets the system #GstClock on the @GstHarness #GstElement + line="1387">Sets the system #GstClock on the @GstHarness #GstElement MT safe. @@ -2711,7 +2711,7 @@ MT safe. a #GstHarness + line="1389">a #GstHarness @@ -2721,7 +2721,7 @@ MT safe. version="1.6"> Sets the #GstTestClock on the #GstHarness #GstElement + line="1406">Sets the #GstTestClock on the #GstHarness #GstElement MT safe. @@ -2732,7 +2732,7 @@ MT safe. a #GstHarness + line="1408">a #GstHarness @@ -2742,7 +2742,7 @@ MT safe. version="1.6"> Waits for @timeout seconds until @waits number of #GstClockID waits is + line="1462">Waits for @timeout seconds until @waits number of #GstClockID waits is registered with the #GstTestClock. Useful for writing deterministic tests, where you want to make sure that an expected number of waits have been reached. @@ -2752,7 +2752,7 @@ MT safe. a @gboolean %TRUE if the waits have been registered, %FALSE if not. + line="1476">a @gboolean %TRUE if the waits have been registered, %FALSE if not. (Could be that it timed out waiting or that more waits than waits was found) @@ -2760,20 +2760,20 @@ MT safe. a #GstHarness + line="1464">a #GstHarness a #guint describing the numbers of #GstClockID registered with + line="1465">a #guint describing the numbers of #GstClockID registered with the #GstTestClock a #guint describing how many seconds to wait for @waits to be true + line="1467">a #guint describing how many seconds to wait for @waits to be true @@ -2784,7 +2784,7 @@ the #GstTestClock introspectable="0"> Creates a new harness. Works like gst_harness_new_with_padnames(), except it + line="974">Creates a new harness. Works like gst_harness_new_with_padnames(), except it assumes the #GstElement sinkpad is named "sink" and srcpad is named "src" MT safe. @@ -2792,7 +2792,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="983">a #GstHarness, or %NULL if the harness could not be created @@ -2800,7 +2800,7 @@ not be created a #gchar describing the #GstElement name + line="976">a #gchar describing the #GstElement name @@ -2811,7 +2811,7 @@ not be created introspectable="0"> Creates a new empty harness. Use gst_harness_add_element_full() to add + line="703">Creates a new empty harness. Use gst_harness_add_element_full() to add an #GstElement to it. MT safe. @@ -2819,7 +2819,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="711">a #GstHarness, or %NULL if the harness could not be created @@ -2830,14 +2830,14 @@ not be created introspectable="0"> Creates a new harness. + line="844">Creates a new harness. MT safe. a #GstHarness, or %NULL if the harness could + line="863">a #GstHarness, or %NULL if the harness could not be created @@ -2845,7 +2845,7 @@ not be created a #GstElement to attach the harness to (transfer none) + line="846">a #GstElement to attach the harness to (transfer none) allow-none="1"> a #GstStaticPadTemplate describing the harness srcpad. + line="847">a #GstStaticPadTemplate describing the harness srcpad. %NULL will not create a harness srcpad. @@ -2864,7 +2864,7 @@ not be created allow-none="1"> a #gchar with the name of the element + line="849">a #gchar with the name of the element sinkpad that is then linked to the harness srcpad. Can be a static or request or a sometimes pad that has been added. %NULL will not get/request a sinkpad from the element. (Like if the element is a src.) @@ -2876,7 +2876,7 @@ from the element. (Like if the element is a src.) allow-none="1"> a #GstStaticPadTemplate describing the harness sinkpad. + line="853">a #GstStaticPadTemplate describing the harness sinkpad. %NULL will not create a harness sinkpad. @@ -2886,7 +2886,7 @@ from the element. (Like if the element is a src.) allow-none="1"> a #gchar with the name of the element + line="855">a #gchar with the name of the element srcpad that is then linked to the harness sinkpad, similar to the @element_sinkpad_name. @@ -2899,7 +2899,7 @@ srcpad that is then linked to the harness sinkpad, similar to the introspectable="0"> Creates a new harness, parsing the @launchline and putting that in a #GstBin, + line="1067">Creates a new harness, parsing the @launchline and putting that in a #GstBin, and then attches the harness to the bin. MT safe. @@ -2907,7 +2907,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="1076">a #GstHarness, or %NULL if the harness could not be created @@ -2915,7 +2915,7 @@ not be created a #gchar describing a gst-launch type line + line="1069">a #gchar describing a gst-launch type line @@ -2926,7 +2926,7 @@ not be created introspectable="0"> Creates a new harness. Works in the same way as gst_harness_new_full(), only + line="880">Creates a new harness. Works in the same way as gst_harness_new_full(), only that generic padtemplates are used for the harness src and sinkpads, which will be sufficient in most usecases. @@ -2935,7 +2935,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="896">a #GstHarness, or %NULL if the harness could not be created @@ -2943,7 +2943,7 @@ not be created a #GstElement to attach the harness to (transfer none) + line="882">a #GstElement to attach the harness to (transfer none) allow-none="1"> a #gchar with the name of the element + line="883">a #gchar with the name of the element sinkpad that is then linked to the harness srcpad. %NULL does not attach a sinkpad @@ -2963,7 +2963,7 @@ sinkpad allow-none="1"> a #gchar with the name of the element + line="886">a #gchar with the name of the element srcpad that is then linked to the harness sinkpad. %NULL does not attach a srcpad @@ -2976,7 +2976,7 @@ srcpad introspectable="0"> Creates a new harness. Works like gst_harness_new_with_element(), + line="909">Creates a new harness. Works like gst_harness_new_with_element(), except you specify the factoryname of the #GstElement MT safe. @@ -2984,7 +2984,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="924">a #GstHarness, or %NULL if the harness could not be created @@ -2992,7 +2992,7 @@ not be created a #gchar describing the #GstElement name + line="911">a #gchar describing the #GstElement name allow-none="1"> a #gchar with the name of the element + line="912">a #gchar with the name of the element sinkpad that is then linked to the harness srcpad. %NULL does not attach a sinkpad @@ -3012,7 +3012,7 @@ sinkpad allow-none="1"> a #gchar with the name of the element + line="915">a #gchar with the name of the element srcpad that is then linked to the harness sinkpad. %NULL does not attach a srcpad @@ -3025,7 +3025,7 @@ srcpad introspectable="0"> Creates a new harness, like gst_harness_new_full(), except it + line="943">Creates a new harness, like gst_harness_new_full(), except it assumes the #GstElement sinkpad is named "sink" and srcpad is named "src" MT safe. @@ -3033,7 +3033,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="956">a #GstHarness, or %NULL if the harness could not be created @@ -3041,7 +3041,7 @@ not be created a #gchar describing the #GstElement name + line="945">a #gchar describing the #GstElement name allow-none="1"> a #GstStaticPadTemplate describing the harness srcpad. + line="946">a #GstStaticPadTemplate describing the harness srcpad. %NULL will not create a harness srcpad. @@ -3060,7 +3060,7 @@ not be created allow-none="1"> a #GstStaticPadTemplate describing the harness sinkpad. + line="948">a #GstStaticPadTemplate describing the harness sinkpad. %NULL will not create a harness sinkpad. @@ -3071,7 +3071,7 @@ not be created version="1.6"> Stop the running #GstHarnessThread + line="3206">Stop the running #GstHarnessThread MT safe. @@ -3082,7 +3082,7 @@ MT safe. a #GstHarnessThread + line="3208">a #GstHarnessThread @@ -4039,7 +4039,7 @@ You must have previously called gst_buffer_straw_start_pipeline() on Verifies that reference values and current values are equals in @list. + line="1053">Verifies that reference values and current values are equals in @list. @@ -4048,13 +4048,13 @@ You must have previously called gst_buffer_straw_start_pipeline() on A list of GstCheckABIStruct to be verified + line="1055">A list of GstCheckABIStruct to be verified Whether there is a reference ABI size already specified, + line="1056">Whether there is a reference ABI size already specified, if it is %FALSE and the `GST_ABI` environment variable is set, usable code for @list will be printed. @@ -4128,7 +4128,7 @@ MT safe. Compare the buffer contents with @data and @size. + line="827">Compare the buffer contents with @data and @size. @@ -4137,7 +4137,7 @@ MT safe. buffer to compare + line="829">buffer to compare allow-none="1"> data to compare to + line="830">data to compare to size of data to compare + line="831">size of data to compare @@ -4160,7 +4160,7 @@ MT safe. Compare two caps with gst_caps_is_equal and fail unless they are + line="806">Compare two caps with gst_caps_is_equal and fail unless they are equal. @@ -4170,13 +4170,13 @@ equal. first caps to compare + line="808">first caps to compare second caps to compare + line="809">second caps to compare @@ -4184,7 +4184,7 @@ equal. A fake chain function that appends the buffer to the internal list of + line="484">A fake chain function that appends the buffer to the internal list of buffers. @@ -4218,7 +4218,7 @@ MT safe. Unref and remove all buffers that are in the global @buffers GList, + line="791">Unref and remove all buffers that are in the global @buffers GList, emptying the list. @@ -4229,7 +4229,7 @@ emptying the list. c:identifier="gst_check_element_push_buffer"> Create an element using the factory providing the @element_name and + line="1025">Create an element using the factory providing the @element_name and push the @buffer_in to this element. The element should create one buffer and this will be compared with @buffer_out. We only check the caps and the data of the buffers. This function unrefs the buffers. @@ -4241,31 +4241,31 @@ and the data of the buffers. This function unrefs the buffers. name of the element that needs to be created + line="1027">name of the element that needs to be created push this buffer to the element + line="1028">push this buffer to the element the #GstCaps expected of the sinkpad of the element + line="1029">the #GstCaps expected of the sinkpad of the element compare the result with this buffer + line="1030">compare the result with this buffer the #GstCaps expected of the srcpad of the element + line="1031">the #GstCaps expected of the srcpad of the element @@ -4274,7 +4274,7 @@ and the data of the buffers. This function unrefs the buffers. c:identifier="gst_check_element_push_buffer_list"> Create an element using the factory providing the @element_name and push the + line="875">Create an element using the factory providing the @element_name and push the buffers in @buffer_in to this element. The element should create the buffers equal to the buffers in @buffer_out. We only check the size and the data of the buffers. This function unrefs the buffers in the two lists. @@ -4290,13 +4290,13 @@ invalid buffer, when the final buffer is expected to fail, for example. name of the element that needs to be created + line="877">name of the element that needs to be created a list of buffers that needs to be + line="878">a list of buffers that needs to be pushed to the element @@ -4305,13 +4305,13 @@ invalid buffer, when the final buffer is expected to fail, for example. the #GstCaps expected of the sinkpad of the element + line="880">the #GstCaps expected of the sinkpad of the element a list of buffers that we expect from + line="881">a list of buffers that we expect from the element @@ -4320,13 +4320,13 @@ the element the #GstCaps expected of the srcpad of the element + line="883">the #GstCaps expected of the srcpad of the element the last buffer push needs to give this GstFlowReturn + line="884">the last buffer push needs to give this GstFlowReturn @@ -4371,7 +4371,7 @@ the element version="1.6"> Unrefs @object_to_unref and checks that is has properly been + line="1314">Unrefs @object_to_unref and checks that is has properly been destroyed. @@ -4384,7 +4384,7 @@ destroyed. allow-none="1"> The #GObject to unref + line="1316">The #GObject to unref @@ -4395,7 +4395,7 @@ destroyed. introspectable="0"> Unrefs @object_to_unref and checks that is has properly been + line="1255">Unrefs @object_to_unref and checks that is has properly been destroyed, also checks that the other objects passed in parameter have been destroyed as a concequence of unrefing @object_to_unref. Last variable argument should be NULL. @@ -4410,7 +4410,7 @@ unrefing @object_to_unref. Last variable argument should be NULL. allow-none="1"> The #GObject to unref + line="1257">The #GObject to unref allow-none="1"> The first object that should be destroyed as a + line="1258">The first object that should be destroyed as a concequence of unrefing @object_to_unref. Additional object that should have been destroyed. + line="1260">Additional object that should have been destroyed. @@ -4459,26 +4459,26 @@ MT safe. number of failed tests + line="1113">number of failed tests the check test suite + line="1109">the check test suite name + line="1110">name file name + line="1111">file name @@ -4487,19 +4487,19 @@ MT safe. c:identifier="gst_check_setup_element"> setup an element for a filter test with mysrcpad and mysinkpad + line="503">setup an element for a filter test with mysrcpad and mysinkpad a new element + line="509">a new element factory + line="505">factory @@ -4507,7 +4507,7 @@ MT safe. Push stream-start, caps and segment event, which consist of the minimum + line="1219">Push stream-start, caps and segment event, which consist of the minimum required events to allow streaming. Caps is optional to allow raw src testing. If @element has more than one src or sink pad, use gst_check_setup_events_with_stream_id() instead. @@ -4519,13 +4519,13 @@ gst_check_setup_events_with_stream_id() instead. The src #GstPad to push on + line="1221">The src #GstPad to push on The #GstElement use to create the stream id + line="1222">The #GstElement use to create the stream id allow-none="1"> #GstCaps in case caps event must be sent + line="1223">#GstCaps in case caps event must be sent The #GstFormat of the default segment to send + line="1224">The #GstFormat of the default segment to send @@ -4549,7 +4549,7 @@ gst_check_setup_events_with_stream_id() instead. c:identifier="gst_check_setup_events_with_stream_id"> Push stream-start, caps and segment event, which consist of the minimum + line="1192">Push stream-start, caps and segment event, which consist of the minimum required events to allow streaming. Caps is optional to allow raw src testing. @@ -4560,13 +4560,13 @@ testing. The src #GstPad to push on + line="1194">The src #GstPad to push on The #GstElement use to create the stream id + line="1195">The #GstElement use to create the stream id allow-none="1"> #GstCaps in case caps event must be sent + line="1196">#GstCaps in case caps event must be sent The #GstFormat of the default segment to send + line="1197">The #GstFormat of the default segment to send A unique identifier for the stream + line="1198">A unique identifier for the stream @@ -4596,25 +4596,25 @@ testing. c:identifier="gst_check_setup_sink_pad"> Does the same as #gst_check_setup_sink_pad_by_name with the <emphasis> name </emphasis> parameter equal to "src". + line="690">Does the same as #gst_check_setup_sink_pad_by_name with the <emphasis> name </emphasis> parameter equal to "src". a new pad that can be used to check the output of @element + line="697">a new pad that can be used to check the output of @element element to setup pad on + line="692">element to setup pad on pad template + line="693">pad template @@ -4623,33 +4623,33 @@ testing. c:identifier="gst_check_setup_sink_pad_by_name"> Creates a new sink pad (based on the given @tmpl) and links it to the given @element src pad + line="705">Creates a new sink pad (based on the given @tmpl) and links it to the given @element src pad (the pad that matches the given @name). You can set event/chain/query functions on this pad to check the output of the @element. a new pad that can be used to check the output of @element + line="715">a new pad that can be used to check the output of @element element to setup pad on + line="707">element to setup pad on pad template + line="708">pad template Name of the @element src pad that will be linked to the sink pad that will be setup + line="709">Name of the @element src pad that will be linked to the sink pad that will be setup @@ -4661,26 +4661,26 @@ You can set event/chain/query functions on this pad to check the output of the @ a new pad + line="754">a new pad element to setup pad on + line="750">element to setup pad on pad template + line="751">pad template name + line="752">name @@ -4692,20 +4692,20 @@ You can set event/chain/query functions on this pad to check the output of the @ a new pad + line="737">a new pad element to setup pad on + line="734">element to setup pad on pad template + line="735">pad template @@ -4714,25 +4714,25 @@ You can set event/chain/query functions on this pad to check the output of the @ c:identifier="gst_check_setup_src_pad"> Does the same as #gst_check_setup_src_pad_by_name with the <emphasis> name </emphasis> parameter equal to "sink". + line="535">Does the same as #gst_check_setup_src_pad_by_name with the <emphasis> name </emphasis> parameter equal to "sink". A new pad that can be used to inject data on @element + line="542">A new pad that can be used to inject data on @element element to setup pad on + line="537">element to setup pad on pad template + line="538">pad template @@ -4741,7 +4741,7 @@ You can set event/chain/query functions on this pad to check the output of the @ c:identifier="gst_check_setup_src_pad_by_name"> Creates a new src pad (based on the given @tmpl) and links it to the given @element sink pad (the pad that matches the given @name). + line="550">Creates a new src pad (based on the given @tmpl) and links it to the given @element sink pad (the pad that matches the given @name). Before using the src pad to push data on @element you need to call #gst_check_setup_events on the created src pad. Example of how to push a buffer on @element: @@ -4778,26 +4778,26 @@ For very simple input/output test scenarios checkout #gst_check_element_push_buf A new pad that can be used to inject data on @element + line="590">A new pad that can be used to inject data on @element element to setup src pad on + line="552">element to setup src pad on pad template + line="553">pad template Name of the @element sink pad that will be linked to the src pad that will be setup + line="554">Name of the @element sink pad that will be linked to the src pad that will be setup @@ -4809,26 +4809,26 @@ For very simple input/output test scenarios checkout #gst_check_element_push_buf a new pad + line="628">a new pad element to setup pad on + line="624">element to setup pad on pad template + line="625">pad template name + line="626">name @@ -4840,20 +4840,20 @@ For very simple input/output test scenarios checkout #gst_check_element_push_buf a new pad + line="611">a new pad element to setup pad on + line="608">element to setup pad on pad template + line="609">pad template @@ -5029,7 +5029,7 @@ inside the 'check' directories of various GStreamer packages. introspectable="0"> Creates a new harness. Works like gst_harness_new_with_padnames(), except it + line="974">Creates a new harness. Works like gst_harness_new_with_padnames(), except it assumes the #GstElement sinkpad is named "sink" and srcpad is named "src" MT safe. @@ -5037,7 +5037,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="983">a #GstHarness, or %NULL if the harness could not be created @@ -5045,7 +5045,7 @@ not be created a #gchar describing the #GstElement name + line="976">a #gchar describing the #GstElement name @@ -5057,7 +5057,7 @@ not be created introspectable="0"> Creates a new empty harness. Use gst_harness_add_element_full() to add + line="703">Creates a new empty harness. Use gst_harness_add_element_full() to add an #GstElement to it. MT safe. @@ -5065,7 +5065,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="711">a #GstHarness, or %NULL if the harness could not be created @@ -5077,14 +5077,14 @@ not be created introspectable="0"> Creates a new harness. + line="844">Creates a new harness. MT safe. a #GstHarness, or %NULL if the harness could + line="863">a #GstHarness, or %NULL if the harness could not be created @@ -5092,7 +5092,7 @@ not be created a #GstElement to attach the harness to (transfer none) + line="846">a #GstElement to attach the harness to (transfer none) allow-none="1"> a #GstStaticPadTemplate describing the harness srcpad. + line="847">a #GstStaticPadTemplate describing the harness srcpad. %NULL will not create a harness srcpad. @@ -5111,7 +5111,7 @@ not be created allow-none="1"> a #gchar with the name of the element + line="849">a #gchar with the name of the element sinkpad that is then linked to the harness srcpad. Can be a static or request or a sometimes pad that has been added. %NULL will not get/request a sinkpad from the element. (Like if the element is a src.) @@ -5123,7 +5123,7 @@ from the element. (Like if the element is a src.) allow-none="1"> a #GstStaticPadTemplate describing the harness sinkpad. + line="853">a #GstStaticPadTemplate describing the harness sinkpad. %NULL will not create a harness sinkpad. @@ -5133,7 +5133,7 @@ from the element. (Like if the element is a src.) allow-none="1"> a #gchar with the name of the element + line="855">a #gchar with the name of the element srcpad that is then linked to the harness sinkpad, similar to the @element_sinkpad_name. @@ -5147,7 +5147,7 @@ srcpad that is then linked to the harness sinkpad, similar to the introspectable="0"> Creates a new harness, parsing the @launchline and putting that in a #GstBin, + line="1067">Creates a new harness, parsing the @launchline and putting that in a #GstBin, and then attches the harness to the bin. MT safe. @@ -5155,7 +5155,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="1076">a #GstHarness, or %NULL if the harness could not be created @@ -5163,7 +5163,7 @@ not be created a #gchar describing a gst-launch type line + line="1069">a #gchar describing a gst-launch type line @@ -5175,7 +5175,7 @@ not be created introspectable="0"> Creates a new harness. Works in the same way as gst_harness_new_full(), only + line="880">Creates a new harness. Works in the same way as gst_harness_new_full(), only that generic padtemplates are used for the harness src and sinkpads, which will be sufficient in most usecases. @@ -5184,7 +5184,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="896">a #GstHarness, or %NULL if the harness could not be created @@ -5192,7 +5192,7 @@ not be created a #GstElement to attach the harness to (transfer none) + line="882">a #GstElement to attach the harness to (transfer none) allow-none="1"> a #gchar with the name of the element + line="883">a #gchar with the name of the element sinkpad that is then linked to the harness srcpad. %NULL does not attach a sinkpad @@ -5212,7 +5212,7 @@ sinkpad allow-none="1"> a #gchar with the name of the element + line="886">a #gchar with the name of the element srcpad that is then linked to the harness sinkpad. %NULL does not attach a srcpad @@ -5226,7 +5226,7 @@ srcpad introspectable="0"> Creates a new harness. Works like gst_harness_new_with_element(), + line="909">Creates a new harness. Works like gst_harness_new_with_element(), except you specify the factoryname of the #GstElement MT safe. @@ -5234,7 +5234,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="924">a #GstHarness, or %NULL if the harness could not be created @@ -5242,7 +5242,7 @@ not be created a #gchar describing the #GstElement name + line="911">a #gchar describing the #GstElement name allow-none="1"> a #gchar with the name of the element + line="912">a #gchar with the name of the element sinkpad that is then linked to the harness srcpad. %NULL does not attach a sinkpad @@ -5262,7 +5262,7 @@ sinkpad allow-none="1"> a #gchar with the name of the element + line="915">a #gchar with the name of the element srcpad that is then linked to the harness sinkpad. %NULL does not attach a srcpad @@ -5276,7 +5276,7 @@ srcpad introspectable="0"> Creates a new harness, like gst_harness_new_full(), except it + line="943">Creates a new harness, like gst_harness_new_full(), except it assumes the #GstElement sinkpad is named "sink" and srcpad is named "src" MT safe. @@ -5284,7 +5284,7 @@ MT safe. a #GstHarness, or %NULL if the harness could + line="956">a #GstHarness, or %NULL if the harness could not be created @@ -5292,7 +5292,7 @@ not be created a #gchar describing the #GstElement name + line="945">a #gchar describing the #GstElement name allow-none="1"> a #GstStaticPadTemplate describing the harness srcpad. + line="946">a #GstStaticPadTemplate describing the harness srcpad. %NULL will not create a harness srcpad. @@ -5311,7 +5311,7 @@ not be created allow-none="1"> a #GstStaticPadTemplate describing the harness sinkpad. + line="948">a #GstStaticPadTemplate describing the harness sinkpad. %NULL will not create a harness sinkpad. @@ -5448,7 +5448,7 @@ not be created version="1.6"> Stop the running #GstHarnessThread + line="3206">Stop the running #GstHarnessThread MT safe. @@ -5459,7 +5459,7 @@ MT safe. a #GstHarnessThread + line="3208">a #GstHarnessThread diff --git a/girs/GstCodecs-1.0.gir b/girs/GstCodecs-1.0.gir index ae2965227..8d270ab3b 100644 --- a/girs/GstCodecs-1.0.gir +++ b/girs/GstCodecs-1.0.gir @@ -155,7 +155,7 @@ preferred by subclass or not. filename="gst-libs/gst/codecs/gstav1decoder.h" line="84">Optional. Called whenever new #GstAV1Picture is created. Subclass can set implementation specific user data -on the #GstAV1Picture via gst_av1_picture_set_user_data() +on the #GstAV1Picture via gst_av1_picture_set_user_data @@ -545,7 +545,7 @@ decoding process for the #GstAV1Picture + line="157"/> @@ -554,9 +554,9 @@ decoding process for the #GstAV1Picture Store the @picture + line="112">Store the @picture + line="169"/> @@ -564,13 +564,13 @@ decoding process for the #GstAV1Picture a #GstAV1Dpb + line="114">a #GstAV1Dpb a #GstAV1Picture + line="115">a #GstAV1Picture @@ -578,9 +578,9 @@ decoding process for the #GstAV1Picture Clear all stored #GstAV1Picture + line="93">Clear all stored #GstAV1Picture + line="166"/> @@ -588,7 +588,7 @@ decoding process for the #GstAV1Picture a #GstAV1Dpb + line="95">a #GstAV1Dpb @@ -596,9 +596,9 @@ decoding process for the #GstAV1Picture Free the @dpb + line="76">Free the @dpb + line="163"/> @@ -606,7 +606,7 @@ decoding process for the #GstAV1Picture a #GstAV1Dpb to free + line="78">a #GstAV1Dpb to free @@ -617,13 +617,13 @@ decoding process for the #GstAV1Picture introspectable="0"> Create new #GstAV1Dpb + line="57">Create new #GstAV1Dpb + line="160"/> a new #GstAV1Dpb + line="62">a new #GstAV1Dpb @@ -635,12 +635,9 @@ decoding process for the #GstAV1Picture glib:get-type="gst_av1_picture_get_type" c:symbol-prefix="av1_picture"> + line="85"/> - - - - + @@ -663,100 +660,25 @@ decoding process for the #GstAV1Picture - - - - - - - - - Create new #GstAV1Picture + line="32">Create new #GstAV1Picture + line="91"/> a new #GstAV1Picture + line="37">a new #GstAV1Picture - - Gets private data set on the picture via -gst_av1_picture_set_user_data() previously. - - - The previously set user_data - - - - - a #GstAV1Picture - - - - - - Sets @user_data on the picture and the #GDestroyNotify that will be called when -the picture is freed. - -If a @user_data was previously set, then the previous set @notify will be called -before the @user_data is replaced. - - - - - - - a #GstAV1Picture - - - - private data - - - - a #GDestroyNotify - - - - + line="62"/> @@ -799,12 +721,184 @@ before the @user_data is replaced. version="1.20" introspectable="0"> + line="47"/> + + + + + + + + + Copy system_frame_number of @src to @dst + + + + a #GstCodecPicture + + + a #GstCodecPicture + + + + + Gets access to the system_frame_number field of @picture + + + + a #GstCodecPicture + + + + + Base struct for coded picture representation + + + + + + + + + + + + + + + + + + + + + + + Gets private data set on the picture via +gst_codec_picture_set_user_data() previously. + + + The previously set user_data + + + + + a #GstCodecPicture + + + + + + Sets @discont_state to @picture + + + + + + + a #GstCodecPicture + + + + a #GstVideoCodecState + + + + + + Sets @user_data on the picture and the #GDestroyNotify that will be called when +the picture is freed. + +If a @user_data was previously set, then the previous set @notify will be called +before the @user_data is replaced. + + + + + + + a #GstCodecPicture + + + + private data + + + + a #GDestroyNotify + + + + + filename="gst-libs/gst/codecs/gsth264decoder.h" line="141">Called when a new field picture is created for interlaced field picture. Subclass can attach implementation specific user data on @second_field via -gst_h264_picture_set_user_data() +gst_h264_picture_set_user_data @@ -964,7 +1058,7 @@ gst_h264_picture_set_user_data() filename="gst-libs/gst/codecs/gsth264decoder.h" line="127">Optional. Called whenever new #GstH264Picture is created. Subclass can set implementation specific user data -on the #GstH264Picture via gst_h264_picture_set_user_data() +on the #GstH264Picture via gst_h264_picture_set_user_data @@ -1097,27 +1191,27 @@ decoding process for the #GstH264Picture version="1.18"> Retrive DPB and return a #GstH264Picture corresponding to + line="3329">Retrive DPB and return a #GstH264Picture corresponding to the @system_frame_number a #GstH264Picture if successful, or %NULL otherwise + line="3337">a #GstH264Picture if successful, or %NULL otherwise a #GstH264Decoder + line="3331">a #GstH264Decoder a target system frame number of #GstH264Picture + line="3332">a target system frame number of #GstH264Picture @@ -1127,7 +1221,7 @@ the @system_frame_number version="1.18"> Called to en/disable reference picture modification process. + line="3313">Called to en/disable reference picture modification process. @@ -1137,13 +1231,13 @@ the @system_frame_number a #GstH264Decoder + line="3315">a #GstH264Decoder whether subclass is requiring reference picture modification process + line="3316">whether subclass is requiring reference picture modification process @@ -1156,7 +1250,7 @@ the @system_frame_number default-value="GST_H264_DECODER_COMPLIANCE_AUTO"> The compliance controls the behavior of the decoder to handle some + line="330">The compliance controls the behavior of the decoder to handle some subtle cases and contexts, such as the low-latency DPB bumping or mapping the baseline profile as the constrained-baseline profile, etc. @@ -1516,13 +1610,13 @@ etc. + line="241"/> Store the @picture + line="248">Store the @picture + line="274"/> @@ -1530,13 +1624,13 @@ etc. a #GstH264Dpb + line="250">a #GstH264Dpb a #GstH264Picture + line="251">a #GstH264Picture @@ -1544,15 +1638,15 @@ etc. Perform bumping process as defined in C.4.5.3 "Bumping" process. + line="858">Perform bumping process as defined in C.4.5.3 "Bumping" process. If @drain is %TRUE, @dpb will remove a #GstH264Picture from internal array so that returned #GstH264Picture could hold the last reference of it + line="327"/> a #GstH264Picture which is needed to be + line="867">a #GstH264Picture which is needed to be outputted @@ -1560,13 +1654,13 @@ outputted a #GstH265Dpb + line="860">a #GstH265Dpb whether draining or not + line="861">whether draining or not @@ -1574,9 +1668,9 @@ outputted Clear all stored #GstH264Picture + line="199">Clear all stored #GstH264Picture + line="271"/> @@ -1584,7 +1678,7 @@ outputted a #GstH264Dpb + line="201">a #GstH264Dpb @@ -1592,9 +1686,9 @@ outputted Delete already outputted and not referenced all pictures from dpb + line="299">Delete already outputted and not referenced all pictures from dpb + line="278"/> @@ -1602,7 +1696,7 @@ outputted a #GstH264Dpb + line="301">a #GstH264Dpb @@ -1610,9 +1704,9 @@ outputted Free the @dpb + line="183">Free the @dpb + line="268"/> @@ -1620,7 +1714,7 @@ outputted a #GstH264Dpb to free + line="185">a #GstH264Dpb to free @@ -1629,18 +1723,18 @@ outputted c:identifier="gst_h264_dpb_get_interlaced" version="1.20"> + line="265"/> %TRUE if @dpb is configured for interlaced stream + line="155">%TRUE if @dpb is configured for interlaced stream a #GstH264Dpb + line="153">a #GstH264Dpb @@ -1650,26 +1744,26 @@ outputted version="1.20"> Find a long term reference picture which has matching long term picture number + line="410">Find a long term reference picture which has matching long term picture number + line="291"/> a #GstH264Picture + line="417">a #GstH264Picture a #GstH264Dpb + line="412">a #GstH264Dpb a long term picture number + line="413">a long term picture number @@ -1678,20 +1772,20 @@ outputted c:identifier="gst_h264_dpb_get_lowest_frame_num_short_ref"> Find a short term reference picture which has the lowest frame_num_wrap + line="443">Find a short term reference picture which has the lowest frame_num_wrap + line="295"/> a #GstH264Picture + line="449">a #GstH264Picture a #GstH264Dpb + line="445">a #GstH264Dpb @@ -1700,18 +1794,18 @@ outputted c:identifier="gst_h264_dpb_get_max_num_frames" version="1.20"> + line="251"/> the number of maximum frames + line="124">the number of maximum frames a #GstH264Dpb + line="122">a #GstH264Dpb @@ -1720,18 +1814,18 @@ outputted c:identifier="gst_h264_dpb_get_max_num_reorder_frames" version="1.22.2"> + line="262"/> Maximum number of reorder frames + line="236">Maximum number of reorder frames a #GstH264Dpb + line="234">a #GstH264Dpb @@ -1740,11 +1834,11 @@ outputted c:identifier="gst_h264_dpb_get_picture" version="1.18"> + line="312"/> the picture identified with the specified + line="581">the picture identified with the specified @system_frame_number, or %NULL if DPB does not contain a #GstH264Picture corresponding to the @system_frame_number @@ -1753,7 +1847,7 @@ corresponding to the @system_frame_number a #GstH264Dpb + line="578">a #GstH264Dpb @system_frame_number The system frame number @@ -1765,11 +1859,11 @@ corresponding to the @system_frame_number + line="309"/> a #GArray of + line="551">a #GArray of #GstH264Picture stored in @dpb @@ -1779,7 +1873,7 @@ corresponding to the @system_frame_number a #GstH264Dpb + line="549">a #GstH264Dpb @@ -1789,10 +1883,10 @@ corresponding to the @system_frame_number version="1.20"> Retrieve all long-term reference pictures from @dpb. The picture will be + line="512">Retrieve all long-term reference pictures from @dpb. The picture will be appended to the array. + line="304"/> @@ -1800,13 +1894,13 @@ appended to the array. a #GstH264Dpb + line="514">a #GstH264Dpb %TRUE if the second field pictures need to be included + line="515">%TRUE if the second field pictures need to be included transfer-ownership="full"> an array + line="516">an array of #GstH264Picture pointer @@ -1828,10 +1922,10 @@ appended to the array. version="1.20"> Retrieve all short-term reference pictures from @dpb. The picture will be + line="474">Retrieve all short-term reference pictures from @dpb. The picture will be appended to the array. + line="298"/> @@ -1839,19 +1933,19 @@ appended to the array. a #GstH264Dpb + line="476">a #GstH264Dpb %TRUE if non-existing pictures need to be included + line="477">%TRUE if non-existing pictures need to be included %TRUE if the second field pictures need to be included + line="478">%TRUE if the second field pictures need to be included transfer-ownership="full"> an array + line="479">an array of #GstH264Picture pointers @@ -1872,44 +1966,44 @@ appended to the array. c:identifier="gst_h264_dpb_get_short_ref_by_pic_num"> Find a short term reference picture which has matching picture number + line="380">Find a short term reference picture which has matching picture number + line="287"/> a #GstH264Picture + line="387">a #GstH264Picture a #GstH264Dpb + line="382">a #GstH264Dpb a picture number + line="383">a picture number + line="316"/> the length of stored dpb array + line="566">the length of stored dpb array a #GstH264Dpb + line="564">a #GstH264Dpb @@ -1918,18 +2012,18 @@ appended to the array. c:identifier="gst_h264_dpb_has_empty_frame_buffer" version="1.20"> + line="319"/> %TRUE if @dpb still has empty frame buffers. + line="611">%TRUE if @dpb still has empty frame buffers. a #GstH264Dpb + line="609">a #GstH264Dpb @@ -1938,9 +2032,9 @@ appended to the array. c:identifier="gst_h264_dpb_mark_all_non_ref"> Mark all pictures are not referenced + line="359">Mark all pictures are not referenced + line="284"/> @@ -1948,7 +2042,7 @@ appended to the array. a #GstH264Dpb + line="361">a #GstH264Dpb @@ -1957,30 +2051,30 @@ appended to the array. c:identifier="gst_h264_dpb_needs_bump" version="1.20"> + line="322"/> %TRUE if bumping is required + line="688">%TRUE if bumping is required a #GstH264Dpb + line="684">a #GstH264Dpb the current #GstH264Picture to insert to dpb. + line="685">the current #GstH264Picture to insert to dpb. The required #GstH264DpbBumpMode for bumping. + line="686">The required #GstH264DpbBumpMode for bumping. @@ -1989,18 +2083,18 @@ appended to the array. c:identifier="gst_h264_dpb_num_ref_frames" version="1.20"> + line="281"/> The number of referenced frames + line="332">The number of referenced frames a #GstH264Dpb + line="330">a #GstH264Dpb @@ -2011,32 +2105,32 @@ appended to the array. introspectable="0"> Perform "8.2.5.4 Adaptive memory control decoded reference picture marking process" + line="969">Perform "8.2.5.4 Adaptive memory control decoded reference picture marking process" + line="335"/> %TRUE if successful + line="977">%TRUE if successful a #GstH265Dpb + line="971">a #GstH265Dpb a #GstH264RefPicMarking + line="972">a #GstH264RefPicMarking a #GstH264Picture + line="973">a #GstH264Picture @@ -2045,7 +2139,7 @@ appended to the array. c:identifier="gst_h264_dpb_set_interlaced" version="1.20"> + line="254"/> @@ -2053,13 +2147,13 @@ appended to the array. a #GstH264Dpb + line="138">a #GstH264Dpb %TRUE if interlaced + line="139">%TRUE if interlaced @@ -2069,10 +2163,10 @@ appended to the array. version="1.20"> Notify the DPB that @picture is output directly without storing + line="942">Notify the DPB that @picture is output directly without storing in the DPB. + line="331"/> @@ -2080,13 +2174,13 @@ in the DPB. a #GstH264Dpb + line="944">a #GstH264Dpb a #GstH264Picture of the last output. + line="945">a #GstH264Picture of the last output. @@ -2096,9 +2190,9 @@ in the DPB. version="1.20"> Set the number of maximum allowed frames to store + line="103">Set the number of maximum allowed frames to store + line="247"/> @@ -2106,13 +2200,13 @@ in the DPB. a #GstH264Dpb + line="105">a #GstH264Dpb the maximum number of picture + line="106">the maximum number of picture @@ -2121,7 +2215,7 @@ in the DPB. c:identifier="gst_h264_dpb_set_max_num_reorder_frames" version="1.20"> + line="258"/> @@ -2129,13 +2223,13 @@ in the DPB. a #GstH264Dpb + line="216">a #GstH264Dpb the max number of reorder frames, which + line="217">the max number of reorder frames, which should not exceed the max size of DPB. @@ -2144,13 +2238,13 @@ should not exceed the max size of DPB. Create new #GstH264Dpb + line="79">Create new #GstH264Dpb + line="244"/> a new #GstH264Dpb + line="84">a new #GstH264Dpb @@ -2159,27 +2253,27 @@ should not exceed the max size of DPB. version="1.20" c:type="GstH264DpbBumpMode"> + line="179"/> No latency requirement for DBP bumping. + line="168">No latency requirement for DBP bumping. Low-latency requirement for DBP bumping. + line="169">Low-latency requirement for DBP bumping. Very low-latency requirement for DBP bumping. + line="170">Very low-latency requirement for DBP bumping. glib:get-type="gst_h264_picture_get_type" c:symbol-prefix="h264_picture"> + line="164"/> - + - - - @@ -2291,130 +2382,23 @@ should not exceed the max size of DPB. - - - - - - - - - Create new #GstH264Picture + line="34">Create new #GstH264Picture + line="185"/> a new #GstH264Picture + line="39">a new #GstH264Picture - - Gets private data set on the picture via -gst_h264_picture_set_user_data() previously. - - - The previously set user_data - - - - - a #GstH264Picture - - - - - - Update reference picture type of @picture with @reference - - - - - - - a #GstH264Picture - - - - a GstH264PictureReference - - - - %TRUE if @reference needs to be applied to the -other field if any - - - - - - Sets @user_data on the picture and the #GDestroyNotify that will be called when -the picture is freed. - -If a @user_data was previously set, then the previous set @notify will be called -before the @user_data is replaced. - - - - - - - a #GstH264Picture - - - - private data - - - - a #GDestroyNotify - - - - + line="98"/> @@ -2432,30 +2416,30 @@ before the @user_data is replaced. version="1.20" c:type="GstH264PictureReference"> + line="113"/> Not used for reference picture + line="102">Not used for reference picture Used for short-term reference picture + line="103">Used for short-term reference picture Used for long-term reference picture + line="104">Used for long-term reference picture + line="91"/> @@ -2507,14 +2491,14 @@ before the @user_data is replaced. value="16" c:type="GST_H264_DPB_MAX_SIZE"> + line="39"/> + line="32"/> @@ -2524,7 +2508,7 @@ before the @user_data is replaced. c:identifier="GST_H264_PICTURE_CAST" introspectable="0"> + line="33"/> @@ -2536,14 +2520,14 @@ before the @user_data is replaced. introspectable="0"> Check whether @picture is a frame (not a field picture) + line="74">Check whether @picture is a frame (not a field picture) + line="82"/> a #GstH264Picture + line="76">a #GstH264Picture @@ -2553,14 +2537,14 @@ before the @user_data is replaced. introspectable="0"> Check whether @picture is used for long-term reference + line="63">Check whether @picture is used for long-term reference + line="71"/> a #GstH264Picture + line="65">a #GstH264Picture @@ -2570,14 +2554,14 @@ before the @user_data is replaced. introspectable="0"> Check whether @picture is used for short-term or long-term reference + line="41">Check whether @picture is used for short-term or long-term reference + line="49"/> a #GstH264Picture + line="43">a #GstH264Picture @@ -2587,14 +2571,14 @@ before the @user_data is replaced. introspectable="0"> Check whether @picture is used for short-term reference + line="52">Check whether @picture is used for short-term reference + line="60"/> a #GstH264Picture + line="54">a #GstH264Picture @@ -2720,7 +2704,7 @@ preferred by subclass or not. filename="gst-libs/gst/codecs/gsth265decoder.h" line="96">Optional. Called whenever new #GstH265Picture is created. Subclass can set implementation specific user data -on the #GstH265Picture via gst_h265_picture_set_user_data() +on the #GstH265Picture via gst_h265_picture_set_user_data @@ -2840,27 +2824,27 @@ decoding process for the #GstH265Picture version="1.20"> Retrive DPB and return a #GstH265Picture corresponding to + line="2167">Retrive DPB and return a #GstH265Picture corresponding to the @system_frame_number a #GstH265Picture if successful, or %NULL otherwise + line="2175">a #GstH265Picture if successful, or %NULL otherwise a #GstH265Decoder + line="2169">a #GstH265Decoder a target system frame number of #GstH265Picture + line="2170">a target system frame number of #GstH265Picture @@ -2870,7 +2854,7 @@ the @system_frame_number version="1.20"> Called to en/disable reference picture modification process. + line="2151">Called to en/disable reference picture modification process. @@ -2880,13 +2864,13 @@ the @system_frame_number a #GstH265Decoder + line="2153">a #GstH265Decoder whether subclass is requiring reference picture modification process + line="2154">whether subclass is requiring reference picture modification process @@ -3187,14 +3171,14 @@ the @system_frame_number + line="152"/> Store the @picture and perform increase pic_latency_cnt as defined in + line="149">Store the @picture and perform increase pic_latency_cnt as defined in "C.5.2.3 Additional bumping" process + line="171"/> @@ -3202,13 +3186,13 @@ the @system_frame_number a #GstH265Dpb + line="151">a #GstH265Dpb a #GstH265Picture + line="152">a #GstH265Picture @@ -3216,15 +3200,15 @@ the @system_frame_number Perform bumping process as defined in C.5.2.4 "Bumping" process. + line="542">Perform bumping process as defined in C.5.2.4 "Bumping" process. If @drain is %TRUE, @dpb will remove a #GstH265Picture from internal array so that returned #GstH265Picture could hold the last reference of it + line="216"/> a #GstH265Picture which is needed to be + line="551">a #GstH265Picture which is needed to be outputted @@ -3232,13 +3216,13 @@ outputted a #GstH265Dpb + line="544">a #GstH265Dpb whether draining or not + line="545">whether draining or not @@ -3246,9 +3230,9 @@ outputted Clear all stored #GstH265Picture + line="134">Clear all stored #GstH265Picture + line="168"/> @@ -3256,7 +3240,7 @@ outputted a #GstH265Dpb + line="136">a #GstH265Dpb @@ -3264,9 +3248,9 @@ outputted Delete not needed for output and not referenced all pictures from dpb + line="187">Delete not needed for output and not referenced all pictures from dpb + line="175"/> @@ -3274,7 +3258,7 @@ outputted a #GstH265Dpb + line="189">a #GstH265Dpb @@ -3282,9 +3266,9 @@ outputted Free the @dpb + line="118">Free the @dpb + line="165"/> @@ -3292,7 +3276,7 @@ outputted a #GstH265Dpb to free + line="120">a #GstH265Dpb to free @@ -3301,26 +3285,26 @@ outputted c:identifier="gst_h265_dpb_get_long_ref_by_poc"> Find a long term reference picture which has matching poc + line="346">Find a long term reference picture which has matching poc + line="196"/> a #GstH265Picture + line="353">a #GstH265Picture a #GstH265Dpb + line="348">a #GstH265Dpb a picture order count + line="349">a picture order count @@ -3328,18 +3312,18 @@ outputted + line="162"/> the number of maximum pictures + line="108">the number of maximum pictures a #GstH265Dpb + line="106">a #GstH265Dpb @@ -3348,11 +3332,11 @@ outputted c:identifier="gst_h265_dpb_get_picture" version="1.20"> + line="203"/> the picture identified with the specified + line="409">the picture identified with the specified @system_frame_number, or %NULL if DPB does not contain a #GstH265Picture corresponding to the @system_frame_number @@ -3361,7 +3345,7 @@ corresponding to the @system_frame_number a #GstH265Dpb + line="406">a #GstH265Dpb @system_frame_number The system frame number @@ -3373,11 +3357,11 @@ corresponding to the @system_frame_number + line="200"/> a #GArray of + line="379">a #GArray of #GstH265Picture stored in @dpb @@ -3387,7 +3371,7 @@ corresponding to the @system_frame_number a #GstH265Dpb + line="377">a #GstH265Dpb @@ -3395,26 +3379,26 @@ corresponding to the @system_frame_number Find a short or long term reference picture which has matching poc + line="259">Find a short or long term reference picture which has matching poc + line="184"/> a #GstH265Picture + line="266">a #GstH265Picture a #GstH265Dpb + line="261">a #GstH265Dpb a picture order count + line="262">a picture order count @@ -3423,26 +3407,26 @@ corresponding to the @system_frame_number c:identifier="gst_h265_dpb_get_ref_by_poc_lsb"> Find a short or long term reference picture which has matching poc_lsb + line="288">Find a short or long term reference picture which has matching poc_lsb + line="188"/> a #GstH265Picture + line="295">a #GstH265Picture a #GstH265Dpb + line="290">a #GstH265Dpb a picture order count lsb + line="291">a picture order count lsb @@ -3451,44 +3435,44 @@ corresponding to the @system_frame_number c:identifier="gst_h265_dpb_get_short_ref_by_poc"> Find a short term reference picture which has matching poc + line="317">Find a short term reference picture which has matching poc + line="192"/> a #GstH265Picture + line="324">a #GstH265Picture a #GstH265Dpb + line="319">a #GstH265Dpb a picture order count + line="320">a picture order count + line="207"/> the length of stored dpb array + line="394">the length of stored dpb array a #GstH265Dpb + line="392">a #GstH265Dpb @@ -3497,9 +3481,9 @@ corresponding to the @system_frame_number c:identifier="gst_h265_dpb_mark_all_non_ref"> Mark all pictures are not referenced + line="238">Mark all pictures are not referenced + line="181"/> @@ -3507,7 +3491,7 @@ corresponding to the @system_frame_number a #GstH265Dpb + line="240">a #GstH265Dpb @@ -3516,36 +3500,36 @@ corresponding to the @system_frame_number c:identifier="gst_h265_dpb_needs_bump" version="1.20"> + line="210"/> %TRUE if bumping is required + line="462">%TRUE if bumping is required a #GstH265Dpb + line="456">a #GstH265Dpb sps_max_num_reorder_pics[HighestTid] + line="457">sps_max_num_reorder_pics[HighestTid] SpsMaxLatencyPictures[HighestTid] + line="458">SpsMaxLatencyPictures[HighestTid] sps_max_dec_pic_buffering_minus1[HighestTid ] + 1 + line="459">sps_max_dec_pic_buffering_minus1[HighestTid ] + 1 or zero if this shouldn't be used for bumping decision @@ -3554,18 +3538,18 @@ corresponding to the @system_frame_number + line="178"/> The number of referenced pictures + line="217">The number of referenced pictures a #GstH265Dpb + line="215">a #GstH265Dpb @@ -3574,9 +3558,9 @@ corresponding to the @system_frame_number c:identifier="gst_h265_dpb_set_max_num_pics"> Set the number of maximum allowed pictures to store + line="89">Set the number of maximum allowed pictures to store + line="158"/> @@ -3584,13 +3568,13 @@ corresponding to the @system_frame_number a #GstH265Dpb + line="91">a #GstH265Dpb the maximum number of picture + line="92">the maximum number of picture @@ -3598,13 +3582,13 @@ corresponding to the @system_frame_number Create new #GstH265Dpb + line="66">Create new #GstH265Dpb + line="155"/> a new #GstH265Dpb + line="71">a new #GstH265Dpb @@ -3615,16 +3599,13 @@ corresponding to the @system_frame_number glib:get-type="gst_h265_picture_get_type" c:symbol-prefix="h265_picture"> + line="90"/> - + - - - @@ -3672,97 +3653,24 @@ corresponding to the @system_frame_number - - - - - - - - - - - - Create new #GstH265Picture - - - a new #GstH265Picture - - - - - Gets private data set on the picture via -gst_h265_picture_set_user_data() previously. - - - The previously set user_data - - - - - a #GstH265Picture - - - - - - Sets @user_data on the picture and the #GDestroyNotify that will be called when -the picture is freed. - -If a @user_data was previously set, then the previous set @notify will be called -before the @user_data is replaced. - - - - - - - a #GstH265Picture - - - - private data - - - - a #GDestroyNotify - - - - + + + Create new #GstH265Picture + + + a new #GstH265Picture + + + + line="59"/> @@ -3829,14 +3737,14 @@ before the @user_data is replaced. value="16" c:type="GST_H265_DPB_MAX_SIZE"> + line="44"/> + line="38"/> @@ -3846,7 +3754,7 @@ before the @user_data is replaced. c:identifier="GST_H265_PICTURE_CAST" introspectable="0"> + line="39"/> @@ -3877,7 +3785,7 @@ before the @user_data is replaced. version="1.20" introspectable="0"> + line="41"/> @@ -3907,7 +3815,7 @@ before the @user_data is replaced. c:identifier="GST_IS_H264_PICTURE" introspectable="0"> + line="31"/> @@ -3937,7 +3845,7 @@ before the @user_data is replaced. c:identifier="GST_IS_H265_PICTURE" introspectable="0"> + line="37"/> @@ -3968,7 +3876,7 @@ before the @user_data is replaced. version="1.20" introspectable="0"> + line="42"/> @@ -3998,7 +3906,7 @@ before the @user_data is replaced. c:identifier="GST_IS_VP8_PICTURE" introspectable="0"> + line="31"/> @@ -4028,7 +3936,7 @@ before the @user_data is replaced. c:identifier="GST_IS_VP9_PICTURE" introspectable="0"> + line="31"/> @@ -4069,7 +3977,7 @@ before the @user_data is replaced. version="1.20" introspectable="0"> + line="48"/> @@ -4081,14 +3989,14 @@ before the @user_data is replaced. introspectable="0"> Check whether @picture's type is I or P + line="97">Check whether @picture's type is I or P + line="105"/> a #GstMpeg2Picture + line="99">a #GstMpeg2Picture @@ -4195,7 +4103,7 @@ preferred by subclass or not. filename="gst-libs/gst/codecs/gstmpeg2decoder.h" line="106">Called when a new field picture is created for interlaced field picture. Subclass can attach implementation specific user data on @second_field via -gst_mpeg2_picture_set_user_data() +gst_mpeg2_picture_set_user_data @@ -4227,7 +4135,7 @@ gst_mpeg2_picture_set_user_data() filename="gst-libs/gst/codecs/gstmpeg2decoder.h" line="90">Optional. Called whenever new #GstMpeg2Picture is created. Subclass can set implementation specific user data -on the #GstMpeg2Picture via gst_mpeg2_picture_set_user_data() +on the #GstMpeg2Picture via gst_mpeg2_picture_set_user_data @@ -4665,13 +4573,13 @@ decoding process for the #GstMpeg2Picture opaque="1" version="1.20"> + line="171"/> Store the @picture + line="164">Store the @picture + line="183"/> @@ -4679,24 +4587,24 @@ decoding process for the #GstMpeg2Picture a #GstMpeg2Dpb + line="166">a #GstMpeg2Dpb a #GstMpeg2Picture + line="167">a #GstMpeg2Picture + line="186"/> a #GstMpeg2Picture which is needed to be + line="214">a #GstMpeg2Picture which is needed to be outputted @@ -4704,7 +4612,7 @@ outputted a #GstMpeg2Dpb + line="212">a #GstMpeg2Dpb @@ -4712,9 +4620,9 @@ outputted Clear all stored #GstMpeg2Picture + line="119">Clear all stored #GstMpeg2Picture + line="180"/> @@ -4722,7 +4630,7 @@ outputted a #GstMpeg2Dpb + line="121">a #GstMpeg2Dpb @@ -4730,9 +4638,9 @@ outputted Free the @dpb + line="95">Free the @dpb + line="177"/> @@ -4740,7 +4648,7 @@ outputted a #GstMpeg2Dpb to free + line="97">a #GstMpeg2Dpb to free @@ -4750,9 +4658,9 @@ outputted version="1.20"> Gets the neighbours #GstMpeg2Picture of @picture in @dpb. + line="258">Gets the neighbours #GstMpeg2Picture of @picture in @dpb. + line="192"/> @@ -4760,13 +4668,13 @@ outputted a #GstMpeg2Dpb + line="260">a #GstMpeg2Dpb current #GstMpeg2Picture + line="261">current #GstMpeg2Picture nullable="1"> previuous + line="262">previuous #GstMpeg2Picture in @dpb @@ -4787,7 +4695,7 @@ outputted nullable="1"> next + line="264">next #GstMpeg2Picture in @dpb @@ -4798,20 +4706,20 @@ outputted version="1.20"> Checks if @dbp has a new picture. + line="188">Checks if @dbp has a new picture. + line="189"/> #TRUE if @dpb needs to be bumped; otherwise, #FALSE + line="194">#TRUE if @dpb needs to be bumped; otherwise, #FALSE a #GstMpeg2Dpb + line="190">a #GstMpeg2Dpb @@ -4822,13 +4730,13 @@ outputted introspectable="0"> Create new #GstMpeg2Dpb + line="80">Create new #GstMpeg2Dpb + line="174"/> a new #GstMpeg2Dpb + line="85">a new #GstMpeg2Dpb @@ -4840,12 +4748,9 @@ outputted glib:get-type="gst_mpeg2_picture_get_type" c:symbol-prefix="mpeg2_picture"> + line="95"/> - - - - + @@ -4868,100 +4773,25 @@ outputted - - - - - - - - - Create new #GstMpeg2Picture + line="44">Create new #GstMpeg2Picture + line="113"/> a new #GstMpeg2Picture + line="49">a new #GstMpeg2Picture - - Gets private data set on the picture via -gst_mpeg2_picture_set_user_data() previously. - - - The previously set user_data - - - - - a #GstMpeg2Picture - - - - - - Sets @user_data on the picture and the #GDestroyNotify that will be called when -the picture is freed. - -If a @user_data was previously set, then the previous set @notify will be called -before the @user_data is replaced. - - - - - - - a #GstMpeg2Picture - - - - private data - - - - a #GDestroyNotify - - - - + line="73"/> @@ -5028,7 +4858,7 @@ before the @user_data is replaced. c:identifier="GST_VP8_PICTURE" introspectable="0"> + line="32"/> @@ -5038,7 +4868,7 @@ before the @user_data is replaced. c:identifier="GST_VP8_PICTURE_CAST" introspectable="0"> + line="33"/> @@ -5242,7 +5072,7 @@ before the @user_data is replaced. c:identifier="GST_VP9_PICTURE" introspectable="0"> + line="32"/> @@ -5252,7 +5082,7 @@ before the @user_data is replaced. c:identifier="GST_VP9_PICTURE_CAST" introspectable="0"> + line="33"/> @@ -5464,7 +5294,7 @@ preferred by subclass or not. line="69">Optional. Called whenever new #GstVp8Picture is created. Subclass can set implementation specific user data - on the #GstVp8Picture via gst_vp8_picture_set_user_data() + on the #GstVp8Picture via gst_vp8_picture_set_user_data @@ -5611,7 +5441,7 @@ preferred by subclass or not. line="69">Optional. Called whenever new #GstVp8Picture is created. Subclass can set implementation specific user data - on the #GstVp8Picture via gst_vp8_picture_set_user_data() + on the #GstVp8Picture via gst_vp8_picture_set_user_data @@ -5769,15 +5599,9 @@ preferred by subclass or not. glib:get-type="gst_vp8_picture_get_type" c:symbol-prefix="vp8_picture"> + line="47"/> - - - - - - - + @@ -5788,92 +5612,19 @@ preferred by subclass or not. - - - - - - - - - Create new #GstVp8Picture + line="32">Create new #GstVp8Picture + line="53"/> a new #GstVp8Picture + line="37">a new #GstVp8Picture - - Gets private data set on the picture via -gst_vp8_picture_set_user_data() previously. - - - The previously set user_data - - - - - a #GstVp8Picture - - - - - - Sets @user_data on the picture and the #GDestroyNotify that will be called when -the picture is freed. - -If a @user_data was previously set, then the previous set @notify will be called -before the @user_data is replaced. - - - - - - - a #GstVp8Picture - - - - private data - - - - a #GDestroyNotify - - - - filename="gst-libs/gst/codecs/gstvp9decoder.h" line="84">Optional. Called whenever new #GstVp9Picture is created. Subclass can set implementation specific user data on the #GstVp9Picture -via gst_vp9_picture_set_user_data() +via gst_vp9_picture_set_user_data @@ -6142,7 +5893,7 @@ profile. version="1.20"> Called to set non-keyframe format change awareness + line="641">Called to set non-keyframe format change awareness @@ -6152,13 +5903,13 @@ profile. a #GstVp9Decoder + line="643">a #GstVp9Decoder whether subclass can support non-keyframe format change + line="644">whether subclass can support non-keyframe format change @@ -6507,7 +6258,7 @@ and can be used as a binary. + line="114"/> @@ -6516,9 +6267,9 @@ and can be used as a binary. Store the @picture + line="104">Store the @picture + line="126"/> @@ -6526,13 +6277,13 @@ and can be used as a binary. a #GstVp9Dpb + line="106">a #GstVp9Dpb a #GstVp9Picture + line="107">a #GstVp9Picture @@ -6540,9 +6291,9 @@ and can be used as a binary. Clear all stored #GstVp9Picture + line="87">Clear all stored #GstVp9Picture + line="123"/> @@ -6550,7 +6301,7 @@ and can be used as a binary. a #GstVp9Dpb + line="89">a #GstVp9Dpb @@ -6558,9 +6309,9 @@ and can be used as a binary. Free the @dpb + line="72">Free the @dpb + line="120"/> @@ -6568,7 +6319,7 @@ and can be used as a binary. a #GstVp9Dpb to free + line="74">a #GstVp9Dpb to free @@ -6576,13 +6327,13 @@ and can be used as a binary. Create new #GstVp9Dpb + line="55">Create new #GstVp9Dpb + line="117"/> a new #GstVp9Dpb + line="60">a new #GstVp9Dpb @@ -6965,12 +6716,9 @@ and can be used as a binary. glib:get-type="gst_vp9_picture_get_type" c:symbol-prefix="vp9_picture"> + line="47"/> - - - - + @@ -6981,92 +6729,19 @@ and can be used as a binary. - - - - - - - - - Create new #GstVp9Picture + line="32">Create new #GstVp9Picture + line="53"/> a new #GstVp9Picture + line="37">a new #GstVp9Picture - - Gets private data set on the picture via -gst_vp9_picture_set_user_data() previously. - - - The previously set user_data - - - - - a #GstVp9Picture - - - - - - Sets @user_data on the picture and the #GDestroyNotify that will be called when -the picture is freed. - -If a @user_data was previously set, then the previous set @notify will be called -before the @user_data is replaced. - - - - - - - a #GstVp9Picture - - - - private data - - - - a #GDestroyNotify - - - - introspectable="0"> Create new #GstAV1Dpb + line="57">Create new #GstAV1Dpb + line="160"/> a new #GstAV1Dpb + line="62">a new #GstAV1Dpb @@ -7473,13 +7148,13 @@ gst_vp9_stateful_parser_free() after use. introspectable="0"> Create new #GstH264Dpb + line="79">Create new #GstH264Dpb + line="244"/> a new #GstH264Dpb + line="84">a new #GstH264Dpb @@ -7489,13 +7164,13 @@ gst_vp9_stateful_parser_free() after use. introspectable="0"> Create new #GstH265Dpb + line="66">Create new #GstH265Dpb + line="155"/> a new #GstH265Dpb + line="71">a new #GstH265Dpb @@ -7506,13 +7181,13 @@ gst_vp9_stateful_parser_free() after use. introspectable="0"> Create new #GstMpeg2Dpb + line="80">Create new #GstMpeg2Dpb + line="174"/> a new #GstMpeg2Dpb + line="85">a new #GstMpeg2Dpb @@ -7522,13 +7197,13 @@ gst_vp9_stateful_parser_free() after use. introspectable="0"> Create new #GstVp9Dpb + line="55">Create new #GstVp9Dpb + line="117"/> a new #GstVp9Dpb + line="60">a new #GstVp9Dpb diff --git a/girs/GstCuda-1.0.gir b/girs/GstCuda-1.0.gir index aa2583edc..579c1cd68 100644 --- a/girs/GstCuda-1.0.gir +++ b/girs/GstCuda-1.0.gir @@ -31,7 +31,7 @@ and/or use gtk-doc annotations. --> - + @@ -41,7 +41,7 @@ and/or use gtk-doc annotations. --> c:identifier="GST_CUDA_ALLOCATOR_CAST" version="1.22" introspectable="0"> - + @@ -50,7 +50,7 @@ and/or use gtk-doc annotations. --> - + @@ -59,7 +59,7 @@ and/or use gtk-doc annotations. --> - + @@ -69,7 +69,7 @@ and/or use gtk-doc annotations. --> c:identifier="GST_CUDA_BUFFER_POOL" introspectable="0"> + line="31"/> @@ -80,7 +80,7 @@ and/or use gtk-doc annotations. --> version="1.22" introspectable="0"> + line="41"/> @@ -90,7 +90,7 @@ and/or use gtk-doc annotations. --> c:identifier="GST_CUDA_BUFFER_POOL_CLASS" introspectable="0"> + line="32"/> @@ -100,7 +100,7 @@ and/or use gtk-doc annotations. --> c:identifier="GST_CUDA_BUFFER_POOL_GET_CLASS" introspectable="0"> + line="33"/> @@ -110,7 +110,7 @@ and/or use gtk-doc annotations. --> c:identifier="GST_CUDA_CONTEXT" introspectable="0"> + line="29"/> @@ -121,7 +121,7 @@ and/or use gtk-doc annotations. --> version="1.22" introspectable="0"> + line="40"/> @@ -131,7 +131,7 @@ and/or use gtk-doc annotations. --> c:identifier="GST_CUDA_CONTEXT_CLASS" introspectable="0"> + line="30"/> @@ -141,7 +141,7 @@ and/or use gtk-doc annotations. --> c:identifier="GST_CUDA_CONTEXT_GET_CLASS" introspectable="0"> + line="31"/> @@ -152,14 +152,14 @@ and/or use gtk-doc annotations. --> c:type="GST_CUDA_CONTEXT_TYPE" version="1.22"> + line="47"/> - + @@ -175,6 +175,42 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-struct="CudaAllocatorClass"> A #GstAllocator subclass for cuda memory + line="233">A #GstAllocator subclass for cuda memory + line="265"/> + + Controls the active state of @allocator. Default #GstCudaAllocator is +stateless and therefore active state is ignored, but subclass implementation +(e.g., #GstCudaPoolAllocator) will require explicit active state control +for its internal resource management. + +This method is conceptually identical to gst_buffer_pool_set_active method. + + + %TRUE if active state of @allocator was successfully updated. + + + + + a #GstCudaAllocator + + + + the new active state + + + + + line="271"/> + + a newly allocated #GstCudaMemory + + + + + a #GstCudaAllocator + + + + a #GstCudaContext + + + + a #GstCudaStream + + + + a #GstVideoInfo + + + + + + Allocates a new memory that wraps the given CUDA device memory. + +@info must represent actual memory layout, in other words, offset, stride +and size fields of @info should be matched with memory layout of @dev_ptr + +By default, wrapped @dev_ptr will be freed at the time when #GstMemory +is freed if @notify is %NULL. Otherwise, if caller sets @notify, +freeing @dev_ptr is callers responsibility and default #GstCudaAllocator +will not free it. + + a new #GstMemory + + + + + a #GstCudaAllocator + + + + a #GstCudaContext + + + + a #GstCudaStream + + + + a #GstVideoInfo + + + + a CUdeviceptr CUDA device memory + + + + user data + + + + + Called with @user_data when the memory is freed + + + + + + Controls the active state of @allocator. Default #GstCudaAllocator is +stateless and therefore active state is ignored, but subclass implementation +(e.g., #GstCudaPoolAllocator) will require explicit active state control +for its internal resource management. + +This method is conceptually identical to gst_buffer_pool_set_active method. + + + %TRUE if active state of @allocator was successfully updated. + + + + + a #GstCudaAllocator + + + + the new active state + + + + + + Allocates new #GstMemory object with CUDA virtual memory. + + + a newly allocated memory object or +%NULL if allocation is not supported + a #GstCudaAllocator + a #GstCudaContext + + a #GstCudaStream + + + a #GstVideoInfo + + allocation property + + + + allocation flags + + + + + + + + + + + line="265"/> + + + + + %TRUE if active state of @allocator was successfully updated. + + + + + a #GstCudaAllocator + + + + the new active state + + + + + + + + + + + + + glib:get-type="gst_cuda_buffer_pool_get_type" glib:type-struct="CudaBufferPoolClass"> + line="67"/> + line="73"/> A newly created #GstCudaBufferPool + filename="gst-libs/gst/cuda/gstcudabufferpool.cpp" + line="233">A newly created #GstCudaBufferPool The #GstCudaContext to use for the new buffer pool + filename="gst-libs/gst/cuda/gstcudabufferpool.cpp" + line="231">The #GstCudaContext to use for the new buffer pool @@ -265,7 +574,7 @@ and/or use gtk-doc annotations. --> c:type="GstCudaBufferPoolClass" glib:is-gtype-struct-for="CudaBufferPool"> + line="67"/> @@ -275,7 +584,7 @@ and/or use gtk-doc annotations. --> disguised="1" opaque="1"> + line="45"/> glib:get-type="gst_cuda_context_get_type" glib:type-struct="CudaContextClass"> + line="69"/> Create #GstCudaContext with given device_id + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="409">Create #GstCudaContext with given device_id + line="75"/> a new #GstCudaContext or %NULL on + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="415">a new #GstCudaContext or %NULL on failure device-id for creating #GstCudaContext + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="411">device-id for creating #GstCudaContext @@ -315,31 +624,31 @@ failure c:identifier="gst_cuda_context_new_wrapped" version="1.22"> Note: The caller is responsible for ensuring that the CUcontext and CUdevice + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="552">Note: The caller is responsible for ensuring that the CUcontext and CUdevice represented by @handle and @device stay alive while the returned #GstCudaContext is active. + line="78"/> A newly created #GstCudaContext + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="565">A newly created #GstCudaContext A + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="554">A [CUcontext](https://docs.nvidia.com/cuda/cuda-driver-api/group__CUDA__TYPES.html#group__CUDA__TYPES_1gf9f5bd81658f866613785b3a0bb7d7d9) to wrap A + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="557">A [CUDevice](https://docs.nvidia.com/cuda/cuda-driver-api/group__CUDA__TYPES.html#group__CUDA__TYPES_1gf9f5bd81658f866613785b3a0bb7d7d9) to wrap @@ -348,14 +657,14 @@ to wrap Pops the current CUDA context from CPU thread + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="470">Pops the current CUDA context from CPU thread + line="84"/> %TRUE if @ctx was pushed without error. + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="475">%TRUE if @ctx was pushed without error. @@ -368,27 +677,27 @@ to wrap c:identifier="gst_cuda_context_can_access_peer" version="1.22"> Query whether @ctx can access any memory which belongs to @peer directly. + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="524">Query whether @ctx can access any memory which belongs to @peer directly. + line="93"/> %TRUE if @ctx can access @peer directly + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="531">%TRUE if @ctx can access @peer directly a #GstCudaContext + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="526">a #GstCudaContext a #GstCudaContext + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="527">a #GstCudaContext @@ -397,22 +706,22 @@ to wrap c:identifier="gst_cuda_context_get_handle" version="1.22"> Get CUDA device context. Caller must not modify and/or destroy + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="485">Get CUDA device context. Caller must not modify and/or destroy returned device context. + line="87"/> the `CUcontext` of @ctx + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="492">the `CUcontext` of @ctx a #GstCudaContext + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="487">a #GstCudaContext @@ -421,44 +730,44 @@ returned device context. c:identifier="gst_cuda_context_get_texture_alignment" version="1.22"> Get required texture alignment by device + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="505">Get required texture alignment by device + line="90"/> the `CUcontext` of @ctx + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="511">the `CUcontext` of @ctx a #GstCudaContext + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="507">a #GstCudaContext Pushes the given @ctx onto the CPU thread's stack of current contexts. + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="449">Pushes the given @ctx onto the CPU thread's stack of current contexts. The specified context becomes the CPU thread's current context, so all CUDA functions that operate on the current context are affected. + line="81"/> %TRUE if @ctx was pushed without error. + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="457">%TRUE if @ctx was pushed without error. a #GstCudaContext to push current thread + filename="gst-libs/gst/cuda/gstcudacontext.cpp" + line="451">a #GstCudaContext to push current thread @@ -470,6 +779,24 @@ so all CUDA functions that operate on the current context are affected. default-value="0"> + + OS handle supportability in virtual memory management + + + + Virtual memory management supportability + + @@ -481,7 +808,7 @@ so all CUDA functions that operate on the current context are affected. c:type="GstCudaContextClass" glib:is-gtype-struct-for="CudaContext"> + line="69"/> @@ -491,12 +818,12 @@ so all CUDA functions that operate on the current context are affected. disguised="1" opaque="1"> + line="51"/> - + @@ -525,18 +852,18 @@ so all CUDA functions that operate on the current context are affected. version="1.22" introspectable="0"> Free @resource + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="661">Free @resource + line="153"/> a #GstCudaGraphicsResource + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="663">a #GstCudaGraphicsResource @@ -547,34 +874,34 @@ so all CUDA functions that operate on the current context are affected. version="1.22" introspectable="0"> Map previously registered resource with map flags + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="557">Map previously registered resource with map flags + line="144"/> the `CUgraphicsResource` if successful or %NULL when failed + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="565">the `CUgraphicsResource` if successful or %NULL when failed a #GstCudaGraphicsResource + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="559">a #GstCudaGraphicsResource a CUstream + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="560">a CUstream a CUgraphicsMapResourceFlags + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="561">a CUgraphicsMapResourceFlags @@ -585,17 +912,17 @@ so all CUDA functions that operate on the current context are affected. version="1.22" introspectable="0"> @resource a #GstCudaGraphicsResource + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="452">@resource a #GstCudaGraphicsResource Register the @buffer for access by CUDA. Must be called from the gl context thread with current cuda context was pushed on the current thread + line="129"/> whether @buffer was registered or not + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="462">whether @buffer was registered or not @@ -605,14 +932,14 @@ pushed on the current thread a GL buffer object + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="455">a GL buffer object a `CUgraphicsRegisterFlags` + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="456">a `CUgraphicsRegisterFlags` @@ -623,25 +950,25 @@ pushed on the current thread version="1.22" introspectable="0"> Unmap previously mapped resource + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="593">Unmap previously mapped resource + line="149"/> a #GstCudaGraphicsResource + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="595">a #GstCudaGraphicsResource a `CUstream` + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="596">a `CUstream` @@ -651,21 +978,21 @@ pushed on the current thread version="1.22" introspectable="0"> Unregister previously registered resource. + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="529">Unregister previously registered resource. For GL resource, this method must be called from gl context thread. Also, current cuda context should be pushed on the current thread before calling this method. + line="141"/> a #GstCudaGraphicsResource + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="531">a #GstCudaGraphicsResource @@ -676,22 +1003,22 @@ before calling this method. version="1.22" introspectable="0"> Create new #GstCudaGraphicsResource with given @context and @type + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="419">Create new #GstCudaGraphicsResource with given @context and @type + line="124"/> a new #GstCudaGraphicsResource. + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="427">a new #GstCudaGraphicsResource. Free with gst_cuda_graphics_resource_free a #GstCudaContext + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="421">a #GstCudaContext nullable="1" allow-none="1"> a graphics API specific context object + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="422">a graphics API specific context object a #GstCudaGraphicsResourceType of resource registration + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="423">a #GstCudaGraphicsResourceType of resource registration @@ -716,7 +1043,7 @@ Free with gst_cuda_graphics_resource_free - + @@ -732,7 +1059,7 @@ Free with gst_cuda_graphics_resource_free + line="193"/> @@ -750,91 +1077,661 @@ Free with gst_cuda_graphics_resource_free - + Ensures that the #GstCudaAllocator is initialized and ready to be used. + filename="gst-libs/gst/cuda/gstcudamemory.cpp" + line="967">Exports virtual memory handle to OS specific handle. + +On Windows, @os_handle should be pointer to HANDLE (i.e., void **), and +pointer to file descriptor (i.e., int *) on Linux. + +The returned @os_handle is owned by @mem and therefore caller shouldn't +close the handle. + line="230"/> - + %TRUE if successful + - - - - - - - - + + + a #GstCudaMemory + + + + a pointer to OS handle + + + + + the device memory needs downloading - to the staging memory - - + filename="gst-libs/gst/cuda/gstcudamemory.cpp" + line="950">Query allocation method + + + + + + + a #GstCudaMemory + + + + + the staging memory needs uploading - to the device memory - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + filename="gst-libs/gst/cuda/gstcudamemory.cpp" + line="664">Gets CUDA stream object associated with @mem + + + a #GstCudaStream or %NULL if default +CUDA stream is in use + + + + + A #GstCudaMemory + + + + + + Creates CUtexObject with given parameters + + + %TRUE if successful + + + + + A #GstCudaMemory + + + + the plane index + + + + filter mode + + + + a pointer to CUtexObject object + + + + + + Gets back user data pointer stored via gst_cuda_memory_set_token_data() + + + user data pointer or %NULL + + + + + a #GstCudaMemory + + + + an user token + + + + + + Gets user data pointer stored via gst_cuda_allocator_alloc_wrapped() + + + the user data pointer + + + + + A #GstCudaMemory + + + + + + Sets an opaque user data on a #GstCudaMemory + + + + + + + a #GstCudaMemory + + + + an user token + + + + an user data + + + + function to invoke with @data as argument, when @data needs to be + freed + + + + + + Performs synchronization if needed + + + + + + + A #GstCudaMemory + + + + + + Ensures that the #GstCudaAllocator is initialized and ready to be used. + + + + + + + + CUDA memory allocation method + + + + Memory allocated via cuMemAlloc or cuMemAllocPitch + + + Memory allocated via cuMemCreate and cuMemMap + + + + + + + CUDA memory transfer flags + + + the device memory needs downloading to the staging memory + + + the staging memory needs uploading to the device memory + + + the device memory needs synchronization + + + + A #GstCudaAllocator subclass for cuda memory pool + + + Creates a new #GstCudaPoolAllocator instance. + + + a new #GstCudaPoolAllocator instance + + + + + a #GstCudaContext + + + + a #GstCudaStream + + + + a #GstVideoInfo + + + + + + Creates a new #GstCudaPoolAllocator instance for virtual memory allocation. + + + a new #GstCudaPoolAllocator instance + + + + + a #GstCudaContext + + + + a #GstCudaStream + + + + a #GstVideoInfo + + + + + + + + + + + + Acquires a #GstMemory from @allocator. @memory should point to a memory +location that can hold a pointer to the new #GstMemory. + + + a #GstFlowReturn such as %GST_FLOW_FLUSHING when the allocator is +inactive. + + + + + a #GstCudaPoolAllocator + + + + a #GstMemory + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new #GstCudaStream + + + a new #GstCudaStream or %NULL on +failure + + + + + a #GstCudaContext + + + + + + Get CUDA stream handle + + + a `CUstream` handle of @stream or %NULL if @stream is %NULL + + + + + a #GstCudaStream + + + + + + Increase the reference count of @stream. + + + @stream + + + + + a #GstCudaStream + + + + + + Decrease the reference count of @stream. + + + + + + + a #GstCudaStream + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -842,7 +1739,7 @@ Free with gst_cuda_graphics_resource_free c:identifier="GST_IS_CUDA_CONTEXT" introspectable="0"> + line="32"/> @@ -852,12 +1749,39 @@ Free with gst_cuda_graphics_resource_free c:identifier="GST_IS_CUDA_CONTEXT_CLASS" introspectable="0"> + line="33"/> + + + + + + + + + + + + + + + + + + + + + + + Gets configured allocation method + + + + + + + a buffer pool config + + + + + + + + the currently configured #GstCudaStream +on @config or %NULL if @config doesn't hold #GstCudaStream + + + + + a buffer pool config + + + + + + Sets allocation method + + + + + + + a buffer pool config + + + + + + + + + Sets @stream on @config + + + + + + + a buffer pool config + + + + a #GstCudaStream + + + + + + Clears a reference to a #GstCudaStream. + + + + + + + a pointer to a #GstCudaStream reference + + + + - + a new #GstContext embedding the @cuda_ctx + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="364">a new #GstContext embedding the @cuda_ctx a #GstCudaContext + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="362">a #GstCudaContext + + Creates new user token value + + + user token value + + + Perform the steps necessary for retrieving a #GstCudaContext from the + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="180">Perform the steps necessary for retrieving a #GstCudaContext from the surrounding elements or from the application using the #GstContext mechanism. If the content of @cuda_ctx is not %NULL, then no #GstContext query is necessary for #GstCudaContext. - + whether a #GstCudaContext exists in @cuda_ctx + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="193">whether a #GstCudaContext exists in @cuda_ctx the #GstElement running the query + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="182">the #GstElement running the query preferred device-id, pass device_id >=0 when + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="183">preferred device-id, pass device_id >=0 when the device_id explicitly required. Otherwise, set -1. @@ -930,8 +1979,8 @@ necessary for #GstCudaContext. caller-allocates="0" transfer-ownership="full"> the resulting #GstCudaContext + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="185">the resulting #GstCudaContext @@ -942,21 +1991,21 @@ necessary for #GstCudaContext. version="1.22" introspectable="0"> Create new #GstCudaGraphicsResource with given @context and @type - + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="419">Create new #GstCudaGraphicsResource with given @context and @type + a new #GstCudaGraphicsResource. + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="427">a new #GstCudaGraphicsResource. Free with gst_cuda_graphics_resource_free a #GstCudaContext + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="421">a #GstCudaContext nullable="1" allow-none="1"> a graphics API specific context object + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="422">a graphics API specific context object a #GstCudaGraphicsResourceType of resource registration + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="423">a #GstCudaGraphicsResourceType of resource registration @@ -980,25 +2029,25 @@ Free with gst_cuda_graphics_resource_free - + Whether the @query was successfully responded to from the passed + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="316">Whether the @query was successfully responded to from the passed @context. a #GstElement + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="312">a #GstElement a #GstQuery of type %GST_QUERY_CONTEXT + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="313">a #GstQuery of type %GST_QUERY_CONTEXT nullable="1" allow-none="1"> a #GstCudaContext + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="314">a #GstCudaContext @@ -1016,35 +2065,35 @@ Free with gst_cuda_graphics_resource_free c:identifier="gst_cuda_handle_set_context" version="1.22"> Helper function for implementing #GstElementClass.set_context() in + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="250">Helper function for implementing #GstElementClass.set_context() in CUDA capable elements. Retrieves the #GstCudaContext in @context and places the result in @cuda_ctx. - + whether the @cuda_ctx could be set successfully + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="263">whether the @cuda_ctx could be set successfully a #GstElement + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="252">a #GstElement a #GstContext + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="253">a #GstContext preferred device-id, pass device_id >=0 when + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="254">preferred device-id, pass device_id >=0 when the device_id explicitly required. Otherwise, set -1. @@ -1053,8 +2102,8 @@ Retrieves the #GstCudaContext in @context and places the result in @cuda_ctx. location of a #GstCudaContext + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="256">location of a #GstCudaContext @@ -1063,13 +2112,13 @@ Retrieves the #GstCudaContext in @context and places the result in @cuda_ctx. Loads the cuda library - + filename="gst-libs/gst/cuda/gstcudaloader.cpp" + line="317">Loads the cuda library + %TRUE if the libcuda could be loaded %FALSE otherwise + filename="gst-libs/gst/cuda/gstcudaloader.cpp" + line="322">%TRUE if the libcuda could be loaded %FALSE otherwise @@ -1078,10 +2127,10 @@ Retrieves the #GstCudaContext in @context and places the result in @cuda_ctx. Ensures that the #GstCudaAllocator is initialized and ready to be used. + filename="gst-libs/gst/cuda/gstcudamemory.cpp" + line="629">Ensures that the #GstCudaAllocator is initialized and ready to be used. + line="196"/> @@ -1089,30 +2138,56 @@ Retrieves the #GstCudaContext in @context and places the result in @cuda_ctx. - + Source code to compile + filename="gst-libs/gst/cuda/gstcudanvrtc.cpp" + line="279">Source code to compile + + + + Compiled CUDA assembly code if successful, +otherwise %NULL + + + + + Source code to compile + + + + CUDA device + + + + Loads the nvrtc library. - + filename="gst-libs/gst/cuda/gstcudanvrtc.cpp" + line="178">Loads the nvrtc library. + %TRUE if the library could be loaded, %FALSE otherwise + filename="gst-libs/gst/cuda/gstcudanvrtc.cpp" + line="183">%TRUE if the library could be loaded, %FALSE otherwise @@ -1120,31 +2195,32 @@ Retrieves the #GstCudaContext in @context and places the result in @cuda_ctx. - + the GQuark for given @id or 0 if @id is unknown value + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="404">the GQuark for given @id or 0 if @id is unknown value a #GstCudaQuarkId + filename="gst-libs/gst/cuda/gstcudautils.cpp" + line="402">a #GstCudaQuarkId - + CUDA device API return code `CUresult` + line="40">CUDA device API return code `CUresult` @@ -1152,18 +2228,18 @@ Retrieves the #GstCudaContext in @context and places the result in @cuda_ctx. Check if @mem is a cuda memory + filename="gst-libs/gst/cuda/gstcudamemory.cpp" + line="649">Check if @mem is a cuda memory + line="199"/> A #GstMemory + filename="gst-libs/gst/cuda/gstcudamemory.cpp" + line="651">A #GstMemory diff --git a/girs/GstGL-1.0.gir b/girs/GstGL-1.0.gir index fc6d7dd27..922804a0f 100644 --- a/girs/GstGL-1.0.gir +++ b/girs/GstGL-1.0.gir @@ -842,6 +842,11 @@ context. It also provided some wrappers around #GstBaseTransform's context is available and current in the calling thread. + called in the GL thread when caps are set on @filter. + Note: this will also be called when changing OpenGL contexts + where #GstBaseTransform::set_caps may not. @@ -860,6 +865,9 @@ context is available and current in the calling thread. + called in the GL thread to setup the element GL state. @@ -872,6 +880,9 @@ context is available and current in the calling thread. + called in the GL thread to setup the element GL state. @@ -891,14 +902,14 @@ context is available and current in the calling thread. Whether an OpenGL context could be retrieved or created successfully + line="642">Whether an OpenGL context could be retrieved or created successfully a #GstGLBaseFilter + line="640">a #GstGLBaseFilter @@ -911,14 +922,14 @@ context is available and current in the calling thread. the #GstGLContext found by @filter + line="660">the #GstGLContext found by @filter a #GstGLBaseFilter + line="658">a #GstGLBaseFilter @@ -980,6 +991,9 @@ context is available and current in the calling thread. + called in the GL thread to setup the element GL state. @@ -994,6 +1008,9 @@ context is available and current in the calling thread. + called in the GL thread to setup the element GL state. @@ -1008,6 +1025,11 @@ context is available and current in the calling thread. + called in the GL thread when caps are set on @filter. + Note: this will also be called when changing OpenGL contexts + where #GstBaseTransform::set_caps may not. @@ -1290,6 +1312,9 @@ multiple times. This must be called before any other GstGLBaseMemory operation. + a #GstGLBaseMemoryAllocatorAllocFunction @@ -1843,6 +1868,9 @@ context. It also provided some wrappers around #GstBaseSrc's `start()` and current in the calling thread. + called in the GL thread to fill the current video texture. @@ -1857,6 +1885,9 @@ current in the calling thread. + called in the GL thread to setup the element GL state. @@ -1868,6 +1899,9 @@ current in the calling thread. + called in the GL thread to setup the element GL state. @@ -1944,6 +1978,9 @@ current in the calling thread. + called in the GL thread to setup the element GL state. @@ -1958,6 +1995,9 @@ current in the calling thread. + called in the GL thread to setup the element GL state. @@ -1972,6 +2012,9 @@ current in the calling thread. + called in the GL thread to fill the current video texture. @@ -2174,7 +2217,7 @@ multiple times. This must be called before any other #GstGLBuffer operation. a #GstGLBufferPool is an object that allocates buffers with #GstGLBaseMemory + line="33">a #GstGLBufferPool is an object that allocates buffers with #GstGLBaseMemory A #GstGLBufferPool is created with gst_gl_buffer_pool_new() @@ -2189,14 +2232,14 @@ A #GstGLBufferPool is created with gst_gl_buffer_pool_new() a #GstBufferPool that allocates buffers with #GstGLMemory + line="392">a #GstBufferPool that allocates buffers with #GstGLMemory the #GstGLContext to use + line="390">the #GstGLContext to use @@ -2206,7 +2249,7 @@ A #GstGLBufferPool is created with gst_gl_buffer_pool_new() version="1.20"> The returned #GstGLAllocationParams will by %NULL before the first successful + line="472">The returned #GstGLAllocationParams will by %NULL before the first successful call to gst_buffer_pool_set_config(). Subsequent successful calls to gst_buffer_pool_set_config() will cause this function to return a new #GstGLAllocationParams which may or may not contain the same information. @@ -2215,14 +2258,14 @@ gst_buffer_pool_set_config() will cause this function to return a new a copy of the #GstGLAllocationParams being used by the @pool + line="481">a copy of the #GstGLAllocationParams being used by the @pool the #GstGLBufferPool + line="474">the #GstGLBufferPool @@ -2288,18 +2331,18 @@ The glcolorconvertelement provides a GStreamer element that uses c:identifier="gst_gl_color_convert_new" version="1.4"> + line="137"/> a new #GstGLColorConvert object + line="662">a new #GstGLColorConvert object a #GstGLContext + line="660">a #GstGLContext @@ -2309,108 +2352,159 @@ The glcolorconvertelement provides a GStreamer element that uses version="1.8"> Provides an implementation of #GstBaseTransformClass.fixate_caps() + line="1511">Provides an implementation of #GstBaseTransformClass.fixate_caps() + line="145"/> the fixated #GstCaps + line="1520">the fixated #GstCaps a #GstGLContext to use for transforming @caps + line="1513">a #GstGLContext to use for transforming @caps a #GstPadDirection + line="1514">a #GstPadDirection the #GstCaps of @direction + line="1515">the #GstCaps of @direction the #GstCaps to fixate + line="1516">the #GstCaps to fixate + + + + a shader string that can be used to swizzle vec +components in a GLSL shader. + + + + + a #GstGLContext + + + + Provides an implementation of #GstBaseTransformClass.transform_caps() + line="1276">Provides an implementation of #GstBaseTransformClass.transform_caps() + line="140"/> the converted #GstCaps + line="1285">the converted #GstCaps a #GstGLContext to use for transforming @caps + line="1278">a #GstGLContext to use for transforming @caps a #GstPadDirection + line="1279">a #GstPadDirection the #GstCaps to transform + line="1280">the #GstCaps to transform a set of filter #GstCaps + line="1281">a set of filter #GstCaps + + The returned glsl function has declaration: + +`vec3 yuv_to_rgb (vec3 rgb, vec3 offset, vec3 ycoeff, vec3 ucoeff, vec3 vcoeff);` + +The Y component is placed in the 0th index of the returned value, The U component in the +1st, and the V component in the 2nd. offset, ycoeff, ucoeff, and vcoeff are the +specific coefficients and offset used for the conversion. + + + a glsl function that can be used to convert from +yuv to rgb + + + + + a #GstGLContext + + + + Provides an implementation of #GstBaseTransformClass.decide_allocation() + line="949">Provides an implementation of #GstBaseTransformClass.decide_allocation() + line="154"/> whether the allocation parameters were successfully chosen + line="956">whether the allocation parameters were successfully chosen a #GstGLColorConvert + line="951">a #GstGLColorConvert a completed ALLOCATION #GstQuery + line="952">a completed ALLOCATION #GstQuery @@ -2420,27 +2514,27 @@ The glcolorconvertelement provides a GStreamer element that uses version="1.4"> Converts the data contained by @inbuf using the formats specified by the + line="1552">Converts the data contained by @inbuf using the formats specified by the #GstCaps passed to gst_gl_color_convert_set_caps() + line="158"/> a converted #GstBuffer or %NULL + line="1560">a converted #GstBuffer or %NULL a #GstGLColorConvert + line="1554">a #GstGLColorConvert the #GstGLMemory filled #GstBuffer to convert + line="1555">the #GstGLMemory filled #GstBuffer to convert @@ -2450,9 +2544,9 @@ The glcolorconvertelement provides a GStreamer element that uses version="1.6"> Initializes @convert with the information required for conversion. + line="926">Initializes @convert with the information required for conversion. + line="150"/> @@ -2460,19 +2554,19 @@ The glcolorconvertelement provides a GStreamer element that uses a #GstGLColorConvert + line="928">a #GstGLColorConvert input #GstCaps + line="929">input #GstCaps output #GstCaps + line="930">output #GstCaps @@ -2963,6 +3057,9 @@ case. + choose a format for the framebuffer @@ -2974,6 +3071,9 @@ case. + create the OpenGL context @@ -2991,6 +3091,9 @@ case. + destroy the OpenGL context @@ -4064,6 +4167,9 @@ MT-safe + get the backing platform specific OpenGL context @@ -4084,6 +4190,9 @@ MT-safe + get the available OpenGL api's that this context can work with @@ -4124,6 +4233,9 @@ MT-safe + get an function pointer to an OpenGL function @@ -4141,6 +4253,9 @@ MT-safe + call eglMakeCurrent or similar @@ -4167,6 +4282,9 @@ MT-safe + choose a format for the framebuffer @@ -4181,6 +4299,9 @@ MT-safe + create the OpenGL context @@ -4201,6 +4322,9 @@ MT-safe + destroy the OpenGL context @@ -4215,6 +4339,9 @@ MT-safe + swap the default framebuffer's front/back buffers @@ -4467,7 +4594,7 @@ a #GstGLDisplay. There are a number of environment variables that influence the choice of platform and window system specific functionality. - GST_GL_WINDOW influences the window system to use. Common values are - 'x11', 'wayland', 'win32' or 'cocoa'. + 'x11', 'wayland', 'surfaceless', 'win32' or 'cocoa'. - GST_GL_PLATFORM influences the OpenGL platform to use. Common values are 'egl', 'glx', 'wgl' or 'cgl'. - GST_GL_API influences the OpenGL API requested by the OpenGL platform. @@ -4480,13 +4607,13 @@ platform and window system specific functionality. > other toolkit/library functionality is accessed. Failure to do so could > result in sudden application abortion during execution. The most notably > example of such a function is X11's XInitThreads\(). - + - + a new #GstGLDisplay + line="450">a new #GstGLDisplay @@ -4495,15 +4622,15 @@ platform and window system specific functionality. version="1.20"> Will always return a #GstGLDisplay of a single type. This differs from + line="330">Will always return a #GstGLDisplay of a single type. This differs from gst_gl_display_new() and the seemingly equivalent call gst_gl_display_new_with_type (GST_GL_DISPLAY_TYPE_ANY) in that the latter may return NULL. - + a new #GstGLDisplay or %NULL if @type is + line="339">a new #GstGLDisplay or %NULL if @type is not supported @@ -4511,41 +4638,41 @@ may return NULL. #GstGLDisplayType + line="332">#GstGLDisplayType - + a new #GstGLWindow for @display or %NULL. + line="678">a new #GstGLWindow for @display or %NULL. a #GstGLDisplay + line="676">a #GstGLDisplay - + the native handle for the display + line="473">the native handle for the display a #GstGLDisplay + line="471">a #GstGLDisplay @@ -4553,11 +4680,11 @@ may return NULL. - + whether @context was successfully added. %FALSE may be returned + line="913">whether @context was successfully added. %FALSE may be returned if there already exists another context for @context's active thread. Must be called with the object lock held. @@ -4567,13 +4694,13 @@ Must be called with the object lock held. a #GstGLDisplay + line="910">a #GstGLDisplay a #GstGLContext + line="911">a #GstGLContext @@ -4584,19 +4711,19 @@ Must be called with the object lock held. throws="1"> It requires the display's object lock to be held. - + line="621">It requires the display's object lock to be held. + whether a new context could be created. + line="630">whether a new context could be created. a #GstGLDisplay + line="623">a #GstGLDisplay allow-none="1"> other #GstGLContext to share resources with. + line="624">other #GstGLContext to share resources with. transfer-ownership="full"> resulting #GstGLContext + line="625">resulting #GstGLContext - + a new #GstGLWindow for @display or %NULL. + line="678">a new #GstGLWindow for @display or %NULL. a #GstGLDisplay + line="676">a #GstGLDisplay @@ -4642,20 +4769,20 @@ Must be called with the object lock held. throws="1"> Ensures that the display has a valid GL context for the current thread. If + line="1020">Ensures that the display has a valid GL context for the current thread. If @context already contains a valid context, this does nothing. - + wether @context contains a valid context. + line="1030">wether @context contains a valid context. a #GstGLDisplay + line="1022">a #GstGLDisplay allow-none="1"> other #GstGLContext to share resources with. + line="1023">other #GstGLContext to share resources with. allow-none="1"> the resulting #GstGLContext + line="1024">the resulting #GstGLContext @@ -4683,11 +4810,11 @@ Must be called with the object lock held. limit the use of OpenGL to the requested @gl_api. This is intended to allow + line="495">limit the use of OpenGL to the requested @gl_api. This is intended to allow application and elements to request a specific set of OpenGL API's based on what they support. See gst_gl_context_get_gl_api() for the retrieving the API supported by a #GstGLContext. - + @@ -4695,13 +4822,13 @@ API supported by a #GstGLContext. a #GstGLDisplay + line="497">a #GstGLDisplay a #GstGLAPI to filter with + line="498">a #GstGLAPI to filter with @@ -4713,15 +4840,15 @@ API supported by a #GstGLContext. deprecated-version="1.18"> Execute @compare_func over the list of windows stored by @display. The + line="740">Execute @compare_func over the list of windows stored by @display. The first argument to @compare_func is the #GstGLWindow being checked and the second argument is @data. Use gst_gl_display_retrieve_window() instead. - + The first #GstGLWindow that causes a match + line="750">The first #GstGLWindow that causes a match from @compare_func @@ -4729,7 +4856,7 @@ second argument is @data. a #GstGLDisplay + line="742">a #GstGLDisplay allow-none="1"> some data to pass to @compare_func + line="743">some data to pass to @compare_func scope="call"> a comparison function to run + line="744">a comparison function to run @@ -4754,26 +4881,26 @@ second argument is @data. see gst_gl_display_filter_gl_api() for what the returned value represents - + line="529">see gst_gl_display_filter_gl_api() for what the returned value represents + the #GstGLAPI configured for @display + line="535">the #GstGLAPI configured for @display a #GstGLDisplay + line="531">a #GstGLDisplay - + @@ -4786,11 +4913,11 @@ second argument is @data. - + the #GstGLContext current on @thread or %NULL + line="856">the #GstGLContext current on @thread or %NULL Must be called with the object lock held. @@ -4799,13 +4926,13 @@ Must be called with the object lock held. a #GstGLDisplay + line="853">a #GstGLDisplay a #GThread + line="854">a #GThread @@ -4813,18 +4940,18 @@ Must be called with the object lock held. - + the native handle for the display + line="473">the native handle for the display a #GstGLDisplay + line="471">a #GstGLDisplay @@ -4832,18 +4959,18 @@ Must be called with the object lock held. - + the #GstGLDisplayType of @display + line="555">the #GstGLDisplayType of @display a #GstGLDisplay + line="553">a #GstGLDisplay @@ -4853,8 +4980,8 @@ Must be called with the object lock held. version="1.18"> Must be called with the object lock held. - + line="973">Must be called with the object lock held. + @@ -4862,13 +4989,13 @@ Must be called with the object lock held. a #GstGLDisplay + line="975">a #GstGLDisplay the #GstGLContext to remove + line="976">the #GstGLContext to remove @@ -4876,24 +5003,24 @@ Must be called with the object lock held. - + if @window could be removed from @display + line="716">if @window could be removed from @display a #GstGLDisplay + line="713">a #GstGLDisplay a #GstGLWindow to remove + line="714">a #GstGLWindow to remove @@ -4903,14 +5030,14 @@ Must be called with the object lock held. version="1.18"> Execute @compare_func over the list of windows stored by @display. The + line="770">Execute @compare_func over the list of windows stored by @display. The first argument to @compare_func is the #GstGLWindow being checked and the second argument is @data. - + The first #GstGLWindow that causes a match + line="780">The first #GstGLWindow that causes a match from @compare_func @@ -4918,7 +5045,7 @@ second argument is @data. a #GstGLDisplay + line="772">a #GstGLDisplay allow-none="1"> some data to pass to @compare_func + line="773">some data to pass to @compare_func scope="call"> a comparison function to run + line="774">a comparison function to run @@ -4988,25 +5115,25 @@ display's object lock held. - + + line="137"/> the native handle for the display + line="473">the native handle for the display a #GstGLDisplay + line="471">a #GstGLDisplay @@ -5015,18 +5142,18 @@ display's object lock held. + line="138"/> a new #GstGLWindow for @display or %NULL. + line="678">a new #GstGLWindow for @display or %NULL. a #GstGLDisplay + line="676">a #GstGLDisplay @@ -5169,6 +5296,17 @@ display's object lock held. filename="gst-libs/gst/gl/gstgldisplay.h" line="76">Android display. + + Mesa3D surfaceless display using the EGL_PLATFORM_SURFACELESS_MESA +extension. + + perform operations on the input and output buffers. In general, + you should avoid using this method if at all possible. One valid + use-case for using this is keeping previous buffers for future calculations. + Note: If @filter exists, then @filter_texture is not run @@ -5225,36 +5369,39 @@ single input and producing a single output with a #GstGLFramebuffer version="1.4"> Calls filter_texture vfunc with correctly mapped #GstGLMemorys + line="941">Calls filter_texture vfunc with correctly mapped #GstGLMemorys whether the transformation succeeded + line="949">whether the transformation succeeded a #GstGLFilter + line="943">a #GstGLFilter an input buffer + line="944">an input buffer an output buffer + line="945">an output buffer + perform initialization when the Framebuffer object is created @@ -5266,6 +5413,9 @@ single input and producing a single output with a #GstGLFramebuffer + mirror from #GstBaseTransform @@ -5283,6 +5433,10 @@ single input and producing a single output with a #GstGLFramebuffer + Perform sub-class specific modifications of the + caps to be processed between upload on input and before download for output. @@ -5307,7 +5461,7 @@ single input and producing a single output with a #GstGLFramebuffer version="1.10"> Render a fullscreen quad using the current GL state. The only GL state this + line="1234">Render a fullscreen quad using the current GL state. The only GL state this modifies is the necessary vertex/index buffers and, if necessary, a Vertex Array Object for drawing a fullscreen quad. Framebuffer state, any shaders, viewport state, etc must be setup by the caller. @@ -5319,7 +5473,7 @@ any shaders, viewport state, etc must be setup by the caller. a #GstGLFilter + line="1236">a #GstGLFilter @@ -5329,31 +5483,31 @@ any shaders, viewport state, etc must be setup by the caller. version="1.4"> Calls filter_texture vfunc with correctly mapped #GstGLMemorys + line="941">Calls filter_texture vfunc with correctly mapped #GstGLMemorys whether the transformation succeeded + line="949">whether the transformation succeeded a #GstGLFilter + line="943">a #GstGLFilter an input buffer + line="944">an input buffer an output buffer + line="945">an output buffer @@ -5363,31 +5517,31 @@ any shaders, viewport state, etc must be setup by the caller. version="1.10"> Transforms @input into @output using @func on through FBO. + line="1077">Transforms @input into @output using @func on through FBO. the return value of @func + line="1087">the return value of @func a #GstGLFilter + line="1079">a #GstGLFilter the input texture + line="1080">the input texture the output texture + line="1081">the output texture closure="3"> the function to transform @input into @output. called with @data + line="1082">the function to transform @input into @output. called with @data allow-none="1"> the data associated with @func + line="1083">the data associated with @func @@ -5415,7 +5569,7 @@ any shaders, viewport state, etc must be setup by the caller. version="1.4"> Transforms @input into @output using @shader with a FBO. + line="1160">Transforms @input into @output using @shader with a FBO. See also: gst_gl_filter_render_to_target() @@ -5426,25 +5580,25 @@ See also: gst_gl_filter_render_to_target() a #GstGLFilter + line="1162">a #GstGLFilter the input texture + line="1163">the input texture the output texture + line="1164">the output texture the shader to use. + line="1165">the shader to use. @@ -5532,6 +5686,9 @@ See also: gst_gl_filter_render_to_target() + mirror from #GstBaseTransform @@ -5552,6 +5709,12 @@ See also: gst_gl_filter_render_to_target() + perform operations on the input and output buffers. In general, + you should avoid using this method if at all possible. One valid + use-case for using this is keeping previous buffers for future calculations. + Note: If @filter exists, then @filter_texture is not run @@ -5572,38 +5735,45 @@ See also: gst_gl_filter_render_to_target() + given @in_tex, transform it into @out_tex. Not used + if @filter exists whether the transformation succeeded + line="949">whether the transformation succeeded a #GstGLFilter + line="943">a #GstGLFilter an input buffer + line="944">an input buffer an output buffer + line="945">an output buffer + perform initialization when the Framebuffer object is created @@ -5618,6 +5788,10 @@ See also: gst_gl_filter_render_to_target() + Perform sub-class specific modifications of the + caps to be processed between upload on input and before download for output. @@ -5894,11 +6068,11 @@ See also: gst_gl_filter_render_to_target() - + Whether @format is supported by @context based on the OpenGL API, + line="672">Whether @format is supported by @context based on the OpenGL API, version, or available OpenGL extension/s. @@ -5906,13 +6080,32 @@ See also: gst_gl_filter_render_to_target() a #GstGLContext + line="669">a #GstGLContext the #GstGLFormat to check is supported by @context + line="670">the #GstGLFormat to check is supported by @context + + + + + + + + the number of components in a #GstGLFormat + + + + + the #GstGLFormat @@ -5922,7 +6115,7 @@ See also: gst_gl_filter_render_to_target() version="1.16"> Get the unsized format and type from @format for usage in glReadPixels, + line="369">Get the unsized format and type from @format for usage in glReadPixels, glTex{Sub}Image*, glTexImage* and similar functions. @@ -5932,7 +6125,7 @@ glTex{Sub}Image*, glTexImage* and similar functions. the sized internal #GstGLFormat + line="371">the sized internal #GstGLFormat transfer-ownership="full"> location for the resulting unsized #GstGLFormat + line="372">location for the resulting unsized #GstGLFormat transfer-ownership="full"> location for the resulting GL type + line="373">location for the resulting GL type @@ -6335,53 +6528,53 @@ the %GST_CAPS_FEATURE_MEMORY_GL_MEMORY as a #GstCapsFeatures and should contain a 'texture-target' field with one of the #GstGLTextureTarget values as a string, i.e. some combination of 'texture-target=(string){2D, rectangle, external-oes}'. - + the parent #GstGLBaseMemory object + line="76">the parent #GstGLBaseMemory object the GL texture id for this memory + line="77">the GL texture id for this memory the GL texture target for this memory + line="78">the GL texture target for this memory the texture type + line="79">the texture type the texture's #GstVideoInfo + line="80">the texture's #GstVideoInfo data alignment for system memory mapping + line="81">data alignment for system memory mapping data plane in @info + line="82">data plane in @info GL shader scaling parameters for @valign and/or width/height + line="83">GL shader scaling parameters for @valign and/or width/height @@ -6407,7 +6600,7 @@ rectangle, external-oes}'. filename="gst-libs/gst/gl/gstglmemory.c" line="1020">Copies @gl_mem into the texture specified by @tex_id. The format of @tex_id is specified by @tex_format, @width and @height. - + filename="gst-libs/gst/gl/gstglmemory.c" line="674">Copies the texture in #GstGLMemory into the texture specified by @tex_id, @out_target, @out_tex_format, @out_width and @out_height. - + - + - + - + - + - + filename="gst-libs/gst/gl/gstglmemory.c" line="330">Initializes @mem with the required parameters. @info is assumed to have already have been modified with gst_video_info_align(). - + @@ -6713,7 +6906,7 @@ to `GL_PIXEL_PACK_BUFFER`. Otherwise @write_pointer is the byte offset into the currently bound `GL_PIXEL_PACK_BUFFER` buffer to store the result of glReadPixels. See the OpenGL specification for glReadPixels for more details. - + line="558">Reads the texture in @read_pointer into @gl_mem. See gst_gl_memory_read_pixels() for what @read_pointer signifies. - + @@ -6775,7 +6968,7 @@ See gst_gl_memory_read_pixels() for what @read_pointer signifies. filename="gst-libs/gst/gl/gstglmemory.c" line="1135">Initializes the GL Base Texture allocator. It is safe to call this function multiple times. This must be called before any other GstGLMemory operation. - + @@ -6784,7 +6977,7 @@ multiple times. This must be called before any other GstGLMemory operation. - + Opaque #GstGLMemoryAllocator struct - + line="214">Opaque #GstGLMemoryAllocator struct + - + - + @@ -6892,21 +7085,21 @@ multiple times. This must be called before any other GstGLMemory operation. provide a custom map implementation + line="229">provide a custom map implementation provide a custom copy implementation + line="230">provide a custom copy implementation provide a custom unmap implementation + line="231">provide a custom unmap implementation @@ -7137,21 +7330,21 @@ output buffer. version="1.24"> Perform processing required and call #GstGLMixerClass::process_textures(). + line="671">Perform processing required and call #GstGLMixerClass::process_textures(). Intended for use within implementations of #GstGLMixerClass::process_buffers(). whether processing of textures succeeded + line="680">whether processing of textures succeeded the #GstGLMixer + line="673">the #GstGLMixer @@ -7166,14 +7359,14 @@ Intended for use within implementations of (nullable): The #GstGLFramebuffer in use by this @mix + line="803">(nullable): The #GstGLFramebuffer in use by this @mix the #GstGLMixer + line="801">the #GstGLMixer @@ -7183,27 +7376,27 @@ Intended for use within implementations of version="1.24"> Perform processing required and call #GstGLMixerClass::process_textures(). + line="671">Perform processing required and call #GstGLMixerClass::process_textures(). Intended for use within implementations of #GstGLMixerClass::process_buffers(). whether processing of textures succeeded + line="680">whether processing of textures succeeded the #GstGLMixer + line="673">the #GstGLMixer output @GstBuffer + line="674">output @GstBuffer @@ -7256,14 +7449,14 @@ Intended for use within implementations of whether processing of textures succeeded + line="680">whether processing of textures succeeded the #GstGLMixer + line="673">the #GstGLMixer @@ -7282,7 +7475,7 @@ Intended for use within implementations of version="1.24"> Adds the default RGBA pad templates to this class. If you have any special + line="411">Adds the default RGBA pad templates to this class. If you have any special template requirements like a different pad subclass or different supported caps, you should not call this function and add the pad templates yourself manually. @@ -7294,7 +7487,7 @@ manually. the #GstGLMixerClass + line="413">the #GstGLMixerClass @@ -10636,6 +10829,9 @@ with the CPU or with other OpenGL contexts. + set a sync point in the OpenGL command stream @@ -10653,6 +10849,9 @@ with the CPU or with other OpenGL contexts. + the same as @set_sync but called from @context's thread @@ -10670,6 +10869,9 @@ with the CPU or with other OpenGL contexts. + execute a wait on the previously set sync point into the OpenGL command stream @@ -10687,6 +10889,9 @@ with the CPU or with other OpenGL contexts. + the same as @wait but called from @context's thread @@ -10704,6 +10909,9 @@ with the CPU or with other OpenGL contexts. + wait for the previously set sync point to pass from the CPU @@ -10721,6 +10929,9 @@ with the CPU or with other OpenGL contexts. + the same as @wait_cpu but called from @context's thread @@ -10738,6 +10949,9 @@ with the CPU or with other OpenGL contexts. + copy @data into a new #GstGLSyncMeta @@ -10761,6 +10975,9 @@ with the CPU or with other OpenGL contexts. + free @data @@ -10778,6 +10995,9 @@ with the CPU or with other OpenGL contexts. + free @data in @context's thread @@ -10928,11 +11148,11 @@ targets with #GValue's when e.g. dealing with #GstCaps. (`GL_TEXTURE_EXTERNAL_OES`) - + the #GstGLTextureTarget that's equiavalant to @target or + line="813">the #GstGLTextureTarget that's equiavalant to @target or %GST_GL_TEXTURE_TARGET_NONE @@ -10940,18 +11160,18 @@ targets with #GValue's when e.g. dealing with #GstCaps. an OpenGL texture binding target + line="811">an OpenGL texture binding target - + the #GstGLTextureTarget represented by @str or + line="768">the #GstGLTextureTarget represented by @str or %GST_GL_TEXTURE_TARGET_NONE @@ -10959,35 +11179,35 @@ targets with #GValue's when e.g. dealing with #GstCaps. a string equivalent to one of the GST_GL_TEXTURE_TARGET_*_STR values + line="766">a string equivalent to one of the GST_GL_TEXTURE_TARGET_*_STR values - + a string representing the @GstBufferPoolOption specified by @target + line="835">a string representing the @GstBufferPoolOption specified by @target a #GstGLTextureTarget + line="833">a #GstGLTextureTarget - + the OpenGL value for binding the @target with glBindTexture() and + line="791">the OpenGL value for binding the @target with glBindTexture() and similar functions or 0 @@ -10995,25 +11215,25 @@ targets with #GValue's when e.g. dealing with #GstCaps. a #GstGLTextureTarget + line="789">a #GstGLTextureTarget - + the stringified version of @target or %NULL + line="747">the stringified version of @target or %NULL a #GstGLTextureTarget + line="745">a #GstGLTextureTarget @@ -11028,7 +11248,7 @@ targets with #GValue's when e.g. dealing with #GstCaps. glib:type-struct="GLUploadClass"> #GstGLUpload is an object that uploads data from system memory into GL textures. + line="52">#GstGLUpload is an object that uploads data from system memory into GL textures. A #GstGLUpload can be created with gst_gl_upload_new() @@ -11037,14 +11257,14 @@ A #GstGLUpload can be created with gst_gl_upload_new() a new #GstGLUpload object + line="3262">a new #GstGLUpload object a #GstGLContext + line="3260">a #GstGLContext @@ -11056,6 +11276,46 @@ A #GstGLUpload can be created with gst_gl_upload_new() + + Fixate the @othercaps based on the information of the @caps. + + + the fixated caps + + + + + a #GstGLUpload + + + + the pad #GstPadDirection + + + + a #GstCaps as the reference + + + + a #GstCaps to fixate + + + + @@ -11065,7 +11325,7 @@ A #GstGLUpload can be created with gst_gl_upload_new() a #GstGLUpload + line="3470">a #GstGLUpload allow-none="1"> the input #GstCaps + line="3471">the input #GstCaps allow-none="1"> the output #GstCaps + line="3472">the output #GstCaps @@ -11096,26 +11356,26 @@ A #GstGLUpload can be created with gst_gl_upload_new() c:identifier="gst_gl_upload_perform_with_buffer"> Uploads @buffer using the transformation specified by + line="3523">Uploads @buffer using the transformation specified by gst_gl_upload_set_caps() creating a new #GstBuffer in @outbuf_ptr. whether the upload was successful + line="3532">whether the upload was successful a #GstGLUpload + line="3525">a #GstGLUpload input #GstBuffer + line="3526">input #GstBuffer transfer-ownership="full"> resulting #GstBuffer + line="3527">resulting #GstBuffer @@ -11133,7 +11393,7 @@ gst_gl_upload_set_caps() creating a new #GstBuffer in @outbuf_ptr. c:identifier="gst_gl_upload_propose_allocation"> Adds the required allocation parameters to support uploading. + line="3394">Adds the required allocation parameters to support uploading. @@ -11142,7 +11402,7 @@ gst_gl_upload_set_caps() creating a new #GstBuffer in @outbuf_ptr. a #GstGLUpload + line="3396">a #GstGLUpload allow-none="1"> a #GstQuery from a decide allocation + line="3397">a #GstQuery from a decide allocation the proposed allocation query + line="3398">the proposed allocation query @@ -11165,31 +11425,31 @@ gst_gl_upload_set_caps() creating a new #GstBuffer in @outbuf_ptr. Initializes @upload with the information required for upload. + line="3445">Initializes @upload with the information required for upload. whether @in_caps and @out_caps could be set on @upload + line="3453">whether @in_caps and @out_caps could be set on @upload a #GstGLUpload + line="3447">a #GstGLUpload input #GstCaps + line="3448">input #GstCaps output #GstCaps + line="3449">output #GstCaps @@ -11324,41 +11584,41 @@ gst_gl_upload_set_caps() creating a new #GstBuffer in @outbuf_ptr. glib:type-name="GstGLVideoAllocationParams" glib:get-type="gst_gl_video_allocation_params_get_type" c:symbol-prefix="gl_video_allocation_params"> - + the parent #GstGLAllocationParams structure + line="124">the parent #GstGLAllocationParams structure the #GstVideoInfo to allocate + line="125">the #GstVideoInfo to allocate the video plane index to allocate + line="126">the video plane index to allocate the #GstVideoAlignment to align the system representation to (may be %NULL for the default) + line="127">the #GstVideoAlignment to align the system representation to (may be %NULL for the default) the #GstGLTextureTarget to allocate + line="128">the #GstGLTextureTarget to allocate the #GstGLFormat to allocate + line="129">the #GstGLFormat to allocate @@ -11369,7 +11629,7 @@ gst_gl_upload_set_caps() creating a new #GstBuffer in @outbuf_ptr. - + - + line="1343">@gl_handle is defined by the specific OpenGL handle being wrapped For #GstGLMemory and #GstGLMemoryPBO it is an OpenGL texture id. Other memory types may define it to require a different type of parameter. - + - + filename="gst-libs/gst/gl/gstglmemory.c" line="1437">Copy and set any dynamically allocated resources in @dest_vid. Intended for subclass usage only to chain up at the end of a subclass copy function. - + @@ -11743,7 +12003,7 @@ for subclass usage only to chain up at the end of a subclass copy function.Unset and free any dynamically allocated resources. Intended for subclass usage only to chain up at the end of a subclass free function. - + @@ -11764,7 +12024,7 @@ usage only to chain up at the end of a subclass free function. Intended for subclass usage - + + close the connection to the display @@ -12341,19 +12604,19 @@ either be a user visible window (onscreen) or hidden (offscreen). version="1.16"> Checks if @window controls the GL viewport. + line="1119">Checks if @window controls the GL viewport. %TRUE if @window controls the GL viewport, otherwise %FALSE + line="1125">%TRUE if @window controls the GL viewport, otherwise %FALSE a #GstGLWindow + line="1121">a #GstGLWindow @@ -12361,7 +12624,7 @@ either be a user visible window (onscreen) or hidden (offscreen). Redraw the window contents. Implementations should invoke the draw callback. + line="487">Redraw the window contents. Implementations should invoke the draw callback. @@ -12370,24 +12633,27 @@ either be a user visible window (onscreen) or hidden (offscreen). a #GstGLWindow + line="489">a #GstGLWindow + Gets the current windowing system display connection the windowing system display handle for this @window + line="876">the windowing system display handle for this @window a #GstGLWindow + line="874">a #GstGLWindow @@ -12395,18 +12661,23 @@ either be a user visible window (onscreen) or hidden (offscreen). + Gets the current window handle that this #GstGLWindow is + rendering into. This may return a different value to + what is passed into @set_window_handle the window handle we are currently rendering into + line="896">the window handle we are currently rendering into a #GstGLWindow + line="894">a #GstGLWindow @@ -12414,7 +12685,7 @@ either be a user visible window (onscreen) or hidden (offscreen). Tell a @window that it should handle events from the window system. These + line="986">Tell a @window that it should handle events from the window system. These events are forwarded upstream as navigation events. In some window systems events are not propagated in the window hierarchy if a client is listening for them. This method allows you to disable events handling completely @@ -12427,13 +12698,13 @@ from the @window. a #GstGLWindow + line="988">a #GstGLWindow a #gboolean indicating if events should be handled or not. + line="989">a #gboolean indicating if events should be handled or not. @@ -12443,24 +12714,27 @@ from the @window. version="1.18"> Query whether @window has output surface or not + line="735">Query whether @window has output surface or not %TRUE if @window has useable output surface + line="741">%TRUE if @window has useable output surface a #GstGLWindow + line="737">a #GstGLWindow + open the connection to the display @@ -12474,7 +12748,7 @@ from the @window. Queue resizing of @window. + line="1053">Queue resizing of @window. @@ -12483,7 +12757,7 @@ from the @window. a #GstGLWindow + line="1055">a #GstGLWindow @@ -12491,7 +12765,7 @@ from the @window. Quit the runloop's execution. + line="598">Quit the runloop's execution. @@ -12500,7 +12774,7 @@ from the @window. a #GstGLWindow + line="600">a #GstGLWindow @@ -12508,7 +12782,7 @@ from the @window. Start the execution of the runloop. + line="563">Start the execution of the runloop. @@ -12517,7 +12791,7 @@ from the @window. a #GstGLWindow + line="565">a #GstGLWindow @@ -12525,7 +12799,7 @@ from the @window. Invoke @callback with data on the window thread. @callback is guaranteed to + line="669">Invoke @callback with data on the window thread. @callback is guaranteed to have executed when this function returns. @@ -12535,7 +12809,7 @@ have executed when this function returns. a #GstGLWindow + line="671">a #GstGLWindow closure="1"> function to invoke + line="672">function to invoke allow-none="1"> data to invoke @callback with + line="673">data to invoke @callback with @@ -12563,7 +12837,7 @@ have executed when this function returns. version="1.4"> Invoke @callback with @data on the window thread. The callback may not + line="759">Invoke @callback with @data on the window thread. The callback may not have been executed when this function returns. @@ -12573,7 +12847,7 @@ have been executed when this function returns. a #GstGLWindow + line="761">a #GstGLWindow destroy="2"> function to invoke + line="762">function to invoke allow-none="1"> data to invoke @callback with + line="763">data to invoke @callback with called when @data is not needed anymore + line="764">called when @data is not needed anymore @@ -12608,7 +12882,7 @@ have been executed when this function returns. version="1.6"> Set the preferred width and height of the window. Implementations are free + line="512">Set the preferred width and height of the window. Implementations are free to ignore this information. @@ -12618,19 +12892,19 @@ to ignore this information. a #GstGLWindow + line="514">a #GstGLWindow new preferred width + line="515">new preferred width new preferred height + line="516">new preferred height @@ -12639,44 +12913,44 @@ to ignore this information. invoker="set_render_rectangle"> Tell a @window that it should render into a specific region of the window + line="1009">Tell a @window that it should render into a specific region of the window according to the #GstVideoOverlay interface. whether the specified region could be set + line="1020">whether the specified region could be set a #GstGLWindow + line="1011">a #GstGLWindow x position + line="1012">x position y position + line="1013">y position width + line="1014">width height + line="1015">height @@ -12686,7 +12960,7 @@ according to the #GstVideoOverlay interface. version="1.4"> Sets the window that this @window should render into. Some implementations + line="427">Sets the window that this @window should render into. Some implementations require this to be called with a valid handle before drawing can commence. @@ -12696,13 +12970,13 @@ require this to be called with a valid handle before drawing can commence. a #GstGLWindow + line="429">a #GstGLWindow handle to the window + line="430">handle to the window @@ -12710,7 +12984,7 @@ require this to be called with a valid handle before drawing can commence. Present the window to the screen. + line="535">Present the window to the screen. @@ -12719,7 +12993,7 @@ require this to be called with a valid handle before drawing can commence. a #GstGLWindow + line="537">a #GstGLWindow @@ -12729,19 +13003,19 @@ require this to be called with a valid handle before drawing can commence. version="1.16"> Checks if @window controls the GL viewport. + line="1119">Checks if @window controls the GL viewport. %TRUE if @window controls the GL viewport, otherwise %FALSE + line="1125">%TRUE if @window controls the GL viewport, otherwise %FALSE a #GstGLWindow + line="1121">a #GstGLWindow @@ -12749,7 +13023,7 @@ require this to be called with a valid handle before drawing can commence. Redraw the window contents. Implementations should invoke the draw callback. + line="487">Redraw the window contents. Implementations should invoke the draw callback. @@ -12758,7 +13032,7 @@ require this to be called with a valid handle before drawing can commence. a #GstGLWindow + line="489">a #GstGLWindow @@ -12770,14 +13044,14 @@ require this to be called with a valid handle before drawing can commence. the #GstGLContext associated with this @window + line="916">the #GstGLContext associated with this @window a #GstGLWindow + line="914">a #GstGLWindow @@ -12789,14 +13063,14 @@ require this to be called with a valid handle before drawing can commence. the windowing system display handle for this @window + line="876">the windowing system display handle for this @window a #GstGLWindow + line="874">a #GstGLWindow @@ -12812,7 +13086,7 @@ require this to be called with a valid handle before drawing can commence. a #GstGLWindow + line="930">a #GstGLWindow transfer-ownership="full"> resulting surface width + line="931">resulting surface width transfer-ownership="full"> resulting surface height + line="932">resulting surface height @@ -12842,14 +13116,14 @@ require this to be called with a valid handle before drawing can commence. the window handle we are currently rendering into + line="896">the window handle we are currently rendering into a #GstGLWindow + line="894">a #GstGLWindow @@ -12857,7 +13131,7 @@ require this to be called with a valid handle before drawing can commence. Tell a @window that it should handle events from the window system. These + line="986">Tell a @window that it should handle events from the window system. These events are forwarded upstream as navigation events. In some window systems events are not propagated in the window hierarchy if a client is listening for them. This method allows you to disable events handling completely @@ -12870,13 +13144,13 @@ from the @window. a #GstGLWindow + line="988">a #GstGLWindow a #gboolean indicating if events should be handled or not. + line="989">a #gboolean indicating if events should be handled or not. @@ -12886,19 +13160,19 @@ from the @window. version="1.18"> Query whether @window has output surface or not + line="735">Query whether @window has output surface or not %TRUE if @window has useable output surface + line="741">%TRUE if @window has useable output surface a #GstGLWindow + line="737">a #GstGLWindow @@ -12906,7 +13180,7 @@ from the @window. Queue resizing of @window. + line="1053">Queue resizing of @window. @@ -12915,7 +13189,7 @@ from the @window. a #GstGLWindow + line="1055">a #GstGLWindow @@ -12923,7 +13197,7 @@ from the @window. Quit the runloop's execution. + line="598">Quit the runloop's execution. @@ -12932,7 +13206,7 @@ from the @window. a #GstGLWindow + line="600">a #GstGLWindow @@ -12940,7 +13214,7 @@ from the @window. Resize @window to the given @width and @height. + line="1097">Resize @window to the given @width and @height. @@ -12949,19 +13223,19 @@ from the @window. a #GstGLWindow + line="1099">a #GstGLWindow new width + line="1100">new width new height + line="1101">new height @@ -12969,7 +13243,7 @@ from the @window. Start the execution of the runloop. + line="563">Start the execution of the runloop. @@ -12978,7 +13252,7 @@ from the @window. a #GstGLWindow + line="565">a #GstGLWindow @@ -13006,7 +13280,7 @@ from the @window. version="1.4"> Invoke @callback with data on the window thread. @callback is guaranteed to + line="669">Invoke @callback with data on the window thread. @callback is guaranteed to have executed when this function returns. @@ -13016,7 +13290,7 @@ have executed when this function returns. a #GstGLWindow + line="671">a #GstGLWindow closure="1"> function to invoke + line="672">function to invoke allow-none="1"> data to invoke @callback with + line="673">data to invoke @callback with @@ -13044,7 +13318,7 @@ have executed when this function returns. version="1.4"> Invoke @callback with @data on the window thread. The callback may not + line="759">Invoke @callback with @data on the window thread. The callback may not have been executed when this function returns. @@ -13054,7 +13328,7 @@ have been executed when this function returns. a #GstGLWindow + line="761">a #GstGLWindow destroy="2"> function to invoke + line="762">function to invoke allow-none="1"> data to invoke @callback with + line="763">data to invoke @callback with called when @data is not needed anymore + line="764">called when @data is not needed anymore @@ -13113,7 +13387,7 @@ have been executed when this function returns. version="1.18"> Notify a @window about a scroll event. A scroll signal holding the event + line="964">Notify a @window about a scroll event. A scroll signal holding the event coordinates will be emitted. @@ -13123,31 +13397,31 @@ coordinates will be emitted. a #GstGLWindow + line="966">a #GstGLWindow x position of the mouse cursor + line="967">x position of the mouse cursor y position of the mouse cursor + line="968">y position of the mouse cursor the x offset of the scroll event + line="969">the x offset of the scroll event the y offset of the scroll event + line="970">the y offset of the scroll event @@ -13157,7 +13431,7 @@ coordinates will be emitted. version="1.4"> Sets the callback called when the window is about to close. + line="843">Sets the callback called when the window is about to close. @@ -13166,7 +13440,7 @@ coordinates will be emitted. a #GstGLWindow + line="845">a #GstGLWindow destroy="2"> function to invoke + line="846">function to invoke allow-none="1"> data to invoke @callback with + line="847">data to invoke @callback with scope="async"> called when @data is not needed any more + line="848">called when @data is not needed any more @@ -13203,7 +13477,7 @@ coordinates will be emitted. version="1.4"> Sets the draw callback called every time gst_gl_window_draw() is called + line="785">Sets the draw callback called every time gst_gl_window_draw() is called @@ -13212,7 +13486,7 @@ coordinates will be emitted. a #GstGLWindow + line="787">a #GstGLWindow destroy="2"> function to invoke + line="788">function to invoke allow-none="1"> data to invoke @callback with + line="789">data to invoke @callback with scope="async"> called when @data is not needed any more + line="790">called when @data is not needed any more @@ -13249,7 +13523,7 @@ coordinates will be emitted. version="1.6"> Set the preferred width and height of the window. Implementations are free + line="512">Set the preferred width and height of the window. Implementations are free to ignore this information. @@ -13259,19 +13533,19 @@ to ignore this information. a #GstGLWindow + line="514">a #GstGLWindow new preferred width + line="515">new preferred width new preferred height + line="516">new preferred height @@ -13280,44 +13554,44 @@ to ignore this information. c:identifier="gst_gl_window_set_render_rectangle"> Tell a @window that it should render into a specific region of the window + line="1009">Tell a @window that it should render into a specific region of the window according to the #GstVideoOverlay interface. whether the specified region could be set + line="1020">whether the specified region could be set a #GstGLWindow + line="1011">a #GstGLWindow x position + line="1012">x position y position + line="1013">y position width + line="1014">width height + line="1015">height @@ -13327,7 +13601,7 @@ according to the #GstVideoOverlay interface. version="1.4"> Sets the resize callback called every time a resize of the window occurs. + line="814">Sets the resize callback called every time a resize of the window occurs. @@ -13336,7 +13610,7 @@ according to the #GstVideoOverlay interface. a #GstGLWindow + line="816">a #GstGLWindow destroy="2"> function to invoke + line="817">function to invoke allow-none="1"> data to invoke @callback with + line="818">data to invoke @callback with scope="async"> called when @data is not needed any more + line="819">called when @data is not needed any more @@ -13373,7 +13647,7 @@ according to the #GstVideoOverlay interface. version="1.4"> Sets the window that this @window should render into. Some implementations + line="427">Sets the window that this @window should render into. Some implementations require this to be called with a valid handle before drawing can commence. @@ -13383,13 +13657,13 @@ require this to be called with a valid handle before drawing can commence. a #GstGLWindow + line="429">a #GstGLWindow handle to the window + line="430">handle to the window @@ -13397,7 +13671,7 @@ require this to be called with a valid handle before drawing can commence. Present the window to the screen. + line="535">Present the window to the screen. @@ -13406,7 +13680,7 @@ require this to be called with a valid handle before drawing can commence. a #GstGLWindow + line="537">a #GstGLWindow @@ -13594,26 +13868,32 @@ direct handle comparision. + Gets the current windowing system display connection the windowing system display handle for this @window + line="876">the windowing system display handle for this @window a #GstGLWindow + line="874">a #GstGLWindow + Set a window handle to render into @@ -13624,39 +13904,47 @@ direct handle comparision. a #GstGLWindow + line="429">a #GstGLWindow handle to the window + line="430">handle to the window + Gets the current window handle that this #GstGLWindow is + rendering into. This may return a different value to + what is passed into @set_window_handle the window handle we are currently rendering into + line="896">the window handle we are currently rendering into a #GstGLWindow + line="894">a #GstGLWindow + redraw the window with the specified dimensions @@ -13667,13 +13955,16 @@ direct handle comparision. a #GstGLWindow + line="489">a #GstGLWindow + run the mainloop @@ -13684,13 +13975,16 @@ direct handle comparision. a #GstGLWindow + line="565">a #GstGLWindow + send a quit to the mainloop @@ -13701,13 +13995,16 @@ direct handle comparision. a #GstGLWindow + line="600">a #GstGLWindow + invoke a function on the window thread. Required to be reentrant. @@ -13718,7 +14015,7 @@ direct handle comparision. a #GstGLWindow + line="671">a #GstGLWindow closure="2"> function to invoke + line="672">function to invoke allow-none="1"> data to invoke @callback with + line="673">data to invoke @callback with + invoke a function on the window thread. @run may or may + not have been called. Required to be reentrant. @@ -13753,7 +14054,7 @@ direct handle comparision. a #GstGLWindow + line="761">a #GstGLWindow destroy="3"> function to invoke + line="762">function to invoke allow-none="1"> data to invoke @callback with + line="763">data to invoke @callback with called when @data is not needed anymore + line="764">called when @data is not needed anymore + open the connection to the display @@ -13799,6 +14103,9 @@ direct handle comparision. + close the connection to the display @@ -13813,6 +14120,11 @@ direct handle comparision. + whether to handle 'extra' events from the windowing system. + Basic events like surface moves and resizes are still valid + things to listen for. @@ -13823,19 +14135,23 @@ direct handle comparision. a #GstGLWindow + line="988">a #GstGLWindow a #gboolean indicating if events should be handled or not. + line="989">a #gboolean indicating if events should be handled or not. + request that the window change surface size. The + implementation is free to ignore this information. @@ -13846,25 +14162,28 @@ direct handle comparision. a #GstGLWindow + line="514">a #GstGLWindow new preferred width + line="515">new preferred width new preferred height + line="516">new preferred height + request that the window be shown to the user @@ -13875,57 +14194,63 @@ direct handle comparision. a #GstGLWindow + line="537">a #GstGLWindow + request a rectangle to render into. See #GstVideoOverlay whether the specified region could be set + line="1020">whether the specified region could be set a #GstGLWindow + line="1011">a #GstGLWindow x position + line="1012">x position y position + line="1013">y position width + line="1014">width height + line="1015">height + request a resize to occur when possible @@ -13936,47 +14261,54 @@ direct handle comparision. a #GstGLWindow + line="1055">a #GstGLWindow + Whether the window takes care of glViewport setup. + and the user does not need to deal with viewports %TRUE if @window controls the GL viewport, otherwise %FALSE + line="1125">%TRUE if @window controls the GL viewport, otherwise %FALSE a #GstGLWindow + line="1121">a #GstGLWindow + Whether the window has output surface or not. (Since: 1.18) %TRUE if @window has useable output surface + line="741">%TRUE if @window has useable output surface a #GstGLWindow + line="737">a #GstGLWindow @@ -14091,7 +14423,7 @@ user-defined purposes. c:type="GST_GL_ALLOCATION_PARAMS_ALLOC_FLAG_VIDEO"> GL allocation flag indicating the allocation of 2D video frames + line="115">GL allocation flag indicating the allocation of 2D video frames @@ -14489,7 +14821,7 @@ user-defined purposes. The currently supported formats that can be converted + line="101">The currently supported formats that can be converted @@ -14511,7 +14843,7 @@ user-defined purposes. c:type="GST_GL_COLOR_CONVERT_VIDEO_CAPS"> The currently supported #GstCaps that can be converted + line="113">The currently supported #GstCaps that can be converted @@ -14673,8 +15005,8 @@ e.g. for `CONFIG_ID`: `GST_GL_CONFIG_ATTRIB_NAME (CONFIG_ID)` c:type="GST_GL_DISPLAY_CONTEXT_TYPE"> The name used in #GstContext queries for requesting a #GstGLDisplay - + line="164">The name used in #GstContext queries for requesting a #GstGLDisplay + c:type="GST_GL_MEMORY_ALLOCATOR_NAME"> The name of the GL memory allocator + line="249">The name of the GL memory allocator @@ -14843,18 +15175,18 @@ e.g. for `CONFIG_ID`: `GST_GL_CONFIG_ATTRIB_NAME (CONFIG_ID)` List of video formats that are supported by #GstGLMemory + line="63">List of video formats that are supported by #GstGLMemory @@ -15698,14 +16030,36 @@ you are writing to OpenGL. Conversely, combining #GST_MAP_GL with the currently set #GstGLAllocationParams or %NULL + line="501">the currently set #GstGLAllocationParams or %NULL a buffer pool config + line="499">a buffer pool config + + + + + + See gst_buffer_pool_config_set_gl_min_free_queue_size(). + + + then number of buffers configured the free queue + + + + + a buffer pool config @@ -15714,7 +16068,7 @@ you are writing to OpenGL. Conversely, combining #GST_MAP_GL with c:identifier="gst_buffer_pool_config_set_gl_allocation_params"> Sets @params on @config + line="515">Sets @params on @config @@ -15723,7 +16077,7 @@ you are writing to OpenGL. Conversely, combining #GST_MAP_GL with a buffer pool config + line="517">a buffer pool config a #GstGLAllocationParams + line="518">a #GstGLAllocationParams + + Instructs the #GstGLBufferPool to keep @queue_size amount of buffers around +before allowing them for reuse. + +This is helpful to allow GPU processing to complete before the CPU +operations on the same buffer could start. Particularly useful when +uploading or downloading data to/from the GPU. + +A value of 0 disabled this functionality. + +This value must be less than the configured maximum amount of buffers for +this @config. + + + + + + + a buffer pool config + + + + the number of buffers + + + + - + Whether @display was in @context + line="598">Whether @display was in @context a #GstContext + line="595">a #GstContext resulting #GstGLDisplay + line="596">resulting #GstGLDisplay @@ -15774,8 +16163,8 @@ you are writing to OpenGL. Conversely, combining #GST_MAP_GL with version="1.4"> Sets @display on @context - + line="567">Sets @display on @context + @@ -15783,7 +16172,7 @@ you are writing to OpenGL. Conversely, combining #GST_MAP_GL with a #GstContext + line="569">a #GstContext resulting #GstGLDisplay + line="570">resulting #GstGLDisplay @@ -15996,7 +16385,7 @@ multiple times. This must be called before any other #GstGLBuffer operation. - + @@ -16005,7 +16394,7 @@ multiple times. This must be called before any other #GstGLBuffer operation. - + @@ -16115,11 +16504,11 @@ The returned #GstGLContext will be shared with a GStreamer created OpenGL contex c:identifier="gst_gl_format_is_supported" moved-to="GLFormat.is_supported" version="1.16"> - + Whether @format is supported by @context based on the OpenGL API, + line="672">Whether @format is supported by @context based on the OpenGL API, version, or available OpenGL extension/s. @@ -16127,13 +16516,33 @@ The returned #GstGLContext will be shared with a GStreamer created OpenGL contex a #GstGLContext + line="669">a #GstGLContext the #GstGLFormat to check is supported by @context + line="670">the #GstGLFormat to check is supported by @context + + + + + + + + the number of components in a #GstGLFormat + + + + + the #GstGLFormat @@ -16144,7 +16553,7 @@ The returned #GstGLContext will be shared with a GStreamer created OpenGL contex version="1.16"> Get the unsized format and type from @format for usage in glReadPixels, + line="369">Get the unsized format and type from @format for usage in glReadPixels, glTex{Sub}Image*, glTexImage* and similar functions. @@ -16154,7 +16563,7 @@ glTex{Sub}Image*, glTexImage* and similar functions. the sized internal #GstGLFormat + line="371">the sized internal #GstGLFormat transfer-ownership="full"> location for the resulting unsized #GstGLFormat + line="372">location for the resulting unsized #GstGLFormat transfer-ownership="full"> location for the resulting GL type + line="373">location for the resulting GL type @@ -16447,7 +16856,7 @@ debug category to be at least %GST_LEVEL_FIXME. filename="gst-libs/gst/gl/gstglmemory.c" line="1135">Initializes the GL Base Texture allocator. It is safe to call this function multiple times. This must be called before any other GstGLMemory operation. - + @@ -16465,7 +16874,7 @@ multiple times. This must be called before any other GstGLMemory operation. - + the sized internal format specified by @format and @type that can + line="291">the sized internal format specified by @format and @type that can be used in @context @@ -16803,19 +17212,19 @@ NDC coordinates in @matrix. a #GstGLContext + line="287">a #GstGLContext an OpenGL format, `GL_RGBA`, `GL_LUMINANCE`, etc + line="288">an OpenGL format, `GL_RGBA`, `GL_LUMINANCE`, etc an OpenGL type, `GL_UNSIGNED_BYTE`, `GL_FLOAT`, etc + line="289">an OpenGL type, `GL_UNSIGNED_BYTE`, `GL_FLOAT`, etc @@ -16828,6 +17237,42 @@ NDC coordinates in @matrix. + + Given @swizzle, produce @inversion such that: + +@swizzle[@inversion[i]] == identity[i] where: +- identity = {0, 1, 2,...} +- unset fields are marked by -1 + + + + + + + input swizzle + + + + + + resulting inversion + + + + + + @@ -16846,11 +17291,11 @@ NDC coordinates in @matrix. - + the #GstGLTextureTarget that's equiavalant to @target or + line="813">the #GstGLTextureTarget that's equiavalant to @target or %GST_GL_TEXTURE_TARGET_NONE @@ -16858,7 +17303,7 @@ NDC coordinates in @matrix. an OpenGL texture binding target + line="811">an OpenGL texture binding target @@ -16866,11 +17311,11 @@ NDC coordinates in @matrix. - + the #GstGLTextureTarget represented by @str or + line="768">the #GstGLTextureTarget represented by @str or %GST_GL_TEXTURE_TARGET_NONE @@ -16878,7 +17323,7 @@ NDC coordinates in @matrix. a string equivalent to one of the GST_GL_TEXTURE_TARGET_*_STR values + line="766">a string equivalent to one of the GST_GL_TEXTURE_TARGET_*_STR values @@ -16886,18 +17331,18 @@ NDC coordinates in @matrix. - + a string representing the @GstBufferPoolOption specified by @target + line="835">a string representing the @GstBufferPoolOption specified by @target a #GstGLTextureTarget + line="833">a #GstGLTextureTarget @@ -16905,11 +17350,11 @@ NDC coordinates in @matrix. - + the OpenGL value for binding the @target with glBindTexture() and + line="791">the OpenGL value for binding the @target with glBindTexture() and similar functions or 0 @@ -16917,7 +17362,7 @@ NDC coordinates in @matrix. a #GstGLTextureTarget + line="789">a #GstGLTextureTarget @@ -16925,18 +17370,18 @@ NDC coordinates in @matrix. - + the stringified version of @target or %NULL + line="747">the stringified version of @target or %NULL a #GstGLTextureTarget + line="745">a #GstGLTextureTarget @@ -17045,6 +17490,48 @@ NDC coordinates in @matrix. + + Calculates the swizzle indices for @video_format and @gl_format in order to +access a texture such that accessing a texel from a texture through the swizzle +index produces values in the order (R, G, B, A) or (Y, U, V, A). + +For multi-planer formats, the swizzle index uses the same component order (RGBA/YUVA) +and should be applied after combining multiple planes into a single rgba/yuva value. +e.g. sampling from a NV12 format would have Y from one texture and UV from +another texture into a (Y, U, V) value. Add an Aplha component and then +perform swizzling. Sampling from NV21 would produce (Y, V, U) which is then +swizzled to (Y, U, V). + + + whether valid swizzle indices could be found + + + + + the #GstVideoFormat in use + + + + the returned swizzle indices + + + + + + @@ -17306,7 +17793,7 @@ formats. - + + line="113"/> @@ -200,7 +200,7 @@ with RG format etc. c:identifier="gst_egl_image_from_dmabuf_direct"> Creates an EGL image that imports the dmabuf FD. The dmabuf data + line="1001">Creates an EGL image that imports the dmabuf FD. The dmabuf data is passed directly as the format described in in_info. This is useful if the hardware is capable of performing color space conversions internally. The appropriate DRM format is picked, and the EGL image @@ -210,36 +210,36 @@ Another notable difference to gst_egl_image_from_dmabuf() is that this function creates one EGL image for all planes, not one for a single plane. + line="93"/> a #GstEGLImage wrapping @dmabuf or %NULL on failure + line="1018">a #GstEGLImage wrapping @dmabuf or %NULL on failure a #GstGLContext (must be an EGL context) + line="1003">a #GstGLContext (must be an EGL context) Array of DMABuf file descriptors + line="1004">Array of DMABuf file descriptors Array of offsets, relative to the DMABuf + line="1005">Array of offsets, relative to the DMABuf the #GstVideoInfo + line="1006">the #GstVideoInfo @@ -249,7 +249,7 @@ a single plane. version="1.18"> Creates an EGL image that imports the dmabuf FD. The dmabuf data + line="793">Creates an EGL image that imports the dmabuf FD. The dmabuf data is passed directly as the format described in @in_info. This is useful if the hardware is capable of performing color space conversions internally. The appropriate DRM format is picked, and the EGL image @@ -259,42 +259,42 @@ Another notable difference to gst_egl_image_from_dmabuf() is that this function creates one EGL image for all planes, not one for a single plane. + line="98"/> a #GstEGLImage wrapping @dmabuf or %NULL on failure + line="811">a #GstEGLImage wrapping @dmabuf or %NULL on failure a #GstGLContext (must be an EGL context) + line="795">a #GstGLContext (must be an EGL context) Array of DMABuf file descriptors + line="796">Array of DMABuf file descriptors Array of offsets, relative to the DMABuf + line="797">Array of offsets, relative to the DMABuf the #GstVideoInfo + line="798">the #GstVideoInfo GL texture target this GstEGLImage is intended for + line="799">GL texture target this GstEGLImage is intended for @@ -304,109 +304,60 @@ a single plane. version="1.24"> Creates an EGL image that imports the dmabuf FD. The dmabuf data is passed + line="830">Creates an EGL image that imports the dmabuf FD. The dmabuf data is passed directly as the format described in @in_info. This is useful if the hardware is capable of performing color space conversions internally. Another notable difference to gst_egl_image_from_dmabuf() is that this function creates one EGL image for all planes, not one for a single plane. + line="105"/> a #GstEGLImage wrapping @dmabuf or %NULL on failure + line="846">a #GstEGLImage wrapping @dmabuf or %NULL on failure a #GstGLContext (must be an EGL context) + line="832">a #GstGLContext (must be an EGL context) + + number of planes (obtained from a #GstVideoMeta) + + Array of DMABuf file descriptors + line="834">Array of DMABuf file descriptors Array of offsets, relative to the DMABuf + line="835">Array of offsets, relative to the DMABuf the #GstVideoInfoDmaDrm + line="836">the #GstVideoInfoDmaDrm GL texture target this GstEGLImage is intended for + line="837">GL texture target this GstEGLImage is intended for - - Creates an EGL image that imports the dmabuf FD. The dmabuf data -is passed as RGBA data. Shaders later take this "RGBA" data and -convert it from its true format (described by in_info) to actual -RGBA output. For example, with I420, three EGL images are created, -one for each @plane, each EGL image with a single-channel R format. -With NV12, two EGL images are created, one with R format, one -with RG format etc. User can specify the modifier in @in_info_dma -for non-linear dmabuf. - - - a #GstEGLImage wrapping @dmabuf or %NULL on failure - - - - - a #GstGLContext (must be an EGL context) - - - - the DMA-Buf file descriptor - - - - the #GstVideoInfoDmaDrm in @dmabuf - - - - the plane in @in_info to create and #GstEGLImage for - - - - the byte-offset in the data - - - - @@ -499,20 +450,36 @@ through the provided API Create a new #GstGLDisplayEGL using the default EGL_DEFAULT_DISPLAY. + line="254">Create a new #GstGLDisplayEGL using the default EGL_DEFAULT_DISPLAY. a new #GstGLDisplayEGL or %NULL + line="259">a new #GstGLDisplayEGL or %NULL + + + + + Create a new surfaceless #GstGLDisplayEGL using the Mesa3D +EGL_PLATFORM_SURFACELESS_MESA extension. + + + a new #GstGLDisplayEGL or %NULL + line="73"/> @@ -530,23 +497,23 @@ through the provided API version="1.12"> Creates a EGL display connection from a native Display. + line="353">Creates a EGL display connection from a native Display. This function will return the same value for multiple calls with the same @display. + line="76"/> a new #GstGLDisplayEGL + line="362">a new #GstGLDisplayEGL an existing #GstGLDisplay + line="355">an existing #GstGLDisplay @@ -557,10 +524,10 @@ This function will return the same value for multiple calls with the same Attempts to create a new `EGLDisplay` from @display. If @type is -%GST_GL_DISPLAY_TYPE_ANY, then @display must be 0. @type must not be -%GST_GL_DISPLAY_TYPE_NONE. +%GST_GL_DISPLAY_TYPE_ANY or %GST_GL_DISPLAY_TYPE_EGL_SURFACELESS, then +@display must be 0. @type must not be %GST_GL_DISPLAY_TYPE_NONE. + line="79"/> + line="81"/> moved-to="EGLImage.from_dmabuf_direct"> Creates an EGL image that imports the dmabuf FD. The dmabuf data + line="1001">Creates an EGL image that imports the dmabuf FD. The dmabuf data is passed directly as the format described in in_info. This is useful if the hardware is capable of performing color space conversions internally. The appropriate DRM format is picked, and the EGL image @@ -1090,36 +1057,36 @@ is created with this DRM format. Another notable difference to gst_egl_image_from_dmabuf() is that this function creates one EGL image for all planes, not one for a single plane. - + a #GstEGLImage wrapping @dmabuf or %NULL on failure + line="1018">a #GstEGLImage wrapping @dmabuf or %NULL on failure a #GstGLContext (must be an EGL context) + line="1003">a #GstGLContext (must be an EGL context) Array of DMABuf file descriptors + line="1004">Array of DMABuf file descriptors Array of offsets, relative to the DMABuf + line="1005">Array of offsets, relative to the DMABuf the #GstVideoInfo + line="1006">the #GstVideoInfo @@ -1130,7 +1097,7 @@ a single plane. version="1.18"> Creates an EGL image that imports the dmabuf FD. The dmabuf data + line="793">Creates an EGL image that imports the dmabuf FD. The dmabuf data is passed directly as the format described in @in_info. This is useful if the hardware is capable of performing color space conversions internally. The appropriate DRM format is picked, and the EGL image @@ -1139,43 +1106,42 @@ is created with this DRM format. Another notable difference to gst_egl_image_from_dmabuf() is that this function creates one EGL image for all planes, not one for a single plane. - + a #GstEGLImage wrapping @dmabuf or %NULL on failure + line="811">a #GstEGLImage wrapping @dmabuf or %NULL on failure a #GstGLContext (must be an EGL context) + line="795">a #GstGLContext (must be an EGL context) Array of DMABuf file descriptors + line="796">Array of DMABuf file descriptors Array of offsets, relative to the DMABuf + line="797">Array of offsets, relative to the DMABuf the #GstVideoInfo + line="798">the #GstVideoInfo GL texture target this GstEGLImage is intended for + line="799">GL texture target this GstEGLImage is intended for @@ -1186,109 +1152,60 @@ a single plane. version="1.24"> Creates an EGL image that imports the dmabuf FD. The dmabuf data is passed + line="830">Creates an EGL image that imports the dmabuf FD. The dmabuf data is passed directly as the format described in @in_info. This is useful if the hardware is capable of performing color space conversions internally. Another notable difference to gst_egl_image_from_dmabuf() is that this function creates one EGL image for all planes, not one for a single plane. + line="105"/> a #GstEGLImage wrapping @dmabuf or %NULL on failure + line="846">a #GstEGLImage wrapping @dmabuf or %NULL on failure a #GstGLContext (must be an EGL context) + line="832">a #GstGLContext (must be an EGL context) + + number of planes (obtained from a #GstVideoMeta) + + Array of DMABuf file descriptors + line="834">Array of DMABuf file descriptors Array of offsets, relative to the DMABuf + line="835">Array of offsets, relative to the DMABuf the #GstVideoInfoDmaDrm + line="836">the #GstVideoInfoDmaDrm GL texture target this GstEGLImage is intended for + line="837">GL texture target this GstEGLImage is intended for - - Creates an EGL image that imports the dmabuf FD. The dmabuf data -is passed as RGBA data. Shaders later take this "RGBA" data and -convert it from its true format (described by in_info) to actual -RGBA output. For example, with I420, three EGL images are created, -one for each @plane, each EGL image with a single-channel R format. -With NV12, two EGL images are created, one with R format, one -with RG format etc. User can specify the modifier in @in_info_dma -for non-linear dmabuf. - - - a #GstEGLImage wrapping @dmabuf or %NULL on failure - - - - - a #GstGLContext (must be an EGL context) - - - - the DMA-Buf file descriptor - - - - the #GstVideoInfoDmaDrm in @dmabuf - - - - the plane in @in_info to create and #GstEGLImage for - - - - the byte-offset in the data - - - - @@ -1338,8 +1255,8 @@ multiple times. This must be called before any other GstGLMemoryEGL operation.< #GstGLDisplayEGL represents a connection to an EGL `EGLDisplay` handle created -internally (gst_gl_display_egl_new()) or wrapped by the application -(gst_gl_display_egl_new_with_egl_display()) +internally (gst_gl_display_egl_new() or gst_gl_display_egl_new_surfaceless()) +or wrapped by the application (gst_gl_display_egl_new_with_egl_display()) +this callback GstInsertBinCallback(). + +Apart from the library API, since 1.24 insertbin can also be found in the +registry: + +``` C + GstElement *pipeline, *insertbin, *videoflip; + + gst_init (NULL, NULL); + pipeline = + gst_parse_launch ("videotestsrc ! insertbin name=i ! autovideosink", + NULL); + + ... + + insertbin = gst_bin_get_by_name (GST_BIN (pipeline), "i"); + videoflip = gst_element_factory_make ("videoflip", NULL); + + ... + + g_object_set (videoflip, "method", 1, NULL); + g_signal_emit_by_name (insertbin, "append", videoflip, NULL, NULL); + + ... +``` + line="99"/> Creates a new #GstInsertBin + line="1058">Creates a new #GstInsertBin + line="105"/> The new #GstInsertBin + line="1064">The new #GstInsertBin @@ -107,7 +131,7 @@ this callback GstInsertBinCallback(). allow-none="1"> The name of the new #GstInsertBin element (or %NULL) + line="1060">The name of the new #GstInsertBin element (or %NULL) @@ -115,12 +139,12 @@ this callback GstInsertBinCallback(). This action signal adds the filter like element after any other element + line="910">This action signal adds the filter like element after any other element in the bin. Same as the #GstInsertBin::append signal. + line="112"/> @@ -131,7 +155,7 @@ Same as the #GstInsertBin::append signal. the #GstElement to add + line="912">the #GstElement to add closure="2"> the callback to call when the element has been + line="913">the callback to call when the element has been added or not, or %NULL @@ -150,7 +174,7 @@ Same as the #GstInsertBin::append signal. allow-none="1"> The data to pass to the callback + line="915">The data to pass to the callback @@ -160,12 +184,12 @@ Same as the #GstInsertBin::append signal. version="1.2"> This action signal adds the filter like element after the @sibling + line="961">This action signal adds the filter like element after the @sibling element in the bin. Same as the #GstInsertBin::insert-after signal. + line="121"/> @@ -176,13 +200,13 @@ Same as the #GstInsertBin::insert-after signal. the #GstElement to add + line="963">the #GstElement to add the #GstElement to add @element after + line="964">the #GstElement to add @element after closure="3"> the callback to call when the element has been + line="965">the callback to call when the element has been added or not, or %NULL @@ -201,7 +225,7 @@ Same as the #GstInsertBin::insert-after signal. allow-none="1"> The data to pass to the callback + line="967">The data to pass to the callback @@ -211,12 +235,12 @@ Same as the #GstInsertBin::insert-after signal. version="1.2"> This action signal adds the filter like element before the @sibling + line="935">This action signal adds the filter like element before the @sibling element in the bin. Same as the #GstInsertBin::insert-before signal. + line="116"/> @@ -227,13 +251,13 @@ Same as the #GstInsertBin::insert-before signal. the #GstElement to add + line="937">the #GstElement to add the #GstElement to add @element before + line="938">the #GstElement to add @element before closure="3"> the callback to call when the element has been + line="939">the callback to call when the element has been added or not, or %NULL @@ -252,7 +276,7 @@ Same as the #GstInsertBin::insert-before signal. allow-none="1"> The data to pass to the callback + line="941">The data to pass to the callback @@ -262,12 +286,12 @@ Same as the #GstInsertBin::insert-before signal. version="1.2"> This action signal adds the filter like element before any other element + line="885">This action signal adds the filter like element before any other element in the bin. Same as the #GstInsertBin::prepend signal. + line="108"/> @@ -278,7 +302,7 @@ Same as the #GstInsertBin::prepend signal. the #GstElement to add + line="887">the #GstElement to add closure="2"> the callback to call when the element has been + line="888">the callback to call when the element has been added or not, or %NULL @@ -297,7 +321,7 @@ Same as the #GstInsertBin::prepend signal. allow-none="1"> The data to pass to the callback + line="890">The data to pass to the callback @@ -305,11 +329,11 @@ Same as the #GstInsertBin::prepend signal. This action signal removed the filter like element from the bin. + line="987">This action signal removed the filter like element from the bin. Same as the #GstInsertBin::remove signal. + line="126"/> @@ -320,7 +344,7 @@ Same as the #GstInsertBin::remove signal. the #GstElement to remove + line="989">the #GstElement to remove closure="2"> the callback to call when the element has been + line="990">the callback to call when the element has been removed or not, or %NULL @@ -339,7 +363,7 @@ Same as the #GstInsertBin::remove signal. allow-none="1"> The data to pass to the callback + line="992">The data to pass to the callback @@ -350,10 +374,10 @@ Same as the #GstInsertBin::remove signal. - + This action signal adds the filter like element after any other element + line="189">This action signal adds the filter like element after any other element in the bin. Same as gst_insert_bin_append() @@ -364,7 +388,7 @@ Same as gst_insert_bin_append() the callback to call when the element has been added or not, or + line="192">the callback to call when the element has been added or not, or %NULL @@ -374,7 +398,7 @@ Same as gst_insert_bin_append() allow-none="1"> The data to pass to the callback + line="194">The data to pass to the callback allow-none="1"> The user data of the signal (ignored) + line="195">The user data of the signal (ignored) - + This action signal adds the filter like element after the @sibling + line="235">This action signal adds the filter like element after the @sibling element in the bin. element in the bin. @@ -403,13 +427,13 @@ Same as gst_insert_bin_insert_after() the #GstElement to add @element after + line="238">the #GstElement to add @element after the callback to call when the element has been added or not, or + line="239">the callback to call when the element has been added or not, or %NULL @@ -419,7 +443,7 @@ Same as gst_insert_bin_insert_after() allow-none="1"> The data to pass to the callback + line="241">The data to pass to the callback allow-none="1"> The user data of the signal (ignored) + line="242">The user data of the signal (ignored) - + This action signal adds the filter like element before the @sibling + line="211">This action signal adds the filter like element before the @sibling element in the bin. Same as gst_insert_bin_insert_before() @@ -447,13 +471,13 @@ Same as gst_insert_bin_insert_before() the #GstElement to add @element before + line="214">the #GstElement to add @element before the callback to call when the element has been added or not, or + line="215">the callback to call when the element has been added or not, or %NULL @@ -463,7 +487,7 @@ Same as gst_insert_bin_insert_before() allow-none="1"> The data to pass to the callback + line="217">The data to pass to the callback allow-none="1"> The user data of the signal (ignored) + line="218">The user data of the signal (ignored) - + This action signal adds the filter like element before any other element + line="167">This action signal adds the filter like element before any other element in the bin. Same as gst_insert_bin_prepend() @@ -491,7 +515,7 @@ Same as gst_insert_bin_prepend() the callback to call when the element has been added or not, or + line="170">the callback to call when the element has been added or not, or %NULL @@ -501,7 +525,7 @@ Same as gst_insert_bin_prepend() allow-none="1"> The data to pass to the callback + line="172">The data to pass to the callback allow-none="1"> The user data of the signal (ignored) + line="173">The user data of the signal (ignored) - + This action signal removed the filter like element from the bin. + line="260">This action signal removed the filter like element from the bin. Same as gst_insert_bin_remove() @@ -528,7 +552,7 @@ Same as gst_insert_bin_remove() the callback to call when the element has been removed or not, + line="263">the callback to call when the element has been removed or not, or %NULL @@ -538,7 +562,7 @@ or %NULL allow-none="1"> The data to pass to the callback + line="265">The data to pass to the callback allow-none="1"> The user data of the signal (ignored) + line="266">The user data of the signal (ignored) - + This is the prototype of callbacks to be called when the operation completes. It could be called at any time, including as a re-entrant call while the operation is requested. + line="69"/> @@ -597,12 +623,13 @@ operation is requested. + glib:is-gtype-struct-for="InsertBin" + version="1.2"> The object class structure. + line="89">The object class structure. + line="99"/> diff --git a/girs/GstMpegts-1.0.gir b/girs/GstMpegts-1.0.gir index cde45a0bb..a6aa6c433 100644 --- a/girs/GstMpegts-1.0.gir +++ b/girs/GstMpegts-1.0.gir @@ -1591,7 +1591,7 @@ Consult the relevant specifications for more details. The #GstMpegtsDVBLinkageEvent or %NULL if an error happened + line="859">The #GstMpegtsDVBLinkageEvent or %NULL if an error happened @@ -1599,7 +1599,7 @@ Consult the relevant specifications for more details. the #GstMpegtsDVBLinkageDescriptor + line="857">the #GstMpegtsDVBLinkageDescriptor @@ -1612,7 +1612,7 @@ Consult the relevant specifications for more details. an #GstMpegtsDVBLinkageExtendedEvent array or %NULL if an error happened + line="876">an #GstMpegtsDVBLinkageExtendedEvent array or %NULL if an error happened @@ -1621,7 +1621,7 @@ Consult the relevant specifications for more details. the #GstMpegtsDVBLinkageDescriptor + line="874">the #GstMpegtsDVBLinkageDescriptor @@ -1634,7 +1634,7 @@ Consult the relevant specifications for more details. The #GstMpegtsDVBLinkageMobileHandOver or %NULL if an error happened + line="842">The #GstMpegtsDVBLinkageMobileHandOver or %NULL if an error happened @@ -1642,7 +1642,7 @@ Consult the relevant specifications for more details. the #GstMpegtsDVBLinkageDescriptor + line="840">the #GstMpegtsDVBLinkageDescriptor @@ -2092,29 +2092,29 @@ As specified in Table 100 of ETSI EN 300 468 v1.13.1 For more details, refer to the ITU H.222.0 or ISO/IEC 13818-1 specifications and other specifications mentioned in the documentation. + line="201"/> the type of descriptor + line="183">the type of descriptor the extended type (if @descriptor_tag is 0x7f) + line="184">the extended type (if @descriptor_tag is 0x7f) the length of the descriptor content (excluding tag/length field) + line="185">the length of the descriptor content (excluding tag/length field) the full descriptor data (including tag, extension, length). The first + line="186">the full descriptor data (including tag, extension, length). The first two bytes are the @tag and @length. @@ -2128,7 +2128,7 @@ two bytes are the @tag and @length. filename="gst-libs/gst/mpegts/gstmpegtsdescriptor.c" line="709">Frees @desc + line="204"/> @@ -2146,20 +2146,20 @@ two bytes are the @tag and @length. version="1.20"> Parses out a list of audio preselection from the @descriptor. + line="2463">Parses out a list of audio preselection from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="2471">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_EXT_DVB_AUDIO_PRESELECTION #GstMpegtsDescriptor + line="2465">a %GST_MTS_DESC_EXT_DVB_AUDIO_PRESELECTION #GstMpegtsDescriptor transfer-ownership="full"> + line="2466"> the list of audio preselection @@ -2181,7 +2181,7 @@ the list of audio preselection filename="gst-libs/gst/mpegts/gstmpegtsdescriptor.c" line="944">Extracts the Conditional Access information from @descriptor. + line="296"/> c:identifier="gst_mpegts_descriptor_parse_cable_delivery_system"> Extracts the cable delivery system information from @descriptor. + line="341">Extracts the cable delivery system information from @descriptor. %TRUE if parsing succeeded, else %FALSE. + line="348">%TRUE if parsing succeeded, else %FALSE. a %GST_MTS_DESC_DVB_CABLE_DELIVERY_SYSTEM #GstMpegtsDescriptor + line="343">a %GST_MTS_DESC_DVB_CABLE_DELIVERY_SYSTEM #GstMpegtsDescriptor transfer-ownership="none"> the #GstMpegtsCableDeliverySystemDescriptor to fill + line="344">the #GstMpegtsCableDeliverySystemDescriptor to fill @@ -2275,13 +2275,13 @@ the list of audio preselection c:identifier="gst_mpegts_descriptor_parse_dvb_bouquet_name"> Extracts the bouquet name from @descriptor. + line="441">Extracts the bouquet name from @descriptor. %TRUE if parsing succeeded, else %FALSE. + line="447">%TRUE if parsing succeeded, else %FALSE. @@ -2296,7 +2296,7 @@ the list of audio preselection allow-none="1"> the bouquet name + line="443">the bouquet name @@ -2305,20 +2305,20 @@ the list of audio preselection c:identifier="gst_mpegts_descriptor_parse_dvb_ca_identifier"> Extracts ca id's from @descriptor. + line="1311">Extracts ca id's from @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="1320">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_CA_IDENTIFIER #GstMpegtsDescriptor + line="1313">a %GST_MTS_DESC_DVB_CA_IDENTIFIER #GstMpegtsDescriptor transfer-ownership="full"> a list of ca identifier. + line="1314">a list of ca identifier. Edge entry identifies the CA system. Allocations of the value of this field are found in http://www.dvbservices.com @@ -2340,20 +2340,20 @@ are found in http://www.dvbservices.com c:identifier="gst_mpegts_descriptor_parse_dvb_component"> Extracts the DVB component information from @descriptor. + line="1237">Extracts the DVB component information from @descriptor. %TRUE if parsing succeeded, else %FALSE. + line="1244">%TRUE if parsing succeeded, else %FALSE. a %GST_MTS_DESC_DVB_COMPONENT #GstMpegtsDescriptor + line="1239">a %GST_MTS_DESC_DVB_COMPONENT #GstMpegtsDescriptor transfer-ownership="full"> the #GstMpegtsComponentDescriptor to fill + line="1240">the #GstMpegtsComponentDescriptor to fill @@ -2372,20 +2372,20 @@ are found in http://www.dvbservices.com c:identifier="gst_mpegts_descriptor_parse_dvb_content"> Extracts the DVB content information from @descriptor. + line="1358">Extracts the DVB content information from @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="1365">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_CONTENT #GstMpegtsDescriptor + line="1360">a %GST_MTS_DESC_DVB_CONTENT #GstMpegtsDescriptor transfer-ownership="full"> #GstMpegtsContent + line="1361">#GstMpegtsContent @@ -2405,20 +2405,20 @@ are found in http://www.dvbservices.com c:identifier="gst_mpegts_descriptor_parse_dvb_data_broadcast"> Parses out the data broadcast from the @descriptor. + line="2115">Parses out the data broadcast from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="2122">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_DATA_BROADCAST #GstMpegtsDescriptor + line="2117">a %GST_MTS_DESC_DVB_DATA_BROADCAST #GstMpegtsDescriptor transfer-ownership="full"> #GstMpegtsDataBroadcastDescriptor + line="2118">#GstMpegtsDataBroadcastDescriptor @@ -2437,20 +2437,20 @@ are found in http://www.dvbservices.com c:identifier="gst_mpegts_descriptor_parse_dvb_data_broadcast_id"> Parses out the data broadcast id from the @descriptor. + line="2192">Parses out the data broadcast id from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="2201">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_DATA_BROADCAST_ID #GstMpegtsDescriptor + line="2194">a %GST_MTS_DESC_DVB_DATA_BROADCAST_ID #GstMpegtsDescriptor transfer-ownership="full"> the data broadcast id + line="2195">the data broadcast id transfer-ownership="full"> the selector bytes, if present + line="2196">the selector bytes, if present @@ -2479,7 +2479,7 @@ are found in http://www.dvbservices.com transfer-ownership="full"> the length of @id_selector_bytes + line="2197">the length of @id_selector_bytes @@ -2488,20 +2488,20 @@ are found in http://www.dvbservices.com c:identifier="gst_mpegts_descriptor_parse_dvb_extended_event"> Extracts the DVB extended event information from @descriptor. + line="1139">Extracts the DVB extended event information from @descriptor. %TRUE if parsing succeeded, else %FALSE. + line="1146">%TRUE if parsing succeeded, else %FALSE. a %GST_MTS_DESC_DVB_EXTENDED_EVENT #GstMpegtsDescriptor + line="1141">a %GST_MTS_DESC_DVB_EXTENDED_EVENT #GstMpegtsDescriptor transfer-ownership="full"> the #GstMpegtsExtendedEventDescriptor to fill + line="1142">the #GstMpegtsExtendedEventDescriptor to fill @@ -2520,20 +2520,20 @@ are found in http://www.dvbservices.com c:identifier="gst_mpegts_descriptor_parse_dvb_frequency_list"> Parses out a list of frequencies from the @descriptor. + line="2021">Parses out a list of frequencies from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="2030">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_FREQUENCY_LIST #GstMpegtsDescriptor + line="2023">a %GST_MTS_DESC_DVB_FREQUENCY_LIST #GstMpegtsDescriptor transfer-ownership="full"> %FALSE in Hz, %TRUE in kHz + line="2024">%FALSE in Hz, %TRUE in kHz transfer-ownership="full"> a list of all frequencies in Hz/kHz + line="2025">a list of all frequencies in Hz/kHz depending on @offset @@ -2563,20 +2563,20 @@ depending on @offset c:identifier="gst_mpegts_descriptor_parse_dvb_linkage"> Extracts the DVB linkage information from @descriptor. + line="668">Extracts the DVB linkage information from @descriptor. %TRUE if parsing succeeded, else %FALSE. + line="675">%TRUE if parsing succeeded, else %FALSE. a %GST_MTS_DESC_DVB_LINKAGE #GstMpegtsDescriptor + line="670">a %GST_MTS_DESC_DVB_LINKAGE #GstMpegtsDescriptor transfer-ownership="full"> the #GstMpegtsDVBLinkageDescriptor to fill + line="671">the #GstMpegtsDVBLinkageDescriptor to fill @@ -2595,20 +2595,20 @@ depending on @offset c:identifier="gst_mpegts_descriptor_parse_dvb_multilingual_bouquet_name"> Parses out the multilingual bouquet name from the @descriptor. + line="1780">Parses out the multilingual bouquet name from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="1789">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_MULTILINGUAL_BOUQUET_NAME + line="1782">a %GST_MTS_DESC_DVB_MULTILINGUAL_BOUQUET_NAME #GstMpegtsDescriptor @@ -2618,7 +2618,7 @@ depending on @offset transfer-ownership="full"> + line="1784"> a #GstMpegtsDvbMultilingualBouquetNameItem @@ -2630,20 +2630,20 @@ a #GstMpegtsDvbMultilingualBouquetNameItem c:identifier="gst_mpegts_descriptor_parse_dvb_multilingual_component"> Parses out the multilingual component from the @descriptor. + line="1932">Parses out the multilingual component from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="1942">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_MULTILINGUAL_COMPONENT + line="1934">a %GST_MTS_DESC_DVB_MULTILINGUAL_COMPONENT #GstMpegtsDescriptor @@ -2653,7 +2653,7 @@ a #GstMpegtsDvbMultilingualBouquetNameItem transfer-ownership="full"> the component tag + line="1936">the component tag transfer-ownership="full"> + line="1937"> a #GstMpegtsDvbMultilingualComponentItem @@ -2674,20 +2674,20 @@ a #GstMpegtsDvbMultilingualComponentItem c:identifier="gst_mpegts_descriptor_parse_dvb_multilingual_network_name"> Parses out the multilingual network name from the @descriptor. + line="1708">Parses out the multilingual network name from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="1717">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_MULTILINGUAL_NETWORK_NAME + line="1710">a %GST_MTS_DESC_DVB_MULTILINGUAL_NETWORK_NAME #GstMpegtsDescriptor @@ -2697,7 +2697,7 @@ a #GstMpegtsDvbMultilingualComponentItem transfer-ownership="full"> + line="1712"> a #GstMpegtsDvbMultilingualNetworkNameItem @@ -2709,20 +2709,20 @@ a #GstMpegtsDvbMultilingualNetworkNameItem c:identifier="gst_mpegts_descriptor_parse_dvb_multilingual_service_name"> Parses out the multilingual service name from the @descriptor. + line="1854">Parses out the multilingual service name from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="1863">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_MULTILINGUAL_SERVICE_NAME + line="1856">a %GST_MTS_DESC_DVB_MULTILINGUAL_SERVICE_NAME #GstMpegtsDescriptor @@ -2732,7 +2732,7 @@ a #GstMpegtsDvbMultilingualNetworkNameItem transfer-ownership="full"> + line="1858"> a #GstMpegtsDvbMultilingualServiceNameItem @@ -2775,20 +2775,20 @@ a #GstMpegtsDvbMultilingualServiceNameItem c:identifier="gst_mpegts_descriptor_parse_dvb_parental_rating"> Extracts the DVB parental rating information from @descriptor. + line="1423">Extracts the DVB parental rating information from @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="1431">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_PARENTAL_RATING #GstMpegtsDescriptor + line="1425">a %GST_MTS_DESC_DVB_PARENTAL_RATING #GstMpegtsDescriptor transfer-ownership="full"> + line="1426"> #GstMpegtsDVBParentalRatingItem @@ -2809,20 +2809,20 @@ a #GstMpegtsDvbMultilingualServiceNameItem c:identifier="gst_mpegts_descriptor_parse_dvb_private_data_specifier"> Parses out the private data specifier from the @descriptor. + line="1984">Parses out the private data specifier from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="1994">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_PRIVATE_DATA_SPECIFIER #GstMpegtsDescriptor + line="1986">a %GST_MTS_DESC_DVB_PRIVATE_DATA_SPECIFIER #GstMpegtsDescriptor transfer-ownership="full"> the private data specifier id + line="1987">the private data specifier id registered by http://www.dvbservices.com/ @@ -2843,7 +2843,7 @@ registered by http://www.dvbservices.com/ allow-none="1"> additional data or NULL + line="1989">additional data or NULL @@ -2856,7 +2856,7 @@ registered by http://www.dvbservices.com/ allow-none="1"> length of @private_data + line="1990">length of @private_data @@ -2865,20 +2865,20 @@ registered by http://www.dvbservices.com/ c:identifier="gst_mpegts_descriptor_parse_dvb_scrambling"> Parses out the scrambling mode from the @descriptor. + line="2161">Parses out the scrambling mode from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="2172">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_SCRAMBLING #GstMpegtsDescriptor + line="2163">a %GST_MTS_DESC_DVB_SCRAMBLING #GstMpegtsDescriptor transfer-ownership="full"> This 8-bit field identifies the selected + line="2164">This 8-bit field identifies the selected mode of the scrambling algorithm (#GstMpegtsDVBScramblingModeType). The technical details of the scrambling algorithm are available only to bona-fide users upon signature of a Non Disclosure Agreement (NDA) @@ -2901,20 +2901,20 @@ administered by the DVB Common Scrambling Algorithm Custodian. c:identifier="gst_mpegts_descriptor_parse_dvb_service"> Extracts the dvb service information from @descriptor. + line="467">Extracts the dvb service information from @descriptor. %TRUE if parsing succeeded, else %FALSE. + line="476">%TRUE if parsing succeeded, else %FALSE. a %GST_MTS_DESC_DVB_SERVICE #GstMpegtsDescriptor + line="469">a %GST_MTS_DESC_DVB_SERVICE #GstMpegtsDescriptor allow-none="1"> the service type + line="470">the service type allow-none="1"> the service name + line="471">the service name allow-none="1"> the provider name + line="472">the provider name @@ -2990,20 +2990,20 @@ the list of services c:identifier="gst_mpegts_descriptor_parse_dvb_short_event"> Extracts the DVB short event information from @descriptor. + line="890">Extracts the DVB short event information from @descriptor. %TRUE if parsing succeeded, else %FALSE. + line="899">%TRUE if parsing succeeded, else %FALSE. a %GST_MTS_DESC_DVB_SHORT_EVENT #GstMpegtsDescriptor + line="892">a %GST_MTS_DESC_DVB_SHORT_EVENT #GstMpegtsDescriptor allow-none="1"> the language code + line="893">the language code allow-none="1"> the event name + line="894">the event name allow-none="1"> the event text + line="895">the event text @@ -3045,20 +3045,20 @@ the list of services c:identifier="gst_mpegts_descriptor_parse_dvb_stream_identifier"> Extracts the component tag from @descriptor. + line="1284">Extracts the component tag from @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="1291">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_CONTENT #GstMpegtsDescriptor + line="1286">a %GST_MTS_DESC_DVB_CONTENT #GstMpegtsDescriptor transfer-ownership="none"> the component tag + line="1287">the component tag @@ -3076,20 +3076,20 @@ the list of services c:identifier="gst_mpegts_descriptor_parse_dvb_stuffing"> Parses out the stuffing bytes from the @descriptor. + line="186">Parses out the stuffing bytes from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="193">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_STUFFING #GstMpegtsDescriptor + line="188">a %GST_MTS_DESC_DVB_STUFFING #GstMpegtsDescriptor transfer-ownership="full"> the stuffing bytes + line="189">the stuffing bytes @@ -3107,7 +3107,7 @@ the list of services c:identifier="gst_mpegts_descriptor_parse_dvb_subtitling_idx"> Extracts the DVB subtitling informatio from specific table id in @descriptor. + line="990">Extracts the DVB subtitling informatio from specific table id in @descriptor. Note: Use #gst_tag_get_language_code if you want to get the the ISO 639-1 language code from the returned ISO 639-2 one. @@ -3116,20 +3116,20 @@ ISO 639-1 language code from the returned ISO 639-2 one. %TRUE if parsing succeeded, else %FALSE. + line="1004">%TRUE if parsing succeeded, else %FALSE. a %GST_MTS_DESC_DVB_SUBTITLING #GstMpegtsDescriptor + line="992">a %GST_MTS_DESC_DVB_SUBTITLING #GstMpegtsDescriptor Table id of the entry to parse + line="993">Table id of the entry to parse transfer-ownership="full"> the language code + line="994">the language code allow-none="1"> the type of subtitling + line="995">the type of subtitling allow-none="1"> the composition page id + line="996">the composition page id allow-none="1"> the ancillary page id + line="997">the ancillary page id @@ -3183,14 +3183,14 @@ ISO 639-1 language code from the returned ISO 639-2 one. The number of entries in @descriptor + line="1042">The number of entries in @descriptor a %GST_MTS_DESC_DVB_SUBTITLING #GstMpegtsDescriptor + line="1040">a %GST_MTS_DESC_DVB_SUBTITLING #GstMpegtsDescriptor @@ -3199,20 +3199,20 @@ ISO 639-1 language code from the returned ISO 639-2 one. c:identifier="gst_mpegts_descriptor_parse_dvb_t2_delivery_system"> Parses out the DVB-T2 delivery system from the @descriptor. + line="2287">Parses out the DVB-T2 delivery system from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="2294">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_EXT_DVB_T2_DELIVERY_SYSTEM #GstMpegtsDescriptor + line="2289">a %GST_MTS_DESC_EXT_DVB_T2_DELIVERY_SYSTEM #GstMpegtsDescriptor transfer-ownership="full"> #GstMpegtsT2DeliverySystemDescriptor + line="2290">#GstMpegtsT2DeliverySystemDescriptor @@ -3231,26 +3231,26 @@ ISO 639-1 language code from the returned ISO 639-2 one. c:identifier="gst_mpegts_descriptor_parse_dvb_teletext_idx"> Parses teletext number @idx in the @descriptor. The language is in ISO639 format. + line="926">Parses teletext number @idx in the @descriptor. The language is in ISO639 format. FALSE on out-of-bounds and errors + line="937">FALSE on out-of-bounds and errors a %GST_MTS_DESC_DVB_TELETEXT #GstMpegtsDescriptor + line="928">a %GST_MTS_DESC_DVB_TELETEXT #GstMpegtsDescriptor The id of the teletext to get + line="929">The id of the teletext to get allow-none="1"> a null-terminated string + line="930">a null-terminated string allow-none="1"> #GstMpegtsDVBTeletextType + line="931">#GstMpegtsDVBTeletextType c:identifier="gst_mpegts_descriptor_parse_dvb_teletext_nb"> Find the number of teletext entries in @descriptor + line="970">Find the number of teletext entries in @descriptor Number of teletext entries + line="976">Number of teletext entries a %GST_MTS_DESC_DVB_TELETEXT #GstMpegtsDescriptor + line="972">a %GST_MTS_DESC_DVB_TELETEXT #GstMpegtsDescriptor @@ -3324,7 +3324,7 @@ ISO 639-1 language code from the returned ISO 639-2 one. Note: Use #gst_tag_get_language_code if you want to get the the ISO 639-1 language code from the returned ISO 639-2 one. + line="333"/> Note: Use #gst_tag_get_language_code if you want to get the the ISO 639-1 language code from the returned ISO 639-2 one. + line="337"/> + line="342"/> filename="gst-libs/gst/mpegts/gstmpegtsdescriptor.c" line="1161">Extracts the logical channels from @descriptor. + line="387"/> + + Parses out the metadata descriptor from the @descriptor. + +See ISO/IEC 13818-1:2018 Section 2.6.60 and 2.6.61 for details. +metadata_application_format is provided in Table 2-82. metadata_format is +provided in Table 2-85. + + + %TRUE if the parsing worked correctly, else %FALSE. + + + + + a %GST_TYPE_MPEGTS_METADATA_DESCRIPTOR #GstMpegtsDescriptor + + + + #GstMpegtsMetadataDescriptor + + + + + + Extracts the metadata STD descriptor from @descriptor. + +See ISO/IEC 13818-1:2018 Section 2.6.62 and 2.6.63 for details. + + + %TRUE if parsing succeeded, else %FALSE. + + + + + a %GST_MTS_DESC_METADATA_STD #GstMpegtsDescriptor +@metadata_input_leak_rate (out): the input leak rate in units of 400bits/sec. +@metadata_buffer_size (out): the buffer size in units of 1024 bytes +@metadata_output_leak_rate (out): the output leak rate in units of 400bits/sec. + + + + + + + + + + + + + @@ -3459,7 +3534,7 @@ ISO 639-1 language code from the returned ISO 639-2 one. filename="gst-libs/gst/mpegts/gstmpegtsdescriptor.c" line="901">Extracts the Registration information from @descriptor. + line="288"/> c:identifier="gst_mpegts_descriptor_parse_satellite_delivery_system"> Extracts the satellite delivery system information from @descriptor. + line="224">Extracts the satellite delivery system information from @descriptor. %TRUE if parsing succeeded, else %FALSE. + line="231">%TRUE if parsing succeeded, else %FALSE. a %GST_MTS_DESC_DVB_SATELLITE_DELIVERY_SYSTEM #GstMpegtsDescriptor + line="226">a %GST_MTS_DESC_DVB_SATELLITE_DELIVERY_SYSTEM #GstMpegtsDescriptor transfer-ownership="none"> the #GstMpegtsSatelliteDeliverySystemDescriptor to fill + line="227">the #GstMpegtsSatelliteDeliverySystemDescriptor to fill @@ -3544,20 +3619,20 @@ ISO 639-1 language code from the returned ISO 639-2 one. c:identifier="gst_mpegts_descriptor_parse_terrestrial_delivery_system"> Parses out the terrestrial delivery system from the @descriptor. + line="1506">Parses out the terrestrial delivery system from the @descriptor. %TRUE if the parsing happened correctly, else %FALSE. + line="1513">%TRUE if the parsing happened correctly, else %FALSE. a %GST_MTS_DESC_DVB_TERRESTRIAL_DELIVERY_SYSTEM #GstMpegtsDescriptor + line="1508">a %GST_MTS_DESC_DVB_TERRESTRIAL_DELIVERY_SYSTEM #GstMpegtsDescriptor transfer-ownership="none"> #GstMpegtsTerrestrialDeliverySystemDescriptor + line="1509">#GstMpegtsTerrestrialDeliverySystemDescriptor @@ -3578,7 +3653,7 @@ ISO 639-1 language code from the returned ISO 639-2 one. filename="gst-libs/gst/mpegts/gstmpegtsdescriptor.c" line="1198">Creates a #GstMpegtsDescriptor with custom @tag and @data + line="392"/> filename="gst-libs/gst/mpegts/gstmpegtsdescriptor.c" line="1224">Creates a #GstMpegtsDescriptor with custom @tag, @tag_extension and @data + line="397"/> c:identifier="gst_mpegts_descriptor_from_dvb_service"> Fills a #GstMpegtsDescriptor to be a %GST_MTS_DESC_DVB_SERVICE. + line="503">Fills a #GstMpegtsDescriptor to be a %GST_MTS_DESC_DVB_SERVICE. The data field of the #GstMpegtsDescriptor will be allocated, and transferred to the caller. the #GstMpegtsDescriptor or %NULL on fail + line="513">the #GstMpegtsDescriptor or %NULL on fail Service type defined as a #GstMpegtsDVBServiceType + line="505">Service type defined as a #GstMpegtsDVBServiceType allow-none="1"> Name of the service + line="506">Name of the service allow-none="1"> Name of the service provider + line="507">Name of the service provider @@ -3728,25 +3803,25 @@ and transferred to the caller. a string containing the ISO639 language + line="1056">a string containing the ISO639 language subtitling type + line="1057">subtitling type composition page id + line="1058">composition page id ancillary page id + line="1059">ancillary page id @@ -3758,7 +3833,7 @@ and transferred to the caller. line="1115">Creates a %GST_MTS_DESC_ISO_639_LANGUAGE #GstMpegtsDescriptor with a single language + line="345"/> filename="gst-libs/gst/mpegts/gstmpegtsdescriptor.c" line="872">Creates a %GST_MTS_DESC_REGISTRATION #GstMpegtsDescriptor + line="283"/> The type of #GstMpegtsDescriptor + line="66">The type of #GstMpegtsDescriptor These values correspond to the registered descriptor type from the base MPEG-TS specifications (ITU H.222.0 | ISO/IEC 13818-1). Consult the relevant specifications for more details. + line="140"/> @@ -4487,7 +4562,7 @@ Consult the relevant specifications for more details. glib:get-type="gst_mpegts_iso_639_language_get_type" c:symbol-prefix="iso_639_language"> + line="323"/> @@ -4504,7 +4579,7 @@ Consult the relevant specifications for more details. + line="330"/> @@ -4518,7 +4593,7 @@ Consult the relevant specifications for more details. + line="315"/> @@ -4542,7 +4617,7 @@ Consult the relevant specifications for more details. glib:get-type="gst_mpegts_logical_channel_get_type" c:symbol-prefix="logical_channel"> + line="365"/> @@ -4559,7 +4634,7 @@ Consult the relevant specifications for more details. glib:get-type="gst_mpegts_logical_channel_descriptor_get_type" c:symbol-prefix="logical_channel_descriptor"> + line="371"/> @@ -4569,16 +4644,110 @@ Consult the relevant specifications for more details. + + The metadata descriptor specifies parameters of a metadata service carried in an MPEG-2 Transport Stream (or Program Stream). The descriptor is included in the PMT in the descriptor loop for the elementary stream that carries the +metadata service. The descriptor specifies the format of the associated metadata, and contains the value of the +metadata_service_id to identify the metadata service to which the metadata descriptor applies. + +Note that this structure does not include all of the metadata_descriptor items, and will need extension to support DSM-CC and private data. +See ISO/IEC 13818-1:2018 Section 2.6.60 and Section 2.6.61 for more information. + + + specifies the application responsible for defining usage, syntax and semantics + + + + indicates the format and coding of the metadata + + + + format identifier (equivalent to registration descriptor), for example 0x4B4C4641 ('KLVA') to indicate SMPTE 336 KLV. + + + + metadata service to which this metadata descriptor applies, typically 0x00 + + + + decoder flags, see ISO/IEC 13818-1:2018 Table 2-88. + + + + true if stream associated with this descriptor is in an ISO/IEC 13818-6 data or object carousel. + + + + + metadata_descriptor metadata_format valid values. See ISO/IEC 13818-1:2018(E) Table 2-85. + + + ISO/IEC 15938-1 TeM. + + + ISO/IEC 15938-1 BiM. + + + Defined by metadata application format. + + + Defined by metadata_format_identifier field. + + The type of #GstMpegtsDescriptor + line="142">The type of #GstMpegtsDescriptor These values correspond to miscellaneous descriptor types that are not yet identified from known specifications. + line="153"/> @@ -4728,6 +4897,52 @@ not yet identified from known specifications. + + Extra buffer metadata describing the PES Metadata context. +This is based on the Metadata AU cell header in +ISO/IEC 13818-1:2018 Section 2.12.4. + +AU_cell_data_length is not provided, since it matches the length of the buffer + + + parent #GstMeta + + + + metadata service identifier + + + + bit flags, see spec for details + + + + Gets the global #GstMetaInfo describing the #GstMpegtsPESMetadataMeta meta. + + + The #GstMetaInfo + + + + c:type="GstMpegtsRegistrationId"> Well-known registration ids, expressed as native-endian 32bit integers. These + line="216">Well-known registration ids, expressed as native-endian 32bit integers. These are used in descriptors of type %GST_MTS_DESC_REGISTRATION. Unless specified otherwise (by use of the "OTHER" prefix), they are all registered by the [SMPTE Registration Authority](https://smpte-ra.org/) or specified in "official" documentation for the given format. + line="278"/> Undefined registration id + line="218">Undefined registration id Audio AC-3, ATSC A/52 + line="219">Audio AC-3, ATSC A/52 SCTE 35, "Digital Program Insertion Cueing Message" + line="221">SCTE 35, "Digital Program Insertion Cueing Message" Dirac Video codec + line="222">Dirac Video codec DTS Audio + line="223">DTS Audio DTS Audio + line="224">DTS Audio DTS Audio + line="225">DTS Audio SMPTE 302M, Mapping of AES3 Data in mpeg-ts + line="228">SMPTE 302M, Mapping of AES3 Data in mpeg-ts Enhanced AC-3 (i.e. EAC3) + line="226">Enhanced AC-3 (i.e. EAC3) Cablelabs ETV + line="227">Cablelabs ETV ATSC A/53 compliant stream (i.e. ATSC) + line="229">ATSC A/53 compliant stream (i.e. ATSC) Blu-ray, "System Description Blu-ray Disc + line="230">Blu-ray, "System Description Blu-ray Disc Read-Only Format part 3 Audio Visual Basic Specifications" SMPTE RP217 : Non-synchronized Mapping of KLV + line="232">SMPTE RP217 : Non-synchronized Mapping of KLV Packets in mpeg-ts Opus Audio + line="234">Opus Audio HDV (Sony) + line="235">HDV (Sony) Video VC-1, SMPTE RP227 "VC-1 Bitstream Transport Encodings" + line="236">Video VC-1, SMPTE RP227 "VC-1 Bitstream Transport Encodings" Audio AC-4, ETSI 103 190-2 + line="220">Audio AC-4, ETSI 103 190-2 HEVC / h265 + line="237">HEVC / h265 @@ -5057,9 +5272,9 @@ Corresponds to table 6 of ETSI EN 300 468 (v1.13.0) c:type="GstMpegtsSCTEDescriptorType"> These values correspond to the ones defined by SCTE (amongst other in ANSI/SCTE 57) + line="155">These values correspond to the ones defined by SCTE (amongst other in ANSI/SCTE 57) + line="171"/> @@ -7918,6 +8133,29 @@ profiles defined in Annex A for service-compatible stereoscopic 3D services + + Creates and adds a #GstMpegtsPESMetadataMeta to a @buffer. + + + a newly created #GstMpegtsPESMetadataMeta + + + + + a #GstBuffer + + + + @@ -7925,7 +8163,7 @@ profiles defined in Annex A for service-compatible stereoscopic 3D servicesCreates a #GstMpegtsDescriptor with custom @tag and @data + line="392"/> Creates a #GstMpegtsDescriptor with custom @tag, @tag_extension and @data + line="397"/> moved-to="Descriptor.from_dvb_service"> Fills a #GstMpegtsDescriptor to be a %GST_MTS_DESC_DVB_SERVICE. + line="503">Fills a #GstMpegtsDescriptor to be a %GST_MTS_DESC_DVB_SERVICE. The data field of the #GstMpegtsDescriptor will be allocated, and transferred to the caller. the #GstMpegtsDescriptor or %NULL on fail + line="513">the #GstMpegtsDescriptor or %NULL on fail Service type defined as a #GstMpegtsDVBServiceType + line="505">Service type defined as a #GstMpegtsDVBServiceType allow-none="1"> Name of the service + line="506">Name of the service allow-none="1"> Name of the service provider + line="507">Name of the service provider @@ -8079,25 +8317,25 @@ and transferred to the caller. a string containing the ISO639 language + line="1056">a string containing the ISO639 language subtitling type + line="1057">subtitling type composition page id + line="1058">composition page id ancillary page id + line="1059">ancillary page id @@ -8110,7 +8348,7 @@ and transferred to the caller. line="1115">Creates a %GST_MTS_DESC_ISO_639_LANGUAGE #GstMpegtsDescriptor with a single language + line="345"/> filename="gst-libs/gst/mpegts/gstmpegtsdescriptor.c" line="872">Creates a %GST_MTS_DESC_REGISTRATION #GstMpegtsDescriptor + line="283"/> Note: To look for descriptors that can be present more than once in an array of descriptors, iterate the #GArray manually. + line="210"/> Note: To look for descriptors that can be present more than once in an array of descriptors, iterate the #GArray manually. + line="214"/> Initializes the MPEG-TS helper library. Must be called before any usage. - + @@ -8519,7 +8757,7 @@ array. Note: The data provided in @buffer will not be copied. + line="207"/> + + Return the #GType associated with #GstMpegtsPESMetadataMeta + + + a #GType + + + + + Gets the global #GstMetaInfo describing the #GstMpegtsPESMetadataMeta meta. + + + The #GstMetaInfo + + + - + - + - + - + Creates a new PTP clock instance that exports the PTP time of the master + line="3293">Creates a new PTP clock instance that exports the PTP time of the master clock in @domain. This clock can be slaved to other clocks as needed. If gst_ptp_init() was not called before, this will call gst_ptp_init() with @@ -848,24 +848,24 @@ times from the PTP master clock on the network. Once this happens the GstPtpClock::internal-clock property will become non-NULL. You can check this with gst_clock_wait_for_sync(), the GstClock::synced signal and gst_clock_is_synced(). - + A new #GstClock + line="3310">A new #GstClock Name of the clock + line="3295">Name of the clock PTP domain + line="3296">PTP domain @@ -930,7 +930,7 @@ gst_clock_is_synced(). The statistics can be the following structures: + line="103">The statistics can be the following structures: GST_PTP_STATISTICS_NEW_DOMAIN_FOUND: "domain" G_TYPE_UINT The domain identifier of the domain @@ -966,7 +966,7 @@ GST_PTP_STATISTICS_TIME_UPDATED: "rate" G_TYPE_DOUBLE Internal/external rate If %FALSE is returned, the callback is removed and never called again. - + @@ -974,13 +974,13 @@ If %FALSE is returned, the callback is removed and never called again. PTP domain identifier + line="105">PTP domain identifier New statistics + line="106">New statistics closure="2"> Data passed to gst_ptp_statistics_callback_add() + line="107">Data passed to gst_ptp_statistics_callback_add() @@ -1188,10 +1188,10 @@ calls, but otherwise returns NULL on error. Deinitialize the GStreamer PTP subsystem and stop the PTP clock. If there + line="2992">Deinitialize the GStreamer PTP subsystem and stop the PTP clock. If there are any remaining GstPtpClock instances, they won't be further synchronized to the PTP network clock. - + @@ -1199,7 +1199,7 @@ to the PTP network clock. Initialize the GStreamer PTP subsystem and create a PTP ordinary clock in + line="2958">Initialize the GStreamer PTP subsystem and create a PTP ordinary clock in slave-only mode for all domains on the given @interfaces with the given @clock_id. @@ -1212,14 +1212,14 @@ parameters if it wasn't called before. %TRUE if the GStreamer PTP clock subsystem could be initialized. + line="2973">%TRUE if the GStreamer PTP clock subsystem could be initialized. PTP clock id of this process' clock or %GST_PTP_CLOCK_ID_NONE + line="2960">PTP clock id of this process' clock or %GST_PTP_CLOCK_ID_NONE allow-none="1"> network interfaces to run the clock on + line="2961">network interfaces to run the clock on + + Initialize the GStreamer PTP subsystem and create a PTP ordinary clock in +slave-only mode according to the @config. + +@config is a #GstStructure with the following optional fields: +* #guint64 `clock-id`: The clock ID to use for the local clock. If the + clock-id is not provided or %GST_PTP_CLOCK_ID_NONE is provided, a clock + id is automatically generated from the MAC address of the first network + interface. +* #GStrv `interfaces`: The interface names to listen on for PTP packets. If + none are provided then all compatible interfaces will be used. +* #guint `ttl`: The TTL to use for multicast packets sent out by GStreamer. + This defaults to 1, i.e. packets will not leave the local network. + +This function is automatically called by gst_ptp_clock_new() with default +parameters if it wasn't called before. + + + %TRUE if the GStreamer PTP clock subsystem could be initialized. + + + + + Configuration for initializing the GStreamer PTP subsystem + + + + Check if the GStreamer PTP clock subsystem is initialized. + line="2520">Check if the GStreamer PTP clock subsystem is initialized. %TRUE if the GStreamer PTP clock subsystem is initialized. + line="2525">%TRUE if the GStreamer PTP clock subsystem is initialized. @@ -1254,13 +1290,13 @@ parameters if it wasn't called before. version="1.6"> Check if PTP clocks are generally supported on this system, and if previous + line="2503">Check if PTP clocks are generally supported on this system, and if previous initializations did not fail. %TRUE if PTP clocks are generally supported on this system, and + line="2509">%TRUE if PTP clocks are generally supported on this system, and previous initializations did not fail. @@ -1270,13 +1306,13 @@ previous initializations did not fail. version="1.6"> Installs a new statistics callback for gathering PTP statistics. See + line="3361">Installs a new statistics callback for gathering PTP statistics. See GstPtpStatisticsCallback for a list of statistics that are provided. - + Id for the callback that can be passed to + line="3370">Id for the callback that can be passed to gst_ptp_statistics_callback_remove() @@ -1288,7 +1324,7 @@ gst_ptp_statistics_callback_remove() destroy="2"> GstPtpStatisticsCallback to call + line="3363">GstPtpStatisticsCallback to call @@ -1298,13 +1334,13 @@ gst_ptp_statistics_callback_remove() allow-none="1"> Data to pass to the callback + line="3364">Data to pass to the callback GDestroyNotify to destroy the data + line="3365">GDestroyNotify to destroy the data @@ -1314,9 +1350,9 @@ gst_ptp_statistics_callback_remove() version="1.6"> Removes a PTP statistics callback that was previously added with + line="3400">Removes a PTP statistics callback that was previously added with gst_ptp_statistics_callback_add(). - + @@ -1324,7 +1360,7 @@ gst_ptp_statistics_callback_add(). Callback id to remove + line="3402">Callback id to remove diff --git a/girs/GstPbutils-1.0.gir b/girs/GstPbutils-1.0.gir index a0957bf7e..f1b42eaf0 100644 --- a/girs/GstPbutils-1.0.gir +++ b/girs/GstPbutils-1.0.gir @@ -484,17 +484,17 @@ set a custom context using g_main_context_push_thread_default(). All the information is returned in a #GstDiscovererInfo structure. + line="405"/> Creates a new #GstDiscoverer with the provided timeout. + line="2670">Creates a new #GstDiscoverer with the provided timeout. + line="411"/> The new #GstDiscoverer. + line="2678">The new #GstDiscoverer. If an error occurred when creating the discoverer, @err will be set accordingly and %NULL will be returned. If @err is set, the caller must free it when no longer needed using g_error_free(). @@ -504,7 +504,7 @@ free it when no longer needed using g_error_free(). timeout per file, in nanoseconds. Allowed are values between + line="2672">timeout per file, in nanoseconds. Allowed are values between one second (#GST_SECOND) and one hour (3600 * #GST_SECOND) @@ -540,6 +540,33 @@ free it when no longer needed using g_error_free(). + + Loads the serialized info from the given uri. + + + the #GstDiscovererInfo or %NULL if it could not be loaded + + + + + the #GstDiscoverer + + + + the uri to load the info from + + + + @@ -572,16 +599,16 @@ free it when no longer needed using g_error_free(). throws="1"> Synchronously discovers the given @uri. + line="2608">Synchronously discovers the given @uri. A copy of @uri will be made internally, so the caller can safely g_free() afterwards. + line="429"/> the result of the scanning. Can be %NULL if an + line="2619">the result of the scanning. Can be %NULL if an error occurred. @@ -589,13 +616,13 @@ error occurred. A #GstDiscoverer + line="2610">A #GstDiscoverer The URI to run on. + line="2611">The URI to run on. @@ -604,18 +631,18 @@ error occurred. c:identifier="gst_discoverer_discover_uri_async"> Appends the given @uri to the list of URIs to discoverer. The actual + line="2569">Appends the given @uri to the list of URIs to discoverer. The actual discovery of the @uri will only take place if gst_discoverer_start() has been called. A copy of @uri will be made internally, so the caller can safely g_free() afterwards. + line="422"/> %TRUE if the @uri was successfully appended to the list of pending + line="2581">%TRUE if the @uri was successfully appended to the list of pending uris, else %FALSE @@ -623,13 +650,13 @@ uris, else %FALSE A #GstDiscoverer + line="2571">A #GstDiscoverer the URI to add. + line="2572">the URI to add. @@ -637,11 +664,11 @@ uris, else %FALSE Allow asynchronous discovering of URIs to take place. + line="2468">Allow asynchronous discovering of URIs to take place. A #GMainLoop must be available for #GstDiscoverer to properly work in asynchronous mode. + line="416"/> @@ -649,7 +676,7 @@ asynchronous mode. A #GstDiscoverer + line="2470">A #GstDiscoverer @@ -657,10 +684,10 @@ asynchronous mode. Stop the discovery of any pending URIs and clears the list of + line="2511">Stop the discovery of any pending URIs and clears the list of pending URIS (if any). + line="419"/> @@ -668,7 +695,7 @@ pending URIS (if any). A #GstDiscoverer + line="2513">A #GstDiscoverer @@ -680,7 +707,7 @@ pending URIS (if any). default-value="15000000000"> The duration (in nanoseconds) after which the discovery of an individual + line="252">The duration (in nanoseconds) after which the discovery of an individual URI will timeout. If the discovery of a URI times out, the %GST_DISCOVERER_TIMEOUT will be @@ -708,7 +735,7 @@ set on the result flags. Will be emitted in async mode when all information on a URI could be + line="307">Will be emitted in async mode when all information on a URI could be discovered, or an error occurred. When an error occurs, @info might still contain some partial information, @@ -720,7 +747,7 @@ depending on the circumstances of the error. the results #GstDiscovererInfo + line="310">the results #GstDiscovererInfo allow-none="1"> #GError, which will be non-NULL + line="311">#GError, which will be non-NULL if an error occurred during discovery. You must not free this #GError, it will be freed by @@ -741,15 +768,37 @@ depending on the circumstances of the error. Will be emitted in async mode when all pending URIs have been processed. + line="285">Will be emitted in async mode when all pending URIs have been processed. + + Retrieves information about a URI from and external source of information, +like a cache file. This is used by the discoverer to speed up the +discovery. + + The #GstDiscovererInfo representing +@uri, or %NULL if no information + + + + + THe URI to load the serialized info for + + + + This signal is emitted after the source element has been created for, so + line="329">This signal is emitted after the source element has been created for, so the URI being discovered, so it can be configured by setting additional properties (e.g. set a proxy server for an http source, or set the device and read speed for an audio cd source). @@ -763,7 +812,7 @@ thread. source element + line="332">source element @@ -771,7 +820,7 @@ thread. Will be emitted when the discover starts analyzing the pending URIs + line="296">Will be emitted when the discover starts analyzing the pending URIs @@ -934,7 +983,7 @@ information. c:type="GstDiscovererClass" glib:is-gtype-struct-for="Discoverer"> + line="405"/> @@ -1003,8 +1052,34 @@ information. + + + + + the #GstDiscovererInfo or %NULL if it could not be loaded + + + + + the #GstDiscoverer + + + + the uri to load the info from + + + + + - + @@ -1079,21 +1154,21 @@ the tags after the life-time of @info, you will need to copy them. version="1.6"> Parses a #GVariant as produced by gst_discoverer_info_to_variant() + line="2747">Parses a #GVariant as produced by gst_discoverer_info_to_variant() back to a #GstDiscovererInfo. A newly-allocated #GstDiscovererInfo. + line="2754">A newly-allocated #GstDiscovererInfo. A #GVariant to deserialize into a #GstDiscovererInfo. + line="2749">A #GVariant to deserialize into a #GstDiscovererInfo. @@ -1493,7 +1568,7 @@ gst_discoverer_stream_info_list_free(). version="1.6"> Serializes @info to a #GVariant that can be parsed again + line="2701">Serializes @info to a #GVariant that can be parsed again through gst_discoverer_info_from_variant(). Note that any #GstToc (s) that might have been discovered will not be serialized @@ -1503,20 +1578,20 @@ for now. A newly-allocated #GVariant representing @info. + line="2713">A newly-allocated #GVariant representing @info. A #GstDiscovererInfo + line="2703">A #GstDiscovererInfo A combination of #GstDiscovererSerializeFlags to specify + line="2704">A combination of #GstDiscovererSerializeFlags to specify what needs to be serialized. @@ -1789,7 +1864,7 @@ after usage. c:identifier="gst_discoverer_stream_info_get_stream_id"> - + the stream ID of this stream. If you wish to @@ -4345,7 +4420,7 @@ in debugging. c:identifier="gst_pb_utils_add_codec_description_to_tag_list"> Adds a codec tag describing the format specified by @caps to @taglist. + line="1146">Adds a codec tag describing the format specified by @caps to @taglist. TRUE if a codec tag was added, FALSE otherwise. + line="1156">TRUE if a codec tag was added, FALSE otherwise. a #GstTagList + line="1148">a #GstTagList allow-none="1"> a GStreamer codec tag such as #GST_TAG_AUDIO_CODEC, + line="1149">a GStreamer codec tag such as #GST_TAG_AUDIO_CODEC, #GST_TAG_VIDEO_CODEC or #GST_TAG_CODEC. If none is specified, the function will attempt to detect the appropriate category. @@ -7008,7 +7083,7 @@ function is mainly for use in plugins. the (fixed) #GstCaps for which a codec tag should be added. + line="1152">the (fixed) #GstCaps for which a codec tag should be added. @@ -7018,14 +7093,14 @@ function is mainly for use in plugins. version="1.20"> Returns flags that describe the format of the caps if known. No flags are + line="1313">Returns flags that describe the format of the caps if known. No flags are set for unknown caps. #GstPbUtilsCapsDescriptionFlags that describe @caps, or no flags + line="1320">#GstPbUtilsCapsDescriptionFlags that describe @caps, or no flags if the caps are unknown. @@ -7034,7 +7109,7 @@ set for unknown caps. the (fixed) #GstCaps for which flags are requested + line="1315">the (fixed) #GstCaps for which flags are requested @@ -7043,7 +7118,7 @@ set for unknown caps. c:identifier="gst_pb_utils_get_codec_description"> Returns a localised (as far as this is possible) string describing the + line="1197">Returns a localised (as far as this is possible) string describing the media format specified in @caps, for use in error dialogs or other messages to be seen by the user. Should never return NULL unless @caps is invalid. @@ -7054,7 +7129,7 @@ gst_pb_utils_add_codec_description_to_tag_list(). a newly-allocated description string, or NULL on error. Free + line="1208">a newly-allocated description string, or NULL on error. Free string with g_free() when not needed any longer. @@ -7062,7 +7137,7 @@ gst_pb_utils_add_codec_description_to_tag_list(). the (fixed) #GstCaps for which an format description is needed + line="1199">the (fixed) #GstCaps for which an format description is needed @@ -7071,7 +7146,7 @@ gst_pb_utils_add_codec_description_to_tag_list(). c:identifier="gst_pb_utils_get_decoder_description"> Returns a localised string describing an decoder for the format specified + line="1011">Returns a localised string describing an decoder for the format specified in @caps, for use in error dialogs or other messages to be seen by the user. This function is mainly for internal use, applications would typically @@ -7082,7 +7157,7 @@ a missing feature from a missing-plugin message. a newly-allocated description string. Free + line="1022">a newly-allocated description string. Free string with g_free() when not needed any longer. @@ -7090,7 +7165,7 @@ a missing feature from a missing-plugin message. the (fixed) #GstCaps for which an decoder description is needed + line="1013">the (fixed) #GstCaps for which an decoder description is needed @@ -7099,7 +7174,7 @@ a missing feature from a missing-plugin message. c:identifier="gst_pb_utils_get_element_description"> Returns a localised string describing the given element, for use in + line="1116">Returns a localised string describing the given element, for use in error dialogs or other messages to be seen by the user. This function is mainly for internal use, applications would typically @@ -7110,7 +7185,7 @@ a missing feature from a missing-plugin message. a newly-allocated description string. Free + line="1127">a newly-allocated description string. Free string with g_free() when not needed any longer. @@ -7118,7 +7193,7 @@ a missing feature from a missing-plugin message. the name of the element, e.g. "giosrc" + line="1118">the name of the element, e.g. "giosrc" @@ -7127,7 +7202,7 @@ a missing feature from a missing-plugin message. c:identifier="gst_pb_utils_get_encoder_description"> Returns a localised string describing an encoder for the format specified + line="1065">Returns a localised string describing an encoder for the format specified in @caps, for use in error dialogs or other messages to be seen by the user. This function is mainly for internal use, applications would typically @@ -7138,7 +7213,7 @@ a missing feature from a missing-plugin message. a newly-allocated description string. Free + line="1076">a newly-allocated description string. Free string with g_free() when not needed any longer. @@ -7146,7 +7221,7 @@ a missing feature from a missing-plugin message. the (fixed) #GstCaps for which an encoder description is needed + line="1067">the (fixed) #GstCaps for which an encoder description is needed @@ -7156,13 +7231,13 @@ a missing feature from a missing-plugin message. version="1.20"> Returns a possible file extension for the given caps, if known. + line="1295">Returns a possible file extension for the given caps, if known. a newly-allocated file extension string, or NULL on error. Free + line="1301">a newly-allocated file extension string, or NULL on error. Free string with g_free() when not needed any longer. @@ -7170,7 +7245,7 @@ a missing feature from a missing-plugin message. the (fixed) #GstCaps for which a file extension is needed + line="1297">the (fixed) #GstCaps for which a file extension is needed @@ -7179,7 +7254,7 @@ a missing feature from a missing-plugin message. c:identifier="gst_pb_utils_get_sink_description"> Returns a localised string describing a sink element handling the protocol + line="976">Returns a localised string describing a sink element handling the protocol specified in @protocol, for use in error dialogs or other messages to be seen by the user. @@ -7191,7 +7266,7 @@ a missing feature from a missing-plugin message. a newly-allocated description string. Free + line="988">a newly-allocated description string. Free string with g_free() when not needed any longer. @@ -7199,7 +7274,7 @@ a missing feature from a missing-plugin message. the protocol the sink element needs to handle, e.g. "http" + line="978">the protocol the sink element needs to handle, e.g. "http" @@ -7208,7 +7283,7 @@ a missing feature from a missing-plugin message. c:identifier="gst_pb_utils_get_source_description"> Returns a localised string describing a source element handling the protocol + line="926">Returns a localised string describing a source element handling the protocol specified in @protocol, for use in error dialogs or other messages to be seen by the user. @@ -7220,7 +7295,7 @@ a missing feature from a missing-plugin message. a newly-allocated description string. Free + line="938">a newly-allocated description string. Free string with g_free() when not needed any longer. @@ -7228,7 +7303,7 @@ a missing feature from a missing-plugin message. the protocol the source element needs to handle, e.g. "http" + line="928">the protocol the source element needs to handle, e.g. "http" diff --git a/girs/GstPlay-1.0.gir b/girs/GstPlay-1.0.gir index 55f976a2f..03412e169 100644 --- a/girs/GstPlay-1.0.gir +++ b/girs/GstPlay-1.0.gir @@ -442,20 +442,58 @@ and/or use gtk-doc annotations. --> glib:type-name="GstPlay" glib:get-type="gst_play_get_type" glib:type-struct="PlayClass"> + The goal of the GstPlay library is to ease the integration of multimedia +playback features in applications. Thus, if you need to build a media player +from the ground-up, GstPlay provides the features you will most likely need. + +An example player is available in gst-examples/playback/player/gst-play/. + +Internally the GstPlay makes use of the `playbin3` element. The legacy +`playbin2` can be selected if the `GST_PLAY_USE_PLAYBIN3=0` environment +variable has been set. + +**Important note**: If your application relies on the GstBus to get +notifications from GstPlay, you need to add some explicit clean-up code in +order to prevent the GstPlay object from leaking. See below for the details. +If you use the GstPlaySignalAdapter, no special clean-up is required. + +When the GstPlaySignalAdapter is not used, the GstBus owned by GstPlay should +be set to flushing state before any attempt to drop the last reference of the +GstPlay object. An example in C: + +```c +... +GstBus *bus = gst_play_get_message_bus (player); +gst_bus_set_flushing (bus, TRUE); +gst_object_unref (bus); +gst_object_unref (player); +``` + +The messages managed by the player contain a reference to itself, and if the +bus watch is just removed together with dropping the player then the bus will +simply keep them around forever (and the bus never goes away because the +player has a strong reference to it, so there's a reference cycle as long as +there are messages). Setting the bus to flushing state forces it to get rid +of its queued messages, thus breaking any possible reference cycle. Creates a new #GstPlay instance. + line="2731">Creates a new #GstPlay instance. Video is going to be rendered by @video_renderer, or if %NULL is provided no special video set up will be done and some default handling will be -performed. +performed. + +This also initializes GStreamer via `gst_init()` on the first call if this +didn't happen before. a new #GstPlay instance + line="2744">a new #GstPlay instance @@ -465,11 +503,31 @@ performed. allow-none="1"> GstPlayVideoRenderer to use + line="2733">GstPlayVideoRenderer to use + + + + %TRUE if pipeline dumps are included in #GstPlay error message +details. + + + + + a #GstPlay configuration + + + + @@ -477,14 +535,14 @@ performed. current position update interval in milliseconds + line="4481">current position update interval in milliseconds a #GstPlay configuration + line="4479">a #GstPlay configuration @@ -496,14 +554,14 @@ performed. %TRUE if accurate seeking is enabled + line="4528">%TRUE if accurate seeking is enabled a #GstPlay configuration + line="4526">a #GstPlay configuration @@ -513,31 +571,60 @@ performed. version="1.20"> Return the user agent which has been configured using + line="4434">Return the user agent which has been configured using gst_play_config_set_user_agent() if any. the configured agent, or %NULL + line="4441">the configured agent, or %NULL a #GstPlay configuration + line="4436">a #GstPlay configuration + + When enabled, the error message emitted by #GstPlay will include a pipeline +dump (in Graphviz DOT format) in the error details #GstStructure. The field +name is `pipeline-dump`. + +This option is disabled by default. + + + + + + + a #GstPlay configuration + + + + Include pipeline dumps in error details, or not. + + + + set desired interval in milliseconds between two position-updated messages. -pass 0 to stop updating the position. + line="4457">Set desired interval in milliseconds between two position-updated messages. +Pass 0 to stop updating the position. @@ -546,13 +633,13 @@ pass 0 to stop updating the position. a #GstPlay configuration + line="4459">a #GstPlay configuration interval in ms + line="4460">interval in ms @@ -562,7 +649,7 @@ pass 0 to stop updating the position. version="1.20"> Enable or disable accurate seeking. When enabled, elements will try harder + line="4498">Enable or disable accurate seeking. When enabled, elements will try harder to seek as accurately as possible to the requested seek position. Generally it will be slower especially for formats that don't have any indexes or timestamp markers in the stream. @@ -579,13 +666,13 @@ Accurate seeking is disabled by default. a #GstPlay configuration + line="4500">a #GstPlay configuration accurate seek or not + line="4501">accurate seek or not @@ -595,7 +682,7 @@ Accurate seeking is disabled by default. version="1.20"> Set the user agent to pass to the server if @play needs to connect + line="4413">Set the user agent to pass to the server if @play needs to connect to a server during playback. This is typically used when playing HTTP or RTSP streams. @@ -606,7 +693,7 @@ or RTSP streams. a #GstPlay configuration + line="4415">a #GstPlay configuration allow-none="1"> the string to use as user agent + line="4416">the string to use as user agent @@ -692,18 +779,18 @@ matching #GstPlayVideoInfo. - + A #gboolean indicating wheter the passes message represents a #GstPlay message or not. + line="4702">A #gboolean indicating whether the passed message represents a #GstPlay message or not. A #GstMessage + line="4700">A #GstMessage @@ -751,19 +838,19 @@ matching #GstPlayVideoInfo. version="1.20"> Retrieve the current value of audio-video-offset property + line="4073">Retrieve the current value of audio-video-offset property The current value of audio-video-offset in nanoseconds + line="4079">The current value of audio-video-offset in nanoseconds #GstPlay instance + line="4075">#GstPlay instance @@ -773,12 +860,12 @@ matching #GstPlayVideoInfo. version="1.20"> Retrieve the current value of the indicated @type. + line="3958">Retrieve the current value of the indicated @type. The current value of @type, between [0,1]. In case of + line="3965">The current value of @type, between [0,1]. In case of error -1 is returned. @@ -786,13 +873,13 @@ matching #GstPlayVideoInfo. #GstPlay instance + line="3960">#GstPlay instance #GstPlayColorBalanceType + line="3961">#GstPlayColorBalanceType @@ -803,14 +890,14 @@ matching #GstPlayVideoInfo. version="1.20"> Get a copy of the current configuration of the play. This configuration + line="4386">Get a copy of the current configuration of the play. This configuration can either be modified and used for the gst_play_set_config() call or it must be freed after usage. a copy of the current configuration of @play. Use + line="4394">a copy of the current configuration of @play. Use gst_structure_free() after usage or gst_play_set_config(). @@ -818,7 +905,7 @@ gst_structure_free() after usage or gst_play_set_config(). #GstPlay instance + line="4388">#GstPlay instance @@ -829,12 +916,12 @@ gst_structure_free() after usage or gst_play_set_config(). version="1.20"> A Function to get current audio #GstPlayAudioInfo instance. + line="3450">A Function to get current audio #GstPlayAudioInfo instance. current audio track. + line="3456">current audio track. The caller should free it with g_object_unref() @@ -843,7 +930,7 @@ The caller should free it with g_object_unref() #GstPlay instance + line="3452">#GstPlay instance @@ -854,12 +941,12 @@ The caller should free it with g_object_unref() version="1.20"> A Function to get current subtitle #GstPlaySubtitleInfo instance. + line="3516">A Function to get current subtitle #GstPlaySubtitleInfo instance. current subtitle track. + line="3522">current subtitle track. The caller should free it with g_object_unref() @@ -868,7 +955,7 @@ The caller should free it with g_object_unref() #GstPlay instance + line="3518">#GstPlay instance @@ -879,12 +966,12 @@ The caller should free it with g_object_unref() version="1.20"> A Function to get current video #GstPlayVideoInfo instance. + line="3483">A Function to get current video #GstPlayVideoInfo instance. current video track. + line="3489">current video track. The caller should free it with g_object_unref() @@ -893,7 +980,7 @@ The caller should free it with g_object_unref() #GstPlay instance + line="3485">#GstPlay instance @@ -905,7 +992,7 @@ The caller should free it with g_object_unref() Name of the currently enabled + line="3809">Name of the currently enabled visualization. g_free() after usage. @@ -914,7 +1001,7 @@ The caller should free it with g_object_unref() #GstPlay instance + line="3807">#GstPlay instance @@ -925,12 +1012,12 @@ The caller should free it with g_object_unref() version="1.20"> Retrieves the duration of the media stream that self represents. + line="3307">Retrieves the duration of the media stream that self represents. the duration of the currently-playing media stream, in + line="3313">the duration of the currently-playing media stream, in nanoseconds. @@ -938,7 +1025,7 @@ nanoseconds. #GstPlay instance + line="3309">#GstPlay instance @@ -949,12 +1036,12 @@ nanoseconds. version="1.20"> A Function to get the current media info #GstPlayMediaInfo instance. + line="3422">A Function to get the current media info #GstPlayMediaInfo instance. media info instance. + line="3428">media info instance. The caller should free it with g_object_unref() @@ -963,7 +1050,7 @@ The caller should free it with g_object_unref() #GstPlay instance + line="3424">#GstPlay instance @@ -973,7 +1060,7 @@ The caller should free it with g_object_unref() version="1.20"> GstPlay API exposes a #GstBus instance which purpose is to provide data + line="2765">GstPlay API exposes a #GstBus instance which purpose is to provide data structures representing play-internal events in form of #GstMessage<!-- -->s of type GST_MESSAGE_APPLICATION. @@ -989,14 +1076,14 @@ fill memory. To avoid that, the bus has to be set "flushing". The play message bus instance + line="2782">The play message bus instance #GstPlay instance + line="2767">#GstPlay instance @@ -1006,12 +1093,12 @@ fill memory. To avoid that, the bus has to be set "flushing". version="1.20"> Retrieve the current value of the indicated @type. + line="4033">Retrieve the current value of the indicated @type. The current value of @type, Default: 0x00000000 "none + line="4039">The current value of @type, Default: 0x00000000 "none @@ -1019,7 +1106,7 @@ fill memory. To avoid that, the bus has to be set "flushing". #GstPlay instance + line="4035">#GstPlay instance @@ -1029,12 +1116,12 @@ fill memory. To avoid that, the bus has to be set "flushing". version="1.20"> Retrieve the current value of the indicated @type. + line="3992">Retrieve the current value of the indicated @type. The current value of @type, Default: -1 "none" + line="3998">The current value of @type, Default: -1 "none" @@ -1042,7 +1129,7 @@ fill memory. To avoid that, the bus has to be set "flushing". #GstPlay instance + line="3994">#GstPlay instance @@ -1055,14 +1142,14 @@ fill memory. To avoid that, the bus has to be set "flushing". %TRUE if the currently-playing stream is muted. + line="3370">%TRUE if the currently-playing stream is muted. #GstPlay instance + line="3368">#GstPlay instance @@ -1075,7 +1162,7 @@ fill memory. To avoid that, the bus has to be set "flushing". The internal playbin instance. + line="3405">The internal playbin instance. The caller should free it with g_object_unref() @@ -1084,7 +1171,7 @@ The caller should free it with g_object_unref() #GstPlay instance + line="3403">#GstPlay instance @@ -1097,7 +1184,7 @@ The caller should free it with g_object_unref() the absolute position time, in nanoseconds, of the + line="3291">the absolute position time, in nanoseconds, of the currently-playing stream. @@ -1105,7 +1192,7 @@ currently-playing stream. #GstPlay instance + line="3289">#GstPlay instance @@ -1118,14 +1205,14 @@ currently-playing stream. current playback rate + line="3125">current playback rate #GstPlay instance + line="3123">#GstPlay instance @@ -1135,12 +1222,12 @@ currently-playing stream. version="1.20"> current subtitle URI + line="3265">Current subtitle URI URI of the current external subtitle. + line="3271">URI of the current external subtitle. g_free() after usage. @@ -1148,7 +1235,7 @@ currently-playing stream. #GstPlay instance + line="3267">#GstPlay instance @@ -1159,19 +1246,19 @@ currently-playing stream. version="1.20"> Retrieve the current value of subtitle-video-offset property + line="4112">Retrieve the current value of subtitle-video-offset property The current value of subtitle-video-offset in nanoseconds + line="4118">The current value of subtitle-video-offset in nanoseconds #GstPlay instance + line="4114">#GstPlay instance @@ -1182,12 +1269,12 @@ currently-playing stream. version="1.20"> Gets the URI of the currently-playing stream. + line="3209">Gets the URI of the currently-playing stream. a string containing the URI of the + line="3215">a string containing the URI of the currently-playing stream. g_free() after usage. @@ -1195,7 +1282,7 @@ currently-playing stream. g_free() after usage. #GstPlay instance + line="3211">#GstPlay instance @@ -1205,30 +1292,30 @@ currently-playing stream. g_free() after usage. version="1.20"> Get a snapshot of the currently selected video stream, if any. The format can be -selected with @format and optional configuration is possible with @config + line="4590">Get a snapshot of the currently selected video stream, if any. The format can be +selected with @format and optional configuration is possible with @config. Currently supported settings are: - width, height of type G_TYPE_INT - pixel-aspect-ratio of type GST_TYPE_FRACTION Except for GST_PLAY_THUMBNAIL_RAW_NATIVE format, if no config is set, pixel-aspect-ratio would be 1/1 - + Current video snapshot sample or %NULL on failure + line="4603">Current video snapshot sample or %NULL on failure #GstPlay instance + line="4592">#GstPlay instance output format of the video snapshot + line="4593">output format of the video snapshot Additional configuration + line="4594">Additional configuration @@ -1248,19 +1335,19 @@ Currently supported settings are: version="1.20"> Returns the current volume level, as a percentage between 0 and 1. + line="3329">Returns the current volume level, as a percentage between 0 and 1. the volume as percentage between 0 and 1. + line="3335">the volume as percentage between 0 and 1. #GstPlay instance + line="3331">#GstPlay instance @@ -1270,12 +1357,12 @@ Currently supported settings are: version="1.20"> Checks whether the @play has color balance support available. + line="3896">Checks whether the @play has color balance support available. %TRUE if @play has color balance support. Otherwise, + line="3902">%TRUE if @play has color balance support. Otherwise, %FALSE. @@ -1283,7 +1370,7 @@ Currently supported settings are: #GstPlay instance + line="3898">#GstPlay instance @@ -1291,7 +1378,7 @@ Currently supported settings are: Pauses the current stream. + line="2916">Pauses the current stream. @@ -1300,7 +1387,7 @@ Currently supported settings are: #GstPlay instance + line="2918">#GstPlay instance @@ -1308,7 +1395,7 @@ Currently supported settings are: Request to play the loaded stream. + line="2848">Request to play the loaded stream. @@ -1317,7 +1404,7 @@ Currently supported settings are: #GstPlay instance + line="2850">#GstPlay instance @@ -1325,7 +1412,7 @@ Currently supported settings are: Seeks the currently-playing stream to the absolute @position time + line="3140">Seeks the currently-playing stream to the absolute @position time in nanoseconds. @@ -1335,13 +1422,13 @@ in nanoseconds. #GstPlay instance + line="3142">#GstPlay instance position to seek in nanoseconds + line="3143">position to seek in nanoseconds @@ -1353,7 +1440,7 @@ in nanoseconds. %TRUE or %FALSE + line="3581">%TRUE or %FALSE Sets the audio track @stream_index. @@ -1362,13 +1449,13 @@ Sets the audio track @stream_index. #GstPlay instance + line="3578">#GstPlay instance stream index + line="3579">stream index @@ -1378,7 +1465,7 @@ Sets the audio track @stream_index. version="1.20"> Enable or disable the current audio track. + line="3702">Enable or disable the current audio track. @@ -1387,13 +1474,13 @@ Sets the audio track @stream_index. #GstPlay instance + line="3704">#GstPlay instance TRUE or FALSE + line="3705">TRUE or FALSE @@ -1404,7 +1491,7 @@ Sets the audio track @stream_index. version="1.20"> Sets audio-video-offset property by value of @offset + line="4095">Sets audio-video-offset property by value of @offset @@ -1413,13 +1500,13 @@ Sets the audio track @stream_index. #GstPlay instance + line="4097">#GstPlay instance #gint64 in nanoseconds + line="4098">#gint64 in nanoseconds @@ -1429,7 +1516,7 @@ Sets the audio track @stream_index. version="1.20"> Sets the current value of the indicated channel @type to the passed + line="3921">Sets the current value of the indicated channel @type to the passed value. @@ -1439,20 +1526,20 @@ value. #GstPlay instance + line="3923">#GstPlay instance #GstPlayColorBalanceType + line="3924">#GstPlayColorBalanceType The new value for the @type, ranged [0,1] + line="3925">The new value for the @type, ranged [0,1] @@ -1462,8 +1549,8 @@ value. version="1.20"> Set the configuration of the play. If the play is already configured, and -the configuration haven't change, this function will return %TRUE. If the + line="4345">Set the configuration of the play. If the play is already configured, and +the configuration hasn't changed, this function will return %TRUE. If the play is not in the GST_PLAY_STATE_STOPPED, this method will return %FALSE and active configuration will remain. @@ -1475,20 +1562,20 @@ This function takes ownership of @config. %TRUE when the configuration could be set. + line="4360">%TRUE when the configuration could be set. #GstPlay instance + line="4347">#GstPlay instance a #GstStructure + line="4348">a #GstStructure @@ -1498,7 +1585,7 @@ This function takes ownership of @config. version="1.20"> Sets the current value of the indicated mode @type to the passed + line="4055">Sets the current value of the indicated mode @type to the passed value. @@ -1508,13 +1595,13 @@ value. #GstPlay instance + line="4057">#GstPlay instance The new value for the @type + line="4058">The new value for the @type @@ -1525,7 +1612,7 @@ value. version="1.20"> Sets the current value of the indicated mode @type to the passed + line="4015">Sets the current value of the indicated mode @type to the passed value. @@ -1535,13 +1622,13 @@ value. #GstPlay instance + line="4017">#GstPlay instance The new value for the @type + line="4018">The new value for the @type @@ -1553,7 +1640,7 @@ value. version="1.20"> %TRUE if the currently-playing stream should be muted. + line="3385">%TRUE if the currently-playing stream should be muted. @@ -1562,13 +1649,13 @@ value. #GstPlay instance + line="3387">#GstPlay instance Mute state the should be set + line="3388">Mute state the should be set @@ -1579,7 +1666,7 @@ value. version="1.20"> Playback at specified rate + line="3104">Playback at specified rate @@ -1588,13 +1675,13 @@ value. #GstPlay instance + line="3106">#GstPlay instance playback rate + line="3107">playback rate @@ -1606,7 +1693,7 @@ value. %TRUE or %FALSE + line="3666">%TRUE or %FALSE Sets the subtitle stack @stream_index. @@ -1615,13 +1702,13 @@ Sets the subtitle stack @stream_index. #GstPlay instance + line="3663">#GstPlay instance stream index + line="3664">stream index @@ -1631,7 +1718,7 @@ Sets the subtitle stack @stream_index. version="1.20"> Enable or disable the current subtitle track. + line="3744">Enable or disable the current subtitle track. @@ -1640,13 +1727,13 @@ Sets the subtitle stack @stream_index. #GstPlay instance + line="3746">#GstPlay instance TRUE or FALSE + line="3747">TRUE or FALSE @@ -1656,7 +1743,7 @@ Sets the subtitle stack @stream_index. version="1.20"> Sets the external subtitle URI. This should be combined with a call to + line="3247">Sets the external subtitle URI. This should be combined with a call to gst_play_set_subtitle_track_enabled(@play, TRUE) so the subtitles are actually rendered. @@ -1667,7 +1754,7 @@ rendered. #GstPlay instance + line="3249">#GstPlay instance allow-none="1"> subtitle URI + line="3250">subtitle URI @@ -1687,7 +1774,7 @@ rendered. version="1.20"> Sets subtitle-video-offset property by value of @offset + line="4134">Sets subtitle-video-offset property by value of @offset @@ -1696,13 +1783,13 @@ rendered. #GstPlay instance + line="4136">#GstPlay instance #gint64 in nanoseconds + line="4137">#gint64 in nanoseconds @@ -1713,7 +1800,7 @@ rendered. version="1.20"> Sets the next URI to play. + line="3231">Sets the next URI to play. @@ -1722,7 +1809,7 @@ rendered. #GstPlay instance + line="3233">#GstPlay instance allow-none="1"> next URI to play. + line="3234">next URI to play. @@ -1743,7 +1830,7 @@ rendered. %TRUE or %FALSE + line="3623">%TRUE or %FALSE Sets the video track @stream_index. @@ -1752,13 +1839,13 @@ Sets the video track @stream_index. #GstPlay instance + line="3620">#GstPlay instance stream index + line="3621">stream index @@ -1768,7 +1855,7 @@ Sets the video track @stream_index. version="1.20"> Enable or disable the current video track. + line="3723">Enable or disable the current video track. @@ -1777,13 +1864,13 @@ Sets the video track @stream_index. #GstPlay instance + line="3725">#GstPlay instance TRUE or FALSE + line="3726">TRUE or FALSE @@ -1795,7 +1882,7 @@ Sets the video track @stream_index. %TRUE if the visualizations was set correctly. Otherwise, + line="3771">%TRUE if the visualization was set correctly. Otherwise, %FALSE. @@ -1803,7 +1890,7 @@ Sets the video track @stream_index. #GstPlay instance + line="3767">#GstPlay instance allow-none="1"> visualization element obtained from + line="3768">visualization element obtained from #gst_play_visualizations_get() @@ -1823,7 +1910,7 @@ Sets the video track @stream_index. version="1.20"> Enable or disable the visualization. + line="3839">Enable or disable the visualization. @@ -1832,13 +1919,13 @@ Sets the video track @stream_index. #GstPlay instance + line="3841">#GstPlay instance TRUE or FALSE + line="3842">TRUE or FALSE @@ -1849,7 +1936,7 @@ Sets the video track @stream_index. version="1.20"> Sets the volume level of the stream as a percentage between 0 and 1. + line="3350">Sets the volume level of the stream as a percentage between 0 and 1. @@ -1858,13 +1945,13 @@ Sets the video track @stream_index. #GstPlay instance + line="3352">#GstPlay instance the new volume level, as a percentage between 0 and 1 + line="3353">the new volume level, as a percentage between 0 and 1 @@ -1872,7 +1959,7 @@ Sets the video track @stream_index. Stops playing the current stream and resets to the first position + line="3001">Stops playing the current stream and resets to the first position in the stream. @@ -1882,7 +1969,7 @@ in the stream. #GstPlay instance + line="3003">#GstPlay instance @@ -2170,12 +2257,12 @@ gain. version="1.20"> Gets a string representing the given color balance type. + line="4179">Gets a string representing the given color balance type. a string with the name of the color + line="4185">a string with the name of the color balance type. @@ -2183,7 +2270,7 @@ gain. a #GstPlayColorBalanceType + line="4181">a #GstPlayColorBalanceType @@ -2210,19 +2297,19 @@ gain. version="1.20"> Gets a string representing the given error. + line="4324">Gets a string representing the given error. a string with the given error. + line="4330">a string with the given error. a #GstPlayError + line="4326">a #GstPlayError @@ -2727,14 +2814,14 @@ See also #gst_play_get_message_bus() a string with the name of the message. + line="4292">a string with the name of the message. a #GstPlayMessage + line="4290">a #GstPlayMessage @@ -2744,8 +2831,8 @@ See also #gst_play_get_message_bus() version="1.20"> Parse the given buffering-percent @msg and extract the corresponding value - + line="4791">Parse the given buffering-percent @msg and extract the corresponding value + @@ -2753,7 +2840,7 @@ See also #gst_play_get_message_bus() A #GstMessage + line="4793">A #GstMessage allow-none="1"> the resulting buffering percent + line="4794">the resulting buffering percent @@ -2774,8 +2861,8 @@ See also #gst_play_get_message_bus() version="1.20"> Parse the given duration @msg and extract the corresponding #GstClockTime - + line="4741">Parse the given duration @msg and extract the corresponding #GstClockTime + @@ -2783,7 +2870,7 @@ See also #gst_play_get_message_bus() A #GstMessage + line="4743">A #GstMessage allow-none="1"> the resulting duration + line="4744">the resulting duration @@ -2804,8 +2891,8 @@ See also #gst_play_get_message_bus() version="1.20"> Parse the given error @msg and extract the corresponding #GError - + line="4807">Parse the given error @msg and extract the corresponding #GError + @@ -2813,7 +2900,7 @@ See also #gst_play_get_message_bus() A #GstMessage + line="4809">A #GstMessage allow-none="1"> the resulting error + line="4810">the resulting error allow-none="1"> A #GstStructure containing additional details about the error + line="4811">A #GstStructure containing additional details about the error @@ -2846,8 +2933,8 @@ See also #gst_play_get_message_bus() version="1.20"> Parse the given @msg and extract the corresponding media information - + line="4865">Parse the given @msg and extract the corresponding media information + @@ -2855,7 +2942,7 @@ See also #gst_play_get_message_bus() A #GstMessage + line="4867">A #GstMessage allow-none="1"> the resulting media info + line="4868">the resulting media info @@ -2876,8 +2963,8 @@ See also #gst_play_get_message_bus() version="1.20"> Parse the given @msg and extract the corresponding audio muted state - + line="4898">Parse the given @msg and extract the corresponding audio muted state + @@ -2885,7 +2972,7 @@ See also #gst_play_get_message_bus() A #GstMessage + line="4900">A #GstMessage allow-none="1"> the resulting audio muted state + line="4901">the resulting audio muted state @@ -2906,8 +2993,8 @@ See also #gst_play_get_message_bus() version="1.20"> Parse the given position @msg and extract the corresponding #GstClockTime - + line="4758">Parse the given position @msg and extract the corresponding #GstClockTime + @@ -2915,7 +3002,7 @@ See also #gst_play_get_message_bus() A #GstMessage + line="4760">A #GstMessage allow-none="1"> the resulting position + line="4761">the resulting position @@ -2936,8 +3023,8 @@ See also #gst_play_get_message_bus() version="1.20"> Parse the given state @msg and extract the corresponding #GstPlayState - + line="4775">Parse the given state @msg and extract the corresponding #GstPlayState + @@ -2945,7 +3032,7 @@ See also #gst_play_get_message_bus() A #GstMessage + line="4777">A #GstMessage allow-none="1"> the resulting play state + line="4778">the resulting play state @@ -2966,8 +3053,8 @@ See also #gst_play_get_message_bus() version="1.20"> Parse the given @msg and extract its #GstPlayMessage type. - + line="4725">Parse the given @msg and extract its #GstPlayMessage type. + @@ -2975,7 +3062,7 @@ See also #gst_play_get_message_bus() A #GstMessage + line="4727">A #GstMessage allow-none="1"> the resulting message type + line="4728">the resulting message type @@ -2996,8 +3083,8 @@ See also #gst_play_get_message_bus() version="1.20"> Parse the given @msg and extract the corresponding video dimensions - + line="4845">Parse the given @msg and extract the corresponding video dimensions + @@ -3005,7 +3092,7 @@ See also #gst_play_get_message_bus() A #GstMessage + line="4847">A #GstMessage allow-none="1"> the resulting video width + line="4848">the resulting video width allow-none="1"> the resulting video height + line="4849">the resulting video height @@ -3037,8 +3124,8 @@ See also #gst_play_get_message_bus() version="1.20"> Parse the given @msg and extract the corresponding audio volume - + line="4882">Parse the given @msg and extract the corresponding audio volume + @@ -3046,7 +3133,7 @@ See also #gst_play_get_message_bus() A #GstMessage + line="4884">A #GstMessage allow-none="1"> the resulting audio volume + line="4885">the resulting audio volume @@ -3067,8 +3154,8 @@ See also #gst_play_get_message_bus() version="1.20"> Parse the given error @msg and extract the corresponding #GError warning - + line="4826">Parse the given error @msg and extract the corresponding #GError warning + @@ -3076,7 +3163,7 @@ See also #gst_play_get_message_bus() A #GstMessage + line="4828">A #GstMessage allow-none="1"> the resulting warning + line="4829">the resulting warning allow-none="1"> A #GstStructure containing additional details about the warning + line="4830">A #GstStructure containing additional details about the warning @@ -3254,7 +3341,7 @@ it on the created adapter object. Emitted on errors. + line="425">Emitted on errors. @@ -3262,7 +3349,7 @@ it on the created adapter object. The error + line="428">The error allow-none="1"> Additional error details + line="429">Additional error details @@ -3377,7 +3464,7 @@ it on the created adapter object. Emitted on warnings. + line="458">Emitted on warnings. @@ -3385,7 +3472,7 @@ it on the created adapter object. The warning + line="461">The warning allow-none="1"> Additional warning details + line="462">Additional warning details @@ -3410,37 +3497,37 @@ it on the created adapter object. - + raw native format. + line="390">raw native format. raw xRGB format. + line="391">raw xRGB format. raw BGRx format. + line="392">raw BGRx format. jpeg format. + line="393">jpeg format. png format. + line="394">png format. version="1.20"> Gets a string representing the given state. + line="4261">Gets a string representing the given state. a string with the name of the state. + line="4267">a string with the name of the state. a #GstPlayState + line="4263">a #GstPlayState @@ -4262,12 +4349,12 @@ freed using gst_play_visualization_free(). version="1.20"> Gets a string representing the given color balance type. + line="4179">Gets a string representing the given color balance type. a string with the name of the color + line="4185">a string with the name of the color balance type. @@ -4275,7 +4362,7 @@ freed using gst_play_visualization_free(). a #GstPlayColorBalanceType + line="4181">a #GstPlayColorBalanceType @@ -4286,19 +4373,19 @@ freed using gst_play_visualization_free(). version="1.20"> Gets a string representing the given error. + line="4324">Gets a string representing the given error. a string with the given error. + line="4330">a string with the given error. a #GstPlayError + line="4326">a #GstPlayError @@ -4319,14 +4406,14 @@ freed using gst_play_visualization_free(). a string with the name of the message. + line="4292">a string with the name of the message. a #GstPlayMessage + line="4290">a #GstPlayMessage @@ -4337,8 +4424,8 @@ freed using gst_play_visualization_free(). version="1.20"> Parse the given buffering-percent @msg and extract the corresponding value - + line="4791">Parse the given buffering-percent @msg and extract the corresponding value + @@ -4346,7 +4433,7 @@ freed using gst_play_visualization_free(). A #GstMessage + line="4793">A #GstMessage allow-none="1"> the resulting buffering percent + line="4794">the resulting buffering percent @@ -4368,8 +4455,8 @@ freed using gst_play_visualization_free(). version="1.20"> Parse the given duration @msg and extract the corresponding #GstClockTime - + line="4741">Parse the given duration @msg and extract the corresponding #GstClockTime + @@ -4377,7 +4464,7 @@ freed using gst_play_visualization_free(). A #GstMessage + line="4743">A #GstMessage allow-none="1"> the resulting duration + line="4744">the resulting duration @@ -4399,8 +4486,8 @@ freed using gst_play_visualization_free(). version="1.20"> Parse the given error @msg and extract the corresponding #GError - + line="4807">Parse the given error @msg and extract the corresponding #GError + @@ -4408,7 +4495,7 @@ freed using gst_play_visualization_free(). A #GstMessage + line="4809">A #GstMessage allow-none="1"> the resulting error + line="4810">the resulting error allow-none="1"> A #GstStructure containing additional details about the error + line="4811">A #GstStructure containing additional details about the error @@ -4442,8 +4529,8 @@ freed using gst_play_visualization_free(). version="1.20"> Parse the given @msg and extract the corresponding media information - + line="4865">Parse the given @msg and extract the corresponding media information + @@ -4451,7 +4538,7 @@ freed using gst_play_visualization_free(). A #GstMessage + line="4867">A #GstMessage allow-none="1"> the resulting media info + line="4868">the resulting media info @@ -4473,8 +4560,8 @@ freed using gst_play_visualization_free(). version="1.20"> Parse the given @msg and extract the corresponding audio muted state - + line="4898">Parse the given @msg and extract the corresponding audio muted state + @@ -4482,7 +4569,7 @@ freed using gst_play_visualization_free(). A #GstMessage + line="4900">A #GstMessage allow-none="1"> the resulting audio muted state + line="4901">the resulting audio muted state @@ -4504,8 +4591,8 @@ freed using gst_play_visualization_free(). version="1.20"> Parse the given position @msg and extract the corresponding #GstClockTime - + line="4758">Parse the given position @msg and extract the corresponding #GstClockTime + @@ -4513,7 +4600,7 @@ freed using gst_play_visualization_free(). A #GstMessage + line="4760">A #GstMessage allow-none="1"> the resulting position + line="4761">the resulting position @@ -4535,8 +4622,8 @@ freed using gst_play_visualization_free(). version="1.20"> Parse the given state @msg and extract the corresponding #GstPlayState - + line="4775">Parse the given state @msg and extract the corresponding #GstPlayState + @@ -4544,7 +4631,7 @@ freed using gst_play_visualization_free(). A #GstMessage + line="4777">A #GstMessage allow-none="1"> the resulting play state + line="4778">the resulting play state @@ -4566,8 +4653,8 @@ freed using gst_play_visualization_free(). version="1.20"> Parse the given @msg and extract its #GstPlayMessage type. - + line="4725">Parse the given @msg and extract its #GstPlayMessage type. + @@ -4575,7 +4662,7 @@ freed using gst_play_visualization_free(). A #GstMessage + line="4727">A #GstMessage allow-none="1"> the resulting message type + line="4728">the resulting message type @@ -4597,8 +4684,8 @@ freed using gst_play_visualization_free(). version="1.20"> Parse the given @msg and extract the corresponding video dimensions - + line="4845">Parse the given @msg and extract the corresponding video dimensions + @@ -4606,7 +4693,7 @@ freed using gst_play_visualization_free(). A #GstMessage + line="4847">A #GstMessage allow-none="1"> the resulting video width + line="4848">the resulting video width allow-none="1"> the resulting video height + line="4849">the resulting video height @@ -4639,8 +4726,8 @@ freed using gst_play_visualization_free(). version="1.20"> Parse the given @msg and extract the corresponding audio volume - + line="4882">Parse the given @msg and extract the corresponding audio volume + @@ -4648,7 +4735,7 @@ freed using gst_play_visualization_free(). A #GstMessage + line="4884">A #GstMessage allow-none="1"> the resulting audio volume + line="4885">the resulting audio volume @@ -4670,8 +4757,8 @@ freed using gst_play_visualization_free(). version="1.20"> Parse the given error @msg and extract the corresponding #GError warning - + line="4826">Parse the given error @msg and extract the corresponding #GError warning + @@ -4679,7 +4766,7 @@ freed using gst_play_visualization_free(). A #GstMessage + line="4828">A #GstMessage allow-none="1"> the resulting warning + line="4829">the resulting warning allow-none="1"> A #GstStructure containing additional details about the warning + line="4830">A #GstStructure containing additional details about the warning @@ -4713,19 +4800,19 @@ freed using gst_play_visualization_free(). version="1.20"> Gets a string representing the given state. + line="4261">Gets a string representing the given state. a string with the name of the state. + line="4267">a string with the name of the state. a #GstPlayState + line="4263">a #GstPlayState diff --git a/girs/GstPlayer-1.0.gir b/girs/GstPlayer-1.0.gir index 0e842c7f5..66fd6a2b6 100644 --- a/girs/GstPlayer-1.0.gir +++ b/girs/GstPlayer-1.0.gir @@ -483,13 +483,16 @@ passed. See gst_player_g_main_context_signal_dispatcher_new(). Video is going to be rendered by @video_renderer, or if %NULL is provided no special video set up will be done and some default handling will be -performed. +performed. + +This also initializes GStreamer via `gst_init()` on the first call if this +didn't happen before. a new #GstPlayer instance + line="631">a new #GstPlayer instance @@ -522,14 +525,14 @@ performed. current position update interval in milliseconds + line="1682">current position update interval in milliseconds a #GstPlayer configuration + line="1680">a #GstPlayer configuration @@ -542,14 +545,14 @@ performed. %TRUE if accurate seeking is enabled + line="1729">%TRUE if accurate seeking is enabled a #GstPlayer configuration + line="1727">a #GstPlayer configuration @@ -559,21 +562,21 @@ performed. version="1.10"> Return the user agent which has been configured using + line="1633">Return the user agent which has been configured using gst_player_config_set_user_agent() if any. the configured agent, or %NULL + line="1640">the configured agent, or %NULL a #GstPlayer configuration + line="1635">a #GstPlayer configuration @@ -583,7 +586,7 @@ gst_player_config_set_user_agent() if any. version="1.10"> set interval in milliseconds between two position-updated signals. + line="1657">set interval in milliseconds between two position-updated signals. pass 0 to stop updating the position. @@ -594,13 +597,13 @@ pass 0 to stop updating the position. a #GstPlayer configuration + line="1659">a #GstPlayer configuration interval in ms + line="1660">interval in ms @@ -610,7 +613,7 @@ pass 0 to stop updating the position. version="1.12"> Enable or disable accurate seeking. When enabled, elements will try harder + line="1699">Enable or disable accurate seeking. When enabled, elements will try harder to seek as accurately as possible to the requested seek position. Generally it will be slower especially for formats that don't have any indexes or timestamp markers in the stream. @@ -628,13 +631,13 @@ Accurate seeking is disabled by default. a #GstPlayer configuration + line="1701">a #GstPlayer configuration accurate seek or not + line="1702">accurate seek or not @@ -644,7 +647,7 @@ Accurate seeking is disabled by default. version="1.10"> Set the user agent to pass to the server if @player needs to connect + line="1612">Set the user agent to pass to the server if @player needs to connect to a server during playback. This is typically used when playing HTTP or RTSP streams. a #GstPlayer configuration + line="1614">a #GstPlayer configuration allow-none="1"> the string to use as user agent + line="1615">the string to use as user agent @@ -778,20 +781,20 @@ matching #GstPlayerVideoInfo. version="1.10"> Retrieve the current value of audio-video-offset property + line="1356">Retrieve the current value of audio-video-offset property The current value of audio-video-offset in nanoseconds + line="1362">The current value of audio-video-offset in nanoseconds #GstPlayer instance + line="1358">#GstPlayer instance @@ -800,13 +803,13 @@ matching #GstPlayerVideoInfo. c:identifier="gst_player_get_color_balance"> Retrieve the current value of the indicated @type. + line="1255">Retrieve the current value of the indicated @type. The current value of @type, between [0,1]. In case of + line="1262">The current value of @type, between [0,1]. In case of error -1 is returned. @@ -814,13 +817,13 @@ matching #GstPlayerVideoInfo. #GstPlayer instance + line="1257">#GstPlayer instance #GstPlayerColorBalanceType + line="1258">#GstPlayerColorBalanceType @@ -831,7 +834,7 @@ matching #GstPlayerVideoInfo. version="1.10"> Get a copy of the current configuration of the player. This configuration + line="1591">Get a copy of the current configuration of the player. This configuration can either be modified and used for the gst_player_set_config() call or it must be freed after usage. a copy of the current configuration of @player. Use + line="1599">a copy of the current configuration of @player. Use gst_structure_free() after usage or gst_player_set_config(). @@ -847,7 +850,7 @@ gst_structure_free() after usage or gst_player_set_config(). #GstPlayer instance + line="1593">#GstPlayer instance @@ -857,13 +860,13 @@ gst_structure_free() after usage or gst_player_set_config(). glib:get-property="current-audio-track"> A Function to get current audio #GstPlayerAudioInfo instance. + line="983">A Function to get current audio #GstPlayerAudioInfo instance. current audio track. + line="989">current audio track. The caller should free it with g_object_unref() @@ -872,7 +875,7 @@ The caller should free it with g_object_unref() #GstPlayer instance + line="985">#GstPlayer instance @@ -882,13 +885,13 @@ The caller should free it with g_object_unref() glib:get-property="current-subtitle-track"> A Function to get current subtitle #GstPlayerSubtitleInfo instance. + line="1035">A Function to get current subtitle #GstPlayerSubtitleInfo instance. current subtitle track. + line="1041">current subtitle track. The caller should free it with g_object_unref() @@ -897,7 +900,7 @@ The caller should free it with g_object_unref() #GstPlayer instance + line="1037">#GstPlayer instance @@ -907,13 +910,13 @@ The caller should free it with g_object_unref() glib:get-property="current-video-track"> A Function to get current video #GstPlayerVideoInfo instance. + line="1009">A Function to get current video #GstPlayerVideoInfo instance. current video track. + line="1015">current video track. The caller should free it with g_object_unref() @@ -922,7 +925,7 @@ The caller should free it with g_object_unref() #GstPlayer instance + line="1011">#GstPlayer instance @@ -934,7 +937,7 @@ The caller should free it with g_object_unref() Name of the currently enabled + line="1178">Name of the currently enabled visualization. g_free() after usage. @@ -943,7 +946,7 @@ The caller should free it with g_object_unref() #GstPlayer instance + line="1176">#GstPlayer instance @@ -953,13 +956,13 @@ The caller should free it with g_object_unref() glib:get-property="duration"> Retrieves the duration of the media stream that self represents. + line="843">Retrieves the duration of the media stream that self represents. the duration of the currently-playing media stream, in + line="849">the duration of the currently-playing media stream, in nanoseconds. @@ -967,7 +970,7 @@ nanoseconds. #GstPlayer instance + line="845">#GstPlayer instance @@ -977,13 +980,13 @@ nanoseconds. glib:get-property="media-info"> A Function to get the current media info #GstPlayerMediaInfo instance. + line="956">A Function to get the current media info #GstPlayerMediaInfo instance. media info instance. + line="962">media info instance. The caller should free it with g_object_unref() @@ -992,7 +995,7 @@ The caller should free it with g_object_unref() #GstPlayer instance + line="958">#GstPlayer instance @@ -1002,13 +1005,13 @@ The caller should free it with g_object_unref() version="1.10"> Retrieve the current value of the indicated @type. + line="1316">Retrieve the current value of the indicated @type. The current value of @type, Default: 0x00000000 "none + line="1322">The current value of @type, Default: 0x00000000 "none @@ -1016,7 +1019,7 @@ The caller should free it with g_object_unref() #GstPlayer instance + line="1318">#GstPlayer instance @@ -1026,13 +1029,13 @@ The caller should free it with g_object_unref() version="1.10"> Retrieve the current value of the indicated @type. + line="1274">Retrieve the current value of the indicated @type. The current value of @type, Default: -1 "none" + line="1280">The current value of @type, Default: -1 "none" @@ -1040,7 +1043,7 @@ The caller should free it with g_object_unref() #GstPlayer instance + line="1276">#GstPlayer instance @@ -1053,14 +1056,14 @@ The caller should free it with g_object_unref() %TRUE if the currently-playing stream is muted. + line="907">%TRUE if the currently-playing stream is muted. #GstPlayer instance + line="905">#GstPlayer instance @@ -1073,7 +1076,7 @@ The caller should free it with g_object_unref() The internal playbin instance. + line="940">The internal playbin instance. The caller should free it with g_object_unref() @@ -1082,7 +1085,7 @@ The caller should free it with g_object_unref() #GstPlayer instance + line="938">#GstPlayer instance @@ -1095,7 +1098,7 @@ The caller should free it with g_object_unref() the absolute position time, in nanoseconds, of the + line="828">the absolute position time, in nanoseconds, of the currently-playing stream. @@ -1103,7 +1106,7 @@ currently-playing stream. #GstPlayer instance + line="826">#GstPlayer instance @@ -1116,14 +1119,14 @@ currently-playing stream. current playback rate + line="719">current playback rate #GstPlayer instance + line="717">#GstPlayer instance @@ -1132,13 +1135,13 @@ currently-playing stream. c:identifier="gst_player_get_subtitle_uri"> current subtitle URI + line="803">current subtitle URI URI of the current external subtitle. + line="809">URI of the current external subtitle. g_free() after usage. @@ -1146,7 +1149,7 @@ currently-playing stream. #GstPlayer instance + line="805">#GstPlayer instance @@ -1157,20 +1160,20 @@ currently-playing stream. version="1.16"> Retrieve the current value of subtitle-video-offset property + line="1395">Retrieve the current value of subtitle-video-offset property The current value of subtitle-video-offset in nanoseconds + line="1401">The current value of subtitle-video-offset in nanoseconds #GstPlayer instance + line="1397">#GstPlayer instance @@ -1180,13 +1183,13 @@ currently-playing stream. glib:get-property="uri"> Gets the URI of the currently-playing stream. + line="750">Gets the URI of the currently-playing stream. a string containing the URI of the + line="756">a string containing the URI of the currently-playing stream. g_free() after usage. @@ -1194,7 +1197,7 @@ currently-playing stream. g_free() after usage. #GstPlayer instance + line="752">#GstPlayer instance @@ -1204,7 +1207,7 @@ currently-playing stream. g_free() after usage. version="1.12"> Get a snapshot of the currently selected video stream, if any. The format can be + line="1746">Get a snapshot of the currently selected video stream, if any. The format can be selected with @format and optional configuration is possible with @config Currently supported settings are: - width, height of type G_TYPE_INT @@ -1215,20 +1218,20 @@ Currently supported settings are: Current video snapshot sample or %NULL on failure + line="1759">Current video snapshot sample or %NULL on failure #GstPlayer instance + line="1748">#GstPlayer instance output format of the video snapshot + line="1749">output format of the video snapshot @@ -1238,7 +1241,7 @@ Currently supported settings are: allow-none="1"> Additional configuration + line="1750">Additional configuration @@ -1248,20 +1251,20 @@ Currently supported settings are: glib:get-property="volume"> Returns the current volume level, as a percentage between 0 and 1. + line="864">Returns the current volume level, as a percentage between 0 and 1. the volume as percentage between 0 and 1. + line="870">the volume as percentage between 0 and 1. #GstPlayer instance + line="866">#GstPlayer instance @@ -1270,13 +1273,13 @@ Currently supported settings are: c:identifier="gst_player_has_color_balance"> Checks whether the @player has color balance support available. + line="1218">Checks whether the @player has color balance support available. %TRUE if @player has color balance support. Otherwise, + line="1224">%TRUE if @player has color balance support. Otherwise, %FALSE. @@ -1284,7 +1287,7 @@ Currently supported settings are: #GstPlayer instance + line="1220">#GstPlayer instance @@ -1292,7 +1295,7 @@ Currently supported settings are: Pauses the current stream. + line="670">Pauses the current stream. @@ -1302,7 +1305,7 @@ Currently supported settings are: #GstPlayer instance + line="672">#GstPlayer instance @@ -1310,7 +1313,7 @@ Currently supported settings are: Request to play the loaded stream. + line="656">Request to play the loaded stream. @@ -1320,7 +1323,7 @@ Currently supported settings are: #GstPlayer instance + line="658">#GstPlayer instance @@ -1328,7 +1331,7 @@ Currently supported settings are: Seeks the currently-playing stream to the absolute @position time + line="733">Seeks the currently-playing stream to the absolute @position time in nanoseconds. @@ -1339,13 +1342,13 @@ in nanoseconds. #GstPlayer instance + line="735">#GstPlayer instance position to seek in nanoseconds + line="736">position to seek in nanoseconds @@ -1356,7 +1359,7 @@ in nanoseconds. %TRUE or %FALSE + line="1066">%TRUE or %FALSE Sets the audio track @stream_idex. @@ -1365,13 +1368,13 @@ Sets the audio track @stream_idex. #GstPlayer instance + line="1063">#GstPlayer instance stream index + line="1064">stream index @@ -1380,7 +1383,7 @@ Sets the audio track @stream_idex. c:identifier="gst_player_set_audio_track_enabled"> Enable or disable the current audio track. + line="1112">Enable or disable the current audio track. @@ -1390,13 +1393,13 @@ Sets the audio track @stream_idex. #GstPlayer instance + line="1114">#GstPlayer instance TRUE or FALSE + line="1115">TRUE or FALSE @@ -1407,7 +1410,7 @@ Sets the audio track @stream_idex. version="1.10"> Sets audio-video-offset property by value of @offset + line="1378">Sets audio-video-offset property by value of @offset @@ -1417,13 +1420,13 @@ Sets the audio track @stream_idex. #GstPlayer instance + line="1380">#GstPlayer instance #gint64 in nanoseconds + line="1381">#gint64 in nanoseconds @@ -1432,7 +1435,7 @@ Sets the audio track @stream_idex. c:identifier="gst_player_set_color_balance"> Sets the current value of the indicated channel @type to the passed + line="1235">Sets the current value of the indicated channel @type to the passed value. @@ -1443,20 +1446,20 @@ value. #GstPlayer instance + line="1237">#GstPlayer instance #GstPlayerColorBalanceType + line="1238">#GstPlayerColorBalanceType The new value for the @type, ranged [0,1] + line="1239">The new value for the @type, ranged [0,1] @@ -1466,7 +1469,7 @@ value. version="1.10"> Set the configuration of the player. If the player is already configured, and + line="1564">Set the configuration of the player. If the player is already configured, and the configuration haven't change, this function will return %TRUE. If the player is not in the GST_PLAYER_STATE_STOPPED, this method will return %FALSE and active configuration will remain. @@ -1480,20 +1483,20 @@ This function takes ownership of @config. %TRUE when the configuration could be set. + line="1579">%TRUE when the configuration could be set. #GstPlayer instance + line="1566">#GstPlayer instance a #GstStructure + line="1567">a #GstStructure @@ -1503,7 +1506,7 @@ This function takes ownership of @config. version="1.10"> Sets the current value of the indicated mode @type to the passed + line="1338">Sets the current value of the indicated mode @type to the passed value. @@ -1514,13 +1517,13 @@ value. #GstPlayer instance + line="1340">#GstPlayer instance The new value for the @type + line="1341">The new value for the @type @@ -1531,7 +1534,7 @@ value. version="1.10"> Sets the current value of the indicated mode @type to the passed + line="1297">Sets the current value of the indicated mode @type to the passed value. @@ -1542,13 +1545,13 @@ value. #GstPlayer instance + line="1299">#GstPlayer instance The new value for the @type + line="1300">The new value for the @type @@ -1559,7 +1562,7 @@ value. glib:set-property="mute"> %TRUE if the currently-playing stream should be muted. + line="921">%TRUE if the currently-playing stream should be muted. @@ -1569,13 +1572,13 @@ value. #GstPlayer instance + line="923">#GstPlayer instance Mute state the should be set + line="924">Mute state the should be set @@ -1585,7 +1588,7 @@ value. glib:set-property="rate"> Playback at specified rate + line="699">Playback at specified rate @@ -1595,13 +1598,13 @@ value. #GstPlayer instance + line="701">#GstPlayer instance playback rate + line="702">playback rate @@ -1613,7 +1616,7 @@ value. %TRUE or %FALSE + line="1100">%TRUE or %FALSE Sets the subtitle stack @stream_index. @@ -1622,13 +1625,13 @@ Sets the subtitle stack @stream_index. #GstPlayer instance + line="1097">#GstPlayer instance stream index + line="1098">stream index @@ -1637,7 +1640,7 @@ Sets the subtitle stack @stream_index. c:identifier="gst_player_set_subtitle_track_enabled"> Enable or disable the current subtitle track. + line="1142">Enable or disable the current subtitle track. @@ -1647,13 +1650,13 @@ Sets the subtitle stack @stream_index. #GstPlayer instance + line="1144">#GstPlayer instance TRUE or FALSE + line="1145">TRUE or FALSE @@ -1662,7 +1665,7 @@ Sets the subtitle stack @stream_index. c:identifier="gst_player_set_subtitle_uri"> Sets the external subtitle URI. This should be combined with a call to + line="786">Sets the external subtitle URI. This should be combined with a call to gst_player_set_subtitle_track_enabled(@player, TRUE) so the subtitles are actually rendered. #GstPlayer instance + line="788">#GstPlayer instance allow-none="1"> subtitle URI + line="789">subtitle URI @@ -1694,7 +1697,7 @@ rendered. version="1.16"> Sets subtitle-video-offset property by value of @offset + line="1417">Sets subtitle-video-offset property by value of @offset @@ -1704,13 +1707,13 @@ rendered. #GstPlayer instance + line="1419">#GstPlayer instance #gint64 in nanoseconds + line="1420">#gint64 in nanoseconds @@ -1720,7 +1723,7 @@ rendered. glib:set-property="uri"> Sets the next URI to play. + line="771">Sets the next URI to play. @@ -1730,7 +1733,7 @@ rendered. #GstPlayer instance + line="773">#GstPlayer instance allow-none="1"> next URI to play. + line="774">next URI to play. @@ -1750,7 +1753,7 @@ rendered. %TRUE or %FALSE + line="1083">%TRUE or %FALSE Sets the video track @stream_index. @@ -1759,13 +1762,13 @@ Sets the video track @stream_index. #GstPlayer instance + line="1080">#GstPlayer instance stream index + line="1081">stream index @@ -1774,7 +1777,7 @@ Sets the video track @stream_index. c:identifier="gst_player_set_video_track_enabled"> Enable or disable the current video track. + line="1127">Enable or disable the current video track. @@ -1784,13 +1787,13 @@ Sets the video track @stream_index. #GstPlayer instance + line="1129">#GstPlayer instance TRUE or FALSE + line="1130">TRUE or FALSE @@ -1802,7 +1805,7 @@ Sets the video track @stream_index. %TRUE if the visualizations was set correctly. Otherwise, + line="1163">%TRUE if the visualizations was set correctly. Otherwise, %FALSE. @@ -1810,7 +1813,7 @@ Sets the video track @stream_index. #GstPlayer instance + line="1159">#GstPlayer instance allow-none="1"> visualization element obtained from + line="1160">visualization element obtained from #gst_player_visualizations_get() @@ -1829,7 +1832,7 @@ Sets the video track @stream_index. c:identifier="gst_player_set_visualization_enabled"> Enable or disable the visualization. + line="1190">Enable or disable the visualization. @@ -1839,13 +1842,13 @@ Sets the video track @stream_index. #GstPlayer instance + line="1192">#GstPlayer instance TRUE or FALSE + line="1193">TRUE or FALSE @@ -1855,7 +1858,7 @@ Sets the video track @stream_index. glib:set-property="volume"> Sets the volume level of the stream as a percentage between 0 and 1. + line="884">Sets the volume level of the stream as a percentage between 0 and 1. This volume is a linear factor. For showing the volume in a GUI it might make sense to first convert from a different format. Volume sliders @@ -1869,13 +1872,13 @@ should usually use a cubic volume. See gst_stream_volume_convert_volume(). #GstPlayer instance + line="886">#GstPlayer instance the new volume level, as a percentage between 0 and 1 + line="887">the new volume level, as a percentage between 0 and 1 @@ -1883,7 +1886,7 @@ should usually use a cubic volume. See gst_stream_volume_convert_volume(). Stops playing the current stream and resets to the first position + line="684">Stops playing the current stream and resets to the first position in the stream. @@ -1894,7 +1897,7 @@ in the stream. #GstPlayer instance + line="686">#GstPlayer instance @@ -2325,12 +2328,12 @@ gain. c:identifier="gst_player_color_balance_type_get_name"> Gets a string representing the given color balance type. + line="1462">Gets a string representing the given color balance type. a string with the name of the color + line="1468">a string with the name of the color balance type. @@ -2338,7 +2341,7 @@ gain. a #GstPlayerColorBalanceType + line="1464">a #GstPlayerColorBalanceType @@ -2362,19 +2365,19 @@ gain. Gets a string representing the given error. + line="1544">Gets a string representing the given error. a string with the given error. + line="1550">a string with the given error. a #GstPlayerError + line="1546">a #GstPlayerError @@ -2943,19 +2946,19 @@ stream. Gets a string representing the given state. + line="1501">Gets a string representing the given state. a string with the name of the state. + line="1507">a string with the name of the state. a #GstPlayerState + line="1503">a #GstPlayerState @@ -3684,12 +3687,12 @@ freed using gst_player_visualization_free(). moved-to="PlayerColorBalanceType.get_name"> Gets a string representing the given color balance type. + line="1462">Gets a string representing the given color balance type. a string with the name of the color + line="1468">a string with the name of the color balance type. @@ -3697,7 +3700,7 @@ freed using gst_player_visualization_free(). a #GstPlayerColorBalanceType + line="1464">a #GstPlayerColorBalanceType @@ -3708,19 +3711,19 @@ freed using gst_player_visualization_free(). moved-to="PlayerError.get_name"> Gets a string representing the given error. + line="1544">Gets a string representing the given error. a string with the given error. + line="1550">a string with the given error. a #GstPlayerError + line="1546">a #GstPlayerError @@ -3737,19 +3740,19 @@ freed using gst_player_visualization_free(). moved-to="PlayerState.get_name"> Gets a string representing the given state. + line="1501">Gets a string representing the given state. a string with the name of the state. + line="1507">a string with the name of the state. a #GstPlayerState + line="1503">a #GstPlayerState diff --git a/girs/GstRtp-1.0.gir b/girs/GstRtp-1.0.gir index f0c885269..81b8d9a31 100644 --- a/girs/GstRtp-1.0.gir +++ b/girs/GstRtp-1.0.gir @@ -3813,7 +3813,39 @@ audio codec glib:type-struct="RTPBaseDepayloadClass"> Provides a base class for RTP depayloaders + line="21">Provides a base class for RTP depayloaders + +In order to handle RTP header extensions correctly if the +depayloader aggregates multiple RTP packet payloads into one output +buffer this class provides the function +gst_rtp_base_depayload_set_aggregate_hdrext_enabled(). If the +aggregation is enabled the virtual functions +@GstRTPBaseDepayload.process or +@GstRTPBaseDepayload.process_rtp_packet must tell the base class +what happens to the current RTP packet. By default the base class +assumes that the packet payload is used with the next output +buffer. + +If the RTP packet will not be used with an output buffer +gst_rtp_base_depayload_dropped() must be called. A typical +situation would be if we are waiting for a keyframe. + +If the RTP packet will be used but not with the current output +buffer but with the next one gst_rtp_base_depayload_delayed() must +be called. This may happen if the current RTP packet signals the +start of a new output buffer and the currently processed output +buffer will be pushed first. The undelay happens implicitly once +the current buffer has been pushed or +gst_rtp_base_depayload_flush() has been called. + +If gst_rtp_base_depayload_flush() is called all RTP packets that +have not been dropped since the last output buffer are dropped, +e.g. if an output buffer is discarded due to malformed data. This +may or may not include the current RTP packet depending on the 2nd +parameter @keep_current. + +Be aware that in case gst_rtp_base_depayload_push_list() is used +each buffer will see the same list of RTP header extensions. @@ -3917,25 +3949,151 @@ buffer and the output buffer will be pushed out. If this function returns + + Called from @GstRTPBaseDepayload.process or +@GstRTPBaseDepayload.process_rtp_packet when the depayloader needs +to keep the current input RTP header for use with the next output +buffer. + +The delayed buffer will remain until the end of processing the +current output buffer and then enqueued for processing with the +next output buffer. + +A typical use-case is when the depayloader implementation will +start a new output buffer for the current input RTP buffer but push +the current output buffer first. + +Must be called with the stream lock held. + + + + + + + a #GstRTPBaseDepayload + + + + + + Called from @GstRTPBaseDepayload.process or +@GstRTPBaseDepayload.process_rtp_packet if the depayloader does not +use the current buffer for the output buffer. This will either drop +the delayed buffer or the last buffer from the header extension +cache. + +A typical use-case is when the depayloader implementation is +dropping an input RTP buffer while waiting for the first keyframe. + +Must be called with the stream lock held. + + + + + + + a #GstRTPBaseDepayload + + + + + + If @GstRTPBaseDepayload.process or +@GstRTPBaseDepayload.process_rtp_packet drop an output buffer this +function tells the base class to flush header extension cache as +well. + +This will not drop an input RTP header marked as delayed from +gst_rtp_base_depayload_delayed(). + +If @keep_current is %TRUE the current input RTP header will be kept +and enqueued after flushing the previous input RTP headers. + +A typical use-case for @keep_current is when the depayloader +implementation invalidates the current output buffer and starts a +new one with the current RTP input buffer. + +Must be called with the stream lock held. + + + + + + + a #GstRTPBaseDepayload + + + + if the current RTP buffer shall be kept + + + + + + Queries whether header extensions will be aggregated per depayloaded buffers. + + + %TRUE if aggregate-header-extension is enabled. + + + + + a #GstRTPBaseDepayload + + + + Queries whether #GstRTPSourceMeta will be added to depayloaded buffers. + line="1898">Queries whether #GstRTPSourceMeta will be added to depayloaded buffers. %TRUE if source-info is enabled. + line="1904">%TRUE if source-info is enabled. a #GstRTPBaseDepayload + line="1900">a #GstRTPBaseDepayload @@ -3943,7 +4101,7 @@ buffer and the output buffer will be pushed out. If this function returns Push @out_buf to the peer of @filter. This function takes ownership of + line="1638">Push @out_buf to the peer of @filter. This function takes ownership of @out_buf. This function will by default apply the last incoming timestamp on @@ -3953,20 +4111,20 @@ the outgoing buffer when it didn't have a timestamp already. a #GstFlowReturn. + line="1649">a #GstFlowReturn. a #GstRTPBaseDepayload + line="1640">a #GstRTPBaseDepayload a #GstBuffer + line="1641">a #GstBuffer @@ -3974,37 +4132,63 @@ the outgoing buffer when it didn't have a timestamp already. Push @out_list to the peer of @filter. This function takes ownership of + line="1664">Push @out_list to the peer of @filter. This function takes ownership of @out_list. a #GstFlowReturn. + line="1672">a #GstFlowReturn. a #GstRTPBaseDepayload + line="1666">a #GstRTPBaseDepayload a #GstBufferList + line="1667">a #GstBufferList + + Enable or disable aggregating header extensions. + + + + + + + a #GstRTPBaseDepayload + + + + whether to aggregate header extensions per output buffer + + + + Enable or disable adding #GstRTPSourceMeta to depayloaded buffers. + line="1882">Enable or disable adding #GstRTPSourceMeta to depayloaded buffers. @@ -4014,13 +4198,13 @@ the outgoing buffer when it didn't have a timestamp already. a #GstRTPBaseDepayload + line="1884">a #GstRTPBaseDepayload whether to add meta about RTP sources to buffer + line="1885">whether to add meta about RTP sources to buffer @@ -4032,12 +4216,30 @@ the outgoing buffer when it didn't have a timestamp already. default-value="TRUE"> If enabled, the depayloader will automatically try to enable all the + line="335">If enabled, the depayloader will automatically try to enable all the RTP header extensions provided in the sink caps, saving the application the need to handle these extensions manually using the GstRTPBaseDepayload::request-extension: signal. + + A list of already enabled RTP header extensions. This may be useful for finding +out which extensions are already enabled (with add-extension signal) and picking a non-conflicting +ID for a new extension that needs to be added on top of the existing ones. + +Note that the value returned by reading this property is not dynamically updated when the set of +enabled extensions changes by any of existing action signals. Rather, it represents the current state +at the time the property is read. + +Dynamic updates of this property can be received by subscribing to its corresponding "notify" signal, i.e. +"notify::extensions". + + default-value="100"> Max seqnum reorder before the sender is assumed to have restarted. + line="320">Max seqnum reorder before the sender is assumed to have restarted. When max-reorder is set to 0 all reordered/duplicate packets are considered coming from a restarted sender. @@ -4058,13 +4260,13 @@ considered coming from a restarted sender. default-value="FALSE"> Add RTP source information found in RTP header as meta to output buffer. + line="308">Add RTP source information found in RTP header as meta to output buffer. Various depayloader statistics retrieved atomically (and are therefore + line="284">Various depayloader statistics retrieved atomically (and are therefore synchroized with each other). This property return a GstStructure named application/x-rtp-depayload-stats containing the following fields relating to the last processed buffer and current state of the stream being depayloaded: @@ -4112,7 +4314,7 @@ the last processed buffer and current state of the stream being depayloaded: Add @ext as an extension for reading part of an RTP header extension from + line="372">Add @ext as an extension for reading part of an RTP header extension from incoming RTP packets. @@ -4121,7 +4323,7 @@ incoming RTP packets. the #GstRTPHeaderExtension + line="375">the #GstRTPHeaderExtension @@ -4132,7 +4334,7 @@ incoming RTP packets. version="1.20"> Clear all RTP header extensions used by this depayloader. + line="388">Clear all RTP header extensions used by this depayloader. @@ -4140,19 +4342,19 @@ incoming RTP packets. The returned @ext must be configured with the correct @ext_id and with the + line="352">The returned @ext must be configured with the correct @ext_id and with the necessary attributes as required by the extension implementation. the #GstRTPHeaderExtension for @ext_id, or %NULL + line="361">the #GstRTPHeaderExtension for @ext_id, or %NULL the extension id being requested + line="355">the extension id being requested allow-none="1"> the extension URI being requested + line="356">the extension URI being requested @@ -4437,7 +4639,7 @@ buffer and the output buffer will be pushed out. If this function returns version="1.16"> Allocate a new #GstBuffer with enough data to hold an RTP packet with + line="2099">Allocate a new #GstBuffer with enough data to hold an RTP packet with minimum @csrc_count CSRCs, a payload length of @payload_len and padding of @pad_len. If @payload has #GstRTPBasePayload:source-info %TRUE additional CSRCs may be allocated and filled with RTP source information. @@ -4446,7 +4648,7 @@ CSRCs may be allocated and filled with RTP source information. A newly allocated buffer that can hold an RTP packet with given + line="2111">A newly allocated buffer that can hold an RTP packet with given parameters. @@ -4454,25 +4656,25 @@ parameters. a #GstRTPBasePayload + line="2101">a #GstRTPBasePayload the length of the payload + line="2102">the length of the payload the amount of padding + line="2103">the amount of padding the minimum number of CSRC entries + line="2104">the minimum number of CSRC entries @@ -4482,7 +4684,7 @@ parameters. version="1.16"> Count the total number of RTP sources found in the meta of @buffer, which + line="2421">Count the total number of RTP sources found in the meta of @buffer, which will be automically added by gst_rtp_base_payload_allocate_output_buffer(). If #GstRTPBasePayload:source-info is %FALSE the count will be 0. The number of sources. + line="2430">The number of sources. a #GstRTPBasePayload + line="2423">a #GstRTPBasePayload a #GstBuffer, typically the buffer to payload + line="2424">a #GstBuffer, typically the buffer to payload @@ -4511,14 +4713,14 @@ If #GstRTPBasePayload:source-info is %FALSE the count will be 0. Check if the packet with @size and @duration would exceed the configured + line="1562">Check if the packet with @size and @duration would exceed the configured maximum size. %TRUE if the packet of @size and @duration would exceed the + line="1571">%TRUE if the packet of @size and @duration would exceed the configured MTU or max_ptime. @@ -4526,19 +4728,19 @@ configured MTU or max_ptime. a #GstRTPBasePayload + line="1564">a #GstRTPBasePayload the size of the packet + line="1565">the size of the packet the duration of the packet + line="1566">the duration of the packet @@ -4548,21 +4750,21 @@ configured MTU or max_ptime. version="1.16"> Queries whether the payloader will add contributing sources (CSRCs) to the + line="2403">Queries whether the payloader will add contributing sources (CSRCs) to the RTP header from #GstRTPSourceMeta. %TRUE if source-info is enabled. + line="2410">%TRUE if source-info is enabled. a #GstRTPBasePayload + line="2405">a #GstRTPBasePayload @@ -4570,7 +4772,7 @@ RTP header from #GstRTPSourceMeta. Push @buffer to the peer element of the payloader. The SSRC, payload type, + line="2066">Push @buffer to the peer element of the payloader. The SSRC, payload type, seqnum and timestamp of the RTP buffer will be updated first. This function takes ownership of @buffer. @@ -4579,20 +4781,20 @@ This function takes ownership of @buffer. a #GstFlowReturn. + line="2076">a #GstFlowReturn. a #GstRTPBasePayload + line="2068">a #GstRTPBasePayload a #GstBuffer + line="2069">a #GstBuffer @@ -4600,7 +4802,7 @@ This function takes ownership of @buffer. Push @list to the peer element of the payloader. The SSRC, payload type, + line="2032">Push @list to the peer element of the payloader. The SSRC, payload type, seqnum and timestamp of the RTP buffer will be updated first. This function takes ownership of @list. @@ -4609,20 +4811,20 @@ This function takes ownership of @list. a #GstFlowReturn. + line="2042">a #GstFlowReturn. a #GstRTPBasePayload + line="2034">a #GstRTPBasePayload a #GstBufferList + line="2035">a #GstBufferList @@ -4631,7 +4833,7 @@ This function takes ownership of @list. c:identifier="gst_rtp_base_payload_set_options"> Set the rtp options of the payloader. These options will be set in the caps + line="939">Set the rtp options of the payloader. These options will be set in the caps of the payloader. Subclasses must call this method before calling gst_rtp_base_payload_push() or gst_rtp_base_payload_set_outcaps(). a #GstRTPBasePayload + line="941">a #GstRTPBasePayload the media type (typically "audio" or "video") + line="942">the media type (typically "audio" or "video") if the payload type is dynamic + line="943">if the payload type is dynamic the encoding name + line="944">the encoding name the clock rate of the media + line="945">the clock rate of the media @@ -4677,7 +4879,7 @@ gst_rtp_base_payload_push() or gst_rtp_base_payload_set_outcaps(). introspectable="0"> Configure the output caps with the optional parameters. + line="1036">Configure the output caps with the optional parameters. Variable arguments should be in the form field name, field type (as a GType), value(s). The last variable argument should be NULL. @@ -4686,26 +4888,26 @@ Variable arguments should be in the form field name, field type %TRUE if the caps could be set. + line="1047">%TRUE if the caps could be set. a #GstRTPBasePayload + line="1038">a #GstRTPBasePayload the first field name or %NULL + line="1039">the first field name or %NULL field values + line="1040">field values @@ -4715,20 +4917,20 @@ Variable arguments should be in the form field name, field type version="1.20"> Configure the output caps with the optional fields. + line="999">Configure the output caps with the optional fields. %TRUE if the caps could be set. + line="1006">%TRUE if the caps could be set. a #GstRTPBasePayload + line="1001">a #GstRTPBasePayload a #GstStructure with the caps fields + line="1002">a #GstStructure with the caps fields @@ -4747,7 +4949,7 @@ Variable arguments should be in the form field name, field type version="1.16"> Enable or disable adding contributing sources to RTP packets from + line="2386">Enable or disable adding contributing sources to RTP packets from #GstRTPSourceMeta. @@ -4758,13 +4960,13 @@ Variable arguments should be in the form field name, field type a #GstRTPBasePayload + line="2388">a #GstRTPBasePayload whether to add contributing sources to RTP packets + line="2389">whether to add contributing sources to RTP packets @@ -4776,12 +4978,30 @@ Variable arguments should be in the form field name, field type default-value="TRUE"> If enabled, the payloader will automatically try to enable all the + line="433">If enabled, the payloader will automatically try to enable all the RTP header extensions provided in the src caps, saving the application the need to handle these extensions manually using the GstRTPBasePayload::request-extension: signal. + + A list of already enabled RTP header extensions. This may be useful for finding +out which extensions are already enabled (with add-extension signal) and picking a non-conflicting +ID for a new extension that needs to be added on top of the existing ones. + +Note that the value returned by reading this property is not dynamically updated when the set of +enabled extensions changes by any of existing action signals. Rather, it represents the current state +at the time the property is read. + +Dynamic updates of this property can be received by subscribing to its corresponding "notify" signal, i.e. +"notify::extensions". + + default-value="0"> Minimum duration of the packet data in ns (can't go above MTU) + line="310">Minimum duration of the packet data in ns (can't go above MTU) default-value="FALSE"> Make the payloader timestamp packets according to the Rate-Control=no + line="399">Make the payloader timestamp packets according to the Rate-Control=no behaviour specified in the ONVIF replay spec. @@ -4820,7 +5040,7 @@ behaviour specified in the ONVIF replay spec. default-value="TRUE"> Try to use the offset fields to generate perfect RTP timestamps. When this + line="330">Try to use the offset fields to generate perfect RTP timestamps. When this option is disabled, RTP timestamps are generated from GST_BUFFER_PTS of each payloaded buffer. The PTSes of buffers may not necessarily increment with the amount of data in each input buffer, consider e.g. the case where @@ -4849,7 +5069,7 @@ timestamps for audio streams. default-value="0"> Force buffers to be multiples of this duration in ns (0 disables) + line="353">Force buffers to be multiples of this duration in ns (0 disables) default-value="TRUE"> Make the RTP packets' timestamps be scaled with the segment's rate + line="414">Make the RTP packets' timestamps be scaled with the segment's rate (corresponding to RTSP speed parameter). Disabling this property means the timestamps will not be affected by the set delivery speed (RTSP speed). @@ -4885,7 +5105,7 @@ server has this property disabled. default-value="FALSE"> Enable writing the CSRC field in allocated RTP header based on RTP source + line="386">Enable writing the CSRC field in allocated RTP header based on RTP source information found in the input buffer's #GstRTPSourceMeta. @@ -4898,7 +5118,7 @@ information found in the input buffer's #GstRTPSourceMeta. Various payloader statistics retrieved atomically (and are therefore + line="364">Various payloader statistics retrieved atomically (and are therefore synchroized with each other), these can be used e.g. to generate an RTP-Info header. This property return a GstStructure named application/x-rtp-payload-stats containing the following fields relating to @@ -5000,7 +5220,7 @@ the last processed buffer and current state of the stream being payloaded: Add @ext as an extension for writing part of an RTP header extension onto + line="477">Add @ext as an extension for writing part of an RTP header extension onto outgoing RTP packets. @@ -5009,7 +5229,7 @@ outgoing RTP packets. the #GstRTPHeaderExtension + line="480">the #GstRTPHeaderExtension @@ -5020,7 +5240,7 @@ outgoing RTP packets. version="1.20"> Clear all RTP header extensions used by this payloader. + line="513">Clear all RTP header extensions used by this payloader. @@ -5028,25 +5248,25 @@ outgoing RTP packets. The returned @ext must be configured with the correct @ext_id and with the + line="493">The returned @ext must be configured with the correct @ext_id and with the necessary attributes as required by the extension implementation. the #GstRTPHeaderExtension for @ext_id, or %NULL + line="502">the #GstRTPHeaderExtension for @ext_id, or %NULL the extension id being requested + line="496">the extension id being requested the extension URI being requested + line="497">the extension URI being requested diff --git a/girs/GstRtsp-1.0.gir b/girs/GstRtsp-1.0.gir index ae9d6e76d..7a17ca661 100644 --- a/girs/GstRtsp-1.0.gir +++ b/girs/GstRtsp-1.0.gir @@ -63,7 +63,7 @@ and/or use gtk-doc annotations. --> c:type="GstRTSPAuthMethod"> Authentication methods, ordered by strength + line="220">Authentication methods, ordered by strength glib:name="GST_RTSP_AUTH_NONE"> no authentication + line="222">no authentication glib:name="GST_RTSP_AUTH_BASIC"> basic authentication + line="223">basic authentication glib:name="GST_RTSP_AUTH_DIGEST"> digest authentication + line="224">digest authentication to receive and send bytes and messages. + + Add header to be appended to any HTTP request made by connection. +If the header already exists then the old header is replaced by the new header. + +Only applicable in HTTP tunnel mode. + + + + + + + a #GstRTSPConnection + + + + HTTP header name + + + + HTTP header value + + + + Clear the list of authentication directives stored in @conn. + line="3457">Clear the list of authentication directives stored in @conn. @@ -164,7 +199,7 @@ to receive and send bytes and messages. a #GstRTSPConnection + line="3459">a #GstRTSPConnection @@ -172,21 +207,21 @@ to receive and send bytes and messages. Close the connected @conn. After this call, the connection is in the same + line="3037">Close the connected @conn. After this call, the connection is in the same state as when it was first created. #GST_RTSP_OK on success. + line="3044">#GST_RTSP_OK on success. a #GstRTSPConnection + line="3039">a #GstRTSPConnection @@ -197,31 +232,31 @@ state as when it was first created. deprecated-version="1.18"> Attempt to connect to the url of @conn made with + line="5189">Attempt to connect to the url of @conn made with gst_rtsp_connection_create(). If @timeout is %NULL this function can block forever. If @timeout contains a valid timeout, this function will return #GST_RTSP_ETIMEOUT after the timeout expired. This function can be cancelled with gst_rtsp_connection_flush(). + line="354"/> #GST_RTSP_OK when a connection could be made. + line="5201">#GST_RTSP_OK when a connection could be made. a #GstRTSPConnection + line="5191">a #GstRTSPConnection a GTimeVal timeout + line="5192">a GTimeVal timeout @@ -231,7 +266,7 @@ This function can be cancelled with gst_rtsp_connection_flush(). version="1.18"> Attempt to connect to the url of @conn made with + line="1392">Attempt to connect to the url of @conn made with gst_rtsp_connection_create(). If @timeout is 0 this function can block forever. If @timeout contains a valid timeout, this function will return #GST_RTSP_ETIMEOUT after the timeout expired. @@ -242,20 +277,20 @@ This function can be cancelled with gst_rtsp_connection_flush(). #GST_RTSP_OK when a connection could be made. + line="1404">#GST_RTSP_OK when a connection could be made. a #GstRTSPConnection + line="1394">a #GstRTSPConnection a timeout in microseconds + line="1395">a timeout in microseconds @@ -267,7 +302,7 @@ This function can be cancelled with gst_rtsp_connection_flush(). deprecated-version="1.18"> Attempt to connect to the url of @conn made with + line="5211">Attempt to connect to the url of @conn made with gst_rtsp_connection_create(). If @timeout is %NULL this function can block forever. If @timeout contains a valid timeout, this function will return #GST_RTSP_ETIMEOUT after the timeout expired. If @conn is set to tunneled, @@ -275,30 +310,30 @@ forever. If @timeout contains a valid timeout, this function will return This function can be cancelled with gst_rtsp_connection_flush(). + line="357"/> #GST_RTSP_OK when a connection could be made. + line="5225">#GST_RTSP_OK when a connection could be made. a #GstRTSPConnection + line="5213">a #GstRTSPConnection a GTimeVal timeout + line="5214">a GTimeVal timeout a #GstRTSPMessage + line="5215">a #GstRTSPMessage @@ -308,7 +343,7 @@ This function can be cancelled with gst_rtsp_connection_flush(). version="1.18"> Attempt to connect to the url of @conn made with + line="1132">Attempt to connect to the url of @conn made with gst_rtsp_connection_create(). If @timeout is 0 this function can block forever. If @timeout contains a valid timeout, this function will return #GST_RTSP_ETIMEOUT after the timeout expired. If @conn is set to tunneled, @@ -320,26 +355,26 @@ This function can be cancelled with gst_rtsp_connection_flush(). #GST_RTSP_OK when a connection could be made. + line="1146">#GST_RTSP_OK when a connection could be made. a #GstRTSPConnection + line="1134">a #GstRTSPConnection a timeout in microseconds + line="1135">a timeout in microseconds a #GstRTSPMessage + line="1136">a #GstRTSPMessage @@ -347,7 +382,7 @@ This function can be cancelled with gst_rtsp_connection_flush(). If @conn received the first tunnel connection and @conn2 received + line="3808">If @conn received the first tunnel connection and @conn2 received the second tunnel connection, link the two connections together so that @conn manages the tunneled connection. @@ -361,14 +396,14 @@ If @conn2 is %NULL then only the base64 decoding context will be setup for return GST_RTSP_OK on success. + line="3823">return GST_RTSP_OK on success. a #GstRTSPConnection + line="3810">a #GstRTSPConnection a #GstRTSPConnection or %NULL + line="3811">a #GstRTSPConnection or %NULL @@ -385,7 +420,7 @@ If @conn2 is %NULL then only the base64 decoding context will be setup for Start or stop the flushing action on @conn. When flushing, all current + line="3299">Start or stop the flushing action on @conn. When flushing, all current and future actions on @conn will return #GST_RTSP_EINTR until the connection is set to non-flushing mode again. #GST_RTSP_OK. + line="3308">#GST_RTSP_OK. a #GstRTSPConnection + line="3301">a #GstRTSPConnection start or stop the flush + line="3302">start or stop the flush @@ -414,20 +449,20 @@ is set to non-flushing mode again. Close and free @conn. + line="3099">Close and free @conn. #GST_RTSP_OK on success. + line="3105">#GST_RTSP_OK on success. a #GstRTSPConnection + line="3101">a #GstRTSPConnection @@ -437,13 +472,13 @@ is set to non-flushing mode again. version="1.20"> Get the ignore_x_server_reply value. + line="3764">Get the ignore_x_server_reply value. returns %TRUE if the x-server-ip-address header reply will be + line="3770">returns %TRUE if the x-server-ip-address header reply will be ignored, else returns %FALSE @@ -451,7 +486,7 @@ is set to non-flushing mode again. a #GstRTSPConnection + line="3766">a #GstRTSPConnection @@ -459,13 +494,13 @@ is set to non-flushing mode again. Retrieve the IP address of the other end of @conn. + line="3605">Retrieve the IP address of the other end of @conn. The IP address as a string. this value remains valid until the + line="3611">The IP address as a string. this value remains valid until the connection is closed. @@ -473,7 +508,7 @@ connection is closed. a #GstRTSPConnection + line="3607">a #GstRTSPConnection @@ -482,13 +517,13 @@ connection is closed. c:identifier="gst_rtsp_connection_get_read_socket"> Get the file descriptor for reading. + line="3638">Get the file descriptor for reading. the file descriptor used for reading or %NULL on + line="3644">the file descriptor used for reading or %NULL on error. The file descriptor remains valid until the connection is closed. @@ -496,7 +531,7 @@ error. The file descriptor remains valid until the connection is closed. a #GstRTSPConnection + line="3640">a #GstRTSPConnection @@ -508,7 +543,7 @@ error. The file descriptor remains valid until the connection is closed. %TRUE if the #GstRTSPConnection remembers the session id in the + line="3921">%TRUE if the #GstRTSPConnection remembers the session id in the last response to set it on any further request. @@ -516,7 +551,7 @@ last response to set it on any further request. a #GstRTSPConnection + line="3919">a #GstRTSPConnection @@ -527,7 +562,7 @@ last response to set it on any further request. throws="1"> Get the TLS connection of @conn. + line="629">Get the TLS connection of @conn. For client side this will return the #GTlsClientConnection when connected over TLS. @@ -540,14 +575,14 @@ calls. The server is then responsible for configuring the TLS connection. the TLS connection for @conn. + line="643">the TLS connection for @conn. a #GstRTSPConnection + line="631">a #GstRTSPConnection @@ -557,7 +592,7 @@ calls. The server is then responsible for configuring the TLS connection. version="1.4"> Gets the anchor certificate authorities database that will be used + line="772">Gets the anchor certificate authorities database that will be used after a server certificate can't be verified with the default certificate database. the anchor certificate authorities database, or NULL if no + line="780">the anchor certificate authorities database, or NULL if no database has been previously set. Use g_object_unref() to release the certificate database. @@ -574,7 +609,7 @@ certificate database. a #GstRTSPConnection + line="774">a #GstRTSPConnection @@ -584,7 +619,7 @@ certificate database. version="1.6"> Gets a #GTlsInteraction object to be used when the connection or certificate + line="828">Gets a #GTlsInteraction object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary. a reference on the #GTlsInteraction. Use + line="836">a reference on the #GTlsInteraction. Use g_object_unref() to release. @@ -600,7 +635,7 @@ g_object_unref() to release. a #GstRTSPConnection + line="830">a #GstRTSPConnection @@ -610,7 +645,7 @@ g_object_unref() to release. version="1.2.1"> Gets the TLS validation flags used to verify the peer certificate + line="713">Gets the TLS validation flags used to verify the peer certificate when a TLS connection is established. GLib guarantees that if certificate verification fails, at least one error @@ -626,14 +661,14 @@ the only error flag set even if other problems exist with the certificate. the validation flags. + line="729">the validation flags. a #GstRTSPConnection + line="715">a #GstRTSPConnection @@ -642,20 +677,20 @@ the only error flag set even if other problems exist with the certificate. c:identifier="gst_rtsp_connection_get_tunnelid"> Get the tunnel session id the connection. + line="3725">Get the tunnel session id the connection. returns a non-empty string if @conn is being tunneled over HTTP. + line="3731">returns a non-empty string if @conn is being tunneled over HTTP. a #GstRTSPConnection + line="3727">a #GstRTSPConnection @@ -663,13 +698,13 @@ the only error flag set even if other problems exist with the certificate. Retrieve the URL of the other end of @conn. + line="3588">Retrieve the URL of the other end of @conn. The URL. This value remains valid until the + line="3594">The URL. This value remains valid until the connection is freed. @@ -677,7 +712,7 @@ connection is freed. a #GstRTSPConnection + line="3590">a #GstRTSPConnection @@ -686,13 +721,13 @@ connection is freed. c:identifier="gst_rtsp_connection_get_write_socket"> Get the file descriptor for writing. + line="3656">Get the file descriptor for writing. the file descriptor used for writing or NULL on + line="3662">the file descriptor used for writing or NULL on error. The file descriptor remains valid until the connection is closed. @@ -700,7 +735,7 @@ error. The file descriptor remains valid until the connection is closed. a #GstRTSPConnection + line="3658">a #GstRTSPConnection @@ -709,20 +744,20 @@ error. The file descriptor remains valid until the connection is closed. c:identifier="gst_rtsp_connection_is_tunneled"> Get the tunneling state of the connection. + line="3709">Get the tunneling state of the connection. if @conn is using HTTP tunneling. + line="3715">if @conn is using HTTP tunneling. a #GstRTSPConnection + line="3711">a #GstRTSPConnection @@ -733,26 +768,26 @@ error. The file descriptor remains valid until the connection is closed. deprecated-version="1.18"> Calculate the next timeout for @conn, storing the result in @timeout. + line="5387">Calculate the next timeout for @conn, storing the result in @timeout. + line="386"/> #GST_RTSP_OK. + line="5394">#GST_RTSP_OK. a #GstRTSPConnection + line="5389">a #GstRTSPConnection a timeout + line="5390">a timeout @@ -762,20 +797,20 @@ error. The file descriptor remains valid until the connection is closed. version="1.18"> Calculate the next timeout for @conn + line="3233">Calculate the next timeout for @conn #the next timeout in microseconds + line="3239">#the next timeout in microseconds a #GstRTSPConnection + line="3235">a #GstRTSPConnection @@ -786,7 +821,7 @@ error. The file descriptor remains valid until the connection is closed. deprecated-version="1.18"> Wait up to the specified @timeout for the connection to become available for + line="5359">Wait up to the specified @timeout for the connection to become available for at least one of the operations specified in @events. When the function returns with #GST_RTSP_OK, @revents will contain a bitmask of available operations on @conn. @@ -795,24 +830,24 @@ with #GST_RTSP_OK, @revents will contain a bitmask of available operations on This function can be cancelled with gst_rtsp_connection_flush(). + line="382"/> #GST_RTSP_OK on success. + line="5375">#GST_RTSP_OK on success. a #GstRTSPConnection + line="5361">a #GstRTSPConnection a bitmask of #GstRTSPEvent flags to check + line="5362">a bitmask of #GstRTSPEvent flags to check transfer-ownership="full"> location for result flags + line="5363">location for result flags a timeout + line="5364">a timeout @@ -837,7 +872,7 @@ This function can be cancelled with gst_rtsp_connection_flush(). version="1.18"> Wait up to the specified @timeout for the connection to become available for + line="3147">Wait up to the specified @timeout for the connection to become available for at least one of the operations specified in @events. When the function returns with #GST_RTSP_OK, @revents will contain a bitmask of available operations on @conn. @@ -850,20 +885,20 @@ This function can be cancelled with gst_rtsp_connection_flush(). #GST_RTSP_OK on success. + line="3163">#GST_RTSP_OK on success. a #GstRTSPConnection + line="3149">a #GstRTSPConnection a bitmask of #GstRTSPEvent flags to check + line="3150">a bitmask of #GstRTSPEvent flags to check transfer-ownership="none"> location for result flags + line="3151">location for result flags a timeout in microseconds + line="3152">a timeout in microseconds @@ -889,30 +924,30 @@ This function can be cancelled with gst_rtsp_connection_flush(). deprecated-version="1.18"> Attempt to read @size bytes into @data from the connected @conn, blocking up to + line="5238">Attempt to read @size bytes into @data from the connected @conn, blocking up to the specified @timeout. @timeout can be %NULL, in which case this function might block forever. This function can be cancelled with gst_rtsp_connection_flush(). + line="361"/> #GST_RTSP_OK on success. + line="5251">#GST_RTSP_OK on success. a #GstRTSPConnection + line="5240">a #GstRTSPConnection the data to read + line="5241">the data to read @@ -920,13 +955,13 @@ This function can be cancelled with gst_rtsp_connection_flush(). the size of @data + line="5242">the size of @data a timeout value or %NULL + line="5243">a timeout value or %NULL @@ -936,7 +971,7 @@ This function can be cancelled with gst_rtsp_connection_flush(). version="1.18"> Attempt to read @size bytes into @data from the connected @conn, blocking up to + line="2870">Attempt to read @size bytes into @data from the connected @conn, blocking up to the specified @timeout. @timeout can be 0, in which case this function might block forever. @@ -946,20 +981,20 @@ This function can be cancelled with gst_rtsp_connection_flush(). #GST_RTSP_OK on success. + line="2883">#GST_RTSP_OK on success. a #GstRTSPConnection + line="2872">a #GstRTSPConnection the data to read + line="2873">the data to read @@ -967,13 +1002,13 @@ This function can be cancelled with gst_rtsp_connection_flush(). the size of @data + line="2874">the size of @data a timeout value in microseconds + line="2875">a timeout value in microseconds @@ -984,36 +1019,36 @@ This function can be cancelled with gst_rtsp_connection_flush(). deprecated-version="1.18"> Attempt to read into @message from the connected @conn, blocking up to + line="5336">Attempt to read into @message from the connected @conn, blocking up to the specified @timeout. @timeout can be %NULL, in which case this function might block forever. This function can be cancelled with gst_rtsp_connection_flush(). + line="378"/> #GST_RTSP_OK on success. + line="5348">#GST_RTSP_OK on success. a #GstRTSPConnection + line="5338">a #GstRTSPConnection the message to read + line="5339">the message to read a timeout value or %NULL + line="5340">a timeout value or %NULL @@ -1023,7 +1058,7 @@ This function can be cancelled with gst_rtsp_connection_flush(). version="1.18"> Attempt to read into @message from the connected @conn, blocking up to + line="2951">Attempt to read into @message from the connected @conn, blocking up to the specified @timeout. @timeout can be 0, in which case this function might block forever. @@ -1033,26 +1068,26 @@ This function can be cancelled with gst_rtsp_connection_flush(). #GST_RTSP_OK on success. + line="2963">#GST_RTSP_OK on success. a #GstRTSPConnection + line="2953">a #GstRTSPConnection the message to read + line="2954">the message to read a timeout value or 0 + line="2955">a timeout value or 0 @@ -1061,20 +1096,20 @@ This function can be cancelled with gst_rtsp_connection_flush(). c:identifier="gst_rtsp_connection_reset_timeout"> Reset the timeout of @conn. + line="3281">Reset the timeout of @conn. #GST_RTSP_OK. + line="3287">#GST_RTSP_OK. a #GstRTSPConnection + line="3283">a #GstRTSPConnection @@ -1085,36 +1120,36 @@ This function can be cancelled with gst_rtsp_connection_flush(). deprecated-version="1.18"> Attempt to send @message to the connected @conn, blocking up to + line="5287">Attempt to send @message to the connected @conn, blocking up to the specified @timeout. @timeout can be %NULL, in which case this function might block forever. This function can be cancelled with gst_rtsp_connection_flush(). + line="370"/> #GST_RTSP_OK on success. + line="5299">#GST_RTSP_OK on success. a #GstRTSPConnection + line="5289">a #GstRTSPConnection the message to send + line="5290">the message to send a timeout value or %NULL + line="5291">a timeout value or %NULL @@ -1126,30 +1161,30 @@ This function can be cancelled with gst_rtsp_connection_flush(). deprecated-version="1.18"> Attempt to send @messages to the connected @conn, blocking up to + line="5310">Attempt to send @messages to the connected @conn, blocking up to the specified @timeout. @timeout can be %NULL, in which case this function might block forever. This function can be cancelled with gst_rtsp_connection_flush(). + line="374"/> #GST_RTSP_OK on success. + line="5323">#GST_RTSP_OK on success. a #GstRTSPConnection + line="5312">a #GstRTSPConnection the messages to send + line="5313">the messages to send @@ -1157,13 +1192,13 @@ This function can be cancelled with gst_rtsp_connection_flush(). the number of messages to send + line="5314">the number of messages to send a timeout value or %NULL + line="5315">a timeout value or %NULL @@ -1173,7 +1208,7 @@ This function can be cancelled with gst_rtsp_connection_flush(). version="1.18"> Attempt to send @messages to the connected @conn, blocking up to + line="2086">Attempt to send @messages to the connected @conn, blocking up to the specified @timeout. @timeout can be 0, in which case this function might block forever. @@ -1183,20 +1218,20 @@ This function can be cancelled with gst_rtsp_connection_flush(). #GST_RTSP_OK on Since. + line="2099">#GST_RTSP_OK on Since. a #GstRTSPConnection + line="2088">a #GstRTSPConnection the messages to send + line="2089">the messages to send @@ -1204,13 +1239,13 @@ This function can be cancelled with gst_rtsp_connection_flush(). the number of messages to send + line="2090">the number of messages to send a timeout value in microseconds + line="2091">a timeout value in microseconds @@ -1220,7 +1255,7 @@ This function can be cancelled with gst_rtsp_connection_flush(). version="1.18"> Attempt to send @message to the connected @conn, blocking up to + line="2060">Attempt to send @message to the connected @conn, blocking up to the specified @timeout. @timeout can be 0, in which case this function might block forever. @@ -1230,26 +1265,26 @@ This function can be cancelled with gst_rtsp_connection_flush(). #GST_RTSP_OK on success. + line="2072">#GST_RTSP_OK on success. a #GstRTSPConnection + line="2062">a #GstRTSPConnection the message to send + line="2063">the message to send a timeout value in microseconds + line="2064">a timeout value in microseconds @@ -1259,7 +1294,7 @@ This function can be cancelled with gst_rtsp_connection_flush(). version="1.14"> Sets a custom accept-certificate function for checking certificates for + line="854">Sets a custom accept-certificate function for checking certificates for validity. This will directly map to #GTlsConnection 's "accept-certificate" signal and be performed after the default checks of #GstRTSPConnection (checking against the #GTlsDatabase with the given #GTlsCertificateFlags) @@ -1274,7 +1309,7 @@ be called. a #GstRTSPConnection + line="856">a #GstRTSPConnection destroy="2"> a #GstRTSPConnectionAcceptCertificateFunc to check certificates + line="857">a #GstRTSPConnectionAcceptCertificateFunc to check certificates @@ -1294,7 +1329,7 @@ be called. allow-none="1"> User data passed to @func + line="859">User data passed to @func scope="async"> #GDestroyNotify for @user_data + line="858">#GDestroyNotify for @user_data @@ -1310,39 +1345,39 @@ be called. Configure @conn for authentication mode @method with @user and @pass as the + line="3352">Configure @conn for authentication mode @method with @user and @pass as the user and password respectively. #GST_RTSP_OK. + line="3362">#GST_RTSP_OK. a #GstRTSPConnection + line="3354">a #GstRTSPConnection authentication method + line="3355">authentication method the user + line="3356">the user the password + line="3357">the password @@ -1351,7 +1386,7 @@ user and password respectively. c:identifier="gst_rtsp_connection_set_auth_param"> Setup @conn with authentication directives. This is not necessary for + line="3431">Setup @conn with authentication directives. This is not necessary for methods #GST_RTSP_AUTH_NONE and #GST_RTSP_AUTH_BASIC. For #GST_RTSP_AUTH_DIGEST, directives should be taken from the digest challenge in the WWW-Authenticate response header and can include realm, domain, @@ -1365,19 +1400,19 @@ nonce, opaque, stale, algorithm, qop as per RFC2617. a #GstRTSPConnection + line="3433">a #GstRTSPConnection authentication directive + line="3434">authentication directive value + line="3435">value @@ -1387,7 +1422,7 @@ nonce, opaque, stale, algorithm, qop as per RFC2617. version="1.18"> Configure @conn to use the specified Content-Length limit. + line="3568">Configure @conn to use the specified Content-Length limit. Both requests and responses are validated. If content-length is exceeded, ENOMEM error will be returned. a #GstRTSPConnection + line="3570">a #GstRTSPConnection Content-Length limit + line="3571">Content-Length limit @@ -1414,7 +1449,7 @@ exceeded, ENOMEM error will be returned. c:identifier="gst_rtsp_connection_set_http_mode"> By setting the HTTP mode to %TRUE the message parsing will support HTTP + line="3674">By setting the HTTP mode to %TRUE the message parsing will support HTTP messages in addition to the RTSP messages. It will also disable the automatic handling of setting up an HTTP tunnel. a #GstRTSPConnection + line="3676">a #GstRTSPConnection %TRUE to enable manual HTTP mode + line="3677">%TRUE to enable manual HTTP mode @@ -1442,7 +1477,7 @@ automatic handling of setting up an HTTP tunnel. version="1.20"> Set whether to ignore the x-server-ip-address header reply or not. If the + line="3744">Set whether to ignore the x-server-ip-address header reply or not. If the header is ignored, the original address will be used instead. @@ -1453,13 +1488,13 @@ header is ignored, the original address will be used instead. a #GstRTSPConnection + line="3746">a #GstRTSPConnection %TRUE to ignore the x-server-ip-address header reply or %FALSE to + line="3747">%TRUE to ignore the x-server-ip-address header reply or %FALSE to comply with it (%FALSE is the default). @@ -1468,7 +1503,7 @@ header is ignored, the original address will be used instead. Set the IP address of the server. + line="3622">Set the IP address of the server. @@ -1478,13 +1513,13 @@ header is ignored, the original address will be used instead. a #GstRTSPConnection + line="3624">a #GstRTSPConnection an ip address + line="3625">an ip address @@ -1492,32 +1527,32 @@ header is ignored, the original address will be used instead. Set the proxy host and port. + line="3329">Set the proxy host and port. #GST_RTSP_OK. + line="3337">#GST_RTSP_OK. a #GstRTSPConnection + line="3331">a #GstRTSPConnection the proxy host + line="3332">the proxy host the proxy port + line="3333">the proxy port @@ -1526,26 +1561,26 @@ header is ignored, the original address will be used instead. c:identifier="gst_rtsp_connection_set_qos_dscp"> Configure @conn to use the specified DSCP value. + line="3543">Configure @conn to use the specified DSCP value. #GST_RTSP_OK on success. + line="3550">#GST_RTSP_OK on success. a #GstRTSPConnection + line="3545">a #GstRTSPConnection DSCP value + line="3546">DSCP value @@ -1554,7 +1589,7 @@ header is ignored, the original address will be used instead. c:identifier="gst_rtsp_connection_set_remember_session_id"> Sets if the #GstRTSPConnection should remember the session id from the last + line="3897">Sets if the #GstRTSPConnection should remember the session id from the last response received and force it onto any further requests. The default value is %TRUE @@ -1567,13 +1602,13 @@ The default value is %TRUE a #GstRTSPConnection + line="3899">a #GstRTSPConnection %TRUE if the connection should remember the session id + line="3900">%TRUE if the connection should remember the session id @@ -1583,7 +1618,7 @@ The default value is %TRUE version="1.4"> Sets the anchor certificate authorities database. This certificate + line="743">Sets the anchor certificate authorities database. This certificate database will be used to verify the server's certificate in case it can't be verified with the default certificate database first. a #GstRTSPConnection + line="745">a #GstRTSPConnection allow-none="1"> a #GTlsDatabase + line="746">a #GTlsDatabase @@ -1614,7 +1649,7 @@ can't be verified with the default certificate database first. version="1.6"> Sets a #GTlsInteraction object to be used when the connection or certificate + line="799">Sets a #GTlsInteraction object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary. a #GstRTSPConnection + line="801">a #GstRTSPConnection allow-none="1"> a #GTlsInteraction + line="802">a #GTlsInteraction @@ -1645,7 +1680,7 @@ user for passwords where necessary. version="1.2.1"> Sets the TLS validation flags to be used to verify the peer + line="674">Sets the TLS validation flags to be used to verify the peer certificate when a TLS connection is established. GLib guarantees that if certificate verification fails, at least one error @@ -1661,7 +1696,7 @@ the only error flag set even if other problems exist with the certificate. TRUE if the validation flags are set correctly, or FALSE if + line="691">TRUE if the validation flags are set correctly, or FALSE if @conn is NULL or is not a TLS connection. @@ -1669,13 +1704,13 @@ the only error flag set even if other problems exist with the certificate. a #GstRTSPConnection + line="676">a #GstRTSPConnection the validation flags. + line="677">the validation flags. @@ -1685,7 +1720,7 @@ the only error flag set even if other problems exist with the certificate. c:identifier="gst_rtsp_connection_set_tunneled"> Set the HTTP tunneling state of the connection. This must be configured before + line="3691">Set the HTTP tunneling state of the connection. This must be configured before the @conn is connected. @@ -1696,13 +1731,13 @@ the @conn is connected. a #GstRTSPConnection + line="3693">a #GstRTSPConnection the new state + line="3694">the new state @@ -1713,30 +1748,30 @@ the @conn is connected. deprecated-version="1.18"> Attempt to write @size bytes of @data to the connected @conn, blocking up to + line="5262">Attempt to write @size bytes of @data to the connected @conn, blocking up to the specified @timeout. @timeout can be %NULL, in which case this function might block forever. This function can be cancelled with gst_rtsp_connection_flush(). + line="366"/> #GST_RTSP_OK on success. + line="5275">#GST_RTSP_OK on success. a #GstRTSPConnection + line="5264">a #GstRTSPConnection the data to write + line="5265">the data to write @@ -1744,13 +1779,13 @@ This function can be cancelled with gst_rtsp_connection_flush(). the size of @data + line="5266">the size of @data a timeout value or %NULL + line="5267">a timeout value or %NULL @@ -1760,7 +1795,7 @@ This function can be cancelled with gst_rtsp_connection_flush(). version="1.18"> Attempt to write @size bytes of @data to the connected @conn, blocking up to + line="1883">Attempt to write @size bytes of @data to the connected @conn, blocking up to the specified @timeout. @timeout can be 0, in which case this function might block forever. @@ -1770,20 +1805,20 @@ This function can be cancelled with gst_rtsp_connection_flush(). #GST_RTSP_OK on success. + line="1896">#GST_RTSP_OK on success. a #GstRTSPConnection + line="1885">a #GstRTSPConnection the data to write + line="1886">the data to write @@ -1791,13 +1826,13 @@ This function can be cancelled with gst_rtsp_connection_flush(). the size of @data + line="1887">the size of @data a timeout value or 0 + line="1888">a timeout value or 0 @@ -1805,21 +1840,21 @@ This function can be cancelled with gst_rtsp_connection_flush(). Accept a new connection on @socket and create a new #GstRTSPConnection for + line="565">Accept a new connection on @socket and create a new #GstRTSPConnection for handling communication on new socket. #GST_RTSP_OK when @conn contains a valid connection. + line="574">#GST_RTSP_OK when @conn contains a valid connection. a socket + line="567">a socket nullable="1"> storage for a #GstRTSPConnection + line="568">storage for a #GstRTSPConnection allow-none="1"> a #GCancellable to cancel the operation + line="569">a #GCancellable to cancel the operation @@ -1846,7 +1881,7 @@ handling communication on new socket. Create a newly allocated #GstRTSPConnection from @url and store it in @conn. + line="399">Create a newly allocated #GstRTSPConnection from @url and store it in @conn. The connection will not yet attempt to connect to @url, use gst_rtsp_connection_connect(). @@ -1856,14 +1891,14 @@ A copy of @url will be made. #GST_RTSP_OK when @conn contains a valid connection. + line="410">#GST_RTSP_OK when @conn contains a valid connection. a #GstRTSPUrl + line="401">a #GstRTSPUrl transfer-ownership="full"> storage for a #GstRTSPConnection + line="402">storage for a #GstRTSPConnection @@ -1881,7 +1916,7 @@ A copy of @url will be made. c:identifier="gst_rtsp_connection_create_from_socket"> Create a new #GstRTSPConnection for handling communication on the existing + line="482">Create a new #GstRTSPConnection for handling communication on the existing socket @socket. The @initial_buffer contains zero terminated data already read from @socket which should be used before starting to read new data. #GST_RTSP_OK when @conn contains a valid connection. + line="494">#GST_RTSP_OK when @conn contains a valid connection. a #GSocket + line="484">a #GSocket the IP address of the other end + line="485">the IP address of the other end the port used by the other end + line="486">the port used by the other end data already read from @fd + line="487">data already read from @fd nullable="1"> storage for a #GstRTSPConnection + line="488">storage for a #GstRTSPConnection @@ -1962,7 +1997,7 @@ read from @socket which should be used before starting to read new data. c:type="GstRTSPEvent"> The possible events for the connection. + line="122">The possible events for the connection. glib:name="GST_RTSP_EV_READ"> connection is readable + line="124">connection is readable glib:name="GST_RTSP_EV_WRITE"> connection is writable + line="125">connection is writable c:type="GstRTSPFamily"> The possible network families. + line="134">The possible network families. glib:name="GST_RTSP_FAM_NONE"> unknown network family + line="136">unknown network family glib:name="GST_RTSP_FAM_INET"> internet + line="137">internet glib:name="GST_RTSP_FAM_INET6"> internet V6 + line="138">internet V6 c:type="GstRTSPHeaderField"> Enumeration of rtsp header fields + line="241">Enumeration of rtsp header fields The different supported RTSP methods. + line="184">The different supported RTSP methods. invalid method + line="186">invalid method the DESCRIBE method + line="187">the DESCRIBE method the ANNOUNCE method + line="188">the ANNOUNCE method the GET_PARAMETER method + line="189">the GET_PARAMETER method the OPTIONS method + line="190">the OPTIONS method the PAUSE method + line="191">the PAUSE method the PLAY method + line="192">the PLAY method the RECORD method + line="193">the RECORD method the REDIRECT method + line="194">the REDIRECT method the SETUP method + line="195">the SETUP method the SET_PARAMETER method + line="196">the SET_PARAMETER method the TEARDOWN method + line="197">the TEARDOWN method the GET method (HTTP). + line="198">the GET method (HTTP). the POST method (HTTP). + line="199">the POST method (HTTP). Convert @method to a string. + line="439"/> filename="gst-libs/gst/rtsp/gstrtspdefs.h" line="67">no error + + RTSP request is successful, but was redirected. + glib:name="GST_RTSP_ERROR"> some unspecified error occurred + line="69">some unspecified error occurred glib:name="GST_RTSP_EINVAL"> invalid arguments were provided to a function + line="70">invalid arguments were provided to a function glib:name="GST_RTSP_EINTR"> an operation was canceled + line="71">an operation was canceled glib:name="GST_RTSP_ENOMEM"> no memory was available for the operation + line="72">no memory was available for the operation glib:name="GST_RTSP_ERESOLV"> a host resolve error occurred + line="73">a host resolve error occurred glib:name="GST_RTSP_ENOTIMPL"> function not implemented + line="74">function not implemented glib:name="GST_RTSP_ESYS"> a system error occurred, errno contains more details + line="75">a system error occurred, errno contains more details glib:name="GST_RTSP_EPARSE"> a parsing error occurred + line="76">a parsing error occurred glib:name="GST_RTSP_EWSASTART"> windows networking could not start + line="77">windows networking could not start glib:name="GST_RTSP_EWSAVERSION"> windows networking stack has wrong version + line="78">windows networking stack has wrong version glib:name="GST_RTSP_EEOF"> end-of-file was reached + line="79">end-of-file was reached glib:name="GST_RTSP_ENET"> a network problem occurred, h_errno contains more details + line="80">a network problem occurred, h_errno contains more details glib:name="GST_RTSP_ENOTIP"> the host is not an IP host + line="81">the host is not an IP host glib:name="GST_RTSP_ETIMEOUT"> a timeout occurred + line="82">a timeout occurred glib:name="GST_RTSP_ETGET"> the tunnel GET request has been performed + line="83">the tunnel GET request has been performed glib:name="GST_RTSP_ETPOST"> the tunnel POST request has been performed + line="84">the tunnel POST request has been performed glib:name="GST_RTSP_ELAST"> last error + line="85">last error c:type="GstRTSPState"> The different RTSP states. + line="148">The different RTSP states. glib:name="GST_RTSP_STATE_INVALID"> invalid state + line="150">invalid state glib:name="GST_RTSP_STATE_INIT"> initializing + line="151">initializing glib:name="GST_RTSP_STATE_READY"> ready for operation + line="152">ready for operation glib:name="GST_RTSP_STATE_SEEKING"> seeking in progress + line="153">seeking in progress glib:name="GST_RTSP_STATE_PLAYING"> playing + line="154">playing glib:name="GST_RTSP_STATE_RECORDING"> recording + line="155">recording c:type="GstRTSPStatusCode"> Enumeration of rtsp status codes + line="362">Enumeration of rtsp status codes glib:nick="use-proxy" glib:name="GST_RTSP_STS_USE_PROXY"> + + RTSP request is temporarily redirected + + + RTSP request is permanently redirected + Convert @transport into a string that can be used to signal the transport in + line="592">Convert @transport into a string that can be used to signal the transport in an RTSP SETUP response. a string describing the RTSP transport + line="599">a string describing the RTSP transport or %NULL when the transport is invalid. @@ -5650,7 +5715,7 @@ or %NULL when the transport is invalid. a #GstRTSPTransport + line="594">a #GstRTSPTransport @@ -5658,20 +5723,20 @@ or %NULL when the transport is invalid. Free the memory used by @transport. + line="763">Free the memory used by @transport. #GST_RTSP_OK. + line="769">#GST_RTSP_OK. a #GstRTSPTransport + line="765">a #GstRTSPTransport @@ -5681,21 +5746,21 @@ or %NULL when the transport is invalid. version="1.4"> Get the media type of @transport. This media type is typically + line="240">Get the media type of @transport. This media type is typically used to generate #GstCaps events. #GST_RTSP_OK. + line="250">#GST_RTSP_OK. a #GstRTSPTransport + line="242">a #GstRTSPTransport transfer-ownership="none"> media type of @transport + line="243">media type of @transport @@ -5713,7 +5778,7 @@ used to generate #GstCaps events. c:identifier="gst_rtsp_transport_get_manager"> Get the #GstElement that can handle the buffers transported over @trans. + line="283">Get the #GstElement that can handle the buffers transported over @trans. It is possible that there are several managers available, use @option to selected one. @@ -5725,14 +5790,14 @@ needed/available for @trans. #GST_RTSP_OK. + line="297">#GST_RTSP_OK. a #GstRTSPTransMode + line="285">a #GstRTSPTransMode nullable="1"> location to hold the result + line="286">location to hold the result option index. + line="287">option index. @@ -5758,7 +5823,7 @@ needed/available for @trans. deprecated="1"> Get the mime type of the transport mode @trans. This mime type is typically + line="209">Get the mime type of the transport mode @trans. This mime type is typically used to generate #GstCaps events. This functions only deals with the GstRTSPTransMode and only returns the mime type for #GST_RTSP_PROFILE_AVP. Use @@ -5768,14 +5833,14 @@ used to generate #GstCaps events. #GST_RTSP_OK. + line="221">#GST_RTSP_OK. a #GstRTSPTransMode + line="211">a #GstRTSPTransMode transfer-ownership="none"> location to hold the result + line="212">location to hold the result @@ -5792,13 +5857,13 @@ used to generate #GstCaps events. Initialize @transport so that it can be used. + line="173">Initialize @transport so that it can be used. #GST_RTSP_OK. + line="179">#GST_RTSP_OK. @@ -5808,7 +5873,7 @@ used to generate #GstCaps events. transfer-ownership="none"> a #GstRTSPTransport + line="175">a #GstRTSPTransport @@ -5816,14 +5881,14 @@ used to generate #GstCaps events. Allocate a new initialized #GstRTSPTransport. Use gst_rtsp_transport_free() + line="150">Allocate a new initialized #GstRTSPTransport. Use gst_rtsp_transport_free() after usage. a #GstRTSPResult. + line="157">a #GstRTSPResult. @@ -5833,7 +5898,7 @@ after usage. transfer-ownership="full"> location to hold the new #GstRTSPTransport + line="152">location to hold the new #GstRTSPTransport @@ -5841,20 +5906,20 @@ after usage. Parse the RTSP transport string @str into @transport. + line="437">Parse the RTSP transport string @str into @transport. a #GstRTSPResult. + line="444">a #GstRTSPResult. a transport string + line="439">a transport string transfer-ownership="none"> a #GstRTSPTransport + line="440">a #GstRTSPTransport @@ -6141,7 +6206,7 @@ with gst_rtsp_url_free(). c:type="GstRTSPVersion"> The supported RTSP versions. + line="168">The supported RTSP versions. glib:name="GST_RTSP_VERSION_INVALID"> unknown/invalid version + line="170">unknown/invalid version glib:name="GST_RTSP_VERSION_1_0"> version 1.0 + line="171">version 1.0 glib:name="GST_RTSP_VERSION_1_1"> version 1.1. + line="172">version 1.1. glib:name="GST_RTSP_VERSION_2_0"> version 2.0. + line="173">version 2.0. Convert @version to a string. + line="442"/> Opaque RTSP watch object that can be used for asynchronous RTSP + line="249">Opaque RTSP watch object that can be used for asynchronous RTSP operations. + line="255"/> Adds a #GstRTSPWatch to a context so that it will be executed within that context. + line="4648">Adds a #GstRTSPWatch to a context so that it will be executed within that context. + line="313"/> the ID (greater than 0) for the watch within the GMainContext. + line="4655">the ID (greater than 0) for the watch within the GMainContext. a #GstRTSPWatch + line="4650">a #GstRTSPWatch allow-none="1"> a GMainContext (if NULL, the default context will be used) + line="4651">a GMainContext (if NULL, the default context will be used) @@ -6242,10 +6307,10 @@ operations. version="1.2"> Get the maximum amount of bytes and messages that will be queued in @watch. + line="4711">Get the maximum amount of bytes and messages that will be queued in @watch. See gst_rtsp_watch_set_send_backlog(). + line="321"/> @@ -6253,7 +6318,7 @@ See gst_rtsp_watch_set_send_backlog(). a #GstRTSPWatch + line="4713">a #GstRTSPWatch allow-none="1"> maximum bytes + line="4714">maximum bytes allow-none="1"> maximum messages + line="4715">maximum messages @@ -6283,10 +6348,10 @@ See gst_rtsp_watch_set_send_backlog(). Reset @watch, this is usually called after gst_rtsp_connection_do_tunnel() + line="4592">Reset @watch, this is usually called after gst_rtsp_connection_do_tunnel() when the file descriptors of the connection might have changed. + line="307"/> @@ -6294,7 +6359,7 @@ when the file descriptors of the connection might have changed. a #GstRTSPWatch + line="4594">a #GstRTSPWatch @@ -6302,31 +6367,31 @@ when the file descriptors of the connection might have changed. Send a @message using the connection of the @watch. If it cannot be sent + line="5016">Send a @message using the connection of the @watch. If it cannot be sent immediately, it will be queued for transmission in @watch. The contents of @message will then be serialized and transmitted when the connection of the @watch becomes writable. In case the @message is queued, the ID returned in @id will be non-zero and used as the ID argument in the message_sent callback. + line="330"/> #GST_RTSP_OK on success. + line="5029">#GST_RTSP_OK on success. a #GstRTSPWatch + line="5018">a #GstRTSPWatch a #GstRTSPMessage + line="5019">a #GstRTSPMessage allow-none="1"> location for a message ID or %NULL + line="5020">location for a message ID or %NULL @@ -6347,7 +6412,7 @@ callback. version="1.16"> Sends @messages using the connection of the @watch. If they cannot be sent + line="5041">Sends @messages using the connection of the @watch. If they cannot be sent immediately, they will be queued for transmission in @watch. The contents of @messages will then be serialized and transmitted when the connection of the @watch becomes writable. In case the @messages are queued, the ID returned in @@ -6355,24 +6420,24 @@ immediately, they will be queued for transmission in @watch. The contents of callback once the last message is sent. The callback will only be called once for the last message. + line="335"/> #GST_RTSP_OK on success. + line="5056">#GST_RTSP_OK on success. a #GstRTSPWatch + line="5043">a #GstRTSPWatch the messages to send + line="5044">the messages to send @@ -6380,7 +6445,7 @@ once for the last message. the number of messages to send + line="5045">the number of messages to send allow-none="1"> location for a message ID or %NULL + line="5046">location for a message ID or %NULL @@ -6401,11 +6466,11 @@ once for the last message. version="1.4"> When @flushing is %TRUE, abort a call to gst_rtsp_watch_wait_backlog() + line="5155">When @flushing is %TRUE, abort a call to gst_rtsp_watch_wait_backlog() and make sure gst_rtsp_watch_write_data() returns immediately with #GST_RTSP_EINTR. And empty the queue. + line="345"/> @@ -6413,13 +6478,13 @@ and make sure gst_rtsp_watch_write_data() returns immediately with a #GstRTSPWatch + line="5157">a #GstRTSPWatch new flushing state + line="5158">new flushing state @@ -6429,13 +6494,13 @@ and make sure gst_rtsp_watch_write_data() returns immediately with version="1.2"> Set the maximum amount of bytes and messages that will be queued in @watch. + line="4680">Set the maximum amount of bytes and messages that will be queued in @watch. When the maximum amounts are exceeded, gst_rtsp_watch_write_data() and gst_rtsp_watch_send_message() will return #GST_RTSP_ENOMEM. A value of 0 for @bytes or @messages means no limits. + line="317"/> @@ -6443,19 +6508,19 @@ A value of 0 for @bytes or @messages means no limits. a #GstRTSPWatch + line="4682">a #GstRTSPWatch maximum bytes + line="4683">maximum bytes maximum messages + line="4684">maximum messages @@ -6463,10 +6528,10 @@ A value of 0 for @bytes or @messages means no limits. Decreases the reference count of @watch by one. If the resulting reference + line="4665">Decreases the reference count of @watch by one. If the resulting reference count is zero the watch and associated memory will be destroyed. + line="310"/> @@ -6474,7 +6539,7 @@ count is zero the watch and associated memory will be destroyed. a #GstRTSPWatch + line="4667">a #GstRTSPWatch @@ -6486,7 +6551,7 @@ count is zero the watch and associated memory will be destroyed. deprecated-version="1.18"> Wait until there is place in the backlog queue, @timeout is reached + line="5414">Wait until there is place in the backlog queue, @timeout is reached or @watch is set to flushing. If @timeout is %NULL this function can block forever. If @timeout @@ -6497,11 +6562,11 @@ The typically use of this function is when gst_rtsp_watch_write_data returns %GST_RTSP_ENOMEM. The caller then calls this function to wait for free space in the backlog queue and try again. + line="389"/> %GST_RTSP_OK when if there is room in queue. + line="5430">%GST_RTSP_OK when if there is room in queue. %GST_RTSP_ETIMEOUT when @timeout was reached. %GST_RTSP_EINTR when @watch is flushing %GST_RTSP_EINVAL when called with invalid parameters. @@ -6511,13 +6576,13 @@ free space in the backlog queue and try again. a #GstRTSPWatch + line="5416">a #GstRTSPWatch a GTimeVal timeout + line="5417">a GTimeVal timeout @@ -6527,7 +6592,7 @@ free space in the backlog queue and try again. version="1.18"> Wait until there is place in the backlog queue, @timeout is reached + line="5090">Wait until there is place in the backlog queue, @timeout is reached or @watch is set to flushing. If @timeout is 0 this function can block forever. If @timeout @@ -6538,11 +6603,11 @@ The typically use of this function is when gst_rtsp_watch_write_data returns %GST_RTSP_ENOMEM. The caller then calls this function to wait for free space in the backlog queue and try again. + line="341"/> %GST_RTSP_OK when if there is room in queue. + line="5106">%GST_RTSP_OK when if there is room in queue. %GST_RTSP_ETIMEOUT when @timeout was reached. %GST_RTSP_EINTR when @watch is flushing %GST_RTSP_EINVAL when called with invalid parameters. @@ -6552,13 +6617,13 @@ free space in the backlog queue and try again. a #GstRTSPWatch + line="5092">a #GstRTSPWatch a timeout in microseconds + line="5093">a timeout in microseconds @@ -6566,7 +6631,7 @@ free space in the backlog queue and try again. Write @data using the connection of the @watch. If it cannot be sent + line="4978">Write @data using the connection of the @watch. If it cannot be sent immediately, it will be queued for transmission in @watch. The contents of @message will then be serialized and transmitted when the connection of the @watch becomes writable. In case the @message is queued, the ID returned in @@ -6579,11 +6644,11 @@ If the amount of queued data exceeds the limits set with gst_rtsp_watch_set_send_backlog(), this function will return #GST_RTSP_ENOMEM. + line="325"/> #GST_RTSP_OK on success. #GST_RTSP_ENOMEM when the backlog limits + line="4998">#GST_RTSP_OK on success. #GST_RTSP_ENOMEM when the backlog limits are reached. #GST_RTSP_EINTR when @watch was flushing. @@ -6591,13 +6656,13 @@ are reached. #GST_RTSP_EINTR when @watch was flushing. a #GstRTSPWatch + line="4980">a #GstRTSPWatch the data to queue + line="4981">the data to queue @@ -6605,7 +6670,7 @@ are reached. #GST_RTSP_EINTR when @watch was flushing. the size of @data + line="4982">the size of @data allow-none="1"> location for a message ID or %NULL + line="4983">location for a message ID or %NULL @@ -6626,7 +6691,7 @@ are reached. #GST_RTSP_EINTR when @watch was flushing. introspectable="0"> Create a watch object for @conn. The functions provided in @funcs will be + line="4541">Create a watch object for @conn. The functions provided in @funcs will be called with @user_data when activity happened on the watch. The new watch is usually created so that it can be attached to a @@ -6634,11 +6699,11 @@ maincontext with gst_rtsp_watch_attach(). @conn must exist for the entire lifetime of the watch. + line="301"/> a #GstRTSPWatch that can be used for asynchronous RTSP + line="4556">a #GstRTSPWatch that can be used for asynchronous RTSP communication. Free with gst_rtsp_watch_unref () after usage. @@ -6646,13 +6711,13 @@ communication. Free with gst_rtsp_watch_unref () after usage. a #GstRTSPConnection + line="4543">a #GstRTSPConnection watch functions + line="4544">watch functions allow-none="1"> user data to pass to @funcs + line="4545">user data to pass to @funcs notify when @user_data is not referenced anymore + line="4546">notify when @user_data is not referenced anymore @@ -6676,16 +6741,16 @@ communication. Free with gst_rtsp_watch_unref () after usage. Callback functions from a #GstRTSPWatch. + line="257">Callback functions from a #GstRTSPWatch. + line="298"/> callback when a message was received + line="259">callback when a message was received + line="278"/> @@ -6709,10 +6774,10 @@ communication. Free with gst_rtsp_watch_unref () after usage. callback when a message was sent + line="260">callback when a message was sent + line="280"/> @@ -6736,10 +6801,10 @@ communication. Free with gst_rtsp_watch_unref () after usage. callback when the connection is closed + line="261">callback when the connection is closed + line="282"/> @@ -6760,10 +6825,10 @@ communication. Free with gst_rtsp_watch_unref () after usage. callback when an error occurred + line="262">callback when an error occurred + line="283"/> @@ -6787,11 +6852,11 @@ communication. Free with gst_rtsp_watch_unref () after usage. a client started a tunneled connection. The tunnelid of the + line="263">a client started a tunneled connection. The tunnelid of the connection must be saved. + line="285"/> @@ -6812,12 +6877,12 @@ communication. Free with gst_rtsp_watch_unref () after usage. a client finished a tunneled connection. In this callback + line="265">a client finished a tunneled connection. In this callback you usually pair the tunnelid of this connection with the saved one using gst_rtsp_connection_do_tunnel(). + line="286"/> @@ -6838,11 +6903,11 @@ communication. Free with gst_rtsp_watch_unref () after usage. callback when an error occurred with more information than + line="268">callback when an error occurred with more information than the @error callback. + line="287"/> @@ -6872,10 +6937,10 @@ communication. Free with gst_rtsp_watch_unref () after usage. callback when the post connection of a tunnel is closed. + line="270">callback when the post connection of a tunnel is closed. + line="290"/> @@ -6896,12 +6961,12 @@ communication. Free with gst_rtsp_watch_unref () after usage. callback when an HTTP response to the GET request + line="271">callback when an HTTP response to the GET request is about to be sent for a tunneled connection. The response can be modified in the callback. Since: 1.4. + line="291"/> @@ -7041,21 +7106,21 @@ gst_rtsp_message_parse_auth_credentials(). moved-to="RTSPConnection.accept"> Accept a new connection on @socket and create a new #GstRTSPConnection for + line="565">Accept a new connection on @socket and create a new #GstRTSPConnection for handling communication on new socket. #GST_RTSP_OK when @conn contains a valid connection. + line="574">#GST_RTSP_OK when @conn contains a valid connection. a socket + line="567">a socket nullable="1"> storage for a #GstRTSPConnection + line="568">storage for a #GstRTSPConnection allow-none="1"> a #GCancellable to cancel the operation + line="569">a #GCancellable to cancel the operation @@ -7084,7 +7149,7 @@ handling communication on new socket. moved-to="RTSPConnection.create"> Create a newly allocated #GstRTSPConnection from @url and store it in @conn. + line="399">Create a newly allocated #GstRTSPConnection from @url and store it in @conn. The connection will not yet attempt to connect to @url, use gst_rtsp_connection_connect(). @@ -7094,14 +7159,14 @@ A copy of @url will be made. #GST_RTSP_OK when @conn contains a valid connection. + line="410">#GST_RTSP_OK when @conn contains a valid connection. a #GstRTSPUrl + line="401">a #GstRTSPUrl transfer-ownership="full"> storage for a #GstRTSPConnection + line="402">storage for a #GstRTSPConnection @@ -7120,7 +7185,7 @@ A copy of @url will be made. moved-to="RTSPConnection.create_from_socket"> Create a new #GstRTSPConnection for handling communication on the existing + line="482">Create a new #GstRTSPConnection for handling communication on the existing socket @socket. The @initial_buffer contains zero terminated data already read from @socket which should be used before starting to read new data. #GST_RTSP_OK when @conn contains a valid connection. + line="494">#GST_RTSP_OK when @conn contains a valid connection. a #GSocket + line="484">a #GSocket the IP address of the other end + line="485">the IP address of the other end the port used by the other end + line="486">the port used by the other end data already read from @fd + line="487">data already read from @fd nullable="1"> storage for a #GstRTSPConnection + line="488">storage for a #GstRTSPConnection @@ -7173,7 +7238,7 @@ read from @socket which should be used before starting to read new data. Convert @header to a #GstRTSPHeaderField. - + Convert @method to a #GstRTSPMethod. - + the username and password. See RFC2069 for details. Currently only supported algorithm "md5". - + - + Check whether @field may appear multiple times in a message. - + Convert @field to a string. - + Convert @method to a string. - + Convert @options to a string. - + filename="gst-libs/gst/rtsp/gstrtspdefs.c" line="486">Convert the comma separated list @options to a #GstRTSPMethod bitwise or of methods. This functions is the reverse of gst_rtsp_options_as_text(). - + Convert @code to a string. - + Convert @result in a human readable string. - + moved-to="RTSPTransport.get_manager"> Get the #GstElement that can handle the buffers transported over @trans. + line="283">Get the #GstElement that can handle the buffers transported over @trans. It is possible that there are several managers available, use @option to selected one. @@ -7794,14 +7859,14 @@ needed/available for @trans. #GST_RTSP_OK. + line="297">#GST_RTSP_OK. a #GstRTSPTransMode + line="285">a #GstRTSPTransMode nullable="1"> location to hold the result + line="286">location to hold the result option index. + line="287">option index. @@ -7828,7 +7893,7 @@ needed/available for @trans. deprecated="1"> Get the mime type of the transport mode @trans. This mime type is typically + line="209">Get the mime type of the transport mode @trans. This mime type is typically used to generate #GstCaps events. This functions only deals with the GstRTSPTransMode and only returns the mime type for #GST_RTSP_PROFILE_AVP. Use @@ -7838,14 +7903,14 @@ used to generate #GstCaps events. #GST_RTSP_OK. + line="221">#GST_RTSP_OK. a #GstRTSPTransMode + line="211">a #GstRTSPTransMode transfer-ownership="none"> location to hold the result + line="212">location to hold the result @@ -7864,13 +7929,13 @@ used to generate #GstCaps events. moved-to="RTSPTransport.init"> Initialize @transport so that it can be used. + line="173">Initialize @transport so that it can be used. #GST_RTSP_OK. + line="179">#GST_RTSP_OK. @@ -7880,7 +7945,7 @@ used to generate #GstCaps events. transfer-ownership="none"> a #GstRTSPTransport + line="175">a #GstRTSPTransport @@ -7890,14 +7955,14 @@ used to generate #GstCaps events. moved-to="RTSPTransport.new"> Allocate a new initialized #GstRTSPTransport. Use gst_rtsp_transport_free() + line="150">Allocate a new initialized #GstRTSPTransport. Use gst_rtsp_transport_free() after usage. a #GstRTSPResult. + line="157">a #GstRTSPResult. @@ -7907,7 +7972,7 @@ after usage. transfer-ownership="full"> location to hold the new #GstRTSPTransport + line="152">location to hold the new #GstRTSPTransport @@ -7917,20 +7982,20 @@ after usage. moved-to="RTSPTransport.parse"> Parse the RTSP transport string @str into @transport. + line="437">Parse the RTSP transport string @str into @transport. a #GstRTSPResult. + line="444">a #GstRTSPResult. a transport string + line="439">a transport string transfer-ownership="none"> a #GstRTSPTransport + line="440">a #GstRTSPTransport @@ -7983,7 +8048,7 @@ with gst_rtsp_url_free(). Convert @version to a string. - + introspectable="0"> Create a watch object for @conn. The functions provided in @funcs will be + line="4541">Create a watch object for @conn. The functions provided in @funcs will be called with @user_data when activity happened on the watch. The new watch is usually created so that it can be attached to a @@ -8013,11 +8078,11 @@ maincontext with gst_rtsp_watch_attach(). @conn must exist for the entire lifetime of the watch. + line="301"/> a #GstRTSPWatch that can be used for asynchronous RTSP + line="4556">a #GstRTSPWatch that can be used for asynchronous RTSP communication. Free with gst_rtsp_watch_unref () after usage. @@ -8025,13 +8090,13 @@ communication. Free with gst_rtsp_watch_unref () after usage. a #GstRTSPConnection + line="4543">a #GstRTSPConnection watch functions + line="4544">watch functions allow-none="1"> user data to pass to @funcs + line="4545">user data to pass to @funcs notify when @user_data is not referenced anymore + line="4546">notify when @user_data is not referenced anymore diff --git a/girs/GstRtspServer-1.0.gir b/girs/GstRtspServer-1.0.gir index c515de68e..ca02b90e6 100644 --- a/girs/GstRtspServer-1.0.gir +++ b/girs/GstRtspServer-1.0.gir @@ -940,6 +940,12 @@ g_free() after usage. + check the authentication of a client. The default implementation + checks if the authentication in the header matches one of the basic + authentication tokens. This function should set the authgroup field + in the context. @@ -954,6 +960,12 @@ g_free() after usage. + check if a resource can be accessed. this function should + call authenticate to authenticate the client when needed. The method + should also construct and send an appropriate response message on + error. @@ -1486,6 +1498,12 @@ no one else overrides it. + check the authentication of a client. The default implementation + checks if the authentication in the header matches one of the basic + authentication tokens. This function should set the authgroup field + in the context. @@ -1502,6 +1520,12 @@ no one else overrides it. + check if a resource can be accessed. this function should + call authenticate to authenticate the client when needed. The method + should also construct and send an appropriate response message on + error. @@ -1628,6 +1652,10 @@ possibility to adjust the error code. + called to give the application the possibility to adjust + the range, seek flags, rate and rate-control. Since 1.18 @@ -1657,6 +1685,11 @@ possibility to adjust the error code. + called to give the implementation the possibility to + adjust the response to a play request, for example if extra headers were + parsed when #GstRTSPClientClass.adjust_play_mode was called. Since 1.18 @@ -1713,6 +1746,11 @@ possibility to adjust the error code. + called when the stream in media needs to be configured. + The default implementation will configure the blocksize on the payloader when + spcified in the request headers. @@ -1733,6 +1771,10 @@ possibility to adjust the error code. + called when the client transport needs to be + configured. @@ -1750,6 +1792,9 @@ possibility to adjust the error code. + called when the SDP needs to be created for media. @@ -1826,6 +1871,9 @@ possibility to adjust the error code. + called to create path from uri. @@ -1868,6 +1916,10 @@ possibility to adjust the error code. + get parameters. This function should also initialize the + RTSP response(ctx->response) via a call to gst_rtsp_message_init_response() @@ -1882,6 +1934,10 @@ possibility to adjust the error code. + set parameters. This function should also initialize the + RTSP response(ctx->response) via a call to gst_rtsp_message_init_response() @@ -2137,6 +2193,10 @@ possibility to adjust the error code. + called when a response to the GET request is about to + be sent for a tunneled connection. The response can be modified. Since: 1.4 @@ -3184,6 +3244,9 @@ that created the client but can be overridden later. + called when the SDP needs to be created for media. @@ -3201,6 +3264,11 @@ that created the client but can be overridden later. + called when the stream in media needs to be configured. + The default implementation will configure the blocksize on the payloader when + spcified in the request headers. @@ -3224,6 +3292,10 @@ that created the client but can be overridden later. + called when the client transport needs to be + configured. @@ -3244,6 +3316,10 @@ that created the client but can be overridden later. + set parameters. This function should also initialize the + RTSP response(ctx->response) via a call to gst_rtsp_message_init_response() @@ -3261,6 +3337,10 @@ that created the client but can be overridden later. + get parameters. This function should also initialize the + RTSP response(ctx->response) via a call to gst_rtsp_message_init_response() @@ -3278,6 +3358,9 @@ that created the client but can be overridden later. + called to create path from uri. @@ -3295,6 +3378,10 @@ that created the client but can be overridden later. + called to give the application the possibility to adjust + the range, seek flags, rate and rate-control. Since 1.18 @@ -3327,6 +3414,11 @@ that created the client but can be overridden later. + called to give the implementation the possibility to + adjust the response to a play request, for example if extra headers were + parsed when #GstRTSPClientClass.adjust_play_mode was called. Since 1.18 @@ -3528,6 +3620,10 @@ that created the client but can be overridden later. + called when a response to the GET request is about to + be sent for a tunneled connection. The response can be modified. Since: 1.4 @@ -4237,7 +4333,7 @@ This object is usually created from a #GstRTSPMediaFactory. Create a new #GstRTSPMedia instance. @element is the bin element that + line="1028">Create a new #GstRTSPMedia instance. @element is the bin element that provides the different streams. The #GstRTSPMedia object contains the element to produce RTP data for one or more related (audio/video/..) streams. @@ -4247,19 +4343,22 @@ Ownership is taken of @element. a new #GstRTSPMedia object. + line="1039">a new #GstRTSPMedia object. a #GstElement + line="1030">a #GstElement + convert a range to the given unit @@ -4288,6 +4387,9 @@ Ownership is taken of @element. + handle a message @@ -4304,25 +4406,25 @@ Ownership is taken of @element. Configure an SDP on @media for receiving streams + line="4747">Configure an SDP on @media for receiving streams TRUE on success. + line="4754">TRUE on success. a #GstRTSPMedia + line="4749">a #GstRTSPMedia a #GstSDPMessage + line="4750">a #GstSDPMessage @@ -4358,7 +4460,7 @@ Ownership is taken of @element. Prepare @media for streaming. This function will create the objects + line="4129">Prepare @media for streaming. This function will create the objects to manage the streaming. A pipeline must have been set on @media with gst_rtsp_media_take_pipeline(). @@ -4368,14 +4470,14 @@ such as the duration. %TRUE on success. + line="4142">%TRUE on success. a #GstRTSPMedia + line="4131">a #GstRTSPMedia allow-none="1"> a #GstRTSPThread to run the + line="4132">a #GstRTSPThread to run the bus handler or %NULL @@ -4402,6 +4504,9 @@ such as the duration. + query the current position in the pipeline @@ -4416,6 +4521,9 @@ such as the duration. + query when playback will stop @@ -4460,32 +4568,32 @@ such as the duration. Add @media specific info to @sdp. @info is used to configure the connection + line="4606">Add @media specific info to @sdp. @info is used to configure the connection information in the SDP. TRUE on success. + line="4615">TRUE on success. a #GstRTSPMedia + line="4608">a #GstRTSPMedia a #GstSDPMessage + line="4609">a #GstSDPMessage a #GstSDPInfo + line="4610">a #GstSDPInfo @@ -4493,7 +4601,7 @@ information in the SDP. Suspend @media. The state of the pipeline managed by @media is set to + line="4874">Suspend @media. The state of the pipeline managed by @media is set to GST_STATE_NULL but all streams are kept. @media can be prepared again with gst_rtsp_media_unsuspend() @@ -4502,14 +4610,14 @@ with gst_rtsp_media_unsuspend() %TRUE on success. + line="4884">%TRUE on success. a #GstRTSPMedia + line="4876">a #GstRTSPMedia @@ -4531,21 +4639,21 @@ with gst_rtsp_media_unsuspend() Unprepare @media. After this call, the media should be prepared again before + line="4364">Unprepare @media. After this call, the media should be prepared again before it can be used again. If the media is set to be non-reusable, a new instance must be created. %TRUE on success. + line="4372">%TRUE on success. a #GstRTSPMedia + line="4366">a #GstRTSPMedia @@ -4564,20 +4672,20 @@ must be created. Unsuspend @media if it was in a suspended state. This method does nothing + line="5098">Unsuspend @media if it was in a suspended state. This method does nothing when the media was not in the suspended state. %TRUE on success. + line="5105">%TRUE on success. a #GstRTSPMedia + line="5100">a #GstRTSPMedia @@ -4587,7 +4695,7 @@ when the media was not in the suspended state. version="1.24"> Check if the pipeline for @media can be shared between multiple clients. + line="1276">Check if the pipeline for @media can be shared between multiple clients. This checks if the media is shareable and whether it is either reusable or was never unprepared before. @@ -4597,14 +4705,14 @@ The function must be called with gst_rtsp_media_lock(). %TRUE if the media can be shared between clients. + line="1287">%TRUE if the media can be shared between clients. a #GstRTSPMedia + line="1278">a #GstRTSPMedia @@ -4613,7 +4721,7 @@ The function must be called with gst_rtsp_media_lock(). c:identifier="gst_rtsp_media_collect_streams"> Find all payloader elements, they should be named pay\%d in the + line="2395">Find all payloader elements, they should be named pay\%d in the element of @media, and create #GstRTSPStreams for them. Collect all dynamic elements, named dynpay\%d, and add them to @@ -4621,7 +4729,7 @@ the list of dynamic elements. Find all depayloader elements, they should be named depay\%d in the element of @media, and create #GstRTSPStreams for them. - + @@ -4629,7 +4737,7 @@ element of @media, and create #GstRTSPStreams for them. a #GstRTSPMedia + line="2397">a #GstRTSPMedia @@ -4639,26 +4747,26 @@ element of @media, and create #GstRTSPStreams for them. version="1.14"> Add a receiver and sender parts to the pipeline based on the transport from + line="5417">Add a receiver and sender parts to the pipeline based on the transport from SETUP. - + %TRUE if the media pipeline has been sucessfully updated. + line="5425">%TRUE if the media pipeline has been sucessfully updated. a #GstRTSPMedia + line="5419">a #GstRTSPMedia a list of #GstRTSPTransport + line="5420">a list of #GstRTSPTransport @@ -4668,13 +4776,13 @@ SETUP. Create a new stream in @media that provides RTP data on @pad. + line="2574">Create a new stream in @media that provides RTP data on @pad. @pad should be a pad of an element inside @media->element. - + a new #GstRTSPStream that remains valid for as long + line="2583">a new #GstRTSPStream that remains valid for as long as @media exists. @@ -4682,19 +4790,19 @@ as @media exists. a #GstRTSPMedia + line="2576">a #GstRTSPMedia a #GstElement + line="2577">a #GstElement a #GstPad + line="2578">a #GstPad @@ -4702,12 +4810,12 @@ as @media exists. Find a stream in @media with @control as the control uri. - + line="2821">Find a stream in @media with @control as the control uri. + the #GstRTSPStream with + line="2828">the #GstRTSPStream with control uri @control or %NULL when a stream with that control did not exist. @@ -4716,13 +4824,13 @@ not exist. a #GstRTSPMedia + line="2823">a #GstRTSPMedia the control of the stream + line="2824">the control of the stream @@ -4731,12 +4839,12 @@ not exist. c:identifier="gst_rtsp_media_get_address_pool"> Get the #GstRTSPAddressPool used as the address pool of @media. + line="2138">Get the #GstRTSPAddressPool used as the address pool of @media. the #GstRTSPAddressPool of @media. + line="2144">the #GstRTSPAddressPool of @media. g_object_unref() after usage. @@ -4744,7 +4852,7 @@ g_object_unref() after usage. a #GstRTSPMedia + line="2140">a #GstRTSPMedia @@ -4752,21 +4860,21 @@ g_object_unref() after usage. Get the base_time that is used by the pipeline in @media. + line="4519">Get the base_time that is used by the pipeline in @media. @media must be prepared before this method returns a valid base_time. - + the base_time used by @media. + line="4527">the base_time used by @media. a #GstRTSPMedia + line="4521">a #GstRTSPMedia @@ -4776,19 +4884,19 @@ g_object_unref() after usage. glib:get-property="buffer-size"> Get the kernel UDP buffer size. + line="1540">Get the kernel UDP buffer size. the kernel UDP buffer size. + line="1546">the kernel UDP buffer size. a #GstRTSPMedia + line="1542">a #GstRTSPMedia @@ -4798,21 +4906,21 @@ g_object_unref() after usage. glib:get-property="clock"> Get the clock that is used by the pipeline in @media. + line="4492">Get the clock that is used by the pipeline in @media. @media must be prepared before this method returns a valid clock object. - + the #GstClock used by @media. unref after usage. + line="4500">the #GstClock used by @media. unref after usage. a #GstRTSPMedia + line="4494">a #GstRTSPMedia @@ -4820,11 +4928,11 @@ g_object_unref() after usage. - + Whether retransmission requests will be sent + line="1871">Whether retransmission requests will be sent @@ -4839,19 +4947,19 @@ g_object_unref() after usage. version="1.18"> Get the configured DSCP QoS of attached media. - + line="1712">Get the configured DSCP QoS of attached media. + the DSCP QoS value of attached streams or -1 if disabled. + line="1718">the DSCP QoS value of attached streams or -1 if disabled. a #GstRTSPMedia + line="1714">a #GstRTSPMedia @@ -4861,19 +4969,65 @@ g_object_unref() after usage. glib:get-property="element"> Get the element that was used when constructing @media. + line="1053">Get the element that was used when constructing @media. a #GstElement. Unref after usage. + line="1059">a #GstElement. Unref after usage. a #GstRTSPMedia + line="1055">a #GstRTSPMedia + + + + + + Get ensure-keyunit-on-start flag. + + + The ensure-keyunit-on-start flag. + + + + + a #GstRTSPMedia + + + + + + Get ensure-keyunit-on-start-timeout time. + + + The ensure-keyunit-on-start-timeout time. + + + + + a #GstRTSPMedia @@ -4883,19 +5037,19 @@ g_object_unref() after usage. glib:get-property="latency"> Get the latency that is used for receiving media. - + line="1946">Get the latency that is used for receiving media. + latency in milliseconds + line="1952">latency in milliseconds a #GstRTSPMedia + line="1948">a #GstRTSPMedia @@ -4906,19 +5060,19 @@ g_object_unref() after usage. version="1.16"> Get the the maximum time-to-live value of outgoing multicast packets. - + line="2266">Get the the maximum time-to-live value of outgoing multicast packets. + the maximum time-to-live value of outgoing multicast packets. + line="2272">the maximum time-to-live value of outgoing multicast packets. a #GstRTSPMedia + line="2268">a #GstRTSPMedia @@ -4927,12 +5081,12 @@ g_object_unref() after usage. c:identifier="gst_rtsp_media_get_multicast_iface"> Get the multicast interface used for @media. + line="2198">Get the multicast interface used for @media. the multicast interface for @media. + line="2204">the multicast interface for @media. g_free() after usage. @@ -4940,7 +5094,7 @@ g_free() after usage. a #GstRTSPMedia + line="2200">a #GstRTSPMedia @@ -4949,19 +5103,19 @@ g_free() after usage. c:identifier="gst_rtsp_media_get_permissions"> Get the permissions object from @media. + line="1137">Get the permissions object from @media. a #GstRTSPPermissions object, unref after usage. + line="1143">a #GstRTSPPermissions object, unref after usage. a #GstRTSPMedia + line="1139">a #GstRTSPMedia @@ -4971,19 +5125,19 @@ g_free() after usage. glib:get-property="profiles"> Get the allowed profiles of @media. + line="1384">Get the allowed profiles of @media. a #GstRTSPProfile + line="1390">a #GstRTSPProfile a #GstRTSPMedia + line="1386">a #GstRTSPMedia @@ -4993,19 +5147,19 @@ g_free() after usage. glib:get-property="protocols"> Get the allowed protocols of @media. + line="1437">Get the allowed protocols of @media. a #GstRTSPLowerTrans + line="1443">a #GstRTSPLowerTrans a #GstRTSPMedia + line="1439">a #GstRTSPMedia @@ -5015,19 +5169,19 @@ g_free() after usage. version="1.8"> Gets if and how the media clock should be published according to RFC7273. - + line="2081">Gets if and how the media clock should be published according to RFC7273. + The GstRTSPPublishClockMode + line="2087">The GstRTSPPublishClockMode a #GstRTSPMedia + line="2083">a #GstRTSPMedia @@ -5036,32 +5190,32 @@ g_free() after usage. c:identifier="gst_rtsp_media_get_range_string"> Get the current range as a string. @media must be prepared with + line="2869">Get the current range as a string. @media must be prepared with gst_rtsp_media_prepare (). - + The range as a string, g_free() after usage. + line="2878">The range as a string, g_free() after usage. a #GstRTSPMedia + line="2871">a #GstRTSPMedia for the PLAY request + line="2872">for the PLAY request the unit to use for the string + line="2873">the unit to use for the string @@ -5069,11 +5223,11 @@ gst_rtsp_media_prepare (). - + whether @media will follow the Rate-Control=no behaviour as specified + line="5560">whether @media will follow the Rate-Control=no behaviour as specified in the ONVIF replay spec. @@ -5088,12 +5242,12 @@ in the ONVIF replay spec. version="1.18"> Get the rate and applied_rate of the current segment. - + line="2935">Get the rate and applied_rate of the current segment. + %FALSE if looking up the rate and applied rate failed. Otherwise + line="2943">%FALSE if looking up the rate and applied rate failed. Otherwise %TRUE is returned and @rate and @applied_rate are set to the rate and applied_rate of the current segment. @@ -5102,7 +5256,7 @@ applied_rate of the current segment. a #GstRTSPMedia + line="2937">a #GstRTSPMedia allow-none="1"> the rate of the current segment + line="2938">the rate of the current segment allow-none="1"> the applied_rate of the current segment + line="2939">the applied_rate of the current segment @@ -5133,19 +5287,19 @@ applied_rate of the current segment. c:identifier="gst_rtsp_media_get_retransmission_time"> Get the amount of time to store retransmission data. - + line="1818">Get the amount of time to store retransmission data. + the amount of time to store retransmission data. + line="1824">the amount of time to store retransmission data. a #GstRTSPMedia + line="1820">a #GstRTSPMedia @@ -5153,20 +5307,20 @@ applied_rate of the current segment. Get the status of @media. When @media is busy preparing, this function waits + line="3061">Get the status of @media. When @media is busy preparing, this function waits until @media is prepared or in error. the status of @media. + line="3068">the status of @media. a #GstRTSPMedia + line="3063">a #GstRTSPMedia @@ -5174,12 +5328,12 @@ until @media is prepared or in error. Retrieve the stream with index @idx from @media. - + line="2791">Retrieve the stream with index @idx from @media. + the #GstRTSPStream at index + line="2798">the #GstRTSPStream at index @idx or %NULL when a stream with that index did not exist. @@ -5187,13 +5341,13 @@ until @media is prepared or in error. a #GstRTSPMedia + line="2793">a #GstRTSPMedia the stream index + line="2794">the stream index @@ -5203,19 +5357,19 @@ until @media is prepared or in error. glib:get-property="suspend-mode"> Get how @media will be suspended. - + line="1198">Get how @media will be suspended. + #GstRTSPSuspendMode. + line="1204">#GstRTSPSuspendMode. a #GstRTSPMedia + line="1200">a #GstRTSPMedia @@ -5225,20 +5379,20 @@ until @media is prepared or in error. glib:get-property="time-provider"> Get the #GstNetTimeProvider for the clock used by @media. The time provider + line="4557">Get the #GstNetTimeProvider for the clock used by @media. The time provider will listen on @address and @port for client time requests. - + the #GstNetTimeProvider of @media. + line="4566">the #GstNetTimeProvider of @media. a #GstRTSPMedia + line="4559">a #GstRTSPMedia allow-none="1"> an address or %NULL + line="4560">an address or %NULL a port or 0 + line="4561">a port or 0 @@ -5263,19 +5417,19 @@ will listen on @address and @port for client time requests. glib:get-property="transport-mode"> Check if the pipeline for @media can be used for PLAY or RECORD methods. + line="5360">Check if the pipeline for @media can be used for PLAY or RECORD methods. The transport mode. + line="5366">The transport mode. a #GstRTSPMedia + line="5362">a #GstRTSPMedia @@ -5283,25 +5437,25 @@ will listen on @address and @port for client time requests. Configure an SDP on @media for receiving streams - + line="4747">Configure an SDP on @media for receiving streams + TRUE on success. + line="4754">TRUE on success. a #GstRTSPMedia + line="4749">a #GstRTSPMedia a #GstSDPMessage + line="4750">a #GstSDPMessage @@ -5311,12 +5465,12 @@ will listen on @address and @port for client time requests. version="1.18"> See gst_rtsp_stream_is_complete(), gst_rtsp_stream_is_sender(). - + line="5496">See gst_rtsp_stream_is_complete(), gst_rtsp_stream_is_sender(). + whether @media has at least one complete sender stream. + line="5501">whether @media has at least one complete sender stream. @@ -5330,19 +5484,19 @@ will listen on @address and @port for client time requests. version="1.16"> Check if multicast sockets are configured to be bound to multicast addresses. - + line="2323">Check if multicast sockets are configured to be bound to multicast addresses. + %TRUE if multicast sockets are configured to be bound to multicast addresses. + line="2329">%TRUE if multicast sockets are configured to be bound to multicast addresses. a #GstRTSPMedia + line="2325">a #GstRTSPMedia @@ -5351,20 +5505,20 @@ will listen on @address and @port for client time requests. c:identifier="gst_rtsp_media_is_eos_shutdown"> Check if the pipeline for @media will send an EOS down the pipeline before + line="1485">Check if the pipeline for @media will send an EOS down the pipeline before unpreparing. %TRUE if the media will send EOS before unpreparing. + line="1492">%TRUE if the media will send EOS before unpreparing. a #GstRTSPMedia + line="1487">a #GstRTSPMedia @@ -5372,11 +5526,11 @@ unpreparing. - + %TRUE if @media is receive-only, %FALSE otherwise. + line="5480">%TRUE if @media is receive-only, %FALSE otherwise. @@ -5388,19 +5542,19 @@ unpreparing. Check if the pipeline for @media can be reused after an unprepare. + line="1331">Check if the pipeline for @media can be reused after an unprepare. %TRUE if the media can be reused + line="1337">%TRUE if the media can be reused a #GstRTSPMedia + line="1333">a #GstRTSPMedia @@ -5408,7 +5562,7 @@ unpreparing. Check if the pipeline for @media can be shared between multiple clients in + line="1246">Check if the pipeline for @media can be shared between multiple clients in theory. This simply returns the value set via gst_rtsp_media_set_shared(). To know if a media can be shared in practice, i.e. if it's shareable and @@ -5418,14 +5572,14 @@ gst_rtsp_media_can_be_shared(). %TRUE if the media can be shared between clients. + line="1257">%TRUE if the media can be shared between clients. a #GstRTSPMedia + line="1248">a #GstRTSPMedia @@ -5434,13 +5588,13 @@ gst_rtsp_media_can_be_shared(). c:identifier="gst_rtsp_media_is_stop_on_disconnect"> Check if the pipeline for @media will be stopped when a client disconnects + line="1762">Check if the pipeline for @media will be stopped when a client disconnects without sending TEARDOWN. %TRUE if the media will be stopped when a client disconnects + line="1769">%TRUE if the media will be stopped when a client disconnects without sending TEARDOWN. @@ -5448,7 +5602,7 @@ without sending TEARDOWN. a #GstRTSPMedia + line="1764">a #GstRTSPMedia @@ -5457,21 +5611,21 @@ without sending TEARDOWN. c:identifier="gst_rtsp_media_is_time_provider"> Check if @media can provide a #GstNetTimeProvider for its pipeline clock. + line="1992">Check if @media can provide a #GstNetTimeProvider for its pipeline clock. Use gst_rtsp_media_get_time_provider() to get the network clock. - + %TRUE if @media can provide a #GstNetTimeProvider. + line="2000">%TRUE if @media can provide a #GstNetTimeProvider. a #GstRTSPMedia + line="1994">a #GstRTSPMedia @@ -5479,7 +5633,7 @@ Use gst_rtsp_media_get_time_provider() to get the network clock. Lock the entire media. This is needed by callers such as rtsp_client to + line="4444">Lock the entire media. This is needed by callers such as rtsp_client to protect the media when it is shared by many clients. The lock prevents that concurrent clients alters the shared media, while one client already is working with it. @@ -5488,7 +5642,7 @@ such as DESCRIBE, SETUP, ANNOUNCE, TEARDOWN, PLAY, PAUSE. As best practice take the lock as soon as the function get hold of a shared media object. Release the lock right before the function returns. - + @@ -5496,7 +5650,7 @@ media object. Release the lock right before the function returns. a #GstRTSPMedia + line="4446">a #GstRTSPMedia @@ -5504,19 +5658,19 @@ media object. Release the lock right before the function returns. Get the number of streams in this media. - + line="2766">Get the number of streams in this media. + The number of streams. + line="2772">The number of streams. a #GstRTSPMedia + line="2768">a #GstRTSPMedia @@ -5524,24 +5678,24 @@ media object. Release the lock right before the function returns. Prepare @media for streaming. This function will create the objects + line="4129">Prepare @media for streaming. This function will create the objects to manage the streaming. A pipeline must have been set on @media with gst_rtsp_media_take_pipeline(). It will preroll the pipeline and collect vital information about the streams such as the duration. - + %TRUE on success. + line="4142">%TRUE on success. a #GstRTSPMedia + line="4131">a #GstRTSPMedia allow-none="1"> a #GstRTSPThread to run the + line="4132">a #GstRTSPThread to run the bus handler or %NULL @@ -5559,26 +5713,26 @@ such as the duration. Seek the pipeline of @media to @range. @media must be prepared with + line="3363">Seek the pipeline of @media to @range. @media must be prepared with gst_rtsp_media_prepare(). - + %TRUE on success. + line="3371">%TRUE on success. a #GstRTSPMedia + line="3365">a #GstRTSPMedia a #GstRTSPTimeRange + line="3366">a #GstRTSPTimeRange @@ -5588,32 +5742,32 @@ gst_rtsp_media_prepare(). version="1.18"> Seek the pipeline of @media to @range with the given @flags. + line="3344">Seek the pipeline of @media to @range with the given @flags. @media must be prepared with gst_rtsp_media_prepare(). - + %TRUE on success. + line="3353">%TRUE on success. a #GstRTSPMedia + line="3346">a #GstRTSPMedia a #GstRTSPTimeRange + line="3347">a #GstRTSPTimeRange The minimal set of #GstSeekFlags to use + line="3348">The minimal set of #GstSeekFlags to use @@ -5623,47 +5777,47 @@ gst_rtsp_media_prepare(). version="1.18"> Seek the pipeline of @media to @range with the given @flags and @rate, + line="3095">Seek the pipeline of @media to @range with the given @flags and @rate, and @trickmode_interval. @media must be prepared with gst_rtsp_media_prepare(). In order to perform the seek operation, the pipeline must contain all needed transport parts (transport sinks). - + %TRUE on success. + line="3109">%TRUE on success. a #GstRTSPMedia + line="3097">a #GstRTSPMedia a #GstRTSPTimeRange + line="3098">a #GstRTSPTimeRange The minimal set of #GstSeekFlags to use + line="3099">The minimal set of #GstSeekFlags to use the rate to use in the seek + line="3100">the rate to use in the seek The trickmode interval to use for KEY_UNITS trick mode + line="3101">The trickmode interval to use for KEY_UNITS trick mode @@ -5673,13 +5827,13 @@ needed transport parts (transport sinks). version="1.14"> Check if the pipeline for @media seek and up to what point in time, + line="5385">Check if the pipeline for @media seek and up to what point in time, it can seek. - + -1 if the stream is not seekable, 0 if seekable only to the beginning + line="5392">-1 if the stream is not seekable, 0 if seekable only to the beginning and > 0 to indicate the longest duration between any two random access points. %G_MAXINT64 means any value is possible. @@ -5688,7 +5842,7 @@ and > 0 to indicate the longest duration between any two random access points a #GstRTSPMedia + line="5387">a #GstRTSPMedia @@ -5697,7 +5851,7 @@ and > 0 to indicate the longest duration between any two random access points c:identifier="gst_rtsp_media_set_address_pool"> configure @pool to be used as the address pool of @media. + line="2105">configure @pool to be used as the address pool of @media. @@ -5706,7 +5860,7 @@ and > 0 to indicate the longest duration between any two random access points a #GstRTSPMedia + line="2107">a #GstRTSPMedia a #GstRTSPAddressPool + line="2108">a #GstRTSPAddressPool @@ -5726,9 +5880,9 @@ and > 0 to indicate the longest duration between any two random access points version="1.16"> Decide whether the multicast socket should be bound to a multicast address or + line="2293">Decide whether the multicast socket should be bound to a multicast address or INADDR_ANY. - + @@ -5736,13 +5890,13 @@ INADDR_ANY. a #GstRTSPMedia + line="2295">a #GstRTSPMedia the new value + line="2296">the new value @@ -5752,7 +5906,7 @@ INADDR_ANY. glib:set-property="buffer-size"> Set the kernel UDP buffer size. + line="1511">Set the kernel UDP buffer size. @@ -5761,13 +5915,13 @@ INADDR_ANY. a #GstRTSPMedia + line="1513">a #GstRTSPMedia the new value + line="1514">the new value @@ -5777,8 +5931,8 @@ INADDR_ANY. glib:set-property="clock"> Configure the clock used for the media. - + line="2019">Configure the clock used for the media. + @@ -5786,7 +5940,7 @@ INADDR_ANY. a #GstRTSPMedia + line="2021">a #GstRTSPMedia allow-none="1"> #GstClock to be used + line="2022">#GstClock to be used @@ -5805,8 +5959,8 @@ INADDR_ANY. version="1.16"> Set whether retransmission requests will be sent - + line="1843">Set whether retransmission requests will be sent + @@ -5825,8 +5979,8 @@ INADDR_ANY. version="1.18"> Configure the dscp qos of attached streams to @dscp_qos. - + line="1681">Configure the dscp qos of attached streams to @dscp_qos. + @@ -5834,23 +5988,83 @@ INADDR_ANY. a #GstRTSPMedia + line="1683">a #GstRTSPMedia a new dscp qos value (0-63, or -1 to disable) + line="1684">a new dscp qos value (0-63, or -1 to disable) + + Set whether or not a keyunit should be ensured when a client connects. It +will also configure the streams to drop delta units to ensure that they start +on a keyunit. + +Note that this will only affect non-shared medias for now. + + + + + + + a #GstRTSPMedia + + + + the new value + + + + + + Sets the maximum allowed time before the first keyunit is considered +expired. + +Note that this will only have an effect when ensure-keyunit-on-start is +enabled. + + + + + + + a #GstRTSPMedia + + + + the new value + + + + Set or unset if an EOS event will be sent to the pipeline for @media before + line="1463">Set or unset if an EOS event will be sent to the pipeline for @media before it is unprepared. @@ -5860,13 +6074,13 @@ it is unprepared. a #GstRTSPMedia + line="1465">a #GstRTSPMedia the new value + line="1466">the new value @@ -5876,8 +6090,8 @@ it is unprepared. glib:set-property="latency"> Configure the latency used for receiving media. - + line="1913">Configure the latency used for receiving media. + @@ -5885,13 +6099,13 @@ it is unprepared. a #GstRTSPMedia + line="1915">a #GstRTSPMedia latency in milliseconds + line="1916">latency in milliseconds @@ -5902,25 +6116,25 @@ it is unprepared. version="1.16"> Set the maximum time-to-live value of outgoing multicast packets. - + line="2225">Set the maximum time-to-live value of outgoing multicast packets. + %TRUE if the requested ttl has been set successfully. + line="2232">%TRUE if the requested ttl has been set successfully. a #GstRTSPMedia + line="2227">a #GstRTSPMedia the new multicast ttl value + line="2228">the new multicast ttl value @@ -5929,7 +6143,7 @@ it is unprepared. c:identifier="gst_rtsp_media_set_multicast_iface"> configure @multicast_iface to be used for @media. + line="2165">configure @multicast_iface to be used for @media. @@ -5938,7 +6152,7 @@ it is unprepared. a #GstRTSPMedia + line="2167">a #GstRTSPMedia allow-none="1"> a multicast interface name + line="2168">a multicast interface name @@ -5956,7 +6170,7 @@ it is unprepared. c:identifier="gst_rtsp_media_set_permissions"> Set @permissions on @media. + line="1112">Set @permissions on @media. @@ -5965,7 +6179,7 @@ it is unprepared. a #GstRTSPMedia + line="1114">a #GstRTSPMedia allow-none="1"> a #GstRTSPPermissions + line="1115">a #GstRTSPPermissions @@ -5983,8 +6197,8 @@ it is unprepared. c:identifier="gst_rtsp_media_set_pipeline_state"> Set the state of the pipeline managed by @media to @state - + line="5178">Set the state of the pipeline managed by @media to @state + @@ -5992,13 +6206,13 @@ it is unprepared. a #GstRTSPMedia + line="5180">a #GstRTSPMedia the target state of the pipeline + line="5181">the target state of the pipeline @@ -6008,7 +6222,7 @@ it is unprepared. glib:set-property="profiles"> Configure the allowed lower transport for @media. + line="1362">Configure the allowed lower transport for @media. @@ -6017,13 +6231,13 @@ it is unprepared. a #GstRTSPMedia + line="1364">a #GstRTSPMedia the new flags + line="1365">the new flags @@ -6033,7 +6247,7 @@ it is unprepared. glib:set-property="protocols"> Configure the allowed lower transport for @media. + line="1415">Configure the allowed lower transport for @media. @@ -6042,13 +6256,13 @@ it is unprepared. a #GstRTSPMedia + line="1417">a #GstRTSPMedia the new flags + line="1418">the new flags @@ -6058,8 +6272,8 @@ it is unprepared. version="1.8"> Sets if and how the media clock should be published according to RFC7273. - + line="2052">Sets if and how the media clock should be published according to RFC7273. + @@ -6067,13 +6281,13 @@ it is unprepared. a #GstRTSPMedia + line="2054">a #GstRTSPMedia the clock publish mode + line="2055">the clock publish mode @@ -6084,9 +6298,9 @@ it is unprepared. version="1.18"> Define whether @media will follow the Rate-Control=no behaviour as specified + line="5526">Define whether @media will follow the Rate-Control=no behaviour as specified in the ONVIF replay spec. - + @@ -6103,8 +6317,8 @@ in the ONVIF replay spec. c:identifier="gst_rtsp_media_set_retransmission_time"> Set the amount of time to store retransmission packets. - + line="1789">Set the amount of time to store retransmission packets. + @@ -6112,13 +6326,13 @@ in the ONVIF replay spec. a #GstRTSPMedia + line="1791">a #GstRTSPMedia the new value + line="1792">the new value @@ -6128,7 +6342,7 @@ in the ONVIF replay spec. glib:set-property="reusable"> Set or unset if the pipeline for @media can be reused after the pipeline has + line="1309">Set or unset if the pipeline for @media can be reused after the pipeline has been unprepared. @@ -6138,13 +6352,13 @@ been unprepared. a #GstRTSPMedia + line="1311">a #GstRTSPMedia the new value + line="1312">the new value @@ -6154,7 +6368,7 @@ been unprepared. glib:set-property="shared"> Set or unset if the pipeline for @media can be shared will multiple clients. + line="1223">Set or unset if the pipeline for @media can be shared will multiple clients. When @shared is %TRUE, client requests for this media will share the media pipeline. @@ -6165,13 +6379,13 @@ pipeline. a #GstRTSPMedia + line="1225">a #GstRTSPMedia the new value + line="1226">the new value @@ -6179,33 +6393,33 @@ pipeline. Set the state of @media to @state and for the transports in @transports. + line="5195">Set the state of @media to @state and for the transports in @transports. @media must be prepared with gst_rtsp_media_prepare(); - + %TRUE on success. + line="5206">%TRUE on success. a #GstRTSPMedia + line="5197">a #GstRTSPMedia the target state of the media + line="5198">the target state of the media + line="5199"> a #GPtrArray of #GstRTSPStreamTransport pointers @@ -6218,7 +6432,7 @@ a #GPtrArray of #GstRTSPStreamTransport pointers glib:set-property="stop-on-disconnect"> Set or unset if the pipeline for @media should be stopped when a + line="1739">Set or unset if the pipeline for @media should be stopped when a client disconnects without sending TEARDOWN. @@ -6228,13 +6442,13 @@ client disconnects without sending TEARDOWN. a #GstRTSPMedia + line="1741">a #GstRTSPMedia the new value + line="1742">the new value @@ -6244,11 +6458,11 @@ client disconnects without sending TEARDOWN. glib:set-property="suspend-mode"> Control how @ media will be suspended after the SDP has been generated and + line="1163">Control how @ media will be suspended after the SDP has been generated and after a PAUSE request has been performed. Media must be unprepared when setting the suspend mode. - + @@ -6256,13 +6470,13 @@ Media must be unprepared when setting the suspend mode. a #GstRTSPMedia + line="1165">a #GstRTSPMedia the new #GstRTSPSuspendMode + line="1166">the new #GstRTSPSuspendMode @@ -6272,7 +6486,7 @@ Media must be unprepared when setting the suspend mode. glib:set-property="transport-mode"> Sets if the media pipeline can work in PLAY or RECORD mode + line="5338">Sets if the media pipeline can work in PLAY or RECORD mode @@ -6281,13 +6495,13 @@ Media must be unprepared when setting the suspend mode. a #GstRTSPMedia + line="5340">a #GstRTSPMedia the new value + line="5341">the new value @@ -6295,32 +6509,32 @@ Media must be unprepared when setting the suspend mode. Add @media specific info to @sdp. @info is used to configure the connection + line="4606">Add @media specific info to @sdp. @info is used to configure the connection information in the SDP. - + TRUE on success. + line="4615">TRUE on success. a #GstRTSPMedia + line="4608">a #GstRTSPMedia a #GstSDPMessage + line="4609">a #GstSDPMessage a #GstSDPInfo + line="4610">a #GstSDPInfo @@ -6328,23 +6542,23 @@ information in the SDP. Suspend @media. The state of the pipeline managed by @media is set to + line="4874">Suspend @media. The state of the pipeline managed by @media is set to GST_STATE_NULL but all streams are kept. @media can be prepared again with gst_rtsp_media_unsuspend() @media must be prepared with gst_rtsp_media_prepare(); - + %TRUE on success. + line="4884">%TRUE on success. a #GstRTSPMedia + line="4876">a #GstRTSPMedia @@ -6352,7 +6566,7 @@ with gst_rtsp_media_unsuspend() Set @pipeline as the #GstPipeline for @media. Ownership is + line="1069">Set @pipeline as the #GstPipeline for @media. Ownership is taken of @pipeline. @@ -6362,13 +6576,13 @@ taken of @pipeline. a #GstRTSPMedia + line="1071">a #GstRTSPMedia a #GstPipeline + line="1072">a #GstPipeline @@ -6378,8 +6592,8 @@ taken of @pipeline. version="1.18"> Unlock the media. - + line="4472">Unlock the media. + @@ -6387,7 +6601,7 @@ taken of @pipeline. a #GstRTSPMedia + line="4474">a #GstRTSPMedia @@ -6395,21 +6609,21 @@ taken of @pipeline. Unprepare @media. After this call, the media should be prepared again before + line="4364">Unprepare @media. After this call, the media should be prepared again before it can be used again. If the media is set to be non-reusable, a new instance must be created. - + %TRUE on success. + line="4372">%TRUE on success. a #GstRTSPMedia + line="4366">a #GstRTSPMedia @@ -6417,20 +6631,20 @@ must be created. Unsuspend @media if it was in a suspended state. This method does nothing + line="5098">Unsuspend @media if it was in a suspended state. This method does nothing when the media was not in the suspended state. - + %TRUE on success. + line="5105">%TRUE on success. a #GstRTSPMedia + line="5100">a #GstRTSPMedia @@ -6439,8 +6653,8 @@ when the media was not in the suspended state. c:identifier="gst_rtsp_media_use_time_provider"> Set @media to provide a #GstNetTimeProvider. - + line="1971">Set @media to provide a #GstNetTimeProvider. + @@ -6448,13 +6662,13 @@ when the media was not in the suspended state. a #GstRTSPMedia + line="1973">a #GstRTSPMedia if a #GstNetTimeProvider should be used + line="1974">if a #GstNetTimeProvider should be used @@ -6496,6 +6710,38 @@ when the media was not in the suspended state. getter="get_element"> + + Whether or not a keyunit should be ensured when a client connects. It +will also configure the streams to drop delta units to ensure that they start +on a keyunit. + +Note that this will only affect non-shared medias for now. + + + + The maximum allowed time before the first keyunit is considered +expired. + +Note that this will only have an effect when ensure-keyunit-on-start is +enabled. + + version="1.22"> Will be emitted when a message appears on the pipeline bus. + line="503">Will be emitted when a message appears on the pipeline bus. a #gboolean indicating if the call was successful or not. + line="510">a #gboolean indicating if the call was successful or not. a #GstMessage + line="506">a #GstMessage @@ -6674,6 +6920,9 @@ when the media was not in the suspended state. + handle a message @@ -6690,19 +6939,24 @@ when the media was not in the suspended state. + the default implementation adds all elements and sets the + pipeline's state to GST_STATE_PAUSED (or GST_STATE_PLAYING + in case of NO_PREROLL elements). %TRUE on success. + line="4142">%TRUE on success. a #GstRTSPMedia + line="4131">a #GstRTSPMedia allow-none="1"> a #GstRTSPThread to run the + line="4132">a #GstRTSPThread to run the bus handler or %NULL @@ -6719,63 +6973,80 @@ when the media was not in the suspended state. + the default implementation sets the pipeline's state + to GST_STATE_NULL and removes all elements. %TRUE on success. + line="4372">%TRUE on success. a #GstRTSPMedia + line="4366">a #GstRTSPMedia + the default implementation sets the pipeline's state to + GST_STATE_NULL GST_STATE_PAUSED depending on the selected + suspend mode. %TRUE on success. + line="4884">%TRUE on success. a #GstRTSPMedia + line="4876">a #GstRTSPMedia + the default implementation reverts the suspend operation. + The pipeline will be prerolled again if it's state was + set to GST_STATE_NULL in suspend. %TRUE on success. + line="5105">%TRUE on success. a #GstRTSPMedia + line="5100">a #GstRTSPMedia + convert a range to the given unit @@ -6795,6 +7066,9 @@ when the media was not in the suspended state. + query the current position in the pipeline @@ -6811,6 +7085,9 @@ when the media was not in the suspended state. + query when playback will stop @@ -6861,26 +7138,26 @@ when the media was not in the suspended state. TRUE on success. + line="4615">TRUE on success. a #GstRTSPMedia + line="4608">a #GstRTSPMedia a #GstSDPMessage + line="4609">a #GstSDPMessage a #GstSDPInfo + line="4610">a #GstSDPInfo @@ -6982,20 +7259,20 @@ when the media was not in the suspended state. TRUE on success. + line="4754">TRUE on success. a #GstRTSPMedia + line="4749">a #GstRTSPMedia a #GstSDPMessage + line="4750">a #GstSDPMessage @@ -7023,17 +7300,21 @@ can contain multiple streams like audio and video. Create a new #GstRTSPMediaFactory instance. + line="542">Create a new #GstRTSPMediaFactory instance. a new #GstRTSPMediaFactory object. + line="547">a new #GstRTSPMediaFactory object. + configure the media created with @construct. The default + implementation will configure the 'shared' property of the media. @@ -7051,7 +7332,7 @@ can contain multiple streams like audio and video. Construct the media object and create its streams. Implementations + line="1535">Construct the media object and create its streams. Implementations should create the needed gstreamer elements and add them to the result object. No state changes should be performed on them yet. @@ -7067,20 +7348,20 @@ The returned media will be locked and must be unlocked afterwards. a new #GstRTSPMedia if the media could be prepared. + line="1552">a new #GstRTSPMedia if the media could be prepared. a #GstRTSPMediaFactory + line="1537">a #GstRTSPMediaFactory the url used + line="1538">the url used @@ -7088,7 +7369,7 @@ The returned media will be locked and must be unlocked afterwards. Construct and return a #GstElement that is a #GstBin containing + line="2181">Construct and return a #GstElement that is a #GstBin containing the elements to use for streaming the media. The bin should contain payloaders pay\%d for each stream. The default @@ -7099,25 +7380,29 @@ launch parameter. a new #GstElement. + line="2193">a new #GstElement. a #GstRTSPMediaFactory + line="2183">a #GstRTSPMediaFactory the url used + line="2184">the url used + create a new pipeline or re-use an existing one and + add the #GstRTSPMedia's element created by @construct to the pipeline. @@ -7133,6 +7418,11 @@ launch parameter. + convert @url to a key for caching shared #GstRTSPMedia objects. + The default implementation of this function will use the complete URL + including the query parameters to return a key. @@ -7148,6 +7438,9 @@ launch parameter. + signal emitted when a media should be configured @@ -7163,6 +7456,9 @@ launch parameter. + signal emitted when a media was constructed @@ -7182,7 +7478,7 @@ launch parameter. introspectable="0"> A convenience method to add @role with @fieldname and additional arguments to + line="610">A convenience method to add @role with @fieldname and additional arguments to the permissions of @factory. If @factory had no permissions, new permissions will be created and the role will be added to it. a #GstRTSPMediaFactory + line="612">a #GstRTSPMediaFactory a role + line="613">a role the first field name + line="614">the first field name additional arguments + line="615">additional arguments @@ -7222,7 +7518,7 @@ will be created and the role will be added to it. version="1.14"> A convenience wrapper around gst_rtsp_permissions_add_role_from_structure(). + line="645">A convenience wrapper around gst_rtsp_permissions_add_role_from_structure(). If @factory had no permissions, new permissions will be created and the role will be added to it. Construct the media object and create its streams. Implementations + line="1535">Construct the media object and create its streams. Implementations should create the needed gstreamer elements and add them to the result object. No state changes should be performed on them yet. @@ -7254,24 +7550,24 @@ with gst_rtsp_media_prepare (). The returned media will be locked and must be unlocked afterwards. + line="286"/> a new #GstRTSPMedia if the media could be prepared. + line="1552">a new #GstRTSPMedia if the media could be prepared. a #GstRTSPMediaFactory + line="1537">a #GstRTSPMediaFactory the url used + line="1538">the url used @@ -7280,31 +7576,31 @@ The returned media will be locked and must be unlocked afterwards. c:identifier="gst_rtsp_media_factory_create_element"> Construct and return a #GstElement that is a #GstBin containing + line="2181">Construct and return a #GstElement that is a #GstBin containing the elements to use for streaming the media. The bin should contain payloaders pay\%d for each stream. The default implementation of this function returns the bin created from the launch parameter. + line="290"/> a new #GstElement. + line="2193">a new #GstElement. a #GstRTSPMediaFactory + line="2183">a #GstRTSPMediaFactory the url used + line="2184">the url used @@ -7313,13 +7609,13 @@ launch parameter. c:identifier="gst_rtsp_media_factory_get_address_pool"> Get the #GstRTSPAddressPool used as the address pool of @factory. + line="1113">Get the #GstRTSPAddressPool used as the address pool of @factory. the #GstRTSPAddressPool of @factory. g_object_unref() after + line="1119">the #GstRTSPAddressPool of @factory. g_object_unref() after usage. @@ -7327,7 +7623,7 @@ usage. a #GstRTSPMediaFactory + line="1115">a #GstRTSPMediaFactory @@ -7337,20 +7633,20 @@ usage. glib:get-property="buffer-size"> Get the kernel UDP buffer size. + line="898">Get the kernel UDP buffer size. the kernel UDP buffer size. + line="904">the kernel UDP buffer size. a #GstRTSPMedia + line="900">a #GstRTSPMedia @@ -7361,21 +7657,21 @@ usage. version="1.8"> Returns the clock that is going to be used by the pipelines + line="1724">Returns the clock that is going to be used by the pipelines of all medias created from this factory. + line="249"/> The GstClock + line="1731">The GstClock a #GstRTSPMediaFactory + line="1726">a #GstRTSPMediaFactory @@ -7384,11 +7680,11 @@ of all medias created from this factory. c:identifier="gst_rtsp_media_factory_get_do_retransmission" version="1.16"> + line="221"/> Whether retransmission requests will be sent for receiving media + line="1425">Whether retransmission requests will be sent for receiving media @@ -7403,20 +7699,68 @@ of all medias created from this factory. version="1.18"> Get the configured media DSCP QoS. + line="1057">Get the configured media DSCP QoS. + line="274"/> the media DSCP QoS value or -1 if disabled. + line="1063">the media DSCP QoS value or -1 if disabled. a #GstRTSPMediaFactory + line="1059">a #GstRTSPMediaFactory + + + + + + Get ensure-keyunit-on-start flag. + + + The ensure-keyunit-on-start flag. + + + + + a #GstRTSPMediaFactory + + + + + + Get ensure-keyunit-on-start-timeout time. + + + The ensure-keyunit-on-start-timeout time. + + + + + a #GstRTSPMediaFactory @@ -7426,20 +7770,20 @@ of all medias created from this factory. glib:get-property="latency"> Get the latency that is used for receiving media + line="1470">Get the latency that is used for receiving media + line="228"/> latency in milliseconds + line="1476">latency in milliseconds a #GstRTSPMediaFactory + line="1472">a #GstRTSPMediaFactory @@ -7449,14 +7793,14 @@ of all medias created from this factory. glib:get-property="launch"> Get the gst_parse_launch() pipeline description that will be used in the + line="705">Get the gst_parse_launch() pipeline description that will be used in the default prepare vmethod. the configured launch description. g_free() after + line="712">the configured launch description. g_free() after usage. @@ -7464,7 +7808,7 @@ usage. a #GstRTSPMediaFactory + line="707">a #GstRTSPMediaFactory @@ -7475,20 +7819,20 @@ usage. version="1.16"> Get the the maximum time-to-live value of outgoing multicast packets. + line="1829">Get the the maximum time-to-live value of outgoing multicast packets. + line="262"/> the maximum time-to-live value of outgoing multicast packets. + line="1835">the maximum time-to-live value of outgoing multicast packets. a #GstRTSPMedia + line="1831">a #GstRTSPMedia @@ -7498,10 +7842,10 @@ usage. version="1.6"> Return the GType of the GstRTSPMedia subclass this + line="1676">Return the GType of the GstRTSPMedia subclass this factory will create. + line="242"/> @@ -7509,7 +7853,7 @@ factory will create. a #GstRTSPMediaFactory + line="1678">a #GstRTSPMediaFactory @@ -7518,13 +7862,13 @@ factory will create. c:identifier="gst_rtsp_media_factory_get_multicast_iface"> Get the multicast interface used for @factory. + line="1171">Get the multicast interface used for @factory. the multicast interface for @factory. g_free() after + line="1177">the multicast interface for @factory. g_free() after usage. @@ -7532,7 +7876,7 @@ usage. a #GstRTSPMediaFactory + line="1173">a #GstRTSPMediaFactory @@ -7541,20 +7885,20 @@ usage. c:identifier="gst_rtsp_media_factory_get_permissions"> Get the permissions object from @factory. + line="584">Get the permissions object from @factory. a #GstRTSPPermissions object, unref after usage. + line="590">a #GstRTSPPermissions object, unref after usage. a #GstRTSPMediaFactory + line="586">a #GstRTSPMediaFactory @@ -7564,20 +7908,20 @@ usage. glib:get-property="profiles"> Get the allowed profiles of @factory. + line="1222">Get the allowed profiles of @factory. a #GstRTSPProfile + line="1228">a #GstRTSPProfile a #GstRTSPMediaFactory + line="1224">a #GstRTSPMediaFactory @@ -7587,20 +7931,20 @@ usage. glib:get-property="protocols"> Get the allowed protocols of @factory. + line="1272">Get the allowed protocols of @factory. a #GstRTSPLowerTrans + line="1278">a #GstRTSPLowerTrans a #GstRTSPMediaFactory + line="1274">a #GstRTSPMediaFactory @@ -7610,20 +7954,20 @@ usage. version="1.8"> Gets if and how the media clock should be published according to RFC7273. + line="1772">Gets if and how the media clock should be published according to RFC7273. + line="255"/> The GstRTSPPublishClockMode + line="1778">The GstRTSPPublishClockMode a #GstRTSPMediaFactory + line="1774">a #GstRTSPMediaFactory @@ -7632,20 +7976,20 @@ usage. c:identifier="gst_rtsp_media_factory_get_retransmission_time"> Get the time that is stored for retransmission purposes + line="1372">Get the time that is stored for retransmission purposes + line="214"/> a #GstClockTime + line="1378">a #GstClockTime a #GstRTSPMediaFactory + line="1374">a #GstRTSPMediaFactory @@ -7655,20 +7999,20 @@ usage. glib:get-property="suspend-mode"> Get how media created from this factory will be suspended. + line="754">Get how media created from this factory will be suspended. a #GstRTSPSuspendMode. + line="760">a #GstRTSPSuspendMode. a #GstRTSPMediaFactory + line="756">a #GstRTSPMediaFactory @@ -7678,21 +8022,21 @@ usage. glib:get-property="transport-mode"> Get if media created from this factory can be used for PLAY or RECORD + line="2237">Get if media created from this factory can be used for PLAY or RECORD methods. + line="235"/> The transport mode. + line="2244">The transport mode. a #GstRTSPMediaFactory + line="2239">a #GstRTSPMediaFactory @@ -7702,20 +8046,20 @@ methods. version="1.16"> Check if multicast sockets are configured to be bound to multicast addresses. + line="1881">Check if multicast sockets are configured to be bound to multicast addresses. + line="268"/> %TRUE if multicast sockets are configured to be bound to multicast addresses. + line="1887">%TRUE if multicast sockets are configured to be bound to multicast addresses. a #GstRTSPMediaFactory + line="1883">a #GstRTSPMediaFactory @@ -7725,20 +8069,20 @@ methods. version="1.20"> Check if created media will send and receive RTCP + line="1932">Check if created media will send and receive RTCP + line="281"/> %TRUE if created media will send and receive RTCP + line="1938">%TRUE if created media will send and receive RTCP a #GstRTSPMediaFactory + line="1934">a #GstRTSPMediaFactory @@ -7747,21 +8091,21 @@ methods. c:identifier="gst_rtsp_media_factory_is_eos_shutdown"> Get if media created from this factory will have an EOS event sent to the + line="850">Get if media created from this factory will have an EOS event sent to the pipeline before shutdown. %TRUE if the media will receive EOS before shutdown. + line="857">%TRUE if the media will receive EOS before shutdown. a #GstRTSPMediaFactory + line="852">a #GstRTSPMediaFactory @@ -7769,20 +8113,20 @@ pipeline before shutdown. Get if media created from this factory can be shared between clients. + line="802">Get if media created from this factory can be shared between clients. %TRUE if the media will be shared between clients. + line="808">%TRUE if the media will be shared between clients. a #GstRTSPMediaFactory + line="804">a #GstRTSPMediaFactory @@ -7804,7 +8148,7 @@ pipeline before shutdown. c:identifier="gst_rtsp_media_factory_set_address_pool"> configure @pool to be used as the address pool of @factory. + line="1084">configure @pool to be used as the address pool of @factory. @@ -7814,7 +8158,7 @@ pipeline before shutdown. a #GstRTSPMediaFactory + line="1086">a #GstRTSPMediaFactory allow-none="1"> a #GstRTSPAddressPool + line="1087">a #GstRTSPAddressPool @@ -7834,10 +8178,10 @@ pipeline before shutdown. version="1.16"> Decide whether the multicast socket should be bound to a multicast address or + line="1856">Decide whether the multicast socket should be bound to a multicast address or INADDR_ANY. + line="265"/> @@ -7845,13 +8189,13 @@ INADDR_ANY. a #GstRTSPMediaFactory + line="1858">a #GstRTSPMediaFactory the new value + line="1859">the new value @@ -7861,7 +8205,7 @@ INADDR_ANY. glib:set-property="buffer-size"> Set the kernel UDP buffer size. + line="876">Set the kernel UDP buffer size. @@ -7871,13 +8215,13 @@ INADDR_ANY. a #GstRTSPMedia + line="878">a #GstRTSPMedia the new value + line="879">the new value @@ -7888,10 +8232,10 @@ INADDR_ANY. version="1.8"> Configures a specific clock to be used by the pipelines + line="1699">Configures a specific clock to be used by the pipelines of all medias created from this factory. + line="245"/> @@ -7899,7 +8243,7 @@ of all medias created from this factory. a #GstRTSPMediaFactory + line="1701">a #GstRTSPMediaFactory allow-none="1"> the clock to be used by the media factory + line="1702">the clock to be used by the media factory @@ -7918,10 +8262,10 @@ of all medias created from this factory. version="1.16"> Set whether retransmission requests will be sent for + line="1397">Set whether retransmission requests will be sent for receiving media + line="217"/> @@ -7940,9 +8284,9 @@ receiving media version="1.18"> Configure the media dscp qos to @dscp_qos. + line="1028">Configure the media dscp qos to @dscp_qos. + line="271"/> @@ -7950,13 +8294,13 @@ receiving media a #GstRTSPMediaFactory + line="1030">a #GstRTSPMediaFactory a new dscp qos value (0-63, or -1 to disable) + line="1031">a new dscp qos value (0-63, or -1 to disable) @@ -7967,9 +8311,9 @@ receiving media version="1.20"> Decide whether the created media should send and receive RTCP + line="1908">Decide whether the created media should send and receive RTCP + line="277"/> @@ -7977,23 +8321,78 @@ receiving media a #GstRTSPMediaFactory + line="1910">a #GstRTSPMediaFactory the new value + line="1911">the new value + + If media from this factory should ensure a key unit when a client connects. + + + + + + + a #GstRTSPMediaFactory + + + + the new value + + + + + + Configures medias from this factory to consider keyunits older than timeout +to be expired. Expired keyunits will be discarded. + + + + + + + a #GstRTSPMediaFactory + + + + the new value + + + + Configure if media created from this factory will have an EOS sent to the + line="827">Configure if media created from this factory will have an EOS sent to the pipeline before shutdown. @@ -8004,13 +8403,13 @@ pipeline before shutdown. a #GstRTSPMediaFactory + line="829">a #GstRTSPMediaFactory the new value + line="830">the new value @@ -8020,9 +8419,9 @@ pipeline before shutdown. glib:set-property="latency"> Configure the latency used for receiving media + line="1446">Configure the latency used for receiving media + line="224"/> @@ -8030,13 +8429,13 @@ pipeline before shutdown. a #GstRTSPMediaFactory + line="1448">a #GstRTSPMediaFactory latency in milliseconds + line="1449">latency in milliseconds @@ -8046,7 +8445,7 @@ pipeline before shutdown. glib:set-property="launch"> The gst_parse_launch() line to use for constructing the pipeline in the + line="672">The gst_parse_launch() line to use for constructing the pipeline in the default prepare vmethod. The pipeline description should return a GstBin as the toplevel element @@ -8064,13 +8463,13 @@ etc.. Each of the payloaders will result in a stream. a #GstRTSPMediaFactory + line="674">a #GstRTSPMediaFactory the launch description + line="675">the launch description @@ -8081,26 +8480,26 @@ etc.. Each of the payloaders will result in a stream. version="1.16"> Set the maximum time-to-live value of outgoing multicast packets. + line="1796">Set the maximum time-to-live value of outgoing multicast packets. + line="258"/> %TRUE if the requested ttl has been set successfully. + line="1803">%TRUE if the requested ttl has been set successfully. a #GstRTSPMedia + line="1798">a #GstRTSPMedia the new multicast ttl value + line="1799">the new multicast ttl value @@ -8110,11 +8509,11 @@ etc.. Each of the payloaders will result in a stream. version="1.6"> Configure the GType of the GstRTSPMedia subclass to + line="1651">Configure the GType of the GstRTSPMedia subclass to create (by default, overridden construct vmethods may of course do something different) + line="238"/> @@ -8122,13 +8521,13 @@ may of course do something different) a #GstRTSPMediaFactory + line="1653">a #GstRTSPMediaFactory the GType of the class to create + line="1654">the GType of the class to create @@ -8137,7 +8536,7 @@ may of course do something different) c:identifier="gst_rtsp_media_factory_set_multicast_iface"> configure @multicast_iface to be used for @factory. + line="1140">configure @multicast_iface to be used for @factory. @@ -8147,7 +8546,7 @@ may of course do something different) a #GstRTSPMediaFactory + line="1142">a #GstRTSPMediaFactory allow-none="1"> a multicast interface name + line="1143">a multicast interface name @@ -8165,7 +8564,7 @@ may of course do something different) c:identifier="gst_rtsp_media_factory_set_permissions"> Set @permissions on @factory. + line="559">Set @permissions on @factory. @@ -8175,7 +8574,7 @@ may of course do something different) a #GstRTSPMediaFactory + line="561">a #GstRTSPMediaFactory allow-none="1"> a #GstRTSPPermissions + line="562">a #GstRTSPPermissions @@ -8194,7 +8593,7 @@ may of course do something different) glib:set-property="profiles"> Configure the allowed profiles for @factory. + line="1198">Configure the allowed profiles for @factory. @@ -8204,13 +8603,13 @@ may of course do something different) a #GstRTSPMediaFactory + line="1200">a #GstRTSPMediaFactory the new flags + line="1201">the new flags @@ -8220,7 +8619,7 @@ may of course do something different) glib:set-property="protocols"> Configure the allowed lower transport for @factory. + line="1248">Configure the allowed lower transport for @factory. @@ -8230,13 +8629,13 @@ may of course do something different) a #GstRTSPMediaFactory + line="1250">a #GstRTSPMediaFactory the new flags + line="1251">the new flags @@ -8246,9 +8645,9 @@ may of course do something different) version="1.8"> Sets if and how the media clock should be published according to RFC7273. + line="1751">Sets if and how the media clock should be published according to RFC7273. + line="252"/> @@ -8256,13 +8655,13 @@ may of course do something different) a #GstRTSPMediaFactory + line="1753">a #GstRTSPMediaFactory the clock publish mode + line="1754">the clock publish mode @@ -8272,9 +8671,9 @@ may of course do something different) c:identifier="gst_rtsp_media_factory_set_retransmission_time"> Configure the time to store for possible retransmission + line="1348">Configure the time to store for possible retransmission + line="210"/> @@ -8282,13 +8681,13 @@ may of course do something different) a #GstRTSPMediaFactory + line="1350">a #GstRTSPMediaFactory a #GstClockTime + line="1351">a #GstClockTime @@ -8298,7 +8697,7 @@ may of course do something different) glib:set-property="shared"> Configure if media created from this factory can be shared between clients. + line="780">Configure if media created from this factory can be shared between clients. @@ -8308,13 +8707,13 @@ may of course do something different) a #GstRTSPMediaFactory + line="782">a #GstRTSPMediaFactory the new value + line="783">the new value @@ -8324,7 +8723,7 @@ may of course do something different) glib:set-property="stop-on-disconnect"> Configure if media created from this factory should be stopped + line="1298">Configure if media created from this factory should be stopped when a client disconnects without sending TEARDOWN. @@ -8335,13 +8734,13 @@ when a client disconnects without sending TEARDOWN. a #GstRTSPMediaFactory + line="1300">a #GstRTSPMediaFactory the new value + line="1301">the new value @@ -8351,7 +8750,7 @@ when a client disconnects without sending TEARDOWN. glib:set-property="suspend-mode"> Configure how media created from this factory will be suspended. + line="732">Configure how media created from this factory will be suspended. @@ -8361,13 +8760,13 @@ when a client disconnects without sending TEARDOWN. a #GstRTSPMediaFactory + line="734">a #GstRTSPMediaFactory the new #GstRTSPSuspendMode + line="735">the new #GstRTSPSuspendMode @@ -8377,9 +8776,9 @@ when a client disconnects without sending TEARDOWN. glib:set-property="transport-mode"> Configure if this factory creates media for PLAY or RECORD modes. + line="2215">Configure if this factory creates media for PLAY or RECORD modes. + line="231"/> @@ -8387,13 +8786,13 @@ when a client disconnects without sending TEARDOWN. a #GstRTSPMediaFactory + line="2217">a #GstRTSPMediaFactory the new value + line="2218">the new value @@ -8436,9 +8835,44 @@ when a client disconnects without sending TEARDOWN. default-value="TRUE"> Whether the created media should send and receive RTCP + line="302">Whether the created media should send and receive RTCP + + + + If media from this factory should ensure a key unit when a client connects. + +This property will ensure that the stream always starts on a key unit +instead of a delta unit which the client would not be able to decode. + +Note that this will only affect non-shared medias for now. + + Timeout in milliseconds used to determine if a keyunit should be discarded +when a client connects. + +If the timeout has been reached a new keyframe will be forced, otherwise +the currently blocking keyframe will be used. + +This options is only relevant when ensure-keyunit-on-start is enabled. + + + convert @url to a key for caching shared #GstRTSPMedia objects. + The default implementation of this function will use the complete URL + including the query parameters to return a key. @@ -8578,58 +9017,74 @@ when a client disconnects without sending TEARDOWN. + Construct and return a #GstElement that is a #GstBin containing + the elements to use for streaming the media. The bin should contain + payloaders pay\%d for each stream. The default implementation of this + function returns the bin created from the launch parameter. a new #GstElement. + line="2193">a new #GstElement. a #GstRTSPMediaFactory + line="2183">a #GstRTSPMediaFactory the url used + line="2184">the url used + the vmethod that will be called when the factory has to create the + #GstRTSPMedia for @url. The default implementation of this + function calls create_element to retrieve an element and then looks for + pay\%d to create the streams. a new #GstRTSPMedia if the media could be prepared. + line="1552">a new #GstRTSPMedia if the media could be prepared. a #GstRTSPMediaFactory + line="1537">a #GstRTSPMediaFactory the url used + line="1538">the url used + create a new pipeline or re-use an existing one and + add the #GstRTSPMedia's element created by @construct to the pipeline. @@ -8647,6 +9102,10 @@ when a client disconnects without sending TEARDOWN. + configure the media created with @construct. The default + implementation will configure the 'shared' property of the media. @@ -8664,6 +9123,9 @@ when a client disconnects without sending TEARDOWN. + signal emitted when a media was constructed @@ -8681,6 +9143,9 @@ when a client disconnects without sending TEARDOWN. + signal emitted when a media should be configured @@ -9149,6 +9614,9 @@ g_object_unref() after usage. + make a path from the given url. @@ -9365,13 +9833,13 @@ bits per second. version="1.14"> Create a new #GstRTSPOnvifMediaFactory + line="536">Create a new #GstRTSPOnvifMediaFactory A new #GstRTSPOnvifMediaFactory + line="541">A new #GstRTSPOnvifMediaFactory @@ -9406,20 +9874,20 @@ bits per second. version="1.14"> Returns %TRUE if an ONVIF backchannel is supported by the media factory. + line="427">Returns %TRUE if an ONVIF backchannel is supported by the media factory. %TRUE if an ONVIF backchannel is supported by the media factory. + line="433">%TRUE if an ONVIF backchannel is supported by the media factory. a #GstRTSPMediaFactory + line="429">a #GstRTSPMediaFactory @@ -9430,21 +9898,21 @@ bits per second. version="1.14"> Get the configured/supported bandwidth of the ONVIF backchannel pipeline in + line="510">Get the configured/supported bandwidth of the ONVIF backchannel pipeline in bits per second. the configured/supported backchannel bandwidth. + line="517">the configured/supported backchannel bandwidth. a #GstRTSPMediaFactory + line="512">a #GstRTSPMediaFactory @@ -9455,14 +9923,14 @@ bits per second. version="1.14"> Get the gst_parse_launch() pipeline description that will be used in the + line="400">Get the gst_parse_launch() pipeline description that will be used in the default prepare vmethod for generating the ONVIF backchannel pipeline. the configured backchannel launch description. g_free() after + line="407">the configured backchannel launch description. g_free() after usage. @@ -9470,7 +9938,7 @@ usage. a #GstRTSPMediaFactory + line="402">a #GstRTSPMediaFactory @@ -9481,20 +9949,20 @@ usage. version="1.14"> Returns %TRUE if an ONVIF backchannel is supported by the media factory. + line="427">Returns %TRUE if an ONVIF backchannel is supported by the media factory. %TRUE if an ONVIF backchannel is supported by the media factory. + line="433">%TRUE if an ONVIF backchannel is supported by the media factory. a #GstRTSPMediaFactory + line="429">a #GstRTSPMediaFactory @@ -9508,7 +9976,7 @@ usage. %TRUE if ONVIF replay is supported by the media factory. + line="456">%TRUE if ONVIF replay is supported by the media factory. @@ -9523,7 +9991,7 @@ usage. version="1.14"> Set the configured/supported bandwidth of the ONVIF backchannel pipeline in + line="489">Set the configured/supported bandwidth of the ONVIF backchannel pipeline in bits per second. @@ -9534,14 +10002,14 @@ bits per second. a #GstRTSPMediaFactory + line="491">a #GstRTSPMediaFactory the bandwidth in bits per second + line="492">the bandwidth in bits per second @@ -9551,7 +10019,7 @@ bits per second. version="1.14"> The gst_parse_launch() line to use for constructing the ONVIF backchannel + line="364">The gst_parse_launch() line to use for constructing the ONVIF backchannel pipeline in the default prepare vmethod if requested by the client. The pipeline description should return a GstBin as the toplevel element @@ -9576,7 +10044,7 @@ prepare. a #GstRTSPMediaFactory + line="366">a #GstRTSPMediaFactory @@ -9586,7 +10054,7 @@ prepare. allow-none="1"> the launch description + line="367">the launch description @@ -9596,7 +10064,7 @@ prepare. version="1.18"> Set to %TRUE if ONVIF replay is supported by the media factory. + line="473">Set to %TRUE if ONVIF replay is supported by the media factory. @@ -9640,14 +10108,14 @@ prepare. %TRUE if an ONVIF backchannel is supported by the media factory. + line="433">%TRUE if an ONVIF backchannel is supported by the media factory. a #GstRTSPMediaFactory + line="429">a #GstRTSPMediaFactory @@ -10179,6 +10647,9 @@ new connection on @socket or @server. + emitted when a new client connected. @@ -10194,6 +10665,12 @@ new connection on @socket or @server. + Create, configure a new GstRTSPClient + object that handles the new connection on @socket. The default + implementation will create a GstRTSPClient and will configure the + mount-points, auth, session-pool and thread-pool on the client. @@ -10958,6 +11435,12 @@ that the HTTP server read from the socket while parsing the HTTP header. + Create, configure a new GstRTSPClient + object that handles the new connection on @socket. The default + implementation will create a GstRTSPClient and will configure the + mount-points, auth, session-pool and thread-pool on the client. @@ -10972,6 +11455,9 @@ that the HTTP server read from the socket while parsing the HTTP header. + emitted when a new client connected. @@ -12037,6 +12523,9 @@ usage. + make a new session object. @@ -12052,6 +12541,10 @@ usage. + create a new random session id. Subclasses can create + custom session ids and should not check if the session exists. @@ -12064,6 +12557,9 @@ usage. + a session was removed from the pool @@ -12372,6 +12868,10 @@ A value of 0 means an unlimited amount of sessions. + create a new random session id. Subclasses can create + custom session ids and should not check if the session exists. @@ -12386,6 +12886,9 @@ A value of 0 means an unlimited amount of sessions. + make a new session object. @@ -12403,6 +12906,9 @@ A value of 0 means an unlimited amount of sessions. + a session was removed from the pool @@ -12534,33 +13040,33 @@ more sessions timed out. Create a new media stream with index @idx that handles RTP data on + line="511">Create a new media stream with index @idx that handles RTP data on @pad and has a payloader element @payloader if @pad is a source pad or a depayloader element @payloader if @pad is a sink pad. a new #GstRTSPStream + line="521">a new #GstRTSPStream an index + line="513">an index a #GstElement + line="515">a #GstElement a #GstPad + line="514">a #GstPad @@ -12570,45 +13076,45 @@ or a depayloader element @payloader if @pad is a sink pad. version="1.16"> Add multicast client address to stream. At this point, the sockets that + line="5098">Add multicast client address to stream. At this point, the sockets that will stream RTP and RTCP data to @destination are supposed to be allocated. %TRUE if @destination can be addedd and handled by @stream. + line="5110">%TRUE if @destination can be addedd and handled by @stream. a #GstRTSPStream + line="5100">a #GstRTSPStream a multicast address to add + line="5101">a multicast address to add RTP port + line="5102">RTP port RTCP port + line="5103">RTCP port socket family + line="5104">socket family @@ -12617,7 +13123,7 @@ allocated. c:identifier="gst_rtsp_stream_add_transport"> Add the transport in @trans to @stream. The media of @stream will + line="4850">Add the transport in @trans to @stream. The media of @stream will then also be send to the values configured in @trans. Adding the same transport twice will not add it a second time. @@ -12628,20 +13134,20 @@ same transport twice will not add it a second time. %TRUE if @trans was added + line="4863">%TRUE if @trans was added a #GstRTSPStream + line="4852">a #GstRTSPStream a #GstRTSPStreamTransport + line="4853">a #GstRTSPStreamTransport @@ -12650,37 +13156,37 @@ same transport twice will not add it a second time. c:identifier="gst_rtsp_stream_allocate_udp_sockets"> Allocates RTP and RTCP ports. + line="1825">Allocates RTP and RTCP ports. %TRUE if the RTP and RTCP sockets have been succeccully allocated. + line="1834">%TRUE if the RTP and RTCP sockets have been succeccully allocated. a #GstRTSPStream + line="1827">a #GstRTSPStream protocol family + line="1828">protocol family transport method + line="1829">transport method Whether to use client settings or not + line="1830">Whether to use client settings or not @@ -12690,26 +13196,26 @@ same transport twice will not add it a second time. version="1.14"> Add a receiver and sender part to the pipeline based on the transport from + line="5904">Add a receiver and sender part to the pipeline based on the transport from SETUP. %TRUE if the stream has been successfully updated. + line="5912">%TRUE if the stream has been successfully updated. a #GstRTSPStream + line="5906">a #GstRTSPStream a #GstRTSPTransport + line="5907">a #GstRTSPTransport @@ -12719,12 +13225,12 @@ SETUP. c:identifier="gst_rtsp_stream_get_address_pool"> Get the #GstRTSPAddressPool used as the address pool of @stream. + line="989">Get the #GstRTSPAddressPool used as the address pool of @stream. the #GstRTSPAddressPool of @stream. + line="995">the #GstRTSPAddressPool of @stream. g_object_unref() after usage. @@ -12732,7 +13238,7 @@ g_object_unref() after usage. a #GstRTSPStream + line="991">a #GstRTSPStream @@ -12742,19 +13248,19 @@ g_object_unref() after usage. version="1.6"> Get the size of the UDP transmission buffer (in bytes) + line="2186">Get the size of the UDP transmission buffer (in bytes) the size of the UDP TX buffer + line="2192">the size of the UDP TX buffer a #GstRTSPStream + line="2188">a #GstRTSPStream @@ -12762,12 +13268,12 @@ g_object_unref() after usage. Retrieve the current caps of @stream. + line="4538">Retrieve the current caps of @stream. the #GstCaps of @stream. + line="4544">the #GstCaps of @stream. use gst_caps_unref() after usage. @@ -12775,7 +13281,7 @@ use gst_caps_unref() after usage. a #GstRTSPStream + line="4540">a #GstRTSPStream @@ -12785,19 +13291,19 @@ use gst_caps_unref() after usage. glib:get-property="control"> Get the control string to identify this stream. + line="621">Get the control string to identify this stream. the control string. g_free() after usage. + line="627">the control string. g_free() after usage. a #GstRTSPStream + line="623">a #GstRTSPStream @@ -12817,19 +13323,19 @@ use gst_caps_unref() after usage. Get the configured DSCP QoS in of the outgoing sockets. + line="789">Get the configured DSCP QoS in of the outgoing sockets. the DSCP QoS value of the outgoing sockets, or -1 if disbled. + line="795">the DSCP QoS value of the outgoing sockets, or -1 if disbled. a #GstRTSPStream + line="791">a #GstRTSPStream @@ -12837,19 +13343,19 @@ use gst_caps_unref() after usage. Get the stream index. + line="544">Get the stream index. the stream index. + line="550">the stream index. a #GstRTSPStream + line="546">a #GstRTSPStream @@ -12858,19 +13364,19 @@ use gst_caps_unref() after usage. c:identifier="gst_rtsp_stream_get_joined_bin"> Get the previous joined bin with gst_rtsp_stream_join_bin() or NULL. + line="4268">Get the previous joined bin with gst_rtsp_stream_join_bin() or NULL. the joined bin or NULL. + line="4274">the joined bin or NULL. a #GstRTSPStream + line="4270">a #GstRTSPStream @@ -12880,19 +13386,19 @@ use gst_caps_unref() after usage. version="1.16"> Get the the maximum time-to-live value of outgoing multicast packets. + line="2236">Get the the maximum time-to-live value of outgoing multicast packets. the maximum time-to-live value of outgoing multicast packets. + line="2242">the maximum time-to-live value of outgoing multicast packets. a #GstRTSPStream + line="2238">a #GstRTSPStream @@ -12900,19 +13406,19 @@ use gst_caps_unref() after usage. Get the configured MTU in the payloader of @stream. + line="725">Get the configured MTU in the payloader of @stream. the MTU of the payloader. + line="731">the MTU of the payloader. a #GstRTSPStream + line="727">a #GstRTSPStream @@ -12921,14 +13427,14 @@ use gst_caps_unref() after usage. c:identifier="gst_rtsp_stream_get_multicast_address"> Get the multicast address of @stream for @family. The original + line="1075">Get the multicast address of @stream for @family. The original #GstRTSPAddress is cached and copy is returned, so freeing the return value won't release the address from the pool. the #GstRTSPAddress of @stream + line="1084">the #GstRTSPAddress of @stream or %NULL when no address could be allocated. gst_rtsp_address_free() after usage. @@ -12937,13 +13443,13 @@ after usage. a #GstRTSPStream + line="1077">a #GstRTSPStream the #GSocketFamily + line="1078">the #GSocketFamily @@ -12953,19 +13459,19 @@ after usage. version="1.16"> Get all multicast client addresses that RTP data will be sent to + line="5154">Get all multicast client addresses that RTP data will be sent to A comma separated list of host:port pairs with destinations + line="5160">A comma separated list of host:port pairs with destinations a #GstRTSPStream + line="5156">a #GstRTSPStream @@ -12974,12 +13480,12 @@ after usage. c:identifier="gst_rtsp_stream_get_multicast_iface"> Get the multicast interface used for @stream. + line="1048">Get the multicast interface used for @stream. the multicast interface for @stream. + line="1054">the multicast interface for @stream. g_free() after usage. @@ -12987,7 +13493,7 @@ g_free() after usage. a #GstRTSPStream + line="1050">a #GstRTSPStream @@ -12997,19 +13503,19 @@ g_free() after usage. glib:get-property="profiles"> Get the allowed profiles of @stream. + line="885">Get the allowed profiles of @stream. a #GstRTSPProfile + line="891">a #GstRTSPProfile a #GstRTSPStream + line="887">a #GstRTSPStream @@ -13019,19 +13525,19 @@ g_free() after usage. glib:get-property="protocols"> Get the allowed protocols of @stream. + line="932">Get the allowed protocols of @stream. a #GstRTSPLowerTrans + line="938">a #GstRTSPLowerTrans a #GstRTSPStream + line="934">a #GstRTSPStream @@ -13039,19 +13545,19 @@ g_free() after usage. Get the stream payload type. + line="560">Get the stream payload type. the stream payload type. + line="566">the stream payload type. a #GstRTSPStream + line="562">a #GstRTSPStream @@ -13061,19 +13567,19 @@ g_free() after usage. version="1.8"> Gets if and how the stream clock should be published according to RFC7273. + line="3156">Gets if and how the stream clock should be published according to RFC7273. The GstRTSPPublishClockMode + line="3162">The GstRTSPPublishClockMode a #GstRTSPStream + line="3158">a #GstRTSPStream @@ -13085,7 +13591,7 @@ g_free() after usage. whether @stream will follow the Rate-Control=no behaviour as specified + line="6486">whether @stream will follow the Rate-Control=no behaviour as specified in the ONVIF replay spec. @@ -13100,19 +13606,19 @@ in the ONVIF replay spec. version="1.18"> Retrieve the current rate and/or applied_rate. + line="4474">Retrieve the current rate and/or applied_rate. %TRUE if rate and/or applied_rate could be determined. + line="4482">%TRUE if rate and/or applied_rate could be determined. a #GstRTSPStream + line="4476">a #GstRTSPStream allow-none="1"> the configured rate + line="4477">the configured rate allow-none="1"> the configured applied_rate + line="4478">the configured applied_rate @@ -13143,19 +13649,19 @@ in the ONVIF replay spec. c:identifier="gst_rtsp_stream_get_retransmission_pt"> Get the payload-type used for retransmission of this stream + line="2146">Get the payload-type used for retransmission of this stream The retransmission PT. + line="2152">The retransmission PT. a #GstRTSPStream + line="2148">a #GstRTSPStream @@ -13164,19 +13670,19 @@ in the ONVIF replay spec. c:identifier="gst_rtsp_stream_get_retransmission_time"> Get the amount of time to store retransmission data. + line="2096">Get the amount of time to store retransmission data. the amount of time to store retransmission data. + line="2102">the amount of time to store retransmission data. a #GstRTSPStream + line="2098">a #GstRTSPStream @@ -13186,12 +13692,12 @@ in the ONVIF replay spec. version="1.14"> Get the multicast RTCP socket from @stream for a @family. + line="5062">Get the multicast RTCP socket from @stream for a @family. the multicast RTCP socket or %NULL if no + line="5069">the multicast RTCP socket or %NULL if no socket could be allocated for @family. Unref after usage @@ -13199,13 +13705,13 @@ socket could be allocated for @family. Unref after usage a #GstRTSPStream + line="5064">a #GstRTSPStream the socket family + line="5065">the socket family @@ -13214,14 +13720,14 @@ socket could be allocated for @family. Unref after usage c:identifier="gst_rtsp_stream_get_rtcp_socket"> Get the RTCP socket from @stream for a @family. + line="4992">Get the RTCP socket from @stream for a @family. @stream must be joined to a bin. the RTCP socket or %NULL if no + line="5001">the RTCP socket or %NULL if no socket could be allocated for @family. Unref after usage @@ -13229,13 +13735,13 @@ socket could be allocated for @family. Unref after usage a #GstRTSPStream + line="4994">a #GstRTSPStream the socket family + line="4995">the socket family @@ -13244,12 +13750,12 @@ socket could be allocated for @family. Unref after usage c:identifier="gst_rtsp_stream_get_rtp_multicast_socket"> Get the multicast RTP socket from @stream for a @family. + line="5027">Get the multicast RTP socket from @stream for a @family. the multicast RTP socket or %NULL if no + line="5034">the multicast RTP socket or %NULL if no socket could be allocated for @family. Unref after usage @@ -13258,13 +13764,13 @@ socket could be allocated for @family. Unref after usage a #GstRTSPStream + line="5029">a #GstRTSPStream the socket family + line="5030">the socket family @@ -13273,14 +13779,14 @@ socket could be allocated for @family. Unref after usage c:identifier="gst_rtsp_stream_get_rtp_socket"> Get the RTP socket from @stream for a @family. + line="4957">Get the RTP socket from @stream for a @family. @stream must be joined to a bin. the RTP socket or %NULL if no + line="4966">the RTP socket or %NULL if no socket could be allocated for @family. Unref after usage @@ -13288,13 +13794,13 @@ socket could be allocated for @family. Unref after usage a #GstRTSPStream + line="4959">a #GstRTSPStream the socket family + line="4960">the socket family @@ -13302,20 +13808,20 @@ socket could be allocated for @family. Unref after usage Retrieve the current rtptime, seq and running-time. This is used to + line="4293">Retrieve the current rtptime, seq and running-time. This is used to construct a RTPInfo reply header. %TRUE when rtptime, seq and running-time could be determined. + line="4304">%TRUE when rtptime, seq and running-time could be determined. a #GstRTSPStream + line="4295">a #GstRTSPStream allow-none="1"> result RTP timestamp + line="4296">result RTP timestamp allow-none="1"> result RTP seqnum + line="4297">result RTP seqnum allow-none="1"> the clock rate + line="4298">the clock rate transfer-ownership="none"> result running-time + line="4299">result running-time @@ -13366,19 +13872,19 @@ construct a RTPInfo reply header. c:identifier="gst_rtsp_stream_get_rtpsession"> Get the RTP session of this stream. + line="2000">Get the RTP session of this stream. The RTP session of this stream. Unref after usage. + line="2006">The RTP session of this stream. Unref after usage. a #GstRTSPStream + line="2002">a #GstRTSPStream @@ -13387,7 +13893,7 @@ construct a RTPInfo reply header. c:identifier="gst_rtsp_stream_get_server_port"> Fill @server_port with the port pair used by the server. This function can + line="1955">Fill @server_port with the port pair used by the server. This function can only be called when @stream has been joined. @@ -13397,7 +13903,7 @@ only be called when @stream has been joined. a #GstRTSPStream + line="1957">a #GstRTSPStream transfer-ownership="none"> result server port + line="1958">result server port the port family to get + line="1959">the port family to get @@ -13420,19 +13926,19 @@ only be called when @stream has been joined. Get the sinkpad associated with @stream. + line="602">Get the sinkpad associated with @stream. the sinkpad. Unref after usage. + line="608">the sinkpad. Unref after usage. a #GstRTSPStream + line="604">a #GstRTSPStream @@ -13440,19 +13946,19 @@ only be called when @stream has been joined. Get the srcpad associated with @stream. + line="583">Get the srcpad associated with @stream. the srcpad. Unref after usage. + line="589">the srcpad. Unref after usage. a #GstRTSPStream + line="585">a #GstRTSPStream @@ -13461,19 +13967,19 @@ only be called when @stream has been joined. c:identifier="gst_rtsp_stream_get_srtp_encoder"> Get the SRTP encoder for this stream. + line="2026">Get the SRTP encoder for this stream. The SRTP encoder for this stream. Unref after usage. + line="2032">The SRTP encoder for this stream. Unref after usage. a #GstRTSPStream + line="2028">a #GstRTSPStream @@ -13481,7 +13987,7 @@ only be called when @stream has been joined. Get the SSRC used by the RTP session of this stream. This function can only + line="2052">Get the SSRC used by the RTP session of this stream. This function can only be called when @stream has been joined. @@ -13491,7 +13997,7 @@ be called when @stream has been joined. a #GstRTSPStream + line="2054">a #GstRTSPStream transfer-ownership="full"> result ssrc + line="2055">result ssrc @@ -13524,7 +14030,7 @@ be called when @stream has been joined. the amount of redundancy applied when creating ULPFEC + line="6436">the amount of redundancy applied when creating ULPFEC protection packets. @@ -13541,7 +14047,7 @@ protection packets. the payload type used for ULPFEC protection packets + line="6321">the payload type used for ULPFEC protection packets @@ -13555,7 +14061,7 @@ protection packets. version="1.16"> Parse and handle a KeyMgmt header. + line="6269">Parse and handle a KeyMgmt header. @@ -13564,13 +14070,13 @@ protection packets. a #GstRTSPStream + line="6271">a #GstRTSPStream a keymgmt header + line="6272">a keymgmt header @@ -13578,19 +14084,19 @@ protection packets. Check if @stream has the control string @control. + line="669">Check if @stream has the control string @control. %TRUE is @stream has @control as the control string + line="676">%TRUE is @stream has @control as the control string a #GstRTSPStream + line="671">a #GstRTSPStream allow-none="1"> a control string + line="672">a control string @@ -13609,19 +14115,19 @@ protection packets. version="1.16"> Check if multicast sockets are configured to be bound to multicast addresses. + line="2303">Check if multicast sockets are configured to be bound to multicast addresses. %TRUE if multicast sockets are configured to be bound to multicast addresses. + line="2309">%TRUE if multicast sockets are configured to be bound to multicast addresses. a #GstRTSPStream + line="2305">a #GstRTSPStream @@ -13629,19 +14135,19 @@ protection packets. Check if @stream is blocking on a #GstBuffer. + line="5646">Check if @stream is blocking on a #GstBuffer. %TRUE if @stream is blocking + line="5652">%TRUE if @stream is blocking a #GstRTSPStream + line="5648">a #GstRTSPStream @@ -13650,19 +14156,19 @@ protection packets. c:identifier="gst_rtsp_stream_is_client_side"> See gst_rtsp_stream_set_client_side() + line="1931">See gst_rtsp_stream_set_client_side() TRUE if this #GstRTSPStream is client-side. + line="1937">TRUE if this #GstRTSPStream is client-side. a #GstRTSPStream + line="1933">a #GstRTSPStream @@ -13672,21 +14178,21 @@ protection packets. version="1.14"> Checks whether the stream is complete, contains the receiver and the sender + line="5956">Checks whether the stream is complete, contains the receiver and the sender parts. As the stream contains sink(s) element(s), it's possible to perform seek operations on it. %TRUE if the stream contains at least one sink element. + line="5964">%TRUE if the stream contains at least one sink element. a #GstRTSPStream + line="5958">a #GstRTSPStream @@ -13696,19 +14202,19 @@ seek operations on it. version="1.14"> Checks whether the stream is a receiver. + line="6010">Checks whether the stream is a receiver. %TRUE if the stream is a receiver and %FALSE otherwise. + line="6016">%TRUE if the stream is a receiver and %FALSE otherwise. a #GstRTSPStream + line="6012">a #GstRTSPStream @@ -13718,19 +14224,19 @@ seek operations on it. version="1.14"> Checks whether the stream is a sender. + line="5984">Checks whether the stream is a sender. %TRUE if the stream is a sender and %FALSE otherwise. + line="5990">%TRUE if the stream is a sender and %FALSE otherwise. a #GstRTSPStream + line="5986">a #GstRTSPStream @@ -13739,25 +14245,25 @@ seek operations on it. c:identifier="gst_rtsp_stream_is_transport_supported"> Check if @transport can be handled by stream + line="809">Check if @transport can be handled by stream %TRUE if @transport can be handled by @stream. + line="816">%TRUE if @transport can be handled by @stream. a #GstRTSPStream + line="811">a #GstRTSPStream a #GstRTSPTransport + line="812">a #GstRTSPTransport @@ -13765,7 +14271,7 @@ seek operations on it. Join the #GstBin @bin that contains the element @rtpbin. + line="3944">Join the #GstBin @bin that contains the element @rtpbin. @stream will link to @rtpbin, which must be inside @bin. The elements added to @bin will be set to the state given in @state. @@ -13773,32 +14279,32 @@ added to @bin will be set to the state given in @state. %TRUE on success. + line="3956">%TRUE on success. a #GstRTSPStream + line="3946">a #GstRTSPStream a #GstBin to join + line="3947">a #GstBin to join a rtpbin element in @bin + line="3948">a rtpbin element in @bin the target state of the new elements + line="3949">the target state of the new elements @@ -13806,31 +14312,31 @@ added to @bin will be set to the state given in @state. Remove the elements of @stream from @bin. + line="4106">Remove the elements of @stream from @bin. %TRUE on success. + line="4114">%TRUE on success. a #GstRTSPStream + line="4108">a #GstRTSPStream a #GstBin + line="4109">a #GstBin a rtpbin #GstElement + line="4110">a rtpbin #GstElement @@ -13839,20 +14345,20 @@ added to @bin will be set to the state given in @state. c:identifier="gst_rtsp_stream_query_position"> Query the position of the stream in %GST_FORMAT_TIME. This only considers + line="5671">Query the position of the stream in %GST_FORMAT_TIME. This only considers the RTP parts of the pipeline and not the RTCP parts. %TRUE if the position could be queried + line="5679">%TRUE if the position could be queried a #GstRTSPStream + line="5673">a #GstRTSPStream transfer-ownership="full"> current position of a #GstRTSPStream + line="5674">current position of a #GstRTSPStream @@ -13869,20 +14375,20 @@ the RTP parts of the pipeline and not the RTCP parts. Query the stop of the stream in %GST_FORMAT_TIME. This only considers + line="5758">Query the stop of the stream in %GST_FORMAT_TIME. This only considers the RTP parts of the pipeline and not the RTCP parts. %TRUE if the stop could be queried + line="5766">%TRUE if the stop could be queried a #GstRTSPStream + line="5760">a #GstRTSPStream transfer-ownership="full"> current stop of a #GstRTSPStream + line="5761">current stop of a #GstRTSPStream @@ -13899,7 +14405,7 @@ the RTP parts of the pipeline and not the RTCP parts. Handle an RTCP buffer for the stream. This method is usually called when a + line="4630">Handle an RTCP buffer for the stream. This method is usually called when a message has been received from a client using the TCP transport. This function takes ownership of @buffer. @@ -13907,20 +14413,20 @@ This function takes ownership of @buffer. a GstFlowReturn. + line="4640">a GstFlowReturn. a #GstRTSPStream + line="4632">a #GstRTSPStream a #GstBuffer + line="4633">a #GstBuffer @@ -13928,7 +14434,7 @@ This function takes ownership of @buffer. Handle an RTP buffer for the stream. This method is usually called when a + line="4565">Handle an RTP buffer for the stream. This method is usually called when a message has been received from a client using the TCP transport. This function takes ownership of @buffer. @@ -13936,20 +14442,20 @@ This function takes ownership of @buffer. a GstFlowReturn. + line="4575">a GstFlowReturn. a #GstRTSPStream + line="4567">a #GstRTSPStream a #GstBuffer + line="4568">a #GstBuffer @@ -13958,7 +14464,7 @@ This function takes ownership of @buffer. c:identifier="gst_rtsp_stream_remove_transport"> Remove the transport in @trans from @stream. The media of @stream will + line="4887">Remove the transport in @trans from @stream. The media of @stream will not be sent to the values configured in @trans. @stream must be joined to a bin. @@ -13968,20 +14474,20 @@ not be sent to the values configured in @trans. %TRUE if @trans was removed + line="4899">%TRUE if @trans was removed a #GstRTSPStream + line="4889">a #GstRTSPStream a #GstRTSPStreamTransport + line="4890">a #GstRTSPStreamTransport @@ -13991,25 +14497,25 @@ not be sent to the values configured in @trans. version="1.16"> Creating a rtxreceive bin + line="3072">Creating a rtxreceive bin a #GstElement. + line="3079">a #GstElement. a #GstRTSPStream + line="3074">a #GstRTSPStream the session id + line="3075">the session id @@ -14019,25 +14525,25 @@ not be sent to the values configured in @trans. version="1.6"> Creating a rtxsend bin + line="2964">Creating a rtxsend bin a #GstElement. + line="2971">a #GstElement. a #GstRTSPStream + line="2966">a #GstRTSPStream the session id + line="2967">the session id @@ -14047,12 +14553,12 @@ not be sent to the values configured in @trans. version="1.16"> Creating a rtpulpfecdec element + line="6357">Creating a rtpulpfecdec element a #GstElement. + line="6362">a #GstElement. @@ -14072,12 +14578,12 @@ not be sent to the values configured in @trans. version="1.16"> Creating a rtpulpfecenc element + line="6386">Creating a rtpulpfecenc element a #GstElement. + line="6391">a #GstElement. @@ -14093,14 +14599,14 @@ not be sent to the values configured in @trans. c:identifier="gst_rtsp_stream_reserve_address"> Reserve @address and @port as the address and port of @stream. The original + line="1148">Reserve @address and @port as the address and port of @stream. The original #GstRTSPAddress is cached and copy is returned, so freeing the return value won't release the address from the pool. the #GstRTSPAddress of @stream or %NULL when + line="1160">the #GstRTSPAddress of @stream or %NULL when the address could not be reserved. gst_rtsp_address_free() after usage. @@ -14109,31 +14615,31 @@ usage. a #GstRTSPStream + line="1150">a #GstRTSPStream an address + line="1151">an address a port + line="1152">a port n_ports + line="1153">n_ports a TTL + line="1154">a TTL @@ -14143,19 +14649,19 @@ usage. version="1.14"> Checks whether the individual @stream is seekable. + line="5850">Checks whether the individual @stream is seekable. %TRUE if @stream is seekable, else %FALSE. + line="5856">%TRUE if @stream is seekable, else %FALSE. a #GstRTSPStream + line="5852">a #GstRTSPStream @@ -14164,7 +14670,7 @@ usage. c:identifier="gst_rtsp_stream_set_address_pool"> configure @pool to be used as the address pool of @stream. + line="958">configure @pool to be used as the address pool of @stream. @@ -14173,7 +14679,7 @@ usage. a #GstRTSPStream + line="960">a #GstRTSPStream allow-none="1"> a #GstRTSPAddressPool + line="961">a #GstRTSPAddressPool @@ -14192,7 +14698,7 @@ usage. version="1.16"> Decide whether the multicast socket should be bound to a multicast address or + line="2282">Decide whether the multicast socket should be bound to a multicast address or INADDR_ANY. @@ -14202,13 +14708,13 @@ INADDR_ANY. a #GstRTSPStream, + line="2284">a #GstRTSPStream, the new value + line="2285">the new value @@ -14216,25 +14722,25 @@ INADDR_ANY. Blocks or unblocks the dataflow on @stream. + line="5568">Blocks or unblocks the dataflow on @stream. %TRUE on success + line="5575">%TRUE on success a #GstRTSPStream + line="5570">a #GstRTSPStream boolean indicating we should block or unblock + line="5571">boolean indicating we should block or unblock @@ -14244,7 +14750,7 @@ INADDR_ANY. version="1.6"> Set the size of the UDP transmission buffer (in bytes) + line="2168">Set the size of the UDP transmission buffer (in bytes) Needs to be set before the stream is joined to a bin. @@ -14254,13 +14760,13 @@ Needs to be set before the stream is joined to a bin. a #GstRTSPStream + line="2170">a #GstRTSPStream the buffer size + line="2171">the buffer size @@ -14269,7 +14775,7 @@ Needs to be set before the stream is joined to a bin. c:identifier="gst_rtsp_stream_set_client_side"> Sets the #GstRTSPStream as a 'client side' stream - used for sending + line="1907">Sets the #GstRTSPStream as a 'client side' stream - used for sending streams to an RTSP server via RECORD. This has the practical effect of changing which UDP port numbers are used when setting up the local side of the stream sending to be either the 'server' or 'client' pair @@ -14282,13 +14788,13 @@ of a configured UDP transport. a #GstRTSPStream + line="1909">a #GstRTSPStream TRUE if this #GstRTSPStream is running on the 'client' side of + line="1910">TRUE if this #GstRTSPStream is running on the 'client' side of an RTSP connection. @@ -14299,7 +14805,7 @@ an RTSP connection. glib:set-property="control"> Set the control string in @stream. + line="647">Set the control string in @stream. @@ -14308,7 +14814,7 @@ an RTSP connection. a #GstRTSPStream + line="649">a #GstRTSPStream allow-none="1"> a control string + line="650">a control string @@ -14325,7 +14831,7 @@ an RTSP connection. Configure the dscp qos of the outgoing sockets to @dscp_qos. + line="761">Configure the dscp qos of the outgoing sockets to @dscp_qos. @@ -14334,13 +14840,13 @@ an RTSP connection. a #GstRTSPStream + line="763">a #GstRTSPStream a new dscp qos value (0-63, or -1 to disable) + line="764">a new dscp qos value (0-63, or -1 to disable) @@ -14350,25 +14856,25 @@ an RTSP connection. version="1.16"> Set the maximum time-to-live value of outgoing multicast packets. + line="2208">Set the maximum time-to-live value of outgoing multicast packets. %TRUE if the requested ttl has been set successfully. + line="2215">%TRUE if the requested ttl has been set successfully. a #GstRTSPStream + line="2210">a #GstRTSPStream the new multicast ttl value + line="2211">the new multicast ttl value @@ -14376,7 +14882,7 @@ an RTSP connection. Configure the mtu in the payloader of @stream to @mtu. + line="704">Configure the mtu in the payloader of @stream to @mtu. @@ -14385,13 +14891,13 @@ an RTSP connection. a #GstRTSPStream + line="706">a #GstRTSPStream a new MTU + line="707">a new MTU @@ -14400,7 +14906,7 @@ an RTSP connection. c:identifier="gst_rtsp_stream_set_multicast_iface"> configure @multicast_iface to be used for @stream. + line="1016">configure @multicast_iface to be used for @stream. @@ -14409,7 +14915,7 @@ an RTSP connection. a #GstRTSPStream + line="1018">a #GstRTSPStream allow-none="1"> a multicast interface name + line="1019">a multicast interface name @@ -14428,7 +14934,7 @@ an RTSP connection. glib:set-property="profiles"> Configure the allowed profiles for @stream. + line="864">Configure the allowed profiles for @stream. @@ -14437,13 +14943,13 @@ an RTSP connection. a #GstRTSPStream + line="866">a #GstRTSPStream the new profiles + line="867">the new profiles @@ -14453,7 +14959,7 @@ an RTSP connection. glib:set-property="protocols"> Configure the allowed lower transport for @stream. + line="910">Configure the allowed lower transport for @stream. @@ -14462,13 +14968,13 @@ an RTSP connection. a #GstRTSPStream + line="912">a #GstRTSPStream the new flags + line="913">the new flags @@ -14476,7 +14982,7 @@ an RTSP connection. Configure a pt map between @pt and @caps. + line="3113">Configure a pt map between @pt and @caps. @@ -14485,19 +14991,19 @@ an RTSP connection. a #GstRTSPStream + line="3115">a #GstRTSPStream the pt + line="3116">the pt a #GstCaps + line="3117">a #GstCaps @@ -14507,7 +15013,7 @@ an RTSP connection. version="1.8"> Sets if and how the stream clock should be published according to RFC7273. + line="3135">Sets if and how the stream clock should be published according to RFC7273. @@ -14516,13 +15022,13 @@ an RTSP connection. a #GstRTSPStream + line="3137">a #GstRTSPStream the clock publish mode + line="3138">the clock publish mode @@ -14533,7 +15039,7 @@ an RTSP connection. version="1.18"> Define whether @stream will follow the Rate-Control=no behaviour as specified + line="6453">Define whether @stream will follow the Rate-Control=no behaviour as specified in the ONVIF replay spec. @@ -14552,7 +15058,7 @@ in the ONVIF replay spec. c:identifier="gst_rtsp_stream_set_retransmission_pt"> Set the payload type (pt) for retransmission of this stream. + line="2118">Set the payload type (pt) for retransmission of this stream. @@ -14561,13 +15067,13 @@ in the ONVIF replay spec. a #GstRTSPStream + line="2120">a #GstRTSPStream a #guint + line="2121">a #guint @@ -14576,7 +15082,7 @@ in the ONVIF replay spec. c:identifier="gst_rtsp_stream_set_retransmission_time"> Set the amount of time to store retransmission packets. + line="2075">Set the amount of time to store retransmission packets. @@ -14585,13 +15091,13 @@ in the ONVIF replay spec. a #GstRTSPStream + line="2077">a #GstRTSPStream a #GstClockTime + line="2078">a #GstClockTime @@ -14616,7 +15122,7 @@ in the ONVIF replay spec. version="1.16"> Sets the amount of redundancy to apply when creating ULPFEC + line="6412">Sets the amount of redundancy to apply when creating ULPFEC protection packets. @@ -14636,7 +15142,7 @@ protection packets. version="1.16"> Set the payload type to be used for ULPFEC protection packets + line="6337">Set the payload type to be used for ULPFEC protection packets @@ -14654,7 +15160,7 @@ protection packets. c:identifier="gst_rtsp_stream_transport_filter"> Call @func for each transport managed by @stream. The result value of @func + line="5233">Call @func for each transport managed by @stream. The result value of @func determines what happens to the transport. @func will be called with @stream locked so no further actions on @stream can be performed from @func. @@ -14672,7 +15178,7 @@ When @func is %NULL, #GST_RTSP_FILTER_REF will be assumed for each transport. a #GList with all + line="5254">a #GList with all transports for which @func returned #GST_RTSP_FILTER_REF. After usage, each element in the #GList should be unreffed before the list is freed. @@ -14683,7 +15189,7 @@ element in the #GList should be unreffed before the list is freed. a #GstRTSPStream + line="5235">a #GstRTSPStream closure="1"> a callback + line="5236">a callback @@ -14704,7 +15210,7 @@ element in the #GList should be unreffed before the list is freed. allow-none="1"> user data passed to @func + line="5237">user data passed to @func @@ -14726,7 +15232,7 @@ element in the #GList should be unreffed before the list is freed. version="1.20"> Remove blocking probe from the RTCP source. When creating an UDP source for + line="6503">Remove blocking probe from the RTCP source. When creating an UDP source for RTCP it is initially blocked until this function is called. This functions should be called once the pipeline is ready for handling RTCP packets. @@ -14744,7 +15250,7 @@ packets. c:identifier="gst_rtsp_stream_update_crypto"> Update the new crypto information for @ssrc in @stream. If information + line="4920">Update the new crypto information for @ssrc in @stream. If information for @ssrc did not exist, it will be added. If information for @ssrc existed, it will be replaced. If @crypto is %NULL, it will be removed from @stream. @@ -14752,20 +15258,20 @@ be removed from @stream. %TRUE if @crypto could be updated + line="4931">%TRUE if @crypto could be updated a #GstRTSPStream + line="4922">a #GstRTSPStream the SSRC + line="4923">the SSRC allow-none="1"> a #GstCaps with crypto info + line="4924">a #GstCaps with crypto info @@ -14784,25 +15290,25 @@ be removed from @stream. version="1.16"> Check if the requested multicast ttl value is allowed. + line="2258">Check if the requested multicast ttl value is allowed. TRUE if the requested ttl value is allowed. + line="2265">TRUE if the requested ttl value is allowed. a #GstRTSPStream + line="2260">a #GstRTSPStream a requested multicast ttl + line="2261">a requested multicast ttl @@ -15861,6 +16367,10 @@ structures. + configure a thread object. this vmethod is called when + a new thread has been created and should be configured. @@ -15913,6 +16423,9 @@ gst_rtsp_thread_stop() after usage + called from the thread when it is entered @@ -15928,6 +16441,9 @@ gst_rtsp_thread_stop() after usage + called from the thread when it is left @@ -16066,6 +16582,10 @@ unlimited number of threads. + this function should make or reuse an existing thread that runs + a mainloop. @@ -16099,6 +16619,10 @@ gst_rtsp_thread_stop() after usage + configure a thread object. this vmethod is called when + a new thread has been created and should be configured. @@ -16119,6 +16643,9 @@ gst_rtsp_thread_stop() after usage + called from the thread when it is entered @@ -16136,6 +16663,9 @@ gst_rtsp_thread_stop() after usage + called from the thread when it is left diff --git a/girs/GstSdp-1.0.gir b/girs/GstSdp-1.0.gir index 13ebd4bd7..9bb4436c5 100644 --- a/girs/GstSdp-1.0.gir +++ b/girs/GstSdp-1.0.gir @@ -242,12 +242,12 @@ protocol sessions. version="1.4"> Make a new MIKEY message. + line="870">Make a new MIKEY message. a new #GstMIKEYMessage on success + line="875">a new #GstMIKEYMessage on success @@ -257,25 +257,25 @@ protocol sessions. throws="1"> Make a new #GstMIKEYMessage from @bytes. + line="896">Make a new #GstMIKEYMessage from @bytes. a new #GstMIKEYMessage + line="904">a new #GstMIKEYMessage a #GBytes + line="898">a #GBytes a #GstMIKEYDecryptInfo + line="899">a #GstMIKEYDecryptInfo @@ -285,7 +285,7 @@ protocol sessions. version="1.8"> Makes mikey message including: + line="2234">Makes mikey message including: - Security Policy Payload - Key Data Transport Payload - Key Data Sub-Payload @@ -293,7 +293,7 @@ protocol sessions. a #GstMIKEYMessage, + line="2243">a #GstMIKEYMessage, or %NULL if there is no srtp information in the caps. @@ -301,7 +301,7 @@ or %NULL if there is no srtp information in the caps. a #GstCaps, including SRTP parameters (srtp/srtcp cipher, authorization, key data) + line="2236">a #GstCaps, including SRTP parameters (srtp/srtcp cipher, authorization, key data) @@ -312,13 +312,13 @@ or %NULL if there is no srtp information in the caps. throws="1"> Parse @size bytes from @data into a #GstMIKEYMessage. @info contains the + line="2048">Parse @size bytes from @data into a #GstMIKEYMessage. @info contains the parameters to decrypt and verify the data. a #GstMIKEYMessage on success or %NULL when parsing failed and + line="2058">a #GstMIKEYMessage on success or %NULL when parsing failed and @error will be set. @@ -326,7 +326,7 @@ parameters to decrypt and verify the data. bytes to read + line="2050">bytes to read @@ -334,13 +334,13 @@ parameters to decrypt and verify the data. length of @data + line="2051">length of @data #GstMIKEYDecryptInfo + line="2052">#GstMIKEYDecryptInfo @@ -350,37 +350,37 @@ parameters to decrypt and verify the data. version="1.4"> Add a Crypto policy for SRTP to @msg. + line="1075">Add a Crypto policy for SRTP to @msg. %TRUE on success + line="1084">%TRUE on success a #GstMIKEYMessage + line="1077">a #GstMIKEYMessage The security policy applied for the stream with @ssrc + line="1078">The security policy applied for the stream with @ssrc the SSRC that must be used for the stream + line="1079">the SSRC that must be used for the stream current rollover counter + line="1080">current rollover counter @@ -390,25 +390,25 @@ parameters to decrypt and verify the data. version="1.4"> Add a new payload to @msg. + line="1231">Add a new payload to @msg. %TRUE on success + line="1238">%TRUE on success a #GstMIKEYMessage + line="1233">a #GstMIKEYMessage a #GstMIKEYPayload + line="1234">a #GstMIKEYPayload @@ -418,37 +418,37 @@ parameters to decrypt and verify the data. version="1.4"> Add a new PKE payload to @msg with the given parameters. + line="1277">Add a new PKE payload to @msg with the given parameters. %TRUE on success + line="1286">%TRUE on success a #GstMIKEYMessage + line="1279">a #GstMIKEYMessage envelope key cache indicator + line="1280">envelope key cache indicator the length of @data + line="1281">the length of @data the encrypted envelope key + line="1282">the encrypted envelope key @@ -460,31 +460,31 @@ parameters to decrypt and verify the data. version="1.4"> Add a new RAND payload to @msg with the given parameters. + line="1367">Add a new RAND payload to @msg with the given parameters. %TRUE on success + line="1375">%TRUE on success a #GstMIKEYMessage + line="1369">a #GstMIKEYMessage the length of @rand + line="1370">the length of @rand random data + line="1371">random data @@ -496,25 +496,25 @@ parameters to decrypt and verify the data. version="1.4"> Add a new RAND payload to @msg with @len random bytes. + line="1397">Add a new RAND payload to @msg with @len random bytes. %TRUE on success + line="1404">%TRUE on success a #GstMIKEYMessage + line="1399">a #GstMIKEYMessage length + line="1400">length @@ -524,31 +524,31 @@ parameters to decrypt and verify the data. version="1.4"> Add a new T payload to @msg with the given parameters. + line="1307">Add a new T payload to @msg with the given parameters. %TRUE on success + line="1315">%TRUE on success a #GstMIKEYMessage + line="1309">a #GstMIKEYMessage specifies the timestamp type used + line="1310">specifies the timestamp type used The timestamp value of the specified @type + line="1311">The timestamp value of the specified @type @@ -560,20 +560,20 @@ parameters to decrypt and verify the data. version="1.4"> Add a new T payload to @msg that contains the current time + line="1336">Add a new T payload to @msg that contains the current time in NTP-UTC format. %TRUE on success + line="1343">%TRUE on success a #GstMIKEYMessage + line="1338">a #GstMIKEYMessage @@ -585,14 +585,14 @@ in NTP-UTC format. a #gchar, base64-encoded data + line="2532">a #gchar, base64-encoded data a #GstMIKEYMessage + line="2530">a #GstMIKEYMessage @@ -602,31 +602,31 @@ in NTP-UTC format. version="1.4"> Find the @nth occurrence of the payload with @type in @msg. + line="1146">Find the @nth occurrence of the payload with @type in @msg. the @nth #GstMIKEYPayload of @type. + line="1154">the @nth #GstMIKEYPayload of @type. a #GstMIKEYMessage + line="1148">a #GstMIKEYMessage a #GstMIKEYPayloadType + line="1149">a #GstMIKEYPayloadType payload to find + line="1150">payload to find @@ -636,25 +636,25 @@ in NTP-UTC format. version="1.4"> Get the policy information of @msg at @idx. + line="972">Get the policy information of @msg at @idx. a #GstMIKEYMapSRTP + line="979">a #GstMIKEYMapSRTP a #GstMIKEYMessage + line="974">a #GstMIKEYMessage an index + line="975">an index @@ -664,19 +664,19 @@ in NTP-UTC format. version="1.4"> Get the number of crypto sessions in @msg. + line="954">Get the number of crypto sessions in @msg. the number of crypto sessions + line="960">the number of crypto sessions a #GstMIKEYMessage + line="956">a #GstMIKEYMessage @@ -686,19 +686,19 @@ in NTP-UTC format. version="1.4"> Get the number of payloads in @msg. + line="1105">Get the number of payloads in @msg. the number of payloads in @msg + line="1111">the number of payloads in @msg a #GstMIKEYMessage + line="1107">a #GstMIKEYMessage @@ -708,12 +708,12 @@ in NTP-UTC format. version="1.4"> Get the #GstMIKEYPayload at @idx in @msg + line="1123">Get the #GstMIKEYPayload at @idx in @msg the #GstMIKEYPayload at @idx. The payload + line="1130">the #GstMIKEYPayload at @idx. The payload remains valid for as long as it is part of @msg. @@ -721,13 +721,13 @@ remains valid for as long as it is part of @msg. a #GstMIKEYMessage + line="1125">a #GstMIKEYMessage an index + line="1126">an index @@ -737,33 +737,33 @@ remains valid for as long as it is part of @msg. version="1.4"> Insert a Crypto Session map for SRTP in @msg at @idx + line="995">Insert a Crypto Session map for SRTP in @msg at @idx When @idx is -1, the policy will be appended. %TRUE on success + line="1005">%TRUE on success a #GstMIKEYMessage + line="997">a #GstMIKEYMessage the index to insert at + line="998">the index to insert at the map info + line="999">the map info @@ -773,32 +773,32 @@ When @idx is -1, the policy will be appended. version="1.4"> Insert the @payload at index @idx in @msg. If @idx is -1, the payload + line="1202">Insert the @payload at index @idx in @msg. If @idx is -1, the payload will be appended to @msg. %TRUE on success + line="1211">%TRUE on success a #GstMIKEYMessage + line="1204">a #GstMIKEYMessage an index + line="1205">an index a #GstMIKEYPayload + line="1206">a #GstMIKEYPayload @@ -808,25 +808,25 @@ will be appended to @msg. version="1.4"> Remove the SRTP policy at @idx. + line="1052">Remove the SRTP policy at @idx. %TRUE on success + line="1059">%TRUE on success a #GstMIKEYMessage + line="1054">a #GstMIKEYMessage the index to remove + line="1055">the index to remove @@ -836,25 +836,25 @@ will be appended to @msg. version="1.4"> Remove the payload in @msg at @idx + line="1180">Remove the payload in @msg at @idx %TRUE on success + line="1187">%TRUE on success a #GstMIKEYMessage + line="1182">a #GstMIKEYMessage an index + line="1183">an index @@ -864,31 +864,31 @@ will be appended to @msg. version="1.4"> Replace a Crypto Session map for SRTP in @msg at @idx with @map. + line="1026">Replace a Crypto Session map for SRTP in @msg at @idx with @map. %TRUE on success + line="1034">%TRUE on success a #GstMIKEYMessage + line="1028">a #GstMIKEYMessage the index to insert at + line="1029">the index to insert at the map info + line="1030">the map info @@ -898,31 +898,31 @@ will be appended to @msg. version="1.4"> Replace the payload at @idx in @msg with @payload. + line="1248">Replace the payload at @idx in @msg with @payload. %TRUE on success + line="1256">%TRUE on success a #GstMIKEYMessage + line="1250">a #GstMIKEYMessage an index + line="1251">an index a #GstMIKEYPayload + line="1252">a #GstMIKEYPayload @@ -932,55 +932,55 @@ will be appended to @msg. version="1.4"> Set the information in @msg. + line="921">Set the information in @msg. %TRUE on success + line="933">%TRUE on success a #GstMIKEYMessage + line="923">a #GstMIKEYMessage a version + line="924">a version a #GstMIKEYType + line="925">a #GstMIKEYType verify flag + line="926">verify flag the #GstMIKEYPRFFunc function to use + line="927">the #GstMIKEYPRFFunc function to use the Crypto Session Bundle id + line="928">the Crypto Session Bundle id the #GstMIKEYMapType + line="929">the #GstMIKEYMapType @@ -991,25 +991,25 @@ will be appended to @msg. throws="1"> Convert @msg to a #GBytes. + line="1664">Convert @msg to a #GBytes. a new #GBytes for @msg. + line="1672">a new #GBytes for @msg. a #GstMIKEYMessage + line="1666">a #GstMIKEYMessage a #GstMIKEYEncryptInfo + line="1667">a #GstMIKEYEncryptInfo @@ -1021,20 +1021,20 @@ will be appended to @msg. %TRUE on success + line="2374">%TRUE on success a #GstMIKEYMessage + line="2371">a #GstMIKEYMessage a #GstCaps to be filled with SRTP parameters (srtp/srtcp cipher, authorization, key data) + line="2372">a #GstCaps to be filled with SRTP parameters (srtp/srtcp cipher, authorization, key data) @@ -1082,19 +1082,19 @@ will be appended to @msg. version="1.4"> Make a new #GstMIKEYPayload with @type. + line="762">Make a new #GstMIKEYPayload with @type. a new #GstMIKEYPayload or %NULL on failure. + line="768">a new #GstMIKEYPayload or %NULL on failure. a #GstMIKEYPayloadType + line="764">a #GstMIKEYPayloadType @@ -1104,25 +1104,25 @@ will be appended to @msg. version="1.4"> Add a new sub payload to @payload. + line="224">Add a new sub payload to @payload. %TRUE on success. + line="231">%TRUE on success. a #GstMIKEYPayload + line="226">a #GstMIKEYPayload a #GstMIKEYPayload to add + line="227">a #GstMIKEYPayload to add @@ -1132,20 +1132,20 @@ will be appended to @msg. version="1.4"> Get the number of sub payloads of @payload. @payload should be of type + line="151">Get the number of sub payloads of @payload. @payload should be of type %GST_MIKEY_PT_KEMAC. the number of sub payloads in @payload + line="158">the number of sub payloads in @payload a #GstMIKEYPayload + line="153">a #GstMIKEYPayload @@ -1155,26 +1155,26 @@ will be appended to @msg. version="1.4"> Get the sub payload of @payload at @idx. @payload should be of type + line="173">Get the sub payload of @payload at @idx. @payload should be of type %GST_MIKEY_PT_KEMAC. the #GstMIKEYPayload at @idx. + line="181">the #GstMIKEYPayload at @idx. a #GstMIKEYPayload + line="175">a #GstMIKEYPayload an index + line="176">an index @@ -1184,25 +1184,25 @@ will be appended to @msg. version="1.4"> Remove the sub payload at @idx in @payload. + line="199">Remove the sub payload at @idx in @payload. %TRUE on success. + line="206">%TRUE on success. a #GstMIKEYPayload + line="201">a #GstMIKEYPayload the index to remove + line="202">the index to remove @@ -1247,31 +1247,31 @@ payload. version="1.4"> Set the key validity period in the %GST_MIKEY_PT_KEY_DATA @payload. + line="683">Set the key validity period in the %GST_MIKEY_PT_KEY_DATA @payload. %TRUE on success + line="693">%TRUE on success a #GstMIKEYPayload + line="685">a #GstMIKEYPayload the length of @vf_data + line="686">the length of @vf_data the Valid From data + line="687">the Valid From data @@ -1279,13 +1279,13 @@ payload. the length of @vt_data + line="688">the length of @vt_data the Valid To data + line="689">the Valid To data @@ -1297,38 +1297,38 @@ payload. version="1.4"> Set @key_len bytes of @key_data of type @key_type as the key for the + line="588">Set @key_len bytes of @key_data of type @key_type as the key for the %GST_MIKEY_PT_KEY_DATA @payload. %TRUE on success + line="598">%TRUE on success a #GstMIKEYPayload + line="590">a #GstMIKEYPayload a #GstMIKEYKeyDataType + line="591">a #GstMIKEYKeyDataType the length of @key_data + line="592">the length of @key_data the key of type @key_type + line="593">the key of type @key_type @@ -1340,26 +1340,26 @@ payload. version="1.4"> Set the salt key data. If @salt_len is 0 and @salt_data is %NULL, the + line="619">Set the salt key data. If @salt_len is 0 and @salt_data is %NULL, the salt data will be removed. %TRUE on success + line="628">%TRUE on success a #GstMIKEYPayload + line="621">a #GstMIKEYPayload the length of @salt_data + line="622">the length of @salt_data allow-none="1"> the salt + line="623">the salt @@ -1380,31 +1380,31 @@ salt data will be removed. version="1.4"> Set the SPI/MKI validity in the %GST_MIKEY_PT_KEY_DATA @payload. + line="651">Set the SPI/MKI validity in the %GST_MIKEY_PT_KEY_DATA @payload. %TRUE on success + line="659">%TRUE on success a #GstMIKEYPayload + line="653">a #GstMIKEYPayload the length of @spi_data + line="654">the length of @spi_data the SPI/MKI data + line="655">the SPI/MKI data @@ -1416,38 +1416,38 @@ salt data will be removed. version="1.4"> Set the PKE values in @payload. @payload must be of type + line="250">Set the PKE values in @payload. @payload must be of type %GST_MIKEY_PT_PKE. %TRUE on success + line="260">%TRUE on success a #GstMIKEYPayload + line="252">a #GstMIKEYPayload envelope key cache indicator + line="253">envelope key cache indicator the length of @data + line="254">the length of @data the encrypted envelope key + line="255">the encrypted envelope key @@ -1459,31 +1459,31 @@ salt data will be removed. version="1.4"> Set the random values in a %GST_MIKEY_PT_RAND @payload. + line="540">Set the random values in a %GST_MIKEY_PT_RAND @payload. %TRUE on success + line="548">%TRUE on success a #GstMIKEYPayload + line="542">a #GstMIKEYPayload the length of @rand + line="543">the length of @rand random values + line="544">random values @@ -1495,38 +1495,38 @@ salt data will be removed. version="1.4"> Add a new parameter to the %GST_MIKEY_PT_SP @payload with @type, @len + line="506">Add a new parameter to the %GST_MIKEY_PT_SP @payload with @type, @len and @val. %TRUE on success + line="516">%TRUE on success a #GstMIKEYPayload + line="508">a #GstMIKEYPayload a type + line="509">a type a length + line="510">a length @len bytes of data + line="511">@len bytes of data @@ -1538,20 +1538,20 @@ and @val. version="1.4"> Get the number of security policy parameters in a %GST_MIKEY_PT_SP + line="431">Get the number of security policy parameters in a %GST_MIKEY_PT_SP @payload. the number of parameters in @payload + line="438">the number of parameters in @payload a #GstMIKEYPayload + line="433">a #GstMIKEYPayload @@ -1561,13 +1561,13 @@ and @val. version="1.4"> Get the Security Policy parameter in a %GST_MIKEY_PT_SP @payload + line="454">Get the Security Policy parameter in a %GST_MIKEY_PT_SP @payload at @idx. the #GstMIKEYPayloadSPParam at @idx in @payload + line="462">the #GstMIKEYPayloadSPParam at @idx in @payload @@ -1575,13 +1575,13 @@ at @idx. a #GstMIKEYPayload + line="456">a #GstMIKEYPayload an index + line="457">an index @@ -1591,26 +1591,26 @@ at @idx. version="1.4"> Remove the Security Policy parameters from a %GST_MIKEY_PT_SP + line="480">Remove the Security Policy parameters from a %GST_MIKEY_PT_SP @payload at @idx. %TRUE on success + line="488">%TRUE on success a #GstMIKEYPayload + line="482">a #GstMIKEYPayload an index + line="483">an index @@ -1620,31 +1620,31 @@ at @idx. version="1.4"> Set the Security Policy parameters for @payload. + line="379">Set the Security Policy parameters for @payload. %TRUE on success + line="387">%TRUE on success a #GstMIKEYPayload + line="381">a #GstMIKEYPayload the policy number + line="382">the policy number a #GstMIKEYSecProto + line="383">a #GstMIKEYSecProto @@ -1654,31 +1654,31 @@ at @idx. version="1.4"> Set the timestamp in a %GST_MIKEY_PT_T @payload. + line="321">Set the timestamp in a %GST_MIKEY_PT_T @payload. %TRUE on success + line="329">%TRUE on success a #GstMIKEYPayload + line="323">a #GstMIKEYPayload the #GstMIKEYTSType + line="324">the #GstMIKEYTSType the timestamp value + line="325">the timestamp value @@ -2392,20 +2392,20 @@ be used by the session or media. version="1.2"> Clear the connection. + line="2402">Clear the connection. @GST_SDP_OK. + line="2408">@GST_SDP_OK. a #GstSDPConnection + line="2404">a #GstSDPConnection @@ -2413,51 +2413,51 @@ be used by the session or media. Set the connection with the given parameters. + line="2369">Set the connection with the given parameters. @GST_SDP_OK. + line="2381">@GST_SDP_OK. a #GstSDPConnection + line="2371">a #GstSDPConnection the type of network. "IN" is defined to have the meaning + line="2372">the type of network. "IN" is defined to have the meaning "Internet". the type of address. + line="2374">the type of address. the address + line="2375">the address the time to live of the address + line="2376">the time to live of the address the number of layers + line="2377">the number of layers @@ -2558,26 +2558,26 @@ keys. Add the attribute with @key and @value to @media. + line="2774">Add the attribute with @key and @value to @media. + line="737"/> #GST_SDP_OK. + line="2782">#GST_SDP_OK. a #GstSDPMedia + line="2776">a #GstSDPMedia a key + line="2777">a key allow-none="1"> a value + line="2778">a value @@ -2594,32 +2594,32 @@ keys. Add the bandwidth information with @bwtype and @bandwidth to @media. + line="2693">Add the bandwidth information with @bwtype and @bandwidth to @media. + line="699"/> #GST_SDP_OK. + line="2701">#GST_SDP_OK. a #GstSDPMedia + line="2695">a #GstSDPMedia the bandwidth modifier type + line="2696">the bandwidth modifier type the bandwidth in kilobits per second + line="2697">the bandwidth in kilobits per second @@ -2628,51 +2628,51 @@ keys. c:identifier="gst_sdp_media_add_connection"> Add the given connection parameters to @media. + line="2545">Add the given connection parameters to @media. + line="673"/> a #GstSDPResult. + line="2557">a #GstSDPResult. a #GstSDPMedia + line="2547">a #GstSDPMedia the type of network. "IN" is defined to have the meaning + line="2548">the type of network. "IN" is defined to have the meaning "Internet". the type of address. + line="2550">the type of address. the address + line="2551">the address the time to live of the address + line="2552">the time to live of the address the number of layers + line="2553">the number of layers @@ -2680,26 +2680,26 @@ keys. Add the format information to @media. + line="2309">Add the format information to @media. + line="643"/> #GST_SDP_OK. + line="2316">#GST_SDP_OK. a #GstSDPMedia + line="2311">a #GstSDPMedia the format + line="2312">the format @@ -2707,20 +2707,20 @@ keys. Convert the contents of @media to a text string. + line="1982">Convert the contents of @media to a text string. + line="599"/> A dynamically allocated string representing the media. + line="1988">A dynamically allocated string representing the media. a #GstSDPMedia + line="1984">a #GstSDPMedia @@ -2729,20 +2729,20 @@ keys. c:identifier="gst_sdp_media_attributes_len"> Get the number of attribute fields in @media. + line="2758">Get the number of attribute fields in @media. + line="713"/> the number of attributes in @media. + line="2764">the number of attributes in @media. a #GstSDPMedia + line="2760">a #GstSDPMedia @@ -2752,26 +2752,26 @@ keys. version="1.8"> Mapping of attributes of #GstSDPMedia to #GstCaps + line="4623">Mapping of attributes of #GstSDPMedia to #GstCaps + line="759"/> a #GstSDPResult. + line="4630">a #GstSDPResult. a #GstSDPMedia + line="4625">a #GstSDPMedia a #GstCaps + line="4626">a #GstCaps @@ -2780,20 +2780,20 @@ keys. c:identifier="gst_sdp_media_bandwidths_len"> Get the number of bandwidth fields in @media. + line="2576">Get the number of bandwidth fields in @media. + line="682"/> the number of bandwidths in @media. + line="2582">the number of bandwidths in @media. a #GstSDPMedia + line="2578">a #GstSDPMedia @@ -2802,20 +2802,20 @@ keys. c:identifier="gst_sdp_media_connections_len"> Get the number of connection fields in @media. + line="2426">Get the number of connection fields in @media. + line="656"/> the number of connections in @media. + line="2432">the number of connections in @media. a #GstSDPMedia + line="2428">a #GstSDPMedia @@ -2823,21 +2823,21 @@ keys. Allocate a new copy of @media and store the result in @copy. The value in + line="1921">Allocate a new copy of @media and store the result in @copy. The value in @copy should be release with gst_sdp_media_free function. + line="596"/> a #GstSDPResult + line="1929">a #GstSDPResult a #GstSDPMedia + line="1923">a #GstSDPMedia transfer-ownership="full"> pointer to new #GstSDPMedia + line="1924">pointer to new #GstSDPMedia @@ -2854,20 +2854,20 @@ keys. Get the number of formats in @media. + line="2189">Get the number of formats in @media. + line="626"/> the number of formats in @media. + line="2195">the number of formats in @media. a #GstSDPMedia + line="2191">a #GstSDPMedia @@ -2875,22 +2875,22 @@ keys. Free all resources allocated by @media. @media should not be used anymore after + line="1900">Free all resources allocated by @media. @media should not be used anymore after this function. This function should be used when @media was dynamically allocated with gst_sdp_media_new(). + line="593"/> a #GstSDPResult. + line="1908">a #GstSDPResult. a #GstSDPMedia + line="1902">a #GstSDPMedia @@ -2898,26 +2898,26 @@ allocated with gst_sdp_media_new(). Get the attribute at position @idx in @media. + line="2799">Get the attribute at position @idx in @media. + line="716"/> the #GstSDPAttribute at position @idx. + line="2806">the #GstSDPAttribute at position @idx. a #GstSDPMedia + line="2801">a #GstSDPMedia an index + line="2802">an index @@ -2926,26 +2926,26 @@ allocated with gst_sdp_media_new(). c:identifier="gst_sdp_media_get_attribute_val"> Get the first attribute value for @key in @media. + line="2850">Get the first attribute value for @key in @media. + line="719"/> the first attribute value for @key. + line="2857">the first attribute value for @key. a #GstSDPMedia + line="2852">a #GstSDPMedia a key + line="2853">a key @@ -2954,32 +2954,32 @@ allocated with gst_sdp_media_new(). c:identifier="gst_sdp_media_get_attribute_val_n"> Get the @nth attribute value for @key in @media. + line="2817">Get the @nth attribute value for @key in @media. + line="722"/> the @nth attribute value. + line="2825">the @nth attribute value. a #GstSDPMedia + line="2819">a #GstSDPMedia a key + line="2820">a key an index + line="2821">an index @@ -2987,26 +2987,26 @@ allocated with gst_sdp_media_new(). Get the bandwidth at position @idx in @media. + line="2592">Get the bandwidth at position @idx in @media. + line="685"/> the #GstSDPBandwidth at position @idx. + line="2599">the #GstSDPBandwidth at position @idx. a #GstSDPMedia + line="2594">a #GstSDPMedia an index + line="2595">an index @@ -3016,7 +3016,7 @@ allocated with gst_sdp_media_new(). version="1.8"> Mapping of caps from SDP fields: + line="3592">Mapping of caps from SDP fields: a=rtpmap:(payload) (encoding_name)/(clock_rate)[/(encoding_params)] @@ -3026,24 +3026,24 @@ a=fmtp:(payload) (param)[=(value)];... Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attributes_to_caps(). + line="741"/> a #GstCaps, or %NULL if an error happened + line="3607">a #GstCaps, or %NULL if an error happened a #GstSDPMedia + line="3594">a #GstSDPMedia a payload type + line="3595">a payload type @@ -3052,26 +3052,26 @@ Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attr c:identifier="gst_sdp_media_get_connection"> Get the connection at position @idx in @media. + line="2442">Get the connection at position @idx in @media. + line="659"/> the #GstSDPConnection at position @idx. + line="2449">the #GstSDPConnection at position @idx. a #GstSDPMedia + line="2444">a #GstSDPMedia an index + line="2445">an index @@ -3079,26 +3079,26 @@ Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attr Get the format information at position @idx in @media. + line="2205">Get the format information at position @idx in @media. + line="629"/> the format at position @idx. + line="2212">the format at position @idx. a #GstSDPMedia + line="2207">a #GstSDPMedia an index + line="2208">an index @@ -3107,20 +3107,20 @@ Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attr c:identifier="gst_sdp_media_get_information"> Get the information of @media + line="2333">Get the information of @media + line="648"/> the information of @media. + line="2339">the information of @media. a #GstSDPMedia + line="2335">a #GstSDPMedia @@ -3128,20 +3128,20 @@ Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attr Get the encryption information from @media. + line="2742">Get the encryption information from @media. + line="705"/> a #GstSDPKey. + line="2748">a #GstSDPKey. a #GstSDPMedia + line="2744">a #GstSDPMedia @@ -3149,20 +3149,20 @@ Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attr Get the media description of @media. + line="2063">Get the media description of @media. + line="604"/> the media description. + line="2069">the media description. a #GstSDPMedia + line="2065">a #GstSDPMedia @@ -3170,20 +3170,20 @@ Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attr Get the number of ports for @media. + line="2116">Get the number of ports for @media. + line="613"/> the number of ports for @media. + line="2122">the number of ports for @media. a #GstSDPMedia + line="2118">a #GstSDPMedia @@ -3191,20 +3191,20 @@ Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attr Get the port number for @media. + line="2100">Get the port number for @media. + line="610"/> the port number of @media. + line="2106">the port number of @media. a #GstSDPMedia + line="2102">a #GstSDPMedia @@ -3212,20 +3212,20 @@ Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attr Get the transport protocol of @media + line="2153">Get the transport protocol of @media + line="620"/> the transport protocol of @media. + line="2159">the transport protocol of @media. a #GstSDPMedia + line="2155">a #GstSDPMedia @@ -3235,33 +3235,33 @@ Note that the extmap, ssrc and rid attributes are set only by gst_sdp_media_attr version="1.2"> Insert the attribute to @media at @idx. When @idx is -1, + line="2868">Insert the attribute to @media at @idx. When @idx is -1, the attribute is appended. + line="726"/> #GST_SDP_OK. + line="2877">#GST_SDP_OK. a #GstSDPMedia + line="2870">a #GstSDPMedia an index + line="2871">an index a #GstSDPAttribute + line="2872">a #GstSDPAttribute @@ -3271,33 +3271,33 @@ the attribute is appended. version="1.2"> Insert the bandwidth information to @media at @idx. When @idx is -1, + line="2609">Insert the bandwidth information to @media at @idx. When @idx is -1, the bandwidth is appended. + line="688"/> #GST_SDP_OK. + line="2618">#GST_SDP_OK. a #GstSDPMedia + line="2611">a #GstSDPMedia an index + line="2612">an index a #GstSDPBandwidth + line="2613">a #GstSDPBandwidth @@ -3307,33 +3307,33 @@ the bandwidth is appended. version="1.2"> Insert the connection information to @media at @idx. When @idx is -1, + line="2460">Insert the connection information to @media at @idx. When @idx is -1, the connection is appended. + line="662"/> #GST_SDP_OK. + line="2469">#GST_SDP_OK. a #GstSDPMedia + line="2462">a #GstSDPMedia an index + line="2463">an index a #GstSDPConnection + line="2464">a #GstSDPConnection @@ -3343,33 +3343,33 @@ the connection is appended. version="1.2"> Insert the format information to @media at @idx. When @idx is -1, + line="2224">Insert the format information to @media at @idx. When @idx is -1, the format is appended. + line="632"/> #GST_SDP_OK. + line="2233">#GST_SDP_OK. a #GstSDPMedia + line="2226">a #GstSDPMedia an index + line="2227">an index the format + line="2228">the format @@ -3379,21 +3379,21 @@ the format is appended. version="1.8.1"> Creates a new #GstMIKEYMessage after parsing the key-mgmt attribute + line="4201">Creates a new #GstMIKEYMessage after parsing the key-mgmt attribute from a #GstSDPMedia. + line="753"/> a #GstSDPResult. + line="4209">a #GstSDPResult. a #GstSDPMedia + line="4203">a #GstSDPMedia transfer-ownership="full"> pointer to new #GstMIKEYMessage + line="4204">pointer to new #GstMIKEYMessage @@ -3412,26 +3412,26 @@ from a #GstSDPMedia. version="1.2"> Remove the attribute in @media at @idx. + line="2927">Remove the attribute in @media at @idx. + line="734"/> #GST_SDP_OK. + line="2934">#GST_SDP_OK. a #GstSDPMedia + line="2929">a #GstSDPMedia an index + line="2930">an index @@ -3441,26 +3441,26 @@ from a #GstSDPMedia. version="1.2"> Remove the bandwidth information in @media at @idx. + line="2667">Remove the bandwidth information in @media at @idx. + line="696"/> #GST_SDP_OK. + line="2674">#GST_SDP_OK. a #GstSDPMedia + line="2669">a #GstSDPMedia an index + line="2670">an index @@ -3470,26 +3470,26 @@ from a #GstSDPMedia. version="1.2"> Remove the connection information in @media at @idx. + line="2519">Remove the connection information in @media at @idx. + line="670"/> #GST_SDP_OK. + line="2526">#GST_SDP_OK. a #GstSDPMedia + line="2521">a #GstSDPMedia an index + line="2522">an index @@ -3499,26 +3499,26 @@ from a #GstSDPMedia. version="1.2"> Remove the format information in @media at @idx. + line="2284">Remove the format information in @media at @idx. + line="640"/> #GST_SDP_OK. + line="2291">#GST_SDP_OK. a #GstSDPMedia + line="2286">a #GstSDPMedia an index + line="2287">an index @@ -3528,32 +3528,32 @@ from a #GstSDPMedia. version="1.2"> Replace the attribute in @media at @idx with @attr. + line="2898">Replace the attribute in @media at @idx with @attr. + line="730"/> #GST_SDP_OK. + line="2906">#GST_SDP_OK. a #GstSDPMedia + line="2900">a #GstSDPMedia an index + line="2901">an index a #GstSDPAttribute + line="2902">a #GstSDPAttribute @@ -3563,32 +3563,32 @@ from a #GstSDPMedia. version="1.2"> Replace the bandwidth information in @media at @idx with @bw. + line="2639">Replace the bandwidth information in @media at @idx with @bw. + line="692"/> #GST_SDP_OK. + line="2647">#GST_SDP_OK. a #GstSDPMedia + line="2641">a #GstSDPMedia an index + line="2642">an index a #GstSDPBandwidth + line="2643">a #GstSDPBandwidth @@ -3598,32 +3598,32 @@ from a #GstSDPMedia. version="1.2"> Replace the connection information in @media at @idx with @conn. + line="2490">Replace the connection information in @media at @idx with @conn. + line="666"/> #GST_SDP_OK. + line="2498">#GST_SDP_OK. a #GstSDPMedia + line="2492">a #GstSDPMedia an index + line="2493">an index a #GstSDPConnection + line="2494">a #GstSDPConnection @@ -3633,32 +3633,32 @@ from a #GstSDPMedia. version="1.2"> Replace the format information in @media at @idx with @format. + line="2256">Replace the format information in @media at @idx with @format. + line="636"/> #GST_SDP_OK. + line="2264">#GST_SDP_OK. a #GstSDPMedia + line="2258">a #GstSDPMedia an index + line="2259">an index the format + line="2260">the format @@ -3667,26 +3667,26 @@ from a #GstSDPMedia. c:identifier="gst_sdp_media_set_information"> Set the media information of @media to @information. + line="2349">Set the media information of @media to @information. + line="651"/> #GST_SDP_OK. + line="2356">#GST_SDP_OK. a #GstSDPMedia + line="2351">a #GstSDPMedia the media information + line="2352">the media information @@ -3694,32 +3694,32 @@ from a #GstSDPMedia. Adds the encryption information to @media. + line="2718">Adds the encryption information to @media. + line="708"/> a #GstSDPResult. + line="2726">a #GstSDPResult. a #GstSDPMedia + line="2720">a #GstSDPMedia the encryption type + line="2721">the encryption type the encryption data + line="2722">the encryption data @@ -3727,26 +3727,26 @@ from a #GstSDPMedia. Set the media description of @media to @med. + line="2079">Set the media description of @media to @med. + line="607"/> #GST_SDP_OK. + line="2086">#GST_SDP_OK. a #GstSDPMedia + line="2081">a #GstSDPMedia the media description + line="2082">the media description @@ -3754,32 +3754,32 @@ from a #GstSDPMedia. Set the port information in @media. + line="2132">Set the port information in @media. + line="616"/> #GST_SDP_OK. + line="2140">#GST_SDP_OK. a #GstSDPMedia + line="2134">a #GstSDPMedia the port number + line="2135">the port number the number of ports + line="2136">the number of ports @@ -3787,26 +3787,26 @@ from a #GstSDPMedia. Set the media transport protocol of @media to @proto. + line="2169">Set the media transport protocol of @media to @proto. + line="623"/> #GST_SDP_OK. + line="2176">#GST_SDP_OK. a #GstSDPMedia + line="2171">a #GstSDPMedia the media transport protocol + line="2172">the media transport protocol @@ -3814,22 +3814,22 @@ from a #GstSDPMedia. Free all resources allocated in @media. @media should not be used anymore after + line="1876">Free all resources allocated in @media. @media should not be used anymore after this function. This function should be used when @media was allocated on the stack and initialized with gst_sdp_media_init(). + line="590"/> a #GstSDPResult. + line="1884">a #GstSDPResult. a #GstSDPMedia + line="1878">a #GstSDPMedia @@ -3837,18 +3837,18 @@ stack and initialized with gst_sdp_media_init(). Initialize @media so that its contents are as if it was freshly allocated + line="1844">Initialize @media so that its contents are as if it was freshly allocated with gst_sdp_media_new(). This function is mostly used to initialize a media allocated on the stack. gst_sdp_media_uninit() undoes this operation. When this function is invoked on newly allocated data (with malloc or on the stack), its contents should be set to 0 before calling this function. + line="587"/> a #GstSDPResult. + line="1855">a #GstSDPResult. @@ -3858,7 +3858,7 @@ stack), its contents should be set to 0 before calling this function. transfer-ownership="none"> a #GstSDPMedia + line="1846">a #GstSDPMedia @@ -3866,13 +3866,13 @@ stack), its contents should be set to 0 before calling this function. Allocate a new GstSDPMedia and store the result in @media. + line="1822">Allocate a new GstSDPMedia and store the result in @media. + line="584"/> a #GstSDPResult. + line="1828">a #GstSDPResult. @@ -3882,7 +3882,7 @@ stack), its contents should be set to 0 before calling this function. transfer-ownership="full"> pointer to new #GstSDPMedia + line="1824">pointer to new #GstSDPMedia @@ -3892,7 +3892,7 @@ stack), its contents should be set to 0 before calling this function. version="1.8"> Mapping of caps to SDP fields: + line="3795">Mapping of caps to SDP fields: a=rtpmap:(payload) (encoding_name) or (clock_rate)[or (encoding_params)] @@ -3904,18 +3904,18 @@ a=rtcp-fb:(payload) (param1) [param2]... a=extmap:(id)[/direction] (extensionname) (extensionattributes) + line="744"/> a #GstSDPResult. + line="3812">a #GstSDPResult. a #GstCaps + line="3797">a #GstCaps transfer-ownership="none"> a #GstSDPMedia + line="3798">a #GstSDPMedia @@ -4314,26 +4314,26 @@ gst_sdp_media_init() before it can be used again. version="1.8"> Mapping of attributes of #GstSDPMessage to #GstCaps + line="4582">Mapping of attributes of #GstSDPMessage to #GstCaps + line="756"/> a #GstSDPResult. + line="4589">a #GstSDPResult. a #GstSDPMessage + line="4584">a #GstSDPMessage a #GstCaps + line="4585">a #GstCaps @@ -4394,20 +4394,20 @@ gst_sdp_media_init() before it can be used again. Dump the parsed contents of @msg to stdout. + line="3295">Dump the parsed contents of @msg to stdout. + line="579"/> a #GstSDPResult. + line="3301">a #GstSDPResult. a #GstSDPMessage + line="3297">a #GstSDPMessage @@ -5105,21 +5105,21 @@ When -1 is given as @idx, the zone is inserted at the end. version="1.8.1"> Creates a new #GstMIKEYMessage after parsing the key-mgmt attribute + line="4180">Creates a new #GstMIKEYMessage after parsing the key-mgmt attribute from a #GstSDPMessage. + line="750"/> a #GstSDPResult. + line="4188">a #GstSDPResult. a #GstSDPMessage + line="4182">a #GstSDPMessage transfer-ownership="full"> pointer to new #GstMIKEYMessage + line="4183">pointer to new #GstMIKEYMessage @@ -5241,6 +5241,36 @@ from a #GstSDPMessage. + + Remove the media at @idx from the array of medias in @msg if found. + + + #GST_SDP_OK when the specified media is found at @idx and removed, +#GST_SDP_EINVAL otherwise. + + + + + a #GstSDPMessage + + + + the media index + + + + @@ -5976,21 +6006,21 @@ stack), its contents should be set to 0 before calling this function. c:identifier="gst_sdp_message_parse_buffer"> Parse the contents of @size bytes pointed to by @data and store the result in + line="3147">Parse the contents of @size bytes pointed to by @data and store the result in @msg. #GST_SDP_OK on success. + line="3156">#GST_SDP_OK on success. the start of the buffer + line="3149">the start of the buffer @@ -5998,13 +6028,13 @@ stack), its contents should be set to 0 before calling this function. the size of the buffer + line="3150">the size of the buffer the result #GstSDPMessage + line="3151">the result #GstSDPMessage @@ -6381,25 +6411,25 @@ messages. version="1.8"> Makes key management data - + line="4107">Makes key management data + a #gchar key-mgmt data, + line="4114">a #gchar key-mgmt data, a #gchar URI + line="4109">a #gchar URI a #gchar base64-encoded key data + line="4110">a #gchar base64-encoded key data @@ -6409,17 +6439,17 @@ messages. moved-to="SDPMedia.init"> Initialize @media so that its contents are as if it was freshly allocated + line="1844">Initialize @media so that its contents are as if it was freshly allocated with gst_sdp_media_new(). This function is mostly used to initialize a media allocated on the stack. gst_sdp_media_uninit() undoes this operation. When this function is invoked on newly allocated data (with malloc or on the stack), its contents should be set to 0 before calling this function. - + a #GstSDPResult. + line="1855">a #GstSDPResult. @@ -6429,7 +6459,7 @@ stack), its contents should be set to 0 before calling this function. transfer-ownership="none"> a #GstSDPMedia + line="1846">a #GstSDPMedia @@ -6439,12 +6469,12 @@ stack), its contents should be set to 0 before calling this function. moved-to="SDPMedia.new"> Allocate a new GstSDPMedia and store the result in @media. - + line="1822">Allocate a new GstSDPMedia and store the result in @media. + a #GstSDPResult. + line="1828">a #GstSDPResult. @@ -6454,7 +6484,7 @@ stack), its contents should be set to 0 before calling this function. transfer-ownership="full"> pointer to new #GstSDPMedia + line="1824">pointer to new #GstSDPMedia @@ -6465,7 +6495,7 @@ stack), its contents should be set to 0 before calling this function. version="1.8"> Mapping of caps to SDP fields: + line="3795">Mapping of caps to SDP fields: a=rtpmap:(payload) (encoding_name) or (clock_rate)[or (encoding_params)] @@ -6476,18 +6506,18 @@ a=fmtp:(payload) (param)[=(value)];... a=rtcp-fb:(payload) (param1) [param2]... a=extmap:(id)[/direction] (extensionname) (extensionattributes) - + a #GstSDPResult. + line="3812">a #GstSDPResult. a #GstCaps + line="3797">a #GstCaps transfer-ownership="none"> a #GstSDPMedia + line="3798">a #GstSDPMedia @@ -6625,20 +6655,20 @@ stack), its contents should be set to 0 before calling this function. moved-to="SDPMessage.parse_buffer"> Parse the contents of @size bytes pointed to by @data and store the result in + line="3147">Parse the contents of @size bytes pointed to by @data and store the result in @msg. #GST_SDP_OK on success. + line="3156">#GST_SDP_OK on success. the start of the buffer + line="3149">the start of the buffer @@ -6646,13 +6676,13 @@ stack), its contents should be set to 0 before calling this function. the size of the buffer + line="3150">the size of the buffer the result #GstSDPMessage + line="3151">the result #GstSDPMessage diff --git a/girs/GstVa-1.0.gir b/girs/GstVa-1.0.gir index 0f5533fb4..20e70479b 100644 --- a/girs/GstVa-1.0.gir +++ b/girs/GstVa-1.0.gir @@ -19,7 +19,7 @@ and/or use gtk-doc annotations. --> value="VAMemory" c:type="GST_ALLOCATOR_VASURFACE" version="1.22"> - + - + @@ -41,7 +41,7 @@ and/or use gtk-doc annotations. --> - + @@ -144,16 +144,16 @@ and/or use gtk-doc annotations. --> Flag indicating that we should map the VASurfaceID instead of to + line="86">Flag indicating that we should map the VASurfaceID instead of to system memory, so users can use libva primitives to operate with that surface. - + - + @@ -162,7 +162,7 @@ that surface. - + @@ -171,7 +171,7 @@ that surface. - + @@ -358,26 +358,26 @@ that surface. version="1.22"> Instanciate a new pooled #GstAllocator backed by VASurfaceID. + line="1724">Instanciate a new pooled #GstAllocator backed by VASurfaceID. + line="100"/> a #GstVaDisplay + line="1732">a #GstVaDisplay a #GstVaDisplay + line="1726">a #GstVaDisplay a #GArray + line="1727">a #GArray of valid #GstVideoFormat for surfaces in current VA context. @@ -390,20 +390,20 @@ that surface. version="1.22"> Allocate a new VASurfaceID backed #GstMemory. + line="1676">Allocate a new VASurfaceID backed #GstMemory. + line="103"/> a #GstMemory backed with a VASurfaceID; %NULL, otherwise. + line="1682">a #GstMemory backed with a VASurfaceID; %NULL, otherwise. a #GstAllocator + line="1678">a #GstAllocator @@ -413,9 +413,9 @@ that surface. version="1.22"> Removes all the memories in @allocator's pool. + line="1823">Removes all the memories in @allocator's pool. + line="111"/> @@ -423,7 +423,7 @@ that surface. a #GstAllocator + line="1825">a #GstAllocator @@ -433,13 +433,13 @@ that surface. version="1.22"> Gets current internal configuration of @allocator. + line="1962">Gets current internal configuration of @allocator. + line="118"/> %TRUE if @allocator is already configured; %FALSE + line="1972">%TRUE if @allocator is already configured; %FALSE otherwise. @@ -447,7 +447,7 @@ otherwise. a #GstAllocator + line="1964">a #GstAllocator allow-none="1"> a #GstVideoInfo + line="1965">a #GstVideoInfo allow-none="1"> VA usage hint + line="1966">VA usage hint allow-none="1"> a #GstVaFeature if derived images - are used for buffer mapping. - + line="1967">whether derived images are used for buffer + mapping. + @@ -490,11 +490,11 @@ otherwise. c:identifier="gst_va_allocator_peek_display" version="1.22"> + line="126"/> the display which this + line="2023">the display which this @allocator belongs to. The reference of the display is unchanged. @@ -502,7 +502,7 @@ otherwise. a #GstAllocator + line="2021">a #GstAllocator @@ -512,14 +512,14 @@ otherwise. version="1.22"> This method will populate @buffer with pooled VASurfaceID + line="1793">This method will populate @buffer with pooled VASurfaceID memories. It doesn't allocate new VASurfacesID. + line="108"/> %TRUE if @buffer was populated correctly; %FALSE + line="1801">%TRUE if @buffer was populated correctly; %FALSE otherwise. @@ -527,13 +527,13 @@ otherwise. a #GstAllocator + line="1795">a #GstAllocator an empty #GstBuffer + line="1796">an empty #GstBuffer @@ -543,7 +543,7 @@ otherwise. version="1.22"> Sets the configuration defined by @info, @usage_hint and + line="1903">Sets the configuration defined by @info, @usage_hint and @use_derived for @allocator, and it tries the configuration, if @allocator has not allocated memories yet. @@ -551,11 +551,11 @@ If @allocator has memory allocated already, and frame size and format in @info are the same as currently configured in @allocator, the rest of @info parameters are updated internally. + line="113"/> %TRUE if the configuration is valid or updated; %FALSE if + line="1918">%TRUE if the configuration is valid or updated; %FALSE if configuration is not valid or not updated. @@ -563,7 +563,7 @@ configuration is not valid or not updated. a #GstAllocator + line="1905">a #GstAllocator transfer-ownership="full"> a #GstVideoInfo + line="1906">a #GstVideoInfo VA usage hint + line="1907">VA usage hint - + a #GstVaFeature + line="1908">a #GstVaFeature @@ -595,9 +595,9 @@ configuration is not valid or not updated. introspectable="0"> Internal method to set allocator specific logic changes. + line="1999">Internal method to set allocator specific logic changes. + line="123"/> @@ -605,13 +605,13 @@ configuration is not valid or not updated. a #GstAllocator + line="2001">a #GstAllocator hacks id to set + line="2002">hacks id to set @@ -621,26 +621,26 @@ configuration is not valid or not updated. version="1.22"> Populates an empty @buffer with a VASuface backed #GstMemory. + line="1751">Populates an empty @buffer with a VASuface backed #GstMemory. + line="105"/> %TRUE if @buffer is populated; %FALSE otherwise. + line="1758">%TRUE if @buffer is populated; %FALSE otherwise. a #GstAllocator + line="1753">a #GstAllocator a #GstBuffer + line="1754">a #GstBuffer @@ -687,24 +687,55 @@ VADisplay. + + + + whether driver version is equal or greater than @major.@minor + + + + + a #GstVaDisplay + + + + major version to check + + + + minor version to check + + + + Get the the #GstVaImplementation type of @self. + line="436">Get the the #GstVaImplementation type of @self. #GstVaImplementation. + line="442">#GstVaImplementation. a #GstVaDisplay type display. + line="438">a #GstVaDisplay type display. @@ -714,19 +745,19 @@ VADisplay. version="1.20"> Get the VA display handle of the @self. + line="415">Get the VA display handle of the @self. the VA display handle. + line="421">the VA display handle. a #GstVaDisplay type display. + line="417">a #GstVaDisplay type display. @@ -736,7 +767,7 @@ VADisplay. version="1.20"> If the display is set by the user (foreign) it is assumed that the + line="359">If the display is set by the user (foreign) it is assumed that the driver is already initialized, thus this function is noop. If the display is opened internally, this function will initialize @@ -748,7 +779,7 @@ GstVaDisplay descendants. %TRUE if the VA driver can be initialized; %FALSE + line="372">%TRUE if the VA driver can be initialized; %FALSE otherwise @@ -756,7 +787,7 @@ GstVaDisplay descendants. a #GstVaDisplay + line="361">a #GstVaDisplay @@ -930,7 +961,7 @@ pipeline is not in NULL state. glib:get-type="gst_va_dmabuf_allocator_get_type"> A pooled memory allocator backed by the DMABufs exported from a + line="244">A pooled memory allocator backed by the DMABufs exported from a VASurfaceID. Also it is possible to import DMAbufs into a VASurfaceID. version="1.22"> Instanciate a new pooled allocator backed with both DMABuf and + line="459">Instanciate a new pooled allocator backed with both DMABuf and VASurfaceID. a new allocated #GstAllocator + line="466">a new allocated #GstAllocator a #GstVaDisplay + line="461">a #GstVaDisplay @@ -962,7 +993,7 @@ VASurfaceID. version="1.22"> Removes all the memories in @allocator's pool. + line="897">Removes all the memories in @allocator's pool. @@ -972,7 +1003,7 @@ VASurfaceID. a #GstAllocator + line="899">a #GstAllocator @@ -982,13 +1013,13 @@ VASurfaceID. version="1.22"> Gets current internal configuration of @allocator. + line="1010">Gets current internal configuration of @allocator. %TRUE if @allocator is already configured; %FALSE + line="1018">%TRUE if @allocator is already configured; %FALSE otherwise. @@ -996,7 +1027,7 @@ otherwise. a #GstAllocator + line="1012">a #GstAllocator allow-none="1"> a #GstVideoInfo - + line="1013">a #GstVideoInfoDmaDrm + allow-none="1"> VA usage hint + line="1014">VA usage hint @@ -1028,14 +1060,14 @@ otherwise. version="1.22"> This method will populate @buffer with pooled VASurfaceID/DMABuf + line="866">This method will populate @buffer with pooled VASurfaceID/DMABuf memories. It doesn't allocate new VASurfacesID. %TRUE if @buffer was populated correctly; %FALSE + line="874">%TRUE if @buffer was populated correctly; %FALSE otherwise. @@ -1043,13 +1075,13 @@ otherwise. a #GstAllocator + line="868">a #GstAllocator an empty #GstBuffer + line="869">an empty #GstBuffer @@ -1059,19 +1091,19 @@ otherwise. version="1.22"> Sets the configuration defined by @info and @usage_hint for + line="951">Sets the configuration defined by @info and @usage_hint for @allocator, and it tries the configuration, if @allocator has not allocated memories yet. -If @allocator has memory allocated already, and frame size and -format in @info are the same as currently configured in @allocator, -the rest of @info parameters are updated internally. +If @allocator has memory allocated already, and frame size, format +and modifier in @info are the same as currently configured in +@allocator, the rest of @info parameters are updated internally. %TRUE if the configuration is valid or updated; %FALSE if + line="965">%TRUE if the configuration is valid or updated; %FALSE if configuration is not valid or not updated. @@ -1079,19 +1111,23 @@ configuration is not valid or not updated. a #GstAllocator + line="953">a #GstAllocator - + a #GstVideoInfo - + line="954">a #GstVideoInfoDmaDrm + VA usage hint + line="955">VA usage hint @@ -1101,27 +1137,27 @@ configuration is not valid or not updated. version="1.22"> This funciton creates a new VASurfaceID and exposes its DMABufs, + line="765">This function creates a new VASurfaceID and exposes its DMABufs, later it populates the @buffer with those DMABufs. %TRUE if @buffer is populated correctly; %FALSE otherwise. + line="773">%TRUE if @buffer is populated correctly; %FALSE otherwise. a #GstAllocator + line="767">a #GstAllocator an empty #GstBuffer + line="768">an empty #GstBuffer @@ -1218,7 +1254,7 @@ the most widely used VA drivers. A new #GstBufferPool for VA allocators. + line="396">A new #GstBufferPool for VA allocators. @@ -1229,7 +1265,7 @@ the most widely used VA drivers. a new #GstBufferPool that handles VASurfacesID-backed + line="484">a new #GstBufferPool that handles VASurfacesID-backed buffers. If the pool cannot be configured correctly, %NULL is returned. @@ -1238,60 +1274,87 @@ the most widely used VA drivers. the #GstCaps of the buffers handled by the new pool. + line="475">the #GstCaps of the buffers handled by the new pool. - - the size of the frames to hold. - - minimum number of frames to create. + line="476">minimum number of frames to create. maximum number of frames to create. + line="477">maximum number of frames to create. VA usage hint + line="478">VA usage hint a #GstVaFeature for derived mapping (only used when + line="479">a #GstVaFeature for derived mapping (only used when VA allocator). the VA allocator to use. + line="481">the VA allocator to use. #GstAllocationParams to use. + line="482">#GstAllocationParams to use. + + Helper function to retrieve the VA surface size provided by @pool. + + + whether the surface size was retrieved. + + + + + a #GstBufferPool + + + + the declared surface size + + + + Retuns: %TRUE if @pool always add #GstVideoMeta to its + line="456">Retuns: %TRUE if @pool always add #GstVideoMeta to its buffers. Otherwise, %FALSE. @@ -1301,7 +1364,7 @@ the most widely used VA drivers. the #GstBufferPool + line="458">the #GstBufferPool @@ -1312,7 +1375,7 @@ the most widely used VA drivers. version="1.20.2"> Video alignment is not handled as expected by VA since it uses + line="432">Video alignment is not handled as expected by VA since it uses opaque surfaces, not directly mappable memory. Still, decoders might need to request bigger surfaces for coded size rather than display sizes. This method will set the coded size to bufferpool's @@ -1325,13 +1388,13 @@ configuration, out of the typical video aligment. the #GstStructure with the pool's configuration. + line="434">the #GstStructure with the pool's configuration. a #GstVideoAlignment + line="435">a #GstVideoAlignment @@ -1342,7 +1405,7 @@ configuration, out of the typical video aligment. version="1.22"> Sets the usage hint for the buffers handled by the buffer pool. + line="413">Sets the usage hint for the buffers handled by the buffer pool. @@ -1351,19 +1414,19 @@ configuration, out of the typical video aligment. the #GstStructure with the pool's configuration. + line="415">the #GstStructure with the pool's configuration. the VA usage hint for new VASurfaceID. + line="416">the VA usage hint for new VASurfaceID. a #GstVaFeature for derived mapping (only used when + line="417">a #GstVaFeature for derived mapping (only used when VA allocator). @@ -1376,26 +1439,26 @@ configuration, out of the typical video aligment. whether we find a valid @display in the @context + line="363">whether we find a valid @display in the @context a #GstContext may contain the display + line="358">a #GstContext may contain the display a #gchar string of the element type + line="359">a #gchar string of the element type the #gchar string of render device path + line="360">the #gchar string of render device path transfer-ownership="full"> the #GstVaDisplay we get + line="361">the #GstVaDisplay we get @@ -1414,7 +1477,7 @@ configuration, out of the typical video aligment. version="1.22"> Set the @display in the @context + line="427">Set the @display in the @context @@ -1423,13 +1486,13 @@ configuration, out of the typical video aligment. a #GstContext + line="429">a #GstContext the #GstVaDisplay we want to set + line="430">the #GstVaDisplay we want to set @@ -1439,15 +1502,15 @@ configuration, out of the typical video aligment. version="1.22"> Creates a new VASurfaceID with @buffer's allocator and attached it + line="2121">Creates a new VASurfaceID with @buffer's allocator and attached it to it. *This method is used only by plugin's internal VA decoder.* - + %TRUE if the new VASurfaceID is attached to @buffer + line="2130">%TRUE if the new VASurfaceID is attached to @buffer correctly; %FALSE, otherwise. @@ -1455,7 +1518,7 @@ to it. a #GstBuffer + line="2123">a #GstBuffer @@ -1464,11 +1527,11 @@ to it. c:identifier="gst_va_buffer_get_aux_surface" version="1.22" introspectable="0"> - + the VASurfaceID attached to + line="2213">the VASurfaceID attached to @buffer. @@ -1476,7 +1539,7 @@ to it. a #GstBuffer + line="2211">a #GstBuffer @@ -1485,18 +1548,18 @@ to it. c:identifier="gst_va_buffer_get_surface" version="1.22" introspectable="0"> - + the VASurfaceID in @buffer. + line="2105">the VASurfaceID in @buffer. a #GstBuffer + line="2103">a #GstBuffer @@ -1504,11 +1567,11 @@ to it. - + the display which this + line="2244">the display which this @buffer belongs to. The reference of the display is unchanged. @@ -1516,7 +1579,7 @@ to it. a #GstBuffer + line="2242">a #GstBuffer @@ -1526,7 +1589,7 @@ to it. version="1.22"> Query the specified context type name. + line="111">Query the specified context type name. @@ -1535,29 +1598,63 @@ to it. a #GstElement + line="113">a #GstElement the #gchar string specify the context type name + line="114">the #gchar string specify the context type name + + Get the underlying modifier for specified @format and @usage_hint. + + + the underlying modifier. + + + + + a #GstVaDisplay + + + + a #GstVideoFormat + + + + VA usage hint + + + + It imports the array of @mem, representing a single frame, into a + line="1060">It imports the array of @mem, representing a single frame, into a VASurfaceID and it's attached into every @mem. %TRUE if frame is imported correctly into a VASurfaceID; + line="1075">%TRUE if frame is imported correctly into a VASurfaceID; %FALSE otherwise. @@ -1565,25 +1662,19 @@ VASurfaceID and it's attached into every @mem. a #GstVaDisplay + line="1062">a #GstVaDisplay - + a #GstVideoInfo - - - - number of planes - + line="1063">a #GstVideoInfoDmaDrm + Memories. One + line="1064">Memories. One per plane. @@ -1592,16 +1683,16 @@ VASurfaceID and it's attached into every @mem. array of + line="1066">array of DMABuf file descriptors. - + array of memory + line="1068">array of memory offsets. @@ -1610,7 +1701,7 @@ VASurfaceID and it's attached into every @mem. VA usage hint. + line="1070">VA usage hint. @@ -1620,7 +1711,7 @@ VASurfaceID and it's attached into every @mem. version="1.22"> Propagate @display by posting it as #GstContext in the pipeline's bus. + line="168">Propagate @display by posting it as #GstContext in the pipeline's bus. @@ -1629,13 +1720,13 @@ VASurfaceID and it's attached into every @mem. a #GstElement + line="170">a #GstElement the #GstVaDisplay to propagate + line="171">the #GstVaDisplay to propagate @@ -1645,12 +1736,12 @@ VASurfaceID and it's attached into every @mem. version="1.22"> Called by the va element to ensure a valid #GstVaDisplay. + line="203">Called by the va element to ensure a valid #GstVaDisplay. whether a #GstVaDisplay exists in @display_ptr + line="211">whether a #GstVaDisplay exists in @display_ptr @@ -1660,13 +1751,13 @@ VASurfaceID and it's attached into every @mem. allow-none="1"> a #GstElement + line="205">a #GstElement the #gchar string of render device path + line="206">the #gchar string of render device path transfer-ownership="full"> The #GstVaDisplay to ensure + line="207">The #GstVaDisplay to ensure @@ -1685,32 +1776,32 @@ VASurfaceID and it's attached into every @mem. version="1.22"> Used by elements when processing their pad's queries, propagating + line="306">Used by elements when processing their pad's queries, propagating element's #GstVaDisplay if the processed query requests it. whether we can handle the context query successfully + line="315">whether we can handle the context query successfully a #GstElement + line="308">a #GstElement a #GstQuery to query the context + line="309">a #GstQuery to query the context a #GstVaDisplay to answer the query + line="310">a #GstVaDisplay to answer the query @@ -1720,13 +1811,13 @@ element's #GstVaDisplay if the processed query requests it. version="1.22"> Called by elements in their #GstElementClass::set_context vmethod. + line="256">Called by elements in their #GstElementClass::set_context vmethod. It gets a valid #GstVaDisplay if @context has it. whether the @display_ptr could be successfully set to a + line="266">whether the @display_ptr could be successfully set to a valid #GstVaDisplay in the @context @@ -1734,19 +1825,19 @@ valid #GstVaDisplay in the @context a #GstElement + line="258">a #GstElement a #GstContext may contain the display + line="259">a #GstContext may contain the display the #gchar string of render device path + line="260">the #gchar string of render device path transfer-ownership="full"> The #GstVaDisplay to set + line="261">The #GstVaDisplay to set @@ -1764,18 +1855,18 @@ valid #GstVaDisplay in the @context c:identifier="gst_va_memory_get_surface" version="1.22" introspectable="0"> - + the VASurfaceID in @mem. + line="2049">the VASurfaceID in @mem. a #GstMemory + line="2047">a #GstMemory @@ -1783,11 +1874,11 @@ valid #GstVaDisplay in the @context - + the display which + line="2080">the display which this @mem belongs to. The reference of the display is unchanged. @@ -1795,7 +1886,7 @@ valid #GstVaDisplay in the @context a #GstMemory + line="2078">a #GstMemory diff --git a/girs/GstValidate-1.0.gir b/girs/GstValidate-1.0.gir index 18d0e44a7..60753baad 100644 --- a/girs/GstValidate-1.0.gir +++ b/girs/GstValidate-1.0.gir @@ -147,7 +147,7 @@ Only access it from the default main context. A newly created #GstValidateAction + line="542">A newly created #GstValidateAction @@ -157,25 +157,25 @@ Only access it from the default main context. allow-none="1"> The scenario executing the action + line="537">The scenario executing the action The action type + line="538">The action type The structure containing the action arguments + line="539">The structure containing the action arguments Weather the action should be added to the scenario action list + line="540">Weather the action should be added to the scenario action list @@ -184,20 +184,20 @@ Only access it from the default main context. c:identifier="gst_validate_action_get_scenario"> Retrieve the scenario from which @action is executed. + line="7277">Retrieve the scenario from which @action is executed. The scenario from which the action is being executed. + line="7283">The scenario from which the action is being executed. The action for which to retrieve the scenario + line="7279">The action for which to retrieve the scenario @@ -242,39 +242,39 @@ Only access it from the default main context. c:identifier="gst_validate_action_get_clocktime"> Get a time value for the @name parameter of an action. This + line="906">Get a time value for the @name parameter of an action. This method should be called to retrieve and compute a timed value of a given action. It will first try to retrieve the value as a double, then get it as a string and execute any formula taking into account the 'position' and 'duration' variables. And it will always convert that value to a GstClockTime. + line="406"/> %TRUE if the time value could be retrieved/computed or %FALSE otherwise + line="922">%TRUE if the time value could be retrieved/computed or %FALSE otherwise The #GstValidateScenario from which to get a time + line="908">The #GstValidateScenario from which to get a time for a parameter of an action The action from which to retrieve the time for @name + line="910">The action from which to retrieve the time for @name parameter. The name of the parameter for which to retrieve a time + line="912">The name of the parameter for which to retrieve a time transfer-ownership="full"> The return value for the wanted time + line="913">The return value for the wanted time @@ -291,7 +291,7 @@ value to a GstClockTime. + line="332"/> for mandatory streams. + + Function that frees the various members of the structure when done using + + - + @@ -1087,32 +1093,32 @@ Class that wraps a #GstElement for Validate checks The newly created #GstValidateIssue + line="274">The newly created #GstValidateIssue The ID of the issue, should be a GQuark + line="269">The ID of the issue, should be a GQuark A summary of the issue + line="270">A summary of the issue A more complete description of the issue + line="271">A more complete description of the issue The level at which the issue will be reported by default + line="272">The level at which the issue will be reported by default @@ -1123,38 +1129,38 @@ Class that wraps a #GstElement for Validate checks The newly created #GstValidateIssue + line="236">The newly created #GstValidateIssue The ID of the issue, should be a GQuark + line="230">The ID of the issue, should be a GQuark A summary of the issue + line="231">A summary of the issue A more complete description of the issue + line="232">A more complete description of the issue The level at which the issue will be reported by default + line="233">The level at which the issue will be reported by default The flags to determine behaviour of the issue + line="234">The flags to determine behaviour of the issue @@ -1174,7 +1180,7 @@ Class that wraps a #GstElement for Validate checks Registers @issue in the issue type system + line="315">Registers @issue in the issue type system @@ -1184,7 +1190,7 @@ Class that wraps a #GstElement for Validate checks The #GstValidateIssue to register + line="317">The #GstValidateIssue to register @@ -1211,14 +1217,14 @@ Class that wraps a #GstElement for Validate checks The issue if found or NULL otherwise + line="754">The issue if found or NULL otherwise The issue id + line="752">The issue id @@ -2472,6 +2478,32 @@ target is in. + + + The property is optional, if it +is not found on the object, nothing happens. + + + Do not check that after +setting the property, the value is the one we set. + + A #GstValidatePipelineMonitor + line="887">A #GstValidatePipelineMonitor a #GstPipeline to run Validate on + line="883">a #GstPipeline to run Validate on a #GstValidateRunner + line="884">a #GstValidateRunner allow-none="1"> The parent of the new monitor + line="885">The parent of the new monitor @@ -3786,7 +3818,7 @@ as the source of that issue. report dot file name + line="220">report dot file name @@ -3803,7 +3835,7 @@ as the source of that issue. report issue + line="185">report issue @@ -3833,7 +3865,7 @@ as the source of that issue. report level + line="164">report level @@ -3850,7 +3882,7 @@ as the source of that issue. report message + line="199">report message @@ -3867,7 +3899,7 @@ as the source of that issue. report reporter + line="192">report reporter @@ -3884,7 +3916,7 @@ as the source of that issue. report issue + line="206">report issue @@ -3901,7 +3933,7 @@ as the source of that issue. reporting level + line="178">reporting level @@ -3918,7 +3950,7 @@ as the source of that issue. report timestamp + line="171">report timestamp @@ -3935,7 +3967,7 @@ as the source of that issue. report backtrace + line="213">report backtrace @@ -4745,13 +4777,13 @@ Class that manages a Validate test run for some pipeline Create a new #GstValidateRunner + line="464">Create a new #GstValidateRunner A newly created #GstValidateRunner + line="469">A newly created #GstValidateRunner @@ -4821,7 +4853,7 @@ Class that manages a Validate test run for some pipeline The list of reports + line="785">The list of reports @@ -4830,7 +4862,7 @@ Class that manages a Validate test run for some pipeline The #GstValidateRunner + line="783">The #GstValidateRunner @@ -4839,20 +4871,20 @@ Class that manages a Validate test run for some pipeline c:identifier="gst_validate_runner_get_reports_count"> Get the number of reports present in the runner: + line="753">Get the number of reports present in the runner: The number of reports present in the runner. + line="759">The number of reports present in the runner. The #GstValidateRunner to get the number of reports from + line="755">The #GstValidateRunner to get the number of reports from @@ -4860,14 +4892,14 @@ Class that manages a Validate test run for some pipeline Prints all the reports on the terminal or on wherever is set + line="851">Prints all the reports on the terminal or on wherever is set in the `GST_VALIDATE_FILE` env variable. 0 if no critical error has been found and 18 if a critical + line="858">0 if no critical error has been found and 18 if a critical error has been detected. That return value is usually to be used as exit code of the application. @@ -4876,7 +4908,7 @@ exit code of the application. The #GstValidateRunner to print all the reports for + line="853">The #GstValidateRunner to print all the reports for @@ -4946,7 +4978,7 @@ exit code of the application. c:identifier="GST_VALIDATE_SCENARIO_EOS_HANDLING_LOCK" introspectable="0"> + line="369"/> @@ -4956,7 +4988,7 @@ exit code of the application. c:identifier="GST_VALIDATE_SCENARIO_EOS_HANDLING_UNLOCK" introspectable="0"> + line="370"/> @@ -4970,11 +5002,11 @@ exit code of the application. glib:get-type="gst_validate_scenario_get_type" glib:type-struct="ScenarioClass"> + line="341"/> + line="435"/> @@ -4982,30 +5014,30 @@ exit code of the application. + line="376"/> A #GstValidateScenario or NULL + line="6056">A #GstValidateScenario or NULL The #GstValidateRunner to use to report issues + line="6052">The #GstValidateRunner to use to report issues The pipeline to run the scenario on + line="6053">The pipeline to run the scenario on The name (or path) of the scenario to run + line="6054">The name (or path) of the scenario to run @@ -5014,72 +5046,72 @@ exit code of the application. c:identifier="gst_validate_scenario_execute_seek"> Executes a seek event on the scenario's pipeline. You should always use + line="1102">Executes a seek event on the scenario's pipeline. You should always use this method when you want to execute a seek inside a new action type so that the scenario state is updated taking into account that seek. For more information you should have a look at #gst_event_new_seek + line="412"/> %TRUE if the seek could be executed, %FALSE otherwise + line="1120">%TRUE if the seek could be executed, %FALSE otherwise The #GstValidateScenario for which to execute a seek action + line="1104">The #GstValidateScenario for which to execute a seek action The seek action to execute + line="1105">The seek action to execute The playback rate of the seek + line="1106">The playback rate of the seek The #GstFormat of the seek + line="1107">The #GstFormat of the seek The #GstSeekFlags of the seek + line="1108">The #GstSeekFlags of the seek The #GstSeekType of the start value of the seek + line="1109">The #GstSeekType of the start value of the seek The start time of the seek + line="1110">The start time of the seek The #GstSeekType of the stop value of the seek + line="1111">The #GstSeekType of the stop value of the seek The stop time of the seek + line="1112">The stop time of the seek @@ -5088,13 +5120,13 @@ For more information you should have a look at #gst_event_new_seek c:identifier="gst_validate_scenario_get_actions"> Get remaining actions from @scenario. + line="7496">Get remaining actions from @scenario. + line="423"/> A list of #GstValidateAction. + line="7502">A list of #GstValidateAction. @@ -5103,7 +5135,7 @@ For more information you should have a look at #gst_event_new_seek The scenario to retrieve remaining actions for + line="7498">The scenario to retrieve remaining actions for @@ -5111,11 +5143,11 @@ For more information you should have a look at #gst_event_new_seek + line="432"/> The #GstPipeline the scenario is running + line="330">The #GstPipeline the scenario is running against @@ -5123,7 +5155,7 @@ against The scenario to retrieve a pipeline from + line="328">The scenario to retrieve a pipeline from @@ -5132,20 +5164,20 @@ against c:identifier="gst_validate_scenario_get_target_state"> Get current target state from @scenario. + line="7521">Get current target state from @scenario. + line="429"/> Current target state. + line="7527">Current target state. The scenario to retrieve the current target state for + line="7523">The scenario to retrieve the current target state for @@ -5187,7 +5219,7 @@ against Emitted when an action is done. + line="5653">Emitted when an action is done. @@ -5195,7 +5227,7 @@ against The #GstValidateAction that is done running + line="5656">The #GstValidateAction that is done running @@ -5203,7 +5235,7 @@ against Emitted once all actions have been executed + line="5643">Emitted once all actions have been executed @@ -5213,7 +5245,7 @@ against c:type="GstValidateScenarioClass" glib:is-gtype-struct-for="Scenario"> + line="341"/> @@ -5347,39 +5379,39 @@ against moved-to="Action.get_clocktime"> Get a time value for the @name parameter of an action. This + line="906">Get a time value for the @name parameter of an action. This method should be called to retrieve and compute a timed value of a given action. It will first try to retrieve the value as a double, then get it as a string and execute any formula taking into account the 'position' and 'duration' variables. And it will always convert that value to a GstClockTime. + line="406"/> %TRUE if the time value could be retrieved/computed or %FALSE otherwise + line="922">%TRUE if the time value could be retrieved/computed or %FALSE otherwise The #GstValidateScenario from which to get a time + line="908">The #GstValidateScenario from which to get a time for a parameter of an action The action from which to retrieve the time for @name + line="910">The action from which to retrieve the time for @name parameter. The name of the parameter for which to retrieve a time + line="912">The name of the parameter for which to retrieve a time transfer-ownership="full"> The return value for the wanted time + line="913">The return value for the wanted time @@ -5433,14 +5465,14 @@ value to a GstClockTime. c:identifier="gst_validate_element_matches_target"> Check if @element matches one of the 'target-element-name', + line="1184">Check if @element matches one of the 'target-element-name', 'target-element-klass' or 'target-element-factory-name' defined in @s. + line="89"/> %TRUE if it matches, %FALSE otherwise or if @s doesn't contain any + line="1192">%TRUE if it matches, %FALSE otherwise or if @s doesn't contain any target-element field. @@ -5448,13 +5480,13 @@ target-element field. a #GstElement to check + line="1186">a #GstElement to check a #GstStructure to use for matching + line="1187">a #GstStructure to use for matching @@ -5485,9 +5517,9 @@ target-element field. Executes @action + line="2845">Executes @action + line="425"/> @@ -5495,13 +5527,13 @@ target-element field. The #GstValidateActionType to execute + line="2847">The #GstValidateActionType to execute The #GstValidateAction to execute + line="2848">The #GstValidateAction to execute @@ -5509,7 +5541,7 @@ target-element field. + line="98"/> @@ -5517,7 +5549,7 @@ target-element field. + line="385"/> @@ -5603,7 +5635,7 @@ Possible configurations (see [GST_VALIDATE_CONFIG](gst-validate-environment-vari + line="99"/> @@ -5639,21 +5671,21 @@ function. The issue if found or NULL otherwise + line="754">The issue if found or NULL otherwise The issue id + line="752">The issue id + line="380"/> @@ -5726,6 +5758,48 @@ function. + + + + + + + + The #GstValidateReporter to use to report errors + + + + The #GObject to set the property on + + + + The name of the property to set + + + + The value to set the property to + + + + The #GstValidateObjectSetPropertyFlags to use + + + + @@ -5786,7 +5860,7 @@ is #NULL Print @message to the GstValidate logging system + line="993">Print @message to the GstValidate logging system @@ -5799,13 +5873,13 @@ is #NULL allow-none="1"> The source object to log + line="995">The source object to log The message to print out in the GstValidate logging system + line="996">The message to print out in the GstValidate logging system @@ -5814,20 +5888,20 @@ is #NULL c:identifier="gst_validate_print_action_types"> Prints the action types details wanted in @wanted_types + line="7434">Prints the action types details wanted in @wanted_types True if all types could be printed + line="7441">True if all types could be printed (optional): List of types to be printed + line="7436">(optional): List of types to be printed @@ -5835,7 +5909,7 @@ is #NULL Length of @wanted_types + line="7437">Length of @wanted_types @@ -5918,14 +5992,14 @@ is #NULL c:identifier="gst_validate_register_action_type"> Register a new action type to the action type system. If the action type already + line="7291">Register a new action type to the action type system. If the action type already exists, it will be overridden by the new definition + line="388"/> The newly created action type or the already registered action type + line="7306">The newly created action type or the already registered action type if it had a higher rank @@ -5933,13 +6007,13 @@ if it had a higher rank The name of the new action type to add + line="7293">The name of the new action type to add The namespace of the implementer of the action type. + line="7294">The namespace of the implementer of the action type. That should always be the name of the GstPlugin as retrieved with #gst_plugin_get_name when the action type is registered inside a plugin. @@ -5948,7 +6022,7 @@ if it had a higher rank The function to be called to execute the action + line="7298">The function to be called to execute the action allow-none="1"> The #GstValidateActionParameter usable as parameter of the type + line="7299">The #GstValidateActionParameter usable as parameter of the type @@ -5965,13 +6039,13 @@ if it had a higher rank A description of the new type + line="7300">A description of the new type The #GstValidateActionTypeFlags to set on the new action type + line="7301">The #GstValidateActionTypeFlags to set on the new action type @@ -5979,11 +6053,11 @@ if it had a higher rank + line="396"/> The newly created action type or the already registered action type + line="7348">The newly created action type or the already registered action type if it had a higher rank @@ -5994,20 +6068,20 @@ if it had a higher rank allow-none="1"> The #GstPlugin that register the action type, + line="7334">The #GstPlugin that register the action type, or NULL for a static element. The name of the new action type to add + line="7342">The name of the new action type to add The ranking of that implementation of the action type called + line="7336">The ranking of that implementation of the action type called @type_name. If an action type has been registered with the same name with a higher rank, the new implementation will not be used, and the already registered action type is returned. @@ -6018,7 +6092,7 @@ if it had a higher rank The function to be called to execute the action + line="7343">The function to be called to execute the action allow-none="1"> The #GstValidateActionParameter usable as parameter of the type + line="7344">The #GstValidateActionParameter usable as parameter of the type @@ -6035,13 +6109,13 @@ if it had a higher rank A description of the new type + line="7345">A description of the new type The #GstValidateActionTypeFlags to be set on the new action type + line="7346">The #GstValidateActionTypeFlags to be set on the new action type @@ -6049,7 +6123,7 @@ if it had a higher rank + line="90"/> @@ -6152,7 +6226,7 @@ You can also use #GST_VALIDATE_REPORT instead. + line="96"/> @@ -6197,7 +6271,7 @@ You can also use #GST_VALIDATE_REPORT instead. + line="86"/> @@ -6225,7 +6299,7 @@ You can also use #GST_VALIDATE_REPORT instead. + line="93"/> @@ -6251,7 +6325,7 @@ You can also use #GST_VALIDATE_REPORT instead. + line="95"/> @@ -6368,7 +6442,7 @@ it can be a gint, gint64 a guint, a gint64. An array of strings from the GstValueList defined in @fieldname + line="1474">An array of strings from the GstValueList defined in @fieldname @@ -6377,13 +6451,13 @@ it can be a gint, gint64 a guint, a gint64. A GstStructure + line="1471">A GstStructure A fieldname containing a GstValueList or is not defined + line="1472">A fieldname containing a GstValueList or is not defined diff --git a/girs/GstVideo-1.0.gir b/girs/GstVideo-1.0.gir index 0b4edcc8e..8bbdd5ab9 100644 --- a/girs/GstVideo-1.0.gir +++ b/girs/GstVideo-1.0.gir @@ -15,6 +15,125 @@ and/or use gtk-doc annotations. --> shared-library="libgstvideo-1.0.so.0" c:identifier-prefixes="Gst" c:symbol-prefixes="gst"> + + #GstMeta for carrying SMPTE-291M Ancillary data. Note that all the ADF fields + (@DID to @checksum) are 10bit values with parity/non-parity high-bits set. + + + Parent #GstMeta + + + + The field where the ancillary data is located + + + + Which channel (luminance or chrominance) the ancillary + data is located. 0 if content is SD or stored in the luminance channel + (default). 1 if HD and stored in the chrominance channel. + + + + The line on which the ancillary data is located (max 11bit). There + are two special values: 0x7ff if no line is specified (default), 0x7fe + to specify the ancillary data is on any valid line before active video + + + + The location of the ancillary data packet in a SDI raster relative + to the start of active video (max 12bits). A value of 0 means the ADF of + the ancillary packet starts immediately following SAV. There are 3 + special values: 0xfff: No specified location (default), 0xffe: within + HANC data space, 0xffd: within the ancillary data space located between + SAV and EAV + + + + Data Identified + + + + Secondary Data identification (if type 2) or Data block + number (if type 1) + + + + The amount of user data + + + + The User data + + + + The checksum of the ADF + + + + + + + + + + + Location of a @GstAncillaryMeta. + + Progressive or no field specified (default) + + + Interlaced first field + + + Interlaced second field + + @@ -41,13 +160,13 @@ When this option is enabled on the bufferpool, version="1.2.2"> An option that can be activated on a bufferpool to request gl texture upload + line="241">An option that can be activated on a bufferpool to request gl texture upload meta on buffers from the pool. When this option is enabled on the bufferpool, @GST_BUFFER_POOL_OPTION_VIDEO_META should also be enabled. + line="252"/> + line="239"/> + default handler for value changed notification @@ -568,6 +690,9 @@ for modifying the color balance implemented by an element providing the + default handler for value changed notification @@ -605,6 +730,9 @@ for modifying the color balance implemented by an element providing the + list handled channels @@ -630,6 +758,9 @@ for modifying the color balance implemented by an element providing the + set a channel value @@ -660,6 +791,9 @@ for modifying the color balance implemented by an element providing the + get a channel value @@ -687,6 +821,9 @@ for modifying the color balance implemented by an element providing the + implementation type @@ -707,6 +844,9 @@ for modifying the color balance implemented by an element providing the + default handler for value changed notification @@ -3209,6 +3349,9 @@ from the event. + sending a navigation event @@ -3226,6 +3369,9 @@ from the event. + sending a navigation event (Since: 1.22) @@ -3732,14 +3878,14 @@ Apple, CapsLock or ShiftLock. introspectable="0"> Generic caps string for video, for use in pad templates. + line="1178">Generic caps string for video, for use in pad templates. + line="1151"/> string format that describes the pixel layout, as string + line="1180">string format that describes the pixel layout, as string (e.g. "I420", "RGB", "YV12", "YUY2", "AYUV", etc.) @@ -3750,20 +3896,20 @@ Apple, CapsLock or ShiftLock. introspectable="0"> Generic caps string for video, for use in pad templates. + line="1192">Generic caps string for video, for use in pad templates. + line="1169"/> Requires caps features as a string, e.g. + line="1196">Requires caps features as a string, e.g. "memory:SystemMemory". string format that describes the pixel layout, as string + line="1194">string format that describes the pixel layout, as string (e.g. "I420", "RGB", "YV12", "YUY2", "AYUV", etc.) @@ -4060,49 +4206,49 @@ detect such a synchronization point. + line="686"/> + line="683"/> + line="682"/> + line="689"/> + line="690"/> + line="681"/> + line="677"/> + line="678"/> + line="676"/> + + Generic caps string for video wit DMABuf(GST_CAPS_FEATURE_MEMORY_DMABUF) +feature, for use in pad templates. As drm-format is supposed to be defined +at run-time it's not predefined here. + + + @@ -4809,11 +4968,11 @@ return to upstream/caller (indicating either GST_FLOW_ERROR or GST_FLOW_OK). List of all video formats, for use in template caps strings. + line="1140">List of all video formats, for use in template caps strings. Formats are sorted by decreasing "quality", using these criteria by priority: - number of components @@ -4829,14 +4988,65 @@ Formats are sorted by decreasing "quality", using these criteria by priority: - prefer I420 over YV12 - format name + line="1125"/> + + + + Declare all video formats as a string. + +Formats are sorted by decreasing "quality", using these criteria by priority: + - number of components + - depth + - subsampling factor of the width + - subsampling factor of the height + - number of planes + - native endianness preferred + - pixel stride + - poffset + - prefer non-complex formats + - prefer YUV formats over RGB ones + - prefer I420 over YV12 + - format name + + + + + This is similar to %GST_VIDEO_FORMATS_ALL but includes formats like DMA_DRM +that do not have a software converter. This should be used for passthrough +template caps. + + + + + This is similar to %GST_VIDEO_FORMATS_ALL_STR but includes formats like +DMA_DRM for which no software converter exists. This should be used for +passthrough template caps. + + line="898"/> @@ -4846,7 +5056,7 @@ Formats are sorted by decreasing "quality", using these criteria by priority: c:identifier="GST_VIDEO_FORMAT_INFO_DATA" introspectable="0"> + line="949"/> @@ -4860,7 +5070,7 @@ Formats are sorted by decreasing "quality", using these criteria by priority: c:identifier="GST_VIDEO_FORMAT_INFO_DEPTH" introspectable="0"> + line="901"/> @@ -4872,7 +5082,7 @@ Formats are sorted by decreasing "quality", using these criteria by priority: c:identifier="GST_VIDEO_FORMAT_INFO_FLAGS" introspectable="0"> + line="874"/> @@ -4882,7 +5092,7 @@ Formats are sorted by decreasing "quality", using these criteria by priority: c:identifier="GST_VIDEO_FORMAT_INFO_FORMAT" introspectable="0"> + line="872"/> @@ -4892,7 +5102,7 @@ Formats are sorted by decreasing "quality", using these criteria by priority: c:identifier="GST_VIDEO_FORMAT_INFO_HAS_ALPHA" introspectable="0"> + line="879"/> @@ -4902,7 +5112,7 @@ Formats are sorted by decreasing "quality", using these criteria by priority: c:identifier="GST_VIDEO_FORMAT_INFO_HAS_PALETTE" introspectable="0"> + line="881"/> @@ -4914,16 +5124,16 @@ Formats are sorted by decreasing "quality", using these criteria by priority: introspectable="0"> This macro checks if %GST_VIDEO_FORMAT_FLAG_SUBTILES is set. When this + line="884">This macro checks if %GST_VIDEO_FORMAT_FLAG_SUBTILES is set. When this flag is set, it means that the tile sizes must be scaled as per the subsampling. + line="896"/> a #GstVideoFormatInfo + line="886">a #GstVideoFormatInfo @@ -4931,7 +5141,7 @@ subsampling. c:identifier="GST_VIDEO_FORMAT_INFO_H_SUB" introspectable="0"> + line="941"/> @@ -4943,7 +5153,7 @@ subsampling. c:identifier="GST_VIDEO_FORMAT_INFO_IS_COMPLEX" introspectable="0"> + line="882"/> @@ -4953,7 +5163,7 @@ subsampling. c:identifier="GST_VIDEO_FORMAT_INFO_IS_GRAY" introspectable="0"> + line="878"/> @@ -4963,7 +5173,7 @@ subsampling. c:identifier="GST_VIDEO_FORMAT_INFO_IS_LE" introspectable="0"> + line="880"/> @@ -4973,7 +5183,7 @@ subsampling. c:identifier="GST_VIDEO_FORMAT_INFO_IS_RGB" introspectable="0"> + line="877"/> @@ -4983,7 +5193,7 @@ subsampling. c:identifier="GST_VIDEO_FORMAT_INFO_IS_TILED" introspectable="0"> + line="883"/> @@ -4995,10 +5205,10 @@ subsampling. introspectable="0"> Tests that the given #GstVideoFormatInfo represents a valid un-encoded + line="861">Tests that the given #GstVideoFormatInfo represents a valid un-encoded format. + line="869"/> @@ -5008,7 +5218,7 @@ format. c:identifier="GST_VIDEO_FORMAT_INFO_IS_YUV" introspectable="0"> + line="876"/> @@ -5018,7 +5228,7 @@ format. c:identifier="GST_VIDEO_FORMAT_INFO_NAME" introspectable="0"> + line="873"/> @@ -5028,7 +5238,7 @@ format. c:identifier="GST_VIDEO_FORMAT_INFO_N_COMPONENTS" introspectable="0"> + line="899"/> @@ -5039,7 +5249,7 @@ format. introspectable="0"> Number of planes. This is the number of planes the pixel layout is + line="917">Number of planes. This is the number of planes the pixel layout is organized in in memory. The number of planes can be less than the number of components (e.g. Y,U,V,A or R, G, B, A) when multiple components are packed into one plane. @@ -5047,12 +5257,12 @@ components are packed into one plane. Examples: RGB/RGBx/RGBA: 1 plane, 3/3/4 components; I420: 3 planes, 3 components; NV21/NV12: 2 planes, 3 components. + line="929"/> a #GstVideoFormatInfo + line="919">a #GstVideoFormatInfo @@ -5060,7 +5270,7 @@ I420: 3 planes, 3 components; NV21/NV12: 2 planes, 3 components. c:identifier="GST_VIDEO_FORMAT_INFO_OFFSET" introspectable="0"> + line="963"/> @@ -5075,20 +5285,20 @@ I420: 3 planes, 3 components; NV21/NV12: 2 planes, 3 components. introspectable="0"> Plane number where the given component can be found. A plane may + line="930">Plane number where the given component can be found. A plane may contain data for multiple components. + line="938"/> a #GstVideoFormatInfo + line="932">a #GstVideoFormatInfo the component index + line="933">the component index @@ -5096,7 +5306,7 @@ contain data for multiple components. c:identifier="GST_VIDEO_FORMAT_INFO_POFFSET" introspectable="0"> + line="939"/> @@ -5109,7 +5319,7 @@ contain data for multiple components. introspectable="0"> pixel stride for the given component. This is the amount of bytes to the + line="902">pixel stride for the given component. This is the amount of bytes to the pixel immediately to the right, so basically bytes from one pixel to the next. When bits < 8, the stride is expressed in bits. @@ -5118,17 +5328,17 @@ would be 4 bytes for RGBx or ARGB, and 8 bytes for ARGB64 or AYUV64. For planar formats such as I420 the pixel stride is usually 1. For YUY2 it would be 2 bytes. + line="916"/> a #GstVideoFormatInfo + line="904">a #GstVideoFormatInfo the component index + line="905">the component index @@ -5136,7 +5346,7 @@ YUY2 it would be 2 bytes. c:identifier="GST_VIDEO_FORMAT_INFO_SCALE_HEIGHT" introspectable="0"> + line="947"/> @@ -5150,7 +5360,7 @@ YUY2 it would be 2 bytes. c:identifier="GST_VIDEO_FORMAT_INFO_SCALE_WIDTH" introspectable="0"> + line="946"/> @@ -5164,7 +5374,7 @@ YUY2 it would be 2 bytes. c:identifier="GST_VIDEO_FORMAT_INFO_SHIFT" introspectable="0"> + line="900"/> @@ -5177,27 +5387,27 @@ YUY2 it would be 2 bytes. introspectable="0"> Row stride in bytes, that is number of bytes from the first pixel component + line="951">Row stride in bytes, that is number of bytes from the first pixel component of a row to the first pixel component in the next row. This might include some row padding (memory not actually used for anything, to make sure the beginning of the next row is aligned in a particular way). + line="962"/> a #GstVideoFormatInfo + line="953">a #GstVideoFormatInfo an array of strides + line="954">an array of strides the component index + line="955">the component index @@ -5207,21 +5417,21 @@ beginning of the next row is aligned in a particular way). introspectable="0"> See #GstVideoTileInfo.height. + line="995">See #GstVideoTileInfo.height. Returns the tile height. + line="1006"/> a #GstVideoFormatInfo + line="997">a #GstVideoFormatInfo the plane index + line="998">the plane index @@ -5229,7 +5439,7 @@ Returns the tile height. c:identifier="GST_VIDEO_FORMAT_INFO_TILE_HS" introspectable="0"> + line="968"/> @@ -5239,7 +5449,7 @@ Returns the tile height. c:identifier="GST_VIDEO_FORMAT_INFO_TILE_MODE" introspectable="0"> + line="966"/> @@ -5251,20 +5461,20 @@ Returns the tile height. introspectable="0"> Provides the size in bytes of a tile in the specified @plane. This replaces + line="970">Provides the size in bytes of a tile in the specified @plane. This replaces the width and height shift, which was limited to power of two dimensions. + line="980"/> a #GstVideoFormatInfo + line="972">a #GstVideoFormatInfo the plane index + line="973">the plane index @@ -5274,23 +5484,23 @@ the width and height shift, which was limited to power of two dimensions. introspectable="0"> See #GstVideoTileInfo.stride. + line="1008">See #GstVideoTileInfo.stride. Returns the stride of one tile, regardless of the internal details of the tile (could be a complex system with subtile) the tiles size should alway match the tile width multiplied by the tile stride. + line="1021"/> a #GstVideoFormatInfo + line="1010">a #GstVideoFormatInfo the plane index + line="1011">the plane index @@ -5300,21 +5510,21 @@ match the tile width multiplied by the tile stride. introspectable="0"> See #GstVideoTileInfo.width. + line="982">See #GstVideoTileInfo.width. Return the width of one tile in pixels, zero if its not an integer. + line="993"/> a #GstVideoFormatInfo + line="984">a #GstVideoFormatInfo the plane index + line="985">the plane index @@ -5322,7 +5532,7 @@ Return the width of one tile in pixels, zero if its not an integer. c:identifier="GST_VIDEO_FORMAT_INFO_TILE_WS" introspectable="0"> + line="967"/> @@ -5332,7 +5542,7 @@ Return the width of one tile in pixels, zero if its not an integer. c:identifier="GST_VIDEO_FORMAT_INFO_W_SUB" introspectable="0"> + line="940"/> @@ -5344,7 +5554,7 @@ Return the width of one tile in pixels, zero if its not an integer. value="(fraction) [ 0, max ]" c:type="GST_VIDEO_FPS_RANGE"> + line="1058"/> value="4" c:type="GST_VIDEO_MAX_COMPONENTS"> + line="625"/> + line="624"/> + line="178"/> @@ -6052,7 +6262,7 @@ It is not valid to use this macro with a TILED format. c:identifier="GST_VIDEO_NE" introspectable="0"> + line="1061"/> @@ -6062,7 +6272,7 @@ It is not valid to use this macro with a TILED format. c:identifier="GST_VIDEO_OE" introspectable="0"> + line="1062"/> @@ -6320,14 +6530,14 @@ quatization errors. value="(int) [ 1, max ]" c:type="GST_VIDEO_SIZE_RANGE"> + line="1057"/> + line="944"/> @@ -6462,7 +6672,7 @@ quatization errors. Active Format Description (AFD) + line="355">Active Format Description (AFD) For details, see Table 6.14 Active Format in: @@ -6476,33 +6686,33 @@ and Active Format Description in Complete list of AFD codes https://en.wikipedia.org/wiki/Active_Format_Description#Complete_list_of_AFD_codes and SMPTE ST2016-1 - + parent #GstMeta + line="357">parent #GstMeta 0 for progressive or field 1 and 1 for field 2 + line="358">0 for progressive or field 1 and 1 for field 2 #GstVideoAFDSpec that applies to @afd + line="359">#GstVideoAFDSpec that applies to @afd #GstVideoAFDValue AFD value + line="360">#GstVideoAFDValue AFD value - + @@ -6515,7 +6725,7 @@ and SMPTE ST2016-1 c:type="GstVideoAFDSpec"> Enumeration of the different standards that may apply to AFD data: + line="331">Enumeration of the different standards that may apply to AFD data: 0) ETSI/DVB: https://www.etsi.org/deliver/etsi_ts/101100_101199/101154/02.01.01_60/ts_101154v020101p.pdf @@ -6531,7 +6741,7 @@ https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf glib:name="GST_VIDEO_AFD_SPEC_DVB_ETSI"> AFD value is from DVB/ETSI standard + line="333">AFD value is from DVB/ETSI standard AFD value is from ATSC A/53 standard + line="334">AFD value is from ATSC A/53 standard Enumeration of the various values for Active Format Description (AFD) + line="251">Enumeration of the various values for Active Format Description (AFD) AFD should be included in video user data whenever the rectangular picture area containing useful information does not extend to the full height or width of the coded @@ -6595,7 +6805,7 @@ of the active image. glib:name="GST_VIDEO_AFD_UNAVAILABLE"> Unavailable (see note 0 below). + line="253">Unavailable (see note 0 below). For 4:3 coded frame, letterbox 16:9 image, + line="254">For 4:3 coded frame, letterbox 16:9 image, at top of the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as the coded frame. @@ -6615,7 +6825,7 @@ of the active image. glib:name="GST_VIDEO_AFD_14_9_TOP_ALIGNED"> For 4:3 coded frame, letterbox 14:9 image, + line="257">For 4:3 coded frame, letterbox 14:9 image, at top of the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the coded frame. @@ -6626,7 +6836,7 @@ of the active image. glib:name="GST_VIDEO_AFD_GREATER_THAN_16_9"> For 4:3 coded frame, letterbox image with an aspect ratio + line="260">For 4:3 coded frame, letterbox image with an aspect ratio greater than 16:9, vertically centered in the coded frame. For 16:9 coded frame, letterbox image with an aspect ratio greater than 16:9. @@ -6637,7 +6847,7 @@ of the active image. glib:name="GST_VIDEO_AFD_4_3_FULL_16_9_FULL"> For 4:3 coded frame, full frame 4:3 image, + line="263">For 4:3 coded frame, full frame 4:3 image, the same as the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as the coded frame. @@ -6648,7 +6858,7 @@ of the active image. glib:name="GST_VIDEO_AFD_4_3_FULL_4_3_PILLAR"> For 4:3 coded frame, full frame 4:3 image, the same as + line="266">For 4:3 coded frame, full frame 4:3 image, the same as the coded frame. For 16:9 coded frame, pillarbox 4:3 image, horizontally centered in the coded frame. @@ -6659,7 +6869,7 @@ of the active image. glib:name="GST_VIDEO_AFD_16_9_LETTER_16_9_FULL"> For 4:3 coded frame, letterbox 16:9 image, vertically centered in + line="269">For 4:3 coded frame, letterbox 16:9 image, vertically centered in the coded frame with all image areas protected. For 16:9 coded frame, full frame 16:9 image, with all image areas protected. @@ -6670,7 +6880,7 @@ of the active image. glib:name="GST_VIDEO_AFD_14_9_LETTER_14_9_PILLAR"> For 4:3 coded frame, letterbox 14:9 image, vertically centered in + line="272">For 4:3 coded frame, letterbox 14:9 image, vertically centered in the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the coded frame. @@ -6681,7 +6891,7 @@ of the active image. glib:name="GST_VIDEO_AFD_4_3_FULL_14_9_CENTER"> For 4:3 coded frame, full frame 4:3 image, with alternative 14:9 + line="275">For 4:3 coded frame, full frame 4:3 image, with alternative 14:9 center. For 16:9 coded frame, pillarbox 4:3 image, with alternative 14:9 center. For 4:3 coded frame, letterbox 16:9 image, with alternative 14:9 + line="277">For 4:3 coded frame, letterbox 16:9 image, with alternative 14:9 center. For 16:9 coded frame, full frame 16:9 image, with alternative 14:9 center. For 4:3 coded frame, letterbox 16:9 image, with alternative 4:3 + line="279">For 4:3 coded frame, letterbox 16:9 image, with alternative 4:3 center. For 16:9 coded frame, full frame 16:9 image, with alternative 4:3 center. @@ -6815,6 +7025,14 @@ Zorder for each input stream can be configured on the + Lets subclasses aggregate frames that are ready. Subclasses + should iterate the GstElement.sinkpads and use the already + mapped #GstVideoFrame from gst_video_aggregator_pad_get_prepared_frame() + or directly use the #GstBuffer from gst_video_aggregator_pad_get_current_buffer() + if it needs to map the buffer in a special way. The result of the + aggregation should land in @outbuffer. @@ -6830,6 +7048,11 @@ Zorder for each input stream can be configured on the + Optional. + Lets subclasses provide a #GstBuffer to be used as @outbuffer of + the #aggregate_frames vmethod. @@ -6869,6 +7092,11 @@ Zorder for each input stream can be configured on the + Optional. + Lets subclasses update the #GstCaps representing + the src pad caps before usage. Return %NULL to indicate failure. @@ -6888,7 +7116,7 @@ Zorder for each input stream can be configured on the version="1.20"> The returned #GstTaskPool is used internally for performing parallel + line="2967">The returned #GstTaskPool is used internally for performing parallel video format conversions/scaling/etc during the #GstVideoAggregatorPadClass::prepare_frame_start() process. Subclasses can add their own operation to perform using the returned @@ -6898,7 +7126,7 @@ Subclasses can add their own operation to perform using the returned the #GstTaskPool that can be used by subclasses + line="2977">the #GstTaskPool that can be used by subclasses for performing concurrent operations @@ -6906,7 +7134,7 @@ Subclasses can add their own operation to perform using the returned the #GstVideoAggregator + line="2969">the #GstVideoAggregator @@ -6919,7 +7147,7 @@ Subclasses can add their own operation to perform using the returned default-value="FALSE"> Causes the element to aggregate on a timeout even when no live source is + line="3098">Causes the element to aggregate on a timeout even when no live source is connected to its sinks. See #GstAggregator:min-upstream-latency for a companion property: in the vast majority of cases where you plan to plug in live sources with a non-zero latency, you should set it to a non-zero value. @@ -6955,6 +7183,11 @@ srcpad caps. + Optional. + Lets subclasses update the #GstCaps representing + the src pad caps before usage. Return %NULL to indicate failure. @@ -6972,6 +7205,14 @@ srcpad caps. + Lets subclasses aggregate frames that are ready. Subclasses + should iterate the GstElement.sinkpads and use the already + mapped #GstVideoFrame from gst_video_aggregator_pad_get_prepared_frame() + or directly use the #GstBuffer from gst_video_aggregator_pad_get_current_buffer() + if it needs to map the buffer in a special way. The result of the + aggregation should land in @outbuffer. @@ -6989,6 +7230,11 @@ srcpad caps. + Optional. + Lets subclasses provide a #GstBuffer to be used as @outbuffer of + the #aggregate_frames vmethod. @@ -7006,6 +7252,10 @@ srcpad caps. + Optional. + Lets subclasses decide of the best common format to use. @@ -7163,6 +7413,9 @@ update for any changes that have happened. + clean the frame previously prepared in prepare_frame @@ -7181,6 +7434,11 @@ update for any changes that have happened. + Prepare the frame from the pad buffer and sets it to prepared_frame. + Implementations should always return TRUE. Returning FALSE will cease + iteration over subsequent pads. @@ -7272,6 +7530,10 @@ If overriden, `prepare_frame_finish` must also be overriden. + Called when either the input or output formats + have changed. @@ -7440,6 +7702,10 @@ or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the agg c:type="GstAggregatorPadClass"/> + Called when either the input or output formats + have changed. @@ -7454,6 +7720,11 @@ or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the agg + Prepare the frame from the pad buffer and sets it to prepared_frame. + Implementations should always return TRUE. Returning FALSE will cease + iteration over subsequent pads. @@ -7477,6 +7748,9 @@ or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the agg + clean the frame previously prepared in prepare_frame @@ -7874,7 +8148,7 @@ the parity check bits). Bar data should be included in video user data + line="413">Bar data should be included in video user data whenever the rectangular picture area containing useful information does not extend to the full height or width of the coded frame and AFD alone is insufficient to describe the extent of the image. @@ -7886,29 +8160,29 @@ For more details, see: https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf and SMPTE ST2016-1 - + parent #GstMeta + line="415">parent #GstMeta 0 for progressive or field 1 and 1 for field 2 + line="416">0 for progressive or field 1 and 1 for field 2 if true then bar data specifies letterbox, otherwise pillarbox + line="417">if true then bar data specifies letterbox, otherwise pillarbox If @is_letterbox is true, then the value specifies the + line="418">If @is_letterbox is true, then the value specifies the last line of a horizontal letterbox bar area at top of reconstructed frame. Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox bar area at the left side of the reconstructed frame @@ -7917,14 +8191,14 @@ and SMPTE ST2016-1 If @is_letterbox is true, then the value specifies the + line="422">If @is_letterbox is true, then the value specifies the first line of a horizontal letterbox bar area at bottom of reconstructed frame. Otherwise, it specifies the first horizontal luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame. - + @@ -8114,24 +8388,24 @@ supports all the video bufferpool options. version="1.16"> Extra buffer metadata providing Closed Caption. - + line="520">Extra buffer metadata providing Closed Caption. + parent #GstMeta + line="522">parent #GstMeta The type of Closed Caption contained in the meta. + line="523">The type of Closed Caption contained in the meta. The Closed Caption data. + line="524">The Closed Caption data. @@ -8139,11 +8413,11 @@ supports all the video bufferpool options. The size in bytes of @data + line="525">The size in bytes of @data - + @@ -8156,7 +8430,7 @@ supports all the video bufferpool options. c:type="GstVideoCaptionType"> The various known types of Closed Caption (CC). + line="475">The various known types of Closed Caption (CC). glib:name="GST_VIDEO_CAPTION_TYPE_UNKNOWN"> Unknown type of CC + line="477">Unknown type of CC glib:name="GST_VIDEO_CAPTION_TYPE_CEA608_RAW"> CEA-608 as byte pairs. Note that + line="478">CEA-608 as byte pairs. Note that this format is not recommended since is does not specify to which field the caption comes from and therefore assumes it comes from the first field (and that there is no information @@ -8188,7 +8462,7 @@ supports all the video bufferpool options. glib:name="GST_VIDEO_CAPTION_TYPE_CEA608_S334_1A"> CEA-608 as byte triplets as defined + line="485">CEA-608 as byte triplets as defined in SMPTE S334-1 Annex A. The second and third byte of the byte triplet is the raw CEA608 data, the first byte is a bitfield: The top/7th bit is 0 for the second field, 1 for the first field, bit 6 and 5 are 0 and @@ -8204,7 +8478,7 @@ supports all the video bufferpool options. glib:name="GST_VIDEO_CAPTION_TYPE_CEA708_RAW"> CEA-708 as cc_data byte triplets. They + line="493">CEA-708 as cc_data byte triplets. They can also contain 608-in-708 and the first byte of each triplet has to be inspected for detecting the type. @@ -8215,7 +8489,7 @@ supports all the video bufferpool options. glib:name="GST_VIDEO_CAPTION_TYPE_CEA708_CDP"> CEA-708 (and optionally CEA-608) in + line="496">CEA-708 (and optionally CEA-608) in a CDP (Caption Distribution Packet) defined by SMPTE S-334-2. Contains the whole CDP (starting with 0x9669). @@ -8224,20 +8498,20 @@ supports all the video bufferpool options. version="1.16"> Parses fixed Closed Caption #GstCaps and returns the corresponding caption + line="1045">Parses fixed Closed Caption #GstCaps and returns the corresponding caption type, or %GST_VIDEO_CAPTION_TYPE_UNKNOWN. - + #GstVideoCaptionType. + line="1052">#GstVideoCaptionType. Fixed #GstCaps to parse + line="1047">Fixed #GstCaps to parse @@ -8247,19 +8521,19 @@ type, or %GST_VIDEO_CAPTION_TYPE_UNKNOWN. version="1.16"> Creates new caps corresponding to @type. - + line="1085">Creates new caps corresponding to @type. + new #GstCaps + line="1091">new #GstCaps #GstVideoCaptionType + line="1087">#GstVideoCaptionType @@ -10068,7 +10342,7 @@ with the parsed values. version="1.6"> Convert the pixels of @src into @dest using @convert. + line="2741">Convert the pixels of @src into @dest using @convert. If #GST_VIDEO_CONVERTER_OPT_ASYNC_TASKS is %TRUE then this function will return immediately and needs to be followed by a call to @@ -10082,19 +10356,19 @@ gst_video_converter_frame_finish(). a #GstVideoConverter + line="2743">a #GstVideoConverter a #GstVideoFrame + line="2745">a #GstVideoFrame a #GstVideoFrame + line="2744">a #GstVideoFrame @@ -10104,7 +10378,7 @@ gst_video_converter_frame_finish(). version="1.20"> Wait for a previous async conversion performed using + line="2791">Wait for a previous async conversion performed using gst_video_converter_frame() to complete. @@ -10115,7 +10389,7 @@ gst_video_converter_frame() to complete. a #GstVideoConverter + line="2793">a #GstVideoConverter @@ -10125,7 +10399,7 @@ gst_video_converter_frame() to complete. version="1.6"> Free @convert + line="2570">Free @convert @@ -10135,7 +10409,7 @@ gst_video_converter_frame() to complete. a #GstVideoConverter + line="2572">a #GstVideoConverter @@ -10143,13 +10417,13 @@ gst_video_converter_frame() to complete. Get the current configuration of @convert. + line="2724">Get the current configuration of @convert. a #GstStructure that remains valid for as long as @convert is valid + line="2730">a #GstStructure that remains valid for as long as @convert is valid or until gst_video_converter_set_config() is called. @@ -10157,7 +10431,7 @@ gst_video_converter_frame() to complete. a #GstVideoConverter + line="2726">a #GstVideoConverter @@ -10167,20 +10441,20 @@ gst_video_converter_frame() to complete. version="1.22"> Retrieve the input format of @convert. + line="8285">Retrieve the input format of @convert. a #GstVideoInfo + line="8291">a #GstVideoInfo a #GstVideoConverter + line="8287">a #GstVideoConverter @@ -10190,20 +10464,20 @@ gst_video_converter_frame() to complete. version="1.22"> Retrieve the output format of @convert. + line="8301">Retrieve the output format of @convert. a #GstVideoInfo + line="8307">a #GstVideoInfo a #GstVideoConverter + line="8303">a #GstVideoConverter @@ -10213,7 +10487,7 @@ gst_video_converter_frame() to complete. version="1.6"> Set @config as extra configuration for @convert. + line="2693">Set @config as extra configuration for @convert. If the parameters in @config can not be set exactly, this function returns %FALSE and will try to update as much state as possible. The new state can @@ -10226,20 +10500,20 @@ option and values. %TRUE when @config could be set. + line="2707">%TRUE when @config could be set. a #GstVideoConverter + line="2695">a #GstVideoConverter a #GstStructure + line="2696">a #GstStructure @@ -10250,7 +10524,7 @@ option and values. introspectable="0"> Create a new converter object to convert between @in_info and @out_info + line="2542">Create a new converter object to convert between @in_info and @out_info with @config. Returns (nullable): a #GstVideoConverter or %NULL if conversion is not possible. @@ -10263,19 +10537,19 @@ Returns (nullable): a #GstVideoConverter or %NULL if conversion is not possible. a #GstVideoInfo + line="2544">a #GstVideoInfo a #GstVideoInfo + line="2545">a #GstVideoInfo a #GstStructure with configuration options + line="2546">a #GstStructure with configuration options @@ -10286,7 +10560,7 @@ Returns (nullable): a #GstVideoConverter or %NULL if conversion is not possible. introspectable="0"> Create a new converter object to convert between @in_info and @out_info + line="2295">Create a new converter object to convert between @in_info and @out_info with @config. The optional @pool can be used to spawn threads, this is useful when @@ -10302,19 +10576,19 @@ Returns (nullable): a #GstVideoConverter or %NULL if conversion is not possible. a #GstVideoInfo + line="2297">a #GstVideoInfo a #GstVideoInfo + line="2298">a #GstVideoInfo a #GstStructure with configuration options + line="2299">a #GstStructure with configuration options a #GstTaskPool to spawn threads from + line="2300">a #GstTaskPool to spawn threads from @@ -10332,42 +10606,42 @@ Returns (nullable): a #GstVideoConverter or %NULL if conversion is not possible. Extra buffer metadata describing image cropping. + line="141">Extra buffer metadata describing image cropping. + line="158"/> parent #GstMeta + line="143">parent #GstMeta the horizontal offset + line="144">the horizontal offset the vertical offset + line="145">the vertical offset the cropped width + line="146">the cropped width the cropped height + line="147">the cropped height + line="164"/> @@ -10504,6 +10778,11 @@ The bare minimum that a functional subclass needs to implement is: + Optional. + Called when the element changes to GST_STATE_NULL. + Allows closing external resources. @@ -10516,6 +10795,14 @@ The bare minimum that a functional subclass needs to implement is: + Optional. + Setup the allocation parameters for allocating output + buffers. The passed in query contains the result of the + downstream allocation query. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -10531,6 +10818,13 @@ The bare minimum that a functional subclass needs to implement is: + Optional. + Called to request subclass to decode any data it can at this + point, but that more data may arrive after. (e.g. at segment end). + Sub-classes should be prepared to handle new data afterward, + or seamless segment processing will break. Since: 1.6 @@ -10543,6 +10837,11 @@ The bare minimum that a functional subclass needs to implement is: + Optional. + Called to request subclass to dispatch any pending remaining + data at EOS. Sub-classes can refuse to decode new data after. @@ -10555,6 +10854,11 @@ The bare minimum that a functional subclass needs to implement is: + Optional. + Flush all remaining data from the decoder without + pushing it downstream. Since: 1.2 @@ -10567,6 +10871,13 @@ The bare minimum that a functional subclass needs to implement is: + Optional. + Allows for a custom sink getcaps implementation. + If not implemented, default returns + gst_video_decoder_proxy_getcaps + applied to sink template caps. @@ -10635,7 +10946,7 @@ The bare minimum that a functional subclass needs to implement is: Negotiate with downstream elements to currently configured #GstVideoCodecState. + line="4526">Negotiate with downstream elements to currently configured #GstVideoCodecState. Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if negotiate fails. %TRUE if the negotiation succeeded, else %FALSE. + line="4534">%TRUE if the negotiation succeeded, else %FALSE. a #GstVideoDecoder + line="4528">a #GstVideoDecoder + Optional. + Called when the element changes to GST_STATE_READY. + Allows opening external resources. @@ -10668,6 +10984,11 @@ negotiate fails. + Required for non-packetized input. + Allows chopping incoming data into manageable units (frames) + for subsequent decoding. @@ -10689,6 +11010,12 @@ negotiate fails. + Optional. + Propose buffer allocation parameters for upstream elements. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -10704,6 +11031,11 @@ negotiate fails. + Optional. + Allows subclass (decoder) to perform post-seek semantics reset. + Deprecated. @@ -10719,6 +11051,9 @@ negotiate fails. + Notifies subclass of incoming data format (caps). @@ -10734,6 +11069,14 @@ negotiate fails. + Optional. + Event handler on the sink pad. This function should return + TRUE if the event was handled and should be discarded + (i.e. not unref'ed). + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -10749,6 +11092,13 @@ negotiate fails. + Optional. + Query handler on the sink pad. This function should + return TRUE if the query could be performed. Subclasses + should chain up to the parent implementation to invoke the + default handler. Since: 1.4 @@ -10764,6 +11114,14 @@ negotiate fails. + Optional. + Event handler on the source pad. This function should return + TRUE if the event was handled and should be discarded + (i.e. not unref'ed). + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -10779,6 +11137,13 @@ negotiate fails. + Optional. + Query handler on the source pad. This function should + return TRUE if the query could be performed. Subclasses + should chain up to the parent implementation to invoke the + default handler. Since: 1.4 @@ -10794,6 +11159,11 @@ negotiate fails. + Optional. + Called when the element starts processing. + Allows opening external resources. @@ -10806,6 +11176,11 @@ negotiate fails. + Optional. + Called when the element stops processing. + Allows closing external resources. @@ -10818,6 +11193,13 @@ negotiate fails. + Optional. Transform the metadata on the input buffer to the + output buffer. By default this method is copies all meta without + tags and meta with only the "video" tag. subclasses can + implement this method and return %TRUE if the metadata is to be + copied. Since: 1.6 @@ -10839,7 +11221,7 @@ negotiate fails. c:identifier="gst_video_decoder_add_to_frame"> Removes next @n_bytes of input data and adds it to currently parsed frame. + line="3727">Removes next @n_bytes of input data and adds it to currently parsed frame. @@ -10849,13 +11231,13 @@ negotiate fails. a #GstVideoDecoder + line="3729">a #GstVideoDecoder the number of bytes to add + line="3730">the number of bytes to add @@ -10864,7 +11246,7 @@ negotiate fails. c:identifier="gst_video_decoder_allocate_output_buffer"> Helper function that allocates a buffer to hold a video frame for @decoder's + line="4558">Helper function that allocates a buffer to hold a video frame for @decoder's current #GstVideoCodecState. You should use gst_video_decoder_allocate_output_frame() instead of this @@ -10874,7 +11256,7 @@ function, if possible at all. allocated buffer, or NULL if no buffer could be + line="4568">allocated buffer, or NULL if no buffer could be allocated (e.g. when downstream is flushing or shutting down) @@ -10882,7 +11264,7 @@ function, if possible at all. a #GstVideoDecoder + line="4560">a #GstVideoDecoder @@ -10891,7 +11273,7 @@ function, if possible at all. c:identifier="gst_video_decoder_allocate_output_frame"> Helper function that allocates a buffer to hold a video frame for @decoder's + line="4624">Helper function that allocates a buffer to hold a video frame for @decoder's current #GstVideoCodecState. Subclass should already have configured video state and set src pad caps. @@ -10902,20 +11284,20 @@ keep references to the frame, not the buffer. %GST_FLOW_OK if an output buffer could be allocated + line="4636">%GST_FLOW_OK if an output buffer could be allocated a #GstVideoDecoder + line="4626">a #GstVideoDecoder a #GstVideoCodecFrame + line="4627">a #GstVideoCodecFrame @@ -10925,33 +11307,33 @@ keep references to the frame, not the buffer. version="1.12"> Same as #gst_video_decoder_allocate_output_frame except it allows passing + line="4646">Same as #gst_video_decoder_allocate_output_frame except it allows passing #GstBufferPoolAcquireParams to the sub call gst_buffer_pool_acquire_buffer. %GST_FLOW_OK if an output buffer could be allocated + line="4655">%GST_FLOW_OK if an output buffer could be allocated a #GstVideoDecoder + line="4648">a #GstVideoDecoder a #GstVideoCodecFrame + line="4649">a #GstVideoCodecFrame a #GstBufferPoolAcquireParams + line="4650">a #GstBufferPoolAcquireParams @@ -10960,7 +11342,7 @@ keep references to the frame, not the buffer. Similar to gst_video_decoder_finish_frame(), but drops @frame in any + line="3220">Similar to gst_video_decoder_finish_frame(), but drops @frame in any case and posts a QoS message with the frame's details on the bus. In any case, the frame is considered finished and released. a #GstFlowReturn, usually GST_FLOW_OK. + line="3229">a #GstFlowReturn, usually GST_FLOW_OK. a #GstVideoDecoder + line="3222">a #GstVideoDecoder the #GstVideoCodecFrame to drop + line="3223">the #GstVideoCodecFrame to drop @@ -10991,7 +11373,7 @@ In any case, the frame is considered finished and released. version="1.20"> Drops input data. + line="3260">Drops input data. The frame is not considered finished until the whole frame is finished or dropped by the subclass. a #GstFlowReturn, usually GST_FLOW_OK. + line="3269">a #GstFlowReturn, usually GST_FLOW_OK. a #GstVideoDecoder + line="3262">a #GstVideoDecoder the #GstVideoCodecFrame + line="3263">the #GstVideoCodecFrame @@ -11021,7 +11403,7 @@ is finished or dropped by the subclass. c:identifier="gst_video_decoder_finish_frame"> @frame should have a valid decoded data buffer, whose metadata fields + line="3397">@frame should have a valid decoded data buffer, whose metadata fields are then appropriately set according to frame data and pushed downstream. If no output data is provided, @frame is considered skipped. In any case, the frame is considered finished and released. @@ -11034,20 +11416,20 @@ of the buffer. a #GstFlowReturn resulting from sending data downstream + line="3411">a #GstFlowReturn resulting from sending data downstream a #GstVideoDecoder + line="3399">a #GstVideoDecoder a decoded #GstVideoCodecFrame + line="3400">a decoded #GstVideoCodecFrame @@ -11057,7 +11439,7 @@ of the buffer. version="1.20"> Indicate that a subframe has been finished to be decoded + line="3548">Indicate that a subframe has been finished to be decoded by the subclass. This method should be called for all subframes except the last subframe where @gst_video_decoder_finish_frame should be called instead. @@ -11066,20 +11448,20 @@ should be called instead. a #GstFlowReturn, usually GST_FLOW_OK. + line="3558">a #GstFlowReturn, usually GST_FLOW_OK. a #GstVideoDecoder + line="3550">a #GstVideoDecoder the #GstVideoCodecFrame + line="3551">the #GstVideoCodecFrame @@ -11088,7 +11470,7 @@ should be called instead. c:identifier="gst_video_decoder_get_allocator"> Lets #GstVideoDecoder sub-classes to know the memory @allocator + line="5186">Lets #GstVideoDecoder sub-classes to know the memory @allocator used by the base class and its @params. Unref the @allocator after use it. @@ -11101,7 +11483,7 @@ Unref the @allocator after use it. a #GstVideoDecoder + line="5188">a #GstVideoDecoder allow-none="1"> the #GstAllocator + line="5189">the #GstAllocator used @@ -11125,7 +11507,7 @@ used allow-none="1"> the + line="5191">the #GstAllocationParams of @allocator @@ -11138,7 +11520,7 @@ used the instance of the #GstBufferPool used + line="5172">the instance of the #GstBufferPool used by the decoder; free it after use it @@ -11146,7 +11528,7 @@ by the decoder; free it after use it a #GstVideoDecoder + line="5170">a #GstVideoDecoder @@ -11158,14 +11540,14 @@ by the decoder; free it after use it currently configured byte to time conversion setting + line="5050">currently configured byte to time conversion setting a #GstVideoDecoder + line="5048">a #GstVideoDecoder @@ -11173,26 +11555,26 @@ by the decoder; free it after use it Get a pending unfinished #GstVideoCodecFrame + line="4152">Get a pending unfinished #GstVideoCodecFrame pending unfinished #GstVideoCodecFrame identified by @frame_number. + line="4159">pending unfinished #GstVideoCodecFrame identified by @frame_number. a #GstVideoDecoder + line="4154">a #GstVideoDecoder system_frame_number of a frame + line="4155">system_frame_number of a frame @@ -11200,13 +11582,13 @@ by the decoder; free it after use it Get all pending unfinished #GstVideoCodecFrame + line="4183">Get all pending unfinished #GstVideoCodecFrame pending unfinished #GstVideoCodecFrame. + line="4189">pending unfinished #GstVideoCodecFrame. @@ -11215,7 +11597,7 @@ by the decoder; free it after use it a #GstVideoDecoder + line="4185">a #GstVideoDecoder @@ -11225,27 +11607,27 @@ by the decoder; free it after use it version="1.20"> Queries the number of the last subframe received by + line="4991">Queries the number of the last subframe received by the decoder baseclass in the @frame. the current subframe index received in subframe mode, 1 otherwise. + line="4999">the current subframe index received in subframe mode, 1 otherwise. a #GstVideoDecoder + line="4993">a #GstVideoDecoder the #GstVideoCodecFrame to update + line="4994">the #GstVideoCodecFrame to update @@ -11253,7 +11635,7 @@ the decoder baseclass in the @frame. Query the configured decoder latency. Results will be returned via + line="5103">Query the configured decoder latency. Results will be returned via @min_latency and @max_latency. @@ -11264,7 +11646,7 @@ the decoder baseclass in the @frame. a #GstVideoDecoder + line="5105">a #GstVideoDecoder allow-none="1"> address of variable in which to store the + line="5106">address of variable in which to store the configured minimum latency, or %NULL @@ -11287,7 +11669,7 @@ the decoder baseclass in the @frame. allow-none="1"> address of variable in which to store the + line="5108">address of variable in which to store the configured mximum latency, or %NULL @@ -11297,7 +11679,7 @@ the decoder baseclass in the @frame. c:identifier="gst_video_decoder_get_max_decode_time"> Determines maximum possible decoding time for @frame that will + line="4721">Determines maximum possible decoding time for @frame that will allow it to decode and arrive in time (as determined by QoS events). In particular, a negative result means decoding in time is no longer possible and should therefore occur as soon/skippy as possible. @@ -11306,20 +11688,20 @@ and should therefore occur as soon/skippy as possible. max decoding time. + line="4731">max decoding time. a #GstVideoDecoder + line="4723">a #GstVideoDecoder a #GstVideoCodecFrame + line="4724">a #GstVideoCodecFrame @@ -11332,14 +11714,14 @@ and should therefore occur as soon/skippy as possible. currently configured decoder tolerated error count. + line="4828">currently configured decoder tolerated error count. a #GstVideoDecoder + line="4826">a #GstVideoDecoder @@ -11349,20 +11731,20 @@ and should therefore occur as soon/skippy as possible. version="1.4"> Queries decoder required format handling. + line="4860">Queries decoder required format handling. %TRUE if required format handling is enabled. + line="4866">%TRUE if required format handling is enabled. a #GstVideoDecoder + line="4862">a #GstVideoDecoder @@ -11372,21 +11754,21 @@ and should therefore occur as soon/skippy as possible. version="1.20"> Queries if the decoder requires a sync point before it starts outputting + line="5342">Queries if the decoder requires a sync point before it starts outputting data in the beginning. %TRUE if a sync point is required in the beginning. + line="5349">%TRUE if a sync point is required in the beginning. a #GstVideoDecoder + line="5344">a #GstVideoDecoder @@ -11395,20 +11777,20 @@ data in the beginning. c:identifier="gst_video_decoder_get_oldest_frame"> Get the oldest pending unfinished #GstVideoCodecFrame + line="4131">Get the oldest pending unfinished #GstVideoCodecFrame oldest pending unfinished #GstVideoCodecFrame. + line="4137">oldest pending unfinished #GstVideoCodecFrame. a #GstVideoDecoder + line="4133">a #GstVideoDecoder @@ -11417,20 +11799,20 @@ data in the beginning. c:identifier="gst_video_decoder_get_output_state"> Get the #GstVideoCodecState currently describing the output stream. + line="4003">Get the #GstVideoCodecState currently describing the output stream. #GstVideoCodecState describing format of video data. + line="4009">#GstVideoCodecState describing format of video data. a #GstVideoDecoder + line="4005">a #GstVideoDecoder @@ -11439,21 +11821,21 @@ data in the beginning. c:identifier="gst_video_decoder_get_packetized"> Queries whether input data is considered packetized or not by the + line="4897">Queries whether input data is considered packetized or not by the base class. TRUE if input data is considered packetized. + line="4904">TRUE if input data is considered packetized. a #GstVideoDecoder + line="4899">a #GstVideoDecoder @@ -11463,21 +11845,21 @@ base class. version="1.4"> Returns the number of bytes previously added to the current frame + line="3756">Returns the number of bytes previously added to the current frame by calling gst_video_decoder_add_to_frame(). The number of bytes pending for the current frame + line="3763">The number of bytes pending for the current frame a #GstVideoDecoder + line="3758">a #GstVideoDecoder @@ -11487,27 +11869,27 @@ by calling gst_video_decoder_add_to_frame(). version="1.20"> Queries the number of subframes in the frame processed by + line="5012">Queries the number of subframes in the frame processed by the decoder baseclass. the current subframe processed received in subframe mode. + line="5020">the current subframe processed received in subframe mode. a #GstVideoDecoder + line="5014">a #GstVideoDecoder the #GstVideoCodecFrame to update + line="5015">the #GstVideoCodecFrame to update @@ -11520,14 +11902,14 @@ the decoder baseclass. The current QoS proportion. + line="4763">The current QoS proportion. a #GstVideoDecoder + line="4760">a #GstVideoDecoder current QoS proportion, or %NULL @@ -11538,7 +11920,7 @@ the decoder baseclass. version="1.20"> Queries whether input data is considered as subframes or not by the + line="4973">Queries whether input data is considered as subframes or not by the base class. If FALSE, each input buffer will be considered as a full frame. TRUE if input data is considered as sub frames. + line="4981">TRUE if input data is considered as sub frames. a #GstVideoDecoder + line="4975">a #GstVideoDecoder @@ -11561,21 +11943,21 @@ frame. Gathers all data collected for currently parsed frame, gathers corresponding + line="3806">Gathers all data collected for currently parsed frame, gathers corresponding metadata and passes it along for further processing, i.e. @handle_frame. a #GstFlowReturn + line="3813">a #GstFlowReturn a #GstVideoDecoder + line="3808">a #GstVideoDecoder @@ -11585,7 +11967,7 @@ metadata and passes it along for further processing, i.e. @handle_frame. version="1.20"> Indicates that the last subframe has been processed by the decoder + line="4912">Indicates that the last subframe has been processed by the decoder in @frame. This will release the current frame in video decoder allowing to receive new frames from upstream elements. This method must be called in the subclass @handle_frame callback. @@ -11594,20 +11976,20 @@ must be called in the subclass @handle_frame callback. a #GstFlowReturn, usually GST_FLOW_OK. + line="4922">a #GstFlowReturn, usually GST_FLOW_OK. a #GstVideoDecoder + line="4914">a #GstVideoDecoder the #GstVideoCodecFrame to update + line="4915">the #GstVideoCodecFrame to update @@ -11615,7 +11997,7 @@ must be called in the subclass @handle_frame callback. Sets the audio decoder tags and how they should be merged with any + line="5126">Sets the audio decoder tags and how they should be merged with any upstream stream tags. This will override any tags previously-set with gst_audio_decoder_merge_tags(). @@ -11632,7 +12014,7 @@ MT safe. a #GstVideoDecoder + line="5128">a #GstVideoDecoder allow-none="1"> a #GstTagList to merge, or NULL to unset + line="5129">a #GstTagList to merge, or NULL to unset previously-set tags the #GstTagMergeMode to use, usually #GST_TAG_MERGE_REPLACE + line="5131">the #GstTagMergeMode to use, usually #GST_TAG_MERGE_REPLACE @@ -11656,7 +12038,7 @@ MT safe. Negotiate with downstream elements to currently configured #GstVideoCodecState. + line="4526">Negotiate with downstream elements to currently configured #GstVideoCodecState. Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if negotiate fails. %TRUE if the negotiation succeeded, else %FALSE. + line="4534">%TRUE if the negotiation succeeded, else %FALSE. a #GstVideoDecoder + line="4528">a #GstVideoDecoder @@ -11681,7 +12063,7 @@ negotiate fails. version="1.6"> Returns caps that express @caps (or sink template caps if @caps == NULL) + line="2033">Returns caps that express @caps (or sink template caps if @caps == NULL) restricted to resolution/format/... combinations supported by downstream elements. a #GstCaps owned by caller + line="2043">a #GstCaps owned by caller a #GstVideoDecoder + line="2035">a #GstVideoDecoder allow-none="1"> initial caps + line="2036">initial caps allow-none="1"> filter caps + line="2037">filter caps @@ -11724,7 +12106,7 @@ elements. version="1.2.2"> Similar to gst_video_decoder_drop_frame(), but simply releases @frame + line="3153">Similar to gst_video_decoder_drop_frame(), but simply releases @frame without any processing other than removing it from list of pending frames, after which it is considered finished and released. a #GstVideoDecoder + line="3155">a #GstVideoDecoder the #GstVideoCodecFrame to release + line="3156">the #GstVideoCodecFrame to release @@ -11752,7 +12134,7 @@ after which it is considered finished and released. version="1.20"> Allows the #GstVideoDecoder subclass to request from the base class that + line="5277">Allows the #GstVideoDecoder subclass to request from the base class that a new sync should be requested from upstream, and that @frame was the frame when the subclass noticed that a new sync point is required. A reason for the subclass to do this could be missing reference frames, for example. @@ -11784,19 +12166,19 @@ should be handled: a #GstVideoDecoder + line="5279">a #GstVideoDecoder a #GstVideoCodecFrame + line="5280">a #GstVideoCodecFrame #GstVideoDecoderRequestSyncPointFlags + line="5281">#GstVideoDecoderRequestSyncPointFlags @@ -11806,7 +12188,7 @@ should be handled: c:identifier="gst_video_decoder_set_estimate_rate"> Allows baseclass to perform byte to time estimated conversion. + line="5031">Allows baseclass to perform byte to time estimated conversion. @@ -11816,13 +12198,13 @@ should be handled: a #GstVideoDecoder + line="5033">a #GstVideoDecoder whether to enable byte to time conversion + line="5034">whether to enable byte to time conversion @@ -11832,45 +12214,45 @@ should be handled: version="1.16."> Same as #gst_video_decoder_set_output_state() but also allows you to also set + line="4105">Same as #gst_video_decoder_set_output_state() but also allows you to also set the interlacing mode. the newly configured output state. + line="4117">the newly configured output state. a #GstVideoDecoder + line="4107">a #GstVideoDecoder a #GstVideoFormat + line="4108">a #GstVideoFormat A #GstVideoInterlaceMode + line="4111">A #GstVideoInterlaceMode The width in pixels + line="4109">The width in pixels The height in pixels + line="4110">The height in pixels allow-none="1"> An optional reference #GstVideoCodecState + line="4112">An optional reference #GstVideoCodecState @@ -11887,7 +12269,7 @@ the interlacing mode. Lets #GstVideoDecoder sub-classes tell the baseclass what the decoder latency + line="5060">Lets #GstVideoDecoder sub-classes tell the baseclass what the decoder latency is. If the provided values changed from previously provided ones, this will also post a LATENCY message on the bus so the pipeline can reconfigure its global latency. @@ -11900,19 +12282,19 @@ global latency. a #GstVideoDecoder + line="5062">a #GstVideoDecoder minimum latency + line="5063">minimum latency maximum latency + line="5064">maximum latency @@ -11922,7 +12304,7 @@ global latency. glib:set-property="max-errors"> Sets numbers of tolerated decoder errors, where a tolerated one is then only + line="4804">Sets numbers of tolerated decoder errors, where a tolerated one is then only warned about, but more than tolerated will lead to fatal error. You can set -1 for never returning fatal errors. Default is set to GST_VIDEO_DECODER_MAX_ERRORS. @@ -11937,13 +12319,13 @@ The '-1' option was added in 1.4 a #GstVideoDecoder + line="4806">a #GstVideoDecoder max tolerated errors + line="4807">max tolerated errors @@ -11953,7 +12335,7 @@ The '-1' option was added in 1.4 version="1.4"> Configures decoder format needs. If enabled, subclass needs to be + line="4838">Configures decoder format needs. If enabled, subclass needs to be negotiated with format caps before it can process any data. It will then never be handed any data before it has been configured. Otherwise, it might be handed data without having been configured and @@ -11968,13 +12350,13 @@ or based on the input data. a #GstVideoDecoder + line="4840">a #GstVideoDecoder new state + line="4841">new state @@ -11984,7 +12366,7 @@ or based on the input data. version="1.20"> Configures whether the decoder requires a sync point before it starts + line="5319">Configures whether the decoder requires a sync point before it starts outputting data in the beginning. If enabled, the base class will discard all non-sync point frames in the beginning and after a flush and does not pass it to the subclass. @@ -12000,13 +12382,13 @@ point via the force-key-unit event. a #GstVideoDecoder + line="5321">a #GstVideoDecoder new state + line="5322">new state @@ -12015,7 +12397,7 @@ point via the force-key-unit event. c:identifier="gst_video_decoder_set_output_state"> Creates a new #GstVideoCodecState with the specified @fmt, @width and @height + line="4071">Creates a new #GstVideoCodecState with the specified @fmt, @width and @height as the output state for the decoder. Any previously set output state on @decoder will be replaced by the newly created one. @@ -12034,32 +12416,32 @@ from the next call to #gst_video_decoder_finish_frame(). the newly configured output state. + line="4094">the newly configured output state. a #GstVideoDecoder + line="4073">a #GstVideoDecoder a #GstVideoFormat + line="4074">a #GstVideoFormat The width in pixels + line="4075">The width in pixels The height in pixels + line="4076">The height in pixels allow-none="1"> An optional reference #GstVideoCodecState + line="4077">An optional reference #GstVideoCodecState @@ -12077,7 +12459,7 @@ from the next call to #gst_video_decoder_finish_frame(). c:identifier="gst_video_decoder_set_packetized"> Allows baseclass to consider input data as packetized or not. If the + line="4882">Allows baseclass to consider input data as packetized or not. If the input is packetized, then the @parse method will not be called. @@ -12088,13 +12470,13 @@ input is packetized, then the @parse method will not be called. a #GstVideoDecoder + line="4884">a #GstVideoDecoder whether the input data should be considered as packetized. + line="4885">whether the input data should be considered as packetized. @@ -12104,7 +12486,7 @@ input is packetized, then the @parse method will not be called. version="1.20"> If this is set to TRUE, it informs the base class that the subclass + line="4943">If this is set to TRUE, it informs the base class that the subclass can receive the data at a granularity lower than one frame. Note that in this mode, the subclass has two options. It can either @@ -12128,13 +12510,13 @@ This method must be called during the decoder subclass @set_format call. a #GstVideoDecoder + line="4945">a #GstVideoDecoder whether the input data should be considered as subframes. + line="4946">whether the input data should be considered as subframes. @@ -12144,7 +12526,7 @@ This method must be called during the decoder subclass @set_format call. version="1.6"> Lets #GstVideoDecoder sub-classes decide if they want the sink pad + line="5213">Lets #GstVideoDecoder sub-classes decide if they want the sink pad to use the default pad query handler to reply to accept-caps queries. By setting this to true it is possible to further customize the default @@ -12159,13 +12541,13 @@ handler with %GST_PAD_SET_ACCEPT_INTERSECT and a #GstVideoDecoder + line="5215">a #GstVideoDecoder if the default pad accept-caps query handling should be used + line="5216">if the default pad accept-caps query handling should be used @@ -12177,7 +12559,7 @@ handler with %GST_PAD_SET_ACCEPT_INTERSECT and default-value="GST_VIDEO_DECODER_REQUEST_SYNC_POINT_DISCARD_INPUT | GST_VIDEO_DECODER_REQUEST_SYNC_POINT_CORRUPT_OUTPUT"> GstVideoDecoderRequestSyncPointFlags to use for the automatically + line="702">GstVideoDecoderRequestSyncPointFlags to use for the automatically requested sync points if `automatic-request-sync-points` is enabled. @@ -12188,7 +12570,7 @@ requested sync points if `automatic-request-sync-points` is enabled. default-value="FALSE"> If set to %TRUE the decoder will automatically request sync points when + line="685">If set to %TRUE the decoder will automatically request sync points when it seems like a good idea, e.g. if the first frames are not key frames or if packet loss was reported by upstream. @@ -12200,7 +12582,7 @@ if packet loss was reported by upstream. default-value="FALSE"> If set to %TRUE the decoder will discard frames that are marked as + line="670">If set to %TRUE the decoder will discard frames that are marked as corrupted instead of outputting them. @@ -12213,7 +12595,7 @@ corrupted instead of outputting them. default-value="-1"> Maximum number of tolerated consecutive decode errors. See + line="636">Maximum number of tolerated consecutive decode errors. See gst_video_decoder_set_max_errors() for more details. @@ -12224,7 +12606,7 @@ gst_video_decoder_set_max_errors() for more details. default-value="0"> Minimum interval between force-key-unit events sent upstream by the + line="650">Minimum interval between force-key-unit events sent upstream by the decoder. Setting this to 0 will cause every event to be handled, setting this to %GST_CLOCK_TIME_NONE will cause every event to be ignored. @@ -12239,7 +12621,7 @@ force-key-unit events. default-value="TRUE"> If set to %TRUE the decoder will handle QoS events received + line="621">If set to %TRUE the decoder will handle QoS events received from downstream elements. This includes dropping output frames which are detected as late using the metrics reported by those events. @@ -12287,6 +12669,11 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Called when the element changes to GST_STATE_READY. + Allows opening external resources. @@ -12301,6 +12688,11 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Called when the element changes to GST_STATE_NULL. + Allows closing external resources. @@ -12315,6 +12707,11 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Called when the element starts processing. + Allows opening external resources. @@ -12329,6 +12726,11 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Called when the element stops processing. + Allows closing external resources. @@ -12343,6 +12745,11 @@ and likely as well. If non-packetized input is supported or expected, + Required for non-packetized input. + Allows chopping incoming data into manageable units (frames) + for subsequent decoding. @@ -12366,6 +12773,9 @@ and likely as well. If non-packetized input is supported or expected, + Notifies subclass of incoming data format (caps). @@ -12383,6 +12793,11 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Allows subclass (decoder) to perform post-seek semantics reset. + Deprecated. @@ -12400,6 +12815,11 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Called to request subclass to dispatch any pending remaining + data at EOS. Sub-classes can refuse to decode new data after. @@ -12414,6 +12834,11 @@ and likely as well. If non-packetized input is supported or expected, + Provides input data frame to subclass. In subframe mode, the subclass needs + to take ownership of @GstVideoCodecFrame.input_buffer as it will be modified + by the base class on the next subframe buffer receiving. @@ -12437,6 +12862,14 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Event handler on the sink pad. This function should return + TRUE if the event was handled and should be discarded + (i.e. not unref'ed). + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -12454,6 +12887,14 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Event handler on the source pad. This function should return + TRUE if the event was handled and should be discarded + (i.e. not unref'ed). + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -12471,26 +12912,40 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Negotiate with downstream and configure buffer pools, etc. + Subclasses should chain up to the parent implementation to + invoke the default handler. %TRUE if the negotiation succeeded, else %FALSE. + line="4534">%TRUE if the negotiation succeeded, else %FALSE. a #GstVideoDecoder + line="4528">a #GstVideoDecoder + Optional. + Setup the allocation parameters for allocating output + buffers. The passed in query contains the result of the + downstream allocation query. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -12508,6 +12963,12 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Propose buffer allocation parameters for upstream elements. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -12525,6 +12986,11 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Flush all remaining data from the decoder without + pushing it downstream. Since: 1.2 @@ -12539,6 +13005,13 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Query handler on the sink pad. This function should + return TRUE if the query could be performed. Subclasses + should chain up to the parent implementation to invoke the + default handler. Since: 1.4 @@ -12556,6 +13029,13 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Query handler on the source pad. This function should + return TRUE if the query could be performed. Subclasses + should chain up to the parent implementation to invoke the + default handler. Since: 1.4 @@ -12573,6 +13053,13 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Allows for a custom sink getcaps implementation. + If not implemented, default returns + gst_video_decoder_proxy_getcaps + applied to sink template caps. @@ -12590,6 +13077,13 @@ and likely as well. If non-packetized input is supported or expected, + Optional. + Called to request subclass to decode any data it can at this + point, but that more data may arrive after. (e.g. at segment end). + Sub-classes should be prepared to handle new data afterward, + or seamless segment processing will break. Since: 1.6 @@ -12604,6 +13098,13 @@ and likely as well. If non-packetized input is supported or expected, + Optional. Transform the metadata on the input buffer to the + output buffer. By default this method is copies all meta without + tags and meta with only the "video" tag. subclasses can + implement this method and return %TRUE if the metadata is to be + copied. Since: 1.6 @@ -13023,6 +13524,11 @@ pipeline to catch up. line="300"/> + Optional. + Called when the element changes to GST_STATE_NULL. + Allows closing external resources. @@ -13035,6 +13541,14 @@ pipeline to catch up. + Optional. + Setup the allocation parameters for allocating output + buffers. The passed in query contains the result of the + downstream allocation query. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -13050,6 +13564,11 @@ pipeline to catch up. + Optional. + Called to request subclass to dispatch any pending remaining + data (e.g. at EOS). @@ -13062,6 +13581,11 @@ pipeline to catch up. + Optional. + Flush all remaining data from the encoder without + pushing it downstream. Since: 1.2 @@ -13074,6 +13598,13 @@ pipeline to catch up. + Optional. + Allows for a custom sink getcaps implementation (e.g. + for multichannel input specification). If not implemented, + default returns gst_video_encoder_proxy_getcaps + applied to sink template caps. @@ -13089,6 +13620,9 @@ pipeline to catch up. + Provides input frame to subclass. @@ -13127,6 +13661,11 @@ negotiate fails. + Optional. + Called when the element changes to GST_STATE_READY. + Allows opening external resources. @@ -13139,6 +13678,12 @@ negotiate fails. + Optional. + Allows subclass to push frame downstream in whatever + shape or form it deems appropriate. If not provided, + provided encoded frame data is simply pushed downstream. @@ -13154,6 +13699,12 @@ negotiate fails. + Optional. + Propose buffer allocation parameters for upstream elements. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -13169,6 +13720,11 @@ negotiate fails. + Optional. + Allows subclass (encoder) to perform post-seek semantics reset. + Deprecated. @@ -13184,6 +13740,12 @@ negotiate fails. + Optional. + Notifies subclass of incoming data format. + GstVideoCodecState fields have already been + set according to provided caps. @@ -13199,6 +13761,14 @@ negotiate fails. + Optional. + Event handler on the sink pad. This function should return + TRUE if the event was handled and should be discarded + (i.e. not unref'ed). + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -13214,6 +13784,13 @@ negotiate fails. + Optional. + Query handler on the sink pad. This function should + return TRUE if the query could be performed. Subclasses + should chain up to the parent implementation to invoke the + default handler. Since: 1.4 @@ -13229,6 +13806,14 @@ negotiate fails. + Optional. + Event handler on the source pad. This function should return + TRUE if the event was handled and should be discarded + (i.e. not unref'ed). + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -13244,6 +13829,13 @@ negotiate fails. + Optional. + Query handler on the source pad. This function should + return TRUE if the query could be performed. Subclasses + should chain up to the parent implementation to invoke the + default handler. Since: 1.4 @@ -13259,6 +13851,11 @@ negotiate fails. + Optional. + Called when the element starts processing. + Allows opening external resources. @@ -13271,6 +13868,11 @@ negotiate fails. + Optional. + Called when the element stops processing. + Allows closing external resources. @@ -13283,6 +13885,13 @@ negotiate fails. + Optional. Transform the metadata on the input buffer to the + output buffer. By default this method is copies all meta without + tags and meta with only the "video" tag. subclasses can + implement this method and return %TRUE if the metadata is to be + copied. Since: 1.6 @@ -14071,6 +14680,11 @@ and @get_caps are likely needed as well. + Optional. + Called when the element changes to GST_STATE_READY. + Allows opening external resources. @@ -14085,6 +14699,11 @@ and @get_caps are likely needed as well. + Optional. + Called when the element changes to GST_STATE_NULL. + Allows closing external resources. @@ -14099,6 +14718,11 @@ and @get_caps are likely needed as well. + Optional. + Called when the element starts processing. + Allows opening external resources. @@ -14113,6 +14737,11 @@ and @get_caps are likely needed as well. + Optional. + Called when the element stops processing. + Allows closing external resources. @@ -14127,6 +14756,12 @@ and @get_caps are likely needed as well. + Optional. + Notifies subclass of incoming data format. + GstVideoCodecState fields have already been + set according to provided caps. @@ -14144,6 +14779,9 @@ and @get_caps are likely needed as well. + Provides input frame to subclass. @@ -14161,6 +14799,11 @@ and @get_caps are likely needed as well. + Optional. + Allows subclass (encoder) to perform post-seek semantics reset. + Deprecated. @@ -14178,6 +14821,11 @@ and @get_caps are likely needed as well. + Optional. + Called to request subclass to dispatch any pending remaining + data (e.g. at EOS). @@ -14192,6 +14840,12 @@ and @get_caps are likely needed as well. + Optional. + Allows subclass to push frame downstream in whatever + shape or form it deems appropriate. If not provided, + provided encoded frame data is simply pushed downstream. @@ -14209,6 +14863,13 @@ and @get_caps are likely needed as well. + Optional. + Allows for a custom sink getcaps implementation (e.g. + for multichannel input specification). If not implemented, + default returns gst_video_encoder_proxy_getcaps + applied to sink template caps. @@ -14226,6 +14887,14 @@ and @get_caps are likely needed as well. + Optional. + Event handler on the sink pad. This function should return + TRUE if the event was handled and should be discarded + (i.e. not unref'ed). + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -14243,6 +14912,14 @@ and @get_caps are likely needed as well. + Optional. + Event handler on the source pad. This function should return + TRUE if the event was handled and should be discarded + (i.e. not unref'ed). + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -14260,6 +14937,12 @@ and @get_caps are likely needed as well. + Optional. + Negotiate with downstream and configure buffer pools, etc. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -14280,6 +14963,14 @@ and @get_caps are likely needed as well. + Optional. + Setup the allocation parameters for allocating output + buffers. The passed in query contains the result of the + downstream allocation query. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -14297,6 +14988,12 @@ and @get_caps are likely needed as well. + Optional. + Propose buffer allocation parameters for upstream elements. + Subclasses should chain up to the parent implementation to + invoke the default handler. @@ -14314,6 +15011,11 @@ and @get_caps are likely needed as well. + Optional. + Flush all remaining data from the encoder without + pushing it downstream. Since: 1.2 @@ -14328,6 +15030,13 @@ and @get_caps are likely needed as well. + Optional. + Query handler on the sink pad. This function should + return TRUE if the query could be performed. Subclasses + should chain up to the parent implementation to invoke the + default handler. Since: 1.4 @@ -14345,6 +15054,13 @@ and @get_caps are likely needed as well. + Optional. + Query handler on the source pad. This function should + return TRUE if the query could be performed. Subclasses + should chain up to the parent implementation to invoke the + default handler. Since: 1.4 @@ -14362,6 +15078,13 @@ and @get_caps are likely needed as well. + Optional. Transform the metadata on the input buffer to the + output buffer. By default this method is copies all meta without + tags and meta with only the "video" tag. subclasses can + implement this method and return %TRUE if the metadata is to be + copied. Since: 1.6 @@ -14499,6 +15222,9 @@ to implement frame dropping. + function to be called with the negotiated caps and video infos @@ -14523,6 +15249,9 @@ to implement frame dropping. + transform a video frame @@ -14541,6 +15270,9 @@ to implement frame dropping. + transform a video frame in place @@ -14589,6 +15321,9 @@ to implement frame dropping. c:type="GstBaseTransformClass"/> + function to be called with the negotiated caps and video infos @@ -14615,6 +15350,9 @@ to implement frame dropping. + transform a video frame @@ -14635,6 +15373,9 @@ to implement frame dropping. + transform a video frame in place @@ -15588,7 +16329,7 @@ for details about the layout and packing of these formats in memory. glib:name="GST_VIDEO_FORMAT_NV12_4L4"> NV12 with 4x4 tiles in linear order. + line="276">NV12 with 4x4 tiles in linear order. glib:name="GST_VIDEO_FORMAT_NV12_32L32"> NV12 with 32x32 tiles in linear order. + line="284">NV12 with 32x32 tiles in linear order. glib:name="GST_VIDEO_FORMAT_RGBP"> Planar 4:4:4 RGB, R-G-B order + line="293">Planar 4:4:4 RGB, R-G-B order glib:name="GST_VIDEO_FORMAT_BGRP"> Planar 4:4:4 RGB, B-G-R order + line="302">Planar 4:4:4 RGB, B-G-R order glib:name="GST_VIDEO_FORMAT_AV12"> Planar 4:2:0 YUV with interleaved UV plane with alpha as + line="311">Planar 4:2:0 YUV with interleaved UV plane with alpha as 3rd plane. glib:name="GST_VIDEO_FORMAT_ARGB64_LE"> RGB with alpha channel first, 16 bits (little endian) + line="321">RGB with alpha channel first, 16 bits (little endian) per channel. glib:name="GST_VIDEO_FORMAT_ARGB64_BE"> RGB with alpha channel first, 16 bits (big endian) + line="331">RGB with alpha channel first, 16 bits (big endian) per channel. glib:name="GST_VIDEO_FORMAT_RGBA64_LE"> RGB with alpha channel last, 16 bits (little endian) + line="341">RGB with alpha channel last, 16 bits (little endian) per channel. glib:name="GST_VIDEO_FORMAT_RGBA64_BE"> RGB with alpha channel last, 16 bits (big endian) + line="351">RGB with alpha channel last, 16 bits (big endian) per channel. glib:name="GST_VIDEO_FORMAT_BGRA64_LE"> Reverse RGB with alpha channel last, 16 bits (little endian) + line="361">Reverse RGB with alpha channel last, 16 bits (little endian) per channel. glib:name="GST_VIDEO_FORMAT_BGRA64_BE"> Reverse RGB with alpha channel last, 16 bits (big endian) -per channel. + line="371">Reverse RGB with alpha channel last, 16 bits (big endian) +per channel. + + + Reverse RGB with alpha channel first, 16 bits (little endian) +per channel. + + + Reverse RGB with alpha channel first, 16 bits (big endian) +per channel. + + + NV12 with 16x32 Y tiles and 16x16 UV tiles. + + + NV12 with 8x128 tiles in linear order. + + + NV12 10bit big endian with 8x128 tiles in linear order. + + + @GST_VIDEO_FORMAT_NV12_10LE40 with 4x4 pixels tiles (5 bytes + per tile row). This format is produced by Verisilicon/Hantro decoders. + + + @GST_VIDEO_FORMAT_DMA_DRM represent the DMA DRM special format. It's +only used with memory:DMABuf #GstCapsFeatures, where an extra +parameter (drm-format) is required to define the image format and +its memory layout. + + + Mediatek 10bit NV12 little endian with 16x32 tiles in linear order, tile 2 +bits. + + + Mediatek 10bit NV12 little endian with 16x32 tiles in linear order, raster +2 bits. + + + planar 4:4:2:2 YUV, 8 bits per channel + + + planar 4:4:4:4 YUV, 8 bits per channel + + + planar 4:4:4:4 YUV, 12 bits per channel + + + planar 4:4:4:4 YUV, 12 bits per channel + + + planar 4:4:2:2 YUV, 12 bits per channel + + + planar 4:4:2:2 YUV, 12 bits per channel + + + planar 4:4:2:0 YUV, 12 bits per channel + + + planar 4:4:2:0 YUV, 12 bits per channel + + + planar 4:4:4:4 YUV, 16 bits per channel + + + planar 4:4:4:4 YUV, 16 bits per channel + + + planar 4:4:2:2 YUV, 16 bits per channel - + Reverse RGB with alpha channel first, 16 bits (little endian) -per channel. + line="569">planar 4:4:2:2 YUV, 16 bits per channel - + Reverse RGB with alpha channel first, 16 bits (big endian) -per channel. + line="578">planar 4:4:2:0 YUV, 16 bits per channel - + NV12 with 16x32 Y tiles and 16x16 UV tiles. + line="587">planar 4:4:2:0 YUV, 16 bits per channel - + NV12 with 8x128 tiles in linear order. + line="596">planar 4:4:4 RGB, 16 bits per channel - + NV12 10bit big endian with 8x128 tiles in linear order. + line="605">planar 4:4:4 RGB, 16 bits per channel - + glib:nick="rbga" + glib:name="GST_VIDEO_FORMAT_RBGA"> @GST_VIDEO_FORMAT_NV12_10LE40 with 4x4 pixels tiles (5 bytes - per tile row). This format is produced by Verisilicon/Hantro decoders. + line="614">packed RGB with alpha, 8 bits per channel Converts a FOURCC value into the corresponding #GstVideoFormat. + line="7967">Converts a FOURCC value into the corresponding #GstVideoFormat. If the FOURCC cannot be represented by #GstVideoFormat, #GST_VIDEO_FORMAT_UNKNOWN is returned. + line="1039"/> the #GstVideoFormat describing the FOURCC value + line="7975">the #GstVideoFormat describing the FOURCC value a FOURCC value representing raw YUV video + line="7969">a FOURCC value representing raw YUV video @@ -15786,13 +16732,13 @@ If the FOURCC cannot be represented by #GstVideoFormat, Find the #GstVideoFormat for the given parameters. + line="7890">Find the #GstVideoFormat for the given parameters. + line="1034"/> a #GstVideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to + line="7903">a #GstVideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to not specify a known format. @@ -15800,44 +16746,44 @@ not specify a known format. the amount of bits used for a pixel + line="7892">the amount of bits used for a pixel the amount of bits used to store a pixel. This value is bigger than + line="7893">the amount of bits used to store a pixel. This value is bigger than @depth the endianness of the masks, #G_LITTLE_ENDIAN or #G_BIG_ENDIAN + line="7895">the endianness of the masks, #G_LITTLE_ENDIAN or #G_BIG_ENDIAN the red mask + line="7896">the red mask the green mask + line="7897">the green mask the blue mask + line="7898">the blue mask the alpha mask, or 0 if no alpha mask + line="7899">the alpha mask, or 0 if no alpha mask @@ -15845,13 +16791,13 @@ not specify a known format. Convert the @format string to its #GstVideoFormat. + line="8059">Convert the @format string to its #GstVideoFormat. + line="1042"/> the #GstVideoFormat for @format or GST_VIDEO_FORMAT_UNKNOWN when the + line="8065">the #GstVideoFormat for @format or GST_VIDEO_FORMAT_UNKNOWN when the string is not a known format. @@ -15859,7 +16805,7 @@ string is not a known format. a format string + line="8061">a format string @@ -15867,20 +16813,20 @@ string is not a known format. Get the #GstVideoFormatInfo for @format + line="8125">Get the #GstVideoFormatInfo for @format + line="1052"/> The #GstVideoFormatInfo for @format. + line="8131">The #GstVideoFormatInfo for @format. a #GstVideoFormat + line="8127">a #GstVideoFormat @@ -15890,14 +16836,14 @@ string is not a known format. version="1.2"> Get the default palette of @format. This the palette used in the pack + line="8141">Get the default palette of @format. This the palette used in the pack function for paletted formats. + line="1055"/> the default palette of @format or %NULL when + line="8149">the default palette of @format or %NULL when @format does not have a palette. @@ -15905,7 +16851,7 @@ function for paletted formats. a #GstVideoFormat + line="8143">a #GstVideoFormat transfer-ownership="full"> size of the palette in bytes + line="8144">size of the palette in bytes @@ -15922,22 +16868,22 @@ function for paletted formats. Converts a #GstVideoFormat value into the corresponding FOURCC. Only + line="8084">Converts a #GstVideoFormat value into the corresponding FOURCC. Only a few YUV formats have corresponding FOURCC values. If @format has no corresponding FOURCC value, 0 is returned. + line="1045"/> the FOURCC corresponding to @format + line="8092">the FOURCC corresponding to @format a #GstVideoFormat video format + line="8086">a #GstVideoFormat video format @@ -15945,21 +16891,21 @@ no corresponding FOURCC value, 0 is returned. Returns a string containing a descriptive name for + line="8105">Returns a string containing a descriptive name for the #GstVideoFormat if there is one, or NULL otherwise. + line="1048"/> the name corresponding to @format + line="8112">the name corresponding to @format a #GstVideoFormat video format + line="8107">a #GstVideoFormat video format @@ -15971,7 +16917,7 @@ the #GstVideoFormat if there is one, or NULL otherwise. c:type="GstVideoFormatFlags"> The different video flags that a format info can have. + line="629">The different video flags that a format info can have. glib:name="GST_VIDEO_FORMAT_FLAG_YUV"> The video format is YUV, components are numbered + line="631">The video format is YUV, components are numbered 0=Y, 1=U, 2=V. glib:name="GST_VIDEO_FORMAT_FLAG_RGB"> The video format is RGB, components are numbered + line="633">The video format is RGB, components are numbered 0=R, 1=G, 2=B. glib:name="GST_VIDEO_FORMAT_FLAG_GRAY"> The video is gray, there is one gray component + line="635">The video is gray, there is one gray component with index 0. glib:name="GST_VIDEO_FORMAT_FLAG_ALPHA"> The video format has an alpha components with + line="637">The video format has an alpha components with the number 3. glib:name="GST_VIDEO_FORMAT_FLAG_LE"> The video format has data stored in little + line="639">The video format has data stored in little endianness. glib:name="GST_VIDEO_FORMAT_FLAG_PALETTE"> The video format has a palette. The palette + line="641">The video format has a palette. The palette is stored in the second plane and indexes are stored in the first plane. glib:name="GST_VIDEO_FORMAT_FLAG_COMPLEX"> The video format has a complex layout that + line="643">The video format has a complex layout that can't be described with the usual information in the #GstVideoFormatInfo. glib:name="GST_VIDEO_FORMAT_FLAG_UNPACK"> This format can be used in a + line="645">This format can be used in a #GstVideoFormatUnpack and #GstVideoFormatPack function. glib:name="GST_VIDEO_FORMAT_FLAG_TILED"> The format is tiled, there is tiling information + line="647">The format is tiled, there is tiling information in the last plane. glib:name="GST_VIDEO_FORMAT_FLAG_SUBTILES"> The tile size varies per plane according to the subsampling. + line="665">The tile size varies per plane according to the subsampling. Information for a video format. + line="785">Information for a video format. + line="859"/> #GstVideoFormat + line="787">#GstVideoFormat string representation of the format + line="788">string representation of the format use readable description of the format + line="789">use readable description of the format #GstVideoFormatFlags + line="790">#GstVideoFormatFlags The number of bits used to pack data items. This can be less than 8 + line="791">The number of bits used to pack data items. This can be less than 8 when multiple pixels are stored in a byte. for values > 8 multiple bytes should be read according to the endianness flag before applying the shift and mask. @@ -16115,13 +17061,13 @@ the #GstVideoFormat if there is one, or NULL otherwise. the number of components in the video format. + line="795">the number of components in the video format. the number of bits to shift away to get the component data + line="796">the number of bits to shift away to get the component data @@ -16129,7 +17075,7 @@ the #GstVideoFormat if there is one, or NULL otherwise. the depth in bits for each component + line="797">the depth in bits for each component @@ -16137,7 +17083,7 @@ the #GstVideoFormat if there is one, or NULL otherwise. the pixel stride of each component. This is the amount of + line="798">the pixel stride of each component. This is the amount of bytes to the pixel immediately to the right. When bits < 8, the stride is expressed in bits. For 24-bit RGB, this would be 3 bytes, for example, while it would be 4 bytes for RGBx or ARGB. @@ -16148,7 +17094,7 @@ the #GstVideoFormat if there is one, or NULL otherwise. the number of planes for this format. The number of planes can be + line="802">the number of planes for this format. The number of planes can be less than the amount of components when multiple components are packed into one plane. @@ -16156,7 +17102,7 @@ the #GstVideoFormat if there is one, or NULL otherwise. the plane number where a component can be found + line="805">the plane number where a component can be found @@ -16164,7 +17110,7 @@ the #GstVideoFormat if there is one, or NULL otherwise. the offset in the plane where the first pixel of the components + line="806">the offset in the plane where the first pixel of the components can be found. @@ -16173,7 +17119,7 @@ the #GstVideoFormat if there is one, or NULL otherwise. subsampling factor of the width for the component. Use + line="808">subsampling factor of the width for the component. Use GST_VIDEO_SUB_SCALE to scale a width. @@ -16182,7 +17128,7 @@ the #GstVideoFormat if there is one, or NULL otherwise. subsampling factor of the height for the component. Use + line="810">subsampling factor of the height for the component. Use GST_VIDEO_SUB_SCALE to scale a height. @@ -16191,52 +17137,52 @@ the #GstVideoFormat if there is one, or NULL otherwise. the format of the unpacked pixels. This format must have the + line="812">the format of the unpacked pixels. This format must have the #GST_VIDEO_FORMAT_FLAG_UNPACK flag set. an unpack function for this format + line="814">an unpack function for this format the amount of lines that will be packed + line="815">the amount of lines that will be packed an pack function for this format + line="816">an pack function for this format The tiling mode + line="817">The tiling mode The width of a tile, in bytes, represented as a shift. DEPRECATED, + line="818">The width of a tile, in bytes, represented as a shift. DEPRECATED, use tile_info[] array instead. The height of a tile, in bytes, represented as a shift. DEPREACTED, + line="820">The height of a tile, in bytes, represented as a shift. DEPREACTED, use tile_info[] array instead. Information about the tiles for each of the planes. + line="851">Information about the tiles for each of the planes. @@ -16246,11 +17192,11 @@ use tile_info[] array instead. version="1.18"> Fill @components with the number of all the components packed in plane @p + line="8169">Fill @components with the number of all the components packed in plane @p for the format @info. A value of -1 in @components indicates that no more components are packed in the plane. + line="1025"/> @@ -16258,13 +17204,13 @@ components are packed in the plane. #GstVideoFormatInfo + line="8171">#GstVideoFormatInfo a plane number + line="8172">a plane number transfer-ownership="full"> array used to store component numbers + line="8173">array used to store component numbers @@ -16283,33 +17229,33 @@ components are packed in the plane. version="1.22"> Extrapolate @plane stride from the first stride of an image. This helper is + line="8199">Extrapolate @plane stride from the first stride of an image. This helper is useful to support legacy API were only one stride is supported. + line="1028"/> The extrapolated stride for @plane + line="8208">The extrapolated stride for @plane #GstVideoFormatInfo + line="8201">#GstVideoFormatInfo a plane number + line="8202">a plane number The fist plane stride + line="8203">The fist plane stride @@ -16318,7 +17264,7 @@ useful to support legacy API were only one stride is supported. Packs @width pixels from @src to the given planes and strides in the + line="745">Packs @width pixels from @src to the given planes and strides in the format @info. The pixels from source have each component interleaved and will be packed into the planes in @data. @@ -16335,7 +17281,7 @@ pack pixels starting from an unaligned position. For tiled images this means that packing should start from a tile coordinate. For subsampled formats this means that a complete pixel needs to be packed. + line="777"/> @@ -16343,13 +17289,13 @@ formats this means that a complete pixel needs to be packed. a #GstVideoFormatInfo + line="747">a #GstVideoFormatInfo flags to control the packing + line="748">flags to control the packing allow-none="1"> a source array + line="749">a source array the source array stride + line="750">the source array stride allow-none="1"> pointers to the destination data planes + line="751">pointers to the destination data planes strides of the destination planes + line="752">strides of the destination planes the chroma siting of the target when subsampled (not used) + line="753">the chroma siting of the target when subsampled (not used) the y position in the image to pack to + line="754">the y position in the image to pack to the amount of pixels to pack. + line="755">the amount of pixels to pack. @@ -16405,7 +17351,7 @@ formats this means that a complete pixel needs to be packed. Unpacks @width pixels from the given planes and strides containing data of + line="715">Unpacks @width pixels from the given planes and strides containing data of format @info. The pixels will be unpacked into @dest with each component interleaved as per @info's unpack_format, which will usually be one of #GST_VIDEO_FORMAT_ARGB, #GST_VIDEO_FORMAT_AYUV, #GST_VIDEO_FORMAT_ARGB64 or @@ -16419,7 +17365,7 @@ For subsampled formats, the components will be duplicated in the destination array. Reconstruction of the missing components can be performed in a separate step after unpacking. + line="740"/> @@ -16427,13 +17373,13 @@ separate step after unpacking. a #GstVideoFormatInfo + line="717">a #GstVideoFormatInfo flags to control the unpacking + line="718">flags to control the unpacking allow-none="1"> a destination array + line="719">a destination array allow-none="1"> pointers to the data planes + line="720">pointers to the data planes strides of the planes + line="721">strides of the planes the x position in the image to start from + line="722">the x position in the image to start from the y position in the image to start from + line="723">the y position in the image to start from the amount of pixels to unpack. + line="724">the amount of pixels to unpack. @@ -16903,7 +17849,7 @@ All video planes of @buffer will be mapped and the pointers will be set in c:type="GstVideoGLTextureOrientation"> The orientation of the GL texture. + line="216">The orientation of the GL texture. Top line first in memory, left row first + line="218">Top line first in memory, left row first Bottom line first in memory, left row first + line="219">Bottom line first in memory, left row first Top line first in memory, right row first + line="220">Top line first in memory, right row first Bottom line first in memory, right row first + line="221">Bottom line first in memory, right row first The GL texture type. + line="193">The GL texture type. Luminance texture, GL_LUMINANCE + line="195">Luminance texture, GL_LUMINANCE Luminance-alpha texture, GL_LUMINANCE_ALPHA + line="196">Luminance-alpha texture, GL_LUMINANCE_ALPHA RGB 565 texture, GL_RGB + line="197">RGB 565 texture, GL_RGB RGB texture, GL_RGB + line="198">RGB texture, GL_RGB RGBA texture, GL_RGBA + line="199">RGBA texture, GL_RGBA R texture, GL_RED_EXT + line="200">R texture, GL_RED_EXT RG texture, GL_RG_EXT + line="201">RG texture, GL_RG_EXT + line="237"/> @@ -17032,35 +17978,35 @@ All video planes of @buffer will be mapped and the pointers will be set in c:type="GstVideoGLTextureUploadMeta"> Extra buffer metadata for uploading a buffer to an OpenGL texture + line="254">Extra buffer metadata for uploading a buffer to an OpenGL texture ID. The caller of gst_video_gl_texture_upload_meta_upload() must have OpenGL set up and call this from a thread where it is valid to upload something to an OpenGL texture. + line="281"/> parent #GstMeta + line="256">parent #GstMeta Orientation of the textures + line="257">Orientation of the textures Number of textures that are generated + line="258">Number of textures that are generated Type of each texture + line="259">Type of each texture @@ -17084,27 +18030,27 @@ to upload something to an OpenGL texture. c:identifier="gst_video_gl_texture_upload_meta_upload"> Uploads the buffer which owns the meta to a specific texture ID. + line="929">Uploads the buffer which owns the meta to a specific texture ID. + line="303"/> %TRUE if uploading succeeded, %FALSE otherwise. + line="936">%TRUE if uploading succeeded, %FALSE otherwise. a #GstVideoGLTextureUploadMeta + line="931">a #GstVideoGLTextureUploadMeta the texture IDs to upload to + line="932">the texture IDs to upload to @@ -17112,7 +18058,7 @@ to upload something to an OpenGL texture. + line="287"/> @@ -17313,7 +18259,7 @@ gst_video_info_init(). Adjust the offset and stride fields in @info so that the padding and + line="1614">Adjust the offset and stride fields in @info so that the padding and stride alignment in @align is respected. Extra padding will be added to the right side when stride alignment padding @@ -17323,7 +18269,7 @@ is required and @align will be updated with the new padding values. %FALSE if alignment could not be applied, e.g. because the + line="1625">%FALSE if alignment could not be applied, e.g. because the size of a frame can't be represented as a 32 bit integer (Since: 1.12) @@ -17331,13 +18277,13 @@ is required and @align will be updated with the new padding values. a #GstVideoInfo + line="1616">a #GstVideoInfo alignment parameters + line="1617">alignment parameters @@ -17347,7 +18293,7 @@ is required and @align will be updated with the new padding values. version="1.18"> Extra padding will be added to the right side when stride alignment padding + line="1493">Extra padding will be added to the right side when stride alignment padding is required and @align will be updated with the new padding values. This variant of gst_video_info_align() provides the updated size, in bytes, @@ -17361,7 +18307,7 @@ ones used to hold a single field, not the full frame. %FALSE if alignment could not be applied, e.g. because the + line="1509">%FALSE if alignment could not be applied, e.g. because the size of a frame can't be represented as a 32 bit integer @@ -17369,13 +18315,13 @@ ones used to hold a single field, not the full frame. a #GstVideoInfo + line="1495">a #GstVideoInfo alignment parameters + line="1496">alignment parameters allow-none="1"> array used to store the plane sizes + line="1497">array used to store the plane sizes @@ -17394,7 +18340,7 @@ ones used to hold a single field, not the full frame. Converts among various #GstFormat types. This function handles + line="1367">Converts among various #GstFormat types. This function handles GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For raw video, GST_FORMAT_DEFAULT corresponds to video frames. This function can be used to handle pad queries of the type GST_QUERY_CONVERT. @@ -17403,32 +18349,32 @@ function can be used to handle pad queries of the type GST_QUERY_CONVERT. TRUE if the conversion was successful. + line="1380">TRUE if the conversion was successful. a #GstVideoInfo + line="1369">a #GstVideoInfo #GstFormat of the @src_value + line="1370">#GstFormat of the @src_value value to convert + line="1371">value to convert #GstFormat of the @dest_value + line="1372">#GstFormat of the @dest_value transfer-ownership="full"> pointer to destination value + line="1373">pointer to destination value @@ -17605,20 +18551,20 @@ mode. Convert the values of @info into a #GstCaps. + line="657">Convert the values of @info into a #GstCaps. a new #GstCaps containing the info of @info. + line="663">a new #GstCaps containing the info of @info. a #GstVideoInfo + line="659">a #GstVideoInfo @@ -17683,27 +18629,27 @@ mode. c:symbol-prefix="video_info_dma_drm"> Information describing a DMABuf image properties. It wraps #GstVideoInfo and + line="46">Information describing a DMABuf image properties. It wraps #GstVideoInfo and adds DRM information such as drm-fourcc and drm-modifier, required for negotiation and mapping. + line="66"/> the associated #GstVideoInfo + line="48">the associated #GstVideoInfo the fourcc defined by drm + line="49">the fourcc defined by drm the drm modifier + line="50">the drm modifier @@ -17716,14 +18662,14 @@ negotiation and mapping. version="1.24"> Allocate a new #GstVideoInfoDmaDrm that is also initialized with + line="221">Allocate a new #GstVideoInfoDmaDrm that is also initialized with gst_video_info_dma_drm_init(). + line="80"/> a new #GstVideoInfoDmaDrm. + line="227">a new #GstVideoInfoDmaDrm. Free it with gst_video_info_dma_drm_free(). @@ -17733,15 +18679,15 @@ Free it with gst_video_info_dma_drm_free(). version="1.24"> Parse @caps to generate a #GstVideoInfoDmaDrm. Please note that the + line="405">Parse @caps to generate a #GstVideoInfoDmaDrm. Please note that the @caps should be a dma drm caps. The gst_video_is_dma_drm_caps() can be used to verify it before calling this function. + line="100"/> A #GstVideoInfoDmaDrm, + line="413">A #GstVideoInfoDmaDrm, or %NULL if @caps couldn't be parsed. @@ -17749,7 +18695,7 @@ be used to verify it before calling this function. a #GstCaps + line="407">a #GstCaps @@ -17759,10 +18705,10 @@ be used to verify it before calling this function. version="1.24"> Free a #GstVideoInfoDmaDrm structure previously allocated with + line="183">Free a #GstVideoInfoDmaDrm structure previously allocated with gst_video_info_dma_drm_new() + line="74"/> @@ -17770,7 +18716,7 @@ gst_video_info_dma_drm_new() a #GstVideoInfoDmaDrm + line="185">a #GstVideoInfoDmaDrm @@ -17780,16 +18726,16 @@ gst_video_info_dma_drm_new() version="1.24"> Convert the values of @drm_info into a #GstCaps. Please note that the -@caps returned will be a dma drm caps which does not contain format field, -but contains a drm-format field instead. The value of drm-format field is + line="277">Convert the values of @drm_info into a #GstCaps. Please note that the +@caps returned will be a dma drm caps which sets format field to DMA_DRM, +and contains a new drm-format field. The value of drm-format field is composed of a drm fourcc and a modifier, such as NV12:0x0100000000000002. + line="83"/> a new #GstCaps containing the + line="286">a new #GstCaps containing the info in @drm_info. @@ -17797,9 +18743,45 @@ info in @drm_info. a #GstVideoInfoDmaDrm + line="279">a #GstVideoInfoDmaDrm + + + + + + Convert the #GstVideoInfoDmaDrm into a traditional #GstVideoInfo with +recognized video format. For DMA kind memory, the non linear DMA format +should be recognized as #GST_VIDEO_FORMAT_DMA_DRM. This helper function +sets @info's video format into the default value according to @drm_info's +drm_fourcc field. + + + %TRUE if @info is converted correctly. + + + + + a #GstVideoInfoDmaDrm + + #GstVideoInfo + + version="1.24"> Parse @caps and update @info. Please note that the @caps should be + line="323">Parse @caps and update @info. Please note that the @caps should be a dma drm caps. The gst_video_is_dma_drm_caps() can be used to verify it before calling this function. + line="86"/> TRUE if @caps could be parsed + line="332">TRUE if @caps could be parsed @@ -17825,13 +18807,13 @@ it before calling this function. transfer-ownership="none"> #GstVideoInfoDmaDrm + line="325">#GstVideoInfoDmaDrm a #GstCaps + line="326">a #GstCaps @@ -17841,14 +18823,14 @@ it before calling this function. version="1.24"> Fills @drm_info if @info's format has a valid drm format and @modifier is also + line="438">Fills @drm_info if @info's format has a valid drm format and @modifier is also valid + line="90"/> %TRUE if @drm_info is filled correctly. + line="447">%TRUE if @drm_info is filled correctly. @@ -17858,19 +18840,19 @@ valid transfer-ownership="none"> #GstVideoInfoDmaDrm + line="440">#GstVideoInfoDmaDrm a #GstVideoInfo + line="441">a #GstVideoInfo the associated modifier value. + line="442">the associated modifier value. @@ -17880,9 +18862,9 @@ valid version="1.24"> Initialize @drm_info with default values. + line="202">Initialize @drm_info with default values. + line="77"/> @@ -17893,7 +18875,7 @@ valid transfer-ownership="none"> a #GstVideoInfoDmaDrm + line="204">a #GstVideoInfoDmaDrm @@ -18307,8 +19289,12 @@ fields: - padding-left (uint): extra pixels on the left side - padding-right (uint): extra pixels on the right side The padding fields have the same semantic as #GstVideoMeta.alignment -and so represent the paddings requested on produced video buffers. - +and so represent the paddings requested on produced video buffers. + +Since 1.24 it can be serialized using gst_meta_serialize() and +gst_meta_deserialize(). + + map the memory of a plane + line="96"/> @@ -18405,9 +19394,12 @@ and so represent the paddings requested on produced video buffers. + unmap the memory of a plane + line="98"/> @@ -18438,17 +19430,17 @@ to no padding and no alignment. Since: 1.18 version="1.18"> Compute the padded height of each plane from @meta (padded size + line="626">Compute the padded height of each plane from @meta (padded size divided by stride). It is not valid to call this function with a meta associated to a TILED video format. + line="139"/> %TRUE if @meta's alignment is valid and @plane_height has been + line="637">%TRUE if @meta's alignment is valid and @plane_height has been updated, %FALSE otherwise @@ -18456,7 +19448,7 @@ updated, %FALSE otherwise a #GstVideoMeta + line="628">a #GstVideoMeta transfer-ownership="none"> array used to store the plane height + line="629">array used to store the plane height @@ -18477,14 +19469,14 @@ updated, %FALSE otherwise version="1.18"> Compute the size, in bytes, of each video plane described in @meta including + line="603">Compute the size, in bytes, of each video plane described in @meta including any padding and alignment constraint defined in @meta->alignment. + line="136"/> %TRUE if @meta's alignment is valid and @plane_size has been + line="611">%TRUE if @meta's alignment is valid and @plane_size has been updated, %FALSE otherwise @@ -18492,7 +19484,7 @@ updated, %FALSE otherwise a #GstVideoMeta + line="605">a #GstVideoMeta transfer-ownership="none"> array used to store the plane sizes + line="606">array used to store the plane sizes @@ -18511,33 +19503,33 @@ updated, %FALSE otherwise Map the video plane with index @plane in @meta and return a pointer to the + line="460">Map the video plane with index @plane in @meta and return a pointer to the first byte of the plane and the stride of the plane. + line="126"/> TRUE if the map operation was successful. + line="472">TRUE if the map operation was successful. a #GstVideoMeta + line="462">a #GstVideoMeta a plane + line="463">a plane a #GstMapInfo + line="464">a #GstMapInfo nullable="1"> the data of @plane + line="465">the data of @plane transfer-ownership="full"> the stride of @plane + line="466">the stride of @plane @GstMapFlags + line="467">@GstMapFlags @@ -18572,28 +19564,28 @@ first byte of the plane and the stride of the plane. version="1.18"> Set the alignment of @meta to @alignment. This function checks that + line="567">Set the alignment of @meta to @alignment. This function checks that the paddings defined in @alignment are compatible with the strides defined in @meta and will fail to update if they are not. + line="133"/> %TRUE if @alignment's meta has been updated, %FALSE if not + line="576">%TRUE if @alignment's meta has been updated, %FALSE if not a #GstVideoMeta + line="569">a #GstVideoMeta a #GstVideoAlignment + line="570">a #GstVideoAlignment @@ -18601,39 +19593,39 @@ defined in @meta and will fail to update if they are not. Unmap a previously mapped plane with gst_video_meta_map(). + line="491">Unmap a previously mapped plane with gst_video_meta_map(). + line="130"/> TRUE if the memory was successfully unmapped. + line="499">TRUE if the memory was successfully unmapped. a #GstVideoMeta + line="493">a #GstVideoMeta a plane + line="494">a plane a #GstMapInfo + line="495">a #GstMapInfo + line="107"/> @@ -18642,33 +19634,33 @@ defined in @meta and will fail to update if they are not. Extra data passed to a video transform #GstMetaTransformFunction such as: + line="180">Extra data passed to a video transform #GstMetaTransformFunction such as: "gst-video-scale". + line="191"/> the input #GstVideoInfo + line="182">the input #GstVideoInfo the output #GstVideoInfo + line="183">the output #GstVideoInfo Get the #GQuark for the "gst-video-scale" metadata transform operation. + line="762">Get the #GQuark for the "gst-video-scale" metadata transform operation. + line="172"/> a #GQuark + line="767">a #GQuark @@ -19629,6 +20621,9 @@ operation of video-sources or operators. + virtual method to get horizontal flipping state @@ -19658,6 +20653,9 @@ operation of video-sources or operators. + virtual method to get vertical flipping state @@ -19687,6 +20685,9 @@ operation of video-sources or operators. + virtual method to get horizontal centering state @@ -19716,6 +20717,9 @@ operation of video-sources or operators. + virtual method to get vertical centering state @@ -19745,6 +20749,9 @@ operation of video-sources or operators. + virtual method to set horizontal flipping state @@ -19771,6 +20778,9 @@ operation of video-sources or operators. + virtual method to set vertical flipping state @@ -19797,6 +20807,9 @@ operation of video-sources or operators. + virtual method to set horizontal centering state @@ -19823,6 +20836,9 @@ operation of video-sources or operators. + virtual method to set vertical centering state @@ -20336,6 +21352,9 @@ from the #GstVideoOverlay. + virtual method to set the render rectangle @@ -20910,6 +21929,9 @@ contained in the rectangles are not copied. + virtual method to handle expose events @@ -20927,6 +21949,9 @@ contained in the rectangles are not copied. + virtual method to handle events @@ -20950,6 +21975,9 @@ contained in the rectangles are not copied. + virtual method to set the render rectangle @@ -20976,6 +22004,9 @@ contained in the rectangles are not copied. + virtual method to configure the window handle @@ -21575,7 +22606,7 @@ gst_video_overlay_composition_copy(). c:type="GstVideoPackFlags"> The different flags that can be used when packing and unpacking. + line="694">The different flags that can be used when packing and unpacking. glib:name="GST_VIDEO_PACK_FLAG_NONE"> No flag + line="696">No flag glib:name="GST_VIDEO_PACK_FLAG_TRUNCATE_RANGE"> When the source has a smaller depth + line="697">When the source has a smaller depth than the target format, set the least significant bits of the target to 0. This is likely slightly faster but less accurate. When this flag is not specified, the most significant bits of the source are duplicated @@ -21605,7 +22636,7 @@ gst_video_overlay_composition_copy(). glib:name="GST_VIDEO_PACK_FLAG_INTERLACED"> The source is interlaced. The unpacked + line="702">The source is interlaced. The unpacked format will be interlaced as well with each line containing information from alternating fields. (Since: 1.2) @@ -21681,61 +22712,61 @@ gst_video_overlay_composition_copy(). c:type="GstVideoRegionOfInterestMeta"> Extra buffer metadata describing an image region of interest + line="307">Extra buffer metadata describing an image region of interest + line="335"/> parent #GstMeta + line="309">parent #GstMeta GQuark describing the semantic of the Roi (f.i. a face, a pedestrian) + line="310">GQuark describing the semantic of the Roi (f.i. a face, a pedestrian) identifier of this particular ROI + line="311">identifier of this particular ROI identifier of its parent ROI, used f.i. for ROI hierarchisation. + line="312">identifier of its parent ROI, used f.i. for ROI hierarchisation. x component of upper-left corner + line="313">x component of upper-left corner y component of upper-left corner + line="314">y component of upper-left corner bounding box width + line="315">bounding box width bounding box height + line="316">bounding box height list of #GstStructure containing element-specific params for downstream, + line="317">list of #GstStructure containing element-specific params for downstream, see gst_video_region_of_interest_meta_add_param(). (Since: 1.14) @@ -21746,7 +22777,7 @@ gst_video_overlay_composition_copy(). version="1.14"> Attach element-specific parameters to @meta meant to be used by downstream + line="1146">Attach element-specific parameters to @meta meant to be used by downstream elements which may handle this ROI. The name of @s is used to identify the element these parameters are meant for. @@ -21756,7 +22787,7 @@ QP offsets this encoder should use when encoding the region described in @meta. Multiple parameters can be defined for the same meta so different encoders can be supported by cross platform applications). + line="366"/> @@ -21764,14 +22795,14 @@ can be supported by cross platform applications). a #GstVideoRegionOfInterestMeta + line="1148">a #GstVideoRegionOfInterestMeta a #GstStructure + line="1149">a #GstStructure @@ -21781,30 +22812,30 @@ can be supported by cross platform applications). version="1.14"> Retrieve the parameter for @meta having @name as structure name, + line="1173">Retrieve the parameter for @meta having @name as structure name, or %NULL if there is none. See also: gst_video_region_of_interest_meta_add_param() + line="370"/> a #GstStructure + line="1181">a #GstStructure a #GstVideoRegionOfInterestMeta + line="1175">a #GstVideoRegionOfInterestMeta a name. + line="1176">a name. @@ -21812,7 +22843,7 @@ See also: gst_video_region_of_interest_meta_add_param() + line="341"/> @@ -22584,6 +23615,12 @@ observing out-of-sync frames. + render a video frame. Maps to #GstBaseSinkClass.render() and + #GstBaseSinkClass.preroll() vfuncs. Rendering during preroll will be + suppressed if the #GstVideoSink:show-preroll-frame property is set to + %FALSE. @@ -22649,6 +23686,12 @@ frames will only be rendered in PLAYING state. + render a video frame. Maps to #GstBaseSinkClass.render() and + #GstBaseSinkClass.preroll() vfuncs. Rendering during preroll will be + suppressed if the #GstVideoSink:show-preroll-frame property is set to + %FALSE. @@ -23834,28 +24877,28 @@ Will not necessarily correspond to a real timecode (e.g. 00:00:10;00) version="1.10"> Extra buffer metadata describing the GstVideoTimeCode of the frame. + line="373">Extra buffer metadata describing the GstVideoTimeCode of the frame. Each frame is assumed to have its own timecode, i.e. they are not automatically incremented/interpolated. + line="389"/> parent #GstMeta + line="375">parent #GstMeta the GstVideoTimeCode to attach + line="376">the GstVideoTimeCode to attach + line="396"/> @@ -24231,20 +25274,20 @@ and "ITU-T H.273 Table 3". c:symbol-prefix="video_vbi_encoder"> An encoder for writing ancillary data to the + line="613">An encoder for writing ancillary data to the Vertical Blanking Interval lines of component signals. - + Create a new #GstVideoVBIEncoder for the specified @format and @pixel_width. - + line="606">Create a new #GstVideoVBIEncoder for the specified @format and @pixel_width. + The new #GstVideoVBIEncoder or %NULL if the @format and/or @pixel_width + line="615">The new #GstVideoVBIEncoder or %NULL if the @format and/or @pixel_width is not supported. @@ -24252,13 +25295,13 @@ is not supported. a #GstVideoFormat + line="608">a #GstVideoFormat The width in pixel to use + line="609">The width in pixel to use @@ -24268,15 +25311,15 @@ is not supported. version="1.16"> Stores Video Ancillary data, according to SMPTE-291M specification. + line="690">Stores Video Ancillary data, according to SMPTE-291M specification. Note that the contents of the data are always read as 8bit data (i.e. do not contain the parity check bits). - + %TRUE if enough space was left in the current line, %FALSE + line="708">%TRUE if enough space was left in the current line, %FALSE otherwise. @@ -24284,32 +25327,32 @@ the parity check bits). a #GstVideoVBIEncoder + line="692">a #GstVideoVBIEncoder %TRUE if composite ADF should be created, component otherwise + line="693">%TRUE if composite ADF should be created, component otherwise The Data Identifier + line="694">The Data Identifier The Secondary Data Identifier (if type 2) or the Data + line="695">The Secondary Data Identifier (if type 2) or the Data Block Number (if type 1) The user data content of the Ancillary packet. + line="698">The user data content of the Ancillary packet. Does not contain the ADF, DID, SDID nor CS. @@ -24318,13 +25361,13 @@ the parity check bits). The amount of data (in bytes) in @data (max 255 bytes) + line="697">The amount of data (in bytes) in @data (max 255 bytes) - + @@ -24339,8 +25382,8 @@ the parity check bits). version="1.16"> Frees the @encoder. - + line="589">Frees the @encoder. + @@ -24348,14 +25391,14 @@ the parity check bits). a #GstVideoVBIEncoder + line="591">a #GstVideoVBIEncoder - + @@ -24378,20 +25421,20 @@ the parity check bits). c:symbol-prefix="video_vbi_parser"> A parser for detecting and extracting @GstVideoAncillary data from + line="567">A parser for detecting and extracting @GstVideoAncillary data from Vertical Blanking Interval lines of component signals. - + Create a new #GstVideoVBIParser for the specified @format and @pixel_width. - + line="325">Create a new #GstVideoVBIParser for the specified @format and @pixel_width. + The new #GstVideoVBIParser or %NULL if the @format and/or @pixel_width + line="334">The new #GstVideoVBIParser or %NULL if the @format and/or @pixel_width is not supported. @@ -24399,13 +25442,13 @@ is not supported. a #GstVideoFormat + line="327">a #GstVideoFormat The width in pixel to use + line="328">The width in pixel to use @@ -24415,9 +25458,9 @@ is not supported. version="1.16"> Provide a new line of data to the @parser. Call gst_video_vbi_parser_get_ancillary() + line="528">Provide a new line of data to the @parser. Call gst_video_vbi_parser_get_ancillary() to get the Ancillary data that might be present on that line. - + @@ -24425,13 +25468,13 @@ to get the Ancillary data that might be present on that line. a #GstVideoVBIParser + line="530">a #GstVideoVBIParser The line of data to parse + line="531">The line of data to parse @@ -24439,7 +25482,7 @@ to get the Ancillary data that might be present on that line. - + @@ -24454,8 +25497,8 @@ to get the Ancillary data that might be present on that line. version="1.16"> Frees the @parser. - + line="379">Frees the @parser. + @@ -24463,7 +25506,7 @@ to get the Ancillary data that might be present on that line. a #GstVideoVBIParser + line="381">a #GstVideoVBIParser @@ -24473,12 +25516,12 @@ to get the Ancillary data that might be present on that line. version="1.16"> Parse the line provided previously by gst_video_vbi_parser_add_line(). - + line="299">Parse the line provided previously by gst_video_vbi_parser_add_line(). + %GST_VIDEO_VBI_PARSER_RESULT_OK if ancillary data was found and + line="308">%GST_VIDEO_VBI_PARSER_RESULT_OK if ancillary data was found and @anc was filled. %GST_VIDEO_VBI_PARSER_RESULT_DONE if there wasn't any data. @@ -24487,7 +25530,7 @@ data. a #GstVideoVBIParser + line="301">a #GstVideoVBIParser transfer-ownership="none"> a #GstVideoAncillary to start the eventual ancillary data + line="302">a #GstVideoAncillary to start the eventual ancillary data @@ -24509,7 +25552,7 @@ data. c:type="GstVideoVBIParserResult"> Return values for #GstVideoVBIParser + line="581">Return values for #GstVideoVBIParser glib:name="GST_VIDEO_VBI_PARSER_RESULT_DONE"> No line were provided, or no more Ancillary data was found. + line="583">No line were provided, or no more Ancillary data was found. glib:name="GST_VIDEO_VBI_PARSER_RESULT_OK"> A #GstVideoAncillary was found. + line="584">A #GstVideoAncillary was found. glib:name="GST_VIDEO_VBI_PARSER_RESULT_ERROR"> An error occurred + line="585">An error occurred + + + + + + + + + + + + + + Adds a new #GstAncillaryMeta to the @buffer. The caller is responsible for setting the appropriate +fields. + + + A new #GstAncillaryMeta, or %NULL if an error happened. + + + + + A #GstBuffer + + + + Attaches #GstVideoAFDMeta metadata to @buffer with the given + line="1334">Attaches #GstVideoAFDMeta metadata to @buffer with the given parameters. - + the #GstVideoAFDMeta on @buffer. + line="1344">the #GstVideoAFDMeta on @buffer. a #GstBuffer + line="1336">a #GstBuffer 0 for progressive or field 1 and 1 for field 2 + line="1337">0 for progressive or field 1 and 1 for field 2 #GstVideoAFDSpec that applies to AFD value + line="1338">#GstVideoAFDSpec that applies to AFD value #GstVideoAFDValue AFD enumeration + line="1339">#GstVideoAFDValue AFD enumeration @@ -24609,13 +25690,13 @@ the given parameters. version="1.18"> Attaches #GstVideoBarMeta metadata to @buffer with the given + line="1444">Attaches #GstVideoBarMeta metadata to @buffer with the given parameters. - + the #GstVideoBarMeta on @buffer. + line="1461">the #GstVideoBarMeta on @buffer. See Table 6.11 Bar Data Syntax @@ -24626,25 +25707,25 @@ https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf a #GstBuffer + line="1446">a #GstBuffer 0 for progressive or field 1 and 1 for field 2 + line="1447">0 for progressive or field 1 and 1 for field 2 if true then bar data specifies letterbox, otherwise pillarbox + line="1448">if true then bar data specifies letterbox, otherwise pillarbox If @is_letterbox is true, then the value specifies the + line="1449">If @is_letterbox is true, then the value specifies the last line of a horizontal letterbox bar area at top of reconstructed frame. Otherwise, it specifies the last horizontal luminance sample of a vertical pillarbox bar area at the left side of the reconstructed frame @@ -24653,7 +25734,7 @@ https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf If @is_letterbox is true, then the value specifies the + line="1453">If @is_letterbox is true, then the value specifies the first line of a horizontal letterbox bar area at bottom of reconstructed frame. Otherwise, it specifies the first horizontal luminance sample of a vertical pillarbox bar area at the right side of the reconstructed frame. @@ -24666,32 +25747,32 @@ https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf version="1.16"> Attaches #GstVideoCaptionMeta metadata to @buffer with the given + line="998">Attaches #GstVideoCaptionMeta metadata to @buffer with the given parameters. - + the #GstVideoCaptionMeta on @buffer. + line="1008">the #GstVideoCaptionMeta on @buffer. a #GstBuffer + line="1000">a #GstBuffer The type of Closed Caption to add + line="1001">The type of Closed Caption to add The Closed Caption data + line="1002">The Closed Caption data @@ -24699,7 +25780,7 @@ parameters. The size of @data in bytes + line="1003">The size of @data in bytes @@ -24738,7 +25819,7 @@ the given alpha buffer. c:identifier="gst_buffer_add_video_crop_meta" introspectable="0"> + line="167"/> @@ -24748,14 +25829,14 @@ the given alpha buffer. c:identifier="gst_buffer_add_video_gl_texture_upload_meta"> Attaches GstVideoGLTextureUploadMeta metadata to @buffer with the given + line="881">Attaches GstVideoGLTextureUploadMeta metadata to @buffer with the given parameters. + line="293"/> the #GstVideoGLTextureUploadMeta on @buffer. + line="895">the #GstVideoGLTextureUploadMeta on @buffer. @@ -24763,26 +25844,26 @@ parameters. a #GstBuffer + line="883">a #GstBuffer the #GstVideoGLTextureOrientation + line="884">the #GstVideoGLTextureOrientation the number of textures + line="885">the number of textures array of #GstVideoGLTextureType + line="886">array of #GstVideoGLTextureType closure="5"> the function to upload the buffer to a specific texture ID + line="887">the function to upload the buffer to a specific texture ID allow-none="1"> user data for the implementor of @upload + line="888">user data for the implementor of @upload scope="call"> function to copy @user_data + line="889">function to copy @user_data scope="call"> function to free @user_data + line="890">function to free @user_data @@ -24825,48 +25906,48 @@ parameters. c:identifier="gst_buffer_add_video_meta"> Attaches GstVideoMeta metadata to @buffer with the given parameters and the + line="377">Attaches GstVideoMeta metadata to @buffer with the given parameters and the default offsets and strides for @format and @width x @height. This function calculates the default offsets and strides and then calls gst_buffer_add_video_meta_full() with them. + line="116"/> the #GstVideoMeta on @buffer. + line="391">the #GstVideoMeta on @buffer. a #GstBuffer + line="379">a #GstBuffer #GstVideoFrameFlags + line="380">#GstVideoFrameFlags a #GstVideoFormat + line="381">a #GstVideoFormat the width + line="382">the width the height + line="383">the height @@ -24875,65 +25956,65 @@ gst_buffer_add_video_meta_full() with them. c:identifier="gst_buffer_add_video_meta_full"> Attaches GstVideoMeta metadata to @buffer with the given parameters. + line="410">Attaches GstVideoMeta metadata to @buffer with the given parameters. + line="120"/> the #GstVideoMeta on @buffer. + line="423">the #GstVideoMeta on @buffer. a #GstBuffer + line="412">a #GstBuffer #GstVideoFrameFlags + line="413">#GstVideoFrameFlags a #GstVideoFormat + line="414">a #GstVideoFormat the width + line="415">the width the height + line="416">the height number of planes + line="417">number of planes offset of each plane - + line="418">offset of each plane + stride of each plane - + line="419">stride of each plane + @@ -24978,14 +26059,14 @@ of @comp. c:identifier="gst_buffer_add_video_region_of_interest_meta"> Attaches #GstVideoRegionOfInterestMeta metadata to @buffer with the given + line="1091">Attaches #GstVideoRegionOfInterestMeta metadata to @buffer with the given parameters. + line="351"/> the #GstVideoRegionOfInterestMeta on @buffer. + line="1103">the #GstVideoRegionOfInterestMeta on @buffer. @@ -24993,37 +26074,37 @@ parameters. a #GstBuffer + line="1093">a #GstBuffer Type of the region of interest (e.g. "face") + line="1094">Type of the region of interest (e.g. "face") X position + line="1095">X position Y position + line="1096">Y position width + line="1097">width height + line="1098">height @@ -25032,14 +26113,14 @@ parameters. c:identifier="gst_buffer_add_video_region_of_interest_meta_id"> Attaches #GstVideoRegionOfInterestMeta metadata to @buffer with the given + line="1113">Attaches #GstVideoRegionOfInterestMeta metadata to @buffer with the given parameters. + line="359"/> the #GstVideoRegionOfInterestMeta on @buffer. + line="1125">the #GstVideoRegionOfInterestMeta on @buffer. @@ -25047,37 +26128,37 @@ parameters. a #GstBuffer + line="1115">a #GstBuffer Type of the region of interest (e.g. "face") + line="1116">Type of the region of interest (e.g. "face") X position + line="1117">X position Y position + line="1118">Y position width + line="1119">width height + line="1120">height @@ -25129,14 +26210,14 @@ parameters. version="1.10"> Attaches #GstVideoTimeCodeMeta metadata to @buffer with the given + line="1283">Attaches #GstVideoTimeCodeMeta metadata to @buffer with the given parameters. + line="403"/> the #GstVideoTimeCodeMeta on @buffer, or + line="1291">the #GstVideoTimeCodeMeta on @buffer, or (since 1.16) %NULL if the timecode was invalid. @@ -25144,13 +26225,13 @@ parameters. a #GstBuffer + line="1285">a #GstBuffer a #GstVideoTimeCode + line="1286">a #GstVideoTimeCode @@ -25160,14 +26241,14 @@ parameters. version="1.10"> Attaches #GstVideoTimeCodeMeta metadata to @buffer with the given + line="1308">Attaches #GstVideoTimeCodeMeta metadata to @buffer with the given parameters. + line="408"/> the #GstVideoTimeCodeMeta on @buffer, or + line="1324">the #GstVideoTimeCodeMeta on @buffer, or (since 1.16) %NULL if the timecode was invalid. @@ -25175,80 +26256,99 @@ parameters. a #GstBuffer + line="1310">a #GstBuffer framerate numerator + line="1311">framerate numerator framerate denominator + line="1312">framerate denominator a #GDateTime for the latest daily jam + line="1313">a #GDateTime for the latest daily jam a #GstVideoTimeCodeFlags + line="1314">a #GstVideoTimeCodeFlags hours since the daily jam + line="1315">hours since the daily jam minutes since the daily jam + line="1316">minutes since the daily jam seconds since the daily jam + line="1317">seconds since the daily jam frames since the daily jam + line="1318">frames since the daily jam fields since the daily jam + line="1319">fields since the daily jam + + Gets the #GstAncillaryMeta that might be present on @b. + +Note: It is quite likely that there might be more than one ancillary meta on +a given buffer. This function will only return the first one. See gst_buffer_iterate_ancillary_meta() for a way to iterate over all ancillary metas of the buffer. + + + + A #GstBuffer + + + Gets the #GstVideoAFDMeta that might be present on @b. + line="393">Gets the #GstVideoAFDMeta that might be present on @b. Note: there may be two #GstVideoAFDMeta structs for interlaced video. - + A #GstBuffer + line="395">A #GstBuffer @@ -25268,13 +26368,13 @@ Note: there may be two #GstVideoAFDMeta structs for interlaced video. introspectable="0"> Gets the #GstVideoBarMeta that might be present on @b. - + line="456">Gets the #GstVideoBarMeta that might be present on @b. + A #GstBuffer + line="458">A #GstBuffer @@ -25284,13 +26384,13 @@ Note: there may be two #GstVideoAFDMeta structs for interlaced video. introspectable="0"> Gets the #GstVideoCaptionMeta that might be present on @b. - + line="547">Gets the #GstVideoCaptionMeta that might be present on @b. + A #GstBuffer + line="549">A #GstBuffer @@ -25315,7 +26415,7 @@ Note: there may be two #GstVideoAFDMeta structs for interlaced video. c:identifier="gst_buffer_get_video_crop_meta" introspectable="0"> + line="166"/> @@ -25325,7 +26425,7 @@ Note: there may be two #GstVideoAFDMeta structs for interlaced video. c:identifier="gst_buffer_get_video_gl_texture_upload_meta" introspectable="0"> + line="289"/> @@ -25335,16 +26435,16 @@ Note: there may be two #GstVideoAFDMeta structs for interlaced video. c:identifier="gst_buffer_get_video_meta"> Find the #GstVideoMeta on @buffer with the lowest @id. + line="269">Find the #GstVideoMeta on @buffer with the lowest @id. Buffers can contain multiple #GstVideoMeta metadata items when dealing with multiview buffers. + line="110"/> the #GstVideoMeta with lowest id (usually 0) or %NULL when there + line="278">the #GstVideoMeta with lowest id (usually 0) or %NULL when there is no such metadata on @buffer. @@ -25352,7 +26452,7 @@ is no such metadata on @buffer. a #GstBuffer + line="271">a #GstBuffer @@ -25361,16 +26461,16 @@ is no such metadata on @buffer. c:identifier="gst_buffer_get_video_meta_id"> Find the #GstVideoMeta on @buffer with the given @id. + line="301">Find the #GstVideoMeta on @buffer with the given @id. Buffers can contain multiple #GstVideoMeta metadata items when dealing with multiview buffers. + line="113"/> the #GstVideoMeta with @id or %NULL when there is no such metadata + line="311">the #GstVideoMeta with @id or %NULL when there is no such metadata on @buffer. @@ -25378,13 +26478,13 @@ on @buffer. a #GstBuffer + line="303">a #GstBuffer a metadata id + line="304">a metadata id @@ -25413,7 +26513,7 @@ on @buffer. c:identifier="gst_buffer_get_video_region_of_interest_meta" introspectable="0"> + line="344"/> @@ -25423,16 +26523,16 @@ on @buffer. c:identifier="gst_buffer_get_video_region_of_interest_meta_id"> Find the #GstVideoRegionOfInterestMeta on @buffer with the given @id. + line="1060">Find the #GstVideoRegionOfInterestMeta on @buffer with the given @id. Buffers can contain multiple #GstVideoRegionOfInterestMeta metadata items if multiple regions of interests are marked on a frame. + line="347"/> the #GstVideoRegionOfInterestMeta with @id or %NULL when there is + line="1070">the #GstVideoRegionOfInterestMeta with @id or %NULL when there is no such metadata on @buffer. @@ -25441,13 +26541,13 @@ no such metadata on @buffer. a #GstBuffer + line="1062">a #GstBuffer a metadata id + line="1063">a metadata id @@ -25472,9 +26572,34 @@ no such metadata on @buffer. c:identifier="gst_buffer_get_video_time_code_meta" introspectable="0"> + line="399"/> + + + + + + + Retrieves the next #GstAncillaryMeta after the current one according to +@s. If @s points to %NULL, the first #GstAncillaryMeta will be returned (if +any). + +@s will be updated with an opaque state pointer. + + A #GstBuffer + + + An opaque state pointer @@ -27087,7 +28212,7 @@ of commands passed must be equal to @n_commands. - + @@ -27095,7 +28220,7 @@ of commands passed must be equal to @n_commands. - + @@ -27119,7 +28244,7 @@ of commands passed must be equal to @n_commands. - + @@ -27127,7 +28252,7 @@ of commands passed must be equal to @n_commands. - + @@ -27308,7 +28433,7 @@ The return value is FALSE in the case of integer overflow or other error. - + @@ -27316,7 +28441,7 @@ The return value is FALSE in the case of integer overflow or other error. - + @@ -27327,20 +28452,20 @@ The return value is FALSE in the case of integer overflow or other error. version="1.16"> Parses fixed Closed Caption #GstCaps and returns the corresponding caption + line="1045">Parses fixed Closed Caption #GstCaps and returns the corresponding caption type, or %GST_VIDEO_CAPTION_TYPE_UNKNOWN. - + #GstVideoCaptionType. + line="1052">#GstVideoCaptionType. Fixed #GstCaps to parse + line="1047">Fixed #GstCaps to parse @@ -27351,19 +28476,19 @@ type, or %GST_VIDEO_CAPTION_TYPE_UNKNOWN. version="1.16"> Creates new caps corresponding to @type. - + line="1085">Creates new caps corresponding to @type. + new #GstCaps + line="1091">new #GstCaps #GstVideoCaptionType + line="1087">#GstVideoCaptionType @@ -28068,7 +29193,7 @@ anymore. introspectable="0"> Create a new converter object to convert between @in_info and @out_info + line="2542">Create a new converter object to convert between @in_info and @out_info with @config. Returns (nullable): a #GstVideoConverter or %NULL if conversion is not possible. @@ -28081,19 +29206,19 @@ Returns (nullable): a #GstVideoConverter or %NULL if conversion is not possible. a #GstVideoInfo + line="2544">a #GstVideoInfo a #GstVideoInfo + line="2545">a #GstVideoInfo a #GstStructure with configuration options + line="2546">a #GstStructure with configuration options @@ -28105,7 +29230,7 @@ Returns (nullable): a #GstVideoConverter or %NULL if conversion is not possible. introspectable="0"> Create a new converter object to convert between @in_info and @out_info + line="2295">Create a new converter object to convert between @in_info and @out_info with @config. The optional @pool can be used to spawn threads, this is useful when @@ -28121,19 +29246,19 @@ Returns (nullable): a #GstVideoConverter or %NULL if conversion is not possible. a #GstVideoInfo + line="2297">a #GstVideoInfo a #GstVideoInfo + line="2298">a #GstVideoInfo a #GstStructure with configuration options + line="2299">a #GstStructure with configuration options a #GstTaskPool to spawn threads from + line="2300">a #GstTaskPool to spawn threads from @@ -28150,7 +29275,7 @@ Returns (nullable): a #GstVideoConverter or %NULL if conversion is not possible. + line="161"/> @@ -28159,7 +29284,7 @@ Returns (nullable): a #GstVideoConverter or %NULL if conversion is not possible. c:identifier="gst_video_crop_meta_get_info" moved-to="VideoCropMeta.get_info"> + line="164"/> @@ -28222,21 +29347,21 @@ performance is achieved when @quantizer is a power of 2. version="1.24"> Converting the video format into dma drm fourcc. If no + line="674">Converting the video format into dma drm fourcc. If no matching fourcc found, then DRM_FORMAT_INVALID is returned. + line="114"/> the DRM_FORMAT_* corresponding to the @format. + line="681">the DRM_FORMAT_* corresponding to the @format. a #GstVideoFormat + line="676">a #GstVideoFormat @@ -28246,15 +29371,15 @@ matching fourcc found, then DRM_FORMAT_INVALID is returned. version="1.24"> Convert the @format_str string into the drm fourcc value. The @modifier is + line="533">Convert the @format_str string into the drm fourcc value. The @modifier is also parsed if we want. Please note that the @format_str should follow the fourcc:modifier kind style, such as NV12:0x0100000000000002 + line="106"/> The drm fourcc value or DRM_FORMAT_INVALID if @format_str is + line="543">The drm fourcc value or DRM_FORMAT_INVALID if @format_str is invalid. @@ -28262,7 +29387,7 @@ invalid. a drm format string + line="535">a drm format string allow-none="1"> Return the modifier in @format or %NULL + line="536">Return the modifier in @format or %NULL to ignore. @@ -28284,21 +29409,21 @@ to ignore. version="1.24"> Converting a dma drm fourcc into the video format. If no matching + line="700">Converting a dma drm fourcc into the video format. If no matching video format found, then GST_VIDEO_FORMAT_UNKNOWN is returned. + line="117"/> the GST_VIDEO_FORMAT_* corresponding to the @fourcc. + line="707">the GST_VIDEO_FORMAT_* corresponding to the @fourcc. the dma drm value. + line="702">the dma drm value. @@ -28308,14 +29433,14 @@ video format found, then GST_VIDEO_FORMAT_UNKNOWN is returned. version="1.24"> Returns a string containing drm kind format, such as + line="597">Returns a string containing drm kind format, such as NV12:0x0100000000000002, or NULL otherwise. + line="110"/> the drm kind string composed + line="605">the drm kind string composed of to @fourcc and @modifier. @@ -28323,13 +29448,13 @@ NV12:0x0100000000000002, or NULL otherwise. a drm fourcc value. + line="599">a drm fourcc value. the associated modifier value. + line="600">the associated modifier value. @@ -28690,22 +29815,22 @@ Create an upstream force key unit event using gst_video_event_new_upstream_forc moved-to="VideoFormat.from_fourcc"> Converts a FOURCC value into the corresponding #GstVideoFormat. + line="7967">Converts a FOURCC value into the corresponding #GstVideoFormat. If the FOURCC cannot be represented by #GstVideoFormat, #GST_VIDEO_FORMAT_UNKNOWN is returned. + line="1039"/> the #GstVideoFormat describing the FOURCC value + line="7975">the #GstVideoFormat describing the FOURCC value a FOURCC value representing raw YUV video + line="7969">a FOURCC value representing raw YUV video @@ -28715,13 +29840,13 @@ If the FOURCC cannot be represented by #GstVideoFormat, moved-to="VideoFormat.from_masks"> Find the #GstVideoFormat for the given parameters. + line="7890">Find the #GstVideoFormat for the given parameters. + line="1034"/> a #GstVideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to + line="7903">a #GstVideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to not specify a known format. @@ -28729,44 +29854,44 @@ not specify a known format. the amount of bits used for a pixel + line="7892">the amount of bits used for a pixel the amount of bits used to store a pixel. This value is bigger than + line="7893">the amount of bits used to store a pixel. This value is bigger than @depth the endianness of the masks, #G_LITTLE_ENDIAN or #G_BIG_ENDIAN + line="7895">the endianness of the masks, #G_LITTLE_ENDIAN or #G_BIG_ENDIAN the red mask + line="7896">the red mask the green mask + line="7897">the green mask the blue mask + line="7898">the blue mask the alpha mask, or 0 if no alpha mask + line="7899">the alpha mask, or 0 if no alpha mask @@ -28776,13 +29901,13 @@ not specify a known format. moved-to="VideoFormat.from_string"> Convert the @format string to its #GstVideoFormat. + line="8059">Convert the @format string to its #GstVideoFormat. + line="1042"/> the #GstVideoFormat for @format or GST_VIDEO_FORMAT_UNKNOWN when the + line="8065">the #GstVideoFormat for @format or GST_VIDEO_FORMAT_UNKNOWN when the string is not a known format. @@ -28790,7 +29915,7 @@ string is not a known format. a format string + line="8061">a format string @@ -28800,20 +29925,20 @@ string is not a known format. moved-to="VideoFormat.get_info"> Get the #GstVideoFormatInfo for @format + line="8125">Get the #GstVideoFormatInfo for @format + line="1052"/> The #GstVideoFormatInfo for @format. + line="8131">The #GstVideoFormatInfo for @format. a #GstVideoFormat + line="8127">a #GstVideoFormat @@ -28824,14 +29949,14 @@ string is not a known format. version="1.2"> Get the default palette of @format. This the palette used in the pack + line="8141">Get the default palette of @format. This the palette used in the pack function for paletted formats. + line="1055"/> the default palette of @format or %NULL when + line="8149">the default palette of @format or %NULL when @format does not have a palette. @@ -28839,7 +29964,7 @@ function for paletted formats. a #GstVideoFormat + line="8143">a #GstVideoFormat transfer-ownership="full"> size of the palette in bytes + line="8144">size of the palette in bytes @@ -28858,22 +29983,22 @@ function for paletted formats. moved-to="VideoFormat.to_fourcc"> Converts a #GstVideoFormat value into the corresponding FOURCC. Only + line="8084">Converts a #GstVideoFormat value into the corresponding FOURCC. Only a few YUV formats have corresponding FOURCC values. If @format has no corresponding FOURCC value, 0 is returned. + line="1045"/> the FOURCC corresponding to @format + line="8092">the FOURCC corresponding to @format a #GstVideoFormat video format + line="8086">a #GstVideoFormat video format @@ -28883,22 +30008,53 @@ no corresponding FOURCC value, 0 is returned. moved-to="VideoFormat.to_string"> Returns a string containing a descriptive name for + line="8105">Returns a string containing a descriptive name for the #GstVideoFormat if there is one, or NULL otherwise. + line="1048"/> the name corresponding to @format + line="8112">the name corresponding to @format a #GstVideoFormat video format + line="8107">a #GstVideoFormat video format + + + + + + Return all the raw video formats supported by GStreamer including +special opaque formats such as %GST_VIDEO_FORMAT_DMA_DRM for which +no software conversion exists. This should be use for passthrough +template cpas. + + + an array of #GstVideoFormat + + + + + + the number of elements in the returned array + @@ -28907,13 +30063,13 @@ the #GstVideoFormat if there is one, or NULL otherwise. version="1.18"> Return all the raw video formats supported by GStreamer. + line="8289">Return all the raw video formats supported by GStreamer. + line="1173"/> an array of #GstVideoFormat + line="8295">an array of #GstVideoFormat @@ -28925,7 +30081,7 @@ the #GstVideoFormat if there is one, or NULL otherwise. transfer-ownership="full"> the number of elements in the returned array + line="8291">the number of elements in the returned array @@ -29074,7 +30230,7 @@ All video planes of @buffer will be mapped and the pointers will be set in + line="284"/> @@ -29083,7 +30239,7 @@ All video planes of @buffer will be mapped and the pointers will be set in c:identifier="gst_video_gl_texture_upload_meta_get_info" moved-to="VideoGLTextureUploadMeta.get_info"> + line="287"/> @@ -29146,15 +30302,15 @@ recognised, and %FALSE otherwise. version="1.24"> Parse @caps and update @info. Please note that the @caps should be + line="323">Parse @caps and update @info. Please note that the @caps should be a dma drm caps. The gst_video_is_dma_drm_caps() can be used to verify it before calling this function. + line="86"/> TRUE if @caps could be parsed + line="332">TRUE if @caps could be parsed @@ -29164,13 +30320,13 @@ it before calling this function. transfer-ownership="none"> #GstVideoInfoDmaDrm + line="325">#GstVideoInfoDmaDrm a #GstCaps + line="326">a #GstCaps @@ -29181,14 +30337,14 @@ it before calling this function. version="1.24"> Fills @drm_info if @info's format has a valid drm format and @modifier is also + line="438">Fills @drm_info if @info's format has a valid drm format and @modifier is also valid + line="90"/> %TRUE if @drm_info is filled correctly. + line="447">%TRUE if @drm_info is filled correctly. @@ -29198,19 +30354,19 @@ valid transfer-ownership="none"> #GstVideoInfoDmaDrm + line="440">#GstVideoInfoDmaDrm a #GstVideoInfo + line="441">a #GstVideoInfo the associated modifier value. + line="442">the associated modifier value. @@ -29221,9 +30377,9 @@ valid version="1.24"> Initialize @drm_info with default values. + line="202">Initialize @drm_info with default values. + line="77"/> @@ -29234,7 +30390,7 @@ valid transfer-ownership="none"> a #GstVideoInfoDmaDrm + line="204">a #GstVideoInfoDmaDrm @@ -29388,21 +30544,21 @@ recognised, and %FALSE otherwise. version="1.24"> Check whether the @caps is a dma drm kind caps. Please note that + line="243">Check whether the @caps is a dma drm kind caps. Please note that the caps should be fixed. + line="103"/> %TRUE if the caps is a dma drm caps. + line="250">%TRUE if the caps is a dma drm caps. a #GstCaps + line="245">a #GstCaps @@ -29412,15 +30568,15 @@ the caps should be fixed. version="1.18"> Return a generic raw video caps for formats defined in @formats. + line="8340">Return a generic raw video caps for formats defined in @formats. If @formats is %NULL returns a caps for all the supported raw video formats, see gst_video_formats_raw(). + line="1211"/> a video @GstCaps + line="8349">a video @GstCaps @@ -29430,7 +30586,7 @@ see gst_video_formats_raw(). allow-none="1"> an array of raw #GstVideoFormat, or %NULL + line="8342">an array of raw #GstVideoFormat, or %NULL @@ -29438,7 +30594,7 @@ see gst_video_formats_raw(). the size of @formats + line="8343">the size of @formats @@ -29448,16 +30604,16 @@ see gst_video_formats_raw(). version="1.18"> Return a generic raw video caps for formats defined in @formats with features + line="8358">Return a generic raw video caps for formats defined in @formats with features @features. If @formats is %NULL returns a caps for all the supported video formats, see gst_video_formats_raw(). + line="1214"/> a video @GstCaps + line="8369">a video @GstCaps @@ -29467,7 +30623,7 @@ see gst_video_formats_raw(). allow-none="1"> an array of raw #GstVideoFormat, or %NULL + line="8360">an array of raw #GstVideoFormat, or %NULL @@ -29475,7 +30631,7 @@ see gst_video_formats_raw(). the size of @formats + line="8361">the size of @formats allow-none="1"> the #GstCapsFeatures to set on the caps + line="8362">the #GstCapsFeatures to set on the caps @@ -29525,7 +30681,7 @@ see gst_video_formats_raw(). + line="104"/> @@ -29534,7 +30690,7 @@ see gst_video_formats_raw(). c:identifier="gst_video_meta_get_info" moved-to="VideoMeta.get_info"> + line="107"/> @@ -29544,13 +30700,13 @@ see gst_video_formats_raw(). moved-to="VideoMetaTransform.scale_get_quark"> Get the #GQuark for the "gst-video-scale" metadata transform operation. + line="762">Get the #GQuark for the "gst-video-scale" metadata transform operation. + line="172"/> a #GQuark + line="767">a #GQuark @@ -29898,7 +31054,7 @@ gst_video_overlay_set_render_rectangle(). + line="338"/> @@ -29907,7 +31063,7 @@ gst_video_overlay_set_render_rectangle(). c:identifier="gst_video_region_of_interest_meta_get_info" moved-to="VideoRegionOfInterestMeta.get_info"> + line="341"/> @@ -30090,7 +31246,7 @@ Use this method when @mode is of type %GST_VIDEO_TILE_TYPE_INDEXED. + line="392"/> @@ -30099,7 +31255,7 @@ Use this method when @mode is of type %GST_VIDEO_TILE_TYPE_INDEXED. c:identifier="gst_video_time_code_meta_get_info" moved-to="VideoTimeCodeMeta.get_info"> + line="396"/> diff --git a/girs/GstVulkan-1.0.gir b/girs/GstVulkan-1.0.gir index c001974e7..1ff0233ce 100644 --- a/girs/GstVulkan-1.0.gir +++ b/girs/GstVulkan-1.0.gir @@ -87,6 +87,26 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + @@ -291,6 +311,26 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + @@ -314,7 +354,7 @@ and/or use gtk-doc annotations. --> - + @@ -323,7 +363,7 @@ and/or use gtk-doc annotations. --> - + @@ -505,6 +545,36 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + + + @@ -898,7 +968,7 @@ and/or use gtk-doc annotations. --> value="4" c:type="GST_VULKAN_MAX_COMPONENTS" version="1.18"> - + + + + + + + + + + + + + + + + + + + + + + @@ -978,7 +1078,7 @@ and/or use gtk-doc annotations. --> - + @@ -987,7 +1087,7 @@ and/or use gtk-doc annotations. --> - + @@ -997,13 +1097,13 @@ and/or use gtk-doc annotations. --> value="gst.vulkan.queue" c:type="GST_VULKAN_QUEUE_CONTEXT_TYPE_STR" version="1.18"> - + - + @@ -1228,7 +1328,7 @@ and/or use gtk-doc annotations. --> c:type="GstVulkanBarrierMemoryInfo" version="1.18"> + line="96"/> the stages in the graphics pipeline to execute the barrier - + access flags - + + + + Timeline semaphore + + + + Current value of the timeline semaphore + @@ -1361,13 +1473,13 @@ and/or use gtk-doc annotations. --> version="1.18"> Allocate a new #GstVulkanBufferMemory. + line="316">Allocate a new #GstVulkanBufferMemory. a #GstMemory object backed by a vulkan buffer + line="325">a #GstMemory object backed by a vulkan buffer backed by vulkan device memory @@ -1375,25 +1487,62 @@ and/or use gtk-doc annotations. --> a #GstVulkanDevice + line="318">a #GstVulkanDevice size of the new buffer + line="319">size of the new buffer buffer usage flags + line="320">buffer usage flags memory properties flags for the backing memory + line="321">memory properties flags for the backing memory + + + + + + Allocate a new #GstVulkanBufferMemory. + + + a #GstMemory object backed by a vulkan buffer + backed by vulkan device memory + + + + + a #GstVulkanDevice + + + + the VkBufferCreateInfo structure + + + + memory properties flags for the backing memory @@ -1404,7 +1553,7 @@ and/or use gtk-doc annotations. --> version="1.18"> Initializes the Vulkan buffer memory allocator. It is safe to call this function + line="397">Initializes the Vulkan buffer memory allocator. It is safe to call this function multiple times. This must be called before any other #GstVulkanBufferMemory operation. @@ -1417,32 +1566,32 @@ multiple times. This must be called before any other #GstVulkanBufferMemory ope version="1.18"> Allocated a new wrapped #GstVulkanBufferMemory with @buffer. + line="342">Allocated a new wrapped #GstVulkanBufferMemory with @buffer. + line="162"/> a #GstMemory object backed by a vulkan device memory + line="352">a #GstMemory object backed by a vulkan device memory a #GstVulkanDevice + line="344">a #GstVulkanDevice a `VkBuffer` + line="345">a `VkBuffer` usage flags of @buffer + line="346">usage flags of @buffer user data to call @notify with + line="347">user data to call @notify with a #GDestroyNotify called when @buffer is no longer in use + line="348">a #GDestroyNotify called when @buffer is no longer in use @@ -1534,18 +1683,48 @@ multiple times. This must be called before any other #GstVulkanBufferMemory ope a #GstBufferPool that allocates buffers with #GstGLMemory + line="238">a #GstBufferPool that allocates buffers with #GstGLMemory the #GstVulkanDevice to use + line="236">the #GstVulkanDevice to use + + Sets the @usage of the buffers to setup. + + + + + + + the #GstStructure with the pool's configuration. + + + + The Vulkan buffer usage flags. + + + + + + + opaque="1"> - - - - - + + + + Appends slices's @data bitstream into @pic internal input buffer. + + a new #GstVulkanDescriptorCache - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="1210">whether the slice @data were added. + - + a #GstVulkanDescriptorPool - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="1202">a #GstVulkanDecoder + + + + a #GstVulkanDecoderPicture + - + number of @layouts - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="1204">slice's bitstream data + - + list of #GstVulkanHandle containing - descriptor set layouts - - - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="1205">the size of @data + + + + whether add start code + - - - - + + + Gets the Vulkan decoding capabilities of the current video session. + + a new #GstVulkanDescriptorSet - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="793">whether the capabilities were fetched correctly. + - + a #GstVulkanDescriptorCache - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="788">a #GstVulkanDecoder + + + a #GstVulkanVideoCapabilities + + - - the parent #GstVulkanHandlePool - - - + the #GstVulkanDescriptorPool to cache descriptor sets for - - - - - - - - - - - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="549">Instantiates an internal Vulkan image pool for driver decoders whose output +buffers cannot be used as DPB buffers. + + + whether the pool was created. + + + + + a #GstVulkanDecoder + + + + the #GstCaps of the DP + + + + + the parent #GstObjectClass - - - - - - - - - - - - - - - - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="622">Decodes @pic. + + a new #GstVulkanDescriptorPool - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="630">whether @pic was decoded correctly. It might fill @error. + - + a #GstVulkanDevice - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="624">a #GstVulkanDecoder + + + + a #GstVulkanDecoderPicture + - + + + + Initializes the decoder at driver level and set its DPB slots to the inactive +state. + + + whether flush was successful + + + + a `VkDescriptorPool` - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="500">a #GstVulkanDecoder + + + + + + + + whether gst_vulkan_decoder_start() was called correctly previously. + + + + + a #GstVulkanDecoder + + + + + + Gets the Vulkan format properties of the output frames. + + + whether the @format was fetched. + + + + + a #GstVulkanDecoder + + + + the Vulkan output format properties + - + + + + Creates a #GstVulkanImageView for @buf for decoding, with the internal Ycbcr +sampler, if available. + + + the #GstVulkanImageView. + + + + maximum descriptor sets allocatable wit @pool - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="1056">a #GstVulkanDecoder + + + + a #GstBuffer + + + + if @buf is for output or for DPB + - - - - + + + Initializes @pic with @out as output buffer. + + a new #GstVulkanDescriptorSet - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="1135">whether @pic was initialized. + - + a #GstVulkanDescriptorPool - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="1129">a #GstVulkanDecoder + - + number of @layouts - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="1130">a #GstVulkanDecoderPicture + - + list of #GstVulkanHandle containing - descriptor set layouts - - - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="1131">the #GstBuffer to use as output + - - + + the parent #GstVulkanDevice for this descriptor pool - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="848">the #GstCaps of the profile defined at + gst_vulkan_decoder_start(). + - + a #GstVulkanDescriptorPool - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="846">a #GstVulkanDecoder + - - + + It creates a Vulkan video session for the given @profile. If an error occurs, +@error is filled. + the maximum number of sets allocatable from @pool - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="129">whether the video decoder has started correctly. + - + a #GstVulkanDescriptorPool - + filename="gst-libs/gst/vulkan/gstvkdecoder.c" + line="122">a #GstVulkanDecoder + + + + a #GstVulkanVideoProfile + + + + + + Destroys the video session created at gst_vulkan_decoder_start() and clean up +the internal objects. + + + whether the decoder stopped correctly. + + + + + a #GstVulkanDecoder + + + + + + Update the internal codec parameters for the current video session. + + + whether the @params were updated internally. It might fill @error. + + + + + a #GstVulkanDecoder + + + + a GstVulkanDecoderParameters union + + + + + + Update the internal Ycbcr sampler for the output images. + + + whether the sampler was updated. + + + + + a #GstVulkanDecoder + + + + whether color components are encoded using the full range of + numerical values or whether values are reserved for headroom and foot + room. + + + + x location of downsampled chroma component samples relative to the luma + samples. + + + + y location of downsampled chroma component samples relative to the luma + samples. + + + + + + Waits indefinitely for decoding fences to signal, and queries the operation +result if available. + + + whether the wait succeeded in waiting for all the fences to be + freed. + + + + + a #GstVulkanDecoder + the parent #GstObject + filename="gst-libs/gst/vulkan/gstvkdecoder.h" + line="78">the parent #GstObject - + the #GstVulkanDevice for descriptor sets - + filename="gst-libs/gst/vulkan/gstvkdecoder.h" + line="79">the #GstVulkanQueue to command buffers will be allocated from + - + the vulksn descriptor pool handle - + filename="gst-libs/gst/vulkan/gstvkdecoder.h" + line="80">the configured video codec operation + + + + the configured #GstVulkanVideoProfile + + + + the buffer to upload the bitstream to decode + + + + + + + if decoder needs a dedicated DPB + + + + if decoder's dedicated DPB has to be a layered image + @@ -2103,16 +2532,13 @@ need to use this function. - - - - the parent #GstObjectClass + + + @@ -2121,1051 +2547,1077 @@ need to use this function. - - - - - - + + Codec specific parameters. + + + + + + + + + + It contains the whole state for decoding a single picture. + + the parent #GstMiniObject - + filename="gst-libs/gst/vulkan/gstvkdecoder.h" + line="39">output buffer + - + the vulkan descriptor set handle - + filename="gst-libs/gst/vulkan/gstvkdecoder.h" + line="40">DPB representation of @out if needed by driver + - + the parent #GstVulkanDescriptorPool for pooling - + filename="gst-libs/gst/vulkan/gstvkdecoder.h" + line="41">image view for reference + - + the parent #GstVulkanDescriptorCache for reuse - + filename="gst-libs/gst/vulkan/gstvkdecoder.h" + line="42">image view for output + - + number of layouts applied to this descriptor set - + filename="gst-libs/gst/vulkan/gstvkdecoder.h" + line="43">array of offsets of each uploaded slice + + + - + layouts applied to this descriptor set - + filename="gst-libs/gst/vulkan/gstvkdecoder.h" + line="44">references required to decode current pictures + + + - - - + + + - + + + + + + + + + + + + + + + Releases the internal resource of @pic. + + + + + + + a #GstVulkanDecoderPicture + + + + + + + + + + + - + a new #GstVulkanDescriptorSet - + filename="gst-libs/gst/vulkan/gstvkdescriptorcache.c" + line="74">a new #GstVulkanDescriptorCache + + a #GstVulkanDescriptorPool - - a VkDescriptorSet - - number of @layouts + filename="gst-libs/gst/vulkan/gstvkdescriptorcache.c" + line="70">number of @layouts list of #GstVulkanHandle containing + filename="gst-libs/gst/vulkan/gstvkdescriptorcache.c" + line="71">list of #GstVulkanHandle containing descriptor set layouts - + - - Increases the refcount of the given buffer by one. - + throws="1"> + @set + filename="gst-libs/gst/vulkan/gstvkdescriptorcache.c" + line="158">a new #GstVulkanDescriptorSet - + a #GstVulkanDescriptorSet. - + filename="gst-libs/gst/vulkan/gstvkdescriptorcache.c" + line="155">a #GstVulkanDescriptorCache + - + Decreases the refcount of the buffer. If the refcount reaches 0, the buffer -will be freed. - - - - - - - a #GstVulkanDescriptorSet. - - - - + filename="gst-libs/gst/vulkan/gstvkdescriptorcache.h" + line="38">the parent #GstVulkanHandlePool + + + + the #GstVulkanDescriptorPool to cache descriptor sets for + + + + + + + + + + + + the parent #GstObjectClass + + + + + + + - + + + - - + + - + a new #GstVulkanDevice - + filename="gst-libs/gst/vulkan/gstvkdescriptorpool.c" + line="95">a new #GstVulkanDescriptorPool + - + the associated #GstVulkanPhysicalDevice - + filename="gst-libs/gst/vulkan/gstvkdescriptorpool.c" + line="91">a #GstVulkanDevice + + + + a `VkDescriptorPool` + + + + maximum descriptor sets allocatable wit @pool + - - + + a new #GstVulkanDevice - + filename="gst-libs/gst/vulkan/gstvkdescriptorpool.c" + line="204">a new #GstVulkanDescriptorSet + - + the associated #GstVulkanInstance - - - + filename="gst-libs/gst/vulkan/gstvkdescriptorpool.c" + line="198">a #GstVulkanDescriptorPool + + + the device index to create the new #GstVulkanDevice from + filename="gst-libs/gst/vulkan/gstvkdescriptorpool.c" + line="199">number of @layouts - - - - If a #GstVulkanDevice is requested in @query, sets @device as the reply. - -Intended for use with element query handlers to respond to #GST_QUERY_CONTEXT -for a #GstVulkanDevice. - - - whether @query was responded to with @device - - - - - a #GstElement - - - - a #GstQuery of type #GST_QUERY_CONTEXT - - - - the #GstVulkanDevice - - - - - - Attempt to retrieve a #GstVulkanDevice using #GST_QUERY_CONTEXT from the -surrounding elements of @element. - - - whether @device contains a valid #GstVulkanDevice - - - - - a #GstElement - - - + a #GstVulkanDevice - + filename="gst-libs/gst/vulkan/gstvkdescriptorpool.c" + line="200">list of #GstVulkanHandle containing + descriptor set layouts + + + - - - - - a new #GstVulkanFence or %NULL - - - - - a #GstVulkanDevice - - - - - Disable an Vulkan extension by @name. Disabling an extension will only have -an effect before the call to gst_vulkan_device_open(). - - + + whether the Vulkan extension could be disabled. - + filename="gst-libs/gst/vulkan/gstvkdescriptorpool.c" + line="126">the parent #GstVulkanDevice for this descriptor pool + - + a #GstVulkanDevice - + filename="gst-libs/gst/vulkan/gstvkdescriptorpool.c" + line="124">a #GstVulkanDescriptorPool + - - extension name to enable - - - - Enable an Vulkan extension by @name. Enabling an extension will -only have an effect before the call to gst_vulkan_device_open(). - + whether the Vulkan extension could be enabled. - + filename="gst-libs/gst/vulkan/gstvkdescriptorpool.c" + line="142">the maximum number of sets allocatable from @pool + - + a #GstVulkanDevice - + filename="gst-libs/gst/vulkan/gstvkdescriptorpool.c" + line="140">a #GstVulkanDescriptorPool + - - extension name to enable - - - + Enable an Vulkan layer by @name. Enabling a layer will -only have an effect before the call to gst_vulkan_device_open(). - - - whether the Vulkan layer could be enabled. - - - - - a #GstVulkanDevice - - - - layer name to enable - - - - - + filename="gst-libs/gst/vulkan/gstvkdescriptorpool.h" + line="37">the parent #GstObject + + + Iterate over each queue family available on #GstVulkanDevice - - - - - - - a #GstVulkanDevice - - - - a #GstVulkanDeviceForEachQueueFunc to run for each #GstVulkanQueue - - - - user data to pass to each call of @func - - - - - - - - the #GstVulkanInstance used to create this @device - - - - - a #GstVulkanDevice - - - - - the #GstVulkanDevice for descriptor sets + + + + the vulksn descriptor pool handle + + + + + + + + + + + + the parent #GstObjectClass + + + + + + + + + + + + + + + the parent #GstMiniObject + + + + the vulkan descriptor set handle + + + + the parent #GstVulkanDescriptorPool for pooling + + + + the parent #GstVulkanDescriptorCache for reuse + + + + number of layouts applied to this descriptor set + + + + layouts applied to this descriptor set + + + + + + + + + + + a new #GstVulkanDescriptorSet + + + + + + + + a VkDescriptorSet + + + + number of @layouts + + + + list of #GstVulkanHandle containing + descriptor set layouts + + + + + + + - - + Increases the refcount of the given buffer by one. + + The VkPhysicalDevice used to create @device - + filename="gst-libs/gst/vulkan/gstvkdescriptorset.h" + line="81">@set + - + a #GstVulkanDevice - + filename="gst-libs/gst/vulkan/gstvkdescriptorset.h" + line="77">a #GstVulkanDescriptorSet. + - + Performs `vkGetDeviceProcAddr()` with @device and @name + filename="gst-libs/gst/vulkan/gstvkdescriptorset.h" + line="92">Decreases the refcount of the buffer. If the refcount reaches 0, the buffer +will be freed. + + + + + + + a #GstVulkanDescriptorSet. + + + + + + + + - + line="90"/> + the function pointer for @name or %NULL - + line="90">a new #GstVulkanDevice + - - a #GstVulkanDevice - - - + name of the function to retrieve - + line="88">the associated #GstVulkanPhysicalDevice + - - + + + line="92"/> a new #GstVulkanQueue - + line="113">a new #GstVulkanDevice + - - a #GstVulkanDevice - - - + a queue family to retrieve - + line="110">the associated #GstVulkanInstance + - + index of the family to retrieve - + line="111">the device index to create the new #GstVulkanDevice from + - - + + + If a #GstVulkanDevice is requested in @query, sets @device as the reply. + +Intended for use with element query handlers to respond to #GST_QUERY_CONTEXT +for a #GstVulkanDevice. + line="139"/> whether extension @name is enabled + line="758">whether @query was responded to with @device - + a # GstVulkanDevice - - - + line="749">a #GstElement + + + extension name - + line="750">a #GstQuery of type #GST_QUERY_CONTEXT + - + + the #GstVulkanDevice + + + + + + Attempt to retrieve a #GstVulkanDevice using #GST_QUERY_CONTEXT from the +surrounding elements of @element. + + + whether @device contains a valid #GstVulkanDevice + + + + + a #GstElement + + + + a #GstVulkanDevice + + + + + + + + a new #GstVulkanFence or %NULL + + + + + a #GstVulkanDevice + + + - + Disable an Vulkan extension by @name. Disabling an extension will only have +an effect before the call to gst_vulkan_device_open(). + line="103"/> whether layer @name is enabled + line="973">whether the Vulkan extension could be disabled. a # GstVulkanDevice + line="967">a #GstVulkanDevice layer name + line="968">extension name to enable - + Attempts to create the internal `VkDevice` object. + line="917">Enable an Vulkan extension by @name. Enabling an extension will +only have an effect before the call to gst_vulkan_device_open(). + line="100"/> whether a vulkan device could be created + line="925">whether the Vulkan extension could be enabled. a #GstVulkanDevice + line="919">a #GstVulkanDevice + + extension name to enable + + - - - - - - - - the parent #GstObject - - - - the #GstVulkanInstance this device was allocated with - - - - the #GstVulkanPhysicalDevice this device was allocated with - - - - the vulkan device handle - - - - - - - - - - - - the parent #GstObjectClass - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The contents of a #GstVulkanDisplay are private and should only be accessed -through the provided API - - - - - a new #GstVulkanDisplay - - - - - - - - - - - + Enable an Vulkan layer by @name. Enabling a layer will +only have an effect before the call to gst_vulkan_device_open(). + + a new #GstVulkanDisplay or %NULL if - e.g. @type is unsupported - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="1055">whether the Vulkan layer could be enabled. + - + a #GstVulkanInstance - - - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="1049">a #GstVulkanDevice + + + the #GstVulkanDisplayType to create - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="1050">layer name to enable + - - + + This function will read the `GST_VULKAN_WINDOW` environment variable for -a user choice or choose the first supported implementation. - -gst_vulkan_instance_fill_info() must have been called prior to this function. - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="551">Iterate over each queue family available on #GstVulkanDevice + - the default #GstVulkanDisplayType #GstVulkanInstance will choose - on creation - + - - a #GstVulkanInstance - - - - - - If a #GstVulkanDisplay is requested in @query, sets @device as the reply. - -Intended for use with element query handlers to respond to #GST_QUERY_CONTEXT -for a #GstVulkanDisplay. - - - whether @query was responded to with @display - - - - + a #GstElement - - - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="553">a #GstVulkanDevice + + + a #GstQuery of type #GST_QUERY_CONTEXT - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="554">a #GstVulkanDeviceForEachQueueFunc to run for each #GstVulkanQueue + - + allow-none="1" + closure="0"> the #GstVulkanDisplay - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="555">user data to pass to each call of @func + - - - Attempt to retrieve a #GstVulkanDisplay using #GST_QUERY_CONTEXT from the -surrounding elements of @element. - - + + + + whether @display contains a valid #GstVulkanDisplay - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="664">the #GstVulkanInstance used to create this @device + - - a #GstElement - - - + a #GstVulkanDisplay - - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="662">a #GstVulkanDevice + + - - - create a window - - + + + + a new #GstVulkanWindow for @display or - %NULL. - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="680">The VkPhysicalDevice used to create @device + - + a #GstVulkanDisplay - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="678">a #GstVulkanDevice + - - + + get the native handle to the display - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="636">Performs `vkGetDeviceProcAddr()` with @device and @name + the winsys specific handle of @display + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="643">the function pointer for @name or %NULL - + a #GstVulkanDisplay - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="638">a #GstVulkanDevice + - - - - - - a new #GstVulkanWindow for @display or - %NULL. - - - - + a #GstVulkanDisplay - - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="639">name of the function to retrieve + + - - Execute @compare_func over the list of windows stored by @display. The -first argument to @compare_func is the #GstVulkanWindow being checked and the -second argument is @data. - - + + The first #GstVulkanWindow that - @compare_func matches, or %NULL - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="515">a new #GstVulkanQueue + - + a #GstVulkanDisplay - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="511">a #GstVulkanDevice + - + some data to pass to @compare_func - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="512">a queue family to retrieve + - + a comparison function to run - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="513">index of the family to retrieve + - - - + + the winsys specific handle of @display - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="878">whether extension @name is enabled + - + a #GstVulkanDisplay - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="875">a # GstVulkanDevice + + + extension name + + - - + + the #GstVulkanDisplayType of @display - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="1008">whether layer @name is enabled + - + a #GstVulkanDisplay - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="1005">a # GstVulkanDevice + + + layer name + + - - + + Attempts to create the internal `VkDevice` object. + whether the window was successfully removed + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="423">whether a vulkan device could be created - + a #GstVulkanDisplay - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="418">a #GstVulkanDevice + - + + + + + + An array with the family + indexes of the created queues in @device + + + + + + the #GstVulkanWindow to remove - + filename="gst-libs/gst/vulkan/gstvkdevice.c" + line="593">a #GstVulkanDevice + + + + + + Select a compatible queue from the @device supporting the @expected_flags. + + + a #GstVulkanQueue for @queue matching the + @expected_flags + + + + + a #GstVulkanDevice + + + + a VkQueueFlagBits + - + + + + + + + + the parent #GstObject - - - - + + the #GstVulkanInstance this device was allocated with - - - - - - - - - - + + the #GstVulkanPhysicalDevice this device was allocated with + - - + + the vulkan device handle + @@ -3173,1175 +3625,1590 @@ second argument is @data. - - - + + parent #GstObjectClass + filename="gst-libs/gst/vulkan/gstvkdevice.h" + line="75">the parent #GstObjectClass - - get the native handle to the display - - - - the winsys specific handle of @display - - - - - a #GstVulkanDisplay - - - - - - - create a window - - - - a new #GstVulkanWindow for @display or - %NULL. - - - - - a #GstVulkanDisplay - - - - - - + + + + + + + + + + + + + + + + + - + - - - no display - - - XCB display - - - wayland display - - - cocoa display for macOS - - - ios display - - - win32 display - - - - - any display type - - + + The contents of a #GstVulkanDisplay are private and should only be accessed +through the provided API + + - + line="131"/> + the Vulkan extension string required for creating a - VkSurfaceKHR using a window system handle or %NULL - + line="257">a new #GstVulkanDisplay + + + + + + + + + + + + a new #GstVulkanDisplay or %NULL if + e.g. @type is unsupported + + + a #GstVulkanInstance + + a #GstVulkanDisplayType + line="207">the #GstVulkanDisplayType to create - - - - - undetermined error - - + + This function will read the `GST_VULKAN_WINDOW` environment variable for +a user choice or choose the first supported implementation. + +gst_vulkan_instance_fill_info() must have been called prior to this function. + - + the default #GstVulkanDisplayType #GstVulkanInstance will choose + on creation + + + + a #GstVulkanInstance + + + - + if @result indicates an error condition, fills out #GError with details of -the error - - + filename="gst-libs/gst/vulkan/gstvkdisplay.c" + line="676">If a #GstVulkanDisplay is requested in @query, sets @device as the reply. + +Intended for use with element query handlers to respond to #GST_QUERY_CONTEXT +for a #GstVulkanDisplay. + + @result for easy chaining - + filename="gst-libs/gst/vulkan/gstvkdisplay.c" + line="687">whether @query was responded to with @display + - + a VkResult - + filename="gst-libs/gst/vulkan/gstvkdisplay.c" + line="678">a #GstElement + - + a #GstQuery of type #GST_QUERY_CONTEXT + + + a #GError to fill - + filename="gst-libs/gst/vulkan/gstvkdisplay.c" + line="680">the #GstVulkanDisplay + - + + + + Attempt to retrieve a #GstVulkanDisplay using #GST_QUERY_CONTEXT from the +surrounding elements of @element. + + + whether @display contains a valid #GstVulkanDisplay + + + + the printf-like format to write into the #GError - + filename="gst-libs/gst/vulkan/gstvkdisplay.c" + line="728">a #GstElement + - + arguments for @format - + filename="gst-libs/gst/vulkan/gstvkdisplay.c" + line="729">a #GstVulkanDisplay + - - - - - the parent #GstMiniObject - - - - the #GstVulkanDevice this fence is allocated from - - - + the parent #GstVulkanFenceCache for fence reuse - - - + filename="gst-libs/gst/vulkan/gstvkdisplay.h" + line="113">create a window + + + a new #GstVulkanWindow for @display or + %NULL. + + + + + a #GstVulkanDisplay + + + + + the vulkan fence handle - - - - + filename="gst-libs/gst/vulkan/gstvkdisplay.h" + line="112">get the native handle to the display + + + the winsys specific handle of @display - - - - - + + + + a #GstVulkanDisplay + + + + + + + a new #GstVulkanFence or %NULL on error - + filename="gst-libs/gst/vulkan/gstvkdisplay.c" + line="329">a new #GstVulkanWindow for @display or + %NULL. + - + the parent #GstVulkanDevice - - + filename="gst-libs/gst/vulkan/gstvkdisplay.c" + line="327">a #GstVulkanDisplay + + - - - - + + + Execute @compare_func over the list of windows stored by @display. The +first argument to @compare_func is the #GstVulkanWindow being checked and the +second argument is @data. + + a new #GstVulkanFence that is always in the signalled state - + filename="gst-libs/gst/vulkan/gstvkdisplay.c" + line="404">The first #GstVulkanWindow that + @compare_func matches, or %NULL + - - + + a #GstVulkanDisplay + + + + some data to pass to @compare_func + + + + a comparison function to run + - - + - - + + whether @fence has been signalled - + filename="gst-libs/gst/vulkan/gstvkdisplay.c" + line="286">the winsys specific handle of @display + - + a #GstVulkanFence - + filename="gst-libs/gst/vulkan/gstvkdisplay.c" + line="284">a #GstVulkanDisplay + - - + + - + the #GstVulkanDisplayType of @display + - - + + a #GstVulkanDisplay + - - - - - + + - + whether the window was successfully removed + - - + + a #GstVulkanDisplay + + + + the #GstVulkanWindow to remove + - - - the parent #GstVulkanHandlePool - + + + - - + + + + + + + + - + - - - - - the parent #GstVulkanHandlePoolClass - + + + + + + + + - - - - is a YUV format - - - is a RGB format - - - has an alpha channel - - - data is stored in little-endiate byte order - - - data is stored complex and cannot be read/write only using the information in the #GstVulkanFormatInfo - - - + - - - the Vulkan format being described - - - - name of this format - - - - how raw data is interpreted and scaled - - - - flags that apply to this format - - - - The number of bits used to pack data items. This can be less than - 8 when multiple pixels are stored in a byte. for values > 8 multiple - bytes should be read according to the endianness flag before - applying the shift and mask. -@n_components; number of components in this format - - - - - - - the number of bits to shift away to get the component data - - - - - - the depth in bits for each component - - - - - - - - - - - the number of planes for this format. The number of planes can - be less than the amount of components when multiple components - are packed into one plane. - - - + + the plane number where a component can be found - - - + filename="gst-libs/gst/vulkan/gstvkdisplay.h" + line="111">parent #GstObjectClass + - + the offset in the plane where the first pixel of the components - can be found. - - - + filename="gst-libs/gst/vulkan/gstvkdisplay.h" + line="112">get the native handle to the display + + + + the winsys specific handle of @display + + + + + a #GstVulkanDisplay + + + + - + subsampling factor of the width for the component. - Use GST_VIDEO_SUB_SCALE to scale a width. - - - + filename="gst-libs/gst/vulkan/gstvkdisplay.h" + line="113">create a window + + + + a new #GstVulkanWindow for @display or + %NULL. + + + + + a #GstVulkanDisplay + + + + - - subsampling factor of the height for the component. - Use GST_VIDEO_SUB_SCALE to scale a height. + - + - - + + + + + no display + + + c:identifier="GST_VULKAN_DISPLAY_TYPE_XCB" + glib:nick="xcb" + glib:name="GST_VULKAN_DISPLAY_TYPE_XCB"> [0, 2^n - 1] -> [0.0, 1.0] + filename="gst-libs/gst/vulkan/gstvkdisplay.h" + line="60">XCB display - + c:identifier="GST_VULKAN_DISPLAY_TYPE_WAYLAND" + glib:nick="wayland" + glib:name="GST_VULKAN_DISPLAY_TYPE_WAYLAND"> [-2^(n-1), 2^(n-1) - 1] -> [-1.0, 1.0] + filename="gst-libs/gst/vulkan/gstvkdisplay.h" + line="61">wayland display - + [0, 2^n - 1] -> [0.0, float(2^n - 1)] + filename="gst-libs/gst/vulkan/gstvkdisplay.h" + line="62">cocoa display for macOS - + [-2^(n-1), 2^(n-1) - 1] -> [float(-2^(n-1)), float(2^(n-1) - 1)] + filename="gst-libs/gst/vulkan/gstvkdisplay.h" + line="63">ios display - + [0, 2^n - 1] -> [0, 2^n - 1] + filename="gst-libs/gst/vulkan/gstvkdisplay.h" + line="64">win32 display - + + + [-2^(n-1), 2^(n-1) - 1] -> [-2^(n-1), 2^(n-1) - 1] + filename="gst-libs/gst/vulkan/gstvkdisplay.h" + line="65">any display type - + + + + the Vulkan extension string required for creating a + VkSurfaceKHR using a window system handle or %NULL + + + + + a #GstVulkanDisplayType + + + + + + + @GST_VULKAN_FORMAT_SCALING_UNORM but the first three components are gamma corrected for the sRGB colour space. + filename="gst-libs/gst/vulkan/gstvkerror.h" + line="50">undetermined error + + + + + + + if @result indicates an error condition, fills out #GError with details of +the error + + + @result for easy chaining + + + + + a VkResult + + + + a #GError to fill + + + + the printf-like format to write into the #GError + + + + arguments for @format + + + + - - + + + + the parent #GstMiniObject + + + + the #GstVulkanDevice this fence is allocated from + + + + the parent #GstVulkanFenceCache for fence reuse + + + + the vulkan fence handle + + + + + + + - + c:identifier="gst_vulkan_fence_new" + version="1.18" + throws="1"> + a new #GstVulkanFullScreenQuad - + filename="gst-libs/gst/vulkan/gstvkfence.c" + line="92">a new #GstVulkanFence or %NULL on error + - + a #GstVulkanQueue - + filename="gst-libs/gst/vulkan/gstvkfence.c" + line="89">the parent #GstVulkanDevice + - - Helper function for creation and submission of a command buffer that draws -a full screen quad. If you need to add other things to the command buffer, -create the command buffer manually and call -gst_vulkan_full_screen_quad_prepare_draw(), -gst_vulkan_full_screen_quad_fill_command_buffer() and -gst_vulkan_full_screen_quad_submit() instead. - + + + + a new #GstVulkanFence that is always in the signalled state + + + + + + + + + + whether the draw was successful + filename="gst-libs/gst/vulkan/gstvkfence.c" + line="161">whether @fence has been signalled - + the #GstVulkanFullScreenQuad - + filename="gst-libs/gst/vulkan/gstvkfence.c" + line="159">a #GstVulkanFence + - - Enables blending of the input image to the output image. - -See also: gst_vulkan_full_screen_quad_set_blend_operation() and -gst_vulkan_full_screen_quad_set_blend_factors(). - + + - - the #GstVulkanFullScreenQuad - - - - whether to enable blending - - - - - - - - - - - - the #GstVulkanFullScreenQuad - - - - whether to clear the framebuffer on load - - - - - - - - whether @cmd could be filled with the necessary commands - - - - - a #GstVulkanFullScreenQuad - - - - the #GstVulkanCommandBuffer to fill with commands - - - + - - - - - - - - - - - - - + + + + + - whether the necessary information could be generated for drawing a -frame. - + - - the #GstVulkanFullScreenQuad - - - - a #GstVulkanFence that will be signalled after submission - + + - - + + You need to enable blend with gst_vulkan_full_screen_quad_enable_blend(). - -See also: gst_vulkan_full_screen_quad_set_blend_operation(). - - - - - - - the #GstVulkanFullScreenQuad - - - - the `VkBlendFactor` for the source image for the colour - components (RGB) - - - - the `VkBlendFactor` for the destination image for the - colour components (RGB) - - - - the `VkBlendFactor` for the source image for the - alpha component. - - - - the `VkBlendFactor` for the destination image for - the alpha component. - - - - - + filename="gst-libs/gst/vulkan/gstvkfence.h" + line="109">the parent #GstVulkanHandlePool + + + + + + + + + + + You need to enable blend with gst_vulkan_full_screen_quad_enable_blend(). - -See also: gst_vulkan_full_screen_quad_set_blend_factors(). - - - - - - - the #GstVulkanFullScreenQuad - - - - the `VkBlendOp` to use for blending colour (RGB) values - - - - the `VkBlendOp` to use for blending alpha values - - - - - the parent #GstVulkanHandlePoolClass + + + + + + + + + + glib:type-name="GstVulkanFormatFlags" + glib:get-type="gst_vulkan_format_flags_get_type" + c:type="GstVulkanFormatFlags"> + See also gst_vulkan_full_screen_quad_set_vertex_buffer() - - - whether the index data could be set - - - - - the #GstVulkanFullScreenQuad - - - - the index data. Must be a #GstVulkanBufferMemory - - - - number of indices in @indices - - - - - - - - whether the information could be successfully set - + filename="gst-libs/gst/vulkan/gstvkformat.h" + line="63">is a YUV format + + + is a RGB format + + + has an alpha channel + + + data is stored in little-endiate byte order + + + data is stored complex and cannot be read/write only using the information in the #GstVulkanFormatInfo + + + + + + the Vulkan format being described + + + + name of this format + + + + how raw data is interpreted and scaled + + + + flags that apply to this format + + + + The number of bits used to pack data items. This can be less than + 8 when multiple pixels are stored in a byte. for values > 8 multiple + bytes should be read according to the endianness flag before + applying the shift and mask. +@n_components; number of components in this format + + + + + + + the number of bits to shift away to get the component data + + + + + + the depth in bits for each component + + + + + + + + + + + the number of planes for this format. The number of planes can + be less than the amount of components when multiple components + are packed into one plane. + + + + the plane number where a component can be found + + + + + + the offset in the plane where the first pixel of the components + can be found. + + + + + + subsampling factor of the width for the component. + Use GST_VIDEO_SUB_SCALE to scale a width. + + + + + + subsampling factor of the height for the component. + Use GST_VIDEO_SUB_SCALE to scale a height. + + + + + + image aspect of this format + + + + + + [0, 2^n - 1] -> [0.0, 1.0] + + + [-2^(n-1), 2^(n-1) - 1] -> [-1.0, 1.0] + + + [0, 2^n - 1] -> [0.0, float(2^n - 1)] + + + [-2^(n-1), 2^(n-1) - 1] -> [float(-2^(n-1)), float(2^(n-1) - 1)] + + + [0, 2^n - 1] -> [0, 2^n - 1] + + + [-2^(n-1), 2^(n-1) - 1] -> [-2^(n-1), 2^(n-1) - 1] + + + @GST_VULKAN_FORMAT_SCALING_UNORM but the first three components are gamma corrected for the sRGB colour space. + + + + + + + + a new #GstVulkanFullScreenQuad + - - the #GstVulkanFullScreenQuad - - - - the input #GstVideoInfo to set - - - + the output #GstVideoInfo to set - + line="824">a #GstVulkanQueue + - - + + Helper function for creation and submission of a command buffer that draws +a full screen quad. If you need to add other things to the command buffer, +create the command buffer manually and call +gst_vulkan_full_screen_quad_prepare_draw(), +gst_vulkan_full_screen_quad_fill_command_buffer() and +gst_vulkan_full_screen_quad_submit() instead. + line="146"/> whether the input buffer could be changed + line="1166">whether the draw was successful the #GstVulkanFullScreenQuad + line="1156">the #GstVulkanFullScreenQuad - - the input #GstBuffer to set - - - - + + Enables blending of the input image to the output image. + +See also: gst_vulkan_full_screen_quad_set_blend_operation() and +gst_vulkan_full_screen_quad_set_blend_factors(). + + + + + + + the #GstVulkanFullScreenQuad + + + + whether to enable blending + + + + + + + + + + + + the #GstVulkanFullScreenQuad + + + + whether to clear the framebuffer on load + + + + + + whether the input buffer could be changed + line="1457">whether @cmd could be filled with the necessary commands the #GstVulkanFullScreenQuad + line="1453">a #GstVulkanFullScreenQuad - + the output #GstBuffer to set - + line="1454">the #GstVulkanCommandBuffer to fill with commands + + + + - + + line="149"/> + + + + + + + + + + + whether the shaders could be set + line="1367">whether the necessary information could be generated for drawing a +frame. the #GstVulkanFullScreenQuad + line="1363">the #GstVulkanFullScreenQuad - + the vertex shader to set - + line="1364">a #GstVulkanFence that will be signalled after submission + - + + + + You need to enable blend with gst_vulkan_full_screen_quad_enable_blend(). + +See also: gst_vulkan_full_screen_quad_set_blend_operation(). + + + + + + the fragment shader to set - + line="1266">the #GstVulkanFullScreenQuad + + + + the `VkBlendFactor` for the source image for the colour + components (RGB) + + + + the `VkBlendFactor` for the destination image for the + colour components (RGB) + + + + the `VkBlendFactor` for the source image for the + alpha component. + + + + the `VkBlendFactor` for the destination image for + the alpha component. + - + You need to enable blend with gst_vulkan_full_screen_quad_enable_blend(). + +See also: gst_vulkan_full_screen_quad_set_blend_factors(). + + + + + + + the #GstVulkanFullScreenQuad + + + + the `VkBlendOp` to use for blending colour (RGB) values + + + + the `VkBlendOp` to use for blending alpha values + + + + + + See also gst_vulkan_full_screen_quad_set_vertex_buffer() + line="116"/> whether the shaders could be set + line="1038">whether the index data could be set the #GstVulkanFullScreenQuad + line="1031">the #GstVulkanFullScreenQuad - + the uniform data to set. Must be a #GstVulkanBufferMemory + line="1032">the index data. Must be a #GstVulkanBufferMemory + + number of indices in @indices + + - + + line="108"/> whether the index data could be set + line="895">whether the information could be successfully set the #GstVulkanFullScreenQuad + line="891">the #GstVulkanFullScreenQuad - + the vertex data. Must be a #GstVulkanBufferMemory - + line="892">the input #GstVideoInfo to set + + + + the output #GstVideoInfo to set + - + line="119"/> whether @cmd could be submitted to the queue + line="921">whether the input buffer could be changed a #GstVulkanFullScreenQuad + line="917">the #GstVulkanFullScreenQuad - + a #GstVulkanCommandBuffer to submit - + line="918">the input #GstBuffer to set + - + + + + + + whether the input buffer could be changed + + + + a #GstVulkanFence to signal on completion - + line="942">the #GstVulkanFullScreenQuad + + + + the output #GstBuffer to set + - - the parent #GstObject - - - - the configured output #GstVideoInfo - - - - the configured input #GstVideoInfo - - - - the #GstVulkanQueue to submit #GstVulkanCommandBuffer's on - - + + + + whether the shaders could be set + + + + + the #GstVulkanFullScreenQuad + + + + the vertex shader to set + + + + the fragment shader to set + + + + + + + + whether the shaders could be set + + + + + the #GstVulkanFullScreenQuad + + + + the uniform data to set. Must be a #GstVulkanBufferMemory + + + + + + + + whether the index data could be set + + + + + the #GstVulkanFullScreenQuad + + + + the vertex data. Must be a #GstVulkanBufferMemory + + + + + + + + whether @cmd could be submitted to the queue + + + + + a #GstVulkanFullScreenQuad + + + + a #GstVulkanCommandBuffer to submit + + + + a #GstVulkanFence to signal on completion + + + + + + the parent #GstObject + + + + the configured output #GstVideoInfo + + + + the configured input #GstVideoInfo + + + + the #GstVulkanQueue to submit #GstVulkanCommandBuffer's on + + c:symbol-prefix="vulkan_handle"> Holds information about a vulkan non dispatchable handle that only has + line="129">Holds information about a vulkan non dispatchable handle that only has a vulkan device as a parent and no specific host synchronisation requirements. Command buffers have extra requirements that are serviced by more specific implementations (#GstVulkanCommandBuffer, #GstVulkanCommandPool). + line="158"/> the parent #GstMiniObject + line="131">the parent #GstMiniObject the #GstVulkanDevice for this handle + line="132">the #GstVulkanDevice for this handle the type of handle + line="133">the type of handle the handle value + line="134">the handle value @@ -4492,7 +5359,7 @@ more specific implementations (#GstVulkanCommandBuffer, #GstVulkanCommandPool).< c:identifier="gst_vulkan_handle_new_wrapped" version="1.18"> + line="213"/> Frees the descriptor set layout in @handle + line="220"/> @@ -4569,7 +5436,7 @@ more specific implementations (#GstVulkanCommandBuffer, #GstVulkanCommandPool).< filename="gst-libs/gst/vulkan/gstvkhandle.c" line="211">Frees the framebuffer in @handle + line="235"/> @@ -4598,7 +5465,7 @@ more specific implementations (#GstVulkanCommandBuffer, #GstVulkanCommandPool).< filename="gst-libs/gst/vulkan/gstvkhandle.c" line="131">Frees the pipeline in @handle + line="226"/> @@ -4627,7 +5494,7 @@ more specific implementations (#GstVulkanCommandBuffer, #GstVulkanCommandPool).< filename="gst-libs/gst/vulkan/gstvkhandle.c" line="150">Frees the pipeline layout in @handle + line="223"/> @@ -4656,7 +5523,7 @@ more specific implementations (#GstVulkanCommandBuffer, #GstVulkanCommandPool).< filename="gst-libs/gst/vulkan/gstvkhandle.c" line="171">Frees the render pass in @handle + line="229"/> @@ -4685,7 +5552,7 @@ more specific implementations (#GstVulkanCommandBuffer, #GstVulkanCommandPool).< filename="gst-libs/gst/vulkan/gstvkhandle.c" line="192">Frees the sampler in @handle + line="232"/> @@ -4714,7 +5581,7 @@ more specific implementations (#GstVulkanCommandBuffer, #GstVulkanCommandPool).< filename="gst-libs/gst/vulkan/gstvkhandle.c" line="232">Frees the shader in @handle + line="238"/> @@ -4742,20 +5609,20 @@ more specific implementations (#GstVulkanCommandBuffer, #GstVulkanCommandPool).< introspectable="0"> Increases the refcount of the given handle by one. + line="160">Increases the refcount of the given handle by one. + line="170"/> @buf + line="166">@buf a #GstVulkanHandle. + line="162">a #GstVulkanHandle. @@ -4766,10 +5633,10 @@ more specific implementations (#GstVulkanCommandBuffer, #GstVulkanCommandPool).< introspectable="0"> Decreases the refcount of the buffer. If the refcount reaches 0, the buffer + line="177">Decreases the refcount of the buffer. If the refcount reaches 0, the buffer will be freed. + line="186"/> @@ -4777,7 +5644,7 @@ will be freed. a #GstVulkanHandle. + line="179">a #GstVulkanHandle. @@ -5249,6 +6116,36 @@ inside @handle. filename="gst-libs/gst/vulkan/gstvkhandle.h" line="87">shader + + video session + + + video session parameters + + + sampler with YCBCR conversion + a #GstBufferPool that allocates buffers with #GstGLMemory + line="529">a #GstBufferPool that allocates buffers with #GstGLMemory the #GstVulkanDevice to use - + filename="gst-libs/gst/vulkan/gstvkimagebufferpool.c" + line="527">the #GstVulkanDevice to use + + + + + + Sets the @usage and @mem_properties of the images to setup. + + + + + + + the #GstStructure with the pool's configuration. + + + + The Vulkan image usage flags. + + + + Vulkan memory property flags. + + + + Initial Vulkan image layout. + + + + Access flags for the layout transition if @initial_layout is +not VK_IMAGE_LAYOUT_UNDEFINED or VK_IMAGE_LAYOUT_PREINITIALIZED. + + + + + + Decode @caps are used when the buffers are going to be used either as decoded +dest or DPB images. + + + + + + + the #GstStructure with the pool's configuration. + + + + Upstream decode caps. + + + + + + parent #GstBufferPool + + + + the #GstVulkanDevice to allocate images from + + + + + + + + + + The #GstVulkanImageBufferPoolClass structure contains only private data + + + parent #GstBufferPoolClass + + + + + + + + + + + + + + + parent #GstMemory + + + + the #GstVulkanDevice to allocate images from + + + + the Vulkan image handle + + + + the backing #GstVulkanMemory for @image + + + + creation information for @image + + + + memory requirements for @image + + + + format properties + + + + intended usage for @image + + + + last set barrier for @image + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + a #GstVulkanImageMemory + + + + a #GstVulkanImageView + + + + + + + + the first #GstVulkanImageView that + @find_func returns %TRUE for, or %NULL + + + + + a #GstVulkanImageMemory + + + + #GstVulkanImageMemoryFindViewFunc to search with + + + + user data to call @finc_func with + + + + + + + + the height of @image + + + + + a #GstVulkanImageMemory + + + + + + + + the width of @image + + + + + a #GstVulkanImageMemory + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Allocated a new #GstVulkanImageMemory. + + + a #GstMemory object backed by a vulkan device memory + + + + + a #GstVulkanDevice + + + + the VkFormat for the new image + + + + width for the new image + + + + height for the new image + + + + tiling for the new image + + + + usage flags for the new image + + + + VkDeviceMemory property flags for the new image + + + + + + + + a #GstMemory object backed by a vulkan device memory + + + + + a #GstVulkanDevice + + + + VkImageCreateInfo structure + + + + VkMemoryPropertyFlags flags + + + + + + Initializes the Vulkan image memory allocator. It is safe to call this function +multiple times. This must be called before any other #GstVulkanImageMemory operation. + + + + + + + + + a new #GstVulkanImageMemory wrapping @image + + + + + a #GstVulkanDevice + + + + a VkImage + + + + the VkFormat for @image + + + + width of @image + + + + height of @image + + + + tiling of @image + + + + usage flags of @image + + + + user data for @notify + + + + a #GDestroyNotify when @image is no longer needed + - - - parent #GstBufferPool - - - + + + + Opaque #GstVulkanImageMemoryAllocator struct + + the #GstVulkanDevice to allocate images from - + filename="gst-libs/gst/vulkan/gstvkimagememory.h" + line="131">the parent #GstAllocator + @@ -5298,20 +6734,20 @@ inside @handle. - The #GstVulkanImageBufferPoolClass structure contains only private data - + filename="gst-libs/gst/vulkan/gstvkimagememory.h" + line="145">The #GstVulkanImageMemoryAllocatorClass only contains private data + parent #GstBufferPoolClass - + filename="gst-libs/gst/vulkan/gstvkimagememory.h" + line="147">the parent #GstAllocatorClass + @@ -5319,426 +6755,750 @@ inside @handle. - - - - + + Function definition used to find views. Return %TRUE if @view matches the +criteria. + line="127"/> + + + + + + + + + + + + + + parent #GstMemory - + filename="gst-libs/gst/vulkan/gstvkimageview.h" + line="44">the parent #GstMiniObject + the #GstVulkanDevice to allocate images from + filename="gst-libs/gst/vulkan/gstvkimageview.h" + line="45">the #GstVulkanDevice the Vulkan image handle - + filename="gst-libs/gst/vulkan/gstvkimageview.h" + line="46">the associated #GstVulkanImageMemory for this view + - + the backing #GstVulkanMemory for @image - + filename="gst-libs/gst/vulkan/gstvkimageview.h" + line="47">the vulkan image view handle + creation information for @image - + filename="gst-libs/gst/vulkan/gstvkimageview.h" + line="48">the creation information for this view + - - memory requirements for @image - + + + + - + + + + A new #GstVulkanImageView from @image and + @create_info + + + + + a #GstVulkanImageMemory to create the new view from + + + + the creation information to create the view from + + + + + format properties - - - + filename="gst-libs/gst/vulkan/gstvkimageview.h" + line="67">Increases the refcount of the given trash object by one. + + + @trash + + + + + a #GstVulkanImageView. + + + + + intended usage for @image - - - + filename="gst-libs/gst/vulkan/gstvkimageview.h" + line="84">Decreases the refcount of the trash object. If the refcount reaches 0, the +trash will be freed. + + + + + + + a #GstVulkanImageView. + + + + + + + + + + + a new uninitialized #GstVulkanInstance + + + + + If a #GstVulkanInstance is requested in @query, sets @instance as the reply. + +Intended for use with element query handlers to respond to #GST_QUERY_CONTEXT +for a #GstVulkanInstance. + + + whether @query was responded to with @instance + + + + + a #GstElement + + + + a #GstQuery of type #GST_QUERY_CONTEXT + + + + the #GstVulkanInstance + + + + + last set barrier for @image - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Attempt to retrieve a #GstVulkanInstance using #GST_QUERY_CONTEXT from the +surrounding elements of @element. + + + whether @instance contains a valid #GstVulkanInstance + + + + + a #GstElement + + + + a #GstVulkanInstance + + + + + - + Check if the configured vulkan instance supports the specified version. +Will not work prior to opening the instance with gst_vulkan_instance_open(). +If a specific version is requested, the @patch level is ignored. + - + whether @instance is at least the requested version. + - + a #GstVulkanImageMemory - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="1281">a #GstVulkanInstance + - + a #GstVulkanImageView - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="1282">major version + + + + minor version + + + + patch version + - - - + + + the first #GstVulkanImageView that - @find_func returns %TRUE for, or %NULL - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="1110">a new #GstVulkanDevice + - + a #GstVulkanImageMemory - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="1107">a #GstVulkanInstance + - + + + + Disable an Vulkan extension by @name. Disabling an extension will only have +an effect before the call to gst_vulkan_instance_open(). + + + whether the Vulkan extension could be disabled. + + + + #GstVulkanImageMemoryFindViewFunc to search with - - - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="580">a #GstVulkanInstance + + + user data to call @finc_func with - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="581">extension name to enable + - - + Enable an Vulkan extension by @name. Extensions cannot be enabled until +gst_vulkan_instance_fill_info() has been called. Enabling an extension will +only have an effect before the call to gst_vulkan_instance_open(). + the height of @image - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="531">whether the Vulkan extension could be enabled. + - + a #GstVulkanImageMemory - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="524">a #GstVulkanInstance + + + extension name to enable + + - - + Enable an Vulkan layer by @name. Layer cannot be enabled until +gst_vulkan_instance_fill_info() has been called. Enabling a layer will +only have an effect before the call to gst_vulkan_instance_open(). + the width of @image - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="677">whether the Vulkan layer could be enabled. + + + + + a #GstVulkanInstance + + + + layer name to enable + + + + + + Retrieve as much information about the available Vulkan instance without +actually creating an Vulkan instance. Will not do anything while @instance +is open. + + + whether the instance information could be retrieved + - + a #GstVulkanImageMemory - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="819">a #GstVulkanInstance + - - + + Retrieves information about an extension. + +Will not find any extensions before gst_vulkan_instance_fill_info() has been +called. + + whether extension @name is available - - + + a #GstVulkanInstance + - - - - - - - - - - - - - - - - - - - - + + the layer name to look for + - - + + return value for the layer specification version + - + Allocated a new #GstVulkanImageMemory. - - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="366">Retrieves information about a layer. + +Will not find any layers before gst_vulkan_instance_fill_info() has been +called. + + a #GstMemory object backed by a vulkan device memory - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="379">whether layer @name is available + - + a #GstVulkanDevice - - - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="368">a #GstVulkanInstance + + + the VkFormat for the new image - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="369">the layer name to look for + - + width for the new image - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="370">return value for the layer description or %NULL + - + height for the new image - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="371">return value for the layer specification version + - + tiling for the new image - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="372">return value for the layer implementation version + - + + + + Performs `vkGetInstanceProcAddr()` with @instance and @name + + + the function pointer for @name or %NULL + + + + usage flags for the new image - - - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="1079">a #GstVulkanInstance + + + VkDeviceMemory property flags for the new image - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="1080">name of the function to retrieve + - - + + Initializes the Vulkan image memory allocator. It is safe to call this function -multiple times. This must be called before any other #GstVulkanImageMemory operation. - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="1311">Retrieve the vulkan instance configured version. Only returns the supported +API version by the instance without taking into account the requested API +version. This means gst_vulkan_instance_check_version() will return +different values if a specific version has been requested (which is the +default) than a version check that is performed manually by retrieving the +version with this function. + - - - - - a new #GstVulkanImageMemory wrapping @image - - - - a #GstVulkanDevice - - - - a VkImage - - - + the VkFormat for @image - - - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="1313">a #GstVulkanInstance + + + width of @image - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="1314">major version + - + height of @image - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="1315">minor version + - + tiling of @image - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="1316">patch version + - + + + + + + whether extension @name is enabled + + + + usage flags of @image - - - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="471">a # GstVulkanInstance + + + user data for @notify - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="472">extension name + - + + + + + + whether layer @name is enabled + + + + a #GDestroyNotify when @image is no longer needed - + filename="gst-libs/gst/vulkan/gstvkinstance.c" + line="618">a # GstVulkanInstance + + + + layer name + - - - - Opaque #GstVulkanImageMemoryAllocator struct - + + + + + whether the instance could be created + + + + + a #GstVulkanInstance + + + + + + + + + + the parent #GstAllocator - + filename="gst-libs/gst/vulkan/gstvkinstance.h" + line="46">parent #GstObject + + + + the Vulkan instance handle + + + + list of vulkan physical device handles + + + + + + Overrides the #GstVulkanDevice creation mechanism. +It can be called from any thread. + + the newly created #GstVulkanDevice. + + + - - The #GstVulkanImageMemoryAllocatorClass only contains private data - + the parent #GstAllocatorClass - + filename="gst-libs/gst/vulkan/gstvkinstance.h" + line="67">parent #GstObjectClass + @@ -5746,964 +7506,867 @@ multiple times. This must be called before any other #GstVulkanImageMemory oper - - Function definition used to find views. Return %TRUE if @view matches the -criteria. - - - - - - - - - - - - - - - - + + + + + + the parent #GstMiniObject - + filename="gst-libs/gst/vulkan/gstvkmemory.h" + line="57">the parent #GstMemory + the #GstVulkanDevice + filename="gst-libs/gst/vulkan/gstvkmemory.h" + line="58">the #GstVulkanDevice this memory is allocated from - + the associated #GstVulkanImageMemory for this view - + filename="gst-libs/gst/vulkan/gstvkmemory.h" + line="59">the vulkan memory handle + + + + lock for accessing/changing memory informat + + + + number of times this memory is mapped + + + + internal pointer to already mapped memory + + + + + + + + + + + + + - - the vulkan image view handle - + + - - the creation information for this view - + + - - + + Allocated a new #GstVulkanMemory. + A new #GstVulkanImageView from @image and - @create_info - + filename="gst-libs/gst/vulkan/gstvkmemory.c" + line="308">a #GstMemory object backed by a vulkan device memory + - + a #GstVulkanImageMemory to create the new view from - + filename="gst-libs/gst/vulkan/gstvkmemory.c" + line="301">a #GstVulkanDevice + - + the creation information to create the view from - + filename="gst-libs/gst/vulkan/gstvkmemory.c" + line="302">the Vulkan memory type index + - - - - Increases the refcount of the given trash object by one. - - - @trash - - - - + a #GstVulkanImageView. - - - - - - Decreases the refcount of the trash object. If the refcount reaches 0, the -trash will be freed. - - - - - - + filename="gst-libs/gst/vulkan/gstvkmemory.c" + line="303">a #GstAllocationParams + + + a #GstVulkanImageView. - - + filename="gst-libs/gst/vulkan/gstvkmemory.c" + line="304">the size to allocate + + + + + - - - - - - - - a new uninitialized #GstVulkanInstance - - - - - If a #GstVulkanInstance is requested in @query, sets @instance as the reply. - -Intended for use with element query handlers to respond to #GST_QUERY_CONTEXT -for a #GstVulkanInstance. - + + + whether @query was responded to with @instance + filename="gst-libs/gst/vulkan/gstvkmemory.c" + line="266">whether a valid memory type could be found - + a #GstElement - + filename="gst-libs/gst/vulkan/gstvkmemory.c" + line="261">a #GstVulkanDevice + - + a #GstQuery of type #GST_QUERY_CONTEXT - + filename="gst-libs/gst/vulkan/gstvkmemory.c" + line="262">memory requirements to look for + - + the #GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkmemory.c" + line="263">memory properties to search for + + + + resulting index of the memory type + - + + + + + + + + + + + Attempt to retrieve a #GstVulkanInstance using #GST_QUERY_CONTEXT from the -surrounding elements of @element. - + filename="gst-libs/gst/vulkan/gstvkmemory.c" + line="349">Initializes the Vulkan memory allocator. It is safe to call this function +multiple times. This must be called before any other #GstVulkanMemory operation. + + + + + + + + + + + + + + + + + + Opaque #GstVulkanMemoryAllocator struct + + + the parent #GstAllocator + + + + + + + + + + The #GstVulkanMemoryAllocatorClass only contains private data + + + the parent #GstAllocatorClass + + + + + + + + + + When using the operation @cmd_buf, you should lock it using +gst_vulkan_command_buffer_lock(), but you have to unlock it, with +gst_vulkan_command_buffer_unlock(), when calling any of #GstVulkanOperation +methods. + + + + whether @instance contains a valid #GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1435">a newly allocated #GstVulkanOperation + - - a #GstElement - - - + a #GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1433">a #GstVulkanCommandPool + - - - Check if the configured vulkan instance supports the specified version. -Will not work prior to opening the instance with gst_vulkan_instance_open(). -If a specific version is requested, the @patch level is ignored. - + + + Add @frame as an operation dependency by adding the timeline semaphores in +each memory of @frame into either the wait semaphore array. The signal array +hold the same semaphores but increasing their current value. + whether @instance is at least the requested version. + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1004">whether the @frame was added as dependency. - + a #GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="993">a #GstVulkanOperation + - + major version - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="994">a Vulkan Image #GstBuffer + - + minor version - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="995">pipeline stage to wait (VkPipelineStageFlags or + VkPipelineStageFlags2) + - + patch version - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="997">pipeline stage to signal (VkPipelineStageFlags or + VkPipelineStageFlags2) + - - - - a new #GstVulkanDevice - - - - - a #GstVulkanInstance - - - - - + Disable an Vulkan extension by @name. Disabling an extension will only have -an effect before the call to gst_vulkan_instance_open(). - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="778">See also: gst_vulkan_operation_use_sync2(), + gst_vulkan_operation_new_extra_image_barriers() and + gst_vulkan_operation_update_frame() + +Any non-repeated image barrier in @extra is appended to the internal barrier +list. + +Remember to call gst_vulkan_operation_update_frame() on those frames with +images in @extra_barriers. + - whether the Vulkan extension could be disabled. - + - + a #GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="780">a #GstVulkanOperation + - + extension name to enable - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="781">a #GArray of extra image memory barriers to handle + + + - + Enable an Vulkan extension by @name. Extensions cannot be enabled until -gst_vulkan_instance_fill_info() has been called. Enabling an extension will -only have an effect before the call to gst_vulkan_instance_open(). - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="858">See also: gst_vulkan_operation_update_frame() + +Adds an image memory barrier per memory in @frame with its future state. And +it updates the @frame barrier state by calling internally +gst_vulkan_operation_update_frame(). + whether the Vulkan extension could be enabled. + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="875">whether the @frame barriers were appended - + a #GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="860">a #GstVulkanOperation + - + extension name to enable - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="861">a Vulkan Image #GstBuffer + - - - - Enable an Vulkan layer by @name. Layer cannot be enabled until -gst_vulkan_instance_fill_info() has been called. Enabling a layer will -only have an effect before the call to gst_vulkan_instance_open(). - - - whether the Vulkan layer could be enabled. - - - - + a #GstVulkanInstance - - - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="862">destination pipeline stage (VkPipelineStageFlags or + VkPipelineStageFlags2) + + + layer name to enable - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="864">the new access flags (VkAccessFlags2 or VkAccessFlags) + - - - - Retrieve as much information about the available Vulkan instance without -actually creating an Vulkan instance. Will not do anything while @instance -is open. - - - whether the instance information could be retrieved - - - - + a #GstVulkanInstance - - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="865">the new VkImageLayout + + + + destination #GstVulkanQueue for a transfer of @frame + ownership + + - + Retrieves information about an extension. + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="290">See also: gst_vulkan_operation_end() and gst_vulkan_operation_reset() -Will not find any extensions before gst_vulkan_instance_fill_info() has been -called. - +Attempts to set the operation ready to work. It instantiates the common +command buffer in @self and calls vkBeginCommandBuffer. + +After calling this function you can register commands in the command buffer, +and finally call gst_vulkan_operation_end(). gst_vulkan_operation_reset() is +called internally if something failed. + whether extension @name is available + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="304">whether the operation started. It might fill @error. - + a #GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="292">a #GstVulkanOperation + - - the layer name to look for - - - - return value for the layer specification version - - - + Retrieves information about a layer. - -Will not find any layers before gst_vulkan_instance_fill_info() has been -called. - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1313">Begins a query operation in the current command buffer. + whether layer @name is available + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1319">whether the begin command was set - + a #GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1315">a #GstVulkanOperation + - - the layer name to look for - - - - return value for the layer description or %NULL - - - - return value for the layer specification version - - - - return value for the layer implementation version - + + - - Performs `vkGetInstanceProcAddr()` with @instance and @name - - - the function pointer for @name or %NULL - + + Discards barriers, and all the semaphore arrays populated by +gst_vulkan_operation_add_dependency_frame(). + + + - + a #GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1156">a #GstVulkanOperation + - - name of the function to retrieve - - - + Retrieve the vulkan instance configured version. Only returns the supported -API version by the instance without taking into account the requested API -version. This means gst_vulkan_instance_check_version() will return -different values if a specific version has been requested (which is the -default) than a version check that is performed manually by retrieving the -version with this function. - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1184">Tries to enable the query pool for the current operation. + - + whether the query pool was enabled. It might populate @error in case + of error. + - + a #GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1186">a #GstVulkanOperation + - + major version - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1187">the VkQueryType to enable + - + minor version - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1188">number of queries to enable + - + patch version - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1189">the structure pointer to use as pNext + - - + + See also: gst_vulkan_operation_begin() and gst_vulkan_operation_reset() + +It calls vkEndCommandBuffer, and later either vkQueueSubmit or +vkQueueSubmit2KHR filling up the semaphores from images declared as +dependencies. + +You have called gst_vulkan_operation_begin() before. +gst_vulkan_operation_reset() is called internally if something fails + whether extension @name is enabled + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="482">whether the operation failed. It might fill @error. - + a # GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="470">a #GstVulkanOperation + - - extension name - - - - + + Ends a query operation in the current command buffer. + whether layer @name is enabled + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1350">whether the end command was set - + a # GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1346">a #GstVulkanOperation + - - layer name - + + - - + Gets the latest operation results of all the queries in @data. API users have +to parse the binary array of @data according of their needs (usually is a +guint32 array of size of n_query). + +Don't free @data. + whether the instance could be created + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1275">whether a status was fetched. If not, it might populate @error - + a #GstVulkanInstance - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1265">a #GstVulkanOperation + + + result of all queries + + - - - - - - - - parent #GstObject - - - - the Vulkan instance handle - - - - list of vulkan physical device handles - - - - - - - - - - - - Overrides the #GstVulkanDevice creation mechanism. -It can be called from any thread. - - the newly created #GstVulkanDevice. - - - - - - - - parent #GstObjectClass - - - - - - - - - - - - - - - the parent #GstMemory - - - - the #GstVulkanDevice this memory is allocated from - - - - the vulkan memory handle - - - - lock for accessing/changing memory informat - - - - number of times this memory is mapped - - - - - - - - - - - - - - - - - - - - - - - - - - + Allocated a new #GstVulkanMemory. - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="753">See also: gst_vulkan_operation_use_sync2(), + gst_vulkan_operation_add_extra_image_barriers() and + gst_vulkan_operation_update_frame() + +If it's required to add custom image memory barriers this function will +allocate a new array to append in it the extra image memory barriers to +handle. + +Remember to call gst_vulkan_operation_update_frame() after adding the barrier +related with that frame. + a #GstMemory object backed by a vulkan device memory - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="768">A new allocated array of barriers, either + VkImageMemoryBarrier or VkImageMemoryBarrier2KHR, depending whether + synchronization2 extension is used. + + + - - a #GstVulkanDevice - - - + the Vulkan memory type index - - - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="755">a #GstVulkanOperation + + + + + + It's a wrapper to vkCmdPipelineBarrier2{KHR} if it's available. + + + %TRUE if vkCmdPipelineBarrier2{KHR} it's available. %FALSE, + otherwise. + + + + a #GstAllocationParams - - - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1391">a #GstVulkanOperation + + + the size to allocate - - - - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="1392">a pointer to VkDependencyInfo + - - - + + + Resets the operation to a clean state. + + + + + + a #GstVulkanOperation + + + + + + Retrieves a copy of the current defined barriers internally, which will be +used by vkCmdPipelineBarrier or vkCmdPipelineBarrier2KHR by the API user. + +The element type of the array might be, depending on if synchronization2 +extension is used, either VkImageMemoryBarrier or VkImageMemoryBarrier2KHR. + + whether a valid memory type could be found - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="738">Current barriers array. Call g_array_unref() after + the operation is using. + + + - + a #GstVulkanDevice - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="730">a #GstVulkanOperation + + + + + + Add or update the internal list of the future state of @frame. This state +will be set after gst_vulkan_operation_end(). + +This method is useful when new barriers are added to the array without using +gst_vulkan_operation_add_frame_barrier(). + + + + + + + a #GstVulkanOperation + + + + a #GstBuffer to update after submit + - + memory type bits to search for - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="672">destination pipeline stage (VkPipelineStageFlags or + VkPipelineStageFlags2) + - + memory properties to search for - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="674">the new access flags (VkAccessFlags2 or VkAccessFlags) + - + resulting index of the memory type - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="675">the new VkImageLayout + + + + destination #GstVulkanQueue for a transfer of @frame + ownership + - - - - - + + + + + whether the operations are using synchronization2 extension. + - - - + + a #GstVulkanOperation + + - - + + Initializes the Vulkan memory allocator. It is safe to call this function -multiple times. This must be called before any other #GstVulkanMemory operation. - + filename="gst-libs/gst/vulkan/gstvkoperation.c" + line="567">Waits for the operation's fence to signal. + - - - - - - - + whether the operation succeed. + - - - + + a #GstVulkanOperation + + - - - - Opaque #GstVulkanMemoryAllocator struct - + + + + the parent #GstAllocator - + filename="gst-libs/gst/vulkan/gstvkoperation.h" + line="37">the parent #GstObject + + + + the current #GstVulkanCommandBuffer + @@ -6711,20 +8374,13 @@ multiple times. This must be called before any other #GstVulkanMemory operation - - The #GstVulkanMemoryAllocatorClass only contains private data - + + - the parent #GstAllocatorClass - + @@ -6732,6 +8388,12 @@ multiple times. This must be called before any other #GstVulkanMemory operation + + + + line="106"/> + line="111"/> a new #GstVulkanPhysicalDevice + line="102">a new #GstVulkanPhysicalDevice the parent #GstVulkanInstance + line="100">the parent #GstVulkanInstance @@ -6773,14 +8435,14 @@ multiple times. This must be called before any other #GstVulkanMemory operation name of @type + line="150">name of @type a `VkPhysicalDeviceType + line="148">a `VkPhysicalDeviceType @@ -6791,30 +8453,30 @@ multiple times. This must be called before any other #GstVulkanMemory operation version="1.18"> Retrieves information about a device extension. + line="1197">Retrieves information about a device extension. Will not find any extensions before gst_vulkan_instance_fill_info() has been called. + line="120"/> whether extension @name is available + line="1208">whether extension @name is available a #GstVulkanPhysicalDevice + line="1199">a #GstVulkanPhysicalDevice the extension name to look for + line="1200">the extension name to look for nullable="1"> return value for the exteion specification version + line="1201">return value for the exteion specification version @@ -6834,18 +8496,18 @@ called. version="1.18" introspectable="0"> + line="117"/> The associated `VkPhysicalDevice` handle + line="1088">The associated `VkPhysicalDevice` handle a #GstVulkanPhysicalDevice + line="1086">a #GstVulkanPhysicalDevice @@ -6856,18 +8518,18 @@ called. glib:get-property="instance" version="1.18"> + line="114"/> The #GstVulkanInstance associated with this physical device + line="1104">The #GstVulkanInstance associated with this physical device a #GstVulkanPhysicalDevice + line="1102">a #GstVulkanPhysicalDevice @@ -6878,30 +8540,30 @@ called. version="1.18"> Retrieves information about a layer. + line="1141">Retrieves information about a layer. Will not find any layers before gst_vulkan_instance_fill_info() has been called. + line="124"/> whether layer @name is available + line="1154">whether layer @name is available a #GstVulkanPhysicalDevice + line="1143">a #GstVulkanPhysicalDevice the layer name to look for + line="1144">the layer name to look for nullable="1"> return value for the layer description or %NULL + line="1145">return value for the layer description or %NULL nullable="1"> return value for the layer specification version + line="1146">return value for the layer specification version nullable="1"> return value for the layer implementation version + line="1147">return value for the layer implementation version @@ -6956,61 +8618,67 @@ called. the parent #GstObject + line="53">the parent #GstObject the parent #GstVulkanInstance for this physical device + line="54">the parent #GstVulkanInstance for this physical device the index into the physical device list in @instance + line="55">the index into the physical device list in @instance the vulkan physical device handle + line="56">the vulkan physical device handle retrieved physical device properties + line="57">retrieved physical device properties retrieved physical device features + line="58">retrieved physical device features retrieved physical device memory properties + line="59">retrieved physical device memory properties vulkan family properties + line="60">vulkan family properties number of elements in @queue_family_props + line="61">number of elements in @queue_family_props + + vulkan operations allowed per queue family + + @@ -7022,11 +8690,11 @@ called. glib:is-gtype-struct-for="VulkanPhysicalDevice" version="1.18"> + line="106"/> the parent #GstObjectClass + line="96">the parent #GstObjectClass @@ -7049,7 +8717,7 @@ called. glib:type-name="GstVulkanQueue" glib:get-type="gst_vulkan_queue_get_type" glib:type-struct="VulkanQueueClass"> - + @@ -7069,29 +8737,29 @@ called. version="1.18"> If a #GstVulkanQueue is requested in @query, sets @queue as the reply. + line="287">If a #GstVulkanQueue is requested in @query, sets @queue as the reply. Intended for use with element query handlers to respond to #GST_QUERY_CONTEXT for a #GstVulkanQueue. + line="108"/> whether @query was responded to with @queue + line="298">whether @query was responded to with @queue a #GstElement + line="289">a #GstElement a #GstQuery of type #GST_QUERY_CONTEXT + line="290">a #GstQuery of type #GST_QUERY_CONTEXT allow-none="1"> the #GstVulkanQueue + line="291">the #GstVulkanQueue @@ -7110,21 +8778,21 @@ for a #GstVulkanQueue. version="1.18"> Attempt to retrieve a #GstVulkanQueue using #GST_QUERY_CONTEXT from the + line="337">Attempt to retrieve a #GstVulkanQueue using #GST_QUERY_CONTEXT from the surrounding elements of @element. + line="112"/> whether @queue contains a valid #GstVulkanQueue + line="345">whether @queue contains a valid #GstVulkanQueue a #GstElement + line="339">a #GstElement transfer-ownership="full"> a #GstVulkanQueue + line="340">a #GstVulkanQueue @@ -7143,7 +8811,7 @@ surrounding elements of @element. version="1.18" throws="1"> + line="90"/> + + Creates a #GstVulkanDecoder object if @codec decoding is supported by @queue + + + the #GstVulkanDecoder object + + + + + a #GstVulkanQueue + + + + the VkVideoCodecOperationFlagBitsKHR to decode + + + + + line="87"/> version="1.18"> Locks the queue for command submission using `vkQueueSubmit()` to meet the + line="383">Locks the queue for command submission using `vkQueueSubmit()` to meet the Vulkan requirements for externally synchronised resources. + line="97"/> @@ -7195,7 +8892,7 @@ Vulkan requirements for externally synchronised resources. a #GstVulkanQueue + line="385">a #GstVulkanQueue @@ -7205,11 +8902,11 @@ Vulkan requirements for externally synchronised resources. version="1.18"> Unlocks the queue for command submission using `vkQueueSubmit()`. + line="400">Unlocks the queue for command submission using `vkQueueSubmit()`. See gst_vulkan_queue_submit_lock() for details on when this call is needed. + line="99"/> @@ -7217,7 +8914,7 @@ See gst_vulkan_queue_submit_lock() for details on when this call is needed. a #GstVulkanQueue + line="402">a #GstVulkanQueue @@ -7225,31 +8922,31 @@ See gst_vulkan_queue_submit_lock() for details on when this call is needed. the parent #GstObject + line="48">the parent #GstObject the #GstVulkanDevice this queue was allocated from + line="49">the #GstVulkanDevice this queue was allocated from the vulkan queue handle + line="50">the vulkan queue handle the vulkan queue family + line="51">the vulkan queue family the vulkan queue index + line="52">the vulkan queue index @@ -7262,11 +8959,11 @@ See gst_vulkan_queue_submit_lock() for details on when this call is needed. - + the parent #GstObjectClass + line="72">the parent #GstObjectClass @@ -7275,6 +8972,24 @@ See gst_vulkan_queue_submit_lock() for details on when this call is needed. + + + + video operation supported by queue family + + + + if queue family supports queries + + + a #GstVulkanSwapper + line="1480">a #GstVulkanSwapper The #GstVideoRectangle for the configured + line="1481">The #GstVideoRectangle for the configured caps modified for DAR. @@ -7370,7 +9085,7 @@ See gst_vulkan_queue_submit_lock() for details on when this call is needed. The #GstVideoRectangle for where the + line="1483">The #GstVideoRectangle for where the output surface is located relative to its parent @@ -7381,7 +9096,7 @@ See gst_vulkan_queue_submit_lock() for details on when this call is needed. The #GstVideoRectangle for where the input + line="1485">The #GstVideoRectangle for where the input images are placed inside @surface_location @@ -8076,6 +9791,33 @@ signalled and freed. + + + + + + + + + + + + + + + + + + + + + + + + + The type of video operation. + + decode operation + + + encode operation + + + unknown + + + + + + the generic vulkan video profile + + + + + + + + + + + + + + + + + + + + + + + + + + + + + whether @a and @b contains the same information. + + + + + a #GstVulkanVideoProfile + + + + another #GstVulkanVideoProfile + + + + + + + + %TRUE if @profile is correct and matches with @codec + + + + + the output profile + + + + VkVideoCodecOperationFlagBitsKHR described by @profile + + + + + + + + a #GstCaps from @profile + + + + + #GstVulkanVideoProfile to convert into a #GstCaps + + + + + + + + %TRUE if @caps was parsed correctly, otherwise %FALSE + + + + + the output profile + + + + a #GstCaps to parse + + + + a supported video operation + + + + + c:identifier="gst_context_get_vulkan_device" version="1.18"> + line="136"/> Whether @device was in @context + line="724">Whether @device was in @context a #GstContext + line="721">a #GstContext resulting #GstVulkanDevice + line="722">resulting #GstVulkanDevice @@ -9081,20 +11008,20 @@ Currently intended for subclasses to update internal state. Whether @instance was in @context + line="1170">Whether @instance was in @context a #GstContext + line="1167">a #GstContext resulting #GstVulkanInstance + line="1168">resulting #GstVulkanInstance @@ -9102,24 +11029,24 @@ Currently intended for subclasses to update internal state. - + Whether @queue was in @context + line="264">Whether @queue was in @context a #GstContext + line="261">a #GstContext resulting #GstVulkanQueue + line="262">resulting #GstVulkanQueue @@ -9129,9 +11056,9 @@ Currently intended for subclasses to update internal state. version="1.18"> Sets @device on @context + line="692">Sets @device on @context + line="133"/> @@ -9139,13 +11066,13 @@ Currently intended for subclasses to update internal state. a #GstContext + line="694">a #GstContext a #GstVulkanDevice + line="695">a #GstVulkanDevice @@ -9181,7 +11108,7 @@ Currently intended for subclasses to update internal state. version="1.18"> Sets @instance on @context + line="1137">Sets @instance on @context @@ -9191,13 +11118,13 @@ Currently intended for subclasses to update internal state. a #GstContext + line="1139">a #GstContext a #GstVulkanInstance + line="1140">a #GstVulkanInstance @@ -9207,8 +11134,8 @@ Currently intended for subclasses to update internal state. version="1.18"> Sets @queue on @context - + line="232">Sets @queue on @context + @@ -9216,13 +11143,13 @@ Currently intended for subclasses to update internal state. a #GstContext + line="234">a #GstContext a #GstVulkanQueue + line="235">a #GstVulkanQueue @@ -9235,14 +11162,14 @@ Currently intended for subclasses to update internal state. whether the memory at @mem is a #GstVulkanBufferMemory + line="428">whether the memory at @mem is a #GstVulkanBufferMemory a #GstMemory + line="426">a #GstMemory @@ -9255,14 +11182,14 @@ Currently intended for subclasses to update internal state. whether the memory at @mem is a #GstVulkanImageMemory + line="726">whether the memory at @mem is a #GstVulkanImageMemory a #GstMemory + line="724">a #GstMemory @@ -9271,18 +11198,18 @@ Currently intended for subclasses to update internal state. c:identifier="gst_is_vulkan_memory" version="1.18"> + line="140"/> whether the memory at @mem is a #GstVulkanMemory + line="380">whether the memory at @mem is a #GstVulkanMemory a #GstMemory + line="378">a #GstMemory @@ -9303,6 +11230,11 @@ A #GstVulkanBufferPool is created with gst_vulkan_buffer_pool_new() #GstVulkanBufferPool implements the VideoMeta buffer pool option #GST_BUFFER_POOL_OPTION_VIDEO_META + + #GstVulkanOperation abstracts a video decoding operation. + A #GstVulkanDevice encapsulates a VkDevice + line="31">A #GstVulkanDevice encapsulates a VkDevice filename="gst-libs/gst/vulkan/gstvkimagebufferpool.c" line="27">a #GstVulkanImageBufferPool is an object that allocates buffers with #GstVulkanImageMemory -A #GstVulkanImageBufferPool is created with gst_vulkan_image_buffer_pool_new() - -#GstVulkanImageBufferPool implements the VideoMeta buffer pool option -#GST_BUFFER_POOL_OPTION_VIDEO_META +A #GstVulkanImageBufferPool is created with gst_vulkan_image_buffer_pool_new() filename="gst-libs/gst/vulkan/gstvkmemory.c" line="31">GstVulkanMemory is a #GstMemory subclass providing support for the mapping of Vulkan device memory. + + + A #GstVulkanOperation abstract a queue operation for images adding +automatically semaphores and barriers. It uses Synchronization2 extension if +available. Also it enables a VkQueryPool if it's possible and it's requested. A #GstVulkanPhysicalDevice encapsulates a VkPhysicalDevice + line="32">A #GstVulkanPhysicalDevice encapsulates a VkPhysicalDevice a #GstMemory object backed by a vulkan buffer + line="325">a #GstMemory object backed by a vulkan buffer backed by vulkan device memory @@ -9422,25 +11358,63 @@ either be a user visible window (onscreen) or hidden (offscreen). a #GstVulkanDevice + line="318">a #GstVulkanDevice size of the new buffer + line="319">size of the new buffer buffer usage flags + line="320">buffer usage flags memory properties flags for the backing memory + line="321">memory properties flags for the backing memory + + + + + + Allocate a new #GstVulkanBufferMemory. + + + a #GstMemory object backed by a vulkan buffer + backed by vulkan device memory + + + + + a #GstVulkanDevice + + + + the VkBufferCreateInfo structure + + + + memory properties flags for the backing memory @@ -9452,7 +11426,7 @@ either be a user visible window (onscreen) or hidden (offscreen). version="1.18"> Initializes the Vulkan buffer memory allocator. It is safe to call this function + line="397">Initializes the Vulkan buffer memory allocator. It is safe to call this function multiple times. This must be called before any other #GstVulkanBufferMemory operation. @@ -9466,32 +11440,32 @@ multiple times. This must be called before any other #GstVulkanBufferMemory ope version="1.18"> Allocated a new wrapped #GstVulkanBufferMemory with @buffer. + line="342">Allocated a new wrapped #GstVulkanBufferMemory with @buffer. + line="162"/> a #GstMemory object backed by a vulkan device memory + line="352">a #GstMemory object backed by a vulkan device memory a #GstVulkanDevice + line="344">a #GstVulkanDevice a `VkBuffer` + line="345">a `VkBuffer` usage flags of @buffer + line="346">usage flags of @buffer user data to call @notify with + line="347">user data to call @notify with a #GDestroyNotify called when @buffer is no longer in use + line="348">a #GDestroyNotify called when @buffer is no longer in use @@ -9555,11 +11529,11 @@ gst_vulkan_command_buffer_lock(). c:identifier="gst_vulkan_create_shader" version="1.18" throws="1"> - + a #GstVulkanHandle for @image matching the + line="519">a #GstVulkanHandle for @image matching the original layout and format of @image or %NULL @@ -9567,19 +11541,19 @@ gst_vulkan_command_buffer_lock(). a #GstVulkanDevice + line="514">a #GstVulkanDevice the SPIR-V shader byte code + line="515">the SPIR-V shader byte code length of @code. Must be a multiple of 4 + line="516">length of @code. Must be a multiple of 4 @@ -9736,45 +11710,157 @@ the error c:identifier="gst_vulkan_format_from_video_info" version="1.18" introspectable="0"> - + the VkFormat to use for @v_format and @plane + filename="gst-libs/gst/vulkan/gstvkformat.c" + line="483">the VkFormat to use for @v_format and @plane the #GstVideoInfo + filename="gst-libs/gst/vulkan/gstvkformat.c" + line="480">the #GstVideoInfo the plane + filename="gst-libs/gst/vulkan/gstvkformat.c" + line="481">the plane + + + + %TRUE if requested GStreamer format maps to a Vulkan format and its +properties. + + + + + a #GstVulkanPhysicalDevice + + + + the #GstVideoInfo + + + + the tiling to use + + + + query for vulkan formats without multiple images + + + + + + + Vulkan formats per image/plane + + + + + + number of images/planes used by the Vulkan format + + + + The potential usage of the format + + + + + + + + the @format aspect + + + + + Vulkan Format + + + + + line="134"/> the #GstVulkanFormatInfo for @format or %NULL + line="395">the #GstVulkanFormatInfo for @format or %NULL a valid `VkFormat` + line="393">a valid `VkFormat` + + + + + + + + the #GstVideoFormat that maps to @vk_format + + + + + the Vulkan format to convert @@ -9799,6 +11885,39 @@ the error + + Create a new #GstVulkanImageView with a specific @create_info. + + + a #GstVulkanImageView for @image matching the + original layout and format of @image + + + + + a #GstVulkanImageMemory + + + + a VkImageViewCreateInfo + + + + @@ -9939,7 +12058,7 @@ the result in @display or @instance respectively. filename="gst-libs/gst/vulkan/gstvkimagememory.c" line="437">Allocated a new #GstVulkanImageMemory. + line="188"/> + + + + a #GstMemory object backed by a vulkan device memory + + + + + a #GstVulkanDevice + + + + VkImageCreateInfo structure + + + + VkMemoryPropertyFlags flags + + + + Initializes the Vulkan image memory allocator. It is safe to call this function + line="695">Initializes the Vulkan image memory allocator. It is safe to call this function multiple times. This must be called before any other #GstVulkanImageMemory operation. @@ -10011,7 +12164,7 @@ multiple times. This must be called before any other #GstVulkanImageMemory oper moved-to="VulkanImageMemory.wrapped" version="1.18"> + line="197"/> version="1.18"> Allocated a new #GstVulkanMemory. + line="299">Allocated a new #GstVulkanMemory. + line="143"/> a #GstMemory object backed by a vulkan device memory + line="308">a #GstMemory object backed by a vulkan device memory a #GstVulkanDevice + line="301">a #GstVulkanDevice the Vulkan memory type index + line="302">the Vulkan memory type index a #GstAllocationParams + line="303">a #GstAllocationParams the size to allocate + line="304">the size to allocate @@ -10150,42 +12303,46 @@ other elements in the pipeline - + + line="150"/> whether a valid memory type could be found + line="266">whether a valid memory type could be found a #GstVulkanDevice + line="261">a #GstVulkanDevice - + memory type bits to search for - + line="262">memory requirements to look for + memory properties to search for + line="263">memory properties to search for - + resulting index of the memory type + line="264">resulting index of the memory type @@ -10210,10 +12367,10 @@ other elements in the pipeline version="1.18"> Initializes the Vulkan memory allocator. It is safe to call this function + line="349">Initializes the Vulkan memory allocator. It is safe to call this function multiple times. This must be called before any other #GstVulkanMemory operation. + line="138"/> @@ -10240,14 +12397,14 @@ multiple times. This must be called before any other #GstVulkanMemory operation name of @present_mode + line="177">name of @present_mode a `VkPresentModeKHR` + line="175">a `VkPresentModeKHR` @@ -10376,6 +12533,43 @@ associated #GstVulkanFence is signalled + + + + %TRUE if @caps was parsed correctly, otherwise %FALSE + + + + + the output profile + + + + a #GstCaps to parse + + + + a supported video operation + + + + URI of the HTTP proxy of the form - http://[username:password@]hostname[:port] + http://[username:password@]hostname[:port][?alpn=<alpn>] Get HTTP Proxy to be used when connecting to TURN server. @@ -1502,7 +1502,7 @@ Get HTTP Proxy to be used when connecting to TURN server. URI of the HTTP proxy of the form - http://[username:password@]hostname[:port] + http://[username:password@]hostname[:port][?alpn=<alpn>] @@ -1873,7 +1873,7 @@ Get HTTP Proxy to be used when connecting to TURN server. URI of the HTTP proxy of the form - http://[username:password@]hostname[:port] + http://[username:password@]hostname[:port][?alpn=<alpn>] Get HTTP Proxy to be used when connecting to TURN server. @@ -2088,7 +2088,7 @@ Get HTTP Proxy to be used when connecting to TURN server. URI of the HTTP proxy of the form - http://[username:password@]hostname[:port] + http://[username:password@]hostname[:port][?alpn=<alpn>] @@ -2847,7 +2847,7 @@ stops automatic ICE gathering. URI of the HTTP proxy of the form - http://[username:password@]hostname[:port] + http://[username:password@]hostname[:port][?alpn=<alpn>] @@ -2860,7 +2860,7 @@ stops automatic ICE gathering. URI of the HTTP proxy of the form - http://[username:password@]hostname[:port] + http://[username:password@]hostname[:port][?alpn=<alpn>] Get HTTP Proxy to be used when connecting to TURN server. diff --git a/girs/Gtk-2.0.gir b/girs/Gtk-2.0.gir index 2bb5263e8..b2047411e 100644 --- a/girs/Gtk-2.0.gir +++ b/girs/Gtk-2.0.gir @@ -23740,12 +23740,12 @@ progress bar will be "filled in". version="2.10"> Creates a new #GtkCellRendererSpin. + line="340">Creates a new #GtkCellRendererSpin. a new #GtkCellRendererSpin + line="345">a new #GtkCellRendererSpin @@ -69043,7 +69043,7 @@ identified and saved to persistant storage. Cancels the selection within the menu shell. + line="1663">Cancels the selection within the menu shell. @@ -69052,7 +69052,7 @@ identified and saved to persistant storage. a #GtkMenuShell + line="1665">a #GtkMenuShell @@ -69183,7 +69183,7 @@ identified and saved to persistant storage. Cancels the selection within the menu shell. + line="1663">Cancels the selection within the menu shell. @@ -69192,7 +69192,7 @@ identified and saved to persistant storage. a #GtkMenuShell + line="1665">a #GtkMenuShell @@ -69225,19 +69225,19 @@ identified and saved to persistant storage. version="2.8"> Returns %TRUE if the menu shell will take the keyboard focus on popup. + line="1795">Returns %TRUE if the menu shell will take the keyboard focus on popup. %TRUE if the menu shell will take the keyboard focus on popup. + line="1801">%TRUE if the menu shell will take the keyboard focus on popup. a #GtkMenuShell + line="1797">a #GtkMenuShell @@ -69278,7 +69278,7 @@ identified and saved to persistant storage. version="2.2"> Select the first visible or selectable child of the menu shell; + line="1387">Select the first visible or selectable child of the menu shell; don't select tearoff items unless the only item is a tearoff item. @@ -69289,13 +69289,13 @@ item. a #GtkMenuShell + line="1389">a #GtkMenuShell if %TRUE, search for the first selectable + line="1390">if %TRUE, search for the first selectable menu item, otherwise select nothing if the first item isn't sensitive. This should be %FALSE if the menu is being @@ -69324,7 +69324,7 @@ item. version="2.8"> If @take_focus is %TRUE (the default) the menu shell will take the keyboard + line="1817">If @take_focus is %TRUE (the default) the menu shell will take the keyboard focus so that it will receive all keyboard events which is needed to enable keyboard navigation in menus. @@ -69357,13 +69357,13 @@ See also gdk_keyboard_grab() a #GtkMenuShell + line="1819">a #GtkMenuShell %TRUE if the menu shell should take the keyboard focus on popup. + line="1820">%TRUE if the menu shell should take the keyboard focus on popup. @@ -69594,7 +69594,7 @@ another item. a #GtkMenuShell + line="1665">a #GtkMenuShell @@ -92768,19 +92768,19 @@ used resource list. Copies a #GtkRequisition. + line="10185">Copies a #GtkRequisition. a copy of @requisition + line="10191">a copy of @requisition a #GtkRequisition + line="10187">a #GtkRequisition @@ -92788,7 +92788,7 @@ used resource list. Frees a #GtkRequisition. + line="10199">Frees a #GtkRequisition. @@ -92797,7 +92797,7 @@ used resource list. a #GtkRequisition + line="10201">a #GtkRequisition @@ -100312,12 +100312,12 @@ use gtk_spinner_stop(). version="2.10"> Creates an empty status icon object. + line="1200">Creates an empty status icon object. a new #GtkStatusIcon + line="1205">a new #GtkStatusIcon @@ -100326,7 +100326,7 @@ use gtk_spinner_stop(). version="2.10"> Creates a status icon displaying the file @filename. + line="1236">Creates a status icon displaying the file @filename. The image will be scaled down to fit in the available space in the notification area, if necessary. @@ -100334,14 +100334,14 @@ space in the notification area, if necessary. a new #GtkStatusIcon + line="1245">a new #GtkStatusIcon a filename + line="1238">a filename @@ -100351,20 +100351,20 @@ space in the notification area, if necessary. version="2.14"> Creates a status icon displaying a #GIcon. If the icon is a + line="1298">Creates a status icon displaying a #GIcon. If the icon is a themed icon, it will be updated when the theme changes. a new #GtkStatusIcon + line="1305">a new #GtkStatusIcon a #GIcon + line="1300">a #GIcon @@ -100374,21 +100374,21 @@ themed icon, it will be updated when the theme changes. version="2.10"> Creates a status icon displaying an icon from the current icon theme. + line="1278">Creates a status icon displaying an icon from the current icon theme. If the current icon theme is changed, the icon will be updated appropriately. a new #GtkStatusIcon + line="1286">a new #GtkStatusIcon an icon name + line="1280">an icon name @@ -100398,7 +100398,7 @@ appropriately. version="2.10"> Creates a status icon displaying @pixbuf. + line="1215">Creates a status icon displaying @pixbuf. The image will be scaled down to fit in the available space in the notification area, if necessary. @@ -100406,14 +100406,14 @@ space in the notification area, if necessary. a new #GtkStatusIcon + line="1224">a new #GtkStatusIcon a #GdkPixbuf + line="1217">a #GdkPixbuf @@ -100423,7 +100423,7 @@ space in the notification area, if necessary. version="2.10"> Creates a status icon displaying a stock icon. Sample stock icon + line="1257">Creates a status icon displaying a stock icon. Sample stock icon names are #GTK_STOCK_OPEN, #GTK_STOCK_QUIT. You can register your own stock icon names, see gtk_icon_factory_add_default() and gtk_icon_factory_add(). @@ -100431,14 +100431,14 @@ gtk_icon_factory_add(). a new #GtkStatusIcon + line="1266">a new #GtkStatusIcon a stock icon id + line="1259">a stock icon id @@ -100448,7 +100448,7 @@ gtk_icon_factory_add(). version="2.10"> Menu positioning function to use with gtk_menu_popup() + line="2512">Menu positioning function to use with gtk_menu_popup() to position @menu aligned to the status icon @user_data. @@ -100458,25 +100458,25 @@ to position @menu aligned to the status icon @user_data. the #GtkMenu + line="2514">the #GtkMenu return location for the x position + line="2515">return location for the x position return location for the y position + line="2516">return location for the y position whether the first menu item should be offset (pushed in) to be + line="2517">whether the first menu item should be offset (pushed in) to be aligned with the menu popup position (only useful for GtkOptionMenu). @@ -100486,7 +100486,7 @@ to position @menu aligned to the status icon @user_data. allow-none="1"> the status icon to position the menu on + line="2519">the status icon to position the menu on @@ -100606,21 +100606,21 @@ to position @menu aligned to the status icon @user_data. deprecated-version="2.22"> Returns whether the icon is blinking, see + line="2454">Returns whether the icon is blinking, see gtk_status_icon_set_blinking(). This function will be removed in GTK+ 3 %TRUE if the icon is blinking + line="2461">%TRUE if the icon is blinking a #GtkStatusIcon + line="2456">a #GtkStatusIcon @@ -100630,7 +100630,7 @@ gtk_status_icon_set_blinking(). version="2.10"> Obtains information about the location of the status icon + line="2638">Obtains information about the location of the status icon on screen. This information can be used to e.g. position popups like notification bubbles. @@ -100646,7 +100646,7 @@ gtk_status_icon_is_embedded(). %TRUE if the location information has + line="2663">%TRUE if the location information has been filled in @@ -100654,7 +100654,7 @@ gtk_status_icon_is_embedded(). a #GtkStatusIcon + line="2640">a #GtkStatusIcon allow-none="1"> return location for the screen, or %NULL if the + line="2641">return location for the screen, or %NULL if the information is not needed @@ -100677,7 +100677,7 @@ gtk_status_icon_is_embedded(). allow-none="1"> return location for the area occupied by the status + line="2643">return location for the area occupied by the status icon, or %NULL @@ -100689,7 +100689,7 @@ gtk_status_icon_is_embedded(). allow-none="1"> return location for the orientation of the panel + line="2645">return location for the orientation of the panel in which the status icon is embedded, or %NULL. A panel at the top or bottom of the screen is horizontal, a panel at the left or right is vertical. @@ -100703,7 +100703,7 @@ gtk_status_icon_is_embedded(). version="2.14"> Retrieves the #GIcon being displayed by the #GtkStatusIcon. + line="2178">Retrieves the #GIcon being displayed by the #GtkStatusIcon. The storage type of the status icon must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_GICON (see gtk_status_icon_get_storage_type()). The caller of this function does not own a reference to the @@ -100714,14 +100714,14 @@ If this function fails, @icon is left unchanged; the displayed icon, or %NULL if the image is empty + line="2190">the displayed icon, or %NULL if the image is empty a #GtkStatusIcon + line="2180">a #GtkStatusIcon @@ -100732,20 +100732,20 @@ If this function fails, @icon is left unchanged; version="2.16"> Returns the current value of the has-tooltip property. + line="2738">Returns the current value of the has-tooltip property. See #GtkStatusIcon:has-tooltip for more information. current value of has-tooltip on @status_icon. + line="2745">current value of has-tooltip on @status_icon. a #GtkStatusIcon + line="2740">a #GtkStatusIcon @@ -100756,7 +100756,7 @@ See #GtkStatusIcon:has-tooltip for more information. version="2.10"> Gets the name of the icon being displayed by the #GtkStatusIcon. + line="2146">Gets the name of the icon being displayed by the #GtkStatusIcon. The storage type of the status icon must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_ICON_NAME (see gtk_status_icon_get_storage_type()). The returned string is owned by the #GtkStatusIcon and should not @@ -100765,14 +100765,14 @@ be freed or modified. name of the displayed icon, or %NULL if the image is empty. + line="2156">name of the displayed icon, or %NULL if the image is empty. a #GtkStatusIcon + line="2148">a #GtkStatusIcon @@ -100783,7 +100783,7 @@ be freed or modified. version="2.10"> Gets the #GdkPixbuf being displayed by the #GtkStatusIcon. + line="2080">Gets the #GdkPixbuf being displayed by the #GtkStatusIcon. The storage type of the status icon must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_PIXBUF (see gtk_status_icon_get_storage_type()). The caller of this function does not own a reference to the @@ -100792,7 +100792,7 @@ returned pixbuf. the displayed pixbuf, + line="2090">the displayed pixbuf, or %NULL if the image is empty. @@ -100800,7 +100800,7 @@ returned pixbuf. a #GtkStatusIcon + line="2082">a #GtkStatusIcon @@ -100811,19 +100811,19 @@ returned pixbuf. version="2.12"> Returns the #GdkScreen associated with @status_icon. + line="2259">Returns the #GdkScreen associated with @status_icon. a #GdkScreen. + line="2265">a #GdkScreen. a #GtkStatusIcon + line="2261">a #GtkStatusIcon @@ -100834,7 +100834,7 @@ returned pixbuf. version="2.10"> Gets the size in pixels that is available for the image. + line="2212">Gets the size in pixels that is available for the image. Stock icons and named icons adapt their size automatically if the size of the notification area changes. For other storage types, the size-changed signal can be used to @@ -100846,14 +100846,14 @@ status icon is embedded (see gtk_status_icon_is_embedded()). the size that is available for the image + line="2225">the size that is available for the image a #GtkStatusIcon + line="2214">a #GtkStatusIcon @@ -100864,7 +100864,7 @@ status icon is embedded (see gtk_status_icon_is_embedded()). version="2.10"> Gets the id of the stock icon being displayed by the #GtkStatusIcon. + line="2113">Gets the id of the stock icon being displayed by the #GtkStatusIcon. The storage type of the status icon must be %GTK_IMAGE_EMPTY or %GTK_IMAGE_STOCK (see gtk_status_icon_get_storage_type()). The returned string is owned by the #GtkStatusIcon and should not @@ -100873,7 +100873,7 @@ be freed or modified. stock id of the displayed stock icon, + line="2123">stock id of the displayed stock icon, or %NULL if the image is empty. @@ -100881,7 +100881,7 @@ be freed or modified. a #GtkStatusIcon + line="2115">a #GtkStatusIcon @@ -100892,21 +100892,21 @@ be freed or modified. version="2.10"> Gets the type of representation being used by the #GtkStatusIcon + line="2061">Gets the type of representation being used by the #GtkStatusIcon to store image data. If the #GtkStatusIcon has no image data, the return value will be %GTK_IMAGE_EMPTY. the image representation being used + line="2069">the image representation being used a #GtkStatusIcon + line="2063">a #GtkStatusIcon @@ -100917,19 +100917,19 @@ the return value will be %GTK_IMAGE_EMPTY. version="2.18"> Gets the title of this tray icon. See gtk_status_icon_set_title(). + line="3018">Gets the title of this tray icon. See gtk_status_icon_set_title(). the title of the status icon + line="3024">the title of the status icon a #GtkStatusIcon + line="3020">a #GtkStatusIcon @@ -100940,12 +100940,12 @@ the return value will be %GTK_IMAGE_EMPTY. version="2.16"> Gets the contents of the tooltip for @status_icon. + line="2914">Gets the contents of the tooltip for @status_icon. the tooltip text, or %NULL. You should free the + line="2920">the tooltip text, or %NULL. You should free the returned string with g_free() when done. @@ -100953,7 +100953,7 @@ the return value will be %GTK_IMAGE_EMPTY. a #GtkStatusIcon + line="2916">a #GtkStatusIcon @@ -100964,12 +100964,12 @@ the return value will be %GTK_IMAGE_EMPTY. version="2.16"> Gets the contents of the tooltip for @status_icon. + line="2832">Gets the contents of the tooltip for @status_icon. the tooltip text, or %NULL. You should free the + line="2838">the tooltip text, or %NULL. You should free the returned string with g_free() when done. @@ -100977,7 +100977,7 @@ the return value will be %GTK_IMAGE_EMPTY. a #GtkStatusIcon + line="2834">a #GtkStatusIcon @@ -100988,7 +100988,7 @@ the return value will be %GTK_IMAGE_EMPTY. version="2.10"> Returns whether the status icon is visible or not. + line="2394">Returns whether the status icon is visible or not. Note that being visible does not guarantee that the user can actually see the icon, see also gtk_status_icon_is_embedded(). @@ -100996,14 +100996,14 @@ gtk_status_icon_is_embedded(). %TRUE if the status icon is visible + line="2403">%TRUE if the status icon is visible a #GtkStatusIcon + line="2396">a #GtkStatusIcon @@ -101013,7 +101013,7 @@ gtk_status_icon_is_embedded(). version="2.14"> This function is only useful on the X11/freedesktop.org platform. + line="2950">This function is only useful on the X11/freedesktop.org platform. It returns a window ID for the widget in the underlying status icon implementation. This is useful for the Galago notification service, which can send a window ID in the protocol @@ -101027,7 +101027,7 @@ as gtk_status_icon_position_menu(). An 32 bit unsigned integer identifier for the + line="2965">An 32 bit unsigned integer identifier for the underlying X11 Window @@ -101035,7 +101035,7 @@ underlying X11 Window a #GtkStatusIcon + line="2952">a #GtkStatusIcon @@ -101045,13 +101045,13 @@ underlying X11 Window version="2.10"> Returns whether the status icon is embedded in a notification + line="2475">Returns whether the status icon is embedded in a notification area. %TRUE if the status icon is embedded in + line="2482">%TRUE if the status icon is embedded in a notification area. @@ -101059,7 +101059,7 @@ area. a #GtkStatusIcon + line="2477">a #GtkStatusIcon @@ -101072,7 +101072,7 @@ area. deprecated-version="2.22"> Makes the status icon start or stop blinking. + line="2415">Makes the status icon start or stop blinking. Note that blinking user interface elements may be problematic for some users, and thus may be turned off, in which case this setting has no effect. @@ -101085,13 +101085,13 @@ this setting has no effect. a #GtkStatusIcon + line="2417">a #GtkStatusIcon %TRUE to turn blinking on, %FALSE to turn it off + line="2418">%TRUE to turn blinking on, %FALSE to turn it off @@ -101101,7 +101101,7 @@ this setting has no effect. version="2.10"> Makes @status_icon display the file @filename. + line="1967">Makes @status_icon display the file @filename. See gtk_status_icon_new_from_file() for details. @@ -101111,13 +101111,13 @@ See gtk_status_icon_new_from_file() for details. a #GtkStatusIcon + line="1969">a #GtkStatusIcon a filename + line="1970">a filename @@ -101127,7 +101127,7 @@ See gtk_status_icon_new_from_file() for details. version="2.14"> Makes @status_icon display the #GIcon. + line="2037">Makes @status_icon display the #GIcon. See gtk_status_icon_new_from_gicon() for details. @@ -101137,13 +101137,13 @@ See gtk_status_icon_new_from_gicon() for details. a #GtkStatusIcon + line="2039">a #GtkStatusIcon a GIcon + line="2040">a GIcon @@ -101153,7 +101153,7 @@ See gtk_status_icon_new_from_gicon() for details. version="2.10"> Makes @status_icon display the icon named @icon_name from the + line="2015">Makes @status_icon display the icon named @icon_name from the current icon theme. See gtk_status_icon_new_from_icon_name() for details. @@ -101164,13 +101164,13 @@ See gtk_status_icon_new_from_icon_name() for details. a #GtkStatusIcon + line="2017">a #GtkStatusIcon an icon name + line="2018">an icon name @@ -101180,7 +101180,7 @@ See gtk_status_icon_new_from_icon_name() for details. version="2.10"> Makes @status_icon display @pixbuf. + line="1943">Makes @status_icon display @pixbuf. See gtk_status_icon_new_from_pixbuf() for details. @@ -101190,7 +101190,7 @@ See gtk_status_icon_new_from_pixbuf() for details. a #GtkStatusIcon + line="1945">a #GtkStatusIcon allow-none="1"> a #GdkPixbuf or %NULL + line="1946">a #GdkPixbuf or %NULL @@ -101209,7 +101209,7 @@ See gtk_status_icon_new_from_pixbuf() for details. version="2.10"> Makes @status_icon display the stock icon with the id @stock_id. + line="1994">Makes @status_icon display the stock icon with the id @stock_id. See gtk_status_icon_new_from_stock() for details. @@ -101219,13 +101219,13 @@ See gtk_status_icon_new_from_stock() for details. a #GtkStatusIcon + line="1996">a #GtkStatusIcon a stock icon id + line="1997">a stock icon id @@ -101236,7 +101236,7 @@ See gtk_status_icon_new_from_stock() for details. version="2.16"> Sets the has-tooltip property on @status_icon to @has_tooltip. + line="2705">Sets the has-tooltip property on @status_icon to @has_tooltip. See #GtkStatusIcon:has-tooltip for more information. @@ -101246,13 +101246,13 @@ See #GtkStatusIcon:has-tooltip for more information. a #GtkStatusIcon + line="2707">a #GtkStatusIcon whether or not @status_icon has a tooltip + line="2708">whether or not @status_icon has a tooltip @@ -101262,7 +101262,7 @@ See #GtkStatusIcon:has-tooltip for more information. version="2.20"> Sets the name of this tray icon. + line="3049">Sets the name of this tray icon. This should be a string identifying this icon. It is may be used for sorting the icons in the tray and will not be shown to the user. @@ -101274,13 +101274,13 @@ the user. a #GtkStatusIcon + line="3051">a #GtkStatusIcon the name + line="3052">the name @@ -101291,7 +101291,7 @@ the user. version="2.12"> Sets the #GdkScreen where @status_icon is displayed; if + line="2237">Sets the #GdkScreen where @status_icon is displayed; if the icon is already mapped, it will be unmapped, and then remapped on the new screen. @@ -101302,13 +101302,13 @@ then remapped on the new screen. a #GtkStatusIcon + line="2239">a #GtkStatusIcon a #GdkScreen + line="2240">a #GdkScreen @@ -101319,7 +101319,7 @@ then remapped on the new screen. version="2.18"> Sets the title of this tray icon. + line="2981">Sets the title of this tray icon. This should be a short, human-readable, localized string describing the tray icon. It may be used by tools like screen readers to render the tray icon. @@ -101331,13 +101331,13 @@ readers to render the tray icon. a #GtkStatusIcon + line="2983">a #GtkStatusIcon the title + line="2984">the title @@ -101349,7 +101349,7 @@ readers to render the tray icon. deprecated-version="2.16"> Sets the tooltip of the status icon. + line="2281">Sets the tooltip of the status icon. Use gtk_status_icon_set_tooltip_text() instead. @@ -101359,7 +101359,7 @@ readers to render the tray icon. a #GtkStatusIcon + line="2283">a #GtkStatusIcon allow-none="1"> the tooltip text, or %NULL + line="2284">the tooltip text, or %NULL @@ -101379,7 +101379,7 @@ readers to render the tray icon. version="2.16"> Sets @markup as the contents of the tooltip, which is marked up with + line="2868">Sets @markup as the contents of the tooltip, which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>. This function will take care of setting #GtkStatusIcon:has-tooltip to %TRUE @@ -101395,7 +101395,7 @@ gtk_tooltip_set_markup(). a #GtkStatusIcon + line="2870">a #GtkStatusIcon allow-none="1"> the contents of the tooltip for @status_icon, or %NULL + line="2871">the contents of the tooltip for @status_icon, or %NULL @@ -101415,7 +101415,7 @@ gtk_tooltip_set_markup(). version="2.16"> Sets @text as the contents of the tooltip. + line="2772">Sets @text as the contents of the tooltip. This function will take care of setting #GtkStatusIcon:has-tooltip to %TRUE and of the default handler for the #GtkStatusIcon::query-tooltip @@ -101431,13 +101431,13 @@ gtk_tooltip_set_text(). a #GtkStatusIcon + line="2774">a #GtkStatusIcon the contents of the tooltip for @status_icon + line="2775">the contents of the tooltip for @status_icon @@ -101448,7 +101448,7 @@ gtk_tooltip_set_text(). version="2.10"> Shows or hides a status icon. + line="2342">Shows or hides a status icon. @@ -101457,13 +101457,13 @@ gtk_tooltip_set_text(). a #GtkStatusIcon + line="2344">a #GtkStatusIcon %TRUE to show the status icon, %FALSE to hide it + line="2345">%TRUE to show the status icon, %FALSE to hide it @@ -101478,7 +101478,7 @@ gtk_tooltip_set_text(). default-value="FALSE"> Whether or not the status icon is blinking. + line="287">Whether or not the status icon is blinking. This property will be removed in GTK+ 3 @@ -101488,7 +101488,7 @@ gtk_tooltip_set_text(). default-value="FALSE"> %TRUE if the statusicon is embedded in a notification area. + line="311">%TRUE if the statusicon is embedded in a notification area. getter="get_gicon"> The #GIcon displayed in the #GtkStatusIcon. For themed icons, + line="244">The #GIcon displayed in the #GtkStatusIcon. For themed icons, the image will be updated automatically if the theme changes. @@ -101518,7 +101518,7 @@ the image will be updated automatically if the theme changes. default-value="FALSE"> Enables or disables the emission of #GtkStatusIcon::query-tooltip on + line="343">Enables or disables the emission of #GtkStatusIcon::query-tooltip on @status_icon. A value of %TRUE indicates that @status_icon can have a tooltip, in this case the status icon will be queried using #GtkStatusIcon::query-tooltip to determine whether it will provide a @@ -101546,7 +101546,7 @@ For plain text tooltips, use #GtkStatusIcon:tooltip-text in preference. default-value="GTK_ORIENTATION_HORIZONTAL"> The orientation of the tray in which the statusicon + line="326">The orientation of the tray in which the statusicon is embedded. @@ -101591,7 +101591,7 @@ is embedded. default-value="NULL"> The title of this tray icon. This should be a short, human-readable, + line="421">The title of this tray icon. This should be a short, human-readable, localized string describing the tray icon. It may be used by tools like screen readers to render the tray icon. @@ -101605,7 +101605,7 @@ like screen readers to render the tray icon. default-value="NULL"> Sets the text of tooltip to be the given string, which is marked up + line="395">Sets the text of tooltip to be the given string, which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>. Also see gtk_tooltip_set_markup(). @@ -101627,7 +101627,7 @@ On some platforms, embedded markup will be ignored. default-value="NULL"> Sets the text of tooltip to be the given string. + line="369">Sets the text of tooltip to be the given string. Also see gtk_tooltip_set_text(). @@ -101659,7 +101659,7 @@ that they allow on status icons, e.g. Windows only shows the first Gets emitted when the user activates the status icon. + line="438">Gets emitted when the user activates the status icon. If and how status icons can activated is platform-dependent. Unlike most G_SIGNAL_ACTION signals, this signal is meant to @@ -101671,7 +101671,7 @@ be used by applications and should be wrapped by language bindings. The ::button-press-event signal will be emitted when a button + line="519">The ::button-press-event signal will be emitted when a button (typically from a mouse) is pressed. Whether this event is emitted is platform-dependent. Use the ::activate @@ -101679,7 +101679,7 @@ and ::popup-menu signals in preference. %TRUE to stop other handlers from being invoked + line="530">%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. @@ -101687,7 +101687,7 @@ for the event. %FALSE to propagate the event further. the #GdkEventButton which triggered this signal + line="522">the #GdkEventButton which triggered this signal @@ -101695,7 +101695,7 @@ for the event. %FALSE to propagate the event further. The ::button-release-event signal will be emitted when a button + line="545">The ::button-release-event signal will be emitted when a button (typically from a mouse) is released. Whether this event is emitted is platform-dependent. Use the ::activate @@ -101703,7 +101703,7 @@ and ::popup-menu signals in preference. %TRUE to stop other handlers from being invoked + line="556">%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. @@ -101711,7 +101711,7 @@ for the event. %FALSE to propagate the event further. the #GdkEventButton which triggered this signal + line="548">the #GdkEventButton which triggered this signal @@ -101719,7 +101719,7 @@ for the event. %FALSE to propagate the event further. Gets emitted when the user brings up the context menu + line="461">Gets emitted when the user brings up the context menu of the status icon. Whether status icons can have context menus and how these are activated is platform-dependent. @@ -101735,14 +101735,14 @@ be used by applications and should be wrapped by language bindings. the button that was pressed, or 0 if the + line="464">the button that was pressed, or 0 if the signal is not emitted in response to a button press event the timestamp of the event that + line="466">the timestamp of the event that triggered the signal emission @@ -101751,7 +101751,7 @@ be used by applications and should be wrapped by language bindings. Emitted when the #GtkSettings:gtk-tooltip-timeout has expired with the + line="595">Emitted when the #GtkSettings:gtk-tooltip-timeout has expired with the cursor hovering above @status_icon; or emitted when @status_icon got focus in keyboard mode. @@ -101769,34 +101769,34 @@ For plain text tooltips, use #GtkStatusIcon:tooltip-text in preference. %TRUE if @tooltip should be shown right now, %FALSE otherwise. + line="621">%TRUE if @tooltip should be shown right now, %FALSE otherwise. the x coordinate of the cursor position where the request has been + line="598">the x coordinate of the cursor position where the request has been emitted, relative to @status_icon the y coordinate of the cursor position where the request has been + line="600">the y coordinate of the cursor position where the request has been emitted, relative to @status_icon %TRUE if the tooltip was trigged using the keyboard + line="602">%TRUE if the tooltip was trigged using the keyboard a #GtkTooltip + line="603">a #GtkTooltip @@ -101804,7 +101804,7 @@ For plain text tooltips, use #GtkStatusIcon:tooltip-text in preference. The ::scroll-event signal is emitted when a button in the 4 to 7 + line="571">The ::scroll-event signal is emitted when a button in the 4 to 7 range is pressed. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned. @@ -101812,7 +101812,7 @@ Whether this event is emitted is platform-dependent. %TRUE to stop other handlers from being invoked for the event. + line="582">%TRUE to stop other handlers from being invoked for the event. %FALSE to propagate the event further. @@ -101820,7 +101820,7 @@ Whether this event is emitted is platform-dependent. the #GdkEventScroll which triggered this signal + line="574">the #GdkEventScroll which triggered this signal @@ -101828,12 +101828,12 @@ Whether this event is emitted is platform-dependent. Gets emitted when the size available for the image + line="494">Gets emitted when the size available for the image changes, e.g. because the notification area got resized. %TRUE if the icon was updated for the new + line="502">%TRUE if the icon was updated for the new size. Otherwise, GTK+ will scale the icon as necessary. @@ -101841,7 +101841,7 @@ size. Otherwise, GTK+ will scale the icon as necessary. the new size + line="497">the new size @@ -124983,12 +124983,12 @@ gtk_tool_item_rebuild_menu() instead. Creates a new toolbar. + line="2755">Creates a new toolbar. the newly-created toolbar. + line="2760">the newly-created toolbar. @@ -125047,7 +125047,7 @@ gtk_tool_item_rebuild_menu() instead. deprecated-version="2.4"> Adds a new element to the end of a toolbar. + line="3634">Adds a new element to the end of a toolbar. If @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element. If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine @@ -125061,20 +125061,20 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. the new toolbar element as a #GtkWidget. + line="3656">the new toolbar element as a #GtkWidget. a #GtkToolbar. + line="3636">a #GtkToolbar. a value of type #GtkToolbarChildType that determines what @widget will be. + line="3637">a value of type #GtkToolbarChildType that determines what @widget will be. allow-none="1"> a #GtkWidget, or %NULL. + line="3638">a #GtkWidget, or %NULL. the element's label. + line="3639">the element's label. the element's tooltip. + line="3640">the element's tooltip. used for context-sensitive help about this toolbar element. + line="3641">used for context-sensitive help about this toolbar element. a #GtkWidget that provides pictorial representation of the element's function. + line="3642">a #GtkWidget that provides pictorial representation of the element's function. the function to be executed when the button is pressed. + line="3643">the function to be executed when the button is pressed. allow-none="1"> any data you wish to pass to the callback. + line="3644">any data you wish to pass to the callback. @@ -125134,7 +125134,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Inserts a new item into the toolbar. You must specify the position + line="3316">Inserts a new item into the toolbar. You must specify the position in the toolbar where it will be inserted. @callback must be a pointer to a function taking a #GtkWidget and a gpointer as @@ -125144,44 +125144,44 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. the new toolbar item as a #GtkWidget. + line="3332">the new toolbar item as a #GtkWidget. a #GtkToolbar. + line="3318">a #GtkToolbar. give your toolbar button a label. + line="3319">give your toolbar button a label. a string that appears when the user holds the mouse over this item. + line="3320">a string that appears when the user holds the mouse over this item. use with #GtkTipsQuery. + line="3321">use with #GtkTipsQuery. a #GtkWidget that should be used as the button's icon. + line="3322">a #GtkWidget that should be used as the button's icon. the function to be executed when the button is pressed. + line="3323">the function to be executed when the button is pressed. allow-none="1"> a pointer to any data you wish to be passed to the callback. + line="3324">a pointer to any data you wish to be passed to the callback. @@ -125201,7 +125201,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Adds a new space to the end of the toolbar. + line="3463">Adds a new space to the end of the toolbar. Use gtk_toolbar_insert() instead. @@ -125211,7 +125211,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. a #GtkToolbar. + line="3465">a #GtkToolbar. @@ -125222,7 +125222,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Adds a widget to the end of the given toolbar. + line="3560">Adds a widget to the end of the given toolbar. Use gtk_toolbar_insert() instead. @@ -125232,13 +125232,13 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. a #GtkToolbar. + line="3562">a #GtkToolbar. a #GtkWidget to add to the toolbar. + line="3563">a #GtkWidget to add to the toolbar. allow-none="1"> the element's tooltip. + line="3564">the element's tooltip. allow-none="1"> used for context-sensitive help about this toolbar element. + line="3565">used for context-sensitive help about this toolbar element. @@ -125266,7 +125266,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. version="2.4"> Returns the position corresponding to the indicated point on + line="3159">Returns the position corresponding to the indicated point on @toolbar. This is useful when dragging items to the toolbar: this function returns the position a new item should be inserted. @@ -125276,26 +125276,26 @@ inserted. The position corresponding to the point (@x, @y) on the toolbar. + line="3172">The position corresponding to the point (@x, @y) on the toolbar. a #GtkToolbar + line="3161">a #GtkToolbar x coordinate of a point on the toolbar + line="3162">x coordinate of a point on the toolbar y coordinate of a point on the toolbar + line="3163">y coordinate of a point on the toolbar @@ -125305,12 +125305,12 @@ inserted. glib:get-property="icon-size"> Retrieves the icon size for the toolbar. See gtk_toolbar_set_icon_size(). + line="3060">Retrieves the icon size for the toolbar. See gtk_toolbar_set_icon_size(). the current icon size for the icons on + line="3066">the current icon size for the icons on the toolbar. @@ -125318,7 +125318,7 @@ the toolbar. a #GtkToolbar + line="3062">a #GtkToolbar @@ -125328,26 +125328,26 @@ the toolbar. version="2.4"> Returns the position of @item on the toolbar, starting from 0. + line="2801">Returns the position of @item on the toolbar, starting from 0. It is an error if @item is not a child of the toolbar. the position of item on the toolbar. + line="2809">the position of item on the toolbar. a #GtkToolbar + line="2803">a #GtkToolbar a #GtkToolItem that is a child of @toolbar + line="2804">a #GtkToolItem that is a child of @toolbar @@ -125357,19 +125357,19 @@ It is an error if @item is not a child of the toolbar. version="2.4"> Returns the number of items on the toolbar. + line="2994">Returns the number of items on the toolbar. the number of items on the toolbar + line="3000">the number of items on the toolbar a #GtkToolbar + line="2996">a #GtkToolbar @@ -125379,13 +125379,13 @@ It is an error if @item is not a child of the toolbar. version="2.4"> Returns the @n<!-- -->'th item on @toolbar, or %NULL if the + line="3019">Returns the @n<!-- -->'th item on @toolbar, or %NULL if the toolbar does not contain an @n<!-- -->'th item. The @n<!-- -->'th #GtkToolItem on @toolbar, + line="3027">The @n<!-- -->'th #GtkToolItem on @toolbar, or %NULL if there isn't an @n<!-- -->'th item. @@ -125393,13 +125393,13 @@ toolbar does not contain an @n<!-- -->'th item. a #GtkToolbar + line="3021">a #GtkToolbar A position on the toolbar + line="3022">A position on the toolbar @@ -125410,21 +125410,21 @@ toolbar does not contain an @n<!-- -->'th item. deprecated-version="2.16"> Retrieves the current orientation of the toolbar. See + line="2865">Retrieves the current orientation of the toolbar. See gtk_toolbar_set_orientation(). Use gtk_orientable_get_orientation() instead. the orientation + line="2872">the orientation a #GtkToolbar + line="2867">a #GtkToolbar @@ -125434,20 +125434,20 @@ gtk_toolbar_set_orientation(). version="2.4"> Returns the relief style of buttons on @toolbar. See + line="3077">Returns the relief style of buttons on @toolbar. See gtk_button_set_relief(). The relief style of buttons on @toolbar. + line="3084">The relief style of buttons on @toolbar. a #GtkToolbar + line="3079">a #GtkToolbar @@ -125458,20 +125458,20 @@ gtk_button_set_relief(). version="2.4"> Returns whether the toolbar has an overflow menu. + line="3133">Returns whether the toolbar has an overflow menu. See gtk_toolbar_set_show_arrow(). %TRUE if the toolbar has an overflow menu. + line="3140">%TRUE if the toolbar has an overflow menu. a #GtkToolbar + line="3135">a #GtkToolbar @@ -125479,20 +125479,20 @@ See gtk_toolbar_set_show_arrow(). Retrieves whether the toolbar has text, icons, or both . See + line="2901">Retrieves whether the toolbar has text, icons, or both . See gtk_toolbar_set_style(). the current style of @toolbar + line="2908">the current style of @toolbar a #GtkToolbar + line="2903">a #GtkToolbar @@ -125504,7 +125504,7 @@ gtk_toolbar_set_style(). deprecated-version="2.14"> Retrieves whether tooltips are enabled. See + line="2974">Retrieves whether tooltips are enabled. See gtk_toolbar_set_tooltips(). The toolkit-wide #GtkSettings:gtk-enable-tooltips property is now used instead. @@ -125512,14 +125512,14 @@ is now used instead. %TRUE if tooltips are enabled + line="2981">%TRUE if tooltips are enabled a #GtkToolbar + line="2976">a #GtkToolbar @@ -125527,7 +125527,7 @@ is now used instead. Insert a #GtkToolItem into the toolbar at position @pos. If @pos is + line="2772">Insert a #GtkToolItem into the toolbar at position @pos. If @pos is 0 the item is prepended to the start of the toolbar. If @pos is negative, the item is appended to the end of the toolbar. @@ -125538,19 +125538,19 @@ negative, the item is appended to the end of the toolbar. a #GtkToolbar + line="2774">a #GtkToolbar a #GtkToolItem + line="2775">a #GtkToolItem the position of the new item + line="2776">the position of the new item @@ -125562,7 +125562,7 @@ negative, the item is appended to the end of the toolbar. deprecated-version="2.4"> Inserts a new element in the toolbar at the given position. + line="3719">Inserts a new element in the toolbar at the given position. If @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element. If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine @@ -125576,20 +125576,20 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. the new toolbar element as a #GtkWidget. + line="3743">the new toolbar element as a #GtkWidget. a #GtkToolbar. + line="3721">a #GtkToolbar. a value of type #GtkToolbarChildType that determines what @widget + line="3722">a value of type #GtkToolbarChildType that determines what @widget will be. @@ -125599,37 +125599,37 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. allow-none="1"> a #GtkWidget, or %NULL. + line="3724">a #GtkWidget, or %NULL. the element's label. + line="3725">the element's label. the element's tooltip. + line="3726">the element's tooltip. used for context-sensitive help about this toolbar element. + line="3727">used for context-sensitive help about this toolbar element. a #GtkWidget that provides pictorial representation of the element's function. + line="3728">a #GtkWidget that provides pictorial representation of the element's function. the function to be executed when the button is pressed. + line="3729">the function to be executed when the button is pressed. allow-none="1"> any data you wish to pass to the callback. + line="3730">any data you wish to pass to the callback. the number of widgets to insert this element after. + line="3731">the number of widgets to insert this element after. @@ -125656,7 +125656,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Inserts a new item into the toolbar. You must specify the position in the + line="3387">Inserts a new item into the toolbar. You must specify the position in the toolbar where it will be inserted. @callback must be a pointer to a function taking a #GtkWidget and a gpointer as @@ -125666,44 +125666,44 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. the new toolbar item as a #GtkWidget. + line="3404">the new toolbar item as a #GtkWidget. a #GtkToolbar. + line="3389">a #GtkToolbar. give your toolbar button a label. + line="3390">give your toolbar button a label. a string that appears when the user holds the mouse over this item. + line="3391">a string that appears when the user holds the mouse over this item. use with #GtkTipsQuery. + line="3392">use with #GtkTipsQuery. a #GtkWidget that should be used as the button's icon. + line="3393">a #GtkWidget that should be used as the button's icon. the function to be executed when the button is pressed. + line="3394">the function to be executed when the button is pressed. allow-none="1"> a pointer to any data you wish to be passed to the callback. + line="3395">a pointer to any data you wish to be passed to the callback. the number of widgets to insert this item after. + line="3396">the number of widgets to insert this item after. @@ -125729,7 +125729,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Inserts a new space in the toolbar at the specified position. + line="3499">Inserts a new space in the toolbar at the specified position. Use gtk_toolbar_insert() instead. @@ -125739,13 +125739,13 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. a #GtkToolbar + line="3501">a #GtkToolbar the number of widgets after which a space should be inserted. + line="3502">the number of widgets after which a space should be inserted. @@ -125757,7 +125757,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Inserts a stock item at the specified position of the toolbar. If + line="3425">Inserts a stock item at the specified position of the toolbar. If @stock_id is not a known stock item ID, it's inserted verbatim, except that underscores used to mark mnemonics are removed. @@ -125768,38 +125768,38 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. the inserted widget + line="3443">the inserted widget A #GtkToolbar + line="3427">A #GtkToolbar The id of the stock item you want to insert + line="3428">The id of the stock item you want to insert The text in the tooltip of the toolbar button + line="3429">The text in the tooltip of the toolbar button The private text of the tooltip + line="3430">The private text of the tooltip The callback called when the toolbar button is clicked. + line="3431">The callback called when the toolbar button is clicked. allow-none="1"> user data passed to callback + line="3432">user data passed to callback The position the button shall be inserted at. + line="3433">The position the button shall be inserted at. -1 means at the end. @@ -125826,7 +125826,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Inserts a widget in the toolbar at the given position. + line="3608">Inserts a widget in the toolbar at the given position. Use gtk_toolbar_insert() instead. @@ -125836,13 +125836,13 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. a #GtkToolbar. + line="3610">a #GtkToolbar. a #GtkWidget to add to the toolbar. + line="3611">a #GtkWidget to add to the toolbar. allow-none="1"> the element's tooltip. + line="3612">the element's tooltip. allow-none="1"> used for context-sensitive help about this toolbar element. + line="3613">used for context-sensitive help about this toolbar element. the number of widgets to insert this widget after. + line="3614">the number of widgets to insert this widget after. @@ -125878,7 +125878,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Adds a new element to the beginning of a toolbar. + line="3677">Adds a new element to the beginning of a toolbar. If @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element. If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine @@ -125892,20 +125892,20 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. the new toolbar element as a #GtkWidget. + line="3699">the new toolbar element as a #GtkWidget. a #GtkToolbar. + line="3679">a #GtkToolbar. a value of type #GtkToolbarChildType that determines what @widget will be. + line="3680">a value of type #GtkToolbarChildType that determines what @widget will be. allow-none="1"> a #GtkWidget, or %NULL + line="3681">a #GtkWidget, or %NULL the element's label. + line="3682">the element's label. the element's tooltip. + line="3683">the element's tooltip. used for context-sensitive help about this toolbar element. + line="3684">used for context-sensitive help about this toolbar element. a #GtkWidget that provides pictorial representation of the element's function. + line="3685">a #GtkWidget that provides pictorial representation of the element's function. the function to be executed when the button is pressed. + line="3686">the function to be executed when the button is pressed. allow-none="1"> any data you wish to pass to the callback. + line="3687">any data you wish to pass to the callback. @@ -125965,7 +125965,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Adds a new button to the beginning (top or left edges) of the given toolbar. + line="3352">Adds a new button to the beginning (top or left edges) of the given toolbar. @callback must be a pointer to a function taking a #GtkWidget and a gpointer as arguments. Use G_CALLBACK() to cast the function to #GCallback. @@ -125974,44 +125974,44 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. the new toolbar item as a #GtkWidget. + line="3367">the new toolbar item as a #GtkWidget. a #GtkToolbar. + line="3354">a #GtkToolbar. give your toolbar button a label. + line="3355">give your toolbar button a label. a string that appears when the user holds the mouse over this item. + line="3356">a string that appears when the user holds the mouse over this item. use with #GtkTipsQuery. + line="3357">use with #GtkTipsQuery. a #GtkWidget that should be used as the button's icon. + line="3358">a #GtkWidget that should be used as the button's icon. the function to be executed when the button is pressed. + line="3359">the function to be executed when the button is pressed. allow-none="1"> a pointer to any data you wish to be passed to the callback. + line="3360">a pointer to any data you wish to be passed to the callback. @@ -126031,7 +126031,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Adds a new space to the beginning of the toolbar. + line="3481">Adds a new space to the beginning of the toolbar. Use gtk_toolbar_insert() instead. @@ -126041,7 +126041,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. a #GtkToolbar. + line="3483">a #GtkToolbar. @@ -126052,7 +126052,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Adds a widget to the beginning of the given toolbar. + line="3584">Adds a widget to the beginning of the given toolbar. Use gtk_toolbar_insert() instead. @@ -126062,13 +126062,13 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. a #GtkToolbar. + line="3586">a #GtkToolbar. a #GtkWidget to add to the toolbar. + line="3587">a #GtkWidget to add to the toolbar. allow-none="1"> the element's tooltip. + line="3588">the element's tooltip. allow-none="1"> used for context-sensitive help about this toolbar element. + line="3589">used for context-sensitive help about this toolbar element. @@ -126097,7 +126097,7 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. deprecated-version="2.4"> Removes a space from the specified position. + line="3519">Removes a space from the specified position. Use gtk_toolbar_insert() instead. @@ -126107,13 +126107,13 @@ arguments. Use G_CALLBACK() to cast the function to #GCallback. a #GtkToolbar. + line="3521">a #GtkToolbar. the index of the space to remove. + line="3522">the index of the space to remove. @@ -126165,7 +126165,7 @@ toolbar. glib:set-property="icon-size"> This function sets the size of stock icons in the toolbar. You + line="3235">This function sets the size of stock icons in the toolbar. You can call it both before you add the icons and after they've been added. The size you set will override user preferences for the default icon size. @@ -126181,13 +126181,13 @@ size of icons. A #GtkToolbar + line="3237">A #GtkToolbar The #GtkIconSize that stock icons in the + line="3238">The #GtkIconSize that stock icons in the toolbar shall have. @@ -126199,7 +126199,7 @@ size of icons. deprecated-version="2.16"> Sets whether a toolbar should appear horizontally or vertically. + line="2847">Sets whether a toolbar should appear horizontally or vertically. Use gtk_orientable_set_orientation() instead. @@ -126209,13 +126209,13 @@ size of icons. a #GtkToolbar. + line="2849">a #GtkToolbar. a new #GtkOrientation. + line="2850">a new #GtkOrientation. @@ -126226,7 +126226,7 @@ size of icons. version="2.4"> Sets whether to show an overflow menu when @toolbar isn’t allocated enough + line="3096">Sets whether to show an overflow menu when @toolbar isn’t allocated enough size to show all of its items. If %TRUE, items which can’t fit in @toolbar, and which have a proxy menu item set by gtk_tool_item_set_proxy_menu_item() or #GtkToolItem::create-menu-proxy, will be available in an overflow menu, @@ -126240,13 +126240,13 @@ request enough size to fit all of its child items without any overflow. a #GtkToolbar + line="3098">a #GtkToolbar Whether to show an overflow menu + line="3099">Whether to show an overflow menu @@ -126254,7 +126254,7 @@ request enough size to fit all of its child items without any overflow. Alters the view of @toolbar to display either icons only, text only, or both. + line="2884">Alters the view of @toolbar to display either icons only, text only, or both. @@ -126263,13 +126263,13 @@ request enough size to fit all of its child items without any overflow. a #GtkToolbar. + line="2886">a #GtkToolbar. the new style for @toolbar. + line="2887">the new style for @toolbar. @@ -126281,7 +126281,7 @@ request enough size to fit all of its child items without any overflow. deprecated-version="2.14"> Sets if the tooltips of a toolbar should be active or not. + line="2950">Sets if the tooltips of a toolbar should be active or not. The toolkit-wide #GtkSettings:gtk-enable-tooltips property is now used instead. @@ -126292,13 +126292,13 @@ is now used instead. a #GtkToolbar. + line="2952">a #GtkToolbar. set to %FALSE to disable the tooltips, or %TRUE to enable them. + line="2953">set to %FALSE to disable the tooltips, or %TRUE to enable them. @@ -126307,7 +126307,7 @@ is now used instead. c:identifier="gtk_toolbar_unset_icon_size"> Unsets toolbar icon size set with gtk_toolbar_set_icon_size(), so that + line="3274">Unsets toolbar icon size set with gtk_toolbar_set_icon_size(), so that user preferences will be used to determine the icon size. @@ -126317,7 +126317,7 @@ user preferences will be used to determine the icon size. a #GtkToolbar + line="3276">a #GtkToolbar @@ -126325,7 +126325,7 @@ user preferences will be used to determine the icon size. Unsets a toolbar style set with gtk_toolbar_set_style(), so that + line="2918">Unsets a toolbar style set with gtk_toolbar_set_style(), so that user preferences will be used to determine the toolbar style. @@ -126335,7 +126335,7 @@ user preferences will be used to determine the toolbar style. a #GtkToolbar + line="2920">a #GtkToolbar @@ -143617,7 +143617,7 @@ internal child "accessible" of a <structname>GtkWidget</structname>. This is a convenience function for creating a widget and setting + line="3011">This is a convenience function for creating a widget and setting its properties in one go. For example you might write: <literal>gtk_widget_new (GTK_TYPE_LABEL, "label", "Hello World", "xalign", 0.0, NULL)</literal> to create a left-aligned label. Equivalent to @@ -143627,26 +143627,26 @@ cast the object yourself. a new #GtkWidget of type @widget_type + line="3025">a new #GtkWidget of type @widget_type type ID of the widget to create + line="3013">type ID of the widget to create name of first property to set + line="3014">name of first property to set value of first property, followed by more properties, + line="3015">value of first property, followed by more properties, %NULL-terminated @@ -143656,12 +143656,12 @@ cast the object yourself. c:identifier="gtk_widget_get_default_colormap"> Obtains the default colormap used to create widgets. + line="8619">Obtains the default colormap used to create widgets. default widget colormap + line="8624">default widget colormap @@ -143669,13 +143669,13 @@ cast the object yourself. c:identifier="gtk_widget_get_default_direction"> Obtains the current default reading direction. See + line="8772">Obtains the current default reading direction. See gtk_widget_set_default_direction(). the current default direction. + line="8778">the current default direction. @@ -143683,12 +143683,12 @@ gtk_widget_set_default_direction(). c:identifier="gtk_widget_get_default_style"> Returns the default style used by all widgets initially. + line="7238">Returns the default style used by all widgets initially. the default style. This #GtkStyle object is owned + line="7243">the default style. This #GtkStyle object is owned by GTK+ and should not be modified or freed. @@ -143697,20 +143697,20 @@ gtk_widget_set_default_direction(). c:identifier="gtk_widget_get_default_visual"> Obtains the visual of the default colormap. Not really useful; + line="8632">Obtains the visual of the default colormap. Not really useful; used to be useful before gdk_colormap_get_visual() existed. visual of the default colormap + line="8638">visual of the default colormap Removes a colormap pushed with gtk_widget_push_colormap(). + line="8590">Removes a colormap pushed with gtk_widget_push_colormap(). @@ -143720,7 +143720,7 @@ used to be useful before gdk_colormap_get_visual() existed. c:identifier="gtk_widget_pop_composite_child"> Cancels the effect of a previous call to gtk_widget_push_composite_child(). + line="8561">Cancels the effect of a previous call to gtk_widget_push_composite_child(). @@ -143729,7 +143729,7 @@ used to be useful before gdk_colormap_get_visual() existed. Pushes @cmap onto a global stack of colormaps; the topmost + line="8573">Pushes @cmap onto a global stack of colormaps; the topmost colormap on the stack will be used to create all widgets. Remove @cmap with gtk_widget_pop_colormap(). There's little reason to use this function. @@ -143741,7 +143741,7 @@ reason to use this function. a #GdkColormap + line="8575">a #GdkColormap @@ -143750,7 +143750,7 @@ reason to use this function. c:identifier="gtk_widget_push_composite_child"> Makes all newly-created widgets as composite children until + line="8532">Makes all newly-created widgets as composite children until the corresponding gtk_widget_pop_composite_child() call. A composite child is a child that's an implementation detail of the @@ -143778,7 +143778,7 @@ Here is a simple example: c:identifier="gtk_widget_set_default_colormap"> Sets the default colormap to use when creating widgets. + line="8602">Sets the default colormap to use when creating widgets. gtk_widget_push_colormap() is a better function to use if you only want to affect a few widgets, rather than all widgets. @@ -143789,7 +143789,7 @@ you only want to affect a few widgets, rather than all widgets. a #GdkColormap + line="8604">a #GdkColormap @@ -143798,7 +143798,7 @@ you only want to affect a few widgets, rather than all widgets. c:identifier="gtk_widget_set_default_direction"> Sets the default reading direction for widgets where the + line="8737">Sets the default reading direction for widgets where the direction has not been explicitly set by gtk_widget_set_direction(). @@ -143808,7 +143808,7 @@ direction has not been explicitly set by gtk_widget_set_direction(). the new default direction. This cannot be + line="8739">the new default direction. This cannot be %GTK_TEXT_DIR_NONE. @@ -143847,7 +143847,7 @@ direction has not been explicitly set by gtk_widget_set_direction(). version="2.4"> Determines whether an accelerator that activates the signal + line="4364">Determines whether an accelerator that activates the signal identified by @signal_id can currently be activated. This is done by emitting the #GtkWidget::can-activate-accel signal on @widget; if the signal isn't overridden by a @@ -143858,20 +143858,20 @@ its ancestors mapped. %TRUE if the accelerator can be activated. + line="4377">%TRUE if the accelerator can be activated. a #GtkWidget + line="4366">a #GtkWidget the ID of a signal installed on @widget + line="4367">the ID of a signal installed on @widget @@ -143879,7 +143879,7 @@ its ancestors mapped. Emits a #GtkWidget::child-notify signal for the + line="2939">Emits a #GtkWidget::child-notify signal for the <link linkend="child-properties">child property</link> @child_property on @widget. @@ -143892,7 +143892,7 @@ This is the analogue of g_object_notify() for child properties. a #GtkWidget + line="2941">a #GtkWidget @@ -144172,7 +144172,7 @@ This is the analogue of g_object_notify() for child properties. Rarely-used function. This function is used to emit + line="4782">Rarely-used function. This function is used to emit the event signals on a widget (those signals should never be emitted without using this function to do so). If you want to synthesize an event though, don't use this function; @@ -144184,7 +144184,7 @@ window. return from the event signal emission (%TRUE if + line="4796">return from the event signal emission (%TRUE if the event was handled) @@ -144192,13 +144192,13 @@ window. a #GtkWidget + line="4784">a #GtkWidget a #GdkEvent + line="4785">a #GdkEvent @@ -144262,7 +144262,7 @@ window. Returns the accessible object that describes the widget to an + line="10224">Returns the accessible object that describes the widget to an assistive technology. If no accessibility library is loaded (i.e. no ATK implementation library is @@ -144278,14 +144278,14 @@ library contains more information about accessible objects and their uses. the #AtkObject associated with @widget + line="10241">the #AtkObject associated with @widget a #GtkWidget + line="10226">a #GtkWidget @@ -144307,7 +144307,7 @@ library contains more information about accessible objects and their uses. Causes @widget to have the keyboard focus for the #GtkWindow it's + line="5316">Causes @widget to have the keyboard focus for the #GtkWindow it's inside. @widget must be a focusable widget, such as a #GtkEntry; something like #GtkFrame won't work. @@ -144325,7 +144325,7 @@ will likely fail and cause critical warnings. a #GtkWidget + line="5318">a #GtkWidget @@ -144347,7 +144347,7 @@ will likely fail and cause critical warnings. Reverses the effects of gtk_widget_show(), causing the widget to be + line="3307">Reverses the effects of gtk_widget_show(), causing the widget to be hidden (invisible to the user). @@ -144357,7 +144357,7 @@ hidden (invisible to the user). a #GtkWidget + line="3309">a #GtkWidget @@ -144368,7 +144368,7 @@ hidden (invisible to the user). deprecated-version="2.24"> Recursively hides a widget and any child widgets. + line="3394">Recursively hides a widget and any child widgets. Use gtk_widget_hide() instead. @@ -144378,7 +144378,7 @@ hidden (invisible to the user). a #GtkWidget + line="3396">a #GtkWidget @@ -144442,7 +144442,7 @@ hidden (invisible to the user). This function is only for use in widget implementations. Causes + line="3418">This function is only for use in widget implementations. Causes a widget to be mapped if it isn't already. @@ -144452,7 +144452,7 @@ a widget to be mapped if it isn't already. a #GtkWidget + line="3420">a #GtkWidget @@ -144474,7 +144474,7 @@ a widget to be mapped if it isn't already. Emits the #GtkWidget::mnemonic-activate signal. + line="4697">Emits the #GtkWidget::mnemonic-activate signal. The default handler for this signal activates the @widget if @group_cycling is %FALSE, and just grabs the focus if @group_cycling @@ -144483,20 +144483,20 @@ is %TRUE. %TRUE if the signal has been handled + line="4708">%TRUE if the signal has been handled a #GtkWidget + line="4699">a #GtkWidget %TRUE if there are other widgets with the same mnemonic + line="4700">%TRUE if there are other widgets with the same mnemonic @@ -144622,7 +144622,7 @@ is %TRUE. Creates the GDK (windowing system) resources associated with a + line="3510">Creates the GDK (windowing system) resources associated with a widget. For example, @widget->window will be created when a widget is realized. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be @@ -144648,7 +144648,7 @@ GtkWidget::realize signal. a #GtkWidget + line="3512">a #GtkWidget @@ -144763,7 +144763,7 @@ GtkWidget::realize signal. Flags a widget to be displayed. Any widget that isn't shown will + line="3217">Flags a widget to be displayed. Any widget that isn't shown will not appear on the screen. If you want to show all the widgets in a container, it's easier to call gtk_widget_show_all() on the container, instead of individually showing the widgets. @@ -144782,7 +144782,7 @@ toplevel container is realized and mapped. a #GtkWidget + line="3219">a #GtkWidget @@ -144790,7 +144790,7 @@ toplevel container is realized and mapped. Recursively shows a widget, and any child widgets (if the widget is + line="3371">Recursively shows a widget, and any child widgets (if the widget is a container). @@ -144800,7 +144800,7 @@ a container). a #GtkWidget + line="3373">a #GtkWidget @@ -144822,7 +144822,7 @@ a container). This function is only used by #GtkContainer subclasses, to assign a size + line="4045">This function is only used by #GtkContainer subclasses, to assign a size and position to their child widgets. @@ -144832,13 +144832,13 @@ and position to their child widgets. a #GtkWidget + line="4047">a #GtkWidget position and size to be allocated to @widget + line="4048">position and size to be allocated to @widget @@ -144846,7 +144846,7 @@ and position to their child widgets. This function is typically used when implementing a #GtkContainer + line="3908">This function is typically used when implementing a #GtkContainer subclass. Obtains the preferred size of a widget. The container uses this information to arrange its child widgets and decide what size allocations to give them with gtk_widget_size_allocate(). @@ -144868,13 +144868,13 @@ See also gtk_widget_get_child_requisition(). a #GtkWidget + line="3910">a #GtkWidget a #GtkRequisition to be filled in + line="3911">a #GtkRequisition to be filled in @@ -144910,7 +144910,7 @@ See also gtk_widget_get_child_requisition(). This function is only for use in widget implementations. Causes + line="3444">This function is only for use in widget implementations. Causes a widget to be unmapped if it's currently mapped. @@ -144920,7 +144920,7 @@ a widget to be unmapped if it's currently mapped. a #GtkWidget + line="3446">a #GtkWidget @@ -144942,7 +144942,7 @@ a widget to be unmapped if it's currently mapped. This function is only useful in widget implementations. + line="3589">This function is only useful in widget implementations. Causes a widget to be unrealized (frees all GDK resources associated with the widget, such as @widget->window). @@ -144953,7 +144953,7 @@ associated with the widget, such as @widget->window). a #GtkWidget + line="3591">a #GtkWidget @@ -144989,7 +144989,7 @@ associated with the widget, such as @widget->window). For widgets that can be "activated" (buttons, menu items, etc.) + line="5029">For widgets that can be "activated" (buttons, menu items, etc.) this function activates them. Activation is what happens when you press Enter on a widget during key navigation. If @widget isn't activatable, the function returns %FALSE. @@ -144997,14 +144997,14 @@ activatable, the function returns %FALSE. %TRUE if the widget was activatable + line="5038">%TRUE if the widget was activatable a #GtkWidget that's activatable + line="5031">a #GtkWidget that's activatable @@ -145012,7 +145012,7 @@ activatable, the function returns %FALSE. Installs an accelerator for this @widget in @accel_group that causes + line="4460">Installs an accelerator for this @widget in @accel_group that causes @accel_signal to be emitted if the accelerator is activated. The @accel_group needs to be added to the widget's toplevel via gtk_window_add_accel_group(), and the signal must be of type %G_RUN_ACTION. @@ -145028,37 +145028,37 @@ gtk_menu_item_set_accel_path() instead. widget to install an accelerator on + line="4462">widget to install an accelerator on widget signal to emit on accelerator activation + line="4463">widget signal to emit on accelerator activation accel group for this widget, added to its toplevel + line="4464">accel group for this widget, added to its toplevel GDK keyval of the accelerator + line="4465">GDK keyval of the accelerator modifier key combination of the accelerator + line="4466">modifier key combination of the accelerator flag accelerators, e.g. %GTK_ACCEL_VISIBLE + line="4467">flag accelerators, e.g. %GTK_ACCEL_VISIBLE @@ -145066,7 +145066,7 @@ gtk_menu_item_set_accel_path() instead. Adds the events in the bitfield @events to the event mask for + line="8147">Adds the events in the bitfield @events to the event mask for @widget. See gtk_widget_set_events() for details. @@ -145076,13 +145076,13 @@ gtk_menu_item_set_accel_path() instead. a #GtkWidget + line="8149">a #GtkWidget an event mask, see #GdkEventMask + line="8150">an event mask, see #GdkEventMask @@ -145092,7 +145092,7 @@ gtk_menu_item_set_accel_path() instead. version="2.4"> Adds a widget to the list of mnemonic labels for + line="10888">Adds a widget to the list of mnemonic labels for this widget. (See gtk_widget_list_mnemonic_labels()). Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update @@ -145106,13 +145106,13 @@ to the #GtkWidget::destroy signal or a weak notifier. a #GtkWidget + line="10890">a #GtkWidget a #GtkWidget that acts as a mnemonic label for @widget + line="10891">a #GtkWidget that acts as a mnemonic label for @widget @@ -145122,7 +145122,7 @@ to the #GtkWidget::destroy signal or a weak notifier. version="2.4"> Determines whether an accelerator that activates the signal + line="4364">Determines whether an accelerator that activates the signal identified by @signal_id can currently be activated. This is done by emitting the #GtkWidget::can-activate-accel signal on @widget; if the signal isn't overridden by a @@ -145133,20 +145133,20 @@ its ancestors mapped. %TRUE if the accelerator can be activated. + line="4377">%TRUE if the accelerator can be activated. a #GtkWidget + line="4366">a #GtkWidget the ID of a signal installed on @widget + line="4367">the ID of a signal installed on @widget @@ -145154,7 +145154,7 @@ its ancestors mapped. This function is used by custom widget implementations; if you're + line="7719">This function is used by custom widget implementations; if you're writing an app, you'd use gtk_widget_grab_focus() to move the focus to a particular widget, and gtk_container_set_focus_chain() to change the focus tab order. So you may want to investigate those @@ -145183,20 +145183,20 @@ currently in a focusable state, so there's no need for those checks. %TRUE if focus ended up inside @widget + line="7750">%TRUE if focus ended up inside @widget a #GtkWidget + line="7721">a #GtkWidget direction of focus movement + line="7722">direction of focus movement @@ -145204,7 +145204,7 @@ currently in a focusable state, so there's no need for those checks. Emits a #GtkWidget::child-notify signal for the + line="2939">Emits a #GtkWidget::child-notify signal for the <link linkend="child-properties">child property</link> @child_property on @widget. @@ -145217,13 +145217,13 @@ This is the analogue of g_object_notify() for child properties. a #GtkWidget + line="2941">a #GtkWidget the name of a child property installed on the + line="2942">the name of a child property installed on the class of @widget<!-- -->'s parent @@ -145232,7 +145232,7 @@ This is the analogue of g_object_notify() for child properties. Same as gtk_widget_path(), but always uses the name of a widget's type, + line="10120">Same as gtk_widget_path(), but always uses the name of a widget's type, never uses a custom name set with gtk_widget_set_name(). @@ -145242,7 +145242,7 @@ never uses a custom name set with gtk_widget_set_name(). a #GtkWidget + line="10122">a #GtkWidget allow-none="1"> location to store the length of the class path, or %NULL + line="10123">location to store the length of the class path, or %NULL allow-none="1"> location to store the class path as an allocated string, or %NULL + line="10124">location to store the class path as an allocated string, or %NULL allow-none="1"> location to store the reverse class path as an allocated + line="10125">location to store the reverse class path as an allocated string, or %NULL @@ -145285,21 +145285,21 @@ never uses a custom name set with gtk_widget_set_name(). c:identifier="gtk_widget_create_pango_context"> Creates a new #PangoContext with the appropriate font map, + line="7334">Creates a new #PangoContext with the appropriate font map, font description, and base direction for drawing text for this widget. See also gtk_widget_get_pango_context(). the new #PangoContext + line="7342">the new #PangoContext a #GtkWidget + line="7336">a #GtkWidget @@ -145308,7 +145308,7 @@ this widget. See also gtk_widget_get_pango_context(). c:identifier="gtk_widget_create_pango_layout"> Creates a new #PangoLayout with the appropriate font map, + line="7369">Creates a new #PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget. @@ -145321,20 +145321,20 @@ for the widget. the new #PangoLayout + line="7384">the new #PangoLayout a #GtkWidget + line="7371">a #GtkWidget text to set on the layout (can be %NULL) + line="7372">text to set on the layout (can be %NULL) @@ -145342,7 +145342,7 @@ for the widget. Destroys a widget. Equivalent to gtk_object_destroy(), except that + line="3165">Destroys a widget. Equivalent to gtk_object_destroy(), except that you don't have to cast the widget to #GtkObject. When a widget is destroyed, it will break any references it holds to other objects. If the widget is inside a container, the widget will be removed @@ -145364,7 +145364,7 @@ be destroyed as well. a #GtkWidget + line="3167">a #GtkWidget @@ -145372,7 +145372,7 @@ be destroyed as well. This function sets *@widget_pointer to %NULL if @widget_pointer != + line="3192">This function sets *@widget_pointer to %NULL if @widget_pointer != %NULL. It's intended to be used as a callback connected to the "destroy" signal of a widget. You connect gtk_widget_destroyed() as a signal handler, and pass the address of your widget variable @@ -145387,7 +145387,7 @@ of the same dialog. a #GtkWidget + line="3194">a #GtkWidget transfer-ownership="none"> address of a variable that contains @widget + line="3195">address of a variable that contains @widget @@ -145404,7 +145404,7 @@ of the same dialog. In GTK+ 1.2, this function would immediately render the + line="3875">In GTK+ 1.2, this function would immediately render the region @area of a widget, by invoking the virtual draw method of a widget. In GTK+ 2.0, the draw method is gone, and instead gtk_widget_draw() simply invalidates the specified region of the @@ -145420,13 +145420,13 @@ a better choice if you want to draw a region of a widget. a #GtkWidget + line="3877">a #GtkWidget area to draw + line="3878">area to draw @@ -145434,7 +145434,7 @@ a better choice if you want to draw a region of a widget. Ensures that @widget has a style (@widget->style). Not a very useful + line="6574">Ensures that @widget has a style (@widget->style). Not a very useful function; most of the time, if you want the style, the widget is realized, and realized widgets are guaranteed to have a style already. @@ -145446,7 +145446,7 @@ already. a #GtkWidget + line="6576">a #GtkWidget @@ -145456,7 +145456,7 @@ already. version="2.12"> Notifies the user about an input-related error on this widget. + line="7836">Notifies the user about an input-related error on this widget. If the #GtkSettings:gtk-error-bell setting is %TRUE, it calls gdk_window_beep(), otherwise it does nothing. @@ -145471,7 +145471,7 @@ or window manager that is used. a #GtkWidget + line="7838">a #GtkWidget @@ -145479,7 +145479,7 @@ or window manager that is used. Rarely-used function. This function is used to emit + line="4782">Rarely-used function. This function is used to emit the event signals on a widget (those signals should never be emitted without using this function to do so). If you want to synthesize an event though, don't use this function; @@ -145491,7 +145491,7 @@ window. return from the event signal emission (%TRUE if + line="4796">return from the event signal emission (%TRUE if the event was handled) @@ -145499,13 +145499,13 @@ window. a #GtkWidget + line="4784">a #GtkWidget a #GdkEvent + line="4785">a #GdkEvent @@ -145514,7 +145514,7 @@ window. c:identifier="gtk_widget_freeze_child_notify"> Stops emission of #GtkWidget::child-notify signals on @widget. The + line="2916">Stops emission of #GtkWidget::child-notify signals on @widget. The signals are queued until gtk_widget_thaw_child_notify() is called on @widget. @@ -145527,7 +145527,7 @@ This is the analogue of g_object_freeze_notify() for child properties. a #GtkWidget + line="2918">a #GtkWidget @@ -145535,7 +145535,7 @@ This is the analogue of g_object_freeze_notify() for child properties. Returns the accessible object that describes the widget to an + line="10224">Returns the accessible object that describes the widget to an assistive technology. If no accessibility library is loaded (i.e. no ATK implementation library is @@ -145551,14 +145551,14 @@ library contains more information about accessible objects and their uses. the #AtkObject associated with @widget + line="10241">the #AtkObject associated with @widget a #GtkWidget + line="10226">a #GtkWidget @@ -145596,7 +145596,7 @@ See also gtk_action_get_proxies(). version="2.18"> Retrieves the widget's allocation. + line="11279">Retrieves the widget's allocation. @@ -145605,7 +145605,7 @@ See also gtk_action_get_proxies(). a #GtkWidget + line="11281">a #GtkWidget transfer-ownership="none"> a pointer to a #GtkAllocation to copy to + line="11282">a pointer to a #GtkAllocation to copy to @@ -145622,7 +145622,7 @@ See also gtk_action_get_proxies(). Gets the first ancestor of @widget with type @widget_type. For example, + line="8249">Gets the first ancestor of @widget with type @widget_type. For example, <literal>gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)</literal> gets the first #GtkBox that's an ancestor of @widget. No reference will be added to the returned widget; it should not be unreferenced. See note @@ -145635,20 +145635,20 @@ considers @widget to be an ancestor of itself. the ancestor widget, or %NULL if not found + line="8264">the ancestor widget, or %NULL if not found a #GtkWidget + line="8251">a #GtkWidget ancestor type + line="8252">ancestor type @@ -145659,7 +145659,7 @@ considers @widget to be an ancestor of itself. version="2.18"> Determines whether the application intends to draw on the widget in + line="6193">Determines whether the application intends to draw on the widget in an #GtkWidget::expose-event handler. See gtk_widget_set_app_paintable() @@ -145667,14 +145667,14 @@ See gtk_widget_set_app_paintable() %TRUE if the widget is app paintable + line="6202">%TRUE if the widget is app paintable a #GtkWidget + line="6195">a #GtkWidget @@ -145685,20 +145685,20 @@ See gtk_widget_set_app_paintable() version="2.18"> Determines whether @widget can be a default widget. See + line="5643">Determines whether @widget can be a default widget. See gtk_widget_set_can_default(). %TRUE if @widget can be a default widget, %FALSE otherwise + line="5650">%TRUE if @widget can be a default widget, %FALSE otherwise a #GtkWidget + line="5645">a #GtkWidget @@ -145709,20 +145709,20 @@ gtk_widget_set_can_default(). version="2.18"> Determines whether @widget can own the input focus. See + line="5549">Determines whether @widget can own the input focus. See gtk_widget_set_can_focus(). %TRUE if @widget can own the input focus, %FALSE otherwise + line="5556">%TRUE if @widget can own the input focus, %FALSE otherwise a #GtkWidget + line="5551">a #GtkWidget @@ -145731,7 +145731,7 @@ gtk_widget_set_can_focus(). c:identifier="gtk_widget_get_child_requisition"> This function is only for use in widget implementations. Obtains + line="3942">This function is only for use in widget implementations. Obtains @widget->requisition, unless someone has forced a particular geometry on the widget (e.g. with gtk_widget_set_size_request()), in which case it returns that geometry instead of the widget's @@ -145757,13 +145757,13 @@ gtk_widget_size_request(). a #GtkWidget + line="3944">a #GtkWidget a #GtkRequisition to be filled in + line="3945">a #GtkRequisition to be filled in @@ -145772,7 +145772,7 @@ gtk_widget_size_request(). c:identifier="gtk_widget_get_child_visible"> Gets the value set with gtk_widget_set_child_visible(). + line="7568">Gets the value set with gtk_widget_set_child_visible(). If you feel a need to use this function, your code probably needs reorganization. @@ -145782,14 +145782,14 @@ never should be called by an application. %TRUE if the widget is mapped with the parent. + line="7579">%TRUE if the widget is mapped with the parent. a #GtkWidget + line="7570">a #GtkWidget @@ -145799,7 +145799,7 @@ never should be called by an application. version="2.2"> Returns the clipboard object for the given selection to + line="10822">Returns the clipboard object for the given selection to be used with @widget. @widget must have a #GdkDisplay associated with it, so must be attached to a toplevel window. @@ -145807,7 +145807,7 @@ window. the appropriate clipboard object. If no + line="10836">the appropriate clipboard object. If no clipboard already exists, a new one will be created. Once a clipboard object has been created, it is persistent for all time. @@ -145817,13 +145817,13 @@ window. a #GtkWidget + line="10824">a #GtkWidget a #GdkAtom which identifies the clipboard + line="10825">a #GdkAtom which identifies the clipboard to use. %GDK_SELECTION_CLIPBOARD gives the default clipboard. Another common value is %GDK_SELECTION_PRIMARY, which gives @@ -145835,20 +145835,20 @@ window. Gets the colormap that will be used to render @widget. No reference will + line="8281">Gets the colormap that will be used to render @widget. No reference will be added to the returned colormap; it should not be unreferenced. the colormap used by @widget + line="8288">the colormap used by @widget a #GtkWidget + line="8283">a #GtkWidget @@ -145857,12 +145857,12 @@ be added to the returned colormap; it should not be unreferenced. c:identifier="gtk_widget_get_composite_name"> Obtains the composite name of a widget. + line="8510">Obtains the composite name of a widget. the composite name of @widget, or %NULL if @widget is not + line="8516">the composite name of @widget, or %NULL if @widget is not a composite child. The string should be freed when it is no longer needed. @@ -145871,7 +145871,7 @@ be added to the returned colormap; it should not be unreferenced. a #GtkWidget + line="8512">a #GtkWidget @@ -145879,20 +145879,20 @@ be added to the returned colormap; it should not be unreferenced. Gets the reading direction for a particular widget. See + line="8699">Gets the reading direction for a particular widget. See gtk_widget_set_direction(). the reading direction for the widget. + line="8706">the reading direction for the widget. a #GtkWidget + line="8701">a #GtkWidget @@ -145902,7 +145902,7 @@ gtk_widget_set_direction(). version="2.2"> Get the #GdkDisplay for the toplevel window associated with + line="7670">Get the #GdkDisplay for the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a #GtkWindow at the top. @@ -145913,14 +145913,14 @@ free those resources when the widget is unrealized. the #GdkDisplay for the toplevel for this widget. + line="7682">the #GdkDisplay for the toplevel for this widget. a #GtkWidget + line="7672">a #GtkWidget @@ -145931,21 +145931,21 @@ free those resources when the widget is unrealized. version="2.18"> Determines whether the widget is double buffered. + line="6257">Determines whether the widget is double buffered. See gtk_widget_set_double_buffered() %TRUE if the widget is double buffered + line="6265">%TRUE if the widget is double buffered a #GtkWidget + line="6259">a #GtkWidget @@ -145955,21 +145955,21 @@ See gtk_widget_set_double_buffered() glib:get-property="events"> Returns the event mask for the widget (a bitfield containing flags + line="8382">Returns the event mask for the widget (a bitfield containing flags from the #GdkEventMask enumeration). These are the events that the widget will receive. event mask for @widget + line="8390">event mask for @widget a #GtkWidget + line="8384">a #GtkWidget @@ -145979,20 +145979,20 @@ will receive. glib:get-property="extension-events"> Retrieves the extension events the widget will receive; see + line="8400">Retrieves the extension events the widget will receive; see gdk_input_set_extension_events(). extension events for @widget + line="8407">extension events for @widget a #GtkWidget + line="8402">a #GtkWidget @@ -146003,20 +146003,20 @@ gdk_input_set_extension_events(). version="2.12"> Returns the current value of the has-tooltip property. See + line="11256">Returns the current value of the has-tooltip property. See GtkWidget:has-tooltip for more information. current value of has-tooltip on @widget. + line="11263">current value of has-tooltip on @widget. a #GtkWidget + line="11258">a #GtkWidget @@ -146026,20 +146026,20 @@ GtkWidget:has-tooltip for more information. version="2.18"> Determines whether @widget has a #GdkWindow of its own. See + line="5994">Determines whether @widget has a #GdkWindow of its own. See gtk_widget_set_has_window(). %TRUE if @widget has a window, %FALSE otherwise + line="6001">%TRUE if @widget has a window, %FALSE otherwise a #GtkWidget + line="5996">a #GtkWidget @@ -146049,19 +146049,19 @@ gtk_widget_set_has_window(). version="2.20"> Whether the widget is mapped. + line="6105">Whether the widget is mapped. %TRUE if the widget is mapped, %FALSE otherwise. + line="6111">%TRUE if the widget is mapped, %FALSE otherwise. a #GtkWidget + line="6107">a #GtkWidget @@ -146070,7 +146070,7 @@ gtk_widget_set_has_window(). c:identifier="gtk_widget_get_modifier_style"> Returns the current modifier style for the widget. (As set by + line="6675">Returns the current modifier style for the widget. (As set by gtk_widget_modify_style().) If no style has previously set, a new #GtkRcStyle will be created with all values unset, and set as the modifier style for the widget. If you make changes to this rc @@ -146086,7 +146086,7 @@ to the modifier style if you want to keep it alive. the modifier style for the widget. This rc style is + line="6692">the modifier style for the widget. This rc style is owned by the widget. If you want to keep a pointer to value this around, you must add a refcount using g_object_ref(). @@ -146095,7 +146095,7 @@ to the modifier style if you want to keep it alive. a #GtkWidget + line="6677">a #GtkWidget @@ -146105,13 +146105,13 @@ to the modifier style if you want to keep it alive. glib:get-property="name"> Retrieves the name of a widget. See gtk_widget_set_name() for the + line="5835">Retrieves the name of a widget. See gtk_widget_set_name() for the significance of widget names. name of the widget. This string is owned by GTK+ and + line="5842">name of the widget. This string is owned by GTK+ and should not be modified or freed @@ -146119,7 +146119,7 @@ should not be modified or freed a #GtkWidget + line="5837">a #GtkWidget @@ -146130,21 +146130,21 @@ should not be modified or freed version="2.4"> Returns the current value of the GtkWidget:no-show-all property, + line="10948">Returns the current value of the GtkWidget:no-show-all property, which determines whether calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect this widget. the current value of the "no-show-all" property. + line="10956">the current value of the "no-show-all" property. a #GtkWidget + line="10950">a #GtkWidget @@ -146153,7 +146153,7 @@ gtk_widget_hide_all() will affect this widget. c:identifier="gtk_widget_get_pango_context"> Gets a #PangoContext with the appropriate font map, font description, + line="7264">Gets a #PangoContext with the appropriate font map, font description, and base direction for this widget. Unlike the context returned by gtk_widget_create_pango_context(), this context is owned by the widget (it can be used until the screen for the widget changes @@ -146168,14 +146168,14 @@ on the layout in response to the #GtkWidget::style-set and the #PangoContext for the widget. + line="7280">the #PangoContext for the widget. a #GtkWidget + line="7266">a #GtkWidget @@ -146185,19 +146185,19 @@ on the layout in response to the #GtkWidget::style-set and glib:get-property="parent"> Returns the parent container of @widget. + line="6472">Returns the parent container of @widget. the parent container of @widget, or %NULL + line="6478">the parent container of @widget, or %NULL a #GtkWidget + line="6474">a #GtkWidget @@ -146206,19 +146206,19 @@ on the layout in response to the #GtkWidget::style-set and c:identifier="gtk_widget_get_parent_window"> Gets @widget's parent window. + line="7488">Gets @widget's parent window. the parent window of @widget. + line="7494">the parent window of @widget. a #GtkWidget. + line="7490">a #GtkWidget. @@ -146226,7 +146226,7 @@ on the layout in response to the #GtkWidget::style-set and Obtains the location of the mouse pointer in widget coordinates. + line="8417">Obtains the location of the mouse pointer in widget coordinates. Widget coordinates are a bit odd; for historical reasons, they are defined as @widget->window coordinates for widgets that are not #GTK_NO_WINDOW widgets, and are relative to @widget->allocation.x, @@ -146239,7 +146239,7 @@ defined as @widget->window coordinates for widgets that are not a #GtkWidget + line="8419">a #GtkWidget return location for the X coordinate, or %NULL + line="8420">return location for the X coordinate, or %NULL return location for the Y coordinate, or %NULL + line="8421">return location for the Y coordinate, or %NULL @@ -146271,19 +146271,19 @@ defined as @widget->window coordinates for widgets that are not version="2.20"> Determines whether @widget is realized. + line="6063">Determines whether @widget is realized. %TRUE if @widget is realized, %FALSE otherwise + line="6069">%TRUE if @widget is realized, %FALSE otherwise a #GtkWidget + line="6065">a #GtkWidget @@ -146294,7 +146294,7 @@ defined as @widget->window coordinates for widgets that are not version="2.18"> Determines whether @widget is alyways treated as default widget + line="5750">Determines whether @widget is alyways treated as default widget withing its toplevel when it has the focus, even if another widget is the default. @@ -146303,7 +146303,7 @@ See gtk_widget_set_receives_default(). %TRUE if @widget acts as default widget when focussed, + line="5760">%TRUE if @widget acts as default widget when focussed, %FALSE otherwise @@ -146311,7 +146311,7 @@ See gtk_widget_set_receives_default(). a #GtkWidget + line="5752">a #GtkWidget @@ -146321,7 +146321,7 @@ See gtk_widget_set_receives_default(). version="2.20"> Retrieves the widget's requisition. + line="11318">Retrieves the widget's requisition. This function should only be used by widget implementations in order to figure whether the widget's requisition has actually @@ -146337,7 +146337,7 @@ Normally, gtk_widget_size_request() should be used. a #GtkWidget + line="11320">a #GtkWidget transfer-ownership="none"> a pointer to a #GtkRequisition to copy to + line="11321">a pointer to a #GtkRequisition to copy to @@ -146356,7 +146356,7 @@ Normally, gtk_widget_size_request() should be used. version="2.2"> Get the root window where this widget is located. This function can + line="7694">Get the root window where this widget is located. This function can only be called after the widget has been added to a widget hierarchy with #GtkWindow at the top. @@ -146368,14 +146368,14 @@ and you should free those resources when the widget is unrealized. the #GdkWindow root window for the toplevel for this widget. + line="7707">the #GdkWindow root window for the toplevel for this widget. a #GtkWidget + line="7696">a #GtkWidget @@ -146385,7 +146385,7 @@ and you should free those resources when the widget is unrealized. version="2.2"> Get the #GdkScreen from the toplevel window associated with + line="7607">Get the #GdkScreen from the toplevel window associated with this widget. This function can only be called after the widget has been added to a widget hierarchy with a #GtkWindow at the top. @@ -146397,14 +146397,14 @@ free those resources when the widget is unrealized. the #GdkScreen for the toplevel for this widget. + line="7620">the #GdkScreen for the toplevel for this widget. a #GtkWidget + line="7609">a #GtkWidget @@ -146415,7 +146415,7 @@ free those resources when the widget is unrealized. version="2.18"> Returns the widget's sensitivity (in the sense of returning + line="6359">Returns the widget's sensitivity (in the sense of returning the value that has been set using gtk_widget_set_sensitive()). The effective sensitivity of a widget is however determined by both its @@ -146424,14 +146424,14 @@ own and its parent widget's sensitivity. See gtk_widget_is_sensitive(). %TRUE if the widget is sensitive + line="6369">%TRUE if the widget is sensitive a #GtkWidget + line="6361">a #GtkWidget @@ -146439,7 +146439,7 @@ own and its parent widget's sensitivity. See gtk_widget_is_sensitive(). Gets the settings object holding the settings (global property + line="8335">Gets the settings object holding the settings (global property settings, RC file information, etc) used for this widget. Note that this function can only be called when the #GtkWidget @@ -146449,14 +146449,14 @@ to a particular #GdkScreen. the relevant #GtkSettings object + line="8346">the relevant #GtkSettings object a #GtkWidget + line="8337">a #GtkWidget @@ -146465,7 +146465,7 @@ to a particular #GdkScreen. c:identifier="gtk_widget_get_size_request"> Gets the size request that was explicitly set for the widget using + line="8061">Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request(). A value of -1 stored in @width or @height indicates that that dimension has not been set explicitly and the natural requisition of the widget will be used intead. See @@ -146480,7 +146480,7 @@ this function. a #GtkWidget + line="8063">a #GtkWidget allow-none="1"> return location for width, or %NULL + line="8064">return location for width, or %NULL allow-none="1"> return location for height, or %NULL + line="8065">return location for height, or %NULL @@ -146513,7 +146513,7 @@ this function. introspectable="0"> Create a #GdkPixmap of the contents of the widget and its children. + line="9627">Create a #GdkPixmap of the contents of the widget and its children. Works even if the widget is obscured. The depth and visual of the resulting pixmap is dependent on the widget being snapshot and likely @@ -146543,14 +146543,14 @@ The returned pixmap can be %NULL, if the resulting @clip_area was empty. #GdkPixmap snapshot of the widget + line="9659">#GdkPixmap snapshot of the widget a #GtkWidget + line="9629">a #GtkWidget allow-none="1"> a #GdkRectangle or %NULL + line="9630">a #GdkRectangle or %NULL @@ -146569,19 +146569,19 @@ The returned pixmap can be %NULL, if the resulting @clip_area was empty. version="2.18"> Returns the widget's state. See gtk_widget_set_state(). + line="5894">Returns the widget's state. See gtk_widget_set_state(). the state of @widget. + line="5900">the state of @widget. a #GtkWidget + line="5896">a #GtkWidget @@ -146591,19 +146591,19 @@ The returned pixmap can be %NULL, if the resulting @clip_area was empty. glib:get-property="style"> Simply an accessor function that returns @widget->style. + line="6616">Simply an accessor function that returns @widget->style. the widget's #GtkStyle + line="6622">the widget's #GtkStyle a #GtkWidget + line="6618">a #GtkWidget @@ -146614,12 +146614,12 @@ The returned pixmap can be %NULL, if the resulting @clip_area was empty. version="2.12"> Gets the contents of the tooltip for @widget. + line="11214">Gets the contents of the tooltip for @widget. the tooltip text, or %NULL. You should free the + line="11220">the tooltip text, or %NULL. You should free the returned string with g_free() when done. @@ -146627,7 +146627,7 @@ The returned pixmap can be %NULL, if the resulting @clip_area was empty. a #GtkWidget + line="11216">a #GtkWidget @@ -146638,12 +146638,12 @@ The returned pixmap can be %NULL, if the resulting @clip_area was empty. version="2.12"> Gets the contents of the tooltip for @widget. + line="11166">Gets the contents of the tooltip for @widget. the tooltip text, or %NULL. You should free the + line="11172">the tooltip text, or %NULL. You should free the returned string with g_free() when done. @@ -146651,7 +146651,7 @@ The returned pixmap can be %NULL, if the resulting @clip_area was empty. a #GtkWidget + line="11168">a #GtkWidget @@ -146661,21 +146661,21 @@ The returned pixmap can be %NULL, if the resulting @clip_area was empty. version="2.12"> Returns the #GtkWindow of the current tooltip. This can be the + line="11078">Returns the #GtkWindow of the current tooltip. This can be the GtkWindow created by default, or the custom tooltip window set using gtk_widget_set_tooltip_window(). The #GtkWindow of the current tooltip. + line="11086">The #GtkWindow of the current tooltip. a #GtkWidget + line="11080">a #GtkWidget @@ -146683,7 +146683,7 @@ using gtk_widget_set_tooltip_window(). This function returns the topmost widget in the container hierarchy + line="8206">This function returns the topmost widget in the container hierarchy @widget is a part of. If @widget has no parent widgets, it will be returned as the topmost widget. No reference will be added to the returned widget; it should not be unreferenced. @@ -146711,7 +146711,7 @@ is set on the result. the topmost ancestor of @widget, or @widget itself + line="8235">the topmost ancestor of @widget, or @widget itself if there's no ancestor. @@ -146719,7 +146719,7 @@ is set on the result. a #GtkWidget + line="8208">a #GtkWidget @@ -146730,7 +146730,7 @@ is set on the result. version="2.18"> Determines whether the widget is visible. Note that this doesn't + line="5942">Determines whether the widget is visible. Note that this doesn't take into account whether the widget's parent is also visible or the widget is obscured in any way. @@ -146739,14 +146739,14 @@ See gtk_widget_set_visible(). %TRUE if the widget is visible + line="5952">%TRUE if the widget is visible a #GtkWidget + line="5944">a #GtkWidget @@ -146754,19 +146754,19 @@ See gtk_widget_set_visible(). Gets the visual that will be used to render @widget. + line="8319">Gets the visual that will be used to render @widget. the visual for @widget + line="8325">the visual for @widget a #GtkWidget + line="8321">a #GtkWidget @@ -146777,19 +146777,19 @@ See gtk_widget_set_visible(). version="2.14"> Returns the widget's window if it is realized, %NULL otherwise + line="11375">Returns the widget's window if it is realized, %NULL otherwise @widget's window. + line="11381">@widget's window. a #GtkWidget + line="11377">a #GtkWidget @@ -146797,7 +146797,7 @@ See gtk_widget_set_visible(). Causes @widget to become the default widget. @widget must have the + line="5692">Causes @widget to become the default widget. @widget must have the %GTK_CAN_DEFAULT flag set; typically you have to set this flag yourself by calling <literal>gtk_widget_set_can_default (@widget, %TRUE)</literal>. The default widget is activated when @@ -146811,7 +146811,7 @@ activatable, that is, gtk_widget_activate() should affect them. a #GtkWidget + line="5694">a #GtkWidget @@ -146819,7 +146819,7 @@ activatable, that is, gtk_widget_activate() should affect them. Causes @widget to have the keyboard focus for the #GtkWindow it's + line="5316">Causes @widget to have the keyboard focus for the #GtkWindow it's inside. @widget must be a focusable widget, such as a #GtkEntry; something like #GtkFrame won't work. @@ -146837,7 +146837,7 @@ will likely fail and cause critical warnings. a #GtkWidget + line="5318">a #GtkWidget @@ -146847,13 +146847,13 @@ will likely fail and cause critical warnings. version="2.18"> Determines whether @widget is the current default widget within its + line="5662">Determines whether @widget is the current default widget within its toplevel. See gtk_widget_set_can_default(). %TRUE if @widget is the current default widget within + line="5669">%TRUE if @widget is the current default widget within its toplevel, %FALSE otherwise @@ -146861,7 +146861,7 @@ toplevel. See gtk_widget_set_can_default(). a #GtkWidget + line="5664">a #GtkWidget @@ -146871,21 +146871,21 @@ toplevel. See gtk_widget_set_can_default(). version="2.18"> Determines if the widget has the global input focus. See + line="5568">Determines if the widget has the global input focus. See gtk_widget_is_focus() for the difference between having the global input focus, and only having the focus within a toplevel. %TRUE if the widget has the global input focus. + line="5576">%TRUE if the widget has the global input focus. a #GtkWidget + line="5570">a #GtkWidget @@ -146895,7 +146895,7 @@ input focus, and only having the focus within a toplevel. version="2.18"> Determines whether the widget is currently grabbing events, so it + line="5773">Determines whether the widget is currently grabbing events, so it is the only widget receiving input events (keyboard and mouse). See also gtk_grab_add(). @@ -146903,14 +146903,14 @@ See also gtk_grab_add(). %TRUE if the widget is in the grab_widgets stack + line="5782">%TRUE if the widget is in the grab_widgets stack a #GtkWidget + line="5775">a #GtkWidget @@ -146920,12 +146920,12 @@ See also gtk_grab_add(). version="2.20"> Determines if the widget style has been looked up through the rc mechanism. + line="6520">Determines if the widget style has been looked up through the rc mechanism. %TRUE if the widget has been looked up through the rc + line="6526">%TRUE if the widget has been looked up through the rc mechanism, %FALSE otherwise. @@ -146933,7 +146933,7 @@ See also gtk_grab_add(). a #GtkWidget + line="6522">a #GtkWidget @@ -146943,7 +146943,7 @@ See also gtk_grab_add(). version="2.2"> Checks whether there is a #GdkScreen is associated with + line="7648">Checks whether there is a #GdkScreen is associated with this widget. All toplevel widgets have an associated screen, and all widgets added into a hierarchy with a toplevel window at the top. @@ -146951,7 +146951,7 @@ window at the top. %TRUE if there is a #GdkScreen associcated + line="7657">%TRUE if there is a #GdkScreen associcated with the widget. @@ -146959,7 +146959,7 @@ window at the top. a #GtkWidget + line="7650">a #GtkWidget @@ -146967,7 +146967,7 @@ window at the top. Reverses the effects of gtk_widget_show(), causing the widget to be + line="3307">Reverses the effects of gtk_widget_show(), causing the widget to be hidden (invisible to the user). @@ -146977,7 +146977,7 @@ hidden (invisible to the user). a #GtkWidget + line="3309">a #GtkWidget @@ -146988,7 +146988,7 @@ hidden (invisible to the user). deprecated-version="2.24"> Recursively hides a widget and any child widgets. + line="3394">Recursively hides a widget and any child widgets. Use gtk_widget_hide() instead. @@ -146998,7 +146998,7 @@ hidden (invisible to the user). a #GtkWidget + line="3396">a #GtkWidget @@ -147006,7 +147006,7 @@ hidden (invisible to the user). Utility function; intended to be connected to the #GtkWidget::delete-event + line="3347">Utility function; intended to be connected to the #GtkWidget::delete-event signal on a #GtkWindow. The function calls gtk_widget_hide() on its argument, then returns %TRUE. If connected to ::delete-event, the result is that clicking the close button for a window (on the @@ -147017,14 +147017,14 @@ is received. %TRUE + line="3359">%TRUE a #GtkWidget + line="3349">a #GtkWidget @@ -147034,7 +147034,7 @@ is received. version="2.10"> Sets an input shape for this widget's GDK window. This allows for + line="9455">Sets an input shape for this widget's GDK window. This allows for windows which react to mouse click in a nonrectangular region, see gdk_window_input_shape_combine_mask() for more information. @@ -147045,7 +147045,7 @@ gdk_window_input_shape_combine_mask() for more information. a #GtkWidget + line="9457">a #GtkWidget allow-none="1"> shape to be added, or %NULL to remove an existing shape + line="9458">shape to be added, or %NULL to remove an existing shape X position of shape mask with respect to @window + line="9459">X position of shape mask with respect to @window Y position of shape mask with respect to @window + line="9460">Y position of shape mask with respect to @window @@ -147074,7 +147074,7 @@ gdk_window_input_shape_combine_mask() for more information. Computes the intersection of a @widget's area and @area, storing + line="5223">Computes the intersection of a @widget's area and @area, storing the intersection in @intersection, and returns %TRUE if there was an intersection. @intersection may be %NULL if you're only interested in whether there was an intersection. @@ -147082,26 +147082,26 @@ interested in whether there was an intersection. %TRUE if there was an intersection + line="5234">%TRUE if there was an intersection a #GtkWidget + line="5225">a #GtkWidget a rectangle + line="5226">a rectangle rectangle to store intersection of @widget and @area + line="5227">rectangle to store intersection of @widget and @area @@ -147109,13 +147109,13 @@ interested in whether there was an intersection. Determines whether @widget is somewhere inside @ancestor, possibly with + line="8455">Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers. %TRUE if @ancestor contains @widget as a child, + line="8463">%TRUE if @ancestor contains @widget as a child, grandchild, great grandchild, etc. @@ -147123,13 +147123,13 @@ intermediate containers. a #GtkWidget + line="8457">a #GtkWidget another #GtkWidget + line="8458">another #GtkWidget @@ -147139,7 +147139,7 @@ intermediate containers. version="2.10"> Whether @widget can rely on having its alpha channel + line="7132">Whether @widget can rely on having its alpha channel drawn correctly. On X11 this function returns whether a compositing manager is running for @widget's screen. @@ -147150,7 +147150,7 @@ window in its hierarchy (as set by gdk_window_set_composited()). %TRUE if the widget can rely on its alpha + line="7144">%TRUE if the widget can rely on its alpha channel being drawn correctly. @@ -147158,7 +147158,7 @@ channel being drawn correctly. a #GtkWidget + line="7134">a #GtkWidget @@ -147168,20 +147168,20 @@ channel being drawn correctly. version="2.18"> Determines whether @widget can be drawn to. A widget can be drawn + line="6043">Determines whether @widget can be drawn to. A widget can be drawn to if it is mapped and visible. %TRUE if @widget is drawable, %FALSE otherwise + line="6050">%TRUE if @widget is drawable, %FALSE otherwise a #GtkWidget + line="6045">a #GtkWidget @@ -147189,7 +147189,7 @@ to if it is mapped and visible. Determines if the widget is the focus widget within its + line="5588">Determines if the widget is the focus widget within its toplevel. (This does not mean that the %HAS_FOCUS flag is necessarily set; %HAS_FOCUS will only be set if the toplevel widget additionally has the global input focus.) @@ -147197,14 +147197,14 @@ toplevel widget additionally has the global input focus.) %TRUE if the widget is the focus widget. + line="5597">%TRUE if the widget is the focus widget. a #GtkWidget + line="5590">a #GtkWidget @@ -147214,20 +147214,20 @@ toplevel widget additionally has the global input focus.) version="2.18"> Returns the widget's effective sensitivity, which means + line="6381">Returns the widget's effective sensitivity, which means it is sensitive itself and also its parent widget is sensntive %TRUE if the widget is effectively sensitive + line="6388">%TRUE if the widget is effectively sensitive a #GtkWidget + line="6383">a #GtkWidget @@ -147237,21 +147237,21 @@ it is sensitive itself and also its parent widget is sensntive version="2.18"> Determines whether @widget is a toplevel widget. Currently only + line="6013">Determines whether @widget is a toplevel widget. Currently only #GtkWindow and #GtkInvisible are toplevel widgets. Toplevel widgets have no parent widget. %TRUE if @widget is a toplevel, %FALSE otherwise + line="6021">%TRUE if @widget is a toplevel, %FALSE otherwise a #GtkWidget + line="6015">a #GtkWidget @@ -147261,7 +147261,7 @@ widgets have no parent widget. version="2.12"> This function should be called whenever keyboard navigation within + line="7779">This function should be called whenever keyboard navigation within a single widget hits a boundary. The function emits the #GtkWidget::keynav-failed signal on the widget and its return value should be interpreted in a way similar to the return value of @@ -147296,7 +147296,7 @@ that require entering license keys. %TRUE if stopping keyboard navigation is fine, %FALSE + line="7816">%TRUE if stopping keyboard navigation is fine, %FALSE if the emitting widget should try to handle the keyboard navigation attempt in its parent container(s). @@ -147305,13 +147305,13 @@ that require entering license keys. a #GtkWidget + line="7781">a #GtkWidget direction of focus movement + line="7782">direction of focus movement @@ -147320,7 +147320,7 @@ that require entering license keys. c:identifier="gtk_widget_list_accel_closures"> Lists the closures used by @widget for accelerator group connections + line="4574">Lists the closures used by @widget for accelerator group connections with gtk_accel_group_connect_by_path() or gtk_accel_group_connect(). The closures can be used to monitor accelerator changes on @widget, by connecting to the @GtkAccelGroup::accel-changed signal of the @@ -147330,7 +147330,7 @@ gtk_accel_group_from_accel_closure(). + line="4585"> a newly allocated #GList of closures @@ -147340,7 +147340,7 @@ gtk_accel_group_from_accel_closure(). widget to list accelerator closures for + line="4576">widget to list accelerator closures for @@ -147350,7 +147350,7 @@ gtk_accel_group_from_accel_closure(). version="2.4"> Returns a newly allocated list of the widgets, normally labels, for + line="10853">Returns a newly allocated list of the widgets, normally labels, for which this widget is a the target of a mnemonic (see for example, gtk_label_set_mnemonic_widget()). @@ -147364,7 +147364,7 @@ widgets afterwards. the list of + line="10868">the list of mnemonic labels; free this list with g_list_free() when you are done with it. @@ -147375,7 +147375,7 @@ widgets afterwards. a #GtkWidget + line="10855">a #GtkWidget @@ -147383,7 +147383,7 @@ widgets afterwards. This function is only for use in widget implementations. Causes + line="3418">This function is only for use in widget implementations. Causes a widget to be mapped if it isn't already. @@ -147393,7 +147393,7 @@ a widget to be mapped if it isn't already. a #GtkWidget + line="3420">a #GtkWidget @@ -147402,7 +147402,7 @@ a widget to be mapped if it isn't already. c:identifier="gtk_widget_mnemonic_activate"> Emits the #GtkWidget::mnemonic-activate signal. + line="4697">Emits the #GtkWidget::mnemonic-activate signal. The default handler for this signal activates the @widget if @group_cycling is %FALSE, and just grabs the focus if @group_cycling @@ -147411,20 +147411,20 @@ is %TRUE. %TRUE if the signal has been handled + line="4708">%TRUE if the signal has been handled a #GtkWidget + line="4699">a #GtkWidget %TRUE if there are other widgets with the same mnemonic + line="4700">%TRUE if there are other widgets with the same mnemonic @@ -147432,7 +147432,7 @@ is %TRUE. Sets the base color for a widget in a particular state. + line="6832">Sets the base color for a widget in a particular state. All other style values are left untouched. The base color is the background color used along with the text color (see gtk_widget_modify_text()) for widgets such as #GtkEntry @@ -147453,13 +147453,13 @@ the base color on that. a #GtkWidget + line="6834">a #GtkWidget the state for which to set the base color + line="6835">the state for which to set the base color allow-none="1"> the color to assign (does not need to be allocated), + line="6836">the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_base(). @@ -147478,7 +147478,7 @@ the base color on that. Sets the background color for a widget in a particular state. + line="6776">Sets the background color for a widget in a particular state. All other style values are left untouched. See also gtk_widget_modify_style(). @@ -147497,13 +147497,13 @@ and setting the background color on that. a #GtkWidget + line="6778">a #GtkWidget the state for which to set the background color + line="6779">the state for which to set the background color allow-none="1"> the color to assign (does not need to be allocated), + line="6780">the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_bg(). @@ -147524,7 +147524,7 @@ and setting the background color on that. version="2.12"> Sets the cursor color to use in a widget, overriding the + line="6895">Sets the cursor color to use in a widget, overriding the #GtkWidget:cursor-color and #GtkWidget:secondary-cursor-color style properties. All other style values are left untouched. See also gtk_widget_modify_style(). @@ -147536,13 +147536,13 @@ See also gtk_widget_modify_style(). a #GtkWidget + line="6897">a #GtkWidget the color to use for primary cursor (does not need to be + line="6898">the color to use for primary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_cursor(). @@ -147550,7 +147550,7 @@ See also gtk_widget_modify_style(). the color to use for secondary cursor (does not need to be + line="6901">the color to use for secondary cursor (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_cursor(). @@ -147560,7 +147560,7 @@ See also gtk_widget_modify_style(). Sets the foreground color for a widget in a particular state. + line="6753">Sets the foreground color for a widget in a particular state. All other style values are left untouched. See also gtk_widget_modify_style(). @@ -147571,13 +147571,13 @@ gtk_widget_modify_style(). a #GtkWidget + line="6755">a #GtkWidget the state for which to set the foreground color + line="6756">the state for which to set the foreground color allow-none="1"> the color to assign (does not need to be allocated), + line="6757">the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_fg(). @@ -147596,7 +147596,7 @@ gtk_widget_modify_style(). Sets the font to use for a widget. All other style values are left + line="6929">Sets the font to use for a widget. All other style values are left untouched. See also gtk_widget_modify_style(). @@ -147606,7 +147606,7 @@ untouched. See also gtk_widget_modify_style(). a #GtkWidget + line="6931">a #GtkWidget allow-none="1"> the font description to use, or %NULL to undo + line="6932">the font description to use, or %NULL to undo the effect of previous calls to gtk_widget_modify_font(). @@ -147624,7 +147624,7 @@ untouched. See also gtk_widget_modify_style(). Modifies style values on the widget. Modifications made using this + line="6632">Modifies style values on the widget. Modifications made using this technique take precedence over style values set via an RC file, however, they will be overriden if a style is explicitely set on the widget using gtk_widget_set_style(). The #GtkRcStyle structure @@ -147649,13 +147649,13 @@ effect with the initial modifications. a #GtkWidget + line="6634">a #GtkWidget the #GtkRcStyle holding the style modifications + line="6635">the #GtkRcStyle holding the style modifications @@ -147663,7 +147663,7 @@ effect with the initial modifications. Sets the text color for a widget in a particular state. All other + line="6807">Sets the text color for a widget in a particular state. All other style values are left untouched. The text color is the foreground color used along with the base color (see gtk_widget_modify_base()) for widgets such as #GtkEntry and #GtkTextView. See also @@ -147676,13 +147676,13 @@ gtk_widget_modify_style(). a #GtkWidget + line="6809">a #GtkWidget the state for which to set the text color + line="6810">the state for which to set the text color allow-none="1"> the color to assign (does not need to be allocated), + line="6811">the color to assign (does not need to be allocated), or %NULL to undo the effect of previous calls to of gtk_widget_modify_text(). @@ -147701,7 +147701,7 @@ gtk_widget_modify_style(). Obtains the full path to @widget. The path is simply the name of a + line="10047">Obtains the full path to @widget. The path is simply the name of a widget and all its parents in the container hierarchy, separated by periods. The name of a widget comes from gtk_widget_get_name(). Paths are used to apply styles to a widget @@ -147721,7 +147721,7 @@ of @widget's outermost ancestor. a #GtkWidget + line="10049">a #GtkWidget allow-none="1"> location to store length of the path, or %NULL + line="10050">location to store length of the path, or %NULL allow-none="1"> location to store allocated path string, or %NULL + line="10051">location to store allocated path string, or %NULL allow-none="1"> location to store allocated reverse path string, or %NULL + line="10052">location to store allocated reverse path string, or %NULL @@ -147765,7 +147765,7 @@ of @widget's outermost ancestor. deprecated-version="2.2"> This function does the same as gtk_widget_queue_draw(). + line="3821">This function does the same as gtk_widget_queue_draw(). Use gtk_widget_queue_draw() instead. @@ -147775,7 +147775,7 @@ of @widget's outermost ancestor. a #GtkWidget + line="3823">a #GtkWidget @@ -147786,7 +147786,7 @@ of @widget's outermost ancestor. deprecated-version="2.2"> This function is no longer different from + line="3791">This function is no longer different from gtk_widget_queue_draw_area(), though it once was. Now it just calls gtk_widget_queue_draw_area(). Originally gtk_widget_queue_clear_area() would force a redraw of the @@ -147802,31 +147802,31 @@ the background will be redrawn. a #GtkWidget + line="3793">a #GtkWidget x coordinate of upper-left corner of rectangle to redraw + line="3794">x coordinate of upper-left corner of rectangle to redraw y coordinate of upper-left corner of rectangle to redraw + line="3795">y coordinate of upper-left corner of rectangle to redraw width of region to draw + line="3796">width of region to draw height of region to draw + line="3797">height of region to draw @@ -147834,7 +147834,7 @@ the background will be redrawn. Equivalent to calling gtk_widget_queue_draw_area() for the + line="3767">Equivalent to calling gtk_widget_queue_draw_area() for the entire area of a widget. @@ -147844,7 +147844,7 @@ entire area of a widget. a #GtkWidget + line="3769">a #GtkWidget @@ -147852,7 +147852,7 @@ entire area of a widget. Invalidates the rectangular area of @widget defined by @x, @y, + line="3623">Invalidates the rectangular area of @widget defined by @x, @y, @width and @height by calling gdk_window_invalidate_rect() on the widget's window and all its child windows. Once the main loop becomes idle (after the current batch of events has been processed, @@ -147880,31 +147880,31 @@ ensures that you only have to redraw one time. a #GtkWidget + line="3625">a #GtkWidget x coordinate of upper-left corner of rectangle to redraw + line="3626">x coordinate of upper-left corner of rectangle to redraw y coordinate of upper-left corner of rectangle to redraw + line="3627">y coordinate of upper-left corner of rectangle to redraw width of region to draw + line="3628">width of region to draw height of region to draw + line="3629">height of region to draw @@ -147912,7 +147912,7 @@ ensures that you only have to redraw one time. This function is only for use in widget implementations. + line="3837">This function is only for use in widget implementations. Flags a widget to have its size renegotiated; should be called when a widget for some reason has a new size request. For example, when you change the text in a #GtkLabel, #GtkLabel @@ -147925,7 +147925,7 @@ queues a resize to ensure there's enough space for the new text. a #GtkWidget + line="3839">a #GtkWidget @@ -147935,7 +147935,7 @@ queues a resize to ensure there's enough space for the new text. version="2.4"> This function works like gtk_widget_queue_resize(), + line="3858">This function works like gtk_widget_queue_resize(), except that the widget is not invalidated. @@ -147945,7 +147945,7 @@ except that the widget is not invalidated. a #GtkWidget + line="3860">a #GtkWidget @@ -147953,7 +147953,7 @@ except that the widget is not invalidated. Creates the GDK (windowing system) resources associated with a + line="3510">Creates the GDK (windowing system) resources associated with a widget. For example, @widget->window will be created when a widget is realized. Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be @@ -147979,7 +147979,7 @@ GtkWidget::realize signal. a #GtkWidget + line="3512">a #GtkWidget @@ -147991,7 +147991,7 @@ GtkWidget::realize signal. deprecated-version="2.12"> Adds a reference to a widget. This function is exactly the same + line="9542">Adds a reference to a widget. This function is exactly the same as calling g_object_ref(), and exists mostly for historical reasons. It can still be convenient to avoid casting a widget to a #GObject, it saves a small amount of typing. @@ -148000,14 +148000,14 @@ to a #GObject, it saves a small amount of typing. the widget that was referenced + line="9551">the widget that was referenced a #GtkWidget + line="9544">a #GtkWidget @@ -148017,14 +148017,14 @@ to a #GObject, it saves a small amount of typing. introspectable="0"> Computes the intersection of a @widget's area and @region, returning + line="5264">Computes the intersection of a @widget's area and @region, returning the intersection. The result may be empty, use gdk_region_empty() to check. A newly allocated region holding the intersection of @widget + line="5271">A newly allocated region holding the intersection of @widget and @region. The coordinates of the return value are relative to @widget->window for %NO_WINDOW widgets, and relative to the parent window of @widget->window for @@ -148035,13 +148035,13 @@ check. a #GtkWidget + line="5266">a #GtkWidget a #GdkRegion, in the same coordinate system as + line="5267">a #GdkRegion, in the same coordinate system as @widget->allocation. That is, relative to @widget->window for %NO_WINDOW widgets; relative to the parent window of @widget->window for widgets with their own window. @@ -148053,38 +148053,38 @@ check. c:identifier="gtk_widget_remove_accelerator"> Removes an accelerator from @widget, previously installed with + line="4523">Removes an accelerator from @widget, previously installed with gtk_widget_add_accelerator(). whether an accelerator was installed and could be removed + line="4529">whether an accelerator was installed and could be removed widget to install an accelerator on + line="4525">widget to install an accelerator on accel group for this widget + line="4526">accel group for this widget GDK keyval of the accelerator + line="4527">GDK keyval of the accelerator modifier key combination of the accelerator + line="4528">modifier key combination of the accelerator @@ -148094,7 +148094,7 @@ gtk_widget_add_accelerator(). version="2.4"> Removes a widget from the list of mnemonic labels for + line="10918">Removes a widget from the list of mnemonic labels for this widget. (See gtk_widget_list_mnemonic_labels()). The widget must have previously been added to the list with gtk_widget_add_mnemonic_label(). @@ -148106,13 +148106,13 @@ gtk_widget_add_mnemonic_label(). a #GtkWidget + line="10920">a #GtkWidget a #GtkWidget that was previously set as a mnemnic label for + line="10921">a #GtkWidget that was previously set as a mnemnic label for @widget with gtk_widget_add_mnemonic_label(). @@ -148121,7 +148121,7 @@ gtk_widget_add_mnemonic_label(). A convenience function that uses the theme engine and RC file + line="7404">A convenience function that uses the theme engine and RC file settings for @widget to look up @stock_id and render it to a pixbuf. @stock_id should be a stock icon ID such as #GTK_STOCK_OPEN or #GTK_STOCK_OK. @size should be a size @@ -148136,7 +148136,7 @@ after use with g_object_unref(). a new pixbuf, or %NULL if the + line="7425">a new pixbuf, or %NULL if the stock ID wasn't known @@ -148144,19 +148144,19 @@ after use with g_object_unref(). a #GtkWidget + line="7406">a #GtkWidget a stock ID + line="7407">a stock ID a stock size. A size of (GtkIconSize)-1 means + line="7408">a stock size. A size of (GtkIconSize)-1 means render at the size of the source and don't scale (if there are multiple source sizes, GTK+ picks one of the available sizes). @@ -148167,7 +148167,7 @@ after use with g_object_unref(). allow-none="1"> render detail to pass to theme engine + line="7411">render detail to pass to theme engine @@ -148175,7 +148175,7 @@ after use with g_object_unref(). Moves a widget from one #GtkContainer to another, handling reference + line="5180">Moves a widget from one #GtkContainer to another, handling reference count issues to avoid destroying the widget. @@ -148185,13 +148185,13 @@ count issues to avoid destroying the widget. a #GtkWidget + line="5182">a #GtkWidget a #GtkContainer to move the widget into + line="5183">a #GtkContainer to move the widget into @@ -148199,7 +148199,7 @@ count issues to avoid destroying the widget. Reset the styles of @widget and all descendents, so when + line="7220">Reset the styles of @widget and all descendents, so when they are looked up again, they get the correct values for the currently loaded RC file settings. @@ -148212,7 +148212,7 @@ This function is not useful for applications. a #GtkWidget. + line="7222">a #GtkWidget. @@ -148222,7 +148222,7 @@ This function is not useful for applications. deprecated="1"> Recursively resets the shape on this widget and its descendants. + line="9524">Recursively resets the shape on this widget and its descendants. This function is being removed in GTK+ 3.0. Don't use it. @@ -148232,7 +148232,7 @@ This function is not useful for applications. a #GtkWidget + line="9526">a #GtkWidget @@ -148240,7 +148240,7 @@ This function is not useful for applications. Very rarely-used function. This function is used to emit + line="4818">Very rarely-used function. This function is used to emit an expose event signals on a widget. This function is not normally used directly. The only time it is used is when propagating an expose event to a child %NO_WINDOW widget, and @@ -148254,7 +148254,7 @@ with a call to gdk_window_process_updates(). return from the event signal emission (%TRUE if + line="4834">return from the event signal emission (%TRUE if the event was handled) @@ -148262,13 +148262,13 @@ with a call to gdk_window_process_updates(). a #GtkWidget + line="4820">a #GtkWidget a expose #GdkEvent + line="4821">a expose #GdkEvent @@ -148278,7 +148278,7 @@ with a call to gdk_window_process_updates(). version="2.22"> Sends the focus change @event to @widget + line="11403">Sends the focus change @event to @widget This function is not meant to be used by applications. The only time it should be used is when it is necessary for a #GtkWidget to assign focus @@ -148305,7 +148305,7 @@ An example of its usage is: the return value from the event signal emission: %TRUE + line="11432">the return value from the event signal emission: %TRUE if the event was handled, and %FALSE otherwise @@ -148313,13 +148313,13 @@ An example of its usage is: a #GtkWidget + line="11405">a #GtkWidget a #GdkEvent of type GDK_FOCUS_CHANGE + line="11406">a #GdkEvent of type GDK_FOCUS_CHANGE @@ -148331,7 +148331,7 @@ An example of its usage is: deprecated-version="2.0"> Precursor of g_object_set(). + line="3044">Precursor of g_object_set(). Use g_object_set() instead. @@ -148341,19 +148341,19 @@ An example of its usage is: a #GtkWidget + line="3046">a #GtkWidget name of first property to set + line="3047">name of first property to set value of first property, followed by more properties, + line="3048">value of first property, followed by more properties, %NULL-terminated @@ -148362,7 +148362,7 @@ An example of its usage is: Given an accelerator group, @accel_group, and an accelerator path, + line="4622">Given an accelerator group, @accel_group, and an accelerator path, @accel_path, sets up an accelerator in @accel_group so whenever the key binding that is defined for @accel_path is pressed, @widget will be activated. This removes any accelerators (for any @@ -148391,7 +148391,7 @@ g_intern_static_string(). a #GtkWidget + line="4624">a #GtkWidget allow-none="1"> path used to look up the accelerator + line="4625">path used to look up the accelerator allow-none="1"> a #GtkAccelGroup. + line="4626">a #GtkAccelGroup. @@ -148419,7 +148419,7 @@ g_intern_static_string(). version="2.18"> Sets the widget's allocation. This should not be used + line="11298">Sets the widget's allocation. This should not be used directly, but from within a widget's size_allocate method. @@ -148429,13 +148429,13 @@ directly, but from within a widget's size_allocate method. a #GtkWidget + line="11300">a #GtkWidget a pointer to a #GtkAllocation to copy from + line="11301">a pointer to a #GtkAllocation to copy from @@ -148445,7 +148445,7 @@ directly, but from within a widget's size_allocate method. glib:set-property="app-paintable"> Sets whether the application intends to draw on the widget in + line="6147">Sets whether the application intends to draw on the widget in an #GtkWidget::expose-event handler. This is a hint to the widget and does not affect the behavior of @@ -148471,13 +148471,13 @@ window using an RGBA visual), you can work around this by doing: a #GtkWidget + line="6149">a #GtkWidget %TRUE if the application will paint on the widget + line="6150">%TRUE if the application will paint on the widget @@ -148488,7 +148488,7 @@ window using an RGBA visual), you can work around this by doing: version="2.18"> Specifies whether @widget can be a default widget. See + line="5614">Specifies whether @widget can be a default widget. See gtk_widget_grab_default() for details about the meaning of "default". @@ -148499,13 +148499,13 @@ gtk_widget_grab_default() for details about the meaning of a #GtkWidget + line="5616">a #GtkWidget whether or not @widget can be a default widget. + line="5617">whether or not @widget can be a default widget. @@ -148516,7 +148516,7 @@ gtk_widget_grab_default() for details about the meaning of version="2.18"> Specifies whether @widget can own the input focus. See + line="5520">Specifies whether @widget can own the input focus. See gtk_widget_grab_focus() for actually setting the input focus on a widget. @@ -148527,13 +148527,13 @@ widget. a #GtkWidget + line="5522">a #GtkWidget whether or not @widget can own the input focus. + line="5523">whether or not @widget can own the input focus. @@ -148542,7 +148542,7 @@ widget. c:identifier="gtk_widget_set_child_visible"> Sets whether @widget should be mapped along with its when its parent + line="7510">Sets whether @widget should be mapped along with its when its parent is mapped and @widget has been shown with gtk_widget_show(). The child visibility can be set for widget before it is added to @@ -148567,13 +148567,13 @@ never should be called by an application. a #GtkWidget + line="7512">a #GtkWidget if %TRUE, @widget should be mapped along with its parent. + line="7513">if %TRUE, @widget should be mapped along with its parent. @@ -148581,7 +148581,7 @@ never should be called by an application. Sets the colormap for the widget to the given value. Widget must not + line="8356">Sets the colormap for the widget to the given value. Widget must not have been previously realized. This probably should only be used from an <function>init()</function> function (i.e. from the constructor for the widget). @@ -148593,13 +148593,13 @@ for the widget). a #GtkWidget + line="8358">a #GtkWidget a colormap + line="8359">a colormap @@ -148608,7 +148608,7 @@ for the widget). c:identifier="gtk_widget_set_composite_name"> Sets a widgets composite name. The widget must be + line="8485">Sets a widgets composite name. The widget must be a composite child of its parent; see gtk_widget_push_composite_child(). @@ -148618,13 +148618,13 @@ a composite child of its parent; see gtk_widget_push_composite_child(). a #GtkWidget. + line="8487">a #GtkWidget. the name to set + line="8488">the name to set @@ -148632,7 +148632,7 @@ a composite child of its parent; see gtk_widget_push_composite_child(). Sets the reading direction on a particular widget. This direction + line="8655">Sets the reading direction on a particular widget. This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order @@ -148652,13 +148652,13 @@ set by gtk_widget_set_default_direction() will be used. a #GtkWidget + line="8657">a #GtkWidget the new direction + line="8658">the new direction @@ -148668,7 +148668,7 @@ set by gtk_widget_set_default_direction() will be used. glib:set-property="double-buffered"> Widgets are double buffered by default; you can use this function + line="6214">Widgets are double buffered by default; you can use this function to turn off the buffering. "Double buffered" simply means that gdk_window_begin_paint_region() and gdk_window_end_paint() are called automatically around expose events sent to the @@ -148694,13 +148694,13 @@ gdk_window_begin_paint()). a #GtkWidget + line="6216">a #GtkWidget %TRUE to double-buffer a widget + line="6217">%TRUE to double-buffer a widget @@ -148710,7 +148710,7 @@ gdk_window_begin_paint()). glib:set-property="events"> Sets the event mask (see #GdkEventMask) for a widget. The event + line="8093">Sets the event mask (see #GdkEventMask) for a widget. The event mask determines which events a widget will receive. Keep in mind that different widgets have different default event masks, and by changing the event mask you may disrupt a widget's functionality, @@ -148728,13 +148728,13 @@ and receive events on the event box. a #GtkWidget + line="8095">a #GtkWidget event mask + line="8096">event mask @@ -148744,7 +148744,7 @@ and receive events on the event box. glib:set-property="extension-events"> Sets the extension events mask to @mode. See #GdkExtensionMode + line="8184">Sets the extension events mask to @mode. See #GdkExtensionMode and gdk_input_set_extension_events(). @@ -148754,13 +148754,13 @@ and gdk_input_set_extension_events(). a #GtkWidget + line="8186">a #GtkWidget bitfield of extension events to receive + line="8187">bitfield of extension events to receive @@ -148771,7 +148771,7 @@ and gdk_input_set_extension_events(). version="2.12"> Sets the has-tooltip property on @widget to @has_tooltip. See + line="11237">Sets the has-tooltip property on @widget to @has_tooltip. See GtkWidget:has-tooltip for more information. @@ -148781,13 +148781,13 @@ GtkWidget:has-tooltip for more information. a #GtkWidget + line="11239">a #GtkWidget whether or not @widget has a tooltip. + line="11240">whether or not @widget has a tooltip. @@ -148797,7 +148797,7 @@ GtkWidget:has-tooltip for more information. version="2.18"> Specifies whether @widget has a #GdkWindow of its own. Note that + line="5964">Specifies whether @widget has a #GdkWindow of its own. Note that all realized widgets have a non-%NULL "window" pointer (gtk_widget_get_window() never returns a %NULL window when a widget is realized), but for many of them it's actually the #GdkWindow of @@ -148815,13 +148815,13 @@ and they should call it in their init() function. a #GtkWidget + line="5966">a #GtkWidget whether or not @widget has a window. + line="5967">whether or not @widget has a window. @@ -148831,7 +148831,7 @@ and they should call it in their init() function. version="2.20"> Marks the widget as being realized. + line="6123">Marks the widget as being realized. This function should only ever be called in a derived widget's "map" or "unmap" implementation. @@ -148843,13 +148843,13 @@ This function should only ever be called in a derived widget's a #GtkWidget + line="6125">a #GtkWidget %TRUE to mark the widget as mapped + line="6126">%TRUE to mark the widget as mapped @@ -148859,7 +148859,7 @@ This function should only ever be called in a derived widget's glib:set-property="name"> Widgets can be named, which allows you to refer to them from a + line="5804">Widgets can be named, which allows you to refer to them from a gtkrc file. You can apply a style to widgets with a particular name in the gtkrc file. See the documentation for gtkrc files (on the same page as the docs for #GtkRcStyle). @@ -148874,13 +148874,13 @@ gtk_widget_path()), so names with embedded periods may cause confusion. a #GtkWidget + line="5806">a #GtkWidget name for the widget + line="5807">name for the widget @@ -148891,7 +148891,7 @@ gtk_widget_path()), so names with embedded periods may cause confusion. version="2.4"> Sets the #GtkWidget:no-show-all property, which determines whether + line="10968">Sets the #GtkWidget:no-show-all property, which determines whether calls to gtk_widget_show_all() and gtk_widget_hide_all() will affect this widget. @@ -148905,13 +148905,13 @@ controlled visibility, see #GtkUIManager. a #GtkWidget + line="10970">a #GtkWidget the new value for the "no-show-all" property + line="10971">the new value for the "no-show-all" property @@ -148921,7 +148921,7 @@ controlled visibility, see #GtkUIManager. glib:set-property="parent"> This function is useful only when implementing subclasses of + line="6401">This function is useful only when implementing subclasses of #GtkContainer. Sets the container as the parent of @widget, and takes care of some details such as updating the state and style of the child @@ -148935,13 +148935,13 @@ gtk_widget_unparent(). a #GtkWidget + line="6403">a #GtkWidget parent container + line="6404">parent container @@ -148950,7 +148950,7 @@ gtk_widget_unparent(). c:identifier="gtk_widget_set_parent_window"> Sets a non default parent window for @widget. + line="7459">Sets a non default parent window for @widget. @@ -148959,13 +148959,13 @@ gtk_widget_unparent(). a #GtkWidget. + line="7461">a #GtkWidget. the new parent window. + line="7462">the new parent window. @@ -148975,7 +148975,7 @@ gtk_widget_unparent(). version="2.20"> Marks the widget as being realized. + line="6081">Marks the widget as being realized. This function should only ever be called in a derived widget's "realize" or "unrealize" implementation. @@ -148987,13 +148987,13 @@ This function should only ever be called in a derived widget's a #GtkWidget + line="6083">a #GtkWidget %TRUE to mark the widget as realized + line="6084">%TRUE to mark the widget as realized @@ -149004,7 +149004,7 @@ This function should only ever be called in a derived widget's version="2.18"> Specifies whether @widget will be treated as the default widget + line="5719">Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. @@ -149018,13 +149018,13 @@ See gtk_widget_grab_default() for details about the meaning of a #GtkWidget + line="5721">a #GtkWidget whether or not @widget can be a default widget. + line="5722">whether or not @widget can be a default widget. @@ -149033,7 +149033,7 @@ See gtk_widget_grab_default() for details about the meaning of c:identifier="gtk_widget_set_redraw_on_allocate"> Sets whether the entire widget is queued for drawing when its size + line="6277">Sets whether the entire widget is queued for drawing when its size allocation changes. By default, this setting is %TRUE and the entire widget is redrawn on every size change. If your widget leaves the upper left unchanged when made bigger, turning this @@ -149055,13 +149055,13 @@ regions newly when the widget increases size. a #GtkWidget + line="6279">a #GtkWidget if %TRUE, the entire widget will be redrawn + line="6280">if %TRUE, the entire widget will be redrawn when it is allocated to a new size. Otherwise, only the new portion of the widget will be redrawn. @@ -149072,7 +149072,7 @@ regions newly when the widget increases size. c:identifier="gtk_widget_set_scroll_adjustments"> For widgets that support scrolling, sets the scroll adjustments and + line="5056">For widgets that support scrolling, sets the scroll adjustments and returns %TRUE. For widgets that don't support scrolling, does nothing and returns %FALSE. Widgets that don't support scrolling can be scrolled by placing them in a #GtkViewport, which does @@ -149081,14 +149081,14 @@ support scrolling. %TRUE if the widget supports scrolling + line="5068">%TRUE if the widget supports scrolling a #GtkWidget + line="5058">a #GtkWidget allow-none="1"> an adjustment for horizontal scrolling, or %NULL + line="5059">an adjustment for horizontal scrolling, or %NULL allow-none="1"> an adjustment for vertical scrolling, or %NULL + line="5060">an adjustment for vertical scrolling, or %NULL @@ -149116,7 +149116,7 @@ support scrolling. glib:set-property="sensitive"> Sets the sensitivity of a widget. A widget is sensitive if the user + line="6311">Sets the sensitivity of a widget. A widget is sensitive if the user can interact with it. Insensitive widgets are "grayed out" and the user can't interact with them. Insensitive widgets are known as "inactive", "disabled", or "ghosted" in some other toolkits. @@ -149128,13 +149128,13 @@ user can't interact with them. Insensitive widgets are known as a #GtkWidget + line="6313">a #GtkWidget %TRUE to make the widget sensitive + line="6314">%TRUE to make the widget sensitive @@ -149143,7 +149143,7 @@ user can't interact with them. Insensitive widgets are known as c:identifier="gtk_widget_set_size_request"> Sets the minimum size of a widget; that is, the widget's size + line="8007">Sets the minimum size of a widget; that is, the widget's size request will be @width by @height. You can use this function to force a widget to be either larger or smaller than it normally would be. @@ -149180,19 +149180,19 @@ you can pass 0,0 to this function to mean "as small as possible." a #GtkWidget + line="8009">a #GtkWidget width @widget should request, or -1 to unset + line="8010">width @widget should request, or -1 to unset height @widget should request, or -1 to unset + line="8011">height @widget should request, or -1 to unset @@ -149200,7 +149200,7 @@ you can pass 0,0 to this function to mean "as small as possible." This function is for use in widget implementations. Sets the state + line="5855">This function is for use in widget implementations. Sets the state of a widget (insensitive, prelighted, etc.) Usually you should set the state using wrapper functions such as gtk_widget_set_sensitive(). @@ -149211,13 +149211,13 @@ the state using wrapper functions such as gtk_widget_set_sensitive(). a #GtkWidget + line="5857">a #GtkWidget new state for @widget + line="5858">new state for @widget @@ -149227,7 +149227,7 @@ the state using wrapper functions such as gtk_widget_set_sensitive(). glib:set-property="style"> Sets the #GtkStyle for a widget (@widget->style). You probably don't + line="6539">Sets the #GtkStyle for a widget (@widget->style). You probably don't want to use this function; it interacts badly with themes, because themes work by replacing the #GtkStyle. Instead, use gtk_widget_modify_style(). @@ -149239,7 +149239,7 @@ gtk_widget_modify_style(). a #GtkWidget + line="6541">a #GtkWidget allow-none="1"> a #GtkStyle, or %NULL to remove the effect of a previous + line="6542">a #GtkStyle, or %NULL to remove the effect of a previous gtk_widget_set_style() and go back to the default style @@ -149260,7 +149260,7 @@ gtk_widget_modify_style(). version="2.12"> Sets @markup as the contents of the tooltip, which is marked up with + line="11189">Sets @markup as the contents of the tooltip, which is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>. This function will take care of setting GtkWidget:has-tooltip to %TRUE @@ -149276,7 +149276,7 @@ gtk_tooltip_set_markup(). a #GtkWidget + line="11191">a #GtkWidget allow-none="1"> the contents of the tooltip for @widget, or %NULL + line="11192">the contents of the tooltip for @widget, or %NULL @@ -149296,7 +149296,7 @@ gtk_tooltip_set_markup(). version="2.12"> Sets @text as the contents of the tooltip. This function will take + line="11144">Sets @text as the contents of the tooltip. This function will take care of setting GtkWidget:has-tooltip to %TRUE and of the default handler for the GtkWidget::query-tooltip signal. @@ -149309,13 +149309,13 @@ See also the GtkWidget:tooltip-text property and gtk_tooltip_set_text(). a #GtkWidget + line="11146">a #GtkWidget the contents of the tooltip for @widget + line="11147">the contents of the tooltip for @widget @@ -149325,7 +149325,7 @@ See also the GtkWidget:tooltip-text property and gtk_tooltip_set_text(). version="2.12"> Replaces the default, usually yellow, window used for displaying + line="11037">Replaces the default, usually yellow, window used for displaying tooltips with @custom_window. GTK+ will take care of showing and hiding @custom_window at the right moment, to behave likewise as the default tooltip window. If @custom_window is %NULL, the default @@ -149341,7 +149341,7 @@ have the name "gtk-tooltip", see gtk_widget_set_name(). a #GtkWidget + line="11039">a #GtkWidget allow-none="1"> a #GtkWindow, or %NULL + line="11040">a #GtkWindow, or %NULL @@ -149358,7 +149358,7 @@ have the name "gtk-tooltip", see gtk_widget_set_name(). Sets the position of a widget. The funny "u" in the name comes from + line="7870">Sets the position of a widget. The funny "u" in the name comes from the "user position" hint specified by the X Window System, and exists for legacy reasons. This function doesn't work if a widget is inside a container; it's only really useful on #GtkWindow. @@ -149381,19 +149381,19 @@ is not honoured unless both @x and @y are set. a #GtkWidget + line="7872">a #GtkWidget x position; -1 to unset x; -2 to leave x unchanged + line="7873">x position; -1 to unset x; -2 to leave x unchanged y position; -1 to unset y; -2 to leave y unchanged + line="7874">y position; -1 to unset y; -2 to leave y unchanged @@ -149404,7 +149404,7 @@ is not honoured unless both @x and @y are set. deprecated-version="2.2"> Sets the minimum size of a widget; that is, the widget's size + line="7971">Sets the minimum size of a widget; that is, the widget's size request will be @width by @height. You can use this function to force a widget to be either larger or smaller than it is. The strange "usize" name dates from the early days of GTK+, and derives @@ -149430,19 +149430,19 @@ correct. a #GtkWidget + line="7973">a #GtkWidget minimum width, or -1 to unset + line="7974">minimum width, or -1 to unset minimum height, or -1 to unset + line="7975">minimum height, or -1 to unset @@ -149453,7 +149453,7 @@ correct. version="2.18"> Sets the visibility state of @widget. Note that setting this to + line="5912">Sets the visibility state of @widget. Note that setting this to %TRUE doesn't mean the widget is actually viewable, see gtk_widget_get_visible(). @@ -149468,13 +149468,13 @@ some condition. a #GtkWidget + line="5914">a #GtkWidget whether the widget should be shown or not + line="5915">whether the widget should be shown or not @@ -149484,7 +149484,7 @@ some condition. version="2.18"> Sets a widget's window. This function should only be used in a + line="11344">Sets a widget's window. This function should only be used in a widget's GtkWidget::realize() implementation. The %window passed is usually either new window created with gdk_window_new(), or the window of its parent widget as returned by @@ -149501,13 +149501,13 @@ widget's init() function. a #GtkWidget + line="11346">a #GtkWidget a #GdkWindow + line="11347">a #GdkWindow @@ -149516,7 +149516,7 @@ widget's init() function. c:identifier="gtk_widget_shape_combine_mask"> Sets a shape for this widget's GDK window. This allows for + line="9402">Sets a shape for this widget's GDK window. This allows for transparent windows etc., see gdk_window_shape_combine_mask() for more information. @@ -149527,7 +149527,7 @@ for more information. a #GtkWidget + line="9404">a #GtkWidget allow-none="1"> shape to be added, or %NULL to remove an existing shape + line="9405">shape to be added, or %NULL to remove an existing shape X position of shape mask with respect to @window + line="9406">X position of shape mask with respect to @window Y position of shape mask with respect to @window + line="9407">Y position of shape mask with respect to @window @@ -149556,7 +149556,7 @@ for more information. Flags a widget to be displayed. Any widget that isn't shown will + line="3217">Flags a widget to be displayed. Any widget that isn't shown will not appear on the screen. If you want to show all the widgets in a container, it's easier to call gtk_widget_show_all() on the container, instead of individually showing the widgets. @@ -149575,7 +149575,7 @@ toplevel container is realized and mapped. a #GtkWidget + line="3219">a #GtkWidget @@ -149583,7 +149583,7 @@ toplevel container is realized and mapped. Recursively shows a widget, and any child widgets (if the widget is + line="3371">Recursively shows a widget, and any child widgets (if the widget is a container). @@ -149593,7 +149593,7 @@ a container). a #GtkWidget + line="3373">a #GtkWidget @@ -149601,7 +149601,7 @@ a container). Shows a widget. If the widget is an unmapped toplevel widget + line="3273">Shows a widget. If the widget is an unmapped toplevel widget (i.e. a #GtkWindow that has not yet been shown), enter the main loop and wait for the window to actually be mapped. Be careful; because the main loop is running, anything can happen during @@ -149614,7 +149614,7 @@ this function. a #GtkWidget + line="3275">a #GtkWidget @@ -149622,7 +149622,7 @@ this function. This function is only used by #GtkContainer subclasses, to assign a size + line="4045">This function is only used by #GtkContainer subclasses, to assign a size and position to their child widgets. @@ -149632,13 +149632,13 @@ and position to their child widgets. a #GtkWidget + line="4047">a #GtkWidget position and size to be allocated to @widget + line="4048">position and size to be allocated to @widget @@ -149646,7 +149646,7 @@ and position to their child widgets. This function is typically used when implementing a #GtkContainer + line="3908">This function is typically used when implementing a #GtkContainer subclass. Obtains the preferred size of a widget. The container uses this information to arrange its child widgets and decide what size allocations to give them with gtk_widget_size_allocate(). @@ -149668,13 +149668,13 @@ See also gtk_widget_get_child_requisition(). a #GtkWidget + line="3910">a #GtkWidget a #GtkRequisition to be filled in + line="3911">a #GtkRequisition to be filled in @@ -149684,7 +149684,7 @@ See also gtk_widget_get_child_requisition(). version="2.20"> This function attaches the widget's #GtkStyle to the widget's + line="6493">This function attaches the widget's #GtkStyle to the widget's #GdkWindow. It is a replacement for <programlisting> @@ -149710,7 +149710,7 @@ implementation which does not chain up to its parent class' introspectable="0"> Gets the values of a multiple style properties of @widget. + line="10023">Gets the values of a multiple style properties of @widget. @@ -149719,19 +149719,19 @@ implementation which does not chain up to its parent class' a #GtkWidget + line="10025">a #GtkWidget the name of the first property to get + line="10026">the name of the first property to get pairs of property names and locations to + line="10027">pairs of property names and locations to return the property values, starting with the location for @first_property_name, terminated by %NULL. @@ -149742,7 +149742,7 @@ implementation which does not chain up to its parent class' c:identifier="gtk_widget_style_get_property"> Gets the value of a style property of @widget. + line="9909">Gets the value of a style property of @widget. @@ -149751,19 +149751,19 @@ implementation which does not chain up to its parent class' a #GtkWidget + line="9911">a #GtkWidget the name of a style property + line="9912">the name of a style property location to return the property value + line="9913">location to return the property value @@ -149773,7 +149773,7 @@ implementation which does not chain up to its parent class' introspectable="0"> Non-vararg variant of gtk_widget_style_get(). Used primarily by language + line="9962">Non-vararg variant of gtk_widget_style_get(). Used primarily by language bindings. @@ -149783,19 +149783,19 @@ bindings. a #GtkWidget + line="9964">a #GtkWidget the name of the first property to get + line="9965">the name of the first property to get a <type>va_list</type> of pairs of property names and + line="9966">a <type>va_list</type> of pairs of property names and locations to return the property values, starting with the location for @first_property_name. @@ -149806,7 +149806,7 @@ bindings. c:identifier="gtk_widget_thaw_child_notify"> Reverts the effect of a previous call to gtk_widget_freeze_child_notify(). + line="2982">Reverts the effect of a previous call to gtk_widget_freeze_child_notify(). This causes all queued #GtkWidget::child-notify signals on @widget to be emitted. @@ -149817,7 +149817,7 @@ emitted. a #GtkWidget + line="2984">a #GtkWidget @@ -149826,7 +149826,7 @@ emitted. c:identifier="gtk_widget_translate_coordinates"> Translate coordinates relative to @src_widget's allocation to coordinates + line="4220">Translate coordinates relative to @src_widget's allocation to coordinates relative to @dest_widget's allocations. In order to perform this operation, both widgets must be realized, and must share a common toplevel. @@ -149834,7 +149834,7 @@ toplevel. %FALSE if either widget was not realized, or there + line="4234">%FALSE if either widget was not realized, or there was no common ancestor. In this case, nothing is stored in *@dest_x and *@dest_y. Otherwise %TRUE. @@ -149843,25 +149843,25 @@ toplevel. a #GtkWidget + line="4222">a #GtkWidget a #GtkWidget + line="4223">a #GtkWidget X position relative to @src_widget + line="4224">X position relative to @src_widget Y position relative to @src_widget + line="4225">Y position relative to @src_widget transfer-ownership="full"> location to store X position relative to @dest_widget + line="4226">location to store X position relative to @dest_widget transfer-ownership="full"> location to store Y position relative to @dest_widget + line="4227">location to store Y position relative to @dest_widget @@ -149889,7 +149889,7 @@ toplevel. version="2.12"> Triggers a tooltip query on the display where the toplevel of @widget + line="11098">Triggers a tooltip query on the display where the toplevel of @widget is located. See gtk_tooltip_trigger_tooltip_query() for more information. @@ -149900,7 +149900,7 @@ information. a #GtkWidget + line="11100">a #GtkWidget @@ -149908,7 +149908,7 @@ information. This function is only for use in widget implementations. Causes + line="3444">This function is only for use in widget implementations. Causes a widget to be unmapped if it's currently mapped. @@ -149918,7 +149918,7 @@ a widget to be unmapped if it's currently mapped. a #GtkWidget + line="3446">a #GtkWidget @@ -149926,7 +149926,7 @@ a widget to be unmapped if it's currently mapped. This function is only for use in widget implementations. + line="3083">This function is only for use in widget implementations. Should be called by implementations of the remove method on #GtkContainer, to dissociate a child from the container. @@ -149937,7 +149937,7 @@ on #GtkContainer, to dissociate a child from the container. a #GtkWidget + line="3085">a #GtkWidget @@ -149945,7 +149945,7 @@ on #GtkContainer, to dissociate a child from the container. This function is only useful in widget implementations. + line="3589">This function is only useful in widget implementations. Causes a widget to be unrealized (frees all GDK resources associated with the widget, such as @widget->window). @@ -149956,7 +149956,7 @@ associated with the widget, such as @widget->window). a #GtkWidget + line="3591">a #GtkWidget @@ -149967,7 +149967,7 @@ associated with the widget, such as @widget->window). deprecated-version="2.12"> Inverse of gtk_widget_ref(). Equivalent to g_object_unref(). + line="9563">Inverse of gtk_widget_ref(). Equivalent to g_object_unref(). Use g_object_unref() instead. @@ -149977,7 +149977,7 @@ associated with the widget, such as @widget->window). a #GtkWidget + line="9565">a #GtkWidget @@ -151876,7 +151876,7 @@ Implementation of this signal is optional. a #GtkWidget + line="3219">a #GtkWidget @@ -151892,7 +151892,7 @@ Implementation of this signal is optional. a #GtkWidget + line="3373">a #GtkWidget @@ -151908,7 +151908,7 @@ Implementation of this signal is optional. a #GtkWidget + line="3309">a #GtkWidget @@ -151924,7 +151924,7 @@ Implementation of this signal is optional. a #GtkWidget + line="3396">a #GtkWidget @@ -151940,7 +151940,7 @@ Implementation of this signal is optional. a #GtkWidget + line="3420">a #GtkWidget @@ -151956,7 +151956,7 @@ Implementation of this signal is optional. a #GtkWidget + line="3446">a #GtkWidget @@ -151972,7 +151972,7 @@ Implementation of this signal is optional. a #GtkWidget + line="3512">a #GtkWidget @@ -151988,7 +151988,7 @@ Implementation of this signal is optional. a #GtkWidget + line="3591">a #GtkWidget @@ -152004,13 +152004,13 @@ Implementation of this signal is optional. a #GtkWidget + line="3910">a #GtkWidget a #GtkRequisition to be filled in + line="3911">a #GtkRequisition to be filled in @@ -152026,13 +152026,13 @@ Implementation of this signal is optional. a #GtkWidget + line="4047">a #GtkWidget position and size to be allocated to @widget + line="4048">position and size to be allocated to @widget @@ -152144,7 +152144,7 @@ Implementation of this signal is optional. a #GtkWidget + line="2941">a #GtkWidget @@ -152159,20 +152159,20 @@ Implementation of this signal is optional. %TRUE if the signal has been handled + line="4708">%TRUE if the signal has been handled a #GtkWidget + line="4699">a #GtkWidget %TRUE if there are other widgets with the same mnemonic + line="4700">%TRUE if there are other widgets with the same mnemonic @@ -152188,7 +152188,7 @@ Implementation of this signal is optional. a #GtkWidget + line="5318">a #GtkWidget @@ -152216,7 +152216,7 @@ Implementation of this signal is optional. return from the event signal emission (%TRUE if + line="4796">return from the event signal emission (%TRUE if the event was handled) @@ -152224,13 +152224,13 @@ Implementation of this signal is optional. a #GtkWidget + line="4784">a #GtkWidget a #GdkEvent + line="4785">a #GdkEvent @@ -152901,14 +152901,14 @@ Implementation of this signal is optional. the #AtkObject associated with @widget + line="10241">the #AtkObject associated with @widget a #GtkWidget + line="10226">a #GtkWidget @@ -152936,20 +152936,20 @@ Implementation of this signal is optional. %TRUE if the accelerator can be activated. + line="4377">%TRUE if the accelerator can be activated. a #GtkWidget + line="4366">a #GtkWidget the ID of a signal installed on @widget + line="4367">the ID of a signal installed on @widget @@ -153038,12 +153038,12 @@ Implementation of this signal is optional. version="2.2"> Finds a style property of a widget class by name. + line="9858">Finds a style property of a widget class by name. the #GParamSpec of the style property or + line="9862">the #GParamSpec of the style property or %NULL if @class has no style property with that name. @@ -153051,13 +153051,13 @@ Implementation of this signal is optional. a #GtkWidgetClass + line="9860">a #GtkWidgetClass the name of the style property to find + line="9861">the name of the style property to find @@ -153066,7 +153066,7 @@ Implementation of this signal is optional. c:identifier="gtk_widget_class_install_style_property"> Installs a style property on a widget class. The parser for the + line="9836">Installs a style property on a widget class. The parser for the style property is determined by the value type of @pspec. @@ -153076,13 +153076,13 @@ style property is determined by the value type of @pspec. a #GtkWidgetClass + line="9838">a #GtkWidgetClass the #GParamSpec for the property + line="9839">the #GParamSpec for the property @@ -153092,7 +153092,7 @@ style property is determined by the value type of @pspec. introspectable="0"> Installs a style property on a widget class. + line="9805">Installs a style property on a widget class. @@ -153101,19 +153101,19 @@ style property is determined by the value type of @pspec. a #GtkWidgetClass + line="9807">a #GtkWidgetClass the #GParamSpec for the style property + line="9808">the #GParamSpec for the style property the parser for the style property + line="9809">the parser for the style property @@ -153123,12 +153123,12 @@ style property is determined by the value type of @pspec. version="2.2"> Returns all style properties of a widget class. + line="9881">Returns all style properties of a widget class. an newly + line="9885">an newly allocated array of #GParamSpec*. The array must be freed with g_free(). @@ -153139,7 +153139,7 @@ style property is determined by the value type of @pspec. a #GtkWidgetClass + line="9883">a #GtkWidgetClass transfer-ownership="full"> location to return the number of style properties found + line="9884">location to return the number of style properties found diff --git a/girs/Gtk-3.0.gir b/girs/Gtk-3.0.gir index 6bce51e21..0e3e86a09 100644 --- a/girs/Gtk-3.0.gir +++ b/girs/Gtk-3.0.gir @@ -1935,6 +1935,10 @@ see gtk_accel_group_connect(). + Signal emitted when an entry is added to or removed + from the accel group. @@ -2455,6 +2459,10 @@ their visual representation if the @accel_closure is theirs. + Signal emitted when an entry is added to or removed + from the accel group. @@ -5623,6 +5631,9 @@ start of the @action_bar. + Signal emitted when the action is activated. @@ -6962,6 +6973,9 @@ notification just before any action is activated. + Looks up an action in the action group by name. @@ -7427,6 +7441,9 @@ as the target.) + virtual function for gtk_actionable_get_action_name() @@ -7446,6 +7463,9 @@ as the target.) + virtual function for gtk_actionable_set_action_name() @@ -7471,6 +7491,9 @@ as the target.) + virtual function for gtk_actionable_get_action_target_value() @@ -7490,6 +7513,9 @@ as the target.) + virtual function for gtk_actionable_set_action_target_value() @@ -7792,6 +7818,11 @@ or unset and by the implementing class when + Called to update the activatable when its related action’s properties change. +You must check the #GtkActivatable:use-action-appearance property only apply action +properties that are meant to effect the appearance accordingly. @@ -8054,6 +8085,11 @@ should be ignored by the #GtkActivatable when this property is %FALSE. + Called to update the activatable when its related action’s properties change. +You must check the #GtkActivatable:use-action-appearance property only apply action +properties that are meant to effect the appearance accordingly. @@ -8074,6 +8110,11 @@ should be ignored by the #GtkActivatable when this property is %FALSE. + Called to update the activatable completely, this is called internally when +#GtkActivatable:related-action property is set or unset and by the implementor when +#GtkActivatable:use-action-appearance changes. @@ -9542,6 +9583,11 @@ that can handle content of the given type. + Signal emitted when a custom item, + previously added with gtk_app_chooser_button_append_custom_item(), + is activated from the dropdown menu. @@ -9875,6 +9921,11 @@ dropdown menu. + Signal emitted when a custom item, + previously added with gtk_app_chooser_button_append_custom_item(), + is activated from the dropdown menu. @@ -10183,6 +10234,10 @@ that can handle content of the given type. + Signal emitted when an application item is + activated from the widget’s list. @@ -10197,6 +10252,10 @@ that can handle content of the given type. + Signal emitted when an application item is + selected from the widget’s list. @@ -10211,6 +10270,10 @@ that can handle content of the given type. + Signal emitted when a context menu is about to + popup over an application item. @@ -10698,6 +10761,10 @@ if at least one item has been added to the menu. + Signal emitted when an application item is + selected from the widget’s list. @@ -10714,6 +10781,10 @@ if at least one item has been added to the menu. + Signal emitted when an application item is + activated from the widget’s list. @@ -10730,6 +10801,10 @@ if at least one item has been added to the menu. + Signal emitted when a context menu is about to + popup over an application item. @@ -10901,6 +10976,10 @@ GTK+ 3.6 or later. + Signal emitted when a #GtkWindow is added to + application through gtk_application_add_window(). @@ -10915,6 +10994,11 @@ GTK+ 3.6 or later. + Signal emitted when a #GtkWindow is removed from + application, either as a side-effect of being destroyed or + explicitly through gtk_application_remove_window(). @@ -11799,6 +11883,10 @@ through gtk_application_remove_window(). + Signal emitted when a #GtkWindow is added to + application through gtk_application_add_window(). @@ -11815,6 +11903,11 @@ through gtk_application_remove_window(). + Signal emitted when a #GtkWindow is removed from + application, either as a side-effect of being destroyed or + explicitly through gtk_application_remove_window(). @@ -12741,6 +12834,9 @@ GtkAssistant has a single CSS node with the name assistant. + Signal emitted when the apply button is clicked. @@ -12752,6 +12848,9 @@ GtkAssistant has a single CSS node with the name assistant. + Signal emitted when the cancel button is clicked. @@ -12763,6 +12862,9 @@ GtkAssistant has a single CSS node with the name assistant. + Signal emitted either when the close button or last page apply button is clicked. @@ -12774,6 +12876,9 @@ GtkAssistant has a single CSS node with the name assistant. + Signal emitted when a new page is set as the assistant’s current page, before making the new page visible. @@ -13701,6 +13806,9 @@ necessary before showing @page. + Signal emitted when a new page is set as the assistant’s current page, before making the new page visible. @@ -13717,6 +13825,9 @@ necessary before showing @page. + Signal emitted when the apply button is clicked. @@ -13730,6 +13841,9 @@ necessary before showing @page. + Signal emitted either when the close button or last page apply button is clicked. @@ -13743,6 +13857,9 @@ necessary before showing @page. + Signal emitted when the cancel button is clicked. @@ -13958,7 +14075,7 @@ container that has been allocated. - + Like gtk_get_binary_age(), but from the headers used at @@ -16563,6 +16680,12 @@ a #GtkBuilder UI definition. + Stores the name attribute given in the GtkBuilder UI definition. + #GtkWidget stores the name as object data. Implement this method if your + object has some notion of “name” and it makes sense to map the XML name + attribute to it. @@ -16585,6 +16708,10 @@ a #GtkBuilder UI definition. + The getter corresponding to @set_name. Implement this + if you implement @set_name. @@ -16604,6 +16731,13 @@ a #GtkBuilder UI definition. + Adds a child. The @type parameter can be used to + differentiate the kind of child. #GtkContainer implements this + to add add a child widget to the container, #GtkNotebook uses + the @type to distinguish between page labels (of type "page-label") + and normal children. @@ -16641,6 +16775,13 @@ a #GtkBuilder UI definition. + Sets a property of a buildable object. + It is normally not necessary to implement this, g_object_set_property() + is used by default. #GtkWindow implements this to delay showing itself + (i.e. setting the #GtkWidget:visible property) until the whole interface + is created. @@ -16675,6 +16816,13 @@ a #GtkBuilder UI definition. + Constructs a child of a buildable that has been + specified as “constructor” in the UI definition. #GtkUIManager implements + this to reference to a widget created in a `<ui>` tag which is outside + of the normal GtkBuilder UI definition hierarchy. A reference to the + constructed object is returned and becomes owned by the caller. @@ -16706,6 +16854,15 @@ a #GtkBuilder UI definition. + Implement this if the buildable needs to parse + content below `<child>`. To handle an element, the implementation + must fill in the @parser and @user_data and return %TRUE. + #GtkWidget implements this to parse keyboard accelerators specified + in `<accelerator>` elements. #GtkContainer implements it to map + properties defined via `<packing>` elements to child properties. + Note that @user_data must be freed in @custom_tag_end or @custom_finished. @@ -16767,6 +16924,10 @@ a #GtkBuilder UI definition. + Called for the end tag of each custom element that is + handled by the buildable (see @custom_tag_start). @@ -16813,6 +16974,10 @@ a #GtkBuilder UI definition. + Called for each custom tag handled by the buildable + when the builder finishes parsing (see @custom_tag_start) @@ -16859,6 +17024,12 @@ a #GtkBuilder UI definition. + Called when a builder finishes the parsing + of a UI definition. It is normally not necessary to implement this, + unless you need to perform special cleanup actions. #GtkWindow sets + the #GtkWidget:visible property here. @@ -16881,6 +17052,13 @@ a #GtkBuilder UI definition. + Returns an internal child of a buildable. + #GtkDialog implements this to give access to its @vbox, making + it possible to add children to the vbox in a UI definition. + Implement this if the buildable has internal children that may + need to be accessed from a UI definition. @@ -18617,6 +18795,11 @@ Pressing Alt and that key activates the button. + Signal that causes the button to animate press then + release. Applications should never connect to this signal, but use + the @clicked signal. @@ -19925,6 +20108,9 @@ contains. + Signal emitted when the button is pressed. Deprecated: 2.8. @@ -19941,6 +20127,9 @@ contains. + Signal emitted when the button is released. Deprecated: 2.8. @@ -19957,6 +20146,9 @@ contains. + Signal emitted when the button has been activated (pressed and released). @@ -19973,6 +20165,9 @@ contains. + Signal emitted when the pointer enters the button. Deprecated: 2.8. @@ -19989,6 +20184,9 @@ contains. + Signal emitted when the pointer leaves the button. Deprecated: 2.8. @@ -20005,6 +20203,11 @@ contains. + Signal that causes the button to animate press then + release. Applications should never connect to this signal, but use + the @clicked signal. @@ -23705,6 +23908,10 @@ allocated rectangle inside @cell_area. + This should be implemented to report the values of + child cell properties for a given child #GtkCellRenderer. @@ -24119,6 +24326,11 @@ the given coordinates. + This should be implemented to handle changes in child + cell properties for a given #GtkCellRenderer that were previously + installed on the #GtkCellAreaClass with gtk_cell_area_class_install_cell_property(). @@ -26350,6 +26562,9 @@ more than its natural size c:type="GInitiallyUnownedClass"/> + adds a #GtkCellRenderer to the area. @@ -26372,6 +26587,9 @@ more than its natural size + removes a #GtkCellRenderer from the area. @@ -26394,6 +26612,10 @@ more than its natural size + calls the #GtkCellCallback function on every #GtkCellRenderer in + the area with the provided user data until the callback returns %TRUE. @@ -26428,6 +26650,11 @@ more than its natural size + Calls the #GtkCellAllocCallback function on every + #GtkCellRenderer in the area with the allocated area for the cell + and the provided user data until the callback returns %TRUE. @@ -26486,6 +26713,11 @@ more than its natural size + Handle an event in the area, this is generally used to activate + a cell at the event location for button events but can also be used + to generically pass events to #GtkWidgets drawn onto the area. @@ -26535,6 +26767,11 @@ more than its natural size + Actually render the area’s cells to the specified rectangle, + @background_area should be correctly distributed to the cells + corresponding background areas. @@ -26593,6 +26830,11 @@ more than its natural size + Apply the cell attributes to the cells. This is + implemented as a signal and generally #GtkCellArea subclasses don't + need to implement it since it is handled by the base class. @@ -26634,6 +26876,11 @@ more than its natural size + Creates and returns a class specific #GtkCellAreaContext + to store cell alignment and allocation details for a said #GtkCellArea + class. @@ -26653,6 +26900,10 @@ more than its natural size + Creates a new #GtkCellAreaContext in the same state as + the passed @context with any cell alignment data and allocations intact. @@ -26678,6 +26929,11 @@ more than its natural size + This allows an area to tell its layouting widget whether + it prefers to be allocated in %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or + %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode. @@ -26697,6 +26953,14 @@ more than its natural size + Calculates the minimum and natural width of the + areas cells with the current attributes applied while considering + the particular layouting details of the said #GtkCellArea. While + requests are performed over a series of rows, alignments and overall + minimum and natural sizes should be stored in the corresponding + #GtkCellAreaContext. @@ -26747,6 +27011,16 @@ more than its natural size + Calculates the minimum and natural height + for the area if the passed @context would be allocated the given width. + When implementing this virtual method it is safe to assume that @context + has already stored the aligned cell widths for every #GtkTreeModel row + that @context will be allocated for since this information was stored + at #GtkCellAreaClass.get_preferred_width() time. This virtual method + should also store any necessary alignments of cell heights for the + case that the context is allocated a height. @@ -26803,6 +27077,12 @@ more than its natural size + Calculates the minimum and natural height of the + areas cells with the current attributes applied. Essentially this is + the same as #GtkCellAreaClass.get_preferred_width() only for areas + that are being requested as %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT. @@ -26853,6 +27133,13 @@ more than its natural size + Calculates the minimum and natural width + for the area if the passed @context would be allocated the given + height. The same as #GtkCellAreaClass.get_preferred_height_for_width() + only for handling requests in the %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT + mode. @@ -26909,6 +27196,11 @@ more than its natural size + This should be implemented to handle changes in child + cell properties for a given #GtkCellRenderer that were previously + installed on the #GtkCellAreaClass with gtk_cell_area_class_install_cell_property(). @@ -26934,6 +27226,10 @@ more than its natural size + This should be implemented to report the values of + child cell properties for a given child #GtkCellRenderer. @@ -26959,6 +27255,16 @@ more than its natural size + This virtual method should be implemented to navigate focus from + cell to cell inside the #GtkCellArea. The #GtkCellArea should move + focus from cell to cell inside the area and return %FALSE if focus + logically leaves the area with the following exceptions: When the + area contains no activatable cells, the entire area recieves focus. + Focus should not be given to cells that are actually “focus siblings” + of other sibling cells (see gtk_cell_area_get_focus_from_sibling()). + Focus is set by calling gtk_cell_area_set_focus_cell(). @@ -26984,6 +27290,13 @@ more than its natural size + Returns whether the #GtkCellArea can respond to + #GtkCellAreaClass.activate(), usually this does not need to be + implemented since the base class takes care of this however it can + be enhanced if the #GtkCellArea subclass can handle activation in + other ways than activating its #GtkCellRenderers. @@ -27003,6 +27316,10 @@ more than its natural size + This is called when the layouting widget rendering the + #GtkCellArea activates the focus cell (see gtk_cell_area_get_focus_cell()). @@ -27924,6 +28241,12 @@ for using gtk_cell_area_get_preferred_width(). + This tells the context that an allocation width or height + (or both) have been decided for a group of rows. The context should + store any allocations for internally aligned cells at this point so + that they dont need to be recalculated at gtk_cell_area_render() time. @@ -27954,6 +28277,10 @@ for using gtk_cell_area_get_preferred_width(). + Clear any previously stored information about requested and + allocated sizes for the context. @@ -27970,6 +28297,10 @@ for using gtk_cell_area_get_preferred_width(). + Returns the aligned height for the given + width that context must store while collecting sizes for it’s rows. @@ -28016,6 +28347,10 @@ for using gtk_cell_area_get_preferred_width(). + Returns the aligned width for the given + height that context must store while collecting sizes for it’s rows. @@ -28365,6 +28700,10 @@ for emitting #GtkCellEditable::remove-widget. + Signal is a sign for the cell renderer to update its + value from the cell_editable. @@ -28381,6 +28720,10 @@ for emitting #GtkCellEditable::remove-widget. + Signal is meant to indicate that the cell is + finished editing, and the widget may now be destroyed. @@ -28397,6 +28740,9 @@ for emitting #GtkCellEditable::remove-widget. + Begins editing on a cell_editable. @@ -29217,6 +29563,9 @@ as appropriate. + Packs the cell into the beginning of cell_layout. @@ -29245,6 +29594,9 @@ as appropriate. + Adds the cell to the end of cell_layout. @@ -29273,6 +29625,10 @@ as appropriate. + Unsets all the mappings on all renderers on cell_layout and + removes all renderers from cell_layout. @@ -29289,6 +29645,10 @@ as appropriate. + Adds an attribute mapping to the list in + cell_layout. @@ -29323,6 +29683,10 @@ as appropriate. + Sets the #GtkCellLayoutDataFunc to use for + cell_layout. @@ -29372,6 +29736,10 @@ as appropriate. + Clears all existing attributes previously set + with gtk_cell_layout_set_attributes(). @@ -29394,6 +29762,9 @@ as appropriate. + Re-inserts cell at position. @@ -29422,6 +29793,10 @@ as appropriate. + Get the cell renderers which have been added to + cell_layout. @@ -29446,6 +29821,11 @@ as appropriate. + Get the underlying #GtkCellArea which might be + cell_layout if called on a #GtkCellArea or might be NULL if no + #GtkCellArea is used by cell_layout. @@ -29572,6 +29952,9 @@ toggles when it gets a mouse click. + Signal gets emitted when the user cancels the process of editing a cell. @@ -29583,6 +29966,9 @@ toggles when it gets a mouse click. + Signal gets emitted when a cell starts to be edited. @@ -31541,6 +31927,10 @@ in the same way as they are in menus. c:type="GInitiallyUnownedClass"/> + Called to gets whether the cell renderer prefers + a height-for-width layout or a width-for-height layout. @@ -31560,6 +31950,9 @@ in the same way as they are in menus. + Called to get a renderer’s natural width. @@ -31604,6 +31997,9 @@ in the same way as they are in menus. + Called to get a renderer’s natural height for width. @@ -31654,6 +32050,9 @@ in the same way as they are in menus. + Called to get a renderer’s natural height. @@ -31698,6 +32097,9 @@ in the same way as they are in menus. + Called to get a renderer’s natural width for height. @@ -31748,6 +32150,9 @@ in the same way as they are in menus. + Called to get the aligned area used by @cell inside @cell_area. @@ -31792,6 +32197,9 @@ in the same way as they are in menus. + Called to get the width and height needed to render the cell. Deprecated: 3.0. @@ -31867,6 +32275,9 @@ in the same way as they are in menus. + Called to render the content of the #GtkCellRenderer. @@ -31914,6 +32325,9 @@ in the same way as they are in menus. + Called to activate the content of the #GtkCellRenderer. @@ -31970,6 +32384,9 @@ in the same way as they are in menus. + Called to initiate editing the content of the #GtkCellRenderer. @@ -32030,6 +32447,9 @@ in the same way as they are in menus. + Signal gets emitted when the user cancels the process of editing a cell. @@ -32043,6 +32463,9 @@ in the same way as they are in menus. + Signal gets emitted when a cell starts to be edited. @@ -34734,6 +35157,9 @@ in @label indicate the mnemonic for the menu item. + Called to draw the check indicator. @@ -35022,6 +35448,9 @@ to discover the new state. + Signal emitted when the state of the check box is changed. @@ -35038,6 +35467,9 @@ to discover the new state. + Called to draw the check indicator. @@ -39002,6 +39434,9 @@ and with the model initialized to @model. + Signal is emitted when the active item is changed. @@ -39013,6 +39448,10 @@ and with the model initialized to @model. + Signal which allows you to change how the text + displayed in a combo box’s entry is displayed. @@ -40373,6 +40812,9 @@ The default binding for this signal is Alt+Down. + Signal is emitted when the active item is changed. @@ -40386,6 +40828,10 @@ The default binding for this signal is Alt+Down. + Signal which allows you to change how the text + displayed in a combo box’s entry is displayed. @@ -41112,6 +41558,9 @@ container. + Signal emitted when a size recalculation is needed. @@ -41147,6 +41596,9 @@ children. + Gets a widget’s composite name. Deprecated: 3.10. @@ -41206,6 +41658,9 @@ than gtk_container_forall(). + Get a property from a child of container. @@ -41287,6 +41742,9 @@ container and help break any circular reference count cycles. + Set a property on a child of container. @@ -42655,6 +43113,9 @@ or executed immediately. + Signal emitted when a widget is added to container. @@ -42677,6 +43138,9 @@ or executed immediately. + Signal emitted when a widget is removed from container. @@ -42699,6 +43163,9 @@ or executed immediately. + Signal emitted when a size recalculation is needed. @@ -42712,6 +43179,10 @@ or executed immediately. + Invokes callback on each child of container. The callback handler + may remove the child. @@ -42749,6 +43220,9 @@ or executed immediately. + Sets the focused child of container. @@ -42774,6 +43248,9 @@ or executed immediately. + Returns the type of the children supported by the container. @@ -42793,6 +43270,9 @@ or executed immediately. + Gets a widget’s composite name. Deprecated: 3.10. @@ -42809,6 +43289,9 @@ or executed immediately. + Set a property on a child of container. @@ -42834,6 +43317,9 @@ or executed immediately. + Get a property from a child of container. @@ -42859,6 +43345,10 @@ or executed immediately. + Get path representing entire widget hierarchy + from the toplevel down to and including @child. @@ -44508,6 +44998,9 @@ Here’s a simple example: + Signal emitted when the user uses a keybinding to close the dialog. @@ -45108,6 +45601,9 @@ Otherwise, it depends on which action widget was clicked. + Signal emitted when an action widget is activated. @@ -45130,6 +45626,9 @@ Otherwise, it depends on which action widget was clicked. + Signal emitted when the user uses a keybinding to close the dialog. @@ -47065,6 +47564,11 @@ just a single handle for the text cursor, it gets the style class + Class handler for the #GtkEntry::activate signal. The default + implementation calls gtk_window_activate_default() on the entry’s top-level + window. @@ -47076,6 +47580,10 @@ just a single handle for the text cursor, it gets the style class + Class handler for the #GtkEntry::backspace signal. The default + implementation deletes the selection or a single character or word. @@ -47087,6 +47595,10 @@ just a single handle for the text cursor, it gets the style class + Class handler for the #GtkEntry::copy-clipboard signal. The + default implementation copies the selection, if one exists. @@ -47098,6 +47610,10 @@ just a single handle for the text cursor, it gets the style class + Class handler for the #GtkEntry::cut-clipboard signal. The + default implementation cuts the selection, if one exists. @@ -47109,6 +47625,11 @@ just a single handle for the text cursor, it gets the style class + Class handler for the #GtkEntry::delete-from-cursor + signal. The default implementation deletes the selection or the specified + number of characters or words. @@ -47126,6 +47647,12 @@ just a single handle for the text cursor, it gets the style class + Calculate the size of the text area frame, which is its + allocated width and requested height, minus space for margins and borders, + and taking baseline and text height into account. This virtual function + must be non-%NULL. @@ -47149,6 +47676,11 @@ just a single handle for the text cursor, it gets the style class + Calculate the size of the text area, which is its + allocated width and requested height, minus space for margins and borders. + This virtual function must be non-%NULL. @@ -47172,6 +47704,10 @@ just a single handle for the text cursor, it gets the style class + Class handler for the #GtkEntry::insert-at-cursor signal. + The default implementation inserts text at the cursor. @@ -47197,6 +47733,11 @@ just a single handle for the text cursor, it gets the style class + Class handler for the #GtkEntry::move-cursor signal. The + default implementation specifies the standard #GtkEntry cursor movement + behavior. @@ -47217,6 +47758,11 @@ just a single handle for the text cursor, it gets the style class + Class handler for the #GtkEntry::paste-clipboard signal. + The default implementation pastes at the current cursor position or over + the current selection if one exists. @@ -47228,6 +47774,11 @@ just a single handle for the text cursor, it gets the style class + Class handler for the #GtkEntry::populate-popup signal. If + non-%NULL, this will be called to add additional entries to the context + menu when it is displayed. @@ -47242,6 +47793,10 @@ just a single handle for the text cursor, it gets the style class + Class handler for the #GtkEntry::toggle-overwrite signal. + The default implementation toggles overwrite mode and blinks the cursor. @@ -51214,6 +51769,11 @@ a custom one. + Class handler for the #GtkEntry::populate-popup signal. If + non-%NULL, this will be called to add additional entries to the context + menu when it is displayed. @@ -51230,6 +51790,11 @@ a custom one. + Class handler for the #GtkEntry::activate signal. The default + implementation calls gtk_window_activate_default() on the entry’s top-level + window. @@ -51243,6 +51808,11 @@ a custom one. + Class handler for the #GtkEntry::move-cursor signal. The + default implementation specifies the standard #GtkEntry cursor movement + behavior. @@ -51265,6 +51835,10 @@ a custom one. + Class handler for the #GtkEntry::insert-at-cursor signal. + The default implementation inserts text at the cursor. @@ -51281,6 +51855,11 @@ a custom one. + Class handler for the #GtkEntry::delete-from-cursor + signal. The default implementation deletes the selection or the specified + number of characters or words. @@ -51300,6 +51879,10 @@ a custom one. + Class handler for the #GtkEntry::backspace signal. The default + implementation deletes the selection or a single character or word. @@ -51313,6 +51896,10 @@ a custom one. + Class handler for the #GtkEntry::cut-clipboard signal. The + default implementation cuts the selection, if one exists. @@ -51326,6 +51913,10 @@ a custom one. + Class handler for the #GtkEntry::copy-clipboard signal. The + default implementation copies the selection, if one exists. @@ -51339,6 +51930,11 @@ a custom one. + Class handler for the #GtkEntry::paste-clipboard signal. + The default implementation pastes at the current cursor position or over + the current selection if one exists. @@ -51352,6 +51948,10 @@ a custom one. + Class handler for the #GtkEntry::toggle-overwrite signal. + The default implementation toggles overwrite mode and blinks the cursor. @@ -51365,6 +51965,11 @@ a custom one. + Calculate the size of the text area, which is its + allocated width and requested height, minus space for margins and borders. + This virtual function must be non-%NULL. @@ -51390,6 +51995,12 @@ a custom one. + Calculate the size of the text area frame, which is its + allocated width and requested height, minus space for margins and borders, + and taking baseline and text height into account. This virtual function + must be non-%NULL. @@ -53917,6 +54528,9 @@ Pressing Alt and that key activates the button. + Keybinding signal is emitted when the user hits the Enter key. @@ -54510,6 +55124,9 @@ expander is expanded. + Keybinding signal is emitted when the user hits the Enter key. @@ -57536,6 +58153,9 @@ order for the button to take over the file selected in the dialog. + Signal emitted when the user selects a file. @@ -57768,6 +58388,9 @@ changes the file. + Signal emitted when the user selects a file. @@ -64929,6 +65552,9 @@ you should use the #GtkGLArea::create-context signal. + class closure for the #GtkGLArea::create-context signal @@ -64940,6 +65566,9 @@ you should use the #GtkGLArea::create-context signal. + class closure for the #GtkGLArea::render signal @@ -64954,6 +65583,9 @@ you should use the #GtkGLArea::create-context signal. + class closeure for the #GtkGLArea::resize signal @@ -65638,6 +66270,9 @@ The default handler sets up the GL viewport. + class closure for the #GtkGLArea::render signal @@ -65654,6 +66289,9 @@ The default handler sets up the GL viewport. + class closeure for the #GtkGLArea::resize signal @@ -65673,6 +66311,9 @@ The default handler sets up the GL viewport. + class closure for the #GtkGLArea::create-context signal @@ -70133,6 +70774,10 @@ so the snap edge should be set to %GTK_POS_BOTTOM. + Signal emitted when the contents of the handlebox + are reattached to the main window. Deprecated: 3.4. @@ -70147,6 +70792,10 @@ so the snap edge should be set to %GTK_POS_BOTTOM. + Signal emitted when the contents of the handlebox + are detached from the main window. Deprecated: 3.4. @@ -70465,6 +71114,10 @@ handlebox are detached from the main window. + Signal emitted when the contents of the handlebox + are reattached to the main window. Deprecated: 3.4. @@ -70481,6 +71134,10 @@ handlebox are detached from the main window. + Signal emitted when the contents of the handlebox + are detached from the main window. Deprecated: 3.4. @@ -71460,6 +72117,9 @@ regenerated by [gtk-query-immodules-3.0][gtk-query-immodules-3.0], in order for the new input method to become available to GTK+ applications. + Default handler of the #GtkIMContext::commit signal. @@ -71695,6 +72355,10 @@ methods must be prepared to function without context. + Default handler of the #GtkIMContext::preedit-changed + signal. @@ -71706,6 +72370,9 @@ methods must be prepared to function without context. + Default handler of the #GtkIMContext::preedit-end signal. @@ -71717,6 +72384,9 @@ methods must be prepared to function without context. + Default handler of the #GtkIMContext::preedit-start signal. @@ -71747,6 +72417,10 @@ method to clear the preedit state. + Default handler of the + #GtkIMContext::retrieve-surrounding signal. @@ -72360,6 +73034,9 @@ gtk_im_context_set_surrounding() method. + Default handler of the #GtkIMContext::preedit-start signal. @@ -72373,6 +73050,9 @@ gtk_im_context_set_surrounding() method. + Default handler of the #GtkIMContext::preedit-end signal. @@ -72386,6 +73066,10 @@ gtk_im_context_set_surrounding() method. + Default handler of the #GtkIMContext::preedit-changed + signal. @@ -72399,6 +73083,9 @@ gtk_im_context_set_surrounding() method. + Default handler of the #GtkIMContext::commit signal. @@ -72415,6 +73102,10 @@ gtk_im_context_set_surrounding() method. + Default handler of the + #GtkIMContext::retrieve-surrounding signal. @@ -72428,6 +73119,10 @@ gtk_im_context_set_surrounding() method. + Default handler of the + #GtkIMContext::delete-surrounding signal. @@ -72460,6 +73155,12 @@ gtk_im_context_set_surrounding() method. + Called via gtk_im_context_set_client_window() when the + input window where the entered text will appear changes. Override this to + keep track of the current input window, for instance for the purpose of + positioning a status display of your input method. @@ -72486,6 +73187,13 @@ gtk_im_context_set_surrounding() method. + Called via gtk_im_context_get_preedit_string() to + retrieve the text currently being preedited for display at the cursor + position. Any input method which composes complex characters or any + other compositions from multiple sequential key presses should override + this method to provide feedback. @@ -72533,6 +73241,18 @@ gtk_im_context_set_surrounding() method. + Called via gtk_im_context_filter_keypress() on every + key press or release event. Every non-trivial input method needs to + override this in order to implement the mapping from key events to text. + A return value of %TRUE indicates to the caller that the event was + consumed by the input method. In that case, the #GtkIMContext::commit + signal should be emitted upon completion of a key sequence to pass the + resulting text back to the input widget. Alternatively, %FALSE may be + returned to indicate that the event wasn’t handled by the input method. + If a builtin mapping exists for the key, it is used to produce a + character. @@ -72558,6 +73278,10 @@ gtk_im_context_set_surrounding() method. + Called via gtk_im_context_focus_in() when the input widget + has gained focus. May be overridden to keep track of the current focus. @@ -72574,6 +73298,10 @@ gtk_im_context_set_surrounding() method. + Called via gtk_im_context_focus_out() when the input widget + has lost focus. May be overridden to keep track of the current focus. @@ -72590,6 +73318,11 @@ gtk_im_context_set_surrounding() method. + Called via gtk_im_context_reset() to signal a change such as a + change in cursor position. An input method that implements preediting + should override this method to clear the preedit state on reset. @@ -72606,6 +73339,12 @@ gtk_im_context_set_surrounding() method. + Called via gtk_im_context_set_cursor_location() + to inform the input method of the current cursor location relative to + the client window. May be overridden to implement the display of popup + windows at the cursor position. @@ -72628,6 +73367,11 @@ gtk_im_context_set_surrounding() method. + Called via gtk_im_context_set_use_preedit() to control + the use of the preedit string. Override this to display feedback by some + other means if turned off. @@ -72650,6 +73394,14 @@ gtk_im_context_set_surrounding() method. + Called via gtk_im_context_set_surrounding() in response + to signal #GtkIMContext::retrieve-surrounding to update the input + method’s idea of the context around the cursor. It is not necessary to + override this method even with input methods which implement + context-dependent behavior. The base implementation is sufficient for + gtk_im_context_get_surrounding() to work. @@ -72686,6 +73438,14 @@ gtk_im_context_set_surrounding() method. + Called via gtk_im_context_get_surrounding() to update + the context around the cursor location. It is not necessary to override + this method even with input methods which implement context-dependent + behavior. The base implementation emits + #GtkIMContext::retrieve-surrounding and records the context received + by the subsequent invocation of @get_surrounding. @@ -79009,7 +79769,8 @@ This behaviour may change in the future. + throws="1" + glib:async-func="load_icon_async"> Renders an icon previously looked up in an icon theme using @@ -79044,7 +79805,9 @@ returned by this function will be scaled to the exact size. + version="3.8" + glib:finish-func="load_icon_finish" + glib:sync-func="load_icon"> Asynchronously load, render and scale an icon previously looked up @@ -79175,7 +79938,8 @@ returned by this function will be scaled to the exact size. + throws="1" + glib:async-func="load_symbolic_async"> Loads an icon, modifying it to match the system colours for the foreground, @@ -79261,7 +80025,9 @@ for more information about symbolic icons. + version="3.8" + glib:finish-func="load_symbolic_finish" + glib:sync-func="load_symbolic"> Asynchronously load, render and scale a symbolic icon previously looked up @@ -79397,7 +80163,8 @@ version of this call. + throws="1" + glib:async-func="load_symbolic_for_context_async"> Loads an icon, modifying it to match the system colors for the foreground, @@ -79447,7 +80214,9 @@ See gtk_icon_info_load_symbolic() for more details. + version="3.8" + glib:finish-func="load_symbolic_for_context_finish" + glib:sync-func="load_symbolic_for_context"> Asynchronously load, render and scale a symbolic icon previously @@ -81318,6 +82087,11 @@ a single icon theme object will be shared between users. + Signal emitted when the current icon theme is switched or + GTK+ detects that a change has occurred in the contents of the + current icon theme. @@ -82286,6 +83060,11 @@ icon theme. + Signal emitted when the current icon theme is switched or + GTK+ detects that a change has occurred in the contents of the + current icon theme. @@ -92385,6 +93164,9 @@ it from a plain #GtkButton, it gets the .link style class. + class handler for the #GtkLinkButton::activate-link signal @@ -92597,6 +93379,9 @@ private data. + class handler for the #GtkLinkButton::activate-link signal @@ -92711,6 +93496,9 @@ style class added when appropriate. + Class handler for the #GtkListBox::activate-cursor-row signal @@ -92722,6 +93510,9 @@ style class added when appropriate. + Class handler for the #GtkListBox::move-cursor signal @@ -92739,6 +93530,9 @@ style class added when appropriate. + Class handler for the #GtkListBox::row-activated signal @@ -92753,6 +93547,9 @@ style class added when appropriate. + Class handler for the #GtkListBox::row-selected signal @@ -92784,6 +93581,9 @@ style class added when appropriate. + Class handler for the #GtkListBox::selected-rows-changed signal @@ -92795,6 +93595,9 @@ style class added when appropriate. + Class handler for the #GtkListBox::toggle-cursor-row signal @@ -93835,6 +94638,9 @@ The default bindings for this signal is Ctrl-Shift-a. + Class handler for the #GtkListBox::row-selected signal @@ -93851,6 +94657,9 @@ The default bindings for this signal is Ctrl-Shift-a. + Class handler for the #GtkListBox::row-activated signal @@ -93867,6 +94676,9 @@ The default bindings for this signal is Ctrl-Shift-a. + Class handler for the #GtkListBox::activate-cursor-row signal @@ -93880,6 +94692,9 @@ The default bindings for this signal is Ctrl-Shift-a. + Class handler for the #GtkListBox::toggle-cursor-row signal @@ -93893,6 +94708,9 @@ The default bindings for this signal is Ctrl-Shift-a. + Class handler for the #GtkListBox::move-cursor signal @@ -93912,6 +94730,9 @@ The default bindings for this signal is Ctrl-Shift-a. + Class handler for the #GtkListBox::selected-rows-changed signal @@ -93925,6 +94746,9 @@ The default bindings for this signal is Ctrl-Shift-a. + Class handler for the #GtkListBox::select-all signal @@ -93941,6 +94765,9 @@ The default bindings for this signal is Ctrl-Shift-a. + Class handler for the #GtkListBox::unselect-all signal @@ -96114,7 +96941,7 @@ against at application run time. - + Like gtk_get_micro_version(), but from the headers used at @@ -98792,6 +99619,10 @@ so underscores in @label indicate the mnemonic for the menu item. + Signal emitted when the item is activated, but also + if the menu item has a submenu. @@ -99547,6 +100378,9 @@ submenu. For normal applications, the relevant signal is + Signal emitted when the item is activated. @@ -99563,6 +100397,10 @@ submenu. For normal applications, the relevant signal is + Signal emitted when the item is activated, but also + if the menu item has a submenu. @@ -99623,6 +100461,9 @@ submenu. For normal applications, the relevant signal is + Sets @text on the #GtkMenuItem label @@ -99645,6 +100486,9 @@ submenu. For normal applications, the relevant signal is + Gets @text from the #GtkMenuItem label @@ -99665,6 +100509,9 @@ submenu. For normal applications, the relevant signal is + Signal emitted when the item is selected. @@ -99681,6 +100528,9 @@ submenu. For normal applications, the relevant signal is + Signal emitted when the item is deselected. @@ -100908,6 +101758,9 @@ the stock item indicated by @stock_id. + Signal emitted before the menu is shown. @@ -101063,6 +101916,9 @@ since the arrow is made insensitive if the menu is not set. + Signal emitted before the menu is shown. @@ -102119,12 +102975,12 @@ subnode is invisible in this case. version="3.16"> Creates a new GtkModelButton. + line="1320">Creates a new GtkModelButton. the newly created #GtkModelButton widget + line="1325">the newly created #GtkModelButton widget @@ -102135,7 +102991,7 @@ subnode is invisible in this case. default-value="FALSE"> The state of the button. This is reflecting the state of the associated + line="1203">The state of the button. This is reflecting the state of the associated #GAction. @@ -102146,7 +103002,7 @@ subnode is invisible in this case. default-value="FALSE"> Whether to render the button contents centered instead of left-aligned. + line="1249">Whether to render the button contents centered instead of left-aligned. This property should be set for title-like items. @@ -102156,7 +103012,7 @@ This property should be set for title-like items. transfer-ownership="none"> A #GIcon that will be used if iconic appearance for the button is + line="1158">A #GIcon that will be used if iconic appearance for the button is desired. @@ -102167,7 +103023,7 @@ desired. default-value="FALSE"> If this property is set, the button will show an icon if one is set. + line="1264">If this property is set, the button will show an icon if one is set. If no icon is set, the text will be used. This is typically used for horizontal sections of linked buttons. @@ -102179,7 +103035,7 @@ horizontal sections of linked buttons. default-value="FALSE"> Whether to show the submenu indicator at the opposite side than normal. + line="1233">Whether to show the submenu indicator at the opposite side than normal. This property should be set for model buttons that 'go back' to a parent menu. @@ -102191,7 +103047,7 @@ menu. default-value="NULL"> The name of a submenu to open when the button is activated. + line="1218">The name of a submenu to open when the button is activated. If this is set, the button should not have an action associated with it. @@ -102202,7 +103058,7 @@ If this is set, the button should not have an action associated with it. default-value="GTK_BUTTON_ROLE_NORMAL"> Specifies whether the button is a plain, check or radio button. + line="1141">Specifies whether the button is a plain, check or radio button. When #GtkActionable:action-name is set, the role will be determined from the action and does not have to be set explicitly. @@ -102213,7 +103069,7 @@ from the action and does not have to be set explicitly. transfer-ownership="none"> The label for the button. + line="1173">The label for the button. default-value="FALSE"> If %TRUE, XML tags in the text of the button are interpreted as by + line="1187">If %TRUE, XML tags in the text of the button are interpreted as by pango_parse_markup() to format the enclosed spans of text. If %FALSE, the text will be displayed verbatim. @@ -106501,6 +107357,10 @@ whose alignments cause them to be positioned at an edge get the style classes + Signal emitted to determine the position and + size of any overlay child widgets. @@ -106707,6 +107567,10 @@ to its contents. + Signal emitted to determine the position and + size of any overlay child widgets. @@ -113640,6 +114504,10 @@ are useful when implementing a print preview. + Signal emitted after the user has finished changing + print settings in the dialog, before the actual rendering starts. @@ -113654,6 +114522,9 @@ are useful when implementing a print preview. + Signal emitted when displaying the print dialog. @@ -113665,6 +114536,10 @@ are useful when implementing a print preview. + Signal emitted right before “begin-print” if + you added a custom widget in the “create-custom-widget” handler. @@ -113679,6 +114554,10 @@ are useful when implementing a print preview. + Signal emitted when the print operation run has finished + doing everything required for printing. @@ -113694,6 +114573,9 @@ are useful when implementing a print preview. + Signal emitted for every page that is printed. @@ -113711,6 +114593,9 @@ are useful when implementing a print preview. + Signal emitted after all pages have been rendered. @@ -113725,6 +114610,10 @@ are useful when implementing a print preview. + Signal emitted after the “begin-print” signal, but + before the actual rendering starts. @@ -113739,6 +114628,10 @@ are useful when implementing a print preview. + Signal emitted when a preview is requested from the + native dialog. @@ -113760,6 +114653,10 @@ are useful when implementing a print preview. + Emitted once for every page that is printed, + to give the application a chance to modify the page setup. @@ -113780,6 +114677,10 @@ are useful when implementing a print preview. + Emitted at between the various phases of the print + operation. @@ -113791,6 +114692,9 @@ are useful when implementing a print preview. + Emitted after change of selected printer. @@ -115350,6 +116254,10 @@ determines what action the print operation should perform. + Signal emitted when the print operation run has finished + doing everything required for printing. @@ -115367,6 +116275,10 @@ determines what action the print operation should perform. + Signal emitted after the user has finished changing + print settings in the dialog, before the actual rendering starts. @@ -115383,6 +116295,10 @@ determines what action the print operation should perform. + Signal emitted after the “begin-print” signal, but + before the actual rendering starts. @@ -115399,6 +116315,10 @@ determines what action the print operation should perform. + Emitted once for every page that is printed, + to give the application a chance to modify the page setup. @@ -115421,6 +116341,9 @@ determines what action the print operation should perform. + Signal emitted for every page that is printed. @@ -115440,6 +116363,9 @@ determines what action the print operation should perform. + Signal emitted after all pages have been rendered. @@ -115456,6 +116382,10 @@ determines what action the print operation should perform. + Emitted at between the various phases of the print + operation. @@ -115469,6 +116399,9 @@ determines what action the print operation should perform. + Signal emitted when displaying the print dialog. @@ -115482,6 +116415,10 @@ determines what action the print operation should perform. + Signal emitted right before “begin-print” if + you added a custom widget in the “create-custom-widget” handler. @@ -115498,6 +116435,10 @@ determines what action the print operation should perform. + Signal emitted when a preview is requested from the + native dialog. @@ -115521,6 +116462,9 @@ determines what action the print operation should perform. + Emitted after change of selected printer. @@ -123719,6 +124663,9 @@ The return value of this function is affected by the “sort-type” and + Gets the #GtkRecentManager used by chooser. @@ -123730,6 +124677,10 @@ The return value of this function is affected by the “sort-type” and + Signal emitted when the user “activates” a recent + item in the recent chooser. @@ -123839,6 +124790,10 @@ multiple selection. + Signal emitted when there is a change in the + set of selected recently used resources. @@ -125221,6 +126176,9 @@ have a customized instance of a #GtkRecentManager object. + Sets uri as the current URI for chooser. @@ -125246,6 +126204,9 @@ have a customized instance of a #GtkRecentManager object. + Gets the URI currently selected by chooser. @@ -125265,6 +126226,9 @@ have a customized instance of a #GtkRecentManager object. + Selects uri inside chooser. @@ -125290,6 +126254,9 @@ have a customized instance of a #GtkRecentManager object. + Unselects uri inside chooser. @@ -125312,6 +126279,10 @@ have a customized instance of a #GtkRecentManager object. + Selects all the items inside chooser, if the chooser + supports multiple selection. @@ -125328,6 +126299,9 @@ have a customized instance of a #GtkRecentManager object. + Unselects all the items inside chooser. @@ -125344,6 +126318,10 @@ have a customized instance of a #GtkRecentManager object. + Gets the list of recently used resources in form of + #GtkRecentInfo objects. @@ -125368,6 +126346,9 @@ have a customized instance of a #GtkRecentManager object. + Gets the #GtkRecentManager used by chooser. @@ -125381,6 +126362,10 @@ have a customized instance of a #GtkRecentManager object. + Adds filter to the list of #GtkRecentFilter objects + held by chooser. @@ -125403,6 +126388,10 @@ have a customized instance of a #GtkRecentManager object. + Removes filter from the list of #GtkRecentFilter + objects held by chooser. @@ -125425,6 +126414,9 @@ have a customized instance of a #GtkRecentManager object. + Gets the #GtkRecentFilter objects held by chooser. @@ -125448,6 +126440,10 @@ have a customized instance of a #GtkRecentManager object. + Sets the comparison function used when sorting to + be sort_func. @@ -125493,6 +126489,10 @@ have a customized instance of a #GtkRecentManager object. + Signal emitted when the user “activates” a recent + item in the recent chooser. @@ -125506,6 +126506,10 @@ have a customized instance of a #GtkRecentManager object. + Signal emitted when there is a change in the + set of selected recently used resources. @@ -126545,7 +127549,7 @@ was added to the recently used resources list. filename="gtk/gtkrecentmanager.c" line="1683">the number of seconds elapsed from system’s Epoch when the resource was added to the list, or -1 on failure. - + @@ -126640,7 +127644,7 @@ storage specification, they will be expanded. filename="gtk/gtkrecentmanager.c" line="1792">return location for the timestamp this item was last registered for this application - + @@ -126855,7 +127859,7 @@ for the resource was last modified. filename="gtk/gtkrecentmanager.c" line="1703">the number of seconds elapsed from system’s Epoch when the resource was last modified, or -1 on failure. - + @@ -126977,7 +127981,7 @@ for the resource was last visited. filename="gtk/gtkrecentmanager.c" line="1723">the number of seconds elapsed from system’s Epoch when the resource was last visited, or -1 on failure. - + @@ -134227,6 +135231,10 @@ will cause the scrolled window to create them for you. + Keybinding signal which gets emitted when focus is + moved away from the scrolled window by a keybinding. @@ -134241,6 +135249,10 @@ will cause the scrolled window to create them for you. + Keybinding signal which gets emitted when a + keybinding that scrolls is pressed. @@ -135454,6 +136466,10 @@ signal that the scrolled window’s child may listen to and scroll itself. + Keybinding signal which gets emitted when a + keybinding that scrolls is pressed. @@ -135473,6 +136489,10 @@ signal that the scrolled window’s child may listen to and scroll itself. + Keybinding signal which gets emitted when focus is + moved away from the scrolled window by a keybinding. @@ -150962,6 +151982,9 @@ the widget represented by @path. + Gets a set of style information that applies to a widget path. @@ -150988,6 +152011,9 @@ style settings affecting @path + Gets the value of a widget style property that applies to a widget path. @@ -151034,6 +152060,9 @@ style settings affecting @path + Gets the icon factory that applies to a widget path. @@ -151102,6 +152131,9 @@ named slider. Neither of them is using any style classes. + An action signal and emitting it causes the switch to animate. @@ -151113,6 +152145,9 @@ named slider. Neither of them is using any style classes. + Class handler for the ::state-set signal. @@ -151346,6 +152381,9 @@ position of the switch. + An action signal and emitting it causes the switch to animate. @@ -151359,6 +152397,9 @@ position of the switch. + Class handler for the ::state-set signal. @@ -154508,6 +155549,9 @@ single call to one of those functions. + The class handler for the #GtkTextBuffer::changed signal. @@ -154519,6 +155563,9 @@ single call to one of those functions. + The class handler for the #GtkTextBuffer::delete-range signal. @@ -154629,6 +155676,9 @@ gtk_text_buffer_get_text(). + The class handler for the #GtkTextBuffer::insert-text signal. @@ -154649,6 +155699,9 @@ gtk_text_buffer_get_text(). + The class handler for the #GtkTextBuffer::mark-deleted signal. @@ -154663,6 +155716,9 @@ gtk_text_buffer_get_text(). + The class handler for the #GtkTextBuffer::mark-set signal. @@ -154680,6 +155736,10 @@ gtk_text_buffer_get_text(). + The class handler for the #GtkTextBuffer::modified-changed + signal. @@ -154691,6 +155751,9 @@ gtk_text_buffer_get_text(). + The class handler for the #GtkTextBuffer::paste-done signal. @@ -157832,6 +158895,9 @@ gtk_text_buffer_remove_tag(). + The class handler for the #GtkTextBuffer::insert-text signal. @@ -157854,6 +158920,10 @@ gtk_text_buffer_remove_tag(). + The class handler for the #GtkTextBuffer::insert-pixbuf + signal. @@ -157882,6 +158952,10 @@ gtk_text_buffer_remove_tag(). + The class handler for the + #GtkTextBuffer::insert-child-anchor signal. @@ -157910,6 +158984,9 @@ gtk_text_buffer_remove_tag(). + The class handler for the #GtkTextBuffer::delete-range signal. @@ -157929,6 +159006,9 @@ gtk_text_buffer_remove_tag(). + The class handler for the #GtkTextBuffer::changed signal. @@ -157942,6 +159022,10 @@ gtk_text_buffer_remove_tag(). + The class handler for the #GtkTextBuffer::modified-changed + signal. @@ -157955,6 +159039,9 @@ gtk_text_buffer_remove_tag(). + The class handler for the #GtkTextBuffer::mark-set signal. @@ -157974,6 +159061,9 @@ gtk_text_buffer_remove_tag(). + The class handler for the #GtkTextBuffer::mark-deleted signal. @@ -157990,6 +159080,9 @@ gtk_text_buffer_remove_tag(). + The class handler for the #GtkTextBuffer::apply-tag signal. @@ -158024,6 +159117,9 @@ gtk_text_buffer_remove_tag(). + The class handler for the #GtkTextBuffer::remove-tag signal. @@ -158058,6 +159154,10 @@ gtk_text_buffer_remove_tag(). + The class handler for the + #GtkTextBuffer::begin-user-action signal. @@ -158074,6 +159174,10 @@ gtk_text_buffer_remove_tag(). + The class handler for the #GtkTextBuffer::end-user-action + signal. @@ -158090,6 +159194,9 @@ gtk_text_buffer_remove_tag(). + The class handler for the #GtkTextBuffer::paste-done signal. @@ -162913,6 +164020,10 @@ take over an existing reference. + The class handler for the #GtkTextView::backspace + keybinding signal. @@ -162924,6 +164035,10 @@ take over an existing reference. + The class handler for the #GtkTextview::copy-clipboard + keybinding signal. @@ -162935,6 +164050,11 @@ take over an existing reference. + The create_buffer vfunc is called to create a #GtkTextBuffer + for the text view. The default implementation is to just call + gtk_text_buffer_new(). Since: 3.10 @@ -162946,6 +164066,10 @@ take over an existing reference. + The class handler for the #GtkTextView::cut-clipboard + keybinding signal @@ -162957,6 +164081,10 @@ take over an existing reference. + The class handler for the #GtkTextView::delete-from-cursor + keybinding signal. @@ -162974,6 +164102,15 @@ take over an existing reference. + The draw_layer vfunc is called before and after the text + view is drawing its own text. Applications can override this vfunc + in a subclass to draw customized content underneath or above the + text. In the %GTK_TEXT_VIEW_LAYER_BELOW_TEXT and %GTK_TEXT_VIEW_LAYER_ABOVE_TEXT + the drawing is done in the buffer coordinate space, but the older (deprecated) + layers %GTK_TEXT_VIEW_LAYER_BELOW and %GTK_TEXT_VIEW_LAYER_ABOVE work in viewport + coordinates, which makes them unnecessarily hard to use. Since: 3.14 @@ -162991,6 +164128,10 @@ take over an existing reference. + The class handler for the #GtkTextView::extend-selection + signal. Since 3.16 @@ -163014,6 +164155,10 @@ take over an existing reference. + The class handler for the #GtkTextView::insert-at-cursor + keybinding signal. @@ -163039,6 +164184,10 @@ take over an existing reference. + The class handler for the #GtkTextView::move-cursor + keybinding signal. @@ -163059,6 +164208,10 @@ take over an existing reference. + The class handler for the #GtkTextView::paste-clipboard + keybinding signal. @@ -163070,6 +164223,10 @@ take over an existing reference. + The class handler for the #GtkTextView::populate-popup + signal. @@ -163084,6 +164241,10 @@ take over an existing reference. + The class handler for the #GtkTextView::set-anchor + keybinding signal. @@ -163095,6 +164256,10 @@ take over an existing reference. + The class handler for the #GtkTextView::toggle-overwrite + keybinding signal. @@ -165987,6 +167152,10 @@ The default bindings for this signal is Insert. + The class handler for the #GtkTextView::populate-popup + signal. @@ -166003,6 +167172,10 @@ The default bindings for this signal is Insert. + The class handler for the #GtkTextView::move-cursor + keybinding signal. @@ -166025,6 +167198,10 @@ The default bindings for this signal is Insert. + The class handler for the #GtkTextView::set-anchor + keybinding signal. @@ -166038,6 +167215,10 @@ The default bindings for this signal is Insert. + The class handler for the #GtkTextView::insert-at-cursor + keybinding signal. @@ -166054,6 +167235,10 @@ The default bindings for this signal is Insert. + The class handler for the #GtkTextView::delete-from-cursor + keybinding signal. @@ -166073,6 +167258,10 @@ The default bindings for this signal is Insert. + The class handler for the #GtkTextView::backspace + keybinding signal. @@ -166086,6 +167275,10 @@ The default bindings for this signal is Insert. + The class handler for the #GtkTextView::cut-clipboard + keybinding signal @@ -166099,6 +167292,10 @@ The default bindings for this signal is Insert. + The class handler for the #GtkTextview::copy-clipboard + keybinding signal. @@ -166112,6 +167309,10 @@ The default bindings for this signal is Insert. + The class handler for the #GtkTextView::paste-clipboard + keybinding signal. @@ -166125,6 +167326,10 @@ The default bindings for this signal is Insert. + The class handler for the #GtkTextView::toggle-overwrite + keybinding signal. @@ -166138,6 +167343,11 @@ The default bindings for this signal is Insert. + The create_buffer vfunc is called to create a #GtkTextBuffer + for the text view. The default implementation is to just call + gtk_text_buffer_new(). Since: 3.10 @@ -166151,6 +167361,15 @@ The default bindings for this signal is Insert. + The draw_layer vfunc is called before and after the text + view is drawing its own text. Applications can override this vfunc + in a subclass to draw customized content underneath or above the + text. In the %GTK_TEXT_VIEW_LAYER_BELOW_TEXT and %GTK_TEXT_VIEW_LAYER_ABOVE_TEXT + the drawing is done in the buffer coordinate space, but the older (deprecated) + layers %GTK_TEXT_VIEW_LAYER_BELOW and %GTK_TEXT_VIEW_LAYER_ABOVE work in viewport + coordinates, which makes them unnecessarily hard to use. Since: 3.14 @@ -166170,6 +167389,10 @@ The default bindings for this signal is Insert. + The class handler for the #GtkTextView::extend-selection + signal. Since 3.16 @@ -166481,6 +167704,10 @@ one. + Renders an area displaying activity, such as in #GtkSpinner, + or #GtkProgressBar. @@ -166508,6 +167735,9 @@ one. + Renders an arrow pointing to a certain direction. @@ -166535,6 +167765,9 @@ one. + Renders the background area of a widget region. @@ -166562,6 +167795,9 @@ one. + Renders a checkmark, as in #GtkCheckButton. @@ -166589,6 +167825,10 @@ one. + Renders an element what will expose/expand part of + the UI, as in #GtkExpander. @@ -166616,6 +167856,9 @@ one. + Renders a extension to a box, usually a notebook tab. @@ -166646,6 +167889,9 @@ one. + Renders the focus indicator. @@ -166673,6 +167919,9 @@ one. + Renders the frame around a widget area. @@ -166700,6 +167949,9 @@ one. + Renders the frame around a widget area with a gap in it. @@ -166736,6 +167988,9 @@ one. + Renders a handle to drag UI elements, as in #GtkPaned. @@ -166763,6 +168018,9 @@ one. + Renders an icon given as a #GdkPixbuf. @@ -166787,6 +168045,9 @@ one. + Renders an icon as a #GdkPixbuf. @@ -166805,6 +168066,9 @@ one. + Renders an icon given as a #cairo_surface_t. @@ -166829,6 +168093,9 @@ one. + Renders a #PangoLayout @@ -166853,6 +168120,9 @@ one. + Renders a line between two points. @@ -166880,6 +168150,9 @@ one. + Renders an option, as in #GtkRadioButton. @@ -166907,6 +168180,9 @@ one. + Renders a slider control, as in #GtkScale. @@ -167739,6 +169015,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders a line between two points. @@ -167768,6 +169047,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders the background area of a widget region. @@ -167797,6 +169079,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders the frame around a widget area. @@ -167826,6 +169111,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders the frame around a widget area with a gap in it. @@ -167864,6 +169152,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders a extension to a box, usually a notebook tab. @@ -167896,6 +169187,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders a checkmark, as in #GtkCheckButton. @@ -167925,6 +169219,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders an option, as in #GtkRadioButton. @@ -167954,6 +169251,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders an arrow pointing to a certain direction. @@ -167983,6 +169283,10 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders an element what will expose/expand part of + the UI, as in #GtkExpander. @@ -168012,6 +169316,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders the focus indicator. @@ -168041,6 +169348,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders a #PangoLayout @@ -168067,6 +169377,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders a slider control, as in #GtkScale. @@ -168099,6 +169412,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders a handle to drag UI elements, as in #GtkPaned. @@ -168128,6 +169444,10 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders an area displaying activity, such as in #GtkSpinner, + or #GtkProgressBar. @@ -168157,6 +169477,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders an icon as a #GdkPixbuf. @@ -168177,6 +169500,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders an icon given as a #GdkPixbuf. @@ -168203,6 +169529,9 @@ a "glossy" custom property, it could be referenced in the CSS file as + Renders an icon given as a #cairo_surface_t. @@ -169204,6 +170533,9 @@ It is an error if @stock_id is not a name of a stock item. + Signal emitted whenever the toggle tool button changes state. @@ -169305,6 +170637,9 @@ This action causes the toggled signal to be emitted. + Signal emitted whenever the toggle tool button changes state. @@ -169456,6 +170791,10 @@ gtk_image_new_from_icon_name() instead. + Signal emitted when the tool button is clicked with the + mouse or activated with the keyboard. @@ -169902,6 +171241,10 @@ or activated with the keyboard. + Signal emitted when the tool button is clicked with the + mouse or activated with the keyboard. @@ -169989,6 +171332,11 @@ See the #GtkToolbar class for a description of the toolbar widget, and + Signal emitted when the toolbar needs + information from tool_item about whether the item should appear in + the toolbar overflow menu. @@ -170825,6 +172173,11 @@ themselves accordingly. + Signal emitted when the toolbar needs + information from tool_item about whether the item should appear in + the toolbar overflow menu. @@ -170838,6 +172191,10 @@ themselves accordingly. + Signal emitted when some property of the + toolbar that the item is a child of changes. @@ -172288,6 +173645,9 @@ instead. + mandatory implementation of gtk_tool_shell_get_icon_size(). @@ -172689,6 +174049,9 @@ gtk_tool_item_rebuild_menu() instead. + mandatory implementation of gtk_tool_shell_get_icon_size(). @@ -172702,6 +174065,9 @@ gtk_tool_item_rebuild_menu() instead. + mandatory implementation of gtk_tool_shell_get_orientation(). @@ -172721,6 +174087,9 @@ gtk_tool_item_rebuild_menu() instead. + mandatory implementation of gtk_tool_shell_get_style(). @@ -172740,6 +174109,9 @@ gtk_tool_item_rebuild_menu() instead. + optional implementation of gtk_tool_shell_get_relief_style(). @@ -172759,6 +174131,9 @@ gtk_tool_item_rebuild_menu() instead. + optional implementation of gtk_tool_shell_rebuild_menu(). @@ -172775,6 +174150,9 @@ gtk_tool_item_rebuild_menu() instead. + optional implementation of gtk_tool_shell_get_text_orientation(). @@ -172794,6 +174172,9 @@ gtk_tool_item_rebuild_menu() instead. + optional implementation of gtk_tool_shell_get_text_alignment(). @@ -172813,6 +174194,9 @@ gtk_tool_item_rebuild_menu() instead. + optional implementation of gtk_tool_shell_get_ellipsize_mode(). @@ -172832,6 +174216,9 @@ gtk_tool_item_rebuild_menu() instead. + optional implementation of gtk_tool_shell_get_text_size_group(). @@ -174322,6 +175709,11 @@ parent of @dest_path doesn’t exist, though. + Asks the #GtkTreeDragDest to insert a row + before the path dest, deriving the contents of the row from + selection_data. @@ -174353,6 +175745,10 @@ parent of @dest_path doesn’t exist, though. + Determines whether a drop is possible before + the given dest_path, at the same depth as dest_path. @@ -174591,6 +175987,10 @@ this interface, the row is assumed draggable. + Asks the #GtkTreeDragSource whether a particular + row can be used as the source of a DND operation. @@ -174616,6 +176016,10 @@ this interface, the row is assumed draggable. + Asks the #GtkTreeDragSource to fill in + selection_data with a representation of the row at path. @@ -174648,6 +176052,10 @@ this interface, the row is assumed draggable. + Asks the #GtkTreeDragSource to delete the row at + path, because it was moved somewhere else via drag-and-drop. @@ -177580,6 +178988,9 @@ iterate over the rows in a tree model. + Signal emitted when a row in the model has changed. @@ -177608,6 +179019,10 @@ iterate over the rows in a tree model. + Signal emitted when a new row has been inserted in + the model. @@ -177636,6 +179051,10 @@ iterate over the rows in a tree model. + Signal emitted when a row has gotten the + first child row or lost its last child row. @@ -177664,6 +179083,9 @@ iterate over the rows in a tree model. + Signal emitted when a row has been deleted. @@ -177687,6 +179109,10 @@ iterate over the rows in a tree model. + Signal emitted when the children of a node in the + GtkTreeModel have been reordered. @@ -177725,6 +179151,9 @@ iterate over the rows in a tree model. + Get #GtkTreeModelFlags supported by this interface. @@ -177744,6 +179173,9 @@ iterate over the rows in a tree model. + Get the number of columns supported by the model. @@ -177763,6 +179195,9 @@ iterate over the rows in a tree model. + Get the type of the column. @@ -177788,6 +179223,9 @@ iterate over the rows in a tree model. + Sets iter to a valid iterator pointing to path. @@ -177822,6 +179260,9 @@ iterate over the rows in a tree model. + Gets a newly-created #GtkTreePath referenced by iter. @@ -177847,6 +179288,9 @@ iterate over the rows in a tree model. + Initializes and sets value to that at column. @@ -177884,6 +179328,10 @@ iterate over the rows in a tree model. + Sets iter to point to the node following it at the + current level. @@ -177909,6 +179357,10 @@ iterate over the rows in a tree model. + Sets iter to point to the previous node at the + current level. @@ -177934,6 +179386,9 @@ iterate over the rows in a tree model. + Sets iter to point to the first child of parent. @@ -177971,6 +179426,9 @@ iterate over the rows in a tree model. + %TRUE if iter has children, %FALSE otherwise. @@ -177996,6 +179454,9 @@ iterate over the rows in a tree model. + Gets the number of children that iter has. @@ -178024,6 +179485,10 @@ iterate over the rows in a tree model. + Sets iter to be the child of parent, using the + given index. @@ -178067,6 +179532,9 @@ iterate over the rows in a tree model. + Sets iter to be the parent of child. @@ -178101,6 +179569,9 @@ iterate over the rows in a tree model. + Lets the tree ref the node. @@ -178123,6 +179594,9 @@ iterate over the rows in a tree model. + Lets the tree unref the node. @@ -179383,6 +180857,9 @@ when nothing has happened (mostly as a result of programmers calling select_row on an already selected row). + Signal emitted whenever the selection has (possibly) changed. @@ -180009,6 +181486,9 @@ has happened. + Signal emitted whenever the selection has (possibly) changed. @@ -180646,6 +182126,10 @@ the contents of @sortable are resorted. + Signal emitted when the sort column or sort + order of sortable is changed. @@ -180662,6 +182146,10 @@ the contents of @sortable are resorted. + Fills in sort_column_id and order with the + current sort column and the order. @@ -180700,6 +182188,10 @@ the contents of @sortable are resorted. + Sets the current sort column to be + sort_column_id. @@ -180728,6 +182220,10 @@ the contents of @sortable are resorted. + Sets the comparison function used when sorting to + be sort_func. @@ -180781,6 +182277,10 @@ the contents of @sortable are resorted. + Sets the default comparison function used + when sorting to be sort_func. @@ -180828,6 +182328,10 @@ the contents of @sortable are resorted. + %TRUE if the model has a default sort +function. @@ -191828,6 +193332,23 @@ direction has not been explicitly set by gtk_widget_set_direction(). + Convert an initial size allocation assigned + by a #GtkContainer using gtk_widget_size_allocate(), into an actual + size allocation to be used by the widget. adjust_size_allocation + adjusts to a child widget’s actual allocation + from what a parent container computed for the + child. The adjusted allocation must be entirely within the original + allocation. In any custom implementation, chain up to the default + #GtkWidget implementation of this method, which applies the margin + and alignment properties of #GtkWidget. Chain up + before performing your own adjustments so your + own adjustments remove more allocation after the #GtkWidget base + class has already removed margin and alignment. The natural size + passed in should be adjusted in the same way as the allocated size, + which allows adjustments to perform alignments or other changes + based on natural size. @@ -191854,6 +193375,23 @@ direction has not been explicitly set by gtk_widget_set_direction(). + Convert an initial size request from a widget's + #GtkSizeRequestMode virtual method implementations into a size request to + be used by parent containers in laying out the widget. + adjust_size_request adjusts from a child widget's + original request to what a parent container should + use for layout. The @for_size argument will be -1 if the request should + not be for a particular size in the opposing orientation, i.e. if the + request is not height-for-width or width-for-height. If @for_size is + greater than -1, it is the proposed allocation in the opposing + orientation that we need the request for. Implementations of + adjust_size_request should chain up to the default implementation, + which applies #GtkWidget’s margin properties and imposes any values + from gtk_widget_set_size_request(). Chaining up should be last, + after your subclass adjusts the request, so + #GtkWidget can apply constraints and add the margin properly. @@ -191874,6 +193412,10 @@ direction has not been explicitly set by gtk_widget_set_direction(). + Signal will be emitted when a button + (typically from a mouse) is pressed. @@ -191888,6 +193430,10 @@ direction has not been explicitly set by gtk_widget_set_direction(). + Signal will be emitted when a button + (typically from a mouse) is released. @@ -191966,6 +193512,10 @@ Also see gtk_container_child_notify(). + Signal emitted when the composited status of + widgets screen changes. See gdk_screen_is_composited(). @@ -191977,6 +193527,10 @@ Also see gtk_container_child_notify(). + Computes whether a container should give this + widget extra space when possible. @@ -191994,6 +193548,10 @@ Also see gtk_container_child_notify(). + Signal will be emitted when the size, position or + stacking of the widget’s window has changed. @@ -192008,6 +193566,10 @@ Also see gtk_container_child_notify(). + Signal emitted when a redirected window belonging to + widget gets drawn into. @@ -192022,6 +193584,10 @@ Also see gtk_container_child_notify(). + Signal emitted if a user requests that a toplevel + window is closed. @@ -192083,6 +193649,9 @@ See also: gtk_container_remove() + Signal is emitted when a #GdkWindow is destroyed. @@ -192097,6 +193666,10 @@ See also: gtk_container_remove() + Signal emitted when the text direction of a + widget changes. @@ -192111,6 +193684,9 @@ See also: gtk_container_remove() + Seldomly overidden. @@ -192128,6 +193704,10 @@ See also: gtk_container_remove() + Signal emitted on the drag source when a drag is + started. @@ -192142,6 +193722,10 @@ See also: gtk_container_remove() + Signal emitted on the drag source when a drag + with the action %GDK_ACTION_MOVE is successfully completed. @@ -192156,6 +193740,10 @@ See also: gtk_container_remove() + Signal emitted on the drag source when the drop + site requests the data which is dragged. @@ -192179,6 +193767,10 @@ See also: gtk_container_remove() + Signal emitted on the drop site when the + dragged data has been received. @@ -192208,6 +193800,10 @@ See also: gtk_container_remove() + Signal emitted on the drop site when the user drops the + data onto the widget. @@ -192231,6 +193827,10 @@ See also: gtk_container_remove() + Signal emitted on the drag source when a drag is + finished. @@ -192245,6 +193845,10 @@ See also: gtk_container_remove() + Signal emitted on the drag source when a drag has + failed. @@ -192262,6 +193866,10 @@ See also: gtk_container_remove() + Signal emitted on the drop site when the cursor leaves + the widget. @@ -192279,6 +193887,10 @@ See also: gtk_container_remove() + signal emitted on the drop site when the user moves + the cursor over the widget during a drag. @@ -192302,6 +193914,9 @@ See also: gtk_container_remove() + Signal emitted when a widget is supposed to render itself. @@ -192316,6 +193931,10 @@ See also: gtk_container_remove() + Signal event will be emitted when the pointer + enters the widget’s window. @@ -192378,6 +193997,10 @@ window. + Signal emitted when the keyboard focus enters the +widget’s window. @@ -192392,6 +194015,10 @@ window. + Signal emitted when the keyboard focus leaves the +widget’s window. @@ -192748,6 +194375,10 @@ capabilities. + Signal emitted when a pointer or keyboard grab + on a window belonging to widget gets broken. @@ -192788,6 +194419,11 @@ will likely fail and cause critical warnings. + Signal emitted when a widget becomes shadowed by a + GTK+ grab (not a pointer or keyboard grab) on another widget, or + when it becomes unshadowed due to a grab being removed. @@ -192820,6 +194456,10 @@ hidden (invisible to the user). + Signal emitted when the anchored state of a + widget changes. @@ -192834,6 +194474,9 @@ hidden (invisible to the user). + Signal emitted when a key is pressed. @@ -192848,6 +194491,9 @@ hidden (invisible to the user). + Signal is emitted when a key is released. @@ -192918,6 +194564,10 @@ that require entering license keys. + Will be emitted when the pointer leaves the + widget’s window. @@ -192950,6 +194600,9 @@ a widget to be mapped if it isn’t already. + Signal emitted when the widget’s window is mapped. @@ -192990,6 +194643,10 @@ a widget to be mapped if it isn’t already. + Signal emitted when the pointer moves over + the widget’s #GdkWindow. @@ -193004,6 +194661,9 @@ a widget to be mapped if it isn’t already. + Signal emitted when a change of focus is requested @@ -193018,6 +194678,10 @@ a widget to be mapped if it isn’t already. + Signal emitted when a new parent has been set on a + widget. @@ -193032,6 +194696,10 @@ a widget to be mapped if it isn’t already. + Signal emitted whenever a widget should pop up a + context menu. @@ -193043,6 +194711,10 @@ a widget to be mapped if it isn’t already. + Signal will be emitted when a property on + the widget’s window has been changed or deleted. @@ -193085,6 +194757,11 @@ a widget to be mapped if it isn’t already. + Signal emitted when “has-tooltip” is %TRUE and the + hover timeout has expired with the cursor hovering “above” + widget; or emitted when widget got focus in keyboard mode. @@ -193176,6 +194853,10 @@ called after the widget is realized automatically, such as + Signal emitted when the screen of a widget has + changed. @@ -193190,6 +194871,10 @@ called after the widget is realized automatically, such as + Signal emitted when a button in the 4 to 7 range is + pressed. @@ -193204,6 +194889,10 @@ called after the widget is realized automatically, such as + Signal will be emitted when the the + widget’s window has lost ownership of a selection. @@ -193269,6 +194958,11 @@ called after the widget is realized automatically, such as + Signal will be emitted when another + client requests ownership of the selection owned by the widget's + window. @@ -193375,6 +195069,10 @@ instead. + Signal emitted when the widget state + changes. Deprecated: 3.0 @@ -193389,6 +195087,10 @@ instead. + Signal emitted when the widget state changes, + see gtk_widget_get_state_flags(). @@ -193403,6 +195105,10 @@ instead. + Signal emitted when a new style has been set on a +widget. Deprecated: 3.0 @@ -193417,6 +195123,10 @@ instead. + Signal emitted when the GtkStyleContext of a widget + is changed. @@ -193428,6 +195138,9 @@ instead. + Signal emitted when a touch event happens @@ -193460,6 +195173,10 @@ a widget to be unmapped if it’s currently mapped. + Signal will be emitted when the widget’s window is + unmapped. @@ -193493,6 +195210,10 @@ associated with the widget, such as @widget->window). + Signal emitted when the widget’s window is + obscured or unobscured. @@ -193507,6 +195228,10 @@ associated with the widget, such as @widget->window). + Signal emitted when the state of the toplevel + window associated to the widget changes. @@ -204282,6 +206007,9 @@ this mask automatically for all new windows. + Seldomly overidden. @@ -204301,6 +206029,10 @@ this mask automatically for all new windows. + Signals that all holders of a reference to the widget + should release the reference that they hold. @@ -204317,6 +206049,9 @@ this mask automatically for all new windows. + Signal emitted when widget is shown @@ -204333,6 +206068,10 @@ this mask automatically for all new windows. + Recursively shows a widget, and any child widgets (if the widget is +a container). @@ -204349,6 +206088,9 @@ this mask automatically for all new windows. + Signal emitted when widget is hidden. @@ -204365,6 +206107,12 @@ this mask automatically for all new windows. + Signal emitted when widget is going to be mapped, that is + when the widget is visible (which is controlled with + gtk_widget_set_visible()) and all its parents up to the toplevel + widget are also visible. @@ -204381,6 +206129,11 @@ this mask automatically for all new windows. + Signal emitted when widget is going to be unmapped, which + means that either it or any of its parents up to the toplevel + widget have been set as hidden. @@ -204397,6 +206150,11 @@ this mask automatically for all new windows. + Signal emitted when widget is associated with a + #GdkWindow, which means that gtk_widget_realize() has been called or + the widget has been mapped (that is, it is going to be drawn). @@ -204413,6 +206171,12 @@ this mask automatically for all new windows. + Signal emitted when the GdkWindow associated with + widget is destroyed, which means that gtk_widget_unrealize() has + been called or the widget has been unmapped (that is, it is going + to be hidden). @@ -204429,6 +206193,9 @@ this mask automatically for all new windows. + Signal emitted to get the widget allocation. @@ -204451,6 +206218,10 @@ this mask automatically for all new windows. + Signal emitted when the widget state + changes. Deprecated: 3.0 @@ -204467,6 +206238,10 @@ this mask automatically for all new windows. + Signal emitted when the widget state changes, + see gtk_widget_get_state_flags(). @@ -204483,6 +206258,10 @@ this mask automatically for all new windows. + Signal emitted when a new parent has been set on a + widget. @@ -204499,6 +206278,10 @@ this mask automatically for all new windows. + Signal emitted when the anchored state of a + widget changes. @@ -204515,6 +206298,10 @@ this mask automatically for all new windows. + Signal emitted when a new style has been set on a +widget. Deprecated: 3.0 @@ -204531,6 +206318,10 @@ this mask automatically for all new windows. + Signal emitted when the text direction of a + widget changes. @@ -204547,6 +206338,11 @@ this mask automatically for all new windows. + Signal emitted when a widget becomes shadowed by a + GTK+ grab (not a pointer or keyboard grab) on another widget, or + when it becomes unshadowed due to a grab being removed. @@ -204563,6 +206359,10 @@ this mask automatically for all new windows. + Signal emitted for each child property that has + changed on an object. @@ -204586,6 +206386,9 @@ this mask automatically for all new windows. + Signal emitted when a widget is supposed to render itself. @@ -204602,6 +206405,22 @@ this mask automatically for all new windows. + This allows a widget to tell its parent container whether + it prefers to be allocated in %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH or + %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT mode. + %GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH means the widget prefers to have + #GtkWidgetClass.get_preferred_width() called and then + #GtkWidgetClass.get_preferred_height_for_width(). + %GTK_SIZE_REQUEST_CONSTANT_SIZE disables any height-for-width or + width-for-height geometry management for a said widget and is the + default return. + It’s important to note (as described below) that any widget + which trades height-for-width or width-for-height must respond properly + to both of the virtual methods #GtkWidgetClass.get_preferred_height_for_width() + and #GtkWidgetClass.get_preferred_width_for_height() since it might be + queried in either #GtkSizeRequestMode by its parent container. @@ -204621,6 +206440,13 @@ this mask automatically for all new windows. + This is called by containers to obtain the minimum + and natural height of a widget. A widget that does not actually trade + any height for width or width for height only has to implement these + two virtual methods (#GtkWidgetClass.get_preferred_width() and + #GtkWidgetClass.get_preferred_height()). @@ -204659,6 +206485,14 @@ this mask automatically for all new windows. + This is analogous to + #GtkWidgetClass.get_preferred_height_for_width() except that it + operates in the oposite orientation. It’s rare that a widget actually + does %GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT requests but this can happen + when, for example, a widget or container gets additional columns to + compensate for a smaller allocated height. @@ -204703,6 +206537,16 @@ this mask automatically for all new windows. + This is called by containers to obtain the minimum + and natural width of a widget. A widget will never be allocated a width + less than its minimum and will only ever be allocated a width greater + than the natural width once all of the said widget’s siblings have + received their natural widths. + Furthermore, a widget will only ever be allocated a width greater than + its natural width if it was configured to receive extra expand space + from its parent container. @@ -204741,6 +206585,13 @@ this mask automatically for all new windows. + This is similar to + #GtkWidgetClass.get_preferred_height() except that it is passed a + contextual width to request height for. By implementing this virtual + method it is possible for a #GtkLabel to tell its parent how much height + would be required if the label were to be allocated a said width. @@ -204785,6 +206636,10 @@ this mask automatically for all new windows. + Activates the @widget if @group_cycling is + %FALSE, and just grabs the focus if @group_cycling is %TRUE. @@ -204810,6 +206665,10 @@ this mask automatically for all new windows. + Causes @widget to have the keyboard focus for the + #GtkWindow it’s inside. @@ -204842,6 +206701,9 @@ this mask automatically for all new windows. + Signal emitted when a change of focus is requested @@ -204858,6 +206720,9 @@ this mask automatically for all new windows. + Signal emitted if keyboard navigation fails. @@ -204885,6 +206750,13 @@ this mask automatically for all new windows. + The GTK+ main loop will emit three signals for each GDK + event delivered to a widget: one generic ::event signal, another, + more specific, signal that matches the type of event delivered + (e.g. "key-press-event") and finally a generic "event-after" + signal. @@ -204911,6 +206783,10 @@ this mask automatically for all new windows. + Signal will be emitted when a button + (typically from a mouse) is pressed. @@ -204927,6 +206803,10 @@ this mask automatically for all new windows. + Signal will be emitted when a button + (typically from a mouse) is released. @@ -204943,6 +206823,10 @@ this mask automatically for all new windows. + Signal emitted when a button in the 4 to 7 range is + pressed. @@ -204959,6 +206843,10 @@ this mask automatically for all new windows. + Signal emitted when the pointer moves over + the widget’s #GdkWindow. @@ -204975,6 +206863,10 @@ this mask automatically for all new windows. + Signal emitted if a user requests that a toplevel + window is closed. @@ -204991,6 +206883,9 @@ this mask automatically for all new windows. + Signal is emitted when a #GdkWindow is destroyed. @@ -205007,6 +206902,9 @@ this mask automatically for all new windows. + Signal emitted when a key is pressed. @@ -205023,6 +206921,9 @@ this mask automatically for all new windows. + Signal is emitted when a key is released. @@ -205039,6 +206940,10 @@ this mask automatically for all new windows. + Signal event will be emitted when the pointer + enters the widget’s window. @@ -205055,6 +206960,10 @@ this mask automatically for all new windows. + Will be emitted when the pointer leaves the + widget’s window. @@ -205071,6 +206980,10 @@ this mask automatically for all new windows. + Signal will be emitted when the size, position or + stacking of the widget’s window has changed. @@ -205087,6 +207000,10 @@ this mask automatically for all new windows. + Signal emitted when the keyboard focus enters the +widget’s window. @@ -205103,6 +207020,10 @@ this mask automatically for all new windows. + Signal emitted when the keyboard focus leaves the +widget’s window. @@ -205119,6 +207040,9 @@ this mask automatically for all new windows. + Signal emitted when the widget’s window is mapped. @@ -205135,6 +207059,10 @@ this mask automatically for all new windows. + Signal will be emitted when the widget’s window is + unmapped. @@ -205151,6 +207079,10 @@ this mask automatically for all new windows. + Signal will be emitted when a property on + the widget’s window has been changed or deleted. @@ -205167,6 +207099,10 @@ this mask automatically for all new windows. + Signal will be emitted when the the + widget’s window has lost ownership of a selection. @@ -205183,6 +207119,11 @@ this mask automatically for all new windows. + Signal will be emitted when another + client requests ownership of the selection owned by the widget's + window. @@ -205247,6 +207188,10 @@ this mask automatically for all new windows. + Signal emitted when the widget’s window is + obscured or unobscured. @@ -205263,6 +207208,10 @@ this mask automatically for all new windows. + Signal emitted when the state of the toplevel + window associated to the widget changes. @@ -205279,6 +207228,10 @@ this mask automatically for all new windows. + Signal emitted when a redirected window belonging to + widget gets drawn into. @@ -205295,6 +207248,10 @@ this mask automatically for all new windows. + Signal emitted when a pointer or keyboard grab + on a window belonging to widget gets broken. @@ -205352,6 +207309,10 @@ this mask automatically for all new windows. + Signal emitted on the drag source when a drag is + started. @@ -205368,6 +207329,10 @@ this mask automatically for all new windows. + Signal emitted on the drag source when a drag is + finished. @@ -205384,6 +207349,10 @@ this mask automatically for all new windows. + Signal emitted on the drag source when the drop + site requests the data which is dragged. @@ -205409,6 +207378,10 @@ this mask automatically for all new windows. + Signal emitted on the drag source when a drag + with the action %GDK_ACTION_MOVE is successfully completed. @@ -205425,6 +207398,10 @@ this mask automatically for all new windows. + Signal emitted on the drop site when the cursor leaves + the widget. @@ -205444,6 +207421,10 @@ this mask automatically for all new windows. + signal emitted on the drop site when the user moves + the cursor over the widget during a drag. @@ -205469,6 +207450,10 @@ this mask automatically for all new windows. + Signal emitted on the drop site when the user drops the + data onto the widget. @@ -205494,6 +207479,10 @@ this mask automatically for all new windows. + Signal emitted on the drop site when the + dragged data has been received. @@ -205525,6 +207514,10 @@ this mask automatically for all new windows. + Signal emitted on the drag source when a drag has + failed. @@ -205544,6 +207537,10 @@ this mask automatically for all new windows. + Signal emitted whenever a widget should pop up a + context menu. @@ -205573,6 +207570,10 @@ this mask automatically for all new windows. + Returns the accessible object that describes the + widget to an assistive technology. @@ -205592,6 +207593,10 @@ this mask automatically for all new windows. + Signal emitted when the screen of a widget has + changed. @@ -205608,6 +207613,11 @@ this mask automatically for all new windows. + Signal allows applications and derived widgets + to override the default GtkWidget handling for determining whether + an accelerator can be activated. @@ -205633,6 +207643,10 @@ this mask automatically for all new windows. + Signal emitted when the composited status of + widgets screen changes. See gdk_screen_is_composited(). @@ -205646,6 +207660,11 @@ this mask automatically for all new windows. + Signal emitted when “has-tooltip” is %TRUE and the + hover timeout has expired with the cursor hovering “above” + widget; or emitted when widget got focus in keyboard mode. @@ -205671,6 +207690,10 @@ this mask automatically for all new windows. + Computes whether a container should give this + widget extra space when possible. @@ -205690,6 +207713,23 @@ this mask automatically for all new windows. + Convert an initial size request from a widget's + #GtkSizeRequestMode virtual method implementations into a size request to + be used by parent containers in laying out the widget. + adjust_size_request adjusts from a child widget's + original request to what a parent container should + use for layout. The @for_size argument will be -1 if the request should + not be for a particular size in the opposing orientation, i.e. if the + request is not height-for-width or width-for-height. If @for_size is + greater than -1, it is the proposed allocation in the opposing + orientation that we need the request for. Implementations of + adjust_size_request should chain up to the default implementation, + which applies #GtkWidget’s margin properties and imposes any values + from gtk_widget_set_size_request(). Chaining up should be last, + after your subclass adjusts the request, so + #GtkWidget can apply constraints and add the margin properly. @@ -205712,6 +207752,23 @@ this mask automatically for all new windows. + Convert an initial size allocation assigned + by a #GtkContainer using gtk_widget_size_allocate(), into an actual + size allocation to be used by the widget. adjust_size_allocation + adjusts to a child widget’s actual allocation + from what a parent container computed for the + child. The adjusted allocation must be entirely within the original + allocation. In any custom implementation, chain up to the default + #GtkWidget implementation of this method, which applies the margin + and alignment properties of #GtkWidget. Chain up + before performing your own adjustments so your + own adjustments remove more allocation after the #GtkWidget base + class has already removed margin and alignment. The natural size + passed in should be adjusted in the same way as the allocated size, + which allows adjustments to perform alignments or other changes + based on natural size. @@ -205740,6 +207797,10 @@ this mask automatically for all new windows. + Signal emitted when the GtkStyleContext of a widget + is changed. @@ -205753,6 +207814,9 @@ this mask automatically for all new windows. + Signal emitted when a touch event happens @@ -205870,6 +207934,11 @@ this mask automatically for all new windows. + Invalidates the area of widget defined by + region by calling gdk_window_invalidate_region() on the widget's + window and all its child windows. @@ -207928,6 +209997,9 @@ and to useful debugging tools. + Activates the default widget for the window. @@ -207939,6 +210011,9 @@ and to useful debugging tools. + Activates the current focused widget within the window. @@ -207950,6 +210025,10 @@ and to useful debugging tools. + Class handler for the #GtkWindow::enable-debugging + keybinding signal. Since: 3.14 @@ -207964,6 +210043,10 @@ and to useful debugging tools. + Signal gets emitted when the set of accelerators or + mnemonics that are associated with window changes. @@ -211977,6 +214060,9 @@ this window changes. + Sets child as the focus widget for the window. @@ -212003,6 +214089,9 @@ this window changes. + Activates the current focused widget within the window. @@ -212016,6 +214105,9 @@ this window changes. + Activates the default widget for the window. @@ -212029,6 +214121,10 @@ this window changes. + Signal gets emitted when the set of accelerators or + mnemonics that are associated with window changes. @@ -212042,6 +214138,10 @@ this window changes. + Class handler for the #GtkWindow::enable-debugging + keybinding signal. Since: 3.14 @@ -212476,6 +214576,9 @@ the window borders; use gtk_window_set_decorated() for that. + Handler for the #_GtkMountOperationHandler::handle-ask-password signal. @@ -212511,6 +214614,9 @@ the window borders; use gtk_window_set_decorated() for that. + Handler for the #_GtkMountOperationHandler::handle-ask-question signal. @@ -212540,6 +214646,9 @@ the window borders; use gtk_window_set_decorated() for that. + Handler for the #_GtkMountOperationHandler::handle-close signal. @@ -212557,6 +214666,9 @@ the window borders; use gtk_window_set_decorated() for that. + Handler for the #_GtkMountOperationHandler::handle-show-processes signal. @@ -218962,7 +221074,7 @@ Typical arrow rendering at 0, 1⁄2 π;, π; and 3⁄2 π: + version="3.0"> Renders the background of an element. diff --git a/girs/Gtk-4.0.gir b/girs/Gtk-4.0.gir index 650c5062b..c5e95745a 100644 --- a/girs/Gtk-4.0.gir +++ b/girs/Gtk-4.0.gir @@ -9807,13 +9807,13 @@ any windows. c:identifier="gtk_application_get_accels_for_action"> Gets the accelerators that are currently associated with + line="1074">Gets the accelerators that are currently associated with the given action. + line="1083"> accelerators for `detailed_action_name` @@ -9823,13 +9823,13 @@ the given action. a `GtkApplication` + line="1076">a `GtkApplication` a detailed action name, specifying an action + line="1077">a detailed action name, specifying an action and target to obtain accelerators for @@ -9839,7 +9839,7 @@ the given action. c:identifier="gtk_application_get_actions_for_accel"> Returns the list of actions (possibly empty) that `accel` maps to. + line="1099">Returns the list of actions (possibly empty) that `accel` maps to. Each item in the list is a detailed action name in the usual form. @@ -9860,7 +9860,7 @@ If you are unsure, check it with [func@Gtk.accelerator_parse] first. a %NULL-terminated array of actions for `accel` + line="1122">a %NULL-terminated array of actions for `accel` @@ -9869,13 +9869,13 @@ If you are unsure, check it with [func@Gtk.accelerator_parse] first. a `GtkApplication` + line="1101">a `GtkApplication` an accelerator that can be parsed by [func@Gtk.accelerator_parse] + line="1102">an accelerator that can be parsed by [func@Gtk.accelerator_parse] @@ -9912,7 +9912,7 @@ recently-focused window within this application. c:identifier="gtk_application_get_menu_by_id"> Gets a menu from automatically loaded resources. + line="1176">Gets a menu from automatically loaded resources. See [the section on Automatic resources](class.Application.html#automatic-resources) for more information. @@ -9920,7 +9920,7 @@ for more information. Gets the menu with the + line="1186">Gets the menu with the given id from the automatically loaded resources @@ -9928,13 +9928,13 @@ for more information. a `GtkApplication` + line="1178">a `GtkApplication` the id of the menu to look up + line="1179">the id of the menu to look up @@ -10099,14 +10099,14 @@ this window to find out more about why the action is inhibited. c:identifier="gtk_application_list_action_descriptions"> Lists the detailed action names which have associated accelerators. + line="1011">Lists the detailed action names which have associated accelerators. See [method@Gtk.Application.set_accels_for_action]. the detailed action names + line="1019">the detailed action names @@ -10115,7 +10115,7 @@ See [method@Gtk.Application.set_accels_for_action]. a `GtkApplication` + line="1013">a `GtkApplication` @@ -10155,7 +10155,7 @@ function, if `window` was the last window of the `application`. c:identifier="gtk_application_set_accels_for_action"> Sets zero or more keyboard accelerators that will trigger the + line="1031">Sets zero or more keyboard accelerators that will trigger the given action. The first item in `accels` will be the primary accelerator, which may be @@ -10174,20 +10174,20 @@ For the `detailed_action_name`, see `g_action_parse_detailed_name()` and a `GtkApplication` + line="1033">a `GtkApplication` a detailed action name, specifying an action + line="1034">a detailed action name, specifying an action and target to associate accelerators with a list of accelerators in the format + line="1036">a list of accelerators in the format understood by [func@Gtk.accelerator_parse] @@ -12311,7 +12311,7 @@ See gtk_assistant_commit() for details. add its own buttons through gtk_assistant_add_action_widget(). - + Like [func@get_binary_age], but from the headers used at @@ -32216,19 +32216,19 @@ is grouped together with other checkbuttons. Gets the child widget of @button or `NULL` if [property@CheckButton:label] is set. + line="1153">Gets the child widget of @button or `NULL` if [property@CheckButton:label] is set. the child widget of @button + line="1159">the child widget of @button a `GtkCheckButton` + line="1155">a `GtkCheckButton` @@ -32286,12 +32286,12 @@ is grouped together with other checkbuttons. Returns whether underlines in the label indicate mnemonics. + line="1064">Returns whether underlines in the label indicate mnemonics. The value of the [property@Gtk.CheckButton:use-underline] property. + line="1070">The value of the [property@Gtk.CheckButton:use-underline] property. See [method@Gtk.CheckButton.set_use_underline] for details on how to set a new value. @@ -32300,7 +32300,7 @@ is grouped together with other checkbuttons. a `GtkCheckButton` + line="1066">a `GtkCheckButton` @@ -32338,7 +32338,7 @@ is grouped together with other checkbuttons. Sets the child widget of @button. + line="1115">Sets the child widget of @button. Note that by using this API, you take full responsibility for setting up the proper accessibility label and description information for @button. @@ -32353,7 +32353,7 @@ relations from @child to @button. a `GtkCheckButton` + line="1117">a `GtkCheckButton` allow-none="1"> the child widget + line="1118">the child widget @@ -32480,7 +32480,7 @@ in @label is interpreted as mnemonic indicator, see Sets whether underlines in the label indicate mnemonics. + line="1084">Sets whether underlines in the label indicate mnemonics. If @setting is %TRUE, an underscore character in @self's label indicates a mnemonic accelerator key. This behavior is similar @@ -32493,13 +32493,13 @@ to [property@Gtk.Label:use-underline]. a `GtkCheckButton` + line="1086">a `GtkCheckButton` the new value to set + line="1087">the new value to set @@ -70918,12 +70918,12 @@ The GTK inspector provides a visual debugging tool for graphics offload. version="4.14"> Creates a new GtkGraphicsOffload widget. + line="261">Creates a new GtkGraphicsOffload widget. - + the new widget + line="267">the new widget @@ -70933,7 +70933,7 @@ The GTK inspector provides a visual debugging tool for graphics offload. allow-none="1"> the child widget + line="263">the child widget @@ -70944,19 +70944,19 @@ The GTK inspector provides a visual debugging tool for graphics offload. version="4.14"> Gets the child of @self. + line="309">Gets the child of @self. the child widget + line="315">the child widget a `GtkGraphicsOffload` + line="311">a `GtkGraphicsOffload` @@ -70967,12 +70967,12 @@ The GTK inspector provides a visual debugging tool for graphics offload. version="4.14"> Returns whether offload is enabled for @self. + line="354">Returns whether offload is enabled for @self. whether offload is enabled + line="360">whether offload is enabled @@ -70980,7 +70980,7 @@ The GTK inspector provides a visual debugging tool for graphics offload. a `GtkGraphicsOffload` + line="356">a `GtkGraphicsOffload` @@ -70991,7 +70991,7 @@ The GTK inspector provides a visual debugging tool for graphics offload. version="4.14"> Sets the child of @self. + line="279">Sets the child of @self. @@ -71000,7 +71000,7 @@ The GTK inspector provides a visual debugging tool for graphics offload. a `GtkGraphicsOffload` + line="281">a `GtkGraphicsOffload` allow-none="1"> the child widget + line="282">the child widget @@ -71020,7 +71020,7 @@ The GTK inspector provides a visual debugging tool for graphics offload. version="4.14"> Sets whether this GtkGraphicsOffload widget will attempt + line="327">Sets whether this GtkGraphicsOffload widget will attempt to offload the content of its child widget. @@ -71030,13 +71030,13 @@ to offload the content of its child widget. a `GtkGraphicsOffload` + line="329">a `GtkGraphicsOffload` whether to enable offload + line="330">whether to enable offload @@ -71054,7 +71054,7 @@ to offload the content of its child widget. value="gtk_graphics_offload_set_child"/> The child widget. + line="232">The child widget. value="gtk_graphics_offload_set_enabled"/> Whether graphics offload is enabled. + line="243">Whether graphics offload is enabled. @@ -76191,7 +76191,7 @@ See [signal@Gtk.SpinButton::input]. - + Like [func@get_interface_age], but from the headers used at @@ -78690,14 +78690,14 @@ allowed and what it does. c:identifier="gtk_icon_paintable_new_for_file"> Creates a `GtkIconPaintable` for a file with a given size and scale. + line="4003">Creates a `GtkIconPaintable` for a file with a given size and scale. The icon can then be rendered by using it as a `GdkPaintable`. a `GtkIconPaintable` containing + line="4013">a `GtkIconPaintable` containing for the icon. Unref with g_object_unref() @@ -78705,19 +78705,19 @@ The icon can then be rendered by using it as a `GdkPaintable`. a `GFile` + line="4005">a `GFile` desired icon size + line="4006">desired icon size the desired scale + line="4007">the desired scale @@ -78728,21 +78728,21 @@ The icon can then be rendered by using it as a `GdkPaintable`. Gets the `GFile` that was used to load the icon. + line="3633">Gets the `GFile` that was used to load the icon. Returns %NULL if the icon was not loaded from a file. the `GFile` for the icon + line="3641">the `GFile` for the icon a `GtkIconPaintable` + line="3635">a `GtkIconPaintable` @@ -78753,7 +78753,7 @@ Returns %NULL if the icon was not loaded from a file. Get the icon name being used for this icon. + line="3657">Get the icon name being used for this icon. When an icon looked up in the icon theme was not available, the icon theme may use fallback icons - either those specified to @@ -78766,7 +78766,7 @@ returns %NULL. the themed icon-name for the + line="3672">the themed icon-name for the icon, or %NULL if its not a themed icon. @@ -78774,7 +78774,7 @@ returns %NULL. a `GtkIconPaintable` + line="3659">a `GtkIconPaintable` @@ -78783,7 +78783,7 @@ returns %NULL. Checks if the icon is symbolic or not. + line="3683">Checks if the icon is symbolic or not. This currently uses only the file name and not the file contents for determining this. This behaviour may change in the future. @@ -78794,14 +78794,14 @@ recoloring), you have to set its icon name on a `GtkImage`. %TRUE if the icon is symbolic, %FALSE otherwise + line="3695">%TRUE if the icon is symbolic, %FALSE otherwise a `GtkIconPaintable` + line="3685">a `GtkIconPaintable` @@ -78815,7 +78815,7 @@ recoloring), you have to set its icon name on a `GtkImage`. value="gtk_icon_paintable_get_file"/> The file representing the icon, if any. + line="3588">The file representing the icon, if any. value="gtk_icon_paintable_get_icon_name"/> The icon name that was chosen during lookup. + line="3598">The icon name that was chosen during lookup. value="gtk_icon_paintable_is_symbolic"/> Whether the icon is symbolic or not. + line="3608">Whether the icon is symbolic or not. @@ -78930,7 +78930,7 @@ g_object_unref (icon); Creates a new icon theme object. + line="817">Creates a new icon theme object. Icon theme objects are used to lookup up an icon by name in a particular icon theme. Usually, you’ll want to use @@ -78940,7 +78940,7 @@ a new icon theme object for scratch. the newly created `GtkIconTheme` object. + line="827">the newly created `GtkIconTheme` object. @@ -78948,7 +78948,7 @@ a new icon theme object for scratch. c:identifier="gtk_icon_theme_get_for_display"> Gets the icon theme object associated with @display. + line="860">Gets the icon theme object associated with @display. If this function has not previously been called for the given display, a new icon theme object will be created and associated @@ -78960,7 +78960,7 @@ this function a single icon theme object will be shared between users. A unique `GtkIconTheme` associated with + line="873">A unique `GtkIconTheme` associated with the given display. This icon theme is associated with the display and can be used as long as the display is open. Do not ref or unref it. @@ -78969,7 +78969,7 @@ this function a single icon theme object will be shared between users. a `GdkDisplay` + line="862">a `GdkDisplay` @@ -78978,7 +78978,7 @@ this function a single icon theme object will be shared between users. c:identifier="gtk_icon_theme_add_resource_path"> Adds a resource path that will be looked at when looking + line="1616">Adds a resource path that will be looked at when looking for icons, similar to search paths. See [method@Gtk.IconTheme.set_resource_path]. @@ -78993,13 +78993,13 @@ available as part of the icon theme. a `GtkIconTheme` + line="1618">a `GtkIconTheme` a resource path + line="1619">a resource path @@ -79008,7 +79008,7 @@ available as part of the icon theme. c:identifier="gtk_icon_theme_add_search_path"> Appends a directory to the search path. + line="1519">Appends a directory to the search path. See [method@Gtk.IconTheme.set_search_path]. @@ -79019,13 +79019,13 @@ See [method@Gtk.IconTheme.set_search_path]. a `GtkIconTheme` + line="1521">a `GtkIconTheme` directory name to append to the icon path + line="1522">directory name to append to the icon path @@ -79035,20 +79035,20 @@ See [method@Gtk.IconTheme.set_search_path]. glib:get-property="display"> Returns the display that the `GtkIconTheme` object was + line="4123">Returns the display that the `GtkIconTheme` object was created for. the display of @icon_theme + line="4130">the display of @icon_theme a `GtkIconTheme` + line="4125">a `GtkIconTheme` @@ -79058,12 +79058,12 @@ created for. glib:get-property="icon-names"> Lists the names of icons in the current icon theme. + line="2734">Lists the names of icons in the current icon theme. a string array + line="2740">a string array holding the names of all the icons in the theme. You must free the array using g_strfreev(). @@ -79074,7 +79074,7 @@ created for. a `GtkIconTheme` + line="2736">a `GtkIconTheme` @@ -79083,7 +79083,7 @@ created for. c:identifier="gtk_icon_theme_get_icon_sizes"> Returns an array of integers describing the sizes at which + line="2657">Returns an array of integers describing the sizes at which the icon is available without scaling. A size of -1 means that the icon is available in a scalable @@ -79092,7 +79092,7 @@ format. The array is zero-terminated. A newly + line="2668">A newly allocated array describing the sizes at which the icon is available. The array should be freed with g_free() when it is no longer needed. @@ -79104,13 +79104,13 @@ format. The array is zero-terminated. a `GtkIconTheme` + line="2659">a `GtkIconTheme` the name of an icon + line="2660">the name of an icon @@ -79120,14 +79120,14 @@ format. The array is zero-terminated. glib:get-property="resource-path"> Gets the current resource path. + line="1589">Gets the current resource path. See [method@Gtk.IconTheme.set_resource_path]. + line="1597"> A list of resource paths @@ -79137,7 +79137,7 @@ See [method@Gtk.IconTheme.set_resource_path]. a `GtkIconTheme` + line="1591">a `GtkIconTheme` @@ -79147,14 +79147,14 @@ See [method@Gtk.IconTheme.set_resource_path]. glib:get-property="search-path"> Gets the current search path. + line="1492">Gets the current search path. See [method@Gtk.IconTheme.set_search_path]. + line="1500"> a list of icon theme path directories @@ -79164,7 +79164,7 @@ See [method@Gtk.IconTheme.set_search_path]. a `GtkIconTheme` + line="1494">a `GtkIconTheme` @@ -79174,7 +79174,7 @@ See [method@Gtk.IconTheme.set_search_path]. glib:get-property="theme-name"> Gets the current icon theme name. + line="1696">Gets the current icon theme name. Returns (transfer full): the current icon theme name, @@ -79185,7 +79185,7 @@ Returns (transfer full): the current icon theme name, a `GtkIconTheme` + line="1698">a `GtkIconTheme` @@ -79195,26 +79195,26 @@ Returns (transfer full): the current icon theme name, version="4.2"> Checks whether an icon theme includes an icon + line="2601">Checks whether an icon theme includes an icon for a particular `GIcon`. %TRUE if @self includes an icon for @gicon + line="2609">%TRUE if @self includes an icon for @gicon a `GtkIconTheme` + line="2603">a `GtkIconTheme` a `GIcon` + line="2604">a `GIcon` @@ -79222,13 +79222,13 @@ for a particular `GIcon`. Checks whether an icon theme includes an icon + line="2564">Checks whether an icon theme includes an icon for a particular name. %TRUE if @self includes an + line="2572">%TRUE if @self includes an icon for @icon_name. @@ -79236,13 +79236,13 @@ for a particular name. a `GtkIconTheme` + line="2566">a `GtkIconTheme` the name of an icon + line="2567">the name of an icon @@ -79251,7 +79251,7 @@ for a particular name. c:identifier="gtk_icon_theme_lookup_by_gicon"> Looks up a icon for a desired size and window scale. + line="4046">Looks up a icon for a desired size and window scale. The icon can then be rendered by using it as a `GdkPaintable`, or you can get information such as the filename and size. @@ -79259,7 +79259,7 @@ or you can get information such as the filename and size. a `GtkIconPaintable` containing + line="4060">a `GtkIconPaintable` containing information about the icon. Unref with g_object_unref() @@ -79267,37 +79267,37 @@ or you can get information such as the filename and size. a `GtkIconTheme` + line="4048">a `GtkIconTheme` the `GIcon` to look up + line="4049">the `GIcon` to look up desired icon size + line="4050">desired icon size the desired scale + line="4051">the desired scale text direction the icon will be displayed in + line="4052">text direction the icon will be displayed in flags modifying the behavior of the icon lookup + line="4053">flags modifying the behavior of the icon lookup @@ -79305,7 +79305,7 @@ or you can get information such as the filename and size. Looks up a named icon for a desired size and window scale, + line="2432">Looks up a named icon for a desired size and window scale, returning a `GtkIconPaintable`. The icon can then be rendered by using it as a `GdkPaintable`, @@ -79325,7 +79325,7 @@ GtkWidgetClass.css-changed() function. a `GtkIconPaintable` object + line="2459">a `GtkIconPaintable` object containing the icon. @@ -79333,13 +79333,13 @@ GtkWidgetClass.css-changed() function. a `GtkIconTheme` + line="2434">a `GtkIconTheme` the name of the icon to lookup + line="2435">the name of the icon to lookup desired icon size. + line="2437">desired icon size. the window scale this will be displayed on + line="2438">the window scale this will be displayed on text direction the icon will be displayed in + line="2439">text direction the icon will be displayed in flags modifying the behavior of the icon lookup + line="2440">flags modifying the behavior of the icon lookup @@ -79381,7 +79381,7 @@ GtkWidgetClass.css-changed() function. glib:set-property="resource-path"> Sets the resource paths that will be looked at when + line="1549">Sets the resource paths that will be looked at when looking for icons, similar to search paths. The resources are considered as part of the hicolor icon theme @@ -79400,7 +79400,7 @@ but they are treated like unthemed icons. a `GtkIconTheme` + line="1551">a `GtkIconTheme` allow-none="1"> + line="1552"> NULL-terminated array of resource paths that are searched for icons @@ -79423,7 +79423,7 @@ but they are treated like unthemed icons. glib:set-property="search-path"> Sets the search path for the icon theme object. + line="1449">Sets the search path for the icon theme object. When looking for an icon theme, GTK will search for a subdirectory of one or more of the directories in @path with the same name @@ -79446,7 +79446,7 @@ rather than directly on the icon path.) a `GtkIconTheme` + line="1451">a `GtkIconTheme` allow-none="1"> NULL-terminated + line="1452">NULL-terminated array of directories that are searched for icon themes @@ -79468,7 +79468,7 @@ rather than directly on the icon path.) glib:set-property="theme-name"> Sets the name of the icon theme that the `GtkIconTheme` object uses + line="1650">Sets the name of the icon theme that the `GtkIconTheme` object uses overriding system configuration. This function cannot be called on the icon theme objects returned @@ -79481,7 +79481,7 @@ from [func@Gtk.IconTheme.get_for_display]. a `GtkIconTheme` + line="1652">a `GtkIconTheme` allow-none="1"> name of icon theme to use instead of + line="1653">name of icon theme to use instead of configured theme, or %NULL to unset a previously set custom theme @@ -79502,7 +79502,7 @@ from [func@Gtk.IconTheme.get_for_display]. getter="get_display"> The display that this icon theme object is attached to. + line="1008">The display that this icon theme object is attached to. getter="get_icon_names"> The icon names that are supported by the icon theme. + line="1018">The icon names that are supported by the icon theme. @@ -79522,7 +79522,7 @@ from [func@Gtk.IconTheme.get_for_display]. getter="get_resource_path"> Resource paths that will be looked at when looking for icons, + line="1044">Resource paths that will be looked at when looking for icons, similar to search paths. The resources are considered as part of the hicolor icon theme @@ -79541,7 +79541,7 @@ of a subdirectory are also considered as ultimate fallback. getter="get_search_path"> The search path for this icon theme. + line="1028">The search path for this icon theme. When looking for icons, GTK will search for a subdirectory of one or more of the directories in the search path with the same @@ -79560,7 +79560,7 @@ to be extended by adding icons in the user’s home directory.) default-value="NULL"> The name of the icon theme that is being used. + line="1061">The name of the icon theme that is being used. Unless set to a different value, this will be the value of the `GtkSettings:gtk-icon-theme-name` property of the `GtkSettings` @@ -79570,7 +79570,7 @@ object associated to the display of the icontheme object. Emitted when the icon theme changes. + line="990">Emitted when the icon theme changes. This can happen because current icon theme is switched or because GTK detects that a change has occurred in the @@ -85445,14 +85445,14 @@ with the [signal@Gtk.Label::activate-link] signal and the Creates a new label with the given text inside it. + line="2828">Creates a new label with the given text inside it. You can pass %NULL to get an empty label widget. the new `GtkLabel` + line="2836">the new `GtkLabel` @@ -85462,7 +85462,7 @@ You can pass %NULL to get an empty label widget. allow-none="1"> The text of the label + line="2830">The text of the label @@ -85471,7 +85471,7 @@ You can pass %NULL to get an empty label widget. c:identifier="gtk_label_new_with_mnemonic"> Creates a new `GtkLabel`, containing the text in @str. + line="2851">Creates a new `GtkLabel`, containing the text in @str. If characters in @str are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use @@ -85489,7 +85489,7 @@ and be activated by the mnemonic. the new `GtkLabel` + line="2871">the new `GtkLabel` @@ -85499,7 +85499,7 @@ and be activated by the mnemonic. allow-none="1"> The text of the label, with an underscore in front of the + line="2853">The text of the label, with an underscore in front of the mnemonic character @@ -85511,7 +85511,7 @@ and be activated by the mnemonic. Gets the label's attribute list. + line="3274">Gets the label's attribute list. This is the [struct@Pango.AttrList] that was set on the label using [method@Gtk.Label.set_attributes], if any. This function does not @@ -85523,14 +85523,14 @@ attributes for the label, use the attribute list + line="3287">the attribute list a `GtkLabel` + line="3276">a `GtkLabel` @@ -85538,7 +85538,7 @@ attributes for the label, use Returns the URI for the currently active link in the label. + line="5809">Returns the URI for the currently active link in the label. The active link is the one under the mouse pointer or, in a selectable label, the link in which the text cursor is currently @@ -85550,14 +85550,14 @@ handler or for use in a [signal@Gtk.Widget::query-tooltip] handler. the currently active URI + line="5822">the currently active URI a `GtkLabel` + line="5811">a `GtkLabel` @@ -85568,21 +85568,21 @@ handler or for use in a [signal@Gtk.Widget::query-tooltip] handler. Returns the ellipsizing position of the label. + line="3959">Returns the ellipsizing position of the label. See [method@Gtk.Label.set_ellipsize]. `PangoEllipsizeMode` + line="3967">`PangoEllipsizeMode` a `GtkLabel` + line="3961">a `GtkLabel` @@ -85593,21 +85593,21 @@ See [method@Gtk.Label.set_ellipsize]. Gets the extra menu model of @label. + line="6019">Gets the extra menu model of @label. See [method@Gtk.Label.set_extra_menu]. the menu model + line="6027">the menu model a `GtkLabel` + line="6021">a `GtkLabel` @@ -85618,21 +85618,21 @@ See [method@Gtk.Label.set_extra_menu]. Returns the justification of the label. + line="3912">Returns the justification of the label. See [method@Gtk.Label.set_justify]. `GtkJustification` + line="3920">`GtkJustification` a `GtkLabel` + line="3914">a `GtkLabel` @@ -85643,7 +85643,7 @@ See [method@Gtk.Label.set_justify]. Fetches the text from a label. + line="3322">Fetches the text from a label. The returned text includes any embedded underlines indicating mnemonics and Pango markup. (See [method@Gtk.Label.get_text]). @@ -85651,7 +85651,7 @@ mnemonics and Pango markup. (See [method@Gtk.Label.get_text]). the text of the label widget. This string is + line="3331">the text of the label widget. This string is owned by the widget and must not be modified or freed. @@ -85659,7 +85659,7 @@ mnemonics and Pango markup. (See [method@Gtk.Label.get_text]). a `GtkLabel` + line="3324">a `GtkLabel` @@ -85667,7 +85667,7 @@ mnemonics and Pango markup. (See [method@Gtk.Label.get_text]). Gets the `PangoLayout` used to display the label. + line="5248">Gets the `PangoLayout` used to display the label. The layout is useful to e.g. convert text positions to pixel positions, in combination with [method@Gtk.Label.get_layout_offsets]. @@ -85678,14 +85678,14 @@ at any time, so it should be considered read-only. the [class@Pango.Layout] for this label + line="5260">the [class@Pango.Layout] for this label a `GtkLabel` + line="5250">a `GtkLabel` @@ -85694,7 +85694,7 @@ at any time, so it should be considered read-only. c:identifier="gtk_label_get_layout_offsets"> Obtains the coordinates where the label will draw its `PangoLayout`. + line="5272">Obtains the coordinates where the label will draw its `PangoLayout`. The coordinates are useful to convert mouse events into coordinates inside the [class@Pango.Layout], e.g. to take some action if some part @@ -85709,7 +85709,7 @@ or [const@Pango.SCALE]. a `GtkLabel` + line="5274">a `GtkLabel` allow-none="1"> location to store X offset of layout + line="5275">location to store X offset of layout allow-none="1"> location to store Y offset of layout + line="5276">location to store Y offset of layout @@ -85742,7 +85742,7 @@ or [const@Pango.SCALE]. Gets the number of lines to which an ellipsized, wrapping + line="5891">Gets the number of lines to which an ellipsized, wrapping label should be limited. See [method@Gtk.Label.set_lines]. @@ -85750,14 +85750,14 @@ See [method@Gtk.Label.set_lines]. The number of lines + line="5900">The number of lines a `GtkLabel` + line="5893">a `GtkLabel` @@ -85768,21 +85768,21 @@ See [method@Gtk.Label.set_lines]. Retrieves the desired maximum width of @label, in characters. + line="4038">Retrieves the desired maximum width of @label, in characters. See [method@Gtk.Label.set_width_chars]. the maximum width of the label in characters. + line="4046">the maximum width of the label in characters. a `GtkLabel` + line="4040">a `GtkLabel` @@ -85793,7 +85793,7 @@ See [method@Gtk.Label.set_width_chars]. Return the mnemonic accelerator. + line="3069">Return the mnemonic accelerator. If the label has been set so that it has a mnemonic key this function returns the keyval used for the mnemonic accelerator. If there is no @@ -85802,14 +85802,14 @@ mnemonic set up it returns `GDK_KEY_VoidSymbol`. GDK keyval usable for accelerators, or `GDK_KEY_VoidSymbol` + line="3079">GDK keyval usable for accelerators, or `GDK_KEY_VoidSymbol` a `GtkLabel` + line="3071">a `GtkLabel` @@ -85820,7 +85820,7 @@ mnemonic set up it returns `GDK_KEY_VoidSymbol`. Retrieves the target of the mnemonic (keyboard shortcut) of this + line="3049">Retrieves the target of the mnemonic (keyboard shortcut) of this label. See [method@Gtk.Label.set_mnemonic_widget]. @@ -85828,7 +85828,7 @@ See [method@Gtk.Label.set_mnemonic_widget]. the target of the label’s mnemonic, + line="3058">the target of the label’s mnemonic, or %NULL if none has been set and the default algorithm will be used. @@ -85836,7 +85836,7 @@ See [method@Gtk.Label.set_mnemonic_widget]. a `GtkLabel` + line="3051">a `GtkLabel` @@ -85849,21 +85849,21 @@ See [method@Gtk.Label.set_mnemonic_widget]. value="natural-wrap-mode"/> Returns line wrap mode used by the label. + line="4183">Returns line wrap mode used by the label. See [method@Gtk.Label.set_natural_wrap_mode]. the natural line wrap mode + line="4191">the natural line wrap mode a `GtkLabel` + line="4185">a `GtkLabel` @@ -85874,19 +85874,19 @@ See [method@Gtk.Label.set_natural_wrap_mode]. Returns whether the label is selectable. + line="5015">Returns whether the label is selectable. %TRUE if the user can copy text from the label + line="5021">%TRUE if the user can copy text from the label a `GtkLabel` + line="5017">a `GtkLabel` @@ -85895,19 +85895,19 @@ See [method@Gtk.Label.set_natural_wrap_mode]. c:identifier="gtk_label_get_selection_bounds"> Gets the selected range of characters in the label. + line="5181">Gets the selected range of characters in the label. %TRUE if selection is non-empty + line="5189">%TRUE if selection is non-empty a `GtkLabel` + line="5183">a `GtkLabel` allow-none="1"> return location for start of selection, as a character offset + line="5184">return location for start of selection, as a character offset allow-none="1"> return location for end of selection, as a character offset + line="5185">return location for end of selection, as a character offset @@ -85941,19 +85941,19 @@ See [method@Gtk.Label.set_natural_wrap_mode]. value="single-line-mode"/> Returns whether the label is in single line mode. + line="5411">Returns whether the label is in single line mode. %TRUE when the label is in single line mode. + line="5417">%TRUE when the label is in single line mode. a `GtkLabel` + line="5413">a `GtkLabel` @@ -85965,7 +85965,7 @@ See [method@Gtk.Label.set_natural_wrap_mode]. Gets the tabs for @self. + line="6064">Gets the tabs for @self. The returned array will be %NULL if “standard” (8-space) tabs are used. Free the return value with [method@Pango.TabArray.free]. @@ -85973,7 +85973,7 @@ Free the return value with [method@Pango.TabArray.free]. copy of default tab array, + line="6073">copy of default tab array, or %NULL if standard tabs are used; must be freed with [method@Pango.TabArray.free]. @@ -85982,7 +85982,7 @@ Free the return value with [method@Pango.TabArray.free]. a `GtkLabel` + line="6066">a `GtkLabel` @@ -85990,7 +85990,7 @@ Free the return value with [method@Pango.TabArray.free]. Fetches the text from a label. + line="3858">Fetches the text from a label. The returned text is as it appears on screen. This does not include any embedded underlines indicating mnemonics or Pango markup. (See @@ -85999,7 +85999,7 @@ any embedded underlines indicating mnemonics or Pango markup. (See the text in the label widget. This is the internal + line="3868">the text in the label widget. This is the internal string used by the label, and must not be modified. @@ -86007,7 +86007,7 @@ any embedded underlines indicating mnemonics or Pango markup. (See a `GtkLabel` + line="3860">a `GtkLabel` @@ -86018,21 +86018,21 @@ any embedded underlines indicating mnemonics or Pango markup. (See Returns whether the label’s text is interpreted as Pango markup. + line="5327">Returns whether the label’s text is interpreted as Pango markup. See [method@Gtk.Label.set_use_markup]. %TRUE if the label’s text will be parsed for markup. + line="5335">%TRUE if the label’s text will be parsed for markup. a `GtkLabel` + line="5329">a `GtkLabel` @@ -86043,14 +86043,14 @@ See [method@Gtk.Label.set_use_markup]. Returns whether an embedded underlines in the label indicate mnemonics. + line="5366">Returns whether an embedded underlines in the label indicate mnemonics. See [method@Gtk.Label.set_use_underline]. %TRUE whether an embedded underline in the label indicates + line="5374">%TRUE whether an embedded underline in the label indicates the mnemonic accelerator keys. @@ -86058,7 +86058,7 @@ See [method@Gtk.Label.set_use_underline]. a `GtkLabel` + line="5368">a `GtkLabel` @@ -86069,21 +86069,21 @@ See [method@Gtk.Label.set_use_underline]. Retrieves the desired width of @label, in characters. + line="3998">Retrieves the desired width of @label, in characters. See [method@Gtk.Label.set_width_chars]. the width of the label in characters. + line="4006">the width of the label in characters. a `GtkLabel` + line="4000">a `GtkLabel` @@ -86094,21 +86094,21 @@ See [method@Gtk.Label.set_width_chars]. Returns whether lines in the label are automatically wrapped. + line="4091">Returns whether lines in the label are automatically wrapped. See [method@Gtk.Label.set_wrap]. %TRUE if the lines of the label are automatically wrapped. + line="4099">%TRUE if the lines of the label are automatically wrapped. a `GtkLabel` + line="4093">a `GtkLabel` @@ -86119,21 +86119,21 @@ See [method@Gtk.Label.set_wrap]. Returns line wrap mode used by the label. + line="4138">Returns line wrap mode used by the label. See [method@Gtk.Label.set_wrap_mode]. the line wrap mode + line="4146">the line wrap mode a `GtkLabel` + line="4140">a `GtkLabel` @@ -86144,21 +86144,21 @@ See [method@Gtk.Label.set_wrap_mode]. Gets the `xalign` of the label. + line="5936">Gets the `xalign` of the label. See the [property@Gtk.Label:xalign] property. the xalign property + line="5944">the xalign property a `GtkLabel` + line="5938">a `GtkLabel` @@ -86169,21 +86169,21 @@ See the [property@Gtk.Label:xalign] property. Gets the `yalign` of the label. + line="5980">Gets the `yalign` of the label. See the [property@Gtk.Label:yalign] property. the yalign property + line="5988">the yalign property a `GtkLabel` + line="5982">a `GtkLabel` @@ -86191,7 +86191,7 @@ See the [property@Gtk.Label:yalign] property. Selects a range of characters in the label, if the label is selectable. + line="5148">Selects a range of characters in the label, if the label is selectable. See [method@Gtk.Label.set_selectable]. If the label is not selectable, this function has no effect. If @start_offset or @@ -86204,19 +86204,19 @@ this function has no effect. If @start_offset or a `GtkLabel` + line="5150">a `GtkLabel` start offset (in characters not bytes) + line="5151">start offset (in characters not bytes) end offset (in characters not bytes) + line="5152">end offset (in characters not bytes) @@ -86227,7 +86227,7 @@ this function has no effect. If @start_offset or Apply attributes to the label text. + line="3238">Apply attributes to the label text. The attributes set with this function will be applied and merged with any other attributes previously effected by way of the @@ -86243,7 +86243,7 @@ be applied to the label after the markup string is parsed. a `GtkLabel` + line="3240">a `GtkLabel` allow-none="1"> a [struct@Pango.AttrList] + line="3241">a [struct@Pango.AttrList] @@ -86263,7 +86263,7 @@ be applied to the label after the markup string is parsed. Sets the mode used to ellipsize the text. + line="3930">Sets the mode used to ellipsize the text. The text will be ellipsized if there is not enough space to render the entire string. @@ -86275,13 +86275,13 @@ to render the entire string. a `GtkLabel` + line="3932">a `GtkLabel` a `PangoEllipsizeMode` + line="3933">a `PangoEllipsizeMode` @@ -86292,7 +86292,7 @@ to render the entire string. Sets a menu model to add when constructing + line="5998">Sets a menu model to add when constructing the context menu for @label. @@ -86302,7 +86302,7 @@ the context menu for @label. a `GtkLabel` + line="6000">a `GtkLabel` allow-none="1"> a `GMenuModel` + line="6001">a `GMenuModel` @@ -86322,7 +86322,7 @@ the context menu for @label. Sets the alignment of the lines in the text of the label relative to + line="3879">Sets the alignment of the lines in the text of the label relative to each other. %GTK_JUSTIFY_LEFT is the default value when the widget is first created @@ -86338,13 +86338,13 @@ only a single line. a `GtkLabel` + line="3881">a `GtkLabel` a `GtkJustification` + line="3882">a `GtkJustification` @@ -86355,7 +86355,7 @@ only a single line. Sets the text of the label. + line="3297">Sets the text of the label. The label is interpreted as including embedded underlines and/or Pango markup depending on the values of the [property@Gtk.Label:use-underline] @@ -86368,13 +86368,13 @@ and [property@Gtk.Label:use-markup] properties. a `GtkLabel` + line="3299">a `GtkLabel` the new text to set for the label + line="3300">the new text to set for the label @@ -86385,7 +86385,7 @@ and [property@Gtk.Label:use-markup] properties. Sets the number of lines to which an ellipsized, wrapping label + line="5865">Sets the number of lines to which an ellipsized, wrapping label should be limited. This has no effect if the label is not wrapping or ellipsized. @@ -86398,13 +86398,13 @@ Set this to -1 if you don’t want to limit the number of lines. a `GtkLabel` + line="5867">a `GtkLabel` the desired number of lines, or -1 + line="5868">the desired number of lines, or -1 @@ -86412,7 +86412,7 @@ Set this to -1 if you don’t want to limit the number of lines. Sets the labels text and attributes from markup. + line="3770">Sets the labels text and attributes from markup. The string must be marked up with Pango markup (see [func@Pango.parse_markup]). @@ -86447,13 +86447,13 @@ See also: [method@Gtk.Label.set_text] a `GtkLabel` + line="3772">a `GtkLabel` a markup string + line="3773">a markup string @@ -86462,7 +86462,7 @@ See also: [method@Gtk.Label.set_text] c:identifier="gtk_label_set_markup_with_mnemonic"> Sets the labels text, attributes and mnemonic from markup. + line="3823">Sets the labels text, attributes and mnemonic from markup. Parses @str which is marked up with Pango markup (see [func@Pango.parse_markup]), setting the label’s text and attribute list based on the parse results. @@ -86479,13 +86479,13 @@ automatically, or explicitly using [method@Gtk.Label.set_mnemonic_widget]. a `GtkLabel` + line="3825">a `GtkLabel` a markup string + line="3826">a markup string @@ -86496,7 +86496,7 @@ automatically, or explicitly using [method@Gtk.Label.set_mnemonic_widget]. Sets the desired maximum width in characters of @label to @n_chars. + line="4016">Sets the desired maximum width in characters of @label to @n_chars. @@ -86505,13 +86505,13 @@ automatically, or explicitly using [method@Gtk.Label.set_mnemonic_widget]. a `GtkLabel` + line="4018">a `GtkLabel` the new desired maximum width, in characters. + line="4019">the new desired maximum width, in characters. @@ -86522,7 +86522,7 @@ automatically, or explicitly using [method@Gtk.Label.set_mnemonic_widget]. Associate the label with its mnemonic target. + line="2997">Associate the label with its mnemonic target. If the label has been set so that it has a mnemonic key (using i.e. [method@Gtk.Label.set_markup_with_mnemonic], @@ -86547,7 +86547,7 @@ and toggle focus between the colliding widgets otherwise. a `GtkLabel` + line="2999">a `GtkLabel` allow-none="1"> the target `GtkWidget`, or %NULL to unset + line="3000">the target `GtkWidget`, or %NULL to unset @@ -86569,7 +86569,7 @@ and toggle focus between the colliding widgets otherwise. value="natural-wrap-mode"/> Select the line wrapping for the natural size request. + line="4156">Select the line wrapping for the natural size request. This only affects the natural size requested, for the actual wrapping used, see the [property@Gtk.Label:wrap-mode] property. @@ -86581,13 +86581,13 @@ see the [property@Gtk.Label:wrap-mode] property. a `GtkLabel` + line="4158">a `GtkLabel` the line wrapping mode + line="4159">the line wrapping mode @@ -86598,7 +86598,7 @@ see the [property@Gtk.Label:wrap-mode] property. Makes text in the label selectable. + line="4961">Makes text in the label selectable. Selectable labels allow the user to select text from the label, for copy-and-paste. @@ -86610,13 +86610,13 @@ for copy-and-paste. a `GtkLabel` + line="4963">a `GtkLabel` %TRUE to allow selecting text in the label + line="4964">%TRUE to allow selecting text in the label @@ -86628,7 +86628,7 @@ for copy-and-paste. value="single-line-mode"/> Sets whether the label is in single line mode. + line="5385">Sets whether the label is in single line mode. @@ -86637,13 +86637,13 @@ for copy-and-paste. a `GtkLabel` + line="5387">a `GtkLabel` %TRUE if the label should be in single line mode + line="5388">%TRUE if the label should be in single line mode @@ -86655,7 +86655,7 @@ for copy-and-paste. Sets the default tab stops for paragraphs in @self. + line="6037">Sets the default tab stops for paragraphs in @self. @@ -86664,7 +86664,7 @@ for copy-and-paste. a `GtkLabel` + line="6039">a `GtkLabel` allow-none="1"> tabs as a `PangoTabArray` + line="6040">tabs as a `PangoTabArray` @@ -86681,7 +86681,7 @@ for copy-and-paste. Sets the text within the `GtkLabel` widget. + line="3200">Sets the text within the `GtkLabel` widget. It overwrites any text that was there before. @@ -86701,13 +86701,13 @@ See also: [method@Gtk.Label.set_markup] a `GtkLabel` + line="3202">a `GtkLabel` The text you want to set + line="3203">The text you want to set @@ -86716,7 +86716,7 @@ See also: [method@Gtk.Label.set_markup] c:identifier="gtk_label_set_text_with_mnemonic"> Sets the label’s text from the string @str. + line="4255">Sets the label’s text from the string @str. If characters in @str are preceded by an underscore, they are underlined indicating that they represent a keyboard accelerator called a mnemonic. @@ -86730,13 +86730,13 @@ automatically, or explicitly using [method@Gtk.Label.set_mnemonic_widget]. a `GtkLabel` + line="4257">a `GtkLabel` a string + line="4258">a string @@ -86747,7 +86747,7 @@ automatically, or explicitly using [method@Gtk.Label.set_mnemonic_widget]. Sets whether the text of the label contains markup. + line="5304">Sets whether the text of the label contains markup. See [method@Gtk.Label.set_markup]. @@ -86758,13 +86758,13 @@ See [method@Gtk.Label.set_markup]. a `GtkLabel` + line="5306">a `GtkLabel` %TRUE if the label’s text should be parsed for markup. + line="5307">%TRUE if the label’s text should be parsed for markup. @@ -86775,7 +86775,7 @@ See [method@Gtk.Label.set_markup]. Sets whether underlines in the text indicate mnemonics. + line="5345">Sets whether underlines in the text indicate mnemonics. @@ -86784,13 +86784,13 @@ See [method@Gtk.Label.set_markup]. a `GtkLabel` + line="5347">a `GtkLabel` %TRUE if underlines in the text indicate mnemonics + line="5348">%TRUE if underlines in the text indicate mnemonics @@ -86801,7 +86801,7 @@ See [method@Gtk.Label.set_markup]. Sets the desired width in characters of @label to @n_chars. + line="3977">Sets the desired width in characters of @label to @n_chars. @@ -86810,13 +86810,13 @@ See [method@Gtk.Label.set_markup]. a `GtkLabel` + line="3979">a `GtkLabel` the new desired width, in characters. + line="3980">the new desired width, in characters. @@ -86827,7 +86827,7 @@ See [method@Gtk.Label.set_markup]. Toggles line wrapping within the `GtkLabel` widget. + line="4056">Toggles line wrapping within the `GtkLabel` widget. %TRUE makes it break lines if text exceeds the widget’s size. %FALSE lets the text get cut off by the edge of the widget if @@ -86846,13 +86846,13 @@ set the label’s width using [method@Gtk.Widget.set_size_request]. a `GtkLabel` + line="4058">a `GtkLabel` the setting + line="4059">the setting @@ -86863,7 +86863,7 @@ set the label’s width using [method@Gtk.Widget.set_size_request]. Controls how line wrapping is done. + line="4109">Controls how line wrapping is done. This only affects the label if line wrapping is on. (See [method@Gtk.Label.set_wrap]) The default is %PANGO_WRAP_WORD @@ -86879,13 +86879,13 @@ property. a `GtkLabel` + line="4111">a `GtkLabel` the line wrapping mode + line="4112">the line wrapping mode @@ -86896,7 +86896,7 @@ property. Sets the `xalign` of the label. + line="5910">Sets the `xalign` of the label. See the [property@Gtk.Label:xalign] property. @@ -86907,13 +86907,13 @@ See the [property@Gtk.Label:xalign] property. a `GtkLabel` + line="5912">a `GtkLabel` the new xalign value, between 0 and 1 + line="5913">the new xalign value, between 0 and 1 @@ -86924,7 +86924,7 @@ See the [property@Gtk.Label:xalign] property. Sets the `yalign` of the label. + line="5954">Sets the `yalign` of the label. See the [property@Gtk.Label:yalign] property. @@ -86935,13 +86935,13 @@ See the [property@Gtk.Label:yalign] property. a `GtkLabel` + line="5956">a `GtkLabel` the new yalign value, between 0 and 1 + line="5957">the new yalign value, between 0 and 1 @@ -86957,7 +86957,7 @@ See the [property@Gtk.Label:yalign] property. value="gtk_label_set_attributes"/> A list of style attributes to apply to the text of the label. + line="2383">A list of style attributes to apply to the text of the label. value="gtk_label_set_ellipsize"/> The preferred place to ellipsize the string, if the label does + line="2536">The preferred place to ellipsize the string, if the label does not have enough room to display the entire string. Note that setting this property to a value other than @@ -86995,7 +86995,7 @@ and [method@Gtk.Label.set_width_chars]. value="gtk_label_set_extra_menu"/> A menu model whose contents will be appended to the context menu. + line="2620">A menu model whose contents will be appended to the context menu. The alignment of the lines in the text of the label, relative to each other. + line="2416">The alignment of the lines in the text of the label, relative to each other. This does *not* affect the alignment of the label within its allocation. See [property@Gtk.Label:xalign] for that. @@ -87023,7 +87023,7 @@ See [property@Gtk.Label:xalign] for that. The contents of the label. + line="2362">The contents of the label. If the string contains Pango markup (see [func@Pango.parse_markup]), you will have to set the [property@Gtk.Label:use-markup] property to @@ -87047,7 +87047,7 @@ for the label to display them. The number of lines to which an ellipsized, wrapping label + line="2605">The number of lines to which an ellipsized, wrapping label should be limited. This property has no effect if the label is not wrapping or ellipsized. @@ -87066,7 +87066,7 @@ Set this property to -1 if you don't want to limit the number of lines. value="gtk_label_set_max_width_chars"/> The desired maximum width of the label, in characters. + line="2588">The desired maximum width of the label, in characters. If this property is set to -1, the width will be calculated automatically. @@ -87083,7 +87083,7 @@ determine the width of ellipsized and wrapped labels. value="gtk_label_get_mnemonic_keyval"/> The mnemonic accelerator key for the label. + line="2515">The mnemonic accelerator key for the label. value="gtk_label_set_mnemonic_widget"/> The widget to be activated when the labels mnemonic key is pressed. + line="2526">The widget to be activated when the labels mnemonic key is pressed. value="gtk_label_set_natural_wrap_mode"/> Select the line wrapping for the natural size request. + line="2486">Select the line wrapping for the natural size request. This only affects the natural size requested. For the actual wrapping used, see the [property@Gtk.Label:wrap-mode] property. @@ -87134,7 +87134,7 @@ The default is %GTK_NATURAL_WRAP_INHERIT, which inherits the behavior of the value="gtk_label_set_selectable"/> Whether the label text can be selected with the mouse. + line="2505">Whether the label text can be selected with the mouse. Whether the label is in single line mode. + line="2573">Whether the label is in single line mode. In single line mode, the height of the label does not depend on the actual text, it is always set to ascent + descent of the font. This @@ -87167,7 +87167,7 @@ of text changes would be distracting, e.g. in a statusbar. Custom tabs for this label. + line="2630">Custom tabs for this label. value="gtk_label_set_use_markup"/> %TRUE if the text of the label includes Pango markup. + line="2393">%TRUE if the text of the label includes Pango markup. See [func@Pango.parse_markup]. @@ -87199,7 +87199,7 @@ See [func@Pango.parse_markup]. value="gtk_label_set_use_underline"/> %TRUE if the text of the label indicates a mnemonic with an _ + line="2405">%TRUE if the text of the label indicates a mnemonic with an _ before the mnemonic character. @@ -87215,7 +87215,7 @@ before the mnemonic character. value="gtk_label_set_width_chars"/> The desired width of the label, in characters. + line="2556">The desired width of the label, in characters. If this property is set to -1, the width will be calculated automatically. @@ -87234,7 +87234,7 @@ determine the width of ellipsized and wrapped labels. %TRUE if the label text will wrap if it gets too wide. + line="2458">%TRUE if the label text will wrap if it gets too wide. value="gtk_label_set_wrap_mode"/> Controls how the line wrapping is done. + line="2468">Controls how the line wrapping is done. This only affects the formatting if line wrapping is on (see the [property@Gtk.Label:wrap] property). The default is %PANGO_WRAP_WORD, @@ -87269,7 +87269,7 @@ property. The horizontal alignment of the label text inside its size allocation. + line="2430">The horizontal alignment of the label text inside its size allocation. Compare this to [property@Gtk.Widget:halign], which determines how the labels size allocation is positioned in the space available for the label. @@ -87285,7 +87285,7 @@ labels size allocation is positioned in the space available for the label. The vertical alignment of the label text inside its size allocation. + line="2444">The vertical alignment of the label text inside its size allocation. Compare this to [property@Gtk.Widget:valign], which determines how the labels size allocation is positioned in the space available for the label. @@ -87294,7 +87294,7 @@ labels size allocation is positioned in the space available for the label. Gets emitted when the user activates a link in the label. + line="2316">Gets emitted when the user activates a link in the label. The ::activate-current-link is a [keybinding signal](class.SignalAction.html). @@ -87309,21 +87309,21 @@ The default bindings for this signal are all forms of the <kbd>Enter</k Gets emitted to activate a URI. + line="2338">Gets emitted to activate a URI. Applications may connect to it to override the default behaviour, which is to call [method@Gtk.FileLauncher.launch]. %TRUE if the link has been activated + line="2348">%TRUE if the link has been activated the URI that is activated + line="2341">the URI that is activated @@ -87331,7 +87331,7 @@ which is to call [method@Gtk.FileLauncher.launch]. Gets emitted to copy the selection to the clipboard. + line="2297">Gets emitted to copy the selection to the clipboard. The ::copy-clipboard signal is a [keybinding signal](class.SignalAction.html). @@ -87343,7 +87343,7 @@ The default binding for this signal is <kbd>Ctrl</kbd>+<kbd>c& Gets emitted when the user initiates a cursor movement. + line="2255">Gets emitted when the user initiates a cursor movement. The ::move-cursor signal is a [keybinding signal](class.SignalAction.html). If the cursor is not visible in @entry, this signal causes the viewport to @@ -87369,19 +87369,19 @@ There are too many key combinations to list them all here. the granularity of the move, as a `GtkMovementStep` + line="2258">the granularity of the move, as a `GtkMovementStep` the number of @step units to move + line="2259">the number of @step units to move %TRUE if the move should extend the selection + line="2260">%TRUE if the move should extend the selection @@ -89119,19 +89119,19 @@ it from a plain `GtkButton`, it gets the .link style class. Creates a new `GtkLinkButton` with the URI as its text. + line="556">Creates a new `GtkLinkButton` with the URI as its text. a new link button widget. + line="562">a new link button widget. a valid URI + line="558">a valid URI @@ -89140,19 +89140,19 @@ it from a plain `GtkButton`, it gets the .link style class. c:identifier="gtk_link_button_new_with_label"> Creates a new `GtkLinkButton` containing a label. + line="603">Creates a new `GtkLinkButton` containing a label. a new link button widget. + line="610">a new link button widget. a valid URI + line="605">a valid URI the text of the button + line="606">the text of the button @@ -89172,12 +89172,12 @@ it from a plain `GtkButton`, it gets the .link style class. Retrieves the URI of the `GtkLinkButton`. + line="683">Retrieves the URI of the `GtkLinkButton`. a valid URI. The returned string is owned by the link button + line="689">a valid URI. The returned string is owned by the link button and should not be modified or freed. @@ -89185,7 +89185,7 @@ it from a plain `GtkButton`, it gets the .link style class. a `GtkLinkButton` + line="685">a `GtkLinkButton` @@ -89196,7 +89196,7 @@ it from a plain `GtkButton`, it gets the .link style class. Retrieves the “visited” state of the `GtkLinkButton`. + line="740">Retrieves the “visited” state of the `GtkLinkButton`. The button becomes visited when it is clicked. If the URI is changed on the button, the “visited” state is unset again. @@ -89206,14 +89206,14 @@ The state may also be changed using [method@Gtk.LinkButton.set_visited]. %TRUE if the link has been visited, %FALSE otherwise + line="751">%TRUE if the link has been visited, %FALSE otherwise a `GtkLinkButton` + line="742">a `GtkLinkButton` @@ -89224,7 +89224,7 @@ The state may also be changed using [method@Gtk.LinkButton.set_visited]. Sets @uri as the URI where the `GtkLinkButton` points. + line="659">Sets @uri as the URI where the `GtkLinkButton` points. As a side-effect this unsets the “visited” state of the button. @@ -89235,13 +89235,13 @@ As a side-effect this unsets the “visited” state of the button. a `GtkLinkButton` + line="661">a `GtkLinkButton` a valid URI + line="662">a valid URI @@ -89252,7 +89252,7 @@ As a side-effect this unsets the “visited” state of the button. Sets the “visited” state of the `GtkLinkButton`. + line="700">Sets the “visited” state of the `GtkLinkButton`. See [method@Gtk.LinkButton.get_visited] for more details. @@ -89263,13 +89263,13 @@ See [method@Gtk.LinkButton.get_visited] for more details. a `GtkLinkButton` + line="702">a `GtkLinkButton` the new “visited” state + line="703">the new “visited” state @@ -94120,7 +94120,7 @@ against at application run time. - + Like [func@get_micro_version], but from the headers used at @@ -127885,7 +127885,7 @@ manager that is usually part of the desktop environment, along with utilities that let the user change these settings. On Wayland, the settings are obtained either via a settings portal, -or by reading desktop settings from DConf. +or by reading desktop settings from [class@Gio.Settings]. On macOS, the settings are obtained from `NSUserDefaults`. @@ -181597,7 +181597,7 @@ and then unref all the widgets afterwards. c:identifier="gtk_window_set_auto_startup_notification"> Sets whether the window should request startup notification. + line="5979">Sets whether the window should request startup notification. By default, after showing the first `GtkWindow`, GTK calls [method@Gdk.Toplevel.set_startup_id]. Call this function @@ -181617,7 +181617,7 @@ showing the main window would automatically result in notification. %TRUE to automatically do startup notification + line="5981">%TRUE to automatically do startup notification @@ -181648,7 +181648,7 @@ called on them. c:identifier="gtk_window_set_interactive_debugging"> Opens or closes the [interactive debugger](running.html#interactive-debugging). + line="6277">Opens or closes the [interactive debugger](running.html#interactive-debugging). The debugger offers access to the widget hierarchy of the application and to useful debugging tools. @@ -181660,7 +181660,7 @@ and to useful debugging tools. %TRUE to enable interactive debugging + line="6279">%TRUE to enable interactive debugging @@ -181766,7 +181766,7 @@ titlebars. Drop the internal reference GTK holds on toplevel windows. + line="6795">Drop the internal reference GTK holds on toplevel windows. @@ -181775,7 +181775,7 @@ titlebars. The window to destroy + line="6797">The window to destroy @@ -181867,19 +181867,19 @@ notifications of the [property@Gtk.Window:fullscreened] property. Gets the child widget of @window. + line="6777">Gets the child widget of @window. the child widget of @window + line="6783">the child widget of @window a `GtkWindow` + line="6779">a `GtkWindow` @@ -182056,12 +182056,12 @@ not be %TRUE for the widget. Gets whether “focus rectangles” are supposed to be visible. + line="6082">Gets whether “focus rectangles” are supposed to be visible. %TRUE if “focus rectangles” are supposed to be visible + line="6088">%TRUE if “focus rectangles” are supposed to be visible in this window. @@ -182069,7 +182069,7 @@ not be %TRUE for the widget. a `GtkWindow` + line="6084">a `GtkWindow` @@ -182108,20 +182108,20 @@ If the window has no group, then the default group is returned. value="handle-menubar-accel"/> Returns whether this window reacts to F10 key presses by + line="6993">Returns whether this window reacts to F10 key presses by activating a menubar it contains. %TRUE if the window handles F10 + line="7000">%TRUE if the window handles F10 a `GtkWindow` + line="6995">a `GtkWindow` @@ -182179,12 +182179,12 @@ activating a menubar it contains. value="mnemonics-visible"/> Gets whether mnemonics are supposed to be visible. + line="6002">Gets whether mnemonics are supposed to be visible. %TRUE if mnemonics are supposed to be visible + line="6008">%TRUE if mnemonics are supposed to be visible in this window. @@ -182192,7 +182192,7 @@ activating a menubar it contains. a `GtkWindow` + line="6004">a `GtkWindow` @@ -182317,19 +182317,19 @@ gtk_window_set_titlebar(). Returns whether @window has an explicit window group. + line="5854">Returns whether @window has an explicit window group. %TRUE if @window has an explicit window group. + line="5860">%TRUE if @window has an explicit window group. a `GtkWindow` + line="5856">a `GtkWindow` @@ -182615,7 +182615,7 @@ as relevant. Sets the child widget of @window. + line="6747">Sets the child widget of @window. @@ -182624,7 +182624,7 @@ as relevant. a `GtkWindow` + line="6749">a `GtkWindow` allow-none="1"> the child widget + line="6750">the child widget @@ -182904,7 +182904,7 @@ to use [method@Gtk.Widget.grab_focus] instead of this function. Sets whether “focus rectangles” are supposed to be visible. + line="6114">Sets whether “focus rectangles” are supposed to be visible. This property is maintained by GTK based on user input, and should not be set by applications. @@ -182916,13 +182916,13 @@ and should not be set by applications. a `GtkWindow` + line="6116">a `GtkWindow` the new value + line="6117">the new value @@ -182935,7 +182935,7 @@ and should not be set by applications. value="handle-menubar-accel"/> Sets whether this window should react to F10 key presses + line="6964">Sets whether this window should react to F10 key presses by activating a menubar it contains. @@ -182945,13 +182945,13 @@ by activating a menubar it contains. a `GtkWindow` + line="6966">a `GtkWindow` %TRUE to make @window handle F10 + line="6967">%TRUE to make @window handle F10 @@ -183025,7 +183025,7 @@ property which is mentioned in the ICCCM. value="mnemonics-visible"/> Sets whether mnemonics are supposed to be visible. + line="6021">Sets whether mnemonics are supposed to be visible. This property is maintained by GTK based on user input, and should not be set by applications. @@ -183037,13 +183037,13 @@ and should not be set by applications. a `GtkWindow` + line="6023">a `GtkWindow` the new value + line="6024">the new value diff --git a/girs/GtkClutter-1.0.gir b/girs/GtkClutter-1.0.gir index 252ca2f18..b7f74c3ee 100644 --- a/girs/GtkClutter-1.0.gir +++ b/girs/GtkClutter-1.0.gir @@ -18,7 +18,7 @@ and/or use gtk-doc annotations. --> - + @@ -27,7 +27,7 @@ and/or use gtk-doc annotations. --> - + @@ -36,7 +36,7 @@ and/or use gtk-doc annotations. --> - + @@ -50,25 +50,25 @@ and/or use gtk-doc annotations. --> glib:get-type="gtk_clutter_actor_get_type" glib:type-struct="ActorClass"> A ClutterActor containing a #GtkWidget. - + Creates a new #GtkClutterActor. This widget can be used to embed a #GtkWidget into a Clutter scene, by retrieving the internal #GtkBin container using gtk_clutter_actor_get_widget() and adding the #GtkWidget to it. - + the newly created #GtkClutterActor @@ -76,7 +76,7 @@ gtk_clutter_actor_get_widget() and adding the #GtkWidget to it. Creates a new #GtkClutterActor widget. This widget can be used to embed a Gtk widget into a clutter scene. @@ -88,17 +88,17 @@ GtkWidget *bin = gtk_clutter_actor_get_widget (GTK_CLUTTER_ACTOR (actor)); gtk_container_add (GTK_CONTAINER (bin), contents); ]| - + the newly created #GtkClutterActor a #GtkWidget to pack into this #ClutterActor @@ -108,7 +108,7 @@ gtk_container_add (GTK_CONTAINER (bin), contents); c:identifier="gtk_clutter_actor_get_contents" glib:get-property="contents"> Retrieves the child of the #GtkBin used to hold the contents of @actor. This convenience function is the logical equivalent of: @@ -119,10 +119,10 @@ GtkWidget *bin; bin = gtk_clutter_actor_get_widget (GTK_CLUTTER_ACTOR (actor)); return gtk_bin_get_child (GTK_BIN (bin)); ]| - + a #GtkWidget, or %NULL if not content has been set @@ -130,7 +130,7 @@ return gtk_bin_get_child (GTK_BIN (bin)); a #GtkClutterActor @@ -138,19 +138,19 @@ return gtk_bin_get_child (GTK_BIN (bin)); Retrieves the #GtkBin used to hold the #GtkClutterActor:contents widget - + a #GtkBin a #GtkClutterActor @@ -162,7 +162,7 @@ return gtk_bin_get_child (GTK_BIN (bin)); transfer-ownership="none" getter="get_contents"> The #GtkWidget to be embedded into the #GtkClutterActor @@ -177,16 +177,15 @@ return gtk_bin_get_child (GTK_BIN (bin)); c:type="GtkClutterActorClass" glib:is-gtype-struct-for="Actor"> Base class for #GtkClutterActor. - + - + @@ -194,8 +193,7 @@ return gtk_bin_get_child (GTK_BIN (bin)); - + @@ -203,8 +201,7 @@ return gtk_bin_get_child (GTK_BIN (bin)); - + @@ -212,8 +209,7 @@ return gtk_bin_get_child (GTK_BIN (bin)); - + @@ -221,8 +217,7 @@ return gtk_bin_get_child (GTK_BIN (bin)); - + @@ -230,8 +225,7 @@ return gtk_bin_get_child (GTK_BIN (bin)); - + @@ -242,12 +236,12 @@ return gtk_bin_get_child (GTK_BIN (bin)); c:type="GtkClutterActorPrivate" disguised="1" opaque="1"> - + - + @@ -256,7 +250,7 @@ return gtk_bin_get_child (GTK_BIN (bin)); - + @@ -265,7 +259,7 @@ return gtk_bin_get_child (GTK_BIN (bin)); - + @@ -279,45 +273,45 @@ return gtk_bin_get_child (GTK_BIN (bin)); glib:get-type="gtk_clutter_embed_get_type" glib:type-struct="EmbedClass"> A #GtkWidget containing the default Clutter stage. The <structname>GtkClutterEmbed</structname> structure contains only private data and should be accessed using the provided API. - + Creates a new #GtkClutterEmbed widget. This widget can be + filename="gtk-clutter-embed.c" + line="1205">Creates a new #GtkClutterEmbed widget. This widget can be used to build a scene using Clutter API into a GTK+ application. - + the newly created #GtkClutterEmbed + filename="gtk-clutter-embed.c" + line="1211">the newly created #GtkClutterEmbed Retrieves the #ClutterStage from @embed. The returned stage can be + filename="gtk-clutter-embed.c" + line="1219">Retrieves the #ClutterStage from @embed. The returned stage can be used to add actors to the Clutter scene. - + the Clutter stage. You should never + filename="gtk-clutter-embed.c" + line="1226">the Clutter stage. You should never destroy or unref the returned actor. a #GtkClutterEmbed + filename="gtk-clutter-embed.c" + line="1221">a #GtkClutterEmbed @@ -327,21 +321,21 @@ used to add actors to the Clutter scene. glib:get-property="use-layout-size" version="1.4"> Retrieves whether the embedding uses the layout size, see + filename="gtk-clutter-embed.c" + line="1283">Retrieves whether the embedding uses the layout size, see gtk_clutter_embed_set_use_layout_size() for details. - + %TRUE if reporting stage size as widget size, %FALSE otherwise. + filename="gtk-clutter-embed.c" + line="1290">%TRUE if reporting stage size as widget size, %FALSE otherwise. a #GtkClutterEmbed + filename="gtk-clutter-embed.c" + line="1285">a #GtkClutterEmbed @@ -351,8 +345,8 @@ gtk_clutter_embed_set_use_layout_size() for details. glib:set-property="use-layout-size" version="1.4"> Changes the way @embed requests size. If @use_layout_size is + filename="gtk-clutter-embed.c" + line="1237">Changes the way @embed requests size. If @use_layout_size is %TRUE, the @embed widget will request the size that the LayoutManager reports as the preferred size. This means that a Gtk+ window will automatically get the natural and minimum @@ -364,21 +358,21 @@ will not request any size and its up to the embedder to make sure there is some size (by setting a custom size on the widget or a default size on the toplevel. This makes more sense when using the @embed as a viewport into a potentially unlimited clutter space. - + a #GtkClutterEmbed + filename="gtk-clutter-embed.c" + line="1239">a #GtkClutterEmbed a boolean + filename="gtk-clutter-embed.c" + line="1240">a boolean @@ -392,9 +386,8 @@ as a viewport into a potentially unlimited clutter space. getter="get_use_layout_size" default-value="FALSE"> Whether to use the reported size of the LayoutManager on the stage as the widget size. -See gtk_clutter_embed_set_use_layout_size() for details. + filename="gtk-clutter-embed.c" + line="1091">The #GtkWidget to be embedded into the #GtkClutterActor @@ -408,19 +401,18 @@ See gtk_clutter_embed_set_use_layout_size() for details. c:type="GtkClutterEmbedClass" glib:is-gtype-struct-for="Embed"> Base class for #GtkClutterEmbed. The <structname>GtkClutterEmbedClass</structname> contains only private data. - + - + @@ -428,8 +420,7 @@ data. - + @@ -437,8 +428,7 @@ data. - + @@ -446,8 +436,7 @@ data. - + @@ -455,8 +444,7 @@ data. - + @@ -464,8 +452,7 @@ data. - + @@ -476,12 +463,12 @@ data. c:type="GtkClutterEmbedPrivate" disguised="1" opaque="1"> - + - + @@ -490,7 +477,7 @@ data. - + @@ -499,7 +486,7 @@ data. - + @@ -508,7 +495,7 @@ data. - + @@ -517,7 +504,7 @@ data. - + @@ -526,7 +513,7 @@ data. - + @@ -535,7 +522,7 @@ data. - + @@ -544,7 +531,7 @@ data. - + @@ -553,7 +540,7 @@ data. - + @@ -562,7 +549,7 @@ data. - + @@ -571,7 +558,7 @@ data. - + @@ -586,10 +573,10 @@ data. glib:get-type="gtk_clutter_texture_get_type" glib:type-struct="TextureClass"> The <structname>GtkClutterTexture</structname> structure contains only private data and should be accessed using the provided API. - + @@ -598,13 +585,12 @@ only private data and should be accessed using the provided API. c:identifier="gtk_clutter_texture_new" version="1.0"> Creates a new #GtkClutterTexture actor. - + the newly created #GtkClutterTexture instance @@ -621,21 +607,20 @@ only private data and should be accessed using the provided API. version="1.0" throws="1"> Sets the contents of @texture using the @icon_name from the current icon theme. - + %TRUE on success, %FALSE on failure a #GtkClutterTexture @@ -644,19 +629,19 @@ current icon theme. nullable="1" allow-none="1"> a #GtkWidget or %NULL the name of the icon the icon size or -1 @@ -666,26 +651,25 @@ current icon theme. c:identifier="gtk_clutter_texture_set_from_pixbuf" throws="1"> Sets the contents of @texture with a copy of @pixbuf. - + %TRUE on success, %FALSE on failure. a #GtkClutterTexture a #GdkPixbuf @@ -695,39 +679,38 @@ current icon theme. c:identifier="gtk_clutter_texture_set_from_stock" throws="1"> Sets the contents of @texture using the stock icon @stock_id, as rendered by @widget. - + %TRUE on success, %FALSE on failure. a #GtkClutterTexture a #GtkWidget the stock id of the icon the size of the icon, or -1 @@ -742,10 +725,10 @@ rendered by @widget. glib:is-gtype-struct-for="Texture" version="1.0"> The <structname>GtkClutterTextureClass</structname> structure contains only private data. - + @@ -754,21 +737,21 @@ only private data. version="1.0" c:type="GtkClutterTextureError"> Error enumeration for #GtkClutterTexture - + Invalid stock id - + @@ -777,7 +760,7 @@ only private data. - + @@ -786,7 +769,7 @@ only private data. - + @@ -800,49 +783,47 @@ only private data. glib:get-type="gtk_clutter_window_get_type" glib:type-struct="WindowClass"> A #GtkWindow containing a #ClutterStage. The <structname>GtkClutterWindow</structname> structure contains only private data and it should be accessed using the provided API. - + Creates a new #GtkClutterWindow widget. This window provides a hidden #ClutterStage on which the child #GtkWidget<!-- -->s are placed. This allows other #ClutterActor<!-- -->s to also be placed on the stage. - + the newly created #GtkClutterWindow Retrieves the #ClutterStage that this window is embedding Use this function if you wish to add other actors to the #ClutterStage. - + the window's #ClutterStage the #GtkClutterWindow @@ -859,19 +840,18 @@ Use this function if you wish to add other actors to the #ClutterStage. c:type="GtkClutterWindowClass" glib:is-gtype-struct-for="Window"> Base class for #GtkClutterWindow. The <structname>GtkClutterWindowClass</structname> structure contains only private data. - + - + @@ -879,8 +859,7 @@ only private data. - + @@ -888,8 +867,7 @@ only private data. - + @@ -897,8 +875,7 @@ only private data. - + @@ -906,8 +883,7 @@ only private data. - + @@ -915,8 +891,7 @@ only private data. - + @@ -927,13 +902,13 @@ only private data. c:type="GtkClutterWindowPrivate" disguised="1" opaque="1"> - + Returns a #GOptionGroup for the command line arguments recognized by Clutter. You should add this group to your #GOptionContext with g_option_context_add_group(), if you are using g_option_context_parse() @@ -969,10 +944,10 @@ is functionally equivalent to: After g_option_context_parse() on a #GOptionContext containing the the returned #GOptionGroup has returned %TRUE, Clutter and GTK-Clutter are guaranteed to be initialized. - + a #GOptionGroup for the commandline arguments recognized by ClutterGtk @@ -980,7 +955,7 @@ guaranteed to be initialized. #GtkClutterActor is a #ClutterContainer that also allows embedding any #GtkWidget in a Clutter scenegraph. @@ -990,7 +965,7 @@ use #GtkClutterActor in a #ClutterStage handled by Clutter alone. #GtkClutterEmbed is a GTK+ widget embedding a #ClutterStage inside a GTK+ application. @@ -1035,13 +1010,13 @@ subclassing #GtkClutterEmbed, to avoid breaking internal state. #GtkClutterTexture is a simple sub-class of #ClutterTexture that integrates nicely with #GdkPixbuf, #GtkIconTheme and stock icons. In order to properly integrate a Clutter scene into a GTK+ applications a certain degree of state must be retrieved from GTK+ itself. @@ -1051,7 +1026,7 @@ GTK+ stock items and icon themes. #GtkClutterWindow is a #GtkWindow sub-class that embeds a Clutter stage. #GtkClutterWindow behaves exactly like a #GtkWindow, except that its @@ -1063,13 +1038,13 @@ gtk_clutter_window_get_stage(). This function should be called instead of clutter_init() and gtk_init(). - + %CLUTTER_INIT_SUCCESS on success, a negative integer on failure. @@ -1082,7 +1057,7 @@ gtk_init(). nullable="1" allow-none="1"> pointer to the arguments count, or %NULL @@ -1093,7 +1068,7 @@ gtk_init(). nullable="1" allow-none="1"> pointer to the arguments vector, or %NULL @@ -1106,13 +1081,13 @@ gtk_init(). c:identifier="gtk_clutter_init_with_args" throws="1"> This function should be called instead of clutter_init() and gtk_init_with_args(). - + %CLUTTER_INIT_SUCCESS on success, a negative integer on failure. @@ -1125,7 +1100,7 @@ gtk_init_with_args(). nullable="1" allow-none="1"> a pointer to the number of command line arguments, or %NULL @@ -1137,7 +1112,7 @@ gtk_init_with_args(). nullable="1" allow-none="1"> a pointer to the array of command line arguments, or %NULL @@ -1149,7 +1124,7 @@ gtk_init_with_args(). nullable="1" allow-none="1"> a string which is displayed in the first line of <option>--help</option> output, after <literal><replaceable>programname</replaceable> [OPTION...]</literal> @@ -1160,7 +1135,7 @@ gtk_init_with_args(). nullable="1" allow-none="1"> a %NULL-terminated array of #GOptionEntry<!-- -->s describing the options of your program @@ -1173,7 +1148,7 @@ gtk_init_with_args(). nullable="1" allow-none="1"> a translation domain to use for translating the <option>--help</option> output for the options in @entries with gettext(), or %NULL diff --git a/girs/GtkSource-3.0.gir b/girs/GtkSource-3.0.gir index 01fcae016..131dad7c4 100644 --- a/girs/GtkSource-3.0.gir +++ b/girs/GtkSource-3.0.gir @@ -243,10 +243,7 @@ previous source mark can be of any category. line="2154">a #GtkSourceBuffer. - + an iterator. @@ -287,7 +284,9 @@ gtk_source_buffer_end_not_undoable_action() blocks. - + Determines whether a source buffer can redo the last action @@ -308,7 +307,9 @@ gtk_source_buffer_end_not_undoable_action() blocks. - + Determines whether a source buffer can undo the last action. @@ -562,10 +563,7 @@ next source mark can be of any category. line="2120">a #GtkSourceBuffer. - + an iterator. @@ -617,7 +615,8 @@ Use g_strfreev() to free the array if it is no longer needed. + c:identifier="gtk_source_buffer_get_highlight_matching_brackets" + glib:get-property="highlight-matching-brackets"> Determines whether bracket match highlighting is activated for the @@ -640,7 +639,8 @@ brackets. + c:identifier="gtk_source_buffer_get_highlight_syntax" + glib:get-property="highlight-syntax"> Determines whether syntax highlighting is activated in the source @@ -663,6 +663,7 @@ buffer. @@ -681,7 +682,8 @@ buffer. + c:identifier="gtk_source_buffer_get_language" + glib:get-property="language"> Returns the #GtkSourceLanguage associated with the buffer, @@ -705,7 +707,8 @@ with the buffer, or %NULL. + c:identifier="gtk_source_buffer_get_max_undo_levels" + glib:get-property="max-undo-levels"> Determines the number of undo levels the buffer will track for buffer edits. @@ -808,7 +811,8 @@ a newly allocated #GSList. + c:identifier="gtk_source_buffer_get_style_scheme" + glib:get-property="style-scheme"> Returns the #GtkSourceStyleScheme associated with the buffer, @@ -832,7 +836,8 @@ associated with the buffer, or %NULL. + c:identifier="gtk_source_buffer_get_undo_manager" + glib:get-property="undo-manager"> Returns the #GtkSourceUndoManager associated with the buffer, @@ -881,10 +886,7 @@ See the #GtkSourceBuffer description for the list of default context classes.a #GtkSourceBuffer. - + a #GtkTextIter. @@ -924,10 +926,7 @@ See the #GtkSourceBuffer description for the list of default context classes.a #GtkSourceBuffer. - + a #GtkTextIter. @@ -1070,7 +1069,8 @@ If @category is NULL, all marks in the range will be removed. + c:identifier="gtk_source_buffer_set_highlight_matching_brackets" + glib:set-property="highlight-matching-brackets"> Controls the bracket match highlighting function in the buffer. If @@ -1097,7 +1097,8 @@ closing bracket character will be highlighted. + c:identifier="gtk_source_buffer_set_highlight_syntax" + glib:set-property="highlight-syntax"> Controls whether syntax is highlighted in the buffer. @@ -1130,6 +1131,7 @@ are removed from the buffer. + c:identifier="gtk_source_buffer_set_language" + glib:set-property="language"> Associates a #GtkSourceLanguage with the buffer. @@ -1202,7 +1205,8 @@ The buffer holds a reference to @language. + c:identifier="gtk_source_buffer_set_max_undo_levels" + glib:set-property="max-undo-levels"> Sets the number of undo levels for user actions the buffer will @@ -1232,7 +1236,8 @@ If @max_undo_levels is 0, the undo/redo is disabled. + c:identifier="gtk_source_buffer_set_style_scheme" + glib:set-property="style-scheme"> Sets a #GtkSourceStyleScheme to be used by the buffer and the view. @@ -1271,7 +1276,8 @@ The buffer holds a reference to @scheme. + c:identifier="gtk_source_buffer_set_undo_manager" + glib:set-property="undo-manager"> Set the buffer undo manager. If @manager is %NULL the default undo manager @@ -1362,21 +1368,35 @@ This function emits the #GtkSourceBuffer::undo signal. - + - + + transfer-ownership="none" + setter="set_highlight_matching_brackets" + getter="get_highlight_matching_brackets" + default-value="TRUE"> Whether to highlight matching brackets in the buffer. - + Whether to highlight syntax in the buffer. @@ -1386,24 +1406,40 @@ This function emits the #GtkSourceBuffer::undo signal. version="3.14" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_implicit_trailing_newline" + getter="get_implicit_trailing_newline" + default-value="TRUE"> Whether the buffer has an implicit trailing newline. See gtk_source_buffer_set_implicit_trailing_newline(). - + - + Number of undo levels for the buffer. -1 means no limit. This property will only affect the default undo manager. - + Style scheme. It contains styles for syntax highlighting, optionally @@ -1414,7 +1450,9 @@ brackets style. + transfer-ownership="none" + setter="set_undo_manager" + getter="get_undo_manager"> @@ -1598,7 +1636,10 @@ modified the buffer. - + - + The #GtkSourceView associated with @completion, or %NULL if the view has been @@ -2240,7 +2283,8 @@ again. + transfer-ownership="none" + default-value="5"> Number of keyboard accelerators to show for the first proposals. For @@ -2251,7 +2295,8 @@ example, to activate the first proposal, the user can press + transfer-ownership="none" + default-value="250"> Determines the popup delay (in milliseconds) at which the completion @@ -2261,7 +2306,8 @@ will be shown for interactive completion. + transfer-ownership="none" + default-value="5"> The scroll page size of the proposals in the completion window. In @@ -2276,7 +2322,8 @@ See also the #GtkSourceCompletion::move-cursor signal. + transfer-ownership="none" + default-value="5"> The scroll page size of the provider pages in the completion window. @@ -2287,7 +2334,8 @@ See the #GtkSourceCompletion::move-page signal. + transfer-ownership="none" + default-value="FALSE"> Determines whether the visibility of the info window should be @@ -2298,7 +2346,8 @@ is shown again. + transfer-ownership="none" + default-value="TRUE"> Determines whether the first proposal should be selected when the @@ -2308,7 +2357,8 @@ completion is first shown. + transfer-ownership="none" + default-value="TRUE"> Determines whether provider headers should be shown in the proposal @@ -2318,7 +2368,8 @@ list. It can be useful to disable when there is only one provider. + transfer-ownership="none" + default-value="TRUE"> Determines whether provider and proposal icons should be shown in @@ -2328,7 +2379,8 @@ the completion popup. + transfer-ownership="none" + getter="get_view"> The #GtkSourceView bound to the completion object. @@ -2698,7 +2750,8 @@ function is called. + c:identifier="gtk_source_completion_context_get_activation" + glib:get-property="activation"> Get the context activation. @@ -2721,7 +2774,8 @@ function is called. + c:identifier="gtk_source_completion_context_get_iter" + glib:get-property="iter"> Get the iter at which the completion was invoked. Providers can use this @@ -2755,7 +2809,9 @@ to determine how and if to match proposals. + transfer-ownership="none" + getter="get_activation" + default-value="GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED"> The completion activation @@ -2770,7 +2826,10 @@ to determine how and if to match proposals. line="241">The #GtkSourceCompletion associated with the context. - + The #GtkTextIter at which the completion is invoked. @@ -2843,7 +2902,8 @@ to know when to cancel running proposal queries. + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> @@ -3253,6 +3315,7 @@ afterwards. @@ -3278,6 +3341,7 @@ afterwards. @@ -3303,6 +3367,7 @@ afterwards. @@ -3328,6 +3393,7 @@ afterwards. @@ -3353,6 +3419,7 @@ afterwards. @@ -3378,6 +3445,7 @@ afterwards. @@ -3404,13 +3472,17 @@ afterwards. + transfer-ownership="none" + setter="set_gicon"> The #GIcon for the icon to be shown for this proposal. - + The #GdkPixbuf for the icon to be shown for this proposal. @@ -3419,31 +3491,49 @@ afterwards. + transfer-ownership="none" + setter="set_icon_name" + default-value="NULL"> The icon name for the icon to be shown for this proposal. - + Optional extra information to be shown for this proposal. - + Label to be shown for this proposal. - + Label with markup to be shown for this proposal. - + Proposal text. @@ -3467,12 +3557,14 @@ afterwards. + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> version="3.10" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="GTK_SOURCE_COMPLETION_ACTIVATION_INTERACTIVE | GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED"> The type of activation. @@ -5464,37 +5557,43 @@ info widget. + transfer-ownership="none" + default-value="50"> + transfer-ownership="none" + default-value="2"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="0"> + transfer-ownership="none" + default-value="300"> + transfer-ownership="none" + default-value="50"> @@ -5516,7 +5615,8 @@ info widget. + disguised="1" + opaque="1"> @@ -5635,6 +5735,7 @@ the line will be drawn (i.e. it has the same effect as specifying all of them).< @@ -5962,6 +6063,7 @@ files. See gtk_source_file_is_local(). @@ -5981,6 +6083,7 @@ files. See gtk_source_file_is_local(). @@ -6023,6 +6127,7 @@ operation, the encoding is non-%NULL. @@ -6143,6 +6248,7 @@ gtk_source_file_check_file_on_disk(). + transfer-ownership="none" + getter="get_compression_type" + default-value="GTK_SOURCE_COMPRESSION_TYPE_NONE"> The compression type. - + The character encoding, initially %NULL. After a successful file @@ -6245,19 +6356,28 @@ loading or saving operation, the encoding is non-%NULL. version="3.14" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_location" + getter="get_location"> The location. - + The line ending type. - + Whether the file is read-only or not. The value of this property is @@ -6360,6 +6480,7 @@ the @buffer is emptied. @@ -6417,6 +6538,7 @@ the @buffer is emptied. @@ -6436,6 +6558,7 @@ the @buffer is emptied. @@ -6456,6 +6579,7 @@ if a #GFile is used. @@ -6661,7 +6785,8 @@ gtk_source_encoding_get_default_candidates(). version="3.14" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_buffer"> The #GtkSourceBuffer to load the contents into. The @@ -6672,7 +6797,8 @@ gtk_source_encoding_get_default_candidates(). version="3.14" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_file"> The #GtkSourceFile. The #GtkSourceFileLoader object has a weak @@ -6683,7 +6809,8 @@ reference to the file. version="3.14" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_input_stream"> The #GInputStream to load. Useful for reading stdin. If this property @@ -6694,7 +6821,8 @@ is set, the #GtkSourceFileLoader:location property is ignored. version="3.14" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_location"> The #GFile to load. If the #GtkSourceFileLoader:input-stream is @@ -6767,10 +6895,14 @@ conversion error and it was needed to use a fallback character. + disguised="1" + opaque="1"> - + @@ -6874,6 +7007,7 @@ buffer for the first time. @@ -6893,6 +7027,7 @@ buffer for the first time. @@ -6912,6 +7047,7 @@ buffer for the first time. @@ -6931,6 +7067,7 @@ buffer for the first time. @@ -6950,6 +7087,7 @@ buffer for the first time. @@ -6969,6 +7107,7 @@ buffer for the first time. @@ -7116,6 +7255,7 @@ if the file has been saved successfully. @@ -7193,6 +7335,7 @@ By default the encoding is taken from the #GtkSourceFile. version="3.14" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_buffer"> The #GtkSourceBuffer to save. The #GtkSourceFileSaver object has a @@ -7232,7 +7376,10 @@ weak reference to the buffer. version="3.14" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_compression_type" + getter="get_compression_type" + default-value="GTK_SOURCE_COMPRESSION_TYPE_NONE"> The compression type. @@ -7242,7 +7389,9 @@ weak reference to the buffer. version="3.14" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_encoding" + getter="get_encoding"> The file's encoding. @@ -7252,7 +7401,8 @@ weak reference to the buffer. version="3.14" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_file"> The #GtkSourceFile. The #GtkSourceFileSaver object has a weak @@ -7263,7 +7413,10 @@ reference to the file. version="3.14" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_flags" + getter="get_flags" + default-value="GTK_SOURCE_FILE_SAVER_FLAGS_NONE"> File saving flags. @@ -7273,7 +7426,8 @@ reference to the file. version="3.14" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_location"> The #GFile where to save the buffer. By default the location is taken @@ -7284,7 +7438,10 @@ from the #GtkSourceFile at construction time. version="3.14" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_newline_type" + getter="get_newline_type" + default-value="GTK_SOURCE_NEWLINE_TYPE_LF"> The newline type. @@ -7392,7 +7549,8 @@ from the #GtkSourceFile at construction time. + disguised="1" + opaque="1"> @@ -7640,6 +7799,7 @@ if the gutter has no window. @@ -7793,7 +7953,8 @@ redraw of the gutter if something has changed and needs to be redrawn. + transfer-ownership="none" + getter="get_view"> The #GtkSourceView of the gutter. @@ -7802,7 +7963,9 @@ redraw of the gutter if something has changed and needs to be redrawn. + transfer-ownership="none" + getter="get_window_type" + default-value="GTK_TEXT_WINDOW_PRIVATE"> The text window type on which the window is placed. @@ -7813,7 +7976,8 @@ redraw of the gutter if something has changed and needs to be redrawn. deprecated-version="3.12" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="0"> The x-padding. @@ -7826,7 +7990,8 @@ redraw of the gutter if something has changed and needs to be redrawn. deprecated-version="3.12" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="0"> The y-padding. @@ -7849,7 +8014,10 @@ redraw of the gutter if something has changed and needs to be redrawn. - + + c:identifier="gtk_source_gutter_renderer_get_alignment_mode" + glib:get-property="alignment-mode"> Get the alignment mode. The alignment mode describes the manner in which the @@ -8541,7 +8710,8 @@ renderer is aligned (see :xalign and :yalign). + c:identifier="gtk_source_gutter_renderer_get_size" + glib:get-property="size"> Get the size of the renderer. @@ -8562,7 +8732,8 @@ renderer is aligned (see :xalign and :yalign). + c:identifier="gtk_source_gutter_renderer_get_view" + glib:get-property="view"> Get the view associated to the gutter renderer @@ -8583,7 +8754,8 @@ renderer is aligned (see :xalign and :yalign). + c:identifier="gtk_source_gutter_renderer_get_visible" + glib:get-property="visible"> Get whether the gutter renderer is visible. @@ -8604,7 +8776,8 @@ renderer is aligned (see :xalign and :yalign). + c:identifier="gtk_source_gutter_renderer_get_window_type" + glib:get-property="window-type"> Get the #GtkTextWindowType associated with the gutter renderer. @@ -8816,7 +8989,8 @@ alignment. Set to 0 for a top alignment. 1 for a bottom alignment. + c:identifier="gtk_source_gutter_renderer_set_alignment_mode" + glib:set-property="alignment-mode"> Set the alignment mode. The alignment mode describes the manner in which the @@ -8904,7 +9078,8 @@ one of the values). + c:identifier="gtk_source_gutter_renderer_set_size" + glib:set-property="size"> Sets the size of the renderer. A value of -1 specifies that the size @@ -8929,7 +9104,8 @@ is to be determined dynamically. + c:identifier="gtk_source_gutter_renderer_set_visible" + glib:set-property="visible"> Set whether the gutter renderer is visible. @@ -8955,7 +9131,10 @@ is to be determined dynamically. + transfer-ownership="none" + setter="set_alignment_mode" + getter="get_alignment_mode" + default-value="GTK_SOURCE_GUTTER_RENDERER_ALIGNMENT_MODE_CELL"> The alignment mode of the renderer. This can be used to indicate @@ -8970,16 +9149,20 @@ or the last line. + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + setter="set_size" + getter="get_size" + default-value="0"> - + The view on which the renderer is placed. @@ -8988,13 +9171,19 @@ or the last line. + transfer-ownership="none" + setter="set_visible" + getter="get_visible" + default-value="TRUE"> The visibility of the renderer. - + The window type of the view on which the renderer is placed (left, @@ -9004,7 +9193,8 @@ or right). + transfer-ownership="none" + default-value="0.000000"> The horizontal alignment of the renderer. Set to 0 for a left @@ -9015,7 +9205,8 @@ A value lower than 0 doesn't modify the alignment. + transfer-ownership="none" + default-value="0"> The left and right padding of the renderer. @@ -9024,7 +9215,8 @@ A value lower than 0 doesn't modify the alignment. + transfer-ownership="none" + default-value="0.000000"> The vertical alignment of the renderer. Set to 0 for a top @@ -9035,7 +9227,8 @@ A value lower than 0 doesn't modify the alignment. + transfer-ownership="none" + default-value="0"> The top and bottom padding of the renderer. @@ -9593,7 +9786,8 @@ text wrapping). + c:identifier="gtk_source_gutter_renderer_pixbuf_get_gicon" + glib:get-property="gicon"> Get the gicon of the renderer @@ -9615,7 +9809,8 @@ text wrapping). + c:identifier="gtk_source_gutter_renderer_pixbuf_get_icon_name" + glib:get-property="icon-name"> @@ -9628,7 +9823,8 @@ text wrapping). + c:identifier="gtk_source_gutter_renderer_pixbuf_get_pixbuf" + glib:get-property="pixbuf"> Get the pixbuf of the renderer. @@ -9651,6 +9847,7 @@ text wrapping). Don't use this function. @@ -9672,7 +9869,8 @@ text wrapping). + c:identifier="gtk_source_gutter_renderer_pixbuf_set_gicon" + glib:set-property="gicon"> @@ -9697,7 +9895,8 @@ text wrapping). + c:identifier="gtk_source_gutter_renderer_pixbuf_set_icon_name" + glib:set-property="icon-name"> @@ -9722,7 +9921,8 @@ text wrapping). + c:identifier="gtk_source_gutter_renderer_pixbuf_set_pixbuf" + glib:set-property="pixbuf"> @@ -9748,6 +9948,7 @@ text wrapping). Don't use this function. @@ -9774,20 +9975,36 @@ text wrapping). - + - + - + + transfer-ownership="none" + setter="set_stock_id" + getter="get_stock_id" + default-value="NULL"> The stock id. @@ -9813,12 +10030,14 @@ text wrapping). + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> + c:identifier="gtk_source_gutter_renderer_text_set_markup" + glib:set-property="markup"> @@ -10006,7 +10226,8 @@ a line in the buffer which contains part of the selection + c:identifier="gtk_source_gutter_renderer_text_set_text" + glib:set-property="text"> @@ -10027,13 +10248,17 @@ a line in the buffer which contains part of the selection + transfer-ownership="none" + setter="set_markup" + default-value="NULL"> + transfer-ownership="none" + setter="set_text" + default-value="NULL"> @@ -10055,7 +10280,8 @@ a line in the buffer which contains part of the selection + disguised="1" + opaque="1"> - + Returns whether the language should be hidden from the user. @@ -10713,7 +10941,9 @@ The returned array must be freed with g_strfreev(). - + Returns the ID of the language. The ID is not locale-dependent. @@ -10792,7 +11022,9 @@ The returned array must be freed with g_strfreev(). - + Returns the localized name of the language. @@ -10815,7 +11047,8 @@ or modified. + c:identifier="gtk_source_language_get_section" + glib:get-property="section"> Returns the localized section of the language. @@ -10927,16 +11160,28 @@ The returned string is owned by the @language and must not be modified. - + - + - + - + @@ -11037,7 +11282,8 @@ owned by @lm and should not be freed. + c:identifier="gtk_source_language_manager_get_language_ids" + glib:get-property="language-ids"> Returns the ids of the available languages. @@ -11064,7 +11310,8 @@ The array is owned by @lm and must not be modified. + c:identifier="gtk_source_language_manager_get_search_path" + glib:get-property="search-path"> Gets the list directories where @lm looks for language files. @@ -11162,7 +11409,8 @@ value is owned by @lm and should not be freed. + c:identifier="gtk_source_language_manager_set_search_path" + glib:set-property="search-path"> Sets the list of directories where the @lm looks for @@ -11202,12 +11450,18 @@ a %NULL-terminated array of strings or %NULL. - + - + @@ -11262,12 +11516,14 @@ a %NULL-terminated array of strings or %NULL. + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> - + @@ -11496,6 +11758,7 @@ category, or all the marks representing a compilation error could belong to + transfer-ownership="none" + getter="get_category" + default-value="NULL"> The category of the #GtkSourceMark, classifies the mark and controls @@ -11615,7 +11880,8 @@ which pixbuf is used and with which priority it is drawn. + c:identifier="gtk_source_mark_attributes_get_background" + glib:get-property="background"> Stores background color in @background. @@ -11645,7 +11911,8 @@ which pixbuf is used and with which priority it is drawn. + c:identifier="gtk_source_mark_attributes_get_gicon" + glib:get-property="gicon"> Gets a #GIcon to be used as a base for rendered icon. Note that the icon can @@ -11668,7 +11935,8 @@ not be unreffed. + c:identifier="gtk_source_mark_attributes_get_icon_name" + glib:get-property="icon-name"> Gets a name of an icon to be used as a base for rendered icon. Note that the @@ -11691,7 +11959,8 @@ should not be freed. + c:identifier="gtk_source_mark_attributes_get_pixbuf" + glib:get-property="pixbuf"> Gets a #GdkPixbuf to be used as a base for rendered icon. Note that the @@ -11715,6 +11984,7 @@ should not be unreffed. + c:identifier="gtk_source_mark_attributes_set_background" + glib:set-property="background"> Sets background color to the one given in @background. @@ -11862,7 +12133,8 @@ and should not be unreffed. + c:identifier="gtk_source_mark_attributes_set_gicon" + glib:set-property="gicon"> Sets an icon to be used as a base for rendered icon. @@ -11886,7 +12158,8 @@ and should not be unreffed. + c:identifier="gtk_source_mark_attributes_set_icon_name" + glib:set-property="icon-name"> Sets a name of an icon to be used as a base for rendered icon. @@ -11910,7 +12183,8 @@ and should not be unreffed. + c:identifier="gtk_source_mark_attributes_set_pixbuf" + glib:set-property="pixbuf"> Sets a pixbuf to be used as a base for rendered icon. @@ -11935,6 +12209,7 @@ and should not be unreffed. - + A color used for background of a line. - + A #GIcon that may be a base of a rendered icon. - + An icon name that may be a base of a rendered icon. - + A #GdkPixbuf that may be a base of a rendered icon. @@ -11988,7 +12280,10 @@ and should not be unreffed. deprecated="1" deprecated-version="3.10" writable="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_stock_id" + getter="get_stock_id" + default-value="NULL"> A stock id that may be a base of a rendered icon. @@ -12055,7 +12350,8 @@ g_free() when done with it. + disguised="1" + opaque="1"> - + + transfer-ownership="none" + setter="set_body_font_name" + getter="get_body_font_name" + default-value="NULL"> Name of the font used for the text body. @@ -13396,7 +13720,8 @@ call to the gtk_source_print_compositor_paginate() function. version="2.2" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_buffer"> The GtkSourceBuffer object to print. @@ -13405,7 +13730,10 @@ call to the gtk_source_print_compositor_paginate() function. + transfer-ownership="none" + setter="set_footer_font_name" + getter="get_footer_font_name" + default-value="NULL"> Name of the font used to print page footer. @@ -13422,7 +13750,10 @@ call to the gtk_source_print_compositor_paginate() function. + transfer-ownership="none" + setter="set_header_font_name" + getter="get_header_font_name" + default-value="NULL"> Name of the font used to print page header. @@ -13439,7 +13770,10 @@ call to the gtk_source_print_compositor_paginate() function. + transfer-ownership="none" + setter="set_highlight_syntax" + getter="get_highlight_syntax" + default-value="TRUE"> Whether to print the document with highlighted syntax. @@ -13451,7 +13785,10 @@ call to the gtk_source_print_compositor_paginate() function. + transfer-ownership="none" + setter="set_line_numbers_font_name" + getter="get_line_numbers_font_name" + default-value="NULL"> Name of the font used to print line numbers on the left margin. @@ -13465,7 +13802,11 @@ The value of this property cannot be changed anymore after the first call to the gtk_source_print_compositor_paginate() function. - + The number of pages in the document or <code>-1</code> if the @@ -13475,7 +13816,10 @@ document has not been completely paginated. + transfer-ownership="none" + setter="set_print_footer" + getter="get_print_footer" + default-value="FALSE"> Whether to print a footer in each page. @@ -13491,7 +13835,10 @@ call to the gtk_source_print_compositor_paginate() function. + transfer-ownership="none" + setter="set_print_header" + getter="get_print_header" + default-value="FALSE"> Whether to print a header in each page. @@ -13507,7 +13854,10 @@ call to the gtk_source_print_compositor_paginate() function. + transfer-ownership="none" + setter="set_print_line_numbers" + getter="get_print_line_numbers" + default-value="1"> Interval of printed line numbers. If this property is set to 0 no @@ -13521,7 +13871,10 @@ call to the gtk_source_print_compositor_paginate() function. + transfer-ownership="none" + setter="set_tab_width" + getter="get_tab_width" + default-value="8"> Width of a tab character expressed in spaces. @@ -13533,7 +13886,10 @@ call to the gtk_source_print_compositor_paginate() function. + transfer-ownership="none" + setter="set_wrap_mode" + getter="get_wrap_mode" + default-value="GTK_WRAP_NONE"> Whether to wrap lines never, at word boundaries, or at character boundaries. @@ -13576,7 +13932,8 @@ call to the gtk_source_print_compositor_paginate() function. + disguised="1" + opaque="1"> @@ -13948,7 +14306,8 @@ doesn't include a newline character at the end of the string. version="3.22" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_buffer"> The #GtkTextBuffer. The #GtkSourceRegion has a weak reference to the @@ -15007,6 +15366,7 @@ details. @@ -15026,6 +15386,7 @@ details. @@ -15045,6 +15406,7 @@ details. @@ -15103,6 +15465,7 @@ an occurrence. Returns -1 if the position is not yet known. @@ -15322,6 +15687,7 @@ backreferences; read the g_regex_replace() documentation for more details. @@ -15419,7 +15787,8 @@ listen to the notify::settings signal. version="3.10" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_buffer"> The #GtkSourceBuffer associated to the search context. @@ -15429,7 +15798,10 @@ listen to the notify::settings signal. version="3.10" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_highlight" + getter="get_highlight" + default-value="TRUE"> Highlight the search occurrences. @@ -15439,7 +15811,9 @@ listen to the notify::settings signal. version="3.16" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_match_style" + getter="get_match_style"> A #GtkSourceStyle, or %NULL for theme's scheme default style. @@ -15447,7 +15821,9 @@ listen to the notify::settings signal. + transfer-ownership="none" + getter="get_occurrences_count" + default-value="0"> The total number of search occurrences. If the search is disabled, @@ -15455,7 +15831,10 @@ the value is 0. If the buffer is not already fully scanned, the value is -1. - + If the regex search pattern doesn't follow all the rules, this @@ -15468,7 +15847,9 @@ Free with g_error_free(). version="3.10" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_settings" + getter="get_settings"> The #GtkSourceSearchSettings associated to the search context. @@ -15497,7 +15878,8 @@ Free with g_error_free(). + disguised="1" + opaque="1"> @@ -15543,6 +15926,7 @@ Free with g_error_free(). @@ -15562,6 +15946,7 @@ Free with g_error_free(). @@ -15581,6 +15966,7 @@ Free with g_error_free(). @@ -15625,6 +16012,7 @@ this function. version="3.10" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_at_word_boundaries" + getter="get_at_word_boundaries" + default-value="FALSE"> If %TRUE, a search match must start and end a word. The match can @@ -15783,7 +16178,10 @@ span multiple words. version="3.10" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_case_sensitive" + getter="get_case_sensitive" + default-value="FALSE"> Whether the search is case sensitive. @@ -15793,7 +16191,10 @@ span multiple words. version="3.10" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_regex_enabled" + getter="get_regex_enabled" + default-value="FALSE"> Search by regular expressions with @@ -15804,7 +16205,10 @@ span multiple words. version="3.10" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_search_text" + getter="get_search_text" + default-value="NULL"> A search string, or %NULL if the search is disabled. If the regular @@ -15816,7 +16220,10 @@ the pattern. version="3.10" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_wrap_around" + getter="get_wrap_around" + default-value="FALSE"> For a forward search, continue at the beginning of the buffer if no @@ -15847,7 +16254,8 @@ end of the buffer. + disguised="1" + opaque="1"> @@ -16027,6 +16436,7 @@ deprecated). version="3.24" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_enable_matrix" + getter="get_enable_matrix" + default-value="FALSE"> Whether the #GtkSourceSpaceDrawer:matrix property is enabled. @@ -16194,7 +16609,9 @@ convenient to use. version="3.24" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_matrix" + getter="get_matrix"> The :matrix property is a #GVariant property to specify where and @@ -16234,7 +16651,8 @@ By default, %GTK_SOURCE_SPACE_TYPE_ALL is set for all locations. + disguised="1" + opaque="1"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="PANGO_UNDERLINE_NONE"> + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="FALSE"> deprecated-version="3.18" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="FALSE"> Use pango-underline. + transfer-ownership="none" + default-value="NULL"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="FALSE"> @@ -16581,6 +17019,7 @@ no author is specified by the style scheme. @@ -16600,6 +17039,7 @@ no author is specified by the style scheme. @@ -16620,6 +17060,7 @@ parsing a style scheme file or %NULL in the other cases. @@ -16639,6 +17080,7 @@ parsing a style scheme file or %NULL in the other cases. @@ -16683,13 +17125,19 @@ the @scheme, or %NULL when no style with this name found. It is owned by - + Style scheme description, a translatable string to present to the user. - + Style scheme filename or %NULL. @@ -16698,14 +17146,19 @@ the @scheme, or %NULL when no style with this name found. It is owned by + transfer-ownership="none" + getter="get_id" + default-value="NULL"> Style scheme id, a unique string used to identify the style scheme in #GtkSourceStyleSchemeManager. - + Style scheme name, a translatable string to present to the user. @@ -16776,6 +17229,7 @@ in #GtkSourceStyleSchemeManager. + transfer-ownership="none" + setter="set_style_scheme" + getter="get_style_scheme"> The :style-scheme property contains the currently selected style @@ -17113,7 +17570,8 @@ the @manager is accessed. + c:identifier="gtk_source_style_scheme_manager_get_scheme_ids" + glib:get-property="scheme-ids"> Returns the ids of the available style schemes. @@ -17141,7 +17599,8 @@ The array is owned by the @manager and must not be modified. + c:identifier="gtk_source_style_scheme_manager_get_search_path" + glib:get-property="search-path"> Returns the current search path for the @manager. @@ -17195,7 +17654,8 @@ See gtk_source_style_scheme_manager_set_search_path() for details. + c:identifier="gtk_source_style_scheme_manager_set_search_path" + glib:set-property="search-path"> Sets the list of directories where the @manager looks for @@ -17227,12 +17687,18 @@ a %NULL-terminated array of strings or %NULL. - + - + @@ -17287,12 +17753,14 @@ a %NULL-terminated array of strings or %NULL. + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> + transfer-ownership="none" + default-value="FALSE"> Whether to draw white spaces. This property takes precedence over the value @@ -17347,7 +17816,8 @@ Setting this property also changes #GtkSourceTag:draw-spaces-set to + transfer-ownership="none" + default-value="FALSE"> Whether the #GtkSourceTag:draw-spaces property is set and must be @@ -18042,38 +18512,40 @@ gtk_source_view_new_with_buffer(). + c:identifier="gtk_source_view_get_auto_indent" + glib:get-property="auto-indent"> Returns whether auto-indentation of text is enabled. + line="4160">Returns whether auto-indentation of text is enabled. %TRUE if auto indentation is enabled. + line="4166">%TRUE if auto indentation is enabled. a #GtkSourceView. + line="4162">a #GtkSourceView. Returns the #GtkSourceBackgroundPatternType specifying if and how + line="5029">Returns the #GtkSourceBackgroundPatternType specifying if and how the background pattern should be displayed for this @view. the #GtkSourceBackgroundPatternType. + line="5036">the #GtkSourceBackgroundPatternType. @@ -18081,41 +18553,43 @@ the background pattern should be displayed for this @view. a #GtkSourceView + line="5031">a #GtkSourceView + c:identifier="gtk_source_view_get_completion" + glib:get-property="completion"> Gets the #GtkSourceCompletion associated with @view. The returned object is + line="4874">Gets the #GtkSourceCompletion associated with @view. The returned object is guaranteed to be the same for the lifetime of @view. Each #GtkSourceView object has a different #GtkSourceCompletion. the #GtkSourceCompletion associated with @view. + line="4882">the #GtkSourceCompletion associated with @view. a #GtkSourceView. + line="4876">a #GtkSourceView. Returns the #GtkSourceDrawSpacesFlags specifying if and how spaces + line="4593">Returns the #GtkSourceDrawSpacesFlags specifying if and how spaces should be displayed for this @view. Use gtk_source_space_drawer_get_types_for_locations() instead. @@ -18123,14 +18597,14 @@ instead. the #GtkSourceDrawSpacesFlags, 0 if no spaces should be drawn. + line="4600">the #GtkSourceDrawSpacesFlags, 0 if no spaces should be drawn. a #GtkSourceView + line="4595">a #GtkSourceView @@ -18140,7 +18614,7 @@ instead. version="2.8"> Returns the #GtkSourceGutter object associated with @window_type for @view. + line="4897">Returns the #GtkSourceGutter object associated with @window_type for @view. Only GTK_TEXT_WINDOW_LEFT and GTK_TEXT_WINDOW_RIGHT are supported, respectively corresponding to the left and right gutter. The line numbers and mark category icons are rendered in the left gutter. @@ -18148,69 +18622,72 @@ and mark category icons are rendered in the left gutter. the #GtkSourceGutter. + line="4909">the #GtkSourceGutter. a #GtkSourceView. + line="4899">a #GtkSourceView. the gutter window type. + line="4900">the gutter window type. + c:identifier="gtk_source_view_get_highlight_current_line" + glib:get-property="highlight-current-line"> Returns whether the current line is highlighted. + line="4359">Returns whether the current line is highlighted. %TRUE if the current line is highlighted. + line="4365">%TRUE if the current line is highlighted. a #GtkSourceView. + line="4361">a #GtkSourceView. + c:identifier="gtk_source_view_get_indent_on_tab" + glib:get-property="indent-on-tab"> Returns whether when the tab key is pressed the current selection + line="4244">Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the \t character. %TRUE if the selection is indented when tab is pressed. + line="4251">%TRUE if the selection is indented when tab is pressed. a #GtkSourceView. + line="4246">a #GtkSourceView. + c:identifier="gtk_source_view_get_indent_width" + glib:get-property="indent-width"> Returns the number of spaces to use for each step of indent. @@ -18232,23 +18709,24 @@ See gtk_source_view_set_indent_width() for details. + c:identifier="gtk_source_view_get_insert_spaces_instead_of_tabs" + glib:get-property="insert-spaces-instead-of-tabs"> Returns whether when inserting a tabulator character it should + line="4203">Returns whether when inserting a tabulator character it should be replaced by a group of space characters. %TRUE if spaces are inserted instead of tabs. + line="4210">%TRUE if spaces are inserted instead of tabs. a #GtkSourceView. + line="4205">a #GtkSourceView. @@ -18257,12 +18735,12 @@ be replaced by a group of space characters. c:identifier="gtk_source_view_get_mark_attributes"> Gets attributes and priority for the @category. + line="4967">Gets attributes and priority for the @category. #GtkSourceMarkAttributes for the @category. + line="4975">#GtkSourceMarkAttributes for the @category. The object belongs to @view, so it must not be unreffed. @@ -18270,46 +18748,48 @@ The object belongs to @view, so it must not be unreffed. a #GtkSourceView. + line="4969">a #GtkSourceView. the category. + line="4970">the category. place where priority of the category will be stored. + line="4971">place where priority of the category will be stored. + c:identifier="gtk_source_view_get_right_margin_position" + glib:get-property="right-margin-position"> Gets the position of the right margin in the given @view. + line="4441">Gets the position of the right margin in the given @view. the position of the right margin. + line="4447">the position of the right margin. a #GtkSourceView. + line="4443">a #GtkSourceView. + c:identifier="gtk_source_view_get_show_line_numbers" + glib:get-property="show-line-numbers"> Returns whether line numbers are displayed beside the text. @@ -18352,97 +18833,102 @@ The object belongs to @view, so it must not be unreffed. + c:identifier="gtk_source_view_get_show_right_margin" + glib:get-property="show-right-margin"> Returns whether a right margin is displayed. + line="4400">Returns whether a right margin is displayed. %TRUE if the right margin is shown. + line="4406">%TRUE if the right margin is shown. a #GtkSourceView. + line="4402">a #GtkSourceView. Returns %TRUE if pressing the Backspace key will try to delete spaces + line="4507">Returns %TRUE if pressing the Backspace key will try to delete spaces up to the previous tab stop. %TRUE if smart Backspace handling is enabled. + line="4514">%TRUE if smart Backspace handling is enabled. a #GtkSourceView. + line="4509">a #GtkSourceView. + c:identifier="gtk_source_view_get_smart_home_end" + glib:get-property="smart-home-end"> Returns a #GtkSourceSmartHomeEndType end value specifying + line="4547">Returns a #GtkSourceSmartHomeEndType end value specifying how the cursor will move when HOME and END keys are pressed. a #GtkSourceSmartHomeEndType value. + line="4554">a #GtkSourceSmartHomeEndType value. a #GtkSourceView. + line="4549">a #GtkSourceView. Gets the #GtkSourceSpaceDrawer associated with @view. The returned object is + line="5047">Gets the #GtkSourceSpaceDrawer associated with @view. The returned object is guaranteed to be the same for the lifetime of @view. Each #GtkSourceView object has a different #GtkSourceSpaceDrawer. the #GtkSourceSpaceDrawer associated with @view. + line="5055">the #GtkSourceSpaceDrawer associated with @view. a #GtkSourceView. + line="5049">a #GtkSourceView. + c:identifier="gtk_source_view_get_tab_width" + glib:get-property="tab-width"> Returns the width of tabulation in characters. @@ -18466,26 +18952,26 @@ object has a different #GtkSourceSpaceDrawer. c:identifier="gtk_source_view_get_visual_column"> Determines the visual column at @iter taking into consideration the + line="4617">Determines the visual column at @iter taking into consideration the #GtkSourceView:tab-width of @view. the visual column at @iter. + line="4625">the visual column at @iter. a #GtkSourceView. + line="4619">a #GtkSourceView. a position in @view. + line="4620">a position in @view. @@ -18523,10 +19009,11 @@ empty lines are not indented. + c:identifier="gtk_source_view_set_auto_indent" + glib:set-property="auto-indent"> If %TRUE auto-indentation of text is enabled. + line="4176">If %TRUE auto-indentation of text is enabled. When Enter is pressed to create a new line, the auto-indentation inserts the same indentation as the previous line. This is <emphasis>not</emphasis> a @@ -18540,23 +19027,24 @@ on the context. a #GtkSourceView. + line="4178">a #GtkSourceView. whether to enable auto indentation. + line="4179">whether to enable auto indentation. Set if and how the background pattern should be displayed. + line="5004">Set if and how the background pattern should be displayed. @@ -18565,13 +19053,13 @@ on the context. a #GtkSourceView. + line="5006">a #GtkSourceView. the #GtkSourceBackgroundPatternType. + line="5007">the #GtkSourceBackgroundPatternType. @@ -18579,11 +19067,12 @@ on the context. Set if and how the spaces should be visualized. Specifying @flags as 0 will + line="4564">Set if and how the spaces should be visualized. Specifying @flags as 0 will disable display of spaces. For a finer-grained method, there is also the GtkSourceTag's @@ -18598,23 +19087,24 @@ instead. a #GtkSourceView. + line="4566">a #GtkSourceView. #GtkSourceDrawSpacesFlags specifing how white spaces should + line="4567">#GtkSourceDrawSpacesFlags specifing how white spaces should be displayed + c:identifier="gtk_source_view_set_highlight_current_line" + glib:set-property="highlight-current-line"> If @highlight is %TRUE the current line will be highlighted. + line="4375">If @highlight is %TRUE the current line will be highlighted. @@ -18623,22 +19113,23 @@ be displayed a #GtkSourceView. + line="4377">a #GtkSourceView. whether to highlight the current line. + line="4378">whether to highlight the current line. + c:identifier="gtk_source_view_set_indent_on_tab" + glib:set-property="indent-on-tab"> If %TRUE, when the tab key is pressed when several lines are selected, the + line="4261">If %TRUE, when the tab key is pressed when several lines are selected, the selected lines are indented of one level instead of being replaced with a \t character. Shift+Tab unindents the selection. @@ -18655,19 +19146,20 @@ the selection with a normal \t character. a #GtkSourceView. + line="4263">a #GtkSourceView. whether to indent a block when tab is pressed. + line="4264">whether to indent a block when tab is pressed. + c:identifier="gtk_source_view_set_indent_width" + glib:set-property="indent-width"> Sets the number of spaces to use for each step of indent when the tab key is @@ -18710,10 +19202,11 @@ drawing!). + c:identifier="gtk_source_view_set_insert_spaces_instead_of_tabs" + glib:set-property="insert-spaces-instead-of-tabs"> If %TRUE a tab key pressed is replaced by a group of space characters. Of + line="4220">If %TRUE a tab key pressed is replaced by a group of space characters. Of course it is still possible to insert a real \t programmatically with the #GtkTextBuffer API. @@ -18724,13 +19217,13 @@ course it is still possible to insert a real \t programmatically with the a #GtkSourceView. + line="4222">a #GtkSourceView. whether to insert spaces instead of tabs. + line="4223">whether to insert spaces instead of tabs. @@ -18739,7 +19232,7 @@ course it is still possible to insert a real \t programmatically with the c:identifier="gtk_source_view_set_mark_attributes"> Sets attributes and priority for the @category. + line="4939">Sets attributes and priority for the @category. @@ -18748,34 +19241,35 @@ course it is still possible to insert a real \t programmatically with the a #GtkSourceView. + line="4941">a #GtkSourceView. the category. + line="4942">the category. mark attributes. + line="4943">mark attributes. priority of the category. + line="4944">priority of the category. + c:identifier="gtk_source_view_set_right_margin_position" + glib:set-property="right-margin-position"> Sets the position of the right margin in the given @view. + line="4457">Sets the position of the right margin in the given @view. @@ -18784,19 +19278,20 @@ course it is still possible to insert a real \t programmatically with the a #GtkSourceView. + line="4459">a #GtkSourceView. the width in characters where to position the right margin. + line="4460">the width in characters where to position the right margin. + c:identifier="gtk_source_view_set_show_line_numbers" + glib:set-property="show-line-numbers"> If %TRUE line numbers will be displayed beside the text. @@ -18845,10 +19341,11 @@ course it is still possible to insert a real \t programmatically with the + c:identifier="gtk_source_view_set_show_right_margin" + glib:set-property="show-right-margin"> If %TRUE a right margin is displayed. + line="4416">If %TRUE a right margin is displayed. @@ -18857,23 +19354,24 @@ course it is still possible to insert a real \t programmatically with the a #GtkSourceView. + line="4418">a #GtkSourceView. whether to show a right margin. + line="4419">whether to show a right margin. When set to %TRUE, pressing the Backspace key will try to delete spaces + line="4482">When set to %TRUE, pressing the Backspace key will try to delete spaces up to the previous tab stop. @@ -18883,22 +19381,23 @@ up to the previous tab stop. a #GtkSourceView. + line="4484">a #GtkSourceView. whether to enable smart Backspace handling. + line="4485">whether to enable smart Backspace handling. + c:identifier="gtk_source_view_set_smart_home_end" + glib:set-property="smart-home-end"> Set the desired movement of the cursor when HOME and END keys + line="4526">Set the desired movement of the cursor when HOME and END keys are pressed. @@ -18908,19 +19407,20 @@ are pressed. a #GtkSourceView. + line="4528">a #GtkSourceView. the desired behavior among #GtkSourceSmartHomeEndType. + line="4529">the desired behavior among #GtkSourceSmartHomeEndType. + c:identifier="gtk_source_view_set_tab_width" + glib:set-property="tab-width"> Sets the width of tabulation in characters. The #GtkTextBuffer still contains @@ -18977,19 +19477,29 @@ specified lines. - + + transfer-ownership="none" + setter="set_background_pattern" + getter="get_background_pattern" + default-value="GTK_SOURCE_BACKGROUND_PATTERN_TYPE_NONE"> Draw a specific background pattern on the view. - + The completion object associated with the view @@ -19000,7 +19510,10 @@ specified lines. deprecated="1" deprecated-version="3.24" writable="1" - transfer-ownership="none"> + transfer-ownership="none" + setter="set_draw_spaces" + getter="get_draw_spaces" + default-value="0"> Set if and how the spaces should be visualized. @@ -19013,13 +19526,26 @@ instead. + transfer-ownership="none" + setter="set_highlight_current_line" + getter="get_highlight_current_line" + default-value="FALSE"> - + - + Width of an indentation step expressed in number of spaces. @@ -19027,18 +19553,29 @@ instead. + transfer-ownership="none" + setter="set_insert_spaces_instead_of_tabs" + getter="get_insert_spaces_instead_of_tabs" + default-value="FALSE"> + transfer-ownership="none" + setter="set_right_margin_position" + getter="get_right_margin_position" + default-value="80"> Position of the right margin. - + Whether to display line mark pixbufs @@ -19046,7 +19583,10 @@ instead. + transfer-ownership="none" + setter="set_show_line_numbers" + getter="get_show_line_numbers" + default-value="FALSE"> Whether to display line numbers @@ -19054,7 +19594,10 @@ instead. + transfer-ownership="none" + setter="set_show_right_margin" + getter="get_show_right_margin" + default-value="FALSE"> Whether to display the right margin. @@ -19063,7 +19606,10 @@ instead. + transfer-ownership="none" + setter="set_smart_backspace" + getter="get_smart_backspace" + default-value="FALSE"> Whether smart Backspace should be used. @@ -19072,19 +19618,30 @@ instead. + transfer-ownership="none" + setter="set_smart_home_end" + getter="get_smart_home_end" + default-value="GTK_SOURCE_SMART_HOME_END_DISABLED"> Set the behavior of the HOME and END keys. - + The #GtkSourceSpaceDrawer object associated with the view. - + Width of a tab character expressed in number of spaces. @@ -19410,7 +19967,10 @@ renderer renderer - + diff --git a/girs/GtkSource-5.gir b/girs/GtkSource-5.gir index c469d2c2f..a75eb7ece 100644 --- a/girs/GtkSource-5.gir +++ b/girs/GtkSource-5.gir @@ -6881,7 +6881,7 @@ called from [class@Gutter] and should never have to be called manually. c:identifier="gtk_source_gutter_renderer_align_cell"> Locates where to render content that is @width x @height based on + line="755">Locates where to render content that is @width x @height based on the renderers alignment and padding. The location will be placed into @x and @y and is relative to the @@ -6898,25 +6898,25 @@ to ensure consistent placement of their contents. the #GtkSourceGutterRenderer + line="757">the #GtkSourceGutterRenderer the line number for content + line="758">the line number for content the width of the content to draw + line="759">the width of the content to draw the height of the content to draw + line="760">the height of the content to draw transfer-ownership="full"> the X position to render the content + line="761">the X position to render the content transfer-ownership="full"> the Y position to render the content + line="762">the Y position to render the content @@ -6971,20 +6971,20 @@ renderer is aligned (see [property@GutterRenderer:xalign] and c:identifier="gtk_source_gutter_renderer_get_buffer"> Gets the [class@Buffer] for which the gutter renderer is drawing. + line="972">Gets the [class@Buffer] for which the gutter renderer is drawing. a #GtkTextBuffer or %NULL + line="978">a #GtkTextBuffer or %NULL a #GtkSourceGutterRenderer + line="974">a #GtkSourceGutterRenderer @@ -7017,7 +7017,7 @@ renderer is aligned (see [property@GutterRenderer:xalign] and glib:get-property="xalign"> Gets the `xalign` property. + line="882">Gets the `xalign` property. This may be used to adjust where within the cell rectangle the renderer will draw. a #GtkSourceGutterRenderer + line="884">a #GtkSourceGutterRenderer @@ -7039,7 +7039,7 @@ This may be used to adjust where within the cell rectangle the renderer will dra glib:get-property="xpad"> Gets the `xpad` property. + line="792">Gets the `xpad` property. This may be used to adjust the cell rectangle that the renderer will use to draw. a #GtkSourceGutterRenderer + line="794">a #GtkSourceGutterRenderer @@ -7061,7 +7061,7 @@ This may be used to adjust the cell rectangle that the renderer will use to draw glib:get-property="yalign"> Gets the `yalign` property. + line="927">Gets the `yalign` property. This may be used to adjust where within the cell rectangle the renderer will draw. a #GtkSourceGutterRenderer + line="929">a #GtkSourceGutterRenderer @@ -7083,7 +7083,7 @@ This may be used to adjust where within the cell rectangle the renderer will dra glib:get-property="ypad"> Gets the `ypad` property. + line="837">Gets the `ypad` property. This may be used to adjust the cell rectangle that the renderer will use to draw. a #GtkSourceGutterRenderer + line="839">a #GtkSourceGutterRenderer @@ -7170,7 +7170,7 @@ renderer is aligned (see [property@GutterRenderer:xalign] and glib:set-property="xalign"> Adjusts the `xalign` property. + line="900">Adjusts the `xalign` property. This may be used to adjust where within the cell rectangle the renderer will draw. a #GtkSourceGutterRenderer + line="902">a #GtkSourceGutterRenderer the Y padding for the drawing cell + line="903">the Y padding for the drawing cell @@ -7198,7 +7198,7 @@ This may be used to adjust where within the cell rectangle the renderer will dra glib:set-property="xpad"> Adjusts the `xpad` property. + line="810">Adjusts the `xpad` property. This may be used to adjust the cell rectangle that the renderer will use to draw. a #GtkSourceGutterRenderer + line="812">a #GtkSourceGutterRenderer the Y padding for the drawing cell + line="813">the Y padding for the drawing cell @@ -7226,7 +7226,7 @@ This may be used to adjust the cell rectangle that the renderer will use to draw glib:set-property="yalign"> Adjusts the `yalign` property. + line="945">Adjusts the `yalign` property. This may be used to adjust where within the cell rectangle the renderer will draw. a #GtkSourceGutterRenderer + line="947">a #GtkSourceGutterRenderer the Y padding for the drawing cell + line="948">the Y padding for the drawing cell @@ -7254,7 +7254,7 @@ This may be used to adjust where within the cell rectangle the renderer will dra glib:set-property="ypad"> Adjusts the `ypad` property. + line="855">Adjusts the `ypad` property. This may be used to adjust the cell rectangle that the renderer will use to draw. a #GtkSourceGutterRenderer + line="857">a #GtkSourceGutterRenderer the Y padding for the drawing cell + line="858">the Y padding for the drawing cell @@ -9776,7 +9776,7 @@ against at application run time. - + Like gtk_source_get_micro_version(), but from the headers used at @@ -17327,7 +17327,7 @@ the default font set in CSS. Creates a new `GtkSourceView`. + line="2982">Creates a new `GtkSourceView`. By default, an empty [class@Buffer] will be lazily created and can be retrieved with [method@Gtk.TextView.get_buffer]. @@ -17339,7 +17339,7 @@ If you want to specify your own buffer, either override the a new #GtkSourceView. + line="2994">a new #GtkSourceView. @@ -17347,21 +17347,21 @@ If you want to specify your own buffer, either override the c:identifier="gtk_source_view_new_with_buffer"> Creates a new #GtkSourceView widget displaying the buffer @buffer. + line="3002">Creates a new #GtkSourceView widget displaying the buffer @buffer. One buffer can be shared among many widgets. a new #GtkSourceView. + line="3010">a new #GtkSourceView. a #GtkSourceBuffer. + line="3004">a #GtkSourceBuffer. @@ -17420,7 +17420,7 @@ One buffer can be shared among many widgets. Inserts a new snippet at @location + line="5581">Inserts a new snippet at @location If another snippet was already active, it will be paused and the new snippet will become active. Once the focus positions of @snippet have @@ -17433,13 +17433,13 @@ been exhausted, editing will return to the previous snippet. a #GtkSourceView + line="5583">a #GtkSourceView a #GtkSourceSnippet + line="5584">a #GtkSourceSnippet allow-none="1"> a #GtkTextIter or %NULL for the cursor position + line="5585">a #GtkTextIter or %NULL for the cursor position @@ -17469,19 +17469,19 @@ been exhausted, editing will return to the previous snippet. glib:get-property="auto-indent"> Returns whether auto-indentation of text is enabled. + line="4490">Returns whether auto-indentation of text is enabled. %TRUE if auto indentation is enabled. + line="4496">%TRUE if auto indentation is enabled. a #GtkSourceView. + line="4492">a #GtkSourceView. @@ -17491,13 +17491,13 @@ been exhausted, editing will return to the previous snippet. glib:get-property="background-pattern"> Returns the #GtkSourceBackgroundPatternType specifying if and how + line="5445">Returns the #GtkSourceBackgroundPatternType specifying if and how the background pattern should be displayed for this @view. the #GtkSourceBackgroundPatternType. + line="5452">the #GtkSourceBackgroundPatternType. @@ -17505,7 +17505,7 @@ the background pattern should be displayed for this @view. a #GtkSourceView + line="5447">a #GtkSourceView @@ -17515,7 +17515,7 @@ the background pattern should be displayed for this @view. glib:get-property="completion"> Gets the [class@Completion] associated with @view. + line="5239">Gets the [class@Completion] associated with @view. The returned object is guaranteed to be the same for the lifetime of @view. Each `GtkSourceView` object has a different [class@Completion]. @@ -17523,14 +17523,14 @@ Each `GtkSourceView` object has a different [class@Completion]. the #GtkSourceCompletion associated with @view. + line="5248">the #GtkSourceCompletion associated with @view. a #GtkSourceView. + line="5241">a #GtkSourceView. @@ -17540,7 +17540,7 @@ Each `GtkSourceView` object has a different [class@Completion]. glib:get-property="enable-snippets"> Gets the [property@View:enable-snippets] property. + line="5635">Gets the [property@View:enable-snippets] property. If %TRUE, matching snippets found in the [class@SnippetManager] may be expanded when the user presses Tab after a word in the [class@View]. @@ -17548,14 +17548,14 @@ may be expanded when the user presses Tab after a word in the [class@View]. %TRUE if enabled + line="5644">%TRUE if enabled a #GtkSourceView + line="5637">a #GtkSourceView @@ -17563,7 +17563,7 @@ may be expanded when the user presses Tab after a word in the [class@View]. Returns the [class@Gutter] object associated with @window_type for @view. + line="5291">Returns the [class@Gutter] object associated with @window_type for @view. Only %GTK_TEXT_WINDOW_LEFT and %GTK_TEXT_WINDOW_RIGHT are supported, respectively corresponding to the left and right gutter. The line numbers @@ -17572,20 +17572,20 @@ and mark category icons are rendered in the left gutter. the #GtkSourceGutter. + line="5302">the #GtkSourceGutter. a #GtkSourceView. + line="5293">a #GtkSourceView. the gutter window type. + line="5294">the gutter window type. @@ -17595,19 +17595,19 @@ and mark category icons are rendered in the left gutter. glib:get-property="highlight-current-line"> Returns whether the current line is highlighted. + line="4690">Returns whether the current line is highlighted. %TRUE if the current line is highlighted. + line="4696">%TRUE if the current line is highlighted. a #GtkSourceView. + line="4692">a #GtkSourceView. @@ -17615,7 +17615,7 @@ and mark category icons are rendered in the left gutter. Gets the [class@Hover] associated with @view. + line="5265">Gets the [class@Hover] associated with @view. The returned object is guaranteed to be the same for the lifetime of @view. Each [class@View] object has a different [class@Hover]. @@ -17623,14 +17623,14 @@ Each [class@View] object has a different [class@Hover]. a #GtkSourceHover associated with @view. + line="5274">a #GtkSourceHover associated with @view. a #GtkSourceView. + line="5267">a #GtkSourceView. @@ -17640,20 +17640,20 @@ Each [class@View] object has a different [class@Hover]. glib:get-property="indent-on-tab"> Returns whether when the tab key is pressed the current selection + line="4585">Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the `\t` character. %TRUE if the selection is indented when tab is pressed. + line="4592">%TRUE if the selection is indented when tab is pressed. a #GtkSourceView. + line="4587">a #GtkSourceView. @@ -17663,21 +17663,21 @@ should get indented instead of replaced with the `\t` character. glib:get-property="indent-width"> Returns the number of spaces to use for each step of indent. + line="3294">Returns the number of spaces to use for each step of indent. See [method@View.set_indent_width] for details. indent width. + line="3302">indent width. a #GtkSourceView. + line="3296">a #GtkSourceView. @@ -17687,19 +17687,19 @@ See [method@View.set_indent_width] for details. glib:get-property="indenter"> Gets the [property@View:indenter] property. + line="5686">Gets the [property@View:indenter] property. a #GtkSourceIndenter or %NULL + line="5692">a #GtkSourceIndenter or %NULL a #GtkSourceView + line="5688">a #GtkSourceView @@ -17709,20 +17709,20 @@ See [method@View.set_indent_width] for details. glib:get-property="insert-spaces-instead-of-tabs"> Returns whether when inserting a tabulator character it should + line="4538">Returns whether when inserting a tabulator character it should be replaced by a group of space characters. %TRUE if spaces are inserted instead of tabs. + line="4545">%TRUE if spaces are inserted instead of tabs. a #GtkSourceView. + line="4540">a #GtkSourceView. @@ -17731,12 +17731,12 @@ be replaced by a group of space characters. c:identifier="gtk_source_view_get_mark_attributes"> Gets attributes and priority for the @category. + line="5381">Gets attributes and priority for the @category. #GtkSourceMarkAttributes for the @category. + line="5389">#GtkSourceMarkAttributes for the @category. The object belongs to @view, so it must not be unreffed. @@ -17744,19 +17744,19 @@ The object belongs to @view, so it must not be unreffed. a #GtkSourceView. + line="5383">a #GtkSourceView. the category. + line="5384">the category. place where priority of the category will be stored. + line="5385">place where priority of the category will be stored. @@ -17766,19 +17766,19 @@ The object belongs to @view, so it must not be unreffed. glib:get-property="right-margin-position"> Gets the position of the right margin in the given @view. + line="4782">Gets the position of the right margin in the given @view. the position of the right margin. + line="4788">the position of the right margin. a #GtkSourceView. + line="4784">a #GtkSourceView. @@ -17788,19 +17788,19 @@ The object belongs to @view, so it must not be unreffed. glib:get-property="show-line-marks"> Returns whether line marks are displayed beside the text. + line="3088">Returns whether line marks are displayed beside the text. %TRUE if the line marks are displayed. + line="3094">%TRUE if the line marks are displayed. a #GtkSourceView. + line="3090">a #GtkSourceView. @@ -17810,19 +17810,19 @@ The object belongs to @view, so it must not be unreffed. glib:get-property="show-line-numbers"> Returns whether line numbers are displayed beside the text. + line="3022">Returns whether line numbers are displayed beside the text. %TRUE if the line numbers are displayed. + line="3028">%TRUE if the line numbers are displayed. a #GtkSourceView. + line="3024">a #GtkSourceView. @@ -17832,19 +17832,19 @@ The object belongs to @view, so it must not be unreffed. glib:get-property="show-right-margin"> Returns whether a right margin is displayed. + line="4736">Returns whether a right margin is displayed. %TRUE if the right margin is shown. + line="4742">%TRUE if the right margin is shown. a #GtkSourceView. + line="4738">a #GtkSourceView. @@ -17854,20 +17854,20 @@ The object belongs to @view, so it must not be unreffed. glib:get-property="smart-backspace"> Returns %TRUE if pressing the Backspace key will try to delete spaces + line="4854">Returns %TRUE if pressing the Backspace key will try to delete spaces up to the previous tab stop. %TRUE if smart Backspace handling is enabled. + line="4861">%TRUE if smart Backspace handling is enabled. a #GtkSourceView. + line="4856">a #GtkSourceView. @@ -17877,20 +17877,20 @@ up to the previous tab stop. glib:get-property="smart-home-end"> Returns a [enum@SmartHomeEndType] end value specifying + line="4897">Returns a [enum@SmartHomeEndType] end value specifying how the cursor will move when HOME and END keys are pressed. a #GtkSourceSmartHomeEndType value. + line="4904">a #GtkSourceSmartHomeEndType value. a #GtkSourceView. + line="4899">a #GtkSourceView. @@ -17900,7 +17900,7 @@ how the cursor will move when HOME and END keys are pressed. glib:get-property="space-drawer"> Gets the [class@SpaceDrawer] associated with @view. + line="5464">Gets the [class@SpaceDrawer] associated with @view. The returned object is guaranteed to be the same for the lifetime of @view. Each [class@View] object has a different [class@SpaceDrawer]. @@ -17908,14 +17908,14 @@ Each [class@View] object has a different [class@SpaceDrawer]. the #GtkSourceSpaceDrawer associated with @view. + line="5473">the #GtkSourceSpaceDrawer associated with @view. a #GtkSourceView. + line="5466">a #GtkSourceView. @@ -17925,19 +17925,19 @@ Each [class@View] object has a different [class@SpaceDrawer]. glib:get-property="tab-width"> Returns the width of tabulation in characters. + line="3231">Returns the width of tabulation in characters. width of tab. + line="3237">width of tab. a #GtkSourceView. + line="3233">a #GtkSourceView. @@ -17946,26 +17946,26 @@ Each [class@View] object has a different [class@SpaceDrawer]. c:identifier="gtk_source_view_get_visual_column"> Determines the visual column at @iter taking into consideration the + line="4916">Determines the visual column at @iter taking into consideration the [property@View:tab-width] of @view. the visual column at @iter. + line="4924">the visual column at @iter. a #GtkSourceView. + line="4918">a #GtkSourceView. a position in @view. + line="4919">a position in @view. @@ -17973,7 +17973,7 @@ Each [class@View] object has a different [class@SpaceDrawer]. Inserts one indentation level at the beginning of the specified lines. The + line="3347">Inserts one indentation level at the beginning of the specified lines. The empty lines are not indented. @@ -17983,19 +17983,19 @@ empty lines are not indented. a #GtkSourceView. + line="3349">a #GtkSourceView. #GtkTextIter of the first line to indent + line="3350">#GtkTextIter of the first line to indent #GtkTextIter of the last line to indent + line="3351">#GtkTextIter of the last line to indent @@ -18003,7 +18003,7 @@ empty lines are not indented. Inserts a new snippet at @location + line="5581">Inserts a new snippet at @location If another snippet was already active, it will be paused and the new snippet will become active. Once the focus positions of @snippet have @@ -18016,13 +18016,13 @@ been exhausted, editing will return to the previous snippet. a #GtkSourceView + line="5583">a #GtkSourceView a #GtkSourceSnippet + line="5584">a #GtkSourceSnippet allow-none="1"> a #GtkTextIter or %NULL for the cursor position + line="5585">a #GtkTextIter or %NULL for the cursor position @@ -18041,7 +18041,7 @@ been exhausted, editing will return to the previous snippet. glib:set-property="auto-indent"> If %TRUE auto-indentation of text is enabled. + line="4508">If %TRUE auto-indentation of text is enabled. When Enter is pressed to create a new line, the auto-indentation inserts the same indentation as the previous line. This is **not** a @@ -18055,13 +18055,13 @@ on the context. a #GtkSourceView. + line="4510">a #GtkSourceView. whether to enable auto indentation. + line="4511">whether to enable auto indentation. @@ -18071,7 +18071,7 @@ on the context. glib:set-property="background-pattern"> Set if and how the background pattern should be displayed. + line="5419">Set if and how the background pattern should be displayed. @@ -18080,13 +18080,13 @@ on the context. a #GtkSourceView. + line="5421">a #GtkSourceView. the #GtkSourceBackgroundPatternType. + line="5422">the #GtkSourceBackgroundPatternType. @@ -18097,7 +18097,7 @@ on the context. glib:set-property="enable-snippets"> Sets the [property@View:enable-snippets] property. + line="5656">Sets the [property@View:enable-snippets] property. If @enable_snippets is %TRUE, matching snippets found in the [class@SnippetManager] may be expanded when the user presses @@ -18110,13 +18110,13 @@ Tab after a word in the [class@View]. a #GtkSourceView + line="5658">a #GtkSourceView if snippets should be enabled + line="5659">if snippets should be enabled @@ -18126,7 +18126,7 @@ Tab after a word in the [class@View]. glib:set-property="highlight-current-line"> If @highlight is %TRUE the current line will be highlighted. + line="4708">If @highlight is %TRUE the current line will be highlighted. @@ -18135,13 +18135,13 @@ Tab after a word in the [class@View]. a #GtkSourceView. + line="4710">a #GtkSourceView. whether to highlight the current line. + line="4711">whether to highlight the current line. @@ -18151,7 +18151,7 @@ Tab after a word in the [class@View]. glib:set-property="indent-on-tab"> If %TRUE, when the tab key is pressed when several lines are selected, the + line="4604">If %TRUE, when the tab key is pressed when several lines are selected, the selected lines are indented of one level instead of being replaced with a `\t` character. Shift+Tab unindents the selection. @@ -18168,13 +18168,13 @@ the selection with a normal `\t` character. a #GtkSourceView. + line="4606">a #GtkSourceView. whether to indent a block when tab is pressed. + line="4607">whether to indent a block when tab is pressed. @@ -18184,7 +18184,7 @@ the selection with a normal `\t` character. glib:set-property="indent-width"> Sets the number of spaces to use for each step of indent when the tab key is + line="3249">Sets the number of spaces to use for each step of indent when the tab key is pressed. If @width is -1, the value of the [property@View:tab-width] property @@ -18214,13 +18214,13 @@ drawing!). a #GtkSourceView. + line="3251">a #GtkSourceView. indent width in characters. + line="3252">indent width in characters. @@ -18230,7 +18230,7 @@ drawing!). glib:set-property="indenter"> Sets the indenter for @view to @indenter. + line="5704">Sets the indenter for @view to @indenter. Note that the indenter will not be used unless #GtkSourceView:auto-indent has been set to %TRUE. @@ -18242,7 +18242,7 @@ has been set to %TRUE. a #GtkSourceView + line="5706">a #GtkSourceView allow-none="1"> a #GtkSourceIndenter or %NULL + line="5707">a #GtkSourceIndenter or %NULL @@ -18261,7 +18261,7 @@ has been set to %TRUE. glib:set-property="insert-spaces-instead-of-tabs"> If %TRUE a tab key pressed is replaced by a group of space characters. + line="4557">If %TRUE a tab key pressed is replaced by a group of space characters. Of course it is still possible to insert a real `\t` programmatically with the [class@Gtk.TextBuffer] API. @@ -18273,13 +18273,13 @@ Of course it is still possible to insert a real `\t` programmatically with the a #GtkSourceView. + line="4559">a #GtkSourceView. whether to insert spaces instead of tabs. + line="4560">whether to insert spaces instead of tabs. @@ -18288,7 +18288,7 @@ Of course it is still possible to insert a real `\t` programmatically with the c:identifier="gtk_source_view_set_mark_attributes"> Sets attributes and priority for the @category. + line="5352">Sets attributes and priority for the @category. @@ -18297,25 +18297,25 @@ Of course it is still possible to insert a real `\t` programmatically with the a #GtkSourceView. + line="5354">a #GtkSourceView. the category. + line="5355">the category. mark attributes. + line="5356">mark attributes. priority of the category. + line="5357">priority of the category. @@ -18325,7 +18325,7 @@ Of course it is still possible to insert a real `\t` programmatically with the glib:set-property="right-margin-position"> Sets the position of the right margin in the given @view. + line="4800">Sets the position of the right margin in the given @view. @@ -18334,13 +18334,13 @@ Of course it is still possible to insert a real `\t` programmatically with the a #GtkSourceView. + line="4802">a #GtkSourceView. the width in characters where to position the right margin. + line="4803">the width in characters where to position the right margin. @@ -18350,7 +18350,7 @@ Of course it is still possible to insert a real `\t` programmatically with the glib:set-property="show-line-marks"> If %TRUE line marks will be displayed beside the text. + line="3119">If %TRUE line marks will be displayed beside the text. @@ -18359,13 +18359,13 @@ Of course it is still possible to insert a real `\t` programmatically with the a #GtkSourceView. + line="3121">a #GtkSourceView. whether line marks should be displayed. + line="3122">whether line marks should be displayed. @@ -18375,7 +18375,7 @@ Of course it is still possible to insert a real `\t` programmatically with the glib:set-property="show-line-numbers"> If %TRUE line numbers will be displayed beside the text. + line="3040">If %TRUE line numbers will be displayed beside the text. @@ -18384,13 +18384,13 @@ Of course it is still possible to insert a real `\t` programmatically with the a #GtkSourceView. + line="3042">a #GtkSourceView. whether line numbers should be displayed. + line="3043">whether line numbers should be displayed. @@ -18400,7 +18400,7 @@ Of course it is still possible to insert a real `\t` programmatically with the glib:set-property="show-right-margin"> If %TRUE a right margin is displayed. + line="4754">If %TRUE a right margin is displayed. @@ -18409,13 +18409,13 @@ Of course it is still possible to insert a real `\t` programmatically with the a #GtkSourceView. + line="4756">a #GtkSourceView. whether to show a right margin. + line="4757">whether to show a right margin. @@ -18425,7 +18425,7 @@ Of course it is still possible to insert a real `\t` programmatically with the glib:set-property="smart-backspace"> When set to %TRUE, pressing the Backspace key will try to delete spaces + line="4828">When set to %TRUE, pressing the Backspace key will try to delete spaces up to the previous tab stop. @@ -18435,13 +18435,13 @@ up to the previous tab stop. a #GtkSourceView. + line="4830">a #GtkSourceView. whether to enable smart Backspace handling. + line="4831">whether to enable smart Backspace handling. @@ -18451,7 +18451,7 @@ up to the previous tab stop. glib:set-property="smart-home-end"> Set the desired movement of the cursor when HOME and END keys + line="4873">Set the desired movement of the cursor when HOME and END keys are pressed. @@ -18461,13 +18461,13 @@ are pressed. a #GtkSourceView. + line="4875">a #GtkSourceView. the desired behavior among #GtkSourceSmartHomeEndType. + line="4876">the desired behavior among #GtkSourceSmartHomeEndType. @@ -18477,7 +18477,7 @@ are pressed. glib:set-property="tab-width"> Sets the width of tabulation in characters. + line="3192">Sets the width of tabulation in characters. The #GtkTextBuffer still contains `\t` characters, but they can take a different visual width in a [class@View] widget. @@ -18489,13 +18489,13 @@ but they can take a different visual width in a [class@View] widget. a #GtkSourceView. + line="3194">a #GtkSourceView. width of tab in characters. + line="3195">width of tab in characters. @@ -18504,7 +18504,7 @@ but they can take a different visual width in a [class@View] widget. c:identifier="gtk_source_view_unindent_lines"> Removes one indentation level at the beginning of the + line="3500">Removes one indentation level at the beginning of the specified lines. @@ -18514,19 +18514,19 @@ specified lines. a #GtkSourceView. + line="3502">a #GtkSourceView. #GtkTextIter of the first line to indent + line="3503">#GtkTextIter of the first line to indent #GtkTextIter of the last line to indent + line="3504">#GtkTextIter of the last line to indent @@ -19001,13 +19001,13 @@ home/end. a #GtkSourceView + line="5583">a #GtkSourceView a #GtkSourceSnippet + line="5584">a #GtkSourceSnippet allow-none="1"> a #GtkTextIter or %NULL for the cursor position + line="5585">a #GtkTextIter or %NULL for the cursor position diff --git a/girs/Gucharmap-2.90.gir b/girs/Gucharmap-2.90.gir index 003ec87c3..69d22404f 100644 --- a/girs/Gucharmap-2.90.gir +++ b/girs/Gucharmap-2.90.gir @@ -2571,7 +2571,7 @@ and/or use gtk-doc annotations. --> - + diff --git a/girs/Guestfs-1.0.gir b/girs/Guestfs-1.0.gir index 87c5378d7..2d9fbe4ed 100644 --- a/girs/Guestfs-1.0.gir +++ b/girs/Guestfs-1.0.gir @@ -8,12 +8,161 @@ and/or use gtk-doc annotations. --> xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsAddDomain object + line="354">Create a new GuestfsAddDomain object a new GuestfsAddDomain object + line="359">a new GuestfsAddDomain object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="258">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="292">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="326">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="309">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="224">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="190">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="241">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="207">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="275">A string. @@ -144,7 +302,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -163,113 +322,134 @@ and/or use gtk-doc annotations. --> Create a new GuestfsAddDrive object + line="445">Create a new GuestfsAddDrive object a new GuestfsAddDrive object + line="450">a new GuestfsAddDrive object + + A 32-bit integer. + + + transfer-ownership="none" + default-value="NULL"> A string. + line="366">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="400">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="383">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="247">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="264">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="298">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="281">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="315">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="230">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="349">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="332">A string. @@ -296,7 +476,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -315,32 +496,44 @@ and/or use gtk-doc annotations. --> Create a new GuestfsAddDriveScratch object + line="186">Create a new GuestfsAddDriveScratch object a new GuestfsAddDriveScratch object + line="191">a new GuestfsAddDriveScratch object + + A 32-bit integer. + + + transfer-ownership="none" + default-value="NULL"> A string. + line="141">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="124">A string. @@ -368,7 +561,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -387,77 +581,84 @@ and/or use gtk-doc annotations. --> Create a new GuestfsAddLibvirtDom object + line="298">Create a new GuestfsAddLibvirtDom object a new GuestfsAddLibvirtDom object + line="303">a new GuestfsAddLibvirtDom object + transfer-ownership="none" + default-value="NULL"> A string. + line="236">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="270">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="253">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="185">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="202">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="168">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="219">A string. @@ -485,7 +686,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -694,23 +896,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsAugTransform object + line="125">Create a new GuestfsAugTransform object a new GuestfsAugTransform object + line="130">a new GuestfsAugTransform object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -737,7 +940,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -795,13 +999,13 @@ and/or use gtk-doc annotations. --> c:identifier="guestfs_btrfs_filesystem_defragment_new"> Create a new GuestfsBTRFSFilesystemDefragment object + line="157">Create a new GuestfsBTRFSFilesystemDefragment object a new GuestfsBTRFSFilesystemDefragment object + line="162">a new GuestfsBTRFSFilesystemDefragment object @@ -809,19 +1013,21 @@ and/or use gtk-doc annotations. --> + transfer-ownership="none" + default-value="NULL"> A string. + line="129">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="112">A boolean. @@ -849,7 +1055,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -869,13 +1076,13 @@ and/or use gtk-doc annotations. --> c:identifier="guestfs_btrfs_filesystem_resize_new"> Create a new GuestfsBTRFSFilesystemResize object + line="125">Create a new GuestfsBTRFSFilesystemResize object a new GuestfsBTRFSFilesystemResize object + line="130">a new GuestfsBTRFSFilesystemResize object @@ -883,10 +1090,11 @@ and/or use gtk-doc annotations. --> + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="97">A 64-bit integer. @@ -914,7 +1122,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -933,23 +1142,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsBTRFSImage object + line="125">Create a new GuestfsBTRFSImage object a new GuestfsBTRFSImage object + line="130">a new GuestfsBTRFSImage object + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="97">A 32-bit integer. @@ -976,7 +1186,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -1146,13 +1357,13 @@ and/or use gtk-doc annotations. --> c:identifier="guestfs_btrfs_subvolume_create_new"> Create a new GuestfsBTRFSSubvolumeCreate object + line="130">Create a new GuestfsBTRFSSubvolumeCreate object a new GuestfsBTRFSSubvolumeCreate object + line="135">a new GuestfsBTRFSSubvolumeCreate object @@ -1160,10 +1371,11 @@ and/or use gtk-doc annotations. --> + transfer-ownership="none" + default-value="NULL"> A string. + line="102">A string. @@ -1191,7 +1403,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -1211,13 +1424,13 @@ and/or use gtk-doc annotations. --> c:identifier="guestfs_btrfs_subvolume_snapshot_new"> Create a new GuestfsBTRFSSubvolumeSnapshot object + line="157">Create a new GuestfsBTRFSSubvolumeSnapshot object a new GuestfsBTRFSSubvolumeSnapshot object + line="162">a new GuestfsBTRFSSubvolumeSnapshot object @@ -1225,16 +1438,21 @@ and/or use gtk-doc annotations. --> + transfer-ownership="none" + default-value="NULL"> A string. + line="129">A string. - + A boolean. + line="112">A boolean. @@ -1262,10 +1480,191 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsBtrfsFsck object + line="152">Create a new GuestfsBtrfsFsck object a new GuestfsBtrfsFsck object + line="157">a new GuestfsBtrfsFsck object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="124">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="107">A 64-bit integer. @@ -1333,10 +1734,281 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsCompressDeviceOut object + line="125">Create a new GuestfsCompressDeviceOut object a new GuestfsCompressDeviceOut object + line="130">a new GuestfsCompressDeviceOut object + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="97">A 32-bit integer. @@ -1396,7 +2069,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -1415,23 +2089,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsCompressOut object + line="125">Create a new GuestfsCompressOut object a new GuestfsCompressOut object + line="130">a new GuestfsCompressOut object + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="97">A 32-bit integer. @@ -1458,7 +2133,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -1477,50 +2153,54 @@ and/or use gtk-doc annotations. --> Create a new GuestfsCopyAttributes object + line="206">Create a new GuestfsCopyAttributes object a new GuestfsCopyAttributes object + line="211">a new GuestfsCopyAttributes object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="127">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="144">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="178">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="161">A boolean. @@ -1548,7 +2228,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -1567,59 +2248,64 @@ and/or use gtk-doc annotations. --> Create a new GuestfsCopyDeviceToDevice object + line="233">Create a new GuestfsCopyDeviceToDevice object a new GuestfsCopyDeviceToDevice object + line="238">a new GuestfsCopyDeviceToDevice object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="205">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="154">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="171">A 64-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="188">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="137">A 64-bit integer. @@ -1647,7 +2333,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -1666,59 +2353,64 @@ and/or use gtk-doc annotations. --> Create a new GuestfsCopyDeviceToFile object + line="233">Create a new GuestfsCopyDeviceToFile object a new GuestfsCopyDeviceToFile object + line="238">a new GuestfsCopyDeviceToFile object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="205">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="154">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="171">A 64-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="188">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="137">A 64-bit integer. @@ -1746,7 +2438,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -1765,59 +2458,64 @@ and/or use gtk-doc annotations. --> Create a new GuestfsCopyFileToDevice object + line="233">Create a new GuestfsCopyFileToDevice object a new GuestfsCopyFileToDevice object + line="238">a new GuestfsCopyFileToDevice object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="205">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="154">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="171">A 64-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="188">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="137">A 64-bit integer. @@ -1845,7 +2543,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -1864,59 +2563,64 @@ and/or use gtk-doc annotations. --> Create a new GuestfsCopyFileToFile object + line="233">Create a new GuestfsCopyFileToFile object a new GuestfsCopyFileToFile object + line="238">a new GuestfsCopyFileToFile object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="205">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="154">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="171">A 64-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="188">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="137">A 64-bit integer. @@ -1944,7 +2648,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -1963,23 +2668,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsCpioOut object + line="130">Create a new GuestfsCpioOut object a new GuestfsCpioOut object + line="135">a new GuestfsCpioOut object + transfer-ownership="none" + default-value="NULL"> A string. + line="102">A string. @@ -2004,10 +2710,148 @@ and/or use gtk-doc annotations. --> - + + + An object encapsulating optional arguments for guestfs_session_cryptsetup_open. + + + Create a new GuestfsCryptsetupOpen object + + + a new GuestfsCryptsetupOpen object + + + + + A string. + + + + A boolean. + + + + + + + + + + + A class metadata object for GuestfsCryptsetupOpen. + + + The superclass of GuestfsCryptsetupOpenClass + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsDiskCreate object + line="244">Create a new GuestfsDiskCreate object a new GuestfsDiskCreate object + line="249">a new GuestfsDiskCreate object + transfer-ownership="none" + default-value="NULL"> A string. + line="148">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="165">A string. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="216">A 32-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="199">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="182">A string. @@ -2128,7 +2977,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -2147,23 +2997,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsDownloadBlocks object + line="125">Create a new GuestfsDownloadBlocks object a new GuestfsDownloadBlocks object + line="130">a new GuestfsDownloadBlocks object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -2191,10 +3042,41 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsE2fsck object + line="152">Create a new GuestfsE2fsck object a new GuestfsE2fsck object + line="157">a new GuestfsE2fsck object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="107">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="124">A boolean. @@ -2260,10 +3144,43 @@ and/or use gtk-doc annotations. --> - + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsFstrim object + line="179">Create a new GuestfsFstrim object a new GuestfsFstrim object + line="184">a new GuestfsFstrim object + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="134">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="151">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="117">A 64-bit integer. @@ -2338,10 +3258,71 @@ and/or use gtk-doc annotations. --> - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsGlobExpand object + line="125">Create a new GuestfsGlobExpand object a new GuestfsGlobExpand object + line="130">a new GuestfsGlobExpand object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -2400,7 +3382,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -2419,50 +3402,54 @@ and/or use gtk-doc annotations. --> Create a new GuestfsGrep object + line="206">Create a new GuestfsGrep object a new GuestfsGrep object + line="211">a new GuestfsGrep object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="178">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="127">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="144">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="161">A boolean. @@ -2487,10 +3474,43 @@ and/or use gtk-doc annotations. --> - + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsHivexOpen object + line="206">Create a new GuestfsHivexOpen object a new GuestfsHivexOpen object + line="211">a new GuestfsHivexOpen object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="144">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="178">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="127">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="161">A boolean. @@ -2590,7 +3614,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -2608,6 +3633,126 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsInspectGetIcon object + line="152">Create a new GuestfsInspectGetIcon object a new GuestfsInspectGetIcon object + line="157">a new GuestfsInspectGetIcon object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="107">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="124">A boolean. @@ -2818,7 +5443,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -2857,50 +5483,54 @@ and/or use gtk-doc annotations. --> Create a new GuestfsInternalTest object + line="213">Create a new GuestfsInternalTest object a new GuestfsInternalTest object + line="218">a new GuestfsInternalTest object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="134">A boolean. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="151">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="168">A 64-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="185">A string. @@ -2926,13 +5556,13 @@ and/or use gtk-doc annotations. --> c:identifier="guestfs_internal_test_63_optargs_new"> Create a new GuestfsInternalTest63Optargs object + line="1799">Create a new GuestfsInternalTest63Optargs object a new GuestfsInternalTest63Optargs object + line="1804">a new GuestfsInternalTest63Optargs object @@ -2940,568 +5570,631 @@ and/or use gtk-doc annotations. --> + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="717">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="870">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="887">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="904">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="921">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="938">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="955">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="972">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="989">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1006">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1023">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="734">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1040">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1057">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1074">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1091">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1108">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1125">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1142">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1159">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1176">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1193">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="751">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1210">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1227">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1244">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1261">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1278">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1295">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1312">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1329">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1346">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1363">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="768">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1380">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1397">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1414">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1431">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1448">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1465">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1482">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1499">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1516">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1533">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="785">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1550">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1567">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1584">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1601">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1618">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1635">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1652">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1669">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1686">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1703">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="802">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1720">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1737">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1754">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="1771">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="819">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="836">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="853">A 32-bit integer. @@ -3529,7 +6222,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -3564,13 +6258,13 @@ and/or use gtk-doc annotations. --> c:identifier="guestfs_internal_test_only_optargs_new"> Create a new GuestfsInternalTestOnlyOptargs object + line="125">Create a new GuestfsInternalTestOnlyOptargs object a new GuestfsInternalTestOnlyOptargs object + line="130">a new GuestfsInternalTestOnlyOptargs object @@ -3578,10 +6272,11 @@ and/or use gtk-doc annotations. --> + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="97">A 32-bit integer. @@ -3609,13 +6304,15 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> + disguised="1" + opaque="1"> @@ -3634,23 +6331,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsIsBlockdev object + line="125">Create a new GuestfsIsBlockdev object a new GuestfsIsBlockdev object + line="130">a new GuestfsIsBlockdev object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -3677,7 +6375,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -3696,23 +6395,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsIsChardev object + line="125">Create a new GuestfsIsChardev object a new GuestfsIsChardev object + line="130">a new GuestfsIsChardev object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -3739,7 +6439,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -3758,23 +6459,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsIsDir object + line="125">Create a new GuestfsIsDir object a new GuestfsIsDir object + line="130">a new GuestfsIsDir object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -3799,7 +6501,10 @@ and/or use gtk-doc annotations. --> - + @@ -3818,23 +6523,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsIsFifo object + line="125">Create a new GuestfsIsFifo object a new GuestfsIsFifo object + line="130">a new GuestfsIsFifo object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -3859,7 +6565,10 @@ and/or use gtk-doc annotations. --> - + @@ -3878,23 +6587,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsIsFile object + line="125">Create a new GuestfsIsFile object a new GuestfsIsFile object + line="130">a new GuestfsIsFile object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -3919,7 +6629,10 @@ and/or use gtk-doc annotations. --> - + @@ -3938,23 +6651,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsIsSocket object + line="125">Create a new GuestfsIsSocket object a new GuestfsIsSocket object + line="130">a new GuestfsIsSocket object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -3981,7 +6695,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -4106,59 +6821,64 @@ and/or use gtk-doc annotations. --> Create a new GuestfsMDCreate object + line="238">Create a new GuestfsMDCreate object a new GuestfsMDCreate object + line="243">a new GuestfsMDCreate object + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="193">A 64-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="210">A string. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="142">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="159">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="176">A 32-bit integer. @@ -4185,7 +6905,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -4215,6 +6936,274 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsMke2fs object + line="1141">Create a new GuestfsMke2fs object a new GuestfsMke2fs object + line="1146">a new GuestfsMke2fs object + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="484">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="501">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="535">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="569">A 64-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="773">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="926">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="960">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="977">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="994">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="841">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="518">A 64-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="790">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="1011">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="586">A 64-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="1028">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="722">A string. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="603">A 64-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="739">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="1045">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="756">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="875">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="892">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="671">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="705">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="552">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="620">A 64-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="1062">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="943">A boolean. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="688">A 32-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="1079">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="1096">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="637">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="654">A 64-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="909">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="1113">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="807">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="824">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="858">A boolean. @@ -4604,7 +7631,10 @@ and/or use gtk-doc annotations. --> - + @@ -4623,59 +7653,64 @@ and/or use gtk-doc annotations. --> Create a new GuestfsMkfs object + line="240">Create a new GuestfsMkfs object a new GuestfsMkfs object + line="245">a new GuestfsMkfs object + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="144">A 32-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="161">A string. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="178">A 32-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="212">A string. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="195">A 32-bit integer. @@ -4700,86 +7735,94 @@ and/or use gtk-doc annotations. --> Create a new GuestfsMkfsBtrfs object + line="323">Create a new GuestfsMkfsBtrfs object a new GuestfsMkfsBtrfs object + line="328">a new GuestfsMkfsBtrfs object + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="176">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="193">A 64-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="210">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="244">A string. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="227">A 32-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="261">A string. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="278">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="295">A 32-bit integer. @@ -4806,7 +7849,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -4825,7 +7869,10 @@ and/or use gtk-doc annotations. --> - + @@ -4844,23 +7891,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsMksquashfs object + line="132">Create a new GuestfsMksquashfs object a new GuestfsMksquashfs object + line="137">a new GuestfsMksquashfs object + transfer-ownership="none" + default-value="NULL"> A string. + line="104">A string. @@ -4887,7 +7935,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -4906,32 +7955,34 @@ and/or use gtk-doc annotations. --> Create a new GuestfsMkswap object + line="159">Create a new GuestfsMkswap object a new GuestfsMkswap object + line="164">a new GuestfsMkswap object + transfer-ownership="none" + default-value="NULL"> A string. + line="114">A string. + transfer-ownership="none" + default-value="NULL"> A string. + line="131">A string. @@ -4956,7 +8007,10 @@ and/or use gtk-doc annotations. --> - + @@ -4975,23 +8029,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsMktemp object + line="130">Create a new GuestfsMktemp object a new GuestfsMktemp object + line="135">a new GuestfsMktemp object + transfer-ownership="none" + default-value="NULL"> A string. + line="102">A string. @@ -5016,7 +8071,10 @@ and/or use gtk-doc annotations. --> - + @@ -5035,23 +8093,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsMount9P object + line="130">Create a new GuestfsMount9P object a new GuestfsMount9P object + line="135">a new GuestfsMount9P object + transfer-ownership="none" + default-value="NULL"> A string. + line="102">A string. @@ -5076,7 +8135,10 @@ and/or use gtk-doc annotations. --> - + @@ -5095,50 +8157,54 @@ and/or use gtk-doc annotations. --> Create a new GuestfsMountLocal object + line="211">Create a new GuestfsMountLocal object a new GuestfsMountLocal object + line="216">a new GuestfsMountLocal object + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="166">A 32-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="183">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="149">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="132">A boolean. @@ -5165,10 +8231,101 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsNTFSResizeOpts object + line="152">Create a new GuestfsNTFSResizeOpts object a new GuestfsNTFSResizeOpts object + line="157">a new GuestfsNTFSResizeOpts object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="124">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="107">A 64-bit integer. @@ -5237,7 +8396,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -5256,59 +8416,64 @@ and/or use gtk-doc annotations. --> Create a new GuestfsNtfscloneOut object + line="233">Create a new GuestfsNtfscloneOut object a new GuestfsNtfscloneOut object + line="238">a new GuestfsNtfscloneOut object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="205">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="171">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="137">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="188">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="154">A boolean. @@ -5335,7 +8500,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -5354,23 +8520,24 @@ and/or use gtk-doc annotations. --> Create a new GuestfsNtfsfix object + line="125">Create a new GuestfsNtfsfix object a new GuestfsNtfsfix object + line="130">a new GuestfsNtfsfix object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -5395,7 +8562,10 @@ and/or use gtk-doc annotations. --> - + @@ -5525,6 +8695,126 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsRemount object + line="125">Create a new GuestfsRemount object a new GuestfsRemount object + line="130">a new GuestfsRemount object - + A boolean. + line="97">A boolean. @@ -5578,7 +8872,10 @@ and/or use gtk-doc annotations. --> - + @@ -5597,32 +8894,34 @@ and/or use gtk-doc annotations. --> Create a new GuestfsRsync object + line="152">Create a new GuestfsRsync object a new GuestfsRsync object + line="157">a new GuestfsRsync object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="107">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="124">A boolean. @@ -5662,32 +8961,34 @@ and/or use gtk-doc annotations. --> Create a new GuestfsRsyncIn object + line="152">Create a new GuestfsRsyncIn object a new GuestfsRsyncIn object + line="157">a new GuestfsRsyncIn object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="107">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="124">A boolean. @@ -5712,7 +9013,10 @@ and/or use gtk-doc annotations. --> - + @@ -5731,32 +9035,34 @@ and/or use gtk-doc annotations. --> Create a new GuestfsRsyncOut object + line="152">Create a new GuestfsRsyncOut object a new GuestfsRsyncOut object + line="157">a new GuestfsRsyncOut object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="107">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="124">A boolean. @@ -5783,14 +9089,135 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsSelinuxRelabel object + line="125">Create a new GuestfsSelinuxRelabel object a new GuestfsSelinuxRelabel object + line="130">a new GuestfsSelinuxRelabel object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -5850,7 +9278,8 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> @@ -5869,13 +9298,13 @@ and/or use gtk-doc annotations. --> Create a new libguestfs session. + line="383">Create a new libguestfs session. a new guestfs session object + line="388">a new guestfs session object @@ -5885,7 +9314,7 @@ and/or use gtk-doc annotations. --> throws="1"> delete the default POSIX ACL of a directory + line="420">delete the default POSIX ACL of a directory This function deletes the default POSIX Access Control List (ACL) attached to directory @dir. @@ -5897,14 +9326,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="434">true on success, false on error A GuestfsSession object + line="422">A GuestfsSession object @@ -5918,7 +9347,7 @@ See also guestfs_session_feature_available(). throws="1"> get the POSIX ACL attached to a file + line="457">get the POSIX ACL attached to a file This function returns the POSIX Access Control List (ACL) attached to @path. The ACL is returned in "long text form" (see acl(5)). @@ -5940,14 +9369,14 @@ See also guestfs_session_feature_available(). the returned string, or NULL on error + line="482">the returned string, or NULL on error A GuestfsSession object + line="459">A GuestfsSession object @@ -5964,7 +9393,7 @@ See also guestfs_session_feature_available(). throws="1"> set the POSIX ACL attached to a file + line="505">set the POSIX ACL attached to a file This function sets the POSIX Access Control List (ACL) attached to @path. @@ -6003,14 +9432,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="548">true on success, false on error A GuestfsSession object + line="507">A GuestfsSession object @@ -6031,7 +9460,7 @@ See also guestfs_session_feature_available(). throws="1"> add a CD-ROM disk image to examine + line="571">add a CD-ROM disk image to examine This function adds a virtual CD-ROM disk image to the guest. @@ -6043,14 +9472,14 @@ guestfs_session_add_drive_ro(). true on success, false on error + line="584">true on success, false on error A GuestfsSession object + line="573">A GuestfsSession object @@ -6064,7 +9493,7 @@ guestfs_session_add_drive_ro(). throws="1"> add the disk(s) from a named libvirt domain + line="608">add the disk(s) from a named libvirt domain This function adds the disk(s) attached to the named libvirt domain @dom. It works by connecting to libvirt, requesting the domain and @@ -6080,21 +9509,17 @@ try to acquire the libvirt lock on each disk. Disks must be accessible locally. This often means that adding disks from a remote libvirt connection (see <ulink -url='http://libvirt.org/remote.html'> http://libvirt.org/remote.html +url='https://libvirt.org/remote.html'> http://libvirt.org/remote.html </ulink>) will fail unless those disks are accessible via the same device path locally too. The optional @libvirturi parameter sets the libvirt URI (see <ulink -url='http://libvirt.org/uri.html'> http://libvirt.org/uri.html +url='https://libvirt.org/uri.html'> http://libvirt.org/uri.html </ulink>). If this is not set then we connect to the default libvirt URI (or one set through an environment variable, see the libvirt documentation for full details). -The optional @live flag controls whether this call will try to connect -to a running virtual machine @guestfsd process if it sees a suitable -&lt;channel&gt; element in the libvirt XML definition. The default (if -the flag is omitted) is never to try. See "ATTACHING TO RUNNING DAEMONS" -in guestfs(3) for more information. +The optional @live flag is ignored in libguestfs &ge; 1.48. If the @allowuuid flag is true (default is false) then a UUID *may* be passed instead of the domain name. The @dom string is treated as a UUID @@ -6138,6 +9563,10 @@ If @readonly is true or false: Disks with the &lt;readonly/&gt; flag are skipped. +If present, the value of @logical_block_size attribute of +&lt;blockio/&gt; tag in libvirt XML will be passed as @blocksize +parameter to guestfs_session_add_drive_opts(). + The other optional parameters are passed directly through to guestfs_session_add_drive_opts(). the returned value, or -1 on error + line="692">the returned value, or -1 on error A GuestfsSession object + line="610">A GuestfsSession object @@ -6164,7 +9593,7 @@ guestfs_session_add_drive_opts(). allow-none="1"> a GuestfsAddDomain containing optional arguments + line="612">a GuestfsAddDomain containing optional arguments @@ -6175,7 +9604,7 @@ guestfs_session_add_drive_opts(). throws="1"> add an image to examine or modify + line="795">add an image to examine or modify This function adds a disk image called filename to the handle. filename may be a regular host file or a host device. @@ -6184,11 +9613,6 @@ When this function is called before guestfs_session_launch() (the usual case) then the first time you call this function, the disk appears in the API as /dev/sda, the second time as /dev/sdb, and so on. -In libguestfs &ge; 1.20 you can also call this function after launch -(with some restrictions). This is called "hotplugging". When -hotplugging, you must specify a @label so that the new disk gets a -predictable name. For more information see "HOTPLUGGING" in guestfs(3). - You don't necessarily need to be root when using libguestfs. However you obviously do need sufficient permissions to access the filename for whatever operations you want to perform (ie. read access if you just @@ -6224,8 +9648,8 @@ This rarely-used option lets you emulate the behaviour of the deprecated guestfs_session_add_drive_with_if() call (q.v.) @name -The name the drive had in the original guest, e.g. /dev/sdb. This is -used as a hint to the guest inspection process if it is available. +This field used to be passed as a hint for guest inspection, but it +is no longer used. @label Give the disk a label. The label should be a unique, short string @@ -6401,20 +9825,30 @@ only affects disk formats which have backing files, and causes reads to be stored in the overlay layer, speeding up multiple reads of the same area of disk. -The default is false. +The default is false. + +@blocksize +This parameter sets the sector size of the disk. Possible values are +@512 (the default if the parameter is omitted) or @4096. Use @4096 +when handling an "Advanced Format" disk that uses 4K sector size +(<ulink url='https://en.wikipedia.org/wiki/Advanced_Format'> +http://en.wikipedia.org/wiki/Advanced_Format </ulink>). + +Only a subset of the backends support this parameter (currently only +the libvirt and direct backends do). true on success, false on error + line="1035">true on success, false on error A GuestfsSession object + line="797">A GuestfsSession object @@ -6426,7 +9860,7 @@ The default is false. allow-none="1"> a GuestfsAddDrive containing optional arguments + line="799">a GuestfsAddDrive containing optional arguments @@ -6437,7 +9871,7 @@ The default is false. throws="1"> add a drive in snapshot mode (read-only) + line="1162">add a drive in snapshot mode (read-only) This function is the equivalent of calling guestfs_session_add_drive_opts() with the optional parameter @@ -6448,14 +9882,14 @@ read-only, with the format being detected automatically. true on success, false on error + line="1175">true on success, false on error A GuestfsSession object + line="1164">A GuestfsSession object @@ -6470,24 +9904,25 @@ read-only, with the format being detected automatically. throws="1"> add a drive read-only specifying the QEMU block emulation to use + line="1198">add a drive read-only specifying the QEMU block emulation to use This is the same as guestfs_session_add_drive_ro() but it allows you to -specify the QEMU interface emulation to use at run time. +specify the QEMU interface emulation to use at run time. Both the direct +and the libvirt backends ignore @iface. In new code, use guestfs_session_add_drive() instead true on success, false on error + line="1211">true on success, false on error A GuestfsSession object + line="1200">A GuestfsSession object @@ -6504,28 +9939,28 @@ specify the QEMU interface emulation to use at run time. throws="1"> add a temporary scratch drive + line="1235">add a temporary scratch drive This command adds a temporary scratch drive to the handle. The @size parameter is the virtual size (in bytes). The scratch drive is blank initially (all reads return zeroes until you start writing to it). The drive is deleted when the handle is closed. -The optional arguments @name and @label are passed through to -guestfs_session_add_drive(). +The optional arguments @name, @label and @blocksize are passed through +to guestfs_session_add_drive_opts(). true on success, false on error + line="1252">true on success, false on error A GuestfsSession object + line="1237">A GuestfsSession object @@ -6537,7 +9972,7 @@ guestfs_session_add_drive(). allow-none="1"> a GuestfsAddDriveScratch containing optional arguments + line="1239">a GuestfsAddDriveScratch containing optional arguments @@ -6549,24 +9984,25 @@ guestfs_session_add_drive(). throws="1"> add a drive specifying the QEMU block emulation to use + line="1307">add a drive specifying the QEMU block emulation to use This is the same as guestfs_session_add_drive() but it allows you to -specify the QEMU interface emulation to use at run time. +specify the QEMU interface emulation to use at run time. Both the direct +and the libvirt backends ignore @iface. In new code, use guestfs_session_add_drive() instead true on success, false on error + line="1320">true on success, false on error A GuestfsSession object + line="1309">A GuestfsSession object @@ -6583,7 +10019,7 @@ specify the QEMU interface emulation to use at run time. throws="1"> add the disk(s) from a libvirt domain + line="1344">add the disk(s) from a libvirt domain This function adds the disk(s) attached to the libvirt domain @dom. It works by requesting the domain XML from libvirt, parsing it for disks, @@ -6601,20 +10037,20 @@ try to acquire the libvirt lock on each disk. Disks must be accessible locally. This often means that adding disks from a remote libvirt connection (see <ulink -url='http://libvirt.org/remote.html'> http://libvirt.org/remote.html +url='https://libvirt.org/remote.html'> http://libvirt.org/remote.html </ulink>) will fail unless those disks are accessible via the same device path locally too. -The optional @live flag controls whether this call will try to connect -to a running virtual machine @guestfsd process if it sees a suitable -&lt;channel&gt; element in the libvirt XML definition. The default (if -the flag is omitted) is never to try. See "ATTACHING TO RUNNING DAEMONS" -in guestfs(3) for more information. +The optional @live flag is ignored in libguestfs &ge; 1.48. The optional @readonlydisk parameter controls what we do for disks which are marked &lt;readonly/&gt; in the libvirt XML. See guestfs_session_add_domain() for possible values. +If present, the value of @logical_block_size attribute of +&lt;blockio/&gt; tag in libvirt XML will be passed as @blocksize +parameter to guestfs_session_add_drive_opts(). + The other optional parameters are passed directly through to guestfs_session_add_drive_opts(). the returned value, or -1 on error + line="1386">the returned value, or -1 on error A GuestfsSession object + line="1346">A GuestfsSession object allow-none="1"> pointer (not implemented in gobject bindings) + line="1347">pointer (not implemented in gobject bindings) allow-none="1"> a GuestfsAddLibvirtDom containing optional arguments + line="1348">a GuestfsAddLibvirtDom containing optional arguments @@ -6658,7 +10094,7 @@ guestfs_session_add_drive_opts(). throws="1"> clear Augeas path + line="1473">clear Augeas path Set the value associated with @path to @NULL. This is the same as the augtool(1) @clear command. @@ -6667,14 +10103,14 @@ augtool(1) @clear command. true on success, false on error + line="1484">true on success, false on error A GuestfsSession object + line="1475">A GuestfsSession object @@ -6688,7 +10124,7 @@ augtool(1) @clear command. throws="1"> close the current Augeas handle + line="1507">close the current Augeas handle Close the current Augeas handle and free up any resources used by it. After calling this, you have to call guestfs_session_aug_init() again @@ -6698,14 +10134,14 @@ before you can use any other Augeas functions. true on success, false on error + line="1518">true on success, false on error A GuestfsSession object + line="1509">A GuestfsSession object @@ -6716,13 +10152,13 @@ before you can use any other Augeas functions. throws="1"> define an Augeas node + line="1541">define an Augeas node Defines a variable @name whose value is the result of evaluating @expr. If @expr evaluates to an empty nodeset, a node is created, equivalent to -calling guestfs_session_aug_set() @expr, @value. @name will be the -nodeset containing that single node. +calling guestfs_session_aug_set() @expr, @val. @name will be the nodeset +containing that single node. On success this returns a pair containing the number of nodes in the nodeset, and a boolean flag if a node was created. @@ -6731,14 +10167,14 @@ nodeset, and a boolean flag if a node was created. a IntBool object, or NULL on error + line="1560">a IntBool object, or NULL on error A GuestfsSession object + line="1543">A GuestfsSession object @@ -6758,7 +10194,7 @@ nodeset, and a boolean flag if a node was created. throws="1"> define an Augeas variable + line="1587">define an Augeas variable Defines an Augeas variable @name whose value is the result of evaluating @expr. If @expr is NULL, then @name is undefined. @@ -6770,14 +10206,14 @@ evaluates to something which is not a nodeset. the returned value, or -1 on error + line="1602">the returned value, or -1 on error A GuestfsSession object + line="1589">A GuestfsSession object @@ -6797,7 +10233,7 @@ evaluates to something which is not a nodeset. throws="1"> look up the value of an Augeas path + line="1625">look up the value of an Augeas path Look up the value associated with @path. If @path matches exactly one node, the @value is returned. @@ -6806,14 +10242,14 @@ node, the @value is returned. the returned string, or NULL on error + line="1636">the returned string, or NULL on error A GuestfsSession object + line="1627">A GuestfsSession object @@ -6827,7 +10263,7 @@ node, the @value is returned. throws="1"> create a new Augeas handle + line="1659">create a new Augeas handle Create a new Augeas handle for editing configuration files. If there was any previous Augeas handle associated with this guestfs session, then it @@ -6873,14 +10309,14 @@ http://augeas.net/ </ulink>. true on success, false on error + line="1708">true on success, false on error A GuestfsSession object + line="1661">A GuestfsSession object @@ -6897,7 +10333,7 @@ http://augeas.net/ </ulink>. throws="1"> insert a sibling Augeas node + line="1731">insert a sibling Augeas node Create a new sibling @label for @path, inserting it into the tree before or after @path (depending on the boolean flag @before). @@ -6909,14 +10345,14 @@ be a label, ie. not contain /, "*" or end with a bracketed index "[N]". true on success, false on error + line="1747">true on success, false on error A GuestfsSession object + line="1733">A GuestfsSession object @@ -6936,7 +10372,7 @@ be a label, ie. not contain /, "*" or end with a bracketed index "[N]". throws="1"> return the label from an Augeas path expression + line="1770">return the label from an Augeas path expression The label (name of the last element) of the Augeas path expression @augpath is returned. @augpath must match exactly one node, else this @@ -6946,14 +10382,14 @@ function returns an error. the returned string, or NULL on error + line="1782">the returned string, or NULL on error A GuestfsSession object + line="1772">A GuestfsSession object @@ -6967,7 +10403,7 @@ function returns an error. throws="1"> load files into the tree + line="1805">load files into the tree Load files into the tree. @@ -6977,14 +10413,14 @@ See @aug_load in the Augeas documentation for the full gory details. true on success, false on error + line="1816">true on success, false on error A GuestfsSession object + line="1807">A GuestfsSession object @@ -6995,7 +10431,7 @@ See @aug_load in the Augeas documentation for the full gory details. throws="1"> list Augeas nodes under augpath + line="1839">list Augeas nodes under augpath This is just a shortcut for listing guestfs_session_aug_match() "path/*" and sorting the resulting nodes into alphabetical order. @@ -7004,7 +10440,7 @@ and sorting the resulting nodes into alphabetical order. an array of returned strings, or NULL on error + line="1850">an array of returned strings, or NULL on error @@ -7013,7 +10449,7 @@ and sorting the resulting nodes into alphabetical order. A GuestfsSession object + line="1841">A GuestfsSession object @@ -7027,7 +10463,7 @@ and sorting the resulting nodes into alphabetical order. throws="1"> return Augeas nodes which match augpath + line="1873">return Augeas nodes which match augpath Returns a list of paths which match the path expression @path. The returned paths are sufficiently qualified so that they match exactly one @@ -7037,7 +10473,7 @@ node in the current tree. an array of returned strings, or NULL on error + line="1885">an array of returned strings, or NULL on error @@ -7046,7 +10482,7 @@ node in the current tree. A GuestfsSession object + line="1875">A GuestfsSession object @@ -7060,7 +10496,7 @@ node in the current tree. throws="1"> move Augeas node + line="1908">move Augeas node Move the node @src to @dest. @src must match exactly one node. @dest is overwritten if it exists. @@ -7069,14 +10505,14 @@ overwritten if it exists. true on success, false on error + line="1920">true on success, false on error A GuestfsSession object + line="1910">A GuestfsSession object @@ -7093,7 +10529,7 @@ overwritten if it exists. throws="1"> remove an Augeas path + line="1943">remove an Augeas path Remove @path and all of its children. @@ -7103,14 +10539,14 @@ On success this returns the number of entries which were removed. the returned value, or -1 on error + line="1955">the returned value, or -1 on error A GuestfsSession object + line="1945">A GuestfsSession object @@ -7124,7 +10560,7 @@ On success this returns the number of entries which were removed. throws="1"> write all pending Augeas changes to disk + line="1978">write all pending Augeas changes to disk This writes all pending changes to disk. @@ -7135,14 +10571,14 @@ how files are saved. true on success, false on error + line="1990">true on success, false on error A GuestfsSession object + line="1980">A GuestfsSession object @@ -7153,9 +10589,9 @@ how files are saved. throws="1"> set Augeas path to value + line="2013">set Augeas path to value -Set the value associated with @path to @val. +Set the value associated with @augpath to @val. In the Augeas API, it is possible to clear a node by setting the value to NULL. Due to an oversight in the libguestfs API you cannot do that @@ -7166,14 +10602,14 @@ call. true on success, false on error + line="2029">true on success, false on error A GuestfsSession object + line="2015">A GuestfsSession object @@ -7190,7 +10626,7 @@ call. throws="1"> set multiple Augeas nodes + line="2052">set multiple Augeas nodes Change multiple Augeas nodes in a single operation. @base is an expression matching multiple nodes. @sub is a path expression relative @@ -7204,14 +10640,14 @@ This returns the number of nodes modified. the returned value, or -1 on error + line="2070">the returned value, or -1 on error A GuestfsSession object + line="2054">A GuestfsSession object @@ -7234,7 +10670,7 @@ This returns the number of nodes modified. throws="1"> add/remove an Augeas lens transformation + line="2093">add/remove an Augeas lens transformation Add an Augeas transformation for the specified @lens so it can handle @file. @@ -7246,14 +10682,14 @@ removed. true on success, false on error + line="2109">true on success, false on error A GuestfsSession object + line="2095">A GuestfsSession object @@ -7268,7 +10704,7 @@ removed. allow-none="1"> a GuestfsAugTransform containing optional arguments + line="2098">a GuestfsAugTransform containing optional arguments @@ -7279,7 +10715,7 @@ removed. throws="1"> test availability of some parts of the API + line="2148">test availability of some parts of the API This command is used to check the availability of some groups of functionality in the appliance, which not all builds of the libguestfs @@ -7332,20 +10768,20 @@ See also guestfs_session_filesystem_available(). true on success, false on error + line="2203">true on success, false on error A GuestfsSession object + line="2150">A GuestfsSession object an array of strings + line="2151">an array of strings @@ -7358,7 +10794,7 @@ See also guestfs_session_filesystem_available(). throws="1"> return a list of all optional groups + line="2226">return a list of all optional groups This command returns a list of all optional groups that this daemon knows about. Note this returns both supported and unsupported groups. To @@ -7373,7 +10809,7 @@ guestfs_session_feature_available() and "AVAILABILITY" in guestfs(3). an array of returned strings, or NULL on error + line="2242">an array of returned strings, or NULL on error @@ -7382,7 +10818,7 @@ guestfs_session_feature_available() and "AVAILABILITY" in guestfs(3). A GuestfsSession object + line="2228">A GuestfsSession object @@ -7393,7 +10829,7 @@ guestfs_session_feature_available() and "AVAILABILITY" in guestfs(3). throws="1"> upload base64-encoded data to file + line="2265">upload base64-encoded data to file This command uploads base64-encoded data from @base64file to filename. true on success, false on error + line="2277">true on success, false on error A GuestfsSession object + line="2267">A GuestfsSession object @@ -7423,7 +10859,7 @@ This command uploads base64-encoded data from @base64file to filename. allow-none="1"> A GCancellable object + line="2270">A GCancellable object @@ -7434,7 +10870,7 @@ This command uploads base64-encoded data from @base64file to filename. throws="1"> download file and encode as base64 + line="2312">download file and encode as base64 This command downloads the contents of filename, writing it out to local file @base64file encoded as base64. @@ -7443,14 +10879,14 @@ file @base64file encoded as base64. true on success, false on error + line="2325">true on success, false on error A GuestfsSession object + line="2314">A GuestfsSession object @@ -7465,7 +10901,7 @@ file @base64file encoded as base64. allow-none="1"> A GCancellable object + line="2317">A GCancellable object @@ -7476,7 +10912,7 @@ file @base64file encoded as base64. throws="1"> discard all blocks on a device + line="2360">discard all blocks on a device This discards all blocks on the block device @device, giving the free space back to the host. @@ -7494,14 +10930,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="2380">true on success, false on error A GuestfsSession object + line="2362">A GuestfsSession object @@ -7515,7 +10951,7 @@ See also guestfs_session_feature_available(). throws="1"> return true if discarded blocks are read as zeroes + line="2403">return true if discarded blocks are read as zeroes This call returns true if blocks on @device that have been discarded by a call to guestfs_session_blkdiscard() are returned as blocks of zero @@ -7531,14 +10967,14 @@ See also guestfs_session_feature_available(). the returned value, or -1 on error + line="2421">the returned value, or -1 on error A GuestfsSession object + line="2405">A GuestfsSession object @@ -7552,7 +10988,7 @@ See also guestfs_session_feature_available(). throws="1"> print block device attributes + line="2444">print block device attributes This command returns block device attributes for @device. The following fields are usually present in the returned hash. Other fields may also @@ -7577,7 +11013,7 @@ The usage of this device, for example @filesystem or @raid. a GHashTable of results, or NULL on error + line="2471">a GHashTable of results, or NULL on error @@ -7587,7 +11023,7 @@ The usage of this device, for example @filesystem or @raid. A GuestfsSession object + line="2446">A GuestfsSession object @@ -7601,7 +11037,7 @@ The usage of this device, for example @filesystem or @raid. throws="1"> flush device buffers + line="2502">flush device buffers This tells the kernel to flush internal buffers associated with @device. @@ -7611,14 +11047,14 @@ This uses the blockdev(8) command. true on success, false on error + line="2514">true on success, false on error A GuestfsSession object + line="2504">A GuestfsSession object @@ -7632,7 +11068,7 @@ This uses the blockdev(8) command. throws="1"> get blocksize of block device + line="2537">get blocksize of block device This returns the block size of a device. @@ -7647,14 +11083,14 @@ This uses the blockdev(8) command. the returned value, or -1 on error + line="2554">the returned value, or -1 on error A GuestfsSession object + line="2539">A GuestfsSession object @@ -7668,7 +11104,7 @@ This uses the blockdev(8) command. throws="1"> is block device set to read-only + line="2577">is block device set to read-only Returns a boolean indicating if the block device is read-only (true if read-only, false if not). @@ -7679,14 +11115,14 @@ This uses the blockdev(8) command. the returned value, or -1 on error + line="2590">the returned value, or -1 on error A GuestfsSession object + line="2579">A GuestfsSession object @@ -7700,7 +11136,7 @@ This uses the blockdev(8) command. throws="1"> get total size of device in bytes + line="2613">get total size of device in bytes This returns the size of the device in bytes. @@ -7712,14 +11148,14 @@ This uses the blockdev(8) command. the returned value, or -1 on error + line="2627">the returned value, or -1 on error A GuestfsSession object + line="2615">A GuestfsSession object @@ -7733,7 +11169,7 @@ This uses the blockdev(8) command. throws="1"> get sectorsize of block device + line="2650">get sectorsize of block device This returns the size of sectors on a block device. Usually 512, but can be larger for modern devices. @@ -7747,14 +11183,14 @@ This uses the blockdev(8) command. the returned value, or -1 on error + line="2666">the returned value, or -1 on error A GuestfsSession object + line="2652">A GuestfsSession object @@ -7768,7 +11204,7 @@ This uses the blockdev(8) command. throws="1"> get total size of device in 512-byte sectors + line="2689">get total size of device in 512-byte sectors This returns the size of the device in units of 512-byte sectors (even if the sectorsize isn't 512 bytes ... weird). @@ -7783,14 +11219,14 @@ This uses the blockdev(8) command. the returned value, or -1 on error + line="2706">the returned value, or -1 on error A GuestfsSession object + line="2691">A GuestfsSession object @@ -7804,7 +11240,7 @@ This uses the blockdev(8) command. throws="1"> reread partition table + line="2729">reread partition table Reread the partition table on @device. @@ -7814,14 +11250,14 @@ This uses the blockdev(8) command. true on success, false on error + line="2741">true on success, false on error A GuestfsSession object + line="2731">A GuestfsSession object @@ -7836,7 +11272,7 @@ This uses the blockdev(8) command. throws="1"> set blocksize of block device + line="2764">set blocksize of block device This call does nothing and has never done anything because of a bug in blockdev. Do not use it. @@ -7849,14 +11285,14 @@ of guestfs_session_mkfs(). true on success, false on error + line="2779">true on success, false on error A GuestfsSession object + line="2766">A GuestfsSession object @@ -7873,7 +11309,7 @@ of guestfs_session_mkfs(). throws="1"> set readahead + line="2803">set readahead Set readahead (in 512-byte sectors) for the device. @@ -7883,14 +11319,14 @@ This uses the blockdev(8) command. true on success, false on error + line="2816">true on success, false on error A GuestfsSession object + line="2805">A GuestfsSession object @@ -7907,7 +11343,7 @@ This uses the blockdev(8) command. throws="1"> set block device to read-only + line="2839">set block device to read-only Sets the block device named @device to read-only. @@ -7917,14 +11353,14 @@ This uses the blockdev(8) command. true on success, false on error + line="2851">true on success, false on error A GuestfsSession object + line="2841">A GuestfsSession object @@ -7938,7 +11374,7 @@ This uses the blockdev(8) command. throws="1"> set block device to read-write + line="2874">set block device to read-write Sets the block device named @device to read-write. @@ -7948,14 +11384,14 @@ This uses the blockdev(8) command. true on success, false on error + line="2886">true on success, false on error A GuestfsSession object + line="2876">A GuestfsSession object @@ -7969,7 +11405,7 @@ This uses the blockdev(8) command. throws="1"> cancel a running or paused balance + line="2909">cancel a running or paused balance Cancel a running balance on a btrfs filesystem. @@ -7980,14 +11416,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="2922">true on success, false on error A GuestfsSession object + line="2911">A GuestfsSession object @@ -8001,7 +11437,7 @@ See also guestfs_session_feature_available(). throws="1"> pause a running balance + line="2945">pause a running balance Pause a running balance on a btrfs filesystem. @@ -8012,14 +11448,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="2958">true on success, false on error A GuestfsSession object + line="2947">A GuestfsSession object @@ -8033,7 +11469,7 @@ See also guestfs_session_feature_available(). throws="1"> resume a paused balance + line="2981">resume a paused balance Resume a paused balance on a btrfs filesystem. @@ -8044,14 +11480,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="2994">true on success, false on error A GuestfsSession object + line="2983">A GuestfsSession object @@ -8065,7 +11501,7 @@ See also guestfs_session_feature_available(). throws="1"> show the status of a running or paused balance + line="3017">show the status of a running or paused balance Show the status of a running or paused balance on a btrfs filesystem. @@ -8076,14 +11512,14 @@ See also guestfs_session_feature_available(). a BTRFSBalance object, or NULL on error + line="3030">a BTRFSBalance object, or NULL on error A GuestfsSession object + line="3019">A GuestfsSession object @@ -8097,7 +11533,7 @@ See also guestfs_session_feature_available(). throws="1"> add devices to a btrfs filesystem + line="3060">add devices to a btrfs filesystem Add the list of device(s) in @devices to the btrfs filesystem mounted at @fs. If @devices is an empty list, this does nothing. @@ -8109,20 +11545,20 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3075">true on success, false on error A GuestfsSession object + line="3062">A GuestfsSession object an array of strings + line="3063">an array of strings @@ -8138,7 +11574,7 @@ See also guestfs_session_feature_available(). throws="1"> remove devices from a btrfs filesystem + line="3098">remove devices from a btrfs filesystem Remove the @devices from the btrfs filesystem mounted at @fs. If @devices is an empty list, this does nothing. @@ -8150,20 +11586,20 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3113">true on success, false on error A GuestfsSession object + line="3100">A GuestfsSession object an array of strings + line="3101">an array of strings @@ -8179,7 +11615,7 @@ See also guestfs_session_feature_available(). throws="1"> balance a btrfs filesystem + line="3136">balance a btrfs filesystem Balance the chunks in the btrfs filesystem mounted at @fs across the underlying devices. @@ -8191,14 +11627,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3150">true on success, false on error A GuestfsSession object + line="3138">A GuestfsSession object @@ -8212,7 +11648,7 @@ See also guestfs_session_feature_available(). throws="1"> defragment a file or directory + line="3173">defragment a file or directory Defragment a file or directory on a btrfs filesystem. compress is one of zlib or lzo. @@ -8224,14 +11660,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3188">true on success, false on error A GuestfsSession object + line="3175">A GuestfsSession object @@ -8243,7 +11679,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsBTRFSFilesystemDefragment containing optional arguments + line="3177">a GuestfsBTRFSFilesystemDefragment containing optional arguments @@ -8255,7 +11691,7 @@ See also guestfs_session_feature_available(). throws="1"> resize a btrfs filesystem + line="3235">resize a btrfs filesystem This command resizes a btrfs filesystem. @@ -8278,14 +11714,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3261">true on success, false on error A GuestfsSession object + line="3237">A GuestfsSession object @@ -8297,7 +11733,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsBTRFSFilesystemResize containing optional arguments + line="3239">a GuestfsBTRFSFilesystemResize containing optional arguments @@ -8309,7 +11745,7 @@ See also guestfs_session_feature_available(). throws="1"> list devices for btrfs filesystem + line="3300">list devices for btrfs filesystem Show all the devices where the filesystems in @device is spanned over. @@ -8323,7 +11759,7 @@ See also guestfs_session_feature_available(). an array of returned strings, or NULL on error + line="3316">an array of returned strings, or NULL on error @@ -8332,7 +11768,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="3302">A GuestfsSession object @@ -8346,7 +11782,7 @@ See also guestfs_session_feature_available(). throws="1"> sync a btrfs filesystem + line="3339">sync a btrfs filesystem Force sync on the btrfs filesystem mounted at @fs. @@ -8357,14 +11793,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3352">true on success, false on error A GuestfsSession object + line="3341">A GuestfsSession object @@ -8378,7 +11814,7 @@ See also guestfs_session_feature_available(). throws="1"> check a btrfs filesystem + line="3375">check a btrfs filesystem Used to check a btrfs filesystem, @device is the device file where the filesystem is stored. @@ -8390,14 +11826,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3390">true on success, false on error A GuestfsSession object + line="3377">A GuestfsSession object @@ -8409,7 +11845,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsBtrfsFsck containing optional arguments + line="3379">a GuestfsBtrfsFsck containing optional arguments @@ -8420,7 +11856,7 @@ See also guestfs_session_feature_available(). throws="1"> create an image of a btrfs filesystem + line="3437">create an image of a btrfs filesystem This is used to create an image of a btrfs filesystem. All data will be zeroed, but metadata and the like is preserved. @@ -8432,20 +11868,20 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3453">true on success, false on error A GuestfsSession object + line="3439">A GuestfsSession object an array of strings + line="3440">an array of strings @@ -8459,7 +11895,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsBTRFSImage containing optional arguments + line="3442">a GuestfsBTRFSImage containing optional arguments @@ -8470,7 +11906,7 @@ See also guestfs_session_feature_available(). throws="1"> add a qgroup to a parent qgroup + line="3492">add a qgroup to a parent qgroup Add qgroup @src to parent qgroup @dst. This command can group several qgroups into a parent qgroup to share common limit. @@ -8482,14 +11918,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3508">true on success, false on error A GuestfsSession object + line="3494">A GuestfsSession object @@ -8509,7 +11945,7 @@ See also guestfs_session_feature_available(). throws="1"> create a subvolume quota group + line="3531">create a subvolume quota group Create a quota group (qgroup) for subvolume at @subvolume. @@ -8520,14 +11956,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3545">true on success, false on error A GuestfsSession object + line="3533">A GuestfsSession object @@ -8544,7 +11980,7 @@ See also guestfs_session_feature_available(). throws="1"> destroy a subvolume quota group + line="3568">destroy a subvolume quota group Destroy a quota group. @@ -8555,14 +11991,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3582">true on success, false on error A GuestfsSession object + line="3570">A GuestfsSession object @@ -8579,7 +12015,7 @@ See also guestfs_session_feature_available(). throws="1"> limit the size of a subvolume + line="3605">limit the size of a subvolume Limit the size of the subvolume with path @subvolume. @@ -8590,14 +12026,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3619">true on success, false on error A GuestfsSession object + line="3607">A GuestfsSession object @@ -8614,7 +12050,7 @@ See also guestfs_session_feature_available(). throws="1"> remove a qgroup from its parent qgroup + line="3642">remove a qgroup from its parent qgroup Remove qgroup @src from the parent qgroup @dst. @@ -8625,14 +12061,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3657">true on success, false on error A GuestfsSession object + line="3644">A GuestfsSession object @@ -8652,7 +12088,7 @@ See also guestfs_session_feature_available(). throws="1"> show subvolume quota groups + line="3680">show subvolume quota groups Show all subvolume quota groups in a btrfs filesystem, including their usages. @@ -8664,7 +12100,7 @@ See also guestfs_session_feature_available(). an array of BTRFSQgroup objects, or NULL on error + line="3694">an array of BTRFSQgroup objects, or NULL on error @@ -8673,7 +12109,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="3682">A GuestfsSession object @@ -8687,7 +12123,7 @@ See also guestfs_session_feature_available(). throws="1"> enable or disable subvolume quota support + line="3727">enable or disable subvolume quota support Enable or disable subvolume quota support for filesystem which contains @path. @@ -8699,14 +12135,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3742">true on success, false on error A GuestfsSession object + line="3729">A GuestfsSession object @@ -8723,7 +12159,7 @@ See also guestfs_session_feature_available(). throws="1"> trash all qgroup numbers and scan the metadata again with the current config + line="3765">trash all qgroup numbers and scan the metadata again with the current config Trash all qgroup numbers and scan the metadata again with the current config. @@ -8735,14 +12171,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3779">true on success, false on error A GuestfsSession object + line="3767">A GuestfsSession object @@ -8756,7 +12192,7 @@ See also guestfs_session_feature_available(). throws="1"> replace a btrfs managed device with another device + line="3802">replace a btrfs managed device with another device Replace device of a btrfs filesystem. On a live filesystem, duplicate the data to the target device which is currently stored on the source @@ -8774,14 +12210,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3824">true on success, false on error A GuestfsSession object + line="3804">A GuestfsSession object @@ -8801,7 +12237,7 @@ See also guestfs_session_feature_available(). throws="1"> recover the chunk tree of btrfs filesystem + line="3847">recover the chunk tree of btrfs filesystem Recover the chunk tree of btrfs filesystem by scanning the devices one by one. @@ -8813,14 +12249,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3861">true on success, false on error A GuestfsSession object + line="3849">A GuestfsSession object @@ -8834,7 +12270,7 @@ See also guestfs_session_feature_available(). throws="1"> recover bad superblocks from good copies + line="3884">recover bad superblocks from good copies Recover bad superblocks from good copies. @@ -8845,14 +12281,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3897">true on success, false on error A GuestfsSession object + line="3886">A GuestfsSession object @@ -8866,7 +12302,7 @@ See also guestfs_session_feature_available(). throws="1"> cancel a running scrub + line="3920">cancel a running scrub Cancel a running scrub on a btrfs filesystem. @@ -8877,14 +12313,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3933">true on success, false on error A GuestfsSession object + line="3922">A GuestfsSession object @@ -8898,7 +12334,7 @@ See also guestfs_session_feature_available(). throws="1"> resume a previously canceled or interrupted scrub + line="3956">resume a previously canceled or interrupted scrub Resume a previously canceled or interrupted scrub on a btrfs filesystem. @@ -8909,14 +12345,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="3969">true on success, false on error A GuestfsSession object + line="3958">A GuestfsSession object @@ -8930,7 +12366,7 @@ See also guestfs_session_feature_available(). throws="1"> read all data from all disks and verify checksums + line="3992">read all data from all disks and verify checksums Reads all the data and metadata on the filesystem, and uses checksums and the duplicate copies from RAID storage to identify and repair any @@ -8943,14 +12379,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="4007">true on success, false on error A GuestfsSession object + line="3994">A GuestfsSession object @@ -8964,7 +12400,7 @@ See also guestfs_session_feature_available(). throws="1"> show status of running or finished scrub + line="4030">show status of running or finished scrub Show status of running or finished scrub on a btrfs filesystem. @@ -8975,14 +12411,14 @@ See also guestfs_session_feature_available(). a BTRFSScrub object, or NULL on error + line="4043">a BTRFSScrub object, or NULL on error A GuestfsSession object + line="4032">A GuestfsSession object @@ -8996,7 +12432,7 @@ See also guestfs_session_feature_available(). throws="1"> enable or disable the seeding feature of device + line="4083">enable or disable the seeding feature of device Enable or disable the seeding feature of a device that contains a btrfs filesystem. @@ -9008,14 +12444,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="4098">true on success, false on error A GuestfsSession object + line="4085">A GuestfsSession object @@ -9032,7 +12468,7 @@ See also guestfs_session_feature_available(). throws="1"> create a btrfs subvolume + line="4121">create a btrfs subvolume Create a btrfs subvolume. The @dest argument is the destination directory and the name of the subvolume, in the form /path/to/dest/name. @@ -9046,14 +12482,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="4138">true on success, false on error A GuestfsSession object + line="4123">A GuestfsSession object @@ -9065,7 +12501,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsBTRFSSubvolumeCreate containing optional arguments + line="4125">a GuestfsBTRFSSubvolumeCreate containing optional arguments @@ -9077,7 +12513,7 @@ See also guestfs_session_feature_available(). throws="1"> delete a btrfs subvolume or snapshot + line="4177">delete a btrfs subvolume or snapshot Delete the named btrfs subvolume or snapshot. @@ -9088,14 +12524,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="4190">true on success, false on error A GuestfsSession object + line="4179">A GuestfsSession object @@ -9109,7 +12545,7 @@ See also guestfs_session_feature_available(). throws="1"> get the default subvolume or snapshot of a filesystem + line="4213">get the default subvolume or snapshot of a filesystem Get the default subvolume or snapshot of a filesystem mounted at @mountpoint. @@ -9121,14 +12557,14 @@ See also guestfs_session_feature_available(). the returned value, or -1 on error + line="4227">the returned value, or -1 on error A GuestfsSession object + line="4215">A GuestfsSession object @@ -9142,7 +12578,7 @@ See also guestfs_session_feature_available(). throws="1"> list btrfs snapshots and subvolumes + line="4250">list btrfs snapshots and subvolumes List the btrfs snapshots and subvolumes of the btrfs filesystem which is mounted at @fs. @@ -9154,7 +12590,7 @@ See also guestfs_session_feature_available(). an array of BTRFSSubvolume objects, or NULL on error + line="4264">an array of BTRFSSubvolume objects, or NULL on error @@ -9163,7 +12599,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="4252">A GuestfsSession object @@ -9177,7 +12613,7 @@ See also guestfs_session_feature_available(). throws="1"> set default btrfs subvolume + line="4297">set default btrfs subvolume Set the subvolume of the btrfs filesystem @fs which will be mounted by default. See guestfs_session_btrfs_subvolume_list() to get a list of @@ -9190,14 +12626,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="4313">true on success, false on error A GuestfsSession object + line="4299">A GuestfsSession object @@ -9214,7 +12650,7 @@ See also guestfs_session_feature_available(). throws="1"> return detailed information of the subvolume + line="4336">return detailed information of the subvolume Return detailed information of the subvolume. @@ -9225,7 +12661,7 @@ See also guestfs_session_feature_available(). a GHashTable of results, or NULL on error + line="4349">a GHashTable of results, or NULL on error @@ -9235,7 +12671,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="4338">A GuestfsSession object @@ -9249,7 +12685,7 @@ See also guestfs_session_feature_available(). throws="1"> create a btrfs snapshot + line="4380">create a btrfs snapshot Create a snapshot of the btrfs subvolume @source. The @dest argument is the destination directory and the name of the snapshot, in the form @@ -9265,14 +12701,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="4400">true on success, false on error A GuestfsSession object + line="4382">A GuestfsSession object @@ -9287,7 +12723,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsBTRFSSubvolumeSnapshot containing optional arguments + line="4385">a GuestfsBTRFSSubvolumeSnapshot containing optional arguments @@ -9299,7 +12735,7 @@ See also guestfs_session_feature_available(). throws="1"> enable extended inode refs + line="4447">enable extended inode refs This will Enable extended inode refs. @@ -9310,14 +12746,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="4460">true on success, false on error A GuestfsSession object + line="4449">A GuestfsSession object @@ -9331,7 +12767,7 @@ See also guestfs_session_feature_available(). throws="1"> enable skinny metadata extent refs + line="4483">enable skinny metadata extent refs This enable skinny metadata extent refs. @@ -9342,14 +12778,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="4496">true on success, false on error A GuestfsSession object + line="4485">A GuestfsSession object @@ -9363,7 +12799,7 @@ See also guestfs_session_feature_available(). throws="1"> enable or disable seeding of a btrfs device + line="4519">enable or disable seeding of a btrfs device Enable seeding of a btrfs device, this will force a fs readonly so that you can use it to build other filesystems. @@ -9375,14 +12811,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="4534">true on success, false on error A GuestfsSession object + line="4521">A GuestfsSession object @@ -9399,7 +12835,7 @@ See also guestfs_session_feature_available(). throws="1"> return the C pointer to the guestfs_h handle + line="4557">return the C pointer to the guestfs_h handle In non-C language bindings, this allows you to retrieve the underlying C pointer to the handle (ie. "guestfs_h *"). The purpose of this is to @@ -9409,14 +12845,14 @@ allow other libraries to interwork with libguestfs. the returned value, or -1 on error + line="4568">the returned value, or -1 on error A GuestfsSession object + line="4559">A GuestfsSession object @@ -9427,7 +12863,7 @@ allow other libraries to interwork with libguestfs. throws="1"> return canonical device name + line="4591">return canonical device name This utility function is useful when displaying device names to the user. It takes a number of irregular device names and returns them in a @@ -9450,14 +12886,14 @@ Other strings are returned unmodified. the returned string, or NULL on error + line="4616">the returned string, or NULL on error A GuestfsSession object + line="4593">A GuestfsSession object @@ -9471,7 +12907,7 @@ Other strings are returned unmodified. throws="1"> get the Linux capabilities attached to a file + line="4639">get the Linux capabilities attached to a file This function returns the Linux capabilities attached to @path. The capabilities set is returned in text form (see cap_to_text(3)). @@ -9485,14 +12921,14 @@ See also guestfs_session_feature_available(). the returned string, or NULL on error + line="4655">the returned string, or NULL on error A GuestfsSession object + line="4641">A GuestfsSession object @@ -9506,7 +12942,7 @@ See also guestfs_session_feature_available(). throws="1"> set the Linux capabilities attached to a file + line="4678">set the Linux capabilities attached to a file This function sets the Linux capabilities attached to @path. The capabilities set @cap should be passed in text form (see @@ -9519,14 +12955,14 @@ See also guestfs_session_feature_available(). true on success, false on error + line="4694">true on success, false on error A GuestfsSession object + line="4680">A GuestfsSession object @@ -9543,7 +12979,7 @@ See also guestfs_session_feature_available(). throws="1"> return true path on case-insensitive filesystem + line="4717">return true path on case-insensitive filesystem This can be used to resolve case insensitive paths on a filesystem which is case sensitive. The use case is to resolve paths which you have read @@ -9561,7 +12997,7 @@ precise details of how they were created. In Windows itself this would not be a problem. Bug or feature? You decide: <ulink -url='http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1'> +url='https://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1'> http://www.tuxera.com/community/ntfs-3g-faq/#posixfilenames1 </ulink> guestfs_session_case_sensitive_path() attempts to resolve the true case @@ -9592,14 +13028,14 @@ See also guestfs_session_realpath(). the returned string, or NULL on error + line="4768">the returned string, or NULL on error A GuestfsSession object + line="4719">A GuestfsSession object @@ -9613,7 +13049,7 @@ See also guestfs_session_realpath(). throws="1"> list the contents of a file + line="4791">list the contents of a file Return the contents of the file named @path. @@ -9626,14 +13062,14 @@ guestfs_session_download() functions. the returned string, or NULL on error + line="4806">the returned string, or NULL on error A GuestfsSession object + line="4793">A GuestfsSession object @@ -9647,7 +13083,7 @@ guestfs_session_download() functions. throws="1"> compute MD5, SHAx or CRC checksum of file + line="4829">compute MD5, SHAx or CRC checksum of file This call computes the MD5, SHAx or CRC checksum of the file named @path. @@ -9660,22 +13096,22 @@ Compute the cyclic redundancy check (CRC) specified by POSIX for the @cksum command. @md5 -Compute the MD5 hash (using the @md5sum program). +Compute the MD5 hash (using the md5sum(1) program). @sha1 -Compute the SHA1 hash (using the @sha1sum program). +Compute the SHA1 hash (using the sha1sum(1) program). @sha224 -Compute the SHA224 hash (using the @sha224sum program). +Compute the SHA224 hash (using the sha224sum(1) program). @sha256 -Compute the SHA256 hash (using the @sha256sum program). +Compute the SHA256 hash (using the sha256sum(1) program). @sha384 -Compute the SHA384 hash (using the @sha384sum program). +Compute the SHA384 hash (using the sha384sum(1) program). @sha512 -Compute the SHA512 hash (using the @sha512sum program). +Compute the SHA512 hash (using the sha512sum(1) program). The checksum is returned as a printable string. @@ -9688,14 +13124,14 @@ guestfs_session_checksums_out(). the returned string, or NULL on error + line="4873">the returned string, or NULL on error A GuestfsSession object + line="4831">A GuestfsSession object @@ -9712,7 +13148,7 @@ guestfs_session_checksums_out(). throws="1"> compute MD5, SHAx or CRC checksum of the contents of a device + line="4896">compute MD5, SHAx or CRC checksum of the contents of a device This call computes the MD5, SHAx or CRC checksum of the contents of the device named @device. For the types of checksums supported see the @@ -9722,14 +13158,14 @@ guestfs_session_checksum() command. the returned string, or NULL on error + line="4909">the returned string, or NULL on error A GuestfsSession object + line="4898">A GuestfsSession object @@ -9746,7 +13182,7 @@ guestfs_session_checksum() command. throws="1"> compute MD5, SHAx or CRC checksum of files in a directory + line="4932">compute MD5, SHAx or CRC checksum of files in a directory This command computes the checksums of all regular files in directory and then emits a list of those checksums to the local output file @@ -9762,14 +13198,14 @@ backslash syntax. For more information, see the GNU coreutils info file. true on success, false on error + line="4953">true on success, false on error A GuestfsSession object + line="4934">A GuestfsSession object @@ -9787,7 +13223,7 @@ backslash syntax. For more information, see the GNU coreutils info file. allow-none="1"> A GCancellable object + line="4938">A GCancellable object @@ -9798,7 +13234,7 @@ backslash syntax. For more information, see the GNU coreutils info file. throws="1"> change file mode + line="4988">change file mode Change the mode (permissions) of @path to @mode. Only numeric modes are supported. @@ -9813,14 +13249,14 @@ The mode actually set is affected by the umask. true on success, false on error + line="5006">true on success, false on error A GuestfsSession object + line="4990">A GuestfsSession object @@ -9837,7 +13273,7 @@ The mode actually set is affected by the umask. throws="1"> change file owner and group + line="5029">change file owner and group Change the file owner to @owner and group to @group. @@ -9849,14 +13285,14 @@ makes this relatively easy). true on success, false on error + line="5045">true on success, false on error A GuestfsSession object + line="5031">A GuestfsSession object @@ -9876,7 +13312,7 @@ makes this relatively easy). throws="1"> remove a single per-backend settings string + line="5068">remove a single per-backend settings string If there is a backend setting string matching "name" or beginning with "name=", then that string is removed from the backend settings. @@ -9890,14 +13326,14 @@ See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). the returned value, or -1 on error + line="5084">the returned value, or -1 on error A GuestfsSession object + line="5070">A GuestfsSession object @@ -9905,23 +13341,87 @@ See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). + + open an encrypted LUKS block device with Clevis and Tang + +This command opens a block device that has been encrypted according to +the Linux Unified Key Setup (LUKS) standard, using network-bound disk +encryption (NBDE). + +@device is the encrypted block device. + +The appliance will connect to the Tang servers noted in the tree of +Clevis pins that is bound to a keyslot of the LUKS header. The Clevis +pin tree may comprise @sss (redudancy) pins as internal nodes +(optionally), and @tang pins as leaves. @tpm2 pins are not supported. +The appliance unlocks the encrypted block device by combining responses +from the Tang servers with metadata from the LUKS header; there is no +@key parameter. + +This command will fail if networking has not been enabled for the +appliance. Refer to guestfs_session_set_network(). + +The command creates a new block device called /dev/mapper/mapname. Reads +and writes to this block device are decrypted from and encrypted to the +underlying @device respectively. Close the decrypted block device with +guestfs_session_cryptsetup_close(). + +@mapname cannot be "control" because that name is reserved by +device-mapper. + +If this block device contains LVM volume groups, then calling +guestfs_session_lvm_scan() with the @activate parameter @true will make +them visible. + +Use guestfs_session_list_dm_devices() to list all device mapper devices. + +This function depends on the feature "clevisluks". +See also guestfs_session_feature_available(). + + + true on success, false on error + + + + + A GuestfsSession object + + + + + + + + + + Close a libguestfs session. + line="396">Close a libguestfs session. true on success, false on error + line="403">true on success, false on error A GuestfsSession object + line="398">A GuestfsSession object @@ -9932,7 +13432,7 @@ See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). throws="1"> run a command from the guest filesystem + line="5173">run a command from the guest filesystem This call runs a command from the guest filesystem. The filesystem must be mounted, and must contain a compatible operating system (ie. @@ -9959,24 +13459,24 @@ available on filesystems which are mounted in the correct places. It is the caller’s responsibility to ensure all filesystems that are needed are mounted at the right locations. + line="229"/> the returned string, or NULL on error + line="5206">the returned string, or NULL on error A GuestfsSession object + line="5175">A GuestfsSession object an array of strings + line="5176">an array of strings @@ -9989,18 +13489,18 @@ are mounted at the right locations. throws="1"> run a command, returning lines + line="5229">run a command, returning lines This is the same as guestfs_session_command(), but splits the result into a list of lines. See also: guestfs_session_sh_lines() + line="230"/> an array of returned strings, or NULL on error + line="5242">an array of returned strings, or NULL on error @@ -10009,13 +13509,13 @@ See also: guestfs_session_sh_lines() A GuestfsSession object + line="5231">A GuestfsSession object an array of strings + line="5232">an array of strings @@ -10028,7 +13528,7 @@ See also: guestfs_session_sh_lines() throws="1"> output compressed device + line="5265">output compressed device This command compresses @device and writes it out to the local file @zdevice. @@ -10036,18 +13536,18 @@ This command compresses @device and writes it out to the local file The @ctype and optional @level parameters have the same meaning as in guestfs_session_compress_out(). + line="231"/> true on success, false on error + line="5283">true on success, false on error A GuestfsSession object + line="5267">A GuestfsSession object @@ -10065,7 +13565,7 @@ guestfs_session_compress_out(). allow-none="1"> a GuestfsCompressDeviceOut containing optional arguments + line="5271">a GuestfsCompressDeviceOut containing optional arguments allow-none="1"> A GCancellable object + line="5272">A GCancellable object @@ -10085,7 +13585,7 @@ guestfs_session_compress_out(). throws="1"> output compressed file + line="5334">output compressed file This command compresses file and writes it out to the local file zfile. @@ -10099,18 +13599,18 @@ The optional @level parameter controls compression level. The meaning and default for this parameter depends on the compression program being used. + line="232"/> true on success, false on error + line="5358">true on success, false on error A GuestfsSession object + line="5336">A GuestfsSession object @@ -10128,7 +13628,7 @@ used. allow-none="1"> a GuestfsCompressOut containing optional arguments + line="5340">a GuestfsCompressOut containing optional arguments allow-none="1"> A GCancellable object + line="5341">A GCancellable object @@ -10148,7 +13648,7 @@ used. throws="1"> add hypervisor parameters + line="5409">add hypervisor parameters This can be used to add arbitrary hypervisor parameters of the form *-param value*. Actually it’s not quite arbitrary - we prevent you from @@ -10159,18 +13659,18 @@ The first character of @hvparam string must be a @- (dash). @hvvalue can be NULL. + line="233"/> true on success, false on error + line="5427">true on success, false on error A GuestfsSession object + line="5411">A GuestfsSession object @@ -10190,12 +13690,12 @@ The first character of @hvparam string must be a @- (dash). throws="1"> copy the attributes of a path (file/directory) to another + line="5450">copy the attributes of a path (file/directory) to another Copy the attributes of a path (which can be a file or a directory) to another path. -By default @no attribute is copied, so make sure to specify any (or @all +By default no attribute is copied, so make sure to specify any (or @all to copy everything). The optional arguments specify which attributes can be copied: @@ -10216,18 +13716,18 @@ Copy the owner uid and the group gid of @source to @destination. Copy all the attributes from @source to @destination. Enabling it enables all the other flags, if they are not specified already. + line="234"/> true on success, false on error + line="5484">true on success, false on error A GuestfsSession object + line="5452">A GuestfsSession object @@ -10242,7 +13742,7 @@ enables all the other flags, if they are not specified already. allow-none="1"> a GuestfsCopyAttributes containing optional arguments + line="5455">a GuestfsCopyAttributes containing optional arguments @@ -10253,7 +13753,7 @@ enables all the other flags, if they are not specified already. throws="1"> copy from source device to destination device + line="5547">copy from source device to destination device The four calls guestfs_session_copy_device_to_device(), guestfs_session_copy_device_to_file(), @@ -10283,18 +13783,18 @@ contain only zeroes, which can help in some situations where the backing disk is thin-provisioned. Note that unless the target is already zeroed, using this option will result in incorrect copying. + line="235"/> true on success, false on error + line="5585">true on success, false on error A GuestfsSession object + line="5549">A GuestfsSession object @@ -10309,7 +13809,7 @@ using this option will result in incorrect copying. allow-none="1"> a GuestfsCopyDeviceToDevice containing optional arguments + line="5552">a GuestfsCopyDeviceToDevice containing optional arguments @@ -10321,23 +13821,23 @@ using this option will result in incorrect copying. throws="1"> copy from source device to destination file + line="5656">copy from source device to destination file See guestfs_session_copy_device_to_device() for a general overview of this call. + line="236"/> true on success, false on error + line="5669">true on success, false on error A GuestfsSession object + line="5658">A GuestfsSession object @@ -10352,7 +13852,7 @@ this call. allow-none="1"> a GuestfsCopyDeviceToFile containing optional arguments + line="5661">a GuestfsCopyDeviceToFile containing optional arguments @@ -10363,23 +13863,23 @@ this call. throws="1"> copy from source file to destination device + line="5740">copy from source file to destination device See guestfs_session_copy_device_to_device() for a general overview of this call. + line="237"/> true on success, false on error + line="5753">true on success, false on error A GuestfsSession object + line="5742">A GuestfsSession object @@ -10394,7 +13894,7 @@ this call. allow-none="1"> a GuestfsCopyFileToDevice containing optional arguments + line="5745">a GuestfsCopyFileToDevice containing optional arguments @@ -10405,7 +13905,7 @@ this call. throws="1"> copy from source file to destination file + line="5824">copy from source file to destination file See guestfs_session_copy_device_to_device() for a general overview of this call. @@ -10415,18 +13915,18 @@ blocks within existing files. See guestfs_session_cp(), guestfs_session_cp_a() and guestfs_session_mv() for general file copying and moving functions. + line="238"/> true on success, false on error + line="5842">true on success, false on error A GuestfsSession object + line="5826">A GuestfsSession object @@ -10441,7 +13941,7 @@ and moving functions. allow-none="1"> a GuestfsCopyFileToFile containing optional arguments + line="5829">a GuestfsCopyFileToFile containing optional arguments @@ -10452,7 +13952,7 @@ and moving functions. throws="1"> copy local files or directories into an image + line="5913">copy local files or directories into an image guestfs_session_copy_in() copies local files or directories recursively into the disk image, placing them in the directory called @remotedir @@ -10460,18 +13960,18 @@ into the disk image, placing them in the directory called @remotedir Wildcards cannot be used. + line="239"/> true on success, false on error + line="5928">true on success, false on error A GuestfsSession object + line="5915">A GuestfsSession object @@ -10488,7 +13988,7 @@ Wildcards cannot be used. throws="1"> copy remote files or directories out of an image + line="5951">copy remote files or directories out of an image guestfs_session_copy_out() copies remote files or directories recursively out of the disk image, placing them on the host disk in a @@ -10500,18 +14000,18 @@ To download to the current directory, use "." as in: Wildcards cannot be used. + line="240"/> true on success, false on error + line="5970">true on success, false on error A GuestfsSession object + line="5953">A GuestfsSession object @@ -10529,7 +14029,7 @@ Wildcards cannot be used. throws="1"> copy size bytes from source to destination using dd + line="5993">copy size bytes from source to destination using dd This command copies exactly @size bytes from one source device or file @src to another destination device or file @dest. @@ -10538,18 +14038,18 @@ Note this will fail if the source is too short or if the destination is not large enough. In new code, use guestfs_session_copy_device_to_device() instead + line="241"/> true on success, false on error + line="6009">true on success, false on error A GuestfsSession object + line="5995">A GuestfsSession object @@ -10569,23 +14069,23 @@ not large enough. throws="1"> copy a file + line="6033">copy a file This copies a file from @src to @dest where @dest is either a destination filename or destination directory. + line="242"/> true on success, false on error + line="6045">true on success, false on error A GuestfsSession object + line="6035">A GuestfsSession object @@ -10602,23 +14102,23 @@ destination filename or destination directory. throws="1"> copy a file or directory recursively + line="6068">copy a file or directory recursively This copies a file or directory from @src to @dest recursively using the "cp -a" command. + line="243"/> true on success, false on error + line="6080">true on success, false on error A GuestfsSession object + line="6070">A GuestfsSession object @@ -10635,7 +14135,7 @@ This copies a file or directory from @src to @dest recursively using the throws="1"> copy a file or directory recursively + line="6103">copy a file or directory recursively This copies a file or directory from @src to @dest recursively using the "cp -rP" command. @@ -10645,18 +14145,18 @@ useful when you don't want to preserve permissions, because the target filesystem does not support it (primarily when writing to DOS FAT filesystems). + line="244"/> true on success, false on error + line="6120">true on success, false on error A GuestfsSession object + line="6105">A GuestfsSession object @@ -10673,7 +14173,7 @@ filesystems). throws="1"> pack directory into cpio file + line="6143">pack directory into cpio file This command packs the contents of directory and downloads it to local file @cpiofile. @@ -10690,25 +14190,149 @@ This is the default format. @crc New (SVR4) portable format with a checksum. + line="245"/> true on success, false on error + line="6169">true on success, false on error A GuestfsSession object + line="6145">A GuestfsSession object - - + + + + + a GuestfsCpioOut containing optional arguments + + + + A GCancellable object + + + + + + close an encrypted device + +This closes an encrypted device that was created earlier by +guestfs_session_cryptsetup_open(). The @device parameter must be the +name of the mapping device (ie. /dev/mapper/mapname) and *not* the name +of the underlying block device. + +This function depends on the feature "luks". +See also guestfs_session_feature_available(). + + + true on success, false on error + + + + + A GuestfsSession object + + + + + + + + + open an encrypted block device + +This command opens a block device which has been encrypted according to +the Linux Unified Key Setup (LUKS) standard, Windows BitLocker, or some +other types. + +@device is the encrypted block device or partition. + +The caller must supply one of the keys associated with the encrypted +block device, in the @key parameter. + +This creates a new block device called /dev/mapper/mapname. Reads and +writes to this block device are decrypted from and encrypted to the +underlying @device respectively. + +@mapname cannot be "control" because that name is reserved by +device-mapper. + +If the optional @crypttype parameter is not present then libguestfs +tries to guess the correct type (for example LUKS or BitLocker). However +you can override this by specifying one of the following types: + +@luks +A Linux LUKS device. + +@bitlk +A Windows BitLocker device. + +The optional @readonly flag, if set to true, creates a read-only +mapping. + +If this block device contains LVM volume groups, then calling +guestfs_session_lvm_scan() with the @activate parameter @true will make +them visible. + +Use guestfs_session_list_dm_devices() to list all device mapper devices. + +This function depends on the feature "luks". +See also guestfs_session_feature_available(). + + + true on success, false on error + + + + + A GuestfsSession object + + + + + + + + + + allow-none="1"> a GuestfsCpioOut containing optional arguments - - - - A GCancellable object - + line="6265">a GuestfsCryptsetupOpen containing optional arguments + @@ -10737,7 +14352,7 @@ New (SVR4) portable format with a checksum. throws="1"> copy from source to destination using dd + line="6355">copy from source to destination using dd This command copies from one source device or file @src to another destination device or file @dest. Normally you would use this to copy to @@ -10748,18 +14363,18 @@ source file or device, otherwise the copy will fail. This command cannot do partial copies (see guestfs_session_copy_device_to_device()). In new code, use guestfs_session_copy_device_to_device() instead + line="248"/> true on success, false on error + line="6372">true on success, false on error A GuestfsSession object + line="6357">A GuestfsSession object @@ -10776,7 +14391,7 @@ do partial copies (see guestfs_session_copy_device_to_device()). throws="1"> debugging and internals + line="6396">debugging and internals The guestfs_session_debug() command exposes some internals of @guestfsd (the guestfs daemon) that runs inside the hypervisor. @@ -10785,18 +14400,18 @@ There is no comprehensive help for this command. You have to look at the file daemon/debug.c in the libguestfs source to find out what you can do. + line="249"/> the returned string, or NULL on error + line="6412">the returned string, or NULL on error A GuestfsSession object + line="6398">A GuestfsSession object @@ -10805,7 +14420,7 @@ do. an array of strings + line="6400">an array of strings @@ -10818,16 +14433,16 @@ do. throws="1"> debug the drives (internal use only) + line="6435">debug the drives (internal use only) This returns the internal list of drives. ‘debug’ commands are not part of the formal API and can be removed or changed at any time. + line="250"/> an array of returned strings, or NULL on error + line="6445">an array of returned strings, or NULL on error @@ -10836,7 +14451,7 @@ of the formal API and can be removed or changed at any time. A GuestfsSession object + line="6437">A GuestfsSession object @@ -10847,7 +14462,7 @@ of the formal API and can be removed or changed at any time. throws="1"> upload a file to the appliance (internal use only) + line="6468">upload a file to the appliance (internal use only) The guestfs_session_debug_upload() command uploads a file to the libguestfs appliance. @@ -10855,18 +14470,18 @@ libguestfs appliance. There is no comprehensive help for this command. You have to look at the file daemon/debug.c in the libguestfs source to find out what it is for. + line="251"/> true on success, false on error + line="6485">true on success, false on error A GuestfsSession object + line="6470">A GuestfsSession object @@ -10884,7 +14499,7 @@ file daemon/debug.c in the libguestfs source to find out what it is for. allow-none="1"> A GCancellable object + line="6474">A GCancellable object @@ -10895,7 +14510,7 @@ file daemon/debug.c in the libguestfs source to find out what it is for. throws="1"> convert device to index + line="6520">convert device to index This function takes a device name (eg. "/dev/sdb") and returns the index of the device in the list of devices. @@ -10903,20 +14518,21 @@ of the device in the list of devices. Index numbers start from 0. The named device must exist, for example as a string returned from guestfs_session_list_devices(). -See also guestfs_session_list_devices(), guestfs_session_part_to_dev(). +See also guestfs_session_list_devices(), guestfs_session_part_to_dev(), +guestfs_session_device_name(). + line="252"/> the returned value, or -1 on error + line="6537">the returned value, or -1 on error A GuestfsSession object + line="6522">A GuestfsSession object @@ -10924,32 +14540,67 @@ See also guestfs_session_list_devices(), guestfs_session_part_to_dev(). + + convert device index to name + +This function takes a device index and returns the device name. For +example index @0 will return the string "/dev/sda". + +The drive index must have been added to the handle. + +See also guestfs_session_list_devices(), guestfs_session_part_to_dev(), +guestfs_session_device_index(). + + + the returned string, or NULL on error + + + + + A GuestfsSession object + + + + + + + report file system disk space usage + line="6599">report file system disk space usage -This command runs the @df command to report disk space used. +This command runs the df(1) command to report disk space used. This command is mostly useful for interactive sessions. It is *not* intended that you try to parse the output string. Use guestfs_session_statvfs() from programs. + line="254"/> the returned string, or NULL on error + line="6612">the returned string, or NULL on error A GuestfsSession object + line="6601">A GuestfsSession object @@ -10960,7 +14611,7 @@ guestfs_session_statvfs() from programs. throws="1"> report file system disk space usage (human readable) + line="6635">report file system disk space usage (human readable) This command runs the "df -h" command to report disk space used in human-readable format. @@ -10969,18 +14620,18 @@ This command is mostly useful for interactive sessions. It is *not* intended that you try to parse the output string. Use guestfs_session_statvfs() from programs. + line="255"/> the returned string, or NULL on error + line="6649">the returned string, or NULL on error A GuestfsSession object + line="6637">A GuestfsSession object @@ -10991,7 +14642,7 @@ guestfs_session_statvfs() from programs. throws="1"> create a blank disk image + line="6672">create a blank disk image Create a blank disk image called filename (a host file) with format @format (usually @raw or @qcow2). The size is @size bytes. @@ -11028,18 +14679,18 @@ supported by qemu &ge; 1.1. Note that this call does not add the new disk to the handle. You may need to call guestfs_session_add_drive_opts() separately. + line="256"/> true on success, false on error + line="6718">true on success, false on error A GuestfsSession object + line="6674">A GuestfsSession object @@ -11057,7 +14708,7 @@ need to call guestfs_session_add_drive_opts() separately. allow-none="1"> a GuestfsDiskCreate containing optional arguments + line="6678">a GuestfsDiskCreate containing optional arguments @@ -11068,7 +14719,7 @@ need to call guestfs_session_add_drive_opts() separately. throws="1"> detect the disk format of a disk image + line="6789">detect the disk format of a disk image Detect and return the format of the disk image called filename. filename can also be a host device, etc. If the format of the image could not be @@ -11079,18 +14730,18 @@ circumstances. See "CVE-2010-3851" in guestfs(3). See also: "DISK IMAGE FORMATS" in guestfs(3) + line="257"/> the returned string, or NULL on error + line="6806">the returned string, or NULL on error A GuestfsSession object + line="6791">A GuestfsSession object @@ -11104,25 +14755,25 @@ See also: "DISK IMAGE FORMATS" in guestfs(3) throws="1"> return whether disk has a backing file + line="6829">return whether disk has a backing file Detect and return whether the disk image filename has a backing file. Note that detecting disk features can be insecure under some circumstances. See "CVE-2010-3851" in guestfs(3). + line="258"/> the returned value, or -1 on error + line="6842">the returned value, or -1 on error A GuestfsSession object + line="6831">A GuestfsSession object @@ -11136,7 +14787,7 @@ circumstances. See "CVE-2010-3851" in guestfs(3). throws="1"> return virtual size of a disk + line="6865">return virtual size of a disk Detect and return the virtual size in bytes of the disk image called filename. @@ -11144,18 +14795,18 @@ filename. Note that detecting disk features can be insecure under some circumstances. See "CVE-2010-3851" in guestfs(3). + line="259"/> the returned value, or -1 on error + line="6879">the returned value, or -1 on error A GuestfsSession object + line="6867">A GuestfsSession object @@ -11169,27 +14820,27 @@ circumstances. See "CVE-2010-3851" in guestfs(3). throws="1"> return kernel messages + line="6902">return kernel messages -This returns the kernel messages (@dmesg output) from the guest kernel. -This is sometimes useful for extended debugging of problems. +This returns the kernel messages (dmesg(1) output) from the guest +kernel. This is sometimes useful for extended debugging of problems. Another way to get the same information is to enable verbose messages with guestfs_session_set_verbose() or by setting the environment variable "LIBGUESTFS_DEBUG=1" before running the program. + line="260"/> the returned string, or NULL on error + line="6916">the returned string, or NULL on error A GuestfsSession object + line="6904">A GuestfsSession object @@ -11200,7 +14851,7 @@ variable "LIBGUESTFS_DEBUG=1" before running the program. throws="1"> download a file to the local machine + line="6939">download a file to the local machine Download file remotefilename and save it as filename on the local machine. @@ -11209,18 +14860,18 @@ filename can also be a named pipe. See also guestfs_session_upload(), guestfs_session_cat(). + line="261"/> true on success, false on error + line="6956">true on success, false on error A GuestfsSession object + line="6941">A GuestfsSession object @@ -11235,7 +14886,7 @@ See also guestfs_session_upload(), guestfs_session_cat(). allow-none="1"> A GCancellable object + line="6944">A GCancellable object @@ -11246,7 +14897,7 @@ See also guestfs_session_upload(), guestfs_session_cat(). throws="1"> download the given data units from the disk + line="6991">download the given data units from the disk Download the data units from start address to stop from the disk partition (eg. /dev/sda1) and save them as filename on the local @@ -11267,18 +14918,18 @@ overwritten yet. This function depends on the feature "sleuthkit". See also guestfs_session_feature_available(). + line="262"/> true on success, false on error + line="7023">true on success, false on error A GuestfsSession object + line="6993">A GuestfsSession object @@ -11299,7 +14950,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsDownloadBlocks containing optional arguments + line="6998">a GuestfsDownloadBlocks containing optional arguments allow-none="1"> A GCancellable object + line="6999">A GCancellable object @@ -11319,7 +14970,7 @@ See also guestfs_session_feature_available(). throws="1"> download a file to the local machine given its inode + line="7074">download a file to the local machine given its inode Download a file given its inode from the disk partition (eg. /dev/sda1) and save it as filename on the local machine. @@ -11331,18 +14982,18 @@ The command is capable of downloading deleted or inaccessible files. This function depends on the feature "sleuthkit". See also guestfs_session_feature_available(). + line="263"/> true on success, false on error + line="7095">true on success, false on error A GuestfsSession object + line="7076">A GuestfsSession object @@ -11360,7 +15011,7 @@ See also guestfs_session_feature_available(). allow-none="1"> A GCancellable object + line="7080">A GCancellable object @@ -11371,7 +15022,7 @@ See also guestfs_session_feature_available(). throws="1"> download a file to the local machine with offset and size + line="7130">download a file to the local machine with offset and size Download file remotefilename and save it as filename on the local machine. @@ -11385,18 +15036,18 @@ always reads the full amount unless an error occurs. See also guestfs_session_download(), guestfs_session_pread(). + line="264"/> true on success, false on error + line="7154">true on success, false on error A GuestfsSession object + line="7132">A GuestfsSession object @@ -11417,7 +15068,7 @@ See also guestfs_session_download(), guestfs_session_pread(). allow-none="1"> A GCancellable object + line="7137">A GCancellable object @@ -11428,11 +15079,11 @@ See also guestfs_session_download(), guestfs_session_pread(). throws="1"> drop kernel page cache, dentries and inodes + line="7189">drop kernel page cache, dentries and inodes This instructs the guest kernel to drop its page cache, and/or dentries and inode caches. The parameter @whattodrop tells the kernel what -precisely to drop, see <ulink url='http://linux-mm.org/Drop_Caches'> +precisely to drop, see <ulink url='https://linux-mm.org/Drop_Caches'> http://linux-mm.org/Drop_Caches </ulink> Setting @whattodrop to 3 should drop everything. @@ -11440,18 +15091,18 @@ Setting @whattodrop to 3 should drop everything. This automatically calls sync(2) before the operation, so that the maximum guest memory is freed. + line="265"/> true on success, false on error + line="7207">true on success, false on error A GuestfsSession object + line="7191">A GuestfsSession object @@ -11465,7 +15116,7 @@ maximum guest memory is freed. throws="1"> estimate file space usage + line="7230">estimate file space usage This command runs the "du -s" command to estimate file space usage for @path. @@ -11477,18 +15128,18 @@ estimate includes the contents of the directory and all subdirectories The result is the estimated size in *kilobytes* (ie. units of 1024 bytes). + line="266"/> the returned value, or -1 on error + line="7248">the returned value, or -1 on error A GuestfsSession object + line="7232">A GuestfsSession object @@ -11502,7 +15153,7 @@ bytes). throws="1"> check an ext2/ext3 filesystem + line="7271">check an ext2/ext3 filesystem This runs the ext2/ext3 filesystem checker on @device. It can take the following optional arguments: @@ -11522,18 +15173,18 @@ non-interactively. This option may not be specified at the same time as the @correct option. + line="267"/> true on success, false on error + line="7298">true on success, false on error A GuestfsSession object + line="7273">A GuestfsSession object @@ -11545,7 +15196,7 @@ option. allow-none="1"> a GuestfsE2fsck containing optional arguments + line="7275">a GuestfsE2fsck containing optional arguments @@ -11557,25 +15208,25 @@ option. throws="1"> check an ext2/ext3 filesystem + line="7345">check an ext2/ext3 filesystem This runs "e2fsck -p -f device", ie. runs the ext2/ext3 filesystem checker on @device, noninteractively (*-p*), even if the filesystem appears to be clean (*-f*). In new code, use guestfs_session_e2fsck() instead + line="268"/> true on success, false on error + line="7357">true on success, false on error A GuestfsSession object + line="7347">A GuestfsSession object @@ -11589,7 +15240,7 @@ appears to be clean (*-f*). throws="1"> echo arguments back to the client + line="7381">echo arguments back to the client This command concatenates the list of @words passed with single spaces between them and returns the resulting string. @@ -11598,24 +15249,24 @@ You can use this command to test the connection through to the daemon. See also guestfs_session_ping_daemon(). + line="269"/> the returned string, or NULL on error + line="7396">the returned string, or NULL on error A GuestfsSession object + line="7383">A GuestfsSession object an array of strings + line="7384">an array of strings @@ -11629,16 +15280,16 @@ See also guestfs_session_ping_daemon(). throws="1"> return lines matching a pattern + line="7419">return lines matching a pattern -This calls the external @egrep program and returns the matching lines. +This calls the external egrep(1) program and returns the matching lines. In new code, use guestfs_session_grep() instead + line="270"/> an array of returned strings, or NULL on error + line="7430">an array of returned strings, or NULL on error @@ -11647,7 +15298,7 @@ This calls the external @egrep program and returns the matching lines. A GuestfsSession object + line="7421">A GuestfsSession object @@ -11665,17 +15316,17 @@ This calls the external @egrep program and returns the matching lines. throws="1"> return lines matching a pattern + line="7454">return lines matching a pattern This calls the external "egrep -i" program and returns the matching lines. In new code, use guestfs_session_grep() instead + line="271"/> an array of returned strings, or NULL on error + line="7466">an array of returned strings, or NULL on error @@ -11684,7 +15335,7 @@ lines. A GuestfsSession object + line="7456">A GuestfsSession object @@ -11701,25 +15352,25 @@ lines. throws="1"> test if two files have equal contents + line="7490">test if two files have equal contents This compares the two files file1 and file2 and returns true if their content is exactly equal, or false otherwise. The external cmp(1) program is used for the comparison. + line="272"/> the returned value, or -1 on error + line="7504">the returned value, or -1 on error A GuestfsSession object + line="7492">A GuestfsSession object @@ -11736,7 +15387,7 @@ The external cmp(1) program is used for the comparison. throws="1"> test if file or directory exists + line="7527">test if file or directory exists This returns @true if and only if there is a file, directory (or anything) with the given @path name. @@ -11744,18 +15395,18 @@ anything) with the given @path name. See also guestfs_session_is_file(), guestfs_session_is_dir(), guestfs_session_stat(). + line="273"/> the returned value, or -1 on error + line="7541">the returned value, or -1 on error A GuestfsSession object + line="7529">A GuestfsSession object @@ -11769,7 +15420,7 @@ guestfs_session_stat(). throws="1"> install the SYSLINUX bootloader on an ext2/3/4 or btrfs filesystem + line="7564">install the SYSLINUX bootloader on an ext2/3/4 or btrfs filesystem Install the SYSLINUX bootloader on the device mounted at directory. Unlike guestfs_session_syslinux() which requires a FAT filesystem, this @@ -11794,18 +15445,18 @@ See also guestfs_session_syslinux(). This function depends on the feature "extlinux". See also guestfs_session_feature_available(). + line="274"/> true on success, false on error + line="7595">true on success, false on error A GuestfsSession object + line="7566">A GuestfsSession object @@ -11819,7 +15470,7 @@ See also guestfs_session_feature_available(). throws="1"> expand a f2fs filesystem + line="7618">expand a f2fs filesystem This expands a f2fs filesystem to match the size of the underlying device. @@ -11827,18 +15478,18 @@ device. This function depends on the feature "f2fs". See also guestfs_session_feature_available(). + line="275"/> true on success, false on error + line="7632">true on success, false on error A GuestfsSession object + line="7620">A GuestfsSession object @@ -11853,7 +15504,7 @@ See also guestfs_session_feature_available(). throws="1"> preallocate a file in the guest filesystem + line="7655">preallocate a file in the guest filesystem This command preallocates a file (containing zero bytes) named @path of size @len bytes. If the file exists already, it is overwritten. @@ -11862,18 +15513,18 @@ Do not confuse this with the guestfish-specific @alloc command which allocates a file in the host and attaches it as a device. In new code, use guestfs_session_fallocate64() instead + line="276"/> true on success, false on error + line="7670">true on success, false on error A GuestfsSession object + line="7657">A GuestfsSession object @@ -11890,7 +15541,7 @@ allocates a file in the host and attaches it as a device. throws="1"> preallocate a file in the guest filesystem + line="7694">preallocate a file in the guest filesystem This command preallocates a file (containing zero bytes) named @path of size @len bytes. If the file exists already, it is overwritten. @@ -11906,18 +15557,18 @@ to 1GB. Do not confuse this with the guestfish-specific @alloc and @sparse commands which create a file in the host and attach it as a device. + line="277"/> true on success, false on error + line="7717">true on success, false on error A GuestfsSession object + line="7696">A GuestfsSession object @@ -11934,31 +15585,31 @@ commands which create a file in the host and attach it as a device. throws="1"> test availability of some parts of the API + line="7740">test availability of some parts of the API This is the same as guestfs_session_available(), but unlike that call it returns a simple true/false boolean result, instead of throwing an exception if a feature is not found. For other documentation see guestfs_session_available(). + line="278"/> the returned value, or -1 on error + line="7753">the returned value, or -1 on error A GuestfsSession object + line="7742">A GuestfsSession object an array of strings + line="7743">an array of strings @@ -11972,16 +15623,16 @@ guestfs_session_available(). throws="1"> return lines matching a pattern + line="7776">return lines matching a pattern -This calls the external @fgrep program and returns the matching lines. +This calls the external fgrep(1) program and returns the matching lines. In new code, use guestfs_session_grep() instead + line="279"/> an array of returned strings, or NULL on error + line="7787">an array of returned strings, or NULL on error @@ -11990,7 +15641,7 @@ This calls the external @fgrep program and returns the matching lines. A GuestfsSession object + line="7778">A GuestfsSession object @@ -12008,17 +15659,17 @@ This calls the external @fgrep program and returns the matching lines. throws="1"> return lines matching a pattern + line="7811">return lines matching a pattern This calls the external "fgrep -i" program and returns the matching lines. In new code, use guestfs_session_grep() instead + line="280"/> an array of returned strings, or NULL on error + line="7823">an array of returned strings, or NULL on error @@ -12027,7 +15678,7 @@ lines. A GuestfsSession object + line="7813">A GuestfsSession object @@ -12044,7 +15695,7 @@ lines. throws="1"> determine file type + line="7847">determine file type This call uses the standard file(1) command to determine the type or contents of the file. @@ -12052,8 +15703,8 @@ contents of the file. This call will also transparently look inside various types of compressed file. -The exact command which runs is "file -zb path". Note in particular that -the filename is not prepended to the output (the *-b* option). +The filename is not prepended to the output (like the file command *-b* +option). The output depends on the output of the underlying file(1) command and it can change in future in ways beyond our control. In other words, the @@ -12063,18 +15714,18 @@ See also: file(1), guestfs_session_vfs_type(), guestfs_session_lstat(), guestfs_session_is_file(), guestfs_session_is_blockdev() (etc), guestfs_session_is_zero(). + line="281"/> the returned string, or NULL on error + line="7872">the returned string, or NULL on error A GuestfsSession object + line="7849">A GuestfsSession object @@ -12088,7 +15739,7 @@ guestfs_session_is_zero(). throws="1"> detect the architecture of a binary file + line="7895">detect the architecture of a binary file This detects the architecture of the binary filename, and returns it if known. @@ -12173,18 +15824,18 @@ compressed code, and are horribly hard to unpack. If you want to find the architecture of a kernel, use the architecture of the associated initrd or kernel module(s) instead. + line="282"/> the returned string, or NULL on error + line="7986">the returned string, or NULL on error A GuestfsSession object + line="7897">A GuestfsSession object @@ -12198,7 +15849,7 @@ associated initrd or kernel module(s) instead. throws="1"> return the size of the file in bytes + line="8009">return the size of the file in bytes This command returns the size of file in bytes. @@ -12207,18 +15858,18 @@ guestfs_session_lstat(), guestfs_session_is_dir(), guestfs_session_is_file() etc. To get the size of block devices, use guestfs_session_blockdev_getsize64(). + line="283"/> the returned value, or -1 on error + line="8024">the returned value, or -1 on error A GuestfsSession object + line="8011">A GuestfsSession object @@ -12232,7 +15883,7 @@ guestfs_session_blockdev_getsize64(). throws="1"> check if filesystem is available + line="8047">check if filesystem is available Check whether libguestfs supports the named filesystem. The argument @filesystem is a filesystem name, such as @ext3. @@ -12248,18 +15899,18 @@ the right mkfs.&lt;*fs*&gt; tool. See also guestfs_session_available(), guestfs_session_feature_available(), "AVAILABILITY" in guestfs(3). + line="284"/> the returned value, or -1 on error + line="8069">the returned value, or -1 on error A GuestfsSession object + line="8049">A GuestfsSession object @@ -12273,7 +15924,7 @@ guestfs_session_feature_available(), "AVAILABILITY" in guestfs(3). throws="1"> walk through the filesystem content + line="8092">walk through the filesystem content Walk through the internal structures of a disk partition (eg. /dev/sda1) in order to return a list of all the files and directories stored @@ -12368,11 +16019,11 @@ The @tsk_type field will contain one of the following characters: This function depends on the feature "libtsk". See also guestfs_session_feature_available(). + line="285"/> an array of TSKDirent objects, or NULL on error + line="8194">an array of TSKDirent objects, or NULL on error @@ -12381,7 +16032,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="8094">A GuestfsSession object @@ -12393,7 +16044,7 @@ See also guestfs_session_feature_available(). allow-none="1"> A GCancellable object + line="8096">A GCancellable object @@ -12404,7 +16055,7 @@ See also guestfs_session_feature_available(). throws="1"> fill a file with octets + line="8252">fill a file with octets This command creates a new file called @path. The initial content of the file is @len octets of @c, where @c must be a number in the range @@ -12414,18 +16065,18 @@ To fill a file with zero bytes (sparsely), it is much more efficient to use guestfs_session_truncate_size(). To create a file with a pattern of repeating bytes use guestfs_session_fill_pattern(). + line="286"/> true on success, false on error + line="8270">true on success, false on error A GuestfsSession object + line="8254">A GuestfsSession object @@ -12445,24 +16096,24 @@ repeating bytes use guestfs_session_fill_pattern(). throws="1"> fill a directory with empty files + line="8293">fill a directory with empty files This function, useful for testing filesystems, creates @nr empty files in the directory @dir with names @00000000 through @nr-1 (ie. each file name is 8 digits long padded with zeroes). + line="287"/> true on success, false on error + line="8306">true on success, false on error A GuestfsSession object + line="8295">A GuestfsSession object @@ -12479,25 +16130,25 @@ name is 8 digits long padded with zeroes). throws="1"> fill a file with a repeating pattern of bytes + line="8329">fill a file with a repeating pattern of bytes This function is like guestfs_session_fill() except that it creates a new file of length @len containing the repeating pattern of bytes in @pattern. The pattern is truncated if necessary to ensure the length of the file is exactly @len bytes. + line="288"/> true on success, false on error + line="8344">true on success, false on error A GuestfsSession object + line="8331">A GuestfsSession object @@ -12517,7 +16168,7 @@ the file is exactly @len bytes. throws="1"> find all files and directories + line="8367">find all files and directories This command lists out all files and directories, recursively, starting at directory. It is essentially equivalent to running the shell command @@ -12548,11 +16199,11 @@ If directory is not a directory, then this command returns an error. The returned list is sorted. + line="289"/> an array of returned strings, or NULL on error + line="8404">an array of returned strings, or NULL on error @@ -12561,7 +16212,7 @@ The returned list is sorted. A GuestfsSession object + line="8369">A GuestfsSession object @@ -12575,7 +16226,7 @@ The returned list is sorted. throws="1"> find all files and directories, returning NUL-separated list + line="8427">find all files and directories, returning NUL-separated list This command lists out all files and directories, recursively, starting at directory, placing the resulting list in the external file called @@ -12591,18 +16242,18 @@ See find(1) option *-print0*. * The result list is not sorted. + line="290"/> true on success, false on error + line="8451">true on success, false on error A GuestfsSession object + line="8429">A GuestfsSession object @@ -12617,7 +16268,7 @@ See find(1) option *-print0*. allow-none="1"> A GCancellable object + line="8432">A GCancellable object @@ -12628,7 +16279,7 @@ See find(1) option *-print0*. throws="1"> search the entries associated to the given inode + line="8486">search the entries associated to the given inode Searches all the entries associated with the given inode. @@ -12638,11 +16289,11 @@ For each entry, a @tsk_dirent structure is returned. See This function depends on the feature "libtsk". See also guestfs_session_feature_available(). + line="291"/> an array of TSKDirent objects, or NULL on error + line="8504">an array of TSKDirent objects, or NULL on error @@ -12651,7 +16302,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="8488">A GuestfsSession object @@ -12666,7 +16317,7 @@ See also guestfs_session_feature_available(). allow-none="1"> A GCancellable object + line="8491">A GCancellable object @@ -12677,25 +16328,25 @@ See also guestfs_session_feature_available(). throws="1"> find a filesystem by label + line="8562">find a filesystem by label This command searches the filesystems and returns the one which has the given label. An error is returned if no such filesystem can be found. To find the label of a filesystem, use guestfs_session_vfs_label(). + line="292"/> the returned string, or NULL on error + line="8575">the returned string, or NULL on error A GuestfsSession object + line="8564">A GuestfsSession object @@ -12709,25 +16360,25 @@ To find the label of a filesystem, use guestfs_session_vfs_label(). throws="1"> find a filesystem by UUID + line="8598">find a filesystem by UUID This command searches the filesystems and returns the one which has the given UUID. An error is returned if no such filesystem can be found. To find the UUID of a filesystem, use guestfs_session_vfs_uuid(). + line="293"/> the returned string, or NULL on error + line="8611">the returned string, or NULL on error A GuestfsSession object + line="8600">A GuestfsSession object @@ -12741,7 +16392,7 @@ To find the UUID of a filesystem, use guestfs_session_vfs_uuid(). throws="1"> run the filesystem checker + line="8634">run the filesystem checker This runs the filesystem checker (fsck) on @device which should have filesystem type @fstype. @@ -12761,18 +16412,18 @@ have been corrected on the filesystem. This command is entirely equivalent to running "fsck -a -t fstype device". + line="294"/> the returned value, or -1 on error + line="8661">the returned value, or -1 on error A GuestfsSession object + line="8636">A GuestfsSession object @@ -12789,7 +16440,7 @@ device". throws="1"> trim free space in a filesystem + line="8684">trim free space in a filesystem Trim the free space in the filesystem mounted on @mountpoint. The filesystem must be mounted read-write. @@ -12815,18 +16466,18 @@ calling guestfs_session_zero_free_space(). This function depends on the feature "fstrim". See also guestfs_session_feature_available(). + line="295"/> true on success, false on error + line="8717">true on success, false on error A GuestfsSession object + line="8686">A GuestfsSession object @@ -12838,7 +16489,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsFstrim containing optional arguments + line="8688">a GuestfsFstrim containing optional arguments @@ -12849,25 +16500,25 @@ See also guestfs_session_feature_available(). throws="1"> get the additional kernel options + line="8772">get the additional kernel options Return the additional kernel options which are added to the libguestfs appliance kernel command line. If @NULL then no options are added. + line="296"/> the returned string. Note that NULL does not indicate error + line="8784">the returned string. Note that NULL does not indicate error A GuestfsSession object + line="8774">A GuestfsSession object @@ -12879,25 +16530,25 @@ If @NULL then no options are added. throws="1"> get the backend + line="8803">get the backend Return the current backend. See guestfs_session_set_backend() and "BACKEND" in guestfs(3). In new code, use guestfs_session_get_backend() instead + line="297"/> the returned string, or NULL on error + line="8814">the returned string, or NULL on error A GuestfsSession object + line="8805">A GuestfsSession object @@ -12908,22 +16559,22 @@ See guestfs_session_set_backend() and "BACKEND" in guestfs(3). throws="1"> get autosync mode + line="8838">get autosync mode Get the autosync flag. + line="298"/> the returned value, or -1 on error + line="8847">the returned value, or -1 on error A GuestfsSession object + line="8840">A GuestfsSession object @@ -12934,7 +16585,7 @@ Get the autosync flag. throws="1"> get the backend + line="8870">get the backend Return the current backend. @@ -12942,18 +16593,18 @@ This handle property was previously called the "attach method". See guestfs_session_set_backend() and "BACKEND" in guestfs(3). + line="299"/> the returned string, or NULL on error + line="8883">the returned string, or NULL on error A GuestfsSession object + line="8872">A GuestfsSession object @@ -12964,7 +16615,7 @@ See guestfs_session_set_backend() and "BACKEND" in guestfs(3). throws="1"> get a single per-backend settings string + line="8906">get a single per-backend settings string Find a backend setting string which is either "name" or begins with "name=". If "name", this returns the string "1". If "name=", this @@ -12975,18 +16626,18 @@ If no such setting is found, this function throws an error. The errno See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). + line="300"/> the returned string, or NULL on error + line="8923">the returned string, or NULL on error A GuestfsSession object + line="8908">A GuestfsSession object @@ -13000,7 +16651,7 @@ See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). throws="1"> get per-backend settings + line="8946">get per-backend settings Return the current backend settings. @@ -13009,11 +16660,11 @@ single backend setting, see guestfs_session_get_backend_setting(). See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). + line="301"/> an array of returned strings, or NULL on error + line="8960">an array of returned strings, or NULL on error @@ -13022,7 +16673,7 @@ See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). A GuestfsSession object + line="8948">A GuestfsSession object @@ -13033,22 +16684,22 @@ See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). throws="1"> get the appliance cache directory + line="8983">get the appliance cache directory Get the directory used by the handle to store the appliance cache. + line="302"/> the returned string, or NULL on error + line="8992">the returned string, or NULL on error A GuestfsSession object + line="8985">A GuestfsSession object @@ -13060,23 +16711,23 @@ Get the directory used by the handle to store the appliance cache. throws="1"> get direct appliance mode flag + line="9015">get direct appliance mode flag Return the direct appliance mode flag. In new code, use guestfs_session_internal_get_console_socket() instead + line="303"/> the returned value, or -1 on error + line="9024">the returned value, or -1 on error A GuestfsSession object + line="9017">A GuestfsSession object @@ -13087,7 +16738,7 @@ Return the direct appliance mode flag. throws="1"> get ext2 file attributes of a file + line="9048">get ext2 file attributes of a file This returns the file attributes associated with file. @@ -13155,18 +16806,18 @@ See also guestfs_session_set_e2attrs(). Don't confuse these attributes with extended attributes (see guestfs_session_getxattr()). + line="304"/> the returned string, or NULL on error + line="9122">the returned string, or NULL on error A GuestfsSession object + line="9050">A GuestfsSession object @@ -13180,7 +16831,7 @@ guestfs_session_getxattr()). throws="1"> get ext2 file generation of a file + line="9145">get ext2 file generation of a file This returns the ext2 file generation of a file. The generation (which used to be called the "version") is a number associated with an inode. @@ -13192,18 +16843,18 @@ error. See guestfs_session_set_e2generation(). + line="305"/> the returned value, or -1 on error + line="9163">the returned value, or -1 on error A GuestfsSession object + line="9147">A GuestfsSession object @@ -13218,23 +16869,23 @@ See guestfs_session_set_e2generation(). throws="1"> get the ext2/3/4 filesystem label + line="9186">get the ext2/3/4 filesystem label This returns the ext2/3/4 filesystem label of the filesystem on @device. In new code, use guestfs_session_vfs_label() instead + line="306"/> the returned string, or NULL on error + line="9196">the returned string, or NULL on error A GuestfsSession object + line="9188">A GuestfsSession object @@ -13249,23 +16900,23 @@ This returns the ext2/3/4 filesystem label of the filesystem on @device. throws="1"> get the ext2/3/4 filesystem UUID + line="9220">get the ext2/3/4 filesystem UUID This returns the ext2/3/4 filesystem UUID of the filesystem on @device. In new code, use guestfs_session_vfs_uuid() instead + line="307"/> the returned string, or NULL on error + line="9230">the returned string, or NULL on error A GuestfsSession object + line="9222">A GuestfsSession object @@ -13279,25 +16930,25 @@ This returns the ext2/3/4 filesystem UUID of the filesystem on @device. throws="1"> get the hypervisor binary + line="9254">get the hypervisor binary Return the current hypervisor binary. This is always non-NULL. If it wasn't set already, then this will return the default qemu binary name. + line="308"/> the returned string, or NULL on error + line="9266">the returned string, or NULL on error A GuestfsSession object + line="9256">A GuestfsSession object @@ -13308,22 +16959,22 @@ the default qemu binary name. throws="1"> get the handle identifier + line="9289">get the handle identifier Get the handle identifier. See guestfs_session_set_identifier(). + line="309"/> the returned string, or NULL on error + line="9298">the returned string, or NULL on error A GuestfsSession object + line="9291">A GuestfsSession object @@ -13334,7 +16985,7 @@ Get the handle identifier. See guestfs_session_set_identifier(). throws="1"> challenge of i'th requested credential + line="9321">challenge of i'th requested credential Get the challenge (provided by libvirt) for the @index'th requested credential. If libvirt did not provide a challenge, this returns the @@ -13343,18 +16994,18 @@ empty string "". See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code. + line="310"/> the returned string, or NULL on error + line="9336">the returned string, or NULL on error A GuestfsSession object + line="9323">A GuestfsSession object @@ -13368,7 +17019,7 @@ code. throws="1"> default result of i'th requested credential + line="9359">default result of i'th requested credential Get the default result (provided by libvirt) for the @index'th requested credential. If libvirt did not provide a default result, this returns @@ -13377,18 +17028,18 @@ the empty string "". See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code. + line="311"/> the returned string, or NULL on error + line="9374">the returned string, or NULL on error A GuestfsSession object + line="9361">A GuestfsSession object @@ -13402,7 +17053,7 @@ code. throws="1"> prompt of i'th requested credential + line="9397">prompt of i'th requested credential Get the prompt (provided by libvirt) for the @index'th requested credential. If libvirt did not provide a prompt, this returns the empty @@ -13411,18 +17062,18 @@ string "". See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code. + line="312"/> the returned string, or NULL on error + line="9412">the returned string, or NULL on error A GuestfsSession object + line="9399">A GuestfsSession object @@ -13436,7 +17087,7 @@ code. throws="1"> get list of credentials requested by libvirt + line="9435">get list of credentials requested by libvirt This should only be called during the event callback for events of type @GUESTFS_EVENT_LIBVIRT_AUTH. @@ -13448,11 +17099,11 @@ guestfs_session_set_libvirt_supported_credentials(). See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code. + line="313"/> an array of returned strings, or NULL on error + line="9452">an array of returned strings, or NULL on error @@ -13461,7 +17112,7 @@ code. A GuestfsSession object + line="9437">A GuestfsSession object @@ -13472,7 +17123,7 @@ code. throws="1"> get memory allocated to the hypervisor + line="9475">get memory allocated to the hypervisor This gets the memory size in megabytes allocated to the hypervisor. @@ -13482,18 +17133,18 @@ default value for memsize. For more information on the architecture of libguestfs, see guestfs(3). + line="314"/> the returned value, or -1 on error + line="9490">the returned value, or -1 on error A GuestfsSession object + line="9477">A GuestfsSession object @@ -13504,22 +17155,22 @@ For more information on the architecture of libguestfs, see guestfs(3). throws="1"> get enable network flag + line="9513">get enable network flag This returns the enable network flag. + line="315"/> the returned value, or -1 on error + line="9522">the returned value, or -1 on error A GuestfsSession object + line="9515">A GuestfsSession object @@ -13530,25 +17181,25 @@ This returns the enable network flag. throws="1"> get the search path + line="9545">get the search path Return the current search path. This is always non-NULL. If it wasn't set already, then this will return the default path. + line="316"/> the returned string, or NULL on error + line="9557">the returned string, or NULL on error A GuestfsSession object + line="9547">A GuestfsSession object @@ -13559,22 +17210,22 @@ the default path. throws="1"> get process group flag + line="9580">get process group flag This returns the process group flag. + line="317"/> the returned value, or -1 on error + line="9589">the returned value, or -1 on error A GuestfsSession object + line="9582">A GuestfsSession object @@ -13585,25 +17236,25 @@ This returns the process group flag. throws="1"> get PID of hypervisor + line="9612">get PID of hypervisor Return the process ID of the hypervisor. If there is no hypervisor running, then this will return an error. This is an internal call used for debugging and testing. + line="318"/> the returned value, or -1 on error + line="9624">the returned value, or -1 on error A GuestfsSession object + line="9614">A GuestfsSession object @@ -13614,22 +17265,22 @@ This is an internal call used for debugging and testing. throws="1"> get the program name + line="9647">get the program name Get the program name. See guestfs_session_set_program(). + line="319"/> the returned string, or NULL on error + line="9656">the returned string, or NULL on error A GuestfsSession object + line="9649">A GuestfsSession object @@ -13641,7 +17292,7 @@ Get the program name. See guestfs_session_set_program(). throws="1"> get the hypervisor binary (usually qemu) + line="9679">get the hypervisor binary (usually qemu) Return the current hypervisor binary (usually qemu). @@ -13649,18 +17300,18 @@ This is always non-NULL. If it wasn't set already, then this will return the default qemu binary name. In new code, use guestfs_session_get_hv() instead + line="320"/> the returned string, or NULL on error + line="9691">the returned string, or NULL on error A GuestfsSession object + line="9681">A GuestfsSession object @@ -13671,22 +17322,22 @@ the default qemu binary name. throws="1"> get recovery process enabled flag + line="9715">get recovery process enabled flag Return the recovery process enabled flag. + line="321"/> the returned value, or -1 on error + line="9724">the returned value, or -1 on error A GuestfsSession object + line="9717">A GuestfsSession object @@ -13698,7 +17349,7 @@ Return the recovery process enabled flag. throws="1"> get SELinux enabled flag + line="9747">get SELinux enabled flag This returns the current setting of the selinux flag which is passed to the appliance at boot time. See guestfs_session_set_selinux(). @@ -13706,18 +17357,18 @@ the appliance at boot time. See guestfs_session_set_selinux(). For more information on the architecture of libguestfs, see guestfs(3). In new code, use guestfs_session_selinux_relabel() instead + line="322"/> the returned value, or -1 on error + line="9759">the returned value, or -1 on error A GuestfsSession object + line="9749">A GuestfsSession object @@ -13728,22 +17379,22 @@ For more information on the architecture of libguestfs, see guestfs(3). throws="1"> get number of virtual CPUs in appliance + line="9783">get number of virtual CPUs in appliance This returns the number of virtual CPUs assigned to the appliance. + line="323"/> the returned value, or -1 on error + line="9792">the returned value, or -1 on error A GuestfsSession object + line="9785">A GuestfsSession object @@ -13754,30 +17405,34 @@ This returns the number of virtual CPUs assigned to the appliance. throws="1"> get the temporary directory for sockets + line="9815">get the temporary directory for sockets and PID files -Get the directory used by the handle to store temporary socket files. +Get the directory used by the handle to store temporary socket and PID +files. -This is different from guestfs_session_tmpdir(), as we need shorter +This is different from guestfs_session_get_tmpdir(), as we need shorter paths for sockets (due to the limited buffers of filenames for UNIX -sockets), and guestfs_session_tmpdir() may be too long for them. +sockets), and guestfs_session_get_tmpdir() may be too long for them. +Furthermore, sockets and PID files must be accessible to such background +services started by libguestfs that may not have permission to access +the temporary directory returned by guestfs_session_get_tmpdir(). The environment variable @XDG_RUNTIME_DIR controls the default value: If @XDG_RUNTIME_DIR is set, then that is the default. Else /tmp is the default. + line="324"/> the returned string, or NULL on error + line="9836">the returned string, or NULL on error A GuestfsSession object + line="9817">A GuestfsSession object @@ -13788,25 +17443,25 @@ default. throws="1"> get the current state + line="9859">get the current state This returns the current state as an opaque integer. This is only useful for printing debug and internal error messages. For more information on states, see guestfs(3). + line="325"/> the returned value, or -1 on error + line="9871">the returned value, or -1 on error A GuestfsSession object + line="9861">A GuestfsSession object @@ -13817,22 +17472,22 @@ For more information on states, see guestfs(3). throws="1"> get the temporary directory + line="9894">get the temporary directory Get the directory used by the handle to store temporary files. + line="326"/> the returned string, or NULL on error + line="9903">the returned string, or NULL on error A GuestfsSession object + line="9896">A GuestfsSession object @@ -13843,22 +17498,22 @@ Get the directory used by the handle to store temporary files. throws="1"> get command trace enabled flag + line="9926">get command trace enabled flag Return the command trace flag. + line="327"/> the returned value, or -1 on error + line="9935">the returned value, or -1 on error A GuestfsSession object + line="9928">A GuestfsSession object @@ -13869,23 +17524,23 @@ Return the command trace flag. throws="1"> get the current umask + line="9958">get the current umask Return the current umask. By default the umask is @022 unless it has been set by calling guestfs_session_umask(). + line="328"/> the returned value, or -1 on error + line="9968">the returned value, or -1 on error A GuestfsSession object + line="9960">A GuestfsSession object @@ -13896,22 +17551,22 @@ been set by calling guestfs_session_umask(). throws="1"> get verbose mode + line="9991">get verbose mode This returns the verbose messages flag. + line="329"/> the returned value, or -1 on error + line="10000">the returned value, or -1 on error A GuestfsSession object + line="9993">A GuestfsSession object @@ -13923,7 +17578,7 @@ This returns the verbose messages flag. throws="1"> get SELinux security context + line="10023">get SELinux security context This gets the SELinux security context of the daemon. @@ -13934,18 +17589,18 @@ This function depends on the feature "selinux". See also guestfs_session_feature_available(). In new code, use guestfs_session_selinux_relabel() instead + line="330"/> the returned string, or NULL on error + line="10038">the returned string, or NULL on error A GuestfsSession object + line="10025">A GuestfsSession object @@ -13956,7 +17611,7 @@ See also guestfs_session_feature_available(). throws="1"> get a single extended attribute + line="10062">get a single extended attribute Get a single extended attribute from file @path named @name. This call follows symlinks. If you want to lookup an extended attribute for the @@ -13978,11 +17633,11 @@ attr(5). This function depends on the feature "linuxxattrs". See also guestfs_session_feature_available(). + line="331"/> an array of binary data, or NULL on error + line="10092">an array of binary data, or NULL on error @@ -13991,7 +17646,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="10064">A GuestfsSession object @@ -14006,7 +17661,7 @@ See also guestfs_session_feature_available(). transfer-ownership="full"> The size of the returned buffer, in bytes + line="10067">The size of the returned buffer, in bytes @@ -14017,7 +17672,7 @@ See also guestfs_session_feature_available(). throws="1"> list extended attributes of a file or directory + line="10115">list extended attributes of a file or directory This call lists the extended attributes of the file or directory @path. @@ -14029,11 +17684,11 @@ See also: guestfs_session_lgetxattrs(), attr(5). This function depends on the feature "linuxxattrs". See also guestfs_session_feature_available(). + line="332"/> an array of XAttr objects, or NULL on error + line="10133">an array of XAttr objects, or NULL on error @@ -14042,7 +17697,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="10117">A GuestfsSession object @@ -14056,7 +17711,7 @@ See also guestfs_session_feature_available(). throws="1"> expand a wildcard path + line="10168">expand a wildcard path This command searches for all the pathnames matching @pattern according to the wildcard expansion rules used by the shell. @@ -14074,11 +17729,11 @@ Notice that there is no equivalent command for expanding a device name (eg. /dev/sd*). Use guestfs_session_list_devices(), guestfs_session_list_partitions() etc functions instead. + line="333"/> an array of returned strings, or NULL on error + line="10193">an array of returned strings, or NULL on error @@ -14087,7 +17742,7 @@ guestfs_session_list_partitions() etc functions instead. A GuestfsSession object + line="10170">A GuestfsSession object @@ -14099,7 +17754,7 @@ guestfs_session_list_partitions() etc functions instead. allow-none="1"> a GuestfsGlobExpand containing optional arguments + line="10172">a GuestfsGlobExpand containing optional arguments @@ -14110,9 +17765,9 @@ guestfs_session_list_partitions() etc functions instead. throws="1"> return lines matching a pattern + line="10232">return lines matching a pattern -This calls the external @grep program and returns the matching lines. +This calls the external grep(1) program and returns the matching lines. The optional flags are: @@ -14128,14 +17783,14 @@ using the *-F* flag. Match case-insensitive. This is the same as using the *-i* flag. @compressed -Use @zgrep instead of @grep. This allows the input to be compress- -or gzip-compressed. +Use zgrep(1) instead of grep(1). This allows the input to be +compress- or gzip-compressed. + line="334"/> an array of returned strings, or NULL on error + line="10261">an array of returned strings, or NULL on error @@ -14144,7 +17799,7 @@ or gzip-compressed. A GuestfsSession object + line="10234">A GuestfsSession object @@ -14159,7 +17814,7 @@ or gzip-compressed. allow-none="1"> a GuestfsGrep containing optional arguments + line="10237">a GuestfsGrep containing optional arguments @@ -14171,17 +17826,17 @@ or gzip-compressed. throws="1"> return lines matching a pattern + line="10324">return lines matching a pattern This calls the external "grep -i" program and returns the matching lines. In new code, use guestfs_session_grep() instead + line="335"/> an array of returned strings, or NULL on error + line="10336">an array of returned strings, or NULL on error @@ -14190,7 +17845,7 @@ lines. A GuestfsSession object + line="10326">A GuestfsSession object @@ -14207,7 +17862,7 @@ lines. throws="1"> install GRUB 1 + line="10360">install GRUB 1 This command installs GRUB 1 (the Grand Unified Bootloader) on @device, with the root directory being @root. @@ -14219,7 +17874,7 @@ by most modern Linux guests. It is possible to run the grub2 command from the guest, although see the caveats in "RUNNING COMMANDS" in guestfs(3). -* This uses @grub-install from the host. Unfortunately grub is not +* This uses grub-install(8) from the host. Unfortunately grub is not always compatible with itself, so this only works in rather narrow circumstances. Careful testing with each guest version is advisable. @@ -14236,18 +17891,18 @@ replacing /dev/vda with the name of the installation device. This function depends on the feature "grub". See also guestfs_session_feature_available(). + line="336"/> true on success, false on error + line="10396">true on success, false on error A GuestfsSession object + line="10362">A GuestfsSession object @@ -14264,16 +17919,16 @@ See also guestfs_session_feature_available(). throws="1"> return first 10 lines of a file + line="10419">return first 10 lines of a file This command returns up to the first 10 lines of a file as a list of strings. + line="337"/> an array of returned strings, or NULL on error + line="10430">an array of returned strings, or NULL on error @@ -14282,7 +17937,7 @@ strings. A GuestfsSession object + line="10421">A GuestfsSession object @@ -14296,7 +17951,7 @@ strings. throws="1"> return first N lines of a file + line="10453">return first N lines of a file If the parameter @nrlines is a positive number, this returns the first @nrlines lines of the file @path. @@ -14306,11 +17961,11 @@ the file @path, excluding the last @nrlines lines. If the parameter @nrlines is zero, this returns an empty list. + line="338"/> an array of returned strings, or NULL on error + line="10470">an array of returned strings, or NULL on error @@ -14319,7 +17974,7 @@ If the parameter @nrlines is zero, this returns an empty list. A GuestfsSession object + line="10455">A GuestfsSession object @@ -14336,23 +17991,23 @@ If the parameter @nrlines is zero, this returns an empty list. throws="1"> dump a file in hexadecimal + line="10493">dump a file in hexadecimal This runs "hexdump -C" on the given @path. The result is the human-readable, canonical hex dump of the file. + line="339"/> the returned string, or NULL on error + line="10504">the returned string, or NULL on error A GuestfsSession object + line="10495">A GuestfsSession object @@ -14366,7 +18021,7 @@ human-readable, canonical hex dump of the file. throws="1"> close the current hivex handle + line="10527">close the current hivex handle Close the current hivex handle. @@ -14375,18 +18030,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="340"/> true on success, false on error + line="10541">true on success, false on error A GuestfsSession object + line="10529">A GuestfsSession object @@ -14397,7 +18052,7 @@ See also guestfs_session_feature_available(). throws="1"> commit (write) changes back to the hive + line="10564">commit (write) changes back to the hive Commit (write) changes to the hive. @@ -14411,18 +18066,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="341"/> true on success, false on error + line="10584">true on success, false on error A GuestfsSession object + line="10566">A GuestfsSession object throws="1"> add a child node + line="10607">add a child node Add a child node to @parent named @name. @@ -14448,18 +18103,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="342"/> the returned value, or -1 on error + line="10623">the returned value, or -1 on error A GuestfsSession object + line="10609">A GuestfsSession object @@ -14476,7 +18131,7 @@ See also guestfs_session_feature_available(). throws="1"> return list of nodes which are subkeys of node + line="10646">return list of nodes which are subkeys of node Return the list of nodes which are subkeys of @nodeh. @@ -14485,11 +18140,11 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="343"/> an array of HivexNode objects, or NULL on error + line="10661">an array of HivexNode objects, or NULL on error @@ -14498,7 +18153,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="10648">A GuestfsSession object @@ -14512,7 +18167,7 @@ See also guestfs_session_feature_available(). throws="1"> delete a node (recursively) + line="10692">delete a node (recursively) Delete @nodeh, recursively if necessary. @@ -14521,18 +18176,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="344"/> true on success, false on error + line="10707">true on success, false on error A GuestfsSession object + line="10694">A GuestfsSession object @@ -14546,7 +18201,7 @@ See also guestfs_session_feature_available(). throws="1"> return the named child of node + line="10730">return the named child of node Return the child of @nodeh with the name @name, if it exists. This can return @0 meaning the name was not found. @@ -14556,18 +18211,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="345"/> the returned value, or -1 on error + line="10747">the returned value, or -1 on error A GuestfsSession object + line="10732">A GuestfsSession object @@ -14584,7 +18239,7 @@ See also guestfs_session_feature_available(). throws="1"> return the named value + line="10770">return the named value Return the value attached to @nodeh which has the name @key, if it exists. This can return @0 meaning the key was not found. @@ -14594,18 +18249,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="346"/> the returned value, or -1 on error + line="10787">the returned value, or -1 on error A GuestfsSession object + line="10772">A GuestfsSession object @@ -14622,7 +18277,7 @@ See also guestfs_session_feature_available(). throws="1"> return the name of the node + line="10810">return the name of the node Return the name of @nodeh. @@ -14631,18 +18286,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="347"/> the returned string, or NULL on error + line="10825">the returned string, or NULL on error A GuestfsSession object + line="10812">A GuestfsSession object @@ -14656,7 +18311,7 @@ See also guestfs_session_feature_available(). throws="1"> return the parent of node + line="10848">return the parent of node Return the parent node of @nodeh. @@ -14665,18 +18320,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="348"/> the returned value, or -1 on error + line="10863">the returned value, or -1 on error A GuestfsSession object + line="10850">A GuestfsSession object @@ -14690,7 +18345,7 @@ See also guestfs_session_feature_available(). throws="1"> set or replace a single value in a node + line="10886">set or replace a single value in a node Set or replace a single value under the node @nodeh. The @key is the name, @t is the type, and @val is the data. @@ -14700,18 +18355,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="349"/> true on success, false on error + line="10906">true on success, false on error A GuestfsSession object + line="10888">A GuestfsSession object @@ -14726,7 +18381,7 @@ See also guestfs_session_feature_available(). an array of binary data + line="10892">an array of binary data @@ -14734,7 +18389,7 @@ See also guestfs_session_feature_available(). The size of val, in bytes + line="10893">The size of val, in bytes @@ -14745,7 +18400,7 @@ See also guestfs_session_feature_available(). throws="1"> return list of values attached to node + line="10929">return list of values attached to node Return the array of (key, datatype, data) tuples attached to @nodeh. @@ -14754,11 +18409,11 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="350"/> an array of HivexValue objects, or NULL on error + line="10944">an array of HivexValue objects, or NULL on error @@ -14767,7 +18422,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="10931">A GuestfsSession object @@ -14781,7 +18436,7 @@ See also guestfs_session_feature_available(). throws="1"> open a Windows Registry hive file + line="10975">open a Windows Registry hive file Open the Windows Registry hive file named filename. If there was any previous hivex handle associated with this guestfs session, then it is @@ -14792,18 +18447,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="351"/> true on success, false on error + line="10993">true on success, false on error A GuestfsSession object + line="10977">A GuestfsSession object @@ -14815,7 +18470,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsHivexOpen containing optional arguments + line="10979">a GuestfsHivexOpen containing optional arguments @@ -14826,7 +18481,7 @@ See also guestfs_session_feature_available(). throws="1"> return the root node of the hive + line="11056">return the root node of the hive Return the root node of the hive. @@ -14835,18 +18490,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="352"/> the returned value, or -1 on error + line="11070">the returned value, or -1 on error A GuestfsSession object + line="11058">A GuestfsSession object @@ -14857,7 +18512,7 @@ See also guestfs_session_feature_available(). throws="1"> return the key field from the (key, datatype, data) tuple + line="11093">return the key field from the (key, datatype, data) tuple Return the key (name) field of a (key, datatype, data) tuple. @@ -14866,18 +18521,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="353"/> the returned string, or NULL on error + line="11108">the returned string, or NULL on error A GuestfsSession object + line="11095">A GuestfsSession object @@ -14891,7 +18546,7 @@ See also guestfs_session_feature_available(). throws="1"> return the data field as a UTF-8 string + line="11131">return the data field as a UTF-8 string This calls guestfs_session_hivex_value_value() (which returns the data field from a hivex value tuple). It then assumes that the field is a @@ -14905,18 +18560,18 @@ fields can contain arbitrary or unexpected data. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="354"/> the returned string, or NULL on error + line="11151">the returned string, or NULL on error A GuestfsSession object + line="11133">A GuestfsSession object @@ -14930,7 +18585,7 @@ See also guestfs_session_feature_available(). throws="1"> return the data type from the (key, datatype, data) tuple + line="11174">return the data type from the (key, datatype, data) tuple Return the data type field from a (key, datatype, data) tuple. @@ -14939,18 +18594,18 @@ This is a wrapper around the hivex(3) call of the same name. This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="355"/> the returned value, or -1 on error + line="11189">the returned value, or -1 on error A GuestfsSession object + line="11176">A GuestfsSession object @@ -14965,7 +18620,7 @@ See also guestfs_session_feature_available(). throws="1"> return the data field as a UTF-8 string + line="11212">return the data field as a UTF-8 string This calls guestfs_session_hivex_value_value() (which returns the data field from a hivex value tuple). It then assumes that the field is a @@ -14980,18 +18635,18 @@ This function depends on the feature "hivex". See also guestfs_session_feature_available(). In new code, use guestfs_session_hivex_value_string() instead + line="356"/> the returned string, or NULL on error + line="11232">the returned string, or NULL on error A GuestfsSession object + line="11214">A GuestfsSession object @@ -15005,7 +18660,7 @@ See also guestfs_session_feature_available(). throws="1"> return the data field from the (key, datatype, data) tuple + line="11256">return the data field from the (key, datatype, data) tuple Return the data field of a (key, datatype, data) tuple. @@ -15016,11 +18671,11 @@ See also: guestfs_session_hivex_value_utf8(). This function depends on the feature "hivex". See also guestfs_session_feature_available(). + line="357"/> an array of binary data, or NULL on error + line="11274">an array of binary data, or NULL on error @@ -15029,7 +18684,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="11258">A GuestfsSession object @@ -15041,7 +18696,7 @@ See also guestfs_session_feature_available(). transfer-ownership="full"> The size of the returned buffer, in bytes + line="11260">The size of the returned buffer, in bytes @@ -15052,7 +18707,7 @@ See also guestfs_session_feature_available(). throws="1"> list the contents of a single file in an initrd + line="11297">list the contents of a single file in an initrd This command unpacks the file filename from the initrd file called initrdpath. The filename must be given *without* the initial / @@ -15066,11 +18721,11 @@ initramfs image: See also guestfs_session_initrd_list(). + line="358"/> an array of binary data, or NULL on error + line="11319">an array of binary data, or NULL on error @@ -15079,7 +18734,7 @@ See also guestfs_session_initrd_list(). A GuestfsSession object + line="11299">A GuestfsSession object @@ -15094,7 +18749,7 @@ See also guestfs_session_initrd_list(). transfer-ownership="full"> The size of the returned buffer, in bytes + line="11302">The size of the returned buffer, in bytes @@ -15105,7 +18760,7 @@ See also guestfs_session_initrd_list(). throws="1"> list files in an initrd + line="11342">list files in an initrd This command lists out files contained in an initrd. @@ -15117,11 +18772,11 @@ Old Linux kernels (2.4 and earlier) used a compressed ext2 filesystem as initrd. We *only* support the newer initramfs format (compressed cpio files). + line="359"/> an array of returned strings, or NULL on error + line="11360">an array of returned strings, or NULL on error @@ -15130,7 +18785,7 @@ files). A GuestfsSession object + line="11344">A GuestfsSession object @@ -15144,7 +18799,7 @@ files). throws="1"> add an inotify watch + line="11383">add an inotify watch Watch @path for the events listed in @mask. @@ -15157,18 +18812,18 @@ the Linux kernel ABI and are listed in /usr/include/sys/inotify.h. This function depends on the feature "inotify". See also guestfs_session_feature_available(). + line="360"/> the returned value, or -1 on error + line="11403">the returned value, or -1 on error A GuestfsSession object + line="11385">A GuestfsSession object @@ -15185,7 +18840,7 @@ See also guestfs_session_feature_available(). throws="1"> close the inotify handle + line="11426">close the inotify handle This closes the inotify handle which was previously opened by inotify_init. It removes all watches, throws away any pending events, @@ -15194,18 +18849,18 @@ and deallocates all resources. This function depends on the feature "inotify". See also guestfs_session_feature_available(). + line="361"/> true on success, false on error + line="11440">true on success, false on error A GuestfsSession object + line="11428">A GuestfsSession object @@ -15216,7 +18871,7 @@ See also guestfs_session_feature_available(). throws="1"> return list of watched files that had events + line="11463">return list of watched files that had events This function is a helpful wrapper around guestfs_session_inotify_read() which just returns a list of pathnames of objects that were touched. The @@ -15225,11 +18880,11 @@ returned pathnames are sorted and deduplicated. This function depends on the feature "inotify". See also guestfs_session_feature_available(). + line="362"/> an array of returned strings, or NULL on error + line="11477">an array of returned strings, or NULL on error @@ -15238,7 +18893,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="11465">A GuestfsSession object @@ -15249,7 +18904,7 @@ See also guestfs_session_feature_available(). throws="1"> create an inotify handle + line="11500">create an inotify handle This command creates a new inotify handle. The inotify subsystem can be used to notify events which happen to objects in the guest filesystem. @@ -15284,18 +18939,18 @@ Note that there is one global inotify handle per libguestfs instance. This function depends on the feature "inotify". See also guestfs_session_feature_available(). + line="363"/> true on success, false on error + line="11541">true on success, false on error A GuestfsSession object + line="11502">A GuestfsSession object @@ -15309,7 +18964,7 @@ See also guestfs_session_feature_available(). throws="1"> return list of inotify events + line="11564">return list of inotify events Return the complete queue of events that have happened since the previous read call. @@ -15324,11 +18979,11 @@ message size and leave remaining events in the queue. This function depends on the feature "inotify". See also guestfs_session_feature_available(). + line="364"/> an array of INotifyEvent objects, or NULL on error + line="11584">an array of INotifyEvent objects, or NULL on error @@ -15337,7 +18992,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="11566">A GuestfsSession object @@ -15348,7 +19003,7 @@ See also guestfs_session_feature_available(). throws="1"> remove an inotify watch + line="11618">remove an inotify watch Remove a previously defined inotify watch. See guestfs_session_inotify_add_watch(). @@ -15356,18 +19011,18 @@ guestfs_session_inotify_add_watch(). This function depends on the feature "inotify". See also guestfs_session_feature_available(). + line="365"/> true on success, false on error + line="11632">true on success, false on error A GuestfsSession object + line="11620">A GuestfsSession object @@ -15381,7 +19036,7 @@ See also guestfs_session_feature_available(). throws="1"> get architecture of inspected operating system + line="11655">get architecture of inspected operating system This returns the architecture of the inspected operating system. The possible return values are listed under @@ -15392,18 +19047,59 @@ returned. Please read "INSPECTION" in guestfs(3) for more details. + line="366"/> + + the returned string, or NULL on error + + + + + A GuestfsSession object + + + + + + + + + get the system build ID + +This returns the build ID of the system, or the string "unknown" if the +system does not have a build ID. + +For Windows, this gets the build number. Although it is returned as a +string, it is (so far) always a number. See <ulink +url='https://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions'> +http://en.wikipedia.org/wiki/List_of_Microsoft_Windows_versions </ulink> +for some possible values. + +For Linux, this returns the @BUILD_ID string from /etc/os-release, +although this is not often used. + +Please read "INSPECTION" in guestfs(3) for more details. + the returned string, or NULL on error + line="11717">the returned string, or NULL on error A GuestfsSession object + line="11697">A GuestfsSession object @@ -15417,7 +19113,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get distro of inspected operating system + line="11740">get distro of inspected operating system This returns the distro (distribution) of the inspected operating system. @@ -15466,6 +19162,9 @@ Gentoo. "kalilinux" Kali Linux. +"kylin" +Kylin. + "linuxmint" Linux Mint. @@ -15490,6 +19189,9 @@ NetBSD. "openbsd" OpenBSD. +"openmandriva" +OpenMandriva Lx. + "opensuse" OpenSUSE. @@ -15508,6 +19210,9 @@ Some Red Hat-derived distro. "rhel" Red Hat Enterprise Linux. +"rocky" +Rocky Linux. + "scientificlinux" Scientific Linux. @@ -15541,18 +19246,18 @@ should be prepared to handle any string. Please read "INSPECTION" in guestfs(3) for more details. + line="368"/> the returned string, or NULL on error + line="11879">the returned string, or NULL on error A GuestfsSession object + line="11742">A GuestfsSession object @@ -15566,7 +19271,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get drive letter mappings + line="11902">get drive letter mappings This call is useful for Windows which uses a primitive system of assigning drive letters (like C:\) to partitions. This inspection API @@ -15599,11 +19304,11 @@ Please read "INSPECTION" in guestfs(3) for more details. See also guestfs_session_inspect_get_mountpoints(), guestfs_session_inspect_get_filesystems(). + line="369"/> a GHashTable of results, or NULL on error + line="11941">a GHashTable of results, or NULL on error @@ -15613,7 +19318,7 @@ guestfs_session_inspect_get_filesystems(). A GuestfsSession object + line="11904">A GuestfsSession object @@ -15627,7 +19332,7 @@ guestfs_session_inspect_get_filesystems(). throws="1"> get filesystems associated with inspected operating system + line="11972">get filesystems associated with inspected operating system This returns a list of all the filesystems that we think are associated with this operating system. This includes the root filesystem, other @@ -15639,11 +19344,11 @@ filesystem to be shared between operating systems. Please read "INSPECTION" in guestfs(3) for more details. See also guestfs_session_inspect_get_mountpoints(). + line="370"/> an array of returned strings, or NULL on error + line="11990">an array of returned strings, or NULL on error @@ -15652,7 +19357,7 @@ guestfs_session_inspect_get_mountpoints(). A GuestfsSession object + line="11974">A GuestfsSession object @@ -15667,19 +19372,19 @@ guestfs_session_inspect_get_mountpoints(). throws="1"> get format of inspected operating system + line="12013">get format of inspected operating system Before libguestfs 1.38, there was some unreliable support for detecting installer CDs. This API would return: -"installed" +@installed This is an installed operating system. -"installer" +@installer The disk image being inspected is not an installed operating system, but a *bootable* install disk, live CD, or similar. -"unknown" +@unknown The format of this disk image is not known. In libguestfs &ge; 1.38, this only returns @installed. Use libosinfo @@ -15688,18 +19393,18 @@ directly to detect installer CDs. Please read "INSPECTION" in guestfs(3) for more details. There is no documented replacement + line="371"/> the returned string, or NULL on error + line="12039">the returned string, or NULL on error A GuestfsSession object + line="12015">A GuestfsSession object @@ -15713,7 +19418,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get hostname of the operating system + line="12063">get hostname of the operating system This function returns the hostname of the operating system as found by inspection of the guest’s configuration files. @@ -15723,18 +19428,18 @@ returned. Please read "INSPECTION" in guestfs(3) for more details. + line="372"/> the returned string, or NULL on error + line="12079">the returned string, or NULL on error A GuestfsSession object + line="12065">A GuestfsSession object @@ -15748,7 +19453,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get the icon corresponding to this operating system + line="12102">get the icon corresponding to this operating system This function returns an icon corresponding to the inspected operating system. The icon is returned as a buffer containing a PNG image @@ -15785,19 +19490,19 @@ up to date before trying to process or display the icon. Libguestfs tries to return the largest, highest quality icon available. The application must scale the icon to the required size. -* Extracting icons from Windows guests requires the external @wrestool -program from the @icoutils package, and several programs (@bmptopnm, -@pnmtopng, @pamcut) from the @netpbm package. These must be -installed separately. +* Extracting icons from Windows guests requires the external +wrestool(1) program from the @icoutils package, and several programs +(bmptopnm(1), pnmtopng(1), pamcut(1)) from the @netpbm package. +These must be installed separately. * Operating system icons are usually trademarks. Seek legal advice before using trademarks in applications. + line="373"/> an array of binary data, or NULL on error + line="12155">an array of binary data, or NULL on error @@ -15806,7 +19511,7 @@ before using trademarks in applications. A GuestfsSession object + line="12104">A GuestfsSession object @@ -15818,7 +19523,7 @@ before using trademarks in applications. allow-none="1"> a GuestfsInspectGetIcon containing optional arguments + line="12106">a GuestfsInspectGetIcon containing optional arguments transfer-ownership="full"> The size of the returned buffer, in bytes + line="12107">The size of the returned buffer, in bytes @@ -15838,7 +19543,7 @@ before using trademarks in applications. throws="1"> get major version of inspected operating system + line="12202">get major version of inspected operating system This returns the major version number of the inspected operating system. @@ -15852,18 +19557,18 @@ If the version could not be determined, then @0 is returned. Please read "INSPECTION" in guestfs(3) for more details. + line="374"/> the returned value, or -1 on error + line="12222">the returned value, or -1 on error A GuestfsSession object + line="12204">A GuestfsSession object @@ -15877,7 +19582,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get minor version of inspected operating system + line="12245">get minor version of inspected operating system This returns the minor version number of the inspected operating system. @@ -15886,18 +19591,18 @@ If the version could not be determined, then @0 is returned. Please read "INSPECTION" in guestfs(3) for more details. See also guestfs_session_inspect_get_major_version(). + line="375"/> the returned value, or -1 on error + line="12260">the returned value, or -1 on error A GuestfsSession object + line="12247">A GuestfsSession object @@ -15911,7 +19616,7 @@ guestfs_session_inspect_get_major_version(). throws="1"> get mountpoints of inspected operating system + line="12283">get mountpoints of inspected operating system This returns a hash of where we think the filesystems associated with this operating system should be mounted. Callers should note that this @@ -15935,11 +19640,11 @@ guestfs_session_inspect_get_drive_mappings(). Please read "INSPECTION" in guestfs(3) for more details. See also guestfs_session_inspect_get_filesystems(). + line="376"/> a GHashTable of results, or NULL on error + line="12313">a GHashTable of results, or NULL on error @@ -15949,7 +19654,7 @@ guestfs_session_inspect_get_filesystems(). A GuestfsSession object + line="12285">A GuestfsSession object @@ -15963,7 +19668,7 @@ guestfs_session_inspect_get_filesystems(). throws="1"> get a possible osinfo short ID corresponding to this operating system + line="12344">get a possible osinfo short ID corresponding to this operating system This function returns a possible short ID for libosinfo corresponding to the guest. @@ -15973,18 +19678,18 @@ ensures that it actually exists in osinfo-db. If no ID could not be determined, then the string @unknown is returned. + line="377"/> the returned string, or NULL on error + line="12360">the returned string, or NULL on error A GuestfsSession object + line="12346">A GuestfsSession object @@ -15998,7 +19703,7 @@ If no ID could not be determined, then the string @unknown is returned. throws="1"> get package format used by the operating system + line="12383">get package format used by the operating system This function and guestfs_session_inspect_get_package_management() return the package format and package management tool used by the @@ -16014,18 +19719,18 @@ Possible strings include: @rpm, @deb, @ebuild, @pisi, @pacman, @pkgsrc, Please read "INSPECTION" in guestfs(3) for more details. + line="378"/> the returned string, or NULL on error + line="12405">the returned string, or NULL on error A GuestfsSession object + line="12385">A GuestfsSession object @@ -16039,7 +19744,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get package management tool used by the operating system + line="12428">get package management tool used by the operating system guestfs_session_inspect_get_package_format() and this function return the package format and package management tool used by the inspected @@ -16056,18 +19761,18 @@ Future versions of libguestfs may return other strings. Please read "INSPECTION" in guestfs(3) for more details. + line="379"/> the returned string, or NULL on error + line="12451">the returned string, or NULL on error A GuestfsSession object + line="12430">A GuestfsSession object @@ -16081,7 +19786,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get product name of inspected operating system + line="12474">get product name of inspected operating system This returns the product name of the inspected operating system. The product name is generally some freeform string which can be displayed to @@ -16092,18 +19797,18 @@ returned. Please read "INSPECTION" in guestfs(3) for more details. + line="380"/> the returned string, or NULL on error + line="12491">the returned string, or NULL on error A GuestfsSession object + line="12476">A GuestfsSession object @@ -16117,7 +19822,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get product variant of inspected operating system + line="12514">get product variant of inspected operating system This returns the product variant of the inspected operating system. @@ -16140,18 +19845,18 @@ Please read "INSPECTION" in guestfs(3) for more details. See also guestfs_session_inspect_get_product_name(), guestfs_session_inspect_get_major_version(). + line="381"/> the returned string, or NULL on error + line="12543">the returned string, or NULL on error A GuestfsSession object + line="12516">A GuestfsSession object @@ -16165,7 +19870,7 @@ guestfs_session_inspect_get_major_version(). throws="1"> return list of operating systems found by last inspection + line="12566">return list of operating systems found by last inspection This function is a convenient way to get the list of root devices, as returned from a previous call to guestfs_session_inspect_os(), but @@ -16176,11 +19881,11 @@ caller has not called guestfs_session_inspect_os(). Please read "INSPECTION" in guestfs(3) for more details. + line="382"/> an array of returned strings, or NULL on error + line="12582">an array of returned strings, or NULL on error @@ -16189,7 +19894,7 @@ Please read "INSPECTION" in guestfs(3) for more details. A GuestfsSession object + line="12568">A GuestfsSession object @@ -16200,7 +19905,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get type of inspected operating system + line="12605">get type of inspected operating system This returns the type of the inspected operating system. Currently defined types are: @@ -16237,18 +19942,18 @@ should be prepared to handle any string. Please read "INSPECTION" in guestfs(3) for more details. + line="383"/> the returned string, or NULL on error + line="12648">the returned string, or NULL on error A GuestfsSession object + line="12607">A GuestfsSession object @@ -16262,7 +19967,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get Windows CurrentControlSet of inspected operating system + line="12671">get Windows CurrentControlSet of inspected operating system This returns the Windows CurrentControlSet of the inspected guest. The CurrentControlSet is a registry key name such as @ControlSet001. @@ -16273,18 +19978,18 @@ returned. Please read "INSPECTION" in guestfs(3) for more details. + line="384"/> the returned string, or NULL on error + line="12688">the returned string, or NULL on error A GuestfsSession object + line="12673">A GuestfsSession object @@ -16298,7 +20003,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get the path of the Windows software hive + line="12711">get the path of the Windows software hive This returns the path to the hive (binary Windows Registry file) corresponding to HKLM\SOFTWARE. @@ -16312,18 +20017,18 @@ You can use guestfs_session_hivex_open() to read or write to the hive. Please read "INSPECTION" in guestfs(3) for more details. + line="385"/> the returned string, or NULL on error + line="12731">the returned string, or NULL on error A GuestfsSession object + line="12713">A GuestfsSession object @@ -16337,7 +20042,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get the path of the Windows system hive + line="12754">get the path of the Windows system hive This returns the path to the hive (binary Windows Registry file) corresponding to HKLM\SYSTEM. @@ -16351,18 +20056,18 @@ You can use guestfs_session_hivex_open() to read or write to the hive. Please read "INSPECTION" in guestfs(3) for more details. + line="386"/> the returned string, or NULL on error + line="12774">the returned string, or NULL on error A GuestfsSession object + line="12756">A GuestfsSession object @@ -16376,7 +20081,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get Windows systemroot of inspected operating system + line="12797">get Windows systemroot of inspected operating system This returns the Windows systemroot of the inspected guest. The systemroot is a directory path such as /WINDOWS. @@ -16387,18 +20092,18 @@ is returned. Please read "INSPECTION" in guestfs(3) for more details. + line="387"/> the returned string, or NULL on error + line="12814">the returned string, or NULL on error A GuestfsSession object + line="12799">A GuestfsSession object @@ -16413,25 +20118,25 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get live flag for install disk + line="12837">get live flag for install disk This is deprecated and always returns @false. Please read "INSPECTION" in guestfs(3) for more details. There is no documented replacement + line="388"/> the returned value, or -1 on error + line="12849">the returned value, or -1 on error A GuestfsSession object + line="12839">A GuestfsSession object @@ -16446,25 +20151,25 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get multipart flag for install disk + line="12873">get multipart flag for install disk This is deprecated and always returns @false. Please read "INSPECTION" in guestfs(3) for more details. There is no documented replacement + line="389"/> the returned value, or -1 on error + line="12885">the returned value, or -1 on error A GuestfsSession object + line="12875">A GuestfsSession object @@ -16479,25 +20184,25 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get netinst (network installer) flag for install disk + line="12909">get netinst (network installer) flag for install disk This is deprecated and always returns @false. Please read "INSPECTION" in guestfs(3) for more details. There is no documented replacement + line="390"/> the returned value, or -1 on error + line="12921">the returned value, or -1 on error A GuestfsSession object + line="12911">A GuestfsSession object @@ -16512,7 +20217,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get list of applications installed in the operating system + line="12945">get list of applications installed in the operating system Return the list of applications installed in the operating system. @@ -16531,8 +20236,8 @@ determine the list of applications. The application structure contains the following fields: @app_name -The name of the application. For Red Hat-derived and Debian-derived -Linux guests, this is the package name. +The name of the application. For Linux guests, this is the package +name. @app_display_name The display name of the application, sometimes localized to the @@ -16589,11 +20294,11 @@ this is returned as an empty string "". Please read "INSPECTION" in guestfs(3) for more details. In new code, use guestfs_session_inspect_list_applications2() instead + line="391"/> an array of Application objects, or NULL on error + line="13027">an array of Application objects, or NULL on error @@ -16602,7 +20307,7 @@ Please read "INSPECTION" in guestfs(3) for more details. A GuestfsSession object + line="12947">A GuestfsSession object @@ -16616,7 +20321,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> get list of applications installed in the operating system + line="13070">get list of applications installed in the operating system Return the list of applications installed in the operating system. @@ -16635,8 +20340,8 @@ determine the list of applications. The application structure contains the following fields: @app2_name -The name of the application. For Red Hat-derived and Debian-derived -Linux guests, this is the package name. +The name of the application. For Linux guests, this is the package +name. @app2_display_name The display name of the application, sometimes localized to the @@ -16697,11 +20402,11 @@ this is returned as an empty string "". Please read "INSPECTION" in guestfs(3) for more details. + line="392"/> an array of Application2 objects, or NULL on error + line="13157">an array of Application2 objects, or NULL on error @@ -16710,7 +20415,7 @@ Please read "INSPECTION" in guestfs(3) for more details. A GuestfsSession object + line="13072">A GuestfsSession object @@ -16724,7 +20429,7 @@ Please read "INSPECTION" in guestfs(3) for more details. throws="1"> inspect disk and return list of operating systems found + line="13204">inspect disk and return list of operating systems found This function uses other libguestfs functions and certain heuristics to inspect the disk(s) (usually disks belonging to a virtual machine), @@ -16756,11 +20461,11 @@ Please read "INSPECTION" in guestfs(3) for more details. See also guestfs_session_list_filesystems(). + line="393"/> an array of returned strings, or NULL on error + line="13241">an array of returned strings, or NULL on error @@ -16769,7 +20474,7 @@ See also guestfs_session_list_filesystems(). A GuestfsSession object + line="13206">A GuestfsSession object @@ -16780,22 +20485,22 @@ See also guestfs_session_list_filesystems(). throws="1"> cause the daemon to exit (internal use only) + line="13264">cause the daemon to exit (internal use only) This function is used internally when testing the appliance. + line="394"/> true on success, false on error + line="13274">true on success, false on error A GuestfsSession object + line="13266">A GuestfsSession object allow-none="1"> A GCancellable object + line="13267">A GCancellable object @@ -16814,7 +20519,7 @@ This function is used internally when testing the appliance. throws="1"> internal test function - do not use + line="13309">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible parameter @@ -16825,18 +20530,18 @@ file (if guestfs_session_internal_test_set_output() was called). You probably don't want to call this function. + line="395"/> true on success, false on error + line="13337">true on success, false on error A GuestfsSession object + line="13311">A GuestfsSession object @@ -16851,7 +20556,7 @@ You probably don't want to call this function. an array of strings + line="13314">an array of strings @@ -16874,7 +20579,7 @@ You probably don't want to call this function. an array of binary data + line="13320">an array of binary data @@ -16882,7 +20587,7 @@ You probably don't want to call this function. The size of bufferin, in bytes + line="13321">The size of bufferin, in bytes allow-none="1"> a GuestfsInternalTest containing optional arguments + line="13322">a GuestfsInternalTest containing optional arguments allow-none="1"> A GCancellable object + line="13323">A GCancellable object @@ -16910,7 +20615,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="13411">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle the full range of 63 optargs @@ -16922,18 +20627,18 @@ file (if guestfs_session_internal_test_set_output() was called). You probably don't want to call this function. + line="396"/> true on success, false on error + line="13430">true on success, false on error A GuestfsSession object + line="13413">A GuestfsSession object allow-none="1"> a GuestfsInternalTest63Optargs containing optional arguments + line="13414">a GuestfsInternalTest63Optargs containing optional arguments @@ -16952,7 +20657,7 @@ You probably don't want to call this function. allow-none="1"> A GCancellable object + line="13415">A GCancellable object @@ -16962,7 +20667,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="13976">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible parameter @@ -16973,18 +20678,18 @@ guestfs_session_internal_test_set_output(). You probably don't want to call this function. + line="397"/> true on success, false on error + line="13992">true on success, false on error A GuestfsSession object + line="13978">A GuestfsSession object @@ -16994,7 +20699,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14014">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle no args, some optargs @@ -17005,18 +20710,18 @@ file (if guestfs_session_internal_test_set_output() was called). You probably don't want to call this function. + line="398"/> true on success, false on error + line="14032">true on success, false on error A GuestfsSession object + line="14016">A GuestfsSession object allow-none="1"> a GuestfsInternalTestOnlyOptargs containing optional arguments + line="14017">a GuestfsInternalTestOnlyOptargs containing optional arguments @@ -17035,7 +20740,7 @@ You probably don't want to call this function. allow-none="1"> A GCancellable object + line="14018">A GCancellable object @@ -17045,7 +20750,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14082">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17055,18 +20760,18 @@ It converts string @val to the return type. You probably don't want to call this function. + line="399"/> the returned value, or -1 on error + line="14098">the returned value, or -1 on error A GuestfsSession object + line="14084">A GuestfsSession object @@ -17079,7 +20784,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14120">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17089,18 +20794,18 @@ This function always returns an error. You probably don't want to call this function. + line="400"/> the returned value, or -1 on error + line="14135">the returned value, or -1 on error A GuestfsSession object + line="14122">A GuestfsSession object @@ -17110,7 +20815,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14157">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17120,11 +20825,11 @@ It converts string @val to the return type. You probably don't want to call this function. + line="401"/> an array of binary data, or NULL on error + line="14174">an array of binary data, or NULL on error @@ -17133,7 +20838,7 @@ You probably don't want to call this function. A GuestfsSession object + line="14159">A GuestfsSession object @@ -17145,7 +20850,7 @@ You probably don't want to call this function. transfer-ownership="full"> The size of the returned buffer, in bytes + line="14161">The size of the returned buffer, in bytes @@ -17155,7 +20860,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14196">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17165,11 +20870,11 @@ This function always returns an error. You probably don't want to call this function. + line="402"/> an array of binary data, or NULL on error + line="14212">an array of binary data, or NULL on error @@ -17178,7 +20883,7 @@ You probably don't want to call this function. A GuestfsSession object + line="14198">A GuestfsSession object transfer-ownership="full"> The size of the returned buffer, in bytes + line="14199">The size of the returned buffer, in bytes @@ -17197,7 +20902,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14234">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17207,18 +20912,18 @@ It converts string @val to the return type. You probably don't want to call this function. + line="403"/> the returned string. Note that NULL does not indicate error + line="14250">the returned string. Note that NULL does not indicate error A GuestfsSession object + line="14236">A GuestfsSession object @@ -17231,7 +20936,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14268">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17241,18 +20946,18 @@ This function always returns an error. You probably don't want to call this function. + line="404"/> the returned string. Note that NULL does not indicate error + line="14283">the returned string. Note that NULL does not indicate error A GuestfsSession object + line="14270">A GuestfsSession object @@ -17262,7 +20967,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14301">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17272,18 +20977,18 @@ It converts string @val to the return type. You probably don't want to call this function. + line="405"/> the returned string, or NULL on error + line="14317">the returned string, or NULL on error A GuestfsSession object + line="14303">A GuestfsSession object @@ -17296,7 +21001,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14339">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17306,18 +21011,18 @@ This function always returns an error. You probably don't want to call this function. + line="406"/> the returned string, or NULL on error + line="14354">the returned string, or NULL on error A GuestfsSession object + line="14341">A GuestfsSession object @@ -17327,7 +21032,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14376">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17337,11 +21042,11 @@ It converts string @val to the return type. You probably don't want to call this function. + line="407"/> a GHashTable of results, or NULL on error + line="14392">a GHashTable of results, or NULL on error @@ -17351,7 +21056,7 @@ You probably don't want to call this function. A GuestfsSession object + line="14378">A GuestfsSession object @@ -17364,7 +21069,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14422">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17374,11 +21079,11 @@ This function always returns an error. You probably don't want to call this function. + line="408"/> a GHashTable of results, or NULL on error + line="14437">a GHashTable of results, or NULL on error @@ -17388,7 +21093,7 @@ You probably don't want to call this function. A GuestfsSession object + line="14424">A GuestfsSession object @@ -17398,7 +21103,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14467">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17408,18 +21113,18 @@ It converts string @val to the return type. You probably don't want to call this function. + line="409"/> the returned value, or -1 on error + line="14483">the returned value, or -1 on error A GuestfsSession object + line="14469">A GuestfsSession object @@ -17432,7 +21137,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14505">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17442,18 +21147,18 @@ It converts string @val to the return type. You probably don't want to call this function. + line="410"/> the returned value, or -1 on error + line="14521">the returned value, or -1 on error A GuestfsSession object + line="14507">A GuestfsSession object @@ -17466,7 +21171,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14543">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17476,18 +21181,18 @@ This function always returns an error. You probably don't want to call this function. + line="411"/> the returned value, or -1 on error + line="14558">the returned value, or -1 on error A GuestfsSession object + line="14545">A GuestfsSession object @@ -17497,7 +21202,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14580">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17507,18 +21212,18 @@ This function always returns an error. You probably don't want to call this function. + line="412"/> the returned value, or -1 on error + line="14595">the returned value, or -1 on error A GuestfsSession object + line="14582">A GuestfsSession object @@ -17528,7 +21233,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14617">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17538,18 +21243,18 @@ It converts string @val to the return type. You probably don't want to call this function. + line="413"/> the returned string, or NULL on error + line="14633">the returned string, or NULL on error A GuestfsSession object + line="14619">A GuestfsSession object @@ -17562,7 +21267,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14655">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17572,18 +21277,18 @@ This function always returns an error. You probably don't want to call this function. + line="414"/> the returned string, or NULL on error + line="14670">the returned string, or NULL on error A GuestfsSession object + line="14657">A GuestfsSession object @@ -17593,7 +21298,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14692">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17603,11 +21308,11 @@ It converts string @val to the return type. You probably don't want to call this function. + line="415"/> an array of returned strings, or NULL on error + line="14708">an array of returned strings, or NULL on error @@ -17616,7 +21321,7 @@ You probably don't want to call this function. A GuestfsSession object + line="14694">A GuestfsSession object @@ -17629,7 +21334,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14730">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17639,11 +21344,11 @@ This function always returns an error. You probably don't want to call this function. + line="416"/> an array of returned strings, or NULL on error + line="14745">an array of returned strings, or NULL on error @@ -17652,7 +21357,7 @@ You probably don't want to call this function. A GuestfsSession object + line="14732">A GuestfsSession object @@ -17662,7 +21367,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14767">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17672,18 +21377,18 @@ It converts string @val to the return type. You probably don't want to call this function. + line="417"/> a PV object, or NULL on error + line="14783">a PV object, or NULL on error A GuestfsSession object + line="14769">A GuestfsSession object @@ -17696,7 +21401,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14821">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17706,18 +21411,18 @@ This function always returns an error. You probably don't want to call this function. + line="418"/> a PV object, or NULL on error + line="14836">a PV object, or NULL on error A GuestfsSession object + line="14823">A GuestfsSession object @@ -17727,7 +21432,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14874">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17737,11 +21442,11 @@ It converts string @val to the return type. You probably don't want to call this function. + line="419"/> an array of PV objects, or NULL on error + line="14890">an array of PV objects, or NULL on error @@ -17750,7 +21455,7 @@ You probably don't want to call this function. A GuestfsSession object + line="14876">A GuestfsSession object @@ -17763,7 +21468,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14933">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible return type @@ -17773,11 +21478,11 @@ This function always returns an error. You probably don't want to call this function. + line="420"/> an array of PV objects, or NULL on error + line="14948">an array of PV objects, or NULL on error @@ -17786,7 +21491,7 @@ You probably don't want to call this function. A GuestfsSession object + line="14935">A GuestfsSession object @@ -17796,7 +21501,7 @@ You probably don't want to call this function. throws="1"> internal test function - do not use + line="14991">internal test function - do not use This is an internal test function which is used to test whether the automatically generated bindings can handle every possible parameter @@ -17806,18 +21511,18 @@ It sets the output file used by guestfs_session_internal_test(). You probably don't want to call this function. + line="421"/> true on success, false on error + line="15007">true on success, false on error A GuestfsSession object + line="14993">A GuestfsSession object @@ -17831,7 +21536,7 @@ You probably don't want to call this function. throws="1"> test if block device + line="15029">test if block device This returns @true if and only if there is a block device with the given @path name. @@ -17846,18 +21551,18 @@ parameter of this call. See also guestfs_session_stat(). + line="422"/> the returned value, or -1 on error + line="15051">the returned value, or -1 on error A GuestfsSession object + line="15031">A GuestfsSession object @@ -17869,7 +21574,7 @@ See also guestfs_session_stat(). allow-none="1"> a GuestfsIsBlockdev containing optional arguments + line="15033">a GuestfsIsBlockdev containing optional arguments @@ -17880,25 +21585,25 @@ See also guestfs_session_stat(). throws="1"> is busy processing a command + line="15090">is busy processing a command This always returns false. This function is deprecated with no replacement. Do not use this function. For more information on states, see guestfs(3). + line="423"/> the returned value, or -1 on error + line="15102">the returned value, or -1 on error A GuestfsSession object + line="15092">A GuestfsSession object @@ -17909,7 +21614,7 @@ For more information on states, see guestfs(3). throws="1"> test if character device + line="15125">test if character device This returns @true if and only if there is a character device with the given @path name. @@ -17920,18 +21625,18 @@ true. See also guestfs_session_stat(). + line="424"/> the returned value, or -1 on error + line="15143">the returned value, or -1 on error A GuestfsSession object + line="15127">A GuestfsSession object @@ -17943,7 +21648,7 @@ See also guestfs_session_stat(). allow-none="1"> a GuestfsIsChardev containing optional arguments + line="15129">a GuestfsIsChardev containing optional arguments @@ -17954,25 +21659,25 @@ See also guestfs_session_stat(). throws="1"> is in configuration state + line="15182">is in configuration state This returns true iff this handle is being configured (in the @CONFIG state). For more information on states, see guestfs(3). + line="425"/> the returned value, or -1 on error + line="15194">the returned value, or -1 on error A GuestfsSession object + line="15184">A GuestfsSession object @@ -17983,7 +21688,7 @@ For more information on states, see guestfs(3). throws="1"> test if a directory + line="15217">test if a directory This returns @true if and only if there is a directory with the given @path name. Note that it returns false for other objects like files. @@ -17994,18 +21699,18 @@ return true. See also guestfs_session_stat(). + line="426"/> the returned value, or -1 on error + line="15235">the returned value, or -1 on error A GuestfsSession object + line="15219">A GuestfsSession object @@ -18017,7 +21722,7 @@ See also guestfs_session_stat(). allow-none="1"> a GuestfsIsDir containing optional arguments + line="15221">a GuestfsIsDir containing optional arguments @@ -18028,7 +21733,7 @@ See also guestfs_session_stat(). throws="1"> test if FIFO (named pipe) + line="15274">test if FIFO (named pipe) This returns @true if and only if there is a FIFO (named pipe) with the given @path name. @@ -18039,18 +21744,18 @@ true. See also guestfs_session_stat(). + line="427"/> the returned value, or -1 on error + line="15292">the returned value, or -1 on error A GuestfsSession object + line="15276">A GuestfsSession object @@ -18062,7 +21767,7 @@ See also guestfs_session_stat(). allow-none="1"> a GuestfsIsFifo containing optional arguments + line="15278">a GuestfsIsFifo containing optional arguments @@ -18073,7 +21778,7 @@ See also guestfs_session_stat(). throws="1"> test if a regular file + line="15331">test if a regular file This returns @true if and only if there is a regular file with the given @path name. Note that it returns false for other objects like @@ -18085,18 +21790,18 @@ true. See also guestfs_session_stat(). + line="428"/> the returned value, or -1 on error + line="15350">the returned value, or -1 on error A GuestfsSession object + line="15333">A GuestfsSession object @@ -18108,7 +21813,7 @@ See also guestfs_session_stat(). allow-none="1"> a GuestfsIsFile containing optional arguments + line="15335">a GuestfsIsFile containing optional arguments @@ -18119,25 +21824,25 @@ See also guestfs_session_stat(). throws="1"> is launching subprocess + line="15389">is launching subprocess This returns true iff this handle is launching the subprocess (in the @LAUNCHING state). For more information on states, see guestfs(3). + line="429"/> the returned value, or -1 on error + line="15401">the returned value, or -1 on error A GuestfsSession object + line="15391">A GuestfsSession object @@ -18148,23 +21853,23 @@ For more information on states, see guestfs(3). throws="1"> test if mountable is a logical volume + line="15424">test if mountable is a logical volume This command tests whether @mountable is a logical volume, and returns true iff this is the case. + line="430"/> the returned value, or -1 on error + line="15435">the returned value, or -1 on error A GuestfsSession object + line="15426">A GuestfsSession object @@ -18178,25 +21883,25 @@ true iff this is the case. throws="1"> is ready to accept commands + line="15458">is ready to accept commands This returns true iff this handle is ready to accept commands (in the @READY state). For more information on states, see guestfs(3). + line="431"/> the returned value, or -1 on error + line="15470">the returned value, or -1 on error A GuestfsSession object + line="15460">A GuestfsSession object @@ -18207,7 +21912,7 @@ For more information on states, see guestfs(3). throws="1"> test if socket + line="15493">test if socket This returns @true if and only if there is a Unix domain socket with the given @path name. @@ -18218,18 +21923,18 @@ true. See also guestfs_session_stat(). + line="432"/> the returned value, or -1 on error + line="15511">the returned value, or -1 on error A GuestfsSession object + line="15495">A GuestfsSession object @@ -18241,7 +21946,7 @@ See also guestfs_session_stat(). allow-none="1"> a GuestfsIsSocket containing optional arguments + line="15497">a GuestfsIsSocket containing optional arguments @@ -18252,25 +21957,25 @@ See also guestfs_session_stat(). throws="1"> test if symbolic link + line="15550">test if symbolic link This returns @true if and only if there is a symbolic link with the given @path name. See also guestfs_session_stat(). + line="433"/> the returned value, or -1 on error + line="15563">the returned value, or -1 on error A GuestfsSession object + line="15552">A GuestfsSession object @@ -18284,23 +21989,23 @@ See also guestfs_session_stat(). throws="1"> test if a device is a whole device + line="15586">test if a device is a whole device This returns @true if and only if @device refers to a whole block device. That is, not a partition or a logical device. + line="434"/> the returned value, or -1 on error + line="15597">the returned value, or -1 on error A GuestfsSession object + line="15588">A GuestfsSession object @@ -18314,23 +22019,23 @@ device. That is, not a partition or a logical device. throws="1"> test if a file contains all zero bytes + line="15620">test if a file contains all zero bytes This returns true iff the file exists and the file is empty or it contains all zero bytes. + line="435"/> the returned value, or -1 on error + line="15631">the returned value, or -1 on error A GuestfsSession object + line="15622">A GuestfsSession object @@ -18344,24 +22049,24 @@ contains all zero bytes. throws="1"> test if a device contains all zero bytes + line="15654">test if a device contains all zero bytes This returns true iff the device exists and contains all zero bytes. Note that for large devices this can take a long time to run. + line="436"/> the returned value, or -1 on error + line="15666">the returned value, or -1 on error A GuestfsSession object + line="15656">A GuestfsSession object @@ -18375,7 +22080,7 @@ Note that for large devices this can take a long time to run. throws="1"> get ISO information from primary volume descriptor of ISO file + line="15689">get ISO information from primary volume descriptor of ISO file This is the same as guestfs_session_isoinfo_device() except that it works for an ISO file located inside some other mounted filesystem. Note @@ -18383,18 +22088,18 @@ that in the common case where you have added an ISO file as a libguestfs device, you would *not* call this. Instead you would call guestfs_session_isoinfo_device(). + line="437"/> a ISOInfo object, or NULL on error + line="15703">a ISOInfo object, or NULL on error A GuestfsSession object + line="15691">A GuestfsSession object @@ -18408,7 +22113,7 @@ guestfs_session_isoinfo_device(). throws="1"> get ISO information from primary volume descriptor of device + line="15745">get ISO information from primary volume descriptor of device @device is an ISO device. This returns a struct of information read from the primary volume descriptor (the ISO equivalent of the superblock) of @@ -18419,21 +22124,21 @@ option on the host to analyze ISO files, instead of going through libguestfs. For information on the primary volume descriptor fields, see <ulink -url='http://wiki.osdev.org/ISO_9660#The_Primary_Volume_Descriptor'> +url='https://wiki.osdev.org/ISO_9660#The_Primary_Volume_Descriptor'> http://wiki.osdev.org/ISO_9660#The_Primary_Volume_Descriptor </ulink> + line="438"/> a ISOInfo object, or NULL on error + line="15765">a ISOInfo object, or NULL on error A GuestfsSession object + line="15747">A GuestfsSession object @@ -18447,25 +22152,25 @@ http://wiki.osdev.org/ISO_9660#The_Primary_Volume_Descriptor </ulink> close the systemd journal + line="15807">close the systemd journal Close the journal handle. This function depends on the feature "journal". See also guestfs_session_feature_available(). + line="439"/> true on success, false on error + line="15819">true on success, false on error A GuestfsSession object + line="15809">A GuestfsSession object @@ -18476,7 +22181,7 @@ See also guestfs_session_feature_available(). throws="1"> read the current journal entry + line="15842">read the current journal entry Read the current journal entry. This returns all the fields in the journal as a set of "(attrname, attrval)" pairs. The @attrname is the @@ -18497,11 +22202,11 @@ protocol. This function depends on the feature "journal". See also guestfs_session_feature_available(). + line="440"/> an array of XAttr objects, or NULL on error + line="15868">an array of XAttr objects, or NULL on error @@ -18510,7 +22215,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="15844">A GuestfsSession object @@ -18521,7 +22226,7 @@ See also guestfs_session_feature_available(). throws="1"> get the data threshold for reading journal entries + line="15903">get the data threshold for reading journal entries Get the current data threshold for reading journal entries. This is a hint to the journal that it may truncate data fields to this size when @@ -18533,18 +22238,18 @@ See also guestfs_session_journal_set_data_threshold(). This function depends on the feature "journal". See also guestfs_session_feature_available(). + line="441"/> the returned value, or -1 on error + line="15920">the returned value, or -1 on error A GuestfsSession object + line="15905">A GuestfsSession object @@ -18555,25 +22260,25 @@ See also guestfs_session_feature_available(). throws="1"> get the timestamp of the current journal entry + line="15943">get the timestamp of the current journal entry Get the realtime (wallclock) timestamp of the current journal entry. This function depends on the feature "journal". See also guestfs_session_feature_available(). + line="442"/> the returned value, or -1 on error + line="15955">the returned value, or -1 on error A GuestfsSession object + line="15945">A GuestfsSession object @@ -18584,7 +22289,7 @@ See also guestfs_session_feature_available(). throws="1"> move to the next journal entry + line="15978">move to the next journal entry Move to the next journal entry. You have to call this at least once after opening the handle before you are able to read data. @@ -18597,18 +22302,18 @@ end of the journal. This function depends on the feature "journal". See also guestfs_session_feature_available(). + line="443"/> the returned value, or -1 on error + line="15996">the returned value, or -1 on error A GuestfsSession object + line="15980">A GuestfsSession object @@ -18619,7 +22324,7 @@ See also guestfs_session_feature_available(). throws="1"> open the systemd journal + line="16019">open the systemd journal Open the systemd journal located in directory. Any previously opened journal handle is closed. @@ -18633,18 +22338,18 @@ by calling guestfs_session_journal_close(). This function depends on the feature "journal". See also guestfs_session_feature_available(). + line="444"/> true on success, false on error + line="16039">true on success, false on error A GuestfsSession object + line="16021">A GuestfsSession object @@ -18658,7 +22363,7 @@ See also guestfs_session_feature_available(). throws="1"> set the data threshold for reading journal entries + line="16062">set the data threshold for reading journal entries Set the data threshold for reading journal entries. This is a hint to the journal that it may truncate data fields to this size when reading @@ -18670,18 +22375,18 @@ See also guestfs_session_journal_get_data_threshold(). This function depends on the feature "journal". See also guestfs_session_feature_available(). + line="445"/> true on success, false on error + line="16080">true on success, false on error A GuestfsSession object + line="16064">A GuestfsSession object @@ -18695,31 +22400,31 @@ See also guestfs_session_feature_available(). throws="1"> skip forwards or backwards in the journal + line="16103">skip forwards or backwards in the journal Skip forwards ("skip &ge; 0") or backwards ("skip &lt; 0") in the journal. -The number of entries actually skipped is returned (note "rskip &ge; -0"). If this is not the same as the absolute value of the skip parameter -("|skip|") you passed in then it means you have reached the end or the -start of the journal. +The number of entries actually skipped is returned (note +"rskip &ge; 0"). If this is not the same as the absolute value of the +skip parameter ("|skip|") you passed in then it means you have reached +the end or the start of the journal. This function depends on the feature "journal". See also guestfs_session_feature_available(). + line="446"/> the returned value, or -1 on error + line="16122">the returned value, or -1 on error A GuestfsSession object + line="16105">A GuestfsSession object @@ -18734,25 +22439,25 @@ See also guestfs_session_feature_available(). throws="1"> kill the hypervisor + line="16145">kill the hypervisor This kills the hypervisor. Do not call this. See: guestfs_session_shutdown() instead. In new code, use guestfs_session_shutdown() instead + line="447"/> true on success, false on error + line="16156">true on success, false on error A GuestfsSession object + line="16147">A GuestfsSession object @@ -18763,7 +22468,7 @@ Do not call this. See: guestfs_session_shutdown() instead. throws="1"> launch the backend + line="16180">launch the backend You should call this after configuring the handle (eg. adding drives) but before performing any actions. @@ -18773,18 +22478,18 @@ it will not give an error (for historical reasons), the precise behaviour when you do this is not well defined. Handles are very cheap to create, so create a new one for each launch. + line="448"/> true on success, false on error + line="16195">true on success, false on error A GuestfsSession object + line="16182">A GuestfsSession object @@ -18795,7 +22500,7 @@ to create, so create a new one for each launch. throws="1"> change file owner and group + line="16218">change file owner and group Change the file owner to @owner and group to @group. This is like guestfs_session_chown() but if @path is a symlink then the link itself @@ -18805,18 +22510,18 @@ Only numeric uid and gid are supported. If you want to use names, you will need to locate and parse the password file yourself (Augeas support makes this relatively easy). + line="449"/> true on success, false on error + line="16236">true on success, false on error A GuestfsSession object + line="16220">A GuestfsSession object @@ -18836,7 +22541,7 @@ makes this relatively easy). throws="1"> scan and create Windows dynamic disk volumes + line="16259">scan and create Windows dynamic disk volumes This function scans all block devices looking for Windows dynamic disk volumes and partitions, and creates devices for any that were found. @@ -18845,25 +22550,23 @@ Call guestfs_session_list_ldm_volumes() and guestfs_session_list_ldm_partitions() to return all devices. Note that you don't normally need to call this explicitly, since it is -done automatically at guestfs_session_launch() time. However you might -want to call this function if you have hotplugged disks or have just -created a Windows dynamic disk. +done automatically at guestfs_session_launch() time. This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="450"/> true on success, false on error + line="16278">true on success, false on error A GuestfsSession object + line="16261">A GuestfsSession object @@ -18874,7 +22577,7 @@ See also guestfs_session_feature_available(). throws="1"> return the disks in a Windows dynamic disk group + line="16301">return the disks in a Windows dynamic disk group Return the disks in a Windows dynamic disk group. The @diskgroup parameter should be the GUID of a disk group, one element from the list @@ -18883,11 +22586,11 @@ returned by guestfs_session_ldmtool_scan(). This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="451"/> an array of returned strings, or NULL on error + line="16316">an array of returned strings, or NULL on error @@ -18896,7 +22599,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="16303">A GuestfsSession object @@ -18910,7 +22613,7 @@ See also guestfs_session_feature_available(). throws="1"> return the name of a Windows dynamic disk group + line="16339">return the name of a Windows dynamic disk group Return the name of a Windows dynamic disk group. The @diskgroup parameter should be the GUID of a disk group, one element from the list @@ -18919,18 +22622,18 @@ returned by guestfs_session_ldmtool_scan(). This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="452"/> the returned string, or NULL on error + line="16354">the returned string, or NULL on error A GuestfsSession object + line="16341">A GuestfsSession object @@ -18944,7 +22647,7 @@ See also guestfs_session_feature_available(). throws="1"> return the volumes in a Windows dynamic disk group + line="16377">return the volumes in a Windows dynamic disk group Return the volumes in a Windows dynamic disk group. The @diskgroup parameter should be the GUID of a disk group, one element from the list @@ -18953,11 +22656,11 @@ returned by guestfs_session_ldmtool_scan(). This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="453"/> an array of returned strings, or NULL on error + line="16392">an array of returned strings, or NULL on error @@ -18966,7 +22669,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="16379">A GuestfsSession object @@ -18980,7 +22683,7 @@ See also guestfs_session_feature_available(). throws="1"> remove all Windows dynamic disk volumes + line="16415">remove all Windows dynamic disk volumes This is essentially the opposite of guestfs_session_ldmtool_create_all(). It removes the device mapper @@ -18989,18 +22692,18 @@ mappings for all Windows dynamic disk volumes This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="454"/> true on success, false on error + line="16429">true on success, false on error A GuestfsSession object + line="16417">A GuestfsSession object @@ -19011,7 +22714,7 @@ See also guestfs_session_feature_available(). throws="1"> scan for Windows dynamic disks + line="16452">scan for Windows dynamic disks This function scans for Windows dynamic disks. It returns a list of identifiers (GUIDs) for all disk groups that were found. These @@ -19023,11 +22726,11 @@ devices, call guestfs_session_ldmtool_scan_devices() instead. This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="455"/> an array of returned strings, or NULL on error + line="16469">an array of returned strings, or NULL on error @@ -19036,7 +22739,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="16454">A GuestfsSession object @@ -19047,7 +22750,7 @@ See also guestfs_session_feature_available(). throws="1"> scan for Windows dynamic disks + line="16492">scan for Windows dynamic disks This function scans for Windows dynamic disks. It returns a list of identifiers (GUIDs) for all disk groups that were found. These @@ -19059,11 +22762,11 @@ this list is empty, all block devices are scanned. This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="456"/> an array of returned strings, or NULL on error + line="16510">an array of returned strings, or NULL on error @@ -19072,13 +22775,13 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="16494">A GuestfsSession object an array of strings + line="16495">an array of strings @@ -19091,7 +22794,7 @@ See also guestfs_session_feature_available(). throws="1"> return the hint field of a Windows dynamic disk volume + line="16533">return the hint field of a Windows dynamic disk volume Return the hint field of the volume named @volume in the disk group with GUID @diskgroup. This may not be defined, in which case the empty string @@ -19101,18 +22804,18 @@ Windows drive, eg. "E:". This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="457"/> the returned string, or NULL on error + line="16550">the returned string, or NULL on error A GuestfsSession object + line="16535">A GuestfsSession object @@ -19129,7 +22832,7 @@ See also guestfs_session_feature_available(). throws="1"> return the partitions in a Windows dynamic disk volume + line="16573">return the partitions in a Windows dynamic disk volume Return the list of partitions in the volume named @volume in the disk group with GUID @diskgroup. @@ -19137,11 +22840,11 @@ group with GUID @diskgroup. This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="458"/> an array of returned strings, or NULL on error + line="16588">an array of returned strings, or NULL on error @@ -19150,7 +22853,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="16575">A GuestfsSession object @@ -19167,7 +22870,7 @@ See also guestfs_session_feature_available(). throws="1"> return the type of a Windows dynamic disk volume + line="16611">return the type of a Windows dynamic disk volume Return the type of the volume named @volume in the disk group with GUID @diskgroup. @@ -19178,18 +22881,18 @@ Possible volume types that can be returned here include: @simple, This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="459"/> the returned string, or NULL on error + line="16629">the returned string, or NULL on error A GuestfsSession object + line="16613">A GuestfsSession object @@ -19206,7 +22909,7 @@ See also guestfs_session_feature_available(). throws="1"> get a single extended attribute + line="16652">get a single extended attribute Get a single extended attribute from file @path named @name. If @path is a symlink, then this call returns an extended attribute from the @@ -19228,11 +22931,11 @@ attr(5). This function depends on the feature "linuxxattrs". See also guestfs_session_feature_available(). + line="460"/> an array of binary data, or NULL on error + line="16682">an array of binary data, or NULL on error @@ -19241,7 +22944,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="16654">A GuestfsSession object @@ -19256,7 +22959,7 @@ See also guestfs_session_feature_available(). transfer-ownership="full"> The size of the returned buffer, in bytes + line="16657">The size of the returned buffer, in bytes @@ -19267,7 +22970,7 @@ See also guestfs_session_feature_available(). throws="1"> list extended attributes of a file or directory + line="16705">list extended attributes of a file or directory This is the same as guestfs_session_getxattrs(), but if @path is a symbolic link, then it returns the extended attributes of the link @@ -19276,11 +22979,11 @@ itself. This function depends on the feature "linuxxattrs". See also guestfs_session_feature_available(). + line="461"/> an array of XAttr objects, or NULL on error + line="16720">an array of XAttr objects, or NULL on error @@ -19289,7 +22992,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="16707">A GuestfsSession object @@ -19300,19 +23003,20 @@ See also guestfs_session_feature_available(). list 9p filesystems + line="16755">list 9p filesystems -List all 9p filesystems attached to the guest. A list of mount tags is -returned. +This call does nothing and returns an error. + There is no documented replacement + line="462"/> an array of returned strings, or NULL on error + line="16764">an array of returned strings, or NULL on error @@ -19321,7 +23025,7 @@ returned. A GuestfsSession object + line="16757">A GuestfsSession object @@ -19332,7 +23036,7 @@ returned. throws="1"> list the block devices + line="16788">list the block devices List all the block devices. @@ -19340,11 +23044,11 @@ The full block device names are returned, eg. /dev/sda. See also guestfs_session_list_filesystems(). + line="463"/> an array of returned strings, or NULL on error + line="16801">an array of returned strings, or NULL on error @@ -19353,7 +23057,7 @@ See also guestfs_session_list_filesystems(). A GuestfsSession object + line="16790">A GuestfsSession object @@ -19364,7 +23068,7 @@ See also guestfs_session_list_filesystems(). throws="1"> mapping of disk labels to devices + line="16824">mapping of disk labels to devices If you add drives using the optional @label parameter of guestfs_session_add_drive_opts(), you can use this call to map between @@ -19375,11 +23079,11 @@ This returns a hashtable, where keys are the disk labels (*without* the /dev/disk/guestfs prefix), and the values are the full raw block device and partition names (eg. /dev/sda and /dev/sda1). + line="464"/> a GHashTable of results, or NULL on error + line="16840">a GHashTable of results, or NULL on error @@ -19389,7 +23093,7 @@ and partition names (eg. /dev/sda and /dev/sda1). A GuestfsSession object + line="16826">A GuestfsSession object @@ -19400,7 +23104,7 @@ and partition names (eg. /dev/sda and /dev/sda1). throws="1"> list device mapper devices + line="16871">list device mapper devices List all device mapper devices. @@ -19411,11 +23115,11 @@ Device mapper devices which correspond to logical volumes are *not* returned in this list. Call guestfs_session_lvs() if you want to list logical volumes. + line="465"/> an array of returned strings, or NULL on error + line="16887">an array of returned strings, or NULL on error @@ -19424,7 +23128,7 @@ logical volumes. A GuestfsSession object + line="16873">A GuestfsSession object @@ -19435,7 +23139,7 @@ logical volumes. throws="1"> list filesystems + line="16910">list filesystems This inspection command looks for filesystems on partitions, block devices and logical volumes, returning a list of @mountables containing @@ -19472,11 +23176,11 @@ filesystems might be mountable but require special options. Filesystems may not all belong to a single logical operating system (use guestfs_session_inspect_os() to look for OSes). + line="466"/> a GHashTable of results, or NULL on error + line="16952">a GHashTable of results, or NULL on error @@ -19486,7 +23190,7 @@ guestfs_session_inspect_os() to look for OSes). A GuestfsSession object + line="16912">A GuestfsSession object @@ -19497,7 +23201,7 @@ guestfs_session_inspect_os() to look for OSes). throws="1"> list all Windows dynamic disk partitions + line="16983">list all Windows dynamic disk partitions This function returns all Windows dynamic disk partitions that were found at launch time. It returns a list of device names. @@ -19505,11 +23209,11 @@ found at launch time. It returns a list of device names. This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="467"/> an array of returned strings, or NULL on error + line="16996">an array of returned strings, or NULL on error @@ -19518,7 +23222,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="16985">A GuestfsSession object @@ -19529,7 +23233,7 @@ See also guestfs_session_feature_available(). throws="1"> list all Windows dynamic disk volumes + line="17019">list all Windows dynamic disk volumes This function returns all Windows dynamic disk volumes that were found at launch time. It returns a list of device names. @@ -19537,11 +23241,11 @@ at launch time. It returns a list of device names. This function depends on the feature "ldm". See also guestfs_session_feature_available(). + line="468"/> an array of returned strings, or NULL on error + line="17032">an array of returned strings, or NULL on error @@ -19550,7 +23254,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="17021">A GuestfsSession object @@ -19561,15 +23265,15 @@ See also guestfs_session_feature_available(). throws="1"> list Linux md (RAID) devices + line="17055">list Linux md (RAID) devices List all Linux md devices. + line="469"/> an array of returned strings, or NULL on error + line="17064">an array of returned strings, or NULL on error @@ -19578,7 +23282,7 @@ List all Linux md devices. A GuestfsSession object + line="17057">A GuestfsSession object @@ -19589,7 +23293,7 @@ List all Linux md devices. throws="1"> list the partitions + line="17087">list the partitions List all the partitions detected on all block devices. @@ -19600,11 +23304,11 @@ guestfs_session_lvs(). See also guestfs_session_list_filesystems(). + line="470"/> an array of returned strings, or NULL on error + line="17103">an array of returned strings, or NULL on error @@ -19613,7 +23317,7 @@ See also guestfs_session_list_filesystems(). A GuestfsSession object + line="17089">A GuestfsSession object @@ -19624,26 +23328,26 @@ See also guestfs_session_list_filesystems(). throws="1"> list the files in a directory (long format) + line="17126">list the files in a directory (long format) List the files in directory (relative to the root directory, there is no -cwd) in the format of 'ls -la'. +cwd) in the format of "ls -la". This command is mostly useful for interactive sessions. It is *not* intended that you try to parse the output string. + line="471"/> the returned string, or NULL on error + line="17140">the returned string, or NULL on error A GuestfsSession object + line="17128">A GuestfsSession object @@ -19658,26 +23362,26 @@ intended that you try to parse the output string. throws="1"> list the files in a directory (long format with SELinux contexts) + line="17163">list the files in a directory (long format with SELinux contexts) -List the files in directory in the format of 'ls -laZ'. +List the files in directory in the format of "ls -laZ". This command is mostly useful for interactive sessions. It is *not* intended that you try to parse the output string. In new code, use guestfs_session_lgetxattrs() instead + line="472"/> the returned string, or NULL on error + line="17176">the returned string, or NULL on error A GuestfsSession object + line="17165">A GuestfsSession object @@ -19691,22 +23395,22 @@ intended that you try to parse the output string. throws="1"> create a hard link + line="17200">create a hard link -This command creates a hard link using the @ln command. +This command creates a hard link. + line="473"/> true on success, false on error + line="17211">true on success, false on error A GuestfsSession object + line="17202">A GuestfsSession object @@ -19723,23 +23427,23 @@ This command creates a hard link using the @ln command. throws="1"> create a hard link + line="17234">create a hard link -This command creates a hard link using the "ln -f" command. The *-f* -option removes the link (@linkname) if it exists already. +This command creates a hard link, removing the link @linkname if it +exists already. + line="474"/> true on success, false on error + line="17246">true on success, false on error A GuestfsSession object + line="17236">A GuestfsSession object @@ -19756,22 +23460,22 @@ option removes the link (@linkname) if it exists already. throws="1"> create a symbolic link + line="17269">create a symbolic link This command creates a symbolic link using the "ln -s" command. + line="475"/> true on success, false on error + line="17280">true on success, false on error A GuestfsSession object + line="17271">A GuestfsSession object @@ -19788,23 +23492,23 @@ This command creates a symbolic link using the "ln -s" command. throws="1"> create a symbolic link + line="17303">create a symbolic link This command creates a symbolic link using the "ln -sf" command, The *-f* option removes the link (@linkname) if it exists already. + line="476"/> true on success, false on error + line="17315">true on success, false on error A GuestfsSession object + line="17305">A GuestfsSession object @@ -19821,7 +23525,7 @@ This command creates a symbolic link using the "ln -sf" command, The throws="1"> remove extended attribute of a file or directory + line="17338">remove extended attribute of a file or directory This is the same as guestfs_session_removexattr(), but if @path is a symbolic link, then it removes an extended attribute of the link itself. @@ -19829,18 +23533,18 @@ symbolic link, then it removes an extended attribute of the link itself. This function depends on the feature "linuxxattrs". See also guestfs_session_feature_available(). + line="477"/> true on success, false on error + line="17353">true on success, false on error A GuestfsSession object + line="17340">A GuestfsSession object @@ -19857,17 +23561,17 @@ See also guestfs_session_feature_available(). throws="1"> list the files in a directory + line="17376">list the files in a directory List the files in directory (relative to the root directory, there is no -cwd). The '.' and '..' entries are not returned, but hidden files are +cwd). The "." and ".." entries are not returned, but hidden files are shown. + line="478"/> an array of returned strings, or NULL on error + line="17388">an array of returned strings, or NULL on error @@ -19876,7 +23580,7 @@ shown. A GuestfsSession object + line="17378">A GuestfsSession object @@ -19890,7 +23594,7 @@ shown. throws="1"> get list of files in a directory + line="17411">get list of files in a directory This specialized command is used to get a listing of the filenames in the directory @dir. The list of filenames is written to the local file @@ -19900,18 +23604,18 @@ In the output file, the filenames are separated by "\0" characters. "." and ".." are not returned. The filenames are not sorted. + line="479"/> true on success, false on error + line="17428">true on success, false on error A GuestfsSession object + line="17413">A GuestfsSession object @@ -19928,7 +23632,7 @@ In the output file, the filenames are separated by "\0" characters. throws="1"> set extended attribute of a file or directory + line="17451">set extended attribute of a file or directory This is the same as guestfs_session_setxattr(), but if @path is a symbolic link, then it sets an extended attribute of the link itself. @@ -19936,18 +23640,18 @@ symbolic link, then it sets an extended attribute of the link itself. This function depends on the feature "linuxxattrs". See also guestfs_session_feature_available(). + line="480"/> true on success, false on error + line="17468">true on success, false on error A GuestfsSession object + line="17453">A GuestfsSession object @@ -19971,7 +23675,7 @@ See also guestfs_session_feature_available(). throws="1"> get file information for a symbolic link + line="17491">get file information for a symbolic link Returns file information for the given @path. @@ -19981,18 +23685,18 @@ symbolic link, then the link is stat-ed, not the file it refers to. This is the same as the lstat(2) system call. In new code, use guestfs_session_lstatns() instead + line="481"/> a Stat object, or NULL on error + line="17506">a Stat object, or NULL on error A GuestfsSession object + line="17493">A GuestfsSession object @@ -20007,7 +23711,7 @@ This is the same as the lstat(2) system call. throws="1"> lstat on multiple files + line="17545">lstat on multiple files This call allows you to perform the guestfs_session_lstat() operation on multiple files, where all files are in the directory @path. @names is @@ -20023,11 +23727,11 @@ guestfs_session_lxattrlist() for a similarly efficient call for getting extended attributes. In new code, use guestfs_session_lstatnslist() instead + line="482"/> an array of Stat objects, or NULL on error + line="17567">an array of Stat objects, or NULL on error @@ -20036,7 +23740,7 @@ extended attributes. A GuestfsSession object + line="17547">A GuestfsSession object @@ -20045,7 +23749,7 @@ extended attributes. an array of strings + line="17549">an array of strings @@ -20058,7 +23762,7 @@ extended attributes. throws="1"> get file information for a symbolic link + line="17611">get file information for a symbolic link Returns file information for the given @path. @@ -20067,18 +23771,18 @@ symbolic link, then the link is stat-ed, not the file it refers to. This is the same as the lstat(2) system call. + line="483"/> a StatNS object, or NULL on error + line="17626">a StatNS object, or NULL on error A GuestfsSession object + line="17613">A GuestfsSession object @@ -20092,7 +23796,7 @@ This is the same as the lstat(2) system call. throws="1"> lstat on multiple files + line="17673">lstat on multiple files This call allows you to perform the guestfs_session_lstatns() operation on multiple files, where all files are in the directory @path. @names is @@ -20107,11 +23811,11 @@ directory contents without making many round-trips. See also guestfs_session_lxattrlist() for a similarly efficient call for getting extended attributes. + line="484"/> an array of StatNS objects, or NULL on error + line="17695">an array of StatNS objects, or NULL on error @@ -20120,7 +23824,7 @@ extended attributes. A GuestfsSession object + line="17675">A GuestfsSession object @@ -20129,7 +23833,7 @@ extended attributes. an array of strings + line="17677">an array of strings @@ -20142,7 +23846,7 @@ extended attributes. throws="1"> add a key on a LUKS encrypted device + line="17747">add a key on a LUKS encrypted device This command adds a new key on LUKS device @device. @key is any existing key, and is used to access the device. @newkey is the new key to add. @@ -20155,18 +23859,18 @@ that key. This function depends on the feature "luks". See also guestfs_session_feature_available(). + line="485"/> true on success, false on error + line="17769">true on success, false on error A GuestfsSession object + line="17749">A GuestfsSession object @@ -20186,10 +23890,11 @@ See also guestfs_session_feature_available(). close a LUKS device + line="17792">close a LUKS device This closes a LUKS device that was created earlier by guestfs_session_luks_open() or guestfs_session_luks_open_ro(). The @@ -20198,19 +23903,20 @@ guestfs_session_luks_open() or guestfs_session_luks_open_ro(). The This function depends on the feature "luks". See also guestfs_session_feature_available(). + In new code, use guestfs_session_cryptsetup_close() instead + line="486"/> true on success, false on error + line="17808">true on success, false on error A GuestfsSession object + line="17794">A GuestfsSession object @@ -20224,27 +23930,27 @@ See also guestfs_session_feature_available(). throws="1"> format a block device as a LUKS encrypted device + line="17832">format a block device as a LUKS encrypted device This command erases existing data on @device and formats the device as a LUKS encrypted device. @key is the initial key, which is added to key -slot @slot. (LUKS supports 8 key slots, numbered 0-7). +slot @keyslot. (LUKS supports 8 key slots, numbered 0-7). This function depends on the feature "luks". See also guestfs_session_feature_available(). + line="487"/> true on success, false on error + line="17849">true on success, false on error A GuestfsSession object + line="17834">A GuestfsSession object @@ -20264,7 +23970,7 @@ See also guestfs_session_feature_available(). throws="1"> format a block device as a LUKS encrypted device + line="17872">format a block device as a LUKS encrypted device This command is the same as guestfs_session_luks_format() but it also allows you to set the @cipher used. @@ -20272,18 +23978,18 @@ allows you to set the @cipher used. This function depends on the feature "luks". See also guestfs_session_feature_available(). + line="488"/> true on success, false on error + line="17889">true on success, false on error A GuestfsSession object + line="17874">A GuestfsSession object @@ -20306,7 +24012,7 @@ See also guestfs_session_feature_available(). throws="1"> remove a key from a LUKS encrypted device + line="17912">remove a key from a LUKS encrypted device This command deletes the key in key slot @keyslot from the encrypted LUKS device @device. @key must be one of the *other* keys. @@ -20314,18 +24020,18 @@ LUKS device @device. @key must be one of the *other* keys. This function depends on the feature "luks". See also guestfs_session_feature_available(). + line="489"/> true on success, false on error + line="17928">true on success, false on error A GuestfsSession object + line="17914">A GuestfsSession object @@ -20342,10 +24048,11 @@ See also guestfs_session_feature_available(). open a LUKS-encrypted block device + line="17951">open a LUKS-encrypted block device This command opens a block device which has been encrypted according to the Linux Unified Key Setup (LUKS) standard. @@ -20367,19 +24074,20 @@ Use guestfs_session_list_dm_devices() to list all device mapper devices. This function depends on the feature "luks". See also guestfs_session_feature_available(). + In new code, use guestfs_session_cryptsetup_open() instead + line="490"/> true on success, false on error + line="17982">true on success, false on error A GuestfsSession object + line="17953">A GuestfsSession object @@ -20396,29 +24104,31 @@ See also guestfs_session_feature_available(). open a LUKS-encrypted block device read-only + line="18006">open a LUKS-encrypted block device read-only This is the same as guestfs_session_luks_open() except that a read-only mapping is created. This function depends on the feature "luks". See also guestfs_session_feature_available(). + In new code, use guestfs_session_cryptsetup_open() instead + line="491"/> true on success, false on error + line="18022">true on success, false on error A GuestfsSession object + line="18008">A GuestfsSession object @@ -20432,13 +24142,45 @@ See also guestfs_session_feature_available(). + + get the UUID of a LUKS device + +This returns the UUID of the LUKS device @device. + +This function depends on the feature "luks". +See also guestfs_session_feature_available(). + + + the returned string, or NULL on error + + + + + A GuestfsSession object + + + + + + + create an LVM logical volume + line="18082">create an LVM logical volume This creates an LVM logical volume called @logvol on the volume group @volgroup, with @size megabytes. @@ -20446,18 +24188,18 @@ This creates an LVM logical volume called @logvol on the volume group This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="493"/> true on success, false on error + line="18098">true on success, false on error A GuestfsSession object + line="18084">A GuestfsSession object @@ -20477,7 +24219,7 @@ See also guestfs_session_feature_available(). throws="1"> create an LVM logical volume in % remaining free space + line="18121">create an LVM logical volume in % remaining free space Create an LVM logical volume called /dev/volgroup/logvol, using approximately @percent % of the free space remaining in the volume @@ -20487,18 +24229,18 @@ possible LV. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="494"/> true on success, false on error + line="18139">true on success, false on error A GuestfsSession object + line="18123">A GuestfsSession object @@ -20518,30 +24260,30 @@ See also guestfs_session_feature_available(). throws="1"> get canonical name of an LV + line="18162">get canonical name of an LV This converts alternative naming schemes for LVs that you might find to the canonical name. For example, /dev/mapper/VG-LV is converted to /dev/VG/LV. This command returns an error if the @lvname parameter does not refer to -a logical volume. +a logical volume. In this case errno will be set to @EINVAL. See also guestfs_session_is_lv(), guestfs_session_canonical_device_name(). + line="495"/> the returned string, or NULL on error + line="18180">the returned string, or NULL on error A GuestfsSession object + line="18164">A GuestfsSession object @@ -20555,25 +24297,25 @@ guestfs_session_canonical_device_name(). throws="1"> clear LVM device filter + line="18203">clear LVM device filter This undoes the effect of guestfs_session_lvm_set_filter(). LVM will be able to see every block device. This command also clears the LVM cache and performs a volume group scan. + line="496"/> true on success, false on error + line="18215">true on success, false on error A GuestfsSession object + line="18205">A GuestfsSession object @@ -20584,7 +24326,7 @@ This command also clears the LVM cache and performs a volume group scan. throws="1"> remove all LVM LVs, VGs and PVs + line="18238">remove all LVM LVs, VGs and PVs This command removes all LVM logical volumes, volume groups and physical volumes. @@ -20592,18 +24334,18 @@ volumes. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="497"/> true on success, false on error + line="18251">true on success, false on error A GuestfsSession object + line="18240">A GuestfsSession object @@ -20614,7 +24356,7 @@ See also guestfs_session_feature_available(). throws="1"> scan for LVM physical volumes, volume groups and logical volumes + line="18274">scan for LVM physical volumes, volume groups and logical volumes This scans all block devices and rebuilds the list of LVM physical volumes, volume groups and logical volumes. @@ -20628,18 +24370,18 @@ you do not normally need to use this API. However it is useful when you have added a new device or deleted an existing device (such as when the guestfs_session_luks_open() API is used). + line="498"/> true on success, false on error + line="18294">true on success, false on error A GuestfsSession object + line="18276">A GuestfsSession object @@ -20653,7 +24395,7 @@ guestfs_session_luks_open() API is used). throws="1"> set LVM device filter + line="18317">set LVM device filter This sets the LVM device filter so that LVM will only be able to "see" the block devices in the list @devices, and will ignore all other @@ -20677,24 +24419,24 @@ mounted filesystem), even if you are not filtering out that VG. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="499"/> true on success, false on error + line="18347">true on success, false on error A GuestfsSession object + line="18319">A GuestfsSession object an array of strings + line="18320">an array of strings @@ -20707,7 +24449,7 @@ See also guestfs_session_feature_available(). throws="1"> remove an LVM logical volume + line="18370">remove an LVM logical volume Remove an LVM logical volume @device, where @device is the path to the LV, such as /dev/VG/LV. @@ -20718,18 +24460,18 @@ You can also remove all LVs in a volume group by specifying the VG name, This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="500"/> true on success, false on error + line="18387">true on success, false on error A GuestfsSession object + line="18372">A GuestfsSession object @@ -20743,22 +24485,22 @@ See also guestfs_session_feature_available(). throws="1"> rename an LVM logical volume + line="18410">rename an LVM logical volume Rename a logical volume @logvol with the new name @newlogvol. + line="501"/> true on success, false on error + line="18421">true on success, false on error A GuestfsSession object + line="18412">A GuestfsSession object @@ -20775,7 +24517,7 @@ Rename a logical volume @logvol with the new name @newlogvol. throws="1"> resize an LVM logical volume + line="18444">resize an LVM logical volume This resizes (expands or shrinks) an existing LVM logical volume to @mbytes. When reducing, data in the reduced part is lost. @@ -20783,18 +24525,18 @@ This resizes (expands or shrinks) an existing LVM logical volume to This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="502"/> true on success, false on error + line="18459">true on success, false on error A GuestfsSession object + line="18446">A GuestfsSession object @@ -20811,28 +24553,28 @@ See also guestfs_session_feature_available(). throws="1"> expand an LV to fill free space + line="18482">expand an LV to fill free space -This expands an existing logical volume @lv so that it fills @pc% of the -remaining free space in the volume group. Commonly you would call this -with pc = 100 which expands the logical volume as much as possible, +This expands an existing logical volume @lv so that it fills @pc % of +the remaining free space in the volume group. Commonly you would call +this with pc = 100 which expands the logical volume as much as possible, using all remaining free space in the volume group. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="503"/> true on success, false on error + line="18499">true on success, false on error A GuestfsSession object + line="18484">A GuestfsSession object @@ -20849,7 +24591,7 @@ See also guestfs_session_feature_available(). throws="1"> list the LVM logical volumes (LVs) + line="18522">list the LVM logical volumes (LVs) List all the logical volumes detected. This is the equivalent of the lvs(8) command. @@ -20862,11 +24604,11 @@ See also guestfs_session_lvs_full(), guestfs_session_list_filesystems(). This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="504"/> an array of returned strings, or NULL on error + line="18540">an array of returned strings, or NULL on error @@ -20875,7 +24617,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="18524">A GuestfsSession object @@ -20886,7 +24628,7 @@ See also guestfs_session_feature_available(). throws="1"> list the LVM logical volumes (LVs) + line="18563">list the LVM logical volumes (LVs) List all the logical volumes detected. This is the equivalent of the lvs(8) command. The "full" version includes all fields. @@ -20894,11 +24636,11 @@ lvs(8) command. The "full" version includes all fields. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="505"/> an array of LV objects, or NULL on error + line="18576">an array of LV objects, or NULL on error @@ -20907,7 +24649,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="18565">A GuestfsSession object @@ -20918,22 +24660,22 @@ See also guestfs_session_feature_available(). throws="1"> get the UUID of a logical volume + line="18622">get the UUID of a logical volume This command returns the UUID of the LVM LV @device. + line="506"/> the returned string, or NULL on error + line="18632">the returned string, or NULL on error A GuestfsSession object + line="18624">A GuestfsSession object @@ -20947,7 +24689,7 @@ This command returns the UUID of the LVM LV @device. throws="1"> lgetxattr on multiple files + line="18655">lgetxattr on multiple files This call allows you to get the extended attributes of multiple files, where all files are in the directory @path. @names is the list of files @@ -20956,11 +24698,11 @@ from this directory. On return you get a flat list of xattr structs which must be interpreted sequentially. The first xattr struct always has a zero-length @attrname. @attrval in this struct is zero-length to indicate there was an error -doing @lgetxattr for this file, *or* is a C string which is a decimal -number (the number of following attributes for this file, which could be -"0"). Then after the first xattr struct are the zero or more attributes -for the first named file. This repeats for the second and subsequent -files. +doing guestfs_session_lgetxattr() for this file, *or* is a C string +which is a decimal number (the number of following attributes for this +file, which could be "0"). Then after the first xattr struct are the +zero or more attributes for the first named file. This repeats for the +second and subsequent files. This call is intended for programs that want to efficiently list a directory contents without making many round-trips. See also @@ -20970,11 +24712,11 @@ standard stats. This function depends on the feature "linuxxattrs". See also guestfs_session_feature_available(). + line="507"/> an array of XAttr objects, or NULL on error + line="18685">an array of XAttr objects, or NULL on error @@ -20983,7 +24725,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="18657">A GuestfsSession object @@ -20992,7 +24734,7 @@ See also guestfs_session_feature_available(). an array of strings + line="18659">an array of strings @@ -21005,7 +24747,7 @@ See also guestfs_session_feature_available(). throws="1"> maximum number of disks that may be added + line="18720">maximum number of disks that may be added Return the maximum number of disks that may be added to a handle (eg. by guestfs_session_add_drive_opts() and similar calls). @@ -21016,18 +24758,18 @@ libguestfs the limit was 25. See "MAXIMUM NUMBER OF DISKS" in guestfs(3) for additional information on this topic. + line="508"/> the returned value, or -1 on error + line="18736">the returned value, or -1 on error A GuestfsSession object + line="18722">A GuestfsSession object @@ -21038,7 +24780,7 @@ on this topic. throws="1"> create a Linux md (RAID) device + line="18759">create a Linux md (RAID) device Create a Linux md (RAID) device named @name on the devices in the list @devices. @@ -21077,29 +24819,32 @@ If not set, this defaults to @0. @chunk The chunk size in bytes. +The @chunk parameter does not make sense, and should not be +specified, when @level is @raid1 (which is the default; see below). + @level -The RAID level, which can be one of: *linear*, *raid0*, *0*, -*stripe*, *raid1*, *1*, *mirror*, *raid4*, *4*, *raid5*, *5*, -*raid6*, *6*, *raid10*, *10*. Some of these are synonymous, and more -levels may be added in future. +The RAID level, which can be one of: @linear, @raid0, @0, @stripe, +@raid1, @1, @mirror, @raid4, @4, @raid5, @5, @raid6, @6, @raid10, +@10. Some of these are synonymous, and more levels may be added in +future. If not set, this defaults to @raid1. This function depends on the feature "mdadm". See also guestfs_session_feature_available(). + line="509"/> true on success, false on error + line="18820">true on success, false on error A GuestfsSession object + line="18761">A GuestfsSession object @@ -21108,7 +24853,7 @@ See also guestfs_session_feature_available(). an array of strings + line="18763">an array of strings @@ -21119,7 +24864,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsMDCreate containing optional arguments + line="18764">a GuestfsMDCreate containing optional arguments @@ -21130,9 +24875,9 @@ See also guestfs_session_feature_available(). throws="1"> obtain metadata for an MD device + line="18891">obtain metadata for an MD device -This command exposes the output of 'mdadm -DY &lt;md&gt;'. The following +This command exposes the output of "mdadm -DY &lt;md&gt;". The following fields are usually present in the returned hash. Other fields may also be present. @@ -21154,11 +24899,11 @@ The name of the MD device. This function depends on the feature "mdadm". See also guestfs_session_feature_available(). + line="510"/> a GHashTable of results, or NULL on error + line="18921">a GHashTable of results, or NULL on error @@ -21168,7 +24913,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="18893">A GuestfsSession object @@ -21182,7 +24927,7 @@ See also guestfs_session_feature_available(). throws="1"> get underlying devices from an MD device + line="18952">get underlying devices from an MD device This call returns a list of the underlying devices which make up the single software RAID array device @md. @@ -21214,11 +24959,11 @@ no specific order) zero or more of the following flags: This function depends on the feature "mdadm". See also guestfs_session_feature_available(). + line="511"/> an array of MDStat objects, or NULL on error + line="18990">an array of MDStat objects, or NULL on error @@ -21227,7 +24972,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="18954">A GuestfsSession object @@ -21241,7 +24986,7 @@ See also guestfs_session_feature_available(). throws="1"> stop a Linux md (RAID) device + line="19023">stop a Linux md (RAID) device This command deactivates the MD array named @md. The device is stopped, but it is not destroyed or zeroed. @@ -21249,18 +24994,18 @@ but it is not destroyed or zeroed. This function depends on the feature "mdadm". See also guestfs_session_feature_available(). + line="512"/> true on success, false on error + line="19037">true on success, false on error A GuestfsSession object + line="19025">A GuestfsSession object @@ -21274,22 +25019,22 @@ See also guestfs_session_feature_available(). throws="1"> create a directory + line="19060">create a directory Create a directory named @path. + line="513"/> true on success, false on error + line="19070">true on success, false on error A GuestfsSession object + line="19062">A GuestfsSession object @@ -21303,7 +25048,7 @@ Create a directory named @path. throws="1"> create a directory with a particular mode + line="19093">create a directory with a particular mode This command creates a directory, setting the initial permissions of the directory to @mode. @@ -21314,18 +25059,18 @@ in other ways. See also guestfs_session_mkdir(), guestfs_session_umask() + line="514"/> true on success, false on error + line="19111">true on success, false on error A GuestfsSession object + line="19095">A GuestfsSession object @@ -21342,23 +25087,23 @@ See also guestfs_session_mkdir(), guestfs_session_umask() throws="1"> create a directory and parents + line="19134">create a directory and parents Create a directory named @path, creating any parent directories as necessary. This is like the "mkdir -p" shell command. + line="515"/> true on success, false on error + line="19145">true on success, false on error A GuestfsSession object + line="19136">A GuestfsSession object @@ -21372,7 +25117,7 @@ necessary. This is like the "mkdir -p" shell command. throws="1"> create a temporary directory + line="19168">create a temporary directory This command creates a temporary directory. The @tmpl parameter should be a full pathname for the temporary directory name with the final six @@ -21390,18 +25135,18 @@ contents after use. See also: mkdtemp(3) + line="516"/> the returned string, or NULL on error + line="19192">the returned string, or NULL on error A GuestfsSession object + line="19170">A GuestfsSession object @@ -21415,7 +25160,7 @@ See also: mkdtemp(3) throws="1"> create an ext2/ext3/ext4 filesystem on device + line="19215">create an ext2/ext3/ext4 filesystem on device @mke2fs is used to create an ext2, ext3, or ext4 filesystem on @device. @@ -21424,18 +25169,18 @@ omitted it defaults to the size of @device. Note if the filesystem is too small to contain a journal, @mke2fs will silently create an ext2 filesystem instead. + line="517"/> true on success, false on error + line="19231">true on success, false on error A GuestfsSession object + line="19217">A GuestfsSession object @@ -21447,7 +25192,7 @@ filesystem instead. allow-none="1"> a GuestfsMke2fs containing optional arguments + line="19219">a GuestfsMke2fs containing optional arguments @@ -21459,7 +25204,7 @@ filesystem instead. throws="1"> make ext2/3/4 filesystem with external journal + line="19566">make ext2/3/4 filesystem with external journal This creates an ext2/3/4 filesystem on @device with an external journal on @journal. It is equivalent to the command: @@ -21469,18 +25214,18 @@ on @journal. It is equivalent to the command: See also guestfs_session_mke2journal(). In new code, use guestfs_session_mke2fs() instead + line="518"/> true on success, false on error + line="19584">true on success, false on error A GuestfsSession object + line="19568">A GuestfsSession object @@ -21504,7 +25249,7 @@ See also guestfs_session_mke2journal(). throws="1"> make ext2/3/4 filesystem with external journal + line="19608">make ext2/3/4 filesystem with external journal This creates an ext2/3/4 filesystem on @device with an external journal on the journal labeled @label. @@ -21512,18 +25257,18 @@ on the journal labeled @label. See also guestfs_session_mke2journal_L(). In new code, use guestfs_session_mke2fs() instead + line="519"/> true on success, false on error + line="19624">true on success, false on error A GuestfsSession object + line="19610">A GuestfsSession object @@ -21547,7 +25292,7 @@ See also guestfs_session_mke2journal_L(). throws="1"> make ext2/3/4 filesystem with external journal + line="19648">make ext2/3/4 filesystem with external journal This creates an ext2/3/4 filesystem on @device with an external journal on the journal with UUID @uuid. @@ -21558,18 +25303,18 @@ This function depends on the feature "linuxfsuuid". See also guestfs_session_feature_available(). In new code, use guestfs_session_mke2fs() instead + line="520"/> true on success, false on error + line="19667">true on success, false on error A GuestfsSession object + line="19650">A GuestfsSession object @@ -21593,7 +25338,7 @@ See also guestfs_session_feature_available(). throws="1"> make ext2/3/4 external journal + line="19691">make ext2/3/4 external journal This creates an ext2 external journal on @device. It is equivalent to the command: @@ -21601,18 +25346,18 @@ the command: <![CDATA[mke2fs -O journal_dev -b blocksize device]]> In new code, use guestfs_session_mke2fs() instead + line="521"/> true on success, false on error + line="19705">true on success, false on error A GuestfsSession object + line="19693">A GuestfsSession object @@ -21630,23 +25375,23 @@ the command: throws="1"> make ext2/3/4 external journal with label + line="19729">make ext2/3/4 external journal with label This creates an ext2 external journal on @device with label @label. In new code, use guestfs_session_mke2fs() instead + line="522"/> true on success, false on error + line="19741">true on success, false on error A GuestfsSession object + line="19731">A GuestfsSession object @@ -21667,7 +25412,7 @@ This creates an ext2 external journal on @device with label @label. throws="1"> make ext2/3/4 external journal with UUID + line="19765">make ext2/3/4 external journal with UUID This creates an ext2 external journal on @device with UUID @uuid. @@ -21675,18 +25420,18 @@ This function depends on the feature "linuxfsuuid". See also guestfs_session_feature_available(). In new code, use guestfs_session_mke2fs() instead + line="523"/> true on success, false on error + line="19780">true on success, false on error A GuestfsSession object + line="19767">A GuestfsSession object @@ -21706,7 +25451,7 @@ See also guestfs_session_feature_available(). throws="1"> make FIFO (named pipe) + line="19804">make FIFO (named pipe) This call creates a FIFO (named pipe) called @path with mode @mode. It is just a convenient wrapper around guestfs_session_mknod(). @@ -21719,18 +25464,18 @@ The mode actually set is affected by the umask. This function depends on the feature "mknod". See also guestfs_session_feature_available(). + line="524"/> true on success, false on error + line="19824">true on success, false on error A GuestfsSession object + line="19806">A GuestfsSession object @@ -21747,7 +25492,7 @@ See also guestfs_session_feature_available(). throws="1"> make a filesystem + line="19847">make a filesystem This function creates a filesystem on @device. The filesystem type is @fstype, for example @ext3. @@ -21782,18 +25527,18 @@ present). This passes the *-S* parameter to external mkfs.ufs(8) program, which sets sector size for ufs filesystem. + line="525"/> true on success, false on error + line="19890">true on success, false on error A GuestfsSession object + line="19849">A GuestfsSession object @@ -21808,7 +25553,7 @@ which sets sector size for ufs filesystem. allow-none="1"> a GuestfsMkfs containing optional arguments + line="19852">a GuestfsMkfs containing optional arguments @@ -21820,7 +25565,7 @@ which sets sector size for ufs filesystem. throws="1"> make a filesystem with block size + line="19961">make a filesystem with block size This call is similar to guestfs_session_mkfs(), but it allows you to control the block size of the resulting filesystem. Supported block @@ -21831,18 +25576,18 @@ For VFAT and NTFS the @blocksize parameter is treated as the requested cluster size. In new code, use guestfs_session_mkfs() instead + line="526"/> true on success, false on error + line="19979">true on success, false on error A GuestfsSession object + line="19963">A GuestfsSession object @@ -21862,7 +25607,7 @@ cluster size. throws="1"> create a btrfs filesystem + line="20003">create a btrfs filesystem Create a btrfs filesystem, allowing all configurables to be set. For more information on the optional arguments, see mkfs.btrfs(8). @@ -21875,24 +25620,24 @@ To create general filesystems, use guestfs_session_mkfs(). This function depends on the feature "btrfs". See also guestfs_session_feature_available(). + line="527"/> true on success, false on error + line="20023">true on success, false on error A GuestfsSession object + line="20005">A GuestfsSession object an array of strings + line="20006">an array of strings @@ -21903,7 +25648,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsMkfsBtrfs containing optional arguments + line="20007">a GuestfsMkfsBtrfs containing optional arguments @@ -21914,24 +25659,24 @@ See also guestfs_session_feature_available(). throws="1"> make lost+found directory on an ext2/3/4 filesystem + line="20118">make lost+found directory on an ext2/3/4 filesystem Make the "lost+found" directory, normally in the root directory of an ext2/3/4 filesystem. @mountpoint is the directory under which we try to create the "lost+found" directory. + line="528"/> true on success, false on error + line="20130">true on success, false on error A GuestfsSession object + line="20120">A GuestfsSession object @@ -21945,7 +25690,7 @@ create the "lost+found" directory. throws="1"> create a mountpoint + line="20153">create a mountpoint guestfs_session_mkmountpoint() and guestfs_session_rmmountpoint() are specialized calls that can be used to create extra mountpoints before @@ -21995,18 +25740,18 @@ Autosync [see guestfs_session_set_autosync(), this is set by default on handles] can cause guestfs_session_umount_all() to be called when the handle is closed which can also trigger these issues. + line="529"/> true on success, false on error + line="20209">true on success, false on error A GuestfsSession object + line="20155">A GuestfsSession object @@ -22020,7 +25765,7 @@ handle is closed which can also trigger these issues. throws="1"> make block, character or FIFO devices + line="20232">make block, character or FIFO devices This call creates block or character special devices, or named pipes (FIFOs). @@ -22042,18 +25787,18 @@ The mode actually set is affected by the umask. This function depends on the feature "mknod". See also guestfs_session_feature_available(). + line="530"/> true on success, false on error + line="20263">true on success, false on error A GuestfsSession object + line="20234">A GuestfsSession object @@ -22076,7 +25821,7 @@ See also guestfs_session_feature_available(). throws="1"> make block device node + line="20286">make block device node This call creates a block device node called @path with mode @mode and device major/minor @devmajor and @devminor. It is just a convenient @@ -22090,18 +25835,18 @@ The mode actually set is affected by the umask. This function depends on the feature "mknod". See also guestfs_session_feature_available(). + line="531"/> true on success, false on error + line="20309">true on success, false on error A GuestfsSession object + line="20288">A GuestfsSession object @@ -22124,7 +25869,7 @@ See also guestfs_session_feature_available(). throws="1"> make char device node + line="20332">make char device node This call creates a char device node called @path with mode @mode and device major/minor @devmajor and @devminor. It is just a convenient @@ -22138,18 +25883,18 @@ The mode actually set is affected by the umask. This function depends on the feature "mknod". See also guestfs_session_feature_available(). + line="532"/> true on success, false on error + line="20355">true on success, false on error A GuestfsSession object + line="20334">A GuestfsSession object @@ -22172,7 +25917,7 @@ See also guestfs_session_feature_available(). throws="1"> create a squashfs filesystem + line="20378">create a squashfs filesystem Create a squashfs filesystem for the specified @path. @@ -22193,18 +25938,18 @@ with large files, such as the resulting squashfs will be over 3GB big. This function depends on the feature "squashfs". See also guestfs_session_feature_available(). + line="533"/> true on success, false on error + line="20408">true on success, false on error A GuestfsSession object + line="20380">A GuestfsSession object @@ -22219,7 +25964,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsMksquashfs containing optional arguments + line="20383">a GuestfsMksquashfs containing optional arguments allow-none="1"> A GCancellable object + line="20384">A GCancellable object @@ -22239,25 +25984,25 @@ See also guestfs_session_feature_available(). throws="1"> create a swap partition + line="20459">create a swap partition Create a Linux swap partition on @device. The option arguments @label and @uuid allow you to set the label and/or UUID of the new swap partition. + line="534"/> true on success, false on error + line="20473">true on success, false on error A GuestfsSession object + line="20461">A GuestfsSession object @@ -22269,7 +26014,7 @@ UUID of the new swap partition. allow-none="1"> a GuestfsMkswap containing optional arguments + line="20463">a GuestfsMkswap containing optional arguments @@ -22281,7 +26026,7 @@ UUID of the new swap partition. throws="1"> create a swap partition with a label + line="20520">create a swap partition with a label Create a swap partition on @device with label @label. @@ -22290,18 +26035,18 @@ Note that you cannot attach a swap label to a block device (eg. kernel or swap tools. In new code, use guestfs_session_mkswap() instead + line="535"/> true on success, false on error + line="20535">true on success, false on error A GuestfsSession object + line="20522">A GuestfsSession object @@ -22319,7 +26064,7 @@ kernel or swap tools. throws="1"> create a swap partition with an explicit UUID + line="20559">create a swap partition with an explicit UUID Create a swap partition on @device with UUID @uuid. @@ -22327,18 +26072,18 @@ This function depends on the feature "linuxfsuuid". See also guestfs_session_feature_available(). In new code, use guestfs_session_mkswap() instead + line="536"/> true on success, false on error + line="20573">true on success, false on error A GuestfsSession object + line="20561">A GuestfsSession object @@ -22355,25 +26100,25 @@ See also guestfs_session_feature_available(). throws="1"> create a swap file + line="20597">create a swap file Create a swap file. This command just writes a swap file signature to an existing file. To create the file itself, use something like guestfs_session_fallocate(). + line="537"/> true on success, false on error + line="20610">true on success, false on error A GuestfsSession object + line="20599">A GuestfsSession object @@ -22387,7 +26132,7 @@ create the file itself, use something like guestfs_session_fallocate(). throws="1"> create a temporary file + line="20633">create a temporary file This command creates a temporary file. The @tmpl parameter should be a full pathname for the temporary directory name with the final six @@ -22407,18 +26152,18 @@ is appended to the temporary name. See also: guestfs_session_mkdtemp(). + line="538"/> the returned string, or NULL on error + line="20660">the returned string, or NULL on error A GuestfsSession object + line="20635">A GuestfsSession object @@ -22430,7 +26175,7 @@ See also: guestfs_session_mkdtemp(). allow-none="1"> a GuestfsMktemp containing optional arguments + line="20637">a GuestfsMktemp containing optional arguments @@ -22441,25 +26186,25 @@ See also: guestfs_session_mkdtemp(). throws="1"> load a kernel module + line="20699">load a kernel module This loads a kernel module in the appliance. This function depends on the feature "linuxmodules". See also guestfs_session_feature_available(). + line="539"/> true on success, false on error + line="20712">true on success, false on error A GuestfsSession object + line="20701">A GuestfsSession object @@ -22473,7 +26218,7 @@ See also guestfs_session_feature_available(). throws="1"> mount a guest disk at a position in the filesystem + line="20735">mount a guest disk at a position in the filesystem Mount a guest disk at a position in the filesystem. Block devices are named /dev/sda, /dev/sdb and so on, as they were added to the guest. If @@ -22496,18 +26241,18 @@ versions of libguestfs, use guestfs_session_mount_options() instead (using an empty string for the first parameter if you don't want any options). + line="540"/> true on success, false on error + line="20765">true on success, false on error A GuestfsSession object + line="20737">A GuestfsSession object @@ -22521,30 +26266,27 @@ options). mount 9p filesystem - -Mount the virtio-9p filesystem with the tag @mounttag on the directory -@mountpoint. + line="20788">mount 9p filesystem -If required, "trans=virtio" will be automatically added to the options. -Any other options required can be passed in the optional @options -parameter. +This call does nothing and returns an error. + There is no documented replacement + line="541"/> true on success, false on error + line="20800">true on success, false on error A GuestfsSession object + line="20790">A GuestfsSession object @@ -22559,7 +26301,7 @@ parameter. allow-none="1"> a GuestfsMount9P containing optional arguments + line="20793">a GuestfsMount9P containing optional arguments @@ -22570,7 +26312,7 @@ parameter. throws="1"> mount on the local filesystem + line="20840">mount on the local filesystem This call exports the libguestfs-accessible filesystem to a local mountpoint (directory) called @localmountpoint. Ordinary reads and @@ -22596,18 +26338,18 @@ guestfs_session_mount_local_run() to run the main loop. See "MOUNT LOCAL" in guestfs(3) for full documentation. + line="542"/> true on success, false on error + line="20873">true on success, false on error A GuestfsSession object + line="20842">A GuestfsSession object @@ -22619,7 +26361,7 @@ See "MOUNT LOCAL" in guestfs(3) for full documentation. allow-none="1"> a GuestfsMountLocal containing optional arguments + line="20844">a GuestfsMountLocal containing optional arguments @@ -22630,7 +26372,7 @@ See "MOUNT LOCAL" in guestfs(3) for full documentation. throws="1"> run main loop of mount on the local filesystem + line="20936">run main loop of mount on the local filesystem Run the main loop which translates kernel calls to libguestfs calls. @@ -22648,18 +26390,18 @@ guestfs(3)). See "MOUNT LOCAL" in guestfs(3) for full documentation. + line="543"/> true on success, false on error + line="20960">true on success, false on error A GuestfsSession object + line="20938">A GuestfsSession object allow-none="1"> A GCancellable object + line="20939">A GCancellable object @@ -22679,24 +26421,24 @@ See "MOUNT LOCAL" in guestfs(3) for full documentation. throws="1"> mount a file using the loop device + line="20995">mount a file using the loop device This command lets you mount file (a filesystem image in a file) on a mount point. It is entirely equivalent to the command "mount -o loop file mountpoint". + line="544"/> true on success, false on error + line="21008">true on success, false on error A GuestfsSession object + line="20997">A GuestfsSession object @@ -22713,7 +26455,7 @@ file mountpoint". throws="1"> mount a guest disk with mount options + line="21031">mount a guest disk with mount options This is the same as the guestfs_session_mount() command, but it allows you to set the mount options as for the mount(8) *-o* flag. @@ -22721,18 +26463,18 @@ you to set the mount options as for the mount(8) *-o* flag. If the @options parameter is an empty string, then no options are passed (all options default to whatever the filesystem uses). + line="545"/> true on success, false on error + line="21047">true on success, false on error A GuestfsSession object + line="21033">A GuestfsSession object @@ -22752,23 +26494,23 @@ If the @options parameter is an empty string, then no options are passed throws="1"> mount a guest disk, read-only + line="21070">mount a guest disk, read-only This is the same as the guestfs_session_mount() command, but it mounts the filesystem with the read-only (*-o ro*) flag. + line="546"/> true on success, false on error + line="21082">true on success, false on error A GuestfsSession object + line="21072">A GuestfsSession object @@ -22785,24 +26527,24 @@ the filesystem with the read-only (*-o ro*) flag. throws="1"> mount a guest disk with mount options and vfstype + line="21105">mount a guest disk with mount options and vfstype This is the same as the guestfs_session_mount() command, but it allows you to set both the mount options and the vfstype as for the mount(8) *-o* and *-t* flags. + line="547"/> true on success, false on error + line="21120">true on success, false on error A GuestfsSession object + line="21107">A GuestfsSession object @@ -22825,7 +26567,7 @@ you to set both the mount options and the vfstype as for the mount(8) throws="1"> extract the device part of a mountable + line="21143">extract the device part of a mountable Returns the device name of a mountable. In quite a lot of cases, the mountable is the device name. @@ -22835,18 +26577,18 @@ a combination of both the device name and the subvolume path (see also guestfs_session_mountable_subvolume() to extract the subvolume path of the mountable if any). + line="548"/> the returned string, or NULL on error + line="21159">the returned string, or NULL on error A GuestfsSession object + line="21145">A GuestfsSession object @@ -22860,7 +26602,7 @@ the mountable if any). throws="1"> extract the subvolume part of a mountable + line="21182">extract the subvolume part of a mountable Returns the subvolume path of a mountable. Btrfs subvolumes mountables are a combination of both the device name and the subvolume path (see @@ -22870,18 +26612,18 @@ mountable). If the mountable does not represent a btrfs subvolume, then this function fails and the @errno is set to @EINVAL. + line="549"/> the returned string, or NULL on error + line="21198">the returned string, or NULL on error A GuestfsSession object + line="21184">A GuestfsSession object @@ -22895,17 +26637,17 @@ function fails and the @errno is set to @EINVAL. throws="1"> show mountpoints + line="21221">show mountpoints This call is similar to guestfs_session_mounts(). That call returns a list of devices. This one returns a hash table (map) of device name to directory where the device is mounted. + line="550"/> a GHashTable of results, or NULL on error + line="21232">a GHashTable of results, or NULL on error @@ -22915,7 +26657,7 @@ directory where the device is mounted. A GuestfsSession object + line="21223">A GuestfsSession object @@ -22926,7 +26668,7 @@ directory where the device is mounted. throws="1"> show mounted filesystems + line="21263">show mounted filesystems This returns the list of currently mounted filesystems. It returns the list of devices (eg. /dev/sda1, /dev/VG/LV). @@ -22935,11 +26677,11 @@ Some internal mounts are not shown. See also: guestfs_session_mountpoints() + line="551"/> an array of returned strings, or NULL on error + line="21277">an array of returned strings, or NULL on error @@ -22948,7 +26690,7 @@ See also: guestfs_session_mountpoints() A GuestfsSession object + line="21265">A GuestfsSession object @@ -22959,25 +26701,25 @@ See also: guestfs_session_mountpoints() throws="1"> move a file + line="21300">move a file This moves a file from @src to @dest where @dest is either a destination filename or destination directory. See also: guestfs_session_rename(). + line="552"/> true on success, false on error + line="21314">true on success, false on error A GuestfsSession object + line="21302">A GuestfsSession object @@ -22994,7 +26736,7 @@ See also: guestfs_session_rename(). throws="1"> return number of whole block devices (disks) added + line="21337">return number of whole block devices (disks) added This returns the number of whole block devices that were added. This is the same as the number of devices that would be returned if you called @@ -23003,18 +26745,18 @@ guestfs_session_list_devices(). To find out the maximum number of devices that could be added, call guestfs_session_max_disks(). + line="553"/> the returned value, or -1 on error + line="21351">the returned value, or -1 on error A GuestfsSession object + line="21339">A GuestfsSession object @@ -23025,7 +26767,7 @@ guestfs_session_max_disks(). throws="1"> probe NTFS volume + line="21374">probe NTFS volume This command runs the ntfs-3g.probe(8) command which probes an NTFS @device for mountability. (Not all NTFS volumes can be mounted @@ -23041,18 +26783,18 @@ or some non-zero value documented in the ntfs-3g.probe(8) manual page. This function depends on the feature "ntfs3g". See also guestfs_session_feature_available(). + line="554"/> the returned value, or -1 on error + line="21397">the returned value, or -1 on error A GuestfsSession object + line="21376">A GuestfsSession object @@ -23069,7 +26811,7 @@ See also guestfs_session_feature_available(). throws="1"> download a file to the local machine given its inode + line="21420">download a file to the local machine given its inode Download a file given its inode from a NTFS filesystem and save it as filename on the local machine. @@ -23080,18 +26822,18 @@ ones within the $Extend folder. The filesystem from which to extract the file must be unmounted, otherwise the call will fail. + line="555"/> true on success, false on error + line="21440">true on success, false on error A GuestfsSession object + line="21422">A GuestfsSession object @@ -23109,7 +26851,7 @@ otherwise the call will fail. allow-none="1"> A GCancellable object + line="21426">A GCancellable object @@ -23120,7 +26862,7 @@ otherwise the call will fail. throws="1"> restore NTFS from backup file + line="21475">restore NTFS from backup file Restore the @backupfile (from a previous call to guestfs_session_ntfsclone_out()) to @device, overwriting any existing @@ -23129,18 +26871,18 @@ contents of this device. This function depends on the feature "ntfs3g". See also guestfs_session_feature_available(). + line="556"/> true on success, false on error + line="21492">true on success, false on error A GuestfsSession object + line="21477">A GuestfsSession object @@ -23155,7 +26897,7 @@ See also guestfs_session_feature_available(). allow-none="1"> A GCancellable object + line="21480">A GCancellable object @@ -23166,7 +26908,7 @@ See also guestfs_session_feature_available(). throws="1"> save NTFS to backup file + line="21527">save NTFS to backup file Stream the NTFS filesystem @device to the local file @backupfile. The format used for the backup file is a special format used by the @@ -23185,18 +26927,18 @@ libguestfs device. This function depends on the feature "ntfs3g". See also guestfs_session_feature_available(). + line="557"/> true on success, false on error + line="21555">true on success, false on error A GuestfsSession object + line="21529">A GuestfsSession object @@ -23211,7 +26953,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsNtfscloneOut containing optional arguments + line="21532">a GuestfsNtfscloneOut containing optional arguments allow-none="1"> A GCancellable object + line="21533">A GCancellable object @@ -23231,7 +26973,7 @@ See also guestfs_session_feature_available(). throws="1"> fix common errors and force Windows to check NTFS + line="21638">fix common errors and force Windows to check NTFS This command repairs some fundamental NTFS inconsistencies, resets the NTFS journal file, and schedules an NTFS consistency check for the first @@ -23246,18 +26988,18 @@ is useful after cloning a disk with bad sectors to a new disk. This function depends on the feature "ntfs3g". See also guestfs_session_feature_available(). + line="558"/> true on success, false on error + line="21660">true on success, false on error A GuestfsSession object + line="21640">A GuestfsSession object @@ -23269,7 +27011,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsNtfsfix containing optional arguments + line="21642">a GuestfsNtfsfix containing optional arguments @@ -23280,7 +27022,7 @@ See also guestfs_session_feature_available(). throws="1"> resize an NTFS filesystem + line="21699">resize an NTFS filesystem This command resizes an NTFS filesystem, expanding or shrinking it to the size of the underlying device. @@ -23307,18 +27049,18 @@ See also ntfsresize(8). This function depends on the feature "ntfsprogs". See also guestfs_session_feature_available(). + line="559"/> true on success, false on error + line="21733">true on success, false on error A GuestfsSession object + line="21701">A GuestfsSession object @@ -23330,7 +27072,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsNTFSResizeOpts containing optional arguments + line="21703">a GuestfsNTFSResizeOpts containing optional arguments @@ -23342,7 +27084,7 @@ See also guestfs_session_feature_available(). throws="1"> resize an NTFS filesystem (with size) + line="21780">resize an NTFS filesystem (with size) This command is the same as guestfs_session_ntfsresize() except that it allows you to specify the new size (in bytes) explicitly. @@ -23351,18 +27093,18 @@ This function depends on the feature "ntfsprogs". See also guestfs_session_feature_available(). In new code, use guestfs_session_ntfsresize() instead + line="560"/> true on success, false on error + line="21795">true on success, false on error A GuestfsSession object + line="21782">A GuestfsSession object @@ -23379,7 +27121,7 @@ See also guestfs_session_feature_available(). throws="1"> parse the environment and set handle flags accordingly + line="21819">parse the environment and set handle flags accordingly Parse the program’s environment and set flags in the handle accordingly. For example if "LIBGUESTFS_DEBUG=1" then the ‘verbose’ flag is set in @@ -23393,18 +27135,18 @@ variables that can affect libguestfs handles. See also "guestfs_create_flags" in guestfs(3), and guestfs_session_parse_environment_list(). + line="561"/> true on success, false on error + line="21838">true on success, false on error A GuestfsSession object + line="21821">A GuestfsSession object @@ -23415,7 +27157,7 @@ guestfs_session_parse_environment_list(). throws="1"> parse the environment and set handle flags accordingly + line="21861">parse the environment and set handle flags accordingly Parse the list of strings in the argument @environment and set flags in the handle accordingly. For example if "LIBGUESTFS_DEBUG=1" is a string @@ -23424,24 +27166,24 @@ in the list, then the ‘verbose’ flag is set in the handle. This is the same as guestfs_session_parse_environment() except that it parses an explicit list of strings instead of the program's environment. + line="562"/> true on success, false on error + line="21876">true on success, false on error A GuestfsSession object + line="21863">A GuestfsSession object an array of strings + line="21864">an array of strings @@ -23454,7 +27196,7 @@ parses an explicit list of strings instead of the program's environment. throws="1"> add a partition to the device + line="21899">add a partition to the device This command adds a partition to @device. If there is no partition table on the device, call guestfs_session_part_init() first. @@ -23470,18 +27212,18 @@ from the end of the disk (@-1 is the last sector). Creating a partition which covers the whole disk is not so easy. Use guestfs_session_part_disk() to do that. + line="563"/> true on success, false on error + line="21924">true on success, false on error A GuestfsSession object + line="21901">A GuestfsSession object @@ -23504,25 +27246,25 @@ guestfs_session_part_disk() to do that. throws="1"> delete a partition + line="21947">delete a partition This command deletes the partition numbered @partnum on @device. Note that in the case of MBR partitioning, deleting an extended partition also deletes any logical partitions it contains. + line="564"/> true on success, false on error + line="21961">true on success, false on error A GuestfsSession object + line="21949">A GuestfsSession object @@ -23539,7 +27281,7 @@ partition also deletes any logical partitions it contains. throws="1"> partition whole disk with a single primary partition + line="21984">partition whole disk with a single primary partition This command is simply a combination of guestfs_session_part_init() followed by guestfs_session_part_add() to create a single primary @@ -23548,18 +27290,18 @@ partition covering the whole disk. @parttype is the partition table type, usually @mbr or @gpt, but other possible values are described in guestfs_session_part_init(). + line="565"/> true on success, false on error + line="22000">true on success, false on error A GuestfsSession object + line="21986">A GuestfsSession object @@ -23576,7 +27318,7 @@ possible values are described in guestfs_session_part_init(). throws="1"> move backup GPT header to the end of the disk + line="22023">move backup GPT header to the end of the disk Move backup GPT data structures to the end of the disk. This is useful in case of in-place image expand since disk space after backup GPT @@ -23587,18 +27329,18 @@ See also sgdisk(8). This function depends on the feature "gdisk". See also guestfs_session_feature_available(). + line="566"/> true on success, false on error + line="22040">true on success, false on error A GuestfsSession object + line="22025">A GuestfsSession object @@ -23612,25 +27354,25 @@ See also guestfs_session_feature_available(). throws="1"> return true if a partition is bootable + line="22063">return true if a partition is bootable This command returns true if the partition @partnum on @device has the bootable flag set. See also guestfs_session_part_set_bootable(). + line="567"/> the returned value, or -1 on error + line="22077">the returned value, or -1 on error A GuestfsSession object + line="22065">A GuestfsSession object @@ -23647,7 +27389,7 @@ See also guestfs_session_part_set_bootable(). throws="1"> get the GUID of a GPT-partitioned disk + line="22100">get the GUID of a GPT-partitioned disk Return the disk identifier (GUID) of a GPT-partitioned @device. Behaviour is undefined for other partition types. @@ -23655,18 +27397,18 @@ Behaviour is undefined for other partition types. This function depends on the feature "gdisk". See also guestfs_session_feature_available(). + line="568"/> the returned string, or NULL on error + line="22114">the returned string, or NULL on error A GuestfsSession object + line="22102">A GuestfsSession object @@ -23680,7 +27422,7 @@ See also guestfs_session_feature_available(). throws="1"> get the attribute flags of a GPT partition + line="22137">get the attribute flags of a GPT partition Return the attribute flags of numbered GPT partition @partnum. An error is returned for MBR partitions. @@ -23688,18 +27430,18 @@ is returned for MBR partitions. This function depends on the feature "gdisk". See also guestfs_session_feature_available(). + line="569"/> the returned value, or -1 on error + line="22152">the returned value, or -1 on error A GuestfsSession object + line="22139">A GuestfsSession object @@ -23716,25 +27458,25 @@ See also guestfs_session_feature_available(). throws="1"> get the GUID of a GPT partition + line="22175">get the GUID of a GPT partition Return the GUID of numbered GPT partition @partnum. This function depends on the feature "gdisk". See also guestfs_session_feature_available(). + line="570"/> the returned string, or NULL on error + line="22189">the returned string, or NULL on error A GuestfsSession object + line="22177">A GuestfsSession object @@ -23751,27 +27493,25 @@ See also guestfs_session_feature_available(). throws="1"> get the type GUID of a GPT partition + line="22212">get the type GUID of a GPT partition -Return the type GUID of numbered GPT partition @partnum. For MBR -partitions, return an appropriate GUID corresponding to the MBR type. -Behaviour is undefined for other partition types. +Return the type GUID of numbered GPT partition @partnum. This function depends on the feature "gdisk". See also guestfs_session_feature_available(). + line="571"/> the returned string, or NULL on error + line="22226">the returned string, or NULL on error A GuestfsSession object + line="22214">A GuestfsSession object @@ -23788,7 +27528,7 @@ See also guestfs_session_feature_available(). throws="1"> get the MBR type byte (ID byte) from a partition + line="22249">get the MBR type byte (ID byte) from a partition Returns the MBR type byte (also known as the ID byte) from the numbered partition @partnum. @@ -23797,18 +27537,18 @@ Note that only MBR (old DOS-style) partitions have type bytes. You will get undefined results for other partition table types (see guestfs_session_part_get_parttype()). + line="572"/> the returned value, or -1 on error + line="22265">the returned value, or -1 on error A GuestfsSession object + line="22251">A GuestfsSession object @@ -23825,25 +27565,25 @@ guestfs_session_part_get_parttype()). throws="1"> get the MBR partition type + line="22288">get the MBR partition type This returns the partition type of an MBR partition numbered @partnum on device @device. It returns @primary, @logical, or @extended. + line="573"/> the returned string, or NULL on error + line="22302">the returned string, or NULL on error A GuestfsSession object + line="22290">A GuestfsSession object @@ -23860,7 +27600,7 @@ It returns @primary, @logical, or @extended. throws="1"> get partition name + line="22325">get partition name This gets the partition name on partition numbered @partnum on device @device. Note that partitions are numbered from 1. @@ -23868,18 +27608,18 @@ This gets the partition name on partition numbered @partnum on device The partition name can only be read on certain types of partition table. This works on @gpt but not on @mbr partitions. + line="574"/> the returned string, or NULL on error + line="22340">the returned string, or NULL on error A GuestfsSession object + line="22327">A GuestfsSession object @@ -23896,7 +27636,7 @@ This works on @gpt but not on @mbr partitions. throws="1"> get the partition table type + line="22363">get the partition table type This command examines the partition table on @device and returns the partition table type (format) being used. @@ -23906,18 +27646,18 @@ table), @gpt (a GPT/EFI-style partition table). Other values are possible, although unusual. See guestfs_session_part_init() for a full list. + line="575"/> the returned string, or NULL on error + line="22379">the returned string, or NULL on error A GuestfsSession object + line="22365">A GuestfsSession object @@ -23931,7 +27671,7 @@ list. throws="1"> create an empty partition table + line="22402">create an empty partition table This creates an empty partition table on @device of one of the partition types listed below. Usually @parttype should be either @msdos or @gpt @@ -23942,52 +27682,59 @@ guestfs_session_part_add() for each partition required. Possible values for @parttype are: -efi -gpt Intel EFI / GPT partition table. +@efi +@gpt +Intel EFI / GPT partition table. This is recommended for >= 2 TB partitions that will be accessed from Linux and Intel-based Mac OS X. It also has limited backwards compatibility with the @mbr format. -mbr -msdos +@mbr +@msdos The standard PC "Master Boot Record" (MBR) format used by MS-DOS and Windows. This partition type will only work for device sizes up to 2 TB. For large disks we recommend using @gpt. Other partition table types that may work but are not supported include: -aix AIX disk labels. +@aix +AIX disk labels. -amiga -rdb Amiga "Rigid Disk Block" format. +@amiga +@rdb +Amiga "Rigid Disk Block" format. -bsd BSD disk labels. +@bsd +BSD disk labels. -dasd +@dasd DASD, used on IBM mainframes. -dvh MIPS/SGI volumes. +@dvh +MIPS/SGI volumes. -mac Old Mac partition format. Modern Macs use @gpt. +@mac +Old Mac partition format. Modern Macs use @gpt. -pc98 +@pc98 NEC PC-98 format, common in Japan apparently. -sun Sun disk labels. +@sun +Sun disk labels. + line="576"/> true on success, false on error + line="22461">true on success, false on error A GuestfsSession object + line="22404">A GuestfsSession object @@ -24004,31 +27751,31 @@ sun Sun disk labels. throws="1"> list partitions on a device + line="22484">list partitions on a device This command parses the partition table on @device and returns the list of partitions found. The fields in the returned structure are: -part_num +@part_num Partition number, counting from 1. -part_start +@part_start Start of the partition *in bytes*. To get sectors you have to divide by the device’s sector size, see guestfs_session_blockdev_getss(). -part_end +@part_end End of the partition in bytes. -part_size +@part_size Size of the partition in bytes. + line="577"/> an array of Partition objects, or NULL on error + line="22510">an array of Partition objects, or NULL on error @@ -24037,7 +27784,7 @@ Size of the partition in bytes. A GuestfsSession object + line="22486">A GuestfsSession object @@ -24051,7 +27798,7 @@ Size of the partition in bytes. throws="1"> resize a partition + line="22544">resize a partition This command resizes the partition numbered @partnum on @device by moving the end position. @@ -24064,18 +27811,18 @@ When growing a partition you will want to grow the filesystem afterwards, but when shrinking, you need to shrink the filesystem before the partition. + line="578"/> true on success, false on error + line="22565">true on success, false on error A GuestfsSession object + line="22546">A GuestfsSession object @@ -24095,7 +27842,7 @@ the partition. throws="1"> make a partition bootable + line="22588">make a partition bootable This sets the bootable flag on partition numbered @partnum on device @device. Note that partitions are numbered from 1. @@ -24104,18 +27851,18 @@ The bootable flag is used by some operating systems (notably Windows) to determine which partition to boot from. It is by no means universally recognized. + line="579"/> true on success, false on error + line="22605">true on success, false on error A GuestfsSession object + line="22590">A GuestfsSession object @@ -24135,7 +27882,7 @@ recognized. throws="1"> set the GUID of a GPT-partitioned disk + line="22628">set the GUID of a GPT-partitioned disk Set the disk identifier (GUID) of a GPT-partitioned @device to @guid. Return an error if the partition table of @device isn't GPT, or if @guid @@ -24144,18 +27891,18 @@ is not a valid GUID. This function depends on the feature "gdisk". See also guestfs_session_feature_available(). + line="580"/> true on success, false on error + line="22644">true on success, false on error A GuestfsSession object + line="22630">A GuestfsSession object @@ -24172,7 +27919,7 @@ See also guestfs_session_feature_available(). throws="1"> set the GUID of a GPT-partitioned disk to random value + line="22667">set the GUID of a GPT-partitioned disk to random value Set the disk identifier (GUID) of a GPT-partitioned @device to a randomly generated value. Return an error if the partition table of @@ -24181,18 +27928,18 @@ randomly generated value. Return an error if the partition table of This function depends on the feature "gdisk". See also guestfs_session_feature_available(). + line="581"/> true on success, false on error + line="22682">true on success, false on error A GuestfsSession object + line="22669">A GuestfsSession object @@ -24206,7 +27953,7 @@ See also guestfs_session_feature_available(). throws="1"> set the attribute flags of a GPT partition + line="22705">set the attribute flags of a GPT partition Set the attribute flags of numbered GPT partition @partnum to @attributes. Return an error if the partition table of @device isn't @@ -24220,18 +27967,18 @@ s'> http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_entries This function depends on the feature "gdisk". See also guestfs_session_feature_available(). + line="582"/> true on success, false on error + line="22727">true on success, false on error A GuestfsSession object + line="22707">A GuestfsSession object @@ -24251,7 +27998,7 @@ See also guestfs_session_feature_available(). throws="1"> set the GUID of a GPT partition + line="22750">set the GUID of a GPT partition Set the GUID of numbered GPT partition @partnum to @guid. Return an error if the partition table of @device isn't GPT, or if @guid is not a @@ -24260,18 +28007,18 @@ valid GUID. This function depends on the feature "gdisk". See also guestfs_session_feature_available(). + line="583"/> true on success, false on error + line="22767">true on success, false on error A GuestfsSession object + line="22752">A GuestfsSession object @@ -24291,33 +28038,33 @@ See also guestfs_session_feature_available(). throws="1"> set the type GUID of a GPT partition + line="22790">set the type GUID of a GPT partition Set the type GUID of numbered GPT partition @partnum to @guid. Return an error if the partition table of @device isn't GPT, or if @guid is not a valid GUID. See <ulink -url='http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GU -IDs'> +url='https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_G +UIDs'> http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs </ulink> for a useful list of type GUIDs. This function depends on the feature "gdisk". See also guestfs_session_feature_available(). + line="584"/> true on success, false on error + line="22813">true on success, false on error A GuestfsSession object + line="22792">A GuestfsSession object @@ -24337,7 +28084,7 @@ See also guestfs_session_feature_available(). throws="1"> set the MBR type byte (ID byte) of a partition + line="22836">set the MBR type byte (ID byte) of a partition Sets the MBR type byte (also known as the ID byte) of the numbered partition @partnum to @idbyte. Note that the type bytes quoted in most @@ -24348,18 +28095,18 @@ Note that only MBR (old DOS-style) partitions have type bytes. You will get undefined results for other partition table types (see guestfs_session_part_get_parttype()). + line="585"/> true on success, false on error + line="22855">true on success, false on error A GuestfsSession object + line="22838">A GuestfsSession object @@ -24379,7 +28126,7 @@ guestfs_session_part_get_parttype()). throws="1"> set partition name + line="22878">set partition name This sets the partition name on partition numbered @partnum on device @device. Note that partitions are numbered from 1. @@ -24387,18 +28134,18 @@ This sets the partition name on partition numbered @partnum on device The partition name can only be set on certain types of partition table. This works on @gpt but not on @mbr partitions. + line="586"/> true on success, false on error + line="22894">true on success, false on error A GuestfsSession object + line="22880">A GuestfsSession object @@ -24418,7 +28165,7 @@ This works on @gpt but not on @mbr partitions. throws="1"> convert partition name to device name + line="22917">convert partition name to device name This function takes a partition name (eg. "/dev/sdb1") and removes the partition number, returning the device name (eg. "/dev/sdb"). @@ -24429,18 +28176,18 @@ guestfs_session_list_partitions(). See also guestfs_session_part_to_partnum(), guestfs_session_device_index(). + line="587"/> the returned string, or NULL on error + line="22934">the returned string, or NULL on error A GuestfsSession object + line="22919">A GuestfsSession object @@ -24454,7 +28201,7 @@ guestfs_session_device_index(). throws="1"> convert partition name to partition number + line="22957">convert partition name to partition number This function takes a partition name (eg. "/dev/sdb1") and returns the partition number (eg. @1). @@ -24464,18 +28211,18 @@ guestfs_session_list_partitions(). See also guestfs_session_part_to_dev(). + line="588"/> the returned value, or -1 on error + line="22973">the returned value, or -1 on error A GuestfsSession object + line="22959">A GuestfsSession object @@ -24489,25 +28236,25 @@ See also guestfs_session_part_to_dev(). throws="1"> ping the guest daemon + line="22996">ping the guest daemon This is a test probe into the guestfs daemon running inside the libguestfs appliance. Calling this function checks that the daemon responds to the ping message, without affecting the daemon or attached block device(s) in any other way. + line="589"/> true on success, false on error + line="23008">true on success, false on error A GuestfsSession object + line="22998">A GuestfsSession object @@ -24518,7 +28265,7 @@ block device(s) in any other way. throws="1"> read part of a file + line="23031">read part of a file This command lets you read part of a file. It reads @count bytes of the file, starting at @offset, from file @path. @@ -24528,11 +28275,11 @@ pread(2) system call. See also guestfs_session_pwrite(), guestfs_session_pread_device(). + line="590"/> an array of binary data, or NULL on error + line="23050">an array of binary data, or NULL on error @@ -24541,7 +28288,7 @@ See also guestfs_session_pwrite(), guestfs_session_pread_device(). A GuestfsSession object + line="23033">A GuestfsSession object @@ -24559,7 +28306,7 @@ See also guestfs_session_pwrite(), guestfs_session_pread_device(). transfer-ownership="full"> The size of the returned buffer, in bytes + line="23037">The size of the returned buffer, in bytes @@ -24570,7 +28317,7 @@ See also guestfs_session_pwrite(), guestfs_session_pread_device(). throws="1"> read part of a device + line="23073">read part of a device This command lets you read part of a block device. It reads @count bytes of @device, starting at @offset. @@ -24580,11 +28327,11 @@ pread(2) system call. See also guestfs_session_pread(). + line="591"/> an array of binary data, or NULL on error + line="23092">an array of binary data, or NULL on error @@ -24593,7 +28340,7 @@ See also guestfs_session_pread(). A GuestfsSession object + line="23075">A GuestfsSession object @@ -24611,7 +28358,7 @@ See also guestfs_session_pread(). transfer-ownership="full"> The size of the returned buffer, in bytes + line="23079">The size of the returned buffer, in bytes @@ -24622,25 +28369,25 @@ See also guestfs_session_pread(). throws="1"> generate a new random UUID for a physical volume + line="23115">generate a new random UUID for a physical volume Generate a new random UUID for the physical volume @device. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="592"/> true on success, false on error + line="23128">true on success, false on error A GuestfsSession object + line="23117">A GuestfsSession object @@ -24654,25 +28401,25 @@ See also guestfs_session_feature_available(). throws="1"> generate new random UUIDs for all physical volumes + line="23151">generate new random UUIDs for all physical volumes Generate new random UUIDs for all physical volumes. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="593"/> true on success, false on error + line="23163">true on success, false on error A GuestfsSession object + line="23153">A GuestfsSession object @@ -24683,7 +28430,7 @@ See also guestfs_session_feature_available(). throws="1"> create an LVM physical volume + line="23186">create an LVM physical volume This creates an LVM physical volume on the named @device, where @device should usually be a partition name such as /dev/sda1. @@ -24691,18 +28438,18 @@ should usually be a partition name such as /dev/sda1. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="594"/> true on success, false on error + line="23200">true on success, false on error A GuestfsSession object + line="23188">A GuestfsSession object @@ -24716,30 +28463,30 @@ See also guestfs_session_feature_available(). throws="1"> remove an LVM physical volume + line="23223">remove an LVM physical volume This wipes a physical volume @device so that LVM will no longer recognise it. -The implementation uses the @pvremove command which refuses to wipe +The implementation uses the pvremove(8) command which refuses to wipe physical volumes that contain any volume groups, so you have to remove those first. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="595"/> true on success, false on error + line="23241">true on success, false on error A GuestfsSession object + line="23225">A GuestfsSession object @@ -24753,7 +28500,7 @@ See also guestfs_session_feature_available(). throws="1"> resize an LVM physical volume + line="23264">resize an LVM physical volume This resizes (expands or shrinks) an existing LVM physical volume to match the new size of the underlying device. @@ -24761,18 +28508,18 @@ match the new size of the underlying device. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="596"/> true on success, false on error + line="23278">true on success, false on error A GuestfsSession object + line="23266">A GuestfsSession object @@ -24786,7 +28533,7 @@ See also guestfs_session_feature_available(). throws="1"> resize an LVM physical volume (with size) + line="23301">resize an LVM physical volume (with size) This command is the same as guestfs_session_pvresize() except that it allows you to specify the new size (in bytes) explicitly. @@ -24794,18 +28541,18 @@ allows you to specify the new size (in bytes) explicitly. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="597"/> true on success, false on error + line="23316">true on success, false on error A GuestfsSession object + line="23303">A GuestfsSession object @@ -24822,7 +28569,7 @@ See also guestfs_session_feature_available(). throws="1"> list the LVM physical volumes (PVs) + line="23339">list the LVM physical volumes (PVs) List all the physical volumes detected. This is the equivalent of the pvs(8) command. @@ -24835,11 +28582,11 @@ See also guestfs_session_pvs_full(). This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="598"/> an array of returned strings, or NULL on error + line="23357">an array of returned strings, or NULL on error @@ -24848,7 +28595,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="23341">A GuestfsSession object @@ -24859,7 +28606,7 @@ See also guestfs_session_feature_available(). throws="1"> list the LVM physical volumes (PVs) + line="23380">list the LVM physical volumes (PVs) List all the physical volumes detected. This is the equivalent of the pvs(8) command. The "full" version includes all fields. @@ -24867,11 +28614,11 @@ pvs(8) command. The "full" version includes all fields. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="599"/> an array of PV objects, or NULL on error + line="23393">an array of PV objects, or NULL on error @@ -24880,7 +28627,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="23382">A GuestfsSession object @@ -24891,22 +28638,22 @@ See also guestfs_session_feature_available(). throws="1"> get the UUID of a physical volume + line="23437">get the UUID of a physical volume This command returns the UUID of the LVM PV @device. + line="600"/> the returned string, or NULL on error + line="23447">the returned string, or NULL on error A GuestfsSession object + line="23439">A GuestfsSession object @@ -24920,7 +28667,7 @@ This command returns the UUID of the LVM PV @device. throws="1"> write to part of a file + line="23470">write to part of a file This command writes to part of a file. It writes the data buffer @content to the file @path starting at offset @offset. @@ -24933,18 +28680,18 @@ circumstances. See also guestfs_session_pread(), guestfs_session_pwrite_device(). + line="601"/> the returned value, or -1 on error + line="23492">the returned value, or -1 on error A GuestfsSession object + line="23472">A GuestfsSession object @@ -24953,7 +28700,7 @@ See also guestfs_session_pread(), guestfs_session_pwrite_device(). an array of binary data + line="23474">an array of binary data @@ -24961,7 +28708,7 @@ See also guestfs_session_pread(), guestfs_session_pwrite_device(). The size of content, in bytes + line="23475">The size of content, in bytes @@ -24975,7 +28722,7 @@ See also guestfs_session_pread(), guestfs_session_pwrite_device(). throws="1"> write to part of a device + line="23515">write to part of a device This command writes to part of a device. It writes the data buffer @content to @device starting at offset @offset. @@ -24987,18 +28734,18 @@ kernels). See also guestfs_session_pwrite(). + line="602"/> the returned value, or -1 on error + line="23536">the returned value, or -1 on error A GuestfsSession object + line="23517">A GuestfsSession object @@ -25007,7 +28754,7 @@ See also guestfs_session_pwrite(). an array of binary data + line="23519">an array of binary data @@ -25015,7 +28762,7 @@ See also guestfs_session_pwrite(). The size of content, in bytes + line="23520">The size of content, in bytes @@ -25029,18 +28776,18 @@ See also guestfs_session_pwrite(). throws="1"> read a file + line="23559">read a file This calls returns the contents of the file @path as a buffer. Unlike guestfs_session_cat(), this function can correctly handle files that contain embedded ASCII NUL characters. + line="603"/> an array of binary data, or NULL on error + line="23573">an array of binary data, or NULL on error @@ -25049,7 +28796,7 @@ that contain embedded ASCII NUL characters. A GuestfsSession object + line="23561">A GuestfsSession object @@ -25061,7 +28808,7 @@ that contain embedded ASCII NUL characters. transfer-ownership="full"> The size of the returned buffer, in bytes + line="23563">The size of the returned buffer, in bytes @@ -25072,7 +28819,7 @@ that contain embedded ASCII NUL characters. throws="1"> read file as lines + line="23596">read file as lines Return the contents of the file named @path. @@ -25084,11 +28831,11 @@ Note that this function cannot correctly handle binary files of string). For those you need to use the guestfs_session_read_file() function and split the buffer into lines yourself. + line="604"/> an array of returned strings, or NULL on error + line="23614">an array of returned strings, or NULL on error @@ -25097,7 +28844,7 @@ function and split the buffer into lines yourself. A GuestfsSession object + line="23598">A GuestfsSession object @@ -25111,7 +28858,7 @@ function and split the buffer into lines yourself. throws="1"> read directories entries + line="23637">read directories entries This returns the list of directory entries in directory @dir. @@ -25145,11 +28892,11 @@ This function is primarily intended for use by programs. To get a simple list of names, use guestfs_session_ls(). To get a printable directory for human consumption, use guestfs_session_ll(). + line="605"/> an array of Dirent objects, or NULL on error + line="23678">an array of Dirent objects, or NULL on error @@ -25158,12 +28905,21 @@ for human consumption, use guestfs_session_ll(). A GuestfsSession object + line="23639">A GuestfsSession object + + A GCancellable object + + throws="1"> read the target of a symbolic link + line="23723">read the target of a symbolic link This command reads the target of a symbolic link. + line="606"/> the returned string, or NULL on error + line="23733">the returned string, or NULL on error A GuestfsSession object + line="23725">A GuestfsSession object @@ -25201,7 +28957,7 @@ This command reads the target of a symbolic link. throws="1"> readlink on multiple files + line="23756">readlink on multiple files This call allows you to do a @readlink operation on multiple files, where all files are in the directory @path. @names is the list of files @@ -25219,11 +28975,11 @@ already (albeit slightly less efficient). This call is intended for programs that want to efficiently list a directory contents without making many round-trips. + line="607"/> an array of returned strings, or NULL on error + line="23781">an array of returned strings, or NULL on error @@ -25232,7 +28988,7 @@ directory contents without making many round-trips. A GuestfsSession object + line="23758">A GuestfsSession object @@ -25241,7 +28997,7 @@ directory contents without making many round-trips. an array of strings + line="23760">an array of strings @@ -25254,23 +29010,23 @@ directory contents without making many round-trips. throws="1"> canonicalized absolute pathname + line="23804">canonicalized absolute pathname Return the canonicalized absolute pathname of @path. The returned path has no ".", ".." or symbolic link path elements. + line="608"/> the returned string, or NULL on error + line="23815">the returned string, or NULL on error A GuestfsSession object + line="23806">A GuestfsSession object @@ -25284,7 +29040,7 @@ has no ".", ".." or symbolic link path elements. throws="1"> remount a filesystem with different options + line="23838">remount a filesystem with different options This call allows you to change the @rw (readonly/read-write) flag on an already mounted filesystem at @mountpoint, converting a readonly @@ -25293,18 +29049,18 @@ filesystem to be read-write, or vice-versa. Note that at the moment you must supply the "optional" @rw parameter. In future we may allow other flags to be adjusted. + line="609"/> true on success, false on error + line="23854">true on success, false on error A GuestfsSession object + line="23840">A GuestfsSession object @@ -25316,7 +29072,7 @@ future we may allow other flags to be adjusted. allow-none="1"> a GuestfsRemount containing optional arguments + line="23842">a GuestfsRemount containing optional arguments @@ -25324,37 +29080,27 @@ future we may allow other flags to be adjusted. remove a disk image - -This function is conceptually the opposite of -guestfs_session_add_drive_opts(). It removes the drive that was -previously added with label @label. + line="23893">remove a disk image -Note that in order to remove drives, you have to add them with labels -(see the optional @label argument to guestfs_session_add_drive_opts()). -If you didn't use a label, then they cannot be removed. - -You can call this function before or after launching the handle. If -called after launch, if the backend supports it, we try to hot unplug -the drive: see "HOTPLUGGING" in guestfs(3). The disk must not be in use -(eg. mounted) when you do this. We try to detect if the disk is in use -and stop you from doing this. +This call does nothing and returns an error. + There is no documented replacement + line="610"/> true on success, false on error + line="23903">true on success, false on error A GuestfsSession object + line="23895">A GuestfsSession object @@ -25368,7 +29114,7 @@ and stop you from doing this. throws="1"> remove extended attribute of a file or directory + line="23927">remove extended attribute of a file or directory This call removes the extended attribute named @xattr of the file @path. @@ -25377,18 +29123,18 @@ See also: guestfs_session_lremovexattr(), attr(5). This function depends on the feature "linuxxattrs". See also guestfs_session_feature_available(). + line="611"/> true on success, false on error + line="23943">true on success, false on error A GuestfsSession object + line="23929">A GuestfsSession object @@ -25405,24 +29151,24 @@ See also guestfs_session_feature_available(). throws="1"> rename a file on the same filesystem + line="23966">rename a file on the same filesystem Rename a file to a new place on the same filesystem. This is the same as the Linux rename(2) system call. In most cases you are better to use guestfs_session_mv() instead. + line="612"/> true on success, false on error + line="23979">true on success, false on error A GuestfsSession object + line="23968">A GuestfsSession object @@ -25439,25 +29185,25 @@ guestfs_session_mv() instead. throws="1"> resize an ext2, ext3 or ext4 filesystem + line="24002">resize an ext2, ext3 or ext4 filesystem This resizes an ext2, ext3 or ext4 filesystem to match the size of the underlying device. See also "RESIZE2FS ERRORS" in guestfs(3). + line="613"/> true on success, false on error + line="24015">true on success, false on error A GuestfsSession object + line="24004">A GuestfsSession object @@ -25471,11 +29217,11 @@ See also "RESIZE2FS ERRORS" in guestfs(3). throws="1"> resize an ext2, ext3 or ext4 filesystem to the minimum size + line="24038">resize an ext2, ext3 or ext4 filesystem to the minimum size This command is the same as guestfs_session_resize2fs(), but the filesystem is resized to its minimum size. This works like the *-M* -option to the @resize2fs command. +option to the resize2fs(8) command. To get the resulting size of the filesystem you should call guestfs_session_tune2fs_l() and read the "Block size" and "Block count" @@ -25484,18 +29230,18 @@ of the minimal filesystem in bytes. See also "RESIZE2FS ERRORS" in guestfs(3). + line="614"/> true on success, false on error + line="24057">true on success, false on error A GuestfsSession object + line="24040">A GuestfsSession object @@ -25509,25 +29255,25 @@ See also "RESIZE2FS ERRORS" in guestfs(3). throws="1"> resize an ext2, ext3 or ext4 filesystem (with size) + line="24080">resize an ext2, ext3 or ext4 filesystem (with size) This command is the same as guestfs_session_resize2fs() except that it allows you to specify the new size (in bytes) explicitly. See also "RESIZE2FS ERRORS" in guestfs(3). + line="615"/> true on success, false on error + line="24094">true on success, false on error A GuestfsSession object + line="24082">A GuestfsSession object @@ -25544,22 +29290,22 @@ See also "RESIZE2FS ERRORS" in guestfs(3). throws="1"> remove a file + line="24117">remove a file Remove the single file @path. + line="616"/> true on success, false on error + line="24127">true on success, false on error A GuestfsSession object + line="24119">A GuestfsSession object @@ -25573,7 +29319,7 @@ Remove the single file @path. throws="1"> remove a file ignoring errors + line="24150">remove a file ignoring errors Remove the file @path. @@ -25584,18 +29330,18 @@ This call cannot remove directories. Use guestfs_session_rmdir() to remove an empty directory, or guestfs_session_rm_rf() to remove directories recursively. + line="617"/> true on success, false on error + line="24167">true on success, false on error A GuestfsSession object + line="24152">A GuestfsSession object @@ -25609,23 +29355,23 @@ directories recursively. throws="1"> remove a file or directory recursively + line="24190">remove a file or directory recursively Remove the file or directory @path, recursively removing the contents if its a directory. This is like the "rm -rf" shell command. + line="618"/> true on success, false on error + line="24201">true on success, false on error A GuestfsSession object + line="24192">A GuestfsSession object @@ -25639,22 +29385,22 @@ its a directory. This is like the "rm -rf" shell command. throws="1"> remove a directory + line="24224">remove a directory Remove the single directory @path. + line="619"/> true on success, false on error + line="24234">true on success, false on error A GuestfsSession object + line="24226">A GuestfsSession object @@ -25668,24 +29414,24 @@ Remove the single directory @path. throws="1"> remove a mountpoint + line="24257">remove a mountpoint This call removes a mountpoint that was previously created with guestfs_session_mkmountpoint(). See guestfs_session_mkmountpoint() for full details. + line="620"/> true on success, false on error + line="24269">true on success, false on error A GuestfsSession object + line="24259">A GuestfsSession object @@ -25699,7 +29445,7 @@ full details. throws="1"> synchronize the contents of two directories + line="24292">synchronize the contents of two directories This call may be used to copy or synchronize two directories under the same libguestfs handle. This uses the rsync(1) program which uses a fast @@ -25720,18 +29466,18 @@ Delete files at the destination that do not exist at the source. This function depends on the feature "rsync". See also guestfs_session_feature_available(). + line="621"/> true on success, false on error + line="24321">true on success, false on error A GuestfsSession object + line="24294">A GuestfsSession object @@ -25746,7 +29492,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsRsync containing optional arguments + line="24297">a GuestfsRsync containing optional arguments @@ -25757,7 +29503,7 @@ See also guestfs_session_feature_available(). throws="1"> synchronize host or remote filesystem with filesystem + line="24368">synchronize host or remote filesystem with filesystem This call may be used to copy or synchronize the filesystem on the host or on a remote computer with the filesystem within libguestfs. This uses @@ -25780,18 +29526,18 @@ The optional arguments are the same as those of guestfs_session_rsync(). This function depends on the feature "rsync". See also guestfs_session_feature_available(). + line="622"/> true on success, false on error + line="24399">true on success, false on error A GuestfsSession object + line="24370">A GuestfsSession object @@ -25806,7 +29552,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsRsyncIn containing optional arguments + line="24373">a GuestfsRsyncIn containing optional arguments @@ -25817,7 +29563,7 @@ See also guestfs_session_feature_available(). throws="1"> synchronize filesystem with host or remote filesystem + line="24446">synchronize filesystem with host or remote filesystem This call may be used to copy or synchronize the filesystem within libguestfs with a filesystem on the host or on a remote computer. This @@ -25847,18 +29593,18 @@ command (see "glob" in guestfish(1)), for example: This function depends on the feature "rsync". See also guestfs_session_feature_available(). + line="623"/> true on success, false on error + line="24484">true on success, false on error A GuestfsSession object + line="24448">A GuestfsSession object @@ -25873,7 +29619,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsRsyncOut containing optional arguments + line="24451">a GuestfsRsyncOut containing optional arguments @@ -25884,7 +29630,7 @@ See also guestfs_session_feature_available(). throws="1"> scrub (securely wipe) a device + line="24531">scrub (securely wipe) a device This command writes patterns over @device to make data retrieval more difficult. @@ -25895,18 +29641,18 @@ more details. This function depends on the feature "scrub". See also guestfs_session_feature_available(). + line="624"/> true on success, false on error + line="24548">true on success, false on error A GuestfsSession object + line="24533">A GuestfsSession object @@ -25920,7 +29666,7 @@ See also guestfs_session_feature_available(). throws="1"> scrub (securely wipe) a file + line="24571">scrub (securely wipe) a file This command writes patterns over a file to make data retrieval more difficult. @@ -25933,18 +29679,18 @@ more details. This function depends on the feature "scrub". See also guestfs_session_feature_available(). + line="625"/> true on success, false on error + line="24590">true on success, false on error A GuestfsSession object + line="24573">A GuestfsSession object @@ -25958,7 +29704,7 @@ See also guestfs_session_feature_available(). throws="1"> scrub (securely wipe) free space + line="24613">scrub (securely wipe) free space This command creates the directory @dir and then fills it with files until the filesystem is full, and scrubs the files as for @@ -25971,18 +29717,18 @@ more details. This function depends on the feature "scrub". See also guestfs_session_feature_available(). + line="626"/> true on success, false on error + line="24632">true on success, false on error A GuestfsSession object + line="24615">A GuestfsSession object @@ -25996,7 +29742,7 @@ See also guestfs_session_feature_available(). throws="1"> relabel parts of the filesystem + line="24655">relabel parts of the filesystem SELinux relabel parts of the filesystem. @@ -26016,18 +29762,18 @@ the file context is changed. This function depends on the feature "selinuxrelabel". See also guestfs_session_feature_available(). + line="627"/> true on success, false on error + line="24683">true on success, false on error A GuestfsSession object + line="24657">A GuestfsSession object @@ -26042,7 +29788,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsSelinuxRelabel containing optional arguments + line="24660">a GuestfsSelinuxRelabel containing optional arguments @@ -26053,7 +29799,7 @@ See also guestfs_session_feature_available(). throws="1"> add options to kernel command line + line="24722">add options to kernel command line This function is used to add additional options to the libguestfs appliance kernel command line. @@ -26064,18 +29810,18 @@ environment variable. Setting @append to @NULL means *no* additional options are passed (libguestfs always adds a few of its own). + line="628"/> true on success, false on error + line="24739">true on success, false on error A GuestfsSession object + line="24724">A GuestfsSession object set the backend + line="24762">set the backend Set the method that libguestfs uses to connect to the backend guestfsd daemon. @@ -26101,18 +29847,18 @@ daemon. See "BACKEND" in guestfs(3). In new code, use guestfs_session_set_backend() instead + line="629"/> true on success, false on error + line="24775">true on success, false on error A GuestfsSession object + line="24764">A GuestfsSession object @@ -26126,7 +29872,7 @@ See "BACKEND" in guestfs(3). throws="1"> set autosync mode + line="24799">set autosync mode If @autosync is true, this enables autosync. Libguestfs will make a best effort attempt to make filesystems consistent and synchronized when the @@ -26135,18 +29881,18 @@ handle is closed (also if the program exits without closing handles). This is enabled by default (since libguestfs 1.5.24, previously it was disabled by default). + line="630"/> true on success, false on error + line="24814">true on success, false on error A GuestfsSession object + line="24801">A GuestfsSession object @@ -26160,7 +29906,7 @@ disabled by default). throws="1"> set the backend + line="24837">set the backend Set the method that libguestfs uses to connect to the backend guestfsd daemon. @@ -26169,18 +29915,18 @@ This handle property was previously called the "attach method". See "BACKEND" in guestfs(3). + line="631"/> true on success, false on error + line="24852">true on success, false on error A GuestfsSession object + line="24839">A GuestfsSession object @@ -26194,7 +29940,7 @@ See "BACKEND" in guestfs(3). throws="1"> set a single per-backend settings string + line="24875">set a single per-backend settings string Append "name=value" to the backend settings string list. However if a string already exists matching "name" or beginning with "name=", then @@ -26202,18 +29948,18 @@ that setting is replaced. See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). + line="632"/> true on success, false on error + line="24890">true on success, false on error A GuestfsSession object + line="24877">A GuestfsSession object @@ -26230,7 +29976,7 @@ See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). throws="1"> replace per-backend settings strings + line="24913">replace per-backend settings strings Set a list of zero or more settings which are passed through to the current backend. Each setting is a string which is interpreted in a @@ -26247,24 +29993,24 @@ guestfs_session_clear_backend_setting(). See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). + line="633"/> true on success, false on error + line="24936">true on success, false on error A GuestfsSession object + line="24915">A GuestfsSession object an array of strings + line="24916">an array of strings @@ -26277,7 +30023,7 @@ See "BACKEND" in guestfs(3), "BACKEND SETTINGS" in guestfs(3). throws="1"> set the appliance cache directory + line="24959">set the appliance cache directory Set the directory used by the handle to store the appliance cache, when using a supermin appliance. The appliance is cached and shared between @@ -26288,18 +30034,18 @@ default value: If @LIBGUESTFS_CACHEDIR is set, then that is the default. Else if @TMPDIR is set, then that is the default. Else /var/tmp is the default. + line="634"/> true on success, false on error + line="24976">true on success, false on error A GuestfsSession object + line="24961">A GuestfsSession object throws="1"> enable or disable direct appliance mode + line="24999">enable or disable direct appliance mode If the direct appliance mode flag is enabled, then stdin and stdout are passed directly through to the appliance once it is launched. @@ -26331,18 +30077,18 @@ You probably don't want to use this unless you know what you are doing. The default is disabled. In new code, use guestfs_session_internal_get_console_socket() instead + line="635"/> true on success, false on error + line="25018">true on success, false on error A GuestfsSession object + line="25001">A GuestfsSession object @@ -26356,7 +30102,7 @@ The default is disabled. throws="1"> set ext2 file attributes of a file + line="25042">set ext2 file attributes of a file This sets or clears the file attributes @attrs associated with the inode file. @@ -26377,18 +30123,18 @@ These attributes are only present when the file is located on an ext2/3/4 filesystem. Using this call on other filesystem types will result in an error. + line="636"/> true on success, false on error + line="25071">true on success, false on error A GuestfsSession object + line="25044">A GuestfsSession object @@ -26403,7 +30149,7 @@ result in an error. allow-none="1"> a GuestfsSetE2attrs containing optional arguments + line="25047">a GuestfsSetE2attrs containing optional arguments @@ -26414,24 +30160,24 @@ result in an error. throws="1"> set ext2 file generation of a file + line="25110">set ext2 file generation of a file This sets the ext2 file generation of a file. See guestfs_session_get_e2generation(). + line="637"/> true on success, false on error + line="25123">true on success, false on error A GuestfsSession object + line="25112">A GuestfsSession object @@ -26449,7 +30195,7 @@ See guestfs_session_get_e2generation(). throws="1"> set the ext2/3/4 filesystem label + line="25146">set the ext2/3/4 filesystem label This sets the ext2/3/4 filesystem label of the filesystem on @device to @label. Filesystem labels are limited to 16 characters. @@ -26459,18 +30205,18 @@ guestfs_session_get_e2label() to return the existing label on a filesystem. In new code, use guestfs_session_set_label() instead + line="638"/> true on success, false on error + line="25162">true on success, false on error A GuestfsSession object + line="25148">A GuestfsSession object @@ -26488,7 +30234,7 @@ filesystem. throws="1"> set the ext2/3/4 filesystem UUID + line="25186">set the ext2/3/4 filesystem UUID This sets the ext2/3/4 filesystem UUID of the filesystem on @device to @uuid. The format of the UUID and alternatives such as @clear, @random @@ -26498,18 +30244,18 @@ You can use guestfs_session_vfs_uuid() to return the existing UUID of a filesystem. In new code, use guestfs_session_set_uuid() instead + line="639"/> true on success, false on error + line="25202">true on success, false on error A GuestfsSession object + line="25188">A GuestfsSession object @@ -26526,11 +30272,10 @@ filesystem. throws="1"> set the hypervisor binary + line="25226">set the hypervisor binary Set the hypervisor binary that we will use. The hypervisor depends on -the backend, but is usually the location of the qemu/KVM hypervisor. For -the uml backend, it is the location of the @linux or @vmlinux binary. +the backend, but is usually the location of the qemu/KVM hypervisor. The default is chosen when the library was compiled by the configure script. @@ -26546,18 +30291,18 @@ results. Using the environment variable @LIBGUESTFS_HV is safest of all since that picks the qemu binary at the same time as the handle is created. + line="640"/> true on success, false on error + line="25251">true on success, false on error A GuestfsSession object + line="25228">A GuestfsSession object @@ -26571,7 +30316,7 @@ created. throws="1"> set the handle identifier + line="25274">set the handle identifier This is an informative string which the caller may optionally set in the handle. It is printed in various places, allowing the current handle to @@ -26598,18 +30343,18 @@ underscore and minus sign. The default is the empty string. See also guestfs_session_set_program(), guestfs_session_set_trace(), guestfs_session_get_identifier(). + line="641"/> true on success, false on error + line="25307">true on success, false on error A GuestfsSession object + line="25276">A GuestfsSession object @@ -26623,7 +30368,7 @@ guestfs_session_get_identifier(). throws="1"> set filesystem label + line="25330">set filesystem label Set the filesystem label on @mountable to @label. @@ -26655,18 +30400,18 @@ specified filesystem, set_label will fail and set errno as ENOTSUP. To read the label on a filesystem, call guestfs_session_vfs_label(). + line="642"/> true on success, false on error + line="25369">true on success, false on error A GuestfsSession object + line="25332">A GuestfsSession object @@ -26683,7 +30428,7 @@ To read the label on a filesystem, call guestfs_session_vfs_label(). throws="1"> pass requested credential back to libvirt + line="25392">pass requested credential back to libvirt After requesting the @index'th credential from the user, call this function to pass the answer back to libvirt. @@ -26691,18 +30436,18 @@ function to pass the answer back to libvirt. See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code. + line="643"/> true on success, false on error + line="25408">true on success, false on error A GuestfsSession object + line="25394">A GuestfsSession object @@ -26711,7 +30456,7 @@ code. an array of binary data + line="25396">an array of binary data @@ -26719,7 +30464,7 @@ code. The size of cred, in bytes + line="25397">The size of cred, in bytes @@ -26730,7 +30475,7 @@ code. throws="1"> set libvirt credentials supported by calling program + line="25431">set libvirt credentials supported by calling program Call this function before setting an event handler for @GUESTFS_EVENT_LIBVIRT_AUTH, to supply the list of credential types that @@ -26754,24 +30499,24 @@ See libvirt documentation for the meaning of these credential types. See "LIBVIRT AUTHENTICATION" in guestfs(3) for documentation and example code. + line="644"/> true on success, false on error + line="25461">true on success, false on error A GuestfsSession object + line="25433">A GuestfsSession object an array of strings + line="25434">an array of strings @@ -26784,7 +30529,7 @@ code. throws="1"> set memory allocated to the hypervisor + line="25484">set memory allocated to the hypervisor This sets the memory size in megabytes allocated to the hypervisor. This only has any effect if called before guestfs_session_launch(). @@ -26794,18 +30539,18 @@ You can also change this by setting the environment variable For more information on the architecture of libguestfs, see guestfs(3). + line="645"/> true on success, false on error + line="25500">true on success, false on error A GuestfsSession object + line="25486">A GuestfsSession object @@ -26819,7 +30564,7 @@ For more information on the architecture of libguestfs, see guestfs(3). throws="1"> set enable network flag + line="25523">set enable network flag If @network is true, then the network is enabled in the libguestfs appliance. The default is false. @@ -26830,18 +30575,18 @@ This affects whether commands are able to access the network (see You must call this before calling guestfs_session_launch(), otherwise it has no effect. + line="646"/> true on success, false on error + line="25540">true on success, false on error A GuestfsSession object + line="25525">A GuestfsSession object @@ -26855,7 +30600,7 @@ has no effect. throws="1"> set the search path + line="25563">set the search path Set the path that libguestfs searches for kernel and initrd.img. @@ -26864,18 +30609,18 @@ The default is "$libdir/guestfs" unless overridden by setting Setting @path to @NULL restores the default path. + line="647"/> true on success, false on error + line="25578">true on success, false on error A GuestfsSession object + line="25565">A GuestfsSession object throws="1"> set process group flag + line="25601">set process group flag If @pgroup is true, child processes are placed into their own process group. @@ -26905,18 +30650,18 @@ kill the subprocess. Guestfish sets this flag to true when used interactively, so that "^C" can cancel long-running commands gracefully (see guestfs_session_user_cancel()). + line="648"/> true on success, false on error + line="25620">true on success, false on error A GuestfsSession object + line="25603">A GuestfsSession object @@ -26930,7 +30675,7 @@ interactively, so that "^C" can cancel long-running commands gracefully throws="1"> set the program name + line="25643">set the program name Set the program name. This is an informative string which the main program may optionally set in the handle. @@ -26938,18 +30683,18 @@ program may optionally set in the handle. When the handle is created, the program name in the handle is set to the basename from "argv[0]". The program name can never be @NULL. + line="649"/> true on success, false on error + line="25657">true on success, false on error A GuestfsSession object + line="25645">A GuestfsSession object @@ -26964,7 +30709,7 @@ basename from "argv[0]". The program name can never be @NULL. throws="1"> set the hypervisor binary (usually qemu) + line="25680">set the hypervisor binary (usually qemu) Set the hypervisor binary (usually qemu) that we will use. @@ -26985,18 +30730,18 @@ since that picks the qemu binary at the same time as the handle is created. In new code, use guestfs_session_set_hv() instead + line="650"/> true on success, false on error + line="25706">true on success, false on error A GuestfsSession object + line="25682">A GuestfsSession object throws="1"> enable or disable the recovery process + line="25730">enable or disable the recovery process If this is called with the parameter @false then guestfs_session_launch() does not create a recovery process. The purpose @@ -27028,18 +30773,18 @@ process will fork itself into the background ("daemonize" itself). In this case the recovery process thinks that the main program has disappeared and so kills the hypervisor, which is not very helpful. + line="651"/> true on success, false on error + line="25751">true on success, false on error A GuestfsSession object + line="25732">A GuestfsSession object @@ -27054,7 +30799,7 @@ disappeared and so kills the hypervisor, which is not very helpful. throws="1"> set SELinux enabled or disabled at appliance boot + line="25774">set SELinux enabled or disabled at appliance boot This sets the selinux flag that is passed to the appliance at boot time. The default is "selinux=0" (disabled). @@ -27065,18 +30810,18 @@ Note that if SELinux is enabled, it is always in Permissive mode For more information on the architecture of libguestfs, see guestfs(3). In new code, use guestfs_session_selinux_relabel() instead + line="652"/> true on success, false on error + line="25790">true on success, false on error A GuestfsSession object + line="25776">A GuestfsSession object @@ -27090,7 +30835,7 @@ For more information on the architecture of libguestfs, see guestfs(3). throws="1"> set number of virtual CPUs in appliance + line="25814">set number of virtual CPUs in appliance Change the number of virtual CPUs assigned to the appliance. The default is @1. Increasing this may improve performance, though often it has no @@ -27098,18 +30843,18 @@ effect. This function must be called before guestfs_session_launch(). + line="653"/> true on success, false on error + line="25828">true on success, false on error A GuestfsSession object + line="25816">A GuestfsSession object @@ -27123,7 +30868,7 @@ This function must be called before guestfs_session_launch(). throws="1"> set the temporary directory + line="25851">set the temporary directory Set the directory used by the handle to store temporary files. @@ -27132,18 +30877,18 @@ default value: If @LIBGUESTFS_TMPDIR is set, then that is the default. Else if @TMPDIR is set, then that is the default. Else /tmp is the default. + line="654"/> true on success, false on error + line="25866">true on success, false on error A GuestfsSession object + line="25853">A GuestfsSession object throws="1"> enable or disable command traces + line="25889">enable or disable command traces If the command trace flag is set to 1, then libguestfs calls, parameters and return values are traced. @@ -27175,18 +30920,18 @@ Trace messages are normally sent to @stderr, unless you register a callback to send them somewhere else (see guestfs_session_set_event_callback()). + line="655"/> true on success, false on error + line="25910">true on success, false on error A GuestfsSession object + line="25891">A GuestfsSession object @@ -27200,7 +30945,7 @@ guestfs_session_set_event_callback()). throws="1"> set the filesystem UUID + line="25933">set the filesystem UUID Set the filesystem UUID on @device to @uuid. If this fails and the errno is ENOTSUP, means that there is no support for changing the UUID for the @@ -27210,18 +30955,18 @@ Only some filesystem types support setting UUIDs. To read the UUID on a filesystem, call guestfs_session_vfs_uuid(). + line="656"/> true on success, false on error + line="25950">true on success, false on error A GuestfsSession object + line="25935">A GuestfsSession object @@ -27238,7 +30983,7 @@ To read the UUID on a filesystem, call guestfs_session_vfs_uuid(). throws="1"> set a random UUID for the filesystem + line="25973">set a random UUID for the filesystem Set the filesystem UUID on @device to a random UUID. If this fails and the errno is ENOTSUP, means that there is no support for changing the @@ -27248,18 +30993,18 @@ Only some filesystem types support setting UUIDs. To read the UUID on a filesystem, call guestfs_session_vfs_uuid(). + line="657"/> true on success, false on error + line="25989">true on success, false on error A GuestfsSession object + line="25975">A GuestfsSession object @@ -27273,7 +31018,7 @@ To read the UUID on a filesystem, call guestfs_session_vfs_uuid(). throws="1"> set verbose mode + line="26012">set verbose mode If @verbose is true, this turns on verbose messages. @@ -27284,18 +31029,18 @@ Verbose messages are normally sent to @stderr, unless you register a callback to send them somewhere else (see guestfs_session_set_event_callback()). + line="658"/> true on success, false on error + line="26029">true on success, false on error A GuestfsSession object + line="26014">A GuestfsSession object @@ -27310,7 +31055,7 @@ guestfs_session_set_event_callback()). throws="1"> set SELinux security context + line="26052">set SELinux security context This sets the SELinux security context of the daemon to the string @context. @@ -27321,18 +31066,18 @@ This function depends on the feature "selinux". See also guestfs_session_feature_available(). In new code, use guestfs_session_selinux_relabel() instead + line="659"/> true on success, false on error + line="26068">true on success, false on error A GuestfsSession object + line="26054">A GuestfsSession object @@ -27346,7 +31091,7 @@ See also guestfs_session_feature_available(). throws="1"> set extended attribute of a file or directory + line="26092">set extended attribute of a file or directory This call sets the extended attribute named @xattr of the file @path to the value @val (of length @vallen). The value is arbitrary 8 bit data. @@ -27356,18 +31101,18 @@ See also: guestfs_session_lsetxattr(), attr(5). This function depends on the feature "linuxxattrs". See also guestfs_session_feature_available(). + line="660"/> true on success, false on error + line="26111">true on success, false on error A GuestfsSession object + line="26094">A GuestfsSession object @@ -27391,7 +31136,7 @@ See also guestfs_session_feature_available(). throws="1"> create partitions on a block device + line="26134">create partitions on a block device This is a direct interface to the sfdisk(8) program for creating partitions on block devices. @@ -27399,15 +31144,15 @@ partitions on block devices. @device should be a block device, for example /dev/sda. @cyls, @heads and @sectors are the number of cylinders, heads and -sectors on the device, which are passed directly to sfdisk as the *-C*, -*-H* and *-S* parameters. If you pass @0 for any of these, then the -corresponding parameter is omitted. Usually for ‘large’ disks, you can -just pass @0 for these, but for small (floppy-sized) disks, sfdisk (or -rather, the kernel) cannot work out the right geometry and you will need -to tell it. +sectors on the device, which are passed directly to sfdisk(8) as the +*-C*, *-H* and *-S* parameters. If you pass @0 for any of these, then +the corresponding parameter is omitted. Usually for ‘large’ disks, you +can just pass @0 for these, but for small (floppy-sized) disks, +sfdisk(8) (or rather, the kernel) cannot work out the right geometry and +you will need to tell it. -@lines is a list of lines that we feed to @sfdisk. For more information -refer to the sfdisk(8) manpage. +@lines is a list of lines that we feed to sfdisk(8). For more +information refer to the sfdisk(8) manpage. To create a single partition occupying the whole disk, you would pass @lines as a single element list, when the single element being the @@ -27417,18 +31162,18 @@ See also: guestfs_session_sfdisk_l(), guestfs_session_sfdisk_N(), guestfs_session_part_init() In new code, use guestfs_session_part_add() instead + line="661"/> true on success, false on error + line="26169">true on success, false on error A GuestfsSession object + line="26136">A GuestfsSession object @@ -27446,7 +31191,7 @@ guestfs_session_part_init() an array of strings + line="26141">an array of strings @@ -27460,7 +31205,7 @@ guestfs_session_part_init() throws="1"> create partitions on a block device + line="26193">create partitions on a block device This is a simplified interface to the guestfs_session_sfdisk() command, where partition sizes are specified in megabytes only (rounded to the @@ -27471,18 +31216,18 @@ See also: guestfs_session_sfdisk(), the sfdisk(8) manpage and guestfs_session_part_disk() In new code, use guestfs_session_part_add() instead + line="662"/> true on success, false on error + line="26210">true on success, false on error A GuestfsSession object + line="26195">A GuestfsSession object @@ -27491,7 +31236,7 @@ guestfs_session_part_disk() an array of strings + line="26197">an array of strings @@ -27505,7 +31250,7 @@ guestfs_session_part_disk() throws="1"> modify a single partition on a block device + line="26234">modify a single partition on a block device This runs sfdisk(8) option to modify just the single partition @n (note: @n counts from 1). @@ -27516,18 +31261,18 @@ pass @0 for the cyls/heads/sectors parameters. See also: guestfs_session_part_add() In new code, use guestfs_session_part_add() instead + line="663"/> true on success, false on error + line="26255">true on success, false on error A GuestfsSession object + line="26236">A GuestfsSession object @@ -27556,7 +31301,7 @@ See also: guestfs_session_part_add() throws="1"> display the disk geometry from the partition table + line="26279">display the disk geometry from the partition table This displays the disk geometry of @device read from the partition table. Especially in the case where the underlying block device has been @@ -27565,18 +31310,18 @@ resized, this can be different from the kernel’s idea of the geometry The result is in human-readable format, and not designed to be parsed. + line="664"/> the returned string, or NULL on error + line="26294">the returned string, or NULL on error A GuestfsSession object + line="26281">A GuestfsSession object @@ -27590,24 +31335,24 @@ The result is in human-readable format, and not designed to be parsed. throws="1"> display the kernel geometry + line="26317">display the kernel geometry This displays the kernel’s idea of the geometry of @device. The result is in human-readable format, and not designed to be parsed. + line="665"/> the returned string, or NULL on error + line="26329">the returned string, or NULL on error A GuestfsSession object + line="26319">A GuestfsSession object @@ -27622,7 +31367,7 @@ The result is in human-readable format, and not designed to be parsed. throws="1"> display the partition table + line="26352">display the partition table This displays the partition table on @device, in the human-readable output of the sfdisk(8) command. It is not intended to be parsed. @@ -27630,18 +31375,18 @@ output of the sfdisk(8) command. It is not intended to be parsed. See also: guestfs_session_part_list() In new code, use guestfs_session_part_list() instead + line="666"/> the returned string, or NULL on error + line="26365">the returned string, or NULL on error A GuestfsSession object + line="26354">A GuestfsSession object @@ -27655,7 +31400,7 @@ See also: guestfs_session_part_list() throws="1"> run a command via the shell + line="26389">run a command via the shell This call runs a command from the guest filesystem via the guest’s /bin/sh. @@ -27669,18 +31414,18 @@ expanded, shell expressions being interpolated and so on. All the provisos about guestfs_session_command() apply to this call. + line="667"/> the returned string, or NULL on error + line="26409">the returned string, or NULL on error A GuestfsSession object + line="26391">A GuestfsSession object @@ -27694,18 +31439,18 @@ All the provisos about guestfs_session_command() apply to this call. throws="1"> run a command via the shell returning lines + line="26432">run a command via the shell returning lines This is the same as guestfs_session_sh(), but splits the result into a list of lines. See also: guestfs_session_command_lines() + line="668"/> an array of returned strings, or NULL on error + line="26445">an array of returned strings, or NULL on error @@ -27714,7 +31459,7 @@ See also: guestfs_session_command_lines() A GuestfsSession object + line="26434">A GuestfsSession object @@ -27728,7 +31473,7 @@ See also: guestfs_session_command_lines() throws="1"> shutdown the hypervisor + line="26468">shutdown the hypervisor This is the opposite of guestfs_session_launch(). It performs an orderly shutdown of the backend process(es). If the autosync flag is set (which @@ -27746,18 +31491,18 @@ guestfs_session_close() afterwards. guestfs_session_close() will call this if you don't do it explicitly, but note that any errors are ignored in that case. + line="669"/> true on success, false on error + line="26491">true on success, false on error A GuestfsSession object + line="26470">A GuestfsSession object @@ -27768,22 +31513,22 @@ but note that any errors are ignored in that case. throws="1"> sleep for some seconds + line="26514">sleep for some seconds Sleep for @secs seconds. + line="670"/> true on success, false on error + line="26524">true on success, false on error A GuestfsSession object + line="26516">A GuestfsSession object @@ -27798,25 +31543,25 @@ Sleep for @secs seconds. throws="1"> get file information + line="26547">get file information Returns file information for the given @path. This is the same as the stat(2) system call. In new code, use guestfs_session_statns() instead + line="671"/> a Stat object, or NULL on error + line="26559">a Stat object, or NULL on error A GuestfsSession object + line="26549">A GuestfsSession object @@ -27830,24 +31575,24 @@ This is the same as the stat(2) system call. throws="1"> get file information + line="26598">get file information Returns file information for the given @path. This is the same as the stat(2) system call. + line="672"/> a StatNS object, or NULL on error + line="26610">a StatNS object, or NULL on error A GuestfsSession object + line="26600">A GuestfsSession object @@ -27861,7 +31606,7 @@ This is the same as the stat(2) system call. throws="1"> get file system statistics + line="26657">get file system statistics Returns file system statistics for any mounted file system. @path should be a file or directory in the mounted file system (typically it is the @@ -27869,18 +31614,18 @@ mount point itself, but it doesn't need to be). This is the same as the statvfs(2) system call. + line="673"/> a StatVFS object, or NULL on error + line="26671">a StatVFS object, or NULL on error A GuestfsSession object + line="26659">A GuestfsSession object @@ -27894,7 +31639,7 @@ This is the same as the statvfs(2) system call. throws="1"> print the printable strings in a file + line="26707">print the printable strings in a file This runs the strings(1) command on a file and returns the list of printable strings found. @@ -27903,11 +31648,11 @@ The @strings command has, in the past, had problems with parsing untrusted files. These are mitigated in the current version of libguestfs, but see "CVE-2014-8484" in guestfs(3). + line="674"/> an array of returned strings, or NULL on error + line="26722">an array of returned strings, or NULL on error @@ -27916,7 +31661,7 @@ libguestfs, but see "CVE-2014-8484" in guestfs(3). A GuestfsSession object + line="26709">A GuestfsSession object @@ -27930,7 +31675,7 @@ libguestfs, but see "CVE-2014-8484" in guestfs(3). throws="1"> print the printable strings in a file + line="26745">print the printable strings in a file This is like the guestfs_session_strings() command, but allows you to specify the encoding of strings that are looked for in the source file @@ -27960,11 +31705,11 @@ The @strings command has, in the past, had problems with parsing untrusted files. These are mitigated in the current version of libguestfs, but see "CVE-2014-8484" in guestfs(3). + line="675"/> an array of returned strings, or NULL on error + line="26782">an array of returned strings, or NULL on error @@ -27973,7 +31718,7 @@ libguestfs, but see "CVE-2014-8484" in guestfs(3). A GuestfsSession object + line="26747">A GuestfsSession object @@ -27990,23 +31735,23 @@ libguestfs, but see "CVE-2014-8484" in guestfs(3). throws="1"> disable swap on device + line="26805">disable swap on device This command disables the libguestfs appliance swap device or partition named @device. See guestfs_session_swapon_device(). + line="676"/> true on success, false on error + line="26816">true on success, false on error A GuestfsSession object + line="26807">A GuestfsSession object @@ -28020,22 +31765,22 @@ named @device. See guestfs_session_swapon_device(). throws="1"> disable swap on file + line="26839">disable swap on file This command disables the libguestfs appliance swap on file. + line="677"/> true on success, false on error + line="26849">true on success, false on error A GuestfsSession object + line="26841">A GuestfsSession object @@ -28049,23 +31794,23 @@ This command disables the libguestfs appliance swap on file. throws="1"> disable swap on labeled swap partition + line="26872">disable swap on labeled swap partition This command disables the libguestfs appliance swap on labeled swap partition. + line="678"/> true on success, false on error + line="26883">true on success, false on error A GuestfsSession object + line="26874">A GuestfsSession object @@ -28079,7 +31824,7 @@ partition. throws="1"> disable swap on swap partition by UUID + line="26906">disable swap on swap partition by UUID This command disables the libguestfs appliance swap partition with the given UUID. @@ -28087,18 +31832,18 @@ given UUID. This function depends on the feature "linuxfsuuid". See also guestfs_session_feature_available(). + line="679"/> true on success, false on error + line="26920">true on success, false on error A GuestfsSession object + line="26908">A GuestfsSession object @@ -28112,7 +31857,7 @@ See also guestfs_session_feature_available(). throws="1"> enable swap on device + line="26943">enable swap on device This command enables the libguestfs appliance to use the swap device or partition named @device. The increased memory is made available for all @@ -28125,18 +31870,18 @@ or other information that the guest doesn't want you to trash. You also risk leaking information about the host to the guest this way. Instead, attach a new host device to the guest and swap on that. + line="680"/> true on success, false on error + line="26962">true on success, false on error A GuestfsSession object + line="26945">A GuestfsSession object @@ -28150,23 +31895,23 @@ attach a new host device to the guest and swap on that. throws="1"> enable swap on file + line="26985">enable swap on file This command enables swap to a file. See guestfs_session_swapon_device() for other notes. + line="681"/> true on success, false on error + line="26996">true on success, false on error A GuestfsSession object + line="26987">A GuestfsSession object @@ -28180,23 +31925,23 @@ for other notes. throws="1"> enable swap on labeled swap partition + line="27019">enable swap on labeled swap partition This command enables swap to a labeled swap partition. See guestfs_session_swapon_device() for other notes. + line="682"/> true on success, false on error + line="27030">true on success, false on error A GuestfsSession object + line="27021">A GuestfsSession object @@ -28210,7 +31955,7 @@ guestfs_session_swapon_device() for other notes. throws="1"> enable swap on swap partition by UUID + line="27053">enable swap on swap partition by UUID This command enables swap to a swap partition with the given UUID. See guestfs_session_swapon_device() for other notes. @@ -28218,18 +31963,18 @@ guestfs_session_swapon_device() for other notes. This function depends on the feature "linuxfsuuid". See also guestfs_session_feature_available(). + line="683"/> true on success, false on error + line="27067">true on success, false on error A GuestfsSession object + line="27055">A GuestfsSession object @@ -28243,7 +31988,7 @@ See also guestfs_session_feature_available(). throws="1"> sync disks, writes are flushed through to the disk image + line="27090">sync disks, writes are flushed through to the disk image This syncs the disk, so that any writes are flushed through to the underlying disk image. @@ -28251,18 +31996,18 @@ underlying disk image. You should always call this if you have modified a disk image, before closing the handle. + line="684"/> true on success, false on error + line="27103">true on success, false on error A GuestfsSession object + line="27092">A GuestfsSession object @@ -28273,7 +32018,7 @@ closing the handle. throws="1"> install the SYSLINUX bootloader + line="27126">install the SYSLINUX bootloader Install the SYSLINUX bootloader on @device. @@ -28302,18 +32047,18 @@ See also guestfs_session_extlinux(). This function depends on the feature "syslinux". See also guestfs_session_feature_available(). + line="685"/> true on success, false on error + line="27162">true on success, false on error A GuestfsSession object + line="27128">A GuestfsSession object @@ -28325,7 +32070,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsSyslinux containing optional arguments + line="27130">a GuestfsSyslinux containing optional arguments @@ -28336,16 +32081,16 @@ See also guestfs_session_feature_available(). throws="1"> return last 10 lines of a file + line="27201">return last 10 lines of a file This command returns up to the last 10 lines of a file as a list of strings. + line="686"/> an array of returned strings, or NULL on error + line="27212">an array of returned strings, or NULL on error @@ -28354,7 +32099,7 @@ strings. A GuestfsSession object + line="27203">A GuestfsSession object @@ -28368,21 +32113,21 @@ strings. throws="1"> return last N lines of a file + line="27235">return last N lines of a file If the parameter @nrlines is a positive number, this returns the last @nrlines lines of the file @path. If the parameter @nrlines is a negative number, this returns lines from -the file @path, starting with the @-nrlinesth line. +the file @path, starting with the @-nrlines'th line. If the parameter @nrlines is zero, this returns an empty list. + line="687"/> an array of returned strings, or NULL on error + line="27252">an array of returned strings, or NULL on error @@ -28391,7 +32136,7 @@ If the parameter @nrlines is zero, this returns an empty list. A GuestfsSession object + line="27237">A GuestfsSession object @@ -28408,15 +32153,15 @@ If the parameter @nrlines is zero, this returns an empty list. throws="1"> unpack tarfile to directory + line="27275">unpack tarfile to directory This command uploads and unpacks local file @tarfile into directory. The optional @compress flag controls compression. If not given, then the input should be an uncompressed tar file. Otherwise one of the following strings may be given to select the compression type of the input file: -@compress, @gzip, @bzip2, @xz, @lzop. (Note that not all builds of -libguestfs will support all of these compression types). +@compress, @gzip, @bzip2, @xz, @lzop, @lzma, @zstd. (Note that not all +builds of libguestfs will support all of these compression types). The other optional arguments are: @@ -28429,18 +32174,18 @@ If set to true, SELinux contexts are restored from the tar file. @acls If set to true, POSIX ACLs are restored from the tar file. + line="688"/> true on success, false on error + line="27305">true on success, false on error A GuestfsSession object + line="27277">A GuestfsSession object @@ -28455,7 +32200,7 @@ If set to true, POSIX ACLs are restored from the tar file. allow-none="1"> a GuestfsTarIn containing optional arguments + line="27280">a GuestfsTarIn containing optional arguments allow-none="1"> A GCancellable object + line="27281">A GCancellable object @@ -28475,7 +32220,7 @@ If set to true, POSIX ACLs are restored from the tar file. throws="1"> pack directory into tarfile + line="27380">pack directory into tarfile This command packs the contents of directory and downloads it to local file @tarfile. @@ -28483,8 +32228,8 @@ file @tarfile. The optional @compress flag controls compression. If not given, then the output will be an uncompressed tar file. Otherwise one of the following strings may be given to select the compression type of the output file: -@compress, @gzip, @bzip2, @xz, @lzop. (Note that not all builds of -libguestfs will support all of these compression types). +@compress, @gzip, @bzip2, @xz, @lzop, @lzma, @zstd. (Note that not all +builds of libguestfs will support all of these compression types). The other optional arguments are: @@ -28505,18 +32250,18 @@ If set to true, SELinux contexts are saved in the output tar. @acls If set to true, POSIX ACLs are saved in the output tar. + line="689"/> true on success, false on error + line="27419">true on success, false on error A GuestfsSession object + line="27382">A GuestfsSession object @@ -28531,7 +32276,7 @@ If set to true, POSIX ACLs are saved in the output tar. allow-none="1"> a GuestfsTarOut containing optional arguments + line="27385">a GuestfsTarOut containing optional arguments allow-none="1"> A GCancellable object + line="27386">A GCancellable object @@ -28552,24 +32297,24 @@ If set to true, POSIX ACLs are saved in the output tar. throws="1"> unpack compressed tarball to directory + line="27502">unpack compressed tarball to directory This command uploads and unpacks local file @tarball (a *gzip compressed* tar file) into directory. In new code, use guestfs_session_tar_in() instead + line="690"/> true on success, false on error + line="27515">true on success, false on error A GuestfsSession object + line="27504">A GuestfsSession object @@ -28584,7 +32329,7 @@ compressed* tar file) into directory. allow-none="1"> A GCancellable object + line="27507">A GCancellable object @@ -28596,24 +32341,24 @@ compressed* tar file) into directory. throws="1"> pack directory into compressed tarball + line="27551">pack directory into compressed tarball This command packs the contents of directory and downloads it to local file @tarball. In new code, use guestfs_session_tar_out() instead + line="691"/> true on success, false on error + line="27564">true on success, false on error A GuestfsSession object + line="27553">A GuestfsSession object @@ -28628,7 +32373,7 @@ file @tarball. allow-none="1"> A GCancellable object + line="27556">A GCancellable object @@ -28639,7 +32384,7 @@ file @tarball. throws="1"> update file timestamps or create a new file + line="27600">update file timestamps or create a new file Touch acts like the touch(1) command. It can be used to update the timestamps on a file, or, if the file does not exist, to create a new @@ -28648,18 +32393,18 @@ zero-length file. This command only works on regular files, and will fail on other file types such as directories, symbolic links, block special etc. + line="692"/> true on success, false on error + line="27615">true on success, false on error A GuestfsSession object + line="27602">A GuestfsSession object @@ -28673,23 +32418,23 @@ types such as directories, symbolic links, block special etc. throws="1"> truncate a file to zero size + line="27638">truncate a file to zero size This command truncates @path to a zero-length file. The file must exist already. + line="693"/> true on success, false on error + line="27649">true on success, false on error A GuestfsSession object + line="27640">A GuestfsSession object @@ -28703,7 +32448,7 @@ already. throws="1"> truncate a file to a particular size + line="27672">truncate a file to a particular size This command truncates @path to size @size bytes. The file must exist already. @@ -28713,18 +32458,18 @@ the required size with zero bytes. This creates a sparse file (ie. disk blocks are not allocated for the file until you write to it). To create a non-sparse file of zeroes, use guestfs_session_fallocate64() instead. + line="694"/> true on success, false on error + line="27689">true on success, false on error A GuestfsSession object + line="27674">A GuestfsSession object @@ -28741,7 +32486,7 @@ a non-sparse file of zeroes, use guestfs_session_fallocate64() instead. throws="1"> adjust ext2/ext3/ext4 filesystem parameters + line="27712">adjust ext2/ext3/ext4 filesystem parameters This call allows you to adjust various filesystem parameters of an ext2/ext3/ext4 filesystem called @device. @@ -28750,16 +32495,16 @@ The optional parameters are: @force Force tune2fs to complete the operation even in the face of errors. -This is the same as the tune2fs @-f option. +This is the same as the tune2fs(8) @-f option. @maxmountcount Set the number of mounts after which the filesystem is checked by e2fsck(8). If this is @0 then the number of mounts is disregarded. -This is the same as the tune2fs @-c option. +This is the same as the tune2fs(8) @-c option. @mountcount Set the number of times the filesystem has been mounted. This is the -same as the tune2fs @-C option. +same as the tune2fs(8) @-C option. @errorbehavior Change the behavior of the kernel code when errors are detected. @@ -28767,51 +32512,51 @@ Possible values currently are: @continue, @remount-ro, @panic. In practice these options don't really make any difference, particularly for write errors. -This is the same as the tune2fs @-e option. +This is the same as the tune2fs(8) @-e option. @group Set the group which can use reserved filesystem blocks. This is the -same as the tune2fs @-g option except that it can only be specified -as a number. +same as the tune2fs(8) @-g option except that it can only be +specified as a number. @intervalbetweenchecks Adjust the maximal time between two filesystem checks (in seconds). If the option is passed as @0 then time-dependent checking is disabled. -This is the same as the tune2fs @-i option. +This is the same as the tune2fs(8) @-i option. @reservedblockspercentage Set the percentage of the filesystem which may only be allocated by -privileged processes. This is the same as the tune2fs @-m option. +privileged processes. This is the same as the tune2fs(8) @-m option. @lastmounteddirectory -Set the last mounted directory. This is the same as the tune2fs @-M -option. +Set the last mounted directory. This is the same as the tune2fs(8) +@-M option. @reservedblockscount Set the number of reserved filesystem blocks. This -is the same as the tune2fs @-r option. +is the same as the tune2fs(8) @-r option. @user Set the user who can use the reserved filesystem blocks. This is the -same as the tune2fs @-u option except that it can only be specified -as a number. +same as the tune2fs(8) @-u option except that it can only be +specified as a number. To get the current values of filesystem parameters, see guestfs_session_tune2fs_l(). For precise details of how tune2fs works, see the tune2fs(8) man page. + line="695"/> true on success, false on error + line="27778">true on success, false on error A GuestfsSession object + line="27714">A GuestfsSession object @@ -28823,7 +32568,7 @@ see the tune2fs(8) man page. allow-none="1"> a GuestfsTune2FS containing optional arguments + line="27716">a GuestfsTune2FS containing optional arguments @@ -28834,7 +32579,7 @@ see the tune2fs(8) man page. throws="1"> get ext2/ext3/ext4 superblock details + line="27889">get ext2/ext3/ext4 superblock details This returns the contents of the ext2, ext3 or ext4 filesystem superblock on @device. @@ -28844,11 +32589,11 @@ for more details. The list of fields returned isn't clearly defined, and depends on both the version of @tune2fs that libguestfs was built against, and the filesystem itself. + line="696"/> a GHashTable of results, or NULL on error + line="27905">a GHashTable of results, or NULL on error @@ -28858,7 +32603,7 @@ against, and the filesystem itself. A GuestfsSession object + line="27891">A GuestfsSession object @@ -28873,7 +32618,7 @@ against, and the filesystem itself. throws="1"> unpack compressed tarball to directory + line="27936">unpack compressed tarball to directory This command uploads and unpacks local file @tarball (an *xz compressed* tar file) into directory. @@ -28882,18 +32627,18 @@ This function depends on the feature "xz". See also guestfs_session_feature_available(). In new code, use guestfs_session_tar_in() instead + line="697"/> true on success, false on error + line="27952">true on success, false on error A GuestfsSession object + line="27938">A GuestfsSession object @@ -28908,7 +32653,7 @@ See also guestfs_session_feature_available(). allow-none="1"> A GCancellable object + line="27941">A GCancellable object @@ -28920,7 +32665,7 @@ See also guestfs_session_feature_available(). throws="1"> pack directory into compressed tarball + line="27988">pack directory into compressed tarball This command packs the contents of directory and downloads it to local file @tarball (as an xz compressed tar archive). @@ -28929,18 +32674,18 @@ This function depends on the feature "xz". See also guestfs_session_feature_available(). In new code, use guestfs_session_tar_out() instead + line="698"/> true on success, false on error + line="28004">true on success, false on error A GuestfsSession object + line="27990">A GuestfsSession object @@ -28955,7 +32700,7 @@ See also guestfs_session_feature_available(). allow-none="1"> A GCancellable object + line="27993">A GCancellable object @@ -28966,7 +32711,7 @@ See also guestfs_session_feature_available(). throws="1"> set file mode creation mask (umask) + line="28040">set file mode creation mask (umask) This function sets the mask used for creating new files and device nodes to "mask & 0777". @@ -28984,18 +32729,18 @@ guestfs_session_mkdir(). This call returns the previous umask. + line="699"/> the returned value, or -1 on error + line="28064">the returned value, or -1 on error A GuestfsSession object + line="28042">A GuestfsSession object @@ -29009,24 +32754,24 @@ This call returns the previous umask. throws="1"> unmount a filesystem + line="28087">unmount a filesystem This unmounts the given filesystem. The filesystem may be specified either by its mountpoint (path) or the device which contains the filesystem. + line="700"/> true on success, false on error + line="28100">true on success, false on error A GuestfsSession object + line="28089">A GuestfsSession object @@ -29038,7 +32783,7 @@ filesystem. allow-none="1"> a GuestfsUmount containing optional arguments + line="28091">a GuestfsUmount containing optional arguments @@ -29049,24 +32794,24 @@ filesystem. throws="1"> unmount all filesystems + line="28147">unmount all filesystems This unmounts all mounted filesystems. Some internal mounts are not unmounted by this call. + line="701"/> true on success, false on error + line="28158">true on success, false on error A GuestfsSession object + line="28149">A GuestfsSession object @@ -29077,25 +32822,25 @@ Some internal mounts are not unmounted by this call. throws="1"> unmount a locally mounted filesystem + line="28181">unmount a locally mounted filesystem If libguestfs is exporting the filesystem on a local mountpoint, then this unmounts it. See "MOUNT LOCAL" in guestfs(3) for full documentation. + line="702"/> true on success, false on error + line="28194">true on success, false on error A GuestfsSession object + line="28183">A GuestfsSession object allow-none="1"> a GuestfsUmountLocal containing optional arguments + line="28184">a GuestfsUmountLocal containing optional arguments @@ -29115,7 +32860,7 @@ See "MOUNT LOCAL" in guestfs(3) for full documentation. throws="1"> upload a file from the local machine + line="28233">upload a file from the local machine Upload local file filename to remotefilename on the filesystem. @@ -29123,18 +32868,18 @@ filename can also be a named pipe. See also guestfs_session_download(). + line="703"/> true on success, false on error + line="28249">true on success, false on error A GuestfsSession object + line="28235">A GuestfsSession object @@ -29149,7 +32894,7 @@ See also guestfs_session_download(). allow-none="1"> A GCancellable object + line="28238">A GCancellable object @@ -29160,7 +32905,7 @@ See also guestfs_session_download(). throws="1"> upload a file from the local machine with offset + line="28284">upload a file from the local machine with offset Upload local file filename to remotefilename on the filesystem. @@ -29176,18 +32921,18 @@ always writes the full amount unless an error occurs. See also guestfs_session_upload(), guestfs_session_pwrite(). + line="704"/> true on success, false on error + line="28309">true on success, false on error A GuestfsSession object + line="28286">A GuestfsSession object @@ -29205,7 +32950,7 @@ See also guestfs_session_upload(), guestfs_session_pwrite(). allow-none="1"> A GCancellable object + line="28290">A GCancellable object @@ -29216,7 +32961,7 @@ See also guestfs_session_upload(), guestfs_session_pwrite(). throws="1"> cancel the current upload or download operation + line="28344">cancel the current upload or download operation This function cancels the current upload or download operation. @@ -29238,25 +32983,25 @@ guestfs_session_user_cancel(): In an interactive text-based program, you might call it from a @SIGINT signal handler so that pressing "^C" cancels the current operation. (You -also need to call "guestfs_set_pgroup" so that child processes don't -receive the "^C" signal). +also need to call guestfs_session_set_pgroup() so that child processes +don't receive the "^C" signal). In a graphical program, when the main thread is displaying a progress bar with a cancel button, wire up the cancel button to call this function. + line="705"/> true on success, false on error + line="28378">true on success, false on error A GuestfsSession object + line="28346">A GuestfsSession object @@ -29267,14 +33012,14 @@ function. throws="1"> set timestamp of a file with nanosecond precision + line="28401">set timestamp of a file with nanosecond precision This command sets the timestamps of a file with nanosecond precision. -"atsecs, atnsecs" are the last access time (atime) in secs and +@atsecs, @atnsecs are the last access time (atime) in secs and nanoseconds from the epoch. -"mtsecs, mtnsecs" are the last modification time (mtime) in secs and +@mtsecs, @mtnsecs are the last modification time (mtime) in secs and nanoseconds from the epoch. If the *nsecs field contains the special value @-1 then the @@ -29285,18 +33030,18 @@ If the *nsecs field contains the special value @-2 then the corresponding timestamp is left unchanged. (The *secs field is ignored in this case). + line="706"/> true on success, false on error + line="28429">true on success, false on error A GuestfsSession object + line="28403">A GuestfsSession object @@ -29322,24 +33067,24 @@ in this case). throws="1"> appliance kernel version + line="28452">appliance kernel version This returns the kernel version of the appliance, where this is available. This information is only useful for debugging. Nothing in the returned structure is defined by the API. + line="707"/> a UTSName object, or NULL on error + line="28463">a UTSName object, or NULL on error A GuestfsSession object + line="28454">A GuestfsSession object @@ -29350,7 +33095,7 @@ returned structure is defined by the API. throws="1"> get the library version number + line="28492">get the library version number Return the libguestfs version number that the program is linked against. @@ -29379,18 +33124,18 @@ earlier versions, making this an unreliable way to test for features. Use guestfs_session_available() or guestfs_session_feature_available() instead. + line="708"/> a Version object, or NULL on error + line="28526">a Version object, or NULL on error A GuestfsSession object + line="28494">A GuestfsSession object @@ -29401,7 +33146,7 @@ instead. throws="1"> get the filesystem label + line="28555">get the filesystem label This returns the label of the filesystem on @mountable. @@ -29409,18 +33154,18 @@ If the filesystem is unlabeled, this returns the empty string. To find a filesystem from the label, use guestfs_session_findfs_label(). + line="709"/> the returned string, or NULL on error + line="28569">the returned string, or NULL on error A GuestfsSession object + line="28557">A GuestfsSession object @@ -29434,7 +33179,7 @@ To find a filesystem from the label, use guestfs_session_findfs_label(). throws="1"> get minimum filesystem size + line="28592">get minimum filesystem size Get the minimum size of filesystem in bytes. This is the minimum possible size for filesystem shrinking. @@ -29444,18 +33189,18 @@ will fail and set errno as ENOTSUP. See also ntfsresize(8), resize2fs(8), btrfs(8), xfs_info(8). + line="710"/> the returned value, or -1 on error + line="28608">the returned value, or -1 on error A GuestfsSession object + line="28594">A GuestfsSession object @@ -29469,7 +33214,7 @@ See also ntfsresize(8), resize2fs(8), btrfs(8), xfs_info(8). throws="1"> get the Linux VFS type corresponding to a mounted device + line="28631">get the Linux VFS type corresponding to a mounted device This command gets the filesystem type corresponding to the filesystem on @mountable. @@ -29479,18 +33224,18 @@ which would be used to mount this filesystem if you mounted it without specifying the filesystem type. For example a string such as @ext3 or @ntfs. + line="711"/> the returned string, or NULL on error + line="28647">the returned string, or NULL on error A GuestfsSession object + line="28633">A GuestfsSession object @@ -29504,7 +33249,7 @@ specifying the filesystem type. For example a string such as @ext3 or throws="1"> get the filesystem UUID + line="28670">get the filesystem UUID This returns the filesystem UUID of the filesystem on @mountable. @@ -29512,18 +33257,18 @@ If the filesystem does not have a UUID, this returns the empty string. To find a filesystem from the UUID, use guestfs_session_findfs_uuid(). + line="712"/> the returned string, or NULL on error + line="28684">the returned string, or NULL on error A GuestfsSession object + line="28672">A GuestfsSession object @@ -29537,7 +33282,7 @@ To find a filesystem from the UUID, use guestfs_session_findfs_uuid(). throws="1"> activate or deactivate some volume groups + line="28707">activate or deactivate some volume groups This command activates or (if @activate is false) deactivates all logical volumes in the listed volume groups @volgroups. @@ -29550,18 +33295,18 @@ activated or deactivated. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="713"/> true on success, false on error + line="28727">true on success, false on error A GuestfsSession object + line="28709">A GuestfsSession object @@ -29570,7 +33315,7 @@ See also guestfs_session_feature_available(). an array of strings + line="28711">an array of strings @@ -29583,7 +33328,7 @@ See also guestfs_session_feature_available(). throws="1"> activate or deactivate all volume groups + line="28750">activate or deactivate all volume groups This command activates or (if @activate is false) deactivates all logical volumes in all volume groups. @@ -29593,18 +33338,18 @@ This command is the same as running "vgchange -a y|n" This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="714"/> true on success, false on error + line="28766">true on success, false on error A GuestfsSession object + line="28752">A GuestfsSession object @@ -29618,25 +33363,25 @@ See also guestfs_session_feature_available(). throws="1"> generate a new random UUID for a volume group + line="28789">generate a new random UUID for a volume group Generate a new random UUID for the volume group @vg. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="715"/> true on success, false on error + line="28802">true on success, false on error A GuestfsSession object + line="28791">A GuestfsSession object @@ -29650,25 +33395,25 @@ See also guestfs_session_feature_available(). throws="1"> generate new random UUIDs for all volume groups + line="28825">generate new random UUIDs for all volume groups Generate new random UUIDs for all volume groups. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="716"/> true on success, false on error + line="28837">true on success, false on error A GuestfsSession object + line="28827">A GuestfsSession object @@ -29679,7 +33424,7 @@ See also guestfs_session_feature_available(). throws="1"> create an LVM volume group + line="28860">create an LVM volume group This creates an LVM volume group called @volgroup from the non-empty list of physical volumes @physvols. @@ -29687,18 +33432,18 @@ list of physical volumes @physvols. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="717"/> true on success, false on error + line="28875">true on success, false on error A GuestfsSession object + line="28862">A GuestfsSession object @@ -29707,7 +33452,7 @@ See also guestfs_session_feature_available(). an array of strings + line="28864">an array of strings @@ -29720,7 +33465,7 @@ See also guestfs_session_feature_available(). throws="1"> get the LV UUIDs of all LVs in the volume group + line="28898">get the LV UUIDs of all LVs in the volume group Given a VG called @vgname, this returns the UUIDs of all the logical volumes created in this volume group. @@ -29731,11 +33476,11 @@ groups. See also guestfs_session_vgpvuuids(). + line="718"/> an array of returned strings, or NULL on error + line="28915">an array of returned strings, or NULL on error @@ -29744,7 +33489,7 @@ See also guestfs_session_vgpvuuids(). A GuestfsSession object + line="28900">A GuestfsSession object @@ -29758,7 +33503,7 @@ See also guestfs_session_vgpvuuids(). throws="1"> get volume group metadata + line="28938">get volume group metadata @vgname is an LVM volume group. This command examines the volume group and returns its metadata. @@ -29769,11 +33514,11 @@ change at any time, and is provided for information only. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="719"/> an array of binary data, or NULL on error + line="28956">an array of binary data, or NULL on error @@ -29782,7 +33527,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="28940">A GuestfsSession object @@ -29794,7 +33539,7 @@ See also guestfs_session_feature_available(). transfer-ownership="full"> The size of the returned buffer, in bytes + line="28942">The size of the returned buffer, in bytes @@ -29805,7 +33550,7 @@ See also guestfs_session_feature_available(). throws="1"> get the PV UUIDs containing the volume group + line="28979">get the PV UUIDs containing the volume group Given a VG called @vgname, this returns the UUIDs of all the physical volumes that this volume group resides on. @@ -29816,11 +33561,11 @@ groups. See also guestfs_session_vglvuuids(). + line="720"/> an array of returned strings, or NULL on error + line="28996">an array of returned strings, or NULL on error @@ -29829,7 +33574,7 @@ See also guestfs_session_vglvuuids(). A GuestfsSession object + line="28981">A GuestfsSession object @@ -29843,7 +33588,7 @@ See also guestfs_session_vglvuuids(). throws="1"> remove an LVM volume group + line="29019">remove an LVM volume group Remove an LVM volume group @vgname, (for example @VG). @@ -29853,18 +33598,18 @@ any). This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="721"/> true on success, false on error + line="29035">true on success, false on error A GuestfsSession object + line="29021">A GuestfsSession object @@ -29878,22 +33623,22 @@ See also guestfs_session_feature_available(). throws="1"> rename an LVM volume group + line="29058">rename an LVM volume group Rename a volume group @volgroup with the new name @newvolgroup. + line="722"/> true on success, false on error + line="29069">true on success, false on error A GuestfsSession object + line="29060">A GuestfsSession object @@ -29910,7 +33655,7 @@ Rename a volume group @volgroup with the new name @newvolgroup. throws="1"> list the LVM volume groups (VGs) + line="29092">list the LVM volume groups (VGs) List all the volumes groups detected. This is the equivalent of the vgs(8) command. @@ -29923,11 +33668,11 @@ See also guestfs_session_vgs_full(). This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="723"/> an array of returned strings, or NULL on error + line="29110">an array of returned strings, or NULL on error @@ -29936,7 +33681,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="29094">A GuestfsSession object @@ -29947,7 +33692,7 @@ See also guestfs_session_feature_available(). throws="1"> list the LVM volume groups (VGs) + line="29133">list the LVM volume groups (VGs) List all the volumes groups detected. This is the equivalent of the vgs(8) command. The "full" version includes all fields. @@ -29955,11 +33700,11 @@ vgs(8) command. The "full" version includes all fields. This function depends on the feature "lvm2". See also guestfs_session_feature_available(). + line="724"/> an array of VG objects, or NULL on error + line="29146">an array of VG objects, or NULL on error @@ -29968,7 +33713,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="29135">A GuestfsSession object @@ -29980,24 +33725,24 @@ See also guestfs_session_feature_available(). throws="1"> rescan for LVM physical volumes, volume groups and logical volumes + line="29195">rescan for LVM physical volumes, volume groups and logical volumes This rescans all block devices and rebuilds the list of LVM physical volumes, volume groups and logical volumes. In new code, use guestfs_session_lvm_scan() instead + line="725"/> true on success, false on error + line="29205">true on success, false on error A GuestfsSession object + line="29197">A GuestfsSession object @@ -30008,22 +33753,22 @@ volumes, volume groups and logical volumes. throws="1"> get the UUID of a volume group + line="29229">get the UUID of a volume group This command returns the UUID of the LVM VG named @vgname. + line="726"/> the returned string, or NULL on error + line="29239">the returned string, or NULL on error A GuestfsSession object + line="29231">A GuestfsSession object @@ -30038,7 +33783,7 @@ This command returns the UUID of the LVM VG named @vgname. throws="1"> wait until the hypervisor launches (no op) + line="29262">wait until the hypervisor launches (no op) This function is a no op. @@ -30052,18 +33797,18 @@ them, unless you want to retain compatibility with older versions of the API. There is no documented replacement + line="727"/> true on success, false on error + line="29280">true on success, false on error A GuestfsSession object + line="29264">A GuestfsSession object @@ -30074,23 +33819,23 @@ API. throws="1"> count characters in a file + line="29304">count characters in a file This command counts the characters in a file, using the "wc -c" external command. + line="728"/> the returned value, or -1 on error + line="29315">the returned value, or -1 on error A GuestfsSession object + line="29306">A GuestfsSession object @@ -30104,23 +33849,23 @@ command. throws="1"> count lines in a file + line="29338">count lines in a file This command counts the lines in a file, using the "wc -l" external command. + line="729"/> the returned value, or -1 on error + line="29349">the returned value, or -1 on error A GuestfsSession object + line="29340">A GuestfsSession object @@ -30134,23 +33879,23 @@ command. throws="1"> count words in a file + line="29372">count words in a file This command counts the words in a file, using the "wc -w" external command. + line="730"/> the returned value, or -1 on error + line="29383">the returned value, or -1 on error A GuestfsSession object + line="29374">A GuestfsSession object @@ -30164,7 +33909,7 @@ command. throws="1"> wipe a filesystem signature from a device + line="29406">wipe a filesystem signature from a device This command erases filesystem or RAID signatures from the specified @device to make the filesystem invisible to libblkid. @@ -30178,18 +33923,18 @@ a device. This function depends on the feature "wipefs". See also guestfs_session_feature_available(). + line="731"/> true on success, false on error + line="29426">true on success, false on error A GuestfsSession object + line="29408">A GuestfsSession object @@ -30203,25 +33948,25 @@ See also guestfs_session_feature_available(). throws="1"> create a new file + line="29449">create a new file This call creates a file called @path. The content of the file is the string @content (which can contain any 8 bit data). See also guestfs_session_write_append(). + line="732"/> true on success, false on error + line="29464">true on success, false on error A GuestfsSession object + line="29451">A GuestfsSession object @@ -30230,7 +33975,7 @@ See also guestfs_session_write_append(). an array of binary data + line="29453">an array of binary data @@ -30238,7 +33983,7 @@ See also guestfs_session_write_append(). The size of content, in bytes + line="29454">The size of content, in bytes @@ -30249,25 +33994,25 @@ See also guestfs_session_write_append(). throws="1"> append content to end of file + line="29487">append content to end of file This call appends @content to the end of file @path. If @path does not exist, then a new file is created. See also guestfs_session_write(). + line="733"/> true on success, false on error + line="29502">true on success, false on error A GuestfsSession object + line="29489">A GuestfsSession object @@ -30276,7 +34021,7 @@ See also guestfs_session_write(). an array of binary data + line="29491">an array of binary data @@ -30284,7 +34029,7 @@ See also guestfs_session_write(). The size of content, in bytes + line="29492">The size of content, in bytes @@ -30296,7 +34041,7 @@ See also guestfs_session_write(). throws="1"> create a file + line="29525">create a file This call creates a file called @path. The contents of the file is the string @content (which can contain any 8 bit data), with length @size. @@ -30309,18 +34054,18 @@ NULs). does *not* work, even if the length is specified. In new code, use guestfs_session_write() instead + line="734"/> true on success, false on error + line="29545">true on success, false on error A GuestfsSession object + line="29527">A GuestfsSession object @@ -30340,7 +34085,7 @@ does *not* work, even if the length is specified. throws="1"> change parameters of an XFS filesystem + line="29569">change parameters of an XFS filesystem Change the parameters of the XFS filesystem on @device. @@ -30351,21 +34096,24 @@ Some of the parameters of a mounted filesystem can be examined and modified using the guestfs_session_xfs_info() and guestfs_session_xfs_growfs() calls. +Beginning with XFS version 5, it is no longer possible to modify the +lazy-counters setting (ie. @lazycounter parameter has no effect). + This function depends on the feature "xfs". See also guestfs_session_feature_available(). + line="735"/> true on success, false on error + line="29593">true on success, false on error A GuestfsSession object + line="29571">A GuestfsSession object @@ -30377,7 +34125,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsXfsAdmin containing optional arguments + line="29573">a GuestfsXfsAdmin containing optional arguments @@ -30388,7 +34136,7 @@ See also guestfs_session_feature_available(). throws="1"> expand an existing XFS filesystem + line="29680">expand an existing XFS filesystem Grow the XFS filesystem mounted at @path. @@ -30398,18 +34146,18 @@ returned as @-1 (for numeric fields) or empty string. This function depends on the feature "xfs". See also guestfs_session_feature_available(). + line="736"/> true on success, false on error + line="29697">true on success, false on error A GuestfsSession object + line="29682">A GuestfsSession object @@ -30421,7 +34169,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsXfsGrowfs containing optional arguments + line="29684">a GuestfsXfsGrowfs containing optional arguments @@ -30432,7 +34180,7 @@ See also guestfs_session_feature_available(). throws="1"> get geometry of XFS filesystem + line="29792">get geometry of XFS filesystem @pathordevice is a mounted XFS filesystem or a device containing an XFS filesystem. This command returns the geometry of the filesystem. @@ -30443,18 +34191,18 @@ returned as @-1 (for numeric fields) or empty string. This function depends on the feature "xfs". See also guestfs_session_feature_available(). + line="737"/> a XFSInfo object, or NULL on error + line="29809">a XFSInfo object, or NULL on error A GuestfsSession object + line="29794">A GuestfsSession object @@ -30468,7 +34216,7 @@ See also guestfs_session_feature_available(). throws="1"> repair an XFS filesystem + line="29859">repair an XFS filesystem Repair corrupt or damaged XFS filesystem on @device. @@ -30487,18 +34235,18 @@ The returned status indicates whether filesystem corruption was detected This function depends on the feature "xfs". See also guestfs_session_feature_available(). + line="738"/> the returned value, or -1 on error + line="29885">the returned value, or -1 on error A GuestfsSession object + line="29861">A GuestfsSession object @@ -30510,7 +34258,7 @@ See also guestfs_session_feature_available(). allow-none="1"> a GuestfsXfsRepair containing optional arguments + line="29863">a GuestfsXfsRepair containing optional arguments @@ -30521,7 +34269,7 @@ See also guestfs_session_feature_available(). throws="1"> destroy previously loaded yara rules + line="29996">destroy previously loaded yara rules Destroy previously loaded Yara rules in order to free libguestfs resources. @@ -30529,18 +34277,18 @@ resources. This function depends on the feature "libyara". See also guestfs_session_feature_available(). + line="739"/> true on success, false on error + line="30009">true on success, false on error A GuestfsSession object + line="29998">A GuestfsSession object @@ -30551,7 +34299,7 @@ See also guestfs_session_feature_available(). throws="1"> load yara rules within libguestfs + line="30032">load yara rules within libguestfs Upload a set of Yara rules from local file filename. @@ -30571,18 +34319,18 @@ Previously loaded rules will be destroyed. This function depends on the feature "libyara". See also guestfs_session_feature_available(). + line="740"/> true on success, false on error + line="30059">true on success, false on error A GuestfsSession object + line="30034">A GuestfsSession object @@ -30594,7 +34342,7 @@ See also guestfs_session_feature_available(). allow-none="1"> A GCancellable object + line="30036">A GCancellable object @@ -30605,7 +34353,7 @@ See also guestfs_session_feature_available(). throws="1"> scan a file with the loaded yara rules + line="30094">scan a file with the loaded yara rules Scan a file with the previously loaded Yara rules. @@ -30622,11 +34370,11 @@ Identifier of the Yara rule which matched against the given file. This function depends on the feature "libyara". See also guestfs_session_feature_available(). + line="741"/> an array of YaraDetection objects, or NULL on error + line="30118">an array of YaraDetection objects, or NULL on error @@ -30635,7 +34383,7 @@ See also guestfs_session_feature_available(). A GuestfsSession object + line="30096">A GuestfsSession object @@ -30647,7 +34395,7 @@ See also guestfs_session_feature_available(). allow-none="1"> A GCancellable object + line="30098">A GCancellable object @@ -30659,16 +34407,16 @@ See also guestfs_session_feature_available(). throws="1"> return lines matching a pattern + line="30162">return lines matching a pattern This calls the external @zegrep program and returns the matching lines. In new code, use guestfs_session_grep() instead + line="742"/> an array of returned strings, or NULL on error + line="30173">an array of returned strings, or NULL on error @@ -30677,7 +34425,7 @@ This calls the external @zegrep program and returns the matching lines. A GuestfsSession object + line="30164">A GuestfsSession object @@ -30695,17 +34443,17 @@ This calls the external @zegrep program and returns the matching lines. throws="1"> return lines matching a pattern + line="30197">return lines matching a pattern This calls the external "zegrep -i" program and returns the matching lines. In new code, use guestfs_session_grep() instead + line="743"/> an array of returned strings, or NULL on error + line="30209">an array of returned strings, or NULL on error @@ -30714,7 +34462,7 @@ lines. A GuestfsSession object + line="30199">A GuestfsSession object @@ -30731,7 +34479,7 @@ lines. throws="1"> write zeroes to the device + line="30233">write zeroes to the device This command writes zeroes over the first few blocks of @device. @@ -30746,18 +34494,18 @@ unnecessarily. See also: guestfs_session_zero_device(), guestfs_session_scrub_device(), guestfs_session_is_zero_device() + line="744"/> true on success, false on error + line="30254">true on success, false on error A GuestfsSession object + line="30235">A GuestfsSession object @@ -30771,7 +34519,7 @@ guestfs_session_is_zero_device() throws="1"> write zeroes to an entire device + line="30277">write zeroes to an entire device This command writes zeroes over the entire @device. Compare with guestfs_session_zero() which just zeroes the first few blocks of a @@ -30781,18 +34529,18 @@ If blocks are already zero, then this command avoids writing zeroes. This prevents the underlying device from becoming non-sparse or growing unnecessarily. + line="745"/> true on success, false on error + line="30293">true on success, false on error A GuestfsSession object + line="30279">A GuestfsSession object @@ -30806,7 +34554,7 @@ unnecessarily. throws="1"> zero free space in a filesystem + line="30316">zero free space in a filesystem Zero the free space in the filesystem mounted on directory. The filesystem must be mounted read-write. @@ -30818,18 +34566,18 @@ Free space is not "trimmed". You may want to call guestfs_session_fstrim() either as an alternative to this, or after calling this, depending on your requirements. + line="746"/> true on success, false on error + line="30334">true on success, false on error A GuestfsSession object + line="30318">A GuestfsSession object @@ -30843,7 +34591,7 @@ calling this, depending on your requirements. throws="1"> zero unused inodes and disk blocks on ext2/3 filesystem + line="30357">zero unused inodes and disk blocks on ext2/3 filesystem This runs the *zerofree* program on @device. This program claims to zero unused inodes and disk blocks on an ext2/3 filesystem, thus making it @@ -30857,18 +34605,18 @@ on the filesystem. This function depends on the feature "zerofree". See also guestfs_session_feature_available(). + line="747"/> true on success, false on error + line="30377">true on success, false on error A GuestfsSession object + line="30359">A GuestfsSession object @@ -30883,16 +34631,16 @@ See also guestfs_session_feature_available(). throws="1"> return lines matching a pattern + line="30400">return lines matching a pattern This calls the external @zfgrep program and returns the matching lines. In new code, use guestfs_session_grep() instead + line="748"/> an array of returned strings, or NULL on error + line="30411">an array of returned strings, or NULL on error @@ -30901,7 +34649,7 @@ This calls the external @zfgrep program and returns the matching lines. A GuestfsSession object + line="30402">A GuestfsSession object @@ -30919,17 +34667,17 @@ This calls the external @zfgrep program and returns the matching lines. throws="1"> return lines matching a pattern + line="30435">return lines matching a pattern This calls the external "zfgrep -i" program and returns the matching lines. In new code, use guestfs_session_grep() instead + line="749"/> an array of returned strings, or NULL on error + line="30447">an array of returned strings, or NULL on error @@ -30938,7 +34686,7 @@ lines. A GuestfsSession object + line="30437">A GuestfsSession object @@ -30956,28 +34704,28 @@ lines. throws="1"> determine file type inside a compressed file + line="30471">determine file type inside a compressed file -This command runs file after first decompressing @path using @method. +This command runs file(1) after first decompressing @path using @meth. -@method must be one of @gzip, @compress or @bzip2. +@meth must be one of @gzip, @compress or @bzip2. Since 1.0.63, use guestfs_session_file() instead which can now process compressed files. In new code, use guestfs_session_file() instead + line="750"/> the returned string, or NULL on error + line="30487">the returned string, or NULL on error A GuestfsSession object + line="30473">A GuestfsSession object @@ -30995,16 +34743,16 @@ compressed files. throws="1"> return lines matching a pattern + line="30511">return lines matching a pattern -This calls the external @zgrep program and returns the matching lines. +This calls the external zgrep(1) program and returns the matching lines. In new code, use guestfs_session_grep() instead + line="751"/> an array of returned strings, or NULL on error + line="30522">an array of returned strings, or NULL on error @@ -31013,7 +34761,7 @@ This calls the external @zgrep program and returns the matching lines. A GuestfsSession object + line="30513">A GuestfsSession object @@ -31031,17 +34779,17 @@ This calls the external @zgrep program and returns the matching lines. throws="1"> return lines matching a pattern + line="30546">return lines matching a pattern This calls the external "zgrep -i" program and returns the matching lines. In new code, use guestfs_session_grep() instead + line="752"/> an array of returned strings, or NULL on error + line="30558">an array of returned strings, or NULL on error @@ -31050,7 +34798,7 @@ lines. A GuestfsSession object + line="30548">A GuestfsSession object @@ -31070,7 +34818,7 @@ lines. See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for + line="261">See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event. @@ -31079,7 +34827,7 @@ more details about this event. An object containing event parameters + line="264">An object containing event parameters @@ -31087,7 +34835,7 @@ more details about this event. See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for + line="189">See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event. @@ -31096,7 +34844,7 @@ more details about this event. An object containing event parameters + line="192">An object containing event parameters @@ -31104,7 +34852,7 @@ more details about this event. See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for + line="315">See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event. @@ -31113,7 +34861,7 @@ more details about this event. An object containing event parameters + line="318">An object containing event parameters @@ -31131,7 +34879,7 @@ more details about this event. See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for + line="279">See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event. @@ -31140,7 +34888,7 @@ more details about this event. An object containing event parameters + line="282">An object containing event parameters @@ -31158,7 +34906,7 @@ more details about this event. See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for + line="243">See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event. @@ -31167,7 +34915,7 @@ more details about this event. An object containing event parameters + line="246">An object containing event parameters @@ -31185,7 +34933,7 @@ more details about this event. See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for + line="297">See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event. @@ -31194,7 +34942,7 @@ more details about this event. An object containing event parameters + line="300">An object containing event parameters @@ -31202,7 +34950,7 @@ more details about this event. See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for + line="351">See "SETTING CALLBACKS TO HANDLE EVENTS" in guestfs(3) for more details about this event. @@ -31211,7 +34959,7 @@ more details about this event. An object containing event parameters + line="354">An object containing event parameters @@ -31243,7 +34991,8 @@ EVENTS" in guestfs(3). + glib:nick="close" + glib:name="GUESTFS_SESSION_EVENT_CLOSE"> The close event @@ -31251,7 +35000,8 @@ EVENTS" in guestfs(3). + glib:nick="subprocess_quit" + glib:name="GUESTFS_SESSION_EVENT_SUBPROCESS_QUIT"> The subprocess_quit event @@ -31259,7 +35009,8 @@ EVENTS" in guestfs(3). + glib:nick="launch_done" + glib:name="GUESTFS_SESSION_EVENT_LAUNCH_DONE"> The launch_done event @@ -31267,7 +35018,8 @@ EVENTS" in guestfs(3). + glib:nick="progress" + glib:name="GUESTFS_SESSION_EVENT_PROGRESS"> The progress event @@ -31275,7 +35027,8 @@ EVENTS" in guestfs(3). + glib:nick="appliance" + glib:name="GUESTFS_SESSION_EVENT_APPLIANCE"> The appliance event @@ -31283,7 +35036,8 @@ EVENTS" in guestfs(3). + glib:nick="library" + glib:name="GUESTFS_SESSION_EVENT_LIBRARY"> The library event @@ -31291,7 +35045,8 @@ EVENTS" in guestfs(3). + glib:nick="trace" + glib:name="GUESTFS_SESSION_EVENT_TRACE"> The trace event @@ -31299,7 +35054,8 @@ EVENTS" in guestfs(3). + glib:nick="enter" + glib:name="GUESTFS_SESSION_EVENT_ENTER"> The enter event @@ -31307,7 +35063,8 @@ EVENTS" in guestfs(3). + glib:nick="libvirt_auth" + glib:name="GUESTFS_SESSION_EVENT_LIBVIRT_AUTH"> The libvirt_auth event @@ -31315,7 +35072,8 @@ EVENTS" in guestfs(3). + glib:nick="warning" + glib:name="GUESTFS_SESSION_EVENT_WARNING"> The warning event @@ -31363,7 +35121,10 @@ EVENTS" in guestfs(3). - + @@ -31382,23 +35143,24 @@ EVENTS" in guestfs(3). Create a new GuestfsSetE2attrs object + line="125">Create a new GuestfsSetE2attrs object a new GuestfsSetE2attrs object + line="130">a new GuestfsSetE2attrs object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -31425,7 +35187,8 @@ EVENTS" in guestfs(3). + disguised="1" + opaque="1"> @@ -31744,23 +35507,24 @@ EVENTS" in guestfs(3). Create a new GuestfsSyslinux object + line="130">Create a new GuestfsSyslinux object a new GuestfsSyslinux object + line="135">a new GuestfsSyslinux object + transfer-ownership="none" + default-value="NULL"> A string. + line="102">A string. @@ -31787,10 +35551,71 @@ EVENTS" in guestfs(3). + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsTarIn object + line="211">Create a new GuestfsTarIn object a new GuestfsTarIn object + line="216">a new GuestfsTarIn object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="183">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="132">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="166">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="149">A boolean. @@ -31978,7 +35837,10 @@ EVENTS" in guestfs(3). - + @@ -31997,59 +35859,64 @@ EVENTS" in guestfs(3). Create a new GuestfsTarOut object + line="240">Create a new GuestfsTarOut object a new GuestfsTarOut object + line="245">a new GuestfsTarOut object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="212">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="144">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="161">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="195">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="178">A boolean. @@ -32074,7 +35941,10 @@ EVENTS" in guestfs(3). - + @@ -32091,7 +35961,8 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. + glib:nick="false" + glib:name="GUESTFS_TRISTATE_FALSE"> False @@ -32099,7 +35970,8 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. + glib:nick="true" + glib:name="GUESTFS_TRISTATE_TRUE"> True @@ -32107,7 +35979,8 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. + glib:nick="none" + glib:name="GUESTFS_TRISTATE_NONE"> Unset @@ -32128,104 +36001,114 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. Create a new GuestfsTune2FS object + line="375">Create a new GuestfsTune2FS object a new GuestfsTune2FS object + line="380">a new GuestfsTune2FS object + transfer-ownership="none" + default-value="NULL"> A string. + line="245">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="194">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="262">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="279">A 32-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="313">A string. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="211">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="228">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="330">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="296">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="347">A 64-bit integer. @@ -32250,10 +36133,73 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsUmount object + line="152">Create a new GuestfsUmount object a new GuestfsUmount object + line="157">a new GuestfsUmount object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="107">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="124">A boolean. @@ -32366,23 +36314,24 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. Create a new GuestfsUmountLocal object + line="125">Create a new GuestfsUmountLocal object a new GuestfsUmountLocal object + line="130">a new GuestfsUmountLocal object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="97">A boolean. @@ -32409,11 +36358,15 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. + disguised="1" + opaque="1"> - + @@ -32753,6 +36706,96 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create a new GuestfsXfsAdmin object + line="294">Create a new GuestfsXfsAdmin object a new GuestfsXfsAdmin object + line="299">a new GuestfsXfsAdmin object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="164">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="181">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="249">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="232">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="215">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="266">A string. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="198">A boolean. @@ -32865,7 +36915,8 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. + disguised="1" + opaque="1"> @@ -32884,86 +36935,94 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. Create a new GuestfsXfsGrowfs object + line="314">Create a new GuestfsXfsGrowfs object a new GuestfsXfsGrowfs object + line="319">a new GuestfsXfsGrowfs object + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="167">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="218">A 64-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="184">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="235">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 32-bit integer. + line="286">A 32-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="269">A 64-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="201">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="252">A 64-bit integer. @@ -32990,7 +37049,8 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. + disguised="1" + opaque="1"> @@ -33009,104 +37069,114 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. Create a new GuestfsXfsRepair object + line="375">Create a new GuestfsXfsRepair object a new GuestfsXfsRepair object + line="380">a new GuestfsXfsRepair object + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="313">A 64-bit integer. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="296">A 64-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="245">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="194">A boolean. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="279">A 64-bit integer. + transfer-ownership="none" + default-value="NULL"> A string. + line="330">A string. + transfer-ownership="none" + default-value="-1"> A 64-bit integer. + line="262">A 64-bit integer. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="211">A boolean. + transfer-ownership="none" + default-value="GUESTFS_TRISTATE_NONE"> A boolean. + line="228">A boolean. + transfer-ownership="none" + default-value="NULL"> A string. + line="347">A string. @@ -33133,7 +37203,8 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. + disguised="1" + opaque="1"> @@ -33157,5 +37228,325 @@ GUESTFS_TRISTATE_TRUE and GUESTFS_TRISTATE_FALSE. + + An object encapsulating optional arguments for guestfs_session_add_domain + + + An object encapsulating optional arguments for guestfs_session_add_drive + + + An object encapsulating optional arguments for guestfs_session_add_drive_scratch + + + An object encapsulating optional arguments for guestfs_session_add_libvirt_dom + + + An object encapsulating optional arguments for guestfs_session_aug_transform + + + An object encapsulating optional arguments for guestfs_session_btrfs_filesystem_defragment + + + An object encapsulating optional arguments for guestfs_session_btrfs_filesystem_resize + + + An object encapsulating optional arguments for guestfs_session_btrfs_fsck + + + An object encapsulating optional arguments for guestfs_session_btrfs_image + + + An object encapsulating optional arguments for guestfs_session_btrfs_subvolume_create + + + An object encapsulating optional arguments for guestfs_session_btrfs_subvolume_snapshot + + + An object encapsulating optional arguments for guestfs_session_compress_device_out + + + An object encapsulating optional arguments for guestfs_session_compress_out + + + An object encapsulating optional arguments for guestfs_session_copy_attributes + + + An object encapsulating optional arguments for guestfs_session_copy_device_to_device + + + An object encapsulating optional arguments for guestfs_session_copy_device_to_file + + + An object encapsulating optional arguments for guestfs_session_copy_file_to_device + + + An object encapsulating optional arguments for guestfs_session_copy_file_to_file + + + An object encapsulating optional arguments for guestfs_session_cpio_out + + + An object encapsulating optional arguments for guestfs_session_cryptsetup_open + + + An object encapsulating optional arguments for guestfs_session_disk_create + + + An object encapsulating optional arguments for guestfs_session_download_blocks + + + An object encapsulating optional arguments for guestfs_session_e2fsck + + + An object encapsulating optional arguments for guestfs_session_fstrim + + + An object encapsulating optional arguments for guestfs_session_glob_expand + + + An object encapsulating optional arguments for guestfs_session_grep + + + An object encapsulating optional arguments for guestfs_session_hivex_open + + + An object encapsulating optional arguments for guestfs_session_inspect_get_icon + + + An object encapsulating optional arguments for guestfs_session_internal_test + + + An object encapsulating optional arguments for guestfs_session_internal_test_63_optargs + + + An object encapsulating optional arguments for guestfs_session_internal_test_only_optargs + + + An object encapsulating optional arguments for guestfs_session_is_blockdev + + + An object encapsulating optional arguments for guestfs_session_is_chardev + + + An object encapsulating optional arguments for guestfs_session_is_dir + + + An object encapsulating optional arguments for guestfs_session_is_fifo + + + An object encapsulating optional arguments for guestfs_session_is_file + + + An object encapsulating optional arguments for guestfs_session_is_socket + + + An object encapsulating optional arguments for guestfs_session_md_create + + + An object encapsulating optional arguments for guestfs_session_mke2fs + + + An object encapsulating optional arguments for guestfs_session_mkfs + + + An object encapsulating optional arguments for guestfs_session_mkfs_btrfs + + + An object encapsulating optional arguments for guestfs_session_mksquashfs + + + An object encapsulating optional arguments for guestfs_session_mkswap + + + An object encapsulating optional arguments for guestfs_session_mktemp + + + An object encapsulating optional arguments for guestfs_session_mount_9p + + + An object encapsulating optional arguments for guestfs_session_mount_local + + + An object encapsulating optional arguments for guestfs_session_ntfsclone_out + + + An object encapsulating optional arguments for guestfs_session_ntfsfix + + + An object encapsulating optional arguments for guestfs_session_ntfsresize + + + An object encapsulating optional arguments for guestfs_session_remount + + + An object encapsulating optional arguments for guestfs_session_rsync + + + An object encapsulating optional arguments for guestfs_session_rsync_in + + + An object encapsulating optional arguments for guestfs_session_rsync_out + + + An object encapsulating optional arguments for guestfs_session_selinux_relabel + + + An object encapsulating optional arguments for guestfs_session_set_e2attrs + + + An object encapsulating optional arguments for guestfs_session_syslinux + + + An object encapsulating optional arguments for guestfs_session_tar_in + + + An object encapsulating optional arguments for guestfs_session_tar_out + + + An object encapsulating optional arguments for guestfs_session_tune2fs + + + An object encapsulating optional arguments for guestfs_session_umount + + + An object encapsulating optional arguments for guestfs_session_umount_local + + + An object encapsulating optional arguments for guestfs_session_xfs_admin + + + An object encapsulating optional arguments for guestfs_session_xfs_growfs + + + An object encapsulating optional arguments for guestfs_session_xfs_repair + diff --git a/girs/HarfBuzz-0.0.gir b/girs/HarfBuzz-0.0.gir index 68f160e7b..26e0bcc8c 100644 --- a/girs/HarfBuzz-0.0.gir +++ b/girs/HarfBuzz-0.0.gir @@ -18,24 +18,24 @@ and/or use gtk-doc annotations. --> Data type for booleans. - + line="88">Data type for booleans. + Data type for holding Unicode codepoints. Also + line="96">Data type for holding Unicode codepoints. Also used to hold glyph IDs. - + Data type for holding color values. Colors are eight bits per + line="868">Data type for holding color values. Colors are eight bits per channel RGB plus alpha transparency. - + Data type for bitmasks. - + line="123">Data type for bitmasks. + @@ -183,22 +183,22 @@ API. These can be used to fetch name strings from a font face. Data type for holding a single coordinate value. + line="114">Data type for holding a single coordinate value. Contour points and other multi-dimensional data are stored as tuples of #hb_position_t's. - + Data type for tag identifiers. Tags are four + line="153">Data type for tag identifiers. Tags are four byte integers, each byte representing a character. Tags are used to identify tables, design-variation axes, scripts, languages, font features, and baselines with human-readable names. - + version="8.0.0"> Unused #hb_codepoint_t value. - + line="105">Unused #hb_codepoint_t value. + introspectable="0"> Constructs an #hb_color_t from four integers. - + line="878">Constructs an #hb_color_t from four integers. + blue channel value + line="880">blue channel value green channel value + line="881">green channel value red channel value + line="882">red channel value alpha channel value + line="883">alpha channel value - + @@ -277,14 +277,14 @@ Set to U+FFFD REPLACEMENT CHARACTER. introspectable="0"> Tests whether a text direction moves backward (from right to left, or from + line="287">Tests whether a text direction moves backward (from right to left, or from bottom to top). Requires that the direction be valid. - + #hb_direction_t to test + line="289">#hb_direction_t to test @@ -293,14 +293,14 @@ bottom to top). Requires that the direction be valid. introspectable="0"> Tests whether a text direction moves forward (from left to right, or from + line="278">Tests whether a text direction moves forward (from left to right, or from top to bottom). Requires that the direction be valid. - + #hb_direction_t to test + line="280">#hb_direction_t to test @@ -309,14 +309,14 @@ top to bottom). Requires that the direction be valid. introspectable="0"> Tests whether a text direction is horizontal. Requires + line="260">Tests whether a text direction is horizontal. Requires that the direction be valid. - + #hb_direction_t to test + line="262">#hb_direction_t to test @@ -325,13 +325,13 @@ that the direction be valid. introspectable="0"> Tests whether a text direction is valid. - + line="251">Tests whether a text direction is valid. + #hb_direction_t to test + line="253">#hb_direction_t to test @@ -340,14 +340,14 @@ that the direction be valid. introspectable="0"> Tests whether a text direction is vertical. Requires + line="269">Tests whether a text direction is vertical. Requires that the direction be valid. - + #hb_direction_t to test + line="271">#hb_direction_t to test @@ -356,14 +356,14 @@ that the direction be valid. introspectable="0"> Reverses a text direction. Requires that the direction + line="296">Reverses a text direction. Requires that the direction be valid. - + #hb_direction_t to reverse + line="298">#hb_direction_t to reverse @@ -373,9 +373,9 @@ be valid. version="2.0.0"> Special setting for #hb_feature_t.start to apply the feature from the start + line="794">Special setting for #hb_feature_t.start to apply the feature from the start of the buffer. - + version="0.6.0"> An unset #hb_language_t. - + line="324">An unset #hb_language_t. + Constructs an #hb_tag_t from four character literals. - + line="166">Constructs an #hb_tag_t from four character literals. + 1st character of the tag + line="168">1st character of the tag 2nd character of the tag + line="169">2nd character of the tag 3rd character of the tag + line="170">3rd character of the tag 4th character of the tag + line="171">4th character of the tag @@ -534,13 +534,13 @@ a font. introspectable="0"> Extracts four character literals from an #hb_tag_t. - + line="178">Extracts four character literals from an #hb_tag_t. + an #hb_tag_t + line="180">an #hb_tag_t @@ -577,21 +577,21 @@ as three integer components. - + The micro component of the library version available at compile-time. - + The minor component of the library version available at compile-time. - + A string literal containing the library version available at compile-time. @@ -4031,7 +4031,7 @@ a client program and HarfBuzz. Appends a character with the Unicode value of @codepoint to @buffer, and + line="1460">Appends a character with the Unicode value of @codepoint to @buffer, and gives it the initial cluster value of @cluster. Clusters can be any thing the client wants, they are usually used to refer to the index of the character in the input text stream and are output in @@ -4039,7 +4039,7 @@ character in the input text stream and are output in This function does not check the validity of @codepoint, it is up to the caller to ensure it is a valid Unicode code point. - + @@ -4047,19 +4047,19 @@ caller to ensure it is a valid Unicode code point. An #hb_buffer_t + line="1462">An #hb_buffer_t A Unicode code point. + line="1463">A Unicode code point. The cluster value of @codepoint. + line="1464">The cluster value of @codepoint. @@ -4069,7 +4069,7 @@ caller to ensure it is a valid Unicode code point. version="0.9.31"> Appends characters from @text array to @buffer. The @item_offset is the + line="1901">Appends characters from @text array to @buffer. The @item_offset is the position of the first character from @text that will be appended, and @item_length is the number of character. When shaping part of a larger text (e.g. a run of text from a paragraph), instead of passing just the substring @@ -4083,7 +4083,7 @@ This function does not check the validity of @text, it is up to the caller to ensure it contains a valid Unicode scalar values. In contrast, hb_buffer_add_utf32() can be used that takes similar input but performs sanity-check on the input. - + @@ -4091,13 +4091,13 @@ sanity-check on the input. a #hb_buffer_t to append characters to. + line="1903">a #hb_buffer_t to append characters to. an array of Unicode code points to append. + line="1904">an array of Unicode code points to append. @@ -4105,19 +4105,19 @@ sanity-check on the input. the length of the @text, or -1 if it is `NULL` terminated. + line="1905">the length of the @text, or -1 if it is `NULL` terminated. the offset of the first code point to add to the @buffer. + line="1906">the offset of the first code point to add to the @buffer. the number of code points to add to the @buffer, or -1 for the + line="1907">the number of code points to add to the @buffer, or -1 for the end of @text (assuming it is `NULL` terminated). @@ -4128,11 +4128,11 @@ sanity-check on the input. version="0.9.39"> Similar to hb_buffer_add_codepoints(), but allows only access to first 256 + line="1874">Similar to hb_buffer_add_codepoints(), but allows only access to first 256 Unicode code points that can fit in 8-bit strings. <note>Has nothing to do with non-Unicode Latin-1 encoding.</note> - + @@ -4140,13 +4140,13 @@ Unicode code points that can fit in 8-bit strings. An #hb_buffer_t + line="1876">An #hb_buffer_t an array of UTF-8 + line="1877">an array of UTF-8 characters to append @@ -4155,19 +4155,19 @@ Unicode code points that can fit in 8-bit strings. the length of the @text, or -1 if it is `NULL` terminated + line="1879">the length of the @text, or -1 if it is `NULL` terminated the offset of the first character to add to the @buffer + line="1880">the offset of the first character to add to the @buffer the number of characters to add to the @buffer, or -1 for the + line="1881">the number of characters to add to the @buffer, or -1 for the end of @text (assuming it is `NULL` terminated) @@ -4178,11 +4178,11 @@ Unicode code points that can fit in 8-bit strings. version="0.9.2"> See hb_buffer_add_codepoints(). + line="1822">See hb_buffer_add_codepoints(). Replaces invalid UTF-16 characters with the @buffer replacement code point, see hb_buffer_set_replacement_codepoint(). - + @@ -4190,13 +4190,13 @@ see hb_buffer_set_replacement_codepoint(). An #hb_buffer_t + line="1824">An #hb_buffer_t An array of UTF-16 characters to append + line="1825">An array of UTF-16 characters to append @@ -4204,19 +4204,19 @@ see hb_buffer_set_replacement_codepoint(). The length of the @text, or -1 if it is `NULL` terminated + line="1826">The length of the @text, or -1 if it is `NULL` terminated The offset of the first character to add to the @buffer + line="1827">The offset of the first character to add to the @buffer The number of characters to add to the @buffer, or -1 for the + line="1828">The number of characters to add to the @buffer, or -1 for the end of @text (assuming it is `NULL` terminated) @@ -4227,11 +4227,11 @@ see hb_buffer_set_replacement_codepoint(). version="0.9.2"> See hb_buffer_add_codepoints(). + line="1848">See hb_buffer_add_codepoints(). Replaces invalid UTF-32 characters with the @buffer replacement code point, see hb_buffer_set_replacement_codepoint(). - + @@ -4239,13 +4239,13 @@ see hb_buffer_set_replacement_codepoint(). An #hb_buffer_t + line="1850">An #hb_buffer_t An array of UTF-32 characters to append + line="1851">An array of UTF-32 characters to append @@ -4253,19 +4253,19 @@ see hb_buffer_set_replacement_codepoint(). The length of the @text, or -1 if it is `NULL` terminated + line="1852">The length of the @text, or -1 if it is `NULL` terminated The offset of the first character to add to the @buffer + line="1853">The offset of the first character to add to the @buffer The number of characters to add to the @buffer, or -1 for the + line="1854">The number of characters to add to the @buffer, or -1 for the end of @text (assuming it is `NULL` terminated) @@ -4276,11 +4276,11 @@ see hb_buffer_set_replacement_codepoint(). version="0.9.2"> See hb_buffer_add_codepoints(). + line="1795">See hb_buffer_add_codepoints(). Replaces invalid UTF-8 characters with the @buffer replacement code point, see hb_buffer_set_replacement_codepoint(). - + @@ -4288,13 +4288,13 @@ see hb_buffer_set_replacement_codepoint(). An #hb_buffer_t + line="1797">An #hb_buffer_t An array of UTF-8 + line="1798">An array of UTF-8 characters to append. @@ -4303,19 +4303,19 @@ see hb_buffer_set_replacement_codepoint(). The length of the @text, or -1 if it is `NULL` terminated. + line="1800">The length of the @text, or -1 if it is `NULL` terminated. The offset of the first character to add to the @buffer. + line="1801">The offset of the first character to add to the @buffer. The number of characters to add to the @buffer, or -1 for the + line="1802">The number of characters to add to the @buffer, or -1 for the end of @text (assuming it is `NULL` terminated). @@ -4326,19 +4326,19 @@ see hb_buffer_set_replacement_codepoint(). version="0.9.2"> Check if allocating memory for the buffer succeeded. - + line="1443">Check if allocating memory for the buffer succeeded. + `true` if @buffer memory allocation succeeded, `false` otherwise. + line="1449">`true` if @buffer memory allocation succeeded, `false` otherwise. An #hb_buffer_t + line="1445">An #hb_buffer_t @@ -4348,8 +4348,8 @@ see hb_buffer_set_replacement_codepoint(). version="1.5.0"> Append (part of) contents of another buffer to this buffer. - + line="1938">Append (part of) contents of another buffer to this buffer. + @@ -4357,25 +4357,25 @@ see hb_buffer_set_replacement_codepoint(). An #hb_buffer_t + line="1940">An #hb_buffer_t source #hb_buffer_t + line="1941">source #hb_buffer_t start index into source buffer to copy. Use 0 to copy from start of buffer. + line="1942">start index into source buffer to copy. Use 0 to copy from start of buffer. end index into source buffer to copy. Use @HB_FEATURE_GLOBAL_END to copy to end of buffer. + line="1943">end index into source buffer to copy. Use @HB_FEATURE_GLOBAL_END to copy to end of buffer. @@ -4385,9 +4385,9 @@ see hb_buffer_set_replacement_codepoint(). version="0.9.11"> Similar to hb_buffer_reset(), but does not clear the Unicode functions and + line="1407">Similar to hb_buffer_reset(), but does not clear the Unicode functions and the replacement code point. - + @@ -4395,7 +4395,7 @@ the replacement code point. An #hb_buffer_t + line="1409">An #hb_buffer_t @@ -4502,12 +4502,12 @@ do not need to maintain such backward compatibility are recommended to use version="0.9.2"> Creates a new #hb_buffer_t with all properties to defaults. + line="722">Creates a new #hb_buffer_t with all properties to defaults. + line="727"> A newly allocated #hb_buffer_t with a reference count of 1. The initial reference count should be released with hb_buffer_destroy() when you are done using the #hb_buffer_t. This function never returns `NULL`. If memory cannot @@ -4521,13 +4521,13 @@ hb_buffer_allocation_successful() returns `false`. version="3.3.0"> Creates a new #hb_buffer_t, similar to hb_buffer_create(). The only + line="752">Creates a new #hb_buffer_t, similar to hb_buffer_create(). The only difference is that the buffer is configured similarly to @src. + line="759"> A newly allocated #hb_buffer_t, similar to hb_buffer_create(). @@ -4535,7 +4535,7 @@ A newly allocated #hb_buffer_t, similar to hb_buffer_create(). An #hb_buffer_t + line="754">An #hb_buffer_t @@ -4547,7 +4547,7 @@ A newly allocated #hb_buffer_t, similar to hb_buffer_create(). filename="hb-buffer-serialize.cc" line="727">Deserializes glyphs @buffer from textual representation in the format produced by hb_buffer_serialize_glyphs(). - + filename="hb-buffer-serialize.cc" line="801">Deserializes Unicode @buffer from textual representation in the format produced by hb_buffer_serialize_unicode(). - + introspectable="0"> Deallocate the @buffer. + line="825">Deallocate the @buffer. Decreases the reference count on @buffer by one. If the result is zero, then @buffer and all associated resources are freed. See hb_buffer_reference(). @@ -4680,7 +4680,7 @@ Decreases the reference count on @buffer by one. If the result is zero, then An #hb_buffer_t + line="827">An #hb_buffer_t @@ -4688,10 +4688,10 @@ Decreases the reference count on @buffer by one. If the result is zero, then If dottedcircle_glyph is (hb_codepoint_t) -1 then #HB_BUFFER_DIFF_FLAG_DOTTED_CIRCLE_PRESENT + line="2119">If dottedcircle_glyph is (hb_codepoint_t) -1 then #HB_BUFFER_DIFF_FLAG_DOTTED_CIRCLE_PRESENT and #HB_BUFFER_DIFF_FLAG_NOTDEF_PRESENT are never returned. This should be used by most callers if just comparing two buffers is needed. - + @@ -4699,25 +4699,25 @@ callers if just comparing two buffers is needed. a buffer. + line="2121">a buffer. other buffer to compare to. + line="2122">other buffer to compare to. glyph id of U+25CC DOTTED CIRCLE, or (hb_codepoint_t) -1. + line="2123">glyph id of U+25CC DOTTED CIRCLE, or (hb_codepoint_t) -1. allowed absolute difference in position values. + line="2124">allowed absolute difference in position values. @@ -4729,7 +4729,7 @@ callers if just comparing two buffers is needed. c:type="hb_buffer_diff_flags_t"> Flags from comparing two #hb_buffer_t's. + line="707">Flags from comparing two #hb_buffer_t's. Buffer with different #hb_buffer_content_type_t cannot be meaningfully compared in any further detail. @@ -4747,7 +4747,7 @@ report which aspect(s) of the glyph info/position are different. glib:name="HB_BUFFER_DIFF_FLAG_EQUAL"> equal buffers. + line="709">equal buffers. glib:name="HB_BUFFER_DIFF_FLAG_CONTENT_TYPE_MISMATCH"> buffers with different + line="710">buffers with different #hb_buffer_content_type_t. glib:name="HB_BUFFER_DIFF_FLAG_LENGTH_MISMATCH"> buffers with differing length. + line="712">buffers with differing length. glib:name="HB_BUFFER_DIFF_FLAG_NOTDEF_PRESENT"> `.notdef` glyph is present in the + line="713">`.notdef` glyph is present in the reference buffer. glib:name="HB_BUFFER_DIFF_FLAG_DOTTED_CIRCLE_PRESENT"> dotted circle glyph is present + line="715">dotted circle glyph is present in the reference buffer. glib:name="HB_BUFFER_DIFF_FLAG_CODEPOINT_MISMATCH"> difference in #hb_glyph_info_t.codepoint + line="717">difference in #hb_glyph_info_t.codepoint glib:name="HB_BUFFER_DIFF_FLAG_CLUSTER_MISMATCH"> difference in #hb_glyph_info_t.cluster + line="718">difference in #hb_glyph_info_t.cluster glib:name="HB_BUFFER_DIFF_FLAG_GLYPH_FLAGS_MISMATCH"> difference in #hb_glyph_flags_t. + line="719">difference in #hb_glyph_flags_t. glib:name="HB_BUFFER_DIFF_FLAG_POSITION_MISMATCH"> difference in #hb_glyph_position_t. + line="720">difference in #hb_glyph_position_t. version="0.9.42"> Fetches the cluster level of a buffer. The #hb_buffer_cluster_level_t + line="1224">Fetches the cluster level of a buffer. The #hb_buffer_cluster_level_t dictates one aspect of how HarfBuzz will treat non-base characters during shaping. The cluster level of @buffer + line="1232">The cluster level of @buffer @@ -4971,7 +4971,7 @@ during shaping. An #hb_buffer_t + line="1226">An #hb_buffer_t @@ -4981,20 +4981,20 @@ during shaping. version="0.9.5"> Fetches the type of @buffer contents. Buffers are either empty, contain + line="939">Fetches the type of @buffer contents. Buffers are either empty, contain characters (before shaping), or contain glyphs (the result of shaping). The type of @buffer contents + line="946">The type of @buffer contents An #hb_buffer_t + line="941">An #hb_buffer_t @@ -5004,19 +5004,19 @@ characters (before shaping), or contain glyphs (the result of shaping). version="0.9.2"> See hb_buffer_set_direction() + line="1024">See hb_buffer_set_direction() The direction of the @buffer. + line="1030">The direction of the @buffer. An #hb_buffer_t + line="1026">An #hb_buffer_t @@ -5026,12 +5026,12 @@ characters (before shaping), or contain glyphs (the result of shaping). version="0.9.2"> Fetches an empty #hb_buffer_t. + line="792">Fetches an empty #hb_buffer_t. The empty buffer + line="797">The empty buffer @@ -5040,19 +5040,19 @@ characters (before shaping), or contain glyphs (the result of shaping). version="0.9.7"> Fetches the #hb_buffer_flags_t of @buffer. + line="1186">Fetches the #hb_buffer_flags_t of @buffer. The @buffer flags + line="1192">The @buffer flags An #hb_buffer_t + line="1188">An #hb_buffer_t @@ -5062,13 +5062,13 @@ characters (before shaping), or contain glyphs (the result of shaping). version="0.9.2"> Returns @buffer glyph information array. Returned pointer + line="1546">Returns @buffer glyph information array. Returned pointer is valid as long as @buffer contents are not modified. - + + line="1554"> The @buffer glyph information array. The value valid as long as buffer has not been modified. @@ -5079,7 +5079,7 @@ The value valid as long as buffer has not been modified. An #hb_buffer_t + line="1548">An #hb_buffer_t transfer-ownership="full"> The output-array length. + line="1549">The output-array length. @@ -5098,18 +5098,18 @@ The value valid as long as buffer has not been modified. version="0.9.2"> Returns @buffer glyph position array. Returned pointer + line="1570">Returns @buffer glyph position array. Returned pointer is valid as long as @buffer contents are not modified. If buffer did not have positions before, the positions will be initialized to zeros, unless this function is called from within a buffer message callback (see hb_buffer_set_message_func()), in which case `NULL` is returned. - + + line="1583"> The @buffer glyph position array. The value valid as long as buffer has not been modified. @@ -5120,7 +5120,7 @@ The value valid as long as buffer has not been modified. An #hb_buffer_t + line="1572">An #hb_buffer_t transfer-ownership="full"> The output length + line="1573">The output length @@ -5139,19 +5139,19 @@ The value valid as long as buffer has not been modified. version="2.0.0"> See hb_buffer_set_invisible_glyph(). + line="1306">See hb_buffer_set_invisible_glyph(). The @buffer invisible #hb_codepoint_t + line="1312">The @buffer invisible #hb_codepoint_t An #hb_buffer_t + line="1308">An #hb_buffer_t @@ -5161,12 +5161,12 @@ The value valid as long as buffer has not been modified. version="0.9.2"> See hb_buffer_set_language(). + line="1112">See hb_buffer_set_language(). + line="1118"> The #hb_language_t of the buffer. Must not be freed by the caller. @@ -5174,7 +5174,7 @@ The #hb_language_t of the buffer. Must not be freed by the caller. An #hb_buffer_t + line="1114">An #hb_buffer_t @@ -5184,12 +5184,12 @@ The #hb_language_t of the buffer. Must not be freed by the caller. version="0.9.2"> Returns the number of items in the buffer. - + line="1528">Returns the number of items in the buffer. + The @buffer length. + line="1534">The @buffer length. The value valid as long as buffer has not been modified. @@ -5197,7 +5197,7 @@ The value valid as long as buffer has not been modified. An #hb_buffer_t + line="1530">An #hb_buffer_t @@ -5207,19 +5207,41 @@ The value valid as long as buffer has not been modified. version="3.1.0"> See hb_buffer_set_not_found_glyph(). + line="1346">See hb_buffer_set_not_found_glyph(). The @buffer not-found #hb_codepoint_t + line="1352">The @buffer not-found #hb_codepoint_t An #hb_buffer_t + line="1348">An #hb_buffer_t + + + + + + See hb_buffer_set_random_state(). + + + The @buffer random state + + + + + An #hb_buffer_t @@ -5229,20 +5251,20 @@ The value valid as long as buffer has not been modified. version="0.9.31"> Fetches the #hb_codepoint_t that replaces invalid entries for a given encoding + line="1265">Fetches the #hb_codepoint_t that replaces invalid entries for a given encoding when adding text to @buffer. The @buffer replacement #hb_codepoint_t + line="1272">The @buffer replacement #hb_codepoint_t An #hb_buffer_t + line="1267">An #hb_buffer_t @@ -5252,19 +5274,19 @@ when adding text to @buffer. version="0.9.2"> Fetches the script of @buffer. + line="1068">Fetches the script of @buffer. The #hb_script_t of the @buffer + line="1074">The #hb_script_t of the @buffer An #hb_buffer_t + line="1070">An #hb_buffer_t @@ -5274,7 +5296,7 @@ when adding text to @buffer. version="0.9.7"> Sets @props to the #hb_segment_properties_t of @buffer. + line="1150">Sets @props to the #hb_segment_properties_t of @buffer. @@ -5283,7 +5305,7 @@ when adding text to @buffer. An #hb_buffer_t + line="1152">An #hb_buffer_t transfer-ownership="none"> The output #hb_segment_properties_t + line="1153">The output #hb_segment_properties_t @@ -5302,19 +5324,19 @@ when adding text to @buffer. version="0.9.2"> Fetches the Unicode-functions structure of a buffer. + line="983">Fetches the Unicode-functions structure of a buffer. The Unicode-functions structure + line="989">The Unicode-functions structure An #hb_buffer_t + line="985">An #hb_buffer_t @@ -5325,26 +5347,26 @@ when adding text to @buffer. introspectable="0"> Fetches the user data associated with the specified key, + line="876">Fetches the user data associated with the specified key, attached to the specified buffer. A pointer to the user data + line="884">A pointer to the user data An #hb_buffer_t + line="878">An #hb_buffer_t The user-data key to query + line="879">The user-data key to query @@ -5354,7 +5376,7 @@ attached to the specified buffer. version="0.9.7"> Sets unset buffer segment properties based on buffer Unicode + line="1690">Sets unset buffer segment properties based on buffer Unicode contents. If buffer is not empty, it must have content type #HB_BUFFER_CONTENT_TYPE_UNICODE. @@ -5383,7 +5405,7 @@ it is called. See documentation for that function for details. An #hb_buffer_t + line="1692">An #hb_buffer_t @@ -5393,21 +5415,21 @@ it is called. See documentation for that function for details. version="2.7.3"> Returns whether @buffer has glyph position data. + line="1607">Returns whether @buffer has glyph position data. A buffer gains position data when hb_buffer_get_glyph_positions() is called on it, and cleared of position data when hb_buffer_clear_contents() is called. - + `true` if the @buffer has position array, `false` otherwise. + line="1615">`true` if the @buffer has position array, `false` otherwise. an #hb_buffer_t. + line="1609">an #hb_buffer_t. @@ -5417,35 +5439,35 @@ and cleared of position data when hb_buffer_clear_contents() is called. version="1.1.3"> A callback method for #hb_buffer_t. The method gets called with the + line="775">A callback method for #hb_buffer_t. The method gets called with the #hb_buffer_t it was set on, the #hb_font_t the buffer is shaped with and a message describing what step of the shaping process will be performed. Returning `false` from this method will skip this shaping step and move to the next one. - + `true` to perform the shaping step, `false` to skip it. + line="788">`true` to perform the shaping step, `false` to skip it. An #hb_buffer_t to work upon + line="777">An #hb_buffer_t to work upon The #hb_font_t the @buffer is shaped with + line="778">The #hb_font_t the @buffer is shaped with `NULL`-terminated message passed to the function + line="779">`NULL`-terminated message passed to the function closure="3"> User data pointer passed by the caller + line="780">User data pointer passed by the caller @@ -5465,11 +5487,11 @@ the next one. version="0.9.2"> Reorders a glyph buffer to have canonical in-cluster glyph order / position. + line="2069">Reorders a glyph buffer to have canonical in-cluster glyph order / position. The resulting clusters should behave identical to pre-reordering clusters. <note>This has nothing to do with Unicode normalization.</note> - + @@ -5477,7 +5499,7 @@ The resulting clusters should behave identical to pre-reordering clusters. An #hb_buffer_t + line="2071">An #hb_buffer_t @@ -5487,25 +5509,25 @@ The resulting clusters should behave identical to pre-reordering clusters. version="0.9.2"> Pre allocates memory for @buffer to fit at least @size number of items. - + line="1425">Pre allocates memory for @buffer to fit at least @size number of items. + `true` if @buffer memory allocation succeeded, `false` otherwise + line="1432">`true` if @buffer memory allocation succeeded, `false` otherwise An #hb_buffer_t + line="1427">An #hb_buffer_t Number of items to pre allocate. + line="1428">Number of items to pre allocate. @@ -5516,13 +5538,13 @@ The resulting clusters should behave identical to pre-reordering clusters. introspectable="0"> Increases the reference count on @buffer by one. This prevents @buffer from + line="807">Increases the reference count on @buffer by one. This prevents @buffer from being destroyed until a matching call to hb_buffer_destroy() is made. + line="814"> The referenced #hb_buffer_t. @@ -5530,7 +5552,7 @@ The referenced #hb_buffer_t. An #hb_buffer_t + line="809">An #hb_buffer_t @@ -5540,7 +5562,7 @@ The referenced #hb_buffer_t. version="0.9.2"> Resets the buffer to its initial status, as if it was just newly created + line="774">Resets the buffer to its initial status, as if it was just newly created with hb_buffer_create(). @@ -5550,7 +5572,7 @@ with hb_buffer_create(). An #hb_buffer_t + line="776">An #hb_buffer_t @@ -5560,8 +5582,8 @@ with hb_buffer_create(). version="0.9.2"> Reverses buffer contents. - + line="1643">Reverses buffer contents. + @@ -5569,7 +5591,7 @@ with hb_buffer_create(). An #hb_buffer_t + line="1645">An #hb_buffer_t @@ -5579,10 +5601,10 @@ with hb_buffer_create(). version="0.9.2"> Reverses buffer clusters. That is, the buffer contents are + line="1674">Reverses buffer clusters. That is, the buffer contents are reversed, then each cluster (consecutive items having the same cluster number) are reversed again. - + @@ -5590,7 +5612,7 @@ same cluster number) are reversed again. An #hb_buffer_t + line="1676">An #hb_buffer_t @@ -5600,8 +5622,8 @@ same cluster number) are reversed again. version="0.9.41"> Reverses buffer contents between @start and @end. - + line="1657">Reverses buffer contents between @start and @end. + @@ -5609,19 +5631,19 @@ same cluster number) are reversed again. An #hb_buffer_t + line="1659">An #hb_buffer_t start index + line="1660">start index end index + line="1661">end index @@ -5636,7 +5658,7 @@ Unicode codepoints or glyph identifiers and positioning information. This is useful for showing the contents of the buffer, for example during debugging. See the documentation of hb_buffer_serialize_unicode() and hb_buffer_serialize_glyphs() for a description of the output format. - + c:type="hb_buffer_serialize_flags_t"> Flags that control what glyph information are serialized in hb_buffer_serialize_glyphs(). + line="600">Flags that control what glyph information are serialized in hb_buffer_serialize_glyphs(). glib:name="HB_BUFFER_SERIALIZE_FLAG_DEFAULT"> serialize glyph names, clusters and positions. + line="602">serialize glyph names, clusters and positions. glib:name="HB_BUFFER_SERIALIZE_FLAG_NO_CLUSTERS"> do not serialize glyph cluster. + line="603">do not serialize glyph cluster. glib:name="HB_BUFFER_SERIALIZE_FLAG_NO_POSITIONS"> do not serialize glyph position information. + line="604">do not serialize glyph position information. glib:name="HB_BUFFER_SERIALIZE_FLAG_NO_GLYPH_NAMES"> do no serialize glyph name. + line="605">do no serialize glyph name. glib:name="HB_BUFFER_SERIALIZE_FLAG_GLYPH_EXTENTS"> serialize glyph extents. + line="606">serialize glyph extents. glib:name="HB_BUFFER_SERIALIZE_FLAG_GLYPH_FLAGS"> serialize glyph flags. Since: 1.5.0 + line="607">serialize glyph flags. Since: 1.5.0 glib:name="HB_BUFFER_SERIALIZE_FLAG_NO_ADVANCES"> do not serialize glyph advances, + line="608">do not serialize glyph advances, glyph offsets will reflect absolute glyph positions. Since: 1.8.0 glib:name="HB_BUFFER_SERIALIZE_FLAG_DEFINED"> All currently defined flags. Since: 4.4.0 + line="610">All currently defined flags. Since: 4.4.0 line="56">Parses a string into an #hb_buffer_serialize_format_t. Does not check if @str is a valid buffer serialization format, use hb_buffer_serialize_list_formats() to get the list of supported formats. - + c:type="hb_buffer_serialize_format_t"> The buffer serialization and de-serialization format used in + line="628">The buffer serialization and de-serialization format used in hb_buffer_serialize_glyphs() and hb_buffer_deserialize_glyphs(). glib:name="HB_BUFFER_SERIALIZE_FORMAT_TEXT"> a human-readable, plain text format. + line="630">a human-readable, plain text format. glib:name="HB_BUFFER_SERIALIZE_FORMAT_JSON"> a machine-readable JSON format. + line="631">a machine-readable JSON format. glib:name="HB_BUFFER_SERIALIZE_FORMAT_INVALID"> invalid format. + line="632">invalid format. filename="hb-buffer-serialize.cc" line="77">Converts @format to the string corresponding it, or `NULL` if it is not a valid #hb_buffer_serialize_format_t. - + - + Returns a list of supported buffer serialization formats. - + - + Sets the cluster level of a buffer. The #hb_buffer_cluster_level_t + line="1203">Sets the cluster level of a buffer. The #hb_buffer_cluster_level_t dictates one aspect of how HarfBuzz will treat non-base characters during shaping. @@ -6175,13 +6197,13 @@ during shaping. An #hb_buffer_t + line="1205">An #hb_buffer_t The cluster level to set on the buffer + line="1206">The cluster level to set on the buffer @@ -6192,7 +6214,7 @@ during shaping. version="0.9.5"> Sets the type of @buffer contents. Buffers are either empty, contain + line="896">Sets the type of @buffer contents. Buffers are either empty, contain characters (before shaping), or contain glyphs (the result of shaping). You rarely need to call this function, since a number of other @@ -6228,13 +6250,13 @@ modify the content type manually. An #hb_buffer_t + line="898">An #hb_buffer_t The type of buffer contents to set + line="899">The type of buffer contents to set @@ -6245,7 +6267,7 @@ modify the content type manually. version="0.9.2"> Set the text flow direction of the buffer. No shaping can happen without + line="999">Set the text flow direction of the buffer. No shaping can happen without setting @buffer direction, and it controls the visual direction for the output glyphs; for RTL direction the glyphs will be reversed. Many layout features depend on the proper setting of the direction, for example, @@ -6260,13 +6282,13 @@ direction. An #hb_buffer_t + line="1001">An #hb_buffer_t the #hb_direction_t of the @buffer + line="1002">the #hb_direction_t of the @buffer @@ -6276,7 +6298,7 @@ direction. version="0.9.7"> Sets @buffer flags to @flags. See #hb_buffer_flags_t. + line="1167">Sets @buffer flags to @flags. See #hb_buffer_flags_t. @@ -6285,13 +6307,13 @@ direction. An #hb_buffer_t + line="1169">An #hb_buffer_t The buffer flags to set + line="1170">The buffer flags to set @@ -6301,7 +6323,7 @@ direction. version="2.0.0"> Sets the #hb_codepoint_t that replaces invisible characters in + line="1284">Sets the #hb_codepoint_t that replaces invisible characters in the shaping result. If set to zero (default), the glyph for the U+0020 SPACE character is used. Otherwise, this value is used verbatim. @@ -6313,13 +6335,13 @@ verbatim. An #hb_buffer_t + line="1286">An #hb_buffer_t the invisible #hb_codepoint_t + line="1287">the invisible #hb_codepoint_t @@ -6329,7 +6351,7 @@ verbatim. version="0.9.2"> Sets the language of @buffer to @language. + line="1085">Sets the language of @buffer to @language. Languages are crucial for selecting which OpenType feature to apply to the buffer which can result in applying language-specific behaviour. Languages @@ -6346,13 +6368,13 @@ Use hb_language_from_string() to convert from BCP 47 language tags to An #hb_buffer_t + line="1087">An #hb_buffer_t An hb_language_t to set + line="1088">An hb_language_t to set @@ -6362,26 +6384,26 @@ Use hb_language_from_string() to convert from BCP 47 language tags to version="0.9.2"> Similar to hb_buffer_pre_allocate(), but clears any new items added at the + line="1486">Similar to hb_buffer_pre_allocate(), but clears any new items added at the end. - + `true` if @buffer memory allocation succeeded, `false` otherwise. + line="1494">`true` if @buffer memory allocation succeeded, `false` otherwise. An #hb_buffer_t + line="1488">An #hb_buffer_t The new length of @buffer + line="1489">The new length of @buffer @@ -6391,8 +6413,8 @@ end. version="1.1.3"> Sets the implementation function for #hb_buffer_message_func_t. - + line="2215">Sets the implementation function for #hb_buffer_message_func_t. + @@ -6400,7 +6422,7 @@ end. An #hb_buffer_t + line="2217">An #hb_buffer_t destroy="3"> Callback function + line="2218">Callback function @@ -6420,7 +6442,7 @@ end. allow-none="1"> Data to pass to @func + line="2219">Data to pass to @func scope="notified"> The function to call when @user_data is not needed anymore + line="2220">The function to call when @user_data is not needed anymore @@ -6440,7 +6462,7 @@ end. version="3.1.0"> Sets the #hb_codepoint_t that replaces characters not found in + line="1323">Sets the #hb_codepoint_t that replaces characters not found in the font during shaping. The not-found glyph defaults to zero, sometimes known as the @@ -6453,23 +6475,56 @@ The not-found glyph defaults to zero, sometimes known as the An #hb_buffer_t + line="1325">An #hb_buffer_t the not-found #hb_codepoint_t + line="1326">the not-found #hb_codepoint_t + + Sets the random state of the buffer. The state changes +every time a glyph uses randomness (eg. the `rand` +OpenType feature). This function together with +hb_buffer_get_random_state() allow for transferring +the current random state to a subsequent buffer, to +get better randomness distribution. + +Defaults to 1 and when buffer contents are cleared. +A value of 0 disables randomness during shaping. + + + + + + + An #hb_buffer_t + + + + the new random state + + + + Sets the #hb_codepoint_t that replaces invalid entries for a given encoding + line="1243">Sets the #hb_codepoint_t that replaces invalid entries for a given encoding when adding text to @buffer. Default is #HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT. @@ -6481,13 +6536,13 @@ Default is #HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT. An #hb_buffer_t + line="1245">An #hb_buffer_t the replacement #hb_codepoint_t + line="1246">the replacement #hb_codepoint_t @@ -6497,7 +6552,7 @@ Default is #HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT. version="0.9.2"> Sets the script of @buffer to @script. + line="1041">Sets the script of @buffer to @script. Script is crucial for choosing the proper shaping behaviour for scripts that require it (e.g. Arabic) and the which OpenType features defined in the font @@ -6514,13 +6569,13 @@ corresponding script from an ISO 15924 script tag. An #hb_buffer_t + line="1043">An #hb_buffer_t An #hb_script_t to set. + line="1044">An #hb_script_t to set. @@ -6530,7 +6585,7 @@ corresponding script from an ISO 15924 script tag. version="0.9.7"> Sets the segment properties of the buffer, a shortcut for calling + line="1129">Sets the segment properties of the buffer, a shortcut for calling hb_buffer_set_direction(), hb_buffer_set_script() and hb_buffer_set_language() individually. @@ -6541,13 +6596,13 @@ hb_buffer_set_language() individually. An #hb_buffer_t + line="1131">An #hb_buffer_t An #hb_segment_properties_t to use + line="1132">An #hb_segment_properties_t to use @@ -6558,7 +6613,7 @@ hb_buffer_set_language() individually. version="0.9.2"> Sets the Unicode-functions structure of a buffer to + line="958">Sets the Unicode-functions structure of a buffer to @unicode_funcs. @@ -6568,13 +6623,13 @@ hb_buffer_set_language() individually. An #hb_buffer_t + line="960">An #hb_buffer_t The Unicode-functions structure + line="961">The Unicode-functions structure @@ -6585,25 +6640,25 @@ hb_buffer_set_language() individually. introspectable="0"> Attaches a user-data key/data pair to the specified buffer. + line="852">Attaches a user-data key/data pair to the specified buffer. `true` if success, `false` otherwise + line="862">`true` if success, `false` otherwise An #hb_buffer_t + line="854">An #hb_buffer_t The user-data key + line="855">The user-data key allow-none="1"> A pointer to the user data + line="856">A pointer to the user data allow-none="1"> A callback to call when @data is not needed anymore + line="857">A callback to call when @data is not needed anymore Whether to replace an existing data with the same key + line="858">Whether to replace an existing data with the same key @@ -6650,7 +6705,7 @@ and output glyphs and their information after shaping. Fetches the alpha channel of the given @color. - + Fetches the blue channel of the given @color. - + Fetches the green channel of the given @color. - + Fetches the red channel of the given @color. - + A virtual method for destroy user-data callbacks. - + line="782">A virtual method for destroy user-data callbacks. + @@ -7029,7 +7084,7 @@ section for details. closure="0"> the data to be destroyed + line="784">the data to be destroyed @@ -7045,7 +7100,7 @@ Matching is loose and applies only to the first letter. For examples, "LTR" and "left-to-right" will both return #HB_DIRECTION_LTR. Unmatched strings will return #HB_DIRECTION_INVALID. - + c:type="hb_direction_t"> The direction of a text segment or buffer. + line="221">The direction of a text segment or buffer. A segment can also be tested for horizontal or vertical orientation (irrespective of specific direction) with @@ -7087,7 +7142,7 @@ HB_DIRECTION_IS_HORIZONTAL() or HB_DIRECTION_IS_VERTICAL(). glib:name="HB_DIRECTION_INVALID"> Initial, unset direction. + line="223">Initial, unset direction. glib:name="HB_DIRECTION_LTR"> Text is set horizontally from left to right. + line="224">Text is set horizontally from left to right. glib:name="HB_DIRECTION_RTL"> Text is set horizontally from right to left. + line="225">Text is set horizontally from right to left. glib:name="HB_DIRECTION_TTB"> Text is set vertically from top to bottom. + line="226">Text is set vertically from top to bottom. glib:name="HB_DIRECTION_BTT"> Text is set vertically from bottom to top. + line="227">Text is set vertically from bottom to top. Converts an #hb_direction_t to a string. - + - + The #hb_feature_t is the structure that holds information about requested + line="814">The #hb_feature_t is the structure that holds information about requested feature application. The feature will be applied with the given value to all glyphs which are in clusters between @start (inclusive) and @end (exclusive). Setting start to #HB_FEATURE_GLOBAL_START and end to #HB_FEATURE_GLOBAL_END specifies that the feature always applies to the entire buffer. - + The #hb_tag_t tag of the feature + line="816">The #hb_tag_t tag of the feature The value of the feature. 0 disables the feature, non-zero (usually + line="817">The value of the feature. 0 disables the feature, non-zero (usually 1) enables the feature. For features implemented as lookup type 3 (like 'salt') the @value is a one based index into the alternates. @@ -9115,13 +9170,13 @@ specifies that the feature always applies to the entire buffer. the cluster to start applying this feature setting (inclusive). + line="820">the cluster to start applying this feature setting (inclusive). the cluster to end applying this feature setting (exclusive). + line="821">the cluster to end applying this feature setting (exclusive). line="958">Converts a #hb_feature_t into a `NULL`-terminated string in the format understood by hb_feature_from_string(). The client in responsible for allocating big enough size for @buf, 128 bytes is more than enough. - + @@ -9175,7 +9230,7 @@ allocating big enough size for @buf, 128 bytes is more than enough. line="958">Converts a #hb_feature_t into a `NULL`-terminated string in the format understood by hb_feature_from_string(). The client in responsible for allocating big enough size for @buf, 128 bytes is more than enough. - + @@ -14159,8 +14214,8 @@ or vertical) depending on the value of @direction. c:symbol-prefix="gobject_font"> Data type for holding fonts. - + line="925">Data type for holding fonts. + Glyph extent values, measured in font units. + line="907">Glyph extent values, measured in font units. Note that @height is negative, in coordinate systems that grow up. - + Distance from the x-origin to the left extremum of the glyph. + line="909">Distance from the x-origin to the left extremum of the glyph. Distance from the top extremum of the glyph to the y-origin. + line="910">Distance from the top extremum of the glyph to the y-origin. Distance from the left extremum of the glyph to the right extremum. + line="911">Distance from the left extremum of the glyph to the right extremum. Distance from the top extremum of the glyph to the bottom extremum. + line="912">Distance from the top extremum of the glyph to the bottom extremum. @@ -14826,19 +14881,19 @@ Note that @height is negative, in coordinate systems that grow up. version="1.5.0"> Returns glyph flags encoded within a #hb_glyph_info_t. + line="1626">Returns glyph flags encoded within a #hb_glyph_info_t. The #hb_glyph_flags_t encoded within @info + line="1632">The #hb_glyph_flags_t encoded within @info a #hb_glyph_info_t + line="1628">a #hb_glyph_info_t @@ -15229,7 +15284,7 @@ conditionally based on those versions, again, at compile- or run-time. filename="hb-common.cc" line="330">Converts @str representing a BCP 47 language tag to the corresponding #hb_language_t. - + - + line="418">Check whether a second language tag is the same or a more specific version of the provided language tag. For example, "fa_IR.utf8" is a more specific tag for "fa" or for "fa_IR". - + Data type for languages. Each #hb_language_t corresponds to a BCP 47 + line="309">Data type for languages. Each #hb_language_t corresponds to a BCP 47 language tag. - + Converts an #hb_language_t to a string. - + Converts an #hb_language_t to a string. - + version="0.9.2"> Computes the transitive closure of glyphs needed for a specified + line="1277">Computes the transitive closure of glyphs needed for a specified input buffer under the given font and feature list. The closure is computed as a set, not as a list. @@ -21170,19 +21225,19 @@ computed as a set, not as a list. #hb_font_t to work upon + line="1279">#hb_font_t to work upon The input buffer to compute from + line="1280">The input buffer to compute from The features enabled on the buffer + line="1281">The features enabled on the buffer @@ -21190,7 +21245,7 @@ computed as a set, not as a list. The number of features enabled on the buffer + line="1282">The number of features enabled on the buffer transfer-ownership="none"> The #hb_set_t set of glyphs comprising the transitive closure of the query + line="1283">The #hb_set_t set of glyphs comprising the transitive closure of the query @@ -21209,7 +21264,7 @@ computed as a set, not as a list. version="0.9.7"> Computes the complete set of GSUB or GPOS lookups that are applicable + line="1237">Computes the complete set of GSUB or GPOS lookups that are applicable under a given @shape_plan. @@ -21219,13 +21274,13 @@ under a given @shape_plan. #hb_shape_plan_t to query + line="1239">#hb_shape_plan_t to query GSUB or GPOS + line="1240">GSUB or GPOS transfer-ownership="none"> The #hb_set_t set of lookups returned + line="1241">The #hb_set_t set of lookups returned @@ -24917,7 +24972,7 @@ of the gradient, and how to interpret the @color_line. Converts an ISO 15924 script tag to a corresponding #hb_script_t. - + line="503">Converts a string @str representing an ISO 15924 script tag to a corresponding #hb_script_t. Shorthand for hb_tag_from_string() then hb_script_from_iso15924_tag(). - + - + c:type="hb_script_t"> Data type for scripts. Each #hb_script_t's value is an #hb_tag_t corresponding + line="340">Data type for scripts. Each #hb_script_t's value is an #hb_tag_t corresponding to the four-letter values defined by [ISO 15924](https://unicode.org/iso15924/). See also the Script (sc) property of the Unicode Character Database. @@ -25010,7 +25065,7 @@ See also the Script (sc) property of the Unicode Character Database. glib:name="HB_SCRIPT_COMMON"> `Zyyy` + line="342">`Zyyy` glib:name="HB_SCRIPT_INHERITED"> `Zinh` + line="343">`Zinh` glib:name="HB_SCRIPT_UNKNOWN"> `Zzzz` + line="344">`Zzzz` glib:name="HB_SCRIPT_ARABIC"> `Arab` + line="345">`Arab` glib:name="HB_SCRIPT_ARMENIAN"> `Armn` + line="346">`Armn` glib:name="HB_SCRIPT_BENGALI"> `Beng` + line="347">`Beng` glib:name="HB_SCRIPT_CYRILLIC"> `Cyrl` + line="348">`Cyrl` glib:name="HB_SCRIPT_DEVANAGARI"> `Deva` + line="349">`Deva` glib:name="HB_SCRIPT_GEORGIAN"> `Geor` + line="350">`Geor` glib:name="HB_SCRIPT_GREEK"> `Grek` + line="351">`Grek` glib:name="HB_SCRIPT_GUJARATI"> `Gujr` + line="352">`Gujr` glib:name="HB_SCRIPT_GURMUKHI"> `Guru` + line="353">`Guru` glib:name="HB_SCRIPT_HANGUL"> `Hang` + line="354">`Hang` glib:name="HB_SCRIPT_HAN"> `Hani` + line="355">`Hani` glib:name="HB_SCRIPT_HEBREW"> `Hebr` + line="356">`Hebr` glib:name="HB_SCRIPT_HIRAGANA"> `Hira` + line="357">`Hira` glib:name="HB_SCRIPT_KANNADA"> `Knda` + line="358">`Knda` glib:name="HB_SCRIPT_KATAKANA"> `Kana` + line="359">`Kana` glib:name="HB_SCRIPT_LAO"> `Laoo` + line="360">`Laoo` glib:name="HB_SCRIPT_LATIN"> `Latn` + line="361">`Latn` glib:name="HB_SCRIPT_MALAYALAM"> `Mlym` + line="362">`Mlym` glib:name="HB_SCRIPT_ORIYA"> `Orya` + line="363">`Orya` glib:name="HB_SCRIPT_TAMIL"> `Taml` + line="364">`Taml` glib:name="HB_SCRIPT_TELUGU"> `Telu` + line="365">`Telu` glib:name="HB_SCRIPT_THAI"> `Thai` + line="366">`Thai` glib:name="HB_SCRIPT_TIBETAN"> `Tibt` + line="367">`Tibt` glib:name="HB_SCRIPT_BOPOMOFO"> `Bopo` + line="368">`Bopo` glib:name="HB_SCRIPT_BRAILLE"> `Brai` + line="369">`Brai` glib:name="HB_SCRIPT_CANADIAN_SYLLABICS"> `Cans` + line="370">`Cans` glib:name="HB_SCRIPT_CHEROKEE"> `Cher` + line="371">`Cher` glib:name="HB_SCRIPT_ETHIOPIC"> `Ethi` + line="372">`Ethi` glib:name="HB_SCRIPT_KHMER"> `Khmr` + line="373">`Khmr` glib:name="HB_SCRIPT_MONGOLIAN"> `Mong` + line="374">`Mong` glib:name="HB_SCRIPT_MYANMAR"> `Mymr` + line="375">`Mymr` glib:name="HB_SCRIPT_OGHAM"> `Ogam` + line="376">`Ogam` glib:name="HB_SCRIPT_RUNIC"> `Runr` + line="377">`Runr` glib:name="HB_SCRIPT_SINHALA"> `Sinh` + line="378">`Sinh` glib:name="HB_SCRIPT_SYRIAC"> `Syrc` + line="379">`Syrc` glib:name="HB_SCRIPT_THAANA"> `Thaa` + line="380">`Thaa` glib:name="HB_SCRIPT_YI"> `Yiii` + line="381">`Yiii` glib:name="HB_SCRIPT_DESERET"> `Dsrt` + line="382">`Dsrt` glib:name="HB_SCRIPT_GOTHIC"> `Goth` + line="383">`Goth` glib:name="HB_SCRIPT_OLD_ITALIC"> `Ital` + line="384">`Ital` glib:name="HB_SCRIPT_BUHID"> `Buhd` + line="385">`Buhd` glib:name="HB_SCRIPT_HANUNOO"> `Hano` + line="386">`Hano` glib:name="HB_SCRIPT_TAGALOG"> `Tglg` + line="387">`Tglg` glib:name="HB_SCRIPT_TAGBANWA"> `Tagb` + line="388">`Tagb` glib:name="HB_SCRIPT_CYPRIOT"> `Cprt` + line="389">`Cprt` glib:name="HB_SCRIPT_LIMBU"> `Limb` + line="390">`Limb` glib:name="HB_SCRIPT_LINEAR_B"> `Linb` + line="391">`Linb` glib:name="HB_SCRIPT_OSMANYA"> `Osma` + line="392">`Osma` glib:name="HB_SCRIPT_SHAVIAN"> `Shaw` + line="393">`Shaw` glib:name="HB_SCRIPT_TAI_LE"> `Tale` + line="394">`Tale` glib:name="HB_SCRIPT_UGARITIC"> `Ugar` + line="395">`Ugar` glib:name="HB_SCRIPT_BUGINESE"> `Bugi` + line="396">`Bugi` glib:name="HB_SCRIPT_COPTIC"> `Copt` + line="397">`Copt` glib:name="HB_SCRIPT_GLAGOLITIC"> `Glag` + line="398">`Glag` glib:name="HB_SCRIPT_KHAROSHTHI"> `Khar` + line="399">`Khar` glib:name="HB_SCRIPT_NEW_TAI_LUE"> `Talu` + line="400">`Talu` glib:name="HB_SCRIPT_OLD_PERSIAN"> `Xpeo` + line="401">`Xpeo` glib:name="HB_SCRIPT_SYLOTI_NAGRI"> `Sylo` + line="402">`Sylo` glib:name="HB_SCRIPT_TIFINAGH"> `Tfng` + line="403">`Tfng` glib:name="HB_SCRIPT_BALINESE"> `Bali` + line="404">`Bali` glib:name="HB_SCRIPT_CUNEIFORM"> `Xsux` + line="405">`Xsux` glib:name="HB_SCRIPT_NKO"> `Nkoo` + line="406">`Nkoo` glib:name="HB_SCRIPT_PHAGS_PA"> `Phag` + line="407">`Phag` glib:name="HB_SCRIPT_PHOENICIAN"> `Phnx` + line="408">`Phnx` glib:name="HB_SCRIPT_CARIAN"> `Cari` + line="409">`Cari` glib:name="HB_SCRIPT_CHAM"> `Cham` + line="410">`Cham` glib:name="HB_SCRIPT_KAYAH_LI"> `Kali` + line="411">`Kali` glib:name="HB_SCRIPT_LEPCHA"> `Lepc` + line="412">`Lepc` glib:name="HB_SCRIPT_LYCIAN"> `Lyci` + line="413">`Lyci` glib:name="HB_SCRIPT_LYDIAN"> `Lydi` + line="414">`Lydi` glib:name="HB_SCRIPT_OL_CHIKI"> `Olck` + line="415">`Olck` glib:name="HB_SCRIPT_REJANG"> `Rjng` + line="416">`Rjng` glib:name="HB_SCRIPT_SAURASHTRA"> `Saur` + line="417">`Saur` glib:name="HB_SCRIPT_SUNDANESE"> `Sund` + line="418">`Sund` glib:name="HB_SCRIPT_VAI"> `Vaii` + line="419">`Vaii` glib:name="HB_SCRIPT_AVESTAN"> `Avst` + line="420">`Avst` glib:name="HB_SCRIPT_BAMUM"> `Bamu` + line="421">`Bamu` glib:name="HB_SCRIPT_EGYPTIAN_HIEROGLYPHS"> `Egyp` + line="422">`Egyp` glib:name="HB_SCRIPT_IMPERIAL_ARAMAIC"> `Armi` + line="423">`Armi` glib:name="HB_SCRIPT_INSCRIPTIONAL_PAHLAVI"> `Phli` + line="424">`Phli` glib:name="HB_SCRIPT_INSCRIPTIONAL_PARTHIAN"> `Prti` + line="425">`Prti` glib:name="HB_SCRIPT_JAVANESE"> `Java` + line="426">`Java` glib:name="HB_SCRIPT_KAITHI"> `Kthi` + line="427">`Kthi` glib:name="HB_SCRIPT_LISU"> `Lisu` + line="428">`Lisu` glib:name="HB_SCRIPT_MEETEI_MAYEK"> `Mtei` + line="429">`Mtei` glib:name="HB_SCRIPT_OLD_SOUTH_ARABIAN"> `Sarb` + line="430">`Sarb` glib:name="HB_SCRIPT_OLD_TURKIC"> `Orkh` + line="431">`Orkh` glib:name="HB_SCRIPT_SAMARITAN"> `Samr` + line="432">`Samr` glib:name="HB_SCRIPT_TAI_THAM"> `Lana` + line="433">`Lana` glib:name="HB_SCRIPT_TAI_VIET"> `Tavt` + line="434">`Tavt` glib:name="HB_SCRIPT_BATAK"> `Batk` + line="435">`Batk` glib:name="HB_SCRIPT_BRAHMI"> `Brah` + line="436">`Brah` glib:name="HB_SCRIPT_MANDAIC"> `Mand` + line="437">`Mand` glib:name="HB_SCRIPT_CHAKMA"> `Cakm` + line="438">`Cakm` glib:name="HB_SCRIPT_MEROITIC_CURSIVE"> `Merc` + line="439">`Merc` glib:name="HB_SCRIPT_MEROITIC_HIEROGLYPHS"> `Mero` + line="440">`Mero` glib:name="HB_SCRIPT_MIAO"> `Plrd` + line="441">`Plrd` glib:name="HB_SCRIPT_SHARADA"> `Shrd` + line="442">`Shrd` glib:name="HB_SCRIPT_SORA_SOMPENG"> `Sora` + line="443">`Sora` glib:name="HB_SCRIPT_TAKRI"> `Takr` + line="444">`Takr` glib:name="HB_SCRIPT_BASSA_VAH"> `Bass`, Since: 0.9.30 + line="445">`Bass`, Since: 0.9.30 glib:name="HB_SCRIPT_CAUCASIAN_ALBANIAN"> `Aghb`, Since: 0.9.30 + line="446">`Aghb`, Since: 0.9.30 glib:name="HB_SCRIPT_DUPLOYAN"> `Dupl`, Since: 0.9.30 + line="447">`Dupl`, Since: 0.9.30 glib:name="HB_SCRIPT_ELBASAN"> `Elba`, Since: 0.9.30 + line="448">`Elba`, Since: 0.9.30 glib:name="HB_SCRIPT_GRANTHA"> `Gran`, Since: 0.9.30 + line="449">`Gran`, Since: 0.9.30 glib:name="HB_SCRIPT_KHOJKI"> `Khoj`, Since: 0.9.30 + line="450">`Khoj`, Since: 0.9.30 glib:name="HB_SCRIPT_KHUDAWADI"> `Sind`, Since: 0.9.30 + line="451">`Sind`, Since: 0.9.30 glib:name="HB_SCRIPT_LINEAR_A"> `Lina`, Since: 0.9.30 + line="452">`Lina`, Since: 0.9.30 glib:name="HB_SCRIPT_MAHAJANI"> `Mahj`, Since: 0.9.30 + line="453">`Mahj`, Since: 0.9.30 glib:name="HB_SCRIPT_MANICHAEAN"> `Mani`, Since: 0.9.30 + line="454">`Mani`, Since: 0.9.30 glib:name="HB_SCRIPT_MENDE_KIKAKUI"> `Mend`, Since: 0.9.30 + line="455">`Mend`, Since: 0.9.30 glib:name="HB_SCRIPT_MODI"> `Modi`, Since: 0.9.30 + line="456">`Modi`, Since: 0.9.30 glib:name="HB_SCRIPT_MRO"> `Mroo`, Since: 0.9.30 + line="457">`Mroo`, Since: 0.9.30 glib:name="HB_SCRIPT_NABATAEAN"> `Nbat`, Since: 0.9.30 + line="458">`Nbat`, Since: 0.9.30 glib:name="HB_SCRIPT_OLD_NORTH_ARABIAN"> `Narb`, Since: 0.9.30 + line="459">`Narb`, Since: 0.9.30 glib:name="HB_SCRIPT_OLD_PERMIC"> `Perm`, Since: 0.9.30 + line="460">`Perm`, Since: 0.9.30 glib:name="HB_SCRIPT_PAHAWH_HMONG"> `Hmng`, Since: 0.9.30 + line="461">`Hmng`, Since: 0.9.30 glib:name="HB_SCRIPT_PALMYRENE"> `Palm`, Since: 0.9.30 + line="462">`Palm`, Since: 0.9.30 glib:name="HB_SCRIPT_PAU_CIN_HAU"> `Pauc`, Since: 0.9.30 + line="463">`Pauc`, Since: 0.9.30 glib:name="HB_SCRIPT_PSALTER_PAHLAVI"> `Phlp`, Since: 0.9.30 + line="464">`Phlp`, Since: 0.9.30 glib:name="HB_SCRIPT_SIDDHAM"> `Sidd`, Since: 0.9.30 + line="465">`Sidd`, Since: 0.9.30 glib:name="HB_SCRIPT_TIRHUTA"> `Tirh`, Since: 0.9.30 + line="466">`Tirh`, Since: 0.9.30 glib:name="HB_SCRIPT_WARANG_CITI"> `Wara`, Since: 0.9.30 + line="467">`Wara`, Since: 0.9.30 glib:name="HB_SCRIPT_AHOM"> `Ahom`, Since: 0.9.30 + line="468">`Ahom`, Since: 0.9.30 glib:name="HB_SCRIPT_ANATOLIAN_HIEROGLYPHS"> `Hluw`, Since: 0.9.30 + line="469">`Hluw`, Since: 0.9.30 glib:name="HB_SCRIPT_HATRAN"> `Hatr`, Since: 0.9.30 + line="470">`Hatr`, Since: 0.9.30 glib:name="HB_SCRIPT_MULTANI"> `Mult`, Since: 0.9.30 + line="471">`Mult`, Since: 0.9.30 glib:name="HB_SCRIPT_OLD_HUNGARIAN"> `Hung`, Since: 0.9.30 + line="472">`Hung`, Since: 0.9.30 glib:name="HB_SCRIPT_SIGNWRITING"> `Sgnw`, Since: 0.9.30 + line="473">`Sgnw`, Since: 0.9.30 glib:name="HB_SCRIPT_ADLAM"> `Adlm`, Since: 1.3.0 + line="474">`Adlm`, Since: 1.3.0 glib:name="HB_SCRIPT_BHAIKSUKI"> `Bhks`, Since: 1.3.0 + line="475">`Bhks`, Since: 1.3.0 glib:name="HB_SCRIPT_MARCHEN"> `Marc`, Since: 1.3.0 + line="476">`Marc`, Since: 1.3.0 glib:name="HB_SCRIPT_OSAGE"> `Osge`, Since: 1.3.0 + line="477">`Osge`, Since: 1.3.0 glib:name="HB_SCRIPT_TANGUT"> `Tang`, Since: 1.3.0 + line="478">`Tang`, Since: 1.3.0 glib:name="HB_SCRIPT_NEWA"> `Newa`, Since: 1.3.0 + line="479">`Newa`, Since: 1.3.0 glib:name="HB_SCRIPT_MASARAM_GONDI"> `Gonm`, Since: 1.6.0 + line="480">`Gonm`, Since: 1.6.0 glib:name="HB_SCRIPT_NUSHU"> `Nshu`, Since: 1.6.0 + line="481">`Nshu`, Since: 1.6.0 glib:name="HB_SCRIPT_SOYOMBO"> `Soyo`, Since: 1.6.0 + line="482">`Soyo`, Since: 1.6.0 glib:name="HB_SCRIPT_ZANABAZAR_SQUARE"> `Zanb`, Since: 1.6.0 + line="483">`Zanb`, Since: 1.6.0 glib:name="HB_SCRIPT_DOGRA"> `Dogr`, Since: 1.8.0 + line="484">`Dogr`, Since: 1.8.0 glib:name="HB_SCRIPT_GUNJALA_GONDI"> `Gong`, Since: 1.8.0 + line="485">`Gong`, Since: 1.8.0 glib:name="HB_SCRIPT_HANIFI_ROHINGYA"> `Rohg`, Since: 1.8.0 + line="486">`Rohg`, Since: 1.8.0 glib:name="HB_SCRIPT_MAKASAR"> `Maka`, Since: 1.8.0 + line="487">`Maka`, Since: 1.8.0 glib:name="HB_SCRIPT_MEDEFAIDRIN"> `Medf`, Since: 1.8.0 + line="488">`Medf`, Since: 1.8.0 glib:name="HB_SCRIPT_OLD_SOGDIAN"> `Sogo`, Since: 1.8.0 + line="489">`Sogo`, Since: 1.8.0 glib:name="HB_SCRIPT_SOGDIAN"> `Sogd`, Since: 1.8.0 + line="490">`Sogd`, Since: 1.8.0 glib:name="HB_SCRIPT_ELYMAIC"> `Elym`, Since: 2.4.0 + line="491">`Elym`, Since: 2.4.0 glib:name="HB_SCRIPT_NANDINAGARI"> `Nand`, Since: 2.4.0 + line="492">`Nand`, Since: 2.4.0 glib:name="HB_SCRIPT_NYIAKENG_PUACHUE_HMONG"> `Hmnp`, Since: 2.4.0 + line="493">`Hmnp`, Since: 2.4.0 glib:name="HB_SCRIPT_WANCHO"> `Wcho`, Since: 2.4.0 + line="494">`Wcho`, Since: 2.4.0 glib:name="HB_SCRIPT_CHORASMIAN"> `Chrs`, Since: 2.6.7 + line="495">`Chrs`, Since: 2.6.7 glib:name="HB_SCRIPT_DIVES_AKURU"> `Diak`, Since: 2.6.7 + line="496">`Diak`, Since: 2.6.7 glib:name="HB_SCRIPT_KHITAN_SMALL_SCRIPT"> `Kits`, Since: 2.6.7 + line="497">`Kits`, Since: 2.6.7 glib:name="HB_SCRIPT_YEZIDI"> `Yezi`, Since: 2.6.7 + line="498">`Yezi`, Since: 2.6.7 glib:name="HB_SCRIPT_CYPRO_MINOAN"> `Cpmn`, Since: 3.0.0 + line="499">`Cpmn`, Since: 3.0.0 glib:name="HB_SCRIPT_OLD_UYGHUR"> `Ougr`, Since: 3.0.0 + line="500">`Ougr`, Since: 3.0.0 glib:name="HB_SCRIPT_TANGSA"> `Tnsa`, Since: 3.0.0 + line="501">`Tnsa`, Since: 3.0.0 glib:name="HB_SCRIPT_TOTO"> `Toto`, Since: 3.0.0 + line="502">`Toto`, Since: 3.0.0 glib:name="HB_SCRIPT_VITHKUQI"> `Vith`, Since: 3.0.0 + line="503">`Vith`, Since: 3.0.0 glib:name="HB_SCRIPT_MATH"> `Zmth`, Since: 3.4.0 + line="504">`Zmth`, Since: 3.4.0 glib:name="HB_SCRIPT_KAWI"> `Kawi`, Since: 5.2.0 + line="505">`Kawi`, Since: 5.2.0 glib:name="HB_SCRIPT_NAG_MUNDARI"> `Nagm`, Since: 5.2.0 + line="506">`Nagm`, Since: 5.2.0 glib:name="HB_SCRIPT_INVALID"> No script set + line="507">No script set Converts an #hb_script_t to a corresponding ISO 15924 script tag. - + are four characters. Shorter input strings will be padded with spaces. Longer input strings will be truncated. - + filename="hb-common.cc" line="115">Converts an #hb_tag_t to a string and returns it in @buf. Strings will be four characters long. - + @@ -30435,14 +30490,14 @@ specified Unicode code point. c:symbol-prefix="gobject_user_data_key"> Data structure for holding user-data keys. - + line="771">Data structure for holding user-data keys. + - + @@ -30471,7 +30526,7 @@ specified Unicode code point. - + @@ -30515,7 +30570,7 @@ accepted, though, not documented below. The format is a tag, optionally followed by an equals sign, followed by a number. For example `wght=500`, or `slnt=-7.5`. - + Data type for holding variation data. Registered OpenType + line="844">Data type for holding variation data. Registered OpenType variation-axis tags are listed in [OpenType Axis Tag Registry](https://docs.microsoft.com/en-us/typography/opentype/spec/dvaraxisreg). - + The #hb_tag_t tag of the variation-axis name + line="846">The #hb_tag_t tag of the variation-axis name The value of the variation axis + line="847">The value of the variation axis Converts an #hb_variation_t into a `NULL`-terminated string in the format understood by hb_variation_from_string(). The client in responsible for allocating big enough size for @buf, 128 bytes is more than enough. - + @@ -30618,7 +30673,7 @@ allocating big enough size for @buf, 128 bytes is more than enough. line="1111">Converts an #hb_variation_t into a `NULL`-terminated string in the format understood by hb_variation_from_string(). The client in responsible for allocating big enough size for @buf, 128 bytes is more than enough. - + diff --git a/girs/IAnjuta-3.0.gir b/girs/IAnjuta-3.0.gir index 6ae53abc3..e01b28513 100644 --- a/girs/IAnjuta-3.0.gir +++ b/girs/IAnjuta-3.0.gir @@ -556,7 +556,8 @@ in source build. + glib:nick="command-compile" + glib:name="IANJUTA_BUILDABLE_COMMAND_COMPILE"> Compile source @@ -564,7 +565,8 @@ in source build. + glib:nick="command-build" + glib:name="IANJUTA_BUILDABLE_COMMAND_BUILD"> Build file (normally using make) @@ -572,7 +574,8 @@ in source build. + glib:nick="command-build-tarball" + glib:name="IANJUTA_BUILDABLE_COMMAND_BUILD_TARBALL"> make dist @@ -580,7 +583,8 @@ in source build. + glib:nick="command-install" + glib:name="IANJUTA_BUILDABLE_COMMAND_INSTALL"> make install @@ -588,7 +592,8 @@ in source build. + glib:nick="command-configure" + glib:name="IANJUTA_BUILDABLE_COMMAND_CONFIGURE"> ./configure @@ -596,7 +601,8 @@ in source build. + glib:nick="command-generate" + glib:name="IANJUTA_BUILDABLE_COMMAND_GENERATE"> ./autogen.sh @@ -604,7 +610,8 @@ in source build. + glib:nick="command-clean" + glib:name="IANJUTA_BUILDABLE_COMMAND_CLEAN"> make clean @@ -612,7 +619,8 @@ in source build. + glib:nick="command-execute" + glib:name="IANJUTA_BUILDABLE_COMMAND_EXECUTE"> ./hello @@ -620,7 +628,8 @@ in source build. + glib:nick="command-is-built" + glib:name="IANJUTA_BUILDABLE_COMMAND_IS_BUILT"> check whether object files are up-to-date @@ -628,12 +637,14 @@ in source build. + glib:nick="command-autoreconf" + glib:name="IANJUTA_BUILDABLE_COMMAND_AUTORECONF"> + glib:nick="command-distclean" + glib:name="IANJUTA_BUILDABLE_COMMAND_DISTCLEAN"> make distclean @@ -641,7 +652,8 @@ in source build. + glib:nick="command-check" + glib:name="IANJUTA_BUILDABLE_COMMAND_CHECK"> make check @@ -649,7 +661,8 @@ in source build. + glib:nick="n-commands" + glib:name="IANJUTA_BUILDABLE_N_COMMANDS"> size of enum @@ -1261,7 +1274,8 @@ g_list_free. + glib:nick="succeed" + glib:name="IANJUTA_BUILDER_SUCCEED"> Build succeeded @@ -1269,7 +1283,8 @@ g_list_free. + glib:nick="failed" + glib:name="IANJUTA_BUILDER_FAILED"> Build failed @@ -1277,7 +1292,8 @@ g_list_free. + glib:nick="canceled" + glib:name="IANJUTA_BUILDER_CANCELED"> Build was canceld @@ -1285,7 +1301,8 @@ g_list_free. + glib:nick="aborted" + glib:name="IANJUTA_BUILDER_ABORTED"> Build aborted @@ -1293,7 +1310,8 @@ g_list_free. + glib:nick="interrupted" + glib:name="IANJUTA_BUILDER_INTERRUPTED"> Build interruped @@ -1301,7 +1319,8 @@ g_list_free. + glib:nick="terminated" + glib:name="IANJUTA_BUILDER_TERMINATED"> Build interruped @@ -1309,7 +1328,8 @@ g_list_free. + glib:nick="unknown-target" + glib:name="IANJUTA_BUILDER_UNKNOWN_TARGET"> The specified target is unknown @@ -1317,7 +1337,8 @@ g_list_free. + glib:nick="unknown-error" + glib:name="IANJUTA_BUILDER_UNKNOWN_ERROR"> Unknown Error @@ -1325,7 +1346,8 @@ g_list_free. + glib:nick="other-error" + glib:name="IANJUTA_BUILDER_OTHER_ERROR"> Other Error (no unknown ;-)) @@ -7010,7 +7032,8 @@ backend. + glib:nick="set-at-address" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_SET_AT_ADDRESS"> Allow to set breakpoint on address @@ -7018,7 +7041,8 @@ backend. + glib:nick="set-at-function" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_SET_AT_FUNCTION"> Allow to set breakpoint on function name @@ -7026,7 +7050,8 @@ backend. + glib:nick="enable" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_ENABLE"> Allow to disable breakpoint @@ -7034,7 +7059,8 @@ backend. + glib:nick="ignore" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_IGNORE"> Allow to ignore breakpoint @@ -7042,7 +7068,8 @@ backend. + glib:nick="condition" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_CONDITION"> Allow to add a condition on breakpoint @@ -7058,7 +7085,8 @@ backend. + glib:nick="removed" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_REMOVED"> Set for removed breakpoint @@ -7066,7 +7094,8 @@ backend. + glib:nick="updated" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_UPDATED"> Set for changed breakpoint @@ -7074,7 +7103,8 @@ backend. + glib:nick="on-line" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_ON_LINE"> Set on source line @@ -7082,7 +7112,8 @@ backend. + glib:nick="on-address" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_ON_ADDRESS"> Set on an addresse @@ -7090,7 +7121,8 @@ backend. + glib:nick="on-function" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_ON_FUNCTION"> Set on a function name @@ -7098,7 +7130,8 @@ backend. + glib:nick="on-read" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_ON_READ"> Set on read access @@ -7106,7 +7139,8 @@ backend. + glib:nick="on-write" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_ON_WRITE"> Set on write access @@ -7114,7 +7148,8 @@ backend. + glib:nick="with-enable" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_WITH_ENABLE"> Has enable information @@ -7122,7 +7157,8 @@ backend. + glib:nick="with-ignore" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_WITH_IGNORE"> Has ignore information, @@ -7130,7 +7166,8 @@ backend. + glib:nick="with-time" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_WITH_TIME"> Has counter information @@ -7138,7 +7175,8 @@ backend. + glib:nick="with-condition" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_WITH_CONDITION"> Has a condition @@ -7146,7 +7184,8 @@ backend. + glib:nick="with-temporary" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_WITH_TEMPORARY"> Temporary breakpoint, automatically removed when triggered @@ -7154,7 +7193,8 @@ backend. + glib:nick="with-pending" + glib:name="IANJUTA_DEBUGGER_BREAKPOINT_WITH_PENDING"> Pending breakpoint @@ -7209,7 +7249,8 @@ backend. + glib:nick="ok" + glib:name="IANJUTA_DEBUGGER_OK"> No error @@ -7217,7 +7258,8 @@ backend. + glib:nick="not-ready" + glib:name="IANJUTA_DEBUGGER_NOT_READY"> Debugger is not ready to execute the command @@ -7225,7 +7267,8 @@ backend. + glib:nick="not-running" + glib:name="IANJUTA_DEBUGGER_NOT_RUNNING"> Debugger is not is running state @@ -7233,7 +7276,8 @@ backend. + glib:nick="not-stopped" + glib:name="IANJUTA_DEBUGGER_NOT_STOPPED"> Debugger is not is stopped state @@ -7241,7 +7285,8 @@ backend. + glib:nick="not-loaded" + glib:name="IANJUTA_DEBUGGER_NOT_LOADED"> Debugger is not is loaded state @@ -7249,7 +7294,8 @@ backend. + glib:nick="not-started" + glib:name="IANJUTA_DEBUGGER_NOT_STARTED"> Debugger is not in started state @@ -7257,7 +7303,8 @@ backend. + glib:nick="not-connected" + glib:name="IANJUTA_DEBUGGER_NOT_CONNECTED"> Debugger is not connected: @@ -7265,7 +7312,8 @@ backend. + glib:nick="not-implemented" + glib:name="IANJUTA_DEBUGGER_NOT_IMPLEMENTED"> Corresponding function is not implemented @@ -7273,7 +7321,8 @@ backend. + glib:nick="cancel" + glib:name="IANJUTA_DEBUGGER_CANCEL"> Operation has been cancelled @@ -7281,7 +7330,8 @@ backend. + glib:nick="unable-to-create-variable" + glib:name="IANJUTA_DEBUGGER_UNABLE_TO_CREATE_VARIABLE"> Debugger cannot create variable @@ -7289,7 +7339,8 @@ backend. + glib:nick="unable-to-access-memory" + glib:name="IANJUTA_DEBUGGER_UNABLE_TO_ACCESS_MEMORY"> Debugger cannot access memory @@ -7297,7 +7348,8 @@ backend. + glib:nick="unable-to-open-file" + glib:name="IANJUTA_DEBUGGER_UNABLE_TO_OPEN_FILE"> Debugger cannot open file @@ -7305,7 +7357,8 @@ backend. + glib:nick="unsupported-file-type" + glib:name="IANJUTA_DEBUGGER_UNSUPPORTED_FILE_TYPE"> Debugger cannot debug such file @@ -7313,7 +7366,8 @@ backend. + glib:nick="unsupported-version" + glib:name="IANJUTA_DEBUGGER_UNSUPPORTED_VERSION"> Debugger is too old @@ -7321,7 +7375,8 @@ backend. + glib:nick="unable-to-find-debugger" + glib:name="IANJUTA_DEBUGGER_UNABLE_TO_FIND_DEBUGGER"> Debugger cannot be found @@ -7329,7 +7384,8 @@ backend. + glib:nick="already-done" + glib:name="IANJUTA_DEBUGGER_ALREADY_DONE"> Command has already been executed @@ -7337,7 +7393,8 @@ backend. + glib:nick="program-not-found" + glib:name="IANJUTA_DEBUGGER_PROGRAM_NOT_FOUND"> Program cannot be found @@ -7345,7 +7402,8 @@ backend. + glib:nick="unable-to-connect" + glib:name="IANJUTA_DEBUGGER_UNABLE_TO_CONNECT"> Unable to connect to debugger @@ -7353,7 +7411,8 @@ backend. + glib:nick="unknown-error" + glib:name="IANJUTA_DEBUGGER_UNKNOWN_ERROR"> Unknown error @@ -7361,7 +7420,8 @@ backend. + glib:nick="other-error" + glib:name="IANJUTA_DEBUGGER_OTHER_ERROR"> other error @@ -9833,7 +9893,8 @@ NULL data. + glib:nick="output" + glib:name="IANJUTA_DEBUGGER_OUTPUT"> Output from debugger @@ -9841,7 +9902,8 @@ NULL data. + glib:nick="warning-output" + glib:name="IANJUTA_DEBUGGER_WARNING_OUTPUT"> Warning from debugger @@ -9849,7 +9911,8 @@ NULL data. + glib:nick="error-output" + glib:name="IANJUTA_DEBUGGER_ERROR_OUTPUT"> Error from debugger @@ -9857,7 +9920,8 @@ NULL data. + glib:nick="info-output" + glib:name="IANJUTA_DEBUGGER_INFO_OUTPUT"> Additional message from debugger @@ -10244,7 +10308,8 @@ called. If FALSE, the callback will not be called. + glib:nick="busy" + glib:name="IANJUTA_DEBUGGER_BUSY"> Debugger is executing a command, it can enter in another @@ -10253,7 +10318,8 @@ called. If FALSE, the callback will not be called. + glib:nick="stopped" + glib:name="IANJUTA_DEBUGGER_STOPPED"> Debugger is stopped. @@ -10261,7 +10327,8 @@ called. If FALSE, the callback will not be called. + glib:nick="started" + glib:name="IANJUTA_DEBUGGER_STARTED"> Debugger is started but no program is loaded. @@ -10269,7 +10336,8 @@ called. If FALSE, the callback will not be called. + glib:nick="program-loaded" + glib:name="IANJUTA_DEBUGGER_PROGRAM_LOADED"> Debugger is started and has a program loaded. @@ -10277,7 +10345,8 @@ called. If FALSE, the callback will not be called. + glib:nick="program-stopped" + glib:name="IANJUTA_DEBUGGER_PROGRAM_STOPPED"> Debugger is started and has a program stopped. @@ -10285,7 +10354,8 @@ called. If FALSE, the callback will not be called. + glib:nick="program-running" + glib:name="IANJUTA_DEBUGGER_PROGRAM_RUNNING"> Debugger is started and has a program running. @@ -12576,7 +12646,8 @@ saves the document before closing. + glib:nick="doesnt-exist" + glib:name="IANJUTA_DOCUMENT_MANAGER_DOESNT_EXIST"> @@ -15457,7 +15528,8 @@ editors implement this. + glib:nick="text" + glib:name="IANJUTA_EDITOR_TEXT"> Normal text @@ -15465,7 +15537,8 @@ editors implement this. + glib:nick="keyword" + glib:name="IANJUTA_EDITOR_KEYWORD"> A keyword of the programming language @@ -15473,7 +15546,8 @@ editors implement this. + glib:nick="comment" + glib:name="IANJUTA_EDITOR_COMMENT"> A comment @@ -15481,7 +15555,8 @@ editors implement this. + glib:nick="string" + glib:name="IANJUTA_EDITOR_STRING"> A string @@ -16283,7 +16358,8 @@ character. + glib:nick="doesnt-exist" + glib:name="IANJUTA_EDITOR_DOESNT_EXIST"> @@ -18465,7 +18541,8 @@ editors implement this. + glib:nick="lf" + glib:name="IANJUTA_EDITOR_LINE_MODE_LF"> Line-Feed (Unix) @@ -18473,7 +18550,8 @@ editors implement this. + glib:nick="cr" + glib:name="IANJUTA_EDITOR_LINE_MODE_CR"> Carat return (Max) @@ -18481,7 +18559,8 @@ editors implement this. + glib:nick="crlf" + glib:name="IANJUTA_EDITOR_LINE_MODE_CRLF"> Caret return + line-feed (Windows) @@ -20199,12 +20278,14 @@ free the output string when not needed. + glib:nick="config" + glib:name="IANJUTA_ENVIRONMENT_CONFIG"> + glib:nick="other-error" + glib:name="IANJUTA_ENVIRONMENT_OTHER_ERROR"> @@ -22625,7 +22706,8 @@ according to the next line start/end. + glib:nick="none" + glib:name="IANJUTA_INDICABLE_NONE"> No indicator @@ -22633,7 +22715,8 @@ according to the next line start/end. + glib:nick="important" + glib:name="IANJUTA_INDICABLE_IMPORTANT"> Important indicator @@ -22641,7 +22724,8 @@ according to the next line start/end. + glib:nick="warning" + glib:name="IANJUTA_INDICABLE_WARNING"> Warning indicator @@ -22649,7 +22733,8 @@ according to the next line start/end. + glib:nick="critical" + glib:name="IANJUTA_INDICABLE_CRITICAL"> Critical indicator @@ -25638,7 +25723,8 @@ implementor object. + glib:nick="invalid-location" + glib:name="IANJUTA_MARKABLE_INVALID_LOCATION"> @@ -25831,7 +25917,8 @@ implementor object. + glib:nick="linemarker" + glib:name="IANJUTA_MARKABLE_LINEMARKER"> Mark a particular line @@ -25839,7 +25926,8 @@ implementor object. + glib:nick="bookmark" + glib:name="IANJUTA_MARKABLE_BOOKMARK"> A bookmark @@ -25847,7 +25935,8 @@ implementor object. + glib:nick="message" + glib:name="IANJUTA_MARKABLE_MESSAGE"> An (error) message @@ -25855,7 +25944,8 @@ implementor object. + glib:nick="breakpoint-disabled" + glib:name="IANJUTA_MARKABLE_BREAKPOINT_DISABLED"> a disabled breakpoint @@ -25863,7 +25953,8 @@ implementor object. + glib:nick="breakpoint-enabled" + glib:name="IANJUTA_MARKABLE_BREAKPOINT_ENABLED"> a enabled breakpoint @@ -25871,7 +25962,8 @@ implementor object. + glib:nick="program-counter" + glib:name="IANJUTA_MARKABLE_PROGRAM_COUNTER"> Marks the program counter position @@ -26411,7 +26503,8 @@ will become invalid. + glib:nick="doesnt-exist" + glib:name="IANJUTA_MESSAGE_MANAGER_DOESNT_EXIST"> @@ -27231,7 +27324,8 @@ by emiiting buffer_flushed signal. The string is expected to be utf8. + glib:nick="type-normal" + glib:name="IANJUTA_MESSAGE_VIEW_TYPE_NORMAL"> Normal message @@ -27239,7 +27333,8 @@ by emiiting buffer_flushed signal. The string is expected to be utf8. + glib:nick="type-info" + glib:name="IANJUTA_MESSAGE_VIEW_TYPE_INFO"> Info message (highlighed) @@ -27247,7 +27342,8 @@ by emiiting buffer_flushed signal. The string is expected to be utf8. + glib:nick="type-warning" + glib:name="IANJUTA_MESSAGE_VIEW_TYPE_WARNING"> Warning message @@ -27255,7 +27351,8 @@ by emiiting buffer_flushed signal. The string is expected to be utf8. + glib:nick="type-error" + glib:name="IANJUTA_MESSAGE_VIEW_TYPE_ERROR"> Error message @@ -27524,12 +27621,14 @@ give it the AnjutaShell object as argument. + glib:nick="ok" + glib:name="IANJUTA_PLUGIN_FACTORY_OK"> + glib:nick="missing-location" + glib:name="IANJUTA_PLUGIN_FACTORY_MISSING_LOCATION"> Module file location is @@ -27538,7 +27637,8 @@ missing in .plugin file + glib:nick="missing-type" + glib:name="IANJUTA_PLUGIN_FACTORY_MISSING_TYPE"> Plugin type (just after @@ -27547,7 +27647,8 @@ double colon following location) is missing in .plugin file + glib:nick="missing-module" + glib:name="IANJUTA_PLUGIN_FACTORY_MISSING_MODULE"> Module file name not found, @@ -27556,7 +27657,8 @@ plugin module is probably not installed + glib:nick="invalid-module" + glib:name="IANJUTA_PLUGIN_FACTORY_INVALID_MODULE"> Module file cannot be @@ -27565,7 +27667,8 @@ loaded, not a shared library perhaps + glib:nick="missing-function" + glib:name="IANJUTA_PLUGIN_FACTORY_MISSING_FUNCTION"> Module does not contain @@ -27575,7 +27678,8 @@ is not for the right version + glib:nick="invalid-type" + glib:name="IANJUTA_PLUGIN_FACTORY_INVALID_TYPE"> Module has not registered @@ -27585,7 +27689,8 @@ the right version + glib:nick="unknown-error" + glib:name="IANJUTA_PLUGIN_FACTORY_UNKNOWN_ERROR"> Another error @@ -29278,42 +29383,50 @@ the file you must add a refcount using g_object_ref(). + glib:nick="error-success" + glib:name="IANJUTA_PROJECT_ERROR_SUCCESS"> + glib:nick="error-doesnt-exist" + glib:name="IANJUTA_PROJECT_ERROR_DOESNT_EXIST"> + glib:nick="error-already-exists" + glib:name="IANJUTA_PROJECT_ERROR_ALREADY_EXISTS"> + glib:nick="error-validation-failed" + glib:name="IANJUTA_PROJECT_ERROR_VALIDATION_FAILED"> + glib:nick="error-project-malformed" + glib:name="IANJUTA_PROJECT_ERROR_PROJECT_MALFORMED"> + glib:nick="error-wrong-parent" + glib:name="IANJUTA_PROJECT_ERROR_WRONG_PARENT"> + glib:nick="error-not-supported" + glib:name="IANJUTA_PROJECT_ERROR_NOT_SUPPORTED"> + glib:nick="error-general-failure" + glib:name="IANJUTA_PROJECT_ERROR_GENERAL_FAILURE"> @@ -31418,17 +31531,20 @@ with g_list_free() and the files with g_object_unref(). + glib:nick="probe-files" + glib:name="IANJUTA_PROJECT_PROBE_FILES"> + glib:nick="probe-make-files" + glib:name="IANJUTA_PROJECT_PROBE_MAKE_FILES"> + glib:nick="probe-project-files" + glib:name="IANJUTA_PROJECT_PROBE_PROJECT_FILES"> + glib:nick="field-id" + glib:name="IANJUTA_SYMBOL_FIELD_ID"> Integer. A unique ID of the symbol @@ -32724,7 +32841,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-name" + glib:name="IANJUTA_SYMBOL_FIELD_NAME"> String. Name of the symbol @@ -32732,7 +32850,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-file-pos" + glib:name="IANJUTA_SYMBOL_FIELD_FILE_POS"> Integer. The file line number where the symbol is found. @@ -32740,12 +32859,14 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="filed-scope-def-id" + glib:name="IANJUTA_SYMBOL_FILED_SCOPE_DEF_ID"> + glib:nick="field-file-scope" + glib:name="IANJUTA_SYMBOL_FIELD_FILE_SCOPE"> Boolean: TRUE if symbol is within file scope, @@ -32754,7 +32875,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-signature" + glib:name="IANJUTA_SYMBOL_FIELD_SIGNATURE"> String. Signature of a method, if symbol is a funtion. @@ -32763,7 +32885,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-returntype" + glib:name="IANJUTA_SYMBOL_FIELD_RETURNTYPE"> String. Return type of a method, if symbol is a function. @@ -32771,7 +32894,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-type" + glib:name="IANJUTA_SYMBOL_FIELD_TYPE"> Both string and Integer. Type attribute of a symbol. @@ -32781,7 +32905,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-type-name" + glib:name="IANJUTA_SYMBOL_FIELD_TYPE_NAME"> type_name attribute of a symbol. @@ -32790,7 +32915,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-file-path" + glib:name="IANJUTA_SYMBOL_FIELD_FILE_PATH"> String. The relative path to the file where the symbol is found. @@ -32798,7 +32924,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-project-name" + glib:name="IANJUTA_SYMBOL_FIELD_PROJECT_NAME"> String. The project name to which the symbol belongs to. @@ -32806,7 +32933,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-project-version" + glib:name="IANJUTA_SYMBOL_FIELD_PROJECT_VERSION"> String. The project version to which the symbol belongs to. @@ -32814,7 +32942,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-implementation" + glib:name="IANJUTA_SYMBOL_FIELD_IMPLEMENTATION"> String. Implementation attribute of a symbol. It may be @@ -32823,7 +32952,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-access" + glib:name="IANJUTA_SYMBOL_FIELD_ACCESS"> String. Access attribute of a symbol. @@ -32832,7 +32962,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-kind" + glib:name="IANJUTA_SYMBOL_FIELD_KIND"> Kind attribute of a symbol, such as @@ -32841,7 +32972,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-is-container" + glib:name="IANJUTA_SYMBOL_FIELD_IS_CONTAINER"> Boolean. TRUE if symbol is @@ -32851,7 +32983,8 @@ e.g. #IANJUTA_SYMBOL_FIELD_TYPE. + glib:nick="field-end" + glib:name="IANJUTA_SYMBOL_FIELD_END"> The end marker. @@ -34644,7 +34777,8 @@ currently open project's symbols are found. + glib:nick="db-project" + glib:name="IANJUTA_SYMBOL_QUERY_DB_PROJECT"> Select project database. @@ -34652,7 +34786,8 @@ currently open project's symbols are found. + glib:nick="db-system" + glib:name="IANJUTA_SYMBOL_QUERY_DB_SYSTEM"> Select system database. @@ -34668,7 +34803,8 @@ currently open project's symbols are found. + glib:nick="search-fs-ignore" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_FS_IGNORE"> Ignore file scope @@ -34676,7 +34812,8 @@ currently open project's symbols are found. + glib:nick="search-fs-public" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_FS_PUBLIC"> Only public symbols visible to rest of project. @@ -34684,7 +34821,8 @@ currently open project's symbols are found. + glib:nick="search-fs-private" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_FS_PRIVATE"> Only private symbols visible inside a file. @@ -35168,7 +35306,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="mode-sync" + glib:name="IANJUTA_SYMBOL_QUERY_MODE_SYNC"> Syncronous query. The result is immediately @@ -35177,7 +35316,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="mode-async" + glib:name="IANJUTA_SYMBOL_QUERY_MODE_ASYNC"> Asynchronous query. The search call @@ -35187,7 +35327,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="mode-queued" + glib:name="IANJUTA_SYMBOL_QUERY_MODE_QUEUED"> If the database is busy @@ -35207,7 +35348,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="search" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH"> Query to perform basic substring search. @@ -35215,7 +35357,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="search-all" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_ALL"> Query to get all symbols @@ -35223,7 +35366,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="search-file" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_FILE"> Query to perform substring search in a file. @@ -35231,7 +35375,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="search-in-scope" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_IN_SCOPE"> Query to perform substring search in a scope. @@ -35239,7 +35384,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="search-id" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_ID"> Query to find the symbol of given ID. @@ -35247,7 +35393,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="search-members" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_MEMBERS"> Query to find members of a scope (eg. class). @@ -35255,7 +35402,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="search-class-parents" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_CLASS_PARENTS"> Query to get parents of a class. @@ -35263,7 +35411,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="search-scope" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_SCOPE"> Query to find scope name of a file position. @@ -35271,7 +35420,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="search-parent-scope" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_PARENT_SCOPE"> Query to get the parent scope of a symbol. @@ -35279,7 +35429,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="search-parent-scope-file" + glib:name="IANJUTA_SYMBOL_QUERY_SEARCH_PARENT_SCOPE_FILE"> Query to get the parent scope of a symbol in the file. @@ -35292,7 +35443,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-none" + glib:name="IANJUTA_SYMBOL_TYPE_NONE"> None spedified. @@ -35300,7 +35452,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-undef" + glib:name="IANJUTA_SYMBOL_TYPE_UNDEF"> Unknown type. @@ -35308,7 +35461,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-class" + glib:name="IANJUTA_SYMBOL_TYPE_CLASS"> Class declaration @@ -35316,7 +35470,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-enum" + glib:name="IANJUTA_SYMBOL_TYPE_ENUM"> Enum declaration @@ -35324,7 +35479,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-enumerator" + glib:name="IANJUTA_SYMBOL_TYPE_ENUMERATOR"> Enumerator value @@ -35332,7 +35488,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-field" + glib:name="IANJUTA_SYMBOL_TYPE_FIELD"> Field (Java only) @@ -35340,7 +35497,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-function" + glib:name="IANJUTA_SYMBOL_TYPE_FUNCTION"> Function definition @@ -35348,7 +35506,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-interface" + glib:name="IANJUTA_SYMBOL_TYPE_INTERFACE"> Interface (Java only) @@ -35356,7 +35515,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-member" + glib:name="IANJUTA_SYMBOL_TYPE_MEMBER"> Member variable of class/struct @@ -35364,7 +35524,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-method" + glib:name="IANJUTA_SYMBOL_TYPE_METHOD"> Class method (Java only) @@ -35372,7 +35533,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-namespace" + glib:name="IANJUTA_SYMBOL_TYPE_NAMESPACE"> Namespace declaration @@ -35380,7 +35542,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-package" + glib:name="IANJUTA_SYMBOL_TYPE_PACKAGE"> Package (Java only) @@ -35388,7 +35551,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-prototype" + glib:name="IANJUTA_SYMBOL_TYPE_PROTOTYPE"> Function prototype @@ -35396,7 +35560,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-struct" + glib:name="IANJUTA_SYMBOL_TYPE_STRUCT"> Struct declaration @@ -35404,7 +35569,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-typedef" + glib:name="IANJUTA_SYMBOL_TYPE_TYPEDEF"> Typedef @@ -35412,7 +35578,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-union" + glib:name="IANJUTA_SYMBOL_TYPE_UNION"> Union @@ -35420,7 +35587,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-variable" + glib:name="IANJUTA_SYMBOL_TYPE_VARIABLE"> Variable @@ -35428,7 +35596,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-externvar" + glib:name="IANJUTA_SYMBOL_TYPE_EXTERNVAR"> Extern or forward declaration @@ -35436,7 +35605,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-macro" + glib:name="IANJUTA_SYMBOL_TYPE_MACRO"> Macro (without arguments) @@ -35444,7 +35614,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-macro-with-arg" + glib:name="IANJUTA_SYMBOL_TYPE_MACRO_WITH_ARG"> Parameterized macro @@ -35452,7 +35623,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-file" + glib:name="IANJUTA_SYMBOL_TYPE_FILE"> File (Pseudo tag) @@ -35460,7 +35632,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-other" + glib:name="IANJUTA_SYMBOL_TYPE_OTHER"> Other (non C/C++/Java tag) @@ -35468,7 +35641,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-scope-container" + glib:name="IANJUTA_SYMBOL_TYPE_SCOPE_CONTAINER"> types which are subjected to create a scope. @@ -35476,7 +35650,8 @@ IANJUTA_SYMBOL_QUERY_MODE_SYNC is selected. + glib:nick="type-max" + glib:name="IANJUTA_SYMBOL_TYPE_MAX"> Maximum value, used as end marker. @@ -36305,7 +36480,8 @@ reporting. + glib:nick="unkown-error" + glib:name="IANJUTA_VCS_UNKOWN_ERROR"> @@ -36926,6 +37102,170 @@ ianjuta_vcs_query_status. + + This interface wrap the real debugger plugin and provide a +common graphical user interface. + + + This interface is implemented by debugger backends, by example the gdb +backend. It is used by the debug manager plugin which provides the +graphical interface and a simple wrapper: #IAnjutaDebugManager. + +The debugger is in one on these 5 states and emit a signal to the debug +manager when it changes. Here is figure showing all transitions and +the signal emitted. +<figure id="debugger-states"> +<mediaobject> + <imageobject> + <imagedata fileref="debugger-states.png" format="PNG"/> + </imageobject> +</mediaobject> +</figure> + + + This interface is used to debuger as machine instruction level. + + + This interface is used to examine the target memory. + + + This interface is used to examine and change values of CPU registers. + + + This interface is used to examine and change values of expression. +It is based on the MI2 variable object interface of gdb. A +variable needs to be created before being able to get or set its +value and list its children. + + + Represents a cell in editor. A cell corresponds to a unicode +character along with all associated styles (such as colors and font). +A cell may or may not have style. If style is supported in the +editor, it is assumed all cells will have styles and hence every +IAnjutaEditorCell interface instance will have additionally +IAnjutaEditorCellStyle implemented. + + + An editor view is a visual representation of the editor. An editor +can have multiple views. All views of an editor show the same editor +content (buffer). Consequently, any change done in one view is +updated in all other views. + + + Any plugin that can open files should implemented this interface. Along +with the 'File Loader::SupportedMimeTypes' property of the plugin in +.plugin file, it will be used by the loader to open files of that type. + + + Loaders can deterime correct plugin to open a file. + + + Plugins implementing #IAnjutaFile inteface that can also save files +should also implement this interface. + + + Loaders can deterime correct plugin to open a file or stream. They +themselves can not load it, but will correctly redirect the request to +an implementor of IAnjutaFile, IAnjutaFileSavable, IAnjutaStream or +IAnjutaStreamSavable, depending on the mime-type, meta-type or any other +requirements. + + + This interface is used to create all Anjuta plugin objects. It is +already implemented inside Anjuta by an object able to load plugins written +in C. In order to load plugins in other languages (or in a different way), +a loader plugin implementing this interface must be written first, probably +in C. + + + This is the new interface that is replacing Gnome Build. + + + StreamLoaders can deterime correct plugin to open a stream. + + + This interface is used to define a symbol, normally got from symbol +queries. A symbol has various fields that can be retrieved by using +their get methods. A symbol will have only those fields which have +been selected to be included in their respective queries, so make sure +the needed fields are correctly specified during query creation. + + + A query object will have this interface that allows to tweak various +query parameters. Except for the #IAnjutaSymbolQueryName and +#IAnjutaSymbolQueryDb parameters, everything else is changable +post-creation. + +Note that chaning a query parameter, except for limit and offset will +result in re-preparing the query the next time it is executed, so it is +not advisable to change it each time the query is executed. For such +cases, create different queries with different parameters. + +A query is signified by a name enumeration (#IAnjutaSymbolQueryName) which +practically determines the query type and its execution condition. Each +query name is assigned to pre-defined query statement and can only be +set during creation time. Then only its specific ianjuta_symbol_query_search_*() +can be used to execute the query. These specific execution methods are +provided to make it convenient to pass query parameters easily and to +ensure all the needed parameters are given. + +A query can run in different modes, defined by #IAnjutaSymbolQueryMode, by +default it is executed in synchrounous mode #IANJUTA_SYMBOL_QUERY_MODE_SYNC +and can be changed using ianjuta_symbol_query_set_mode(). +#IANJUTA_SYMBOL_QUERY_MODE_ASYNC runs it in asynchronous mode in a separate +thread and can be canceled with ianjuta_symbol_query_cancel(). + +A query runs on a database, defined by #IAnjutaSymbolQueryDb, and can be +only selected at creatation time. + +In addition, there are many other filters that can be set to the query +to refine the query results. For example, ianjuta_symbol_query_set_fields() +is used to set the needed symbol fields to retrieve, ianjuta_symbol_query_set_filters() +is used to filter the results with symbol types, ianjuta_symbol_query_set_file_scope() +limits the results to either public or private scope within the source file, +ianjuta_symbol_query_set_group_by() is used to group the results on a given +field, ianjuta_symbol_query_set_order_by is used to order the results on a +given field. + +ianjuta_symbol_query_set_limit() and ianjuta_symbol_query_set_offset() are +used to change limit and offset of the resultset. Note again that these +parameters do not require re-preparation of query, so can be safely used +any time without performance hit. + diff --git a/girs/IMSettings-1.8.gir b/girs/IMSettings-1.8.gir index d929eaa63..8cf1645e4 100644 --- a/girs/IMSettings-1.8.gir +++ b/girs/IMSettings-1.8.gir @@ -51,19 +51,19 @@ and/or use gtk-doc annotations. --> Creates an instance of #IMSettingsClient. + line="275">Creates an instance of #IMSettingsClient. a #IMSettingsClient. + line="282">a #IMSettingsClient. a locale to obtain information for or to give it for Input Method. + line="277">a locale to obtain information for or to give it for Input Method. or %NULL if you want to pass current locale. @@ -74,7 +74,7 @@ and/or use gtk-doc annotations. --> throws="1"> Check if X Display can be open or not. + line="1588">Check if X Display can be open or not. You could access through DBus API instead: @@ -89,14 +89,14 @@ You could access through DBus API instead: if supported, returns %TRUE otherwise %FALSE. + line="1606">if supported, returns %TRUE otherwise %FALSE. a #IMSettingsClient. + line="1590">a #IMSettingsClient. a #GCancellable or %NULL. + line="1591">a #GCancellable or %NULL. @@ -115,13 +115,13 @@ You could access through DBus API instead: throws="1"> Obtains the result of the request from + line="1665">Obtains the result of the request from imsettings_client_can_x_display_open_start(). if the operation is successfully done, returns %TRUE + line="1674">if the operation is successfully done, returns %TRUE otherwise %FALSE @@ -129,13 +129,13 @@ imsettings_client_can_x_display_open_start(). a #IMSettingsClient. + line="1667">a #IMSettingsClient. a #GAsyncResult pushed through #GAsyncReadyCallback. + line="1668">a #GAsyncResult pushed through #GAsyncReadyCallback. @@ -144,7 +144,7 @@ imsettings_client_can_x_display_open_start(). c:identifier="imsettings_client_can_x_display_open_start"> Request asking if current desktop is supported or not asynchronously + line="1635">Request asking if current desktop is supported or not asynchronously @@ -153,7 +153,7 @@ imsettings_client_can_x_display_open_start(). a #IMSettingsClient. + line="1637">a #IMSettingsClient. allow-none="1"> a #GCancellable or %NULL. + line="1638">a #GCancellable or %NULL. closure="2"> a #GAsyncReadyCallback. + line="1639">a #GAsyncReadyCallback. allow-none="1"> a pointer of the user data to give it to @callback. + line="1640">a pointer of the user data to give it to @callback. @@ -192,7 +192,7 @@ imsettings_client_can_x_display_open_start(). throws="1"> Obtains the Input Method information that is currently running on. + line="1088">Obtains the Input Method information that is currently running on. You could access through DBus API instead: @@ -207,14 +207,14 @@ You could access through DBus API instead: a #IMSettingsInfo for active Input Method. if not, %NULL then. + line="1106">a #IMSettingsInfo for active Input Method. if not, %NULL then. a #IMSettingsClient. + line="1090">a #IMSettingsClient. a #GCancellable or %NULL. + line="1091">a #GCancellable or %NULL. @@ -233,12 +233,12 @@ You could access through DBus API instead: glib:get-property="desktop"> Obtains current desktop information in @client. + line="382">Obtains current desktop information in @client. a reference to the desktop name in @client. it shouldn't be freed + line="388">a reference to the desktop name in @client. it shouldn't be freed in applications. @@ -246,7 +246,7 @@ You could access through DBus API instead: a #IMSettingsClient. + line="384">a #IMSettingsClient. @@ -256,26 +256,26 @@ You could access through DBus API instead: throws="1"> A convenient function to get #IMSettingsInfo from the result of + line="566">A convenient function to get #IMSettingsInfo from the result of imsettings_client_get_info_variant(). a #IMSettingsInfo or %NULL. + line="576">a #IMSettingsInfo or %NULL. a #IMSettingsClient. + line="568">a #IMSettingsClient. an Input Method name to obtain the information. + line="569">an Input Method name to obtain the information. allow-none="1"> a #GCancellable or %NULL. + line="570">a #GCancellable or %NULL. @@ -294,7 +294,7 @@ imsettings_client_get_info_variant(). throws="1"> Obtains the information for the specific Input Method in @module. + line="596">Obtains the information for the specific Input Method in @module. You could access through DBus API instead: @@ -311,7 +311,7 @@ You could access through DBus API instead: a #GVariant that can converts to #IMSettingsInfo through + line="617">a #GVariant that can converts to #IMSettingsInfo through imsettings_info_new(). otherwise %NULL. @@ -319,13 +319,13 @@ You could access through DBus API instead: a #IMSettingsClient. + line="598">a #IMSettingsClient. an Input Method name to obtain the information. + line="599">an Input Method name to obtain the information. a #GCancellable or %NULL. + line="600">a #GCancellable or %NULL. @@ -344,13 +344,13 @@ You could access through DBus API instead: throws="1"> Obtains the result of the request from + line="692">Obtains the result of the request from imsettings_client_get_info_variant_start(). a #GVariant that can converts to #IMSettingsInfo through + line="701">a #GVariant that can converts to #IMSettingsInfo through imsettings_info_new(). otherwise %NULL. @@ -358,13 +358,13 @@ imsettings_client_get_info_variant_start(). a #IMSettingsClient. + line="694">a #IMSettingsClient. a #GAsyncResult pushed through #GAsyncReadyCallback. + line="695">a #GAsyncResult pushed through #GAsyncReadyCallback. @@ -373,7 +373,7 @@ imsettings_client_get_info_variant_start(). c:identifier="imsettings_client_get_info_variant_start"> Request obtaining asynchronously the Input Method information for @module. + line="658">Request obtaining asynchronously the Input Method information for @module. @@ -382,13 +382,13 @@ imsettings_client_get_info_variant_start(). a #IMSettingsClient. + line="660">a #IMSettingsClient. an Input Method name to obtain the information. + line="661">an Input Method name to obtain the information. allow-none="1"> a #GCancellable or %NULL. + line="662">a #GCancellable or %NULL. closure="3"> a #GAsyncReadyCallback. + line="663">a #GAsyncReadyCallback. allow-none="1"> a pointer of the user data to give it to @callback. + line="664">a pointer of the user data to give it to @callback. @@ -427,7 +427,7 @@ imsettings_client_get_info_variant_start(). throws="1"> Obtains all of the Input Method information available on the system. + line="454">Obtains all of the Input Method information available on the system. You could access through DBus API instead: @@ -443,7 +443,7 @@ You could access through DBus API instead: a #GVariant contains some pairs of an Input Method name and + line="473">a #GVariant contains some pairs of an Input Method name and a #GVariant that can converts to #IMSettingsInfo through imsettings_info_new(). otherwise %NULL. @@ -452,7 +452,7 @@ You could access through DBus API instead: a #IMSettingsClient. + line="456">a #IMSettingsClient. a #GCancellable or %NULL. + line="457">a #GCancellable or %NULL. @@ -471,13 +471,13 @@ You could access through DBus API instead: throws="1"> Obtains the result of the request from + line="545">Obtains the result of the request from imsettings_client_get_info_variants_start(). a #GVariant contains some pairs of an Input Method name and + line="554">a #GVariant contains some pairs of an Input Method name and a #GVariant that can converts to #IMSettingsInfo through imsettings_info_new(). otherwise %NULL. @@ -486,13 +486,13 @@ imsettings_client_get_info_variants_start(). a #IMSettingsClient. + line="547">a #IMSettingsClient. a #GAsyncResult pushed through #GAsyncReadyCallback. + line="548">a #GAsyncResult pushed through #GAsyncReadyCallback. @@ -501,7 +501,7 @@ imsettings_client_get_info_variants_start(). c:identifier="imsettings_client_get_info_variants_start"> Request obtaining asynchronously all of the Input Method information + line="513">Request obtaining asynchronously all of the Input Method information available on the system. @@ -511,7 +511,7 @@ available on the system. a #IMSettingsClient. + line="515">a #IMSettingsClient. allow-none="1"> a #GCancellable or %NULL. + line="516">a #GCancellable or %NULL. closure="2"> a #GAsyncReadyCallback. + line="517">a #GAsyncReadyCallback. allow-none="1"> a pointer of the user data to give it to @callback. + line="518">a pointer of the user data to give it to @callback. @@ -550,12 +550,12 @@ available on the system. glib:get-property="locale"> Obtains current locale information in @client. + line="332">Obtains current locale information in @client. a reference to the locale string in @client. it shouldn't be freed + line="338">a reference to the locale string in @client. it shouldn't be freed in applications. @@ -563,7 +563,7 @@ available on the system. a #IMSettingsClient. + line="334">a #IMSettingsClient. @@ -573,7 +573,7 @@ available on the system. throws="1"> Obtains current Input Method settings in the backend modules. + line="1388">Obtains current Input Method settings in the backend modules. You could access through DBus API instead: @@ -588,7 +588,7 @@ You could access through DBus API instead: a #GVariant that contains some pairs of the module name and + line="1406">a #GVariant that contains some pairs of the module name and the Input Method name. @@ -596,7 +596,7 @@ You could access through DBus API instead: a #IMSettingsClient. + line="1390">a #IMSettingsClient. a #GCancellable or %NULL. + line="1391">a #GCancellable or %NULL. @@ -615,7 +615,7 @@ You could access through DBus API instead: throws="1"> Obtains an Input Method name that currently is active for the system-wide. + line="825">Obtains an Input Method name that currently is active for the system-wide. You could access through DBus API instead: @@ -633,14 +633,14 @@ You could access through DBus API instead: an Input Method name or %NULL. + line="846">an Input Method name or %NULL. a #IMSettingsClient. + line="827">a #IMSettingsClient. a #GCancellable or %NULL. + line="828">a #GCancellable or %NULL. @@ -659,26 +659,26 @@ You could access through DBus API instead: throws="1"> Obtains the result of the request from + line="908">Obtains the result of the request from imsettings_client_get_system_im_start(). an Input Method name or %NULL. + line="917">an Input Method name or %NULL. a #IMSettingsClient. + line="910">a #IMSettingsClient. a #GAsyncResult pushed through #GAsyncReadyCallback. + line="911">a #GAsyncResult pushed through #GAsyncReadyCallback. @@ -687,7 +687,7 @@ imsettings_client_get_system_im_start(). c:identifier="imsettings_client_get_system_im_start"> Request obtaining asynchronously an input method name that currently is + line="876">Request obtaining asynchronously an input method name that currently is active for the system-wide. @@ -697,7 +697,7 @@ active for the system-wide. a #IMSettingsClient. + line="878">a #IMSettingsClient. allow-none="1"> a #GCancellable or %NULL. + line="879">a #GCancellable or %NULL. closure="2"> a #GAsyncReadyCallback. + line="880">a #GAsyncReadyCallback. allow-none="1"> a pointer of the user data to give it to @callback. + line="881">a pointer of the user data to give it to @callback. @@ -736,7 +736,7 @@ active for the system-wide. throws="1"> Obtains an Input Method name that currently is active for the user. + line="712">Obtains an Input Method name that currently is active for the user. If one doesn't have the user xinputrc on their home, this simply returns the same value to what imsettings_client_get_system_im() returns. @@ -756,14 +756,14 @@ You could access through DBus API instead: an Input Method name or %NULL. + line="735">an Input Method name or %NULL. a #IMSettingsClient. + line="714">a #IMSettingsClient. a #GCancellable or %NULL. + line="715">a #GCancellable or %NULL. @@ -782,26 +782,26 @@ You could access through DBus API instead: throws="1"> Obtains the result of the request from + line="806">Obtains the result of the request from imsettings_client_get_user_im_start(). an Input Method name or %NULL. + line="815">an Input Method name or %NULL. a #IMSettingsClient. + line="808">a #IMSettingsClient. a #GAsyncResult pushed through #GAsyncReadyCallback. + line="809">a #GAsyncResult pushed through #GAsyncReadyCallback. @@ -810,7 +810,7 @@ imsettings_client_get_user_im_start(). c:identifier="imsettings_client_get_user_im_start"> Request obtaining asynchronously an input method name that currently is + line="774">Request obtaining asynchronously an input method name that currently is active for the user. @@ -820,7 +820,7 @@ active for the user. a #IMSettingsClient. + line="776">a #IMSettingsClient. allow-none="1"> a #GCancellable or %NULL. + line="777">a #GCancellable or %NULL. closure="2"> a #GAsyncReadyCallback. + line="778">a #GAsyncReadyCallback. allow-none="1"> a pointer of the user data to give it to @callback. + line="779">a pointer of the user data to give it to @callback. @@ -859,7 +859,7 @@ active for the user. throws="1"> Obtains the version information of imsettings-daemon running. + line="403">Obtains the version information of imsettings-daemon running. This is expected to invoke at first if the return value is same to %IMSETTINGS_SETTINGS_API_VERSION. otherwise it may not works as expected due to the changes of the implementation between imsettings-daemon and @@ -878,14 +878,14 @@ You could access through DBus API instead: a version number. + line="425">a version number. a #IMSettingsClient. + line="405">a #IMSettingsClient. a #GCancellable or %NULL. + line="406">a #GCancellable or %NULL. @@ -904,7 +904,7 @@ You could access through DBus API instead: throws="1"> Checks whether @module is the system default or not. + line="1136">Checks whether @module is the system default or not. You could access through DBus API instead: @@ -921,20 +921,20 @@ You could access through DBus API instead: %TRUE if it is, otherwise %FALSE. + line="1157">%TRUE if it is, otherwise %FALSE. a #IMSettingsClient. + line="1138">a #IMSettingsClient. an Input Method name to ask. + line="1139">an Input Method name to ask. a #GCancellable or %NULL. + line="1140">a #GCancellable or %NULL. @@ -953,7 +953,7 @@ You could access through DBus API instead: throws="1"> Checks whether @module is the user default or not. + line="1190">Checks whether @module is the user default or not. You could access through DBus API instead: @@ -970,20 +970,20 @@ You could access through DBus API instead: %TRUE if it is, otherwise %FALSE. + line="1211">%TRUE if it is, otherwise %FALSE. a #IMSettingsClient. + line="1192">a #IMSettingsClient. an Input Method name to ask. + line="1193">an Input Method name to ask. a #GCancellable or %NULL. + line="1194">a #GCancellable or %NULL. @@ -1002,7 +1002,7 @@ You could access through DBus API instead: throws="1"> Checks whether @module is the Input Method for XIM only or not. + line="1244">Checks whether @module is the Input Method for XIM only or not. You could access through DBus API instead: @@ -1019,20 +1019,20 @@ You could access through DBus API instead: %TRUE if it is, otherwise %FALSE. + line="1265">%TRUE if it is, otherwise %FALSE. a #IMSettingsClient. + line="1246">a #IMSettingsClient. an Input Method name to ask. + line="1247">an Input Method name to ask. a #GCancellable or %NULL. + line="1248">a #GCancellable or %NULL. @@ -1051,7 +1051,7 @@ You could access through DBus API instead: throws="1"> Check if IMSettings is supposed to be taken any acttions. + line="1685">Check if IMSettings is supposed to be taken any acttions. You could access through DBus API instead: @@ -1069,14 +1069,14 @@ You could access through DBus API instead: if any actions needed, returns %TRUE otherwise %FALSE. + line="1706">if any actions needed, returns %TRUE otherwise %FALSE. a #IMSettingsClient. + line="1687">a #IMSettingsClient. @@ -1088,7 +1088,7 @@ You could access through DBus API instead: allow-none="1"> a #GCancellable or %NULL. + line="1688">a #GCancellable or %NULL. @@ -1098,13 +1098,13 @@ You could access through DBus API instead: throws="1"> Obtains the result of the request from + line="1777">Obtains the result of the request from imsettings_client_is_action_needed_start(). if the operation is successfully done, returns %TRUE + line="1786">if the operation is successfully done, returns %TRUE otherwise %FALSE @@ -1112,13 +1112,13 @@ imsettings_client_is_action_needed_start(). a #IMSettingsClient. + line="1779">a #IMSettingsClient. a #GAsyncResult pushed through #GAsyncReadyCallback. + line="1780">a #GAsyncResult pushed through #GAsyncReadyCallback. @@ -1127,7 +1127,7 @@ imsettings_client_is_action_needed_start(). c:identifier="imsettings_client_is_action_needed_start"> Request asking if IMSettings is supposed to be taken any actions + line="1742">Request asking if IMSettings is supposed to be taken any actions @@ -1136,7 +1136,7 @@ imsettings_client_is_action_needed_start(). a #IMSettingsClient. + line="1744">a #IMSettingsClient. @@ -1148,7 +1148,7 @@ imsettings_client_is_action_needed_start(). allow-none="1"> a #GCancellable or %NULL. + line="1745">a #GCancellable or %NULL. closure="3"> a #GAsyncReadyCallback. + line="1746">a #GAsyncReadyCallback. allow-none="1"> a pointer of the user data to give it to @callback. + line="1747">a pointer of the user data to give it to @callback. @@ -1178,7 +1178,7 @@ imsettings_client_is_action_needed_start(). throws="1"> Check if current desktop is supported by IMSettings or not. + line="1485">Check if current desktop is supported by IMSettings or not. You could access through DBus API instead: @@ -1194,14 +1194,14 @@ You could access through DBus API instead: if supported, returns %TRUE otherwise %FALSE. + line="1504">if supported, returns %TRUE otherwise %FALSE. a #IMSettingsClient. + line="1487">a #IMSettingsClient. a #GCancellable or %NULL. + line="1488">a #GCancellable or %NULL. @@ -1220,13 +1220,13 @@ You could access through DBus API instead: throws="1"> Obtains the result of the request from + line="1568">Obtains the result of the request from imsettings_client_is_supported_desktop_start(). if the operation is successfully done, returns %TRUE + line="1577">if the operation is successfully done, returns %TRUE otherwise %FALSE @@ -1234,13 +1234,13 @@ imsettings_client_is_supported_desktop_start(). a #IMSettingsClient. + line="1570">a #IMSettingsClient. a #GAsyncResult pushed through #GAsyncReadyCallback. + line="1571">a #GAsyncResult pushed through #GAsyncReadyCallback. @@ -1249,7 +1249,7 @@ imsettings_client_is_supported_desktop_start(). c:identifier="imsettings_client_is_supported_desktop_start"> Request asking if current desktop is supported or not asynchronously + line="1536">Request asking if current desktop is supported or not asynchronously @@ -1258,7 +1258,7 @@ imsettings_client_is_supported_desktop_start(). a #IMSettingsClient. + line="1538">a #IMSettingsClient. allow-none="1"> a #GCancellable or %NULL. + line="1539">a #GCancellable or %NULL. closure="2"> a #GAsyncReadyCallback. + line="1540">a #GAsyncReadyCallback. allow-none="1"> a pointer of the user data to give it to @callback. + line="1541">a pointer of the user data to give it to @callback. @@ -1295,19 +1295,19 @@ imsettings_client_is_supported_desktop_start(). Check whether the process is running. + line="1444">Check whether the process is running. %TRUE if imsettings-daemon is running. otherwise %FALSE. + line="1450">%TRUE if imsettings-daemon is running. otherwise %FALSE. a #IMSettingsClient. + line="1446">a #IMSettingsClient. @@ -1315,7 +1315,7 @@ imsettings_client_is_supported_desktop_start(). Reloads imsettings-daemon. + line="1298">Reloads imsettings-daemon. Note that @send_signal option is for the backward compatibility. imsettings-daemon doesn't do anything since %IMSETTINGS_SETTINGS_API_VERSION @@ -1345,20 +1345,20 @@ You could access through DBus API instead: %TRUE if the operation is successfully done, otherwise %FALSE. + line="1332">%TRUE if the operation is successfully done, otherwise %FALSE. a #IMSettingsClient. + line="1300">a #IMSettingsClient. %TRUE to send a signal instead of invoking a method. + line="1301">%TRUE to send a signal instead of invoking a method. a #GCancellable or %NULL. + line="1302">a #GCancellable or %NULL. @@ -1377,26 +1377,26 @@ You could access through DBus API instead: glib:set-property="desktop"> Update the desktop name in @client to @desktop. if @desktop is %NULL, + line="355">Update the desktop name in @client to @desktop. if @desktop is %NULL, the desktop detection will be done in the server side. %TRUE if successfully updated, otherwise %FALSE. + line="363">%TRUE if successfully updated, otherwise %FALSE. a #IMSettingsClient. + line="357">a #IMSettingsClient. a current desktop name going to operate. + line="358">a current desktop name going to operate. @@ -1406,25 +1406,25 @@ the desktop detection will be done in the server side. glib:set-property="locale"> Update the locale information in @client with @locale. + line="294">Update the locale information in @client with @locale. %TRUE if successfully updated, otherwise %FALSE. + line="302">%TRUE if successfully updated, otherwise %FALSE. a #IMSettingsClient. + line="296">a #IMSettingsClient. a locale to obtain information for or to give it for Input Method. + line="297">a locale to obtain information for or to give it for Input Method. or %NULL if you want to pass current locale. @@ -1435,7 +1435,7 @@ the desktop detection will be done in the server side. throws="1"> Changes the Input Method to @module. + line="927">Changes the Input Method to @module. You could access through DBus API instead: @@ -1453,7 +1453,7 @@ You could access through DBus API instead: if the operation is successfully done, returns %TRUE + line="951">if the operation is successfully done, returns %TRUE otherwise %FALSE. @@ -1461,20 +1461,20 @@ You could access through DBus API instead: a #IMSettingsClient. + line="929">a #IMSettingsClient. an Input Method name changing to, or %NULL to disable + line="930">an Input Method name changing to, or %NULL to disable the Input Method. %TRUE to update the user xinputrc, otherwise %FALSE. + line="932">%TRUE to update the user xinputrc, otherwise %FALSE. a #GCancellable or %NULL. + line="933">a #GCancellable or %NULL. @@ -1493,13 +1493,13 @@ You could access through DBus API instead: throws="1"> Obtains the result of the request from + line="1068">Obtains the result of the request from imsettings_client_switch_im_start(). if the operation is successfully done, returns %TRUE + line="1077">if the operation is successfully done, returns %TRUE otherwise %FALSE. @@ -1507,13 +1507,13 @@ imsettings_client_switch_im_start(). a #IMSettingsClient. + line="1070">a #IMSettingsClient. a #GAsyncResult pushed through #GAsyncReadyCallback. + line="1071">a #GAsyncResult pushed through #GAsyncReadyCallback. @@ -1522,7 +1522,7 @@ imsettings_client_switch_im_start(). c:identifier="imsettings_client_switch_im_start"> Request changing asynchronously the Input Method to @module. + line="1008">Request changing asynchronously the Input Method to @module. @@ -1531,20 +1531,20 @@ imsettings_client_switch_im_start(). a #IMSettingsClient. + line="1010">a #IMSettingsClient. an Input Method name changing to, or %NULL to disable + line="1011">an Input Method name changing to, or %NULL to disable the Input Method. %TRUE to update the user xinputrc, otherwise %FALSE. + line="1013">%TRUE to update the user xinputrc, otherwise %FALSE. allow-none="1"> a #GCancellable or %NULL. + line="1014">a #GCancellable or %NULL. closure="4"> a #GAsyncReadyCallback. + line="1015">a #GAsyncReadyCallback. allow-none="1"> a pointer of the user data to give it to @callback. + line="1016">a pointer of the user data to give it to @callback. diff --git a/girs/JavaScriptCore-4.0.gir b/girs/JavaScriptCore-4.0.gir index ecc794f67..df34a2f0b 100644 --- a/girs/JavaScriptCore-4.0.gir +++ b/girs/JavaScriptCore-4.0.gir @@ -2615,7 +2615,7 @@ against at application run time. line="38"/> - + Like jsc_get_micro_version(), but from the headers used at diff --git a/girs/JavaScriptCore-4.1.gir b/girs/JavaScriptCore-4.1.gir index b44500e42..8f0437e2f 100644 --- a/girs/JavaScriptCore-4.1.gir +++ b/girs/JavaScriptCore-4.1.gir @@ -2615,7 +2615,7 @@ against at application run time. line="38"/> - + Like jsc_get_micro_version(), but from the headers used at diff --git a/girs/JavaScriptCore-6.0.gir b/girs/JavaScriptCore-6.0.gir index 3a9506a76..e1ef00d43 100644 --- a/girs/JavaScriptCore-6.0.gir +++ b/girs/JavaScriptCore-6.0.gir @@ -2366,7 +2366,7 @@ against at application run time. line="38"/> - + Like jsc_get_micro_version(), but from the headers used at diff --git a/girs/Jsonrpc-1.0.gir b/girs/Jsonrpc-1.0.gir index d69146c94..ff9a275d1 100644 --- a/girs/Jsonrpc-1.0.gir +++ b/girs/Jsonrpc-1.0.gir @@ -1551,7 +1551,7 @@ trip. - + jsonrpc-glib micro version component (e.g. 3 if %JSONRPC_VERSION is 1.2.3) @@ -2434,7 +2434,7 @@ failure), using [method@Client.reply] or [method@Client.reply_async]. - + jsonrpc-glib version, encoded as a string, useful for printing and diff --git a/girs/Libosinfo-1.0.gir b/girs/Libosinfo-1.0.gir index 980192b1d..0399407a6 100644 --- a/girs/Libosinfo-1.0.gir +++ b/girs/Libosinfo-1.0.gir @@ -19,31 +19,31 @@ and/or use gtk-doc annotations. --> - + - + - + - + - + glib:type-name="OsinfoAvatarFormat" glib:get-type="osinfo_avatar_format_get_type" glib:type-struct="AvatarFormatClass"> - + Construct a new user avatar file for an #OsinfoInstallScript. - + the necessary information to create an avatar for an user @@ -74,18 +73,17 @@ and/or use gtk-doc annotations. --> c:identifier="osinfo_avatar_format_get_alpha" glib:get-property="alpha" version="0.2.2"> - + Whether alpha channel is supported in the avatar. the avatar info @@ -95,18 +93,17 @@ and/or use gtk-doc annotations. --> c:identifier="osinfo_avatar_format_get_height" glib:get-property="height" version="0.2.2"> - + the required height (in pixels) of the avatar, or -1. the avatar info @@ -116,11 +113,10 @@ and/or use gtk-doc annotations. --> c:identifier="osinfo_avatar_format_get_mime_types" glib:get-property="mime-types" version="0.2.2"> - + the required mime-types of the avatar. @@ -129,7 +125,7 @@ and/or use gtk-doc annotations. --> the avatar info @@ -139,32 +135,37 @@ and/or use gtk-doc annotations. --> c:identifier="osinfo_avatar_format_get_width" glib:get-property="width" version="0.2.2"> - + the required width (in pixels) of the avatar, or -1. the avatar info - + Whether alpha channel is supported in the avatar. - + The required height (in pixels) of the avatar. @@ -172,15 +173,18 @@ and/or use gtk-doc annotations. --> transfer-ownership="container" getter="get_mime_types"> The allowed mime-types for the avatar. - + The required width (in pixels) of the avatar. @@ -194,20 +198,21 @@ and/or use gtk-doc annotations. --> - + - + disguised="1" + opaque="1"> + - + @@ -224,7 +229,7 @@ and/or use gtk-doc annotations. --> - + @@ -241,7 +246,7 @@ and/or use gtk-doc annotations. --> - + @@ -258,109 +263,109 @@ and/or use gtk-doc annotations. --> - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + glib:type-name="OsinfoDatamap" glib:get-type="osinfo_datamap_get_type" glib:type-struct="DatamapClass"> - + Construct a new datamapa that is initially empty. - + an empty datamap the unique identifier @@ -397,29 +402,29 @@ and/or use gtk-doc annotations. --> c:identifier="osinfo_datamap_insert" version="0.2.3"> Adds the input value and the output value associated to it to the @map. - + the OS datamap the input value the output value @@ -429,22 +434,22 @@ the @map. c:identifier="osinfo_datamap_lookup" version="0.2.3"> Returns the output value with which @inval is associated to. - + the OS datamap the input value @@ -454,22 +459,22 @@ the @map. c:identifier="osinfo_datamap_reverse_lookup" version="0.2.3"> Returns the input value with which @outval is associated to. - + the OS datamap the output value @@ -485,7 +490,7 @@ the @map. - + @@ -497,17 +502,17 @@ the @map. glib:type-name="OsinfoDatamapList" glib:get-type="osinfo_datamaplist_get_type" glib:type-struct="DatamapListClass"> - + Construct a new install_datamap list that is initially empty. - + an empty install_datamap list @@ -522,18 +527,22 @@ the @map. - + - + disguised="1" + opaque="1"> + - - + + glib:type-name="OsinfoDb" glib:get-type="osinfo_db_get_type" glib:type-struct="DbClass"> - + - + the new database @@ -555,60 +564,60 @@ the @map. - + the database an install datamap - + the database a deployment - + the database a device @@ -617,60 +626,60 @@ the @map. - + the database an install script - + the database an operating system - + the database an platform @@ -678,31 +687,31 @@ the @map. Find the deployment for @os on @platform, if any. - + the deployment, or NULL the database the operating system to find the virtualization platform @@ -711,23 +720,23 @@ the @map. - + the install datamap, or NULL if none is found the database the unique operating system identifier @@ -736,40 +745,40 @@ the @map. - + the list of install datamaps the database - + the operating system, or NULL if none is found the database the unique operating system identifier @@ -777,57 +786,57 @@ the @map. - + the list of deployments the database - + the device, or NULL if none is found the database the unique device identifier - + the list of devices the database @@ -836,23 +845,23 @@ the @map. - + the install script, or NULL if none is found the database the unique operating system identifier @@ -861,80 +870,80 @@ the @map. - + the list of install scripts the database - + the operating system, or NULL if none is found the database the unique operating system identifier - + the list of operating systems the database - + the platform, or NULL if none is found the database the unique platform identifier @@ -942,17 +951,17 @@ the @map. - + the list of platforms the database @@ -963,26 +972,26 @@ the @map. deprecated="1" deprecated-version="0.2.3"> Guess operating system given an #OsinfoMedia object. Use osinfo_db_identify_media() instead. - + the operating system, or NULL if guessing failed the database the installation media @@ -993,7 +1002,7 @@ the @map. optional="1" allow-none="1"> the matched operating system media @@ -1005,26 +1014,26 @@ system media deprecated="1" deprecated-version="1.6.0"> Guess operating system given an #OsinfoTree object. Use osinfo_db_identify_tree() instead. - + the operating system, or NULL if guessing failed the database the installation tree @@ -1035,7 +1044,7 @@ system media optional="1" allow-none="1"> the matched operating system tree @@ -1046,7 +1055,7 @@ system tree c:identifier="osinfo_db_identify_media" version="0.2.3"> Try to match a newly created @media with a media description from @db. If found, @media will be filled with the corresponding information stored in @db. In particular, after a call to osinfo_db_identify_media(), if @@ -1059,23 +1068,23 @@ in which matches are identified is not guaranteed, so when there are multiple matches, the returned match may vary over time. Applications are recommended to use the #osinfo_db_identify_all_media method instead to receive all matched media. - + TRUE if @media was found in @db, FALSE otherwise an #OsinfoDb database the installation media data @@ -1086,30 +1095,30 @@ data c:identifier="osinfo_db_identify_medialist" version="1.10.0"> Try to match a newly created @media with a media description from @db. The return list will contain any #OsinfoMedia instances from @db that matched @media. Usuaully there will only be one match returned, but applications should be prepared to deal with multiple matches. The returned #OsinfoMedia instances will have their OsinfoEntify::id and OsinfoMedia::os properties will be set, while @media is left unmodified. - + a list containing any matches for @media found in @db an #OsinfoDb database the installation media data @@ -1119,7 +1128,7 @@ OsinfoMedia::os properties will be set, while @media is left unmodified. c:identifier="osinfo_db_identify_tree" version="1.6.0"> Try to match a newly created @tree with a tree description from @db. If found, @tree will be filled with the corresponding information stored in @db. In particular, after a call to osinfo_db_identify_tree(), if @@ -1132,23 +1141,23 @@ in which matches are identified is not guaranteed, so when there are multiple matches, the returned match may vary over time. Applications are recommended to use the #osinfo_db_identify_all_tree method instead to receive all matched tree. - + TRUE if @tree was found in @db, FALSE otherwise an #OsinfoDb database the installation tree data @@ -1159,30 +1168,30 @@ data c:identifier="osinfo_db_identify_treelist" version="1.10.0"> Try to match a newly created @tree with a tree description from @db. The return list will contain any #OsinfoTree instances from @db that matched @tree. Usuaully there will only be one match returned, but applications should be prepared to deal with multiple matches. The returned #OsinfoTree instances will have their OsinfoEntify::id and OsinfoTree::os properties will be set, while @tree is left unmodified. - + a list containing any matches for @tree found in @db an #OsinfoDb database the installation tree data @@ -1191,26 +1200,26 @@ OsinfoTree::os properties will be set, while @tree is left unmodified. Get all operating systems that are the referee in an operating system relationship. - + a list of operating systems the database the product relationship @@ -1220,26 +1229,26 @@ in an operating system relationship. Get all platforms that are the referee in an platform relationship. - + a list of virtualization platforms the database the product relationship @@ -1249,13 +1258,13 @@ in an platform relationship. Get all unique values for a named property amongst all deployments in the database - + a list of strings @@ -1264,13 +1273,13 @@ deployments in the database the database a property name @@ -1279,13 +1288,13 @@ deployments in the database Get all unique values for a named property amongst all devices in the database - + a list of strings @@ -1294,13 +1303,13 @@ devices in the database the database a property name @@ -1309,13 +1318,13 @@ devices in the database Get all unique values for a named property amongst all operating systems in the database - + a list of strings @@ -1324,13 +1333,13 @@ operating systems in the database the database a property name @@ -1339,13 +1348,13 @@ operating systems in the database Get all unique values for a named property amongst all platforms in the database - + a list of strings @@ -1354,13 +1363,13 @@ platforms in the database the database a property name @@ -1376,13 +1385,13 @@ platforms in the database - + - - + + glib:type-name="OsinfoDeployment" glib:get-type="osinfo_deployment_get_type" glib:type-struct="DeploymentClass"> - + Create a new deployment entity - + A deployment entity the unique identifier the operating system to deploy the platform to deploy on @@ -1426,26 +1435,26 @@ platforms in the database Associate a device with a deployment. The returned #OsinfoDeviceLink can be used to record extra metadata against the link - + the device association a deployment entity the device to associate @@ -1454,20 +1463,20 @@ can be used to record extra metadata against the link Retrieve all the associated devices matching the filter. The filter matches against the link, not the device. - + a list of #OsinfoDevice entities a deployment entity @@ -1476,7 +1485,7 @@ The filter matches against the link, not the device. nullable="1" allow-none="1"> an optional filter @@ -1484,20 +1493,20 @@ The filter matches against the link, not the device. Retrieve all the associated devices matching the filter. The filter matches against the device, not the link. - + a list of #OsinfoDevice entities a deployment entity @@ -1506,7 +1515,7 @@ The filter matches against the device, not the link. nullable="1" allow-none="1"> an optional filter @@ -1516,19 +1525,19 @@ The filter matches against the device, not the link. c:identifier="osinfo_deployment_get_os" glib:get-property="os"> Get the operating system for the deployment - + an OS, or NULL the deployment entity @@ -1538,19 +1547,19 @@ The filter matches against the device, not the link. c:identifier="osinfo_deployment_get_platform" glib:get-property="platform"> Get the platform for the deployment - + a platform, or NULL the deployment entity @@ -1559,19 +1568,19 @@ The filter matches against the device, not the link. Get the preferred device matching a given filter - + a device, or NULL the deployment entity @@ -1580,7 +1589,7 @@ The filter matches against the device, not the link. nullable="1" allow-none="1"> a device metadata filter @@ -1589,20 +1598,20 @@ The filter matches against the device, not the link. Get the preferred device link matching a given filter and platform. The filter matches against attributes on the link, not the device. - + a device, or NULL the deployment entity @@ -1611,7 +1620,7 @@ The filter matches against attributes on the link, not the device. nullable="1" allow-none="1"> a device metadata filter @@ -1623,7 +1632,7 @@ The filter matches against attributes on the link, not the device. transfer-ownership="none" getter="get_os"> The operating system to be deployed @@ -1633,7 +1642,7 @@ The filter matches against attributes on the link, not the device. transfer-ownership="none" getter="get_platform"> The platform to deploy on @@ -1647,7 +1656,7 @@ The filter matches against attributes on the link, not the device. - + @@ -1659,16 +1668,15 @@ The filter matches against attributes on the link, not the device. glib:type-name="OsinfoDeploymentList" glib:get-type="osinfo_deploymentlist_get_type" glib:type-struct="DeploymentListClass"> - + Construct a new deployment list that is initially empty. - + an empty deployment list @@ -1678,22 +1686,21 @@ The filter matches against attributes on the link, not the device. deprecated="1" deprecated-version="0.2.2"> Construct a new deployment list that is filled with deployments from @source Use osinfo_list_new_copy() instead. - + a copy of the deployment list the deployment list to copy @@ -1704,28 +1711,27 @@ from @source deprecated="1" deprecated-version="0.2.2"> Construct a new deployment list that is filled with deployments from @source that match @filter Use osinfo_list_new_filtered() instead. - + a filtered copy of the deployment list the deployment list to copy the filter to apply @@ -1736,28 +1742,27 @@ from @source that match @filter deprecated="1" deprecated-version="0.2.2"> Construct a new deployment list that is filled with only the deployments that are present in both @sourceOne and @sourceTwo. Use osinfo_list_new_intersection() instead. - + an intersection of the two deployment lists the first deployment list to copy the second deployment list to copy @@ -1768,28 +1773,27 @@ deployments that are present in both @sourceOne and @sourceTwo. deprecated="1" deprecated-version="0.2.2"> Construct a new deployment list that is filled with all the deployments that are present in either @sourceOne and @sourceTwo. Use osinfo_list_new_union() instead. - + a union of the two deployment lists the first deployment list to copy the second deployment list to copy @@ -1806,20 +1810,22 @@ deployments that are present in either @sourceOne and @sourceTwo. - + - + disguised="1" + opaque="1"> + - + disguised="1" + opaque="1"> + glib:type-name="OsinfoDevice" glib:get-type="osinfo_device_get_type" glib:type-struct="DeviceClass"> - + - + @@ -1841,7 +1847,7 @@ deployments that are present in either @sourceOne and @sourceTwo. - + @@ -1852,7 +1858,7 @@ deployments that are present in either @sourceOne and @sourceTwo. - + @@ -1863,7 +1869,7 @@ deployments that are present in either @sourceOne and @sourceTwo. - + @@ -1874,7 +1880,7 @@ deployments that are present in either @sourceOne and @sourceTwo. - + @@ -1886,7 +1892,7 @@ deployments that are present in either @sourceOne and @sourceTwo. - + @@ -1899,24 +1905,24 @@ deployments that are present in either @sourceOne and @sourceTwo. - + the value of the device's subsystem. the device - + @@ -1927,7 +1933,7 @@ deployments that are present in either @sourceOne and @sourceTwo. - + @@ -1947,7 +1953,7 @@ deployments that are present in either @sourceOne and @sourceTwo. - + @@ -1959,25 +1965,24 @@ deployments that are present in either @sourceOne and @sourceTwo. glib:type-name="OsinfoDeviceDriver" glib:get-type="osinfo_device_driver_get_type" glib:type-struct="DeviceDriverClass"> - + Retrieves the target hardware architecture of @driver. - + the hardware architecture. an #OsinfoDeviceDriver instance @@ -1986,18 +1991,17 @@ deployments that are present in either @sourceOne and @sourceTwo. - + The list of devices supported by this driver. an #OsinfoDeviceDriver instance @@ -2007,14 +2011,13 @@ deployments that are present in either @sourceOne and @sourceTwo. c:identifier="osinfo_device_driver_get_files" version="0.2.2"> Retrieves the names of driver files under the location returned by #osinfo_device_driver_get_location. - + The list of driver files. @@ -2023,7 +2026,7 @@ deployments that are present in either @sourceOne and @sourceTwo. an #OsinfoDeviceDriver instance @@ -2033,20 +2036,19 @@ deployments that are present in either @sourceOne and @sourceTwo. c:identifier="osinfo_device_driver_get_location" version="0.2.2"> Retrieves the location of the @driver as a URL. - + the location of the driver. an #OsinfoDeviceDriver instance @@ -2055,18 +2057,17 @@ deployments that are present in either @sourceOne and @sourceTwo. - + TRUE if @driver is pre-installable, FALSE otherwise. an #OsinfoDeviceDriver instance @@ -2076,21 +2077,20 @@ deployments that are present in either @sourceOne and @sourceTwo. c:identifier="osinfo_device_driver_get_priority" version="1.7.0"> Returns the priority of the device driver. The higher the value, the more important it is. - + the priority of the device driver. an #OsinfoDeviceDriver instance @@ -2100,21 +2100,20 @@ important it is. c:identifier="osinfo_device_driver_get_signed" version="0.2.6"> Some OS vendors recommend or require device drivers to be signed by them before these device drivers could be installed on their OS. - + TRUE if @driver is signed, FALSE otherwise. an #OsinfoDeviceDriver instance @@ -2130,7 +2129,7 @@ before these device drivers could be installed on their OS. - + @@ -2142,19 +2141,18 @@ before these device drivers could be installed on their OS. glib:type-name="OsinfoDeviceDriverList" glib:get-type="osinfo_device_driverlist_get_type" glib:type-struct="DeviceDriverListClass"> - + Construct a new device driver list that is initially empty. - an empty device driver list @@ -2170,22 +2168,22 @@ before these device drivers could be installed on their OS. - + - + disguised="1" + opaque="1"> + - + disguised="1" + opaque="1"> + glib:nick="none" glib:name="OSINFO_DEVICE_DRIVER_SIGNING_REQ_NONE"> Script do not require device drivers to be signed. @@ -2208,7 +2206,7 @@ to be signed. glib:nick="strict" glib:name="OSINFO_DEVICE_DRIVER_SIGNING_REQ_STRICT"> Script must only be given signed device drivers. Some scripts will allow overriding this requirement through #osinfo_install_config_set_driver_signing function. You can query if a @@ -2222,7 +2220,7 @@ by the script in question (or other scripts in the same profile). glib:nick="warn" glib:name="OSINFO_DEVICE_DRIVER_SIGNING_REQ_WARN"> A warning will be issued by OS installer if device drivers are not signed and most probably require user input (and thus breaking unattended installation). See @@ -2237,30 +2235,30 @@ for some scripts. glib:type-name="OsinfoDeviceLink" glib:get-type="osinfo_devicelink_get_type" glib:type-struct="DeviceLinkClass"> - + Construct a new link for an #OsinfoDevice. The unique ID of the link is set to match the ID of the target device. - + the new device link the target device - + @@ -2274,19 +2272,19 @@ of the link is set to match the ID of the target device. c:identifier="osinfo_devicelink_get_target" glib:get-property="target"> Retrieve the #OsinfoDevice that the link points to. - + the target of the device link the device link @@ -2298,7 +2296,7 @@ of the link is set to match the ID of the target device. transfer-ownership="none" getter="get_target"> The target of the device link. @@ -2312,7 +2310,7 @@ of the link is set to match the ID of the target device. - + @@ -2324,25 +2322,24 @@ of the link is set to match the ID of the target device. glib:type-name="OsinfoDeviceLinkFilter" glib:get-type="osinfo_devicelinkfilter_get_type" glib:type-struct="DeviceLinkFilterClass"> - + Construct a new filter that matches all operating systems - a new filter the target device filter @@ -2352,21 +2349,21 @@ systems c:identifier="osinfo_devicelinkfilter_get_target_filter" glib:get-property="target-filter"> Retrieve the filter used to match against the target of the device link - the target filter object the filter object @@ -2378,7 +2375,7 @@ the device link transfer-ownership="none" getter="get_target_filter"> The operating system to be deployed @@ -2393,17 +2390,16 @@ the device link - + - + disguised="1" + opaque="1"> + glib:type-name="OsinfoDeviceLinkList" glib:get-type="osinfo_devicelinklist_get_type" glib:type-struct="DeviceLinkListClass"> - + Construct a new devicelink list that is initially empty. - + an empty devicelink list @@ -2429,20 +2424,19 @@ the device link Get all devices matching a given filter - + A list of devices an device link list @@ -2451,7 +2445,7 @@ the device link nullable="1" allow-none="1"> an optional device property filter @@ -2462,22 +2456,21 @@ the device link deprecated="1" deprecated-version="0.2.2"> Construct a new devicelink list that is filled with devicelinks from @source Use osinfo_list_new_copy() instead. - + a copy of the devicelink list the devicelink list to copy @@ -2488,28 +2481,27 @@ from @source deprecated="1" deprecated-version="0.2.2"> Construct a new devicelink list that is filled with devicelinks from @source that match @filter Use osinfo_list_new_filtered() instead. - + a filtered copy of the devicelink list the devicelink list to copy the filter to apply @@ -2520,28 +2512,27 @@ from @source that match @filter deprecated="1" deprecated-version="0.2.2"> Construct a new devicelink list that is filled with only the devicelinks that are present in both @sourceOne and @sourceTwo. Use osinfo_list_new_intersection() instead. - + an intersection of the two devicelink lists the first devicelink list to copy the second devicelink list to copy @@ -2552,28 +2543,27 @@ devicelinks that are present in both @sourceOne and @sourceTwo. deprecated="1" deprecated-version="0.2.2"> Construct a new devicelink list that is filled with all the devicelinks that are present in either @sourceOne and @sourceTwo. Use osinfo_list_new_union() instead. - + a union of the two devicelink lists the first devicelink list to copy the second devicelink list to copy @@ -2590,20 +2580,22 @@ devicelinks that are present in either @sourceOne and @sourceTwo. - + - + disguised="1" + opaque="1"> + - + disguised="1" + opaque="1"> + glib:type-name="OsinfoDeviceList" glib:get-type="osinfo_devicelist_get_type" glib:type-struct="DeviceListClass"> - + Construct a new device list that is initially empty. - + an empty device list @@ -2630,21 +2622,21 @@ devicelinks that are present in either @sourceOne and @sourceTwo. deprecated="1" deprecated-version="0.2.2"> Construct a new device list that is filled with devices from @source Use osinfo_list_new_copy() instead. - + a copy of the device list the device list to copy @@ -2655,27 +2647,27 @@ from @source deprecated="1" deprecated-version="0.2.2"> Construct a new device list that is filled with devices from @source that match @filter Use osinfo_list_new_filtered() instead. - + a filtered copy of the device list the device list to copy the filter to apply @@ -2686,27 +2678,27 @@ from @source that match @filter deprecated="1" deprecated-version="0.2.2"> Construct a new device list that is filled with only the devices that are present in both @sourceOne and @sourceTwo. Use osinfo_list_new_intersection() instead. - + an intersection of the two device lists the first device list to copy the second device list to copy @@ -2717,27 +2709,27 @@ devices that are present in both @sourceOne and @sourceTwo. deprecated="1" deprecated-version="0.2.2"> Construct a new device list that is filled with all the devices that are present in either @sourceOne and @sourceTwo. Use osinfo_list_new_union() instead. - + a union of the two device lists the first device list to copy the second device list to copy @@ -2753,21 +2745,25 @@ devices that are present in either @sourceOne and @sourceTwo. - + - + disguised="1" + opaque="1"> + - - + + - + glib:type-name="OsinfoEntity" glib:get-type="osinfo_entity_get_type" glib:type-struct="EntityClass"> - + Adds a new parameter against the entity. A key can have multiple values associated. Thus repeated calls with the same key will build up a list of possible values. - + an #OsinfoEntity containing the parameters the name of the key the data to associated with that key @@ -2812,22 +2808,22 @@ build up a list of possible values. Remove all values associated with a key - + an #OsinfoEntity containing the parameters the name of the key @@ -2837,20 +2833,20 @@ build up a list of possible values. c:identifier="osinfo_entity_get_id" glib:get-property="id"> Retrieves the unique key for the entity. The format of identifiers is undefined, but the recommended practice is to use a URI. - + the unique key for the entity an #OsinfoEntity @@ -2859,13 +2855,13 @@ is undefined, but the recommended practice is to use a URI. Retrieve all the known parameter keys associated with the entity - + The list of string parameters @@ -2874,7 +2870,7 @@ the entity an #OsinfoEntity containing the parameters @@ -2883,27 +2879,27 @@ the entity Retrieve the parameter value associated with a named key. If multiple values are stored against the key, only the first value is returned. If no value is associated, NULL is returned - + the value associated with the key, or NULL an #OsinfoEntity containing the parameters the name of the key @@ -2913,27 +2909,27 @@ value is returned. If no value is associated, NULL is returned c:identifier="osinfo_entity_get_param_value_boolean" version="0.2.0"> Retrieve the parameter value associated with a named key as a boolean. If multiple values are stored against the key, only the first value is returned. If no value is associated, FALSE is returned - + the value associated with the key as a boolean, or FALSE an #OsinfoEntity containing the parameters the name of the key @@ -2943,15 +2939,15 @@ first value is returned. If no value is associated, FALSE is returned c:identifier="osinfo_entity_get_param_value_boolean_with_default" version="0.2.1"> Retrieve the parameter value associated with a named key as a boolean. If multiple values are stored against the key, only the first value is returned. If no value is associated, @default_value is returned. - + the value associated with the key as a boolean, or @default_value @@ -2959,19 +2955,19 @@ is returned. an #OsinfoEntity containing the parameters the name of the key the value to be returned in case there's no value associated with the @key @@ -2982,40 +2978,40 @@ is returned. c:identifier="osinfo_entity_get_param_value_enum" version="0.2.2"> Retrieve the parameter value associated with a named key as an enum value. If multiple values are stored against the key, only the first value is returned. If no value is associated, the @default_value is returned. - + the enum value associated with the key, or @default_value. an #OsinfoEntity containing the parameters the name of the key the enum type the default value to be used, in case there's no value associated with the key @@ -3026,27 +3022,27 @@ the first value is returned. If no value is associated, the c:identifier="osinfo_entity_get_param_value_int64" version="0.2.1"> Retrieve the parameter value associated with a named key as an int64. If multiple values are stored against the key, only the first value is returned. If no value is associated, -1 is returned. - + the value associated with the key as an int64, or -1. an #OsinfoEntity containing the parameters the name of the key @@ -3056,15 +3052,15 @@ first value is returned. If no value is associated, -1 is returned. c:identifier="osinfo_entity_get_param_value_int64_with_default" version="0.2.1"> Retrieve the parameter value associated with a named key as an int64. If multiple values are stored against the key, only the first value is returned. If no value is associated, @default_value is returned. - + the value associated with the key as an int64, or @default_value @@ -3072,19 +3068,19 @@ is returned. an #OsinfoEntity containing the parameters the name of the key the value to be returned in case there's no value associated with the @key @@ -3094,13 +3090,13 @@ is returned. Retrieve all the parameter values associated with a named key. If no values are associated, NULL is returned - + the values associated with the key @@ -3109,13 +3105,13 @@ key. If no values are associated, NULL is returned an #OsinfoEntity containing the parameters the name of the key @@ -3123,30 +3119,30 @@ key. If no values are associated, NULL is returned Sets a new parameter against the entity. If the key already has a value associated with it, the existing value will be cleared. - + an #OsinfoEntity containing the parameters the name of the key the data to associated with that key @@ -3156,30 +3152,30 @@ cleared. c:identifier="osinfo_entity_set_param_boolean" version="0.2.0"> Sets a new parameter against the entity. If the key already has a value associated with it, the existing value will be cleared. - + an #OsinfoEntity containing the parameters the name of the key the boolean value to be associated with that key @@ -3189,36 +3185,36 @@ cleared. c:identifier="osinfo_entity_set_param_enum" version="0.2.2"> Sets a new parameter against the entity. If the key already has a value associated with it, the existing value will be cleared. - + an #OsinfoEntity containing the parameters the name of the key the enum value to be associated with that key the enum type @@ -3228,30 +3224,30 @@ cleared. c:identifier="osinfo_entity_set_param_int64" version="0.2.1"> Sets a new parameter against the entity. If the key already has a value associated with it, the existing value will be cleared. - + an #OsinfoEntity containing the parameters the name of the key the int64 value to be associated with that key @@ -3261,9 +3257,10 @@ cleared. writable="1" construct="1" transfer-ownership="none" - getter="get_id"> + getter="get_id" + default-value="NULL"> The unique identifier for the entity The format of identifiers is undefined, but the recommended practice is to use a URI. This parameter must be set at time of construction as no @@ -3280,13 +3277,16 @@ default value is provided. - + - - + + c:type="OsinfoError" glib:error-domain="libosinfo"> #GError codes used for errors in #OSINFO_ERROR domain. glib:nick="generic" glib:name="OSINFO_ERROR_GENERIC"> Generic Osinfo error; Gets a #GQuark representing the string "libosinfo" the #GQuark representing the string. @@ -3321,19 +3321,19 @@ default value is provided. - + - + - + glib:type-name="OsinfoFilter" glib:get-type="osinfo_filter_get_type" glib:type-struct="FilterClass"> - + Construct a new filter that matches all entities - + a filter object Determine of an entity matches a filter - + TRUE if entity passes the filter, FALSE otherwise a filter object an entity to query @@ -3385,32 +3385,32 @@ default value is provided. Adds a constraint that requires the entity to have a property key @propName with a value of @propVal. If multiple constraints are added for the same @propName, with different values, the entity have all property values. - + a filter object the name of the parameter key the required property value @@ -3419,23 +3419,23 @@ all property values. Remove all filter constraints for the matching property name. - + a filter object name of the key to remove constraints for @@ -3444,16 +3444,16 @@ name. Remove all filter property constraints - + a filter object @@ -3462,12 +3462,12 @@ name. Get a list of all constraint property keys - + List of constraint keys @@ -3476,7 +3476,7 @@ name. a filter object @@ -3485,12 +3485,12 @@ name. Get a list values for filter constraints with the named key - + List of constraint values @@ -3499,13 +3499,13 @@ name. a filter object the name of the key @@ -3513,25 +3513,25 @@ name. Determine of an entity matches a filter - + TRUE if entity passes the filter, FALSE otherwise a filter object an entity to query @@ -3547,29 +3547,29 @@ name. - + - + TRUE if entity passes the filter, FALSE otherwise a filter object an entity to query @@ -3577,8 +3577,11 @@ name. - - + + glib:type-name="OsinfoFirmware" glib:get-type="osinfo_firmware_get_type" glib:type-struct="FirmwareClass"> - + - + @@ -3610,19 +3613,19 @@ name. glib:get-property="architecture" version="1.7.0"> Retrieves the target hardware architecture of the OS @firmware provides. - + the hardware architecture, or NULL an #OsinfoFirmware instance @@ -3632,19 +3635,19 @@ name. c:identifier="osinfo_firmware_get_firmware_type" version="1.7.0"> The type of the @firmware - + the type, or NULL an #OsinfoFirmware instance @@ -3654,19 +3657,19 @@ name. c:identifier="osinfo_firmware_is_supported" version="1.8.0"> Whether the @firmware is supported or not - + TRUE if supported, FALSE otherwise. an #OsinfoFirmware instance @@ -3675,13 +3678,17 @@ name. + getter="get_architecture" + default-value="NULL"> The target hardware architecture of this firmware. - + @@ -3694,7 +3701,7 @@ name. - + @@ -3706,17 +3713,17 @@ name. glib:type-name="OsinfoFirmwareList" glib:get-type="osinfo_firmwarelist_get_type" glib:type-struct="FirmwareListClass"> - + Construct a new firmware list that is initially empty. - + an empty firmware list @@ -3731,312 +3738,314 @@ name. - + - + disguised="1" + opaque="1"> + - + disguised="1" + opaque="1"> + - + - + - + - + - + - + - - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + glib:type-name="OsinfoImage" glib:get-type="osinfo_image_get_type" glib:type-struct="ImageClass"> - + - + @@ -4069,19 +4078,19 @@ name. glib:get-property="architecture" version="1.3.0"> Retrieves the target hardware architecture of the OS @image provides. - + the hardware architecture, or NULL an #OsinfoImage instance @@ -4092,12 +4101,12 @@ name. glib:get-property="cloud-init" version="1.3.0"> Whether @image supports cloud init customizations - + #TRUE if @image supports cloud init customizations, #FALSE otherwise. @@ -4105,7 +4114,7 @@ otherwise. an #OsinfoImage instance @@ -4116,36 +4125,36 @@ otherwise. glib:get-property="format" version="1.3.0"> The format of the @image - + the format, or NULL an #OsinfoImage instance - + the operating system, or NULL an #OsinfoImage instance @@ -4155,19 +4164,19 @@ otherwise. c:identifier="osinfo_image_get_os_variants" version="1.5.0"> Gets the varriants of the associated operating system - + the operating system variants, or NULL an #OsinfoImage instance @@ -4178,19 +4187,19 @@ otherwise. glib:get-property="url" version="1.3.0"> The URL to the @image - + the URL, or NULL an #OsinfoImage instance @@ -4198,22 +4207,22 @@ otherwise. Sets the #OsinfoOs associated to the #OsinfoImage instance. - + an #OsinfoImage instance an #OsinfoOs instance @@ -4222,36 +4231,40 @@ otherwise. + getter="get_architecture" + default-value="NULL"> The target hardware architecture of this image. + getter="get_cloud_init" + default-value="NULL"> Whether the image supports cloud-init customizations or not. + getter="get_format" + default-value="NULL"> The image format. + getter="get_url" + default-value="NULL"> The URL to this image. @@ -4265,7 +4278,7 @@ otherwise. - + @@ -4277,17 +4290,17 @@ otherwise. glib:type-name="OsinfoImageList" glib:get-type="osinfo_imagelist_get_type" glib:type-struct="ImageListClass"> - + Construct a new image list that is initially empty. - + an empty image list @@ -4302,18 +4315,22 @@ otherwise. - + - + disguised="1" + opaque="1"> + - - + + glib:type-name="OsinfoInstallConfig" glib:get-type="osinfo_install_config_get_type" glib:type-struct="InstallConfigClass"> - + Construct a new install configuration with default values for language, keyboard, timezone and admin password. The default values are to use an 'en_US' language and keyboard, and an 'America/New_York' timezone. The admin password is set to a random 8 character password. - + an install configuration with default values @@ -4344,7 +4360,7 @@ values the unique identifier @@ -4353,11 +4369,10 @@ values - + The value of #OSINFO_INSTALL_CONFIG_PROP_ADMIN_PASSWORD parameter, or NULL. @@ -4365,7 +4380,7 @@ values the install config @@ -4374,11 +4389,10 @@ values - + The value of #OSINFO_INSTALL_CONFIG_PROP_AVATAR_DISK parameter, or NULL. @@ -4386,7 +4400,7 @@ values the install config @@ -4395,11 +4409,10 @@ values - + The value of #OSINFO_INSTALL_CONFIG_PROP_AVATAR_LOCATION parameter, or NULL. @@ -4407,7 +4420,7 @@ values the install config @@ -4416,11 +4429,10 @@ values - + %TRUE if driver signing is currently enabled, %FALSE otherwise, see #osinfo_install_config_set_driver_signing() for more details about driver signing. @@ -4429,7 +4441,7 @@ signing. the install config @@ -4438,11 +4450,10 @@ signing. - + The value of #OSINFO_INSTALL_CONFIG_PROP_HARDWARE_ARCH parameter, or NULL. @@ -4450,7 +4461,7 @@ signing. the install config @@ -4459,11 +4470,10 @@ signing. - + The value of #OSINFO_INSTALL_CONFIG_PROP_HOSTNAME parameter, or NULL. @@ -4471,7 +4481,7 @@ signing. the install config @@ -4481,17 +4491,16 @@ signing. c:identifier="osinfo_install_config_get_installation_url" version="1.5.0"> Returns the URL the script will use to perform the installation. - + the install config @@ -4500,11 +4509,10 @@ signing. - + The value of #OSINFO_INSTALL_CONFIG_PROP_L10N_KEYBOARD parameter, or NULL. @@ -4512,7 +4520,7 @@ signing. the install config @@ -4521,11 +4529,10 @@ signing. - + The value of #OSINFO_INSTALL_CONFIG_PROP_L10N_LANGUAGE parameter, or NULL. @@ -4533,7 +4540,7 @@ signing. the install config @@ -4542,11 +4549,10 @@ signing. - + The value of #OSINFO_INSTALL_CONFIG_PROP_L10N_TIMEZONE parameter, or NULL. @@ -4554,7 +4560,7 @@ signing. the install config @@ -4563,11 +4569,10 @@ signing. - + The disk on which post-installation drivers are located, or NULL if its not set using #osinfo_install_config_set_post_install_drivers_disk(). @@ -4575,7 +4580,7 @@ its not set using #osinfo_install_config_set_post_install_drivers_disk(). the install config @@ -4584,11 +4589,10 @@ its not set using #osinfo_install_config_set_post_install_drivers_disk(). - + The disk on which post-installation drivers are located, or NULL if its not set using #osinfo_install_config_set_post_install_drivers_location(). @@ -4596,7 +4600,7 @@ its not set using #osinfo_install_config_set_post_install_drivers_location(). the install config @@ -4605,11 +4609,10 @@ its not set using #osinfo_install_config_set_post_install_drivers_location(). - + The disk on which pre-installation drivers are located, or NULL if its not set using #osinfo_install_config_set_pre_install_drivers_disk(). @@ -4617,7 +4620,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_disk(). the install config @@ -4626,11 +4629,10 @@ its not set using #osinfo_install_config_set_pre_install_drivers_disk(). - + The location on which pre-installation drivers are located, or NULL if its not set using #osinfo_install_config_set_pre_install_drivers_location(). @@ -4638,7 +4640,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). the install config @@ -4647,11 +4649,10 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). - + The value of #OSINFO_INSTALL_CONFIG_PROP_REG_LOGIN parameter, or NULL. @@ -4659,7 +4660,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). the install config @@ -4668,11 +4669,10 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). - + The value of #OSINFO_INSTALL_CONFIG_PROP_REG_PASSWORD parameter, or NULL. @@ -4680,7 +4680,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). the install config @@ -4689,11 +4689,10 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). - + The value of #OSINFO_INSTALL_CONFIG_PROP_REG_PRODUCTKEY parameter, or NULL. @@ -4701,7 +4700,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). the install config @@ -4710,11 +4709,10 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). - + The value of #OSINFO_INSTALL_CONFIG_PROP_SCRIPT_DISK parameter, or NULL. @@ -4722,7 +4720,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). the install config @@ -4731,11 +4729,10 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). - + The value of #OSINFO_INSTALL_CONFIG_PROP_TARGET_DISK parameter, or NULL. @@ -4743,7 +4740,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). the install config @@ -4752,11 +4749,10 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). - + The value of #OSINFO_INSTALL_CONFIG_PROP_USER_ADMIN parameter, or NULL. @@ -4764,7 +4760,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). the install config @@ -4773,11 +4769,10 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). - + The value of #OSINFO_INSTALL_CONFIG_PROP_USER_AUTOLOGIN parameter, or NULL. @@ -4785,7 +4780,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). the install config @@ -4794,11 +4789,10 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). - + The value of #OSINFO_INSTALL_CONFIG_PROP_USER_LOGIN parameter, or NULL. @@ -4806,7 +4800,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). the install config @@ -4815,11 +4809,10 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). - + The value of #OSINFO_INSTALL_CONFIG_PROP_USER_PASSWORD parameter, or NULL. @@ -4827,7 +4820,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). the install config @@ -4836,11 +4829,10 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). - + The value of #OSINFO_INSTALL_CONFIG_PROP_USER_REALNAME parameter, or NULL. @@ -4848,7 +4840,7 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). the install config @@ -4858,23 +4850,22 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). Sets the #OSINFO_INSTALL_CONFIG_PROP_ADMIN_PASSWORD parameter - + the install config the administrator password to be set @@ -4884,26 +4875,25 @@ its not set using #osinfo_install_config_set_pre_install_drivers_location(). Sets the #OSINFO_INSTALL_CONFIG_PROP_AVATAR_DISK parameter. Please read documentation on #osinfo_install_config_set_target_disk() for explanation on the format of @disk string. - + the install config the avatar disk @@ -4913,7 +4903,7 @@ explanation on the format of @disk string. c:identifier="osinfo_install_config_set_avatar_location" version="0.2.2"> Sets the #OSINFO_INSTALL_CONFIG_PROP_AVATAR_LOCATION parameter. Note that the format of this string is dependent on the installer script @@ -4923,21 +4913,20 @@ does the script expects this string to be in. Also note that in case of #OSINFO_PATH_FORMAT_DOS, the drive/disk letter and the leading ':' must not be included in the path. - + the install config new location @@ -4947,25 +4936,24 @@ and the leading ':' must not be included in the path. c:identifier="osinfo_install_config_set_driver_signing" version="0.2.6"> If a script requires drivers to be signed, this function can be used to disable that security feature. WARNING: Disabling driver signing may very well mean disabling it permanently. - + the install config boolean value @@ -4975,25 +4963,24 @@ well mean disabling it permanently. c:identifier="osinfo_install_config_set_hardware_arch" version="0.2.0"> Sets the #OSINFO_INSTALL_CONFIG_PROP_HARDWARE_ARCH parameter. The list of valid architectures are part of osinfo.rng schema - + the install config the hardware architecture @@ -5003,7 +4990,7 @@ The list of valid architectures are part of osinfo.rng schema c:identifier="osinfo_install_config_set_hostname" version="0.2.0"> Sets the #OSINFO_INSTALL_CONFIG_PROP_HOSTNAME parameter. Note that some operating systems have restrictions on maximum number of, and @@ -5012,21 +4999,20 @@ recommended that you keep the actual hostname less than or equal to 15 characters long and make sure that it does not contain any characters other than ASCII alphanumeric and '-'. Otherwise unattended installation might fail. - + the install config the desired hostname @@ -5036,24 +5022,23 @@ fail. c:identifier="osinfo_install_config_set_installation_url" version="1.5.0"> When performing a tree based installation the script will need the installation URL to be set, whenever the installation is performed from a non canonical place. - + the install config the URL used to perform the installation @@ -5063,26 +5048,25 @@ URL to be set, whenever the installation is performed from a non canonical place c:identifier="osinfo_install_config_set_l10n_keyboard" version="0.2.0"> Sets the #OSINFO_INSTALL_CONFIG_PROP_L10N_KEYBOARD parameter. The expected format of this string is the same as #osinfo_install_config_set_l10n_language function's 'language' parameter. - + the install config the keyboard @@ -5092,7 +5076,7 @@ The expected format of this string is the same as c:identifier="osinfo_install_config_set_l10n_language" version="0.2.0"> Sets the #OSINFO_INSTALL_CONFIG_PROP_L10N_LANGUAGE parameter. The expected format of this string is the gettext locale names standard: @@ -5102,21 +5086,20 @@ https://www.gnu.org/savannah-checkouts/gnu/gettext/manual/html_node/Locale-Names Encoding and variant are (at least for now) not supported. For example, 'pt_BR' is accepted is accepted as the language codes for Brazilian Portuguese but 'pt_BR.utf8' is not. - + the install config the language @@ -5126,25 +5109,24 @@ but 'pt_BR.utf8' is not. c:identifier="osinfo_install_config_set_l10n_timezone" version="0.2.0"> Set the #OSINFO_INSTALL_CONFIG_PROP_L10N_TIMEZONE parameter. The expected format of this string is the tzdata names standard. - + the install config. the timezone @@ -5154,7 +5136,7 @@ The expected format of this string is the tzdata names standard. c:identifier="osinfo_install_config_set_post_install_drivers_disk" version="0.2.2"> Specify the disk on which drivers to be installed at the end of installation, are available. @@ -5164,21 +5146,20 @@ explanation on the format of @disk string. NOTE: Not every install script supports post-installation of drivers. Use #osinfo_install_script_get_can_post_install_drivers() to find out if an install script supports it. - + the install config the target disk @@ -5188,7 +5169,7 @@ install script supports it. c:identifier="osinfo_install_config_set_post_install_drivers_location" version="0.2.2"> Specify the disk on which drivers to be installed at the end of installation, are available. @@ -5198,21 +5179,20 @@ explanation on the format of @location string. NOTE: Not every install script supports post-installation of drivers. Use #osinfo_install_script_get_can_post_install_drivers() to find out if an install script supports it. - + the install config the location of avatar @@ -5222,7 +5202,7 @@ install script supports it. c:identifier="osinfo_install_config_set_pre_install_drivers_disk" version="0.2.2"> Specify the disk on which drivers to be installed at the very beginning of installation, are available. This is usually needed for devices for which the OS in question does not have out of the box support for and devices are @@ -5237,21 +5217,20 @@ installer script supports it. NOTE: Microsoft Windows XP requires pre-installation driver files to be present in the script disk under the toplevel directory. - + the install config the disk @@ -5261,7 +5240,7 @@ present in the script disk under the toplevel directory. c:identifier="osinfo_install_config_set_pre_install_drivers_location" version="0.2.2"> Specify the location on which drivers to be installed at the very beginning of installation, are available. Please read documentation on #osinfo_install_config_set_pre_install_drivers_disk() for more information @@ -5269,21 +5248,20 @@ about pre-installation of drivers. Please read documentation on #osinfo_install_config_set_avatar_location() for explanation on the format of @location string. - + the install config the location @@ -5293,23 +5271,22 @@ explanation on the format of @location string. c:identifier="osinfo_install_config_set_reg_login" version="0.2.0"> Sets the value of #OSINFO_INSTALL_CONFIG_PROP_REG_LOGIN parameter. - + the install config the registration login @@ -5319,23 +5296,22 @@ explanation on the format of @location string. c:identifier="osinfo_install_config_set_reg_password" version="0.2.0"> Sets the value of #OSINFO_INSTALL_CONFIG_PROP_REG_PASSWORD parameter. - + the install config the registration password @@ -5343,8 +5319,7 @@ explanation on the format of @location string. - + @@ -5361,26 +5336,25 @@ explanation on the format of @location string. c:identifier="osinfo_install_config_set_script_disk" version="0.2.2"> Sets the #OSINFO_INSTALL_CONFIG_PROP_SCRIPT_DISK parameter. Please read documentation on #osinfo_install_config_set_target_disk() for explanation on the format of @disk string. - + the install config the disk @@ -5390,7 +5364,7 @@ explanation on the format of @disk string. c:identifier="osinfo_install_config_set_target_disk" version="0.2.2"> Sets the #OSINFO_INSTALL_CONFIG_PROP_TARGET_DISK parameter. Note that the format of this string is dependent on the installer script @@ -5399,21 +5373,20 @@ Note that the format of this string is dependent on the installer script does the script expects this string to be in. In case of #OSINFO_PATH_FORMAT_UNIX unix device node names are expected, e.g "/dev/fd0". In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". - + the install config the target disk @@ -5423,23 +5396,22 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". c:identifier="osinfo_install_config_set_user_administrator" version="0.2.0"> Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_ADMIN parameter. - + the install config whether the user should be set as administrator or not @@ -5449,23 +5421,22 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". c:identifier="osinfo_install_config_set_user_autologin" version="0.2.0"> Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_AUTOLOGIN parameter. - + the install config whether autologin should be set for the user or not @@ -5475,23 +5446,22 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". c:identifier="osinfo_install_config_set_user_login" version="0.2.0"> Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_LOGIN parameter. - + the install config the chosen username for the user log into the system @@ -5501,23 +5471,22 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". c:identifier="osinfo_install_config_set_user_password" version="0.2.0"> Sets the #OSINFO_INSTALL_CONFIG_PROP_USER_PASSWORD parameter - + the install config the user password to be set @@ -5527,23 +5496,22 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". c:identifier="osinfo_install_config_set_user_realname" version="0.2.0"> Sets the value of #OSINFO_INSTALL_CONFIG_PROP_USER_REALNAME parameter. - + the install config the user real name to be displayed @@ -5560,7 +5528,7 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". - + @@ -5572,26 +5540,26 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". glib:type-name="OsinfoInstallConfigParam" glib:get-type="osinfo_install_config_param_get_type" glib:type-struct="InstallConfigParamClass"> - Construct a new configuration parameter for an #OsinfoInstallScript. - the new configuration parameter the configuration parameter name @@ -5601,18 +5569,18 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". c:identifier="osinfo_install_config_param_get_name" glib:get-property="name" version="0.2.0"> - the name of the configuration parameter the configuration parameter @@ -5623,11 +5591,11 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". c:identifier="osinfo_install_config_param_get_policy" glib:get-property="policy" version="0.2.0"> - the policy of the configuration parameter @@ -5635,7 +5603,7 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". the configuration parameter @@ -5646,11 +5614,11 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". c:identifier="osinfo_install_config_param_get_value_map" glib:get-property="value-map" version="0.2.8"> - The data map used to transform values set for this parameter to OS-specific values, or NULL. @@ -5658,7 +5626,7 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". the configuration parameter @@ -5668,18 +5636,18 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". - TRUE if the config_param is optional. FALSE otherwise. the configuration parameter @@ -5689,18 +5657,18 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". - TRUE if the config_param is required. FALSE otherwise. the configuration parameter @@ -5712,11 +5680,11 @@ In case of #OSINFO_PATH_FORMAT_DOS drive letters are expected, e.g "A". glib:set-property="value-map" version="0.2.8"> After a call to osinfo_install_config_param_set_value_map(), @datamap will be used to transform values set for this parameter to OS-specific values. A NULL @datamap will disable transformations. - @@ -5724,14 +5692,14 @@ values. A NULL @datamap will disable transformations. the configuration parameter a #OsinfoDatamap to transform values this parameter is set to, or NULL to disable transformations for this parameter @@ -5742,15 +5710,19 @@ or NULL to disable transformations for this parameter writable="1" construct-only="1" transfer-ownership="none" - getter="get_name"> + getter="get_name" + default-value="NULL"> The name of the configuration parameter. - + The policy of the configuration parameter. @@ -5760,7 +5732,7 @@ or NULL to disable transformations for this parameter setter="set_value_map" getter="get_value_map"> The mapping between generic values and OS-specific values for this configuration parameter @@ -5776,7 +5748,7 @@ configuration parameter - @@ -5789,19 +5761,19 @@ configuration parameter glib:type-name="OsinfoInstallConfigParamList" glib:get-type="osinfo_install_config_paramlist_get_type" glib:type-struct="InstallConfigParamListClass"> - Construct a new install_config_param list that is initially empty. - an empty install_config_param list @@ -5818,7 +5790,7 @@ configuration parameter - @@ -5826,8 +5798,9 @@ configuration parameter - + glib:get-type="osinfo_install_config_param_policy_get_type" c:type="OsinfoInstallConfigParamPolicy"> Policy for configuration parameter presence glib:nick="none" glib:name="OSINFO_INSTALL_CONFIG_PARAM_POLICY_NONE"> no policy defined glib:nick="required" glib:name="OSINFO_INSTALL_CONFIG_PARAM_POLICY_REQUIRED"> config parameter is required glib:nick="optional" glib:name="OSINFO_INSTALL_CONFIG_PARAM_POLICY_OPTIONAL"> config parameter may be omitted - + - + disguised="1" + opaque="1"> + glib:type-name="OsinfoInstallScript" glib:get-type="osinfo_install_script_get_type" glib:type-struct="InstallScriptClass"> - + - + @@ -5901,32 +5875,31 @@ configuration parameter c:identifier="osinfo_install_script_new_data" version="0.2.0"> Construct a new install script from stylesheet data - + an new install script a unique identifier the profile of script style sheet data @@ -5936,32 +5909,31 @@ configuration parameter c:identifier="osinfo_install_script_new_uri" version="0.2.0"> Construct a new install script from a stylesheet URI - + an new install script a unique identifier the profile of script style sheet URI @@ -5972,13 +5944,12 @@ configuration parameter version="0.2.0" throws="1"> Creates an install script. - + the script as string. If you are generating the script for a specific media, it is recommended @@ -5991,19 +5962,19 @@ that you use #osinfo_install_script_generate_for_tree() in instead. the install script the os the install script config @@ -6012,7 +5983,7 @@ that you use #osinfo_install_script_generate_for_tree() in instead. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -6022,34 +5993,33 @@ that you use #osinfo_install_script_generate_for_tree() in instead. c:identifier="osinfo_install_script_generate_async" version="0.2.0"> Asynchronous variant of #osinfo_install_script_generate(). From the callback, call #osinfo_install_script_generate_finish() to conclude this call and get the generated script. If you are generating the script for a specific media, it is recommended that you use #osinfo_install_script_generate_for_media_async() instead. - + the install script the os the install script config @@ -6058,7 +6028,7 @@ you use #osinfo_install_script_generate_for_media_async() instead. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -6069,7 +6039,7 @@ you use #osinfo_install_script_generate_for_media_async() instead. scope="async" closure="4"> Function to call when result of this call is ready @@ -6078,7 +6048,7 @@ you use #osinfo_install_script_generate_for_media_async() instead. nullable="1" allow-none="1"> The user data to pass to @callback, or %NULL @@ -6088,7 +6058,7 @@ you use #osinfo_install_script_generate_for_media_async() instead. c:identifier="osinfo_install_script_generate_command_line" version="0.2.7"> Some install scripts need to pass a command line to the kernel, Such install scripts belong to OSs that provide paths to the kernel and initrd files that can be used to directly boot @@ -6102,30 +6072,29 @@ recommended that you use If you are generating the command line for a specific tree, it is recommended that you use #osinfo_install_script_generate_command_line_for_tree() instead. - + The generated command line string, NULL otherwise. the install script the os entity the install script config @@ -6135,7 +6104,7 @@ recommended that you use c:identifier="osinfo_install_script_generate_command_line_for_media" version="0.2.12"> Some install scripts need to pass a command line to the kernel, Such install scripts belong to OSs that provide paths to the kernel and initrd files that can be used to directly boot @@ -6144,30 +6113,29 @@ the OS in order to pass the needed commandline to it. The media @media must have been identified successfully using #osinfo_db_identify_media() before calling this function. - + The generated command line string, NULL otherwise. the install script the media the install script config @@ -6177,7 +6145,7 @@ The media @media must have been identified successfully using c:identifier="osinfo_install_script_generate_command_line_for_tree" version="1.6.0"> Some install scripts need to pass a command line to the kernel, Such install scripts belong to OSs that provide paths to the kernel and initrd files that can be used to directly boot @@ -6186,30 +6154,29 @@ the OS in order to pass the needed commandline to it. The tree @tree must have been identified successfully using #osinfo_db_identify_tree() before calling this function. - + The generated command line string, NULL otherwise. the install script the tree the install script config @@ -6219,24 +6186,23 @@ The tree @tree must have been identified successfully using c:identifier="osinfo_install_script_generate_finish" version="0.2.0" throws="1"> - + the generated script, or NULL on error the install script a #GAsyncResult @@ -6247,33 +6213,32 @@ The tree @tree must have been identified successfully using version="0.2.12" throws="1"> Creates an install script. The media @media must have been identified successfully using #osinfo_db_identify_media() before calling this function. - + the script as string. the install script the media the install script config @@ -6282,7 +6247,7 @@ successfully using #osinfo_db_identify_media() before calling this function. a #GCancellable, or %NULL @@ -6292,31 +6257,30 @@ successfully using #osinfo_db_identify_media() before calling this function. Asynchronous variant of #osinfo_install_script_generate_for_media(). From the callback, call #osinfo_install_script_generate_for_media_finish() to conclude this call and get the generated script. - + the install script the media the install script config @@ -6325,7 +6289,7 @@ conclude this call and get the generated script. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -6336,7 +6300,7 @@ conclude this call and get the generated script. scope="async" closure="4"> Function to call when result of this call is ready @@ -6345,7 +6309,7 @@ conclude this call and get the generated script. nullable="1" allow-none="1"> The user data to pass to @callback, or %NULL @@ -6355,24 +6319,23 @@ conclude this call and get the generated script. c:identifier="osinfo_install_script_generate_for_media_finish" version="0.2.12" throws="1"> - + the generated script, or NULL on error the install script a #GAsyncResult @@ -6383,33 +6346,32 @@ conclude this call and get the generated script. version="1.6.0" throws="1"> Creates an install script. The tree @tree must have been identified successfully using #osinfo_db_identify_tree() before calling this function. - + the script as string. the install script the tree the install script config @@ -6418,7 +6380,7 @@ successfully using #osinfo_db_identify_tree() before calling this function. a #GCancellable, or %NULL @@ -6428,31 +6390,30 @@ successfully using #osinfo_db_identify_tree() before calling this function. Asynchronous variant of #osinfo_install_script_generate_for_tree(). From the callback, call #osinfo_install_script_generate_for_tree_finish() to conclude this call and get the generated script. - + the install script the tree the install script config @@ -6461,7 +6422,7 @@ conclude this call and get the generated script. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -6472,7 +6433,7 @@ conclude this call and get the generated script. scope="async" closure="4"> Function to call when result of this call is ready @@ -6481,7 +6442,7 @@ conclude this call and get the generated script. nullable="1" allow-none="1"> The user data to pass to @callback, or %NULL @@ -6491,24 +6452,23 @@ conclude this call and get the generated script. c:identifier="osinfo_install_script_generate_for_tree_finish" version="1.6.0" throws="1"> - + the generated script, or NULL or error the install script a #GAsyncResult @@ -6519,13 +6479,12 @@ conclude this call and get the generated script. version="0.2.0" throws="1"> Creates an install script that is written to the returned file. - + a file containing the script If you are generating the script for a specific media, it is recommended @@ -6538,25 +6497,25 @@ that you use #osinfo_install_script_generate_output_for_tree() instead. the install script the os entity the install script config the directory where the file containing the output script will be written @@ -6566,7 +6525,7 @@ that you use #osinfo_install_script_generate_output_for_tree() instead. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -6576,40 +6535,39 @@ that you use #osinfo_install_script_generate_output_for_tree() instead. c:identifier="osinfo_install_script_generate_output_async" version="0.2.0"> Asynchronous variant of #osinfo_install_script_generate_output(). From the callback, call #osinfo_install_script_generate_output_finish() to conclude this call and get the generated script. If you are generating the script for a specific media, it is recommended that you use #osinfo_install_script_generate_output_for_media_async() instead. - + the install script the os the install script config the directory where the file containing the output script will be written @@ -6619,7 +6577,7 @@ you use #osinfo_install_script_generate_output_for_media_async() instead. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -6630,7 +6588,7 @@ you use #osinfo_install_script_generate_output_for_media_async() instead. scope="async" closure="5"> Function to call when result of this call is ready @@ -6639,7 +6597,7 @@ you use #osinfo_install_script_generate_output_for_media_async() instead. nullable="1" allow-none="1"> The user data to pass to @callback, or %NULL @@ -6649,24 +6607,23 @@ you use #osinfo_install_script_generate_output_for_media_async() instead. c:identifier="osinfo_install_script_generate_output_finish" version="0.2.3" throws="1"> - + a file containing the script, or NULL on error the install script a #GAsyncResult @@ -6677,38 +6634,37 @@ you use #osinfo_install_script_generate_output_for_media_async() instead. version="0.2.12" throws="1"> Creates an install script that is written to the returned file. - + a file containing the script. the install script the media the install script config the directory where the file containing the output script will be written @@ -6718,7 +6674,7 @@ you use #osinfo_install_script_generate_output_for_media_async() instead. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -6728,38 +6684,37 @@ you use #osinfo_install_script_generate_output_for_media_async() instead. c:identifier="osinfo_install_script_generate_output_for_media_async" version="0.2.12"> Asynchronous variant of #osinfo_install_script_generate_output_for_media(). From the callback, call #osinfo_install_script_generate_output_for_media_finish() to conclude this call and get the generated file. - + the install script the media the install script config the directory where the file containing the output script will be written @@ -6769,7 +6724,7 @@ call and get the generated file. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -6780,7 +6735,7 @@ call and get the generated file. scope="async" closure="5"> Function to call when result of this call is ready @@ -6789,7 +6744,7 @@ call and get the generated file. nullable="1" allow-none="1"> The user data to pass to @callback, or %NULL @@ -6799,24 +6754,23 @@ call and get the generated file. c:identifier="osinfo_install_script_generate_output_for_media_finish" version="0.2.12" throws="1"> - + a file containing the script, or NULL on error. the install script a #GAsyncResult @@ -6827,38 +6781,37 @@ call and get the generated file. version="1.6.0" throws="1"> Creates an install script that is written to the returned file. - + a file containing the script. the install script the tree the install script config the directory where the file containing the output script will be written @@ -6868,7 +6821,7 @@ call and get the generated file. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -6878,38 +6831,37 @@ call and get the generated file. c:identifier="osinfo_install_script_generate_output_for_tree_async" version="1.6.0"> Asynchronous variant of #osinfo_install_script_generate_output_for_tree(). From the callback, call #osinfo_install_script_generate_output_for_tree_finish() to conclude this call and get the generated file. - + the install script the tree the install script config the directory where the file containing the output script will be written @@ -6919,7 +6871,7 @@ call and get the generated file. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -6930,7 +6882,7 @@ call and get the generated file. scope="async" closure="5"> Function to call when result of this call is ready @@ -6939,7 +6891,7 @@ call and get the generated file. nullable="1" allow-none="1"> The user data to pass to @callback, or %NULL @@ -6949,24 +6901,23 @@ call and get the generated file. c:identifier="osinfo_install_script_generate_output_for_tree_finish" version="1.6.0" throws="1"> - + a file containing the script, or NULL on error. the install script a #GAsyncResult @@ -6977,15 +6928,14 @@ call and get the generated file. glib:get-property="avatar-format" version="0.2.2"> Some install scripts have restrictions on the format of the user avatar. Use this method to retrieve those restrictions in the form of an #OsinfoAvatarFormat instance. - + The avatar format, or NULL if there is no restrictions on the format of avatar @@ -6993,7 +6943,7 @@ this method to retrieve those restrictions in the form of an the install script @@ -7003,22 +6953,21 @@ this method to retrieve those restrictions in the form of an c:identifier="osinfo_install_script_get_can_post_install_drivers" version="0.2.2"> Whether install script can install drivers at the very end of installation This can be used for installing devices which the OS in question does not have out of the box support. - + TRUE if install script supports post-installable drivers, FALSE otherwise. the install script @@ -7028,23 +6977,22 @@ have out of the box support. c:identifier="osinfo_install_script_get_can_pre_install_drivers" version="0.2.2"> Whether install script can install drivers at the very beginning of installation. This is needed for devices for which the OS in question does not have out of the box support for and devices are required/preferred to be available during actual installation. - + TRUE if install script supports pre-installable drivers, FALSE otherwise. the install script @@ -7054,13 +7002,12 @@ available during actual installation. c:identifier="osinfo_install_script_get_config_param" version="0.2.1"> Get a config param from the config param's list - + the sought config param, if exists. NULL otherwise. @@ -7071,13 +7018,13 @@ the same. the install script name of the parameter @@ -7087,13 +7034,12 @@ the same. c:identifier="osinfo_install_script_get_config_param_list" version="0.2.0"> Get the list of valid config parameters for @script. - + the list of valid #OsinfoInstallConfigParam parameters. Free with g_list_free() when done. The elements are owned by libosinfo. @@ -7104,7 +7050,7 @@ g_list_free() when done. The elements are owned by libosinfo. the install script @@ -7114,13 +7060,12 @@ g_list_free() when done. The elements are owned by libosinfo. c:identifier="osinfo_install_script_get_config_params" version="0.2.3"> Get the list of valid config parameters for @script. - + the list of valid #OsinfoInstallConfigParam parameters. the install script @@ -7139,21 +7084,20 @@ parameters. c:identifier="osinfo_install_script_get_expected_filename" version="0.2.1"> Some operating systems (as Windows) expect that script filename has particular name to work. - + the expected script filename the install script @@ -7163,13 +7107,12 @@ particular name to work. c:identifier="osinfo_install_script_get_injection_methods" version="0.2.10"> Retrieve the supported method to inject the script in to the installation process. - + bitwise-or of supported methods for install script injection. @@ -7177,7 +7120,7 @@ supported methods for install script injection. the install script @@ -7187,11 +7130,10 @@ supported methods for install script injection. c:identifier="osinfo_install_script_get_installation_source" glib:get-property="installation-source" version="1.3.0"> - + the installation source to be used with the script. If none is set, it defaults to OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_MEDIA. the install script @@ -7210,13 +7152,12 @@ OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_MEDIA. c:identifier="osinfo_install_script_get_needs_internet" version="0.2.11"> Some install scripts cannot ensure that they work without an internet connection. - + TRUE if script needs an internet connection, FALSE otherwise internet connection. @@ -7224,7 +7165,7 @@ internet connection. the install script @@ -7234,23 +7175,22 @@ internet connection. c:identifier="osinfo_install_script_get_output_filename" version="0.2.0"> Some operating systems are able to use any script filename, allowing the application to set the filename as desired. libosinfo provides this functionality by set the expected filename's prefix using osinfo_install_script_set_output_prefix() function. - + the output script filename the install script @@ -7259,18 +7199,17 @@ osinfo_install_script_set_output_prefix() function. - + the prefix of the file generated the install script @@ -7281,14 +7220,13 @@ osinfo_install_script_set_output_prefix() function. glib:get-property="path-format" version="0.2.2"> Returns the path format to be used for the files and disks which will be used during the installation. - + the path format to be used. OSINFO_PATH_FORMAT_UNIX is the default option. @@ -7296,7 +7234,7 @@ be used during the installation. the install script @@ -7306,18 +7244,17 @@ be used during the installation. c:identifier="osinfo_install_script_get_post_install_drivers_signing_req" version="0.2.6"> If install script can install drivers at the end of installation, this function retrieves the requirement about signed status of drivers. - + the install script @@ -7327,18 +7264,17 @@ function retrieves the requirement about signed status of drivers. c:identifier="osinfo_install_script_get_pre_install_drivers_signing_req" version="0.2.6"> If install script can install drivers at the very beginning of installation, this function retrieves the requirement about signed status of drivers. - + the install script @@ -7348,11 +7284,10 @@ this function retrieves the requirement about signed status of drivers. c:identifier="osinfo_install_script_get_preferred_injection_method" glib:get-property="preferred-injection-method" version="1.3.0"> - + the preferred injection method for the script. If none is set and OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_DISK is supported, OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_DISK is returned, otherwise @@ -7363,7 +7298,7 @@ OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_INITRD is returned. the install script @@ -7374,7 +7309,7 @@ OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_INITRD is returned. glib:get-property="product-key-format" version="0.2.2"> If this function returns a non-NULL string, it means that the @script requires you to specify product registration key through #OsinfoInstallConfig instance passed to script generation methods. @@ -7392,18 +7327,17 @@ For example in case of installer for Microsoft Windows XP, you'll get "$$$$$-$$$$$-$$$$$-$$$$$-$$$$$". That means a product key consists of 24 alphanumeric characters and 4 '-' characters at (0-based) indices 5, 11, 17 and 23. - + Product key format mask, or NULL. the install script @@ -7414,21 +7348,20 @@ and 23. glib:get-property="profile" version="0.2.0"> Returns a string representing the install script profile that's going to be used. The values supported are "jeos" for minimal installations and "desktop" for workstation/desktop installations. - + the install script @@ -7439,17 +7372,16 @@ workstation/desktop installations. glib:get-property="template-data" version="0.2.0"> Returns the stylesheet data used to construct the install script. - + the install script @@ -7460,17 +7392,16 @@ workstation/desktop installations. glib:get-property="template-uri" version="0.2.0"> Returns the stylesheet URI used to construct the install script. - + the install script @@ -7480,25 +7411,24 @@ workstation/desktop installations. c:identifier="osinfo_install_script_has_config_param" version="0.2.0"> Returns whether the @script has the @config_param searched or not. This code assumes that the 'id' and 'name' entity properties are the same. - + the install script an #OsinfoInstallConfigParam @@ -7509,23 +7439,22 @@ This code assumes that the 'id' and 'name' entity properties are the same. c:identifier="osinfo_install_script_has_config_param_name" version="0.2.0"> Returns whether the @script has a configuration parameter matching @name or not. - + the install script the configuration parameter name @@ -7535,23 +7464,22 @@ This code assumes that the 'id' and 'name' entity properties are the same. c:identifier="osinfo_install_script_set_installation_source" version="1.3.0"> Set the installation source to be used with the @script. - + the install script one of the installation sources: OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_MEDIA, OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_NETWORK @@ -7564,23 +7492,22 @@ OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_NETWORK c:identifier="osinfo_install_script_set_output_prefix" version="0.2.0"> Mind that not all installers support any name for the installer scripts. - + the install script a prefix to be added to the file generated @@ -7591,23 +7518,22 @@ OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_NETWORK glib:set-property="preferred-injection-method" version="1.3.0"> Set the preferred injection method to be used with the @script - + the install script one of the injection methods: OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_CDROM, OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_DISK, @@ -7626,45 +7552,52 @@ OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_WEB + getter="get_installation_source" + default-value="OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_MEDIA"> + getter="get_path_format" + default-value="OSINFO_PATH_FORMAT_UNIX"> + getter="get_preferred_injection_method" + default-value="OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_DISK"> + getter="get_product_key_format" + default-value="NULL"> + getter="get_profile" + default-value="NULL"> + getter="get_template_data" + default-value="NULL"> + getter="get_template_uri" + default-value="NULL"> @@ -7678,7 +7611,7 @@ OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_WEB - + @@ -7694,9 +7627,9 @@ OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_WEB glib:nick="cdrom" glib:name="OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_CDROM"> Support injection of the -installation script trough a CD-ROM. +installation script through a CD-ROM. glib:nick="disk" glib:name="OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_DISK"> Support injection of the -installation script trough a disk. +installation script through a disk. glib:nick="floppy" glib:name="OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_FLOPPY"> Support injection of the -installation script trough a floppy disk. +installation script through a floppy disk. glib:nick="initrd" glib:name="OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_INITRD"> Support injection of the -installation script trough the initrd. +installation script through the initrd. glib:nick="web" glib:name="OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_WEB"> Support injection of the installation script from the web. @@ -7750,7 +7683,7 @@ installation script from the web. glib:nick="media" glib:name="OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_MEDIA"> A media will be used as the installation source. @@ -7760,7 +7693,7 @@ the installation source. glib:nick="network" glib:name="OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_NETWORK"> A network method will be used as installation source. @@ -7772,19 +7705,19 @@ be used as installation source. glib:type-name="OsinfoInstallScriptList" glib:get-type="osinfo_install_scriptlist_get_type" glib:type-struct="InstallScriptListClass"> - Construct a new install_script list that is initially empty. - an empty install_script list @@ -7795,22 +7728,22 @@ be used as installation source. deprecated="1" deprecated-version="0.2.2"> Construct a new install_script list that is filled with install_scripts from @source Use osinfo_list_new_copy() instead. - a copy of the install_script list the install_script list to copy @@ -7822,28 +7755,28 @@ from @source deprecated="1" deprecated-version="0.2.2"> Construct a new install_script list that is filled with install_scripts from @source that match @filter Use osinfo_list_new_filtered() instead. - a filtered copy of the install_script list the install_script list to copy the filter to apply @@ -7855,28 +7788,28 @@ from @source that match @filter deprecated="1" deprecated-version="0.2.2"> Construct a new install_script list that is filled with only the install_scripts that are present in both @sourceOne and @sourceTwo. Use osinfo_list_new_intersection() instead. - an intersection of the two install_script lists the first install_script list to copy the second install_script list to copy @@ -7888,28 +7821,28 @@ install_scripts that are present in both @sourceOne and @sourceTwo. deprecated="1" deprecated-version="0.2.2"> Construct a new install_script list that is filled with all the install_scripts that are present in either @sourceOne and @sourceTwo. Use osinfo_list_new_union() instead. - a union of the two install_script lists the first install_script list to copy the second install_script list to copy @@ -7926,7 +7859,7 @@ install_scripts that are present in either @sourceOne and @sourceTwo. - @@ -7934,17 +7867,19 @@ install_scripts that are present in either @sourceOne and @sourceTwo. - + - + disguised="1" + opaque="1"> + - + glib:type-name="OsinfoList" glib:get-type="osinfo_list_get_type" glib:type-struct="ListClass"> - + Adds a new entity to the list. - + the entity list the entity to add to the list @@ -7981,24 +7916,24 @@ install_scripts that are present in either @sourceOne and @sourceTwo. Adds all entities from @source to @list. Using one of the constructors in a subclass is preferable to this method. - + the entity list the list to add @@ -8006,30 +7941,30 @@ to this method. Adds all entities from @source which are matched by @filter. Using one of the constructors in a subclass is preferable to this method. - + the entity list the source for elements filter to process the source with @@ -8038,31 +7973,31 @@ to this method. Computes the intersection between @sourceOne and @sourceTwo and adds the resulting list of entities to the @list. Using one of the constructors in a subclass is preferable to this method. - + the entity list the first list to add the second list to add @@ -8070,31 +8005,31 @@ to this method. Computes the union between @sourceOne and @sourceTwo and adds the resulting list of entities to the @list. Using one of the constructors in a subclass is preferable to this method. - + the entity list the first list to add the second list to add @@ -8102,26 +8037,26 @@ to this method. Search the list looking for the entity with a matching unique identifier. - + the matching entity, or NULL the entity list the unique identifier @@ -8131,20 +8066,20 @@ unique identifier. c:identifier="osinfo_list_get_element_type" glib:get-property="element-type"> Retrieves the type of the subclass of #OsinfoEntity that may be stored in the list - + the type of entity stored the entity list @@ -8152,12 +8087,12 @@ that may be stored in the list Retrieve a linked list of all elements in the list. - + the list elements @@ -8166,7 +8101,7 @@ that may be stored in the list the entity list @@ -8174,20 +8109,20 @@ that may be stored in the list Retrieves the number of elements currently stored in the list - + the list length the entity list @@ -8195,27 +8130,27 @@ in the list Retrieves the element in the list at position @idx. If @idx is less than zero, or greater than the number of elements in the list, the results are undefined. - + the list element or %NULL the entity list the list position to fetch @@ -8225,19 +8160,19 @@ elements in the list, the results are undefined. c:identifier="osinfo_list_new_copy" version="0.2.2"> Construct a new list that is filled with elements from @source - + a copy of the list the list to copy @@ -8247,26 +8182,26 @@ elements in the list, the results are undefined. c:identifier="osinfo_list_new_filtered" version="0.2.2"> Construct a new list that is filled with elements from @source that match @filter - + a filtered copy of the list the list to copy the filter to apply @@ -8276,26 +8211,26 @@ match @filter c:identifier="osinfo_list_new_intersection" version="0.2.2"> Construct a new list that is filled with only the elements that are present in both @sourceOne and @sourceTwo. - + an intersection of the two lists the first list to copy the second list to copy @@ -8305,27 +8240,27 @@ that are present in both @sourceOne and @sourceTwo. c:identifier="osinfo_list_new_union" version="0.2.2"> Construct a new list that is filled with all the that are present in either @sourceOne and @sourceTwo. @sourceOne and @sourceTwo must be of the same type. - + a union of the two lists the first list to copy the second list to copy @@ -8337,7 +8272,7 @@ the same type. transfer-ownership="none" getter="get_element_type"> The specialization of the list. The list will be restricted to storing #OsinfoEntity objects of the specified type. @@ -8353,13 +8288,16 @@ the specified type. - + - - + + glib:type-name="OsinfoLoader" glib:get-type="osinfo_loader_get_type" glib:type-struct="LoaderClass"> - + Create a new database loader - + a loader object Retrieves the database being populated - + the database the loader object @@ -8404,7 +8342,7 @@ the specified type. - + @@ -8419,16 +8357,16 @@ the specified type. version="0.2.8" throws="1"> Loads data from the local path. - + the loader object @@ -8438,25 +8376,25 @@ the specified type. c:identifier="osinfo_loader_process_path" throws="1"> Loads data from the specified path. If the path points to a file, that will be loaded as XML Otherwise it can point to a directory which will be recursively traversed, loading all files as XML. - + the loader object the fully qualified path @@ -8467,16 +8405,16 @@ be recursively traversed, loading all files as XML. version="0.2.8" throws="1"> Loads data from the system path. - + the loader object @@ -8486,25 +8424,25 @@ be recursively traversed, loading all files as XML. c:identifier="osinfo_loader_process_uri" throws="1"> Loads data from the specified URI. If the URI points to a file, that will be loaded as XML Otherwise it can point to a directory which will be recursively traversed, loading all files as XML. - + the loader object the data source URI @@ -8515,16 +8453,16 @@ be recursively traversed, loading all files as XML. version="0.2.8" throws="1"> Loads data from user path. - + the loader object @@ -8540,153 +8478,156 @@ be recursively traversed, loading all files as XML. - + - - + + libosinfo major version number. - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + libosinfo micro version number. - + libosinfo minor version number. - + glib:type-name="OsinfoMedia" glib:get-type="osinfo_media_get_type" glib:type-struct="MediaClass"> - + - + @@ -8715,22 +8656,22 @@ be recursively traversed, loading all files as XML. c:identifier="osinfo_media_create_from_location" throws="1"> Creates a new #OsinfoMedia for installation media at @location. The @location could be a http:// or a https:// URI or a local path. NOTE: Currently this only works for ISO images/devices. - + a new #OsinfoMedia , or NULL on error the location of an installation media @@ -8739,7 +8680,7 @@ NOTE: Currently this only works for ISO images/devices. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -8748,22 +8689,22 @@ NOTE: Currently this only works for ISO images/devices. Asynchronous variant of #osinfo_media_create_from_location. - + the location of an installation media the I/O priority of the request @@ -8772,7 +8713,7 @@ NOTE: Currently this only works for ISO images/devices. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -8783,7 +8724,7 @@ NOTE: Currently this only works for ISO images/devices. scope="async" closure="4"> Function to call when result of this call is ready @@ -8792,7 +8733,7 @@ NOTE: Currently this only works for ISO images/devices. nullable="1" allow-none="1"> The user data to pass to @callback, or %NULL @@ -8803,20 +8744,20 @@ NOTE: Currently this only works for ISO images/devices. version="1.6.0" throws="1"> Finishes an asynchronous media object creation process started with #osinfo_media_create_from_location_async. - + a new #OsinfoMedia , or NULL on error a #GAsyncResult @@ -8827,22 +8768,22 @@ NOTE: Currently this only works for ISO images/devices. version="1.6.0" throws="1"> Creates a new #OsinfoMedia for installation media at @location. The @location could be a http:// or a https:// URI or a local path. NOTE: Currently this only works for ISO images/devices. - + a new #OsinfoMedia , or NULL on error the location of an installation media @@ -8851,13 +8792,13 @@ NOTE: Currently this only works for ISO images/devices. nullable="1" allow-none="1"> a #GCancellable, or %NULL An #OsinfoMediaDetectFlag, or 0. @@ -8867,22 +8808,22 @@ NOTE: Currently this only works for ISO images/devices. c:identifier="osinfo_media_create_from_location_with_flags_async" version="1.6.0"> Asynchronous variant of #osinfo_media_create_from_location_with_flags. - + the location of an installation media the I/O priority of the request @@ -8891,7 +8832,7 @@ NOTE: Currently this only works for ISO images/devices. nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -8902,13 +8843,13 @@ NOTE: Currently this only works for ISO images/devices. scope="async" closure="5"> Function to call when result of this call is ready An #OsinfoMediaDetectFlag, or 0. @@ -8917,7 +8858,7 @@ NOTE: Currently this only works for ISO images/devices. nullable="1" allow-none="1"> The user data to pass to @callback, or %NULL @@ -8927,20 +8868,20 @@ NOTE: Currently this only works for ISO images/devices. c:identifier="osinfo_media_create_from_location_with_flags_finish" throws="1"> Finishes an asynchronous media object creation process started with #osinfo_media_create_from_location_async. - + a new #OsinfoMedia , or NULL on error a #GAsyncResult @@ -8950,22 +8891,22 @@ NOTE: Currently this only works for ISO images/devices. c:identifier="osinfo_media_add_install_script" version="1.4.0"> Adds an @script to the specified @media - + an #OsinfoMedia instance an #OsinfoInstallScript instance @@ -8975,24 +8916,24 @@ NOTE: Currently this only works for ISO images/devices. c:identifier="osinfo_media_get_application_id" glib:get-property="application-id"> If @media is an ISO9660 image/device, this function retrieves the expected application ID. Note: In practice, this will usually not be the exact copy of the application ID string on the ISO image/device but rather a regular expression that matches it. - + the application id, or NULL an #OsinfoMedia instance @@ -9002,19 +8943,19 @@ matches it. c:identifier="osinfo_media_get_architecture" glib:get-property="architecture"> Retrieves the target hardware architecture of the OS @media provides. - + the hardware architecture, or NULL an #OsinfoMedia instance @@ -9025,19 +8966,19 @@ matches it. glib:get-property="eject-after-install" version="0.2.13"> Whether @media should ejected after the installation procces. - + #TRUE if media should be ejected, #FALSE otherwise an #OsinfoMedia instance @@ -9047,21 +8988,21 @@ matches it. c:identifier="osinfo_media_get_initrd_path" glib:get-property="initrd-path"> Retrieves the path to the initrd image in the install tree. Note: This only applies to installer medias of 'linux' OS family. - + the path to initrd image, or NULL an #OsinfoMedia instance @@ -9070,17 +9011,17 @@ Note: This only applies to installer medias of 'linux' OS family. - + a list of the install scripts for the specified media an #OsinfoMedia instance @@ -9091,19 +9032,19 @@ Note: This only applies to installer medias of 'linux' OS family. glib:get-property="installer" version="0.0.3"> Whether @media provides an installer for an OS. - + #TRUE if media is installer, #FALSE otherwise an #OsinfoMedia instance @@ -9114,7 +9055,7 @@ Note: This only applies to installer medias of 'linux' OS family. glib:get-property="installer-reboots" version="0.2.1"> If media is an installer, this method retrieves the number of reboots the installer takes before installation is complete. @@ -9124,17 +9065,17 @@ that. Warning: Some media allow you to install from live sessions, in which case number of reboots *alone* is not a reliable method for tracking installation. - + the number of installer reboots or -1 if media is not an installer an #OsinfoMedia instance @@ -9144,21 +9085,21 @@ number of reboots *alone* is not a reliable method for tracking installation. Retrieves the path to the kernel image in the install tree. Note: This only applies to installer medias of 'linux' OS family. - + the path to kernel image, or NULL an #OsinfoMedia instance @@ -9169,7 +9110,7 @@ Note: This only applies to installer medias of 'linux' OS family. glib:get-property="languages" version="0.2.3"> If media is an installer, this property indicates the languages that can be used during automatic installations. @@ -9177,10 +9118,10 @@ On media that are not installers, this property will indicate the languages that the user interface can be displayed in. Use #osinfo_media_get_installer(or OsinfoMedia::installer) to know if the media is an installer or not. - + a #GList containing the list of the UI languages this media supports. The list must be freed with g_list_free() when no longer needed. If the @@ -9192,7 +9133,7 @@ supported languages are unknown, NULL will be returned. an #OsinfoMedia instance @@ -9203,19 +9144,19 @@ supported languages are unknown, NULL will be returned. glib:get-property="live" version="0.0.3"> Whether @media can boot directly an OS without any installations. - + #TRUE if media is live, #FALSE otherwise an #OsinfoMedia instance @@ -9225,17 +9166,17 @@ supported languages are unknown, NULL will be returned. c:identifier="osinfo_media_get_os" glib:get-property="os" version="0.2.3"> - + the operating system, or NULL an #OsinfoMedia instance @@ -9245,19 +9186,19 @@ supported languages are unknown, NULL will be returned. c:identifier="osinfo_media_get_os_variants" version="0.2.9"> Gets the variants of the associated operating system. - + the operating system variant, or NULL an #OsinfoMedia instance @@ -9267,24 +9208,24 @@ supported languages are unknown, NULL will be returned. c:identifier="osinfo_media_get_publisher_id" glib:get-property="publisher-id"> If @media is an ISO9660 image/device, this function retrieves the expected publisher ID. Note: In practice, this will usually not be the exact copy of the publisher ID string on the ISO image/device but rather a regular expression that matches it. - + the publisher id, or NULL an #OsinfoMedia instance @@ -9294,24 +9235,24 @@ matches it. c:identifier="osinfo_media_get_system_id" glib:get-property="system-id"> If @media is an ISO9660 image/device, this function retrieves the expected system ID. Note: In practice, this will usually not be the exact copy of the system ID string on the ISO image/device but rather a regular expression that matches it. - + the system id, or NULL an #OsinfoMedia instance @@ -9321,19 +9262,19 @@ it. c:identifier="osinfo_media_get_url" glib:get-property="url"> The URL to the @media - + the URL, or NULL an #OsinfoMedia instance @@ -9343,24 +9284,24 @@ it. c:identifier="osinfo_media_get_volume_id" glib:get-property="volume-id"> If @media is an ISO9660 image/device, this function retrieves the expected volume ID. Note: In practice, this will usually not be the exact copy of the volume ID string on the ISO image/device but rather a regular expression that matches it. - + the volume id, or NULL an #OsinfoMedia instance @@ -9369,10 +9310,10 @@ it. - + the ISO9660 volume size, in bytes or -1 if size is unknown or media is not an ISO9660 device/image. @@ -9380,7 +9321,7 @@ unknown or media is not an ISO9660 device/image. an #OsinfoMedia instance @@ -9389,17 +9330,17 @@ unknown or media is not an ISO9660 device/image. - + #TRUE if the @media is bootable. #FALSE otherwise. and #OsinfoMedia instance @@ -9409,29 +9350,29 @@ unknown or media is not an ISO9660 device/image. c:identifier="osinfo_media_matches" version="1.10.0"> Determines whether the metadata for the unidentified @media is a match for the @reference media. The metadata in the unidentified @media must be literal strings, while the metadata in the @reference media must be regular expressions. - + #TRUE if @media is a match for @reference. #FALSE otherwise an unidentified #OsinfoMedia instance a reference #OsinfoMedia instance @@ -9441,12 +9382,12 @@ while the metadata in the @reference media must be regular expressions. c:identifier="osinfo_media_supports_installer_script" version="1.3.0"> Whether @media supports installation using install scripts. - + #TRUE if install-scripts are supported by the media, #FALSE otherwise @@ -9454,7 +9395,7 @@ while the metadata in the @reference media must be regular expressions. an #OsinfoMedia instance @@ -9463,27 +9404,30 @@ while the metadata in the @reference media must be regular expressions. + getter="get_application_id" + default-value="NULL"> Expected application ID (regular expression) for ISO9660 image/device. + getter="get_architecture" + default-value="NULL"> The target hardware architecture of this media. + getter="get_eject_after_install" + default-value="TRUE"> Whether the media should be ejected after the installation process. Some distros need their media to not be ejected after the final reboot @@ -9495,27 +9439,30 @@ application). + getter="get_initrd_path" + default-value="NULL"> The path to the initrd image in the install tree. + getter="get_installer" + default-value="TRUE"> Whether media provides an installer for an OS. + getter="get_installer_reboots" + default-value="1"> If media is an installer, this property indicates the number of reboots the installer takes before installation is complete. @@ -9528,9 +9475,12 @@ case number of reboots *alone* is not a reliable method for tracking installation. - + Whether the media supports installation via an install-script. Some distros provide a few different medias and not all the medias support @@ -9540,9 +9490,10 @@ installation via an install script. + getter="get_kernel_path" + default-value="NULL"> The path to the kernel image in the install tree. @@ -9550,7 +9501,7 @@ installation via an install script. transfer-ownership="container" getter="get_languages"> If media is an installer, this property indicates the languages that can be used during automatic installations. @@ -9565,9 +9516,10 @@ if the media is an installer or not. + getter="get_live" + default-value="FALSE"> Whether media can boot directly an OS without any installations. @@ -9576,7 +9528,7 @@ if the media is an installer or not. transfer-ownership="none" getter="get_os"> Os information for the current media. For media stored in an #OsinfoDb, it will be filled when the database is loaded, otherwise the property will be filled after a successful call to @@ -9586,45 +9538,50 @@ osinfo_db_identify_media(). + getter="get_publisher_id" + default-value="NULL"> Expected publisher ID (regular expression) for ISO9660 image/device. + getter="get_system_id" + default-value="NULL"> Expected system ID (regular expression) for ISO9660 image/device. + getter="get_url" + default-value="NULL"> The URL to this media. + getter="get_volume_id" + default-value="NULL"> Expected volume ID (regular expression) for ISO9660 image/device. + getter="get_volume_size" + default-value="-1"> Expected volume size, in bytes for ISO9660 image/device. @@ -9638,7 +9595,7 @@ osinfo_db_identify_media(). - + @@ -9649,7 +9606,7 @@ osinfo_db_identify_media(). glib:get-type="osinfo_media_detect_flags_get_type" c:type="OsinfoMediaDetectFlags"> OSINFO_MEDIA_DETECT_REQUIRE_BOOTABLE: Requires a media to be bootable. Flags used for detecting a media. c:type="OsinfoMediaError" glib:error-domain="osinfo-media-error"> #GError codes used for errors in the #OSINFO_MEDIA_ERROR domain, during reading of data from install media location. glib:nick="no-descriptors" glib:name="OSINFO_MEDIA_ERROR_NO_DESCRIPTORS"> No descriptors. glib:nick="no-pvd" glib:name="OSINFO_MEDIA_ERROR_NO_PVD"> No Primary volume descriptor. glib:nick="no-svd" glib:name="OSINFO_MEDIA_ERROR_NO_SVD"> No supplementary volume descriptor. glib:nick="insufficient-metadata" glib:name="OSINFO_MEDIA_ERROR_INSUFFICIENT_METADATA"> Not enough metadata. glib:nick="not-bootable" glib:name="OSINFO_MEDIA_ERROR_NOT_BOOTABLE"> Install media not bootable. glib:nick="no-directory-record-extent" glib:name="OSINFO_MEDIA_ERROR_NO_DIRECTORY_RECORD_EXTENT"> No directory record extent found. @@ -9736,15 +9693,15 @@ found. glib:type-name="OsinfoMediaList" glib:get-type="osinfo_medialist_get_type" glib:type-struct="MediaListClass"> - + Construct a new media list that is initially empty. - + an empty media list @@ -9754,21 +9711,21 @@ found. deprecated="1" deprecated-version="0.2.2"> Construct a new media list that is filled with medias from @source Use osinfo_list_new_copy() instead. - + a copy of the media list the media list to copy @@ -9779,27 +9736,27 @@ from @source deprecated="1" deprecated-version="0.2.2"> Construct a new media list that is filled with medias from @source that match @filter Use osinfo_list_new_filtered() instead. - + a filtered copy of the media list the media list to copy the filter to apply @@ -9810,27 +9767,27 @@ from @source that match @filter deprecated="1" deprecated-version="0.2.2"> Construct a new media list that is filled with only the medias that are present in both @sourceOne and @sourceTwo. Use osinfo_list_new_intersection() instead. - + an intersection of the two media lists the first media list to copy the second media list to copy @@ -9841,27 +9798,27 @@ medias that are present in both @sourceOne and @sourceTwo. deprecated="1" deprecated-version="0.2.2"> Construct a new media list that is filled with all the medias that are present in either @sourceOne and @sourceTwo. Use osinfo_list_new_union() instead. - + a union of the two media lists the first media list to copy the second media list to copy @@ -9877,53 +9834,57 @@ medias that are present in either @sourceOne and @sourceTwo. - + - + disguised="1" + opaque="1"> + - - + + - + - + - + - + - + - + glib:type-name="OsinfoOs" glib:get-type="osinfo_os_get_type" glib:type-struct="OsClass"> - + Create a new operating system entity - + a new operating system entity a unique identifier @@ -9956,27 +9917,27 @@ medias that are present in either @sourceOne and @sourceTwo. Associated a device with an operating system. The returned #OsinfoDeviceLink can be used to record extra metadata against the link - + the device association an operating system the device to associate with @@ -9986,22 +9947,22 @@ extra metadata against the link c:identifier="osinfo_os_add_device_driver" version="0.2.2"> Adds @driver to the list of device drivers of operating system @os. - + an operating system the device driver to add @@ -10011,22 +9972,22 @@ extra metadata against the link c:identifier="osinfo_os_add_firmware" version="1.7.0"> Adds @firmware to the list of firmwares of operating system @os. - + an operating system the firmware to add @@ -10036,22 +9997,22 @@ extra metadata against the link c:identifier="osinfo_os_add_image" version="1.3.0"> Adds an installed image @image to operating system @os. - + an operating system the image to add @@ -10061,22 +10022,22 @@ extra metadata against the link c:identifier="osinfo_os_add_install_script" version="0.2.0"> Adds @script to the list of scripts of operating system @os. - + an operating system the install script to add @@ -10086,22 +10047,22 @@ extra metadata against the link c:identifier="osinfo_os_add_maximum_resources" version="1.3.0"> Adds @resources to list of maximum resources of operating system @os. - + an operating system the resources to add @@ -10109,22 +10070,22 @@ extra metadata against the link Adds installation media @media to operating system @os. - + an operating system the media to add @@ -10133,22 +10094,22 @@ extra metadata against the link Adds @resources to list of minimum resources of operating system @os. - + an operating system the resources to add @@ -10158,23 +10119,23 @@ extra metadata against the link c:identifier="osinfo_os_add_network_install_resources" version="1.3.0"> Adds @resources to list of resources needed for network installing an operating system @os. - + an operating system the resources to add @@ -10183,22 +10144,22 @@ operating system @os. Adds @resources to list of recommended resources of operating system @os. - + an operating system the resources to add @@ -10206,22 +10167,22 @@ operating system @os. Adds installation tree @tree to operating system @os. - + an operating system the tree to add @@ -10231,22 +10192,22 @@ operating system @os. c:identifier="osinfo_os_add_variant" version="0.2.9"> Adds a variant @variant to operating system @os. - + an operating system the variant to add @@ -10255,23 +10216,23 @@ operating system @os. - + A new #OsinfoInstallScript for the @os @profile an operating system the install script profile that must be either OSINFO_INSTALL_SCRIPT_PROFILE_DESKTOP or OSINFO_INSTALL_SCRIPT_PROFILE_JEOS @@ -10282,21 +10243,21 @@ OSINFO_INSTALL_SCRIPT_PROFILE_DESKTOP or OSINFO_INSTALL_SCRIPT_PROFILE_JEOS Get all devicelinks matching a given filter but unlike osinfo_os_get_device_links this function also retrieves devices from all derived and cloned operating systems. - + A list of OsinfoDeviceLink an operating system @@ -10305,7 +10266,7 @@ derived and cloned operating systems. nullable="1" allow-none="1"> an optional device property filter @@ -10315,21 +10276,21 @@ derived and cloned operating systems. c:identifier="osinfo_os_get_all_devices" version="0.0.5"> Get all devices matching a given filter but unlike osinfo_os_get_devices this function also retrieves devices from all derived and cloned operating systems. - + A list of devices an operating system @@ -10338,7 +10299,7 @@ systems. nullable="1" allow-none="1"> an optional device property filter @@ -10348,20 +10309,20 @@ systems. c:identifier="osinfo_os_get_cloud_image_username" glib:get-property="cloud-image-username"> Gets the username expected to be passed to the cloud image when performing installation. - + the username, if present. Otherwise, NULL. an operating system @@ -10371,19 +10332,19 @@ installation. c:identifier="osinfo_os_get_complete_firmware_list" version="1.10.0"> Get the complete firmwares matching a given filter, including the non-supported ones. - + A list of firmwares an operating system @@ -10392,7 +10353,7 @@ installation. nullable="1" allow-none="1"> an optional firmware property filter @@ -10402,19 +10363,19 @@ installation. c:identifier="osinfo_os_get_device_drivers" version="0.2.2"> Gets list of all available device drivers for OS @os. - + A list of device drivers an operating system @@ -10424,19 +10385,19 @@ installation. c:identifier="osinfo_os_get_device_drivers_prioritized" version="1.7.0"> Gets list of the highest priority device drivers for OS @os. - + A list of device drivers an operating system @@ -10445,20 +10406,20 @@ installation. Get all devices matching a given filter. The filter matches against the links, not the devices. - + A list of device links an operating system @@ -10467,7 +10428,7 @@ matches against the links, not the devices. nullable="1" allow-none="1"> an optional device property filter @@ -10475,19 +10436,19 @@ matches against the links, not the devices. Get all devices matching a given filter - + A list of devices an operating system @@ -10496,7 +10457,7 @@ matches against the links, not the devices. nullable="1" allow-none="1"> an optional device property filter @@ -10506,38 +10467,38 @@ matches against the links, not the devices. c:identifier="osinfo_os_get_devices_by_property" version="0.0.6"> A utility function that gets devices found from the list of devices @os supports, for which the value of @property is @value. - + The found devices an operating system the property of interest the required value of property @property Should devices from inherited and cloned OSs be included in the search. @@ -10548,20 +10509,20 @@ search. c:identifier="osinfo_os_get_distro" glib:get-property="distro"> Retrieves the generic family the OS @os belongs to, for example fedora, ubuntu, windows, solaris, freebsd etc. - + the distro of this os an #OsinfoOs @@ -10571,20 +10532,20 @@ ubuntu, windows, solaris, freebsd etc. c:identifier="osinfo_os_get_family" glib:get-property="family"> Retrieves the generic family the OS @os belongs to, based upon its kernel, for example linux, winnt, solaris, freebsd etc. - + the family of this os an #OsinfoOs @@ -10594,19 +10555,19 @@ for example linux, winnt, solaris, freebsd etc. c:identifier="osinfo_os_get_firmware_list" version="1.7.0"> Get all the supported firmwares matching a given filter - + A list of firmwares an operating system @@ -10615,7 +10576,7 @@ for example linux, winnt, solaris, freebsd etc. nullable="1" allow-none="1"> an optional firmware property filter @@ -10625,19 +10586,19 @@ for example linux, winnt, solaris, freebsd etc. c:identifier="osinfo_os_get_image_list" version="1.3.0"> Get all installed images associated with operating system @os. - + A list of images an operating system @@ -10646,17 +10607,17 @@ for example linux, winnt, solaris, freebsd etc. - + a list of the install scripts for the specified os an operating system @@ -10666,13 +10627,13 @@ for example linux, winnt, solaris, freebsd etc. c:identifier="osinfo_os_get_kernel_url_argument" glib:get-property="kernel-url-argument"> Gets the argument expected to be passed to the kernel command line when performing a tree based installation. - + the kernel url argument, if present. Otherwise, NULL. @@ -10680,7 +10641,7 @@ NULL. an operating system @@ -10690,19 +10651,19 @@ NULL. c:identifier="osinfo_os_get_maximum_resources" version="1.3.0"> Get the list of maximum resources for the operating system @os. - + A list of resources an operating system @@ -10710,19 +10671,19 @@ NULL. Get all installation medias associated with operating system @os. - + A list of medias an operating system @@ -10731,19 +10692,19 @@ NULL. Get the list of minimum required resources for the operating system @os. - + A list of resources an operating system @@ -10753,20 +10714,20 @@ NULL. c:identifier="osinfo_os_get_network_install_resources" version="1.3.0"> Get the list of resources needed for network installing an operating system @os. - + A list of resources an operating system @@ -10775,19 +10736,19 @@ NULL. Get the list of recommended resources for the operating system @os. - + A list of resources an operating system @@ -10797,19 +10758,19 @@ NULL. c:identifier="osinfo_os_get_release_status" version="0.2.9"> Use this to determine the release status of the @os. - + release status of @os. an #OsinfoOs @@ -10817,19 +10778,19 @@ NULL. Get all installation trees associated with operating system @os. - + A list of trees an operating system @@ -10839,19 +10800,19 @@ NULL. c:identifier="osinfo_os_get_variant_list" version="0.2.9"> Gets all known variants of operating system @os. - + A list of variants an operating system @@ -10859,31 +10820,39 @@ NULL. + getter="get_cloud_image_username" + default-value="NULL"> The username to be passed to the cloud-init program. - + The generic distro this OS belongs to, for example fedora, windows, solaris, freebsd etc. - + The generic family this OS belongs to, based upon its kernel, for example linux, winnt, solaris, freebsd etc. + getter="get_kernel_url_argument" + default-value="NULL"> The argument to be passed to kernel command line when performing a tree based installation of this OS. @@ -10898,7 +10867,7 @@ tree based installation of this OS. - + @@ -10910,15 +10879,15 @@ tree based installation of this OS. glib:type-name="OsinfoOsList" glib:get-type="osinfo_oslist_get_type" glib:type-struct="OsListClass"> - + Construct a new os list that is initially empty. - + an empty os list @@ -10928,21 +10897,21 @@ tree based installation of this OS. deprecated="1" deprecated-version="0.2.2"> Construct a new os list that is filled with oss from @source Use osinfo_list_new_copy() instead. - + a copy of the os list the os list to copy @@ -10953,27 +10922,27 @@ from @source deprecated="1" deprecated-version="0.2.2"> Construct a new os list that is filled with oss from @source that match @filter Use osinfo_list_new_filtered() instead. - + a filtered copy of the os list the os list to copy the filter to apply @@ -10984,27 +10953,27 @@ from @source that match @filter deprecated="1" deprecated-version="0.2.2"> Construct a new os list that is filled with only the oss that are present in both @sourceOne and @sourceTwo. Use osinfo_list_new_intersection() instead. - + an intersection of the two os lists the first os list to copy the second os list to copy @@ -11015,27 +10984,27 @@ oss that are present in both @sourceOne and @sourceTwo. deprecated="1" deprecated-version="0.2.2"> Construct a new os list that is filled with all the oss that are present in either @sourceOne and @sourceTwo. Use osinfo_list_new_union() instead. - + a union of the two os lists the first os list to copy the second os list to copy @@ -11051,16 +11020,19 @@ oss that are present in either @sourceOne and @sourceTwo. - + - - + + - - + + glib:type-name="OsinfoOsVariant" glib:get-type="osinfo_os_variant_get_type" glib:type-struct="OsVariantClass"> - + Creates a new os variant - + An os variant entity the id of the os variant to be created @@ -11097,19 +11069,19 @@ oss that are present in either @sourceOne and @sourceTwo. glib:get-property="name" version="0.2.9"> The name of the @variant - + the name, or NULL an #OsinfoOsVariant instance @@ -11118,9 +11090,10 @@ oss that are present in either @sourceOne and @sourceTwo. + getter="get_name" + default-value="NULL"> The name to this variant. @@ -11134,7 +11107,7 @@ oss that are present in either @sourceOne and @sourceTwo. - + @@ -11146,18 +11119,17 @@ oss that are present in either @sourceOne and @sourceTwo. glib:type-name="OsinfoOsVariantList" glib:get-type="osinfo_os_variantlist_get_type" glib:type-struct="OsVariantListClass"> - + Construct a new install_variant list that is initially empty. - + an empty install_variant list @@ -11173,67 +11145,69 @@ oss that are present in either @sourceOne and @sourceTwo. - + - + disguised="1" + opaque="1"> + - + disguised="1" + opaque="1"> + - + - + - + - + - + - + - + - + glib:nick="unix" glib:name="OSINFO_PATH_FORMAT_UNIX"> Unix/Linux path format, e.g /home/foo/bar.txt glib:nick="dos" glib:name="OSINFO_PATH_FORMAT_DOS"> DOS/Windows path format, e.g \My Documents\bar.txt @@ -11266,22 +11240,22 @@ oss that are present in either @sourceOne and @sourceTwo. glib:type-name="OsinfoPlatform" glib:get-type="osinfo_platform_get_type" glib:type-struct="PlatformClass"> - + Create a new platform entity - + A platform entity a unique identifier @@ -11289,26 +11263,26 @@ oss that are present in either @sourceOne and @sourceTwo. Associate a device with a platform. The returned #OsinfoDeviceLink can be used to record extra metadata against the link - + the device association a platform entity the device to associate @@ -11318,21 +11292,21 @@ can be used to record extra metadata against the link c:identifier="osinfo_platform_get_all_devices" version="0.2.7"> Get all platforms matching a given filter but unlike osinfo_platform_get_devices this function also retrieves devices from all derived and upgraded platforms. - + A list of devices a platform @@ -11341,7 +11315,7 @@ all derived and upgraded platforms. nullable="1" allow-none="1"> an optional device property filter @@ -11350,20 +11324,20 @@ all derived and upgraded platforms. Retrieve all the associated devices matching the filter. The filter matches against the link, not the device. - + a list of #OsinfoDevice entities a platform entity @@ -11372,7 +11346,7 @@ The filter matches against the link, not the device. nullable="1" allow-none="1"> an optional filter @@ -11380,20 +11354,20 @@ The filter matches against the link, not the device. Retrieve all the associated devices matching the filter. The filter matches against the device, not the link. - + a list of #OsinfoDevice entities a platform entity @@ -11402,7 +11376,7 @@ The filter matches against the device, not the link. nullable="1" allow-none="1"> an optional filter @@ -11418,7 +11392,7 @@ The filter matches against the device, not the link. - + @@ -11430,15 +11404,15 @@ The filter matches against the device, not the link. glib:type-name="OsinfoPlatformList" glib:get-type="osinfo_platformlist_get_type" glib:type-struct="PlatformListClass"> - + Construct a new platform list that is initially empty. - + an empty platform list @@ -11448,21 +11422,21 @@ The filter matches against the device, not the link. deprecated="1" deprecated-version="0.2.2"> Construct a new platform list that is filled with platforms from @source Use osinfo_list_new_copy() instead. - + a copy of the platform list the platform list to copy @@ -11473,27 +11447,27 @@ from @source deprecated="1" deprecated-version="0.2.2"> Construct a new platform list that is filled with platforms from @source that match @filter Use osinfo_list_new_filtered() instead. - + a filtered copy of the platform list the platform list to copy the filter to apply @@ -11504,27 +11478,27 @@ from @source that match @filter deprecated="1" deprecated-version="0.2.2"> Construct a new platform list that is filled with only the platforms that are present in both @sourceOne and @sourceTwo. Use osinfo_list_new_intersection() instead. - + an intersection of the two platform lists the first platform list to copy the second platform list to copy @@ -11535,27 +11509,27 @@ platforms that are present in both @sourceOne and @sourceTwo. deprecated="1" deprecated-version="0.2.2"> Construct a new platform list that is filled with all the platforms that are present in either @sourceOne and @sourceTwo. Use osinfo_list_new_union() instead. - + a union of the two platform lists the first platform list to copy the second platform list to copy @@ -11571,20 +11545,22 @@ platforms that are present in either @sourceOne and @sourceTwo. - + - + disguised="1" + opaque="1"> + - + disguised="1" + opaque="1"> + glib:type-name="OsinfoProduct" glib:get-type="osinfo_product_get_type" glib:type-struct="ProductClass"> - + Add an association between two products - + a product the relationship the product to relate to @@ -11628,17 +11604,17 @@ platforms that are present in either @sourceOne and @sourceTwo. - + The product's codename, or NULL. an product @@ -11647,10 +11623,10 @@ platforms that are present in either @sourceOne and @sourceTwo. - + A #GDate representing the product's EOL date, or NULL. @@ -11658,7 +11634,7 @@ platforms that are present in either @sourceOne and @sourceTwo. an product @@ -11667,17 +11643,17 @@ platforms that are present in either @sourceOne and @sourceTwo. - + A string representing the product's EOL date, or NULL. an product @@ -11686,7 +11662,7 @@ platforms that are present in either @sourceOne and @sourceTwo. - + @@ -11699,7 +11675,7 @@ platforms that are present in either @sourceOne and @sourceTwo. - + @@ -11711,26 +11687,26 @@ platforms that are present in either @sourceOne and @sourceTwo. Get a list of products satisfying the requested relationship - + a list of related products an product the relationship to query @@ -11740,10 +11716,10 @@ relationship - + A #GDate representing the product's release date, or NULL. @@ -11751,7 +11727,7 @@ relationship an product @@ -11760,17 +11736,17 @@ relationship - + A string representing the product's release date, or NULL. an product @@ -11779,7 +11755,7 @@ relationship - + @@ -11793,12 +11769,12 @@ relationship c:identifier="osinfo_product_get_short_id_list" version="1.5.0"> Retrieve all the short-ids associated with the product. - + the list of short-ids. @@ -11807,7 +11783,7 @@ relationship an #OsinfoProduct @@ -11816,7 +11792,7 @@ relationship - + @@ -11829,7 +11805,7 @@ relationship - + @@ -11841,41 +11817,55 @@ relationship + getter="get_codename" + default-value="NULL"> The codename of this product. - + The URI of the logo of the product. - + The name of this product. + getter="get_short_id" + default-value="NULL"> The short ID of this product. - + The Vendor of this product. - + The version of the product. @@ -11889,7 +11879,7 @@ relationship - + @@ -11901,17 +11891,16 @@ relationship glib:type-name="OsinfoProductFilter" glib:get-type="osinfo_productfilter_get_type" glib:type-struct="ProductFilterClass"> - + Construct a new filter that matches all operating systems - + a new filter @@ -11919,33 +11908,32 @@ systems Adds a constraint that matches products which have a relationship @relshp with @product. Multiple constraints can be set for the same @relshp or @product, in which case all must match - + a filter object the relationship to filter on the target product to filter on @@ -11953,8 +11941,7 @@ all must match - + @@ -11970,23 +11957,22 @@ all must match Remove all constraints for the relationship @relshp - + a filter object the relationship to clear @@ -11996,17 +11982,16 @@ all must match Remove all relationship constraints - + a filter object @@ -12015,15 +12000,14 @@ all must match Retrieve a list of all operating systems that are the target of constraint for the relationship @relshp. - + a list of operating systems @@ -12032,13 +12016,13 @@ the target of constraint for the relationship a filter object a relationship to query @@ -12056,15 +12040,16 @@ the target of constraint for the relationship - + - + disguised="1" + opaque="1"> + - + Construct a new os list that is initially empty. - + an empty os list @@ -12091,21 +12076,21 @@ the target of constraint for the relationship deprecated="1" deprecated-version="0.2.2"> Construct a new os list that is filled with oss from @source Use osinfo_list_new_copy() instead. - + a copy of the os list the os list to copy @@ -12116,27 +12101,27 @@ from @source deprecated="1" deprecated-version="0.2.2"> Construct a new os list that is filled with oss from @source that match @filter Use osinfo_list_new_filtered() instead. - + a filtered copy of the os list the os list to copy the filter to apply @@ -12147,27 +12132,27 @@ from @source that match @filter deprecated="1" deprecated-version="0.2.2"> Construct a new os list that is filled with only the oss that are present in both @sourceOne and @sourceTwo. Use osinfo_list_new_intersection() instead. - + an intersection of the two os lists the first os list to copy the second os list to copy @@ -12178,27 +12163,27 @@ oss that are present in both @sourceOne and @sourceTwo. deprecated="1" deprecated-version="0.2.2"> Construct a new os list that is filled with all the oss that are present in either @sourceOne and @sourceTwo. Use osinfo_list_new_union() instead. - + a union of the two os lists the first os list to copy the second os list to copy @@ -12214,25 +12199,29 @@ oss that are present in either @sourceOne and @sourceTwo. - + - + disguised="1" + opaque="1"> + - - + + Enum values used to form relationships between products glib:nick="derives-from" glib:name="OSINFO_PRODUCT_RELATIONSHIP_DERIVES_FROM"> a descendent (RHEL-5 derives from Fedora-6) glib:nick="upgrades" glib:name="OSINFO_PRODUCT_RELATIONSHIP_UPGRADES"> a new version release (RHEL-6 upgrades RHEL-4) glib:nick="clones" glib:name="OSINFO_PRODUCT_RELATIONSHIP_CLONES"> a perfect clone (CentOS-5 clones RHEL-5) - + - + - + - + - + glib:nick="released" glib:name="OSINFO_RELEASE_STATUS_RELEASED"> A released OS. (Since: 0.2.9) glib:nick="snapshot" glib:name="OSINFO_RELEASE_STATUS_SNAPSHOT"> A continuous integration snapshot and not an actual released product yet. For example, gnome-continuous images for development snapshots of GNOME and nightly build ISOs of Fedora etc. @@ -12323,7 +12312,7 @@ development snapshots of GNOME and nightly build ISOs of Fedora etc. glib:nick="prerelease" glib:name="OSINFO_RELEASE_STATUS_PRERELEASE"> A pre-release. For example, alpha and beta pre-releases of Fedora etc. (Since: 0.2.9) @@ -12333,7 +12322,7 @@ beta pre-releases of Fedora etc. (Since: 0.2.9) glib:nick="rolling" glib:name="OSINFO_RELEASE_STATUS_ROLLING"> A rolling version of an OS and thus with no actual releases. For example, Gentoo, Arch Linux, etc. (Since: 1.4.0) @@ -12345,9 +12334,9 @@ actual releases. For example, Gentoo, Arch Linux, etc. (Since: 1.4.0) glib:type-name="OsinfoResources" glib:get-type="osinfo_resources_get_type" glib:type-struct="ResourcesClass"> - + - + @@ -12364,22 +12353,22 @@ actual releases. For example, Gentoo, Arch Linux, etc. (Since: 1.4.0) c:identifier="osinfo_resources_get_architecture" glib:get-property="architecture"> Retrieves the target hardware architecture to which @resources applies. Some operating systems specify the same requirements and recommendations for all architectures. In such cases, the string returned by this call will be #OSINFO_ARCHITECTURE_ALL. - + the hardware architecture. an #OsinfoResources instance @@ -12389,20 +12378,20 @@ architectures. In such cases, the string returned by this call will be c:identifier="osinfo_resources_get_cpu" glib:get-property="cpu"> Retrieves the CPU frequency in hertz (Hz). Divide the value by #OSINFO_MEGAHERTZ if you need this value in megahertz (MHz). - + the CPU frequency, or -1. an #OsinfoResources instance @@ -12412,19 +12401,19 @@ you need this value in megahertz (MHz). c:identifier="osinfo_resources_get_n_cpus" glib:get-property="n-cpus"> Retrieves the number of CPUs. - + the number of CPUs, or -1. an #OsinfoResources instance @@ -12434,20 +12423,20 @@ you need this value in megahertz (MHz). c:identifier="osinfo_resources_get_ram" glib:get-property="ram"> Retrieves the amount of Random Access Memory (RAM) in bytes. Divide the value by #OSINFO_MEBIBYTES if you need this value in mebibytes. - + the amount of RAM, or -1. an #OsinfoResources instance @@ -12457,20 +12446,20 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. c:identifier="osinfo_resources_get_storage" glib:get-property="storage"> Retrieves the amount of storage space in bytes. Divide the value by #OSINFO_GIBIBYTES if you need this value in gibibytes. - + the amount of storage, or -1. an #OsinfoResources instance @@ -12480,22 +12469,22 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. c:identifier="osinfo_resources_set_cpu" glib:set-property="cpu"> Sets the CPU frequency. - + an #OsinfoResources instance the CPU frequency in hertz (Hz) @@ -12505,22 +12494,22 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. c:identifier="osinfo_resources_set_n_cpus" glib:set-property="n-cpus"> Sets the number of CPUs. - + an #OsinfoResources instance the number of CPUs @@ -12530,22 +12519,22 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. c:identifier="osinfo_resources_set_ram" glib:set-property="ram"> Sets the amount of RAM in bytes. - + an #OsinfoResources instance the amount of ram in bytes @@ -12555,22 +12544,22 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. c:identifier="osinfo_resources_set_storage" glib:set-property="storage"> Sets the amount of storage space. - + an #OsinfoResources instance the amount of storage in bytes @@ -12580,9 +12569,10 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. writable="1" construct-only="1" transfer-ownership="none" - getter="get_architecture"> + getter="get_architecture" + default-value="NULL"> The target hardware architecture to which these resources applies. @@ -12590,9 +12580,10 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. writable="1" transfer-ownership="none" setter="set_cpu" - getter="get_cpu"> + getter="get_cpu" + default-value="-1"> The CPU frequency in hertz (Hz). @@ -12600,9 +12591,10 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. writable="1" transfer-ownership="none" setter="set_n_cpus" - getter="get_n_cpus"> + getter="get_n_cpus" + default-value="-1"> The number of CPUs. @@ -12610,9 +12602,10 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. writable="1" transfer-ownership="none" setter="set_ram" - getter="get_ram"> + getter="get_ram" + default-value="-1"> The amount of Random Access Memory (RAM) in bytes. @@ -12620,9 +12613,10 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. writable="1" transfer-ownership="none" setter="set_storage" - getter="get_storage"> + getter="get_storage" + default-value="-1"> The amount of storage space in bytes. @@ -12636,7 +12630,7 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. - + @@ -12648,16 +12642,15 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. glib:type-name="OsinfoResourcesList" glib:get-type="osinfo_resourceslist_get_type" glib:type-struct="ResourcesListClass"> - + Construct a new resources list that is initially empty. - + an empty resources list @@ -12667,22 +12660,21 @@ by #OSINFO_MEBIBYTES if you need this value in mebibytes. deprecated="1" deprecated-version="0.2.2"> Construct a new resources list that is filled with resources instances from @source Use osinfo_list_new_copy() instead. - + a copy of the resources list the resources list to copy @@ -12693,28 +12685,27 @@ from @source deprecated="1" deprecated-version="0.2.2"> Construct a new resources list that is filled with resources instances from @source that match @filter Use osinfo_list_new_filtered() instead. - + a filtered copy of the resources list the resources list to copy the filter to apply @@ -12725,28 +12716,27 @@ from @source that match @filter deprecated="1" deprecated-version="0.2.2"> Construct a new resources list that is filled with only the resources instances that are present in both @sourceOne and @sourceTwo. Use osinfo_list_new_intersection() instead. - + an intersection of the two resources lists the first resources list to copy the second resources list to copy @@ -12757,28 +12747,27 @@ resources instances that are present in both @sourceOne and @sourceTwo. deprecated="1" deprecated-version="0.2.2"> Construct a new resources list that is filled with all the resources instances that are present in either @sourceOne and @sourceTwo. Use osinfo_list_new_union() instead. - + a union of the two resources lists the first resources list to copy the second resources list to copy @@ -12795,83 +12784,85 @@ resources instances that are present in either @sourceOne and @sourceTwo. - + - + disguised="1" + opaque="1"> + - + disguised="1" + opaque="1"> + - + - + - + - + - + - + - + - + - + - + - + glib:type-name="OsinfoTree" glib:get-type="osinfo_tree_get_type" glib:type-struct="TreeClass"> - + Create a new tree entity - + A tree entity the id of the tree to be created the architecture of the tree to be created @@ -12913,22 +12904,22 @@ resources instances that are present in either @sourceOne and @sourceTwo. version="0.1.0" throws="1"> Creates a new #OsinfoTree for installation tree at @location. The @location could be a http:// or a https:// URI, or a local file. NOTE: Currently this only works for trees with a .treeinfo file - + a new #OsinfoTree , or NULL on error the location of an installation tree @@ -12937,7 +12928,7 @@ NOTE: Currently this only works for trees with a .treeinfo file nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -12947,22 +12938,22 @@ NOTE: Currently this only works for trees with a .treeinfo file c:identifier="osinfo_tree_create_from_location_async" version="0.1.0"> Asynchronous variant of #osinfo_tree_create_from_location. - + the location of an installation tree the I/O priority of the request @@ -12971,7 +12962,7 @@ NOTE: Currently this only works for trees with a .treeinfo file nullable="1" allow-none="1"> a #GCancellable, or %NULL @@ -12982,7 +12973,7 @@ NOTE: Currently this only works for trees with a .treeinfo file scope="async" closure="4"> Function to call when result of this call is ready @@ -12991,7 +12982,7 @@ NOTE: Currently this only works for trees with a .treeinfo file nullable="1" allow-none="1"> The user data to pass to @callback, or %NULL @@ -13002,20 +12993,20 @@ NOTE: Currently this only works for trees with a .treeinfo file version="0.1.0" throws="1"> Finishes an asynchronous tree object creation process started with #osinfo_tree_create_from_location_async. - + a new #OsinfoTree , or NULL on error a #GAsyncResult @@ -13026,25 +13017,25 @@ NOTE: Currently this only works for trees with a .treeinfo file version="1.7.0" throws="1"> Creates a new #OsinfoTree for installation tree represented by @treeinfo. - + a new #OsinfoTree, or NULL on error a string representing the .treeinfo content the location of the original @treeinfo @@ -13055,19 +13046,19 @@ NOTE: Currently this only works for trees with a .treeinfo file glib:get-property="architecture" version="0.1.0"> Retrieves the target hardware architecture of the OS @tree provides. - + the hardware architecture, or NULL an #OsinfoTree instance @@ -13078,19 +13069,19 @@ NOTE: Currently this only works for trees with a .treeinfo file glib:get-property="boot-iso-path" version="0.1.0"> Retrieves the path to the boot_iso image in the install tree. - + the path to boot_iso image, or NULL an #OsinfoTree instance @@ -13101,21 +13092,21 @@ NOTE: Currently this only works for trees with a .treeinfo file glib:get-property="initrd-path" version="0.1.0"> Retrieves the path to the initrd image in the install tree. Note: This only applies to installer trees of 'linux' OS family. - + the path to initrd image, or NULL an #OsinfoTree instance @@ -13126,21 +13117,21 @@ Note: This only applies to installer trees of 'linux' OS family. glib:get-property="kernel-path" version="0.1.0"> Retrieves the path to the kernel image in the install tree. Note: This only applies to installer trees of 'linux' OS family. - + the path to kernel image, or NULL an #OsinfoTree instance @@ -13150,17 +13141,17 @@ Note: This only applies to installer trees of 'linux' OS family. c:identifier="osinfo_tree_get_os" glib:get-property="os" version="1.5.0"> - + the operating system, or NULL an #OsinfoTree instance @@ -13170,19 +13161,19 @@ Note: This only applies to installer trees of 'linux' OS family. c:identifier="osinfo_tree_get_os_variants" version="1.5.0"> Gets the variants of the associated operating system. - + the operating system variant, or NULL an #OsinfoTree instance @@ -13193,22 +13184,22 @@ Note: This only applies to installer trees of 'linux' OS family. glib:get-property="treeinfo-arch" version="0.1.0"> If @tree has treeinfo, this function retrieves the expected architecture. Note: In practice, this will usually not be the exact copy of the architecture but rather a regular expression that matches it. - + the treeinfo architecture, or NULL an #OsinfoTree instance @@ -13219,22 +13210,22 @@ architecture but rather a regular expression that matches it. glib:get-property="treeinfo-family" version="0.1.0"> If @tree has treeinfo, this function retrieves the expected family. Note: In practice, this will usually not be the exact copy of the family but rather a regular expression that matches it. - + the treeinfo family, or NULL an #OsinfoTree instance @@ -13245,22 +13236,22 @@ but rather a regular expression that matches it. glib:get-property="treeinfo-variant" version="0.1.0"> If @tree has treeinfo, this function retrieves the expected variant. Note: In practice, this will usually not be the exact copy of the variant but rather a regular expression that matches it. - + the treeinfo variant, or NULL an #OsinfoTree instance @@ -13271,22 +13262,22 @@ but rather a regular expression that matches it. glib:get-property="treeinfo-version" version="0.1.0"> If @tree has treeinfo, this function retrieves the expected version. Note: In practice, this will usually not be the exact copy of version but rather a regular expression that matches it. - + the treeinfo version, or NULL an #OsinfoTree instance @@ -13297,19 +13288,19 @@ rather a regular expression that matches it. glib:get-property="url" version="0.1.0"> The URL to the @tree - + the URL, or NULL an #OsinfoTree instance @@ -13319,19 +13310,19 @@ rather a regular expression that matches it. c:identifier="osinfo_tree_has_treeinfo" version="1.3.0"> Return whether a tree has treeinfo or not. - + TRUE if the tree has treeinfo. FALSE otherwise. an #OsinfoTree instance @@ -13341,29 +13332,29 @@ rather a regular expression that matches it. c:identifier="osinfo_tree_matches" version="1.10.0"> Determines whether the metadata for the unidentified @tree is a match for the @reference tree. The metadata in the unidentified @tree must be literal strings, while the metadata in the @reference tree must be regular expressions. - + #TRUE if @tree is a match for @reference. #FALSE otherwise an unidentified #OsinfoTree instance a reference #OsinfoTree instance @@ -13374,22 +13365,22 @@ while the metadata in the @reference tree must be regular expressions. glib:set-property="os" version="1.5.0"> Sets the #OsinfoOs associated to the #OsinfoTree instance. - + an #OsinfoTree instance an #OsinfoOs instance @@ -13398,42 +13389,49 @@ while the metadata in the @reference tree must be regular expressions. + getter="get_architecture" + default-value="NULL"> The target hardware architecture of this tree. + getter="get_boot_iso_path" + default-value="NULL"> The path to the boot ISO in the install tree - + Whether the tree has treeinfo or not + getter="get_initrd_path" + default-value="NULL"> The path to the initrd image in the install tree. + getter="get_kernel_path" + default-value="NULL"> The path to the kernel image in the install tree. @@ -13443,7 +13441,7 @@ while the metadata in the @reference tree must be regular expressions. setter="set_os" getter="get_os"> Os information for the current tree. For tree stored in an #OsinfoDb, it will be filled when the database is loaded, otherwise the property will be filled after a successful call to @@ -13453,45 +13451,50 @@ osinfo_db_identify_tree(). + getter="get_treeinfo_arch" + default-value="NULL"> The treeinfo arch + getter="get_treeinfo_family" + default-value="NULL"> The treeinfo family + getter="get_treeinfo_variant" + default-value="NULL"> The treeinfo variant + getter="get_treeinfo_version" + default-value="NULL"> The treeinfo version + getter="get_url" + default-value="NULL"> The URL to this tree. @@ -13505,7 +13508,7 @@ osinfo_db_identify_tree(). - + @@ -13517,7 +13520,7 @@ osinfo_db_identify_tree(). c:type="OsinfoTreeError" glib:error-domain="osinfo-tree-error"> #GError codes used for errors in the #OSINFO_TREE_ERROR domain, during reading the treeinfo from a URI. glib:nick="no-treeinfo" glib:name="OSINFO_TREE_ERROR_NO_TREEINFO"> No treeinfo found; glib:nick="not-supported-protocol" glib:name="OSINFO_TREE_ERROR_NOT_SUPPORTED_PROTOCOL"> The URL protocol is not supported. Gets a #GQuark representing the string "osinfo-tree-error" the #GQuark representing the string. @@ -13559,17 +13562,17 @@ reading the treeinfo from a URI. glib:type-name="OsinfoTreeList" glib:get-type="osinfo_treelist_get_type" glib:type-struct="TreeListClass"> - + Construct a new tree list that is initially empty. - + an empty tree list @@ -13580,21 +13583,21 @@ reading the treeinfo from a URI. deprecated="1" deprecated-version="0.2.2"> Construct a new tree list that is filled with trees from @source Use osinfo_list_new_copy() instead. - + a copy of the tree list the tree list to copy @@ -13606,27 +13609,27 @@ from @source deprecated="1" deprecated-version="0.2.2"> Construct a new tree list that is filled with trees from @source that match @filter Use osinfo_list_new_filtered() instead. - + a filtered copy of the tree list the tree list to copy the filter to apply @@ -13638,27 +13641,27 @@ from @source that match @filter deprecated="1" deprecated-version="0.2.2"> Construct a new tree list that is filled with only the trees that are present in both @sourceOne and @sourceTwo. Use osinfo_list_new_intersection() instead. - + an intersection of the two tree lists the first tree list to copy the second tree list to copy @@ -13670,27 +13673,27 @@ trees that are present in both @sourceOne and @sourceTwo. deprecated="1" deprecated-version="0.2.2"> Construct a new tree list that is filled with all the trees that are present in either @sourceOne and @sourceTwo. Use osinfo_list_new_union() instead. - + a union of the two tree lists the first tree list to copy the second tree list to copy @@ -13706,29 +13709,33 @@ trees that are present in either @sourceOne and @sourceTwo. - + - + disguised="1" + opaque="1"> + - - + + Gets a #GQuark representing the string "libosinfo" the #GQuark representing the string. @@ -13742,64 +13749,64 @@ trees that are present in either @sourceOne and @sourceTwo. #OsinfoDatamap is an object for representing OS datamaps. It is to translate generic osinfo values to OS specific data. #OsinfoDatamapList is a list specialization that stores only #OsinfoDatamap objects. #OsinfoDb is a database tracking all entity instances against which metadata is recorded. #OsinfoDeployment is an entity representing an virtualization deployment. Deployments have a list of supported devices #OsinfoDeploymentList is a list specialization that stores only #OsinfoDeployment objects. #OsinfoDevice is an entity representing some kind of hardware device. Devices can be associated with operating systems and platforms. #OsinfoDeviceDriver is an entity representing device drivers for an (guest) operating system. #OsinfoDeviceDriverList is a list specialization that stores only #OsinfoDeviceDriver objects. #OsinfoDeviceLink is an entity representing some kind of hardware devicelink. DeviceLinks can be associated with operating systems and platforms. #OsinfoDeviceLinkFilter is a specialization of #OsinfoFilter that can also set a constraint against the device link target. It can only be used to filter entities @@ -13807,19 +13814,19 @@ that are #OsinfoDeviceLink objects. #OsinfoDeviceLinkList is a list specialization that stores only #OsinfoDeviceLink objects. #OsinfoDeviceList is a list specialization that stores only #OsinfoDevice objects. #OsinfoEntity is an abstract base class for all objects against which metadata needs to be recorded. Every object has a unique identifier, which is recommended to be in URI format. Named, multi-valued data @@ -13828,44 +13835,44 @@ of entities, the parameter values can be used for matching. #OsinfoFilter provides a way to filter OsinfoEntity instances based on their parameter values. #OsinfoFirmware is an entity representing a firmware used to boot a (guest) operating system. #OsinfoFirmwareList is a list specialization that stores only #OsinfoFirmware objects. #OsinfoImage is an entity representing an installation image a (guest) operating system. #OsinfoImageList is a list specialization that stores only #OsinfoImage objects. #OsinfoInstallConfig is an object for representing OS install configuration data. It is used to generate an automated installation script #OsinfoInstallConfigParam is an entity for describing all parameters that can be set in an automated installation. It is used to help applications to generate an automated installation script. The actual parameter values @@ -13874,13 +13881,13 @@ object. #OsinfoInstallConfigParamList is a list specialization that stores only #OsinfoInstallConfigParam objects. #OsinfoInstallScript is an object used to generate an automated installation script for an OS. The OS configuration data (language, keyboard, timezone, ...) @@ -13888,36 +13895,36 @@ comes from an #OsinfoInstallConfig object. #OsinfoInstallScriptList is a list specialization that stores only #OsinfoInstallScript objects. #OsinfoList provides a way to maintain a list of #OsinfoEntity objects. #OsinfoLoader provides a way to populate an #OsinfoDb from a set of XML documents. #OsinfoMedia is an entity representing an installation media a (guest) operating system. #OsinfoMediaList is a list specialization that stores only #OsinfoMedia objects. #OsinfoOs is an entity representing an operating system. Operating systems have a list of supported devices. There are relationships amongst operating systems to @@ -13926,36 +13933,36 @@ and which are derived from a common ancestry. #OsinfoOsVariant is an entity representing a variant of an operating system. #OsinfoOsVariantList is a list specialization that stores only #OsinfoOsVariant objects. #OsinfoOsList is a list specialization that stores only #OsinfoOs objects. #OsinfoPlatform is an entity representing an virtualization platform. Platforms have a list of supported devices #OsinfoPlatformList is a list specialization that stores only #OsinfoPlatform objects. #OsinfoProduct is an entity representing an software product. There are relationships amongst products to declare which are newest releases, which are clones @@ -13963,7 +13970,7 @@ and which are derived from a common ancestry. #OsinfoProductFilter is a specialization of #OsinfoFilter that can also set constraints against operating system relationships. It can only be used to filter entities @@ -13971,31 +13978,31 @@ that are #OsinfoProduct objects. #OsinfoProductList is a list specialization that stores only #OsinfoProduct objects. #OsinfoResources is an entity representing required or recommended resources for an (guest) operating system. #OsinfoResourcesList is a list specialization that stores only #OsinfoResources objects. #OsinfoTree is an entity representing an installation tree a (guest) operating system. #OsinfoTreeList is a list specialization that stores only #OsinfoTree objects. @@ -14004,11 +14011,11 @@ only #OsinfoTree objects. moved-to="TreeError.quark" version="0.1.0"> Gets a #GQuark representing the string "osinfo-tree-error" the #GQuark representing the string. diff --git a/girs/LibvirtGConfig-1.0.gir b/girs/LibvirtGConfig-1.0.gir index a74c52dda..02fb9bfc8 100644 --- a/girs/LibvirtGConfig-1.0.gir +++ b/girs/LibvirtGConfig-1.0.gir @@ -1523,6 +1523,36 @@ a newly allocated #GList of #GVirConfigCapabilitiesHostSecModel. + + + + + + + + + + + + + + + + + + + + + @@ -2163,6 +2193,36 @@ a newly allocated #GList of #GVirConfigCapabilitiesHostSecModel. + + + + + + + + + + + + + + + + + + + + + @@ -3510,7 +3570,7 @@ object should be unreffed with g_object_unref() when no longer needed. line="472">Sets the current amount of RAM allocated to @domain in kilobytes (i.e. blocks of 1024 bytes). This can be set to less than the maximum domain memory to allow to balloon the guest memory on the fly. Be aware that -libvirt will set it automatically if it's not explictly set, which means +libvirt will set it automatically if it's not explicitly set, which means you may need to set this value in addition to 'memory' if you want to change the available domain memory after creation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + c:identifier="gvir_config_domain_disk_get_driver"> Gets the driver configuration for @disk. + line="418">Gets the driver configuration for @disk. A #GVirConfigDomainDiskDriver. The returned + line="424">A #GVirConfigDomainDiskDriver. The returned object should be unreffed with g_object_unref() when no longer needed. @@ -6199,7 +6410,7 @@ object should be unreffed with g_object_unref() when no longer needed. a #GVirConfigDomainDisk + line="420">a #GVirConfigDomainDisk @@ -6346,7 +6557,7 @@ instead c:identifier="gvir_config_domain_disk_set_driver"> Uses @driver as the driver configuration for @disk. + line="399">Uses @driver as the driver configuration for @disk. @@ -6356,7 +6567,7 @@ instead a #GVirConfigDomainDisk + line="401">a #GVirConfigDomainDisk allow-none="1"> a #GVirConfigDomainDiskDriver + line="402">a #GVirConfigDomainDiskDriver @@ -7554,6 +7765,117 @@ instead + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -12710,6 +13051,26 @@ should be unreffed with g_object_unref() when no longer needed. + + + + + + + + + + + + + + @@ -13140,6 +13501,26 @@ should be unreffed with g_object_unref() when no longer needed. + + + + + + + + + + + + + + diff --git a/girs/LibvirtGLib-1.0.gir b/girs/LibvirtGLib-1.0.gir index 62909a755..aa32dc5d0 100644 --- a/girs/LibvirtGLib-1.0.gir +++ b/girs/LibvirtGLib-1.0.gir @@ -276,7 +276,7 @@ of the most recent libvirt error object in the current thread. The <code>gvir_error_new</code>, <code>gvir_error_new_literal</code> and <code>gvir_error_new_valist</code> methods all return a newly created <code>GError *</code> object instance, differing only in the way the -message needs to be provided. For most usage though, it is preferrable +message needs to be provided. For most usage though, it is preferable to use the <code>gvir_set_error</code>, <code>gvir_set_error_literal</code> and <code>gvir_set_error_valist</code> methods. These all accept a <code>GError **</code> argument and take care to only fill it if it @@ -325,7 +325,7 @@ int main(int argc, char **argv) { </example> <example> -<title>Registering for events using Appplication</title> +<title>Registering for events using Application</title> <programlisting><![CDATA[ int main(int argc, char **argv) { ...setup... diff --git a/girs/LightDM-1.gir b/girs/LightDM-1.gir index 1e2478813..61bf70401 100644 --- a/girs/LightDM-1.gir +++ b/girs/LightDM-1.gir @@ -357,7 +357,9 @@ using the provided functions. + c:identifier="lightdm_greeter_connect_to_daemon" + glib:finish-func="connect_to_daemon_finish" + glib:sync-func="connect_to_daemon_sync"> Asynchronously connects the greeter to the display manager. @@ -437,7 +439,8 @@ See lightdm_greeter_connect_to_daemon_sync() for the synchronous version. + throws="1" + glib:async-func="connect_to_daemon"> Connects the greeter to the display manager. Will block until connected. @@ -458,7 +461,9 @@ See lightdm_greeter_connect_to_daemon_sync() for the synchronous version. + c:identifier="lightdm_greeter_ensure_shared_data_dir" + glib:finish-func="ensure_shared_data_dir_finish" + glib:sync-func="ensure_shared_data_dir_sync"> Ensure that a shared data dir for the given user is available. Both the @@ -549,7 +554,8 @@ the directory themselves. + throws="1" + glib:async-func="ensure_shared_data_dir"> Ensure that a shared data dir for the given user is available. Both the @@ -1030,7 +1036,9 @@ This must be called before lightdm_greeter_connect is called. + c:identifier="lightdm_greeter_start_session" + glib:finish-func="start_session_finish" + glib:sync-func="start_session_sync"> Asynchronously start a session for the authenticated user. @@ -1119,7 +1127,8 @@ See lightdm_greeter_start_session_sync() for the synchronous version. + throws="1" + glib:async-func="start_session"> Start a session for the authenticated user. diff --git a/girs/Manette-0.2.gir b/girs/Manette-0.2.gir index 535c7b216..670581cff 100644 --- a/girs/Manette-0.2.gir +++ b/girs/Manette-0.2.gir @@ -23,23 +23,23 @@ and/or use gtk-doc annotations. --> glib:type-name="ManetteDevice" glib:get-type="manette_device_get_type" glib:type-struct="DeviceClass"> - + Gets the device's name. - + line="602">Gets the device's name. + the name of @self, do not modify it or free it + line="608">the name of @self, do not modify it or free it a #ManetteDevice + line="604">a #ManetteDevice @@ -47,44 +47,53 @@ and/or use gtk-doc annotations. --> Gets whether the device has the given input. If the input is present it means + line="578">Gets whether the device has the given input. If the input is present it means that the device can send events for it regardless of whether the device is mapped or not. - + whether the device has the given input + line="588">whether the device has the given input a #ManetteDevice + line="580">a #ManetteDevice the input type + line="581">the input type the input code + line="582">the input code - + Gets whether @self supports rumble. + + whether @self supports rumble + a #ManetteDevice @@ -93,19 +102,19 @@ mapped or not. c:identifier="manette_device_has_user_mapping"> Gets whether @self has a user mapping. - + line="704">Gets whether @self has a user mapping. + whether @self has a user mapping + line="710">whether @self has a user mapping a #ManetteDevice + line="706">a #ManetteDevice @@ -114,8 +123,8 @@ mapped or not. c:identifier="manette_device_remove_user_mapping"> Removes the user mapping for @self. - + line="753">Removes the user mapping for @self. + @@ -123,27 +132,48 @@ mapped or not. a #ManetteDevice + line="755">a #ManetteDevice - + Make @self rumble during @milliseconds milliseconds, with the heavy and light +motors rumbling at their respectively defined magnitudes. + +The duration cannot exceed 32767 milliseconds. + + whether the rumble effect was played + a #ManetteDevice + the magnitude for the heavy motor + the magnitude for the light motor + the rumble effect play time in milliseconds @@ -152,8 +182,8 @@ mapped or not. c:identifier="manette_device_save_user_mapping"> Saves @mapping_string as the user mapping for @self. - + line="726">Saves @mapping_string as the user mapping for @self. + @@ -161,13 +191,13 @@ mapped or not. a #ManetteDevice + line="728">a #ManetteDevice the mapping string + line="729">the mapping string @@ -175,7 +205,7 @@ mapped or not. Emitted when an absolute axis' value changes. + line="281">Emitted when an absolute axis' value changes. @@ -183,7 +213,7 @@ mapped or not. the event emitted by the manette device + line="284">the event emitted by the manette device @@ -191,7 +221,7 @@ mapped or not. Emitted when a button is pressed. + line="249">Emitted when a button is pressed. @@ -199,7 +229,7 @@ mapped or not. the event emitted by the manette device + line="252">the event emitted by the manette device @@ -207,7 +237,7 @@ mapped or not. Emitted when a button is released. + line="265">Emitted when a button is released. @@ -215,7 +245,7 @@ mapped or not. the event emitted by the manette device + line="268">the event emitted by the manette device @@ -223,7 +253,7 @@ mapped or not. Emitted when the device is disconnected. + line="313">Emitted when the device is disconnected. @@ -231,7 +261,7 @@ mapped or not. Emitted for any kind of event before mapping it. + line="233">Emitted for any kind of event before mapping it. @@ -239,7 +269,7 @@ mapped or not. the event emitted by the manette device + line="236">the event emitted by the manette device @@ -247,7 +277,7 @@ mapped or not. Emitted when a hat axis' value changes. + line="297">Emitted when a hat axis' value changes. @@ -255,7 +285,7 @@ mapped or not. the event emitted by the manette device + line="300">the event emitted by the manette device @@ -264,7 +294,7 @@ mapped or not. - + @@ -274,23 +304,23 @@ mapped or not. glib:type-name="ManetteEvent" glib:get-type="manette_event_get_type" c:symbol-prefix="event"> - + Creates a copy of a #ManetteEvent. - + line="45">Creates a copy of a #ManetteEvent. + a new #ManetteEvent + line="51">a new #ManetteEvent a #ManetteEvent + line="47">a #ManetteEvent @@ -298,8 +328,8 @@ mapped or not. Frees @self. - + line="68">Frees @self. + @@ -307,7 +337,7 @@ mapped or not. a #ManetteEvent + line="70">a #ManetteEvent @@ -315,19 +345,19 @@ mapped or not. Gets the axis of @self, if any. - + line="225">Gets the axis of @self, if any. + whether the axis was retrieved + line="233">whether the axis was retrieved a #ManetteEvent + line="227">a #ManetteEvent transfer-ownership="full"> return location for the axis + line="228">return location for the axis transfer-ownership="full"> return location for the axis + line="229">return location for the axis @@ -353,19 +383,19 @@ mapped or not. Gets the button of @self, if any. - + line="198">Gets the button of @self, if any. + whether the button was retrieved + line="205">whether the button was retrieved a #ManetteEvent + line="200">a #ManetteEvent transfer-ownership="full"> return location for the button + line="201">return location for the button @@ -382,19 +412,19 @@ mapped or not. Gets the #ManetteDevice associated with the @self. - + line="118">Gets the #ManetteDevice associated with the @self. + the #ManetteDevice associated with the @self + line="124">the #ManetteDevice associated with the @self a #ManetteEvent + line="120">a #ManetteEvent @@ -403,19 +433,19 @@ mapped or not. c:identifier="manette_event_get_event_type"> Gets the event type of @self. - + line="84">Gets the event type of @self. + the event type of @self + line="90">the event type of @self a #ManetteEvent + line="86">a #ManetteEvent @@ -424,19 +454,19 @@ mapped or not. c:identifier="manette_event_get_hardware_code"> Gets the hardware code of @self. - + line="150">Gets the hardware code of @self. + the hardware code of @self + line="156">the hardware code of @self a #ManetteEvent + line="152">a #ManetteEvent @@ -445,19 +475,19 @@ mapped or not. c:identifier="manette_event_get_hardware_index"> Gets the hardware index of @self. - + line="182">Gets the hardware index of @self. + the hardware index of @self + line="188">the hardware index of @self a #ManetteEvent + line="184">a #ManetteEvent @@ -466,19 +496,19 @@ mapped or not. c:identifier="manette_event_get_hardware_type"> Gets the hardware type of @self. - + line="134">Gets the hardware type of @self. + the hardware type of @self + line="140">the hardware type of @self a #ManetteEvent + line="136">a #ManetteEvent @@ -487,19 +517,19 @@ mapped or not. c:identifier="manette_event_get_hardware_value"> Gets the hardware value of @self. - + line="166">Gets the hardware value of @self. + the hardware value of @self + line="172">the hardware value of @self a #ManetteEvent + line="168">a #ManetteEvent @@ -507,19 +537,19 @@ mapped or not. Gets the hat of @self, if any. - + line="255">Gets the hat of @self, if any. + whether the hat was retrieved + line="263">whether the hat was retrieved a #ManetteEvent + line="257">a #ManetteEvent transfer-ownership="full"> return location for the hat + line="258">return location for the hat transfer-ownership="full"> return location for the hat + line="259">return location for the hat @@ -545,19 +575,21 @@ mapped or not. Gets the time stamp of @self. - + line="100">Gets the timestamp of when @self was received by the input driver that takes +care of its device. Use this timestamp to ensure external factors such as +synchronous disk writes don't influence your timing computations. + the time stamp of @self + line="108">the timestamp of when @self was received by the input driver a #ManetteEvent + line="102">a #ManetteEvent @@ -569,7 +601,7 @@ mapped or not. c:type="ManetteEventType"> Specifies the type of the event. + line="36">Specifies the type of the event. glib:name="MANETTE_EVENT_NOTHING"> a special code to indicate a null event + line="38">a special code to indicate a null event glib:name="MANETTE_EVENT_BUTTON_PRESS"> a button has been pressed + line="39">a button has been pressed glib:name="MANETTE_EVENT_BUTTON_RELEASE"> a button has been released + line="40">a button has been released glib:name="MANETTE_EVENT_ABSOLUTE"> an absolute axis has been moved + line="41">an absolute axis has been moved glib:name="MANETTE_EVENT_HAT"> a hat axis has been moved + line="42">a hat axis has been moved glib:type-name="ManetteMonitor" glib:get-type="manette_monitor_get_type" glib:type-struct="MonitorClass"> - + - + Creates a new #ManetteMonitor object. + + a new #ManetteMonitor - + Creates a new #ManetteMonitorIter iterating on @self. + a new #ManetteMonitorIter + line="521">a new #ManetteMonitorIter iterating on @self a #ManetteMonitor + line="517">a #ManetteMonitor @@ -650,7 +691,7 @@ mapped or not. Emitted when a device is connected. + line="482">Emitted when a device is connected. @@ -658,7 +699,7 @@ mapped or not. a #ManetteDevice + line="485">a #ManetteDevice @@ -666,7 +707,7 @@ mapped or not. Emitted when a device is disconnected. + line="498">Emitted when a device is disconnected. @@ -674,7 +715,7 @@ mapped or not. a #ManetteDevice + line="501">a #ManetteDevice @@ -683,7 +724,7 @@ mapped or not. - + @@ -694,14 +735,14 @@ mapped or not. glib:type-name="ManetteMonitorIter" glib:get-type="manette_monitor_iter_get_type" c:symbol-prefix="monitor_iter"> - + Frees a #ManetteMonitorIter. - + @@ -718,7 +759,7 @@ mapped or not. Gets the next device from the device monitor iterator. - + xmlns="http://www.gtk.org/introspection/core/1.0" xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="MashData" glib:get-type="mash_data_get_type" glib:type-struct="DataClass"> - The #MashData structure contains only private data. + The #MashData structure contains only private data. + - Constructs a new #MashData instance. The object initially has + Constructs a new #MashData instance. The object initially has no data so nothing will be drawn when mash_data_render() is called. To load data into the object, call mash_data_load(). + - a new #MashData. + a new #MashData. @@ -50,56 +123,95 @@ called. To load data into the object, call mash_data_load(). - Gets the bounding cuboid of the vertices in @self. The cuboid is + Gets the bounding cuboid of the vertices in @self. The cuboid is represented by two vertices representing the minimum and maximum extents. The x, y and z components of @min_vertex will contain the minimum x, y and z values of all the vertices and @max_vertex will contain the maximum. The extents of the model are cached so it is cheap to call this function. + + + A #MashData instance + + - A location to return the minimum vertex + A location to return the minimum vertex - A location to return the maximum vertex + A location to return the maximum vertex - Loads the data from the file called @filename into @self. The + Loads the data from the file called @filename into @self. The model can then be rendered using mash_data_render(). If there is an error loading the file it will return %FALSE and @error will be set to a GError instance. + - %TRUE if the load succeeded or %FALSE otherwise. + %TRUE if the load succeeded or %FALSE otherwise. + + The #MashData instance + + - Flags used to specify load-time modifications to the data + Flags used to specify load-time modifications to the data - The name of a file to load + The name of a file to load - Renders the data contained in the model to the Clutter + Renders the data contained in the model to the Clutter scene. The current Cogl source material will be used to affect the appearance of the model. This function is not usually called directly but instead the #MashData instance is added to a #MashModel and this function will be automatically called by the paint method of the model. + + + + A #MashData instance + + + @@ -111,27 +223,60 @@ the paint method of the model. - The #MashDataClass structure contains only private data. + The #MashDataClass structure contains only private data. + - Error enumeration for #MashData + Error enumeration for #MashData + - + c:identifier="MASH_DATA_ERROR_UNKNOWN_FORMAT"> + The file has an unknown format. + + + The underlying library reported an error. + - + c:identifier="MASH_DATA_ERROR_MISSING_PROPERTY"> + A property that is needed + by #MashData is not present in the file. For example, this + will happen if the file does not contain the x, y and z properties. + + + The file is not valid. + + c:identifier="MASH_DATA_ERROR_UNSUPPORTED"> + The file is not supported + by your GL driver. This will happen if your driver can't support + GL_UNSIGNED_INT indices but the model has more than 65,536 + vertices. + - Flags used for modifying the data as it is loaded. These can be + Flags used for modifying the data as it is loaded. These can be passed to mash_data_load(). If any of the negate flags are set then they cause the vertex and @@ -149,10 +294,27 @@ faces would be culled with the default Cogl settings. To avoid these issues when exporting from Blender it is common to pass the %MASH_DATA_NEGATE_Y flag. - - - - + + + No flags + + + Negate the X axis + + + Negate the Y axis + + + Negate the Z axis + glib:type-name="MashDataLoader" glib:get-type="mash_data_loader_get_type" glib:type-struct="DataLoaderClass"> - The #MashDataLoader structure contains only private data. + The #MashDataLoader structure contains only private data. + + + + + - Obtains the loaded data after calling mash_data_loader_load(). + Obtains the loaded data after calling mash_data_loader_load(). This function is not usually called by applications. + + + The #MashDataLoader instance + + @@ -189,22 +367,32 @@ This function is not usually called by applications. + + + + - Obtains the loaded data after calling mash_data_loader_load(). + Obtains the loaded data after calling mash_data_loader_load(). This function is not usually called by applications. + + + + @@ -223,16 +411,21 @@ This function is not usually called by applications. + + + The #MashDataLoader instance @@ -246,6 +439,7 @@ This function is not usually called by applications. + @@ -261,7 +455,10 @@ This function is not usually called by applications. - The #MashDataLoaderData structure contains the loaded data. + The #MashDataLoaderData structure contains the loaded data. + @@ -286,9 +483,15 @@ This function is not usually called by applications. + disguised="1" + opaque="1"> + - + + glib:type-name="MashDirectionalLight" glib:get-type="mash_directional_light_get_type" glib:type-struct="DirectionalLightClass"> - The #MashDirectionalLight structure contains only private data. + The #MashDirectionalLight structure contains only private data. + - Constructs a new directional light actor. + Constructs a new directional light actor. + - the new light. + the new light. @@ -320,14 +531,231 @@ This function is not usually called by applications. + + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="MashLight" glib:get-type="mash_light_get_type" glib:type-struct="LightClass"> - The #MashLight structure contains only private data. + The #MashLight structure contains only private data. + - This function is used to generate the shader code required to + This function is used to generate the shader code required to implement a paraticular. It would not usually need to be called from an application. Instead it is called automatically by #MashLightSet. @@ -411,22 +844,35 @@ documentation for a description of these. The implementation should always chain up to the #MashLight implementation so that it can declare the built-in uniforms. + + + A #MashLight + + - A location to append uniforms declarations to + A location to append uniforms declarations to - A location to append lighting algorithm snippets to + A location to append lighting algorithm snippets to - This function is used by #MashLightSet to implement the lights. It + This function is used by #MashLightSet to implement the lights. It should not need to be called by an application directly. This function is virtual and can be overriden by subclasses to @@ -444,18 +890,29 @@ queried to the locations of named uniforms. mash_light_get_uniform_location() can be used to make this easier when a uniform is named uniquely using the ‘$’ symbol in mash_light_append_shader(). + + + The #MashLight that needs updating + + - A #CoglProgram containing the uniforms + A #CoglProgram containing the uniforms - This is a convenience intended to be used within + This is a convenience intended to be used within mash_light_generate_shader() to generate shader snippets with actor-specific variable names. It should not generally need to be called by an application unless it is implementing its own lighting @@ -475,22 +932,35 @@ following: The ‘position’ will get translated to something like ‘positiong00000002’. + + + The #MashLight which is generating the shader + + - The string to append to + The string to append to - A snippet of GLSL + A snippet of GLSL - This function is used to generate the shader code required to + This function is used to generate the shader code required to implement a paraticular. It would not usually need to be called from an application. Instead it is called automatically by #MashLightSet. @@ -559,75 +1029,138 @@ documentation for a description of these. The implementation should always chain up to the #MashLight implementation so that it can declare the built-in uniforms. + + + A #MashLight + + - A location to append uniforms declarations to + A location to append uniforms declarations to - A location to append lighting algorithm snippets to + A location to append lighting algorithm snippets to - - Retrieves the ‘ambient’ color emitted by the light. + + Retrieves the ‘ambient’ color emitted by the light. + + + The #MashLight to query + + - A return location for the color + A return location for the color - - Retrieves the ‘diffuse’ color emitted by the light. + + Retrieves the ‘diffuse’ color emitted by the light. + + + The #MashLight to query + + - A return location for the color + A return location for the color - Gets the modelview matrix for the light including all of the + Gets the modelview matrix for the light including all of the transformations for its parent actors. This should be used for updating uniforms that depend on the actor's transformation or position. + + + A #MashLight + + - The return location for the matrix + The return location for the matrix - - Retrieves the ‘specular’ color emitted by the light. + + Retrieves the ‘specular’ color emitted by the light. + + + The #MashLight to query + + - A return location for the color + A return location for the color - This is a convenience intended to be used within + This is a convenience intended to be used within mash_light_update_uniforms() to help query uniform locations. It should not generally need to be called by an application unless it is implementing its own lighting algorithms. @@ -636,22 +1169,37 @@ This is a wrapper around cogl_program_get_uniform_location() which appends an actor specific string to the uniform name. This is useful when uniforms have been declared like ‘position$’ within mash_light_append_shader(). + + + The #MashLight which is generating the shader + + - The program passed in from mash_light_update_uniforms(). + The program passed in from mash_light_update_uniforms(). - The name of a uniform + The name of a uniform - - Sets the ‘ambient’ color emitted by the light. If the light reaches + + Sets the ‘ambient’ color emitted by the light. If the light reaches a vertex at all then the ambient color affects the vertex regardless of its orientation or distance from the light. In real-world lighting, even if an object isn't in a direct line of @@ -659,35 +1207,59 @@ sight to a light it can still be partially lit due to the fact that light can bounce off other objects to reach it. The Mash lighting model doesn't simulate this bouncing so the ambient color is often used to give an approximation of the effect. + + + The #MashLight to modify + + - The new color value + The new color value - - Sets the ‘diffuse’ color emitted by the light. The diffuse color is + + Sets the ‘diffuse’ color emitted by the light. The diffuse color is only visible on an object if is facing the light. The orientation of the object is determined per-vertex using the vertex's normal. The diffuse color will be darkened depending on how directly the object faces the light. + + + The #MashLight to modify + + - The new color value + The new color value - This is a convenience intended to be used within + This is a convenience intended to be used within mash_light_update_uniforms() to help set uniforms. It should not generally need to be called by an application unless it is implementing its own lighting algorithms. @@ -697,43 +1269,69 @@ uniform. @direction_in should be an untransformed array of 3 floats representing a vector. The vector will be transformed into eye space according to the inverse transposed matrix of @light so that it won't change direction for non-uniform scaling transformations. + + + The #MashLight which is generating the shader + + - The location of the uniform + The location of the uniform - The untransformed direction uniform + The untransformed direction uniform - - Sets the ‘specular’ color emitted by the light. The specular color + + Sets the ‘specular’ color emitted by the light. The specular color is used to add highlights to an object wherever the angle to the light is close to the angle that the object is being viewed from. For example, if you were modelling a snooker ball with a bright light above it, this property will allow you add a bright part where the light can directly reflect off the ball into the eye. It is common to set this to a bright white value. + + + The #MashLight to modify + + - The new color value + The new color value - This function is used by #MashLightSet to implement the lights. It + This function is used by #MashLightSet to implement the lights. It should not need to be called by an application directly. This function is virtual and can be overriden by subclasses to @@ -751,23 +1349,47 @@ queried to the locations of named uniforms. mash_light_get_uniform_location() can be used to make this easier when a uniform is named uniquely using the ‘$’ symbol in mash_light_append_shader(). + + + The #MashLight that needs updating + + - A #CoglProgram containing the uniforms + A #CoglProgram containing the uniforms - + - + - + @@ -780,24 +1402,33 @@ in mash_light_append_shader(). + + + A #MashLight - A location to append uniforms declarations to + A location to append uniforms declarations to - A location to append lighting algorithm snippets to + A location to append lighting algorithm snippets to @@ -805,22 +1436,32 @@ in mash_light_append_shader(). + + The #MashLight that needs updating - A #CoglProgram containing the uniforms + A #CoglProgram containing the uniforms - + + glib:type-name="MashLightSet" glib:get-type="mash_light_set_get_type" glib:type-struct="LightSetClass"> - The #MashLightSet structure contains only private data. + The #MashLightSet structure contains only private data. + - Constructs a new #MashLightSet. + Constructs a new #MashLightSet. + - a new #MashLightSet. + a new #MashLightSet. - This adds a light to the set. Lights need to be added to the light + This adds a light to the set. Lights need to be added to the light set as well as to a container somewhere in the Clutter actor hierarchy in order to be useful. + + + A #MashLightSet instance + + - A #MashLight + A #MashLight - This function should only be needed by custom actors that wish to + version="0.2"> + This function should only be needed by custom actors that wish to use the lighting model of Mash. The function should be called every time the actor is painted. The @material parameter is used to specify the lighting material properties. The material is not @@ -869,25 +1530,47 @@ cogl_material_set_user_program(). #MashModel<!-- -->s are already designed to use this function when a light set is passed to mash_model_set_light_set(). - - a CoglProgram to use for rendering. + + + a CoglProgram to use for rendering. + + A #MashLightSet instance + + - The material that will be used to paint + The material that will be used to paint - Removes a light from the set. + Removes a light from the set. + + + A #MashLightSet instance + + - A #MashLight + A #MashLight @@ -902,13 +1585,45 @@ a light set is passed to mash_model_set_light_set(). - The #MashLightSetClass structure contains only private data. + The #MashLightSetClass structure contains only private data. + - + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="MashModel" glib:get-type="mash_model_get_type" glib:type-struct="ModelClass"> - The #MashModel structure contains only private data. + The #MashModel structure contains only private data. + - Constructs a new #MashModel. Nothing will be rendered by the + Constructs a new #MashModel. Nothing will be rendered by the model until a #MashData is attached using mash_model_set_data(). + - a new #MashModel. + a new #MashModel. - This is a convenience function that creates a new #MashData + This is a convenience function that creates a new #MashData and immediately loads the data in @filename. If the load succeeds a new #MashModel will be created for the data. The model has a default white material so that if vertices of the model have any color attributes they will be used directly. The material does not have textures by default so if you want the model to be textured you will need to modify the material. + - a new #MashModel or %NULL if the load failed. + a new #MashModel or %NULL if the load failed. - Flags for loading the data. + Flags for loading the data. - The name of a PLY file to load. + The name of a PLY file to load. - Gets the model data that will be used to render the actor. + Gets the model data that will be used to render the actor. + - A pointer to a #MashData instance or %NULL if no data has been set yet. + A pointer to a #MashData instance or %NULL if +no data has been set yet. + + + A #MashModel instance + + + + c:identifier="mash_model_get_fit_to_allocation" + glib:get-property="fit-to-allocation"> + - whether the actor will try to scale the model to fit within the allocation. + whether the actor will try to scale the model to fit +within the allocation. + + + A #MashModel instance + + + + - the #MashLightSet previously set with mash_model_set_light_set(). + the #MashLightSet previously set with +mash_model_set_light_set(). + + + A #MashModel instance + + + - - Gets the material that will be used to render the model. The + + Gets the material that will be used to render the model. The material can be modified to affect the appearence of the model. By default the material will be solid white. - - a handle to the Cogl material used by the model. + + + a handle to the Cogl material used by the model. + + + A #MashModel instance + + + - - Replaces the data used by the actor with @data. A reference is + + Replaces the data used by the actor with @data. A reference is taken on @data so if you no longer need it you should unref it with g_object_unref(). + + + A #MashModel instance + + - The new #MashData + The new #MashData - This sets whether the actor should scale the model to fit the + c:identifier="mash_model_set_fit_to_allocation" + glib:set-property="fit-to-allocation"> + This sets whether the actor should scale the model to fit the actor's allocation. If it's %TRUE then all of the axes of the model will be scaled by the same amount to fill the allocation as much as possible without distorting the aspect ratio. The model is also @@ -1031,35 +1831,58 @@ model extends past the allocated size then it will draw outside the allocation. The default value is %TRUE. + + + A #MashModel instance + + - New value + New value - This sets the #MashLightSet that will be used to render the + This sets the #MashLightSet that will be used to render the model. Alternatively %NULL can be passed to disable lighting for this model. The light set represents a collection of #MashLight<!-- -->s that will affect the appearance of the model. + + + A #MashModel instance + + - A new #MashLightSet + A new #MashLightSet - Replaces the material that will be used to render the model with + Replaces the material that will be used to render the model with the given one. By default a #MashModel will use a solid white material. However the color of the material is still blended with the vertex colors so the white material will cause the vertex @@ -1073,25 +1896,45 @@ set. If multiple models are expected to use the same material with different light sets, it would be better to use a different copy of the same material for each set of models so that they don't repeatedly change the program on the material during paint. + + + A #MashModel instance + + - A handle to a Cogl material + A handle to a Cogl material - + - + transfer-ownership="none" + setter="set_fit_to_allocation" + getter="get_fit_to_allocation" + default-value="TRUE"> + - + - The #MashModelClass structure contains only private data. + The #MashModelClass structure contains only private data. + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="MashPlyLoader" glib:get-type="mash_ply_loader_get_type" glib:type-struct="PlyLoaderClass"> + @@ -1134,13 +2039,16 @@ repeatedly change the program on the material during paint. + + disguised="1" + opaque="1"> + glib:type-name="MashPointLight" glib:get-type="mash_point_light_get_type" glib:type-struct="PointLightClass"> - The #MashLightClass structure contains only private data. + The #MashLightClass structure contains only private data. + - Constructs a new #MashPointLight. + Constructs a new #MashPointLight. + - the new light. + the new light. + c:identifier="mash_point_light_get_constant_attenuation" + glib:get-property="constant-attenuation"> + - the constant light attenuation value. + the constant light attenuation value. + + + The light to query + + + + c:identifier="mash_point_light_get_linear_attenuation" + glib:get-property="linear-attenuation"> + - the linear light attenuation value. + the linear light attenuation value. + + + The light to query + + + + c:identifier="mash_point_light_get_quadratic_attenuation" + glib:get-property="quadratic-attenuation"> + - the quadratic light attenuation value. + the quadratic light attenuation value. + + + The light to query + + + - Sets the constant attenuation value on a light. The light intensity + c:identifier="mash_point_light_set_constant_attenuation" + glib:set-property="constant-attenuation"> + Sets the constant attenuation value on a light. The light intensity is divided by this value. Setting a higher value will cause the light to appear dimmer. + + + The light to modify + + - The new value + The new value - Sets the linear attenuation value on a light. The light intensity + c:identifier="mash_point_light_set_linear_attenuation" + glib:set-property="linear-attenuation"> + Sets the linear attenuation value on a light. The light intensity is divided by this value multiplied by the distance to the light. Setting a higher value will cause the intensity to dim faster as the vertex moves away from the light. + + + The light to modify + + - The new value + The new value - Sets the quadratic attenuation value on a light. The light + c:identifier="mash_point_light_set_quadratic_attenuation" + glib:set-property="quadratic-attenuation"> + Sets the quadratic attenuation value on a light. The light intensity is divided by this value multiplied by the square of the distance to the light. Setting a higher value will cause the intensity to dim sharply as the vertex moves away from the light. + + + The light to modify + + - The new value + The new value - + transfer-ownership="none" + setter="set_constant_attenuation" + getter="get_constant_attenuation" + default-value="1.000000"> + - + transfer-ownership="none" + setter="set_linear_attenuation" + getter="get_linear_attenuation" + default-value="0.000000"> + - + transfer-ownership="none" + setter="set_quadratic_attenuation" + getter="get_quadratic_attenuation" + default-value="0.000000"> + @@ -1254,15 +2251,47 @@ intensity to dim sharply as the vertex moves away from the light. - The #MashPointLightClass structure contains only private data. + The #MashPointLightClass structure contains only private data. + + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + + glib:type-name="MashSpotLight" glib:get-type="mash_spot_light_get_type" glib:type-struct="SpotLightClass"> - The #MashSpotLight structure contains only private data. + The #MashSpotLight structure contains only private data. + - Constructs a new #MashSpotLight. + Constructs a new #MashSpotLight. + - the new light. + the new light. + c:identifier="mash_spot_light_get_spot_cutoff" + glib:get-property="spot-cutoff"> + - the spot cut off value + the spot cut off value + + + The light to query + + + + c:identifier="mash_spot_light_get_spot_exponent" + glib:get-property="spot-exponent"> + - the spot exponent value + the spot exponent value + + + The light to query + + + - Sets the spot cut off value on a light. This is an angle in degrees + c:identifier="mash_spot_light_set_spot_cutoff" + glib:set-property="spot-cutoff"> + Sets the spot cut off value on a light. This is an angle in degrees which defines the shape of the cone of light emitted from the light. It should be within the range 0° to 90° + + + The light to modify + + - The new value + The new value - Sets the spot exponent value on a light. The light intensity is + c:identifier="mash_spot_light_set_spot_exponent" + glib:set-property="spot-exponent"> + Sets the spot exponent value on a light. The light intensity is multiplied by the angle between the light direction and the vector to the vertex raised to the power of the exponent. A higher exponent value makes the cone of the light appear smaller. + + + The light to modify + + - The new value + The new value - - + + - - + + @@ -1343,14 +2438,194 @@ exponent value makes the cone of the light appear smaller. - The #MashSpotLightClass structure contains only private data. + The #MashSpotLightClass structure contains only private data. + + disguised="1" + opaque="1"> + + + #MashData is an object that can represent the data contained +in a 3D model file. The data is internally converted to a +Cogl vertex buffer so that it can be rendered efficiently. + +The #MashData object is usually associated with a +#MashModel so that it can be animated as a regular actor. The +data is separated from the actor in this way to make it easy to +share data with multiple actors without having to keep two copies +of the data. + + + #MashDirectionalLight is the simplest light type implemented in +Mash. It is intended to model a light that has a direction but it +is infinitely far away. This means that the light will always reach +the model regardless of its position. The light does however have a +direction so the light intensity will be altered depending on the +orientation of the vertex. Directional lights are useful for +example to model the light emitted from the sun in an outdoor +scene. + +The actor position of a #MashDirectionalLight is ignored. The +direction of the light is always along the positive y axis (which +is towards the bottom of the stage by default in Clutter). However +the direction of the light is affected by the actor's +transformation so it can be modified using the rotation properties. + + + #MashLight is the abstract base class of all lights in Mash. It can +not be instantiated directly. Instead one of its subclasses should +be used such as #MashPointLight, #MashSpotLight or +#MashDirectionalLight. + +#MashLight<!-- -->s must be added to a #MashLightSet and a parent +container before they will have any effect. + +#MashLight contains three light colors that are common to all +three light types that Mash supports. These are ambient, diffuse +and specular. The colors are of the lights are combined with the +corresponding colors of the #CoglMaterial to give a final fragment +color. The material colors can be changed for a #MashModel by +extracting the #CoglMaterial with mash_model_get_material() and +then calling functions such as cogl_material_set_diffuse(). + +#MashLight can be subclassed in an application to provide custom +lighting algorithms. + + + #MashLightSet is a toplevel object that contains a list of +#MashLight<!-- -->s. The set which a light belongs to is separate +from its parent actor. For a light to be useful it needs to be +added to both a light set and a parent container. + +The #MashLightSet can only be used with actors that are +specifically designed to support it. #MashModel is one such +actor. It can be told to use a light set with +mash_model_set_light_set(). + +The light set implements the Blinn-Phong lighting model which is +the standard model used in fixed function version of OpenGL and +Direct3D. The lighting calculations are performed per-vertex and +then interpolated across the surface of the primitives. + +Lights are positioned as normal actors by adding #MashLight<!-- +-->s them to a container and moving them. The lights do not have to +be in any particular position relative to the models in the +hierarchy of actors, although it wouldn't make much sense if they +were on different stages. The lights are subclasses of +#ClutterActor so they can be positioned and animated using the +usual Clutter animation framework. + +The lighting implementation requires GLSL support from Clutter. If +the application can still work without lighting it would be worth +checking for shader support by passing %COGL_FEATURE_SHADERS_GLSL +to cogl_features_available(). + +It should be possible to extend the lighting model and implement +application-specific lighting algorithms by subclassing #MashLight +and adding shader snippets by overriding +mash_light_generate_shader(). + + + #MashModel is an actor subclass that can be used to render a +3D model. The model is a normal #ClutterActor that can be animated +and positioned with the methods of #ClutterActor. + +By default the model will be scaled to best fit within the size of +the actor. Therefore it is possible to take a small model that may +have positions ranging between -1 and 1 and draw it at a larger +size just by setting the size on the actor. This behaviour can be +disabled with mash_model_set_fit_to_allocation(). + +The actual data for the model is stored in a separate object called +#MashData. This can be used to share the data for a model +between multiple actors without having to duplicate resources of +the data. Alternatively mash_model_new_from_file() can be +used as a convenience wrapper to easily make an actor out of a PLY +without having to worry about #MashData. To share the data +with another actor, call mash_model_get_data() on an +existing actor then call mash_model_set_data() with the +return value on a new actor. + +The model can be rendered with any Cogl material. By default the +model will use a solid white material. The material color is +blended with the model's vertex colors so the white material will +cause the vertex colors to be used directly. #MashData is +able to load texture coordinates from the PLY file so it is +possible to render a textured model by setting a texture layer on +the material, like so: + +|[ + /&ast; Create an actor out of a PLY model file &ast;/ + ClutterActor *model + = mash_model_new_from_file ("some-model.ply", NULL); + /&ast; Get a handle to the default material for the actor &ast;/ + CoglHandle material + = mash_model_get_material (MASH_MODEL (model)); + /&ast; Load a texture image from a file &ast;/ + CoglHandle texture + = cogl_texture_new_from_file ("some-image.png", COGL_TEXTURE_NONE, + COGL_PIXEL_FORMAT_ANY, NULL); + /&ast; Set a texture layer on the material &ast;/ + cogl_material_set_layer (material, 0, texture); + /&ast; The texture is now referenced by the material so we can + drop the reference we have &ast;/ + cogl_handle_unref (texture); +]| + + + A #MashPointLight models a light that has a position and emits +light evenly in all directions. The position of the light is taken +from the actor's position so it can be easily modified and even +animated using the #ClutterActor properties. The intensity of the +light can be attenuated using the attenuation properties to make +objects that are further from the light receive less intensity. The +intensity of the light is divided by ad² + bd + c, where d is the +distance between the light and the vertex and a, b and c are the +following properties which can be modified on the light: +quadratic-attenuation, linear-attenuation and constant-attenuation. + +By default the attenuation values are all zero except for the +constant attenuation. This causes the light to never be attenuated +so that the light intensity is not affected by the distance from +the light. + + + A #MashSpotLight is a subclass of #MashPointLight which +additionally restricts the light emitted to a cone shape eminating +from the light's position. The same attenuation properties provided +by #MashPointLight can be used to modify the intensity based on the +distance to the light. The angle of the cone can be modified with +the spot-cutoff property and the spot-exponent property. The cutoff +sets a hard restriction on the maximum angle which light will be +emitted. The exponent sets the rate at which light dims as the +angle expands out. + +The direction of a spot light is always along the positive y axis +which is towards the bottom of the stage in a default Clutter +scene. The direction is affected by the actor's transformation so +it can be modified or animated by rotating the actor. + diff --git a/girs/Matekbd-1.0.gir b/girs/Matekbd-1.0.gir index 6ce682b3b..48962bcbc 100644 --- a/girs/Matekbd-1.0.gir +++ b/girs/Matekbd-1.0.gir @@ -12,7 +12,7 @@ and/or use gtk-doc annotations. --> @@ -36,7 +36,7 @@ and/or use gtk-doc annotations. --> - + @@ -298,7 +298,7 @@ and/or use gtk-doc annotations. --> List of group names + line="874">List of group names @@ -329,7 +329,7 @@ and/or use gtk-doc annotations. --> The engine shared by all MatekbdIndicator objects + line="863">The engine shared by all MatekbdIndicator objects @@ -458,7 +458,7 @@ and/or use gtk-doc annotations. --> - + @@ -585,7 +585,7 @@ and/or use gtk-doc annotations. --> closure="1"> a function to call when settings are changed + line="319">a function to call when settings are changed - + @@ -834,7 +834,7 @@ and/or use gtk-doc annotations. --> List of options + line="763">List of options @@ -945,7 +945,7 @@ and/or use gtk-doc annotations. --> - + @@ -1033,7 +1033,7 @@ and/or use gtk-doc annotations. --> - + @@ -1052,57 +1052,57 @@ and/or use gtk-doc annotations. --> Renders a keyboard layout to a cairo_t context. @cr and @layout can be got + line="2417">Renders a keyboard layout to a cairo_t context. @cr and @layout can be got from e.g. a GtkWidget or a GtkPrintContext. @cr and @layout may be modified by the function but will not be unreffed. %TRUE on success, %FALSE on failure + line="2431">%TRUE on success, %FALSE on failure keyboard layout to render + line="2419">keyboard layout to render Cairo context to render to + line="2420">Cairo context to render to Pango layout to use to render text + line="2421">Pango layout to use to render text left coordinate (pixels) of region to render in + line="2422">left coordinate (pixels) of region to render in top coordinate (pixels) of region to render in + line="2423">top coordinate (pixels) of region to render in width (pixels) of region to render in + line="2424">width (pixels) of region to render in height (pixels) of region to render in + line="2425">height (pixels) of region to render in @@ -1481,7 +1481,7 @@ by the function but will not be unreffed. List of group names + line="855">List of group names @@ -1505,7 +1505,7 @@ by the function but will not be unreffed. The engine shared by all MatekbdStatus objects + line="844">The engine shared by all MatekbdStatus objects @@ -1581,7 +1581,7 @@ by the function but will not be unreffed. List of options + line="763">List of options diff --git a/girs/Nice-0.1.gir b/girs/Nice-0.1.gir index 7df2be2bc..39d0684b3 100644 --- a/girs/Nice-0.1.gir +++ b/girs/Nice-0.1.gir @@ -41,22 +41,29 @@ and/or use gtk-doc annotations. --> + c:type="NICE_AGENT_MAX_REMOTE_CANDIDATES" + deprecated="1" + deprecated-version="0.1.20"> A hard limit for the number of remote candidates. This -limit is enforced to protect against malevolent remote -clients. - + line="260">Was a limit on the number of remote candidates one can set, but is +no longer used by libnice itself. + Replace with dynamic value based on the +#NiceAgent::max-connectivity-checks property + - + The #NiceAddress structure that represents an IPv4 or IPv6 address. - + line="72">The #NiceAddress structure that represents an IPv4 or IPv6 address. + - + @@ -67,12 +74,25 @@ clients. + + Create a new #NiceAddress with undefined address +You must free it with nice_address_free() + + + The new #NiceAddress + + + Fills the sockaddr structure @sin with the address contained in @addr - + line="222">Fills the sockaddr structure @sin with the address contained in @addr + @@ -80,7 +100,7 @@ clients. The #NiceAddress to query + line="224">The #NiceAddress to query allow-none="1"> The sockaddr to fill + line="225">The sockaddr to fill - + Creates a new #NiceAddress with the same address as @addr - - + line="129">Creates a new #NiceAddress with the same address as @addr + + The new #NiceAddress + line="135">The new #NiceAddress The #NiceAddress to dup + line="131">The #NiceAddress to dup + + + + + + Transforms the address @addr into a newly allocated human readable string + + + the address string + + + + + The #NiceAddress to query @@ -117,26 +159,26 @@ clients. Compares two #NiceAddress structures to see if they contain the same address + line="233">Compares two #NiceAddress structures to see if they contain the same address and the same port. - + %TRUE if @a and @b are the same address, %FALSE if they are different + line="241">%TRUE if @a and @b are the same address, %FALSE if they are different First #NiceAddress to compare + line="235">First #NiceAddress to compare Second #NiceAddress to compare + line="236">Second #NiceAddress to compare @@ -146,13 +188,13 @@ and the same port. version="0.1.8"> Compares two #NiceAddress structures to see if they contain the same address, + line="246">Compares two #NiceAddress structures to see if they contain the same address, ignoring the port. - + %TRUE if @a and @b are the same address, %FALSE if they + line="254">%TRUE if @a and @b are the same address, %FALSE if they are different @@ -160,13 +202,13 @@ are different First #NiceAddress to compare + line="248">First #NiceAddress to compare Second #NiceAddress to compare + line="249">Second #NiceAddress to compare @@ -174,8 +216,8 @@ are different Frees a #NiceAddress created with nice_address_new() or nice_address_dup() - + line="120">Frees a #NiceAddress created with nice_address_new() or nice_address_dup() + @@ -183,7 +225,7 @@ are different The #NiceAddress to free + line="122">The #NiceAddress to free @@ -191,19 +233,19 @@ are different Retreive the port of @addr - + line="187">Retreive the port of @addr + The port of @addr + line="193">The port of @addr The #NiceAddress to query + line="189">The #NiceAddress to query @@ -211,8 +253,8 @@ are different Initialize a #NiceAddress into an undefined address - + line="100">Initialize a #NiceAddress into an undefined address + @@ -220,7 +262,7 @@ are different The #NiceAddress to init + line="102">The #NiceAddress to init @@ -228,19 +270,41 @@ are different Returns the IP version of the address - + line="322">Returns the IP version of the address + 4 for IPv4, 6 for IPv6 and 0 for undefined address + line="328">4 for IPv4, 6 for IPv6 and 0 for undefined address The #NiceAddress to query + line="324">The #NiceAddress to query + + + + + + Verifies if the address in @addr is a link-local address or not + + + %TRUE if @addr is a link-local address, %FALSE otherwise + + + + + The #NiceAddress to query @@ -248,19 +312,19 @@ are different Verifies if the address in @addr is a private address or not - + line="286">Verifies if the address in @addr is a private address or not + %TRUE if @addr is a private address, %FALSE otherwise + line="292">%TRUE if @addr is a private address, %FALSE otherwise The #NiceAddress to query + line="288">The #NiceAddress to query @@ -268,19 +332,19 @@ are different Validate whether the #NiceAddress @addr is a valid IPv4 or IPv6 address - + line="310">Validate whether the #NiceAddress @addr is a valid IPv4 or IPv6 address + %TRUE if @addr is valid, %FALSE otherwise + line="316">%TRUE if @addr is valid, %FALSE otherwise The #NiceAddress to query + line="312">The #NiceAddress to query @@ -289,8 +353,8 @@ are different c:identifier="nice_address_set_from_sockaddr"> Sets an IPv4 or IPv6 address from the sockaddr structure @sin - + line="210">Sets an IPv4 or IPv6 address from the sockaddr structure @sin + @@ -298,7 +362,7 @@ are different The #NiceAddress to modify + line="212">The #NiceAddress to modify allow-none="1"> The sockaddr to set + line="213">The sockaddr to set @@ -316,25 +380,25 @@ are different c:identifier="nice_address_set_from_string"> Sets an IPv4 or IPv6 address from the string @str - + line="198">Sets an IPv4 or IPv6 address from the string @str + %TRUE if success, %FALSE on error + line="205">%TRUE if success, %FALSE on error The #NiceAddress to modify + line="200">The #NiceAddress to modify The string to set + line="201">The string to set @@ -342,7 +406,7 @@ are different Set @addr to an IPv4 address using the data from @addr_ipv4 + line="141">Set @addr to an IPv4 address using the data from @addr_ipv4 <note> <para> @@ -350,7 +414,7 @@ are different nice_address_set_port() </para> </note> - + @@ -358,13 +422,13 @@ are different The #NiceAddress to modify + line="143">The #NiceAddress to modify The IPv4 address + line="144">The IPv4 address @@ -372,7 +436,7 @@ are different Set @addr to an IPv6 address using the data from @addr_ipv6 + line="159">Set @addr to an IPv6 address using the data from @addr_ipv6 <note> <para> @@ -380,7 +444,7 @@ are different nice_address_set_port() </para> </note> - + @@ -388,13 +452,13 @@ are different The #NiceAddress to modify + line="161">The #NiceAddress to modify The IPv6 address + line="162">The IPv6 address @@ -402,8 +466,8 @@ are different Set the port of @addr to @port - + line="177">Set the port of @addr to @port + @@ -411,22 +475,24 @@ are different The #NiceAddress to modify + line="179">The #NiceAddress to modify The port to set + line="180">The port to set - + Transforms the address @addr into a human readable string - + line="262">Transforms the address @addr into a human readable string + @@ -434,30 +500,17 @@ are different The #NiceAddress to query + line="264">The #NiceAddress to query The string to fill + line="265">The string to fill - - Create a new #NiceAddress with undefined address -You must free it with nice_address_free() - - - The new #NiceAddress - - - Create a new #NiceAgent. + line="451">Create a new #NiceAgent. The returned object must be freed with g_object_unref() - + The new agent GObject + line="459">The new agent GObject The Glib Mainloop Context to use for timers + line="453">The Glib Mainloop Context to use for timers The compatibility mode of the agent + line="454">The compatibility mode of the agent @@ -503,34 +556,34 @@ The returned object must be freed with g_object_unref() version="0.1.15"> Create a new #NiceAgent with parameters that must be be defined at + line="483">Create a new #NiceAgent with parameters that must be be defined at construction time. The returned object must be freed with g_object_unref() <para> See also: #NiceNominationMode and #NiceAgentOption</para> - + The new agent GObject + line="496">The new agent GObject The Glib Mainloop Context to use for timers + line="485">The Glib Mainloop Context to use for timers The compatibility mode of the agent + line="486">The compatibility mode of the agent Flags to set the properties + line="487">Flags to set the properties @@ -540,29 +593,29 @@ The returned object must be freed with g_object_unref() version="0.0.11"> Create a new #NiceAgent in reliable mode. If the connectivity is established + line="465">Create a new #NiceAgent in reliable mode. If the connectivity is established through ICE-UDP, then a #PseudoTcpSocket will be transparently used to ensure reliability of the messages. The returned object must be freed with g_object_unref() <para> See also: #NiceAgent::reliable-transport-writable </para> - + The new agent GObject + line="478">The new agent GObject The Glib Mainloop Context to use for timers + line="467">The Glib Mainloop Context to use for timers The compatibility mode of the agent + line="468">The compatibility mode of the agent @@ -571,7 +624,7 @@ The returned object must be freed with g_object_unref() c:identifier="nice_agent_add_local_address"> Add a local address from which to derive local host candidates for + line="503">Add a local address from which to derive local host candidates for candidate gathering. <para> Since 0.0.5, if this method is not called, libnice will automatically @@ -579,24 +632,24 @@ discover the local addresses available </para> See also: nice_agent_gather_candidates() - + %TRUE on success, %FALSE on fatal (memory allocation) errors + line="517">%TRUE on success, %FALSE on fatal (memory allocation) errors The #NiceAgent Object + line="505">The #NiceAgent Object The address to listen to + line="506">The address to listen to If the port is 0, then a random port will be chosen by the system @@ -605,26 +658,26 @@ If the port is 0, then a random port will be chosen by the system Adds a data stream to @agent containing @n_components components. The + line="522">Adds a data stream to @agent containing @n_components components. The returned stream ID is guaranteed to be positive on success. - + The ID of the new stream, 0 on failure + line="530">The ID of the new stream, 0 on failure The #NiceAgent Object + line="524">The #NiceAgent Object The number of components to add to the stream + line="525">The number of components to add to the stream @@ -634,7 +687,7 @@ returned stream ID is guaranteed to be positive on success. introspectable="0"> Attaches the stream's component's sockets to the Glib Mainloop Context in + line="965">Attaches the stream's component's sockets to the Glib Mainloop Context in order to be notified whenever data becomes available for a component, and to enable #NiceAgent to receive STUN messages (during the establishment of ICE connectivity). @@ -647,42 +700,42 @@ callback and cause reception to be paused for the given stream/component pair. You must iterate the previously specified #GMainContext sufficiently to ensure all pending I/O callbacks have been received before calling this function to unset @func, otherwise data loss of received packets may occur. - + %TRUE on success, %FALSE if the stream or component IDs are invalid. + line="990">%TRUE on success, %FALSE if the stream or component IDs are invalid. The #NiceAgent Object + line="967">The #NiceAgent Object The ID of stream + line="968">The ID of stream The ID of the component + line="969">The ID of the component The Glib Mainloop Context to use for listening on the component + line="970">The Glib Mainloop Context to use for listening on the component The callback function to be called when data is received on + line="971">The callback function to be called when data is received on the stream's component (will not be called for STUN messages that should be handled by #NiceAgent itself) @@ -693,7 +746,7 @@ should be handled by #NiceAgent itself) allow-none="1"> user data associated with the callback + line="974">user data associated with the callback @@ -703,7 +756,7 @@ should be handled by #NiceAgent itself) version="0.1.16"> Asynchronously closes resources the agent has allocated on remote servers. + line="1704">Asynchronously closes resources the agent has allocated on remote servers. The agent will call the callback in the current #GMainContext in which this function is called. The #GAsyncResult in the callback @@ -711,7 +764,7 @@ can be ignored as this operation never fails. Calling this function before freeing the agent makes sure the allocated relay ports aren't left behind on TURN server but properly removed. - + @@ -719,7 +772,7 @@ ports aren't left behind on TURN server but properly removed. The #NiceAgent object + line="1706">The #NiceAgent object closure="1"> A callback that will be called when the closing is + line="1707">A callback that will be called when the closing is complete @@ -740,7 +793,7 @@ ports aren't left behind on TURN server but properly removed. allow-none="1"> A pointer that will be passed to the callback + line="1709">A pointer that will be passed to the callback @@ -750,7 +803,7 @@ ports aren't left behind on TURN server but properly removed. version="0.1.19"> Notifies the agent that consent to receive has been revoked. This will + line="1676">Notifies the agent that consent to receive has been revoked. This will cause the component to fail with 403 'Forbidden' all incoming STUN binding requests as specified in RFC 7675. @@ -760,11 +813,11 @@ nice_agent_restart_stream(). Calling the function only has an effect when @agent has been created with @NICE_AGENT_OPTION_CONSENT_FRESHNESS. - + %FALSE if the stream or component could not be found or consent + line="1693">%FALSE if the stream or component could not be found or consent freshness is not enabled, %TRUE otherwise @@ -772,19 +825,19 @@ Calling the function only has an effect when @agent has been created with The #NiceAgent Object + line="1678">The #NiceAgent Object The ID of the stream + line="1679">The ID of the stream The ID of the component + line="1680">The ID of the component @@ -794,34 +847,34 @@ Calling the function only has an effect when @agent has been created with version="0.1.6"> Forget all the relay servers previously added using + line="1615">Forget all the relay servers previously added using nice_agent_set_relay_info(). Currently connected streams will keep using the relay as long as they have not been restarted and haven't succesfully negotiated a different path. - + %FALSE if the component could not be found, %TRUE otherwise + line="1626">%FALSE if the component could not be found, %TRUE otherwise The #NiceAgent Object + line="1617">The #NiceAgent Object The ID of the stream + line="1618">The ID of the stream The ID of the component + line="1619">The ID of the component @@ -830,7 +883,7 @@ succesfully negotiated a different path. c:identifier="nice_agent_gather_candidates"> Allocate and start listening on local candidate ports and start the remote + line="608">Allocate and start listening on local candidate ports and start the remote candidate gathering process. Once done, #NiceAgent::candidate-gathering-done is called for the stream. As soon as this function is called, #NiceAgent::new-candidate signals may be @@ -841,11 +894,11 @@ calling this function. <para>See also: nice_agent_add_local_address()</para> <para>See also: nice_agent_set_port_range()</para> - + %FALSE if the stream ID is invalid or if a host candidate couldn't + line="625">%FALSE if the stream ID is invalid or if a host candidate couldn't be allocated on the requested interfaces/ports; %TRUE otherwise <note> @@ -864,13 +917,13 @@ be allocated on the requested interfaces/ports; %TRUE otherwise The #NiceAgent object + line="610">The #NiceAgent object The ID of the stream to start + line="611">The ID of the stream to start @@ -880,16 +933,16 @@ be allocated on the requested interfaces/ports; %TRUE otherwise version="0.1.4"> Generate an SDP string representing a local candidate. + line="1480">Generate an SDP string representing a local candidate. <para>See also: nice_agent_parse_remote_candidate_sdp() </para> <para>See also: nice_agent_generate_local_sdp() </para> <para>See also: nice_agent_generate_local_stream_sdp() </para> - + A string representing the SDP for the candidate. Must be freed + line="1491">A string representing the SDP for the candidate. Must be freed with g_free() once done. @@ -897,13 +950,13 @@ with g_free() once done. The #NiceAgent Object + line="1482">The #NiceAgent Object The candidate to generate + line="1483">The candidate to generate @@ -913,7 +966,7 @@ with g_free() once done. version="0.1.4"> Generate an SDP string containing the local candidates and credentials for + line="1399">Generate an SDP string containing the local candidates and credentials for all streams and components in the agent. <note> @@ -938,11 +991,11 @@ all streams and components in the agent. <para>See also: nice_agent_generate_local_stream_sdp() </para> <para>See also: nice_agent_generate_local_candidate_sdp() </para> <para>See also: nice_agent_get_default_local_candidate() </para> - + A string representing the local SDP. Must be freed with g_free() + line="1429">A string representing the local SDP. Must be freed with g_free() once done. @@ -950,7 +1003,7 @@ once done. The #NiceAgent Object + line="1401">The #NiceAgent Object @@ -960,7 +1013,7 @@ once done. version="0.1.4"> Generate an SDP string containing the local candidates and credentials + line="1438">Generate an SDP string containing the local candidates and credentials for a stream. <note> @@ -983,11 +1036,11 @@ for a stream. <para>See also: nice_agent_generate_local_sdp() </para> <para>See also: nice_agent_generate_local_candidate_sdp() </para> <para>See also: nice_agent_get_default_local_candidate() </para> - + A string representing the local SDP for the stream. Must be freed + line="1469">A string representing the local SDP for the stream. Must be freed with g_free() once done. @@ -995,19 +1048,19 @@ with g_free() once done. The #NiceAgent Object + line="1440">The #NiceAgent Object The ID of the stream + line="1441">The ID of the stream Whether or not to include non ICE specific lines + line="1442">Whether or not to include non ICE specific lines (m=, c= and a=rtcp: lines) @@ -1018,12 +1071,12 @@ with g_free() once done. version="0.1.8"> Retrieves the current state of a component. - + line="1635">Retrieves the current state of a component. + the #NiceComponentState of the component and + line="1643">the #NiceComponentState of the component and %NICE_COMPONENT_STATE_FAILED if the component was invalid. @@ -1031,19 +1084,19 @@ with g_free() once done. The #NiceAgent Object + line="1637">The #NiceAgent Object The ID of the stream + line="1638">The ID of the stream The ID of the component + line="1639">The ID of the component @@ -1052,7 +1105,7 @@ with g_free() once done. c:identifier="nice_agent_get_default_local_candidate"> This helper function will return the recommended default candidate to be + line="1372">This helper function will return the recommended default candidate to be used for non-ICE compatible clients. This will usually be the candidate with the lowest priority, since it will be the longest path but the one with the most chances of success. @@ -1062,11 +1115,11 @@ the most chances of success. local SDP </para> </note> - + The candidate to be used as the default candidate, or %NULL in case + line="1389">The candidate to be used as the default candidate, or %NULL in case of error. Must be freed with nice_candidate_free() once done. @@ -1074,19 +1127,19 @@ of error. Must be freed with nice_candidate_free() once done. The #NiceAgent Object + line="1374">The #NiceAgent Object The ID of the stream + line="1375">The ID of the stream The ID of the component + line="1376">The ID of the component @@ -1096,7 +1149,7 @@ of error. Must be freed with nice_candidate_free() once done. version="0.1.5"> Gets a #GIOStream wrapper around the given stream and component in + line="1577">Gets a #GIOStream wrapper around the given stream and component in @agent. The I/O stream will be valid for as long as @stream_id is valid. The #GInputStream and #GOutputStream implement #GPollableInputStream and #GPollableOutputStream. @@ -1104,30 +1157,30 @@ The #GInputStream and #GOutputStream implement #GPollableInputStream and This function may only be called on reliable #NiceAgents. It is a programming error to try and create an I/O stream wrapper for an unreliable stream. - + A #GIOStream. + line="1592">A #GIOStream. A #NiceAgent + line="1579">A #NiceAgent The ID of the stream to wrap + line="1580">The ID of the stream to wrap The ID of the component to wrap + line="1581">The ID of the component to wrap @@ -1136,7 +1189,7 @@ unreliable stream. c:identifier="nice_agent_get_local_candidates"> Retrieve from the agent the list of all local candidates + line="864">Retrieve from the agent the list of all local candidates for a stream's component <note> @@ -1147,11 +1200,11 @@ for a stream's component #NiceAgent::candidate-gathering-done signal. </para> </note> - + a #GSList of + line="882">a #GSList of #NiceCandidate objects representing the local candidates of @agent @@ -1161,19 +1214,19 @@ for a stream's component The #NiceAgent Object + line="866">The #NiceAgent Object The ID of the stream + line="867">The ID of the stream The ID of the component + line="868">The ID of the component @@ -1182,29 +1235,29 @@ for a stream's component c:identifier="nice_agent_get_local_credentials"> Gets the local credentials for stream @stream_id. This may be called any time + line="705">Gets the local credentials for stream @stream_id. This may be called any time after creating a stream using nice_agent_add_stream(). An error will be returned if this is called for a non-existent stream, or if either of @ufrag or @pwd are %NULL. - + %TRUE on success, %FALSE on error. + line="720">%TRUE on success, %FALSE on error. The #NiceAgent Object + line="707">The #NiceAgent Object The ID of the stream + line="708">The ID of the stream transfer-ownership="full"> return location for a nul-terminated string + line="709">return location for a nul-terminated string containing an ICE username fragment; must be freed with g_free() @@ -1223,7 +1276,7 @@ containing an ICE username fragment; must be freed with g_free() transfer-ownership="full"> return location for a nul-terminated string + line="711">return location for a nul-terminated string containing an ICE password; must be freed with g_free() @@ -1233,7 +1286,7 @@ containing an ICE password; must be freed with g_free() c:identifier="nice_agent_get_remote_candidates"> Get a list of the remote candidates set on a stream's component + line="892">Get a list of the remote candidates set on a stream's component <note> <para> @@ -1246,11 +1299,11 @@ containing an ICE password; must be freed with g_free() to get notified of new remote candidates. </para> </note> - + a #GSList of + line="912">a #GSList of #NiceCandidates objects representing the remote candidates set on the @agent @@ -1260,19 +1313,19 @@ containing an ICE password; must be freed with g_free() The #NiceAgent Object + line="894">The #NiceAgent Object The ID of the stream + line="895">The ID of the stream The ID of the component + line="896">The ID of the component @@ -1281,44 +1334,44 @@ containing an ICE password; must be freed with g_free() c:identifier="nice_agent_get_selected_pair"> Retreive the selected candidate pair for media transmission + line="1203">Retreive the selected candidate pair for media transmission for a given stream's component. - + %TRUE on success, %FALSE if there is no selected candidate pair + line="1214">%TRUE on success, %FALSE if there is no selected candidate pair The #NiceAgent Object + line="1205">The #NiceAgent Object The ID of the stream + line="1206">The ID of the stream The ID of the component + line="1207">The ID of the component The local selected candidate + line="1208">The local selected candidate The remote selected candidate + line="1209">The remote selected candidate @@ -1328,7 +1381,7 @@ for a given stream's component. version="0.1.5"> Retreive the local socket associated with the selected candidate pair + line="1224">Retreive the local socket associated with the selected candidate pair for media transmission for a given stream's component. This is useful for adding ICE support to legacy applications that already @@ -1340,11 +1393,11 @@ handling instead and let libnice handle the connection maintenance. Users of this method are encouraged to not use a TURN relay or any kind of proxy, as in this case, the socket will not be available to the application because the packets are encapsulated. - + pointer to the #GSocket, or %NULL if + line="1243">pointer to the #GSocket, or %NULL if there is no selected candidate or if the selected candidate is a relayed candidate. @@ -1353,19 +1406,19 @@ candidate. The #NiceAgent Object + line="1226">The #NiceAgent Object The ID of the stream + line="1227">The ID of the stream The ID of the component + line="1228">The ID of the component @@ -1375,18 +1428,18 @@ candidate. version="0.1.17"> Each component can have multiple sockets, this is an API to retrieve them all + line="1726">Each component can have multiple sockets, this is an API to retrieve them all to be able to set properties. Most of the sockets for a component are created when calling nice_agent_gather_candidates(), so this API should be called right after to able to set properties on the sockets before they are used. These sockets can be a mix of UDP & TCP sockets depending on the compatibility mode and options that have been set. - + An array + line="1740">An array containing all of the sockets for this component. Free with g_ptr_array_unref() when done. @@ -1397,19 +1450,19 @@ g_ptr_array_unref() when done. The #NiceAgent Object + line="1728">The #NiceAgent Object The ID of the stream + line="1729">The ID of the stream The ID of the component + line="1730">The ID of the component @@ -1419,14 +1472,14 @@ g_ptr_array_unref() when done. version="0.1.4"> This function will return the name assigned to a stream. + line="1353">This function will return the name assigned to a stream. <para>See also: nice_agent_set_stream_name()</para> - + The name of the stream. The name is only valid while the stream + line="1362">The name of the stream. The name is only valid while the stream exists or until it changes through a call to nice_agent_set_stream_name(). @@ -1434,13 +1487,13 @@ exists or until it changes through a call to nice_agent_set_stream_name(). The #NiceAgent Object + line="1355">The #NiceAgent Object The ID of the stream to change + line="1356">The ID of the stream to change @@ -1450,35 +1503,35 @@ exists or until it changes through a call to nice_agent_set_stream_name(). version="0.1.4"> Parse an SDP string and extracts the candidate from it. + line="1555">Parse an SDP string and extracts the candidate from it. <para>See also: nice_agent_generate_local_candidate_sdp() </para> <para>See also: nice_agent_parse_remote_sdp() </para> <para>See also: nice_agent_parse_remote_stream_sdp() </para> - + The parsed candidate or %NULL if there was an error. + line="1567">The parsed candidate or %NULL if there was an error. The #NiceAgent Object + line="1557">The #NiceAgent Object The ID of the stream the candidate belongs to + line="1558">The ID of the stream the candidate belongs to The remote SDP to parse + line="1559">The remote SDP to parse @@ -1488,31 +1541,31 @@ exists or until it changes through a call to nice_agent_set_stream_name(). version="0.1.4"> Parse an SDP string and extracts candidates and credentials from it and sets + line="1501">Parse an SDP string and extracts candidates and credentials from it and sets them on the agent. <para>See also: nice_agent_set_stream_name() </para> <para>See also: nice_agent_generate_local_sdp() </para> <para>See also: nice_agent_parse_remote_stream_sdp() </para> <para>See also: nice_agent_parse_remote_candidate_sdp() </para> - + The number of candidates added, negative on errors + line="1514">The number of candidates added, negative on errors The #NiceAgent Object + line="1503">The #NiceAgent Object The remote SDP to parse + line="1504">The remote SDP to parse @@ -1522,17 +1575,17 @@ them on the agent. version="0.1.4"> Parse an SDP string representing a single stream and extracts candidates + line="1524">Parse an SDP string representing a single stream and extracts candidates and credentials from it. <para>See also: nice_agent_generate_local_stream_sdp() </para> <para>See also: nice_agent_parse_remote_sdp() </para> <para>See also: nice_agent_parse_remote_candidate_sdp() </para> - + A #GSList of + line="1541">A #GSList of candidates parsed from the SDP, or %NULL in case of errors @@ -1542,32 +1595,32 @@ candidates parsed from the SDP, or %NULL in case of errors The #NiceAgent Object + line="1526">The #NiceAgent Object The ID of the stream to parse + line="1527">The ID of the stream to parse The remote SDP to parse + line="1528">The remote SDP to parse Pointer to store the ice ufrag if non %NULL. Must be freed with + line="1529">Pointer to store the ice ufrag if non %NULL. Must be freed with g_free() after use Pointer to store the ice password if non %NULL. Must be freed with + line="1531">Pointer to store the ice password if non %NULL. Must be freed with g_free() after use @@ -1578,7 +1631,7 @@ g_free() after use version="0.1.16"> Notifies the agent that the remote peer has concluded candidate gathering and + line="1653">Notifies the agent that the remote peer has concluded candidate gathering and thus no more remote candidates are expected to arrive for @stream_id. This will allow the stream components without a successful connectivity check @@ -1586,24 +1639,24 @@ to stop waiting for more candidates to come and finally transit into %NICE_COMPONENT_STATE_FAILED. Calling the function has an effect only when #NiceAgent:trickle-ice is %TRUE. - + %FALSE if the stream could not be found, %TRUE otherwise + line="1667">%FALSE if the stream could not be found, %TRUE otherwise The #NiceAgent Object + line="1655">The #NiceAgent Object The ID of the stream + line="1656">The ID of the stream @@ -1614,12 +1667,12 @@ Calling the function has an effect only when #NiceAgent:trickle-ice is %TRUE. A single-message version of nice_agent_recv_messages(). - + line="1001">A single-message version of nice_agent_recv_messages(). + the number of bytes written to @buf on success (guaranteed to be + line="1015">the number of bytes written to @buf on success (guaranteed to be greater than 0 unless @buf_len is 0), 0 if in reliable mode and the remote peer closed the stream, or -1 on error @@ -1628,19 +1681,19 @@ peer closed the stream, or -1 on error a #NiceAgent + line="1003">a #NiceAgent the ID of the stream to receive on + line="1004">the ID of the stream to receive on the ID of the component to receive on + line="1005">the ID of the component to receive on transfer-ownership="none"> caller-allocated buffer + line="1006">caller-allocated buffer to write the received data into, of length at least @buf_len @@ -1658,7 +1711,7 @@ to write the received data into, of length at least @buf_len length of @buf + line="1008">length of @buf allow-none="1"> a #GCancellable to allow the operation to be + line="1009">a #GCancellable to allow the operation to be cancelled from another thread, or %NULL @@ -1679,7 +1732,7 @@ cancelled from another thread, or %NULL throws="1"> Block on receiving data from the given stream/component combination on + line="1031">Block on receiving data from the given stream/component combination on @agent, returning only once exactly @n_messages messages have been received and written into @messages, the stream is closed by the other end or by calling nice_agent_remove_stream(), or @cancellable is cancelled. @@ -1712,11 +1765,11 @@ If the stream/component pair doesn’t exist, or if a suitable candidate socket hasn’t yet been selected for it, a %G_IO_ERROR_BROKEN_PIPE error will be returned. A %G_IO_ERROR_CANCELLED error will be returned if the operation was cancelled. %G_IO_ERROR_FAILED will be returned for other errors. - + the number of valid messages written to @messages on success + line="1078">the number of valid messages written to @messages on success (guaranteed to be greater than 0 unless @n_messages is 0), 0 if the remote peer closed the stream, or -1 on error @@ -1725,19 +1778,19 @@ peer closed the stream, or -1 on error a #NiceAgent + line="1033">a #NiceAgent the ID of the stream to receive on + line="1034">the ID of the stream to receive on the ID of the component to receive on + line="1035">the ID of the component to receive on transfer-ownership="none"> caller-allocated + line="1036">caller-allocated array of #NiceInputMessages to write the received messages into, of length at least @n_messages @@ -1759,7 +1812,7 @@ least @n_messages transfer-ownership="full"> number of entries in @messages + line="1039">number of entries in @messages allow-none="1"> a #GCancellable to allow the operation to be + line="1040">a #GCancellable to allow the operation to be cancelled from another thread, or %NULL @@ -1780,7 +1833,7 @@ cancelled from another thread, or %NULL throws="1"> Try to receive data from the given stream/component combination on @agent, + line="1124">Try to receive data from the given stream/component combination on @agent, without blocking. If receiving data would block, -1 is returned and %G_IO_ERROR_WOULD_BLOCK is set in @error. If any other error occurs, -1 is returned and @error is set accordingly. Otherwise, 0 is returned if (and only @@ -1805,11 +1858,11 @@ immediately. This must not be used in combination with nice_agent_attach_recv() on the same stream/component pair. - + the number of valid messages written to @messages on success + line="1163">the number of valid messages written to @messages on success (guaranteed to be greater than 0 unless @n_messages is 0), 0 if in reliable mode and the remote peer closed the stream, or -1 on error @@ -1818,19 +1871,19 @@ mode and the remote peer closed the stream, or -1 on error a #NiceAgent + line="1126">a #NiceAgent the ID of the stream to receive on + line="1127">the ID of the stream to receive on the ID of the component to receive on + line="1128">the ID of the component to receive on transfer-ownership="none"> caller-allocated + line="1129">caller-allocated array of #NiceInputMessages to write the received messages into, of length at least @n_messages @@ -1852,7 +1905,7 @@ least @n_messages transfer-ownership="full"> number of entries in @messages + line="1132">number of entries in @messages allow-none="1"> a #GCancellable to allow the operation to be + line="1133">a #GCancellable to allow the operation to be cancelled from another thread, or %NULL @@ -1873,12 +1926,12 @@ cancelled from another thread, or %NULL throws="1"> A single-message version of nice_agent_recv_messages_nonblocking(). - + line="1094">A single-message version of nice_agent_recv_messages_nonblocking(). + the number of bytes received into @buf on success (guaranteed to be + line="1108">the number of bytes received into @buf on success (guaranteed to be greater than 0 unless @buf_len is 0), 0 if in reliable mode and the remote peer closed the stream, or -1 on error @@ -1887,19 +1940,19 @@ peer closed the stream, or -1 on error a #NiceAgent + line="1096">a #NiceAgent the ID of the stream to receive on + line="1097">the ID of the stream to receive on the ID of the component to receive on + line="1098">the ID of the component to receive on transfer-ownership="none"> caller-allocated buffer + line="1099">caller-allocated buffer to write the received data into, of length at least @buf_len @@ -1917,7 +1970,7 @@ to write the received data into, of length at least @buf_len length of @buf + line="1101">length of @buf allow-none="1"> a #GCancellable to allow the operation to be + line="1102">a #GCancellable to allow the operation to be cancelled from another thread, or %NULL @@ -1935,11 +1988,11 @@ cancelled from another thread, or %NULL Remove and free a previously created data stream from @agent. If any I/O + line="537">Remove and free a previously created data stream from @agent. If any I/O streams have been created using nice_agent_get_io_stream(), they should be closed completely using g_io_stream_close() before this is called, or they will get broken pipe errors. - + @@ -1947,13 +2000,13 @@ will get broken pipe errors. The #NiceAgent Object + line="539">The #NiceAgent Object The ID of the stream to remove + line="540">The ID of the stream to remove @@ -1961,25 +2014,25 @@ will get broken pipe errors. Restarts the session as defined in ICE draft 19. This function + line="921">Restarts the session as defined in ICE draft 19. This function needs to be called both when initiating (ICE spec section 9.1.1.1. "ICE Restarts"), as well as when reacting (spec section 9.2.1.1. "Detecting ICE Restart") to a restart. If consent-freshness has been enabled on @agent, as specified in RFC7675 then restarting streams will restore the local consent. - + %TRUE on success %FALSE on error + line="933">%TRUE on success %FALSE on error The #NiceAgent Object + line="923">The #NiceAgent Object @@ -1989,7 +2042,7 @@ then restarting streams will restore the local consent. version="0.1.6"> Restarts a single stream as defined in RFC 5245. This function + line="939">Restarts a single stream as defined in RFC 5245. This function needs to be called both when initiating (ICE spec section 9.1.1.1. "ICE Restarts"), as well as when reacting (spec section 9.2.1.1. "Detecting ICE Restart") to a restart. @@ -1999,24 +2052,24 @@ does not generate a new tie breaker. If consent-freshness has been enabled on @agent, as specified in RFC7675 then restart @stream_id will restore the local consent for that stream. - + %TRUE on success %FALSE on error + line="955">%TRUE on success %FALSE on error The #NiceAgent Object + line="941">The #NiceAgent Object The ID of the stream + line="942">The ID of the stream @@ -2024,7 +2077,7 @@ then restart @stream_id will restore the local consent for that stream. Sends a data payload over a stream's component. + line="767">Sends a data payload over a stream's component. <note> <para> @@ -2048,42 +2101,42 @@ then restart @stream_id will restore the local consent for that stream. the stream_id and/or component_id are invalid. </para> </note> - + The number of bytes sent, or negative error code + line="800">The number of bytes sent, or negative error code The #NiceAgent Object + line="769">The #NiceAgent Object The ID of the stream to send to + line="770">The ID of the stream to send to The ID of the component to send to + line="771">The ID of the component to send to The length of the buffer to send + line="772">The length of the buffer to send The buffer of data to send + line="773">The buffer of data to send @@ -2094,7 +2147,7 @@ then restart @stream_id will restore the local consent for that stream. throws="1"> Sends multiple messages on the socket identified by the given + line="810">Sends multiple messages on the socket identified by the given stream/component pair. Transmission is non-blocking, so a %G_IO_ERROR_WOULD_BLOCK error may be returned if the send buffer is full. @@ -2121,36 +2174,36 @@ returned. In both cases, wait for the #NiceAgent::reliable-transport-writable signal before trying again. If the given @stream_id or @component_id are invalid or not yet connected, %G_IO_ERROR_BROKEN_PIPE will be returned. %G_IO_ERROR_FAILED will be returned for other errors. - + the number of messages sent (may be zero), or -1 on error + line="850">the number of messages sent (may be zero), or -1 on error a #NiceAgent + line="812">a #NiceAgent the ID of the stream to send to + line="813">the ID of the stream to send to the ID of the component to send to + line="814">the ID of the component to send to array of messages to send, of at least + line="815">array of messages to send, of at least @n_messages entries in length number of entries in @messages + line="817">number of entries in @messages a #GCancellable to cancel the operation from + line="818">a #GCancellable to cancel the operation from another thread, or %NULL @@ -2180,7 +2233,7 @@ another thread, or %NULL c:identifier="nice_agent_set_local_credentials"> Sets the local credentials for stream @stream_id. + line="677">Sets the local credentials for stream @stream_id. <note> <para> @@ -2189,37 +2242,37 @@ another thread, or %NULL </note> Since 0.1.11 - + %TRUE on success, %FALSE on error. + line="695">%TRUE on success, %FALSE on error. The #NiceAgent Object + line="679">The #NiceAgent Object The ID of the stream + line="680">The ID of the stream nul-terminated string containing an ICE username fragment + line="681">nul-terminated string containing an ICE username fragment (length must be between 22 and 256 chars) nul-terminated string containing an ICE password + line="683">nul-terminated string containing an ICE password (length must be between 4 and 256 chars) @@ -2228,7 +2281,7 @@ Since 0.1.11 Sets a preferred port range for allocating host candidates. + line="554">Sets a preferred port range for allocating host candidates. <para> If a local host candidate cannot be created on that port range, then the nice_agent_gather_candidates() call will fail. @@ -2236,7 +2289,7 @@ range, then the nice_agent_gather_candidates() call will fail. <para> This MUST be called before nice_agent_gather_candidates() </para> - + @@ -2244,31 +2297,31 @@ This MUST be called before nice_agent_gather_candidates() The #NiceAgent Object + line="556">The #NiceAgent Object The ID of the stream + line="557">The ID of the stream The ID of the component + line="558">The ID of the component The minimum port to use + line="559">The minimum port to use The maximum port to use + line="560">The maximum port to use @@ -2276,14 +2329,14 @@ This MUST be called before nice_agent_gather_candidates() Sets the settings for using a relay server during the candidate discovery. + line="580">Sets the settings for using a relay server during the candidate discovery. This may be called multiple times to add multiple relay servers to the discovery process; one TCP and one UDP, for example. - + %TRUE if the TURN settings were accepted. + line="595">%TRUE if the TURN settings were accepted. %FALSE if the address was invalid. @@ -2291,49 +2344,49 @@ discovery process; one TCP and one UDP, for example. The #NiceAgent Object + line="582">The #NiceAgent Object The ID of the stream + line="583">The ID of the stream The ID of the component + line="584">The ID of the component The IP address of the TURN server + line="585">The address of the TURN server The port of the TURN server + line="586">The port of the TURN server The TURN username to use for the allocate + line="587">The TURN username to use for the allocate The TURN password to use for the allocate + line="588">The TURN password to use for the allocate The type of relay to use + line="589">The type of relay to use @@ -2342,7 +2395,7 @@ discovery process; one TCP and one UDP, for example. c:identifier="nice_agent_set_remote_candidates"> Sets, adds or updates the remote candidates for a component of a stream. + line="728">Sets, adds or updates the remote candidates for a component of a stream. <note> <para> @@ -2361,11 +2414,11 @@ discovery process; one TCP and one UDP, for example. existing remote candidates. </para> </note> - + The number of candidates added, negative on errors (memory + line="756">The number of candidates added, negative on errors (memory allocation error or invalid component) @@ -2373,25 +2426,25 @@ allocation error or invalid component) The #NiceAgent Object + line="730">The #NiceAgent Object The ID of the stream the candidates are for + line="731">The ID of the stream the candidates are for The ID of the component the candidates are for + line="732">The ID of the component the candidates are for a #GSList of + line="733">a #GSList of #NiceCandidate items describing each candidate to add @@ -2403,7 +2456,7 @@ allocation error or invalid component) c:identifier="nice_agent_set_remote_credentials"> Sets the remote credentials for stream @stream_id. + line="644">Sets the remote credentials for stream @stream_id. <note> <para> @@ -2417,37 +2470,37 @@ allocation error or invalid component) username and password on the candidates. </para> </note> - + %TRUE on success, %FALSE on error. + line="668">%TRUE on success, %FALSE on error. The #NiceAgent Object + line="646">The #NiceAgent Object The ID of the stream + line="647">The ID of the stream nul-terminated string containing an ICE username fragment + line="648">nul-terminated string containing an ICE username fragment (length must be between 22 and 256 chars) nul-terminated string containing an ICE password + line="650">nul-terminated string containing an ICE password (length must be between 4 and 256 chars) @@ -2457,47 +2510,47 @@ allocation error or invalid component) c:identifier="nice_agent_set_selected_pair"> Sets the selected candidate pair for media transmission + line="1179">Sets the selected candidate pair for media transmission for a given stream's component. Calling this function will disable all further ICE processing (connection check, state machine updates, etc). Note that keepalives will continue to be sent. - + %TRUE on success, %FALSE if the candidate pair cannot be found + line="1193">%TRUE on success, %FALSE if the candidate pair cannot be found The #NiceAgent Object + line="1181">The #NiceAgent Object The ID of the stream + line="1182">The ID of the stream The ID of the component + line="1183">The ID of the component The local foundation of the candidate to use + line="1184">The local foundation of the candidate to use The remote foundation of the candidate to use + line="1185">The remote foundation of the candidate to use @@ -2506,43 +2559,43 @@ continue to be sent. c:identifier="nice_agent_set_selected_remote_candidate"> Sets the selected remote candidate for media transmission + line="1255">Sets the selected remote candidate for media transmission for a given stream's component. This is used to force the selection of a specific remote candidate even when connectivity checks are failing (e.g. non-ICE compatible candidates). Calling this function will disable all further ICE processing (connection check, state machine updates, etc). Note that keepalives will continue to be sent. - + %TRUE on success, %FALSE on failure + line="1270">%TRUE on success, %FALSE on failure The #NiceAgent Object + line="1257">The #NiceAgent Object The ID of the stream + line="1258">The ID of the stream The ID of the component + line="1259">The ID of the component The #NiceCandidate to select + line="1260">The #NiceCandidate to select @@ -2552,7 +2605,7 @@ continue to be sent. version="0.0.10"> This function will set the value of the SOFTWARE attribute to be added to + line="1297">This function will set the value of the SOFTWARE attribute to be added to STUN requests, responses and error responses sent during connectivity checks. <para> The SOFTWARE attribute will only be added in the #NICE_COMPATIBILITY_RFC5245 @@ -2569,7 +2622,7 @@ and #NICE_COMPATIBILITY_WLM2009 compatibility modes. 128 characters will be sent. </para> </note> - + @@ -2577,13 +2630,13 @@ and #NICE_COMPATIBILITY_WLM2009 compatibility modes. The #NiceAgent Object + line="1299">The #NiceAgent Object The value of the SOFTWARE attribute to add. + line="1300">The value of the SOFTWARE attribute to add. @@ -2593,7 +2646,7 @@ and #NICE_COMPATIBILITY_WLM2009 compatibility modes. version="0.1.4"> This function will assign a media type to a stream. The only values + line="1327">This function will assign a media type to a stream. The only values that can be used to produce a valid SDP are: "audio", "video", "text", "application", "image" and "message". @@ -2603,11 +2656,11 @@ candidates. <para>See also: nice_agent_generate_local_sdp()</para> <para>See also: nice_agent_parse_remote_sdp()</para> <para>See also: nice_agent_get_stream_name()</para> - + %TRUE if the name has been set. %FALSE in case of error + line="1344">%TRUE if the name has been set. %FALSE in case of error (invalid stream or duplicate name). @@ -2615,19 +2668,19 @@ candidates. The #NiceAgent Object + line="1329">The #NiceAgent Object The ID of the stream to change + line="1330">The ID of the stream to change The new name of the stream or %NULL + line="1331">The new name of the stream or %NULL @@ -2637,8 +2690,8 @@ candidates. version="0.0.9"> Sets the IP_TOS and/or IPV6_TCLASS field on the stream's sockets' options - + line="1280">Sets the IP_TOS and/or IPV6_TCLASS field on the stream's sockets' options + @@ -2646,30 +2699,31 @@ candidates. The #NiceAgent Object + line="1282">The #NiceAgent Object The ID of the stream + line="1283">The ID of the stream The ToS to set + line="1284">The ToS to set This property defines whether receive/send over a TCP or pseudo-TCP, in + line="755">This property defines whether receive/send operations over a TCP socket, in reliable mode, are considered as packetized or as bytestream. In unreliable mode, every send/recv is considered as packetized, and this property is ignored and cannot be set. @@ -2679,15 +2733,11 @@ In reliable mode, this property will always return %TRUE in the </para> If the property is %TRUE, the stream is considered in bytestream mode and data can be read with any receive size. If the property is %FALSE, then -the stream is considred packetized and each receive will return one packet +the stream is considered packetized and each receive will return one packet of the same size as what was sent from the peer. If in packetized mode, then doing a receive with a size smaller than the packet, will cause the remaining bytes in the packet to be dropped, breaking the reliability -of the stream. -<para> -This property is currently read-only, and will become read/write once -bytestream mode will be supported. -</para> +of the stream. The Nice agent can work in various compatibility modes depending on + line="384">The Nice agent can work in various compatibility modes depending on what the application/peer needs. <para> See also: #NiceCompatibility</para> @@ -2710,7 +2760,7 @@ what the application/peer needs. default-value="FALSE"> Whether to perform periodic consent freshness checks as specified in + line="916">Whether to perform periodic consent freshness checks as specified in RFC 7675. When %TRUE, the agent will periodically send binding requests to the peer to maintain the consent to send with the peer. On receipt of any authenticated error response, a component will immediately move @@ -2726,7 +2776,7 @@ be %TRUE as well. default-value="FALSE"> Whether the agent has the controlling role. This property should + line="417">Whether the agent has the controlling role. This property should be modified before gathering candidates, any modification occuring later will be hold until ICE is restarted. @@ -2738,7 +2788,7 @@ later will be hold until ICE is restarted. default-value="FALSE"> Force all traffic to go through a relay for added privacy, this + line="810">Force all traffic to go through a relay for added privacy, this allows hiding the local IP address. When this is enabled, so local candidates are available before relay servers have been set with nice_agent_set_relay_info(). @@ -2758,7 +2808,7 @@ with nice_agent_set_relay_info(). default-value="TRUE"> Whether the agent should use ICE-TCP when gathering candidates. + line="722">Whether the agent should use ICE-TCP when gathering candidates. If the option is disabled, no TCP candidates will be generated. If the agent is in reliable mode, then pseudotcp will need to be used over UDP candidates. @@ -2786,7 +2836,7 @@ to %FALSE as well. default-value="FALSE"> Whether to perform Trickle ICE as per draft-ietf-ice-trickle-ice-21. + line="898">Whether to perform Trickle ICE as per draft-ietf-ice-trickle-ice-21. When %TRUE, the agent will postpone changing a component state to %NICE_COMPONENT_STATE_FAILED until nice_agent_peer_candidate_gathering_done() has been called with the ID of the component's stream. @@ -2799,7 +2849,7 @@ has been called with the ID of the component's stream. default-value="TRUE"> Whether the agent should use ICE-UDP when gathering candidates. + line="696">Whether the agent should use ICE-UDP when gathering candidates. If the option is disabled, no UDP candidates will be generated. If the agent is in reliable mode, then pseudotcp will not be used since pseudotcp works on top of UDP candidates. @@ -2821,7 +2871,7 @@ to %FALSE as well. default-value="5000"> A final timeout in msec, launched when the agent becomes idle, + line="496">A final timeout in msec, launched when the agent becomes idle, before stopping its activity. This timer will delay the decision to set a component as failed. @@ -2857,7 +2907,7 @@ in a timely manner. default-value="FALSE"> Use binding requests as keepalives instead of binding + line="784">Use binding requests as keepalives instead of binding indications. This means that the keepalives may time out which will change the component state to %NICE_COMPONENT_STATE_FAILED. @@ -2876,7 +2926,7 @@ This is always enabled if the 'consent-freshness' property is %TRUE transfer-ownership="none"> A GLib main context is needed for all timeouts used by libnice. + line="371">A GLib main context is needed for all timeouts used by libnice. This is a property being set by the nice_agent_new() call. @@ -2895,11 +2945,25 @@ This is a property being set by the nice_agent_new() call. default-value="NICE_NOMINATION_MODE_AGGRESSIVE"> The nomination mode used in the ICE specification for describing + line="460">The nomination mode used in the ICE specification for describing the selection of valid pairs to be used upstream. <para> See also: #NiceNominationMode </para> + + Optional extra headers to append to the HTTP proxy CONNECT request. +Provided as key/value-pairs in hash table corresponding to +header-name/header-value. + + + + + The proxy server IP used to bypass a proxy firewall + line="541">The proxy server IP used to bypass a proxy firewall The password used to authenticate with the proxy + line="603">The password used to authenticate with the proxy The proxy server port used to bypass a proxy firewall + line="556">The proxy server port used to bypass a proxy firewall The type of proxy set in the proxy-ip property + line="572">The type of proxy set in the proxy-ip property The username used to authenticate with the proxy + line="588">The username used to authenticate with the proxy Whether the agent is providing a reliable transport of messages (through + line="680">Whether the agent is providing a reliable transport of messages (through ICE-TCP or PseudoTCP over ICE-UDP) @@ -2970,7 +3034,7 @@ ICE-TCP or PseudoTCP over ICE-UDP) default-value="500"> The initial timeout (msecs) of the STUN binding requests + line="854">The initial timeout (msecs) of the STUN binding requests used in the gathering stage, to find our local candidates. This property is described as 'RTO' in the RFC 5389 and RFC 5245. This timeout is doubled for each retransmission, until @@ -2988,7 +3052,7 @@ multiplier 'Rm' to 'RTO' should be used). default-value="3"> The maximum number of retransmissions of the STUN binding requests + line="828">The maximum number of retransmissions of the STUN binding requests used in the gathering stage, to find our local candidates, and used in the connection check stage, to test the validity of each constructed pair. This property is described as 'Rc' in the RFC @@ -3014,7 +3078,7 @@ state. default-value="2000"> The initial timeout of the STUN binding requests used + line="879">The initial timeout of the STUN binding requests used for a reliable timer. @@ -3036,7 +3100,7 @@ for a reliable timer. default-value="FALSE"> Support RENOMINATION STUN attribute proposed here: + line="478">Support RENOMINATION STUN attribute proposed here: https://tools.ietf.org/html/draft-thatcher-ice-renomination-00 As soon as RENOMINATION attribute is received from remote candidate's address, corresponding candidates pair gets @@ -3051,7 +3115,7 @@ selected. This is specific to Google Chrome/libWebRTC. default-value="TRUE"> Whether the agent should use UPnP to open a port in the router and + line="635">Whether the agent should use UPnP to open a port in the router and get the external IP @@ -3063,14 +3127,14 @@ get the external IP default-value="200"> The maximum amount of time (in milliseconds) to wait for UPnP discovery to + line="657">The maximum amount of time (in milliseconds) to wait for UPnP discovery to finish before signaling the #NiceAgent::candidate-gathering-done signal This signal is fired whenever a stream has finished gathering its + line="966">This signal is fired whenever a stream has finished gathering its candidates after a call to nice_agent_gather_candidates() @@ -3079,7 +3143,7 @@ candidates after a call to nice_agent_gather_candidates() The ID of the stream + line="969">The ID of the stream @@ -3087,7 +3151,7 @@ candidates after a call to nice_agent_gather_candidates() This signal is fired whenever a component’s state changes. There are many + line="940">This signal is fired whenever a component’s state changes. There are many valid state transitions. ![State transition diagram](states.png) @@ -3098,19 +3162,19 @@ valid state transitions. The ID of the stream + line="943">The ID of the stream The ID of the component + line="944">The ID of the component The new #NiceComponentState of the component + line="945">The new #NiceComponentState of the component @@ -3118,7 +3182,7 @@ valid state transitions. This signal is fired when we received our first binding request from + line="1076">This signal is fired when we received our first binding request from the peer. @@ -3127,7 +3191,7 @@ the peer. The ID of the stream + line="1079">The ID of the stream @@ -3138,7 +3202,7 @@ the peer. deprecated-version="0.1.8"> This signal is fired when the agent discovers a new local candidate. + line="1017">This signal is fired when the agent discovers a new local candidate. When this signal is emitted, a matching #NiceAgent::new-candidate-full is also emitted with the candidate. @@ -3152,19 +3216,19 @@ See also: #NiceAgent::candidate-gathering-done, The ID of the stream + line="1020">The ID of the stream The ID of the component + line="1021">The ID of the component The foundation of the new candidate + line="1022">The foundation of the new candidate @@ -3172,7 +3236,7 @@ See also: #NiceAgent::candidate-gathering-done, This signal is fired when the agent discovers a new local candidate. + line="1180">This signal is fired when the agent discovers a new local candidate. When this signal is emitted, a matching #NiceAgent::new-candidate is also emitted with the candidate's foundation. @@ -3185,7 +3249,7 @@ See also: #NiceAgent::candidate-gathering-done, The new #NiceCandidate + line="1183">The new #NiceCandidate @@ -3196,7 +3260,7 @@ See also: #NiceAgent::candidate-gathering-done, deprecated-version="0.1.8"> This signal is fired when the agent discovers a new remote + line="1046">This signal is fired when the agent discovers a new remote candidate. This can happen with peer reflexive candidates. When this signal is emitted, a matching #NiceAgent::new-remote-candidate-full is also emitted with the @@ -3211,19 +3275,19 @@ See also: #NiceAgent::new-remote-candidate-full The ID of the stream + line="1049">The ID of the stream The ID of the component + line="1050">The ID of the component The foundation of the new candidate + line="1051">The foundation of the new candidate @@ -3233,7 +3297,7 @@ See also: #NiceAgent::new-remote-candidate-full version="0.1.8"> This signal is fired when the agent discovers a new remote candidate. + line="1207">This signal is fired when the agent discovers a new remote candidate. This can happen with peer reflexive candidates. When this signal is emitted, a matching #NiceAgent::new-remote-candidate is also emitted with the candidate's foundation. @@ -3246,7 +3310,7 @@ See also: #NiceAgent::new-remote-candidate The new #NiceCandidate + line="1210">The new #NiceCandidate @@ -3257,7 +3321,7 @@ See also: #NiceAgent::new-remote-candidate deprecated-version="0.1.8"> This signal is fired once a candidate pair is selected for data + line="987">This signal is fired once a candidate pair is selected for data transfer for a stream's component This is emitted along with #NiceAgent::new-selected-pair-full which has the whole candidate, the Foundation of a Candidate is not a unique identifier. @@ -3271,25 +3335,25 @@ See also: #NiceAgent::new-selected-pair-full The ID of the stream + line="990">The ID of the stream The ID of the component + line="991">The ID of the component The local foundation of the selected candidate pair + line="992">The local foundation of the selected candidate pair The remote foundation of the selected candidate pair + line="993">The remote foundation of the selected candidate pair @@ -3297,7 +3361,7 @@ See also: #NiceAgent::new-selected-pair-full This signal is fired once a candidate pair is selected for data + line="1152">This signal is fired once a candidate pair is selected for data transfer for a stream's component. This is emitted along with #NiceAgent::new-selected-pair. @@ -3309,25 +3373,25 @@ See also: #NiceAgent::new-selected-pair The ID of the stream + line="1155">The ID of the stream The ID of the component + line="1156">The ID of the component The local #NiceCandidate of the selected candidate pair + line="1157">The local #NiceCandidate of the selected candidate pair The remote #NiceCandidate of the selected candidate pair + line="1158">The remote #NiceCandidate of the selected candidate pair @@ -3337,7 +3401,7 @@ See also: #NiceAgent::new-selected-pair version="0.0.11"> This signal is fired on the reliable #NiceAgent when the underlying reliable + line="1098">This signal is fired on the reliable #NiceAgent when the underlying reliable transport becomes writable. This signal is only emitted when the nice_agent_send() function returns less bytes than requested to send (or -1) and once when the connection @@ -3349,13 +3413,13 @@ is established. The ID of the stream + line="1101">The ID of the stream The ID of the component + line="1102">The ID of the component @@ -3363,7 +3427,7 @@ is established. This signal is fired whenever one or more streams are removed from the + line="1126">This signal is fired whenever one or more streams are removed from the @agent. @@ -3372,7 +3436,7 @@ is established. An array of + line="1129">An array of unsigned integer stream IDs, ending with a 0 ID @@ -3392,16 +3456,21 @@ unsigned integer stream IDs, ending with a 0 ID These are options that can be passed to nice_agent_new_full(). They set + line="403">These are options that can be passed to nice_agent_new_full(). They set various properties on the agent. Not including them sets the property to the other value. - + + + No enabled options (Since: 0.1.19) + Enables regular nomination, default + line="406">Enables regular nomination, default is aggrssive mode (see #NiceNominationMode). c:identifier="NICE_AGENT_OPTION_RELIABLE"> Enables reliable mode, possibly using PseudoTCP, * see nice_agent_new_reliable(). + line="408">Enables reliable mode, possibly using PseudoTCP, * see nice_agent_new_reliable(). Enable lite mode + line="409">Enable lite mode Enable ICE trickle mode + line="410">Enable ICE trickle mode Enable renomination triggered by NOMINATION STUN attribute + line="411">Enable renomination triggered by NOMINATION STUN attribute proposed here: https://tools.ietf.org/html/draft-thatcher-ice-renomination-00 Enable RFC 7675 consent freshness support. (Since: 0.1.19) + line="413">Enable RFC 7675 consent freshness support. (Since: 0.1.19) + + + Use bytestream mode for reliable TCP connections. (Since: 0.1.20) Callback function when data is received on a component - + line="433">Callback function when data is received on a component + @@ -3453,32 +3529,32 @@ proposed here: https://tools.ietf.org/html/draft-thatcher-ice-renomination-00 The #NiceAgent Object + line="435">The #NiceAgent Object The id of the stream + line="436">The id of the stream The id of the component of the stream + line="437">The id of the component of the stream which received the data The length of the data + line="439">The length of the data The buffer containing the data received + line="440">The buffer containing the data received The user data set in nice_agent_attach_recv() + line="441">The user data set in nice_agent_attach_recv() @@ -3498,8 +3574,8 @@ proposed here: https://tools.ietf.org/html/draft-thatcher-ice-renomination-00 The maximum size a candidate foundation can have. - + line="65">The maximum size a candidate foundation can have. + The maximum number of local addresses. The constraint is that the + line="79">The maximum number of local addresses. The constraint is that the maximum number of local addresses and number of turn servers must fit on 9 bits, to ensure candidate priority uniqueness. See also @NICE_CANDIDATE_MAX_TURN_SERVERS. We choose 6 bits for the number of local addresses, and 3 bits for the number of turn servers. - + c:type="NICE_CANDIDATE_MAX_TURN_SERVERS"> The maximum number of turns servers. - + line="72">The maximum number of turns servers. + c:symbol-prefix="candidate"> A structure to represent an ICE candidate + line="142">A structure to represent an ICE candidate <note> <para> The @priority is an integer as specified in the ICE draft 19. If you are @@ -3540,53 +3616,53 @@ local addresses, and 3 bits for the number of turn servers. value will represent the qvalue multiplied by 1000. </para> </note> - + The type of candidate + line="144">The type of candidate The transport being used for the candidate + line="145">The transport being used for the candidate The #NiceAddress of the candidate + line="146">The #NiceAddress of the candidate The #NiceAddress of the base address used by the candidate + line="147">The #NiceAddress of the base address used by the candidate The priority of the candidate <emphasis> see note </emphasis> + line="148">The priority of the candidate <emphasis> see note </emphasis> The ID of the stream to which belongs the candidate + line="149">The ID of the stream to which belongs the candidate The ID of the component to which belongs the candidate + line="150">The ID of the component to which belongs the candidate The foundation of the candidate + line="151">The foundation of the candidate @@ -3594,33 +3670,33 @@ local addresses, and 3 bits for the number of turn servers. The candidate-specific username to use (overrides the one set + line="152">The candidate-specific username to use (overrides the one set by nice_agent_set_local_credentials() or nice_agent_set_remote_credentials()) The candidate-specific password to use (overrides the one set + line="154">The candidate-specific password to use (overrides the one set by nice_agent_set_local_credentials() or nice_agent_set_remote_credentials()) Creates a new candidate. Must be freed with nice_candidate_free() - + line="181">Creates a new candidate. Must be freed with nice_candidate_free() + A new #NiceCandidate + line="187">A new #NiceCandidate The #NiceCandidateType of the candidate to create + line="183">The #NiceCandidateType of the candidate to create @@ -3628,19 +3704,19 @@ by nice_agent_set_local_credentials() or nice_agent_set_remote_credentials()) Makes a copy of a #NiceCandidate - + line="201">Makes a copy of a #NiceCandidate + A new #NiceCandidate, a copy of @candidate + line="207">A new #NiceCandidate, a copy of @candidate The candidate to copy + line="203">The candidate to copy @@ -3650,26 +3726,26 @@ by nice_agent_set_local_credentials() or nice_agent_set_remote_credentials()) Verifies that the candidates point to the same place, meaning they have + line="212">Verifies that the candidates point to the same place, meaning they have the same transport and the same address. It ignores all other aspects. - + %TRUE if the candidates point to the same place + line="220">%TRUE if the candidates point to the same place A candidate + line="214">A candidate A candidate + line="215">A candidate @@ -3677,8 +3753,8 @@ the same transport and the same address. It ignores all other aspects. Frees a #NiceCandidate - + line="192">Frees a #NiceCandidate + @@ -3686,30 +3762,85 @@ the same transport and the same address. It ignores all other aspects. The candidate to free + line="194">The candidate to free + + In case the given candidate is relayed through a TURN server, use this utility function to get +its address. + + + + + + + A relay candidate + + + + The #NiceAddress to fill + + + + + + In case the given candidate server-reflexive, use this utility function to get its address. The +address will be filled only if the candidate was generated using an STUN server. + + + TRUE if it's a STUN created ICE candidate, or FALSE if the reflexed's server was not STUN. + + + + + A server-reflexive candidate + + + + The #NiceAddress to fill + + + + Useful for debugging functions, just returns a static string with the + line="244">Useful for debugging functions, just returns a static string with the candidate transport. - + a static string with the candidate transport + line="251">a static string with the candidate transport a #NiceCandidateTransport + line="246">a #NiceCandidateTransport @@ -3719,20 +3850,20 @@ candidate transport. version="0.1.19"> Useful for debugging functions, just returns a static string with the + line="230">Useful for debugging functions, just returns a static string with the candidate type. - + a static string with the candidate type + line="237">a static string with the candidate type a #NiceCandidateType + line="232">a #NiceCandidateType @@ -3741,71 +3872,71 @@ candidate type. An enum representing the type of transport to use - + line="107">An enum representing the type of transport to use + UDP transport + line="109">UDP transport TCP Active transport + line="110">TCP Active transport TCP Passive transport + line="111">TCP Passive transport TCP Simultaneous-Open transport + line="112">TCP Simultaneous-Open transport An enum represneting the type of a candidate - + line="90">An enum representing the type of a candidate + A host candidate + line="92">A host candidate A server reflexive candidate + line="93">A server reflexive candidate (or a NAT-assisted candidate) A peer reflexive candidate + line="94">A peer reflexive candidate A relay candidate + line="95">A relay candidate An enum to specify which compatible specifications the #NiceAgent should use. + line="319">An enum to specify which compatible specifications the #NiceAgent should use. Use with nice_agent_new() <warning>@NICE_COMPATIBILITY_DRAFT19 is deprecated and should not be used @@ -3820,13 +3951,13 @@ represents the same compatibility as @NICE_COMPATIBILITY_RFC5245 </warning> fails and ICE-UDP succeeds. </para> </note> - + Use compatibility with the RFC5245 ICE-UDP specs + line="321">Use compatibility with the RFC5245 ICE-UDP specs and RFC6544 ICE-TCP specs c:identifier="NICE_COMPATIBILITY_DRAFT19"> Use compatibility for ICE Draft 19 specs + line="329">Use compatibility for ICE Draft 19 specs Use compatibility for Google Talk specs + line="323">Use compatibility for Google Talk specs Use compatibility for MSN Messenger specs + line="324">Use compatibility for MSN Messenger specs Use compatibility with Windows Live Messenger + line="325">Use compatibility with Windows Live Messenger 2009 Use compatibility with Microsoft Office Communicator 2007 + line="327">Use compatibility with Microsoft Office Communicator 2007 Use compatibility with Microsoft Office Communicator 2007 R2 + line="328">Use compatibility with Microsoft Office Communicator 2007 R2 Dummy last compatibility mode + line="330">Dummy last compatibility mode An enum representing the state of a component. + line="271">An enum representing the state of a component. <para> See also: #NiceAgent::component-state-changed </para> - + No activity scheduled + line="273">No activity scheduled Gathering local candidates + line="274">Gathering local candidates Establishing connectivity + line="275">Establishing connectivity At least one working candidate pair + line="276">At least one working candidate pair ICE concluded, candidate pair selection + line="277">ICE concluded, candidate pair selection is now final c:identifier="NICE_COMPONENT_STATE_FAILED"> Connectivity checks have been completed, + line="279">Connectivity checks have been completed, but connectivity was not established Dummy state + line="281">Dummy state Convenience enum representing the type of a component for use as the + line="298">Convenience enum representing the type of a component for use as the component_id for RTP/RTCP usages. <example> <title>Example of use.</title> @@ -3937,16 +4068,16 @@ component_id for RTP/RTCP usages. nice_agent_send (agent, stream_id, NICE_COMPONENT_TYPE_RTP, len, buf); </programlisting> </example> - + RTP Component type + line="300">RTP Component type RTCP Component type + line="301">RTCP Component type c:type="NiceNominationMode"> An enum to specity the kind of nomination mode to use by + line="382">An enum to specity the kind of nomination mode to use by the agent, as described in RFC 5245. Two modes exists, regular and aggressive. They differ by the way the controlling agent chooses to put the USE-CANDIDATE attribute in its STUN messages. The aggressive mode is supposed to nominate a pair faster, than the regular mode, potentially causing the nominated pair to change until the connection check completes. - + Regular nomination mode + line="385">Regular nomination mode Aggressive nomination mode + line="384">Aggressive nomination mode @@ -4124,29 +4255,29 @@ is %NULL-terminated An enum to specify which proxy type to use for relaying. + line="361">An enum to specify which proxy type to use for relaying. Note that the proxies will only be used with TCP TURN relaying. <para> See also: #NiceAgent:proxy-type </para> - + Do not use a proxy + line="363">Do not use a proxy Use a SOCKS5 proxy + line="364">Use a SOCKS5 proxy Use an HTTP proxy + line="365">Use an HTTP proxy Dummy last proxy type + line="366">Dummy last proxy type An enum representing the type of relay to use - + line="124">An enum representing the type of relay to use + A TURN relay using UDP + line="126">A TURN relay using UDP A TURN relay using TCP + line="127">A TURN relay using TCP A TURN relay using TLS over TCP + line="128">A TURN relay using TLS over TCP @@ -5171,7 +5302,7 @@ more complete examples. A representation of an ICE candidate. Make sure you read the ICE drafts[1] to + line="48">A representation of an ICE candidate. Make sure you read the ICE drafts[1] to understand correctly the concept of ICE candidates. [1] http://tools.ietf.org/wg/mmusic/draft-ietf-mmusic-ice/ @@ -5182,20 +5313,20 @@ understand correctly the concept of ICE candidates. version="0.1.19"> Useful for debugging functions, just returns a static string with the + line="244">Useful for debugging functions, just returns a static string with the candidate transport. - + a static string with the candidate transport + line="251">a static string with the candidate transport a #NiceCandidateTransport + line="246">a #NiceCandidateTransport @@ -5206,20 +5337,20 @@ candidate transport. version="0.1.19"> Useful for debugging functions, just returns a static string with the + line="230">Useful for debugging functions, just returns a static string with the candidate type. - + a static string with the candidate type + line="237">a static string with the candidate type a #NiceCandidateType + line="232">a #NiceCandidateType @@ -5229,20 +5360,20 @@ candidate type. version="0.1.6"> Returns a string representation of the state, generally to use in debug + line="1602">Returns a string representation of the state, generally to use in debug messages. - + a string representation of @state + line="1609">a string representation of @state a #NiceComponentState + line="1604">a #NiceComponentState @@ -5325,17 +5456,40 @@ domains: in a portable manner, they also allow finding the local ip addresses or the address allocated to a network interface. + + Returns the interface index match the local address passed. This can +by used for APIs that need a specific address. + + + The interface index or 0 on error + + + + + A #NiceAddress for a local interface + + + + Retrieves the IP address of an interface by its name. If this fails, %NULL + line="45">Retrieves the IP address of an interface by its name. If this fails, %NULL is returned. - + a newly-allocated string with the IP + line="52">a newly-allocated string with the IP address @@ -5343,7 +5497,7 @@ address name of local interface + line="47">name of local interface @@ -5352,12 +5506,12 @@ address c:identifier="nice_interfaces_get_local_interfaces"> Get the list of local interfaces - + line="71">Get the list of local interfaces + a newly-allocated #GList of + line="76">a newly-allocated #GList of strings. The caller must free it. @@ -5368,12 +5522,12 @@ strings. The caller must free it. c:identifier="nice_interfaces_get_local_ips"> Get a list of local ipv4 interface addresses - + line="58">Get a list of local ipv4 interface addresses + a newly-allocated #GList of + line="64">a newly-allocated #GList of strings. The caller must free it. @@ -5383,7 +5537,7 @@ strings. The caller must free it. Include any loopback devices + line="60">Include any loopback devices diff --git a/girs/OSTree-1.0.gir b/girs/OSTree-1.0.gir index a810f78f7..4d6a9ae04 100644 --- a/girs/OSTree-1.0.gir +++ b/girs/OSTree-1.0.gir @@ -8,11 +8,65 @@ and/or use gtk-doc annotations. --> xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> + + + A %NULL-terminated array of #OstreeCollectionRef instances, designed to +be used with g_auto(): + +|[<!-- language="C" --> +g_auto(OstreeCollectionRefv) refs = NULL; +]| + + + + + A %NULL-terminated array of #OstreeRepoFinderResult instances, designed to +be used with g_auto(): + +|[<!-- language="C" --> +g_auto(OstreeRepoFinderResultv) results = NULL; +]| + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="OstreeAsyncProgress" glib:get-type="ostree_async_progress_get_type" glib:type-struct="AsyncProgressClass"> + + - A new progress object + A new progress object + c:identifier="ostree_async_progress_new_and_connect" + introspectable="0"> + + A new progress object @@ -36,17 +99,24 @@ and/or use gtk-doc annotations. --> transfer-ownership="none" nullable="1" allow-none="1"> + a notification callback + data to pass to @changed + @@ -63,32 +133,130 @@ and/or use gtk-doc annotations. --> + + Atomically copies all the state from @self to @dest, without invoking the +callback. +This is used for proxying progress objects across different #GMainContexts. + + + + + + + An #OstreeAsyncProgress to copy from + + + + An #OstreeAsyncProgress to copy to + + + + - Process any pending signals, ensuring the main context is cleared + Process any pending signals, ensuring the main context is cleared of sources used by this object. Also ensures that no further events will be queued. + + + + + + + Self + + + + + + Get the values corresponding to zero or more keys from the +#OstreeAsyncProgress. Each key is specified in @... as the key name, followed +by a #GVariant format string, followed by the necessary arguments for that +format string, just as for g_variant_get(). After those arguments is the +next key name. The varargs list must be %NULL-terminated. + +Each format string must make deep copies of its value, as the values stored +in the #OstreeAsyncProgress may be freed from another thread after this +function returns. + +This operation is thread-safe, and all the keys are queried atomically. + +|[<!-- language="C" --> +guint32 outstanding_fetches; +guint64 bytes_received; +g_autofree gchar *status = NULL; +g_autoptr(GVariant) refs_variant = NULL; + +ostree_async_progress_get (progress, + "outstanding-fetches", "u", &outstanding_fetches, + "bytes-received", "t", &bytes_received, + "status", "s", &status, + "refs", "@a{ss}", &refs_variant, + NULL); +]| + - Self + an #OstreeAsyncProgress + + key name, format string, #GVariant return locations, …, followed by %NULL + + - + c:identifier="ostree_async_progress_get_status" + version="2017.6"> + Get the human-readable status string from the #OstreeAsyncProgress. This +operation is thread-safe. The retuned value may be %NULL if no status is +set. + +This is a convenience function to get the well-known `status` key. + + + the current status, or %NULL if none is set + an #OstreeAsyncProgress + @@ -103,6 +271,7 @@ events will be queued. + @@ -115,21 +284,116 @@ events will be queued. + + Look up a key in the #OstreeAsyncProgress and return the #GVariant associated +with it. The lookup is thread-safe. + + + value for the given @key, or %NULL if + it was not set + + + + + an #OstreeAsyncProgress + + + + a key to look up + + + + + + Set the values for zero or more keys in the #OstreeAsyncProgress. Each key is +specified in @... as the key name, followed by a #GVariant format string, +followed by the necessary arguments for that format string, just as for +g_variant_new(). After those arguments is the next key name. The varargs list +must be %NULL-terminated. + +g_variant_ref_sink() will be called as appropriate on the #GVariant +parameters, so they may be floating. + +This operation is thread-safe, and all the keys are set atomically. + +|[<!-- language="C" --> +guint32 outstanding_fetches = 15; +guint64 bytes_received = 1000; + +ostree_async_progress_set (progress, + "outstanding-fetches", "u", outstanding_fetches, + "bytes-received", "t", bytes_received, + "status", "s", "Updated status", + "refs", "@a{ss}", g_variant_new_parsed ("@a{ss} {}"), + NULL); +]| + + + + + + + an #OstreeAsyncProgress + + + + key name, format string, #GVariant parameters, …, followed by %NULL + + + + + c:identifier="ostree_async_progress_set_status" + version="2017.6"> + Set the human-readable status string for the #OstreeAsyncProgress. This +operation is thread-safe. %NULL may be passed to clear the status. + +This is a convenience function to set the well-known `status` key. + + an #OstreeAsyncProgress - + + new status string, or %NULL to clear the status + @@ -147,6 +411,7 @@ events will be queued. + @@ -162,8 +427,46 @@ events will be queued. + + Assign a new @value to the given @key, replacing any existing value. The +operation is thread-safe. @value may be a floating reference; +g_variant_ref_sink() will be called on it. + +Any watchers of the #OstreeAsyncProgress will be notified of the change if +@value differs from the existing value for @key. + + + + + + + an #OstreeAsyncProgress + + + + a key to set + + + + the value to assign to @key + + + + - Emitted when @self has been changed. + Emitted when @self has been changed. @@ -172,11 +475,13 @@ events will be queued. + + @@ -195,6 +500,15 @@ events will be queued. + + + + + + + glib:type-name="OstreeBootconfigParser" glib:get-type="ostree_bootconfig_parser_get_type"> + + - Copy of @self + Copy of @self - Bootconfig to clone + Bootconfig to clone - + Get the value corresponding to @key from the boot configuration dictionary. + + + The corresponding value, or %NULL if the key hasn't been +found. + Parser + the key name to retrieve + + + + Array of initrds or %NULL +if none are set. + + + + + + + Parser + + + + + @@ -255,51 +612,108 @@ events will be queued. - Initialize a bootconfig from the given file. + Initialize a bootconfig from the given file. + - Parser + Parser - Directory fd + Directory fd - File path + File path - Cancellable + Cancellable + Set the @key/@value pair to the boot configuration dictionary. + + Parser + the key + the key + + These are rendered as additional `initrd` keys in the final bootloader configs. The +base initrd is part of the primary keys. + + + + + + + Parser + + + + Array of overlay + initrds or %NULL to unset. + + + + + + + @@ -321,6 +735,7 @@ events will be queued. + @@ -343,255 +758,545 @@ events will be queued. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Compile-time version checking. Evaluates to %TRUE if the version +of ostree is equal or greater than the required one. + + + + required year version + + + required release version + + + + + + + + GVariant type `s`. Intended to describe the CPU architecture. This is a freeform string, and +some distributions which have existing package managers might want to match that schema. If you +don't have a prior schema, it's recommended to use `uname -m` by default (i.e. the Linux kernel +schema). In the future ostree might include a builtin function to compare architectures. + + + + + GVariant type `s`. If this is added to a commit, `ostree_repo_pull()` +will enforce that the commit was retrieved from a repository which has +the same collection ID. See `ostree_repo_set_collection_id()`. +This is most useful in concert with `OSTREE_COMMIT_META_KEY_REF_BINDING`, +as it more strongly binds the commit to the repository and branch. + + + + + GVariant type `s`. This metadata key is used to display vendor's message +when an update stream for a particular branch ends. It usually provides +update instructions for the users. + + + + + GVariant type `s`. Should contain a refspec defining a new target branch; +`ostree admin upgrade` and `OstreeSysrootUpgrader` will automatically initiate +a rebase upon encountering this metadata key. + + + + + GVariant type `as`; each element is a branch name. If this is added to a +commit, `ostree_repo_pull()` will enforce that the commit was retrieved from +one of the branch names in this array. This prevents "sidegrade" attacks. +The rationale for having this support multiple branch names is that it helps +support a "promotion" model of taking a commit and moving it between development +and production branches. + + + + + GVariant type `s`. This should hold a relatively short single line value +containing a human-readable "source" for a commit, intended to be displayed +near the origin ref. This is particularly useful for systems that inject +content into an OSTree commit from elsewhere - for example, generating from +an OCI or qcow2 image. Or if generating from packages, the enabled repository +names and their versions. + +Try to keep this key short (e.g. < 80 characters) and human-readable; if you +desire machine readable data, consider injecting separate metadata keys. + - - + + GVariant type `s`. This metadata key is used for version numbers. A freeform +string; the intention is that systems using ostree do not interpret this +semantically as traditional package managers do. + +This is the only ostree-defined metadata key that does not start with `ostree.`. + + + + + Flags influencing checksumming logic. + + + Default checksumming without tweaks. + (Since: 2017.13.) + + + Ignore xattrs when checksumming. + (Since: 2017.13.) + + + Use canonical uid/gid/mode + values, for bare-user-only mode. (Since: 2021.4.) + + + + A structure which globally uniquely identifies a ref as the tuple +(@collection_id, @ref_name). For backwards compatibility, @collection_id may be %NULL, +indicating a ref name which is not globally unique. + + + collection ID which provided the ref, or %NULL if there + is no associated collection + + + + ref name + + + + Create a new #OstreeCollectionRef containing (@collection_id, @ref_name). If +@collection_id is %NULL, this is equivalent to a plain ref name string (not a +refspec; no remote name is included), which can be used for non-P2P +operations. + - + a new #OstreeCollectionRef + - - + + a collection ID, or %NULL for a plain ref + - - + + a ref name + - - - - - + + Create a copy of the given @ref. + + + a newly allocated copy of @ref + + + + + an #OstreeCollectionRef + + + + + + Compare @ref1 and @ref2 and return %TRUE if they have the same collection ID and +ref name, and %FALSE otherwise. Both @ref1 and @ref2 must be non-%NULL. + + + %TRUE if @ref1 and @ref2 are equal, %FALSE otherwise + + + + + an #OstreeCollectionRef + + + + another #OstreeCollectionRef + + + + + + Free the given @ref. + + + + + + + an #OstreeCollectionRef + + + + + + Hash the given @ref. This function is suitable for use with #GHashTable. +@ref must be non-%NULL. + + + hash value for @ref + + + + + an #OstreeCollectionRef + + + + + + Copy an array of #OstreeCollectionRefs, including deep copies of all its +elements. @refs must be %NULL-terminated; it may be empty, but must not be +%NULL. + + + a newly allocated copy of @refs + + + + + + + %NULL-terminated array of #OstreeCollectionRefs + + + + + + + + Free the given array of @refs, including freeing all its elements. @refs +must be %NULL-terminated; it may be empty, but must not be %NULL. + + + + + + + an array of #OstreeCollectionRefs + + + + + + + + + Structure representing an entry in the "ostree.sizes" commit metadata. Each +entry corresponds to an object in the associated commit. + + + object checksum + - - + + object type + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + unpacked object size + - - - - - - + + compressed object size + + + Create a new #OstreeCommitSizesEntry for representing an object in a +commit's "ostree.sizes" metadata. + + + a new #OstreeCommitSizesEntry + + + + + object checksum + + + + object type + + + + unpacked object size + + + + compressed object size + + + + + + Create a copy of the given @entry. + + + a new copy of @entry + + + + + an #OstreeCommitSizesEntry + + + + + + Free given @entry. + + + + + + + an #OstreeCommitSizesEntry + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + Complete the object write and return the checksum. + + + Checksum, or %NULL on error + + + + + Writer + + + + Cancellable + + + + + + + + + + + + + + + + + glib:type-name="OstreeDeployment" glib:get-type="ostree_deployment_get_type"> + + New deployment + Global index into the bootloader entries + "stateroot" for this deployment + OSTree commit that will be deployed + Unique counter - + + Kernel/initrd checksum + Unique index - + + The intention of an origin file is primarily describe the "inputs" that +resulted in a deployment, and it's commonly used to derive the new state. For +example, a key value (in pure libostree mode) is the "refspec". However, +libostree (or other applications) may want to store "transient" state that +should not be carried across upgrades. + +This function just removes all members of the `libostree-transient` group. +The name of that group is available to all libostree users; best practice +would be to prefix values underneath there with a short identifier for your +software. + +Additionally, this function will remove the `origin/unlocked` and +`origin/override-commit` members; these should be considered transient state +that should have been under an explicit group. + - + - - + + An origin + + c:identifier="ostree_deployment_unlocked_state_to_string" + version="2016.4"> + + Description of state @@ -651,48 +1405,66 @@ events will be queued. + - New deep copy of @self + New deep copy of @self - Deployment + Deployment + - %TRUE if deployments have the same osname, csum, and deployserial + %TRUE if deployments have the same osname, csum, and deployserial - A deployment + A deployment - A deployment + A deployment - - Boot configuration + + + Boot configuration - Deployment + Deployment + @@ -704,6 +1476,7 @@ events will be queued. + @@ -714,6 +1487,7 @@ events will be queued. + @@ -725,6 +1499,7 @@ events will be queued. + @@ -735,44 +1510,64 @@ events will be queued. + + The global index into the bootloader ordering + Deployment - - Origin + + + Origin - Deployment + Deployment - Note this function only returns a *relative* path - if you want to + Note this function only returns a *relative* path - if you want to access, it, you must either use fd-relative api such as openat(), or concatenate it with the full ostree_sysroot_get_path(). + - Path to deployment root directory, relative to sysroot + Path to deployment root directory, relative to sysroot - A deployment + A deployment + @@ -783,7 +1578,9 @@ or concatenate it with the full ostree_sysroot_get_path(). + c:identifier="ostree_deployment_get_unlocked" + version="2016.4"> + @@ -794,56 +1591,181 @@ or concatenate it with the full ostree_sysroot_get_path(). + + + + An integer suitable for use in a `GHashTable` + + + + + Deployment + + + + + + + + `TRUE` if deployment is queued to be "finalized" at shutdown time, but requires +additional action. + + + + + Deployment + + + + + + See ostree_sysroot_deployment_set_pinned(). + + + `TRUE` if deployment will not be subject to GC + + + + + Deployment + + + + + + + + `TRUE` if deployment should be "finalized" at shutdown time + + + + + Deployment + + + + + Set or clear the bootloader configuration. + + Deployment - + + Bootloader configuration object + Should never have been made public API; don't use this. + + Deployment + Don't use this + Sets the global index into the bootloader ordering. + + Deployment + Index into bootloader ordering + Replace the "origin", which is a description of the source +of the deployment and how to update to the next version. + + Deployment - + + Set the origin for this deployment @@ -851,6 +1773,7 @@ or concatenate it with the full ostree_sysroot_get_path(). + @@ -863,8 +1786,45 @@ or concatenate it with the full ostree_sysroot_get_path(). value="2" c:identifier="OSTREE_DEPLOYMENT_UNLOCKED_HOTFIX"> + + + + An extensible options structure controlling diff dirs. Make sure +that owner_uid/gid is set to -1 when not used. This is used by +ostree_diff_dirs_with_options(). + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="OstreeDiffItem" glib:get-type="ostree_diff_item_get_type" c:symbol-prefix="diff_item"> + - + @@ -899,6 +1860,7 @@ or concatenate it with the full ostree_sysroot_get_path(). + @@ -909,6 +1871,7 @@ or concatenate it with the full ostree_sysroot_get_path(). + @@ -919,92 +1882,232 @@ or concatenate it with the full ostree_sysroot_get_path(). + + + + + + + + + + + + + + + + + + + + + + + Errors returned by signature creation and verification operations in OSTree. +These may be returned by any API which creates or verifies signatures. + + + A signature was expected, but not found. + + + A signature was malformed. + + + A signature was found, but was created with a key not in the +configured keyrings. + + + A signature was expired. Since: 2020.1. + + + A signature was found, but the key used to + sign it has expired. Since: 2020.1. + + + A signature was found, but the key used to + sign it has been revoked. Since: 2020.1. + + - Signature attributes available from an #OstreeGpgVerifyResult. + Signature attributes available from an #OstreeGpgVerifyResult. The attribute's #GVariantType is shown in brackets. + - [#G_VARIANT_TYPE_BOOLEAN] Is the signature valid? + [#G_VARIANT_TYPE_BOOLEAN] Is the signature valid? - [#G_VARIANT_TYPE_BOOLEAN] Has the signature expired? + [#G_VARIANT_TYPE_BOOLEAN] Has the signature expired? - [#G_VARIANT_TYPE_BOOLEAN] Has the signing key expired? + [#G_VARIANT_TYPE_BOOLEAN] Has the signing key expired? - [#G_VARIANT_TYPE_BOOLEAN] Has the signing key been revoked? + [#G_VARIANT_TYPE_BOOLEAN] Has the signing key been revoked? - [#G_VARIANT_TYPE_BOOLEAN] Is the signing key missing? + [#G_VARIANT_TYPE_BOOLEAN] Is the signing key missing? - [#G_VARIANT_TYPE_STRING] Fingerprint of the signing key + [#G_VARIANT_TYPE_STRING] Fingerprint of the signing key - [#G_VARIANT_TYPE_INT64] Signature creation Unix timestamp + [#G_VARIANT_TYPE_INT64] Signature creation Unix timestamp - [#G_VARIANT_TYPE_INT64] Signature expiration Unix timestamp (0 if no + [#G_VARIANT_TYPE_INT64] Signature expiration Unix timestamp (0 if no expiration) - [#G_VARIANT_TYPE_STRING] Name of the public key algorithm used to create + [#G_VARIANT_TYPE_STRING] Name of the public key algorithm used to create the signature - [#G_VARIANT_TYPE_STRING] Name of the hash algorithm used to create the + [#G_VARIANT_TYPE_STRING] Name of the hash algorithm used to create the signature - [#G_VARIANT_TYPE_STRING] The name of the signing key's primary user + [#G_VARIANT_TYPE_STRING] The name of the signing key's primary user - [#G_VARIANT_TYPE_STRING] The email address of the signing key's primary + [#G_VARIANT_TYPE_STRING] The email address of the signing key's primary user + + [#G_VARIANT_TYPE_STRING] Fingerprint of the signing key's primary key + (will be the same as OSTREE_GPG_SIGNATURE_ATTR_FINGERPRINT if the + the signature is already from the primary key rather than a subkey, + and will be the empty string if the key is missing.) + + + [#G_VARIANT_TYPE_INT64] Key expiration Unix timestamp (0 if no + expiration or if the key is missing) + + + [#G_VARIANT_TYPE_INT64] Key expiration Unix timestamp of the signing key's + primary key (will be the same as OSTREE_GPG_SIGNATURE_ATTR_KEY_EXP_TIMESTAMP + if the signing key is the primary key and 0 if no expiration or if the key + is missing) + - - Formatting flags for ostree_gpg_verify_result_describe(). Currently + + Formatting flags for ostree_gpg_verify_result_describe(). Currently there's only one possible output format, but this enumeration allows for future variations. + - Use the default output format + Use the default output format - - - + - Similar to ostree_gpg_verify_result_describe() but takes a #GVariant of + Similar to ostree_gpg_verify_result_describe() but takes a #GVariant of all attributes for a GPG signature instead of an #OstreeGpgVerifyResult and signature index. The @variant <emphasis>MUST</emphasis> have been created by ostree_gpg_verify_result_get_all(). + - a #GVariant from ostree_gpg_verify_result_get_all() + a #GVariant from ostree_gpg_verify_result_get_all() - a #GString to hold the description + a #GString to hold the description - optional line prefix string + optional line prefix string - flags to adjust the description format + flags to adjust the description format @@ -1048,34 +2162,50 @@ ostree_gpg_verify_result_get_all(). - Counts all the signatures in @result. + Counts all the signatures in @result. + - signature count + signature count - an #OstreeGpgVerifyResult + an #OstreeGpgVerifyResult - Counts only the valid signatures in @result. + Counts only the valid signatures in @result. + - valid signature count + valid signature count - an #OstreeGpgVerifyResult + an #OstreeGpgVerifyResult - Appends a brief, human-readable description of the GPG signature at + Appends a brief, human-readable description of the GPG signature at @signature_index in @result to the @output_buffer. The description spans multiple lines. A @line_prefix string, if given, will precede each line of the description. @@ -1086,59 +2216,81 @@ format. Currently must be 0. It is a programmer error to request an invalid @signature_index. Use ostree_gpg_verify_result_count_all() to find the number of signatures in @result. + - an #OstreeGpgVerifyResult + an #OstreeGpgVerifyResult - which signature to describe + which signature to describe - a #GString to hold the description + a #GString to hold the description - optional line prefix string + optional line prefix string - flags to adjust the description format + flags to adjust the description format - Builds a #GVariant tuple of requested attributes for the GPG signature at + Builds a #GVariant tuple of requested attributes for the GPG signature at @signature_index in @result. See the #OstreeGpgSignatureAttr description for the #GVariantType of each available attribute. It is a programmer error to request an invalid #OstreeGpgSignatureAttr or an invalid @signature_index. Use ostree_gpg_verify_result_count_all() to find the number of signatures in @result. - - a new, floating, #GVariant tuple + + + a new, floating, #GVariant tuple - an #OstreeGpgVerifyResult + an #OstreeGpgVerifyResult - which signature to get attributes from + which signature to get attributes from - Array of requested attributes + Array of requested attributes @@ -1146,13 +2298,17 @@ find the number of signatures in @result. - Length of the @attrs array + Length of the @attrs array - Builds a #GVariant tuple of all available attributes for the GPG signature + Builds a #GVariant tuple of all available attributes for the GPG signature at @signature_index in @result. The child values in the returned #GVariant tuple are ordered to match the @@ -1175,45 +2331,63 @@ available attribute. It is a programmer error to request an invalid @signature_index. Use ostree_gpg_verify_result_count_all() to find the number of signatures in @result. - - a new, floating, #GVariant tuple + + + a new, floating, #GVariant tuple - an #OstreeGpgVerifyResult + an #OstreeGpgVerifyResult - which signature to get attributes from + which signature to get attributes from - Searches @result for a signature signed by @key_id. If a match is found, + Searches @result for a signature signed by @key_id. If a match is found, the function returns %TRUE and sets @out_signature_index so that further signature details can be obtained through ostree_gpg_verify_result_get(). If no match is found, the function returns %FALSE and leaves @out_signature_index unchanged. + - %TRUE on success, %FALSE on failure + %TRUE on success, %FALSE on failure - an #OstreeGpgVerifyResult + an #OstreeGpgVerifyResult - a GPG key ID or fingerprint + a GPG key ID or fingerprint - return location for the index of the signature + return location for the index of the signature signed by @key_id, or %NULL @@ -1221,13 +2395,19 @@ If no match is found, the function returns %FALSE and leaves - Checks if the result contains at least one signature from the + Checks if the result contains at least one signature from the trusted keyring. You can call this function immediately after ostree_repo_verify_summary() or ostree_repo_verify_commit_ext() - it will handle the %NULL @result and filled @error too. + - %TRUE if @result was not %NULL and had at least one + %TRUE if @result was not %NULL and had at least one signature from trusted keyring, otherwise %FALSE @@ -1236,5220 +2416,13563 @@ signature from trusted keyring, otherwise %FALSE transfer-ownership="none" nullable="1" allow-none="1"> - an #OstreeGpgVerifyResult + an #OstreeGpgVerifyResult - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Zlib decompression - - - - - - - - - - - - - - - Maximum permitted size in bytes of metadata objects. This is an -arbitrary number, but really, no one should be putting humongous -data in metadata. - - - - Objects committed above this size will be allowed, but a warning -will be emitted. - - - - Maximum depth of metadata. - - - - Private instance structure. - - - A new tree - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Appends @arg which is in the form of key=value pair to the hash table kargs->table +(appends to the value list if key is already in the hash table) +and appends key to kargs->order if it is not in the hash table already. + - + - - + + a OstreeKernelArgs instance + - + + key or key/value pair to be added - - - - - Create all parent trees necessary for the given @split_path to -exist. + + Appends each value in @argv to the corresponding value array and +appends key to kargs->order if it is not in the hash table already. + - + - - Tree - + + a OstreeKernelArgs instance + - - File path components - - + + an array of key=value argument pairs + + - - SHA256 checksum for metadata - + + + + Appends each argument that does not have one of the @prefixes as prefix to the @kargs + + + + + + + a OstreeKernelArgs instance + + + + an array of key=value argument pairs + + + - - The parent tree - + + an array of prefix strings + + + - + + Appends @arg which is in the form of key=value pair to the hash table kargs->table +(appends to the value list if key is not in the hash table) +and appends key to kargs->order if it is not in the hash table. + - + - - + + a OstreeKernelArgs instance + + + key or key/value pair to be added + + - + + Appends the command line arguments in the file "/proc/cmdline" +that does not have "BOOT_IMAGE=" and "initrd=" as prefixes to the @kargs + - All children files (the value is a checksum) - - - - + %TRUE on success, %FALSE on failure + - - + + a OstreeKernelArgs instance + + + optional GCancellable object, NULL to ignore + + - + + Search for @arg which is in the form of key=value pair at the hash table kargs->table +and returns true if finds it. + - + %TRUE if @arg is contained in @kargs, %FALSE otherwise. + - - + + a OstreeKernelArgs instance + + + key or key/value pair to check + + - + + There are few scenarios being handled for deletion: + + 1: for input arg with a single key(i.e without = for split), + the key/value pair will be deleted if there is only + one value that is associated with the key + + 2: for input arg wth key/value pair, the specific key + value pair will be deleted from the pointer array + if those exist. + + 3: If the found key has only one value + associated with it, the key entry in the table will also + be removed, and the key will be removed from order table + + Returns: %TRUE on success, %FALSE on failure + + Since: 2019.3 + - All children directories - - - - + - - + + a OstreeKernelArgs instance + + + key or key/value pair for deletion + + - + Deletes @arg which is in the form of key=value pair from the hash table kargs->table. + + %TRUE on success, %FALSE on failure - - + + a OstreeKernelArgs instance + - + + key or key/value pair to be deleted - - - - - - - + This function removes the key entry from the hashtable +as well from the order pointer array inside kargs + +Note: since both table and order inside kernel args +are with free function, no extra free functions are +being called as they are done automatically by GLib + + %TRUE on success, %FALSE on failure - - + + an OstreeKernelArgs instance + - + + the key to remove - + + + + Frees the kargs structure + + + + + + + An OstreeKernelArgs that represents kernel arguments + + + + + + Finds and returns the last element of value array +corresponding to the @key in @kargs hash table. Note that the application +will be terminated if the @key is found but the value array is empty + + + %NULL if @key is not found in the @kargs hash table, +otherwise returns last element of value array corresponding to @key + + + + + a OstreeKernelArgs instance + + + + a key to look for in @kargs hash table - + + This function implements the basic logic behind key/value pair +replacement. Do note that the arg need to be properly formatted + +When replacing key with exact one value, the arg can be in +the form: +key, key=new_val, or key=old_val=new_val +The first one swaps the old_val with the key to an empty value +The second and third replace the old_val into the new_val + +When replacing key with multiple values, the arg can only be +in the form of: +key=old_val=new_val. Unless there is a special case where +there is an empty value associated with the key, then +key=new_val will work because old_val is empty. The empty +val will be swapped with the new_val in that case + - + %TRUE on success, %FALSE on failure (and in some other instances such as: +1. key not found in @kargs +2. old value not found when @arg is in the form of key=old_val=new_val +3. multiple old values found when @arg is in the form of key=old_val) + - - + + OstreeKernelArgs instance + - + + a string argument - + + Parses @options by separating it by whitespaces and appends each argument to @kargs + - - + + a OstreeKernelArgs instance + - + + a string representing command line arguments - - Traverse @start number of elements starting from @split_path; the -child will be returned in @out_subdir. + + Finds and replaces the old key if @arg is already in the hash table, +otherwise adds @arg as new key and split_keyeq (arg) as value. +Note that when replacing old key value pair, the old values are freed. + - + - - Tree - + + a OstreeKernelArgs instance + - - Split pathname - - - + + key or key/value pair for replacement + - - Descend from this number of elements in @split_path - + + + + Finds and replaces each non-null arguments of @argv in the hash table, +otherwise adds individual arg as new key and split_keyeq (arg) as value. +Note that when replacing old key value pair, the old values are freed. + + + + + + + a OstreeKernelArgs instance + + + + an array of key or key/value pairs + - - Target parent - + + + + Finds and replaces the old key if @arg is already in the hash table, +otherwise adds @arg as new key and split_keyeq (arg) as value. +Note that when replacing old key, the old values are freed. + + + + + + + a OstreeKernelArgs instance + + + + key or key/value pair for replacement + - - - - - - - - - - - - - - - - Enumeration for core object types; %OSTREE_OBJECT_TYPE_FILE is for -content, the other types are metadata. - - Content; regular file, symbolic link - - - List of children (trees or files), and metadata - - - Directory metadata - - - Toplevel object, refers to tree and dirmeta for root - - - Toplevel object, refers to a deleted commit - - - Detached metadata for a commit - - - - + + Extracts all key value pairs in @kargs and appends to a temporary +GString in forms of "key=value" or "key" if value is NULL separated +by a single whitespace, and returns the temporary string with the +GString wrapper freed + +Note: the application will be terminated if one of the values array +in @kargs is NULL + - An accessor object for an OSTree repository located at @path - + a string of "key=value" pairs or "key" if value is NULL, +separated by single whitespaces + - - Path to a repository - - + + a OstreeKernelArgs instance + + - - - If the current working directory appears to be an OSTree -repository, create a new #OstreeRepo object for accessing it. -Otherwise use the path in the OSTREE_REPO environment variable -(if defined) or else the default system repository located at -/ostree/repo. + + + Extracts all key value pairs in @kargs and appends to a temporary +array in forms of "key=value" or "key" if value is NULL, and returns +the temporary array with the GPtrArray wrapper freed + - An accessor object for an OSTree repository located at /ostree/repo - + an array of "key=value" pairs or "key" if value is NULL + + + - - - Creates a new #OstreeRepo instance, taking the system root path explicitly -instead of assuming "/". - - An accessor object for the OSTree repository located at @repo_path. - + + + a OstreeKernelArgs instance + + + + + + Frees the OstreeKernelArgs structure pointed by *loc + + + - - Path to a repository - - - - Path to the system root - + + Address of an OstreeKernelArgs pointer + - - - - + + + Initializes a new OstreeKernelArgs then parses and appends @options +to the empty OstreeKernelArgs + + + newly allocated #OstreeKernelArgs with @options appended + - + + a string representing command line arguments - - - - - Convenient "changed" callback for use with -ostree_async_progress_new_and_connect() when pulling from a remote -repository. + + Initializes a new OstreeKernelArgs structure and returns it + + + A newly created #OstreeKernelArgs for kernel arguments + + + + + + Default limit for maximum permitted size in bytes of metadata objects fetched +over HTTP (including repo/config files, refs, and commit/dirtree/dirmeta +objects). This is an arbitrary number intended to mitigate disk space +exhaustion attacks. + + + + + This variable is no longer meaningful, it is kept only for compatibility. + + + + + GVariant type `b`: Set if this commit is intended to be bootable + + + + + GVariant type `s`: Contains the Linux kernel release (i.e. `uname -r`) + + + + + GVariant type `s`. This key can be used in the repo metadata which is stored +in OSTREE_REPO_METADATA_REF as well as in the summary. The semantics of this +are that the remote repository wants clients to update their remote config +to add this collection ID (clients can't do P2P operations involving a +remote without a collection ID configured on it, even if one is configured +on the server side). Clients must never change or remove a collection ID +already set in their remote config. -Depending on the state of the #OstreeAsyncProgress, either displays a -custom status message, or else outstanding fetch progress in bytes/sec, -or else outstanding content or metadata writes to the repository in -number of objects. +Currently, OSTree does not implement changing a remote config based on this +key, but it may do so in a later release, and until then clients such as +Flatpak may implement it. -Compatibility note: this function previously assumed that @user_data -was a pointer to a #GSConsole instance. This is no longer the case, -and @user_data is ignored. - - +This is a replacement for the similar metadata key implemented by flatpak, +`xa.collection-id`, which is now deprecated as clients which supported it had +bugs with their P2P implementations. + + + + + + + + + + + + + + + + + + + + + + + + + + Private instance structure. + + + + + A new tree + + + + + Creates a new OstreeMutableTree with the contents taken from the given repo +and checksums. The data will be loaded from the repo lazily as needed. + + + A new tree + - - Async progress - + + The repo which contains the objects refered by the checksums. + - - User data - + + dirtree checksum + + + + dirmeta checksum + - - - This hash table is a set of #GVariant which can be accessed via -ostree_object_name_deserialize(). - - A new hash table - - - - + + + Creates a new OstreeMutableTree with the contents taken from the given commit. +The data will be loaded from the repo lazily as needed. + + + A new tree + - - + + The repo which contains the objects refered by the checksums. + + + + ref or SHA-256 checksum + + + + + + In some cases, a tree may be in a "lazy" state that loads +data in the background; if an error occurred during a non-throwing +API call, it will have been cached. This function checks for a +cached error. The tree remains in error state. + + `TRUE` on success - + Tree + - - - - - Add a GPG signature to a static delta. + Returns the subdirectory of self with filename @name, creating an empty one +it if it doesn't exist. + - Self - + Tree + - - NULL-terminated array of GPG keys. - - - - - - GPG home directory, or %NULL - + + Name of subdirectory of self to retrieve/creates + - - A #GCancellable - + the subdirectory + - - Append a GPG signature to a commit. + Create all parent trees necessary for the given @split_path to +exist. + - Self - + Tree + - - SHA256 of given commit to sign - + + File path components + + + - - Signature data - + + SHA256 checksum for metadata + - - A #GCancellable - + The parent tree + - - Similar to ostree_repo_checkout_tree(), but uses directory-relative -paths for the destination, uses a new `OstreeRepoCheckoutAtOptions`, -and takes a commit checksum and optional subpath pair, rather than -requiring use of `GFile` APIs for the caller. - -It also replaces ostree_repo_checkout_at() which was not safe to -use with GObject introspection. - -Note in addition that unlike ostree_repo_checkout_tree(), the -default is not to use the repository-internal uncompressed objects -cache. + + Merges @self with the tree given by @contents_checksum and +@metadata_checksum, but only if it's possible without writing new objects to +the @repo. We can do this if either @self is empty, the tree given by +@contents_checksum is empty or if both trees already have the same +@contents_checksum. + + @TRUE if merge was successful, @FALSE if it was not possible. + +This function enables optimisations when composing trees. The provided +checksums are not loaded or checked when this function is called. Instead +the contents will be loaded only when needed. - Repo - + - - Options - - - - Directory FD for destination - + + - - Directory for destination + - - Checksum for commit + - - Cancellable - - - - Call this after finishing a succession of checkout operations; it -will delete any currently-unused uncompressed objects from the -cache. + + - + - Repo - + - - Cancellable - - - - Check out @source into @destination, which must live on the -physical filesystem. @source may be any subdirectory of a given -commit. The @mode and @overwrite_mode allow control over how the -files are checked out. + + - + All children files (the value is a checksum) + + + + - Repo - + - - Options controlling all files - - - - Whether or not to overwrite files - - - - Place tree here - - - - Source tree - - - - Source info - - - - Cancellable - - - - Similar to ostree_repo_checkout_tree(), but uses directory-relative -paths for the destination, uses a new `OstreeRepoCheckoutAtOptions`, -and takes a commit checksum and optional subpath pair, rather than -requiring use of `GFile` APIs for the caller. - -Note in addition that unlike ostree_repo_checkout_tree(), the -default is not to use the repository-internal uncompressed objects -cache. - -This function is deprecated. Use ostree_repo_checkout_at() instead. + + - + - Repo - + - - Options - - - - Directory FD for destination - - - - Directory for destination - - - - Checksum for commit - - - - Cancellable - - - - Complete the transaction. Any refs set with -ostree_repo_transaction_set_ref() or -ostree_repo_transaction_set_refspec() will be written out. + + - - - - - An #OstreeRepo - - - - A set of statistics of things -that happened during this transaction. - - - - Cancellable - - - - - - - A newly-allocated copy of the repository config - + All children directories + + + + - + - - Create the underlying structure on disk for the repository, and call -ostree_repo_open() on the result, preparing it for use. - -Since version 2016.8, this function will succeed on an existing -repository, and finish creating any necessary files in a partially -created repository. However, this function cannot change the mode -of an existing repository, and will silently ignore an attempt to -do so. + + Lookup @name and returns @out_file_checksum or @out_subdir depending on its +file type. + + %TRUE on success and either @out_file_checksum or @out_subdir are +filled, %FALSE otherwise. - An #OstreeRepo - + Tree + - - The mode to store the repository in - + + name + - - Cancellable - + checksum + + + + subdirectory + - - Remove the object of type @objtype with checksum @sha256 -from the repository. An error of type %G_IO_ERROR_NOT_FOUND -is thrown if the object does not exist. + Remove the file or subdirectory named @name from the mutable tree @self. + - Repo - + Tree + - - Object type - - - - Checksum + + Name of file or subdirectory to remove - - Cancellable - + + If @FALSE, an error will be thrown if @name does not exist in the tree + - - Import an archive file @archive into the repository, and write its -file structure to @mtree. + - An #OstreeRepo - + - - Options controlling conversion - - - - An #OstreeRepoFile for the base directory - - - - A `struct archive`, but specified as void to avoid a dependency on the libarchive headers - + + - - Cancellable - + + - + + - The repository configuration; do not modify - + - + + + + - - In some cases it's useful for applications to access the repository -directly; for example, writing content into `repo/tmp` ensures it's -on the same filesystem. Another case is detecting the mtime on the -repository (to see whether a ref was written). + + - File descriptor for repository root - owned by @self - + - Repo - + - - - - For more information see ostree_repo_set_disable_fsync(). + + + + + + + Traverse @start number of elements starting from @split_path; the +child will be returned in @out_subdir. + - Whether or not fsync() is enabled for this repo. - An #OstreeRepo - + Tree + + + Split pathname + + + + + + Descend from this number of elements in @split_path + + + + Target parent + + - + + + + + + + + + + + + + + + + + + + + + An #OstreeObjectType + + + + + The name of a `GKeyFile` group for data that should not +be carried across upgrades. For more information, +see ostree_deployment_origin_remove_transient_state(). + + + + + Enumeration for core object types; %OSTREE_OBJECT_TYPE_FILE is for +content, the other types are metadata. + + + Content; regular file, symbolic link + + + List of children (trees or files), and metadata + + + Directory metadata + + + Toplevel object, refers to tree and dirmeta for root + + + Toplevel object, refers to a deleted commit + + + Detached metadata for a commit + + + Symlink to a .file given its checksum on the payload only. + + + Detached xattrs content, for 'bare-split-xattrs' mode. + + + Hardlink to a .file-xattrs given the checksum of its .file +object. + + + + Filesystem path that is created on an ostree-booted system. + + + + + ostree release version component (e.g. 2 if %OSTREE_VERSION is 2017.2) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The name of a ref which is used to store metadata for the entire repository, +such as its expected update time (`ostree.summary.expires`), name, or new +GPG keys. Metadata is stored on contentless commits in the ref, and hence is +signed with the commits. + +This supersedes the additional metadata dictionary in the `summary` file +(see ostree_repo_regenerate_summary()), as the use of a ref means that the +metadata for multiple upstream repositories can be included in a single mirror +repository, disambiguating the refs using collection IDs. In order to support +peer to peer redistribution of repository metadata, repositories must set a +collection ID (ostree_repo_set_collection_id()). + +Users of OSTree may place arbitrary metadata in commits on this ref, but the +keys must be namespaced by product or developer. For example, +`exampleos.end-of-life`. The `ostree.` prefix is reserved. + + + + + This represents the configuration for a single remote repository. Currently, +remotes can only be passed around as (reference counted) opaque handles. In +future, more API may be added to create and interrogate them. + + + Get the human-readable name of the remote. This is what the user configured, +if the remote was explicitly configured; and will otherwise be a stable, +arbitrary, string. + - + remote’s name + - - + + an #OstreeRemote + - - Before this function can be used, ostree_repo_init() must have been -called. - - Parent repository, or %NULL if none - + + Get the URL from the remote. + + + the remote's URL + - - Repo - + + an #OstreeRemote + - - - Path to repo - + + Increase the reference count on the given @remote. + + + a copy of @remote, for convenience + - - + + an #OstreeRemote + - - OSTree remotes are represented by keyfile groups, formatted like: -`[remote "remotename"]`. This function returns a value named @option_name -underneath that group, and returns it as a boolean. -If the option is not set, @out_value will be set to @default_value. + + Decrease the reference count on the given @remote and free it if the +reference count reaches 0. + - %TRUE on success, otherwise %FALSE with @error set - + - - A OstreeRepo - + + an #OstreeRemote + - - Name - + + + + + + + + An accessor object for an OSTree repository located at @path + + + + + Path to a repository + - - Option + + + + If the current working directory appears to be an OSTree +repository, create a new #OstreeRepo object for accessing it. +Otherwise use the path in the OSTREE_REPO environment variable +(if defined) or else the default system repository located at +/ostree/repo. + + + An accessor object for an OSTree repository located at /ostree/repo + + + + + Creates a new #OstreeRepo instance, taking the system root path explicitly +instead of assuming "/". + + + An accessor object for the OSTree repository located at @repo_path. + + + + + Path to a repository + + + + Path to the system root + + + + + + This is a file-descriptor relative version of ostree_repo_create(). +Create the underlying structure on disk for the repository, and call +ostree_repo_open_at() on the result, preparing it for use. + +If a repository already exists at @dfd + @path (defined by an `objects/` +subdirectory existing), then this function will simply call +ostree_repo_open_at(). In other words, this function cannot be used to change +the mode or configuration (`repo/config`) of an existing repo. + +The @options dict may contain: + + - collection-id: s: Set as collection ID in repo/config (Since 2017.9) + + + A new OSTree repository reference + + + + + Directory fd + + + + Path - - Value returned if @option_name is not present - + + The mode to store the repository in + - - location to store the result. - + + a{sv}: See below for accepted keys + + + + Cancellable + - - - OSTree remotes are represented by keyfile groups, formatted like: -`[remote "remotename"]`. This function returns a value named @option_name -underneath that group, and returns it as an zero terminated array of strings. -If the option is not set, @out_value will be set to %NULL. + + + - %TRUE on success, otherwise %FALSE with @error set - - A OstreeRepo - - - - Name - - - - Option + + a repo mode as a string - - location to store the list - of strings. The list should be freed with - g_strfreev(). - - - + the corresponding #OstreeRepoMode + - - - OSTree remotes are represented by keyfile groups, formatted like: -`[remote "remotename"]`. This function returns a value named @option_name -underneath that group, or @default_value if the remote exists but not the -option name. - - %TRUE on success, otherwise %FALSE with @error set - + + + This combines ostree_repo_new() (but using fd-relative access) with +ostree_repo_open(). Use this when you know you should be operating on an +already extant repository. If you want to create one, use ostree_repo_create_at(). + + + An accessor object for an OSTree repository located at @dfd + @path + - - A OstreeRepo - - - - Name - + + Directory fd + - - Option + + Path - - Value returned if @option_name is not present - - - - Return location for value - + - - - Verify @signatures for @data using GPG keys in the keyring for -@remote_name, and return an #OstreeGpgVerifyResult. + + + Convenient "changed" callback for use with +ostree_async_progress_new_and_connect() when pulling from a remote +repository. -The @remote_name parameter can be %NULL. In that case it will do -the verifications using GPG keys in the keyrings of all remotes. - - an #OstreeGpgVerifyResult, or %NULL on error - +Depending on the state of the #OstreeAsyncProgress, either displays a +custom status message, or else outstanding fetch progress in bytes/sec, +or else outstanding content or metadata writes to the repository in +number of objects. + +Compatibility note: this function previously assumed that @user_data +was a pointer to a #GSConsole instance. This is no longer the case, +and @user_data is ignored. + + + - - Repository - - - - Name of remote - - - - Data as a #GBytes - - - - Signatures as a #GBytes - + + Async progress + - - Path to directory GPG keyrings; overrides built-in default if given - + User data + - - Path to additional keyring file (not a directory) - + + + + This hash table is a mapping from #GVariant which can be accessed +via ostree_object_name_deserialize() to a #GVariant containing either +a similar #GVariant or and array of them, listing the parents of the key. + + + A new hash table + + + + + + + + This hash table is a set of #GVariant which can be accessed via +ostree_object_name_deserialize(). + + + A new hash table + + + + + + + + Gets all the commits that a certain object belongs to, as recorded +by a parents table gotten from ostree_repo_traverse_commit_union_with_parents. + + + An array of checksums for +the commits the key belongs to. + + + + + + + + + + - - Cancellable - + + - - + - Set @out_have_object to %TRUE if @self contains the given object; -%FALSE otherwise. + Abort the active transaction; any staged objects and ref changes will be +discarded. You *must* invoke this if you have chosen not to invoke +ostree_repo_commit_transaction(). Calling this function when not in a +transaction will do nothing and return successfully. + - %FALSE if an unexpected error occurred, %TRUE otherwise - Repo + An #OstreeRepo - - Object type - - - - ASCII SHA256 checksum - - - - %TRUE if repository contains object - - - Cancellable + Cancellable - - Import an archive file @archive into the repository, and write its -file structure to @mtree. + Add a GPG signature to a summary file. + - An #OstreeRepo + Self - - Options structure, ensure this is zeroed, then set specific variables - - - - Really this is "struct archive*" - - - - The #OstreeMutableTree to write to - + + NULL-terminated array of GPG keys. + + + - - Optional commit modifier - + GPG home directory, or %NULL + - Cancellable + A #GCancellable - - Copy object named by @objtype and @checksum into @self from the -source repository @source. If both repositories are of the same -type and on the same filesystem, this will simply be a fast Unix -hard link operation. - -Otherwise, a copy will be performed. + Append a GPG signature to a commit. + - Destination repo + Self - - Source repo - - - - Object type - + + SHA256 of given commit to sign + - - checksum - + + Signature data + - Cancellable + A #GCancellable - - Copy object named by @objtype and @checksum into @self from the -source repository @source. If both repositories are of the same -type and on the same filesystem, this will simply be a fast Unix -hard link operation. + Similar to ostree_repo_checkout_tree(), but uses directory-relative +paths for the destination, uses a new `OstreeRepoCheckoutAtOptions`, +and takes a commit checksum and optional subpath pair, rather than +requiring use of `GFile` APIs for the caller. -Otherwise, a copy will be performed. +It also replaces ostree_repo_checkout_at() which was not safe to +use with GObject introspection. + +Note in addition that unlike ostree_repo_checkout_tree(), the +default is not to use the repository-internal uncompressed objects +cache. + - Destination repo + Repo - - Source repo - + + Options + - - Object type - + + Directory FD for destination + - - checksum + + Directory for destination - - If %TRUE, assume the source repo is valid and trusted - + + Checksum for commit + - Cancellable + Cancellable - - - %TRUE if this repository is the root-owned system global repository - - - - - Repository - - - - - - Returns whether the repository is writable by the current user. -If the repository is not writable, the @error indicates why. + Call this after finishing a succession of checkout operations; it +will delete any currently-unused uncompressed objects from the +cache. + - %TRUE if this repository is writable - Repo + Repo + + Cancellable + + - - This function synchronously enumerates all commit objects starting -with @start, returning data in @out_commits. + Check out @source into @destination, which must live on the +physical filesystem. @source may be any subdirectory of a given +commit. The @mode and @overwrite_mode allow control over how the +files are checked out. + - %TRUE on success, %FALSE on error, and @error will be set - Repo + Repo - - List commits starting with this checksum - + + Options controlling all files + - - Array of GVariants - - - - + + Whether or not to overwrite files + + + + Place tree here + + + + Source tree + + + + Source info + - Cancellable + Cancellable - - This function synchronously enumerates all objects in the -repository, returning data in @out_objects. @out_objects -maps from keys returned by ostree_object_name_serialize() -to #GVariant values of type %OSTREE_REPO_LIST_OBJECTS_VARIANT_TYPE. + Similar to ostree_repo_checkout_tree(), but uses directory-relative +paths for the destination, uses a new `OstreeRepoCheckoutAtOptions`, +and takes a commit checksum and optional subpath pair, rather than +requiring use of `GFile` APIs for the caller. + +Note in addition that unlike ostree_repo_checkout_tree(), the +default is not to use the repository-internal uncompressed objects +cache. + +This function is deprecated. Use ostree_repo_checkout_at() instead. + - %TRUE on success, %FALSE on error, and @error will be set - Repo + Repo - - Flags controlling enumeration - + + Options + - - Map of serialized object name to variant data - - - - + + Directory FD for destination + + + + Directory for destination + + + + Checksum for commit + - Cancellable + Cancellable - - If @refspec_prefix is %NULL, list all local and remote refspecs, -with their current values in @out_all_refs. Otherwise, only list -refspecs which have @refspec_prefix as a prefix. + + Compute the composefs digest for a filesystem tree +and insert it into metadata for a commit object. The composefs +digest covers the entire filesystem tree and can be verified by +the composefs mount tooling. + - Repo + Repo - - Only list refs which match this prefix - + + Must be zero + - - Mapping from ref to checksum - - - - + + A GVariant builder of type a{sv} + + + + the target filesystem tree + - Cancellable + Cancellable - - If @refspec_prefix is %NULL, list all local and remote refspecs, -with their current values in @out_all_refs. Otherwise, only list -refspecs which have @refspec_prefix as a prefix. Differently from -ostree_repo_list_refs(), the prefix will not be removed from the ref -name. + Complete the transaction. Any refs set with +ostree_repo_transaction_set_ref() or +ostree_repo_transaction_set_refspec() will be written out. + +Note that if multiple threads are performing writes, all such threads must +have terminated before this function is invoked. + +Locking: Releases `shared` lock acquired by `ostree_repo_prepare_transaction()` +Multithreading: This function is *not* MT safe; only one transaction can be +active at a time. + - Repo + An #OstreeRepo - - Only list refs which match this prefix - - - - Mapping from ref to checksum - - - - - - - Options controlling listing behavior - + A set of statistics of things +that happened during this transaction. + - Cancellable + Cancellable - - This function synchronously enumerates all static deltas in the -repository, returning its result in @out_deltas. + + + + A newly-allocated copy of the repository config + + + + + + + + + + Create the underlying structure on disk for the repository, and call +ostree_repo_open() on the result, preparing it for use. + +Since version 2016.8, this function will succeed on an existing +repository, and finish creating any necessary files in a partially +created repository. However, this function cannot change the mode +of an existing repository, and will silently ignore an attempt to +do so. + +Since 2017.9, "existing repository" is defined by the existence of an +`objects` subdirectory. + +This function predates ostree_repo_create_at(). It is an error to call +this function on a repository initialized via ostree_repo_open_at(). + - Repo + An #OstreeRepo - - String name of deltas (checksum-checksum.delta) - - - + + The mode to store the repository in + - Cancellable + Cancellable - - A version of ostree_repo_load_variant() specialized to commits, -capable of returning extended state information. Currently -the only extended state is %OSTREE_REPO_COMMIT_STATE_PARTIAL, which -means that only a sub-path of the commit is available. + Remove the object of type @objtype with checksum @sha256 +from the repository. An error of type %G_IO_ERROR_NOT_FOUND +is thrown if the object does not exist. + - Repo + Repo - - Commit checksum + + Object type + + + + Checksum - - Commit - + Cancellable + - - Commit state - + + + + Check whether two opened repositories are the same on disk: if their root +directories are the same inode. If @a or @b are not open yet (due to +ostree_repo_open() not being called on them yet), %FALSE will be returned. + + + %TRUE if @a and @b are the same repository on disk, %FALSE otherwise + + + + + an #OstreeRepo + + + + an #OstreeRepo + - - Load content object, decomposing it into three parts: the actual -content (for regular files), the metadata, and extended attributes. + + Import an archive file @archive into the repository, and write its +file structure to @mtree. + - Repo + An #OstreeRepo - - ASCII SHA256 checksum - - - - File content - + + Options controlling conversion + - - File information - + + An #OstreeRepoFile for the base directory + - - Extended attributes - + A `struct archive`, but specified as void to avoid a dependency on the libarchive +headers + - Cancellable + Cancellable - - Load object as a stream; useful when copying objects between -repositories. + + Find reachable remote URIs which claim to provide any of the given named +@refs. This will search for configured remotes (#OstreeRepoFinderConfig), +mounted volumes (#OstreeRepoFinderMount) and (if enabled at compile time) +local network peers (#OstreeRepoFinderAvahi). In order to use a custom +configuration of #OstreeRepoFinder instances, call +ostree_repo_finder_resolve_all_async() on them individually. + +Any remote which is found and which claims to support any of the given @refs +will be returned in the results. It is possible that a remote claims to +support a given ref, but turns out not to — it is not possible to verify this +until ostree_repo_pull_from_remotes_async() is called. + +The returned results will be sorted with the most useful first — this is +typically the remote which claims to provide the most of @refs, at the lowest +latency. + +Each result contains a list of the subset of @refs it claims to provide. It +is possible for a non-empty list of results to be returned, but for some of +@refs to not be listed in any of the results. Callers must check for this. + +Pass the results to ostree_repo_pull_from_remotes_async() to pull the given @refs +from those remotes. + +The following @options are currently defined: + + * `override-commit-ids` (`as`): Array of specific commit IDs to fetch. The nth + commit ID applies to the nth ref, so this must be the same length as @refs, if + provided. + * `n-network-retries` (`u`): Number of times to retry each download on + receiving a transient network error, such as a socket timeout; default is + 5, 0 means return errors without retrying. Since: 2018.6 + +@finders must be a non-empty %NULL-terminated array of the #OstreeRepoFinder +instances to use, or %NULL to use the system default set of finders, which +will typically be all available finders using their default options (but +this is not guaranteed). + +GPG verification of commits will be used unconditionally. + +This will use the thread-default #GMainContext, but will not iterate it. + - + - Repo + an #OstreeRepo - - Object type - + + non-empty array of collection–ref pairs to find remotes for + + + - - ASCII SHA256 checksum - + + a GVariant `a{sv}` with an extensible set of flags + - - Stream for object - + + non-empty array of + #OstreeRepoFinder instances to use, or %NULL to use the system defaults + + + - - Length of @out_input - + + an #OstreeAsyncProgress to update with the operation’s + progress, or %NULL + - Cancellable + a #GCancellable, or %NULL + + asynchronous completion callback + + + + data to pass to @callback + + - - Load the metadata object @sha256 of type @objtype, storing the -result in @out_variant. - - + Finish an asynchronous pull operation started with +ostree_repo_find_remotes_async(). + + + a potentially empty array + of #OstreeRepoFinderResults, followed by a %NULL terminator element; or + %NULL on error + + + - Repo + an #OstreeRepo - - Expected object type - - - - Checksum string - - - - Metadata object - + + the asynchronous result + - - Attempt to load the metadata object @sha256 of type @objtype if it -exists, storing the result in @out_variant. If it doesn't exist, -%NULL is returned. + Verify consistency of the object; this performs checks only relevant to the +immediate object itself, such as checksumming. This API call will not itself +traverse metadata objects for example. + - Repo + Repo - Object type + Object type - ASCII checksum + Checksum - - Metadata - + + Cancellable + - + + Get the bootloader configured. See the documentation for the +"sysroot.bootloader" config key. + + + bootloader configuration for the sysroot + + + + + an #OstreeRepo + + + + + + Get the collection ID of this repository. See [collection IDs][collection-ids]. + + + collection ID for the repository + + + + + an #OstreeRepo + + + + + + + + The repository configuration; do not modify + + + + + + + + + + Get the set of default repo finders configured. See the documentation for +the "core.default-repo-finders" config key. + + + + %NULL-terminated array of strings. + + + + + + + an #OstreeRepo + + + + + + In some cases it's useful for applications to access the repository +directly; for example, writing content into `repo/tmp` ensures it's +on the same filesystem. Another case is detecting the mtime on the +repository (to see whether a ref was written). + + + File descriptor for repository root - owned by @self + + + + + Repo + + + + + + For more information see ostree_repo_set_disable_fsync(). + + Whether or not fsync() is enabled for this repo. + An #OstreeRepo - - - - - Starts or resumes a transaction. In order to write to a repo, you -need to start a transaction. You can complete the transaction with -ostree_repo_commit_transaction(), or abort the transaction with -ostree_repo_abort_transaction(). - -Currently, transactions are not atomic, and aborting a transaction -will not erase any data you write during the transaction. + Determine the number of bytes of free disk space that are reserved according +to the repo config and return that number in @out_reserved_bytes. See the +documentation for the core.min-free-space-size and +core.min-free-space-percent repo config options. + + %TRUE on success, %FALSE otherwise. - An #OstreeRepo + Repo - - Whether this transaction -is resuming from a previous one. This is a legacy state, now OSTree -pulls use per-commit `state/.commitpartial` files. - - - - Cancellable - + transfer-ownership="full"> + Location to store the result + - - Delete content from the repository. By default, this function will -only delete "orphaned" objects not referred to by any commit. This -can happen during a local commit operation, when we have written -content objects but not saved the commit referencing them. - -However, if %OSTREE_REPO_PRUNE_FLAGS_REFS_ONLY is provided, instead -of traversing all commits, only refs will be used. Particularly -when combined with @depth, this is a convenient way to delete -history from the repository. - -Use the %OSTREE_REPO_PRUNE_FLAGS_NO_PRUNE to just determine -statistics on objects that would be deleted, without actually -deleting them. + + + + + + + + + + + + + Before this function can be used, ostree_repo_init() must have been +called. + + + Parent repository, or %NULL if none + + + + + Repo + + + + + + Note that since the introduction of ostree_repo_open_at(), this function may +return a process-specific path in `/proc` if the repository was created using +that API. In general, you should avoid use of this API. + + + Path to repo + + + + + Repo + + + + + + OSTree remotes are represented by keyfile groups, formatted like: +`[remote "remotename"]`. This function returns a value named @option_name +underneath that group, and returns it as a boolean. +If the option is not set, @out_value will be set to @default_value. If an +error is returned, @out_value will be set to %FALSE. + + %TRUE on success, otherwise %FALSE with @error set - Repo + A OstreeRepo - - Options controlling prune process - + + Name + - - Stop traversal after this many iterations (-1 for unlimited) - + + Option + - - Number of objects found - + + Value returned if @option_name is not present + - - Number of objects deleted - + location to store the result. + - + + + OSTree remotes are represented by keyfile groups, formatted like: +`[remote "remotename"]`. This function returns a value named @option_name +underneath that group, and returns it as a zero terminated array of strings. +If the option is not set, or if an error is returned, @out_value will be set +to %NULL. + + + %TRUE on success, otherwise %FALSE with @error set + + + + + A OstreeRepo + + + + Name + + + + Option + + + - Storage size in bytes of objects deleted - - - - Cancellable - + location to store the list + of strings. The list should be freed with + g_strfreev(). + + + - - Prune static deltas, if COMMIT is specified then delete static delta files only -targeting that commit; otherwise any static delta of non existing commits are -deleted. + OSTree remotes are represented by keyfile groups, formatted like: +`[remote "remotename"]`. This function returns a value named @option_name +underneath that group, or @default_value if the remote exists but not the +option name. If an error is returned, @out_value will be set to %NULL. + + %TRUE on success, otherwise %FALSE with @error set - Repo + A OstreeRepo - - ASCII SHA256 checksum for commit, or %NULL for each -non existing commit + + Name - + Option + + + - Cancellable - + Value returned if @option_name is not present + + + + Return location for value + - - Connect to the remote repository, fetching the specified set of -refs @refs_to_fetch. For each ref that is changed, download the -commit, all metadata, and all content objects, storing them safely -on disk in @self. - -If @flags contains %OSTREE_REPO_PULL_FLAGS_MIRROR, and -the @refs_to_fetch is %NULL, and the remote repository contains a -summary file, then all refs will be fetched. - -If @flags contains %OSTREE_REPO_PULL_FLAGS_COMMIT_ONLY, then only the -metadata for the commits in @refs_to_fetch is pulled. + + Sign the given @data with the specified keys in @key_id. Similar to +ostree_repo_add_gpg_signature_summary() but can be used on any +data. -Warning: This API will iterate the thread default main context, -which is a bug, but kept for compatibility reasons. If you want to -avoid this, use g_main_context_push_thread_default() to push a new -one around this call. +You can use ostree_repo_gpg_verify_data() to verify the signatures. + + %TRUE if @data has been signed successfully, +%FALSE in case of error (@error will contain the reason). - Repo + Self - - Name of remote - + + Data as a #GBytes + - - Optional list of refs; if %NULL, fetch all configured refs - + Existing signatures to append to (or %NULL) + + + + NULL-terminated array of GPG keys. + - - Options controlling fetch behavior - - - - Progress - + GPG home directory, or %NULL + + + + in case of success will contain signature + - Cancellable + A #GCancellable - - This is similar to ostree_repo_pull(), but only fetches a single -subpath. - - - + Verify @signatures for @data using GPG keys in the keyring for +@remote_name, and return an #OstreeGpgVerifyResult. + +The @remote_name parameter can be %NULL. In that case it will do +the verifications using GPG keys in the keyrings of all remotes. + + + an #OstreeGpgVerifyResult, or %NULL on error + + - Repo + Repository - - Name of remote - - - - Subdirectory path - - - - Optional list of refs; if %NULL, fetch all configured refs - - - + Name of remote + - - Options controlling fetch behavior - + + Data as a #GBytes + - - Progress - + + Signatures as a #GBytes + - - Cancellable - - - - - - Like ostree_repo_pull(), but supports an extensible set of flags. -The following are currently defined: - - * refs (as): Array of string refs - * flags (i): An instance of #OstreeRepoPullFlags - * subdir (s): Pull just this subdirectory - * override-remote-name (s): If local, add this remote to refspec - * gpg-verify (b): GPG verify commits - * gpg-verify-summary (b): GPG verify summary - * depth (i): How far in the history to traverse; default is 0, -1 means infinite - * disable-static-deltas (b): Do not use static deltas - * require-static-deltas (b): Require static deltas - * override-commit-ids (as): Array of specific commit IDs to fetch for refs - * dry-run (b): Only print information on what will be downloaded (requires static deltas) - * override-url (s): Fetch objects from this URL if remote specifies no metalink in options - - - - - - Repo - - - - Name of remote or file:// url - - - - A GVariant a{sv} with an extensible set of flags. - + Path to directory GPG keyrings; overrides built-in default if given + - - Progress - + Path to additional keyring file (not a directory) + - Cancellable + Cancellable - - Return the size in bytes of object with checksum @sha256, after any -compression has been applied. + Set @out_have_object to %TRUE if @self contains the given object; +%FALSE otherwise. + + %FALSE if an unexpected error occurred, %TRUE otherwise - Repo + Repo - Object type + Object type - - Checksum + + ASCII SHA256 checksum - - Size in bytes object occupies physically - + %TRUE if repository contains object + - Cancellable + Cancellable - + Calculate a hash value for the given open repository, suitable for use when +putting it into a hash table. It is an error to call this on an #OstreeRepo +which is not yet open, as a persistent hash value cannot be calculated until +the repository is open and the inode of its root directory has been loaded. + +This function does no I/O. + + + hash value for the #OstreeRepo + + + + + an #OstreeRepo + + + + + - Load the content for @rev into @out_root. + Import an archive file @archive into the repository, and write its +file structure to @mtree. + - Repo + An #OstreeRepo - - Ref or ASCII checksum - + + Options structure, ensure this is zeroed, then set specific variables + - - An #OstreeRepoFile corresponding to the root - + + Really this is "struct archive*" + - - The resolved commit checksum - + + The #OstreeMutableTree to write to + + + + Optional commit modifier + - Cancellable + Cancellable - - OSTree commits can have arbitrary metadata associated; this -function retrieves them. If none exists, @out_metadata will be set -to %NULL. + Copy object named by @objtype and @checksum into @self from the +source repository @source. If both repositories are of the same +type and on the same filesystem, this will simply be a fast Unix +hard link operation. + +Otherwise, a copy will be performed. + - Repo + Destination repo + + Source repo + + + + Object type + + - ASCII SHA256 commit checksum + checksum - - Metadata associated with commit in with format "a{sv}", or %NULL if none exists - - - Cancellable + Cancellable - - An OSTree repository can contain a high level "summary" file that -describes the available branches and other metadata. + Copy object named by @objtype and @checksum into @self from the +source repository @source. If @trusted is %TRUE and both +repositories are of the same type and on the same filesystem, +this will simply be a fast Unix hard link operation. -It is regenerated automatically after a commit if -`core/commit-update-summary` is set. +Otherwise, a copy will be performed. + - Repo + Destination repo - - A GVariant of type a{sv}, or %NULL - + + Source repo + + + + Object type + + + + checksum + + + + If %TRUE, assume the source repo is valid and trusted + - Cancellable + Cancellable - + + + %TRUE if this repository is the root-owned system global repository + + + + + Repository + + + + + - Create a new remote named @name pointing to @url. If @options is -provided, then it will be mapped to #GKeyFile entries, where the -GVariant dictionary key is an option string, and the value is -mapped as follows: - * s: g_key_file_set_string() - * b: g_key_file_set_boolean() - * as: g_key_file_set_string_list() + Returns whether the repository is writable by the current user. +If the repository is not writable, the @error indicates why. + + %TRUE if this repository is writable - Repo + Repo - - Name of remote - - - - URL for remote (if URL begins with metalink=, it will be used as such) - - - - GVariant of type a{sv} - - - - Cancellable - - - - A combined function handling the equivalent of -ostree_repo_remote_add(), ostree_repo_remote_delete(), with more -options. + List all local, mirrored, and remote refs, mapping them to the commit +checksums they currently point to in @out_all_refs. If @match_collection_id +is specified, the results will be limited to those with an equal collection +ID. + +#OstreeCollectionRefs are guaranteed to be returned with their collection ID +set to a non-%NULL value; so no refs from `refs/heads` will be listed if no +collection ID is configured for the repository +(ostree_repo_get_collection_id()). + +If you want to exclude refs from `refs/remotes`, use +%OSTREE_REPO_LIST_REFS_EXT_EXCLUDE_REMOTES in @flags. Similarly use +%OSTREE_REPO_LIST_REFS_EXT_EXCLUDE_MIRRORS to exclude refs from +`refs/mirrors`. + + %TRUE on success, %FALSE otherwise - Repo + Repo - - System root - - - - Operation to perform - - - - Name of remote + If non-%NULL, only list refs from this collection - - URL for remote (if URL begins with metalink=, it will be used as such) - + + + Mapping from collection–ref to checksum + + + + - - GVariant of type a{sv} - + + Options controlling listing behavior + - Cancellable + Cancellable - - Delete the remote named @name. It is an error if the provided -remote does not exist. + This function synchronously enumerates all commit objects starting +with @start, returning data in @out_commits. + +To list all commit objects, provide the empty string `""` for @start. + + %TRUE on success, %FALSE on error, and @error will be set - Repo + Repo - - Name of remote + + List commits starting with this checksum (empty string for all) + + +Map of serialized commit name to variant data + + + + + - Cancellable + Cancellable - - Tries to fetch the summary file and any GPG signatures on the summary file -over HTTP, and returns the binary data in @out_summary and @out_signatures -respectively. - -If no summary file exists on the remote server, @out_summary is set to -@NULL. Likewise if the summary file is not signed, @out_signatures is -set to @NULL. In either case the function still returns %TRUE. - -Parse the summary data into a #GVariant using g_variant_new_from_bytes() -with #OSTREE_SUMMARY_GVARIANT_FORMAT as the format string. + This function synchronously enumerates all objects in the +repository, returning data in @out_objects. @out_objects +maps from keys returned by ostree_object_name_serialize() +to #GVariant values of type %OSTREE_REPO_LIST_OBJECTS_VARIANT_TYPE. + - %TRUE on success, %FALSE on failure + %TRUE on success, %FALSE on error, and @error will be set - Self + Repo - - name of a remote - + + Flags controlling enumeration + - + +Map of serialized object name to variant data + + + + + + - return location for raw summary data, or %NULL - + Cancellable + - + + + If @refspec_prefix is %NULL, list all local and remote refspecs, +with their current values in @out_all_refs. Otherwise, only list +refspecs which have @refspec_prefix as a prefix. + +@out_all_refs will be returned as a mapping from refspecs (including the +remote name) to checksums. If @refspec_prefix is non-%NULL, it will be +removed as a prefix from the hash table keys. + + + + + + + Repo + + + - return location for raw summary signature - data, or %NULL - + Only list refs which match this prefix + + + + + Mapping from refspec to checksum + + + + - a #GCancellable + Cancellable - - Like ostree_repo_remote_fetch_summary(), but supports an extensible set of flags. -The following are currently defined: + If @refspec_prefix is %NULL, list all local and remote refspecs, +with their current values in @out_all_refs. Otherwise, only list +refspecs which have @refspec_prefix as a prefix. -- override-url (s): Fetch summary from this URL if remote specifies no metalink in options +@out_all_refs will be returned as a mapping from refspecs (including the +remote name) to checksums. Differently from ostree_repo_list_refs(), the +@refspec_prefix will not be removed from the refspecs in the hash table. + - %TRUE on success, %FALSE on failure - Self + Repo - - name of a remote - - - - A GVariant a{sv} with an extensible set of flags - + Only list refs which match this prefix + - - return location for raw summary data, or %NULL - + + + Mapping from refspec to checksum + + + + - - return location for raw summary signature - data, or %NULL - + + Options controlling listing behavior + - a #GCancellable + Cancellable - - Return whether GPG verification is enabled for the remote named @name -through @out_gpg_verify. It is an error if the provided remote does -not exist. + This function synchronously enumerates all static delta indexes in the +repository, returning its result in @out_indexes. + - %TRUE on success, %FALSE on failure - Repo + Repo - - Name of remote - - - + String name of delta indexes +(checksum) + + + + + - Remote's GPG option - + Cancellable + - - Return whether GPG verification of the summary is enabled for the remote -named @name through @out_gpg_verify_summary. It is an error if the provided -remote does not exist. + This function synchronously enumerates all static deltas in the +repository, returning its result in @out_deltas. + - %TRUE on success, %FALSE on failure - Repo + Repo - - Name of remote - - - + String name of deltas +(checksum-checksum.delta) + + + + + - Remote's GPG option - + Cancellable + - - Return the URL of the remote named @name through @out_url. It is an -error if the provided remote does not exist. + A version of ostree_repo_load_variant() specialized to commits, +capable of returning extended state information. Currently +the only extended state is %OSTREE_REPO_COMMIT_STATE_PARTIAL, which +means that only a sub-path of the commit is available. + - %TRUE on success, %FALSE on failure - Repo + Repo - - Name of remote + + Commit checksum - - Remote's URL - + Commit + + + + Commit state + - - Imports one or more GPG keys from the open @source_stream, or from the -user's personal keyring if @source_stream is %NULL. The @key_ids array -can optionally restrict which keys are imported. If @key_ids is %NULL, -then all keys are imported. - -The imported keys will be used to conduct GPG verification when pulling -from the remote named @name. + + Load content object, decomposing it into three parts: the actual +content (for regular files), the metadata, and extended attributes. + - %TRUE on success, %FALSE on failure - Self + Repo - - name of a remote + + ASCII SHA256 checksum - - a #GInputStream, or %NULL - + File content + - - a %NULL-terminated array of GPG key IDs, or %NULL - - - + File information + - - return location for the number of imported - keys, or %NULL - + Extended attributes + - a #GCancellable + Cancellable - - List available remote names in an #OstreeRepo. Remote names are sorted -alphabetically. If no remotes are available the function returns %NULL. - - a %NULL-terminated - array of remote names - - - - - - - Repo - - - - Number of remotes available - - - - - + Load object as a stream; useful when copying objects between +repositories. + - Repo + Repo - - Name of the remote. + + Object type + + + + ASCII SHA256 checksum - - Mapping from ref to checksum - - - - + Stream for object + + + + Length of @out_input + - Cancellable + Cancellable - - Look up the given refspec, returning the checksum it references in -the parameter @out_rev. Will fall back on remote directory if cannot -find the given refspec in local. + Load the metadata object @sha256 of type @objtype, storing the +result in @out_variant. + - Repo + Repo - - A refspec - + + Expected object type + - - Do not throw an error if refspec does not exist - + + Checksum string + - - A checksum,or %NULL if @allow_noent is true and it does not exist - + Metadata object + - - Look up the given refspec, returning the checksum it references in -the parameter @out_rev. Differently from ostree_repo_resolve_rev(), -this will not fall back to searching through remote repos if a -local ref is specified but not found. + + Attempt to load the metadata object @sha256 of type @objtype if it +exists, storing the result in @out_variant. If it doesn't exist, +@out_variant will be set to %NULL and the function will still +return TRUE. + - Repo + Repo - - A refspec - - - - Do not throw an error if refspec does not exist - + + Object type + - - Options controlling behavior - + + ASCII checksum + - - A checksum,or %NULL if @allow_noent is true and it does not exist - + transfer-ownership="full" + nullable="1"> + Metadata + - - When ostree builds a mutable tree from directory like in -ostree_repo_write_directory_to_mtree(), it has to scan all files that you -pass in and compute their checksums. If your commit contains hardlinks from -ostree's existing repo, ostree can build a mapping of device numbers and -inodes to their checksum. + Release a lock of type @lock_type from the lock state. If the lock state +becomes empty, the repository is unlocked. Otherwise, the lock state only +changes when transitioning from an exclusive lock back to a shared lock. The +requested @lock_type must be the same type that was requested in the call to +ostree_repo_lock_push(). It is a programmer error if these do not match and +the program may abort if the lock would reach an invalid state. -There is an upfront cost to creating this mapping, as this will scan the -entire objects directory. If your commit is composed of mostly hardlinks to -existing ostree objects, then this will speed up considerably, so call it -before you call ostree_write_directory_to_mtree() or similar. +ostree_repo_lock_pop() waits for the lock depending on the repository's +lock-timeout-secs configuration. When lock-timeout-secs is -1, a blocking lock is +attempted. Otherwise, the lock is removed non-blocking and +ostree_repo_lock_pop() will sleep synchronously up to lock-timeout-secs seconds +attempting to remove the lock. If the lock cannot be removed within the +timeout, a %G_IO_ERROR_WOULD_BLOCK error is returned. + +If @self is not writable by the user, then no unlocking is attempted and +%TRUE is returned. + + %TRUE on success, otherwise %FALSE with @error set - An #OstreeRepo + a #OstreeRepo + + the type of lock to release + + - Cancellable + a #GCancellable - - Set a custom location for the cache directory used for e.g. -per-remote summary caches. Setting this manually is useful when -doing operations on a system repo as a user because you don't have -write permissions in the repo, where the cache is normally stored. + Takes a lock on the repository and adds it to the lock state. If @lock_type +is %OSTREE_REPO_LOCK_SHARED, a shared lock is taken. If @lock_type is +%OSTREE_REPO_LOCK_EXCLUSIVE, an exclusive lock is taken. The actual lock +state is only changed when locking a previously unlocked repository or +upgrading the lock from shared to exclusive. If the requested lock type is +unchanged or would represent a downgrade (exclusive to shared), the lock +state is not changed. + +ostree_repo_lock_push() waits for the lock depending on the repository's +lock-timeout-secs configuration. When lock-timeout-secs is -1, a blocking lock is +attempted. Otherwise, the lock is taken non-blocking and +ostree_repo_lock_push() will sleep synchronously up to lock-timeout-secs seconds +attempting to acquire the lock. If the lock cannot be acquired within the +timeout, a %G_IO_ERROR_WOULD_BLOCK error is returned. + +If @self is not writable by the user, then no locking is attempted and +%TRUE is returned. + + %TRUE on success, otherwise %FALSE with @error set - An #OstreeRepo + a #OstreeRepo - - directory fd - - - - subpath in @dfd - + + the type of lock to acquire + - a #GCancellable + a #GCancellable - - Disable requests to fsync() to stable storage during commits. This -option should only be used by build system tools which are creating -disposable virtual machines, or have higher level mechanisms for -ensuring data consistency. + + Commits in the "partial" state do not have all their child objects +written. This occurs in various situations, such as during a pull, +but also if a "subpath" pull is used, as well as "commit only" +pulls. + +This function is used by ostree_repo_pull_with_options(); you +should use this if you are implementing a different type of transport. + - + - An #OstreeRepo + Repo - - If %TRUE, do not fsync + + Commit SHA-256 + + + + Whether or not this commit is partial - - This is like ostree_repo_transaction_set_ref(), except it may be -invoked outside of a transaction. This is presently safe for the -case where we're creating or overwriting an existing ref. + Allows the setting of a reason code for a partial commit. Presently +it only supports setting reason bitmask to +OSTREE_REPO_COMMIT_STATE_FSCK_PARTIAL, or +OSTREE_REPO_COMMIT_STATE_NORMAL. This will allow successive ostree +fsck operations to exit properly with an error code if the +repository has been truncated as a result of fsck trying to repair +it. + - An #OstreeRepo + Repo - - A remote for the ref + + Commit SHA-256 - - The ref to write - + + Whether or not this commit is partial + - - The checksum to point it to, or %NULL to unset - + + Reason bitmask for partial commit + + + + + + + + + + + + - GCancellable - - Add a GPG signature to a commit. + Starts or resumes a transaction. In order to write to a repo, you +need to start a transaction. You can complete the transaction with +ostree_repo_commit_transaction(), or abort the transaction with +ostree_repo_abort_transaction(). + +Currently, transactions may result in partial commits or data in the target +repository if interrupted during ostree_repo_commit_transaction(), and +further writing refs is also not currently atomic. + +There can be at most one transaction active on a repo at a time per instance +of `OstreeRepo`; however, it is safe to have multiple threads writing objects +on a single `OstreeRepo` instance as long as their lifetime is bounded by the +transaction. + +Locking: Acquires a `shared` lock; release via commit or abort +Multithreading: This function is *not* MT safe; only one transaction can be +active at a time. + - Self + An #OstreeRepo - - SHA256 of given commit to sign - - - - Use this GPG key id - - - - GPG home directory, or %NULL - + Whether this transaction +is resuming from a previous one. This is a legacy state, now OSTree +pulls use per-commit `state/.commitpartial` files. + - A #GCancellable + Cancellable - - This function is deprecated, sign the summary file instead. -Add a GPG signature to a static delta. + + Delete content from the repository. By default, this function will +only delete "orphaned" objects not referred to by any commit. This +can happen during a local commit operation, when we have written +content objects but not saved the commit referencing them. + +However, if %OSTREE_REPO_PRUNE_FLAGS_REFS_ONLY is provided, instead +of traversing all commits, only refs will be used. Particularly +when combined with @depth, this is a convenient way to delete +history from the repository. + +Use the %OSTREE_REPO_PRUNE_FLAGS_NO_PRUNE to just determine +statistics on objects that would be deleted, without actually +deleting them. + +Locking: exclusive + + Repo - - + + Options controlling prune process + - - + + Stop traversal after this many iterations (-1 for unlimited) + - - + + Number of objects found + - - + + Number of objects deleted + + + + Storage size in bytes of objects deleted + + Cancellable - - Given a directory representing an already-downloaded static delta -on disk, apply it, generating a new commit. The directory must be -named with the form "FROM-TO", where both are checksums, and it -must contain a file named "superblock", along with at least one part. + Delete content from the repository. This function is the "backend" +half of the higher level ostree_repo_prune(). To use this function, +you determine the root set yourself, and this function finds all other +unreferenced objects and deletes them. + +Use this API when you want to perform more selective pruning - for example, +retain all commits from a production branch, but just GC some history from +your dev branch. + +The %OSTREE_REPO_PRUNE_FLAGS_NO_PRUNE flag may be specified to just determine +statistics on objects that would be deleted, without actually deleting them. + +Locking: exclusive + - Repo + Repo - - Path to a directory containing static delta data, or directly to the superblock - + + Options controlling prune process + - - If %TRUE, assume data integrity - + + Number of objects found + + + + Number of objects deleted + + + + Storage size in bytes of objects deleted + - Cancellable + Cancellable - - Generate a lookaside "static delta" from @from (%NULL means -from-empty) which can generate the objects in @to. This delta is -an optimization over fetching individual objects, and can be -conveniently stored and applied offline. + Prune static deltas, if COMMIT is specified then delete static delta files only +targeting that commit; otherwise any static delta of non existing commits are +deleted. -The @params argument should be an a{sv}. The following attributes -are known: - - min-fallback-size: u: Minimum uncompressed size in megabytes to use fallback, 0 to disable fallbacks - - max-chunk-size: u: Maximum size in megabytes of a delta part - - max-bsdiff-size: u: Maximum size in megabytes to consider bsdiff compression - for input files - - compression: y: Compression type: 0=none, x=lzma, g=gzip - - bsdiff-enabled: b: Enable bsdiff compression. Default TRUE. - - inline-parts: b: Put part data in header, to get a single file delta. Default FALSE. - - verbose: b: Print diagnostic messages. Default FALSE. - - endianness: b: Deltas use host byte order by default; this option allows choosing (G_BIG_ENDIAN or G_LITTLE_ENDIAN) - - filename: ay: Save delta superblock to this filename, and parts in the same directory. Default saves to repository. +Locking: exclusive + - Repo + Repo - - High level optimization choice - - - - ASCII SHA256 checksum of origin, or %NULL - - - - ASCII SHA256 checksum of target - - - - Optional metadata - - - - Parameters, see below - + ASCII SHA256 checksum for commit, or %NULL for each +non existing commit + - Cancellable + Cancellable - - If @checksum is not %NULL, then record it as the target of ref named -@ref; if @remote is provided, the ref will appear to originate from that -remote. + + Connect to the remote repository, fetching the specified set of +refs @refs_to_fetch. For each ref that is changed, download the +commit, all metadata, and all content objects, storing them safely +on disk in @self. -Otherwise, if @checksum is %NULL, then record that the ref should -be deleted. +If @flags contains %OSTREE_REPO_PULL_FLAGS_MIRROR, and +the @refs_to_fetch is %NULL, and the remote repository contains a +summary file, then all refs will be fetched. -The change will not be written out immediately, but when the transaction -is completed with ostree_repo_commit_transaction(). If the transaction -is instead aborted with ostree_repo_abort_transaction(), no changes will -be made to the repository. +If @flags contains %OSTREE_REPO_PULL_FLAGS_COMMIT_ONLY, then only the +metadata for the commits in @refs_to_fetch is pulled. + +Warning: This API will iterate the thread default main context, +which is a bug, but kept for compatibility reasons. If you want to +avoid this, use g_main_context_push_thread_default() to push a new +one around this call. + - + - An #OstreeRepo + Repo - + Name of remote + + + - A remote for the ref - - - - The ref to write - + Optional list of +refs; if %NULL, fetch all configured refs + + + - - The checksum to point it to - + + Options controlling fetch behavior + + + + Progress + + + + Cancellable + - - Like ostree_repo_transaction_set_ref(), but takes concatenated -@refspec format as input instead of separate remote and name -arguments. + + Pull refs from multiple remotes which have been found using +ostree_repo_find_remotes_async(). + +@results are expected to be in priority order, with the best remotes to pull +from listed first. ostree_repo_pull_from_remotes_async() will generally pull +from the remotes in order, but may parallelise its downloads. + +If an error is encountered when pulling from a given remote, that remote will +be ignored and another will be tried instead. If any refs have not been +downloaded successfully after all remotes have been tried, %G_IO_ERROR_FAILED +will be returned. The results of any successful downloads will remain cached +in the local repository. + +If @cancellable is cancelled, %G_IO_ERROR_CANCELLED will be returned +immediately. The results of any successfully completed downloads at that +point will remain cached in the local repository. + +GPG verification of commits will be used unconditionally. + +The following @options are currently defined: + + * `flags` (`i`): #OstreeRepoPullFlags to apply to the pull operation + * `inherit-transaction` (`b`): %TRUE to inherit an ongoing transaction on + the #OstreeRepo, rather than encapsulating the pull in a new one + * `depth` (`i`): How far in the history to traverse; default is 0, -1 means infinite + * `disable-static-deltas` (`b`): Do not use static deltas + * `http-headers` (`a(ss)`): Additional headers to add to all HTTP requests + * `subdirs` (`as`): Pull just these subdirectories + * `update-frequency` (`u`): Frequency to call the async progress callback in + milliseconds, if any; only values higher than 0 are valid + * `append-user-agent` (`s`): Additional string to append to the user agent + * `n-network-retries` (`u`): Number of times to retry each download on receiving + a transient network error, such as a socket timeout; default is 5, 0 + means return errors without retrying. Since: 2018.6 + * `ref-keyring-map` (`a(sss)`): Array of (collection ID, ref name, keyring + remote name) tuples specifying which remote's keyring should be used when + doing GPG verification of each collection-ref. This is useful to prevent a + remote from serving malicious updates to refs which did not originate from + it. This can be a subset or superset of the refs being pulled; any ref + not being pulled will be ignored and any ref without a keyring remote + will be verified with the keyring of the remote being pulled from. + Since: 2019.2 + - An #OstreeRepo + an #OstreeRepo - - The refspec to write - + + %NULL-terminated array of remotes to + pull from, including the refs to pull from each + + + - - The checksum to point it to - + + A GVariant `a{sv}` with an extensible set of flags + + + + an #OstreeAsyncProgress to update with the operation’s + progress, or %NULL + + + + a #GCancellable, or %NULL + + + + asynchronous completion callback + + + + data to pass to @callback + - - Create a new set @out_reachable containing all objects reachable -from @commit_checksum, traversing @maxdepth parent commits. + Finish an asynchronous pull operation started with +ostree_repo_pull_from_remotes_async(). + + %TRUE on success, %FALSE otherwise - - Repo + + an #OstreeRepo - - ASCII SHA256 checksum - - - - Traverse this many parent commits, -1 for unlimited - - - - Set of reachable objects - - - - - - - Cancellable - + + the asynchronous result + - - Update the set @inout_reachable containing all objects reachable -from @commit_checksum, traversing @maxdepth parent commits. + This is similar to ostree_repo_pull(), but only fetches a single +subpath. + - - Repo + + Repo - - ASCII SHA256 checksum + + Name of remote - - Traverse this many parent commits, -1 for unlimited - + + Subdirectory path + - - Set of reachable objects - - - - + + Optional list of +refs; if %NULL, fetch all configured refs + + + + + + Options controlling fetch behavior + + + + Progress + - Cancellable + Cancellable - - Check for a valid GPG signature on commit named by the ASCII -checksum @commit_checksum. + Like ostree_repo_pull(), but supports an extensible set of flags. +The following are currently defined: + + * `refs` (`as`): Array of string refs + * `collection-refs` (`a(sss)`): Array of (collection ID, ref name, checksum) tuples to pull; + mutually exclusive with `refs` and `override-commit-ids`. Checksums may be the empty + string to pull the latest commit for that ref + * `flags` (`i`): An instance of #OstreeRepoPullFlags + * `subdir` (`s`): Pull just this subdirectory + * `subdirs` (`as`): Pull just these subdirectories + * `override-remote-name` (`s`): If local, add this remote to refspec + * `gpg-verify` (`b`): GPG verify commits + * `gpg-verify-summary` (`b`): GPG verify summary + * `disable-sign-verify` (`b`): Disable signapi verification of commits + * `disable-sign-verify-summary` (`b`): Disable signapi verification of the summary + * `depth` (`i`): How far in the history to traverse; default is 0, -1 means infinite + * `per-object-fsync` (`b`): Perform disk writes more slowly, avoiding a single large I/O sync + * `disable-static-deltas` (`b`): Do not use static deltas + * `require-static-deltas` (`b`): Require static deltas + * `override-commit-ids` (`as`): Array of specific commit IDs to fetch for refs + * `timestamp-check` (`b`): Verify commit timestamps are newer than current (when pulling via +ref); Since: 2017.11 + * `timestamp-check-from-rev` (`s`): Verify that all fetched commit timestamps are newer than +timestamp of given rev; Since: 2020.4 + * `max-metadata-size` (`t`): Restrict metadata objects to a maximum number of bytes; 0 to +disable. Since: 2018.9 + * `dry-run` (`b`): Only print information on what will be downloaded (requires static deltas) + * `override-url` (`s`): Fetch objects from this URL if remote specifies no metalink in options + * `inherit-transaction` (`b`): Don't initiate, finish or abort a transaction, useful to do +multiple pulls in one transaction. + * `http-headers` (`a(ss)`): Additional headers to add to all HTTP requests + * `update-frequency` (`u`): Frequency to call the async progress callback in milliseconds, if +any; only values higher than 0 are valid + * `localcache-repos` (`as`): File paths for local repos to use as caches when doing remote +fetches + * `append-user-agent` (`s`): Additional string to append to the user agent + * `n-network-retries` (`u`): Number of times to retry each download on receiving + a transient network error, such as a socket timeout; default is 5, 0 + means return errors without retrying. Since: 2018.6 + * `low-speed-limit-bytes` (`u`): The average transfer speed per second of a transfer + during the time set via "low-speed-time-seconds" for libcurl to abort. + * `low-speed-time-seconds` (`u`): The time in number seconds that the transfer + speed should be below the "low-speed-limit-bytes" setting for libcurl to abort. + * `retry-all-network-errors` (`b`): Retry when network issues happen, instead of + failing automatically. Currently only affects libcurl. (Default set to true) + * `max-outstanding-fetcher-requests` (`u`): The max amount of concurrent connections allowed. + * `ref-keyring-map` (`a(sss)`): Array of (collection ID, ref name, keyring + remote name) tuples specifying which remote's keyring should be used when + doing GPG verification of each collection-ref. This is useful to prevent a + remote from serving malicious updates to refs which did not originate from + it. This can be a subset or superset of the refs being pulled; any ref + not being pulled will be ignored and any ref without a keyring remote + will be verified with the keyring of the remote being pulled from. + Since: 2019.2 + * `summary-bytes` (`ay'): Contents of the `summary` file to use. If this is + specified, `summary-sig-bytes` must also be specified. This is + useful if doing multiple pull operations in a transaction, using + ostree_repo_remote_fetch_summary_with_options() beforehand to download + the `summary` and `summary.sig` once for the entire transaction. If not + specified, the `summary` will be downloaded from the remote. Since: 2020.5 + * `summary-sig-bytes` (`ay`): Contents of the `summary.sig` file. If this + is specified, `summary-bytes` must also be specified. Since: 2020.5 + * `disable-verify-bindings` (`b`): Disable verification of commit bindings. + Since: 2020.9 + - %TRUE if there was a GPG signature from a trusted keyring, otherwise %FALSE - Repository + Repo - - ASCII SHA256 checksum - + + Name of remote or file:// url + - - Path to directory GPG keyrings; overrides built-in default if given - + + A GVariant a{sv} with an extensible set of flags. + - - Path to additional keyring file (not a directory) - + Progress + - Cancellable + Cancellable - - Read GPG signature(s) on the commit named by the ASCII checksum -@commit_checksum and return detailed results. - - an #OstreeGpgVerifyResult, or %NULL on error - + Return the size in bytes of object with checksum @sha256, after any +compression has been applied. + + + - Repository + Repo - - ASCII SHA256 checksum - + + Object type + - - Path to directory GPG keyrings; overrides built-in default if given - + + Checksum + - - Path to additional keyring file (not a directory) - + + Size in bytes object occupies physically + - Cancellable + Cancellable - - Verify @signatures for @summary data using GPG keys in the keyring for -@remote_name, and return an #OstreeGpgVerifyResult. - - an #OstreeGpgVerifyResult, or %NULL on error - + Load the content for @rev into @out_root. + + + - Repo + Repo - - Name of remote + + Ref or ASCII checksum - - Summary data as a #GBytes - + + An #OstreeRepoFile corresponding to the root + - - Summary signatures as a #GBytes - + + The resolved commit checksum + - Cancellable + Cancellable - - Import an archive file @archive into the repository, and write its -file structure to @mtree. + OSTree commits can have arbitrary metadata associated; this +function retrieves them. If none exists, @out_metadata will be set +to %NULL. + - An #OstreeRepo + Repo - - A path to an archive file - - - - The #OstreeMutableTree to write to - - - - Optional commit modifier - + + ASCII SHA256 commit checksum + - - Autocreate parent directories - + + Metadata associated with commit in with format +"a{sv}", or %NULL if none exists + - Cancellable + Cancellable - - Write a commit metadata object, referencing @root_contents_checksum -and @root_metadata_checksum. + Regenerate the OSTree repository metadata used by clients to describe +available branches and other metadata. + +The repository metadata currently consists of the `summary` file. See +ostree_repo_regenerate_summary() and %OSTREE_SUMMARY_GVARIANT_FORMAT for +additional details on its contents. + +Additionally, if the `core/collection-id` key is set in the configuration, a +%OSTREE_REPO_METADATA_REF commit will be created. + +The following @options are currently defined: + + * `gpg-key-ids` (`as`): Array of GPG key IDs to sign the metadata with. + * `gpg-homedir` (`s`): GPG home directory. + * `sign-keys` (`av`): Array of keys to sign the metadata with. The key + type is specific to the sign engine used. + * `sign-type` (`s`): Sign engine type to use. If not specified, + %OSTREE_SIGN_NAME_ED25519 is used. + +Locking: shared + - Repo + Repo - - ASCII SHA256 checksum for parent, or %NULL for none - + A GVariant `a{sv}`, or %NULL + - - Subject - + A GVariant `a{sv}` with an extensible set of flags + - - Body - + Cancellable + - + + + An OSTree repository can contain a high level "summary" file that +describes the available branches and other metadata. + +If the timetable for making commits and updating the summary file is fairly +regular, setting the `ostree.summary.expires` key in @additional_metadata +will aid clients in working out when to check for updates. + +It is regenerated automatically after any ref is +added, removed, or updated if `core/auto-update-summary` is set. + +If the `core/collection-id` key is set in the configuration, it will be +included as %OSTREE_SUMMARY_COLLECTION_ID in the summary file. Refs that +have associated collection IDs will be included in the generated summary +file, listed under the %OSTREE_SUMMARY_COLLECTION_MAP key. Collection IDs +and refs in %OSTREE_SUMMARY_COLLECTION_MAP are guaranteed to be in +lexicographic order. + +Locking: shared (Prior to 2021.7, this was exclusive) + + + + + + + Repo + + + - GVariant of type a{sv}, or %NULL for none + A GVariant of type a{sv}, or %NULL - - The tree to point the commit to - - - - Resulting ASCII SHA256 checksum for commit - + + Cancellable + + + + + By default, an #OstreeRepo will cache the remote configuration and its +own repo/config data. This API can be used to reload it. + + + + + + + repo + + - Cancellable + cancellable - - Replace any existing metadata associated with commit referred to by -@checksum with @metadata. If @metadata is %NULL, then existing -data will be deleted. + Create a new remote named @name pointing to @url. If @options is +provided, then it will be mapped to #GKeyFile entries, where the +GVariant dictionary key is an option string, and the value is +mapped as follows: + * s: g_key_file_set_string() + * b: g_key_file_set_boolean() + * as: g_key_file_set_string_list() + - Repo + Repo - - ASCII SHA256 commit checksum + + Name of remote - + URL for remote (if URL begins with metalink=, it will be used as such) + + + - Metadata to associate with commit in with format "a{sv}", or %NULL to delete + GVariant of type a{sv} - Cancellable + Cancellable - - Write a commit metadata object, referencing @root_contents_checksum -and @root_metadata_checksum. + A combined function handling the equivalent of +ostree_repo_remote_add(), ostree_repo_remote_delete(), with more +options. + - Repo + Repo - - ASCII SHA256 checksum for parent, or %NULL for none - + System root + - - Subject + + Operation to perform + + + + Name of remote - - Body + URL for remote (if URL begins with metalink=, it will be used as such) - - GVariant of type a{sv}, or %NULL for none + GVariant of type a{sv} - - The tree to point the commit to - - - - The time to use to stamp the commit - - - - Resulting ASCII SHA256 checksum for commit - - - Cancellable + Cancellable - - Save @new_config in place of this repository's config file. Note -that @new_config should not be modified after - this function -simply adds a reference. + Delete the remote named @name. It is an error if the provided +remote does not exist. + - Repo + Repo - - Overwrite the config file with this data. Do not change later! - + + Name of remote + + + + Cancellable + - - Store the content object streamed as @object_input, -with total length @length. The actual checksum will -be returned as @out_csum. + Tries to fetch the summary file and any GPG signatures on the summary file +over HTTP, and returns the binary data in @out_summary and @out_signatures +respectively. + +If no summary file exists on the remote server, @out_summary is set to +@NULL. Likewise if the summary file is not signed, @out_signatures is +set to @NULL. In either case the function still returns %TRUE. + +This method does not verify the signature of the downloaded summary file. +Use ostree_repo_verify_summary() for that. + +Parse the summary data into a #GVariant using g_variant_new_from_bytes() +with #OSTREE_SUMMARY_GVARIANT_FORMAT as the format string. + + %TRUE on success, %FALSE on failure - Repo + Self - - If provided, validate content against this checksum + + name of a remote - - Content object stream - - - - Length of @object_input - + + return location for raw summary data, or + %NULL + - - Binary checksum - - - + return location for raw summary + signature data, or %NULL + - Cancellable + a #GCancellable - - Asynchronously store the content object @object. If provided, the -checksum @expected_checksum will be verified. + + Like ostree_repo_remote_fetch_summary(), but supports an extensible set of flags. +The following are currently defined: + +- override-url (s): Fetch summary from this URL if remote specifies no metalink in options +- http-headers (a(ss)): Additional headers to add to all HTTP requests +- append-user-agent (s): Additional string to append to the user agent +- n-network-retries (u): Number of times to retry each download on receiving + a transient network error, such as a socket timeout; default is 5, 0 + means return errors without retrying + - + %TRUE on success, %FALSE on failure + - Repo + Self - + name of a remote + + + - If provided, validate content against this checksum - + A GVariant a{sv} with an extensible set of flags + - - Input - + + return location for raw summary data, or %NULL + - - Length of @object - + + return location for raw summary signature + data, or %NULL + - Cancellable + a #GCancellable - + + + Enumerate the trusted GPG keys for the remote @name. If @name is +%NULL, the global GPG keys will be returned. The keys will be +returned in the @out_keys #GPtrArray. Each element in the array is a +#GVariant of format %OSTREE_GPG_KEY_GVARIANT_FORMAT. The @key_ids +array can be used to limit which keys are included. If @key_ids is +%NULL, then all keys are included. + + + %TRUE if the GPG keys could be enumerated, %FALSE otherwise + + + + + an #OstreeRepo + + + - Invoked when content is writed - + allow-none="1"> + name of the remote or %NULL + - - User data for @callback - + + a %NULL-terminated array of GPG key IDs to include, or %NULL + + + + + + + return location for a #GPtrArray of the remote's trusted GPG keys, or + %NULL + + + + + + a #GCancellable, or %NULL + - - Completes an invocation of ostree_repo_write_content_async(). + Return whether GPG verification is enabled for the remote named @name +through @out_gpg_verify. It is an error if the provided remote does +not exist. + + %TRUE on success, %FALSE on failure - a #OstreeRepo + Repo - - a #GAsyncResult - + + Name of remote + - - A binary SHA256 checksum of the content object - + transfer-ownership="full" + optional="1" + allow-none="1"> + Remote's GPG option + - - Store the content object streamed as @object_input, with total -length @length. The given @checksum will be treated as trusted. - -This function should be used when importing file objects from local -disk, for example. + Return whether GPG verification of the summary is enabled for the remote +named @name through @out_gpg_verify_summary. It is an error if the provided +remote does not exist. + + %TRUE on success, %FALSE on failure - Repo + Repo - - Store content using this ASCII SHA256 checksum + + Name of remote - - Content stream - - - - Length of @object_input - - - - Cancellable - + Remote's GPG option + - - Store as objects all contents of the directory referred to by @dfd -and @path all children into the repository @self, overlaying the -resulting filesystem hierarchy into @mtree. + Return the URL of the remote named @name through @out_url. It is an +error if the provided remote does not exist. + + %TRUE on success, %FALSE on failure - Repo + Repo - - Directory file descriptor - - - - Path + + Name of remote - - Overlay directory contents into this tree - - - - Optional modifier - - - - Cancellable - + Remote's URL + - - Store objects for @dir and all children into the repository @self, -overlaying the resulting filesystem hierarchy into @mtree. + Imports one or more GPG keys from the open @source_stream, or from the +user's personal keyring if @source_stream is %NULL. The @key_ids array +can optionally restrict which keys are imported. If @key_ids is %NULL, +then all keys are imported. + +The imported keys will be used to conduct GPG verification when pulling +from the remote named @name. + + %TRUE on success, %FALSE on failure - Repo + Self - - Path to a directory - + + name of a remote + - - Overlay directory contents into this tree - + + a #GInputStream, or %NULL + - - Optional modifier - + a %NULL-terminated array of +GPG key IDs, or %NULL + + + + + + return location for the number of imported + keys, or %NULL + - Cancellable + a #GCancellable - - Store the metadata object @variant. Return the checksum -as @out_csum. - -If @expected_checksum is not %NULL, verify it against the -computed checksum. - - + + List available remote names in an #OstreeRepo. Remote names are sorted +alphabetically. If no remotes are available the function returns %NULL. + + + a %NULL-terminated + array of remote names + + + - Repo + Repo - - Object type - - - - If provided, validate content against this checksum - - - - Metadata - - - - Binary checksum - - - - - - Cancellable - + Number of remotes available + - - Asynchronously store the metadata object @variant. If provided, -the checksum @expected_checksum will be verified. + + List refs advertised by @remote_name, including refs which are part of +collections. If the repository at @remote_name has a collection ID set, its +refs will be returned with that collection ID; otherwise, they will be returned +with a %NULL collection ID in each #OstreeCollectionRef key in @out_all_refs. +Any refs for other collections stored in the repository will also be returned. +No filtering is performed. + - + - Repo + Repo - - Object type - - - - If provided, validate content against this checksum + + Name of the remote. - - Metadata - + + + Mapping from collection–ref to checksum + + + + - Cancellable + Cancellable - - Invoked when metadata is writed - - - - Data for @callback - - - + + Repo - - + + Name of the remote. + - - + + + Mapping from ref to checksum + + + + + + + Cancellable + - - Store the metadata object @variant; the provided @checksum is -trusted. + Look up the checksum for the given collection–ref, returning it in @out_rev. +This will search through the mirrors and remote refs. + +If @allow_noent is %TRUE and the given @ref cannot be found, %TRUE will be +returned and @out_rev will be set to %NULL. If @allow_noent is %FALSE and +the given @ref cannot be found, a %G_IO_ERROR_NOT_FOUND error will be +returned. + +If you want to check only local refs, not remote or mirrored ones, use the +flag %OSTREE_REPO_RESOLVE_REV_EXT_LOCAL_ONLY. This is analogous to using +ostree_repo_resolve_rev_ext() but for collection-refs. + + %TRUE on success, %FALSE on failure - Repo + an #OstreeRepo - - Object type - + + a collection–ref to resolve + - - Store object with this ASCII SHA256 checksum - + + %TRUE to not throw an error if @ref doesn’t exist + - - Metadata object stream - + + options controlling behaviour + - - Length, may be 0 for unknown - + + return location for + the checksum corresponding to @ref, or %NULL if @allow_noent is %TRUE and + the @ref could not be found + - Cancellable + a #GCancellable, or %NULL - - Store the metadata object @variant; the provided @checksum is -trusted. - - + Find the GPG keyring for the given @collection_id, using the local +configuration from the given #OstreeRepo. This will search the configured +remotes for ones whose `collection-id` key matches @collection_id, and will +return the first matching remote. + +If multiple remotes match and have different keyrings, a debug message will +be emitted, and the first result will be returned. It is expected that the +keyrings should match. + +If no match can be found, a %G_IO_ERROR_NOT_FOUND error will be returned. + + + #OstreeRemote containing the GPG keyring for + @collection_id + - Repo + an #OstreeRepo - - Object type - - - - Store object with this ASCII SHA256 checksum - - - - Metadata object - + + the collection ID to look up a keyring for + - Cancellable + a #GCancellable, or %NULL - - Write all metadata objects for @mtree to repo; the resulting -@out_file points to the %OSTREE_OBJECT_TYPE_DIR_TREE object that -the @mtree represented. + Look up the given refspec, returning the checksum it references in +the parameter @out_rev. Will fall back on remote directory if cannot +find the given refspec in local. + - Repo + Repo - - Mutable tree - + + A refspec + - + Do not throw an error if refspec does not exist + + + - An #OstreeRepoFile representing @mtree's root. - - - - Cancellable - + transfer-ownership="full" + nullable="1"> + A checksum,or %NULL if @allow_noent is true and it +does not exist + - + + Look up the given refspec, returning the checksum it references in +the parameter @out_rev. Differently from ostree_repo_resolve_rev(), +this will not fall back to searching through remote repos if a +local ref is specified but not found. + +The flag %OSTREE_REPO_RESOLVE_REV_EXT_LOCAL_ONLY is implied so +using it has no effect. + + + + + + + Repo + + + + A refspec + + + + Do not throw an error if refspec does not exist + + + + Options controlling behavior + + + + A checksum,or %NULL if @allow_noent is true and it +does not exist + + + + + + This function is deprecated in favor of using ostree_repo_devino_cache_new(), +which allows a precise mapping to be built up between hardlink checkout files +and their checksums between `ostree_repo_checkout_at()` and +`ostree_repo_write_directory_to_mtree()`. + +When invoking ostree_repo_write_directory_to_mtree(), it has to compute the +checksum of all files. If your commit contains hardlinks from a checkout, +this functions builds a mapping of device numbers and inodes to their +checksum. + +There is an upfront cost to creating this mapping, as this will scan the +entire objects directory. If your commit is composed of mostly hardlinks to +existing ostree objects, then this will speed up considerably, so call it +before you call ostree_repo_write_directory_to_mtree() or similar. However, +ostree_repo_devino_cache_new() is better as it avoids scanning all objects. + +Multithreading: This function is *not* MT safe. + + + + + + + An #OstreeRepo + + + + Cancellable + + + + + + Like ostree_repo_set_ref_immediate(), but creates an alias. + + + + + + + An #OstreeRepo + + + + A remote for the ref + + + + The ref to write + + + + The ref target to point it to, or %NULL to unset + + + + GCancellable + + + + + + Set a custom location for the cache directory used for e.g. +per-remote summary caches. Setting this manually is useful when +doing operations on a system repo as a user because you don't have +write permissions in the repo, where the cache is normally stored. + + + + + + + An #OstreeRepo + + + + directory fd + + + + subpath in @dfd + + + + a #GCancellable + + + + + + Set or clear the collection ID of this repository. See [collection IDs][collection-ids]. +The update will be made in memory, but must be written out to the repository +configuration on disk using ostree_repo_write_config(). + + + %TRUE on success, %FALSE otherwise + + + + + an #OstreeRepo + + + + new collection ID, or %NULL to unset it + + + + + + This is like ostree_repo_transaction_set_collection_ref(), except it may be +invoked outside of a transaction. This is presently safe for the +case where we're creating or overwriting an existing ref. + + + %TRUE on success, %FALSE otherwise + + + + + An #OstreeRepo + + + + The collection–ref to write + + + + The checksum to point it to, or %NULL to unset + + + + GCancellable + + + + + + Disable requests to fsync() to stable storage during commits. This +option should only be used by build system tools which are creating +disposable virtual machines, or have higher level mechanisms for +ensuring data consistency. + + + + + + + An #OstreeRepo + + + + If %TRUE, do not fsync + + + + + + This is like ostree_repo_transaction_set_ref(), except it may be +invoked outside of a transaction. This is presently safe for the +case where we're creating or overwriting an existing ref. + +Multithreading: This function is MT safe. + + + + + + + An #OstreeRepo + + + + A remote for the ref + + + + The ref to write + + + + The checksum to point it to, or %NULL to unset + + + + GCancellable + + + + + + Add a GPG signature to a commit. + + + + + + + Self + + + + SHA256 of given commit to sign + + + + Use this GPG key id + + + + GPG home directory, or %NULL + + + + A #GCancellable + + + + + + This function is deprecated, sign the summary file instead. +Add a GPG signature to a static delta. + + + + + + + Self + + + + From commit + + + + To commit + + + + key id + + + + homedir + + + + cancellable + + + + + + Validate the commit data using the commit metadata which must +contain at least one valid signature. If GPG and signapi are +both enabled, then both must find at least one valid signature. + + + + + + + Repo + + + + Name of remote + + + + Commit object data (GVariant) + + + + Commit metadata (GVariant `a{sv}`), must contain at least one valid signature + + + + Optionally disable GPG or signapi + + + + Textual description of results + + + + + + Given a directory representing an already-downloaded static delta +on disk, apply it, generating a new commit. The directory must be +named with the form "FROM-TO", where both are checksums, and it +must contain a file named "superblock", along with at least one part. + + + + + + + Repo + + + + Path to a directory containing static delta data, or directly to the superblock + + + + If %TRUE, assume data integrity + + + + Cancellable + + + + + + Given a directory representing an already-downloaded static delta +on disk, apply it, generating a new commit. +If sign is passed, the static delta signature is verified. +If sign-verify-deltas configuration option is set and static delta is signed, +signature verification will be mandatory before apply the static delta. +The directory must be named with the form "FROM-TO", where both are +checksums, and it must contain a file named "superblock", along with at least +one part. + + + + + + + Repo + + + + Path to a directory containing static delta data, or directly to the superblock + + + + Signature engine used to check superblock + + + + If %TRUE, assume data integrity + + + + Cancellable + + + + + + Generate a lookaside "static delta" from @from (%NULL means +from-empty) which can generate the objects in @to. This delta is +an optimization over fetching individual objects, and can be +conveniently stored and applied offline. + +The @params argument should be an a{sv}. The following attributes +are known: + - min-fallback-size: u: Minimum uncompressed size in megabytes to use fallback, 0 to disable +fallbacks + - max-chunk-size: u: Maximum size in megabytes of a delta part + - max-bsdiff-size: u: Maximum size in megabytes to consider bsdiff compression + for input files + - compression: y: Compression type: 0=none, x=lzma, g=gzip + - bsdiff-enabled: b: Enable bsdiff compression. Default TRUE. + - inline-parts: b: Put part data in header, to get a single file delta. Default FALSE. + - verbose: b: Print diagnostic messages. Default FALSE. + - endianness: b: Deltas use host byte order by default; this option allows choosing +(G_BIG_ENDIAN or G_LITTLE_ENDIAN) + - filename: ^ay: Save delta superblock to this filename (bytestring), and parts in the same +directory. Default saves to repository. + - sign-name: ^ay: Signature type to use (bytestring). + - sign-key-ids: ^as: NULL-terminated array of keys used to sign delta superblock. + + + + + + + Repo + + + + High level optimization choice + + + + ASCII SHA256 checksum of origin, or %NULL + + + + ASCII SHA256 checksum of target + + + + Optional metadata + + + + Parameters, see below + + + + Cancellable + + + + + + The delta index for a particular commit lists all the existing deltas that can be used +when downloading that commit. This operation regenerates these indexes, either for +a particular commit (if @opt_to_commit is non-%NULL), or for all commits that +are reachable by an existing delta (if @opt_to_commit is %NULL). + +This is normally called automatically when the summary is updated in +ostree_repo_regenerate_summary(). + +Locking: shared + + + + + + + Repo + + + + Flags affecting the indexing operation + + + + ASCII SHA256 checksum of target commit, or %NULL to index all targets + + + + Cancellable + + + + + + Verify static delta file signature. + + + TRUE if the signature of static delta file is valid using the +signature engine provided, FALSE otherwise. + + + + + Repo + + + + delta path + + + + Signature engine used to check superblock + + + + success message + + + + + + If @checksum is not %NULL, then record it as the target of local ref named +@ref. + +Otherwise, if @checksum is %NULL, then record that the ref should +be deleted. + +The change will not be written out immediately, but when the transaction +is completed with ostree_repo_commit_transaction(). If the transaction +is instead aborted with ostree_repo_abort_transaction(), no changes will +be made to the repository. + +Multithreading: Since v2017.15 this function is MT safe. + + + + + + + An #OstreeRepo + + + + The collection–ref to write + + + + The checksum to point it to + + + + + + If @checksum is not %NULL, then record it as the target of ref named +@ref; if @remote is provided, the ref will appear to originate from that +remote. + +Otherwise, if @checksum is %NULL, then record that the ref should +be deleted. + +The change will be written when the transaction is completed with +ostree_repo_commit_transaction(); that function takes care of writing all of +the objects (such as the commit referred to by @checksum) before updating the +refs. If the transaction is instead aborted with +ostree_repo_abort_transaction(), no changes to the ref will be made to the +repository. + +Note however that currently writing *multiple* refs is not truly atomic; if +the process or system is terminated during +ostree_repo_commit_transaction(), it is possible that just some of the refs +will have been updated. Your application should take care to handle this +case. + +Multithreading: Since v2017.15 this function is MT safe. + + + + + + + An #OstreeRepo + + + + A remote for the ref + + + + The ref to write + + + + The checksum to point it to + + + + + + Like ostree_repo_transaction_set_ref(), but takes concatenated +@refspec format as input instead of separate remote and name +arguments. + +Multithreading: Since v2017.15 this function is MT safe. + + + + + + + An #OstreeRepo + + + + The refspec to write + + + + The checksum to point it to + + + + + + Create a new set @out_reachable containing all objects reachable +from @commit_checksum, traversing @maxdepth parent commits. + + + + + + + Repo + + + + ASCII SHA256 checksum + + + + Traverse this many parent commits, -1 for unlimited + + + + Set of reachable +objects + + + + + + + Cancellable + + + + + + Update the set @inout_reachable containing all objects reachable +from @commit_checksum, traversing @maxdepth parent commits. + + + + + + + Repo + + + + ASCII SHA256 checksum + + + + Traverse this many parent commits, -1 for unlimited + + + + Set of reachable objects + + + + + + + Cancellable + + + + + + Update the set @inout_reachable containing all objects reachable +from @commit_checksum, traversing @maxdepth parent commits. + +Additionally this constructs a mapping from each object to the parents +of the object, which can be used to track which commits an object +belongs to. + + + + + + + Repo + + + + ASCII SHA256 checksum + + + + Traverse this many parent commits, -1 for unlimited + + + + Set of reachable objects + + + + + + + Map from object to parent object + + + + + + + Cancellable + + + + + + Update the set @inout_reachable containing all objects reachable +from @commit_checksum, traversing @maxdepth parent commits. + +Additionally this constructs a mapping from each object to the parents +of the object, which can be used to track which commits an object +belongs to. + + + + + + + Repo + + + + change traversal behaviour according to these flags + + + + ASCII SHA256 checksum + + + + Traverse this many parent commits, -1 for unlimited + + + + Set of reachable objects + + + + + + + Map from object to parent object + + + + + + + Cancellable + + + + + + Add all commit objects directly reachable via a ref to @reachable. + +Locking: shared + + + + + + + Repo + + + + Depth of traversal + + + + Set of reachable objects (will be modified) + + + + + + + Cancellable + + + + + + Check for a valid GPG signature on commit named by the ASCII +checksum @commit_checksum. + + + %TRUE if there was a GPG signature from a trusted keyring, otherwise %FALSE + + + + + Repository + + + + ASCII SHA256 checksum + + + + Path to directory GPG keyrings; overrides built-in default if given + + + + Path to additional keyring file (not a directory) + + + + Cancellable + + + + + + Read GPG signature(s) on the commit named by the ASCII checksum +@commit_checksum and return detailed results. + + + an #OstreeGpgVerifyResult, or %NULL on error + + + + + Repository + + + + ASCII SHA256 checksum + + + + Path to directory GPG keyrings; overrides built-in default if given + + + + Path to additional keyring file (not a directory) + + + + Cancellable + + + + + + Read GPG signature(s) on the commit named by the ASCII checksum +@commit_checksum and return detailed results, based on the keyring +configured for @remote. + + + an #OstreeGpgVerifyResult, or %NULL on error + + + + + Repository + + + + ASCII SHA256 checksum + + + + OSTree remote to use for configuration + + + + Cancellable + + + + + + Verify @signatures for @summary data using GPG keys in the keyring for +@remote_name, and return an #OstreeGpgVerifyResult. + + + an #OstreeGpgVerifyResult, or %NULL on error + + + + + Repo + + + + Name of remote + + + + Summary data as a #GBytes + + + + Summary signatures as a #GBytes + + + + Cancellable + + + + + + Import an archive file @archive into the repository, and write its +file structure to @mtree. + + + + + + + An #OstreeRepo + + + + A path to an archive file + + + + The #OstreeMutableTree to write to + + + + Optional commit modifier + + + + Autocreate parent directories + + + + Cancellable + + + + + + Read an archive from @fd and import it into the repository, writing +its file structure to @mtree. + + + + + + + An #OstreeRepo + + + + A file descriptor to read the archive from + + + + The #OstreeMutableTree to write to + + + + Optional commit modifier + + + + Autocreate parent directories + + + + Cancellable + + + + + + Write a commit metadata object, referencing @root_contents_checksum +and @root_metadata_checksum. +This uses the current time as the commit timestamp, but it can be +overridden with an explicit timestamp via the +[standard](https://reproducible-builds.org/specs/source-date-epoch/) +`SOURCE_DATE_EPOCH` environment flag. + + + + + + + Repo + + + + ASCII SHA256 checksum for parent, or %NULL for none + + + + Subject + + + + Body + + + + GVariant of type a{sv}, or %NULL for none + + + + The tree to point the commit to + + + + Resulting ASCII SHA256 checksum for +commit + + + + Cancellable + + + + + + Replace any existing metadata associated with commit referred to by +@checksum with @metadata. If @metadata is %NULL, then existing +data will be deleted. + + + + + + + Repo + + + + ASCII SHA256 commit checksum + + + + Metadata to associate with commit in with format "a{sv}", or %NULL to +delete + + + + Cancellable + + + + + + Write a commit metadata object, referencing @root_contents_checksum +and @root_metadata_checksum. + + + + + + + Repo + + + + ASCII SHA256 checksum for parent, or %NULL for none + + + + Subject + + + + Body + + + + GVariant of type a{sv}, or %NULL for none + + + + The tree to point the commit to + + + + The time to use to stamp the commit + + + + Resulting ASCII SHA256 checksum for +commit + + + + Cancellable + + + + + + Save @new_config in place of this repository's config file. + + + + + + + Repo + + + + Overwrite the config file with this data + + + + + + Store the content object streamed as @object_input, +with total length @length. The actual checksum will +be returned as @out_csum. + + + + + + + Repo + + + + If provided, validate content against this checksum + + + + Content object stream + + + + Length of @object_input + + + + Binary checksum + + + + + + Cancellable + + + + + + Asynchronously store the content object @object. If provided, the +checksum @expected_checksum will be verified. + + + + + + + Repo + + + + If provided, validate content against this checksum + + + + Input + + + + Length of @object + + + + Cancellable + + + + Invoked when content is writed + + + + User data for @callback + + + + + + Completes an invocation of ostree_repo_write_content_async(). + + + + + + + a #OstreeRepo + + + + a #GAsyncResult + + + + A binary SHA256 +checksum of the content object + + + + + + Store the content object streamed as @object_input, with total +length @length. The given @checksum will be treated as trusted. + +This function should be used when importing file objects from local +disk, for example. + + + + + + + Repo + + + + Store content using this ASCII SHA256 checksum + + + + Content stream + + + + Length of @object_input + + + + Cancellable + + + + + + Store as objects all contents of the directory referred to by @dfd +and @path all children into the repository @self, overlaying the +resulting filesystem hierarchy into @mtree. + + + + + + + Repo + + + + Directory file descriptor + + + + Path + + + + Overlay directory contents into this tree + + + + Optional modifier + + + + Cancellable + + + + + + Store objects for @dir and all children into the repository @self, +overlaying the resulting filesystem hierarchy into @mtree. + + + + + + + Repo + + + + Path to a directory + + + + Overlay directory contents into this tree + + + + Optional modifier + + + + Cancellable + + + + + + Store the metadata object @object. Return the checksum +as @out_csum. + +If @expected_checksum is not %NULL, verify it against the +computed checksum. + + + + + + + Repo + + + + Object type + + + + If provided, validate content against this checksum + + + + Metadata + + + + Binary checksum + + + + + + Cancellable + + + + + + Asynchronously store the metadata object @variant. If provided, +the checksum @expected_checksum will be verified. + + + + + + + Repo + + + + Object type + + + + If provided, validate content against this checksum + + + + Metadata + + + + Cancellable + + + + Invoked when metadata is writed + + + + Data for @callback + + + + + + Complete a call to ostree_repo_write_metadata_async(). + + + + + + + Repo + + + + Result + + + + Binary checksum value + + + + + + + + Store the metadata object @variant; the provided @checksum is +trusted. + + + + + + + Repo + + + + Object type + + + + Store object with this ASCII SHA256 checksum + + + + Metadata object stream + + + + Length, may be 0 for unknown + + + + Cancellable + + + + + + Store the metadata object @variant; the provided @checksum is +trusted. + + + + + + + Repo + + + + Object type + + + + Store object with this ASCII SHA256 checksum + + + + Metadata object + + + + Cancellable + + + + + + Write all metadata objects for @mtree to repo; the resulting +@out_file points to the %OSTREE_OBJECT_TYPE_DIR_TREE object that +the @mtree represented. + + + + + + + Repo + + + + Mutable tree + + + + An #OstreeRepoFile representing @mtree's root. + + + + Cancellable + + + + + + Create an `OstreeContentWriter` that allows streaming output into +the repository. + + + A new writer, or %NULL on error + + + + + Repo, + + + + Expected checksum (SHA-256 hex string) + + + + user id + + + + group id + + + + Unix file mode + + + + Expected content length + + + + Extended attributes (GVariant type `(ayay)`) + + + + + + Synchronously create a file object from the provided content. This API +is intended for small files where it is reasonable to buffer the entire +content in memory. + +Unlike `ostree_repo_write_content()`, if @expected_checksum is provided, +this function will not check for the presence of the object beforehand. + + + Checksum (as a hex string) of the committed file + + + + + repo + + + + The expected checksum + + + + User id + + + + Group id + + + + File mode + + + + Extended attributes, GVariant of type (ayay) + + + + File contents + + + + + + + + + Cancellable + + + + + + Synchronously create a symlink object. + +Unlike `ostree_repo_write_content()`, if @expected_checksum is provided, +this function will not check for the presence of the object beforehand. + + + Checksum (as a hex string) of the committed file + + + + + repo + + + + The expected checksum + + + + User id + + + + Group id + + + + Extended attributes, GVariant of type (ayay) + + + + Target of the symbolic link + + + + Cancellable + + + + + + Path to repository. Note that if this repository was created +via `ostree_repo_new_at()`, this value will refer to a value in +the Linux kernel's `/proc/self/fd` directory. Generally, you +should avoid using this property at all; you can gain a reference +to the repository's directory fd via `ostree_repo_get_dfd()` and +use file-descriptor relative operations. + transfer-ownership="none" + default-value="NULL"> + Path to directory containing remote definitions. The default is `NULL`. +If a `sysroot-path` property is defined, this value will default to +`${sysroot_path}/etc/ostree/remotes.d`. + +This value will only be used for system repositories. + A system using libostree for the host has a "system" repository; this +property will be set for repositories referenced via +`ostree_sysroot_repo()` for example. + +You should avoid using this property; if your code is operating +on a system repository, use `OstreeSysroot` and access the repository +object via `ostree_sysroot_repo()`. - Emitted during a pull operation upon GPG verification (if enabled). + Emitted during a pull operation upon GPG verification (if enabled). Applications can connect to this signal to output the verification results if desired. -The signal will be emitted from whichever #GMainContext is the -thread-default at the point when ostree_repo_pull_with_options() -is called. +The signal will be emitted from whichever #GMainContext is the +thread-default at the point when ostree_repo_pull_with_options() +is called. + + + + + + checksum of the signed object + + + + an #OstreeGpgVerifyResult + + + + + + + An extensible options structure controlling checkout. Ensure that +you have entirely zeroed the structure, then set just the desired +options. This is used by ostree_repo_checkout_at() which +supercedes previous separate enumeration usage in +ostree_repo_checkout_tree() and ostree_repo_checkout_tree_at(). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This function simply assigns @cache to the `devino_to_csum_cache` member of +@opts; it's only useful for introspection. + +Note that cache does *not* have its refcount incremented - the lifetime of +@cache must be equal to or greater than that of @opts. + + + + + + + Checkout options + + + + Devino cache + + + + + + + + + #OstreeRepoCheckoutFilterResult saying whether or not to checkout this file + + + + + Repo + + + + Path to file + + + + File information + + + + User data + + + + + + + + Do checkout this object + + + Ignore this object + + + + + + No special options + + + Ignore uid/gid of files + + + + An extensible options structure controlling checkout. Ensure that +you have entirely zeroed the structure, then set just the desired +options. This is used by ostree_repo_checkout_tree_at() which +supercedes previous separate enumeration usage in +ostree_repo_checkout_tree(). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + No special options + + + When layering checkouts, unlink() and replace +existing files, but do not modify existing directories (unless whiteouts are enabled, then +directories are replaced) + + + Only add new files/directories + + + Like UNION_FILES, but error if files are not +identical (requires hardlink checkouts) + + + + + + #OstreeRepoCommitFilterResult saying whether or not to commit this file + + + + + Repo + + + + Path to file + + + + File information + + + + User data + + + + + + + + Do commit this object + + + Ignore this object + + + + + + + + + + + + + + + A structure allowing control over commits. + + + + + A new commit modifier. + + + + + Control options for filter + + + + Function that can inspect individual files + + + + User data + + + + A #GDestroyNotify + + + + + + + + + + + + + + + + + See the documentation for +`ostree_repo_devino_cache_new()`. This function can +then be used for later calls to +`ostree_repo_write_directory_to_mtree()` to optimize commits. + +Note if your process has multiple writers, you should use separate +`OSTreeRepo` instances if you want to also use this API. + +This function will add a reference to @cache without copying - you +should avoid further mutation of the cache. + + + + + + + Modifier + + + + A hash table caching device,inode to checksums + + + + + + If @policy is non-%NULL, use it to look up labels to use for +"security.selinux" extended attributes. + +Note that any policy specified this way operates in addition to any +extended attributes provided via +ostree_repo_commit_modifier_set_xattr_callback(). However if both +specify a value for "security.selinux", then the one from the +policy wins. + + + + + + + An #OstreeRepoCommitModifier + + + + Policy to use for labeling + + + + + + In many cases, one wants to create a "derived" commit from base commit. +SELinux policy labels are part of that base commit. This API allows +one to easily set up SELinux labeling from a base commit. + + + + + + + Commit modifier + + + + OSTree repo containing @rev + + + + Find SELinux policy from this base commit + + + + + + + + + If set, this function should return extended attributes to use for +the given path. This is useful for things like ACLs and SELinux, +where a build system can label the files as it's committing to the +repository. + + + + + + + An #OstreeRepoCommitModifier + + + + Function to be invoked, should return extended attributes for path + + + + Destroy notification + + + + Data for @callback: + + + + + + + + + + + + + + + + + + Flags modifying commit behavior. In bare-user-only mode, +@OSTREE_REPO_COMMIT_MODIFIER_FLAGS_CANONICAL_PERMISSIONS and +@OSTREE_REPO_COMMIT_MODIFIER_FLAGS_SKIP_XATTRS are automatically enabled. + + + No special flags + + + Do not process extended attributes + + + Generate size information. + + + Canonicalize permissions. + + + Emit an error if configured SELinux +policy does not provide a label + + + Delete added files/directories after commit; Since: +2017.13 + + + If a devino cache hit is found, skip +modifier filters (non-directories only); Since: 2017.14 + + + For SELinux and other systems, label +/usr/etc as if it was /etc. + + + + + + + + + + + + + + + + + + + + + + + + Flags representing the state of a commit in the local repository, as returned +by ostree_repo_load_commit(). + + + Commit is complete. This is the default. + (Since: 2017.14.) + + + One or more objects are missing from the + local copy of the commit, but metadata is present. (Since: 2015.7.) + + + One or more objects are missing from the + local copy of the commit, due to an fsck --delete. (Since: 2019.4.) + + + + + + No special options for traverse + + + Traverse and retrieve only commit objects. +(Since: 2022.2) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Return information on the current directory. This function may +only be called if %OSTREE_REPO_COMMIT_ITER_RESULT_DIR was returned +from ostree_repo_commit_traverse_iter_next(). + + + + + + + An iter + + + + Name of current dir + + + + Checksum of current content + + + + Checksum of current metadata + + + + + + Return information on the current file. This function may only be +called if %OSTREE_REPO_COMMIT_ITER_RESULT_FILE was returned from +ostree_repo_commit_traverse_iter_next(). + + + + + + + An iter + + + + Name of current file + + + + Checksum of current file + + + + + + Initialize (in place) an iterator over the root of a commit object. + + + + + + + An iter + + + + A repo + + + + Variant of type %OSTREE_OBJECT_TYPE_COMMIT + + + + Flags + + + + + + Initialize (in place) an iterator over a directory tree. + + + + + + + An iter + + + + A repo + + + + Variant of type %OSTREE_OBJECT_TYPE_DIR_TREE + + + + Flags + + + + + + Step the interator to the next item. Files will be returned first, +then subdirectories. Call this in a loop; upon encountering +%OSTREE_REPO_COMMIT_ITER_RESULT_END, there will be no more files or +directories. If %OSTREE_REPO_COMMIT_ITER_RESULT_DIR is returned, +then call ostree_repo_commit_traverse_iter_get_dir() to retrieve +data for that directory. Similarly, if +%OSTREE_REPO_COMMIT_ITER_RESULT_FILE is returned, call +ostree_repo_commit_traverse_iter_get_file(). + +If %OSTREE_REPO_COMMIT_ITER_RESULT_ERROR is returned, it is a +program error to call any further API on @iter except for +ostree_repo_commit_traverse_iter_clear(). + + + + + + + An iter + + + + Cancellable + + + + + + + + + + + + + + + + + + + + OSTree has support for pairing ostree_repo_checkout_tree_at() using +hardlinks in combination with a later +ostree_repo_write_directory_to_mtree() using a (normally modified) +directory. In order for OSTree to optimally detect just the new +files, use this function and fill in the `devino_to_csum_cache` +member of `OstreeRepoCheckoutAtOptions`, then call +ostree_repo_commit_set_devino_cache(). + + + Newly allocated cache + + + + + + + + + + + + + + + + + + + + + + + + + + + + An extensible options structure controlling archive creation. Ensure that +you have entirely zeroed the structure, then set just the desired +options. This is used by ostree_repo_export_tree_to_archive(). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Ensure that the backing metadata is loaded. + + + %FALSE if the operation failed, %TRUE otherwise + + + + + A repo file + + + + + + + + + + + + + + + + + + + Repository + + + + + + + + + + + + The root directory for the commit referenced by this file + + + + + + + + + + + + + + + + #OstreeRepoFile + + + + the extended attributes + + + + Cancellable + + + + + + + + + + + + #OstreeRepoFile + + + + name of the child + + + + + + + + + + + + This API will return %NULL if the file is not "resolved" i.e. in a loaded +state. It will also return %NULL if this path is not a directory tree. + + + The GVariant representing the children of this directory. + + + + + A repo file + + + + + + + + The SHA256 digest of the content object, or %NULL if this is not a +directory. + + + + + A repo file + + + + + + This API will return %NULL if the file is not "resolved" i.e. in a loaded +state. It will also return %NULL if this path is not a directory tree. + + + The GVariant representing the metadata for this directory. + + + + + A repo file + + + + + + + + The SHA256 digest of the metadata object, or %NULL if this is not a +directory. + + + + + A repo file + + + + + + + + %TRUE on success and the @out_info is set, %FALSE otherwise. + + + + + #OstreeRepoFile + + + + the child number + + + + an attribute string to match, see g_file_attribute_matcher_new() + + + + a #GFileQueryInfoFlags + + + + the #GFileInfo of the child. + + + + a #GCancellable or %NULL + + + + + + Replace the metadata checksum and metadata object. + + + + + + + A repo file + + + + + + + + + + + + + + + + + + + + + A version of ostree_repo_finder_resolve_async() which queries one or more +@finders in parallel and combines the results. + + + + + + + non-empty array of #OstreeRepoFinders + + + + + + non-empty array of collection–ref pairs to find remotes for + + + + + + the local repository which the refs are being resolved for, + which provides configuration information and GPG keys + + + + a #GCancellable, or %NULL + + + + asynchronous completion callback + + + + data to pass to @callback + + + + + + Get the results from a ostree_repo_finder_resolve_all_async() operation. + + + array of zero + or more results + + + + + + + #GAsyncResult from the callback + + + + + + Find reachable remote URIs which claim to provide any of the given @refs. The +specific method for finding the remotes depends on the #OstreeRepoFinder +implementation. + +Any remote which is found and which claims to support any of the given @refs +will be returned in the results. It is possible that a remote claims to +support a given ref, but turns out not to — it is not possible to verify this +until ostree_repo_pull_from_remotes_async() is called. + +The returned results will be sorted with the most useful first — this is +typically the remote which claims to provide the most @refs, at the lowest +latency. + +Each result contains a mapping of @refs to the checksums of the commits +which the result provides. If the result provides the latest commit for a ref +across all of the results, the checksum will be set. Otherwise, if the +result provides an outdated commit, or doesn’t provide a given ref at all, +the checksum will not be set. Results which provide none of the requested +@refs may be listed with an empty refs map. + +Pass the results to ostree_repo_pull_from_remotes_async() to pull the given +@refs from those remotes. + - - checksum of the signed object - + + an #OstreeRepoFinder + + + + non-empty array of collection–ref pairs to find remotes for + + + - - an #OstreeGpgVerifyResult - + + the local repository which the refs are being resolved for, + which provides configuration information and GPG keys + + + + a #GCancellable, or %NULL + + + + asynchronous completion callback + + + + data to pass to @callback + - - - - An extensible options structure controlling checkout. Ensure that -you have entirely zeroed the structure, then set just the desired -options. This is used by ostree_repo_checkout_at() which -supercedes previous separate enumeration usage in -ostree_repo_checkout_tree() and ostree_repo_checkout_tree_at(). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - No special options - - - Ignore uid/gid of files - - - - An extensible options structure controlling checkout. Ensure that -you have entirely zeroed the structure, then set just the desired -options. This is used by ostree_repo_checkout_tree_at() which -supercedes previous separate enumeration usage in -ostree_repo_checkout_tree(). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - No special options - - - When layering checkouts, overwrite earlier files, but keep earlier directories - - - - - #OstreeRepoCommitFilterResult saying whether or not to commit this file - - - - - Repo - - - - Path to file - - - - File information - - - - User data - - - - - - - Do commit this object - - - Ignore this object - - - - - - - - - - - - - - A structure allowing control over commits. - + + + Get the results from a ostree_repo_finder_resolve_async() operation. + - A new commit modifier. - + array of zero + or more results + + + - - Control options for filter - + + an #OstreeRepoFinder + + + + #GAsyncResult from the callback + - + + + Find reachable remote URIs which claim to provide any of the given @refs. The +specific method for finding the remotes depends on the #OstreeRepoFinder +implementation. + +Any remote which is found and which claims to support any of the given @refs +will be returned in the results. It is possible that a remote claims to +support a given ref, but turns out not to — it is not possible to verify this +until ostree_repo_pull_from_remotes_async() is called. + +The returned results will be sorted with the most useful first — this is +typically the remote which claims to provide the most @refs, at the lowest +latency. + +Each result contains a mapping of @refs to the checksums of the commits +which the result provides. If the result provides the latest commit for a ref +across all of the results, the checksum will be set. Otherwise, if the +result provides an outdated commit, or doesn’t provide a given ref at all, +the checksum will not be set. Results which provide none of the requested +@refs may be listed with an empty refs map. + +Pass the results to ostree_repo_pull_from_remotes_async() to pull the given +@refs from those remotes. + + + + + + + an #OstreeRepoFinder + + + + non-empty array of collection–ref pairs to find remotes for + + + + + + the local repository which the refs are being resolved for, + which provides configuration information and GPG keys + + + + a #GCancellable, or %NULL + + + - Function that can inspect individual files - + scope="async" + closure="4"> + asynchronous completion callback + - User data + data to pass to @callback - - A #GDestroyNotify - - - - + + + Get the results from a ostree_repo_finder_resolve_async() operation. + - + array of zero + or more results + + + - - + + an #OstreeRepoFinder + + + #GAsyncResult from the callback + + - - See the documentation for -`ostree_repo_devino_cache_new()`. This function can -then be used for later calls to -`ostree_repo_write_directory_to_mtree()` to optimize commits. + + + + + + Create a new #OstreeRepoFinderAvahi instance. It is intended that one such +instance be created per process, and it be used to answer all resolution +requests from #OstreeRepos. -Note if your process has multiple writers, you should use separate -`OSTreeRepo` instances if you want to also use this API. +The calling code is responsible for ensuring that @context is iterated while +the #OstreeRepoFinderAvahi is running (after ostree_repo_finder_avahi_start() +is called). This may be done from any thread. -This function will add a reference to @cache without copying - you -should avoid further mutation of the cache. +If @context is %NULL, the current thread-default #GMainContext is used. + + + a new #OstreeRepoFinderAvahi + + + + + a #GMainContext for processing Avahi + events in, or %NULL to use the current thread-default + + + + + + Start monitoring the local network for peers who are advertising OSTree +repositories, using Avahi. In order for this to work, the #GMainContext +passed to @self at construction time must be iterated (so it will typically +be the global #GMainContext, or be a separate #GMainContext in a worker +thread). + +This will return an error (%G_IO_ERROR_FAILED) if initialisation fails, or if +Avahi support is not available (%G_IO_ERROR_NOT_SUPPORTED). In either case, +the #OstreeRepoFinderAvahi instance is useless afterwards and should be +destroyed. + +Call ostree_repo_finder_avahi_stop() to stop the repo finder. + +It is an error to call this function multiple times on the same +#OstreeRepoFinderAvahi instance, or to call it after +ostree_repo_finder_avahi_stop(). + - - Modifier - + + an #OstreeRepoFinderAvahi + - - A hash table caching device,inode to checksums - - - - If @policy is non-%NULL, use it to look up labels to use for -"security.selinux" extended attributes. + + Stop monitoring the local network for peers who are advertising OSTree +repositories. If any resolve tasks (from ostree_repo_finder_resolve_async()) +are in progress, they will be cancelled and will return %G_IO_ERROR_CANCELLED. -Note that any policy specified this way operates in addition to any -extended attributes provided via -ostree_repo_commit_modifier_set_xattr_callback(). However if both -specify a value for "security.selinux", then the one from the -policy wins. +Call ostree_repo_finder_avahi_start() to start the repo finder. + +It is an error to call this function multiple times on the same +#OstreeRepoFinderAvahi instance, or to call it before +ostree_repo_finder_avahi_start(). + - - An #OstreeRepoCommitModifier - + + an #OstreeRepoFinderAvahi + - + + + + + + + + + + + + + Create a new #OstreeRepoFinderConfig. + + + a new #OstreeRepoFinderConfig + + + + + + + + + + + + + + + + + + + + + + + + an #OstreeRepoFinder + + + + non-empty array of collection–ref pairs to find remotes for + + + + + + the local repository which the refs are being resolved for, + which provides configuration information and GPG keys + + + + a #GCancellable, or %NULL + + + + asynchronous completion callback + + + + data to pass to @callback + + + + + + + + + + array of zero + or more results + + + + + + + an #OstreeRepoFinder + + + + #GAsyncResult from the callback + + + + + + + + + + + Create a new #OstreeRepoFinderMount, using the given @monitor to look up +volumes. If @monitor is %NULL, the monitor from g_volume_monitor_get() will +be used. + + + a new #OstreeRepoFinderMount + + + + - Policy to use for labeling - + volume monitor to use, or %NULL to use + the system default + - - - If set, this function should return extended attributes to use for -the given path. This is useful for things like ACLs and SELinux, -where a build system can label the files as it's committing to the -repository. + + + Volume monitor to use to look up mounted volumes when queried. + + + + + + + + + + + + + + Create a new #OstreeRepoFinderOverride. + + + a new #OstreeRepoFinderOverride + + + + + Add the given @uri to the set of URIs which the repo finder will search for +matching refs when ostree_repo_finder_resolve_async() is called on it. + - - An #OstreeRepoCommitModifier - + + - - Function to be invoked, should return extended attributes for path - + + URI to add to the repo finder + - - Destroy notification - + + + + + + + + + + + #OstreeRepoFinderResult gives a single result from an +ostree_repo_finder_resolve_async() or ostree_repo_finder_resolve_all_async() +operation. This represents a single remote which provides none, some or all +of the refs being resolved. The structure includes various bits of metadata +which allow ostree_repo_pull_from_remotes_async() (for example) to prioritise +how to pull the refs. + +An #OstreeRepoFinderResult is immutable after construction. + +The @priority is used as one input of many to ordering functions like +ostree_repo_finder_result_compare(). + +@ref_to_checksum indicates which refs (out of the ones queried for as inputs +to ostree_repo_finder_resolve_async()) are provided by this remote. The refs +are present as keys (of type #OstreeCollectionRef), and the corresponding values +are the checksums of the commits the remote currently has for those refs. (These +might not be the latest commits available out of all results.) A +checksum may be %NULL if the remote does not advertise the corresponding ref. +After ostree_repo_finder_resolve_async() has been called, the commit metadata +should be available locally, so the details for each checksum can be looked +up using ostree_repo_load_commit(). + +@ref_to_timestamp provides timestamps for the set of refs in +@ref_to_checksum. The refs are keys (of type #OstreeCollectionRef) and the +values are guint64 pointers with the timestamp associated with the checksum +provided in @ref_to_checksum. @ref_to_timestamp can be %NULL, and when it's +not, the timestamps are zero when any of the following conditions are met: +(1) the override-commit-ids option was used on +ostree_repo_find_remotes_async (2) there was an error in trying to get the +commit metadata (3) the checksum for this ref is %NULL in @ref_to_checksum. + + + #OstreeRemote which contains the transport details for the result, + such as its URI and GPG key + + + + the #OstreeRepoFinder instance which produced this result + + + + static priority of the result, where higher numbers indicate lower + priority + + + + map of collection–ref + pairs to checksums provided by this remote; values may be %NULL to + indicate this remote doesn’t provide that ref + + + + + + + Unix timestamp (seconds since the epoch, UTC) when + the summary file on the remote was last modified, or `0` if unknown + + + + map of + collection–ref pairs to timestamps; values may be 0 for various reasons + + + + + + + + + + + + Create a new #OstreeRepoFinderResult instance. The semantics for the arguments +are as described in the #OstreeRepoFinderResult documentation. + + + a new #OstreeRepoFinderResult + + + + + an #OstreeRemote containing the transport details + for the result + + + + the #OstreeRepoFinder instance which produced the + result + + + + static priority of the result, where higher numbers indicate lower + priority + - + + map of collection–ref pairs to checksums provided by this result + + + + + + - Data for @callback: - + map of collection–ref pairs to timestamps provided by this + result + + + + + + + Unix timestamp (seconds since the epoch, UTC) when + the summary file for the result was last modified, or `0` if this is unknown + + + + + + Compare two #OstreeRepoFinderResult instances to work out which one is better +to pull from, and hence needs to be ordered before the other. + + + <0 if @a is ordered before @b, 0 if they are ordered equally, + >0 if @b is ordered before @a + + + + + an #OstreeRepoFinderResult + + + + an #OstreeRepoFinderResult + - + + Copy an #OstreeRepoFinderResult. + + + a newly allocated copy of @result + + + + + an #OstreeRepoFinderResult to copy + + + + + + Free the given @result. + - - + + an #OstreeRepoFinderResult + + + Free the given @results array, freeing each element and the container. + + + + + + + an #OstreeRepoFinderResult + + + + + + + + + An extensible options structure controlling archive import. Ensure that +you have entirely zeroed the structure, then set just the desired +options. This is used by ostree_repo_import_archive_to_mtree(). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - No special flags - - - Do not process extended attributes - - - Generate size information. - - - + + Possibly change a pathname while importing an archive. If %NULL is returned, +then @src_path will be used unchanged. Otherwise, return a new pathname which +will be freed via `g_free()`. + +This pathname translation will be performed *before* any processing from an +active `OstreeRepoCommitModifier`. Will be invoked for all directory and file +types, first with outer directories, then their sub-files and directories. + +Note that enabling pathname translation will always override the setting for +`use_ostree_convention`. + - + + Repo - - + + Stat buffer + - - + + Path in the archive + + User data - - + + + c:identifier="OSTREE_REPO_LIST_OBJECTS_LOOSE"> + List only loose (plain file) objects + + + List only packed (compacted into blobs) objects + + + List all objects + + + Only list objects in this repo, not parents - - + + + No flags. + + + c:identifier="OSTREE_REPO_LIST_REFS_EXT_ALIASES"> + Only list aliases. Since: 2017.10 + + + Exclude remote refs. Since: 2017.11 + + + Exclude mirrored refs. Since: 2019.2 - - - + + Flags controlling repository locking. + + + A "read only" lock; multiple readers are allowed. + + + A writable lock at most one writer can be active, and zero readers. + + + + See the documentation of #OstreeRepo for more information about the +possible modes. + + + Files are stored as themselves; checkouts are hardlinks; can only be +written as root + + + Files are compressed, should be owned by non-root. Can be served via +HTTP. Since: 2017.12 + + + Legacy alias for `OSTREE_REPO_MODE_ARCHIVE` + + + Files are stored as themselves, except ownership; can be written by +user. Hardlinks work only in user checkouts. + + + Same as BARE_USER, but all metadata is not stored, so it can +only be used for user checkouts. Does not need xattrs. + + + Same as BARE_USER, but xattrs are stored separately from +file content, with dedicated object types. + + + + + + No special options for pruning + + + Don't actually delete objects + + + Do not traverse individual commit objects, only follow refs +for reachability calculations + + + Only traverse commit objects. (Since 2022.2) + + + + + + - - + + + + + + + + - - - + + + - + + + + + + + + + + No special options for pull + + + Write out refs suitable for mirrors and fetch all refs if none +requested + + + Fetch only the commit metadata + + + Do verify checksums of local (filesystem-accessible) +repositories (defaults on for HTTP) + + + Since 2017.7. Reject writes of content objects with +modes outside of 0775. + + + Don't verify checksums of objects HTTP repositories +(Since: 2017.12) + + + + The remote change operation. + + + Add a remote + + + Like above, but do nothing if the remote exists + + + Delete a remote + + + Delete a remote, do nothing if the remote does not +exist + + + Add or replace a remote (Since: 2019.2) + + + + + + No flags. + + + Exclude remote and mirrored refs. Since: 2019.2 + + + + A list of statistics for each transaction that may be +interesting for reporting purposes. + + + The total number of metadata objects +in the repository after this transaction has completed. + + + + The number of metadata objects that +were written to the repository in this transaction. + + + + The total number of content objects +in the repository after this transaction has completed. + + + + The number of content objects that +were written to the repository in this transaction. + + + + The amount of data added to the repository, +in bytes, counting only content objects. + + + + + + + reserved + + + + reserved + + + + reserved + + + + reserved + + + + + + + No flags + + + Skip GPG verification + + + Skip all other signature verification methods + + + + + + + + + + + Length of a sha256 digest when expressed as raw bytes + + + + + Length of a sha256 digest when expressed as a hexadecimal string + + + + + The name of the default ed25519 signing type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An accessor object for SELinux policy in root located at @path + + + + + Path to a root directory + + + + Cancellable + + + + + + + + An accessor object for SELinux policy in root located at @rootfs_dfd + + + + + Directory fd for rootfs (will not be cloned) + + + + Cancellable + + + + + + Extract the SELinux policy from a commit object via a partial checkout. This is useful +for labeling derived content as separate commits. + +This function is the backend of `ostree_repo_commit_modifier_set_sepolicy_from_commit()`. + + + A new policy + + + + + The repo + + + + ostree ref or checksum + + + + Cancellable + + + + + + Cleanup function for ostree_sepolicy_setfscreatecon(). + - - + + Not used, just in case you didn't infer that from the parameter name + + + + + + + + Checksum of current policy + + + + + - - Return information on the current directory. This function may -only be called if %OSTREE_REPO_COMMIT_ITER_RESULT_DIR was returned -from ostree_repo_commit_traverse_iter_next(). + + Store in @out_label the security context for the given @relpath and +mode @unix_mode. If the policy does not specify a label, %NULL +will be returned. + - + - - An iter - + + Self + - - Name of current dir - + + Path + - - Checksum of current content - + + Unix mode + - - Checksum of current metadata + transfer-ownership="full" + nullable="1"> + Return location for security context + + Cancellable + + - - Return information on the current file. This function may only be -called if %OSTREE_REPO_COMMIT_ITER_RESULT_FILE was returned from -ostree_repo_commit_traverse_iter_next(). - - + + + + Type of current policy + - - An iter - + + - - Name of current file - - - - Checksum of current file - - - + This API should be considered deprecated, because it's supported for +policy objects to be created from file-descriptor relative paths, which +may not be globally accessible. + + + Path to rootfs + + + + + A SePolicy object + + + + + - Initialize (in place) an iterator over the root of a commit object. + Reset the security context of @target based on the SELinux policy. + - - An iter - + + Self + - - A repo - + + Path string to use for policy lookup + - - Variant of type %OSTREE_OBJECT_TYPE_COMMIT - + + File attributes + + + + Physical path to target file + - Flags - + Flags controlling behavior + + + + New label, or %NULL if unchanged + + + + Cancellable + - - Initialize (in place) an iterator over a directory tree. + - - An iter - + + Policy + - - A repo - - - - Variant of type %OSTREE_OBJECT_TYPE_DIR_TREE - + + Use this path to determine a label + - - Flags - + + Used along with @path + - - Step the interator to the next item. Files will be returned first, -then subdirectories. Call this in a loop; upon encountering -%OSTREE_REPO_COMMIT_ITER_RESULT_END, there will be no more files or -directories. If %OSTREE_REPO_COMMIT_ITER_RESULT_DIR is returned, -then call ostree_repo_commit_traverse_iter_get_dir() to retrieve -data for that directory. Similarly, if -%OSTREE_REPO_COMMIT_ITER_RESULT_FILE is returned, call -ostree_repo_commit_traverse_iter_get_file(). - -If %OSTREE_REPO_COMMIT_ITER_RESULT_ERROR is returned, it is a -program error to call any further API on @iter except for -ostree_repo_commit_traverse_iter_clear(). - - + + + + + + + + + + + + + + + + + + + + Return an array with newly allocated instances of all available +signing engines; they will not be initialized. + + + an array of signing engines + + + + + + + Create a new instance of a signing engine. + + + New signing engine, or %NULL if the engine is not known + - - An iter - - - - Cancellable - + + the name of desired signature engine + - - + + + Add the public key for verification. Could be called multiple times for +adding all needed keys to be used for verification. + +The @public_key argument depends of the particular engine implementation. + - + @TRUE in case if the key could be added successfully, +@FALSE in case of error (@error will contain the reason). + - - + + an #OstreeSign object + + + + single public key to be added + - - - - - OSTree has support for pairing ostree_repo_checkout_tree_at() using -hardlinks in combination with a later -ostree_repo_write_directory_to_mtree() using a (normally modified) -directory. In order for OSTree to optimally detect just the new -files, use this function and fill in the `devino_to_csum_cache` -member of `OstreeRepoCheckoutAtOptions`, then call -ostree_repo_commit_set_devino_cache(). - - Newly allocated cache - - - - - - + + + Clear all previously preloaded secret and public keys. + + + @TRUE in case if no errors, @FALSE in case of error + - - + + an #OstreeSign object + - - + + + Sign the given @data with pre-loaded secret key. + +Depending of the signing engine used you will need to load +the secret key with #ostree_sign_set_sk. + - + @TRUE if @data has been signed successfully, +@FALSE in case of error (@error will contain the reason). + - - + + an #OstreeSign object + + + the raw data to be signed with pre-loaded secret key + + + + in case of success will contain signature + + + + A #GCancellable + + - - - - An extensible options structure controlling archive creation. Ensure that -you have entirely zeroed the structure, then set just the desired -options. This is used by ostree_repo_export_tree_to_archive(). - - - - - - - - - - - - - - - - - - - - - - - - - - + + + Verify given data against signatures with pre-loaded public keys. + +Depending of the signing engine used you will need to load +the public key(s) with #ostree_sign_set_pk, #ostree_sign_add_pk +or #ostree_sign_load_pk. + + @TRUE if @data has been signed at least with any single valid key, +@FALSE in case of error or no valid keys are available (@error will contain the reason). - + an #OstreeSign object + + + the raw data to check + + + + the signatures to be checked + + + + success message returned by the signing +engine + + - - + + + Return the pointer to the name of currently used/selected signing engine. + - + pointer to the name +@NULL in case of error (unlikely). + - + an #OstreeSign object + - - + + + Load public keys for verification from anywhere. +It is expected that all keys would be added to already pre-loaded keys. + +The @options argument depends of the particular engine implementation. + +For example, @ed25515 engine could use following string-formatted options: +- @filename -- single file to use to load keys from +- @basedir -- directory containing subdirectories + 'trusted.ed25519.d' and 'revoked.ed25519.d' with appropriate + public keys. Used for testing and re-definition of system-wide + directories if defaults are not suitable for any reason. + - Repository - + @TRUE in case if at least one key could be load successfully, +@FALSE in case of error (@error will contain the reason). + - + an #OstreeSign object + + + any options + + - - + + + Return the pointer to the string with format used in (detached) metadata for +current signing engine. + - The root directory for the commit referenced by this file - + pointer to the metadata format, +@NULL in case of error (unlikely). + - + an #OstreeSign object + - - + + + Return the pointer to the name of the key used in (detached) metadata for +current signing engine. + - + pointer to the metadata key name, +@NULL in case of error (unlikely). + - + an #OstreeSign object + - - - - - - - - + + + Set the public key for verification. It is expected what all +previously pre-loaded public keys will be dropped. + +The @public_key argument depends of the particular engine implementation. + - + @TRUE in case if the key could be set successfully, +@FALSE in case of error (@error will contain the reason). + - + an #OstreeSign object + - - - - - - - - + + single public key to be added + - - - - + + + Set the secret key to be used for signing data, commits and summary. + +The @secret_key argument depends of the particular engine implementation. + + + @TRUE in case if the key could be set successfully, +@FALSE in case of error (@error will contain the reason). + - + an #OstreeSign object + + + secret key to be added + + - - + + + Add the public key for verification. Could be called multiple times for +adding all needed keys to be used for verification. + +The @public_key argument depends of the particular engine implementation. + - + @TRUE in case if the key could be added successfully, +@FALSE in case of error (@error will contain the reason). + - + an #OstreeSign object + + + single public key to be added + + - - - + + Clear all previously preloaded secret and public keys. + + + @TRUE in case if no errors, @FALSE in case of error + - + an #OstreeSign object + - + + Add a signature to a commit. + +Depending of the signing engine used you will need to load +the secret key with #ostree_sign_set_sk. + - + @TRUE if commit has been signed successfully, +@FALSE in case of error (@error will contain the reason). + - + an #OstreeSign object + + + an #OsreeRepo object + + + + SHA256 of given commit to sign + + + + A #GCancellable + + - + Verify if commit is signed with known key. + +Depending of the signing engine used you will need to load +the public key(s) for verification with #ostree_sign_set_pk, +#ostree_sign_add_pk and/or #ostree_sign_load_pk. + + @TRUE if commit has been verified successfully, +@FALSE in case of error or no valid keys are available (@error will contain the reason). - + an #OstreeSign object + - - + + an #OsreeRepo object + - - + + SHA256 of given commit to verify + - - + + success message returned by the signing +engine + + + + A #GCancellable + + + + + + Sign the given @data with pre-loaded secret key. + +Depending of the signing engine used you will need to load +the secret key with #ostree_sign_set_sk. + + + @TRUE if @data has been signed successfully, +@FALSE in case of error (@error will contain the reason). + + + + + an #OstreeSign object + + + + the raw data to be signed with pre-loaded secret key + - - + + in case of success will contain signature + + A #GCancellable - + + Verify given data against signatures with pre-loaded public keys. + +Depending of the signing engine used you will need to load +the public key(s) with #ostree_sign_set_pk, #ostree_sign_add_pk +or #ostree_sign_load_pk. + - + @TRUE if @data has been signed at least with any single valid key, +@FALSE in case of error or no valid keys are available (@error will contain the reason). + - + an #OstreeSign object + - - + + the raw data to check + - + + the signatures to be checked - - - - - - - - - - - - - - - - - An extensible options structure controlling archive import. Ensure that -you have entirely zeroed the structure, then set just the desired -options. This is used by ostree_repo_import_archive_to_mtree(). - - - - - - - - - - - - - - - - - - - - - - - - - - - - - List only loose (plain file) objects - - - List only packed (compacted into blobs) objects - - - List all objects - - - Only list objects in this repo, not parents - - - - - No flags. - - - - See the documentation of #OstreeRepo for more information about the -possible modes. - - Files are stored as themselves; checkouts are hardlinks; can only be written as root - - - Files are compressed, should be owned by non-root. Can be served via HTTP - - - Files are stored as themselves, except ownership; can be written by user. Hardlinks work only in user checkouts. - - - - - No special options for pruning - - - Don't actually delete objects - - - Do not traverse individual commit objects, only follow refs - - - - - No special options for pull - - - Write out refs suitable for mirrors - - - Fetch only the commit metadata - - - Don't trust local remote - - - - The remote change operation. - - - - - - - - - - - - No flags. - - - - A list of statistics for each transaction that may be -interesting for reporting purposes. - - The total number of metadata objects -in the repository after this transaction has completed. - - - - The number of metadata objects that -were written to the repository in this transaction. - - - - The total number of content objects -in the repository after this transaction has completed. - - - - The number of content objects that -were written to the repository in this transaction. - - - - The amount of data added to the repository, -in bytes, counting only content objects. - - - - reserved - - - - reserved - - - - reserved - - - - reserved - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Length of a sha256 digest when expressed as raw bytes - - - - Length of a sha256 digest when expressed as a hexadecimal string - - - - - - - - - - - - - An accessor object for SELinux policy in root located at @path - - - - - Path to a root directory - - - - + success message returned by the signing +engine + - - - Cleanup function for ostree_sepolicy_setfscreatecon(). + + + - + - - + + + + + - - + + + - Checksum of current policy - + - + - - Store in @out_label the security context for the given @relpath and -mode @unix_mode. If the policy does not specify a label, %NULL -will be returned. + - Self - + - - Path - - - - Unix mode - + + - - Return location for security context - + + - Cancellable - + + - Type of current policy - + - + + + + + + + + + + - + + - Path to rootfs - + - + - - Reset the security context of @target based on the SELinux policy. + - Self - + - - Path string to use for policy lookup - + + - - File attributes - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - Physical path to target file - + + + + + + + + + + + + + - - Flags controlling behavior - + + + + Return the pointer to the name of currently used/selected signing engine. + + + pointer to the name +@NULL in case of error (unlikely). + + + + + an #OstreeSign object + + + + + + Load public keys for verification from anywhere. +It is expected that all keys would be added to already pre-loaded keys. + +The @options argument depends of the particular engine implementation. + +For example, @ed25515 engine could use following string-formatted options: +- @filename -- single file to use to load keys from +- @basedir -- directory containing subdirectories + 'trusted.ed25519.d' and 'revoked.ed25519.d' with appropriate + public keys. Used for testing and re-definition of system-wide + directories if defaults are not suitable for any reason. + + + @TRUE in case if at least one key could be load successfully, +@FALSE in case of error (@error will contain the reason). + + + + + an #OstreeSign object + + + + any options + - - New label, or %NULL if unchanged - + + + + Return the pointer to the string with format used in (detached) metadata for +current signing engine. + + + pointer to the metadata format, +@NULL in case of error (unlikely). + + + + + an #OstreeSign object + + + + + + Return the pointer to the name of the key used in (detached) metadata for +current signing engine. + + + pointer to the metadata key name, +@NULL in case of error (unlikely). + + + + + an #OstreeSign object + + + + + + Set the public key for verification. It is expected what all +previously pre-loaded public keys will be dropped. + +The @public_key argument depends of the particular engine implementation. + + + @TRUE in case if the key could be set successfully, +@FALSE in case of error (@error will contain the reason). + + + + + an #OstreeSign object + + + + single public key to be added + - - Cancellable - + + + + Set the secret key to be used for signing data, commits and summary. + +The @secret_key argument depends of the particular engine implementation. + + + @TRUE in case if the key could be set successfully, +@FALSE in case of error (@error will contain the reason). + + + + + an #OstreeSign object + + + + secret key to be added + - + Add a signature to a summary file. +Based on ostree_repo_add_gpg_signature_summary implementation. + + @TRUE if summary file has been signed with all provided keys - Policy - + Self + - - Use this path to determine a label - + + ostree repository + - - Used along with @path - + + keys -- GVariant containing keys as GVarints specific to signature type. + + + + A #GCancellable + - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + pointer to the name +@NULL in case of error (unlikely). + + + + + an #OstreeSign object + + + + + + + + + + @TRUE if @data has been signed successfully, +@FALSE in case of error (@error will contain the reason). + + + + + an #OstreeSign object + + + + the raw data to be signed with pre-loaded secret key + + + + in case of success will contain signature + + + + A #GCancellable + + + + + + + + + + @TRUE if @data has been signed at least with any single valid key, +@FALSE in case of error or no valid keys are available (@error will contain the reason). + + + + + an #OstreeSign object + + + + the raw data to check + + + + the signatures to be checked + + + + success message returned by the signing +engine + + + + + + + + + + pointer to the metadata key name, +@NULL in case of error (unlikely). + + + + + an #OstreeSign object + + + + + + + + + + pointer to the metadata format, +@NULL in case of error (unlikely). + + + + + an #OstreeSign object + + + + + + + + + + @TRUE in case if no errors, @FALSE in case of error + + + + + an #OstreeSign object + + + + + + + + + + @TRUE in case if the key could be set successfully, +@FALSE in case of error (@error will contain the reason). + + + + + an #OstreeSign object + + + + secret key to be added + + + + + + + + + + @TRUE in case if the key could be set successfully, +@FALSE in case of error (@error will contain the reason). + + + + + an #OstreeSign object + + + + single public key to be added + + + + + + + + + + @TRUE in case if the key could be added successfully, +@FALSE in case of error (@error will contain the reason). + + + + + an #OstreeSign object + + + + single public key to be added + + + + + + + + + + @TRUE in case if at least one key could be load successfully, +@FALSE in case of error (@error will contain the reason). + + + + + an #OstreeSign object + + + + any options + + + + + + - Parameters controlling optimization of static deltas. + Parameters controlling optimization of static deltas. + - Optimize for speed of delta creation over space + Optimize for speed of delta creation over space - Optimize for delta size (may be very slow) + Optimize for delta size (may be very slow) + + + + Flags controlling static delta index generation. + + + No special flags glib:type-name="OstreeSysroot" glib:get-type="ostree_sysroot_get_type"> + Create a new #OstreeSysroot object for the sysroot at @path. If @path is %NULL, +the current visible root file system is used, equivalent to +ostree_sysroot_new_default(). + - An accessor object for an system root located at @path + An accessor object for an system root located at @path @@ -6468,94 +15999,226 @@ will be returned. transfer-ownership="none" nullable="1" allow-none="1"> - Path to a system root directory, or %NULL + Path to a system root directory, or %NULL to use the + current visible root file system + - An accessor for the current visible root / filesystem + An accessor for the current visible root / filesystem + - Path to deployment origin file + Path to deployment origin file - A deployment path + A deployment path + + Given the target deployment (which must be the staged deployment) this API +will toggle its "finalization locking" state. If it is currently locked, +it will be unlocked (and hence queued to apply on shutdown). + + + + + + + Sysroot + + + + Deployment which must be staged + + + + - Delete any state that resulted from a partially completed + Delete any state that resulted from a partially completed transaction, such as incomplete deployments. + - Sysroot + Sysroot + + + + Cancellable + + + + + + Prune the system repository. This is a thin wrapper +around ostree_repo_prune_from_reachable(); the primary +addition is that this function automatically gathers +all deployed commits into the reachable set. + +You generally want to at least set the `OSTREE_REPO_PRUNE_FLAGS_REFS_ONLY` +flag in @options. A commit traversal depth of `0` is assumed. + +Locking: exclusive + + + + + + + Sysroot + + Flags controlling pruning + + + + Number of objects found + + + + Number of objects deleted + + + + Storage size in bytes of objects deleted + + - Cancellable + Cancellable - Check out deployment tree with revision @revision, performing a 3 -way merge with @provided_merge_deployment for configuration. + Older version of ostree_sysroot_stage_tree_with_options(). + - Sysroot + Sysroot - osname to use for merge deployment + osname to use for merge deployment - Checksum to add + Checksum to add - Origin to use for upgrades + Origin to use for upgrades - Use this deployment for merge path + Use this deployment for merge path - Use these as kernel arguments; if %NULL, inherit options from provided_merge_deployment + Use these as +kernel arguments; if %NULL, inherit options from provided_merge_deployment @@ -6564,14 +16227,103 @@ way merge with @provided_merge_deployment for configuration. direction="out" caller-allocates="0" transfer-ownership="full"> - The new deployment path + The new deployment path + + + + Cancellable + + + + + + Check out deployment tree with revision @revision, performing a 3 +way merge with @provided_merge_deployment for configuration. + +When booted into the sysroot, you should use the +ostree_sysroot_stage_tree() API instead. + + + + + + + Sysroot + + + + osname to use for merge deployment + + + + Checksum to add + + + + Origin to use for upgrades + + + + Use this deployment for merge path + + + + Options + + + + The new deployment path - Cancellable + Cancellable @@ -6579,22 +16331,31 @@ way merge with @provided_merge_deployment for configuration. - Entirely replace the kernel arguments of @deployment with the + Entirely replace the kernel arguments of @deployment with the values in @new_kargs. + - Sysroot + Sysroot - A deployment + A deployment - Replace deployment's kernel arguments + Replace deployment's kernel arguments @@ -6603,7 +16364,52 @@ values in @new_kargs. transfer-ownership="none" nullable="1" allow-none="1"> - Cancellable + Cancellable + + + + + + Replace the kernel arguments of @deployment with the values in @kargs_str. + + + + + + + Sysroot + + + + A deployment + + + + Replace @deployment's kernel arguments + + + + Cancellable @@ -6611,56 +16417,118 @@ values in @new_kargs. - By default, deployment directories are not mutable. This function + By default, deployment directories are not mutable. This function will allow making them temporarily mutable, for example to allow layering additional non-OSTree content. + - Sysroot + Sysroot - A deployment + A deployment - Whether or not deployment's files can be changed + Whether or not deployment's files can be changed + Cancellable + + By default, deployments may be subject to garbage collection. Typical uses of +libostree only retain at most 2 deployments. If @is_pinned is `TRUE`, a +metadata bit will be set causing libostree to avoid automatic GC of the +deployment. However, this is really an "advisory" note; it's still possible +for e.g. older versions of libostree unaware of pinning to GC the deployment. + +This function does nothing and returns successfully if the deployment +is already in the desired pinning state. It is an error to try to pin +the staged deployment (as it's not in the bootloader entries). + + + + + + + Sysroot + + + + A deployment + + + + Whether or not deployment will be automatically GC'd + + + + - Configure the target deployment @deployment such that it + Configure the target deployment @deployment such that it is writable. There are multiple modes, essentially differing in whether or not any changes persist across reboot. The `OSTREE_DEPLOYMENT_UNLOCKED_HOTFIX` state is persistent across reboots. + - Sysroot + Sysroot - Deployment + Deployment - Transition to this unlocked state + Transition to this unlocked state @@ -6668,7 +16536,9 @@ across reboots. transfer-ownership="none" nullable="1" allow-none="1"> - Cancellable + Cancellable @@ -6676,40 +16546,56 @@ across reboots. - Ensure that @self is set up as a valid rootfs, by creating + Ensure that @self is set up as a valid rootfs, by creating /ostree/repo, among other things. + - Sysroot + Sysroot - Cancellable + Cancellable - - The currently booted deployment, or %NULL if none + This function may only be called if the sysroot is loaded. + + + The currently booted deployment, or %NULL if none - Sysroot + Sysroot + @@ -6721,100 +16607,145 @@ across reboots. + - Path to deployment root directory + Path to deployment root directory - Sysroot + Sysroot - A deployment + A deployment - Note this function only returns a *relative* path - if you want + Note this function only returns a *relative* path - if you want to access, it, you must either use fd-relative api such as openat(), or concatenate it with the full ostree_sysroot_get_path(). + - Path to deployment root directory, relative to sysroot + Path to deployment root directory, relative to sysroot - Repo + Repo - A deployment + A deployment + - Ordered list of deployments + Ordered list of deployments - Sysroot + Sysroot - Access a file descriptor that refers to the root directory of this -sysroot. ostree_sysroot_load() must have been invoked prior to -calling this function. + Access a file descriptor that refers to the root directory of this sysroot. +ostree_sysroot_initialize() (or ostree_sysroot_load()) must have been invoked +prior to calling this function. + - A file descriptor valid for the lifetime of @self + A file descriptor valid for the lifetime of @self - Sysroot + Sysroot - Find the deployment to use as a configuration merge source; this is + Find the deployment to use as a configuration merge source; this is the first one in the current deployment list which matches osname. - - Configuration merge deployment + + + Configuration merge deployment - Sysroot + Sysroot - Operating system group + Operating system group - + + - Path to rootfs + Path to rootfs + Sysroot @@ -6822,142 +16753,303 @@ the first one in the current deployment list which matches osname. - Retrieve the OSTree repository in sysroot @self. + Retrieve the OSTree repository in sysroot @self. The repo is guaranteed to be open +(see ostree_repo_open()). + + %TRUE on success, %FALSE otherwise - Sysroot + Sysroot - Repository in sysroot @self + transfer-ownership="full" + optional="1" + allow-none="1"> + Repository in sysroot @self - Cancellable + Cancellable + + + + + + + + The currently staged deployment, or %NULL if none + + + + + Sysroot + + + + + + + + + + + + + + + + + Initialize the directory structure for an "osname", which is a +group of operating system deployments, with a shared `/var`. One +is required for generating a deployment. + + + + + + + Sysroot + + + + Name group of operating system checkouts + + + + Cancellable - + + Subset of ostree_sysroot_load(); performs basic initialization. Notably, one +can invoke `ostree_sysroot_get_fd()` after calling this function. + +It is not necessary to call this function if ostree_sysroot_load() is +invoked. + - + + sysroot - - Initialize the directory structure for an "osname", which is a -group of operating system deployments, with a shared `/var`. One -is required for generating a deployment. + Prepare the current process for modifying a booted sysroot, if applicable. +This function subsumes the functionality of `ostree_sysroot_initialize` +and may be invoked wherever that function is. + +If the sysroot does not appear to be booted, or where the current process is not uid 0, +this function returns successfully. + +Otherwise, if the process is in the same mount namespace as pid 1, create +a new namespace. + +If you invoke this function, it must be before ostree_sysroot_load(); it may +be invoked before or after ostree_sysroot_initialize(). + - Sysroot - - Name group of operating system checkouts - - - Cancellable + + Can only be invoked after `ostree_sysroot_initialize()`. + + + %TRUE iff the sysroot points to a booted deployment + + + + + Sysroot + + + + - Load deployment list, bootversion, and subbootversion from the + Load deployment list, bootversion, and subbootversion from the rootfs @self. + - Sysroot + Sysroot - Cancellable + Cancellable + + #OstreeSysroot - + + Cancellable - - Acquire an exclusive multi-process write lock for @self. This call + + Acquire an exclusive multi-process write lock for @self. This call blocks until the lock has been acquired. The lock is not reentrant. Release the lock with ostree_sysroot_unlock(). The lock will also be released if @self is deallocated. + - Self + Self - - An asynchronous version of ostree_sysroot_lock(). + + An asynchronous version of ostree_sysroot_lock(). + - Self + Self - Cancellable + Cancellable allow-none="1" scope="async" closure="2"> - Callback + Callback - User data + User data @@ -6981,33 +17077,48 @@ be released if @self is deallocated. - Call when ostree_sysroot_lock_async() is ready. + Call when ostree_sysroot_lock_async() is ready. + - Self + Self - Result + Result + - A new config file which sets @refspec as an origin + A new config file which sets @refspec as an origin + Sysroot - A refspec + A refspec @@ -7015,29 +17126,166 @@ be released if @self is deallocated. - Like ostree_sysroot_cleanup() in that it cleans up incomplete deployments + Like ostree_sysroot_cleanup() in that it cleans up incomplete deployments and old boot versions, but does NOT prune the repository. + - Sysroot + Sysroot - Cancellable + Cancellable + + Find the pending and rollback deployments for @osname. Pass %NULL for @osname +to use the booted deployment's osname. By default, pending deployment is the +first deployment in the order that matches @osname, and @rollback will be the +next one after the booted deployment, or the deployment after the pending if +we're not looking at the booted deployment. + + + + + + + Sysroot + + + + "stateroot" name + + + + The pending deployment + + + + The rollback deployment + + + + + + This function is a variant of ostree_sysroot_get_repo() that cannot fail, and +returns a cached repository. Can only be called after ostree_sysroot_initialize() +or ostree_sysroot_load() has been invoked successfully. + + + The OSTree repository in sysroot @self. + + + + + Sysroot + + + + + + Find the booted deployment, or return an error if not booted via OSTree. + + + The currently booted deployment, or an error + + + + + Sysroot + + + + + + If this function is invoked, then libostree will assume that +a private Linux mount namespace has been created by the process. +The primary use case for this is to have e.g. /sysroot mounted +read-only by default. + +If this function has been called, then when a function which requires +writable access is invoked, libostree will automatically remount as writable +any mount points on which it operates. This currently is just `/sysroot` and +`/boot`. + +If you invoke this function, it must be before ostree_sysroot_load(); it may +be invoked before or after ostree_sysroot_initialize(). + + + + + + + + + + - Prepend @new_deployment to the list of deployments, commit, and + Prepend @new_deployment to the list of deployments, commit, and cleanup. By default, all other deployments for the given @osname except the merge deployment and the booted deployment will be garbage collected. @@ -7045,37 +17293,59 @@ garbage collected. If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_RETAIN is specified, then all current deployments will be kept. +If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_RETAIN_PENDING is +specified, then pending deployments will be kept. + +If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_RETAIN_ROLLBACK is +specified, then rollback deployments will be kept. + If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_NOT_DEFAULT is specified, then instead of prepending, the new deployment will be -added right after the booted or merge deployment, instead of first. +added right after the booted or merge deployment, instead of first. + +If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_NO_CLEAN is +specified, then no cleanup will be performed after adding the +deployment. Make sure to call ostree_sysroot_cleanup() sometime +later, instead. + - Sysroot + Sysroot - OS name + OS name - Prepend this deployment to the list + Prepend this deployment to the list - Use this deployment for configuration merge + Use this deployment for configuration merge - Flags controlling behavior + Flags controlling behavior @@ -7083,7 +17353,217 @@ added right after the booted or merge deployment, instead of first. transfer-ownership="none" nullable="1" allow-none="1"> - Cancellable + Cancellable + + + + + + Stage an overlay initrd to be used in an upcoming deployment. Returns a checksum which +can be passed to ostree_sysroot_deploy_tree_with_options() or +ostree_sysroot_stage_tree_with_options() via the `overlay_initrds` array option. + + + + + + + Sysroot + + + + File descriptor to overlay initrd + + + + Overlay initrd checksum + + + + Cancellable + + + + + + Older version of ostree_sysroot_stage_tree_with_options(). + + + + + + + Sysroot + + + + osname to use for merge deployment + + + + Checksum to add + + + + Origin to use for upgrades + + + + Use this deployment for merge path + + + + Use these as +kernel arguments; if %NULL, inherit options from provided_merge_deployment + + + + + + The new deployment path + + + + Cancellable + + + + + + Like ostree_sysroot_deploy_tree(), but "finalization" only occurs at OS +shutdown time. + + + + + + + Sysroot + + + + osname to use for merge deployment + + + + Checksum to add + + + + Origin to use for upgrades + + + + Use this deployment for merge path + + + + Options + + + + The new deployment path + + + + Cancellable @@ -7091,85 +17571,188 @@ added right after the booted or merge deployment, instead of first. - Try to acquire an exclusive multi-process write lock for @self. If + Try to acquire an exclusive multi-process write lock for @self. If another process holds the lock, this function will return immediately, setting @out_acquired to %FALSE, and returning %TRUE (and no error). Release the lock with ostree_sysroot_unlock(). The lock will also be released if @self is deallocated. + - Self + Self - Whether or not the lock has been acquired + Whether or not the lock has been acquired - Release any resources such as file descriptors referring to the + Release any resources such as file descriptors referring to the root directory of this sysroot. Normally, those resources are cleared by finalization, but in garbage collected languages that may not be predictable. This undoes the effect of `ostree_sysroot_load()`. + - Sysroot + Sysroot - Clear the lock previously acquired with ostree_sysroot_lock(). It + Clear the lock previously acquired with ostree_sysroot_lock(). It is safe to call this function if the lock has not been previously acquired. + - Self + Self + + + + + + Update a sysroot as needed after having copied it into place using file-level +operations. This enables options like fs-verity on the required files that may +have been lost during the copy. + + + + + + + Sysroot + + + + + + + + + Older version of ostree_sysroot_write_deployments_with_options(). This +version will perform post-deployment cleanup by default. + + + + + + + Sysroot + + List of new deployments + + + + + + Cancellable + + - - Assuming @new_deployments have already been deployed in place on -disk, atomically update bootloader configuration. + Assuming @new_deployments have already been deployed in place on disk via +ostree_sysroot_deploy_tree(), atomically update bootloader configuration. By +default, no post-transaction cleanup will be performed. You should invoke +ostree_sysroot_cleanup() at some point after the transaction, or specify +`do_postclean` in @opts. Skipping the post-transaction cleanup is useful +if for example you want to control pruning of the repository. + - Sysroot + Sysroot - List of new deployments + List of new deployments + + Options + + - Cancellable + Cancellable @@ -7177,33 +17760,44 @@ disk, atomically update bootloader configuration. - Immediately replace the origin file of the referenced @deployment + Immediately replace the origin file of the referenced @deployment with the contents of @new_origin. If @new_origin is %NULL, this function will write the current origin of @deployment. + - System root + System root - Deployment + Deployment - Origin content + Origin content - Cancellable + Cancellable @@ -7211,12 +17805,62 @@ this function will write the current origin of @deployment. + transfer-ownership="none" + getter="get_path"> + + libostree will log to the journal various events, such as the /etc merge +status, and transaction completion. Connect to this signal to also +synchronously receive the text for those messages. This is intended to be +used by command line tools which link to libostree as a library. + +Currently, the structured data is only available via the systemd journal. + + + + + + Human-readable string (should not contain newlines) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -7233,6 +17877,14 @@ this function will write the current origin of @deployment. value="4" c:identifier="OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_NO_CLEAN"> + + + + + - An upgrader + An upgrader - An #OstreeSysroot + An #OstreeSysroot + Cancellable @@ -7264,26 +17924,36 @@ this function will write the current origin of @deployment. + - An upgrader + An upgrader - An #OstreeSysroot + An #OstreeSysroot - Operating system name + Operating system name + Cancellable @@ -7291,24 +17961,33 @@ this function will write the current origin of @deployment. + - An upgrader + An upgrader - An #OstreeSysroot + An #OstreeSysroot - Operating system name + Operating system name - Flags + Flags @@ -7316,6 +17995,9 @@ this function will write the current origin of @deployment. transfer-ownership="none" nullable="1" allow-none="1"> + Cancellable @@ -7323,23 +18005,32 @@ this function will write the current origin of @deployment. - Check that the timestamp on @to_rev is equal to or newer than + Check that the timestamp on @to_rev is equal to or newer than @from_rev. This protects systems against man-in-the-middle attackers which provide a client with an older commit. + - Repo + Repo - From revision + From revision - To revision + To revision @@ -7347,60 +18038,83 @@ attackers which provide a client with an older commit. - Write the new deployment to disk, perform a configuration merge + Write the new deployment to disk, perform a configuration merge with /etc, and update the bootloader configuration. + - Self + Self - Cancellable + Cancellable - - A copy of the origin file, or %NULL if unknown + + + A copy of the origin file, or %NULL if unknown. - Sysroot + Sysroot - - The origin file, or %NULL if unknown + + + The origin file, or %NULL if unknown. - Sysroot + Sysroot - - A one-line descriptive summary of the origin, or %NULL if unknown + + + A one-line descriptive summary of the origin, or %NULL if +unknown. - Upgrader + Upgrader @@ -7408,26 +18122,35 @@ with /etc, and update the bootloader configuration. - Perform a pull from the origin. First check if the ref has + Perform a pull from the origin. First check if the ref has changed, if so download the linked objects, and store the updated ref locally. Then @out_changed will be %TRUE. If the origin remote is unchanged, @out_changed will be set to %FALSE. + - Upgrader + Upgrader - Flags controlling pull behavior + Flags controlling pull behavior - Flags controlling upgrader behavior + Flags controlling upgrader behavior @@ -7435,21 +18158,27 @@ If the origin remote is unchanged, @out_changed will be set to transfer-ownership="none" nullable="1" allow-none="1"> - Progress + Progress - Whether or not the origin changed + Whether or not the origin changed - Cancellable + Cancellable @@ -7457,36 +18186,66 @@ If the origin remote is unchanged, @out_changed will be set to - Like ostree_sysroot_upgrader_pull(), but allows retrieving just a + Like ostree_sysroot_upgrader_pull(), but allows retrieving just a subpath of the tree. This can be used to download metadata files from inside the tree such as package databases. + + Upgrader + Subdirectory path (should include a leading /) + Flags controlling pull behavior + Flags controlling upgrader behavior - + + Progress - + + Whether or not the origin changed + Cancellable @@ -7494,27 +18253,36 @@ from inside the tree such as package databases. - Replace the origin with @origin. + Replace the origin with @origin. + - Sysroot + Sysroot - The new origin + The new origin - Cancellable + Cancellable @@ -7522,13 +18290,15 @@ from inside the tree such as package databases. + transfer-ownership="none" + default-value="0"> + transfer-ownership="none" + default-value="NULL"> glib:type-name="OstreeSysrootUpgraderFlags" glib:get-type="ostree_sysroot_upgrader_flags_get_type" c:type="OstreeSysrootUpgraderFlags"> - Flags controlling operation of an #OstreeSysrootUpgrader. + Flags controlling operation of an #OstreeSysrootUpgrader. - Do not error if the origin has an unconfigured-state key + glib:nick="ignore-unconfigured" + glib:name="OSTREE_SYSROOT_UPGRADER_FLAGS_IGNORE_UNCONFIGURED"> + Do not error if the origin has an +unconfigured-state key + + + Enable "staging" (finalization at shutdown); recommended + (Since: 2021.4) + @@ -7560,35 +18347,200 @@ from inside the tree such as package databases. value="1" c:identifier="OSTREE_SYSROOT_UPGRADER_PULL_FLAGS_ALLOW_OLDER"> + + + + + + + + + + + + + + + + + + + + + + + + + + - The mtime used for stored files. This was originally 0, changed to 1 for + The mtime used for stored files. This was originally 0, changed to 1 for a few releases, then was reverted due to regressions it introduced from users who had been using zero before. + + - - - - - + + ostree version. + + + + + ostree version, encoded as a string, useful for printing and +concatenation. + + + + + ostree year version component (e.g. 2017 if %OSTREE_VERSION is 2017.2) + + + #OstreeBloom is an implementation of a bloom filter which supports writing to +and loading from a #GBytes bit array. The caller must store metadata about +the bloom filter (its hash function and `k` parameter value) separately, as +the same values must be used when reading from a serialised bit array as were +used to build the array in the first place. + +This is a standard implementation of a bloom filter, and background reading +on the theory can be +[found on Wikipedia](https://en.wikipedia.org/wiki/Bloom_filter). In +particular, a bloom filter is parameterised by `m` and `k` parameters: the +size of the bit array (in bits) is `m`, and the number of hash functions +applied to each element is `k`. Bloom filters require a universal hash +function which can be parameterised by `k`. We have #OstreeBloomHashFunc, +with ostree_str_bloom_hash() being an implementation for strings. + +The serialised output from a bloom filter is guaranteed to be stable across +versions of libostree as long as the same values for `k` and the hash +function are used. + +#OstreeBloom is mutable when constructed with ostree_bloom_new(), and elements +can be added to it using ostree_bloom_add_element(), until ostree_bloom_seal() +is called to serialise it and make it immutable. After then, the bloom filter +can only be queried using ostree_bloom_maybe_contains(). + +If constructed with ostree_bloom_new_from_bytes(), the bloom filter is +immutable from construction, and can only be queried. + +Reference: + - https://en.wikipedia.org/wiki/Bloom_filter + - https://llimllib.github.io/bloomfilter-tutorial/ + + + In many cases using libostree, a program may need to "break" +hardlinks by performing a copy. For example, in order to +logically append to a file. + +This function performs full copying, including e.g. extended +attributes and permissions of both regular files and symbolic links. + +If the file is not hardlinked, this function does nothing and +returns successfully. + +This function does not perform synchronization via `fsync()` or +`fdatasync()`; the idea is this will commonly be done as part +of an `ostree_repo_commit_transaction()`, which itself takes +care of synchronization. + + + + + + + Directory fd + + + + Path relative to @dfd + + + + Do not copy extended attributes + + + + + + + + + + + %TRUE if current libostree has at least the requested version, %FALSE otherwise + + + + + Major/year required + + + + Release version required + + + + + c:identifier="ostree_checksum_b64_from_bytes" + version="2016.8"> + - Modified base64 encoding of @csum + Modified base64 encoding of @csum The "modified" term refers to the fact that instead of '/', the '_' character is used. @@ -7596,8 +18548,10 @@ character is used. - An binary checksum of length 32 - + An binary checksum of length 32 + @@ -7606,21 +18560,28 @@ character is used. - Overwrite the contents of @buf with modified base64 encoding of @csum. + Overwrite the contents of @buf with modified base64 encoding of @csum. The "modified" term refers to the fact that instead of '/', the '_' character is used. + - An binary checksum of length 32 - + An binary checksum of length 32 + - Output location, must be at least 44 bytes in length + Output location, must be at least 44 bytes in length @@ -7628,49 +18589,68 @@ character is used. - Overwrite the contents of @buf with stringified version of @csum. + Overwrite the contents of @buf with stringified version of @csum. + - An binary checksum of length 32 - + An binary checksum of length 32 + - Output location, must be at least 45 bytes in length + Output location, must be at least 45 bytes in length + c:identifier="ostree_checksum_b64_to_bytes" + version="2016.8"> + - Binary version of @checksum. + Binary version of @checksum. - An ASCII checksum + An ASCII checksum + - Binary checksum data in @bytes; do not free. If @bytes does not have the correct length, return %NULL. - + Binary checksum data in +@bytes; do not free. If @bytes does not have the correct length, return %NULL. + - #GVariant of type ay + #GVariant of type ay @@ -7678,16 +18658,23 @@ character is used. - Like ostree_checksum_bytes_peek(), but also throws @error. + Like ostree_checksum_bytes_peek(), but also throws @error. + - Binary checksum data - + Binary checksum data + - #GVariant of type ay + #GVariant of type ay @@ -7695,24 +18682,33 @@ character is used. - Compute the OSTree checksum for a given file. + Compute the OSTree checksum for a given file. + - File path + File path - Object type + Object type - Return location for binary checksum + Return location for binary checksum @@ -7721,36 +18717,49 @@ character is used. transfer-ownership="none" nullable="1" allow-none="1"> - Cancellable + Cancellable - Asynchronously compute the OSTree checksum for a given file; + Asynchronously compute the OSTree checksum for a given file; complete with ostree_checksum_file_async_finish(). + - File path + File path - Object type + Object type - Priority for operation, see %G_IO_PRIORITY_DEFAULT + Priority for operation, see %G_IO_PRIORITY_DEFAULT - Cancellable + Cancellable allow-none="1" scope="async" closure="5"> - Invoked when operation is complete + Invoked when operation is complete - Data for @callback + Data for @callback @@ -7774,66 +18787,148 @@ complete with ostree_checksum_file_async_finish(). - Finish computing the OSTree checksum for a given file; see + Finish computing the OSTree checksum for a given file; see ostree_checksum_file_async(). + - File path + File path - Async result + Async result - Return location for binary checksum + Return location for binary checksum + + Compute the OSTree checksum for a given file. This is an fd-relative version +of ostree_checksum_file() which also takes flags and fills in a caller +allocated buffer. + + + + + + + Directory file descriptor + + + + Subpath +@stbuf (allow-none): Optional stat buffer + + + + + + + Object type + + + + Flags +@out_checksum (out) (transfer full): Return location for hex checksum + + + + + + + Cancellable + + + + - Compute the OSTree checksum for a given input. + Compute the OSTree checksum for a given input. + - File information + File information - Optional extended attributes + Optional extended attributes - File content, should be %NULL for symbolic links + File content, should be %NULL for symbolic links - Object type + Object type - Return location for binary checksum + Return location for binary checksum @@ -7842,21 +18937,28 @@ ostree_checksum_file_async(). transfer-ownership="none" nullable="1" allow-none="1"> - Cancellable + Cancellable + - String form of @csum + String form of @csum - An binary checksum of length 32 - + An binary checksum of length 32 + @@ -7864,13 +18966,18 @@ ostree_checksum_file_async(). + - String form of @csum_bytes + String form of @csum_bytes - #GVariant of type ay + #GVariant of type ay @@ -7878,161 +18985,372 @@ ostree_checksum_file_async(). - Overwrite the contents of @buf with stringified version of @csum. + Overwrite the contents of @buf with stringified version of @csum. + - An binary checksum of length 32 - + An binary checksum of length 32 + - Output location, must be at least OSTREE_SHA256_STRING_LEN+1 bytes in length + Output location, must be at least OSTREE_SHA256_STRING_LEN+1 bytes in length - Convert @checksum from a string to binary in-place, without + Convert @checksum from a string to binary in-place, without allocating memory. Use this function in hot code paths. + - a SHA256 string + a SHA256 string - Output buffer with at least 32 bytes of space + Output buffer with at least 32 bytes of space + - Binary checksum from @checksum of length 32; free with g_free(). + Binary checksum from @checksum of length 32; +free with g_free(). - An ASCII checksum + An ASCII checksum + - New #GVariant of type ay with length 32 + New #GVariant of type ay with length 32 - An ASCII checksum + An ASCII checksum - - - - - - Compare two binary checksums, using memcmp(). + Compare two binary checksums, using memcmp(). + - A binary checksum + A binary checksum - A binary checksum + A binary checksum - + + Copy an array of #OstreeCollectionRefs, including deep copies of all its +elements. @refs must be %NULL-terminated; it may be empty, but must not be +%NULL. + - Checksum of the parent commit of @commit_variant, or %NULL + a newly allocated copy of @refs + + + + + + + %NULL-terminated array of #OstreeCollectionRefs + + + + + + + + Free the given array of @refs, including freeing all its elements. @refs +must be %NULL-terminated; it may be empty, but must not be %NULL. + + + + + + + an array of #OstreeCollectionRefs + + + + + + + + There are use cases where one wants a checksum just of the content of a +commit. OSTree commits by default capture the current timestamp, and may have +additional metadata, which means that re-committing identical content +often results in a new checksum. + +By comparing checksums of content, it's possible to easily distinguish +cases where nothing actually changed. + +The content checksums is simply defined as `SHA256(root dirtree_checksum || +root_dirmeta_checksum)`, i.e. the SHA-256 of the root "dirtree" object's checksum concatenated +with the root "dirmeta" checksum (both in binary form, not hexadecimal). + + + A SHA-256 hex string, or %NULL if @commit_variant is not well-formed + + + + + A commit object + + + + + + Reads a commit's "ostree.sizes" metadata and returns an array of +#OstreeCommitSizesEntry in @out_sizes_entries. Each element +represents an object in the commit. If the commit does not contain +the "ostree.sizes" metadata, a %G_IO_ERROR_NOT_FOUND error will be +returned. + + + + + + + variant of type %OSTREE_OBJECT_TYPE_COMMIT + + + + + return location for an array of object size entries + + + + + + + + + + Checksum of the parent commit of @commit_variant, or %NULL if none - Variant of type %OSTREE_OBJECT_TYPE_COMMIT + Variant of type %OSTREE_OBJECT_TYPE_COMMIT + c:identifier="ostree_commit_get_timestamp" + version="2016.3"> + + timestamp in seconds since the Unix epoch, UTC + Commit object + + Update provided @dict with standard metadata for bootable OSTree commits. + + + + + + + Root filesystem to be committed + + + + Dictionary to update + + + + + + + - A thin wrapper for ostree_content_stream_parse(); this function + A thin wrapper for ostree_content_stream_parse(); this function converts an object content stream back into components. + - Whether or not the stream is zlib-compressed + Whether or not the stream is zlib-compressed - Path to file containing content + Path to file containing content - If %TRUE, assume the content has been validated + If %TRUE, assume the content has been validated - The raw file content stream + The raw file content stream - Normal metadata + Normal metadata - Extended attributes + Extended attributes - Cancellable + Cancellable @@ -8040,54 +19358,73 @@ converts an object content stream back into components. - A thin wrapper for ostree_content_stream_parse(); this function + A thin wrapper for ostree_content_stream_parse(); this function converts an object content stream back into components. + - Whether or not the stream is zlib-compressed + Whether or not the stream is zlib-compressed - Directory file descriptor + Directory file descriptor - Subpath + Subpath - If %TRUE, assume the content has been validated + If %TRUE, assume the content has been validated - The raw file content stream + The raw file content stream - Normal metadata + Normal metadata - Extended attributes + Extended attributes - Cancellable + Cancellable @@ -8095,160 +19432,375 @@ converts an object content stream back into components. - The reverse of ostree_raw_file_to_content_stream(); this function + The reverse of ostree_raw_file_to_content_stream(); this function converts an object content stream back into components. + - Whether or not the stream is zlib-compressed + Whether or not the stream is zlib-compressed - Object content stream + Object content stream - Length of stream + Length of stream - If %TRUE, assume the content has been validated + If %TRUE, assume the content has been validated - The raw file content stream + The raw file content stream - Normal metadata + Normal metadata - - Extended attributes - + + Extended attributes + + + + Cancellable + + + + + + + + A new #GVariant containing %OSTREE_OBJECT_TYPE_DIR_META + + + + + a #GFileInfo containing directory information + + + + Optional extended attributes + + + + + + Compute the difference between directory @a and @b as 3 separate +sets of #OstreeDiffItem in @modified, @removed, and @added. + + + + + + + Flags + + + + First directory path, or %NULL + + + + First directory path + + + + Modified files + + + + + + Removed files + + + + + + Added files + + + - Cancellable + Cancellable - - - A new #GVariant containing %OSTREE_OBJECT_TYPE_DIR_META - - - - - a #GFileInfo containing directory information - - - - Optional extended attributes - - - - - - Compute the difference between directory @a and @b as 3 separate + + Compute the difference between directory @a and @b as 3 separate sets of #OstreeDiffItem in @modified, @removed, and @added. + - Flags + Flags - First directory path, or %NULL + First directory path, or %NULL - First directory path + First directory path - Modified files + Modified files - Removed files + Removed files - Added files + Added files + + Options + + - Cancellable + Cancellable - Print the contents of a diff to stdout. + Print the contents of a diff to stdout. + - First directory path + First directory path - First directory path + First directory path - Modified files + Modified files - Removed files + Removed files - Added files + Added files + + Retrieve all extended attributes in a canonical (sorted) order from +the given file descriptor. + + + A GVariant of type `a(ayay)` + + + + + File descriptor + + + + Cancellable + + + + + + Retrieve all extended attributes in a canonical (sorted) order from +the given path, relative to the provided directory file descriptor. +The target path will not be dereferenced. Currently on Linux, this +API must be used currently to retrieve extended attributes +for symbolic links because while `O_PATH` exists, it cannot be used +with `fgetxattr()`. + + + A GVariant of type `a(ayay)` + + + + + Directory file descriptor + + + + Filesystem path + + + + Cancellable + + + + + + + + + - Use this function with #GHashTable and ostree_object_name_serialize(). + Use this function with #GHashTable and ostree_object_name_serialize(). + @@ -8257,13 +19809,80 @@ sets of #OstreeDiffItem in @modified, @removed, and @added. transfer-ownership="none" nullable="1" allow-none="1"> - A #GVariant containing a serialized object + A #GVariant containing a serialized object + + Frees the OstreeKernelArgs structure pointed by *loc + + + + + + + Address of an OstreeKernelArgs pointer + + + + + + Initializes a new OstreeKernelArgs then parses and appends @options +to the empty OstreeKernelArgs + + + newly allocated #OstreeKernelArgs with @options appended + + + + + a string representing command line arguments + + + + + + Initializes a new OstreeKernelArgs structure and returns it + + + A newly created #OstreeKernelArgs for kernel arguments + + + + @@ -8275,141 +19894,453 @@ sets of #OstreeDiffItem in @modified, @removed, and @added. - Reverse ostree_object_to_string(). + Reverse ostree_object_to_string(). + - An ASCII checksum + An ASCII checksum - Parsed checksum + Parsed checksum - Parsed object type + Parsed object type - Reverse ostree_object_name_serialize(). Note that @out_checksum is + Reverse ostree_object_name_serialize(). Note that @out_checksum is only valid for the lifetime of @variant, and must not be freed. + - A #GVariant of type (su) + A #GVariant of type (su) - Pointer into string memory of @variant with checksum + Pointer into string memory of @variant with checksum - Return object type + Return object type + - A new floating #GVariant containing checksum string and objtype + A new floating #GVariant containing checksum string and objtype - An ASCII checksum + An ASCII checksum - An object type + An object type + - A string containing both @checksum and a stringifed version of @objtype + A string containing both @checksum and a stringifed version of @objtype - An ASCII checksum + An ASCII checksum - Object type + Object type - The reverse of ostree_object_type_to_string(). + The reverse of ostree_object_type_to_string(). + - A stringified version of #OstreeObjectType + A stringified version of #OstreeObjectType - Serialize @objtype to a string; this is used for file extensions. + Serialize @objtype to a string; this is used for file extensions. + - an #OstreeObjectType + an #OstreeObjectType + + For many asynchronous operations, it's desirable for callers to be +able to watch their status as they progress. For example, an user +interface calling an asynchronous download operation will want to +be able to see the total number of bytes downloaded. + +This class provides a mechanism for callees of asynchronous +operations to communicate back with callers. It transparently +handles thread safety, ensuring that the progress change +notification occurs in the thread-default context of the calling +operation. + +The ostree_async_progress_get_status() and ostree_async_progress_set_status() +methods get and set a well-known `status` key of type %G_VARIANT_TYPE_STRING. +This key may be accessed using the other #OstreeAsyncProgress methods, but it +must always have the correct type. + + + These functions implement repository-independent algorithms for +operating on the core OSTree data formats, such as converting +#GFileInfo into a #GVariant. + +There are 4 types of objects; file, dirmeta, tree, and commit. The +last 3 are metadata, and the file object is the only content object +type. + +All metadata objects are stored as #GVariant (big endian). The +rationale for this is the same as that of the ext{2,3,4} family of +filesystems; most developers will be using LE, and so it's better +to continually test the BE->LE swap. + +The file object is a custom format in order to support streaming. + + + #OstreeGpgVerifyResult contains verification details for GPG signatures +read from a detached #OstreeRepo metadata object. + +Use ostree_gpg_verify_result_count_all() and +ostree_gpg_verify_result_count_valid() to quickly check overall signature +validity. + +Use ostree_gpg_verify_result_lookup() to find a signature by the key ID +or fingerprint of the signing key. + +For more in-depth inspection, such as presenting signature details to the +user, pass an array of attribute values to ostree_gpg_verify_result_get() +or get all signature details with ostree_gpg_verify_result_get_all(). + + + An implementation of #GConverter that compresses data using +LZMA. + + + An implementation of #GConverter that decompresses data using +LZMA. + + + In order to commit content into an #OstreeRepo, it must first be +imported into an #OstreeMutableTree. There are several high level +APIs to create an initiable #OstreeMutableTree from a physical +filesystem directory, but they may also be computed +programmatically. + + + The #OstreeRepo is like git, a content-addressed object store. +Unlike git, it records uid, gid, and extended attributes. + +There are four possible "modes" for an #OstreeRepo; %OSTREE_REPO_MODE_BARE +is very simple - content files are represented exactly as they are, and +checkouts are just hardlinks. %OSTREE_REPO_MODE_BARE_USER is similar, except +the uid/gids are not set on the files, and checkouts as hardlinks work only +for user checkouts. %OSTREE_REPO_MODE_BARE_USER_ONLY is the same as +BARE_USER, but all metadata is not stored, so it can only be used for user +checkouts. This mode does not require xattrs. A %OSTREE_REPO_MODE_ARCHIVE +(also known as %OSTREE_REPO_MODE_ARCHIVE_Z2) repository in contrast stores +content files zlib-compressed. It is suitable for non-root-owned +repositories that can be served via a static HTTP server. + +Creating an #OstreeRepo does not invoke any file I/O, and thus needs +to be initialized, either from existing contents or as a new +repository. If you have an existing repo, use ostree_repo_open() +to load it from disk and check its validity. To initialize a new +repository in the given filepath, use ostree_repo_create() instead. + +To store content in the repo, first start a transaction with +ostree_repo_prepare_transaction(). Then create a +#OstreeMutableTree, and apply functions such as +ostree_repo_write_directory_to_mtree() to traverse a physical +filesystem and write content, possibly multiple times. + +Once the #OstreeMutableTree is complete, write all of its metadata +with ostree_repo_write_mtree(), and finally create a commit with +ostree_repo_write_commit(). + +## Collection IDs + +A collection ID is a globally unique identifier which, if set, is used to +identify refs from a repository which are mirrored elsewhere, such as in +mirror repositories or peer to peer networks. + +This is separate from the `collection-id` configuration key for a remote, which +is used to store the collection ID of the repository that remote points to. + +The collection ID should only be set on an #OstreeRepo if it is the canonical +collection for some refs. + +A collection ID must be a reverse DNS name, where the domain name is under the +control of the curator of the collection, so they can demonstrate ownership +of the collection. The later elements in the reverse DNS name can be used to +disambiguate between multiple collections from the same curator. For example, +`org.exampleos.Main` and `org.exampleos.Apps`. For the complete format of +collection IDs, see ostree_validate_collection_id(). + + + #OstreeRepoFinderAvahi is an implementation of #OstreeRepoFinder which looks +for refs being hosted by peers on the local network. + +Any ref which matches by collection ID and ref name is returned as a result, +with no limitations on the peers which host them, as long as they are +accessible over the local network, and their adverts reach this machine via +DNS-SD/mDNS. + +For each repository which is found, a result will be returned for the +intersection of the refs being searched for, and the refs in `refs/mirrors` +in the remote repository. + +DNS-SD resolution is performed using Avahi, which will continue to scan for +matching peers throughout the lifetime of the process. It’s recommended that +ostree_repo_finder_avahi_start() be called early on in the process’ lifetime, +and the #GMainContext which is passed to ostree_repo_finder_avahi_new() +continues to be iterated until ostree_repo_finder_avahi_stop() is called. + +The values stored in DNS-SD TXT records are stored as big-endian whenever +endianness is relevant. + +Internally, #OstreeRepoFinderAvahi has an Avahi client, browser and resolver +which work in the background to track all available peers on the local +network. Whenever a resolve request is made using +ostree_repo_finder_resolve_async(), the request is blocked until the +background tracking is in a consistent state (typically this only happens at +startup), and is then answered using the current cache of background data. +The Avahi client tracks the #OstreeRepoFinderAvahi’s connection with the +Avahi D-Bus service. The browser looks for DNS-SD peers on the local network; +and the resolver is used to retrieve information about services advertised by +each peer, including the services’ TXT records. + + + #OstreeRepoFinderConfig is an implementation of #OstreeRepoFinder which looks +refs up in locally configured remotes and returns remote URIs. +Duplicate remote URIs are combined into a single #OstreeRepoFinderResult +which lists multiple refs. + +For all the locally configured remotes which have an `collection-id` specified +(see [ostree.repo-config(5)](man:ostree.repo-config(5))), it finds the +intersection of their refs and the set of refs to resolve. If the +intersection is non-empty, that remote is returned as a result. Remotes which +do not have their `collection-id` key configured are ignored. + + + #OstreeRepoFinderMount is an implementation of #OstreeRepoFinder which looks +refs up in well-known locations on any mounted removable volumes. + +For each mounted removable volume, the directory `.ostree/repos.d` will be +enumerated, and all OSTree repositories below it will be searched, in lexical +order, for the requested #OstreeCollectionRefs. The names of the directories +below `.ostree/repos.d` are irrelevant, apart from their lexical ordering. +The directories `.ostree/repo`, `ostree/repo` and `var/lib/flatpak/repo` +will be searched after the others, if they exist. +Non-removable volumes are ignored. + +For each repository which is found, a result will be returned for the +intersection of the refs being searched for, and the refs in `refs/heads` and +`refs/mirrors` in the repository on the removable volume. + +Symlinks are followed when listing the repositories, so a volume might +contain a single OSTree at some arbitrary path, with a symlink from +`.ostree/repos.d`. Any symlink which points outside the volume’s file +system will be ignored. Repositories are deduplicated in the results. + +The volume monitor used to find mounted volumes can be overridden by setting +#OstreeRepoFinderMount:monitor. By default, g_volume_monitor_get() is used. + + + #OstreeRepoFinderOverride is an implementation of #OstreeRepoFinder which +looks refs up in a list of remotes given by their URI, and returns the URIs +which contain the refs. Duplicate remote URIs are combined into a single +#OstreeRepoFinderResult which lists multiple refs. + +Each result is given an #OstreeRepoFinderResult.priority value of 20, which +ranks its results above those from the other default #OstreeRepoFinder +implementations. + +Results can only be returned for a ref if a remote and keyring are configured +locally for the collection ID of that ref, otherwise there would be no keys +available to verify signatures on commits for that ref. + +This is intended to be used for user-provided overrides and testing software +which uses #OstreeRepoFinder. For production use, #OstreeRepoFinderConfig is +recommended instead. + + + A #OstreeSePolicy object can load the SELinux policy from a given +root and perform labeling. + + + An #OstreeSign interface allows to select and use any available engine +for signing or verifying the commit object or summary file. + + + A #OstreeSysroot object represents a physical root filesystem, +which in particular should contain a toplevel /ostree directory. +Inside this directory is an #OstreeRepo in /ostree/repo, plus a set +of deployments in /ostree/deploy. + +This class is not by default safe against concurrent use by threads +or external processes. You can use ostree_sysroot_lock() to +perform locking externally. + + + The #OstreeSysrootUpgrader class allows performing simple upgrade +operations. + + + ostree provides macros to check the version of the library +at compile-time + - Split a refspec like "gnome-ostree:gnome-ostree/buildmaster" into -two parts; @out_remote will be set to "gnome-ostree", and @out_ref -will be "gnome-ostree/buildmaster". - -If @refspec refers to a local ref, @out_remote will be %NULL. + Split a refspec like `gnome-ostree:gnome-ostree/buildmain` or just +`gnome-ostree/buildmain` into two parts. In the first case, @out_remote +will be set to `gnome-ostree`, and @out_ref to `gnome-ostree/buildmain`. +In the second case (a local ref), @out_remote will be %NULL, and @out_ref +will be `gnome-ostree/buildmain`. In both cases, %TRUE will be returned. + + %TRUE on successful parsing, %FALSE otherwise - A "refspec" string + A "refspec" string - The remote name, or %NULL if the refspec refs to a local ref + Return location for the remote name, + or %NULL if the refspec refs to a local ref transfer-ownership="full" optional="1" allow-none="1"> - Name of ref + Return location for the ref name - Convert from a "bare" file representation into an + Convert from a "bare" file representation into an OSTREE_OBJECT_TYPE_FILE stream suitable for ostree pull. + + + + + + + File raw content stream + + + + A file info + + + + Optional extended attributes + + + + Serialized object stream + + + + Cancellable + + + + + + Like ostree_raw_file_to_archive_z2_stream(), but supports an extensible set +of flags. The following flags are currently defined: + +- `compression-level` (`i`): Level of compression to use, 0–9, with 0 being + the least compression, and <0 giving the default level (currently 6). + - File raw content stream + File raw content stream - A file info + A file info - Optional extended attributes + Optional extended attributes + + + + A GVariant `a{sv}` with an extensible set of flags - Serialized object stream + Serialized object stream - Cancellable + Cancellable @@ -8466,54 +20479,83 @@ OSTREE_OBJECT_TYPE_FILE stream suitable for ostree pull. - Convert from a "bare" file representation into an + Convert from a "bare" file representation into an OSTREE_OBJECT_TYPE_FILE stream. This is a fundamental operation for writing data to an #OstreeRepo. + - File raw content stream + File raw content stream - A file info + A file info - Optional extended attributes + Optional extended attributes - Serialized object stream + Serialized object stream - Length of stream + Length of stream - Cancellable + Cancellable + + The #OstreeRemote structure represents the configuration for a single remote +repository. Currently, all configuration is handled internally, and +#OstreeRemote objects are represented by their textual name handle, or by an +opaque pointer (which can be reference counted if needed). + +#OstreeRemote provides configuration for accessing a remote, but does not +provide the results of accessing a remote, such as information about what +refs are currently on a remote, or the commits they currently point to. Use +#OstreeRepo in combination with an #OstreeRemote to query that information. + + @@ -8526,17 +20568,241 @@ for writing data to an #OstreeRepo. + + A version of ostree_repo_finder_resolve_async() which queries one or more +@finders in parallel and combines the results. + + + + + + + non-empty array of #OstreeRepoFinders + + + + + + non-empty array of collection–ref pairs to find remotes for + + + + + + the local repository which the refs are being resolved for, + which provides configuration information and GPG keys + + + + a #GCancellable, or %NULL + + + + asynchronous completion callback + + + + data to pass to @callback + + + + + + Get the results from a ostree_repo_finder_resolve_all_async() operation. + + + array of zero + or more results + + + + + + + #GAsyncResult from the callback + + + + + + Free the given @results array, freeing each element and the container. + + + + + + + an #OstreeRepoFinderResult + + + + + + + + Return an array with newly allocated instances of all available +signing engines; they will not be initialized. + + + an array of signing engines + + + + + + + Create a new instance of a signing engine. + + + New signing engine, or %NULL if the engine is not known + + + + + the name of desired signature engine + + + + - Use this function to see if input strings are checksums. + Use this function to see if input strings are checksums. + - %TRUE if @sha256 is a valid checksum string, %FALSE otherwise + %TRUE if @sha256 is a valid checksum string, %FALSE otherwise - SHA256 hex string + SHA256 hex string + + + + + + Check whether the given @collection_id is valid. Return an error if it is +invalid or %NULL. + +Valid collection IDs are reverse DNS names: + * They are composed of 1 or more elements separated by a period (`.`) character. + All elements must contain at least one character. + * Each element must only contain the ASCII characters `[A-Z][a-z][0-9]_` and must not + begin with a digit. + * They must contain at least one `.` (period) character (and thus at least two elements). + * They must not begin with a `.` (period) character. + * They must not exceed 255 characters in length. + +(This makes their format identical to D-Bus interface names, for consistency.) + + + %TRUE if @collection_id is a valid collection ID, %FALSE if it is invalid + or %NULL + + + + + A collection ID + + + + + + + + %TRUE if @remote_name is a valid remote name + + + + + A remote name @@ -8544,13 +20810,18 @@ for writing data to an #OstreeRepo. + - %TRUE if @rev is a valid ref string + %TRUE if @rev is a valid ref string - A revision string + A revision string @@ -8558,13 +20829,18 @@ for writing data to an #OstreeRepo. + - %TRUE if @checksum is a valid ASCII SHA256 checksum + %TRUE if @checksum is a valid ASCII SHA256 checksum - an ASCII string + an ASCII string @@ -8572,15 +20848,22 @@ for writing data to an #OstreeRepo. - Use this to validate the basic structure of @commit, independent of + Use this to validate the basic structure of @commit, independent of any other objects it references. + - %TRUE if @commit is structurally valid + %TRUE if @commit is structurally valid - A commit object, %OSTREE_OBJECT_TYPE_COMMIT + A commit object, %OSTREE_OBJECT_TYPE_COMMIT @@ -8588,13 +20871,18 @@ any other objects it references. + - %TRUE if @checksum is a valid binary SHA256 checksum + %TRUE if @checksum is a valid binary SHA256 checksum - a #GVariant of type "ay" + a #GVariant of type "ay" @@ -8602,14 +20890,21 @@ any other objects it references. - Use this to validate the basic structure of @dirmeta. + Use this to validate the basic structure of @dirmeta. + - %TRUE if @dirmeta is structurally valid + %TRUE if @dirmeta is structurally valid - A dirmeta object, %OSTREE_OBJECT_TYPE_DIR_META + A dirmeta object, %OSTREE_OBJECT_TYPE_DIR_META @@ -8617,15 +20912,22 @@ any other objects it references. - Use this to validate the basic structure of @dirtree, independent of + Use this to validate the basic structure of @dirtree, independent of any other objects it references. + - %TRUE if @dirtree is structurally valid + %TRUE if @dirtree is structurally valid - A dirtree object, %OSTREE_OBJECT_TYPE_DIR_TREE + A dirtree object, %OSTREE_OBJECT_TYPE_DIR_TREE @@ -8633,13 +20935,18 @@ any other objects it references. + - %TRUE if @mode represents a valid file type and permissions + %TRUE if @mode represents a valid file type and permissions - A Unix filesystem mode + A Unix filesystem mode @@ -8647,8 +20954,11 @@ any other objects it references. + - %TRUE if @objtype represents a valid object type + %TRUE if @objtype represents a valid object type diff --git a/girs/PQMarble-2.gir b/girs/PQMarble-2.gir index 10659a0fa..66c2cb4ca 100644 --- a/girs/PQMarble-2.gir +++ b/girs/PQMarble-2.gir @@ -1,5 +1,5 @@ - + diff --git a/girs/PackageKitGlib-1.0.gir b/girs/PackageKitGlib-1.0.gir index 96f813885..fda3eb939 100644 --- a/girs/PackageKitGlib-1.0.gir +++ b/girs/PackageKitGlib-1.0.gir @@ -2449,7 +2449,8 @@ applications. + throws="1" + glib:async-func="get_progress_async"> Get the progress of a transaction. @@ -2490,7 +2491,9 @@ applications. + version="0.5.2" + glib:finish-func="get_progress_finish" + glib:sync-func="get_progress"> Find the current state of a transaction. @@ -6482,7 +6485,8 @@ the socket. + version="0.5.2" + glib:finish-func="can_authorize_finish"> We may want to know before we run a method if we are going to be denied, @@ -6568,7 +6572,8 @@ accepted or challenged for authentication. + version="0.5.2" + glib:finish-func="get_daemon_state_finish"> Gets the debugging state from the daemon. @@ -6648,7 +6653,8 @@ accepted or challenged for authentication. + throws="1" + glib:async-func="get_properties_async"> Gets the properties the daemon supports. @@ -6682,7 +6688,9 @@ applications. + version="0.5.2" + glib:finish-func="get_properties_finish" + glib:sync-func="get_properties"> Gets global properties from the daemon. @@ -6761,7 +6769,8 @@ applications. + version="0.5.2" + glib:finish-func="get_tid_finish"> Gets a transacton ID from the daemon. @@ -6840,7 +6849,8 @@ applications. + version="0.5.2" + glib:finish-func="get_time_since_action_finish"> We may want to know how long it has been since we refreshed the cache or @@ -6927,7 +6937,8 @@ retrieved the update list. + throws="1" + glib:async-func="get_transaction_list_async"> Gets the transaction list in progress. @@ -6963,7 +6974,9 @@ applications. + version="0.5.2" + glib:finish-func="get_transaction_list_finish" + glib:sync-func="get_transaction_list"> Gets the transactions currently running in the daemon. @@ -7045,7 +7058,8 @@ applications. + throws="1" + glib:async-func="set_proxy_async"> Sets the network proxy to use in the daemon. @@ -7250,7 +7264,9 @@ applications. + version="0.5.2" + glib:finish-func="set_proxy_finish" + glib:sync-func="set_proxy"> Set a proxy on the PK daemon @@ -7345,7 +7361,8 @@ Clients should really be using pk_control_set_proxy2_async(). + throws="1" + glib:async-func="suggest_daemon_quit_async"> Suggests to the daemon that it should quit as soon as possible. @@ -7379,7 +7396,9 @@ applications. + version="0.6.2" + glib:finish-func="suggest_daemon_quit_finish" + glib:sync-func="suggest_daemon_quit"> Suggests to the daemon that it should quit as soon as possible. diff --git a/girs/Pango-1.0.gir b/girs/Pango-1.0.gir index a3a7cd483..000d0c863 100644 --- a/girs/Pango-1.0.gir +++ b/girs/Pango-1.0.gir @@ -10497,7 +10497,7 @@ See also [enum@Pango.Gravity] You typically obtain `PangoItems` by itemizing a piece of text with [func@itemize]. - + analysis results for the item. + line="103">analysis results for the item. Creates a new `PangoItem` structure initialized to default values. - + - + @@ -10574,7 +10574,7 @@ the iter to each call. Copy an existing `PangoItem` structure. - + Free a `PangoItem` and all associated memory. - + @@ -10613,6 +10613,34 @@ the iter to each call. + + Returns the character offset of the item from the beginning +of the itemized text. + +If the item has not been obtained from Pango's itemization +machinery, then the character offset is not available. In +that case, this function returns -1. + + + the character offset of the item from the beginning + of the itemized text, or -1 + + + + + a `PangoItem` + + + + - + - + The micro component of the version of Pango available at compile-time. - + The minor component of the version of Pango available at compile-time. @@ -19392,7 +19420,7 @@ Two encoded version numbers can be compared as integers. - + The base direction is used when computing bidirectional levels. [func@itemize] gets the base direction from the `PangoContext` (see [method@Pango.Context.set_base_dir]). - + - + version="1.4"> Creates a `PangoFontDescription` that matches the specified + line="2950">Creates a `PangoFontDescription` that matches the specified Fontconfig pattern as closely as possible. Many possible Fontconfig pattern values, such as %FC_RASTERIZER @@ -450,7 +450,7 @@ so will be ignored. a new `PangoFontDescription`. Free with + line="2964">a new `PangoFontDescription`. Free with pango_font_description_free(). @@ -458,13 +458,13 @@ so will be ignored. a `FcPattern` + line="2952">a `FcPattern` if %TRUE, the pattern will include the size from + line="2953">if %TRUE, the pattern will include the size from the @pattern; otherwise the resulting pattern will be unsized. (only %FC_SIZE is examined, not %FC_PIXEL_SIZE) @@ -476,16 +476,16 @@ so will be ignored. version="1.4"> Gets the glyph index for a given Unicode character + line="635">Gets the glyph index for a given Unicode character for @font. If you only want to determine whether the font has the glyph, use [method@PangoFc.Font.has_char]. - + the glyph index, or 0, if the Unicode + line="646">the glyph index, or 0, if the Unicode character doesn't exist in the font. @@ -493,13 +493,13 @@ the glyph, use [method@PangoFc.Font.has_char]. a `PangoFcFont` + line="637">a `PangoFcFont` Unicode character to look up + line="638">Unicode character to look up @@ -511,18 +511,18 @@ the glyph, use [method@PangoFc.Font.has_char]. deprecated-version="1.50"> Returns the languages that are supported by @font. + line="1079">Returns the languages that are supported by @font. This corresponds to the FC_LANG member of the FcPattern. The returned array is only valid as long as the font and its fontmap are valid. Use pango_font_get_language() - + a + line="1090">a %NULL-terminated array of `PangoLanguage`* @@ -532,7 +532,7 @@ and its fontmap are valid. a `PangoFcFont` + line="1081">a `PangoFcFont` @@ -544,19 +544,19 @@ and its fontmap are valid. introspectable="0"> Returns the FcPattern that @font is based on. - + line="1113">Returns the FcPattern that @font is based on. + the fontconfig pattern for this font + line="1119">the fontconfig pattern for this font a `PangoFcFont` + line="1115">a `PangoFcFont` @@ -566,28 +566,28 @@ and its fontmap are valid. version="1.4"> Returns the index of a glyph suitable for drawing @wc + line="670">Returns the index of a glyph suitable for drawing @wc as an unknown character. Use PANGO_GET_UNKNOWN_GLYPH() instead. - + a glyph index into @font. + line="680">a glyph index into @font. a `PangoFcFont` + line="672">a `PangoFcFont` the Unicode character for which a glyph is needed. + line="673">the Unicode character for which a glyph is needed. @@ -599,26 +599,26 @@ Use PANGO_GET_UNKNOWN_GLYPH() instead. deprecated-version="1.44"> Determines whether @font has a glyph for the codepoint @wc. + line="605">Determines whether @font has a glyph for the codepoint @wc. Use [method@Pango.Font.has_char] - + %TRUE if @font has the requested codepoint. + line="612">%TRUE if @font has the requested codepoint. a `PangoFcFont` + line="607">a `PangoFcFont` Unicode codepoint to look up + line="608">Unicode codepoint to look up @@ -630,11 +630,11 @@ Use PANGO_GET_UNKNOWN_GLYPH() instead. deprecated-version="1.32"> This function used to adjust each adjacent pair of glyphs + line="703">This function used to adjust each adjacent pair of glyphs in @glyphs according to kerning information in @font. Since 1.44, it does nothing. - + @@ -642,13 +642,13 @@ Since 1.44, it does nothing. a `PangoFcFont` + line="705">a `PangoFcFont` a `PangoGlyphString` + line="706">a `PangoGlyphString` @@ -661,23 +661,23 @@ Since 1.44, it does nothing. deprecated-version="1.44"> Gets the FreeType `FT_Face` associated with a font. + line="565">Gets the FreeType `FT_Face` associated with a font. This face will be kept around until you call [method@PangoFc.Font.unlock_face]. Use pango_font_get_hb_font() instead - + the FreeType `FT_Face` associated with @font. + line="574">the FreeType `FT_Face` associated with @font. a `PangoFcFont`. + line="567">a `PangoFcFont`. @@ -689,10 +689,10 @@ This face will be kept around until you call deprecated-version="1.44"> Releases a font previously obtained with + line="587">Releases a font previously obtained with [method@PangoFc.Font.lock_face]. Use pango_font_get_hb_font() instead - + @@ -700,7 +700,7 @@ This face will be kept around until you call a `PangoFcFont`. + line="589">a `PangoFcFont`. @@ -834,7 +834,7 @@ application-specific encodings for various fonts. version="1.4"> Clear all cached information and fontsets for this font map. + line="2459">Clear all cached information and fontsets for this font map. This should be called whenever there is a change in the output of the default_substitute() virtual function of the @@ -848,7 +848,7 @@ configuration. a `PangoFcFontMap` + line="2461">a `PangoFcFontMap` @@ -858,7 +858,7 @@ configuration. version="1.38"> Informs font map that the fontconfig configuration (i.e., FcConfig + line="2502">Informs font map that the fontconfig configuration (i.e., FcConfig object) used by this font map has changed. This currently calls [method@PangoFc.FontMap.cache_clear] which @@ -872,7 +872,7 @@ updated configuration. a `PangoFcFontMap` + line="2504">a `PangoFcFontMap` @@ -884,7 +884,7 @@ updated configuration. deprecated-version="1.22"> Creates a new context for this fontmap. + line="2819">Creates a new context for this fontmap. This function is intended only for backend implementations deriving from `PangoFcFontMap`; it is possible that a backend will store @@ -895,14 +895,14 @@ after calling this function. a new `PangoContext` + line="2830">a new `PangoContext` a `PangoFcFontMap` + line="2821">a `PangoFcFontMap` @@ -945,14 +945,14 @@ Decoders can be added to a font map using introspectable="0"> Fetches the `FcConfig` attached to a font map. + line="2569">Fetches the `FcConfig` attached to a font map. See also: [method@PangoFc.FontMap.set_config]. the `FcConfig` object attached to + line="2577">the `FcConfig` object attached to @fcfontmap, which might be %NULL. The return value is owned by Pango and should not be freed. @@ -961,7 +961,7 @@ See also: [method@PangoFc.FontMap.set_config]. a `PangoFcFontMap` + line="2571">a `PangoFcFontMap` @@ -972,12 +972,12 @@ See also: [method@PangoFc.FontMap.set_config]. introspectable="0"> Retrieves the `hb_face_t` for the given `PangoFcFont`. + line="3665">Retrieves the `hb_face_t` for the given `PangoFcFont`. the `hb_face_t` + line="3672">the `hb_face_t` for the given font @@ -985,13 +985,13 @@ See also: [method@PangoFc.FontMap.set_config]. a `PangoFcFontMap` + line="3667">a `PangoFcFontMap` a `PangoFcFont` + line="3668">a `PangoFcFont` @@ -1002,7 +1002,7 @@ See also: [method@PangoFc.FontMap.set_config]. introspectable="0"> Set the `FcConfig` for this font map to use. + line="2521">Set the `FcConfig` for this font map to use. The default value is %NULL, which causes Fontconfig to use its global "current config". @@ -1026,7 +1026,7 @@ does **not** need to retain a reference. a `PangoFcFontMap` + line="2523">a `PangoFcFontMap` allow-none="1"> a `FcConfig` + line="2524">a `FcConfig` @@ -1094,7 +1094,7 @@ hinting and antialiasing options. version="1.4"> Clears all cached information for the fontmap and marks + line="2855">Clears all cached information for the fontmap and marks all fonts open for the fontmap as dead. See the shutdown() virtual function of `PangoFcFont`. @@ -1111,7 +1111,7 @@ from `PangoFcFontMap`. a `PangoFcFontMap` + line="2857">a `PangoFcFontMap` diff --git a/girs/PangoXft-1.0.gir b/girs/PangoXft-1.0.gir index f27e5c11f..81720320c 100644 --- a/girs/PangoXft-1.0.gir +++ b/girs/PangoXft-1.0.gir @@ -364,6 +364,11 @@ using the renderer. + draw the specified glyphs using + the current foreground color and other foreground + attributes @@ -384,6 +389,10 @@ using the renderer. + draw the specified trapezoids using + the current color and other attributes for @part @@ -497,6 +506,10 @@ The renderer must not be currently active. + draw the specified trapezoids using + the current color and other attributes for @part @@ -519,6 +532,11 @@ The renderer must not be currently active. + draw the specified glyphs using + the current foreground color and other foreground + attributes diff --git a/girs/Pluma-1.0.gir b/girs/Pluma-1.0.gir index 31fa22129..5464eaa7f 100644 --- a/girs/Pluma-1.0.gir +++ b/girs/Pluma-1.0.gir @@ -751,25 +751,25 @@ The list should not be freed Gets the metadata assigned to @key. + line="2889">Gets the metadata assigned to @key. the value assigned to @key. + line="2896">the value assigned to @key. a #PlumaDocument + line="2891">a #PlumaDocument name of the key + line="2892">name of the key @@ -1245,7 +1245,7 @@ to be emitted. introspectable="0"> Sets metadata on a document. + line="2928">Sets metadata on a document. @@ -1254,19 +1254,19 @@ to be emitted. a #PlumaDocument + line="2930">a #PlumaDocument name of the first key to set + line="2931">name of the first key to set value for the first key, followed optionally by more key/value pairs, + line="2932">value for the first key, followed optionally by more key/value pairs, followed by %NULL. @@ -4141,12 +4141,12 @@ drops to 0, @message_type is destroyed. Creates a new #PlumaNotebook object. + line="745">Creates a new #PlumaNotebook object. a new #PlumaNotebook + line="750">a new #PlumaNotebook @@ -4220,7 +4220,7 @@ drops to 0, @message_type is destroyed. Adds the specified @tab to the @nb. + line="951">Adds the specified @tab to the @nb. @@ -4229,25 +4229,25 @@ drops to 0, @message_type is destroyed. a #PlumaNotebook + line="953">a #PlumaNotebook a #PlumaTab + line="954">a #PlumaTab the position where the @tab should be added + line="955">the position where the @tab should be added %TRUE to set the @tab as active + line="956">%TRUE to set the @tab as active @@ -4256,19 +4256,19 @@ drops to 0, @message_type is destroyed. c:identifier="pluma_notebook_get_close_buttons_sensitive"> Whether the close buttons are sensitive. + line="1136">Whether the close buttons are sensitive. %TRUE if the close buttons are sensitive + line="1142">%TRUE if the close buttons are sensitive a #PlumaNotebook + line="1138">a #PlumaNotebook @@ -4277,19 +4277,19 @@ drops to 0, @message_type is destroyed. c:identifier="pluma_notebook_get_tab_drag_and_drop_enabled"> Whether the drag and drop is enabled in the @nb. + line="1173">Whether the drag and drop is enabled in the @nb. %TRUE if the drag and drop is enabled. + line="1179">%TRUE if the drag and drop is enabled. a #PlumaNotebook + line="1175">a #PlumaNotebook @@ -4336,7 +4336,7 @@ end of the tabs. c:identifier="pluma_notebook_remove_all_tabs"> Removes all #PlumaTab from @nb. + line="1080">Removes all #PlumaTab from @nb. @@ -4345,7 +4345,7 @@ end of the tabs. a #PlumaNotebook + line="1082">a #PlumaNotebook @@ -4353,7 +4353,7 @@ end of the tabs. Removes @tab from @nb. + line="1049">Removes @tab from @nb. @@ -4362,13 +4362,13 @@ end of the tabs. a #PlumaNotebook + line="1051">a #PlumaNotebook a #PlumaTab + line="1052">a #PlumaTab @@ -4409,7 +4409,7 @@ end of the tabs. c:identifier="pluma_notebook_set_close_buttons_sensitive"> Sets whether the close buttons in the tabs of @nb are sensitive. + line="1111">Sets whether the close buttons in the tabs of @nb are sensitive. @@ -4418,13 +4418,13 @@ end of the tabs. a #PlumaNotebook + line="1113">a #PlumaNotebook %TRUE to make the buttons sensitive + line="1114">%TRUE to make the buttons sensitive @@ -4433,7 +4433,7 @@ end of the tabs. c:identifier="pluma_notebook_set_tab_drag_and_drop_enabled"> Sets whether drag and drop of tabs in the @nb is enabled. + line="1152">Sets whether drag and drop of tabs in the @nb is enabled. @@ -4442,13 +4442,13 @@ end of the tabs. a #PlumaNotebook + line="1154">a #PlumaNotebook %TRUE to enable the drag and drop + line="1155">%TRUE to enable the drag and drop @@ -6756,7 +6756,7 @@ otherwise sets it to @font_name. Closes all opened tabs. + line="4354">Closes all opened tabs. @@ -6765,7 +6765,7 @@ otherwise sets it to @font_name. a #PlumaWindow + line="4356">a #PlumaWindow @@ -6773,7 +6773,7 @@ otherwise sets it to @font_name. Closes the @tab. + line="4335">Closes the @tab. @@ -6782,13 +6782,13 @@ otherwise sets it to @font_name. a #PlumaWindow + line="4337">a #PlumaWindow the #PlumaTab to close + line="4338">the #PlumaTab to close @@ -6796,7 +6796,7 @@ otherwise sets it to @font_name. Closes all tabs specified by @tabs. + line="4374">Closes all tabs specified by @tabs. @@ -6805,13 +6805,13 @@ otherwise sets it to @font_name. a #PlumaWindow + line="4376">a #PlumaWindow a list of #PlumaTab + line="4377">a list of #PlumaTab @@ -6821,26 +6821,26 @@ otherwise sets it to @font_name. Creates a new #PlumaTab and adds the new tab to the #PlumaNotebook. + line="4162">Creates a new #PlumaTab and adds the new tab to the #PlumaNotebook. In case @jump_to is %TRUE the #PlumaNotebook switches to that new #PlumaTab. a new #PlumaTab + line="4170">a new #PlumaTab a #PlumaWindow + line="4164">a #PlumaWindow %TRUE to set the new #PlumaTab as active + line="4165">%TRUE to set the new #PlumaTab as active @@ -6849,7 +6849,7 @@ In case @jump_to is %TRUE the #PlumaNotebook switches to that new #PlumaTab. Creates a new #PlumaTab loading the document specified by @uri. + line="4196">Creates a new #PlumaTab loading the document specified by @uri. In case @jump_to is %TRUE the #PlumaNotebook swithes to that new #PlumaTab. Whether @create is %TRUE, creates a new empty document if location does not refer to an existing file @@ -6857,44 +6857,44 @@ not refer to an existing file a new #PlumaTab + line="4210">a new #PlumaTab a #PlumaWindow + line="4198">a #PlumaWindow the uri of the document + line="4199">the uri of the document a #PlumaEncoding + line="4200">a #PlumaEncoding the line position to visualize + line="4201">the line position to visualize %TRUE to create a new document in case @uri does exist + line="4202">%TRUE to create a new document in case @uri does exist %TRUE to set the new #PlumaTab as active + line="4203">%TRUE to set the new #PlumaTab as active @@ -6903,19 +6903,19 @@ not refer to an existing file c:identifier="pluma_window_get_active_document"> Gets the active #PlumaDocument. + line="4132">Gets the active #PlumaDocument. the active #PlumaDocument + line="4138">the active #PlumaDocument a #PlumaWindow + line="4134">a #PlumaWindow @@ -6923,19 +6923,19 @@ not refer to an existing file Gets the active #PlumaTab in the @window. + line="4247">Gets the active #PlumaTab in the @window. the active #PlumaTab in the @window. + line="4253">the active #PlumaTab in the @window. a PlumaWindow + line="4249">a PlumaWindow @@ -6944,19 +6944,19 @@ not refer to an existing file c:identifier="pluma_window_get_active_view"> Gets the active #PlumaView. + line="4109">Gets the active #PlumaView. the active #PlumaView + line="4115">the active #PlumaView a #PlumaWindow + line="4111">a #PlumaWindow @@ -6965,19 +6965,19 @@ not refer to an existing file c:identifier="pluma_window_get_bottom_panel"> Gets the bottom #PlumaPanel of the @window. + line="4511">Gets the bottom #PlumaPanel of the @window. the bottom #PlumaPanel. + line="4517">the bottom #PlumaPanel. a #PlumaWindow + line="4513">a #PlumaWindow @@ -6985,13 +6985,13 @@ not refer to an existing file Gets a newly allocated list with all the documents in the window. + line="4274">Gets a newly allocated list with all the documents in the window. This list must be freed. a newly + line="4281">a newly allocated list with all the documents in the window @@ -7001,7 +7001,7 @@ allocated list with all the documents in the window a #PlumaWindow + line="4276">a #PlumaWindow @@ -7009,19 +7009,19 @@ allocated list with all the documents in the window Gets the #GtkWindowGroup in which @window resides. + line="4455">Gets the #GtkWindowGroup in which @window resides. the #GtkWindowGroup + line="4461">the #GtkWindowGroup a #PlumaWindow + line="4457">a #PlumaWindow @@ -7030,20 +7030,20 @@ allocated list with all the documents in the window c:identifier="pluma_window_get_message_bus"> Gets the #PlumaMessageBus associated with @window. The returned reference + line="4790">Gets the #PlumaMessageBus associated with @window. The returned reference is owned by the window and should not be unreffed. the #PlumaMessageBus associated with @window + line="4797">the #PlumaMessageBus associated with @window a #PlumaWindow + line="4792">a #PlumaWindow @@ -7051,19 +7051,19 @@ is owned by the window and should not be unreffed. Gets the side #PlumaPanel of the @window. + line="4495">Gets the side #PlumaPanel of the @window. the side #PlumaPanel. + line="4501">the side #PlumaPanel. a #PlumaWindow + line="4497">a #PlumaWindow @@ -7073,19 +7073,19 @@ is owned by the window and should not be unreffed. glib:get-property="state"> Retrieves the state of the @window. + line="4543">Retrieves the state of the @window. the current #PlumaWindowState of the @window. + line="4549">the current #PlumaWindowState of the @window. a #PlumaWindow + line="4545">a #PlumaWindow @@ -7093,19 +7093,19 @@ is owned by the window and should not be unreffed. Gets the #PlumaStatusbar of the @window. + line="4527">Gets the #PlumaStatusbar of the @window. the #PlumaStatusbar of the @window. + line="4533">the #PlumaStatusbar of the @window. a #PlumaWindow + line="4529">a #PlumaWindow @@ -7114,25 +7114,25 @@ is owned by the window and should not be unreffed. c:identifier="pluma_window_get_tab_from_location"> Gets the #PlumaTab that matches with the given @location. + line="4738">Gets the #PlumaTab that matches with the given @location. the #PlumaTab that matches with the given @location. + line="4745">the #PlumaTab that matches with the given @location. a #PlumaWindow + line="4740">a #PlumaWindow a #GFile + line="4741">a #GFile @@ -7140,19 +7140,19 @@ is owned by the window and should not be unreffed. Gets the #GtkUIManager associated with the @window. + line="4479">Gets the #GtkUIManager associated with the @window. the #GtkUIManager of the @window. + line="4485">the #GtkUIManager of the @window. a #PlumaWindow + line="4481">a #PlumaWindow @@ -7161,12 +7161,12 @@ is owned by the window and should not be unreffed. c:identifier="pluma_window_get_unsaved_documents"> Gets the list of documents that need to be saved before closing the window. + line="4586">Gets the list of documents that need to be saved before closing the window. a list of + line="4592">a list of #PlumaDocument that need to be saved before closing the window @@ -7176,7 +7176,7 @@ is owned by the window and should not be unreffed. a #PlumaWindow + line="4588">a #PlumaWindow @@ -7184,12 +7184,12 @@ is owned by the window and should not be unreffed. Gets a list with all the views in the window. This list must be freed. + line="4310">Gets a list with all the views in the window. This list must be freed. a newly allocated + line="4316">a newly allocated list with all the views in the window @@ -7199,7 +7199,7 @@ list with all the views in the window a #PlumaWindow + line="4312">a #PlumaWindow @@ -7207,7 +7207,7 @@ list with all the views in the window Switches to the tab that matches with @tab. + line="4431">Switches to the tab that matches with @tab. @@ -7216,13 +7216,13 @@ list with all the views in the window a #PlumaWindow + line="4433">a #PlumaWindow a #PlumaTab + line="4434">a #PlumaTab @@ -8105,7 +8105,7 @@ extensions that should be activated on a pluma main window. c:identifier="pluma_utils_basename_for_display"> Return the basename of a file suitable for display to users. + line="1261">Return the basename of a file suitable for display to users. @@ -8114,7 +8114,7 @@ extensions that should be activated on a pluma main window. uri for which the basename should be displayed + line="1263">uri for which the basename should be displayed @@ -8122,7 +8122,7 @@ extensions that should be activated on a pluma main window. Parse and break an uri apart in its individual components like the uri + line="1417">Parse and break an uri apart in its individual components like the uri scheme, user info, port, host and path. The return value pointer can be %NULL to ignore certain parts of the uri. If the function returns %TRUE, then all return value pointers should be freed using g_free @@ -8130,14 +8130,14 @@ all return value pointers should be freed using g_free %TRUE if the uri could be properly decoded, %FALSE otherwise. + line="1432">%TRUE if the uri could be properly decoded, %FALSE otherwise. the uri to decode + line="1419">the uri to decode allow-none="1"> return value pointer for the uri's + line="1420">return value pointer for the uri's scheme (e.g. http, sftp, ...), or %NULL @@ -8156,7 +8156,7 @@ scheme (e.g. http, sftp, ...), or %NULL allow-none="1"> return value pointer for the uri user info, or %NULL + line="1422">return value pointer for the uri user info, or %NULL allow-none="1"> return value pointer for the uri host, or %NULL + line="1423">return value pointer for the uri host, or %NULL allow-none="1"> return value pointer for the uri port, or %NULL + line="1424">return value pointer for the uri port, or %NULL allow-none="1"> return value pointer for the uri path, or %NULL + line="1425">return value pointer for the uri path, or %NULL @@ -8192,12 +8192,12 @@ scheme (e.g. http, sftp, ...), or %NULL c:identifier="pluma_utils_drop_get_uris"> Create a list of valid uri's from a uri-list drop. + line="1367">Create a list of valid uri's from a uri-list drop. a string array which will hold the uris or %NULL if there + line="1373">a string array which will hold the uris or %NULL if there were no valid uris. g_strfreev should be used when the string array is no longer used @@ -8208,7 +8208,7 @@ scheme (e.g. http, sftp, ...), or %NULL the #GtkSelectionData from drag_data_received + line="1369">the #GtkSelectionData from drag_data_received @@ -8244,7 +8244,7 @@ scheme (e.g. http, sftp, ...), or %NULL c:identifier="pluma_utils_file_has_parent"> Return %TRUE if the specified gfile has a parent (is not the root), %FALSE + line="1239">Return %TRUE if the specified gfile has a parent (is not the root), %FALSE otherwise @@ -8254,7 +8254,7 @@ otherwise the GFile to check the parent for + line="1241">the GFile to check the parent for @@ -8263,7 +8263,7 @@ otherwise c:identifier="pluma_utils_get_current_viewport"> Get the current viewport origin + line="941">Get the current viewport origin Get the currently visible viewport origin for the #GdkScreen. @@ -8288,7 +8288,7 @@ If the X11 window property isn't found, (0, 0) is returned. c:identifier="pluma_utils_get_current_workspace"> Get the current workspace + line="836">Get the current workspace Get the currently visible workspace for the #GdkScreen. @@ -8309,46 +8309,46 @@ is returned. introspectable="0"> This function gets the requested objects from a GtkBuilder ui file. In case + line="1096">This function gets the requested objects from a GtkBuilder ui file. In case of error it returns %FALSE and sets error_widget to a GtkLabel containing the error message to display. %FALSE if an error occurs, %TRUE on success. + line="1110">%FALSE if an error occurs, %TRUE on success. the path to the gtk builder file + line="1098">the path to the gtk builder file a %NULL terminated list of root objects to load or NULL to + line="1099">a %NULL terminated list of root objects to load or NULL to load all objects a pointer were a #GtkLabel + line="1101">a pointer were a #GtkLabel the name of the first object + line="1102">the name of the first object a pointer were the first object is returned, followed by more + line="1103">a pointer were the first object is returned, followed by more name / object pairs and terminated by %NULL. @@ -8358,7 +8358,7 @@ the error message to display. c:identifier="pluma_utils_get_window_workspace"> Get the workspace the window is on + line="888">Get the workspace the window is on This function gets the workspace that the #GtkWindow is visible on, it returns PLUMA_ALL_WORKSPACES if the window is sticky, or if @@ -8389,7 +8389,7 @@ the window manager doesn support this function c:identifier="pluma_utils_location_get_dirname_for_display"> Returns a string suitable to be displayed in the UI indicating + line="715">Returns a string suitable to be displayed in the UI indicating the name of the directory where the file is located. For remote files it may also contain the hostname etc. For local files it tries to replace the home dir with ~. @@ -8397,14 +8397,14 @@ For local files it tries to replace the home dir with ~. a string to display the dirname + line="724">a string to display the dirname the location + line="717">the location @@ -8578,7 +8578,7 @@ for a specified gtk widget. c:identifier="pluma_utils_uri_for_display"> Filter, modify, unescape and change @uri to make it appropriate + line="1343">Filter, modify, unescape and change @uri to make it appropriate for display to users. This function is a convenient wrapper for g_file_get_parse_name @@ -8586,14 +8586,14 @@ This function is a convenient wrapper for g_file_get_parse_name a string which represents @uri and can be displayed. + line="1352">a string which represents @uri and can be displayed. uri to be displayed. + line="1345">uri to be displayed. @@ -8602,7 +8602,7 @@ This function is a convenient wrapper for g_file_get_parse_name c:identifier="pluma_utils_uri_get_dirname"> Note: this function replace home dir with ~ + line="684">Note: this function replace home dir with ~ diff --git a/girs/Polkit-1.0.gir b/girs/Polkit-1.0.gir index 0e687cce4..a7b79aa73 100644 --- a/girs/Polkit-1.0.gir +++ b/girs/Polkit-1.0.gir @@ -14,6 +14,93 @@ and/or use gtk-doc annotations. --> shared-library="libpolkit-gobject-1.so.0" c:identifier-prefixes="Polkit" c:symbol-prefixes="polkit"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:get-type="polkit_action_description_get_type" glib:type-struct="ActionDescriptionClass"> Object used to encapsulate a registered action. - + Gets the action id for @action_description. - + A string owned by @action_description. Do not free. @@ -40,7 +129,7 @@ and/or use gtk-doc annotations. --> A #PolkitActionDescription. @@ -49,12 +138,13 @@ and/or use gtk-doc annotations. --> Get the value of the annotation with @key. - + %NULL if there is no annoation with @key, otherwise the annotation value owned by @action_description. Do not free. @@ -64,13 +154,13 @@ free. A #PolkitActionDescription. An annotation key. @@ -79,12 +169,13 @@ free. Gets the keys of annotations defined in @action_description. - + The annotation keys owned by @action_description. Do not free. @@ -94,7 +185,7 @@ free. A #PolkitActionDescription. @@ -103,12 +194,13 @@ free. Gets the description used for @action_description. - + A string owned by @action_description. Do not free. @@ -116,7 +208,7 @@ free. A #PolkitActionDescription. @@ -125,12 +217,13 @@ free. Gets the icon name for @action_description, if any. - + A string owned by @action_description. Do not free. @@ -138,7 +231,7 @@ free. A #PolkitActionDescription. @@ -147,13 +240,14 @@ free. Gets the implicit authorization for @action_description used for subjects in active sessions on a local console. - + A value from the #PolkitImplicitAuthorization enumeration. @@ -162,7 +256,7 @@ subjects in active sessions on a local console. A #PolkitActionDescription. @@ -171,13 +265,14 @@ subjects in active sessions on a local console. Gets the implicit authorization for @action_description used for any subject. - + A value from the #PolkitImplicitAuthorization enumeration. @@ -186,7 +281,7 @@ any subject. A #PolkitActionDescription. @@ -195,13 +290,14 @@ any subject. Gets the implicit authorization for @action_description used for subjects in inactive sessions on a local console. - + A value from the #PolkitImplicitAuthorization enumeration. @@ -210,7 +306,7 @@ subjects in inactive sessions on a local console. A #PolkitActionDescription. @@ -219,12 +315,13 @@ subjects in inactive sessions on a local console. Gets the message used for @action_description. - + A string owned by @action_description. Do not free. @@ -232,7 +329,7 @@ subjects in inactive sessions on a local console. A #PolkitActionDescription. @@ -241,12 +338,13 @@ subjects in inactive sessions on a local console. Gets the vendor name for @action_description, if any. - + A string owned by @action_description. Do not free. @@ -254,7 +352,7 @@ subjects in inactive sessions on a local console. A #PolkitActionDescription. @@ -263,12 +361,13 @@ subjects in inactive sessions on a local console. Gets the vendor URL for @action_description, if any. - + A string owned by @action_description. Do not free. @@ -276,7 +375,7 @@ subjects in inactive sessions on a local console. A #PolkitActionDescription. @@ -286,8 +385,10 @@ subjects in inactive sessions on a local console. - + glib:get-type="polkit_authority_get_type" glib:type-struct="AuthorityClass"> #PolkitAuthority is used for checking whether a given subject is authorized to perform a given action. Typically privileged system daemons or suid helpers will use this when handling requests from @@ -307,24 +408,24 @@ authority. This is used for requests from untrusted clients where system policy requires that the user needs to acknowledge (through proving he is the user or the administrator) a given action. See #PolkitAgentListener and #PolkitAgentSession for details. - + (deprecated) - + value Asynchronously gets a reference to the authority. This is an asynchronous failable function. When the result is @@ -333,7 +434,7 @@ linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from and you can use polkit_authority_get_finish() to get the result. See polkit_authority_get_sync() for the synchronous version. - + @@ -343,7 +444,7 @@ polkit_authority_get_sync() for the synchronous version. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -354,7 +455,7 @@ polkit_authority_get_sync() for the synchronous version. scope="async" closure="2"> A #GAsyncReadyCallback to call when the request is satisfied. @@ -363,7 +464,7 @@ polkit_authority_get_sync() for the synchronous version. nullable="1" allow-none="1"> The data to pass to @callback. @@ -373,12 +474,12 @@ polkit_authority_get_sync() for the synchronous version. c:identifier="polkit_authority_get_finish" throws="1"> Finishes an operation started with polkit_authority_get_async(). - + A #PolkitAuthority. Free it with g_object_unref() when done with it. @@ -386,7 +487,7 @@ g_object_unref() when done with it. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to polkit_authority_get_async(). @@ -396,16 +497,16 @@ g_object_unref() when done with it. c:identifier="polkit_authority_get_sync" throws="1"> Synchronously gets a reference to the authority. This is a synchronous failable function - the calling thread is blocked until a reply is received. See polkit_authority_get_async() for the asynchronous version. - + A #PolkitAuthority. Free it with g_object_unref() when done with it. @@ -416,7 +517,7 @@ g_object_unref() when done with it. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -425,7 +526,7 @@ g_object_unref() when done with it. Asynchronously provide response that @identity successfully authenticated for the authentication request identified by @cookie. @@ -438,26 +539,26 @@ main loop</link> of the thread you are calling this method from. You can then call polkit_authority_authentication_agent_response_finish() to get the result of the operation. - + A #PolkitAuthority. The cookie passed to the authentication agent from the authority. The identity that was authenticated. @@ -466,7 +567,7 @@ result of the operation. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -477,7 +578,7 @@ result of the operation. scope="async" closure="4"> A #GAsyncReadyCallback to call when the request is satisfied. @@ -486,7 +587,7 @@ result of the operation. nullable="1" allow-none="1"> The data to pass to @callback. @@ -496,25 +597,25 @@ result of the operation. c:identifier="polkit_authority_authentication_agent_response_finish" throws="1"> Finishes providing response from an authentication agent. - + %TRUE if @authority acknowledged the call, %FALSE if @error is set. A #PolkitAuthority. A #GAsyncResult obtained from the callback. @@ -524,7 +625,7 @@ result of the operation. c:identifier="polkit_authority_authentication_agent_response_sync" throws="1"> Provide response that @identity successfully authenticated for the authentication request identified by @cookie. See polkit_authority_authentication_agent_response() for limitations on who is allowed is to call this method. @@ -532,29 +633,29 @@ for limitations on who is allowed is to call this method. The calling thread is blocked until a reply is received. See polkit_authority_authentication_agent_response() for the asynchronous version. - + %TRUE if @authority acknowledged the call, %FALSE if @error is set. A #PolkitAuthority. The cookie passed to the authentication agent from the authority. The identity that was authenticated. @@ -563,7 +664,7 @@ asynchronous version. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -572,7 +673,7 @@ asynchronous version. Asynchronously checks if @subject is authorized to perform the action represented by @action_id. @@ -597,26 +698,26 @@ the <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckA If @details is non-empty then the request will fail with #POLKIT_ERROR_FAILED unless the process doing the check itsef is sufficiently authorized (e.g. running as uid 0). - + A #PolkitAuthority. A #PolkitSubject. The action to check for. @@ -625,13 +726,13 @@ sufficiently authorized (e.g. running as uid 0). nullable="1" allow-none="1"> Details about the action or %NULL. A set of #PolkitCheckAuthorizationFlags. @@ -641,7 +742,7 @@ sufficiently authorized (e.g. running as uid 0). nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -652,7 +753,7 @@ sufficiently authorized (e.g. running as uid 0). scope="async" closure="6"> A #GAsyncReadyCallback to call when the request is satisfied. @@ -661,7 +762,7 @@ sufficiently authorized (e.g. running as uid 0). nullable="1" allow-none="1"> The data to pass to @callback. @@ -671,12 +772,12 @@ sufficiently authorized (e.g. running as uid 0). c:identifier="polkit_authority_check_authorization_finish" throws="1"> Finishes checking if a subject is authorized for an action. - + A #PolkitAuthorizationResult or %NULL if @error is set. Free with g_object_unref(). A #PolkitAuthority. A #GAsyncResult obtained from the callback. @@ -701,7 +802,7 @@ sufficiently authorized (e.g. running as uid 0). c:identifier="polkit_authority_check_authorization_sync" throws="1"> Checks if @subject is authorized to perform the action represented by @action_id. @@ -723,10 +824,10 @@ Known keys in @details include <literal>polkit.message</literal> and <literal>polkit.gettext_domain</literal> that can be used to override the message shown to the user. See the documentation for the <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckAuthorization">D-Bus method</link> for more details. - + A #PolkitAuthorizationResult or %NULL if @error is set. Free with g_object_unref(). @@ -734,19 +835,19 @@ the <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckA A #PolkitAuthority. A #PolkitSubject. The action to check for. @@ -755,13 +856,13 @@ the <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckA nullable="1" allow-none="1"> Details about the action or %NULL. A set of #PolkitCheckAuthorizationFlags. @@ -771,7 +872,7 @@ the <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckA nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -780,7 +881,7 @@ the <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.CheckA Asynchronously retrieves all registered actions. When the operation is finished, @callback will be invoked in the @@ -788,14 +889,14 @@ When the operation is finished, @callback will be invoked in the main loop</link> of the thread you are calling this method from. You can then call polkit_authority_enumerate_actions_finish() to get the result of the operation. - + A #PolkitAuthority. @@ -804,7 +905,7 @@ to get the result of the operation. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -815,7 +916,7 @@ to get the result of the operation. scope="async" closure="2"> A #GAsyncReadyCallback to call when the request is satisfied. @@ -824,7 +925,7 @@ to get the result of the operation. nullable="1" allow-none="1"> The data to pass to @callback. @@ -834,12 +935,12 @@ to get the result of the operation. c:identifier="polkit_authority_enumerate_actions_finish" throws="1"> Finishes retrieving all registered actions. - + A list of #PolkitActionDescription objects or %NULL if @error is set. The returned list should be freed with g_list_free() after each element have been freed @@ -851,13 +952,13 @@ with g_object_unref(). A #PolkitAuthority. A #GAsyncResult obtained from the callback. @@ -867,14 +968,14 @@ with g_object_unref(). c:identifier="polkit_authority_enumerate_actions_sync" throws="1"> Synchronously retrieves all registered actions - the calling thread is blocked until a reply is received. See polkit_authority_enumerate_actions() for the asynchronous version. - + A list of #PolkitActionDescription or %NULL if @error is set. The returned list should be freed with g_list_free() after each element have been freed with @@ -886,7 +987,7 @@ g_object_unref(). A #PolkitAuthority. @@ -895,7 +996,7 @@ g_object_unref(). nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -904,7 +1005,7 @@ g_object_unref(). Asynchronously gets all temporary authorizations for @subject. When the operation is finished, @callback will be invoked in the @@ -913,20 +1014,20 @@ main loop</link> of the thread you are calling this method from. You can then call polkit_authority_enumerate_temporary_authorizations_finish() to get the result of the operation. - + A #PolkitAuthority. A #PolkitSubject, typically a #PolkitUnixSession. @@ -935,7 +1036,7 @@ the result of the operation. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -946,7 +1047,7 @@ the result of the operation. scope="async" closure="3"> A #GAsyncReadyCallback to call when the request is satisfied. @@ -955,7 +1056,7 @@ the result of the operation. nullable="1" allow-none="1"> The data to pass to @callback. @@ -965,12 +1066,12 @@ the result of the operation. c:identifier="polkit_authority_enumerate_temporary_authorizations_finish" throws="1"> Finishes retrieving all registered actions. - + A list of #PolkitTemporaryAuthorization objects or %NULL if @error is set. The returned list should be freed with g_list_free() after each element have @@ -982,13 +1083,13 @@ been freed with g_object_unref(). A #PolkitAuthority. A #GAsyncResult obtained from the callback. @@ -998,16 +1099,16 @@ been freed with g_object_unref(). c:identifier="polkit_authority_enumerate_temporary_authorizations_sync" throws="1"> Synchronousky gets all temporary authorizations for @subject. The calling thread is blocked until a reply is received. See polkit_authority_enumerate_temporary_authorizations() for the asynchronous version. - + A list of #PolkitTemporaryAuthorization objects or %NULL if @error is set. The returned list should be freed with g_list_free() after each element have @@ -1019,13 +1120,13 @@ been freed with g_object_unref(). A #PolkitAuthority. A #PolkitSubject, typically a #PolkitUnixSession. @@ -1034,93 +1135,98 @@ been freed with g_object_unref(). nullable="1" allow-none="1"> A #GCancellable or %NULL. + c:identifier="polkit_authority_get_backend_features" + glib:get-property="backend-features"> Gets the features supported by the authority backend. - + Flags from #PolkitAuthorityFeatures. A #PolkitAuthority. + c:identifier="polkit_authority_get_backend_name" + glib:get-property="backend-name"> Gets the name of the authority backend. - + The name of the backend. A #PolkitAuthority. + c:identifier="polkit_authority_get_backend_version" + glib:get-property="backend-version"> Gets the version of the authority backend. - + The version string for the backend. A #PolkitAuthority. - + The unique name on the system message bus of the owner of the name <literal>org.freedesktop.PolicyKit1</literal> or %NULL if no-one currently owns the name. You may connect to the #GObject::notify signal to track changes to the #PolkitAuthority:owner property. - + %NULL or a string that should be freed with g_free(). A #PolkitAuthority. @@ -1129,7 +1235,7 @@ signal to track changes to the #PolkitAuthority:owner property. Asynchronously registers an authentication agent. Note that this should be called by the same effective UID which will be @@ -1142,32 +1248,32 @@ main loop</link> of the thread you are calling this method from. You can then call polkit_authority_register_authentication_agent_finish() to get the result of the operation. - + A #PolkitAuthority. The subject the authentication agent is for, typically a #PolkitUnixSession object. The locale of the authentication agent. The object path for the authentication agent. @@ -1176,7 +1282,7 @@ result of the operation. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -1187,7 +1293,7 @@ result of the operation. scope="async" closure="5"> A #GAsyncReadyCallback to call when the request is satisfied. @@ -1196,7 +1302,7 @@ result of the operation. nullable="1" allow-none="1"> The data to pass to @callback. @@ -1206,25 +1312,25 @@ result of the operation. c:identifier="polkit_authority_register_authentication_agent_finish" throws="1"> Finishes registering an authentication agent. - + %TRUE if the authentication agent was successfully registered, %FALSE if @error is set. A #PolkitAuthority. A #GAsyncResult obtained from the callback. @@ -1234,7 +1340,7 @@ result of the operation. c:identifier="polkit_authority_register_authentication_agent_sync" throws="1"> Registers an authentication agent. Note that this should be called by the same effective UID which will be @@ -1245,35 +1351,35 @@ The calling thread is blocked until a reply is received. See polkit_authority_register_authentication_agent() for the asynchronous version. - + %TRUE if the authentication agent was successfully registered, %FALSE if @error is set. A #PolkitAuthority. The subject the authentication agent is for, typically a #PolkitUnixSession object. The locale of the authentication agent. The object path for the authentication agent. @@ -1282,7 +1388,7 @@ asynchronous version. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -1291,7 +1397,7 @@ asynchronous version. Asynchronously registers an authentication agent. Note that this should be called by the same effective UID which will be @@ -1304,32 +1410,32 @@ main loop</link> of the thread you are calling this method from. You can then call polkit_authority_register_authentication_agent_with_options_finish() to get the result of the operation. - + A #PolkitAuthority. The subject the authentication agent is for, typically a #PolkitUnixSession object. The locale of the authentication agent. The object path for the authentication agent. @@ -1338,7 +1444,7 @@ result of the operation. nullable="1" allow-none="1"> A #GVariant with options or %NULL. @@ -1347,7 +1453,7 @@ result of the operation. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -1358,7 +1464,7 @@ result of the operation. scope="async" closure="6"> A #GAsyncReadyCallback to call when the request is satisfied. @@ -1367,7 +1473,7 @@ result of the operation. nullable="1" allow-none="1"> The data to pass to @callback. @@ -1377,25 +1483,25 @@ result of the operation. c:identifier="polkit_authority_register_authentication_agent_with_options_finish" throws="1"> Finishes registering an authentication agent. - + %TRUE if the authentication agent was successfully registered, %FALSE if @error is set. A #PolkitAuthority. A #GAsyncResult obtained from the callback. @@ -1405,7 +1511,7 @@ result of the operation. c:identifier="polkit_authority_register_authentication_agent_with_options_sync" throws="1"> Registers an authentication agent. Note that this should be called by the same effective UID which will be @@ -1416,35 +1522,35 @@ The calling thread is blocked until a reply is received. See polkit_authority_register_authentication_agent_with_options() for the asynchronous version. - + %TRUE if the authentication agent was successfully registered, %FALSE if @error is set. A #PolkitAuthority. The subject the authentication agent is for, typically a #PolkitUnixSession object. The locale of the authentication agent. The object path for the authentication agent. @@ -1453,7 +1559,7 @@ asynchronous version. nullable="1" allow-none="1"> A #GVariant with options or %NULL. @@ -1462,7 +1568,7 @@ asynchronous version. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -1471,7 +1577,7 @@ asynchronous version. Asynchronously revoke a temporary authorization. When the operation is finished, @callback will be invoked in the @@ -1480,20 +1586,20 @@ main loop</link> of the thread you are calling this method from. You can then call polkit_authority_revoke_temporary_authorization_by_id_finish() to get the result of the operation. - + A #PolkitAuthority. The opaque identifier for the temporary authorization. @@ -1502,7 +1608,7 @@ get the result of the operation. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -1513,7 +1619,7 @@ get the result of the operation. scope="async" closure="3"> A #GAsyncReadyCallback to call when the request is satisfied. @@ -1522,7 +1628,7 @@ get the result of the operation. nullable="1" allow-none="1"> The data to pass to @callback. @@ -1532,25 +1638,25 @@ get the result of the operation. c:identifier="polkit_authority_revoke_temporary_authorization_by_id_finish" throws="1"> Finishes revoking a temporary authorization by id. - + %TRUE if the temporary authorization was revoked, %FALSE if error is set. A #PolkitAuthority. A #GAsyncResult obtained from the callback. @@ -1560,29 +1666,29 @@ get the result of the operation. c:identifier="polkit_authority_revoke_temporary_authorization_by_id_sync" throws="1"> Synchronously revokes a temporary authorization. The calling thread is blocked until a reply is received. See polkit_authority_revoke_temporary_authorization_by_id() for the asynchronous version. - + %TRUE if the temporary authorization was revoked, %FALSE if error is set. A #PolkitAuthority. The opaque identifier for the temporary authorization. @@ -1591,7 +1697,7 @@ asynchronous version. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -1600,7 +1706,7 @@ asynchronous version. Asynchronously revokes all temporary authorizations for @subject. When the operation is finished, @callback will be invoked in the @@ -1609,20 +1715,20 @@ main loop</link> of the thread you are calling this method from. You can then call polkit_authority_revoke_temporary_authorizations_finish() to get the result of the operation. - + A #PolkitAuthority. The subject to revoke authorizations from, typically a #PolkitUnixSession. @@ -1631,7 +1737,7 @@ the result of the operation. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -1642,7 +1748,7 @@ the result of the operation. scope="async" closure="3"> A #GAsyncReadyCallback to call when the request is satisfied. @@ -1651,7 +1757,7 @@ the result of the operation. nullable="1" allow-none="1"> The data to pass to @callback. @@ -1661,25 +1767,25 @@ the result of the operation. c:identifier="polkit_authority_revoke_temporary_authorizations_finish" throws="1"> Finishes revoking temporary authorizations. - + %TRUE if all the temporary authorizations was revoked, %FALSE if error is set. A #PolkitAuthority. A #GAsyncResult obtained from the callback. @@ -1689,29 +1795,29 @@ the result of the operation. c:identifier="polkit_authority_revoke_temporary_authorizations_sync" throws="1"> Synchronously revokes all temporary authorization from @subject. The calling thread is blocked until a reply is received. See polkit_authority_revoke_temporary_authorizations() for the asynchronous version. - + %TRUE if the temporary authorization was revoked, %FALSE if error is set. A #PolkitAuthority. The subject to revoke authorizations from, typically a #PolkitUnixSession. @@ -1720,7 +1826,7 @@ asynchronous version. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -1729,7 +1835,7 @@ asynchronous version. Asynchronously unregisters an authentication agent. When the operation is finished, @callback will be invoked in the @@ -1738,26 +1844,26 @@ main loop</link> of the thread you are calling this method from. You can then call polkit_authority_unregister_authentication_agent_finish() to get the result of the operation. - + A #PolkitAuthority. The subject the authentication agent is for, typically a #PolkitUnixSession object. The object path for the authentication agent. @@ -1766,7 +1872,7 @@ the result of the operation. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -1777,7 +1883,7 @@ the result of the operation. scope="async" closure="4"> A #GAsyncReadyCallback to call when the request is satisfied. @@ -1786,7 +1892,7 @@ the result of the operation. nullable="1" allow-none="1"> The data to pass to @callback. @@ -1796,25 +1902,25 @@ the result of the operation. c:identifier="polkit_authority_unregister_authentication_agent_finish" throws="1"> Finishes unregistering an authentication agent. - + %TRUE if the authentication agent was successfully unregistered, %FALSE if @error is set. A #PolkitAuthority. A #GAsyncResult obtained from the callback. @@ -1824,34 +1930,34 @@ the result of the operation. c:identifier="polkit_authority_unregister_authentication_agent_sync" throws="1"> Unregisters an authentication agent. The calling thread is blocked until a reply is received. See polkit_authority_unregister_authentication_agent() for the asynchronous version. - + %TRUE if the authentication agent was successfully unregistered, %FALSE if @error is set. A #PolkitAuthority. The subject the authentication agent is for, typically a #PolkitUnixSession object. The object path for the authentication agent. @@ -1860,30 +1966,42 @@ asynchronous version. nullable="1" allow-none="1"> A #GCancellable or %NULL. - + The features of the currently used Authority backend. - + The name of the currently used Authority backend. - + - + The unique name of the owner of the org.freedesktop.PolicyKit1 D-Bus service or %NULL if there is no owner. Connect to the #GObject::notify signal to track changes to this property. @@ -1891,7 +2009,7 @@ D-Bus service or %NULL if there is no owner. Connect to the Emitted when actions and/or authorizations change @@ -1901,30 +2019,33 @@ D-Bus service or %NULL if there is no owner. Connect to the - + Flags describing features supported by the Authority implementation. + glib:nick="none" + glib:name="POLKIT_AUTHORITY_FEATURES_NONE"> No flags set. + glib:nick="temporary-authorization" + glib:name="POLKIT_AUTHORITY_FEATURES_TEMPORARY_AUTHORIZATION"> The authority supports temporary authorizations that can be obtained through authentication. @@ -1936,17 +2057,19 @@ that can be obtained through authentication. glib:get-type="polkit_authorization_result_get_type" glib:type-struct="AuthorizationResultClass"> This class represents the result you get when checking for an authorization. - + Creates a new #PolkitAuthorizationResult object. - + A #PolkitAuthorizationResult object. Free with g_object_unref(). @@ -1954,13 +2077,13 @@ that can be obtained through authentication. Whether the subject is authorized. Whether the subject is authorized if more information is provided. Must be %FALSE unless @is_authorized is %TRUE. @@ -1971,7 +2094,7 @@ information is provided. Must be %FALSE unless @is_authorized is nullable="1" allow-none="1"> Must be %NULL unless @is_authorized is %TRUE @@ -1980,12 +2103,13 @@ information is provided. Must be %FALSE unless @is_authorized is Gets the details about the result. - + A #PolkitDetails object or %NULL if there are no details. This object is owned by @result and should not be freed by the caller. @@ -1994,7 +2118,7 @@ should not be freed by the caller. A #PolkitAuthorizationResult. @@ -2005,22 +2129,23 @@ should not be freed by the caller. c:identifier="polkit_authorization_result_get_dismissed" version="0.101"> Gets whether the authentication request was dismissed / canceled by the user. This method simply reads the value of the key/value pair in @details with the key <literal>polkit.dismissed</literal>. - + %TRUE if the authentication request was dismissed, %FALSE otherwise. A #PolkitAuthorizationResult. @@ -2030,22 +2155,23 @@ key <literal>polkit.dismissed</literal>. Gets whether the subject is authorized. If the authorization is temporary, use polkit_authorization_result_get_temporary_authorization_id() to get the opaque identifier for the temporary authorization. - + Whether the subject is authorized. A #PolkitAuthorizationResult. @@ -2055,19 +2181,20 @@ to get the opaque identifier for the temporary authorization. Gets whether the subject is authorized if more information is provided. - + Whether the subject is authorized if more information is provided. A #PolkitAuthorizationResult. @@ -2077,7 +2204,7 @@ to get the opaque identifier for the temporary authorization. Gets whether authorization is retained if obtained via authentication. This can only be the case if @result indicates that the subject can obtain authorization after challenge (cf. polkit_authorization_result_get_is_challenge()), e.g. when the subject is not already authorized (cf. @@ -2088,17 +2215,18 @@ to check if the authorization is temporary. This method simply reads the value of the key/value pair in @details with the key <literal>polkit.retains_authorization_after_challenge</literal>. - + %TRUE if the authorization is or will be temporary. A #PolkitAuthorizationResult. @@ -2108,7 +2236,7 @@ key <literal>polkit.retains_authorization_after_challenge</literal>. Gets the opaque temporary authorization id for @result if @result indicates the subject is authorized and the authorization is temporary rather than one-shot or permanent. @@ -2123,10 +2251,11 @@ to check if the authorization will be retained if obtained via authentication. This method simply reads the value of the key/value pair in @details with the key <literal>polkit.temporary_authorization_id</literal>. - + The opaque temporary authorization id for @result or %NULL if not available. Do not free this string, it is owned by @result. @@ -2135,7 +2264,7 @@ key <literal>polkit.temporary_authorization_id</literal>. A #PolkitAuthorizationResult. @@ -2146,35 +2275,66 @@ key <literal>polkit.temporary_authorization_id</literal>. - + Possible flags when checking authorizations. + glib:nick="none" + glib:name="POLKIT_CHECK_AUTHORIZATION_FLAGS_NONE"> No flags set. + glib:nick="allow-user-interaction" + glib:name="POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION"> If the subject can obtain the authorization through authentication, and an authentication agent is available, then attempt to do so. Note, this means that the method used for checking authorization is likely to block for a long time. + + + + + + + + + + + + + + + + + + + + + An object used for passing details around. - + Creates a new #PolkitDetails object. - + A #PolkitDetails object. Free with g_object_unref(). Gets a list of all keys on @details. - + %NULL if there are no keys otherwise an array of strings that should be freed with g_strfreev(). @@ -2215,7 +2375,7 @@ g_strfreev(). A #PolkitDetails. @@ -2223,24 +2383,24 @@ g_strfreev(). Inserts a copy of @key and @value on @details. If @value is %NULL, the key will be removed. - + A #PolkitDetails. A key. @@ -2249,7 +2409,7 @@ If @value is %NULL, the key will be removed. nullable="1" allow-none="1"> A value. @@ -2257,25 +2417,25 @@ If @value is %NULL, the key will be removed. Gets the value for @key on @details. - + %NULL if there is no value for @key, otherwise a string owned by @details. A #PolkitDetails. A key. @@ -2285,8 +2445,9 @@ If @value is %NULL, the key will be removed. - + c:type="PolkitError" glib:error-domain="polkit-error-quark"> Possible error when using PolicyKit. + glib:nick="failed" + glib:name="POLKIT_ERROR_FAILED"> The operation failed. + glib:nick="cancelled" + glib:name="POLKIT_ERROR_CANCELLED"> The operation was cancelled. + glib:nick="not-supported" + glib:name="POLKIT_ERROR_NOT_SUPPORTED"> Operation is not supported. + glib:nick="not-authorized" + glib:name="POLKIT_ERROR_NOT_AUTHORIZED"> Not authorized to perform operation. @@ -2334,27 +2499,276 @@ If @value is %NULL, the key will be removed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + #PolkitIdentity is an abstract type for representing one or more identities. - + Creates an object from @str that implements the #PolkitIdentity interface. - + A #PolkitIdentity or %NULL if @error is set. Free with g_object_unref(). @@ -2362,7 +2776,7 @@ if @error is set. Free with g_object_unref(). A string obtained from polkit_identity_to_string(). @@ -2370,27 +2784,27 @@ if @error is set. Free with g_object_unref(). Checks if @a and @b are equal, ie. represent the same identity. This function can be used in e.g. g_hash_table_new(). - + %TRUE if @a and @b are equal, %FALSE otherwise. A #PolkitIdentity. A #PolkitIdentity. @@ -2398,19 +2812,19 @@ This function can be used in e.g. g_hash_table_new(). Gets a hash code for @identity that can be used with e.g. g_hash_table_new(). - + A hash code. A #PolkitIdentity. @@ -2418,20 +2832,20 @@ This function can be used in e.g. g_hash_table_new(). Serializes @identity to a string that can be used in polkit_identity_from_string(). - + A string representing @identity. Free with g_free(). A #PolkitIdentity. @@ -2439,27 +2853,27 @@ polkit_identity_from_string(). Checks if @a and @b are equal, ie. represent the same identity. This function can be used in e.g. g_hash_table_new(). - + %TRUE if @a and @b are equal, %FALSE otherwise. A #PolkitIdentity. A #PolkitIdentity. @@ -2467,19 +2881,19 @@ This function can be used in e.g. g_hash_table_new(). Gets a hash code for @identity that can be used with e.g. g_hash_table_new(). - + A hash code. A #PolkitIdentity. @@ -2487,20 +2901,20 @@ This function can be used in e.g. g_hash_table_new(). Serializes @identity to a string that can be used in polkit_identity_from_string(). - + A string representing @identity. Free with g_free(). A #PolkitIdentity. @@ -2511,28 +2925,28 @@ polkit_identity_from_string(). c:type="PolkitIdentityIface" glib:is-gtype-struct-for="Identity"> An interface for identities. - + The parent interface. - + A hash code. A #PolkitIdentity. @@ -2541,23 +2955,23 @@ polkit_identity_from_string(). - + %TRUE if @a and @b are equal, %FALSE otherwise. A #PolkitIdentity. A #PolkitIdentity. @@ -2566,17 +2980,17 @@ polkit_identity_from_string(). - + A string representing @identity. Free with g_free(). A #PolkitIdentity. @@ -2589,76 +3003,92 @@ polkit_identity_from_string(). glib:get-type="polkit_implicit_authorization_get_type" c:type="PolkitImplicitAuthorization"> Possible implicit authorizations. + glib:nick="unknown" + glib:name="POLKIT_IMPLICIT_AUTHORIZATION_UNKNOWN"> Unknown whether the subject is authorized, never returned in any public API. + glib:nick="not-authorized" + glib:name="POLKIT_IMPLICIT_AUTHORIZATION_NOT_AUTHORIZED"> Subject is not authorized. + glib:nick="authentication-required" + glib:name="POLKIT_IMPLICIT_AUTHORIZATION_AUTHENTICATION_REQUIRED"> Authentication is required. + glib:nick="administrator-authentication-required" + glib:name="POLKIT_IMPLICIT_AUTHORIZATION_ADMINISTRATOR_AUTHENTICATION_REQUIRED"> Authentication as an administrator is required. + glib:nick="authentication-required-retained" + glib:name="POLKIT_IMPLICIT_AUTHORIZATION_AUTHENTICATION_REQUIRED_RETAINED"> Authentication is required. If the authorization is obtained, it is retained. + glib:nick="administrator-authentication-required-retained" + glib:name="POLKIT_IMPLICIT_AUTHORIZATION_ADMINISTRATOR_AUTHENTICATION_REQUIRED_RETAINED"> Authentication as an administrator is required. If the authorization is obtained, it is retained. + glib:nick="authorized" + glib:name="POLKIT_IMPLICIT_AUTHORIZATION_AUTHORIZED"> The subject is authorized - + + A string + The location of the resulting deserialization @@ -2666,7 +3096,8 @@ polkit_identity_from_string(). - + @@ -2678,13 +3109,22 @@ polkit_identity_from_string(). + + + + + + + #PolkitPermission is a #GPermission implementation. It can be used with e.g. #GtkLockButton. See the #GPermission documentation for more information. @@ -2694,19 +3134,19 @@ more information. c:identifier="polkit_permission_new_finish" throws="1"> Finishes an operation started with polkit_permission_new(). - + A #GPermission or %NULL if @error is set. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to polkit_permission_new(). @@ -2716,23 +3156,23 @@ more information. c:identifier="polkit_permission_new_sync" throws="1"> Creates a #GPermission instance for the PolicyKit action @action_id. This is a synchronous failable constructor. See polkit_permission_new() for the asynchronous version. - + A #GPermission or %NULL if @error is set. The PolicyKit action identifier. @@ -2741,7 +3181,7 @@ polkit_permission_new() for the asynchronous version. nullable="1" allow-none="1"> A #PolkitSubject or %NULL for the current process. @@ -2750,7 +3190,7 @@ polkit_permission_new() for the asynchronous version. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -2758,7 +3198,7 @@ polkit_permission_new() for the asynchronous version. Creates a #GPermission instance for the PolicyKit action @action_id. @@ -2768,14 +3208,14 @@ operation. This is a asynchronous failable constructor. See polkit_permission_new_sync() for the synchronous version. - + The PolicyKit action identifier. @@ -2784,7 +3224,7 @@ polkit_permission_new_sync() for the synchronous version. nullable="1" allow-none="1"> A #PolkitSubject or %NULL for the current process. @@ -2793,7 +3233,7 @@ polkit_permission_new_sync() for the synchronous version. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -2804,7 +3244,7 @@ polkit_permission_new_sync() for the synchronous version. scope="async" closure="4"> A #GAsyncReadyCallback to call when the request is satisfied. @@ -2813,48 +3253,51 @@ polkit_permission_new_sync() for the synchronous version. nullable="1" allow-none="1"> The data to pass to @callback. + c:identifier="polkit_permission_get_action_id" + glib:get-property="action-id"> Gets the PolicyKit action identifier used for @permission. - + A string owned by @permission. Do not free. A #PolkitPermission. - + Gets the subject used for @permission. - + An object owned by @permission. Do not free. A #PolkitPermission. @@ -2863,44 +3306,92 @@ polkit_permission_new_sync() for the synchronous version. + transfer-ownership="none" + getter="get_action_id" + default-value="NULL"> The action identifier to use for the permission. + transfer-ownership="none" + getter="get_subject"> The #PolkitSubject to use for the permission. If not set during construction, it will be set to match the current process. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + #PolkitSubject is an abstract type for representing one or more processes. - + Creates an object from @str that implements the #PolkitSubject interface. - + A #PolkitSubject or %NULL if @error is set. Free with g_object_unref(). @@ -2908,7 +3399,7 @@ set. Free with g_object_unref(). A string obtained from polkit_subject_to_string(). @@ -2916,29 +3407,29 @@ set. Free with g_object_unref(). Checks if @a and @b are equal, ie. represent the same subject. However, avoid calling polkit_subject_equal() to compare two processes; for more information see the `PolkitUnixProcess` documentation. This function can be used in e.g. g_hash_table_new(). - + %TRUE if @a and @b are equal, %FALSE otherwise. A #PolkitSubject. A #PolkitSubject. @@ -2946,7 +3437,7 @@ This function can be used in e.g. g_hash_table_new(). Asynchronously checks if @subject exists. When the operation is finished, @callback will be invoked in the @@ -2954,14 +3445,14 @@ When the operation is finished, @callback will be invoked in the main loop</link> of the thread you are calling this method from. You can then call polkit_subject_exists_finish() to get the result of the operation. - + A #PolkitSubject. @@ -2970,7 +3461,7 @@ result of the operation. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -2981,7 +3472,7 @@ result of the operation. scope="async" closure="2"> A #GAsyncReadyCallback to call when the request is satisfied @@ -2991,7 +3482,7 @@ result of the operation. allow-none="1" closure="2"> The data to pass to @callback. @@ -2999,25 +3490,25 @@ result of the operation. Finishes checking whether a subject exists. - + %TRUE if the subject exists, %FALSE if not or @error is set. A #PolkitSubject. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to polkit_subject_exists(). @@ -3025,23 +3516,23 @@ result of the operation. Checks if @subject exists. This is a synchronous blocking call - the calling thread is blocked until a reply is received. See polkit_subject_exists() for the asynchronous version. - + %TRUE if the subject exists, %FALSE if not or @error is set. A #PolkitSubject. @@ -3050,7 +3541,7 @@ asynchronous version. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -3058,19 +3549,19 @@ asynchronous version. Gets a hash code for @subject that can be used with e.g. g_hash_table_new(). - + A hash code. A #PolkitSubject. @@ -3078,20 +3569,20 @@ asynchronous version. Serializes @subject to a string that can be used in polkit_subject_from_string(). - + A string representing @subject. Free with g_free(). A #PolkitSubject. @@ -3099,29 +3590,29 @@ polkit_subject_from_string(). Checks if @a and @b are equal, ie. represent the same subject. However, avoid calling polkit_subject_equal() to compare two processes; for more information see the `PolkitUnixProcess` documentation. This function can be used in e.g. g_hash_table_new(). - + %TRUE if @a and @b are equal, %FALSE otherwise. A #PolkitSubject. A #PolkitSubject. @@ -3129,7 +3620,7 @@ This function can be used in e.g. g_hash_table_new(). Asynchronously checks if @subject exists. When the operation is finished, @callback will be invoked in the @@ -3137,14 +3628,14 @@ When the operation is finished, @callback will be invoked in the main loop</link> of the thread you are calling this method from. You can then call polkit_subject_exists_finish() to get the result of the operation. - + A #PolkitSubject. @@ -3153,7 +3644,7 @@ result of the operation. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -3164,7 +3655,7 @@ result of the operation. scope="async" closure="2"> A #GAsyncReadyCallback to call when the request is satisfied @@ -3173,7 +3664,7 @@ result of the operation. nullable="1" allow-none="1"> The data to pass to @callback. @@ -3183,25 +3674,25 @@ result of the operation. c:identifier="polkit_subject_exists_finish" throws="1"> Finishes checking whether a subject exists. - + %TRUE if the subject exists, %FALSE if not or @error is set. A #PolkitSubject. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to polkit_subject_exists(). @@ -3211,23 +3702,23 @@ result of the operation. c:identifier="polkit_subject_exists_sync" throws="1"> Checks if @subject exists. This is a synchronous blocking call - the calling thread is blocked until a reply is received. See polkit_subject_exists() for the asynchronous version. - + %TRUE if the subject exists, %FALSE if not or @error is set. A #PolkitSubject. @@ -3236,7 +3727,7 @@ asynchronous version. nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -3244,19 +3735,19 @@ asynchronous version. Gets a hash code for @subject that can be used with e.g. g_hash_table_new(). - + A hash code. A #PolkitSubject. @@ -3264,20 +3755,20 @@ asynchronous version. Serializes @subject to a string that can be used in polkit_subject_from_string(). - + A string representing @subject. Free with g_free(). A #PolkitSubject. @@ -3288,28 +3779,28 @@ polkit_subject_from_string(). c:type="PolkitSubjectIface" glib:is-gtype-struct-for="Subject"> An interface for subjects. - + The parent interface. - + A hash code. A #PolkitSubject. @@ -3318,23 +3809,23 @@ polkit_subject_from_string(). - + %TRUE if @a and @b are equal, %FALSE otherwise. A #PolkitSubject. A #PolkitSubject. @@ -3343,17 +3834,17 @@ polkit_subject_from_string(). - + A string representing @subject. Free with g_free(). A #PolkitSubject. @@ -3362,14 +3853,14 @@ polkit_subject_from_string(). - + A #PolkitSubject. @@ -3378,7 +3869,7 @@ polkit_subject_from_string(). nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -3389,7 +3880,7 @@ polkit_subject_from_string(). scope="async" closure="3"> A #GAsyncReadyCallback to call when the request is satisfied @@ -3400,7 +3891,7 @@ polkit_subject_from_string(). allow-none="1" closure="3"> The data to pass to @callback. @@ -3409,23 +3900,23 @@ polkit_subject_from_string(). - + %TRUE if the subject exists, %FALSE if not or @error is set. A #PolkitSubject. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to polkit_subject_exists(). @@ -3434,17 +3925,17 @@ polkit_subject_from_string(). - + %TRUE if the subject exists, %FALSE if not or @error is set. A #PolkitSubject. @@ -3453,7 +3944,7 @@ polkit_subject_from_string(). nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -3468,47 +3959,51 @@ polkit_subject_from_string(). glib:get-type="polkit_system_bus_name_get_type" glib:type-struct="SystemBusNameClass"> An object that represents a process owning a unique name on the system bus. - + filename="src/polkit/polkitsystembusname.c" + line="35">An object that represents a process owning a unique name on the system bus. + Creates a new #PolkitSystemBusName for @name. - + filename="src/polkit/polkitsystembusname.c" + line="193">Creates a new #PolkitSystemBusName for @name. + A #PolkitSystemBusName. Free with g_object_unref(). + filename="src/polkit/polkitsystembusname.c" + line="199">A #PolkitSystemBusName. Free with g_object_unref(). A unique system bus name. + filename="src/polkit/polkitsystembusname.c" + line="195">A unique system bus name. - - Gets the unique system bus name for @system_bus_name. - + + Gets the unique system bus name for @system_bus_name. + The unique system bus name for @system_bus_name. Do not + filename="src/polkit/polkitsystembusname.c" + line="166">The unique system bus name for @system_bus_name. Do not free, this string is owned by @system_bus_name. A #PolkitSystemBusName. + filename="src/polkit/polkitsystembusname.c" + line="162">A #PolkitSystemBusName. @@ -3517,21 +4012,22 @@ free, this string is owned by @system_bus_name. c:identifier="polkit_system_bus_name_get_process_sync" throws="1"> Synchronously gets a #PolkitUnixProcess object for @system_bus_name + filename="src/polkit/polkitsystembusname.c" + line="607">Synchronously gets a #PolkitUnixProcess object for @system_bus_name - the calling thread is blocked until a reply is received. - + A #PolkitUnixProcess object or %NULL if @error is set. + filename="src/polkit/polkitsystembusname.c" + line="616">A #PolkitUnixProcess object or %NULL if @error is set. A #PolkitSystemBusName. + filename="src/polkit/polkitsystembusname.c" + line="609">A #PolkitSystemBusName. nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="src/polkit/polkitsystembusname.c" + line="610">A #GCancellable or %NULL. @@ -3549,21 +4045,22 @@ free, this string is owned by @system_bus_name. c:identifier="polkit_system_bus_name_get_user_sync" throws="1"> Synchronously gets a #PolkitUnixUser object for @system_bus_name; + filename="src/polkit/polkitsystembusname.c" + line="650">Synchronously gets a #PolkitUnixUser object for @system_bus_name; the calling thread is blocked until a reply is received. - + A #PolkitUnixUser object or %NULL if @error is set. + filename="src/polkit/polkitsystembusname.c" + line="659">A #PolkitUnixUser object or %NULL if @error is set. A #PolkitSystemBusName. + filename="src/polkit/polkitsystembusname.c" + line="652">A #PolkitSystemBusName. nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="src/polkit/polkitsystembusname.c" + line="653">A #GCancellable or %NULL. - - Sets the unique system bus name for @system_bus_name. - + + Sets the unique system bus name for @system_bus_name. + A #PolkitSystemBusName. + filename="src/polkit/polkitsystembusname.c" + line="178">A #PolkitSystemBusName. A unique system bus name. + filename="src/polkit/polkitsystembusname.c" + line="179">A unique system bus name. @@ -3603,19 +4103,53 @@ the calling thread is blocked until a reply is received. + transfer-ownership="none" + setter="set_name" + getter="get_name" + default-value="NULL"> The unique name on the system message bus. + filename="src/polkit/polkitsystembusname.c" + line="141">The unique name on the system message bus. - + + + + + + + + + + + + + + + + + + + + + + glib:get-type="polkit_temporary_authorization_get_type" glib:type-struct="TemporaryAuthorizationClass"> Object used to describe a temporary authorization. - + Gets the action that @authorization is for. - + A string owned by @authorization. Do not free. A #PolkitTemporaryAuthorization. @@ -3651,19 +4187,20 @@ the calling thread is blocked until a reply is received. Gets the opaque identifier for @authorization. - + A string owned by @authorization. Do not free. A #PolkitTemporaryAuthorization. @@ -3673,19 +4210,20 @@ the calling thread is blocked until a reply is received. Gets the subject that @authorization is for. - + A #PolkitSubject, free with g_object_unref(). A #PolkitTemporaryAuthorization. @@ -3695,22 +4233,23 @@ the calling thread is blocked until a reply is received. Gets the time when @authorization will expire. (Note that the PolicyKit daemon is using monotonic time internally so the returned value may change if system time changes.) - + Seconds since the Epoch Jan 1. 1970, 0:00 UTC. A #PolkitTemporaryAuthorization. @@ -3720,22 +4259,23 @@ so the returned value may change if system time changes.) Gets the time when @authorization was obtained. (Note that the PolicyKit daemon is using monotonic time internally so the returned value may change if system time changes.) - + Seconds since the Epoch Jan 1. 1970, 0:00 UTC. A #PolkitTemporaryAuthorization. @@ -3746,9 +4286,146 @@ so the returned value may change if system time changes.) - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:get-type="polkit_unix_group_get_type" glib:type-struct="UnixGroupClass"> An object representing a group identity on a UNIX system. - + Creates a new #PolkitUnixGroup object for @gid. - + A #PolkitUnixGroup object. Free with g_object_unref(). A UNIX group id. @@ -3784,64 +4461,68 @@ so the returned value may change if system time changes.) c:identifier="polkit_unix_group_new_for_name" throws="1"> Creates a new #PolkitUnixGroup object for a group with the group name @name. - - + + (allow-none): A #PolkitUnixGroup object or %NULL if @error + filename="src/polkit/polkitunixgroup.c" + line="206">A #PolkitUnixGroup object or %NULL if @error is set. A UNIX group name. - + Gets the UNIX group id for @group. - + A UNIX group id. A #PolkitUnixGroup. - + Sets @gid for @group. - + A #PolkitUnixGroup. A UNIX group id. @@ -3850,9 +4531,12 @@ is set. + transfer-ownership="none" + setter="set_gid" + getter="get_gid" + default-value="-1"> The UNIX group id. @@ -3860,8 +4544,9 @@ is set. - + glib:get-type="polkit_unix_netgroup_get_type" glib:type-struct="UnixNetgroupClass"> An object representing a netgroup identity on a UNIX system. - + Creates a new #PolkitUnixNetgroup object for @name. - + A #PolkitUnixNetgroup object. Free with g_object_unref(). A netgroup name. - + Gets the netgroup name for @group. - + A netgroup name string. A #PolkitUnixNetgroup. - + Sets @name for @group. - + A #PolkitUnixNetgroup. A netgroup name. @@ -3940,9 +4629,12 @@ is set. + transfer-ownership="none" + setter="set_name" + getter="get_name" + default-value="NULL"> The NIS netgroup name. @@ -3950,8 +4642,9 @@ is set. - + glib:get-type="polkit_unix_process_get_type" glib:type-struct="UnixProcessClass"> An object for representing a UNIX process. NOTE: This object as -designed is now known broken; a mechanism to exploit a delay in -start time in the Linux kernel was identified. Avoid + filename="src/polkit/polkitunixprocess.c" + line="52">An object for representing a UNIX process. In order to be reliable and +race-free, this requires support for PID File Descriptors in the kernel, +dbus-daemon/broker and systemd. With this functionality, we can reliably +track processes without risking PID reuse and race conditions, and compare +them. + +NOTE: If PID FDs are not available, this object will fall back to using +PIDs, and this designed is now known broken; a mechanism to exploit a delay +in start time in the Linux kernel was identified. Avoid calling polkit_subject_equal() to compare two processes. To uniquely identify processes, both the process id and the start @@ -3977,28 +4676,28 @@ value as of the time when the operation was made (or, following the open() privilege check model, when the connection making the operation possible was initiated). That is usually done by initializing this with polkit_unix_process_new_for_owner() with trusted data. - + Creates a new #PolkitUnixProcess for @pid. + filename="src/polkit/polkitunixprocess.c" + line="740">Creates a new #PolkitUnixProcess for @pid. The uid and start time of the process will be looked up in using e.g. the <filename>/proc</filename> filesystem depending on the platform in use. - + A #PolkitSubject. Free with g_object_unref(). + filename="src/polkit/polkitunixprocess.c" + line="750">A #PolkitSubject. Free with g_object_unref(). The process id. + filename="src/polkit/polkitunixprocess.c" + line="742">The process id. @@ -4006,130 +4705,246 @@ platform in use. Creates a new #PolkitUnixProcess object for @pid, @start_time and @uid. - + filename="src/polkit/polkitunixprocess.c" + line="783">Creates a new #PolkitUnixProcess object for @pid, @start_time and @uid. + A #PolkitSubject. Free with g_object_unref(). + filename="src/polkit/polkitunixprocess.c" + line="791">A #PolkitSubject. Free with g_object_unref(). The process id. + filename="src/polkit/polkitunixprocess.c" + line="785">The process id. The start time for @pid or 0 to look it up in e.g. <filename>/proc</filename>. + filename="src/polkit/polkitunixprocess.c" + line="786">The start time for @pid or 0 to look it up in e.g. <filename>/proc</filename>. The (real, not effective) uid of the owner of @pid or -1 to look it up in e.g. <filename>/proc</filename>. + filename="src/polkit/polkitunixprocess.c" + line="787">The (real, not effective) uid of the owner of @pid or -1 to look it up in e.g. <filename>/proc</filename>. Creates a new #PolkitUnixProcess object for @pid and @start_time. + filename="src/polkit/polkitunixprocess.c" + line="760">Creates a new #PolkitUnixProcess object for @pid and @start_time. The uid of the process will be looked up in using e.g. the <filename>/proc</filename> filesystem depending on the platform in use. - + A #PolkitSubject. Free with g_object_unref(). + filename="src/polkit/polkitunixprocess.c" + line="771">A #PolkitSubject. Free with g_object_unref(). The process id. + filename="src/polkit/polkitunixprocess.c" + line="762">The process id. The start time for @pid. + filename="src/polkit/polkitunixprocess.c" + line="763">The start time for @pid. + + Creates a new #PolkitUnixProcess object for @pidfd and @uid. + + + A #PolkitSubject. Free with g_object_unref(). + + + + + The process id file descriptor. + + + + The (real, not effective) uid of the owner of @pid or -1 to look it up in e.g. <filename>/proc</filename>. + + + + The (real, not effective) gids of the owner of @pid or %NULL. + + + + + + + + Gets the group ids for @process. Note that this is the real group-ids, +not the effective group-ids. + + + a #GArray + of #gid_t containing the group ids for @process or NULL if unknown, + as a new reference to the array, caller must deref it when done. + + + + + + + + + A #PolkitUnixProcess. + + + + (deprecated) - + filename="src/polkit/polkitunixprocess.c" + line="1269">(deprecated) + A #PolkitUnixProcess. + filename="src/polkit/polkitunixprocess.c" + line="1271">A #PolkitUnixProcess. - + Gets the process id for @process. - + filename="src/polkit/polkitunixprocess.c" + line="595">Gets the process id for @process. + The process id for @process. + filename="src/polkit/polkitunixprocess.c" + line="601">The process id for @process. A #PolkitUnixProcess. + filename="src/polkit/polkitunixprocess.c" + line="597">A #PolkitUnixProcess. + + + + + + Gets the process id file descriptor for @process. + + + The process id file descriptor for @process. + + + + + A #PolkitUnixProcess. + + + + + + Checks if the process id file descriptor for @process is safe +or if it was opened locally and thus vulnerable to reuse. + + + TRUE or FALSE. + + + + + A #PolkitUnixProcess. + c:identifier="polkit_unix_process_get_start_time" + glib:get-property="start-time"> Gets the start time of @process. - + filename="src/polkit/polkitunixprocess.c" + line="623">Gets the start time of @process. + The start time of @process. + filename="src/polkit/polkitunixprocess.c" + line="629">The start time of @process. A #PolkitUnixProcess. + filename="src/polkit/polkitunixprocess.c" + line="625">A #PolkitUnixProcess. - + Gets the user id for @process. Note that this is the real user-id, + filename="src/polkit/polkitunixprocess.c" + line="520">Gets the user id for @process. Note that this is the real user-id, not the effective user-id. NOTE: The UID may change over time, so the returned value may not match the @@ -4137,117 +4952,218 @@ current state of the underlying process; or the UID may have been set by polkit_unix_process_new_for_owner() or polkit_unix_process_set_uid(), in which case it may not correspond to the actual UID of the referenced process at all (at any point in time). - + The user id for @process or -1 if unknown. + filename="src/polkit/polkitunixprocess.c" + line="533">The user id for @process or -1 if unknown. A #PolkitUnixProcess. + filename="src/polkit/polkitunixprocess.c" + line="522">A #PolkitUnixProcess. - + Sets @pid for @process. - + filename="src/polkit/polkitunixprocess.c" + line="575">Sets the (real, not effective) group ids for @process. + A #PolkitUnixProcess. + filename="src/polkit/polkitunixprocess.c" + line="577">A #PolkitUnixProcess. + + + + A #GList of #gid_t containing the group + ids to set for @process or NULL to unset them. + A reference to @gids is taken. + + + + + + + + + + Sets @pid for @process. + + + + + + + A #PolkitUnixProcess. A process id. + filename="src/polkit/polkitunixprocess.c" + line="656">A process id. + + + + + + Sets @pidfd for @process. + + + + + + + A #PolkitUnixProcess. + + + + A process id file descriptor. + c:identifier="polkit_unix_process_set_start_time" + glib:set-property="start-time"> Set the start time of @process. - + filename="src/polkit/polkitunixprocess.c" + line="638">Set the start time of @process. + A #PolkitUnixProcess. + filename="src/polkit/polkitunixprocess.c" + line="640">A #PolkitUnixProcess. The start time for @pid. + filename="src/polkit/polkitunixprocess.c" + line="641">The start time for @pid. - + Sets the (real, not effective) user id for @process. - + filename="src/polkit/polkitunixprocess.c" + line="542">Sets the (real, not effective) user id for @process. + A #PolkitUnixProcess. + filename="src/polkit/polkitunixprocess.c" + line="544">A #PolkitUnixProcess. The user id to set for @process or -1 to unset it. + filename="src/polkit/polkitunixprocess.c" + line="545">The user id to set for @process or -1 to unset it. + + The UNIX group ids of the process. + + + + + transfer-ownership="none" + setter="set_pid" + getter="get_pid" + default-value="0"> + The UNIX process id. + + + The UNIX process id. + filename="src/polkit/polkitunixprocess.c" + line="466">The UNIX process id file descriptor. + + + + transfer-ownership="none" + setter="set_start_time" + getter="get_start_time" + default-value="0"> The start time of the process. + filename="src/polkit/polkitunixprocess.c" + line="447">The start time of the process. + transfer-ownership="none" + setter="set_uid" + getter="get_uid" + default-value="-1"> The UNIX user id of the process or -1 if unknown. + filename="src/polkit/polkitunixprocess.c" + line="426">The UNIX user id of the process or -1 if unknown. Note that this is the real user-id, not the effective user-id. @@ -4256,8 +5172,9 @@ Note that this is the real user-id, not the effective user-id. - + glib:get-type="polkit_unix_session_get_type" glib:type-struct="UnixSessionClass"> An object that represents an user session. The session id is an opaque string obtained from ConsoleKit. - + Creates a new #PolkitUnixSession for @session_id. - + A #PolkitUnixSession. Free with g_object_unref(). The session id. @@ -4297,7 +5214,7 @@ The session id is an opaque string obtained from ConsoleKit. Asynchronously creates a new #PolkitUnixSession object for the process with process id @pid. @@ -4310,14 +5227,14 @@ the operation. This method constructs the object asynchronously, for the synchronous and blocking version use polkit_unix_session_new_for_process_sync(). - + The process id of the process to get the session for. @@ -4326,7 +5243,7 @@ use polkit_unix_session_new_for_process_sync(). nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -4337,7 +5254,7 @@ use polkit_unix_session_new_for_process_sync(). scope="async" closure="3"> A #GAsyncReadyCallback to call when the request is satisfied @@ -4346,7 +5263,7 @@ use polkit_unix_session_new_for_process_sync(). nullable="1" allow-none="1"> The data to pass to @callback. @@ -4356,12 +5273,12 @@ use polkit_unix_session_new_for_process_sync(). c:identifier="polkit_unix_session_new_for_process_finish" throws="1"> Finishes constructing a #PolkitSubject for a process id. - + A #PolkitUnixSession for the @pid passed to polkit_unix_session_new_for_process() or %NULL if @error is set. Free with g_object_unref(). @@ -4370,7 +5287,7 @@ use polkit_unix_session_new_for_process_sync(). A #GAsyncResult obtained from the #GAsyncReadyCallback passed to polkit_unix_session_new_for_process(). @@ -4380,16 +5297,16 @@ use polkit_unix_session_new_for_process_sync(). c:identifier="polkit_unix_session_new_for_process_sync" throws="1"> Creates a new #PolkitUnixSession for the process with process id @pid. This is a synchronous call - the calling thread is blocked until a reply is received. For the asynchronous version, see polkit_unix_session_new_for_process(). - + A #PolkitUnixSession for @pid or %NULL if @error is set. Free with g_object_unref(). @@ -4397,7 +5314,7 @@ polkit_unix_session_new_for_process(). The process id of the process to get the session for. @@ -4406,21 +5323,22 @@ polkit_unix_session_new_for_process(). nullable="1" allow-none="1"> A #GCancellable or %NULL. + c:identifier="polkit_unix_session_get_session_id" + glib:get-property="session-id"> Gets the session id for @session. - + The session id for @session. Do not free this string, it is owned by @session. @@ -4428,31 +5346,32 @@ is owned by @session. A #PolkitUnixSession. + c:identifier="polkit_unix_session_set_session_id" + glib:set-property="session-id"> Sets the session id for @session to @session_id. - + A #PolkitUnixSession. The session id. @@ -4462,18 +5381,22 @@ is owned by @session. readable="0" writable="1" construct-only="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="0"> The UNIX process id to look up the session. + transfer-ownership="none" + setter="set_session_id" + getter="get_session_id" + default-value="NULL"> The UNIX session id. @@ -4481,8 +5404,9 @@ is owned by @session. - + glib:get-type="polkit_unix_user_get_type" glib:type-struct="UnixUserClass"> An object representing a user identity on a UNIX system. - + Creates a new #PolkitUnixUser object for @uid. - + A #PolkitUnixUser object. Free with g_object_unref(). A UNIX user id. @@ -4519,20 +5443,20 @@ is owned by @session. c:identifier="polkit_unix_user_new_for_name" throws="1"> Creates a new #PolkitUnixUser object for a user with the user name @name. - + A #PolkitUnixUser object or %NULL if @error is set. A UNIX user name. @@ -4540,62 +5464,66 @@ is owned by @session. Get the user's name. - + User name string or %NULL if user uid not found. A #PolkitUnixUser. - + Gets the UNIX user id for @user. - + A UNIX user id. A #PolkitUnixUser. - + Sets @uid for @user. - + A #PolkitUnixUser. A UNIX user id. @@ -4604,9 +5532,12 @@ is owned by @session. + transfer-ownership="none" + setter="set_uid" + getter="get_uid" + default-value="-1"> The UNIX user id. @@ -4614,8 +5545,9 @@ is owned by @session. - + moved-to="Identity.from_string" throws="1"> Creates an object from @str that implements the #PolkitIdentity interface. - + A #PolkitIdentity or %NULL if @error is set. Free with g_object_unref(). @@ -4643,7 +5575,7 @@ if @error is set. Free with g_object_unref(). A string obtained from polkit_identity_to_string(). @@ -4652,15 +5584,25 @@ if @error is set. Free with g_object_unref(). - + + A string - + + The location of the resulting deserialization @@ -4669,7 +5611,8 @@ if @error is set. Free with g_object_unref(). - + @@ -4680,18 +5623,23 @@ if @error is set. Free with g_object_unref(). + + Error codes. + Creates an object from @str that implements the #PolkitSubject interface. - + A #PolkitSubject or %NULL if @error is set. Free with g_object_unref(). @@ -4699,7 +5647,7 @@ set. Free with g_object_unref(). A string obtained from polkit_subject_to_string(). diff --git a/girs/PolkitAgent-1.0.gir b/girs/PolkitAgent-1.0.gir index 43d762f9c..483b30d9e 100644 --- a/girs/PolkitAgent-1.0.gir +++ b/girs/PolkitAgent-1.0.gir @@ -15,6 +15,86 @@ and/or use gtk-doc annotations. --> shared-library="libpolkit-agent-1.so.0" c:identifier-prefixes="PolkitAgent" c:symbol-prefixes="polkit_agent"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:get-type="polkit_agent_listener_get_type" glib:type-struct="ListenerClass"> #PolkitAgentListener is an abstract base class used for implementing authentication agents. To implement an authentication agent, simply subclass #PolkitAgentListener and implement the @initiate_authentication and @initiate_authentication_finish methods. @@ -36,13 +116,15 @@ authentication result to the PolicyKit daemon. To register a #PolkitAgentListener with the PolicyKit daemon, use polkit_agent_listener_register() or polkit_agent_listener_register_with_options(). - + Unregisters @listener. - + @@ -52,7 +134,7 @@ polkit_agent_listener_register_with_options(). nullable="1" allow-none="1"> A handle obtained from polkit_agent_listener_register(). @@ -61,7 +143,7 @@ polkit_agent_listener_register_with_options(). Called on a registered authentication agent (see polkit_agent_listener_register()) when the user owning the session needs to prove he is one of the identities listed in @identities. @@ -79,50 +161,51 @@ function can and will use it. Additionally, @callback must be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread that this method is called from. - + A #PolkitAgentListener. The action to authenticate for. The message to present to the user. A themed icon name representing the action or %NULL. Details describing the action. The cookie for the authentication request. A list of #PolkitIdentity objects that the user can choose to authenticate as. @@ -133,7 +216,7 @@ loop</link> of the thread that this method is called from. nullable="1" allow-none="1"> A #GCancellable. @@ -144,7 +227,7 @@ loop</link> of the thread that this method is called from. scope="async" closure="8"> Function to call when the user is done authenticating. @@ -154,7 +237,7 @@ loop</link> of the thread that this method is called from. allow-none="1" closure="8"> Data to pass to @callback. @@ -164,26 +247,27 @@ loop</link> of the thread that this method is called from. invoker="initiate_authentication_finish" throws="1"> Finishes an authentication request from the PolicyKit daemon, see polkit_agent_listener_initiate_authentication() for details. - + %TRUE if @error is set. A #PolkitAgentListener. A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to polkit_agent_listener_initiate_authentication(). @@ -192,7 +276,7 @@ polkit_agent_listener_initiate_authentication() for details. Called on a registered authentication agent (see polkit_agent_listener_register()) when the user owning the session needs to prove he is one of the identities listed in @identities. @@ -210,50 +294,51 @@ function can and will use it. Additionally, @callback must be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread that this method is called from. - + A #PolkitAgentListener. The action to authenticate for. The message to present to the user. A themed icon name representing the action or %NULL. Details describing the action. The cookie for the authentication request. A list of #PolkitIdentity objects that the user can choose to authenticate as. @@ -264,7 +349,7 @@ loop</link> of the thread that this method is called from. nullable="1" allow-none="1"> A #GCancellable. @@ -275,7 +360,7 @@ loop</link> of the thread that this method is called from. scope="async" closure="8"> Function to call when the user is done authenticating. @@ -284,7 +369,7 @@ loop</link> of the thread that this method is called from. nullable="1" allow-none="1"> Data to pass to @callback. @@ -294,26 +379,27 @@ loop</link> of the thread that this method is called from. c:identifier="polkit_agent_listener_initiate_authentication_finish" throws="1"> Finishes an authentication request from the PolicyKit daemon, see polkit_agent_listener_initiate_authentication() for details. - + %TRUE if @error is set. A #PolkitAgentListener. A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to polkit_agent_listener_initiate_authentication(). @@ -323,7 +409,7 @@ polkit_agent_listener_initiate_authentication() for details. c:identifier="polkit_agent_listener_register" throws="1"> Registers @listener with the PolicyKit daemon as an authentication agent for @subject. This is implemented by registering a D-Bus object at @object_path on the unique name assigned by the system @@ -340,10 +426,11 @@ example another authentication agent may already be registered for @subject. Note that the calling thread is blocked until a reply is received. - + %NULL if @error is set, otherwise a registration handle that can be used with polkit_agent_listener_unregister(). @@ -352,25 +439,25 @@ polkit_agent_listener_unregister(). A #PolkitAgentListener. A set of flags from the #PolkitAgentRegisterFlags enumeration. The subject to become an authentication agent for, typically a #PolkitUnixSession object. The D-Bus object path to use for the authentication agent or %NULL for the default object path. @@ -379,7 +466,7 @@ polkit_agent_listener_unregister(). nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -389,13 +476,14 @@ polkit_agent_listener_unregister(). c:identifier="polkit_agent_listener_register_with_options" throws="1"> Like polkit_agent_listener_register() but takes options to influence registration. See the <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgentWithOptions">RegisterAuthenticationAgentWithOptions()</link> D-Bus method for details. - + %NULL if @error is set, otherwise a registration handle that can be used with polkit_agent_listener_unregister(). @@ -404,25 +492,25 @@ polkit_agent_listener_unregister(). A #PolkitAgentListener. A set of flags from the #PolkitAgentRegisterFlags enumeration. The subject to become an authentication agent for, typically a #PolkitUnixSession object. The D-Bus object path to use for the authentication agent or %NULL for the default object path. @@ -431,7 +519,7 @@ polkit_agent_listener_unregister(). nullable="1" allow-none="1"> A #GVariant with options or %NULL. @@ -440,7 +528,7 @@ polkit_agent_listener_unregister(). nullable="1" allow-none="1"> A #GCancellable or %NULL. @@ -454,61 +542,63 @@ polkit_agent_listener_unregister(). c:type="PolkitAgentListenerClass" glib:is-gtype-struct-for="Listener"> VFuncs that authentication agents needs to implement. - + The parent class. - + A #PolkitAgentListener. The action to authenticate for. The message to present to the user. A themed icon name representing the action or %NULL. Details describing the action. The cookie for the authentication request. A list of #PolkitIdentity objects that the user can choose to authenticate as. @@ -519,7 +609,7 @@ polkit_agent_listener_unregister(). nullable="1" allow-none="1"> A #GCancellable. @@ -530,7 +620,7 @@ polkit_agent_listener_unregister(). scope="async" closure="9"> Function to call when the user is done authenticating. @@ -541,7 +631,7 @@ polkit_agent_listener_unregister(). allow-none="1" closure="9"> Data to pass to @callback. @@ -550,23 +640,24 @@ polkit_agent_listener_unregister(). - + %TRUE if @error is set. A #PolkitAgentListener. A #GAsyncResult obtained from the #GAsyncReadyCallback function passed to polkit_agent_listener_initiate_authentication(). @@ -575,7 +666,8 @@ polkit_agent_listener_unregister(). - + @@ -583,7 +675,8 @@ polkit_agent_listener_unregister(). - + @@ -591,7 +684,8 @@ polkit_agent_listener_unregister(). - + @@ -599,7 +693,8 @@ polkit_agent_listener_unregister(). - + @@ -607,7 +702,8 @@ polkit_agent_listener_unregister(). - + @@ -615,7 +711,8 @@ polkit_agent_listener_unregister(). - + @@ -623,7 +720,8 @@ polkit_agent_listener_unregister(). - + @@ -631,7 +729,8 @@ polkit_agent_listener_unregister(). - + @@ -643,25 +742,57 @@ polkit_agent_listener_unregister(). glib:get-type="polkit_agent_register_flags_get_type" c:type="PolkitAgentRegisterFlags"> Flags used in polkit_agent_listener_register(). + glib:nick="none" + glib:name="POLKIT_AGENT_REGISTER_FLAGS_NONE"> No flags are set. + glib:nick="run-in-thread" + glib:name="POLKIT_AGENT_REGISTER_FLAGS_RUN_IN_THREAD"> Run the listener in a dedicated thread. + + + + + + + + + + + + + + + + + + + + + glib:get-type="polkit_agent_session_get_type" glib:type-struct="SessionClass"> The #PolkitAgentSession class is an abstraction used for interacting with the native authentication system (for example PAM) for obtaining authorizations. This class is typically used together with instances that are derived from @@ -693,10 +824,11 @@ with the @gained_authorization paramter set to %TRUE. If the user is unable to authenticate, the #PolkitAgentSession::completed signal will be emitted with the @gained_authorization paramter set to %FALSE. - + Creates a new authentication session. The caller should connect to the @@ -705,23 +837,24 @@ The caller should connect to the #PolkitAgentSession::show-error and #PolkitAgentSession::completed signals and then call polkit_agent_session_initiate() to initiate the authentication session. - + A #PolkitAgentSession. Free with g_object_unref(). The identity to authenticate. The cookie obtained from the PolicyKit daemon @@ -729,17 +862,18 @@ signals and then call polkit_agent_session_initiate() to initiate the authentica Cancels an authentication session. This will make @session emit the #PolkitAgentSession::completed signal. - + A #PolkitAgentSession. @@ -747,7 +881,7 @@ signal. Initiates the authentication session. Before calling this method, make sure to connect to the various signals. The signals will be emitted in the <link @@ -755,14 +889,15 @@ linkend="g-main-context-push-thread-default">thread-default main loop</link> that this method is invoked from. Use polkit_agent_session_cancel() to cancel the session. - + A #PolkitAgentSession. @@ -770,23 +905,24 @@ Use polkit_agent_session_cancel() to cancel the session. Function for providing response to requests received via the #PolkitAgentSession::request signal. - + A #PolkitAgentSession. Response from the user, typically a password. @@ -795,9 +931,10 @@ via the #PolkitAgentSession::request signal. + transfer-ownership="none" + default-value="NULL"> The cookie obtained from the PolicyKit daemon @@ -806,13 +943,13 @@ via the #PolkitAgentSession::request signal. construct-only="1" transfer-ownership="none"> The identity to authenticate. Emitted when the authentication session has been completed or cancelled. The @gained_authorization parameter is %TRUE only if the user successfully authenticated. @@ -824,7 +961,7 @@ Upon receiving this signal, the user should free @session using g_object_unref() %TRUE only if the authorization was successfully obtained. @@ -832,7 +969,7 @@ Upon receiving this signal, the user should free @session using g_object_unref() Emitted when the user is requested to answer a question. When the response has been collected from the user, call polkit_agent_session_response(). @@ -842,13 +979,13 @@ When the response has been collected from the user, call polkit_agent_session_re The request to show the user, e.g. "name: " or "password: ". %TRUE if the response to the request SHOULD be echoed on the screen, %FALSE if the response MUST NOT be echoed to the screen. @@ -857,7 +994,7 @@ When the response has been collected from the user, call polkit_agent_session_re Emitted when there is information related to an error condition to be displayed to the user. @@ -865,7 +1002,7 @@ When the response has been collected from the user, call polkit_agent_session_re An error string to display to the user. @@ -873,7 +1010,7 @@ When the response has been collected from the user, call polkit_agent_session_re Emitted when there is information to be displayed to the user. @@ -881,7 +1018,7 @@ When the response has been collected from the user, call polkit_agent_session_re A string to display to the user. @@ -891,9 +1028,21 @@ When the response has been collected from the user, call polkit_agent_session_re - + + + + + + + + #PolkitAgentTextListener is an #PolkitAgentListener implementation that interacts with the user using a textual interface. @@ -909,16 +1058,17 @@ that interacts with the user using a textual interface. c:identifier="polkit_agent_text_listener_new" throws="1"> Creates a new #PolkitAgentTextListener for authenticating the user + filename="src/polkitagent/polkitagenttextlistener.c" + line="216">Creates a new #PolkitAgentTextListener for authenticating the user via an textual interface on the controlling terminal (e.g. <filename>/dev/tty</filename>). This can fail if e.g. the current process has no controlling terminal. - + A #PolkitAgentTextListener or %NULL if @error is set. Free with g_object_unref() when done with it. + filename="src/polkitagent/polkitagenttextlistener.c" + line="226">A #PolkitAgentTextListener or %NULL if @error is set. Free with g_object_unref() when done with it. @@ -927,39 +1077,74 @@ current process has no controlling terminal. nullable="1" allow-none="1"> A #GCancellable or %NULL. + filename="src/polkitagent/polkitagenttextlistener.c" + line="218">A #GCancellable or %NULL. + + + + + + + + + + + + + + + + + + + (deprecated) - + A #PolkitAgentListener. The subject to become an authentication agent for, typically a #PolkitUnixSession object. The D-Bus object path to use for the authentication agent or %NULL for the default object path. diff --git a/girs/Qmi-1.0.gir b/girs/Qmi-1.0.gir index b731aec38..e19867a62 100644 --- a/girs/Qmi-1.0.gir +++ b/girs/Qmi-1.0.gir @@ -20,8 +20,8 @@ and/or use gtk-doc annotations. --> An opaque type representing a QMI message. - + line="78">An opaque type representing a QMI message. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -546,6 +636,36 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + + + @@ -8729,6 +8849,492 @@ You can then call qmi_client_gms_test_set_value_finish() to get the result of th + + The #QmiClientIms structure contains private data and should only be accessed +using the provided API. + + + Asynchronously sends a Get IMS Services Enabled Setting request to the device. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from. + +You can then call qmi_client_ims_get_ims_services_enabled_setting_finish() to get the result of the operation. + + + + + + + a #QmiClientIms. + + + + %NULL. This message doesn't have any input bundle. + + + + maximum time to wait for the method to complete, in seconds. + + + + a #GCancellable or %NULL. + + + + a #GAsyncReadyCallback to call when the request is satisfied. + + + + user data to pass to @callback. + + + + + + Finishes an async operation started with qmi_client_ims_get_ims_services_enabled_setting(). + + + a #QmiMessageImsGetImsServicesEnabledSettingOutput, or %NULL if @error is set. The returned value should be freed with qmi_message_ims_get_ims_services_enabled_setting_output_unref(). + + + + + a #QmiClientIms. + + + + the #GAsyncResult obtained from the #GAsyncReadyCallback passed to qmi_client_ims_get_ims_services_enabled_setting(). + + + + + + + + + + + + + + + + + + + The #QmiClientImsa structure contains private data and should only be accessed +using the provided API. + + + Asynchronously sends a Get IMS Registration Status request to the device. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from. + +You can then call qmi_client_imsa_get_ims_registration_status_finish() to get the result of the operation. + + + + + + + a #QmiClientImsa. + + + + %NULL. This message doesn't have any input bundle. + + + + maximum time to wait for the method to complete, in seconds. + + + + a #GCancellable or %NULL. + + + + a #GAsyncReadyCallback to call when the request is satisfied. + + + + user data to pass to @callback. + + + + + + Finishes an async operation started with qmi_client_imsa_get_ims_registration_status(). + + + a #QmiMessageImsaGetImsRegistrationStatusOutput, or %NULL if @error is set. The returned value should be freed with qmi_message_imsa_get_ims_registration_status_output_unref(). + + + + + a #QmiClientImsa. + + + + the #GAsyncResult obtained from the #GAsyncReadyCallback passed to qmi_client_imsa_get_ims_registration_status(). + + + + + + Asynchronously sends a Get IMS Services Status request to the device. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from. + +You can then call qmi_client_imsa_get_ims_services_status_finish() to get the result of the operation. + + + + + + + a #QmiClientImsa. + + + + %NULL. This message doesn't have any input bundle. + + + + maximum time to wait for the method to complete, in seconds. + + + + a #GCancellable or %NULL. + + + + a #GAsyncReadyCallback to call when the request is satisfied. + + + + user data to pass to @callback. + + + + + + Finishes an async operation started with qmi_client_imsa_get_ims_services_status(). + + + a #QmiMessageImsaGetImsServicesStatusOutput, or %NULL if @error is set. The returned value should be freed with qmi_message_imsa_get_ims_services_status_output_unref(). + + + + + a #QmiClientImsa. + + + + the #GAsyncResult obtained from the #GAsyncReadyCallback passed to qmi_client_imsa_get_ims_services_status(). + + + + + + + + + + + + + + + + + + + The #QmiClientImsp structure contains private data and should only be accessed +using the provided API. + + + Asynchronously sends a Get Enabler State request to the device. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from. + +You can then call qmi_client_imsp_get_enabler_state_finish() to get the result of the operation. + + + + + + + a #QmiClientImsp. + + + + %NULL. This message doesn't have any input bundle. + + + + maximum time to wait for the method to complete, in seconds. + + + + a #GCancellable or %NULL. + + + + a #GAsyncReadyCallback to call when the request is satisfied. + + + + user data to pass to @callback. + + + + + + Finishes an async operation started with qmi_client_imsp_get_enabler_state(). + + + a #QmiMessageImspGetEnablerStateOutput, or %NULL if @error is set. The returned value should be freed with qmi_message_imsp_get_enabler_state_output_unref(). + + + + + a #QmiClientImsp. + + + + the #GAsyncResult obtained from the #GAsyncReadyCallback passed to qmi_client_imsp_get_enabler_state(). + + + + + + + + + + + + + + + + + + + The #QmiClientSsc structure contains private data and should only be accessed +using the provided API. + + + Asynchronously sends a Control request to the device. + +When the operation is finished, @callback will be invoked in the thread-default main loop of the thread you are calling this method from. + +You can then call qmi_client_ssc_control_finish() to get the result of the operation. + + + + + + + a #QmiClientSsc. + + + + a #QmiMessageSscControlInput. + + + + maximum time to wait for the method to complete, in seconds. + + + + a #GCancellable or %NULL. + + + + a #GAsyncReadyCallback to call when the request is satisfied. + + + + user data to pass to @callback. + + + + + + Finishes an async operation started with qmi_client_ssc_control(). + + + a #QmiMessageSscControlOutput, or %NULL if @error is set. The returned value should be freed with qmi_message_ssc_control_output_unref(). + + + + + a #QmiClientSsc. + + + + the #GAsyncResult obtained from the #GAsyncReadyCallback passed to qmi_client_ssc_control(). + + + + + + + + + + + + The ::report-large signal gets emitted when a '<link linkend="libqmi-glib-SSC-Report-Large-indication.top_of_page">Report Large</link>' indication is received. + + + + + + A #QmiIndicationSscReportLargeOutput. + + + + + + The ::report-small signal gets emitted when a '<link linkend="libqmi-glib-SSC-Report-Small-indication.top_of_page">Report Small</link>' indication is received. + + + + + + A #QmiIndicationSscReportSmallOutput. + + + + + + + + + + + Data Endpoint Type. + line="171">Data Endpoint Type. Unknown. Since 1.30. + line="173">Unknown. Since 1.30. High-speed inter-chip interface. Since 1.30. + line="174">High-speed inter-chip interface. Since 1.30. High-speed USB. + line="175">High-speed USB. PCIe. Since: 1.28. + line="176">PCIe. Since: 1.28. Embedded. Since 1.28. + line="177">Embedded. Since 1.28. BAM/DMUX. Since 1.30. + line="178">BAM/DMUX. Since 1.30. Undefined. + line="179">Undefined. Gets the nickname string for the #QmiDataEndpointType specified at @val. + line="3538">Gets the nickname string for the #QmiDataEndpointType specified at @val. + line="3547"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3544">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDataEndpointType. + line="3540">a QmiDataEndpointType. @@ -29489,7 +30254,7 @@ qmi_device_set_instance_id_finish() to get the result of the operation. The ::device-removed signal is emitted when an unexpected port hang-up is received. + line="3543">The ::device-removed signal is emitted when an unexpected port hang-up is received. @@ -29497,7 +30262,7 @@ qmi_device_set_instance_id_finish() to get the result of the operation. The ::indication signal gets emitted when a QMI indication is received. + line="3522">The ::indication signal gets emitted when a QMI indication is received. @@ -29505,7 +30270,7 @@ qmi_device_set_instance_id_finish() to get the result of the operation. A #QmiMessage. + line="3525">A #QmiMessage. @@ -29571,21 +30336,21 @@ qmi_device_set_instance_id_finish() to get the result of the operation. version="1.30"> Builds a string containing a comma-separated list of nicknames for + line="72">Builds a string containing a comma-separated list of nicknames for each #QmiDeviceAddLinkFlags in @mask. + line="82"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="79">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiDeviceAddLinkFlags values. + line="74">bitmask of QmiDeviceAddLinkFlags values. @@ -29735,20 +30500,20 @@ This type is only applicable when using the qmi_wwan kernel driver. version="1.14"> Gets the nickname string for the #QmiDeviceExpectedDataFormat specified at @val. + line="40">Gets the nickname string for the #QmiDeviceExpectedDataFormat specified at @val. + line="49"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="46">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDeviceExpectedDataFormat. + line="42">a QmiDeviceExpectedDataFormat. @@ -29867,21 +30632,21 @@ This type is only applicable when using the qmi_wwan kernel driver. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="38">Builds a string containing a comma-separated list of nicknames for each #QmiDeviceOpenFlags in @mask. + line="48"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="45">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiDeviceOpenFlags values. + line="40">bitmask of QmiDeviceOpenFlags values. @@ -29924,21 +30689,21 @@ each #QmiDeviceOpenFlags in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="55">Builds a string containing a comma-separated list of nicknames for each #QmiDeviceReleaseClientFlags in @mask. + line="65"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="62">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiDeviceReleaseClientFlags values. + line="57">bitmask of QmiDeviceReleaseClientFlags values. @@ -30083,20 +30848,20 @@ each #QmiDeviceReleaseClientFlags in @mask. version="1.0"> Gets the nickname string for the #QmiDmsActivationState specified at @val. + line="170">Gets the nickname string for the #QmiDmsActivationState specified at @val. + line="179"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="176">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsActivationState. + line="172">a QmiDmsActivationState. @@ -30424,20 +31189,20 @@ This type is bit to bit compatible with #QmiNasBandPreference. version="1.18"> Gets the nickname string for the #QmiDmsBootImageDownloadMode specified at @val. + line="266">Gets the nickname string for the #QmiDmsBootImageDownloadMode specified at @val. + line="275"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="272">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsBootImageDownloadMode. + line="268">a QmiDmsBootImageDownloadMode. @@ -30502,20 +31267,20 @@ This type is bit to bit compatible with #QmiNasBandPreference. version="1.0"> Gets the nickname string for the #QmiDmsDataServiceCapability specified at @val. + line="58">Gets the nickname string for the #QmiDmsDataServiceCapability specified at @val. + line="67"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="64">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsDataServiceCapability. + line="60">a QmiDmsDataServiceCapability. @@ -30553,20 +31318,20 @@ This type is bit to bit compatible with #QmiNasBandPreference. version="1.0"> Gets the nickname string for the #QmiDmsFirmwareImageType specified at @val. + line="250">Gets the nickname string for the #QmiDmsFirmwareImageType specified at @val. + line="259"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="256">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsFirmwareImageType. + line="252">a QmiDmsFirmwareImageType. @@ -30613,20 +31378,20 @@ This type is bit to bit compatible with #QmiNasBandPreference. version="1.26"> Gets the nickname string for the #QmiDmsFoxconnDeviceMode specified at @val. + line="330">Gets the nickname string for the #QmiDmsFoxconnDeviceMode specified at @val. + line="339"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="336">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsFoxconnDeviceMode. + line="332">a QmiDmsFoxconnDeviceMode. @@ -30673,20 +31438,20 @@ This type is bit to bit compatible with #QmiNasBandPreference. version="1.26"> Gets the nickname string for the #QmiDmsFoxconnFirmwareVersionType specified at @val. + line="346">Gets the nickname string for the #QmiDmsFoxconnFirmwareVersionType specified at @val. + line="355"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="352">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsFoxconnFirmwareVersionType. + line="348">a QmiDmsFoxconnFirmwareVersionType. @@ -30715,20 +31480,20 @@ This type is bit to bit compatible with #QmiNasBandPreference. version="1.18"> Gets the nickname string for the #QmiDmsHpDeviceMode specified at @val. + line="298">Gets the nickname string for the #QmiDmsHpDeviceMode specified at @val. + line="307"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="304">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsHpDeviceMode. + line="300">a QmiDmsHpDeviceMode. @@ -31047,20 +31812,20 @@ This type is bit to bit compatible with #QmiNasBandPreference. version="1.26"> Gets the nickname string for the #QmiDmsMacType specified at @val. + line="282">Gets the nickname string for the #QmiDmsMacType specified at @val. + line="291"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="288">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsMacType. + line="284">a QmiDmsMacType. @@ -31115,21 +31880,21 @@ This type is bit to bit compatible with #QmiNasBandPreference. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="108">Builds a string containing a comma-separated list of nicknames for each #QmiDmsOfflineReason in @mask. + line="118"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="115">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiDmsOfflineReason values. + line="110">bitmask of QmiDmsOfflineReason values. @@ -31229,20 +31994,20 @@ each #QmiDmsOfflineReason in @mask. version="1.0"> Gets the nickname string for the #QmiDmsOperatingMode specified at @val. + line="138">Gets the nickname string for the #QmiDmsOperatingMode specified at @val. + line="147"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="144">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsOperatingMode. + line="140">a QmiDmsOperatingMode. @@ -31308,21 +32073,21 @@ If @QMI_DMS_POWER_STATE_FAULT is set, a power fault has been detected. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="91">Builds a string containing a comma-separated list of nicknames for each #QmiDmsPowerState in @mask. + line="101"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="98">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiDmsPowerState values. + line="93">bitmask of QmiDmsPowerState values. @@ -31404,20 +32169,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsRadioInterface specified at @val. + line="90">Gets the nickname string for the #QmiDmsRadioInterface specified at @val. + line="99"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="96">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsRadioInterface. + line="92">a QmiDmsRadioInterface. @@ -31454,20 +32219,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsSimCapability specified at @val. + line="74">Gets the nickname string for the #QmiDmsSimCapability specified at @val. + line="83"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="80">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsSimCapability. + line="76">a QmiDmsSimCapability. @@ -31726,20 +32491,20 @@ each #QmiDmsPowerState in @mask. version="1.20"> Gets the nickname string for the #QmiDmsSwiUsbComposition specified at @val. + line="314">Gets the nickname string for the #QmiDmsSwiUsbComposition specified at @val. + line="323"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="320">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsSwiUsbComposition. + line="316">a QmiDmsSwiUsbComposition. @@ -31768,20 +32533,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsTimeReferenceType specified at @val. + line="234">Gets the nickname string for the #QmiDmsTimeReferenceType specified at @val. + line="243"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="240">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsTimeReferenceType. + line="236">a QmiDmsTimeReferenceType. @@ -31828,20 +32593,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsTimeSource specified at @val. + line="154">Gets the nickname string for the #QmiDmsTimeSource specified at @val. + line="163"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="160">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsTimeSource. + line="156">a QmiDmsTimeSource. @@ -31905,20 +32670,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsUimFacility specified at @val. + line="186">Gets the nickname string for the #QmiDmsUimFacility specified at @val. + line="195"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="192">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsUimFacility. + line="188">a QmiDmsUimFacility. @@ -31964,20 +32729,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsUimFacilityState specified at @val. + line="202">Gets the nickname string for the #QmiDmsUimFacilityState specified at @val. + line="211"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="208">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsUimFacilityState. + line="204">a QmiDmsUimFacilityState. @@ -32014,20 +32779,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsUimPinId specified at @val. + line="106">Gets the nickname string for the #QmiDmsUimPinId specified at @val. + line="115"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="112">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsUimPinId. + line="108">a QmiDmsUimPinId. @@ -32118,20 +32883,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsUimPinStatus specified at @val. + line="122">Gets the nickname string for the #QmiDmsUimPinStatus specified at @val. + line="131"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="128">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsUimPinStatus. + line="124">a QmiDmsUimPinStatus. @@ -32195,20 +32960,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsUimState specified at @val. + line="218">Gets the nickname string for the #QmiDmsUimState specified at @val. + line="227"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="224">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsUimState. + line="220">a QmiDmsUimState. @@ -32317,20 +33082,20 @@ each #QmiDmsPowerState in @mask. version="1.26"> Gets the nickname string for the #QmiDsdApnType specified at @val. + line="364">Gets the nickname string for the #QmiDsdApnType specified at @val. + line="373"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="370">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDsdApnType. + line="366">a QmiDsdApnType. @@ -32479,20 +33244,20 @@ each #QmiDsdApnTypePreference in @mask. version="1.32"> Gets the nickname string for the #QmiDsdDataSystemNetworkType specified at @val. + line="380">Gets the nickname string for the #QmiDsdDataSystemNetworkType specified at @val. + line="389"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="386">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDsdDataSystemNetworkType. + line="382">a QmiDsdDataSystemNetworkType. @@ -32611,20 +33376,20 @@ each #QmiDsdApnTypePreference in @mask. version="1.32"> Gets the nickname string for the #QmiDsdRadioAccessTechnology specified at @val. + line="396">Gets the nickname string for the #QmiDsdRadioAccessTechnology specified at @val. + line="405"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="402">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDsdRadioAccessTechnology. + line="398">a QmiDsdRadioAccessTechnology. @@ -32918,7 +33683,7 @@ each #QmiDsdApnTypePreference in @mask. c:type="QmiEndian"> Type of endianness. + line="157">Type of endianness. glib:name="QMI_ENDIAN_LITTLE"> Little endian. + line="159">Little endian. glib:name="QMI_ENDIAN_BIG"> Big endian. + line="160">Big endian. Gets the nickname string for the #QmiEndian specified at @val. + line="3522">Gets the nickname string for the #QmiEndian specified at @val. + line="3531"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3528">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiEndian. + line="3524">a QmiEndian. @@ -33001,20 +33766,20 @@ each #QmiDsdApnTypePreference in @mask. version="1.32"> Gets the nickname string for the #QmiFoxFirmwareVersionType specified at @val. + line="414">Gets the nickname string for the #QmiFoxFirmwareVersionType specified at @val. + line="423"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="420">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiFoxFirmwareVersionType. + line="416">a QmiFoxFirmwareVersionType. @@ -33061,20 +33826,20 @@ each #QmiDsdApnTypePreference in @mask. version="1.24"> Gets the nickname string for the #QmiGasFirmwareListingMode specified at @val. + line="432">Gets the nickname string for the #QmiGasFirmwareListingMode specified at @val. + line="441"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="438">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiGasFirmwareListingMode. + line="434">a QmiGasFirmwareListingMode. @@ -33112,20 +33877,20 @@ each #QmiDsdApnTypePreference in @mask. version="1.32"> Gets the nickname string for the #QmiGasUsbCompositionEndpointType specified at @val. + line="448">Gets the nickname string for the #QmiGasUsbCompositionEndpointType specified at @val. + line="457"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="454">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiGasUsbCompositionEndpointType. + line="450">a QmiGasUsbCompositionEndpointType. @@ -33290,6 +34055,66 @@ each #QmiDsdApnTypePreference in @mask. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -33450,6 +34275,26 @@ each #QmiDsdApnTypePreference in @mask. + + + + + + + + + + + + + + @@ -33586,6 +34431,262 @@ each #QmiDsdApnTypePreference in @mask. + + IMS registration status. + + no registration for IMS. + + + IMS is registering. + + + IMS is fully registered. + + + IMS is limited registered, expect limited services. + + + Gets the nickname string for the #QmiImsaImsRegistrationStatus specified at @val. + + + a string with the nickname, or %NULL if not found. Do not free the returned value. + + + + + a QmiImsaImsRegistrationStatus. + + + + + + + Network technology on which service is available. + + registered on WLAN interface. + + + registered on WWAN interface. + + + registered on Interworking WLAN interface. + + + Gets the nickname string for the #QmiImsaRegistrationTechnology specified at @val. + + + a string with the nickname, or %NULL if not found. Do not free the returned value. + + + + + a QmiImsaRegistrationTechnology. + + + + + + + IMS Application Service availibility status. + + Service unavailable. + + + Service limited available. + + + Service available. + + + Gets the nickname string for the #QmiImsaServiceStatus specified at @val. + + + a string with the nickname, or %NULL if not found. Do not free the returned value. + + + + + a QmiImsaServiceStatus. + + + + + + + IMS Presence enabler state. + + IMS is not initialized yet. + + + IMS is initialized, but not registered yet with the network IMS service. + + + IMS is initialized but device is in airplane mode. + + + IMS is initialized and registered. + + + Gets the nickname string for the #QmiImspEnablerState specified at @val. + + + a string with the nickname, or %NULL if not found. Do not free the returned value. + + + + + a QmiImspEnablerState. + + + + + + + The #QmiIndicationSscReportLargeOutput structure contains private data and should only be accessed +using the provided API. + + + Get the 'Client ID' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiIndicationSscReportLargeOutput. + + + + a placeholder for the output #guint64, or %NULL if not required. + + + + + + Get the 'Data' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiIndicationSscReportLargeOutput. + + + + a placeholder for the output #GArray of #guint8 elements, or %NULL if not required. Do not free it, it is owned by @self. + + + + + + + + Atomically increments the reference count of @self by one. + + + the new reference to @self. + + + + + a #QmiIndicationSscReportLargeOutput. + + + + + + Atomically decrements the reference count of @self by one. +If the reference count drops to 0, @self is completely disposed. + + + + + + + a #QmiIndicationSscReportLargeOutput. + + + + + + + The #QmiIndicationSscReportSmallOutput structure contains private data and should only be accessed +using the provided API. + + + Get the 'Client ID' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiIndicationSscReportSmallOutput. + + + + a placeholder for the output #guint64, or %NULL if not required. + + + + + + Get the 'Data' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiIndicationSscReportSmallOutput. + + + + a placeholder for the output #GArray of #guint8 elements, or %NULL if not required. Do not free it, it is owned by @self. + + + + + + + + Atomically increments the reference count of @self by one. + + + the new reference to @self. + + + + + a #QmiIndicationSscReportSmallOutput. + + + + + + Atomically decrements the reference count of @self by one. +If the reference count drops to 0, @self is completely disposed. + + + + + + + a #QmiIndicationSscReportSmallOutput. + + + + + version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="195">Builds a string containing a comma-separated list of nicknames for each #QmiLocDeleteCellDatabase in @mask. + line="205"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="202">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocDeleteCellDatabase values. + line="197">bitmask of QmiLocDeleteCellDatabase values. @@ -50682,21 +52053,21 @@ each #QmiLocDeleteCellDatabase in @mask. version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="212">Builds a string containing a comma-separated list of nicknames for each #QmiLocDeleteClockInfo in @mask. + line="222"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="219">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocDeleteClockInfo values. + line="214">bitmask of QmiLocDeleteClockInfo values. @@ -50875,21 +52246,21 @@ Since 1.22 version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="178">Builds a string containing a comma-separated list of nicknames for each #QmiLocDeleteSvInfo in @mask. + line="188"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="185">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocDeleteSvInfo values. + line="180">bitmask of QmiLocDeleteSvInfo values. @@ -50927,20 +52298,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocEngineState specified at @val. + line="614">Gets the nickname string for the #QmiLocEngineState specified at @val. + line="623"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="620">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocEngineState. + line="616">a QmiLocEngineState. @@ -51120,20 +52491,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocFixRecurrenceType specified at @val. + line="582">Gets the nickname string for the #QmiLocFixRecurrenceType specified at @val. + line="591"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="588">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocFixRecurrenceType. + line="584">a QmiLocFixRecurrenceType. @@ -51172,20 +52543,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocHealthStatus specified at @val. + line="678">Gets the nickname string for the #QmiLocHealthStatus specified at @val. + line="687"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="684">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocHealthStatus. + line="680">a QmiLocHealthStatus. @@ -51268,20 +52639,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocIndicationStatus specified at @val. + line="550">Gets the nickname string for the #QmiLocIndicationStatus specified at @val. + line="559"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="556">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocIndicationStatus. + line="552">a QmiLocIndicationStatus. @@ -51327,20 +52698,20 @@ Since 1.22 version="1.20"> Gets the nickname string for the #QmiLocIntermediateReportState specified at @val. + line="534">Gets the nickname string for the #QmiLocIntermediateReportState specified at @val. + line="543"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="540">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocIntermediateReportState. + line="536">a QmiLocIntermediateReportState. @@ -51396,20 +52767,20 @@ Since 1.22 version="1.28"> Gets the nickname string for the #QmiLocLockType specified at @val. + line="758">Gets the nickname string for the #QmiLocLockType specified at @val. + line="767"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="764">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocLockType. + line="760">a QmiLocLockType. @@ -51447,20 +52818,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocNavigationData specified at @val. + line="694">Gets the nickname string for the #QmiLocNavigationData specified at @val. + line="703"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="700">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocNavigationData. + line="696">a QmiLocNavigationData. @@ -51551,21 +52922,21 @@ Since 1.22 version="1.26"> Builds a string containing a comma-separated list of nicknames for + line="229">Builds a string containing a comma-separated list of nicknames for each #QmiLocNmeaType in @mask. + line="239"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="236">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocNmeaType values. + line="231">bitmask of QmiLocNmeaType values. @@ -51639,20 +53010,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocOperationMode specified at @val. + line="598">Gets the nickname string for the #QmiLocOperationMode specified at @val. + line="607"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="604">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocOperationMode. + line="600">a QmiLocOperationMode. @@ -51680,20 +53051,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocPredictedOrbitsDataFormat specified at @val. + line="742">Gets the nickname string for the #QmiLocPredictedOrbitsDataFormat specified at @val. + line="751"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="748">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocPredictedOrbitsDataFormat. + line="744">a QmiLocPredictedOrbitsDataFormat. @@ -51759,20 +53130,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocReliability specified at @val. + line="630">Gets the nickname string for the #QmiLocReliability specified at @val. + line="639"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="636">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocReliability. + line="632">a QmiLocReliability. @@ -51819,20 +53190,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocSatelliteStatus specified at @val. + line="710">Gets the nickname string for the #QmiLocSatelliteStatus specified at @val. + line="719"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="716">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocSatelliteStatus. + line="712">a QmiLocSatelliteStatus. @@ -51924,21 +53295,21 @@ Since 1.22 version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="144">Builds a string containing a comma-separated list of nicknames for each #QmiLocSatelliteValidInformation in @mask. + line="154"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="151">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocSatelliteValidInformation values. + line="146">bitmask of QmiLocSatelliteValidInformation values. @@ -52045,21 +53416,21 @@ Since 1.22 version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="161">Builds a string containing a comma-separated list of nicknames for each #QmiLocServerAddressType in @mask. + line="171"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="168">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocServerAddressType values. + line="163">bitmask of QmiLocServerAddressType values. @@ -52124,20 +53495,20 @@ each #QmiLocServerAddressType in @mask. version="1.22"> Gets the nickname string for the #QmiLocServerType specified at @val. + line="726">Gets the nickname string for the #QmiLocServerType specified at @val. + line="735"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="732">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocServerType. + line="728">a QmiLocServerType. @@ -52229,20 +53600,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocSessionStatus specified at @val. + line="566">Gets the nickname string for the #QmiLocSessionStatus specified at @val. + line="575"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="572">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocSessionStatus. + line="568">a QmiLocSessionStatus. @@ -52307,20 +53678,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocSystem specified at @val. + line="662">Gets the nickname string for the #QmiLocSystem specified at @val. + line="671"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="668">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocSystem. + line="664">a QmiLocSystem. @@ -52412,21 +53783,21 @@ Since 1.22 version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="127">Builds a string containing a comma-separated list of nicknames for each #QmiLocTechnologyUsed in @mask. + line="137"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="134">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocTechnologyUsed values. + line="129">bitmask of QmiLocTechnologyUsed values. @@ -52599,20 +53970,20 @@ Since 1.22 version="1.22"> Gets the nickname string for the #QmiLocTimeSource specified at @val. + line="646">Gets the nickname string for the #QmiLocTimeSource specified at @val. + line="655"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="652">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocTimeSource. + line="648">a QmiLocTimeSource. @@ -52624,10 +53995,23 @@ Since 1.22 version="1.0"> First byte of every QMI message. + line="57">First byte of every QMI QMUX message. + + Fake header added by libqmi to re-use existing QMUX message parsers for QRTR messages. +QRTR QMI services with a service ID > 0xFF use this fake header where the service ID +is set to 16 bits instead of 8 bits. This header has no purpose outside of libqmi +and is never send to the actual device implementing these QMI services. + + + version="1.0"> Callback type to use when iterating raw TLVs with + line="970">Callback type to use when iterating raw TLVs with qmi_message_foreach_raw_tlv(). - + @@ -68780,19 +70164,19 @@ qmi_message_foreach_raw_tlv(). specific ID of the TLV. + line="972">specific ID of the TLV. value of the TLV. + line="973">value of the TLV. length of the TLV, in bytes. + line="974">length of the TLV, in bytes. closure="3"> user data. + line="975">user data. @@ -71411,6 +72795,1149 @@ If the reference count drops to 0, @self is completely disposed. + + The #QmiMessageImsGetImsServicesEnabledSettingOutput structure contains private data and should only be accessed +using the provided API. + + + Get the 'IMS Registration Service Enabled' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsGetImsServicesEnabledSettingOutput. + + + + a placeholder for the output #gboolean, or %NULL if not required. + + + + + + Get the 'IMS SMS Service Enabled' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsGetImsServicesEnabledSettingOutput. + + + + a placeholder for the output #gboolean, or %NULL if not required. + + + + + + Get the 'IMS USSD Service Enabled' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsGetImsServicesEnabledSettingOutput. + + + + a placeholder for the output #gboolean, or %NULL if not required. + + + + + + Get the 'IMS UT Service Enabled' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsGetImsServicesEnabledSettingOutput. + + + + a placeholder for the output #gboolean, or %NULL if not required. + + + + + + Get the 'IMS Video Telephony Service Enabled' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsGetImsServicesEnabledSettingOutput. + + + + a placeholder for the output #gboolean, or %NULL if not required. + + + + + + Get the 'IMS Voice Service Enabled' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsGetImsServicesEnabledSettingOutput. + + + + a placeholder for the output #gboolean, or %NULL if not required. + + + + + + Get the 'IMS Voice WiFi Service Enabled' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsGetImsServicesEnabledSettingOutput. + + + + a placeholder for the output #gboolean, or %NULL if not required. + + + + + + Get the result of the QMI operation. + + + %TRUE if the QMI operation succeeded, %FALSE if @error is set. + + + + + a QmiMessageImsGetImsServicesEnabledSettingOutput. + + + + + + Atomically increments the reference count of @self by one. + + + the new reference to @self. + + + + + a #QmiMessageImsGetImsServicesEnabledSettingOutput. + + + + + + Atomically decrements the reference count of @self by one. +If the reference count drops to 0, @self is completely disposed. + + + + + + + a #QmiMessageImsGetImsServicesEnabledSettingOutput. + + + + + + + The #QmiMessageImsaGetImsRegistrationStatusOutput structure contains private data and should only be accessed +using the provided API. + + + Get the 'IMS Registration Error Code' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsRegistrationStatusOutput. + + + + a placeholder for the output #guint16, or %NULL if not required. + + + + + + Get the 'IMS Registration Error Message' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsRegistrationStatusOutput. + + + + a placeholder for the output constant string, or %NULL if not required. + + + + + + Get the 'IMS Registration Status' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsRegistrationStatusOutput. + + + + a placeholder for the output #QmiImsaImsRegistrationStatus, or %NULL if not required. + + + + + + Get the 'IMS Registration Technology' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsRegistrationStatusOutput. + + + + a placeholder for the output #QmiImsaRegistrationTechnology, or %NULL if not required. + + + + + + Get the result of the QMI operation. + + + %TRUE if the QMI operation succeeded, %FALSE if @error is set. + + + + + a QmiMessageImsaGetImsRegistrationStatusOutput. + + + + + + Atomically increments the reference count of @self by one. + + + the new reference to @self. + + + + + a #QmiMessageImsaGetImsRegistrationStatusOutput. + + + + + + Atomically decrements the reference count of @self by one. +If the reference count drops to 0, @self is completely disposed. + + + + + + + a #QmiMessageImsaGetImsRegistrationStatusOutput. + + + + + + + The #QmiMessageImsaGetImsServicesStatusOutput structure contains private data and should only be accessed +using the provided API. + + + Get the 'IMS SMS Service Registration Technology' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + a placeholder for the output #QmiImsaRegistrationTechnology, or %NULL if not required. + + + + + + Get the 'IMS SMS Service Status' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + a placeholder for the output #QmiImsaServiceStatus, or %NULL if not required. + + + + + + Get the 'IMS UE to TAS Service Registration Technology' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + a placeholder for the output #QmiImsaRegistrationTechnology, or %NULL if not required. + + + + + + Get the 'IMS UE to TAS Service Status' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + a placeholder for the output #QmiImsaServiceStatus, or %NULL if not required. + + + + + + Get the 'IMS Video Share Service Registration Technology' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + a placeholder for the output #QmiImsaRegistrationTechnology, or %NULL if not required. + + + + + + Get the 'IMS Video Share Service Status' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + a placeholder for the output #QmiImsaServiceStatus, or %NULL if not required. + + + + + + Get the 'IMS Video Telephony Service Registration Technology' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + a placeholder for the output #QmiImsaRegistrationTechnology, or %NULL if not required. + + + + + + Get the 'IMS Video Telephony Service Status' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + a placeholder for the output #QmiImsaServiceStatus, or %NULL if not required. + + + + + + Get the 'IMS Voice Service Registration Technology' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + a placeholder for the output #QmiImsaRegistrationTechnology, or %NULL if not required. + + + + + + Get the 'IMS Voice Service Status' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + a placeholder for the output #QmiImsaServiceStatus, or %NULL if not required. + + + + + + Get the result of the QMI operation. + + + %TRUE if the QMI operation succeeded, %FALSE if @error is set. + + + + + a QmiMessageImsaGetImsServicesStatusOutput. + + + + + + Atomically increments the reference count of @self by one. + + + the new reference to @self. + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + + + Atomically decrements the reference count of @self by one. +If the reference count drops to 0, @self is completely disposed. + + + + + + + a #QmiMessageImsaGetImsServicesStatusOutput. + + + + + + + The #QmiMessageImspGetEnablerStateOutput structure contains private data and should only be accessed +using the provided API. + + + Get the 'Enabler State' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageImspGetEnablerStateOutput. + + + + a placeholder for the output #QmiImspEnablerState, or %NULL if not required. + + + + + + Get the result of the QMI operation. + + + %TRUE if the QMI operation succeeded, %FALSE if @error is set. + + + + + a QmiMessageImspGetEnablerStateOutput. + + + + + + Atomically increments the reference count of @self by one. + + + the new reference to @self. + + + + + a #QmiMessageImspGetEnablerStateOutput. + + + + + + Atomically decrements the reference count of @self by one. +If the reference count drops to 0, @self is completely disposed. + + + + + + + a #QmiMessageImspGetEnablerStateOutput. + + + + + + + The #QmiMessageSscControlInput structure contains private data and should only be accessed +using the provided API. + + + Allocates a new #QmiMessageSscControlInput. + + + the newly created #QmiMessageSscControlInput. The returned value should be freed with qmi_message_ssc_control_input_unref(). + + + + + Get the 'Data' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageSscControlInput. + + + + a placeholder for the output #GArray of #guint8 elements, or %NULL if not required. Do not free it, it is owned by @self. + + + + + + + + Get the 'Report Type' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageSscControlInput. + + + + a placeholder for the output #QmiSscReportType, or %NULL if not required. + + + + + + Atomically increments the reference count of @self by one. + + + the new reference to @self. + + + + + a #QmiMessageSscControlInput. + + + + + + Set the 'Data' field in the message. + + + %TRUE if @value was successfully set, %FALSE otherwise. + + + + + a #QmiMessageSscControlInput. + + + + a #GArray of #guint8 elements. A new reference to @value_data will be taken, so the caller must make sure the array was created with the correct #GDestroyNotify as clear function for each element in the array. + + + + + + + + Set the 'Report Type' field in the message. + + + %TRUE if @value was successfully set, %FALSE otherwise. + + + + + a #QmiMessageSscControlInput. + + + + a #QmiSscReportType. + + + + + + Atomically decrements the reference count of @self by one. +If the reference count drops to 0, @self is completely disposed. + + + + + + + a #QmiMessageSscControlInput. + + + + + + + The #QmiMessageSscControlOutput structure contains private data and should only be accessed +using the provided API. + + + Get the 'Client ID' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageSscControlOutput. + + + + a placeholder for the output #guint64, or %NULL if not required. + + + + + + Get the 'Response' field from @self. + + + %TRUE if the field is found, %FALSE otherwise. + + + + + a #QmiMessageSscControlOutput. + + + + a placeholder for the output #guint32, or %NULL if not required. + + + + + + Get the result of the QMI operation. + + + %TRUE if the QMI operation succeeded, %FALSE if @error is set. + + + + + a QmiMessageSscControlOutput. + + + + + + Atomically increments the reference count of @self by one. + + + the new reference to @self. + + + + + a #QmiMessageSscControlOutput. + + + + + + Atomically decrements the reference count of @self by one. +If the reference count drops to 0, @self is completely disposed. + + + + + + + a #QmiMessageSscControlOutput. + + + + + version="1.0"> Gets the nickname string for the #QmiNasActiveBand specified at @val. + line="792">Gets the nickname string for the #QmiNasActiveBand specified at @val. + line="801"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="798">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasActiveBand. + line="794">a QmiNasActiveBand. @@ -158847,20 +161747,20 @@ If the reference count drops to 0, @self is completely disposed. version="1.0"> Gets the nickname string for the #QmiNasAttachState specified at @val. + line="904">Gets the nickname string for the #QmiNasAttachState specified at @val. + line="913"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="910">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasAttachState. + line="906">a QmiNasAttachState. @@ -159197,20 +162097,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.28"> Gets the nickname string for the #QmiNasBoolean specified at @val. + line="1592">Gets the nickname string for the #QmiNasBoolean specified at @val. + line="1601"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1598">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasBoolean. + line="1594">a QmiNasBoolean. @@ -159274,20 +162174,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasCallBarringStatus specified at @val. + line="1000">Gets the nickname string for the #QmiNasCallBarringStatus specified at @val. + line="1009"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1006">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasCallBarringStatus. + line="1002">a QmiNasCallBarringStatus. @@ -159325,20 +162225,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasCdmaPilotType specified at @val. + line="1304">Gets the nickname string for the #QmiNasCdmaPilotType specified at @val. + line="1313"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1310">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasCdmaPilotType. + line="1306">a QmiNasCdmaPilotType. @@ -159384,20 +162284,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasCdmaPrlPreference specified at @val. + line="1064">Gets the nickname string for the #QmiNasCdmaPrlPreference specified at @val. + line="1073"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1070">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasCdmaPrlPreference. + line="1066">a QmiNasCdmaPrlPreference. @@ -159444,20 +162344,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasCellBroadcastCapability specified at @val. + line="1272">Gets the nickname string for the #QmiNasCellBroadcastCapability specified at @val. + line="1281"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1278">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasCellBroadcastCapability. + line="1274">a QmiNasCellBroadcastCapability. @@ -159495,20 +162395,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasChangeDuration specified at @val. + line="1112">Gets the nickname string for the #QmiNasChangeDuration specified at @val. + line="1121"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1118">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasChangeDuration. + line="1114">a QmiNasChangeDuration. @@ -159599,20 +162499,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.16"> Gets the nickname string for the #QmiNasDLBandwidth specified at @val. + line="1368">Gets the nickname string for the #QmiNasDLBandwidth specified at @val. + line="1377"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1374">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasDLBandwidth. + line="1370">a QmiNasDLBandwidth. @@ -159757,20 +162657,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasDataCapability specified at @val. + line="952">Gets the nickname string for the #QmiNasDataCapability specified at @val. + line="961"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="958">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasDataCapability. + line="954">a QmiNasDataCapability. @@ -159852,20 +162752,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.4"> Gets the nickname string for the #QmiNasDayOfWeek specified at @val. + line="1320">Gets the nickname string for the #QmiNasDayOfWeek specified at @val. + line="1329"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1326">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasDayOfWeek. + line="1322">a QmiNasDayOfWeek. @@ -159911,20 +162811,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.4"> Gets the nickname string for the #QmiNasDaylightSavingsAdjustment specified at @val. + line="1336">Gets the nickname string for the #QmiNasDaylightSavingsAdjustment specified at @val. + line="1345"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1342">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasDaylightSavingsAdjustment. + line="1338">a QmiNasDaylightSavingsAdjustment. @@ -159989,20 +162889,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.28"> Gets the nickname string for the #QmiNasDrx specified at @val. + line="1576">Gets the nickname string for the #QmiNasDrx specified at @val. + line="1585"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1582">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasDrx. + line="1578">a QmiNasDrx. @@ -160102,20 +163002,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasEvdoSinrLevel specified at @val. + line="824">Gets the nickname string for the #QmiNasEvdoSinrLevel specified at @val. + line="833"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="830">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasEvdoSinrLevel. + line="826">a QmiNasEvdoSinrLevel. @@ -160161,20 +163061,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasGsmWcdmaAcquisitionOrderPreference specified at @val. + line="1144">Gets the nickname string for the #QmiNasGsmWcdmaAcquisitionOrderPreference specified at @val. + line="1153"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1150">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasGsmWcdmaAcquisitionOrderPreference. + line="1146">a QmiNasGsmWcdmaAcquisitionOrderPreference. @@ -160221,20 +163121,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasHdrPersonality specified at @val. + line="984">Gets the nickname string for the #QmiNasHdrPersonality specified at @val. + line="993"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="990">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasHdrPersonality. + line="986">a QmiNasHdrPersonality. @@ -160289,20 +163189,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasHdrProtocolRevision specified at @val. + line="1240">Gets the nickname string for the #QmiNasHdrProtocolRevision specified at @val. + line="1249"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1246">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasHdrProtocolRevision. + line="1242">a QmiNasHdrProtocolRevision. @@ -160649,20 +163549,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.24"> Gets the nickname string for the #QmiNasLteCellAccessStatus specified at @val. + line="1224">Gets the nickname string for the #QmiNasLteCellAccessStatus specified at @val. + line="1233"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1230">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasLteCellAccessStatus. + line="1226">a QmiNasLteCellAccessStatus. @@ -160727,20 +163627,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.24"> Gets the nickname string for the #QmiNasLteRegistrationDomain specified at @val. + line="1192">Gets the nickname string for the #QmiNasLteRegistrationDomain specified at @val. + line="1201"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1198">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasLteRegistrationDomain. + line="1194">a QmiNasLteRegistrationDomain. @@ -160796,20 +163696,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.28"> Gets the nickname string for the #QmiNasLteVoiceDomain specified at @val. + line="1624">Gets the nickname string for the #QmiNasLteVoiceDomain specified at @val. + line="1633"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1630">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasLteVoiceDomain. + line="1626">a QmiNasLteVoiceDomain. @@ -160855,20 +163755,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasNetworkDescriptionDisplay specified at @val. + line="1016">Gets the nickname string for the #QmiNasNetworkDescriptionDisplay specified at @val. + line="1025"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1022">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkDescriptionDisplay. + line="1018">a QmiNasNetworkDescriptionDisplay. @@ -160924,20 +163824,20 @@ This type is bit to bit compatible with #QmiDmsBandCapability. version="1.0"> Gets the nickname string for the #QmiNasNetworkDescriptionEncoding specified at @val. + line="1032">Gets the nickname string for the #QmiNasNetworkDescriptionEncoding specified at @val. + line="1041"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1038">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkDescriptionEncoding. + line="1034">a QmiNasNetworkDescriptionEncoding. @@ -160982,21 +163882,21 @@ SPN display is required in this case. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="367">Builds a string containing a comma-separated list of nicknames for each #QmiNasNetworkNameDisplayCondition in @mask. + line="377"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="374">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasNetworkNameDisplayCondition values. + line="369">bitmask of QmiNasNetworkNameDisplayCondition values. @@ -161079,20 +163979,20 @@ each #QmiNasNetworkNameDisplayCondition in @mask. version="1.24"> Gets the nickname string for the #QmiNasNetworkNameSource specified at @val. + line="1432">Gets the nickname string for the #QmiNasNetworkNameSource specified at @val. + line="1441"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1438">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkNameSource. + line="1434">a QmiNasNetworkNameSource. @@ -161130,20 +164030,20 @@ each #QmiNasNetworkNameDisplayCondition in @mask. version="1.0"> Gets the nickname string for the #QmiNasNetworkRegisterType specified at @val. + line="856">Gets the nickname string for the #QmiNasNetworkRegisterType specified at @val. + line="865"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="862">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkRegisterType. + line="858">a QmiNasNetworkRegisterType. @@ -161190,20 +164090,20 @@ each #QmiNasNetworkNameDisplayCondition in @mask. version="1.24"> Gets the nickname string for the #QmiNasNetworkScanResult specified at @val. + line="840">Gets the nickname string for the #QmiNasNetworkScanResult specified at @val. + line="849"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="846">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkScanResult. + line="842">a QmiNasNetworkScanResult. @@ -161259,21 +164159,21 @@ each #QmiNasNetworkNameDisplayCondition in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="265">Builds a string containing a comma-separated list of nicknames for each #QmiNasNetworkScanType in @mask. + line="275"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="272">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasNetworkScanType values. + line="267">bitmask of QmiNasNetworkScanType values. @@ -161310,20 +164210,20 @@ each #QmiNasNetworkScanType in @mask. version="1.0"> Gets the nickname string for the #QmiNasNetworkSelectionPreference specified at @val. + line="1096">Gets the nickname string for the #QmiNasNetworkSelectionPreference specified at @val. + line="1105"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1102">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkSelectionPreference. + line="1098">a QmiNasNetworkSelectionPreference. @@ -161370,20 +164270,20 @@ each #QmiNasNetworkScanType in @mask. version="1.24"> Gets the nickname string for the #QmiNasNetworkSelectionRegistrationRestriction specified at @val. + line="1176">Gets the nickname string for the #QmiNasNetworkSelectionRegistrationRestriction specified at @val. + line="1185"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1182">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkSelectionRegistrationRestriction. + line="1178">a QmiNasNetworkSelectionRegistrationRestriction. @@ -161448,20 +164348,20 @@ each #QmiNasNetworkScanType in @mask. version="1.0"> Gets the nickname string for the #QmiNasNetworkServiceDomain specified at @val. + line="808">Gets the nickname string for the #QmiNasNetworkServiceDomain specified at @val. + line="817"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="814">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkServiceDomain. + line="810">a QmiNasNetworkServiceDomain. @@ -161553,21 +164453,21 @@ each #QmiNasNetworkScanType in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="282">Builds a string containing a comma-separated list of nicknames for each #QmiNasNetworkStatus in @mask. + line="292"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="289">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasNetworkStatus values. + line="284">bitmask of QmiNasNetworkStatus values. @@ -161613,20 +164513,20 @@ each #QmiNasNetworkStatus in @mask. version="1.0"> Gets the nickname string for the #QmiNasNetworkType specified at @val. + line="920">Gets the nickname string for the #QmiNasNetworkType specified at @val. + line="929"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="926">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkType. + line="922">a QmiNasNetworkType. @@ -161709,21 +164609,21 @@ ETSI TS 131 102, chapter 4.2.5. version="1.30"> Builds a string containing a comma-separated list of nicknames for + line="299">Builds a string containing a comma-separated list of nicknames for each #QmiNasPlmnAccessTechnologyIdentifier in @mask. + line="309"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="306">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasPlmnAccessTechnologyIdentifier values. + line="301">bitmask of QmiNasPlmnAccessTechnologyIdentifier values. @@ -161762,20 +164662,20 @@ information element". version="1.18"> Gets the nickname string for the #QmiNasPlmnEncodingScheme specified at @val. + line="1400">Gets the nickname string for the #QmiNasPlmnEncodingScheme specified at @val. + line="1409"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1406">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPlmnEncodingScheme. + line="1402">a QmiNasPlmnEncodingScheme. @@ -161822,20 +164722,20 @@ information element". version="1.28"> Gets the nickname string for the #QmiNasPlmnLanguageId specified at @val. + line="1608">Gets the nickname string for the #QmiNasPlmnLanguageId specified at @val. + line="1617"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1614">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPlmnLanguageId. + line="1610">a QmiNasPlmnLanguageId. @@ -161882,20 +164782,20 @@ section "Network Name information element". version="1.18"> Gets the nickname string for the #QmiNasPlmnNameCountryInitials specified at @val. + line="1416">Gets the nickname string for the #QmiNasPlmnNameCountryInitials specified at @val. + line="1425"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1422">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPlmnNameCountryInitials. + line="1418">a QmiNasPlmnNameCountryInitials. @@ -161988,20 +164888,20 @@ section "Network Name information element". version="1.18"> Gets the nickname string for the #QmiNasPlmnNameSpareBits specified at @val. + line="1448">Gets the nickname string for the #QmiNasPlmnNameSpareBits specified at @val. + line="1457"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1454">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPlmnNameSpareBits. + line="1450">a QmiNasPlmnNameSpareBits. @@ -162084,20 +164984,20 @@ section "Network Name information element". version="1.0"> Gets the nickname string for the #QmiNasPreferenceDuration specified at @val. + line="1048">Gets the nickname string for the #QmiNasPreferenceDuration specified at @val. + line="1057"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1054">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPreferenceDuration. + line="1050">a QmiNasPreferenceDuration. @@ -162135,20 +165035,20 @@ section "Network Name information element". version="1.20"> Gets the nickname string for the #QmiNasPsAttachAction specified at @val. + line="872">Gets the nickname string for the #QmiNasPsAttachAction specified at @val. + line="881"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="878">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPsAttachAction. + line="874">a QmiNasPsAttachAction. @@ -162257,20 +165157,20 @@ section "Network Name information element". version="1.0"> Gets the nickname string for the #QmiNasRadioInterface specified at @val. + line="776">Gets the nickname string for the #QmiNasRadioInterface specified at @val. + line="785"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="782">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRadioInterface. + line="778">a QmiNasRadioInterface. @@ -162352,21 +165252,21 @@ section "Network Name information element". version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="316">Builds a string containing a comma-separated list of nicknames for each #QmiNasRadioTechnologyPreference in @mask. + line="326"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="323">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasRadioTechnologyPreference values. + line="318">bitmask of QmiNasRadioTechnologyPreference values. @@ -162449,21 +165349,21 @@ each #QmiNasRadioTechnologyPreference in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="333">Builds a string containing a comma-separated list of nicknames for each #QmiNasRatModePreference in @mask. + line="343"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="340">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasRatModePreference values. + line="335">bitmask of QmiNasRatModePreference values. @@ -162528,20 +165428,20 @@ each #QmiNasRatModePreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasRegistrationState specified at @val. + line="888">Gets the nickname string for the #QmiNasRegistrationState specified at @val. + line="897"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="894">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRegistrationState. + line="890">a QmiNasRegistrationState. @@ -163104,20 +166004,20 @@ annex G) and in 3GPP TS 24.301 in section 9.9.3.9. version="1.30"> Gets the nickname string for the #QmiNasRejectCause specified at @val. + line="1640">Gets the nickname string for the #QmiNasRejectCause specified at @val. + line="1649"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1646">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRejectCause. + line="1642">a QmiNasRejectCause. @@ -163154,20 +166054,20 @@ annex G) and in 3GPP TS 24.301 in section 9.9.3.9. version="1.0"> Gets the nickname string for the #QmiNasRoamingIndicatorStatus specified at @val. + line="936">Gets the nickname string for the #QmiNasRoamingIndicatorStatus specified at @val. + line="945"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="942">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRoamingIndicatorStatus. + line="938">a QmiNasRoamingIndicatorStatus. @@ -163223,20 +166123,20 @@ annex G) and in 3GPP TS 24.301 in section 9.9.3.9. version="1.0"> Gets the nickname string for the #QmiNasRoamingPreference specified at @val. + line="1080">Gets the nickname string for the #QmiNasRoamingPreference specified at @val. + line="1089"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1086">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRoamingPreference. + line="1082">a QmiNasRoamingPreference. @@ -163373,20 +166273,20 @@ annex G) and in 3GPP TS 24.301 in section 9.9.3.9. version="1.0"> Gets the nickname string for the #QmiNasRoamingStatus specified at @val. + line="1208">Gets the nickname string for the #QmiNasRoamingStatus specified at @val. + line="1217"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1214">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRoamingStatus. + line="1210">a QmiNasRoamingStatus. @@ -163432,20 +166332,20 @@ annex G) and in 3GPP TS 24.301 in section 9.9.3.9. version="1.16"> Gets the nickname string for the #QmiNasScellState specified at @val. + line="1384">Gets the nickname string for the #QmiNasScellState specified at @val. + line="1393"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1390">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasScellState. + line="1386">a QmiNasScellState. @@ -163509,20 +166409,20 @@ annex G) and in 3GPP TS 24.301 in section 9.9.3.9. version="1.0"> Gets the nickname string for the #QmiNasServiceDomainPreference specified at @val. + line="1128">Gets the nickname string for the #QmiNasServiceDomainPreference specified at @val. + line="1137"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1134">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasServiceDomainPreference. + line="1130">a QmiNasServiceDomainPreference. @@ -163587,20 +166487,20 @@ annex G) and in 3GPP TS 24.301 in section 9.9.3.9. version="1.0"> Gets the nickname string for the #QmiNasServiceStatus specified at @val. + line="968">Gets the nickname string for the #QmiNasServiceStatus specified at @val. + line="977"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="974">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasServiceStatus. + line="970">a QmiNasServiceStatus. @@ -163700,21 +166600,21 @@ annex G) and in 3GPP TS 24.301 in section 9.9.3.9. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="248">Builds a string containing a comma-separated list of nicknames for each #QmiNasSignalStrengthRequest in @mask. + line="258"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="255">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasSignalStrengthRequest values. + line="250">bitmask of QmiNasSignalStrengthRequest values. @@ -163779,20 +166679,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.0"> Gets the nickname string for the #QmiNasSimRejectState specified at @val. + line="1288">Gets the nickname string for the #QmiNasSimRejectState specified at @val. + line="1297"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1294">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSimRejectState. + line="1290">a QmiNasSimRejectState. @@ -163856,20 +166756,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiEmmConnectionState specified at @val. + line="1560">Gets the nickname string for the #QmiNasSwiEmmConnectionState specified at @val. + line="1569"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1566">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiEmmConnectionState. + line="1562">a QmiNasSwiEmmConnectionState. @@ -163961,20 +166861,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiEmmState specified at @val. + line="1544">Gets the nickname string for the #QmiNasSwiEmmState specified at @val. + line="1553"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1550">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiEmmState. + line="1546">a QmiNasSwiEmmState. @@ -164047,20 +166947,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiImsRegState specified at @val. + line="1512">Gets the nickname string for the #QmiNasSwiImsRegState specified at @val. + line="1521"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1518">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiImsRegState. + line="1514">a QmiNasSwiImsRegState. @@ -164196,20 +167096,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiModemMode specified at @val. + line="1480">Gets the nickname string for the #QmiNasSwiModemMode specified at @val. + line="1489"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1486">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiModemMode. + line="1482">a QmiNasSwiModemMode. @@ -164255,20 +167155,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiPsState specified at @val. + line="1528">Gets the nickname string for the #QmiNasSwiPsState specified at @val. + line="1537"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1534">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiPsState. + line="1530">a QmiNasSwiPsState. @@ -164377,20 +167277,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiSystemMode specified at @val. + line="1496">Gets the nickname string for the #QmiNasSwiSystemMode specified at @val. + line="1505"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1502">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiSystemMode. + line="1498">a QmiNasSwiSystemMode. @@ -164463,21 +167363,21 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="350">Builds a string containing a comma-separated list of nicknames for each #QmiNasTdScdmaBandPreference in @mask. + line="360"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="357">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasTdScdmaBandPreference values. + line="352">bitmask of QmiNasTdScdmaBandPreference values. @@ -164524,20 +167424,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.24"> Gets the nickname string for the #QmiNasUsagePreference specified at @val. + line="1464">Gets the nickname string for the #QmiNasUsagePreference specified at @val. + line="1473"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1470">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasUsagePreference. + line="1466">a QmiNasUsagePreference. @@ -164592,20 +167492,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.24"> Gets the nickname string for the #QmiNasVoiceDomainPreference specified at @val. + line="1160">Gets the nickname string for the #QmiNasVoiceDomainPreference specified at @val. + line="1169"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1166">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasVoiceDomainPreference. + line="1162">a QmiNasVoiceDomainPreference. @@ -164697,20 +167597,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasWcdmaHsService specified at @val. + line="1256">Gets the nickname string for the #QmiNasWcdmaHsService specified at @val. + line="1265"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1262">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasWcdmaHsService. + line="1258">a QmiNasWcdmaHsService. @@ -164774,20 +167674,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.10"> Gets the nickname string for the #QmiNasWcdmaRrcState specified at @val. + line="1352">Gets the nickname string for the #QmiNasWcdmaRrcState specified at @val. + line="1361"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1358">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasWcdmaRrcState. + line="1354">a QmiNasWcdmaRrcState. @@ -164833,20 +167733,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.6"> Gets the nickname string for the #QmiOmaHfaFeatureDoneState specified at @val. + line="1706">Gets the nickname string for the #QmiOmaHfaFeatureDoneState specified at @val. + line="1715"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1712">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiOmaHfaFeatureDoneState. + line="1708">a QmiOmaHfaFeatureDoneState. @@ -164920,20 +167820,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.6"> Gets the nickname string for the #QmiOmaSessionFailedReason specified at @val. + line="1690">Gets the nickname string for the #QmiOmaSessionFailedReason specified at @val. + line="1699"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1696">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiOmaSessionFailedReason. + line="1692">a QmiOmaSessionFailedReason. @@ -165052,20 +167952,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.6"> Gets the nickname string for the #QmiOmaSessionState specified at @val. + line="1674">Gets the nickname string for the #QmiOmaSessionState specified at @val. + line="1683"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1680">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiOmaSessionState. + line="1676">a QmiOmaSessionState. @@ -165147,20 +168047,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.6"> Gets the nickname string for the #QmiOmaSessionType specified at @val. + line="1658">Gets the nickname string for the #QmiOmaSessionType specified at @val. + line="1667"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1664">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiOmaSessionType. + line="1660">a QmiOmaSessionType. @@ -165278,21 +168178,21 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.6"> Builds a string containing a comma-separated list of nicknames for + line="386">Builds a string containing a comma-separated list of nicknames for each #QmiPbmEventRegistrationFlag in @mask. + line="396"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="393">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiPbmEventRegistrationFlag values. + line="388">bitmask of QmiPbmEventRegistrationFlag values. @@ -165384,21 +168284,21 @@ each #QmiPbmEventRegistrationFlag in @mask. version="1.6"> Builds a string containing a comma-separated list of nicknames for + line="403">Builds a string containing a comma-separated list of nicknames for each #QmiPbmPhonebookType in @mask. + line="413"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="410">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiPbmPhonebookType values. + line="405">bitmask of QmiPbmPhonebookType values. @@ -165489,20 +168389,20 @@ each #QmiPbmPhonebookType in @mask. version="1.6"> Gets the nickname string for the #QmiPbmSessionType specified at @val. + line="1724">Gets the nickname string for the #QmiPbmSessionType specified at @val. + line="1733"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1730">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPbmSessionType. + line="1726">a QmiPbmSessionType. @@ -165539,20 +168439,20 @@ each #QmiPbmPhonebookType in @mask. version="1.18"> Gets the nickname string for the #QmiPdcConfigurationType specified at @val. + line="1742">Gets the nickname string for the #QmiPdcConfigurationType specified at @val. + line="1751"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1748">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdcConfigurationType. + line="1744">a QmiPdcConfigurationType. @@ -165599,20 +168499,20 @@ each #QmiPbmPhonebookType in @mask. version="1.32"> Gets the nickname string for the #QmiPdcRefreshEventType specified at @val. + line="1758">Gets the nickname string for the #QmiPdcRefreshEventType specified at @val. + line="1767"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1764">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdcRefreshEventType. + line="1760">a QmiPdcRefreshEventType. @@ -165838,21 +168738,21 @@ each #QmiPbmPhonebookType in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="422">Builds a string containing a comma-separated list of nicknames for each #QmiPdsDataValid in @mask. + line="432"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="429">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiPdsDataValid values. + line="424">bitmask of QmiPdsDataValid values. @@ -165889,20 +168789,20 @@ each #QmiPdsDataValid in @mask. version="1.12"> Gets the nickname string for the #QmiPdsNetworkMode specified at @val. + line="1840">Gets the nickname string for the #QmiPdsNetworkMode specified at @val. + line="1849"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1846">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdsNetworkMode. + line="1842">a QmiPdsNetworkMode. @@ -165948,20 +168848,20 @@ each #QmiPdsDataValid in @mask. version="1.12"> Gets the nickname string for the #QmiPdsOperatingMode specified at @val. + line="1824">Gets the nickname string for the #QmiPdsOperatingMode specified at @val. + line="1833"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1830">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdsOperatingMode. + line="1826">a QmiPdsOperatingMode. @@ -166016,20 +168916,20 @@ each #QmiPdsDataValid in @mask. version="1.0"> Gets the nickname string for the #QmiPdsOperationMode specified at @val. + line="1776">Gets the nickname string for the #QmiPdsOperationMode specified at @val. + line="1785"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1782">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdsOperationMode. + line="1778">a QmiPdsOperationMode. @@ -166129,20 +169029,20 @@ each #QmiPdsDataValid in @mask. version="1.0"> Gets the nickname string for the #QmiPdsPositionSessionStatus specified at @val. + line="1792">Gets the nickname string for the #QmiPdsPositionSessionStatus specified at @val. + line="1801"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1798">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdsPositionSessionStatus. + line="1794">a QmiPdsPositionSessionStatus. @@ -166189,20 +169089,20 @@ each #QmiPdsDataValid in @mask. version="1.0"> Gets the nickname string for the #QmiPdsTrackingSessionState specified at @val. + line="1808">Gets the nickname string for the #QmiPdsTrackingSessionState specified at @val. + line="1817"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1814">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdsTrackingSessionState. + line="1810">a QmiPdsTrackingSessionState. @@ -167601,20 +170501,20 @@ using the provided API. version="1.22"> Gets the nickname string for the #QmiQosEvent specified at @val. + line="1874">Gets the nickname string for the #QmiQosEvent specified at @val. + line="1883"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1880">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiQosEvent. + line="1876">a QmiQosEvent. @@ -167669,20 +170569,20 @@ using the provided API. version="1.22"> Gets the nickname string for the #QmiQosStatus specified at @val. + line="1858">Gets the nickname string for the #QmiQosStatus specified at @val. + line="1867"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1864">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiQosStatus. + line="1860">a QmiQosStatus. @@ -167890,20 +170790,20 @@ using the provided API. version="1.28"> Gets the nickname string for the #QmiSarRfState specified at @val. + line="1892">Gets the nickname string for the #QmiSarRfState specified at @val. + line="1901"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1898">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiSarRfState. + line="1894">a QmiSarRfState. @@ -168356,7 +171256,7 @@ using the provided API. glib:name="QMI_SERVICE_FOTA"> Firmware Over The Air service. Since: 1.24. + line="90">Firmware Over The Air service. Since: 1.24. glib:name="QMI_SERVICE_GMS"> Telit General Modem Service. Since: 1.24. + line="91">Telit General Modem Service. Since: 1.24. glib:name="QMI_SERVICE_GAS"> Telit General Application Service. Since: 1.24. + line="92">Telit General Application Service. Since: 1.24. glib:name="QMI_SERVICE_ATR"> Telit AT Relay Service. Since: 1.34. + line="93">Telit AT Relay Service. Since: 1.34. + + + Snapdragon Sensore Core Service. Since: 1.34. Gets the nickname string for the #QmiService specified at @val. + line="3506">Gets the nickname string for the #QmiService specified at @val. + line="3515"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3512">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiService. + line="3508">a QmiService. @@ -168449,7 +171358,7 @@ using the provided API. c:type="QmiSioPort"> SIO (serial I/O) port numbers. All ports available in the modem have a SIO + line="195">SIO (serial I/O) port numbers. All ports available in the modem have a SIO port number. This enum is incomplete, only few port numbers are publicly known. glib:name="QMI_SIO_PORT_NONE"> Invalid port number. + line="197">Invalid port number. glib:name="QMI_SIO_PORT_A2_MUX_RMNET0"> A2 MUX (BAM-DMUX) port for rmnet0. + line="198">A2 MUX (BAM-DMUX) port for rmnet0. glib:name="QMI_SIO_PORT_A2_MUX_RMNET1"> A2 MUX (BAM-DMUX) port for rmnet1. + line="199">A2 MUX (BAM-DMUX) port for rmnet1. glib:name="QMI_SIO_PORT_A2_MUX_RMNET2"> A2 MUX (BAM-DMUX) port for rmnet2. + line="200">A2 MUX (BAM-DMUX) port for rmnet2. glib:name="QMI_SIO_PORT_A2_MUX_RMNET3"> A2 MUX (BAM-DMUX) port for rmnet3. + line="201">A2 MUX (BAM-DMUX) port for rmnet3. glib:name="QMI_SIO_PORT_A2_MUX_RMNET4"> A2 MUX (BAM-DMUX) port for rmnet4. + line="202">A2 MUX (BAM-DMUX) port for rmnet4. glib:name="QMI_SIO_PORT_A2_MUX_RMNET5"> A2 MUX (BAM-DMUX) port for rmnet5. + line="203">A2 MUX (BAM-DMUX) port for rmnet5. glib:name="QMI_SIO_PORT_A2_MUX_RMNET6"> A2 MUX (BAM-DMUX) port for rmnet6. + line="204">A2 MUX (BAM-DMUX) port for rmnet6. glib:name="QMI_SIO_PORT_A2_MUX_RMNET7"> A2 MUX (BAM-DMUX) port for rmnet7. + line="205">A2 MUX (BAM-DMUX) port for rmnet7. Gets the nickname string for the #QmiSioPort specified at @val. + line="3554">Gets the nickname string for the #QmiSioPort specified at @val. + line="3563"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3560">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiSioPort. + line="3556">a QmiSioPort. @@ -168577,6 +171486,56 @@ known. + + SSC service report types. + + Small size report. + + + Large size report. + + + Gets the nickname string for the #QmiSscReportType specified at @val. + + + a string with the nickname, or %NULL if not found. Do not free the returned value. + + + + + a QmiSscReportType. + + + + + version="1.10"> Gets the nickname string for the #QmiUimCardApplicationPersonalizationFeature specified at @val. + line="2088">Gets the nickname string for the #QmiUimCardApplicationPersonalizationFeature specified at @val. + line="2097"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2094">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardApplicationPersonalizationFeature. + line="2090">a QmiUimCardApplicationPersonalizationFeature. @@ -168938,20 +171897,20 @@ known. version="1.34"> Gets the nickname string for the #QmiUimCardApplicationPersonalizationFeatureStatus specified at @val. + line="2104">Gets the nickname string for the #QmiUimCardApplicationPersonalizationFeatureStatus specified at @val. + line="2113"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2110">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardApplicationPersonalizationFeatureStatus. + line="2106">a QmiUimCardApplicationPersonalizationFeatureStatus. @@ -169025,20 +171984,20 @@ known. version="1.10"> Gets the nickname string for the #QmiUimCardApplicationPersonalizationState specified at @val. + line="2072">Gets the nickname string for the #QmiUimCardApplicationPersonalizationState specified at @val. + line="2081"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2078">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardApplicationPersonalizationState. + line="2074">a QmiUimCardApplicationPersonalizationState. @@ -169130,20 +172089,20 @@ known. version="1.10"> Gets the nickname string for the #QmiUimCardApplicationState specified at @val. + line="2056">Gets the nickname string for the #QmiUimCardApplicationState specified at @val. + line="2065"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2062">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardApplicationState. + line="2058">a QmiUimCardApplicationState. @@ -169217,20 +172176,20 @@ known. version="1.10"> Gets the nickname string for the #QmiUimCardApplicationType specified at @val. + line="2040">Gets the nickname string for the #QmiUimCardApplicationType specified at @val. + line="2049"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2046">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardApplicationType. + line="2042">a QmiUimCardApplicationType. @@ -169322,20 +172281,20 @@ known. version="1.10"> Gets the nickname string for the #QmiUimCardError specified at @val. + line="2024">Gets the nickname string for the #QmiUimCardError specified at @val. + line="2033"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2030">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardError. + line="2026">a QmiUimCardError. @@ -169381,20 +172340,20 @@ known. version="1.26"> Gets the nickname string for the #QmiUimCardProtocol specified at @val. + line="2184">Gets the nickname string for the #QmiUimCardProtocol specified at @val. + line="2193"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2190">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardProtocol. + line="2186">a QmiUimCardProtocol. @@ -169440,20 +172399,20 @@ known. version="1.10"> Gets the nickname string for the #QmiUimCardState specified at @val. + line="1992">Gets the nickname string for the #QmiUimCardState specified at @val. + line="2001"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1998">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardState. + line="1994">a QmiUimCardState. @@ -169500,21 +172459,21 @@ items are returned. version="1.30"> Builds a string containing a comma-separated list of nicknames for + line="475">Builds a string containing a comma-separated list of nicknames for each #QmiUimConfiguration in @mask. + line="485"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="482">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiUimConfiguration values. + line="477">bitmask of QmiUimConfiguration values. @@ -169551,20 +172510,20 @@ each #QmiUimConfiguration in @mask. version="1.30"> Gets the nickname string for the #QmiUimDepersonalizationOperation specified at @val. + line="2200">Gets the nickname string for the #QmiUimDepersonalizationOperation specified at @val. + line="2209"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2206">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimDepersonalizationOperation. + line="2202">a QmiUimDepersonalizationOperation. @@ -169620,21 +172579,21 @@ each #QmiUimConfiguration in @mask. version="1.22.4"> Builds a string containing a comma-separated list of nicknames for + line="441">Builds a string containing a comma-separated list of nicknames for each #QmiUimEventRegistrationFlag in @mask. + line="451"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="448">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiUimEventRegistrationFlag values. + line="443">bitmask of QmiUimEventRegistrationFlag values. @@ -169699,20 +172658,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.6"> Gets the nickname string for the #QmiUimFileType specified at @val. + line="1944">Gets the nickname string for the #QmiUimFileType specified at @val. + line="1953"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1950">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimFileType. + line="1946">a QmiUimFileType. @@ -169758,20 +172717,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.26"> Gets the nickname string for the #QmiUimPhysicalCardState specified at @val. + line="2152">Gets the nickname string for the #QmiUimPhysicalCardState specified at @val. + line="2161"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2158">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimPhysicalCardState. + line="2154">a QmiUimPhysicalCardState. @@ -169836,20 +172795,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.14"> Gets the nickname string for the #QmiUimPinId specified at @val. + line="1976">Gets the nickname string for the #QmiUimPinId specified at @val. + line="1985"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1982">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimPinId. + line="1978">a QmiUimPinId. @@ -169922,20 +172881,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.10"> Gets the nickname string for the #QmiUimPinState specified at @val. + line="2008">Gets the nickname string for the #QmiUimPinState specified at @val. + line="2017"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2014">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimPinState. + line="2010">a QmiUimPinState. @@ -170017,20 +172976,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.28"> Gets the nickname string for the #QmiUimRefreshMode specified at @val. + line="2136">Gets the nickname string for the #QmiUimRefreshMode specified at @val. + line="2145"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2142">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimRefreshMode. + line="2138">a QmiUimRefreshMode. @@ -170085,20 +173044,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.28"> Gets the nickname string for the #QmiUimRefreshStage specified at @val. + line="2120">Gets the nickname string for the #QmiUimRefreshStage specified at @val. + line="2129"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2126">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimRefreshStage. + line="2122">a QmiUimRefreshStage. @@ -170153,21 +173112,21 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.6"> Builds a string containing a comma-separated list of nicknames for + line="458">Builds a string containing a comma-separated list of nicknames for each #QmiUimSecurityAttribute in @mask. + line="468"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="465">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiUimSecurityAttribute values. + line="460">bitmask of QmiUimSecurityAttribute values. @@ -170232,20 +173191,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.6"> Gets the nickname string for the #QmiUimSecurityAttributeLogic specified at @val. + line="1960">Gets the nickname string for the #QmiUimSecurityAttributeLogic specified at @val. + line="1969"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1966">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimSecurityAttributeLogic. + line="1962">a QmiUimSecurityAttributeLogic. @@ -170490,20 +173449,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.6"> Gets the nickname string for the #QmiUimSessionType specified at @val. + line="1928">Gets the nickname string for the #QmiUimSessionType specified at @val. + line="1937"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1934">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimSessionType. + line="1930">a QmiUimSessionType. @@ -170540,20 +173499,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.26"> Gets the nickname string for the #QmiUimSlotState specified at @val. + line="2168">Gets the nickname string for the #QmiUimSlotState specified at @val. + line="2177"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2174">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimSlotState. + line="2170">a QmiUimSlotState. @@ -170590,20 +173549,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.26"> Gets the nickname string for the #QmiVoiceAlphaDataCodingScheme specified at @val. + line="2410">Gets the nickname string for the #QmiVoiceAlphaDataCodingScheme specified at @val. + line="2419"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2416">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceAlphaDataCodingScheme. + line="2412">a QmiVoiceAlphaDataCodingScheme. @@ -170641,20 +173600,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoiceAls specified at @val. + line="2282">Gets the nickname string for the #QmiVoiceAls specified at @val. + line="2291"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2288">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceAls. + line="2284">a QmiVoiceAls. @@ -170700,20 +173659,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.26"> Gets the nickname string for the #QmiVoiceCallControlResultType specified at @val. + line="2442">Gets the nickname string for the #QmiVoiceCallControlResultType specified at @val. + line="2451"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2448">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallControlResultType. + line="2444">a QmiVoiceCallControlResultType. @@ -170796,20 +173755,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.26"> Gets the nickname string for the #QmiVoiceCallControlSupplementaryServiceType specified at @val. + line="2458">Gets the nickname string for the #QmiVoiceCallControlSupplementaryServiceType specified at @val. + line="2467"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2464">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallControlSupplementaryServiceType. + line="2460">a QmiVoiceCallControlSupplementaryServiceType. @@ -170856,20 +173815,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoiceCallDirection specified at @val. + line="2250">Gets the nickname string for the #QmiVoiceCallDirection specified at @val. + line="2259"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2256">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallDirection. + line="2252">a QmiVoiceCallDirection. @@ -172662,20 +175621,20 @@ service connection being terminated. version="1.26"> Gets the nickname string for the #QmiVoiceCallEndReason specified at @val. + line="2426">Gets the nickname string for the #QmiVoiceCallEndReason specified at @val. + line="2435"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2432">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallEndReason. + line="2428">a QmiVoiceCallEndReason. @@ -172739,20 +175698,20 @@ service connection being terminated. version="1.14"> Gets the nickname string for the #QmiVoiceCallMode specified at @val. + line="2266">Gets the nickname string for the #QmiVoiceCallMode specified at @val. + line="2275"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2272">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallMode. + line="2268">a QmiVoiceCallMode. @@ -172870,20 +175829,20 @@ service connection being terminated. version="1.14"> Gets the nickname string for the #QmiVoiceCallState specified at @val. + line="2218">Gets the nickname string for the #QmiVoiceCallState specified at @val. + line="2227"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2224">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallState. + line="2220">a QmiVoiceCallState. @@ -172956,20 +175915,20 @@ service connection being terminated. version="1.14"> Gets the nickname string for the #QmiVoiceCallType specified at @val. + line="2234">Gets the nickname string for the #QmiVoiceCallType specified at @val. + line="2243"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2240">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallType. + line="2236">a QmiVoiceCallType. @@ -173024,20 +175983,20 @@ service connection being terminated. version="1.14"> Gets the nickname string for the #QmiVoiceDomain specified at @val. + line="2362">Gets the nickname string for the #QmiVoiceDomain specified at @val. + line="2371"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2368">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceDomain. + line="2364">a QmiVoiceDomain. @@ -173092,20 +176051,20 @@ service connection being terminated. version="1.14"> Gets the nickname string for the #QmiVoicePresentation specified at @val. + line="2298">Gets the nickname string for the #QmiVoicePresentation specified at @val. + line="2307"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2304">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoicePresentation. + line="2300">a QmiVoicePresentation. @@ -173142,20 +176101,20 @@ service connection being terminated. version="1.14"> Gets the nickname string for the #QmiVoicePrivacy specified at @val. + line="2346">Gets the nickname string for the #QmiVoicePrivacy specified at @val. + line="2355"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2352">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoicePrivacy. + line="2348">a QmiVoicePrivacy. @@ -173264,20 +176223,20 @@ service connection being terminated. version="1.14"> Gets the nickname string for the #QmiVoiceServiceOption specified at @val. + line="2330">Gets the nickname string for the #QmiVoiceServiceOption specified at @val. + line="2339"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2336">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceServiceOption. + line="2332">a QmiVoiceServiceOption. @@ -173332,20 +176291,20 @@ service connection being terminated. version="1.30"> Gets the nickname string for the #QmiVoiceSupplementaryServiceAction specified at @val. + line="2506">Gets the nickname string for the #QmiVoiceSupplementaryServiceAction specified at @val. + line="2515"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2512">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceSupplementaryServiceAction. + line="2508">a QmiVoiceSupplementaryServiceAction. @@ -173518,20 +176477,20 @@ service connection being terminated. version="1.30"> Gets the nickname string for the #QmiVoiceSupplementaryServiceNotificationType specified at @val. + line="2490">Gets the nickname string for the #QmiVoiceSupplementaryServiceNotificationType specified at @val. + line="2499"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2496">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceSupplementaryServiceNotificationType. + line="2492">a QmiVoiceSupplementaryServiceNotificationType. @@ -173686,20 +176645,20 @@ service connection being terminated. version="1.30"> Gets the nickname string for the #QmiVoiceSupplementaryServiceReason specified at @val. + line="2522">Gets the nickname string for the #QmiVoiceSupplementaryServiceReason specified at @val. + line="2531"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2528">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceSupplementaryServiceReason. + line="2524">a QmiVoiceSupplementaryServiceReason. @@ -173818,20 +176777,20 @@ service connection being terminated. version="1.30"> Gets the nickname string for the #QmiVoiceSupplementaryServiceType specified at @val. + line="2474">Gets the nickname string for the #QmiVoiceSupplementaryServiceType specified at @val. + line="2483"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2480">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceSupplementaryServiceType. + line="2476">a QmiVoiceSupplementaryServiceType. @@ -173887,20 +176846,20 @@ service connection being terminated. version="1.14"> Gets the nickname string for the #QmiVoiceTtyMode specified at @val. + line="2314">Gets the nickname string for the #QmiVoiceTtyMode specified at @val. + line="2323"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2320">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceTtyMode. + line="2316">a QmiVoiceTtyMode. @@ -173946,20 +176905,20 @@ service connection being terminated. version="1.26"> Gets the nickname string for the #QmiVoiceUserAction specified at @val. + line="2378">Gets the nickname string for the #QmiVoiceUserAction specified at @val. + line="2387"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2384">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceUserAction. + line="2380">a QmiVoiceUserAction. @@ -174014,20 +176973,20 @@ service connection being terminated. version="1.26"> Gets the nickname string for the #QmiVoiceUssDataCodingScheme specified at @val. + line="2394">Gets the nickname string for the #QmiVoiceUssDataCodingScheme specified at @val. + line="2403"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2400">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceUssDataCodingScheme. + line="2396">a QmiVoiceUssDataCodingScheme. @@ -174092,21 +177051,21 @@ service connection being terminated. version="1.14"> Builds a string containing a comma-separated list of nicknames for + line="494">Builds a string containing a comma-separated list of nicknames for each #QmiVoiceWcdmaAmrStatus in @mask. + line="504"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="501">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiVoiceWcdmaAmrStatus values. + line="496">bitmask of QmiVoiceWcdmaAmrStatus values. @@ -174225,20 +177184,20 @@ each #QmiVoiceWcdmaAmrStatus in @mask. version="1.10"> Gets the nickname string for the #QmiWdaDataAggregationProtocol specified at @val. + line="2556">Gets the nickname string for the #QmiWdaDataAggregationProtocol specified at @val. + line="2565"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2562">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdaDataAggregationProtocol. + line="2558">a QmiWdaDataAggregationProtocol. @@ -174285,20 +177244,20 @@ each #QmiVoiceWcdmaAmrStatus in @mask. version="1.10"> Gets the nickname string for the #QmiWdaLinkLayerProtocol specified at @val. + line="2540">Gets the nickname string for the #QmiWdaLinkLayerProtocol specified at @val. + line="2549"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2546">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdaLinkLayerProtocol. + line="2542">a QmiWdaLinkLayerProtocol. @@ -174376,20 +177335,20 @@ each #QmiVoiceWcdmaAmrStatus in @mask. version="1.28"> Gets the nickname string for the #QmiWdsAttachPdnListAction specified at @val. + line="3150">Gets the nickname string for the #QmiWdsAttachPdnListAction specified at @val. + line="3159"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3156">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsAttachPdnListAction. + line="3152">a QmiWdsAttachPdnListAction. @@ -174436,21 +177395,21 @@ each #QmiVoiceWcdmaAmrStatus in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="649">Builds a string containing a comma-separated list of nicknames for each #QmiWdsAuthentication in @mask. + line="659"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="656">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsAuthentication values. + line="651">bitmask of QmiWdsAuthentication values. @@ -174496,20 +177455,20 @@ each #QmiWdsAuthentication in @mask. version="1.14"> Gets the nickname string for the #QmiWdsAutoconnectSetting specified at @val. + line="2990">Gets the nickname string for the #QmiWdsAutoconnectSetting specified at @val. + line="2999"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2996">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsAutoconnectSetting. + line="2992">a QmiWdsAutoconnectSetting. @@ -174547,20 +177506,20 @@ each #QmiWdsAuthentication in @mask. version="1.14"> Gets the nickname string for the #QmiWdsAutoconnectSettingRoaming specified at @val. + line="3006">Gets the nickname string for the #QmiWdsAutoconnectSettingRoaming specified at @val. + line="3015"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3012">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsAutoconnectSettingRoaming. + line="3008">a QmiWdsAutoconnectSettingRoaming. @@ -175228,20 +178187,20 @@ each #QmiWdsAuthentication in @mask. version="1.0"> Gets the nickname string for the #QmiWdsCallEndReason specified at @val. + line="2622">Gets the nickname string for the #QmiWdsCallEndReason specified at @val. + line="2631"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2628">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsCallEndReason. + line="2624">a QmiWdsCallEndReason. @@ -175278,20 +178237,20 @@ each #QmiWdsAuthentication in @mask. version="1.0"> Gets the nickname string for the #QmiWdsCallType specified at @val. + line="2606">Gets the nickname string for the #QmiWdsCallType specified at @val. + line="2615"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2612">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsCallType. + line="2608">a QmiWdsCallType. @@ -175328,20 +178287,20 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Gets the nickname string for the #QmiWdsClientType specified at @val. + line="3166">Gets the nickname string for the #QmiWdsClientType specified at @val. + line="3175"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3172">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsClientType. + line="3168">a QmiWdsClientType. @@ -175405,20 +178364,20 @@ each #QmiWdsAuthentication in @mask. version="1.0"> Gets the nickname string for the #QmiWdsConnectionStatus specified at @val. + line="2766">Gets the nickname string for the #QmiWdsConnectionStatus specified at @val. + line="2775"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2772">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsConnectionStatus. + line="2768">a QmiWdsConnectionStatus. @@ -175626,20 +178585,20 @@ each #QmiWdsAuthentication in @mask. version="1.0"> Gets the nickname string for the #QmiWdsDataBearerTechnology specified at @val. + line="2782">Gets the nickname string for the #QmiWdsDataBearerTechnology specified at @val. + line="2791"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2788">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDataBearerTechnology. + line="2784">a QmiWdsDataBearerTechnology. @@ -175686,20 +178645,20 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Gets the nickname string for the #QmiWdsDataCallStatus specified at @val. + line="3038">Gets the nickname string for the #QmiWdsDataCallStatus specified at @val. + line="3047"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3044">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDataCallStatus. + line="3040">a QmiWdsDataCallStatus. @@ -175754,20 +178713,20 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Gets the nickname string for the #QmiWdsDataCallType specified at @val. + line="3054">Gets the nickname string for the #QmiWdsDataCallType specified at @val. + line="3063"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3060">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDataCallType. + line="3056">a QmiWdsDataCallType. @@ -175849,20 +178808,20 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Gets the nickname string for the #QmiWdsDataSystem specified at @val. + line="2830">Gets the nickname string for the #QmiWdsDataSystem specified at @val. + line="2839"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2836">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDataSystem. + line="2832">a QmiWdsDataSystem. @@ -175899,20 +178858,20 @@ each #QmiWdsAuthentication in @mask. version="1.14"> Gets the nickname string for the #QmiWdsDataSystemNetworkType specified at @val. + line="2814">Gets the nickname string for the #QmiWdsDataSystemNetworkType specified at @val. + line="2823"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2820">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDataSystemNetworkType. + line="2816">a QmiWdsDataSystemNetworkType. @@ -175959,20 +178918,20 @@ each #QmiWdsAuthentication in @mask. version="1.14"> Gets the nickname string for the #QmiWdsDeliveryOrder specified at @val. + line="2910">Gets the nickname string for the #QmiWdsDeliveryOrder specified at @val. + line="2919"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2916">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDeliveryOrder. + line="2912">a QmiWdsDeliveryOrder. @@ -176018,20 +178977,20 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Gets the nickname string for the #QmiWdsDormancyStatus specified at @val. + line="3022">Gets the nickname string for the #QmiWdsDormancyStatus specified at @val. + line="3031"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3028">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDormancyStatus. + line="3024">a QmiWdsDormancyStatus. @@ -176230,20 +179189,20 @@ each #QmiWdsAuthentication in @mask. version="1.8"> Gets the nickname string for the #QmiWdsDsProfileError specified at @val. + line="2974">Gets the nickname string for the #QmiWdsDsProfileError specified at @val. + line="2983"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2980">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDsProfileError. + line="2976">a QmiWdsDsProfileError. @@ -176397,21 +179356,21 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="700">Builds a string containing a comma-separated list of nicknames for each #QmiWdsExtendedDataBearerTechnology3gpp in @mask. + line="710"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="707">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsExtendedDataBearerTechnology3gpp values. + line="702">bitmask of QmiWdsExtendedDataBearerTechnology3gpp values. @@ -176557,21 +179516,21 @@ each #QmiWdsExtendedDataBearerTechnology3gpp in @mask. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="717">Builds a string containing a comma-separated list of nicknames for each #QmiWdsExtendedDataBearerTechnology3gpp2 in @mask. + line="727"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="724">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsExtendedDataBearerTechnology3gpp2 values. + line="719">bitmask of QmiWdsExtendedDataBearerTechnology3gpp2 values. @@ -176636,20 +179595,20 @@ each #QmiWdsExtendedDataBearerTechnology3gpp2 in @mask. version="1.0"> Gets the nickname string for the #QmiWdsExtendedTechnologyPreference specified at @val. + line="2590">Gets the nickname string for the #QmiWdsExtendedTechnologyPreference specified at @val. + line="2599"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2596">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsExtendedTechnologyPreference. + line="2592">a QmiWdsExtendedTechnologyPreference. @@ -176705,20 +179664,20 @@ each #QmiWdsExtendedDataBearerTechnology3gpp2 in @mask. version="1.0"> Gets the nickname string for the #QmiWdsIpFamily specified at @val. + line="2574">Gets the nickname string for the #QmiWdsIpFamily specified at @val. + line="2583"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2580">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsIpFamily. + line="2576">a QmiWdsIpFamily. @@ -176764,20 +179723,20 @@ each #QmiWdsExtendedDataBearerTechnology3gpp2 in @mask. version="1.28"> Gets the nickname string for the #QmiWdsIpSupportType specified at @val. + line="3182">Gets the nickname string for the #QmiWdsIpSupportType specified at @val. + line="3191"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3188">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsIpSupportType. + line="3184">a QmiWdsIpSupportType. @@ -176823,20 +179782,20 @@ each #QmiWdsExtendedDataBearerTechnology3gpp2 in @mask. version="1.0"> Gets the nickname string for the #QmiWdsNetworkType specified at @val. + line="2798">Gets the nickname string for the #QmiWdsNetworkType specified at @val. + line="2807"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2804">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsNetworkType. + line="2800">a QmiWdsNetworkType. @@ -176945,21 +179904,21 @@ each #QmiWdsExtendedDataBearerTechnology3gpp2 in @mask. version="1.6"> Builds a string containing a comma-separated list of nicknames for + line="666">Builds a string containing a comma-separated list of nicknames for each #QmiWdsPacketStatisticsMaskFlag in @mask. + line="676"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="673">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsPacketStatisticsMaskFlag values. + line="668">bitmask of QmiWdsPacketStatisticsMaskFlag values. @@ -177015,20 +179974,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.18"> Gets the nickname string for the #QmiWdsPdpDataCompressionType specified at @val. + line="3118">Gets the nickname string for the #QmiWdsPdpDataCompressionType specified at @val. + line="3127"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3124">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsPdpDataCompressionType. + line="3120">a QmiWdsPdpDataCompressionType. @@ -177093,20 +180052,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.18"> Gets the nickname string for the #QmiWdsPdpHeaderCompressionType specified at @val. + line="3102">Gets the nickname string for the #QmiWdsPdpHeaderCompressionType specified at @val. + line="3111"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3108">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsPdpHeaderCompressionType. + line="3104">a QmiWdsPdpHeaderCompressionType. @@ -177162,20 +180121,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.0"> Gets the nickname string for the #QmiWdsPdpType specified at @val. + line="2846">Gets the nickname string for the #QmiWdsPdpType specified at @val. + line="2855"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2852">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsPdpType. + line="2848">a QmiWdsPdpType. @@ -177230,20 +180189,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.34"> Gets the nickname string for the #QmiWdsProfileChangeEvent specified at @val. + line="3198">Gets the nickname string for the #QmiWdsProfileChangeEvent specified at @val. + line="3207"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3204">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsProfileChangeEvent. + line="3200">a QmiWdsProfileChangeEvent. @@ -177281,20 +180240,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.22"> Gets the nickname string for the #QmiWdsProfileFamily specified at @val. + line="2894">Gets the nickname string for the #QmiWdsProfileFamily specified at @val. + line="2903"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2900">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsProfileFamily. + line="2896">a QmiWdsProfileFamily. @@ -177349,20 +180308,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.0"> Gets the nickname string for the #QmiWdsProfileType specified at @val. + line="2878">Gets the nickname string for the #QmiWdsProfileType specified at @val. + line="2887"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2884">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsProfileType. + line="2880">a QmiWdsProfileType. @@ -177462,20 +180421,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.18"> Gets the nickname string for the #QmiWdsQosClassIdentifier specified at @val. + line="3134">Gets the nickname string for the #QmiWdsQosClassIdentifier specified at @val. + line="3143"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3140">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsQosClassIdentifier. + line="3136">a QmiWdsQosClassIdentifier. @@ -177603,20 +180562,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.18"> Gets the nickname string for the #QmiWdsRadioAccessTechnology specified at @val. + line="3086">Gets the nickname string for the #QmiWdsRadioAccessTechnology specified at @val. + line="3095"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3092">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsRadioAccessTechnology. + line="3088">a QmiWdsRadioAccessTechnology. @@ -177745,21 +180704,21 @@ bearer network type is @QMI_WDS_NETWORK_TYPE_3GPP. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="547">Builds a string containing a comma-separated list of nicknames for each #QmiWdsRat3gpp in @mask. + line="557"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="554">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsRat3gpp values. + line="549">bitmask of QmiWdsRat3gpp values. @@ -177851,21 +180810,21 @@ bearer network type is @QMI_WDS_NETWORK_TYPE_3GPP2. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="530">Builds a string containing a comma-separated list of nicknames for each #QmiWdsRat3gpp2 in @mask. + line="540"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="537">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsRat3gpp2 values. + line="532">bitmask of QmiWdsRat3gpp2 values. @@ -178064,21 +181023,21 @@ each #QmiWdsRat3gpp2 in @mask. version="1.32"> Builds a string containing a comma-separated list of nicknames for + line="632">Builds a string containing a comma-separated list of nicknames for each #QmiWdsRequestedSettings in @mask. + line="642"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="639">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsRequestedSettings values. + line="634">bitmask of QmiWdsRequestedSettings values. @@ -178134,20 +181093,20 @@ each #QmiWdsRequestedSettings in @mask. version="1.14"> Gets the nickname string for the #QmiWdsSduErroneousDelivery specified at @val. + line="2958">Gets the nickname string for the #QmiWdsSduErroneousDelivery specified at @val. + line="2967"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2964">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsSduErroneousDelivery. + line="2960">a QmiWdsSduErroneousDelivery. @@ -178239,20 +181198,20 @@ each #QmiWdsRequestedSettings in @mask. version="1.14"> Gets the nickname string for the #QmiWdsSduErrorRatio specified at @val. + line="2926">Gets the nickname string for the #QmiWdsSduErrorRatio specified at @val. + line="2935"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2932">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsSduErrorRatio. + line="2928">a QmiWdsSduErrorRatio. @@ -178361,20 +181320,20 @@ each #QmiWdsRequestedSettings in @mask. version="1.14"> Gets the nickname string for the #QmiWdsSduResidualBitErrorRatio specified at @val. + line="2942">Gets the nickname string for the #QmiWdsSduResidualBitErrorRatio specified at @val. + line="2951"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2948">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsSduResidualBitErrorRatio. + line="2944">a QmiWdsSduResidualBitErrorRatio. @@ -178485,21 +181444,21 @@ should be emitted. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="683">Builds a string containing a comma-separated list of nicknames for each #QmiWdsSetEventReportTransferStatistics in @mask. + line="693"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="690">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsSetEventReportTransferStatistics values. + line="685">bitmask of QmiWdsSetEventReportTransferStatistics values. @@ -178557,21 +181516,21 @@ contains @QMI_WDS_RAT_3GPP2_CDMA1X. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="564">Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoCdma1x in @mask. + line="574"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="571">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsSoCdma1x values. + line="566">bitmask of QmiWdsSoCdma1x values. @@ -178610,21 +181569,21 @@ contains @QMI_WDS_RAT_3GPP2_EVDO_REV0. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="581">Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoEvdoRev0 in @mask. + line="591"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="588">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsSoEvdoRev0 values. + line="583">bitmask of QmiWdsSoEvdoRev0 values. @@ -178690,21 +181649,21 @@ contains @QMI_WDS_RAT_3GPP2_EVDO_REVA. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="598">Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoEvdoRevA in @mask. + line="608"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="605">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsSoEvdoRevA values. + line="600">bitmask of QmiWdsSoEvdoRevA values. @@ -178788,21 +181747,21 @@ contains @QMI_WDS_RAT_3GPP2_EVDO_REVB. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="615">Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoEvdoRevB in @mask. + line="625"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="622">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsSoEvdoRevB values. + line="617">bitmask of QmiWdsSoEvdoRevB values. @@ -178839,21 +181798,21 @@ each #QmiWdsSoEvdoRevB in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="513">Builds a string containing a comma-separated list of nicknames for each #QmiWdsTechnologyPreference in @mask. + line="523"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="520">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsTechnologyPreference values. + line="515">bitmask of QmiWdsTechnologyPreference values. @@ -178900,20 +181859,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.18"> Gets the nickname string for the #QmiWdsTetheredCallType specified at @val. + line="3070">Gets the nickname string for the #QmiWdsTetheredCallType specified at @val. + line="3079"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3076">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsTetheredCallType. + line="3072">a QmiWdsTetheredCallType. @@ -178977,20 +181936,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsTrafficClass specified at @val. + line="2862">Gets the nickname string for the #QmiWdsTrafficClass specified at @val. + line="2871"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2868">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsTrafficClass. + line="2864">a QmiWdsTrafficClass. @@ -179369,20 +182328,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReason3gpp specified at @val. + line="2702">Gets the nickname string for the #QmiWdsVerboseCallEndReason3gpp specified at @val. + line="2711"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2708">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReason3gpp. + line="2704">a QmiWdsVerboseCallEndReason3gpp. @@ -180536,20 +183495,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonCm specified at @val. + line="2686">Gets the nickname string for the #QmiWdsVerboseCallEndReasonCm specified at @val. + line="2695"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2692">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonCm. + line="2688">a QmiWdsVerboseCallEndReasonCm. @@ -180713,20 +183672,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonEhrpd specified at @val. + line="2734">Gets the nickname string for the #QmiWdsVerboseCallEndReasonEhrpd specified at @val. + line="2743"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2740">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonEhrpd. + line="2736">a QmiWdsVerboseCallEndReasonEhrpd. @@ -181187,20 +184146,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonInternal specified at @val. + line="2670">Gets the nickname string for the #QmiWdsVerboseCallEndReasonInternal specified at @val. + line="2679"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2676">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonInternal. + line="2672">a QmiWdsVerboseCallEndReasonInternal. @@ -181247,20 +184206,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonIpv6 specified at @val. + line="2750">Gets the nickname string for the #QmiWdsVerboseCallEndReasonIpv6 specified at @val. + line="2759"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2756">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonIpv6. + line="2752">a QmiWdsVerboseCallEndReasonIpv6. @@ -181559,20 +184518,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonMip specified at @val. + line="2654">Gets the nickname string for the #QmiWdsVerboseCallEndReasonMip specified at @val. + line="2663"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2660">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonMip. + line="2656">a QmiWdsVerboseCallEndReasonMip. @@ -181655,20 +184614,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonPpp specified at @val. + line="2718">Gets the nickname string for the #QmiWdsVerboseCallEndReasonPpp specified at @val. + line="2727"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2724">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonPpp. + line="2720">a QmiWdsVerboseCallEndReasonPpp. @@ -181751,20 +184710,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonType specified at @val. + line="2638">Gets the nickname string for the #QmiWdsVerboseCallEndReasonType specified at @val. + line="2647"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2644">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonType. + line="2640">a QmiWdsVerboseCallEndReasonType. @@ -181811,20 +184770,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.28"> Gets the nickname string for the #QmiWmsAckFailureCause specified at @val. + line="3488">Gets the nickname string for the #QmiWmsAckFailureCause specified at @val. + line="3497"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3494">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsAckFailureCause. + line="3490">a QmiWmsAckFailureCause. @@ -181861,20 +184820,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsAckIndicator specified at @val. + line="3232">Gets the nickname string for the #QmiWmsAckIndicator specified at @val. + line="3241"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3238">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsAckIndicator. + line="3234">a QmiWmsAckIndicator. @@ -182145,20 +185104,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsCdmaCauseCode specified at @val. + line="3312">Gets the nickname string for the #QmiWmsCdmaCauseCode specified at @val. + line="3321"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3318">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsCdmaCauseCode. + line="3314">a QmiWmsCdmaCauseCode. @@ -182214,20 +185173,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsCdmaErrorClass specified at @val. + line="3328">Gets the nickname string for the #QmiWmsCdmaErrorClass specified at @val. + line="3337"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3334">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsCdmaErrorClass. + line="3330">a QmiWmsCdmaErrorClass. @@ -182273,20 +185232,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsCdmaServiceOption specified at @val. + line="3296">Gets the nickname string for the #QmiWmsCdmaServiceOption specified at @val. + line="3305"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3302">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsCdmaServiceOption. + line="3298">a QmiWmsCdmaServiceOption. @@ -182522,20 +185481,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsGsmUmtsRpCause specified at @val. + line="3344">Gets the nickname string for the #QmiWmsGsmUmtsRpCause specified at @val. + line="3353"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3350">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsGsmUmtsRpCause. + line="3346">a QmiWmsGsmUmtsRpCause. @@ -182788,20 +185747,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsGsmUmtsTpCause specified at @val. + line="3360">Gets the nickname string for the #QmiWmsGsmUmtsTpCause specified at @val. + line="3369"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3366">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsGsmUmtsTpCause. + line="3362">a QmiWmsGsmUmtsTpCause. @@ -182874,20 +185833,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsMessageClass specified at @val. + line="3440">Gets the nickname string for the #QmiWmsMessageClass specified at @val. + line="3449"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3446">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageClass. + line="3442">a QmiWmsMessageClass. @@ -182924,20 +185883,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsMessageDeliveryFailureType specified at @val. + line="3376">Gets the nickname string for the #QmiWmsMessageDeliveryFailureType specified at @val. + line="3385"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3382">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageDeliveryFailureType. + line="3378">a QmiWmsMessageDeliveryFailureType. @@ -182993,20 +185952,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsMessageFormat specified at @val. + line="3248">Gets the nickname string for the #QmiWmsMessageFormat specified at @val. + line="3257"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3254">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageFormat. + line="3250">a QmiWmsMessageFormat. @@ -183043,20 +186002,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsMessageMode specified at @val. + line="3264">Gets the nickname string for the #QmiWmsMessageMode specified at @val. + line="3273"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3270">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageMode. + line="3266">a QmiWmsMessageMode. @@ -183093,20 +186052,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsMessageProtocol specified at @val. + line="3408">Gets the nickname string for the #QmiWmsMessageProtocol specified at @val. + line="3417"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3414">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageProtocol. + line="3410">a QmiWmsMessageProtocol. @@ -183161,20 +186120,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsMessageTagType specified at @val. + line="3392">Gets the nickname string for the #QmiWmsMessageTagType specified at @val. + line="3401"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3398">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageTagType. + line="3394">a QmiWmsMessageTagType. @@ -183202,20 +186161,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsMessageType specified at @val. + line="3424">Gets the nickname string for the #QmiWmsMessageType specified at @val. + line="3433"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3430">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageType. + line="3426">a QmiWmsMessageType. @@ -183261,20 +186220,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsNotificationType specified at @val. + line="3280">Gets the nickname string for the #QmiWmsNotificationType specified at @val. + line="3289"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3286">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsNotificationType. + line="3282">a QmiWmsNotificationType. @@ -183338,20 +186297,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsReceiptAction specified at @val. + line="3456">Gets the nickname string for the #QmiWmsReceiptAction specified at @val. + line="3465"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3462">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsReceiptAction. + line="3458">a QmiWmsReceiptAction. @@ -183397,20 +186356,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsStorageType specified at @val. + line="3216">Gets the nickname string for the #QmiWmsStorageType specified at @val. + line="3225"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3222">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsStorageType. + line="3218">a QmiWmsStorageType. @@ -183438,20 +186397,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiWmsTransferIndication specified at @val. + line="3472">Gets the nickname string for the #QmiWmsTransferIndication specified at @val. + line="3481"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3478">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsTransferIndication. + line="3474">a QmiWmsTransferIndication. @@ -183495,20 +186454,20 @@ or reported by the device when failed to process a transfer-only CDMA message. Gets the nickname string for the #QmiDataEndpointType specified at @val. + line="3538">Gets the nickname string for the #QmiDataEndpointType specified at @val. + line="3547"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3544">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDataEndpointType. + line="3540">a QmiDataEndpointType. @@ -183519,21 +186478,21 @@ or reported by the device when failed to process a transfer-only CDMA message. Builds a string containing a comma-separated list of nicknames for + line="72">Builds a string containing a comma-separated list of nicknames for each #QmiDeviceAddLinkFlags in @mask. + line="82"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="79">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiDeviceAddLinkFlags values. + line="74">bitmask of QmiDeviceAddLinkFlags values. @@ -183544,20 +186503,20 @@ each #QmiDeviceAddLinkFlags in @mask. version="1.14"> Gets the nickname string for the #QmiDeviceExpectedDataFormat specified at @val. + line="40">Gets the nickname string for the #QmiDeviceExpectedDataFormat specified at @val. + line="49"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="46">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDeviceExpectedDataFormat. + line="42">a QmiDeviceExpectedDataFormat. @@ -183569,21 +186528,21 @@ each #QmiDeviceAddLinkFlags in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="38">Builds a string containing a comma-separated list of nicknames for each #QmiDeviceOpenFlags in @mask. + line="48"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="45">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiDeviceOpenFlags values. + line="40">bitmask of QmiDeviceOpenFlags values. @@ -183594,21 +186553,21 @@ each #QmiDeviceOpenFlags in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="55">Builds a string containing a comma-separated list of nicknames for each #QmiDeviceReleaseClientFlags in @mask. + line="65"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="62">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiDeviceReleaseClientFlags values. + line="57">bitmask of QmiDeviceReleaseClientFlags values. @@ -183620,20 +186579,20 @@ each #QmiDeviceReleaseClientFlags in @mask. version="1.0"> Gets the nickname string for the #QmiDmsActivationState specified at @val. + line="170">Gets the nickname string for the #QmiDmsActivationState specified at @val. + line="179"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="176">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsActivationState. + line="172">a QmiDmsActivationState. @@ -183668,20 +186627,20 @@ each #QmiDmsBandCapability in @mask. version="1.18"> Gets the nickname string for the #QmiDmsBootImageDownloadMode specified at @val. + line="266">Gets the nickname string for the #QmiDmsBootImageDownloadMode specified at @val. + line="275"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="272">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsBootImageDownloadMode. + line="268">a QmiDmsBootImageDownloadMode. @@ -183693,20 +186652,20 @@ each #QmiDmsBandCapability in @mask. version="1.0"> Gets the nickname string for the #QmiDmsDataServiceCapability specified at @val. + line="58">Gets the nickname string for the #QmiDmsDataServiceCapability specified at @val. + line="67"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="64">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsDataServiceCapability. + line="60">a QmiDmsDataServiceCapability. @@ -183718,20 +186677,20 @@ each #QmiDmsBandCapability in @mask. version="1.0"> Gets the nickname string for the #QmiDmsFirmwareImageType specified at @val. + line="250">Gets the nickname string for the #QmiDmsFirmwareImageType specified at @val. + line="259"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="256">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsFirmwareImageType. + line="252">a QmiDmsFirmwareImageType. @@ -183742,20 +186701,20 @@ each #QmiDmsBandCapability in @mask. version="1.26"> Gets the nickname string for the #QmiDmsFoxconnDeviceMode specified at @val. + line="330">Gets the nickname string for the #QmiDmsFoxconnDeviceMode specified at @val. + line="339"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="336">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsFoxconnDeviceMode. + line="332">a QmiDmsFoxconnDeviceMode. @@ -183766,20 +186725,20 @@ each #QmiDmsBandCapability in @mask. version="1.26"> Gets the nickname string for the #QmiDmsFoxconnFirmwareVersionType specified at @val. + line="346">Gets the nickname string for the #QmiDmsFoxconnFirmwareVersionType specified at @val. + line="355"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="352">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsFoxconnFirmwareVersionType. + line="348">a QmiDmsFoxconnFirmwareVersionType. @@ -183791,20 +186750,20 @@ each #QmiDmsBandCapability in @mask. version="1.18"> Gets the nickname string for the #QmiDmsHpDeviceMode specified at @val. + line="298">Gets the nickname string for the #QmiDmsHpDeviceMode specified at @val. + line="307"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="304">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsHpDeviceMode. + line="300">a QmiDmsHpDeviceMode. @@ -183839,20 +186798,20 @@ each #QmiDmsLteBandCapability in @mask. version="1.26"> Gets the nickname string for the #QmiDmsMacType specified at @val. + line="282">Gets the nickname string for the #QmiDmsMacType specified at @val. + line="291"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="288">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsMacType. + line="284">a QmiDmsMacType. @@ -183863,21 +186822,21 @@ each #QmiDmsLteBandCapability in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="108">Builds a string containing a comma-separated list of nicknames for each #QmiDmsOfflineReason in @mask. + line="118"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="115">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiDmsOfflineReason values. + line="110">bitmask of QmiDmsOfflineReason values. @@ -183888,20 +186847,20 @@ each #QmiDmsOfflineReason in @mask. version="1.0"> Gets the nickname string for the #QmiDmsOperatingMode specified at @val. + line="138">Gets the nickname string for the #QmiDmsOperatingMode specified at @val. + line="147"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="144">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsOperatingMode. + line="140">a QmiDmsOperatingMode. @@ -183912,21 +186871,21 @@ each #QmiDmsOfflineReason in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="91">Builds a string containing a comma-separated list of nicknames for each #QmiDmsPowerState in @mask. + line="101"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="98">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiDmsPowerState values. + line="93">bitmask of QmiDmsPowerState values. @@ -183937,20 +186896,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsRadioInterface specified at @val. + line="90">Gets the nickname string for the #QmiDmsRadioInterface specified at @val. + line="99"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="96">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsRadioInterface. + line="92">a QmiDmsRadioInterface. @@ -183961,20 +186920,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsSimCapability specified at @val. + line="74">Gets the nickname string for the #QmiDmsSimCapability specified at @val. + line="83"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="80">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsSimCapability. + line="76">a QmiDmsSimCapability. @@ -184008,20 +186967,20 @@ each #QmiDmsPowerState in @mask. version="1.20"> Gets the nickname string for the #QmiDmsSwiUsbComposition specified at @val. + line="314">Gets the nickname string for the #QmiDmsSwiUsbComposition specified at @val. + line="323"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="320">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsSwiUsbComposition. + line="316">a QmiDmsSwiUsbComposition. @@ -184032,20 +186991,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsTimeReferenceType specified at @val. + line="234">Gets the nickname string for the #QmiDmsTimeReferenceType specified at @val. + line="243"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="240">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsTimeReferenceType. + line="236">a QmiDmsTimeReferenceType. @@ -184056,20 +187015,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsTimeSource specified at @val. + line="154">Gets the nickname string for the #QmiDmsTimeSource specified at @val. + line="163"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="160">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsTimeSource. + line="156">a QmiDmsTimeSource. @@ -184080,20 +187039,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsUimFacility specified at @val. + line="186">Gets the nickname string for the #QmiDmsUimFacility specified at @val. + line="195"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="192">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsUimFacility. + line="188">a QmiDmsUimFacility. @@ -184104,20 +187063,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsUimFacilityState specified at @val. + line="202">Gets the nickname string for the #QmiDmsUimFacilityState specified at @val. + line="211"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="208">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsUimFacilityState. + line="204">a QmiDmsUimFacilityState. @@ -184128,20 +187087,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsUimPinId specified at @val. + line="106">Gets the nickname string for the #QmiDmsUimPinId specified at @val. + line="115"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="112">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsUimPinId. + line="108">a QmiDmsUimPinId. @@ -184152,20 +187111,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsUimPinStatus specified at @val. + line="122">Gets the nickname string for the #QmiDmsUimPinStatus specified at @val. + line="131"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="128">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsUimPinStatus. + line="124">a QmiDmsUimPinStatus. @@ -184176,20 +187135,20 @@ each #QmiDmsPowerState in @mask. version="1.0"> Gets the nickname string for the #QmiDmsUimState specified at @val. + line="218">Gets the nickname string for the #QmiDmsUimState specified at @val. + line="227"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="224">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDmsUimState. + line="220">a QmiDmsUimState. @@ -184200,20 +187159,20 @@ each #QmiDmsPowerState in @mask. version="1.26"> Gets the nickname string for the #QmiDsdApnType specified at @val. + line="364">Gets the nickname string for the #QmiDsdApnType specified at @val. + line="373"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="370">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDsdApnType. + line="366">a QmiDsdApnType. @@ -184249,20 +187208,20 @@ each #QmiDsdApnTypePreference in @mask. version="1.32"> Gets the nickname string for the #QmiDsdDataSystemNetworkType specified at @val. + line="380">Gets the nickname string for the #QmiDsdDataSystemNetworkType specified at @val. + line="389"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="386">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDsdDataSystemNetworkType. + line="382">a QmiDsdDataSystemNetworkType. @@ -184274,20 +187233,20 @@ each #QmiDsdApnTypePreference in @mask. version="1.32"> Gets the nickname string for the #QmiDsdRadioAccessTechnology specified at @val. + line="396">Gets the nickname string for the #QmiDsdRadioAccessTechnology specified at @val. + line="405"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="402">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiDsdRadioAccessTechnology. + line="398">a QmiDsdRadioAccessTechnology. @@ -184323,20 +187282,20 @@ each #QmiDsdSoMask in @mask. version="1.28"> Gets the nickname string for the #QmiEndian specified at @val. + line="3522">Gets the nickname string for the #QmiEndian specified at @val. + line="3531"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3528">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiEndian. + line="3524">a QmiEndian. @@ -184347,20 +187306,20 @@ each #QmiDsdSoMask in @mask. version="1.32"> Gets the nickname string for the #QmiFoxFirmwareVersionType specified at @val. + line="414">Gets the nickname string for the #QmiFoxFirmwareVersionType specified at @val. + line="423"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="420">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiFoxFirmwareVersionType. + line="416">a QmiFoxFirmwareVersionType. @@ -184372,20 +187331,20 @@ each #QmiDsdSoMask in @mask. version="1.24"> Gets the nickname string for the #QmiGasFirmwareListingMode specified at @val. + line="432">Gets the nickname string for the #QmiGasFirmwareListingMode specified at @val. + line="441"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="438">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiGasFirmwareListingMode. + line="434">a QmiGasFirmwareListingMode. @@ -184397,25 +187356,123 @@ each #QmiDsdSoMask in @mask. version="1.32"> Gets the nickname string for the #QmiGasUsbCompositionEndpointType specified at @val. + line="448">Gets the nickname string for the #QmiGasUsbCompositionEndpointType specified at @val. + line="457"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="454">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiGasUsbCompositionEndpointType. + line="450">a QmiGasUsbCompositionEndpointType. + + Gets the nickname string for the #QmiImsaImsRegistrationStatus specified at @val. + + + a string with the nickname, or %NULL if not found. Do not free the returned value. + + + + + a QmiImsaImsRegistrationStatus. + + + + + + Gets the nickname string for the #QmiImsaRegistrationTechnology specified at @val. + + + a string with the nickname, or %NULL if not found. Do not free the returned value. + + + + + a QmiImsaRegistrationTechnology. + + + + + + Gets the nickname string for the #QmiImsaServiceStatus specified at @val. + + + a string with the nickname, or %NULL if not found. Do not free the returned value. + + + + + a QmiImsaServiceStatus. + + + + + + Gets the nickname string for the #QmiImspEnablerState specified at @val. + + + a string with the nickname, or %NULL if not found. Do not free the returned value. + + + + + a QmiImspEnablerState. + + + + + + Parses a #QmiMessage and builds a #QmiIndicationSscReportLargeOutput out of it. +The operation fails if the message is of the wrong type. + + + a #QmiIndicationSscReportLargeOutput, or %NULL if @error is set. The returned value should be freed with qmi_indication_ssc_report_large_output_unref(). + + + + + a #QmiMessage. + + + + + + Parses a #QmiMessage and builds a #QmiIndicationSscReportSmallOutput out of it. +The operation fails if the message is of the wrong type. + + + a #QmiIndicationSscReportSmallOutput, or %NULL if @error is set. The returned value should be freed with qmi_indication_ssc_report_small_output_unref(). + + + + + a #QmiMessage. + + + + version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="195">Builds a string containing a comma-separated list of nicknames for each #QmiLocDeleteCellDatabase in @mask. + line="205"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="202">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocDeleteCellDatabase values. + line="197">bitmask of QmiLocDeleteCellDatabase values. @@ -185826,21 +188935,21 @@ each #QmiLocDeleteCellDatabase in @mask. version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="212">Builds a string containing a comma-separated list of nicknames for each #QmiLocDeleteClockInfo in @mask. + line="222"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="219">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocDeleteClockInfo values. + line="214">bitmask of QmiLocDeleteClockInfo values. @@ -185875,21 +188984,21 @@ each #QmiLocDeleteGnssData in @mask. version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="178">Builds a string containing a comma-separated list of nicknames for each #QmiLocDeleteSvInfo in @mask. + line="188"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="185">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocDeleteSvInfo values. + line="180">bitmask of QmiLocDeleteSvInfo values. @@ -185900,20 +189009,20 @@ each #QmiLocDeleteSvInfo in @mask. version="1.22"> Gets the nickname string for the #QmiLocEngineState specified at @val. + line="614">Gets the nickname string for the #QmiLocEngineState specified at @val. + line="623"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="620">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocEngineState. + line="616">a QmiLocEngineState. @@ -185949,20 +189058,20 @@ each #QmiLocEventRegistrationFlag in @mask. version="1.22"> Gets the nickname string for the #QmiLocFixRecurrenceType specified at @val. + line="582">Gets the nickname string for the #QmiLocFixRecurrenceType specified at @val. + line="591"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="588">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocFixRecurrenceType. + line="584">a QmiLocFixRecurrenceType. @@ -185973,20 +189082,20 @@ each #QmiLocEventRegistrationFlag in @mask. version="1.22"> Gets the nickname string for the #QmiLocHealthStatus specified at @val. + line="678">Gets the nickname string for the #QmiLocHealthStatus specified at @val. + line="687"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="684">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocHealthStatus. + line="680">a QmiLocHealthStatus. @@ -185997,20 +189106,20 @@ each #QmiLocEventRegistrationFlag in @mask. version="1.22"> Gets the nickname string for the #QmiLocIndicationStatus specified at @val. + line="550">Gets the nickname string for the #QmiLocIndicationStatus specified at @val. + line="559"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="556">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocIndicationStatus. + line="552">a QmiLocIndicationStatus. @@ -186021,20 +189130,20 @@ each #QmiLocEventRegistrationFlag in @mask. version="1.20"> Gets the nickname string for the #QmiLocIntermediateReportState specified at @val. + line="534">Gets the nickname string for the #QmiLocIntermediateReportState specified at @val. + line="543"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="540">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocIntermediateReportState. + line="536">a QmiLocIntermediateReportState. @@ -186046,20 +189155,20 @@ each #QmiLocEventRegistrationFlag in @mask. version="1.28"> Gets the nickname string for the #QmiLocLockType specified at @val. + line="758">Gets the nickname string for the #QmiLocLockType specified at @val. + line="767"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="764">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocLockType. + line="760">a QmiLocLockType. @@ -186070,20 +189179,20 @@ each #QmiLocEventRegistrationFlag in @mask. version="1.22"> Gets the nickname string for the #QmiLocNavigationData specified at @val. + line="694">Gets the nickname string for the #QmiLocNavigationData specified at @val. + line="703"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="700">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocNavigationData. + line="696">a QmiLocNavigationData. @@ -186094,21 +189203,21 @@ each #QmiLocEventRegistrationFlag in @mask. version="1.26"> Builds a string containing a comma-separated list of nicknames for + line="229">Builds a string containing a comma-separated list of nicknames for each #QmiLocNmeaType in @mask. + line="239"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="236">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocNmeaType values. + line="231">bitmask of QmiLocNmeaType values. @@ -186119,20 +189228,20 @@ each #QmiLocNmeaType in @mask. version="1.22"> Gets the nickname string for the #QmiLocOperationMode specified at @val. + line="598">Gets the nickname string for the #QmiLocOperationMode specified at @val. + line="607"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="604">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocOperationMode. + line="600">a QmiLocOperationMode. @@ -186143,20 +189252,20 @@ each #QmiLocNmeaType in @mask. version="1.22"> Gets the nickname string for the #QmiLocPredictedOrbitsDataFormat specified at @val. + line="742">Gets the nickname string for the #QmiLocPredictedOrbitsDataFormat specified at @val. + line="751"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="748">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocPredictedOrbitsDataFormat. + line="744">a QmiLocPredictedOrbitsDataFormat. @@ -186168,20 +189277,20 @@ each #QmiLocNmeaType in @mask. version="1.22"> Gets the nickname string for the #QmiLocReliability specified at @val. + line="630">Gets the nickname string for the #QmiLocReliability specified at @val. + line="639"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="636">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocReliability. + line="632">a QmiLocReliability. @@ -186192,20 +189301,20 @@ each #QmiLocNmeaType in @mask. version="1.22"> Gets the nickname string for the #QmiLocSatelliteStatus specified at @val. + line="710">Gets the nickname string for the #QmiLocSatelliteStatus specified at @val. + line="719"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="716">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocSatelliteStatus. + line="712">a QmiLocSatelliteStatus. @@ -186216,21 +189325,21 @@ each #QmiLocNmeaType in @mask. version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="144">Builds a string containing a comma-separated list of nicknames for each #QmiLocSatelliteValidInformation in @mask. + line="154"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="151">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocSatelliteValidInformation values. + line="146">bitmask of QmiLocSatelliteValidInformation values. @@ -186266,21 +189375,21 @@ each #QmiLocSensorDataUsage in @mask. version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="161">Builds a string containing a comma-separated list of nicknames for each #QmiLocServerAddressType in @mask. + line="171"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="168">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocServerAddressType values. + line="163">bitmask of QmiLocServerAddressType values. @@ -186291,20 +189400,20 @@ each #QmiLocServerAddressType in @mask. version="1.22"> Gets the nickname string for the #QmiLocServerType specified at @val. + line="726">Gets the nickname string for the #QmiLocServerType specified at @val. + line="735"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="732">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocServerType. + line="728">a QmiLocServerType. @@ -186315,20 +189424,20 @@ each #QmiLocServerAddressType in @mask. version="1.22"> Gets the nickname string for the #QmiLocSessionStatus specified at @val. + line="566">Gets the nickname string for the #QmiLocSessionStatus specified at @val. + line="575"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="572">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocSessionStatus. + line="568">a QmiLocSessionStatus. @@ -186339,20 +189448,20 @@ each #QmiLocServerAddressType in @mask. version="1.22"> Gets the nickname string for the #QmiLocSystem specified at @val. + line="662">Gets the nickname string for the #QmiLocSystem specified at @val. + line="671"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="668">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocSystem. + line="664">a QmiLocSystem. @@ -186363,21 +189472,21 @@ each #QmiLocServerAddressType in @mask. version="1.22"> Builds a string containing a comma-separated list of nicknames for + line="127">Builds a string containing a comma-separated list of nicknames for each #QmiLocTechnologyUsed in @mask. + line="137"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="134">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiLocTechnologyUsed values. + line="129">bitmask of QmiLocTechnologyUsed values. @@ -186388,20 +189497,20 @@ each #QmiLocTechnologyUsed in @mask. version="1.22"> Gets the nickname string for the #QmiLocTimeSource specified at @val. + line="646">Gets the nickname string for the #QmiLocTimeSource specified at @val. + line="655"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="652">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiLocTimeSource. + line="648">a QmiLocTimeSource. @@ -186412,37 +189521,37 @@ each #QmiLocTechnologyUsed in @mask. throws="1"> Creates a new @type TLV with the value given in @raw, and adds it to the #QmiMessage. - + line="1017">Creates a new @type TLV with the value given in @raw, and adds it to the #QmiMessage. + %TRUE if the TLV is successfully added, otherwise %FALSE is returned and @error is set. + line="1027">%TRUE if the TLV is successfully added, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="1019">a #QmiMessage. specific ID of the TLV to add. + line="1020">specific ID of the TLV to add. raw data buffer with the value of the TLV. + line="1021">raw data buffer with the value of the TLV. length of the raw data buffer. + line="1022">length of the raw data buffer. @@ -188244,8 +191353,8 @@ The operation fails if the message is of the wrong type. version="1.0"> Calls the given function for each TLV found within the #QmiMessage. - + line="987">Calls the given function for each TLV found within the #QmiMessage. + @@ -188253,7 +191362,7 @@ The operation fails if the message is of the wrong type. a #QmiMessage. + line="989">a #QmiMessage. closure="2"> the function to call for each TLV. + line="990">the function to call for each TLV. @@ -188275,7 +191384,7 @@ The operation fails if the message is of the wrong type. closure="1"> user data to pass to the function. + line="991">user data to pass to the function. @@ -188415,19 +191524,19 @@ The operation fails if the message is of the wrong type. version="1.0"> Gets the client ID of the message. - + line="238">Gets the client ID of the message. + the client ID. + line="244">the client ID. a #QmiMessage. + line="240">a #QmiMessage. @@ -188438,19 +191547,19 @@ The operation fails if the message is of the wrong type. throws="1"> Gets the data buffer of the #QmiMessage without the QMUX header. - + line="303">Gets the data buffer of the #QmiMessage without the QMUX header. + The raw QMI buffer, or %NULL if @error is set. + line="311">The raw QMI buffer, or %NULL if @error is set. a #QmiMessage. + line="305">a #QmiMessage. transfer-ownership="full"> return location for the size of the output buffer. + line="306">return location for the size of the output buffer. @@ -188469,19 +191578,41 @@ The operation fails if the message is of the wrong type. version="1.0"> Gets the length of the raw data corresponding to the given #QmiMessage. - + line="274">Gets the length of the raw data corresponding to the given #QmiMessage. + the length of the raw data. + line="280">the length of the raw data. a #QmiMessage. + line="276">a #QmiMessage. + + + + + + Gets the marker of the #QmiMessage. + + + The message marker. + + + + + a #QmiMessage. @@ -188491,19 +191622,19 @@ The operation fails if the message is of the wrong type. version="1.0"> Gets the ID of the message. - + line="262">Gets the ID of the message. + the ID. + line="268">the ID. a #QmiMessage. + line="264">a #QmiMessage. @@ -188513,7 +191644,7 @@ The operation fails if the message is of the wrong type. version="1.18"> Gets a printable string with the contents of the whole QMI message. + line="1061">Gets a printable string with the contents of the whole QMI message. If known, the printable string will contain translated TLV values as well as the raw data buffer contents. @@ -188522,30 +191653,30 @@ The translation of the contents may be specific to the @context provided, e.g. for vendor-specific messages. If no @context given, the behavior is the same as qmi_message_get_printable(). - + a newly allocated string, which should be freed with g_free(). + line="1077">a newly allocated string, which should be freed with g_free(). a #QmiMessage. + line="1063">a #QmiMessage. a #QmiMessageContext. + line="1064">a #QmiMessageContext. prefix string to use in each new generated line. + line="1065">prefix string to use in each new generated line. @@ -188556,19 +191687,19 @@ If no @context given, the behavior is the same as qmi_message_get_printable(). Gets the raw data buffer of the #QmiMessage. - + line="286">Gets the raw data buffer of the #QmiMessage. + The raw data buffer, or %NULL if @error is set. + line="294">The raw data buffer, or %NULL if @error is set. a #QmiMessage. + line="288">a #QmiMessage. return location for the size of the output buffer. + line="289">return location for the size of the output buffer. @@ -188587,25 +191718,25 @@ If no @context given, the behavior is the same as qmi_message_get_printable(). Get the raw data buffer of a specific TLV within the #QmiMessage. - + line="1001">Get the raw data buffer of a specific TLV within the #QmiMessage. + The raw data buffer of the TLV, or %NULL if not found. + line="1009">The raw data buffer of the TLV, or %NULL if not found. a #QmiMessage. + line="1003">a #QmiMessage. specific ID of the TLV to get. + line="1004">specific ID of the TLV to get. return location for the length of the TLV. + line="1005">return location for the length of the TLV. @@ -188624,19 +191755,19 @@ If no @context given, the behavior is the same as qmi_message_get_printable(). Gets the service corresponding to the given #QmiMessage. - + line="226">Gets the service corresponding to the given #QmiMessage. + a #QmiService. + line="232">a #QmiService. a #QmiMessage. + line="228">a #QmiMessage. @@ -188646,45 +191777,45 @@ If no @context given, the behavior is the same as qmi_message_get_printable(). Gets a printable string with the contents of the TLV. + line="1085">Gets a printable string with the contents of the TLV. This method is the most generic one and doesn't try to translate the TLV contents. - + a newly allocated string, which should be freed with g_free(). + line="1097">a newly allocated string, which should be freed with g_free(). a #QmiMessage. + line="1087">a #QmiMessage. prefix string to use in each new generated line. + line="1088">prefix string to use in each new generated line. type of the TLV. + line="1089">type of the TLV. raw data buffer with the value of the TLV. + line="1090">raw data buffer with the value of the TLV. length of the raw data buffer. + line="1091">length of the raw data buffer. @@ -188694,19 +191825,19 @@ This method is the most generic one and doesn't try to translate the TLV content version="1.0"> Gets the transaction ID of the message. - + line="250">Gets the transaction ID of the message. + the transaction ID. + line="256">the transaction ID. a #QmiMessage. + line="252">a #QmiMessage. @@ -188763,24 +191894,128 @@ The operation fails if the message is of the wrong type. + + Parses a #QmiMessage and builds a #QmiMessageImsGetImsServicesEnabledSettingOutput out of it. +The operation fails if the message is of the wrong type. + + + a #QmiMessageImsGetImsServicesEnabledSettingOutput, or %NULL if @error is set. The returned value should be freed with qmi_message_ims_get_ims_services_enabled_setting_output_unref(). + + + + + a #QmiMessage. + + + + + + Parses a #QmiMessage and builds a #QmiMessageImsaGetImsRegistrationStatusOutput out of it. +The operation fails if the message is of the wrong type. + + + a #QmiMessageImsaGetImsRegistrationStatusOutput, or %NULL if @error is set. The returned value should be freed with qmi_message_imsa_get_ims_registration_status_output_unref(). + + + + + a #QmiMessage. + + + + + + Parses a #QmiMessage and builds a #QmiMessageImsaGetImsServicesStatusOutput out of it. +The operation fails if the message is of the wrong type. + + + a #QmiMessageImsaGetImsServicesStatusOutput, or %NULL if @error is set. The returned value should be freed with qmi_message_imsa_get_ims_services_status_output_unref(). + + + + + a #QmiMessage. + + + + + + Parses a #QmiMessage and builds a #QmiMessageImspGetEnablerStateOutput out of it. +The operation fails if the message is of the wrong type. + + + a #QmiMessageImspGetEnablerStateOutput, or %NULL if @error is set. The returned value should be freed with qmi_message_imsp_get_enabler_state_output_unref(). + + + + + a #QmiMessage. + + + + Checks whether the given #QmiMessage is an indication. - + line="214">Checks whether the given #QmiMessage is an indication. + %TRUE if @self is an indication message, %FALSE otherwise. + line="220">%TRUE if @self is an indication message, %FALSE otherwise. a #QmiMessage. + line="216">a #QmiMessage. @@ -188790,19 +192025,19 @@ The operation fails if the message is of the wrong type. version="1.8"> Checks whether the given #QmiMessage is a request. - + line="190">Checks whether the given #QmiMessage is a request. + %TRUE if @self is a request message, %FALSE otherwise. + line="196">%TRUE if @self is a request message, %FALSE otherwise. a #QmiMessage. + line="192">a #QmiMessage. @@ -188812,19 +192047,19 @@ The operation fails if the message is of the wrong type. version="1.0"> Checks whether the given #QmiMessage is a response. - + line="202">Checks whether the given #QmiMessage is a response. + %TRUE if @self is a response message, %FALSE otherwise. + line="208">%TRUE if @self is a response message, %FALSE otherwise. a #QmiMessage. + line="204">a #QmiMessage. @@ -189999,40 +193234,40 @@ The operation fails if the message is of the wrong type. Create a new #QmiMessage with the specified parameters. + line="90">Create a new #QmiMessage with the specified parameters. Note that @transaction_id must be less than #G_MAXUINT8 if @service is #QMI_SERVICE_CTL. - + a newly created #QmiMessage. The returned value should be freed with qmi_message_unref(). + line="102">a newly created #QmiMessage. The returned value should be freed with qmi_message_unref(). a #QmiService + line="92">a #QmiService client ID of the originating control point. + line="93">client ID of the originating control point. transaction ID. + line="94">transaction ID. message ID. + line="95">message ID. @@ -190043,29 +193278,29 @@ Note that @transaction_id must be less than #G_MAXUINT8 if @service is throws="1"> Create a new #QmiMessage for the given @service and @client_id and including the given QMI data buffer. + line="127">Create a new #QmiMessage for the given @service and @client_id and including the given QMI data buffer. Whenever a complete QMI message is read, its data gets removed from the @qmi_data buffer. This method should be used instead of qmi_message_new_from_raw() if the input data doesn't have QMUX headers. - + a newly created #QmiMessage, which should be freed with qmi_message_unref(). If @qmi_data doesn't contain a complete QMI data payload %NULL is returned. If there is a complete QMI data payload but it appears not to be valid, %NULL is returned and @error is set. + line="140">a newly created #QmiMessage, which should be freed with qmi_message_unref(). If @qmi_data doesn't contain a complete QMI data payload %NULL is returned. If there is a complete QMI data payload but it appears not to be valid, %NULL is returned and @error is set. a #QmiService + line="129">a #QmiService client ID of the originating control point. + line="130">client ID of the originating control point. data buffer containing only the QMI part of the message. + line="131">data buffer containing only the QMI part of the message. @@ -190087,14 +193322,14 @@ This method should be used instead of qmi_message_new_from_raw() if the input da throws="1"> Create a new #QmiMessage from the given raw data buffer. + line="111">Create a new #QmiMessage from the given raw data buffer. Whenever a complete QMI message is read, its raw data gets removed from the @raw buffer. - + a newly created #QmiMessage, which should be freed with qmi_message_unref(). If @raw doesn't contain a complete QMI message %NULL is returned. If there is a complete QMI message but it appears not to be valid, %NULL is returned and @error is set. + line="120">a newly created #QmiMessage, which should be freed with qmi_message_unref(). If @raw doesn't contain a complete QMI message %NULL is returned. If there is a complete QMI message but it appears not to be valid, %NULL is returned and @error is set. @@ -190104,7 +193339,7 @@ Whenever a complete QMI message is read, its raw data gets removed from the @raw transfer-ownership="full"> raw data buffer. + line="113">raw data buffer. @@ -191098,19 +194333,19 @@ The operation fails if the message is of the wrong type. Atomically increments the reference count of @self by one. - + line="163">Atomically increments the reference count of @self by one. + the new reference to @self. + line="169">the new reference to @self. a #QmiMessage. + line="165">a #QmiMessage. @@ -191120,25 +194355,25 @@ The operation fails if the message is of the wrong type. version="1.8"> Create a new response #QmiMessage for the specified @request. - + line="149">Create a new response #QmiMessage for the specified @request. + a newly created #QmiMessage. The returned value should be freed with qmi_message_unref(). + line="156">a newly created #QmiMessage. The returned value should be freed with qmi_message_unref(). a request #QmiMessage. + line="151">a request #QmiMessage. a #QmiProtocolError to set in the result TLV. + line="152">a #QmiProtocolError to set in the result TLV. @@ -191200,8 +194435,8 @@ The operation fails if the message is of the wrong type. version="1.8"> Overwrites the transaction ID of the message. - + line="1040">Overwrites the transaction ID of the message. + @@ -191209,24 +194444,50 @@ The operation fails if the message is of the wrong type. a #QmiMessage. + line="1042">a #QmiMessage. transaction id. + line="1043">transaction id. + + Parses a #QmiMessage and builds a #QmiMessageSscControlOutput out of it. +The operation fails if the message is of the wrong type. + + + a #QmiMessageSscControlOutput, or %NULL if @error is set. The returned value should be freed with qmi_message_ssc_control_output_unref(). + + + + + a #QmiMessage. + + + + Reads a string from the TLV. + line="925">Reads a string from the TLV. The string written in @out will need to be NUL-terminated by the caller. @@ -191240,24 +194501,24 @@ The fixed sized field may be suffixed with e.g. 0xFF if the contents are shorter than @string_length. Since 1.26, this method will return the valid UTF-8 characters in the start of the string, instead of returning an error when doing the full UTF-8 string validation. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="949">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="927">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="928">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="929">address of a the offset within the TLV value. amount of bytes to read. + line="930">amount of bytes to read. transfer-ownership="full"> buffer preallocated by the client, with at least @string_length bytes. + line="931">buffer preallocated by the client, with at least @string_length bytes. @@ -191292,29 +194553,29 @@ when doing the full UTF-8 string validation. throws="1"> Reads a 64-bit floating-point number from the TLV. + line="866">Reads a 64-bit floating-point number from the TLV. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, @offset will be updated to point past the read item. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="881">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="868">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="869">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="870">address of a the offset within the TLV value. source endianness, which will be swapped to host byte order if necessary. + line="871">source endianness, which will be swapped to host byte order if necessary. transfer-ownership="full"> return location for the read #gdouble. + line="872">return location for the read #gdouble. @@ -191349,29 +194610,29 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Reads a 32-bit floating-point number from the TLV. + line="840">Reads a 32-bit floating-point number from the TLV. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, @offset will be updated to point past the read item. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="855">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="842">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="843">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="844">address of a the offset within the TLV value. source endianness, which will be swapped to host byte order if necessary. + line="845">source endianness, which will be swapped to host byte order if necessary. transfer-ownership="full"> return location for the read #gfloat. + line="846">return location for the read #gfloat. @@ -191406,29 +194667,29 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Reads a signed 16-bit integer from the TLV, in host byte order. + line="682">Reads a signed 16-bit integer from the TLV, in host byte order. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, @offset will be updated to point past the read item. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="697">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="684">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="685">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="686">address of a the offset within the TLV value. source endianness, which will be swapped to host byte order if necessary. + line="687">source endianness, which will be swapped to host byte order if necessary. transfer-ownership="full"> return location for the read #gint16. + line="688">return location for the read #gint16. @@ -191463,29 +194724,29 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Reads a signed 32-bit integer from the TLV, in host byte order. + line="734">Reads a signed 32-bit integer from the TLV, in host byte order. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, @offset will be updated to point past the read item. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="749">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="736">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="737">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="738">address of a the offset within the TLV value. source endianness, which will be swapped to host byte order if necessary. + line="739">source endianness, which will be swapped to host byte order if necessary. transfer-ownership="full"> return location for the read #gint32. + line="740">return location for the read #gint32. @@ -191520,29 +194781,29 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Reads a signed 64-bit integer from the TLV, in host byte order. + line="786">Reads a signed 64-bit integer from the TLV, in host byte order. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, @offset will be updated to point past the read item. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="801">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="788">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="789">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="790">address of a the offset within the TLV value. source endianness, which will be swapped to host byte order if necessary. + line="791">source endianness, which will be swapped to host byte order if necessary. transfer-ownership="full"> return location for the read #gint64. + line="792">return location for the read #gint64. @@ -191577,29 +194838,29 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Reads a signed byte from the TLV. + line="632">Reads a signed byte from the TLV. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, @offset will be updated to point past the read item. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="646">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="634">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="635">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="636">address of a the offset within the TLV value. transfer-ownership="full"> return location for the read #gint8. + line="637">return location for the read #gint8. @@ -191628,29 +194889,29 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Reads an unsigned 16-bit integer from the TLV, in host byte order. + line="656">Reads an unsigned 16-bit integer from the TLV, in host byte order. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, @offset will be updated to point past the read item. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="671">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="658">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="659">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="660">address of a the offset within the TLV value. source endianness, which will be swapped to host byte order if necessary. + line="661">source endianness, which will be swapped to host byte order if necessary. transfer-ownership="full"> return location for the read #guint16. + line="662">return location for the read #guint16. @@ -191685,29 +194946,29 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Reads an unsigned 32-bit integer from the TLV, in host byte order. + line="708">Reads an unsigned 32-bit integer from the TLV, in host byte order. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, @offset will be updated to point past the read item. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="723">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="710">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="711">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="712">address of a the offset within the TLV value. source endianness, which will be swapped to host byte order if necessary. + line="713">source endianness, which will be swapped to host byte order if necessary. transfer-ownership="full"> return location for the read #guint32. + line="714">return location for the read #guint32. @@ -191742,29 +195003,29 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Reads an unsigned 64-bit integer from the TLV, in host byte order. + line="760">Reads an unsigned 64-bit integer from the TLV, in host byte order. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, @offset will be updated to point past the read item. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="775">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="762">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="763">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="764">address of a the offset within the TLV value. source endianness, which will be swapped to host byte order if necessary. + line="765">source endianness, which will be swapped to host byte order if necessary. transfer-ownership="full"> return location for the read #guint64. + line="766">return location for the read #guint64. @@ -191799,29 +195060,29 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Reads an unsigned byte from the TLV. + line="608">Reads an unsigned byte from the TLV. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, @offset will be updated to point past the read item. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="622">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="610">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="611">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of the offset within the TLV value. + line="612">address of the offset within the TLV value. transfer-ownership="full"> return location for the read #guint8. + line="613">return location for the read #guint8. @@ -191850,25 +195111,25 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Starts reading a given TLV from the #QmiMessage. - + line="590">Starts reading a given TLV from the #QmiMessage. + the offset where the TLV starts, or 0 if an error happens. + line="599">the offset where the TLV starts, or 0 if an error happens. a #QmiMessage. + line="592">a #QmiMessage. specific ID of the TLV to read. + line="593">specific ID of the TLV to read. transfer-ownership="full"> optional return location for the TLV size. + line="594">optional return location for the TLV size. - + @@ -191906,29 +195167,29 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Reads a @b_bytes-sized integer from the TLV, in host byte order. + line="812">Reads a @b_bytes-sized integer from the TLV, in host byte order. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable is successfully read, @offset will be updated to point past the read item. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="828">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="814">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="815">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="816">address of a the offset within the TLV value. number of bytes to read. + line="817">number of bytes to read. source endianness, which will be swapped to host byte order if necessary. + line="818">source endianness, which will be swapped to host byte order if necessary. transfer-ownership="full"> return location for the read #guint64. + line="819">return location for the read #guint64. @@ -191969,7 +195230,7 @@ is successfully read, @offset will be updated to point past the read item. throws="1"> Reads a string from the TLV. + line="892">Reads a string from the TLV. @offset needs to point to a valid @gsize specifying the index to start reading from within the TLV value (0 for the first item). If the variable @@ -191979,24 +195240,24 @@ Since 1.24.6 the read string is guaranteed to be valid UTF-8. Also, in order to overcome known firmware errors on string fields, this method will also attempt to parse the string as GSM-7 or UCS-2 if the initial UTF-8 validation fails. - + %TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. + line="913">%TRUE if the variable is successfully read, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="894">a #QmiMessage. offset that was returned by qmi_message_tlv_read_init(). + line="895">offset that was returned by qmi_message_tlv_read_init(). transfer-ownership="full"> address of a the offset within the TLV value. + line="896">address of a the offset within the TLV value. number of bytes used in the size prefix. + line="897">number of bytes used in the size prefix. maximum number of bytes to read, or 0 to read all available bytes. + line="898">maximum number of bytes to read, or 0 to read all available bytes. transfer-ownership="full"> return location for the read string. The returned value should be freed with g_free(). + line="899">return location for the read string. The returned value should be freed with g_free(). @@ -192037,28 +195298,28 @@ fails. throws="1"> Completes building a TLV in the #QmiMessage. + line="368">Completes building a TLV in the #QmiMessage. In case of error the TLV will be reseted; i.e. there is no need to explicitly call qmi_message_tlv_write_reset(). - + %TRUE if the TLV is successfully completed, otherwise %FALSE is returned and @error is set. + line="379">%TRUE if the TLV is successfully completed, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="370">a #QmiMessage. offset that was returned by qmi_message_tlv_write_init(). + line="371">offset that was returned by qmi_message_tlv_write_init(). @@ -192069,33 +195330,33 @@ call qmi_message_tlv_write_reset(). throws="1"> Appends a signed 16-bit integer to the TLV being built. The number to be + line="439">Appends a signed 16-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by @endian. - + %TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. + line="450">%TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="441">a #QmiMessage. target endianness, swapped from host byte order if necessary. + line="442">target endianness, swapped from host byte order if necessary. a #gint16 in host byte order. + line="443">a #gint16 in host byte order. @@ -192106,33 +195367,33 @@ care of converting the value written to the byte order specified by @endian. Appends a signed 32-bit integer to the TLV being built. The number to be + line="479">Appends a signed 32-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by @endian. - + %TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. + line="490">%TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="481">a #QmiMessage. target endianness, swapped from host byte order if necessary. + line="482">target endianness, swapped from host byte order if necessary. a #gint32 in host byte order. + line="483">a #gint32 in host byte order. @@ -192143,33 +195404,33 @@ care of converting the value written to the byte order specified by @endian. Appends a signed 32-bit integer to the TLV being built. The number to be + line="519">Appends a signed 32-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by @endian. - + %TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. + line="530">%TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="521">a #QmiMessage. target endianness, swapped from host byte order if necessary. + line="522">target endianness, swapped from host byte order if necessary. a #gint64 in host byte order. + line="523">a #gint64 in host byte order. @@ -192180,25 +195441,25 @@ care of converting the value written to the byte order specified by @endian. Appends a signed byte variable to the TLV being built. - + line="403">Appends a signed byte variable to the TLV being built. + %TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. + line="411">%TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="405">a #QmiMessage. a #gint8. + line="406">a #gint8. @@ -192209,33 +195470,33 @@ care of converting the value written to the byte order specified by @endian. Appends an unsigned 16-bit integer to the TLV being built. The number to be + line="419">Appends an unsigned 16-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by @endian. - + %TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. + line="430">%TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="421">a #QmiMessage. target endianness, swapped from host byte order if necessary. + line="422">target endianness, swapped from host byte order if necessary. a #guint16 in host byte order. + line="423">a #guint16 in host byte order. @@ -192246,33 +195507,33 @@ care of converting the value written to the byte order specified by @endian. Appends an unsigned 32-bit integer to the TLV being built. The number to be + line="459">Appends an unsigned 32-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by @endian. - + %TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. + line="470">%TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="461">a #QmiMessage. target endianness, swapped from host byte order if necessary. + line="462">target endianness, swapped from host byte order if necessary. a #guint32 in host byte order. + line="463">a #guint32 in host byte order. @@ -192283,33 +195544,33 @@ care of converting the value written to the byte order specified by @endian. Appends an unsigned 64-bit integer to the TLV being built. The number to be + line="499">Appends an unsigned 64-bit integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by @endian. - + %TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. + line="510">%TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="501">a #QmiMessage. target endianness, swapped from host byte order if necessary. + line="502">target endianness, swapped from host byte order if necessary. a #guint64 in host byte order. + line="503">a #guint64 in host byte order. @@ -192320,25 +195581,25 @@ care of converting the value written to the byte order specified by @endian. Appends an unsigned byte to the TLV being built. - + line="387">Appends an unsigned byte to the TLV being built. + %TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. + line="395">%TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="389">a #QmiMessage. a #guint8. + line="390">a #guint8. @@ -192349,31 +195610,31 @@ care of converting the value written to the byte order specified by @endian. Starts building a new TLV in the #QmiMessage. + line="334">Starts building a new TLV in the #QmiMessage. In order to finish adding the TLV, qmi_message_tlv_write_complete() needs to be called. If any error happens adding fields on the TLV, the previous state can be recovered using qmi_message_tlv_write_reset(). - + the offset where the TLV was started to be added, or 0 if an error happens. + line="348">the offset where the TLV was started to be added, or 0 if an error happens. a #QmiMessage. + line="336">a #QmiMessage. specific ID of the TLV to add. + line="337">specific ID of the TLV to add. @@ -192383,8 +195644,8 @@ recovered using qmi_message_tlv_write_reset(). version="1.12"> Removes the TLV being currently added. - + line="356">Removes the TLV being currently added. + @@ -192392,13 +195653,13 @@ recovered using qmi_message_tlv_write_reset(). a #QmiMessage. + line="358">a #QmiMessage. offset that was returned by qmi_message_tlv_write_init(). + line="359">offset that was returned by qmi_message_tlv_write_init(). @@ -192409,42 +195670,42 @@ recovered using qmi_message_tlv_write_reset(). throws="1"> Appends a @n_bytes-sized unsigned integer to the TLV being built. The number + line="539">Appends a @n_bytes-sized unsigned integer to the TLV being built. The number to be written is expected to be given in host endianness, and this method takes care of converting the value written to the byte order specified by @endian. The value of @n_bytes can be any between 1 and 8. - + %TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. + line="554">%TRUE if the variable is successfully added, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="541">a #QmiMessage. number of bytes to write. + line="542">number of bytes to write. target endianness, swapped from host byte order if necessary. + line="543">target endianness, swapped from host byte order if necessary. a #guint64 in host byte order. + line="544">a #guint64 in host byte order. @@ -192455,39 +195716,39 @@ The value of @n_bytes can be any between 1 and 8. throws="1"> Appends a string to the TLV being built. + line="565">Appends a string to the TLV being built. Fixed-sized strings should give @n_size_prefix_bytes equal to 0. - + %TRUE if the string is successfully added, otherwise %FALSE is returned and @error is set. + line="577">%TRUE if the string is successfully added, otherwise %FALSE is returned and @error is set. a #QmiMessage. + line="567">a #QmiMessage. number of bytes to use in the size prefix. + line="568">number of bytes to use in the size prefix. string to write. + line="569">string to write. length of @in, or -1 if @in is NUL-terminated. + line="570">length of @in, or -1 if @in is NUL-terminated. @@ -193068,9 +196329,9 @@ The operation fails if the message is of the wrong type. version="1.0"> Atomically decrements the reference count of @self by one. + line="175">Atomically decrements the reference count of @self by one. If the reference count drops to 0, @self is completely disposed. - + @@ -193078,7 +196339,7 @@ If the reference count drops to 0, @self is completely disposed. a #QmiMessage. + line="177">a #QmiMessage. @@ -194881,20 +198142,20 @@ The operation fails if the message is of the wrong type. version="1.0"> Gets the nickname string for the #QmiNasActiveBand specified at @val. + line="792">Gets the nickname string for the #QmiNasActiveBand specified at @val. + line="801"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="798">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasActiveBand. + line="794">a QmiNasActiveBand. @@ -194905,20 +198166,20 @@ The operation fails if the message is of the wrong type. version="1.0"> Gets the nickname string for the #QmiNasAttachState specified at @val. + line="904">Gets the nickname string for the #QmiNasAttachState specified at @val. + line="913"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="910">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasAttachState. + line="906">a QmiNasAttachState. @@ -194953,20 +198214,20 @@ each #QmiNasBandPreference in @mask. version="1.28"> Gets the nickname string for the #QmiNasBoolean specified at @val. + line="1592">Gets the nickname string for the #QmiNasBoolean specified at @val. + line="1601"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1598">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasBoolean. + line="1594">a QmiNasBoolean. @@ -194977,20 +198238,20 @@ each #QmiNasBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasCallBarringStatus specified at @val. + line="1000">Gets the nickname string for the #QmiNasCallBarringStatus specified at @val. + line="1009"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1006">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasCallBarringStatus. + line="1002">a QmiNasCallBarringStatus. @@ -195001,20 +198262,20 @@ each #QmiNasBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasCdmaPilotType specified at @val. + line="1304">Gets the nickname string for the #QmiNasCdmaPilotType specified at @val. + line="1313"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1310">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasCdmaPilotType. + line="1306">a QmiNasCdmaPilotType. @@ -195025,20 +198286,20 @@ each #QmiNasBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasCdmaPrlPreference specified at @val. + line="1064">Gets the nickname string for the #QmiNasCdmaPrlPreference specified at @val. + line="1073"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1070">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasCdmaPrlPreference. + line="1066">a QmiNasCdmaPrlPreference. @@ -195049,20 +198310,20 @@ each #QmiNasBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasCellBroadcastCapability specified at @val. + line="1272">Gets the nickname string for the #QmiNasCellBroadcastCapability specified at @val. + line="1281"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1278">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasCellBroadcastCapability. + line="1274">a QmiNasCellBroadcastCapability. @@ -195074,20 +198335,20 @@ each #QmiNasBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasChangeDuration specified at @val. + line="1112">Gets the nickname string for the #QmiNasChangeDuration specified at @val. + line="1121"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1118">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasChangeDuration. + line="1114">a QmiNasChangeDuration. @@ -195098,20 +198359,20 @@ each #QmiNasBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasDataCapability specified at @val. + line="952">Gets the nickname string for the #QmiNasDataCapability specified at @val. + line="961"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="958">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasDataCapability. + line="954">a QmiNasDataCapability. @@ -195122,20 +198383,20 @@ each #QmiNasBandPreference in @mask. version="1.4"> Gets the nickname string for the #QmiNasDayOfWeek specified at @val. + line="1320">Gets the nickname string for the #QmiNasDayOfWeek specified at @val. + line="1329"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1326">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasDayOfWeek. + line="1322">a QmiNasDayOfWeek. @@ -195146,20 +198407,20 @@ each #QmiNasBandPreference in @mask. version="1.4"> Gets the nickname string for the #QmiNasDaylightSavingsAdjustment specified at @val. + line="1336">Gets the nickname string for the #QmiNasDaylightSavingsAdjustment specified at @val. + line="1345"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1342">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasDaylightSavingsAdjustment. + line="1338">a QmiNasDaylightSavingsAdjustment. @@ -195171,20 +198432,20 @@ each #QmiNasBandPreference in @mask. version="1.16"> Gets the nickname string for the #QmiNasDLBandwidth specified at @val. + line="1368">Gets the nickname string for the #QmiNasDLBandwidth specified at @val. + line="1377"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1374">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasDLBandwidth. + line="1370">a QmiNasDLBandwidth. @@ -195195,20 +198456,20 @@ each #QmiNasBandPreference in @mask. version="1.28"> Gets the nickname string for the #QmiNasDrx specified at @val. + line="1576">Gets the nickname string for the #QmiNasDrx specified at @val. + line="1585"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1582">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasDrx. + line="1578">a QmiNasDrx. @@ -195219,20 +198480,20 @@ each #QmiNasBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasEvdoSinrLevel specified at @val. + line="824">Gets the nickname string for the #QmiNasEvdoSinrLevel specified at @val. + line="833"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="830">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasEvdoSinrLevel. + line="826">a QmiNasEvdoSinrLevel. @@ -195243,20 +198504,20 @@ each #QmiNasBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasGsmWcdmaAcquisitionOrderPreference specified at @val. + line="1144">Gets the nickname string for the #QmiNasGsmWcdmaAcquisitionOrderPreference specified at @val. + line="1153"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1150">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasGsmWcdmaAcquisitionOrderPreference. + line="1146">a QmiNasGsmWcdmaAcquisitionOrderPreference. @@ -195268,20 +198529,20 @@ each #QmiNasBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasHdrPersonality specified at @val. + line="984">Gets the nickname string for the #QmiNasHdrPersonality specified at @val. + line="993"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="990">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasHdrPersonality. + line="986">a QmiNasHdrPersonality. @@ -195292,20 +198553,20 @@ each #QmiNasBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasHdrProtocolRevision specified at @val. + line="1240">Gets the nickname string for the #QmiNasHdrProtocolRevision specified at @val. + line="1249"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1246">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasHdrProtocolRevision. + line="1242">a QmiNasHdrProtocolRevision. @@ -195341,20 +198602,20 @@ each #QmiNasLteBandPreference in @mask. version="1.24"> Gets the nickname string for the #QmiNasLteCellAccessStatus specified at @val. + line="1224">Gets the nickname string for the #QmiNasLteCellAccessStatus specified at @val. + line="1233"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1230">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasLteCellAccessStatus. + line="1226">a QmiNasLteCellAccessStatus. @@ -195366,20 +198627,20 @@ each #QmiNasLteBandPreference in @mask. version="1.24"> Gets the nickname string for the #QmiNasLteRegistrationDomain specified at @val. + line="1192">Gets the nickname string for the #QmiNasLteRegistrationDomain specified at @val. + line="1201"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1198">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasLteRegistrationDomain. + line="1194">a QmiNasLteRegistrationDomain. @@ -195391,20 +198652,20 @@ each #QmiNasLteBandPreference in @mask. version="1.28"> Gets the nickname string for the #QmiNasLteVoiceDomain specified at @val. + line="1624">Gets the nickname string for the #QmiNasLteVoiceDomain specified at @val. + line="1633"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1630">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasLteVoiceDomain. + line="1626">a QmiNasLteVoiceDomain. @@ -195415,20 +198676,20 @@ each #QmiNasLteBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasNetworkDescriptionDisplay specified at @val. + line="1016">Gets the nickname string for the #QmiNasNetworkDescriptionDisplay specified at @val. + line="1025"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1022">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkDescriptionDisplay. + line="1018">a QmiNasNetworkDescriptionDisplay. @@ -195440,20 +198701,20 @@ each #QmiNasLteBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasNetworkDescriptionEncoding specified at @val. + line="1032">Gets the nickname string for the #QmiNasNetworkDescriptionEncoding specified at @val. + line="1041"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1038">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkDescriptionEncoding. + line="1034">a QmiNasNetworkDescriptionEncoding. @@ -195465,21 +198726,21 @@ each #QmiNasLteBandPreference in @mask. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="367">Builds a string containing a comma-separated list of nicknames for each #QmiNasNetworkNameDisplayCondition in @mask. + line="377"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="374">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasNetworkNameDisplayCondition values. + line="369">bitmask of QmiNasNetworkNameDisplayCondition values. @@ -195491,20 +198752,20 @@ each #QmiNasNetworkNameDisplayCondition in @mask. version="1.24"> Gets the nickname string for the #QmiNasNetworkNameSource specified at @val. + line="1432">Gets the nickname string for the #QmiNasNetworkNameSource specified at @val. + line="1441"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1438">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkNameSource. + line="1434">a QmiNasNetworkNameSource. @@ -195515,20 +198776,20 @@ each #QmiNasNetworkNameDisplayCondition in @mask. version="1.0"> Gets the nickname string for the #QmiNasNetworkRegisterType specified at @val. + line="856">Gets the nickname string for the #QmiNasNetworkRegisterType specified at @val. + line="865"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="862">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkRegisterType. + line="858">a QmiNasNetworkRegisterType. @@ -195540,20 +198801,20 @@ each #QmiNasNetworkNameDisplayCondition in @mask. version="1.24"> Gets the nickname string for the #QmiNasNetworkScanResult specified at @val. + line="840">Gets the nickname string for the #QmiNasNetworkScanResult specified at @val. + line="849"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="846">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkScanResult. + line="842">a QmiNasNetworkScanResult. @@ -195564,21 +198825,21 @@ each #QmiNasNetworkNameDisplayCondition in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="265">Builds a string containing a comma-separated list of nicknames for each #QmiNasNetworkScanType in @mask. + line="275"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="272">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasNetworkScanType values. + line="267">bitmask of QmiNasNetworkScanType values. @@ -195589,20 +198850,20 @@ each #QmiNasNetworkScanType in @mask. version="1.0"> Gets the nickname string for the #QmiNasNetworkSelectionPreference specified at @val. + line="1096">Gets the nickname string for the #QmiNasNetworkSelectionPreference specified at @val. + line="1105"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1102">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkSelectionPreference. + line="1098">a QmiNasNetworkSelectionPreference. @@ -195614,20 +198875,20 @@ each #QmiNasNetworkScanType in @mask. version="1.24"> Gets the nickname string for the #QmiNasNetworkSelectionRegistrationRestriction specified at @val. + line="1176">Gets the nickname string for the #QmiNasNetworkSelectionRegistrationRestriction specified at @val. + line="1185"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1182">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkSelectionRegistrationRestriction. + line="1178">a QmiNasNetworkSelectionRegistrationRestriction. @@ -195639,20 +198900,20 @@ each #QmiNasNetworkScanType in @mask. version="1.0"> Gets the nickname string for the #QmiNasNetworkServiceDomain specified at @val. + line="808">Gets the nickname string for the #QmiNasNetworkServiceDomain specified at @val. + line="817"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="814">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkServiceDomain. + line="810">a QmiNasNetworkServiceDomain. @@ -195664,21 +198925,21 @@ each #QmiNasNetworkScanType in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="282">Builds a string containing a comma-separated list of nicknames for each #QmiNasNetworkStatus in @mask. + line="292"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="289">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasNetworkStatus values. + line="284">bitmask of QmiNasNetworkStatus values. @@ -195689,20 +198950,20 @@ each #QmiNasNetworkStatus in @mask. version="1.0"> Gets the nickname string for the #QmiNasNetworkType specified at @val. + line="920">Gets the nickname string for the #QmiNasNetworkType specified at @val. + line="929"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="926">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasNetworkType. + line="922">a QmiNasNetworkType. @@ -195713,21 +198974,21 @@ each #QmiNasNetworkStatus in @mask. version="1.30"> Builds a string containing a comma-separated list of nicknames for + line="299">Builds a string containing a comma-separated list of nicknames for each #QmiNasPlmnAccessTechnologyIdentifier in @mask. + line="309"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="306">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasPlmnAccessTechnologyIdentifier values. + line="301">bitmask of QmiNasPlmnAccessTechnologyIdentifier values. @@ -195739,20 +199000,20 @@ each #QmiNasPlmnAccessTechnologyIdentifier in @mask. version="1.18"> Gets the nickname string for the #QmiNasPlmnEncodingScheme specified at @val. + line="1400">Gets the nickname string for the #QmiNasPlmnEncodingScheme specified at @val. + line="1409"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1406">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPlmnEncodingScheme. + line="1402">a QmiNasPlmnEncodingScheme. @@ -195764,20 +199025,20 @@ each #QmiNasPlmnAccessTechnologyIdentifier in @mask. version="1.28"> Gets the nickname string for the #QmiNasPlmnLanguageId specified at @val. + line="1608">Gets the nickname string for the #QmiNasPlmnLanguageId specified at @val. + line="1617"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1614">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPlmnLanguageId. + line="1610">a QmiNasPlmnLanguageId. @@ -195788,20 +199049,20 @@ each #QmiNasPlmnAccessTechnologyIdentifier in @mask. version="1.18"> Gets the nickname string for the #QmiNasPlmnNameCountryInitials specified at @val. + line="1416">Gets the nickname string for the #QmiNasPlmnNameCountryInitials specified at @val. + line="1425"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1422">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPlmnNameCountryInitials. + line="1418">a QmiNasPlmnNameCountryInitials. @@ -195813,20 +199074,20 @@ each #QmiNasPlmnAccessTechnologyIdentifier in @mask. version="1.18"> Gets the nickname string for the #QmiNasPlmnNameSpareBits specified at @val. + line="1448">Gets the nickname string for the #QmiNasPlmnNameSpareBits specified at @val. + line="1457"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1454">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPlmnNameSpareBits. + line="1450">a QmiNasPlmnNameSpareBits. @@ -195837,20 +199098,20 @@ each #QmiNasPlmnAccessTechnologyIdentifier in @mask. version="1.0"> Gets the nickname string for the #QmiNasPreferenceDuration specified at @val. + line="1048">Gets the nickname string for the #QmiNasPreferenceDuration specified at @val. + line="1057"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1054">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPreferenceDuration. + line="1050">a QmiNasPreferenceDuration. @@ -195862,20 +199123,20 @@ each #QmiNasPlmnAccessTechnologyIdentifier in @mask. version="1.20"> Gets the nickname string for the #QmiNasPsAttachAction specified at @val. + line="872">Gets the nickname string for the #QmiNasPsAttachAction specified at @val. + line="881"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="878">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasPsAttachAction. + line="874">a QmiNasPsAttachAction. @@ -195886,20 +199147,20 @@ each #QmiNasPlmnAccessTechnologyIdentifier in @mask. version="1.0"> Gets the nickname string for the #QmiNasRadioInterface specified at @val. + line="776">Gets the nickname string for the #QmiNasRadioInterface specified at @val. + line="785"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="782">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRadioInterface. + line="778">a QmiNasRadioInterface. @@ -195910,21 +199171,21 @@ each #QmiNasPlmnAccessTechnologyIdentifier in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="316">Builds a string containing a comma-separated list of nicknames for each #QmiNasRadioTechnologyPreference in @mask. + line="326"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="323">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasRadioTechnologyPreference values. + line="318">bitmask of QmiNasRadioTechnologyPreference values. @@ -195936,21 +199197,21 @@ each #QmiNasRadioTechnologyPreference in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="333">Builds a string containing a comma-separated list of nicknames for each #QmiNasRatModePreference in @mask. + line="343"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="340">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasRatModePreference values. + line="335">bitmask of QmiNasRatModePreference values. @@ -196027,20 +199288,20 @@ The returned value should be freed with g_free(). version="1.0"> Gets the nickname string for the #QmiNasRegistrationState specified at @val. + line="888">Gets the nickname string for the #QmiNasRegistrationState specified at @val. + line="897"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="894">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRegistrationState. + line="890">a QmiNasRegistrationState. @@ -196051,20 +199312,20 @@ The returned value should be freed with g_free(). version="1.30"> Gets the nickname string for the #QmiNasRejectCause specified at @val. + line="1640">Gets the nickname string for the #QmiNasRejectCause specified at @val. + line="1649"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1646">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRejectCause. + line="1642">a QmiNasRejectCause. @@ -196075,20 +199336,20 @@ The returned value should be freed with g_free(). version="1.0"> Gets the nickname string for the #QmiNasRoamingIndicatorStatus specified at @val. + line="936">Gets the nickname string for the #QmiNasRoamingIndicatorStatus specified at @val. + line="945"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="942">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRoamingIndicatorStatus. + line="938">a QmiNasRoamingIndicatorStatus. @@ -196100,20 +199361,20 @@ The returned value should be freed with g_free(). version="1.0"> Gets the nickname string for the #QmiNasRoamingPreference specified at @val. + line="1080">Gets the nickname string for the #QmiNasRoamingPreference specified at @val. + line="1089"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1086">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRoamingPreference. + line="1082">a QmiNasRoamingPreference. @@ -196124,20 +199385,20 @@ The returned value should be freed with g_free(). version="1.0"> Gets the nickname string for the #QmiNasRoamingStatus specified at @val. + line="1208">Gets the nickname string for the #QmiNasRoamingStatus specified at @val. + line="1217"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1214">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasRoamingStatus. + line="1210">a QmiNasRoamingStatus. @@ -196148,20 +199409,20 @@ The returned value should be freed with g_free(). version="1.16"> Gets the nickname string for the #QmiNasScellState specified at @val. + line="1384">Gets the nickname string for the #QmiNasScellState specified at @val. + line="1393"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1390">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasScellState. + line="1386">a QmiNasScellState. @@ -196172,20 +199433,20 @@ The returned value should be freed with g_free(). version="1.0"> Gets the nickname string for the #QmiNasServiceDomainPreference specified at @val. + line="1128">Gets the nickname string for the #QmiNasServiceDomainPreference specified at @val. + line="1137"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1134">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasServiceDomainPreference. + line="1130">a QmiNasServiceDomainPreference. @@ -196197,20 +199458,20 @@ The returned value should be freed with g_free(). version="1.0"> Gets the nickname string for the #QmiNasServiceStatus specified at @val. + line="968">Gets the nickname string for the #QmiNasServiceStatus specified at @val. + line="977"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="974">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasServiceStatus. + line="970">a QmiNasServiceStatus. @@ -196221,21 +199482,21 @@ The returned value should be freed with g_free(). version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="248">Builds a string containing a comma-separated list of nicknames for each #QmiNasSignalStrengthRequest in @mask. + line="258"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="255">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasSignalStrengthRequest values. + line="250">bitmask of QmiNasSignalStrengthRequest values. @@ -196247,20 +199508,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.0"> Gets the nickname string for the #QmiNasSimRejectState specified at @val. + line="1288">Gets the nickname string for the #QmiNasSimRejectState specified at @val. + line="1297"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1294">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSimRejectState. + line="1290">a QmiNasSimRejectState. @@ -196271,20 +199532,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiEmmConnectionState specified at @val. + line="1560">Gets the nickname string for the #QmiNasSwiEmmConnectionState specified at @val. + line="1569"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1566">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiEmmConnectionState. + line="1562">a QmiNasSwiEmmConnectionState. @@ -196296,20 +199557,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiEmmState specified at @val. + line="1544">Gets the nickname string for the #QmiNasSwiEmmState specified at @val. + line="1553"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1550">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiEmmState. + line="1546">a QmiNasSwiEmmState. @@ -196320,20 +199581,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiImsRegState specified at @val. + line="1512">Gets the nickname string for the #QmiNasSwiImsRegState specified at @val. + line="1521"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1518">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiImsRegState. + line="1514">a QmiNasSwiImsRegState. @@ -196344,20 +199605,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiModemMode specified at @val. + line="1480">Gets the nickname string for the #QmiNasSwiModemMode specified at @val. + line="1489"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1486">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiModemMode. + line="1482">a QmiNasSwiModemMode. @@ -196368,20 +199629,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiPsState specified at @val. + line="1528">Gets the nickname string for the #QmiNasSwiPsState specified at @val. + line="1537"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1534">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiPsState. + line="1530">a QmiNasSwiPsState. @@ -196392,20 +199653,20 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.24"> Gets the nickname string for the #QmiNasSwiSystemMode specified at @val. + line="1496">Gets the nickname string for the #QmiNasSwiSystemMode specified at @val. + line="1505"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1502">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasSwiSystemMode. + line="1498">a QmiNasSwiSystemMode. @@ -196416,21 +199677,21 @@ each #QmiNasSignalStrengthRequest in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="350">Builds a string containing a comma-separated list of nicknames for each #QmiNasTdScdmaBandPreference in @mask. + line="360"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="357">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiNasTdScdmaBandPreference values. + line="352">bitmask of QmiNasTdScdmaBandPreference values. @@ -196442,20 +199703,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.24"> Gets the nickname string for the #QmiNasUsagePreference specified at @val. + line="1464">Gets the nickname string for the #QmiNasUsagePreference specified at @val. + line="1473"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1470">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasUsagePreference. + line="1466">a QmiNasUsagePreference. @@ -196466,20 +199727,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.24"> Gets the nickname string for the #QmiNasVoiceDomainPreference specified at @val. + line="1160">Gets the nickname string for the #QmiNasVoiceDomainPreference specified at @val. + line="1169"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1166">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasVoiceDomainPreference. + line="1162">a QmiNasVoiceDomainPreference. @@ -196491,20 +199752,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.0"> Gets the nickname string for the #QmiNasWcdmaHsService specified at @val. + line="1256">Gets the nickname string for the #QmiNasWcdmaHsService specified at @val. + line="1265"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1262">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasWcdmaHsService. + line="1258">a QmiNasWcdmaHsService. @@ -196515,20 +199776,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.10"> Gets the nickname string for the #QmiNasWcdmaRrcState specified at @val. + line="1352">Gets the nickname string for the #QmiNasWcdmaRrcState specified at @val. + line="1361"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1358">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiNasWcdmaRrcState. + line="1354">a QmiNasWcdmaRrcState. @@ -196539,20 +199800,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.6"> Gets the nickname string for the #QmiOmaHfaFeatureDoneState specified at @val. + line="1706">Gets the nickname string for the #QmiOmaHfaFeatureDoneState specified at @val. + line="1715"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1712">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiOmaHfaFeatureDoneState. + line="1708">a QmiOmaHfaFeatureDoneState. @@ -196564,20 +199825,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.6"> Gets the nickname string for the #QmiOmaSessionFailedReason specified at @val. + line="1690">Gets the nickname string for the #QmiOmaSessionFailedReason specified at @val. + line="1699"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1696">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiOmaSessionFailedReason. + line="1692">a QmiOmaSessionFailedReason. @@ -196589,20 +199850,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.6"> Gets the nickname string for the #QmiOmaSessionState specified at @val. + line="1674">Gets the nickname string for the #QmiOmaSessionState specified at @val. + line="1683"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1680">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiOmaSessionState. + line="1676">a QmiOmaSessionState. @@ -196613,20 +199874,20 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.6"> Gets the nickname string for the #QmiOmaSessionType specified at @val. + line="1658">Gets the nickname string for the #QmiOmaSessionType specified at @val. + line="1667"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1664">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiOmaSessionType. + line="1660">a QmiOmaSessionType. @@ -196637,21 +199898,21 @@ each #QmiNasTdScdmaBandPreference in @mask. version="1.6"> Builds a string containing a comma-separated list of nicknames for + line="386">Builds a string containing a comma-separated list of nicknames for each #QmiPbmEventRegistrationFlag in @mask. + line="396"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="393">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiPbmEventRegistrationFlag values. + line="388">bitmask of QmiPbmEventRegistrationFlag values. @@ -196663,21 +199924,21 @@ each #QmiPbmEventRegistrationFlag in @mask. version="1.6"> Builds a string containing a comma-separated list of nicknames for + line="403">Builds a string containing a comma-separated list of nicknames for each #QmiPbmPhonebookType in @mask. + line="413"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="410">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiPbmPhonebookType values. + line="405">bitmask of QmiPbmPhonebookType values. @@ -196688,20 +199949,20 @@ each #QmiPbmPhonebookType in @mask. version="1.6"> Gets the nickname string for the #QmiPbmSessionType specified at @val. + line="1724">Gets the nickname string for the #QmiPbmSessionType specified at @val. + line="1733"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1730">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPbmSessionType. + line="1726">a QmiPbmSessionType. @@ -196712,20 +199973,20 @@ each #QmiPbmPhonebookType in @mask. version="1.18"> Gets the nickname string for the #QmiPdcConfigurationType specified at @val. + line="1742">Gets the nickname string for the #QmiPdcConfigurationType specified at @val. + line="1751"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1748">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdcConfigurationType. + line="1744">a QmiPdcConfigurationType. @@ -196736,20 +199997,20 @@ each #QmiPbmPhonebookType in @mask. version="1.32"> Gets the nickname string for the #QmiPdcRefreshEventType specified at @val. + line="1758">Gets the nickname string for the #QmiPdcRefreshEventType specified at @val. + line="1767"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1764">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdcRefreshEventType. + line="1760">a QmiPdcRefreshEventType. @@ -196760,21 +200021,21 @@ each #QmiPbmPhonebookType in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="422">Builds a string containing a comma-separated list of nicknames for each #QmiPdsDataValid in @mask. + line="432"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="429">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiPdsDataValid values. + line="424">bitmask of QmiPdsDataValid values. @@ -196785,20 +200046,20 @@ each #QmiPdsDataValid in @mask. version="1.12"> Gets the nickname string for the #QmiPdsNetworkMode specified at @val. + line="1840">Gets the nickname string for the #QmiPdsNetworkMode specified at @val. + line="1849"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1846">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdsNetworkMode. + line="1842">a QmiPdsNetworkMode. @@ -196809,20 +200070,20 @@ each #QmiPdsDataValid in @mask. version="1.12"> Gets the nickname string for the #QmiPdsOperatingMode specified at @val. + line="1824">Gets the nickname string for the #QmiPdsOperatingMode specified at @val. + line="1833"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1830">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdsOperatingMode. + line="1826">a QmiPdsOperatingMode. @@ -196833,20 +200094,20 @@ each #QmiPdsDataValid in @mask. version="1.0"> Gets the nickname string for the #QmiPdsOperationMode specified at @val. + line="1776">Gets the nickname string for the #QmiPdsOperationMode specified at @val. + line="1785"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1782">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdsOperationMode. + line="1778">a QmiPdsOperationMode. @@ -196857,20 +200118,20 @@ each #QmiPdsDataValid in @mask. version="1.0"> Gets the nickname string for the #QmiPdsPositionSessionStatus specified at @val. + line="1792">Gets the nickname string for the #QmiPdsPositionSessionStatus specified at @val. + line="1801"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1798">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdsPositionSessionStatus. + line="1794">a QmiPdsPositionSessionStatus. @@ -196882,20 +200143,20 @@ each #QmiPdsDataValid in @mask. version="1.0"> Gets the nickname string for the #QmiPdsTrackingSessionState specified at @val. + line="1808">Gets the nickname string for the #QmiPdsTrackingSessionState specified at @val. + line="1817"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1814">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiPdsTrackingSessionState. + line="1810">a QmiPdsTrackingSessionState. @@ -196977,6 +200238,21 @@ called in order to release the unique client ID reserved. filename="src/libqmi-glib/generated/qmi-gms.c" line="1084">#QmiClient which handles operations in the GMS service. + + #QmiClient which handles operations in the IMS service. + + + #QmiClient which handles operations in the IMSA service. + + + #QmiClient which handles operations in the IMSP service. + filename="src/libqmi-glib/generated/qmi-sar.c" line="908">#QmiClient which handles operations in the SAR service. + + #QmiClient which handles operations in the SSC service. + This section defines enumerations and flags used in the GAS service +interface. + + + This section defines enumerations and flags used in the IMSA service +interface. + + + This section defines enumerations and flags used in the IMSP service interface. @@ -197125,6 +200418,12 @@ interface. This section defines enumerations and flags used in the SAR service +interface. + + + This section defines enumerations and flags used in the SSC service interface. @@ -197362,6 +200661,16 @@ interface. filename="src/libqmi-glib/generated/qmi-qos.h" line="139">Collection of methods to parse indications of the QOS Network Status message. + + Collection of methods to parse indications of the SSC Report Large message. + + + Collection of methods to parse indications of the SSC Report Small message. + filename="src/libqmi-glib/generated/qmi-gms.h" line="45">Collection of methods to create requests and parse responses of the GMS Test Set Value message. + + Collection of methods to create requests and parse responses of the IMS Get IMS Services Enabled Setting message. + + + Collection of methods to create requests and parse responses of the IMSA Get IMS Registration Status message. + + + Collection of methods to create requests and parse responses of the IMSA Get IMS Services Status message. + + + Collection of methods to create requests and parse responses of the IMSP Get Enabler State message. + filename="src/libqmi-glib/generated/qmi-sar.h" line="46">Collection of methods to create requests and parse responses of the SAR RF Set State message. + + Collection of methods to create requests and parse responses of the SSC Control message. + version="1.22"> Gets the nickname string for the #QmiQosEvent specified at @val. + line="1874">Gets the nickname string for the #QmiQosEvent specified at @val. + line="1883"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1880">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiQosEvent. + line="1876">a QmiQosEvent. @@ -198778,20 +202112,20 @@ with the QMI library. version="1.22"> Gets the nickname string for the #QmiQosStatus specified at @val. + line="1858">Gets the nickname string for the #QmiQosStatus specified at @val. + line="1867"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1864">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiQosStatus. + line="1860">a QmiQosStatus. @@ -198802,20 +202136,20 @@ with the QMI library. version="1.28"> Gets the nickname string for the #QmiSarRfState specified at @val. + line="1892">Gets the nickname string for the #QmiSarRfState specified at @val. + line="1901"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1898">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiSarRfState. + line="1894">a QmiSarRfState. @@ -198826,20 +202160,20 @@ with the QMI library. version="1.0"> Gets the nickname string for the #QmiService specified at @val. + line="3506">Gets the nickname string for the #QmiService specified at @val. + line="3515"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3512">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiService. + line="3508">a QmiService. @@ -198850,44 +202184,68 @@ with the QMI library. version="1.28"> Gets the nickname string for the #QmiSioPort specified at @val. + line="3554">Gets the nickname string for the #QmiSioPort specified at @val. + line="3563"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3560">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiSioPort. + line="3556">a QmiSioPort. + + Gets the nickname string for the #QmiSscReportType specified at @val. + + + a string with the nickname, or %NULL if not found. Do not free the returned value. + + + + + a QmiSscReportType. + + + + Gets the nickname string for the #QmiUimCardApplicationPersonalizationFeature specified at @val. + line="2088">Gets the nickname string for the #QmiUimCardApplicationPersonalizationFeature specified at @val. + line="2097"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2094">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardApplicationPersonalizationFeature. + line="2090">a QmiUimCardApplicationPersonalizationFeature. @@ -198899,20 +202257,20 @@ with the QMI library. version="1.34"> Gets the nickname string for the #QmiUimCardApplicationPersonalizationFeatureStatus specified at @val. + line="2104">Gets the nickname string for the #QmiUimCardApplicationPersonalizationFeatureStatus specified at @val. + line="2113"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2110">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardApplicationPersonalizationFeatureStatus. + line="2106">a QmiUimCardApplicationPersonalizationFeatureStatus. @@ -198924,20 +202282,20 @@ with the QMI library. version="1.10"> Gets the nickname string for the #QmiUimCardApplicationPersonalizationState specified at @val. + line="2072">Gets the nickname string for the #QmiUimCardApplicationPersonalizationState specified at @val. + line="2081"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2078">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardApplicationPersonalizationState. + line="2074">a QmiUimCardApplicationPersonalizationState. @@ -198949,20 +202307,20 @@ with the QMI library. version="1.10"> Gets the nickname string for the #QmiUimCardApplicationState specified at @val. + line="2056">Gets the nickname string for the #QmiUimCardApplicationState specified at @val. + line="2065"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2062">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardApplicationState. + line="2058">a QmiUimCardApplicationState. @@ -198974,20 +202332,20 @@ with the QMI library. version="1.10"> Gets the nickname string for the #QmiUimCardApplicationType specified at @val. + line="2040">Gets the nickname string for the #QmiUimCardApplicationType specified at @val. + line="2049"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2046">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardApplicationType. + line="2042">a QmiUimCardApplicationType. @@ -198999,20 +202357,20 @@ with the QMI library. version="1.10"> Gets the nickname string for the #QmiUimCardError specified at @val. + line="2024">Gets the nickname string for the #QmiUimCardError specified at @val. + line="2033"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2030">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardError. + line="2026">a QmiUimCardError. @@ -199023,20 +202381,20 @@ with the QMI library. version="1.26"> Gets the nickname string for the #QmiUimCardProtocol specified at @val. + line="2184">Gets the nickname string for the #QmiUimCardProtocol specified at @val. + line="2193"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2190">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardProtocol. + line="2186">a QmiUimCardProtocol. @@ -199047,20 +202405,20 @@ with the QMI library. version="1.10"> Gets the nickname string for the #QmiUimCardState specified at @val. + line="1992">Gets the nickname string for the #QmiUimCardState specified at @val. + line="2001"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1998">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimCardState. + line="1994">a QmiUimCardState. @@ -199071,21 +202429,21 @@ with the QMI library. version="1.30"> Builds a string containing a comma-separated list of nicknames for + line="475">Builds a string containing a comma-separated list of nicknames for each #QmiUimConfiguration in @mask. + line="485"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="482">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiUimConfiguration values. + line="477">bitmask of QmiUimConfiguration values. @@ -199096,20 +202454,20 @@ each #QmiUimConfiguration in @mask. version="1.30"> Gets the nickname string for the #QmiUimDepersonalizationOperation specified at @val. + line="2200">Gets the nickname string for the #QmiUimDepersonalizationOperation specified at @val. + line="2209"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2206">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimDepersonalizationOperation. + line="2202">a QmiUimDepersonalizationOperation. @@ -199121,21 +202479,21 @@ each #QmiUimConfiguration in @mask. version="1.22.4"> Builds a string containing a comma-separated list of nicknames for + line="441">Builds a string containing a comma-separated list of nicknames for each #QmiUimEventRegistrationFlag in @mask. + line="451"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="448">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiUimEventRegistrationFlag values. + line="443">bitmask of QmiUimEventRegistrationFlag values. @@ -199147,20 +202505,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.6"> Gets the nickname string for the #QmiUimFileType specified at @val. + line="1944">Gets the nickname string for the #QmiUimFileType specified at @val. + line="1953"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1950">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimFileType. + line="1946">a QmiUimFileType. @@ -199171,20 +202529,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.26"> Gets the nickname string for the #QmiUimPhysicalCardState specified at @val. + line="2152">Gets the nickname string for the #QmiUimPhysicalCardState specified at @val. + line="2161"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2158">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimPhysicalCardState. + line="2154">a QmiUimPhysicalCardState. @@ -199195,20 +202553,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.14"> Gets the nickname string for the #QmiUimPinId specified at @val. + line="1976">Gets the nickname string for the #QmiUimPinId specified at @val. + line="1985"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1982">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimPinId. + line="1978">a QmiUimPinId. @@ -199219,20 +202577,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.10"> Gets the nickname string for the #QmiUimPinState specified at @val. + line="2008">Gets the nickname string for the #QmiUimPinState specified at @val. + line="2017"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2014">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimPinState. + line="2010">a QmiUimPinState. @@ -199243,20 +202601,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.28"> Gets the nickname string for the #QmiUimRefreshMode specified at @val. + line="2136">Gets the nickname string for the #QmiUimRefreshMode specified at @val. + line="2145"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2142">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimRefreshMode. + line="2138">a QmiUimRefreshMode. @@ -199267,20 +202625,20 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.28"> Gets the nickname string for the #QmiUimRefreshStage specified at @val. + line="2120">Gets the nickname string for the #QmiUimRefreshStage specified at @val. + line="2129"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2126">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimRefreshStage. + line="2122">a QmiUimRefreshStage. @@ -199291,21 +202649,21 @@ each #QmiUimEventRegistrationFlag in @mask. version="1.6"> Builds a string containing a comma-separated list of nicknames for + line="458">Builds a string containing a comma-separated list of nicknames for each #QmiUimSecurityAttribute in @mask. + line="468"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="465">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiUimSecurityAttribute values. + line="460">bitmask of QmiUimSecurityAttribute values. @@ -199316,20 +202674,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.6"> Gets the nickname string for the #QmiUimSecurityAttributeLogic specified at @val. + line="1960">Gets the nickname string for the #QmiUimSecurityAttributeLogic specified at @val. + line="1969"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1966">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimSecurityAttributeLogic. + line="1962">a QmiUimSecurityAttributeLogic. @@ -199341,20 +202699,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.6"> Gets the nickname string for the #QmiUimSessionType specified at @val. + line="1928">Gets the nickname string for the #QmiUimSessionType specified at @val. + line="1937"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="1934">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimSessionType. + line="1930">a QmiUimSessionType. @@ -199365,20 +202723,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.26"> Gets the nickname string for the #QmiUimSlotState specified at @val. + line="2168">Gets the nickname string for the #QmiUimSlotState specified at @val. + line="2177"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2174">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiUimSlotState. + line="2170">a QmiUimSlotState. @@ -199455,20 +202813,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.26"> Gets the nickname string for the #QmiVoiceAlphaDataCodingScheme specified at @val. + line="2410">Gets the nickname string for the #QmiVoiceAlphaDataCodingScheme specified at @val. + line="2419"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2416">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceAlphaDataCodingScheme. + line="2412">a QmiVoiceAlphaDataCodingScheme. @@ -199480,20 +202838,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoiceAls specified at @val. + line="2282">Gets the nickname string for the #QmiVoiceAls specified at @val. + line="2291"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2288">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceAls. + line="2284">a QmiVoiceAls. @@ -199504,20 +202862,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.26"> Gets the nickname string for the #QmiVoiceCallControlResultType specified at @val. + line="2442">Gets the nickname string for the #QmiVoiceCallControlResultType specified at @val. + line="2451"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2448">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallControlResultType. + line="2444">a QmiVoiceCallControlResultType. @@ -199529,20 +202887,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.26"> Gets the nickname string for the #QmiVoiceCallControlSupplementaryServiceType specified at @val. + line="2458">Gets the nickname string for the #QmiVoiceCallControlSupplementaryServiceType specified at @val. + line="2467"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2464">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallControlSupplementaryServiceType. + line="2460">a QmiVoiceCallControlSupplementaryServiceType. @@ -199554,20 +202912,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoiceCallDirection specified at @val. + line="2250">Gets the nickname string for the #QmiVoiceCallDirection specified at @val. + line="2259"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2256">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallDirection. + line="2252">a QmiVoiceCallDirection. @@ -199578,20 +202936,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.26"> Gets the nickname string for the #QmiVoiceCallEndReason specified at @val. + line="2426">Gets the nickname string for the #QmiVoiceCallEndReason specified at @val. + line="2435"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2432">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallEndReason. + line="2428">a QmiVoiceCallEndReason. @@ -199602,20 +202960,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoiceCallMode specified at @val. + line="2266">Gets the nickname string for the #QmiVoiceCallMode specified at @val. + line="2275"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2272">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallMode. + line="2268">a QmiVoiceCallMode. @@ -199626,20 +202984,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoiceCallState specified at @val. + line="2218">Gets the nickname string for the #QmiVoiceCallState specified at @val. + line="2227"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2224">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallState. + line="2220">a QmiVoiceCallState. @@ -199650,20 +203008,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoiceCallType specified at @val. + line="2234">Gets the nickname string for the #QmiVoiceCallType specified at @val. + line="2243"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2240">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceCallType. + line="2236">a QmiVoiceCallType. @@ -199674,20 +203032,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoiceDomain specified at @val. + line="2362">Gets the nickname string for the #QmiVoiceDomain specified at @val. + line="2371"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2368">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceDomain. + line="2364">a QmiVoiceDomain. @@ -199698,20 +203056,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoicePresentation specified at @val. + line="2298">Gets the nickname string for the #QmiVoicePresentation specified at @val. + line="2307"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2304">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoicePresentation. + line="2300">a QmiVoicePresentation. @@ -199722,20 +203080,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoicePrivacy specified at @val. + line="2346">Gets the nickname string for the #QmiVoicePrivacy specified at @val. + line="2355"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2352">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoicePrivacy. + line="2348">a QmiVoicePrivacy. @@ -199746,20 +203104,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoiceServiceOption specified at @val. + line="2330">Gets the nickname string for the #QmiVoiceServiceOption specified at @val. + line="2339"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2336">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceServiceOption. + line="2332">a QmiVoiceServiceOption. @@ -199770,20 +203128,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.30"> Gets the nickname string for the #QmiVoiceSupplementaryServiceAction specified at @val. + line="2506">Gets the nickname string for the #QmiVoiceSupplementaryServiceAction specified at @val. + line="2515"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2512">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceSupplementaryServiceAction. + line="2508">a QmiVoiceSupplementaryServiceAction. @@ -199795,20 +203153,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.30"> Gets the nickname string for the #QmiVoiceSupplementaryServiceNotificationType specified at @val. + line="2490">Gets the nickname string for the #QmiVoiceSupplementaryServiceNotificationType specified at @val. + line="2499"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2496">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceSupplementaryServiceNotificationType. + line="2492">a QmiVoiceSupplementaryServiceNotificationType. @@ -199820,20 +203178,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.30"> Gets the nickname string for the #QmiVoiceSupplementaryServiceReason specified at @val. + line="2522">Gets the nickname string for the #QmiVoiceSupplementaryServiceReason specified at @val. + line="2531"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2528">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceSupplementaryServiceReason. + line="2524">a QmiVoiceSupplementaryServiceReason. @@ -199845,20 +203203,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.30"> Gets the nickname string for the #QmiVoiceSupplementaryServiceType specified at @val. + line="2474">Gets the nickname string for the #QmiVoiceSupplementaryServiceType specified at @val. + line="2483"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2480">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceSupplementaryServiceType. + line="2476">a QmiVoiceSupplementaryServiceType. @@ -199870,20 +203228,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Gets the nickname string for the #QmiVoiceTtyMode specified at @val. + line="2314">Gets the nickname string for the #QmiVoiceTtyMode specified at @val. + line="2323"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2320">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceTtyMode. + line="2316">a QmiVoiceTtyMode. @@ -199894,20 +203252,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.26"> Gets the nickname string for the #QmiVoiceUserAction specified at @val. + line="2378">Gets the nickname string for the #QmiVoiceUserAction specified at @val. + line="2387"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2384">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceUserAction. + line="2380">a QmiVoiceUserAction. @@ -199918,20 +203276,20 @@ each #QmiUimSecurityAttribute in @mask. version="1.26"> Gets the nickname string for the #QmiVoiceUssDataCodingScheme specified at @val. + line="2394">Gets the nickname string for the #QmiVoiceUssDataCodingScheme specified at @val. + line="2403"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2400">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiVoiceUssDataCodingScheme. + line="2396">a QmiVoiceUssDataCodingScheme. @@ -199943,21 +203301,21 @@ each #QmiUimSecurityAttribute in @mask. version="1.14"> Builds a string containing a comma-separated list of nicknames for + line="494">Builds a string containing a comma-separated list of nicknames for each #QmiVoiceWcdmaAmrStatus in @mask. + line="504"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="501">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiVoiceWcdmaAmrStatus values. + line="496">bitmask of QmiVoiceWcdmaAmrStatus values. @@ -199968,20 +203326,20 @@ each #QmiVoiceWcdmaAmrStatus in @mask. version="1.10"> Gets the nickname string for the #QmiWdaDataAggregationProtocol specified at @val. + line="2556">Gets the nickname string for the #QmiWdaDataAggregationProtocol specified at @val. + line="2565"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2562">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdaDataAggregationProtocol. + line="2558">a QmiWdaDataAggregationProtocol. @@ -199993,20 +203351,20 @@ each #QmiVoiceWcdmaAmrStatus in @mask. version="1.10"> Gets the nickname string for the #QmiWdaLinkLayerProtocol specified at @val. + line="2540">Gets the nickname string for the #QmiWdaLinkLayerProtocol specified at @val. + line="2549"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2546">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdaLinkLayerProtocol. + line="2542">a QmiWdaLinkLayerProtocol. @@ -200041,20 +203399,20 @@ each #QmiWdsApnTypeMask in @mask. version="1.28"> Gets the nickname string for the #QmiWdsAttachPdnListAction specified at @val. + line="3150">Gets the nickname string for the #QmiWdsAttachPdnListAction specified at @val. + line="3159"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3156">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsAttachPdnListAction. + line="3152">a QmiWdsAttachPdnListAction. @@ -200066,21 +203424,21 @@ each #QmiWdsApnTypeMask in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="649">Builds a string containing a comma-separated list of nicknames for each #QmiWdsAuthentication in @mask. + line="659"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="656">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsAuthentication values. + line="651">bitmask of QmiWdsAuthentication values. @@ -200091,20 +203449,20 @@ each #QmiWdsAuthentication in @mask. version="1.14"> Gets the nickname string for the #QmiWdsAutoconnectSetting specified at @val. + line="2990">Gets the nickname string for the #QmiWdsAutoconnectSetting specified at @val. + line="2999"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2996">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsAutoconnectSetting. + line="2992">a QmiWdsAutoconnectSetting. @@ -200116,20 +203474,20 @@ each #QmiWdsAuthentication in @mask. version="1.14"> Gets the nickname string for the #QmiWdsAutoconnectSettingRoaming specified at @val. + line="3006">Gets the nickname string for the #QmiWdsAutoconnectSettingRoaming specified at @val. + line="3015"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3012">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsAutoconnectSettingRoaming. + line="3008">a QmiWdsAutoconnectSettingRoaming. @@ -200141,20 +203499,20 @@ each #QmiWdsAuthentication in @mask. version="1.0"> Gets the nickname string for the #QmiWdsCallEndReason specified at @val. + line="2622">Gets the nickname string for the #QmiWdsCallEndReason specified at @val. + line="2631"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2628">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsCallEndReason. + line="2624">a QmiWdsCallEndReason. @@ -200165,20 +203523,20 @@ each #QmiWdsAuthentication in @mask. version="1.0"> Gets the nickname string for the #QmiWdsCallType specified at @val. + line="2606">Gets the nickname string for the #QmiWdsCallType specified at @val. + line="2615"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2612">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsCallType. + line="2608">a QmiWdsCallType. @@ -200189,20 +203547,20 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Gets the nickname string for the #QmiWdsClientType specified at @val. + line="3166">Gets the nickname string for the #QmiWdsClientType specified at @val. + line="3175"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3172">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsClientType. + line="3168">a QmiWdsClientType. @@ -200213,20 +203571,20 @@ each #QmiWdsAuthentication in @mask. version="1.0"> Gets the nickname string for the #QmiWdsConnectionStatus specified at @val. + line="2766">Gets the nickname string for the #QmiWdsConnectionStatus specified at @val. + line="2775"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2772">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsConnectionStatus. + line="2768">a QmiWdsConnectionStatus. @@ -200237,20 +203595,20 @@ each #QmiWdsAuthentication in @mask. version="1.0"> Gets the nickname string for the #QmiWdsDataBearerTechnology specified at @val. + line="2782">Gets the nickname string for the #QmiWdsDataBearerTechnology specified at @val. + line="2791"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2788">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDataBearerTechnology. + line="2784">a QmiWdsDataBearerTechnology. @@ -200262,20 +203620,20 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Gets the nickname string for the #QmiWdsDataCallStatus specified at @val. + line="3038">Gets the nickname string for the #QmiWdsDataCallStatus specified at @val. + line="3047"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3044">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDataCallStatus. + line="3040">a QmiWdsDataCallStatus. @@ -200286,20 +203644,20 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Gets the nickname string for the #QmiWdsDataCallType specified at @val. + line="3054">Gets the nickname string for the #QmiWdsDataCallType specified at @val. + line="3063"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3060">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDataCallType. + line="3056">a QmiWdsDataCallType. @@ -200310,20 +203668,20 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Gets the nickname string for the #QmiWdsDataSystem specified at @val. + line="2830">Gets the nickname string for the #QmiWdsDataSystem specified at @val. + line="2839"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2836">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDataSystem. + line="2832">a QmiWdsDataSystem. @@ -200334,20 +203692,20 @@ each #QmiWdsAuthentication in @mask. version="1.14"> Gets the nickname string for the #QmiWdsDataSystemNetworkType specified at @val. + line="2814">Gets the nickname string for the #QmiWdsDataSystemNetworkType specified at @val. + line="2823"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2820">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDataSystemNetworkType. + line="2816">a QmiWdsDataSystemNetworkType. @@ -200359,20 +203717,20 @@ each #QmiWdsAuthentication in @mask. version="1.14"> Gets the nickname string for the #QmiWdsDeliveryOrder specified at @val. + line="2910">Gets the nickname string for the #QmiWdsDeliveryOrder specified at @val. + line="2919"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2916">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDeliveryOrder. + line="2912">a QmiWdsDeliveryOrder. @@ -200383,20 +203741,20 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Gets the nickname string for the #QmiWdsDormancyStatus specified at @val. + line="3022">Gets the nickname string for the #QmiWdsDormancyStatus specified at @val. + line="3031"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3028">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDormancyStatus. + line="3024">a QmiWdsDormancyStatus. @@ -200407,20 +203765,20 @@ each #QmiWdsAuthentication in @mask. version="1.8"> Gets the nickname string for the #QmiWdsDsProfileError specified at @val. + line="2974">Gets the nickname string for the #QmiWdsDsProfileError specified at @val. + line="2983"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2980">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsDsProfileError. + line="2976">a QmiWdsDsProfileError. @@ -200431,21 +203789,21 @@ each #QmiWdsAuthentication in @mask. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="717">Builds a string containing a comma-separated list of nicknames for each #QmiWdsExtendedDataBearerTechnology3gpp2 in @mask. + line="727"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="724">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsExtendedDataBearerTechnology3gpp2 values. + line="719">bitmask of QmiWdsExtendedDataBearerTechnology3gpp2 values. @@ -200457,21 +203815,21 @@ each #QmiWdsExtendedDataBearerTechnology3gpp2 in @mask. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="700">Builds a string containing a comma-separated list of nicknames for each #QmiWdsExtendedDataBearerTechnology3gpp in @mask. + line="710"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="707">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsExtendedDataBearerTechnology3gpp values. + line="702">bitmask of QmiWdsExtendedDataBearerTechnology3gpp values. @@ -200483,20 +203841,20 @@ each #QmiWdsExtendedDataBearerTechnology3gpp in @mask. version="1.0"> Gets the nickname string for the #QmiWdsExtendedTechnologyPreference specified at @val. + line="2590">Gets the nickname string for the #QmiWdsExtendedTechnologyPreference specified at @val. + line="2599"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2596">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsExtendedTechnologyPreference. + line="2592">a QmiWdsExtendedTechnologyPreference. @@ -200508,20 +203866,20 @@ each #QmiWdsExtendedDataBearerTechnology3gpp in @mask. version="1.0"> Gets the nickname string for the #QmiWdsIpFamily specified at @val. + line="2574">Gets the nickname string for the #QmiWdsIpFamily specified at @val. + line="2583"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2580">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsIpFamily. + line="2576">a QmiWdsIpFamily. @@ -200532,20 +203890,20 @@ each #QmiWdsExtendedDataBearerTechnology3gpp in @mask. version="1.28"> Gets the nickname string for the #QmiWdsIpSupportType specified at @val. + line="3182">Gets the nickname string for the #QmiWdsIpSupportType specified at @val. + line="3191"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3188">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsIpSupportType. + line="3184">a QmiWdsIpSupportType. @@ -200556,20 +203914,20 @@ each #QmiWdsExtendedDataBearerTechnology3gpp in @mask. version="1.0"> Gets the nickname string for the #QmiWdsNetworkType specified at @val. + line="2798">Gets the nickname string for the #QmiWdsNetworkType specified at @val. + line="2807"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2804">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsNetworkType. + line="2800">a QmiWdsNetworkType. @@ -200580,21 +203938,21 @@ each #QmiWdsExtendedDataBearerTechnology3gpp in @mask. version="1.6"> Builds a string containing a comma-separated list of nicknames for + line="666">Builds a string containing a comma-separated list of nicknames for each #QmiWdsPacketStatisticsMaskFlag in @mask. + line="676"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="673">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsPacketStatisticsMaskFlag values. + line="668">bitmask of QmiWdsPacketStatisticsMaskFlag values. @@ -200606,20 +203964,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.18"> Gets the nickname string for the #QmiWdsPdpDataCompressionType specified at @val. + line="3118">Gets the nickname string for the #QmiWdsPdpDataCompressionType specified at @val. + line="3127"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3124">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsPdpDataCompressionType. + line="3120">a QmiWdsPdpDataCompressionType. @@ -200631,20 +203989,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.18"> Gets the nickname string for the #QmiWdsPdpHeaderCompressionType specified at @val. + line="3102">Gets the nickname string for the #QmiWdsPdpHeaderCompressionType specified at @val. + line="3111"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3108">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsPdpHeaderCompressionType. + line="3104">a QmiWdsPdpHeaderCompressionType. @@ -200656,20 +204014,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.0"> Gets the nickname string for the #QmiWdsPdpType specified at @val. + line="2846">Gets the nickname string for the #QmiWdsPdpType specified at @val. + line="2855"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2852">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsPdpType. + line="2848">a QmiWdsPdpType. @@ -200680,20 +204038,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.34"> Gets the nickname string for the #QmiWdsProfileChangeEvent specified at @val. + line="3198">Gets the nickname string for the #QmiWdsProfileChangeEvent specified at @val. + line="3207"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3204">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsProfileChangeEvent. + line="3200">a QmiWdsProfileChangeEvent. @@ -200705,20 +204063,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.22"> Gets the nickname string for the #QmiWdsProfileFamily specified at @val. + line="2894">Gets the nickname string for the #QmiWdsProfileFamily specified at @val. + line="2903"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2900">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsProfileFamily. + line="2896">a QmiWdsProfileFamily. @@ -200729,20 +204087,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.0"> Gets the nickname string for the #QmiWdsProfileType specified at @val. + line="2878">Gets the nickname string for the #QmiWdsProfileType specified at @val. + line="2887"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2884">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsProfileType. + line="2880">a QmiWdsProfileType. @@ -200753,20 +204111,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.18"> Gets the nickname string for the #QmiWdsQosClassIdentifier specified at @val. + line="3134">Gets the nickname string for the #QmiWdsQosClassIdentifier specified at @val. + line="3143"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3140">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsQosClassIdentifier. + line="3136">a QmiWdsQosClassIdentifier. @@ -200778,20 +204136,20 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.18"> Gets the nickname string for the #QmiWdsRadioAccessTechnology specified at @val. + line="3086">Gets the nickname string for the #QmiWdsRadioAccessTechnology specified at @val. + line="3095"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3092">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsRadioAccessTechnology. + line="3088">a QmiWdsRadioAccessTechnology. @@ -200803,21 +204161,21 @@ each #QmiWdsPacketStatisticsMaskFlag in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="530">Builds a string containing a comma-separated list of nicknames for each #QmiWdsRat3gpp2 in @mask. + line="540"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="537">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsRat3gpp2 values. + line="532">bitmask of QmiWdsRat3gpp2 values. @@ -200828,21 +204186,21 @@ each #QmiWdsRat3gpp2 in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="547">Builds a string containing a comma-separated list of nicknames for each #QmiWdsRat3gpp in @mask. + line="557"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="554">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsRat3gpp values. + line="549">bitmask of QmiWdsRat3gpp values. @@ -200853,21 +204211,21 @@ each #QmiWdsRat3gpp in @mask. version="1.32"> Builds a string containing a comma-separated list of nicknames for + line="632">Builds a string containing a comma-separated list of nicknames for each #QmiWdsRequestedSettings in @mask. + line="642"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="639">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsRequestedSettings values. + line="634">bitmask of QmiWdsRequestedSettings values. @@ -200878,20 +204236,20 @@ each #QmiWdsRequestedSettings in @mask. version="1.14"> Gets the nickname string for the #QmiWdsSduErroneousDelivery specified at @val. + line="2958">Gets the nickname string for the #QmiWdsSduErroneousDelivery specified at @val. + line="2967"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2964">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsSduErroneousDelivery. + line="2960">a QmiWdsSduErroneousDelivery. @@ -200903,20 +204261,20 @@ each #QmiWdsRequestedSettings in @mask. version="1.14"> Gets the nickname string for the #QmiWdsSduErrorRatio specified at @val. + line="2926">Gets the nickname string for the #QmiWdsSduErrorRatio specified at @val. + line="2935"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2932">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsSduErrorRatio. + line="2928">a QmiWdsSduErrorRatio. @@ -200927,20 +204285,20 @@ each #QmiWdsRequestedSettings in @mask. version="1.14"> Gets the nickname string for the #QmiWdsSduResidualBitErrorRatio specified at @val. + line="2942">Gets the nickname string for the #QmiWdsSduResidualBitErrorRatio specified at @val. + line="2951"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2948">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsSduResidualBitErrorRatio. + line="2944">a QmiWdsSduResidualBitErrorRatio. @@ -200952,21 +204310,21 @@ each #QmiWdsRequestedSettings in @mask. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="683">Builds a string containing a comma-separated list of nicknames for each #QmiWdsSetEventReportTransferStatistics in @mask. + line="693"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="690">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsSetEventReportTransferStatistics values. + line="685">bitmask of QmiWdsSetEventReportTransferStatistics values. @@ -200978,21 +204336,21 @@ each #QmiWdsSetEventReportTransferStatistics in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="564">Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoCdma1x in @mask. + line="574"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="571">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsSoCdma1x values. + line="566">bitmask of QmiWdsSoCdma1x values. @@ -201003,21 +204361,21 @@ each #QmiWdsSoCdma1x in @mask. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="581">Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoEvdoRev0 in @mask. + line="591"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="588">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsSoEvdoRev0 values. + line="583">bitmask of QmiWdsSoEvdoRev0 values. @@ -201028,21 +204386,21 @@ each #QmiWdsSoEvdoRev0 in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="598">Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoEvdoRevA in @mask. + line="608"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="605">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsSoEvdoRevA values. + line="600">bitmask of QmiWdsSoEvdoRevA values. @@ -201053,21 +204411,21 @@ each #QmiWdsSoEvdoRevA in @mask. version="1.18"> Builds a string containing a comma-separated list of nicknames for + line="615">Builds a string containing a comma-separated list of nicknames for each #QmiWdsSoEvdoRevB in @mask. + line="625"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="622">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsSoEvdoRevB values. + line="617">bitmask of QmiWdsSoEvdoRevB values. @@ -201078,21 +204436,21 @@ each #QmiWdsSoEvdoRevB in @mask. version="1.0"> Builds a string containing a comma-separated list of nicknames for + line="513">Builds a string containing a comma-separated list of nicknames for each #QmiWdsTechnologyPreference in @mask. + line="523"/> a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). + line="520">a string with the list of nicknames, or %NULL if none given. The returned value should be freed with g_free(). bitmask of QmiWdsTechnologyPreference values. + line="515">bitmask of QmiWdsTechnologyPreference values. @@ -201104,20 +204462,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.18"> Gets the nickname string for the #QmiWdsTetheredCallType specified at @val. + line="3070">Gets the nickname string for the #QmiWdsTetheredCallType specified at @val. + line="3079"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3076">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsTetheredCallType. + line="3072">a QmiWdsTetheredCallType. @@ -201128,20 +204486,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsTrafficClass specified at @val. + line="2862">Gets the nickname string for the #QmiWdsTrafficClass specified at @val. + line="2871"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2868">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsTrafficClass. + line="2864">a QmiWdsTrafficClass. @@ -201152,20 +204510,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReason3gpp specified at @val. + line="2702">Gets the nickname string for the #QmiWdsVerboseCallEndReason3gpp specified at @val. + line="2711"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2708">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReason3gpp. + line="2704">a QmiWdsVerboseCallEndReason3gpp. @@ -201177,20 +204535,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonCm specified at @val. + line="2686">Gets the nickname string for the #QmiWdsVerboseCallEndReasonCm specified at @val. + line="2695"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2692">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonCm. + line="2688">a QmiWdsVerboseCallEndReasonCm. @@ -201202,20 +204560,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonEhrpd specified at @val. + line="2734">Gets the nickname string for the #QmiWdsVerboseCallEndReasonEhrpd specified at @val. + line="2743"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2740">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonEhrpd. + line="2736">a QmiWdsVerboseCallEndReasonEhrpd. @@ -201256,20 +204614,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonInternal specified at @val. + line="2670">Gets the nickname string for the #QmiWdsVerboseCallEndReasonInternal specified at @val. + line="2679"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2676">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonInternal. + line="2672">a QmiWdsVerboseCallEndReasonInternal. @@ -201281,20 +204639,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonIpv6 specified at @val. + line="2750">Gets the nickname string for the #QmiWdsVerboseCallEndReasonIpv6 specified at @val. + line="2759"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2756">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonIpv6. + line="2752">a QmiWdsVerboseCallEndReasonIpv6. @@ -201306,20 +204664,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonMip specified at @val. + line="2654">Gets the nickname string for the #QmiWdsVerboseCallEndReasonMip specified at @val. + line="2663"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2660">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonMip. + line="2656">a QmiWdsVerboseCallEndReasonMip. @@ -201331,20 +204689,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonPpp specified at @val. + line="2718">Gets the nickname string for the #QmiWdsVerboseCallEndReasonPpp specified at @val. + line="2727"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2724">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonPpp. + line="2720">a QmiWdsVerboseCallEndReasonPpp. @@ -201356,20 +204714,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWdsVerboseCallEndReasonType specified at @val. + line="2638">Gets the nickname string for the #QmiWdsVerboseCallEndReasonType specified at @val. + line="2647"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="2644">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWdsVerboseCallEndReasonType. + line="2640">a QmiWdsVerboseCallEndReasonType. @@ -201381,20 +204739,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.28"> Gets the nickname string for the #QmiWmsAckFailureCause specified at @val. + line="3488">Gets the nickname string for the #QmiWmsAckFailureCause specified at @val. + line="3497"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3494">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsAckFailureCause. + line="3490">a QmiWmsAckFailureCause. @@ -201405,20 +204763,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsAckIndicator specified at @val. + line="3232">Gets the nickname string for the #QmiWmsAckIndicator specified at @val. + line="3241"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3238">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsAckIndicator. + line="3234">a QmiWmsAckIndicator. @@ -201429,20 +204787,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsCdmaCauseCode specified at @val. + line="3312">Gets the nickname string for the #QmiWmsCdmaCauseCode specified at @val. + line="3321"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3318">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsCdmaCauseCode. + line="3314">a QmiWmsCdmaCauseCode. @@ -201453,20 +204811,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsCdmaErrorClass specified at @val. + line="3328">Gets the nickname string for the #QmiWmsCdmaErrorClass specified at @val. + line="3337"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3334">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsCdmaErrorClass. + line="3330">a QmiWmsCdmaErrorClass. @@ -201477,20 +204835,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsCdmaServiceOption specified at @val. + line="3296">Gets the nickname string for the #QmiWmsCdmaServiceOption specified at @val. + line="3305"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3302">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsCdmaServiceOption. + line="3298">a QmiWmsCdmaServiceOption. @@ -201501,20 +204859,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsGsmUmtsRpCause specified at @val. + line="3344">Gets the nickname string for the #QmiWmsGsmUmtsRpCause specified at @val. + line="3353"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3350">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsGsmUmtsRpCause. + line="3346">a QmiWmsGsmUmtsRpCause. @@ -201525,20 +204883,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsGsmUmtsTpCause specified at @val. + line="3360">Gets the nickname string for the #QmiWmsGsmUmtsTpCause specified at @val. + line="3369"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3366">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsGsmUmtsTpCause. + line="3362">a QmiWmsGsmUmtsTpCause. @@ -201549,20 +204907,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsMessageClass specified at @val. + line="3440">Gets the nickname string for the #QmiWmsMessageClass specified at @val. + line="3449"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3446">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageClass. + line="3442">a QmiWmsMessageClass. @@ -201573,20 +204931,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsMessageDeliveryFailureType specified at @val. + line="3376">Gets the nickname string for the #QmiWmsMessageDeliveryFailureType specified at @val. + line="3385"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3382">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageDeliveryFailureType. + line="3378">a QmiWmsMessageDeliveryFailureType. @@ -201598,20 +204956,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsMessageFormat specified at @val. + line="3248">Gets the nickname string for the #QmiWmsMessageFormat specified at @val. + line="3257"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3254">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageFormat. + line="3250">a QmiWmsMessageFormat. @@ -201622,20 +204980,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsMessageMode specified at @val. + line="3264">Gets the nickname string for the #QmiWmsMessageMode specified at @val. + line="3273"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3270">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageMode. + line="3266">a QmiWmsMessageMode. @@ -201646,20 +205004,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsMessageProtocol specified at @val. + line="3408">Gets the nickname string for the #QmiWmsMessageProtocol specified at @val. + line="3417"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3414">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageProtocol. + line="3410">a QmiWmsMessageProtocol. @@ -201670,20 +205028,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsMessageTagType specified at @val. + line="3392">Gets the nickname string for the #QmiWmsMessageTagType specified at @val. + line="3401"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3398">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageTagType. + line="3394">a QmiWmsMessageTagType. @@ -201694,20 +205052,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsMessageType specified at @val. + line="3424">Gets the nickname string for the #QmiWmsMessageType specified at @val. + line="3433"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3430">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsMessageType. + line="3426">a QmiWmsMessageType. @@ -201718,20 +205076,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsNotificationType specified at @val. + line="3280">Gets the nickname string for the #QmiWmsNotificationType specified at @val. + line="3289"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3286">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsNotificationType. + line="3282">a QmiWmsNotificationType. @@ -201742,20 +205100,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsReceiptAction specified at @val. + line="3456">Gets the nickname string for the #QmiWmsReceiptAction specified at @val. + line="3465"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3462">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsReceiptAction. + line="3458">a QmiWmsReceiptAction. @@ -201766,20 +205124,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsStorageType specified at @val. + line="3216">Gets the nickname string for the #QmiWmsStorageType specified at @val. + line="3225"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3222">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsStorageType. + line="3218">a QmiWmsStorageType. @@ -201790,20 +205148,20 @@ each #QmiWdsTechnologyPreference in @mask. version="1.0"> Gets the nickname string for the #QmiWmsTransferIndication specified at @val. + line="3472">Gets the nickname string for the #QmiWmsTransferIndication specified at @val. + line="3481"/> a string with the nickname, or %NULL if not found. Do not free the returned value. + line="3478">a string with the nickname, or %NULL if not found. Do not free the returned value. a QmiWmsTransferIndication. + line="3474">a QmiWmsTransferIndication. diff --git a/girs/Retro-1.gir b/girs/Retro-1.gir index 09b736374..08ae55e82 100644 --- a/girs/Retro-1.gir +++ b/girs/Retro-1.gir @@ -23,22 +23,24 @@ and/or use gtk-doc annotations. --> glib:get-type="retro_analog_id_get_type" c:type="RetroAnalogId"> Represents the axes of the analog sticks for the Libretro gamepad. + glib:nick="x" + glib:name="RETRO_ANALOG_ID_X"> the X axis of an analog stick + glib:nick="y" + glib:name="RETRO_ANALOG_ID_Y"> the Y axis of an analog stick @@ -47,22 +49,24 @@ and/or use gtk-doc annotations. --> glib:get-type="retro_analog_index_get_type" c:type="RetroAnalogIndex"> Represents the analog sticks for the Libretro gamepad. + glib:nick="left" + glib:name="RETRO_ANALOG_INDEX_LEFT"> the left analog stick + glib:nick="right" + glib:name="RETRO_ANALOG_INDEX_RIGHT"> the right analog stick @@ -72,26 +76,26 @@ and/or use gtk-doc annotations. --> glib:type-name="RetroController" glib:get-type="retro_controller_get_type" glib:type-struct="ControllerInterface"> - + Gets a flag representing the capabilities of @self. Each bit index matches the #RetroControllerType of same number. For example, if @self is an analog gamepad, the value would be: (1 << RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). - + the capabilities flag of @self a #RetroController @@ -99,19 +103,19 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). Gets the main type of the controller. - + the controller type of @self a #RetroController @@ -119,25 +123,25 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). Gets the state of an input of @self. - + the input's state a #RetroController a #RetroInput to query @self @@ -145,19 +149,19 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). Gets whether @self supports rumble effects. - + whether @self supports rumble effects. a #RetroController @@ -165,28 +169,28 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). Sets the rumble state of @self. - + a #RetroController the rumble effect the rumble effect strength @@ -194,7 +198,7 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). - + @@ -207,23 +211,23 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). Gets a flag representing the capabilities of @self. Each bit index matches the #RetroControllerType of same number. For example, if @self is an analog gamepad, the value would be: (1 << RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). - + the capabilities flag of @self a #RetroController @@ -232,19 +236,19 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). Gets the main type of the controller. - + the controller type of @self a #RetroController @@ -253,25 +257,25 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). Gets the state of an input of @self. - + the input's state a #RetroController a #RetroInput to query @self @@ -280,19 +284,19 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). Gets whether @self supports rumble effects. - + whether @self supports rumble effects. a #RetroController @@ -301,25 +305,25 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). Gets whether @self has the capability to represent the given controller type. - + whether @self has the capability a #RetroController a #RetroControllerType @@ -328,28 +332,28 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). Sets the rumble state of @self. - + a #RetroController the rumble effect the rumble effect strength @@ -365,35 +369,34 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). c:type="RetroControllerInterface" glib:is-gtype-struct-for="Controller"> An interface for a controller, e.g. a gamepad. - + The parent interface. - + the input's state a #RetroController a #RetroInput to query @self @@ -402,18 +405,17 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). - + the controller type of @self a #RetroController @@ -422,18 +424,17 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). - + the capabilities flag of @self a #RetroController @@ -442,18 +443,17 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). - + whether @self supports rumble effects. a #RetroController @@ -462,27 +462,26 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). - + a #RetroController the rumble effect the rumble effect strength @@ -497,24 +496,24 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). glib:type-name="RetroControllerIterator" glib:get-type="retro_controller_iterator_get_type" glib:type-struct="ControllerIteratorClass"> - Fetch the next #RetroController and the port number it is plugged into. - %FALSE if it reached the end, %TRUE otherwise a #RetroControllerIterator @@ -525,7 +524,7 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). optional="1" allow-none="1"> return location for the port @@ -536,7 +535,7 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). optional="1" allow-none="1"> return location for the controller @@ -546,7 +545,7 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). - @@ -557,76 +556,83 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). glib:get-type="retro_controller_type_get_type" c:type="RetroControllerType"> Represents the base types for Libretro controllers. + glib:nick="none" + glib:name="RETRO_CONTROLLER_TYPE_NONE"> no controller + glib:nick="joypad" + glib:name="RETRO_CONTROLLER_TYPE_JOYPAD"> a classic gamepad + glib:nick="mouse" + glib:name="RETRO_CONTROLLER_TYPE_MOUSE"> a simple mouse + glib:nick="keyboard" + glib:name="RETRO_CONTROLLER_TYPE_KEYBOARD"> a keyboard + glib:nick="lightgun" + glib:name="RETRO_CONTROLLER_TYPE_LIGHTGUN"> a lightgun + glib:nick="analog" + glib:name="RETRO_CONTROLLER_TYPE_ANALOG"> a gamepad with analog sticks + glib:nick="pointer" + glib:name="RETRO_CONTROLLER_TYPE_POINTER"> a screen pointer + glib:nick="type-mask" + glib:name="RETRO_CONTROLLER_TYPE_TYPE_MASK"> a mask to get the super type of a derived one - + @@ -638,8 +644,7 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). - + @@ -657,61 +662,63 @@ RETRO_CONTROLLER_TYPE_JOYPAD) | (1 << RETRO_CONTROLLER_TYPE_ANALOG). glib:type-name="RetroCore" glib:get-type="retro_core_get_type" glib:type-struct="CoreClass"> - + Creates a new #RetroCore. - + filename="retro-gtk/retro-core.c" + line="1895">Creates a new #RetroCore. + a new #RetroCore + filename="retro-gtk/retro-core.c" + line="1901">a new #RetroCore the filename of a Libretro core + filename="retro-gtk/retro-core.c" + line="1897">the filename of a Libretro core This initializes @self, loads its available options and loads the medias. You + filename="retro-gtk/retro-core.c" + line="1107">This initializes @self, loads its available options and loads the medias. You need to boot @self before using some of its methods. - + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1109">a #RetroCore - + Gets the Libretro API version implement by the core. - + filename="retro-gtk/retro-core.c" + line="671">Gets the Libretro API version implement by the core. + the API version + filename="retro-gtk/retro-core.c" + line="677">the API version a #RetroCore + filename="retro-gtk/retro-core.c" + line="673">a #RetroCore @@ -719,27 +726,28 @@ need to boot @self before using some of its methods. Gets whether the state of @self can be accessed. - + filename="retro-gtk/retro-core.c" + line="1381">Gets whether the state of @self can be accessed. + whether the state of @self can be accessed + filename="retro-gtk/retro-core.c" + line="1387">whether the state of @self can be accessed a #RetroCore + filename="retro-gtk/retro-core.c" + line="1383">a #RetroCore - + c:identifier="retro_core_get_content_directory" + glib:get-property="content-directory"> + @@ -749,142 +757,150 @@ need to boot @self before using some of its methods. - + Gets the filename of the core. - + filename="retro-gtk/retro-core.c" + line="694">Gets the filename of the core. + the filename of the core + filename="retro-gtk/retro-core.c" + line="700">the filename of the core a #RetroCore + filename="retro-gtk/retro-core.c" + line="696">a #RetroCore + c:identifier="retro_core_get_frames_per_second" + glib:get-property="frames-per-second"> Gets the FPS rate for the core's video output. - + filename="retro-gtk/retro-core.c" + line="869">Gets the FPS rate for the core's video output. + the FPS rate for the core's video output + filename="retro-gtk/retro-core.c" + line="875">the FPS rate for the core's video output a #RetroCore + filename="retro-gtk/retro-core.c" + line="871">a #RetroCore - + Gets whether a game has been loaded. - + filename="retro-gtk/retro-core.c" + line="837">Gets whether a game has been loaded. + whether a game has been loaded + filename="retro-gtk/retro-core.c" + line="843">whether a game has been loaded a #RetroCore + filename="retro-gtk/retro-core.c" + line="839">a #RetroCore + c:identifier="retro_core_get_is_initiated" + glib:get-property="is-initiated"> Gets whether the core has been initiated. - + filename="retro-gtk/retro-core.c" + line="821">Gets whether the core has been initiated. + whether the core has been initiated + filename="retro-gtk/retro-core.c" + line="827">whether the core has been initiated a #RetroCore + filename="retro-gtk/retro-core.c" + line="823">a #RetroCore Gets the size of a memory region of @self. - + filename="retro-gtk/retro-core.c" + line="1456">Gets the size of a memory region of @self. + the size of a memory region + filename="retro-gtk/retro-core.c" + line="1463">the size of a memory region a #RetroCore + filename="retro-gtk/retro-core.c" + line="1458">a #RetroCore the type of memory + filename="retro-gtk/retro-core.c" + line="1459">the type of memory Gets the option for the given key. - + filename="retro-gtk/retro-core.c" + line="1835">Gets the option for the given key. + the option + filename="retro-gtk/retro-core.c" + line="1842">the option a #RetroCore + filename="retro-gtk/retro-core.c" + line="1837">a #RetroCore the key of the option + filename="retro-gtk/retro-core.c" + line="1838">the key of the option - - + + @@ -895,135 +911,120 @@ need to boot @self before using some of its methods. + c:identifier="retro_core_get_save_directory" + glib:get-property="save-directory"> Gets the save directory of the core. + filename="retro-gtk/retro-core.c" + line="779">Gets the save directory of the core. The core will save some data here. - + the save directory of the core + filename="retro-gtk/retro-core.c" + line="787">the save directory of the core a #RetroCore + filename="retro-gtk/retro-core.c" + line="781">a #RetroCore - + Gets the speed rate at which to run the core. - + filename="retro-gtk/retro-core.c" + line="1779">Gets the speed rate at which to run the core. + the speed rate + filename="retro-gtk/retro-core.c" + line="1785">the speed rate a #RetroCore + filename="retro-gtk/retro-core.c" + line="1781">a #RetroCore + c:identifier="retro_core_get_support_no_game" + glib:get-property="support-no-game"> Gets whether the core supports running with no game. - + filename="retro-gtk/retro-core.c" + line="853">Gets whether the core supports running with no game. + whether the core supports running with no game + filename="retro-gtk/retro-core.c" + line="859">whether the core supports running with no game a #RetroCore + filename="retro-gtk/retro-core.c" + line="855">a #RetroCore + c:identifier="retro_core_get_system_directory" + glib:get-property="system-directory"> Gets the system directory of the core. + filename="retro-gtk/retro-core.c" + line="710">Gets the system directory of the core. The core will look here for additional data, such as firmware ROMs or configuration files. - + the system directory of the core + filename="retro-gtk/retro-core.c" + line="719">the system directory of the core a #RetroCore - - - - - - Gets the name of the user. - - - the name of the user - - - - - a #RetroCore + filename="retro-gtk/retro-core.c" + line="712">a #RetroCore Gets whether the core has an option for the given key. - + filename="retro-gtk/retro-core.c" + line="1816">Gets whether the core has an option for the given key. + whether the core has an option for the given key + filename="retro-gtk/retro-core.c" + line="1823">whether the core has an option for the given key a #RetroCore + filename="retro-gtk/retro-core.c" + line="1818">a #RetroCore the key of the option + filename="retro-gtk/retro-core.c" + line="1819">the key of the option @@ -1031,59 +1032,59 @@ configuration files. Creates a new #RetroControllerIterator which can be used to iterate through + filename="retro-gtk/retro-core.c" + line="1743">Creates a new #RetroControllerIterator which can be used to iterate through the controllers plugged into @self. - + a new #RetroControllerIterator + filename="retro-gtk/retro-core.c" + line="1750">a new #RetroControllerIterator a #RetroCore + filename="retro-gtk/retro-core.c" + line="1745">a #RetroCore Creates a new #RetroOptionIterator which can be used to iterate through the + filename="retro-gtk/retro-core.c" + line="1854">Creates a new #RetroOptionIterator which can be used to iterate through the options of @self. - + a new #RetroOptionIterator + filename="retro-gtk/retro-core.c" + line="1861">a new #RetroOptionIterator a #RetroCore + filename="retro-gtk/retro-core.c" + line="1856">a #RetroCore Iterate @self for a frame. - + filename="retro-gtk/retro-core.c" + line="1351">Iterate @self for a frame. + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1353">a #RetroCore @@ -1092,29 +1093,29 @@ options of @self. c:identifier="retro_core_load_memory" throws="1"> Loads a memory region of @self. - + filename="retro-gtk/retro-core.c" + line="1511">Loads a memory region of @self. + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1513">a #RetroCore the type of memory + filename="retro-gtk/retro-core.c" + line="1514">the type of memory a file to load the data from + filename="retro-gtk/retro-core.c" + line="1515">a file to load the data from @@ -1123,23 +1124,23 @@ options of @self. c:identifier="retro_core_load_state" throws="1"> Loads the state of the @self. - + filename="retro-gtk/retro-core.c" + line="1431">Loads the state of the @self. + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1433">a #RetroCore the file to load the state from + filename="retro-gtk/retro-core.c" + line="1434">the file to load the state from @@ -1147,67 +1148,67 @@ options of @self. Overrides default value for the option @key. This can be used to set value + filename="retro-gtk/retro-core.c" + line="1871">Overrides default value for the option @key. This can be used to set value for a startup-only option. You can use this before booting the core. - + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1873">a #RetroCore the key of the option + filename="retro-gtk/retro-core.c" + line="1874">the key of the option the default value + filename="retro-gtk/retro-core.c" + line="1875">the default value Resets @self. - + filename="retro-gtk/retro-core.c" + line="1331">Resets @self. + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1333">a #RetroCore Starts running the core. If the core was stopped, it will restart from this + filename="retro-gtk/retro-core.c" + line="1287">Starts running the core. If the core was stopped, it will restart from this moment. - + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1289">a #RetroCore @@ -1216,29 +1217,29 @@ moment. c:identifier="retro_core_save_memory" throws="1"> Saves a memory region of @self. - + filename="retro-gtk/retro-core.c" + line="1484">Saves a memory region of @self. + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1486">a #RetroCore the type of memory + filename="retro-gtk/retro-core.c" + line="1487">the type of memory a file to save the data to + filename="retro-gtk/retro-core.c" + line="1488">a file to save the data to @@ -1247,30 +1248,31 @@ moment. c:identifier="retro_core_save_state" throws="1"> Saves the state of @self. - + filename="retro-gtk/retro-core.c" + line="1406">Saves the state of @self. + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1408">a #RetroCore the file to save the state to + filename="retro-gtk/retro-core.c" + line="1409">the file to save the state to - + c:identifier="retro_core_set_content_directory" + glib:set-property="content-directory"> + @@ -1285,23 +1287,23 @@ moment. Plugs @controller into the specified port number of @self. - + filename="retro-gtk/retro-core.c" + line="1640">Plugs @controller into the specified port number of @self. + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1642">a #RetroCore the port number + filename="retro-gtk/retro-core.c" + line="1643">the port number nullable="1" allow-none="1"> a #RetroController + filename="retro-gtk/retro-core.c" + line="1644">a #RetroController @@ -1319,25 +1321,25 @@ moment. c:identifier="retro_core_set_current_media" throws="1"> Sets the current media index. + filename="retro-gtk/retro-core.c" + line="1256">Sets the current media index. You can use this after booting the core. - + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1258">a #RetroCore the media index + filename="retro-gtk/retro-core.c" + line="1259">the media index @@ -1345,25 +1347,25 @@ You can use this after booting the core. Uses @controller as the default controller for the given type. When a port + filename="retro-gtk/retro-core.c" + line="1594">Uses @controller as the default controller for the given type. When a port has no controller plugged plugged into it, the core will use the default controllers instead. - + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1596">a #RetroCore a #RetroControllerType + filename="retro-gtk/retro-core.c" + line="1597">a #RetroControllerType nullable="1" allow-none="1"> a #RetroController + filename="retro-gtk/retro-core.c" + line="1598">a #RetroController Sets the widget whose key events will be forwarded to @self. - + filename="retro-gtk/retro-core.c" + line="1697">Sets the widget whose key events will be forwarded to @self. + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1699">a #RetroCore nullable="1" allow-none="1"> a #GtkWidget, or %NULL + filename="retro-gtk/retro-core.c" + line="1700">a #GtkWidget, or %NULL Sets the medias to load into the core. + filename="retro-gtk/retro-core.c" + line="1233">Sets the medias to load into the core. You can use this before booting the core. - + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1235">a #RetroCore the URIs + filename="retro-gtk/retro-core.c" + line="1236">the URIs - - + + @@ -1445,163 +1449,166 @@ You can use this before booting the core. + c:identifier="retro_core_set_save_directory" + glib:set-property="save-directory"> Sets the save directory of the core. + filename="retro-gtk/retro-core.c" + line="797">Sets the save directory of the core. The core will save some data here. - + a #RetroCore + filename="retro-gtk/retro-core.c" + line="799">a #RetroCore the save directory + filename="retro-gtk/retro-core.c" + line="800">the save directory - + Sets the speed rate at which to run the core. - + filename="retro-gtk/retro-core.c" + line="1795">Sets the speed rate at which to run the core. + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1797">a #RetroCore a speed rate + filename="retro-gtk/retro-core.c" + line="1798">a speed rate + c:identifier="retro_core_set_system_directory" + glib:set-property="system-directory"> Sets the system directory of the core. + filename="retro-gtk/retro-core.c" + line="729">Sets the system directory of the core. The core will look here for additional data, such as firmware ROMs or configuration files. - + a #RetroCore + filename="retro-gtk/retro-core.c" + line="731">a #RetroCore the system directory - - - - - - Sets the name of the user. - - - - - - - a #RetroCore - - - - the user name + filename="retro-gtk/retro-core.c" + line="732">the system directory Stops running the core. - + filename="retro-gtk/retro-core.c" + line="1311">Stops running the core. + a #RetroCore + filename="retro-gtk/retro-core.c" + line="1313">a #RetroCore - + The Libretro API version implement by the core. + filename="retro-gtk/retro-core.c" + line="306">The Libretro API version implement by the core. + transfer-ownership="none" + setter="set_content_directory" + getter="get_content_directory" + default-value="NULL"> + transfer-ownership="none" + getter="get_filename" + default-value="NULL"> The filename of the core. + filename="retro-gtk/retro-core.c" + line="323">The filename of the core. - + The FPS rate for the core's video output. + filename="retro-gtk/retro-core.c" + line="430">The FPS rate for the core's video output. - + Whether a game has been loaded. + filename="retro-gtk/retro-core.c" + line="400">Whether a game has been loaded. - + Whether the core has been initiated. + filename="retro-gtk/retro-core.c" + line="385">Whether the core has been initiated. - + The number of frames to run ahead of time. This allows to know in advance + filename="retro-gtk/retro-core.c" + line="447">The number of frames to run ahead of time. This allows to know in advance what should happen in the given number of frames, allowing to react in advance. @@ -1611,89 +1618,101 @@ requires the cores to properly support serialization, otherwise the behavior is undefined. - + The save directory of the core. + filename="retro-gtk/retro-core.c" + line="368">The save directory of the core. The core will save some data here. - + The speed ratio at wich the core will run. + filename="retro-gtk/retro-core.c" + line="471">The speed ratio at wich the core will run. - + Whether the core supports running with no game. + filename="retro-gtk/retro-core.c" + line="415">Whether the core supports running with no game. - + The system directory of the core. + filename="retro-gtk/retro-core.c" + line="339">The system directory of the core. The core will look here for additional data, such as firmware ROMs or configuration files. - - The name of the user. - - The ::crash signal is emitted when the core crashes. + filename="retro-gtk/retro-core.c" + line="561">The ::crash signal is emitted when the core crashes. the message to show to the user + filename="retro-gtk/retro-core.c" + line="564">the message to show to the user The ::log signal is emitted each time the core emits a message to log. + filename="retro-gtk/retro-core.c" + line="509">The ::log signal is emitted each time the core emits a message to log. the log domain + filename="retro-gtk/retro-core.c" + line="512">the log domain the log level + filename="retro-gtk/retro-core.c" + line="513">the log level the message + filename="retro-gtk/retro-core.c" + line="514">the message The ::message signal is emitted each time the core emits a message to + filename="retro-gtk/retro-core.c" + line="543">The ::message signal is emitted each time the core emits a message to display during a given amount of frames. @@ -1701,22 +1720,22 @@ display during a given amount of frames. the message + filename="retro-gtk/retro-core.c" + line="546">the message the number of frames the message should be displayed + filename="retro-gtk/retro-core.c" + line="547">the number of frames the message should be displayed The ::shutdown signal is emitted when the core shut down. + filename="retro-gtk/retro-core.c" + line="528">The ::shutdown signal is emitted when the core shut down. The core must be released or re-started in order to function anew. @@ -1725,8 +1744,8 @@ The core must be released or re-started in order to function anew. The ::video-output signal is emitted each time a new video frame is emitted + filename="retro-gtk/retro-core.c" + line="488">The ::video-output signal is emitted each time a new video frame is emitted by the core. @pixdata will be invalid after the signal emission, copy it in some way if @@ -1737,8 +1756,8 @@ you want to keep it. the #RetroPixdata + filename="retro-gtk/retro-core.c" + line="491">the #RetroPixdata @@ -1747,7 +1766,7 @@ you want to keep it. - + @@ -1759,27 +1778,26 @@ you want to keep it. glib:type-name="RetroCoreDescriptor" glib:get-type="retro_core_descriptor_get_type" glib:type-struct="CoreDescriptorClass"> - + Creates a new #RetroCoreDescriptor. - Creates a new #RetroCoreDescriptor. + a new #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="923">a new #RetroCoreDescriptor the file name of the core descriptor + filename="retro-gtk/retro-core-descriptor.c" + line="918">the file name of the core descriptor @@ -1788,27 +1806,27 @@ you want to keep it. c:identifier="retro_core_descriptor_get_firmware_md5" throws="1"> Gets the MD5 fingerprint of the firmware file, or %NULL. - Gets the MD5 fingerprint of the firmware file, or %NULL. + a string or %NULL, free it with g_free() + filename="retro-gtk/retro-core-descriptor.c" + line="796">a string or %NULL, free it with g_free() a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="790">a #RetroCoreDescriptor a firmware name + filename="retro-gtk/retro-core-descriptor.c" + line="791">a firmware name @@ -1817,27 +1835,27 @@ you want to keep it. c:identifier="retro_core_descriptor_get_firmware_path" throws="1"> Gets the demanded path to the firmware file, or %NULL. - Gets the demanded path to the firmware file, or %NULL. + a string or %NULL, free it with g_free() + filename="retro-gtk/retro-core-descriptor.c" + line="772">a string or %NULL, free it with g_free() a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="766">a #RetroCoreDescriptor a firmware name + filename="retro-gtk/retro-core-descriptor.c" + line="767">a firmware name @@ -1846,27 +1864,27 @@ you want to keep it. c:identifier="retro_core_descriptor_get_firmware_sha512" throws="1"> Gets the SHA512 fingerprint of the firmware file, or %NULL. - Gets the SHA512 fingerprint of the firmware file, or %NULL. + a string or %NULL, free it with g_free() + filename="retro-gtk/retro-core-descriptor.c" + line="820">a string or %NULL, free it with g_free() a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="814">a #RetroCoreDescriptor a firmware name + filename="retro-gtk/retro-core-descriptor.c" + line="815">a firmware name @@ -1875,14 +1893,14 @@ you want to keep it. c:identifier="retro_core_descriptor_get_firmwares" throws="1"> Gets the list of firmwares used by the core for this platform. - Gets the list of firmwares used by the core for this platform. + a %NULL-terminated string array or %NULL, the array should + filename="retro-gtk/retro-core-descriptor.c" + line="744">a %NULL-terminated string array or %NULL, the array should be freed with g_strfreev() @@ -1891,14 +1909,14 @@ be freed with g_strfreev() a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="736">a #RetroCoreDescriptor a platform name + filename="retro-gtk/retro-core-descriptor.c" + line="737">a platform name optional="1" allow-none="1"> return location for the number of returned + filename="retro-gtk/retro-core-descriptor.c" + line="738">return location for the number of returned strings, or %NULL @@ -1919,42 +1937,42 @@ strings, or %NULL c:identifier="retro_core_descriptor_get_icon" throws="1"> Gets the icon, or %NULL if it doesn't exist. - Gets the icon, or %NULL if it doesn't exist. + a #GIcon or %NULL + filename="retro-gtk/retro-core-descriptor.c" + line="524">a #GIcon or %NULL a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="519">a #RetroCoreDescriptor Gets the ID of @self. - Gets the ID of @self. + the ID of @self, free it with g_free() + filename="retro-gtk/retro-core-descriptor.c" + line="418">the ID of @self, free it with g_free() a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="414">a #RetroCoreDescriptor @@ -1963,21 +1981,21 @@ strings, or %NULL c:identifier="retro_core_descriptor_get_is_emulator" throws="1"> Gets whether the core is an emulator, and hence need games to be loaded. - Gets whether the core is an emulator, and hence need games to be loaded. + whether the core is an emulator + filename="retro-gtk/retro-core-descriptor.c" + line="469">whether the core is an emulator a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="464">a #RetroCoreDescriptor @@ -1986,27 +2004,27 @@ strings, or %NULL c:identifier="retro_core_descriptor_get_is_firmware_mandatory" throws="1"> Gets whether the firmware is mandatory for the core to function. - Gets whether the firmware is mandatory for the core to function. + whether the firmware is mandatory for the core to function + filename="retro-gtk/retro-core-descriptor.c" + line="844">whether the firmware is mandatory for the core to function a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="838">a #RetroCoreDescriptor a firmware name + filename="retro-gtk/retro-core-descriptor.c" + line="839">a firmware name @@ -2015,21 +2033,21 @@ strings, or %NULL c:identifier="retro_core_descriptor_get_is_game" throws="1"> Gets whether the core is a game, and hence can't load games. - Gets whether the core is a game, and hence can't load games. + whether the core is a game + filename="retro-gtk/retro-core-descriptor.c" + line="435">whether the core is a game a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="430">a #RetroCoreDescriptor @@ -2038,14 +2056,14 @@ strings, or %NULL c:identifier="retro_core_descriptor_get_mime_type" throws="1"> Gets the list of MIME types accepted used by the core for this platform. - Gets the list of MIME types accepted used by the core for this platform. + a %NULL-terminated string array or %NULL, the array should + filename="retro-gtk/retro-core-descriptor.c" + line="714">a %NULL-terminated string array or %NULL, the array should be freed with g_strfreev() @@ -2054,14 +2072,14 @@ be freed with g_strfreev() a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="706">a #RetroCoreDescriptor a platform name + filename="retro-gtk/retro-core-descriptor.c" + line="707">a platform name optional="1" allow-none="1"> return location for the number of returned + filename="retro-gtk/retro-core-descriptor.c" + line="708">return location for the number of returned strings, or %NULL @@ -2082,21 +2100,21 @@ strings, or %NULL c:identifier="retro_core_descriptor_get_module" throws="1"> Gets the module file name, or %NULL if it doesn't exist. - Gets the module file name, or %NULL if it doesn't exist. + a string or %NULL, free it with g_free() + filename="retro-gtk/retro-core-descriptor.c" + line="558">a string or %NULL, free it with g_free() a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="553">a #RetroCoreDescriptor @@ -2105,21 +2123,21 @@ strings, or %NULL c:identifier="retro_core_descriptor_get_module_file" throws="1"> Gets the module file, or %NULL if it doesn't exist. - Gets the module file, or %NULL if it doesn't exist. + a #GFile or %NULL + filename="retro-gtk/retro-core-descriptor.c" + line="579">a #GFile or %NULL a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="574">a #RetroCoreDescriptor @@ -2128,21 +2146,21 @@ strings, or %NULL c:identifier="retro_core_descriptor_get_name" throws="1"> Gets the name, or %NULL if it doesn't exist. - Gets the name, or %NULL if it doesn't exist. + a string or %NULL, free it with g_free() + filename="retro-gtk/retro-core-descriptor.c" + line="503">a string or %NULL, free it with g_free() a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="498">a #RetroCoreDescriptor @@ -2151,33 +2169,33 @@ strings, or %NULL c:identifier="retro_core_descriptor_get_platform_supports_mime_types" throws="1"> Gets whether the platform supports all of the given MIME types. - Gets whether the platform supports all of the given MIME types. + whether the platform supports all of the given MIME types + filename="retro-gtk/retro-core-descriptor.c" + line="881">whether the platform supports all of the given MIME types a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="874">a #RetroCoreDescriptor a platform name + filename="retro-gtk/retro-core-descriptor.c" + line="875">a platform name the MIME types + filename="retro-gtk/retro-core-descriptor.c" + line="876">the MIME types @@ -2186,21 +2204,21 @@ strings, or %NULL Gets the URI of the file of @self. - Gets the URI of the file of @self. + the URI of the file of @self, free it with g_free() + filename="retro-gtk/retro-core-descriptor.c" + line="396">the URI of the file of @self, free it with g_free() a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="392">a #RetroCoreDescriptor @@ -2209,27 +2227,27 @@ strings, or %NULL c:identifier="retro_core_descriptor_has_firmware_md5" throws="1"> Gets whether the firmware declares its MD5 fingerprint. - Gets whether the firmware declares its MD5 fingerprint. + whether the firmware declares its MD5 fingerprint + filename="retro-gtk/retro-core-descriptor.c" + line="664">whether the firmware declares its MD5 fingerprint a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="658">a #RetroCoreDescriptor a firmware name + filename="retro-gtk/retro-core-descriptor.c" + line="659">a firmware name @@ -2238,27 +2256,27 @@ strings, or %NULL c:identifier="retro_core_descriptor_has_firmware_sha512" throws="1"> Gets whether the firmware declares its SHA512 fingerprint. - Gets whether the firmware declares its SHA512 fingerprint. + whether the firmware declares its SHA512 fingerprint + filename="retro-gtk/retro-core-descriptor.c" + line="688">whether the firmware declares its SHA512 fingerprint a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="682">a #RetroCoreDescriptor a firmware name + filename="retro-gtk/retro-core-descriptor.c" + line="683">a firmware name @@ -2267,27 +2285,27 @@ strings, or %NULL c:identifier="retro_core_descriptor_has_firmwares" throws="1"> Gets whether the platform has associated firmwares. - Gets whether the platform has associated firmwares. + whether the platform has associated firmwares + filename="retro-gtk/retro-core-descriptor.c" + line="640">whether the platform has associated firmwares a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="634">a #RetroCoreDescriptor a platform name + filename="retro-gtk/retro-core-descriptor.c" + line="635">a platform name @@ -2296,21 +2314,21 @@ strings, or %NULL c:identifier="retro_core_descriptor_has_icon" throws="1"> Gets whether the core has an icon. - Gets whether the core has an icon. + whether the core has an icon + filename="retro-gtk/retro-core-descriptor.c" + line="366">whether the core has an icon a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="361">a #RetroCoreDescriptor @@ -2318,27 +2336,27 @@ strings, or %NULL Gets whether the core descriptor declares the given platform. - Gets whether the core descriptor declares the given platform. + whether the core descriptor declares the given platform + filename="retro-gtk/retro-core-descriptor.c" + line="619">whether the core descriptor declares the given platform a #RetroCoreDescriptor + filename="retro-gtk/retro-core-descriptor.c" + line="614">a #RetroCoreDescriptor a platform name + filename="retro-gtk/retro-core-descriptor.c" + line="615">a platform name @@ -2347,8 +2365,7 @@ strings, or %NULL - + @@ -2360,70 +2377,71 @@ strings, or %NULL glib:type-name="RetroCoreView" glib:get-type="retro_core_view_get_type" glib:type-struct="CoreViewClass"> - + Creates a new #RetroCoreView. - + filename="retro-gtk/retro-core-view.c" + line="859">Creates a new #RetroCoreView. + a new #RetroCoreView + filename="retro-gtk/retro-core-view.c" + line="864">a new #RetroCoreView Creates a new #RetroController exposing @self as the specified controller + filename="retro-gtk/retro-core-view.c" + line="622">Creates a new #RetroController exposing @self as the specified controller type. The valid controller types are RETRO_CONTROLLER_TYPE_JOYPAD, RETRO_CONTROLLER_TYPE_MOUSE, RETRO_CONTROLLER_TYPE_KEYBOARD and RETRO_CONTROLLER_TYPE_POINTER. - + a new #RetroController + filename="retro-gtk/retro-core-view.c" + line="632">a new #RetroController a #RetroCoreView + filename="retro-gtk/retro-core-view.c" + line="624">a #RetroCoreView the controller type to expose @self as + filename="retro-gtk/retro-core-view.c" + line="625">the controller type to expose @self as + c:identifier="retro_core_view_get_can_grab_pointer" + glib:get-property="can-grab-pointer"> Gets whether the pointer should be grabbed when clicking on the view. This + filename="retro-gtk/retro-core-view.c" + line="772">Gets whether the pointer should be grabbed when clicking on the view. This allows @self to work as a RETRO_CONTROLLER_TYPE_MOUSE instead of a RETRO_CONTROLLER_TYPE_POINTER. - + whether the pointer should snap to the borders + filename="retro-gtk/retro-core-view.c" + line="780">whether the pointer should snap to the borders a #RetroCoreView + filename="retro-gtk/retro-core-view.c" + line="774">a #RetroCoreView @@ -2431,25 +2449,25 @@ RETRO_CONTROLLER_TYPE_POINTER. Gets a flag representing the capabilities of @self when exposed as a + filename="retro-gtk/retro-core-view.c" + line="748">Gets a flag representing the capabilities of @self when exposed as a controller. See retro_controller_get_capabilities() for more information on the flag. See retro_core_view_as_controller() to know the capabilities of #RetroCoreView when exposed as a controller. - + the capabilities flag of @self when exposed as a controller + filename="retro-gtk/retro-core-view.c" + line="759">the capabilities flag of @self when exposed as a controller a #RetroCoreView + filename="retro-gtk/retro-core-view.c" + line="750">a #RetroCoreView @@ -2457,26 +2475,26 @@ See retro_core_view_as_controller() to know the capabilities of Gets the state of an input of @self. - + filename="retro-gtk/retro-core-view.c" + line="674">Gets the state of an input of @self. + the input's state + filename="retro-gtk/retro-core-view.c" + line="681">the input's state a #RetroCoreView + filename="retro-gtk/retro-core-view.c" + line="676">a #RetroCoreView a #RetroInput to query @self + filename="retro-gtk/retro-core-view.c" + line="677">a #RetroInput to query @self @@ -2484,63 +2502,64 @@ See retro_core_view_as_controller() to know the capabilities of Gets the currently set key joypad mapping. - + filename="retro-gtk/retro-core-view.c" + line="606">Gets the currently set key joypad mapping. + a #RetroKeyJoypadMapping + filename="retro-gtk/retro-core-view.c" + line="612">a #RetroKeyJoypadMapping a #RetroCoreView + filename="retro-gtk/retro-core-view.c" + line="608">a #RetroCoreView Gets the currently displayed video frame. - + a #GdkPixbuf a #RetroCoreView + c:identifier="retro_core_view_get_snap_pointer_to_borders" + glib:get-property="snap-pointer-to-borders"> Gets whether the pointer should be considered to be at the border of the + filename="retro-gtk/retro-core-view.c" + line="818">Gets whether the pointer should be considered to be at the border of the video display when it is outside of it. This is used when @self is exposed as a RETRO_CONTROLLER_TYPE_POINTER. - + whether the pointer should snap to the borders + filename="retro-gtk/retro-core-view.c" + line="826">whether the pointer should snap to the borders a #RetroCoreView + filename="retro-gtk/retro-core-view.c" + line="820">a #RetroCoreView @@ -2548,17 +2567,17 @@ a RETRO_CONTROLLER_TYPE_POINTER. Sets the @self as the default controllers of @core. - + filename="retro-gtk/retro-core-view.c" + line="643">Sets the @self as the default controllers of @core. + a #RetroCoreView + filename="retro-gtk/retro-core-view.c" + line="645">a #RetroCoreView nullable="1" allow-none="1"> a #RetroCore + filename="retro-gtk/retro-core-view.c" + line="646">a #RetroCore + c:identifier="retro_core_view_set_can_grab_pointer" + glib:set-property="can-grab-pointer"> Sets whether the pointer should be grabbed when clicking on the view. This + filename="retro-gtk/retro-core-view.c" + line="790">Sets whether the pointer should be grabbed when clicking on the view. This allows @self to work as a RETRO_CONTROLLER_TYPE_MOUSE instead of a RETRO_CONTROLLER_TYPE_POINTER. - + a #RetroCoreView + filename="retro-gtk/retro-core-view.c" + line="792">a #RetroCoreView whether the pointer should be grabbed when clicking on + filename="retro-gtk/retro-core-view.c" + line="793">whether the pointer should be grabbed when clicking on the view @@ -2601,16 +2621,16 @@ the view Sets @core as the #RetroCore handled by @self. - + a #RetroCoreView @@ -2619,7 +2639,7 @@ the view nullable="1" allow-none="1"> a #RetroCore, or %NULL @@ -2627,22 +2647,22 @@ the view Sets the video filter to use to render the core's video on @self. - + a #RetroCoreView a #RetroVideoFilter @@ -2651,17 +2671,17 @@ the view Sets the key joypad mapping on @self. If given mapping is %NULL, then set to an empty configuration. - + a #RetroCoreView @@ -2670,7 +2690,7 @@ an empty configuration. nullable="1" allow-none="1"> a #RetroKeyJoypadMapping @@ -2678,69 +2698,78 @@ an empty configuration. Sets @pixbuf as the currently displayed video frame. retro_pixbuf_set_aspect_ratio() can be used to specify the aspect ratio for the pixbuf. Otherwise the core's aspect ratio will be used. - + a #RetroCoreView a #GdkPixbuf + c:identifier="retro_core_view_set_snap_pointer_to_borders" + glib:set-property="snap-pointer-to-borders"> Sets whether the pointer should be considered to be at the border of the + filename="retro-gtk/retro-core-view.c" + line="836">Sets whether the pointer should be considered to be at the border of the video display when it is outside of it. This is used when @self is exposed as a RETRO_CONTROLLER_TYPE_POINTER. - + a #RetroCoreView + filename="retro-gtk/retro-core-view.c" + line="838">a #RetroCoreView whether the pointer should snap to the borders + filename="retro-gtk/retro-core-view.c" + line="839">whether the pointer should snap to the borders - + + transfer-ownership="none" + setter="set_snap_pointer_to_borders" + getter="get_snap_pointer_to_borders" + default-value="FALSE"> The ::controller-state-changed signal is emitted when a key is pressed or released, mouse pointer is moved, or a mouse button is pressed or released. @@ -2754,7 +2783,7 @@ Applications should not connect to it. - + @@ -2764,15 +2793,15 @@ Applications should not connect to it. glib:type-name="RetroInput" glib:get-type="retro_input_get_type" c:symbol-prefix="input"> - + Creates a new #RetroInput. - + a new #RetroInput, use retro_input_free() to free it @@ -2780,12 +2809,12 @@ it Copies @self into a new #RetroInput. - + a new #RetroInput, use retro_input_free() to free it @@ -2793,7 +2822,7 @@ it a #RetroInput @@ -2801,16 +2830,16 @@ it Frees the given #RetroInput. - + a #RetroInput @@ -2818,19 +2847,19 @@ it Gets the analog id and index of @self, if any. - + whether the id and the index were retrieved a #RetroInput @@ -2839,7 +2868,7 @@ it caller-allocates="0" transfer-ownership="full"> return location for the id @@ -2848,7 +2877,7 @@ it caller-allocates="0" transfer-ownership="full"> return location for the index @@ -2857,19 +2886,19 @@ it Gets the controller type of @self. - + the controller type of @self a #RetroInput @@ -2877,19 +2906,19 @@ it Gets the joypad id of @self, if any. - + whether the id was retrieved a #RetroInput @@ -2898,7 +2927,7 @@ it caller-allocates="0" transfer-ownership="full"> return location for the id @@ -2906,19 +2935,19 @@ it Gets the lightgun id of @self, if any. - + whether the id was retrieved a #RetroInput @@ -2927,7 +2956,7 @@ it caller-allocates="0" transfer-ownership="full"> return location for the id @@ -2935,19 +2964,19 @@ it Gets the mouse id of @self, if any. - + whether the id was retrieved a #RetroInput @@ -2956,7 +2985,7 @@ it caller-allocates="0" transfer-ownership="full"> return location for the id @@ -2964,19 +2993,19 @@ it Gets the pointer id of @self, if any. - + whether the id was retrieved a #RetroInput @@ -2985,7 +3014,7 @@ it caller-allocates="0" transfer-ownership="full"> return location for the id @@ -2997,7 +3026,7 @@ it glib:get-type="retro_joypad_id_get_type" c:type="RetroJoypadId"> Represents the buttons for the Libretro gamepad. The available buttons are the same as the W3C Standard Gamepad, the SDL GameController and many other modern standard gamepads, but the name of the buttons may differ. See the @@ -3007,145 +3036,160 @@ GamepadController definition</ulink> for more information. + glib:nick="b" + glib:name="RETRO_JOYPAD_ID_B"> the bottom action button + glib:nick="y" + glib:name="RETRO_JOYPAD_ID_Y"> the left action button + glib:nick="select" + glib:name="RETRO_JOYPAD_ID_SELECT"> the Select button + glib:nick="start" + glib:name="RETRO_JOYPAD_ID_START"> the Start button + glib:nick="up" + glib:name="RETRO_JOYPAD_ID_UP"> the up directional button + glib:nick="down" + glib:name="RETRO_JOYPAD_ID_DOWN"> the down directional button + glib:nick="left" + glib:name="RETRO_JOYPAD_ID_LEFT"> the left directional button + glib:nick="right" + glib:name="RETRO_JOYPAD_ID_RIGHT"> the right directional button + glib:nick="a" + glib:name="RETRO_JOYPAD_ID_A"> the right action button + glib:nick="x" + glib:name="RETRO_JOYPAD_ID_X"> the top action button + glib:nick="l" + glib:name="RETRO_JOYPAD_ID_L"> the first left shoulder button + glib:nick="r" + glib:name="RETRO_JOYPAD_ID_R"> the first right shoulder button + glib:nick="l2" + glib:name="RETRO_JOYPAD_ID_L2"> the second left shoulder button + glib:nick="r2" + glib:name="RETRO_JOYPAD_ID_R2"> the second right shoulder button + glib:nick="l3" + glib:name="RETRO_JOYPAD_ID_L3"> the left thumb button + glib:nick="r3" + glib:name="RETRO_JOYPAD_ID_R3"> the right thumb button - + the corresponding joypad id a button code @@ -3153,18 +3197,17 @@ GamepadController definition</ulink> for more information. - + the corresponding button code a #RetroJoypadId @@ -3178,17 +3221,17 @@ GamepadController definition</ulink> for more information. glib:type-name="RetroKeyJoypadMapping" glib:get-type="retro_key_joypad_mapping_get_type" glib:type-struct="KeyJoypadMappingClass"> - Creates a new #RetroKeyJoypadMapping. - a new #RetroKeyJoypadMapping @@ -3196,13 +3239,13 @@ GamepadController definition</ulink> for more information. Creates a new #RetroKeyJoypadMapping with the default mapping. - a new #RetroKeyJoypadMapping @@ -3210,26 +3253,26 @@ GamepadController definition</ulink> for more information. Gets the mapping key code for the joypad button id. - mapping key code a #RetroKeyJoypadMapping joypad button id @@ -3238,9 +3281,9 @@ GamepadController definition</ulink> for more information. Maps the joypad button id to mapping key code. - @@ -3248,19 +3291,19 @@ GamepadController definition</ulink> for more information. a #RetroKeyJoypadMapping joypad button id mapping key code @@ -3270,7 +3313,7 @@ GamepadController definition</ulink> for more information. - @@ -3281,94 +3324,101 @@ GamepadController definition</ulink> for more information. glib:get-type="retro_lightgun_id_get_type" c:type="RetroLightgunId"> Represents the inputs for the Libretro lightgun. + glib:nick="x" + glib:name="RETRO_LIGHTGUN_ID_X"> the X axis of a lightgun + glib:nick="y" + glib:name="RETRO_LIGHTGUN_ID_Y"> the Y axis of a lightgun + glib:nick="trigger" + glib:name="RETRO_LIGHTGUN_ID_TRIGGER"> the trigger of a lightgun + glib:nick="cursor" + glib:name="RETRO_LIGHTGUN_ID_CURSOR"> the cursor of a lightgun + glib:nick="turbo" + glib:name="RETRO_LIGHTGUN_ID_TURBO"> the turbo button of a lightgun + glib:nick="pause" + glib:name="RETRO_LIGHTGUN_ID_PAUSE"> the pause button of a lightgun + glib:nick="start" + glib:name="RETRO_LIGHTGUN_ID_START"> the start button of a lightgun Represents the memory types for the Libretro core. - + the save RAM the real time clock the system RAM the video RAM @@ -3379,25 +3429,24 @@ GamepadController definition</ulink> for more information. glib:type-name="RetroModuleIterator" glib:get-type="retro_module_iterator_get_type" glib:type-struct="ModuleIteratorClass"> - + Creates a new #RetroModuleIterator. - Creates a new #RetroModuleIterator. + a new #RetroModuleIterator + filename="retro-gtk/retro-module-iterator.c" + line="298">a new #RetroModuleIterator paths where to look for Libretro + filename="retro-gtk/retro-module-iterator.c" + line="292">paths where to look for Libretro cores @@ -3405,51 +3454,51 @@ cores whether to run the query in sub-directories + filename="retro-gtk/retro-module-iterator.c" + line="294">whether to run the query in sub-directories Gets the last #RetroCoreDescriptor fetched by retro_module_iterator_next(), + filename="retro-gtk/retro-module-iterator.c" + line="230">Gets the last #RetroCoreDescriptor fetched by retro_module_iterator_next(), or %NULL if the end was reached. - a #RetroCoreDescriptor, or %NULL + filename="retro-gtk/retro-module-iterator.c" + line="237">a #RetroCoreDescriptor, or %NULL a #RetroModuleIterator + filename="retro-gtk/retro-module-iterator.c" + line="232">a #RetroModuleIterator Fetch the next #RetroModuleIterator. - Fetch the next #RetroModuleIterator. + %FALSE if it reached the end, %TRUE otherwise + filename="retro-gtk/retro-module-iterator.c" + line="255">%FALSE if it reached the end, %TRUE otherwise a #RetroModuleIterator + filename="retro-gtk/retro-module-iterator.c" + line="251">a #RetroModuleIterator @@ -3458,8 +3507,7 @@ or %NULL if the end was reached. - + @@ -3471,45 +3519,43 @@ or %NULL if the end was reached. glib:type-name="RetroModuleQuery" glib:get-type="retro_module_query_get_type" glib:type-struct="ModuleQueryClass"> - + Creates a new #RetroModuleQuery. - + filename="retro-gtk/retro-module-query.c" + line="95">Creates a new #RetroModuleQuery. + a new #RetroModuleQuery + filename="retro-gtk/retro-module-query.c" + line="101">a new #RetroModuleQuery whether to run the query in sub-directories + filename="retro-gtk/retro-module-query.c" + line="97">whether to run the query in sub-directories Creates a new #RetroModuleIterator. - + filename="retro-gtk/retro-module-query.c" + line="71">Creates a new #RetroModuleIterator. + a new #RetroModuleIterator + filename="retro-gtk/retro-module-query.c" + line="77">a new #RetroModuleIterator a #RetroModuleQuery + filename="retro-gtk/retro-module-query.c" + line="73">a #RetroModuleQuery @@ -3518,7 +3564,7 @@ or %NULL if the end was reached. - + @@ -3528,88 +3574,105 @@ or %NULL if the end was reached. glib:get-type="retro_mouse_id_get_type" c:type="RetroMouseId"> Represents the inputs for the Libretro mouse. - + the X axis of a mouse - + the Y axis of a mouse + glib:nick="left" + glib:name="RETRO_MOUSE_ID_LEFT"> the left button of a mouse + glib:nick="right" + glib:name="RETRO_MOUSE_ID_RIGHT"> the right button of a mouse + glib:nick="wheelup" + glib:name="RETRO_MOUSE_ID_WHEELUP"> the up direction of a mouse wheel + glib:nick="wheeldown" + glib:name="RETRO_MOUSE_ID_WHEELDOWN"> the down direction of a mouse wheel + glib:nick="middle" + glib:name="RETRO_MOUSE_ID_MIDDLE"> the middle button of a mouse + glib:nick="horiz-wheelup" + glib:name="RETRO_MOUSE_ID_HORIZ_WHEELUP"> the horizontal up direction of a mouse wheel + glib:nick="horiz-wheeldown" + glib:name="RETRO_MOUSE_ID_HORIZ_WHEELDOWN"> the horizontal down direction of a mouse wheel + glib:nick="button-4" + glib:name="RETRO_MOUSE_ID_BUTTON_4"> the fourth button of a mouse + glib:nick="button-5" + glib:name="RETRO_MOUSE_ID_BUTTON_5"> the fifth button of a mouse @@ -3620,23 +3683,23 @@ or %NULL if the end was reached. glib:type-name="RetroOption" glib:get-type="retro_option_get_type" glib:type-struct="OptionClass"> - + Gets the description of @self. - + the description of @self a #RetroOption @@ -3644,19 +3707,19 @@ or %NULL if the end was reached. Gets the key of @self. - + the key of @self a #RetroOption @@ -3664,19 +3727,19 @@ or %NULL if the end was reached. Gets the value of @self. - + the value of @self a #RetroOption @@ -3684,12 +3747,12 @@ or %NULL if the end was reached. Gets the value of @self. - + the value of @self @@ -3699,7 +3762,7 @@ value of @self a #RetroOption @@ -3709,23 +3772,23 @@ value of @self c:identifier="retro_option_set_value" throws="1"> Sets the value for @self. An error will be thrown if the value is invalid for @self. - + a #RetroOption the value @@ -3740,7 +3803,7 @@ value of @self - + @@ -3752,24 +3815,23 @@ value of @self glib:type-name="RetroOptionIterator" glib:get-type="retro_option_iterator_get_type" glib:type-struct="OptionIteratorClass"> - + Fetch the next #RetroOption and its key. - %FALSE if it reached the end, %TRUE otherwise a #RetroOptionIterator @@ -3780,7 +3842,7 @@ value of @self optional="1" allow-none="1"> return location for the key @@ -3792,7 +3854,7 @@ value of @self optional="1" allow-none="1"> return location for the option @@ -3802,52 +3864,52 @@ value of @self - + - + Copies @self into a new #RetroPixdata. - + filename="retro-gtk/retro-pixdata.c" + line="230">Copies @self into a new #RetroPixdata. + a new #RetroPixdata, use retro_pixdata_free() to + filename="retro-gtk/retro-pixdata.c" + line="236">a new #RetroPixdata, use retro_pixdata_free() to free it a #RetroPixdata + filename="retro-gtk/retro-pixdata.c" + line="232">a #RetroPixdata Frees the given #RetroPixdata object. - + filename="retro-gtk/retro-pixdata.c" + line="249">Frees the given #RetroPixdata object. + a #RetroPixdata + filename="retro-gtk/retro-pixdata.c" + line="251">a #RetroPixdata @@ -3855,60 +3917,60 @@ free it Gets the aspect ratio the video should be rendered with. - + filename="retro-gtk/retro-pixdata.c" + line="297">Gets the aspect ratio the video should be rendered with. + the aspect ratio + filename="retro-gtk/retro-pixdata.c" + line="303">the aspect ratio a #RetroCore + filename="retro-gtk/retro-pixdata.c" + line="299">a #RetroCore Gets the height of @self. - + filename="retro-gtk/retro-pixdata.c" + line="281">Gets the height of @self. + the height + filename="retro-gtk/retro-pixdata.c" + line="287">the height a #RetroCore + filename="retro-gtk/retro-pixdata.c" + line="283">a #RetroCore Gets the width of @self. - + filename="retro-gtk/retro-pixdata.c" + line="265">Gets the width of @self. + the width + filename="retro-gtk/retro-pixdata.c" + line="271">the width a #RetroCore + filename="retro-gtk/retro-pixdata.c" + line="267">a #RetroCore @@ -3916,43 +3978,43 @@ free it Loads an OpenGL texture from @self. - + filename="retro-gtk/retro-pixdata.c" + line="369">Loads an OpenGL texture from @self. + whether the loading was successful + filename="retro-gtk/retro-pixdata.c" + line="375">whether the loading was successful the #RetroPixdata + filename="retro-gtk/retro-pixdata.c" + line="371">the #RetroPixdata Creates a new #GdkPixbuf from @self. + filename="retro-gtk/retro-pixdata.c" + line="313">Creates a new #GdkPixbuf from @self. The #GdkPixbuf stores the intended aspect-ratio, you can access it via retro_pixbuf_get_aspect_ratio(). - + a new #RetroPixdata + filename="retro-gtk/retro-pixdata.c" + line="322">a new #RetroPixdata the #RetroPixdata + filename="retro-gtk/retro-pixdata.c" + line="315">the #RetroPixdata @@ -3963,30 +4025,33 @@ retro_pixbuf_get_aspect_ratio(). glib:get-type="retro_pointer_id_get_type" c:type="RetroPointerId"> Represents the inputs for the Libretro pointer. + glib:nick="x" + glib:name="RETRO_POINTER_ID_X"> the X axis of a pointer + glib:nick="y" + glib:name="RETRO_POINTER_ID_Y"> the Y axis of a pointer + glib:nick="pressed" + glib:name="RETRO_POINTER_ID_PRESSED"> the pression of a pointer @@ -3995,22 +4060,24 @@ retro_pixbuf_get_aspect_ratio(). glib:get-type="retro_rumble_effect_get_type" c:type="RetroRumbleEffect"> Represents the strength of the rumble effect. + glib:nick="strong" + glib:name="RETRO_RUMBLE_EFFECT_STRONG"> the strong rumble effect + glib:nick="weak" + glib:name="RETRO_RUMBLE_EFFECT_WEAK"> the weak rumble effect @@ -4019,50 +4086,52 @@ retro_pixbuf_get_aspect_ratio(). glib:get-type="retro_video_filter_get_type" c:type="RetroVideoFilter"> Represents the filters that can be applied to the video output. + glib:nick="smooth" + glib:name="RETRO_VIDEO_FILTER_SMOOTH"> a smooth but blurry video filer + glib:nick="sharp" + glib:name="RETRO_VIDEO_FILTER_SHARP"> a sharp video filter showing every pixel + glib:nick="crt" + glib:name="RETRO_VIDEO_FILTER_CRT"> a video filter mimicking CRT screens Gets a #RetroVideoFilter from it's name. It defaults to RETRO_VIDEO_FILTER_SMOOTH in case of error. - + a #RetroVideoFilter a filter name @@ -4072,7 +4141,7 @@ RETRO_VIDEO_FILTER_SMOOTH in case of error. - + @@ -4085,7 +4154,7 @@ RETRO_VIDEO_FILTER_SMOOTH in case of error. - + @@ -4097,19 +4166,19 @@ RETRO_VIDEO_FILTER_SMOOTH in case of error. Logs an error or debugging message. This is a convenience function to forward the #RetroCore::log signal of #RetroCore to g_log(), see it for more information. - + a #RetroCore @@ -4118,27 +4187,27 @@ This is a convenience function to forward the #RetroCore::log signal of nullable="1" allow-none="1"> the log domain, usually #G_LOG_DOMAIN, or %NULL the log level, either from #GLogLevelFlags or a user-defined level the message to log - + @@ -4146,18 +4215,17 @@ level - + the corresponding joypad id a button code @@ -4166,18 +4234,17 @@ level - + the corresponding button code a #RetroJoypadId @@ -4186,19 +4253,19 @@ level Gets the aspect ratio of @pixbuf by reading the 'aspect-ratio' pixbuf option. - + the aspect ratio, or 0 if the option is not set or its value is invalid. a #GdkPixbuf @@ -4207,23 +4274,23 @@ level Sets the aspect ratio of @pixbuf by setting the 'aspect-ratio' pixbuf option. Use retro_pixbuf_get_aspect_ratio() to retrieve it. - + a #GdkPixbuf the aspect ratio value @@ -4231,7 +4298,7 @@ Use retro_pixbuf_get_aspect_ratio() to retrieve it. The #RetroInput structure represents an input from a controller, like a button, an axis, or a key. @@ -4243,17 +4310,17 @@ which joypad input type is represented via retro_input_get_joypad(). Convenience functions to connect to the #RetroCore::log signal of #RetroCore. Convenience functions to handle the options of a #GdkPixbuf. The #RetroPixdata structure holds the internal representation of a #RetroCore's video output. To use the image, either convert it to a #GdkPixbuf via retro_pixdata_to_pixbuf() or load it as an OpenGL texture via @@ -4266,20 +4333,20 @@ it via retro_pixbuf_get_aspect_ratio(). c:identifier="retro_video_filter_from_string" moved-to="VideoFilter.from_string"> Gets a #RetroVideoFilter from it's name. It defaults to RETRO_VIDEO_FILTER_SMOOTH in case of error. - + a #RetroVideoFilter a filter name diff --git a/girs/RpmOstree-1.0.gir b/girs/RpmOstree-1.0.gir index 48eea6e4d..e433c9425 100644 --- a/girs/RpmOstree-1.0.gir +++ b/girs/RpmOstree-1.0.gir @@ -180,7 +180,7 @@ individual getters for more precise control. - + diff --git a/girs/RygelRenderer-2.8.gir b/girs/RygelRenderer-2.8.gir index aa434269a..8bd923dc3 100644 --- a/girs/RygelRenderer-2.8.gir +++ b/girs/RygelRenderer-2.8.gir @@ -1,5 +1,5 @@ - + diff --git a/girs/RygelRendererGst-2.8.gir b/girs/RygelRendererGst-2.8.gir index 6a68ebc3b..766b6a23c 100644 --- a/girs/RygelRendererGst-2.8.gir +++ b/girs/RygelRendererGst-2.8.gir @@ -1,5 +1,5 @@ - + diff --git a/girs/RygelServer-2.8.gir b/girs/RygelServer-2.8.gir index 6a8122f9f..ac49121d0 100644 --- a/girs/RygelServer-2.8.gir +++ b/girs/RygelServer-2.8.gir @@ -1,5 +1,5 @@ - + diff --git a/girs/Secret-1.gir b/girs/Secret-1.gir index 317d96b95..c0c649fea 100644 --- a/girs/Secret-1.gir +++ b/girs/Secret-1.gir @@ -38,7 +38,10 @@ and/or use gtk-doc annotations. --> storage. - + Get a #SecretBackend instance. @@ -115,7 +118,10 @@ This method will return immediately and complete asynchronously. - + + implementation of [func@password_clear], required @@ -157,6 +163,9 @@ This method will return immediately and complete asynchronously. + implementation of [func@password_clear_finish], required @@ -170,7 +179,11 @@ This method will return immediately and complete asynchronously. - + + implementation of reinitialization step in constructor, optional @@ -206,6 +219,9 @@ This method will return immediately and complete asynchronously. + implementation of reinitialization step in constructor, optional @@ -219,7 +235,10 @@ This method will return immediately and complete asynchronously. - + + implementation of [func@password_lookup], required @@ -261,6 +280,9 @@ This method will return immediately and complete asynchronously. + implementation of [func@password_lookup_finish], required @@ -274,7 +296,10 @@ This method will return immediately and complete asynchronously. - + + implementation of [func@password_search], required @@ -319,6 +344,9 @@ This method will return immediately and complete asynchronously. + implementation of [func@password_search_finish], required @@ -334,7 +362,10 @@ This method will return immediately and complete asynchronously. - + + implementation of [func@password_store], required @@ -385,6 +416,9 @@ This method will return immediately and complete asynchronously. + implementation of [func@password_store_finish], required @@ -464,6 +498,9 @@ been initialized. + implementation of reinitialization step in constructor, optional @@ -502,6 +539,9 @@ been initialized. + implementation of reinitialization step in constructor, optional @@ -518,6 +558,9 @@ been initialized. + implementation of [func@password_store], required @@ -571,6 +614,9 @@ been initialized. + implementation of [func@password_store_finish], required @@ -587,6 +633,9 @@ been initialized. + implementation of [func@password_lookup], required @@ -631,6 +680,9 @@ been initialized. + implementation of [func@password_lookup_finish], required @@ -647,6 +699,9 @@ been initialized. + implementation of [func@password_clear], required @@ -691,6 +746,9 @@ been initialized. + implementation of [func@password_clear_finish], required @@ -707,6 +765,9 @@ been initialized. + implementation of [func@password_search], required @@ -754,6 +815,9 @@ been initialized. + implementation of [func@password_search_finish], required @@ -824,7 +888,7 @@ given version. line="70">An alias to the default collection. This can be passed to [func@password_store] [func@Collection.for_alias]. - + - + - + Create a new collection in the secret service. @@ -1064,7 +1131,8 @@ default [class@Service] proxy. + throws="1" + glib:async-func="create"> Create a new collection in the secret service. @@ -1132,7 +1200,10 @@ default [class@Service] proxy. - + Lookup which collection is assigned to this alias. Aliases help determine @@ -1224,7 +1295,8 @@ to an alias. + throws="1" + glib:async-func="for_alias"> Lookup which collection is assigned to this alias. Aliases help determine @@ -1343,7 +1415,10 @@ This method will return immediately and complete asynchronously. - + Delete this collection. @@ -1423,7 +1498,8 @@ any prompts that show up. + throws="1" + glib:async-func="delete"> Delete this collection. @@ -1633,7 +1709,10 @@ The return value is the number of seconds since the unix epoch, January 1st - + Ensure that the #SecretCollection proxy has loaded all the items present @@ -1718,7 +1797,8 @@ has loaded all the items present in the Secret Service. + throws="1" + glib:async-func="load_items"> Ensure that the #SecretCollection proxy has loaded all the items present @@ -1776,7 +1856,10 @@ will notify the client when properties change. - + Search for items matching the @attributes in the @collection. @@ -1894,7 +1977,9 @@ This function returns immediately and completes asynchronously. + stability="Unstable" + glib:finish-func="search_for_dbus_paths_finish" + glib:sync-func="search_for_dbus_paths_sync"> Search for items in @collection matching the @attributes, and return their @@ -2010,7 +2095,8 @@ DBus object paths of the items will be returned. If you would to have c:identifier="secret_collection_search_for_dbus_paths_sync" introspectable="0" stability="Unstable" - throws="1"> + throws="1" + glib:async-func="search_for_dbus_paths"> Search for items matching the @attributes in @collection, and return their @@ -2072,7 +2158,8 @@ DBus object paths of the items will be returned. If you would to have + throws="1" + glib:async-func="search"> Search for items matching the @attributes in the @collection. @@ -2145,7 +2232,9 @@ in user interface threads. + glib:set-property="label" + glib:finish-func="set_label_finish" + glib:sync-func="set_label_sync"> + throws="1" + glib:async-func="set_label"> Set the label of this collection. @@ -2497,15 +2587,55 @@ application to handle them appropriately. filename="libsecret/secret-util.c" line="31">the file format is not valid + + the xdg:schema attribute of the table does +not match the schema name + + + attribute contained in table not found +in corresponding schema + + + attribute could not be parsed according to its type +reported in the table's schema + + + attribute list passed to secret_attributes_validate +has no elements to validate + Get the error quark. + line="83">Get the error quark. the quark + line="88">the quark @@ -2723,7 +2853,10 @@ threads. - + Create a new item in the secret service. @@ -2838,7 +2971,8 @@ will be used to handle any prompts that are required. + throws="1" + glib:async-func="create"> Create a new item in the secret service. @@ -2912,7 +3046,10 @@ will be used to handle any prompts that are required. - + Load the secret values for a secret item stored in the service. @@ -2991,7 +3128,8 @@ Items that are locked will not have their secrets loaded. + throws="1" + glib:async-func="load_secrets"> Load the secret values for a secret item stored in the service. @@ -3098,7 +3236,10 @@ This method will return immediately and complete asynchronously. - + Delete this item. @@ -3178,7 +3319,8 @@ any prompts that show up. + throws="1" + glib:async-func="delete"> Delete this secret item. @@ -3432,7 +3574,10 @@ To load the secret call the [method@Item.load_secret] method. - + Load the secret value of this item. @@ -3518,7 +3663,8 @@ The newly loaded secret value can be accessed by calling + throws="1" + glib:async-func="load_secret"> Load the secret value of this item. @@ -3576,7 +3722,10 @@ will notify the client when properties change. - + Set the attributes of this item. @@ -3676,7 +3825,8 @@ This function returns immediately and completes asynchronously. + throws="1" + glib:async-func="set_attributes"> Set the attributes of this item. @@ -3730,7 +3880,10 @@ in user interface threads. - + Set the label of this item. @@ -3814,7 +3967,8 @@ This function returns immediately and completes asynchronously. + throws="1" + glib:async-func="set_label"> Set the label of this item. @@ -3852,7 +4006,10 @@ in user interface threads. - + Set the secret value of this item. @@ -3939,7 +4096,8 @@ This function returns immediately and completes asynchronously. + throws="1" + glib:async-func="set_secret"> Set the secret value of this item. @@ -4113,7 +4271,7 @@ uses to interact with the actual D-Bus Secret Service. - + The micro version of libsecret. @@ -4182,7 +4340,10 @@ methods of the [class@Service] class. - + Runs a prompt and performs the prompting. @@ -4288,7 +4449,8 @@ defined in the Secret Service DBus API specification. + throws="1" + glib:async-func="perform"> Runs a prompt and performs the prompting. @@ -4457,7 +4619,8 @@ retrieved by [method@Retrievable.retrieve_secret] and + version="0.19.0" + glib:finish-func="retrieve_secret_finish"> Retrieve the secret value of this object. @@ -4653,7 +4816,9 @@ The return value is the number of seconds since the unix epoch, January 1st + version="0.19.0" + glib:finish-func="retrieve_secret_finish" + glib:sync-func="retrieve_secret_sync"> Retrieve the secret value of this object. @@ -4737,7 +4902,8 @@ This function returns immediately and completes asynchronously. + throws="1" + glib:async-func="retrieve_secret"> Retrieve the secret value of this object synchronously. @@ -4848,6 +5014,10 @@ item was last modified. + implementation of [method@Retrievable.retrieve_secret], + required @@ -4896,6 +5066,10 @@ item was last modified. + implementation of + [method@Retrievable.retrieve_secret_finish], required @@ -4984,7 +5158,7 @@ the schema's attributes are matched. This is useful when you are looking up items that are not stored by the libsecret library. Other libraries such as libgnome-keyring don't store the schema name. -Additional schemas can be defined via the %SecretSchema structure like this: +Additional schemas can be defined via the [struct@Schema] structure like this: ```c // in a header: @@ -5502,7 +5676,10 @@ being freed. - + Get a #SecretService proxy for the Secret Service. @@ -5581,7 +5758,8 @@ Secret Service. + throws="1" + glib:async-func="get"> Get a #SecretService proxy for the Secret Service. @@ -5619,7 +5797,10 @@ threads. - + Create a new #SecretService proxy for the Secret Service. @@ -5718,7 +5899,8 @@ the Secret Service. + throws="1" + glib:async-func="open"> Create a new #SecretService proxy for the Secret Service. @@ -5821,7 +6003,10 @@ This will always be either [class@Item] or derived from it. - + + called to perform asynchronous prompting when necessary @@ -5944,7 +6129,10 @@ run [method@Prompt.perform_sync] on the prompt with a %NULL `window_id`. - + Remove unlocked items which match the attributes from the secret service. @@ -6052,7 +6240,8 @@ service. + throws="1" + glib:async-func="clear"> Remove unlocked items which match the attributes from the secret service. @@ -6113,10 +6302,12 @@ threads. + stability="Unstable" + glib:finish-func="create_collection_dbus_path_finish" + glib:sync-func="create_collection_dbus_path_sync"> Create a new collection in the secret service, and return its path. + line="1701">Create a new collection in the secret service, and return its path. Using this method requires that you setup a correct hash table of D-Bus properties for the new collection. You may prefer to use @@ -6147,13 +6338,13 @@ any prompts that are required. a secret service object + line="1703">a secret service object hash table of properties for + line="1704">hash table of properties for the new collection @@ -6166,14 +6357,14 @@ any prompts that are required. allow-none="1"> an alias to check for before creating the new + line="1706">an alias to check for before creating the new collection, or to assign to the new collection not currently used + line="1708">not currently used @@ -6183,7 +6374,7 @@ any prompts that are required. allow-none="1"> optional cancellation object + line="1709">optional cancellation object closure="5"> called when the operation completes + line="1710">called when the operation completes allow-none="1"> data to be passed to the callback + line="1711">data to be passed to the callback @@ -6215,13 +6406,13 @@ any prompts that are required. throws="1"> Finish asynchronous operation to create a new collection in the secret + line="1783">Finish asynchronous operation to create a new collection in the secret service. a new string containing the D-Bus object path + line="1794">a new string containing the D-Bus object path of the collection @@ -6229,13 +6420,13 @@ service. a secret service object + line="1785">a secret service object the asynchronous result passed to the callback + line="1786">the asynchronous result passed to the callback @@ -6244,10 +6435,11 @@ service. c:identifier="secret_service_create_collection_dbus_path_sync" introspectable="0" stability="Unstable" - throws="1"> + throws="1" + glib:async-func="create_collection_dbus_path"> Create a new collection in the secret service and return its path. + line="1818">Create a new collection in the secret service and return its path. Using this method requires that you setup a correct hash table of D-Bus properties for the new collection. You may prefer to use @@ -6272,7 +6464,7 @@ will be used to handle any prompts that are required. a new string containing the D-Bus object path + line="1853">a new string containing the D-Bus object path of the collection @@ -6280,13 +6472,13 @@ will be used to handle any prompts that are required. a secret service object + line="1820">a secret service object hash table of D-Bus properties + line="1821">hash table of D-Bus properties for the new collection @@ -6299,14 +6491,14 @@ will be used to handle any prompts that are required. allow-none="1"> an alias to check for before creating the new + line="1823">an alias to check for before creating the new collection, or to assign to the new collection not currently used + line="1825">not currently used @@ -6316,7 +6508,7 @@ will be used to handle any prompts that are required. allow-none="1"> optional cancellation object + line="1826">optional cancellation object @@ -6324,10 +6516,12 @@ will be used to handle any prompts that are required. + stability="Unstable" + glib:finish-func="create_item_dbus_path_finish" + glib:sync-func="create_item_dbus_path_sync"> Create a new item in a secret service collection and return its D-Bus + line="2004">Create a new item in a secret service collection and return its D-Bus object path. It is often easier to use [func@password_store] or [func@Item.create] @@ -6354,19 +6548,19 @@ any prompts that are required. a secret service object + line="2006">a secret service object the D-Bus object path of the collection in which to create item + line="2007">the D-Bus object path of the collection in which to create item hash table of D-Bus properties + line="2008">hash table of D-Bus properties for the new collection @@ -6376,13 +6570,13 @@ any prompts that are required. the secret value to store in the item + line="2010">the secret value to store in the item flags for the creation of the new item + line="2011">flags for the creation of the new item allow-none="1"> optional cancellation object + line="2012">optional cancellation object closure="6"> called when the operation completes + line="2013">called when the operation completes allow-none="1"> data to be passed to the callback + line="2014">data to be passed to the callback @@ -6423,13 +6617,13 @@ any prompts that are required. throws="1"> Finish asynchronous operation to create a new item in the secret + line="2074">Finish asynchronous operation to create a new item in the secret service. a new string containing the D-Bus object path + line="2085">a new string containing the D-Bus object path of the item @@ -6437,13 +6631,13 @@ service. a secret service object + line="2076">a secret service object the asynchronous result passed to the callback + line="2077">the asynchronous result passed to the callback @@ -6451,10 +6645,11 @@ service. + throws="1" + glib:async-func="create_item_dbus_path"> Create a new item in a secret service collection and return its D-Bus + line="2126">Create a new item in a secret service collection and return its D-Bus object path. It is often easier to use [func@password_store_sync] or [func@Item.create_sync] @@ -6477,7 +6672,7 @@ will be used to handle any prompts that are required. a new string containing the D-Bus object path + line="2159">a new string containing the D-Bus object path of the item @@ -6485,19 +6680,19 @@ will be used to handle any prompts that are required. a secret service object + line="2128">a secret service object the D-Bus path of the collection in which to create item + line="2129">the D-Bus path of the collection in which to create item hash table of D-Bus properties + line="2130">hash table of D-Bus properties for the new collection @@ -6507,13 +6702,13 @@ will be used to handle any prompts that are required. the secret value to store in the item + line="2132">the secret value to store in the item flags for the creation of the new item + line="2133">flags for the creation of the new item allow-none="1"> optional cancellation object + line="2134">optional cancellation object @@ -6531,7 +6726,7 @@ will be used to handle any prompts that are required. c:identifier="secret_service_decode_dbus_secret"> Decode a [struct@Value] into [struct@GLib.Variant] received with the Secret Service + line="2591">Decode a [struct@Value] into [struct@GLib.Variant] received with the Secret Service DBus API. The [struct@GLib.Variant] should have a `(oayays)` signature. @@ -6542,20 +6737,20 @@ the encoded secret must be valid for that session. the decoded secret value + line="2604">the decoded secret value the service + line="2593">the service the encoded secret + line="2594">the encoded secret @@ -6563,10 +6758,12 @@ the encoded secret must be valid for that session. + stability="Unstable" + glib:finish-func="delete_item_dbus_path_finish" + glib:sync-func="delete_item_dbus_path_sync"> Delete a secret item from the secret service. + line="1530">Delete a secret item from the secret service. The item is represented by its D-Bus object path. If you already have a [class@Item] proxy objects, use use [method@Item.delete] instead. @@ -6580,13 +6777,13 @@ This method will return immediately and complete asynchronously. the secret service + line="1532">the secret service the D-Bus path of item to delete + line="1533">the D-Bus path of item to delete allow-none="1"> optional cancellation object + line="1534">optional cancellation object closure="3"> called when the operation completes + line="1535">called when the operation completes allow-none="1"> data to be passed to the callback + line="1536">data to be passed to the callback @@ -6627,26 +6824,26 @@ This method will return immediately and complete asynchronously. throws="1"> Complete an asynchronous operation to delete a secret item from the secret + line="1561">Complete an asynchronous operation to delete a secret item from the secret service. whether the deletion was successful or not + line="1572">whether the deletion was successful or not the secret service + line="1563">the secret service the asynchronous result passed to the callback + line="1564">the asynchronous result passed to the callback @@ -6655,10 +6852,11 @@ service. c:identifier="secret_service_delete_item_dbus_path_sync" introspectable="0" stability="Unstable" - throws="1"> + throws="1" + glib:async-func="delete_item_dbus_path"> Delete a secret item from the secret service. + line="1582">Delete a secret item from the secret service. The item is represented by its D-Bus object path. If you already have a [class@Item] proxy objects, use use [method@Item.delete_sync] instead. @@ -6669,20 +6867,20 @@ threads. whether the deletion was successful or not + line="1599">whether the deletion was successful or not the secret service + line="1584">the secret service the D-Bus path of item to delete + line="1585">the D-Bus path of item to delete allow-none="1"> optional cancellation object + line="1586">optional cancellation object @@ -6700,7 +6898,7 @@ threads. c:identifier="secret_service_encode_dbus_secret"> Encodes a [struct@Value] into [struct@GLib.Variant] for use with the Secret + line="2562">Encodes a [struct@Value] into [struct@GLib.Variant] for use with the Secret Service DBus API. The resulting [struct@GLib.Variant] will have a `(oayays)` signature. @@ -6710,26 +6908,28 @@ A session must have already been established by the [class@Service]. the encoded secret + line="2574">the encoded secret the service + line="2564">the service the secret value + line="2565">the secret value + c:identifier="secret_service_ensure_session" + glib:finish-func="ensure_session_finish" + glib:sync-func="ensure_session_sync"> Ensure that the #SecretService proxy has established a session with the @@ -6816,7 +7016,8 @@ has established a session with the Secret Service. + throws="1" + glib:async-func="ensure_session"> Ensure that the #SecretService proxy has established a session with the @@ -6959,7 +7160,9 @@ This will always be either [class@Item] or derived from it. + stability="Unstable" + glib:finish-func="get_secret_for_dbus_path_finish" + glib:sync-func="get_secret_for_dbus_path_sync"> Get the secret value for a secret item stored in the service. @@ -7055,10 +7258,11 @@ Will return %NULL if the item is locked. c:identifier="secret_service_get_secret_for_dbus_path_sync" introspectable="0" stability="Unstable" - throws="1"> + throws="1" + glib:async-func="get_secret_for_dbus_path"> Get the secret value for a secret item stored in the service. + line="805">Get the secret value for a secret item stored in the service. The item is represented by its D-Bus object path. If you already have a [class@Item] proxy object, use use [method@Item.load_secret_sync] to more simply @@ -7072,7 +7276,7 @@ Will return %NULL if the item is locked. the newly allocated secret value + line="825">the newly allocated secret value the item, which should be released with [method@Value.unref] @@ -7080,13 +7284,13 @@ Will return %NULL if the item is locked. the secret service + line="807">the secret service the D-Bus path to item to retrieve secret for + line="808">the D-Bus path to item to retrieve secret for allow-none="1"> optional cancellation object + line="809">optional cancellation object @@ -7103,10 +7307,12 @@ Will return %NULL if the item is locked. + stability="Unstable" + glib:finish-func="get_secrets_for_dbus_paths_finish" + glib:sync-func="get_secrets_for_dbus_paths_sync"> Get the secret values for a secret item stored in the service. + line="858">Get the secret values for a secret item stored in the service. The items are represented by their D-Bus object paths. If you already have [class@Item] proxy objects, use use [func@Item.load_secrets] to more simply @@ -7121,13 +7327,13 @@ This function returns immediately and completes asynchronously. the secret service + line="860">the secret service the D-Bus paths to items to retrieve secrets for + line="861">the D-Bus paths to items to retrieve secrets for allow-none="1"> optional cancellation object + line="862">optional cancellation object closure="3"> called when the operation completes + line="863">called when the operation completes allow-none="1"> data to pass to the callback + line="864">data to pass to the callback @@ -7168,7 +7374,7 @@ This function returns immediately and completes asynchronously. throws="1"> Complete asynchronous operation to get the secret values for an + line="903">Complete asynchronous operation to get the secret values for an secret items stored in the service. Items that are locked will not be included the results. @@ -7176,7 +7382,7 @@ Items that are locked will not be included the results. a newly + line="916">a newly allocated hash table of item path keys to [struct@Value] values. @@ -7188,13 +7394,13 @@ Items that are locked will not be included the results. the secret service + line="905">the secret service asynchronous result passed to callback + line="906">asynchronous result passed to callback @@ -7203,10 +7409,11 @@ Items that are locked will not be included the results. c:identifier="secret_service_get_secrets_for_dbus_paths_sync" introspectable="0" stability="Unstable" - throws="1"> + throws="1" + glib:async-func="get_secrets_for_dbus_paths"> Get the secret values for a secret item stored in the service. + line="945">Get the secret values for a secret item stored in the service. The items are represented by their D-Bus object paths. If you already have [class@Item] proxy objects, use use [func@Item.load_secrets_sync] to more @@ -7220,7 +7427,7 @@ Items that are locked will not be included the results. a newly + line="965">a newly allocated hash table of item_path keys to [struct@Value] values. @@ -7232,13 +7439,13 @@ Items that are locked will not be included the results. the secret service + line="947">the secret service the D-Bus paths to items to retrieve secrets for + line="948">the D-Bus paths to items to retrieve secrets for allow-none="1"> optional cancellation object + line="949">optional cancellation object @@ -7305,7 +7512,9 @@ This will be %NULL if no session has been established. Use + c:identifier="secret_service_load_collections" + glib:finish-func="load_collections_finish" + glib:sync-func="load_collections_sync"> Ensure that the #SecretService proxy has loaded all the collections present @@ -7391,7 +7600,8 @@ has loaded all the collections present in the Secret Service. + throws="1" + glib:async-func="load_collections"> Ensure that the #SecretService proxy has loaded all the collections present @@ -7430,7 +7640,10 @@ threads. - + Lock items or collections in the secret service. @@ -7500,10 +7713,12 @@ any prompts that show up. + stability="Unstable" + glib:finish-func="lock_dbus_paths_finish" + glib:sync-func="lock_dbus_paths_sync"> Lock items or collections in the secret service. + line="1205">Lock items or collections in the secret service. The items or collections are represented by their D-Bus object paths. If you already have [class@Item] and [class@Collection] proxy objects, use use @@ -7523,13 +7738,13 @@ any prompts that show up. the secret service + line="1207">the secret service the D-Bus paths for items or collections to lock + line="1208">the D-Bus paths for items or collections to lock @@ -7540,7 +7755,7 @@ any prompts that show up. allow-none="1"> optional cancellation object + line="1209">optional cancellation object closure="3"> called when the operation completes + line="1210">called when the operation completes allow-none="1"> data to pass to the callback + line="1211">data to pass to the callback @@ -7572,7 +7787,7 @@ any prompts that show up. throws="1"> Complete asynchronous operation to lock items or collections in the secret + line="1243">Complete asynchronous operation to lock items or collections in the secret service. The secret service may not be able to lock items individually, and may @@ -7581,20 +7796,20 @@ lock an entire collection instead. the number of items or collections that were locked + line="1260">the number of items or collections that were locked the secret service + line="1245">the secret service asynchronous result passed to the callback + line="1246">asynchronous result passed to the callback allow-none="1"> + line="1247"> location to place array of D-Bus paths of items or collections that were locked @@ -7619,10 +7834,11 @@ lock an entire collection instead. c:identifier="secret_service_lock_dbus_paths_sync" introspectable="0" stability="Unstable" - throws="1"> + throws="1" + glib:async-func="lock_dbus_paths"> Lock items or collections in the secret service. + line="1146">Lock items or collections in the secret service. The items or collections are represented by their D-Bus object paths. If you already have [class@Item] and [class@Collection] proxy objects, use use @@ -7638,20 +7854,20 @@ interface threads. The secret service may prompt the user. the number of items or collections that were locked + line="1171">the number of items or collections that were locked the secret service + line="1148">the secret service the D-Bus object paths of the items or collections to lock + line="1149">the D-Bus object paths of the items or collections to lock @@ -7662,7 +7878,7 @@ interface threads. The secret service may prompt the user. allow-none="1"> optional cancellation object + line="1150">optional cancellation object + line="1151"> location to place array of D-Bus paths of items or collections that were locked @@ -7735,7 +7951,8 @@ lock an entire collection instead. + throws="1" + glib:async-func="lock"> Lock items or collections in the secret service. @@ -7800,7 +8017,10 @@ interface threads. The secret service may prompt the user. - + Lookup a secret value in the secret service. @@ -7910,7 +8130,8 @@ If no secret is found then %NULL is returned. + throws="1" + glib:async-func="lookup"> Lookup a secret value in the secret service. @@ -7969,7 +8190,10 @@ threads. - + Perform prompting for a [class@Prompt]. @@ -8040,10 +8264,12 @@ run [method@Prompt.perform] on the prompt. + stability="Unstable" + glib:finish-func="prompt_at_dbus_path_finish" + glib:sync-func="prompt_at_dbus_path_sync"> Perform prompting for a [class@Prompt]. + line="2494">Perform prompting for a [class@Prompt]. This function is called by other parts of this library to handle prompts for the various actions that can require prompting. @@ -8059,13 +8285,13 @@ run [method@Prompt.perform] on the prompt. the secret service + line="2496">the secret service the D-Bus object path of the prompt + line="2497">the D-Bus object path of the prompt allow-none="1"> the variant type of the prompt result + line="2498">the variant type of the prompt result allow-none="1"> optional cancellation object + line="2499">optional cancellation object closure="4"> called when the operation completes + line="2500">called when the operation completes allow-none="1"> data to be passed to the callback + line="2501">data to be passed to the callback @@ -8115,7 +8341,7 @@ run [method@Prompt.perform] on the prompt. throws="1"> Complete asynchronous operation to perform prompting for a [class@Prompt]. + line="2533">Complete asynchronous operation to perform prompting for a [class@Prompt]. Returns a variant result if the prompt was completed and not dismissed. The type of result depends on the action the prompt is completing, and is defined @@ -8124,7 +8350,7 @@ in the Secret Service DBus API specification. %NULL if the prompt was dismissed or an + line="2547">%NULL if the prompt was dismissed or an error occurred, a variant result if the prompt was successful @@ -8132,13 +8358,13 @@ in the Secret Service DBus API specification. the secret service + line="2535">the secret service the asynchronous result passed to the callback + line="2536">the asynchronous result passed to the callback @@ -8147,10 +8373,11 @@ in the Secret Service DBus API specification. c:identifier="secret_service_prompt_at_dbus_path_sync" introspectable="0" stability="Unstable" - throws="1"> + throws="1" + glib:async-func="prompt_at_dbus_path"> Perform prompting for a [class@Prompt]. + line="2447">Perform prompting for a [class@Prompt]. Override the #SecretServiceClass [vfunc@Service.prompt_async] virtual method to change the behavior of the propmting. The default behavior is to simply @@ -8165,7 +8392,7 @@ This method may block and should not be used in user interface threads. %NULL if the prompt was dismissed or an + line="2469">%NULL if the prompt was dismissed or an error occurred, a variant result if the prompt was successful @@ -8173,13 +8400,13 @@ This method may block and should not be used in user interface threads. the secret service + line="2449">the secret service the D-Bus object path of the prompt + line="2450">the D-Bus object path of the prompt allow-none="1"> optional cancellation object + line="2451">optional cancellation object allow-none="1"> the variant type of the prompt result + line="2452">the variant type of the prompt result @@ -8237,7 +8464,8 @@ in the Secret Service DBus API specification. + throws="1" + glib:async-func="prompt"> Perform prompting for a [class@Prompt]. @@ -8294,10 +8522,12 @@ run [method@Prompt.perform_sync] on the prompt with a %NULL `window_id`. + stability="Unstable" + glib:finish-func="read_alias_dbus_path_finish" + glib:sync-func="read_alias_dbus_path_sync"> Lookup which collection is assigned to this alias. + line="2196">Lookup which collection is assigned to this alias. Aliases help determine well known collections, such as 'default'. This method looks up the dbus object path of the well known collection. @@ -8311,13 +8541,13 @@ This method will return immediately and complete asynchronously. a secret service object + line="2198">a secret service object the alias to lookup + line="2199">the alias to lookup allow-none="1"> optional cancellation object + line="2200">optional cancellation object closure="3"> called when the operation completes + line="2201">called when the operation completes allow-none="1"> data to pass to the callback + line="2202">data to pass to the callback @@ -8358,7 +8588,7 @@ This method will return immediately and complete asynchronously. throws="1"> Finish an asynchronous operation to lookup which collection is assigned + line="2230">Finish an asynchronous operation to lookup which collection is assigned to an alias. This method returns the DBus object path of the collection @@ -8366,7 +8596,7 @@ This method returns the DBus object path of the collection the collection dbus object path, + line="2243">the collection dbus object path, or %NULL if none assigned to the alias @@ -8374,13 +8604,13 @@ This method returns the DBus object path of the collection a secret service object + line="2232">a secret service object asynchronous result passed to callback + line="2233">asynchronous result passed to callback @@ -8389,10 +8619,11 @@ This method returns the DBus object path of the collection c:identifier="secret_service_read_alias_dbus_path_sync" introspectable="0" stability="Unstable" - throws="1"> + throws="1" + glib:async-func="read_alias_dbus_path"> Lookup which collection is assigned to this alias. + line="2271">Lookup which collection is assigned to this alias. Aliases help determine well known collections, such as 'default'. This method returns the dbus object path of the collection. @@ -8402,7 +8633,7 @@ This method may block and should not be used in user interface threads. the collection dbus object path, + line="2287">the collection dbus object path, or %NULL if none assigned to the alias @@ -8410,13 +8641,13 @@ This method may block and should not be used in user interface threads. a secret service object + line="2273">a secret service object the alias to lookup + line="2274">the alias to lookup allow-none="1"> optional cancellation object + line="2275">optional cancellation object - + Search for items matching the @attributes. @@ -8559,7 +8793,9 @@ This function returns immediately and completes asynchronously. + stability="Unstable" + glib:finish-func="search_for_dbus_paths_finish" + glib:sync-func="search_for_dbus_paths_sync"> Search for items matching the @attributes, and return their D-Bus object paths. @@ -8708,7 +8944,8 @@ instead, then us the [method@Service.search] and c:identifier="secret_service_search_for_dbus_paths_sync" introspectable="0" stability="Unstable" - throws="1"> + throws="1" + glib:async-func="search_for_dbus_paths"> Search for items matching the @attributes, and return their D-Bus object @@ -8803,7 +9040,8 @@ instead, then use the [method@Service.search_sync] function. + throws="1" + glib:async-func="search"> Search for items matching the @attributes. @@ -8884,7 +9122,10 @@ in user interface threads. - + Assign a collection to this alias. @@ -8988,7 +9229,8 @@ This method will return immediately and complete asynchronously. + throws="1" + glib:async-func="set_alias"> Assign a collection to this alias. Aliases help determine @@ -9044,10 +9286,12 @@ This method may block and should not be used in user interface threads. + stability="Unstable" + glib:finish-func="set_alias_to_dbus_path_finish" + glib:sync-func="set_alias_to_dbus_path_sync"> Assign a collection to this alias. Aliases help determine + line="2319">Assign a collection to this alias. Aliases help determine well known collections, such as 'default'. This method takes the dbus object path of the collection to assign to the alias. @@ -9060,13 +9304,13 @@ This method will return immediately and complete asynchronously. a secret service object + line="2321">a secret service object the alias to assign the collection to + line="2322">the alias to assign the collection to allow-none="1"> the dbus object path of the collection to assign to the alias + line="2323">the dbus object path of the collection to assign to the alias allow-none="1"> optional cancellation object + line="2324">optional cancellation object closure="4"> called when the operation completes + line="2325">called when the operation completes allow-none="1"> data to pass to the callback + line="2326">data to pass to the callback @@ -9116,25 +9360,25 @@ This method will return immediately and complete asynchronously. throws="1"> Finish an asynchronous operation to assign a collection to an alias. + line="2359">Finish an asynchronous operation to assign a collection to an alias. %TRUE if successful + line="2369">%TRUE if successful a secret service object + line="2361">a secret service object asynchronous result passed to callback + line="2362">asynchronous result passed to callback @@ -9143,10 +9387,11 @@ This method will return immediately and complete asynchronously. c:identifier="secret_service_set_alias_to_dbus_path_sync" introspectable="0" stability="Unstable" - throws="1"> + throws="1" + glib:async-func="set_alias_to_dbus_path"> Assign a collection to this alias. + line="2391">Assign a collection to this alias. Aliases help determine well known collections, such as 'default'. This method takes the dbus object path of the collection to assign to the alias. @@ -9156,20 +9401,20 @@ This method may block and should not be used in user interface threads. %TRUE if successful + line="2409">%TRUE if successful a secret service object + line="2393">a secret service object the alias to assign the collection to + line="2394">the alias to assign the collection to allow-none="1"> the D-Bus object path of the collection to + line="2395">the D-Bus object path of the collection to assign to the alias @@ -9188,12 +9433,15 @@ This method may block and should not be used in user interface threads. allow-none="1"> optional cancellation object + line="2397">optional cancellation object - + Store a secret value in the secret service. @@ -9329,7 +9577,8 @@ This method will return immediately and complete asynchronously. + throws="1" + glib:async-func="store"> Store a secret value in the secret service. @@ -9416,7 +9665,10 @@ threads. - + Unlock items or collections in the secret service. @@ -9486,10 +9738,12 @@ interface threads. The secret service may prompt the user. + stability="Unstable" + glib:finish-func="unlock_dbus_paths_finish" + glib:sync-func="unlock_dbus_paths_sync"> Unlock items or collections in the secret service. + line="1335">Unlock items or collections in the secret service. The items or collections are represented by their D-Bus object paths. If you already have [class@Item] and [class@Collection] proxy objects, use use @@ -9509,13 +9763,13 @@ any prompts that show up. the secret service + line="1337">the secret service the D-Bus paths for items or + line="1338">the D-Bus paths for items or collections to unlock @@ -9527,7 +9781,7 @@ any prompts that show up. allow-none="1"> optional cancellation object + line="1340">optional cancellation object closure="3"> called when the operation completes + line="1341">called when the operation completes allow-none="1"> data to pass to the callback + line="1342">data to pass to the callback @@ -9559,7 +9813,7 @@ any prompts that show up. throws="1"> Complete asynchronous operation to unlock items or collections in the secret + line="1375">Complete asynchronous operation to unlock items or collections in the secret service. The secret service may not be able to unlock items individually, and may @@ -9568,20 +9822,20 @@ unlock an entire collection instead. the number of items or collections that were unlocked + line="1392">the number of items or collections that were unlocked the secret service + line="1377">the secret service asynchronous result passed to the callback + line="1378">asynchronous result passed to the callback allow-none="1"> + line="1379"> location to place array of D-Bus paths of items or collections that were unlocked @@ -9606,10 +9860,11 @@ unlock an entire collection instead. c:identifier="secret_service_unlock_dbus_paths_sync" introspectable="0" stability="Unstable" - throws="1"> + throws="1" + glib:async-func="unlock_dbus_paths"> Unlock items or collections in the secret service. + line="1275">Unlock items or collections in the secret service. The items or collections are represented by their D-Bus object paths. If you already have [class@Item] and [class@Collection] proxy objects, use use @@ -9625,20 +9880,20 @@ interface threads. The secret service may prompt the user. the number of items or collections that were unlocked + line="1301">the number of items or collections that were unlocked the secret service + line="1277">the secret service the D-Bus object paths of the items or + line="1278">the D-Bus object paths of the items or collections to unlock @@ -9650,7 +9905,7 @@ interface threads. The secret service may prompt the user. allow-none="1"> optional cancellation object + line="1280">optional cancellation object + line="1281"> location to place array of D-Bus paths of items or collections that were unlocked @@ -9723,7 +9978,8 @@ unlock an entire collection instead. + throws="1" + glib:async-func="unlock"> Unlock items or collections in the secret service. @@ -9841,6 +10097,9 @@ method. + called to perform synchronous prompting when necessary @@ -9882,6 +10141,9 @@ method. + called to perform asynchronous prompting when necessary @@ -9923,6 +10185,9 @@ method. + called to complete an asynchronous prompt operation @@ -9949,6 +10214,10 @@ method. + called to get the GObject type for collections + instantiated by the #SecretService proxy @@ -9968,6 +10237,10 @@ method. + called to get the GObject type for collections + instantiated by the #SecretService proxy @@ -10370,6 +10643,40 @@ string, an int number, or a gboolean value, as defined in the password + + Check if attributes are valid according to the provided schema. + +Verifies schema name if available, attribute names and parsing +of attribute values. + + + whether or not the given attributes table is valid + + + + + the schema for the attributes + + + + the attributes to be validated + + + + + + + moved-to="Error.get_quark"> Get the error quark. + line="83">Get the error quark. the quark + line="88">the quark diff --git a/girs/Shell-14.gir b/girs/Shell-14.gir index 522219c90..48b833ac4 100644 --- a/girs/Shell-14.gir +++ b/girs/Shell-14.gir @@ -154,7 +154,7 @@ event timestamp. glib:finish-func="activate_action_finish"> This activates an action using 'org.freedesktop.Application' DBus interface. + line="1559">This activates an action using 'org.freedesktop.Application' DBus interface. This function will fail if this #ShellApp doesn't have a valid #GDesktopAppInfo with a valid id. @@ -166,13 +166,13 @@ with a valid id. the #ShellApp + line="1561">the #ShellApp the name of an action to activate + line="1562">the name of an action to activate allow-none="1"> the parameter to the activation + line="1563">the parameter to the activation Event timestamp, or 0 for current event timestamp + line="1564">Event timestamp, or 0 for current event timestamp Start on this workspace, or -1 for default + line="1565">Start on this workspace, or -1 for default allow-none="1"> a #GCancellable or %NULL + line="1566">a #GCancellable or %NULL closure="6"> A #GAsyncReadyCallback to call when the request is satisfied. + line="1567">A #GAsyncReadyCallback to call when the request is satisfied. allow-none="1"> User data to pass to @callback + line="1568">User data to pass to @callback @@ -232,20 +232,20 @@ with a valid id. throws="1"> Finish the asynchronous operation started by shell_app_activate_action() + line="1611">Finish the asynchronous operation started by shell_app_activate_action() and obtain its result. whether the operation was successful + line="1619">whether the operation was successful the #ShellApp + line="1613">the #ShellApp @@ -373,12 +373,12 @@ like presenting the most recently active one) Order two applications by name. + line="1737">Order two applications by name. -1, 0, or 1; suitable for use as a comparison function + line="1744">-1, 0, or 1; suitable for use as a comparison function for e.g. g_slist_sort() @@ -386,13 +386,13 @@ for e.g. g_slist_sort() One app + line="1739">One app The other app + line="1740">The other app @@ -426,14 +426,14 @@ for it at the given size. The #GDesktopAppInfo for this app, or %NULL if backed by a window + line="1643">The #GDesktopAppInfo for this app, or %NULL if backed by a window a #ShellApp + line="1641">a #ShellApp @@ -619,19 +619,19 @@ how to launch it again. Event timestamp, or 0 for current event timestamp + line="1335">Event timestamp, or 0 for current event timestamp Start on this workspace, or -1 for default + line="1336">Start on this workspace, or -1 for default the GPU to prefer launching on + line="1337">the GPU to prefer launching on @@ -645,26 +645,26 @@ how to launch it again. the #ShellApp + line="1425">the #ShellApp the name of the action to launch (as obtained by + line="1426">the name of the action to launch (as obtained by g_desktop_app_info_list_actions()) Event timestamp, or 0 for current event timestamp + line="1428">Event timestamp, or 0 for current event timestamp Start on this workspace, or -1 for default + line="1429">Start on this workspace, or -1 for default @@ -749,7 +749,7 @@ This operation may not be supported for all applications. The #GDBusActionGroup associated with this ShellApp, if any. See the + line="1858">The #GDBusActionGroup associated with this ShellApp, if any. See the documentation of #GApplication and #GActionGroup for details. @@ -760,7 +760,7 @@ documentation of #GApplication and #GActionGroup for details. getter="get_app_info"> The #GDesktopAppInfo associated with this ShellApp, if any. + line="1871">The #GDesktopAppInfo associated with this ShellApp, if any. default-value="FALSE"> Whether the application has marked itself as busy. + line="1821">Whether the application has marked itself as busy. The #GIcon representing this ShellApp + line="1846">The #GIcon representing this ShellApp default-value="NULL"> The id of this application (a desktop filename, or a special string + line="1833">The id of this application (a desktop filename, or a special string like window:0xabcd1234) @@ -794,7 +794,7 @@ like window:0xabcd1234) default-value="SHELL_APP_STATE_STOPPED"> The high-level state of the application, effectively whether it's + line="1807">The high-level state of the application, effectively whether it's running or not, or transitioning between those states. @@ -5155,21 +5155,21 @@ If @window is not part of preview, this function will do nothing. throws="1"> Synchronously load the contents of a file as a NUL terminated + line="209">Synchronously load the contents of a file as a NUL terminated string, validating it as UTF-8. Embedded NUL characters count as invalid content. File contents + line="218">File contents UTF-8 encoded filename path + line="211">UTF-8 encoded filename path @@ -5269,7 +5269,7 @@ have it also track through startup-notification. c:identifier="shell_util_check_cloexec_fds"> Walk over all open file descriptors. Check them for the FD_CLOEXEC flag. + line="446">Walk over all open file descriptors. Check them for the FD_CLOEXEC flag. If this flag is not set, log the offending file descriptor number. It is important that gnome-shell's file descriptors are all marked CLOEXEC, @@ -5284,7 +5284,7 @@ that we launch. c:identifier="shell_util_create_pixbuf_from_data"> Workaround for non-introspectability of gdk_pixbuf_from_data(). + line="326">Workaround for non-introspectability of gdk_pixbuf_from_data(). @@ -5322,20 +5322,20 @@ that we launch. c:identifier="shell_util_get_translated_folder_name"> Attempts to translate the folder @name using translations provided + line="801">Attempts to translate the folder @name using translations provided by .directory files. a translated string or %NULL + line="808">a translated string or %NULL the untranslated folder name + line="803">the untranslated folder name @@ -5343,13 +5343,13 @@ by .directory files. A wrapper around getuid() so that it can be used from JavaScript. This + line="463">A wrapper around getuid() so that it can be used from JavaScript. This function will always succeed. the real user ID of the calling process + line="469">the real user ID of the calling process @@ -5357,14 +5357,14 @@ function will always succeed. c:identifier="shell_util_get_week_start"> Gets the first week day for the current locale, expressed as a + line="81">Gets the first week day for the current locale, expressed as a number in the range 0..6, representing week days from Sunday to Saturday. A number representing the first week day for the current + line="88">A number representing the first week day for the current locale @@ -5373,7 +5373,7 @@ Saturday. c:identifier="shell_util_has_x11_display_extension"> If the corresponding X11 display provides the passed extension, return %TRUE, + line="777">If the corresponding X11 display provides the passed extension, return %TRUE, otherwise %FALSE. If there is no X11 display, %FALSE is passed. @@ -5383,13 +5383,13 @@ otherwise %FALSE. If there is no X11 display, %FALSE is passed. A #MetaDisplay + line="779">A #MetaDisplay An X11 extension + line="780">An X11 extension @@ -5397,20 +5397,20 @@ otherwise %FALSE. If there is no X11 display, %FALSE is passed. A wrapper around g_regex_escape_string() that takes its argument as + line="174">A wrapper around g_regex_escape_string() that takes its argument as \0-terminated string rather than a byte-array that confuses gjs. @str with all regex-special characters escaped + line="181">@str with all regex-special characters escaped a UTF-8 string to escape + line="176">a UTF-8 string to escape @@ -5425,7 +5425,7 @@ otherwise %FALSE. If there is no X11 display, %FALSE is passed. c:identifier="shell_util_set_hidden_from_pick"> If @hidden is %TRUE, hide @actor from pick even with a mode of + line="48">If @hidden is %TRUE, hide @actor from pick even with a mode of %CLUTTER_PICK_ALL; if @hidden is %FALSE, unhide @actor. @@ -5435,17 +5435,370 @@ otherwise %FALSE. If there is no X11 display, %FALSE is passed. A #ClutterActor + line="50">A #ClutterActor Whether @actor should be hidden from pick + line="51">Whether @actor should be hidden from pick + + A wrapper around g_spawn_async() with async-signal-safe implementation of +#GSpawnChildSetupFunc to launch a child program asynchronously resetting the +rlimit nofile on child setup. + + + the PID of the child on success, 0 if error is set + + + + + child's current working + directory, or %NULL to inherit parent's + + + + + child's argument vector + + + + + + + child's environment, or %NULL to inherit parent's + + + + + + flags from #GSpawnFlags + + + + + + A wrapper around g_spawn_async_with_fds() with async-signal-safe +implementation of #GSpawnChildSetupFunc to launch a child program +asynchronously resetting the rlimit nofile on child setup. + + + the PID of the child on success, 0 if error is set + + + + + child's current working + directory, or %NULL to inherit parent's + + + + + child's argument vector + + + + + + + child's environment, or %NULL to inherit parent's + + + + + + flags from #GSpawnFlags + + + + file descriptor to use for child's stdin, or `-1` + + + + file descriptor to use for child's stdout, or `-1` + + + + file descriptor to use for child's stderr, or `-1` + + + + + + A wrapper around g_spawn_async_with_pipes() with async-signal-safe +implementation of #GSpawnChildSetupFunc to launch a child program +asynchronously resetting the rlimit nofile on child setup. + + + the PID of the child on success, 0 if error is set + + + + + child's current working + directory, or %NULL to inherit parent's + + + + + child's argument vector + + + + + + + child's environment, or %NULL to inherit parent's + + + + + + flags from #GSpawnFlags + + + + return location for file descriptor to write to child's stdin, or %NULL + + + + return location for file descriptor to read child's stdout, or %NULL + + + + return location for file descriptor to read child's stderr, or %NULL + + + + + + A wrapper around g_spawn_async_with_pipes_and_fds() with async-signal-safe +implementation of #GSpawnChildSetupFunc to launch a child program +asynchronously resetting the rlimit nofile on child setup. + + + the PID of the child on success, 0 if error is set + + + + + child's current working + directory, or %NULL to inherit parent's, in the GLib file name encoding + + + + child's argument + vector, in the GLib file name encoding; it must be non-empty and %NULL-terminated + + + + + + + child's environment, or %NULL to inherit parent's, in the GLib file + name encoding + + + + + + flags from #GSpawnFlags + + + + file descriptor to use for child's stdin, or `-1` + + + + file descriptor to use for child's stdout, or `-1` + + + + file descriptor to use for child's stderr, or `-1` + + + + array of FDs from the parent + process to make available in the child process + + + + + + array of FDs to remap + @source_fds to in the child process + + + + + + number of FDs in @source_fds and @target_fds + + + + return location for file descriptor to write to child's stdin, or %NULL + + + + return location for file descriptor to read child's stdout, or %NULL + + + + return location for file descriptor to read child's stderr, or %NULL + + + + @@ -5633,21 +5986,21 @@ otherwise %FALSE. If there is no X11 display, %FALSE is passed. c:identifier="shell_util_translate_time_string"> Translate @str according to the locale defined by LC_TIME; unlike + line="139">Translate @str according to the locale defined by LC_TIME; unlike dcgettext(), the translations is still taken from the LC_MESSAGES catalogue and not the LC_TIME one. the translated string + line="147">the translated string String to translate + line="141">String to translate @@ -5655,20 +6008,20 @@ catalogue and not the LC_TIME one. Implements libc standard WIFEXITED, that cannot be used JS + line="303">Implements libc standard WIFEXITED, that cannot be used JS code. TRUE if the process exited normally, FALSE otherwise + line="310">TRUE if the process exited normally, FALSE otherwise the status returned by wait() or waitpid() + line="305">the status returned by wait() or waitpid() transfer-ownership="full"> the actual exit status of the process + line="306">the actual exit status of the process @@ -5687,26 +6040,26 @@ code. throws="1"> Write a string to a GOutputStream as UTF-8. This is a workaround + line="189">Write a string to a GOutputStream as UTF-8. This is a workaround for not having binary buffers in GJS. %TRUE if write succeeded + line="198">%TRUE if write succeeded a #GOutputStream + line="191">a #GOutputStream a UTF-8 string to write to @stream + line="192">a UTF-8 string to write to @stream diff --git a/girs/Shumate-1.0.gir b/girs/Shumate-1.0.gir index eb7e9c10f..0d859802a 100644 --- a/girs/Shumate-1.0.gir +++ b/girs/Shumate-1.0.gir @@ -2300,11 +2300,11 @@ but is good enough for most purposes. the distance in meters between @this and @other + line="130">the distance in meters between @self and @other - + a [iface@Location] @@ -2613,7 +2613,7 @@ but is good enough for most purposes. - + The micro version of libshumate (3, if %SHUMATE_VERSION is 1.2.3) @@ -3321,7 +3321,7 @@ and draws them as a grid. Emitted when a symbol in the map layer is clicked. + line="799">Emitted when a symbol in the map layer is clicked. @@ -3329,7 +3329,7 @@ and draws them as a grid. a [class@SymbolEvent] with details about the clicked symbol. + line="802">a [class@SymbolEvent] with details about the clicked symbol. diff --git a/girs/Signon-2.0.gir b/girs/Signon-2.0.gir index 11bbc68a3..1f3ea7210 100644 --- a/girs/Signon-2.0.gir +++ b/girs/Signon-2.0.gir @@ -14,6 +14,66 @@ and/or use gtk-doc annotations. --> shared-library="libsignon-glib.so.2" c:identifier-prefixes="Signon" c:symbol-prefixes="signon"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:get-type="signon_auth_service_get_type" glib:type-struct="AuthServiceClass"> Opaque struct. Use the accessor functions below. + filename="libsignon-glib/signon-auth-service.h" + line="55">Opaque struct. Use the accessor functions below. + line="53"/> Create a new #SignonAuthService. + line="141">Create a new #SignonAuthService. + line="68"/> an instance of an #SignonAuthService. + line="146">an instance of an #SignonAuthService. @@ -44,9 +104,9 @@ and/or use gtk-doc annotations. --> version="2.0"> Lists all the available mechanisms. + line="231">Lists all the available mechanisms. + line="81"/> @@ -54,13 +114,13 @@ and/or use gtk-doc annotations. --> a #SignonAuthService + line="233">a #SignonAuthService the name of the method whose mechanisms must be retrieved. + line="234">the name of the method whose mechanisms must be retrieved. allow-none="1"> a #GCancellable or %NULL + line="235">a #GCancellable or %NULL closure="3"> a callback to execute upon completion + line="236">a callback to execute upon completion allow-none="1"> closure data for @callback + line="237">closure data for @callback @@ -99,13 +159,13 @@ and/or use gtk-doc annotations. --> throws="1"> Completes an asynchronous request to signon_auth_service_get_mechanisms(). + line="260">Completes an asynchronous request to signon_auth_service_get_mechanisms(). + line="86"/> A list of available + line="268">A list of available mechanisms. @@ -115,13 +175,13 @@ mechanisms. a #SignonAuthService + line="262">a #SignonAuthService a #GAsyncResult + line="263">a #GAsyncResult @@ -132,14 +192,14 @@ mechanisms. throws="1"> Lists all the available mechanisms. + line="281">Lists all the available mechanisms. This is a blocking version of signon_auth_service_get_mechanisms(). + line="89"/> A list of available + line="291">A list of available mechanisms. @@ -149,13 +209,13 @@ mechanisms. a #SignonAuthService + line="283">a #SignonAuthService the name of the method whose mechanisms must be retrieved. + line="284">the name of the method whose mechanisms must be retrieved. allow-none="1"> a #GCancellable or %NULL + line="285">a #GCancellable or %NULL @@ -174,9 +234,9 @@ mechanisms. version="2.0"> Lists all the available methods. + line="154">Lists all the available methods. + line="70"/> @@ -184,7 +244,7 @@ mechanisms. a #SignonAuthService + line="156">a #SignonAuthService allow-none="1"> a #GCancellable or %NULL + line="157">a #GCancellable or %NULL closure="2"> a callback to execute upon completion + line="158">a callback to execute upon completion allow-none="1"> closure data for @callback + line="159">closure data for @callback @@ -223,13 +283,13 @@ mechanisms. throws="1"> Completes an asynchronous request to signon_auth_service_get_methods(). + line="180">Completes an asynchronous request to signon_auth_service_get_methods(). + line="74"/> A list of available + line="188">A list of available methods. @@ -239,13 +299,13 @@ methods. a #SignonAuthService + line="182">a #SignonAuthService a #GAsyncResult + line="183">a #GAsyncResult @@ -256,14 +316,14 @@ methods. throws="1"> Lists all the available methods. + line="201">Lists all the available methods. This is a blocking version of signon_auth_service_get_methods(). + line="77"/> A list of available + line="210">A list of available methods. @@ -273,7 +333,7 @@ methods. a #SignonAuthService + line="203">a #SignonAuthService allow-none="1"> a #GCancellable or %NULL + line="204">a #GCancellable or %NULL + + + + + + Opaque struct. Use the accessor functions below. + filename="libsignon-glib/signon-auth-service.h" + line="45">Opaque struct. Use the accessor functions below. + line="53"/> + + + glib:get-type="signon_auth_session_get_type" glib:type-struct="AuthSessionClass"> Opaque struct. Use the accessor functions below. + filename="libsignon-glib/signon-auth-session.h" + line="123">Opaque struct. Use the accessor functions below. + line="141"/> Creates a new #SignonAuthSession, which can be used to authenticate using + line="334">Creates a new #SignonAuthSession, which can be used to authenticate using the specified method. + line="145"/> a new #SignonAuthSession. + line="345">a new #SignonAuthSession. the id of the #SignonIdentity to be used. Can be 0, if this session is + line="336">the id of the #SignonIdentity to be used. Can be 0, if this session is not bound to any stored identity. the name of the authentication method to be used. + line="338">the name of the authentication method to be used. @@ -346,9 +419,9 @@ not bound to any stored identity. Cancel the authentication session. + line="508">Cancel the authentication session. + line="161"/> @@ -356,7 +429,7 @@ not bound to any stored identity. the #SignonAuthSession. + line="510">the #SignonAuthSession. @@ -366,7 +439,7 @@ not bound to any stored identity. filename="libsignon-glib/signon-auth-session.c" line="412">Get the current authentication method. + line="149"/> version="1.8"> Performs one step of the authentication process. If the #SignonAuthSession + line="431">Performs one step of the authentication process. If the #SignonAuthSession object is bound to an existing identity, the identity properties such as username and password will be also passed to the authentication plugin, so there's no need to fill them into @session_data. @session_data can be used to add additional authentication parameters to the session, or to override the parameters otherwise taken from the identity. + line="151"/> @@ -402,19 +475,19 @@ session, or to override the parameters otherwise taken from the identity. the #SignonAuthSession. + line="433">the #SignonAuthSession. a dictionary of parameters. + line="434">a dictionary of parameters. the authentication mechanism to be used. + line="435">the authentication mechanism to be used. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="436">optional #GCancellable object, %NULL to ignore. closure="4"> a callback which will be called when the + line="437">a callback which will be called when the authentication reply is available. @@ -444,7 +517,7 @@ authentication reply is available. allow-none="1"> user data to be passed to the callback. + line="439">user data to be passed to the callback. @@ -455,13 +528,13 @@ authentication reply is available. throws="1"> Collect the result of the signon_auth_session_process() operation. + line="482">Collect the result of the signon_auth_session_process() operation. + line="157"/> a #GVariant of type %G_VARIANT_TYPE_VARDICT containing the + line="491">a #GVariant of type %G_VARIANT_TYPE_VARDICT containing the authentication reply. @@ -469,22 +542,28 @@ authentication reply. the #SignonAuthSession. + line="484">the #SignonAuthSession. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to + line="485">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to signon_auth_session_process(). + + + + + + Emitted when the state of the #SignonAuthSession changes. + line="310">Emitted when the state of the #SignonAuthSession changes. @@ -492,13 +571,13 @@ signon_auth_session_process(). the current state of the #SignonAuthSession + line="313">the current state of the #SignonAuthSession the message associated with the state change + line="314">the message associated with the state change @@ -508,14 +587,30 @@ signon_auth_session_process(). c:type="SignonAuthSessionClass" glib:is-gtype-struct-for="AuthSession"> Opaque struct. Use the accessor functions below. + filename="libsignon-glib/signon-auth-session.h" + line="134">Opaque struct. Use the accessor functions below. - + line="141"/> + + + + + + + + + + + + glib:nick="unknown" + glib:name="SIGNON_ERROR_UNKNOWN"> Catch-all for errors not distinguished by another code. @@ -535,7 +631,8 @@ signon_auth_session_process(). + glib:nick="internal-server" + glib:name="SIGNON_ERROR_INTERNAL_SERVER"> Signon daemon internal error. @@ -543,7 +640,8 @@ signon_auth_session_process(). + glib:nick="internal-communication" + glib:name="SIGNON_ERROR_INTERNAL_COMMUNICATION"> Error communicating with Sigon daemon. @@ -551,7 +649,8 @@ signon_auth_session_process(). + glib:nick="permission-denied" + glib:name="SIGNON_ERROR_PERMISSION_DENIED"> The operation cannot be performed due to @@ -560,7 +659,8 @@ insufficient client permissions. + glib:nick="method-not-known" + glib:name="SIGNON_ERROR_METHOD_NOT_KNOWN"> The method with this name was not found. @@ -568,7 +668,8 @@ insufficient client permissions. + glib:nick="service-not-available" + glib:name="SIGNON_ERROR_SERVICE_NOT_AVAILABLE"> The service is temporarily unavailable. @@ -576,7 +677,8 @@ insufficient client permissions. + glib:nick="invalid-query" + glib:name="SIGNON_ERROR_INVALID_QUERY"> Parameters for the query are invalid. @@ -584,7 +686,8 @@ insufficient client permissions. + glib:nick="method-not-available" + glib:name="SIGNON_ERROR_METHOD_NOT_AVAILABLE"> The requested method is not available. @@ -592,7 +695,8 @@ insufficient client permissions. + glib:nick="identity-not-found" + glib:name="SIGNON_ERROR_IDENTITY_NOT_FOUND"> The identity mathching the #SignonIdentity @@ -601,7 +705,8 @@ was not found on the service. + glib:nick="store-failed" + glib:name="SIGNON_ERROR_STORE_FAILED"> Storing credentials failed. @@ -609,7 +714,8 @@ was not found on the service. + glib:nick="remove-failed" + glib:name="SIGNON_ERROR_REMOVE_FAILED"> Removing credentials failed. @@ -617,7 +723,8 @@ was not found on the service. + glib:nick="signout-failed" + glib:name="SIGNON_ERROR_SIGNOUT_FAILED"> Signing out failed. @@ -625,7 +732,8 @@ was not found on the service. + glib:nick="identity-operation-canceled" + glib:name="SIGNON_ERROR_IDENTITY_OPERATION_CANCELED"> Identity operation was canceled @@ -634,7 +742,8 @@ by the user. + glib:nick="credentials-not-available" + glib:name="SIGNON_ERROR_CREDENTIALS_NOT_AVAILABLE"> Query failed. @@ -642,7 +751,8 @@ by the user. + glib:nick="reference-not-found" + glib:name="SIGNON_ERROR_REFERENCE_NOT_FOUND"> Trying to remove non-existent reference. @@ -650,7 +760,8 @@ by the user. + glib:nick="mechanism-not-available" + glib:name="SIGNON_ERROR_MECHANISM_NOT_AVAILABLE"> The requested mechanism in not @@ -659,7 +770,8 @@ available. + glib:nick="missing-data" + glib:name="SIGNON_ERROR_MISSING_DATA"> The #SessionData does not contain the necessary @@ -668,7 +780,8 @@ information. + glib:nick="invalid-credentials" + glib:name="SIGNON_ERROR_INVALID_CREDENTIALS"> The supplied credentials are invalid for @@ -677,7 +790,8 @@ the mechanism implementation. + glib:nick="not-authorized" + glib:name="SIGNON_ERROR_NOT_AUTHORIZED"> Authorization failed. @@ -685,7 +799,8 @@ the mechanism implementation. + glib:nick="wrong-state" + glib:name="SIGNON_ERROR_WRONG_STATE"> An operation method has been called in an @@ -694,7 +809,8 @@ incorrect state. + glib:nick="operation-not-supported" + glib:name="SIGNON_ERROR_OPERATION_NOT_SUPPORTED"> The operation is not supported by the @@ -703,7 +819,8 @@ mechanism implementation. + glib:nick="no-connection" + glib:name="SIGNON_ERROR_NO_CONNECTION"> No network connection. @@ -711,7 +828,8 @@ mechanism implementation. + glib:nick="network" + glib:name="SIGNON_ERROR_NETWORK"> Network connection failed. @@ -719,7 +837,8 @@ mechanism implementation. + glib:nick="ssl" + glib:name="SIGNON_ERROR_SSL"> SSL connection failed. @@ -727,7 +846,8 @@ mechanism implementation. + glib:nick="runtime" + glib:name="SIGNON_ERROR_RUNTIME"> Casting #SessionData into subclass failed. @@ -735,7 +855,8 @@ mechanism implementation. + glib:nick="session-canceled" + glib:name="SIGNON_ERROR_SESSION_CANCELED"> Challenge was canceled. @@ -743,7 +864,8 @@ mechanism implementation. + glib:nick="timed-out" + glib:name="SIGNON_ERROR_TIMED_OUT"> Challenge timed out. @@ -751,7 +873,8 @@ mechanism implementation. + glib:nick="user-interaction" + glib:name="SIGNON_ERROR_USER_INTERACTION"> User interaction dialog failed. @@ -759,7 +882,8 @@ mechanism implementation. + glib:nick="operation-failed" + glib:name="SIGNON_ERROR_OPERATION_FAILED"> Temporary failure in authentication. @@ -767,7 +891,8 @@ mechanism implementation. + glib:nick="encryption-failed" + glib:name="SIGNON_ERROR_ENCRYPTION_FAILED"> @deprecated: Failure during data @@ -776,7 +901,8 @@ encryption/decryption. + glib:nick="tos-not-accepted" + glib:name="SIGNON_ERROR_TOS_NOT_ACCEPTED"> User declined Terms of Service. @@ -784,7 +910,8 @@ encryption/decryption. + glib:nick="forgot-password" + glib:name="SIGNON_ERROR_FORGOT_PASSWORD"> User requested password reset sequence. @@ -792,7 +919,8 @@ encryption/decryption. + glib:nick="method-or-mechanism-not-allowed" + glib:name="SIGNON_ERROR_METHOD_OR_MECHANISM_NOT_ALLOWED"> Method or mechanism not @@ -801,7 +929,8 @@ allowed for this identity. + glib:nick="incorrect-date" + glib:name="SIGNON_ERROR_INCORRECT_DATE"> Date/time incorrect on device. @@ -809,7 +938,8 @@ allowed for this identity. + glib:nick="user-error" + glib:name="SIGNON_ERROR_USER_ERROR"> Placeholder to rearrange enumeration - userspace @@ -821,6 +951,91 @@ specific. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:get-type="signon_identity_get_type" glib:type-struct="IdentityClass"> Opaque struct. Use the accessor functions below. - + filename="libsignon-glib/signon-identity.h" + line="56">Opaque struct. Use the accessor functions below. + Construct new, empty, identity object. + line="596">Construct new, empty, identity object. + line="70"/> an instance of an #SignonIdentity. + line="601">an instance of an #SignonIdentity. @@ -849,21 +1064,21 @@ specific. c:identifier="signon_identity_new_from_db"> Construct an identity object associated with an existing identity + line="570">Construct an identity object associated with an existing identity record. + line="69"/> an instance of a #SignonIdentity. + line="577">an instance of a #SignonIdentity. identity ID. + line="572">identity ID. @@ -873,42 +1088,43 @@ record. throws="1"> Creates an authentication session for this identity. + line="630">Creates an authentication session for this identity. + line="76"/> a new #SignonAuthSession. + line="638">a new #SignonAuthSession. the #SignonIdentity. + line="632">the #SignonIdentity. method. + line="633">method. Get the id of the @identity. + line="449">Get the id of the @identity. + line="72"/> the id of the #SignonIdentity, or 0 if the identity has not being + line="457">the id of the #SignonIdentity, or 0 if the identity has not being registered. @@ -916,7 +1132,7 @@ registered. the #SignonIdentity. + line="451">the #SignonIdentity. @@ -925,20 +1141,20 @@ registered. c:identifier="signon_identity_get_last_error"> Get the most recent error that occurred on @identity. + line="482">Get the most recent error that occurred on @identity. + line="74"/> a #GError containing the most recent error, or %NULL on failure. + line="488">a #GError containing the most recent error, or %NULL on failure. the #SignonIdentity. + line="484">the #SignonIdentity. @@ -948,9 +1164,9 @@ registered. version="2.0"> Fetches the #SignonIdentityInfo associated with this identity. + line="1343">Fetches the #SignonIdentityInfo associated with this identity. + line="98"/> @@ -958,7 +1174,7 @@ registered. the #SignonIdentity. + line="1345">the #SignonIdentity. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="1346">optional #GCancellable object, %NULL to ignore. closure="2"> a callback which will be called when the #SignonIdentityInfo is + line="1347">a callback which will be called when the #SignonIdentityInfo is available. @@ -988,7 +1204,7 @@ available. allow-none="1"> user data to be passed to the callback. + line="1349">user data to be passed to the callback. @@ -998,26 +1214,26 @@ available. throws="1"> Collect the result of the signon_identity_query_info() operation. + line="1373">Collect the result of the signon_identity_query_info() operation. + line="102"/> the #SignonIdentityInfo associated with this identity. + line="1382">the #SignonIdentityInfo associated with this identity. the #SignonIdentity. + line="1375">the #SignonIdentity. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to + line="1376">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to signon_identity_query_info(). @@ -1028,9 +1244,9 @@ signon_identity_query_info(). version="2.0"> Removes the corresponding credentials record from the database. + line="1162">Removes the corresponding credentials record from the database. + line="106"/> @@ -1038,7 +1254,7 @@ signon_identity_query_info(). the #SignonIdentity. + line="1164">the #SignonIdentity. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="1165">optional #GCancellable object, %NULL to ignore. closure="2"> a callback which will be called when the operation has completed. + line="1166">a callback which will be called when the operation has completed. allow-none="1"> user data to be passed to the callback. + line="1167">user data to be passed to the callback. @@ -1076,7 +1292,7 @@ signon_identity_query_info(). c:identifier="signon_identity_remove_finish" throws="1"> + line="110"/> @@ -1094,11 +1310,11 @@ signon_identity_query_info(). version="2.0"> Asks signond to close all authentication sessions for this + line="1201">Asks signond to close all authentication sessions for this identity, and to remove any stored secrets associated with it (password and authentication tokens). + line="114"/> @@ -1106,7 +1322,7 @@ authentication tokens). the #SignonIdentity. + line="1203">the #SignonIdentity. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="1204">optional #GCancellable object, %NULL to ignore. closure="2"> a callback which will be called when the operation has completed. + line="1205">a callback which will be called when the operation has completed. allow-none="1"> user data to be passed to the callback. + line="1206">user data to be passed to the callback. @@ -1144,7 +1360,7 @@ authentication tokens). c:identifier="signon_identity_sign_out_finish" throws="1"> + line="118"/> @@ -1162,9 +1378,9 @@ authentication tokens). version="2.0"> Stores the data from @info into the identity. + line="702">Stores the data from @info into the identity. + line="80"/> @@ -1172,13 +1388,13 @@ authentication tokens). the #SignonIdentity. + line="704">the #SignonIdentity. the #SignonIdentityInfo data to store. + line="705">the #SignonIdentityInfo data to store. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="706">optional #GCancellable object, %NULL to ignore. closure="3"> a callback which will be called when the + line="707">a callback which will be called when the authentication reply is available. @@ -1208,7 +1424,7 @@ authentication reply is available. allow-none="1"> user data to be passed to the callback. + line="709">user data to be passed to the callback. @@ -1218,26 +1434,26 @@ authentication reply is available. throws="1"> Collect the result of the signon_identity_store_info() operation. + line="740">Collect the result of the signon_identity_store_info() operation. + line="85"/> %TRUE if the info has been stored, %FALSE otherwise. + line="749">%TRUE if the info has been stored, %FALSE otherwise. the #SignonIdentity. + line="742">the #SignonIdentity. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to + line="743">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to signon_identity_store_info(). @@ -1248,9 +1464,9 @@ signon_identity_store_info(). version="2.0"> Verifies the given secret. + line="905">Verifies the given secret. + line="89"/> @@ -1258,13 +1474,13 @@ signon_identity_store_info(). the #SignonIdentity. + line="907">the #SignonIdentity. the secret (password) to be verified. + line="908">the secret (password) to be verified. allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="909">optional #GCancellable object, %NULL to ignore. closure="3"> a callback which will be called when the verification is done. + line="910">a callback which will be called when the verification is done. allow-none="1"> user data to be passed to the callback. + line="911">user data to be passed to the callback. @@ -1303,26 +1519,26 @@ signon_identity_store_info(). throws="1"> Collect the result of the signon_identity_verify_secret() operation. + line="940">Collect the result of the signon_identity_verify_secret() operation. + line="94"/> %TRUE if the secret is valid, %FALSE otherwise. + line="949">%TRUE if the secret is valid, %FALSE otherwise. the #SignonIdentity. + line="942">the #SignonIdentity. A #GAsyncResult obtained from the #GAsyncReadyCallback passed to + line="943">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to signon_identity_verify_secret(). @@ -1331,13 +1547,21 @@ signon_identity_verify_secret(). + transfer-ownership="none" + getter="get_id" + default-value="0"> + + + + + + Emitted when the identity was signed out. + line="266">Emitted when the identity was signed out. @@ -1347,15 +1571,16 @@ signon_identity_verify_secret(). c:type="SignonIdentityClass" glib:is-gtype-struct-for="Identity"> Opaque struct. Use the accessor functions below. - + filename="libsignon-glib/signon-identity.h" + line="46">Opaque struct. Use the accessor functions below. + @@ -1855,6 +2080,12 @@ should remember it. + + + + glib:nick="other" + glib:name="SIGNON_IDENTITY_TYPE_OTHER"> an identity that is not an app, web or network @@ -1873,7 +2105,8 @@ should remember it. + glib:nick="app" + glib:name="SIGNON_IDENTITY_TYPE_APP"> an application identity @@ -1881,7 +2114,8 @@ should remember it. + glib:nick="web" + glib:name="SIGNON_IDENTITY_TYPE_WEB"> a web identity @@ -1889,7 +2123,8 @@ should remember it. + glib:nick="network" + glib:name="SIGNON_IDENTITY_TYPE_NETWORK"> a network server identity @@ -1987,6 +2222,7 @@ should remember it. @@ -2183,7 +2419,8 @@ should remember it. + glib:nick="default" + glib:name="SIGNON_POLICY_DEFAULT"> The plugin can decide when to show UI. @@ -2191,7 +2428,8 @@ should remember it. + glib:nick="request-password" + glib:name="SIGNON_POLICY_REQUEST_PASSWORD"> Force the user to enter the password. @@ -2199,7 +2437,8 @@ should remember it. + glib:nick="no-user-interaction" + glib:name="SIGNON_POLICY_NO_USER_INTERACTION"> No UI elements will be shown to the user. @@ -2207,7 +2446,8 @@ should remember it. + glib:nick="validation" + glib:name="SIGNON_POLICY_VALIDATION"> UI elements can be shown to the user only when @@ -2221,5 +2461,42 @@ CAPTCHA-like security measures are required. + + The #SignonAuthService is the main object in this library. + + + The #SignonAuthSession object is responsible for handling the client +authentication. #SignonAuthSession objects can be created from existing +identities (via signon_identity_create_session() or by passing a non-zero ID +to signon_auth_session_new()), in which case the authentication data such as +username and password will be implicitly taken from the identity, or they +can be created with no existing identity bound to them, in which case all +the authentication data must be filled in by the client when +signon_auth_session_process() is called. + + + An enumeration of errors that are possible from Signon. + + + The #SignonIdentity represents a database entry for a single identity. + + + Extra data retreived from a #SignonIdentity. + + + Security context information for a #SignonIdentity. + diff --git a/girs/Soup-2.4.gir b/girs/Soup-2.4.gir index 8a3e42696..a9323de6c 100644 --- a/girs/Soup-2.4.gir +++ b/girs/Soup-2.4.gir @@ -14687,7 +14687,7 @@ counterpart instead. version="2.40"> Obtains the headers for the part currently being processed. Note + line="567">Obtains the headers for the part currently being processed. Note that the #SoupMessageHeaders that are returned are owned by the #SoupMultipartInputStream and will be replaced when a call is made to soup_multipart_input_stream_next_part() or its async @@ -14701,7 +14701,7 @@ will be returned. a #SoupMessageHeaders + line="581">a #SoupMessageHeaders containing the headers for the part currently being processed or %NULL if the headers failed to parse. @@ -14710,7 +14710,7 @@ containing the headers for the part currently being processed or a #SoupMultipartInputStream. + line="569">a #SoupMultipartInputStream. @@ -14825,13 +14825,13 @@ workflow. throws="1"> Finishes an asynchronous request for the next part. + line="543">Finishes an asynchronous request for the next part. a newly created + line="551">a newly created #GInputStream for reading the next part or %NULL if there are no more parts. @@ -14840,14 +14840,14 @@ more parts. a #SoupMultipartInputStream. + line="545">a #SoupMultipartInputStream. a #GAsyncResult. + line="546">a #GAsyncResult. @@ -16119,7 +16119,7 @@ error. version="2.42"> Alias for the #SoupRequest:session property, qv. + line="305">Alias for the #SoupRequest:session property, qv. @@ -16129,7 +16129,7 @@ error. version="2.42"> Alias for the #SoupRequest:uri property, qv. + line="283">Alias for the #SoupRequest:uri property, qv. @@ -16196,14 +16196,14 @@ range", referring to the last -@start bytes of the resource body. version="2.42"> Gets the length of the data represented by @request. For most + line="367">Gets the length of the data represented by @request. For most request types, this will not be known until after you call soup_request_send() or soup_request_send_finish(). the length of the data represented by @request, + line="375">the length of the data represented by @request, or -1 if not known. @@ -16211,7 +16211,7 @@ soup_request_send() or soup_request_send_finish(). a #SoupRequest + line="369">a #SoupRequest @@ -16221,7 +16221,7 @@ soup_request_send() or soup_request_send_finish(). version="2.42"> Gets the type of the data represented by @request. For most request + line="386">Gets the type of the data represented by @request. For most request types, this will not be known until after you call soup_request_send() or soup_request_send_finish(). @@ -16231,7 +16231,7 @@ after the MIME type. the type of the data represented by + line="397">the type of the data represented by @request, or %NULL if not known. @@ -16239,7 +16239,7 @@ after the MIME type. a #SoupRequest + line="388">a #SoupRequest @@ -16247,7 +16247,7 @@ after the MIME type. Synchronously requests the URI pointed to by @request, and returns + line="197">Synchronously requests the URI pointed to by @request, and returns a #GInputStream that can be used to read its contents. Note that you cannot use this method with #SoupRequests attached to @@ -16256,7 +16256,7 @@ a #SoupSessionAsync. a #GInputStream that can be used to + line="209">a #GInputStream that can be used to read from the URI pointed to by @request. @@ -16264,7 +16264,7 @@ a #SoupSessionAsync. a #SoupRequest + line="199">a #SoupRequest allow-none="1"> a #GCancellable or %NULL + line="200">a #GCancellable or %NULL @@ -16281,7 +16281,7 @@ a #SoupSessionAsync. Begins an asynchronously request for the URI pointed to by + line="223">Begins an asynchronously request for the URI pointed to by @request. Note that you cannot use this method with #SoupRequests attached to @@ -16294,7 +16294,7 @@ a #SoupSessionSync. a #SoupRequest + line="225">a #SoupRequest allow-none="1"> a #GCancellable or %NULL + line="226">a #GCancellable or %NULL closure="2"> a #GAsyncReadyCallback + line="227">a #GAsyncReadyCallback closure="2"> user data passed to @callback + line="228">user data passed to @callback @@ -16335,12 +16335,12 @@ a #SoupSessionSync. throws="1"> Gets the result of a soup_request_send_async(). + line="248">Gets the result of a soup_request_send_async(). a #GInputStream that can be used to + line="256">a #GInputStream that can be used to read from the URI pointed to by @request. @@ -16348,13 +16348,13 @@ a #SoupSessionSync. a #SoupRequest + line="250">a #SoupRequest the #GAsyncResult + line="251">the #GAsyncResult @@ -16364,14 +16364,14 @@ a #SoupSessionSync. version="2.42"> Gets the length of the data represented by @request. For most + line="367">Gets the length of the data represented by @request. For most request types, this will not be known until after you call soup_request_send() or soup_request_send_finish(). the length of the data represented by @request, + line="375">the length of the data represented by @request, or -1 if not known. @@ -16379,7 +16379,7 @@ soup_request_send() or soup_request_send_finish(). a #SoupRequest + line="369">a #SoupRequest @@ -16389,7 +16389,7 @@ soup_request_send() or soup_request_send_finish(). version="2.42"> Gets the type of the data represented by @request. For most request + line="386">Gets the type of the data represented by @request. For most request types, this will not be known until after you call soup_request_send() or soup_request_send_finish(). @@ -16399,7 +16399,7 @@ after the MIME type. the type of the data represented by + line="397">the type of the data represented by @request, or %NULL if not known. @@ -16407,7 +16407,7 @@ after the MIME type. a #SoupRequest + line="388">a #SoupRequest @@ -16418,19 +16418,19 @@ after the MIME type. version="2.42"> Gets @request's #SoupSession + line="351">Gets @request's #SoupSession @request's #SoupSession + line="357">@request's #SoupSession a #SoupRequest + line="353">a #SoupRequest @@ -16441,19 +16441,19 @@ after the MIME type. version="2.42"> Gets @request's URI + line="335">Gets @request's URI @request's URI + line="341">@request's URI a #SoupRequest + line="337">a #SoupRequest @@ -16464,7 +16464,7 @@ after the MIME type. throws="1"> Synchronously requests the URI pointed to by @request, and returns + line="197">Synchronously requests the URI pointed to by @request, and returns a #GInputStream that can be used to read its contents. Note that you cannot use this method with #SoupRequests attached to @@ -16473,7 +16473,7 @@ a #SoupSessionAsync. a #GInputStream that can be used to + line="209">a #GInputStream that can be used to read from the URI pointed to by @request. @@ -16481,7 +16481,7 @@ a #SoupSessionAsync. a #SoupRequest + line="199">a #SoupRequest allow-none="1"> a #GCancellable or %NULL + line="200">a #GCancellable or %NULL @@ -16500,7 +16500,7 @@ a #SoupSessionAsync. version="2.42"> Begins an asynchronously request for the URI pointed to by + line="223">Begins an asynchronously request for the URI pointed to by @request. Note that you cannot use this method with #SoupRequests attached to @@ -16513,7 +16513,7 @@ a #SoupSessionSync. a #SoupRequest + line="225">a #SoupRequest allow-none="1"> a #GCancellable or %NULL + line="226">a #GCancellable or %NULL closure="2"> a #GAsyncReadyCallback + line="227">a #GAsyncReadyCallback allow-none="1"> user data passed to @callback + line="228">user data passed to @callback @@ -16553,12 +16553,12 @@ a #SoupSessionSync. throws="1"> Gets the result of a soup_request_send_async(). + line="248">Gets the result of a soup_request_send_async(). a #GInputStream that can be used to + line="256">a #GInputStream that can be used to read from the URI pointed to by @request. @@ -16566,13 +16566,13 @@ a #SoupSessionSync. a #SoupRequest + line="250">a #SoupRequest the #GAsyncResult + line="251">the #GAsyncResult @@ -16585,7 +16585,7 @@ a #SoupSessionSync. getter="get_session"> The request's #SoupSession. + line="312">The request's #SoupSession. getter="get_uri"> The request URI. + line="290">The request URI. @@ -16638,7 +16638,7 @@ a #SoupSessionSync. a #GInputStream that can be used to + line="209">a #GInputStream that can be used to read from the URI pointed to by @request. @@ -16646,7 +16646,7 @@ a #SoupSessionSync. a #SoupRequest + line="199">a #SoupRequest allow-none="1"> a #GCancellable or %NULL + line="200">a #GCancellable or %NULL @@ -16671,7 +16671,7 @@ a #SoupSessionSync. a #SoupRequest + line="225">a #SoupRequest allow-none="1"> a #GCancellable or %NULL + line="226">a #GCancellable or %NULL closure="3"> a #GAsyncReadyCallback + line="227">a #GAsyncReadyCallback @@ -16702,7 +16702,7 @@ a #SoupSessionSync. closure="3"> user data passed to @callback + line="228">user data passed to @callback @@ -16714,7 +16714,7 @@ a #SoupSessionSync. a #GInputStream that can be used to + line="256">a #GInputStream that can be used to read from the URI pointed to by @request. @@ -16722,13 +16722,13 @@ a #SoupSessionSync. a #SoupRequest + line="250">a #SoupRequest the #GAsyncResult + line="251">the #GAsyncResult @@ -16740,7 +16740,7 @@ a #SoupSessionSync. the length of the data represented by @request, + line="375">the length of the data represented by @request, or -1 if not known. @@ -16748,7 +16748,7 @@ a #SoupSessionSync. a #SoupRequest + line="369">a #SoupRequest @@ -16760,7 +16760,7 @@ a #SoupSessionSync. the type of the data represented by + line="397">the type of the data represented by @request, or %NULL if not known. @@ -16768,7 +16768,7 @@ a #SoupSessionSync. a #SoupRequest + line="388">a #SoupRequest @@ -16813,7 +16813,7 @@ a #SoupSessionSync. glib:error-domain="soup_request_error_quark"> A #SoupRequest error. + line="4730">A #SoupRequest error. glib:name="SOUP_REQUEST_ERROR_BAD_URI"> the URI could not be parsed + line="4732">the URI could not be parsed glib:name="SOUP_REQUEST_ERROR_UNSUPPORTED_URI_SCHEME"> the URI scheme is not + line="4733">the URI scheme is not supported by this #SoupSession glib:name="SOUP_REQUEST_ERROR_PARSING"> the server's response could not + line="4735">the server's response could not be parsed glib:name="SOUP_REQUEST_ERROR_ENCODING"> the server's response was in an + line="4737">the server's response was in an unsupported format @@ -16873,19 +16873,19 @@ a #SoupSessionSync. version="2.40"> Gets a #GFile corresponding to @file's URI + line="368">Gets a #GFile corresponding to @file's URI a #GFile corresponding to @file + line="374">a #GFile corresponding to @file a #SoupRequestFile + line="370">a #SoupRequestFile @@ -16925,19 +16925,19 @@ a #SoupSessionSync. version="2.40"> Gets a new reference to the #SoupMessage associated to this SoupRequest + line="218">Gets a new reference to the #SoupMessage associated to this SoupRequest a new reference to the #SoupMessage + line="224">a new reference to the #SoupMessage a #SoupRequestHTTP object + line="220">a #SoupRequestHTTP object @@ -20084,7 +20084,7 @@ returning to the main loop. version="2.62"> Start a connection to @uri. The operation can be monitored by providing a @progress_callback + line="5073">Start a connection to @uri. The operation can be monitored by providing a @progress_callback and finishes when the connection is done or an error ocurred. Call soup_session_connect_finish() to get the #GIOStream to communicate with the server. @@ -20096,13 +20096,13 @@ Call soup_session_connect_finish() to get the #GIOStream to communicate with the a #SoupSession + line="5075">a #SoupSession a #SoupURI to connect to + line="5076">a #SoupURI to connect to a #GCancellable + line="5077">a #GCancellable a #SoupSessionConnectProgressCallback which + line="5078">a #SoupSessionConnectProgressCallback which will be called for every network event that occurs during the connection. @@ -20134,7 +20134,7 @@ will be called for every network event that occurs during the connection. closure="4"> the callback to invoke when the operation finishes + line="5080">the callback to invoke when the operation finishes allow-none="1"> data for @progress_callback and @callback + line="5081">data for @progress_callback and @callback @@ -20154,25 +20154,25 @@ will be called for every network event that occurs during the connection. throws="1"> Gets the #GIOStream created for the connection to communicate with the server. + line="5132">Gets the #GIOStream created for the connection to communicate with the server. a new #GIOStream, or %NULL on error. + line="5140">a new #GIOStream, or %NULL on error. a #SoupSession + line="5134">a #SoupSession the #GAsyncResult passed to your callback + line="5135">the #GAsyncResult passed to your callback @@ -20624,12 +20624,12 @@ from the session at construct time by using the throws="1"> Creates a #SoupRequest for retrieving @uri_string. + line="4563">Creates a #SoupRequest for retrieving @uri_string. a new #SoupRequest, or + line="4571">a new #SoupRequest, or %NULL on error. @@ -20637,13 +20637,13 @@ from the session at construct time by using the a #SoupSession + line="4565">a #SoupSession a URI, in string form + line="4566">a URI, in string form @@ -20654,14 +20654,14 @@ from the session at construct time by using the throws="1"> Creates a #SoupRequest for retrieving @uri_string, which must be an + line="4660">Creates a #SoupRequest for retrieving @uri_string, which must be an "http" or "https" URI (or another protocol listed in @session's #SoupSession:http-aliases or #SoupSession:https-aliases). a new #SoupRequestHTTP, or + line="4671">a new #SoupRequestHTTP, or %NULL on error. @@ -20669,19 +20669,19 @@ from the session at construct time by using the a #SoupSession + line="4662">a #SoupSession an HTTP method + line="4663">an HTTP method a URI, in string form + line="4664">a URI, in string form @@ -20692,14 +20692,14 @@ from the session at construct time by using the throws="1"> Creates a #SoupRequest for retrieving @uri, which must be an + line="4691">Creates a #SoupRequest for retrieving @uri, which must be an "http" or "https" URI (or another protocol listed in @session's #SoupSession:http-aliases or #SoupSession:https-aliases). a new #SoupRequestHTTP, or + line="4702">a new #SoupRequestHTTP, or %NULL on error. @@ -20707,19 +20707,19 @@ from the session at construct time by using the a #SoupSession + line="4693">a #SoupSession an HTTP method + line="4694">an HTTP method a #SoupURI representing the URI to retrieve + line="4695">a #SoupURI representing the URI to retrieve @@ -20730,12 +20730,12 @@ from the session at construct time by using the throws="1"> Creates a #SoupRequest for retrieving @uri. + line="4596">Creates a #SoupRequest for retrieving @uri. a new #SoupRequest, or + line="4604">a new #SoupRequest, or %NULL on error. @@ -20743,13 +20743,13 @@ from the session at construct time by using the a #SoupSession + line="4598">a #SoupSession a #SoupURI representing the URI to retrieve + line="4599">a #SoupURI representing the URI to retrieve @@ -20785,7 +20785,7 @@ again. throws="1"> Synchronously sends @msg and waits for the beginning of a response. + line="4416">Synchronously sends @msg and waits for the beginning of a response. On success, a #GInputStream will be returned which you can use to read the response body. ("Success" here means only that an HTTP response was received and understood; it does not necessarily mean @@ -20814,7 +20814,7 @@ response has been completely read. a #GInputStream for reading the + line="4449">a #GInputStream for reading the response body, or %NULL on error. @@ -20822,13 +20822,13 @@ response has been completely read. a #SoupSession + line="4418">a #SoupSession a #SoupMessage + line="4419">a #SoupMessage a #GCancellable + line="4420">a #GCancellable @@ -20917,14 +20917,14 @@ callback until the response has been completely read. throws="1"> Gets the response to a soup_session_send_async() call and (if + line="4374">Gets the response to a soup_session_send_async() call and (if successful), returns a #GInputStream that can be used to read the response body. a #GInputStream for reading the + line="4384">a #GInputStream for reading the response body, or %NULL on error. @@ -20932,13 +20932,13 @@ response body. a #SoupSession + line="4376">a #SoupSession the #GAsyncResult passed to your callback + line="4377">the #GAsyncResult passed to your callback @@ -20989,7 +20989,7 @@ response body, and allows you to read the response via a version="2.50"> "Steals" the HTTP connection associated with @msg from @session. + line="4790">"Steals" the HTTP connection associated with @msg from @session. This happens immediately, regardless of the current state of the connection, and @msg's callback will not be called. You can steal the connection from a #SoupMessage signal handler if you need to @@ -21001,7 +21001,7 @@ holding any other reference to it. the #GIOStream formerly associated + line="4804">the #GIOStream formerly associated with @msg (or %NULL if @msg was no longer associated with a connection). No guarantees are made about what kind of #GIOStream is returned. @@ -21011,13 +21011,13 @@ holding any other reference to it. a #SoupSession + line="4792">a #SoupSession the message whose connection is to be stolen + line="4793">the message whose connection is to be stolen @@ -21059,7 +21059,7 @@ This may only be called for asynchronous messages (those sent on a version="2.50"> Asynchronously creates a #SoupWebsocketConnection to communicate + line="4900">Asynchronously creates a #SoupWebsocketConnection to communicate with a remote server. All necessary WebSocket-related headers will be added to @msg, and @@ -21085,13 +21085,13 @@ soup_session_websocket_connect_finish() will return a #SoupSession + line="4902">a #SoupSession #SoupMessage indicating the WebSocket server to connect to + line="4903">#SoupMessage indicating the WebSocket server to connect to origin of the connection + line="4904">origin of the connection a + line="4905">a %NULL-terminated array of protocols supported @@ -21121,7 +21121,7 @@ soup_session_websocket_connect_finish() will return allow-none="1"> a #GCancellable + line="4907">a #GCancellable the callback to invoke + line="4908">the callback to invoke data for @callback + line="4909">data for @callback @@ -21152,7 +21152,7 @@ soup_session_websocket_connect_finish() will return throws="1"> Gets the #SoupWebsocketConnection response to a + line="4974">Gets the #SoupWebsocketConnection response to a soup_session_websocket_connect_async() call and (if successful), returns a #SoupWebsocketConnection that can be used to communicate with the server. @@ -21160,7 +21160,7 @@ with the server. a new #SoupWebsocketConnection, or + line="4985">a new #SoupWebsocketConnection, or %NULL on error. @@ -21168,13 +21168,13 @@ with the server. a #SoupSession + line="4976">a #SoupSession the #GAsyncResult passed to your callback + line="4977">the #GAsyncResult passed to your callback @@ -22163,7 +22163,7 @@ be called after the message completes or when an unrecoverable error occurs. Prototype for the progress callback passed to soup_session_connect_async(). + line="5001">Prototype for the progress callback passed to soup_session_connect_async(). @@ -22172,19 +22172,19 @@ be called after the message completes or when an unrecoverable error occurs. the #SoupSession + line="5003">the #SoupSession a #GSocketClientEvent + line="5004">a #GSocketClientEvent the current state of the network connection + line="5005">the current state of the network connection the data passed to soup_session_connect_async(). + line="5006">the data passed to soup_session_connect_async(). @@ -22874,7 +22874,7 @@ linkend="libsoup-session-porting">porting guide</link>. Begins asynchronously connecting to @sock's remote address. The + line="1017">Begins asynchronously connecting to @sock's remote address. The socket will call @callback when it succeeds or fails (but not before returning from this function). @@ -22889,7 +22889,7 @@ status of %SOUP_STATUS_CANCELLED. a client #SoupSocket (which must not already be connected) + line="1019">a client #SoupSocket (which must not already be connected) allow-none="1"> a #GCancellable, or %NULL + line="1020">a #GCancellable, or %NULL closure="2"> callback to call after connecting + line="1021">callback to call after connecting allow-none="1"> data to pass to @callback + line="1022">data to pass to @callback @@ -22924,7 +22924,7 @@ status of %SOUP_STATUS_CANCELLED. Attempt to synchronously connect @sock to its remote address. + line="1087">Attempt to synchronously connect @sock to its remote address. If @cancellable is non-%NULL, it can be used to cancel the connection, in which case soup_socket_connect_sync() will return @@ -22933,14 +22933,14 @@ connection, in which case soup_socket_connect_sync() will return a success or failure code. + line="1098">a success or failure code. a client #SoupSocket (which must not already be connected) + line="1089">a client #SoupSocket (which must not already be connected) a #GCancellable, or %NULL + line="1090">a #GCancellable, or %NULL @@ -22957,7 +22957,7 @@ connection, in which case soup_socket_connect_sync() will return Disconnects @sock. Any further read or write attempts on it will + line="1578">Disconnects @sock. Any further read or write attempts on it will fail. @@ -22967,7 +22967,7 @@ fail. a #SoupSocket + line="1580">a #SoupSocket @@ -22977,7 +22977,7 @@ fail. glib:get-property="fd"> Gets @sock's underlying file descriptor. + line="1118">Gets @sock's underlying file descriptor. Note that fiddling with the file descriptor may break the #SoupSocket. @@ -22985,14 +22985,14 @@ Note that fiddling with the file descriptor may break the @sock's file descriptor. + line="1127">@sock's file descriptor. a #SoupSocket + line="1120">a #SoupSocket @@ -23002,7 +23002,7 @@ Note that fiddling with the file descriptor may break the glib:get-property="local-address"> Returns the #SoupAddress corresponding to the local end of @sock. + line="1654">Returns the #SoupAddress corresponding to the local end of @sock. Calling this method on an unconnected socket is considered to be an error, and produces undefined results. @@ -23010,14 +23010,14 @@ an error, and produces undefined results. the #SoupAddress + line="1663">the #SoupAddress a #SoupSocket + line="1656">a #SoupSocket @@ -23027,7 +23027,7 @@ an error, and produces undefined results. glib:get-property="remote-address"> Returns the #SoupAddress corresponding to the remote end of @sock. + line="1702">Returns the #SoupAddress corresponding to the remote end of @sock. Calling this method on an unconnected socket is considered to be an error, and produces undefined results. @@ -23035,14 +23035,14 @@ an error, and produces undefined results. the #SoupAddress + line="1711">the #SoupAddress a #SoupSocket + line="1704">a #SoupSocket @@ -23050,19 +23050,19 @@ an error, and produces undefined results. Tests if @sock is connected to another host + line="1635">Tests if @sock is connected to another host %TRUE or %FALSE. + line="1641">%TRUE or %FALSE. a #SoupSocket + line="1637">a #SoupSocket @@ -23070,19 +23070,19 @@ an error, and produces undefined results. Tests if @sock is doing (or has attempted to do) SSL. + line="1562">Tests if @sock is doing (or has attempted to do) SSL. %TRUE if @sock has SSL credentials set + line="1568">%TRUE if @sock has SSL credentials set a #SoupSocket + line="1564">a #SoupSocket @@ -23090,20 +23090,20 @@ an error, and produces undefined results. Makes @sock start listening on its local address. When connections + line="1262">Makes @sock start listening on its local address. When connections come in, @sock will emit #SoupSocket::new_connection. whether or not @sock is now listening. + line="1270">whether or not @sock is now listening. a server #SoupSocket (which must not already be connected or + line="1264">a server #SoupSocket (which must not already be connected or listening) @@ -23112,7 +23112,7 @@ listening) Attempts to read up to @len bytes from @sock into @buffer. If some + line="1827">Attempts to read up to @len bytes from @sock into @buffer. If some data is successfully read, soup_socket_read() will return %SOUP_SOCKET_OK, and *@nread will contain the number of bytes actually read (which may be less than @len). @@ -23128,7 +23128,7 @@ emitted once. See the documentation for #SoupSocket:non-blocking.) a #SoupSocketIOStatus, as described above (or + line="1850">a #SoupSocketIOStatus, as described above (or %SOUP_SOCKET_EOF if the socket is no longer connected, or %SOUP_SOCKET_ERROR on any other error, in which case @error will also be set). @@ -23138,13 +23138,13 @@ also be set). the socket + line="1829">the socket buffer to read + line="1830">buffer to read into @@ -23153,7 +23153,7 @@ also be set). size of @buffer in bytes + line="1832">size of @buffer in bytes transfer-ownership="full"> on return, the number of bytes read into @buffer + line="1833">on return, the number of bytes read into @buffer allow-none="1"> a #GCancellable, or %NULL + line="1834">a #GCancellable, or %NULL @@ -23181,7 +23181,7 @@ also be set). throws="1"> Like soup_socket_read(), but reads no further than the first + line="1893">Like soup_socket_read(), but reads no further than the first occurrence of @boundary. (If the boundary is found, it will be included in the returned data, and *@got_boundary will be set to %TRUE.) Any data after the boundary will returned in future reads. @@ -23197,20 +23197,20 @@ longer than @boundary_len if you want to make any progress at all. as for soup_socket_read() + line="1920">as for soup_socket_read() the socket + line="1895">the socket buffer to read + line="1896">buffer to read into @@ -23219,7 +23219,7 @@ longer than @boundary_len if you want to make any progress at all. size of @buffer in bytes + line="1898">size of @buffer in bytes allow-none="1"> boundary to read until + line="1899">boundary to read until length of @boundary in bytes + line="1900">length of @boundary in bytes transfer-ownership="full"> on return, the number of bytes read into @buffer + line="1901">on return, the number of bytes read into @buffer transfer-ownership="full"> on return, whether or not the data in @buffer + line="1902">on return, whether or not the data in @buffer ends with the boundary string @@ -23262,7 +23262,7 @@ ends with the boundary string allow-none="1"> a #GCancellable, or %NULL + line="1904">a #GCancellable, or %NULL @@ -23271,26 +23271,26 @@ ends with the boundary string c:identifier="soup_socket_start_proxy_ssl"> Starts using SSL on @socket, expecting to find a host named + line="1470">Starts using SSL on @socket, expecting to find a host named @ssl_host. success or failure + line="1479">success or failure the socket + line="1472">the socket hostname of the SSL server + line="1473">hostname of the SSL server allow-none="1"> a #GCancellable + line="1474">a #GCancellable @@ -23307,19 +23307,19 @@ ends with the boundary string Starts using SSL on @socket. + line="1452">Starts using SSL on @socket. success or failure + line="1459">success or failure the socket + line="1454">the socket allow-none="1"> a #GCancellable + line="1455">a #GCancellable @@ -23336,7 +23336,7 @@ ends with the boundary string Attempts to write @len bytes from @buffer to @sock. If some data is + line="1970">Attempts to write @len bytes from @buffer to @sock. If some data is successfully written, the return status will be %SOUP_SOCKET_OK, and *@nwrote will contain the number of bytes actually written (which may be less than @len). @@ -23352,7 +23352,7 @@ and it is only emitted once. See the documentation for a #SoupSocketIOStatus, as described above (or + line="1992">a #SoupSocketIOStatus, as described above (or %SOUP_SOCKET_EOF or %SOUP_SOCKET_ERROR. @error will be set if the return value is %SOUP_SOCKET_ERROR.) @@ -23361,13 +23361,13 @@ return value is %SOUP_SOCKET_ERROR.) the socket + line="1972">the socket data to write + line="1973">data to write @@ -23375,7 +23375,7 @@ return value is %SOUP_SOCKET_ERROR.) size of @buffer, in bytes + line="1974">size of @buffer, in bytes transfer-ownership="full"> on return, number of bytes written + line="1975">on return, number of bytes written allow-none="1"> a #GCancellable, or %NULL + line="1976">a #GCancellable, or %NULL @@ -23620,7 +23620,7 @@ soup_socket_write() and #SoupSocket:non-blocking. The callback function passed to soup_socket_connect_async(). + line="982">The callback function passed to soup_socket_connect_async(). @@ -23629,13 +23629,13 @@ soup_socket_write() and #SoupSocket:non-blocking. the #SoupSocket + line="984">the #SoupSocket an HTTP status code indicating success or failure + line="985">an HTTP status code indicating success or failure closure="2"> the data passed to soup_socket_connect_async() + line="986">the data passed to soup_socket_connect_async() @@ -23751,7 +23751,7 @@ soup_socket_write() and #SoupSocket:non-blocking. c:type="SoupSocketIOStatus"> Return value from the #SoupSocket IO methods. + line="1817">Return value from the #SoupSocket IO methods. glib:name="SOUP_SOCKET_OK"> Success + line="1819">Success glib:name="SOUP_SOCKET_WOULD_BLOCK"> Cannot read/write any more at this time + line="1820">Cannot read/write any more at this time glib:name="SOUP_SOCKET_EOF"> End of file + line="1821">End of file glib:name="SOUP_SOCKET_ERROR"> Other error + line="1822">Other error version="2.50"> Creates a #SoupWebsocketConnection on @stream. This should be + line="1731">Creates a #SoupWebsocketConnection on @stream. This should be called after completing the handshake to begin using the WebSocket protocol. a new #SoupWebsocketConnection + line="1743">a new #SoupWebsocketConnection a #GIOStream connected to the WebSocket server + line="1733">a #GIOStream connected to the WebSocket server the URI of the connection + line="1734">the URI of the connection the type of connection (client/side) + line="1735">the type of connection (client/side) @@ -25818,7 +25818,7 @@ protocol. allow-none="1"> the Origin of the client + line="1736">the Origin of the client allow-none="1"> the subprotocol in use + line="1737">the subprotocol in use @@ -25837,7 +25837,7 @@ protocol. version="2.68"> Creates a #SoupWebsocketConnection on @stream with the given active @extensions. + line="1757">Creates a #SoupWebsocketConnection on @stream with the given active @extensions. This should be called after completing the handshake to begin using the WebSocket protocol. a new #SoupWebsocketConnection + line="1770">a new #SoupWebsocketConnection a #GIOStream connected to the WebSocket server + line="1759">a #GIOStream connected to the WebSocket server the URI of the connection + line="1760">the URI of the connection the type of connection (client/side) + line="1761">the type of connection (client/side) @@ -25874,7 +25874,7 @@ protocol. allow-none="1"> the Origin of the client + line="1762">the Origin of the client allow-none="1"> the subprotocol in use + line="1763">the subprotocol in use a #GList of #SoupWebsocketExtension objects + line="1764">a #GList of #SoupWebsocketExtension objects @@ -25978,7 +25978,7 @@ protocol. version="2.50"> Close the connection in an orderly fashion. + line="2062">Close the connection in an orderly fashion. Note that until the #SoupWebsocketConnection::closed signal fires, the connection is not yet completely closed. The close message is not even sent until the @@ -25997,14 +25997,14 @@ Note that the @data must be UTF-8 valid. the WebSocket + line="2064">the WebSocket close code + line="2065">close code allow-none="1"> close data + line="2066">close data @@ -26023,7 +26023,7 @@ Note that the @data must be UTF-8 valid. version="2.50"> Get the close code received from the WebSocket peer. + line="1930">Get the close code received from the WebSocket peer. This only becomes valid once the WebSocket is in the %SOUP_WEBSOCKET_STATE_CLOSED state. The value will often be in the @@ -26034,14 +26034,14 @@ defined close code. the close code or zero. + line="1941">the close code or zero. the WebSocket + line="1932">the WebSocket @@ -26052,7 +26052,7 @@ defined close code. version="2.50"> Get the close data received from the WebSocket peer. + line="1953">Get the close data received from the WebSocket peer. This only becomes valid once the WebSocket is in the %SOUP_WEBSOCKET_STATE_CLOSED state. The data may be freed once @@ -26062,14 +26062,14 @@ the main loop is run, so copy it if you need to keep it around. the close data or %NULL + line="1963">the close data or %NULL the WebSocket + line="1955">the WebSocket @@ -26081,13 +26081,13 @@ the main loop is run, so copy it if you need to keep it around. version="2.50"> Get the connection type (client/server) of the connection. + line="1814">Get the connection type (client/server) of the connection. the connection type + line="1820">the connection type @@ -26095,7 +26095,7 @@ the main loop is run, so copy it if you need to keep it around. the WebSocket + line="1816">the WebSocket @@ -26107,13 +26107,13 @@ the main loop is run, so copy it if you need to keep it around. version="2.68"> Get the extensions chosen via negotiation with the peer. + line="1889">Get the extensions chosen via negotiation with the peer. a #GList of #SoupWebsocketExtension objects + line="1895">a #GList of #SoupWebsocketExtension objects @@ -26122,7 +26122,7 @@ the main loop is run, so copy it if you need to keep it around. the WebSocket + line="1891">the WebSocket @@ -26134,20 +26134,20 @@ the main loop is run, so copy it if you need to keep it around. version="2.50"> Get the I/O stream the WebSocket is communicating over. + line="1796">Get the I/O stream the WebSocket is communicating over. the WebSocket's I/O stream. + line="1802">the WebSocket's I/O stream. the WebSocket + line="1798">the WebSocket @@ -26159,20 +26159,20 @@ the main loop is run, so copy it if you need to keep it around. version="2.58"> Gets the keepalive interval in seconds or 0 if disabled. + line="2148">Gets the keepalive interval in seconds or 0 if disabled. the keepalive interval. + line="2154">the keepalive interval. the WebSocket + line="2150">the WebSocket @@ -26184,20 +26184,20 @@ the main loop is run, so copy it if you need to keep it around. version="2.56"> Gets the maximum payload size allowed for incoming packets. + line="2102">Gets the maximum payload size allowed for incoming packets. the maximum payload size. + line="2108">the maximum payload size. the WebSocket + line="2104">the WebSocket @@ -26209,20 +26209,20 @@ the main loop is run, so copy it if you need to keep it around. version="2.50"> Get the origin of the WebSocket. + line="1853">Get the origin of the WebSocket. the origin, or %NULL + line="1859">the origin, or %NULL the WebSocket + line="1855">the WebSocket @@ -26234,20 +26234,20 @@ the main loop is run, so copy it if you need to keep it around. version="2.50"> Get the protocol chosen via negotiation with the peer. + line="1871">Get the protocol chosen via negotiation with the peer. the chosen protocol, or %NULL + line="1877">the chosen protocol, or %NULL the WebSocket + line="1873">the WebSocket @@ -26259,20 +26259,20 @@ the main loop is run, so copy it if you need to keep it around. version="2.50"> Get the current state of the WebSocket. + line="1907">Get the current state of the WebSocket. the state + line="1913">the state the WebSocket + line="1909">the WebSocket @@ -26284,7 +26284,7 @@ the main loop is run, so copy it if you need to keep it around. version="2.50"> Get the URI of the WebSocket. + line="1832">Get the URI of the WebSocket. For servers this represents the address of the WebSocket, and for clients it is the address connected to. @@ -26293,14 +26293,14 @@ for clients it is the address connected to. the URI + line="1841">the URI the WebSocket + line="1834">the WebSocket @@ -26311,7 +26311,7 @@ for clients it is the address connected to. version="2.50"> Send a binary message to the peer. If @length is 0, @data may be %NULL. + line="2005">Send a binary message to the peer. If @length is 0, @data may be %NULL. The message is queued to be sent and will be sent when the main loop is run. @@ -26324,7 +26324,7 @@ is run. the WebSocket + line="2007">the WebSocket @@ -26334,7 +26334,7 @@ is run. allow-none="1"> the message contents + line="2008">the message contents @@ -26342,7 +26342,7 @@ is run. the length of @data + line="2009">the length of @data @@ -26352,7 +26352,7 @@ is run. version="2.68"> Send a message of the given @type to the peer. Note that this method, + line="2030">Send a message of the given @type to the peer. Note that this method, allows to send text messages containing %NULL characters. The message is queued to be sent and will be sent when the main loop @@ -26366,20 +26366,20 @@ is run. the WebSocket + line="2032">the WebSocket the type of message contents + line="2033">the type of message contents the message data as #GBytes + line="2034">the message data as #GBytes @@ -26389,7 +26389,7 @@ is run. version="2.50"> Send a %NULL-terminated text (UTF-8) message to the peer. If you need + line="1975">Send a %NULL-terminated text (UTF-8) message to the peer. If you need to send text messages containing %NULL characters use soup_websocket_connection_send_message() instead. @@ -26404,14 +26404,14 @@ is run. the WebSocket + line="1977">the WebSocket the message contents + line="1978">the message contents @@ -26422,7 +26422,7 @@ is run. version="2.58"> Sets the interval in seconds on when to send a ping message which will serve + line="2183">Sets the interval in seconds on when to send a ping message which will serve as a keepalive message. If set to 0 the keepalive message is disabled. @@ -26433,14 +26433,14 @@ as a keepalive message. If set to 0 the keepalive message is disabled. the WebSocket + line="2185">the WebSocket the interval to send a ping message or 0 to disable it + line="2186">the interval to send a ping message or 0 to disable it @@ -26451,7 +26451,7 @@ as a keepalive message. If set to 0 the keepalive message is disabled. version="2.56"> Sets the maximum payload size allowed for incoming packets. It + line="2123">Sets the maximum payload size allowed for incoming packets. It does not limit the outgoing packet size. @@ -26462,7 +26462,7 @@ does not limit the outgoing packet size. the WebSocket + line="2125">the WebSocket @@ -26470,7 +26470,7 @@ does not limit the outgoing packet size. transfer-ownership="none"> the maximum payload size + line="2126">the maximum payload size @@ -26484,7 +26484,7 @@ does not limit the outgoing packet size. default-value="SOUP_WEBSOCKET_CONNECTION_UNKNOWN"> The type of connection (client/server). + line="1496">The type of connection (client/server). getter="get_extensions"> List of #SoupWebsocketExtension objects that are active in the connection. + line="1620">List of #SoupWebsocketExtension objects that are active in the connection. getter="get_io_stream"> The underlying IO stream the WebSocket is communicating + line="1477">The underlying IO stream the WebSocket is communicating over. The input and output streams must be pollable streams. @@ -26522,7 +26522,7 @@ The input and output streams must be pollable streams. default-value="0"> Interval in seconds on when to send a ping message which will + line="1600">Interval in seconds on when to send a ping message which will serve as a keepalive message. If set to 0 the keepalive message is disabled. @@ -26537,7 +26537,7 @@ disabled. default-value="131072"> The maximum payload size for incoming packets the protocol expects + line="1581">The maximum payload size for incoming packets the protocol expects or 0 to not limit it. @@ -26550,7 +26550,7 @@ or 0 to not limit it. default-value="NULL"> The client's Origin. + line="1532">The client's Origin. default-value="NULL"> The chosen protocol, or %NULL if a protocol was not agreed + line="1548">The chosen protocol, or %NULL if a protocol was not agreed upon. @@ -26573,7 +26573,7 @@ upon. default-value="SOUP_WEBSOCKET_STATE_OPEN"> The current state of the WebSocket. + line="1565">The current state of the WebSocket. getter="get_uri"> The URI of the WebSocket. + line="1513">The URI of the WebSocket. For servers this represents the address of the WebSocket, and for clients it is the address connected to. @@ -26600,7 +26600,7 @@ and for clients it is the address connected to. Emitted when the connection has completely closed, either + line="1689">Emitted when the connection has completely closed, either due to an orderly close from the peer, one initiated via soup_websocket_connection_close() or a fatal error condition that caused a close. @@ -26613,7 +26613,7 @@ This signal will be emitted once. This signal will be emitted during an orderly close. + line="1674">This signal will be emitted during an orderly close. @@ -26621,7 +26621,7 @@ This signal will be emitted once. Emitted when an error occurred on the WebSocket. This may + line="1656">Emitted when an error occurred on the WebSocket. This may be fired multiple times. Fatal errors will be followed by the #SoupWebsocketConnection::closed signal being emitted. @@ -26631,7 +26631,7 @@ the #SoupWebsocketConnection::closed signal being emitted. the error that occured + line="1659">the error that occured @@ -26639,7 +26639,7 @@ the #SoupWebsocketConnection::closed signal being emitted. Emitted when we receive a message from the peer. + line="1635">Emitted when we receive a message from the peer. As a convenience, the @message data will always be NUL-terminated, but the NUL byte will not be included in @@ -26651,13 +26651,13 @@ the length count. the type of message contents + line="1638">the type of message contents the message data + line="1639">the message data @@ -26665,7 +26665,7 @@ the length count. Emitted when we receive a Pong frame (solicited or + line="1709">Emitted when we receive a Pong frame (solicited or unsolicited) from the peer. As a convenience, the @message data will always be @@ -26678,7 +26678,7 @@ the length count. the application data (if any) + line="1712">the application data (if any) @@ -27594,7 +27594,7 @@ Extensions using reserved bits of the header will change them in @header. c:type="SoupXMLRPCFault"> Pre-defined XML-RPC fault codes from <ulink + line="1449">Pre-defined XML-RPC fault codes from <ulink url="http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php">http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php</ulink>. These are an extension, not part of the XML-RPC spec; you can't assume servers will use them. @@ -27605,7 +27605,7 @@ assume servers will use them. glib:name="SOUP_XMLRPC_FAULT_PARSE_ERROR_NOT_WELL_FORMED"> request was not + line="1451">request was not well-formed glib:name="SOUP_XMLRPC_FAULT_PARSE_ERROR_UNSUPPORTED_ENCODING"> request was in + line="1453">request was in an unsupported encoding glib:name="SOUP_XMLRPC_FAULT_PARSE_ERROR_INVALID_CHARACTER_FOR_ENCODING"> request contained an invalid character + line="1455">request contained an invalid character glib:name="SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_XML_RPC"> request was not + line="1457">request was not valid XML-RPC glib:name="SOUP_XMLRPC_FAULT_SERVER_ERROR_REQUESTED_METHOD_NOT_FOUND"> method + line="1459">method not found glib:name="SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_METHOD_PARAMETERS"> invalid + line="1461">invalid parameters glib:name="SOUP_XMLRPC_FAULT_SERVER_ERROR_INTERNAL_XML_RPC_ERROR"> internal + line="1463">internal error glib:name="SOUP_XMLRPC_FAULT_APPLICATION_ERROR"> start of reserved range for + line="1465">start of reserved range for application error codes glib:name="SOUP_XMLRPC_FAULT_SYSTEM_ERROR"> start of reserved range for + line="1467">start of reserved range for system error codes glib:name="SOUP_XMLRPC_FAULT_TRANSPORT_ERROR"> start of reserved range for + line="1469">start of reserved range for transport error codes @@ -27711,7 +27711,7 @@ assume servers will use them. version="2.52"> Opaque structure containing XML-RPC methodCall parameter values. + line="1081">Opaque structure containing XML-RPC methodCall parameter values. Can be parsed using soup_xmlrpc_params_parse() and freed with soup_xmlrpc_params_free(). @@ -27720,7 +27720,7 @@ soup_xmlrpc_params_free(). version="2.52"> Free a #SoupXMLRPCParams returned by soup_xmlrpc_parse_request(). + line="1095">Free a #SoupXMLRPCParams returned by soup_xmlrpc_parse_request(). @@ -27729,7 +27729,7 @@ soup_xmlrpc_params_free(). a SoupXMLRPCParams + line="1097">a SoupXMLRPCParams @@ -27740,7 +27740,7 @@ soup_xmlrpc_params_free(). throws="1"> Parse method parameters returned by soup_xmlrpc_parse_request(). + line="1124">Parse method parameters returned by soup_xmlrpc_parse_request(). Deserialization details: - If @signature is provided, &lt;int&gt; and &lt;i4&gt; can be deserialized @@ -27764,14 +27764,14 @@ Deserialization details: a new (non-floating) #GVariant, or %NULL + line="1151">a new (non-floating) #GVariant, or %NULL A #SoupXMLRPCParams + line="1126">A #SoupXMLRPCParams A valid #GVariant type string, or %NULL + line="1127">A valid #GVariant type string, or %NULL @@ -27792,14 +27792,14 @@ Deserialization details: introspectable="0"> Adds @function to be executed from inside @async_context with the + line="134">Adds @function to be executed from inside @async_context with the default priority. Use this when you want to complete an action in @async_context's main loop, as soon as possible. a #GSource, which can be removed from @async_context + line="145">a #GSource, which can be removed from @async_context with g_source_destroy(). @@ -27810,14 +27810,14 @@ with g_source_destroy(). allow-none="1"> the #GMainContext to dispatch the I/O + line="136">the #GMainContext to dispatch the I/O watch in, or %NULL for the default context the callback to invoke + line="138">the callback to invoke allow-none="1"> user data to pass to @function + line="139">user data to pass to @function @@ -27834,7 +27834,7 @@ watch in, or %NULL for the default context Adds an idle event as with g_idle_add(), but using the given + line="92">Adds an idle event as with g_idle_add(), but using the given @async_context. If you want @function to run "right away", use @@ -27844,7 +27844,7 @@ soup_add_completion(), since that sets a higher priority on the a #GSource, which can be removed from @async_context + line="106">a #GSource, which can be removed from @async_context with g_source_destroy(). @@ -27855,14 +27855,14 @@ with g_source_destroy(). allow-none="1"> the #GMainContext to dispatch the I/O + line="94">the #GMainContext to dispatch the I/O watch in, or %NULL for the default context the callback to invoke at idle time + line="96">the callback to invoke at idle time allow-none="1"> user data to pass to @function + line="97">user data to pass to @function @@ -27936,13 +27936,13 @@ watch in, or %NULL for the default context introspectable="0"> Adds a timeout as with g_timeout_add(), but using the given + line="161">Adds a timeout as with g_timeout_add(), but using the given @async_context. a #GSource, which can be removed from @async_context + line="172">a #GSource, which can be removed from @async_context with g_source_destroy(). @@ -27953,20 +27953,20 @@ with g_source_destroy(). allow-none="1"> the #GMainContext to dispatch the I/O + line="163">the #GMainContext to dispatch the I/O watch in, or %NULL for the default context the timeout interval, in milliseconds + line="165">the timeout interval, in milliseconds the callback to invoke at timeout time + line="166">the callback to invoke at timeout time allow-none="1"> user data to pass to @function + line="167">user data to pass to @function @@ -31322,33 +31322,33 @@ connections, it will call this for you. introspectable="0"> This creates an XML-RPC fault response and returns it as a string. + line="467">This creates an XML-RPC fault response and returns it as a string. (To create a successful response, use soup_xmlrpc_build_method_response().) the text of the fault + line="477">the text of the fault the fault code + line="469">the fault code a printf()-style format string + line="470">a printf()-style format string the parameters to @fault_format + line="471">the parameters to @fault_format @@ -31358,7 +31358,7 @@ soup_xmlrpc_build_method_response().) deprecated="1"> This creates an XML-RPC methodCall and returns it as a string. + line="122">This creates an XML-RPC methodCall and returns it as a string. This is the low-level method that soup_xmlrpc_request_new() is built on. @@ -31385,7 +31385,7 @@ soup_value_hash_new() and related methods can help with this. the text of the methodCall, or %NULL on + line="151">the text of the methodCall, or %NULL on error @@ -31393,13 +31393,13 @@ error the name of the XML-RPC method + line="124">the name of the XML-RPC method arguments to @method + line="125">arguments to @method @@ -31407,7 +31407,7 @@ error length of @params + line="126">length of @params @@ -31417,7 +31417,7 @@ error deprecated="1"> This creates a (successful) XML-RPC methodResponse and returns it + line="246">This creates a (successful) XML-RPC methodResponse and returns it as a string. To create a fault response, use soup_xmlrpc_build_fault(). @@ -31428,7 +31428,7 @@ soup_xmlrpc_build_method_call(), qv. the text of the methodResponse, or %NULL + line="257">the text of the methodResponse, or %NULL on error @@ -31436,7 +31436,7 @@ on error the return value + line="248">the return value @@ -31447,7 +31447,7 @@ on error throws="1"> This creates an XML-RPC methodCall and returns it as a string. + line="240">This creates an XML-RPC methodCall and returns it as a string. This is the low-level method that soup_xmlrpc_message_new() is built on. @@ -31474,20 +31474,20 @@ If @params is floating, it is consumed. the text of the methodCall, or %NULL on error. + line="270">the text of the methodCall, or %NULL on error. the name of the XML-RPC method + line="242">the name of the XML-RPC method a #GVariant tuple + line="243">a #GVariant tuple @@ -31498,7 +31498,7 @@ If @params is floating, it is consumed. throws="1"> This creates a (successful) XML-RPC methodResponse and returns it + line="361">This creates a (successful) XML-RPC methodResponse and returns it as a string. To create a fault response, use soup_xmlrpc_build_fault(). This is the low-level method that soup_xmlrpc_message_set_response() is built on. @@ -31511,14 +31511,14 @@ If @value is floating, it is consumed. the text of the methodResponse, or %NULL on error. + line="376">the text of the methodResponse, or %NULL on error. the return value + line="363">the return value @@ -31536,7 +31536,7 @@ If @value is floating, it is consumed. deprecated="1"> Parses @method_call to get the name and parameters, and puts + line="559">Parses @method_call to get the name and parameters, and puts the parameters into variables of the appropriate types. The parameters are handled similarly to @@ -31551,20 +31551,20 @@ you don't know the types of the parameters. success or failure. + line="577">success or failure. the XML-RPC methodCall string + line="561">the XML-RPC methodCall string the length of @method_call, or -1 if it is NUL-terminated + line="562">the length of @method_call, or -1 if it is NUL-terminated transfer-ownership="full"> on return, the methodName from @method_call + line="563">on return, the methodName from @method_call return types and locations for parameters + line="564">return types and locations for parameters @@ -31590,7 +31590,7 @@ you don't know the types of the parameters. deprecated="1"> Parses @method_response and extracts the return value into + line="687">Parses @method_response and extracts the return value into a variable of the correct type. If @method_response is a fault, the return value will be unset, @@ -31604,7 +31604,7 @@ but @error will be unset.) %TRUE if a return value was parsed, %FALSE if the + line="705">%TRUE if a return value was parsed, %FALSE if the response was of the wrong type, or contained a fault. @@ -31612,31 +31612,31 @@ response was of the wrong type, or contained a fault. the XML-RPC methodResponse string + line="689">the XML-RPC methodResponse string the length of @method_response, or -1 if it is NUL-terminated + line="690">the length of @method_response, or -1 if it is NUL-terminated error return value + line="691">error return value the expected type of the return value + line="692">the expected type of the return value location for return value + line="693">location for return value @@ -31655,7 +31655,7 @@ response was of the wrong type, or contained a fault. throws="1"> Creates an XML-RPC methodCall and returns a #SoupMessage, ready + line="323">Creates an XML-RPC methodCall and returns a #SoupMessage, ready to send, for that method call. See soup_xmlrpc_build_request() for serialization details. @@ -31665,7 +31665,7 @@ If @params is floating, it is consumed. a #SoupMessage encoding the + line="337">a #SoupMessage encoding the indicated XML-RPC request, or %NULL on error. @@ -31673,19 +31673,19 @@ If @params is floating, it is consumed. URI of the XML-RPC service + line="325">URI of the XML-RPC service the name of the XML-RPC method to invoke at @uri + line="326">the name of the XML-RPC method to invoke at @uri a #GVariant tuple + line="327">a #GVariant tuple @@ -31696,7 +31696,7 @@ If @params is floating, it is consumed. introspectable="0"> Sets the status code and response body of @msg to indicate an + line="491">Sets the status code and response body of @msg to indicate an unsuccessful XML-RPC call, with the error described by @fault_code and @fault_format. @@ -31707,25 +31707,25 @@ and @fault_format. an XML-RPC request + line="493">an XML-RPC request the fault code + line="494">the fault code a printf()-style format string + line="495">a printf()-style format string the parameters to @fault_format + line="496">the parameters to @fault_format @@ -31736,7 +31736,7 @@ and @fault_format. throws="1"> Sets the status code and response body of @msg to indicate a + line="520">Sets the status code and response body of @msg to indicate a successful XML-RPC call, with a return value given by @value. To set a fault response, use soup_xmlrpc_message_set_fault(). @@ -31747,20 +31747,20 @@ If @value is floating, it is consumed. %TRUE on success, %FALSE otherwise. + line="534">%TRUE on success, %FALSE otherwise. an XML-RPC request + line="522">an XML-RPC request a #GVariant + line="523">a #GVariant @@ -31770,7 +31770,7 @@ If @value is floating, it is consumed. deprecated="1"> Parses @method_call to get the name and parameters, and returns the + line="487">Parses @method_call to get the name and parameters, and returns the parameter values in a #GValueArray; see also soup_xmlrpc_extract_method_call(), which is more convenient if you know in advance what the types of the parameters will be. @@ -31779,20 +31779,20 @@ know in advance what the types of the parameters will be. success or failure. + line="499">success or failure. the XML-RPC methodCall string + line="489">the XML-RPC methodCall string the length of @method_call, or -1 if it is NUL-terminated + line="490">the length of @method_call, or -1 if it is NUL-terminated transfer-ownership="full"> on return, the methodName from @method_call + line="491">on return, the methodName from @method_call transfer-ownership="full"> on return, the parameters from @method_call + line="492">on return, the parameters from @method_call @@ -31821,7 +31821,7 @@ know in advance what the types of the parameters will be. throws="1"> Parses @method_response and returns the return value in @value. If + line="602">Parses @method_response and returns the return value in @value. If @method_response is a fault, @value will be unchanged, and @error will be set to an error of type %SOUP_XMLRPC_FAULT, with the error #code containing the fault code, and the error #message containing @@ -31833,7 +31833,7 @@ will be unset.) %TRUE if a return value was parsed, %FALSE if the + line="617">%TRUE if a return value was parsed, %FALSE if the response could not be parsed, or contained a fault. @@ -31841,13 +31841,13 @@ response could not be parsed, or contained a fault. the XML-RPC methodResponse string + line="604">the XML-RPC methodResponse string the length of @method_response, or -1 if it is NUL-terminated + line="605">the length of @method_response, or -1 if it is NUL-terminated transfer-ownership="none"> on return, the return value from @method_call + line="606">on return, the return value from @method_call @@ -31867,26 +31867,26 @@ response could not be parsed, or contained a fault. throws="1"> Parses @method_call and return the method name. Method parameters can be + line="1183">Parses @method_call and return the method name. Method parameters can be parsed later using soup_xmlrpc_params_parse(). method's name, or %NULL on error. + line="1193">method's name, or %NULL on error. the XML-RPC methodCall string + line="1185">the XML-RPC methodCall string the length of @method_call, or -1 if it is NUL-terminated + line="1186">the length of @method_call, or -1 if it is NUL-terminated transfer-ownership="full"> on success, a new #SoupXMLRPCParams + line="1187">on success, a new #SoupXMLRPCParams @@ -31906,7 +31906,7 @@ parsed later using soup_xmlrpc_params_parse(). throws="1"> Parses @method_response and returns the return value. If + line="1255">Parses @method_response and returns the return value. If @method_response is a fault, %NULL is returned, and @error will be set to an error in the %SOUP_XMLRPC_FAULT domain, with the error code containing the fault code, and the error message containing @@ -31918,20 +31918,20 @@ See soup_xmlrpc_params_parse() for deserialization details. a new (non-floating) #GVariant, or %NULL + line="1271">a new (non-floating) #GVariant, or %NULL the XML-RPC methodResponse string + line="1257">the XML-RPC methodResponse string the length of @method_response, or -1 if it is NUL-terminated + line="1258">the length of @method_response, or -1 if it is NUL-terminated allow-none="1"> A valid #GVariant type string, or %NULL + line="1259">A valid #GVariant type string, or %NULL @@ -31951,7 +31951,7 @@ See soup_xmlrpc_params_parse() for deserialization details. deprecated="1"> Creates an XML-RPC methodCall and returns a #SoupMessage, ready + line="216">Creates an XML-RPC methodCall and returns a #SoupMessage, ready to send, for that method call. The parameters are passed as type/value pairs; ie, first a #GType, @@ -31962,7 +31962,7 @@ and then a value of the appropriate type, finally terminated by a #SoupMessage encoding the + line="229">a #SoupMessage encoding the indicated XML-RPC request. @@ -31970,19 +31970,19 @@ indicated XML-RPC request. URI of the XML-RPC service + line="218">URI of the XML-RPC service the name of the XML-RPC method to invoke at @uri + line="219">the name of the XML-RPC method to invoke at @uri parameters for @method + line="220">parameters for @method @@ -31993,7 +31993,7 @@ indicated XML-RPC request. deprecated="1"> Sets the status code and response body of @msg to indicate an + line="327">Sets the status code and response body of @msg to indicate an unsuccessful XML-RPC call, with the error described by @fault_code and @fault_format. Use soup_xmlrpc_message_set_fault() instead. @@ -32005,25 +32005,25 @@ and @fault_format. an XML-RPC request + line="329">an XML-RPC request the fault code + line="330">the fault code a printf()-style format string + line="331">a printf()-style format string the parameters to @fault_format + line="332">the parameters to @fault_format @@ -32034,7 +32034,7 @@ and @fault_format. deprecated="1"> Sets the status code and response body of @msg to indicate a + line="293">Sets the status code and response body of @msg to indicate a successful XML-RPC call, with a return value given by @type and the following varargs argument, of the type indicated by @type. Use soup_xmlrpc_message_set_response() instead. @@ -32046,19 +32046,19 @@ following varargs argument, of the type indicated by @type. an XML-RPC request + line="295">an XML-RPC request the type of the response value + line="296">the type of the response value the response value + line="297">the response value @@ -32069,7 +32069,7 @@ following varargs argument, of the type indicated by @type. throws="1"> Get the #SoupDate from special #GVariant created by + line="1387">Get the #SoupDate from special #GVariant created by soup_xmlrpc_variant_new_datetime() or by parsing a &lt;dateTime.iso8601&gt; node. See soup_xmlrpc_params_parse(). @@ -32080,14 +32080,14 @@ are not in the expected type. a new #SoupDate, or %NULL on error. + line="1400">a new #SoupDate, or %NULL on error. a #GVariant + line="1389">a #GVariant @@ -32097,7 +32097,7 @@ are not in the expected type. version="2.52"> Construct a special #GVariant used to serialize a &lt;dateTime.iso8601&gt; + line="1357">Construct a special #GVariant used to serialize a &lt;dateTime.iso8601&gt; node. See soup_xmlrpc_build_request(). The actual type of the returned #GVariant is unspecified and "v" or "*" @@ -32109,14 +32109,14 @@ args = g_variant_new ("(v)", soup_xmlrpc_variant_new_datetime (date)); a floating #GVariant. + line="1370">a floating #GVariant. a #SoupDate + line="1359">a #SoupDate diff --git a/girs/SpiceClientGLib-2.0.gir b/girs/SpiceClientGLib-2.0.gir index 99399546b..d066eadc2 100644 --- a/girs/SpiceClientGLib-2.0.gir +++ b/girs/SpiceClientGLib-2.0.gir @@ -17,7 +17,7 @@ and/or use gtk-doc annotations. --> c:identifier-prefixes="Spice" c:symbol-prefixes="spice"> - + @@ -26,7 +26,7 @@ and/or use gtk-doc annotations. --> - + @@ -35,7 +35,7 @@ and/or use gtk-doc annotations. --> - + @@ -50,30 +50,30 @@ and/or use gtk-doc annotations. --> glib:get-type="spice_audio_get_type" glib:type-struct="AudioClass"> The #SpiceAudio struct is opaque and should not be accessed directly. - + filename="src/spice-audio.h" + line="53">The #SpiceAudio struct is opaque and should not be accessed directly. + Once instantiated, #SpiceAudio will handle the playback and record + filename="src/spice-audio.c" + line="246">Once instantiated, #SpiceAudio will handle the playback and record channels to stream to your local audio system. Use spice_audio_get() instead - + a new #SpiceAudio instance or %NULL if no backend or failed. + filename="src/spice-audio.c" + line="257">a new #SpiceAudio instance or %NULL if no backend or failed. the #SpiceSession to connect to + filename="src/spice-audio.c" + line="248">the #SpiceSession to connect to nullable="1" allow-none="1"> a #GMainContext to attach to (or %NULL for + filename="src/spice-audio.c" + line="249">a #GMainContext to attach to (or %NULL for default). @@ -91,8 +91,8 @@ default). nullable="1" allow-none="1"> a name for the audio channels (or %NULL for + filename="src/spice-audio.c" + line="251">a name for the audio channels (or %NULL for application name). @@ -100,26 +100,26 @@ application name). Gets the #SpiceAudio associated with the passed in #SpiceSession. + filename="src/spice-session.c" + line="2745">Gets the #SpiceAudio associated with the passed in #SpiceSession. A new #SpiceAudio instance will be created the first time this function is called for a certain #SpiceSession. Note that this function returns a weak reference, which should not be used after the #SpiceSession itself has been unref-ed by the caller. - + a weak reference to a #SpiceAudio + filename="src/spice-session.c" + line="2757">a weak reference to a #SpiceAudio instance or %NULL if failed. the #SpiceSession to connect to + filename="src/spice-session.c" + line="2747">the #SpiceSession to connect to nullable="1" allow-none="1"> a #GMainContext to attach to (or %NULL for default). + filename="src/spice-session.c" + line="2748">a #GMainContext to attach to (or %NULL for default). - + @@ -148,7 +148,7 @@ instance or %NULL if failed. - + @@ -183,7 +183,7 @@ instance or %NULL if failed. - + @@ -206,7 +206,7 @@ instance or %NULL if failed. - + @@ -241,7 +241,7 @@ instance or %NULL if failed. - + @@ -274,8 +274,8 @@ instance or %NULL if failed. construct-only="1" transfer-ownership="none"> #SpiceSession this #SpiceAudio is associated with + filename="src/spice-audio.c" + line="117">#SpiceSession this #SpiceAudio is associated with @@ -289,18 +289,18 @@ instance or %NULL if failed. c:type="SpiceAudioClass" glib:is-gtype-struct-for="Audio"> Class structure for #SpiceAudio. - + filename="src/spice-audio.h" + line="64">Class structure for #SpiceAudio. + Parent class. + filename="src/spice-audio.h" + line="66">Parent class. - + @@ -316,7 +316,7 @@ instance or %NULL if failed. - + @@ -354,7 +354,7 @@ instance or %NULL if failed. - + @@ -379,7 +379,7 @@ instance or %NULL if failed. - + @@ -417,7 +417,7 @@ instance or %NULL if failed. - + @@ -441,18 +441,21 @@ instance or %NULL if failed. - - + + - - + + - + @@ -461,7 +464,7 @@ instance or %NULL if failed. - + @@ -470,7 +473,7 @@ instance or %NULL if failed. - + @@ -479,7 +482,7 @@ instance or %NULL if failed. - + @@ -488,7 +491,7 @@ instance or %NULL if failed. - + @@ -497,7 +500,7 @@ instance or %NULL if failed. - + @@ -511,37 +514,37 @@ instance or %NULL if failed. glib:get-type="spice_channel_get_type" glib:type-struct="ChannelClass"> The #SpiceChannel struct is opaque and should not be accessed directly. - + filename="src/spice-channel.h" + line="69">The #SpiceChannel struct is opaque and should not be accessed directly. + Create a new #SpiceChannel of type @type, and channel ID @id. - + filename="src/spice-channel.c" + line="2254">Create a new #SpiceChannel of type @type, and channel ID @id. + a weak reference to #SpiceChannel, the session owns the reference + filename="src/spice-channel.c" + line="2262">a weak reference to #SpiceChannel, the session owns the reference the @SpiceSession the channel is linked to + filename="src/spice-channel.c" + line="2256">the @SpiceSession the channel is linked to the requested SPICECHANNELPRIVATE type + filename="src/spice-channel.c" + line="2257">the requested SPICECHANNELPRIVATE type the channel-id + filename="src/spice-channel.c" + line="2258">the channel-id @@ -550,20 +553,20 @@ instance or %NULL if failed. c:identifier="spice_channel_string_to_type" version="0.21"> Convert a channel-type property value to a string. - + filename="src/spice-channel.c" + line="2209">Convert a channel-type property value to a string. + the channel-type property value for a @str channel + filename="src/spice-channel.c" + line="2215">the channel-type property value for a @str channel a string representation of the channel-type property + filename="src/spice-channel.c" + line="2211">a string representation of the channel-type property @@ -572,26 +575,26 @@ instance or %NULL if failed. c:identifier="spice_channel_type_to_string" version="0.20"> Convert a channel-type property value to a string. - + filename="src/spice-channel.c" + line="2189">Convert a channel-type property value to a string. + string representation of @type. + filename="src/spice-channel.c" + line="2195">string representation of @type. a channel-type property value + filename="src/spice-channel.c" + line="2191">a channel-type property value - + @@ -605,7 +608,7 @@ instance or %NULL if failed. - + @@ -619,7 +622,7 @@ instance or %NULL if failed. - + @@ -630,7 +633,7 @@ instance or %NULL if failed. - + @@ -641,7 +644,7 @@ instance or %NULL if failed. - + @@ -655,7 +658,7 @@ instance or %NULL if failed. - + @@ -666,7 +669,7 @@ instance or %NULL if failed. - + @@ -677,7 +680,7 @@ instance or %NULL if failed. - + @@ -692,20 +695,20 @@ instance or %NULL if failed. Connect the channel, using #SpiceSession connection informations - + filename="src/spice-channel.c" + line="2815">Connect the channel, using #SpiceSession connection informations + %TRUE on success. + filename="src/spice-channel.c" + line="2821">%TRUE on success. a #SpiceChannel + filename="src/spice-channel.c" + line="2817">a #SpiceChannel @@ -715,46 +718,46 @@ instance or %NULL if failed. deprecated="1" deprecated-version="0.27"> Disconnect and unref the @channel. + filename="src/spice-channel.c" + line="2336">Disconnect and unref the @channel. this function has been deprecated because it is misleading, the object is not actually destroyed. Instead, it is recommended to call explicitely spice_channel_disconnect() and g_object_unref(). - + a #SpiceChannel + filename="src/spice-channel.c" + line="2338">a #SpiceChannel Close the socket and reset connection specific data. Finally, emit + filename="src/spice-channel.c" + line="2930">Close the socket and reset connection specific data. Finally, emit @reason #SpiceChannel::channel-event on main context if not #SPICE_CHANNEL_NONE. - + a #SpiceChannel + filename="src/spice-channel.c" + line="2932">a #SpiceChannel a channel event emitted on main context (or #SPICE_CHANNEL_NONE) + filename="src/spice-channel.c" + line="2933">a channel event emitted on main context (or #SPICE_CHANNEL_NONE) @@ -763,22 +766,22 @@ g_object_unref(). c:identifier="spice_channel_flush_async" version="0.15"> Forces an asynchronous write of all user-space buffered data for + filename="src/spice-channel.c" + line="3169">Forces an asynchronous write of all user-space buffered data for the given channel. When the operation is finished callback will be called. You can then call spice_channel_flush_finish() to get the result of the operation. - + a #SpiceChannel + filename="src/spice-channel.c" + line="3171">a #SpiceChannel nullable="1" allow-none="1"> optional GCancellable object, %NULL to ignore + filename="src/spice-channel.c" + line="3172">optional GCancellable object, %NULL to ignore scope="async" closure="2"> callback to call when the request is satisfied + filename="src/spice-channel.c" + line="3173">callback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="src/spice-channel.c" + line="3174">the data to pass to callback function @@ -817,26 +820,26 @@ operation. version="0.15" throws="1"> Finishes flushing a channel. - + filename="src/spice-channel.c" + line="3217">Finishes flushing a channel. + %TRUE if flush operation succeeded, %FALSE otherwise. + filename="src/spice-channel.c" + line="3226">%TRUE if flush operation succeeded, %FALSE otherwise. a #SpiceChannel + filename="src/spice-channel.c" + line="3219">a #SpiceChannel a #GAsyncResult + filename="src/spice-channel.c" + line="3220">a #GAsyncResult @@ -845,50 +848,50 @@ operation. c:identifier="spice_channel_get_error" version="0.24"> Retrieves the #GError currently set on channel, if the #SpiceChannel + filename="src/spice-channel.c" + line="2556">Retrieves the #GError currently set on channel, if the #SpiceChannel is in error state and can provide additional error details. - + the pointer to the error, or %NULL + filename="src/spice-channel.c" + line="2563">the pointer to the error, or %NULL a #SpiceChannel + filename="src/spice-channel.c" + line="2558">a #SpiceChannel Connect the channel using @fd socket. + filename="src/spice-channel.c" + line="2836">Connect the channel using @fd socket. If @fd is -1, a valid fd will be requested later via the SpiceChannel::open-fd signal. - + %TRUE on success. + filename="src/spice-channel.c" + line="2847">%TRUE on success. a #SpiceChannel + filename="src/spice-channel.c" + line="2838">a #SpiceChannel a file descriptor (socket) or -1. + filename="src/spice-channel.c" + line="2839">a file descriptor (socket) or -1. request mechanism @@ -899,24 +902,24 @@ request mechanism deprecated="1" deprecated-version="0.13"> Enable specific channel-kind capability. + filename="src/spice-channel.c" + line="3036">Enable specific channel-kind capability. this function has been removed - + a #SpiceChannel + filename="src/spice-channel.c" + line="3038">a #SpiceChannel a capability + filename="src/spice-channel.c" + line="3039">a capability @@ -924,26 +927,26 @@ request mechanism Test availability of remote "channel kind capability". - + filename="src/spice-channel.c" + line="2985">Test availability of remote "channel kind capability". + %TRUE if @cap (channel kind capability) is available. + filename="src/spice-channel.c" + line="2992">%TRUE if @cap (channel kind capability) is available. a #SpiceChannel + filename="src/spice-channel.c" + line="2987">a #SpiceChannel a capability + filename="src/spice-channel.c" + line="2988">a capability @@ -951,26 +954,26 @@ request mechanism Test availability of remote "common channel capability". - + filename="src/spice-channel.c" + line="3004">Test availability of remote "common channel capability". + %TRUE if @cap (common channel capability) is available. + filename="src/spice-channel.c" + line="3011">%TRUE if @cap (common channel capability) is available. a #SpiceChannel + filename="src/spice-channel.c" + line="3006">a #SpiceChannel a capability + filename="src/spice-channel.c" + line="3007">a capability @@ -978,19 +981,21 @@ request mechanism + transfer-ownership="none" + default-value="-1"> + transfer-ownership="none" + default-value="-1"> Get the underlying #GSocket. Note that you should not read or + filename="src/spice-channel.c" + line="329">Get the underlying #GSocket. Note that you should not read or write any data to it directly since this will likely corrupt the channel stream. This property is mainly useful to get some connections details. @@ -1002,7 +1007,9 @@ connections details. transfer-ownership="none"> - + @@ -1013,8 +1020,8 @@ connections details. The #SpiceChannel::channel-event signal is emitted when the + filename="src/spice-channel.c" + line="348">The #SpiceChannel::channel-event signal is emitted when the state of the connection is changed. In case of errors, spice_channel_get_error() may provide additional informations on the source of the error. @@ -1024,16 +1031,16 @@ on the source of the error. a #SpiceChannelEvent + filename="src/spice-channel.c" + line="351">a #SpiceChannelEvent The #SpiceChannel::open-fd signal is emitted when a new + filename="src/spice-channel.c" + line="369">The #SpiceChannel::open-fd signal is emitted when a new connection is requested. This signal is emitted when the connection is made with spice_session_open_fd(). @@ -1042,8 +1049,8 @@ connection is made with spice_session_open_fd(). wether TLS connection is requested + filename="src/spice-channel.c" + line="372">wether TLS connection is requested @@ -1053,18 +1060,18 @@ connection is made with spice_session_open_fd(). c:type="SpiceChannelClass" glib:is-gtype-struct-for="Channel"> Class structure for #SpiceChannel. - + filename="src/spice-channel.h" + line="83">Class structure for #SpiceChannel. + Parent class. + filename="src/spice-channel.h" + line="85">Parent class. - + @@ -1080,7 +1087,7 @@ connection is made with spice_session_open_fd(). - + @@ -1096,7 +1103,7 @@ connection is made with spice_session_open_fd(). - + @@ -1112,7 +1119,7 @@ connection is made with spice_session_open_fd(). - + @@ -1125,7 +1132,7 @@ connection is made with spice_session_open_fd(). - + @@ -1138,7 +1145,7 @@ connection is made with spice_session_open_fd(). - + @@ -1154,7 +1161,7 @@ connection is made with spice_session_open_fd(). - + @@ -1173,7 +1180,7 @@ connection is made with spice_session_open_fd(). - + @@ -1188,152 +1195,165 @@ connection is made with spice_session_open_fd(). - - + + - + disguised="1" + opaque="1"> + An event, emitted by #SpiceChannel::channel-event signal. + filename="src/spice-channel.h" + line="42">An event, emitted by #SpiceChannel::channel-event signal. + glib:nick="none" + glib:name="SPICE_CHANNEL_NONE"> no event, or ignored event + filename="src/spice-channel.h" + line="44">no event, or ignored event + glib:nick="opened" + glib:name="SPICE_CHANNEL_OPENED"> connection is authentified and ready + filename="src/spice-channel.h" + line="45">connection is authentified and ready + glib:nick="switching" + glib:name="SPICE_CHANNEL_SWITCHING"> disconnecting from the current host and connecting to the target host. + filename="src/spice-channel.h" + line="46">disconnecting from the current host and connecting to the target host. + glib:nick="closed" + glib:name="SPICE_CHANNEL_CLOSED"> connection is closed normally (sent if channel was ready) + filename="src/spice-channel.h" + line="47">connection is closed normally (sent if channel was ready) + glib:nick="error-connect" + glib:name="SPICE_CHANNEL_ERROR_CONNECT"> connection error + filename="src/spice-channel.h" + line="48">connection error + glib:nick="error-tls" + glib:name="SPICE_CHANNEL_ERROR_TLS"> SSL error + filename="src/spice-channel.h" + line="49">SSL error + glib:nick="error-link" + glib:name="SPICE_CHANNEL_ERROR_LINK"> error during link process + filename="src/spice-channel.h" + line="50">error during link process + glib:nick="error-auth" + glib:name="SPICE_CHANNEL_ERROR_AUTH"> authentication error + filename="src/spice-channel.h" + line="51">authentication error + glib:nick="error-io" + glib:name="SPICE_CHANNEL_ERROR_IO"> IO error + filename="src/spice-channel.h" + line="52">IO error - - + + Error codes returned by spice-client API. - + filename="src/spice-client.h" + line="64">Error codes returned by spice-client API. + generic error code + filename="src/spice-client.h" + line="66">generic error code device redirection rejected by host + filename="src/spice-client.h" + line="67">device redirection rejected by host device disconnected (fatal IO error) + filename="src/spice-client.h" + line="68">device disconnected (fatal IO error) password is required + filename="src/spice-client.h" + line="69">password is required username is required + filename="src/spice-client.h" + line="70">username is required password and username are required + filename="src/spice-client.h" + line="71">password and username are required USB service error + filename="src/spice-client.h" + line="72">USB service error glib:get-type="spice_cursor_channel_get_type" glib:type-struct="CursorChannelClass"> The #SpiceCursorChannel struct is opaque and should not be accessed directly. - + filename="src/channel-cursor.h" + line="62">The #SpiceCursorChannel struct is opaque and should not be accessed directly. + - + @@ -1359,7 +1379,7 @@ connection is made with spice_session_open_fd(). - + @@ -1376,7 +1396,7 @@ connection is made with spice_session_open_fd(). - + @@ -1387,7 +1407,7 @@ connection is made with spice_session_open_fd(). - + @@ -1417,8 +1437,8 @@ connection is made with spice_session_open_fd(). The last #SpiceCursorShape received. + filename="src/channel-cursor.c" + line="179">The last #SpiceCursorShape received. @@ -1429,8 +1449,8 @@ connection is made with spice_session_open_fd(). The #SpiceCursorChannel::cursor-hide signal is emitted to hide + filename="src/channel-cursor.c" + line="243">The #SpiceCursorChannel::cursor-hide signal is emitted to hide the cursor/pointer on the display area. @@ -1438,8 +1458,8 @@ the cursor/pointer on the display area. The #SpiceCursorChannel::cursor-move signal is emitted to update + filename="src/channel-cursor.c" + line="223">The #SpiceCursorChannel::cursor-move signal is emitted to update the cursor position on the display area. @@ -1447,22 +1467,22 @@ the cursor position on the display area. x position + filename="src/channel-cursor.c" + line="226">x position y position + filename="src/channel-cursor.c" + line="227">y position The #SpiceCursorChannel::cursor-reset signal is emitted to + filename="src/channel-cursor.c" + line="260">The #SpiceCursorChannel::cursor-reset signal is emitted to reset the cursor to its default context. @@ -1473,8 +1493,8 @@ reset the cursor to its default context. deprecated="1" deprecated-version="0.34"> The #SpiceCursorChannel::cursor-set signal is emitted to modify + filename="src/channel-cursor.c" + line="194">The #SpiceCursorChannel::cursor-set signal is emitted to modify cursor aspect and position on the display area. Use #SpiceCursorChannel:cursor notify instead. @@ -1483,26 +1503,26 @@ cursor aspect and position on the display area. width of the shape + filename="src/channel-cursor.c" + line="197">width of the shape height of the shape + filename="src/channel-cursor.c" + line="198">height of the shape horizontal offset of the 'hotspot' of the cursor + filename="src/channel-cursor.c" + line="199">horizontal offset of the 'hotspot' of the cursor vertical offset of the 'hotspot' of the cursor + filename="src/channel-cursor.c" + line="200">vertical offset of the 'hotspot' of the cursor nullable="1" allow-none="1"> 32bits shape data, or %NULL if default cursor. It might + filename="src/channel-cursor.c" + line="201">32bits shape data, or %NULL if default cursor. It might be freed after the signal is emitted, so make sure to copy it if you need it later! @@ -1523,18 +1543,18 @@ if you need it later! c:type="SpiceCursorChannelClass" glib:is-gtype-struct-for="CursorChannel"> Class structure for #SpiceCursorChannel. - + filename="src/channel-cursor.h" + line="75">Class structure for #SpiceCursorChannel. + Parent class. + filename="src/channel-cursor.h" + line="77">Parent class. - + @@ -1565,7 +1585,7 @@ if you need it later! - + @@ -1584,7 +1604,7 @@ if you need it later! - + @@ -1597,7 +1617,7 @@ if you need it later! - + @@ -1611,8 +1631,9 @@ if you need it later! - + disguised="1" + opaque="1"> + glib:get-type="spice_cursor_shape_get_type" c:symbol-prefix="cursor_shape"> The #SpiceCursorShape structure defines the remote cursor's shape. - + filename="src/channel-cursor.h" + line="40">The #SpiceCursorShape structure defines the remote cursor's shape. + a #SpiceCursorType of @data + filename="src/channel-cursor.h" + line="42">a #SpiceCursorType of @data a width of the remote cursor + filename="src/channel-cursor.h" + line="43">a width of the remote cursor a height of the remote cursor + filename="src/channel-cursor.h" + line="44">a height of the remote cursor a 'x' coordinate of the remote cursor + filename="src/channel-cursor.h" + line="45">a 'x' coordinate of the remote cursor a 'y' coordinate of the remote cursor + filename="src/channel-cursor.h" + line="46">a 'y' coordinate of the remote cursor image data of the remote cursor + filename="src/channel-cursor.h" + line="47">image data of the remote cursor + + + + + + + + + - + @@ -1672,7 +1702,7 @@ if you need it later! - + @@ -1681,7 +1711,7 @@ if you need it later! - + @@ -1695,115 +1725,254 @@ if you need it later! glib:get-type="spice_display_channel_get_type" glib:type-struct="DisplayChannelClass"> The #SpiceDisplayChannel struct is opaque and should not be accessed directly. - - - Tells the spice server to change the preferred image compression + filename="src/channel-display.h" + line="107">The #SpiceDisplayChannel struct is opaque and should not be accessed directly. + + + Tells the spice server to change the preferred image compression for the @channel. - + use spice_display_channel_change_preferred_compression() instead. + - + a #SpiceDisplayChannel - - + filename="src/channel-display.c" + line="568">a #SpiceDisplayChannel + + a #SpiceImageCompression + filename="src/channel-display.c" + line="569">a #SpiceImageCompression - - + + Tells the spice server to change the preferred video codec type for + filename="src/channel-display.c" + line="637">Tells the spice server to change the preferred video codec type for streaming in @channel. Application can set only one preferred video codec per display channel. - + use spice_display_channel_change_preferred_video_codec_type() instead. + - + a #SpiceDisplayChannel - + filename="src/channel-display.c" + line="639">a #SpiceDisplayChannel + + + + a #SpiceVideoCodecType + + + + + + Tells the spice server to change the preferred image compression +for the @channel. + + + + + + + a #SpiceDisplayChannel + + + + a #SpiceImageCompression + + + + + Tells the spice server to change the preferred video codec type for +streaming in @channel. Application can set only one preferred video codec per +display channel. + use spice_display_channel_change_preferred_video_codec_types() instead. + + + + + + + a #SpiceDisplayChannel + + a #SpiceVideoCodecType + filename="src/channel-display.c" + line="657">a #SpiceVideoCodecType - - + + Retrieve primary display surface @surface_id. - + filename="src/channel-display.c" + line="685">Tells the spice server the ordered preferred video codec types to +use for streaming in @channel. + %TRUE if the primary surface was found and its details + filename="src/channel-display.c" + line="695">%TRUE if the preferred codec list was successfully changed, and %FALSE +otherwise. + + + + + a #SpiceDisplayChannel + + + + an array of @ncodecs #SpiceVideoCodecType types + + + + + + the number of codec types in the @codecs array + + + + + + Retrieve primary display surface @surface_id. + + + %TRUE if the primary surface was found and its details collected in @primary. - + a #SpiceDisplayChannel - + filename="src/channel-display.c" + line="529">a #SpiceDisplayChannel + + + + a surface id + + + a #SpiceDisplayPrimary + + + + + + Retrieve primary display surface @surface_id. + use spice_display_channel_get_primary() instead. + + + %TRUE if the primary surface was found and its details +collected in @primary. + + + + + a #SpiceDisplayChannel + + a surface id + filename="src/channel-display.c" + line="511">a surface id a #SpiceDisplayPrimary + filename="src/channel-display.c" + line="512">a #SpiceDisplayPrimary - + Retrieves the GL scanout if available - + filename="src/channel-display.c" + line="759">Retrieves the GL scanout if available + the current GL scanout, or %NULL if none or not valid + filename="src/channel-display.c" + line="765">the current GL scanout, or %NULL if none or not valid a #SpiceDisplayChannel + filename="src/channel-display.c" + line="761">a #SpiceDisplayChannel @@ -1812,50 +1981,56 @@ collected in @primary. c:identifier="spice_display_channel_gl_draw_done" version="0.35"> After a SpiceDisplayChannel::gl-draw is emitted, the client should + filename="src/channel-display.c" + line="2129">After a SpiceDisplayChannel::gl-draw is emitted, the client should draw the current display with the current GL scanout, and must release the GL resource with a call to spice_display_gl_draw_done() (failing to do so for each gl-draw may result in a frozen display). - + a #SpiceDisplayChannel + filename="src/channel-display.c" + line="2131">a #SpiceDisplayChannel - + The last #SpiceGlScanout received. - + Current monitors configuration. - + - + The maximum number of monitors the server or guest supports. May change during client lifetime, for instance guest may reboot or dynamically adjust this. - + @@ -1867,7 +2042,7 @@ reboot or dynamically adjust this. The #SpiceDisplayChannel::display-invalidate signal is emitted when the rectangular region x/y/w/h of the primary buffer is updated. @@ -1877,25 +2052,25 @@ updated. x position y position width height @@ -1903,7 +2078,7 @@ updated. The #SpiceDisplayChannel::display-mark signal is emitted when the %RED_DISPLAY_MARK command is received, and the display should be exposed. @@ -1913,7 +2088,7 @@ should be exposed. %TRUE when the display mark has been received @@ -1921,7 +2096,7 @@ should be exposed. The #SpiceDisplayChannel::display-primary-create signal provides main display buffer data. @@ -1930,31 +2105,31 @@ provides main display buffer data. %SPICE_SURFACE_FMT_32_xRGB or %SPICE_SURFACE_FMT_16_555; width resolution height resolution the buffer stride ("width" padding) identifier of the shared memory segment associated with the @imgdata, or -1 if not shm @@ -1964,7 +2139,7 @@ the @imgdata, or -1 if not shm nullable="1" allow-none="1"> pointer to surface buffer @@ -1972,7 +2147,7 @@ the @imgdata, or -1 if not shm The #SpiceDisplayChannel::display-primary-destroy signal is emitted when the primary surface is freed and should not be accessed anymore. @@ -1982,7 +2157,7 @@ accessed anymore. The #SpiceDisplayChannel::gl-draw signal is emitted when the rectangular region x/y/w/h of the GL scanout is updated and must be drawn. When the draw is finished, you must call @@ -1994,25 +2169,25 @@ resources. x position y position width height @@ -2020,20 +2195,22 @@ resources. The #SpiceDisplayChannel::gst-video-overlay signal is emitted when pipeline is ready and can be passed to widget to register GStreamer -overlay interface and other GStreamer callbacks. +overlay interface and other GStreamer callbacks. If the pipeline +pointer is NULL, the drawing area of the native renderer is set +visible. %TRUE if the overlay is being set + filename="src/channel-display.c" + line="491">%TRUE if the overlay is being set pointer to GStreamer's pipeline @@ -2047,7 +2224,7 @@ overlay interface and other GStreamer callbacks. instead handle for the display window if possible The #SpiceDisplayChannel::streaming-mode signal is emitted when @@ -2057,7 +2234,7 @@ spice server is working in streaming mode. %TRUE when it's streaming mode @@ -2068,18 +2245,18 @@ spice server is working in streaming mode. c:type="SpiceDisplayChannelClass" glib:is-gtype-struct-for="DisplayChannel"> Class structure for #SpiceDisplayChannel. - + filename="src/channel-display.h" + line="120">Class structure for #SpiceDisplayChannel. + Parent class. + filename="src/channel-display.h" + line="122">Parent class. - + @@ -2110,7 +2287,7 @@ spice server is working in streaming mode. - + @@ -2123,7 +2300,7 @@ spice server is working in streaming mode. - + @@ -2148,7 +2325,7 @@ spice server is working in streaming mode. - + @@ -2165,104 +2342,105 @@ spice server is working in streaming mode. - + disguised="1" + opaque="1"> + Holds a monitor configuration. - + filename="src/channel-display.h" + line="62">Holds a monitor configuration. + monitor id + filename="src/channel-display.h" + line="64">monitor id monitor surface id + filename="src/channel-display.h" + line="65">monitor surface id x position of the monitor + filename="src/channel-display.h" + line="66">x position of the monitor y position of the monitor + filename="src/channel-display.h" + line="67">y position of the monitor width of the monitor + filename="src/channel-display.h" + line="68">width of the monitor height of the monitor + filename="src/channel-display.h" + line="69">height of the monitor Holds the information necessary to use the primary surface. - + filename="src/channel-display.h" + line="83">Holds the information necessary to use the primary surface. + primary buffer format + filename="src/channel-display.h" + line="85">primary buffer format width of the primary + filename="src/channel-display.h" + line="86">width of the primary height of the primary + filename="src/channel-display.h" + line="87">height of the primary stride of the primary + filename="src/channel-display.h" + line="88">stride of the primary identifier of the shared memory segment associated with + filename="src/channel-display.h" + line="89">identifier of the shared memory segment associated with the @data, or -1 if not shm pointer to primary buffer + filename="src/channel-display.h" + line="91">pointer to primary buffer whether the display is marked ready + filename="src/channel-display.h" + line="92">whether the display is marked ready - + @@ -2271,7 +2449,7 @@ the @data, or -1 if not shm - + @@ -2280,7 +2458,7 @@ the @data, or -1 if not shm - + @@ -2293,9 +2471,9 @@ the @data, or -1 if not shm glib:type-name="SpiceFileTransferTask" glib:get-type="spice_file_transfer_task_get_type" glib:type-struct="FileTransferTaskClass"> - + - + @@ -2307,7 +2485,7 @@ the @data, or -1 if not shm - + @@ -2318,8 +2496,9 @@ the @data, or -1 if not shm - + c:identifier="spice_file_transfer_task_get_progress" + glib:get-property="progress"> + @@ -2330,8 +2509,9 @@ the @data, or -1 if not shm - + c:identifier="spice_file_transfer_task_get_total_bytes" + glib:get-property="total-bytes"> + @@ -2342,8 +2522,9 @@ the @data, or -1 if not shm - + c:identifier="spice_file_transfer_task_get_transferred_bytes" + glib:get-property="transferred-bytes"> + @@ -2374,16 +2555,26 @@ the @data, or -1 if not shm + transfer-ownership="none" + default-value="0"> - + - + - + @@ -2400,33 +2591,34 @@ the @data, or -1 if not shm - + Compile-time version checking. Evaluates to %TRUE if the version + filename="src/spice-version.h" + line="58">Compile-time version checking. Evaluates to %TRUE if the version of Spice-Gtk is greater than the required one. - + required major version + filename="src/spice-version.h" + line="60">required major version required minor version + filename="src/spice-version.h" + line="61">required minor version required micro version + filename="src/spice-version.h" + line="62">required micro version @@ -2435,9 +2627,9 @@ of Spice-Gtk is greater than the required one. c:type="SPICE_GTK_MAJOR_VERSION" version="0.24"> Spice-Gtk major version component (e.g. 1 if version is 1.2.3) - + filename="src/spice-version.h" + line="34">Spice-Gtk major version component (e.g. 1 if version is 1.2.3) + c:type="SPICE_GTK_MICRO_VERSION" version="0.24"> Spice-Gtk micro version component (e.g. 3 if version is 1.2.3) - + filename="src/spice-version.h" + line="50">Spice-Gtk micro version component (e.g. 3 if version is 1.2.3) + Spice-Gtk minor version component (e.g. 2 if version is 1.2.3) - + filename="src/spice-version.h" + line="42">Spice-Gtk minor version component (e.g. 2 if version is 1.2.3) + glib:get-type="spice_gl_scanout_get_type" c:symbol-prefix="gl_scanout"> Holds the information necessary for using the GL display scanout. - + filename="src/channel-display.h" + line="41">Holds the information necessary for using the GL display scanout. + a drm DMABUF file that can be imported with eglCreateImageKHR + filename="src/channel-display.h" + line="43">a drm DMABUF file that can be imported with eglCreateImageKHR width of the scanout + filename="src/channel-display.h" + line="44">width of the scanout height of the scanout + filename="src/channel-display.h" + line="45">height of the scanout stride of the scanout + filename="src/channel-display.h" + line="46">stride of the scanout the drm fourcc format + filename="src/channel-display.h" + line="47">the drm fourcc format orientation of the scanout + filename="src/channel-display.h" + line="48">orientation of the scanout Frees the @scanout. - + a #SpiceGlScanout @@ -2526,7 +2718,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2535,7 +2727,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2544,7 +2736,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2553,7 +2745,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2562,7 +2754,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2571,7 +2763,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2580,7 +2772,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2589,7 +2781,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2598,7 +2790,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2607,7 +2799,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2616,7 +2808,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2625,7 +2817,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2634,7 +2826,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2643,7 +2835,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2652,7 +2844,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2661,7 +2853,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2670,7 +2862,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2679,7 +2871,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2688,7 +2880,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2697,7 +2889,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2706,7 +2898,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2715,7 +2907,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2724,7 +2916,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2733,7 +2925,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2742,7 +2934,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2751,7 +2943,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2760,7 +2952,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2769,7 +2961,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2778,7 +2970,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2787,7 +2979,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2796,7 +2988,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2805,7 +2997,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2814,7 +3006,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2823,7 +3015,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2832,7 +3024,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2841,7 +3033,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2850,7 +3042,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2859,7 +3051,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2868,7 +3060,7 @@ of Spice-Gtk is greater than the required one. - + @@ -2882,36 +3074,36 @@ of Spice-Gtk is greater than the required one. glib:get-type="spice_inputs_channel_get_type" glib:type-struct="InputsChannelClass"> The #SpiceInputsChannel struct is opaque and should not be accessed directly. - + filename="src/channel-inputs.h" + line="53">The #SpiceInputsChannel struct is opaque and should not be accessed directly. + Press a mouse button. - + filename="src/channel-inputs.c" + line="394">Press a mouse button. + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="396">a #SpiceInputsChannel a SPICE_MOUSE_BUTTON + filename="src/channel-inputs.c" + line="397">a SPICE_MOUSE_BUTTON SPICE_MOUSE_BUTTON_MASK flags + filename="src/channel-inputs.c" + line="398">SPICE_MOUSE_BUTTON_MASK flags @@ -2920,29 +3112,29 @@ of Spice-Gtk is greater than the required one. c:identifier="spice_inputs_channel_button_release" version="0.35"> Release a button. - + filename="src/channel-inputs.c" + line="465">Release a button. + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="467">a #SpiceInputsChannel a SPICE_MOUSE_BUTTON + filename="src/channel-inputs.c" + line="468">a SPICE_MOUSE_BUTTON SPICE_MOUSE_BUTTON_MASK flags + filename="src/channel-inputs.c" + line="469">SPICE_MOUSE_BUTTON_MASK flags @@ -2951,23 +3143,23 @@ of Spice-Gtk is greater than the required one. c:identifier="spice_inputs_channel_key_press" version="0.35"> Press a key. - + filename="src/channel-inputs.c" + line="535">Press a key. + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="537">a #SpiceInputsChannel a PC XT (set 1) key scancode. For scancodes with an \%0xe0 + filename="src/channel-inputs.c" + line="538">a PC XT (set 1) key scancode. For scancodes with an \%0xe0 prefix, drop the prefix and OR the scancode with \%0x100. @@ -2977,23 +3169,23 @@ of Spice-Gtk is greater than the required one. c:identifier="spice_inputs_channel_key_press_and_release" version="0.35"> Press and release a key event atomically (in the same message). - + filename="src/channel-inputs.c" + line="623">Press and release a key event atomically (in the same message). + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="625">a #SpiceInputsChannel a PC XT (set 1) key scancode. For scancodes with an \%0xe0 + filename="src/channel-inputs.c" + line="626">a PC XT (set 1) key scancode. For scancodes with an \%0xe0 prefix, drop the prefix and OR the scancode with \%0x100. @@ -3003,23 +3195,23 @@ of Spice-Gtk is greater than the required one. c:identifier="spice_inputs_channel_key_release" version="0.35"> Release a key. - + filename="src/channel-inputs.c" + line="578">Release a key. + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="580">a #SpiceInputsChannel a PC XT (set 1) key scancode. For scancodes with an \%0xe0 + filename="src/channel-inputs.c" + line="581">a PC XT (set 1) key scancode. For scancodes with an \%0xe0 prefix, drop the prefix and OR the scancode with \%0x100. @@ -3029,35 +3221,35 @@ of Spice-Gtk is greater than the required one. c:identifier="spice_inputs_channel_motion" version="0.35"> Change mouse position (used in SPICE_MOUSE_MODE_SERVER). - + filename="src/channel-inputs.c" + line="291">Change mouse position (used in SPICE_MOUSE_MODE_SERVER). + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="293">a #SpiceInputsChannel delta X mouse coordinates + filename="src/channel-inputs.c" + line="294">delta X mouse coordinates delta Y mouse coordinates + filename="src/channel-inputs.c" + line="295">delta Y mouse coordinates SPICE_MOUSE_BUTTON_MASK flags + filename="src/channel-inputs.c" + line="296">SPICE_MOUSE_BUTTON_MASK flags @@ -3066,41 +3258,41 @@ of Spice-Gtk is greater than the required one. c:identifier="spice_inputs_channel_position" version="0.35"> Change mouse position (used in SPICE_MOUSE_MODE_CLIENT). - + filename="src/channel-inputs.c" + line="343">Change mouse position (used in SPICE_MOUSE_MODE_CLIENT). + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="345">a #SpiceInputsChannel X mouse coordinates + filename="src/channel-inputs.c" + line="346">X mouse coordinates Y mouse coordinates + filename="src/channel-inputs.c" + line="347">Y mouse coordinates display channel id + filename="src/channel-inputs.c" + line="348">display channel id SPICE_MOUSE_BUTTON_MASK flags + filename="src/channel-inputs.c" + line="349">SPICE_MOUSE_BUTTON_MASK flags @@ -3109,28 +3301,30 @@ of Spice-Gtk is greater than the required one. c:identifier="spice_inputs_channel_set_key_locks" version="0.35"> Set the keyboard locks on the guest (Caps, Num, Scroll..) - + filename="src/channel-inputs.c" + line="710">Set the keyboard locks on the guest (Caps, Num, Scroll..) + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="712">a #SpiceInputsChannel #SpiceInputsLock modifiers flags + filename="src/channel-inputs.c" + line="713">#SpiceInputsLock modifiers flags - + @@ -3141,8 +3335,8 @@ of Spice-Gtk is greater than the required one. The #SpiceInputsChannel::inputs-modifiers signal is emitted when + filename="src/channel-inputs.c" + line="123">The #SpiceInputsChannel::inputs-modifiers signal is emitted when the guest keyboard locks are changed. You can read the current state from #SpiceInputsChannel:key-modifiers property. @@ -3154,18 +3348,18 @@ state from #SpiceInputsChannel:key-modifiers property. c:type="SpiceInputsChannelClass" glib:is-gtype-struct-for="InputsChannel"> Class structure for #SpiceInputsChannel. - + filename="src/channel-inputs.h" + line="66">Class structure for #SpiceInputsChannel. + Parent class. + filename="src/channel-inputs.h" + line="68">Parent class. - + @@ -3179,45 +3373,49 @@ state from #SpiceInputsChannel:key-modifiers property. - + disguised="1" + opaque="1"> + Constants used to synchronize modifiers between a client and a guest. + filename="src/channel-inputs.h" + line="39">Constants used to synchronize modifiers between a client and a guest. + glib:nick="scroll-lock" + glib:name="SPICE_INPUTS_SCROLL_LOCK"> Scroll Lock + filename="src/channel-inputs.h" + line="41">Scroll Lock + glib:nick="num-lock" + glib:name="SPICE_INPUTS_NUM_LOCK"> Num Lock + filename="src/channel-inputs.h" + line="42">Num Lock + glib:nick="caps-lock" + glib:name="SPICE_INPUTS_CAPS_LOCK"> Caps Lock + filename="src/channel-inputs.h" + line="43">Caps Lock - + @@ -3226,7 +3424,7 @@ state from #SpiceInputsChannel:key-modifiers property. - + @@ -3235,7 +3433,7 @@ state from #SpiceInputsChannel:key-modifiers property. - + @@ -3249,33 +3447,33 @@ state from #SpiceInputsChannel:key-modifiers property. glib:get-type="spice_main_channel_get_type" glib:type-struct="MainChannelClass"> The #SpiceMainChannel struct is opaque and should not be accessed directly. - + filename="src/channel-main.h" + line="39">The #SpiceMainChannel struct is opaque and should not be accessed directly. + Test capability of a remote agent. - + filename="src/channel-main.c" + line="2718">Test capability of a remote agent. + %TRUE if @cap (channel kind capability) is available. + filename="src/channel-main.c" + line="2725">%TRUE if @cap (channel kind capability) is available. a #SpiceMainChannel + filename="src/channel-main.c" + line="2720">a #SpiceMainChannel an agent capability identifier + filename="src/channel-main.c" + line="2721">an agent capability identifier @@ -3284,35 +3482,37 @@ state from #SpiceInputsChannel:key-modifiers property. c:identifier="spice_main_channel_clipboard_selection_grab" version="0.35"> Grab the guest clipboard, with #VD_AGENT_CLIPBOARD @types. - + filename="src/channel-main.c" + line="2914">Grab the guest clipboard, with #VD_AGENT_CLIPBOARD @types. + a #SpiceMainChannel + filename="src/channel-main.c" + line="2916">a #SpiceMainChannel one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* + filename="src/channel-main.c" + line="2917">one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* an array of #VD_AGENT_CLIPBOARD types available in the clipboard - + filename="src/channel-main.c" + line="2918">an array of #VD_AGENT_CLIPBOARD types available in the clipboard + + + the number of @types + filename="src/channel-main.c" + line="2919">the number of @types @@ -3321,41 +3521,43 @@ state from #SpiceInputsChannel:key-modifiers property. c:identifier="spice_main_channel_clipboard_selection_notify" version="0.35"> Send the clipboard data to the guest. - + filename="src/channel-main.c" + line="3026">Send the clipboard data to the guest. + a #SpiceMainChannel + filename="src/channel-main.c" + line="3028">a #SpiceMainChannel one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* + filename="src/channel-main.c" + line="3029">one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* a #VD_AGENT_CLIPBOARD type + filename="src/channel-main.c" + line="3030">a #VD_AGENT_CLIPBOARD type clipboard data - + filename="src/channel-main.c" + line="3031">clipboard data + + + data length in bytes + filename="src/channel-main.c" + line="3032">data length in bytes @@ -3364,24 +3566,24 @@ state from #SpiceInputsChannel:key-modifiers property. c:identifier="spice_main_channel_clipboard_selection_release" version="0.35"> Release the clipboard (for example, when the client loses the + filename="src/channel-main.c" + line="2965">Release the clipboard (for example, when the client loses the clipboard grab): Inform the guest no clipboard data is available. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="2967">a #SpiceMainChannel one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* + filename="src/channel-main.c" + line="2968">one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* @@ -3390,30 +3592,30 @@ clipboard grab): Inform the guest no clipboard data is available. c:identifier="spice_main_channel_clipboard_selection_request" version="0.35"> Request clipboard data of @type from the guest. The reply is sent + filename="src/channel-main.c" + line="3081">Request clipboard data of @type from the guest. The reply is sent through the #SpiceMainChannel::main-clipboard-selection signal. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="3083">a #SpiceMainChannel one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* + filename="src/channel-main.c" + line="3084">one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* a #VD_AGENT_CLIPBOARD type + filename="src/channel-main.c" + line="3085">a #VD_AGENT_CLIPBOARD type @@ -3422,8 +3624,8 @@ through the #SpiceMainChannel::main-clipboard-selection signal. c:identifier="spice_main_channel_file_copy_async" version="0.35"> Copies the file @sources to guest + filename="src/channel-main.c" + line="3424">Copies the file @sources to guest If @cancellable is not %NULL, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation @@ -3446,29 +3648,29 @@ before release 0.33 the callback was called for each file in multiple file transfer. This behavior was changed for the same reason as the progress_callback (above). If you need to monitor the ending of individual files, you can connect to "finished" signal from each SpiceFileTransferTask. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="3426">a #SpiceMainChannel a %NULL-terminated array of #GFile objects to be transferred + filename="src/channel-main.c" + line="3427">a %NULL-terminated array of #GFile objects to be transferred set of #GFileCopyFlags + filename="src/channel-main.c" + line="3428">set of #GFileCopyFlags optional #GCancellable object, %NULL to ignore + filename="src/channel-main.c" + line="3429">optional #GCancellable object, %NULL to ignore function to callback with + filename="src/channel-main.c" + line="3430">function to callback with progress information, or %NULL if progress information is not needed @@ -3498,8 +3700,8 @@ files, you can connect to "finished" signal from each SpiceFileTransferTask. user data to pass to @progress_callback + filename="src/channel-main.c" + line="3432">user data to pass to @progress_callback a #GAsyncReadyCallback to call when the request is satisfied + filename="src/channel-main.c" + line="3433">a #GAsyncReadyCallback to call when the request is satisfied the data to pass to callback function + filename="src/channel-main.c" + line="3434">the data to pass to callback function @@ -3528,27 +3730,27 @@ files, you can connect to "finished" signal from each SpiceFileTransferTask. Finishes copying the file started with + filename="src/channel-main.c" + line="3544">Finishes copying the file started with spice_main_file_copy_async(). - + a %TRUE on success, %FALSE on error. + filename="src/channel-main.c" + line="3553">a %TRUE on success, %FALSE on error. a #SpiceMainChannel + filename="src/channel-main.c" + line="3546">a #SpiceMainChannel a #GAsyncResult. + filename="src/channel-main.c" + line="3547">a #GAsyncResult. @@ -3557,25 +3759,25 @@ spice_main_file_copy_async(). c:identifier="spice_main_channel_request_mouse_mode" version="0.35"> Request a mouse mode to the server. The server may not be able to + filename="src/channel-main.c" + line="1648">Request a mouse mode to the server. The server may not be able to change the mouse mode, but spice-gtk will try to request it when possible. - + a %SpiceMainChannel + filename="src/channel-main.c" + line="1650">a %SpiceMainChannel a SPICE_MOUSE_MODE + filename="src/channel-main.c" + line="1651">a SPICE_MOUSE_MODE @@ -3584,21 +3786,21 @@ when possible. c:identifier="spice_main_channel_send_monitor_config" version="0.35"> Send monitors configuration previously set with + filename="src/channel-main.c" + line="1105">Send monitors configuration previously set with spice_main_set_display() and spice_main_set_display_enabled() - + %TRUE on success. + filename="src/channel-main.c" + line="1112">%TRUE on success. a #SpiceMainChannel + filename="src/channel-main.c" + line="1107">a #SpiceMainChannel @@ -3607,58 +3809,58 @@ spice_main_set_display() and spice_main_set_display_enabled() c:identifier="spice_main_channel_update_display" version="0.35"> Update the display @id resolution. + filename="src/channel-main.c" + line="2778">Update the display @id resolution. If @update is %TRUE, the remote configuration will be updated too after 1 second without further changes. You can send when you want without delay the new configuration to the remote with spice_main_send_monitor_config() - + a #SpiceMainChannel + filename="src/channel-main.c" + line="2780">a #SpiceMainChannel display ID + filename="src/channel-main.c" + line="2781">display ID x position + filename="src/channel-main.c" + line="2782">x position y position + filename="src/channel-main.c" + line="2783">y position display width + filename="src/channel-main.c" + line="2784">display width display height + filename="src/channel-main.c" + line="2785">display height if %TRUE, update guest resolution after 1sec. + filename="src/channel-main.c" + line="2786">if %TRUE, update guest resolution after 1sec. @@ -3667,8 +3869,8 @@ spice_main_send_monitor_config() c:identifier="spice_main_channel_update_display_enabled" version="0.35"> When sending monitor configuration to agent guest, if @enabled is %FALSE, + filename="src/channel-main.c" + line="3127">When sending monitor configuration to agent guest, if @enabled is %FALSE, don't set display @id, which the agent translates to disabling the display id. If @enabled is %TRUE, the monitor will be included in the next monitor update. Note: this will take effect next time the monitor configuration is @@ -3676,41 +3878,93 @@ sent. If @update is %FALSE, no server update will be triggered by this call, but the value will be saved and used in the next configuration update. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="3129">a #SpiceMainChannel display ID (if -1: set all displays) + filename="src/channel-main.c" + line="3130">display ID (if -1: set all displays) wether display @id is enabled + filename="src/channel-main.c" + line="3131">wether display @id is enabled + + + + if %TRUE, update guest display state after 1sec. + + + + Update the display @id physical size. + +If @update is %TRUE, the remote configuration will be updated too +after 1 second without further changes. You can send when you want +without delay the new configuration to the remote with +spice_main_send_monitor_config() + + + + + + + a #SpiceMainChannel + + + + display ID + + + + physical display width in millimeters + + + + physical display height in millimeters + + if %TRUE, update guest display state after 1sec. + filename="src/channel-main.c" + line="2829">if %TRUE, update guest resolution after 1sec. - + - + deprecated-version="0.37" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="0"> Deprecated due lack of support in drivers, only Windows 7 and older. This option is currently ignored. @@ -3726,52 +3981,58 @@ This option is currently ignored. + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="FALSE"> Disable automatic horizontal display position alignment. + filename="src/channel-main.c" + line="576">Disable automatic horizontal display position alignment. + transfer-ownership="none" + default-value="TRUE"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="FALSE"> + transfer-ownership="none" + default-value="104857600"> Maximum size of clipboard operations in bytes (default 100MB, + filename="src/channel-main.c" + line="593">Maximum size of clipboard operations in bytes (default 100MB, -1 for unlimited size); - + Spice protocol specifies two mouse modes, client mode and + filename="src/channel-main.c" + line="475">Spice protocol specifies two mouse modes, client mode and server mode. In client mode (%SPICE_MOUSE_MODE_CLIENT), the affective mouse is the client side mouse: the client sends mouse position within the display and the server sends mouse @@ -3788,8 +4049,8 @@ position and shape commands. Notify when the %SpiceMainChannel:agent-connected or + filename="src/channel-main.c" + line="629">Notify when the %SpiceMainChannel:agent-connected or %SpiceMainChannel:agent-caps-0 property change. @@ -3800,8 +4061,8 @@ position and shape commands. deprecated="1" deprecated-version="0.6"> Provides guest clipboard data requested by spice_main_clipboard_request(). + filename="src/channel-main.c" + line="645">Provides guest clipboard data requested by spice_main_clipboard_request(). use SpiceMainChannel::main-clipboard-selection instead. @@ -3809,23 +4070,22 @@ position and shape commands. the VD_AGENT_CLIPBOARD data type + filename="src/channel-main.c" + line="648">the VD_AGENT_CLIPBOARD data type - + clipboard data - + filename="src/channel-main.c" + line="649">clipboard data + + + size of @data in bytes + filename="src/channel-main.c" + line="650">size of @data in bytes @@ -3835,27 +4095,26 @@ position and shape commands. deprecated="1" deprecated-version="0.6"> Inform when clipboard data is available from the guest, and for + filename="src/channel-main.c" + line="690">Inform when clipboard data is available from the guest, and for which @types. use SpiceMainChannel::main-clipboard-selection-grab instead. - + the VD_AGENT_CLIPBOARD data types - + filename="src/channel-main.c" + line="693">the VD_AGENT_CLIPBOARD data types + + + the number of @types + filename="src/channel-main.c" + line="694">the number of @types @@ -3865,8 +4124,8 @@ which @types. deprecated="1" deprecated-version="0.6"> Inform when the clipboard is released from the guest, when no + filename="src/channel-main.c" + line="780">Inform when the clipboard is released from the guest, when no clipboard data is available from the guest. use SpiceMainChannel::main-clipboard-selection-release instead. @@ -3878,57 +4137,56 @@ clipboard data is available from the guest. deprecated="1" deprecated-version="0.6"> Request clipboard data from the client. + filename="src/channel-main.c" + line="735">Request clipboard data from the client. use SpiceMainChannel::main-clipboard-selection-request instead. %TRUE if the request is successful + filename="src/channel-main.c" + line="742">%TRUE if the request is successful the VD_AGENT_CLIPBOARD request type + filename="src/channel-main.c" + line="738">the VD_AGENT_CLIPBOARD request type Informs that clipboard selection data are available. + filename="src/channel-main.c" + line="667">Informs that clipboard selection data are available. a VD_AGENT_CLIPBOARD_SELECTION clipboard + filename="src/channel-main.c" + line="670">a VD_AGENT_CLIPBOARD_SELECTION clipboard the VD_AGENT_CLIPBOARD data type + filename="src/channel-main.c" + line="671">the VD_AGENT_CLIPBOARD data type - + clipboard data - + filename="src/channel-main.c" + line="672">clipboard data + + + size of @data in bytes + filename="src/channel-main.c" + line="673">size of @data in bytes @@ -3937,8 +4195,8 @@ clipboard data is available from the guest. when="last" version="0.6"> Inform when clipboard data is available from the guest, and for + filename="src/channel-main.c" + line="712">Inform when clipboard data is available from the guest, and for which @types. @@ -3946,23 +4204,22 @@ which @types. a VD_AGENT_CLIPBOARD_SELECTION clipboard + filename="src/channel-main.c" + line="715">a VD_AGENT_CLIPBOARD_SELECTION clipboard - + the VD_AGENT_CLIPBOARD data types - + filename="src/channel-main.c" + line="716">the VD_AGENT_CLIPBOARD data types + + + the number of @types + filename="src/channel-main.c" + line="717">the number of @types @@ -3971,8 +4228,8 @@ which @types. when="last" version="0.6"> Inform when the clipboard is released from the guest, when no + filename="src/channel-main.c" + line="799">Inform when the clipboard is released from the guest, when no clipboard data is available from the guest. @@ -3980,8 +4237,8 @@ clipboard data is available from the guest. a VD_AGENT_CLIPBOARD_SELECTION clipboard + filename="src/channel-main.c" + line="802">a VD_AGENT_CLIPBOARD_SELECTION clipboard @@ -3990,41 +4247,41 @@ clipboard data is available from the guest. when="last" version="0.6"> Request clipboard data from the client. + filename="src/channel-main.c" + line="757">Request clipboard data from the client. %TRUE if the request is successful + filename="src/channel-main.c" + line="765">%TRUE if the request is successful a VD_AGENT_CLIPBOARD_SELECTION clipboard + filename="src/channel-main.c" + line="760">a VD_AGENT_CLIPBOARD_SELECTION clipboard the VD_AGENT_CLIPBOARD request type + filename="src/channel-main.c" + line="761">the VD_AGENT_CLIPBOARD request type Notify when the mouse mode has changed. + filename="src/channel-main.c" + line="612">Notify when the mouse mode has changed. Inform when migration is starting. Application wishing to make + filename="src/channel-main.c" + line="820">Inform when migration is starting. Application wishing to make connections themself can set the #SpiceSession:client-sockets to @TRUE, then follow #SpiceSession::channel-new creation, and use spice_channel_open_fd() once the socket is created. @@ -4034,16 +4291,16 @@ use spice_channel_open_fd() once the socket is created. a migration #SpiceSession + filename="src/channel-main.c" + line="823">a migration #SpiceSession This signal is emitted when a new file transfer task has been initiated + filename="src/channel-main.c" + line="842">This signal is emitted when a new file transfer task has been initiated on this channel. Client applications may take a reference on the @task object and use it to monitor the status of the file transfer task. @@ -4052,8 +4309,8 @@ object and use it to monitor the status of the file transfer task. a #SpiceFileTransferTask + filename="src/channel-main.c" + line="845">a #SpiceFileTransferTask @@ -4063,18 +4320,18 @@ object and use it to monitor the status of the file transfer task. c:type="SpiceMainChannelClass" glib:is-gtype-struct-for="MainChannel"> Class structure for #SpiceMainChannel. - + filename="src/channel-main.h" + line="52">Class structure for #SpiceMainChannel. + Parent class. + filename="src/channel-main.h" + line="54">Parent class. - + @@ -4087,7 +4344,7 @@ object and use it to monitor the status of the file transfer task. - + @@ -4101,19 +4358,20 @@ object and use it to monitor the status of the file transfer task. - + disguised="1" + opaque="1"> + - - + + - - + + - + @@ -4122,7 +4380,7 @@ object and use it to monitor the status of the file transfer task. - + @@ -4131,7 +4389,7 @@ object and use it to monitor the status of the file transfer task. - + @@ -4140,7 +4398,7 @@ object and use it to monitor the status of the file transfer task. - + @@ -4149,7 +4407,7 @@ object and use it to monitor the status of the file transfer task. - + @@ -4158,7 +4416,7 @@ object and use it to monitor the status of the file transfer task. - + @@ -4172,11 +4430,11 @@ object and use it to monitor the status of the file transfer task. glib:get-type="spice_playback_channel_get_type" glib:type-struct="PlaybackChannelClass"> The #SpicePlaybackChannel struct is opaque and should not be accessed directly. - + filename="src/channel-playback.h" + line="39">The #SpicePlaybackChannel struct is opaque and should not be accessed directly. + - + @@ -4196,7 +4454,7 @@ object and use it to monitor the status of the file transfer task. - + @@ -4216,7 +4474,7 @@ object and use it to monitor the status of the file transfer task. - + @@ -4228,34 +4486,43 @@ object and use it to monitor the status of the file transfer task. Adjust the multimedia time according to the delay. - + filename="src/channel-playback.c" + line="443">Adjust the multimedia time according to the delay. + a #SpicePlaybackChannel + filename="src/channel-playback.c" + line="445">a #SpicePlaybackChannel the delay in ms + filename="src/channel-playback.c" + line="446">the delay in ms - + - + - + @@ -4270,8 +4537,8 @@ object and use it to monitor the status of the file transfer task. Provide audio data to be played. + filename="src/channel-playback.c" + line="240">Provide audio data to be played. @@ -4281,30 +4548,30 @@ object and use it to monitor the status of the file transfer task. nullable="1" allow-none="1"> pointer to audio data + filename="src/channel-playback.c" + line="243">pointer to audio data size in byte of @data + filename="src/channel-playback.c" + line="244">size in byte of @data Notify when the current playback delay is requested + filename="src/channel-playback.c" + line="275">Notify when the current playback delay is requested Notify when the playback should start, and provide audio format + filename="src/channel-playback.c" + line="218">Notify when the playback should start, and provide audio format characteristics. @@ -4312,28 +4579,28 @@ characteristics. a #SPICE_AUDIO_FMT + filename="src/channel-playback.c" + line="221">a #SPICE_AUDIO_FMT number of channels + filename="src/channel-playback.c" + line="222">number of channels audio rate + filename="src/channel-playback.c" + line="223">audio rate Notify when the playback should stop. + filename="src/channel-playback.c" + line="259">Notify when the playback should stop. @@ -4343,18 +4610,18 @@ characteristics. c:type="SpicePlaybackChannelClass" glib:is-gtype-struct-for="PlaybackChannel"> Class structure for #SpicePlaybackChannel. - + filename="src/channel-playback.h" + line="52">Class structure for #SpicePlaybackChannel. + Parent class. + filename="src/channel-playback.h" + line="54">Parent class. - + @@ -4376,7 +4643,7 @@ characteristics. - + @@ -4398,7 +4665,7 @@ characteristics. - + @@ -4412,8 +4679,9 @@ characteristics. - + disguised="1" + opaque="1"> + glib:get-type="spice_port_channel_get_type" glib:type-struct="PortChannelClass"> The #SpicePortChannel struct is opaque and should not be accessed directly. - + filename="src/channel-port.h" + line="40">The #SpicePortChannel struct is opaque and should not be accessed directly. + Send an event to the port. + filename="src/channel-port.c" + line="384">Send an event to the port. Note: The values SPICE_PORT_EVENT_CLOSED and SPICE_PORT_EVENT_OPENED are managed by the channel connection state. - + a #SpicePortChannel + filename="src/channel-port.c" + line="386">a #SpicePortChannel a SPICE_PORT_EVENT value + filename="src/channel-port.c" + line="387">a SPICE_PORT_EVENT value @@ -4459,26 +4727,26 @@ state. c:identifier="spice_port_channel_write_async" version="0.35"> Request an asynchronous write of count bytes from @buffer into the + filename="src/channel-port.c" + line="285">Request an asynchronous write of count bytes from @buffer into the @port. When the operation is finished @callback will be called. You can then call spice_port_write_finish() to get the result of the operation. - + A #SpicePortChannel + filename="src/channel-port.c" + line="287">A #SpicePortChannel the buffer + filename="src/channel-port.c" + line="288">the buffer containing the data to write @@ -4486,8 +4754,8 @@ containing the data to write the number of bytes to write + filename="src/channel-port.c" + line="290">the number of bytes to write nullable="1" allow-none="1"> optional GCancellable object, NULL to ignore + filename="src/channel-port.c" + line="291">optional GCancellable object, NULL to ignore scope="async" closure="4"> callback to call when the request is satisfied + filename="src/channel-port.c" + line="292">callback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="src/channel-port.c" + line="293">the data to pass to callback function @@ -4526,34 +4794,38 @@ containing the data to write version="0.35" throws="1"> Finishes a port write operation. - + filename="src/channel-port.c" + line="345">Finishes a port write operation. + a #gssize containing the number of bytes written to the stream. + filename="src/channel-port.c" + line="354">a #gssize containing the number of bytes written to the stream. a #SpicePortChannel + filename="src/channel-port.c" + line="347">a #SpicePortChannel a #GAsyncResult + filename="src/channel-port.c" + line="348">a #GAsyncResult - + - + @@ -4564,8 +4836,8 @@ containing the data to write The #SpicePortChannel::port-data signal is emitted when new + filename="src/channel-port.c" + line="148">The #SpicePortChannel::port-data signal is emitted when new port data is received. @@ -4576,22 +4848,22 @@ port data is received. nullable="1" allow-none="1"> the data received + filename="src/channel-port.c" + line="151">the data received number of bytes read + filename="src/channel-port.c" + line="152">number of bytes read The #SpicePortChannel::port-event signal is emitted when new + filename="src/channel-port.c" + line="170">The #SpicePortChannel::port-event signal is emitted when new port event is received. @@ -4599,8 +4871,8 @@ port event is received. the event received + filename="src/channel-port.c" + line="173">the event received @@ -4610,25 +4882,26 @@ port event is received. c:type="SpicePortChannelClass" glib:is-gtype-struct-for="PortChannel"> Class structure for #SpicePortChannel. - + filename="src/channel-port.h" + line="53">Class structure for #SpicePortChannel. + Parent class. + filename="src/channel-port.h" + line="55">Parent class. - + disguised="1" + opaque="1"> + - + @@ -4637,7 +4910,7 @@ port event is received. - + @@ -4646,7 +4919,7 @@ port event is received. - + @@ -4661,26 +4934,26 @@ port event is received. glib:get-type="spice_qmp_port_get_type" glib:type-struct="QmpPortClass"> Opaque data structure. - + filename="src/qmp-port.h" + line="36">Opaque data structure. + Associate a QMP port helper to the given port channel. If there is + filename="src/qmp-port.c" + line="460">Associate a QMP port helper to the given port channel. If there is already a helper associated with the channel, it is simply returned. - + a weak reference to the associated SpiceQmpPort + filename="src/qmp-port.c" + line="467">a weak reference to the associated SpiceQmpPort the QMP port channel + filename="src/qmp-port.c" + line="462">the QMP port channel @@ -4689,17 +4962,17 @@ already a helper associated with the channel, it is simply returned. c:identifier="spice_qmp_port_query_status_async" version="0.36"> Query the run status of all VCPUs. - + filename="src/qmp-port.c" + line="543">Query the run status of all VCPUs. + A #SpiceQmpPort + filename="src/qmp-port.c" + line="545">A #SpiceQmpPort nullable="1" allow-none="1"> A #GCancellable + filename="src/qmp-port.c" + line="546">A #GCancellable scope="async" closure="2"> The async callback. + filename="src/qmp-port.c" + line="547">The async callback. nullable="1" allow-none="1"> The async callback user data. + filename="src/qmp-port.c" + line="548">The async callback user data. @@ -4738,27 +5011,27 @@ already a helper associated with the channel, it is simply returned. version="0.36" throws="1"> Finish the asynchronous status query. - + filename="src/qmp-port.c" + line="571">Finish the asynchronous status query. + The #SpiceQmpStatus result or %NULL, in which case @error + filename="src/qmp-port.c" + line="579">The #SpiceQmpStatus result or %NULL, in which case @error will be set. A #SpiceQmpPort + filename="src/qmp-port.c" + line="573">A #SpiceQmpPort The async #GAsyncResult result + filename="src/qmp-port.c" + line="574">The async #GAsyncResult result @@ -4767,23 +5040,23 @@ will be set. c:identifier="spice_qmp_port_vm_action_async" version="0.36"> Request the VM to perform an action. - + filename="src/qmp-port.c" + line="401">Request the VM to perform an action. + a qmp port helper + filename="src/qmp-port.c" + line="403">a qmp port helper a VM action + filename="src/qmp-port.c" + line="404">a VM action nullable="1" allow-none="1"> a #GCancellable, or %NULL + filename="src/qmp-port.c" + line="405">a #GCancellable, or %NULL scope="async" closure="3"> callback to call when the action is complete + filename="src/qmp-port.c" + line="406">callback to call when the action is complete nullable="1" allow-none="1"> the data to pass to the callback function + filename="src/qmp-port.c" + line="407">the data to pass to the callback function @@ -4822,23 +5095,23 @@ will be set. version="0.36" throws="1"> Finishes asynchronous VM action and returns the result. - + filename="src/qmp-port.c" + line="381">Finishes asynchronous VM action and returns the result. + a qmp port helper + filename="src/qmp-port.c" + line="383">a qmp port helper The async #GAsyncResult result + filename="src/qmp-port.c" + line="384">The async #GAsyncResult result @@ -4849,21 +5122,21 @@ will be set. transfer-ownership="none"> - + Event emitted whenever a QMP event is received. + filename="src/qmp-port.c" + line="291">Event emitted whenever a QMP event is received. the QMP event name + filename="src/qmp-port.c" + line="294">the QMP event name nullable="1" allow-none="1"> the event data json-node, or NULL + filename="src/qmp-port.c" + line="295">the event data json-node, or NULL @@ -4881,57 +5154,58 @@ will be set. - + An action to perform on the VM. - + filename="src/qmp-port.h" + line="45">An action to perform on the VM. + This command will cause the VM process to exit gracefully. + filename="src/qmp-port.h" + line="47">This command will cause the VM process to exit gracefully. Performs a hard reset of the VM. + filename="src/qmp-port.h" + line="48">Performs a hard reset of the VM. Performs a power down operation. + filename="src/qmp-port.h" + line="49">Performs a power down operation. Stop all VCPU execution. + filename="src/qmp-port.h" + line="50">Stop all VCPU execution. Resume all VCPU execution. + filename="src/qmp-port.h" + line="51">Resume all VCPU execution. the last enum value. + filename="src/qmp-port.h" + line="52">the last enum value. glib:get-type="spice_qmp_status_get_type" c:symbol-prefix="qmp_status"> Information about VCPU run state. - + filename="src/qmp-port.h" + line="68">Information about VCPU run state. + the structure version + filename="src/qmp-port.h" + line="70">the structure version true if all VCPUs are runnable, false if not runnable + filename="src/qmp-port.h" + line="71">true if all VCPUs are runnable, false if not runnable true if VCPUs are in single-step mode + filename="src/qmp-port.h" + line="72">true if VCPUs are in single-step mode the virtual machine run state + filename="src/qmp-port.h" + line="73">the virtual machine run state References a @status. - + filename="src/qmp-port.c" + line="491">References a @status. + The same @status + filename="src/qmp-port.c" + line="497">The same @status a #SpiceQmpStatus + filename="src/qmp-port.c" + line="493">a #SpiceQmpStatus @@ -4995,17 +5269,17 @@ will be set. c:identifier="spice_qmp_status_unref" version="0.36"> Removes a reference from the given @status. - + filename="src/qmp-port.c" + line="511">Removes a reference from the given @status. + a #SpiceQmpStatus + filename="src/qmp-port.c" + line="513">a #SpiceQmpStatus @@ -5014,7 +5288,7 @@ will be set. - + @@ -5023,7 +5297,7 @@ will be set. - + @@ -5032,7 +5306,7 @@ will be set. - + @@ -5046,11 +5320,11 @@ will be set. glib:get-type="spice_record_channel_get_type" glib:type-struct="RecordChannelClass"> The #SpiceRecordChannel struct is opaque and should not be accessed directly. - + filename="src/channel-record.h" + line="39">The #SpiceRecordChannel struct is opaque and should not be accessed directly. + - + @@ -5070,7 +5344,7 @@ will be set. - + @@ -5090,7 +5364,7 @@ will be set. - + @@ -5104,17 +5378,17 @@ will be set. c:identifier="spice_record_channel_send_data" version="0.35"> Send recorded PCM data to the guest. - + filename="src/channel-record.c" + line="311">Send recorded PCM data to the guest. + a #SpiceRecordChannel + filename="src/channel-record.c" + line="313">a #SpiceRecordChannel nullable="1" allow-none="1"> PCM data + filename="src/channel-record.c" + line="314">PCM data size of @data + filename="src/channel-record.c" + line="315">size of @data stream timestamp + filename="src/channel-record.c" + line="316">stream timestamp - + - + @@ -5157,8 +5437,8 @@ will be set. Notify when the recording should start, and provide audio format + filename="src/channel-record.c" + line="205">Notify when the recording should start, and provide audio format characteristics. @@ -5166,28 +5446,28 @@ characteristics. a #SPICE_AUDIO_FMT + filename="src/channel-record.c" + line="208">a #SPICE_AUDIO_FMT number of channels + filename="src/channel-record.c" + line="209">number of channels audio rate + filename="src/channel-record.c" + line="210">audio rate Notify when the recording should stop. + filename="src/channel-record.c" + line="226">Notify when the recording should stop. @@ -5197,18 +5477,18 @@ characteristics. c:type="SpiceRecordChannelClass" glib:is-gtype-struct-for="RecordChannel"> Class structure for #SpiceRecordChannel. - + filename="src/channel-record.h" + line="52">Class structure for #SpiceRecordChannel. + Parent class. + filename="src/channel-record.h" + line="54">Parent class. - + @@ -5230,7 +5510,7 @@ characteristics. - + @@ -5252,7 +5532,7 @@ characteristics. - + @@ -5266,13 +5546,14 @@ characteristics. - + disguised="1" + opaque="1"> + - + @@ -5281,7 +5562,7 @@ characteristics. - + @@ -5290,7 +5571,7 @@ characteristics. - + @@ -5299,7 +5580,7 @@ characteristics. - + @@ -5308,7 +5589,7 @@ characteristics. - + @@ -5317,7 +5598,7 @@ characteristics. - + @@ -5326,7 +5607,7 @@ characteristics. - + @@ -5335,7 +5616,7 @@ characteristics. - + @@ -5344,7 +5625,7 @@ characteristics. - + @@ -5358,23 +5639,23 @@ characteristics. glib:get-type="spice_session_get_type" glib:type-struct="SessionClass"> The #SpiceSession struct is opaque and should not be accessed directly. - + filename="src/spice-session.h" + line="71">The #SpiceSession struct is opaque and should not be accessed directly. + Creates a new Spice session. - + filename="src/spice-session.c" + line="1565">Creates a new Spice session. + a new #SpiceSession + filename="src/spice-session.c" + line="1570">a new #SpiceSession - + @@ -5388,7 +5669,7 @@ characteristics. - + @@ -5403,14 +5684,14 @@ characteristics. Open the session using the #SpiceSession:host and + filename="src/spice-session.c" + line="1648">Open the session using the #SpiceSession:host and #SpiceSession:port. - + %FALSE if the session state is invalid for connection + filename="src/spice-session.c" + line="1655">%FALSE if the session state is invalid for connection request. %TRUE if the connection is initiated. To know whether the connection is established, you must watch for channels creation (#SpiceSession::channel-new) and the channels state @@ -5420,38 +5701,38 @@ connection is established, you must watch for channels creation a #SpiceSession + filename="src/spice-session.c" + line="1650">a #SpiceSession Disconnect the @session, and destroy all channels. - + filename="src/spice-session.c" + line="2013">Disconnect the @session, and destroy all channels. + a #SpiceSession + filename="src/spice-session.c" + line="2015">a #SpiceSession Get the list of current channels associated with this @session. - + filename="src/spice-session.c" + line="2035">Get the list of current channels associated with this @session. + a #GList + filename="src/spice-session.c" + line="2041">a #GList of unowned #SpiceChannel channels. @@ -5460,8 +5741,8 @@ connection is established, you must watch for channels creation a #SpiceSession + filename="src/spice-session.c" + line="2037">a #SpiceSession @@ -5470,40 +5751,42 @@ connection is established, you must watch for channels creation c:identifier="spice_session_get_proxy_uri" version="0.24"> Gets the @session proxy uri. - + filename="src/spice-session.c" + line="2724">Gets the @session proxy uri. + the session proxy #SpiceURI or %NULL. + filename="src/spice-session.c" + line="2730">the session proxy #SpiceURI or %NULL. a #SpiceSession + filename="src/spice-session.c" + line="2726">a #SpiceSession - + Checks whether the @session is read-only. - + filename="src/spice-session.c" + line="1986">Checks whether the @session is read-only. + whether the @session is in read-only mode. + filename="src/spice-session.c" + line="1992">whether the @session is in read-only mode. a #SpiceSession + filename="src/spice-session.c" + line="1988">a #SpiceSession @@ -5511,27 +5794,27 @@ connection is established, you must watch for channels creation See if there is a @type channel in the channels associated with this + filename="src/spice-session.c" + line="2052">See if there is a @type channel in the channels associated with this @session. - + TRUE if a @type channel is available otherwise FALSE. + filename="src/spice-session.c" + line="2060">TRUE if a @type channel is available otherwise FALSE. a #SpiceSession + filename="src/spice-session.c" + line="2054">a #SpiceSession a #SpiceChannel:channel-type + filename="src/spice-session.c" + line="2055">a #SpiceChannel:channel-type @@ -5540,31 +5823,31 @@ connection is established, you must watch for channels creation c:identifier="spice_session_is_for_migration" version="0.27"> During seamless migration, channels may be created to establish a + filename="src/spice-session.c" + line="2890">During seamless migration, channels may be created to establish a connection with the target, but they are temporary and should only handle migration steps. In order to avoid other interactions with the client, channels should check this value. - + %TRUE if the session is a copy created during migration + filename="src/spice-session.c" + line="2899">%TRUE if the session is a copy created during migration a Spice session + filename="src/spice-session.c" + line="2892">a Spice session Open the session using the provided @fd socket file + filename="src/spice-session.c" + line="1681">Open the session using the provided @fd socket file descriptor. This is useful if you create the fd yourself, for example to setup a SSH tunnel. @@ -5578,24 +5861,24 @@ If @fd is -1, a valid fd will be requested later via the SpiceChannel::open-fd signal. Typically, you would want to just pass -1 as @fd this call since you will have to hook to SpiceChannel::open-fd signal anyway. - + %TRUE on success. + filename="src/spice-session.c" + line="1701">%TRUE on success. a #SpiceSession + filename="src/spice-session.c" + line="1683">a #SpiceSession a file descriptor (socket) or -1 + filename="src/spice-session.c" + line="1684">a file descriptor (socket) or -1 @@ -5605,8 +5888,8 @@ anyway. writable="1" transfer-ownership="none"> CA certificates in PEM format. The text data can contain + filename="src/spice-session.c" + line="1255">CA certificates in PEM format. The text data can contain several CA certificates identified by: -----BEGIN CERTIFICATE----- @@ -5616,29 +5899,42 @@ several CA certificates identified by: - + File holding the CA certificates for the host the client is + filename="src/spice-session.c" + line="974">File holding the CA certificates for the host the client is connecting to + transfer-ownership="none" + default-value="0"> Images cache size. If 0, don't set. + filename="src/spice-session.c" + line="1379">Images cache size. If 0, don't set. - + - + - + deprecated="1" deprecated-version="0.37" writable="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="0"> Display color depth to set on new display channels. If 0, don't set. + filename="src/spice-session.c" + line="1127">Display color depth to set on new display channels. If 0, don't set. Deprecated due lack of support in drivers, only Windows 7 and older. This option is currently ignored. @@ -5659,8 +5956,8 @@ This option is currently ignored. writable="1" transfer-ownership="none"> A string array of effects to disable. The settings will + filename="src/spice-session.c" + line="1108">A string array of effects to disable. The settings will be applied on new display channels. The following effets can be disabled "wallpaper", "font-smooth", "animation", and "all", which will disable all the effects. If NULL, don't apply changes. @@ -5672,20 +5969,22 @@ which will disable all the effects. If NULL, don't apply changes. version="0.8" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="TRUE"> If set to TRUE, the audio channels will be enabled for + filename="src/spice-session.c" + line="1164">If set to TRUE, the audio channels will be enabled for playback and recording. + transfer-ownership="none" + default-value="FALSE"> If set to TRUE, the smartcard channel will be enabled and smartcard + filename="src/spice-session.c" + line="1147">If set to TRUE, the smartcard channel will be enabled and smartcard events will be forwarded to the guest @@ -5693,10 +5992,11 @@ events will be forwarded to the guest version="0.8" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="TRUE"> If set to TRUE, the usbredir channel will be enabled and USB devices + filename="src/spice-session.c" + line="1220">If set to TRUE, the usbredir channel will be enabled and USB devices can be redirected to the guest @@ -5704,10 +6004,11 @@ can be redirected to the guest version="0.36" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="TRUE"> Whether to enable gl-scanout (Unix only). Set to TRUE by + filename="src/spice-session.c" + line="1532">Whether to enable gl-scanout (Unix only). Set to TRUE by default on EGL-enabled host, unless SPICE_DISABLE_GL_SCANOUT environment variable is set. @@ -5715,78 +6016,95 @@ environment variable is set. + transfer-ownership="none" + default-value="0"> Glz window size. If 0, don't set. + filename="src/spice-session.c" + line="1395">Glz window size. If 0, don't set. + transfer-ownership="none" + default-value="localhost"> URL of the SPICE host to connect to + filename="src/spice-session.c" + line="881">URL of the SPICE host to connect to + transfer-ownership="none" + default-value="FALSE"> - + #SpiceSessionMigration bit field indicating if a migration is in + filename="src/spice-session.c" + line="1091">#SpiceSessionMigration bit field indicating if a migration is in progress - + Spice server name. + filename="src/spice-session.c" + line="1411">Spice server name. - + TLS password to use + filename="src/spice-session.c" + line="959">TLS password to use - + Port to connect to for unencrypted sessions + filename="src/spice-session.c" + line="914">Port to connect to for unencrypted sessions + transfer-ownership="none" + default-value="SPICE_IMAGE_COMPRESSION_INVALID"> The image compression algorithm the client prefers to use. It is + filename="src/spice-session.c" + line="1514">The image compression algorithm the client prefers to use. It is reported to the server. + transfer-ownership="none" + default-value="2"> Version of the SPICE protocol to use + filename="src/spice-session.c" + line="1003">Version of the SPICE protocol to use + transfer-ownership="none" + default-value="NULL"> URI to the proxy server to use when doing network connection. + filename="src/spice-session.c" + line="1442">URI to the proxy server to use when doing network connection. of the form <![CDATA[ [protocol://]<host>[:port] ]]> @@ -5799,10 +6117,12 @@ of the form <![CDATA[ [protocol://]<host>[:port] ]]> version="0.8" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + getter="get_read_only" + default-value="FALSE"> Whether this connection is read-only mode. + filename="src/spice-session.c" + line="1363">Whether this connection is read-only mode. writable="1" transfer-ownership="none"> A string array of channel types to be secured. + filename="src/spice-session.c" + line="1276">A string array of channel types to be secured. @@ -5820,20 +6140,22 @@ of the form <![CDATA[ [protocol://]<host>[:port] ]]> version="0.28" writable="1" construct="1" - transfer-ownership="none"> + transfer-ownership="none" + default-value="FALSE"> Whether to share the directory read-only. + filename="src/spice-session.c" + line="1476">Whether to share the directory read-only. + transfer-ownership="none" + default-value="NULL"> Location of the shared directory + filename="src/spice-session.c" + line="1459">Location of the shared directory writable="1" transfer-ownership="none"> This property is used when one wants to simulate a smartcard with no + filename="src/spice-session.c" + line="1181">This property is used when one wants to simulate a smartcard with no hardware smartcard reader. If it's set to a NULL-terminated string array containing the names of 3 valid certificates, these will be used to simulate a smartcard in the guest @@ -5854,58 +6176,80 @@ See also spice_smartcard_manager_insert_card() + transfer-ownership="none" + default-value="NULL"> Path to the NSS certificate database containing the certificates to + filename="src/spice-session.c" + line="1202">Path to the NSS certificate database containing the certificates to use to simulate a software smartcard - + Port to connect to for TLS sessions + filename="src/spice-session.c" + line="929">Port to connect to for TLS sessions + transfer-ownership="none" + default-value="NULL"> Path of the Unix socket to connect to + filename="src/spice-session.c" + line="897">Path of the Unix socket to connect to - + URI of the SPICE host to connect to. The URI is of the form + filename="src/spice-session.c" + line="1019">URI of the SPICE host to connect to. The URI is of the form spice://hostname?port=XXX or spice://hostname?tls_port=XXX - + Username to use + filename="src/spice-session.c" + line="944">Username to use Spice server uuid. + filename="src/spice-session.c" + line="1427">Spice server uuid. + transfer-ownership="none" + default-value="SPICE_SESSION_VERIFY_HOSTNAME"> #SpiceSessionVerify bit field indicating which parts of the peer + filename="src/spice-session.c" + line="1074">#SpiceSessionVerify bit field indicating which parts of the peer certificate should be checked + + Phodav server that is internally used by #SpiceSession to make +#SpiceSession:shared-dir available to the host. + + @@ -5914,48 +6258,48 @@ certificate should be checked The #SpiceSession::channel-destroy signal is emitted each time a #SpiceChannel is destroyed. + filename="src/spice-session.c" + line="1311">The #SpiceSession::channel-destroy signal is emitted each time a #SpiceChannel is destroyed. the destroyed #SpiceChannel + filename="src/spice-session.c" + line="1314">the destroyed #SpiceChannel The #SpiceSession::channel-new signal is emitted each time a #SpiceChannel is created. + filename="src/spice-session.c" + line="1293">The #SpiceSession::channel-new signal is emitted each time a #SpiceChannel is created. the new #SpiceChannel + filename="src/spice-session.c" + line="1296">the new #SpiceChannel The #SpiceSession::disconnected signal is emitted when all channels have been destroyed. + filename="src/spice-session.c" + line="1329">The #SpiceSession::disconnected signal is emitted when all channels have been destroyed. The #SpiceSession::mm-time-reset is emitted when we identify discontinuity in mm-time + filename="src/spice-session.c" + line="1346">The #SpiceSession::mm-time-reset is emitted when we identify discontinuity in mm-time Since 0.20 @@ -5967,18 +6311,18 @@ Since 0.20 c:type="SpiceSessionClass" glib:is-gtype-struct-for="Session"> Class structure for #SpiceSession. - + filename="src/spice-session.h" + line="83">Class structure for #SpiceSession. + Parent class. + filename="src/spice-session.h" + line="85">Parent class. - + @@ -5994,7 +6338,7 @@ Since 0.20 - + @@ -6009,8 +6353,8 @@ Since 0.20 - - + + @@ -6019,74 +6363,84 @@ Since 0.20 glib:get-type="spice_session_migration_get_type" c:type="SpiceSessionMigration"> Session migration state. + filename="src/spice-session.h" + line="55">Session migration state. + glib:nick="none" + glib:name="SPICE_SESSION_MIGRATION_NONE"> no migration going on + filename="src/spice-session.h" + line="57">no migration going on + glib:nick="switching" + glib:name="SPICE_SESSION_MIGRATION_SWITCHING"> the session is switching host (destroy and reconnect) + filename="src/spice-session.h" + line="58">the session is switching host (destroy and reconnect) + glib:nick="migrating" + glib:name="SPICE_SESSION_MIGRATION_MIGRATING"> the session is migrating seamlessly (reconnect) + filename="src/spice-session.h" + line="59">the session is migrating seamlessly (reconnect) + glib:nick="connecting" + glib:name="SPICE_SESSION_MIGRATION_CONNECTING"> the migration is connecting to destination (Since: 0.27) + filename="src/spice-session.h" + line="60">the migration is connecting to destination (Since: 0.27) - - + + Peer certificate verification parameters flags. + filename="src/spice-session.h" + line="41">Peer certificate verification parameters flags. + glib:nick="pubkey" + glib:name="SPICE_SESSION_VERIFY_PUBKEY"> verify certificate public key matching + filename="src/spice-session.h" + line="43">verify certificate public key matching + glib:nick="hostname" + glib:name="SPICE_SESSION_VERIFY_HOSTNAME"> verify certificate hostname matching + filename="src/spice-session.h" + line="44">verify certificate hostname matching + glib:nick="subject" + glib:name="SPICE_SESSION_VERIFY_SUBJECT"> verify certificate subject matching + filename="src/spice-session.h" + line="45">verify certificate subject matching glib:get-type="spice_smartcard_channel_get_type" glib:type-struct="SmartcardChannelClass"> The #SpiceSmartcardChannel struct is opaque and should not be accessed directly. - + filename="src/channel-smartcard.h" + line="39">The #SpiceSmartcardChannel struct is opaque and should not be accessed directly. + @@ -6112,20 +6466,21 @@ Since 0.20 c:type="SpiceSmartcardChannelClass" glib:is-gtype-struct-for="SmartcardChannel"> Class structure for #SpiceSmartcardChannel. - + filename="src/channel-smartcard.h" + line="52">Class structure for #SpiceSmartcardChannel. + Parent class. + filename="src/channel-smartcard.h" + line="54">Parent class. - + disguised="1" + opaque="1"> + glib:get-type="spice_smartcard_manager_get_type" glib:type-struct="SmartcardManagerClass"> The #SpiceSmartcardManager struct is opaque and should not be accessed directly. - + filename="src/smartcard-manager.h" + line="49">The #SpiceSmartcardManager struct is opaque and should not be accessed directly. + #SpiceSmartcardManager is a singleton, use this function to get a pointer + filename="src/smartcard-manager.c" + line="223">#SpiceSmartcardManager is a singleton, use this function to get a pointer to it. A new SpiceSmartcardManager instance will be created the first time this function is called - + a weak reference to the #SpiceSmartcardManager + filename="src/smartcard-manager.c" + line="230">a weak reference to the #SpiceSmartcardManager - + @@ -6167,7 +6522,7 @@ time this function is called - + @@ -6181,7 +6536,7 @@ time this function is called - + @@ -6195,7 +6550,7 @@ time this function is called - + @@ -6212,14 +6567,14 @@ time this function is called c:identifier="spice_smartcard_manager_get_readers" version="0.20"> Gets the list of smartcard readers that are currently available, they + filename="src/smartcard-manager.c" + line="588">Gets the list of smartcard readers that are currently available, they can be either software (emulated) readers, or hardware ones. - + a newly + filename="src/smartcard-manager.c" + line="595">a newly allocated list of SpiceSmartcardReader instances, or NULL if none were found. When no longer needed, the list must be freed after unreferencing its elements with g_boxed_free() @@ -6230,8 +6585,8 @@ its elements with g_boxed_free() a #SpiceSmartcardManager + filename="src/smartcard-manager.c" + line="590">a #SpiceSmartcardManager @@ -6240,25 +6595,25 @@ its elements with g_boxed_free() c:identifier="spice_smartcard_manager_insert_card" version="0.20"> Simulates the insertion of a smartcard in the guest. Valid certificates + filename="src/smartcard-manager.c" + line="628">Simulates the insertion of a smartcard in the guest. Valid certificates must have been set in #SpiceSession:smartcard-certificates for software smartcard support to work. At the moment, only one software smartcard reader is supported, that's why there is no parameter to indicate which reader to insert the card in. - + TRUE if smartcard insertion was successfully simulated, FALSE + filename="src/smartcard-manager.c" + line="638">TRUE if smartcard insertion was successfully simulated, FALSE if this failed, or if software smartcard support isn't enabled. a #SpiceSmartcardManager + filename="src/smartcard-manager.c" + line="630">a #SpiceSmartcardManager @@ -6267,23 +6622,23 @@ if this failed, or if software smartcard support isn't enabled. c:identifier="spice_smartcard_manager_remove_card" version="0.20"> Simulates the removal of a smartcard in the guest. At the moment, only + filename="src/smartcard-manager.c" + line="654">Simulates the removal of a smartcard in the guest. At the moment, only one software smartcard reader is supported, that's why there is no parameter to indicate which reader to insert the card in. - + TRUE if smartcard removal was successfully simulated, FALSE + filename="src/smartcard-manager.c" + line="662">TRUE if smartcard removal was successfully simulated, FALSE if this failed, or if software smartcard support isn't enabled. a #SpiceSmartcardManager + filename="src/smartcard-manager.c" + line="656">a #SpiceSmartcardManager @@ -6297,8 +6652,8 @@ if this failed, or if software smartcard support isn't enabled. The #SpiceSmartcardManager::card-inserted signal is emitted whenever + filename="src/smartcard-manager.c" + line="169">The #SpiceSmartcardManager::card-inserted signal is emitted whenever a smartcard is inserted in a reader @@ -6306,8 +6661,8 @@ a smartcard is inserted in a reader #VReader boxed object corresponding to the reader a new + filename="src/smartcard-manager.c" + line="172">#VReader boxed object corresponding to the reader a new card was inserted in @@ -6315,8 +6670,8 @@ card was inserted in The #SpiceSmartcardManager::card-removed signal is emitted whenever + filename="src/smartcard-manager.c" + line="189">The #SpiceSmartcardManager::card-removed signal is emitted whenever a smartcard was removed from a reader. @@ -6324,8 +6679,8 @@ a smartcard was removed from a reader. #VReader boxed object corresponding to the reader a card + filename="src/smartcard-manager.c" + line="192">#VReader boxed object corresponding to the reader a card was removed from @@ -6333,8 +6688,8 @@ was removed from The #SpiceSmartcardManager::reader-added signal is emitted whenever + filename="src/smartcard-manager.c" + line="131">The #SpiceSmartcardManager::reader-added signal is emitted whenever a new smartcard reader (software or hardware) has been plugged in. @@ -6342,16 +6697,16 @@ a new smartcard reader (software or hardware) has been plugged in. #VReader boxed object corresponding to the added reader + filename="src/smartcard-manager.c" + line="134">#VReader boxed object corresponding to the added reader The #SpiceSmartcardManager::reader-removed signal is emitted whenever + filename="src/smartcard-manager.c" + line="150">The #SpiceSmartcardManager::reader-removed signal is emitted whenever a smartcard reader (software or hardware) has been removed. @@ -6359,8 +6714,8 @@ a smartcard reader (software or hardware) has been removed. #VReader boxed object corresponding to the removed reader + filename="src/smartcard-manager.c" + line="153">#VReader boxed object corresponding to the removed reader @@ -6370,18 +6725,18 @@ a smartcard reader (software or hardware) has been removed. c:type="SpiceSmartcardManagerClass" glib:is-gtype-struct-for="SmartcardManager"> Class structure for #SpiceSmartcardManager. - + filename="src/smartcard-manager.h" + line="63">Class structure for #SpiceSmartcardManager. + Parent class. + filename="src/smartcard-manager.h" + line="65">Parent class. - + @@ -6397,7 +6752,7 @@ a smartcard reader (software or hardware) has been removed. - + @@ -6413,7 +6768,7 @@ a smartcard reader (software or hardware) has been removed. - + @@ -6429,7 +6784,7 @@ a smartcard reader (software or hardware) has been removed. - + @@ -6444,41 +6799,45 @@ a smartcard reader (software or hardware) has been removed. - - + + - + disguised="1" + opaque="1"> + - + The #SpiceSmartcardReader struct is opaque and cannot be accessed directly. - + filename="src/smartcard-manager.h" + line="42">The #SpiceSmartcardReader struct is opaque and cannot be accessed directly. + Simulates insertion of a smartcard in the software smartcard reader + filename="src/smartcard-manager.c" + line="544">Simulates insertion of a smartcard in the software smartcard reader @reader. If @reader is not a software smartcard reader, FALSE will be returned. - + TRUE if insertion of a card was successfully simulated, FALSE + filename="src/smartcard-manager.c" + line="552">TRUE if insertion of a card was successfully simulated, FALSE otherwise a #SpiceSmartcardReader + filename="src/smartcard-manager.c" + line="546">a #SpiceSmartcardReader @@ -6486,21 +6845,21 @@ otherwise Tests if @reader is a software (emulated) smartcard reader. - + filename="src/smartcard-manager.c" + line="529">Tests if @reader is a software (emulated) smartcard reader. + TRUE if @reader is a software (emulated) smartcard reader, + filename="src/smartcard-manager.c" + line="535">TRUE if @reader is a software (emulated) smartcard reader, FALSE otherwise a #SpiceSmartcardReader + filename="src/smartcard-manager.c" + line="531">a #SpiceSmartcardReader @@ -6508,23 +6867,23 @@ FALSE otherwise Simulates removal of a smartcard from the software smartcard reader + filename="src/smartcard-manager.c" + line="566">Simulates removal of a smartcard from the software smartcard reader @reader. If @reader is not a software smartcard reader, FALSE will be returned. - + TRUE if removal of a card was successfully simulated, FALSE + filename="src/smartcard-manager.c" + line="574">TRUE if removal of a card was successfully simulated, FALSE otherwise a #SpiceSmartcardReader + filename="src/smartcard-manager.c" + line="568">a #SpiceSmartcardReader @@ -6538,11 +6897,13 @@ otherwise glib:get-type="spice_uri_get_type" glib:type-struct="URIClass"> The #SpiceURI struct is opaque and cannot be accessed directly. - - - + filename="src/spice-uri.h" + line="35">The #SpiceURI struct is opaque and cannot be accessed directly. + + + @@ -6552,8 +6913,10 @@ otherwise - - + + @@ -6563,8 +6926,10 @@ otherwise - - + + @@ -6574,8 +6939,10 @@ otherwise - - + + @@ -6585,8 +6952,10 @@ otherwise - - + + @@ -6596,8 +6965,10 @@ otherwise - - + + @@ -6610,8 +6981,10 @@ otherwise - - + + @@ -6624,8 +6997,10 @@ otherwise - - + + @@ -6638,8 +7013,10 @@ otherwise - - + + @@ -6652,8 +7029,10 @@ otherwise - - + + @@ -6667,7 +7046,7 @@ otherwise - + @@ -6677,39 +7056,68 @@ otherwise - + - + - + - + - + The #SpiceURIClass struct is opaque and cannot be accessed directly. + filename="src/spice-uri.h" + line="42">The #SpiceURIClass struct is opaque and cannot be accessed directly. It is class structure for #SpiceURI. - + - - + + - + @@ -6718,7 +7126,7 @@ It is class structure for #SpiceURI. - + @@ -6727,7 +7135,7 @@ It is class structure for #SpiceURI. - + @@ -6736,7 +7144,7 @@ It is class structure for #SpiceURI. - + @@ -6745,7 +7153,7 @@ It is class structure for #SpiceURI. - + @@ -6754,7 +7162,7 @@ It is class structure for #SpiceURI. - + @@ -6763,7 +7171,7 @@ It is class structure for #SpiceURI. - + @@ -6772,7 +7180,7 @@ It is class structure for #SpiceURI. - + @@ -6780,18 +7188,19 @@ It is class structure for #SpiceURI. The #SpiceUsbDevice struct is opaque and cannot be accessed directly. - + filename="src/usb-device-manager.h" + line="45">The #SpiceUsbDevice struct is opaque and cannot be accessed directly. + Get a string describing the device which is suitable as a description of + filename="src/usb-device-manager.c" + line="1433">Get a string describing the device which is suitable as a description of the device for the end user. The returned string should be freed with g_free() when no longer needed. @@ -6803,18 +7212,18 @@ The @format positional parameters are the following: 5. \%d address (the default format string is "\%s \%s \%s at \%d-\%d") - + a newly-allocated string holding the description, or %NULL if failed + filename="src/usb-device-manager.c" + line="1452">a newly-allocated string holding the description, or %NULL if failed #SpiceUsbDevice to get the description of + filename="src/usb-device-manager.c" + line="1435">#SpiceUsbDevice to get the description of an optional printf() format string with + filename="src/usb-device-manager.c" + line="1436">an optional printf() format string with positional parameters @@ -6833,20 +7242,20 @@ positional parameters c:identifier="spice_usb_device_get_libusb_device" version="0.27"> Finds the %libusb_device associated with the @device. - + filename="src/usb-device-manager.c" + line="621">Finds the %libusb_device associated with the @device. + the %libusb_device associated to %SpiceUsbDevice. + filename="src/usb-device-manager.c" + line="627">the %libusb_device associated to %SpiceUsbDevice. #SpiceUsbDevice to get the descriptor information of + filename="src/usb-device-manager.c" + line="623">#SpiceUsbDevice to get the descriptor information of @@ -6860,39 +7269,39 @@ positional parameters glib:get-type="spice_usb_device_manager_get_type" glib:type-struct="UsbDeviceManagerClass"> The #SpiceUsbDeviceManager struct is opaque and should not be accessed directly. - + filename="src/usb-device-manager.h" + line="52">The #SpiceUsbDeviceManager struct is opaque and should not be accessed directly. + Gets the #SpiceUsbDeviceManager associated with the passed in #SpiceSession. + filename="src/spice-session.c" + line="2778">Gets the #SpiceUsbDeviceManager associated with the passed in #SpiceSession. A new #SpiceUsbDeviceManager instance will be created the first time this function is called for a certain #SpiceSession. Note that this function returns a weak reference, which should not be used after the #SpiceSession itself has been unref-ed by the caller. - + a weak reference to the #SpiceUsbDeviceManager associated with the passed in #SpiceSession + filename="src/spice-session.c" + line="2790">a weak reference to the #SpiceUsbDeviceManager associated with the passed in #SpiceSession #SpiceSession for which to get the #SpiceUsbDeviceManager + filename="src/spice-session.c" + line="2780">#SpiceSession for which to get the #SpiceUsbDeviceManager - + @@ -6909,7 +7318,7 @@ after the #SpiceSession itself has been unref-ed by the caller. - + @@ -6923,7 +7332,7 @@ after the #SpiceSession itself has been unref-ed by the caller. - + @@ -6940,7 +7349,7 @@ after the #SpiceSession itself has been unref-ed by the caller. - + @@ -6953,30 +7362,59 @@ after the #SpiceSession itself has been unref-ed by the caller. + + Allocates a SpiceUsbDevice instance for the specified file descriptor. + + + an allocated SpiceUsbDevice instance or %NULL in case of failure. + + + + + the #SpiceUsbDeviceManager manager. + + + + an open file descriptor for the USB device. + + + + Checks whether it is possible to redirect the @device. - + filename="src/usb-device-manager.c" + line="1348">Checks whether it is possible to redirect the @device. + %TRUE if @device can be redirected + filename="src/usb-device-manager.c" + line="1356">%TRUE if @device can be redirected - + the #SpiceUsbDeviceManager manager + filename="src/usb-device-manager.c" + line="1350">the #SpiceUsbDeviceManager manager a #SpiceUsbDevice to disconnect + filename="src/usb-device-manager.c" + line="1351">a #SpiceUsbDevice to disconnect @@ -6984,25 +7422,25 @@ after the #SpiceSession itself has been unref-ed by the caller. Asynchronously connects the @device. When completed, @callback will be called. + filename="src/usb-device-manager.c" + line="1143">Asynchronously connects the @device. When completed, @callback will be called. Then it is possible to call spice_usb_device_manager_connect_device_finish() to get the result of the operation. - + - + a #SpiceUsbDeviceManager. + filename="src/usb-device-manager.c" + line="1145">a #SpiceUsbDeviceManager. a #SpiceUsbDevice to redirect + filename="src/usb-device-manager.c" + line="1146">a #SpiceUsbDevice to redirect nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="src/usb-device-manager.c" + line="1147">optional #GCancellable object, %NULL to ignore scope="async" closure="3"> a #GAsyncReadyCallback to call when the request is satisfied + filename="src/usb-device-manager.c" + line="1148">a #GAsyncReadyCallback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="src/usb-device-manager.c" + line="1149">the data to pass to callback function @@ -7040,50 +7478,79 @@ to get the result of the operation. c:identifier="spice_usb_device_manager_connect_device_finish" throws="1"> Finishes an async operation. See spice_usb_device_manager_connect_device_async(). - + filename="src/usb-device-manager.c" + line="1177">Finishes an async operation. See spice_usb_device_manager_connect_device_async(). + %TRUE if connection is successful + filename="src/usb-device-manager.c" + line="1185">%TRUE if connection is successful - + a #SpiceUsbDeviceManager. + filename="src/usb-device-manager.c" + line="1179">a #SpiceUsbDeviceManager. a #GAsyncResult + filename="src/usb-device-manager.c" + line="1180">a #GAsyncResult + + Creates a new shared CD device based on a disk image file +or a physical CD device. + + + %TRUE if device created successfully + + + + + a #SpiceUsbDeviceManager + + + + image or device path + + + + Disconnects the @device. - + filename="src/usb-device-manager.c" + line="1265">Disconnects the @device. + the #SpiceUsbDeviceManager manager + filename="src/usb-device-manager.c" + line="1267">the #SpiceUsbDeviceManager manager a #SpiceUsbDevice to disconnect + filename="src/usb-device-manager.c" + line="1268">a #SpiceUsbDevice to disconnect @@ -7092,25 +7559,25 @@ to get the result of the operation. c:identifier="spice_usb_device_manager_disconnect_device_async" version="0.32"> Asynchronously disconnects the @device. When completed, @callback will be called. + filename="src/usb-device-manager.c" + line="1305">Asynchronously disconnects the @device. When completed, @callback will be called. Then it is possible to call spice_usb_device_manager_disconnect_device_finish() to get the result of the operation. - + - + the #SpiceUsbDeviceManager manager. + filename="src/usb-device-manager.c" + line="1307">the #SpiceUsbDeviceManager manager. a connected #SpiceUsbDevice to disconnect. + filename="src/usb-device-manager.c" + line="1308">a connected #SpiceUsbDevice to disconnect. nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore. + filename="src/usb-device-manager.c" + line="1309">optional #GCancellable object, %NULL to ignore. scope="async" closure="3"> a #GAsyncReadyCallback to call when the request is satisfied. + filename="src/usb-device-manager.c" + line="1310">a #GAsyncReadyCallback to call when the request is satisfied. nullable="1" allow-none="1"> the data to pass to @callback. + filename="src/usb-device-manager.c" + line="1311">the data to pass to @callback. @@ -7148,26 +7615,26 @@ to get the result of the operation. c:identifier="spice_usb_device_manager_disconnect_device_finish" throws="1"> Finishes an async operation. See spice_usb_device_manager_disconnect_device_async(). - + filename="src/usb-device-manager.c" + line="1199">Finishes an async operation. See spice_usb_device_manager_disconnect_device_async(). + %TRUE if disconnection is successful + filename="src/usb-device-manager.c" + line="1207">%TRUE if disconnection is successful - + a #SpiceUsbDeviceManager. + filename="src/usb-device-manager.c" + line="1201">a #SpiceUsbDeviceManager. a #GAsyncResult + filename="src/usb-device-manager.c" + line="1202">a #GAsyncResult @@ -7175,13 +7642,13 @@ to get the result of the operation. Finds devices associated with the @manager - + filename="src/usb-device-manager.c" + line="1048">Finds devices associated with the @manager + a %GPtrArray array of %SpiceUsbDevice + filename="src/usb-device-manager.c" + line="1054">a %GPtrArray array of %SpiceUsbDevice @@ -7189,8 +7656,8 @@ to get the result of the operation. the #SpiceUsbDeviceManager manager + filename="src/usb-device-manager.c" + line="1050">the #SpiceUsbDeviceManager manager @@ -7199,13 +7666,13 @@ to get the result of the operation. c:identifier="spice_usb_device_manager_get_devices_with_filter" version="0.20"> Finds devices associated with the @manager complying with the @filter - + filename="src/usb-device-manager.c" + line="988">Finds devices associated with the @manager complying with the @filter + a + filename="src/usb-device-manager.c" + line="997">a %GPtrArray array of %SpiceUsbDevice @@ -7214,8 +7681,8 @@ to get the result of the operation. the #SpiceUsbDeviceManager manager + filename="src/usb-device-manager.c" + line="990">the #SpiceUsbDeviceManager manager nullable="1" allow-none="1"> filter string for selecting which devices to return, + filename="src/usb-device-manager.c" + line="991">filter string for selecting which devices to return, see #SpiceUsbDeviceManager:auto-connect-filter for the filter string format @@ -7234,26 +7701,53 @@ to get the result of the operation. Finds if the @device is connected. - + filename="src/usb-device-manager.c" + line="1061">Finds if the @device is connected. + %TRUE if @device has an associated USB redirection channel + filename="src/usb-device-manager.c" + line="1068">%TRUE if @device has an associated USB redirection channel the #SpiceUsbDeviceManager manager + filename="src/usb-device-manager.c" + line="1063">the #SpiceUsbDeviceManager manager a #SpiceUsbDevice + filename="src/usb-device-manager.c" + line="1064">a #SpiceUsbDevice + + + + + + Checks whether a device is shared CD. + + + %TRUE if the device is shared CD + + + + + a #SpiceUsbDeviceManager + + + + a #SpiceUsbDevice to query @@ -7262,28 +7756,31 @@ to get the result of the operation. c:identifier="spice_usb_device_manager_is_redirecting" version="0.32"> Checks whether a device is being redirected - + filename="src/usb-device-manager.c" + line="178">Checks whether a device is being redirected + %TRUE if device redirection negotiation flow is in progress + filename="src/usb-device-manager.c" + line="184">%TRUE if device redirection negotiation flow is in progress - + the #SpiceUsbDeviceManager manager + filename="src/usb-device-manager.c" + line="180">the #SpiceUsbDeviceManager manager - + Set this to TRUE to automatically redirect newly plugged in device. + filename="src/usb-device-manager.c" + line="464">Set this to TRUE to automatically redirect newly plugged in device. Note when #SpiceGtkSession's auto-usbredir property is TRUE, this property is controlled by #SpiceGtkSession. @@ -7292,10 +7789,11 @@ property is controlled by #SpiceGtkSession. + transfer-ownership="none" + default-value="0x03,-1,-1,-1,0|-1,-1,-1,-1,1"> Set a string specifying a filter to use to determine which USB devices + filename="src/usb-device-manager.c" + line="478">Set a string specifying a filter to use to determine which USB devices to autoconnect when plugged in, a filter consists of one or more rules. Where each rule has the form of: @@ -7316,18 +7814,22 @@ Filter strings in this format can be easily created with the RHEV-M USB filter editor tool. - + Get the number of available channels for redirecting USB devices. + filename="src/usb-device-manager.c" + line="523">Get the number of available channels for redirecting USB devices. + transfer-ownership="none" + default-value="NULL"> Set a string specifying a filter selecting USB devices to automatically + filename="src/usb-device-manager.c" + line="508">Set a string specifying a filter selecting USB devices to automatically redirect after a Spice connection has been established. See #SpiceUsbDeviceManager:auto-connect-filter for the filter string @@ -7339,8 +7841,8 @@ format. construct-only="1" transfer-ownership="none"> #SpiceSession this #SpiceUsbDeviceManager is associated with + filename="src/usb-device-manager.c" + line="449">#SpiceSession this #SpiceUsbDeviceManager is associated with @@ -7352,8 +7854,8 @@ format. The #SpiceUsbDeviceManager::auto-connect-failed signal is emitted + filename="src/usb-device-manager.c" + line="576">The #SpiceUsbDeviceManager::auto-connect-failed signal is emitted whenever the auto-connect property is true, and a newly plugged in device could not be auto-connected. @@ -7362,22 +7864,22 @@ device could not be auto-connected. #SpiceUsbDevice boxed object corresponding to the device which failed to auto connect + filename="src/usb-device-manager.c" + line="579">#SpiceUsbDevice boxed object corresponding to the device which failed to auto connect #GError describing the reason why the autoconnect failed + filename="src/usb-device-manager.c" + line="580">#GError describing the reason why the autoconnect failed The #SpiceUsbDeviceManager::device-added signal is emitted whenever + filename="src/usb-device-manager.c" + line="538">The #SpiceUsbDeviceManager::device-added signal is emitted whenever a new USB device has been plugged in. @@ -7385,16 +7887,16 @@ a new USB device has been plugged in. #SpiceUsbDevice boxed object corresponding to the added device + filename="src/usb-device-manager.c" + line="541">#SpiceUsbDevice boxed object corresponding to the added device The #SpiceUsbDeviceManager::device-error signal is emitted whenever an + filename="src/usb-device-manager.c" + line="598">The #SpiceUsbDeviceManager::device-error signal is emitted whenever an error happens which causes a device to no longer be available to the guest. @@ -7403,22 +7905,22 @@ guest. #SpiceUsbDevice boxed object corresponding to the device which has an error + filename="src/usb-device-manager.c" + line="601">#SpiceUsbDevice boxed object corresponding to the device which has an error #GError describing the error + filename="src/usb-device-manager.c" + line="602">#GError describing the error The #SpiceUsbDeviceManager::device-removed signal is emitted whenever + filename="src/usb-device-manager.c" + line="557">The #SpiceUsbDeviceManager::device-removed signal is emitted whenever an USB device has been removed. @@ -7426,8 +7928,8 @@ an USB device has been removed. #SpiceUsbDevice boxed object corresponding to the removed device + filename="src/usb-device-manager.c" + line="560">#SpiceUsbDevice boxed object corresponding to the removed device @@ -7437,18 +7939,18 @@ an USB device has been removed. c:type="SpiceUsbDeviceManagerClass" glib:is-gtype-struct-for="UsbDeviceManager"> Class structure for #SpiceUsbDeviceManager. - + filename="src/usb-device-manager.h" + line="66">Class structure for #SpiceUsbDeviceManager. + Parent class. + filename="src/usb-device-manager.h" + line="68">Parent class. - + @@ -7464,7 +7966,7 @@ an USB device has been removed. - + @@ -7480,7 +7982,7 @@ an USB device has been removed. - + @@ -7499,7 +8001,7 @@ an USB device has been removed. - + @@ -7517,15 +8019,16 @@ an USB device has been removed. - - + + - + disguised="1" + opaque="1"> + glib:get-type="spice_usbredir_channel_get_type" glib:type-struct="UsbredirChannelClass"> The #SpiceUsbredirChannel struct is opaque and should not be accessed directly. - + filename="src/channel-usbredir.h" + line="42">The #SpiceUsbredirChannel struct is opaque and should not be accessed directly. + @@ -7550,20 +8053,21 @@ an USB device has been removed. c:type="SpiceUsbredirChannelClass" glib:is-gtype-struct-for="UsbredirChannel"> Class structure for #SpiceUsbredirChannel. - + filename="src/channel-usbredir.h" + line="55">Class structure for #SpiceUsbredirChannel. + Parent class. + filename="src/channel-usbredir.h" + line="57">Parent class. - + disguised="1" + opaque="1"> + - + @@ -7582,7 +8086,7 @@ an USB device has been removed. - + @@ -7591,12 +8095,18 @@ an USB device has been removed. - + + + + + glib:get-type="spice_webdav_channel_get_type" glib:type-struct="WebdavChannelClass"> The #SpiceWebdavChannel struct is opaque and should not be accessed directly. - + filename="src/channel-webdav.h" + line="41">The #SpiceWebdavChannel struct is opaque and should not be accessed directly. + @@ -7619,25 +8129,26 @@ an USB device has been removed. c:type="SpiceWebdavChannelClass" glib:is-gtype-struct-for="WebdavChannel"> Class structure for #SpiceWebdavChannel. - + filename="src/channel-webdav.h" + line="54">Class structure for #SpiceWebdavChannel. + Parent class. + filename="src/channel-webdav.h" + line="56">Parent class. - + disguised="1" + opaque="1"> + The Spice protocol defines a set of messages for controlling cursor + filename="src/channel-cursor.c" + line="26">The Spice protocol defines a set of messages for controlling cursor shape and position on the remote display area. The cursor changes that should be reflected on the display are notified by signals. See for example #SpiceCursorChannel::cursor-set and @@ -7646,7 +8157,7 @@ property. A class that handles the rendering of the remote display and inform of its updates. @@ -7658,8 +8169,8 @@ The update of regions is notified by Spice supports sending keyboard key events and keyboard leds + filename="src/channel-inputs.c" + line="23">Spice supports sending keyboard key events and keyboard leds synchronization. The key events are sent using spice_inputs_key_press() and spice_inputs_key_release() using a modified variant of PC XT scancodes. @@ -7670,15 +8181,15 @@ is emitted with #SpiceInputsChannel::inputs-modifiers signal. The main channel is the Spice session control channel. It handles + filename="src/channel-main.c" + line="34">The main channel is the Spice session control channel. It handles communication initialization (channels list), migrations, mouse modes, multimedia time, and agent communication. #SpicePlaybackChannel class handles an audio playback stream. The + filename="src/channel-playback.c" + line="29">#SpicePlaybackChannel class handles an audio playback stream. The audio data is received via #SpicePlaybackChannel::playback-data signal, and is controlled by the guest with #SpicePlaybackChannel::playback-stop and @@ -7689,8 +8200,8 @@ record audio channels for your application. A Spice port channel carry arbitrary data between the Spice client + filename="src/channel-port.c" + line="24">A Spice port channel carry arbitrary data between the Spice client and the Spice server. It may be used to provide additional services on top of a Spice connection. For example, a channel can be associated with the qemu monitor for the client to interact @@ -7710,8 +8221,8 @@ sending data via spice_port_write_async(). #SpiceRecordChannel class handles an audio recording stream. The + filename="src/channel-record.c" + line="28">#SpiceRecordChannel class handles an audio recording stream. The audio stream should start when #SpiceRecordChannel::record-start is emitted and should be stopped when #SpiceRecordChannel::record-stop is received. @@ -7724,8 +8235,8 @@ record audio channels for your application. The Spice protocol defines a set of messages to forward smartcard + filename="src/channel-smartcard.c" + line="27">The Spice protocol defines a set of messages to forward smartcard information from the Spice client to the VM. This channel handles these messages. While it's mainly focus on smartcard readers and smartcards, it's also possible to use it with a software smartcard @@ -7737,14 +8248,14 @@ insertion/removal. The Spice protocol defines a set of messages to redirect USB devices + filename="src/channel-usbredir.c" + line="41">The Spice protocol defines a set of messages to redirect USB devices from the Spice client to the VM. This channel handles these messages. The "webdav" channel exports a directory to the guest for file + filename="src/channel-webdav.c" + line="27">The "webdav" channel exports a directory to the guest for file manipulation (read/write/copy etc). The underlying protocol is implemented using WebDAV (RFC 4918). @@ -7755,157 +8266,61 @@ directory with #SpiceSession #SpiceSession:shared-dir property. Gets a #GQuark representing the string "spice-client-error-quark" + filename="src/spice-client.c" + line="23">Gets a #GQuark representing the string "spice-client-error-quark" the #GQuark representing the string. + filename="src/spice-client.c" + line="28">the #GQuark representing the string. - - Tells the spice server to change the preferred image compression -for the @channel. - use spice_display_channel_change_preferred_compression() instead. - - - - - - - a #SpiceDisplayChannel - - - - a #SpiceImageCompression - - - - - - Tells the spice server to change the preferred video codec type for -streaming in @channel. Application can set only one preferred video codec per -display channel. - use spice_display_channel_change_preferred_video_codec_type() instead. - - - - - - - a #SpiceDisplayChannel - - - - a #SpiceVideoCodecType - - - - Retrieves the GL scanout if available + filename="src/channel-display.c" + line="742">Retrieves the GL scanout if available use spice_display_channel_get_gl_scanout() instead. - + the current GL scanout, or %NULL if none or not valid + filename="src/channel-display.c" + line="748">the current GL scanout, or %NULL if none or not valid a #SpiceDisplayChannel + filename="src/channel-display.c" + line="744">a #SpiceDisplayChannel - - Retrieve primary display surface @surface_id. - use spice_display_channel_get_primary() instead. - - - %TRUE if the primary surface was found and its details -collected in @primary. - - - - - a #SpiceDisplayChannel - - - - a surface id - - - - a #SpiceDisplayPrimary - - - - After a SpiceDisplayChannel::gl-draw is emitted, the client should + filename="src/channel-display.c" + line="2112">After a SpiceDisplayChannel::gl-draw is emitted, the client should draw the current display with the current GL scanout, and must release the GL resource with a call to spice_display_gl_draw_done() (failing to do so for each gl-draw may result in a frozen display). use spice_display_channel_gl_draw_done() instead. - + a #SpiceDisplayChannel + filename="src/channel-display.c" + line="2114">a #SpiceDisplayChannel @@ -7914,14 +8329,14 @@ release the GL resource with a call to spice_display_gl_draw_done() c:identifier="spice_g_signal_connect_object" introspectable="0"> Similar to g_signal_connect_object() but will delete connection + filename="src/spice-util.c" + line="214">Similar to g_signal_connect_object() but will delete connection when any of the objects is destroyed. - + the handler id. + filename="src/spice-util.c" + line="225">the handler id. @@ -7930,20 +8345,20 @@ when any of the objects is destroyed. nullable="1" allow-none="1"> the instance to connect to. + filename="src/spice-util.c" + line="216">the instance to connect to. a string of the form "signal-name::detail". + filename="src/spice-util.c" + line="217">a string of the form "signal-name::detail". the #GCallback to connect. + filename="src/spice-util.c" + line="218">the #GCallback to connect. nullable="1" allow-none="1"> the object to pass as data to @c_handler. + filename="src/spice-util.c" + line="219">the object to pass as data to @c_handler. a combination of #GConnectFlags. + filename="src/spice-util.c" + line="220">a combination of #GConnectFlags. Gets commandline options. Bindings for other languages are available since 0.32 - + a #GOptionGroup for the commandline arguments specific to Spice. You have to call spice_set_session_option() after to set the options on a @@ -7985,30 +8400,30 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.35"> Press a mouse button. + filename="src/channel-inputs.c" + line="378">Press a mouse button. use spice_inputs_channel_button_press() instead. - + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="380">a #SpiceInputsChannel a SPICE_MOUSE_BUTTON + filename="src/channel-inputs.c" + line="381">a SPICE_MOUSE_BUTTON SPICE_MOUSE_BUTTON_MASK flags + filename="src/channel-inputs.c" + line="382">SPICE_MOUSE_BUTTON_MASK flags @@ -8018,30 +8433,30 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.35"> Release a button. + filename="src/channel-inputs.c" + line="449">Release a button. use spice_inputs_channel_button_release() instead. - + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="451">a #SpiceInputsChannel a SPICE_MOUSE_BUTTON + filename="src/channel-inputs.c" + line="452">a SPICE_MOUSE_BUTTON SPICE_MOUSE_BUTTON_MASK flags + filename="src/channel-inputs.c" + line="453">SPICE_MOUSE_BUTTON_MASK flags @@ -8051,24 +8466,24 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.35"> Press a key. + filename="src/channel-inputs.c" + line="520">Press a key. use spice_inputs_channel_key_press() instead. - + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="522">a #SpiceInputsChannel a PC XT (set 1) key scancode. For scancodes with an \%0xe0 + filename="src/channel-inputs.c" + line="523">a PC XT (set 1) key scancode. For scancodes with an \%0xe0 prefix, drop the prefix and OR the scancode with \%0x100. @@ -8080,23 +8495,23 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.35"> Press and release a key event atomically (in the same message). - + filename="src/channel-inputs.c" + line="606">Press and release a key event atomically (in the same message). + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="608">a #SpiceInputsChannel a PC XT (set 1) key scancode. For scancodes with an \%0xe0 + filename="src/channel-inputs.c" + line="609">a PC XT (set 1) key scancode. For scancodes with an \%0xe0 prefix, drop the prefix and OR the scancode with \%0x100. @@ -8107,24 +8522,24 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.35"> Release a key. + filename="src/channel-inputs.c" + line="563">Release a key. use spice_inputs_channel_key_release() instead. - + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="565">a #SpiceInputsChannel a PC XT (set 1) key scancode. For scancodes with an \%0xe0 + filename="src/channel-inputs.c" + line="566">a PC XT (set 1) key scancode. For scancodes with an \%0xe0 prefix, drop the prefix and OR the scancode with \%0x100. @@ -8135,36 +8550,36 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.35"> Change mouse position (used in SPICE_MOUSE_MODE_SERVER). + filename="src/channel-inputs.c" + line="274">Change mouse position (used in SPICE_MOUSE_MODE_SERVER). use spice_inputs_channel_motion() instead. - + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="276">a #SpiceInputsChannel delta X mouse coordinates + filename="src/channel-inputs.c" + line="277">delta X mouse coordinates delta Y mouse coordinates + filename="src/channel-inputs.c" + line="278">delta Y mouse coordinates SPICE_MOUSE_BUTTON_MASK flags + filename="src/channel-inputs.c" + line="279">SPICE_MOUSE_BUTTON_MASK flags @@ -8174,42 +8589,42 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.35"> Change mouse position (used in SPICE_MOUSE_MODE_CLIENT). + filename="src/channel-inputs.c" + line="325">Change mouse position (used in SPICE_MOUSE_MODE_CLIENT). use spice_inputs_channel_position() instead. - + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="327">a #SpiceInputsChannel X mouse coordinates + filename="src/channel-inputs.c" + line="328">X mouse coordinates Y mouse coordinates + filename="src/channel-inputs.c" + line="329">Y mouse coordinates display channel id + filename="src/channel-inputs.c" + line="330">display channel id SPICE_MOUSE_BUTTON_MASK flags + filename="src/channel-inputs.c" + line="331">SPICE_MOUSE_BUTTON_MASK flags @@ -8219,24 +8634,24 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.35"> Set the keyboard locks on the guest (Caps, Num, Scroll..) + filename="src/channel-inputs.c" + line="696">Set the keyboard locks on the guest (Caps, Num, Scroll..) use spice_inputs_channel_set_key_locks() instead. - + a #SpiceInputsChannel + filename="src/channel-inputs.c" + line="698">a #SpiceInputsChannel #SpiceInputsLock modifiers flags + filename="src/channel-inputs.c" + line="699">#SpiceInputsLock modifiers flags @@ -8246,27 +8661,27 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.35"> Test capability of a remote agent. + filename="src/channel-main.c" + line="2702">Test capability of a remote agent. use spice_main_channel_agent_test_capability() instead. - + %TRUE if @cap (channel kind capability) is available. + filename="src/channel-main.c" + line="2709">%TRUE if @cap (channel kind capability) is available. a #SpiceMainChannel + filename="src/channel-main.c" + line="2704">a #SpiceMainChannel an agent capability identifier + filename="src/channel-main.c" + line="2705">an agent capability identifier @@ -8276,30 +8691,32 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.6"> Grab the guest clipboard, with #VD_AGENT_CLIPBOARD @types. + filename="src/channel-main.c" + line="2880">Grab the guest clipboard, with #VD_AGENT_CLIPBOARD @types. use spice_main_channel_clipboard_selection_grab() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="2882">a #SpiceMainChannel an array of #VD_AGENT_CLIPBOARD types available in the clipboard - + filename="src/channel-main.c" + line="2883">an array of #VD_AGENT_CLIPBOARD types available in the clipboard + + + the number of @types + filename="src/channel-main.c" + line="2884">the number of @types @@ -8309,36 +8726,38 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.6"> Send the clipboard data to the guest. + filename="src/channel-main.c" + line="2989">Send the clipboard data to the guest. use spice_main_channel_clipboard_selection_notify() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="2991">a #SpiceMainChannel a #VD_AGENT_CLIPBOARD type + filename="src/channel-main.c" + line="2992">a #VD_AGENT_CLIPBOARD type clipboard data - + filename="src/channel-main.c" + line="2993">clipboard data + + + data length in bytes + filename="src/channel-main.c" + line="2994">data length in bytes @@ -8348,19 +8767,19 @@ spice_set_session_option() after to set the options on a deprecated="1" deprecated-version="0.6"> Release the clipboard (for example, when the client loses the + filename="src/channel-main.c" + line="2935">Release the clipboard (for example, when the client loses the clipboard grab): Inform the guest no clipboard data is available. use spice_main_channel_clipboard_selection_release() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="2937">a #SpiceMainChannel @@ -8370,25 +8789,25 @@ clipboard grab): Inform the guest no clipboard data is available. deprecated="1" deprecated-version="0.6"> Request clipboard data of @type from the guest. The reply is sent + filename="src/channel-main.c" + line="3048">Request clipboard data of @type from the guest. The reply is sent through the #SpiceMainChannel::main-clipboard signal. use spice_main_channel_clipboard_selection_request() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="3050">a #SpiceMainChannel a #VD_AGENT_CLIPBOARD type + filename="src/channel-main.c" + line="3051">a #VD_AGENT_CLIPBOARD type @@ -8399,36 +8818,38 @@ through the #SpiceMainChannel::main-clipboard signal. deprecated="1" deprecated-version="0.35"> Grab the guest clipboard, with #VD_AGENT_CLIPBOARD @types. + filename="src/channel-main.c" + line="2896">Grab the guest clipboard, with #VD_AGENT_CLIPBOARD @types. use spice_main_channel_clipboard_selection_grab() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="2898">a #SpiceMainChannel one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* + filename="src/channel-main.c" + line="2899">one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* an array of #VD_AGENT_CLIPBOARD types available in the clipboard - + filename="src/channel-main.c" + line="2900">an array of #VD_AGENT_CLIPBOARD types available in the clipboard + + + the number of @types + filename="src/channel-main.c" + line="2901">the number of @types @@ -8439,42 +8860,44 @@ through the #SpiceMainChannel::main-clipboard signal. deprecated="1" deprecated-version="0.35"> Send the clipboard data to the guest. + filename="src/channel-main.c" + line="3007">Send the clipboard data to the guest. use spice_main_channel_clipboard_selection_notify() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="3009">a #SpiceMainChannel one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* + filename="src/channel-main.c" + line="3010">one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* a #VD_AGENT_CLIPBOARD type + filename="src/channel-main.c" + line="3011">a #VD_AGENT_CLIPBOARD type clipboard data - + filename="src/channel-main.c" + line="3012">clipboard data + + + data length in bytes + filename="src/channel-main.c" + line="3013">data length in bytes @@ -8485,25 +8908,25 @@ through the #SpiceMainChannel::main-clipboard signal. deprecated="1" deprecated-version="0.35"> Release the clipboard (for example, when the client loses the + filename="src/channel-main.c" + line="2949">Release the clipboard (for example, when the client loses the clipboard grab): Inform the guest no clipboard data is available. use spice_main_channel_clipboard_selection_release() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="2951">a #SpiceMainChannel one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* + filename="src/channel-main.c" + line="2952">one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* @@ -8514,31 +8937,31 @@ clipboard grab): Inform the guest no clipboard data is available. deprecated="1" deprecated-version="0.35"> Request clipboard data of @type from the guest. The reply is sent + filename="src/channel-main.c" + line="3064">Request clipboard data of @type from the guest. The reply is sent through the #SpiceMainChannel::main-clipboard-selection signal. use spice_main_channel_clipboard_selection_request() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="3066">a #SpiceMainChannel one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* + filename="src/channel-main.c" + line="3067">one of the clipboard #VD_AGENT_CLIPBOARD_SELECTION_* a #VD_AGENT_CLIPBOARD type + filename="src/channel-main.c" + line="3068">a #VD_AGENT_CLIPBOARD type @@ -8548,32 +8971,32 @@ through the #SpiceMainChannel::main-clipboard-selection signal. deprecated="1" deprecated-version="0.35"> See: spice_main_channel_file_copy_async() + filename="src/channel-main.c" + line="3395">See: spice_main_channel_file_copy_async() use spice_main_channel_file_copy_async() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="3397">a #SpiceMainChannel a %NULL-terminated array of #GFile objects to be transferred + filename="src/channel-main.c" + line="3398">a %NULL-terminated array of #GFile objects to be transferred set of #GFileCopyFlags + filename="src/channel-main.c" + line="3399">set of #GFileCopyFlags nullable="1" allow-none="1"> optional #GCancellable object, %NULL to ignore + filename="src/channel-main.c" + line="3400">optional #GCancellable object, %NULL to ignore scope="call" closure="5"> function to callback with + filename="src/channel-main.c" + line="3401">function to callback with progress information, or %NULL if progress information is not needed @@ -8603,8 +9026,8 @@ through the #SpiceMainChannel::main-clipboard-selection signal. nullable="1" allow-none="1"> user data to pass to @progress_callback + filename="src/channel-main.c" + line="3403">user data to pass to @progress_callback scope="async" closure="7"> a #GAsyncReadyCallback to call when the request is satisfied + filename="src/channel-main.c" + line="3404">a #GAsyncReadyCallback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="src/channel-main.c" + line="3405">the data to pass to callback function @@ -8633,27 +9056,27 @@ through the #SpiceMainChannel::main-clipboard-selection signal. c:identifier="spice_main_file_copy_finish" throws="1"> Finishes copying the file started with + filename="src/channel-main.c" + line="3526">Finishes copying the file started with spice_main_file_copy_async(). - + a %TRUE on success, %FALSE on error. + filename="src/channel-main.c" + line="3535">a %TRUE on success, %FALSE on error. a #SpiceMainChannel + filename="src/channel-main.c" + line="3528">a #SpiceMainChannel a #GAsyncResult. + filename="src/channel-main.c" + line="3529">a #GAsyncResult. @@ -8664,26 +9087,26 @@ spice_main_file_copy_async(). deprecated="1" deprecated-version="0.35"> Request a mouse mode to the server. The server may not be able to + filename="src/channel-main.c" + line="1631">Request a mouse mode to the server. The server may not be able to change the mouse mode, but spice-gtk will try to request it when possible. use spice_main_channel_request_mouse_mode() instead. - + a %SpiceMainChannel + filename="src/channel-main.c" + line="1633">a %SpiceMainChannel a SPICE_MOUSE_MODE + filename="src/channel-main.c" + line="1634">a SPICE_MOUSE_MODE @@ -8693,22 +9116,22 @@ when possible. deprecated="1" deprecated-version="0.35"> Send monitors configuration previously set with + filename="src/channel-main.c" + line="1089">Send monitors configuration previously set with spice_main_set_display() and spice_main_set_display_enabled() use spice_main_channel_send_monitor_config() instead. - + %TRUE on success. + filename="src/channel-main.c" + line="1096">%TRUE on success. a #SpiceMainChannel + filename="src/channel-main.c" + line="1091">a #SpiceMainChannel @@ -8718,49 +9141,49 @@ spice_main_set_display() and spice_main_set_display_enabled() deprecated="1" deprecated-version="0.35"> Notify the guest of screen resolution change. The notification is + filename="src/channel-main.c" + line="2860">Notify the guest of screen resolution change. The notification is sent 1 second later, if no further changes happen. use spice_main_channel_update_display() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="2862">a #SpiceMainChannel display ID + filename="src/channel-main.c" + line="2863">display ID x position + filename="src/channel-main.c" + line="2864">x position y position + filename="src/channel-main.c" + line="2865">y position display width + filename="src/channel-main.c" + line="2866">display width display height + filename="src/channel-main.c" + line="2867">display height @@ -8771,33 +9194,33 @@ sent 1 second later, if no further changes happen. deprecated="1" deprecated-version="0.35"> When sending monitor configuration to agent guest, don't set + filename="src/channel-main.c" + line="3171">When sending monitor configuration to agent guest, don't set display @id, which the agent translates to disabling the display id. Note: this will take effect next time the monitor configuration is sent. use spice_main_channel_update_display_enabled() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="3173">a #SpiceMainChannel display ID (if -1: set all displays) + filename="src/channel-main.c" + line="3174">display ID (if -1: set all displays) wether display @id is enabled + filename="src/channel-main.c" + line="3175">wether display @id is enabled @@ -8807,59 +9230,59 @@ configuration is sent. deprecated="1" deprecated-version="0.35"> Update the display @id resolution. + filename="src/channel-main.c" + line="2736">Update the display @id resolution. If @update is %TRUE, the remote configuration will be updated too after 1 second without further changes. You can send when you want without delay the new configuration to the remote with spice_main_send_monitor_config() use spice_main_channel_update_display() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="2738">a #SpiceMainChannel display ID + filename="src/channel-main.c" + line="2739">display ID x position + filename="src/channel-main.c" + line="2740">x position y position + filename="src/channel-main.c" + line="2741">y position display width + filename="src/channel-main.c" + line="2742">display width display height + filename="src/channel-main.c" + line="2743">display height if %TRUE, update guest resolution after 1sec. + filename="src/channel-main.c" + line="2744">if %TRUE, update guest resolution after 1sec. @@ -8870,8 +9293,8 @@ spice_main_send_monitor_config() deprecated="1" deprecated-version="0.35"> When sending monitor configuration to agent guest, if @enabled is %FALSE, + filename="src/channel-main.c" + line="3102">When sending monitor configuration to agent guest, if @enabled is %FALSE, don't set display @id, which the agent translates to disabling the display id. If @enabled is %TRUE, the monitor will be included in the next monitor update. Note: this will take effect next time the monitor configuration is @@ -8880,39 +9303,39 @@ sent. If @update is %FALSE, no server update will be triggered by this call, but the value will be saved and used in the next configuration update. use spice_main_channel_update_display_enabled() instead. - + a #SpiceMainChannel + filename="src/channel-main.c" + line="3104">a #SpiceMainChannel display ID (if -1: set all displays) + filename="src/channel-main.c" + line="3105">display ID (if -1: set all displays) wether display @id is enabled + filename="src/channel-main.c" + line="3106">wether display @id is enabled if %TRUE, update guest display state after 1sec. + filename="src/channel-main.c" + line="3107">if %TRUE, update guest display state after 1sec. - + @@ -8931,28 +9354,28 @@ the value will be saved and used in the next configuration update. deprecated="1" deprecated-version="0.35"> Send an event to the port. + filename="src/channel-port.c" + line="365">Send an event to the port. Note: The values SPICE_PORT_EVENT_CLOSED and SPICE_PORT_EVENT_OPENED are managed by the channel connection state. use spice_port_channel_event() instead. - + a #SpicePortChannel + filename="src/channel-port.c" + line="367">a #SpicePortChannel a SPICE_PORT_EVENT value + filename="src/channel-port.c" + line="368">a SPICE_PORT_EVENT value @@ -8963,27 +9386,27 @@ state. deprecated="1" deprecated-version="0.35"> Request an asynchronous write of count bytes from @buffer into the + filename="src/channel-port.c" + line="258">Request an asynchronous write of count bytes from @buffer into the @port. When the operation is finished @callback will be called. You can then call spice_port_write_finish() to get the result of the operation. use spice_port_channel_write_async() instead. - + A #SpicePortChannel + filename="src/channel-port.c" + line="260">A #SpicePortChannel the buffer + filename="src/channel-port.c" + line="261">the buffer containing the data to write @@ -8991,8 +9414,8 @@ containing the data to write the number of bytes to write + filename="src/channel-port.c" + line="263">the number of bytes to write nullable="1" allow-none="1"> optional GCancellable object, NULL to ignore + filename="src/channel-port.c" + line="264">optional GCancellable object, NULL to ignore scope="async" closure="5"> callback to call when the request is satisfied + filename="src/channel-port.c" + line="265">callback to call when the request is satisfied nullable="1" allow-none="1"> the data to pass to callback function + filename="src/channel-port.c" + line="266">the data to pass to callback function @@ -9033,53 +9456,53 @@ containing the data to write deprecated-version="0.35" throws="1"> Finishes a port write operation. + filename="src/channel-port.c" + line="326">Finishes a port write operation. use spice_port_channel_write_finish() instead. - + a #gssize containing the number of bytes written to the stream. + filename="src/channel-port.c" + line="335">a #gssize containing the number of bytes written to the stream. a #SpicePortChannel + filename="src/channel-port.c" + line="328">a #SpicePortChannel a #GAsyncResult + filename="src/channel-port.c" + line="329">a #GAsyncResult A helper to handle QMP messages over a %SpicePortChannel. + filename="src/qmp-port.c" + line="24">A helper to handle QMP messages over a %SpicePortChannel. Send recorded PCM data to the guest. + filename="src/channel-record.c" + line="294">Send recorded PCM data to the guest. use spice_record_channel_send_data() instead. - + a #SpiceRecordChannel + filename="src/channel-record.c" + line="296">a #SpiceRecordChannel nullable="1" allow-none="1"> PCM data + filename="src/channel-record.c" + line="297">PCM data size of @data + filename="src/channel-record.c" + line="298">size of @data stream timestamp + filename="src/channel-record.c" + line="299">stream timestamp @@ -9108,47 +9531,47 @@ containing the data to write Set various properties on @session, according to the commandline + filename="src/spice-option.c" + line="229">Set various properties on @session, according to the commandline arguments given to spice_get_option_group() option group. - + a #SpiceSession to set option upon + filename="src/spice-option.c" + line="231">a #SpiceSession to set option upon #SpiceSmartcardManager monitors smartcard reader plugging/unplugging, + filename="src/smartcard-manager.c" + line="31">#SpiceSmartcardManager monitors smartcard reader plugging/unplugging, and smartcard insertions/removals. It also provides methods to handle software smartcards (to emulate a smartcard reader/smartcard on the guest using 3 certificates available to the client). A class that handles the playback and record channels for your + filename="src/spice-audio.c" + line="21">A class that handles the playback and record channels for your application, and connect them to the default sound system. #SpiceChannel is the base class for the different kind of Spice + filename="src/spice-channel.c" + line="68">#SpiceChannel is the base class for the different kind of Spice channel connections, such as #SpiceMainChannel, or #SpiceInputsChannel. The #SpiceSession class handles all the #SpiceChannel connections. + filename="src/spice-session.c" + line="132">The #SpiceSession class handles all the #SpiceChannel connections. It's also the class that contains connections informations, such as #SpiceSession:host and #SpiceSession:port. @@ -9171,19 +9594,19 @@ a Spice server. Various functions for debugging and informational purposes. + filename="src/spice-util.c" + line="29">Various functions for debugging and informational purposes. Spice-Gtk provides macros to check the version of the library + filename="src/spice-version.h" + line="24">Spice-Gtk provides macros to check the version of the library at compile-time #SpiceUsbDeviceManager monitors USB redirection channels and USB + filename="src/usb-device-manager.c" + line="50">#SpiceUsbDeviceManager monitors USB redirection channels and USB devices plugging/unplugging. If #SpiceUsbDeviceManager:auto-connect is set to %TRUE, it will automatically connect newly plugged USB devices to available channels. @@ -9194,7 +9617,7 @@ spice_usb_device_manager_new, instead there is spice_usb_device_manager_get() which ensures this 1:1 relation. - + @@ -9202,29 +9625,29 @@ spice_usb_device_manager_get() which ensures this 1:1 relation. Gets the version string - + filename="src/spice-util.c" + line="96">Gets the version string + Spice-GTK version as a const string. + filename="src/spice-util.c" + line="101">Spice-GTK version as a const string. Enable or disable Spice-GTK debugging messages. - + filename="src/spice-util.c" + line="56">Enable or disable Spice-GTK debugging messages. + %TRUE or %FALSE + filename="src/spice-util.c" + line="58">%TRUE or %FALSE @@ -9233,22 +9656,24 @@ spice_usb_device_manager_get() which ensures this 1:1 relation. c:identifier="spice_uuid_to_string" version="0.22"> Creates a string representation of @uuid, of the form + filename="src/spice-util.c" + line="123">Creates a string representation of @uuid, of the form "06e023d5-86d8-420e-8103-383e4566087a" - + A string that should be freed with g_free(). + filename="src/spice-util.c" + line="130">A string that should be freed with g_free(). UUID byte array - + filename="src/spice-util.c" + line="125">UUID byte array + + + diff --git a/girs/St-14.gir b/girs/St-14.gir index ed022236f..05fb0ab6f 100644 --- a/girs/St-14.gir +++ b/girs/St-14.gir @@ -3077,12 +3077,12 @@ through the public API. Create a newly allocated #StIcon. + line="677">Create a newly allocated #StIcon. A newly allocated #StIcon + line="682">A newly allocated #StIcon @@ -3091,19 +3091,19 @@ through the public API. glib:get-property="fallback-gicon"> Gets the currently set fallback #GIcon. + line="784">Gets the currently set fallback #GIcon. The fallback #GIcon, if set, otherwise %NULL + line="790">The fallback #GIcon, if set, otherwise %NULL a #StIcon + line="786">a #StIcon @@ -3113,20 +3113,20 @@ through the public API. glib:get-property="fallback-icon-name"> This is a convenience method to get the icon name of the fallback + line="869">This is a convenience method to get the icon name of the fallback #GThemedIcon that is currently set. The name of the icon or %NULL if no icon is set + line="876">The name of the icon or %NULL if no icon is set an #StIcon + line="871">an #StIcon @@ -3136,19 +3136,19 @@ through the public API. glib:get-property="gicon"> Gets the current #GIcon in use. + line="745">Gets the current #GIcon in use. The current #GIcon, if set, otherwise %NULL + line="751">The current #GIcon, if set, otherwise %NULL an #StIcon + line="747">an #StIcon @@ -3158,20 +3158,20 @@ through the public API. glib:get-property="icon-name"> This is a convenience method to get the icon name of the current icon, if it + line="690">This is a convenience method to get the icon name of the current icon, if it is currently a #GThemedIcon, or %NULL otherwise. The name of the icon or %NULL + line="697">The name of the icon or %NULL an #StIcon + line="692">an #StIcon @@ -3181,20 +3181,39 @@ is currently a #GThemedIcon, or %NULL otherwise. glib:get-property="icon-size"> Gets the explicit size set using st_icon_set_icon_size() for the icon. + line="825">Gets the explicit size set using st_icon_set_icon_size() for the icon. This is not necessarily the size that the icon will be displayed at. The explicitly set size, or -1 if no size has been set + line="832">The explicitly set size, or -1 if no size has been set an #StIcon + line="827">an #StIcon + + + + + + + + Whether the displayed icon is symbolic + + + + + an #StIcon @@ -3204,7 +3223,7 @@ This is not necessarily the size that the icon will be displayed at. glib:set-property="fallback-gicon"> Sets a fallback #GIcon to show if the normal icon fails to load. + line="800">Sets a fallback #GIcon to show if the normal icon fails to load. If @fallback_gicon is %NULL or fails to load, the icon is unset and no texture will be visible for the fallback icon. @@ -3215,7 +3234,7 @@ texture will be visible for the fallback icon. a #StIcon + line="802">a #StIcon allow-none="1"> the fallback #GIcon + line="803">the fallback #GIcon @@ -3234,7 +3253,7 @@ texture will be visible for the fallback icon. glib:set-property="fallback-icon-name"> This is a convenience method to set the fallback #GIcon to a #GThemedIcon + line="893">This is a convenience method to set the fallback #GIcon to a #GThemedIcon created using the given icon name. If @fallback_icon_name is an empty string, %NULL or fails to load, the icon is unset and no texture will be visible for the fallback icon. @@ -3246,7 +3265,7 @@ be visible for the fallback icon. an #StIcon + line="895">an #StIcon allow-none="1"> the name of the fallback icon + line="896">the name of the fallback icon @@ -3265,7 +3284,7 @@ be visible for the fallback icon. glib:set-property="gicon"> Sets a #GIcon to show for the icon. If @gicon is %NULL or fails to load, + line="761">Sets a #GIcon to show for the icon. If @gicon is %NULL or fails to load, the fallback icon set using st_icon_set_fallback_icon() will be shown. @@ -3275,7 +3294,7 @@ the fallback icon set using st_icon_set_fallback_icon() will be shown. an #StIcon + line="763">an #StIcon allow-none="1"> a #GIcon + line="764">a #GIcon @@ -3294,7 +3313,7 @@ the fallback icon set using st_icon_set_fallback_icon() will be shown. glib:set-property="icon-name"> This is a convenience method to set the #GIcon to a #GThemedIcon created + line="714">This is a convenience method to set the #GIcon to a #GThemedIcon created using the given icon name. If @icon_name is an empty string, %NULL or fails to load, the fallback icon will be shown. @@ -3305,7 +3324,7 @@ fails to load, the fallback icon will be shown. an #StIcon + line="716">an #StIcon allow-none="1"> the name of the icon + line="717">the name of the icon @@ -3324,7 +3343,7 @@ fails to load, the fallback icon will be shown. glib:set-property="icon-size"> Sets an explicit size for the icon. Setting @size to -1 will use the size + line="842">Sets an explicit size for the icon. Setting @size to -1 will use the size defined by the current style or the default icon size. @@ -3334,13 +3353,13 @@ defined by the current style or the default icon size. an #StIcon + line="844">an #StIcon if positive, the new size, otherwise the size will be + line="845">if positive, the new size, otherwise the size will be derived from the current style @@ -3353,7 +3372,7 @@ defined by the current style or the default icon size. getter="get_fallback_gicon"> The fallback #GIcon to display if #StIcon:gicon fails to load. + line="320">The fallback #GIcon to display if #StIcon:gicon fails to load. default-value="NULL"> The fallback icon name of the #StIcon. See st_icon_set_fallback_icon_name() + line="357">The fallback icon name of the #StIcon. See st_icon_set_fallback_icon_name() for details. @@ -3375,7 +3394,7 @@ for details. getter="get_gicon"> The #GIcon being displayed by this #StIcon. + line="308">The #GIcon being displayed by this #StIcon. default-value="NULL"> The name of the icon if the icon being displayed is a #GThemedIcon. + line="332">The name of the icon if the icon being displayed is a #GThemedIcon. default-value="-1"> The size of the icon, if greater than `0`. Otherwise the icon size is derived + line="344">The size of the icon, if greater than `0`. Otherwise the icon size is derived from the current style. + + + @@ -4965,7 +4990,7 @@ icon theme. c:identifier="st_image_content_new_with_preferred_size"> Creates a new #StImageContent, a simple content for sized images. + line="328">Creates a new #StImageContent, a simple content for sized images. See #ClutterImage for setting the actual image to display or #StIcon for displaying icons. @@ -4973,7 +4998,7 @@ displaying icons. the newly created #StImageContent content + line="338">the newly created #StImageContent content Use g_object_unref() when done. @@ -4981,13 +5006,13 @@ displaying icons. The preferred width to be used when drawing the content + line="330">The preferred width to be used when drawing the content The preferred width to be used when drawing the content + line="331">The preferred width to be used when drawing the content @@ -6875,7 +6900,7 @@ are implemented, currently. The global texture cache + line="1659">The global texture cache @@ -6885,7 +6910,7 @@ are implemented, currently. throws="1"> Load an arbitrary texture, caching it. The string chosen for @key + line="864">Load an arbitrary texture, caching it. The string chosen for @key should be of the form "type-prefix:type-uuid". For example, "url:file:///usr/share/icons/hicolor/48x48/apps/firefox.png", or "stock-icon:gtk-ok". @@ -6893,32 +6918,32 @@ should be of the form "type-prefix:type-uuid". For example, A newly-referenced handle to the texture + line="878">A newly-referenced handle to the texture A #StTextureCache + line="866">A #StTextureCache Arbitrary string used to refer to item + line="867">Arbitrary string used to refer to item Caching policy + line="868">Caching policy Function to create the texture, if not already cached + line="869">Function to create the texture, if not already cached User data passed to @load + line="870">User data passed to @load @@ -6936,25 +6961,25 @@ should be of the form "type-prefix:type-uuid". For example, c:identifier="st_texture_cache_load_cairo_surface_to_gicon"> Create a #GIcon from @surface. + line="845">Create a #GIcon from @surface. A new #GIcon + line="852">A new #GIcon A #StTextureCache + line="847">A #StTextureCache A #cairo_surface_t + line="848">A #cairo_surface_t @@ -6963,51 +6988,51 @@ should be of the form "type-prefix:type-uuid". For example, c:identifier="st_texture_cache_load_file_async"> Asynchronously load an image. Initially, the returned texture will have a natural + line="1416">Asynchronously load an image. Initially, the returned texture will have a natural size of zero. At some later point, either the image will be loaded successfully and at that point size will be negotiated, or upon an error, no image will be set. A new #ClutterActor with no image loaded initially. + line="1429">A new #ClutterActor with no image loaded initially. A #StTextureCache + line="1418">A #StTextureCache a #GFile of the image file from which to create a pixbuf + line="1419">a #GFile of the image file from which to create a pixbuf available width for the image, can be -1 if not limited + line="1420">available width for the image, can be -1 if not limited available height for the image, can be -1 if not limited + line="1421">available height for the image, can be -1 if not limited scale factor of the display + line="1422">scale factor of the display Resource scale factor + line="1423">Resource scale factor @@ -7016,39 +7041,39 @@ and at that point size will be negotiated, or upon an error, no image will be se c:identifier="st_texture_cache_load_file_to_cairo_surface"> This function synchronously loads the given file path + line="1617">This function synchronously loads the given file path into a cairo surface. On error, a warning is emitted and %NULL is returned. a new #cairo_surface_t + line="1628">a new #cairo_surface_t A #StTextureCache + line="1619">A #StTextureCache A #GFile in supported image format + line="1620">A #GFile in supported image format Scale factor of the display + line="1621">Scale factor of the display Resource scale factor + line="1622">Resource scale factor @@ -7058,39 +7083,39 @@ and %NULL is returned. introspectable="0"> This function synchronously loads the given file path + line="1580">This function synchronously loads the given file path into a COGL texture. On error, a warning is emitted and %NULL is returned. a new #CoglTexture + line="1591">a new #CoglTexture A #StTextureCache + line="1582">A #StTextureCache A #GFile in supported image format + line="1583">A #GFile in supported image format Scale factor of the display + line="1584">Scale factor of the display Resource scale factor + line="1585">Resource scale factor @@ -7098,21 +7123,21 @@ and %NULL is returned. This method returns a new #ClutterActor for a given #GIcon. If the + line="957">This method returns a new #ClutterActor for a given #GIcon. If the icon isn't loaded already, the texture will be filled asynchronously. A new #ClutterActor for the icon, or %NULL if not found + line="971">A new #ClutterActor for the icon, or %NULL if not found A #StTextureCache + line="959">A #StTextureCache allow-none="1"> The #StThemeNode to use for colors, or %NULL + line="960">The #StThemeNode to use for colors, or %NULL if the icon must not be recolored the #GIcon to load + line="962">the #GIcon to load Size of themed + line="963">Size of themed Scale factor of display + line="964">Scale factor of display Resource scale factor + line="965">Resource scale factor @@ -7155,7 +7180,7 @@ asynchronously. c:identifier="st_texture_cache_load_sliced_image"> This function reads a single image file which contains multiple images internally. + line="1355">This function reads a single image file which contains multiple images internally. The image file will be divided using @grid_width and @grid_height; note that the dimensions of the image loaded from @path should be a multiple of the specified grid dimensions. @@ -7163,38 +7188,38 @@ should be a multiple of the specified grid dimensions. A new #ClutterActor + line="1370">A new #ClutterActor A #StTextureCache + line="1357">A #StTextureCache A #GFile + line="1358">A #GFile Width in pixels + line="1359">Width in pixels Height in pixels + line="1360">Height in pixels Scale factor of the display + line="1361">Scale factor of the display @@ -7208,7 +7233,7 @@ should be a multiple of the specified grid dimensions. closure="6"> Function called when the image is loaded, or %NULL + line="1362">Function called when the image is loaded, or %NULL allow-none="1"> Data to pass to the load callback + line="1363">Data to pass to the load callback @@ -7226,12 +7251,12 @@ should be a multiple of the specified grid dimensions. c:identifier="st_texture_cache_rescan_icon_theme"> Rescan the current icon theme, if necessary. + line="1669">Rescan the current icon theme, if necessary. %TRUE if the icon theme has changed and needed to be reloaded. + line="1674">%TRUE if the icon theme has changed and needed to be reloaded. diff --git a/girs/TelepathyFarstream-0.6.gir b/girs/TelepathyFarstream-0.6.gir index 1555581f4..ed752a172 100644 --- a/girs/TelepathyFarstream-0.6.gir +++ b/girs/TelepathyFarstream-0.6.gir @@ -15,6 +15,60 @@ and/or use gtk-doc annotations. --> shared-library="libtelepathy-farstream.so.3" c:identifier-prefixes="tf_,Tf" c:symbol-prefixes="tf_,tf"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="TfChannel" glib:get-type="tf_channel_get_type" glib:type-struct="ChannelClass"> - All members of the object are private + All members of the object are private + - Completes the construction of a TfChannel. + Completes the construction of a TfChannel. + - a #TfChannel or %NULL if there was an error + a #TfChannel or %NULL if there was an error - The #GObject + The #GObject - a #GAsyncResult + a #GAsyncResult - Creates a new #TfChannel from an existing channel proxy, the new + Creates a new #TfChannel from an existing channel proxy, the new TfChannel object will be return in the async callback. The user must call tf_channel_new_finish() in the callback to get the finished object. + - a #TpChannel proxy + a #TpChannel proxy allow-none="1" scope="async" closure="2"> - a #GAsyncReadyCallback to call when the channel is ready + a #GAsyncReadyCallback to call when the channel is ready - - the data to pass to callback function + + the data to pass to callback function - You must call this function on call messages received on the async bus. + You must call this function on call messages received on the async bus. #GstMessages are not modified. + - %TRUE if the message has been handled, %FALSE otherwise + %TRUE if the message has been handled, %FALSE otherwise - A #TfChannel + A #TfChannel - A #GstMessage received from the bus + A #GstMessage received from the bus @@ -102,11 +189,15 @@ to get the finished object. - + - This function is called after a channel is closed, either because + This function is called after a channel is closed, either because it has been closed by the connection manager or because we had a locally generated error. @@ -114,7 +205,9 @@ generated error. - Tells the application that a content has been added. In the callback for + Tells the application that a content has been added. In the callback for this signal, the application should set its preferred codecs, and hook up to any signal from #TfContent it cares about. Special care should be made to connect #TfContent::src-pad-added as well @@ -124,45 +217,59 @@ as the #TfContent::start-sending and #TfContent::stop-sending signals. - a #TfContent + a #TfContent - Tells the application that a content is being removed. + Tells the application that a content is being removed. - a #TfContent + a #TfContent - When this signal is emitted, the conference should be added to the + When this signal is emitted, the conference should be added to the application's pipeline. - a #FsConference + a #FsConference - When this signal is emitted, the conference should be remove from the + When this signal is emitted, the conference should be remove from the application's pipeline. - a #FsConference + a #FsConference @@ -171,10 +278,18 @@ application's pipeline. - There are no overridable functions + There are no overridable functions + - + + glib:type-name="TfContent" glib:get-type="tf_content_get_type" glib:type-struct="ContentClass"> - This structure is private, this class is not subclassable. + This structure is private, this class is not subclassable. + - Send a fatal streaming error to the Content to the CM, the effect is most + Send a fatal streaming error to the Content to the CM, the effect is most likely that the content will be removed. + - a #TfContent + a #TfContent - error Message with printf style formatting + error Message with printf style formatting - Parameters to insert into the @message_format string + Parameters to insert into the @message_format string @@ -212,41 +339,59 @@ likely that the content will be removed. - Send a fatal streaming error to the Content to the CM, the effect is most + Send a fatal streaming error to the Content to the CM, the effect is most likely that the content will be removed. + - a #TfContent + a #TfContent - error Message + error Message - Provides a iterator that can be used to iterate through all of the src + Provides a iterator that can be used to iterate through all of the src pads that are are used to receive from a group of Telepathy handles. + - a #GstIterator + a #GstIterator - a #TfContent + a #TfContent - a 0 terminated array of #guint representing Telepathy handles + a 0 terminated array of #guint representing Telepathy handles - the numner of handles in @handles + the numner of handles in @handles @@ -255,33 +400,46 @@ pads that are are used to receive from a group of Telepathy handles. c:identifier="tf_content_receiving_failed" shadowed-by="receiving_failed_literal" introspectable="0"> - Informs the Connection Manager that receiving has failed for this + Informs the Connection Manager that receiving has failed for this content. This is a transient error and it may or not not end the Content and the call. If handles are not specific, it assumes that it is valid for all handles. + - a #TfContent + a #TfContent - an array of #guint representing Telepathy handles, may be %NULL + an array of #guint representing Telepathy handles, may be %NULL - the numner of handles in @handles + the numner of handles in @handles - Message with printf style formatting + Message with printf style formatting - Parameters to insert into the @message_format string + Parameters to insert into the @message_format string @@ -289,29 +447,40 @@ If handles are not specific, it assumes that it is valid for all handles. - Informs the Connection Manager that receiving has failed for this + Informs the Connection Manager that receiving has failed for this content. This is a transient error and it may or not not end the Content and the call. If handles are not specific, it assumes that it is valid for all handles. + - a #TfContent + a #TfContent - an array of #guint representing Telepathy handles, may be %NULL + an array of #guint representing Telepathy handles, may be %NULL - the numner of handles in @handles + the numner of handles in @handles - The error message + The error message @@ -320,23 +489,32 @@ If handles are not specific, it assumes that it is valid for all handles. c:identifier="tf_content_sending_failed" shadowed-by="sending_failed_literal" introspectable="0"> - Informs the Connection Manager that sending has failed for this + Informs the Connection Manager that sending has failed for this content. This is a transient error and it may or not not end the Content and the call. + - a #TfContent + a #TfContent - Message with printf style formatting + Message with printf style formatting - Parameters to insert into the @message_format string + Parameters to insert into the @message_format string @@ -344,19 +522,26 @@ and the call. - Informs the Connection Manager that sending has failed for this + Informs the Connection Manager that sending has failed for this content. This is a transient error and it may or not not end the Content and the call. + - a #TfContent + a #TfContent - The error message + The error message @@ -367,10 +552,14 @@ and the call. - + - + @@ -380,14 +569,18 @@ and the call. - This signal requests that the source be restarted so that the caps can + This signal requests that the source be restarted so that the caps can be renegotiated with a new resolutions and framerate. - This signal is emitted when a data is coming on a new pad. This signal + This signal is emitted when a data is coming on a new pad. This signal is not emitted on the main thread, so special care must be made to lock the relevant data. When the callback returns from this signal, data will start flowing through the pad, so the application MUST connect a sink. @@ -396,26 +589,36 @@ start flowing through the pad, so the application MUST connect a sink. - the handle of the remote party producing the content on this pad + the handle of the remote party producing the content on this pad or 0 if unknown - the #FsStream for this pad + the #FsStream for this pad - a #GstPad + a #GstPad - the #FsCodec for this pad + the #FsCodec for this pad - This signal is emitted when the connection managers requests that the + This signal is emitted when the connection managers requests that the application prepares itself to start receiving data again from certain handles. @@ -423,51 +626,75 @@ This signal will only be emitted after the #TfContent::stop-receiving signal has succeeded. It will not be emitted right after #TfContent::src-pad-added. - %TRUE if the application can start receiving data or %FALSE + %TRUE if the application can start receiving data or %FALSE otherwise - - a 0-terminated array of #guint containing the handles + + a 0-terminated array of #guint containing the handles - The number of handles in the @handles array + The number of handles in the @handles array - This signal is emitted when the connection manager ask to send media. + This signal is emitted when the connection manager ask to send media. For example, this can be used to open a camera, start recording from a microphone or play back a file. The application should start sending data on the #TfContent:sink-pad - %TRUE if the application can start providing data or %FALSE + %TRUE if the application can start providing data or %FALSE otherwise - This signal is emitted when the connection manager wants to tell the + This signal is emitted when the connection manager wants to tell the application that it is now allowed to stop receiving. - - a 0-terminated array of #guint containing the handles + + a 0-terminated array of #guint containing the handles - The number of handles in the @handles array + The number of handles in the @handles array - This signal is emitted when the connection manager ask to stop + This signal is emitted when the connection manager ask to stop sending media @@ -477,10 +704,73 @@ sending media - This structure is private, this class is not subclassable. + This structure is private, this class is not subclassable. + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This class handles the +org.freedesktop.Telepathy.Channel.Interface.MediaSignalling on a +channel using Farstream or the media part of the +org.freedesktop.Telepathy.Channel.Type.Call that has HardwareStreaming=FALSE + + + Objects of this class allow the user to handle the media side of a Telepathy +channel handled by #TfChannel. + +This object is created by the #TfChannel and the user is notified +of its creation by the #TfChannel::content-added signal. In the +callback for this signal, the user should connect to the +#TfContent::src-pad-added signal. + diff --git a/girs/TelepathyGLib-0.12.gir b/girs/TelepathyGLib-0.12.gir index 6d7b993cf..1271dc19c 100644 --- a/girs/TelepathyGLib-0.12.gir +++ b/girs/TelepathyGLib-0.12.gir @@ -16286,19 +16286,19 @@ value. It is now non-%NULL in all cases. version="0.15.6"> <!-- --> + line="809"><!-- --> the value of #TpChannel:initiator-contact + line="815">the value of #TpChannel:initiator-contact a channel + line="811">a channel @@ -16384,19 +16384,19 @@ value. It is now non-%NULL in all cases. version="0.15.6"> <!-- --> + line="792"><!-- --> the value of #TpChannel:target-contact + line="798">the value of #TpChannel:target-contact a channel + line="794">a channel @@ -16406,7 +16406,7 @@ value. It is now non-%NULL in all cases. version="0.15.6"> If @self is a group and the %TP_CHANNEL_FEATURE_CONTACTS feature has been + line="868">If @self is a group and the %TP_CHANNEL_FEATURE_CONTACTS feature has been prepared, return a #GPtrArray containing its local-pending members. If @self is a group but %TP_CHANNEL_FEATURE_CONTACTS has not been prepared, @@ -16417,7 +16417,7 @@ If @self is not a group, return %NULL. + line="880"> a new #GPtrArray of #TpContact, free it with g_ptr_array_unref(), or %NULL. @@ -16427,7 +16427,7 @@ If @self is not a group, return %NULL. a channel + line="870">a channel @@ -16437,7 +16437,7 @@ If @self is not a group, return %NULL. version="0.15.6"> If @self is a group and the %TP_CHANNEL_FEATURE_CONTACTS feature has been + line="843">If @self is a group and the %TP_CHANNEL_FEATURE_CONTACTS feature has been prepared, return a #GPtrArray containing its members. If @self is a group but %TP_CHANNEL_FEATURE_CONTACTS has not been prepared, @@ -16448,7 +16448,7 @@ If @self is not a group, return %NULL. + line="855"> a new #GPtrArray of #TpContact, free it with g_ptr_array_unref(), or %NULL. @@ -16458,7 +16458,7 @@ If @self is not a group, return %NULL. a channel + line="845">a channel @@ -16468,7 +16468,7 @@ If @self is not a group, return %NULL. version="0.15.6"> If @self is a group and the %TP_CHANNEL_FEATURE_CONTACTS feature has been + line="893">If @self is a group and the %TP_CHANNEL_FEATURE_CONTACTS feature has been prepared, return a #GPtrArray containing its remote-pending members. If @self is a group but %TP_CHANNEL_FEATURE_CONTACTS has not been prepared, @@ -16479,7 +16479,7 @@ If @self is not a group, return %NULL. + line="905"> a new #GPtrArray of #TpContact, free it with g_ptr_array_unref(), or %NULL. @@ -16489,7 +16489,7 @@ If @self is not a group, return %NULL. a channel + line="895">a channel @@ -16499,7 +16499,7 @@ If @self is not a group, return %NULL. version="0.15.6"> Synopsis (see below for further explanation): + line="999">Synopsis (see below for further explanation): - if @self is not a group or @contact is not a member of this channel, result is undefined; @@ -16536,7 +16536,7 @@ Group's remote-pending set). the global contact that owns the given contact, + line="1038">the global contact that owns the given contact, or %NULL. @@ -16544,13 +16544,13 @@ Group's remote-pending set). a channel + line="1001">a channel a contact which is a member of this channel + line="1002">a contact which is a member of this channel @@ -16680,7 +16680,7 @@ If @self is not a group, return %NULL. version="0.15.6"> If @local_pending is actually a local-pending contact, + line="918">If @local_pending is actually a local-pending contact, write additional information into @actor, @reason and @message and return %TRUE. The contact and message are not referenced or copied, and can only be assumed to remain valid until the main loop is re-entered. @@ -16692,20 +16692,20 @@ and "" into @message, and return %FALSE. %TRUE if the contact is in fact local-pending + line="940">%TRUE if the contact is in fact local-pending a channel + line="920">a channel the #TpContact of a local-pending contact about whom more + line="921">the #TpContact of a local-pending contact about whom more information is needed @@ -16717,7 +16717,7 @@ and "" into @message, and return %FALSE. allow-none="1"> either %NULL or a location to + line="923">either %NULL or a location to return the contact who requested the change @@ -16729,7 +16729,7 @@ and "" into @message, and return %FALSE. allow-none="1"> either %NULL or a location to return the reason + line="925">either %NULL or a location to return the reason for the change @@ -16742,7 +16742,7 @@ and "" into @message, and return %FALSE. allow-none="1"> either %NULL or a location to + line="927">either %NULL or a location to return the user-supplied message @@ -16892,19 +16892,19 @@ If @self is not a group, return %NULL. version="0.15.6"> <!-- --> + line="826"><!-- --> the value of #TpChannel:group-self-contact + line="832">the value of #TpChannel:group-self-contact a channel + line="828">a channel diff --git a/girs/TelepathyLogger-0.2.gir b/girs/TelepathyLogger-0.2.gir index 8b4e6e174..4acd2ec5a 100644 --- a/girs/TelepathyLogger-0.2.gir +++ b/girs/TelepathyLogger-0.2.gir @@ -835,14 +835,14 @@ data, %FALSE otherwise %TRUE if @event should appear in the result + line="70">%TRUE if @event should appear in the result the #TplEvent to filter + line="67">the #TplEvent to filter closure="1"> user-supplied data + line="68">user-supplied data @@ -866,7 +866,7 @@ data, %FALSE otherwise glib:type-struct="LogManagerClass"> An object used to access logs + line="59">An object used to access logs @@ -874,7 +874,7 @@ data, %FALSE otherwise a new reference on the log manager + line="303">a new reference on the log manager @@ -884,7 +884,7 @@ data, %FALSE otherwise the #GQuark associated with the error domain of #TplLogManager + line="1419">the #GQuark associated with the error domain of #TplLogManager @@ -893,8 +893,8 @@ data, %FALSE otherwise introspectable="0"> Free @hits and its content. - + line="704">Free @hits and its content. + @@ -902,72 +902,17 @@ data, %FALSE otherwise a #GList of #TplLogSearchHit + line="706">a #GList of #TplLogSearchHit - - Disables logging of events for given entity. By default logging is enabled -for all entities. - - - - - - - the log manager -@entity a TplEntity - - - - - - - - - - - - Re-enables logging of events for entity previously disabled by -tpl_log_manager_disable_for_entity(). By default logging is enabled for all -entities. - - - - - - - the log manager - - - - - - - a TplEntity - - - - Checks if logs exist for @target. + line="424">Checks if logs exist for @target. It applies for any registered TplLogStore with the TplLogStore:readable property %TRUE. @@ -975,32 +920,32 @@ property %TRUE. %TRUE logs exist for @target, otherwise %FALSE + line="436">%TRUE logs exist for @target, otherwise %FALSE TplLogManager + line="426">TplLogManager TpAccount + line="427">TpAccount a non-NULL #TplEntity + line="428">a non-NULL #TplEntity event type filter see #TplEventTypeMask + line="429">event type filter see #TplEventTypeMask @@ -1009,7 +954,7 @@ property %TRUE. c:identifier="tpl_log_manager_get_dates_async"> Retrieves a list of #GDate corresponding to each day where + line="860">Retrieves a list of #GDate corresponding to each day where at least one event exist for @target. It applies for any registered TplLogStore with the TplLogStore:readable @@ -1022,25 +967,25 @@ property %TRUE. a #TplLogManager + line="862">a #TplLogManager a #TpAccount + line="863">a #TpAccount a non-NULL #TplEntity + line="864">a non-NULL #TplEntity event type filter see #TplEventTypeMask + line="865">event type filter see #TplEventTypeMask closure="4"> a callback to call when the request is satisfied + line="866">a callback to call when the request is satisfied allow-none="1"> data to pass to @callback + line="867">data to pass to @callback @@ -1072,20 +1017,20 @@ property %TRUE. #TRUE if the operation was successful, otherwise #FALSE + line="921">#TRUE if the operation was successful, otherwise #FALSE a #TplLogManager + line="915">a #TplLogManager a #GAsyncResult + line="916">a #GAsyncResult transfer-ownership="full"> a pointer to a + line="917">a pointer to a #GList used to return the list of #GDate @@ -1106,7 +1051,7 @@ property %TRUE. c:identifier="tpl_log_manager_get_entities_async"> Start a query looking for all entities for which you have logs in the @account. + line="1240">Start a query looking for all entities for which you have logs in the @account. @@ -1115,13 +1060,13 @@ property %TRUE. a #TplLogManager + line="1242">a #TplLogManager a #TpAccount + line="1243">a #TpAccount closure="2"> a callback to call when the request is satisfied + line="1244">a callback to call when the request is satisfied allow-none="1"> data to pass to @callback + line="1245">data to pass to @callback @@ -1153,20 +1098,20 @@ property %TRUE. #TRUE if the operation was successful, otherwise #FALSE + line="1291">#TRUE if the operation was successful, otherwise #FALSE a #TplLogManager + line="1284">a #TplLogManager a #GAsyncResult + line="1285">a #GAsyncResult transfer-ownership="full"> a + line="1286">a pointer to a #GList used to return the list of #TplEntity, to be freed using something like g_list_free_full (lst, g_object_unref) @@ -1188,7 +1133,7 @@ property %TRUE. c:identifier="tpl_log_manager_get_events_for_date_async"> Retrieve a list of #TplEvent at @date with @target. + line="971">Retrieve a list of #TplEvent at @date with @target. @@ -1197,31 +1142,31 @@ property %TRUE. a #TplLogManager + line="973">a #TplLogManager a #TpAccount + line="974">a #TpAccount a non-NULL #TplEntity + line="975">a non-NULL #TplEntity event type filter see #TplEventTypeMask + line="976">event type filter see #TplEventTypeMask a #GDate + line="977">a #GDate closure="5"> a callback to call when the request is satisfied + line="978">a callback to call when the request is satisfied allow-none="1"> data to pass to @callback + line="979">data to pass to @callback @@ -1253,20 +1198,20 @@ property %TRUE. #TRUE if the operation was successful, otherwise #FALSE + line="1032">#TRUE if the operation was successful, otherwise #FALSE a #TplLogManager + line="1026">a #TplLogManager a #GAsyncResult + line="1027">a #GAsyncResult transfer-ownership="full"> a + line="1028">a pointer to a #GList used to return the list of #TplEvent @@ -1287,7 +1232,7 @@ property %TRUE. c:identifier="tpl_log_manager_get_filtered_events_async"> Retrieve the most recent @num_event events exchanged with @target. + line="1081">Retrieve the most recent @num_event events exchanged with @target. @@ -1296,31 +1241,31 @@ property %TRUE. a #TplLogManager + line="1083">a #TplLogManager a #TpAccount + line="1084">a #TpAccount a non-NULL #TplEntity + line="1085">a non-NULL #TplEntity event type filter see #TplEventTypeMask + line="1086">event type filter see #TplEventTypeMask number of maximum events to fetch + line="1087">number of maximum events to fetch closure="5"> an optional filter function + line="1088">an optional filter function allow-none="1"> user data to pass to @filter + line="1089">user data to pass to @filter closure="7"> a callback to call when + line="1090">a callback to call when the request is satisfied @@ -1361,7 +1306,7 @@ the request is satisfied allow-none="1"> data to pass to @callback + line="1092">data to pass to @callback @@ -1373,20 +1318,20 @@ the request is satisfied #TRUE if the operation was successful, otherwise #FALSE. + line="1149">#TRUE if the operation was successful, otherwise #FALSE. a #TplLogManager + line="1143">a #TplLogManager a #GAsyncResult + line="1144">a #GAsyncResult transfer-ownership="full"> + line="1145"> a pointer to a #GList used to return the list #TplEvent @@ -1403,41 +1348,10 @@ the request is satisfied - - Checks, whether logging is disabled for given entity. By default, logging -is enabled for all entities. - - - %TRUE if logging for the entity has been disabled, %FALSE otherwise. - - - - - the log manager - - - - - - - a TplEntity - - - - Search for all the conversations containing @text. + line="1338">Search for all the conversations containing @text. @@ -1446,19 +1360,19 @@ is enabled for all entities. a #TplLogManager + line="1340">a #TplLogManager the pattern to search + line="1341">the pattern to search event type filter see #TplEventTypeMask + line="1342">event type filter see #TplEventTypeMask closure="3"> a callback to call when the request is satisfied + line="1343">a callback to call when the request is satisfied allow-none="1"> data to pass to @callback + line="1344">data to pass to @callback #TRUE if the operation was successful, otherwise #FALSE + line="1390">#TRUE if the operation was successful, otherwise #FALSE a #TplLogManager + line="1384">a #TplLogManager a #GAsyncResult + line="1385">a #GAsyncResult transfer-ownership="full"> a + line="1386">a pointer to a #GList used to return the list of #TplLogSearchHit - + @@ -1524,37 +1439,37 @@ is enabled for all entities. c:identifier="tpl_log_manager_walk_filtered_events"> Create a #TplLogWalker to traverse all the events exchanged with @target. + line="1176">Create a #TplLogWalker to traverse all the events exchanged with @target. a #TplLogWalker + line="1187">a #TplLogWalker a #TplLogManager + line="1178">a #TplLogManager a #TpAccount + line="1179">a #TpAccount a non-NULL #TplEntity + line="1180">a non-NULL #TplEntity event type filter see #TplEventTypeMask + line="1181">event type filter see #TplEventTypeMask closure="4"> an optional filter function + line="1182">an optional filter function allow-none="1"> user data to pass to @filter + line="1183">user data to pass to @filter @@ -1923,14 +1838,14 @@ the request is satisfied the same value as the #TplTextEvent:edit-timestamp property + line="398">the same value as the #TplTextEvent:edit-timestamp property a #TplTextEvent + line="396">a #TplTextEvent @@ -1942,14 +1857,14 @@ the request is satisfied the same message as the #TplTextEvent:message property + line="296">the same message as the #TplTextEvent:message property a #TplTextEvent + line="294">a #TplTextEvent @@ -1961,14 +1876,14 @@ the request is satisfied the same message as the #TplTextEvent:message-token property + line="311">the same message as the #TplTextEvent:message-token property a #TplTextEvent + line="309">a #TplTextEvent @@ -1980,7 +1895,7 @@ the request is satisfied the same message as the #TplTextEvent:message-type property + line="382">the same message as the #TplTextEvent:message-type property @@ -1988,7 +1903,7 @@ the request is satisfied a #TplTextEvent + line="380">a #TplTextEvent @@ -1999,7 +1914,7 @@ the request is satisfied A #GList + line="367">A #GList of #TplTextEvent that this event supersedes. @@ -2010,7 +1925,7 @@ supersedes. a #TplTextEvent + line="365">a #TplTextEvent @@ -2022,14 +1937,14 @@ supersedes. the same message as the #TplTextEvent:supersedes-token property + line="326">the same message as the #TplTextEvent:supersedes-token property a #TplTextEvent + line="324">a #TplTextEvent @@ -2107,7 +2022,7 @@ specialized by subclasses of #TplEvent. The #TplLogManager object allows user to fetch logs and make searches. + line="51">The #TplLogManager object allows user to fetch logs and make searches. xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> - + - + @@ -28,7 +28,7 @@ and/or use gtk-doc annotations. --> - + @@ -37,7 +37,7 @@ and/or use gtk-doc annotations. --> - + @@ -104,37 +104,37 @@ and/or use gtk-doc annotations. --> glib:type-name="TeplAbstractFactory" glib:get-type="tepl_abstract_factory_get_type" glib:type-struct="AbstractFactoryClass"> - + Gets the #TeplAbstractFactory singleton instance. + line="118">Gets the #TeplAbstractFactory singleton instance. If tepl_abstract_factory_set_singleton() has not been called, the singleton is created with a #TeplAbstractFactory instance. - + the #TeplAbstractFactory singleton instance. + line="126">the #TeplAbstractFactory singleton instance. - + a new #TeplFile. + line="221">a new #TeplFile. the #TeplAbstractFactory. + line="219">the #TeplAbstractFactory. @@ -142,13 +142,13 @@ is created with a #TeplAbstractFactory instance. Creates a main #GtkApplicationWindow in the sense of + line="154">Creates a main #GtkApplicationWindow in the sense of tepl_application_window_is_main_window(). - + a new main application window, or + line="162">a new main application window, or %NULL if the vfunc is not implemented. @@ -156,13 +156,13 @@ tepl_application_window_is_main_window(). the #TeplAbstractFactory. + line="156">the #TeplAbstractFactory. a #GtkApplication. + line="157">a #GtkApplication. @@ -172,15 +172,15 @@ tepl_application_window_is_main_window(). version="5.0"> Creates a new #GFile that is then intended to be used as an argument to + line="232">Creates a new #GFile that is then intended to be used as an argument to tepl_metadata_manager_load_from_disk() and tepl_metadata_manager_save_to_disk(). This function just creates the #GFile object, it doesn't call any #TeplMetadataManager function. - + a new #GFile, or %NULL if the vfunc is + line="241">a new #GFile, or %NULL if the vfunc is not implemented. @@ -188,24 +188,24 @@ not implemented. the #TeplAbstractFactory. + line="234">the #TeplAbstractFactory. - + a new #TeplTab. + line="185">a new #TeplTab. the #TeplAbstractFactory. + line="183">the #TeplAbstractFactory. @@ -215,12 +215,12 @@ not implemented. version="3.0"> Creates a new tab label for @tab, suitable for gtk_notebook_set_tab_label(). - + line="196">Creates a new tab label for @tab, suitable for gtk_notebook_set_tab_label(). + a new #GtkWidget, or %NULL for the + line="203">a new #GtkWidget, or %NULL for the default tab label (“page N” with #GtkNotebook). @@ -228,32 +228,58 @@ default tab label (“page N” with #GtkNotebook). the #TeplAbstractFactory. + line="198">the #TeplAbstractFactory. a #TeplTab. + line="199">a #TeplTab. + + @dialog is a newly-created #TeplPrefsDialog. This function fills @dialog with +the intended content. + + + + + + + the #TeplAbstractFactory. + + + + a #TeplPrefsDialog. + + + + - + a new #TeplFile. + line="221">a new #TeplFile. the #TeplAbstractFactory. + line="219">the #TeplAbstractFactory. @@ -262,13 +288,13 @@ default tab label (“page N” with #GtkNotebook). c:identifier="tepl_abstract_factory_create_main_window"> Creates a main #GtkApplicationWindow in the sense of + line="154">Creates a main #GtkApplicationWindow in the sense of tepl_application_window_is_main_window(). - + a new main application window, or + line="162">a new main application window, or %NULL if the vfunc is not implemented. @@ -276,13 +302,13 @@ tepl_application_window_is_main_window(). the #TeplAbstractFactory. + line="156">the #TeplAbstractFactory. a #GtkApplication. + line="157">a #GtkApplication. @@ -292,15 +318,15 @@ tepl_application_window_is_main_window(). version="5.0"> Creates a new #GFile that is then intended to be used as an argument to + line="232">Creates a new #GFile that is then intended to be used as an argument to tepl_metadata_manager_load_from_disk() and tepl_metadata_manager_save_to_disk(). This function just creates the #GFile object, it doesn't call any #TeplMetadataManager function. - + a new #GFile, or %NULL if the vfunc is + line="241">a new #GFile, or %NULL if the vfunc is not implemented. @@ -308,7 +334,7 @@ not implemented. the #TeplAbstractFactory. + line="234">the #TeplAbstractFactory. @@ -316,18 +342,18 @@ not implemented. - + a new #TeplTab. + line="185">a new #TeplTab. the #TeplAbstractFactory. + line="183">the #TeplAbstractFactory. @@ -337,12 +363,12 @@ not implemented. version="3.0"> Creates a new tab label for @tab, suitable for gtk_notebook_set_tab_label(). - + line="196">Creates a new tab label for @tab, suitable for gtk_notebook_set_tab_label(). + a new #GtkWidget, or %NULL for the + line="203">a new #GtkWidget, or %NULL for the default tab label (“page N” with #GtkNotebook). @@ -350,30 +376,56 @@ default tab label (“page N” with #GtkNotebook). the #TeplAbstractFactory. + line="198">the #TeplAbstractFactory. a #TeplTab. + line="199">a #TeplTab. + + @dialog is a newly-created #TeplPrefsDialog. This function fills @dialog with +the intended content. + + + + + + + the #TeplAbstractFactory. + + + + a #TeplPrefsDialog. + + + + Sets the #TeplAbstractFactory singleton. This should be called early in + line="89">Sets the #TeplAbstractFactory singleton. This should be called early in main(), for example just after calling tepl_init(). This function must be called only once, before the first call to tepl_abstract_factory_get_singleton(). Tepl takes ownership of the @factory reference. - + @@ -381,7 +433,7 @@ Tepl takes ownership of the @factory reference. a #TeplAbstractFactory. + line="91">a #TeplAbstractFactory. @@ -393,20 +445,20 @@ Tepl takes ownership of the @factory reference. - + The parent class. + line="36">The parent class. - + a new main application window, or + line="162">a new main application window, or %NULL if the vfunc is not implemented. @@ -414,13 +466,13 @@ Tepl takes ownership of the @factory reference. the #TeplAbstractFactory. + line="156">the #TeplAbstractFactory. a #GtkApplication. + line="157">a #GtkApplication. @@ -428,18 +480,18 @@ Tepl takes ownership of the @factory reference. - + a new #TeplTab. + line="185">a new #TeplTab. the #TeplAbstractFactory. + line="183">the #TeplAbstractFactory. @@ -447,11 +499,11 @@ Tepl takes ownership of the @factory reference. - + a new #GtkWidget, or %NULL for the + line="203">a new #GtkWidget, or %NULL for the default tab label (“page N” with #GtkNotebook). @@ -459,13 +511,13 @@ default tab label (“page N” with #GtkNotebook). the #TeplAbstractFactory. + line="198">the #TeplAbstractFactory. a #TeplTab. + line="199">a #TeplTab. @@ -473,18 +525,18 @@ default tab label (“page N” with #GtkNotebook). - + a new #TeplFile. + line="221">a new #TeplFile. the #TeplAbstractFactory. + line="219">the #TeplAbstractFactory. @@ -492,11 +544,11 @@ default tab label (“page N” with #GtkNotebook). - + a new #GFile, or %NULL if the vfunc is + line="241">a new #GFile, or %NULL if the vfunc is not implemented. @@ -504,9 +556,31 @@ not implemented. the #TeplAbstractFactory. + line="234">the #TeplAbstractFactory. + + + + + + + + + + + + + + the #TeplAbstractFactory. + + a #TeplPrefsDialog. + + @@ -1085,7 +1159,7 @@ name. a new #TeplBuffer. + line="410">a new #TeplBuffer. @@ -1105,7 +1179,7 @@ name. version="1.0"> Returns the #TeplFile of @buffer. The returned object is guaranteed to be the + line="419">Returns the #TeplFile of @buffer. The returned object is guaranteed to be the same for the lifetime of @buffer. #TeplBuffer creates the #TeplFile with tepl_abstract_factory_create_file(). @@ -1113,14 +1187,14 @@ same for the lifetime of @buffer. the associated #TeplFile. + line="428">the associated #TeplFile. a #TeplBuffer. + line="421">a #TeplBuffer. @@ -1130,7 +1204,7 @@ same for the lifetime of @buffer. version="3.0"> Returns a title suitable for a #GtkWindow title. It contains (in that order): + line="593">Returns a title suitable for a #GtkWindow title. It contains (in that order): - the #TeplBuffer:tepl-short-title; - the directory path in parenthesis if the #TeplFile:location isn't %NULL. @@ -1138,7 +1212,7 @@ same for the lifetime of @buffer. the @buffer full title. Free the return value with g_free() when no + line="602">the @buffer full title. Free the return value with g_free() when no longer needed. @@ -1146,7 +1220,7 @@ longer needed. a #TeplBuffer. + line="595">a #TeplBuffer. @@ -1156,20 +1230,20 @@ longer needed. version="5.0"> Returns the #TeplMetadata of @buffer. The returned object is guaranteed to be + line="442">Returns the #TeplMetadata of @buffer. The returned object is guaranteed to be the same for the lifetime of @buffer. the associated #TeplMetadata. + line="449">the associated #TeplMetadata. a #TeplBuffer. + line="444">a #TeplBuffer. @@ -1177,18 +1251,18 @@ the same for the lifetime of @buffer. - + the current #TeplSelectionType. + line="811">the current #TeplSelectionType. a #TeplBuffer. + line="809">a #TeplBuffer. @@ -1198,14 +1272,14 @@ the same for the lifetime of @buffer. version="3.0"> Returns a title suitable for a tab label. It contains (in that order): + line="555">Returns a title suitable for a tab label. It contains (in that order): - '*' if the buffer is modified; - the #TeplFile:short-name. the @buffer short title. Free the return value with g_free() when no + line="563">the @buffer short title. Free the return value with g_free() when no longer needed. @@ -1213,7 +1287,7 @@ longer needed. a #TeplBuffer. + line="557">a #TeplBuffer. @@ -1221,18 +1295,18 @@ longer needed. - + the #TeplBuffer:tepl-style-scheme-id. Free with g_free(). + line="697">the #TeplBuffer:tepl-style-scheme-id. Free with g_free(). a #TeplBuffer. + line="695">a #TeplBuffer. @@ -1242,7 +1316,7 @@ longer needed. version="1.0"> Returns whether @buffer is untouched. + line="523">Returns whether @buffer is untouched. This function is for example useful to know if we can re-use this buffer to load a file, instead of opening a new tab or window. @@ -1254,14 +1328,14 @@ the undo/redo #GtkSourceBuffer history must be empty, and the %TRUE if @buffer has not been touched, %FALSE otherwise. + line="536">%TRUE if @buffer has not been touched, %FALSE otherwise. a #TeplBuffer. + line="525">a #TeplBuffer. @@ -1271,7 +1345,7 @@ the undo/redo #GtkSourceBuffer history must be empty, and the version="5.0"> Calls tepl_metadata_manager_copy_from() for #TeplFile:location (if not %NULL) + line="463">Calls tepl_metadata_manager_copy_from() for #TeplFile:location (if not %NULL) to the associated #TeplMetadata of @buffer. @@ -1281,9 +1355,54 @@ to the associated #TeplMetadata of @buffer. a #TeplBuffer. + line="465">a #TeplBuffer. + + + + + + A convenience function to provide a #GSettings key corresponding to the +#TeplBuffer:tepl-style-scheme-id property. + +Once this function is called, calling tepl_buffer_set_style_scheme_id() or +setting the property will benefit from a fallback mechanism that takes the +default value of the #GSettings key (see g_settings_get_default_value()). + +If @bind_to_property is %TRUE, then this function additionally binds the +#GSettings key to the property with the %G_SETTINGS_BIND_GET flag. + + + + + + + a #TeplBuffer. + + a #GSettings object. + + + + a #GSettings key of type string. + + + + whether to bind the #GSettings key to the property. + + version="5.0"> Calls tepl_metadata_manager_merge_into() for #TeplFile:location (if not + line="493">Calls tepl_metadata_manager_merge_into() for #TeplFile:location (if not %NULL) from the associated #TeplMetadata of @buffer. @@ -1301,7 +1420,7 @@ to the associated #TeplMetadata of @buffer. a #TeplBuffer. + line="495">a #TeplBuffer. @@ -1311,12 +1430,23 @@ to the associated #TeplMetadata of @buffer. version="2.0"> Sets the #TeplBuffer:tepl-style-scheme-id property. + line="747">Sets the #TeplBuffer:tepl-style-scheme-id property. The #GtkSourceStyleScheme is taken from the default #GtkSourceStyleSchemeManager as returned by -gtk_source_style_scheme_manager_get_default(). - +gtk_source_style_scheme_manager_get_default(). + +Since 6.4, if there are no #GtkSourceStyleScheme for @style_scheme_id, there +is a fallback mechanism that takes the default value of the provided +#GSettings key (see tepl_buffer_provide_style_scheme_id_gsetting()); if the +#GSettings key was not provided, it takes a recommended #GtkSourceStyleScheme +provided by GtkSourceView (see the documentation of +gtk_source_buffer_set_style_scheme()). + +If more flexibility is desired, don't use the +#TeplBuffer:tepl-style-scheme-id property, use the #GtkSourceBuffer API +instead. + @@ -1324,13 +1454,13 @@ gtk_source_style_scheme_manager_get_default(). a #TeplBuffer. + line="749">a #TeplBuffer. the new value. + line="750">the new value. @@ -1341,7 +1471,7 @@ gtk_source_style_scheme_manager_get_default(). default-value="NULL"> The full title. See tepl_buffer_get_full_title(). + line="306">The full title. See tepl_buffer_get_full_title(). default-value="NULL"> The short title. See tepl_buffer_get_short_title(). + line="291">The short title. See tepl_buffer_get_short_title(). transfer-ownership="none"> The #GtkSourceBuffer:style-scheme ID, as a string. This property is + line="321">The #GtkSourceBuffer:style-scheme ID, as a string. This property is useful for binding it to a #GSettings key. When the #GtkSourceBuffer:style-scheme is %NULL, @@ -1372,7 +1502,7 @@ When the #GtkSourceBuffer:style-scheme is %NULL, The ::tepl-cursor-moved signal is emitted when the insert mark is + line="342">The ::tepl-cursor-moved signal is emitted when the insert mark is moved explicitely or when the buffer changes (insert/delete). A typical use-case for this signal is to update the cursor position @@ -1408,6 +1538,359 @@ in a statusbar. + + To implement the #TeplEncoding interface. + +Don't access the fields of this struct unless you are writing a class that +implements this interface. + + + the #TeplEncodingVtable of the object. + + + + #TeplEncoding's are grouped into several categories, such as "Unicode" or +"Western". + +This function returns the category name of the #TeplEncoding, or %NULL if the +category is unknown. + +The returned string is localized (i.e., already translated). + + + the category name of the #TeplEncoding, or %NULL. + + + + + a #TeplEncoding. + + + + + + Gets the name of the #TeplEncoding, such as "UTF-8". + + + the name of the #TeplEncoding. + + + + + a #TeplEncoding. + + + + + + + + + + + a copy of @enc. + + + + + a #TeplEncodingIconv. + + + + + + Returns whether @enc1 and @enc2 are equal. It returns %TRUE iff: +- Both @enc1 and @enc2 are %NULL; +- Or both @enc1 and @enc2 have a UTF-8 charset (see + tepl_encoding_iconv_is_utf8()); +- Or the charsets are equal according to g_ascii_strcasecmp() (because + iconv-compatible charsets are case insensitive). + + + whether @enc1 and @enc2 are equal. + + + + + a #TeplEncodingIconv, or %NULL. + + + + a #TeplEncodingIconv, or %NULL. + + + + + + + + + + + + a #TeplEncodingIconv, or %NULL. + + + + + + Returns whether @enc is a UTF-8 encoding. + +If @enc was created with tepl_encoding_iconv_new_utf8(), the charset is +"UTF-8". But iconv supports other variants: "UTF8", "utf-8" and "utf8". This +function returns %TRUE for all UTF-8 variants supported by iconv. + + + whether @enc is a UTF-8 encoding. + + + + + a #TeplEncodingIconv. + + + + + + + + the #TeplEncoding object of @enc. + + + + + a #TeplEncodingIconv object. + + + + + + Returns the encoding category name with the charset in parenthesis, for +example "Unicode (UTF-8)". If the category name is unknown, just the charset +is returned. + +The category name is localized (i.e., already translated). + + + a string representation. Free with g_free() when no longer needed. + + + + + a #TeplEncodingIconv. + + + + + + Gets a list of all encodings known by #TeplEncodingIconv. + + + a list of + #TeplEncodingIconv's. + + + + + + + Gets the list of default candidate encodings to try when loading a file. See +gtk_source_file_loader_set_candidate_encodings(). + +This function returns a different list depending on the current locale (i.e. +language, country and default encoding). The UTF-8 encoding and the current +locale encoding are guaranteed to be present in the returned list. + +Note that the returned list doesn't contain all encodings known by +#TeplEncodingIconv, it is a limited list that contains only the encodings +that have the most likelihood to fit for the current locale. + + + the list of + default candidate encodings. + + + + + + + Creates a new #TeplEncodingIconv from a character set such as "UTF-8" or +"ISO-8859-1". + +The tepl_encoding_get_name() function will return exactly the same string as +the @charset passed in to this constructor. + + + the new #TeplEncodingIconv. Free with tepl_encoding_iconv_free(). + + + + + a character set. + + + + + + Creates a new #TeplEncodingIconv from the current locale, as returned by +g_get_charset(). + + + the new #TeplEncodingIconv. Free with tepl_encoding_iconv_free(). + + + + + Creates a new #TeplEncodingIconv with the "UTF-8" character set. + + + the new #TeplEncodingIconv. Free with tepl_encoding_iconv_free(). + + + + + + The virtual function table of the #TeplEncoding interface. + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -1496,11 +1979,11 @@ in a statusbar. glib:type-struct="FileClass"> - + a new #TeplFile object. + line="414">a new #TeplFile object. @@ -1584,9 +2067,9 @@ of @chooser. version="4.0"> If the #TeplFile:location isn't %NULL, adds its URI to the default + line="670">If the #TeplFile:location isn't %NULL, adds its URI to the default #GtkRecentManager with gtk_recent_manager_add_item(). - + @@ -1594,7 +2077,27 @@ of @chooser. a #TeplFile. + line="672">a #TeplFile. + + + + + + + + the value of the #TeplFile:full-name property. Free with g_free(). + + + + + a #TeplFile. @@ -1603,18 +2106,18 @@ of @chooser. c:identifier="tepl_file_get_location" glib:get-property="location" version="1.0"> - + the value of the #TeplFile:location property. + line="458">the value of the #TeplFile:location property. a #TeplFile. + line="456">a #TeplFile. @@ -1623,18 +2126,18 @@ of @chooser. c:identifier="tepl_file_get_newline_type" glib:get-property="newline-type" version="1.0"> - + the value of the #TeplFile:newline-type property. + line="566">the value of the #TeplFile:newline-type property. a #TeplFile. + line="564">a #TeplFile. @@ -1643,19 +2146,18 @@ of @chooser. c:identifier="tepl_file_get_short_name" glib:get-property="short-name" version="5.0"> - + the value of the #TeplFile:short-name property. Free with g_free() - when no longer needed. + line="473">the value of the #TeplFile:short-name property. Free with g_free(). a #TeplFile. + line="471">a #TeplFile. @@ -1666,8 +2168,8 @@ of @chooser. version="1.0"> Sets the #TeplFile:location property. - + line="423">Sets the #TeplFile:location property. + @@ -1675,7 +2177,7 @@ of @chooser. a #TeplFile. + line="425">a #TeplFile. allow-none="1"> the new #GFile, or %NULL. + line="426">the new #GFile, or %NULL. @@ -1695,13 +2197,13 @@ of @chooser. introspectable="0"> Sets a #TeplMountOperationFactory function that will be called when a + line="577">Sets a #TeplMountOperationFactory function that will be called when a #GMountOperation must be created. This is useful for creating a #GtkMountOperation with the parent #GtkWindow. If a mount operation factory isn't set, g_mount_operation_new() will be called. - + @@ -1709,7 +2211,7 @@ called. a #TeplFile. + line="579">a #TeplFile. destroy="2"> a #TeplMountOperationFactory to call when a + line="580">a #TeplMountOperationFactory to call when a #GMountOperation is needed. @@ -1730,7 +2232,7 @@ called. allow-none="1"> the data to pass to the @callback function. + line="582">the data to pass to the @callback function. scope="async"> function to call on @user_data when the @callback is no + line="583">function to call on @user_data when the @callback is no longer needed, or %NULL. - + Sets a #TeplUntitledFileCallback, useful to customize the +#TeplFile:short-name. + + + + + + + a #TeplFile. + + + + a #TeplUntitledFileCallback, or %NULL to unset. + + + + + + Convenience property for the full name of a #TeplFile. + +When the #TeplFile:location is %NULL, this property has the same +value as the #TeplFile:short-name. + +When the #TeplFile:location is not %NULL, this property contains the +full path to the location. It uses: +- g_file_get_parse_name() +- tepl_utils_replace_home_dir_with_tilde() + + + getter="get_location"> The location. + line="221">The location. default-value="TEPL_NEWLINE_TYPE_LF"> The line ending type. + line="237">The line ending type. default-value="NULL"> The file short name. + line="253">The file short name. -When the #TeplFile:location is %NULL, this property contains -"Untitled File N", with N the Nth untitled file of the application, -starting at 1. When an untitled file is closed (when the #TeplFile is -freed) or its #TeplFile:location is set, its untitled number is -released and can be used by a later file. +When the #TeplFile:location is %NULL, this property contains by +default "Untitled File N" (translated), with N the Nth untitled file +of the application, starting at 1. When an untitled file is closed +(when the #TeplFile is freed) or its #TeplFile:location is set, its +untitled number is released and can be used by a later file. + +See tepl_file_set_untitled_file_callback() to customize the string. +Other examples: "Unsaved" instead of "Untitled", or "Document" +instead of "File". When the #TeplFile:location is not %NULL, this property contains the display-name (see #G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME). However, @@ -3010,7 +3564,7 @@ and %TEPL_GUTTER_RENDERER_FOLDS_STATE_CONTINUE. - + @@ -3019,7 +3573,7 @@ and %TEPL_GUTTER_RENDERER_FOLDS_STATE_CONTINUE. - + @@ -3200,6 +3754,24 @@ and %TEPL_GUTTER_RENDERER_FOLDS_STATE_CONTINUE. + + + + + + + + + + + + + + @@ -3254,19 +3826,109 @@ and %TEPL_GUTTER_RENDERER_FOLDS_STATE_CONTINUE. + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - + @@ -3290,6 +3952,24 @@ and %TEPL_GUTTER_RENDERER_FOLDS_STATE_CONTINUE. + + + + + + + + + + + + + + @@ -3308,19 +3988,19 @@ and %TEPL_GUTTER_RENDERER_FOLDS_STATE_CONTINUE. - - + - - + @@ -3407,7 +4087,7 @@ and %TEPL_GUTTER_RENDERER_FOLDS_STATE_CONTINUE. a new #TeplInfoBar. + line="349">a new #TeplInfoBar. @@ -3416,26 +4096,26 @@ and %TEPL_GUTTER_RENDERER_FOLDS_STATE_CONTINUE. version="2.0"> Creates a new #TeplInfoBar with an icon (depending on @msg_type), a primary + line="358">Creates a new #TeplInfoBar with an icon (depending on @msg_type), a primary message and a secondary message. a new #TeplInfoBar. + line="367">a new #TeplInfoBar. the message type. + line="360">the message type. the primary message. + line="361">the primary message. allow-none="1"> the secondary message, or %NULL. + line="362">the secondary message, or %NULL. @@ -3454,14 +4134,14 @@ message and a secondary message. version="1.0"> Utility function to create a #GtkLabel suitable for a #GtkInfoBar. The + line="676">Utility function to create a #GtkLabel suitable for a #GtkInfoBar. The wrapping and alignment is configured. The label is also set as selectable, for example to copy an error message and search an explanation on the web. a new #GtkLabel suitable for a #GtkInfoBar. + line="683">a new #GtkLabel suitable for a #GtkInfoBar. @@ -3470,7 +4150,7 @@ for example to copy an error message and search an explanation on the web. version="6.0"> Sets the desired orientation (horizontal or vertical) for the action area as + line="639">Sets the desired orientation (horizontal or vertical) for the action area as returned by gtk_info_bar_get_action_area(). The action area is where the buttons are placed. @@ -3488,13 +4168,13 @@ also follows the original design of #GtkInfoBar. a #GtkInfoBar. + line="641">a #GtkInfoBar. the desired orientation. + line="642">the desired orientation. @@ -3504,7 +4184,7 @@ also follows the original design of #GtkInfoBar. version="6.0"> Adds @widget to @info_bar at @location. + line="543">Adds @widget to @info_bar at @location. As described in #TeplInfoBarLocation, a #TeplInfoBar has internal containers for the content area. So if you need to add a custom #GtkWidget, it is better @@ -3518,19 +4198,19 @@ area. a #TeplInfoBar. + line="545">a #TeplInfoBar. a #GtkWidget. + line="546">a #GtkWidget. a #TeplInfoBarLocation. + line="547">a #TeplInfoBarLocation. @@ -3540,7 +4220,7 @@ area. version="2.0"> Adds a primary message to the %TEPL_INFO_BAR_LOCATION_ALONGSIDE_ICON + line="475">Adds a primary message to the %TEPL_INFO_BAR_LOCATION_ALONGSIDE_ICON location. @@ -3550,13 +4230,13 @@ location. a #TeplInfoBar. + line="477">a #TeplInfoBar. a primary message. + line="478">a primary message. @@ -3566,7 +4246,7 @@ location. version="2.0"> Adds a secondary message to the %TEPL_INFO_BAR_LOCATION_ALONGSIDE_ICON + line="509">Adds a secondary message to the %TEPL_INFO_BAR_LOCATION_ALONGSIDE_ICON location. @@ -3576,13 +4256,13 @@ location. a #TeplInfoBar. + line="511">a #TeplInfoBar. a secondary message. + line="512">a secondary message. @@ -3595,14 +4275,14 @@ location. the value of the #TeplInfoBar:handle-close-response property. + line="586">the value of the #TeplInfoBar:handle-close-response property. a #TeplInfoBar. + line="584">a #TeplInfoBar. @@ -3615,14 +4295,14 @@ location. the value of the #TeplInfoBar:icon-from-message-type property. + line="398">the value of the #TeplInfoBar:icon-from-message-type property. a #TeplInfoBar. + line="396">a #TeplInfoBar. @@ -3635,14 +4315,14 @@ location. the value of the #TeplInfoBar:icon-name property. + line="438">the value of the #TeplInfoBar:icon-name property. a #TeplInfoBar. + line="436">a #TeplInfoBar. @@ -3653,7 +4333,7 @@ location. version="6.0"> Sets a new value to the #TeplInfoBar:handle-close-response property. + line="597">Sets a new value to the #TeplInfoBar:handle-close-response property. @@ -3662,13 +4342,13 @@ location. a #TeplInfoBar. + line="599">a #TeplInfoBar. the new value. + line="600">the new value. @@ -3679,7 +4359,7 @@ location. version="6.0"> Sets a new value to the #TeplInfoBar:icon-from-message-type property. + line="409">Sets a new value to the #TeplInfoBar:icon-from-message-type property. @@ -3688,13 +4368,13 @@ location. a #TeplInfoBar. + line="411">a #TeplInfoBar. the new value. + line="412">the new value. @@ -3705,7 +4385,7 @@ location. version="6.0"> Sets a new value to the #TeplInfoBar:icon-name property. + line="449">Sets a new value to the #TeplInfoBar:icon-name property. @@ -3714,13 +4394,13 @@ location. a #TeplInfoBar. + line="451">a #TeplInfoBar. the new value. + line="452">the new value. @@ -3730,7 +4410,7 @@ location. version="6.0"> Convenience function to set the #GtkInfoBar:show-close-button and + line="621">Convenience function to set the #GtkInfoBar:show-close-button and #TeplInfoBar:handle-close-response properties to %TRUE. @@ -3740,7 +4420,7 @@ location. a #TeplInfoBar. + line="623">a #TeplInfoBar. @@ -3755,7 +4435,7 @@ location. default-value="FALSE"> If this property is %TRUE, then the #TeplInfoBar is destroyed with + line="203">If this property is %TRUE, then the #TeplInfoBar is destroyed with gtk_widget_destroy() when the #GtkInfoBar::response signal is received with the @response_id %GTK_RESPONSE_CLOSE. @@ -3770,7 +4450,7 @@ received with the @response_id %GTK_RESPONSE_CLOSE. default-value="FALSE"> If this property is %TRUE, then an icon is shown on the left, based + line="159">If this property is %TRUE, then an icon is shown on the left, based on the value of the #GtkInfoBar:message-type property. For %GTK_MESSAGE_OTHER no icon is shown. @@ -3791,7 +4471,7 @@ Note that setting this property doesn't change the value of the default-value="NULL"> If set to a non-%NULL value, then an icon is shown on the left. + line="183">If set to a non-%NULL value, then an icon is shown on the left. If this property has a non-%NULL value, then the #TeplInfoBar:icon-from-message-type property is not taken into @@ -3940,6 +4620,33 @@ The content area of a #TeplInfoBar contains a vertical container containing: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + a new #TeplLineColumnIndicator widget. + + + + + Sets a #TeplTabGroup to update automatically the values for the line and +column of the current cursor position, for the current +#TeplTabGroup:active-tab. + +This function can be called only once per @indicator. + +Use tepl_line_column_indicator_set_view() or +tepl_line_column_indicator_set_tab_group(), but not both. + + + + + + + a #TeplLineColumnIndicator. + + + + a #TeplTabGroup. + + + + + + Sets a #TeplView to update automatically the values for the line and column +of the current cursor position. If @view is %NULL, then @indicator will be +empty. + +Use tepl_line_column_indicator_set_view() or +tepl_line_column_indicator_set_tab_group(), but not both. + + + + + + + a #TeplLineColumnIndicator. + + + + a #TeplView, or %NULL. + + + + + + + + + + + + + + + + + + + + + + + + + @@ -4674,7 +5499,7 @@ should fit most applications' needs. glib:name="TEPL_NEWLINE_TYPE_LF"> line feed, used on UNIX. + line="69">line feed, used on UNIX. glib:name="TEPL_NEWLINE_TYPE_CR"> carriage return, used on Mac. + line="70">carriage return, used on Mac. glib:name="TEPL_NEWLINE_TYPE_CR_LF"> carriage return followed by a line feed, used + line="71">carriage return followed by a line feed, used on Windows. @@ -4742,136 +5567,395 @@ should fit most applications' needs. opaque="1"> - - - - - - - - - - - - - - - - - - - - - - - + - - + - - + - - + + - - - Creates a new #TeplPanel containing only an empty #GtkStack that can be -retrieved with tepl_panel_get_stack(). - + + a new #TeplPanel. - + filename="tepl/tepl-overwrite-indicator.c" + line="255">a new #TeplOverwriteIndicator. + - - Creates a new #TeplPanel intended to be used as a side panel added on the -left side inside a #GtkWindow. - -It contains: -- A #GtkStackSwitcher. -- A close button that hides the #TeplPanel when clicked. -- A #GtkStack that can be retrieved with tepl_panel_get_stack(). - + + a new left side #TeplPanel. - - - - - The equivalent of gtk_stack_add_titled(), with an optional @icon_name to set -the “icon-name” #GtkStack child property. - - - + filename="tepl/tepl-overwrite-indicator.c" + line="268">the value of the #TeplOverwriteIndicator:overwrite property. + + + + + a #TeplOverwriteIndicator. + + + + + + Sets a new value to the #TeplOverwriteIndicator:overwrite property. + + + + + + + a #TeplOverwriteIndicator. + + + + the new value. + + + + + + Sets a #GtkTextView to update automatically the state of @indicator according +to @view. If @view is %NULL, then @indicator will be empty. + + + + + + + a #TeplOverwriteIndicator. + + + + a #GtkTextView, or %NULL. + + + + + + - If %TRUE, indicates the overwrite mode. +- If %FALSE, indicates the insert mode. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adds an item to the panel. See #TeplPanelItem for the meaning of the parameters. + +@widget should have its #GtkWidget:visible property set to %TRUE in order to +be correctly shown in the panel. + +A #TeplPanelItem object is returned, which can be used as a parameter to +other #TeplPanel functions (#TeplPanelItem serves as a kind of handle). + +Note that #TeplPanel also owns a reference to the #TeplPanelItem. So either +store the #TeplPanelItem for later use, or unref it directly after calling +this function. + + + a new #TeplPanelItem object. + a #TeplPanel. + line="50">a #TeplPanel. - + the child #GtkWidget to add to the #GtkStack of @panel. + line="51">a #GtkWidget. - + the name for @component. + line="52">the name. - + a human-readable title for @component. + line="53">the title. allow-none="1"> the icon name for @component, or %NULL. + line="54">the icon-name. - - - + + + Removes an item from @panel. + - the #GtkStack widget of @panel (a direct child -#GtkWidget of @panel). - + a #TeplPanel. + line="90">a #TeplPanel. + + the #TeplPanelItem to remove. + + - - + + Provides a #GSettings key for saving and restoring the -#GtkStack:visible-child-name property of the #GtkStack belonging to @panel. - -This function just stores @settings and @setting_key for further use by -tepl_panel_restore_state_from_gsettings() and -tepl_panel_save_state_to_gsettings(). + line="107">Sets @item to be the one that is currently shown in @panel. -Note that only one @settings/@setting_key pair is stored by @panel for -further use, if you call this function twice on the same @panel, the second -call overrides the first one. - +This is different than setting the #GtkWidget:visible property to %TRUE. All +#GtkWidget's of a @panel should have their #GtkWidget:visible property set to +%TRUE all the time, but only one #TeplPanelItem is shown at a time. + @@ -4928,77 +6008,1058 @@ call overrides the first one. a #TeplPanel. + line="109">a #TeplPanel. - + a #GSettings object. - - - - a #GSettings key of type string. - + line="110">a #TeplPanelItem. + - - + + Restores the state of @panel according to the provided #GSettings. + line="48">Adds an item to the panel. See #TeplPanelItem for the meaning of the parameters. -This function must be called when all components have been added to the -#GtkStack of @panel. - +@widget should have its #GtkWidget:visible property set to %TRUE in order to +be correctly shown in the panel. + +A #TeplPanelItem object is returned, which can be used as a parameter to +other #TeplPanel functions (#TeplPanelItem serves as a kind of handle). + +Note that #TeplPanel also owns a reference to the #TeplPanelItem. So either +store the #TeplPanelItem for later use, or unref it directly after calling +this function. + + + a new #TeplPanelItem object. + + + + + a #TeplPanel. + + + + a #GtkWidget. + + + + the name. + + + + the title. + + + + the icon-name. + + + + + + Removes an item from @panel. + + + + + + + a #TeplPanel. + + + + the #TeplPanelItem to remove. + + + + + + Sets @item to be the one that is currently shown in @panel. + +This is different than setting the #GtkWidget:visible property to %TRUE. All +#GtkWidget's of a @panel should have their #GtkWidget:visible property set to +%TRUE all the time, but only one #TeplPanelItem is shown at a time. + + + + + + + a #TeplPanel. + + + + a #TeplPanelItem. + + + + + + + + + + + + Creates a new #TeplPanel1 containing only an empty #GtkStack that can be +retrieved with tepl_panel1_get_stack(). + + + a new #TeplPanel1. + + + + + Creates a new #TeplPanel1 intended to be used as a side panel added on the +left side inside a #GtkWindow. + +It contains: +- A #GtkStackSwitcher. +- A close button that hides the #TeplPanel1 when clicked. +- A #GtkStack that can be retrieved with tepl_panel1_get_stack(). + + + a new left side #TeplPanel1. + + + + + The equivalent of gtk_stack_add_titled(), with an optional @icon_name to set +the “icon-name” #GtkStack child property. + + + + + + + a #TeplPanel1. + + + + the child #GtkWidget to add to the #GtkStack of @panel. + + + + the name for @component. + + + + a human-readable title for @component. + + + + the icon name for @component, or %NULL. + + + + + + + + the #GtkStack widget of @panel (a direct child +#GtkWidget of @panel). + + + + + a #TeplPanel1. + + + + + + Provides a #GSettings key for saving and restoring the +#GtkStack:visible-child-name property of the #GtkStack belonging to @panel. + +This function just stores @settings and @setting_key for further use by +tepl_panel1_restore_state_from_gsettings() and +tepl_panel1_save_state_to_gsettings(). It doesn't bind the #GSettings key to +the property, because each main window containing a #TeplPanel1 needs to be +able to have a different state, and have more control over when that state is +restored and saved. Once a #TeplPanel1 is created and fully populated, the +setting can be restored. The setting can be saved according to the current +main window before creating a new main window, and of course on application +exit. + +Note that only one @settings/@setting_key pair is stored by @panel for +further use, if you call this function twice on the same @panel, the second +call overrides the first one. + + + + + + + a #TeplPanel1. + + + + a #GSettings object. + + + + a #GSettings key of type string. + + + + + + Restores the state of @panel according to the provided #GSettings. + +This function must be called when all components have been added to the +#GtkStack of @panel. + + + + + + + a #TeplPanel1. + + + + + + Saves the current state of @panel to the provided #GSettings. + + + + + + + a #TeplPanel1. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + a new #TeplPanelContainer. + + + + + + + the #TeplPanelItem currently shown in + @container. + + + + + a #TeplPanelContainer. + + + + + + + + the name of the #TeplPanelItem currently shown in + @container. + + + + + a #TeplPanelContainer. + + + + + + + + all the items of + @container. + + + + + + + a #TeplPanelContainer. + + + + + + Convenience function. Useful to implement a switcher widget. + + + whether @container has more than one #TeplPanelItem. + + + + + a #TeplPanelContainer. + + + + + + Calls tepl_panel_set_active() with the #TeplPanelItem named @name (if found). + + + + + + + a #TeplPanelContainer. + + + + a name. + + + + + + + + + + + + The ::changed signal is emitted when: +- A #TeplPanelItem is added or removed from @container. +- The active #TeplPanelItem of @container has changed. + + + + + + + + + + + + + + + + + + + + + The virtual function table for #TeplPanel. + + + The parent interface. + + + + + + + a new #TeplPanelItem object. + + + + + a #TeplPanel. + + + + a #GtkWidget. + + + + the name. + + + + the title. + + + + the icon-name. + + + + + + + + + + + + + + a #TeplPanel. + + + + the #TeplPanelItem to remove. + + + + + + + + + + + + + + a #TeplPanel. + + + + a #TeplPanelItem. + + + + + + + + + + Gets the icon name. It can be shown in the UI to choose this item, for +example with the #GtkImage's #GtkImage:icon-name property. + + + the "icon-name" attribute. + + + + + a #TeplPanelItem. + + + + + + Gets the name. It is an ID as a UTF-8 string. It is not displayed in the UI. +It uniquely identifies an item within a list. + + + the "name" attribute. + + + + + a #TeplPanelItem. + + + + + + Gets the title. It is a human-readable UTF-8 string that can be shown in the +UI to choose this item. + + + the "title" attribute. + + + + + a #TeplPanelItem. + + + + + + Gets the #GtkWidget (the main content). + + + the "widget" attribute. Is %NULL when + the widget has been destroyed. + + + + + a #TeplPanelItem. + + + + + + A #GCompareFunc for the #TeplPanelItem's "title" attribute. + + + the usual return value for a #GCompareFunc. + + + + + a #TeplPanelItem. + + + + a #TeplPanelItem. + + + + + + Gets the icon name. It can be shown in the UI to choose this item, for +example with the #GtkImage's #GtkImage:icon-name property. + + + the "icon-name" attribute. + + + + + a #TeplPanelItem. + + + + + + Gets the name. It is an ID as a UTF-8 string. It is not displayed in the UI. +It uniquely identifies an item within a list. + + + the "name" attribute. + + + + + a #TeplPanelItem. + + + + + + Gets the title. It is a human-readable UTF-8 string that can be shown in the +UI to choose this item. + + + the "title" attribute. + + + + + a #TeplPanelItem. + + + + + + Gets the #GtkWidget (the main content). + + + the "widget" attribute. Is %NULL when + the widget has been destroyed. + + + + + a #TeplPanelItem. + + + + + + + The virtual function table for #TeplPanelItem. + + + The parent interface. + + + + + + + the "widget" attribute. Is %NULL when + the widget has been destroyed. + + + + + a #TeplPanelItem. + + + + + + + + + + the "name" attribute. + + + + + a #TeplPanelItem. + + + + + + + + + + the "title" attribute. + + + + + a #TeplPanelItem. + + + + + + + + + + the "icon-name" attribute. + + + + + a #TeplPanelItem. + + + + + + + + + + + + - + a new #TeplPanelSwitcherMenu widget. + - + a #TeplPanel. - - + filename="tepl/tepl-panel-switcher-menu.c" + line="263">a #TeplPanelContainer. + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + the #TeplPrefsDialog singleton instance. + + + + Saves the current state of @panel to the provided #GSettings. - + filename="tepl/tepl-prefs-dialog.c" + line="127">This function sets the #GtkWindow:transient-for property and presents +@dialog. + - + a #TeplPanel. - + filename="tepl/tepl-prefs-dialog.c" + line="129">a #TeplPrefsDialog. + + + the parent #GtkWindow. + + - + - + - - + + - + @@ -5006,11 +7067,11 @@ This function must be called when all components have been added to the - - + opaque="1"> + + + + + + + + + + + + + + + + + + + + + @@ -5225,28 +7313,28 @@ with the %GTK_RESPONSE_CANCEL response. - - + - - + - - + @@ -5316,6 +7404,217 @@ with the %GTK_RESPONSE_CANCEL response. line="39">The selection spans multiple lines. + + + + This function introspects a #GSettings key to get its range, if the key as a +"u" type (unsigned integer). %FALSE is returned if the introspection failed. + +See g_settings_schema_key_get_range() for more flexibility. + + + whether the operation was successful. + + + + + a #GSettings. + + + + a key part of @settings. + + + + the minimum value allowed by the range. + + + + the maximum value allowed by the range. + + + + + + + + the #TeplSettings singleton instance. + + + + + If tepl_settings_provide_font_settings() has *not* been called, this function +always returns the current value of the system's fixed width (monospace) +font. + +If tepl_settings_provide_font_settings() *has* been called, this function +returns the font name depending on the boolean value of +@use_default_font_key. + +See also the #TeplSettings::font-changed signal, +tepl_utils_override_font_string() and tepl_prefs_create_font_component(). + + + the selected font name. + + + + + the #TeplSettings instance. + + + + + + + + the #GSettings for `"org.gnome.desktop.interface"`. + + + + + the #TeplSettings instance. + + + + + + This function can only be called once, to provide two keys: +- @use_default_font_key: must be of type boolean, to know whether to use the + system's font (the default font), or the editor font. +- @editor_font_key: must be of type string, containing the font name to have + a different font for the text editor, rather than using the system's font. + +See tepl_settings_get_selected_font(). + + + + + + + the #TeplSettings instance. + + + + the #GSettings object containing the keys. + + + + a key of type boolean. + + + + a key of type string. + + + + + + + + + + + + The ::font-changed signal is emitted when the return value of +tepl_settings_get_selected_font() has potentially changed. + +It takes into account the @use_default_font_key provided with +tepl_settings_provide_font_settings() to avoid unnecessary signal +emission. In other words, for example if @use_default_font_key is +%FALSE, the signal is not emitted even if the default (system's) font +has been modified. + +The relation between this signal and a potential zoom in and zoom out +feature, to temporarily make the font larger or smaller (so the zoom +level not being stored in #GSettings): when this signal is emitted, +it means that the user has explicitly changed the font setting, and +as such he or she probably wants to use that font instead. So the +expected behavior in that case is to reset the zoom level. But it's +left as an exercise for another class, since #TeplSettings is only +for #GSettings. + + + + + + + + + + + + + + + + + + + a new #TeplSpaceDrawerPrefs. + line="369">a new #TeplSpaceDrawerPrefs. @@ -5428,21 +7727,21 @@ weak reference to @object. version="6.0"> Gets the #GtkSourceSpaceDrawer associated with @prefs. The returned object is + line="378">Gets the #GtkSourceSpaceDrawer associated with @prefs. The returned object is guaranteed to be the same for the lifetime of @prefs. Each #TeplSpaceDrawerPrefs object has a different #GtkSourceSpaceDrawer. the #GtkSourceSpaceDrawer associated with @prefs. + line="386">the #GtkSourceSpaceDrawer associated with @prefs. a #TeplSpaceDrawerPrefs. + line="380">a #TeplSpaceDrawerPrefs. @@ -5474,127 +7773,68 @@ guaranteed to be the same for the lifetime of @prefs. Each opaque="1"> - - + + + + - - - + + a new #TeplStatusbar. - + filename="tepl/tepl-status-menu-button.c" + line="118">a new #TeplStatusMenuButton widget. + - - The reverse action of tepl_statusbar_show_cursor_position(). This function -hides the text used to show the line and column numbers. - - - - - - - a #TeplStatusbar. - - - - - - Calls tepl_statusbar_show_cursor_position() and -tepl_statusbar_hide_cursor_position() according to the -#TeplTabGroup:active-view of @tab_group, and the -#TeplBuffer::tepl-cursor-moved signal. - -For the column number it uses the gtk_source_view_get_visual_column() -function. - -This function can be called only once, it is not possible to change the -#TeplTabGroup afterwards (this restriction may be lifted in the future if -there is a compelling use-case). - - - - - - - a #TeplStatusbar. - - - - a #TeplTabGroup. - - - - - + Shows the line and column numbers on the right side of the @statusbar. (So -messages added with gtk_statusbar_push() are still visible after calling this -function). - + filename="tepl/tepl-status-menu-button.c" + line="127">To change the text displayed in @button. + - + a #TeplStatusbar. - + filename="tepl/tepl-status-menu-button.c" + line="129">a #TeplStatusMenuButton. + - + the line number, must be >= 1. - - - - the column number, must be >= 1. - + filename="tepl/tepl-status-menu-button.c" + line="130">the text to set. + - + - + - - + + - + @@ -5602,11 +7842,11 @@ function). - - + a new #TeplStyleSchemeChooserWidget. + line="417">a new #TeplStyleSchemeChooserWidget. @@ -5641,7 +7881,7 @@ function). the value of the #TeplStyleSchemeChooserWidget:tepl-style-scheme-id + line="430">the value of the #TeplStyleSchemeChooserWidget:tepl-style-scheme-id property. Free with g_free() when no longer needed. @@ -5649,7 +7889,7 @@ property. Free with g_free() when no longer needed. a #TeplStyleSchemeChooserWidget. + line="428">a #TeplStyleSchemeChooserWidget. @@ -5660,7 +7900,7 @@ property. Free with g_free() when no longer needed. version="5.0"> Sets the #TeplStyleSchemeChooserWidget:tepl-style-scheme-id property. + line="456">Sets the #TeplStyleSchemeChooserWidget:tepl-style-scheme-id property. The #GtkSourceStyleScheme is taken from the default #GtkSourceStyleSchemeManager as returned by @@ -5674,14 +7914,14 @@ gtk_source_style_scheme_manager_get_default(). a #TeplStyleSchemeChooserWidget. + line="458">a #TeplStyleSchemeChooserWidget. the new value. + line="459">the new value. @@ -5692,7 +7932,7 @@ gtk_source_style_scheme_manager_get_default(). transfer-ownership="none"> The #GtkSourceStyleSchemeChooser:style-scheme ID, as a string. This + line="179">The #GtkSourceStyleSchemeChooser:style-scheme ID, as a string. This property is useful for binding it to a #GSettings key. When the #GtkSourceStyleSchemeChooser:style-scheme is %NULL, this @@ -6897,6 +9137,27 @@ The Tepl library uses this priority for its #GtkStyleProvider's. + + Type definition for a function that will be called to create a string +containing @untitled_file_number, to give a name to a file not yet present on +disk. + + + + + + + the number. + + + + Creates a new #TeplView. + line="156">Creates a new #TeplView. By default, an empty #TeplBuffer will be lazily created and can be retrieved with gtk_text_view_get_buffer(). @@ -6923,7 +9184,7 @@ tepl_view_new_with_buffer(). a new #TeplView. + line="168">a new #TeplView. @@ -6932,19 +9193,19 @@ tepl_view_new_with_buffer(). version="5.0"> Creates a new #TeplView widget displaying the buffer @buffer. + line="177">Creates a new #TeplView widget displaying the buffer @buffer. a new #TeplView. + line="183">a new #TeplView. a #GtkSourceBuffer or a subclass of it. + line="179">a #GtkSourceBuffer or a subclass of it. @@ -6954,7 +9215,7 @@ tepl_view_new_with_buffer(). version="1.0"> Copies the clipboard. + line="229">Copies the clipboard. @@ -6963,7 +9224,7 @@ tepl_view_new_with_buffer(). a #TeplView. + line="231">a #TeplView. @@ -6973,7 +9234,7 @@ tepl_view_new_with_buffer(). version="1.0"> Cuts the clipboard and then scrolls to the cursor position. + line="196">Cuts the clipboard and then scrolls to the cursor position. @@ -6982,7 +9243,7 @@ tepl_view_new_with_buffer(). a #TeplView. + line="198">a #TeplView. @@ -6992,7 +9253,7 @@ tepl_view_new_with_buffer(). version="1.0"> Deletes the text currently selected in the #GtkTextBuffer associated + line="286">Deletes the text currently selected in the #GtkTextBuffer associated to the view and then scrolls to the cursor position. @@ -7002,7 +9263,7 @@ to the view and then scrolls to the cursor position. a #TeplView. + line="288">a #TeplView. @@ -7012,13 +9273,13 @@ to the view and then scrolls to the cursor position. version="2.0"> Places the cursor at the position returned by + line="364">Places the cursor at the position returned by gtk_text_buffer_get_iter_at_line(), and scrolls to that position. %TRUE if the cursor has been moved exactly to @line, %FALSE if that + line="372">%TRUE if the cursor has been moved exactly to @line, %FALSE if that line didn't exist. @@ -7026,13 +9287,13 @@ gtk_text_buffer_get_iter_at_line(), and scrolls to that position. a #TeplView. + line="366">a #TeplView. a line number, counting from 0. + line="367">a line number, counting from 0. @@ -7042,13 +9303,13 @@ gtk_text_buffer_get_iter_at_line(), and scrolls to that position. version="2.0"> Places the cursor at the position returned by + line="397">Places the cursor at the position returned by gtk_text_buffer_get_iter_at_line_offset(), and scrolls to that position. %TRUE if the cursor has been moved exactly to @line and + line="406">%TRUE if the cursor has been moved exactly to @line and @line_offset, %FALSE if that position didn't exist. @@ -7056,19 +9317,19 @@ gtk_text_buffer_get_iter_at_line_offset(), and scrolls to that position. a #TeplView. + line="399">a #TeplView. a line number, counting from 0. + line="400">a line number, counting from 0. the line offset, in characters (not bytes). + line="401">the line offset, in characters (not bytes). @@ -7078,7 +9339,7 @@ gtk_text_buffer_get_iter_at_line_offset(), and scrolls to that position. version="1.0"> Pastes the clipboard and then scrolls to the cursor position. + line="255">Pastes the clipboard and then scrolls to the cursor position. @@ -7087,7 +9348,7 @@ gtk_text_buffer_get_iter_at_line_offset(), and scrolls to that position. a #TeplView. + line="257">a #TeplView. @@ -7097,7 +9358,7 @@ gtk_text_buffer_get_iter_at_line_offset(), and scrolls to that position. version="1.0"> Scrolls the @view to the cursor position. + line="339">Scrolls the @view to the cursor position. @@ -7106,7 +9367,7 @@ gtk_text_buffer_get_iter_at_line_offset(), and scrolls to that position. a #TeplView. + line="341">a #TeplView. @@ -7116,7 +9377,7 @@ gtk_text_buffer_get_iter_at_line_offset(), and scrolls to that position. version="1.0"> Selects all the text. + line="316">Selects all the text. @@ -7125,7 +9386,7 @@ gtk_text_buffer_get_iter_at_line_offset(), and scrolls to that position. a #TeplView. + line="318">a #TeplView. @@ -7135,7 +9396,7 @@ gtk_text_buffer_get_iter_at_line_offset(), and scrolls to that position. version="2.0"> Selects the lines between @start_line and @end_line included, counting from + line="437">Selects the lines between @start_line and @end_line included, counting from zero. And then scrolls to the cursor. Possible use-case: line numbers coming from a compilation output, to go to @@ -7148,19 +9409,19 @@ the place where a warning or error occurred. a #TeplView. + line="439">a #TeplView. start of the region to select. + line="440">start of the region to select. end of the region to select. + line="441">end of the region to select. @@ -7185,9 +9446,9 @@ the place where a warning or error occurred. The Tepl framework uses the #TeplAbstractFactory singleton to create some -objects and widgets. By creating a subclass of #TeplAbstractFactory (to -override the desired virtual functions) and setting the instance with + line="8">Tepl uses the #TeplAbstractFactory singleton to create some objects and +widgets. By creating a subclass of #TeplAbstractFactory (to override the +desired virtual functions) and setting the instance with tepl_abstract_factory_set_singleton(), an application can tell Tepl to create custom objects and widgets. @@ -7198,9 +9459,7 @@ Note that #GtkTextViewClass has the ::create_buffer factory method, that Recommendation for the subclass name: in Tepl, #TeplAbstractFactory is an abstract class, but in an application it is a concrete class. So -“MyappAbstractFactory” is not a good name for a #TeplAbstractFactory -subclass. “MyappFactory” is a better name (of course change “Myapp” with the -application namespace). +“MyappFactory” is a better name than “MyappAbstractFactory”. + + #TeplEncoding is an interface to represent a character encoding, also called +a "character set" or "charset". + +It serves as a basis for features such as character encoding detection and +conversion during file loading and saving. + +Note that the text in GTK widgets is always encoded in UTF-8. + + + #TeplEncodingIconv implements the #TeplEncoding interface, for use with iconv +in mind. + + + Gets a list of all encodings known by #TeplEncodingIconv. + + + a list of + #TeplEncodingIconv's. + + + + + + + Gets the list of default candidate encodings to try when loading a file. See +gtk_source_file_loader_set_candidate_encodings(). + +This function returns a different list depending on the current locale (i.e. +language, country and default encoding). The UTF-8 encoding and the current +locale encoding are guaranteed to be present in the returned list. + +Note that the returned list doesn't contain all encodings known by +#TeplEncodingIconv, it is a limited list that contains only the encodings +that have the most likelihood to fit for the current locale. + + + the list of + default candidate encodings. + + + + + + + Creates a new #TeplEncodingIconv from a character set such as "UTF-8" or +"ISO-8859-1". + +The tepl_encoding_get_name() function will return exactly the same string as +the @charset passed in to this constructor. + + + the new #TeplEncodingIconv. Free with tepl_encoding_iconv_free(). + + + + + a character set. + + + + + + Creates a new #TeplEncodingIconv from the current locale, as returned by +g_get_charset(). + + + the new #TeplEncodingIconv. Free with tepl_encoding_iconv_free(). + + + + + Creates a new #TeplEncodingIconv with the "UTF-8" character set. + + + the new #TeplEncodingIconv. Free with tepl_encoding_iconv_free(). + + + Free the resources allocated by Tepl. For example it unrefs the singleton + line="67">Free the resources allocated by Tepl. For example it unrefs the singleton objects. This function also calls amtk_finalize() and gtk_source_finalize(). @@ -7418,7 +9800,7 @@ handles only the drawing, and has a flat view of the folding tree. #TeplInfoBar is a subclass of #GtkInfoBar. In most cases it permits to create + line="8">#TeplInfoBar is a subclass of #GtkInfoBar. In most cases it permits to create #GtkInfoBar's more easily. The content area is divided into several sub-areas, described in @@ -7427,7 +9809,7 @@ The content area is divided into several sub-areas, described in Initializes the Tepl library (e.g. for the internationalization). + line="33">Initializes the Tepl library (e.g. for the internationalization). This function can be called several times, but is meant to be called at the beginning of main(), before any other Tepl function call. @@ -7441,14 +9823,14 @@ This function also calls amtk_init() and gtk_source_init(). Verbose error reporting for file I/O operations. + line="11">Verbose error reporting for file I/O operations. When a %G_IO_ERROR_CANT_CREATE_BACKUP error occurs while saving @location, + line="111">When a %G_IO_ERROR_CANT_CREATE_BACKUP error occurs while saving @location, offer two possible actions: - Save anyway: %GTK_RESPONSE_YES. - Don't save: %GTK_RESPONSE_CANCEL. @@ -7456,20 +9838,20 @@ offer two possible actions: the newly created #TeplInfoBar. + line="121">the newly created #TeplInfoBar. the #GFile for which the backup failed to be created. + line="113">the #GFile for which the backup failed to be created. must be a %G_IO_ERROR_CANT_CREATE_BACKUP. + line="114">must be a %G_IO_ERROR_CANT_CREATE_BACKUP. @@ -7479,29 +9861,29 @@ offer two possible actions: version="5.0"> Creates a warning about @location having changed on disk. The possible + line="171">Creates a warning about @location having changed on disk. The possible actions: - Depending on @document_modified, "Reload" or "Drop changes and reload": %GTK_RESPONSE_OK. -- A close button as added with gtk_info_bar_set_show_close_button(). +- Ignore: %GTK_RESPONSE_CLOSE. the newly created #TeplInfoBar. + line="183">the newly created #TeplInfoBar. the #GFile for which there has been an external modification. + line="173">the #GFile for which there has been an external modification. whether the document (e.g. the #GtkTextBuffer) has + line="174">whether the document (e.g. the #GtkTextBuffer) has unsaved modifications. @@ -7512,7 +9894,7 @@ actions: version="5.0"> Creates a warning about @location being already open in another window, + line="32">Creates a warning about @location being already open in another window, offering two possible actions: - Edit anyway: %GTK_RESPONSE_YES. - Don't edit: %GTK_RESPONSE_CANCEL. @@ -7520,14 +9902,14 @@ offering two possible actions: the newly created #TeplInfoBar. + line="41">the newly created #TeplInfoBar. the #GFile already open in another window. + line="34">the #GFile already open in another window. @@ -7537,22 +9919,47 @@ offering two possible actions: version="5.0"> For file saving, creates a warning about invalid characters that can corrupt + line="276">For file saving, creates a warning about invalid characters that can corrupt the file. Possible actions: - Save anyway: %GTK_RESPONSE_YES. +- Don't save: %GTK_RESPONSE_CANCEL. + + + the newly created #TeplInfoBar. + + + + + where to save the document. + + + + + + When attempting to save @location, creates a warning about @location having +changed on disk. The possible actions: +- Save anyway: %GTK_RESPONSE_YES. - Don't save: %GTK_RESPONSE_CANCEL. the newly created #TeplInfoBar. + line="241">the newly created #TeplInfoBar. where to save the document. + line="234">a #GFile. @@ -7624,6 +10031,14 @@ You probably want to connect to the #GtkDialog::response signal with the #TeplLanguageChooserWidget implements the #TeplLanguageChooser interface. In addition to the list, it contains a #GtkSearchEntry to search the list. + + + #TeplLineColumnIndicator indicates the cursor position by line and column +numbers. For example: "Ln 2, Col 3". + +The usual case is to pack this widget in a #GtkStatusbar. #TeplNotebook is a subclass of #GtkNotebook that implements the #TeplTabGroup interface. + + + #TeplOverwriteIndicator indicates the mode in which text edition occurs: +insert or overwrite. + +See for example the #GtkTextView:overwrite property. + +The usual case is to pack this widget in a #GtkStatusbar. + +# TODO + +It is planned to extend this widget to be able to click on / activate it to +change the mode, with a #GtkPopover for example (but this would be optional, +with a "chooser" boolean construct-only property). + +With a different styling when in overwrite mode. + +Because not everybody is familiar with the key on the keyboard to switch +between the different modes. #TeplPanel permits to create a side or bottom panel that contains several + line="7">#TeplPanel represents a panel that is usually shown on the side or at the +bottom (inside a main window), and can contain several items. + + + #TeplPanelContainer is an implementation of the #TeplPanel interface. + +#TeplPanelContainer contains API useful to implement a switcher widget, like +#TeplPanelSwitcherMenu. + + + #TeplPanelItem is an interface to get the information of a panel item. + + + Similar to #GtkStackSwitcher, but for a #TeplPanelContainer. + +This switcher widget is suitable to be put in a #GtkHeaderBar, to choose the +component of a side panel (for example). + + + #TeplPanel1 permits to create a side or bottom panel that contains several components. -#TeplPanel is a #GtkGrid subclass containing only one child #GtkWidget by -default: the #GtkStack that can be retrieved with tepl_panel_get_stack(). +#TeplPanel1 is a #GtkGrid subclass containing only one child #GtkWidget by +default: the #GtkStack that can be retrieved with tepl_panel1_get_stack(). + +#TeplPanel1 has the "1" suffix because it's the version 1 of the TeplPanel +API. +See also tepl_utils_override_font_description() and +tepl_utils_override_font_string(). A newly allocated string containing the CSS + line="88">A newly allocated string containing the CSS describing the font description. Free with g_free() when no longer needed. @@ -7766,6 +10233,250 @@ See also tepl_utils_override_font(). + + Functions to create GUI elements that are useful for a preferences dialog or +panel. In order to configure a text editor. + + + #TeplPrefsDialog is a subclass of #GtkDialog for configuring the preferences +of an application. + +tepl_abstract_factory_fill_prefs_dialog() is called by #TeplPrefsDialog +during its construction. + + + This function creates a component containing a #TeplStyleSchemeChooserWidget. + + + A component for choosing the + #GtkSourceStyleScheme to use. + + + + + a #GSettings. + + + + a key part of @settings to store the style scheme ID. The + type of the key must be a string. + + + + + + + + A #GtkCheckButton intended for + #GtkSourceView:show-line-numbers. + + + + + a #GSettings. + + + + a key part of @settings. The type of the key must + be a boolean. + + + + + + + + a component for some files preferences. + + + + + a #GSettings. + + + + a key part of @settings. The type of the key must be + a boolean. Intended to be used with %TEPL_FILE_SAVER_FLAGS_CREATE_BACKUP + (for example). + + + + a key part of @settings. The type of the key must be a + boolean. Whether to autosave files. + + + + a key part of @settings. The type of the key must be an + unsigned integer, with a range. The interval is in minutes. + + + + + + + + A component for configuring the font. + + + + + a #GSettings. + + + + a key part of @settings to store whether to use the + system font. The type of the key must be a boolean. + + + + a key part of @settings to store the editor font. The type + of the key must be a string. + + + + + + + + a component intended for + #GtkSourceView:highlight-current-line and + #GtkSourceBuffer:highlight-matching-brackets. + + + + + a #GSettings. + + + + a key part of @settings. The type of the key + must be a boolean. + + + + a key part of @settings. The type of the + key must be a boolean. + + + + + + + + a component intended for + #GtkSourceView:insert-spaces-instead-of-tabs and + #GtkSourceView:smart-backspace. + + + + + a #GSettings. + + + + a key part of @settings. The type of the key must be a + boolean. + + + + a key part of @settings. The type of the key must be a + boolean. + + + + + + + + A widget containing a #GtkSpinButton intended + for #GtkSourceView:tab-width. + + + + + a #GSettings. + + + + a key part of @settings. The type of the key must be an + unsigned integer, with a range. + + + + + + + #TeplSettings is a singleton class to have a central access to some +#GSettings objects and having convenience features that are useful for a text +editor. + +The central access permits to: +- Share the same #GSettings objects between different parts of the + application. +- Avoid the need to store #GSettings objects a bit everywhere in different + classes. #TeplSpaceDrawerPrefs is a #GtkWidget for configuring the preferences about + line="10">#TeplSpaceDrawerPrefs is a #GtkWidget for configuring the preferences about white space drawing with #GtkSourceSpaceDrawer. The configuration is stored in the #GtkSourceSpaceDrawer:matrix property of the associated #GtkSourceSpaceDrawer object. - + #TeplStatusbar is a subclass of #GtkStatusbar with a better look by default, -and with added functions useful for a text editor. + filename="tepl/tepl-status-menu-button.c" + line="9">#TeplStatusMenuButton is a #GtkMenuButton that is suitable to be put in a +#GtkStatusbar. + +It contains: +- Some text. +- An arrow. +- When clicked, a menu or popover can be shown (see the #GtkMenuButton API). #TeplStyleSchemeChooserWidget is a simple implementation of the -#GtkSourceStyleSchemeChooser interface. It already contains a -#GtkScrolledWindow internally. - -Additional features compared to #GtkSourceStyleSchemeChooserWidget: -- There is an additional convenience property: - #TeplStyleSchemeChooserWidget:tepl-style-scheme-id. -- When the #GtkWidget::map signal is emitted, #TeplStyleSchemeChooserWidget - scrolls to the selected row. +#GtkSourceStyleSchemeChooser interface. + +It shows a list with the name and description of each #GtkSourceStyleScheme, +taken from the default #GtkSourceStyleSchemeManager (as returned by +gtk_source_style_scheme_manager_get_default()). + +#TeplStyleSchemeChooserWidget contains a #GtkScrolledWindow internally. When +the #GtkWidget::map signal is emitted, it scrolls to the selected row (useful +when the list is long). + +There is also an additional convenience property: +#TeplStyleSchemeChooserWidget:tepl-style-scheme-id. A #GBindingTransformFunc to transform between these two #GValue types: + line="1227">A #GBindingTransformFunc to transform between these two #GValue types: - A #GValue of type #gboolean. - A #GValue of type #GVariant, with the #GVariant of type boolean. @@ -7936,30 +10669,30 @@ it introspects the types of @from_value and @to_value. Note that if @from_value and @to_value are of the same #GValue type, this function won't work and you shouldn't use a custom #GBindingTransformFunc in the first place. - + %TRUE if the transformation was successful, and %FALSE otherwise. + line="1245">%TRUE if the transformation was successful, and %FALSE otherwise. a #GBinding. + line="1229">a #GBinding. the #GValue containing the value to transform. + line="1230">the #GValue containing the value to transform. the #GValue in which to store the transformed value. + line="1231">the #GValue in which to store the transformed value. allow-none="1"> data passed to the transform function. + line="1232">data passed to the transform function. + + Especially useful for external #GSettings (provided by another application +for instance). + +See also: tepl_utils_can_use_gsettings_schema() which is typically used +before this function. + + + whether the #GSettings key exists. + + + + + a #GSettings object. + + + + the key to introspect. + + + + + + Checks that a #GSettings schema exists. + +Especially useful for external #GSettings (provided by another application +for instance). + + + %TRUE if a #GSettings instance can be created with @schema_id. + %FALSE otherwise (in that case the program would crash). + + + + + a #GSettings schema ID. + + + + - + a new close button (a #GtkButton). + line="718">a new close button (a #GtkButton). @@ -7990,13 +10781,13 @@ the first place. throws="1"> Synchronously creates parent directories of @file, so that @file can be + line="610">Synchronously creates parent directories of @file, so that @file can be saved. - + whether the directories are correctly created. %FALSE is returned on + line="619">whether the directories are correctly created. %FALSE is returned on error. @@ -8004,7 +10795,7 @@ error. a file + line="612">a file allow-none="1"> optional #GCancellable object, %NULL to ignore. + line="613">optional #GCancellable object, %NULL to ignore. @@ -8023,22 +10814,22 @@ error. version="5.0"> Parse and break an uri apart in its individual components like the uri + line="412">Parse and break an uri apart in its individual components like the uri scheme, user info, host, port and path. The return value pointer can be %NULL to ignore certain parts of the uri. If the function returns %TRUE, then all return value pointers should be freed using g_free(). - + %TRUE if the uri could be properly decoded, %FALSE otherwise. + line="427">%TRUE if the uri could be properly decoded, %FALSE otherwise. the uri to decode + line="414">the uri to decode allow-none="1"> return value pointer for the uri's + line="415">return value pointer for the uri's scheme (e.g. http, sftp, ...), or %NULL @@ -8061,7 +10852,7 @@ all return value pointers should be freed using g_free(). allow-none="1"> return value pointer for the uri user info, or %NULL + line="417">return value pointer for the uri user info, or %NULL allow-none="1"> return value pointer for the uri host, or %NULL + line="418">return value pointer for the uri host, or %NULL allow-none="1"> return value pointer for the uri port, or %NULL + line="419">return value pointer for the uri port, or %NULL allow-none="1"> return value pointer for the uri path, or %NULL + line="420">return value pointer for the uri path, or %NULL @@ -8104,10 +10895,10 @@ all return value pointers should be freed using g_free(). version="5.0"> The asynchronous version of g_file_query_exists(). When the operation is + line="659">The asynchronous version of g_file_query_exists(). When the operation is finished, @callback will be called. You can then call tepl_utils_file_query_exists_finish() to get the result of the operation. - + @@ -8115,7 +10906,7 @@ tepl_utils_file_query_exists_finish() to get the result of the operation. a #GFile. + line="661">a #GFile. allow-none="1"> a #GCancellable. + line="662">a #GCancellable. closure="3"> the callback to call when the operation is finished. + line="663">the callback to call when the operation is finished. allow-none="1"> the data to pass to the callback function. + line="664">the data to pass to the callback function. @@ -8154,14 +10945,14 @@ tepl_utils_file_query_exists_finish() to get the result of the operation. version="5.0"> Finishes the operation started with tepl_utils_file_query_exists_async(). + line="687">Finishes the operation started with tepl_utils_file_query_exists_async(). There is no output #GError parameter, so you should check if the operation has been cancelled (in which case %FALSE will be returned). - + %TRUE if the file exists and the operation hasn't been cancelled, + line="696">%TRUE if the file exists and the operation hasn't been cancelled, %FALSE otherwise. @@ -8169,13 +10960,13 @@ has been cancelled (in which case %FALSE will be returned). a #GFile. + line="689">a #GFile. a #GAsyncResult. + line="690">a #GAsyncResult. @@ -8185,17 +10976,17 @@ has been cancelled (in which case %FALSE will be returned). version="4.4"> Examples: + line="273">Examples: - "file.pdf" returns ".pdf". - "file.PDF" returns ".pdf". - "file.tar.gz" returns ".gz". - "path/to/file.pdf" returns ".pdf". - "file" (without an extension) returns "" (the empty string). - + the @filename's extension with the dot, in lowercase. Free with + line="284">the @filename's extension with the dot, in lowercase. Free with g_free(). @@ -8203,7 +10994,7 @@ g_free(). a filename. + line="275">a filename. @@ -8213,23 +11004,58 @@ g_free(). version="4.4"> Returns @filename without its extension. With the “extension” having the same + line="296">Returns @filename without its extension. With the “extension” having the same definition as in tepl_utils_get_file_extension(); in other words it returns the other part of @filename. - + the @filename without its extension. Free with g_free(). + line="304">the @filename without its extension. Free with g_free(). a filename. + line="298">a filename. + + + + + + To add a title to a GUI component. + +Useful for example in a #GtkDialog window, when there are several components, +or logical groups. + +The title will be in bold, left-aligned, and the @component will have a left +margin. + + + a new widget containing the @title above the +@component. + + + + + the title. + + a #GtkWidget. + + version="6.0"> Removes all rows of @list_box, to obtain an empty #GtkListBox. - + line="853">Removes all rows of @list_box, to obtain an empty #GtkListBox. + @@ -8246,7 +11072,7 @@ the other part of @filename. a #GtkListBox. + line="855">a #GtkListBox. @@ -8256,14 +11082,14 @@ the other part of @filename. version="6.0"> Gets an array of all the #GtkListBoxRow childen of @list_box for which + line="1004">Gets an array of all the #GtkListBoxRow childen of @list_box for which @filter_func returns %TRUE. The elements in the array are sorted by increasing index order (as returned by gtk_list_box_row_get_index()). - + + line="1017"> a %NULL-terminated array of #GtkListBoxRow objects, or %NULL. Free with g_free() when no longer needed. @@ -8274,7 +11100,7 @@ increasing index order (as returned by gtk_list_box_row_get_index()). a #GtkListBox. + line="1006">a #GtkListBox. closure="2"> non-%NULL callback function. + line="1007">non-%NULL callback function. allow-none="1"> user data passed to @filter_func. + line="1008">user data passed to @filter_func. allow-none="1"> location to store the number of + line="1009">location to store the number of #GtkListBoxRow's present in the returned array, without counting the terminating %NULL. @@ -8315,29 +11141,29 @@ increasing index order (as returned by gtk_list_box_row_get_index()). version="6.0"> This function has the same semantics as gtk_list_box_get_row_at_index(), but + line="946">This function has the same semantics as gtk_list_box_get_row_at_index(), but it takes into account only the rows for which @filter_func returns %TRUE. As an example, if @index is 0, it returns the first #GtkListBoxRow for which @filter_func returns %TRUE. - + the child #GtkListBoxRow or %NULL. + line="960">the child #GtkListBoxRow or %NULL. a #GtkListBox. + line="948">a #GtkListBox. the index of the row, starting at 0. The index is among the filtered + line="949">the index of the row, starting at 0. The index is among the filtered rows only. @@ -8347,7 +11173,7 @@ As an example, if @index is 0, it returns the first #GtkListBoxRow for which closure="3"> non-%NULL callback function. + line="951">non-%NULL callback function. user data passed to @filter_func. + line="952">user data passed to @filter_func. @@ -8366,11 +11192,11 @@ As an example, if @index is 0, it returns the first #GtkListBoxRow for which version="6.0"> Scrolls to a specific #GtkListBoxRow. + line="897">Scrolls to a specific #GtkListBoxRow. Before using this function, tepl_utils_list_box_setup_scrolling() must have been called. - + @@ -8378,13 +11204,13 @@ been called. a #GtkListBox. + line="899">a #GtkListBox. a #GtkListBoxRow. + line="900">a #GtkListBoxRow. @@ -8394,13 +11220,13 @@ been called. version="6.0"> Calls tepl_utils_list_box_scroll_to_row() on the row returned by + line="919">Calls tepl_utils_list_box_scroll_to_row() on the row returned by gtk_list_box_get_selected_row(). This function assumes that there is either zero or one selected row. Before using this function, tepl_utils_list_box_setup_scrolling() must have been called. - + @@ -8408,7 +11234,7 @@ been called. a #GtkListBox. + line="921">a #GtkListBox. @@ -8418,12 +11244,12 @@ been called. version="6.0"> Setup vertical scrolling between @list_box and @scrolled_window, to be able + line="871">Setup vertical scrolling between @list_box and @scrolled_window, to be able to use tepl_utils_list_box_scroll_to_row() afterwards. This function is intended to be called only once per #GtkListBox, when initializing the @list_box and @scrolled_window widgets. - + @@ -8431,13 +11257,13 @@ initializing the @list_box and @scrolled_window widgets. a #GtkListBox. + line="873">a #GtkListBox. a #GtkScrolledWindow. + line="874">a #GtkScrolledWindow. @@ -8482,20 +11308,49 @@ g_free() when no longer needed. - + A replacement for gtk_widget_override_font(). Because + line="1063">A replacement for gtk_widget_override_font(). Because gtk_widget_override_font() is deprecated but was useful. -See pango_font_description_from_string() for a description of the format of -the string representation for @font_str. +See also tepl_pango_font_description_to_css(). + + + + + + + a #GtkWidget. + + + + the #PangoFontDescription to use, or %NULL to undo + the effect of previous calls to this function on @widget. + + + + + + A convenience function that calls tepl_utils_override_font_description(). -This function uses tepl_pango_font_description_to_css() and applies the CSS -to the #GtkStyleContext of @widget. - +See pango_font_description_from_string() for a description of the format of +the string representation for @font_str. + @@ -8503,7 +11358,7 @@ to the #GtkStyleContext of @widget. a #GtkWidget. + line="1127">a #GtkWidget. allow-none="1"> a string representation of a #PangoFontDescription, or + line="1128">a string representation of a #PangoFontDescription, or %NULL to undo the effect of previous calls to this function on @widget. @@ -8523,32 +11378,51 @@ to the #GtkStyleContext of @widget. version="4.4"> Replaces the home directory with a tilde, if the home directory is present in + line="387">Replaces the home directory with a tilde, if the home directory is present in the @filename. - + the new filename. Free with g_free(). + line="394">the new filename. Free with g_free(). the filename. + line="389">the filename. + + To better configure a #GtkStatusbar (to make it smaller). + + + + + + + a #GtkStatusbar. + + + + Shows a #GtkDialog with the provided warning message. - + line="789">Shows a #GtkDialog with the provided warning message. + @@ -8559,19 +11433,19 @@ the @filename. allow-none="1"> the #GtkWindow issuing the warning. + line="791">the #GtkWindow issuing the warning. format string, as with printf(). + line="792">format string, as with printf(). parameters to insert into the format string. + line="793">parameters to insert into the format string. diff --git a/girs/TimezoneMap-1.0.gir b/girs/TimezoneMap-1.0.gir index b82a341ba..ea6ef492f 100644 --- a/girs/TimezoneMap-1.0.gir +++ b/girs/TimezoneMap-1.0.gir @@ -6,61 +6,173 @@ and/or use gtk-doc annotations. --> xmlns="http://www.gtk.org/introspection/core/1.0" xmlns:c="http://www.gtk.org/introspection/c/1.0" xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="CcTimezoneCompletion" glib:get-type="cc_timezone_completion_get_type" glib:type-struct="TimezoneCompletionClass"> + + + + + + @@ -97,6 +215,7 @@ and/or use gtk-doc annotations. --> + @@ -104,7 +223,9 @@ and/or use gtk-doc annotations. --> + disguised="1" + opaque="1"> + glib:type-name="CcTimezoneLocation" glib:get-type="cc_timezone_location_get_type" glib:type-struct="TimezoneLocationClass"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + - - + + - - + + - - + + - - + + - - + + + + + @@ -147,13 +573,16 @@ and/or use gtk-doc annotations. --> + + disguised="1" + opaque="1"> + glib:type-name="CcTimezoneMap" glib:get-type="cc_timezone_map_get_type" glib:type-struct="TimezoneMapClass"> + + - - + + Clear the location currently set for the #CcTimezoneMap. This will remove +the highlight and reset the map to its original state. + + + + + + + A #CcTimezoneMap + + + + + + Returns the current location set for the map. + + + the map location. + + + A #CcTimezoneMap + + + + + + Returns the currently selected offset in hours from GMT. + + + The selected offset. + + + + + A #CcTimezoneMap + + + + - + + + + @@ -191,10 +680,14 @@ and/or use gtk-doc annotations. --> + + + + @@ -203,27 +696,85 @@ and/or use gtk-doc annotations. --> + + + + + + + + + + + + + + + + + + + Set the currently selected offset for the map and redraw the highlighted +time zone. + + + + + + + A #CcTimezoneMap + + + + The offset from GMT in hours + + + + + + + + - + + + + + - + + + + @@ -232,7 +783,7 @@ and/or use gtk-doc annotations. --> - + @@ -244,13 +795,16 @@ and/or use gtk-doc annotations. --> + + disguised="1" + opaque="1"> + diff --git a/girs/TotemPlParser-1.0.gir b/girs/TotemPlParser-1.0.gir index 9b63ad161..ec2f95f55 100644 --- a/girs/TotemPlParser-1.0.gir +++ b/girs/TotemPlParser-1.0.gir @@ -18,7 +18,7 @@ and/or use gtk-doc annotations. --> introspectable="0"> An alias for #GHashTable, used in the #TotemPlParser::entry-parsed and + line="408">An alias for #GHashTable, used in the #TotemPlParser::entry-parsed and #TotemPlParser::playlist-started signals due to #GHashTable not being a boxed type when totem-pl-parser was originally written. @@ -26,7 +26,7 @@ The hash table is a mapping from field names (such as %TOTEM_PL_PARSER_FIELD_ALBUM) to their associated values. It is safe to use #GHashTable instead of #TotemPlParserMetadata everywhere. - + - + - + - + Metadata field for an entry's abstract text. - + line="164">Metadata field for an entry's abstract text. + Metadata field for an entry's album. - + line="102">Metadata field for an entry's album. + Metadata field for an entry's default audio-track selection. The default + line="270">Metadata field for an entry's default audio-track selection. The default track is defined as NULL. Note that the value is sent as a string. - + c:type="TOTEM_PL_PARSER_FIELD_AUTHOR"> Metadata field for an entry's author/composer/director. - + line="96">Metadata field for an entry's author/composer/director. + c:type="TOTEM_PL_PARSER_FIELD_AUTOPLAY"> Metadata field for an entry's "autoplay" flag, which is %TRUE if the entry should play automatically. - + line="126">Metadata field for an entry's "autoplay" flag, which is %TRUE if the entry should play automatically. + c:type="TOTEM_PL_PARSER_FIELD_BASE"> Metadata field for an entry's base path. - + line="108">Metadata field for an entry's base path. + c:type="TOTEM_PL_PARSER_FIELD_CONTACT"> Metadata field for an entry's contact details for the webmaster. - + line="218">Metadata field for an entry's contact details for the webmaster. + c:type="TOTEM_PL_PARSER_FIELD_CONTENT_RATING"> Metadata field for an entry's content rating. It is + line="277">Metadata field for an entry's content rating. It is %TOTEM_PL_PARSER_CONTENT_RATING_CLEAN for clean content, %TOTEM_PL_PARSER_CONTENT_RATING_EXPLICIT for explicit content and %TOTEM_PL_PARSER_CONTENT_RATING_UNRATED for content which is not rated. - + c:type="TOTEM_PL_PARSER_FIELD_CONTENT_TYPE"> Metadata field for an entry's content-type (usually a mime-type coming + line="256">Metadata field for an entry's content-type (usually a mime-type coming from a web server). - + c:type="TOTEM_PL_PARSER_FIELD_COPYRIGHT"> Metadata field for an entry's copyright line. - + line="158">Metadata field for an entry's copyright line. + c:type="TOTEM_PL_PARSER_FIELD_DESCRIPTION"> Metadata field for an entry's description. - + line="170">Metadata field for an entry's description. + version="2.26"> Metadata field for an entry's download URI. Only used if an alternate download + line="232">Metadata field for an entry's download URI. Only used if an alternate download location is available for the entry. - + c:type="TOTEM_PL_PARSER_FIELD_DURATION"> Metadata field for an entry's playback duration, which should be parsed using totem_pl_parser_parse_duration(). - + line="132">Metadata field for an entry's playback duration, which should be parsed using totem_pl_parser_parse_duration(). + c:type="TOTEM_PL_PARSER_FIELD_DURATION_MS"> Metadata field for an entry's playback duration, in milliseconds. It's only used when an entry's + line="138">Metadata field for an entry's playback duration, in milliseconds. It's only used when an entry's duration is available in that format, so one would get either the %TOTEM_PL_PARSER_FIELD_DURATION or %TOTEM_PL_PARSER_FIELD_DURATION_MS as metadata. - + c:type="TOTEM_PL_PARSER_FIELD_ENDTIME"> Metadata field for an entry's playback end time. - + line="152">Metadata field for an entry's playback end time. + c:type="TOTEM_PL_PARSER_FIELD_FILESIZE"> Metadata field for an entry's filesize in bytes. This is only advisory, and can sometimes not match the actual filesize of the stream. - + line="206">Metadata field for an entry's filesize in bytes. This is only advisory, and can sometimes not match the actual filesize of the stream. + c:type="TOTEM_PL_PARSER_FIELD_GENRE"> Metadata field for an entry's primary genre. This is a string of -the form 'Genre1' or 'Genre1/SubGenre1". - - - - - Metadata field for an entry's full genre. This is a concatenated -string of the form 'Genre1/SubGenre1,Genre2/SubGenre2" etc. - + line="84">Metadata field for an entry's genre. + c:type="TOTEM_PL_PARSER_FIELD_ID"> Metadata field for an entry's identifier. Its use is dependent on the format + line="241">Metadata field for an entry's identifier. Its use is dependent on the format of the playlist parsed, and its origin. - + version="2.26"> Metadata field for an entry's thumbnail image URI. - + line="224">Metadata field for an entry's thumbnail image URI. + c:type="TOTEM_PL_PARSER_FIELD_IS_PLAYLIST"> Metadata field used to tell the calling code that the parsing of a playlist + line="248">Metadata field used to tell the calling code that the parsing of a playlist started. It is only %TRUE for the metadata passed to #TotemPlParser::playlist-started or #TotemPlParser::playlist-ended signal handlers. - + Metadata field for an entry's audio language. - + line="212">Metadata field for an entry's audio language. + Metadata field for an entry's "more info" URI. - + line="182">Metadata field for an entry's "more info" URI. + Metadata field for an entry's status in a playlist. This is usually + line="263">Metadata field for an entry's status in a playlist. This is usually used when saving the state of an on-going playlist. - + c:type="TOTEM_PL_PARSER_FIELD_PUB_DATE"> Metadata field for an entry's publication date, which should be parsed using totem_pl_parser_parse_date(). - + line="200">Metadata field for an entry's publication date, which should be parsed using totem_pl_parser_parse_date(). + c:type="TOTEM_PL_PARSER_FIELD_SCREENSIZE"> Metadata field for an entry's preferred screen size. - + line="188">Metadata field for an entry's preferred screen size. + c:type="TOTEM_PL_PARSER_FIELD_STARTTIME"> Metadata field for an entry's playback start time, which should be parsed using totem_pl_parser_parse_duration(). - + line="146">Metadata field for an entry's playback start time, which should be parsed using totem_pl_parser_parse_duration(). + c:type="TOTEM_PL_PARSER_FIELD_SUBTITLE_URI"> The URI of the entry's subtitle file. - + line="114">The URI of the entry's subtitle file. + c:type="TOTEM_PL_PARSER_FIELD_TITLE"> Metadata field for an entry's displayable title. - + line="90">Metadata field for an entry's displayable title. + c:type="TOTEM_PL_PARSER_FIELD_UI_MODE"> Metadata field for an entry's preferred UI mode. - + line="194">Metadata field for an entry's preferred UI mode. + c:type="TOTEM_PL_PARSER_FIELD_VOLUME"> Metadata field for an entry's playback volume. - + line="120">Metadata field for an entry's playback volume. + All the fields in the #TotemPlParser structure are private and should never be accessed directly. - + Creates a #TotemPlParser object. - + line="682">Creates a #TotemPlParser object. + a new #TotemPlParser + line="687">a new #TotemPlParser @@ -487,31 +476,31 @@ used when saving the state of an on-going playlist. c:identifier="totem_pl_parser_can_parse_from_data"> Checks if the first @len bytes of @data can be parsed. + line="2662">Checks if the first @len bytes of @data can be parsed. %TRUE if @data can be parsed + line="2670">%TRUE if @data can be parsed the data to check for parsability + line="2664">the data to check for parsability the length of data to check + line="2665">the length of data to check %TRUE if debug statements should be printed + line="2666">%TRUE if debug statements should be printed @@ -520,7 +509,7 @@ used when saving the state of an on-going playlist. c:identifier="totem_pl_parser_can_parse_from_filename"> Checks if the file can be parsed. Files can be parsed if: + line="2720">Checks if the file can be parsed. Files can be parsed if: <itemizedlist> <listitem><para>they have a special mimetype, or</para></listitem> <listitem><para>they have a mimetype which could be a video or a playlist.</para></listitem> @@ -529,20 +518,20 @@ used when saving the state of an on-going playlist. %TRUE if @filename can be parsed + line="2731">%TRUE if @filename can be parsed the file to check for parsability + line="2722">the file to check for parsability %TRUE if debug statements should be printed + line="2723">%TRUE if debug statements should be printed @@ -551,27 +540,27 @@ used when saving the state of an on-going playlist. c:identifier="totem_pl_parser_can_parse_from_uri"> Checks if the remote URI can be parsed. Note that this does + line="2758">Checks if the remote URI can be parsed. Note that this does not actually try to open the remote URI, or deduce its mime-type from filename, as this would bring too many false positives. %TRUE if @uri could be parsed + line="2767">%TRUE if @uri could be parsed the remote URI to check for parsability + line="2760">the remote URI to check for parsability %TRUE if debug statements should be printed + line="2761">%TRUE if debug statements should be printed @@ -579,26 +568,26 @@ from filename, as this would bring too many false positives. Parses the given date string and returns it as a <type>gint64</type> + line="2573">Parses the given date string and returns it as a <type>gint64</type> denoting the date in seconds since the UNIX Epoch. - + the date in seconds, or -1 on error + line="2581">the date in seconds, or -1 on error the date string to parse + line="2575">the date string to parse %TRUE if debug statements should be printed + line="2576">%TRUE if debug statements should be printed @@ -607,32 +596,32 @@ denoting the date in seconds since the UNIX Epoch. c:identifier="totem_pl_parser_parse_duration"> Parses the given duration string and returns it as a <type>gint64</type> + line="2503">Parses the given duration string and returns it as a <type>gint64</type> denoting the duration in seconds. - + the duration in seconds, or -1 on error + line="2511">the duration in seconds, or -1 on error the duration string to parse + line="2505">the duration string to parse %TRUE if debug statements should be printed + line="2506">%TRUE if debug statements should be printed - + @@ -652,7 +641,7 @@ denoting the duration in seconds. - + @@ -666,7 +655,7 @@ denoting the duration in seconds. - + @@ -690,9 +679,9 @@ denoting the duration in seconds. version="3.26.4"> Adds a glob to the list of mimetypes to ignore, so that + line="2482">Adds a glob to the list of mimetypes to ignore, so that any URI of that glob is ignored during playlist parsing. - + @@ -700,13 +689,13 @@ any URI of that glob is ignored during playlist parsing. a #TotemPlParser + line="2484">a #TotemPlParser a glob to ignore + line="2485">a glob to ignore @@ -715,9 +704,9 @@ any URI of that glob is ignored during playlist parsing. c:identifier="totem_pl_parser_add_ignored_mimetype"> Adds a mimetype to the list of mimetypes to ignore, so that + line="2463">Adds a mimetype to the list of mimetypes to ignore, so that any URI of that mimetype is ignored during playlist parsing. - + @@ -725,13 +714,13 @@ any URI of that mimetype is ignored during playlist parsing. a #TotemPlParser + line="2465">a #TotemPlParser the mimetype to ignore + line="2466">the mimetype to ignore @@ -740,9 +729,9 @@ any URI of that mimetype is ignored during playlist parsing. c:identifier="totem_pl_parser_add_ignored_scheme"> Adds a scheme to the list of schemes to ignore, so that + line="2437">Adds a scheme to the list of schemes to ignore, so that any URI using that scheme is ignored during playlist parsing. - + @@ -750,13 +739,13 @@ any URI using that scheme is ignored during playlist parsing. a #TotemPlParser + line="2439">a #TotemPlParser the scheme to ignore + line="2440">the scheme to ignore @@ -764,35 +753,35 @@ any URI using that scheme is ignored during playlist parsing. Parses a playlist given by the absolute URI @uri. This method is + line="2415">Parses a playlist given by the absolute URI @uri. This method is synchronous, and will block on (e.g.) network requests to slow servers. totem_pl_parser_parse_async() is recommended instead. Return values are as totem_pl_parser_parse_with_base(). - + a #TotemPlParserResult + line="2428">a #TotemPlParserResult a #TotemPlParser + line="2417">a #TotemPlParser the URI of the playlist to parse + line="2418">the URI of the playlist to parse %TRUE if the parser should add the playlist URI to the + line="2419">%TRUE if the parser should add the playlist URI to the end of the playlist on parse failure @@ -801,14 +790,14 @@ end of the playlist on parse failure Starts asynchronous parsing of a playlist given by the absolute URI @uri. @parser and @uri are both reffed/copied + line="2364">Starts asynchronous parsing of a playlist given by the absolute URI @uri. @parser and @uri are both reffed/copied when this function is called, so can safely be freed after this function returns. For more details, see totem_pl_parser_parse(), which is the synchronous version of this function. When the operation is finished, @callback will be called. You can then call totem_pl_parser_parse_finish() to get the results of the operation. - + @@ -816,19 +805,19 @@ to get the results of the operation. a #TotemPlParser + line="2366">a #TotemPlParser the URI of the playlist to parse + line="2367">the URI of the playlist to parse %TRUE if the parser should add the playlist URI to the + line="2368">%TRUE if the parser should add the playlist URI to the end of the playlist on parse failure @@ -838,7 +827,7 @@ end of the playlist on parse failure allow-none="1"> optional #GCancellable object, or %NULL + line="2370">optional #GCancellable object, or %NULL closure="4"> a #GAsyncReadyCallback to call when parsing is finished + line="2371">a #GAsyncReadyCallback to call when parsing is finished allow-none="1"> data to pass to the @callback function + line="2372">data to pass to the @callback function @@ -868,29 +857,29 @@ end of the playlist on parse failure throws="1"> Finishes an asynchronous playlist parsing operation started with totem_pl_parser_parse_async() + line="2389">Finishes an asynchronous playlist parsing operation started with totem_pl_parser_parse_async() or totem_pl_parser_parse_with_base_async(). If parsing of the playlist is cancelled part-way through, %TOTEM_PL_PARSER_RESULT_CANCELLED is returned when this function is called. - + a #TotemPlParserResult + line="2401">a #TotemPlParserResult a #TotemPlParser + line="2391">a #TotemPlParser a #GAsyncResult + line="2392">a #GAsyncResult @@ -899,26 +888,26 @@ this function is called. c:identifier="totem_pl_parser_parse_with_base"> Parses a playlist given by the absolute URI @uri, using + line="2312">Parses a playlist given by the absolute URI @uri, using @base to resolve relative paths where appropriate. - + a #TotemPlParserResult + line="2323">a #TotemPlParserResult a #TotemPlParser + line="2314">a #TotemPlParser the URI of the playlist to parse + line="2315">the URI of the playlist to parse allow-none="1"> the base path for relative filenames, or %NULL + line="2316">the base path for relative filenames, or %NULL %TRUE if the parser should add the playlist URI to the + line="2317">%TRUE if the parser should add the playlist URI to the end of the playlist on parse failure @@ -943,14 +932,14 @@ end of the playlist on parse failure c:identifier="totem_pl_parser_parse_with_base_async"> Starts asynchronous parsing of a playlist given by the absolute URI @uri, using @base to resolve relative paths where appropriate. + line="2271">Starts asynchronous parsing of a playlist given by the absolute URI @uri, using @base to resolve relative paths where appropriate. @parser and @uri are both reffed/copied when this function is called, so can safely be freed after this function returns. For more details, see totem_pl_parser_parse_with_base(), which is the synchronous version of this function. When the operation is finished, @callback will be called. You can then call totem_pl_parser_parse_finish() to get the results of the operation. - + @@ -958,13 +947,13 @@ to get the results of the operation. a #TotemPlParser + line="2273">a #TotemPlParser the URI of the playlist to parse + line="2274">the URI of the playlist to parse allow-none="1"> the base path for relative filenames, or %NULL + line="2275">the base path for relative filenames, or %NULL %TRUE if the parser should add the playlist URI to the + line="2276">%TRUE if the parser should add the playlist URI to the end of the playlist on parse failure @@ -989,7 +978,7 @@ end of the playlist on parse failure allow-none="1"> optional #GCancellable object, or %NULL + line="2278">optional #GCancellable object, or %NULL closure="5"> a #GAsyncReadyCallback to call when parsing is finished + line="2279">a #GAsyncReadyCallback to call when parsing is finished allow-none="1"> data to pass to the @callback function + line="2280">data to pass to the @callback function @@ -1017,7 +1006,7 @@ end of the playlist on parse failure Writes the playlist held by @parser and @playlist out to the path + line="1211">Writes the playlist held by @parser and @playlist out to the path pointed by @dest. The playlist is written in the format @type and is given the title @title. @@ -1034,42 +1023,42 @@ parts of the playlist to be written are too long. If writing a PLA playlist and there is an error converting a URI's encoding, a code from #GConvertError will be returned. - + %TRUE on success + line="1238">%TRUE on success a #TotemPlParser + line="1213">a #TotemPlParser a #TotemPlPlaylist + line="1214">a #TotemPlPlaylist output #GFile + line="1215">output #GFile the playlist title + line="1216">the playlist title a #TotemPlParserType for the outputted playlist + line="1217">a #TotemPlParserType for the outputted playlist @@ -1077,12 +1066,12 @@ a code from #GConvertError will be returned. Starts asynchronous version of totem_pl_parser_save(). For more details + line="1271">Starts asynchronous version of totem_pl_parser_save(). For more details see totem_pl_parser_save(). When the operation is finished, @callback will be called. You can then call totem_pl_parser_save_finish() to get the results of the operation. - + @@ -1090,31 +1079,31 @@ totem_pl_parser_save_finish() to get the results of the operation. a #TotemPlParser + line="1273">a #TotemPlParser a #TotemPlPlaylist + line="1274">a #TotemPlPlaylist output #GFile + line="1275">output #GFile the playlist title + line="1276">the playlist title a #TotemPlParserType for the outputted playlist + line="1277">a #TotemPlParserType for the outputted playlist allow-none="1"> a #GCancellable, or %NULL + line="1278">a #GCancellable, or %NULL closure="6"> a #GAsyncReadyCallback to call when saving has finished + line="1279">a #GAsyncReadyCallback to call when saving has finished allow-none="1"> data to pass to the @callback function + line="1280">data to pass to the @callback function @@ -1153,28 +1142,28 @@ totem_pl_parser_save_finish() to get the results of the operation. throws="1"> Finishes an asynchronous playlist saving operation started with totem_pl_parser_save_async(). + line="1319">Finishes an asynchronous playlist saving operation started with totem_pl_parser_save_async(). If saving of the playlist is cancelled part-way through, %G_IO_ERROR_CANCELLED will be returned when this function is called. - + %TRUE on success, %FALSE on failure. + line="1330">%TRUE on success, %FALSE on failure. a #TotemPlParser + line="1321">a #TotemPlParser a #GAsyncResult + line="1322">a #GAsyncResult @@ -1304,17 +1293,17 @@ started. glib:is-gtype-struct-for="Parser"> The class structure for the #TotemPlParser type. - + line="292">The class structure for the #TotemPlParser type. + the parent class + line="294">the parent class - + @@ -1336,7 +1325,7 @@ started. - + @@ -1358,7 +1347,7 @@ started. - + @@ -1380,7 +1369,7 @@ started. glib:error-domain="totem_pl_parser_error"> Allows you to differentiate between different + line="336">Allows you to differentiate between different errors occurring during file operations in a #TotemPlParser. glib:name="TOTEM_PL_PARSER_ERROR_NO_DISC"> Error attempting to open a disc device when no disc is present + line="338">Error attempting to open a disc device when no disc is present glib:name="TOTEM_PL_PARSER_ERROR_MOUNT_FAILED"> An attempted mount operation failed + line="339">An attempted mount operation failed glib:name="TOTEM_PL_PARSER_ERROR_EMPTY_PLAYLIST"> Playlist to be saved is empty + line="340">Playlist to be saved is empty @@ -1481,7 +1470,7 @@ and totem_pl_parser_add_ignored_mimetype()). c:type="TotemPlParserType"> The type of playlist a #TotemPlParser will parse. + line="318">The type of playlist a #TotemPlParser will parse. glib:name="TOTEM_PL_PARSER_PLS"> PLS parser + line="320">PLS parser glib:name="TOTEM_PL_PARSER_M3U"> M3U parser + line="321">M3U parser glib:name="TOTEM_PL_PARSER_M3U_DOS"> M3U (DOS linebreaks) parser + line="322">M3U (DOS linebreaks) parser glib:name="TOTEM_PL_PARSER_XSPF"> XSPF parser + line="323">XSPF parser glib:name="TOTEM_PL_PARSER_IRIVER_PLA"> iRiver PLA parser + line="324">iRiver PLA parser - + diff --git a/girs/Tracker-3.0.gir b/girs/Tracker-3.0.gir index 8726d5be8..9082a8be8 100644 --- a/girs/Tracker-3.0.gir +++ b/girs/Tracker-3.0.gir @@ -1251,7 +1251,7 @@ Like #tracker_major_version, but intended to be used at application compile time line="10"/> - + The micro version of the Tracker library. diff --git a/girs/UMockdev-1.0.gir b/girs/UMockdev-1.0.gir index 0557ada43..1693f761b 100644 --- a/girs/UMockdev-1.0.gir +++ b/girs/UMockdev-1.0.gir @@ -1,5 +1,5 @@ - + diff --git a/girs/UPowerGlib-1.0.gir b/girs/UPowerGlib-1.0.gir index 92b27e927..0c523f412 100644 --- a/girs/UPowerGlib-1.0.gir +++ b/girs/UPowerGlib-1.0.gir @@ -8,11 +8,53 @@ and/or use gtk-doc annotations. --> xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> + + + The compile-time major version + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="UpClient" glib:get-type="up_client_get_type" glib:type-struct="ClientClass"> + + + - Creates a new #UpClient object. + Creates a new #UpClient object. If connecting to upowerd on D-Bus fails, +this returns %NULL and prints out a warning with the error message. +Consider using up_client_new_full() instead which allows you to handle errors +and cancelling long operations yourself. + + + a new UpClient object, or %NULL on failure. + + + + + Finishes an operation started with up_client_new_async(). + + + a #UpClient or %NULL if @error is set. + Free with g_object_unref(). + + + + + a #GAsyncResult obtained from the #GAsyncReadyCallback passed + to up_client_new_async() + + + + + + Creates a new #UpClient object. If connecting to upowerd on D-Bus fails, +this returns %NULL and sets @error. + - a new UpClient object. + a new UpClient object, or %NULL on failure. + + + A #GCancellable or %NULL. + + + + + Asynchronously creates a new #UpClient object. + +This is an asynchronous failable function. + + + + + + + a #GCancellable or %NULL + + + + a #GAsyncReadyCallback to call when the request is satisfied + + + + the data to pass to @callback + + + + + @@ -41,6 +192,7 @@ and/or use gtk-doc annotations. --> + @@ -56,129 +208,313 @@ and/or use gtk-doc annotations. --> - Gets a string representing the configured critical action, + Gets a string representing the configured critical action, depending on availability. + - the action name, or %NULL on error. + the action name, or %NULL on error. - a #UpClient instance. + a #UpClient instance. - Get UPower daemon version. - - string containing the daemon version, e.g. 008 + Get UPower daemon version. + + + string containing the daemon version, e.g. 008 - a #UpClient instance. + a #UpClient instance. - Get a copy of the device objects. + version="0.9.0" + deprecated="1" + deprecated-version="0.99.8" + glib:async-func="get_devices_async"> + Get a copy of the device objects. This function does not set the free +function for the #GPtrArray so you need use g_object_unref on all +elements when you are finished with the array. + + + an array of #UpDevice objects or %NULL on error, free with g_ptr_array_unref() + + + + + + + a #UpClient instance. + + + + + + Get a copy of the device objects. + + + an array of #UpDevice objects or %NULL on error, free with g_ptr_array_unref() + + + + + + + a #UpClient instance. + + + + + + Asynchronously fetches the list of #UpDevice objects. + + + + + + + a #UpClient instance. + + + + a #GCancellable or %NULL + + + + a #GAsyncReadyCallback to call when the request is satisfied + + + + the data to pass to @callback + + + + + + Finishes an operation started with up_client_get_devices_async(). + - an array of #UpDevice objects, free with g_ptr_array_unref() + an array of + #UpDevice objects or %NULL on error. - a #UpClient instance. + a #UpClient instance. + + a #GAsyncResult obtained from the #GAsyncReadyCallback passed + to up_client_get_devices_async() + + - Get the composite display device. + Get the composite display device. + - a #UpClient object, or %NULL on error. + a #UpDevice object, or %NULL on error. - a #UpClient instance. + a #UpClient instance. - Get whether the laptop lid is closed. - - %TRUE if lid is closed or %FALSE otherwise. + Get whether the laptop lid is closed. + + + %TRUE if lid is closed or %FALSE otherwise. - a #UpClient instance. + a #UpClient instance. - Get whether a laptop lid is present on this machine. - - %TRUE if the machine has a laptop lid + Get whether a laptop lid is present on this machine. + + + %TRUE if the machine has a laptop lid - a #UpClient instance. + a #UpClient instance. - Get whether the system is running on battery power. - - %TRUE if the system is currently running on battery, %FALSE otherwise. + Get whether the system is running on battery power. + + + %TRUE if the system is currently running on battery, %FALSE otherwise. - a #UpClient instance. + a #UpClient instance. - The daemon version. + transfer-ownership="none" + getter="get_daemon_version" + default-value="NULL"> + The daemon version. - - If the laptop lid is closed. + + If the laptop lid is closed. - If a laptop lid is present. + transfer-ownership="none" + getter="get_lid_is_present" + default-value="FALSE"> + If a laptop lid is present. - - If the computer is on battery power. + + If the computer is on battery power. @@ -188,25 +524,33 @@ depending on availability. - The ::device-added signal is emitted when a power device is added. + The ::device-added signal is emitted when a power device is added. - the #UpDevice that was added. + the #UpDevice that was added. - The ::device-removed signal is emitted when a power device is removed. + The ::device-removed signal is emitted when a power device is removed. - the object path of the #UpDevice that was removed. + the object path of the #UpDevice that was removed. @@ -215,11 +559,13 @@ depending on availability. - + + + @@ -235,6 +581,7 @@ depending on availability. + @@ -250,6 +597,7 @@ depending on availability. + @@ -257,6 +605,7 @@ depending on availability. + @@ -264,6 +613,7 @@ depending on availability. + @@ -271,6 +621,7 @@ depending on availability. + @@ -278,6 +629,7 @@ depending on availability. + @@ -285,6 +637,7 @@ depending on availability. + @@ -292,6 +645,7 @@ depending on availability. + @@ -299,6639 +653,1606 @@ depending on availability. + - - Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower.top_of_page">org.freedesktop.UPower</link>. - - Gets a machine-readable description of the <link linkend="gdbus-interface-org-freedesktop-UPower.top_of_page">org.freedesktop.UPower</link> D-Bus interface. - - A #GDBusInterfaceInfo. Do not free. - + + Private #UpClient data + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new #UpDevice object. + + + a new UpDevice object. + - - - Overrides all #GObject properties in the #UpClientGlue interface for a concrete class. -The properties are overridden in the order they are defined. - - The last property id. - + + + Converts a string to a #UpDeviceKind. + + + enumerated value + - - The class structure for a #GObject<!-- -->-derived class. - - - - The property id to assign to the first overridden property. - + + - - - + + Converts a #UpDeviceKind to a string. + + + identifier string + - - - - - + + - - - - + + + Converts a string to a #UpDeviceLevel. + + + enumerated value + - - - - + - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower.DaemonVersion">"DaemonVersion"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_client_glue_dup_daemon_version() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. + + + Converts a #UpDeviceLevel to a string. + + + identifier string - - A #UpClientGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower.LidIsClosed">"LidIsClosed"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpClientGlue. - - + + + - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower.LidIsPresent">"LidIsPresent"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - + + + Converts a string to a #UpDeviceState. + + + enumerated value + - - A #UpClientGlue. - - + + + - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower.OnBattery">"OnBattery"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - + + + Converts a #UpDeviceState to a string. + + + identifier string + - - A #UpClientGlue. - - + + + - - - - + + + Converts a string to a #UpDeviceTechnology. + + + enumerated value + - - - - - + + - - - - + + + Converts a #UpDeviceTechnology to a string. + + + identifier string + - - - - - + + - - - - - - - - - - - - - - - - Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower.EnumerateDevices">EnumerateDevices()</link> D-Bus method on @proxy. -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_client_glue_call_enumerate_devices_finish() to get the result of the operation. - -See up_client_glue_call_enumerate_devices_sync() for the synchronous, blocking version of this method. - - - - - - A #UpClientGlueProxy. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied or %NULL. - - - - User data to pass to @callback. - - - - - + - Finishes an operation started with up_client_glue_call_enumerate_devices(). - - %TRUE if the call succeded, %FALSE if @error is set. - + Gets the device history. + + + an array of #UpHistoryItem's, with the most + recent one being first; %NULL if @error is set or @device is + invalid + + + - - A #UpClientGlueProxy. - + + a #UpDevice instance. + - - Return location for return parameter or %NULL to ignore. - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_client_glue_call_enumerate_devices(). - + + The type of history, known values are "rate" and "charge". + - - - - Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower.EnumerateDevices">EnumerateDevices()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. - -See up_client_glue_call_enumerate_devices() for the asynchronous version of this method. - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpClientGlueProxy. - - - - Return location for return parameter or %NULL to ignore. - + + the amount of time to look back into time. + - - A #GCancellable or %NULL. - + + the resolution of data. + - - - - Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower.GetCriticalAction">GetCriticalAction()</link> D-Bus method on @proxy. -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_client_glue_call_get_critical_action_finish() to get the result of the operation. - -See up_client_glue_call_get_critical_action_sync() for the synchronous, blocking version of this method. - - - - - - A #UpClientGlueProxy. - - - A #GCancellable or %NULL. + a #GCancellable or %NULL - - A #GAsyncReadyCallback to call when the request is satisfied or %NULL. - - - - User data to pass to @callback. - - - - Finishes an operation started with up_client_glue_call_get_critical_action(). - - %TRUE if the call succeded, %FALSE if @error is set. - + + Gets the object path for the device. + + + the object path, or %NULL + - - A #UpClientGlueProxy. - + + a #UpDevice instance. + - - Return location for return parameter or %NULL to ignore. - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_client_glue_call_get_critical_action(). - - - - Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower.GetCriticalAction">GetCriticalAction()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. - -See up_client_glue_call_get_critical_action() for the asynchronous version of this method. - - %TRUE if the call succeded, %FALSE if @error is set. - + Gets the device current statistics. + + + an array of #UpStatsItem's, else #NULL and @error is used + + + - - A #UpClientGlueProxy. - + + a #UpDevice instance. + - - Return location for return parameter or %NULL to ignore. - + + the type of statistics. + - A #GCancellable or %NULL. + a #GCancellable or %NULL - - Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower.GetDisplayDevice">GetDisplayDevice()</link> D-Bus method on @proxy. -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_client_glue_call_get_display_device_finish() to get the result of the operation. - -See up_client_glue_call_get_display_device_sync() for the synchronous, blocking version of this method. - - + + Refreshes properties on the device. +This function is normally not required and will only return without +an error if the daemon was started in debug mode. + + + #TRUE for success, else #FALSE and @error is used + - - A #UpClientGlueProxy. - + + a #UpDevice instance. + - A #GCancellable or %NULL. + a #GCancellable or %NULL - - A #GAsyncReadyCallback to call when the request is satisfied or %NULL. - - - - User data to pass to @callback. - - - - - - Finishes an operation started with up_client_glue_call_get_display_device(). - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpClientGlueProxy. - - - - Return location for return parameter or %NULL to ignore. - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_client_glue_call_get_display_device(). - - - - Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower.GetDisplayDevice">GetDisplayDevice()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. - -See up_client_glue_call_get_display_device() for the asynchronous version of this method. - - %TRUE if the call succeded, %FALSE if @error is set. + Sets the object path of the object and fills up initial properties. + + + #TRUE for success, else #FALSE and @error is used - - A #UpClientGlueProxy. - + + a #UpDevice instance. + - - Return location for return parameter or %NULL to ignore. - + + The UPower object path. + - A #GCancellable or %NULL. + a #GCancellable or %NULL - - Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-UPower.EnumerateDevices">EnumerateDevices()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. - -This method will free @invocation, you cannot use it afterwards. - - - - - - A #UpClientGlue. - - - - A #GDBusMethodInvocation. - - - - Parameter to return. - - - - - - Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-UPower.GetCriticalAction">GetCriticalAction()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. - -This method will free @invocation, you cannot use it afterwards. - - - - - - A #UpClientGlue. - - - - A #GDBusMethodInvocation. - - - - Parameter to return. - - - - - - Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-UPower.GetDisplayDevice">GetDisplayDevice()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. - -This method will free @invocation, you cannot use it afterwards. - - - - - - A #UpClientGlue. - - - - A #GDBusMethodInvocation. - - - - Parameter to return. - - - - - - Gets a copy of the <link linkend="gdbus-property-org-freedesktop-UPower.DaemonVersion">"DaemonVersion"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + Converts the device to a string description. + - The property value or %NULL if the property is not set. The returned value should be freed with g_free(). + text representation of #UpDevice - - A #UpClientGlue. - - - - - - Emits the <link linkend="gdbus-signal-org-freedesktop-UPower.DeviceAdded">"DeviceAdded"</link> D-Bus signal. - - - - - - A #UpClientGlue. - - - - Argument to pass with the signal. - - - - - - Emits the <link linkend="gdbus-signal-org-freedesktop-UPower.DeviceRemoved">"DeviceRemoved"</link> D-Bus signal. - - - - - - A #UpClientGlue. - - - - Argument to pass with the signal. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower.DaemonVersion">"DaemonVersion"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_client_glue_dup_daemon_version() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpClientGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower.LidIsClosed">"LidIsClosed"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpClientGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower.LidIsPresent">"LidIsPresent"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpClientGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower.OnBattery">"OnBattery"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpClientGlue. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower.DaemonVersion">"DaemonVersion"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpClientGlue. - + + a #UpDevice instance. + - - The value to set. - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower.LidIsClosed">"LidIsClosed"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpClientGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower.LidIsPresent">"LidIsPresent"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpClientGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower.OnBattery">"OnBattery"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpClientGlue. - - - - The value to set. - - - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower.DaemonVersion">"DaemonVersion"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. + + The battery level, e.g. %UP_DEVICE_LEVEL_CRITICAL. If this is something +other than %UP_DEVICE_LEVEL_NONE, then User Interfaces should use this +approximate level instead of percentages. + + + + The percentage capacity of the device where 100% means the device has +the same charge potential as when it was manufactured. + + + + The number of charge cycles for the battery, or -1 if unknown +or non-applicable. + + + + The energy left in the device. Measured in mWh. + + + + The energy the device will have when it is empty. This is usually zero. +Measured in mWh. + + + + The amount of energy when the device is fully charged. Measured in mWh. + + + + The amount of energy when the device was brand new. Measured in mWh. + + + + The rate of discharge or charge. Measured in mW. + + + + If the device has history data that might be useful. + + + + If the device has statistics data that might be useful. + + + + The icon name, following the Icon Naming Speficiation - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower.LidIsClosed">"LidIsClosed"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. + + If the device is present, as some devices like laptop batteries +can be removed, leaving an empty bay that is still technically a +device. - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower.LidIsPresent">"LidIsPresent"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. + + If the device has a rechargable battery. - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower.OnBattery">"OnBattery"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. + + The device kind, e.g. %UP_DEVICE_KIND_KEYBOARD. + + + + The current luminosity of the device. + + + + The model of the device. + + + + The native path of the device, useful for direct device access. + + + + If the device is online, i.e. connected. - - On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-freedesktop-UPower.DeviceAdded">"DeviceAdded"</link> is received. - -On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - - - - - - Argument. - - - - - - On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-freedesktop-UPower.DeviceRemoved">"DeviceRemoved"</link> is received. - -On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - - - - - - Argument. - - - - - - Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-UPower.EnumerateDevices">EnumerateDevices()</link> D-Bus method. - -If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call up_client_glue_complete_enumerate_devices() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. - - %TRUE if the invocation was handled, %FALSE to let other signal handlers run. - - - - - A #GDBusMethodInvocation. - - - - - - Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-UPower.GetCriticalAction">GetCriticalAction()</link> D-Bus method. - -If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call up_client_glue_complete_get_critical_action() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. - - %TRUE if the invocation was handled, %FALSE to let other signal handlers run. - - - - - A #GDBusMethodInvocation. - - - - - - Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-UPower.GetDisplayDevice">GetDisplayDevice()</link> D-Bus method. - -If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call up_client_glue_complete_get_display_device() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. - - %TRUE if the invocation was handled, %FALSE to let other signal handlers run. - - - - - A #GDBusMethodInvocation. - - - - - - - Virtual table for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower.top_of_page">org.freedesktop.UPower</link>. - - The parent interface. - + + The percentage charge of the device. Note that if the battery level property +is something other than %UP_DEVICE_LEVEL_NONE, then this percentage is an +approximation, and should not be used a number to display to the user. + + + + If the device is powering the system. + + + + The serial number of the device. + + + + The state the device is in at this time, e.g. %UP_DEVICE_STATE_EMPTY. + + + + The battery technology e.g. %UP_DEVICE_TECHNOLOGY_LITHIUM_ION. + + + + The temperature of the device in degrees Celsius. + + + + The amount of time until the device is empty. + + + + The amount of time until the device is fully charged. + + + + The last time the device was updated. + + + + The vendor of the device. + + + + The current voltage of the device. + + + + The warning level e.g. %UP_DEVICE_LEVEL_CRITICAL. + + + + + + + + + + + + + - - + + + - + - - - - - - - - - - + + + - + - - - - - - - - - - + + + - + - - - - - - - - - - + + + - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - + - - - A #UpClientGlue. - - - - - + + + - The property value. - + - - - A #UpClientGlue. - - - - - - - - - The property value. - - - - - A #UpClientGlue. - - - - - + + + - The property value. - + - - - A #UpClientGlue. - - - - - + + + - - - - - - - - - - + + + - - - - - - - - - - The #UpClientGlueProxy structure contains only private data and should only be accessed using the provided API. - - - - - - Finishes an operation started with up_client_glue_proxy_new(). - - The constructed proxy object or %NULL if @error is set. - - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_client_glue_proxy_new(). - - - - - - Finishes an operation started with up_client_glue_proxy_new_for_bus(). - - The constructed proxy object or %NULL if @error is set. - - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_client_glue_proxy_new_for_bus(). - - - - - - Like up_client_glue_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. - -The calling thread is blocked until a reply is received. - -See up_client_glue_proxy_new_for_bus() for the asynchronous version of this constructor. - - The constructed proxy object or %NULL if @error is set. - - - - - A #GBusType. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique). - - - - An object path. - - - - A #GCancellable or %NULL. - - - - - - Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower.top_of_page">org.freedesktop.UPower</link>. See g_dbus_proxy_new_sync() for more details. - -The calling thread is blocked until a reply is received. - -See up_client_glue_proxy_new() for the asynchronous version of this constructor. - - The constructed proxy object or %NULL if @error is set. - - - - - A #GDBusConnection. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. - - - - An object path. - - - - A #GCancellable or %NULL. - - - - - - Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower.top_of_page">org.freedesktop.UPower</link>. See g_dbus_proxy_new() for more details. - -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_client_glue_proxy_new_finish() to get the result of the operation. - -See up_client_glue_proxy_new_sync() for the synchronous, blocking version of this constructor. - - - - - - A #GDBusConnection. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. - - - - An object path. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied. - - - - User data to pass to @callback. - - - - - - Like up_client_glue_proxy_new() but takes a #GBusType instead of a #GDBusConnection. - -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_client_glue_proxy_new_for_bus_finish() to get the result of the operation. - -See up_client_glue_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. - - - - - - A #GBusType. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique). - - - - An object path. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied. - - - - User data to pass to @callback. - - - - - - - - - - - - - Class structure for #UpClientGlueProxy. - - The parent class. - - - - - - - The #UpClientGlueSkeleton structure contains only private data and should only be accessed using the provided API. - - - - Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower.top_of_page">org.freedesktop.UPower</link>. - - The skeleton object. - - - - - - - - - - - - Class structure for #UpClientGlueSkeleton. - - The parent class. - - - - - - - Private #UpClient data + + The device type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The level of a battery. Only values up to, and including +%UP_DEVICE_LEVEL_ACTION are relevant for the #WarningLevel. +The #BatteryLevel only uses the following values: +- %UP_DEVICE_LEVEL_UNKNOWN +- %UP_DEVICE_LEVEL_NONE +- %UP_DEVICE_LEVEL_LOW +- %UP_DEVICE_LEVEL_CRITICAL +- %UP_DEVICE_LEVEL_NORMAL +- %UP_DEVICE_LEVEL_HIGH +- %UP_DEVICE_LEVEL_FULL + + + + + + + + + + + + + + + + + + + + + + + + Private #PkDevice data + - - - Creates a new #UpDevice object. - - a new UpDevice object. - - - - - Converts a string to a #UpDeviceKind. - - enumerated value - - - - - - - - - - Converts a #UpDeviceKind to a string. - - identifier string - - - - - - - - - - Converts a string to a #UpDeviceLevel. - - enumerated value - - - - - - - - - - Converts a #UpDeviceLevel to a string. - - identifier string - - - - - - - - - - Converts a string to a #UpDeviceState. - - enumerated value - - - - - - - - - - Converts a #UpDeviceState to a string. - - identifier string - - - - - - - - - - Converts a string to a #UpDeviceTechnology. - - enumerated value - - - - - - - - - - Converts a #UpDeviceTechnology to a string. - - identifier string - - - - - - - - - - Gets the device history. - - an array of #UpHistoryItem's, with the most - recent one being first; %NULL if @error is set or @device is - invalid - - - - - - - a #UpDevice instance. - - - - The type of history, known values are "rate" and "charge". - - - - the amount of time to look back into time. - - - - the resolution of data. - - - - a #GCancellable or %NULL - - - - - - Gets the object path for the device. - - the object path, or %NULL - - - - - a #UpDevice instance. - - - - - - Gets the device current statistics. - - an array of #UpStatsItem's, else #NULL and @error is used - - - - - - - a #UpDevice instance. - - - - the type of statistics. - - - - a #GCancellable or %NULL - - - - - - Refreshes properties on the device. -This function is normally not required. - - #TRUE for success, else #FALSE and @error is used - - - - - a #UpDevice instance. - - - - a #GCancellable or %NULL - - - - - - Sets the object path of the object and fills up initial properties. - - #TRUE for success, else #FALSE and @error is used - - - - - a #UpDevice instance. - - - - The UPower object path. - - - - a #GCancellable or %NULL - - - - - - Converts the device to a string description. - - text representation of #UpDevice - - - - - a #UpDevice instance. - - - - - - The percentage capacity of the device where 100% means the device has -the same charge potential as when it was manufactured. - - - - The energy left in the device. Measured in mWh. - - - - The energy the device will have when it is empty. This is usually zero. -Measured in mWh. - - - - The amount of energy when the device is fully charged. Measured in mWh. - - - - The amount of energy when the device was brand new. Measured in mWh. - - - - The rate of discharge or charge. Measured in mW. - - - - If the device has history data that might be useful. - - - - If the device has statistics data that might be useful. - - - - The icon name, following the Icon Naming Speficiation - - - - If the device is present, as some devices like laptop batteries -can be removed, leaving an empty bay that is still technically a -device. - - - - If the device has a rechargable battery. - - - - The device kind, e.g. %UP_DEVICE_KIND_KEYBOARD. - - - - The current luminosity of the device. - - - - The model of the device. - - - - The native path of the device, useful for direct device access. - - - - If the device is online, i.e. connected. - - - - The percentage charge of the device. - - - - If the device is powering the system. - - - - The serial number of the device. - - - - The state the device is in at this time, e.g. %UP_DEVICE_STATE_EMPTY. - - - - The battery technology e.g. %UP_DEVICE_TECHNOLOGY_LITHIUM_ION. - - - - The temperature of the device in degrees Celsius. - - - - The amount of time until the device is empty. - - - - The amount of time until the device is fully charged. - - - - The last time the device was updated. - - - - The vendor of the device. - - - - The current voltage of the device. - - - - The warning level e.g. %UP_DEVICE_LEVEL_WARNING. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower-Device.top_of_page">org.freedesktop.UPower.Device</link>. - - Gets a machine-readable description of the <link linkend="gdbus-interface-org-freedesktop-UPower-Device.top_of_page">org.freedesktop.UPower.Device</link> D-Bus interface. - - A #GDBusInterfaceInfo. Do not free. - - - - - Overrides all #GObject properties in the #UpDeviceGlue interface for a concrete class. -The properties are overridden in the order they are defined. - - The last property id. - - - - - The class structure for a #GObject<!-- -->-derived class. - - - - The property id to assign to the first overridden property. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Capacity">"Capacity"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Energy">"Energy"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyEmpty">"EnergyEmpty"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyFull">"EnergyFull"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyFullDesign">"EnergyFullDesign"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyRate">"EnergyRate"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.HasHistory">"HasHistory"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.HasStatistics">"HasStatistics"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.IconName">"IconName"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_device_glue_dup_icon_name() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.IsPresent">"IsPresent"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.IsRechargeable">"IsRechargeable"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Luminosity">"Luminosity"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Model">"Model"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_device_glue_dup_model() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.NativePath">"NativePath"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_device_glue_dup_native_path() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Online">"Online"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Percentage">"Percentage"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.PowerSupply">"PowerSupply"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Serial">"Serial"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_device_glue_dup_serial() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.State">"State"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Technology">"Technology"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Temperature">"Temperature"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.TimeToEmpty">"TimeToEmpty"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.TimeToFull">"TimeToFull"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Type">"Type"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.UpdateTime">"UpdateTime"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Vendor">"Vendor"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_device_glue_dup_vendor() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Voltage">"Voltage"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.WarningLevel">"WarningLevel"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower-Device.GetHistory">GetHistory()</link> D-Bus method on @proxy. -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_device_glue_call_get_history_finish() to get the result of the operation. - -See up_device_glue_call_get_history_sync() for the synchronous, blocking version of this method. - - - - - - A #UpDeviceGlueProxy. - - - - Argument to pass with the method invocation. - - - - Argument to pass with the method invocation. - - - - Argument to pass with the method invocation. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied or %NULL. - - - - User data to pass to @callback. - - - - - - Finishes an operation started with up_device_glue_call_get_history(). - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpDeviceGlueProxy. - - - - Return location for return parameter or %NULL to ignore. - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_device_glue_call_get_history(). - - - - - - Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower-Device.GetHistory">GetHistory()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. - -See up_device_glue_call_get_history() for the asynchronous version of this method. - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpDeviceGlueProxy. - - - - Argument to pass with the method invocation. - - - - Argument to pass with the method invocation. - - - - Argument to pass with the method invocation. - - - - Return location for return parameter or %NULL to ignore. - - - - A #GCancellable or %NULL. - - - - - - Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower-Device.GetStatistics">GetStatistics()</link> D-Bus method on @proxy. -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_device_glue_call_get_statistics_finish() to get the result of the operation. - -See up_device_glue_call_get_statistics_sync() for the synchronous, blocking version of this method. - - - - - - A #UpDeviceGlueProxy. - - - - Argument to pass with the method invocation. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied or %NULL. - - - - User data to pass to @callback. - - - - - - Finishes an operation started with up_device_glue_call_get_statistics(). - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpDeviceGlueProxy. - - - - Return location for return parameter or %NULL to ignore. - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_device_glue_call_get_statistics(). - - - - - - Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower-Device.GetStatistics">GetStatistics()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. - -See up_device_glue_call_get_statistics() for the asynchronous version of this method. - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpDeviceGlueProxy. - - - - Argument to pass with the method invocation. - - - - Return location for return parameter or %NULL to ignore. - - - - A #GCancellable or %NULL. - - - - - - Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower-Device.Refresh">Refresh()</link> D-Bus method on @proxy. -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_device_glue_call_refresh_finish() to get the result of the operation. - -See up_device_glue_call_refresh_sync() for the synchronous, blocking version of this method. - - - - - - A #UpDeviceGlueProxy. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied or %NULL. - - - - User data to pass to @callback. - - - - - - Finishes an operation started with up_device_glue_call_refresh(). - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpDeviceGlueProxy. - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_device_glue_call_refresh(). - - - - - - Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower-Device.Refresh">Refresh()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. - -See up_device_glue_call_refresh() for the asynchronous version of this method. - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpDeviceGlueProxy. - - - - A #GCancellable or %NULL. - - - - - - Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-UPower-Device.GetHistory">GetHistory()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. - -This method will free @invocation, you cannot use it afterwards. - - - - - - A #UpDeviceGlue. - - - - A #GDBusMethodInvocation. - - - - Parameter to return. - - - - - - Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-UPower-Device.GetStatistics">GetStatistics()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. - -This method will free @invocation, you cannot use it afterwards. - - - - - - A #UpDeviceGlue. - - - - A #GDBusMethodInvocation. - - - - Parameter to return. - - - - - - Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-UPower-Device.Refresh">Refresh()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. - -This method will free @invocation, you cannot use it afterwards. - - - - - - A #UpDeviceGlue. - - - - A #GDBusMethodInvocation. - - - - - - Gets a copy of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.IconName">"IconName"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value or %NULL if the property is not set. The returned value should be freed with g_free(). - - - - - A #UpDeviceGlue. - - - - - - Gets a copy of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Model">"Model"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value or %NULL if the property is not set. The returned value should be freed with g_free(). - - - - - A #UpDeviceGlue. - - - - - - Gets a copy of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.NativePath">"NativePath"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value or %NULL if the property is not set. The returned value should be freed with g_free(). - - - - - A #UpDeviceGlue. - - - - - - Gets a copy of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Serial">"Serial"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value or %NULL if the property is not set. The returned value should be freed with g_free(). - - - - - A #UpDeviceGlue. - - - - - - Gets a copy of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Vendor">"Vendor"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value or %NULL if the property is not set. The returned value should be freed with g_free(). - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Capacity">"Capacity"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Energy">"Energy"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyEmpty">"EnergyEmpty"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyFull">"EnergyFull"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyFullDesign">"EnergyFullDesign"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyRate">"EnergyRate"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.HasHistory">"HasHistory"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.HasStatistics">"HasStatistics"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.IconName">"IconName"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_device_glue_dup_icon_name() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.IsPresent">"IsPresent"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.IsRechargeable">"IsRechargeable"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Luminosity">"Luminosity"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Model">"Model"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_device_glue_dup_model() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.NativePath">"NativePath"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_device_glue_dup_native_path() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Online">"Online"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Percentage">"Percentage"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.PowerSupply">"PowerSupply"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Serial">"Serial"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_device_glue_dup_serial() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.State">"State"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Technology">"Technology"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Temperature">"Temperature"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.TimeToEmpty">"TimeToEmpty"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.TimeToFull">"TimeToFull"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Type">"Type"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.UpdateTime">"UpdateTime"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Vendor">"Vendor"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - -<warning>The returned value is only valid until the property changes so on the client-side it is only safe to use this function on the thread where @object was constructed. Use up_device_glue_dup_vendor() if on another thread.</warning> - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Voltage">"Voltage"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Device.WarningLevel">"WarningLevel"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpDeviceGlue. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Capacity">"Capacity"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Energy">"Energy"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyEmpty">"EnergyEmpty"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyFull">"EnergyFull"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyFullDesign">"EnergyFullDesign"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyRate">"EnergyRate"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.HasHistory">"HasHistory"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.HasStatistics">"HasStatistics"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.IconName">"IconName"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.IsPresent">"IsPresent"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.IsRechargeable">"IsRechargeable"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Luminosity">"Luminosity"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Model">"Model"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.NativePath">"NativePath"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Online">"Online"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Percentage">"Percentage"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.PowerSupply">"PowerSupply"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Serial">"Serial"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.State">"State"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Technology">"Technology"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Temperature">"Temperature"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.TimeToEmpty">"TimeToEmpty"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.TimeToFull">"TimeToFull"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Type">"Type"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.UpdateTime">"UpdateTime"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Vendor">"Vendor"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.Voltage">"Voltage"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Device.WarningLevel">"WarningLevel"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpDeviceGlue. - - - - The value to set. - - - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Capacity">"Capacity"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Energy">"Energy"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyEmpty">"EnergyEmpty"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyFull">"EnergyFull"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyFullDesign">"EnergyFullDesign"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.EnergyRate">"EnergyRate"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.HasHistory">"HasHistory"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.HasStatistics">"HasStatistics"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.IconName">"IconName"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.IsPresent">"IsPresent"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.IsRechargeable">"IsRechargeable"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Luminosity">"Luminosity"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Model">"Model"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.NativePath">"NativePath"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Online">"Online"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Percentage">"Percentage"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.PowerSupply">"PowerSupply"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Serial">"Serial"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.State">"State"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Technology">"Technology"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Temperature">"Temperature"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.TimeToEmpty">"TimeToEmpty"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.TimeToFull">"TimeToFull"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Type">"Type"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.UpdateTime">"UpdateTime"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Vendor">"Vendor"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.Voltage">"Voltage"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Device.WarningLevel">"WarningLevel"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-UPower-Device.GetHistory">GetHistory()</link> D-Bus method. - -If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call up_device_glue_complete_get_history() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. - - %TRUE if the invocation was handled, %FALSE to let other signal handlers run. - - - - - A #GDBusMethodInvocation. - - - - Argument passed by remote caller. - - - - Argument passed by remote caller. - - - - Argument passed by remote caller. - - - - - - Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-UPower-Device.GetStatistics">GetStatistics()</link> D-Bus method. - -If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call up_device_glue_complete_get_statistics() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. - - %TRUE if the invocation was handled, %FALSE to let other signal handlers run. - - - - - A #GDBusMethodInvocation. - - - - Argument passed by remote caller. - - - - - - Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-UPower-Device.Refresh">Refresh()</link> D-Bus method. - -If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call up_device_glue_complete_refresh() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. - - %TRUE if the invocation was handled, %FALSE to let other signal handlers run. - - - - - A #GDBusMethodInvocation. - - - - - - - Virtual table for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower-Device.top_of_page">org.freedesktop.UPower.Device</link>. - - The parent interface. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value or %NULL if the property is not set. Do not free the returned value, it belongs to @object. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - - The property value. - - - - - A #UpDeviceGlue. - - - - - - - - The #UpDeviceGlueProxy structure contains only private data and should only be accessed using the provided API. - - - - - - Finishes an operation started with up_device_glue_proxy_new(). - - The constructed proxy object or %NULL if @error is set. - - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_device_glue_proxy_new(). - - - - - - Finishes an operation started with up_device_glue_proxy_new_for_bus(). - - The constructed proxy object or %NULL if @error is set. - - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_device_glue_proxy_new_for_bus(). - - - - - - Like up_device_glue_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. - -The calling thread is blocked until a reply is received. - -See up_device_glue_proxy_new_for_bus() for the asynchronous version of this constructor. - - The constructed proxy object or %NULL if @error is set. - - - - - A #GBusType. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique). - - - - An object path. - - - - A #GCancellable or %NULL. - - - - - - Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower-Device.top_of_page">org.freedesktop.UPower.Device</link>. See g_dbus_proxy_new_sync() for more details. - -The calling thread is blocked until a reply is received. - -See up_device_glue_proxy_new() for the asynchronous version of this constructor. - - The constructed proxy object or %NULL if @error is set. - - - - - A #GDBusConnection. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. - - - - An object path. - - - - A #GCancellable or %NULL. - - - - - - Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower-Device.top_of_page">org.freedesktop.UPower.Device</link>. See g_dbus_proxy_new() for more details. - -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_device_glue_proxy_new_finish() to get the result of the operation. - -See up_device_glue_proxy_new_sync() for the synchronous, blocking version of this constructor. - - - - - - A #GDBusConnection. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. - - - - An object path. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied. - - - - User data to pass to @callback. - - - - - - Like up_device_glue_proxy_new() but takes a #GBusType instead of a #GDBusConnection. - -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_device_glue_proxy_new_for_bus_finish() to get the result of the operation. - -See up_device_glue_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. - - - - - - A #GBusType. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique). - - - - An object path. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied. - - - - User data to pass to @callback. - - - - - - - - - - - - - Class structure for #UpDeviceGlueProxy. - - The parent class. - - - - - - - The #UpDeviceGlueSkeleton structure contains only private data and should only be accessed using the provided API. - - - - Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower-Device.top_of_page">org.freedesktop.UPower.Device</link>. - - The skeleton object. - - - - - - - - - - - - Class structure for #UpDeviceGlueSkeleton. - - The parent class. - - - - - - - The device type. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The warning level of a battery. - - - - - - - - - - - - - - - - - Private #PkDevice data - - - The device state. - - - - - - - - - - - - - - - - - - - The device technology. - - - - - - - - - - - - - - - - - - - - - a new UpHistoryItem object. - - - - - Gets the item state. - - - - - - #UpHistoryItem - - - - - - Gets the item time. - - - - - - #UpHistoryItem - - - - - - Gets the item value. - - - - - - #UpHistoryItem - - - - - - Converts the history item to a string representation. - - - - - - #UpHistoryItem - - - - - - - - - Sets the item state. - - - - - - #UpHistoryItem - - - - the new value - - - - - - Sets the item time. - - - - - - #UpHistoryItem - - - - the new value - - - - - - Sets the item time to the present value. - - - - - - #UpHistoryItem - - - - - - Sets the item value. - - - - - - #UpHistoryItem - - - - the new value - - - - - - Converts the history item to a string representation. - - - - - - #UpHistoryItem - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The compile-time micro version - - - - - - - - - a new UpStatsItem object. - - - - - Gets the item accuracy. - - - - - - - - - - - Gets the item value. - - - - - - - - - - - Sets the item accuracy. - - - - - - - - - - - - - - Sets the item value. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - a new UpWakeupItem object. - - - - - Gets the item cmdline. - - the value - - - - - #UpWakeupItem - - - - - - Gets the item details. - - the value - - - - - #UpWakeupItem - - - - - - Gets the item id. - - the value - - - - - #UpWakeupItem - - - - - - Gets if the item is userspace. - - the value - - - - - #UpWakeupItem - - - - - - Gets the item old. - - the value - - - - - #UpWakeupItem - - - - - - Gets the item value. - - the value - - - - - #UpWakeupItem - - - - - - Sets the item cmdline. - - - - - - #UpWakeupItem - - - - the new value - - - - - - Sets the item details. - - - - - - #UpWakeupItem - - - - the new value - - - - - - Sets the item id. - - - - - - #UpWakeupItem - - - - the new value - - - - - - Sets if the item is userspace. - - - - - - #UpWakeupItem - - - - the new value - - - - - - Sets the item old. - - - - - - #UpWakeupItem - - - - the new value - - - - - - Sets the item value. - - - - - - #UpWakeupItem - - - - the new value - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets a new object to allow querying the wakeups data from the server. - - the a new @UpWakeups object. - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets the wakeups data from the daemon. - - an array of %UpWakeupItem's - - - - - - - a #UpWakeups instance. - - - - a #GCancellable or %NULL - - - - - - Returns if the daemon supports getting the wakeup data. - - %TRUE if supported - - - - - a #UpWakeups instance. - - - - - - Gets properties from the daemon about wakeup data. - - %TRUE if supported - - - - - a #UpWakeups instance. - - - - a #GCancellable or %NULL - - - - - - Gets the the total number of wakeups per second from the daemon. - - number of wakeups per second. - - - - - a #UpWakeups instance. - - - - a #GCancellable or %NULL - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Abstract interface type for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower-Wakeups.top_of_page">org.freedesktop.UPower.Wakeups</link>. - - Gets a machine-readable description of the <link linkend="gdbus-interface-org-freedesktop-UPower-Wakeups.top_of_page">org.freedesktop.UPower.Wakeups</link> D-Bus interface. - - A #GDBusInterfaceInfo. Do not free. - - - - - Overrides all #GObject properties in the #UpWakeupsGlue interface for a concrete class. -The properties are overridden in the order they are defined. - - The last property id. - - - - - The class structure for a #GObject<!-- -->-derived class. - - - - The property id to assign to the first overridden property. - - - - - - - - - - - - - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Wakeups.HasCapability">"HasCapability"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. - - The property value. - - - - - A #UpWakeupsGlue. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower-Wakeups.GetData">GetData()</link> D-Bus method on @proxy. -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_wakeups_glue_call_get_data_finish() to get the result of the operation. - -See up_wakeups_glue_call_get_data_sync() for the synchronous, blocking version of this method. - - - - - - A #UpWakeupsGlueProxy. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied or %NULL. - - - - User data to pass to @callback. - - - - - - Finishes an operation started with up_wakeups_glue_call_get_data(). - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpWakeupsGlueProxy. - - - - Return location for return parameter or %NULL to ignore. - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_wakeups_glue_call_get_data(). - - - - - - Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower-Wakeups.GetData">GetData()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. - -See up_wakeups_glue_call_get_data() for the asynchronous version of this method. - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpWakeupsGlueProxy. - - - - Return location for return parameter or %NULL to ignore. - - - - A #GCancellable or %NULL. - - - - - - Asynchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower-Wakeups.GetTotal">GetTotal()</link> D-Bus method on @proxy. -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_wakeups_glue_call_get_total_finish() to get the result of the operation. - -See up_wakeups_glue_call_get_total_sync() for the synchronous, blocking version of this method. - - - - - - A #UpWakeupsGlueProxy. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied or %NULL. - - - - User data to pass to @callback. - - - - - - Finishes an operation started with up_wakeups_glue_call_get_total(). - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpWakeupsGlueProxy. - - - - Return location for return parameter or %NULL to ignore. - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_wakeups_glue_call_get_total(). - - - - - - Synchronously invokes the <link linkend="gdbus-method-org-freedesktop-UPower-Wakeups.GetTotal">GetTotal()</link> D-Bus method on @proxy. The calling thread is blocked until a reply is received. - -See up_wakeups_glue_call_get_total() for the asynchronous version of this method. - - %TRUE if the call succeded, %FALSE if @error is set. - - - - - A #UpWakeupsGlueProxy. - - - - Return location for return parameter or %NULL to ignore. - - - - A #GCancellable or %NULL. - - - - - - Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-UPower-Wakeups.GetData">GetData()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. - -This method will free @invocation, you cannot use it afterwards. - - + + The device state. + + + + + + + + + + + + + + + + + + + + The device technology. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + a new UpHistoryItem object. + - - - A #UpWakeupsGlue. - - - - A #GDBusMethodInvocation. - - - - Parameter to return. - - - - - - Helper function used in service implementations to finish handling invocations of the <link linkend="gdbus-method-org-freedesktop-UPower-Wakeups.GetTotal">GetTotal()</link> D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar. - -This method will free @invocation, you cannot use it afterwards. + + + Gets the item state. + - + - - A #UpWakeupsGlue. - + + #UpHistoryItem + - - A #GDBusMethodInvocation. - - - - Parameter to return. - - - - Emits the <link linkend="gdbus-signal-org-freedesktop-UPower-Wakeups.DataChanged">"DataChanged"</link> D-Bus signal. + + Gets the item time. + - + - - A #UpWakeupsGlue. - + + #UpHistoryItem + - - Emits the <link linkend="gdbus-signal-org-freedesktop-UPower-Wakeups.TotalChanged">"TotalChanged"</link> D-Bus signal. + + Gets the item value. + - + - - A #UpWakeupsGlue. - + + #UpHistoryItem + - - Argument to pass with the signal. - - - - Gets the value of the <link linkend="gdbus-property-org-freedesktop-UPower-Wakeups.HasCapability">"HasCapability"</link> D-Bus property. - -Since this D-Bus property is readable, it is meaningful to use this function on both the client- and service-side. + + Converts the history item to a string representation. + - The property value. - - A #UpWakeupsGlue. - - - - - - Sets the <link linkend="gdbus-property-org-freedesktop-UPower-Wakeups.HasCapability">"HasCapability"</link> D-Bus property to @value. - -Since this D-Bus property is not writable, it is only meaningful to use this function on the service-side. - - - - - - A #UpWakeupsGlue. - + + #UpHistoryItem + - - The value to set. - + + - - Represents the D-Bus property <link linkend="gdbus-property-org-freedesktop-UPower-Wakeups.HasCapability">"HasCapability"</link>. - -Since the D-Bus property for this #GObject property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side. - - - - On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-freedesktop-UPower-Wakeups.DataChanged">"DataChanged"</link> is received. - -On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. - - - - - - Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-UPower-Wakeups.GetData">GetData()</link> D-Bus method. - -If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call up_wakeups_glue_complete_get_data() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. - - %TRUE if the invocation was handled, %FALSE to let other signal handlers run. - - - - - A #GDBusMethodInvocation. - - - - - - Signal emitted when a remote caller is invoking the <link linkend="gdbus-method-org-freedesktop-UPower-Wakeups.GetTotal">GetTotal()</link> D-Bus method. - -If a signal handler returns %TRUE, it means the signal handler will handle the invocation (e.g. take a reference to @invocation and eventually call up_wakeups_glue_complete_get_total() or e.g. g_dbus_method_invocation_return_error() on it) and no order signal handlers will run. If no signal handler handles the invocation, the %G_DBUS_ERROR_UNKNOWN_METHOD error is returned. - - %TRUE if the invocation was handled, %FALSE to let other signal handlers run. - - - - - A #GDBusMethodInvocation. - - - - - - On the client-side, this signal is emitted whenever the D-Bus signal <link linkend="gdbus-signal-org-freedesktop-UPower-Wakeups.TotalChanged">"TotalChanged"</link> is received. - -On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal. + + Sets the item state. + - - Argument. - - - - - - - Virtual table for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower-Wakeups.top_of_page">org.freedesktop.UPower.Wakeups</link>. - - The parent interface. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The property value. - - - - - A #UpWakeupsGlue. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The #UpWakeupsGlueProxy structure contains only private data and should only be accessed using the provided API. - - - - - - Finishes an operation started with up_wakeups_glue_proxy_new(). - - The constructed proxy object or %NULL if @error is set. - - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_wakeups_glue_proxy_new(). - - - - - - Finishes an operation started with up_wakeups_glue_proxy_new_for_bus(). - - The constructed proxy object or %NULL if @error is set. - - - - - The #GAsyncResult obtained from the #GAsyncReadyCallback passed to up_wakeups_glue_proxy_new_for_bus(). - - - - - - Like up_wakeups_glue_proxy_new_sync() but takes a #GBusType instead of a #GDBusConnection. - -The calling thread is blocked until a reply is received. - -See up_wakeups_glue_proxy_new_for_bus() for the asynchronous version of this constructor. - - The constructed proxy object or %NULL if @error is set. - - - - - A #GBusType. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique). - - - - An object path. - - - - A #GCancellable or %NULL. - - - - - - Synchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower-Wakeups.top_of_page">org.freedesktop.UPower.Wakeups</link>. See g_dbus_proxy_new_sync() for more details. - -The calling thread is blocked until a reply is received. - -See up_wakeups_glue_proxy_new() for the asynchronous version of this constructor. - - The constructed proxy object or %NULL if @error is set. - - - - - A #GDBusConnection. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. - - - - An object path. - - - - A #GCancellable or %NULL. - + + #UpHistoryItem + + + + the new value + - - - Asynchronously creates a proxy for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower-Wakeups.top_of_page">org.freedesktop.UPower.Wakeups</link>. See g_dbus_proxy_new() for more details. - -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_wakeups_glue_proxy_new_finish() to get the result of the operation. - -See up_wakeups_glue_proxy_new_sync() for the synchronous, blocking version of this constructor. + + + Sets the item time. + - - A #GDBusConnection. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique) or %NULL if @connection is not a message bus connection. - - - - An object path. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied. - - - - User data to pass to @callback. - + + #UpHistoryItem + + + + the new value + - - - Like up_wakeups_glue_proxy_new() but takes a #GBusType instead of a #GDBusConnection. - -When the operation is finished, @callback will be invoked in the <link linkend="g-main-context-push-thread-default">thread-default main loop</link> of the thread you are calling this method from. -You can then call up_wakeups_glue_proxy_new_for_bus_finish() to get the result of the operation. - -See up_wakeups_glue_proxy_new_for_bus_sync() for the synchronous, blocking version of this constructor. + + + Sets the item time to the present value. + - - A #GBusType. - - - - Flags from the #GDBusProxyFlags enumeration. - - - - A bus name (well-known or unique). - - - - An object path. - - - - A #GCancellable or %NULL. - - - - A #GAsyncReadyCallback to call when the request is satisfied. - - - - User data to pass to @callback. - + + #UpHistoryItem + + + + + + Sets the item value. + + + + + + + #UpHistoryItem + + + + the new value + - - - - - - - - - - Class structure for #UpWakeupsGlueProxy. - - The parent class. - - - - - - - The #UpWakeupsGlueSkeleton structure contains only private data and should only be accessed using the provided API. - - - - Creates a skeleton object for the D-Bus interface <link linkend="gdbus-interface-org-freedesktop-UPower-Wakeups.top_of_page">org.freedesktop.UPower.Wakeups</link>. + + + Converts the history item to a string representation. + - The skeleton object. - + - - - + + + #UpHistoryItem + + + + + + + + + + + + + + + - - + + - - Class structure for #UpWakeupsGlueSkeleton. + + - The parent class. - + - - - + + - - Gets a machine-readable description of the <link linkend="gdbus-interface-org-freedesktop-UPower.top_of_page">org.freedesktop.UPower</link> D-Bus interface. - - A #GDBusInterfaceInfo. Do not free. - - - - - Overrides all #GObject properties in the #UpClientGlue interface for a concrete class. -The properties are overridden in the order they are defined. - - The last property id. - - + + - - The class structure for a #GObject<!-- -->-derived class. - + - - The property id to assign to the first overridden property. - + + + + + + - - - Gets a machine-readable description of the <link linkend="gdbus-interface-org-freedesktop-UPower-Device.top_of_page">org.freedesktop.UPower.Device</link> D-Bus interface. - - A #GDBusInterfaceInfo. Do not free. - - - - - Overrides all #GObject properties in the #UpDeviceGlue interface for a concrete class. -The properties are overridden in the order they are defined. - - The last property id. - - + + + - - The class structure for a #GObject<!-- -->-derived class. - + - - The property id to assign to the first overridden property. - + + + + + + - - - Gets a machine-readable description of the <link linkend="gdbus-interface-org-freedesktop-UPower-Wakeups.top_of_page">org.freedesktop.UPower.Wakeups</link> D-Bus interface. - - A #GDBusInterfaceInfo. Do not free. - - - - - Overrides all #GObject properties in the #UpWakeupsGlue interface for a concrete class. -The properties are overridden in the order they are defined. - - The last property id. - - + + + - - The class structure for a #GObject<!-- -->-derived class. - + - - The property id to assign to the first overridden property. - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The compile-time micro version + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + a new UpStatsItem object. + + + + + Gets the item accuracy. + + + + + + + + + + + + Gets the item value. + + + + + + + + + + + + Sets the item accuracy. + + + + + + + + + + + + + + + Sets the item value. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + A helper GObject to use for accessing UPower information, and to be notified +when it is changed. + + + A helper GObject to use for accessing UPower devices, and to be notified +when it is changed. + + + This object represents one item of data which may be returned from the +daemon in response to a query. + + + This object represents one item of data which may be returned from the +daemon in response to a query. + + + These helper functions provide a way to marshal enumerated values to +text and back again. + + + These compile time macros allow the user to enable parts of client code +depending on the version of libupower-glib installed. + + + These objects allow client programs to trivially get details about the power +state, and about devices on the system. + diff --git a/girs/UnityExtras-7.0.gir b/girs/UnityExtras-7.0.gir index ced1efa5a..8ee4014c8 100644 --- a/girs/UnityExtras-7.0.gir +++ b/girs/UnityExtras-7.0.gir @@ -1,12 +1,12 @@ - + - + @@ -19,13 +19,16 @@ + + + - + - + @@ -35,6 +38,9 @@ + + + @@ -45,10 +51,13 @@ - + + + + - + @@ -58,6 +67,9 @@ + + + @@ -68,10 +80,13 @@ - + + + + - + @@ -81,6 +96,9 @@ + + + @@ -91,10 +109,13 @@ - + + + + - + @@ -104,6 +125,9 @@ + + + @@ -114,10 +138,13 @@ - + + + + - + @@ -127,6 +154,9 @@ + + + @@ -137,10 +167,13 @@ - + + + + - + @@ -150,6 +183,9 @@ + + + @@ -160,13 +196,16 @@ + + + - + - + @@ -179,6 +218,9 @@ + + + @@ -198,7 +240,7 @@ - + @@ -225,10 +267,10 @@ - + - + @@ -254,7 +296,7 @@ - + @@ -264,7 +306,7 @@ - + diff --git a/girs/Vte-2.91.gir b/girs/Vte-2.91.gir index 172d0926d..1a3075920 100644 --- a/girs/Vte-2.91.gir +++ b/girs/Vte-2.91.gir @@ -243,16 +243,16 @@ keys. version="0.76"> Provides context information for a context menu event. + line="7487">Provides context information for a context menu event. - + the #GdkEvent that triggered the event, or %NULL if it was not + line="7510">the #GdkEvent that triggered the event, or %NULL if it was not triggered by an event @@ -260,7 +260,7 @@ keys. the #VteEventContext + line="7508">the #VteEventContext @@ -373,7 +373,7 @@ should be copied to the clipboard in. - + The micro version number of the VTE library @@ -1921,23 +1921,6 @@ selection. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -2263,7 +2224,7 @@ regexes in @regexes. You must free each string and the array; but note that this is *not* a %NULL-terminated string array, and so you must *not* use g_strfreev() on it. - + - + Checks whether or not hyperlinks (OSC 8 escape sequence) are allowed. - + line="5144">Checks whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact. - + the terminal's cell height scale + line="6148">the terminal's cell height scale a #VteTerminal + line="6146">a #VteTerminal @@ -2623,21 +2584,21 @@ or if SGR 1 only enables bold and leaves the color intact. the terminal's cell width scale + line="6198">the terminal's cell width scale a #VteTerminal + line="6196">a #VteTerminal - + - + (Note that when using a non-UTF-8 encoding set via vte_terminal_set_encoding(), the width of ambiguous-width characters is fixed and determined by the encoding itself.) - + version="0.54"> Returns the background colour, as used by @terminal when + line="7097">Returns the background colour, as used by @terminal when drawing the background, which may be different from the color set by vte_terminal_set_color_background(). @@ -2716,7 +2677,7 @@ GtkWidget::draw signal. This function is rarely useful. One use for it is if you disable drawing the background (see vte_terminal_set_clear_background()) and then need to draw the background yourself. - + @@ -2724,7 +2685,7 @@ and then need to draw the background yourself. a #VteTerminal + line="7099">a #VteTerminal transfer-ownership="none"> a location to store a #GdkRGBA color + line="7100">a location to store a #GdkRGBA color - + glib:get-property="context-menu" version="0.76"> - + the context menu, or %NULL + line="7469">the context menu, or %NULL a #VteTerminal + line="7467">a #VteTerminal @@ -2783,18 +2744,18 @@ and then need to draw the background yourself. version="0.76"> - + the context menu model, or %NULL + line="7414">the context menu model, or %NULL a #VteTerminal + line="7412">a #VteTerminal @@ -2802,11 +2763,11 @@ and then need to draw the background yourself. - + the name of the current + line="5585">the name of the current container, or %NULL @@ -2814,7 +2775,7 @@ and then need to draw the background yourself. a #VteTerminal + line="5583">a #VteTerminal @@ -2822,11 +2783,11 @@ and then need to draw the background yourself. - + the name of the runtime + line="5610">the name of the runtime toolset used to set up the current container, or %NULL @@ -2834,7 +2795,7 @@ and then need to draw the background yourself. a #VteTerminal + line="5608">a #VteTerminal @@ -2842,11 +2803,11 @@ and then need to draw the background yourself. - + the URI of the current directory of the + line="5635">the URI of the current directory of the process running in the terminal, or %NULL @@ -2854,7 +2815,7 @@ and then need to draw the background yourself. a #VteTerminal + line="5633">a #VteTerminal @@ -2862,11 +2823,11 @@ and then need to draw the background yourself. - + the URI of the current file the + line="5656">the URI of the current file the process running in the terminal is operating on, or %NULL if not set @@ -2875,7 +2836,7 @@ and then need to draw the background yourself. a #VteTerminal + line="5654">a #VteTerminal @@ -2885,19 +2846,19 @@ and then need to draw the background yourself. glib:get-property="cursor-blink-mode"> Returns the currently set cursor blink mode. + line="5674">Returns the currently set cursor blink mode. cursor blink mode. + line="5680">cursor blink mode. a #VteTerminal + line="5676">a #VteTerminal @@ -2910,7 +2871,7 @@ and then need to draw the background yourself. coordinate is absolute. This method is unaware of BiDi. The returned column is logical column. - + @@ -2950,19 +2911,19 @@ This method is unaware of BiDi. The returned column is logical column. glib:get-property="cursor-shape"> Returns the currently set cursor shape. + line="5720">Returns the currently set cursor shape. cursor shape. + line="5726">cursor shape. a #VteTerminal + line="5722">a #VteTerminal @@ -2973,19 +2934,19 @@ This method is unaware of BiDi. The returned column is logical column. version="0.78"> Checks whether the terminal communicates with a11y backends - + line="5790">Checks whether the terminal communicates with a11y backends + %TRUE if a11y is enabled, %FALSE if not + line="5796">%TRUE if a11y is enabled, %FALSE if not a #VteTerminal + line="5792">a #VteTerminal @@ -2996,19 +2957,19 @@ This method is unaware of BiDi. The returned column is logical column. version="0.58"> Checks whether the terminal performs bidirectional text rendering. - + line="5837">Checks whether the terminal performs bidirectional text rendering. + %TRUE if BiDi is enabled, %FALSE if not + line="5843">%TRUE if BiDi is enabled, %FALSE if not a #VteTerminal + line="5839">a #VteTerminal @@ -3021,14 +2982,14 @@ This method is unaware of BiDi. The returned column is logical column. %TRUE if fallback scrolling is enabled + line="6885">%TRUE if fallback scrolling is enabled a #VteTerminal + line="6883">a #VteTerminal @@ -3039,19 +3000,19 @@ This method is unaware of BiDi. The returned column is logical column. version="0.58"> Checks whether the terminal shapes Arabic text. - + line="5884">Checks whether the terminal shapes Arabic text. + %TRUE if Arabic shaping is enabled, %FALSE if not + line="5890">%TRUE if Arabic shaping is enabled, %FALSE if not a #VteTerminal + line="5886">a #VteTerminal @@ -3060,18 +3021,18 @@ This method is unaware of BiDi. The returned column is logical column. c:identifier="vte_terminal_get_enable_sixel" glib:get-property="enable-sixel" version="0.62"> - + %FALSE + line="7161">%FALSE a #VteTerminal + line="7159">a #VteTerminal @@ -3083,21 +3044,21 @@ This method is unaware of BiDi. The returned column is logical column. deprecated-version="0.54"> Determines the name of the encoding in which the terminal expects data to be + line="5931">Determines the name of the encoding in which the terminal expects data to be encoded, or %NULL if UTF-8 is in use. Support for non-UTF-8 is deprecated. the current encoding for the terminal + line="5938">the current encoding for the terminal a #VteTerminal + line="5933">a #VteTerminal @@ -3105,15 +3066,15 @@ encoded, or %NULL if UTF-8 is in use. Queries the terminal for information about the fonts which will be + line="5998">Queries the terminal for information about the fonts which will be used to draw text in the terminal. The actual font takes the font scale into account, this is not reflected in the return value, the unscaled font is returned. - + a #PangoFontDescription describing the font the + line="6007">a #PangoFontDescription describing the font the terminal uses to render text at the default font scale of 1.0. @@ -3122,7 +3083,7 @@ terminal uses to render text at the default font scale of 1.0. a #VteTerminal + line="6000">a #VteTerminal @@ -3135,14 +3096,14 @@ terminal uses to render text at the default font scale of 1.0. the terminal's font options, or %NULL + line="6054">the terminal's font options, or %NULL a #VteTerminal + line="6052">a #VteTerminal @@ -3154,14 +3115,14 @@ terminal uses to render text at the default font scale of 1.0. the terminal's font scale + line="6105">the terminal's font scale a #VteTerminal + line="6103">a #VteTerminal @@ -3172,7 +3133,7 @@ terminal uses to render text at the default font scale of 1.0. deprecated-version="0.52"> Fills in some @hints from @terminal's geometry. The hints + line="6250">Fills in some @hints from @terminal's geometry. The hints filled are those covered by the %GDK_HINT_RESIZE_INC, %GDK_HINT_MIN_SIZE and %GDK_HINT_BASE_SIZE flags. @@ -3187,7 +3148,7 @@ See gtk_window_set_geometry_hints() for more information. a #VteTerminal + line="6252">a #VteTerminal a #GdkGeometry to fill in + line="6253">a #GdkGeometry to fill in the minimum number of rows to request + line="6254">the minimum number of rows to request the minimum number of columns to request + line="6255">the minimum number of columns to request @@ -3217,21 +3178,21 @@ See gtk_window_set_geometry_hints() for more information. c:identifier="vte_terminal_get_has_selection"> Checks if the terminal currently contains selected text. Note that this + line="6338">Checks if the terminal currently contains selected text. Note that this is different from determining if the terminal is the owner of any #GtkClipboard items. - + %TRUE if part of the text in the terminal is selected. + line="6346">%TRUE if part of the text in the terminal is selected. a #VteTerminal + line="6340">a #VteTerminal @@ -3245,14 +3206,14 @@ is different from determining if the terminal is the owner of any %NULL + line="6432">%NULL a #VteTerminal + line="6430">a #VteTerminal @@ -3262,8 +3223,8 @@ is different from determining if the terminal is the owner of any glib:get-property="input-enabled"> Returns whether the terminal allow user input. - + line="6442">Returns whether the terminal allow user input. + @@ -3271,7 +3232,7 @@ is different from determining if the terminal is the owner of any a #VteTerminal + line="6444">a #VteTerminal @@ -3280,22 +3241,22 @@ is different from determining if the terminal is the owner of any c:identifier="vte_terminal_get_mouse_autohide"> Determines the value of the terminal's mouse autohide setting. When + line="6486">Determines the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse. This setting can be changed using vte_terminal_set_mouse_autohide(). - + %TRUE if autohiding is enabled, %FALSE if not + line="6495">%TRUE if autohiding is enabled, %FALSE if not a #VteTerminal + line="6488">a #VteTerminal @@ -3305,19 +3266,19 @@ using vte_terminal_set_mouse_autohide(). glib:get-property="pty"> Returns the #VtePty of @terminal. - + line="6561">Returns the #VtePty of @terminal. + a #VtePty, or %NULL + line="6567">a #VtePty, or %NULL a #VteTerminal + line="6563">a #VteTerminal @@ -3329,36 +3290,36 @@ using vte_terminal_set_mouse_autohide(). deprecated-version="0.58"> Checks whether or not the terminal will rewrap its contents upon resize. + line="6582">Checks whether or not the terminal will rewrap its contents upon resize. %TRUE if rewrapping is enabled, %FALSE if not + line="6588">%TRUE if rewrapping is enabled, %FALSE if not a #VteTerminal + line="6584">a #VteTerminal - + the number of rows + line="6635">the number of rows a #VteTerminal + line="6632">a #VteTerminal @@ -3371,7 +3332,7 @@ using vte_terminal_set_mouse_autohide(). whether or not the terminal will forcibly scroll to the bottom of + line="6737">whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child. @@ -3379,7 +3340,7 @@ the viewable history when the new data is received from the child. a #VteTerminal + line="6735">a #VteTerminal @@ -3392,7 +3353,7 @@ the viewable history when the new data is received from the child. whether or not the terminal will forcibly scroll to the bottom of + line="6786">whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior. @@ -3401,7 +3362,7 @@ trigger this behavior. a #VteTerminal + line="6784">a #VteTerminal @@ -3414,7 +3375,7 @@ trigger this behavior. whether or not the terminal will forcibly scroll to the bottom of + line="6834">whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child. @@ -3422,7 +3383,7 @@ the viewable history when the new data is received from the child. a #VteTerminal + line="6832">a #VteTerminal @@ -3435,14 +3396,14 @@ the viewable history when the new data is received from the child. %TRUE if the scroll unit is pixels; or %FALSE if the unit is lines + line="6933">%TRUE if the scroll unit is pixels; or %FALSE if the unit is lines a #VteTerminal + line="6931">a #VteTerminal @@ -3451,11 +3412,11 @@ the viewable history when the new data is received from the child. c:identifier="vte_terminal_get_scrollback_lines" glib:get-property="scrollback-lines" version="0.52"> - + length of the scrollback buffer used by the terminal. + line="6690">length of the scrollback buffer used by the terminal. A negative value means "infinite scrollback". @@ -3463,7 +3424,7 @@ A negative value means "infinite scrollback". a #VteTerminal + line="6688">a #VteTerminal @@ -3565,7 +3526,7 @@ Since 0.72, passing a non-%NULL @is_selected parameter will make this function i This method is unaware of BiDi. The columns returned in @attributes are logical columns. - + Returns the specified range of text in the specified format. - + Gets the currently selected text in the format specified by @format. + line="6361">Gets the currently selected text in the format specified by @format. Since 0.72, this function also supports %VTE_FORMAT_HTML format. - + a newly allocated string containing the selected text, or %NULL if there is no selection or the format is not supported + line="6369">a newly allocated string containing the selected text, or %NULL if there is no selection or the format is not supported a #VteTerminal + line="6363">a #VteTerminal the #VteFormat to use + line="6364">the #VteFormat to use @@ -3842,25 +3803,25 @@ Since 0.72, this function also supports %VTE_FORMAT_HTML format. version="0.72"> Gets the currently selected text in the format specified by @format. - + line="6388">Gets the currently selected text in the format specified by @format. + a newly allocated string containing the selected text, or %NULL if there is no selection or the format is not supported + line="6396">a newly allocated string containing the selected text, or %NULL if there is no selection or the format is not supported a #VteTerminal + line="6390">a #VteTerminal the #VteFormat to use + line="6391">the #VteFormat to use allow-none="1"> a pointer to a #gsize to store the string length + line="6392">a pointer to a #gsize to store the string length @@ -3879,18 +3840,18 @@ Since 0.72, this function also supports %VTE_FORMAT_HTML format. - + the window title, or %NULL + line="6954">the window title, or %NULL a #VteTerminal + line="6952">a #VteTerminal @@ -3901,7 +3862,7 @@ Since 0.72, this function also supports %VTE_FORMAT_HTML format. version="0.40"> Returns the set of characters which will be considered parts of a word + line="6969">Returns the set of characters which will be considered parts of a word when doing word-wise selection, in addition to the default which only considers alphanumeric characters part of a word. @@ -3910,14 +3871,14 @@ If %NULL, a built-in set is used. a string, or %NULL + line="6979">a string, or %NULL a #VteTerminal + line="6971">a #VteTerminal @@ -3926,18 +3887,18 @@ If %NULL, a built-in set is used. c:identifier="vte_terminal_get_xalign" glib:get-property="xalign" version="0.76"> - + the horizontal alignment of @terminal within its allocation + line="7222">the horizontal alignment of @terminal within its allocation a #VteTerminal + line="7220">a #VteTerminal @@ -3946,18 +3907,18 @@ If %NULL, a built-in set is used. c:identifier="vte_terminal_get_xfill" glib:get-property="xfill" version="0.76"> - + the horizontal fillment of @terminal within its allocation + line="7318">the horizontal fillment of @terminal within its allocation a #VteTerminal + line="7316">a #VteTerminal @@ -3966,18 +3927,18 @@ If %NULL, a built-in set is used. c:identifier="vte_terminal_get_yalign" glib:get-property="yalign" version="0.76"> - + the vertical alignment of @terminal within its allocation + line="7269">the vertical alignment of @terminal within its allocation a #VteTerminal + line="7267">a #VteTerminal @@ -3986,18 +3947,18 @@ If %NULL, a built-in set is used. c:identifier="vte_terminal_get_yfill" glib:get-property="yfill" version="0.76"> - + the vertical fillment of @terminal within its allocation + line="7366">the vertical fillment of @terminal within its allocation a #VteTerminal + line="7364">a #VteTerminal @@ -4013,7 +3974,7 @@ escape sequence) at the position of the event, or %NULL. Proper use of the escape sequence should result in URI-encoded URIs with a proper scheme like "http://", "https://", "file://", "mailto:" etc. This is, however, not enforced by VTE. The caller must tolerate the returned string potentially not being a valid URI. - + - + - + line="3760">Removes the regular expression which is associated with the given @tag from the list of expressions which the terminal will highlight when the user moves the mouse cursor over matching text. - + @@ -4243,7 +4204,7 @@ moves the mouse cursor over matching text. filename="src/vtegtk.cc" line="3782">Clears the list of regular expressions the terminal uses to highlight text when the user moves the mouse cursor. - + @@ -4300,7 +4261,7 @@ specified by @tag. The terminal keeps a reference to @cursor. filename="src/vtegtk.cc" line="3735">Sets which cursor the terminal will use if the pointer is over the pattern specified by @tag. - + @@ -4474,7 +4435,7 @@ See vte_pty_new() for more information. unprocessed input data, resetting character attributes, cursor state, national character set state, status line, terminal modes (insert/delete), selection state, and encoding. - + @@ -4505,7 +4466,7 @@ selection state, and encoding. filename="src/vtegtk.cc" line="3823">Searches the next string matching the search regex set with vte_terminal_search_set_regex(). - + filename="src/vtegtk.cc" line="3801">Searches the previous string matching the search regex set with vte_terminal_search_set_regex(). - + - + - + Note that @regex should have been created using the <literal>PCRE2_MULTILINE</literal> flag. - + @@ -4680,7 +4641,7 @@ Note that @regex should have been created using the filename="src/vtegtk.cc" line="3934">Sets whether search should wrap around to the beginning of the terminal content when reaching its end. - + @@ -4752,7 +4713,7 @@ by using a bold font variant. Controls whether or not hyperlinks (OSC 8 escape sequence) are allowed. - + @@ -4805,7 +4766,7 @@ by using a bold font variant. line="5119">Modifies the terminal's backspace key binding, which controls what string or control sequence the terminal sends to its child when the user presses the backspace key. - + @@ -4833,7 +4794,7 @@ presses the backspace key. line="5169">Sets whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact. - + @@ -4858,7 +4819,7 @@ or if SGR 1 only enables bold and leaves the color intact. version="0.52"> Sets the terminal's cell height scale to @scale. + line="6166">Sets the terminal's cell height scale to @scale. This can be used to increase the line spacing. (The font's height is not affected.) Valid values go from 1.0 (default) to 2.0 ("double spacing"). @@ -4870,13 +4831,13 @@ Valid values go from 1.0 (default) to 2.0 ("double spacing"). a #VteTerminal + line="6168">a #VteTerminal the cell height scale + line="6169">the cell height scale @@ -4887,7 +4848,7 @@ Valid values go from 1.0 (default) to 2.0 ("double spacing"). version="0.52"> Sets the terminal's cell width scale to @scale. + line="6216">Sets the terminal's cell width scale to @scale. This can be used to increase the letter spacing. (The font's width is not affected.) Valid values go from 1.0 (default) to 2.0. @@ -4899,13 +4860,13 @@ Valid values go from 1.0 (default) to 2.0. a #VteTerminal + line="6218">a #VteTerminal the cell width scale + line="6219">the cell width scale @@ -4919,7 +4880,7 @@ Valid values go from 1.0 (default) to 2.0. (Note that when using a non-UTF-8 encoding set via vte_terminal_set_encoding(), the width of ambiguous-width characters is fixed and determined by the encoding itself.) - + @@ -4943,12 +4904,12 @@ itself.) version="0.52"> Sets whether to paint the background with the background colour. + line="7070">Sets whether to paint the background with the background colour. The default is %TRUE. This function is rarely useful. One use for it is to add a background image to the terminal. - + @@ -4956,13 +4917,13 @@ image to the terminal. a #VteTerminal + line="7072">a #VteTerminal whether to clear the background + line="7073">whether to clear the background @@ -5230,12 +5191,12 @@ greater than 0, the new background color is taken from @palette[0]. Sets @menu as the context menu in @terminal. + line="7432">Sets @menu as the context menu in @terminal. Use %NULL to unset the current menu. Note that a menu model set with vte_terminal_set_context_menu_model() takes precedence over a menu set using this function. - + @@ -5243,7 +5204,7 @@ takes precedence over a menu set using this function. a #VteTerminal + line="7434">a #VteTerminal allow-none="1"> a menu + line="7435">a menu @@ -5265,9 +5226,9 @@ takes precedence over a menu set using this function. value="context-menu-model"/> Sets @model as the context menu model in @terminal. + line="7384">Sets @model as the context menu model in @terminal. Use %NULL to unset the current menu model. - + @@ -5275,7 +5236,7 @@ Use %NULL to unset the current menu model. a #VteTerminal + line="7386">a #VteTerminal allow-none="1"> a #GMenuModel + line="7387">a #GMenuModel @@ -5294,7 +5255,7 @@ Use %NULL to unset the current menu model. glib:set-property="cursor-blink-mode"> Sets whether or not the cursor will blink. Using %VTE_CURSOR_BLINK_SYSTEM + line="5696">Sets whether or not the cursor will blink. Using %VTE_CURSOR_BLINK_SYSTEM will use the #GtkSettings::gtk-cursor-blink setting. @@ -5304,13 +5265,13 @@ will use the #GtkSettings::gtk-cursor-blink setting. a #VteTerminal + line="5698">a #VteTerminal the #VteCursorBlinkMode to use + line="5699">the #VteCursorBlinkMode to use @@ -5320,7 +5281,7 @@ will use the #GtkSettings::gtk-cursor-blink setting. glib:set-property="cursor-shape"> Sets the shape of the cursor drawn. + line="5742">Sets the shape of the cursor drawn. @@ -5329,13 +5290,13 @@ will use the #GtkSettings::gtk-cursor-blink setting. a #VteTerminal + line="5744">a #VteTerminal the #VteCursorShape to use + line="5745">the #VteCursorShape to use @@ -5363,10 +5324,10 @@ will use the #GtkSettings::gtk-cursor-blink setting. glib:set-property="delete-binding"> Modifies the terminal's delete key binding, which controls what + line="5765">Modifies the terminal's delete key binding, which controls what string or control sequence the terminal sends to its child when the user presses the delete key. - + @@ -5374,13 +5335,13 @@ presses the delete key. a #VteTerminal + line="5767">a #VteTerminal a #VteEraseBinding for the delete key + line="5768">a #VteEraseBinding for the delete key @@ -5391,8 +5352,8 @@ presses the delete key. version="0.78"> Controls whether or not the terminal will communicate with a11y backends. - + line="5813">Controls whether or not the terminal will communicate with a11y backends. + @@ -5400,13 +5361,13 @@ presses the delete key. a #VteTerminal + line="5815">a #VteTerminal %TRUE to enable a11y support + line="5816">%TRUE to enable a11y support @@ -5417,8 +5378,8 @@ presses the delete key. version="0.58"> Controls whether or not the terminal will perform bidirectional text rendering. - + line="5860">Controls whether or not the terminal will perform bidirectional text rendering. + @@ -5426,13 +5387,13 @@ presses the delete key. a #VteTerminal + line="5862">a #VteTerminal %TRUE to enable BiDi support + line="5863">%TRUE to enable BiDi support @@ -5443,7 +5404,7 @@ presses the delete key. version="0.64"> Controls whether the terminal uses scroll events to scroll the history + line="6852">Controls whether the terminal uses scroll events to scroll the history if the event was not otherwise consumed by it. This function is rarely useful, except when the terminal is added to a @@ -5457,13 +5418,13 @@ not, yet, implement kinetic scrolling by itself). a #VteTerminal + line="6854">a #VteTerminal whether to enable fallback scrolling + line="6855">whether to enable fallback scrolling @@ -5474,8 +5435,8 @@ not, yet, implement kinetic scrolling by itself). version="0.58"> Controls whether or not the terminal will shape Arabic text. - + line="5907">Controls whether or not the terminal will shape Arabic text. + @@ -5483,13 +5444,13 @@ not, yet, implement kinetic scrolling by itself). a #VteTerminal + line="5909">a #VteTerminal %TRUE to enable Arabic shaping + line="5910">%TRUE to enable Arabic shaping @@ -5500,8 +5461,8 @@ not, yet, implement kinetic scrolling by itself). version="0.62"> Set whether to enable SIXEL images. - + line="7136">Set whether to enable SIXEL images. + @@ -5509,13 +5470,13 @@ not, yet, implement kinetic scrolling by itself). a #VteTerminal + line="7138">a #VteTerminal whether to enable SIXEL images + line="7139">whether to enable SIXEL images @@ -5528,7 +5489,7 @@ not, yet, implement kinetic scrolling by itself). throws="1"> Changes the encoding the terminal will expect data from the child to + line="5955">Changes the encoding the terminal will expect data from the child to be encoded with. For certain terminal types, applications executing in the terminal can change the encoding. If @codeset is %NULL, it uses "UTF-8". @@ -5540,7 +5501,7 @@ spawning the child process. %TRUE if the encoding could be changed to the specified one, + line="5969">%TRUE if the encoding could be changed to the specified one, or %FALSE with @error set to %G_CONVERT_ERROR_NO_CONVERSION. @@ -5548,7 +5509,7 @@ spawning the child process. a #VteTerminal + line="5957">a #VteTerminal allow-none="1"> target charset, or %NULL to use UTF-8 + line="5958">target charset, or %NULL to use UTF-8 @@ -5565,12 +5526,12 @@ spawning the child process. Sets the font used for rendering all text displayed by the terminal, + line="6024">Sets the font used for rendering all text displayed by the terminal, overriding any fonts set using gtk_widget_modify_font(). The terminal will immediately attempt to load the desired font, retrieve its metrics, and attempt to resize itself to keep the same number of rows and columns. The font scale is applied to the specified font. - + @@ -5578,7 +5539,7 @@ and columns. The font scale is applied to the specified font. a #VteTerminal + line="6026">a #VteTerminal allow-none="1"> a #PangoFontDescription for the desired font, or %NULL + line="6027">a #PangoFontDescription for the desired font, or %NULL @@ -5599,7 +5560,7 @@ and columns. The font scale is applied to the specified font. version="0.74"> Sets the terminal's font options to @options. + line="6072">Sets the terminal's font options to @options. Note that on GTK4, the terminal by default uses font options with %CAIRO_HINT_METRICS_ON set; to override that, use this @@ -5613,7 +5574,7 @@ function to set a #cairo_font_options_t that has a #VteTerminal + line="6074">a #VteTerminal the font options, or %NULL + line="6075">the font options, or %NULL @@ -5633,7 +5594,7 @@ function to set a #cairo_font_options_t that has glib:set-property="font-scale"> Sets the terminal's font scale to @scale. + line="6121">Sets the terminal's font scale to @scale. @@ -5642,13 +5603,13 @@ function to set a #cairo_font_options_t that has a #VteTerminal + line="6123">a #VteTerminal the font scale + line="6124">the font scale @@ -5659,7 +5620,7 @@ function to set a #cairo_font_options_t that has deprecated-version="0.52"> Sets @terminal as @window's geometry widget. See + line="6306">Sets @terminal as @window's geometry widget. See gtk_window_set_geometry_hints() for more information. @terminal must be realized (see gtk_widget_get_realized()). @@ -5671,13 +5632,13 @@ gtk_window_set_geometry_hints() for more information. a #VteTerminal + line="6308">a #VteTerminal a #GtkWindow + line="6309">a #GtkWindow @@ -5687,10 +5648,10 @@ gtk_window_set_geometry_hints() for more information. glib:set-property="input-enabled"> Enables or disables user input. When user input is disabled, + line="6462">Enables or disables user input. When user input is disabled, the terminal's child will not receive any key press, or mouse button press or motion events sent to it. - + @@ -5698,13 +5659,13 @@ press or motion events sent to it. a #VteTerminal + line="6464">a #VteTerminal whether to enable user input + line="6465">whether to enable user input @@ -5713,11 +5674,11 @@ press or motion events sent to it. c:identifier="vte_terminal_set_mouse_autohide"> Changes the value of the terminal's mouse autohide setting. When autohiding + line="6510">Changes the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse. This setting can be read using vte_terminal_get_mouse_autohide(). - + @@ -5725,13 +5686,13 @@ vte_terminal_get_mouse_autohide(). a #VteTerminal + line="6512">a #VteTerminal whether the mouse pointer should autohide + line="6513">whether the mouse pointer should autohide @@ -5741,9 +5702,9 @@ vte_terminal_get_mouse_autohide(). glib:set-property="pty"> Sets @pty as the PTY to use in @terminal. + line="6535">Sets @pty as the PTY to use in @terminal. Use %NULL to unset the PTY. - + @@ -5751,7 +5712,7 @@ Use %NULL to unset the PTY. a #VteTerminal + line="6537">a #VteTerminal allow-none="1"> a #VtePty, or %NULL + line="6538">a #VtePty, or %NULL @@ -5772,7 +5733,7 @@ Use %NULL to unset the PTY. deprecated-version="0.58"> Controls whether or not the terminal will rewrap its contents, including + line="6605">Controls whether or not the terminal will rewrap its contents, including the scrollback history, whenever the terminal's width changes. @@ -5782,13 +5743,13 @@ the scrollback history, whenever the terminal's width changes. a #VteTerminal + line="6607">a #VteTerminal %TRUE if the terminal should rewrap on resize + line="6608">%TRUE if the terminal should rewrap on resize @@ -5799,7 +5760,7 @@ the scrollback history, whenever the terminal's width changes. version="0.76"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="6708">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when text is inserted, e.g. by a paste. @@ -5809,13 +5770,13 @@ the viewable history when text is inserted, e.g. by a paste. a #VteTerminal + line="6710">a #VteTerminal whether the terminal should scroll on insert + line="6711">whether the terminal should scroll on insert @@ -5826,7 +5787,7 @@ the viewable history when text is inserted, e.g. by a paste. version="0.52"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="6756">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior. @@ -5837,13 +5798,13 @@ trigger this behavior. a #VteTerminal + line="6758">a #VteTerminal whether the terminal should scroll on keystrokes + line="6759">whether the terminal should scroll on keystrokes @@ -5854,7 +5815,7 @@ trigger this behavior. version="0.52"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="6805">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child. @@ -5864,52 +5825,24 @@ the viewable history when the new data is received from the child. a #VteTerminal + line="6807">a #VteTerminal whether the terminal should scroll on output + line="6808">whether the terminal should scroll on output - - Sets the number of lines by which the buffer is moved when -scrolling with a mouse wheel. Setting it to zero will cause the -buffer to be moved by an amount depending on the number of visible -rows the widget can display. - - - - - - - a #VteTerminal - - - - move the buffer by this number of lines while scrolling - - - - Controls whether the terminal's scroll unit is lines or pixels. + line="6902">Controls whether the terminal's scroll unit is lines or pixels. This function is rarely useful, except when the terminal is added to a #GtkScrolledWindow. @@ -5921,13 +5854,13 @@ This function is rarely useful, except when the terminal is added to a a #VteTerminal + line="6904">a #VteTerminal whether to use pixels as scroll unit + line="6905">whether to use pixels as scroll unit @@ -5937,7 +5870,7 @@ This function is rarely useful, except when the terminal is added to a glib:set-property="scrollback-lines"> Sets the length of the scrollback buffer used by the terminal. The size of + line="6650">Sets the length of the scrollback buffer used by the terminal. The size of the scrollback buffer will be set to the larger of this value and the number of visible rows the widget can display, so 0 can safely be used to disable scrollback. @@ -5949,7 +5882,7 @@ degradation or exhaustion of system resources, and is therefore not recommended. Note that this setting only affects the normal screen buffer. No scrollback is allowed on the alternate screen buffer. - + @@ -5957,13 +5890,13 @@ No scrollback is allowed on the alternate screen buffer. a #VteTerminal + line="6652">a #VteTerminal the length of the history buffer + line="6653">the length of the history buffer @@ -6029,7 +5962,7 @@ the attempt succeeds, the widget will resize itself to the proper size. version="0.40"> With this function you can provide a set of characters which will + line="6997">With this function you can provide a set of characters which will be considered parts of a word when doing word-wise selection, in addition to the default which only considers alphanumeric characters part of a word. @@ -6047,13 +5980,13 @@ Use %NULL to reset the set of exception characters to the default. a #VteTerminal + line="6999">a #VteTerminal a string of ASCII punctuation characters, or %NULL + line="7000">a string of ASCII punctuation characters, or %NULL @@ -6064,11 +5997,11 @@ Use %NULL to reset the set of exception characters to the default. version="0.76"> Sets the horizontal alignment of @terminal within its allocation. + line="7190">Sets the horizontal alignment of @terminal within its allocation. Note: %VTE_ALIGN_START_FILL is not supported, and will be treated like %VTE_ALIGN_START. - + @@ -6076,13 +6009,13 @@ Note: %VTE_ALIGN_START_FILL is not supported, and will be treated a #VteTerminal + line="7192">a #VteTerminal alignment value from #VteAlign + line="7193">alignment value from #VteAlign @@ -6093,11 +6026,11 @@ Note: %VTE_ALIGN_START_FILL is not supported, and will be treated version="0.76"> Sets the horizontal fillment of @terminal within its allocation. + line="7287">Sets the horizontal fillment of @terminal within its allocation. Note: %VTE_FILL_START_FILL is not supported, and will be treated like %VTE_FILL_START. - + @@ -6105,13 +6038,13 @@ Note: %VTE_FILL_START_FILL is not supported, and will be treated a #VteTerminal + line="7289">a #VteTerminal fillment value from #VteFill + line="7290">fillment value from #VteFill @@ -6122,8 +6055,8 @@ Note: %VTE_FILL_START_FILL is not supported, and will be treated version="0.76"> Sets the vertical alignment of @terminal within its allocation. - + line="7240">Sets the vertical alignment of @terminal within its allocation. + @@ -6131,13 +6064,13 @@ Note: %VTE_FILL_START_FILL is not supported, and will be treated a #VteTerminal + line="7242">a #VteTerminal alignment value from #VteAlign + line="7243">alignment value from #VteAlign @@ -6148,10 +6081,10 @@ Note: %VTE_FILL_START_FILL is not supported, and will be treated version="0.76"> Sets the vertical fillment of @terminal within its allocation. + line="7336">Sets the vertical fillment of @terminal within its allocation. Note that yfill is only supported with yalign set to %VTE_ALIGN_START, and is ignored for all other yalign values. - + @@ -6159,13 +6092,13 @@ Note that yfill is only supported with yalign set to a #VteTerminal + line="7338">a #VteTerminal fillment value from #VteFill + line="7339">fillment value from #VteFill @@ -6706,7 +6639,7 @@ the %G_SPAWN_DO_NOT_REAP_CHILD flag MUST have been passed. throws="1"> Write contents of the current contents of @terminal (including any + line="7031">Write contents of the current contents of @terminal (including any scrollback history) to @stream according to @flags. If @cancellable is not %NULL, then the operation can be cancelled by triggering @@ -6716,30 +6649,30 @@ the error %G_IO_ERROR_CANCELLED will be returned in @error. This is a synchronous operation and will make the widget (and input processing) during the write operation, which may take a long time depending on scrollback history and @stream availability for writing. - + %TRUE on success, %FALSE if there was an error + line="7050">%TRUE on success, %FALSE if there was an error a #VteTerminal + line="7033">a #VteTerminal a #GOutputStream to write to + line="7034">a #GOutputStream to write to a set of #VteWriteFlags + line="7035">a set of #VteWriteFlags allow-none="1"> a #GCancellable object, or %NULL + line="7036">a #GCancellable object, or %NULL @@ -6763,7 +6696,7 @@ depending on scrollback history and @stream availability for writing. default-value="TRUE"> Controls whether or not the terminal will attempt to draw bold text, + line="2176">Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant. There's probably no reason for this feature to exist. @@ -6777,7 +6710,7 @@ by using a bold font variant. default-value="FALSE"> Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed. + line="2189">Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed. default-value="TRUE"> Controls whether or not the terminal will beep when the child outputs the + line="2201">Controls whether or not the terminal will beep when the child outputs the "bl" sequence. @@ -6799,7 +6732,7 @@ by using a bold font variant. default-value="VTE_ERASE_AUTO"> Controls what string or control sequence the terminal sends to its child + line="2212">Controls what string or control sequence the terminal sends to its child when the user presses the backspace key. @@ -6812,7 +6745,7 @@ when the user presses the backspace key. default-value="FALSE"> Whether the SGR 1 attribute also switches to the bright counterpart + line="2224">Whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact. @@ -6826,7 +6759,7 @@ or if SGR 1 only enables bold and leaves the color intact. default-value="1.000000"> Scale factor for the cell height, to increase line spacing. (The font's height is not affected.) + line="2238">Scale factor for the cell height, to increase line spacing. (The font's height is not affected.) default-value="1.000000"> Scale factor for the cell width, to increase letter spacing. (The font's width is not affected.) + line="2252">Scale factor for the cell width, to increase letter spacing. (The font's width is not affected.) default-value="1"> This setting controls whether ambiguous-width characters are narrow or wide. + line="2266">This setting controls whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via vte_terminal_set_encoding(), the width of ambiguous-width characters is fixed and determined by the encoding itself.) @@ -6870,7 +6803,7 @@ via escape sequence or with vte_terminal_reset(). value="vte_terminal_set_context_menu"/> The menu used for context menus. Note that context menu model set with the + line="2296">The menu used for context menus. Note that context menu model set with the #VteTerminal::context-menu-model property or vte_terminal_set_context_menu_model() takes precedence over this. @@ -6887,7 +6820,7 @@ takes precedence over this. value="vte_terminal_set_context_menu_model"/> The menu model used for context menus. If non-%NULL, the context menu is + line="2282">The menu model used for context menus. If non-%NULL, the context menu is generated from this model, and overrides a context menu set with the #VteTerminal::context-menu property or vte_terminal_set_context_menu(). @@ -6898,7 +6831,7 @@ generated from this model, and overrides a context menu set with the default-value="NULL"> The name of the current container, or %NULL if unset. + line="2626">The name of the current container, or %NULL if unset. The name of the runtime toolset used to set up the current + line="2636">The name of the runtime toolset used to set up the current container, or %NULL if unset. @@ -6937,7 +6870,7 @@ container, or %NULL if unset. default-value="VTE_CURSOR_BLINK_SYSTEM"> Sets whether or not the cursor will blink. Using %VTE_CURSOR_BLINK_SYSTEM + line="2314">Sets whether or not the cursor will blink. Using %VTE_CURSOR_BLINK_SYSTEM will use the #GtkSettings:gtk-cursor-blink setting. @@ -6949,7 +6882,7 @@ will use the #GtkSettings:gtk-cursor-blink setting. default-value="VTE_CURSOR_SHAPE_BLOCK"> Controls the shape of the cursor. + line="2326">Controls the shape of the cursor. default-value="VTE_ERASE_AUTO"> Controls what string or control sequence the terminal sends to its child + line="2337">Controls what string or control sequence the terminal sends to its child when the user presses the delete key. @@ -6972,7 +6905,7 @@ when the user presses the delete key. default-value="TRUE"> Controls whether or not a11y is enabled for the widget. + line="2349">Controls whether or not a11y is enabled for the widget. default-value="TRUE"> Controls whether or not the terminal will perform bidirectional text rendering. + line="2365">Controls whether or not the terminal will perform bidirectional text rendering. default-value="TRUE"> Controls whether or not the terminal will shape Arabic text. + line="2377">Controls whether or not the terminal will shape Arabic text. default-value="FALSE"> Controls whether SIXEL image support is enabled. + line="2389">Controls whether SIXEL image support is enabled. default-value="NULL"> Controls the encoding the terminal will expect data from the child to + line="2433">Controls the encoding the terminal will expect data from the child to be encoded with. For certain terminal types, applications executing in the terminal can change the encoding. The default is defined by the application's locale settings. @@ -7040,7 +6973,7 @@ application's locale settings. Specifies the font used for rendering all text displayed by the terminal, + line="2449">Specifies the font used for rendering all text displayed by the terminal, overriding any fonts set using gtk_widget_modify_font(). The terminal will immediately attempt to load the desired font, retrieve its metrics, and attempt to resize itself to keep the same number of rows @@ -7055,7 +6988,7 @@ and columns. getter="get_font_options"> The terminal's font options, or %NULL to use the default font options. + line="2402">The terminal's font options, or %NULL to use the default font options. Note that on GTK4, the terminal by default uses font options with %CAIRO_HINT_METRICS_ON set; to override that, use this @@ -7071,7 +7004,7 @@ function to set a #cairo_font_options_t that has default-value="1.000000"> The terminal's font scale. + line="2421">The terminal's font scale. Controls whether the terminal allows user input. When user input is disabled, + line="2473">Controls whether the terminal allows user input. When user input is disabled, key press and mouse button press and motion events are not sent to the terminal's child. @@ -7111,7 +7044,7 @@ terminal's child. default-value="FALSE"> Controls the value of the terminal's mouse autohide setting. When autohiding + line="2485">Controls the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse. @@ -7123,7 +7056,7 @@ shown when the user moves the mouse. getter="get_pty"> The PTY object for the terminal. + line="2497">The PTY object for the terminal. default-value="TRUE"> Controls whether or not the terminal will rewrap its contents, including + line="2507">Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal's width changes. @@ -7149,7 +7082,7 @@ the scrollback buffer, whenever the terminal's width changes. default-value="FALSE"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="2537">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the text is inserted (e.g. by a paste). @@ -7161,7 +7094,7 @@ the viewable history when the text is inserted (e.g. by a paste). default-value="FALSE"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="2552">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior. @@ -7174,24 +7107,10 @@ trigger this behavior. default-value="TRUE"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="2564">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child. - - The number of lines by which the buffer is moved when -scrolling with a mouse wheel on top of the terminal -Setting it to zero will cause the buffer to be moved by an -amount depending on the number of visible rows the widget -can display. - - default-value="FALSE"> Controls whether the terminal's GtkAdjustment values unit is lines + line="2589">Controls whether the terminal's GtkAdjustment values unit is lines or pixels. This can be enabled when the terminal is the child of a GtkScrolledWindow to fix some bugs with its kinetic scrolling. @@ -7214,7 +7133,7 @@ GtkScrolledWindow to fix some bugs with its kinetic scrolling. default-value="512"> The length of the scrollback buffer used by the terminal. The size of + line="2520">The length of the scrollback buffer used by the terminal. The size of the scrollback buffer will be set to the larger of this value and the number of visible rows the widget can display, so 0 can safely be used to disable scrollback. Note that this setting only affects the normal screen buffer. @@ -7231,7 +7150,7 @@ allowed on the alternate screen buffer. default-value="VTE_TEXT_BLINK_ALWAYS"> Controls whether or not the terminal will allow blinking text. + line="2603">Controls whether or not the terminal will allow blinking text. default-value="NULL"> The terminal's title. + line="2616">The terminal's title. This signal is emitted when the a child sends a bell request to the + line="2124">This signal is emitted when the a child sends a bell request to the terminal. @@ -7328,7 +7247,7 @@ terminal. Emitted whenever the cell size changes, e.g. due to a change in + line="1706">Emitted whenever the cell size changes, e.g. due to a change in font, font-scale or cell-width/height-scale. Note that this signal should rather be called "cell-size-changed". @@ -7339,13 +7258,13 @@ Note that this signal should rather be called "cell-size-changed". the new character cell width + line="1709">the new character cell width the new character cell height + line="1710">the new character cell height @@ -7353,7 +7272,7 @@ Note that this signal should rather be called "cell-size-changed". This signal is emitted when the terminal detects that a child + line="1481">This signal is emitted when the terminal detects that a child watched using vte_terminal_watch_child() has exited. @@ -7362,7 +7281,7 @@ watched using vte_terminal_watch_child() has exited. the child's exit status + line="1484">the child's exit status @@ -7370,7 +7289,7 @@ watched using vte_terminal_watch_child() has exited. Emitted whenever the terminal receives input from the user and + line="1684">Emitted whenever the terminal receives input from the user and prepares to send it to the child process. @@ -7379,13 +7298,13 @@ prepares to send it to the child process. a string of text + line="1687">a string of text the length of that string of text + line="1688">the length of that string of text @@ -7393,7 +7312,7 @@ prepares to send it to the child process. Emitted whenever the visible appearance of the terminal has changed. + line="1749">Emitted whenever the visible appearance of the terminal has changed. Used primarily by #VteTerminalAccessible. @@ -7402,7 +7321,7 @@ Used primarily by #VteTerminalAccessible. Emitted whenever vte_terminal_copy_clipboard() is called. + line="2086">Emitted whenever vte_terminal_copy_clipboard() is called. @@ -7410,7 +7329,7 @@ Used primarily by #VteTerminalAccessible. Emitted when the current directory URI is modified. + line="1595">Emitted when the current directory URI is modified. @@ -7418,7 +7337,7 @@ Used primarily by #VteTerminalAccessible. Emitted when the current file URI is modified. + line="1614">Emitted when the current file URI is modified. @@ -7426,7 +7345,7 @@ Used primarily by #VteTerminalAccessible. Emitted whenever the cursor moves to a new character cell. Used + line="1769">Emitted whenever the cursor moves to a new character cell. Used primarily by #VteTerminalAccessible. @@ -7435,7 +7354,7 @@ primarily by #VteTerminalAccessible. Emitted when the user hits the '-' key while holding the Control key. + line="1999">Emitted when the user hits the '-' key while holding the Control key. @@ -7446,7 +7365,7 @@ primarily by #VteTerminalAccessible. deprecated-version="0.60"> Never emitted. + line="1789">Never emitted. @@ -7454,7 +7373,7 @@ primarily by #VteTerminalAccessible. Emitted whenever the terminal's current encoding has changed. + line="1663">Emitted whenever the terminal's current encoding has changed. Note: support for non-UTF-8 is deprecated. @@ -7464,7 +7383,7 @@ Note: support for non-UTF-8 is deprecated. Emitted when the terminal receives an end-of-file from a child which + line="1460">Emitted when the terminal receives an end-of-file from a child which is running in the terminal. This signal is frequently (but not always) emitted with a #VteTerminal::child-exited signal. @@ -7476,7 +7395,7 @@ always) emitted with a #VteTerminal::child-exited signal. version="0.50"> Emitted when the hovered hyperlink changes. + line="1633">Emitted when the hovered hyperlink changes. @uri and @bbox are owned by VTE, must not be modified, and might change after the signal handlers returns. @@ -7490,13 +7409,13 @@ same hyperlink. This might change in a future VTE version without notice. the nonempty target URI under the mouse, or NULL + line="1636">the nonempty target URI under the mouse, or NULL the bounding box of the hyperlink anchor text, or NULL + line="1637">the bounding box of the hyperlink anchor text, or NULL @@ -7516,7 +7435,7 @@ same hyperlink. This might change in a future VTE version without notice. deprecated-version="0.60"> Never emitted. + line="1810">Never emitted. @@ -7524,7 +7443,7 @@ same hyperlink. This might change in a future VTE version without notice. Emitted when the user hits the '+' key while holding the Control key. + line="1980">Emitted when the user hits the '+' key while holding the Control key. @@ -7535,7 +7454,7 @@ same hyperlink. This might change in a future VTE version without notice. deprecated-version="0.60"> Never emitted. + line="1852">Never emitted. @@ -7546,7 +7465,7 @@ same hyperlink. This might change in a future VTE version without notice. deprecated-version="0.60"> Never emitted. + line="1915">Never emitted. @@ -7557,7 +7476,7 @@ same hyperlink. This might change in a future VTE version without notice. deprecated-version="0.60"> Never emitted. + line="1957">Never emitted. @@ -7565,13 +7484,13 @@ same hyperlink. This might change in a future VTE version without notice. the terminal's desired location, X coordinate + line="1960">the terminal's desired location, X coordinate the terminal's desired location, Y coordinate + line="1961">the terminal's desired location, Y coordinate @@ -7579,7 +7498,7 @@ same hyperlink. This might change in a future VTE version without notice. Emitted when a process running in the terminal wants to + line="1503">Emitted when a process running in the terminal wants to send a notification to the desktop environment. @@ -7588,7 +7507,7 @@ send a notification to the desktop environment. The summary + line="1506">The summary allow-none="1"> Extra optional text + line="1507">Extra optional text @@ -7605,7 +7524,7 @@ send a notification to the desktop environment. Emitted whenever vte_terminal_paste_clipboard() is called. + line="2105">Emitted whenever vte_terminal_paste_clipboard() is called. @@ -7616,7 +7535,7 @@ send a notification to the desktop environment. deprecated-version="0.60"> Never emitted. + line="1831">Never emitted. @@ -7627,7 +7546,7 @@ send a notification to the desktop environment. deprecated-version="0.60"> Never emitted. + line="1873">Never emitted. @@ -7635,7 +7554,7 @@ send a notification to the desktop environment. Emitted at the child application's request. + line="1936">Emitted at the child application's request. @@ -7643,13 +7562,13 @@ send a notification to the desktop environment. the desired number of columns + line="1939">the desired number of columns the desired number of rows + line="1940">the desired number of rows @@ -7660,7 +7579,7 @@ send a notification to the desktop environment. deprecated-version="0.60"> Never emitted. + line="1894">Never emitted. @@ -7668,7 +7587,7 @@ send a notification to the desktop environment. Emitted whenever the contents of terminal's selection changes. + line="1730">Emitted whenever the contents of terminal's selection changes. @@ -7676,7 +7595,7 @@ send a notification to the desktop environment. Emitted with non-%NULL context before @terminal shows a context menu. + line="2144">Emitted with non-%NULL context before @terminal shows a context menu. The handler may set either a menu model using vte_terminal_set_context_menu_model(), or a menu using vte_terminal_set_context_menu(), which will then be used as context @@ -7698,7 +7617,7 @@ Also emitted with %NULL context after the context menu has been dismissed. allow-none="1"> the context + line="2147">the context @@ -7706,7 +7625,7 @@ Also emitted with %NULL context after the context menu has been dismissed. Emitted right before an interactive shell shows a + line="1523">Emitted right before an interactive shell shows a first-level prompt. @@ -7715,7 +7634,7 @@ first-level prompt. Emitted when the interactive shell has read in a complete + line="1540">Emitted when the interactive shell has read in a complete command and is about to execute it. @@ -7765,7 +7684,7 @@ command and is about to execute it. Emitted when the #VteTerminal:window-title property is modified. + line="1557">Emitted when the #VteTerminal:window-title property is modified. @@ -8181,50 +8100,10 @@ command and is about to execute it. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + @@ -8371,7 +8250,7 @@ to an output stream. - + diff --git a/girs/Vte-3.91.gir b/girs/Vte-3.91.gir index 771b43d7d..728b6cb74 100644 --- a/girs/Vte-3.91.gir +++ b/girs/Vte-3.91.gir @@ -245,16 +245,16 @@ keys. version="0.76"> Provides context information for a context menu event. + line="7487">Provides context information for a context menu event. - + %TRUE if the event has coordinates attached + line="7537">%TRUE if the event has coordinates attached that are within the terminal, with @x and @y filled in; %FALSE otherwise @@ -263,7 +263,7 @@ keys. the #VteEventContext + line="7533">the #VteEventContext allow-none="1"> location to store the X coordinate + line="7534">location to store the X coordinate allow-none="1"> location to store the Y coordinate + line="7535">location to store the Y coordinate @@ -394,7 +394,7 @@ should be copied to the clipboard in. - + The micro version number of the VTE library @@ -2060,7 +2060,7 @@ escape sequence) at the position (x, y), or %NULL. Proper use of the escape sequence should result in URI-encoded URIs with a proper scheme like "http://", "https://", "file://", "mailto:" etc. This is, however, not enforced by VTE. The caller must tolerate the returned string potentially not being a valid URI. - + - + - + - + Checks whether or not hyperlinks (OSC 8 escape sequence) are allowed. - + line="5144">Checks whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact. - + the terminal's cell height scale + line="6148">the terminal's cell height scale a #VteTerminal + line="6146">a #VteTerminal @@ -2575,21 +2575,21 @@ or if SGR 1 only enables bold and leaves the color intact. the terminal's cell width scale + line="6198">the terminal's cell width scale a #VteTerminal + line="6196">a #VteTerminal - + - + (Note that when using a non-UTF-8 encoding set via vte_terminal_set_encoding(), the width of ambiguous-width characters is fixed and determined by the encoding itself.) - + version="0.54"> Returns the background colour, as used by @terminal when + line="7097">Returns the background colour, as used by @terminal when drawing the background, which may be different from the color set by vte_terminal_set_color_background(). @@ -2668,7 +2668,7 @@ GtkWidget::draw signal. This function is rarely useful. One use for it is if you disable drawing the background (see vte_terminal_set_clear_background()) and then need to draw the background yourself. - + @@ -2676,7 +2676,7 @@ and then need to draw the background yourself. a #VteTerminal + line="7099">a #VteTerminal transfer-ownership="none"> a location to store a #GdkRGBA color + line="7100">a location to store a #GdkRGBA color - + glib:get-property="context-menu" version="0.76"> - + the context menu, or %NULL + line="7469">the context menu, or %NULL a #VteTerminal + line="7467">a #VteTerminal @@ -2735,18 +2735,58 @@ and then need to draw the background yourself. version="0.76"> - + the context menu model, or %NULL + line="7414">the context menu model, or %NULL a #VteTerminal + line="7412">a #VteTerminal + + + + + + + + the name of the current + container, or %NULL + + + + + a #VteTerminal + + + + + + + + the name of the runtime + toolset used to set up the current container, or %NULL + + + + + a #VteTerminal @@ -2754,11 +2794,11 @@ and then need to draw the background yourself. - + the URI of the current directory of the + line="5635">the URI of the current directory of the process running in the terminal, or %NULL @@ -2766,7 +2806,7 @@ and then need to draw the background yourself. a #VteTerminal + line="5633">a #VteTerminal @@ -2774,11 +2814,11 @@ and then need to draw the background yourself. - + the URI of the current file the + line="5656">the URI of the current file the process running in the terminal is operating on, or %NULL if not set @@ -2787,7 +2827,7 @@ and then need to draw the background yourself. a #VteTerminal + line="5654">a #VteTerminal @@ -2797,19 +2837,19 @@ and then need to draw the background yourself. glib:get-property="cursor-blink-mode"> Returns the currently set cursor blink mode. + line="5674">Returns the currently set cursor blink mode. cursor blink mode. + line="5680">cursor blink mode. a #VteTerminal + line="5676">a #VteTerminal @@ -2822,7 +2862,7 @@ and then need to draw the background yourself. coordinate is absolute. This method is unaware of BiDi. The returned column is logical column. - + @@ -2862,19 +2902,19 @@ This method is unaware of BiDi. The returned column is logical column. glib:get-property="cursor-shape"> Returns the currently set cursor shape. + line="5720">Returns the currently set cursor shape. cursor shape. + line="5726">cursor shape. a #VteTerminal + line="5722">a #VteTerminal @@ -2885,19 +2925,19 @@ This method is unaware of BiDi. The returned column is logical column. version="0.78"> Checks whether the terminal communicates with a11y backends - + line="5790">Checks whether the terminal communicates with a11y backends + %TRUE if a11y is enabled, %FALSE if not + line="5796">%TRUE if a11y is enabled, %FALSE if not a #VteTerminal + line="5792">a #VteTerminal @@ -2908,19 +2948,19 @@ This method is unaware of BiDi. The returned column is logical column. version="0.58"> Checks whether the terminal performs bidirectional text rendering. - + line="5837">Checks whether the terminal performs bidirectional text rendering. + %TRUE if BiDi is enabled, %FALSE if not + line="5843">%TRUE if BiDi is enabled, %FALSE if not a #VteTerminal + line="5839">a #VteTerminal @@ -2933,14 +2973,14 @@ This method is unaware of BiDi. The returned column is logical column. %TRUE if fallback scrolling is enabled + line="6885">%TRUE if fallback scrolling is enabled a #VteTerminal + line="6883">a #VteTerminal @@ -2951,19 +2991,19 @@ This method is unaware of BiDi. The returned column is logical column. version="0.58"> Checks whether the terminal shapes Arabic text. - + line="5884">Checks whether the terminal shapes Arabic text. + %TRUE if Arabic shaping is enabled, %FALSE if not + line="5890">%TRUE if Arabic shaping is enabled, %FALSE if not a #VteTerminal + line="5886">a #VteTerminal @@ -2972,18 +3012,18 @@ This method is unaware of BiDi. The returned column is logical column. c:identifier="vte_terminal_get_enable_sixel" glib:get-property="enable-sixel" version="0.62"> - + %FALSE + line="7161">%FALSE a #VteTerminal + line="7159">a #VteTerminal @@ -2995,21 +3035,21 @@ This method is unaware of BiDi. The returned column is logical column. deprecated-version="0.54"> Determines the name of the encoding in which the terminal expects data to be + line="5931">Determines the name of the encoding in which the terminal expects data to be encoded, or %NULL if UTF-8 is in use. Support for non-UTF-8 is deprecated. the current encoding for the terminal + line="5938">the current encoding for the terminal a #VteTerminal + line="5933">a #VteTerminal @@ -3017,15 +3057,15 @@ encoded, or %NULL if UTF-8 is in use. Queries the terminal for information about the fonts which will be + line="5998">Queries the terminal for information about the fonts which will be used to draw text in the terminal. The actual font takes the font scale into account, this is not reflected in the return value, the unscaled font is returned. - + a #PangoFontDescription describing the font the + line="6007">a #PangoFontDescription describing the font the terminal uses to render text at the default font scale of 1.0. @@ -3034,7 +3074,7 @@ terminal uses to render text at the default font scale of 1.0. a #VteTerminal + line="6000">a #VteTerminal @@ -3047,14 +3087,14 @@ terminal uses to render text at the default font scale of 1.0. the terminal's font options, or %NULL + line="6054">the terminal's font options, or %NULL a #VteTerminal + line="6052">a #VteTerminal @@ -3066,14 +3106,14 @@ terminal uses to render text at the default font scale of 1.0. the terminal's font scale + line="6105">the terminal's font scale a #VteTerminal + line="6103">a #VteTerminal @@ -3082,21 +3122,21 @@ terminal uses to render text at the default font scale of 1.0. c:identifier="vte_terminal_get_has_selection"> Checks if the terminal currently contains selected text. Note that this + line="6338">Checks if the terminal currently contains selected text. Note that this is different from determining if the terminal is the owner of any #GtkClipboard items. - + %TRUE if part of the text in the terminal is selected. + line="6346">%TRUE if part of the text in the terminal is selected. a #VteTerminal + line="6340">a #VteTerminal @@ -3110,14 +3150,14 @@ is different from determining if the terminal is the owner of any %NULL + line="6432">%NULL a #VteTerminal + line="6430">a #VteTerminal @@ -3127,8 +3167,8 @@ is different from determining if the terminal is the owner of any glib:get-property="input-enabled"> Returns whether the terminal allow user input. - + line="6442">Returns whether the terminal allow user input. + @@ -3136,7 +3176,7 @@ is different from determining if the terminal is the owner of any a #VteTerminal + line="6444">a #VteTerminal @@ -3145,22 +3185,22 @@ is different from determining if the terminal is the owner of any c:identifier="vte_terminal_get_mouse_autohide"> Determines the value of the terminal's mouse autohide setting. When + line="6486">Determines the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse. This setting can be changed using vte_terminal_set_mouse_autohide(). - + %TRUE if autohiding is enabled, %FALSE if not + line="6495">%TRUE if autohiding is enabled, %FALSE if not a #VteTerminal + line="6488">a #VteTerminal @@ -3170,19 +3210,19 @@ using vte_terminal_set_mouse_autohide(). glib:get-property="pty"> Returns the #VtePty of @terminal. - + line="6561">Returns the #VtePty of @terminal. + a #VtePty, or %NULL + line="6567">a #VtePty, or %NULL a #VteTerminal + line="6563">a #VteTerminal @@ -3194,36 +3234,36 @@ using vte_terminal_set_mouse_autohide(). deprecated-version="0.58"> Checks whether or not the terminal will rewrap its contents upon resize. + line="6582">Checks whether or not the terminal will rewrap its contents upon resize. %TRUE if rewrapping is enabled, %FALSE if not + line="6588">%TRUE if rewrapping is enabled, %FALSE if not a #VteTerminal + line="6584">a #VteTerminal - + the number of rows + line="6635">the number of rows a #VteTerminal + line="6632">a #VteTerminal @@ -3236,7 +3276,7 @@ using vte_terminal_set_mouse_autohide(). whether or not the terminal will forcibly scroll to the bottom of + line="6737">whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child. @@ -3244,7 +3284,7 @@ the viewable history when the new data is received from the child. a #VteTerminal + line="6735">a #VteTerminal @@ -3257,7 +3297,7 @@ the viewable history when the new data is received from the child. whether or not the terminal will forcibly scroll to the bottom of + line="6786">whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior. @@ -3266,7 +3306,7 @@ trigger this behavior. a #VteTerminal + line="6784">a #VteTerminal @@ -3279,7 +3319,7 @@ trigger this behavior. whether or not the terminal will forcibly scroll to the bottom of + line="6834">whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child. @@ -3287,7 +3327,7 @@ the viewable history when the new data is received from the child. a #VteTerminal + line="6832">a #VteTerminal @@ -3300,14 +3340,14 @@ the viewable history when the new data is received from the child. %TRUE if the scroll unit is pixels; or %FALSE if the unit is lines + line="6933">%TRUE if the scroll unit is pixels; or %FALSE if the unit is lines a #VteTerminal + line="6931">a #VteTerminal @@ -3316,11 +3356,11 @@ the viewable history when the new data is received from the child. c:identifier="vte_terminal_get_scrollback_lines" glib:get-property="scrollback-lines" version="0.52"> - + length of the scrollback buffer used by the terminal. + line="6690">length of the scrollback buffer used by the terminal. A negative value means "infinite scrollback". @@ -3328,7 +3368,7 @@ A negative value means "infinite scrollback". a #VteTerminal + line="6688">a #VteTerminal @@ -3430,7 +3470,7 @@ Since 0.72, passing a non-%NULL @is_selected parameter will make this function i This method is unaware of BiDi. The columns returned in @attributes are logical columns. - + Returns the specified range of text in the specified format. - + Gets the currently selected text in the format specified by @format. + line="6361">Gets the currently selected text in the format specified by @format. Since 0.72, this function also supports %VTE_FORMAT_HTML format. - + a newly allocated string containing the selected text, or %NULL if there is no selection or the format is not supported + line="6369">a newly allocated string containing the selected text, or %NULL if there is no selection or the format is not supported a #VteTerminal + line="6363">a #VteTerminal the #VteFormat to use + line="6364">the #VteFormat to use @@ -3707,25 +3747,25 @@ Since 0.72, this function also supports %VTE_FORMAT_HTML format. version="0.72"> Gets the currently selected text in the format specified by @format. - + line="6388">Gets the currently selected text in the format specified by @format. + a newly allocated string containing the selected text, or %NULL if there is no selection or the format is not supported + line="6396">a newly allocated string containing the selected text, or %NULL if there is no selection or the format is not supported a #VteTerminal + line="6390">a #VteTerminal the #VteFormat to use + line="6391">the #VteFormat to use allow-none="1"> a pointer to a #gsize to store the string length + line="6392">a pointer to a #gsize to store the string length @@ -3744,18 +3784,18 @@ Since 0.72, this function also supports %VTE_FORMAT_HTML format. - + the window title, or %NULL + line="6954">the window title, or %NULL a #VteTerminal + line="6952">a #VteTerminal @@ -3766,7 +3806,7 @@ Since 0.72, this function also supports %VTE_FORMAT_HTML format. version="0.40"> Returns the set of characters which will be considered parts of a word + line="6969">Returns the set of characters which will be considered parts of a word when doing word-wise selection, in addition to the default which only considers alphanumeric characters part of a word. @@ -3775,14 +3815,14 @@ If %NULL, a built-in set is used. a string, or %NULL + line="6979">a string, or %NULL a #VteTerminal + line="6971">a #VteTerminal @@ -3791,18 +3831,18 @@ If %NULL, a built-in set is used. c:identifier="vte_terminal_get_xalign" glib:get-property="xalign" version="0.76"> - + the horizontal alignment of @terminal within its allocation + line="7222">the horizontal alignment of @terminal within its allocation a #VteTerminal + line="7220">a #VteTerminal @@ -3811,18 +3851,18 @@ If %NULL, a built-in set is used. c:identifier="vte_terminal_get_xfill" glib:get-property="xfill" version="0.76"> - + the horizontal fillment of @terminal within its allocation + line="7318">the horizontal fillment of @terminal within its allocation a #VteTerminal + line="7316">a #VteTerminal @@ -3831,18 +3871,18 @@ If %NULL, a built-in set is used. c:identifier="vte_terminal_get_yalign" glib:get-property="yalign" version="0.76"> - + the vertical alignment of @terminal within its allocation + line="7269">the vertical alignment of @terminal within its allocation a #VteTerminal + line="7267">a #VteTerminal @@ -3851,18 +3891,18 @@ If %NULL, a built-in set is used. c:identifier="vte_terminal_get_yfill" glib:get-property="yfill" version="0.76"> - + the vertical fillment of @terminal within its allocation + line="7366">the vertical fillment of @terminal within its allocation a #VteTerminal + line="7364">a #VteTerminal @@ -3878,7 +3918,7 @@ this expression, the text will be highlighted. Note that @regex should have been created using the <literal>PCRE2_MULTILINE</literal> flag. - + line="3760">Removes the regular expression which is associated with the given @tag from the list of expressions which the terminal will highlight when the user moves the mouse cursor over matching text. - + @@ -3992,7 +4032,7 @@ moves the mouse cursor over matching text. filename="src/vtegtk.cc" line="3782">Clears the list of regular expressions the terminal uses to highlight text when the user moves the mouse cursor. - + @@ -4049,7 +4089,7 @@ specified by @tag. The terminal keeps a reference to @cursor. filename="src/vtegtk.cc" line="3735">Sets which cursor the terminal will use if the pointer is over the pattern specified by @tag. - + @@ -4189,7 +4229,7 @@ See vte_pty_new() for more information. unprocessed input data, resetting character attributes, cursor state, national character set state, status line, terminal modes (insert/delete), selection state, and encoding. - + @@ -4220,7 +4260,7 @@ selection state, and encoding. filename="src/vtegtk.cc" line="3823">Searches the next string matching the search regex set with vte_terminal_search_set_regex(). - + filename="src/vtegtk.cc" line="3801">Searches the previous string matching the search regex set with vte_terminal_search_set_regex(). - + - + - + Note that @regex should have been created using the <literal>PCRE2_MULTILINE</literal> flag. - + @@ -4338,7 +4378,7 @@ Note that @regex should have been created using the filename="src/vtegtk.cc" line="3934">Sets whether search should wrap around to the beginning of the terminal content when reaching its end. - + @@ -4410,7 +4450,7 @@ by using a bold font variant. Controls whether or not hyperlinks (OSC 8 escape sequence) are allowed. - + @@ -4463,7 +4503,7 @@ by using a bold font variant. line="5119">Modifies the terminal's backspace key binding, which controls what string or control sequence the terminal sends to its child when the user presses the backspace key. - + @@ -4491,7 +4531,7 @@ presses the backspace key. line="5169">Sets whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact. - + @@ -4516,7 +4556,7 @@ or if SGR 1 only enables bold and leaves the color intact. version="0.52"> Sets the terminal's cell height scale to @scale. + line="6166">Sets the terminal's cell height scale to @scale. This can be used to increase the line spacing. (The font's height is not affected.) Valid values go from 1.0 (default) to 2.0 ("double spacing"). @@ -4528,13 +4568,13 @@ Valid values go from 1.0 (default) to 2.0 ("double spacing"). a #VteTerminal + line="6168">a #VteTerminal the cell height scale + line="6169">the cell height scale @@ -4545,7 +4585,7 @@ Valid values go from 1.0 (default) to 2.0 ("double spacing"). version="0.52"> Sets the terminal's cell width scale to @scale. + line="6216">Sets the terminal's cell width scale to @scale. This can be used to increase the letter spacing. (The font's width is not affected.) Valid values go from 1.0 (default) to 2.0. @@ -4557,13 +4597,13 @@ Valid values go from 1.0 (default) to 2.0. a #VteTerminal + line="6218">a #VteTerminal the cell width scale + line="6219">the cell width scale @@ -4577,7 +4617,7 @@ Valid values go from 1.0 (default) to 2.0. (Note that when using a non-UTF-8 encoding set via vte_terminal_set_encoding(), the width of ambiguous-width characters is fixed and determined by the encoding itself.) - + @@ -4601,12 +4641,12 @@ itself.) version="0.52"> Sets whether to paint the background with the background colour. + line="7070">Sets whether to paint the background with the background colour. The default is %TRUE. This function is rarely useful. One use for it is to add a background image to the terminal. - + @@ -4614,13 +4654,13 @@ image to the terminal. a #VteTerminal + line="7072">a #VteTerminal whether to clear the background + line="7073">whether to clear the background @@ -4888,12 +4928,12 @@ greater than 0, the new background color is taken from @palette[0]. Sets @menu as the context menu in @terminal. + line="7432">Sets @menu as the context menu in @terminal. Use %NULL to unset the current menu. Note that a menu model set with vte_terminal_set_context_menu_model() takes precedence over a menu set using this function. - + @@ -4901,7 +4941,7 @@ takes precedence over a menu set using this function. a #VteTerminal + line="7434">a #VteTerminal allow-none="1"> a menu + line="7435">a menu @@ -4923,9 +4963,9 @@ takes precedence over a menu set using this function. value="context-menu-model"/> Sets @model as the context menu model in @terminal. + line="7384">Sets @model as the context menu model in @terminal. Use %NULL to unset the current menu model. - + @@ -4933,7 +4973,7 @@ Use %NULL to unset the current menu model. a #VteTerminal + line="7386">a #VteTerminal allow-none="1"> a #GMenuModel + line="7387">a #GMenuModel @@ -4952,7 +4992,7 @@ Use %NULL to unset the current menu model. glib:set-property="cursor-blink-mode"> Sets whether or not the cursor will blink. Using %VTE_CURSOR_BLINK_SYSTEM + line="5696">Sets whether or not the cursor will blink. Using %VTE_CURSOR_BLINK_SYSTEM will use the #GtkSettings::gtk-cursor-blink setting. @@ -4962,13 +5002,13 @@ will use the #GtkSettings::gtk-cursor-blink setting. a #VteTerminal + line="5698">a #VteTerminal the #VteCursorBlinkMode to use + line="5699">the #VteCursorBlinkMode to use @@ -4978,7 +5018,7 @@ will use the #GtkSettings::gtk-cursor-blink setting. glib:set-property="cursor-shape"> Sets the shape of the cursor drawn. + line="5742">Sets the shape of the cursor drawn. @@ -4987,13 +5027,13 @@ will use the #GtkSettings::gtk-cursor-blink setting. a #VteTerminal + line="5744">a #VteTerminal the #VteCursorShape to use + line="5745">the #VteCursorShape to use @@ -5021,10 +5061,10 @@ will use the #GtkSettings::gtk-cursor-blink setting. glib:set-property="delete-binding"> Modifies the terminal's delete key binding, which controls what + line="5765">Modifies the terminal's delete key binding, which controls what string or control sequence the terminal sends to its child when the user presses the delete key. - + @@ -5032,13 +5072,13 @@ presses the delete key. a #VteTerminal + line="5767">a #VteTerminal a #VteEraseBinding for the delete key + line="5768">a #VteEraseBinding for the delete key @@ -5049,8 +5089,8 @@ presses the delete key. version="0.78"> Controls whether or not the terminal will communicate with a11y backends. - + line="5813">Controls whether or not the terminal will communicate with a11y backends. + @@ -5058,13 +5098,13 @@ presses the delete key. a #VteTerminal + line="5815">a #VteTerminal %TRUE to enable a11y support + line="5816">%TRUE to enable a11y support @@ -5075,8 +5115,8 @@ presses the delete key. version="0.58"> Controls whether or not the terminal will perform bidirectional text rendering. - + line="5860">Controls whether or not the terminal will perform bidirectional text rendering. + @@ -5084,13 +5124,13 @@ presses the delete key. a #VteTerminal + line="5862">a #VteTerminal %TRUE to enable BiDi support + line="5863">%TRUE to enable BiDi support @@ -5101,7 +5141,7 @@ presses the delete key. version="0.64"> Controls whether the terminal uses scroll events to scroll the history + line="6852">Controls whether the terminal uses scroll events to scroll the history if the event was not otherwise consumed by it. This function is rarely useful, except when the terminal is added to a @@ -5115,13 +5155,13 @@ not, yet, implement kinetic scrolling by itself). a #VteTerminal + line="6854">a #VteTerminal whether to enable fallback scrolling + line="6855">whether to enable fallback scrolling @@ -5132,8 +5172,8 @@ not, yet, implement kinetic scrolling by itself). version="0.58"> Controls whether or not the terminal will shape Arabic text. - + line="5907">Controls whether or not the terminal will shape Arabic text. + @@ -5141,13 +5181,13 @@ not, yet, implement kinetic scrolling by itself). a #VteTerminal + line="5909">a #VteTerminal %TRUE to enable Arabic shaping + line="5910">%TRUE to enable Arabic shaping @@ -5158,8 +5198,8 @@ not, yet, implement kinetic scrolling by itself). version="0.62"> Set whether to enable SIXEL images. - + line="7136">Set whether to enable SIXEL images. + @@ -5167,13 +5207,13 @@ not, yet, implement kinetic scrolling by itself). a #VteTerminal + line="7138">a #VteTerminal whether to enable SIXEL images + line="7139">whether to enable SIXEL images @@ -5186,7 +5226,7 @@ not, yet, implement kinetic scrolling by itself). throws="1"> Changes the encoding the terminal will expect data from the child to + line="5955">Changes the encoding the terminal will expect data from the child to be encoded with. For certain terminal types, applications executing in the terminal can change the encoding. If @codeset is %NULL, it uses "UTF-8". @@ -5198,7 +5238,7 @@ spawning the child process. %TRUE if the encoding could be changed to the specified one, + line="5969">%TRUE if the encoding could be changed to the specified one, or %FALSE with @error set to %G_CONVERT_ERROR_NO_CONVERSION. @@ -5206,7 +5246,7 @@ spawning the child process. a #VteTerminal + line="5957">a #VteTerminal allow-none="1"> target charset, or %NULL to use UTF-8 + line="5958">target charset, or %NULL to use UTF-8 @@ -5223,12 +5263,12 @@ spawning the child process. Sets the font used for rendering all text displayed by the terminal, + line="6024">Sets the font used for rendering all text displayed by the terminal, overriding any fonts set using gtk_widget_modify_font(). The terminal will immediately attempt to load the desired font, retrieve its metrics, and attempt to resize itself to keep the same number of rows and columns. The font scale is applied to the specified font. - + @@ -5236,7 +5276,7 @@ and columns. The font scale is applied to the specified font. a #VteTerminal + line="6026">a #VteTerminal allow-none="1"> a #PangoFontDescription for the desired font, or %NULL + line="6027">a #PangoFontDescription for the desired font, or %NULL @@ -5257,7 +5297,7 @@ and columns. The font scale is applied to the specified font. version="0.74"> Sets the terminal's font options to @options. + line="6072">Sets the terminal's font options to @options. Note that on GTK4, the terminal by default uses font options with %CAIRO_HINT_METRICS_ON set; to override that, use this @@ -5271,7 +5311,7 @@ function to set a #cairo_font_options_t that has a #VteTerminal + line="6074">a #VteTerminal the font options, or %NULL + line="6075">the font options, or %NULL @@ -5291,7 +5331,7 @@ function to set a #cairo_font_options_t that has glib:set-property="font-scale"> Sets the terminal's font scale to @scale. + line="6121">Sets the terminal's font scale to @scale. @@ -5300,13 +5340,13 @@ function to set a #cairo_font_options_t that has a #VteTerminal + line="6123">a #VteTerminal the font scale + line="6124">the font scale @@ -5316,10 +5356,10 @@ function to set a #cairo_font_options_t that has glib:set-property="input-enabled"> Enables or disables user input. When user input is disabled, + line="6462">Enables or disables user input. When user input is disabled, the terminal's child will not receive any key press, or mouse button press or motion events sent to it. - + @@ -5327,13 +5367,13 @@ press or motion events sent to it. a #VteTerminal + line="6464">a #VteTerminal whether to enable user input + line="6465">whether to enable user input @@ -5342,11 +5382,11 @@ press or motion events sent to it. c:identifier="vte_terminal_set_mouse_autohide"> Changes the value of the terminal's mouse autohide setting. When autohiding + line="6510">Changes the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse. This setting can be read using vte_terminal_get_mouse_autohide(). - + @@ -5354,13 +5394,13 @@ vte_terminal_get_mouse_autohide(). a #VteTerminal + line="6512">a #VteTerminal whether the mouse pointer should autohide + line="6513">whether the mouse pointer should autohide @@ -5370,9 +5410,9 @@ vte_terminal_get_mouse_autohide(). glib:set-property="pty"> Sets @pty as the PTY to use in @terminal. + line="6535">Sets @pty as the PTY to use in @terminal. Use %NULL to unset the PTY. - + @@ -5380,7 +5420,7 @@ Use %NULL to unset the PTY. a #VteTerminal + line="6537">a #VteTerminal allow-none="1"> a #VtePty, or %NULL + line="6538">a #VtePty, or %NULL @@ -5401,7 +5441,7 @@ Use %NULL to unset the PTY. deprecated-version="0.58"> Controls whether or not the terminal will rewrap its contents, including + line="6605">Controls whether or not the terminal will rewrap its contents, including the scrollback history, whenever the terminal's width changes. @@ -5411,13 +5451,13 @@ the scrollback history, whenever the terminal's width changes. a #VteTerminal + line="6607">a #VteTerminal %TRUE if the terminal should rewrap on resize + line="6608">%TRUE if the terminal should rewrap on resize @@ -5428,7 +5468,7 @@ the scrollback history, whenever the terminal's width changes. version="0.76"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="6708">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when text is inserted, e.g. by a paste. @@ -5438,13 +5478,13 @@ the viewable history when text is inserted, e.g. by a paste. a #VteTerminal + line="6710">a #VteTerminal whether the terminal should scroll on insert + line="6711">whether the terminal should scroll on insert @@ -5455,7 +5495,7 @@ the viewable history when text is inserted, e.g. by a paste. version="0.52"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="6756">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior. @@ -5466,13 +5506,13 @@ trigger this behavior. a #VteTerminal + line="6758">a #VteTerminal whether the terminal should scroll on keystrokes + line="6759">whether the terminal should scroll on keystrokes @@ -5483,7 +5523,7 @@ trigger this behavior. version="0.52"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="6805">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child. @@ -5493,13 +5533,13 @@ the viewable history when the new data is received from the child. a #VteTerminal + line="6807">a #VteTerminal whether the terminal should scroll on output + line="6808">whether the terminal should scroll on output @@ -5510,7 +5550,7 @@ the viewable history when the new data is received from the child. version="0.66"> Controls whether the terminal's scroll unit is lines or pixels. + line="6902">Controls whether the terminal's scroll unit is lines or pixels. This function is rarely useful, except when the terminal is added to a #GtkScrolledWindow. @@ -5522,13 +5562,13 @@ This function is rarely useful, except when the terminal is added to a a #VteTerminal + line="6904">a #VteTerminal whether to use pixels as scroll unit + line="6905">whether to use pixels as scroll unit @@ -5538,7 +5578,7 @@ This function is rarely useful, except when the terminal is added to a glib:set-property="scrollback-lines"> Sets the length of the scrollback buffer used by the terminal. The size of + line="6650">Sets the length of the scrollback buffer used by the terminal. The size of the scrollback buffer will be set to the larger of this value and the number of visible rows the widget can display, so 0 can safely be used to disable scrollback. @@ -5550,7 +5590,7 @@ degradation or exhaustion of system resources, and is therefore not recommended. Note that this setting only affects the normal screen buffer. No scrollback is allowed on the alternate screen buffer. - + @@ -5558,13 +5598,13 @@ No scrollback is allowed on the alternate screen buffer. a #VteTerminal + line="6652">a #VteTerminal the length of the history buffer + line="6653">the length of the history buffer @@ -5630,7 +5670,7 @@ the attempt succeeds, the widget will resize itself to the proper size. version="0.40"> With this function you can provide a set of characters which will + line="6997">With this function you can provide a set of characters which will be considered parts of a word when doing word-wise selection, in addition to the default which only considers alphanumeric characters part of a word. @@ -5648,13 +5688,13 @@ Use %NULL to reset the set of exception characters to the default. a #VteTerminal + line="6999">a #VteTerminal a string of ASCII punctuation characters, or %NULL + line="7000">a string of ASCII punctuation characters, or %NULL @@ -5665,11 +5705,11 @@ Use %NULL to reset the set of exception characters to the default. version="0.76"> Sets the horizontal alignment of @terminal within its allocation. + line="7190">Sets the horizontal alignment of @terminal within its allocation. Note: %VTE_ALIGN_START_FILL is not supported, and will be treated like %VTE_ALIGN_START. - + @@ -5677,13 +5717,13 @@ Note: %VTE_ALIGN_START_FILL is not supported, and will be treated a #VteTerminal + line="7192">a #VteTerminal alignment value from #VteAlign + line="7193">alignment value from #VteAlign @@ -5694,11 +5734,11 @@ Note: %VTE_ALIGN_START_FILL is not supported, and will be treated version="0.76"> Sets the horizontal fillment of @terminal within its allocation. + line="7287">Sets the horizontal fillment of @terminal within its allocation. Note: %VTE_FILL_START_FILL is not supported, and will be treated like %VTE_FILL_START. - + @@ -5706,13 +5746,13 @@ Note: %VTE_FILL_START_FILL is not supported, and will be treated a #VteTerminal + line="7289">a #VteTerminal fillment value from #VteFill + line="7290">fillment value from #VteFill @@ -5723,8 +5763,8 @@ Note: %VTE_FILL_START_FILL is not supported, and will be treated version="0.76"> Sets the vertical alignment of @terminal within its allocation. - + line="7240">Sets the vertical alignment of @terminal within its allocation. + @@ -5732,13 +5772,13 @@ Note: %VTE_FILL_START_FILL is not supported, and will be treated a #VteTerminal + line="7242">a #VteTerminal alignment value from #VteAlign + line="7243">alignment value from #VteAlign @@ -5749,10 +5789,10 @@ Note: %VTE_FILL_START_FILL is not supported, and will be treated version="0.76"> Sets the vertical fillment of @terminal within its allocation. + line="7336">Sets the vertical fillment of @terminal within its allocation. Note that yfill is only supported with yalign set to %VTE_ALIGN_START, and is ignored for all other yalign values. - + @@ -5760,13 +5800,13 @@ Note that yfill is only supported with yalign set to a #VteTerminal + line="7338">a #VteTerminal fillment value from #VteFill + line="7339">fillment value from #VteFill @@ -6307,7 +6347,7 @@ the %G_SPAWN_DO_NOT_REAP_CHILD flag MUST have been passed. throws="1"> Write contents of the current contents of @terminal (including any + line="7031">Write contents of the current contents of @terminal (including any scrollback history) to @stream according to @flags. If @cancellable is not %NULL, then the operation can be cancelled by triggering @@ -6317,30 +6357,30 @@ the error %G_IO_ERROR_CANCELLED will be returned in @error. This is a synchronous operation and will make the widget (and input processing) during the write operation, which may take a long time depending on scrollback history and @stream availability for writing. - + %TRUE on success, %FALSE if there was an error + line="7050">%TRUE on success, %FALSE if there was an error a #VteTerminal + line="7033">a #VteTerminal a #GOutputStream to write to + line="7034">a #GOutputStream to write to a set of #VteWriteFlags + line="7035">a set of #VteWriteFlags allow-none="1"> a #GCancellable object, or %NULL + line="7036">a #GCancellable object, or %NULL @@ -6364,7 +6404,7 @@ depending on scrollback history and @stream availability for writing. default-value="TRUE"> Controls whether or not the terminal will attempt to draw bold text, + line="2176">Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant. There's probably no reason for this feature to exist. @@ -6378,7 +6418,7 @@ by using a bold font variant. default-value="FALSE"> Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed. + line="2189">Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed. default-value="TRUE"> Controls whether or not the terminal will beep when the child outputs the + line="2201">Controls whether or not the terminal will beep when the child outputs the "bl" sequence. @@ -6400,7 +6440,7 @@ by using a bold font variant. default-value="VTE_ERASE_AUTO"> Controls what string or control sequence the terminal sends to its child + line="2212">Controls what string or control sequence the terminal sends to its child when the user presses the backspace key. @@ -6413,7 +6453,7 @@ when the user presses the backspace key. default-value="FALSE"> Whether the SGR 1 attribute also switches to the bright counterpart + line="2224">Whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact. @@ -6427,7 +6467,7 @@ or if SGR 1 only enables bold and leaves the color intact. default-value="1.000000"> Scale factor for the cell height, to increase line spacing. (The font's height is not affected.) + line="2238">Scale factor for the cell height, to increase line spacing. (The font's height is not affected.) default-value="1.000000"> Scale factor for the cell width, to increase letter spacing. (The font's width is not affected.) + line="2252">Scale factor for the cell width, to increase letter spacing. (The font's width is not affected.) default-value="1"> This setting controls whether ambiguous-width characters are narrow or wide. + line="2266">This setting controls whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via vte_terminal_set_encoding(), the width of ambiguous-width characters is fixed and determined by the encoding itself.) @@ -6471,7 +6511,7 @@ via escape sequence or with vte_terminal_reset(). value="vte_terminal_set_context_menu"/> The menu used for context menus. Note that context menu model set with the + line="2296">The menu used for context menus. Note that context menu model set with the #VteTerminal::context-menu-model property or vte_terminal_set_context_menu_model() takes precedence over this. @@ -6488,11 +6528,30 @@ takes precedence over this. value="vte_terminal_set_context_menu_model"/> The menu model used for context menus. If non-%NULL, the context menu is + line="2282">The menu model used for context menus. If non-%NULL, the context menu is generated from this model, and overrides a context menu set with the #VteTerminal::context-menu property or vte_terminal_set_context_menu(). + + The name of the current container, or %NULL if unset. + + + + The name of the runtime toolset used to set up the current +container, or %NULL if unset. + + Sets whether or not the cursor will blink. Using %VTE_CURSOR_BLINK_SYSTEM + line="2314">Sets whether or not the cursor will blink. Using %VTE_CURSOR_BLINK_SYSTEM will use the #GtkSettings:gtk-cursor-blink setting. @@ -6531,7 +6590,7 @@ will use the #GtkSettings:gtk-cursor-blink setting. default-value="VTE_CURSOR_SHAPE_BLOCK"> Controls the shape of the cursor. + line="2326">Controls the shape of the cursor. default-value="VTE_ERASE_AUTO"> Controls what string or control sequence the terminal sends to its child + line="2337">Controls what string or control sequence the terminal sends to its child when the user presses the delete key. @@ -6554,7 +6613,7 @@ when the user presses the delete key. default-value="FALSE"> Controls whether or not a11y is enabled for the widget. + line="2349">Controls whether or not a11y is enabled for the widget. default-value="TRUE"> Controls whether or not the terminal will perform bidirectional text rendering. + line="2365">Controls whether or not the terminal will perform bidirectional text rendering. default-value="TRUE"> Controls whether or not the terminal will shape Arabic text. + line="2377">Controls whether or not the terminal will shape Arabic text. default-value="FALSE"> Controls whether SIXEL image support is enabled. + line="2389">Controls whether SIXEL image support is enabled. default-value="NULL"> Controls the encoding the terminal will expect data from the child to + line="2433">Controls the encoding the terminal will expect data from the child to be encoded with. For certain terminal types, applications executing in the terminal can change the encoding. The default is defined by the application's locale settings. @@ -6622,7 +6681,7 @@ application's locale settings. Specifies the font used for rendering all text displayed by the terminal, + line="2449">Specifies the font used for rendering all text displayed by the terminal, overriding any fonts set using gtk_widget_modify_font(). The terminal will immediately attempt to load the desired font, retrieve its metrics, and attempt to resize itself to keep the same number of rows @@ -6637,7 +6696,7 @@ and columns. getter="get_font_options"> The terminal's font options, or %NULL to use the default font options. + line="2402">The terminal's font options, or %NULL to use the default font options. Note that on GTK4, the terminal by default uses font options with %CAIRO_HINT_METRICS_ON set; to override that, use this @@ -6653,7 +6712,7 @@ function to set a #cairo_font_options_t that has default-value="1.000000"> The terminal's font scale. + line="2421">The terminal's font scale. Controls whether the terminal allows user input. When user input is disabled, + line="2473">Controls whether the terminal allows user input. When user input is disabled, key press and mouse button press and motion events are not sent to the terminal's child. @@ -6693,7 +6752,7 @@ terminal's child. default-value="FALSE"> Controls the value of the terminal's mouse autohide setting. When autohiding + line="2485">Controls the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse. @@ -6705,7 +6764,7 @@ shown when the user moves the mouse. getter="get_pty"> The PTY object for the terminal. + line="2497">The PTY object for the terminal. default-value="TRUE"> Controls whether or not the terminal will rewrap its contents, including + line="2507">Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal's width changes. @@ -6731,7 +6790,7 @@ the scrollback buffer, whenever the terminal's width changes. default-value="FALSE"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="2537">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the text is inserted (e.g. by a paste). @@ -6743,7 +6802,7 @@ the viewable history when the text is inserted (e.g. by a paste). default-value="FALSE"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="2552">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior. @@ -6756,7 +6815,7 @@ trigger this behavior. default-value="TRUE"> Controls whether or not the terminal will forcibly scroll to the bottom of + line="2564">Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child. @@ -6769,7 +6828,7 @@ the viewable history when the new data is received from the child. default-value="FALSE"> Controls whether the terminal's GtkAdjustment values unit is lines + line="2589">Controls whether the terminal's GtkAdjustment values unit is lines or pixels. This can be enabled when the terminal is the child of a GtkScrolledWindow to fix some bugs with its kinetic scrolling. @@ -6782,7 +6841,7 @@ GtkScrolledWindow to fix some bugs with its kinetic scrolling. default-value="512"> The length of the scrollback buffer used by the terminal. The size of + line="2520">The length of the scrollback buffer used by the terminal. The size of the scrollback buffer will be set to the larger of this value and the number of visible rows the widget can display, so 0 can safely be used to disable scrollback. Note that this setting only affects the normal screen buffer. @@ -6799,7 +6858,7 @@ allowed on the alternate screen buffer. default-value="VTE_TEXT_BLINK_ALWAYS"> Controls whether or not the terminal will allow blinking text. + line="2603">Controls whether or not the terminal will allow blinking text. default-value="NULL"> The terminal's title. + line="2616">The terminal's title. This signal is emitted when the a child sends a bell request to the + line="2124">This signal is emitted when the a child sends a bell request to the terminal. @@ -6891,7 +6950,7 @@ terminal. Emitted whenever the cell size changes, e.g. due to a change in + line="1706">Emitted whenever the cell size changes, e.g. due to a change in font, font-scale or cell-width/height-scale. Note that this signal should rather be called "cell-size-changed". @@ -6902,13 +6961,13 @@ Note that this signal should rather be called "cell-size-changed". the new character cell width + line="1709">the new character cell width the new character cell height + line="1710">the new character cell height @@ -6916,7 +6975,7 @@ Note that this signal should rather be called "cell-size-changed". This signal is emitted when the terminal detects that a child + line="1481">This signal is emitted when the terminal detects that a child watched using vte_terminal_watch_child() has exited. @@ -6925,7 +6984,7 @@ watched using vte_terminal_watch_child() has exited. the child's exit status + line="1484">the child's exit status @@ -6933,7 +6992,7 @@ watched using vte_terminal_watch_child() has exited. Emitted whenever the terminal receives input from the user and + line="1684">Emitted whenever the terminal receives input from the user and prepares to send it to the child process. @@ -6942,13 +7001,13 @@ prepares to send it to the child process. a string of text + line="1687">a string of text the length of that string of text + line="1688">the length of that string of text @@ -6956,7 +7015,7 @@ prepares to send it to the child process. Emitted whenever the visible appearance of the terminal has changed. + line="1749">Emitted whenever the visible appearance of the terminal has changed. Used primarily by #VteTerminalAccessible. @@ -6965,7 +7024,7 @@ Used primarily by #VteTerminalAccessible. Emitted whenever vte_terminal_copy_clipboard() is called. + line="2086">Emitted whenever vte_terminal_copy_clipboard() is called. @@ -6973,7 +7032,7 @@ Used primarily by #VteTerminalAccessible. Emitted when the current directory URI is modified. + line="1595">Emitted when the current directory URI is modified. @@ -6981,7 +7040,7 @@ Used primarily by #VteTerminalAccessible. Emitted when the current file URI is modified. + line="1614">Emitted when the current file URI is modified. @@ -6989,7 +7048,7 @@ Used primarily by #VteTerminalAccessible. Emitted whenever the cursor moves to a new character cell. Used + line="1769">Emitted whenever the cursor moves to a new character cell. Used primarily by #VteTerminalAccessible. @@ -6998,7 +7057,7 @@ primarily by #VteTerminalAccessible. Emitted when the user hits the '-' key while holding the Control key. + line="1999">Emitted when the user hits the '-' key while holding the Control key. @@ -7009,7 +7068,7 @@ primarily by #VteTerminalAccessible. deprecated-version="0.60"> Never emitted. + line="1789">Never emitted. @@ -7017,7 +7076,7 @@ primarily by #VteTerminalAccessible. Emitted whenever the terminal's current encoding has changed. + line="1663">Emitted whenever the terminal's current encoding has changed. Note: support for non-UTF-8 is deprecated. @@ -7027,7 +7086,7 @@ Note: support for non-UTF-8 is deprecated. Emitted when the terminal receives an end-of-file from a child which + line="1460">Emitted when the terminal receives an end-of-file from a child which is running in the terminal. This signal is frequently (but not always) emitted with a #VteTerminal::child-exited signal. @@ -7039,7 +7098,7 @@ always) emitted with a #VteTerminal::child-exited signal. version="0.50"> Emitted when the hovered hyperlink changes. + line="1633">Emitted when the hovered hyperlink changes. @uri and @bbox are owned by VTE, must not be modified, and might change after the signal handlers returns. @@ -7053,13 +7112,13 @@ same hyperlink. This might change in a future VTE version without notice. the nonempty target URI under the mouse, or NULL + line="1636">the nonempty target URI under the mouse, or NULL the bounding box of the hyperlink anchor text, or NULL + line="1637">the bounding box of the hyperlink anchor text, or NULL @@ -7079,7 +7138,7 @@ same hyperlink. This might change in a future VTE version without notice. deprecated-version="0.60"> Never emitted. + line="1810">Never emitted. @@ -7087,7 +7146,7 @@ same hyperlink. This might change in a future VTE version without notice. Emitted when the user hits the '+' key while holding the Control key. + line="1980">Emitted when the user hits the '+' key while holding the Control key. @@ -7098,7 +7157,7 @@ same hyperlink. This might change in a future VTE version without notice. deprecated-version="0.60"> Never emitted. + line="1852">Never emitted. @@ -7109,7 +7168,7 @@ same hyperlink. This might change in a future VTE version without notice. deprecated-version="0.60"> Never emitted. + line="1915">Never emitted. @@ -7120,7 +7179,7 @@ same hyperlink. This might change in a future VTE version without notice. deprecated-version="0.60"> Never emitted. + line="1957">Never emitted. @@ -7128,21 +7187,47 @@ same hyperlink. This might change in a future VTE version without notice. the terminal's desired location, X coordinate + line="1960">the terminal's desired location, X coordinate the terminal's desired location, Y coordinate + line="1961">the terminal's desired location, Y coordinate + + Emitted when a process running in the terminal wants to +send a notification to the desktop environment. + + + + + + The summary + + + + Extra optional text + + + + Emitted whenever vte_terminal_paste_clipboard() is called. + line="2105">Emitted whenever vte_terminal_paste_clipboard() is called. @@ -7153,7 +7238,7 @@ same hyperlink. This might change in a future VTE version without notice. deprecated-version="0.60"> Never emitted. + line="1831">Never emitted. @@ -7164,7 +7249,7 @@ same hyperlink. This might change in a future VTE version without notice. deprecated-version="0.60"> Never emitted. + line="1873">Never emitted. @@ -7172,7 +7257,7 @@ same hyperlink. This might change in a future VTE version without notice. Emitted at the child application's request. + line="1936">Emitted at the child application's request. @@ -7180,13 +7265,13 @@ same hyperlink. This might change in a future VTE version without notice. the desired number of columns + line="1939">the desired number of columns the desired number of rows + line="1940">the desired number of rows @@ -7197,7 +7282,7 @@ same hyperlink. This might change in a future VTE version without notice. deprecated-version="0.60"> Never emitted. + line="1894">Never emitted. @@ -7205,7 +7290,7 @@ same hyperlink. This might change in a future VTE version without notice. Emitted whenever the contents of terminal's selection changes. + line="1730">Emitted whenever the contents of terminal's selection changes. @@ -7213,7 +7298,7 @@ same hyperlink. This might change in a future VTE version without notice. Emitted with non-%NULL context before @terminal shows a context menu. + line="2144">Emitted with non-%NULL context before @terminal shows a context menu. The handler may set either a menu model using vte_terminal_set_context_menu_model(), or a menu using vte_terminal_set_context_menu(), which will then be used as context @@ -7235,15 +7320,33 @@ Also emitted with %NULL context after the context menu has been dismissed. allow-none="1"> the context + line="2147">the context + + Emitted right before an interactive shell shows a +first-level prompt. + + + + + + Emitted when the interactive shell has read in a complete +command and is about to execute it. + + + + Emitted when the #VteTerminal:window-title property is modified. + line="1557">Emitted when the #VteTerminal:window-title property is modified. @@ -7749,7 +7852,7 @@ to an output stream. - + diff --git a/girs/WebKit-6.0.gir b/girs/WebKit-6.0.gir index 5360a04a8..810b43306 100644 --- a/girs/WebKit-6.0.gir +++ b/girs/WebKit-6.0.gir @@ -2971,7 +2971,8 @@ or to set the acceptance policy, with webkit_cookie_manager_get_accept_policy(). line="37"/> + version="2.20" + glib:finish-func="add_cookie_finish"> Asynchronously add a #SoupCookie to the underlying storage. @@ -3059,7 +3060,8 @@ webkit_cookie_manager_add_cookie_finish() to get the result of the operation. + version="2.20" + glib:finish-func="delete_cookie_finish"> Asynchronously delete a #SoupCookie from the current session. @@ -3146,7 +3148,8 @@ webkit_cookie_manager_delete_cookie_finish() to get the result of the operation. + c:identifier="webkit_cookie_manager_get_accept_policy" + glib:finish-func="get_accept_policy_finish"> Asynchronously get the cookie acceptance policy of @cookie_manager. @@ -3231,7 +3234,8 @@ webkit_cookie_manager_get_accept_policy_finish() to get the result of the operat + version="2.42" + glib:finish-func="get_all_cookies_finish"> Asynchronously get a list of #SoupCookie from @cookie_manager. @@ -3318,7 +3322,8 @@ with g_list_free_full() and soup_cookie_free(). + version="2.20" + glib:finish-func="get_cookies_finish"> Asynchronously get a list of #SoupCookie from @cookie_manager. @@ -3414,7 +3419,8 @@ with g_list_free_full() and soup_cookie_free(). + version="2.42" + glib:finish-func="replace_cookies_finish"> Asynchronously replace all cookies in @cookie_manager with the given list of @cookies. @@ -4961,7 +4967,8 @@ the in-memory cache during the current execution. + c:identifier="webkit_favicon_database_get_favicon" + glib:finish-func="get_favicon_finish"> Asynchronously obtains a favicon image. @@ -8684,6 +8691,10 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_set_enable_preedit() to + control the use of the preedit string. @@ -8708,6 +8719,13 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_get_preedit() to + retrieve the text currently being preedited for display at the cursor + position. Any input method which composes complex characters or any + other compositions from multiple sequential key presses should override + this method to provide feedback. @@ -8758,6 +8776,16 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_filter_key_event() on every + key press or release event. Every non-trivial input method needs to + override this in order to implement the mapping from key events to text. + A return value of %TRUE indicates to the caller that the event was + consumed by the input method. In that case, the #WebKitInputMethodContext::committed + signal should be emitted upon completion of a key sequence to pass the + resulting text back to the editable element. Alternatively, %FALSE may be + returned to indicate that the event wasn’t handled by the input method. @@ -8785,6 +8813,10 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_notify_focus_in() when + an editable element of the #WebKitWebView has gained focus. @@ -8803,6 +8835,10 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_notify_focus_out() when + an editable element of the #WebKitWebView has lost focus. @@ -8821,6 +8857,11 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_notify_cursor_area() + to inform the input method of the current cursor location relative to + the client window. @@ -8863,6 +8904,11 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_notify_surrounding() to + update the context surrounding the cursor. The provided text should not include + the preedit string. @@ -8905,6 +8951,11 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_reset() to signal a change that + requires a reset. An input method that implements preediting + should override this method to clear the preedit state on reset. @@ -9409,7 +9460,7 @@ against at application run time. line="31"/> - + Like webkit_get_micro_version(), but from the headers used at @@ -10765,7 +10816,8 @@ webkit_web_view_download_uri() instead. + version="2.40" + glib:finish-func="get_itp_summary_finish"> Asynchronously get the list of #WebKitITPThirdParty seen for @session. @@ -12563,7 +12615,7 @@ autoplay policy in this case would be set in the @policies. glib:type-struct="PrintOperationClass"> Controls a print operation. + line="52">Controls a print operation. A #WebKitPrintOperation controls a print operation in WebKit. With a similar API to #GtkPrintOperation, it lets you set the print @@ -12574,20 +12626,20 @@ display the print dialog with webkit_print_operation_run_dialog(). Create a new #WebKitPrintOperation to print @web_view contents. + line="699">Create a new #WebKitPrintOperation to print @web_view contents. a new #WebKitPrintOperation. + line="705">a new #WebKitPrintOperation. a #WebKitWebView + line="701">a #WebKitWebView @@ -12597,7 +12649,7 @@ display the print dialog with webkit_print_operation_run_dialog(). glib:get-property="page-setup"> Return the current page setup of @print_operation. + line="755">Return the current page setup of @print_operation. It returns %NULL until either webkit_print_operation_set_page_setup() or webkit_print_operation_run_dialog() @@ -12607,14 +12659,14 @@ have been called. the current #GtkPageSetup of @print_operation. + line="765">the current #GtkPageSetup of @print_operation. a #WebKitPrintOperation + line="757">a #WebKitPrintOperation @@ -12624,7 +12676,7 @@ have been called. glib:get-property="print-settings"> Return the current print settings of @print_operation. + line="714">Return the current print settings of @print_operation. It returns %NULL until either webkit_print_operation_set_print_settings() or webkit_print_operation_run_dialog() @@ -12634,22 +12686,25 @@ have been called. the current #GtkPrintSettings of @print_operation. + line="724">the current #GtkPrintSettings of @print_operation. a #WebKitPrintOperation + line="716">a #WebKitPrintOperation - + Start a print operation using current print settings and page setup. + line="850">Start a print operation using current print settings and page setup. Start a print operation using current print settings and page setup without showing the print dialog. If either print settings or page setup @@ -12659,6 +12714,7 @@ and the print job will be sent to the default printer. The #WebKitPrintOperation::finished signal is emitted when the printing operation finishes. If an error occurs while printing the signal #WebKitPrintOperation::failed is emitted before #WebKitPrintOperation::finished. + This function does nothing if the app is sandboxed. @@ -12668,7 +12724,7 @@ operation finishes. If an error occurs while printing the signal a #WebKitPrintOperation + line="852">a #WebKitPrintOperation @@ -12677,7 +12733,7 @@ operation finishes. If an error occurs while printing the signal c:identifier="webkit_print_operation_run_dialog"> Run the print dialog and start printing. + line="796">Run the print dialog and start printing. Run the print dialog and start printing using the options selected by the user. This method returns when the print dialog is closed. @@ -12696,7 +12752,7 @@ after this method. the #WebKitPrintOperationResponse of the print dialog + line="816">the #WebKitPrintOperationResponse of the print dialog @@ -12704,7 +12760,7 @@ after this method. a #WebKitPrintOperation + line="798">a #WebKitPrintOperation allow-none="1"> transient parent of the print dialog + line="799">transient parent of the print dialog @@ -12723,7 +12779,7 @@ after this method. glib:set-property="page-setup"> Set the current page setup of @print_operation. + line="774">Set the current page setup of @print_operation. Current page setup is used for the initial values of the print dialog when webkit_print_operation_run_dialog() is called. @@ -12736,13 +12792,13 @@ initial values of the print dialog when webkit_print_operation_run_dialog() is c a #WebKitPrintOperation + line="776">a #WebKitPrintOperation a #GtkPageSetup to set + line="777">a #GtkPageSetup to set @@ -12752,7 +12808,7 @@ initial values of the print dialog when webkit_print_operation_run_dialog() is c glib:set-property="print-settings"> Set the current print settings of @print_operation. + line="733">Set the current print settings of @print_operation. Set the current print settings of @print_operation. Current print settings are used for the initial values of the print dialog when webkit_print_operation_run_dialog() is called. @@ -12765,13 +12821,13 @@ the initial values of the print dialog when webkit_print_operation_run_dialog() a #WebKitPrintOperation + line="735">a #WebKitPrintOperation a #GtkPrintSettings to set + line="736">a #GtkPrintSettings to set @@ -12783,7 +12839,7 @@ the initial values of the print dialog when webkit_print_operation_run_dialog() getter="get_page_setup"> The initial #GtkPageSetup for the print operation. + line="188">The initial #GtkPageSetup for the print operation. The initial #GtkPrintSettings for the print operation. + line="177">The initial #GtkPrintSettings for the print operation. The #WebKitWebView that will be printed. + line="165">The #WebKitWebView that will be printed. Emitted when an error occurs while printing. The given @error, of the domain + line="217">Emitted when an error occurs while printing. The given @error, of the domain %WEBKIT_PRINT_ERROR, contains further details of the failure. The #WebKitPrintOperation::finished signal is emitted after this one. @@ -12818,7 +12874,7 @@ The #WebKitPrintOperation::finished signal is emitted after this one. the #GError that was triggered + line="220">the #GError that was triggered @@ -12826,7 +12882,7 @@ The #WebKitPrintOperation::finished signal is emitted after this one. Emitted when the print operation has finished doing everything + line="202">Emitted when the print operation has finished doing everything required for printing. @@ -19111,7 +19167,8 @@ The path must point to a local filesystem, and will be created if needed. + version="2.24" + glib:finish-func="fetch_identifiers_finish"> Asynchronously retrieve a list of the identifiers for all the stored filters. @@ -19225,7 +19282,8 @@ started with webkit_user_content_filter_store_fetch_identifiers(). + version="2.24" + glib:finish-func="load_finish"> Asynchronously load a content filter given its @identifier. @@ -19319,7 +19377,8 @@ webkit_user_content_filter_store_load(). + version="2.24" + glib:finish-func="remove_finish"> Asynchronously remove a content filter given its @identifier. @@ -19411,7 +19470,8 @@ webkit_user_content_filter_store_remove(). + version="2.24" + glib:finish-func="save_finish"> Asynchronously save a content filter from a set source rule. @@ -19516,7 +19576,8 @@ webkit_user_content_filter_store_save(). + version="2.24" + glib:finish-func="save_from_file_finish"> Asynchronously save a content filter from the contents of a file. @@ -22278,7 +22339,9 @@ webkit_web_resource_get_response(), as well as the raw data, using webkit_web_resource_get_data(). - + Asynchronously get the raw data for @resource. @@ -23032,7 +23095,8 @@ webkit_web_view_new_with_settings(). + version="2.40" + glib:finish-func="call_async_javascript_function_finish"> Asynchronously call @body with @arguments in the script world with name @world_name of the main frame current context in @web_view. @@ -23207,7 +23271,8 @@ web_view_evaluate_promise (WebKitWebView *web_view) + c:identifier="webkit_web_view_can_execute_editing_command" + glib:finish-func="can_execute_editing_command_finish"> Asynchronously check if it is possible to execute the given editing command. @@ -23393,7 +23458,8 @@ webkit_web_view_can_execute_editing_command_finish() to get the result of the op + version="2.40" + glib:finish-func="evaluate_javascript_finish"> Asynchronously evaluate @script in the script world with name @world_name of the main frame current context in @web_view. @@ -24171,7 +24237,9 @@ the settings of a #WebKitWebView would affect other - + Asynchronously retrieves a snapshot of @web_view for @region. @@ -25029,7 +25097,9 @@ using any cached data. - + Asynchronously save the current web page. @@ -25120,7 +25190,9 @@ operation. - + Asynchronously save the current web page. @@ -25218,7 +25290,8 @@ operation. + version="2.28" + glib:finish-func="send_message_to_page_finish"> Send @message to the #WebKitWebPage corresponding to @web_view. @@ -28171,7 +28244,8 @@ period of time. line="39"/> + version="2.16" + glib:finish-func="clear_finish"> Asynchronously clear the website data of the given @types modified in the past @timespan. @@ -28273,7 +28347,8 @@ future. + version="2.16" + glib:finish-func="fetch_finish"> Asynchronously get the list of #WebKitWebsiteData for the given @types. @@ -28466,7 +28541,8 @@ webkit_website_data_manager_fetch_finish() to get the result of the operation. + version="2.30" + glib:finish-func="get_itp_summary_finish"> Asynchronously get the list of #WebKitITPThirdParty seen for @manager. @@ -28583,7 +28659,8 @@ See #WebKitWebsiteDataManager:is-ephemeral for more details. + version="2.16" + glib:finish-func="remove_finish"> Asynchronously removes the website data in the given @website_data list. diff --git a/girs/WebKit2-4.0.gir b/girs/WebKit2-4.0.gir index 5ac6722da..156c7bd86 100644 --- a/girs/WebKit2-4.0.gir +++ b/girs/WebKit2-4.0.gir @@ -3610,7 +3610,8 @@ or to set the acceptance policy, with webkit_cookie_manager_get_accept_policy(). line="50"/> + version="2.20" + glib:finish-func="add_cookie_finish"> Asynchronously add a #SoupCookie to the underlying storage. @@ -3720,7 +3721,8 @@ webkit_cookie_manager_add_cookie_finish() to get the result of the operation. + version="2.20" + glib:finish-func="delete_cookie_finish"> Asynchronously delete a #SoupCookie from the current session. @@ -3835,7 +3837,8 @@ webkit_cookie_manager_delete_cookie_finish() to get the result of the operation. + c:identifier="webkit_cookie_manager_get_accept_policy" + glib:finish-func="get_accept_policy_finish"> Asynchronously get the cookie acceptance policy of @cookie_manager. @@ -3920,7 +3923,8 @@ webkit_cookie_manager_get_accept_policy_finish() to get the result of the operat + version="2.42" + glib:finish-func="get_all_cookies_finish"> Asynchronously get a list of #SoupCookie from @cookie_manager. @@ -4007,7 +4011,8 @@ with g_list_free_full() and soup_cookie_free(). + version="2.20" + glib:finish-func="get_cookies_finish"> Asynchronously get a list of #SoupCookie from @cookie_manager. @@ -4104,7 +4109,8 @@ with g_list_free_full() and soup_cookie_free(). + deprecated-version="2.16" + glib:finish-func="get_domains_with_cookies_finish"> Asynchronously get the list of domains for which @cookie_manager contains cookies. @@ -4195,7 +4201,8 @@ be released with g_strfreev(). + version="2.42" + glib:finish-func="replace_cookies_finish"> Asynchronously replace all cookies in @cookie_manager with the given list of @cookies. @@ -6142,7 +6149,8 @@ the in-memory cache during the current execution. + c:identifier="webkit_favicon_database_get_favicon" + glib:finish-func="get_favicon_finish"> Asynchronously obtains a favicon image. @@ -11433,6 +11441,10 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_set_enable_preedit() to + control the use of the preedit string. @@ -11457,6 +11469,13 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_get_preedit() to + retrieve the text currently being preedited for display at the cursor + position. Any input method which composes complex characters or any + other compositions from multiple sequential key presses should override + this method to provide feedback. @@ -11507,6 +11526,16 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_filter_key_event() on every + key press or release event. Every non-trivial input method needs to + override this in order to implement the mapping from key events to text. + A return value of %TRUE indicates to the caller that the event was + consumed by the input method. In that case, the #WebKitInputMethodContext::committed + signal should be emitted upon completion of a key sequence to pass the + resulting text back to the editable element. Alternatively, %FALSE may be + returned to indicate that the event wasn’t handled by the input method. @@ -11534,6 +11563,10 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_notify_focus_in() when + an editable element of the #WebKitWebView has gained focus. @@ -11552,6 +11585,10 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_notify_focus_out() when + an editable element of the #WebKitWebView has lost focus. @@ -11570,6 +11607,11 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_notify_cursor_area() + to inform the input method of the current cursor location relative to + the client window. @@ -11612,6 +11654,11 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_notify_surrounding() to + update the context surrounding the cursor. The provided text should not include + the preedit string. @@ -11654,6 +11701,11 @@ webkit_input_method_context_get_preedit() returns the empty string. + Called via webkit_input_method_context_reset() to signal a change that + requires a reset. An input method that implements preediting + should override this method to clear the preedit state on reset. @@ -12360,7 +12412,7 @@ against at application run time. - + Like webkit_get_micro_version(), but from the headers used at @@ -24076,7 +24128,8 @@ The path must point to a local filesystem, and will be created if needed. + version="2.24" + glib:finish-func="fetch_identifiers_finish"> Asynchronously retrieve a list of the identifiers for all the stored filters. @@ -24190,7 +24243,8 @@ started with webkit_user_content_filter_store_fetch_identifiers(). + version="2.24" + glib:finish-func="load_finish"> Asynchronously load a content filter given its @identifier. @@ -24284,7 +24338,8 @@ webkit_user_content_filter_store_load(). + version="2.24" + glib:finish-func="remove_finish"> Asynchronously remove a content filter given its @identifier. @@ -24376,7 +24431,8 @@ webkit_user_content_filter_store_remove(). + version="2.24" + glib:finish-func="save_finish"> Asynchronously save a content filter from a set source rule. @@ -24481,7 +24537,8 @@ webkit_user_content_filter_store_save(). + version="2.24" + glib:finish-func="save_from_file_finish"> Asynchronously save a content filter from the contents of a file. @@ -26915,7 +26972,8 @@ database associated with @context, or %NULL. + deprecated-version="2.32" + glib:finish-func="get_plugins_finish"> Asynchronously get the list of installed plugins. @@ -28852,7 +28910,9 @@ webkit_web_resource_get_response(), as well as the raw data, using webkit_web_resource_get_data(). - + Asynchronously get the raw data for @resource. @@ -29796,7 +29856,8 @@ in the view by the user content manager. + version="2.40" + glib:finish-func="call_async_javascript_function_finish"> Asynchronously call @body with @arguments in the script world with name @world_name of the main frame current context in @web_view. @@ -29971,7 +30032,8 @@ web_view_evaluate_promise (WebKitWebView *web_view) + c:identifier="webkit_web_view_can_execute_editing_command" + glib:finish-func="can_execute_editing_command_finish"> Asynchronously check if it is possible to execute the given editing command. @@ -30157,7 +30219,8 @@ webkit_web_view_can_execute_editing_command_finish() to get the result of the op + version="2.40" + glib:finish-func="evaluate_javascript_finish"> Asynchronously evaluate @script in the script world with name @world_name of the main frame current context in @web_view. @@ -30941,7 +31004,9 @@ the settings of a #WebKitWebView would affect other - + Asynchronously retrieves a snapshot of @web_view for @region. @@ -31859,7 +31924,8 @@ using any cached data. c:identifier="webkit_web_view_run_async_javascript_function_in_world" version="2.38" deprecated="1" - deprecated-version="2.40"> + deprecated-version="2.40" + glib:finish-func="webkit_web_view_run_javascript_in_world_finish"> Asynchronously run @body in the script world with name @world_name of the current page context in @@ -31984,7 +32050,8 @@ web_view_evaluate_promise (WebKitWebView *web_view) + deprecated-version="2.40" + glib:finish-func="run_javascript_finish"> Asynchronously run @script in the context of the current page in @web_view. @@ -32124,7 +32191,8 @@ web_view_get_link_url (WebKitWebView *web_view, + deprecated-version="2.40" + glib:finish-func="run_javascript_from_gresource_finish"> Asynchronously run the script from @resource. @@ -32224,7 +32292,8 @@ Check webkit_web_view_run_javascript_finish() for a usage example. c:identifier="webkit_web_view_run_javascript_in_world" version="2.22" deprecated="1" - deprecated-version="2.40"> + deprecated-version="2.40" + glib:finish-func="run_javascript_in_world_finish"> Asynchronously run @script in the script world. @@ -32324,7 +32393,9 @@ webkit_web_view_run_javascript_in_world_finish() to get the result of the operat - + Asynchronously save the current web page. @@ -32415,7 +32486,9 @@ operation. - + Asynchronously save the current web page. @@ -32513,7 +32586,8 @@ operation. + version="2.28" + glib:finish-func="send_message_to_page_finish"> Send @message to the #WebKitWebPage corresponding to @web_view. @@ -35368,7 +35442,8 @@ passing %NULL as the value of @settings. + version="2.16" + glib:finish-func="clear_finish"> Asynchronously clear the website data of the given @types modified in the past @timespan. @@ -35470,7 +35545,8 @@ future. + version="2.16" + glib:finish-func="fetch_finish"> Asynchronously get the list of #WebKitWebsiteData for the given @types. @@ -35803,7 +35879,8 @@ webkit_website_data_manager_fetch_finish() to get the result of the operation. + version="2.30" + glib:finish-func="get_itp_summary_finish"> Asynchronously get the list of #WebKitITPThirdParty seen for @manager. @@ -36082,7 +36159,8 @@ See #WebKitWebsiteDataManager:is-ephemeral for more details. + version="2.16" + glib:finish-func="remove_finish"> Asynchronously removes the website data in the given @website_data list. diff --git a/girs/WebKit2-4.1.gir b/girs/WebKit2-4.1.gir index d67968d3c..be45491b7 100644 --- a/girs/WebKit2-4.1.gir +++ b/girs/WebKit2-4.1.gir @@ -12412,7 +12412,7 @@ against at application run time. - + Like webkit_get_micro_version(), but from the headers used at @@ -16358,7 +16358,7 @@ according to their values. glib:type-struct="PrintOperationClass"> Controls a print operation. + line="52">Controls a print operation. A #WebKitPrintOperation controls a print operation in WebKit. With a similar API to #GtkPrintOperation, it lets you set the print @@ -16369,20 +16369,20 @@ display the print dialog with webkit_print_operation_run_dialog(). Create a new #WebKitPrintOperation to print @web_view contents. + line="699">Create a new #WebKitPrintOperation to print @web_view contents. a new #WebKitPrintOperation. + line="705">a new #WebKitPrintOperation. a #WebKitWebView + line="701">a #WebKitWebView @@ -16392,7 +16392,7 @@ display the print dialog with webkit_print_operation_run_dialog(). glib:get-property="page-setup"> Return the current page setup of @print_operation. + line="755">Return the current page setup of @print_operation. It returns %NULL until either webkit_print_operation_set_page_setup() or webkit_print_operation_run_dialog() @@ -16402,14 +16402,14 @@ have been called. the current #GtkPageSetup of @print_operation. + line="765">the current #GtkPageSetup of @print_operation. a #WebKitPrintOperation + line="757">a #WebKitPrintOperation @@ -16419,7 +16419,7 @@ have been called. glib:get-property="print-settings"> Return the current print settings of @print_operation. + line="714">Return the current print settings of @print_operation. It returns %NULL until either webkit_print_operation_set_print_settings() or webkit_print_operation_run_dialog() @@ -16429,22 +16429,25 @@ have been called. the current #GtkPrintSettings of @print_operation. + line="724">the current #GtkPrintSettings of @print_operation. a #WebKitPrintOperation + line="716">a #WebKitPrintOperation - + Start a print operation using current print settings and page setup. + line="850">Start a print operation using current print settings and page setup. Start a print operation using current print settings and page setup without showing the print dialog. If either print settings or page setup @@ -16454,6 +16457,7 @@ and the print job will be sent to the default printer. The #WebKitPrintOperation::finished signal is emitted when the printing operation finishes. If an error occurs while printing the signal #WebKitPrintOperation::failed is emitted before #WebKitPrintOperation::finished. + This function does nothing if the app is sandboxed. @@ -16463,7 +16467,7 @@ operation finishes. If an error occurs while printing the signal a #WebKitPrintOperation + line="852">a #WebKitPrintOperation @@ -16472,7 +16476,7 @@ operation finishes. If an error occurs while printing the signal c:identifier="webkit_print_operation_run_dialog"> Run the print dialog and start printing. + line="796">Run the print dialog and start printing. Run the print dialog and start printing using the options selected by the user. This method returns when the print dialog is closed. @@ -16491,7 +16495,7 @@ after this method. the #WebKitPrintOperationResponse of the print dialog + line="816">the #WebKitPrintOperationResponse of the print dialog @@ -16499,7 +16503,7 @@ after this method. a #WebKitPrintOperation + line="798">a #WebKitPrintOperation allow-none="1"> transient parent of the print dialog + line="799">transient parent of the print dialog @@ -16518,7 +16522,7 @@ after this method. glib:set-property="page-setup"> Set the current page setup of @print_operation. + line="774">Set the current page setup of @print_operation. Current page setup is used for the initial values of the print dialog when webkit_print_operation_run_dialog() is called. @@ -16531,13 +16535,13 @@ initial values of the print dialog when webkit_print_operation_run_dialog() is c a #WebKitPrintOperation + line="776">a #WebKitPrintOperation a #GtkPageSetup to set + line="777">a #GtkPageSetup to set @@ -16547,7 +16551,7 @@ initial values of the print dialog when webkit_print_operation_run_dialog() is c glib:set-property="print-settings"> Set the current print settings of @print_operation. + line="733">Set the current print settings of @print_operation. Set the current print settings of @print_operation. Current print settings are used for the initial values of the print dialog when webkit_print_operation_run_dialog() is called. @@ -16560,13 +16564,13 @@ the initial values of the print dialog when webkit_print_operation_run_dialog() a #WebKitPrintOperation + line="735">a #WebKitPrintOperation a #GtkPrintSettings to set + line="736">a #GtkPrintSettings to set @@ -16578,7 +16582,7 @@ the initial values of the print dialog when webkit_print_operation_run_dialog() getter="get_page_setup"> The initial #GtkPageSetup for the print operation. + line="188">The initial #GtkPageSetup for the print operation. The initial #GtkPrintSettings for the print operation. + line="177">The initial #GtkPrintSettings for the print operation. The #WebKitWebView that will be printed. + line="165">The #WebKitWebView that will be printed. @@ -16614,21 +16618,21 @@ the initial values of the print dialog when webkit_print_operation_run_dialog() deprecated-version="2.40"> Emitted when displaying the print dialog with webkit_print_operation_run_dialog(). + line="239">Emitted when displaying the print dialog with webkit_print_operation_run_dialog(). The returned #WebKitPrintCustomWidget will be added to the print dialog and it will be owned by the @print_operation. However, the object is guaranteed to be alive until the #WebKitPrintCustomWidget::apply is emitted. A #WebKitPrintCustomWidget that will be embedded in the dialog. + line="248">A #WebKitPrintCustomWidget that will be embedded in the dialog. Emitted when an error occurs while printing. The given @error, of the domain + line="217">Emitted when an error occurs while printing. The given @error, of the domain %WEBKIT_PRINT_ERROR, contains further details of the failure. The #WebKitPrintOperation::finished signal is emitted after this one. @@ -16638,7 +16642,7 @@ The #WebKitPrintOperation::finished signal is emitted after this one. the #GError that was triggered + line="220">the #GError that was triggered @@ -16646,7 +16650,7 @@ The #WebKitPrintOperation::finished signal is emitted after this one. Emitted when the print operation has finished doing everything + line="202">Emitted when the print operation has finished doing everything required for printing. diff --git a/girs/WebKit2WebExtension-4.0.gir b/girs/WebKit2WebExtension-4.0.gir index 9887f0bc9..a3f46c6d0 100644 --- a/girs/WebKit2WebExtension-4.0.gir +++ b/girs/WebKit2WebExtension-4.0.gir @@ -379,7 +379,7 @@ and/or use gtk-doc annotations. --> glib:type-struct="ContextMenuClass"> Represents the context menu in a #WebKitWebView. + line="41">Represents the context menu in a #WebKitWebView. #WebKitContextMenu represents a context menu containing #WebKitContextMenuItem<!-- -->s in a #WebKitWebView. @@ -397,7 +397,7 @@ existing ones with webkit_context_menu_remove_all(). Creates a new #WebKitContextMenu object. + line="135">Creates a new #WebKitContextMenu object. Creates a new #WebKitContextMenu object to be used as a submenu of an existing #WebKitContextMenu. The context menu of a #WebKitWebView is created by the view @@ -411,7 +411,7 @@ a list of initial items. The newly created #WebKitContextMenu object + line="148">The newly created #WebKitContextMenu object @@ -419,7 +419,7 @@ a list of initial items. c:identifier="webkit_context_menu_new_with_items"> Creates a new #WebKitContextMenu object with the given items. + line="155">Creates a new #WebKitContextMenu object with the given items. Creates a new #WebKitContextMenu object to be used as a submenu of an existing #WebKitContextMenu with the given initial items. @@ -429,14 +429,14 @@ See also webkit_context_menu_new() The newly created #WebKitContextMenu object + line="165">The newly created #WebKitContextMenu object a #GList of #WebKitContextMenuItem + line="157">a #GList of #WebKitContextMenuItem @@ -446,7 +446,7 @@ See also webkit_context_menu_new() Adds @item at the end of the @menu. + line="188">Adds @item at the end of the @menu. @@ -456,13 +456,13 @@ See also webkit_context_menu_new() a #WebKitContextMenu + line="190">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="191">the #WebKitContextMenuItem to add @@ -470,13 +470,13 @@ See also webkit_context_menu_new() Gets the first item in the @menu. + line="277">Gets the first item in the @menu. the first #WebKitContextMenuItem of @menu, + line="283">the first #WebKitContextMenuItem of @menu, or %NULL if the #WebKitContextMenu is empty. @@ -484,7 +484,7 @@ See also webkit_context_menu_new() a #WebKitContextMenu + line="279">a #WebKitContextMenu @@ -494,7 +494,7 @@ See also webkit_context_menu_new() version="2.40"> Gets the #GdkEvent that triggered the context menu. This function only returns a valid + line="405">Gets the #GdkEvent that triggered the context menu. This function only returns a valid #GdkEvent when called for a #WebKitContextMenu passed to #WebKitWebView::context-menu signal; in all other cases, %NULL is returned. @@ -515,14 +515,14 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal the menu event or %NULL. + line="426">the menu event or %NULL. a #WebKitContextMenu + line="407">a #WebKitContextMenu @@ -531,13 +531,13 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal c:identifier="webkit_context_menu_get_item_at_position"> Gets the item at the given position in the @menu. + line="310">Gets the item at the given position in the @menu. the #WebKitContextMenuItem at position @position in @menu, + line="317">the #WebKitContextMenuItem at position @position in @menu, or %NULL if the position is off the end of the @menu. @@ -545,13 +545,13 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal a #WebKitContextMenu + line="312">a #WebKitContextMenu the position of the item, counting from 0 + line="313">the position of the item, counting from 0 @@ -559,13 +559,13 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal Returns the item list of @menu. + line="246">Returns the item list of @menu. a #GList of + line="252">a #GList of #WebKitContextMenuItem<!-- -->s @@ -575,7 +575,7 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal a #WebKitContextMenu + line="248">a #WebKitContextMenu @@ -584,20 +584,20 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal c:identifier="webkit_context_menu_get_n_items"> Gets the length of the @menu. + line="262">Gets the length of the @menu. the number of #WebKitContextMenuItem<!-- -->s in @menu + line="268">the number of #WebKitContextMenuItem<!-- -->s in @menu a #WebKitContextMenu + line="264">a #WebKitContextMenu @@ -607,7 +607,7 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal version="2.8"> Gets the user data of @menu. + line="384">Gets the user data of @menu. This function can be used from the UI Process to get user data previously set from the Web Process with webkit_context_menu_set_user_data(). @@ -616,14 +616,14 @@ from the Web Process with webkit_context_menu_set_user_data(). the user data of @menu, or %NULL if @menu doesn't have user data + line="393">the user data of @menu, or %NULL if @menu doesn't have user data a #WebKitContextMenu + line="386">a #WebKitContextMenu @@ -631,7 +631,7 @@ from the Web Process with webkit_context_menu_set_user_data(). Inserts @item into the @menu at the given position. + line="200">Inserts @item into the @menu at the given position. If @position is negative, or is larger than the number of items in the #WebKitContextMenu, the item is added on to the end of @@ -645,19 +645,19 @@ the @menu. The first position is 0. a #WebKitContextMenu + line="202">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="203">the #WebKitContextMenuItem to add the position to insert the item + line="204">the position to insert the item @@ -665,13 +665,13 @@ the @menu. The first position is 0. Gets the last item in the @menu. + line="293">Gets the last item in the @menu. the last #WebKitContextMenuItem of @menu, + line="299">the last #WebKitContextMenuItem of @menu, or %NULL if the #WebKitContextMenu is empty. @@ -679,7 +679,7 @@ the @menu. The first position is 0. a #WebKitContextMenu + line="295">a #WebKitContextMenu @@ -687,7 +687,7 @@ the @menu. The first position is 0. Moves @item to the given position in the @menu. + line="221">Moves @item to the given position in the @menu. If @position is negative, or is larger than the number of items in the #WebKitContextMenu, the item is added on to the end of @@ -702,19 +702,19 @@ The first position is 0. a #WebKitContextMenu + line="223">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="224">the #WebKitContextMenuItem to add the new position to move the item + line="225">the new position to move the item @@ -722,7 +722,7 @@ The first position is 0. Adds @item at the beginning of the @menu. + line="176">Adds @item at the beginning of the @menu. @@ -732,13 +732,13 @@ The first position is 0. a #WebKitContextMenu + line="178">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="179">the #WebKitContextMenuItem to add @@ -746,7 +746,7 @@ The first position is 0. Removes @item from the @menu. + line="328">Removes @item from the @menu. See also webkit_context_menu_remove_all() to remove all items. a #WebKitContextMenu + line="330">a #WebKitContextMenu the #WebKitContextMenuItem to remove + line="331">the #WebKitContextMenuItem to remove @@ -772,7 +772,7 @@ See also webkit_context_menu_remove_all() to remove all items. Removes all items of the @menu. + line="349">Removes all items of the @menu. @@ -782,7 +782,7 @@ See also webkit_context_menu_remove_all() to remove all items. a #WebKitContextMenu + line="351">a #WebKitContextMenu @@ -792,7 +792,7 @@ See also webkit_context_menu_remove_all() to remove all items. version="2.8"> Sets user data to @menu. + line="363">Sets user data to @menu. This function can be used from a Web Process extension to set user data that can be retrieved from the UI Process using webkit_context_menu_get_user_data(). @@ -806,13 +806,13 @@ If the @user_data #GVariant is floating, it is consumed. a #WebKitContextMenu + line="365">a #WebKitContextMenu a #GVariant + line="366">a #GVariant @@ -1215,7 +1215,7 @@ If the @user_data #GVariant is floating, it is consumed. glib:type-struct="ContextMenuItemClass"> One item of a #WebKitContextMenu. + line="41">One item of a #WebKitContextMenu. The #WebKitContextMenu is composed of #WebKitContextMenuItem<!-- -->s. These items can be created from a #GtkAction, from a @@ -1230,21 +1230,21 @@ for the items. You can also create separators and submenus. deprecated-version="2.18"> Creates a new #WebKitContextMenuItem for the given @action. + line="136">Creates a new #WebKitContextMenuItem for the given @action. Use webkit_context_menu_item_new_from_gaction() instead. the newly created #WebKitContextMenuItem object. + line="142">the newly created #WebKitContextMenuItem object. a #GtkAction + line="138">a #GtkAction @@ -1254,7 +1254,7 @@ for the items. You can also create separators and submenus. version="2.18"> Creates a new #WebKitContextMenuItem for the given @action and @label. + line="159">Creates a new #WebKitContextMenuItem for the given @action and @label. On activation @target will be passed as parameter to the callback. @@ -1263,20 +1263,20 @@ On activation the newly created #WebKitContextMenuItem object. + line="170">the newly created #WebKitContextMenuItem object. a #GAction + line="161">a #GAction the menu item label text + line="162">the menu item label text a #GVariant to use as the action target + line="163">a #GVariant to use as the action target @@ -1294,7 +1294,7 @@ On activation c:identifier="webkit_context_menu_item_new_from_stock_action"> Creates a new #WebKitContextMenuItem for the given stock action. + line="189">Creates a new #WebKitContextMenuItem for the given stock action. Stock actions are handled automatically by WebKit so that, for example, when a menu item created with a %WEBKIT_CONTEXT_MENU_ACTION_STOP is @@ -1309,14 +1309,14 @@ action from being performed. the newly created #WebKitContextMenuItem object. + line="204">the newly created #WebKitContextMenuItem object. a #WebKitContextMenuAction stock action + line="191">a #WebKitContextMenuAction stock action @@ -1325,7 +1325,7 @@ action from being performed. c:identifier="webkit_context_menu_item_new_from_stock_action_with_label"> Creates a new #WebKitContextMenuItem for the given stock action using the given @label. + line="219">Creates a new #WebKitContextMenuItem for the given stock action using the given @label. Stock actions have a predefined label, this method can be used to create a #WebKitContextMenuItem for a #WebKitContextMenuAction but using a custom label. @@ -1334,20 +1334,20 @@ Stock actions have a predefined label, this method can be used to create a the newly created #WebKitContextMenuItem object. + line="229">the newly created #WebKitContextMenuItem object. a #WebKitContextMenuAction stock action + line="221">a #WebKitContextMenuAction stock action a custom label text to use instead of the predefined one + line="222">a custom label text to use instead of the predefined one @@ -1356,13 +1356,13 @@ Stock actions have a predefined label, this method can be used to create a c:identifier="webkit_context_menu_item_new_separator"> Creates a new #WebKitContextMenuItem representing a separator. + line="273">Creates a new #WebKitContextMenuItem representing a separator. the newly created #WebKitContextMenuItem object. + line="278">the newly created #WebKitContextMenuItem object. @@ -1370,26 +1370,26 @@ Stock actions have a predefined label, this method can be used to create a c:identifier="webkit_context_menu_item_new_with_submenu"> Creates a new #WebKitContextMenuItem using the given @label with a submenu. + line="244">Creates a new #WebKitContextMenuItem using the given @label with a submenu. the newly created #WebKitContextMenuItem object. + line="251">the newly created #WebKitContextMenuItem object. the menu item label text + line="246">the menu item label text a #WebKitContextMenu to set + line="247">a #WebKitContextMenu to set @@ -1400,14 +1400,14 @@ Stock actions have a predefined label, this method can be used to create a deprecated-version="2.18"> Gets the action associated to @item as a #GtkAction. + line="291">Gets the action associated to @item as a #GtkAction. Use webkit_context_menu_item_get_gaction() instead. the #GtkAction associated to the #WebKitContextMenuItem, + line="297">the #GtkAction associated to the #WebKitContextMenuItem, or %NULL if @item is a separator. @@ -1415,7 +1415,7 @@ Stock actions have a predefined label, this method can be used to create a a #WebKitContextMenuItem + line="293">a #WebKitContextMenuItem @@ -1425,13 +1425,13 @@ Stock actions have a predefined label, this method can be used to create a version="2.18"> Gets the action associated to @item as a #GAction. + line="314">Gets the action associated to @item as a #GAction. the #GAction associated to the #WebKitContextMenuItem, + line="320">the #GAction associated to the #WebKitContextMenuItem, or %NULL if @item is a separator. @@ -1439,7 +1439,7 @@ Stock actions have a predefined label, this method can be used to create a a #WebKitContextMenuItem + line="316">a #WebKitContextMenuItem @@ -1448,7 +1448,7 @@ Stock actions have a predefined label, this method can be used to create a c:identifier="webkit_context_menu_item_get_stock_action"> Gets the #WebKitContextMenuAction of @item. + line="336">Gets the #WebKitContextMenuAction of @item. If the #WebKitContextMenuItem was not created for a stock action %WEBKIT_CONTEXT_MENU_ACTION_CUSTOM will be @@ -1459,14 +1459,14 @@ will be returned. the #WebKitContextMenuAction of @item + line="347">the #WebKitContextMenuAction of @item a #WebKitContextMenuItem + line="338">a #WebKitContextMenuItem @@ -1475,13 +1475,13 @@ will be returned. c:identifier="webkit_context_menu_item_get_submenu"> Gets the submenu of @item. + line="401">Gets the submenu of @item. the #WebKitContextMenu representing the submenu of + line="407">the #WebKitContextMenu representing the submenu of @item or %NULL if @item doesn't have a submenu. @@ -1489,7 +1489,7 @@ will be returned. a #WebKitContextMenuItem + line="403">a #WebKitContextMenuItem @@ -1498,20 +1498,20 @@ will be returned. c:identifier="webkit_context_menu_item_is_separator"> Checks whether @item is a separator. + line="360">Checks whether @item is a separator. %TRUE is @item is a separator or %FALSE otherwise + line="366">%TRUE is @item is a separator or %FALSE otherwise a #WebKitContextMenuItem + line="362">a #WebKitContextMenuItem @@ -1520,7 +1520,7 @@ will be returned. c:identifier="webkit_context_menu_item_set_submenu"> Sets or replaces the @item submenu. + line="379">Sets or replaces the @item submenu. If @submenu is %NULL the current submenu of @item is removed. @@ -1533,7 +1533,7 @@ submenu of @item is removed. a #WebKitContextMenuItem + line="381">a #WebKitContextMenuItem allow-none="1"> a #WebKitContextMenu + line="382">a #WebKitContextMenu @@ -47919,7 +47919,8 @@ int main (int argc, char **argv) + version="2.28" + glib:finish-func="send_message_to_context_finish"> Send @message to the #WebKitWebContext corresponding to @extension. If @message is floating, it's consumed. @@ -48488,14 +48489,14 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. deprecated-version="2.40."> Get the #WebKitDOMDocument currently loaded in @web_page + line="826">Get the #WebKitDOMDocument currently loaded in @web_page Use JavaScriptCore API instead. the #WebKitDOMDocument currently loaded, or %NULL + line="832">the #WebKitDOMDocument currently loaded, or %NULL if no document is currently loaded. @@ -48503,7 +48504,7 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. a #WebKitWebPage + line="828">a #WebKitWebPage @@ -48513,20 +48514,20 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. version="2.10"> Gets the #WebKitWebEditor of a #WebKitWebPage. + line="899">Gets the #WebKitWebEditor of a #WebKitWebPage. the #WebKitWebEditor + line="905">the #WebKitWebEditor a #WebKitWebPage + line="901">a #WebKitWebPage @@ -48536,20 +48537,20 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. version="2.40"> Get the #WebKitWebFormManager of @web_page in @world. + line="984">Get the #WebKitWebFormManager of @web_page in @world. a #WebKitWebFormManager + line="991">a #WebKitWebFormManager a #WebKitWebPage + line="986">a #WebKitWebPage allow-none="1"> a #WebKitScriptWorld + line="987">a #WebKitScriptWorld @@ -48566,20 +48567,20 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. Get the identifier of the #WebKitWebPage + line="848">Get the identifier of the #WebKitWebPage the identifier of @web_page + line="854">the identifier of @web_page a #WebKitWebPage + line="850">a #WebKitWebPage @@ -48589,20 +48590,20 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. version="2.2"> Returns the main frame of a #WebKitWebPage. + line="882">Returns the main frame of a #WebKitWebPage. the #WebKitFrame that is the main frame of @web_page + line="888">the #WebKitFrame that is the main frame of @web_page a #WebKitWebPage + line="884">a #WebKitWebPage @@ -48612,7 +48613,7 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. glib:get-property="uri"> Returns the current active URI of @web_page. + line="863">Returns the current active URI of @web_page. You can monitor the active URI by connecting to the notify::uri signal of @web_page. @@ -48621,7 +48622,7 @@ signal of @web_page. the current active URI of @web_view or %NULL if nothing has been + line="872">the current active URI of @web_view or %NULL if nothing has been loaded yet. @@ -48629,17 +48630,18 @@ signal of @web_page. a #WebKitWebPage + line="865">a #WebKitWebPage + version="2.28" + glib:finish-func="send_message_to_view_finish"> Send @message to the #WebKitWebView corresponding to @web_page. If @message is floating, it's consumed. + line="919">Send @message to the #WebKitWebView corresponding to @web_page. If @message is floating, it's consumed. If you don't expect any reply, or you simply want to ignore it, you can pass %NULL as @callback. When the operation is finished, @callback will be called. You can then call @@ -48653,13 +48655,13 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. a #WebKitWebPage + line="921">a #WebKitWebPage a #WebKitUserMessage + line="922">a #WebKitUserMessage allow-none="1"> a #GCancellable or %NULL to ignore + line="923">a #GCancellable or %NULL to ignore closure="3"> A #GAsyncReadyCallback to call when the request is satisfied or %NULL + line="924">A #GAsyncReadyCallback to call when the request is satisfied or %NULL allow-none="1"> the data to pass to callback function + line="925">the data to pass to callback function @@ -48699,26 +48701,26 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. throws="1"> Finish an asynchronous operation started with webkit_web_page_send_message_to_view(). + line="964">Finish an asynchronous operation started with webkit_web_page_send_message_to_view(). a #WebKitUserMessage with the reply or %NULL in case of error. + line="972">a #WebKitUserMessage with the reply or %NULL in case of error. a #WebKitWebPage + line="966">a #WebKitWebPage a #GAsyncResult + line="967">a #GAsyncResult @@ -48729,7 +48731,7 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. default-value="NULL"> The current active URI of the #WebKitWebPage. + line="513">The current active URI of the #WebKitWebPage. @@ -48745,7 +48747,7 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. deprecated-version="2.40"> Emitted when a message is sent to the console. This can be a message + line="615">Emitted when a message is sent to the console. This can be a message produced by the use of JavaScript console API, a JavaScript exception, a security error or other errors, warnings, debug or log messages. The @console_message contains information of the message. @@ -48756,7 +48758,7 @@ The @console_message contains information of the message. the #WebKitConsoleMessage + line="618">the #WebKitConsoleMessage @@ -48764,7 +48766,7 @@ The @console_message contains information of the message. Emitted before a context menu is displayed in the UI Process to + line="579">Emitted before a context menu is displayed in the UI Process to give the application a chance to customize the proposed menu, build its own context menu or pass user data to the UI Process. This signal is useful when the information available in the UI Process @@ -48775,20 +48777,20 @@ signal instead. %TRUE if the proposed @context_menu has been modified, or %FALSE otherwise. + line="594">%TRUE if the proposed @context_menu has been modified, or %FALSE otherwise. the proposed #WebKitContextMenu + line="582">the proposed #WebKitContextMenu a #WebKitWebHitTestResult + line="583">a #WebKitWebHitTestResult @@ -48796,7 +48798,7 @@ signal instead. This signal is emitted when the DOM document of a #WebKitWebPage has been + line="527">This signal is emitted when the DOM document of a #WebKitWebPage has been loaded. You can wait for this signal to get the DOM document @@ -48811,7 +48813,7 @@ You can wait for this signal to get the DOM document deprecated-version="2.26"> Emitted after form elements (or form associated elements) are associated to a particular web + line="642">Emitted after form elements (or form associated elements) are associated to a particular web page. This is useful to implement form auto filling for web pages where form fields are added dynamically. This signal might be emitted multiple times for the same web page. @@ -48828,7 +48830,7 @@ keep them alive after the signal handler returns. a #GPtrArray of + line="645">a #GPtrArray of #WebKitDOMElement with the list of forms in the page @@ -48843,7 +48845,7 @@ keep them alive after the signal handler returns. deprecated-version="2.40"> Emitted after form elements (or form associated elements) are associated to a particular web + line="671">Emitted after form elements (or form associated elements) are associated to a particular web page. This is useful to implement form auto filling for web pages where form fields are added dynamically. This signal might be emitted multiple times for the same web page. @@ -48860,7 +48862,7 @@ keep them alive after the signal handler returns. a #GPtrArray of + line="674">a #GPtrArray of #WebKitDOMElement with the list of forms in the page @@ -48869,7 +48871,7 @@ keep them alive after the signal handler returns. the #WebKitFrame + line="676">the #WebKitFrame @@ -48877,7 +48879,7 @@ keep them alive after the signal handler returns. This signal is emitted when @request is about to be sent to + line="544">This signal is emitted when @request is about to be sent to the server. This signal can be used to modify the #WebKitURIRequest that will be sent to the server. You can also cancel the resource load operation by connecting to this signal and returning %TRUE. @@ -48894,7 +48896,7 @@ is sent over the network. %TRUE to stop other handlers from being invoked for the event. + line="565">%TRUE to stop other handlers from being invoked for the event. %FALSE to continue emission of the event. @@ -48902,13 +48904,13 @@ is sent over the network. a #WebKitURIRequest + line="547">a #WebKitURIRequest a #WebKitURIResponse, or %NULL + line="548">a #WebKitURIResponse, or %NULL @@ -48916,7 +48918,7 @@ is sent over the network. This signal is emitted when a #WebKitUserMessage is received from the + line="765">This signal is emitted when a #WebKitUserMessage is received from the #WebKitWebView corresponding to @web_page. You can reply to the message using webkit_user_message_send_reply(). @@ -48927,14 +48929,14 @@ finish with error %WEBKIT_USER_MESSAGE_UNHANDLED_MESSAGE. %TRUE if the message was handled, or %FALSE otherwise. + line="779">%TRUE if the message was handled, or %FALSE otherwise. the #WebKitUserMessage received + line="768">the #WebKitUserMessage received @@ -48946,7 +48948,7 @@ finish with error %WEBKIT_USER_MESSAGE_UNHANDLED_MESSAGE. deprecated-version="2.40"> This signal is emitted to indicate various points during form + line="702">This signal is emitted to indicate various points during form submission. @step indicates the current stage of form submission. If this signal is emitted with %WEBKIT_FORM_SUBMISSION_WILL_SEND_DOM_EVENT, @@ -48981,34 +48983,34 @@ emitted. the #WebKitDOMElement to be submitted, which will always correspond to an HTMLFormElement + line="705">the #WebKitDOMElement to be submitted, which will always correspond to an HTMLFormElement a #WebKitFormSubmissionEventType indicating the current + line="706">a #WebKitFormSubmissionEventType indicating the current stage of form submission the #WebKitFrame containing the form to be + line="708">the #WebKitFrame containing the form to be submitted the #WebKitFrame containing the form's target, + line="710">the #WebKitFrame containing the form's target, which may be the same as @source_frame if no target was specified names of + line="712">names of the form's text fields @@ -49017,7 +49019,7 @@ the form's text fields values + line="714">values of the form's text fields diff --git a/girs/WebKit2WebExtension-4.1.gir b/girs/WebKit2WebExtension-4.1.gir index 70b5d2a62..965cbebd1 100644 --- a/girs/WebKit2WebExtension-4.1.gir +++ b/girs/WebKit2WebExtension-4.1.gir @@ -19,7 +19,7 @@ and/or use gtk-doc annotations. --> - @@ -29,7 +29,7 @@ and/or use gtk-doc annotations. --> - @@ -39,7 +39,7 @@ and/or use gtk-doc annotations. --> - @@ -49,7 +49,7 @@ and/or use gtk-doc annotations. --> - @@ -59,7 +59,7 @@ and/or use gtk-doc annotations. --> - @@ -69,7 +69,7 @@ and/or use gtk-doc annotations. --> - @@ -82,7 +82,7 @@ and/or use gtk-doc annotations. --> glib:type-name="WebKitConsoleMessage" glib:get-type="webkit_console_message_get_type" c:symbol-prefix="console_message"> - Make a copy of @console_message. - Free the #WebKitConsoleMessage - @@ -139,7 +139,7 @@ and/or use gtk-doc annotations. --> Gets the log level of a #WebKitConsoleMessage - Gets the line number of a #WebKitConsoleMessage - Gets the source of a #WebKitConsoleMessage - Gets the source identifier of a #WebKitConsoleMessage - Gets the text message of a #WebKitConsoleMessage - glib:get-type="webkit_console_message_level_get_type" c:type="WebKitConsoleMessageLevel"> Enum values used to denote the various levels of console messages. glib:nick="info" glib:name="WEBKIT_CONSOLE_MESSAGE_LEVEL_INFO"> Information message. glib:nick="log" glib:name="WEBKIT_CONSOLE_MESSAGE_LEVEL_LOG"> Log message. glib:nick="warning" glib:name="WEBKIT_CONSOLE_MESSAGE_LEVEL_WARNING"> Warning message. glib:nick="error" glib:name="WEBKIT_CONSOLE_MESSAGE_LEVEL_ERROR"> Error message. glib:nick="debug" glib:name="WEBKIT_CONSOLE_MESSAGE_LEVEL_DEBUG"> Debug message. @@ -322,7 +322,7 @@ and/or use gtk-doc annotations. --> glib:get-type="webkit_console_message_source_get_type" c:type="WebKitConsoleMessageSource"> Enum values used to denote the various sources of console messages. glib:nick="javascript" glib:name="WEBKIT_CONSOLE_MESSAGE_SOURCE_JAVASCRIPT"> Message produced by JavaScript. glib:nick="network" glib:name="WEBKIT_CONSOLE_MESSAGE_SOURCE_NETWORK"> Network messages. glib:nick="console-api" glib:name="WEBKIT_CONSOLE_MESSAGE_SOURCE_CONSOLE_API"> Messages produced by console API. glib:nick="security" glib:name="WEBKIT_CONSOLE_MESSAGE_SOURCE_SECURITY"> Security messages. glib:nick="other" glib:name="WEBKIT_CONSOLE_MESSAGE_SOURCE_OTHER"> Other messages. @@ -379,7 +379,7 @@ and/or use gtk-doc annotations. --> glib:type-struct="ContextMenuClass"> Represents the context menu in a #WebKitWebView. + line="41">Represents the context menu in a #WebKitWebView. #WebKitContextMenu represents a context menu containing #WebKitContextMenuItem<!-- -->s in a #WebKitWebView. @@ -392,12 +392,12 @@ new #WebKitContextMenuItem<!-- -->s with webkit_context_menu_prepend(), webkit_context_menu_append() or webkit_context_menu_insert(), maybe after having removed the existing ones with webkit_context_menu_remove_all(). - Creates a new #WebKitContextMenu object. + line="135">Creates a new #WebKitContextMenu object. Creates a new #WebKitContextMenu object to be used as a submenu of an existing #WebKitContextMenu. The context menu of a #WebKitWebView is created by the view @@ -406,12 +406,12 @@ To add items to the menu use webkit_context_menu_prepend(), webkit_context_menu_append() or webkit_context_menu_insert(). See also webkit_context_menu_new_with_items() to create a #WebKitContextMenu with a list of initial items. - The newly created #WebKitContextMenu object + line="148">The newly created #WebKitContextMenu object @@ -419,24 +419,24 @@ a list of initial items. c:identifier="webkit_context_menu_new_with_items"> Creates a new #WebKitContextMenu object with the given items. + line="155">Creates a new #WebKitContextMenu object with the given items. Creates a new #WebKitContextMenu object to be used as a submenu of an existing #WebKitContextMenu with the given initial items. See also webkit_context_menu_new() - The newly created #WebKitContextMenu object + line="165">The newly created #WebKitContextMenu object a #GList of #WebKitContextMenuItem + line="157">a #GList of #WebKitContextMenuItem @@ -446,8 +446,8 @@ See also webkit_context_menu_new() Adds @item at the end of the @menu. - Adds @item at the end of the @menu. + @@ -456,13 +456,13 @@ See also webkit_context_menu_new() a #WebKitContextMenu + line="190">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="191">the #WebKitContextMenuItem to add @@ -470,13 +470,13 @@ See also webkit_context_menu_new() Gets the first item in the @menu. - Gets the first item in the @menu. + the first #WebKitContextMenuItem of @menu, + line="283">the first #WebKitContextMenuItem of @menu, or %NULL if the #WebKitContextMenu is empty. @@ -484,7 +484,7 @@ See also webkit_context_menu_new() a #WebKitContextMenu + line="279">a #WebKitContextMenu @@ -494,7 +494,7 @@ See also webkit_context_menu_new() version="2.40"> Gets the #GdkEvent that triggered the context menu. This function only returns a valid + line="405">Gets the #GdkEvent that triggered the context menu. This function only returns a valid #GdkEvent when called for a #WebKitContextMenu passed to #WebKitWebView::context-menu signal; in all other cases, %NULL is returned. @@ -510,19 +510,19 @@ a #GdkEventKey of type %GDK_KEY_PRESS if the keyboard was used to show the menu. a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal was used to show the context menu. </para></listitem> </itemizedlist> - the menu event or %NULL. + line="426">the menu event or %NULL. a #WebKitContextMenu + line="407">a #WebKitContextMenu @@ -531,13 +531,13 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal c:identifier="webkit_context_menu_get_item_at_position"> Gets the item at the given position in the @menu. - Gets the item at the given position in the @menu. + the #WebKitContextMenuItem at position @position in @menu, + line="317">the #WebKitContextMenuItem at position @position in @menu, or %NULL if the position is off the end of the @menu. @@ -545,13 +545,13 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal a #WebKitContextMenu + line="312">a #WebKitContextMenu the position of the item, counting from 0 + line="313">the position of the item, counting from 0 @@ -559,13 +559,13 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal Returns the item list of @menu. - Returns the item list of @menu. + a #GList of + line="252">a #GList of #WebKitContextMenuItem<!-- -->s @@ -575,7 +575,7 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal a #WebKitContextMenu + line="248">a #WebKitContextMenu @@ -584,20 +584,20 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal c:identifier="webkit_context_menu_get_n_items"> Gets the length of the @menu. - Gets the length of the @menu. + the number of #WebKitContextMenuItem<!-- -->s in @menu + line="268">the number of #WebKitContextMenuItem<!-- -->s in @menu a #WebKitContextMenu + line="264">a #WebKitContextMenu @@ -607,23 +607,23 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal version="2.8"> Gets the user data of @menu. + line="384">Gets the user data of @menu. This function can be used from the UI Process to get user data previously set from the Web Process with webkit_context_menu_set_user_data(). - the user data of @menu, or %NULL if @menu doesn't have user data + line="393">the user data of @menu, or %NULL if @menu doesn't have user data a #WebKitContextMenu + line="386">a #WebKitContextMenu @@ -631,12 +631,12 @@ from the Web Process with webkit_context_menu_set_user_data(). Inserts @item into the @menu at the given position. + line="200">Inserts @item into the @menu at the given position. If @position is negative, or is larger than the number of items in the #WebKitContextMenu, the item is added on to the end of the @menu. The first position is 0. - @@ -645,19 +645,19 @@ the @menu. The first position is 0. a #WebKitContextMenu + line="202">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="203">the #WebKitContextMenuItem to add the position to insert the item + line="204">the position to insert the item @@ -665,13 +665,13 @@ the @menu. The first position is 0. Gets the last item in the @menu. - Gets the last item in the @menu. + the last #WebKitContextMenuItem of @menu, + line="299">the last #WebKitContextMenuItem of @menu, or %NULL if the #WebKitContextMenu is empty. @@ -679,7 +679,7 @@ the @menu. The first position is 0. a #WebKitContextMenu + line="295">a #WebKitContextMenu @@ -687,13 +687,13 @@ the @menu. The first position is 0. Moves @item to the given position in the @menu. + line="221">Moves @item to the given position in the @menu. If @position is negative, or is larger than the number of items in the #WebKitContextMenu, the item is added on to the end of the @menu. The first position is 0. - @@ -702,19 +702,19 @@ The first position is 0. a #WebKitContextMenu + line="223">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="224">the #WebKitContextMenuItem to add the new position to move the item + line="225">the new position to move the item @@ -722,8 +722,8 @@ The first position is 0. Adds @item at the beginning of the @menu. - Adds @item at the beginning of the @menu. + @@ -732,13 +732,13 @@ The first position is 0. a #WebKitContextMenu + line="178">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="179">the #WebKitContextMenuItem to add @@ -746,10 +746,10 @@ The first position is 0. Removes @item from the @menu. + line="328">Removes @item from the @menu. See also webkit_context_menu_remove_all() to remove all items. - @@ -758,13 +758,13 @@ See also webkit_context_menu_remove_all() to remove all items. a #WebKitContextMenu + line="330">a #WebKitContextMenu the #WebKitContextMenuItem to remove + line="331">the #WebKitContextMenuItem to remove @@ -772,8 +772,8 @@ See also webkit_context_menu_remove_all() to remove all items. Removes all items of the @menu. - Removes all items of the @menu. + @@ -782,7 +782,7 @@ See also webkit_context_menu_remove_all() to remove all items. a #WebKitContextMenu + line="351">a #WebKitContextMenu @@ -792,12 +792,12 @@ See also webkit_context_menu_remove_all() to remove all items. version="2.8"> Sets user data to @menu. + line="363">Sets user data to @menu. This function can be used from a Web Process extension to set user data that can be retrieved from the UI Process using webkit_context_menu_get_user_data(). If the @user_data #GVariant is floating, it is consumed. - @@ -806,13 +806,13 @@ If the @user_data #GVariant is floating, it is consumed. a #WebKitContextMenu + line="365">a #WebKitContextMenu a #GVariant + line="366">a #GVariant @@ -826,352 +826,352 @@ If the @user_data #GVariant is floating, it is consumed. Enum values used to denote the stock actions for #WebKitContextMenuItem<!-- -->s - No action, used by separator menu items. Open current link. Open current link in a new window. Download link destination. Copy link location to the clipboard. Open current image in a new window. Download current image. Copy current image to the clipboard. Copy current image location to the clipboard. Open current frame in a new window. Load the previous history item. Load the next history item. Stop any ongoing loading operation. Reload the contents of current view. Copy current selection the clipboard. Cut current selection to the clipboard. Paste clipboard contents. Delete current selection. Select all text. Input methods menu. Unicode menu. A proposed replacement for a misspelled word. An indicator that spellchecking found no proposed replacements. Causes the spellchecker to ignore the word for this session. Causes the spellchecker to add the word to the dictionary. Ignore grammar. Font options menu. Bold. Italic. Underline. Outline. Open current element in the inspector. Open current video element in a new window. Open current audio element in a new window. Copy video link location in to the clipboard. Copy audio link location in to the clipboard. Enable or disable media controls. Enable or disable media loop. Show current video element in fullscreen mode. Play current media element. Pause current media element. Mute current media element. Download video to disk. Since 2.2 Download audio to disk. Since 2.2 Insert an emoji. Since 2.26 Paste clipboard contents as plain text. Since 2.30 Custom action defined by applications. - - @@ -1180,7 +1180,7 @@ If the @user_data #GVariant is floating, it is consumed. - @@ -1189,7 +1189,7 @@ If the @user_data #GVariant is floating, it is consumed. - @@ -1198,7 +1198,7 @@ If the @user_data #GVariant is floating, it is consumed. - @@ -1215,14 +1215,14 @@ If the @user_data #GVariant is floating, it is consumed. glib:type-struct="ContextMenuItemClass"> One item of a #WebKitContextMenu. + line="41">One item of a #WebKitContextMenu. The #WebKitContextMenu is composed of #WebKitContextMenuItem<!-- -->s. These items can be created from a #GtkAction, from a #WebKitContextMenuAction or from a #WebKitContextMenuAction and a label. These #WebKitContextMenuAction<!-- -->s denote stock actions for the items. You can also create separators and submenus. - deprecated-version="2.18"> Creates a new #WebKitContextMenuItem for the given @action. + line="136">Creates a new #WebKitContextMenuItem for the given @action. Use webkit_context_menu_item_new_from_gaction() instead. - the newly created #WebKitContextMenuItem object. + line="142">the newly created #WebKitContextMenuItem object. a #GtkAction + line="138">a #GtkAction @@ -1254,29 +1254,29 @@ for the items. You can also create separators and submenus. version="2.18"> Creates a new #WebKitContextMenuItem for the given @action and @label. + line="159">Creates a new #WebKitContextMenuItem for the given @action and @label. On activation @target will be passed as parameter to the callback. - the newly created #WebKitContextMenuItem object. + line="170">the newly created #WebKitContextMenuItem object. a #GAction + line="161">a #GAction the menu item label text + line="162">the menu item label text a #GVariant to use as the action target + line="163">a #GVariant to use as the action target @@ -1294,7 +1294,7 @@ On activation c:identifier="webkit_context_menu_item_new_from_stock_action"> Creates a new #WebKitContextMenuItem for the given stock action. + line="189">Creates a new #WebKitContextMenuItem for the given stock action. Stock actions are handled automatically by WebKit so that, for example, when a menu item created with a %WEBKIT_CONTEXT_MENU_ACTION_STOP is @@ -1304,19 +1304,19 @@ load operation will be stopped. You can get the #GAction of a webkit_context_menu_item_get_gaction() and connect to the #GSimpleAction::activate signal to be notified when the item is activated, but you can't prevent the associated action from being performed. - the newly created #WebKitContextMenuItem object. + line="204">the newly created #WebKitContextMenuItem object. a #WebKitContextMenuAction stock action + line="191">a #WebKitContextMenuAction stock action @@ -1325,29 +1325,29 @@ action from being performed. c:identifier="webkit_context_menu_item_new_from_stock_action_with_label"> Creates a new #WebKitContextMenuItem for the given stock action using the given @label. + line="219">Creates a new #WebKitContextMenuItem for the given stock action using the given @label. Stock actions have a predefined label, this method can be used to create a #WebKitContextMenuItem for a #WebKitContextMenuAction but using a custom label. - the newly created #WebKitContextMenuItem object. + line="229">the newly created #WebKitContextMenuItem object. a #WebKitContextMenuAction stock action + line="221">a #WebKitContextMenuAction stock action a custom label text to use instead of the predefined one + line="222">a custom label text to use instead of the predefined one @@ -1356,13 +1356,13 @@ Stock actions have a predefined label, this method can be used to create a c:identifier="webkit_context_menu_item_new_separator"> Creates a new #WebKitContextMenuItem representing a separator. - Creates a new #WebKitContextMenuItem representing a separator. + the newly created #WebKitContextMenuItem object. + line="278">the newly created #WebKitContextMenuItem object. @@ -1370,26 +1370,26 @@ Stock actions have a predefined label, this method can be used to create a c:identifier="webkit_context_menu_item_new_with_submenu"> Creates a new #WebKitContextMenuItem using the given @label with a submenu. - Creates a new #WebKitContextMenuItem using the given @label with a submenu. + the newly created #WebKitContextMenuItem object. + line="251">the newly created #WebKitContextMenuItem object. the menu item label text + line="246">the menu item label text a #WebKitContextMenu to set + line="247">a #WebKitContextMenu to set @@ -1400,14 +1400,14 @@ Stock actions have a predefined label, this method can be used to create a deprecated-version="2.18"> Gets the action associated to @item as a #GtkAction. + line="291">Gets the action associated to @item as a #GtkAction. Use webkit_context_menu_item_get_gaction() instead. - the #GtkAction associated to the #WebKitContextMenuItem, + line="297">the #GtkAction associated to the #WebKitContextMenuItem, or %NULL if @item is a separator. @@ -1415,7 +1415,7 @@ Stock actions have a predefined label, this method can be used to create a a #WebKitContextMenuItem + line="293">a #WebKitContextMenuItem @@ -1425,13 +1425,13 @@ Stock actions have a predefined label, this method can be used to create a version="2.18"> Gets the action associated to @item as a #GAction. - Gets the action associated to @item as a #GAction. + the #GAction associated to the #WebKitContextMenuItem, + line="320">the #GAction associated to the #WebKitContextMenuItem, or %NULL if @item is a separator. @@ -1439,7 +1439,7 @@ Stock actions have a predefined label, this method can be used to create a a #WebKitContextMenuItem + line="316">a #WebKitContextMenuItem @@ -1448,25 +1448,25 @@ Stock actions have a predefined label, this method can be used to create a c:identifier="webkit_context_menu_item_get_stock_action"> Gets the #WebKitContextMenuAction of @item. + line="336">Gets the #WebKitContextMenuAction of @item. If the #WebKitContextMenuItem was not created for a stock action %WEBKIT_CONTEXT_MENU_ACTION_CUSTOM will be returned. If the #WebKitContextMenuItem is a separator %WEBKIT_CONTEXT_MENU_ACTION_NO_ACTION will be returned. - the #WebKitContextMenuAction of @item + line="347">the #WebKitContextMenuAction of @item a #WebKitContextMenuItem + line="338">a #WebKitContextMenuItem @@ -1475,13 +1475,13 @@ will be returned. c:identifier="webkit_context_menu_item_get_submenu"> Gets the submenu of @item. - Gets the submenu of @item. + the #WebKitContextMenu representing the submenu of + line="407">the #WebKitContextMenu representing the submenu of @item or %NULL if @item doesn't have a submenu. @@ -1489,7 +1489,7 @@ will be returned. a #WebKitContextMenuItem + line="403">a #WebKitContextMenuItem @@ -1498,20 +1498,20 @@ will be returned. c:identifier="webkit_context_menu_item_is_separator"> Checks whether @item is a separator. - Checks whether @item is a separator. + %TRUE is @item is a separator or %FALSE otherwise + line="366">%TRUE is @item is a separator or %FALSE otherwise a #WebKitContextMenuItem + line="362">a #WebKitContextMenuItem @@ -1520,11 +1520,11 @@ will be returned. c:identifier="webkit_context_menu_item_set_submenu"> Sets or replaces the @item submenu. + line="379">Sets or replaces the @item submenu. If @submenu is %NULL the current submenu of @item is removed. - @@ -1533,7 +1533,7 @@ submenu of @item is removed. a #WebKitContextMenuItem + line="381">a #WebKitContextMenuItem allow-none="1"> a #WebKitContextMenu + line="382">a #WebKitContextMenu @@ -1558,7 +1558,7 @@ submenu of @item is removed. - - @@ -1575,7 +1575,7 @@ submenu of @item is removed. - @@ -1584,7 +1584,7 @@ submenu of @item is removed. - @@ -1593,7 +1593,7 @@ submenu of @item is removed. - @@ -1605,14 +1605,14 @@ submenu of @item is removed. c:type="WebKitContextMenuItemPrivate" disguised="1" opaque="1"> - - - @@ -45337,7 +45337,7 @@ not be skipped. - @@ -45347,7 +45347,7 @@ not be skipped. - @@ -45362,7 +45362,7 @@ not be skipped. glib:get-type="webkit_form_submission_step_get_type" c:type="WebKitFormSubmissionStep"> Used to indicate a particular stage in form submission. See #WebKitWebPage::will-submit-form. glib:nick="send-dom-event" glib:name="WEBKIT_FORM_SUBMISSION_WILL_SEND_DOM_EVENT"> indicates the form's DOM submit event is about to be emitted. @@ -45381,7 +45381,7 @@ DOM submit event is about to be emitted. glib:nick="complete" glib:name="WEBKIT_FORM_SUBMISSION_WILL_COMPLETE"> indicates the form is about to be submitted. @@ -45400,7 +45400,7 @@ to be submitted. Each `WebKitWebPage` has at least one main frame, and can have any number of subframes. - line="126">Gets the process-unique identifier of this #WebKitFrame. No other frame in the same web process will have the same ID; however, frames in other web processes may. - filename="Source/WebKit/WebProcess/InjectedBundle/API/glib/WebKitFrame.cpp" line="204">Gets the JavaScript execution context of @frame for the given #WebKitScriptWorld. Use webkit_frame_get_js_context_for_script_world() instead. - line="184">Gets the global JavaScript execution context. Use this function to bridge between the WebKit and JavaScriptCore APIs. Use webkit_frame_get_js_context() instead. - filename="Source/WebKit/WebProcess/InjectedBundle/API/glib/WebKitFrame.cpp" line="226">Get the JavaScript execution context of @frame. Use this function to bridge between the WebKit and JavaScriptCore APIs. - Get the JavaScript execution context of @frame for the given #WebKitScriptWorld. - filename="Source/WebKit/WebProcess/InjectedBundle/API/glib/WebKitFrame.cpp" line="264">Get a #JSCValue referencing the given DOM object. The value is created in the JavaScript execution context of @frame. - filename="Source/WebKit/WebProcess/InjectedBundle/API/glib/WebKitFrame.cpp" line="285">Get a #JSCValue referencing the given DOM object. The value is created in the JavaScript execution context of @frame for the given #WebKitScriptWorld. - Gets the current active URI of @frame. - Gets whether @frame is the main frame of a #WebKitWebPage - - @@ -45674,13 +45674,13 @@ context of @frame for the given #WebKitScriptWorld. c:type="WebKitFramePrivate" disguised="1" opaque="1"> - - @@ -45690,7 +45690,7 @@ context of @frame for the given #WebKitScriptWorld. - @@ -45700,7 +45700,7 @@ context of @frame for the given #WebKitScriptWorld. - @@ -45736,7 +45736,7 @@ are active at the same time, for example if there's a link containing an image. When the mouse is moved over a #WebKitWebView a Hit Test is performed for the mouse coordinates and #WebKitWebView::mouse-target-changed signal is emitted with a #WebKitHitTestResult. - @@ -45744,7 +45744,7 @@ signal is emitted with a #WebKitHitTestResult. filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="335">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_EDITABLE flag is present in #WebKitHitTestResult:context. - filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="301">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE flag is present in #WebKitHitTestResult:context. - filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="284">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK flag is present in #WebKitHitTestResult:context. - filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="318">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA flag is present in #WebKitHitTestResult:context. - filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="453">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SCROLLBAR flag is present in #WebKitHitTestResult:context. - filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="352">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SELECTION flag is present in #WebKitHitTestResult:context. - Gets the value of the #WebKitHitTestResult:context property. - Gets the value of the #WebKitHitTestResult:image-uri property. - Gets the value of the #WebKitHitTestResult:link-label property. - Gets the value of the #WebKitHitTestResult:link-title property. - Gets the value of the #WebKitHitTestResult:link-uri property. - Gets the value of the #WebKitHitTestResult:media-uri property. - - - @@ -46127,7 +46127,7 @@ is present in #WebKitHitTestResult:context - @@ -46136,7 +46136,7 @@ is present in #WebKitHitTestResult:context - @@ -46145,7 +46145,7 @@ is present in #WebKitHitTestResult:context - @@ -46155,57 +46155,57 @@ is present in #WebKitHitTestResult:context Enum values with flags representing the context of a #WebKitHitTestResult. - anywhere in the document. a hyperlink element. an image element. a video or audio element. an editable element a scrollbar element. a selected element. Since 2.8 @@ -46213,13 +46213,13 @@ is present in #WebKitHitTestResult:context c:type="WebKitHitTestResultPrivate" disguised="1" opaque="1"> - - @@ -46229,7 +46229,7 @@ is present in #WebKitHitTestResult:context - @@ -46239,7 +46239,7 @@ is present in #WebKitHitTestResult:context - @@ -46249,7 +46249,7 @@ is present in #WebKitHitTestResult:context - @@ -46259,7 +46259,7 @@ is present in #WebKitHitTestResult:context - @@ -46269,7 +46269,7 @@ is present in #WebKitHitTestResult:context - @@ -46279,7 +46279,7 @@ is present in #WebKitHitTestResult:context - @@ -46289,7 +46289,7 @@ is present in #WebKitHitTestResult:context - @@ -46299,7 +46299,7 @@ is present in #WebKitHitTestResult:context - @@ -46309,7 +46309,7 @@ is present in #WebKitHitTestResult:context - @@ -46319,7 +46319,7 @@ is present in #WebKitHitTestResult:context - @@ -46329,7 +46329,7 @@ is present in #WebKitHitTestResult:context - @@ -46339,7 +46339,7 @@ is present in #WebKitHitTestResult:context - @@ -46349,7 +46349,7 @@ is present in #WebKitHitTestResult:context - @@ -46359,7 +46359,7 @@ is present in #WebKitHitTestResult:context - @@ -46369,7 +46369,7 @@ is present in #WebKitHitTestResult:context - @@ -46379,7 +46379,7 @@ is present in #WebKitHitTestResult:context - @@ -46389,7 +46389,7 @@ is present in #WebKitHitTestResult:context - @@ -46399,7 +46399,7 @@ is present in #WebKitHitTestResult:context - @@ -46409,7 +46409,7 @@ is present in #WebKitHitTestResult:context - @@ -46419,7 +46419,7 @@ is present in #WebKitHitTestResult:context - @@ -46429,7 +46429,7 @@ is present in #WebKitHitTestResult:context - @@ -46439,7 +46439,7 @@ is present in #WebKitHitTestResult:context - @@ -46449,7 +46449,7 @@ is present in #WebKitHitTestResult:context - @@ -46459,7 +46459,7 @@ is present in #WebKitHitTestResult:context - @@ -46469,7 +46469,7 @@ is present in #WebKitHitTestResult:context - @@ -46479,7 +46479,7 @@ is present in #WebKitHitTestResult:context - @@ -46489,7 +46489,7 @@ is present in #WebKitHitTestResult:context - @@ -46499,7 +46499,7 @@ is present in #WebKitHitTestResult:context - @@ -46513,7 +46513,7 @@ is present in #WebKitHitTestResult:context glib:type-name="WebKitScriptWorld" glib:get-type="webkit_script_world_get_type" glib:type-struct="ScriptWorldClass"> - - - - Get the name of a #WebKitScriptWorld. - - - @@ -46657,7 +46657,7 @@ webkit_frame_get_js_context_for_script_world(). - @@ -46666,7 +46666,7 @@ webkit_frame_get_js_context_for_script_world(). - @@ -46675,7 +46675,7 @@ webkit_frame_get_js_context_for_script_world(). - @@ -46687,7 +46687,7 @@ webkit_frame_get_js_context_for_script_world(). c:type="WebKitScriptWorldPrivate" disguised="1" opaque="1"> - A #WebKitURIRequest can be created with a URI using the webkit_uri_request_new() method, and you can get the URI of an existing request with the webkit_uri_request_get_uri() one. - Creates a new #WebKitURIRequest for the given URI. - Get the HTTP headers of a #WebKitURIRequest as a #SoupMessageHeaders. - Get the HTTP method of the #WebKitURIRequest. - Obtains the request URI. - Set the URI of @request - @@ -46845,14 +46845,14 @@ existing request with the webkit_uri_request_get_uri() one. - - @@ -46861,7 +46861,7 @@ existing request with the webkit_uri_request_get_uri() one. - @@ -46870,7 +46870,7 @@ existing request with the webkit_uri_request_get_uri() one. - @@ -46879,7 +46879,7 @@ existing request with the webkit_uri_request_get_uri() one. - @@ -46891,7 +46891,7 @@ existing request with the webkit_uri_request_get_uri() one. c:type="WebKitURIRequestPrivate" disguised="1" opaque="1"> - A #WebKitURIResponse contains information such as the URI, the status code, the content length, the mime type, the HTTP status or the suggested filename. - line="207">Get the expected content length of the #WebKitURIResponse. It can be 0 if the server provided an incorrect or missing Content-Length. - Get the HTTP headers of a #WebKitURIResponse as a #SoupMessageHeaders. - Gets the MIME type of the response. - - Get the suggested filename for @response, as specified by the 'Content-Disposition' HTTP header, or %NULL if it's not present. - Gets the URI which resulted in the response. - - - @@ -47142,7 +47142,7 @@ present. - @@ -47151,7 +47151,7 @@ present. - @@ -47160,7 +47160,7 @@ present. - @@ -47172,13 +47172,13 @@ present. c:type="WebKitURIResponsePrivate" disguised="1" opaque="1"> - - @@ -47188,7 +47188,7 @@ present. - @@ -47198,7 +47198,7 @@ present. - @@ -47208,7 +47208,7 @@ present. - @@ -47218,7 +47218,7 @@ present. - @@ -47228,7 +47228,7 @@ present. - @@ -47238,7 +47238,7 @@ present. - @@ -47248,7 +47248,7 @@ present. - @@ -47258,7 +47258,7 @@ present. - @@ -47283,7 +47283,7 @@ UNIX file descriptors. Messages can be sent from a #WebKitWebContext to all web from a web process extension to its corresponding #WebKitWebContext, and from a #WebKitWebView to its corresponding #WebKitWebPage (and vice versa). One to one messages can be replied to directly with webkit_user_message_send_reply(). - Create a new #WebKitUserMessage with @name. - Create a new #WebKitUserMessage including also a list of UNIX file descriptors to be sent. - Get the @message list of file descritpor. - Get the @message name. - Get the @message parameters. - If @reply is floating, it's consumed. You can only send a reply to a #WebKitUserMessage that has been received. - @@ -47518,7 +47518,7 @@ allowed. - - @@ -47535,7 +47535,7 @@ allowed. - @@ -47544,7 +47544,7 @@ allowed. - @@ -47553,7 +47553,7 @@ allowed. - @@ -47565,15 +47565,15 @@ allowed. version="2.28" c:type="WebKitUserMessageError"> Enum values used to denote errors happening when sending user messages. - The message was not handled by the receiver. @@ -47581,13 +47581,13 @@ allowed. c:type="WebKitUserMessagePrivate" disguised="1" opaque="1"> - - @@ -47597,7 +47597,7 @@ allowed. - @@ -47607,7 +47607,7 @@ allowed. - @@ -47617,7 +47617,7 @@ allowed. - @@ -47627,7 +47627,7 @@ allowed. - @@ -47637,7 +47637,7 @@ allowed. - @@ -47647,7 +47647,7 @@ allowed. - @@ -47657,7 +47657,7 @@ allowed. - @@ -47667,7 +47667,7 @@ allowed. - @@ -47677,7 +47677,7 @@ allowed. - @@ -47687,7 +47687,7 @@ allowed. - @@ -47697,7 +47697,7 @@ allowed. - @@ -47707,7 +47707,7 @@ allowed. - @@ -47717,7 +47717,7 @@ allowed. - @@ -47727,7 +47727,7 @@ allowed. - @@ -47749,7 +47749,7 @@ allowed. The WebKitWebEditor provides access to various editing capabilities of a #WebKitWebPage such as a possibility to react to the current selection in #WebKitWebPage. - Gets the #WebKitWebPage that is associated with the #WebKitWebEditor. - - @@ -47804,7 +47804,7 @@ selection. c:type="WebKitWebEditorPrivate" disguised="1" opaque="1"> - - Get the web page of the given @page_id. - + version="2.28" + glib:finish-func="send_message_to_context_finish"> Send @message to the #WebKitWebContext corresponding to @extension. If @message is floating, it's consumed. @@ -47927,7 +47928,7 @@ int main (int argc, char **argv) If you don't expect any reply, or you simply want to ignore it, you can pass %NULL as @calback. When the operation is finished, @callback will be called. You can then call webkit_web_extension_send_message_to_context_finish() to get the message reply. - @@ -47983,7 +47984,7 @@ webkit_web_extension_send_message_to_context_finish() to get the message reply.< Finish an asynchronous operation started with webkit_web_extension_send_message_to_context(). - - @@ -48061,10 +48062,10 @@ replied to. Calling webkit_user_message_send_reply() will do nothing. Type definition for a function that will be called to initialize the web extension when the web process starts. - @@ -48072,7 +48073,7 @@ the web extension when the web process starts. a #WebKitWebExtension @@ -48082,12 +48083,12 @@ the web extension when the web process starts. c:type="WebKitWebExtensionInitializeWithUserDataFunction" version="2.4"> Type definition for a function that will be called to initialize the web extensions when the web process starts, and which receives as additional argument the user data set with webkit_web_context_set_web_extensions_initialization_user_data(). - @@ -48095,13 +48096,13 @@ webkit_web_context_set_web_extensions_initialization_user_data(). a #WebKitWebExtension a #GVariant @@ -48111,7 +48112,7 @@ webkit_web_context_set_web_extensions_initialization_user_data(). c:type="WebKitWebExtensionPrivate" disguised="1" opaque="1"> - Form manager of a #WebKitWebPage in a #WebKitScriptWorld - line="205">Set the value of an HTML input element as if it had been edited by the user, triggering a change event, and set it as filled automatically. If @element is not an HTML input element this function does nothing. - @@ -48161,7 +48162,7 @@ If @element is not an HTML input element this function does nothing. Get whether @element is an HTML input element that has been filled automatically. - Get whether @element is an HTML text input element that has been edited by a user action. - - @@ -48336,7 +48337,7 @@ signal is emitted. WebKitWebHitTestResult extends #WebKitHitTestResult to provide information about the #WebKitDOMNode in the coordinates of the Hit Test. - Get the #JSCValue for the DOM node in @world at the coordinates of the Hit Test. - filename="Source/WebKit/WebProcess/InjectedBundle/API/glib/WebKitWebHitTestResult.cpp" line="378">Get the #WebKitDOMNode in the coordinates of the Hit Test. Use webkit_web_hit_test_result_get_js_node() instead - - - @@ -48437,7 +48438,7 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. - @@ -48446,7 +48447,7 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. - @@ -48455,7 +48456,7 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. - @@ -48467,7 +48468,7 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. c:type="WebKitWebHitTestResultPrivate" disguised="1" opaque="1"> - A loaded web page. - deprecated-version="2.40."> Get the #WebKitDOMDocument currently loaded in @web_page + line="826">Get the #WebKitDOMDocument currently loaded in @web_page Use JavaScriptCore API instead. - the #WebKitDOMDocument currently loaded, or %NULL + line="832">the #WebKitDOMDocument currently loaded, or %NULL if no document is currently loaded. @@ -48503,7 +48504,7 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. a #WebKitWebPage + line="828">a #WebKitWebPage @@ -48513,20 +48514,20 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. version="2.10"> Gets the #WebKitWebEditor of a #WebKitWebPage. - Gets the #WebKitWebEditor of a #WebKitWebPage. + the #WebKitWebEditor + line="905">the #WebKitWebEditor a #WebKitWebPage + line="901">a #WebKitWebPage @@ -48536,20 +48537,20 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. version="2.40"> Get the #WebKitWebFormManager of @web_page in @world. - Get the #WebKitWebFormManager of @web_page in @world. + a #WebKitWebFormManager + line="991">a #WebKitWebFormManager a #WebKitWebPage + line="986">a #WebKitWebPage allow-none="1"> a #WebKitScriptWorld + line="987">a #WebKitScriptWorld @@ -48566,20 +48567,20 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. Get the identifier of the #WebKitWebPage - Get the identifier of the #WebKitWebPage + the identifier of @web_page + line="854">the identifier of @web_page a #WebKitWebPage + line="850">a #WebKitWebPage @@ -48589,20 +48590,20 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. version="2.2"> Returns the main frame of a #WebKitWebPage. - Returns the main frame of a #WebKitWebPage. + the #WebKitFrame that is the main frame of @web_page + line="888">the #WebKitFrame that is the main frame of @web_page a #WebKitWebPage + line="884">a #WebKitWebPage @@ -48612,16 +48613,16 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. glib:get-property="uri"> Returns the current active URI of @web_page. + line="863">Returns the current active URI of @web_page. You can monitor the active URI by connecting to the notify::uri signal of @web_page. - the current active URI of @web_view or %NULL if nothing has been + line="872">the current active URI of @web_view or %NULL if nothing has been loaded yet. @@ -48629,22 +48630,23 @@ signal of @web_page. a #WebKitWebPage + line="865">a #WebKitWebPage + version="2.28" + glib:finish-func="send_message_to_view_finish"> Send @message to the #WebKitWebView corresponding to @web_page. If @message is floating, it's consumed. + line="919">Send @message to the #WebKitWebView corresponding to @web_page. If @message is floating, it's consumed. If you don't expect any reply, or you simply want to ignore it, you can pass %NULL as @callback. When the operation is finished, @callback will be called. You can then call webkit_web_page_send_message_to_view_finish() to get the message reply. - @@ -48653,13 +48655,13 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. a #WebKitWebPage + line="921">a #WebKitWebPage a #WebKitUserMessage + line="922">a #WebKitUserMessage allow-none="1"> a #GCancellable or %NULL to ignore + line="923">a #GCancellable or %NULL to ignore closure="3"> A #GAsyncReadyCallback to call when the request is satisfied or %NULL + line="924">A #GAsyncReadyCallback to call when the request is satisfied or %NULL allow-none="1"> the data to pass to callback function + line="925">the data to pass to callback function @@ -48699,26 +48701,26 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. throws="1"> Finish an asynchronous operation started with webkit_web_page_send_message_to_view(). - Finish an asynchronous operation started with webkit_web_page_send_message_to_view(). + a #WebKitUserMessage with the reply or %NULL in case of error. + line="972">a #WebKitUserMessage with the reply or %NULL in case of error. a #WebKitWebPage + line="966">a #WebKitWebPage a #GAsyncResult + line="967">a #GAsyncResult @@ -48729,7 +48731,7 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. default-value="NULL"> The current active URI of the #WebKitWebPage. + line="513">The current active URI of the #WebKitWebPage. @@ -48745,7 +48747,7 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. deprecated-version="2.40"> Emitted when a message is sent to the console. This can be a message + line="615">Emitted when a message is sent to the console. This can be a message produced by the use of JavaScript console API, a JavaScript exception, a security error or other errors, warnings, debug or log messages. The @console_message contains information of the message. @@ -48756,7 +48758,7 @@ The @console_message contains information of the message. the #WebKitConsoleMessage + line="618">the #WebKitConsoleMessage @@ -48764,7 +48766,7 @@ The @console_message contains information of the message. Emitted before a context menu is displayed in the UI Process to + line="579">Emitted before a context menu is displayed in the UI Process to give the application a chance to customize the proposed menu, build its own context menu or pass user data to the UI Process. This signal is useful when the information available in the UI Process @@ -48775,20 +48777,20 @@ signal instead. %TRUE if the proposed @context_menu has been modified, or %FALSE otherwise. + line="594">%TRUE if the proposed @context_menu has been modified, or %FALSE otherwise. the proposed #WebKitContextMenu + line="582">the proposed #WebKitContextMenu a #WebKitWebHitTestResult + line="583">a #WebKitWebHitTestResult @@ -48796,7 +48798,7 @@ signal instead. This signal is emitted when the DOM document of a #WebKitWebPage has been + line="527">This signal is emitted when the DOM document of a #WebKitWebPage has been loaded. You can wait for this signal to get the DOM document @@ -48811,7 +48813,7 @@ You can wait for this signal to get the DOM document deprecated-version="2.26"> Emitted after form elements (or form associated elements) are associated to a particular web + line="642">Emitted after form elements (or form associated elements) are associated to a particular web page. This is useful to implement form auto filling for web pages where form fields are added dynamically. This signal might be emitted multiple times for the same web page. @@ -48828,7 +48830,7 @@ keep them alive after the signal handler returns. a #GPtrArray of + line="645">a #GPtrArray of #WebKitDOMElement with the list of forms in the page @@ -48843,7 +48845,7 @@ keep them alive after the signal handler returns. deprecated-version="2.40"> Emitted after form elements (or form associated elements) are associated to a particular web + line="671">Emitted after form elements (or form associated elements) are associated to a particular web page. This is useful to implement form auto filling for web pages where form fields are added dynamically. This signal might be emitted multiple times for the same web page. @@ -48860,7 +48862,7 @@ keep them alive after the signal handler returns. a #GPtrArray of + line="674">a #GPtrArray of #WebKitDOMElement with the list of forms in the page @@ -48869,7 +48871,7 @@ keep them alive after the signal handler returns. the #WebKitFrame + line="676">the #WebKitFrame @@ -48877,7 +48879,7 @@ keep them alive after the signal handler returns. This signal is emitted when @request is about to be sent to + line="544">This signal is emitted when @request is about to be sent to the server. This signal can be used to modify the #WebKitURIRequest that will be sent to the server. You can also cancel the resource load operation by connecting to this signal and returning %TRUE. @@ -48894,7 +48896,7 @@ is sent over the network. %TRUE to stop other handlers from being invoked for the event. + line="565">%TRUE to stop other handlers from being invoked for the event. %FALSE to continue emission of the event. @@ -48902,13 +48904,13 @@ is sent over the network. a #WebKitURIRequest + line="547">a #WebKitURIRequest a #WebKitURIResponse, or %NULL + line="548">a #WebKitURIResponse, or %NULL @@ -48916,7 +48918,7 @@ is sent over the network. This signal is emitted when a #WebKitUserMessage is received from the + line="765">This signal is emitted when a #WebKitUserMessage is received from the #WebKitWebView corresponding to @web_page. You can reply to the message using webkit_user_message_send_reply(). @@ -48927,14 +48929,14 @@ finish with error %WEBKIT_USER_MESSAGE_UNHANDLED_MESSAGE. %TRUE if the message was handled, or %FALSE otherwise. + line="779">%TRUE if the message was handled, or %FALSE otherwise. the #WebKitUserMessage received + line="768">the #WebKitUserMessage received @@ -48946,7 +48948,7 @@ finish with error %WEBKIT_USER_MESSAGE_UNHANDLED_MESSAGE. deprecated-version="2.40"> This signal is emitted to indicate various points during form + line="702">This signal is emitted to indicate various points during form submission. @step indicates the current stage of form submission. If this signal is emitted with %WEBKIT_FORM_SUBMISSION_WILL_SEND_DOM_EVENT, @@ -48981,34 +48983,34 @@ emitted. the #WebKitDOMElement to be submitted, which will always correspond to an HTMLFormElement + line="705">the #WebKitDOMElement to be submitted, which will always correspond to an HTMLFormElement a #WebKitFormSubmissionEventType indicating the current + line="706">a #WebKitFormSubmissionEventType indicating the current stage of form submission the #WebKitFrame containing the form to be + line="708">the #WebKitFrame containing the form to be submitted the #WebKitFrame containing the form's target, + line="710">the #WebKitFrame containing the form's target, which may be the same as @source_frame if no target was specified names of + line="712">names of the form's text fields @@ -49017,7 +49019,7 @@ the form's text fields values + line="714">values of the form's text fields @@ -49029,7 +49031,7 @@ of the form's text fields - @@ -49039,7 +49041,7 @@ of the form's text fields c:type="WebKitWebPagePrivate" disguised="1" opaque="1"> - diff --git a/girs/WebKitWebProcessExtension-6.0.gir b/girs/WebKitWebProcessExtension-6.0.gir index cedb97316..9426bd02b 100644 --- a/girs/WebKitWebProcessExtension-6.0.gir +++ b/girs/WebKitWebProcessExtension-6.0.gir @@ -26,7 +26,7 @@ and/or use gtk-doc annotations. --> glib:type-struct="ContextMenuClass"> Represents the context menu in a #WebKitWebView. + line="41">Represents the context menu in a #WebKitWebView. #WebKitContextMenu represents a context menu containing #WebKitContextMenuItem<!-- -->s in a #WebKitWebView. @@ -39,12 +39,12 @@ new #WebKitContextMenuItem<!-- -->s with webkit_context_menu_prepend(), webkit_context_menu_append() or webkit_context_menu_insert(), maybe after having removed the existing ones with webkit_context_menu_remove_all(). - Creates a new #WebKitContextMenu object. + line="135">Creates a new #WebKitContextMenu object. Creates a new #WebKitContextMenu object to be used as a submenu of an existing #WebKitContextMenu. The context menu of a #WebKitWebView is created by the view @@ -53,12 +53,12 @@ To add items to the menu use webkit_context_menu_prepend(), webkit_context_menu_append() or webkit_context_menu_insert(). See also webkit_context_menu_new_with_items() to create a #WebKitContextMenu with a list of initial items. - The newly created #WebKitContextMenu object + line="148">The newly created #WebKitContextMenu object @@ -66,24 +66,24 @@ a list of initial items. c:identifier="webkit_context_menu_new_with_items"> Creates a new #WebKitContextMenu object with the given items. + line="155">Creates a new #WebKitContextMenu object with the given items. Creates a new #WebKitContextMenu object to be used as a submenu of an existing #WebKitContextMenu with the given initial items. See also webkit_context_menu_new() - The newly created #WebKitContextMenu object + line="165">The newly created #WebKitContextMenu object a #GList of #WebKitContextMenuItem + line="157">a #GList of #WebKitContextMenuItem @@ -93,8 +93,8 @@ See also webkit_context_menu_new() Adds @item at the end of the @menu. - Adds @item at the end of the @menu. + @@ -103,13 +103,13 @@ See also webkit_context_menu_new() a #WebKitContextMenu + line="190">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="191">the #WebKitContextMenuItem to add @@ -117,13 +117,13 @@ See also webkit_context_menu_new() Gets the first item in the @menu. - Gets the first item in the @menu. + the first #WebKitContextMenuItem of @menu, + line="283">the first #WebKitContextMenuItem of @menu, or %NULL if the #WebKitContextMenu is empty. @@ -131,7 +131,7 @@ See also webkit_context_menu_new() a #WebKitContextMenu + line="279">a #WebKitContextMenu @@ -141,7 +141,7 @@ See also webkit_context_menu_new() version="2.40"> Gets the #GdkEvent that triggered the context menu. This function only returns a valid + line="405">Gets the #GdkEvent that triggered the context menu. This function only returns a valid #GdkEvent when called for a #WebKitContextMenu passed to #WebKitWebView::context-menu signal; in all other cases, %NULL is returned. @@ -157,19 +157,19 @@ a #GdkEventKey of type %GDK_KEY_PRESS if the keyboard was used to show the menu. a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal was used to show the context menu. </para></listitem> </itemizedlist> - the menu event or %NULL. + line="426">the menu event or %NULL. a #WebKitContextMenu + line="407">a #WebKitContextMenu @@ -178,13 +178,13 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal c:identifier="webkit_context_menu_get_item_at_position"> Gets the item at the given position in the @menu. - Gets the item at the given position in the @menu. + the #WebKitContextMenuItem at position @position in @menu, + line="317">the #WebKitContextMenuItem at position @position in @menu, or %NULL if the position is off the end of the @menu. @@ -192,13 +192,13 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal a #WebKitContextMenu + line="312">a #WebKitContextMenu the position of the item, counting from 0 + line="313">the position of the item, counting from 0 @@ -206,13 +206,13 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal Returns the item list of @menu. - Returns the item list of @menu. + a #GList of + line="252">a #GList of #WebKitContextMenuItem<!-- -->s @@ -222,7 +222,7 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal a #WebKitContextMenu + line="248">a #WebKitContextMenu @@ -231,20 +231,20 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal c:identifier="webkit_context_menu_get_n_items"> Gets the length of the @menu. - Gets the length of the @menu. + the number of #WebKitContextMenuItem<!-- -->s in @menu + line="268">the number of #WebKitContextMenuItem<!-- -->s in @menu a #WebKitContextMenu + line="264">a #WebKitContextMenu @@ -254,23 +254,23 @@ a generic #GdkEvent of type %GDK_NOTHING when the #GtkWidget::popup-menu signal version="2.8"> Gets the user data of @menu. + line="384">Gets the user data of @menu. This function can be used from the UI Process to get user data previously set from the Web Process with webkit_context_menu_set_user_data(). - the user data of @menu, or %NULL if @menu doesn't have user data + line="393">the user data of @menu, or %NULL if @menu doesn't have user data a #WebKitContextMenu + line="386">a #WebKitContextMenu @@ -278,12 +278,12 @@ from the Web Process with webkit_context_menu_set_user_data(). Inserts @item into the @menu at the given position. + line="200">Inserts @item into the @menu at the given position. If @position is negative, or is larger than the number of items in the #WebKitContextMenu, the item is added on to the end of the @menu. The first position is 0. - @@ -292,19 +292,19 @@ the @menu. The first position is 0. a #WebKitContextMenu + line="202">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="203">the #WebKitContextMenuItem to add the position to insert the item + line="204">the position to insert the item @@ -312,13 +312,13 @@ the @menu. The first position is 0. Gets the last item in the @menu. - Gets the last item in the @menu. + the last #WebKitContextMenuItem of @menu, + line="299">the last #WebKitContextMenuItem of @menu, or %NULL if the #WebKitContextMenu is empty. @@ -326,7 +326,7 @@ the @menu. The first position is 0. a #WebKitContextMenu + line="295">a #WebKitContextMenu @@ -334,13 +334,13 @@ the @menu. The first position is 0. Moves @item to the given position in the @menu. + line="221">Moves @item to the given position in the @menu. If @position is negative, or is larger than the number of items in the #WebKitContextMenu, the item is added on to the end of the @menu. The first position is 0. - @@ -349,19 +349,19 @@ The first position is 0. a #WebKitContextMenu + line="223">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="224">the #WebKitContextMenuItem to add the new position to move the item + line="225">the new position to move the item @@ -369,8 +369,8 @@ The first position is 0. Adds @item at the beginning of the @menu. - Adds @item at the beginning of the @menu. + @@ -379,13 +379,13 @@ The first position is 0. a #WebKitContextMenu + line="178">a #WebKitContextMenu the #WebKitContextMenuItem to add + line="179">the #WebKitContextMenuItem to add @@ -393,10 +393,10 @@ The first position is 0. Removes @item from the @menu. + line="328">Removes @item from the @menu. See also webkit_context_menu_remove_all() to remove all items. - @@ -405,13 +405,13 @@ See also webkit_context_menu_remove_all() to remove all items. a #WebKitContextMenu + line="330">a #WebKitContextMenu the #WebKitContextMenuItem to remove + line="331">the #WebKitContextMenuItem to remove @@ -419,8 +419,8 @@ See also webkit_context_menu_remove_all() to remove all items. Removes all items of the @menu. - Removes all items of the @menu. + @@ -429,7 +429,7 @@ See also webkit_context_menu_remove_all() to remove all items. a #WebKitContextMenu + line="351">a #WebKitContextMenu @@ -439,12 +439,12 @@ See also webkit_context_menu_remove_all() to remove all items. version="2.8"> Sets user data to @menu. + line="363">Sets user data to @menu. This function can be used from a Web Process extension to set user data that can be retrieved from the UI Process using webkit_context_menu_get_user_data(). If the @user_data #GVariant is floating, it is consumed. - @@ -453,13 +453,13 @@ If the @user_data #GVariant is floating, it is consumed. a #WebKitContextMenu + line="365">a #WebKitContextMenu a #GVariant + line="366">a #GVariant @@ -467,345 +467,345 @@ If the @user_data #GVariant is floating, it is consumed. Enum values used to denote the stock actions for #WebKitContextMenuItem<!-- -->s - No action, used by separator menu items. Open current link. Open current link in a new window. Download link destination. Copy link location to the clipboard. Open current image in a new window. Download current image. Copy current image to the clipboard. Copy current image location to the clipboard. Open current frame in a new window. Load the previous history item. Load the next history item. Stop any ongoing loading operation. Reload the contents of current view. Copy current selection the clipboard. Cut current selection to the clipboard. Paste clipboard contents. Delete current selection. Select all text. Input methods menu. Unicode menu. A proposed replacement for a misspelled word. An indicator that spellchecking found no proposed replacements. Causes the spellchecker to ignore the word for this session. Causes the spellchecker to add the word to the dictionary. Ignore grammar. Font options menu. Bold. Italic. Underline. Outline. Open current element in the inspector. Open current video element in a new window. Open current audio element in a new window. Copy video link location in to the clipboard. Copy audio link location in to the clipboard. Enable or disable media controls. Enable or disable media loop. Show current video element in fullscreen mode. Play current media element. Pause current media element. Mute current media element. Download video to disk. Since 2.2 Download audio to disk. Since 2.2 Insert an emoji. Since 2.26 Paste clipboard contents as plain text. Since 2.30 Custom action defined by applications. - @@ -821,43 +821,43 @@ If the @user_data #GVariant is floating, it is consumed. glib:type-struct="ContextMenuItemClass"> One item of a #WebKitContextMenu. + line="41">One item of a #WebKitContextMenu. The #WebKitContextMenu is composed of #WebKitContextMenuItem<!-- -->s. These items can be created from a #GtkAction, from a #WebKitContextMenuAction or from a #WebKitContextMenuAction and a label. These #WebKitContextMenuAction<!-- -->s denote stock actions for the items. You can also create separators and submenus. - Creates a new #WebKitContextMenuItem for the given @action and @label. + line="159">Creates a new #WebKitContextMenuItem for the given @action and @label. On activation @target will be passed as parameter to the callback. - the newly created #WebKitContextMenuItem object. + line="170">the newly created #WebKitContextMenuItem object. a #GAction + line="161">a #GAction the menu item label text + line="162">the menu item label text a #GVariant to use as the action target + line="163">a #GVariant to use as the action target @@ -875,7 +875,7 @@ On activation c:identifier="webkit_context_menu_item_new_from_stock_action"> Creates a new #WebKitContextMenuItem for the given stock action. + line="189">Creates a new #WebKitContextMenuItem for the given stock action. Stock actions are handled automatically by WebKit so that, for example, when a menu item created with a %WEBKIT_CONTEXT_MENU_ACTION_STOP is @@ -885,19 +885,19 @@ load operation will be stopped. You can get the #GAction of a webkit_context_menu_item_get_gaction() and connect to the #GSimpleAction::activate signal to be notified when the item is activated, but you can't prevent the associated action from being performed. - the newly created #WebKitContextMenuItem object. + line="204">the newly created #WebKitContextMenuItem object. a #WebKitContextMenuAction stock action + line="191">a #WebKitContextMenuAction stock action @@ -906,29 +906,29 @@ action from being performed. c:identifier="webkit_context_menu_item_new_from_stock_action_with_label"> Creates a new #WebKitContextMenuItem for the given stock action using the given @label. + line="219">Creates a new #WebKitContextMenuItem for the given stock action using the given @label. Stock actions have a predefined label, this method can be used to create a #WebKitContextMenuItem for a #WebKitContextMenuAction but using a custom label. - the newly created #WebKitContextMenuItem object. + line="229">the newly created #WebKitContextMenuItem object. a #WebKitContextMenuAction stock action + line="221">a #WebKitContextMenuAction stock action a custom label text to use instead of the predefined one + line="222">a custom label text to use instead of the predefined one @@ -937,13 +937,13 @@ Stock actions have a predefined label, this method can be used to create a c:identifier="webkit_context_menu_item_new_separator"> Creates a new #WebKitContextMenuItem representing a separator. - Creates a new #WebKitContextMenuItem representing a separator. + the newly created #WebKitContextMenuItem object. + line="278">the newly created #WebKitContextMenuItem object. @@ -951,26 +951,26 @@ Stock actions have a predefined label, this method can be used to create a c:identifier="webkit_context_menu_item_new_with_submenu"> Creates a new #WebKitContextMenuItem using the given @label with a submenu. - Creates a new #WebKitContextMenuItem using the given @label with a submenu. + the newly created #WebKitContextMenuItem object. + line="251">the newly created #WebKitContextMenuItem object. the menu item label text + line="246">the menu item label text a #WebKitContextMenu to set + line="247">a #WebKitContextMenu to set @@ -980,13 +980,13 @@ Stock actions have a predefined label, this method can be used to create a version="2.18"> Gets the action associated to @item as a #GAction. - Gets the action associated to @item as a #GAction. + the #GAction associated to the #WebKitContextMenuItem, + line="320">the #GAction associated to the #WebKitContextMenuItem, or %NULL if @item is a separator. @@ -994,7 +994,7 @@ Stock actions have a predefined label, this method can be used to create a a #WebKitContextMenuItem + line="316">a #WebKitContextMenuItem @@ -1003,25 +1003,25 @@ Stock actions have a predefined label, this method can be used to create a c:identifier="webkit_context_menu_item_get_stock_action"> Gets the #WebKitContextMenuAction of @item. + line="336">Gets the #WebKitContextMenuAction of @item. If the #WebKitContextMenuItem was not created for a stock action %WEBKIT_CONTEXT_MENU_ACTION_CUSTOM will be returned. If the #WebKitContextMenuItem is a separator %WEBKIT_CONTEXT_MENU_ACTION_NO_ACTION will be returned. - the #WebKitContextMenuAction of @item + line="347">the #WebKitContextMenuAction of @item a #WebKitContextMenuItem + line="338">a #WebKitContextMenuItem @@ -1030,13 +1030,13 @@ will be returned. c:identifier="webkit_context_menu_item_get_submenu"> Gets the submenu of @item. - Gets the submenu of @item. + the #WebKitContextMenu representing the submenu of + line="407">the #WebKitContextMenu representing the submenu of @item or %NULL if @item doesn't have a submenu. @@ -1044,7 +1044,7 @@ will be returned. a #WebKitContextMenuItem + line="403">a #WebKitContextMenuItem @@ -1053,20 +1053,20 @@ will be returned. c:identifier="webkit_context_menu_item_is_separator"> Checks whether @item is a separator. - Checks whether @item is a separator. + %TRUE is @item is a separator or %FALSE otherwise + line="366">%TRUE is @item is a separator or %FALSE otherwise a #WebKitContextMenuItem + line="362">a #WebKitContextMenuItem @@ -1075,11 +1075,11 @@ will be returned. c:identifier="webkit_context_menu_item_set_submenu"> Sets or replaces the @item submenu. + line="379">Sets or replaces the @item submenu. If @submenu is %NULL the current submenu of @item is removed. - @@ -1088,7 +1088,7 @@ submenu of @item is removed. a #WebKitContextMenuItem + line="381">a #WebKitContextMenuItem allow-none="1"> a #WebKitContextMenu + line="382">a #WebKitContextMenu @@ -1106,7 +1106,7 @@ submenu of @item is removed. - Each `WebKitWebPage` has at least one main frame, and can have any number of subframes. - line="126">Gets the process-unique identifier of this #WebKitFrame. No other frame in the same web process will have the same ID; however, frames in other web processes may. - filename="Source/WebKit/WebProcess/InjectedBundle/API/glib/WebKitFrame.cpp" line="226">Get the JavaScript execution context of @frame. Use this function to bridge between the WebKit and JavaScriptCore APIs. - Get the JavaScript execution context of @frame for the given #WebKitScriptWorld. - Gets the current active URI of @frame. - Gets whether @frame is the main frame of a #WebKitWebPage - - @@ -1291,7 +1291,7 @@ are active at the same time, for example if there's a link containing an image. When the mouse is moved over a #WebKitWebView a Hit Test is performed for the mouse coordinates and #WebKitWebView::mouse-target-changed signal is emitted with a #WebKitHitTestResult. - @@ -1299,7 +1299,7 @@ signal is emitted with a #WebKitHitTestResult. filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="335">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_EDITABLE flag is present in #WebKitHitTestResult:context. - filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="301">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE flag is present in #WebKitHitTestResult:context. - filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="284">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK flag is present in #WebKitHitTestResult:context. - filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="318">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA flag is present in #WebKitHitTestResult:context. - filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="453">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SCROLLBAR flag is present in #WebKitHitTestResult:context. - filename="Source/WebKit/Shared/API/glib/WebKitHitTestResult.cpp" line="352">Gets whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SELECTION flag is present in #WebKitHitTestResult:context. - Gets the value of the #WebKitHitTestResult:context property. - Gets the value of the #WebKitHitTestResult:image-uri property. - Gets the value of the #WebKitHitTestResult:link-label property. - Gets the value of the #WebKitHitTestResult:link-title property. - Gets the value of the #WebKitHitTestResult:link-uri property. - Gets the value of the #WebKitHitTestResult:media-uri property. - - @@ -1667,64 +1667,64 @@ is present in #WebKitHitTestResult:context Enum values with flags representing the context of a #WebKitHitTestResult. - anywhere in the document. a hyperlink element. an image element. a video or audio element. an editable element a scrollbar element. a selected element. Since 2.8 - @@ -1734,7 +1734,7 @@ is present in #WebKitHitTestResult:context - @@ -1749,7 +1749,7 @@ is present in #WebKitHitTestResult:context glib:type-name="WebKitScriptWorld" glib:get-type="webkit_script_world_get_type" glib:type-struct="ScriptWorldClass"> - - - - Get the name of a #WebKitScriptWorld. - - @@ -1892,13 +1892,13 @@ webkit_frame_get_js_context_for_script_world(). A #WebKitURIRequest can be created with a URI using the webkit_uri_request_new() method, and you can get the URI of an existing request with the webkit_uri_request_get_uri() one. - Creates a new #WebKitURIRequest for the given URI. - Get the HTTP headers of a #WebKitURIRequest as a #SoupMessageHeaders. - Get the HTTP method of the #WebKitURIRequest. - Obtains the request URI. - Set the URI of @request - @@ -2027,7 +2027,7 @@ existing request with the webkit_uri_request_get_uri() one. - @@ -2048,7 +2048,7 @@ existing request with the webkit_uri_request_get_uri() one. A #WebKitURIResponse contains information such as the URI, the status code, the content length, the mime type, the HTTP status or the suggested filename. - line="207">Get the expected content length of the #WebKitURIResponse. It can be 0 if the server provided an incorrect or missing Content-Length. - Get the HTTP headers of a #WebKitURIResponse as a #SoupMessageHeaders. - Gets the MIME type of the response. - - Get the suggested filename for @response, as specified by the 'Content-Disposition' HTTP header, or %NULL if it's not present. - Gets the URI which resulted in the response. - - @@ -2285,7 +2285,7 @@ UNIX file descriptors. Messages can be sent from a #WebKitWebContext to all web from a web process extension to its corresponding #WebKitWebContext, and from a #WebKitWebView to its corresponding #WebKitWebPage (and vice versa). One to one messages can be replied to directly with webkit_user_message_send_reply(). - Create a new #WebKitUserMessage with @name. - Create a new #WebKitUserMessage including also a list of UNIX file descriptors to be sent. - Get the @message list of file descritpor. - Get the @message name. - Get the @message parameters. - If @reply is floating, it's consumed. You can only send a reply to a #WebKitUserMessage that has been received. - @@ -2514,7 +2514,7 @@ allowed. - version="2.28" c:type="WebKitUserMessageError"> Enum values used to denote errors happening when sending user messages. - The message was not handled by the receiver. - @@ -2550,7 +2550,7 @@ allowed. - @@ -2560,7 +2560,7 @@ allowed. - @@ -2583,7 +2583,7 @@ allowed. The WebKitWebEditor provides access to various editing capabilities of a #WebKitWebPage such as a possibility to react to the current selection in #WebKitWebPage. - Gets the #WebKitWebPage that is associated with the #WebKitWebEditor. - - @@ -2639,7 +2639,7 @@ selection. Form manager of a #WebKitWebPage in a #WebKitScriptWorld - line="205">Set the value of an HTML input element as if it had been edited by the user, triggering a change event, and set it as filled automatically. If @element is not an HTML input element this function does nothing. - @@ -2675,7 +2675,7 @@ If @element is not an HTML input element this function does nothing. Get whether @element is an HTML input element that has been filled automatically. - Get whether @element is an HTML text input element that has been edited by a user action. - - @@ -2851,7 +2851,7 @@ signal is emitted. WebKitWebHitTestResult extends #WebKitHitTestResult to provide information about the #WebKitDOMNode in the coordinates of the Hit Test. - @@ -2861,7 +2861,7 @@ about the #WebKitDOMNode in the coordinates of the Hit Test. Checks whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_EDITABLE flag is present in the context flags. - Checks whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_IMAGE flag is present in the context flags. - Checks whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_LINK flag is present in the context flags. - Checks whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_MEDIA flag is present in the context flags. - Checks whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SCROLLBAR flag is present in the context flags. - Checks whether %WEBKIT_HIT_TEST_RESULT_CONTEXT_SELECTION flag is present in the context flags. - Gets the the context flags for the hit test result. - Obtains the URI associated with the image element at the hit test position. - Get the #JSCValue for the DOM node in @world at the coordinates of the Hit Test. - Obtains the label associated with the link element at the hit test position. - Obtains the title associated with the link element at the hit test position. - Obtains the URI associated with the link element at the hit test position. - Obtains the URI associated with the media element at the hit test position. - - @@ -3203,27 +3203,27 @@ the context flags. A loaded web page. - Gets the #WebKitWebEditor of a #WebKitWebPage. - Gets the #WebKitWebEditor of a #WebKitWebPage. + the #WebKitWebEditor + line="905">the #WebKitWebEditor a #WebKitWebPage + line="901">a #WebKitWebPage @@ -3233,20 +3233,20 @@ the context flags. version="2.40"> Get the #WebKitWebFormManager of @web_page in @world. - Get the #WebKitWebFormManager of @web_page in @world. + a #WebKitWebFormManager + line="991">a #WebKitWebFormManager a #WebKitWebPage + line="986">a #WebKitWebPage allow-none="1"> a #WebKitScriptWorld + line="987">a #WebKitScriptWorld @@ -3263,20 +3263,20 @@ the context flags. Get the identifier of the #WebKitWebPage - Get the identifier of the #WebKitWebPage + the identifier of @web_page + line="854">the identifier of @web_page a #WebKitWebPage + line="850">a #WebKitWebPage @@ -3286,20 +3286,20 @@ the context flags. version="2.2"> Returns the main frame of a #WebKitWebPage. - Returns the main frame of a #WebKitWebPage. + the #WebKitFrame that is the main frame of @web_page + line="888">the #WebKitFrame that is the main frame of @web_page a #WebKitWebPage + line="884">a #WebKitWebPage @@ -3309,16 +3309,16 @@ the context flags. glib:get-property="uri"> Returns the current active URI of @web_page. + line="863">Returns the current active URI of @web_page. You can monitor the active URI by connecting to the notify::uri signal of @web_page. - the current active URI of @web_view or %NULL if nothing has been + line="872">the current active URI of @web_view or %NULL if nothing has been loaded yet. @@ -3326,22 +3326,23 @@ signal of @web_page. a #WebKitWebPage + line="865">a #WebKitWebPage + version="2.28" + glib:finish-func="send_message_to_view_finish"> Send @message to the #WebKitWebView corresponding to @web_page. If @message is floating, it's consumed. + line="919">Send @message to the #WebKitWebView corresponding to @web_page. If @message is floating, it's consumed. If you don't expect any reply, or you simply want to ignore it, you can pass %NULL as @callback. When the operation is finished, @callback will be called. You can then call webkit_web_page_send_message_to_view_finish() to get the message reply. - @@ -3350,13 +3351,13 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. a #WebKitWebPage + line="921">a #WebKitWebPage a #WebKitUserMessage + line="922">a #WebKitUserMessage allow-none="1"> a #GCancellable or %NULL to ignore + line="923">a #GCancellable or %NULL to ignore closure="3"> A #GAsyncReadyCallback to call when the request is satisfied or %NULL + line="924">A #GAsyncReadyCallback to call when the request is satisfied or %NULL allow-none="1"> the data to pass to callback function + line="925">the data to pass to callback function @@ -3396,26 +3397,26 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. throws="1"> Finish an asynchronous operation started with webkit_web_page_send_message_to_view(). - Finish an asynchronous operation started with webkit_web_page_send_message_to_view(). + a #WebKitUserMessage with the reply or %NULL in case of error. + line="972">a #WebKitUserMessage with the reply or %NULL in case of error. a #WebKitWebPage + line="966">a #WebKitWebPage a #GAsyncResult + line="967">a #GAsyncResult @@ -3426,13 +3427,13 @@ webkit_web_page_send_message_to_view_finish() to get the message reply. default-value="NULL"> The current active URI of the #WebKitWebPage. + line="513">The current active URI of the #WebKitWebPage. Emitted before a context menu is displayed in the UI Process to + line="579">Emitted before a context menu is displayed in the UI Process to give the application a chance to customize the proposed menu, build its own context menu or pass user data to the UI Process. This signal is useful when the information available in the UI Process @@ -3443,20 +3444,20 @@ signal instead. %TRUE if the proposed @context_menu has been modified, or %FALSE otherwise. + line="594">%TRUE if the proposed @context_menu has been modified, or %FALSE otherwise. the proposed #WebKitContextMenu + line="582">the proposed #WebKitContextMenu a #WebKitWebHitTestResult + line="583">a #WebKitWebHitTestResult @@ -3464,7 +3465,7 @@ signal instead. This signal is emitted when the DOM document of a #WebKitWebPage has been + line="527">This signal is emitted when the DOM document of a #WebKitWebPage has been loaded. You can wait for this signal to get the DOM document @@ -3475,7 +3476,7 @@ You can wait for this signal to get the DOM document This signal is emitted when @request is about to be sent to + line="544">This signal is emitted when @request is about to be sent to the server. This signal can be used to modify the #WebKitURIRequest that will be sent to the server. You can also cancel the resource load operation by connecting to this signal and returning %TRUE. @@ -3492,7 +3493,7 @@ is sent over the network. %TRUE to stop other handlers from being invoked for the event. + line="565">%TRUE to stop other handlers from being invoked for the event. %FALSE to continue emission of the event. @@ -3500,13 +3501,13 @@ is sent over the network. a #WebKitURIRequest + line="547">a #WebKitURIRequest a #WebKitURIResponse, or %NULL + line="548">a #WebKitURIResponse, or %NULL @@ -3514,7 +3515,7 @@ is sent over the network. This signal is emitted when a #WebKitUserMessage is received from the + line="765">This signal is emitted when a #WebKitUserMessage is received from the #WebKitWebView corresponding to @web_page. You can reply to the message using webkit_user_message_send_reply(). @@ -3525,14 +3526,14 @@ finish with error %WEBKIT_USER_MESSAGE_UNHANDLED_MESSAGE. %TRUE if the message was handled, or %FALSE otherwise. + line="779">%TRUE if the message was handled, or %FALSE otherwise. the #WebKitUserMessage received + line="768">the #WebKitUserMessage received @@ -3541,7 +3542,7 @@ finish with error %WEBKIT_USER_MESSAGE_UNHANDLED_MESSAGE. - @@ -3629,7 +3630,7 @@ int main (int argc, char **argv) // ... } ``` - Get the web page of the given @page_id. - + version="2.40" + glib:finish-func="send_message_to_context_finish"> Send @message to the #WebKitWebContext corresponding to @extension. If @message is floating, it's consumed. @@ -3672,7 +3674,7 @@ int main (int argc, char **argv) If you don't expect any reply, or you simply want to ignore it, you can pass %NULL as @calback. When the operation is finished, @callback will be called. You can then call webkit_web_process_extension_send_message_to_context_finish() to get the message reply. - @@ -3729,7 +3731,7 @@ webkit_web_process_extension_send_message_to_context_finish() to get the message Finish an asynchronous operation started with webkit_web_process_extension_send_message_to_context(). - - @@ -3803,10 +3805,10 @@ replied to. Calling webkit_user_message_send_reply() will do nothing. c:type="WebKitWebProcessExtensionInitializeFunction" version="2.40"> Type definition for a function that will be called to initialize the web extension when the web process starts. - @@ -3814,7 +3816,7 @@ the web extension when the web process starts. a #WebKitWebProcessExtension @@ -3825,12 +3827,12 @@ the web extension when the web process starts. c:type="WebKitWebProcessExtensionInitializeWithUserDataFunction" version="2.40"> Type definition for a function that will be called to initialize the web extensions when the web process starts, and which receives as additional argument the user data set with webkit_web_context_set_web_process_extensions_initialization_user_data(). - @@ -3838,14 +3840,14 @@ webkit_web_context_set_web_process_extensions_initialization_user_data(). a #WebKitWebProcessExtension a #GVariant diff --git a/girs/Wnck-3.0.gir b/girs/Wnck-3.0.gir index c4d2366ef..833e3fd02 100644 --- a/girs/Wnck-3.0.gir +++ b/girs/Wnck-3.0.gir @@ -46,7 +46,7 @@ and/or use gtk-doc annotations. --> - + @@ -55,7 +55,7 @@ and/or use gtk-doc annotations. --> - + @@ -64,7 +64,7 @@ and/or use gtk-doc annotations. --> - + @@ -175,19 +175,19 @@ items for window operations on @window. glib:type-struct="ApplicationClass"> The #WnckApplication struct contains only private fields and should not be + line="46">The #WnckApplication struct contains only private fields and should not be directly accessed. - + Gets the #WnckApplication corresponding to the group leader with @xwindow + line="174">Gets the #WnckApplication corresponding to the group leader with @xwindow as X window ID. - + the #WnckApplication corresponding to + line="181">the #WnckApplication corresponding to @xwindow, or %NULL if there no such #WnckApplication could be found. The returned #WnckApplication is owned by libwnck and must not be referenced or unreferenced. @@ -197,13 +197,13 @@ unreferenced. the X window ID of a group leader. + line="176">the X window ID of a group leader. - + @@ -214,7 +214,7 @@ unreferenced. - + @@ -224,17 +224,21 @@ unreferenced. - + Gets the icon to be used for @app. If no icon is set for @app, a + line="387">Gets the icon to be used for @app. If no icon is set for @app, a suboptimal heuristic is used to find an appropriate icon. If no icon was found, a fallback icon is used. - + Use wnck_application_get_icon_surface() instead. + the icon for @app. The caller should + line="395">the icon for @app. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the icon around. @@ -243,7 +247,7 @@ the icon around. a #WnckApplication. + line="389">a #WnckApplication. @@ -252,20 +256,20 @@ the icon around. c:identifier="wnck_application_get_icon_is_fallback"> Gets whether a default fallback icon is used for @app (because none + line="573">Gets whether a default fallback icon is used for @app (because none was set on @app). - + %TRUE if the icon for @app is a fallback, %FALSE otherwise. + line="580">%TRUE if the icon for @app is a fallback, %FALSE otherwise. a #WnckApplication + line="575">a #WnckApplication @@ -274,14 +278,14 @@ was set on @app). c:identifier="wnck_application_get_icon_name"> Gets the icon name of @app (to be used when @app is minimized). Since + line="266">Gets the icon name of @app (to be used when @app is minimized). Since there is no way to properly find this name, various suboptimal heuristics are used to find it. - + the icon name of @app, or a fallback icon name if no icon name + line="274">the icon name of @app, or a fallback icon name if no icon name is available. @@ -289,23 +293,51 @@ is available. a #WnckApplication + line="268">a #WnckApplication + + + + + + Gets the icon-surface to be used for @app. If no icon-surfaceis set for @app, +a suboptimal heuristic is used to find an appropriate icon. If no icon-surface +was found, a fallback icon-surface is used. + + + a reference to the icon-surface for @app. The +caller should unreference the <classname>cairo_surface_t</classname> once done +with it. + + + + + a #WnckApplication. + c:identifier="wnck_application_get_mini_icon" + deprecated="1" + deprecated-version="41.0"> Gets the mini-icon to be used for @app. If no mini-icon is set for @app, + line="449">Gets the mini-icon to be used for @app. If no mini-icon is set for @app, a suboptimal heuristic is used to find an appropriate icon. If no mini-icon was found, a fallback mini-icon is used. - + Use wnck_application_get_mini_icon_surface() instead. + the mini-icon for @app. The caller should + line="457">the mini-icon for @app. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the mini-icon around. @@ -314,7 +346,32 @@ the mini-icon around. a #WnckApplication. + line="451">a #WnckApplication. + + + + + + Gets the mini-icon-surface to be used for @app. If no mini-icon-surfaceis set +for @app, a suboptimal heuristic is used to find an appropriate icon. If no +mini-icon-surface was found, a fallback mini-icon-surface is used. + + + a reference to the mini-icon-surface for @app. +The caller should unreference the <classname>cairo_surface_t</classname> once +done with it. + + + + + a #WnckApplication. @@ -323,19 +380,19 @@ the mini-icon around. c:identifier="wnck_application_get_n_windows"> Gets the number of #WnckWindow belonging to @app. - + line="226">Gets the number of #WnckWindow belonging to @app. + the number of #WnckWindow belonging to @app. + line="232">the number of #WnckWindow belonging to @app. a #WnckApplication. + line="228">a #WnckApplication. @@ -343,24 +400,24 @@ the mini-icon around. Gets the name of @app. Since there is no way to properly find this name, + line="242">Gets the name of @app. Since there is no way to properly find this name, various suboptimal heuristics are used to find it. GTK+ should probably have a function to allow applications to set the _NET_WM_NAME property on the group leader as the application name, and the <ulink url="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html">EWMH</ulink> should say that this is where the application name goes. - + the name of @app, or a fallback name if no name is available. + line="253">the name of @app, or a fallback name if no name is available. a #WnckApplication. + line="244">a #WnckApplication. @@ -368,19 +425,19 @@ should say that this is where the application name goes. Gets the process ID of @app. - + line="292">Gets the process ID of @app. + the process ID of @app, or 0 if none is available. + line="298">the process ID of @app, or 0 if none is available. a #WnckApplication. + line="294">a #WnckApplication. @@ -390,12 +447,12 @@ should say that this is where the application name goes. version="2.2"> Gets the startup sequence ID used for startup notification of @app. - + line="599">Gets the startup sequence ID used for startup notification of @app. + the startup sequence ID used for startup notification of @app, + line="605">the startup sequence ID used for startup notification of @app, or %NULL if none is available. @@ -403,7 +460,7 @@ or %NULL if none is available. a #WnckApplication. + line="601">a #WnckApplication. @@ -411,12 +468,12 @@ or %NULL if none is available. Gets the list of #WnckWindow belonging to @app. - + line="208">Gets the list of #WnckWindow belonging to @app. + the list of + line="214">the list of #WnckWindow belonging to @app, or %NULL if the application contains no window. The list should not be modified nor freed, as it is owned by @app. @@ -427,7 +484,7 @@ window. The list should not be modified nor freed, as it is owned by @app. a #WnckApplication. + line="210">a #WnckApplication. @@ -435,19 +492,19 @@ window. The list should not be modified nor freed, as it is owned by @app. Gets the X window ID of the group leader window for @app. - + line="192">Gets the X window ID of the group leader window for @app. + the X window ID of the group leader window for @app. + line="198">the X window ID of the group leader window for @app. a #WnckApplication. + line="194">a #WnckApplication. @@ -478,13 +535,13 @@ window. The list should not be modified nor freed, as it is owned by @app. - + - + @@ -497,7 +554,7 @@ window. The list should not be modified nor freed, as it is owned by @app. - + @@ -510,7 +567,7 @@ window. The list should not be modified nor freed, as it is owned by @app. - + @@ -518,7 +575,7 @@ window. The list should not be modified nor freed, as it is owned by @app. - + @@ -526,7 +583,7 @@ window. The list should not be modified nor freed, as it is owned by @app. - + @@ -534,7 +591,7 @@ window. The list should not be modified nor freed, as it is owned by @app. - + @@ -545,7 +602,7 @@ window. The list should not be modified nor freed, as it is owned by @app. c:type="WnckApplicationPrivate" disguised="1" opaque="1"> - + - + @@ -582,7 +639,7 @@ window. The list should not be modified nor freed, as it is owned by @app. - + @@ -591,7 +648,7 @@ window. The list should not be modified nor freed, as it is owned by @app. - + @@ -606,18 +663,18 @@ window. The list should not be modified nor freed, as it is owned by @app. glib:type-struct="ClassGroupClass"> The #WnckClassGroup struct contains only private fields and should not be + line="47">The #WnckClassGroup struct contains only private fields and should not be directly accessed. - + Gets the #WnckClassGroup corresponding to @id. - + line="180">Gets the #WnckClassGroup corresponding to @id. + the #WnckClassGroup corresponding to + line="186">the #WnckClassGroup corresponding to @id, or %NULL if there is no #WnckClassGroup with the specified @id. The returned #WnckClassGroup is owned by libwnck and must not be referenced or unreferenced. @@ -627,13 +684,13 @@ referenced or unreferenced. identifier name of the sought resource class. + line="182">identifier name of the sought resource class. - + @@ -644,7 +701,7 @@ referenced or unreferenced. - + @@ -656,19 +713,22 @@ referenced or unreferenced. + version="2.2" + deprecated="1" + deprecated-version="41.0"> Gets the icon to be used for @class_group. Since there is no way to + line="677">Gets the icon to be used for @class_group. Since there is no way to properly find the icon, a suboptimal heuristic is used to find it. The icon is the first icon found by looking at all the #WnckApplication for each #WnckWindow in @class_group, then at all the #WnckWindow in @class_group. If no icon was found, a fallback icon is used. - + Use wnck_class_group_get_icon_surface() instead. + the icon for @class_group. The caller should + line="687">the icon for @class_group. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the icon around. @@ -677,7 +737,31 @@ the icon around. a #WnckClassGroup. + line="679">a #WnckClassGroup. + + + + + + Gets the icon-surface to be used for @class_group. Since there is no way to +properly find the icon-surface, the same suboptimal heuristic as the one for +wnck_class_group_get_icon() is used to find it. + + + the icon-surface for @class_group. The caller should +unreference the returned <classname>cairo_surface_t</classname> once done with it. + + + + + a #WnckClassGroup. @@ -687,13 +771,13 @@ the icon around. version="3.2"> Gets the identifier name for @class_group. This is the resource class for + line="613">Gets the identifier name for @class_group. This is the resource class for @class_group. - + the identifier name of @class_group, or an + line="620">the identifier name of @class_group, or an empty string if the group has no identifier name. @@ -701,24 +785,27 @@ empty string if the group has no identifier name. a #WnckClassGroup. + line="615">a #WnckClassGroup. + version="2.2" + deprecated="1" + deprecated-version="41.0"> Gets the mini-icon to be used for @class_group. Since there is no way to + line="733">Gets the mini-icon to be used for @class_group. Since there is no way to properly find the mini-icon, the same suboptimal heuristic as the one for wnck_class_group_get_icon() is used to find it. - + Use wnck_class_group_get_mini_icon_surface() instead. + the mini-icon for @class_group. The caller + line="741">the mini-icon for @class_group. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the mini-icon around. @@ -727,7 +814,31 @@ to keep the mini-icon around. a #WnckClassGroup. + line="735">a #WnckClassGroup. + + + + + + Gets the mini-icon-surface to be used for @class_group. Since there is no way to +properly find the mini-icon-surface, the same suboptimal heuristic as the one for +wnck_class_group_get_icon() is used to find it. + + + the mini-icon-surface for @class_group. The caller should +unreference the returned <classname>cairo_surface_t</classname> once done with it. + + + + + a #WnckClassGroup. @@ -737,25 +848,25 @@ to keep the mini-icon around. version="2.2"> Gets an human-readable name for @class_group. Since there is no way to + line="653">Gets an human-readable name for @class_group. Since there is no way to properly find this name, a suboptimal heuristic is used to find it. The name is the name of all #WnckApplication for each #WnckWindow in @class_group if they all have the same name. If all #WnckApplication don't have the same name, the name is the name of all #WnckWindow in @class_group if they all have the same name. If all #WnckWindow don't have the same name, the resource class name is used. - + an human-readable name for @class_group. + line="665">an human-readable name for @class_group. a #WnckClassGroup. + line="655">a #WnckClassGroup. @@ -767,13 +878,13 @@ resource class name is used. deprecated-version="3.2"> Gets the resource class name for @class_group. + line="633">Gets the resource class name for @class_group. Use wnck_class_group_get_id() instead. - + the resource class name of @class_group, or an + line="639">the resource class name of @class_group, or an empty string if the group has no resource class name. @@ -781,7 +892,7 @@ empty string if the group has no resource class name. a #WnckClassGroup. + line="635">a #WnckClassGroup. @@ -791,12 +902,12 @@ empty string if the group has no resource class name. version="2.2"> Gets the list of #WnckWindow that are grouped in @class_group. - + line="592">Gets the list of #WnckWindow that are grouped in @class_group. + the list of + line="598">the list of #WnckWindow grouped in @class_group, or %NULL if the group contains no window. The list should not be modified nor freed, as it is owned by @class_group. @@ -808,7 +919,7 @@ window. The list should not be modified nor freed, as it is owned by a #WnckClassGroup. + line="594">a #WnckClassGroup. @@ -839,13 +950,13 @@ window. The list should not be modified nor freed, as it is owned by - + - + @@ -858,7 +969,7 @@ window. The list should not be modified nor freed, as it is owned by - + @@ -871,7 +982,7 @@ window. The list should not be modified nor freed, as it is owned by - + @@ -879,7 +990,7 @@ window. The list should not be modified nor freed, as it is owned by - + @@ -887,7 +998,7 @@ window. The list should not be modified nor freed, as it is owned by - + @@ -895,7 +1006,7 @@ window. The list should not be modified nor freed, as it is owned by - + @@ -906,7 +1017,7 @@ window. The list should not be modified nor freed, as it is owned by c:type="WnckClassGroupPrivate" disguised="1" opaque="1"> - + Creates a new #WnckHandle object with a given @client_type. + line="327">Creates a new #WnckHandle object with a given @client_type. newly created #WnckHandle. + line="333">newly created #WnckHandle. a role for the client + line="329">a role for the client @@ -980,13 +1091,13 @@ with window management, like pagers and taskbars. c:identifier="wnck_handle_get_application"> Gets the #WnckApplication corresponding to the group leader with @xwindow + line="570">Gets the #WnckApplication corresponding to the group leader with @xwindow as X window ID. the #WnckApplication corresponding to + line="578">the #WnckApplication corresponding to @xwindow, or %NULL if there no such #WnckApplication could be found. The returned #WnckApplication is owned by libwnck and must not be referenced or unreferenced. @@ -996,13 +1107,13 @@ unreferenced. a #WnckHandle + line="572">a #WnckHandle the X window ID of a group leader. + line="573">the X window ID of a group leader. @@ -1011,12 +1122,12 @@ unreferenced. c:identifier="wnck_handle_get_class_group"> Gets the #WnckClassGroup corresponding to @id. + line="533">Gets the #WnckClassGroup corresponding to @id. the #WnckClassGroup corresponding to + line="540">the #WnckClassGroup corresponding to @id, or %NULL if there is no #WnckClassGroup with the specified @id. The returned #WnckClassGroup is owned by libwnck and must not be referenced or unreferenced. @@ -1026,13 +1137,13 @@ referenced or unreferenced. a #WnckHandle + line="535">a #WnckHandle identifier name of the sought resource class. + line="536">identifier name of the sought resource class. @@ -1041,12 +1152,12 @@ referenced or unreferenced. c:identifier="wnck_handle_get_default_screen"> Gets the default #WnckScreen on the default display. + line="349">Gets the default #WnckScreen on the default display. the default #WnckScreen. The + line="355">the default #WnckScreen. The returned #WnckScreen is owned by #WnckHandle and must not be referenced or unreferenced. This can return %NULL if not on X11. @@ -1055,7 +1166,7 @@ or unreferenced. This can return %NULL if not on X11. a #WnckHandle + line="351">a #WnckHandle @@ -1063,12 +1174,12 @@ or unreferenced. This can return %NULL if not on X11. Gets the #WnckScreen for a given screen on the default display. + line="373">Gets the #WnckScreen for a given screen on the default display. the #WnckScreen for screen @index, or %NULL + line="380">the #WnckScreen for screen @index, or %NULL if no such screen exists. The returned #WnckScreen is owned by #WnckHandle and must not be referenced or unreferenced. @@ -1077,13 +1188,13 @@ and must not be referenced or unreferenced. a #WnckHandle + line="375">a #WnckHandle screen number, starting from 0. + line="376">screen number, starting from 0. @@ -1092,7 +1203,7 @@ and must not be referenced or unreferenced. c:identifier="wnck_handle_get_screen_for_root"> Gets the #WnckScreen for the root window at @root_window_id, or + line="411">Gets the #WnckScreen for the root window at @root_window_id, or %NULL if no #WnckScreen exists for this root window. This function does not work if wnck_handle_get_screen() was not called @@ -1101,7 +1212,7 @@ for the sought #WnckScreen before, and returns %NULL. the #WnckScreen for the root window at + line="422">the #WnckScreen for the root window at @root_window_id, or %NULL. The returned #WnckScreen is owned by #WnckHandle and must not be referenced or unreferenced. @@ -1110,13 +1221,13 @@ for the sought #WnckScreen before, and returns %NULL. a #WnckHandle + line="413">a #WnckHandle an X window ID. + line="414">an X window ID. @@ -1124,14 +1235,14 @@ for the sought #WnckScreen before, and returns %NULL. Gets a preexisting #WnckWindow for the X window @xwindow. This will not + line="607">Gets a preexisting #WnckWindow for the X window @xwindow. This will not create a #WnckWindow if none exists. The function is robust against bogus window IDs. the #WnckWindow for @xwindow. The returned + line="616">the #WnckWindow for @xwindow. The returned #WnckWindow is owned by libwnck and must not be referenced or unreferenced. @@ -1139,13 +1250,13 @@ window IDs. a #WnckHandle + line="609">a #WnckHandle an X window ID. + line="610">an X window ID. @@ -1154,7 +1265,7 @@ window IDs. c:identifier="wnck_handle_set_default_icon_size"> The default main icon size is %WNCK_DEFAULT_ICON_SIZE. This function allows + line="455">The default main icon size is %WNCK_DEFAULT_ICON_SIZE. This function allows to change this value. @@ -1164,13 +1275,13 @@ to change this value. a #WnckHandle + line="457">a #WnckHandle the default size for windows and application standard icons. + line="458">the default size for windows and application standard icons. @@ -1179,7 +1290,7 @@ to change this value. c:identifier="wnck_handle_set_default_mini_icon_size"> The default main icon size is %WNCK_DEFAULT_MINI_ICON_SIZE. This function + line="485">The default main icon size is %WNCK_DEFAULT_MINI_ICON_SIZE. This function allows to change this value. @@ -1189,13 +1300,13 @@ allows to change this value. a #WnckHandle + line="487">a #WnckHandle the default size for windows and application mini icons. + line="488">the default size for windows and application mini icons. @@ -1237,7 +1348,7 @@ allows to change this value. - + @@ -1246,7 +1357,7 @@ allows to change this value. - + @@ -1255,7 +1366,7 @@ allows to change this value. - + @@ -1264,7 +1375,7 @@ allows to change this value. - + @@ -1345,7 +1456,7 @@ allows to change this value. - + @@ -1354,7 +1465,7 @@ allows to change this value. - + @@ -1417,7 +1528,7 @@ allows to change this value. + line="43"/> @@ -1430,7 +1541,7 @@ allows to change this value. + line="45"/> @@ -1456,10 +1567,26 @@ allows to change this value. + + + + + + + + + + + + + + + line="40"/> @@ -1488,12 +1615,12 @@ allows to change this value. introspectable="0"> Specifies the type of function passed to wnck_tasklist_set_icon_loader(). - + line="117">Specifies the type of function passed to wnck_tasklist_set_icon_loader(). + it should return a <classname>GdkPixbuf</classname> of @icon_name + line="128">it should return a <classname>GdkPixbuf</classname> of @icon_name at size @size, or %NULL if no icon for @icon_name at size @size could be loaded. @@ -1502,20 +1629,65 @@ loaded. an icon name as in the Icon field in a .desktop file for the + line="119">an icon name as in the Icon field in a .desktop file for the +icon to load. + + + + the desired icon size. + + + + not defined to do anything yet. + + + + data passed to the function, set when the #WnckLoadIconFunction has +been set for the #WnckTasklist. + + + + + + Specifies the type of function passed to wnck_tasklist_set_icon_loader(). + + + it should return a <classname>cairo_surface_t</classname> of @icon_name +at size @size, or %NULL if no icon for @icon_name at size @size could be +loaded. + + + + + an icon name as in the Icon field in a .desktop file for the icon to load. the desired icon size. + line="148">the desired icon size. not defined to do anything yet. + line="149">not defined to do anything yet. allow-none="1"> data passed to the function, set when the #WnckLoadIconFunction has + line="150">data passed to the function, set when the #WnckLoadSurfaceFunction has been set for the #WnckTasklist. @@ -1642,13 +1814,13 @@ directly accessed. Creates a new #WnckPager. The #WnckPager will show the #WnckWorkspace of the + line="2271">Creates a new #WnckPager. The #WnckPager will show the #WnckWorkspace of the #WnckScreen it is on. a newly created #WnckPager. + line="2277">a newly created #WnckPager. @@ -1656,20 +1828,20 @@ directly accessed. c:identifier="wnck_pager_new_with_handle"> Creates a new #WnckPager. The #WnckPager will show the #WnckWorkspace of the + line="2291">Creates a new #WnckPager. The #WnckPager will show the #WnckWorkspace of the #WnckScreen it is on. a newly created #WnckPager. + line="2298">a newly created #WnckPager. a #WnckHandle + line="2293">a #WnckHandle @@ -1681,7 +1853,7 @@ directly accessed. %TRUE if the @pager wraps workspaces on a scroll event that + line="2578">%TRUE if the @pager wraps workspaces on a scroll event that hits a border, %FALSE otherwise. @@ -1689,7 +1861,7 @@ hits a border, %FALSE otherwise. a #WnckPager. + line="2576">a #WnckPager. @@ -1698,7 +1870,7 @@ hits a border, %FALSE otherwise. c:identifier="wnck_pager_set_display_mode"> Sets the display mode for @pager to @mode. + line="2463">Sets the display mode for @pager to @mode. @@ -1707,13 +1879,13 @@ hits a border, %FALSE otherwise. a #WnckPager. + line="2465">a #WnckPager. a display mode. + line="2466">a display mode. @@ -1721,7 +1893,7 @@ hits a border, %FALSE otherwise. Tries to change the number of rows in the layout of #WnckWorkspace on the + line="2415">Tries to change the number of rows in the layout of #WnckWorkspace on the #WnckScreen @pager is watching. Since no more than one application should set this property of a #WnckScreen at a time, setting the layout is not guaranteed to work. @@ -1732,7 +1904,7 @@ because @pager can't know the screen on which to modify the layout. %TRUE if the layout of #WnckWorkspace has been successfully + line="2429">%TRUE if the layout of #WnckWorkspace has been successfully changed or did not need to be changed, %FALSE otherwise. @@ -1740,13 +1912,13 @@ changed or did not need to be changed, %FALSE otherwise. a #WnckPager. + line="2417">a #WnckPager. the number of rows to use for the layout of #WnckWorkspace on the + line="2418">the number of rows to use for the layout of #WnckWorkspace on the #WnckScreen @pager is watching. @@ -1755,7 +1927,7 @@ changed or did not need to be changed, %FALSE otherwise. Tries to change the orientation of the layout of #WnckWorkspace on the + line="2353">Tries to change the orientation of the layout of #WnckWorkspace on the #WnckScreen @pager is watching. Since no more than one application should set this property of a #WnckScreen at a time, setting the layout is not guaranteed to work. @@ -1781,7 +1953,7 @@ because @pager can't know the screen on which to modify the orientation. %TRUE if the layout of #WnckWorkspace has been successfully + line="2382">%TRUE if the layout of #WnckWorkspace has been successfully changed or did not need to be changed, %FALSE otherwise. @@ -1789,13 +1961,13 @@ changed or did not need to be changed, %FALSE otherwise. a #WnckPager. + line="2355">a #WnckPager. orientation to use for the layout of #WnckWorkspace on the + line="2356">orientation to use for the layout of #WnckWorkspace on the #WnckScreen @pager is watching. @@ -1806,7 +1978,7 @@ changed or did not need to be changed, %FALSE otherwise. version="3.36"> Sets @pager to react to input device scrolling in one of the + line="2485">Sets @pager to react to input device scrolling in one of the available scroll modes. @@ -1816,13 +1988,13 @@ available scroll modes. a #WnckPager. + line="2487">a #WnckPager. a scroll mode. + line="2488">a scroll mode. @@ -1832,7 +2004,7 @@ available scroll modes. version="2.2"> Sets the shadow type for @pager to @shadow_type. The main use of this + line="2530">Sets the shadow type for @pager to @shadow_type. The main use of this function is proper integration of #WnckPager in panels with non-system backgrounds. @@ -1843,13 +2015,13 @@ backgrounds. a #WnckPager. + line="2532">a #WnckPager. a shadow type. + line="2533">a shadow type. @@ -1857,7 +2029,7 @@ backgrounds. Sets @pager to display all #WnckWorkspace or not, according to + line="2507">Sets @pager to display all #WnckWorkspace or not, according to @show_all_workspaces. @@ -1867,13 +2039,13 @@ backgrounds. a #WnckPager. + line="2509">a #WnckPager. whether to display all #WnckWorkspace in @pager. + line="2510">whether to display all #WnckWorkspace in @pager. @@ -1883,7 +2055,7 @@ backgrounds. version="3.24.0"> Sets the wrapping behavior of the @pager. Setting it to %TRUE will + line="2554">Sets the wrapping behavior of the @pager. Setting it to %TRUE will wrap arround to the start when scrolling over the end and vice versa. By default it is set to %FALSE. @@ -1894,13 +2066,13 @@ versa. By default it is set to %FALSE. a #WnckPager. + line="2556">a #WnckPager. a boolean. + line="2557">a boolean. @@ -2630,19 +2802,19 @@ referenced or unreferenced. c:identifier="wnck_screen_get_background_pixmap"> Gets the X window ID of the background pixmap of @screen. + line="2362">Gets the X window ID of the background pixmap of @screen. the X window ID of the background pixmap of @screen. + line="2368">the X window ID of the background pixmap of @screen. a #WnckScreen. + line="2364">a #WnckScreen. @@ -2670,19 +2842,19 @@ referenced or unreferenced. Gets the height of @screen. + line="2394">Gets the height of @screen. the height of @screen. + line="2400">the height of @screen. a #WnckScreen. + line="2396">a #WnckScreen. @@ -2741,20 +2913,20 @@ referenced or unreferenced. version="2.2"> Gets whether @screen is in the "showing the desktop" mode. This mode is + line="2535">Gets whether @screen is in the "showing the desktop" mode. This mode is changed when a #WnckScreen::showing-desktop-changed signal gets emitted. %TRUE if @window is fullscreen, %FALSE otherwise. + line="2542">%TRUE if @window is fullscreen, %FALSE otherwise. a #WnckScreen. + line="2537">a #WnckScreen. @@ -2762,19 +2934,19 @@ changed when a #WnckScreen::showing-desktop-changed signal gets emitted. Gets the width of @screen. + line="2378">Gets the width of @screen. the width of @screen. + line="2384">the width of @screen. a #WnckScreen. + line="2380">a #WnckScreen. @@ -2784,12 +2956,12 @@ changed when a #WnckScreen::showing-desktop-changed signal gets emitted. version="2.20"> Gets the name of the window manager. + line="2309">Gets the name of the window manager. the name of the window manager, or %NULL if the window manager + line="2315">the name of the window manager, or %NULL if the window manager does not comply with the <ulink url="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html">EWMH</ulink> specification. @@ -2799,7 +2971,7 @@ specification. a #WnckScreen. + line="2311">a #WnckScreen. @@ -2938,7 +3110,7 @@ is owned by @screen. version="2.4"> Asks the window manager to move the viewport of the current #WnckWorkspace + line="2575">Asks the window manager to move the viewport of the current #WnckWorkspace on @screen. @@ -2948,19 +3120,19 @@ on @screen. a #WnckScreen. + line="2577">a #WnckScreen. X offset in pixels of viewport. + line="2578">X offset in pixels of viewport. Y offset in pixels of viewport. + line="2579">Y offset in pixels of viewport. @@ -2969,7 +3141,7 @@ on @screen. c:identifier="wnck_screen_net_wm_supports"> Gets whether the window manager for @screen supports a certain hint from + line="2330">Gets whether the window manager for @screen supports a certain hint from the <ulink url="http://standards.freedesktop.org/wm-spec/wm-spec-latest.html">Extended Window Manager Hints specification</ulink> (EWMH). @@ -2986,7 +3158,7 @@ See also gdk_x11_screen_supports_net_wm_hint() in GDK. %TRUE if the window manager for @screen supports the @atom + line="2349">%TRUE if the window manager for @screen supports the @atom hint, %FALSE otherwise. @@ -2994,13 +3166,13 @@ hint, %FALSE otherwise. a #WnckScreen. + line="2332">a #WnckScreen. a property atom. + line="2333">a property atom. @@ -3009,7 +3181,7 @@ hint, %FALSE otherwise. c:identifier="wnck_screen_release_workspace_layout"> Releases the ownership of the layout of #WnckWorkspace on @screen. + line="2514">Releases the ownership of the layout of #WnckWorkspace on @screen. @current_token is used to verify that the caller is the owner of the layout. If the verification fails, nothing happens. @@ -3020,13 +3192,13 @@ If the verification fails, nothing happens. a #WnckScreen. + line="2516">a #WnckScreen. the token obtained through + line="2517">the token obtained through wnck_screen_try_set_workspace_layout(). @@ -3037,7 +3209,7 @@ wnck_screen_try_set_workspace_layout(). version="2.2"> Asks the window manager to set the "showing the desktop" mode on @screen + line="2554">Asks the window manager to set the "showing the desktop" mode on @screen according to @show. @@ -3047,13 +3219,13 @@ according to @show. a #WnckScreen. + line="2556">a #WnckScreen. whether to activate the "showing the desktop" mode on @screen. + line="2557">whether to activate the "showing the desktop" mode on @screen. @@ -3062,7 +3234,7 @@ according to @show. c:identifier="wnck_screen_try_set_workspace_layout"> Tries to modify the layout of #WnckWorkspace on @screen. To do this, tries + line="2463">Tries to modify the layout of #WnckWorkspace on @screen. To do this, tries to acquire ownership of the layout. If the current process is the owner of the layout, @current_token is used to determine if the caller is the owner (there might be more than one part of the same process trying to set the @@ -3080,7 +3252,7 @@ wnck_screen_release_workspace_layout() when you do not need it anymore. a token to use for future calls to + line="2487">a token to use for future calls to wnck_screen_try_set_workspace_layout() and to wnck_screen_release_workspace_layout(), or 0 if the layout could not be set. @@ -3089,13 +3261,13 @@ wnck_screen_release_workspace_layout(), or 0 if the layout could not be set. a #WnckScreen. + line="2465">a #WnckScreen. a token. Use 0 if you do not called + line="2466">a token. Use 0 if you do not called wnck_screen_try_set_workspace_layout() before, or if you did not keep the old token. @@ -3103,13 +3275,13 @@ old token. the number of rows to use for the #WnckWorkspace layout. + line="2469">the number of rows to use for the #WnckWorkspace layout. the number of columns to use for the #WnckWorkspace layout. + line="2470">the number of columns to use for the #WnckWorkspace layout. @@ -3620,13 +3792,13 @@ directly accessed. Creates a new #WnckSelector. The #WnckSelector will list #WnckWindow of the + line="1336">Creates a new #WnckSelector. The #WnckSelector will list #WnckWindow of the #WnckScreen it is on. a newly created #WnckSelector. + line="1342">a newly created #WnckSelector. @@ -3634,20 +3806,20 @@ directly accessed. c:identifier="wnck_selector_new_with_handle"> Creates a new #WnckSelector. The #WnckSelector will list #WnckWindow of the + line="1358">Creates a new #WnckSelector. The #WnckSelector will list #WnckWindow of the #WnckScreen it is on. a newly created #WnckSelector. + line="1365">a newly created #WnckSelector. a #WnckHandle + line="1360">a #WnckHandle @@ -3755,13 +3927,13 @@ directly accessed. Creates a new #WnckTasklist. The #WnckTasklist will list #WnckWindow of the + line="2736">Creates a new #WnckTasklist. The #WnckTasklist will list #WnckWindow of the #WnckScreen it is on. a newly created #WnckTasklist. + line="2742">a newly created #WnckTasklist. @@ -3769,20 +3941,20 @@ directly accessed. c:identifier="wnck_tasklist_new_with_handle"> Creates a new #WnckTasklist. The #WnckTasklist will list #WnckWindow of the + line="2756">Creates a new #WnckTasklist. The #WnckTasklist will list #WnckWindow of the #WnckScreen it is on. a newly created #WnckTasklist. + line="2763">a newly created #WnckTasklist. a #WnckHandle + line="2758">a #WnckHandle @@ -3792,7 +3964,7 @@ directly accessed. version="3.24.0"> Gets the scroll behavior of the @tasklist. + line="1347">Gets the scroll behavior of the @tasklist. @@ -3801,7 +3973,7 @@ directly accessed. a #WnckTasklist. + line="1349">a #WnckTasklist. @@ -3812,7 +3984,7 @@ directly accessed. deprecated-version="3.42"> Since a #WnckTasklist does not have a fixed size (#WnckWindow can be grouped + line="2094">Since a #WnckTasklist does not have a fixed size (#WnckWindow can be grouped when needed, for example), the standard size request mechanism in GTK+ is not enough to announce what sizes can be used by @tasklist. The size hints mechanism is a solution for this. See panel_applet_set_size_hints() for more @@ -3822,7 +3994,7 @@ information. a list of size hints that can be used to allocate an + line="2106">a list of size hints that can be used to allocate an appropriate size for @tasklist. @@ -3830,44 +4002,24 @@ appropriate size for @tasklist. a #WnckTasklist. + line="2096">a #WnckTasklist. return location for the number of elements in the array + line="2097">return location for the number of elements in the array returned by this function. This number should always be pair. - - Returns whether tooltips are enabled on the @tasklist. - - - - - - - a #WnckTasklist. - - - - Sets the relief type of the buttons in @tasklist to @relief. The main use of + line="1260">Sets the relief type of the buttons in @tasklist to @relief. The main use of this function is proper integration of #WnckTasklist in panels with non-system backgrounds. @@ -3878,13 +4030,13 @@ non-system backgrounds. a #WnckTasklist. + line="1262">a #WnckTasklist. a relief type. + line="1263">a relief type. @@ -3892,7 +4044,7 @@ non-system backgrounds. Sets the grouping policy for @tasklist to @grouping. + line="1232">Sets the grouping policy for @tasklist to @grouping. @@ -3901,13 +4053,13 @@ non-system backgrounds. a #WnckTasklist. + line="1234">a #WnckTasklist. a grouping policy. + line="1235">a grouping policy. @@ -3917,7 +4069,7 @@ non-system backgrounds. c:identifier="wnck_tasklist_set_grouping_limit"> Sets the maximum size of buttons in @tasklist before @tasklist tries to + line="1417">Sets the maximum size of buttons in @tasklist before @tasklist tries to group #WnckWindow in the same #WnckApplication in only one button. This limit is valid only when the grouping policy of @tasklist is %WNCK_TASKLIST_AUTO_GROUP. @@ -3929,13 +4081,13 @@ limit is valid only when the grouping policy of @tasklist is a #WnckTasklist. + line="1419">a #WnckTasklist. a size in pixels. + line="1420">a size in pixels. @@ -3946,8 +4098,8 @@ limit is valid only when the grouping policy of @tasklist is introspectable="0"> Sets a function to be used for loading icons. - + line="1440">Sets a function to be used for loading icons. + @@ -3955,7 +4107,7 @@ limit is valid only when the grouping policy of @tasklist is a #WnckTasklist + line="1442">a #WnckTasklist icon loader function + line="1443">icon loader function data for icon loader function + line="1444">data for icon loader function function to free the data + line="1445">function to free the data @@ -3991,7 +4143,7 @@ limit is valid only when the grouping policy of @tasklist is c:identifier="wnck_tasklist_set_include_all_workspaces"> Sets @tasklist to display #WnckWindow from all #WnckWorkspace or not, + line="1383">Sets @tasklist to display #WnckWindow from all #WnckWorkspace or not, according to @include_all_workspaces. Note that if the active #WnckWorkspace has a viewport and if @@ -4010,13 +4162,13 @@ showing all #WnckWindow from all #WnckWorkspace. a #WnckTasklist. + line="1385">a #WnckTasklist. whether to display #WnckWindow from all + line="1386">whether to display #WnckWindow from all #WnckWorkspace in @tasklist. @@ -4027,7 +4179,7 @@ showing all #WnckWindow from all #WnckWorkspace. version="3.4.6"> Sets @tasklist to close windows with mouse middle click on button, + line="1290">Sets @tasklist to close windows with mouse middle click on button, according to @middle_click_close. @@ -4037,13 +4189,13 @@ according to @middle_click_close. a #WnckTasklist. + line="1292">a #WnckTasklist. whether to close windows with middle click on + line="1293">whether to close windows with middle click on button. @@ -4054,7 +4206,7 @@ button. version="3.4.6"> Set the orientation of the @tasklist to match @orient. + line="1310">Set the orientation of the @tasklist to match @orient. This function can be used to integrate a #WnckTasklist in vertical panels. @@ -4064,13 +4216,13 @@ This function can be used to integrate a #WnckTasklist in vertical panels. a #WnckTasklist. + line="1312">a #WnckTasklist. a GtkOrientation. + line="1313">a GtkOrientation. @@ -4080,7 +4232,7 @@ This function can be used to integrate a #WnckTasklist in vertical panels. version="3.24.0"> Sets the scroll behavior of the @tasklist. When set to %TRUE, a scroll + line="1328">Sets the scroll behavior of the @tasklist. When set to %TRUE, a scroll event over the tasklist will change the current window accordingly. @@ -4090,26 +4242,23 @@ event over the tasklist will change the current window accordingly. a #WnckTasklist. + line="1330">a #WnckTasklist. a boolean. + line="1331">a boolean. - + Sets @tasklist to activate or not the #WnckWorkspace a #WnckWindow is on -when unminimizing it, according to @switch_workspace_on_unminimize. - -FIXME: does it still work? - + line="1467">Sets a function to be used for loading cairo surface icons. + @@ -4117,41 +4266,63 @@ FIXME: does it still work? a #WnckTasklist. + line="1469">a #WnckTasklist - + whether to activate the #WnckWorkspace a -#WnckWindow is on when unminimizing it. - + line="1470">icon loader function + + + + data for icon loader function + + + + function to free the data + - + Sets whether tooltips are enabled on the @tasklist. - + line="1363">Sets @tasklist to activate or not the #WnckWorkspace a #WnckWindow is on +when unminimizing it, according to @switch_workspace_on_unminimize. + +FIXME: does it still work? + - + a #WnckTasklist. + line="1365">a #WnckTasklist. - + a boolean. + line="1366">whether to activate the #WnckWorkspace a +#WnckWindow is on when unminimizing it. @@ -4162,14 +4333,6 @@ FIXME: does it still work? transfer-ownership="none"> - - - @@ -4179,7 +4342,7 @@ FIXME: does it still work? Emitted when the task is entered. + line="1115">Emitted when the task is entered. @@ -4190,7 +4353,7 @@ FIXME: does it still work? allow-none="1"> the #GList with all the #WnckWindow belonging to the task. + line="1118">the #GList with all the #WnckWindow belonging to the task. @@ -4198,7 +4361,7 @@ FIXME: does it still work? Emitted when the task is entered. + line="1130">Emitted when the task is entered. @@ -4209,7 +4372,7 @@ FIXME: does it still work? allow-none="1"> the #GList with all the #WnckWindow belonging to the task. + line="1133">the #GList with all the #WnckWindow belonging to the task. @@ -4304,7 +4467,7 @@ to have a good-looking list of all #WnckWindow. - + @@ -4313,7 +4476,7 @@ to have a good-looking list of all #WnckWindow. - + @@ -4322,7 +4485,7 @@ to have a good-looking list of all #WnckWindow. - + @@ -4364,20 +4527,20 @@ to have a good-looking list of all #WnckWindow. glib:type-struct="WindowClass"> The #WnckWindow struct contains only private fields and should not be + line="237">The #WnckWindow struct contains only private fields and should not be directly accessed. - + Gets a preexisting #WnckWindow for the X window @xwindow. This will not + line="434">Gets a preexisting #WnckWindow for the X window @xwindow. This will not create a #WnckWindow if none exists. The function is robust against bogus window IDs. - + the #WnckWindow for @xwindow. The returned + line="442">the #WnckWindow for @xwindow. The returned #WnckWindow is owned by libwnck and must not be referenced or unreferenced. @@ -4385,13 +4548,13 @@ window IDs. an X window ID. + line="436">an X window ID. - + @@ -4408,7 +4571,7 @@ window IDs. - + @@ -4419,7 +4582,7 @@ window IDs. - + @@ -4430,7 +4593,7 @@ window IDs. - + @@ -4441,7 +4604,7 @@ window IDs. - + @@ -4452,7 +4615,7 @@ window IDs. - + @@ -4463,7 +4626,7 @@ window IDs. - + @@ -4480,7 +4643,7 @@ window IDs. - + @@ -4491,7 +4654,7 @@ window IDs. - + @@ -4506,14 +4669,14 @@ window IDs. version="2.10"> Asks the window manager to make @window the active window. The + line="1902">Asks the window manager to make @window the active window. The window manager may choose to raise @window along with focusing it, and may decide to refuse the request (to not steal the focus if there is a more recent user activity, for example). This function existed before 2.10, but the @timestamp argument was missing in earlier versions. - + @@ -4521,13 +4684,13 @@ in earlier versions. a #WnckWindow. + line="1904">a #WnckWindow. the X server timestamp of the user interaction event that caused + line="1905">the X server timestamp of the user interaction event that caused this call to occur. @@ -4538,7 +4701,7 @@ this call to occur. version="2.10"> If @window has transients, activates the most likely transient + line="2009">If @window has transients, activates the most likely transient instead of the window itself. Otherwise activates @window. FIXME the ideal behavior of this function is probably to activate @@ -4547,7 +4710,7 @@ This is probably best implemented on the window manager side. This function existed before 2.10, but the @timestamp argument was missing in earlier versions. - + @@ -4555,13 +4718,13 @@ in earlier versions. a #WnckWindow. + line="2011">a #WnckWindow. the X server timestamp of the user interaction event that caused + line="2012">the X server timestamp of the user interaction event that caused this call to occur. @@ -4570,11 +4733,11 @@ this call to occur. Closes @window. + line="1448">Closes @window. This function existed before 2.6, but the @timestamp argument was missing in earlier versions. - + @@ -4582,13 +4745,13 @@ in earlier versions. a #WnckWindow. + line="1450">a #WnckWindow. the X server timestamp of the user interaction event that caused + line="1451">the X server timestamp of the user interaction event that caused this call to occur. @@ -4597,19 +4760,19 @@ this call to occur. Gets the actions that can be done for @window. - + line="2327">Gets the actions that can be done for @window. + bitmask of actions that can be done for @window. + line="2333">bitmask of actions that can be done for @window. a #WnckWindow. + line="2329">a #WnckWindow. @@ -4618,12 +4781,12 @@ this call to occur. c:identifier="wnck_window_get_application"> Gets the #WnckApplication to which @window belongs. - + line="706">Gets the #WnckApplication to which @window belongs. + the #WnckApplication to which @window belongs. + line="712">the #WnckApplication to which @window belongs. The returned #WnckApplication is owned by libwnck and must not be referenced or unreferenced. @@ -4632,7 +4795,7 @@ or unreferenced. a #WnckWindow. + line="708">a #WnckWindow. @@ -4642,12 +4805,12 @@ or unreferenced. version="2.2"> Gets the #WnckClassGroup to which @window belongs. - + line="783">Gets the #WnckClassGroup to which @window belongs. + the #WnckClassGroup to which @window belongs. + line="789">the #WnckClassGroup to which @window belongs. The returned #WnckClassGroup is owned by libwnck and must not be referenced or unreferenced. @@ -4656,7 +4819,7 @@ or unreferenced. a #WnckWindow. + line="785">a #WnckWindow. @@ -4665,17 +4828,17 @@ or unreferenced. c:identifier="wnck_window_get_class_group_name"> Gets the class group name from the <ulink + line="1182">Gets the class group name from the <ulink url="http://tronche.com/gui/x/icccm/sec-4.html&num;WM_CLASS">WM_CLASS Property</ulink> for @window. The class group name is also the identifier name of the #WnckClassGroup to which @window belongs. - + the class group name for @window, or %NULL if @window belongs + line="1193">the class group name for @window, or %NULL if @window belongs to no class group. @@ -4683,7 +4846,7 @@ to no class group. a #WnckWindow. + line="1184">a #WnckWindow. @@ -4692,17 +4855,17 @@ to no class group. c:identifier="wnck_window_get_class_instance_name"> Gets the class instance name from the <ulink + line="1204">Gets the class instance name from the <ulink url="http://tronche.com/gui/x/icccm/sec-4.html&num;WM_CLASS">WM_CLASS Property</ulink> for @window. The class instance name allows to differentiate windows belonging to the same class group, so that they can use different resources. - + the class instance name for @window, or %NULL if @window has + line="1215">the class instance name for @window, or %NULL if @window has no class instance. @@ -4710,7 +4873,7 @@ no class instance. a #WnckWindow. + line="1206">a #WnckWindow. @@ -4720,7 +4883,7 @@ no class instance. version="2.20"> Gets the size and position of @window, as last received + line="2360">Gets the size and position of @window, as last received in a ConfigureNotify event (i.e. this call does not round-trip to the server, just gets the last size we were notified of). The X and Y coordinates are relative to the root window. @@ -4728,7 +4891,7 @@ The X and Y coordinates are relative to the root window. The window manager usually adds a frame around windows. If you need to know the size of @window with the frame, use wnck_window_get_geometry(). - + @@ -4736,7 +4899,7 @@ wnck_window_get_geometry(). a #WnckWindow. + line="2362">a #WnckWindow. transfer-ownership="full"> return location for X coordinate in pixels of @window. + line="2363">return location for X coordinate in pixels of @window. transfer-ownership="full"> return location for Y coordinate in pixels of @window. + line="2364">return location for Y coordinate in pixels of @window. transfer-ownership="full"> return location for width in pixels of @window. + line="2365">return location for width in pixels of @window. transfer-ownership="full"> return location for height in pixels of @window. + line="2366">return location for height in pixels of @window. @@ -4780,7 +4943,7 @@ wnck_window_get_geometry(). Gets the size and position of @window, including decorations. This + line="2398">Gets the size and position of @window, including decorations. This function uses the information last received in a ConfigureNotify event and adjusts it according to the size of the frame that is added by the window manager (this call does not round-trip to the @@ -4789,7 +4952,7 @@ X and Y coordinates are relative to the root window. If you need to know the actual size of @window ignoring the frame added by the window manager, use wnck_window_get_client_window_geometry(). - + @@ -4797,7 +4960,7 @@ added by the window manager, use wnck_window_get_client_window_geometry(). a #WnckWindow. + line="2400">a #WnckWindow. transfer-ownership="full"> return location for X coordinate in pixels of @window. + line="2401">return location for X coordinate in pixels of @window. transfer-ownership="full"> return location for Y coordinate in pixels of @window. + line="2402">return location for Y coordinate in pixels of @window. transfer-ownership="full"> return location for width in pixels of @window. + line="2403">return location for width in pixels of @window. transfer-ownership="full"> return location for height in pixels of @window. + line="2404">return location for height in pixels of @window. @@ -4842,12 +5005,12 @@ added by the window manager, use wnck_window_get_client_window_geometry(). c:identifier="wnck_window_get_group_leader"> Gets the group leader of the group of windows to which @window belongs. - + line="749">Gets the group leader of the group of windows to which @window belongs. + the group leader of the group of windows to which @window + line="755">the group leader of the group of windows to which @window belongs, or the X window ID of @window if @window does not belong to any group. @@ -4856,22 +5019,26 @@ group. a #WnckWindow. + line="751">a #WnckWindow. - + Gets the icon to be used for @window. If no icon was found, a fallback + line="2158">Gets the icon to be used for @window. If no icon was found, a fallback icon is used. wnck_window_get_icon_is_fallback() can be used to tell if the icon is the fallback icon. - + Use wnck_window_get_icon_surface() instead. + the icon for @window. The caller should + line="2166">the icon for @window. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the icon around. @@ -4880,7 +5047,7 @@ the icon around. a #WnckWindow. + line="2160">a #WnckWindow. @@ -4889,20 +5056,20 @@ the icon around. c:identifier="wnck_window_get_icon_is_fallback"> Gets whether a default fallback icon is used for @window (because none + line="2310">Gets whether a default fallback icon is used for @window (because none was set on @window). - + %TRUE if the icon for @window is a fallback, %FALSE otherwise. + line="2317">%TRUE if the icon for @window is a fallback, %FALSE otherwise. a #WnckWindow. + line="2312">a #WnckWindow. @@ -4910,18 +5077,18 @@ was set on @window). Gets the icon name of @window, as it should be displayed for an icon + line="650">Gets the icon name of @window, as it should be displayed for an icon (minimized state). Always returns some value, even if @window has no icon name set; use wnck_window_has_icon_name() if you need to know whether the returned icon name is "real" or not. Contrast with wnck_window_get_name(), which returns @window<!-- -->'s title, not its icon title. - + the icon name of @window, or a fallback icon name if no icon + line="662">the icon name of @window, or a fallback icon name if no icon name is available. @@ -4929,22 +5096,51 @@ name is available. a #WnckWindow + line="652">a #WnckWindow - + Gets the mini-icon to be used for @window. If no mini-icon was found, a + line="2266">Gets the icon-surface to be used for @window. If no icon-surface was found, a +fallback icon-surface is used. wnck_window_get_icon_is_fallback() can be used +to tell if the icon-surface is the fallback icon-surface. + + + a reference to the icon-surface for @window. +The caller should unreference the returned <classname>cairo_surface_t</classname> +once done with it. + + + + + a #WnckWindow. + + + + + + Gets the mini-icon to be used for @window. If no mini-icon was found, a fallback mini-icon is used. wnck_window_get_icon_is_fallback() can be used to tell if the mini-icon is the fallback mini-icon. - + Use wnck_window_get_mini_icon_surface() instead. + the mini-icon for @window. The caller should + line="2220">the mini-icon for @window. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the icon around. @@ -4953,7 +5149,32 @@ the icon around. a #WnckWindow. + line="2214">a #WnckWindow. + + + + + + Gets the mini-icon-surface to be used for @window. If no mini-icon-surface +was found, a fallback mini-icon-surface is used. wnck_window_get_icon_is_fallback() +can be used to tell if the mini-icon-surface is the fallback mini-icon-surface. + + + a reference to the mini-icon-surface for @window. +The caller should unreference the returned <classname>cairo_surface_t</classname> +once done with it. + + + + + a #WnckWindow. @@ -4961,17 +5182,17 @@ the icon around. Gets the name of @window, as it should be displayed in a pager + line="597">Gets the name of @window, as it should be displayed in a pager or tasklist. Always returns some value, even if @window has no name set; use wnck_window_has_name() if you need to know whether the returned name is "real" or not. For icons titles, use wnck_window_get_icon_name() instead. - + the name of @window, or a fallback name if no name is + line="608">the name of @window, or a fallback name if no name is available. @@ -4979,7 +5200,7 @@ available. a #WnckWindow. + line="599">a #WnckWindow. @@ -4987,19 +5208,19 @@ available. Gets the process ID of @window. - + line="879">Gets the process ID of @window. + the process ID of @window, or 0 if none is available. + line="885">the process ID of @window, or 0 if none is available. a #WnckWindow. + line="881">a #WnckWindow. @@ -5007,21 +5228,21 @@ available. Gets the role for @window. + line="861">Gets the role for @window. The role uniquely identifies a window among all windows that have the same client leader window. - + role for @window, or %NULL if @window has no role. + line="869">role for @window, or %NULL if @window has no role. a #WnckWindow. + line="863">a #WnckWindow. @@ -5029,12 +5250,12 @@ client leader window. Gets the #WnckScreen @window is on. - + line="451">Gets the #WnckScreen @window is on. + the #WnckScreen @window is on. The returned + line="457">the #WnckScreen @window is on. The returned #WnckScreen is owned by libwnck and must not be referenced or unreferenced. @@ -5042,7 +5263,7 @@ client leader window. a #WnckWindow. + line="453">a #WnckWindow. @@ -5050,15 +5271,15 @@ client leader window. Gets the session ID for @window in Latin-1 encoding. + line="803">Gets the session ID for @window in Latin-1 encoding. NOTE: this is invalid UTF-8. You can't display this string in a GTK+ widget without converting to UTF-8. See wnck_window_get_session_id_utf8(). - + the session ID for @window in Latin-1, or %NULL if @window has + line="812">the session ID for @window in Latin-1, or %NULL if @window has no session ID. @@ -5066,7 +5287,7 @@ no session ID. a #WnckWindow. + line="805">a #WnckWindow. @@ -5075,15 +5296,15 @@ no session ID. c:identifier="wnck_window_get_session_id_utf8"> Gets the session ID for @window in UTF-8 encoding. + line="823">Gets the session ID for @window in UTF-8 encoding. The session ID should be in Latin-1 encoding, so the conversion should work, but a broken client could set a session ID that might not be convertable to UTF-8. - + the session ID for @window in UTF-8, or %NULL if @window has + line="832">the session ID for @window in UTF-8, or %NULL if @window has no session ID. @@ -5091,7 +5312,7 @@ no session ID. a #WnckWindow. + line="825">a #WnckWindow. @@ -5101,21 +5322,21 @@ no session ID. version="2.10"> Gets the sort order of @window, used for ordering of @window in + line="895">Gets the sort order of @window, used for ordering of @window in #WnckSelector and #WnckTasklist. The sort order is an internal state in libwnck. The initial value is defined when the window is created. - + the sort order of @window, or G_MAXINT if none is available. + line="903">the sort order of @window, or G_MAXINT if none is available. a #WnckWindow. + line="897">a #WnckWindow. @@ -5123,19 +5344,19 @@ libwnck. The initial value is defined when the window is created. Gets the state of @window. - + line="2344">Gets the state of @window. + bitmask of active states for @window. + line="2350">bitmask of active states for @window. a #WnckWindow. + line="2346">a #WnckWindow. @@ -5145,12 +5366,12 @@ libwnck. The initial value is defined when the window is created. version="2.12"> Gets the #WnckWindow for which @window is transient. - + line="724">Gets the #WnckWindow for which @window is transient. + the #WnckWindow for which @window is + line="730">the #WnckWindow for which @window is transient, or %NULL if @window is not transient for any #WnckWindow. The returned #WnckWindow is owned by libwnck and must not be referenced or unreferenced. @@ -5160,7 +5381,7 @@ unreferenced. a #WnckWindow. + line="726">a #WnckWindow. @@ -5169,19 +5390,19 @@ unreferenced. c:identifier="wnck_window_get_window_type"> Gets the semantic type of @window. - + line="934">Gets the semantic type of @window. + the semantic type of @window. + line="940">the semantic type of @window. a #WnckWindow. + line="936">a #WnckWindow. @@ -5189,13 +5410,13 @@ unreferenced. Gets the current workspace @window is on. If the window is pinned (on all + line="1799">Gets the current workspace @window is on. If the window is pinned (on all workspaces), or not on any workspaces, %NULL may be returned. - + the single current workspace @window is on, or + line="1806">the single current workspace @window is on, or %NULL. The returned #WnckWorkspace is owned by libwnck and must not be referenced or unreferenced. @@ -5204,7 +5425,7 @@ referenced or unreferenced. a #WnckWindow. + line="1801">a #WnckWindow. @@ -5212,19 +5433,19 @@ referenced or unreferenced. Gets the X window ID of @window. - + line="767">Gets the X window ID of @window. + the X window ID of @window. + line="773">the X window ID of @window. a #WnckWindow. + line="769">a #WnckWindow. @@ -5234,7 +5455,7 @@ referenced or unreferenced. version="2.16"> Checks whether or not @window has an icon name. + line="622">Checks whether or not @window has an icon name. wnck_window_get_icon_name() will always return some value, even if @window has no icon name set; wnck_window_has_icon_name() can be used to tell if that icon name is real or not. @@ -5244,11 +5465,11 @@ wnck_window_has_name() returns %TRUE, then the name returned by wnck_window_get_icon_name() is @window<!-- -->'s name. Only when both methods return %FALSE does wnck_window_get_icon_name() return a generic fallback name.) - + %TRUE if wnck_window_get_icon_name() returns + line="637">%TRUE if wnck_window_get_icon_name() returns @window<!-- -->'s icon name, %FALSE if it returns a fallback name. @@ -5256,7 +5477,7 @@ generic fallback name.) a #WnckWindow + line="624">a #WnckWindow @@ -5266,17 +5487,17 @@ generic fallback name.) version="2.16"> Checks whether or not @window has a name. wnck_window_get_name() + line="573">Checks whether or not @window has a name. wnck_window_get_name() will always return some value, even if @window has no name set; wnck_window_has_name() can be used to tell if that name is real or not. For icons titles, use wnck_window_has_icon_name() instead. - + %TRUE if wnck_window_get_name() returns @window<!-- -->'s + line="584">%TRUE if wnck_window_get_name() returns @window<!-- -->'s name, %FALSE if it returns a fallback name. @@ -5284,7 +5505,7 @@ name, %FALSE if it returns a fallback name. a #WnckWindow. + line="575">a #WnckWindow. @@ -5294,22 +5515,22 @@ name, %FALSE if it returns a fallback name. version="2.14"> Gets whether @window is above other windows. This state may change + line="1267">Gets whether @window is above other windows. This state may change anytime a #WnckWindow::state-changed signal gets emitted. See wnck_window_make_above() for more details on this state. - + %TRUE if @window is above other windows, %FALSE otherwise. + line="1276">%TRUE if @window is above other windows, %FALSE otherwise. a #WnckWindow. + line="1269">a #WnckWindow. @@ -5317,12 +5538,12 @@ See wnck_window_make_above() for more details on this state. Gets whether @window is the active window on its #WnckScreen. - + line="1929">Gets whether @window is the active window on its #WnckScreen. + %TRUE if @window is the active window on its #WnckScreen, + line="1935">%TRUE if @window is the active window on its #WnckScreen, %FALSE otherwise. @@ -5330,7 +5551,7 @@ See wnck_window_make_above() for more details on this state. a #WnckWindow. + line="1931">a #WnckWindow. @@ -5340,22 +5561,22 @@ See wnck_window_make_above() for more details on this state. version="2.20"> Gets whether @window is below other windows. This state may change + line="1288">Gets whether @window is below other windows. This state may change anytime a #WnckWindow::state-changed signal gets emitted. See wnck_window_make_below() for more details on this state. - + %TRUE if @window is below other windows, %FALSE otherwise. + line="1297">%TRUE if @window is below other windows, %FALSE otherwise. a #WnckWindow. + line="1290">a #WnckWindow. @@ -5365,20 +5586,20 @@ See wnck_window_make_below() for more details on this state. version="2.8"> Gets whether @window is fullscreen. Fullscreen state may change + line="1363">Gets whether @window is fullscreen. Fullscreen state may change anytime a #WnckWindow::state-changed signal gets emitted. - + %TRUE if @window is fullscreen, %FALSE otherwise. + line="1370">%TRUE if @window is fullscreen, %FALSE otherwise. a #WnckWindow. + line="1365">a #WnckWindow. @@ -5388,12 +5609,12 @@ anytime a #WnckWindow::state-changed signal gets emitted. version="2.4"> Gets %TRUE if @window appears in the current viewport of @workspace. - + line="2573">Gets %TRUE if @window appears in the current viewport of @workspace. + %TRUE if @window appears in current viewport of @workspace, + line="2580">%TRUE if @window appears in current viewport of @workspace, %FALSE otherwise. @@ -5401,13 +5622,13 @@ anytime a #WnckWindow::state-changed signal gets emitted. a #WnckWindow. + line="2575">a #WnckWindow. a #WnckWorkspace. + line="2576">a #WnckWorkspace. @@ -5415,17 +5636,17 @@ anytime a #WnckWindow::state-changed signal gets emitted. Gets whether @window is maximized. Maximization state may change + line="1226">Gets whether @window is maximized. Maximization state may change anytime a #WnckWindow::state-changed signal gets emitted. As for GDK, "maximized" means both vertically and horizontally. If @window is maximized in only one direction, then @window is not considered maximized. - + %TRUE if @window is maximized in both directions, %FALSE + line="1237">%TRUE if @window is maximized in both directions, %FALSE otherwise. @@ -5433,7 +5654,7 @@ otherwise. a #WnckWindow. + line="1228">a #WnckWindow. @@ -5442,20 +5663,20 @@ otherwise. c:identifier="wnck_window_is_maximized_horizontally"> Gets whether @window is maximized horizontally. Horizontal maximization + line="1123">Gets whether @window is maximized horizontally. Horizontal maximization state may change anytime a #WnckWindow::state-changed signal gets emitted. - + %TRUE if @window is maximized horizontally, %FALSE otherwise. + line="1130">%TRUE if @window is maximized horizontally, %FALSE otherwise. a #WnckWindow. + line="1125">a #WnckWindow. @@ -5464,20 +5685,20 @@ state may change anytime a #WnckWindow::state-changed signal gets emitted. c:identifier="wnck_window_is_maximized_vertically"> Gets whether @window is maximized vertically. vertiVal maximization + line="1140">Gets whether @window is maximized vertically. vertiVal maximization state may change anytime a #WnckWindow::state-changed signal gets emitted. - + %TRUE if @window is maximized vertically, %FALSE otherwise. + line="1147">%TRUE if @window is maximized vertically, %FALSE otherwise. a #WnckWindow. + line="1142">a #WnckWindow. @@ -5485,20 +5706,20 @@ state may change anytime a #WnckWindow::state-changed signal gets emitted. Gets whether @window is minimized. Minimization state may change anytime + line="1012">Gets whether @window is minimized. Minimization state may change anytime a #WnckWindow::state-changed signal gets emitted. - + %TRUE if @window is minimized, %FALSE otherwise. + line="1019">%TRUE if @window is minimized, %FALSE otherwise. a #WnckWindow. + line="1014">a #WnckWindow. @@ -5508,18 +5729,18 @@ a #WnckWindow::state-changed signal gets emitted. version="2.8"> Gets whether @window is the most recently activated window on its + line="1946">Gets whether @window is the most recently activated window on its #WnckScreen. The most recently activated window is identical to the active window for click and sloppy focus methods (since a window is always active in those cases) but differs slightly for mouse focus since there often is no active window. - + %TRUE if @window was the most recently activated window on its + line="1958">%TRUE if @window was the most recently activated window on its #WnckScreen, %FALSE otherwise. @@ -5527,7 +5748,7 @@ there often is no active window. a #WnckWindow. + line="1948">a #WnckWindow. @@ -5536,25 +5757,25 @@ there often is no active window. c:identifier="wnck_window_is_on_workspace"> Gets whether @window appears on @workspace. - + line="2553">Gets whether @window appears on @workspace. + %TRUE if @window appears on @workspace, %FALSE otherwise. + line="2560">%TRUE if @window appears on @workspace, %FALSE otherwise. a #WnckWindow. + line="2555">a #WnckWindow. a #WnckWorkspace. + line="2556">a #WnckWorkspace. @@ -5562,21 +5783,21 @@ there often is no active window. Gets whether @window is on all workspace. Pinned state may change + line="1841">Gets whether @window is on all workspace. Pinned state may change anytime a #WnckWindow::workspace-changed signal gets emitted, but not when a #WnckWindow::state-changed gets emitted. - + %TRUE if @window is on all workspaces, %FALSE otherwise. + line="1849">%TRUE if @window is on all workspaces, %FALSE otherwise. a #WnckWindow. + line="1843">a #WnckWindow. @@ -5584,20 +5805,20 @@ a #WnckWindow::state-changed gets emitted. Gets whether @window is shaded. Shade state may change anytime + line="1250">Gets whether @window is shaded. Shade state may change anytime a #WnckWindow::state-changed signal gets emitted. - + %TRUE if @window is shaded, %FALSE otherwise. + line="1257">%TRUE if @window is shaded, %FALSE otherwise. a #WnckWindow. + line="1252">a #WnckWindow. @@ -5605,20 +5826,20 @@ a #WnckWindow::state-changed signal gets emitted. Gets whether @window is included on pagers. This state may change + line="1309">Gets whether @window is included on pagers. This state may change anytime a #WnckWindow::state-changed signal gets emitted. - + %TRUE if @window is included on pagers, %FALSE otherwise. + line="1316">%TRUE if @window is included on pagers, %FALSE otherwise. a #WnckWindow. + line="1311">a #WnckWindow. @@ -5627,20 +5848,20 @@ anytime a #WnckWindow::state-changed signal gets emitted. c:identifier="wnck_window_is_skip_tasklist"> Gets whether @window is included on tasklists. This state may change + line="1346">Gets whether @window is included on tasklists. This state may change anytime a #WnckWindow::state-changed signal gets emitted. - + %TRUE if @window is included on tasklists, %FALSE otherwise. + line="1353">%TRUE if @window is included on tasklists, %FALSE otherwise. a #WnckWindow. + line="1348">a #WnckWindow. @@ -5648,25 +5869,25 @@ anytime a #WnckWindow::state-changed signal gets emitted. Gets whether @window is sticky. Sticky state may change + line="1426">Gets whether @window is sticky. Sticky state may change anytime a #WnckWindow::state-changed signal gets emitted. Sticky here means "stuck to the glass", i.e. does not scroll with the viewport. In GDK/GTK+ (e.g. gdk_window_stick()/gtk_window_stick()), sticky means "stuck to the glass" and <emphasis>also</emphasis> that the window is on all workspaces. But here it only means the viewport aspect of it. - + %TRUE if @window is "stuck to the glass", %FALSE otherwise. + line="1438">%TRUE if @window is "stuck to the glass", %FALSE otherwise. a #WnckWindow. + line="1428">a #WnckWindow. @@ -5675,13 +5896,13 @@ on all workspaces. But here it only means the viewport aspect of it. c:identifier="wnck_window_is_visible_on_workspace"> Like wnck_window_is_on_workspace(), but also checks that + line="2489">Like wnck_window_is_on_workspace(), but also checks that the window is in a visible state (i.e. not minimized or shaded). - + %TRUE if @window appears on @workspace in normal state, %FALSE + line="2497">%TRUE if @window appears on @workspace in normal state, %FALSE otherwise. @@ -5689,13 +5910,13 @@ otherwise. a #WnckWindow. + line="2491">a #WnckWindow. a #WnckWorkspace. + line="2492">a #WnckWorkspace. @@ -5703,8 +5924,8 @@ otherwise. Asks the window manager to start moving @window via the keyboard. - + line="1769">Asks the window manager to start moving @window via the keyboard. + @@ -5712,7 +5933,7 @@ otherwise. a #WnckWindow. + line="1771">a #WnckWindow. @@ -5720,8 +5941,8 @@ otherwise. Asks the window manager to start resizing @window via the keyboard. - + line="1784">Asks the window manager to start resizing @window via the keyboard. + @@ -5729,7 +5950,7 @@ otherwise. a #WnckWindow. + line="1786">a #WnckWindow. @@ -5739,10 +5960,10 @@ otherwise. version="2.14"> Asks the window manager to put @window on top of most windows (@window will + line="1647">Asks the window manager to put @window on top of most windows (@window will not be on top of focused fullscreen windows, of other windows with this setting and of dock windows). - + @@ -5750,7 +5971,7 @@ setting and of dock windows). a #WnckWindow. + line="1649">a #WnckWindow. @@ -5760,8 +5981,8 @@ setting and of dock windows). version="2.20"> Asks the window manager to put @window below most windows. - + line="1690">Asks the window manager to put @window below most windows. + @@ -5769,7 +5990,7 @@ setting and of dock windows). a #WnckWindow. + line="1692">a #WnckWindow. @@ -5777,8 +5998,8 @@ setting and of dock windows). Asks the window manager to maximize @window. - + line="1503">Asks the window manager to maximize @window. + @@ -5786,7 +6007,7 @@ setting and of dock windows). a #WnckWindow. + line="1505">a #WnckWindow. @@ -5795,8 +6016,8 @@ setting and of dock windows). c:identifier="wnck_window_maximize_horizontally"> Asks the window manager to maximize horizontally @window. - + line="1539">Asks the window manager to maximize horizontally @window. + @@ -5804,7 +6025,7 @@ setting and of dock windows). a #WnckWindow. + line="1541">a #WnckWindow. @@ -5813,8 +6034,8 @@ setting and of dock windows). c:identifier="wnck_window_maximize_vertically"> Asks the window manager to maximize vertically @window. - + line="1575">Asks the window manager to maximize vertically @window. + @@ -5822,7 +6043,7 @@ setting and of dock windows). a #WnckWindow. + line="1577">a #WnckWindow. @@ -5830,8 +6051,8 @@ setting and of dock windows). Minimizes @window. - + line="1470">Minimizes @window. + @@ -5839,7 +6060,7 @@ setting and of dock windows). a #WnckWindow. + line="1472">a #WnckWindow. @@ -5848,9 +6069,9 @@ setting and of dock windows). c:identifier="wnck_window_move_to_workspace"> Asks the window manager to move @window to @space. If @window was pinned, it + line="1821">Asks the window manager to move @window to @space. If @window was pinned, it will also result in @window being visible only on @space. - + @@ -5858,13 +6079,13 @@ will also result in @window being visible only on @space. a #WnckWindow. + line="1823">a #WnckWindow. a #WnckWorkspace. + line="1824">a #WnckWorkspace. @@ -5874,23 +6095,23 @@ will also result in @window being visible only on @space. version="2.12"> Gets whether @window needs attention. This state may change anytime + line="1029">Gets whether @window needs attention. This state may change anytime a #WnckWindow::state-changed signal gets emitted. This state depends on flags such as the demands_attention and is_urgent hints. - + %TRUE if @window needs attention, %FALSE otherwise. + line="1039">%TRUE if @window needs attention, %FALSE otherwise. a #WnckWindow. + line="1031">a #WnckWindow. @@ -5900,13 +6121,13 @@ hints. version="2.12"> Gets whether @window or one of its transients needs attention. This state + line="1104">Gets whether @window or one of its transients needs attention. This state may change anytime a #WnckWindow::state-changed signal gets emitted. - + %TRUE if @window or one of its transients needs attention, + line="1111">%TRUE if @window or one of its transients needs attention, %FALSE otherwise. @@ -5914,7 +6135,7 @@ may change anytime a #WnckWindow::state-changed signal gets emitted. a #WnckWindow. + line="1106">a #WnckWindow. @@ -5922,8 +6143,8 @@ may change anytime a #WnckWindow::state-changed signal gets emitted. Asks the window manager to put @window on all workspaces. - + line="1859">Asks the window manager to put @window on all workspaces. + @@ -5931,7 +6152,7 @@ may change anytime a #WnckWindow::state-changed signal gets emitted. a #WnckWindow. + line="1861">a #WnckWindow. @@ -5941,9 +6162,9 @@ may change anytime a #WnckWindow::state-changed signal gets emitted. version="2.8"> Asks the window manager to set the fullscreen state of @window according to + line="1403">Asks the window manager to set the fullscreen state of @window according to @fullscreen. - + @@ -5951,13 +6172,13 @@ may change anytime a #WnckWindow::state-changed signal gets emitted. a #WnckWindow. + line="1405">a #WnckWindow. whether to make @window fullscreen. + line="1406">whether to make @window fullscreen. @@ -5967,7 +6188,7 @@ may change anytime a #WnckWindow::state-changed signal gets emitted. version="2.16"> Sets the size and position of @window. The X and Y coordinates should be + line="2435">Sets the size and position of @window. The X and Y coordinates should be relative to the root window. Note that the new size and position apply to @window with its frame added @@ -5976,7 +6197,7 @@ the values returned by wnck_window_get_geometry() should be a no-op, while using wnck_window_set_geometry() with the values returned by wnck_window_get_client_window_geometry() should reduce the size of @window and move it. - + @@ -5984,44 +6205,44 @@ and move it. a #WnckWindow. + line="2437">a #WnckWindow. the gravity point to use as a reference for the new position. + line="2438">the gravity point to use as a reference for the new position. a bitmask containing flags for what should be set. + line="2439">a bitmask containing flags for what should be set. new X coordinate in pixels of @window. + line="2440">new X coordinate in pixels of @window. new Y coordinate in pixels of @window. + line="2441">new Y coordinate in pixels of @window. new width in pixels of @window. + line="2442">new width in pixels of @window. new height in pixels of @window. + line="2443">new height in pixels of @window. @@ -6030,9 +6251,9 @@ and move it. c:identifier="wnck_window_set_icon_geometry"> Sets the icon geometry for @window. A typical use case for this is the + line="2517">Sets the icon geometry for @window. A typical use case for this is the destination of the minimization animation of @window. - + @@ -6040,31 +6261,31 @@ destination of the minimization animation of @window. a #WnckWindow. + line="2519">a #WnckWindow. X coordinate in pixels. + line="2520">X coordinate in pixels. Y coordinate in pixels. + line="2521">Y coordinate in pixels. width in pixels. + line="2522">width in pixels. height in pixels. + line="2523">height in pixels. @@ -6072,8 +6293,8 @@ destination of the minimization animation of @window. Asks the window manager to make @window included or not included on pagers. - + line="1326">Asks the window manager to make @window included or not included on pagers. + @@ -6081,13 +6302,13 @@ destination of the minimization animation of @window. a #WnckWindow. + line="1328">a #WnckWindow. whether @window should be included on pagers. + line="1329">whether @window should be included on pagers. @@ -6096,9 +6317,9 @@ destination of the minimization animation of @window. c:identifier="wnck_window_set_skip_tasklist"> Asks the window manager to make @window included or not included on + line="1382">Asks the window manager to make @window included or not included on tasklists. - + @@ -6106,13 +6327,13 @@ tasklists. a #WnckWindow. + line="1384">a #WnckWindow. whether @window should be included on tasklists. + line="1385">whether @window should be included on tasklists. @@ -6122,9 +6343,9 @@ tasklists. version="2.20"> Sets the sort order of @window. The sort order is used for ordering of + line="915">Sets the sort order of @window. The sort order is used for ordering of @window in #WnckSelector and #WnckTasklist. - + @@ -6132,13 +6353,13 @@ tasklists. a #WnckWindow. + line="917">a #WnckWindow. new sort order for @window. + line="918">new sort order for @window. @@ -6148,8 +6369,8 @@ tasklists. version="2.12"> Sets the semantic type of @window to @wintype. - + line="951">Sets the semantic type of @window to @wintype. + @@ -6157,13 +6378,13 @@ tasklists. a #WnckWindow. + line="953">a #WnckWindow. a semantic type. + line="954">a semantic type. @@ -6171,8 +6392,8 @@ tasklists. Asks the window manager to shade @window. - + line="1611">Asks the window manager to shade @window. + @@ -6180,7 +6401,7 @@ tasklists. a #WnckWindow. + line="1613">a #WnckWindow. @@ -6188,9 +6409,9 @@ tasklists. Asks the window manager to keep the @window<!-- -->'s position fixed on the + line="1731">Asks the window manager to keep the @window<!-- -->'s position fixed on the screen, even when the workspace or viewport scrolls. - + @@ -6198,7 +6419,7 @@ screen, even when the workspace or viewport scrolls. a #WnckWindow. + line="1733">a #WnckWindow. @@ -6208,7 +6429,7 @@ screen, even when the workspace or viewport scrolls. version="2.12"> Gets whether one of the transients of @window is the most + line="2062">Gets whether one of the transients of @window is the most recently activated window. See wnck_window_is_most_recently_activated() for a more complete description of what is meant by most recently activated. This @@ -6218,11 +6439,11 @@ activate a transient instead of @window itself minimize @window and its transients. (Not doing this can be especially annoying in the case of modal dialogs that don't appear in the #WnckTasklist). - + %TRUE if one of the transients of @window is the most recently + line="2077">%TRUE if one of the transients of @window is the most recently activated window, %FALSE otherwise. @@ -6230,7 +6451,7 @@ activated window, %FALSE otherwise. a #WnckWindow. + line="2064">a #WnckWindow. @@ -6240,9 +6461,9 @@ activated window, %FALSE otherwise. version="2.14"> Asks the window manager to not put @window on top of most windows, and to + line="1669">Asks the window manager to not put @window on top of most windows, and to put it again in the stack with other windows. - + @@ -6250,7 +6471,7 @@ put it again in the stack with other windows. a #WnckWindow. + line="1671">a #WnckWindow. @@ -6260,9 +6481,9 @@ put it again in the stack with other windows. version="2.20"> Asks the window manager to not put @window below most windows, and to + line="1710">Asks the window manager to not put @window below most windows, and to put it again in the stack with other windows. - + @@ -6270,7 +6491,7 @@ put it again in the stack with other windows. a #WnckWindow. + line="1712">a #WnckWindow. @@ -6278,8 +6499,8 @@ put it again in the stack with other windows. Asks the window manager to unmaximize @window. - + line="1521">Asks the window manager to unmaximize @window. + @@ -6287,7 +6508,7 @@ put it again in the stack with other windows. a #WnckWindow. + line="1523">a #WnckWindow. @@ -6296,8 +6517,8 @@ put it again in the stack with other windows. c:identifier="wnck_window_unmaximize_horizontally"> Asks the window manager to unmaximize horizontally @window. - + line="1557">Asks the window manager to unmaximize horizontally @window. + @@ -6305,7 +6526,7 @@ put it again in the stack with other windows. a #WnckWindow. + line="1559">a #WnckWindow. @@ -6314,8 +6535,8 @@ put it again in the stack with other windows. c:identifier="wnck_window_unmaximize_vertically"> Asks the window manager to unmaximize vertically @window. - + line="1593">Asks the window manager to unmaximize vertically @window. + @@ -6323,7 +6544,7 @@ put it again in the stack with other windows. a #WnckWindow. + line="1595">a #WnckWindow. @@ -6331,9 +6552,9 @@ put it again in the stack with other windows. Unminimizes @window by activating it or one of its transients. See + line="1485">Unminimizes @window by activating it or one of its transients. See wnck_window_activate_transient() for details on how the activation is done. - + @@ -6341,13 +6562,13 @@ wnck_window_activate_transient() for details on how the activation is done. a #WnckWindow. + line="1487">a #WnckWindow. the X server timestamp of the user interaction event that caused + line="1488">the X server timestamp of the user interaction event that caused this call to occur. @@ -6356,12 +6577,12 @@ this call to occur. Asks the window manager to put @window only in the currently active + line="1875">Asks the window manager to put @window only in the currently active workspace, if @window was previously pinned. If @window was not pinned, does not change @window<!-- -->'s workspace. If the active workspace is not known for some reason (it should not happen much), sets @window<!-- -->'s workspace to the first workspace. - + @@ -6369,7 +6590,7 @@ is not known for some reason (it should not happen much), sets a #WnckWindow. + line="1877">a #WnckWindow. @@ -6377,8 +6598,8 @@ is not known for some reason (it should not happen much), sets Asks the window manager to unshade @window. - + line="1629">Asks the window manager to unshade @window. + @@ -6386,7 +6607,7 @@ is not known for some reason (it should not happen much), sets a #WnckWindow. + line="1631">a #WnckWindow. @@ -6394,9 +6615,9 @@ is not known for some reason (it should not happen much), sets Asks the window manager to not have @window<!-- -->'s position fixed on the + line="1750">Asks the window manager to not have @window<!-- -->'s position fixed on the screen when the workspace or viewport scrolls. - + @@ -6404,7 +6625,7 @@ screen when the workspace or viewport scrolls. a #WnckWindow. + line="1752">a #WnckWindow. @@ -6418,7 +6639,7 @@ screen when the workspace or viewport scrolls. Emitted when the actions availabilities for @window change. + line="307">Emitted when the actions availabilities for @window change. @@ -6426,14 +6647,14 @@ screen when the workspace or viewport scrolls. the bitmask containing bits set for all actions + line="310">the bitmask containing bits set for all actions availabilities for @window that have changed. the new actions availabilities for @window. + line="312">the new actions availabilities for @window. @@ -6441,7 +6662,7 @@ availabilities for @window that have changed. Emitted when the class name or instance name of @window changes. + line="340">Emitted when the class name or instance name of @window changes. @@ -6449,7 +6670,7 @@ availabilities for @window that have changed. Emitted when the geometry of @window changes. + line="326">Emitted when the geometry of @window changes. @@ -6457,7 +6678,7 @@ availabilities for @window that have changed. Emitted when the icon of @window changes. + line="293">Emitted when the icon of @window changes. @@ -6465,7 +6686,7 @@ availabilities for @window that have changed. Emitted when the name of @window changes. + line="243">Emitted when the name of @window changes. @@ -6473,7 +6694,7 @@ availabilities for @window that have changed. Emitted when the role of @window changes. + line="354">Emitted when the role of @window changes. @@ -6481,7 +6702,7 @@ availabilities for @window that have changed. Emitted when the state of @window changes. This can happen when @window is + line="257">Emitted when the state of @window changes. This can happen when @window is (un)minimized, (un)maximized, (un)sticked, (un)shaded, (un)made above, (un)made below, (un)set fullscreen, when it needs attention, etc. See #WnckWindowState for the complete list of states that might have changed. @@ -6492,14 +6713,14 @@ availabilities for @window that have changed. the bitmask containing bits set for all states of @window + line="260">the bitmask containing bits set for all states of @window that have changed. the new state of @window. + line="262">the new state of @window. @@ -6507,7 +6728,7 @@ that have changed. Emitted when the EWMH type hint of the window changes. + line="368">Emitted when the EWMH type hint of the window changes. @@ -6515,7 +6736,7 @@ that have changed. Emitted when the current workspace of @window changes, or if @window has + line="278">Emitted when the current workspace of @window changes, or if @window has been pinned or unpinned. @@ -6528,7 +6749,7 @@ been pinned or unpinned. c:type="WnckWindowActions"> Type used as a bitmask to describe the actions that can be done for a + line="83">Type used as a bitmask to describe the actions that can be done for a #WnckWindow. glib:name="WNCK_WINDOW_ACTION_MOVE"> the window may be moved around the screen. + line="85">the window may be moved around the screen. glib:name="WNCK_WINDOW_ACTION_RESIZE"> the window may be resized. + line="86">the window may be resized. glib:name="WNCK_WINDOW_ACTION_SHADE"> the window may be shaded. + line="87">the window may be shaded. glib:name="WNCK_WINDOW_ACTION_STICK"> the window may be sticked. + line="88">the window may be sticked. glib:name="WNCK_WINDOW_ACTION_MAXIMIZE_HORIZONTALLY"> the window may be maximized + line="89">the window may be maximized horizontally. glib:name="WNCK_WINDOW_ACTION_MAXIMIZE_VERTICALLY"> the window may be maximized + line="91">the window may be maximized vertically. glib:name="WNCK_WINDOW_ACTION_CHANGE_WORKSPACE"> the window may be moved between + line="93">the window may be moved between workspaces, or (un)pinned. glib:name="WNCK_WINDOW_ACTION_CLOSE"> the window may be closed. + line="95">the window may be closed. glib:name="WNCK_WINDOW_ACTION_UNMAXIMIZE_HORIZONTALLY"> the window may be unmaximized + line="96">the window may be unmaximized horizontally. glib:name="WNCK_WINDOW_ACTION_UNMAXIMIZE_VERTICALLY"> the window may be maximized + line="98">the window may be maximized vertically. glib:name="WNCK_WINDOW_ACTION_UNSHADE"> the window may be unshaded. + line="100">the window may be unshaded. glib:name="WNCK_WINDOW_ACTION_UNSTICK"> the window may be unsticked. + line="101">the window may be unsticked. glib:name="WNCK_WINDOW_ACTION_MINIMIZE"> the window may be minimized. + line="102">the window may be minimized. glib:name="WNCK_WINDOW_ACTION_UNMINIMIZE"> the window may be unminimized. + line="103">the window may be unminimized. glib:name="WNCK_WINDOW_ACTION_MAXIMIZE"> the window may be maximized. + line="104">the window may be maximized. glib:name="WNCK_WINDOW_ACTION_UNMAXIMIZE"> the window may be unmaximized. + line="105">the window may be unmaximized. glib:name="WNCK_WINDOW_ACTION_FULLSCREEN"> the window may be brought to fullscreen. + line="106">the window may be brought to fullscreen. glib:name="WNCK_WINDOW_ACTION_ABOVE"> the window may be made above other windows. + line="107">the window may be made above other windows. glib:name="WNCK_WINDOW_ACTION_BELOW"> the window may be made below other windows. + line="108">the window may be made below other windows. - + - + @@ -6729,7 +6950,7 @@ vertically. - + @@ -6748,7 +6969,7 @@ vertically. - + @@ -6761,7 +6982,7 @@ vertically. - + @@ -6774,7 +6995,7 @@ vertically. - + @@ -6793,7 +7014,7 @@ vertically. - + @@ -6806,7 +7027,7 @@ vertically. - + @@ -6819,7 +7040,7 @@ vertically. - + @@ -6832,7 +7053,7 @@ vertically. - + @@ -6845,7 +7066,7 @@ vertically. - + @@ -6859,7 +7080,7 @@ vertically. c:type="WnckWindowGravity"> Flag used when changing the geometry of a #WnckWindow. This is the gravity + line="163">Flag used when changing the geometry of a #WnckWindow. This is the gravity point to use as a reference for the new position. glib:name="WNCK_WINDOW_GRAVITY_CURRENT"> keep the current gravity point. + line="165">keep the current gravity point. glib:name="WNCK_WINDOW_GRAVITY_NORTHWEST"> use the left top corner of the frame window + line="166">use the left top corner of the frame window as gravity point. glib:name="WNCK_WINDOW_GRAVITY_NORTH"> use the center of the frame window's top side as + line="168">use the center of the frame window's top side as gravity point. glib:name="WNCK_WINDOW_GRAVITY_NORTHEAST"> use the right top corner of the frame window + line="170">use the right top corner of the frame window as gravity point. glib:name="WNCK_WINDOW_GRAVITY_WEST"> use the center of the frame window's left side as + line="172">use the center of the frame window's left side as gravity point. glib:name="WNCK_WINDOW_GRAVITY_CENTER"> use the center of the frame window as gravity + line="174">use the center of the frame window as gravity point. glib:name="WNCK_WINDOW_GRAVITY_EAST"> use the center of the frame window's right side + line="176">use the center of the frame window's right side as gravity point. glib:name="WNCK_WINDOW_GRAVITY_SOUTHWEST"> use the left bottom corner of the frame + line="178">use the left bottom corner of the frame window as gravity point. glib:name="WNCK_WINDOW_GRAVITY_SOUTH"> use the center of the frame window's bottom side + line="180">use the center of the frame window's bottom side as gravity point. glib:name="WNCK_WINDOW_GRAVITY_SOUTHEAST"> use the right bottom corner of the frame + line="182">use the right bottom corner of the frame window as gravity point. glib:name="WNCK_WINDOW_GRAVITY_STATIC"> use the left top corner of the client window as + line="184">use the left top corner of the client window as gravity point. @@ -6978,7 +7199,7 @@ gravity point. c:type="WnckWindowMoveResizeMask"> Flag used as a bitmask when changing the geometry of a #WnckWindow. This + line="207">Flag used as a bitmask when changing the geometry of a #WnckWindow. This indicates which part of the geometry should be changed. glib:name="WNCK_WINDOW_CHANGE_X"> X coordinate of the window should be changed. + line="209">X coordinate of the window should be changed. glib:name="WNCK_WINDOW_CHANGE_Y"> Y coordinate of the window should be changed. + line="210">Y coordinate of the window should be changed. glib:name="WNCK_WINDOW_CHANGE_WIDTH"> width of the window should be changed. + line="211">width of the window should be changed. glib:name="WNCK_WINDOW_CHANGE_HEIGHT"> height of the window should be changed. + line="212">height of the window should be changed. - + c:type="WnckWindowState"> Type used as a bitmask to describe the state of a #WnckWindow. + line="40">Type used as a bitmask to describe the state of a #WnckWindow. glib:name="WNCK_WINDOW_STATE_MINIMIZED"> the window is minimized. + line="42">the window is minimized. glib:name="WNCK_WINDOW_STATE_MAXIMIZED_HORIZONTALLY"> the window is horizontically + line="43">the window is horizontically maximized. glib:name="WNCK_WINDOW_STATE_MAXIMIZED_VERTICALLY"> the window is vertically maximized. + line="45">the window is vertically maximized. glib:name="WNCK_WINDOW_STATE_SHADED"> the window is shaded. + line="46">the window is shaded. glib:name="WNCK_WINDOW_STATE_SKIP_PAGER"> the window should not be included on pagers. + line="47">the window should not be included on pagers. glib:name="WNCK_WINDOW_STATE_SKIP_TASKLIST"> the window should not be included on + line="48">the window should not be included on tasklists. glib:name="WNCK_WINDOW_STATE_STICKY"> the window is sticky (see + line="50">the window is sticky (see wnck_window_is_sticky()). glib:name="WNCK_WINDOW_STATE_HIDDEN"> the window is not visible on its #WnckWorkspace + line="52">the window is not visible on its #WnckWorkspace and viewport (when minimized, for example). glib:name="WNCK_WINDOW_STATE_FULLSCREEN"> the window is fullscreen. + line="54">the window is fullscreen. glib:name="WNCK_WINDOW_STATE_DEMANDS_ATTENTION"> the window needs attention (because + line="55">the window needs attention (because the window requested activation but the window manager refused it, for example). @@ -7133,7 +7354,7 @@ example). glib:name="WNCK_WINDOW_STATE_URGENT"> the window requires a response from the user. + line="58">the window requires a response from the user. glib:name="WNCK_WINDOW_STATE_ABOVE"> the window is above other windows (see + line="59">the window is above other windows (see wnck_window_make_above()). glib:name="WNCK_WINDOW_STATE_BELOW"> the window is below other windows (see + line="61">the window is below other windows (see wnck_window_make_below()). @@ -7162,7 +7383,7 @@ wnck_window_make_below()). c:type="WnckWindowType"> Type describing the semantic type of a #WnckWindow. + line="136">Type describing the semantic type of a #WnckWindow. glib:name="WNCK_WINDOW_NORMAL"> the window is a normal window. + line="138">the window is a normal window. glib:name="WNCK_WINDOW_DESKTOP"> the window is a desktop. + line="139">the window is a desktop. glib:name="WNCK_WINDOW_DOCK"> the window is a dock or a panel. + line="140">the window is a dock or a panel. glib:name="WNCK_WINDOW_DIALOG"> the window is a dialog window. + line="141">the window is a dialog window. glib:name="WNCK_WINDOW_TOOLBAR"> the window is a tearoff toolbar. + line="142">the window is a tearoff toolbar. glib:name="WNCK_WINDOW_MENU"> the window is a tearoff menu. + line="143">the window is a tearoff menu. glib:name="WNCK_WINDOW_UTILITY"> the window is a small persistent utility window, such + line="144">the window is a small persistent utility window, such as a palette or toolbox. glib:name="WNCK_WINDOW_SPLASHSCREEN"> the window is a splash screen displayed as an + line="146">the window is a splash screen displayed as an application is starting up. @@ -7904,7 +8125,7 @@ be ignored and a critical warning will be logged. version="2.4.6"> The default main icon size is %WNCK_DEFAULT_ICON_SIZE. This function allows + line="188">The default main icon size is %WNCK_DEFAULT_ICON_SIZE. This function allows to change this value. @@ -7914,7 +8135,7 @@ to change this value. the default size for windows and application standard icons. + line="190">the default size for windows and application standard icons. @@ -7924,7 +8145,7 @@ to change this value. version="2.4.6"> The default main icon size is %WNCK_DEFAULT_MINI_ICON_SIZE. This function + line="203">The default main icon size is %WNCK_DEFAULT_MINI_ICON_SIZE. This function allows to change this value. @@ -7934,7 +8155,7 @@ allows to change this value. the default size for windows and application mini icons. + line="205">the default size for windows and application mini icons. @@ -7942,7 +8163,7 @@ allows to change this value. Makes libwnck stop listening to events and tear down all resources from + line="273">Makes libwnck stop listening to events and tear down all resources from libwnck. This should be done if you are not going to need the state change notifications for an extended period of time, to avoid wakeups with every key and focus event. @@ -7993,7 +8214,7 @@ versions of libwnck that do not provide the same API. The #WnckWindow objects are always owned by libwnck and must not be + line="40">The #WnckWindow objects are always owned by libwnck and must not be referenced or unreferenced. diff --git a/girs/Wp-0.5.gir b/girs/Wp-0.5.gir index f61cd99f5..c1fa6a4dc 100644 --- a/girs/Wp-0.5.gir +++ b/girs/Wp-0.5.gir @@ -975,24 +975,40 @@ This also effectively destroys all WpCore objects that were created through the - + + Finds a registered object. - - + + the registered object or NULL if not found + + the core - + + a function that takes the object being searched as the first argument and @data as the second. it should return TRUE if the object is found or FALSE otherwise + the second argument to @func @@ -1400,7 +1416,7 @@ This is the same as wp_core_idle_add(), but it allows you to specify a GClosure c:identifier="wp_core_install_object_manager"> Installs the object manager on this core, activating its internal management engine. + line="2960">Installs the object manager on this core, activating its internal management engine. This will immediately emit signals about objects added on @om if objects that the @om is interested in were in existence already. @@ -1412,13 +1428,13 @@ This will immediately emit signals about objects added on @om if objects that th the core + line="2962">the core a WpObjectManager + line="2963">a WpObjectManager @@ -1560,7 +1576,7 @@ The @type will determine which component loader to use. The following types are Registers @obj with the core, making it appear on WpObjectManager instances as well. + line="1242">Registers @obj with the core, making it appear on WpObjectManager instances as well. The core will also maintain a ref to that object until it is removed. @@ -1572,13 +1588,13 @@ The core will also maintain a ref to that object until it is removed. the core + line="1244">the core the object to register + line="1245">the object to register @@ -1586,7 +1602,7 @@ The core will also maintain a ref to that object until it is removed. Detaches and unrefs the specified object from this core. + line="1256">Detaches and unrefs the specified object from this core. @@ -1595,13 +1611,13 @@ The core will also maintain a ref to that object until it is removed. the core + line="1258">the core a pointer to the object to remove + line="1259">a pointer to the object to remove @@ -1731,25 +1747,25 @@ In both success and error cases, @closure is always invoked. Use wp_core_sync_fi Test if a global feature is provided. + line="1269">Test if a global feature is provided. TRUE if the feature is provided, FALSE otherwise + line="1279">TRUE if the feature is provided, FALSE otherwise the core + line="1271">the core the feature name + line="1272">the feature name @@ -1985,7 +2001,7 @@ A WpDevice is constructed internally when a new device appears on the PipeWire r c:identifier="wp_device_new_from_factory"> Constructs a device on the PipeWire server by asking the remote factory @factory_name to create it. + line="1283">Constructs a device on the PipeWire server by asking the remote factory @factory_name to create it. Because of the nature of the PipeWire protocol, this operation completes asynchronously at some point in the future. In order to find out when this is done, you should call wp_object_activate(), requesting at least WP_PROXY_FEATURE_BOUND. When this feature is ready, the device is ready for use on the server. If the device cannot be created, this activation operation will fail. @@ -1993,20 +2009,20 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr the new device or NULL if the core is not connected and therefore the device cannot be created + line="1295">the new device or NULL if the core is not connected and therefore the device cannot be created the wireplumber core + line="1285">the wireplumber core the pipewire factory name to construct the device + line="1286">the pipewire factory name to construct the device the properties to pass to the factory + line="1287">the properties to pass to the factory @@ -2059,25 +2075,25 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr Creates a new event. + line="1581">Creates a new event. the newly constructed event + line="1594">the newly constructed event the type of the event + line="1583">the type of the event the priority of the event + line="1584">the priority of the event properties of the event + line="1585">properties of the event the source of the event + line="1586">the source of the event the object that the event is about + line="1587">the object that the event is about @@ -2109,25 +2125,25 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr Collects all the hooks registered in the @dispatcher that run for this @event. + line="1717">Collects all the hooks registered in the @dispatcher that run for this @event. TRUE if at least one hook has been collected, FALSE if no hooks run for this event or an error occurred + line="1727">TRUE if at least one hook has been collected, FALSE if no hooks run for this event or an error occurred the event + line="1719">the event the event dispatcher + line="1720">the event dispatcher @@ -2135,19 +2151,19 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr Returns the internal GCancellable that is used to track whether this event has been stopped by wp_event_stop_processing() + line="1663">Returns the internal GCancellable that is used to track whether this event has been stopped by wp_event_stop_processing() the cancellable + line="1672">the cancellable the event + line="1665">the event @@ -2155,25 +2171,25 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr Gets the data that was previously associated with @key by wp_event_set_data() + line="1703">Gets the data that was previously associated with @key by wp_event_set_data() the data associated with @key or %NULL + line="1713">the data associated with @key or %NULL the event + line="1705">the event the key + line="1706">the key @@ -2181,19 +2197,19 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr Gets the name of the event. + line="1598">Gets the name of the event. the event name + line="1607">the event name the event + line="1600">the event @@ -2201,19 +2217,19 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr Gets the priority of the event. + line="1611">Gets the priority of the event. the event priority + line="1620">the event priority the event + line="1613">the event @@ -2221,19 +2237,19 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr Gets the properties of the Event. + line="1624">Gets the properties of the Event. the properties of the event + line="1633">the properties of the event the handle + line="1626">the handle @@ -2241,19 +2257,19 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr Gets the Source Object of the Event. + line="1637">Gets the Source Object of the Event. the source of the event + line="1646">the source of the event the handle + line="1639">the handle @@ -2261,19 +2277,19 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr Gets the Subject Object of the Event. + line="1650">Gets the Subject Object of the Event. the subject of the event + line="1659">the subject of the event the handle + line="1652">the handle @@ -2282,19 +2298,19 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr c:identifier="wp_event_new_hooks_iterator"> Returns an iterator that iterates over all the hooks that were collected by wp_event_collect_hooks() + line="1731">Returns an iterator that iterates over all the hooks that were collected by wp_event_collect_hooks() the new iterator + line="1740">the new iterator the event + line="1733">the event @@ -2313,7 +2329,7 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr Stores @data on the event, associated with the specified @key. + line="1688">Stores @data on the event, associated with the specified @key. This can be used to exchange arbitrary data between hooks that run for this event. @@ -2325,13 +2341,13 @@ This can be used to exchange arbitrary data between hooks that run for this even the event + line="1690">the event the key to associate @data with + line="1691">the key to associate @data with the data element, or %NULL to remove any previous data associated with this @key + line="1692">the data element, or %NULL to remove any previous data associated with this @key @@ -2348,7 +2364,7 @@ This can be used to exchange arbitrary data between hooks that run for this even Stops processing of this event; any further hooks will not be executed from this moment onwards and the event will be discarded from the stack. + line="1676">Stops processing of this event; any further hooks will not be executed from this moment onwards and the event will be discarded from the stack. @@ -2357,7 +2373,7 @@ This can be used to exchange arbitrary data between hooks that run for this even the event + line="1678">the event @@ -2389,7 +2405,7 @@ This can be used to exchange arbitrary data between hooks that run for this even c:identifier="wp_event_dispatcher_get_instance"> Returns the event dispatcher instance that is associated with the given core. + line="1386">Returns the event dispatcher instance that is associated with the given core. This method will also create the instance and register it with the core, if it had not been created before. @@ -2397,14 +2413,14 @@ This method will also create the instance and register it with the core, if it h the event dispatcher instance + line="1396">the event dispatcher instance the core + line="1388">the core @@ -2413,19 +2429,19 @@ This method will also create the instance and register it with the core, if it h c:identifier="wp_event_dispatcher_new_hooks_iterator"> Returns an iterator to iterate over all the registered hooks. + line="1439">Returns an iterator to iterate over all the registered hooks. a new iterator + line="1448">a new iterator the event dispatcher + line="1441">the event dispatcher @@ -2433,7 +2449,7 @@ This method will also create the instance and register it with the core, if it h Pushes a new event onto the event stack for dispatching only if there are any hooks are available for it. + line="1400">Pushes a new event onto the event stack for dispatching only if there are any hooks are available for it. @@ -2442,13 +2458,13 @@ This method will also create the instance and register it with the core, if it h the dispatcher + line="1402">the dispatcher the new event + line="1403">the new event @@ -2457,7 +2473,7 @@ This method will also create the instance and register it with the core, if it h c:identifier="wp_event_dispatcher_register_hook"> Registers an event hook. + line="1413">Registers an event hook. @@ -2466,13 +2482,13 @@ This method will also create the instance and register it with the core, if it h the event dispatcher + line="1415">the event dispatcher the hook to register + line="1416">the hook to register @@ -2481,7 +2497,7 @@ This method will also create the instance and register it with the core, if it h c:identifier="wp_event_dispatcher_unregister_hook"> Unregisters an event hook. + line="1426">Unregisters an event hook. @@ -2490,13 +2506,13 @@ This method will also create the instance and register it with the core, if it h the event dispatcher + line="1428">the event dispatcher the hook to unregister + line="1429">the hook to unregister @@ -2525,25 +2541,25 @@ This method will also create the instance and register it with the core, if it h Finishes the async operation that was started by wp_event_hook_run() + line="1547">Finishes the async operation that was started by wp_event_hook_run() FALSE if there was an error, TRUE otherwise + line="1558">FALSE if there was an error, TRUE otherwise the event hook + line="1549">the event hook the async operation result + line="1550">the async operation result @@ -2551,7 +2567,7 @@ This method will also create the instance and register it with the core, if it h Runs the hook on the given event. + line="1531">Runs the hook on the given event. @@ -2560,13 +2576,13 @@ This method will also create the instance and register it with the core, if it h the event hook + line="1533">the event hook the event that triggered the hook + line="1534">the event that triggered the hook a GCancellable to cancel the async operation + line="1535">a GCancellable to cancel the async operation a callback to fire after execution of the hook has completed + line="1536">a callback to fire after execution of the hook has completed data for the callback + line="1537">data for the callback @@ -2603,25 +2619,25 @@ This method will also create the instance and register it with the core, if it h Checks if the hook should be executed for a given event. + line="1517">Checks if the hook should be executed for a given event. TRUE if the hook should be executed for the given event, FALSE otherwise + line="1527">TRUE if the hook should be executed for the given event, FALSE otherwise the event hook + line="1519">the event hook the event + line="1520">the event @@ -2629,47 +2645,48 @@ This method will also create the instance and register it with the core, if it h Finishes the async operation that was started by wp_event_hook_run() + line="1547">Finishes the async operation that was started by wp_event_hook_run() FALSE if there was an error, TRUE otherwise + line="1558">FALSE if there was an error, TRUE otherwise the event hook + line="1549">the event hook the async operation result + line="1550">the async operation result + glib:get-property="dispatcher" + introspectable="0"> Returns the associated event dispatcher. + line="1491">Returns the associated event dispatcher. the event dispatcher on which this hook is registered, or NULL if the hook is not registered + line="1500">the event dispatcher on which this hook is registered, or NULL if the hook is not registered the event hook + line="1493">the event hook @@ -2679,19 +2696,19 @@ This method will also create the instance and register it with the core, if it h glib:get-property="name"> Returns the name of the hook. + line="1452">Returns the name of the hook. the event hook name + line="1461">the event hook name the event hook + line="1454">the event hook @@ -2701,12 +2718,12 @@ This method will also create the instance and register it with the core, if it h glib:get-property="runs-after-hooks"> Returns the names of the hooks that should run before this hook, or in other words, this hook should run after them. + line="1478">Returns the names of the hooks that should run before this hook, or in other words, this hook should run after them. a NULL-terminated array of hook names + line="1487">a NULL-terminated array of hook names @@ -2715,7 +2732,7 @@ This method will also create the instance and register it with the core, if it h the event hook + line="1480">the event hook @@ -2725,12 +2742,12 @@ This method will also create the instance and register it with the core, if it h glib:get-property="runs-before-hooks"> Returns the names of the hooks that should run after this hook, or in other words, this hook should run before them. + line="1465">Returns the names of the hooks that should run after this hook, or in other words, this hook should run before them. a NULL-terminated array of hook names + line="1474">a NULL-terminated array of hook names @@ -2739,7 +2756,7 @@ This method will also create the instance and register it with the core, if it h the event hook + line="1467">the event hook @@ -2747,7 +2764,7 @@ This method will also create the instance and register it with the core, if it h Runs the hook on the given event. + line="1531">Runs the hook on the given event. @@ -2756,13 +2773,13 @@ This method will also create the instance and register it with the core, if it h the event hook + line="1533">the event hook the event that triggered the hook + line="1534">the event that triggered the hook a GCancellable to cancel the async operation + line="1535">a GCancellable to cancel the async operation a callback to fire after execution of the hook has completed + line="1536">a callback to fire after execution of the hook has completed data for the callback + line="1537">data for the callback @@ -2800,40 +2817,50 @@ This method will also create the instance and register it with the core, if it h c:identifier="wp_event_hook_runs_for_event"> Checks if the hook should be executed for a given event. + line="1517">Checks if the hook should be executed for a given event. TRUE if the hook should be executed for the given event, FALSE otherwise + line="1527">TRUE if the hook should be executed for the given event, FALSE otherwise the event hook + line="1519">the event hook the event + line="1520">the event + c:identifier="wp_event_hook_set_dispatcher" + introspectable="0"> + Sets the associated event dispatcher. + the event hook + the event dispatcher on which this hook is registered @@ -2885,20 +2912,20 @@ This method will also create the instance and register it with the core, if it h TRUE if the hook should be executed for the given event, FALSE otherwise + line="1527">TRUE if the hook should be executed for the given event, FALSE otherwise the event hook + line="1519">the event hook the event + line="1520">the event @@ -2914,13 +2941,13 @@ This method will also create the instance and register it with the core, if it h the event hook + line="1533">the event hook the event that triggered the hook + line="1534">the event that triggered the hook a GCancellable to cancel the async operation + line="1535">a GCancellable to cancel the async operation a callback to fire after execution of the hook has completed + line="1536">a callback to fire after execution of the hook has completed @@ -2950,7 +2977,7 @@ This method will also create the instance and register it with the core, if it h allow-none="1"> data for the callback + line="1537">data for the callback @@ -2962,20 +2989,20 @@ This method will also create the instance and register it with the core, if it h FALSE if there was an error, TRUE otherwise + line="1558">FALSE if there was an error, TRUE otherwise the event hook + line="1549">the event hook the async operation result + line="1550">the async operation result @@ -3026,19 +3053,19 @@ A WpFactory is constructed internally by wireplumber, when the pipewire construc c:identifier="wp_feature_activation_transition_get_requested_features"> Gets the features requested to be activated in this transition. + line="2974">Gets the features requested to be activated in this transition. the features that were requested to be activated in this transition; this contains the features as they were passed in wp_object_activate() and therefore it may contain unsupported or already active features + line="2983">the features that were requested to be activated in this transition; this contains the features as they were passed in wp_object_activate() and therefore it may contain unsupported or already active features the transition + line="2976">the transition @@ -3070,7 +3097,7 @@ A WpFactory is constructed internally by wireplumber, when the pipewire construc Binds to the global and creates the underlying pw_proxy. + line="1784">Binds to the global and creates the underlying pw_proxy. This is mostly meant to be called internally. It will create the pw_proxy and will activate the WP_PROXY_FEATURE_BOUND feature. @@ -3079,14 +3106,14 @@ This may only be called if there is no pw_proxy associated with this object yet. TRUE on success, FALSE if there is no global to bind to + line="1795">TRUE on success, FALSE if there is no global to bind to the pipewire global + line="1786">the pipewire global @@ -3096,19 +3123,19 @@ This may only be called if there is no pw_proxy associated with this object yet. glib:get-property="global-properties"> Gets the global properties of a pipewire global. + line="1771">Gets the global properties of a pipewire global. the global (immutable) properties of this pipewire object + line="1780">the global (immutable) properties of this pipewire object the pipewire global + line="1773">the pipewire global @@ -3118,19 +3145,19 @@ This may only be called if there is no pw_proxy associated with this object yet. glib:get-property="permissions"> Gets the permissions of a pipewire global. + line="1758">Gets the permissions of a pipewire global. the permissions that wireplumber has on this object + line="1767">the permissions that wireplumber has on this object the pipewire global + line="1760">the pipewire global @@ -3139,7 +3166,7 @@ This may only be called if there is no pw_proxy associated with this object yet. c:identifier="wp_global_proxy_request_destroy"> Requests the PipeWire server to destroy the object represented by this proxy. + line="1744">Requests the PipeWire server to destroy the object represented by this proxy. If the server allows it, the object will be destroyed and the WpProxy's pw-proxy-destroyed signal will be emitted. If the server does not allow it, nothing will happen. @@ -3152,7 +3179,7 @@ This is mostly useful for destroying WpLink objects. the pipewire global + line="1746">the pipewire global @@ -3223,19 +3250,19 @@ Activate this object with at least WP_PROXY_FEATURE_BOUND to export it to PipeWi Creates a new metadata implementation. + line="2286">Creates a new metadata implementation. a new WpImplMetadata + line="2295">a new WpImplMetadata the core + line="2288">the core @@ -3245,19 +3272,19 @@ Activate this object with at least WP_PROXY_FEATURE_BOUND to export it to PipeWi version="0.4.3"> Creates a new metadata implementation with name and properties. + line="2299">Creates a new metadata implementation with name and properties. a new WpImplMetadata + line="2310">a new WpImplMetadata the core + line="2301">the core the metadata name + line="2302">the metadata name the metadata properties + line="2303">the metadata properties @@ -3316,25 +3343,25 @@ Activate this object with at least WP_PROXY_FEATURE_BOUND to export it to PipeWi Loads a PipeWire module into the WirePlumber process. + line="2316">Loads a PipeWire module into the WirePlumber process. the WpImplModule for the module that was loaded on success, NULL on failure. + line="2328">the WpImplModule for the module that was loaded on success, NULL on failure. The WirePlumber core + line="2318">The WirePlumber core the name of the module to load + line="2319">the name of the module to load arguments to be passed to the module + line="2320">arguments to be passed to the module additional properties to be provided to the module + line="2321">additional properties to be provided to the module @@ -3408,7 +3435,7 @@ Activate this object with at least WP_PROXY_FEATURE_BOUND to export it to PipeWi c:identifier="wp_impl_node_new_from_pw_factory"> Constructs a new node, locally on this process, using the specified @factory_name. + line="2529">Constructs a new node, locally on this process, using the specified @factory_name. To export this node to the PipeWire server, you need to call wp_object_activate() requesting WP_PROXY_FEATURE_BOUND and wait for the operation to complete. @@ -3416,20 +3443,20 @@ To export this node to the PipeWire server, you need to call wp_object_activate( A new WpImplNode wrapping the node that was constructed by the factory, or NULL if the factory does not exist or was unable to construct the node + line="2541">A new WpImplNode wrapping the node that was constructed by the factory, or NULL if the factory does not exist or was unable to construct the node the wireplumber core + line="2531">the wireplumber core the name of the pipewire factory + line="2532">the name of the pipewire factory properties to be passed to node constructor + line="2533">properties to be passed to node constructor @@ -3446,19 +3473,19 @@ To export this node to the PipeWire server, you need to call wp_object_activate( Constructs a node object from an existing pw_impl_node. + line="2515">Constructs a node object from an existing pw_impl_node. A new WpImplNode wrapping @node + line="2525">A new WpImplNode wrapping @node the wireplumber core + line="2517">the wireplumber core an existing pw_impl_node to wrap + line="2518">an existing pw_impl_node to wrap @@ -3539,7 +3566,7 @@ To export this node to the PipeWire server, you need to call wp_object_activate( introspectable="0"> Equivalent to: + line="1562">Equivalent to: @@ -3556,13 +3583,13 @@ The constraints specified in the variable arguments must follow the rules docume the event hook + line="1564">the event hook a list of constraints, terminated by NULL + line="1565">a list of constraints, terminated by NULL @@ -3670,7 +3697,7 @@ The constraints specified in the variable arguments must follow the rules docume Constructs an iterator that uses the provided @methods to implement its API. + line="1799">Constructs an iterator that uses the provided @methods to implement its API. The WpIterator structure is internally allocated with @user_size additional space at the end. A pointer to this space can be retrieved with wp_iterator_get_user_data() and is available for implementation-specific storage. @@ -3678,20 +3705,20 @@ The WpIterator structure is internally allocated with @user_size additional spac a new custom iterator + line="1810">a new custom iterator method implementations for the new iterator + line="1801">method implementations for the new iterator size of the user_data structure to be allocated + line="1802">size of the user_data structure to be allocated @@ -3701,19 +3728,19 @@ The WpIterator structure is internally allocated with @user_size additional spac introspectable="0"> Creates an iterator from a pointer array. + line="1912">Creates an iterator from a pointer array. a new iterator that iterates over @items + line="1922">a new iterator that iterates over @items the items to iterate over + line="1914">the items to iterate over @@ -3721,7 +3748,7 @@ The WpIterator structure is internally allocated with @user_size additional spac the type of each item + line="1915">the type of each item @@ -3729,19 +3756,19 @@ The WpIterator structure is internally allocated with @user_size additional spac Fold a function over the items of the iterator. + line="1881">Fold a function over the items of the iterator. TRUE if all the items were processed, FALSE otherwise. + line="1893">TRUE if all the items were processed, FALSE otherwise. the iterator + line="1883">the iterator the fold function + line="1884">the fold function the accumulator data + line="1885">the accumulator data the user data + line="1886">the user data @@ -3776,19 +3803,19 @@ The WpIterator structure is internally allocated with @user_size additional spac Iterates over all items of the iterator calling a function. + line="1897">Iterates over all items of the iterator calling a function. TRUE if all the items were processed, FALSE otherwise. + line="1908">TRUE if all the items were processed, FALSE otherwise. the iterator + line="1899">the iterator the foreach function + line="1900">the foreach function the user data + line="1901">the user data @@ -3814,7 +3841,7 @@ The WpIterator structure is internally allocated with @user_size additional spac Gets the implementation-specific storage of an iterator. + line="1814">Gets the implementation-specific storage of an iterator. this only for use by implementations of WpIterator @@ -3822,14 +3849,14 @@ this only for use by implementations of WpIterator a pointer to the implementation-specific storage area + line="1826">a pointer to the implementation-specific storage area an iterator object + line="1816">an iterator object @@ -3837,19 +3864,19 @@ this only for use by implementations of WpIterator Gets the next item of the iterator. + line="1867">Gets the next item of the iterator. TRUE if next iterator was obtained, FALSE when the iterator has no more items to iterate through. + line="1877">TRUE if next iterator was obtained, FALSE when the iterator has no more items to iterate through. the iterator + line="1869">the iterator transfer-ownership="none"> the next item of the iterator + line="1870">the next item of the iterator @@ -3866,19 +3893,19 @@ this only for use by implementations of WpIterator Increases the reference count of an iterator. + line="1830">Increases the reference count of an iterator. @self with an additional reference count on it + line="1839">@self with an additional reference count on it an iterator object + line="1832">an iterator object @@ -3886,7 +3913,7 @@ this only for use by implementations of WpIterator Resets the iterator so we can iterate again from the beginning. + line="1855">Resets the iterator so we can iterate again from the beginning. @@ -3895,7 +3922,7 @@ this only for use by implementations of WpIterator the iterator + line="1857">the iterator @@ -3903,7 +3930,7 @@ this only for use by implementations of WpIterator Decreases the reference count on @self and frees it when the ref count reaches zero. + line="1843">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -3912,7 +3939,7 @@ this only for use by implementations of WpIterator an iterator object + line="1845">an iterator object @@ -4053,8 +4080,8 @@ this only for use by implementations of WpIterator A custom GLib log level for trace messages (extension of GLogLevelFlags) - + line="2124">A custom GLib log level for trace messages (extension of GLogLevelFlags) + Constructs a link on the PipeWire server by asking the remote factory @factory_name to create it. + line="1976">Constructs a link on the PipeWire server by asking the remote factory @factory_name to create it. Because of the nature of the PipeWire protocol, this operation completes asynchronously at some point in the future. In order to find out when this is done, you should call wp_object_activate(), requesting at least WP_PROXY_FEATURE_BOUND. When this feature is ready, the link is ready for use on the server. If the link cannot be created, this activation operation will fail. @@ -4142,20 +4169,20 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr the new link or NULL if the core is not connected and therefore the link cannot be created + line="1988">the new link or NULL if the core is not connected and therefore the link cannot be created the wireplumber core + line="1978">the wireplumber core the pipewire factory name to construct the link + line="1979">the pipewire factory name to construct the link the properties to pass to the factory + line="1980">the properties to pass to the factory @@ -4173,7 +4200,7 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr c:identifier="wp_link_get_linked_object_ids"> Retrieves the ids of the objects that are linked by this link. + line="1992">Retrieves the ids of the objects that are linked by this link. Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO @@ -4185,7 +4212,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the link + line="1994">the link allow-none="1"> the bound id of the output (source) node + line="1995">the bound id of the output (source) node allow-none="1"> the bound id of the output (source) port + line="1996">the bound id of the output (source) port allow-none="1"> the bound id of the input (sink) node + line="1997">the bound id of the input (sink) node allow-none="1"> the bound id of the input (sink) port + line="1998">the bound id of the input (sink) port @@ -4240,19 +4267,19 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO version="0.4.11"> Gets the current state of the link. + line="2011">Gets the current state of the link. the current state of the link + line="2021">the current state of the link the link + line="2013">the link allow-none="1"> the error + line="2014">the error @@ -4362,7 +4389,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO Initializes a log topic. Internal function, don't use it directly. + line="2063">Initializes a log topic. Internal function, don't use it directly. @@ -4376,7 +4403,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO Registers a log topic. + line="2038">Registers a log topic. The log topic must be unregistered using wp_log_topic_unregister before its lifetime ends. @@ -4394,7 +4421,7 @@ This function is threadsafe. Unregisters a log topic. + line="2051">Unregisters a log topic. This function is threadsafe. @@ -4447,7 +4474,7 @@ A WpMetadata is constructed internally when a new metadata object appears on the Clears permanently all stored metadata. + line="2274">Clears permanently all stored metadata. @@ -4456,7 +4483,7 @@ A WpMetadata is constructed internally when a new metadata object appears on the the metadata object + line="2276">the metadata object @@ -4464,31 +4491,31 @@ A WpMetadata is constructed internally when a new metadata object appears on the Finds the metadata value given its @subject and @key. + line="2242">Finds the metadata value given its @subject and @key. the metadata string value, or NULL if not found. + line="2254">the metadata string value, or NULL if not found. a metadata object + line="2244">a metadata object the metadata subject id + line="2245">the metadata subject id the metadata key name + line="2246">the metadata key name the metadata type name + line="2247">the metadata type name @@ -4507,7 +4534,7 @@ A WpMetadata is constructed internally when a new metadata object appears on the Iterates over metadata items that matches the given @subject. + line="2226">Iterates over metadata items that matches the given @subject. If no constraints are specified, the returned iterator iterates over all the stored metadata. @@ -4516,20 +4543,20 @@ Note that this method works on cached metadata. When you change metadata with wp an iterator that iterates over the found metadata. The type of the iterator item is WpMetadataItem. + line="2238">an iterator that iterates over the found metadata. The type of the iterator item is WpMetadataItem. a metadata object + line="2228">a metadata object the metadata subject id, or -1 (PW_ID_ANY) + line="2229">the metadata subject id, or -1 (PW_ID_ANY) @@ -4537,7 +4564,7 @@ Note that this method works on cached metadata. When you change metadata with wp Sets the metadata associated with the given @subject and @key. Use NULL as a value to unset the given @key and use NULL in both @key and @value to remove all metadata associated with the given @subject. + line="2258">Sets the metadata associated with the given @subject and @key. Use NULL as a value to unset the given @key and use NULL in both @key and @value to remove all metadata associated with the given @subject. @@ -4546,13 +4573,13 @@ Note that this method works on cached metadata. When you change metadata with wp the metadata object + line="2260">the metadata object the subject id for which this metadata property is being set + line="2261">the subject id for which this metadata property is being set the key to set, or NULL to remove all metadata for @subject + line="2262">the key to set, or NULL to remove all metadata for @subject the type of the value; NULL is synonymous to "string" + line="2263">the type of the value; NULL is synonymous to "string" the value to set, or NULL to unset the given @key + line="2264">the value to set, or NULL to unset the given @key @@ -4646,19 +4673,19 @@ Note that this method works on cached metadata. When you change metadata with wp version="0.5.0"> Gets the key from a metadata item. + line="2181">Gets the key from a metadata item. the metadata key of the @item + line="2190">the metadata key of the @item the item held by the GValue that was returned from the WpIterator of wp_metadata_new_iterator() + line="2183">the item held by the GValue that was returned from the WpIterator of wp_metadata_new_iterator() @@ -4668,19 +4695,19 @@ Note that this method works on cached metadata. When you change metadata with wp version="0.5.0"> Gets the subject from a metadata item. + line="2166">Gets the subject from a metadata item. the metadata subject of the @item + line="2175">the metadata subject of the @item the item held by the GValue that was returned from the WpIterator of wp_metadata_new_iterator() + line="2168">the item held by the GValue that was returned from the WpIterator of wp_metadata_new_iterator() @@ -4690,19 +4717,19 @@ Note that this method works on cached metadata. When you change metadata with wp version="0.5.0"> Gets the value from a metadata item. + line="2211">Gets the value from a metadata item. the metadata value of the @item + line="2220">the metadata value of the @item the item held by the GValue that was returned from the WpIterator of wp_metadata_new_iterator() + line="2213">the item held by the GValue that was returned from the WpIterator of wp_metadata_new_iterator() @@ -4712,19 +4739,19 @@ Note that this method works on cached metadata. When you change metadata with wp version="0.5.0"> Gets the value type from a metadata item. + line="2196">Gets the value type from a metadata item. the metadata value type of the @item + line="2205">the metadata value type of the @item the item held by the GValue that was returned from the WpIterator of wp_metadata_new_iterator() + line="2198">the item held by the GValue that was returned from the WpIterator of wp_metadata_new_iterator() @@ -4732,19 +4759,19 @@ Note that this method works on cached metadata. When you change metadata with wp Increases the reference count of a metadata item object. + line="2137">Increases the reference count of a metadata item object. @self with an additional reference count on it + line="2146">@self with an additional reference count on it a metadata item object + line="2139">a metadata item object @@ -4754,7 +4781,7 @@ Note that this method works on cached metadata. When you change metadata with wp version="0.5.0"> Decreases the reference count on @self and frees it when the ref count reaches zero. + line="2152">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -4763,7 +4790,7 @@ Note that this method works on cached metadata. When you change metadata with wp a metadata item object + line="2154">a metadata item object @@ -4786,7 +4813,7 @@ A WpNode is constructed internally when a new node appears on the PipeWire regis c:identifier="wp_node_new_from_factory"> Constructs a node on the PipeWire server by asking the remote factory @factory_name to create it. + line="2334">Constructs a node on the PipeWire server by asking the remote factory @factory_name to create it. Because of the nature of the PipeWire protocol, this operation completes asynchronously at some point in the future. In order to find out when this is done, you should call wp_object_activate(), requesting at least WP_PROXY_FEATURE_BOUND. When this feature is ready, the node is ready for use on the server. If the node cannot be created, this activation operation will fail. @@ -4794,20 +4821,20 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr the new node or NULL if the core is not connected and therefore the node cannot be created + line="2346">the new node or NULL if the core is not connected and therefore the node cannot be created the wireplumber core + line="2336">the wireplumber core the pipewire factory name to construct the node + line="2337">the pipewire factory name to construct the node the properties to pass to the factory + line="2338">the properties to pass to the factory @@ -4826,7 +4853,7 @@ Because of the nature of the PipeWire protocol, this operation completes asynchr glib:get-property="n-input-ports"> Gets the number of input ports of this node. + line="2364">Gets the number of input ports of this node. Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO @@ -4834,14 +4861,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the number of input ports of this node, as reported by the node info + line="2377">the number of input ports of this node, as reported by the node info the node + line="2366">the node allow-none="1"> the maximum supported number of input ports + line="2367">the maximum supported number of input ports @@ -4862,7 +4889,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO glib:get-property="n-output-ports"> Gets the number of output ports of this node. + line="2381">Gets the number of output ports of this node. Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO @@ -4870,14 +4897,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the number of output ports of this node, as reported by the node info + line="2394">the number of output ports of this node, as reported by the node info the node + line="2383">the node allow-none="1"> the maximum supported number of output ports + line="2384">the maximum supported number of output ports @@ -4896,7 +4923,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO Gets the number of ports of this node. + line="2398">Gets the number of ports of this node. Note that this number may not add up to wp_node_get_n_input_ports() + wp_node_get_n_output_ports() because it is discovered by looking at the number of available ports in the registry, however ports may appear there with a delay or may not appear at all if this client does not have permission to read them @@ -4905,14 +4932,14 @@ Requires WP_NODE_FEATURE_PORTS the number of ports of this node. + line="2411">the number of ports of this node. the node + line="2400">the node @@ -4922,19 +4949,19 @@ Requires WP_NODE_FEATURE_PORTS glib:get-property="state"> Gets the current state of the node. + line="2350">Gets the current state of the node. the current state of the node + line="2360">the current state of the node the node + line="2352">the node allow-none="1"> the error + line="2353">the error @@ -4955,7 +4982,7 @@ Requires WP_NODE_FEATURE_PORTS introspectable="0"> Retrieves the first port that matches the constraints. + line="2466">Retrieves the first port that matches the constraints. The constraints specified in the variable arguments must follow the rules documented in wp_object_interest_new(). @@ -4964,20 +4991,20 @@ Requires WP_NODE_FEATURE_PORTS the first port that matches the constraints, or NULL if there is no such port + line="2480">the first port that matches the constraints, or NULL if there is no such port the node + line="2468">the node a list of constraints, terminated by NULL + line="2469">a list of constraints, terminated by NULL @@ -4985,7 +5012,7 @@ Requires WP_NODE_FEATURE_PORTS Retrieves the first port that matches the @interest. + line="2484">Retrieves the first port that matches the @interest. Requires WP_NODE_FEATURE_PORTS @@ -4993,20 +5020,20 @@ Requires WP_NODE_FEATURE_PORTS the first port that matches the @interest, or NULL if there is no such port + line="2497">the first port that matches the @interest, or NULL if there is no such port the node + line="2486">the node the interest + line="2487">the interest @@ -5016,7 +5043,7 @@ Requires WP_NODE_FEATURE_PORTS introspectable="0"> Gets a new iterator that iterates over all the ports that belong to this node and match the constraints. + line="2431">Gets a new iterator that iterates over all the ports that belong to this node and match the constraints. The constraints specified in the variable arguments must follow the rules documented in wp_object_interest_new(). @@ -5025,20 +5052,20 @@ Requires WP_NODE_FEATURE_PORTS a WpIterator that iterates over WpPort objects + line="2445">a WpIterator that iterates over WpPort objects the node + line="2433">the node a list of constraints, terminated by NULL + line="2434">a list of constraints, terminated by NULL @@ -5047,7 +5074,7 @@ Requires WP_NODE_FEATURE_PORTS c:identifier="wp_node_new_ports_filtered_iterator_full"> Gets a new iterator that iterates over all the ports that belong to this node and match the @interest. + line="2449">Gets a new iterator that iterates over all the ports that belong to this node and match the @interest. Requires WP_NODE_FEATURE_PORTS @@ -5055,20 +5082,20 @@ Requires WP_NODE_FEATURE_PORTS a WpIterator that iterates over WpPort objects + line="2462">a WpIterator that iterates over WpPort objects the node + line="2451">the node the interest + line="2452">the interest @@ -5077,7 +5104,7 @@ Requires WP_NODE_FEATURE_PORTS c:identifier="wp_node_new_ports_iterator"> Gets a new iterator that iterates over all the ports that belong to this node. + line="2415">Gets a new iterator that iterates over all the ports that belong to this node. Requires WP_NODE_FEATURE_PORTS @@ -5085,14 +5112,14 @@ Requires WP_NODE_FEATURE_PORTS a WpIterator that iterates over WpPort objects + line="2427">a WpIterator that iterates over WpPort objects the node + line="2417">the node @@ -5100,7 +5127,7 @@ Requires WP_NODE_FEATURE_PORTS Sends a command to a node. + line="2501">Sends a command to a node. Valid commands are the short string reprepsentations of enum spa_node_command. For example, "Suspend" or "Flush" are valid commands @@ -5112,13 +5139,13 @@ Valid commands are the short string reprepsentations of enum spa_node_command. F the node + line="2503">the node the command + line="2504">the command @@ -5238,8 +5265,8 @@ Valid commands are the short string reprepsentations of enum spa_node_command. F c:type="WP_OBJECT_FEATURES_ALL"> Special value that can be used to activate all the supported features in any given object. - + line="3156">Special value that can be used to activate all the supported features in any given object. + Deactivates the given @features, leaving the object in the state it was before they were enabled. + line="3108">Deactivates the given @features, leaving the object in the state it was before they were enabled. This is seldom needed to call manually, but it can be used to save resources if some features are no longer needed. @@ -5317,13 +5344,13 @@ This is seldom needed to call manually, but it can be used to save resources if the object + line="3110">the object the features to deactivate + line="3111">the features to deactivate @@ -5332,19 +5359,19 @@ This is seldom needed to call manually, but it can be used to save resources if invoker="get_supported_features"> Gets the supported features of this object. + line="3029">Gets the supported features of this object. A bitset containing the supported features of this object; note that supported features may change at runtime + line="3038">A bitset containing the supported features of this object; note that supported features may change at runtime the object + line="3031">the object @@ -5354,7 +5381,7 @@ This is seldom needed to call manually, but it can be used to save resources if version="0.4.6"> Aborts the current object activation by returning a transition error if any transitions are pending. + line="3122">Aborts the current object activation by returning a transition error if any transitions are pending. This is usually used to stop any pending activation if an error happened. @@ -5366,13 +5393,13 @@ This is usually used to stop any pending activation if an error happened. the object + line="3124">the object the message used in the transition error + line="3125">the message used in the transition error @@ -5382,7 +5409,7 @@ This is usually used to stop any pending activation if an error happened. glib:finish-func="activate_finish"> Callback version of wp_object_activate_closure() + line="3058">Callback version of wp_object_activate_closure() @@ -5391,13 +5418,13 @@ This is usually used to stop any pending activation if an error happened. the object + line="3060">the object the features to enable + line="3061">the features to enable allow-none="1"> a cancellable for the async operation + line="3062">a cancellable for the async operation closure="3"> a function to call when activation is complete + line="3063">a function to call when activation is complete allow-none="1"> data for @callback + line="3064">data for @callback @@ -5435,7 +5462,7 @@ This is usually used to stop any pending activation if an error happened. c:identifier="wp_object_activate_closure"> Activates the requested @features and invokes @closure when this is done. @features may contain unsupported or already active features. The operation will filter them and activate only ones that are supported and inactive. + line="3074">Activates the requested @features and invokes @closure when this is done. @features may contain unsupported or already active features. The operation will filter them and activate only ones that are supported and inactive. If multiple calls to this method is done, the operations will be executed one after the other to ensure features only get activated once. @@ -5448,13 +5475,13 @@ If multiple calls to this method is done, the operations will be executed one af the object + line="3076">the object the features to enable + line="3077">the features to enable a cancellable for the async operation + line="3078">a cancellable for the async operation the closure to use when activation is completed + line="3079">the closure to use when activation is completed @@ -5479,25 +5506,25 @@ If multiple calls to this method is done, the operations will be executed one af throws="1"> Finishes the async operation that was started with wp_object_activate() + line="3093">Finishes the async operation that was started with wp_object_activate() TRUE if the requested features were activated, FALSE if there was an error + line="3104">TRUE if the requested features were activated, FALSE if there was an error the object + line="3095">the object the async operation result + line="3096">the async operation result @@ -5505,7 +5532,7 @@ If multiple calls to this method is done, the operations will be executed one af Deactivates the given @features, leaving the object in the state it was before they were enabled. + line="3108">Deactivates the given @features, leaving the object in the state it was before they were enabled. This is seldom needed to call manually, but it can be used to save resources if some features are no longer needed. @@ -5517,13 +5544,13 @@ This is seldom needed to call manually, but it can be used to save resources if the object + line="3110">the object the features to deactivate + line="3111">the features to deactivate @@ -5533,19 +5560,19 @@ This is seldom needed to call manually, but it can be used to save resources if glib:get-property="active-features"> Gets the active features of this object. + line="3000">Gets the active features of this object. A bitset containing the active features of this object + line="3009">A bitset containing the active features of this object the object + line="3002">the object @@ -5555,19 +5582,19 @@ This is seldom needed to call manually, but it can be used to save resources if glib:get-property="core"> Gets the core associated with this object. + line="2987">Gets the core associated with this object. the core associated with this object + line="2996">the core associated with this object the object + line="2989">the object @@ -5577,7 +5604,7 @@ This is seldom needed to call manually, but it can be used to save resources if glib:get-property="id"> Gets the unique wireplumber Id of this object. + line="3992">Gets the unique wireplumber Id of this object. @@ -5586,7 +5613,7 @@ This is seldom needed to call manually, but it can be used to save resources if the session item + line="3994">the session item @@ -5596,19 +5623,19 @@ This is seldom needed to call manually, but it can be used to save resources if glib:get-property="supported-features"> Gets the supported features of this object. + line="3029">Gets the supported features of this object. A bitset containing the supported features of this object; note that supported features may change at runtime + line="3038">A bitset containing the supported features of this object; note that supported features may change at runtime the object + line="3031">the object @@ -5618,25 +5645,25 @@ This is seldom needed to call manually, but it can be used to save resources if version="0.5.0"> Checks if the given features are active on this object. + line="3013">Checks if the given features are active on this object. TRUE if all the given features are active on this object + line="3023">TRUE if all the given features are active on this object the object + line="3015">the object the features to check + line="3016">the features to check @@ -5646,25 +5673,25 @@ This is seldom needed to call manually, but it can be used to save resources if version="0.5.0"> Checks if the given features are supported on this object. + line="3042">Checks if the given features are supported on this object. TRUE if all the given features are supported on this object + line="3052">TRUE if all the given features are supported on this object the object + line="3044">the object the features to check + line="3045">the features to check @@ -5672,7 +5699,7 @@ This is seldom needed to call manually, but it can be used to save resources if Allows subclasses to update the currently active features. + line="3138">Allows subclasses to update the currently active features. @activated should contain new features and @deactivated should contain features that were just deactivated. Calling this method also advances the activation transitions. @@ -5685,19 +5712,19 @@ Private method to be called by subclasses only. the object + line="3140">the object the features that were activated, or 0 + line="3141">the features that were activated, or 0 the features that were deactivated, or 0 + line="3142">the features that were deactivated, or 0 @@ -5744,14 +5771,14 @@ Private method to be called by subclasses only. A bitset containing the supported features of this object; note that supported features may change at runtime + line="3038">A bitset containing the supported features of this object; note that supported features may change at runtime the object + line="3031">the object @@ -5813,13 +5840,13 @@ Private method to be called by subclasses only. the object + line="3110">the object the features to deactivate + line="3111">the features to deactivate @@ -5847,7 +5874,7 @@ An interest is defined by a GType and a set of constraints on the object's prope introspectable="0"> Creates a new interest that declares interest in objects of the specified @gtype, with the constraints specified in the variable arguments. + line="2545">Creates a new interest that declares interest in objects of the specified @gtype, with the constraints specified in the variable arguments. The variable arguments should be a list of constraints terminated with NULL, where each constraint consists of the following arguments: @@ -5882,20 +5909,20 @@ For example, this interest matches objects that are descendands of WpProxy with the new object interest + line="2583">the new object interest the type of the object to declare interest in + line="2547">the type of the object to declare interest in a set of constraints, terminated with NULL + line="2548">a set of constraints, terminated with NULL @@ -5903,7 +5930,7 @@ For example, this interest matches objects that are descendands of WpProxy with Creates a new interest that declares interest in objects of the specified @gtype, without any property constraints. + line="2601">Creates a new interest that declares interest in objects of the specified @gtype, without any property constraints. To add property constraints, you can call wp_object_interest_add_constraint() afterwards. @@ -5911,14 +5938,14 @@ To add property constraints, you can call wp_object_interest_add_constraint() af the new object interest + line="2611">the new object interest the type of the object to declare interest in + line="2603">the type of the object to declare interest in @@ -5928,25 +5955,25 @@ To add property constraints, you can call wp_object_interest_add_constraint() af introspectable="0"> va_list version of wp_object_interest_new() + line="2587">va_list version of wp_object_interest_new() the new object interest + line="2597">the new object interest the type of the object to declare interest in + line="2589">the type of the object to declare interest in pointer to va_list containing the constraints + line="2590">pointer to va_list containing the constraints @@ -5955,7 +5982,7 @@ To add property constraints, you can call wp_object_interest_add_constraint() af c:identifier="wp_object_interest_add_constraint"> Adds a constraint to this interest. Constraints consist of a @type, a @subject, a @verb and, depending on the @verb, a @value. + line="2615">Adds a constraint to this interest. Constraints consist of a @type, a @subject, a @verb and, depending on the @verb, a @value. Constraints are almost like a spoken language sentence that declare a condition that must be true in order to consider that an object can match this interest. For instance, a constraint can be "pipewire property @@ -5985,25 +6012,25 @@ This method does not fail if invalid arguments are given. However, wp_object_int the object interest + line="2617">the object interest the constraint type + line="2618">the constraint type the subject that the constraint applies to + line="2619">the subject that the constraint applies to the operation that is performed to check the constraint + line="2620">the operation that is performed to check the constraint the value to check for + line="2621">the value to check for @@ -6020,7 +6047,7 @@ This method does not fail if invalid arguments are given. However, wp_object_int Checks if the specified @object matches the type and all the constraints that are described in @self. + line="2692">Checks if the specified @object matches the type and all the constraints that are described in @self. If @self is configured to match GObject subclasses, this is equivalent to wp_object_interest_matches_full (self, G_OBJECT_TYPE (object), object, NULL, NULL) and if it is configured to match WpProperties, this is equivalent to wp_object_interest_matches_full (self, self->gtype, NULL, (WpProperties *) object, NULL); @@ -6028,14 +6055,14 @@ If @self is configured to match GObject subclasses, this is equivalent to wp_obj TRUE if the object matches, FALSE otherwise + line="2703">TRUE if the object matches, FALSE otherwise the object interest + line="2694">the object interest the target object to check for a match + line="2695">the target object to check for a match @@ -6053,7 +6080,7 @@ If @self is configured to match GObject subclasses, this is equivalent to wp_obj c:identifier="wp_object_interest_matches_full"> A low-level version of wp_object_interest_matches(). + line="2707">A low-level version of wp_object_interest_matches(). In this version, the object's type is directly given in @object_type and is not inferred from the @object. @object is only used to check for constraints against GObject properties. @@ -6064,26 +6091,26 @@ When @flags contains WP_INTEREST_MATCH_FLAGS_CHECK_ALL, all the constraints are flags that indicate which components of the interest match. WP_INTEREST_MATCH_ALL indicates a fully successful match; any other combination indicates a failure on the component(s) that do not appear on the flag set + line="2725">flags that indicate which components of the interest match. WP_INTEREST_MATCH_ALL indicates a fully successful match; any other combination indicates a failure on the component(s) that do not appear on the flag set the object interest + line="2709">the object interest flags to alter the behavior of this function + line="2710">flags to alter the behavior of this function the type to be checked against the interest's type + line="2711">the type to be checked against the interest's type the object to be used for checking constraints of type WP_CONSTRAINT_TYPE_G_PROPERTY + line="2712">the object to be used for checking constraints of type WP_CONSTRAINT_TYPE_G_PROPERTY the properties to be used for checking constraints of type WP_CONSTRAINT_TYPE_PW_PROPERTY + line="2713">the properties to be used for checking constraints of type WP_CONSTRAINT_TYPE_PW_PROPERTY the properties to be used for checking constraints of type WP_CONSTRAINT_TYPE_PW_GLOBAL_PROPERTY + line="2714">the properties to be used for checking constraints of type WP_CONSTRAINT_TYPE_PW_GLOBAL_PROPERTY @@ -6118,19 +6145,19 @@ When @flags contains WP_INTEREST_MATCH_FLAGS_CHECK_ALL, all the constraints are Increases the reference count of an object interest. + line="2650">Increases the reference count of an object interest. @self with an additional reference count on it + line="2659">@self with an additional reference count on it the object interest to ref + line="2652">the object interest to ref @@ -6138,7 +6165,7 @@ When @flags contains WP_INTEREST_MATCH_FLAGS_CHECK_ALL, all the constraints are Decreases the reference count on @self and frees it when the ref count reaches zero. + line="2663">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -6147,7 +6174,7 @@ When @flags contains WP_INTEREST_MATCH_FLAGS_CHECK_ALL, all the constraints are the object interest to unref + line="2665">the object interest to unref @@ -6157,7 +6184,7 @@ When @flags contains WP_INTEREST_MATCH_FLAGS_CHECK_ALL, all the constraints are throws="1"> Validates the interest, ensuring that the interest GType is a valid object and that all the constraints have been expressed properly. + line="2675">Validates the interest, ensuring that the interest GType is a valid object and that all the constraints have been expressed properly. This is called internally when @self is first used to find a match, so it is not necessary to call it explicitly @@ -6165,14 +6192,14 @@ This is called internally when @self is first used to find a match, so it is not TRUE if the interest is valid and can be used in a match, FALSE otherwise + line="2688">TRUE if the interest is valid and can be used in a match, FALSE otherwise the object interest to validate + line="2677">the object interest to validate @@ -6200,25 +6227,39 @@ Upon installing a WpObjectManager on a WpCore, any pre-existing objects that mat Constructs a new object manager. + line="2729">Constructs a new object manager. the newly constructed object manager + line="2737">the newly constructed object manager - + + Adds a global object to the object manager. + + +caller must also call wp_object_manager_maybe_objects_changed() after + the object manager + the global object to add @@ -6228,7 +6269,7 @@ Upon installing a WpObjectManager on a WpCore, any pre-existing objects that mat introspectable="0"> Equivalent to: + line="2754">Equivalent to: @@ -6245,19 +6286,19 @@ The constraints specified in the variable arguments must follow the rules docume the object manager + line="2756">the object manager the GType of the objects that we are declaring interest in + line="2757">the GType of the objects that we are declaring interest in a list of constraints, terminated by NULL + line="2758">a list of constraints, terminated by NULL @@ -6266,7 +6307,7 @@ The constraints specified in the variable arguments must follow the rules docume c:identifier="wp_object_manager_add_interest_full"> Declares interest in a certain kind of object. + line="2774">Declares interest in a certain kind of object. Interest consists of a GType that the object must be an ancestor of (g_type_is_a() must match) and optionally, a set of additional constraints on certain properties of the object. Refer to WpObjectInterest for more details. @@ -6278,30 +6319,44 @@ Interest consists of a GType that the object must be an ancestor of (g_type_is_a the object manager + line="2776">the object manager the interest + line="2777">the interest - + + Adds an object to the object manager. + + +caller must also call wp_object_manager_maybe_objects_changed() after + the object manager + the object to add @@ -6310,19 +6365,19 @@ Interest consists of a GType that the object must be an ancestor of (g_type_is_a c:identifier="wp_object_manager_get_n_objects"> Gets the number of objects managed by the object manager. + line="2803">Gets the number of objects managed by the object manager. the number of objects managed by this WpObjectManager + line="2812">the number of objects managed by this WpObjectManager the object manager + line="2805">the object manager @@ -6331,19 +6386,19 @@ Interest consists of a GType that the object must be an ancestor of (g_type_is_a c:identifier="wp_object_manager_is_installed"> Checks if an object manager is installed. + line="2741">Checks if an object manager is installed. TRUE if the object manager is installed (i.e. the WpObjectManager installed signal has been emitted), FALSE otherwise + line="2750">TRUE if the object manager is installed (i.e. the WpObjectManager installed signal has been emitted), FALSE otherwise the object manager + line="2743">the object manager @@ -6353,7 +6408,7 @@ Interest consists of a GType that the object must be an ancestor of (g_type_is_a introspectable="0"> Equivalent to: + line="2864">Equivalent to: @@ -6366,26 +6421,26 @@ The constraints specified in the variable arguments must follow the rules docume the first managed object that matches the lookup interest, or NULL if no object matches + line="2881">the first managed object that matches the lookup interest, or NULL if no object matches the object manager + line="2866">the object manager the GType of the object to lookup + line="2867">the GType of the object to lookup a list of constraints, terminated by NULL + line="2868">a list of constraints, terminated by NULL @@ -6393,7 +6448,7 @@ The constraints specified in the variable arguments must follow the rules docume Searches for an object that matches the specified @interest and returns it, if found. + line="2885">Searches for an object that matches the specified @interest and returns it, if found. If more than one objects match, only the first one is returned. To find multiple objects that match certain criteria, wp_object_manager_new_filtered_iterator() is more suitable. @@ -6401,32 +6456,39 @@ If more than one objects match, only the first one is returned. To find multiple the first managed object that matches the lookup interest, or NULL if no object matches + line="2896">the first managed object that matches the lookup interest, or NULL if no object matches the object manager + line="2887">the object manager the interst + line="2888">the interst + c:identifier="wp_object_manager_maybe_objects_changed" + introspectable="0"> + Checks if the object manager should emit the 'objects-changed' signal. + the object manager @@ -6436,7 +6498,7 @@ If more than one objects match, only the first one is returned. To find multiple introspectable="0"> Equivalent to: + line="2829">Equivalent to: @@ -6449,26 +6511,26 @@ The constraints specified in the variable arguments must follow the rules docume a WpIterator that iterates over all the matching objects of this object manager + line="2846">a WpIterator that iterates over all the matching objects of this object manager the object manager + line="2831">the object manager the GType of the objects to iterate through + line="2832">the GType of the objects to iterate through a list of constraints, terminated by NULL + line="2833">a list of constraints, terminated by NULL @@ -6477,25 +6539,25 @@ The constraints specified in the variable arguments must follow the rules docume c:identifier="wp_object_manager_new_filtered_iterator_full"> Iterates through all the objects managed by this object manager that match the specified @interest. + line="2850">Iterates through all the objects managed by this object manager that match the specified @interest. a WpIterator that iterates over all the matching objects of this object manager + line="2860">a WpIterator that iterates over all the matching objects of this object manager the object manager + line="2852">the object manager the interest + line="2853">the interest @@ -6504,19 +6566,19 @@ The constraints specified in the variable arguments must follow the rules docume c:identifier="wp_object_manager_new_iterator"> Iterates through all the objects managed by this object manager. + line="2816">Iterates through all the objects managed by this object manager. a WpIterator that iterates over all the managed objects of this object manager + line="2825">a WpIterator that iterates over all the managed objects of this object manager the object manager + line="2818">the object manager @@ -6525,7 +6587,7 @@ The constraints specified in the variable arguments must follow the rules docume c:identifier="wp_object_manager_request_object_features"> Requests the object manager to automatically prepare the @wanted_features on any managed object that is of the specified @object_type. + line="2788">Requests the object manager to automatically prepare the @wanted_features on any managed object that is of the specified @object_type. These features will always be prepared before the object appears on the object manager. @@ -6537,36 +6599,50 @@ These features will always be prepared before the object appears on the object m the object manager + line="2790">the object manager the WpProxy descendant type + line="2791">the WpProxy descendant type the features to enable on this kind of object + line="2792">the features to enable on this kind of object - + + Removes an object from the object manager. + + +caller must also call wp_object_manager_maybe_objects_changed() after + the object manager + the object to remove @@ -6640,7 +6716,7 @@ The common characteristic of all objects that implement this interface is the pr glib:sync-func="enum_params_sync"> Enumerate object parameters. + line="3870">Enumerate object parameters. This will asynchronously return the result, or an error, by calling the given @callback. The result is going to be a WpIterator containing WpSpaPod objects, which can be retrieved with wp_pipewire_object_enum_params_finish(). @@ -6652,7 +6728,7 @@ This will asynchronously return the result, or an error, by calling the given @c the pipewire object + line="3872">the pipewire object the parameter id to enumerate or NULL for all parameters + line="3873">the parameter id to enumerate or NULL for all parameters a param filter or NULL + line="3874">a param filter or NULL a cancellable for the async operation + line="3875">a cancellable for the async operation a callback to call with the result + line="3876">a callback to call with the result data to pass to @callback + line="3877">data to pass to @callback @@ -6710,25 +6786,25 @@ This will asynchronously return the result, or an error, by calling the given @c throws="1"> Finishes an asynchronous parameter enumeration operation. + line="3888">Finishes an asynchronous parameter enumeration operation. an iterator to iterate over the collected params, or NULL if the operation resulted in error; the items in the iterator are WpSpaPod + line="3899">an iterator to iterate over the collected params, or NULL if the operation resulted in error; the items in the iterator are WpSpaPod the pipewire object + line="3890">the pipewire object the async result + line="3891">the async result @@ -6738,7 +6814,7 @@ This will asynchronously return the result, or an error, by calling the given @c glib:async-func="enum_params"> This method can be used to retrieve object parameters in a synchronous way (in contrast with wp_pipewire_object_enum_params(), which is async). + line="3903">This method can be used to retrieve object parameters in a synchronous way (in contrast with wp_pipewire_object_enum_params(), which is async). The WP_PIPEWIRE_OBJECT_FEATURE_PARAM_<something> feature that corresponds to the specified @id must have been activated earlier. These features enable monitoring and caching of params underneath, so that they are always available for retrieval with this method. @@ -6747,20 +6823,20 @@ Note, however, that cached params may be out-of-date if they have changed very r an iterator to iterate over cached parameters, or NULL if parameters for this @id are not cached; the items in the iterator are WpSpaPod + line="3916">an iterator to iterate over cached parameters, or NULL if parameters for this @id are not cached; the items in the iterator are WpSpaPod the pipewire object + line="3905">the pipewire object the parameter id to enumerate + line="3906">the parameter id to enumerate a param filter or NULL + line="3907">a param filter or NULL @@ -6777,7 +6853,7 @@ Note, however, that cached params may be out-of-date if they have changed very r Retrieves the native infor structure of this object (pw_node_info, pw_port_info, etc...) + line="3781">Retrieves the native infor structure of this object (pw_node_info, pw_port_info, etc...) Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO @@ -6785,14 +6861,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the native pipewire info structure of this object + line="3793">the native pipewire info structure of this object the pipewire object + line="3783">the pipewire object @@ -6800,7 +6876,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO Returns the available parameters of this pipewire object. + line="3848">Returns the available parameters of this pipewire object. The return value is a GVariant of type a{ss}, where the key of each map entry is a spa param type id (the same ids that you can pass in wp_pipewire_object_enum_params()) and the value is a string that can contain the following letters, each of them representing a flag: @@ -6814,14 +6890,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO a variant of type a{ss} or NULL if the object does not support params at all + line="3866">a variant of type a{ss} or NULL if the object does not support params at all the pipewire object + line="3850">the pipewire object @@ -6829,7 +6905,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO Retrieves the PipeWire properties of this object. + line="3797">Retrieves the PipeWire properties of this object. Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO @@ -6837,14 +6913,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the pipewire properties of this object; normally these are the properties that are part of the info structure + line="3809">the pipewire properties of this object; normally these are the properties that are part of the info structure the pipewire object + line="3799">the pipewire object @@ -6852,37 +6928,37 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO Sets a parameter on the object. + line="3920">Sets a parameter on the object. TRUE on success, FALSE if setting the param failed + line="3932">TRUE on success, FALSE if setting the param failed the pipewire object + line="3922">the pipewire object the parameter id to set + line="3923">the parameter id to set optional flags or 0 + line="3924">optional flags or 0 the parameter to set + line="3925">the parameter to set @@ -6893,7 +6969,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO glib:sync-func="enum_params_sync"> Enumerate object parameters. + line="3870">Enumerate object parameters. This will asynchronously return the result, or an error, by calling the given @callback. The result is going to be a WpIterator containing WpSpaPod objects, which can be retrieved with wp_pipewire_object_enum_params_finish(). @@ -6905,7 +6981,7 @@ This will asynchronously return the result, or an error, by calling the given @c the pipewire object + line="3872">the pipewire object the parameter id to enumerate or NULL for all parameters + line="3873">the parameter id to enumerate or NULL for all parameters a param filter or NULL + line="3874">a param filter or NULL a cancellable for the async operation + line="3875">a cancellable for the async operation a callback to call with the result + line="3876">a callback to call with the result data to pass to @callback + line="3877">data to pass to @callback @@ -6962,25 +7038,25 @@ This will asynchronously return the result, or an error, by calling the given @c throws="1"> Finishes an asynchronous parameter enumeration operation. + line="3888">Finishes an asynchronous parameter enumeration operation. an iterator to iterate over the collected params, or NULL if the operation resulted in error; the items in the iterator are WpSpaPod + line="3899">an iterator to iterate over the collected params, or NULL if the operation resulted in error; the items in the iterator are WpSpaPod the pipewire object + line="3890">the pipewire object the async result + line="3891">the async result @@ -6990,7 +7066,7 @@ This will asynchronously return the result, or an error, by calling the given @c glib:async-func="enum_params"> This method can be used to retrieve object parameters in a synchronous way (in contrast with wp_pipewire_object_enum_params(), which is async). + line="3903">This method can be used to retrieve object parameters in a synchronous way (in contrast with wp_pipewire_object_enum_params(), which is async). The WP_PIPEWIRE_OBJECT_FEATURE_PARAM_<something> feature that corresponds to the specified @id must have been activated earlier. These features enable monitoring and caching of params underneath, so that they are always available for retrieval with this method. @@ -6999,20 +7075,20 @@ Note, however, that cached params may be out-of-date if they have changed very r an iterator to iterate over cached parameters, or NULL if parameters for this @id are not cached; the items in the iterator are WpSpaPod + line="3916">an iterator to iterate over cached parameters, or NULL if parameters for this @id are not cached; the items in the iterator are WpSpaPod the pipewire object + line="3905">the pipewire object the parameter id to enumerate + line="3906">the parameter id to enumerate a param filter or NULL + line="3907">a param filter or NULL @@ -7031,7 +7107,7 @@ Note, however, that cached params may be out-of-date if they have changed very r glib:get-property="native-info"> Retrieves the native infor structure of this object (pw_node_info, pw_port_info, etc...) + line="3781">Retrieves the native infor structure of this object (pw_node_info, pw_port_info, etc...) Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO @@ -7039,14 +7115,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the native pipewire info structure of this object + line="3793">the native pipewire info structure of this object the pipewire object + line="3783">the pipewire object @@ -7056,7 +7132,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO glib:get-property="param-info"> Returns the available parameters of this pipewire object. + line="3848">Returns the available parameters of this pipewire object. The return value is a GVariant of type a{ss}, where the key of each map entry is a spa param type id (the same ids that you can pass in wp_pipewire_object_enum_params()) and the value is a string that can contain the following letters, each of them representing a flag: @@ -7070,14 +7146,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO a variant of type a{ss} or NULL if the object does not support params at all + line="3866">a variant of type a{ss} or NULL if the object does not support params at all the pipewire object + line="3850">the pipewire object @@ -7087,7 +7163,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO glib:get-property="properties"> Retrieves the PipeWire properties of this object. + line="3797">Retrieves the PipeWire properties of this object. Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO @@ -7095,14 +7171,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the pipewire properties of this object; normally these are the properties that are part of the info structure + line="3809">the pipewire properties of this object; normally these are the properties that are part of the info structure the pipewire object + line="3799">the pipewire object @@ -7111,7 +7187,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO c:identifier="wp_pipewire_object_get_property"> Returns the value of a single pipewire property. + line="3829">Returns the value of a single pipewire property. This is the same as getting the whole properties structure with wp_pipewire_object_get_properties() and accessing a single property with wp_properties_get(), but saves one call and having to clean up the WpProperties reference count afterwards. @@ -7121,20 +7197,20 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the value of the pipewire property @key or NULL if the property doesn't exist + line="3844">the value of the pipewire property @key or NULL if the property doesn't exist the pipewire object + line="3831">the pipewire object the property name + line="3832">the property name @@ -7143,7 +7219,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO c:identifier="wp_pipewire_object_new_properties_iterator"> Iterates over the object's PipeWire properties. + line="3813">Iterates over the object's PipeWire properties. Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO @@ -7151,14 +7227,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO an iterator that iterates over the pipewire properties of this object. Use wp_properties_iterator_item_get_key() and wp_properties_iterator_item_get_value() to parse the items returned by this iterator. + line="3825">an iterator that iterates over the pipewire properties of this object. Use wp_properties_iterator_item_get_key() and wp_properties_iterator_item_get_value() to parse the items returned by this iterator. the pipewire object + line="3815">the pipewire object @@ -7166,37 +7242,37 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO Sets a parameter on the object. + line="3920">Sets a parameter on the object. TRUE on success, FALSE if setting the param failed + line="3932">TRUE on success, FALSE if setting the param failed the pipewire object + line="3922">the pipewire object the parameter id to set + line="3923">the parameter id to set optional flags or 0 + line="3924">optional flags or 0 the parameter to set + line="3925">the parameter to set @@ -7240,14 +7316,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the native pipewire info structure of this object + line="3793">the native pipewire info structure of this object the pipewire object + line="3783">the pipewire object @@ -7259,14 +7335,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the pipewire properties of this object; normally these are the properties that are part of the info structure + line="3809">the pipewire properties of this object; normally these are the properties that are part of the info structure the pipewire object + line="3799">the pipewire object @@ -7278,14 +7354,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO a variant of type a{ss} or NULL if the object does not support params at all + line="3866">a variant of type a{ss} or NULL if the object does not support params at all the pipewire object + line="3850">the pipewire object @@ -7301,7 +7377,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the pipewire object + line="3872">the pipewire object allow-none="1"> the parameter id to enumerate or NULL for all parameters + line="3873">the parameter id to enumerate or NULL for all parameters allow-none="1"> a param filter or NULL + line="3874">a param filter or NULL allow-none="1"> a cancellable for the async operation + line="3875">a cancellable for the async operation closure="5"> a callback to call with the result + line="3876">a callback to call with the result @@ -7350,7 +7426,7 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO closure="5"> data to pass to @callback + line="3877">data to pass to @callback @@ -7362,20 +7438,20 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO an iterator to iterate over the collected params, or NULL if the operation resulted in error; the items in the iterator are WpSpaPod + line="3899">an iterator to iterate over the collected params, or NULL if the operation resulted in error; the items in the iterator are WpSpaPod the pipewire object + line="3890">the pipewire object the async result + line="3891">the async result @@ -7387,20 +7463,20 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO an iterator to iterate over cached parameters, or NULL if parameters for this @id are not cached; the items in the iterator are WpSpaPod + line="3916">an iterator to iterate over cached parameters, or NULL if parameters for this @id are not cached; the items in the iterator are WpSpaPod the pipewire object + line="3905">the pipewire object the parameter id to enumerate + line="3906">the parameter id to enumerate allow-none="1"> a param filter or NULL + line="3907">a param filter or NULL @@ -7421,32 +7497,32 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO TRUE on success, FALSE if setting the param failed + line="3932">TRUE on success, FALSE if setting the param failed the pipewire object + line="3922">the pipewire object the parameter id to set + line="3923">the parameter id to set optional flags or 0 + line="3924">optional flags or 0 the parameter to set + line="3925">the parameter to set @@ -7475,25 +7551,25 @@ Being a WpObject subclass, the plugin inherits WpObject's activation system. For Looks up a plugin. + line="3169">Looks up a plugin. the plugin matching the lookup name + line="3179">the plugin matching the lookup name the core + line="3171">the core the lookup name + line="3172">the lookup name @@ -7528,19 +7604,19 @@ Being a WpObject subclass, the plugin inherits WpObject's activation system. For glib:get-property="name"> Retreives the name of a plugin. + line="3183">Retreives the name of a plugin. the name of this plugin + line="3192">the name of this plugin the plugin + line="3185">the plugin @@ -7626,7 +7702,7 @@ A WpPort is constructed internally when a new port appears on the PipeWire regis Gets the current direction of the port. + line="3196">Gets the current direction of the port. Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO @@ -7634,14 +7710,14 @@ Requires WP_PIPEWIRE_OBJECT_FEATURE_INFO the current direction of the port + line="3208">the current direction of the port the port + line="3198">the port @@ -7674,25 +7750,25 @@ WpProperties is reference-counted with wp_properties_ref() and wp_properties_unr introspectable="0"> Constructs a new properties set that contains the given properties. + line="3224">Constructs a new properties set that contains the given properties. the newly constructed properties set + line="3234">the newly constructed properties set a property name + line="3226">a property name a property value, followed by any number of further property key-value pairs, followed by NULL + line="3227">a property value, followed by any number of further property key-value pairs, followed by NULL @@ -7700,12 +7776,12 @@ WpProperties is reference-counted with wp_properties_ref() and wp_properties_unr Constructs a new WpProperties that contains a copy of all the properties contained in the given @props structure. + line="3307">Constructs a new WpProperties that contains a copy of all the properties contained in the given @props structure. the newly constructed properties set + line="3316">the newly constructed properties set @@ -7715,7 +7791,7 @@ WpProperties is reference-counted with wp_properties_ref() and wp_properties_unr allow-none="1"> a native pw_properties structure to copy + line="3309">a native pw_properties structure to copy @@ -7724,12 +7800,12 @@ WpProperties is reference-counted with wp_properties_ref() and wp_properties_unr c:identifier="wp_properties_new_copy_dict"> Constructs a new WpProperties that contains a copy of all the properties contained in the given @dict structure. + line="3335">Constructs a new WpProperties that contains a copy of all the properties contained in the given @dict structure. the newly constructed properties set + line="3344">the newly constructed properties set @@ -7739,7 +7815,7 @@ WpProperties is reference-counted with wp_properties_ref() and wp_properties_unr allow-none="1"> a native spa_dict structure to copy + line="3337">a native spa_dict structure to copy @@ -7747,31 +7823,31 @@ WpProperties is reference-counted with wp_properties_ref() and wp_properties_unr Creates a new empty properties set. + line="3212">Creates a new empty properties set. the newly constructed properties set + line="3220">the newly constructed properties set Constructs a new properties set that contains the properties that can be parsed from the given JSON object. + line="3265">Constructs a new properties set that contains the properties that can be parsed from the given JSON object. the newly constructed properties set + line="3274">the newly constructed properties set a JSON object + line="3267">a JSON object @@ -7779,19 +7855,19 @@ WpProperties is reference-counted with wp_properties_ref() and wp_properties_unr Constructs a new properties set that contains the properties that can be parsed from the given string. + line="3252">Constructs a new properties set that contains the properties that can be parsed from the given string. the newly constructed properties set + line="3261">the newly constructed properties set a string containing either a whitespace separated list of key=value pairs (ex. "key1=value1 key2=value2") or a JSON object (ex. '{"key1":"value1"}') + line="3254">a string containing either a whitespace separated list of key=value pairs (ex. "key1=value1 key2=value2") or a JSON object (ex. '{"key1":"value1"}') @@ -7799,7 +7875,7 @@ WpProperties is reference-counted with wp_properties_ref() and wp_properties_unr Constructs a new WpProperties that wraps the given @props structure, allowing reading & writing properties on that @props structure through the WpProperties API. + line="3293">Constructs a new WpProperties that wraps the given @props structure, allowing reading & writing properties on that @props structure through the WpProperties API. In constrast with wp_properties_new_wrap(), this function assumes ownership of the @props structure, so it will try to free @props when it is destroyed. @@ -7807,7 +7883,7 @@ In constrast with wp_properties_new_wrap(), this function assumes ownership of t the newly constructed properties set + line="3303">the newly constructed properties set @@ -7817,7 +7893,7 @@ In constrast with wp_properties_new_wrap(), this function assumes ownership of t allow-none="1"> a native pw_properties structure to wrap + line="3295">a native pw_properties structure to wrap @@ -7827,25 +7903,25 @@ In constrast with wp_properties_new_wrap(), this function assumes ownership of t introspectable="0"> This is the va_list version of wp_properties_new() + line="3238">This is the va_list version of wp_properties_new() the newly constructed properties set + line="3248">the newly constructed properties set a property name + line="3240">a property name the variable arguments passed to wp_properties_new() + line="3241">the variable arguments passed to wp_properties_new() @@ -7853,7 +7929,7 @@ In constrast with wp_properties_new_wrap(), this function assumes ownership of t Constructs a new WpProperties that wraps the given @props structure, allowing reading properties on that @props structure through the WpProperties API. + line="3278">Constructs a new WpProperties that wraps the given @props structure, allowing reading properties on that @props structure through the WpProperties API. Care must be taken when using this function, since the returned WpProperties object does not own the @props structure. Therefore, if the owner decides to free @props, the returned WpProperties will crash when used. In addition, the returned WpProperties object will not try to free @props when destroyed. @@ -7862,7 +7938,7 @@ Furthermore, note that the returned WpProperties object is immutable. That means the newly constructed properties set + line="3289">the newly constructed properties set @@ -7872,7 +7948,7 @@ Furthermore, note that the returned WpProperties object is immutable. That means allow-none="1"> a native pw_properties structure to wrap + line="3280">a native pw_properties structure to wrap @@ -7881,7 +7957,7 @@ Furthermore, note that the returned WpProperties object is immutable. That means c:identifier="wp_properties_new_wrap_dict"> Constructs a new WpProperties that wraps the given @dict structure, allowing reading properties from that @dict through the WpProperties API. + line="3320">Constructs a new WpProperties that wraps the given @dict structure, allowing reading properties from that @dict through the WpProperties API. Note that the returned object does not own the @dict, so care must be taken not to free it externally while this WpProperties object is alive. @@ -7890,7 +7966,7 @@ In addition, note that the returned WpProperties object is immutable. That means the newly constructed properties set + line="3331">the newly constructed properties set @@ -7900,7 +7976,7 @@ In addition, note that the returned WpProperties object is immutable. That means allow-none="1"> a native spa_dict structure to wrap + line="3322">a native spa_dict structure to wrap @@ -7908,7 +7984,7 @@ In addition, note that the returned WpProperties object is immutable. That means Adds new properties in @self, using the given @props as a source. + line="3436">Adds new properties in @self, using the given @props as a source. Properties (keys) from @props that are already contained in @self are not modified, unlike what happens with wp_properties_update(). Properties in @self that are not contained in @props are left untouched. @@ -7916,20 +7992,20 @@ Properties (keys) from @props that are already contained in @self are not modifi the number of properties that were changed + line="3447">the number of properties that were changed a properties object + line="3438">a properties object a properties set that contains properties to add + line="3439">a properties set that contains properties to add @@ -7937,7 +8013,7 @@ Properties (keys) from @props that are already contained in @self are not modifi Adds new properties in @self, using the given @dict as a source. + line="3451">Adds new properties in @self, using the given @dict as a source. Properties (keys) from @dict that are already contained in @self are not modified, unlike what happens with wp_properties_update_from_dict(). Properties in @self that are not contained in @dict are left untouched. @@ -7945,14 +8021,14 @@ Properties (keys) from @dict that are already contained in @self are not modifie the number of properties that were changed + line="3462">the number of properties that were changed a properties object + line="3453">a properties object a spa_dict that contains properties to add + line="3454">a spa_dict that contains properties to add @@ -7971,7 +8047,7 @@ Properties (keys) from @dict that are already contained in @self are not modifie introspectable="0"> Adds new properties in @self, using the given @props as a source. + line="3515">Adds new properties in @self, using the given @props as a source. Unlike wp_properties_add(), this function only adds properties that have one of the specified keys; the rest is left untouched. @@ -7979,32 +8055,32 @@ Unlike wp_properties_add(), this function only adds properties that have one of the number of properties that were changed + line="3528">the number of properties that were changed a properties set + line="3517">a properties set a properties set that contains properties to add + line="3518">a properties set that contains properties to add a property to add + line="3519">a property to add a list of additional properties to add, followed by NULL + line="3520">a list of additional properties to add, followed by NULL @@ -8013,31 +8089,31 @@ Unlike wp_properties_add(), this function only adds properties that have one of c:identifier="wp_properties_add_keys_array"> The same as wp_properties_add_keys(), using a NULL-terminated array for specifying the keys to add. + line="3549">The same as wp_properties_add_keys(), using a NULL-terminated array for specifying the keys to add. the number of properties that were changed + line="3560">the number of properties that were changed a properties set + line="3551">a properties set a properties set that contains properties to add + line="3552">a properties set that contains properties to add the properties to add + line="3553">the properties to add @@ -8049,7 +8125,7 @@ Unlike wp_properties_add(), this function only adds properties that have one of introspectable="0"> Adds new properties in @self, using the given @dict as a source. + line="3532">Adds new properties in @self, using the given @dict as a source. Unlike wp_properties_add_from_dict(), this function only adds properties that have one of the specified keys; the rest is left untouched. @@ -8057,14 +8133,14 @@ Unlike wp_properties_add_from_dict(), this function only adds properties that ha the number of properties that were changed + line="3545">the number of properties that were changed a properties set + line="3534">a properties set a spa_dict that contains properties to add + line="3535">a spa_dict that contains properties to add a property to add + line="3536">a property to add a list of additional properties to add, followed by NULL + line="3537">a list of additional properties to add, followed by NULL @@ -8093,19 +8169,19 @@ Unlike wp_properties_add_from_dict(), this function only adds properties that ha Constructs and returns a new WpProperties object that contains a copy of all the properties contained in @other. + line="3348">Constructs and returns a new WpProperties object that contains a copy of all the properties contained in @other. the newly constructed properties set + line="3357">the newly constructed properties set a properties object + line="3350">a properties object @@ -8114,7 +8190,7 @@ Unlike wp_properties_add_from_dict(), this function only adds properties that ha c:identifier="wp_properties_ensure_unique_owner"> Ensures that the given properties set is uniquely owned. + line="3373">Ensures that the given properties set is uniquely owned. "Uniquely owned" means that: @@ -8126,14 +8202,14 @@ If @self is not uniquely owned already, then it is unrefed and a copy of it is r the uniquely owned properties object + line="3387">the uniquely owned properties object a properties object + line="3375">a properties object @@ -8141,25 +8217,25 @@ If @self is not uniquely owned already, then it is unrefed and a copy of it is r Looks up a given property value from a key. + line="3564">Looks up a given property value from a key. the value of the property identified with @key, or NULL if this property is not contained in @self + line="3574">the value of the property identified with @key, or NULL if this property is not contained in @self a properties object + line="3566">a properties object a property key + line="3567">a property key @@ -8169,19 +8245,19 @@ If @self is not uniquely owned already, then it is unrefed and a copy of it is r version="0.4.10"> Gets the number of properties contained in this object. + line="3699">Gets the number of properties contained in this object. the number of properties contained in this object + line="3708">the number of properties contained in this object a properties object + line="3701">a properties object @@ -8189,7 +8265,7 @@ If @self is not uniquely owned already, then it is unrefed and a copy of it is r Checks if all property values contained in @other are matching with the values in @self. + line="3766">Checks if all property values contained in @other are matching with the values in @self. If a property is contained in @other and not in @self, the result is not matched. If a property is contained in both sets, then the value of the property in @other is interpreted as a glob-style pattern (using g_pattern_match_simple()) and the value in @self is checked to see if it matches with this pattern. @@ -8197,20 +8273,20 @@ If a property is contained in @other and not in @self, the result is not matched TRUE if all matches were successfull, FALSE if at least one property value did not match + line="3777">TRUE if all matches were successfull, FALSE if at least one property value did not match a properties object + line="3768">a properties object a set of properties to match + line="3769">a set of properties to match @@ -8218,19 +8294,19 @@ If a property is contained in @other and not in @self, the result is not matched Iterates through all the properties in the properties object. + line="3686">Iterates through all the properties in the properties object. an iterator that iterates over the properties. The items in the iterator are of type WpPropertiesItem. Use wp_properties_item_get_key() and wp_properties_item_get_value() to retrieve their contents. + line="3695">an iterator that iterates over the properties. The items in the iterator are of type WpPropertiesItem. Use wp_properties_item_get_key() and wp_properties_item_get_value() to retrieve their contents. a properties object + line="3688">a properties object @@ -8238,19 +8314,19 @@ If a property is contained in @other and not in @self, the result is not matched Gets the dictionary wrapped by a properties object. + line="3726">Gets the dictionary wrapped by a properties object. the internal properties set as a struct spa_dict * + line="3735">the internal properties set as a struct spa_dict * a properties object + line="3728">a properties object @@ -8269,7 +8345,7 @@ If a property is contained in @other and not in @self, the result is not matched Sets the given property @key - @value pair on @self. + line="3578">Sets the given property @key - @value pair on @self. If the property already existed, the value is overwritten with the new one. @@ -8278,20 +8354,20 @@ If the @value is NULL, then the specified property is removed from @self 1 if the property was changed. 0 if nothing was changed because the property already existed with the same value or because the key to remove did not exist. + line="3591">1 if the property was changed. 0 if nothing was changed because the property already existed with the same value or because the key to remove did not exist. a properties object + line="3580">a properties object a property key + line="3581">a property key allow-none="1"> a property value + line="3582">a property value @@ -8308,37 +8384,37 @@ If the @value is NULL, then the specified property is removed from @self Formats the given @format string with the specified arguments and sets the result as a value of the property specified with @key. + line="3595">Formats the given @format string with the specified arguments and sets the result as a value of the property specified with @key. 1 if the property was changed. 0 if nothing was changed because the property already existed with the same value + line="3607">1 if the property was changed. 0 if nothing was changed because the property already existed with the same value a properties object + line="3597">a properties object a property key + line="3598">a property key a printf-style format to be formatted and set as a value for this property @key + line="3599">a printf-style format to be formatted and set as a value for this property @key arguments for @format + line="3600">arguments for @format @@ -8348,37 +8424,37 @@ If the @value is NULL, then the specified property is removed from @self introspectable="0"> This is the va_list version of wp_properties_setf() + line="3611">This is the va_list version of wp_properties_setf() 1 if the property was changed. 0 if nothing was changed because the property already existed with the same value + line="3623">1 if the property was changed. 0 if nothing was changed because the property already existed with the same value a properties object + line="3613">a properties object a property key + line="3614">a property key a printf-style format to be formatted and set as a value for this property @key + line="3615">a printf-style format to be formatted and set as a value for this property @key the variable arguments passed to wp_properties_setf() + line="3616">the variable arguments passed to wp_properties_setf() @@ -8386,7 +8462,7 @@ If the @value is NULL, then the specified property is removed from @self Sorts the keys in alphabetical order. + line="3714">Sorts the keys in alphabetical order. @@ -8395,7 +8471,7 @@ If the @value is NULL, then the specified property is removed from @self a properties object + line="3716">a properties object @@ -8404,19 +8480,19 @@ If the @value is NULL, then the specified property is removed from @self c:identifier="wp_properties_to_pw_properties"> Gets a copy of the properties object as a struct pw_properties + line="3739">Gets a copy of the properties object as a struct pw_properties a copy of the properties in @self as a struct pw_properties + line="3748">a copy of the properties in @self as a struct pw_properties a properties object + line="3741">a properties object @@ -8424,7 +8500,7 @@ If the @value is NULL, then the specified property is removed from @self Decreases the reference count on @self and frees it when the ref count reaches zero. + line="3361">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -8433,7 +8509,7 @@ If the @value is NULL, then the specified property is removed from @self a properties object + line="3363">a properties object @@ -8442,7 +8518,7 @@ If the @value is NULL, then the specified property is removed from @self c:identifier="wp_properties_unref_and_take_pw_properties"> Similar to wp_properties_to_pw_properties(), but this method avoids making a copy of the properties by returning the struct pw_properties that is stored internally and then freeing the WpProperties wrapper. + line="3752">Similar to wp_properties_to_pw_properties(), but this method avoids making a copy of the properties by returning the struct pw_properties that is stored internally and then freeing the WpProperties wrapper. If @self is not uniquely owned (see wp_properties_ensure_unique_owner()), then this method does make a copy and is the same as wp_properties_to_pw_properties(), performance-wise. @@ -8450,14 +8526,14 @@ If @self is not uniquely owned (see wp_properties_ensure_unique_owner()), then t the properties in @self as a struct pw_properties + line="3762">the properties in @self as a struct pw_properties a properties object + line="3754">a properties object @@ -8465,7 +8541,7 @@ If @self is not uniquely owned (see wp_properties_ensure_unique_owner()), then t Updates (adds new or modifies existing) properties in @self, using the given @props as a source. + line="3391">Updates (adds new or modifies existing) properties in @self, using the given @props as a source. Any properties that are not contained in @props are left untouched. @@ -8473,20 +8549,20 @@ Any properties that are not contained in @props are left untouched. the number of properties that were changed + line="3402">the number of properties that were changed a properties object + line="3393">a properties object a properties set that contains properties to update + line="3394">a properties set that contains properties to update @@ -8495,7 +8571,7 @@ Any properties that are not contained in @props are left untouched. c:identifier="wp_properties_update_from_dict"> Updates (adds new or modifies existing) properties in @self, using the given @dict as a source. + line="3406">Updates (adds new or modifies existing) properties in @self, using the given @dict as a source. Any properties that are not contained in @dict are left untouched. @@ -8503,14 +8579,14 @@ Any properties that are not contained in @dict are left untouched. the number of properties that were changed + line="3417">the number of properties that were changed a properties object + line="3408">a properties object allow-none="1"> a spa_dict that contains properties to update + line="3409">a spa_dict that contains properties to update @@ -8528,7 +8604,7 @@ Any properties that are not contained in @dict are left untouched. c:identifier="wp_properties_update_from_json"> Updates (adds new or modifies existing) properties in @self, using the given @json as a source. + line="3421">Updates (adds new or modifies existing) properties in @self, using the given @json as a source. Any properties that are not contained in @json are left untouched. @@ -8536,20 +8612,20 @@ Any properties that are not contained in @json are left untouched. the number of properties that were changed + line="3432">the number of properties that were changed a properties object + line="3423">a properties object a JSON object that contains properties to update + line="3424">a JSON object that contains properties to update @@ -8559,7 +8635,7 @@ Any properties that are not contained in @json are left untouched. introspectable="0"> Updates (adds new or modifies existing) properties in @self, using the given @props as a source. + line="3466">Updates (adds new or modifies existing) properties in @self, using the given @props as a source. Unlike wp_properties_update(), this function only updates properties that have one of the specified keys; the rest is left untouched. @@ -8567,32 +8643,32 @@ Unlike wp_properties_update(), this function only updates properties that have o the number of properties that were changed + line="3479">the number of properties that were changed a properties set + line="3468">a properties set a properties set that contains properties to update + line="3469">a properties set that contains properties to update a property to update + line="3470">a property to update a list of additional properties to update, followed by NULL + line="3471">a list of additional properties to update, followed by NULL @@ -8601,31 +8677,31 @@ Unlike wp_properties_update(), this function only updates properties that have o c:identifier="wp_properties_update_keys_array"> The same as wp_properties_update_keys(), using a NULL-terminated array for specifying the keys to update. + line="3500">The same as wp_properties_update_keys(), using a NULL-terminated array for specifying the keys to update. the number of properties that were changed + line="3511">the number of properties that were changed a properties set + line="3502">a properties set a properties set that contains properties to update + line="3503">a properties set that contains properties to update the properties to update + line="3504">the properties to update @@ -8637,7 +8713,7 @@ Unlike wp_properties_update(), this function only updates properties that have o introspectable="0"> Updates (adds new or modifies existing) properties in @self, using the given @dict as a source. + line="3483">Updates (adds new or modifies existing) properties in @self, using the given @dict as a source. Unlike wp_properties_update_from_dict(), this function only updates properties that have one of the specified keys; the rest is left untouched. @@ -8645,14 +8721,14 @@ Unlike wp_properties_update_from_dict(), this function only updates properties t the number of properties that were changed + line="3496">the number of properties that were changed a properties set + line="3485">a properties set a spa_dict that contains properties to update + line="3486">a spa_dict that contains properties to update a property to update + line="3487">a property to update a list of additional properties to update, followed by NULL + line="3488">a list of additional properties to update, followed by NULL @@ -8691,19 +8767,19 @@ Unlike wp_properties_update_from_dict(), this function only updates properties t version="0.4.2"> Gets the key from a properties item. + line="3656">Gets the key from a properties item. the property key of the @item + line="3665">the property key of the @item the item held by the GValue that was returned from the WpIterator of wp_properties_new_iterator() + line="3658">the item held by the GValue that was returned from the WpIterator of wp_properties_new_iterator() @@ -8713,19 +8789,19 @@ Unlike wp_properties_update_from_dict(), this function only updates properties t version="0.4.2"> Gets the value from a properties item. + line="3671">Gets the value from a properties item. the property value of the @item + line="3680">the property value of the @item the item held by the GValue that was returned from the WpIterator of wp_properties_new_iterator() + line="3673">the item held by the GValue that was returned from the WpIterator of wp_properties_new_iterator() @@ -8733,19 +8809,19 @@ Unlike wp_properties_update_from_dict(), this function only updates properties t Increases the reference count of a properties item object. + line="3627">Increases the reference count of a properties item object. @self with an additional reference count on it + line="3636">@self with an additional reference count on it a properties item object + line="3629">a properties item object @@ -8755,7 +8831,7 @@ Unlike wp_properties_update_from_dict(), this function only updates properties t version="0.4.2"> Decreases the reference count on @self and frees it when the ref count reaches zero. + line="3642">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -8764,7 +8840,7 @@ Unlike wp_properties_update_from_dict(), this function only updates properties t a properties item object + line="3644">a properties item object @@ -8850,7 +8926,7 @@ This base class cannot be instantiated. It provides handling of pw_proxy's event glib:get-property="bound-id"> Returns the proxy bound id. + line="3936">Returns the proxy bound id. The bound id is the id that this object has on the PipeWire registry (a.k.a. the global id). The object must have the WP_PROXY_FEATURE_BOUND feature before this method can be called. @@ -8859,14 +8935,14 @@ Requires WP_PROXY_FEATURE_BOUND the bound id of this object + line="3949">the bound id of this object the proxy + line="3938">the proxy @@ -8875,19 +8951,19 @@ Requires WP_PROXY_FEATURE_BOUND c:identifier="wp_proxy_get_interface_type"> Gets the interface type of the proxied object. + line="3953">Gets the interface type of the proxied object. the PipeWire type of the interface that is being proxied + line="3963">the PipeWire type of the interface that is being proxied the proxy + line="3955">the proxy allow-none="1"> the version of the interface + line="3956">the version of the interface @@ -8908,19 +8984,19 @@ Requires WP_PROXY_FEATURE_BOUND glib:get-property="pw-proxy"> Gets the pw_proxy wrapped by this proxy object. + line="3967">Gets the pw_proxy wrapped by this proxy object. a pointer to the underlying pw_proxy object + line="3976">a pointer to the underlying pw_proxy object the proxy + line="3969">the proxy @@ -8928,7 +9004,7 @@ Requires WP_PROXY_FEATURE_BOUND Private method to be used by subclasses to set the pw_proxy pointer when it is available. + line="3980">Private method to be used by subclasses to set the pw_proxy pointer when it is available. This can be called only if there is no pw_proxy already set. Takes ownership of @proxy. @@ -9192,8 +9268,8 @@ This can be called only if there is no pw_proxy already set. Takes ownership of c:type="WP_SPA_TYPE_INVALID"> Type id representing an invalid SPA type. - + line="7858">Type id representing an invalid SPA type. + Helper callback for sub-classes that deffers and unexports the session item. + line="4137">Helper callback for sub-classes that deffers and unexports the session item. Only meant to be used when the pipewire proxy destroyed signal is triggered. @@ -9225,13 +9301,13 @@ Only meant to be used when the pipewire proxy destroyed signal is triggered. the proxy that was destroyed by the server + line="4139">the proxy that was destroyed by the server the associated session item + line="4140">the associated session item @@ -9239,25 +9315,25 @@ Only meant to be used when the pipewire proxy destroyed signal is triggered. Finds the factory associated with the given @name from the @core and uses it to construct a new WpSessionItem. + line="4568">Finds the factory associated with the given @name from the @core and uses it to construct a new WpSessionItem. the new session item + line="4578">the new session item the WpCore + line="4570">the WpCore the name of the factory to be used for constructing the object + line="4571">the name of the factory to be used for constructing the object @@ -9265,25 +9341,25 @@ Only meant to be used when the pipewire proxy destroyed signal is triggered. Configures the session item with a set of properties. + line="4017">Configures the session item with a set of properties. TRUE on success, FALSE if the item could not be configured + line="4027">TRUE on success, FALSE if the item could not be configured the session item + line="4019">the session item the properties used to configure the item + line="4020">the properties used to configure the item @@ -9355,7 +9431,7 @@ Only meant to be used when the pipewire proxy destroyed signal is triggered. Resets the session item. + line="4004">Resets the session item. This essentially removes the configuration and deactivates all active features. @@ -9367,7 +9443,7 @@ This essentially removes the configuration and deactivates all active features.< the session item + line="4006">the session item @@ -9375,25 +9451,25 @@ This essentially removes the configuration and deactivates all active features.< Configures the session item with a set of properties. + line="4017">Configures the session item with a set of properties. TRUE on success, FALSE if the item could not be configured + line="4027">TRUE on success, FALSE if the item could not be configured the session item + line="4019">the session item the properties used to configure the item + line="4020">the properties used to configure the item @@ -9402,25 +9478,25 @@ This essentially removes the configuration and deactivates all active features.< c:identifier="wp_session_item_get_associated_proxy"> An associated proxy is a WpProxy subclass instance that is somehow related to this item. + line="4044">An associated proxy is a WpProxy subclass instance that is somehow related to this item. the associated proxy of the specified @proxy_type, or NULL if there is no association to such a proxy + line="4054">the associated proxy of the specified @proxy_type, or NULL if there is no association to such a proxy the session item + line="4046">the session item a WpProxy subclass GType + line="4047">a WpProxy subclass GType @@ -9429,25 +9505,25 @@ This essentially removes the configuration and deactivates all active features.< c:identifier="wp_session_item_get_associated_proxy_id"> Gets the bound id of a proxy associated with the session item. + line="4058">Gets the bound id of a proxy associated with the session item. the bound id of the associated proxy of the specified @proxy_type, or SPA_ID_INVALID if there is no association to such a proxy + line="4068">the bound id of the associated proxy of the specified @proxy_type, or SPA_ID_INVALID if there is no association to such a proxy the session item + line="4060">the session item a WpProxy subclass GType + line="4061">a WpProxy subclass GType @@ -9457,19 +9533,19 @@ This essentially removes the configuration and deactivates all active features.< glib:get-property="properties"> Gets the properties of a session item. + line="4096">Gets the properties of a session item. the item's properties. + line="4105">the item's properties. the session item + line="4098">the session item @@ -9477,25 +9553,25 @@ This essentially removes the configuration and deactivates all active features.< Looks up a named session item property value for a given key. + line="4109">Looks up a named session item property value for a given key. the item property value for the given key. + line="4119">the item property value for the given key. the session item + line="4111">the session item the property key + line="4112">the property key @@ -9504,19 +9580,19 @@ This essentially removes the configuration and deactivates all active features.< c:identifier="wp_session_item_is_configured"> Checks if the session item is configured. + line="4031">Checks if the session item is configured. TRUE if the item is configured, FALSE otherwise + line="4040">TRUE if the item is configured, FALSE otherwise the session item + line="4033">the session item @@ -9524,7 +9600,7 @@ This essentially removes the configuration and deactivates all active features.< Registers the session item to its associated core. + line="4072">Registers the session item to its associated core. @@ -9533,7 +9609,7 @@ This essentially removes the configuration and deactivates all active features.< the session item + line="4074">the session item @@ -9541,7 +9617,7 @@ This essentially removes the configuration and deactivates all active features.< Removes the session item from its associated core. + line="4084">Removes the session item from its associated core. @@ -9550,7 +9626,7 @@ This essentially removes the configuration and deactivates all active features.< the session item + line="4086">the session item @@ -9558,7 +9634,7 @@ This essentially removes the configuration and deactivates all active features.< Resets the session item. + line="4004">Resets the session item. This essentially removes the configuration and deactivates all active features. @@ -9570,7 +9646,7 @@ This essentially removes the configuration and deactivates all active features.< the session item + line="4006">the session item @@ -9579,7 +9655,7 @@ This essentially removes the configuration and deactivates all active features.< c:identifier="wp_session_item_set_properties"> Sets the item's properties. + line="4123">Sets the item's properties. This should only be done by sub-classes after the configuration has been done. @@ -9591,13 +9667,13 @@ This should only be done by sub-classes after the configuration has been done. the session item + line="4125">the session item the new properties to set + line="4126">the new properties to set @@ -9628,7 +9704,7 @@ This should only be done by sub-classes after the configuration has been done. the session item + line="4006">the session item @@ -9640,20 +9716,20 @@ This should only be done by sub-classes after the configuration has been done. TRUE on success, FALSE if the item could not be configured + line="4027">TRUE on success, FALSE if the item could not be configured the session item + line="4019">the session item the properties used to configure the item + line="4020">the properties used to configure the item @@ -9771,19 +9847,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Creates a new WpSettings object. + line="4306">Creates a new WpSettings object. a new WpSettings object + line="4316">a new WpSettings object the WpCore + line="4308">the WpCore the name of the metadata object to associate with the settings object; NULL means the default "sm-settings" + line="4309">the name of the metadata object to associate with the settings object; NULL means the default "sm-settings" @@ -9800,19 +9876,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Finds a registered WpSettings object by its metadata name. + line="4320">Finds a registered WpSettings object by its metadata name. the WpSettings object, or NULL if not found + line="4330">the WpSettings object, or NULL if not found the WpCore + line="4322">the WpCore the name of the metadata object that the settings object is associated with; NULL means the default "sm-settings" + line="4323">the name of the metadata object that the settings object is associated with; NULL means the default "sm-settings" @@ -9829,25 +9905,25 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Deletes a saved setting to not make it persistent after reboot. + line="4464">Deletes a saved setting to not make it persistent after reboot. TRUE if the setting could be deleted, FALSE otherwise + line="4474">TRUE if the setting could be deleted, FALSE otherwise the settings object + line="4466">the settings object the name of the saved setting to be deleted + line="4467">the name of the saved setting to be deleted @@ -9855,7 +9931,7 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Deletes all saved setting to not make them persistent after reboot. + line="4502">Deletes all saved setting to not make them persistent after reboot. @@ -9864,7 +9940,7 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. the settings object + line="4504">the settings object @@ -9872,25 +9948,25 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Gets the WpSpaJson value of a setting. + line="4379">Gets the WpSpaJson value of a setting. The WpSpaJson value of the setting, or NULL if the setting does not exist + line="4389">The WpSpaJson value of the setting, or NULL if the setting does not exist the settings object + line="4381">the settings object the name of the setting + line="4382">the name of the setting @@ -9898,25 +9974,25 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Gets the WpSpaJson saved value of a setting. + line="4393">Gets the WpSpaJson saved value of a setting. The WpSpaJson saved value of the setting, or NULL if the setting does not exist + line="4403">The WpSpaJson saved value of the setting, or NULL if the setting does not exist the settings object + line="4395">the settings object the name of the setting + line="4396">the name of the setting @@ -9924,25 +10000,25 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Gets the specification of a setting. + line="4407">Gets the specification of a setting. the specification of the setting + line="4417">the specification of the setting the settings object + line="4409">the settings object the name of the setting + line="4410">the name of the setting @@ -9950,19 +10026,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Iterates over settings. + line="4514">Iterates over settings. an iterator that iterates over the settings. + line="4523">an iterator that iterates over the settings. the settings object + line="4516">the settings object @@ -9970,25 +10046,25 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Resets the setting to its default value. + line="4436">Resets the setting to its default value. TRUE if the setting could be reset, FALSE otherwise + line="4446">TRUE if the setting could be reset, FALSE otherwise the settings object + line="4438">the settings object the name of the setting to reset + line="4439">the name of the setting to reset @@ -9996,7 +10072,7 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Resets all the settings to their default value. + line="4478">Resets all the settings to their default value. @@ -10005,7 +10081,7 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. the settings object + line="4480">the settings object @@ -10013,25 +10089,25 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Saves a setting to make it persistent after reboot. + line="4450">Saves a setting to make it persistent after reboot. TRUE if the setting could be saved, FALSE otherwise + line="4460">TRUE if the setting could be saved, FALSE otherwise the settings object + line="4452">the settings object the name of the setting to be saved + line="4453">the name of the setting to be saved @@ -10039,7 +10115,7 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Saves all the settings to make them persistent after reboot. + line="4490">Saves all the settings to make them persistent after reboot. @@ -10048,7 +10124,7 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. the settings object + line="4492">the settings object @@ -10056,31 +10132,31 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Sets a new setting value. + line="4421">Sets a new setting value. TRUE if the setting could be set, FALSE otherwise + line="4432">TRUE if the setting could be set, FALSE otherwise the settings object + line="4423">the settings object the name of the setting + line="4424">the name of the setting the JSON value of the setting + line="4425">the JSON value of the setting @@ -10088,25 +10164,25 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Subscribes callback for a given setting pattern(a glob-style pattern matched using g_pattern_match_simple), this allows clients to look for any changes made in settings through metadata. + line="4334">Subscribes callback for a given setting pattern(a glob-style pattern matched using g_pattern_match_simple), this allows clients to look for any changes made in settings through metadata. the subscription ID (always greater than 0 for successful subscriptions) + line="4346">the subscription ID (always greater than 0 for successful subscriptions) the settings object + line="4336">the settings object name of the pattern to match the settings with + line="4337">name of the pattern to match the settings with the callback triggered when the settings change. + line="4338">the callback triggered when the settings change. @@ -10125,7 +10201,7 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. data to pass to @callback + line="4339">data to pass to @callback @@ -10134,25 +10210,25 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Subscribes callback for a given setting pattern(a glob-style pattern matched using g_pattern_match_simple), this allows clients to look for any changes made in settings through metadata. + line="4350">Subscribes callback for a given setting pattern(a glob-style pattern matched using g_pattern_match_simple), this allows clients to look for any changes made in settings through metadata. the subscription ID (always greater than 0 for success) + line="4361">the subscription ID (always greater than 0 for success) the settings object + line="4352">the settings object name of the pattern to match the settings with + line="4353">name of the pattern to match the settings with a GAsyncReadyCallback wrapped in a GClosure + line="4354">a GAsyncReadyCallback wrapped in a GClosure @@ -10169,25 +10245,25 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Unsubscribes callback for a given subscription_id. + line="4365">Unsubscribes callback for a given subscription_id. TRUE if success, FALSE otherwise + line="4375">TRUE if success, FALSE otherwise the settings object + line="4367">the settings object identifies the callback + line="4368">identifies the callback @@ -10257,19 +10333,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Gets the key from a settings item. + line="4280">Gets the key from a settings item. the settings key of the @item + line="4289">the settings key of the @item the item held by the GValue that was returned from the WpIterator of wp_settings_new_iterator() + line="4282">the item held by the GValue that was returned from the WpIterator of wp_settings_new_iterator() @@ -10277,19 +10353,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Gets the value from a settings item. + line="4293">Gets the value from a settings item. the settings value of the @item + line="4302">the settings value of the @item the item held by the GValue that was returned from the WpIterator of wp_settings_new_iterator() + line="4295">the item held by the GValue that was returned from the WpIterator of wp_settings_new_iterator() @@ -10297,19 +10373,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Increases the reference count of a settings item object. + line="4255">Increases the reference count of a settings item object. @self with an additional reference count on it + line="4264">@self with an additional reference count on it a settings item object + line="4257">a settings item object @@ -10317,7 +10393,7 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Decreases the reference count on @self and frees it when the ref count reaches zero. + line="4268">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -10326,7 +10402,7 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. a settings item object + line="4270">a settings item object @@ -10345,25 +10421,25 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Checks whether a value is compatible with the spec or not. + line="4241">Checks whether a value is compatible with the spec or not. TRUE if the value is compatible with the spec, FALSE otherwise + line="4251">TRUE if the value is compatible with the spec, FALSE otherwise the settings spec object + line="4243">the settings spec object the value to check + line="4244">the value to check @@ -10372,19 +10448,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Gets the default value of a settings spec. + line="4202">Gets the default value of a settings spec. the default value of the settings spec + line="4211">the default value of the settings spec the settings spec object + line="4204">the settings spec object @@ -10393,19 +10469,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Gets the description of a settings spec. + line="4176">Gets the description of a settings spec. the description of the settings spec + line="4185">the description of the settings spec the settings spec object + line="4178">the settings spec object @@ -10414,19 +10490,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Gets the maximum value of a settings spec. + line="4228">Gets the maximum value of a settings spec. the maximum value of the settings spec, or NULL if the spec type is not WP_SETTINGS_SPEC_TYPE_INT or WP_SETTINGS_SPEC_TYPE_FLOAT + line="4237">the maximum value of the settings spec, or NULL if the spec type is not WP_SETTINGS_SPEC_TYPE_INT or WP_SETTINGS_SPEC_TYPE_FLOAT the settings spec object + line="4230">the settings spec object @@ -10435,19 +10511,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Gets the minimum value of a settings spec. + line="4215">Gets the minimum value of a settings spec. the minimum value of the settings spec, or NULL if the spec type is not WP_SETTINGS_SPEC_TYPE_INT or WP_SETTINGS_SPEC_TYPE_FLOAT + line="4224">the minimum value of the settings spec, or NULL if the spec type is not WP_SETTINGS_SPEC_TYPE_INT or WP_SETTINGS_SPEC_TYPE_FLOAT the settings spec object + line="4217">the settings spec object @@ -10456,19 +10532,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Gets the type of a settings spec. + line="4189">Gets the type of a settings spec. the type of the settings spec + line="4198">the type of the settings spec the settings spec object + line="4191">the settings spec object @@ -10476,19 +10552,19 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Increases the reference count of a settings spec object. + line="4151">Increases the reference count of a settings spec object. @self with an additional reference count on it + line="4160">@self with an additional reference count on it a settings spec object + line="4153">a settings spec object @@ -10496,7 +10572,7 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. Decreases the reference count on @self and frees it when the ref count reaches zero. + line="4164">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -10505,7 +10581,7 @@ Being a WpObject subclass, the settings inherits WpObject's activation system. a settings spec object + line="4166">a settings spec object @@ -10575,7 +10651,7 @@ A WpSiAcquisition is associated directly with a WpSiLinkable via wp_si_linkable_ glib:finish-func="acquire_finish"> Acquires the @item for linking by @acquisitor. + line="4749">Acquires the @item for linking by @acquisitor. When a link is not allowed by policy, this operation should return an error. @@ -10588,19 +10664,19 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade the session item + line="4751">the session item the link that is trying to acquire a port info item + line="4752">the link that is trying to acquire a port info item the item that is being acquired + line="4753">the item that is being acquired the callback to call when the operation is done + line="4754">the callback to call when the operation is done user data for @callback + line="4755">user data for @callback @@ -10630,25 +10706,25 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade throws="1"> Finishes the operation started by wp_si_acquisition_acquire(). This is meant to be called in the callback that was passed to that method. + line="4767">Finishes the operation started by wp_si_acquisition_acquire(). This is meant to be called in the callback that was passed to that method. TRUE on success, FALSE if there was an error + line="4778">TRUE on success, FALSE if there was an error the session item + line="4769">the session item the async result + line="4770">the async result @@ -10656,7 +10732,7 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade Releases the @item, which means that it is being unlinked. + line="4782">Releases the @item, which means that it is being unlinked. @@ -10665,19 +10741,19 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade the session item + line="4784">the session item the link that had previously acquired the item + line="4785">the link that had previously acquired the item the port info that is being released + line="4786">the port info that is being released @@ -10687,7 +10763,7 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade glib:finish-func="acquire_finish"> Acquires the @item for linking by @acquisitor. + line="4749">Acquires the @item for linking by @acquisitor. When a link is not allowed by policy, this operation should return an error. @@ -10700,19 +10776,19 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade the session item + line="4751">the session item the link that is trying to acquire a port info item + line="4752">the link that is trying to acquire a port info item the item that is being acquired + line="4753">the item that is being acquired the callback to call when the operation is done + line="4754">the callback to call when the operation is done user data for @callback + line="4755">user data for @callback @@ -10742,25 +10818,25 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade throws="1"> Finishes the operation started by wp_si_acquisition_acquire(). This is meant to be called in the callback that was passed to that method. + line="4767">Finishes the operation started by wp_si_acquisition_acquire(). This is meant to be called in the callback that was passed to that method. TRUE on success, FALSE if there was an error + line="4778">TRUE on success, FALSE if there was an error the session item + line="4769">the session item the async result + line="4770">the async result @@ -10768,7 +10844,7 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade Releases the @item, which means that it is being unlinked. + line="4782">Releases the @item, which means that it is being unlinked. @@ -10777,19 +10853,19 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade the session item + line="4784">the session item the link that had previously acquired the item + line="4785">the link that had previously acquired the item the port info that is being released + line="4786">the port info that is being released @@ -10812,19 +10888,19 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade the session item + line="4751">the session item the link that is trying to acquire a port info item + line="4752">the link that is trying to acquire a port info item the item that is being acquired + line="4753">the item that is being acquired the callback to call when the operation is done + line="4754">the callback to call when the operation is done @@ -10845,7 +10921,7 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade allow-none="1"> user data for @callback + line="4755">user data for @callback @@ -10857,20 +10933,20 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade TRUE on success, FALSE if there was an error + line="4778">TRUE on success, FALSE if there was an error the session item + line="4769">the session item the async result + line="4770">the async result @@ -10886,19 +10962,19 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade the session item + line="4784">the session item the link that had previously acquired the item + line="4785">the link that had previously acquired the item the port info that is being released + line="4786">the port info that is being released @@ -10924,19 +11000,19 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade Gets the format used to configure the adapter session item's ports. + line="4611">Gets the format used to configure the adapter session item's ports. The format used to configure the ports of the adapter session item. Some items automatically choose a format when being activated, others never set a format on activation and the user needs to manually set it externally with wp_si_adapter_set_ports_format(). + line="4621">The format used to configure the ports of the adapter session item. Some items automatically choose a format when being activated, others never set a format on activation and the user needs to manually set it externally with wp_si_adapter_set_ports_format(). the session item + line="4613">the session item the mode + line="4614">the mode @@ -10956,19 +11032,19 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade version="0.4.10"> Gets the ports state. + line="4596">Gets the ports state. The state of the ports + line="4605">The state of the ports the session item + line="4598">the session item @@ -10978,7 +11054,7 @@ When a link needs to be delayed for a short amount of time (ex. to apply a fade glib:finish-func="set_ports_format_finish"> Sets the format and configures the adapter session item ports using the given format. + line="4625">Sets the format and configures the adapter session item ports using the given format. The result of the operation can be checked using the wp_si_adapter_set_ports_format_finish() API. If format is NULL, the adapter will be configured with the default format. If mode is NULL, the adapter will use "dsp" mode. @@ -10990,7 +11066,7 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for the session item + line="4627">the session item the format to be set + line="4628">the format to be set the mode + line="4629">the mode the callback to call when the operation is done + line="4630">the callback to call when the operation is done user data for @callback + line="4631">user data for @callback @@ -11038,25 +11114,25 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for throws="1"> Finishes the operation started by wp_si_adapter_set_format(). This is meant to be called in the callback that was passed to that method. + line="4642">Finishes the operation started by wp_si_adapter_set_format(). This is meant to be called in the callback that was passed to that method. TRUE on success, FALSE if there was an error + line="4653">TRUE on success, FALSE if there was an error the session item + line="4644">the session item the async result + line="4645">the async result @@ -11065,19 +11141,19 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for c:identifier="wp_si_adapter_get_ports_format"> Gets the format used to configure the adapter session item's ports. + line="4611">Gets the format used to configure the adapter session item's ports. The format used to configure the ports of the adapter session item. Some items automatically choose a format when being activated, others never set a format on activation and the user needs to manually set it externally with wp_si_adapter_set_ports_format(). + line="4621">The format used to configure the ports of the adapter session item. Some items automatically choose a format when being activated, others never set a format on activation and the user needs to manually set it externally with wp_si_adapter_set_ports_format(). the session item + line="4613">the session item the mode + line="4614">the mode @@ -11097,19 +11173,19 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for version="0.4.10"> Gets the ports state. + line="4596">Gets the ports state. The state of the ports + line="4605">The state of the ports the session item + line="4598">the session item @@ -11119,7 +11195,7 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for glib:finish-func="set_ports_format_finish"> Sets the format and configures the adapter session item ports using the given format. + line="4625">Sets the format and configures the adapter session item ports using the given format. The result of the operation can be checked using the wp_si_adapter_set_ports_format_finish() API. If format is NULL, the adapter will be configured with the default format. If mode is NULL, the adapter will use "dsp" mode. @@ -11131,7 +11207,7 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for the session item + line="4627">the session item the format to be set + line="4628">the format to be set the mode + line="4629">the mode the callback to call when the operation is done + line="4630">the callback to call when the operation is done user data for @callback + line="4631">user data for @callback @@ -11179,25 +11255,25 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for throws="1"> Finishes the operation started by wp_si_adapter_set_format(). This is meant to be called in the callback that was passed to that method. + line="4642">Finishes the operation started by wp_si_adapter_set_format(). This is meant to be called in the callback that was passed to that method. TRUE on success, FALSE if there was an error + line="4653">TRUE on success, FALSE if there was an error the session item + line="4644">the session item the async result + line="4645">the async result @@ -11229,14 +11305,14 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for The format used to configure the ports of the adapter session item. Some items automatically choose a format when being activated, others never set a format on activation and the user needs to manually set it externally with wp_si_adapter_set_ports_format(). + line="4621">The format used to configure the ports of the adapter session item. Some items automatically choose a format when being activated, others never set a format on activation and the user needs to manually set it externally with wp_si_adapter_set_ports_format(). the session item + line="4613">the session item the mode + line="4614">the mode @@ -11262,7 +11338,7 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for the session item + line="4627">the session item the format to be set + line="4628">the format to be set the mode + line="4629">the mode the callback to call when the operation is done + line="4630">the callback to call when the operation is done @@ -11301,7 +11377,7 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for allow-none="1"> user data for @callback + line="4631">user data for @callback @@ -11313,20 +11389,20 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for TRUE on success, FALSE if there was an error + line="4653">TRUE on success, FALSE if there was an error the session item + line="4644">the session item the async result + line="4645">the async result @@ -11338,14 +11414,14 @@ The result of the operation can be checked using the wp_si_adapter_set_ports_for The state of the ports + line="4605">The state of the ports the session item + line="4598">the session item @@ -11404,25 +11480,25 @@ And the most simple way to construct an item from a registered factory: Creates a simple factory that constructs objects of a given GType. + line="4582">Creates a simple factory that constructs objects of a given GType. the new factory + line="4592">the new factory the factory name; must be a static string! + line="4584">the factory name; must be a static string! the WpSessionItem subclass type to instantiate for constructing items + line="4585">the WpSessionItem subclass type to instantiate for constructing items @@ -11430,25 +11506,25 @@ And the most simple way to construct an item from a registered factory: Looks up a factory matching a name. + line="4554">Looks up a factory matching a name. the factory matching the lookup name + line="4564">the factory matching the lookup name the core + line="4556">the core the lookup name + line="4557">the lookup name @@ -11456,25 +11532,25 @@ And the most simple way to construct an item from a registered factory: Creates a new instance of the session item that is constructed by this factory. + line="4540">Creates a new instance of the session item that is constructed by this factory. a new session item instance + line="4550">a new session item instance the factory + line="4542">the factory the core + line="4543">the core @@ -11482,25 +11558,25 @@ And the most simple way to construct an item from a registered factory: Creates a new instance of the session item that is constructed by this factory. + line="4540">Creates a new instance of the session item that is constructed by this factory. a new session item instance + line="4550">a new session item instance the factory + line="4542">the factory the core + line="4543">the core @@ -11510,19 +11586,19 @@ And the most simple way to construct an item from a registered factory: glib:get-property="name"> Gets the name of the factory. + line="4527">Gets the name of the factory. the factory name + line="4536">the factory name the factory + line="4529">the factory @@ -11551,20 +11627,20 @@ And the most simple way to construct an item from a registered factory: a new session item instance + line="4550">a new session item instance the factory + line="4542">the factory the core + line="4543">the core @@ -11590,19 +11666,19 @@ And the most simple way to construct an item from a registered factory: Gets the input item linked by the link. + line="4736">Gets the input item linked by the link. the input item that is linked by this link + line="4745">the input item that is linked by this link the session item + line="4738">the session item @@ -11610,19 +11686,19 @@ And the most simple way to construct an item from a registered factory: Gets the output item linked by the link. + line="4723">Gets the output item linked by the link. the output item that is linked by this link + line="4732">the output item that is linked by this link the session item + line="4725">the session item @@ -11630,19 +11706,19 @@ And the most simple way to construct an item from a registered factory: Gets the properties of the link. + line="4710">Gets the properties of the link. the properties of the link + line="4719">the properties of the link the session item + line="4712">the session item @@ -11651,19 +11727,19 @@ And the most simple way to construct an item from a registered factory: invoker="get_registration_info"> This should return information that is used for registering the link, as a GVariant of type a{ss} that contains additional properties to be added to the list of global properties. + line="4697">This should return information that is used for registering the link, as a GVariant of type a{ss} that contains additional properties to be added to the list of global properties. registration info for the link + line="4706">registration info for the link the session item + line="4699">the session item @@ -11671,19 +11747,19 @@ And the most simple way to construct an item from a registered factory: Gets the input item linked by the link. + line="4736">Gets the input item linked by the link. the input item that is linked by this link + line="4745">the input item that is linked by this link the session item + line="4738">the session item @@ -11691,19 +11767,19 @@ And the most simple way to construct an item from a registered factory: Gets the output item linked by the link. + line="4723">Gets the output item linked by the link. the output item that is linked by this link + line="4732">the output item that is linked by this link the session item + line="4725">the session item @@ -11711,19 +11787,19 @@ And the most simple way to construct an item from a registered factory: Gets the properties of the link. + line="4710">Gets the properties of the link. the properties of the link + line="4719">the properties of the link the session item + line="4712">the session item @@ -11732,19 +11808,19 @@ And the most simple way to construct an item from a registered factory: c:identifier="wp_si_link_get_registration_info"> This should return information that is used for registering the link, as a GVariant of type a{ss} that contains additional properties to be added to the list of global properties. + line="4697">This should return information that is used for registering the link, as a GVariant of type a{ss} that contains additional properties to be added to the list of global properties. registration info for the link + line="4706">registration info for the link the session item + line="4699">the session item @@ -11768,14 +11844,14 @@ And the most simple way to construct an item from a registered factory: registration info for the link + line="4706">registration info for the link the session item + line="4699">the session item @@ -11787,14 +11863,14 @@ And the most simple way to construct an item from a registered factory: the properties of the link + line="4719">the properties of the link the session item + line="4712">the session item @@ -11806,14 +11882,14 @@ And the most simple way to construct an item from a registered factory: the output item that is linked by this link + line="4732">the output item that is linked by this link the session item + line="4725">the session item @@ -11825,14 +11901,14 @@ And the most simple way to construct an item from a registered factory: the input item that is linked by this link + line="4745">the input item that is linked by this link the session item + line="4738">the session item @@ -11858,19 +11934,19 @@ And the most simple way to construct an item from a registered factory: Gets the acquisition interface associated with the item. + line="4684">Gets the acquisition interface associated with the item. the acquisition interface associated with this item, or NULL if this item does not require acquiring items before linking them + line="4693">the acquisition interface associated with this item, or NULL if this item does not require acquiring items before linking them the session item + line="4686">the session item @@ -11878,7 +11954,7 @@ And the most simple way to construct an item from a registered factory: This method returns a variant of type "a(uuu)", where each tuple in the array contains the following information: + line="4657">This method returns a variant of type "a(uuu)", where each tuple in the array contains the following information: @@ -11898,14 +11974,14 @@ Contexts other than NULL may only be used internally to ease the implementation a GVariant containing information about the ports of this item + line="4680">a GVariant containing information about the ports of this item the session item + line="4659">the session item an optional context for the ports + line="4660">an optional context for the ports @@ -11923,19 +11999,19 @@ Contexts other than NULL may only be used internally to ease the implementation c:identifier="wp_si_linkable_get_acquisition"> Gets the acquisition interface associated with the item. + line="4684">Gets the acquisition interface associated with the item. the acquisition interface associated with this item, or NULL if this item does not require acquiring items before linking them + line="4693">the acquisition interface associated with this item, or NULL if this item does not require acquiring items before linking them the session item + line="4686">the session item @@ -11943,7 +12019,7 @@ Contexts other than NULL may only be used internally to ease the implementation This method returns a variant of type "a(uuu)", where each tuple in the array contains the following information: + line="4657">This method returns a variant of type "a(uuu)", where each tuple in the array contains the following information: @@ -11963,14 +12039,14 @@ Contexts other than NULL may only be used internally to ease the implementation a GVariant containing information about the ports of this item + line="4680">a GVariant containing information about the ports of this item the session item + line="4659">the session item an optional context for the ports + line="4660">an optional context for the ports @@ -11998,14 +12074,14 @@ Contexts other than NULL may only be used internally to ease the implementation a GVariant containing information about the ports of this item + line="4680">a GVariant containing information about the ports of this item the session item + line="4659">the session item an optional context for the ports + line="4660">an optional context for the ports @@ -12026,14 +12102,14 @@ Contexts other than NULL may only be used internally to ease the implementation the acquisition interface associated with this item, or NULL if this item does not require acquiring items before linking them + line="4693">the acquisition interface associated with this item, or NULL if this item does not require acquiring items before linking them the session item + line="4686">the session item @@ -12109,7 +12185,7 @@ For actual devices (not device monitors) it also possible and desirable to expor c:identifier="wp_spa_device_new_from_spa_factory"> Constructs a SPA_TYPE_INTERFACE_Device by loading the given SPA @factory_name. + line="1314">Constructs a SPA_TYPE_INTERFACE_Device by loading the given SPA @factory_name. To export this device to the PipeWire server, you need to call wp_object_activate() requesting WP_PROXY_FEATURE_BOUND and wait for the operation to complete. @@ -12117,20 +12193,20 @@ To export this device to the PipeWire server, you need to call wp_object_activat A new WpSpaDevice wrapping the device that was constructed by the factory, or NULL if the factory does not exist or was unable to construct the device + line="1326">A new WpSpaDevice wrapping the device that was constructed by the factory, or NULL if the factory does not exist or was unable to construct the device the wireplumber core + line="1316">the wireplumber core the name of the SPA factory + line="1317">the name of the SPA factory properties to be passed to device constructor + line="1318">properties to be passed to device constructor @@ -12147,19 +12223,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Constructs an SPA Device object from an existing device handle. + line="1299">Constructs an SPA Device object from an existing device handle. A new WpSpaDevice + line="1310">A new WpSpaDevice the wireplumber core + line="1301">the wireplumber core the spa device handle + line="1302">the spa device handle additional properties of the device + line="1303">additional properties of the device @@ -12186,25 +12262,25 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_device_get_managed_object"> Gets one of the objects managed by this device. + line="1358">Gets one of the objects managed by this device. the managed object associated with @id + line="1368">the managed object associated with @id the spa device + line="1360">the spa device the (device-internal) id of the object to get + line="1361">the (device-internal) id of the object to get @@ -12214,19 +12290,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat glib:get-property="properties"> Gets the properties of this device. + line="1330">Gets the properties of this device. the device properties + line="1339">the device properties the spa device + line="1332">the spa device @@ -12236,19 +12312,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat version="0.4.11"> Iterates through all the objects managed by this device. + line="1343">Iterates through all the objects managed by this device. a WpIterator that iterates over all the objects managed by this device + line="1352">a WpIterator that iterates over all the objects managed by this device the spa device + line="1345">the spa device @@ -12257,7 +12333,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_device_store_managed_object"> Stores or removes a managed object into/from a device. + line="1372">Stores or removes a managed object into/from a device. @@ -12266,13 +12342,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa device + line="1374">the spa device the (device-internal) id of the object + line="1375">the (device-internal) id of the object the object to store or NULL to remove the managed object associated with @id + line="1376">the object to store or NULL to remove the managed object associated with @id @@ -12361,12 +12437,12 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> Creates a spa json of type array. + line="5053">Creates a spa json of type array. The new spa json + line="5063">The new spa json @@ -12376,13 +12452,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat allow-none="1"> the first value format ("n", "b", "i", "f", "s" or "J") + line="5055">the first value format ("n", "b", "i", "f", "s" or "J") a list of array types and values, followed by NULL + line="5056">a list of array types and values, followed by NULL @@ -12392,12 +12468,12 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> This is the va_list version of wp_spa_json_new_array() + line="5067">This is the va_list version of wp_spa_json_new_array() The new spa json + line="5077">The new spa json @@ -12407,13 +12483,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat allow-none="1"> the first value format ("n", "b", "i", "f", "s" or "J") + line="5069">the first value format ("n", "b", "i", "f", "s" or "J") the variable arguments passed to wp_spa_json_new_array() + line="5070">the variable arguments passed to wp_spa_json_new_array() @@ -12421,19 +12497,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Creates a spa json of type boolean. + line="5001">Creates a spa json of type boolean. The new spa json + line="5010">The new spa json the boolean value + line="5003">the boolean value @@ -12441,19 +12517,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Creates a spa json of type float. + line="5027">Creates a spa json of type float. The new spa json + line="5036">The new spa json the float value + line="5029">the float value @@ -12463,19 +12539,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat version="0.5.0"> Constructs a new WpSpaJson from a JSON string. + line="4821">Constructs a new WpSpaJson from a JSON string. a new WpSpaJson; unlike the "wrap" variants, this function copies the data in @json_str, so it does not need to stay alive. + line="4830">a new WpSpaJson; unlike the "wrap" variants, this function copies the data in @json_str, so it does not need to stay alive. a JSON string + line="4823">a JSON string @@ -12485,25 +12561,25 @@ To export this device to the PipeWire server, you need to call wp_object_activat version="0.5.0"> Constructs a new WpSpaJson from a JSON string with specific length. + line="4836">Constructs a new WpSpaJson from a JSON string with specific length. a new WpSpaJson; unlike the "wrap" variants, this function copies the data in @json_str, so it does not need to stay alive. + line="4846">a new WpSpaJson; unlike the "wrap" variants, this function copies the data in @json_str, so it does not need to stay alive. a JSON string + line="4838">a JSON string the specific length of the string + line="4839">the specific length of the string @@ -12511,19 +12587,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Creates a spa json of type int. + line="5014">Creates a spa json of type int. The new spa json + line="5023">The new spa json the int value + line="5016">the int value @@ -12531,12 +12607,12 @@ To export this device to the PipeWire server, you need to call wp_object_activat Creates a spa json of type NULL. + line="4989">Creates a spa json of type NULL. The new spa json + line="4997">The new spa json @@ -12545,12 +12621,12 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> Creates a spa json of type object. + line="5081">Creates a spa json of type object. The new spa json + line="5092">The new spa json @@ -12560,7 +12636,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat allow-none="1"> the first object property key + line="5083">the first object property key the first property format ("n", "b", "i", "f", "s" or "J") + line="5084">the first property format ("n", "b", "i", "f", "s" or "J") a list of object properties and values, followed by NULL + line="5085">a list of object properties and values, followed by NULL @@ -12585,12 +12661,12 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> This is the va_list version of wp_spa_json_new_object() + line="5096">This is the va_list version of wp_spa_json_new_object() The new spa json + line="5107">The new spa json @@ -12600,7 +12676,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat allow-none="1"> the first object property key + line="5098">the first object property key the first property format ("n", "b", "i", "f", "s" or "J") + line="5099">the first property format ("n", "b", "i", "f", "s" or "J") the variable arguments passed to wp_spa_json_new_object() + line="5100">the variable arguments passed to wp_spa_json_new_object() @@ -12623,19 +12699,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Creates a spa json of type string. + line="5040">Creates a spa json of type string. The new spa json + line="5049">The new spa json the string value + line="5042">the string value @@ -12643,12 +12719,12 @@ To export this device to the PipeWire server, you need to call wp_object_activat Constructs a new WpSpaJson that wraps the given spa_json. + line="4883">Constructs a new WpSpaJson that wraps the given spa_json. a new WpSpaJson that references the data in @json. @json is not copied, so it needs to stay alive. + line="4892">a new WpSpaJson that references the data in @json. @json is not copied, so it needs to stay alive. @@ -12658,7 +12734,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat allow-none="1"> a spa_json + line="4885">a spa_json @@ -12668,19 +12744,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat version="0.5.0"> Constructs a new WpSpaJson that wraps a JSON string. + line="4852">Constructs a new WpSpaJson that wraps a JSON string. a new WpSpaJson that references the data in @json_str. @json_str is not copied, so it needs to stay alive. + line="4861">a new WpSpaJson that references the data in @json_str. @json_str is not copied, so it needs to stay alive. a JSON string + line="4854">a JSON string @@ -12690,25 +12766,25 @@ To export this device to the PipeWire server, you need to call wp_object_activat version="0.5.0"> Constructs a new WpSpaJson that wraps a JSON string with specific length. + line="4867">Constructs a new WpSpaJson that wraps a JSON string with specific length. a new WpSpaJson that references the data in @json_str. @json_str is not copied, so it needs to stay alive. + line="4877">a new WpSpaJson that references the data in @json_str. @json_str is not copied, so it needs to stay alive. a JSON string + line="4869">a JSON string the specific length of the string + line="4870">the specific length of the string @@ -12716,19 +12792,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Copies a spa json object. + line="4950">Copies a spa json object. The newly copied spa json + line="4959">The newly copied spa json a spa json object + line="4952">a spa json object @@ -12737,19 +12813,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_json_ensure_unique_owner"> If @self is not uniquely owned already, then it is unrefed and a copy of it is returned instead. You should always consider @self as unsafe to use after this call and you should use the returned object instead. + line="4976">If @self is not uniquely owned already, then it is unrefed and a copy of it is returned instead. You should always consider @self as unsafe to use after this call and you should use the returned object instead. the uniquely owned spa json object which may or may not be the same as @self. + line="4985">the uniquely owned spa json object which may or may not be the same as @self. a spa json object + line="4978">a spa json object @@ -12757,19 +12833,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Returns the json data. + line="4909">Returns the json data. a const pointer to the json data + line="4918">a const pointer to the json data a spa json object + line="4911">a spa json object @@ -12777,19 +12853,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Returns the json data size. + line="4922">Returns the json data size. the json data size + line="4931">the json data size a spa json object + line="4924">a spa json object @@ -12797,19 +12873,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Converts a WpSpaJson pointer to a struct spa_json one, for use with native pipewire & spa functions. The returned pointer is owned by WpSpaJson and may not be modified or freed. + line="4896">Converts a WpSpaJson pointer to a struct spa_json one, for use with native pipewire & spa functions. The returned pointer is owned by WpSpaJson and may not be modified or freed. a const pointer to the underlying spa_json structure + line="4905">a const pointer to the underlying spa_json structure a spa json object + line="4898">a spa json object @@ -12817,19 +12893,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Checks whether the spa json is of type array or not. + line="5176">Checks whether the spa json is of type array or not. TRUE if it is of type array, FALSE otherwise + line="5185">TRUE if it is of type array, FALSE otherwise the spa json object + line="5178">the spa json object @@ -12837,19 +12913,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Checks wether the spa json is of type boolean or not. + line="5124">Checks wether the spa json is of type boolean or not. TRUE if it is of type boolean, FALSE otherwise + line="5133">TRUE if it is of type boolean, FALSE otherwise the spa json object + line="5126">the spa json object @@ -12857,19 +12933,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Checks whether the spa json is of type container or not. + line="5189">Checks whether the spa json is of type container or not. TRUE if it is of type container, FALSE otherwise + line="5198">TRUE if it is of type container, FALSE otherwise the spa json object + line="5191">the spa json object @@ -12877,19 +12953,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Checks wether the spa json is of type float or not. + line="5150">Checks wether the spa json is of type float or not. TRUE if it is of type float, FALSE otherwise + line="5159">TRUE if it is of type float, FALSE otherwise the spa json object + line="5152">the spa json object @@ -12897,19 +12973,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Checks wether the spa json is of type int or not. + line="5137">Checks wether the spa json is of type int or not. TRUE if it is of type int, FALSE otherwise + line="5146">TRUE if it is of type int, FALSE otherwise the spa json object + line="5139">the spa json object @@ -12917,19 +12993,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Checks wether the spa json is of type null or not. + line="5111">Checks wether the spa json is of type null or not. TRUE if it is of type null, FALSE otherwise + line="5120">TRUE if it is of type null, FALSE otherwise the spa json object + line="5113">the spa json object @@ -12937,19 +13013,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Checks whether the spa json is of type object or not. + line="5202">Checks whether the spa json is of type object or not. TRUE if it is of type object, FALSE otherwise + line="5211">TRUE if it is of type object, FALSE otherwise the spa json object + line="5204">the spa json object @@ -12957,19 +13033,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Checks wether the spa json is of type string or not. + line="5163">Checks wether the spa json is of type string or not. TRUE if it is of type string, FALSE otherwise + line="5172">TRUE if it is of type string, FALSE otherwise the spa json object + line="5165">the spa json object @@ -12978,19 +13054,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_json_is_unique_owner"> Checks if the json is the unique owner of its data or not. + line="4963">Checks if the json is the unique owner of its data or not. TRUE if the json owns the data, FALSE otherwise. + line="4972">TRUE if the json owns the data, FALSE otherwise. a spa json object + line="4965">a spa json object @@ -12998,19 +13074,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Creates a new iterator for a spa json object. + line="5741">Creates a new iterator for a spa json object. the new spa json iterator + line="5750">the new spa json iterator the spa json object + line="5743">the spa json object @@ -13020,25 +13096,25 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> Parses the object property values of a spa json object. + line="5326">Parses the object property values of a spa json object. TRUE if the properties and values were obtained, FALSE otherwise + line="5336">TRUE if the properties and values were obtained, FALSE otherwise the spa json object + line="5328">the spa json object the list of property names, formats and values, followed by NULL + line="5329">the list of property names, formats and values, followed by NULL @@ -13048,25 +13124,25 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> This is the va_list version of wp_spa_json_object_get() + line="5340">This is the va_list version of wp_spa_json_object_get() TRUE if the properties and values were obtained, FALSE otherwise + line="5350">TRUE if the properties and values were obtained, FALSE otherwise the spa json object + line="5342">the spa json object the variable arguments passed to wp_spa_json_object_get() + line="5343">the variable arguments passed to wp_spa_json_object_get() @@ -13076,19 +13152,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> Parses the array types and values of a spa json object. + line="5270">Parses the array types and values of a spa json object. TRUE if the types and values were obtained, FALSE otherwise + line="5280">TRUE if the types and values were obtained, FALSE otherwise the spa json object + line="5272">the spa json object the list of array types and values, followed by NULL + line="5273">the list of array types and values, followed by NULL @@ -13107,19 +13183,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> This is the va_list version of wp_spa_json_parse_array() + line="5284">This is the va_list version of wp_spa_json_parse_array() TRUE if the types and values were obtained, FALSE otherwise + line="5294">TRUE if the types and values were obtained, FALSE otherwise the spa json object + line="5286">the spa json object the variable arguments passed to wp_spa_json_parse_array() + line="5287">the variable arguments passed to wp_spa_json_parse_array() @@ -13136,19 +13212,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Parses the boolean value of a spa json object. + line="5215">Parses the boolean value of a spa json object. TRUE if the value was obtained, FALSE otherwise + line="5225">TRUE if the value was obtained, FALSE otherwise the spa json object + line="5217">the spa json object the boolean value + line="5218">the boolean value @@ -13165,19 +13241,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Parses the float value of a spa json object. + line="5243">Parses the float value of a spa json object. TRUE if the value was obtained, FALSE otherwise + line="5253">TRUE if the value was obtained, FALSE otherwise the spa json object + line="5245">the spa json object the float value + line="5246">the float value @@ -13194,19 +13270,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Parses the int value of a spa json object. + line="5229">Parses the int value of a spa json object. TRUE if the value was obtained, FALSE otherwise + line="5239">TRUE if the value was obtained, FALSE otherwise the spa json object + line="5231">the spa json object the int value + line="5232">the int value @@ -13225,19 +13301,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> Parses the object properties and values of a spa json object. + line="5298">Parses the object properties and values of a spa json object. TRUE if the properties and values were obtained, FALSE otherwise + line="5308">TRUE if the properties and values were obtained, FALSE otherwise the spa json object + line="5300">the spa json object the list of object properties and values, followed by NULL + line="5301">the list of object properties and values, followed by NULL @@ -13256,19 +13332,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> This is the va_list version of wp_spa_json_parse_object() + line="5312">This is the va_list version of wp_spa_json_parse_object() TRUE if the properties and values were obtained, FALSE otherwise + line="5322">TRUE if the properties and values were obtained, FALSE otherwise the spa json object + line="5314">the spa json object the variable arguments passed to wp_spa_json_parse_object() + line="5315">the variable arguments passed to wp_spa_json_parse_object() @@ -13285,19 +13361,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Parses the string value of a spa json object. + line="5257">Parses the string value of a spa json object. The newly allocated parsed string + line="5266">The newly allocated parsed string the spa json object + line="5259">the spa json object @@ -13305,19 +13381,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Increases the reference count of a spa json object. + line="4796">Increases the reference count of a spa json object. @self with an additional reference count on it + line="4805">@self with an additional reference count on it a spa json object + line="4798">a spa json object @@ -13327,19 +13403,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat version="0.4.11"> Returns a newly allocated json string with length matching the size. + line="4935">Returns a newly allocated json string with length matching the size. the json string with length matching the size + line="4944">the json string with length matching the size a spa json object + line="4937">a spa json object @@ -13347,7 +13423,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat Decreases the reference count on @self and frees it when the ref count reaches zero. + line="4809">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -13356,7 +13432,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat a spa json object + line="4811">a spa json object @@ -13374,12 +13450,12 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_json_builder_new_array"> Creates a spa json builder of type array. + line="5379">Creates a spa json builder of type array. the new spa json builder + line="5387">the new spa json builder @@ -13387,12 +13463,12 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_json_builder_new_object"> Creates a spa json builder of type object. + line="5391">Creates a spa json builder of type object. the new spa json builder + line="5399">the new spa json builder @@ -13401,7 +13477,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> Adds values into the builder. + line="5520">Adds values into the builder. @@ -13410,13 +13486,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa json builder object + line="5522">the spa json builder object the json values + line="5523">the json values @@ -13425,7 +13501,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_json_builder_add_boolean"> Adds a boolean value into the builder. + line="5428">Adds a boolean value into the builder. @@ -13434,13 +13510,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa json builder object + line="5430">the spa json builder object the boolean value + line="5431">the boolean value @@ -13448,7 +13524,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat Adds a float value into the builder. + line="5454">Adds a float value into the builder. @@ -13457,13 +13533,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa json builder object + line="5456">the spa json builder object the float value + line="5457">the float value @@ -13472,7 +13548,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_json_builder_add_from_string"> Adds a json string into the builder. + line="5493">Adds a json string into the builder. @@ -13481,13 +13557,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa json builder object + line="5495">the spa json builder object the json string + line="5496">the json string @@ -13496,7 +13572,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_json_builder_add_from_stringn"> Adds a json string with specific length into the builder. + line="5506">Adds a json string with specific length into the builder. @@ -13505,19 +13581,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa json builder object + line="5508">the spa json builder object the json string + line="5509">the json string the specific length of the json string + line="5510">the specific length of the json string @@ -13525,7 +13601,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat Adds a int value into the builder. + line="5441">Adds a int value into the builder. @@ -13534,13 +13610,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa json builder object + line="5443">the spa json builder object the int value + line="5444">the int value @@ -13548,7 +13624,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat Adds a json value into the builder. + line="5480">Adds a json value into the builder. @@ -13557,13 +13633,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa json builder object + line="5482">the spa json builder object the json value + line="5483">the json value @@ -13571,7 +13647,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat Adds a null value into the builder. + line="5416">Adds a null value into the builder. @@ -13580,7 +13656,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa json builder object + line="5418">the spa json builder object @@ -13589,7 +13665,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_json_builder_add_property"> Adds a property into the builder. + line="5403">Adds a property into the builder. @@ -13598,13 +13674,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa json builder object + line="5405">the spa json builder object the name of the property + line="5406">the name of the property @@ -13612,7 +13688,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat Adds a string value into the builder. + line="5467">Adds a string value into the builder. @@ -13621,13 +13697,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa json builder object + line="5469">the spa json builder object the string value + line="5470">the string value @@ -13637,7 +13713,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat introspectable="0"> This is the va_list version of wp_spa_json_builder_add() + line="5533">This is the va_list version of wp_spa_json_builder_add() @@ -13646,13 +13722,13 @@ To export this device to the PipeWire server, you need to call wp_object_activat the spa json builder object + line="5535">the spa json builder object the variable arguments passed to wp_spa_json_builder_add() + line="5536">the variable arguments passed to wp_spa_json_builder_add() @@ -13660,19 +13736,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Ends the builder process and returns the constructed spa json object. + line="5546">Ends the builder process and returns the constructed spa json object. the constructed spa json object + line="5555">the constructed spa json object the spa json builder object + line="5548">the spa json builder object @@ -13680,19 +13756,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat Increases the reference count of a spa json builder. + line="5354">Increases the reference count of a spa json builder. @self with an additional reference count on it + line="5363">@self with an additional reference count on it a spa json builder object + line="5356">a spa json builder object @@ -13700,7 +13776,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat Decreases the reference count on @self and frees it when the ref count reaches zero. + line="5367">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -13709,7 +13785,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat a spa json builder object + line="5369">a spa json builder object @@ -13727,19 +13803,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_json_parser_new_array"> Creates a spa json array parser. The @json object must be valid for the entire life-cycle of the returned parser. + line="5584">Creates a spa json array parser. The @json object must be valid for the entire life-cycle of the returned parser. The new spa json parser + line="5593">The new spa json parser the spa json array to parse + line="5586">the spa json array to parse @@ -13748,19 +13824,19 @@ To export this device to the PipeWire server, you need to call wp_object_activat c:identifier="wp_spa_json_parser_new_object"> Creates a spa json object parser. The @json object must be valid for the entire life-cycle of the returned parser. + line="5597">Creates a spa json object parser. The @json object must be valid for the entire life-cycle of the returned parser. The new spa json parser + line="5606">The new spa json parser the spa json object to parse + line="5599">the spa json object to parse @@ -13770,7 +13846,7 @@ To export this device to the PipeWire server, you need to call wp_object_activat version="0.5.0"> Creates a new spa json parser for undefined type of data. The @json object must be valid for the entire life-cycle of the returned parser. + line="5610">Creates a new spa json parser for undefined type of data. The @json object must be valid for the entire life-cycle of the returned parser. This function allows creating a parser object for any type of spa json and is mostly useful to parse non-standard JSON data that should be treated as if it were an object or array, but does not start with a '{' or '[' character. Such data can be for instance a comma-separated list of single values (array) or key-value pairs (object). Such data is also the main configuration file, which is an object but doesn't start with a '{' character. @@ -13779,14 +13855,14 @@ If the data is an array or object, the parser will not enter it and the only tok The new spa json parser + line="5623">The new spa json parser the spa json to parse + line="5612">the spa json to parse @@ -13807,19 +13883,19 @@ If the data is an array or object, the parser will not enter it and the only tok introspectable="0"> Gets the values from a spa json parser object. + line="5713">Gets the values from a spa json parser object. TRUE if the value was obtained, FALSE otherwise + line="5723">TRUE if the value was obtained, FALSE otherwise the spa json parser object + line="5715">the spa json parser object a list of values to get, followed by NULL + line="5716">a list of values to get, followed by NULL @@ -13836,19 +13912,19 @@ If the data is an array or object, the parser will not enter it and the only tok Gets the boolean value from a spa json parser. + line="5642">Gets the boolean value from a spa json parser. TRUE if the value was obtained, FALSE otherwise + line="5652">TRUE if the value was obtained, FALSE otherwise the spa json parser object + line="5644">the spa json parser object the boolean value + line="5645">the boolean value @@ -13865,19 +13941,19 @@ If the data is an array or object, the parser will not enter it and the only tok Gets the float value from a spa json parser object. + line="5670">Gets the float value from a spa json parser object. TRUE if the value was obtained, FALSE otherwise + line="5680">TRUE if the value was obtained, FALSE otherwise the spa json parser object + line="5672">the spa json parser object the float value + line="5673">the float value @@ -13894,19 +13970,19 @@ If the data is an array or object, the parser will not enter it and the only tok Gets the int value from a spa json parser object. + line="5656">Gets the int value from a spa json parser object. TRUE if the value was obtained, FALSE otherwise + line="5666">TRUE if the value was obtained, FALSE otherwise the spa json parser object + line="5658">the spa json parser object the int value + line="5659">the int value @@ -13923,7 +13999,7 @@ If the data is an array or object, the parser will not enter it and the only tok Gets the spa json value from a spa json parser object. + line="5697">Gets the spa json value from a spa json parser object. the returned spa json object references the original data instead of copying it, therefore the original data must be valid for the entire life-cycle of the returned object @@ -13931,14 +14007,14 @@ the returned spa json object references the original data instead of copying it, The spa json value or NULL if it could not be obtained + line="5709">The spa json value or NULL if it could not be obtained the spa json parser object + line="5699">the spa json parser object @@ -13946,19 +14022,19 @@ the returned spa json object references the original data instead of copying it, Gets the null value from a spa json parser. + line="5629">Gets the null value from a spa json parser. TRUE if the null value is present, FALSE otherwise + line="5638">TRUE if the null value is present, FALSE otherwise the spa json parser object + line="5631">the spa json parser object @@ -13966,19 +14042,19 @@ the returned spa json object references the original data instead of copying it, Gets the string value from a spa json parser object. + line="5684">Gets the string value from a spa json parser object. The newly allocated parsed string + line="5693">The newly allocated parsed string the spa json parser object + line="5686">the spa json parser object @@ -13988,25 +14064,25 @@ the returned spa json object references the original data instead of copying it, introspectable="0"> This is the va_list version of wp_spa_json_parser_get() + line="5727">This is the va_list version of wp_spa_json_parser_get() TRUE if the value was obtained, FALSE otherwise + line="5737">TRUE if the value was obtained, FALSE otherwise the spa json parser object + line="5729">the spa json parser object the variable arguments passed to wp_spa_json_parser_get() + line="5730">the variable arguments passed to wp_spa_json_parser_get() @@ -14014,19 +14090,19 @@ the returned spa json object references the original data instead of copying it, Increases the reference count of a spa json parser. + line="5559">Increases the reference count of a spa json parser. @self with an additional reference count on it + line="5568">@self with an additional reference count on it a spa json parser object + line="5561">a spa json parser object @@ -14034,7 +14110,7 @@ the returned spa json object references the original data instead of copying it, Decreases the reference count on @self and frees it when the ref count reaches zero. + line="5572">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -14043,7 +14119,7 @@ the returned spa json object references the original data instead of copying it, a spa json parser object + line="5574">a spa json parser object @@ -14059,19 +14135,19 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type boolean. + line="5896">Creates a spa pod of type boolean. The new spa pod + line="5905">The new spa pod the boolean value + line="5898">the boolean value @@ -14079,12 +14155,12 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type bytes. + line="5987">Creates a spa pod of type bytes. The new spa pod + line="5997">The new spa pod @@ -14094,13 +14170,13 @@ the returned spa json object references the original data instead of copying it, allow-none="1"> the bytes value + line="5989">the bytes value the length of the bytes value + line="5990">the length of the bytes value @@ -14110,25 +14186,25 @@ the returned spa json object references the original data instead of copying it, introspectable="0"> Creates a spa pod of type choice. + line="6056">Creates a spa pod of type choice. The new spa pod + line="6066">The new spa pod the name of the choice type ("Range", "Step", ...), + line="6058">the name of the choice type ("Range", "Step", ...), a list of choice values, followed by NULL + line="6059">a list of choice values, followed by NULL @@ -14138,25 +14214,25 @@ the returned spa json object references the original data instead of copying it, introspectable="0"> This is the va_list version of wp_spa_pod_new_choice() + line="6070">This is the va_list version of wp_spa_pod_new_choice() The new spa pod + line="6080">The new spa pod the name of the choice type ("Range", "Step", ...) + line="6072">the name of the choice type ("Range", "Step", ...) the variable arguments passed to wp_spa_pod_new_choice() + line="6073">the variable arguments passed to wp_spa_pod_new_choice() @@ -14164,19 +14240,19 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type double. + line="5961">Creates a spa pod of type double. The new spa pod + line="5970">The new spa pod the double value + line="5963">the double value @@ -14184,19 +14260,19 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type Fd. + line="6015">Creates a spa pod of type Fd. The new spa pod + line="6024">The new spa pod the Fd value + line="6017">the Fd value @@ -14204,19 +14280,19 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type float. + line="5948">Creates a spa pod of type float. The new spa pod + line="5957">The new spa pod the float value + line="5950">the float value @@ -14224,25 +14300,25 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type fraction. + line="6042">Creates a spa pod of type fraction. The new spa pod + line="6052">The new spa pod the numerator value of the fraction + line="6044">the numerator value of the fraction the denominator value of the fraction + line="6045">the denominator value of the fraction @@ -14250,19 +14326,19 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type Id. + line="5909">Creates a spa pod of type Id. The new spa pod + line="5918">The new spa pod the Id value + line="5911">the Id value @@ -14270,19 +14346,19 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type int. + line="5922">Creates a spa pod of type int. The new spa pod + line="5931">The new spa pod the int value + line="5924">the int value @@ -14290,19 +14366,19 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type long. + line="5935">Creates a spa pod of type long. The new spa pod + line="5944">The new spa pod the long value + line="5937">the long value @@ -14310,12 +14386,12 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type None. + line="5884">Creates a spa pod of type None. The new spa pod + line="5892">The new spa pod @@ -14324,31 +14400,31 @@ the returned spa json object references the original data instead of copying it, introspectable="0"> Creates a spa pod of type object. + line="6084">Creates a spa pod of type object. The new spa pod + line="6095">The new spa pod the type name of the object type + line="6086">the type name of the object type the id name of the object, + line="6087">the id name of the object, a list of object properties with their values, followed by NULL + line="6088">a list of object properties with their values, followed by NULL @@ -14358,31 +14434,31 @@ the returned spa json object references the original data instead of copying it, introspectable="0"> This is the va_list version of wp_spa_pod_new_object() + line="6099">This is the va_list version of wp_spa_pod_new_object() The new spa pod + line="6110">The new spa pod the type name of the object type + line="6101">the type name of the object type the id name of the object + line="6102">the id name of the object the variable arguments passed to wp_spa_pod_new_object() + line="6103">the variable arguments passed to wp_spa_pod_new_object() @@ -14390,19 +14466,19 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type pointer. + line="6001">Creates a spa pod of type pointer. The new spa pod + line="6011">The new spa pod the name of the type of the pointer + line="6003">the name of the type of the pointer the pointer value + line="6004">the pointer value @@ -14420,25 +14496,25 @@ the returned spa json object references the original data instead of copying it, c:identifier="wp_spa_pod_new_rectangle"> Creates a spa pod of type rectangle. + line="6028">Creates a spa pod of type rectangle. The new spa pod + line="6038">The new spa pod the width value of the rectangle + line="6030">the width value of the rectangle the height value of the rectangle + line="6031">the height value of the rectangle @@ -14448,25 +14524,25 @@ the returned spa json object references the original data instead of copying it, introspectable="0"> Creates a spa pod of type sequence. + line="6114">Creates a spa pod of type sequence. The new spa pod + line="6124">The new spa pod the unit of the sequence + line="6116">the unit of the sequence a list of sequence controls with their values, followed by NULL + line="6117">a list of sequence controls with their values, followed by NULL @@ -14476,25 +14552,25 @@ the returned spa json object references the original data instead of copying it, introspectable="0"> This is the va_list version of wp_spa_pod_new_sequence() + line="6128">This is the va_list version of wp_spa_pod_new_sequence() The new spa pod + line="6138">The new spa pod the unit of the sequence + line="6130">the unit of the sequence the variable arguments passed to wp_spa_pod_new_sequence() + line="6131">the variable arguments passed to wp_spa_pod_new_sequence() @@ -14502,19 +14578,19 @@ the returned spa json object references the original data instead of copying it, Creates a spa pod of type string. + line="5974">Creates a spa pod of type string. The new spa pod + line="5983">The new spa pod the string value + line="5976">the string value @@ -14522,12 +14598,12 @@ the returned spa json object references the original data instead of copying it, Constructs a new WpSpaPod that wraps the given spa_pod. + line="5779">Constructs a new WpSpaPod that wraps the given spa_pod. a new WpSpaPod that references the data in @pod. @pod is not copied, so it needs to stay alive. The returned WpSpaPod can be modified by using the setter functions, in which case @pod will be modified underneath. + line="5788">a new WpSpaPod that references the data in @pod. @pod is not copied, so it needs to stay alive. The returned WpSpaPod can be modified by using the setter functions, in which case @pod will be modified underneath. @@ -14537,7 +14613,7 @@ the returned spa json object references the original data instead of copying it, allow-none="1"> a spa_pod + line="5781">a spa_pod @@ -14546,12 +14622,12 @@ the returned spa json object references the original data instead of copying it, c:identifier="wp_spa_pod_new_wrap_const"> Constructs a new immutable WpSpaPod that wraps the given spa_pod. + line="5792">Constructs a new immutable WpSpaPod that wraps the given spa_pod. a new WpSpaPod that references the data in @pod. @pod is not copied, so it needs to stay alive. The returned WpSpaPod cannot be modified, unless it's copied first. + line="5801">a new WpSpaPod that references the data in @pod. @pod is not copied, so it needs to stay alive. The returned WpSpaPod cannot be modified, unless it's copied first. @@ -14561,7 +14637,7 @@ the returned spa json object references the original data instead of copying it, allow-none="1"> a constant spa_pod + line="5794">a constant spa_pod @@ -14569,19 +14645,19 @@ the returned spa json object references the original data instead of copying it, Copies a spa pod object. + line="5845">Copies a spa pod object. The newly copied spa pod + line="5854">The newly copied spa pod a spa pod object + line="5847">a spa pod object @@ -14590,19 +14666,19 @@ the returned spa json object references the original data instead of copying it, c:identifier="wp_spa_pod_ensure_unique_owner"> If @self is not uniquely owned already, then it is unrefed and a copy of it is returned instead. You should always consider @self as unsafe to use after this call and you should use the returned object instead. + line="5871">If @self is not uniquely owned already, then it is unrefed and a copy of it is returned instead. You should always consider @self as unsafe to use after this call and you should use the returned object instead. the uniquely owned spa pod object which may or may not be the same as @self. + line="5880">the uniquely owned spa pod object which may or may not be the same as @self. a spa pod object + line="5873">a spa pod object @@ -14610,25 +14686,25 @@ the returned spa json object references the original data instead of copying it, Checks whether two spa pod objects have the same value or not. + line="6730">Checks whether two spa pod objects have the same value or not. TRUE if both spa pod objects have the same values, FALSE othewrise. + line="6740">TRUE if both spa pod objects have the same values, FALSE othewrise. the spa pod object + line="6732">the spa pod object the pod with the value to be compared with + line="6733">the pod with the value to be compared with @@ -14650,19 +14726,19 @@ the returned spa json object references the original data instead of copying it, Fixates choices in an object pod so that they only have one value. + line="6859">Fixates choices in an object pod so that they only have one value. TRUE if the pod was an object and it went through the fixation procedure, FALSE otherwise + line="6868">TRUE if the pod was an object and it went through the fixation procedure, FALSE otherwise a spa pod + line="6861">a spa pod @@ -14670,19 +14746,19 @@ the returned spa json object references the original data instead of copying it, Gets the child of a spa pod array object. + line="6846">Gets the child of a spa pod array object. the child of the spa pod array object + line="6855">the child of the spa pod array object a spa pod choice object + line="6848">a spa pod choice object @@ -14690,19 +14766,19 @@ the returned spa json object references the original data instead of copying it, Gets the boolean value of a spa pod object. + line="6402">Gets the boolean value of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6412">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6404">the spa pod object the boolean value + line="6405">the boolean value @@ -14719,19 +14795,19 @@ the returned spa json object references the original data instead of copying it, Gets the bytes value and its len of a spa pod object. + line="6500">Gets the bytes value and its len of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6511">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6502">the spa pod object the bytes value + line="6503">the bytes value the length of the bytes value + line="6504">the length of the bytes value @@ -14759,19 +14835,19 @@ the returned spa json object references the original data instead of copying it, c:identifier="wp_spa_pod_get_choice_child"> Gets the child of a spa pod choice object. + line="6833">Gets the child of a spa pod choice object. the child of the spa pod choice object + line="6842">the child of the spa pod choice object a spa pod choice object + line="6835">a spa pod choice object @@ -14779,19 +14855,19 @@ the returned spa json object references the original data instead of copying it, If the pod is a Choice, this gets the choice type (Range, Step, Enum, ...) + line="5832">If the pod is a Choice, this gets the choice type (Range, Step, Enum, ...) the choice type of the choice pod + line="5841">the choice type of the choice pod a choice pod + line="5834">a choice pod @@ -14799,19 +14875,19 @@ the returned spa json object references the original data instead of copying it, Gets the offset, type name and spa pod value of a spa pod control. + line="6817">Gets the offset, type name and spa pod value of a spa pod control. TRUE if the value was obtained, FALSE otherwise + line="6829">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6819">the spa pod object the offset of the control + line="6820">the offset of the control the control type (Properties, Midi, ...) + line="6821">the control type (Properties, Midi, ...) the spa pod value of the control + line="6822">the spa pod value of the control @@ -14852,19 +14928,19 @@ the returned spa json object references the original data instead of copying it, Gets the double value of a spa pod object. + line="6472">Gets the double value of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6482">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6474">the spa pod object the double value + line="6475">the double value @@ -14881,19 +14957,19 @@ the returned spa json object references the original data instead of copying it, Gets the Fd value of a spa pod object. + line="6529">Gets the Fd value of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6539">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6531">the spa pod object the Fd value + line="6532">the Fd value @@ -14910,19 +14986,19 @@ the returned spa json object references the original data instead of copying it, Gets the float value of a spa pod object. + line="6458">Gets the float value of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6468">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6460">the spa pod object the float value + line="6461">the float value @@ -14939,19 +15015,19 @@ the returned spa json object references the original data instead of copying it, Gets the fractions's numerator and denominator value of a spa pod object. + line="6558">Gets the fractions's numerator and denominator value of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6569">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6560">the spa pod object the fractions's numerator value + line="6561">the fractions's numerator value the fractions's denominator value + line="6562">the fractions's denominator value @@ -14977,19 +15053,19 @@ the returned spa json object references the original data instead of copying it, Gets the Id value of a spa pod object. + line="6416">Gets the Id value of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6426">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6418">the spa pod object the Id value + line="6419">the Id value @@ -15006,19 +15082,19 @@ the returned spa json object references the original data instead of copying it, Gets the int value of a spa pod object. + line="6430">Gets the int value of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6440">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6432">the spa pod object the int value + line="6433">the int value @@ -15035,19 +15111,19 @@ the returned spa json object references the original data instead of copying it, Gets the long value of a spa pod object. + line="6444">Gets the long value of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6454">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6446">the spa pod object the long value + line="6447">the long value @@ -15066,19 +15142,19 @@ the returned spa json object references the original data instead of copying it, introspectable="0"> Gets the object properties values of a spa pod object. + line="6744">Gets the object properties values of a spa pod object. TRUE if the object properties values were obtained, FALSE otherwise + line="6755">TRUE if the object properties values were obtained, FALSE otherwise the spa pod object + line="6746">the spa pod object the id name of the object, + line="6747">the id name of the object, the list of the object properties values, followed by NULL + line="6748">the list of the object properties values, followed by NULL @@ -15106,19 +15182,19 @@ the returned spa json object references the original data instead of copying it, introspectable="0"> This is the va_list version of wp_spa_pod_get_object() + line="6759">This is the va_list version of wp_spa_pod_get_object() TRUE if the object properties values were obtained, FALSE otherwise + line="6770">TRUE if the object properties values were obtained, FALSE otherwise the spa pod object + line="6761">the spa pod object the id name of the object + line="6762">the id name of the object the variable arguments passed to wp_spa_pod_get_object() + line="6763">the variable arguments passed to wp_spa_pod_get_object() @@ -15144,19 +15220,19 @@ the returned spa json object references the original data instead of copying it, Gets the pointer value and its type name of a spa pod object. + line="6515">Gets the pointer value and its type name of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6525">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6517">the spa pod object the pointer value + line="6518">the pointer value @@ -15174,19 +15250,19 @@ the returned spa json object references the original data instead of copying it, Gets the name, flags and spa pod value of a spa pod property. + line="6802">Gets the name, flags and spa pod value of a spa pod property. TRUE if the value was obtained, FALSE otherwise + line="6813">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6804">the spa pod object the name of the property + line="6805">the name of the property the spa pod value of the property + line="6806">the spa pod value of the property @@ -15216,19 +15292,19 @@ the returned spa json object references the original data instead of copying it, Gets the rectangle's width and height value of a spa pod object. + line="6543">Gets the rectangle's width and height value of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6554">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6545">the spa pod object the rectangle's width value + line="6546">the rectangle's width value the rectangle's height value + line="6547">the rectangle's height value @@ -15254,19 +15330,19 @@ the returned spa json object references the original data instead of copying it, Converts a WpSpaPod pointer to a struct spa_pod one, for use with native pipewire & spa functions. The returned pointer is owned by WpSpaPod and may not be modified or freed. + line="5805">Converts a WpSpaPod pointer to a struct spa_pod one, for use with native pipewire & spa functions. The returned pointer is owned by WpSpaPod and may not be modified or freed. a const pointer to the underlying spa_pod structure + line="5814">a const pointer to the underlying spa_pod structure a spa pod object + line="5807">a spa pod object @@ -15274,7 +15350,7 @@ the returned spa json object references the original data instead of copying it, Gets the SPA type of the spa pod. + line="5818">Gets the SPA type of the spa pod. If the pod is an object or pointer, this will return the derived object/pointer type directly. If the pod is an object property or a control, this will return the type of the contained value. @@ -15282,14 +15358,14 @@ If the pod is an object or pointer, this will return the derived object/pointer the type of the spa pod + line="5828">the type of the spa pod a spa pod + line="5820">a spa pod @@ -15297,19 +15373,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the string value of a spa pod object. + line="6486">Gets the string value of a spa pod object. TRUE if the value was obtained, FALSE otherwise + line="6496">TRUE if the value was obtained, FALSE otherwise the spa pod object + line="6488">the spa pod object the string value + line="6489">the string value @@ -15328,19 +15404,19 @@ If the pod is an object or pointer, this will return the derived object/pointer introspectable="0"> Gets the struct's values of a spa pod object. + line="6774">Gets the struct's values of a spa pod object. TRUE if the struct values were obtained, FALSE otherwise + line="6784">TRUE if the struct values were obtained, FALSE otherwise the spa pod object + line="6776">the spa pod object the list of the struct values, followed by NULL + line="6777">the list of the struct values, followed by NULL @@ -15359,19 +15435,19 @@ If the pod is an object or pointer, this will return the derived object/pointer introspectable="0"> This is the va_list version of wp_spa_pod_get_struct() + line="6788">This is the va_list version of wp_spa_pod_get_struct() TRUE if the struct values were obtained, FALSE otherwise + line="6798">TRUE if the struct values were obtained, FALSE otherwise the spa pod object + line="6790">the spa pod object the variable arguments passed to wp_spa_pod_get_struct() + line="6791">the variable arguments passed to wp_spa_pod_get_struct() @@ -15388,19 +15464,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type array or not. + line="6311">Checks wether the spa pod is of type array or not. TRUE if it is of type array, FALSE otherwise + line="6320">TRUE if it is of type array, FALSE otherwise the spa pod object + line="6313">the spa pod object @@ -15408,19 +15484,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type boolean or not. + line="6155">Checks wether the spa pod is of type boolean or not. TRUE if it is of type boolean, FALSE otherwise + line="6164">TRUE if it is of type boolean, FALSE otherwise the spa pod object + line="6157">the spa pod object @@ -15428,19 +15504,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type bytes or not. + line="6246">Checks wether the spa pod is of type bytes or not. TRUE if it is of type bytes, FALSE otherwise + line="6255">TRUE if it is of type bytes, FALSE otherwise the spa pod object + line="6248">the spa pod object @@ -15448,19 +15524,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type choice or not. + line="6324">Checks wether the spa pod is of type choice or not. TRUE if it is of type choice, FALSE otherwise + line="6333">TRUE if it is of type choice, FALSE otherwise the spa pod object + line="6326">the spa pod object @@ -15468,19 +15544,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type control or not. + line="6389">Checks wether the spa pod is of type control or not. TRUE if it is of type control, FALSE otherwise + line="6398">TRUE if it is of type control, FALSE otherwise the spa pod object + line="6391">the spa pod object @@ -15488,19 +15564,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type double or not. + line="6220">Checks wether the spa pod is of type double or not. TRUE if it is of type double, FALSE otherwise + line="6229">TRUE if it is of type double, FALSE otherwise the spa pod object + line="6222">the spa pod object @@ -15508,19 +15584,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type Fd or not. + line="6272">Checks wether the spa pod is of type Fd or not. TRUE if it is of type Fd, FALSE otherwise + line="6281">TRUE if it is of type Fd, FALSE otherwise the spa pod object + line="6274">the spa pod object @@ -15528,19 +15604,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type float or not. + line="6207">Checks wether the spa pod is of type float or not. TRUE if it is of type float, FALSE otherwise + line="6216">TRUE if it is of type float, FALSE otherwise the spa pod object + line="6209">the spa pod object @@ -15548,19 +15624,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type fraction or not. + line="6298">Checks wether the spa pod is of type fraction or not. TRUE if it is of type fraction, FALSE otherwise + line="6307">TRUE if it is of type fraction, FALSE otherwise the spa pod object + line="6300">the spa pod object @@ -15568,19 +15644,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type Id or not. + line="6168">Checks wether the spa pod is of type Id or not. TRUE if it is of type Id, FALSE otherwise + line="6177">TRUE if it is of type Id, FALSE otherwise the spa pod object + line="6170">the spa pod object @@ -15588,19 +15664,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type int or not. + line="6181">Checks wether the spa pod is of type int or not. TRUE if it is of type int, FALSE otherwise + line="6190">TRUE if it is of type int, FALSE otherwise the spa pod object + line="6183">the spa pod object @@ -15608,19 +15684,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type long or not. + line="6194">Checks wether the spa pod is of type long or not. TRUE if it is of type long, FALSE otherwise + line="6203">TRUE if it is of type long, FALSE otherwise the spa pod object + line="6196">the spa pod object @@ -15628,19 +15704,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type none or not. + line="6142">Checks wether the spa pod is of type none or not. TRUE if it is of type none, FALSE otherwise + line="6151">TRUE if it is of type none, FALSE otherwise the spa pod object + line="6144">the spa pod object @@ -15648,19 +15724,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type object or not. + line="6337">Checks wether the spa pod is of type object or not. TRUE if it is of type object, FALSE otherwise + line="6346">TRUE if it is of type object, FALSE otherwise the spa pod object + line="6339">the spa pod object @@ -15668,19 +15744,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type pointer or not. + line="6259">Checks wether the spa pod is of type pointer or not. TRUE if it is of type pointer, FALSE otherwise + line="6268">TRUE if it is of type pointer, FALSE otherwise the spa pod object + line="6261">the spa pod object @@ -15688,19 +15764,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type property or not. + line="6376">Checks wether the spa pod is of type property or not. TRUE if it is of type property, FALSE otherwise + line="6385">TRUE if it is of type property, FALSE otherwise the spa pod object + line="6378">the spa pod object @@ -15708,19 +15784,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type rectangle or not. + line="6285">Checks wether the spa pod is of type rectangle or not. TRUE if it is of type rectangle, FALSE otherwise + line="6294">TRUE if it is of type rectangle, FALSE otherwise the spa pod object + line="6287">the spa pod object @@ -15728,19 +15804,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type sequence or not. + line="6363">Checks wether the spa pod is of type sequence or not. TRUE if it is of type sequence, FALSE otherwise + line="6372">TRUE if it is of type sequence, FALSE otherwise the spa pod object + line="6365">the spa pod object @@ -15748,19 +15824,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type string or not. + line="6233">Checks wether the spa pod is of type string or not. TRUE if it is of type string, FALSE otherwise + line="6242">TRUE if it is of type string, FALSE otherwise the spa pod object + line="6235">the spa pod object @@ -15768,19 +15844,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks wether the spa pod is of type struct or not. + line="6350">Checks wether the spa pod is of type struct or not. TRUE if it is of type struct, FALSE otherwise + line="6359">TRUE if it is of type struct, FALSE otherwise the spa pod object + line="6352">the spa pod object @@ -15788,19 +15864,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Checks if the pod is the unique owner of its data or not. + line="5858">Checks if the pod is the unique owner of its data or not. TRUE if the pod owns the data, FALSE otherwise. + line="5867">TRUE if the pod owns the data, FALSE otherwise. a spa pod object + line="5860">a spa pod object @@ -15808,19 +15884,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Creates a new iterator for a spa pod object. + line="7500">Creates a new iterator for a spa pod object. the new spa pod iterator + line="7509">the new spa pod iterator a spa pod object + line="7502">a spa pod object @@ -15828,19 +15904,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Increases the reference count of a spa pod object. + line="5754">Increases the reference count of a spa pod object. @self with an additional reference count on it + line="5763">@self with an additional reference count on it a spa pod object + line="5756">a spa pod object @@ -15848,25 +15924,25 @@ If the pod is an object or pointer, this will return the derived object/pointer Sets a boolean value in the spa pod object. + line="6573">Sets a boolean value in the spa pod object. TRUE if the value could be set, FALSE othewrise. + line="6583">TRUE if the value could be set, FALSE othewrise. the spa pod object + line="6575">the spa pod object the boolean value + line="6576">the boolean value @@ -15874,25 +15950,25 @@ If the pod is an object or pointer, this will return the derived object/pointer Sets a double value in the spa pod object. + line="6643">Sets a double value in the spa pod object. TRUE if the value could be set, FALSE othewrise. + line="6653">TRUE if the value could be set, FALSE othewrise. the spa pod object + line="6645">the spa pod object the double value + line="6646">the double value @@ -15900,25 +15976,25 @@ If the pod is an object or pointer, this will return the derived object/pointer Sets a Fd value in the spa pod object. + line="6672">Sets a Fd value in the spa pod object. TRUE if the value could be set, FALSE othewrise. + line="6682">TRUE if the value could be set, FALSE othewrise. the spa pod object + line="6674">the spa pod object the Fd value + line="6675">the Fd value @@ -15926,25 +16002,25 @@ If the pod is an object or pointer, this will return the derived object/pointer Sets a float value in the spa pod object. + line="6629">Sets a float value in the spa pod object. TRUE if the value could be set, FALSE othewrise. + line="6639">TRUE if the value could be set, FALSE othewrise. the spa pod object + line="6631">the spa pod object the float value + line="6632">the float value @@ -15952,31 +16028,31 @@ If the pod is an object or pointer, this will return the derived object/pointer Sets the numerator and denominator values of a fraction in the spa pod object. + line="6701">Sets the numerator and denominator values of a fraction in the spa pod object. TRUE if the value could be set, FALSE othewrise. + line="6712">TRUE if the value could be set, FALSE othewrise. the spa pod object + line="6703">the spa pod object the numerator value of the farction + line="6704">the numerator value of the farction the denominator value of the fraction + line="6705">the denominator value of the fraction @@ -15984,25 +16060,25 @@ If the pod is an object or pointer, this will return the derived object/pointer Sets an Id value in the spa pod object. + line="6587">Sets an Id value in the spa pod object. TRUE if the value could be set, FALSE othewrise. + line="6597">TRUE if the value could be set, FALSE othewrise. the spa pod object + line="6589">the spa pod object the Id value + line="6590">the Id value @@ -16010,25 +16086,25 @@ If the pod is an object or pointer, this will return the derived object/pointer Sets an int value in the spa pod object. + line="6601">Sets an int value in the spa pod object. TRUE if the value could be set, FALSE othewrise. + line="6611">TRUE if the value could be set, FALSE othewrise. the spa pod object + line="6603">the spa pod object the int value + line="6604">the int value @@ -16036,25 +16112,25 @@ If the pod is an object or pointer, this will return the derived object/pointer Sets a long value in the spa pod object. + line="6615">Sets a long value in the spa pod object. TRUE if the value could be set, FALSE othewrise. + line="6625">TRUE if the value could be set, FALSE othewrise. the spa pod object + line="6617">the spa pod object the long value + line="6618">the long value @@ -16062,25 +16138,25 @@ If the pod is an object or pointer, this will return the derived object/pointer Sets the value of a spa pod object in the current spa pod object. The spa pod objects must be of the same value. + line="6716">Sets the value of a spa pod object in the current spa pod object. The spa pod objects must be of the same value. TRUE if the value could be set, FALSE othewrise. + line="6726">TRUE if the value could be set, FALSE othewrise. the spa pod object + line="6718">the spa pod object the pod with the value to be set + line="6719">the pod with the value to be set @@ -16088,25 +16164,25 @@ If the pod is an object or pointer, this will return the derived object/pointer Sets a pointer value with its type name in the spa pod object. + line="6657">Sets a pointer value with its type name in the spa pod object. TRUE if the value could be set, FALSE othewrise. + line="6668">TRUE if the value could be set, FALSE othewrise. the spa pod object + line="6659">the spa pod object the name of the type of the pointer + line="6660">the name of the type of the pointer the pointer value + line="6661">the pointer value @@ -16123,31 +16199,31 @@ If the pod is an object or pointer, this will return the derived object/pointer Sets the width and height values of a rectangle in the spa pod object. + line="6686">Sets the width and height values of a rectangle in the spa pod object. TRUE if the value could be set, FALSE othewrise. + line="6697">TRUE if the value could be set, FALSE othewrise. the spa pod object + line="6688">the spa pod object the width value of the rectangle + line="6689">the width value of the rectangle the height value of the rectangle + line="6690">the height value of the rectangle @@ -16155,7 +16231,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Decreases the reference count on @self and frees it when the ref count reaches zero. + line="5767">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -16164,7 +16240,7 @@ If the pod is an object or pointer, this will return the derived object/pointer a spa pod object + line="5769">a spa pod object @@ -16181,12 +16257,12 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_builder_new_array"> Creates a spa pod builder of type array. + line="6897">Creates a spa pod builder of type array. the new spa pod builder + line="6905">the new spa pod builder @@ -16194,19 +16270,19 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_builder_new_choice"> Creates a spa pod builder of type choice. + line="6909">Creates a spa pod builder of type choice. the new spa pod builder + line="6918">the new spa pod builder the name of the choice type ("Range", "Step", ...) + line="6911">the name of the choice type ("Range", "Step", ...) @@ -16215,25 +16291,25 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_builder_new_object"> Creates a spa pod builder of type object. + line="6922">Creates a spa pod builder of type object. the new spa pod builder + line="6932">the new spa pod builder the type name of the object type + line="6924">the type name of the object type the Id name of the object + line="6925">the Id name of the object @@ -16242,12 +16318,12 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_builder_new_sequence"> Creates a spa pod builder of type sequence. + line="6948">Creates a spa pod builder of type sequence. the new spa pod builder + line="6956">the new spa pod builder @@ -16260,12 +16336,12 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_builder_new_struct"> Creates a spa pod builder of type struct. + line="6936">Creates a spa pod builder of type struct. the new spa pod builder + line="6944">the new spa pod builder @@ -16274,7 +16350,7 @@ If the pod is an object or pointer, this will return the derived object/pointer introspectable="0"> Adds a list of values into the builder. + line="7185">Adds a list of values into the builder. @@ -16283,13 +16359,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7187">the spa pod builder object a list of additional values, followed by NULL + line="7188">a list of additional values, followed by NULL @@ -16297,7 +16373,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a boolean value into the builder. + line="6972">Adds a boolean value into the builder. @@ -16306,13 +16382,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="6974">the spa pod builder object the boolean value + line="6975">the boolean value @@ -16320,7 +16396,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a bytes value with its length into the builder. + line="7063">Adds a bytes value with its length into the builder. @@ -16329,7 +16405,7 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7065">the spa pod builder object the bytes value + line="7066">the bytes value the length of the bytes value + line="7067">the length of the bytes value @@ -16352,7 +16428,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a control into the builder. + line="7171">Adds a control into the builder. @@ -16361,19 +16437,19 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7173">the spa pod builder object the offset of the control + line="7174">the offset of the control the type name of the control + line="7175">the type name of the control @@ -16381,7 +16457,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a double value into the builder. + line="7037">Adds a double value into the builder. @@ -16390,13 +16466,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7039">the spa pod builder object the double value + line="7040">the double value @@ -16404,7 +16480,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a Fd value into the builder. + line="7091">Adds a Fd value into the builder. @@ -16413,13 +16489,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7093">the spa pod builder object the Fd value + line="7094">the Fd value @@ -16427,7 +16503,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a float value into the builder. + line="7024">Adds a float value into the builder. @@ -16436,13 +16512,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7026">the spa pod builder object the float value + line="7027">the float value @@ -16451,7 +16527,7 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_builder_add_fraction"> Adds the numerator and denominator values of a fraction into the builder. + line="7118">Adds the numerator and denominator values of a fraction into the builder. @@ -16460,19 +16536,19 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7120">the spa pod builder object the numerator value of the fraction + line="7121">the numerator value of the fraction the denominator value of the fraction + line="7122">the denominator value of the fraction @@ -16480,7 +16556,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a Id value into the builder. + line="6985">Adds a Id value into the builder. @@ -16489,13 +16565,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="6987">the spa pod builder object the Id value + line="6988">the Id value @@ -16503,7 +16579,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a int value into the builder. + line="6998">Adds a int value into the builder. @@ -16512,13 +16588,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7000">the spa pod builder object the int value + line="7001">the int value @@ -16526,7 +16602,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a long value into the builder. + line="7011">Adds a long value into the builder. @@ -16535,13 +16611,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7013">the spa pod builder object the long value + line="7014">the long value @@ -16549,7 +16625,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a none value into the builder. + line="6960">Adds a none value into the builder. @@ -16558,7 +16634,7 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="6962">the spa pod builder object @@ -16566,7 +16642,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a pod value into the builder. + line="7132">Adds a pod value into the builder. @@ -16575,13 +16651,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7134">the spa pod builder object the pod value + line="7135">the pod value @@ -16589,7 +16665,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a pointer value with its type name into the builder. + line="7077">Adds a pointer value with its type name into the builder. @@ -16598,13 +16674,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7079">the spa pod builder object the type name that the pointer points to + line="7080">the type name that the pointer points to the pointer vaue + line="7081">the pointer vaue @@ -16622,7 +16698,7 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_builder_add_property"> Adds a property into the builder. + line="7145">Adds a property into the builder. @@ -16631,13 +16707,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7147">the spa pod builder object the name of the property + line="7148">the name of the property @@ -16646,7 +16722,7 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_builder_add_property_id"> Adds a property into the builder. + line="7158">Adds a property into the builder. @@ -16655,13 +16731,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7160">the spa pod builder object the id of the property + line="7161">the id of the property @@ -16670,7 +16746,7 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_builder_add_rectangle"> Adds the width and height values of a rectangle into the builder. + line="7104">Adds the width and height values of a rectangle into the builder. @@ -16679,19 +16755,19 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7106">the spa pod builder object the width value of the rectangle + line="7107">the width value of the rectangle the height value of the rectangle + line="7108">the height value of the rectangle @@ -16699,7 +16775,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Adds a string value into the builder. + line="7050">Adds a string value into the builder. @@ -16708,13 +16784,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7052">the spa pod builder object the string value + line="7053">the string value @@ -16724,7 +16800,7 @@ If the pod is an object or pointer, this will return the derived object/pointer introspectable="0"> Adds a list of values into the builder. + line="7198">Adds a list of values into the builder. @@ -16733,13 +16809,13 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod builder object + line="7200">the spa pod builder object the variable arguments passed to wp_spa_pod_builder_add() + line="7201">the variable arguments passed to wp_spa_pod_builder_add() @@ -16747,19 +16823,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Ends the builder process and returns the constructed spa pod object. + line="7211">Ends the builder process and returns the constructed spa pod object. the constructed spa pod object + line="7220">the constructed spa pod object the spa pod builder object + line="7213">the spa pod builder object @@ -16767,19 +16843,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Increases the reference count of a spa pod builder. + line="6872">Increases the reference count of a spa pod builder. @self with an additional reference count on it + line="6881">@self with an additional reference count on it a spa pod builder object + line="6874">a spa pod builder object @@ -16787,7 +16863,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Decreases the reference count on @self and frees it when the ref count reaches zero. + line="6885">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -16796,7 +16872,7 @@ If the pod is an object or pointer, this will return the derived object/pointer a spa pod builder object + line="6887">a spa pod builder object @@ -16813,25 +16889,25 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_parser_new_object"> Creates an object spa pod parser. The @pod object must be valid for the entire life-cycle of the returned parser. + line="7249">Creates an object spa pod parser. The @pod object must be valid for the entire life-cycle of the returned parser. The new spa pod parser + line="7259">The new spa pod parser the object spa pod to parse + line="7251">the object spa pod to parse the Id name of the object + line="7252">the Id name of the object @@ -16840,19 +16916,19 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_parser_new_struct"> Creates an struct spa pod parser. The @pod object must be valid for the entire life-cycle of the returned parser. + line="7263">Creates an struct spa pod parser. The @pod object must be valid for the entire life-cycle of the returned parser. The new spa pod parser + line="7272">The new spa pod parser the struct spa pod to parse + line="7265">the struct spa pod to parse @@ -16860,7 +16936,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Ends the parser process. + line="7488">Ends the parser process. @@ -16869,7 +16945,7 @@ If the pod is an object or pointer, this will return the derived object/pointer the spa pod parser object + line="7490">the spa pod parser object @@ -16879,19 +16955,19 @@ If the pod is an object or pointer, this will return the derived object/pointer introspectable="0"> Gets a list of values from a spa pod parser object. + line="7460">Gets a list of values from a spa pod parser object. TRUE if the values were obtained, FALSE otherwise + line="7470">TRUE if the values were obtained, FALSE otherwise the spa pod parser object + line="7462">the spa pod parser object a list of values to get, followed by NULL + line="7463">a list of values to get, followed by NULL @@ -16908,19 +16984,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the boolean value from a spa pod parser. + line="7276">Gets the boolean value from a spa pod parser. TRUE if the value was obtained, FALSE otherwise + line="7286">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7278">the spa pod parser object the boolean value + line="7279">the boolean value @@ -16937,19 +17013,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the bytes value and its length from a spa pod parser object. + line="7374">Gets the bytes value and its length from a spa pod parser object. TRUE if the value was obtained, FALSE otherwise + line="7385">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7376">the spa pod parser object the bytes value + line="7377">the bytes value the length of the bytes value + line="7378">the length of the bytes value @@ -16976,19 +17052,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the double value from a spa pod parser object. + line="7346">Gets the double value from a spa pod parser object. TRUE if the value was obtained, FALSE otherwise + line="7356">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7348">the spa pod parser object the double value + line="7349">the double value @@ -17005,19 +17081,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the Fd value from a spa pod parser object. + line="7403">Gets the Fd value from a spa pod parser object. TRUE if the value was obtained, FALSE otherwise + line="7413">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7405">the spa pod parser object the Fd value + line="7406">the Fd value @@ -17034,19 +17110,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the float value from a spa pod parser object. + line="7332">Gets the float value from a spa pod parser object. TRUE if the value was obtained, FALSE otherwise + line="7342">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7334">the spa pod parser object the float value + line="7335">the float value @@ -17064,19 +17140,19 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_parser_get_fraction"> Gets the fractions's numerator and denominator value from a spa pod parser object. + line="7432">Gets the fractions's numerator and denominator value from a spa pod parser object. TRUE if the value was obtained, FALSE otherwise + line="7443">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7434">the spa pod parser object the fractions's numerator value + line="7435">the fractions's numerator value the fractions's denominator value + line="7436">the fractions's denominator value @@ -17102,19 +17178,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the Id value from a spa pod parser object. + line="7290">Gets the Id value from a spa pod parser object. TRUE if the value was obtained, FALSE otherwise + line="7300">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7292">the spa pod parser object the Id value + line="7293">the Id value @@ -17131,19 +17207,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the int value from a spa pod parser object. + line="7304">Gets the int value from a spa pod parser object. TRUE if the value was obtained, FALSE otherwise + line="7314">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7306">the spa pod parser object the int value + line="7307">the int value @@ -17160,19 +17236,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the long value from a spa pod parser object. + line="7318">Gets the long value from a spa pod parser object. TRUE if the value was obtained, FALSE otherwise + line="7328">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7320">the spa pod parser object the long value + line="7321">the long value @@ -17189,19 +17265,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the spa pod value from a spa pod parser object. + line="7447">Gets the spa pod value from a spa pod parser object. The spa pod value or NULL if it could not be obtained + line="7456">The spa pod value or NULL if it could not be obtained the spa pod parser object + line="7449">the spa pod parser object @@ -17209,19 +17285,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the pointer value and its type name from a spa pod parser object. + line="7389">Gets the pointer value and its type name from a spa pod parser object. TRUE if the value was obtained, FALSE otherwise + line="7399">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7391">the spa pod parser object the pointer value + line="7392">the pointer value @@ -17240,19 +17316,19 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_pod_parser_get_rectangle"> Gets the rectangle's width and height value from a spa pod parser object. + line="7417">Gets the rectangle's width and height value from a spa pod parser object. TRUE if the value was obtained, FALSE otherwise + line="7428">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7419">the spa pod parser object the rectangle's width value + line="7420">the rectangle's width value the rectangle's height value + line="7421">the rectangle's height value @@ -17278,19 +17354,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Gets the string value from a spa pod parser object. + line="7360">Gets the string value from a spa pod parser object. TRUE if the value was obtained, FALSE otherwise + line="7370">TRUE if the value was obtained, FALSE otherwise the spa pod parser object + line="7362">the spa pod parser object the string value + line="7363">the string value @@ -17309,25 +17385,25 @@ If the pod is an object or pointer, this will return the derived object/pointer introspectable="0"> This is the va_list version of wp_spa_pod_parser_get() + line="7474">This is the va_list version of wp_spa_pod_parser_get() TRUE if the values were obtained, FALSE otherwise + line="7484">TRUE if the values were obtained, FALSE otherwise the spa pod parser object + line="7476">the spa pod parser object the variable arguments passed to wp_spa_pod_parser_get() + line="7477">the variable arguments passed to wp_spa_pod_parser_get() @@ -17335,19 +17411,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Increases the reference count of a spa pod parser. + line="7224">Increases the reference count of a spa pod parser. @self with an additional reference count on it + line="7233">@self with an additional reference count on it a spa pod sparser object + line="7226">a spa pod sparser object @@ -17355,7 +17431,7 @@ If the pod is an object or pointer, this will return the derived object/pointer Decreases the reference count on @self and frees it when the ref count reaches zero. + line="7237">Decreases the reference count on @self and frees it when the ref count reaches zero. @@ -17364,7 +17440,7 @@ If the pod is an object or pointer, this will return the derived object/pointer a spa pod parser object + line="7239">a spa pod parser object @@ -17378,19 +17454,19 @@ If the pod is an object or pointer, this will return the derived object/pointer Looks up the type id from a given type name. + line="7513">Looks up the type id from a given type name. the corresponding type id or WP_SPA_TYPE_INVALID if not found + line="7522">the corresponding type id or WP_SPA_TYPE_INVALID if not found the name to look up + line="7515">the name to look up @@ -17399,7 +17475,7 @@ If the pod is an object or pointer, this will return the derived object/pointer c:identifier="wp_spa_type_get_object_id_values_table"> Gets the table with the values that can be stored in the special "id" field of an object of the given @type. + line="7591">Gets the table with the values that can be stored in the special "id" field of an object of the given @type. Object pods (see WpSpaPod) always have a special "id" field along with other fields that can be defined. This "id" field can only store values of a specific SPA_TYPE_Id type. This function returns the table that contains the possible values for that field. @@ -17407,14 +17483,14 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie the table with the values that can be stored in the special "id" field of an object of the given @type + line="7601">the table with the values that can be stored in the special "id" field of an object of the given @type the type id of an object type + line="7593">the type id of an object type @@ -17423,19 +17499,19 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie c:identifier="wp_spa_type_get_values_table"> Gets the values table of an SPA type. + line="7605">Gets the values table of an SPA type. the associated WpSpaIdTable that contains possible values or object fields for this type, or NULL + line="7614">the associated WpSpaIdTable that contains possible values or object fields for this type, or NULL a type id + line="7607">a type id @@ -17443,19 +17519,19 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie Checks if an SPA type is a fundamental type. + line="7552">Checks if an SPA type is a fundamental type. TRUE if the @type has no parent, FALSE otherwise + line="7561">TRUE if the @type has no parent, FALSE otherwise a type id + line="7554">a type id @@ -17463,19 +17539,19 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie Checks if an SPA type is an Id type. + line="7565">Checks if an SPA type is an Id type. TRUE if the @type is a SPA_TYPE_Id, FALSE otherwise + line="7574">TRUE if the @type is a SPA_TYPE_Id, FALSE otherwise a type id + line="7567">a type id @@ -17483,19 +17559,19 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie Checks if an SPA type is an Object type. + line="7578">Checks if an SPA type is an Object type. TRUE if the @type is a SPA_TYPE_Object, FALSE otherwise + line="7587">TRUE if the @type is a SPA_TYPE_Object, FALSE otherwise a type id + line="7580">a type id @@ -17503,19 +17579,19 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie Gets the name of an SPA type. + line="7539">Gets the name of an SPA type. the complete name of the given @type or NULL if @type is invalid + line="7548">the complete name of the given @type or NULL if @type is invalid a type id + line="7541">a type id @@ -17523,19 +17599,19 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie Gets the parent type of an SPA type. + line="7526">Gets the parent type of an SPA type. the direct parent type of the given @type; if the type is fundamental (i.e. has no parent), the returned type is the same as @type + line="7535">the direct parent type of the given @type; if the type is fundamental (i.e. has no parent), the returned type is the same as @type a type id + line="7528">a type id @@ -17555,19 +17631,19 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie Constructs a new state object. + line="7871">Constructs a new state object. the new WpState + line="7880">the new WpState the state name + line="7873">the state name @@ -17575,7 +17651,7 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie Clears the state removing its file. + line="7910">Clears the state removing its file. @@ -17584,7 +17660,7 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie the state + line="7912">the state @@ -17592,19 +17668,19 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie Gets the location of a state object. + line="7897">Gets the location of a state object. the location of this state + line="7906">the location of this state the state + line="7899">the state @@ -17614,19 +17690,19 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie glib:get-property="name"> Gets the name of a state object. + line="7884">Gets the name of a state object. the name of this state + line="7893">the name of this state the state + line="7886">the state @@ -17634,7 +17710,7 @@ Object pods (see WpSpaPod) always have a special "id" field along with other fie Loads the state data from the file system. + line="7955">Loads the state data from the file system. This function will never fail. If it cannot load the state, for any reason, it will simply return an empty WpProperties, behaving as if there was no previous state stored. @@ -17642,14 +17718,14 @@ This function will never fail. If it cannot load the state, for any reason, it w a new WpProperties containing the state data + line="7965">a new WpProperties containing the state data the state + line="7957">the state @@ -17657,25 +17733,25 @@ This function will never fail. If it cannot load the state, for any reason, it w Saves new properties in the state, overwriting all previous data. + line="7922">Saves new properties in the state, overwriting all previous data. TRUE if the properties could be saved, FALSE otherwise + line="7933">TRUE if the properties could be saved, FALSE otherwise the state + line="7924">the state the properties to save + line="7925">the properties to save @@ -17685,7 +17761,7 @@ This function will never fail. If it cannot load the state, for any reason, it w version="0.5.0"> Saves new properties in the state, overwriting all previous data, after a timeout. + line="7937">Saves new properties in the state, overwriting all previous data, after a timeout. This is similar to wp_state_save() but it will save the state after a timeout has elapsed. If the state is saved again before the timeout elapses, the timeout is reset. @@ -17698,19 +17774,19 @@ This function is useful to avoid saving the state too often. When called consecu the state + line="7939">the state the core, used to add the timeout callback to the main loop + line="7940">the core, used to add the timeout callback to the main loop the properties to save. This object will be referenced and kept alive until the timeout elapses, but not deep copied. + line="7941">the properties to save. This object will be referenced and kept alive until the timeout elapses, but not deep copied. @@ -17756,7 +17832,7 @@ Typically, every step will start an asynchronous operation. Although it is possi Creates a WpTransition acting on @source_object. + line="7969">Creates a WpTransition acting on @source_object. When the transition is done, @callback will be invoked. @@ -17766,14 +17842,14 @@ The transition is automatically unref'ed after the @callback has been executed. the new transition + line="7987">the new transition the GType of the WpTransition subclass to instantiate + line="7971">the GType of the WpTransition subclass to instantiate the GObject that owns this task, or NULL + line="7972">the GObject that owns this task, or NULL optional GCancellable + line="7973">optional GCancellable a GAsyncReadyCallback + line="7974">a GAsyncReadyCallback user data passed to @callback + line="7975">user data passed to @callback @@ -17819,7 +17895,7 @@ The transition is automatically unref'ed after the @callback has been executed. Creates a WpTransition acting on @source_object. When the transition is done, @closure will be invoked. + line="7991">Creates a WpTransition acting on @source_object. When the transition is done, @closure will be invoked. The transition does not automatically start executing steps. You must call wp_transition_advance() after creating it in order to start it. @@ -17828,14 +17904,14 @@ Note that the transition is automatically unref'ed after the @closure has been e the new transition + line="8005">the new transition the GType of the WpTransition subclass to instantiate + line="7993">the GType of the WpTransition subclass to instantiate the GObject that owns this task, or NULL + line="7994">the GObject that owns this task, or NULL optional GCancellable + line="7995">optional GCancellable a GAsyncReadyCallback wrapped in a GClosure + line="7996">a GAsyncReadyCallback wrapped in a GClosure @@ -17870,7 +17946,7 @@ Note that the transition is automatically unref'ed after the @closure has been e Returns the final return status of the transition and its error, if there was one. + line="8157">Returns the final return status of the transition and its error, if there was one. This is meant to be called from within the GAsyncReadyCallback that was specified in wp_transition_new(). @@ -17878,14 +17954,14 @@ This is meant to be called from within the GAsyncReadyCallback that was specifie TRUE if the transition completed successfully, FALSE if there was an error + line="8168">TRUE if the transition completed successfully, FALSE if there was an error a transition, as a GAsyncResult + line="8159">a transition, as a GAsyncResult @@ -17921,7 +17997,7 @@ This is meant to be called from within the GAsyncReadyCallback that was specifie Advances the transition to the next step. + line="8123">Advances the transition to the next step. This initially calls _WpTransitionClass::get_next_step() in order to determine what the next step is. If _WpTransitionClass::get_next_step() returns a step different than the previous one, it calls _WpTransitionClass::execute_step() to execute it. @@ -17937,7 +18013,7 @@ In error conditions, _WpTransitionClass::execute_step() is called once with @ste the transition + line="8125">the transition @@ -17947,19 +18023,19 @@ In error conditions, _WpTransitionClass::execute_step() is called once with @ste glib:get-property="completed"> Checks if the transition completed. + line="8097">Checks if the transition completed. TRUE if the transition has completed (with or without an error), FALSE otherwise + line="8106">TRUE if the transition has completed (with or without an error), FALSE otherwise the transition + line="8099">the transition @@ -17967,7 +18043,7 @@ In error conditions, _WpTransitionClass::execute_step() is called once with @ste Gets @self 's data. + line="8067">Gets @self 's data. See wp_transition_set_data(). @@ -17975,14 +18051,14 @@ See wp_transition_set_data(). the transition's data + line="8079">the transition's data the transition + line="8069">the transition @@ -17991,7 +18067,7 @@ See wp_transition_set_data(). c:identifier="wp_transition_get_source_object"> Gets the source object from the transition. + line="8009">Gets the source object from the transition. Like g_async_result_get_source_object(), but does not ref the object. @@ -17999,14 +18075,14 @@ Like g_async_result_get_source_object(), but does not ref the object. the source object + line="8019">the source object the transition + line="8011">the transition @@ -18015,7 +18091,7 @@ Like g_async_result_get_source_object(), but does not ref the object. c:identifier="wp_transition_get_source_tag"> Gets @self 's source tag. + line="8037">Gets @self 's source tag. See wp_transition_set_source_tag(). @@ -18023,14 +18099,14 @@ See wp_transition_set_source_tag(). the transition's source tag + line="8049">the transition's source tag the transition + line="8039">the transition @@ -18038,19 +18114,19 @@ See wp_transition_set_source_tag(). Checks if the transition completed with an error. + line="8110">Checks if the transition completed with an error. TRUE if the transition completed with an error, FALSE otherwise + line="8119">TRUE if the transition completed with an error, FALSE otherwise the transition + line="8112">the transition @@ -18058,19 +18134,19 @@ See wp_transition_set_source_tag(). Checks if @self has the given @tag (generally a function pointer indicating the function @self was created by). + line="8023">Checks if @self has the given @tag (generally a function pointer indicating the function @self was created by). TRUE if @self has the indicated @tag , FALSE if not. + line="8033">TRUE if @self has the indicated @tag , FALSE if not. the transition + line="8025">the transition allow-none="1"> a tag + line="8026">a tag @@ -18087,7 +18163,7 @@ See wp_transition_set_source_tag(). Completes the transition with an error. + line="8140">Completes the transition with an error. This can be called anytime from within any virtual function or an async job handler. @@ -18100,13 +18176,13 @@ In most cases this will also unref the transition, so it is not safe to access i the transition + line="8142">the transition a GError + line="8143">a GError @@ -18114,7 +18190,7 @@ In most cases this will also unref the transition, so it is not safe to access i Sets @self 's data (freeing the existing data, if any). This can be an arbitrary user structure that holds data associated with this transition. + line="8083">Sets @self 's data (freeing the existing data, if any). This can be an arbitrary user structure that holds data associated with this transition. @@ -18123,7 +18199,7 @@ In most cases this will also unref the transition, so it is not safe to access i the transition + line="8085">the transition transition-specific user data + line="8086">transition-specific user data GDestroyNotify for @data + line="8087">GDestroyNotify for @data @@ -18151,7 +18227,7 @@ In most cases this will also unref the transition, so it is not safe to access i c:identifier="wp_transition_set_source_tag"> Sets @self 's source tag. + line="8053">Sets @self 's source tag. You can use this to tag a transition's return value with a particular pointer (usually a pointer to the function doing the tagging) and then later check it using wp_transition_get_source_tag() (or g_async_result_is_tagged()) in the transition's "finish" function, to figure out if the response came from a particular place. @@ -18163,7 +18239,7 @@ You can use this to tag a transition's return value with a particular pointer (u the transition + line="8055">the transition an opaque pointer indicating the source of this transition + line="8056">an opaque pointer indicating the source of this transition @@ -18345,7 +18421,7 @@ The iterator will iterate over the absolute paths of all the files files found, - + @@ -18354,7 +18430,7 @@ The iterator will iterate over the absolute paths of all the files files found, - + @@ -18367,7 +18443,7 @@ The iterator will iterate over the absolute paths of all the files files found, - + @@ -18376,7 +18452,7 @@ The iterator will iterate over the absolute paths of all the files files found, - + @@ -18385,7 +18461,7 @@ The iterator will iterate over the absolute paths of all the files files found, - + @@ -18398,7 +18474,7 @@ The iterator will iterate over the absolute paths of all the files files found, - + @@ -18418,12 +18494,12 @@ The iterator will iterate over the absolute paths of all the files files found, version="0.4.12"> Gets the WirePlumber library API version. + line="8199">Gets the WirePlumber library API version. WirePlumber library API version + line="8207">WirePlumber library API version @@ -18432,17 +18508,17 @@ The iterator will iterate over the absolute paths of all the files files found, version="0.4.12"> Gets the WirePlumber library version. + line="8185">Gets the WirePlumber library version. WirePlumber library version + line="8193">WirePlumber library version - + @@ -18451,7 +18527,7 @@ The iterator will iterate over the absolute paths of all the files files found, - + @@ -18464,7 +18540,7 @@ The iterator will iterate over the absolute paths of all the files files found, - + @@ -18475,7 +18551,7 @@ The iterator will iterate over the absolute paths of all the files files found, Initializes WirePlumber and PipeWire underneath. + line="8172">Initializes WirePlumber and PipeWire underneath. @flags can modify which parts are initialized, in cases where you want to handle part of this initialization externally. @@ -18487,7 +18563,7 @@ The iterator will iterate over the absolute paths of all the files files found, initialization flags + line="8174">initialization flags @@ -18497,7 +18573,7 @@ The iterator will iterate over the absolute paths of all the files files found, throws="1"> Matches the given properties against a set of rules described in JSON and calls the given callback to perform actions on a successful match. + line="1926">Matches the given properties against a set of rules described in JSON and calls the given callback to perform actions on a successful match. The given JSON should be an array of objects, where each object has a "matches" and an "actions" property. The "matches" value should also be an array of objects, where each object is a set of properties to match. Inside such an object, all properties must match to consider a successful match. However, if multiple objects are provided, only one object needs to match. @@ -18506,20 +18582,20 @@ The "actions" value should be an object where the key is the action name and the FALSE if an error occurred, TRUE otherwise + line="1941">FALSE if an error occurred, TRUE otherwise a JSON array containing rules in the described format + line="1928">a JSON array containing rules in the described format the properties to match against the rules + line="1929">the properties to match against the rules a function to call for each action on a successful match + line="1930">a function to call for each action on a successful match data to be passed to @callback + line="1931">data to be passed to @callback @@ -18549,25 +18625,25 @@ The "actions" value should be an object where the key is the action name and the c:identifier="wp_json_utils_match_rules_update_properties"> Matches the given properties against a set of rules described in JSON and updates the properties if the rule actions include the "update-props" action. + line="1945">Matches the given properties against a set of rules described in JSON and updates the properties if the rule actions include the "update-props" action. the number of properties that were updated + line="1955">the number of properties that were updated a JSON array containing rules in the format accepted by wp_json_utils_match_rules() + line="1947">a JSON array containing rules in the format accepted by wp_json_utils_match_rules() the properties to match against the rules and also update, acting on the "update-props" action + line="1948">the properties to match against the rules and also update, acting on the "update-props" action @@ -18576,7 +18652,7 @@ The "actions" value should be an object where the key is the action name and the c:identifier="wp_json_utils_merge_containers"> Merges two JSON containers (objects or arrays) into one. + line="1959">Merges two JSON containers (objects or arrays) into one. If both @a and @b are objects, the result will be a new object containing all properties from both @a and @b. If a property exists in both @a and @b, the values are recursively merged. If a property exists in both @a and @b and the property name starts with the "override." prefix in either of those, the value from the key with the prefix is used. @@ -18586,20 +18662,20 @@ If @a and @b are not of the same type, NULL is returned. a new JSON container containing the merged contents of @a and @b or NULL if @a and @b are not of the same type + line="1972">a new JSON container containing the merged contents of @a and @b or NULL if @a and @b are not of the same type a JSON container + line="1961">a JSON container a JSON container + line="1962">a JSON container @@ -18614,7 +18690,7 @@ If @a and @b are not of the same type, NULL is returned. - + @@ -18630,13 +18706,14 @@ If @a and @b are not of the same type, NULL is returned. + introspectable="0" + deprecated="1"> Used internally by the debug logging macros. Avoid using it directly. - + line="2086">Used internally by the debug logging macros. Avoid using it directly. + Use wp_logt_checked instead. -This assumes that the arguments are correct and that the log_topic is enabled for the given log_level. No additional checks are performed. +This assumes that the arguments are correct and that the log_topic is enabled for the given log_level. No additional checks are performed. @@ -18674,7 +18751,10 @@ This assumes that the arguments are correct and that the log_topic is enabled fo - + + private, called from wp_init() @@ -18699,7 +18779,7 @@ This assumes that the arguments are correct and that the log_topic is enabled fo WirePlumber's GLogWriterFunc. + line="2074">WirePlumber's GLogWriterFunc. This is installed automatically when you call wp_init() with WP_INIT_SET_GLIB_LOG set in the flags @@ -18725,8 +18805,54 @@ This is installed automatically when you call wp_init() with WP_INIT_SET_GLIB_LO + + Used internally by the debug logging macros. Avoid using it directly. + + +This assumes that the arguments are correct and that the log_topic is enabled for the given log_level. No additional checks are performed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -18735,7 +18861,7 @@ This is installed automatically when you call wp_init() with WP_INIT_SET_GLIB_LO - + @@ -18748,7 +18874,7 @@ This is installed automatically when you call wp_init() with WP_INIT_SET_GLIB_LO - + @@ -18760,7 +18886,7 @@ This is installed automatically when you call wp_init() with WP_INIT_SET_GLIB_LO c:identifier="wp_spa_dynamic_id_table_register"> Registers an additional WpSpaIdTable in the spa type system. + line="7842">Registers an additional WpSpaIdTable in the spa type system. This is useful to add custom enumeration types. @@ -18769,14 +18895,14 @@ Note that both @name and @values must be statically allocated, or otherwise guar the new table + line="7854">the new table the name of the id table + line="7844">the name of the id table an array of spa_type_info that contains the values of the table + line="7845">an array of spa_type_info that contains the values of the table @@ -18794,7 +18920,7 @@ Note that both @name and @values must be statically allocated, or otherwise guar c:identifier="wp_spa_dynamic_type_deinit"> Deinitializes the spa type registry. + line="7813">Deinitializes the spa type registry. You do not need to ever call this, unless you want to free memory at the end of the execution of a test, so that it doesn't show as leaked in the memory profiler. @@ -18807,7 +18933,7 @@ You do not need to ever call this, unless you want to free memory at the end of c:identifier="wp_spa_dynamic_type_init"> Initializes the spa dynamic type registry. + line="7800">Initializes the spa dynamic type registry. This allows registering new spa types at runtime. The spa type system still works if this function is not called. @@ -18821,7 +18947,7 @@ Normally called by wp_init() when WP_INIT_SPA_TYPES is passed in its flags. Registers an additional type in the spa type system. + line="7825">Registers an additional type in the spa type system. This is useful to add a custom pod object type. @@ -18830,20 +18956,20 @@ Note that both @name and @values must be statically allocated, or otherwise guar the new type + line="7838">the new type the name of the type + line="7827">the name of the type the parent type + line="7828">the parent type an array of spa_type_info that contains the values of the type, used only for Object types + line="7829">an array of spa_type_info that contains the values of the type, used only for Object types @@ -18861,25 +18987,25 @@ Note that both @name and @values must be statically allocated, or otherwise guar c:identifier="wp_spa_id_table_find_value"> Finds a value in an SPA Id table. + line="7646">Finds a value in an SPA Id table. the WpSpaIdValue associated with @value, or NULL + line="7656">the WpSpaIdValue associated with @value, or NULL the id table + line="7648">the id table a numeric value that is contained in the table + line="7649">a numeric value that is contained in the table @@ -18888,25 +19014,25 @@ Note that both @name and @values must be statically allocated, or otherwise guar c:identifier="wp_spa_id_table_find_value_from_name"> Finds a named value in an SPA Id table. + line="7660">Finds a named value in an SPA Id table. the WpSpaIdValue associated with @name, or NULL + line="7670">the WpSpaIdValue associated with @name, or NULL the id table + line="7662">the id table the full name of a value that is contained in the table + line="7663">the full name of a value that is contained in the table @@ -18915,25 +19041,25 @@ Note that both @name and @values must be statically allocated, or otherwise guar c:identifier="wp_spa_id_table_find_value_from_short_name"> Finds a short named value in an SPA Id table. + line="7674">Finds a short named value in an SPA Id table. the WpSpaIdValue associated with @short_name, or NULL + line="7684">the WpSpaIdValue associated with @short_name, or NULL the id table + line="7676">the id table the short name of a value that is contained in the table + line="7677">the short name of a value that is contained in the table @@ -18942,7 +19068,7 @@ Note that both @name and @values must be statically allocated, or otherwise guar c:identifier="wp_spa_id_table_from_name"> Finds a WpSpaIdTable given its name. + line="7618">Finds a WpSpaIdTable given its name. This name can either be the full type name of an object type, or the name of an enum (which is (!!) a type). For example, "Spa:Pod:Object:Param:Format" and "Spa:Enum:ParamId" are both valid table names. @@ -18950,14 +19076,14 @@ This name can either be the full type name of an object type, or the name of an the associated table, or NULL + line="7628">the associated table, or NULL the full name of an id table + line="7620">the full name of an id table @@ -18973,7 +19099,7 @@ This name can either be the full type name of an object type, or the name of an c:identifier="wp_spa_id_table_new_iterator"> This function returns an iterator that allows you to iterate through the values associated with this table. + line="7632">This function returns an iterator that allows you to iterate through the values associated with this table. The items in the iterator are of type WpSpaIdValue. @@ -18981,14 +19107,14 @@ The items in the iterator are of type WpSpaIdValue. a WpIterator that iterates over WpSpaIdValue items + line="7642">a WpIterator that iterates over WpSpaIdValue items the id table + line="7634">the id table @@ -18997,7 +19123,7 @@ The items in the iterator are of type WpSpaIdValue. c:identifier="wp_spa_id_value_array_get_item_type"> If the value type of @id is SPA_TYPE_Array, this function returns the type that is allowed to be contained inside the array. + line="7785">If the value type of @id is SPA_TYPE_Array, this function returns the type that is allowed to be contained inside the array. When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @table is set to point to the WpSpaIdTable that contains the possible Id values / object fields. @@ -19005,14 +19131,14 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ the type that is allowed in the array, if @id represents an object field that takes an array as value + line="7796">the type that is allowed in the array, if @id represents an object field that takes an array as value an id value + line="7787">an id value the associated WpSpaIdTable + line="7788">the associated WpSpaIdTable @@ -19032,7 +19158,7 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ c:identifier="wp_spa_id_value_from_name"> Looks up an id value (enum, flag or object field) directly from its full name. + line="7688">Looks up an id value (enum, flag or object field) directly from its full name. For instance, "Spa:Enum:Direction:Input" will resolve to the id value that represents "Input" in the "Spa:Enum:Direction" enum. @@ -19040,14 +19166,14 @@ For instance, "Spa:Enum:Direction:Input" will resolve to the id value that repre the id value for @name, or NULL if no such id value was found + line="7698">the id value for @name, or NULL if no such id value was found the full name of an id value + line="7690">the full name of an id value @@ -19056,25 +19182,25 @@ For instance, "Spa:Enum:Direction:Input" will resolve to the id value that repre c:identifier="wp_spa_id_value_from_number"> Looks up an id value given its container @table_name and its numeric representation, @id. + line="7716">Looks up an id value given its container @table_name and its numeric representation, @id. the id value or NULL if it was not found + line="7726">the id value or NULL if it was not found the name of the WpSpaIdTable to look up the value in + line="7718">the name of the WpSpaIdTable to look up the value in the numeric representation of the value to look up + line="7719">the numeric representation of the value to look up @@ -19083,25 +19209,25 @@ For instance, "Spa:Enum:Direction:Input" will resolve to the id value that repre c:identifier="wp_spa_id_value_from_short_name"> Looks up an id value given its container @table_name and its @short_name. + line="7702">Looks up an id value given its container @table_name and its @short_name. the id value or NULL if it was not found + line="7712">the id value or NULL if it was not found the name of the WpSpaIdTable to look up the value in + line="7704">the name of the WpSpaIdTable to look up the value in the short name of the value to look up + line="7705">the short name of the value to look up @@ -19117,7 +19243,7 @@ For instance, "Spa:Enum:Direction:Input" will resolve to the id value that repre c:identifier="wp_spa_id_value_get_value_type"> Returns the value type associated with this WpSpaIdValue. + line="7769">Returns the value type associated with this WpSpaIdValue. This information is useful when @id represents an object field, which can take a value of an arbitrary type. @@ -19126,14 +19252,14 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ the value type associated with @id + line="7781">the value type associated with @id an id value + line="7771">an id value the associated WpSpaIdTable + line="7772">the associated WpSpaIdTable @@ -19152,19 +19278,19 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ Gets the name of an id value. + line="7743">Gets the name of an id value. the full name of this id value + line="7752">the full name of this id value an id value + line="7745">an id value @@ -19172,19 +19298,19 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ Gets the numeric value of an id value. + line="7730">Gets the numeric value of an id value. the numeric representation of this id value + line="7739">the numeric representation of this id value an id value + line="7732">an id value @@ -19193,19 +19319,19 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ c:identifier="wp_spa_id_value_short_name"> Gets the short name of an id value. + line="7756">Gets the short name of an id value. the short name of this id value + line="7765">the short name of this id value an id value + line="7758">an id value @@ -19214,17 +19340,17 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ c:identifier="wp_spa_log_get_instance"> Gets WirePlumber's instance of spa_log - + line="2112">Gets WirePlumber's instance of spa_log + WirePlumber's instance of spa_log, which can be used to redirect PipeWire's log messages to the currently installed GLogWriterFunc. This is installed automatically when you call wp_init() with WP_INIT_SET_PW_LOG set in the flags + line="2120">WirePlumber's instance of spa_log, which can be used to redirect PipeWire's log messages to the currently installed GLogWriterFunc. This is installed automatically when you call wp_init() with WP_INIT_SET_PW_LOG set in the flags - + @@ -19233,7 +19359,7 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ - + @@ -19246,7 +19372,7 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ - + @@ -19257,7 +19383,7 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ - + @@ -19266,7 +19392,7 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ - + @@ -19279,7 +19405,7 @@ When the returned type is (or is derived from) SPA_TYPE_Id or SPA_TYPE_Object, @ - + diff --git a/girs/Xdp-1.0.gir b/girs/Xdp-1.0.gir index 3cef0cefa..c03d7ef6c 100644 --- a/girs/Xdp-1.0.gir +++ b/girs/Xdp-1.0.gir @@ -644,25 +644,25 @@ object with [ctor@Portal.new] and use it throughout its lifetime. throws="1"> Creates a new [class@Portal] object. + line="345">Creates a new [class@Portal] object. a newly created [class@Portal] object or NULL on error + line="351">a newly created [class@Portal] object or NULL on error Creates a new [class@Portal] object. If D-Bus is unavailable this API will abort. + line="359">Creates a new [class@Portal] object. If D-Bus is unavailable this API will abort. We recommend using xdp_portal_initable_new() to safely handle this failure. a newly created [class@Portal] object + line="365">a newly created [class@Portal] object @@ -670,14 +670,14 @@ We recommend using xdp_portal_initable_new() to safely handle this failure. Detects if running inside of a Flatpak or WebKit sandbox. + line="469">Detects if running inside of a Flatpak or WebKit sandbox. See also: [func@Portal.running_under_sandbox]. %TRUE if the current process is running under a Flatpak sandbox + line="476">%TRUE if the current process is running under a Flatpak sandbox @@ -685,7 +685,7 @@ See also: [func@Portal.running_under_sandbox]. c:identifier="xdp_portal_running_under_sandbox"> This function tries to determine if the current process is running under a + line="526">This function tries to determine if the current process is running under a sandbox that requires the use of portals. If you need to check error conditions see [func@Portal.running_under_snap]. @@ -695,7 +695,7 @@ Note that these functions are all cached and will always return the same result. %TRUE if the current process should use portals to access resources + line="536">%TRUE if the current process should use portals to access resources on the host system, or %FALSE if either an error was encountered or the process is running unsandboxed @@ -706,14 +706,14 @@ Note that these functions are all cached and will always return the same result. throws="1"> Detects if you are running inside of a Snap sandbox. + line="499">Detects if you are running inside of a Snap sandbox. See also: [func@Portal.running_under_sandbox]. %TRUE if the current process is running under a Snap sandbox, or + line="507">%TRUE if the current process is running under a Snap sandbox, or %FALSE if either unsandboxed or an error was encountered in which case @error will be set @@ -4131,7 +4131,7 @@ Returns the result in the form of boolean. Emitted when location monitoring is enabled and the location changes. + line="223">Emitted when location monitoring is enabled and the location changes. @@ -4139,55 +4139,55 @@ Returns the result in the form of boolean. the latitude, in degrees + line="226">the latitude, in degrees the longitude, in degrees + line="227">the longitude, in degrees the altitude, in meters + line="228">the altitude, in meters the accuracy, in meters + line="229">the accuracy, in meters the speed, in meters per second + line="230">the speed, in meters per second the heading, in degrees + line="231">the heading, in degrees the description + line="232">the description the timestamp seconds since the Unix epoch + line="233">the timestamp seconds since the Unix epoch the microseconds fraction of the timestamp + line="234">the microseconds fraction of the timestamp @@ -4195,7 +4195,7 @@ Returns the result in the form of boolean. Emitted when a non-exported action is activated on a notification. + line="256">Emitted when a non-exported action is activated on a notification. @@ -4203,13 +4203,13 @@ Returns the result in the form of boolean. the notification ID + line="259">the notification ID the action name + line="260">the action name allow-none="1"> the target parameter for the action + line="261">the target parameter for the action @@ -4226,7 +4226,7 @@ Returns the result in the form of boolean. Emitted when session state monitoring is + line="145">Emitted when session state monitoring is enabled and the state of the login session changes or the screensaver is activated or deactivated. @@ -4236,13 +4236,13 @@ the screensaver is activated or deactivated. whether the screensaver is active + line="148">whether the screensaver is active the current state of the login session + line="149">the current state of the login session @@ -4250,7 +4250,7 @@ the screensaver is activated or deactivated. Emitted when a process that was spawned with [method@Portal.spawn] exits. + line="127">Emitted when a process that was spawned with [method@Portal.spawn] exits. @@ -4258,13 +4258,13 @@ the screensaver is activated or deactivated. the pid of the process + line="130">the pid of the process the exit status of the process + line="131">the exit status of the process @@ -4272,7 +4272,7 @@ the screensaver is activated or deactivated. Emitted when updates monitoring is enabled + line="165">Emitted when updates monitoring is enabled and a new update is available. It is only sent once with the same information, but it can be sent many @@ -4284,20 +4284,20 @@ times if new updates appear. the commit that the sandbox is running with + line="168">the commit that the sandbox is running with the commit that is currently deployed. Restarting + line="169">the commit that is currently deployed. Restarting the app will use this commit the commit that is available as an update. + line="171">the commit that is available as an update. Updating the app will deloy this commit @@ -4306,7 +4306,7 @@ times if new updates appear. Emitted to indicate progress of an update installation. + line="191">Emitted to indicate progress of an update installation. It is undefined exactly how often it is sent, but it will be emitted at least once at the end with a non-zero @status. For each successful @@ -4319,38 +4319,38 @@ with @progress 100. the number of operations that the update consists of + line="194">the number of operations that the update consists of the position of the currently active operation + line="195">the position of the currently active operation the progress of the currently active operation, as + line="196">the progress of the currently active operation, as a number between 0 and 100 the overall status of the update + line="198">the overall status of the update the error name if the status is 'failed' + line="199">the error name if the status is 'failed' the error message if the status is 'failed' + line="200">the error message if the status is 'failed' diff --git a/girs/Xkl-1.0.gir b/girs/Xkl-1.0.gir index 3ae92edbb..aa5f53745 100644 --- a/girs/Xkl-1.0.gir +++ b/girs/Xkl-1.0.gir @@ -15,6 +15,87 @@ and/or use gtk-doc annotations. --> shared-library="libxklavier.so.16" c:identifier-prefixes="Xkl" c:symbol-prefixes="xkl"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + glib:type-name="XklConfigItem" glib:get-type="xkl_config_item_get_type" glib:type-struct="ConfigItemClass"> + - Create new XklConfigItem + Create new XklConfigItem + - new instance + new instance + - The @description field of a XklConfigItem. This is mostly useful for + The @description field of a XklConfigItem. This is mostly useful for language bindings, in C you can manipulate the member directly. - the XklConfigItem object + the XklConfigItem object + - The @name field of a XklConfigItem. This is mostly useful for + The @name field of a XklConfigItem. This is mostly useful for language bindings, in C you can manipulate the member directly. - the XklConfigItem object + the XklConfigItem object + - The @short_description field of a XklConfigItem. This is mostly useful for + The @short_description field of a XklConfigItem. This is mostly useful for language bindings, in C you can manipulate the member directly. - the XklConfigItem object + the XklConfigItem object - Change the @description field of a XklConfigItem. This is mostly useful for + Change the @description field of a XklConfigItem. This is mostly useful for language bindings, in C you can manipulate the member directly. + - the XklConfigItem object to be changed + the XklConfigItem object to be changed - Description (max. 192 + Description (max. 192 characters); can be NULL. - Change the @name field of a XklConfigItem. This is mostly useful for + Change the @name field of a XklConfigItem. This is mostly useful for language bindings, in C you can manipulate the member directly. + - the XklConfigItem object to be changed + the XklConfigItem object to be changed - Name (max. 32 characters); can be NULL. + Name (max. 32 characters); can be NULL. - Change the @short_description field of a XklConfigItem. This is mostly useful for + Change the @short_description field of a XklConfigItem. This is mostly useful for language bindings, in C you can manipulate the member directly. + - the XklConfigItem object to be changed + the XklConfigItem object to be changed - Short Description (max. 10 + Short Description (max. 10 characters); can be NULL. @@ -138,17 +261,17 @@ language bindings, in C you can manipulate the member directly. - + - + - + @@ -156,26 +279,39 @@ language bindings, in C you can manipulate the member directly. + - Callback type used for enumerating keyboard models, layouts, variants, options + Callback type used for enumerating keyboard models, layouts, variants, options + - the config registry + the config registry - the item from registry + the item from registry - - anything which can be stored into the pointer + + anything which can be stored into the pointer @@ -187,207 +323,301 @@ language bindings, in C you can manipulate the member directly. glib:type-name="XklConfigRec" glib:get-type="xkl_config_rec_get_type" glib:type-struct="ConfigRecClass"> + - Create new XklConfigRec + Create new XklConfigRec + - new instance + new instance - Writes some XKB configuration into XKM/XKB/... file - - TRUE on success + Writes some XKB configuration into XKM/XKB/... file + + + TRUE on success - the engine + the engine - name of the file to create + name of the file to create - valid XKB configuration + valid XKB configuration description. Can be NULL - flag indicating whether the output file should be binary + flag indicating whether the output file should be binary - Activates some XKB configuration + Activates some XKB configuration description. Can be NULL + - TRUE on success + TRUE on success - valid XKB configuration + valid XKB configuration - the engine + the engine - Compares two records - - TRUE if records are same + Compares two records + + + TRUE if records are same - record to compare + record to compare - another record + another record - Loads the current XKB configuration (from backup) - - TRUE on success + Loads the current XKB configuration (from backup) + + + TRUE on success - buffer for XKB configuration + buffer for XKB configuration - the engine + the engine - Gets the XKB configuration from any root window property - - TRUE on success + Gets the XKB configuration from any root window property + + + TRUE on success - buffer to hold the result + buffer to hold the result - atom name of the root window property to read + atom name of the root window property to read - pointer to hold the file name + pointer to hold the file name - the engine + the engine - Loads the current XKB configuration (from X server) - - TRUE on success + Loads the current XKB configuration (from X server) + + + TRUE on success - buffer for XKB configuration + buffer for XKB configuration - the engine + the engine - Resets the record (equal to Destroy and Init) + Resets the record (equal to Destroy and Init) + - record to reset + record to reset - Sets a new layout list. + Sets a new layout list. Frees the previous layout list. This is primarily useful for bindings, in C you can manipulate the @layouts record member directly. + - record to change + record to change - zero terminated + zero terminated list of new layout names. - + - Sets a new model. + Sets a new model. Frees the previous model. This is primarily useful for bindings, in C you can manipulate the @model record member directly. + - record to change + record to change - new keyboard name. + new keyboard name. - Sets a new option list. + Sets a new option list. Frees the previous option list. This is primarily useful for bindings, in C you can manipulate the @options record member directly. + - record to change + record to change - zero terminated + zero terminated list of new option names. - + @@ -395,47 +625,67 @@ list of new option names. - Saves the XKB configuration into any root window property - - TRUE on success + Saves the XKB configuration into any root window property + + + TRUE on success - configuration to save + configuration to save - atom name of the root window property to write + atom name of the root window property to write - rules file name + rules file name - the engine + the engine - Sets a new variant list. + Sets a new variant list. Frees the previous variant list. This is primarily useful for bindings, in C you can manipulate the @variants record member directly. + - record to change + record to change - zero terminated + zero terminated list of new variant names. - + @@ -466,6 +716,7 @@ list of new variant names. + @@ -477,16 +728,24 @@ list of new variant names. glib:type-name="XklConfigRegistry" glib:get-type="xkl_config_registry_get_type" glib:type-struct="ConfigRegistryClass"> + - Create new XklConfig - - new instance + Create new XklConfig + + + new instance - the engine to use for accessing X in all the operations + the engine to use for accessing X in all the operations (like accessing root window properties etc) @@ -494,36 +753,54 @@ list of new variant names. - Loads a keyboard layout information from the XML configuration registry. - - TRUE if appropriate element was found and loaded + Loads a keyboard layout information from the XML configuration registry. + + + TRUE if appropriate element was found and loaded - the config registry + the config registry - pointer to a XklConfigItem containing the name of the + pointer to a XklConfigItem containing the name of the keyboard layout. On successfull return, the descriptions are filled. - Loads a keyboard model information from the XML configuration registry. - - TRUE if appropriate element was found and loaded + Loads a keyboard model information from the XML configuration registry. + + + TRUE if appropriate element was found and loaded - the config registry + the config registry - pointer to a XklConfigItem containing the name of the + pointer to a XklConfigItem containing the name of the keyboard model. On successfull return, the descriptions are filled. @@ -531,23 +808,34 @@ keyboard model. On successfull return, the descriptions are filled. - Loads a keyboard option information from the XML configuration + Loads a keyboard option information from the XML configuration registry. + - TRUE if appropriate element was found and loaded + TRUE if appropriate element was found and loaded - the config registry + the config registry - name of the option group + name of the option group - pointer to a XklConfigItem containing the name of the + pointer to a XklConfigItem containing the name of the keyboard option. On successfull return, the descriptions are filled. @@ -555,19 +843,28 @@ keyboard option. On successfull return, the descriptions are filled. - Loads a keyboard option group information from the XML configuration + Loads a keyboard option group information from the XML configuration registry. + - TRUE if appropriate element was found and loaded + TRUE if appropriate element was found and loaded - the config registry + the config registry - pointer to a XklConfigItem containing the name of the + pointer to a XklConfigItem containing the name of the keyboard option group. On successfull return, the descriptions are filled. @@ -575,23 +872,34 @@ keyboard option group. On successfull return, the descriptions are filled. - Loads a keyboard layout variant information from the XML configuration + Loads a keyboard layout variant information from the XML configuration registry. + - TRUE if appropriate element was found and loaded + TRUE if appropriate element was found and loaded - the config registry + the config registry - name of the parent layout + name of the parent layout - pointer to a XklConfigItem containing the name of the + pointer to a XklConfigItem containing the name of the keyboard layout variant. On successfull return, the descriptions are filled. @@ -599,208 +907,305 @@ keyboard layout variant. On successfull return, the descriptions are filled. - Enumerates countries for which layouts are available, + Enumerates countries for which layouts are available, from the XML configuration registry + - the config registry + the config registry - callback to call for every ISO 3166 country code + callback to call for every ISO 3166 country code - - anything which can be stored into the pointer + + anything which can be stored into the pointer - Enumerates keyboard layout variants for the country, + Enumerates keyboard layout variants for the country, from the XML configuration registry + - the config registry + the config registry - country ISO code for which variants will be listed + country ISO code for which variants will be listed - callback to call for every country variant + callback to call for every country variant - - anything which can be stored into the pointer + + anything which can be stored into the pointer - Enumerates languages for which layouts are available, + Enumerates languages for which layouts are available, from the XML configuration registry + - the config registry + the config registry - callback to call for every ISO 639-2 country code + callback to call for every ISO 639-2 country code - - anything which can be stored into the pointer + + anything which can be stored into the pointer - Enumerates keyboard layout variants for the language, + Enumerates keyboard layout variants for the language, from the XML configuration registry + - the config registry + the config registry - language ISO code for which variants will be listed + language ISO code for which variants will be listed - callback to call for every country variant + callback to call for every country variant - - anything which can be stored into the pointer + + anything which can be stored into the pointer - Enumerates keyboard layouts from the XML configuration registry + Enumerates keyboard layouts from the XML configuration registry + - the config registry + the config registry - callback to call for every layout + callback to call for every layout - - anything which can be stored into the pointer + + anything which can be stored into the pointer - Enumerates keyboard layout variants from the XML configuration registry + Enumerates keyboard layout variants from the XML configuration registry + - the config registry + the config registry - layout name for which variants will be listed + layout name for which variants will be listed - callback to call for every layout variant + callback to call for every layout variant - - anything which can be stored into the pointer + + anything which can be stored into the pointer - Enumerates keyboard models from the XML configuration registry + Enumerates keyboard models from the XML configuration registry + - the config registry + the config registry - callback to call for every model + callback to call for every model - - anything which can be stored into the pointer + + anything which can be stored into the pointer - Enumerates keyboard options from the XML configuration registry + Enumerates keyboard options from the XML configuration registry + - the config registry + the config registry - option group name for which variants + option group name for which variants will be listed @@ -808,55 +1213,83 @@ will be listed transfer-ownership="none" scope="call" closure="2"> - callback to call for every option + callback to call for every option - - anything which can be stored into the pointer + + anything which can be stored into the pointer - Enumerates keyboard option groups from the XML configuration registry + Enumerates keyboard option groups from the XML configuration registry + - the config registry + the config registry - callback to call for every option group + callback to call for every option group - - anything which can be stored into the pointer + + anything which can be stored into the pointer - Loads XML configuration registry. The name is taken from X server + Loads XML configuration registry. The name is taken from X server (for XKB/libxkbfile, from the root window property) + - TRUE on success + TRUE on success - the config registry + the config registry - whether exotic materials (layouts, options) + whether exotic materials (layouts, options) should be loaded as well @@ -864,33 +1297,47 @@ should be loaded as well - Enumerates keyboard layout/variants that match the pattern. + Enumerates keyboard layout/variants that match the pattern. The layout/variant is considered as matching if one of the following is true: 1. Country description (from the country list or name) contains pattern as substring 2. Language description (from the language list or name) contains pattern as substring + - the config registry + the config registry - pattern to search for (NULL means "all") + pattern to search for (NULL means "all") - callback to call for every matching layout/variant + callback to call for every matching layout/variant - - anything which can be stored into the pointer + + anything which can be stored into the pointer @@ -911,14 +1358,42 @@ is true: + + disguised="1" + opaque="1"> + + + + + + + + + + + + + + + + + + + + + + + + @@ -943,16 +1420,23 @@ is true: - + - + + @@ -969,28 +1453,42 @@ is true: - + - + - Get the instance of the XklEngine. Within a process, there is always once instance. - - the singleton instance + Get the instance of the XklEngine. Within a process, there is always once instance. + + + the singleton instance - the X display used by the application + the X display used by the application + @@ -1001,6 +1499,7 @@ is true: + @@ -1011,6 +1510,7 @@ is true: + @@ -1027,6 +1527,7 @@ is true: + @@ -1047,153 +1548,223 @@ is true: - Allows to switch (once) to the secondary group + Allows to switch (once) to the secondary group + - the engine + the engine - Backups current XKB configuration into some property - + Backups current XKB configuration into some property - if this property is not defined yet. + - TRUE on success + TRUE on success - the engine + the engine - Drops the state of a given window (of its "App window"). + Drops the state of a given window (of its "App window"). + - the engine + the engine - target window + target window - Processes X events. Should be included into the main event cycle of an + Processes X events. Should be included into the main event cycle of an application. One of the most important functions. + - 0 if the event it processed - 1 otherwise + 0 if the event it processed - 1 otherwise - the engine + the engine - delivered X event + delivered X event - What kind of backend is used - - some string id of the backend + What kind of backend is used + + + some string id of the backend - the engine + the engine + - current state of the keyboard. + current state of the keyboard. Returned value is a statically allocated buffer, should not be freed. - the engine + the engine + - currently focused window + currently focused window - the engine + the engine + - saved group id of the current window. + saved group id of the current window. - the engine + the engine - Returns the default group set on window creation + c:identifier="xkl_engine_get_default_group" + glib:get-property="default-group"> + Returns the default group set on window creation If -1, no default group is used + - the default group + the default group - the engine + the engine - - Provides information regarding available backend features + + Provides information regarding available backend features (combination of XKLF_* constants) + - ORed XKLF_* constants + ORed XKLF_* constants - the engine + the engine + - the array of group names for the current XKB + the array of group names for the current XKB configuration (keyboard). This array is static, should not be freed @@ -1202,28 +1773,39 @@ This array is static, should not be freed - the engine + the engine + c:identifier="xkl_engine_get_indicators_handling" + glib:get-property="indicators-handling"> + - the value of the parameter: perform indicator handling + the value of the parameter: perform indicator handling - the engine + the engine + - the array of indicator names for the current XKB + the array of indicator names for the current XKB configuration (keyboard). This array is static, should not be freed @@ -1232,405 +1814,587 @@ This array is static, should not be freed - the engine + the engine - Provides the information on maximum number of simultaneously supported + c:identifier="xkl_engine_get_max_num_groups" + glib:get-property="max-num-groups"> + Provides the information on maximum number of simultaneously supported groups (layouts) + - maximum number of the groups in configuration, + maximum number of the groups in configuration, 0 if no restrictions. - the engine + the engine - Calculates next group id. Does not change the state of anything. - - next group id + Calculates next group id. Does not change the state of anything. + + + next group id - the engine + the engine - + + - the total number of groups in the current configuration + the total number of groups in the current configuration (keyboard) - the engine + the engine - Calculates prev group id. Does not change the state of anything. - - prev group id + Calculates prev group id. Does not change the state of anything. + + + prev group id - the engine + the engine + c:identifier="xkl_engine_get_secondary_groups_mask" + glib:get-property="secondary-groups-mask"> + - the secondary group mask + the secondary group mask - the engine + the engine - Finds the state for a given window (for its "App window"). - - TRUE on success, otherwise FALSE + Finds the state for a given window (for its "App window"). + + + TRUE on success, otherwise FALSE (the error message can be obtained using xkl_GetLastError). - the engine + the engine - window to query + window to query - structure to store the state + structure to store the state + - the window title of some window or NULL. + the window title of some window or NULL. If not NULL, it should be freed with XFree - the engine + the engine - X window + X window - Grabs some key - - TRUE on success + Grabs some key + + + TRUE on success - the engine + the engine - keycode + keycode - bitmask of modifiers + bitmask of modifiers + - the value of the parameter: group per application + the value of the parameter: group per application - the engine + the engine - Checks whether 2 windows have the same topmost window - - TRUE is windows are in the same application + Checks whether 2 windows have the same topmost window + + + TRUE is windows are in the same application - the engine + the engine - first window + first window - second window + second window + - TRUE if the window is "transparent" + TRUE if the window is "transparent" - the engine + the engine - window to get the transparent flag from. + window to get the transparent flag from. - Locks the group. Can be used after xkl_GetXXXGroup functions + Locks the group. Can be used after xkl_GetXXXGroup functions + - the engine + the engine - group number for locking + group number for locking - Temporary pauses listening for XKB-related events + Temporary pauses listening for XKB-related events + - 0 + 0 - the engine + the engine - Resumes listening for XKB-related events + Resumes listening for XKB-related events + - 0 + 0 - the engine + the engine - Stores ths state for a given window + Stores ths state for a given window + - the engine + the engine - target window + target window - new state of the window + new state of the window - Configures the default group set on window creation. + Configures the default group set on window creation. If -1, no default group is used + - the engine + the engine - default group + default group - Sets the configuration parameter: group per application + Sets the configuration parameter: group per application + - the engine + the engine - new parameter value + new parameter value - Sets the configuration parameter: perform indicators handling + Sets the configuration parameter: perform indicators handling + - the engine + the engine - new parameter value + new parameter value - Sets the secondary groups (one bit per group). + Sets the secondary groups (one bit per group). Secondary groups require explicit "allowance" for switching + - the engine + the engine - new group mask + new group mask - Sets the "transparent" flag. It means focus switching onto + Sets the "transparent" flag. It means focus switching onto this window will never change the state. + - the engine + the engine - window do set the flag for. + window do set the flag for. - if true, the windows is transparent. + if true, the windows is transparent. - Starts listening for XKB-related events + Starts listening for XKB-related events + - 0 + 0 - the engine + the engine - any combination of XKLL_* constants + any combination of XKLL_* constants - Stops listening for XKB-related events + Stops listening for XKB-related events + - 0 + 0 - the engine + the engine - any combination of XKLL_* constants + any combination of XKLL_* constants - Ungrabs some key - - TRUE on success + Ungrabs some key + + + TRUE on success - the engine + the engine - keycode + keycode - bitmask of modifiers + bitmask of modifiers - + - + transfer-ownership="none"> - + - + - + - + - + @@ -1703,11 +2482,13 @@ this window will never change the state. + + @@ -1720,6 +2501,7 @@ this window will never change the state. + @@ -1738,6 +2520,7 @@ this window will never change the state. + @@ -1759,6 +2542,7 @@ this window will never change the state. + @@ -1774,118 +2558,246 @@ this window will never change the state. glib:type-name="XklEngineFeatures" glib:get-type="xkl_engine_features_get_type" c:type="XklEngineFeatures"> - A set of flags used to indicate the capabilities of the active backend + A set of flags used to indicate the capabilities of the active backend - Backend allows to toggls indicators on/off + glib:nick="can-toggle-indicators" + glib:name="XKLF_CAN_TOGGLE_INDICATORS"> + Backend allows to toggls indicators on/off - Backend allows writing ASCII representation of the configuration + glib:nick="can-output-config-as-ascii" + glib:name="XKLF_CAN_OUTPUT_CONFIG_AS_ASCII"> + Backend allows writing ASCII representation of the configuration - Backend allows writing binary representation of the configuration + glib:nick="can-output-config-as-binary" + glib:name="XKLF_CAN_OUTPUT_CONFIG_AS_BINARY"> + Backend allows writing binary representation of the configuration - Backend supports multiple layouts + glib:nick="multiple-layouts-supported" + glib:name="XKLF_MULTIPLE_LAYOUTS_SUPPORTED"> + Backend supports multiple layouts - Backend requires manual configuration, some daemon should do + glib:nick="requires-manual-layout-management" + glib:name="XKLF_REQUIRES_MANUAL_LAYOUT_MANAGEMENT"> + Backend requires manual configuration, some daemon should do xkl_start_listen(engine,XKLL_MANAGE_LAYOUTS); - Backend supports device discovery, can notify + glib:nick="device-discovery" + glib:name="XKLF_DEVICE_DISCOVERY"> + Backend supports device discovery, can notify - The listener action modes: + The listener action modes: - The listener process should handle the per-window states + glib:nick="manage-window-states" + glib:name="XKLL_MANAGE_WINDOW_STATES"> + The listener process should handle the per-window states and all the related activity - Just track the state and pass it to the application above. + glib:nick="track-keyboard-state" + glib:name="XKLL_TRACK_KEYBOARD_STATE"> + Just track the state and pass it to the application above. - The listener process should help backend to maintain the configuration + glib:nick="manage-layouts" + glib:name="XKLL_MANAGE_LAYOUTS"> + The listener process should help backend to maintain the configuration (manually switch layouts etc). - + + - The type of the keyboard state change + The type of the keyboard state change - Group was changed + glib:nick="group-changed" + glib:name="GROUP_CHANGED"> + Group was changed - Indicators were changed + glib:nick="indicators-changed" + glib:name="INDICATORS_CHANGED"> + Indicators were changed + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - Custom log output method for _xkl_debug. This appender is NOT called if the + Custom log output method for _xkl_debug. This appender is NOT called if the level of the message is greater than currently set debug level. + - name of the source file. + name of the source file. Preprocessor symbol__FILE__ should be used here - + - name of the function + name of the function Preprocessor symbol__func__ should be used here - + - level of the message + level of the message - format (like in printf) - + format (like in printf) + - list of parameters + list of parameters @@ -1893,16 +2805,19 @@ Preprocessor symbol__func__ should be used here + + + glib:type-name="XklState" glib:get-type="xkl_state_get_type" c:symbol-prefix="state"> + @@ -1919,115 +2835,186 @@ Preprocessor symbol__func__ should be used here - Callback type used for enumerating layouts/variants for countries/languages + Callback type used for enumerating layouts/variants for countries/languages + - the config registry + the config registry - the item from registry + the item from registry - the item from registry + the item from registry - - anything which can be stored into the pointer + + anything which can be stored into the pointer + + Output (optionally) some debug info + + + + level of the message + + + + + - Default log output method. Sends everything to stdout. + Default log output method. Sends everything to stdout. + - name of the source file. + name of the source file. Preprocessor symbol__FILE__ should be used here - + - name of the function + name of the function Preprocessor symbol__func__ should be used here - + - level of the message + level of the message - format (like in printf) - + format (like in printf) + - list of parameters + list of parameters - Get localized country name, from ISO code + Get localized country name, from ISO code + - localized country name (USA, Russia, France, ... translated) + localized country name (USA, Russia, France, ... translated) - ISO 3166 Alpha 2 code: 2 chars, uppercase (US, RU, FR, ...) + ISO 3166 Alpha 2 code: 2 chars, uppercase (US, RU, FR, ...) - Get localized language name, from ISO code + Get localized language name, from ISO code + - localized country name (English, Russiam, French, ... translated) + localized country name (English, Russiam, French, ... translated) - ISO 639 2B or 2T code: 3 chars, lowercase (eng, rus, fra, ...) + ISO 639 2B or 2T code: 3 chars, lowercase (eng, rus, fra, ...) + - the text message (statically allocated) of the last error + the text message (statically allocated) of the last error - Restores XKB from the property saved by xkl_backup_names_prop + Restores XKB from the property saved by xkl_backup_names_prop + - TRUE on success + TRUE on success - the engine + the engine - Sets maximum debug level. + Sets maximum debug level. Message of the level more than the one set here - will be ignored + - new debug level + new debug level @@ -2035,13 +3022,18 @@ Message of the level more than the one set here - will be ignored - Installs the custom log appender.function + Installs the custom log appender.function + - new log appender + new log appender diff --git a/girs/Xmlb-2.0.gir b/girs/Xmlb-2.0.gir index be2d79a0f..0bb50a249 100644 --- a/girs/Xmlb-2.0.gir +++ b/girs/Xmlb-2.0.gir @@ -14,7 +14,7 @@ and/or use gtk-doc annotations. --> version="2.0" shared-library="libxmlb.so.2" c:identifier-prefixes="Xb" - c:symbol-prefixes="xb"> + c:symbol-prefixes="xb,xmlb,libxmlb"> Creates a new builder. + line="1148">Creates a new builder. The #XbSilo returned by the methods of this #XbBuilder will use the thread-default main context at the time of calling this function for its @@ -35,7 +35,7 @@ future signal emissions. a new #XbBuilder + line="1157">a new #XbBuilder @@ -44,7 +44,7 @@ future signal emissions. version="0.1.3"> Adds a function that will get run on every #XbBuilderNode compile creates + line="1089">Adds a function that will get run on every #XbBuilderNode compile creates for the silo. This is run after all the #XbBuilderSource fixups have been run. @@ -55,13 +55,13 @@ run. a #XbBuilder + line="1091">a #XbBuilder a #XbBuilderFixup + line="1092">a #XbBuilderFixup @@ -97,7 +97,7 @@ locales added later. version="0.1.0"> Adds the GUID to the internal correctness hash. + line="1054">Adds the GUID to the internal correctness hash. @@ -106,13 +106,13 @@ locales added later. a #XbSilo + line="1056">a #XbSilo any text, typcically a filename or GUID + line="1057">any text, typcically a filename or GUID @@ -123,25 +123,25 @@ locales added later. throws="1"> Compiles a #XbSilo. + line="732">Compiles a #XbSilo. a #XbSilo, or %NULL for error + line="741">a #XbSilo, or %NULL for error a #XbSilo + line="734">a #XbSilo some #XbBuilderCompileFlags, e.g. %XB_BUILDER_SOURCE_FLAG_LITERAL_TEXT + line="735">some #XbBuilderCompileFlags, e.g. %XB_BUILDER_SOURCE_FLAG_LITERAL_TEXT allow-none="1"> a #GCancellable, or %NULL + line="736">a #GCancellable, or %NULL @@ -161,7 +161,7 @@ locales added later. throws="1"> Ensures @file is up to date, and returns a compiled #XbSilo. + line="954">Ensures @file is up to date, and returns a compiled #XbSilo. If @silo is being used by a query (e.g. in another thread) then all node data is immediately invalid. @@ -172,26 +172,26 @@ calling this function for its future signal emissions. a #XbSilo, or %NULL for error + line="970">a #XbSilo, or %NULL for error a #XbSilo + line="956">a #XbSilo a #GFile + line="957">a #GFile some #XbBuilderCompileFlags, e.g. %XB_BUILDER_COMPILE_FLAG_IGNORE_INVALID + line="958">some #XbBuilderCompileFlags, e.g. %XB_BUILDER_COMPILE_FLAG_IGNORE_INVALID allow-none="1"> a #GCancellable, or %NULL + line="959">a #GCancellable, or %NULL @@ -245,7 +245,7 @@ Failure to include an appropriate GUID value would allow an out-of-data silo to version="0.1.0"> Adds a #XbBuilderSource to the #XbBuilder. + line="179">Adds a #XbBuilderSource to the #XbBuilder. @@ -254,13 +254,13 @@ Failure to include an appropriate GUID value would allow an out-of-data silo to a #XbSilo + line="181">a #XbSilo a #XbBuilderSource + line="182">a #XbBuilderSource @@ -270,7 +270,7 @@ Failure to include an appropriate GUID value would allow an out-of-data silo to version="0.1.1"> Enables or disables the collection of profiling data. + line="1072">Enables or disables the collection of profiling data. @@ -279,13 +279,13 @@ Failure to include an appropriate GUID value would allow an out-of-data silo to a #XbBuilder + line="1074">a #XbBuilder some #XbSiloProfileFlags, e.g. %XB_SILO_PROFILE_FLAG_DEBUG + line="1075">some #XbSiloProfileFlags, e.g. %XB_SILO_PROFILE_FLAG_DEBUG @@ -2298,6 +2298,53 @@ to be shared) + + Check whether a libxmlb version equal to or greater than +major.minor.micro. + + + + Major version number + + + Minor version number + + + Micro version number + + + + + The compile-time major version + + + + + The compile-time micro version + + + + + The compile-time minor version + + + Creates a new virtual machine. + line="2446">Creates a new virtual machine. a new #XbMachine + line="2451">a new #XbMachine @@ -2528,19 +2575,19 @@ encoding or shorthand mnemonics for standard functions. version="0.1.3"> Gets the maximum stack size used for the machine. + line="1413">Gets the maximum stack size used for the machine. integer + line="1419">integer a #XbMachine + line="1415">a #XbMachine @@ -2810,7 +2857,7 @@ created the #XbMachine. version="0.1.3"> Sets the maximum stack size used for the machine. + line="1392">Sets the maximum stack size used for the machine. The stack size will be affective for new jobs started with xb_machine_run() and xb_machine_parse(). @@ -2822,13 +2869,13 @@ and xb_machine_parse(). a #XbMachine + line="1394">a #XbMachine integer + line="1395">integer @@ -2839,25 +2886,25 @@ and xb_machine_parse(). throws="1"> Pops an opcode from the stack. + line="1164">Pops an opcode from the stack. %TRUE if popping succeeded, %FALSE if the stack was empty already + line="1173">%TRUE if popping succeeded, %FALSE if the stack was empty already a #XbMachine + line="1166">a #XbMachine a #XbStack + line="1167">a #XbStack allow-none="1"> return location for the popped #XbOpcode + line="1168">return location for the popped #XbOpcode @@ -2879,7 +2926,7 @@ and xb_machine_parse(). throws="1"> Pushes a new empty opcode onto the end of the stack. A pointer to the opcode + line="1235">Pushes a new empty opcode onto the end of the stack. A pointer to the opcode is returned in @opcode_out so that the caller can initialise it. If the stack reaches its maximum size, %G_IO_ERROR_NO_SPACE will be returned. @@ -2887,7 +2934,7 @@ If the stack reaches its maximum size, %G_IO_ERROR_NO_SPACE will be returned. %TRUE if a new empty opcode was returned, or %FALSE if the stack has + line="1247">%TRUE if a new empty opcode was returned, or %FALSE if the stack has reached its maximum size @@ -2895,13 +2942,13 @@ If the stack reaches its maximum size, %G_IO_ERROR_NO_SPACE will be returned. a #XbMachine + line="1237">a #XbMachine a #XbStack + line="1238">a #XbStack return location for the new #XbOpcode + line="1239">return location for the new #XbOpcode @@ -2922,33 +2969,33 @@ If the stack reaches its maximum size, %G_IO_ERROR_NO_SPACE will be returned. Adds an integer literal to the stack. + line="1360">Adds an integer literal to the stack. Errors are as for xb_machine_stack_push(). %TRUE on success, %FALSE otherwise + line="1371">%TRUE on success, %FALSE otherwise a #XbMachine + line="1362">a #XbMachine a #XbStack + line="1363">a #XbStack integer literal + line="1364">integer literal @@ -2959,33 +3006,33 @@ Errors are as for xb_machine_stack_push(). throws="1"> Adds a text literal to the stack, copying @str. + line="1263">Adds a text literal to the stack, copying @str. Errors are as for xb_machine_stack_push(). %TRUE on success, %FALSE otherwise + line="1274">%TRUE on success, %FALSE otherwise a #XbMachine + line="1265">a #XbMachine a #XbStack + line="1266">a #XbStack text literal + line="1267">text literal @@ -2996,33 +3043,33 @@ Errors are as for xb_machine_stack_push(). throws="1"> Adds static text literal to the stack. + line="1295">Adds static text literal to the stack. Errors are as for xb_machine_stack_push(). %TRUE on success, %FALSE otherwise + line="1306">%TRUE on success, %FALSE otherwise a #XbMachine + line="1297">a #XbMachine a #XbStack + line="1298">a #XbStack text literal + line="1299">text literal @@ -3033,33 +3080,33 @@ Errors are as for xb_machine_stack_push(). throws="1"> Adds a stolen text literal to the stack. + line="1327">Adds a stolen text literal to the stack. Errors are as for xb_machine_stack_push(). %TRUE on success, %FALSE otherwise + line="1338">%TRUE on success, %FALSE otherwise a #XbMachine + line="1329">a #XbMachine a #XbStack + line="1330">a #XbStack text literal + line="1331">text literal @@ -3633,7 +3680,7 @@ result. throws="1"> Searches the silo using an XPath query, returning up to @limit results. + line="19">Searches the silo using an XPath query, returning up to @limit results. It is safe to call this function from a different thread to the one that created the #XbSilo. @@ -3643,7 +3690,7 @@ Please note: Only a subset of XPath is supported. results, or %NULL if unfound + line="33">results, or %NULL if unfound @@ -3652,19 +3699,19 @@ Please note: Only a subset of XPath is supported. a #XbNode + line="21">a #XbNode an XPath, e.g. `id[abe.desktop]` + line="22">an XPath, e.g. `id[abe.desktop]` maximum number of results to return, or 0 for "all" + line="23">maximum number of results to return, or 0 for "all" @@ -3675,7 +3722,7 @@ Please note: Only a subset of XPath is supported. throws="1"> Searches the node using an XPath query, returning up to one result. + line="252">Searches the node using an XPath query, returning up to one result. It is safe to call this function from a different thread to the one that created the #XbSilo. @@ -3685,26 +3732,26 @@ Please note: Only a subset of XPath is supported. a string, or %NULL if unfound + line="266">a string, or %NULL if unfound a #XbNode + line="254">a #XbNode An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` + line="255">An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` an attribute name, e.g. `type` + line="256">an attribute name, e.g. `type` @@ -3715,7 +3762,7 @@ Please note: Only a subset of XPath is supported. throws="1"> Searches the node using an XPath query, returning up to one result. + line="373">Searches the node using an XPath query, returning up to one result. It is safe to call this function from a different thread to the one that created the #XbSilo. @@ -3725,26 +3772,26 @@ Please note: Only a subset of XPath is supported. a #guint64, or %G_MAXUINT64 if unfound + line="387">a #guint64, or %G_MAXUINT64 if unfound a #XbNode + line="375">a #XbNode An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` + line="376">An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` an attribute name, e.g. `type` + line="377">an attribute name, e.g. `type` @@ -3755,7 +3802,7 @@ Please note: Only a subset of XPath is supported. throws="1"> Searches the node using an XPath query, returning an XML string of the + line="296">Searches the node using an XPath query, returning an XML string of the result and any children. It is safe to call this function from a different thread to the one that @@ -3766,20 +3813,20 @@ Please note: Only a subset of XPath is supported. a string, or %NULL if unfound + line="310">a string, or %NULL if unfound a #XbNode + line="298">a #XbNode An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` + line="299">An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` @@ -3790,27 +3837,27 @@ Please note: Only a subset of XPath is supported. throws="1"> Searches the node using an XPath query, returning up to one result. + line="179">Searches the node using an XPath query, returning up to one result. Please note: Only a tiny subset of XPath 1.0 is supported. a #XbNode, or %NULL if unfound + line="189">a #XbNode, or %NULL if unfound a #XbNode + line="181">a #XbNode An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` + line="182">An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` @@ -3821,7 +3868,7 @@ Please note: Only a tiny subset of XPath 1.0 is supported. throws="1"> Searches the silo using a prepared query, returning up to one result. To + line="113">Searches the silo using a prepared query, returning up to one result. To search using a query with bound values, use xb_node_query_first_with_context(). @@ -3833,20 +3880,20 @@ Please note: Only a subset of XPath is supported. a #XbNode, or %NULL if unfound + line="128">a #XbNode, or %NULL if unfound a #XbNode + line="115">a #XbNode an #XbQuery + line="116">an #XbQuery @@ -3857,7 +3904,7 @@ Please note: Only a subset of XPath is supported. throws="1"> Searches the silo using a prepared query, returning up to one result. + line="138">Searches the silo using a prepared query, returning up to one result. It is safe to call this function from a different thread to the one that created the #XbSilo. @@ -3867,20 +3914,20 @@ Please note: Only a subset of XPath is supported. a #XbNode, or %NULL if unfound + line="154">a #XbNode, or %NULL if unfound a #XbNode + line="140">a #XbNode an #XbQuery + line="141">an #XbQuery allow-none="1"> context including values bound to opcodes of type + line="142">context including values bound to opcodes of type %XB_OPCODE_KIND_BOUND_INTEGER or %XB_OPCODE_KIND_BOUND_TEXT, or %NULL if the query doesn’t need any context @@ -3902,7 +3949,7 @@ Please note: Only a subset of XPath is supported. throws="1"> Searches the silo using a prepared query. To search using a query with + line="46">Searches the silo using a prepared query. To search using a query with bound values, use xb_node_query_with_context(). It is safe to call this function from a different thread to the one that @@ -3913,7 +3960,7 @@ Please note: Only a subset of XPath is supported. results, or %NULL if unfound + line="60">results, or %NULL if unfound @@ -3922,13 +3969,13 @@ Please note: Only a subset of XPath is supported. a #XbNode + line="48">a #XbNode an #XbQuery + line="49">an #XbQuery @@ -3939,7 +3986,7 @@ Please note: Only a subset of XPath is supported. throws="1"> Searches the node using an XPath query, returning up to one result. + line="209">Searches the node using an XPath query, returning up to one result. It is safe to call this function from a different thread to the one that created the #XbSilo. @@ -3949,20 +3996,20 @@ Please note: Only a subset of XPath is supported. a string, or %NULL if unfound + line="222">a string, or %NULL if unfound a #XbNode + line="211">a #XbNode An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` + line="212">An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` @@ -3973,7 +4020,7 @@ Please note: Only a subset of XPath is supported. throws="1"> Searches the node using an XPath query, returning up to one result. + line="338">Searches the node using an XPath query, returning up to one result. It is safe to call this function from a different thread to the one that created the #XbSilo. @@ -3983,20 +4030,20 @@ Please note: Only a subset of XPath is supported. a #guint64, or %G_MAXUINT64 if unfound + line="351">a #guint64, or %G_MAXUINT64 if unfound a #XbNode + line="340">a #XbNode An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` + line="341">An XPath, e.g. `/components/component[@type=desktop]/id[abe.desktop]` @@ -4007,7 +4054,7 @@ Please note: Only a subset of XPath is supported. throws="1"> Searches the silo using a prepared query, substituting values from the + line="78">Searches the silo using a prepared query, substituting values from the bindings in @context for bound opcodes as needed. It is safe to call this function from a different thread to the one that @@ -4018,7 +4065,7 @@ Please note: Only a subset of XPath is supported. results, or %NULL if unfound + line="95">results, or %NULL if unfound @@ -4027,13 +4074,13 @@ Please note: Only a subset of XPath is supported. a #XbNode + line="80">a #XbNode an #XbQuery + line="81">an #XbQuery allow-none="1"> context including values bound to opcodes of type + line="82">context including values bound to opcodes of type %XB_OPCODE_KIND_BOUND_INTEGER or %XB_OPCODE_KIND_BOUND_TEXT, or %NULL if the query doesn’t need any context @@ -5346,11 +5393,11 @@ number of results to return, or values to bind to query placeholders. version="0.3.0"> Clear an #XbQueryContext, freeing any allocated memory it points to. + line="60">Clear an #XbQueryContext, freeing any allocated memory it points to. After this function has been called, the contents of the #XbQueryContext are undefined, and it’s only safe to call xb_query_context_init() on it. - + @@ -5358,7 +5405,7 @@ undefined, and it’s only safe to call xb_query_context_init() on it. an #XbQueryContext + line="62">an #XbQueryContext @@ -5366,19 +5413,19 @@ undefined, and it’s only safe to call xb_query_context_init() on it. Copy @self into a new heap-allocated #XbQueryContext instance. - + line="79">Copy @self into a new heap-allocated #XbQueryContext instance. + a copy of @self + line="85">a copy of @self an #XbQueryContext + line="81">an #XbQueryContext @@ -5386,12 +5433,12 @@ undefined, and it’s only safe to call xb_query_context_init() on it. Free a heap-allocated #XbQueryContext instance. This should be used on + line="107">Free a heap-allocated #XbQueryContext instance. This should be used on #XbQueryContext instances created with xb_query_context_copy(). For stack-allocated instances, xb_query_context_clear() should be used instead. - + @@ -5399,7 +5446,7 @@ instead. a heap-allocated #XbQueryContext + line="109">a heap-allocated #XbQueryContext @@ -5409,19 +5456,19 @@ instead. version="0.3.0"> Get the #XbValueBindings for this query context. - + line="128">Get the #XbValueBindings for this query context. + bindings + line="134">bindings an #XbQueryContext + line="130">an #XbQueryContext @@ -5431,19 +5478,19 @@ instead. version="0.3.0"> Get the flags set on the context. See xb_query_context_set_flags(). - + line="186">Get the flags set on the context. See xb_query_context_set_flags(). + query flags + line="192">query flags an #XbQueryContext + line="188">an #XbQueryContext @@ -5453,20 +5500,20 @@ instead. version="0.3.0"> Get the limit on the number of query results. See + line="147">Get the limit on the number of query results. See xb_query_context_set_limit(). - + limit on results, or `0` if unlimited + line="154">limit on results, or `0` if unlimited an #XbQueryContext + line="149">an #XbQueryContext @@ -5474,12 +5521,12 @@ xb_query_context_set_limit(). Initialise a stack-allocated #XbQueryContext struct so it can be used. + line="38">Initialise a stack-allocated #XbQueryContext struct so it can be used. Stack-allocated #XbQueryContext instances should be freed once finished with, using xb_query_context_clear() (or `g_auto(XbQueryContext)`, which is equivalent). - + @@ -5487,7 +5534,7 @@ equivalent). an uninitialised #XbQueryContext to initialise + line="40">an uninitialised #XbQueryContext to initialise @@ -5497,8 +5544,8 @@ equivalent). version="0.3.0"> Set flags which affect the behaviour of the query. - + line="205">Set flags which affect the behaviour of the query. + @@ -5506,13 +5553,13 @@ equivalent). an #XbQueryContext + line="207">an #XbQueryContext query flags, or %XB_QUERY_FLAG_NONE for none + line="208">query flags, or %XB_QUERY_FLAG_NONE for none @@ -5522,8 +5569,8 @@ equivalent). version="0.3.0"> Set the limit on the number of results to return from the query. - + line="167">Set the limit on the number of results to return from the query. + @@ -5531,13 +5578,13 @@ equivalent). an #XbQueryContext + line="169">an #XbQueryContext number of query results to return, or `0` for unlimited + line="170">number of query results to return, or `0` for unlimited @@ -7142,6 +7189,20 @@ operator (`|`) if required. + + Gets the XMLb installed runtime version. + + + a version number, e.g. "0.3.19" + + + + + These compile time macros allow the user to enable parts of client code +depending on the version of libxmlb installed. + diff --git a/girs/Zeitgeist-2.0.gir b/girs/Zeitgeist-2.0.gir index b5837b0d6..485ba5bda 100644 --- a/girs/Zeitgeist-2.0.gir +++ b/girs/Zeitgeist-2.0.gir @@ -1,5 +1,5 @@ - + diff --git a/package.json b/package.json index ce0e8d079..de2495cd8 100644 --- a/package.json +++ b/package.json @@ -18,9 +18,11 @@ "publish:app:latest": "yarn workspaces foreach -v --all --parallel --no-private --include '@ts-for-gir/*' --include '@gi.ts/*' npm publish --tolerate-republish --tag latest --access public", "publish:types:next": "yarn workspaces foreach -v --all --parallel --no-private --include '@girs/*' npm publish --tolerate-republish --tag next --access public", "publish:types:latest": "yarn workspaces foreach -v --all --parallel --no-private --include '@girs/*' npm publish --tolerate-republish --tag latest --access public", - "test": "yarn build:all && yarn test:girs:local && yarn validate:examples && yarn start:cli-examples", - "test:girs:local": "yarn clear:types && yarn build:types:local && yarn validate:types:local", + "test": "yarn build:all && yarn test:girs:packages && yarn validate:examples && yarn start:cli-examples", + "test:girs:local": "yarn clear:types:local && yarn build:types:local && yarn validate:types:local", "test:girs:local:gtk4": "yarn clear:types && yarn build:types:local:gtk4 && yarn validate:types:local", + "test:girs:packages": "yarn build:types:packages && yarn validate:types:packages", + "test:girs:packages:gtk4": "yarn build:types:packages:gtk4 && yarn validate:types:packages", "build": "yarn build:parser && yarn build:lib && yarn build:generators && yarn build:cli", "build:parser": "yarn workspace @gi.ts/parser run build", "build:cli": "yarn workspace @ts-for-gir/cli run build", @@ -43,11 +45,14 @@ "validate": "yarn workspaces foreach -v --all --parallel run validate", "validate:types": "yarn workspaces foreach -v --all --parallel run validate:types", "validate:examples": "yarn workspaces foreach -v --all --parallel run validate:app", - "validate:types:packages": "yarn workspace @ts-for-gir-test/types-packages run validate:types:packages", - "clear": "yarn clear:build && yarn clear:types", + "TODO": "yarn workspace @ts-for-gir-test/types-packages run validate:types", + "validate:types:packages": "yarn workspaces foreach -v --all --parallel --include '@girs/*' run test", + "validate:types:local": "tsc --project tsconfig.local.json", + "clear": "yarn clear:build && yarn clear:types:local", "clear:build": "yarn workspaces foreach -v --all --include '@ts-for-gir/*' run clear:build", - "clear:types": "yarn run clear:types:local", - "clear:types:local": "rimraf ./@types", + "clear:types:local": "yarn run clear:types:local:local", + "clear:types:local:local": "rimraf ./@types", + "clear:types:local:packages": "rimraf ./types/*", "clear:examples": "yarn workspaces foreach -v --all --include '@ts-for-gir-example/*' --include '*-example' --parallel run clear", "clear:all": "yarn clear && yarn clear:examples", "watch": "concurrently 'yarn:watch:*'", @@ -83,14 +88,14 @@ "devDependencies": { "@ts-for-gir/cli": "workspace:^", "@typescript-eslint/eslint-plugin": "^7.8.0", - "@typescript-eslint/parser": "^7.8.0", + "@typescript-eslint/parser": "^7.15.0", "concurrently": "^8.2.2", "eslint": "^8.57.0", "eslint-config-prettier": "^9.1.0", "eslint-plugin-prettier": "^5.1.3", - "prettier": "^3.2.5", - "rimraf": "^5.0.5", - "typescript": "^5.4.5" + "prettier": "^3.3.2", + "rimraf": "^5.0.8", + "typescript": "^5.5.3" }, "workspaces": [ "test", diff --git a/packages/cli/package.json b/packages/cli/package.json index e524329f9..8a231d7d6 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -54,16 +54,16 @@ ], "devDependencies": { "@types/inquirer": "^9.0.7", - "@types/node": "^20.12.8", + "@types/node": "^20.14.10", "@types/yargs": "^17.0.32", "@typescript-eslint/eslint-plugin": "^7.8.0", - "@typescript-eslint/parser": "^7.8.0", + "@typescript-eslint/parser": "^7.15.0", "eslint": "^8.57.0", "eslint-config-prettier": "^9.1.0", "eslint-plugin-prettier": "^5.1.3", - "rimraf": "^5.0.5", + "rimraf": "^5.0.8", "ts-node": "^10.9.2", - "typescript": "^5.4.5" + "typescript": "^5.5.3" }, "dependencies": { "@gi.ts/parser": "workspace:^", @@ -73,9 +73,9 @@ "@ts-for-gir/lib": "workspace:^", "colorette": "^2.0.20", "cosmiconfig": "^9.0.0", - "glob": "^10.3.12", - "inquirer": "^9.2.20", - "prettier": "^3.2.5", + "glob": "^10.4.3", + "inquirer": "^9.3.4", + "prettier": "^3.3.2", "yargs": "^17.7.2" } } diff --git a/packages/generator-base/package.json b/packages/generator-base/package.json index 80981a8fd..ae1104011 100644 --- a/packages/generator-base/package.json +++ b/packages/generator-base/package.json @@ -34,15 +34,15 @@ "generator" ], "devDependencies": { - "@types/node": "^20.12.8", + "@types/node": "^20.14.10", "@typescript-eslint/eslint-plugin": "^7.8.0", - "@typescript-eslint/parser": "^7.8.0", + "@typescript-eslint/parser": "^7.15.0", "eslint": "^8.57.0", "eslint-config-prettier": "^9.1.0", "eslint-plugin-prettier": "^5.1.3", - "prettier": "^3.2.5", - "rimraf": "^5.0.5", - "typescript": "^5.4.5" + "prettier": "^3.3.2", + "rimraf": "^5.0.8", + "typescript": "^5.5.3" }, "dependencies": { "@ts-for-gir/lib": "workspace:^" diff --git a/packages/generator-html-doc/package.json b/packages/generator-html-doc/package.json index b4cdc4d7c..c3fb1bb77 100644 --- a/packages/generator-html-doc/package.json +++ b/packages/generator-html-doc/package.json @@ -34,15 +34,15 @@ "generator" ], "devDependencies": { - "@types/node": "^20.12.8", + "@types/node": "^20.14.10", "@typescript-eslint/eslint-plugin": "^7.8.0", - "@typescript-eslint/parser": "^7.8.0", + "@typescript-eslint/parser": "^7.15.0", "eslint": "^8.57.0", "eslint-config-prettier": "^9.1.0", "eslint-plugin-prettier": "^5.1.3", - "prettier": "^3.2.5", - "rimraf": "^5.0.5", - "typescript": "^5.4.5" + "prettier": "^3.3.2", + "rimraf": "^5.0.8", + "typescript": "^5.5.3" }, "dependencies": { "@ts-for-gir/generator-base": "workspace:^", diff --git a/packages/generator-typescript/package.json b/packages/generator-typescript/package.json index 7fec888b4..713bed1c0 100644 --- a/packages/generator-typescript/package.json +++ b/packages/generator-typescript/package.json @@ -42,16 +42,16 @@ ], "devDependencies": { "@types/ejs": "^3.1.5", - "@types/node": "^20.12.8", + "@types/node": "^20.14.10", "@types/xml2js": "^0.4.14", "@typescript-eslint/eslint-plugin": "^7.8.0", - "@typescript-eslint/parser": "^7.8.0", + "@typescript-eslint/parser": "^7.15.0", "eslint": "^8.57.0", "eslint-config-prettier": "^9.1.0", "eslint-plugin-prettier": "^5.1.3", - "prettier": "^3.2.5", - "rimraf": "^5.0.5", - "typescript": "^5.4.5" + "prettier": "^3.3.2", + "rimraf": "^5.0.8", + "typescript": "^5.5.3" }, "dependencies": { "@ts-for-gir/generator-base": "workspace:^", diff --git a/packages/generator-typescript/src/type-definition-generator.ts b/packages/generator-typescript/src/type-definition-generator.ts index 97687dcb1..b41203f8c 100644 --- a/packages/generator-typescript/src/type-definition-generator.ts +++ b/packages/generator-typescript/src/type-definition-generator.ts @@ -1412,9 +1412,10 @@ class ModuleGenerator extends FormatGenerator { return ` extends ${Type}` } - throw new Error( - `Unable to resolve type: ${node.superType.name} from ${node.superType.namespace} in ${node.namespace.namespace} ${node.namespace.version}`, + this.log.error( + `Unable to resolve type: ${node.superType.name} from ${node.superType.namespace} in ${node.namespace.namespace} ${node.namespace.version}, falling back to GObject.Object`, ) + return ` extends GObject.Object` } return '' diff --git a/packages/generator-typescript/templates/package.json b/packages/generator-typescript/templates/package.json index fe171e683..d71fdaced 100644 --- a/packages/generator-typescript/templates/package.json +++ b/packages/generator-typescript/templates/package.json @@ -63,7 +63,7 @@ _%> } }, "scripts": { - "test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit <%- entryPointName %>.d.ts" + "test": "tsc --project tsconfig.json" }, "dependencies": { <%_ if (packageName !== 'Gjs') { _%> diff --git a/packages/lib/package.json b/packages/lib/package.json index f9ecf1ae3..b6624afd7 100644 --- a/packages/lib/package.json +++ b/packages/lib/package.json @@ -52,22 +52,22 @@ "devDependencies": { "@types/ejs": "^3.1.5", "@types/eslint": "8.56.10", - "@types/lodash": "^4.17.1", - "@types/node": "^20.12.8", + "@types/lodash": "^4.17.6", + "@types/node": "^20.14.10", "@typescript-eslint/eslint-plugin": "^7.8.0", - "@typescript-eslint/parser": "^7.8.0", + "@typescript-eslint/parser": "^7.15.0", "eslint": "^8.57.0", "eslint-config-prettier": "^9.1.0", "eslint-plugin-prettier": "^5.1.3", - "prettier": "^3.2.5", - "rimraf": "^5.0.5", - "typescript": "^5.4.5" + "prettier": "^3.3.2", + "rimraf": "^5.0.8", + "typescript": "^5.5.3" }, "dependencies": { "@gi.ts/parser": "workspace:^", "colorette": "^2.0.20", "ejs": "^3.1.10", - "glob": "^10.3.12", + "glob": "^10.4.3", "lodash": "^4.17.21" } } diff --git a/packages/lib/src/gir.ts b/packages/lib/src/gir.ts index d0fb5c9d2..461e6f31a 100644 --- a/packages/lib/src/gir.ts +++ b/packages/lib/src/gir.ts @@ -139,7 +139,7 @@ export class TypeIdentifier extends TypeExpression { return null } - this.log.error(`Type ${this.name} could not be resolved in ${namespace.namespace}`) + this.log.error(`Type ${this.name} could not be resolved in ${namespace.namespace} ${namespace.version}`) return null } diff --git a/packages/parser/package.json b/packages/parser/package.json index ab4d41fc4..95be80a28 100644 --- a/packages/parser/package.json +++ b/packages/parser/package.json @@ -28,15 +28,15 @@ "prepack": "rm -rf dist && yarn build" }, "dependencies": { - "fast-xml-parser": "^4.3.6" + "fast-xml-parser": "^4.4.0" }, "devDependencies": { "@typescript-eslint/eslint-plugin": "^7.8.0", - "@typescript-eslint/parser": "^7.8.0", + "@typescript-eslint/parser": "^7.15.0", "eslint": "^8.57.0", "eslint-config-prettier": "^9.1.0", "eslint-plugin-prettier": "^5.1.3", - "prettier": "^3.2.5", - "typescript": "^5.4.5" + "prettier": "^3.3.2", + "typescript": "^5.5.3" } } diff --git a/packages/test/package.json b/packages/test/package.json index fdcd7bc57..96654a8d0 100644 --- a/packages/test/package.json +++ b/packages/test/package.json @@ -1,7 +1,7 @@ { "name": "@ts-for-gir-test/types-packages", "scripts": { - "validate:types:packages": "tsc --project tsconfig.json --noEmit" + "validate:types": "tsc --project tsconfig.json --noEmit" }, "dependencies": { "@girs/accounts-1.0": "workspace:^", @@ -478,6 +478,6 @@ "@girs/zpj-0.0": "workspace:^" }, "devDependencies": { - "typescript": "^5.4.5" + "typescript": "^5.5.3" } } diff --git a/tsconfig.local.json b/tsconfig.local.json new file mode 100644 index 000000000..072fcfd2d --- /dev/null +++ b/tsconfig.local.json @@ -0,0 +1,18 @@ +// This is the local tsconfig for validating the types in the @types directory +{ + "compilerOptions": { + // General settings for code interpretation + "target": "ESNext", + "module": "ESNext", + "lib": ["ESNext"], + "types": [], + "experimentalDecorators": true, + "moduleResolution": "node", + "noEmit": true, + "noEmitOnError": false, + "rootDir": "./@types" + }, + "include": ["./@types/**/*.d.ts"] +} + + diff --git a/types b/types index e883772e0..29fecc071 160000 --- a/types +++ b/types @@ -1 +1 @@ -Subproject commit e883772e0c477d76d737f7aac698a10aef6280dd +Subproject commit 29fecc071e53abf758bac8f8bc0a812e62023df2 diff --git a/vala-girs b/vala-girs index 167d367f4..7da1fae99 160000 --- a/vala-girs +++ b/vala-girs @@ -1 +1 @@ -Subproject commit 167d367f42d6d3e218480b87c91fc4f3dcbc4107 +Subproject commit 7da1fae995900e7631ab5b2cd2e4f5b787f75053 diff --git a/yarn.lock b/yarn.lock index 11fa8a82f..47952b15c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -15,7 +15,7 @@ __metadata: languageName: node linkType: hard -"@babel/code-frame@npm:^7.0.0, @babel/code-frame@npm:^7.16.7, @babel/code-frame@npm:^7.23.5, @babel/code-frame@npm:^7.24.2": +"@babel/code-frame@npm:^7.0.0, @babel/code-frame@npm:^7.16.7": version: 7.24.2 resolution: "@babel/code-frame@npm:7.24.2" dependencies: @@ -25,88 +25,100 @@ __metadata: languageName: node linkType: hard -"@babel/compat-data@npm:^7.23.5": - version: 7.24.4 - resolution: "@babel/compat-data@npm:7.24.4" - checksum: 10/e51faec0ac8259f03cc5029d2b4a944b4fee44cb5188c11530769d5beb81f384d031dba951febc3e33dbb48ceb8045b1184f5c1ac4c5f86ab1f5e951e9aaf7af +"@babel/code-frame@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/code-frame@npm:7.24.7" + dependencies: + "@babel/highlight": "npm:^7.24.7" + picocolors: "npm:^1.0.0" + checksum: 10/4812e94885ba7e3213d49583a155fdffb05292330f0a9b2c41b49288da70cf3c746a3fda0bf1074041a6d741c33f8d7be24be5e96f41ef77395eeddc5c9ff624 languageName: node linkType: hard -"@babel/core@npm:^7.24.5": - version: 7.24.5 - resolution: "@babel/core@npm:7.24.5" +"@babel/compat-data@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/compat-data@npm:7.24.7" + checksum: 10/6edc09152ca51a22c33741c441f33f9475598fa59edc53369edb74b49f4ea4bef1281f5b0ed2b9b67fb66faef2da2069e21c4eef83405d8326e524b301f4e7e2 + languageName: node + linkType: hard + +"@babel/core@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/core@npm:7.24.7" dependencies: "@ampproject/remapping": "npm:^2.2.0" - "@babel/code-frame": "npm:^7.24.2" - "@babel/generator": "npm:^7.24.5" - "@babel/helper-compilation-targets": "npm:^7.23.6" - "@babel/helper-module-transforms": "npm:^7.24.5" - "@babel/helpers": "npm:^7.24.5" - "@babel/parser": "npm:^7.24.5" - "@babel/template": "npm:^7.24.0" - "@babel/traverse": "npm:^7.24.5" - "@babel/types": "npm:^7.24.5" + "@babel/code-frame": "npm:^7.24.7" + "@babel/generator": "npm:^7.24.7" + "@babel/helper-compilation-targets": "npm:^7.24.7" + "@babel/helper-module-transforms": "npm:^7.24.7" + "@babel/helpers": "npm:^7.24.7" + "@babel/parser": "npm:^7.24.7" + "@babel/template": "npm:^7.24.7" + "@babel/traverse": "npm:^7.24.7" + "@babel/types": "npm:^7.24.7" convert-source-map: "npm:^2.0.0" debug: "npm:^4.1.0" gensync: "npm:^1.0.0-beta.2" json5: "npm:^2.2.3" semver: "npm:^6.3.1" - checksum: 10/b0d02c51f39cc4c6f8fcaab7052d17dea63aab36d7e2567bfbad074e5a027df737ebcaf3029c3a659bc719bbac806311c2e8786be1d686abd093c48a6068395c + checksum: 10/ef8cc1afa3ccecee6d1f5660c487ccc2a3f25106830ea9040e80ef4b2092e053607ee4ddd03493e4f7ef2f9967a956ca53b830d54c5bee738eeb58cce679dd4a languageName: node linkType: hard -"@babel/generator@npm:^7.24.5": - version: 7.24.5 - resolution: "@babel/generator@npm:7.24.5" +"@babel/generator@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/generator@npm:7.24.7" dependencies: - "@babel/types": "npm:^7.24.5" + "@babel/types": "npm:^7.24.7" "@jridgewell/gen-mapping": "npm:^0.3.5" "@jridgewell/trace-mapping": "npm:^0.3.25" jsesc: "npm:^2.5.1" - checksum: 10/7a3782f1d2f824025a538444a0fce44f5b30a7b013984279561bcb3450eec91a41526533fd0b25b1a6fde627bebd0e645c0ea2aa907cc15c7f3da2d9eb71f069 + checksum: 10/c71d24a4b41b19c10d2f2eb819f27d4cf94220e2322f7c8fed8bfbbb115b2bebbdd6dc1f27dac78a175e90604def58d763af87e0fa81ce4ab1582858162cf768 languageName: node linkType: hard -"@babel/helper-compilation-targets@npm:^7.23.6": - version: 7.23.6 - resolution: "@babel/helper-compilation-targets@npm:7.23.6" +"@babel/helper-compilation-targets@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helper-compilation-targets@npm:7.24.7" dependencies: - "@babel/compat-data": "npm:^7.23.5" - "@babel/helper-validator-option": "npm:^7.23.5" + "@babel/compat-data": "npm:^7.24.7" + "@babel/helper-validator-option": "npm:^7.24.7" browserslist: "npm:^4.22.2" lru-cache: "npm:^5.1.1" semver: "npm:^6.3.1" - checksum: 10/05595cd73087ddcd81b82d2f3297aac0c0422858dfdded43d304786cf680ec33e846e2317e6992d2c964ee61d93945cbf1fa8ec80b55aee5bfb159227fb02cb9 + checksum: 10/8f8bc89af70a606ccb208513aa25d83e19b88f91b64a33174f7701a9479e67ddbb0a9c89033265070375cd24e690b93380b3a3ea11e4b3a711d742f0f4699ee7 languageName: node linkType: hard -"@babel/helper-environment-visitor@npm:^7.22.20": - version: 7.22.20 - resolution: "@babel/helper-environment-visitor@npm:7.22.20" - checksum: 10/d80ee98ff66f41e233f36ca1921774c37e88a803b2f7dca3db7c057a5fea0473804db9fb6729e5dbfd07f4bed722d60f7852035c2c739382e84c335661590b69 +"@babel/helper-environment-visitor@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helper-environment-visitor@npm:7.24.7" + dependencies: + "@babel/types": "npm:^7.24.7" + checksum: 10/079d86e65701b29ebc10baf6ed548d17c19b808a07aa6885cc141b690a78581b180ee92b580d755361dc3b16adf975b2d2058b8ce6c86675fcaf43cf22f2f7c6 languageName: node linkType: hard -"@babel/helper-function-name@npm:^7.23.0": - version: 7.23.0 - resolution: "@babel/helper-function-name@npm:7.23.0" +"@babel/helper-function-name@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helper-function-name@npm:7.24.7" dependencies: - "@babel/template": "npm:^7.22.15" - "@babel/types": "npm:^7.23.0" - checksum: 10/7b2ae024cd7a09f19817daf99e0153b3bf2bc4ab344e197e8d13623d5e36117ed0b110914bc248faa64e8ccd3e97971ec7b41cc6fd6163a2b980220c58dcdf6d + "@babel/template": "npm:^7.24.7" + "@babel/types": "npm:^7.24.7" + checksum: 10/2ceb3d9b2b35a0fc4100fc06ed7be3bc38f03ff0bf128ff0edbc0cc7dd842967b1496fc70b5c616c747d7711c2b87e7d025c8888f48740631d6148a9d3614f85 languageName: node linkType: hard -"@babel/helper-hoist-variables@npm:^7.22.5": - version: 7.22.5 - resolution: "@babel/helper-hoist-variables@npm:7.22.5" +"@babel/helper-hoist-variables@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helper-hoist-variables@npm:7.24.7" dependencies: - "@babel/types": "npm:^7.22.5" - checksum: 10/394ca191b4ac908a76e7c50ab52102669efe3a1c277033e49467913c7ed6f7c64d7eacbeabf3bed39ea1f41731e22993f763b1edce0f74ff8563fd1f380d92cc + "@babel/types": "npm:^7.24.7" + checksum: 10/6cfdcf2289cd12185dcdbdf2435fa8d3447b797ac75851166de9fc8503e2fd0021db6baf8dfbecad3753e582c08e6a3f805c8d00cbed756060a877d705bd8d8d languageName: node linkType: hard -"@babel/helper-module-imports@npm:^7.18.6, @babel/helper-module-imports@npm:^7.24.3": +"@babel/helper-module-imports@npm:^7.18.6": version: 7.24.3 resolution: "@babel/helper-module-imports@npm:7.24.3" dependencies: @@ -115,36 +127,47 @@ __metadata: languageName: node linkType: hard -"@babel/helper-module-transforms@npm:^7.24.5": - version: 7.24.5 - resolution: "@babel/helper-module-transforms@npm:7.24.5" +"@babel/helper-module-imports@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helper-module-imports@npm:7.24.7" dependencies: - "@babel/helper-environment-visitor": "npm:^7.22.20" - "@babel/helper-module-imports": "npm:^7.24.3" - "@babel/helper-simple-access": "npm:^7.24.5" - "@babel/helper-split-export-declaration": "npm:^7.24.5" - "@babel/helper-validator-identifier": "npm:^7.24.5" + "@babel/traverse": "npm:^7.24.7" + "@babel/types": "npm:^7.24.7" + checksum: 10/df8bfb2bb18413aa151ecd63b7d5deb0eec102f924f9de6bc08022ced7ed8ca7fed914562d2f6fa5b59b74a5d6e255dc35612b2bc3b8abf361e13f61b3704770 + languageName: node + linkType: hard + +"@babel/helper-module-transforms@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helper-module-transforms@npm:7.24.7" + dependencies: + "@babel/helper-environment-visitor": "npm:^7.24.7" + "@babel/helper-module-imports": "npm:^7.24.7" + "@babel/helper-simple-access": "npm:^7.24.7" + "@babel/helper-split-export-declaration": "npm:^7.24.7" + "@babel/helper-validator-identifier": "npm:^7.24.7" peerDependencies: "@babel/core": ^7.0.0 - checksum: 10/1a91e8abc2f427f8273ce3b99ef7b9c013eb3628221428553e0d4bc9c6db2e73bc4fc1b8535bd258544936accab9380e0d095f2449f913cad650ddee744b2124 + checksum: 10/4f2b232bf6d1be8d3a72b084a2a7ac1b0b93ea85717411a11ae1fb6375d4392019e781d8cc155789e649a2caa7eec378dd1404210603d6d4230f042c5feacffb languageName: node linkType: hard -"@babel/helper-simple-access@npm:^7.24.5": - version: 7.24.5 - resolution: "@babel/helper-simple-access@npm:7.24.5" +"@babel/helper-simple-access@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helper-simple-access@npm:7.24.7" dependencies: - "@babel/types": "npm:^7.24.5" - checksum: 10/db8768a16592faa1bde9061cac3d903bdbb2ddb2a7e9fb73c5904daee1f1b1dc69ba4d249dc22c45885c0d4b54fd0356ee78e6d67a9a90330c7dd37e6cd3acff + "@babel/traverse": "npm:^7.24.7" + "@babel/types": "npm:^7.24.7" + checksum: 10/5083e190186028e48fc358a192e4b93ab320bd016103caffcfda81302a13300ccce46c9cd255ae520c25d2a6a9b47671f93e5fe5678954a2329dc0a685465c49 languageName: node linkType: hard -"@babel/helper-split-export-declaration@npm:^7.24.5": - version: 7.24.5 - resolution: "@babel/helper-split-export-declaration@npm:7.24.5" +"@babel/helper-split-export-declaration@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helper-split-export-declaration@npm:7.24.7" dependencies: - "@babel/types": "npm:^7.24.5" - checksum: 10/84777b6304ef0fe6501038985b61aaa118082688aa54eca8265f14f3ae2e01adf137e9111f4eb9870e0e9bc23901e0b8859bb2a9e4362ddf89d05e1c409c2422 + "@babel/types": "npm:^7.24.7" + checksum: 10/ff04a3071603c87de0d6ee2540b7291ab36305b329bd047cdbb6cbd7db335a12f9a77af1cf708779f75f13c4d9af46093c00b34432e50b2411872c658d1a2e5e languageName: node linkType: hard @@ -155,6 +178,13 @@ __metadata: languageName: node linkType: hard +"@babel/helper-string-parser@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helper-string-parser@npm:7.24.7" + checksum: 10/603d8d962bbe89907aa99a8f19a006759ab7b2464615f20a6a22e3e2e8375af37ddd0e5175c9e622e1c4b2d83607ffb41055a59d0ce34404502af30fde573a5c + languageName: node + linkType: hard + "@babel/helper-validator-identifier@npm:^7.24.5": version: 7.24.5 resolution: "@babel/helper-validator-identifier@npm:7.24.5" @@ -162,21 +192,27 @@ __metadata: languageName: node linkType: hard -"@babel/helper-validator-option@npm:^7.23.5": - version: 7.23.5 - resolution: "@babel/helper-validator-option@npm:7.23.5" - checksum: 10/537cde2330a8aede223552510e8a13e9c1c8798afee3757995a7d4acae564124fe2bf7e7c3d90d62d3657434a74340a274b3b3b1c6f17e9a2be1f48af29cb09e +"@babel/helper-validator-identifier@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helper-validator-identifier@npm:7.24.7" + checksum: 10/86875063f57361471b531dbc2ea10bbf5406e12b06d249b03827d361db4cad2388c6f00936bcd9dc86479f7e2c69ea21412c2228d4b3672588b754b70a449d4b languageName: node linkType: hard -"@babel/helpers@npm:^7.24.5": - version: 7.24.5 - resolution: "@babel/helpers@npm:7.24.5" +"@babel/helper-validator-option@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helper-validator-option@npm:7.24.7" + checksum: 10/9689166bf3f777dd424c026841c8cd651e41b21242dbfd4569a53086179a3e744c8eddd56e9d10b54142270141c91581b53af0d7c00c82d552d2540e2a919f7e + languageName: node + linkType: hard + +"@babel/helpers@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/helpers@npm:7.24.7" dependencies: - "@babel/template": "npm:^7.24.0" - "@babel/traverse": "npm:^7.24.5" - "@babel/types": "npm:^7.24.5" - checksum: 10/efd74325823c70a32aa9f5e263c8eb0a1f729f5e9ea168e3226fa92a10b1702593b76034812e9f7b560d6447f9cd446bad231d7086af842129c6596306300094 + "@babel/template": "npm:^7.24.7" + "@babel/types": "npm:^7.24.7" + checksum: 10/f7496f0d7a0b13ea86136ac2053371027125734170328215f8a90eac96fafaaae4e5398c0729bdadf23261c00582a31e14bc70113427653b718220641a917f9d languageName: node linkType: hard @@ -192,12 +228,24 @@ __metadata: languageName: node linkType: hard -"@babel/parser@npm:^7.24.0, @babel/parser@npm:^7.24.5": - version: 7.24.5 - resolution: "@babel/parser@npm:7.24.5" +"@babel/highlight@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/highlight@npm:7.24.7" + dependencies: + "@babel/helper-validator-identifier": "npm:^7.24.7" + chalk: "npm:^2.4.2" + js-tokens: "npm:^4.0.0" + picocolors: "npm:^1.0.0" + checksum: 10/69b73f38cdd4f881b09b939a711e76646da34f4834f4ce141d7a49a6bb1926eab1c594148970a8aa9360398dff800f63aade4e81fafdd7c8d8a8489ea93bfec1 + languageName: node + linkType: hard + +"@babel/parser@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/parser@npm:7.24.7" bin: parser: ./bin/babel-parser.js - checksum: 10/f5ed1c5fd4b0045a364fb906f54fd30e2fff93a45069068b6d80d3ab2b64f5569c90fb41d39aff80fb7e925ca4d44917965a76776a3ca11924ec1fae3be5d1ea + checksum: 10/ef9ebce60e13db560ccc7af9235d460f6726bb7e23ae2d675098c1fc43d5249067be60d4118889dad33b1d4f85162cf66baf554719e1669f29bb20e71322568e languageName: node linkType: hard @@ -210,36 +258,36 @@ __metadata: languageName: node linkType: hard -"@babel/template@npm:^7.22.15, @babel/template@npm:^7.24.0": - version: 7.24.0 - resolution: "@babel/template@npm:7.24.0" +"@babel/template@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/template@npm:7.24.7" dependencies: - "@babel/code-frame": "npm:^7.23.5" - "@babel/parser": "npm:^7.24.0" - "@babel/types": "npm:^7.24.0" - checksum: 10/8c538338c7de8fac8ada691a5a812bdcbd60bd4a4eb5adae2cc9ee19773e8fb1a724312a00af9e1ce49056ffd3c3475e7287b5668cf6360bfb3f8ac827a06ffe + "@babel/code-frame": "npm:^7.24.7" + "@babel/parser": "npm:^7.24.7" + "@babel/types": "npm:^7.24.7" + checksum: 10/5975d404ef51cf379515eb0f80b115981d0b9dff5539e53a47516644abb8c83d7559f5b083eb1d4977b20d8359ebb2f911ccd4f729143f8958fdc465f976d843 languageName: node linkType: hard -"@babel/traverse@npm:^7.24.5": - version: 7.24.5 - resolution: "@babel/traverse@npm:7.24.5" - dependencies: - "@babel/code-frame": "npm:^7.24.2" - "@babel/generator": "npm:^7.24.5" - "@babel/helper-environment-visitor": "npm:^7.22.20" - "@babel/helper-function-name": "npm:^7.23.0" - "@babel/helper-hoist-variables": "npm:^7.22.5" - "@babel/helper-split-export-declaration": "npm:^7.24.5" - "@babel/parser": "npm:^7.24.5" - "@babel/types": "npm:^7.24.5" +"@babel/traverse@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/traverse@npm:7.24.7" + dependencies: + "@babel/code-frame": "npm:^7.24.7" + "@babel/generator": "npm:^7.24.7" + "@babel/helper-environment-visitor": "npm:^7.24.7" + "@babel/helper-function-name": "npm:^7.24.7" + "@babel/helper-hoist-variables": "npm:^7.24.7" + "@babel/helper-split-export-declaration": "npm:^7.24.7" + "@babel/parser": "npm:^7.24.7" + "@babel/types": "npm:^7.24.7" debug: "npm:^4.3.1" globals: "npm:^11.1.0" - checksum: 10/e237de56e0c30795293fdb6f2cb09a75e6230836e3dc67dc4fa21781eb4d5842996bf3af95bc57ac5c7e6e97d06446f14732d0952eb57d5d9643de7c4f95bee6 + checksum: 10/785cf26383a992740e492efba7016de964cd06c05c9d7146fa1b5ead409e054c444f50b36dc37856884a56e32cf9d3105ddf1543486b6df68300bffb117a245a languageName: node linkType: hard -"@babel/types@npm:^7.22.5, @babel/types@npm:^7.23.0, @babel/types@npm:^7.24.0, @babel/types@npm:^7.24.5, @babel/types@npm:^7.8.3": +"@babel/types@npm:^7.24.0, @babel/types@npm:^7.8.3": version: 7.24.5 resolution: "@babel/types@npm:7.24.5" dependencies: @@ -250,6 +298,17 @@ __metadata: languageName: node linkType: hard +"@babel/types@npm:^7.24.7": + version: 7.24.7 + resolution: "@babel/types@npm:7.24.7" + dependencies: + "@babel/helper-string-parser": "npm:^7.24.7" + "@babel/helper-validator-identifier": "npm:^7.24.7" + to-fast-properties: "npm:^2.0.0" + checksum: 10/ad3c8c0d6fb4acb0bb74bb5b4bb849b181bf6185677ef9c59c18856c81e43628d0858253cf232f0eca806f02e08eff85a1d3e636a3e94daea737597796b0b430 + languageName: node + linkType: hard + "@cspotcode/source-map-support@npm:^0.8.0": version: 0.8.1 resolution: "@cspotcode/source-map-support@npm:0.8.1" @@ -266,163 +325,331 @@ __metadata: languageName: node linkType: hard -"@esbuild/aix-ppc64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/aix-ppc64@npm:0.20.2" +"@esbuild/aix-ppc64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/aix-ppc64@npm:0.21.5" conditions: os=aix & cpu=ppc64 languageName: node linkType: hard -"@esbuild/android-arm64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/android-arm64@npm:0.20.2" +"@esbuild/aix-ppc64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/aix-ppc64@npm:0.23.0" + conditions: os=aix & cpu=ppc64 + languageName: node + linkType: hard + +"@esbuild/android-arm64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/android-arm64@npm:0.21.5" conditions: os=android & cpu=arm64 languageName: node linkType: hard -"@esbuild/android-arm@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/android-arm@npm:0.20.2" +"@esbuild/android-arm64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/android-arm64@npm:0.23.0" + conditions: os=android & cpu=arm64 + languageName: node + linkType: hard + +"@esbuild/android-arm@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/android-arm@npm:0.21.5" conditions: os=android & cpu=arm languageName: node linkType: hard -"@esbuild/android-x64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/android-x64@npm:0.20.2" +"@esbuild/android-arm@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/android-arm@npm:0.23.0" + conditions: os=android & cpu=arm + languageName: node + linkType: hard + +"@esbuild/android-x64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/android-x64@npm:0.21.5" conditions: os=android & cpu=x64 languageName: node linkType: hard -"@esbuild/darwin-arm64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/darwin-arm64@npm:0.20.2" +"@esbuild/android-x64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/android-x64@npm:0.23.0" + conditions: os=android & cpu=x64 + languageName: node + linkType: hard + +"@esbuild/darwin-arm64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/darwin-arm64@npm:0.21.5" conditions: os=darwin & cpu=arm64 languageName: node linkType: hard -"@esbuild/darwin-x64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/darwin-x64@npm:0.20.2" +"@esbuild/darwin-arm64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/darwin-arm64@npm:0.23.0" + conditions: os=darwin & cpu=arm64 + languageName: node + linkType: hard + +"@esbuild/darwin-x64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/darwin-x64@npm:0.21.5" conditions: os=darwin & cpu=x64 languageName: node linkType: hard -"@esbuild/freebsd-arm64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/freebsd-arm64@npm:0.20.2" +"@esbuild/darwin-x64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/darwin-x64@npm:0.23.0" + conditions: os=darwin & cpu=x64 + languageName: node + linkType: hard + +"@esbuild/freebsd-arm64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/freebsd-arm64@npm:0.21.5" conditions: os=freebsd & cpu=arm64 languageName: node linkType: hard -"@esbuild/freebsd-x64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/freebsd-x64@npm:0.20.2" +"@esbuild/freebsd-arm64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/freebsd-arm64@npm:0.23.0" + conditions: os=freebsd & cpu=arm64 + languageName: node + linkType: hard + +"@esbuild/freebsd-x64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/freebsd-x64@npm:0.21.5" conditions: os=freebsd & cpu=x64 languageName: node linkType: hard -"@esbuild/linux-arm64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/linux-arm64@npm:0.20.2" +"@esbuild/freebsd-x64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/freebsd-x64@npm:0.23.0" + conditions: os=freebsd & cpu=x64 + languageName: node + linkType: hard + +"@esbuild/linux-arm64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/linux-arm64@npm:0.21.5" conditions: os=linux & cpu=arm64 languageName: node linkType: hard -"@esbuild/linux-arm@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/linux-arm@npm:0.20.2" +"@esbuild/linux-arm64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/linux-arm64@npm:0.23.0" + conditions: os=linux & cpu=arm64 + languageName: node + linkType: hard + +"@esbuild/linux-arm@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/linux-arm@npm:0.21.5" conditions: os=linux & cpu=arm languageName: node linkType: hard -"@esbuild/linux-ia32@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/linux-ia32@npm:0.20.2" +"@esbuild/linux-arm@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/linux-arm@npm:0.23.0" + conditions: os=linux & cpu=arm + languageName: node + linkType: hard + +"@esbuild/linux-ia32@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/linux-ia32@npm:0.21.5" conditions: os=linux & cpu=ia32 languageName: node linkType: hard -"@esbuild/linux-loong64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/linux-loong64@npm:0.20.2" +"@esbuild/linux-ia32@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/linux-ia32@npm:0.23.0" + conditions: os=linux & cpu=ia32 + languageName: node + linkType: hard + +"@esbuild/linux-loong64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/linux-loong64@npm:0.21.5" conditions: os=linux & cpu=loong64 languageName: node linkType: hard -"@esbuild/linux-mips64el@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/linux-mips64el@npm:0.20.2" +"@esbuild/linux-loong64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/linux-loong64@npm:0.23.0" + conditions: os=linux & cpu=loong64 + languageName: node + linkType: hard + +"@esbuild/linux-mips64el@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/linux-mips64el@npm:0.21.5" conditions: os=linux & cpu=mips64el languageName: node linkType: hard -"@esbuild/linux-ppc64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/linux-ppc64@npm:0.20.2" +"@esbuild/linux-mips64el@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/linux-mips64el@npm:0.23.0" + conditions: os=linux & cpu=mips64el + languageName: node + linkType: hard + +"@esbuild/linux-ppc64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/linux-ppc64@npm:0.21.5" conditions: os=linux & cpu=ppc64 languageName: node linkType: hard -"@esbuild/linux-riscv64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/linux-riscv64@npm:0.20.2" +"@esbuild/linux-ppc64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/linux-ppc64@npm:0.23.0" + conditions: os=linux & cpu=ppc64 + languageName: node + linkType: hard + +"@esbuild/linux-riscv64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/linux-riscv64@npm:0.21.5" conditions: os=linux & cpu=riscv64 languageName: node linkType: hard -"@esbuild/linux-s390x@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/linux-s390x@npm:0.20.2" +"@esbuild/linux-riscv64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/linux-riscv64@npm:0.23.0" + conditions: os=linux & cpu=riscv64 + languageName: node + linkType: hard + +"@esbuild/linux-s390x@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/linux-s390x@npm:0.21.5" conditions: os=linux & cpu=s390x languageName: node linkType: hard -"@esbuild/linux-x64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/linux-x64@npm:0.20.2" +"@esbuild/linux-s390x@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/linux-s390x@npm:0.23.0" + conditions: os=linux & cpu=s390x + languageName: node + linkType: hard + +"@esbuild/linux-x64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/linux-x64@npm:0.21.5" conditions: os=linux & cpu=x64 languageName: node linkType: hard -"@esbuild/netbsd-x64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/netbsd-x64@npm:0.20.2" +"@esbuild/linux-x64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/linux-x64@npm:0.23.0" + conditions: os=linux & cpu=x64 + languageName: node + linkType: hard + +"@esbuild/netbsd-x64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/netbsd-x64@npm:0.21.5" conditions: os=netbsd & cpu=x64 languageName: node linkType: hard -"@esbuild/openbsd-x64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/openbsd-x64@npm:0.20.2" +"@esbuild/netbsd-x64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/netbsd-x64@npm:0.23.0" + conditions: os=netbsd & cpu=x64 + languageName: node + linkType: hard + +"@esbuild/openbsd-arm64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/openbsd-arm64@npm:0.23.0" + conditions: os=openbsd & cpu=arm64 + languageName: node + linkType: hard + +"@esbuild/openbsd-x64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/openbsd-x64@npm:0.21.5" conditions: os=openbsd & cpu=x64 languageName: node linkType: hard -"@esbuild/sunos-x64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/sunos-x64@npm:0.20.2" +"@esbuild/openbsd-x64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/openbsd-x64@npm:0.23.0" + conditions: os=openbsd & cpu=x64 + languageName: node + linkType: hard + +"@esbuild/sunos-x64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/sunos-x64@npm:0.21.5" conditions: os=sunos & cpu=x64 languageName: node linkType: hard -"@esbuild/win32-arm64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/win32-arm64@npm:0.20.2" +"@esbuild/sunos-x64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/sunos-x64@npm:0.23.0" + conditions: os=sunos & cpu=x64 + languageName: node + linkType: hard + +"@esbuild/win32-arm64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/win32-arm64@npm:0.21.5" conditions: os=win32 & cpu=arm64 languageName: node linkType: hard -"@esbuild/win32-ia32@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/win32-ia32@npm:0.20.2" +"@esbuild/win32-arm64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/win32-arm64@npm:0.23.0" + conditions: os=win32 & cpu=arm64 + languageName: node + linkType: hard + +"@esbuild/win32-ia32@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/win32-ia32@npm:0.21.5" conditions: os=win32 & cpu=ia32 languageName: node linkType: hard -"@esbuild/win32-x64@npm:0.20.2": - version: 0.20.2 - resolution: "@esbuild/win32-x64@npm:0.20.2" +"@esbuild/win32-ia32@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/win32-ia32@npm:0.23.0" + conditions: os=win32 & cpu=ia32 + languageName: node + linkType: hard + +"@esbuild/win32-x64@npm:0.21.5": + version: 0.21.5 + resolution: "@esbuild/win32-x64@npm:0.21.5" + conditions: os=win32 & cpu=x64 + languageName: node + linkType: hard + +"@esbuild/win32-x64@npm:0.23.0": + version: 0.23.0 + resolution: "@esbuild/win32-x64@npm:0.23.0" conditions: os=win32 & cpu=x64 languageName: node linkType: hard @@ -474,13 +701,13 @@ __metadata: resolution: "@gi.ts/parser@workspace:packages/parser" dependencies: "@typescript-eslint/eslint-plugin": "npm:^7.8.0" - "@typescript-eslint/parser": "npm:^7.8.0" + "@typescript-eslint/parser": "npm:^7.15.0" eslint: "npm:^8.57.0" eslint-config-prettier: "npm:^9.1.0" eslint-plugin-prettier: "npm:^5.1.3" - fast-xml-parser: "npm:^4.3.6" - prettier: "npm:^3.2.5" - typescript: "npm:^5.4.5" + fast-xml-parser: "npm:^4.4.0" + prettier: "npm:^3.3.2" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -515,6 +742,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -527,6 +755,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -562,6 +791,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" "@girs/soup-3.0": "workspace:^" @@ -605,6 +835,7 @@ __metadata: "@girs/gsk-4.0": "workspace:^" "@girs/gtk-4.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" + "@girs/libxml2-2.0": "workspace:^" "@girs/pango-1.0": "workspace:^" "@girs/pangocairo-1.0": "workspace:^" typescript: "npm:*" @@ -718,6 +949,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -774,6 +1006,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -787,6 +1020,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -800,6 +1034,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -813,6 +1048,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -1001,6 +1237,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -1135,6 +1372,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -1187,6 +1425,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -1210,6 +1449,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1234,6 +1474,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1258,6 +1499,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1282,6 +1524,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1307,6 +1550,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1325,6 +1569,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" typescript: "npm:*" @@ -1374,6 +1619,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -1432,6 +1678,55 @@ __metadata: languageName: unknown linkType: soft +"@girs/clapper-0.0@workspace:^, @girs/clapper-0.0@workspace:types/clapper-0.0": + version: 0.0.0-use.local + resolution: "@girs/clapper-0.0@workspace:types/clapper-0.0" + dependencies: + "@girs/gio-2.0": "workspace:^" + "@girs/gjs": "workspace:^" + "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" + "@girs/gobject-2.0": "workspace:^" + "@girs/gst-1.0": "workspace:^" + "@girs/gstaudio-1.0": "workspace:^" + "@girs/gstbase-1.0": "workspace:^" + "@girs/gstpbutils-1.0": "workspace:^" + "@girs/gsttag-1.0": "workspace:^" + "@girs/gstvideo-1.0": "workspace:^" + typescript: "npm:*" + languageName: unknown + linkType: soft + +"@girs/clappergtk-0.0@workspace:types/clappergtk-0.0": + version: 0.0.0-use.local + resolution: "@girs/clappergtk-0.0@workspace:types/clappergtk-0.0" + dependencies: + "@girs/cairo-1.0": "workspace:^" + "@girs/clapper-0.0": "workspace:^" + "@girs/freetype2-2.0": "workspace:^" + "@girs/gdk-4.0": "workspace:^" + "@girs/gdkpixbuf-2.0": "workspace:^" + "@girs/gio-2.0": "workspace:^" + "@girs/gjs": "workspace:^" + "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" + "@girs/gobject-2.0": "workspace:^" + "@girs/graphene-1.0": "workspace:^" + "@girs/gsk-4.0": "workspace:^" + "@girs/gst-1.0": "workspace:^" + "@girs/gstaudio-1.0": "workspace:^" + "@girs/gstbase-1.0": "workspace:^" + "@girs/gstpbutils-1.0": "workspace:^" + "@girs/gsttag-1.0": "workspace:^" + "@girs/gstvideo-1.0": "workspace:^" + "@girs/gtk-4.0": "workspace:^" + "@girs/harfbuzz-0.0": "workspace:^" + "@girs/pango-1.0": "workspace:^" + "@girs/pangocairo-1.0": "workspace:^" + typescript: "npm:*" + languageName: unknown + linkType: soft + "@girs/cloudproviders-0.3@workspace:^, @girs/cloudproviders-0.3@workspace:types/cloudproviders-0.3": version: 0.0.0-use.local resolution: "@girs/cloudproviders-0.3@workspace:types/cloudproviders-0.3" @@ -1439,6 +1734,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -1457,6 +1753,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -1479,6 +1776,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1502,6 +1800,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1525,6 +1824,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1548,6 +1848,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1572,6 +1873,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1681,6 +1983,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -1698,6 +2001,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -1825,6 +2129,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/pango-1.0": "workspace:^" @@ -1844,6 +2149,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1864,6 +2170,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1884,6 +2191,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1904,6 +2212,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1924,6 +2233,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -1946,6 +2256,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/pango-1.0": "workspace:^" @@ -1961,6 +2272,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -1997,6 +2309,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gusb-1.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -2043,6 +2356,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2154,6 +2468,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2191,6 +2506,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2203,6 +2519,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/soup-2.4": "workspace:^" typescript: "npm:*" @@ -2245,6 +2562,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" @@ -2263,6 +2581,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" @@ -2280,6 +2599,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" @@ -2297,6 +2617,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/icalglib-3.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -2315,6 +2636,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" @@ -2334,6 +2656,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" @@ -2353,6 +2676,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/icalglib-3.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -2370,6 +2694,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" @@ -2643,6 +2968,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2655,6 +2981,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2667,6 +2994,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2679,6 +3007,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2692,6 +3021,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2705,6 +3035,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2719,6 +3050,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2733,6 +3065,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2750,6 +3083,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" @@ -2770,6 +3104,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" @@ -2787,6 +3122,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/socialwebclient-0.25": "workspace:^" typescript: "npm:*" @@ -2802,6 +3138,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/telepathyglib-0.12": "workspace:^" typescript: "npm:*" @@ -2817,6 +3154,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/telepathyglib-0.12": "workspace:^" typescript: "npm:*" @@ -2840,6 +3178,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gusb-1.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -2864,6 +3203,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2888,6 +3228,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2900,6 +3241,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxfce4util-1.0": "workspace:^" typescript: "npm:*" @@ -2940,6 +3282,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/pango-1.0": "workspace:^" @@ -2954,6 +3297,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2967,6 +3311,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -2980,6 +3325,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3015,6 +3361,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3027,6 +3374,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3051,6 +3399,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3064,6 +3413,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3183,6 +3533,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" typescript: "npm:*" @@ -3196,6 +3547,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/goa-1.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -3455,6 +3807,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3490,6 +3843,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3560,6 +3914,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3572,6 +3927,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/soup-2.4": "workspace:^" @@ -3586,6 +3942,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/soup-3.0": "workspace:^" @@ -3670,6 +4027,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3682,6 +4040,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/rest-0.7": "workspace:^" @@ -3697,6 +4056,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/rest-0.7": "workspace:^" @@ -3712,6 +4072,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3723,6 +4084,7 @@ __metadata: dependencies: "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3832,6 +4194,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3920,6 +4283,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3932,6 +4296,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3944,6 +4309,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -3967,6 +4333,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -4046,6 +4413,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -4116,6 +4484,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -4156,6 +4525,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -4178,6 +4548,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -4234,9 +4605,10 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" - "@girs/rest-0.7": "workspace:^" - "@girs/soup-2.4": "workspace:^" + "@girs/rest-1.0": "workspace:^" + "@girs/soup-3.0": "workspace:^" typescript: "npm:*" languageName: unknown linkType: soft @@ -4248,6 +4620,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -4344,6 +4717,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -4452,6 +4826,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -4464,6 +4839,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/soup-2.4": "workspace:^" typescript: "npm:*" @@ -4477,6 +4853,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/soup-3.0": "workspace:^" typescript: "npm:*" @@ -4518,6 +4895,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" "@girs/soup-2.4": "workspace:^" @@ -4532,6 +4910,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" typescript: "npm:*" @@ -4545,6 +4924,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -4557,6 +4937,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -4590,6 +4971,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -4624,6 +5006,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/soup-2.4": "workspace:^" typescript: "npm:*" @@ -4637,6 +5020,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/soup-2.4": "workspace:^" typescript: "npm:*" @@ -4650,6 +5034,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/soup-3.0": "workspace:^" typescript: "npm:*" @@ -5344,6 +5729,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -5805,6 +6191,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -5817,6 +6204,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gssdp-1.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" @@ -5832,6 +6220,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gssdp-1.2": "workspace:^" "@girs/libxml2-2.0": "workspace:^" @@ -5847,6 +6236,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gssdp-1.6": "workspace:^" "@girs/libxml2-2.0": "workspace:^" @@ -5943,6 +6333,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" typescript: "npm:*" @@ -5956,6 +6347,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -5968,6 +6360,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -5980,6 +6373,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gvnc-1.0": "workspace:^" typescript: "npm:*" @@ -6015,6 +6409,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6028,6 +6423,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" typescript: "npm:*" @@ -6042,6 +6438,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" typescript: "npm:*" @@ -6056,6 +6453,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" typescript: "npm:*" @@ -6070,6 +6468,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" typescript: "npm:*" @@ -6084,6 +6483,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6097,6 +6497,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6212,6 +6613,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6340,6 +6742,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6418,6 +6821,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" typescript: "npm:*" @@ -6441,6 +6845,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6453,6 +6858,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6488,6 +6894,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" typescript: "npm:*" @@ -6530,6 +6937,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6553,6 +6961,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6565,6 +6974,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" typescript: "npm:*" @@ -6578,6 +6988,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6613,6 +7024,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libvirtgconfig-1.0": "workspace:^" "@girs/libvirtglib-1.0": "workspace:^" @@ -6628,6 +7040,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libvirtgconfig-1.0": "workspace:^" "@girs/libvirtglib-1.0": "workspace:^" @@ -6690,6 +7103,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6780,6 +7194,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6792,6 +7207,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6830,6 +7246,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gudev-1.0": "workspace:^" typescript: "npm:*" @@ -6845,19 +7262,17 @@ __metadata: "@girs/clutter-1.0": "workspace:^" "@girs/cogl-1.0": "workspace:^" "@girs/coglpango-1.0": "workspace:^" - "@girs/fontconfig-2.0": "workspace:^" "@girs/freetype2-2.0": "workspace:^" "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/pango-1.0": "workspace:^" "@girs/pangocairo-1.0": "workspace:^" - "@girs/pangofc-1.0": "workspace:^" - "@girs/pangoft2-1.0": "workspace:^" typescript: "npm:*" languageName: unknown linkType: soft @@ -6914,6 +7329,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6948,6 +7364,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6960,6 +7377,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -6972,6 +7390,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -7054,6 +7473,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -7081,6 +7501,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -7109,6 +7530,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -7136,6 +7558,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -7164,6 +7587,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -7193,6 +7617,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/graphene-1.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" @@ -7263,6 +7688,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -7330,6 +7756,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -7356,6 +7783,7 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gl-1.0": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -7442,6 +7870,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -7524,6 +7953,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -7536,6 +7966,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -7596,6 +8027,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/networkmanager-1.0": "workspace:^" typescript: "npm:*" @@ -7670,6 +8102,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -7692,6 +8125,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -7704,6 +8138,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/packagekitglib-1.0": "workspace:^" typescript: "npm:*" @@ -7766,6 +8201,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" typescript: "npm:*" @@ -7781,6 +8217,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/pango-1.0": "workspace:^" @@ -7798,6 +8235,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/pango-1.0": "workspace:^" @@ -7815,6 +8253,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/pango-1.0": "workspace:^" @@ -7833,6 +8272,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/pango-1.0": "workspace:^" @@ -7851,6 +8291,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/pango-1.0": "workspace:^" @@ -7871,6 +8312,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -7883,6 +8325,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -7948,6 +8391,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -8016,6 +8460,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -8028,6 +8473,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/polkit-1.0": "workspace:^" typescript: "npm:*" @@ -8042,6 +8488,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -8077,6 +8524,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/qrtr-1.0": "workspace:^" typescript: "npm:*" @@ -8090,6 +8538,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -8131,6 +8580,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/soup-2.4": "workspace:^" typescript: "npm:*" @@ -8144,6 +8594,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/soup-3.0": "workspace:^" typescript: "npm:*" @@ -8157,6 +8608,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/libxml2-2.0": "workspace:^" "@girs/rest-0.7": "workspace:^" @@ -8172,6 +8624,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/rest-1.0": "workspace:^" "@girs/soup-3.0": "workspace:^" @@ -8253,6 +8706,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/ostree-1.0": "workspace:^" typescript: "npm:*" @@ -8282,6 +8736,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gssdp-1.2": "workspace:^" "@girs/gupnp-1.2": "workspace:^" @@ -8299,6 +8754,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gssdp-1.6": "workspace:^" "@girs/gupnp-1.6": "workspace:^" @@ -8316,6 +8772,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gssdp-1.2": "workspace:^" "@girs/gupnp-1.2": "workspace:^" @@ -8335,6 +8792,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gssdp-1.6": "workspace:^" "@girs/gupnp-1.6": "workspace:^" @@ -8398,6 +8856,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gssdp-1.2": "workspace:^" "@girs/gupnp-1.2": "workspace:^" @@ -8417,6 +8876,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gssdp-1.6": "workspace:^" "@girs/gupnp-1.6": "workspace:^" @@ -8435,6 +8895,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -8447,6 +8908,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/secret-1": "workspace:^" typescript: "npm:*" @@ -8661,6 +9123,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -8684,6 +9147,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -8696,6 +9160,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -8708,6 +9173,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -8720,6 +9186,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -8732,6 +9199,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -8744,6 +9212,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/soup-2.4": "workspace:^" typescript: "npm:*" @@ -9047,6 +9516,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9059,6 +9529,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/telepathyglib-0.12": "workspace:^" typescript: "npm:*" @@ -9072,6 +9543,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9141,7 +9613,7 @@ __metadata: "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gtk-3.0": "workspace:^" - "@girs/gtksource-4": "workspace:^" + "@girs/gtksource-300": "workspace:^" "@girs/harfbuzz-0.0": "workspace:^" "@girs/pango-1.0": "workspace:^" "@girs/xlib-2.0": "workspace:^" @@ -9224,6 +9696,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9236,6 +9709,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9248,6 +9722,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9260,6 +9735,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9272,6 +9748,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9284,6 +9761,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9310,6 +9788,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9322,6 +9801,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9334,6 +9814,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9346,6 +9827,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/soup-2.4": "workspace:^" typescript: "npm:*" @@ -9359,6 +9841,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/soup-3.0": "workspace:^" typescript: "npm:*" @@ -9407,6 +9890,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9421,6 +9905,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9433,6 +9918,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/unity-7.0": "workspace:^" typescript: "npm:*" @@ -9446,6 +9932,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9460,6 +9947,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gxml-0.20": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -9477,6 +9965,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gxml-0.20": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -9495,6 +9984,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gxml-0.20": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -9514,6 +10004,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gxml-0.20": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -9544,6 +10035,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gxml-0.20": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -9562,6 +10054,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gxml-0.20": "workspace:^" "@girs/json-1.0": "workspace:^" @@ -9951,6 +10444,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9963,6 +10457,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -9997,6 +10492,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -10079,6 +10575,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -10134,6 +10631,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -10223,6 +10721,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" typescript: "npm:*" languageName: unknown @@ -10235,6 +10734,7 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" + "@girs/gmodule-2.0": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/json-1.0": "workspace:^" "@girs/rest-0.7": "workspace:^" @@ -10268,10 +10768,10 @@ __metadata: languageName: node linkType: hard -"@inquirer/figures@npm:^1.0.1": - version: 1.0.1 - resolution: "@inquirer/figures@npm:1.0.1" - checksum: 10/ed9f23ce881e7fe7042f5f1a630d7d0febe7cce0eadc6e2eeb10238d80c4a19d03c344e980cb2e199081823fbaad42b3e1fab46ef77d3ac68e0575fc7037067a +"@inquirer/figures@npm:^1.0.3": + version: 1.0.3 + resolution: "@inquirer/figures@npm:1.0.3" + checksum: 10/fa5c46527580c64ba151e1399f91772670f5f59e47045a3d2366188ed4cab1b63b7fb2a6d40d340f622cb174ca6dd3d5e22b962811c00548f9a9b4024b105dce languageName: node linkType: hard @@ -10351,15 +10851,6 @@ __metadata: languageName: node linkType: hard -"@ljharb/through@npm:^2.3.13": - version: 2.3.13 - resolution: "@ljharb/through@npm:2.3.13" - dependencies: - call-bind: "npm:^1.0.7" - checksum: 10/6150c6c43a726d52c26863ed6dc4ab54fa7cf625c81463a5ddec86278c99e23bf94dfc99ebf09a9ac3191332d4a27344e092f7e07f252b8cd600e2b38e645870 - languageName: node - linkType: hard - "@nodelib/fs.scandir@npm:2.1.5": version: 2.1.5 resolution: "@nodelib/fs.scandir@npm:2.1.5" @@ -10465,6 +10956,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-android-arm-eabi@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-android-arm-eabi@npm:4.18.0" + conditions: os=android & cpu=arm + languageName: node + linkType: hard + "@rollup/rollup-android-arm64@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-android-arm64@npm:4.17.2" @@ -10472,6 +10970,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-android-arm64@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-android-arm64@npm:4.18.0" + conditions: os=android & cpu=arm64 + languageName: node + linkType: hard + "@rollup/rollup-darwin-arm64@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-darwin-arm64@npm:4.17.2" @@ -10479,6 +10984,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-darwin-arm64@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-darwin-arm64@npm:4.18.0" + conditions: os=darwin & cpu=arm64 + languageName: node + linkType: hard + "@rollup/rollup-darwin-x64@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-darwin-x64@npm:4.17.2" @@ -10486,6 +10998,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-darwin-x64@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-darwin-x64@npm:4.18.0" + conditions: os=darwin & cpu=x64 + languageName: node + linkType: hard + "@rollup/rollup-linux-arm-gnueabihf@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-linux-arm-gnueabihf@npm:4.17.2" @@ -10493,6 +11012,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-linux-arm-gnueabihf@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-linux-arm-gnueabihf@npm:4.18.0" + conditions: os=linux & cpu=arm & libc=glibc + languageName: node + linkType: hard + "@rollup/rollup-linux-arm-musleabihf@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-linux-arm-musleabihf@npm:4.17.2" @@ -10500,6 +11026,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-linux-arm-musleabihf@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-linux-arm-musleabihf@npm:4.18.0" + conditions: os=linux & cpu=arm & libc=musl + languageName: node + linkType: hard + "@rollup/rollup-linux-arm64-gnu@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-linux-arm64-gnu@npm:4.17.2" @@ -10507,6 +11040,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-linux-arm64-gnu@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-linux-arm64-gnu@npm:4.18.0" + conditions: os=linux & cpu=arm64 & libc=glibc + languageName: node + linkType: hard + "@rollup/rollup-linux-arm64-musl@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-linux-arm64-musl@npm:4.17.2" @@ -10514,6 +11054,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-linux-arm64-musl@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-linux-arm64-musl@npm:4.18.0" + conditions: os=linux & cpu=arm64 & libc=musl + languageName: node + linkType: hard + "@rollup/rollup-linux-powerpc64le-gnu@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-linux-powerpc64le-gnu@npm:4.17.2" @@ -10521,6 +11068,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-linux-powerpc64le-gnu@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-linux-powerpc64le-gnu@npm:4.18.0" + conditions: os=linux & cpu=ppc64 & libc=glibc + languageName: node + linkType: hard + "@rollup/rollup-linux-riscv64-gnu@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-linux-riscv64-gnu@npm:4.17.2" @@ -10528,6 +11082,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-linux-riscv64-gnu@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-linux-riscv64-gnu@npm:4.18.0" + conditions: os=linux & cpu=riscv64 & libc=glibc + languageName: node + linkType: hard + "@rollup/rollup-linux-s390x-gnu@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-linux-s390x-gnu@npm:4.17.2" @@ -10535,6 +11096,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-linux-s390x-gnu@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-linux-s390x-gnu@npm:4.18.0" + conditions: os=linux & cpu=s390x & libc=glibc + languageName: node + linkType: hard + "@rollup/rollup-linux-x64-gnu@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-linux-x64-gnu@npm:4.17.2" @@ -10542,6 +11110,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-linux-x64-gnu@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-linux-x64-gnu@npm:4.18.0" + conditions: os=linux & cpu=x64 & libc=glibc + languageName: node + linkType: hard + "@rollup/rollup-linux-x64-musl@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-linux-x64-musl@npm:4.17.2" @@ -10549,6 +11124,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-linux-x64-musl@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-linux-x64-musl@npm:4.18.0" + conditions: os=linux & cpu=x64 & libc=musl + languageName: node + linkType: hard + "@rollup/rollup-win32-arm64-msvc@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-win32-arm64-msvc@npm:4.17.2" @@ -10556,6 +11138,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-win32-arm64-msvc@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-win32-arm64-msvc@npm:4.18.0" + conditions: os=win32 & cpu=arm64 + languageName: node + linkType: hard + "@rollup/rollup-win32-ia32-msvc@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-win32-ia32-msvc@npm:4.17.2" @@ -10563,6 +11152,13 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-win32-ia32-msvc@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-win32-ia32-msvc@npm:4.18.0" + conditions: os=win32 & cpu=ia32 + languageName: node + linkType: hard + "@rollup/rollup-win32-x64-msvc@npm:4.17.2": version: 4.17.2 resolution: "@rollup/rollup-win32-x64-msvc@npm:4.17.2" @@ -10570,20 +11166,27 @@ __metadata: languageName: node linkType: hard +"@rollup/rollup-win32-x64-msvc@npm:4.18.0": + version: 4.18.0 + resolution: "@rollup/rollup-win32-x64-msvc@npm:4.18.0" + conditions: os=win32 & cpu=x64 + languageName: node + linkType: hard + "@ts-for-gir-example/adw-1-hello-example@workspace:examples/gjs/adw-1-hello": version: 0.0.0-use.local resolution: "@ts-for-gir-example/adw-1-hello-example@workspace:examples/gjs/adw-1-hello" dependencies: - "@babel/core": "npm:^7.24.5" + "@babel/core": "npm:^7.24.7" "@girs/adw-1": "workspace:^" "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" "@girs/gtk-4.0": "workspace:^" "@rollup/plugin-babel": "npm:^6.0.4" - rollup: "npm:^4.17.2" - typescript: "npm:^5.4.5" - vite: "npm:^5.2.11" + rollup: "npm:^4.18.0" + typescript: "npm:^5.5.3" + vite: "npm:^5.3.3" languageName: unknown linkType: soft @@ -10594,8 +11197,8 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10605,8 +11208,8 @@ __metadata: dependencies: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10616,8 +11219,8 @@ __metadata: dependencies: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10632,8 +11235,8 @@ __metadata: "@girs/graphene-1.0": "workspace:^" "@girs/gtk-4.0": "workspace:^" "@ts-for-gir/cli": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10645,8 +11248,8 @@ __metadata: "@girs/glib-2.0": "workspace:^" fork-ts-checker-webpack-plugin: "npm:^9.0.2" ts-loader: "npm:^9.5.1" - typescript: "npm:^5.4.5" - webpack: "npm:^5.91.0" + typescript: "npm:^5.5.3" + webpack: "npm:^5.92.1" webpack-cli: "npm:^5.1.4" languageName: unknown linkType: soft @@ -10658,8 +11261,8 @@ __metadata: "@girs/gio-2.0": "workspace:^" "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10673,8 +11276,8 @@ __metadata: "@girs/webkit2-4.0": "workspace:^" fork-ts-checker-webpack-plugin: "npm:^9.0.2" ts-loader: "npm:^9.5.1" - typescript: "npm:^5.4.5" - webpack: "npm:^5.91.0" + typescript: "npm:^5.5.3" + webpack: "npm:^5.92.1" webpack-cli: "npm:^5.1.4" languageName: unknown linkType: soft @@ -10688,8 +11291,8 @@ __metadata: fork-ts-checker-webpack-plugin: "npm:^9.0.2" raw-loader: "npm:^4.0.2" ts-loader: "npm:^9.5.1" - typescript: "npm:^5.4.5" - webpack: "npm:^5.91.0" + typescript: "npm:^5.5.3" + webpack: "npm:^5.92.1" webpack-cli: "npm:^5.1.4" languageName: unknown linkType: soft @@ -10700,8 +11303,8 @@ __metadata: dependencies: "@girs/gjs": "workspace:^" "@girs/gtk-3.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10714,8 +11317,8 @@ __metadata: "@girs/gtksource-3.0": "workspace:^" fork-ts-checker-webpack-plugin: "npm:^9.0.2" ts-loader: "npm:^9.5.1" - typescript: "npm:^5.4.5" - webpack: "npm:^5.91.0" + typescript: "npm:^5.5.3" + webpack: "npm:^5.92.1" webpack-cli: "npm:^5.1.4" languageName: unknown linkType: soft @@ -10726,8 +11329,8 @@ __metadata: dependencies: "@girs/gjs": "workspace:^" "@girs/gtk-3.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10737,8 +11340,8 @@ __metadata: dependencies: "@girs/gjs": "workspace:^" "@girs/gtk-3.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10750,8 +11353,8 @@ __metadata: "@girs/gtk-3.0": "workspace:^" fork-ts-checker-webpack-plugin: "npm:^9.0.2" ts-loader: "npm:^9.5.1" - typescript: "npm:^5.4.5" - webpack: "npm:^5.91.0" + typescript: "npm:^5.5.3" + webpack: "npm:^5.92.1" webpack-cli: "npm:^5.1.4" languageName: unknown linkType: soft @@ -10762,8 +11365,8 @@ __metadata: dependencies: "@girs/gjs": "workspace:^" "@girs/gtk-3.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10774,8 +11377,8 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gtk-3.0": "workspace:^" "@girs/webkit2-4.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10787,8 +11390,8 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" "@girs/gtk-4.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10800,8 +11403,8 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/gobject-2.0": "workspace:^" "@girs/gtk-4.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10814,8 +11417,8 @@ __metadata: "@girs/glib-2.0": "workspace:^" "@girs/gtk-4.0": "workspace:^" "@ts-for-gir/cli": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10828,8 +11431,8 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" "@girs/gtk-4.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10841,8 +11444,8 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" "@girs/soup-3.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10854,8 +11457,8 @@ __metadata: "@girs/gjs": "workspace:^" "@girs/glib-2.0": "workspace:^" "@girs/soup-3.0": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -10864,8 +11467,8 @@ __metadata: resolution: "@ts-for-gir-example/timers-example@workspace:examples/gjs/timers" dependencies: "@girs/gjs": "workspace:^" - esbuild: "npm:^0.20.2" - typescript: "npm:^5.4.5" + esbuild: "npm:^0.23.0" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -11345,7 +11948,7 @@ __metadata: "@girs/zbar-1.0": "workspace:^" "@girs/zeitgeist-2.0": "workspace:^" "@girs/zpj-0.0": "workspace:^" - typescript: "npm:^5.4.5" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -11359,21 +11962,21 @@ __metadata: "@ts-for-gir/generator-typescript": "workspace:^" "@ts-for-gir/lib": "workspace:^" "@types/inquirer": "npm:^9.0.7" - "@types/node": "npm:^20.12.8" + "@types/node": "npm:^20.14.10" "@types/yargs": "npm:^17.0.32" "@typescript-eslint/eslint-plugin": "npm:^7.8.0" - "@typescript-eslint/parser": "npm:^7.8.0" + "@typescript-eslint/parser": "npm:^7.15.0" colorette: "npm:^2.0.20" cosmiconfig: "npm:^9.0.0" eslint: "npm:^8.57.0" eslint-config-prettier: "npm:^9.1.0" eslint-plugin-prettier: "npm:^5.1.3" - glob: "npm:^10.3.12" - inquirer: "npm:^9.2.20" - prettier: "npm:^3.2.5" - rimraf: "npm:^5.0.5" + glob: "npm:^10.4.3" + inquirer: "npm:^9.3.4" + prettier: "npm:^3.3.2" + rimraf: "npm:^5.0.8" ts-node: "npm:^10.9.2" - typescript: "npm:^5.4.5" + typescript: "npm:^5.5.3" yargs: "npm:^17.7.2" bin: ts-for-gir: ./lib/start.js @@ -11385,15 +11988,15 @@ __metadata: resolution: "@ts-for-gir/generator-base@workspace:packages/generator-base" dependencies: "@ts-for-gir/lib": "workspace:^" - "@types/node": "npm:^20.12.8" + "@types/node": "npm:^20.14.10" "@typescript-eslint/eslint-plugin": "npm:^7.8.0" - "@typescript-eslint/parser": "npm:^7.8.0" + "@typescript-eslint/parser": "npm:^7.15.0" eslint: "npm:^8.57.0" eslint-config-prettier: "npm:^9.1.0" eslint-plugin-prettier: "npm:^5.1.3" - prettier: "npm:^3.2.5" - rimraf: "npm:^5.0.5" - typescript: "npm:^5.4.5" + prettier: "npm:^3.3.2" + rimraf: "npm:^5.0.8" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -11403,15 +12006,15 @@ __metadata: dependencies: "@ts-for-gir/generator-base": "workspace:^" "@ts-for-gir/lib": "workspace:^" - "@types/node": "npm:^20.12.8" + "@types/node": "npm:^20.14.10" "@typescript-eslint/eslint-plugin": "npm:^7.8.0" - "@typescript-eslint/parser": "npm:^7.8.0" + "@typescript-eslint/parser": "npm:^7.15.0" eslint: "npm:^8.57.0" eslint-config-prettier: "npm:^9.1.0" eslint-plugin-prettier: "npm:^5.1.3" - prettier: "npm:^3.2.5" - rimraf: "npm:^5.0.5" - typescript: "npm:^5.4.5" + prettier: "npm:^3.3.2" + rimraf: "npm:^5.0.8" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -11422,17 +12025,17 @@ __metadata: "@ts-for-gir/generator-base": "workspace:^" "@ts-for-gir/lib": "workspace:^" "@types/ejs": "npm:^3.1.5" - "@types/node": "npm:^20.12.8" + "@types/node": "npm:^20.14.10" "@types/xml2js": "npm:^0.4.14" "@typescript-eslint/eslint-plugin": "npm:^7.8.0" - "@typescript-eslint/parser": "npm:^7.8.0" + "@typescript-eslint/parser": "npm:^7.15.0" ejs: "npm:^3.1.10" eslint: "npm:^8.57.0" eslint-config-prettier: "npm:^9.1.0" eslint-plugin-prettier: "npm:^5.1.3" - prettier: "npm:^3.2.5" - rimraf: "npm:^5.0.5" - typescript: "npm:^5.4.5" + prettier: "npm:^3.3.2" + rimraf: "npm:^5.0.8" + typescript: "npm:^5.5.3" xml2js: "npm:^0.6.2" languageName: unknown linkType: soft @@ -11444,20 +12047,20 @@ __metadata: "@gi.ts/parser": "workspace:^" "@types/ejs": "npm:^3.1.5" "@types/eslint": "npm:8.56.10" - "@types/lodash": "npm:^4.17.1" - "@types/node": "npm:^20.12.8" + "@types/lodash": "npm:^4.17.6" + "@types/node": "npm:^20.14.10" "@typescript-eslint/eslint-plugin": "npm:^7.8.0" - "@typescript-eslint/parser": "npm:^7.8.0" + "@typescript-eslint/parser": "npm:^7.15.0" colorette: "npm:^2.0.20" ejs: "npm:^3.1.10" eslint: "npm:^8.57.0" eslint-config-prettier: "npm:^9.1.0" eslint-plugin-prettier: "npm:^5.1.3" - glob: "npm:^10.3.12" + glob: "npm:^10.4.3" lodash: "npm:^4.17.21" - prettier: "npm:^3.2.5" - rimraf: "npm:^5.0.5" - typescript: "npm:^5.4.5" + prettier: "npm:^3.3.2" + rimraf: "npm:^5.0.8" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -11540,14 +12143,14 @@ __metadata: languageName: node linkType: hard -"@types/lodash@npm:^4.17.1": - version: 4.17.1 - resolution: "@types/lodash@npm:4.17.1" - checksum: 10/384bdd29348a000f8e815f94839a1a8c7f5a4ca856b016ade7f2abdc1df0b4e3e009c113b69db320a8fde51d1f38e60c19462b9bf3e82e0e2e32d3ac3e7ba2c4 +"@types/lodash@npm:^4.17.6": + version: 4.17.6 + resolution: "@types/lodash@npm:4.17.6" + checksum: 10/6d3a68b3e795381f4aaf946855134d24eeb348ad5d66e9a44461d30026da82b215d55b92b70486d811ca45d54d4ab956aa2dced37fd04e19d49afe160ae3da2e languageName: node linkType: hard -"@types/node@npm:*, @types/node@npm:^20.12.8": +"@types/node@npm:*": version: 20.12.8 resolution: "@types/node@npm:20.12.8" dependencies: @@ -11556,6 +12159,15 @@ __metadata: languageName: node linkType: hard +"@types/node@npm:^20.14.10": + version: 20.14.10 + resolution: "@types/node@npm:20.14.10" + dependencies: + undici-types: "npm:~5.26.4" + checksum: 10/672892cf94d0d95cf052f11271990686a0fd204cd1e5fe7a4ef240e5315e06711765dc47b9ec98627d3adac18b8c92bb7e2d8db21d18faa20bc3e3203a143e79 + languageName: node + linkType: hard + "@types/semver@npm:^7.5.8": version: 7.5.8 resolution: "@types/semver@npm:7.5.8" @@ -11622,21 +12234,31 @@ __metadata: languageName: node linkType: hard -"@typescript-eslint/parser@npm:^7.8.0": - version: 7.8.0 - resolution: "@typescript-eslint/parser@npm:7.8.0" +"@typescript-eslint/parser@npm:^7.15.0": + version: 7.15.0 + resolution: "@typescript-eslint/parser@npm:7.15.0" dependencies: - "@typescript-eslint/scope-manager": "npm:7.8.0" - "@typescript-eslint/types": "npm:7.8.0" - "@typescript-eslint/typescript-estree": "npm:7.8.0" - "@typescript-eslint/visitor-keys": "npm:7.8.0" + "@typescript-eslint/scope-manager": "npm:7.15.0" + "@typescript-eslint/types": "npm:7.15.0" + "@typescript-eslint/typescript-estree": "npm:7.15.0" + "@typescript-eslint/visitor-keys": "npm:7.15.0" debug: "npm:^4.3.4" peerDependencies: eslint: ^8.56.0 peerDependenciesMeta: typescript: optional: true - checksum: 10/57b7918ec80484903e43e6877aabc37e7e1735fefc730c161777333b38d92cffb562fca9c91e622c0e58fe2fb0f7e47e5237bd0666189a70b3abc62e5c13eb7c + checksum: 10/0b5e7a14fa5d0680efb17e750a095729a7fb7c785d7a0fea2f9e6cbfef9e65caab2b751654b348b9ab813d222c1c3f8189ebf48561b81224d1821cee5c99d658 + languageName: node + linkType: hard + +"@typescript-eslint/scope-manager@npm:7.15.0": + version: 7.15.0 + resolution: "@typescript-eslint/scope-manager@npm:7.15.0" + dependencies: + "@typescript-eslint/types": "npm:7.15.0" + "@typescript-eslint/visitor-keys": "npm:7.15.0" + checksum: 10/45bfdbae2d080691a34f5b37679b4a4067981baa3b82922268abdd21f6917a8dd1c4ccb12133f6c9cce81cfd640040913b223e8125235b92f42fdb57db358a3e languageName: node linkType: hard @@ -11667,6 +12289,13 @@ __metadata: languageName: node linkType: hard +"@typescript-eslint/types@npm:7.15.0": + version: 7.15.0 + resolution: "@typescript-eslint/types@npm:7.15.0" + checksum: 10/b36c98344469f4bc54a5199733ea4f6d4d0f2da1070605e60d4031e2da2946b84b91a90108516c8e6e83a21030ba4e935053a0906041c920156de40683297d0b + languageName: node + linkType: hard + "@typescript-eslint/types@npm:7.8.0": version: 7.8.0 resolution: "@typescript-eslint/types@npm:7.8.0" @@ -11674,6 +12303,25 @@ __metadata: languageName: node linkType: hard +"@typescript-eslint/typescript-estree@npm:7.15.0": + version: 7.15.0 + resolution: "@typescript-eslint/typescript-estree@npm:7.15.0" + dependencies: + "@typescript-eslint/types": "npm:7.15.0" + "@typescript-eslint/visitor-keys": "npm:7.15.0" + debug: "npm:^4.3.4" + globby: "npm:^11.1.0" + is-glob: "npm:^4.0.3" + minimatch: "npm:^9.0.4" + semver: "npm:^7.6.0" + ts-api-utils: "npm:^1.3.0" + peerDependenciesMeta: + typescript: + optional: true + checksum: 10/c5fb15108fbbc1bc976e827218ff7bfbc78930c5906292325ee42ba03514623e7b861497b3e3087f71ede9a757b16441286b4d234450450b0dd70ff753782736 + languageName: node + linkType: hard + "@typescript-eslint/typescript-estree@npm:7.8.0": version: 7.8.0 resolution: "@typescript-eslint/typescript-estree@npm:7.8.0" @@ -11710,6 +12358,16 @@ __metadata: languageName: node linkType: hard +"@typescript-eslint/visitor-keys@npm:7.15.0": + version: 7.15.0 + resolution: "@typescript-eslint/visitor-keys@npm:7.15.0" + dependencies: + "@typescript-eslint/types": "npm:7.15.0" + eslint-visitor-keys: "npm:^3.4.3" + checksum: 10/0e17d7f5de767da7f98170c2efc905cdb0ceeaf04a667e12ca1a92eae64479a07f4f8e2a9b5023b055b01250916c3bcac86908cd06552610baff734fafae4464 + languageName: node + linkType: hard + "@typescript-eslint/visitor-keys@npm:7.8.0": version: 7.8.0 resolution: "@typescript-eslint/visitor-keys@npm:7.8.0" @@ -11932,12 +12590,12 @@ __metadata: languageName: node linkType: hard -"acorn-import-assertions@npm:^1.9.0": - version: 1.9.0 - resolution: "acorn-import-assertions@npm:1.9.0" +"acorn-import-attributes@npm:^1.9.5": + version: 1.9.5 + resolution: "acorn-import-attributes@npm:1.9.5" peerDependencies: acorn: ^8 - checksum: 10/af8dd58f6b0c6a43e85849744534b99f2133835c6fcdabda9eea27d0a0da625a0d323c4793ba7cb25cf4507609d0f747c210ccc2fc9b5866de04b0e59c9c5617 + checksum: 10/8bfbfbb6e2467b9b47abb4d095df717ab64fce2525da65eabee073e85e7975fb3a176b6c8bba17c99a7d8ede283a10a590272304eb54a93c4aa1af9790d47a8b languageName: node linkType: hard @@ -12210,19 +12868,6 @@ __metadata: languageName: node linkType: hard -"call-bind@npm:^1.0.7": - version: 1.0.7 - resolution: "call-bind@npm:1.0.7" - dependencies: - es-define-property: "npm:^1.0.0" - es-errors: "npm:^1.3.0" - function-bind: "npm:^1.1.2" - get-intrinsic: "npm:^1.2.4" - set-function-length: "npm:^1.2.1" - checksum: 10/cd6fe658e007af80985da5185bff7b55e12ef4c2b6f41829a26ed1eef254b1f1c12e3dfd5b2b068c6ba8b86aba62390842d81752e67dcbaec4f6f76e7113b6b7 - languageName: node - linkType: hard - "callsites@npm:^3.0.0": version: 3.1.0 resolution: "callsites@npm:3.1.0" @@ -12258,13 +12903,6 @@ __metadata: languageName: node linkType: hard -"chalk@npm:^5.3.0": - version: 5.3.0 - resolution: "chalk@npm:5.3.0" - checksum: 10/6373caaab21bd64c405bfc4bd9672b145647fc9482657b5ea1d549b3b2765054e9d3d928870cdf764fb4aad67555f5061538ff247b8310f110c5c888d92397ea - languageName: node - linkType: hard - "chardet@npm:^0.7.0": version: 0.7.0 resolution: "chardet@npm:0.7.0" @@ -12547,17 +13185,6 @@ __metadata: languageName: node linkType: hard -"define-data-property@npm:^1.1.4": - version: 1.1.4 - resolution: "define-data-property@npm:1.1.4" - dependencies: - es-define-property: "npm:^1.0.0" - es-errors: "npm:^1.3.0" - gopd: "npm:^1.0.1" - checksum: 10/abdcb2505d80a53524ba871273e5da75e77e52af9e15b3aa65d8aad82b8a3a424dad7aee2cc0b71470ac7acf501e08defac362e8b6a73cdb4309f028061df4ae - languageName: node - linkType: hard - "diff@npm:^4.0.1": version: 4.0.2 resolution: "diff@npm:4.0.2" @@ -12638,7 +13265,7 @@ __metadata: languageName: node linkType: hard -"enhanced-resolve@npm:^5.0.0, enhanced-resolve@npm:^5.16.0": +"enhanced-resolve@npm:^5.0.0": version: 5.16.0 resolution: "enhanced-resolve@npm:5.16.0" dependencies: @@ -12648,6 +13275,16 @@ __metadata: languageName: node linkType: hard +"enhanced-resolve@npm:^5.17.0": + version: 5.17.0 + resolution: "enhanced-resolve@npm:5.17.0" + dependencies: + graceful-fs: "npm:^4.2.4" + tapable: "npm:^2.2.0" + checksum: 10/8f7bf71537d78e7d20a27363793f2c9e13ec44800c7c7830364a448f80a44994aa19d64beecefa1ab49e4de6f7fbe18cc0931dc449c115f02918ff5fcbe7705f + languageName: node + linkType: hard + "env-paths@npm:^2.2.0, env-paths@npm:^2.2.1": version: 2.2.1 resolution: "env-paths@npm:2.2.1" @@ -12680,22 +13317,6 @@ __metadata: languageName: node linkType: hard -"es-define-property@npm:^1.0.0": - version: 1.0.0 - resolution: "es-define-property@npm:1.0.0" - dependencies: - get-intrinsic: "npm:^1.2.4" - checksum: 10/f66ece0a887b6dca71848fa71f70461357c0e4e7249696f81bad0a1f347eed7b31262af4a29f5d726dc026426f085483b6b90301855e647aa8e21936f07293c6 - languageName: node - linkType: hard - -"es-errors@npm:^1.3.0": - version: 1.3.0 - resolution: "es-errors@npm:1.3.0" - checksum: 10/96e65d640156f91b707517e8cdc454dd7d47c32833aa3e85d79f24f9eb7ea85f39b63e36216ef0114996581969b59fe609a94e30316b08f5f4df1d44134cf8d5 - languageName: node - linkType: hard - "es-module-lexer@npm:^1.2.1": version: 1.5.2 resolution: "es-module-lexer@npm:1.5.2" @@ -12703,33 +13324,114 @@ __metadata: languageName: node linkType: hard -"esbuild@npm:^0.20.1, esbuild@npm:^0.20.2": - version: 0.20.2 - resolution: "esbuild@npm:0.20.2" - dependencies: - "@esbuild/aix-ppc64": "npm:0.20.2" - "@esbuild/android-arm": "npm:0.20.2" - "@esbuild/android-arm64": "npm:0.20.2" - "@esbuild/android-x64": "npm:0.20.2" - "@esbuild/darwin-arm64": "npm:0.20.2" - "@esbuild/darwin-x64": "npm:0.20.2" - "@esbuild/freebsd-arm64": "npm:0.20.2" - "@esbuild/freebsd-x64": "npm:0.20.2" - "@esbuild/linux-arm": "npm:0.20.2" - "@esbuild/linux-arm64": "npm:0.20.2" - "@esbuild/linux-ia32": "npm:0.20.2" - "@esbuild/linux-loong64": "npm:0.20.2" - "@esbuild/linux-mips64el": "npm:0.20.2" - "@esbuild/linux-ppc64": "npm:0.20.2" - "@esbuild/linux-riscv64": "npm:0.20.2" - "@esbuild/linux-s390x": "npm:0.20.2" - "@esbuild/linux-x64": "npm:0.20.2" - "@esbuild/netbsd-x64": "npm:0.20.2" - "@esbuild/openbsd-x64": "npm:0.20.2" - "@esbuild/sunos-x64": "npm:0.20.2" - "@esbuild/win32-arm64": "npm:0.20.2" - "@esbuild/win32-ia32": "npm:0.20.2" - "@esbuild/win32-x64": "npm:0.20.2" +"esbuild@npm:^0.21.3": + version: 0.21.5 + resolution: "esbuild@npm:0.21.5" + dependencies: + "@esbuild/aix-ppc64": "npm:0.21.5" + "@esbuild/android-arm": "npm:0.21.5" + "@esbuild/android-arm64": "npm:0.21.5" + "@esbuild/android-x64": "npm:0.21.5" + "@esbuild/darwin-arm64": "npm:0.21.5" + "@esbuild/darwin-x64": "npm:0.21.5" + "@esbuild/freebsd-arm64": "npm:0.21.5" + "@esbuild/freebsd-x64": "npm:0.21.5" + "@esbuild/linux-arm": "npm:0.21.5" + "@esbuild/linux-arm64": "npm:0.21.5" + "@esbuild/linux-ia32": "npm:0.21.5" + "@esbuild/linux-loong64": "npm:0.21.5" + "@esbuild/linux-mips64el": "npm:0.21.5" + "@esbuild/linux-ppc64": "npm:0.21.5" + "@esbuild/linux-riscv64": "npm:0.21.5" + "@esbuild/linux-s390x": "npm:0.21.5" + "@esbuild/linux-x64": "npm:0.21.5" + "@esbuild/netbsd-x64": "npm:0.21.5" + "@esbuild/openbsd-x64": "npm:0.21.5" + "@esbuild/sunos-x64": "npm:0.21.5" + "@esbuild/win32-arm64": "npm:0.21.5" + "@esbuild/win32-ia32": "npm:0.21.5" + "@esbuild/win32-x64": "npm:0.21.5" + dependenciesMeta: + "@esbuild/aix-ppc64": + optional: true + "@esbuild/android-arm": + optional: true + "@esbuild/android-arm64": + optional: true + "@esbuild/android-x64": + optional: true + "@esbuild/darwin-arm64": + optional: true + "@esbuild/darwin-x64": + optional: true + "@esbuild/freebsd-arm64": + optional: true + "@esbuild/freebsd-x64": + optional: true + "@esbuild/linux-arm": + optional: true + "@esbuild/linux-arm64": + optional: true + "@esbuild/linux-ia32": + optional: true + "@esbuild/linux-loong64": + optional: true + "@esbuild/linux-mips64el": + optional: true + "@esbuild/linux-ppc64": + optional: true + "@esbuild/linux-riscv64": + optional: true + "@esbuild/linux-s390x": + optional: true + "@esbuild/linux-x64": + optional: true + "@esbuild/netbsd-x64": + optional: true + "@esbuild/openbsd-x64": + optional: true + "@esbuild/sunos-x64": + optional: true + "@esbuild/win32-arm64": + optional: true + "@esbuild/win32-ia32": + optional: true + "@esbuild/win32-x64": + optional: true + bin: + esbuild: bin/esbuild + checksum: 10/d2ff2ca84d30cce8e871517374d6c2290835380dc7cd413b2d49189ed170d45e407be14de2cb4794cf76f75cf89955c4714726ebd3de7444b3046f5cab23ab6b + languageName: node + linkType: hard + +"esbuild@npm:^0.23.0": + version: 0.23.0 + resolution: "esbuild@npm:0.23.0" + dependencies: + "@esbuild/aix-ppc64": "npm:0.23.0" + "@esbuild/android-arm": "npm:0.23.0" + "@esbuild/android-arm64": "npm:0.23.0" + "@esbuild/android-x64": "npm:0.23.0" + "@esbuild/darwin-arm64": "npm:0.23.0" + "@esbuild/darwin-x64": "npm:0.23.0" + "@esbuild/freebsd-arm64": "npm:0.23.0" + "@esbuild/freebsd-x64": "npm:0.23.0" + "@esbuild/linux-arm": "npm:0.23.0" + "@esbuild/linux-arm64": "npm:0.23.0" + "@esbuild/linux-ia32": "npm:0.23.0" + "@esbuild/linux-loong64": "npm:0.23.0" + "@esbuild/linux-mips64el": "npm:0.23.0" + "@esbuild/linux-ppc64": "npm:0.23.0" + "@esbuild/linux-riscv64": "npm:0.23.0" + "@esbuild/linux-s390x": "npm:0.23.0" + "@esbuild/linux-x64": "npm:0.23.0" + "@esbuild/netbsd-x64": "npm:0.23.0" + "@esbuild/openbsd-arm64": "npm:0.23.0" + "@esbuild/openbsd-x64": "npm:0.23.0" + "@esbuild/sunos-x64": "npm:0.23.0" + "@esbuild/win32-arm64": "npm:0.23.0" + "@esbuild/win32-ia32": "npm:0.23.0" + "@esbuild/win32-x64": "npm:0.23.0" dependenciesMeta: "@esbuild/aix-ppc64": optional: true @@ -12767,6 +13469,8 @@ __metadata: optional: true "@esbuild/netbsd-x64": optional: true + "@esbuild/openbsd-arm64": + optional: true "@esbuild/openbsd-x64": optional: true "@esbuild/sunos-x64": @@ -12779,7 +13483,7 @@ __metadata: optional: true bin: esbuild: bin/esbuild - checksum: 10/663215ab7e599651e00d61b528a63136e1f1d397db8b9c3712540af928c9476d61da95aefa81b7a8dfc7a9fdd7616fcf08395c27be68be8c99953fb461863ce4 + checksum: 10/d3d91bf9ca73ba33966fc54cabb321eca770a5e2ff5b34d67e4235c94560cfd881803e39fcaa31d842579d10600da5201c5f597f8438679f6db856f75ded7124 languageName: node linkType: hard @@ -13033,14 +13737,14 @@ __metadata: languageName: node linkType: hard -"fast-xml-parser@npm:^4.3.6": - version: 4.3.6 - resolution: "fast-xml-parser@npm:4.3.6" +"fast-xml-parser@npm:^4.4.0": + version: 4.4.0 + resolution: "fast-xml-parser@npm:4.4.0" dependencies: strnum: "npm:^1.0.5" bin: fxparser: src/cli/cli.js - checksum: 10/3e431e594960f04996e60a01fb51d8f4346138a7ba60d97244bf7866a3072eaf2f6dc73008d7b07871b98b606a8d7db955efdeae787992f685dd0e5bcc67c36a + checksum: 10/f1592fa810d3923c46c7037d5adf1c309580d1d14780312019f33e4967f6ffcb5632168a5e889fe9d30794f6a087a0a095bb21cdf62320a96c6b304395212658 languageName: node linkType: hard @@ -13250,19 +13954,6 @@ __metadata: languageName: node linkType: hard -"get-intrinsic@npm:^1.1.3, get-intrinsic@npm:^1.2.4": - version: 1.2.4 - resolution: "get-intrinsic@npm:1.2.4" - dependencies: - es-errors: "npm:^1.3.0" - function-bind: "npm:^1.1.2" - has-proto: "npm:^1.0.1" - has-symbols: "npm:^1.0.3" - hasown: "npm:^2.0.0" - checksum: 10/85bbf4b234c3940edf8a41f4ecbd4e25ce78e5e6ad4e24ca2f77037d983b9ef943fd72f00f3ee97a49ec622a506b67db49c36246150377efcda1c9eb03e5f06d - languageName: node - linkType: hard - "glob-parent@npm:^5.1.2, glob-parent@npm:~5.1.2": version: 5.1.2 resolution: "glob-parent@npm:5.1.2" @@ -13288,7 +13979,7 @@ __metadata: languageName: node linkType: hard -"glob@npm:^10.2.2, glob@npm:^10.3.10, glob@npm:^10.3.12, glob@npm:^10.3.7": +"glob@npm:^10.2.2, glob@npm:^10.3.10, glob@npm:^10.3.7": version: 10.3.12 resolution: "glob@npm:10.3.12" dependencies: @@ -13303,6 +13994,22 @@ __metadata: languageName: node linkType: hard +"glob@npm:^10.4.3": + version: 10.4.3 + resolution: "glob@npm:10.4.3" + dependencies: + foreground-child: "npm:^3.1.0" + jackspeak: "npm:^3.1.2" + minimatch: "npm:^9.0.4" + minipass: "npm:^7.1.2" + package-json-from-dist: "npm:^1.0.0" + path-scurry: "npm:^1.11.1" + bin: + glob: dist/esm/bin.mjs + checksum: 10/7670e257bc7cf62a5649e79a71fc3b74806516eabfbfef0a949e11c5530c215d0f6d75c8c0c35266ff44ef6cb29b6c0e59be63906909be946d4c65df5d336be8 + languageName: node + linkType: hard + "glob@npm:^7.1.3": version: 7.2.3 resolution: "glob@npm:7.2.3" @@ -13347,15 +14054,6 @@ __metadata: languageName: node linkType: hard -"gopd@npm:^1.0.1": - version: 1.0.1 - resolution: "gopd@npm:1.0.1" - dependencies: - get-intrinsic: "npm:^1.1.3" - checksum: 10/5fbc7ad57b368ae4cd2f41214bd947b045c1a4be2f194a7be1778d71f8af9dbf4004221f3b6f23e30820eb0d052b4f819fe6ebe8221e2a3c6f0ee4ef173421ca - languageName: node - linkType: hard - "graceful-fs@npm:^4.1.2, graceful-fs@npm:^4.1.6, graceful-fs@npm:^4.2.0, graceful-fs@npm:^4.2.11, graceful-fs@npm:^4.2.4, graceful-fs@npm:^4.2.6": version: 4.2.11 resolution: "graceful-fs@npm:4.2.11" @@ -13384,29 +14082,6 @@ __metadata: languageName: node linkType: hard -"has-property-descriptors@npm:^1.0.2": - version: 1.0.2 - resolution: "has-property-descriptors@npm:1.0.2" - dependencies: - es-define-property: "npm:^1.0.0" - checksum: 10/2d8c9ab8cebb572e3362f7d06139a4592105983d4317e68f7adba320fe6ddfc8874581e0971e899e633fd5f72e262830edce36d5a0bc863dad17ad20572484b2 - languageName: node - linkType: hard - -"has-proto@npm:^1.0.1": - version: 1.0.3 - resolution: "has-proto@npm:1.0.3" - checksum: 10/0b67c2c94e3bea37db3e412e3c41f79d59259875e636ba471e94c009cdfb1fa82bf045deeffafc7dbb9c148e36cae6b467055aaa5d9fad4316e11b41e3ba551a - languageName: node - linkType: hard - -"has-symbols@npm:^1.0.3": - version: 1.0.3 - resolution: "has-symbols@npm:1.0.3" - checksum: 10/464f97a8202a7690dadd026e6d73b1ceeddd60fe6acfd06151106f050303eaa75855aaa94969df8015c11ff7c505f196114d22f7386b4a471038da5874cf5e9b - languageName: node - linkType: hard - "hasown@npm:^2.0.0": version: 2.0.2 resolution: "hasown@npm:2.0.2" @@ -13528,18 +14203,14 @@ __metadata: languageName: node linkType: hard -"inquirer@npm:^9.2.20": - version: 9.2.20 - resolution: "inquirer@npm:9.2.20" +"inquirer@npm:^9.3.4": + version: 9.3.4 + resolution: "inquirer@npm:9.3.4" dependencies: - "@inquirer/figures": "npm:^1.0.1" - "@ljharb/through": "npm:^2.3.13" + "@inquirer/figures": "npm:^1.0.3" ansi-escapes: "npm:^4.3.2" - chalk: "npm:^5.3.0" - cli-cursor: "npm:^3.1.0" cli-width: "npm:^4.1.0" external-editor: "npm:^3.1.0" - lodash: "npm:^4.17.21" mute-stream: "npm:1.0.0" ora: "npm:^5.4.1" run-async: "npm:^3.0.0" @@ -13547,7 +14218,8 @@ __metadata: string-width: "npm:^4.2.3" strip-ansi: "npm:^6.0.1" wrap-ansi: "npm:^6.2.0" - checksum: 10/beeca2f0da3eaca18fdf00d1c45e9db71b7699e5b4c96793056434928a96587bf83dcfb594d535162f62e59a6e3c4f0a64e0cdafcc5109123ab16ffa93f87903 + yoctocolors-cjs: "npm:^2.1.2" + checksum: 10/f9d20820ad07bfaa98ad1b0e1bb65da9cb020edafda25f781a28e7fe0fc98eb15b3fe95687258140a24a6bc9d209740d38ab17cc265c12fa6738db530c71b17e languageName: node linkType: hard @@ -13694,6 +14366,19 @@ __metadata: languageName: node linkType: hard +"jackspeak@npm:^3.1.2": + version: 3.4.1 + resolution: "jackspeak@npm:3.4.1" + dependencies: + "@isaacs/cliui": "npm:^8.0.2" + "@pkgjs/parseargs": "npm:^0.11.0" + dependenciesMeta: + "@pkgjs/parseargs": + optional: true + checksum: 10/73225d15b5d1eb3b882bec6e88d956c91ba954afe6a23f1f5e95494c04b68e5b3636f3fe304c8a416e1e68bef7e664a9e6c4ae7e77be8f502b5d16a9ecdcfe00 + languageName: node + linkType: hard + "jake@npm:^10.8.5": version: 10.8.7 resolution: "jake@npm:10.8.7" @@ -14105,6 +14790,13 @@ __metadata: languageName: node linkType: hard +"minipass@npm:^7.1.2": + version: 7.1.2 + resolution: "minipass@npm:7.1.2" + checksum: 10/c25f0ee8196d8e6036661104bacd743785b2599a21de5c516b32b3fa2b83113ac89a2358465bc04956baab37ffb956ae43be679b2262bf7be15fce467ccd7950 + languageName: node + linkType: hard + "minizlib@npm:^2.1.1, minizlib@npm:^2.1.2": version: 2.1.2 resolution: "minizlib@npm:2.1.2" @@ -14328,6 +15020,13 @@ __metadata: languageName: node linkType: hard +"package-json-from-dist@npm:^1.0.0": + version: 1.0.0 + resolution: "package-json-from-dist@npm:1.0.0" + checksum: 10/ac706ec856a5a03f5261e4e48fa974f24feb044d51f84f8332e2af0af04fbdbdd5bbbfb9cbbe354190409bc8307c83a9e38c6672c3c8855f709afb0006a009ea + languageName: node + linkType: hard + "parent-module@npm:^1.0.0": version: 1.0.1 resolution: "parent-module@npm:1.0.1" @@ -14387,6 +15086,16 @@ __metadata: languageName: node linkType: hard +"path-scurry@npm:^1.11.1": + version: 1.11.1 + resolution: "path-scurry@npm:1.11.1" + dependencies: + lru-cache: "npm:^10.2.0" + minipass: "npm:^5.0.0 || ^6.0.2 || ^7.0.0" + checksum: 10/5e8845c159261adda6f09814d7725683257fcc85a18f329880ab4d7cc1d12830967eae5d5894e453f341710d5484b8fdbbd4d75181b4d6e1eb2f4dc7aeadc434 + languageName: node + linkType: hard + "path-type@npm:^4.0.0": version: 4.0.0 resolution: "path-type@npm:4.0.0" @@ -14401,6 +15110,13 @@ __metadata: languageName: node linkType: hard +"picocolors@npm:^1.0.1": + version: 1.0.1 + resolution: "picocolors@npm:1.0.1" + checksum: 10/fa68166d1f56009fc02a34cdfd112b0dd3cf1ef57667ac57281f714065558c01828cdf4f18600ad6851cbe0093952ed0660b1e0156bddf2184b6aaf5817553a5 + languageName: node + linkType: hard + "picomatch@npm:^2.0.4, picomatch@npm:^2.2.1, picomatch@npm:^2.3.1": version: 2.3.1 resolution: "picomatch@npm:2.3.1" @@ -14417,14 +15133,14 @@ __metadata: languageName: node linkType: hard -"postcss@npm:^8.4.38": - version: 8.4.38 - resolution: "postcss@npm:8.4.38" +"postcss@npm:^8.4.39": + version: 8.4.39 + resolution: "postcss@npm:8.4.39" dependencies: nanoid: "npm:^3.3.7" - picocolors: "npm:^1.0.0" + picocolors: "npm:^1.0.1" source-map-js: "npm:^1.2.0" - checksum: 10/6e44a7ed835ffa9a2b096e8d3e5dfc6bcf331a25c48aeb862dd54e3aaecadf814fa22be224fd308f87d08adf2299164f88c5fd5ab1c4ef6cbd693ceb295377f4 + checksum: 10/ad9c1add892c96433b9a5502878201ede4a20c4ce02d056251f61f8d9a3e5426dab3683fe5a086edfa78a1a19f2b4988c8cea02c5122136d29758cb5a17e2621 languageName: node linkType: hard @@ -14444,12 +15160,12 @@ __metadata: languageName: node linkType: hard -"prettier@npm:^3.2.5": - version: 3.2.5 - resolution: "prettier@npm:3.2.5" +"prettier@npm:^3.3.2": + version: 3.3.2 + resolution: "prettier@npm:3.3.2" bin: prettier: bin/prettier.cjs - checksum: 10/d509f9da0b70e8cacc561a1911c0d99ec75117faed27b95cc8534cb2349667dee6351b0ca83fa9d5703f14127faa52b798de40f5705f02d843da133fc3aa416a + checksum: 10/83214e154afa5aa9b664c2506640212323eb1376b13379b2413dc351b7de0687629dca3f00ff2ec895ebd7e3a2adb7d7e231b6c77606e2358137f2150807405b languageName: node linkType: hard @@ -14639,18 +15355,18 @@ __metadata: languageName: node linkType: hard -"rimraf@npm:^5.0.5": - version: 5.0.5 - resolution: "rimraf@npm:5.0.5" +"rimraf@npm:^5.0.8": + version: 5.0.8 + resolution: "rimraf@npm:5.0.8" dependencies: glob: "npm:^10.3.7" bin: rimraf: dist/esm/bin.mjs - checksum: 10/a612c7184f96258b7d1328c486b12ca7b60aa30e04229a08bbfa7e964486deb1e9a1b52d917809311bdc39a808a4055c0f950c0280fba194ba0a09e6f0d404f6 + checksum: 10/ab8f1bcb49762d16120813a127f90773da657bb5c6f29d3865c1b3c1ceb0d2291cd3e7b439adb7571024be47dce8443b3ffd1b116ec78b6122fca0571da87a79 languageName: node linkType: hard -"rollup@npm:^4.13.0, rollup@npm:^4.17.2": +"rollup@npm:^4.13.0": version: 4.17.2 resolution: "rollup@npm:4.17.2" dependencies: @@ -14713,6 +15429,69 @@ __metadata: languageName: node linkType: hard +"rollup@npm:^4.18.0": + version: 4.18.0 + resolution: "rollup@npm:4.18.0" + dependencies: + "@rollup/rollup-android-arm-eabi": "npm:4.18.0" + "@rollup/rollup-android-arm64": "npm:4.18.0" + "@rollup/rollup-darwin-arm64": "npm:4.18.0" + "@rollup/rollup-darwin-x64": "npm:4.18.0" + "@rollup/rollup-linux-arm-gnueabihf": "npm:4.18.0" + "@rollup/rollup-linux-arm-musleabihf": "npm:4.18.0" + "@rollup/rollup-linux-arm64-gnu": "npm:4.18.0" + "@rollup/rollup-linux-arm64-musl": "npm:4.18.0" + "@rollup/rollup-linux-powerpc64le-gnu": "npm:4.18.0" + "@rollup/rollup-linux-riscv64-gnu": "npm:4.18.0" + "@rollup/rollup-linux-s390x-gnu": "npm:4.18.0" + "@rollup/rollup-linux-x64-gnu": "npm:4.18.0" + "@rollup/rollup-linux-x64-musl": "npm:4.18.0" + "@rollup/rollup-win32-arm64-msvc": "npm:4.18.0" + "@rollup/rollup-win32-ia32-msvc": "npm:4.18.0" + "@rollup/rollup-win32-x64-msvc": "npm:4.18.0" + "@types/estree": "npm:1.0.5" + fsevents: "npm:~2.3.2" + dependenciesMeta: + "@rollup/rollup-android-arm-eabi": + optional: true + "@rollup/rollup-android-arm64": + optional: true + "@rollup/rollup-darwin-arm64": + optional: true + "@rollup/rollup-darwin-x64": + optional: true + "@rollup/rollup-linux-arm-gnueabihf": + optional: true + "@rollup/rollup-linux-arm-musleabihf": + optional: true + "@rollup/rollup-linux-arm64-gnu": + optional: true + "@rollup/rollup-linux-arm64-musl": + optional: true + "@rollup/rollup-linux-powerpc64le-gnu": + optional: true + "@rollup/rollup-linux-riscv64-gnu": + optional: true + "@rollup/rollup-linux-s390x-gnu": + optional: true + "@rollup/rollup-linux-x64-gnu": + optional: true + "@rollup/rollup-linux-x64-musl": + optional: true + "@rollup/rollup-win32-arm64-msvc": + optional: true + "@rollup/rollup-win32-ia32-msvc": + optional: true + "@rollup/rollup-win32-x64-msvc": + optional: true + fsevents: + optional: true + bin: + rollup: dist/bin/rollup + checksum: 10/2320fe653cfd5e3d72ecab2f1d52d47e7b624a6ab02919f53c1ad1c5efa3b66e277c3ecfef03bb97651e79cef04bfefd34ad1f6e648f496572bf76c834f19599 + languageName: node + linkType: hard + "run-async@npm:^3.0.0": version: 3.0.0 resolution: "run-async@npm:3.0.0" @@ -14799,20 +15578,6 @@ __metadata: languageName: node linkType: hard -"set-function-length@npm:^1.2.1": - version: 1.2.2 - resolution: "set-function-length@npm:1.2.2" - dependencies: - define-data-property: "npm:^1.1.4" - es-errors: "npm:^1.3.0" - function-bind: "npm:^1.1.2" - get-intrinsic: "npm:^1.2.4" - gopd: "npm:^1.0.1" - has-property-descriptors: "npm:^1.0.2" - checksum: 10/505d62b8e088468917ca4e3f8f39d0e29f9a563b97dbebf92f4bd2c3172ccfb3c5b8e4566d5fcd00784a00433900e7cb8fbc404e2dbd8c3818ba05bb9d4a8a6d - languageName: node - linkType: hard - "shallow-clone@npm:^3.0.0": version: 3.0.1 resolution: "shallow-clone@npm:3.0.1" @@ -15168,14 +15933,14 @@ __metadata: dependencies: "@ts-for-gir/cli": "workspace:^" "@typescript-eslint/eslint-plugin": "npm:^7.8.0" - "@typescript-eslint/parser": "npm:^7.8.0" + "@typescript-eslint/parser": "npm:^7.15.0" concurrently: "npm:^8.2.2" eslint: "npm:^8.57.0" eslint-config-prettier: "npm:^9.1.0" eslint-plugin-prettier: "npm:^5.1.3" - prettier: "npm:^3.2.5" - rimraf: "npm:^5.0.5" - typescript: "npm:^5.4.5" + prettier: "npm:^3.3.2" + rimraf: "npm:^5.0.8" + typescript: "npm:^5.5.3" languageName: unknown linkType: soft @@ -15263,7 +16028,7 @@ __metadata: languageName: node linkType: hard -"typescript@npm:*, typescript@npm:^5.4.5": +"typescript@npm:*": version: 5.4.5 resolution: "typescript@npm:5.4.5" bin: @@ -15273,7 +16038,17 @@ __metadata: languageName: node linkType: hard -"typescript@patch:typescript@npm%3A*#optional!builtin, typescript@patch:typescript@npm%3A^5.4.5#optional!builtin": +"typescript@npm:^5.5.3": + version: 5.5.3 + resolution: "typescript@npm:5.5.3" + bin: + tsc: bin/tsc + tsserver: bin/tsserver + checksum: 10/11a867312419ed497929aafd2f1d28b2cd41810a5eb6c6e9e169559112e9ea073d681c121a29102e67cd4478d0a4ae37a306a5800f3717f59c4337e6a9bd5e8d + languageName: node + linkType: hard + +"typescript@patch:typescript@npm%3A*#optional!builtin": version: 5.4.5 resolution: "typescript@patch:typescript@npm%3A5.4.5#optional!builtin::version=5.4.5&hash=5adc0c" bin: @@ -15283,6 +16058,16 @@ __metadata: languageName: node linkType: hard +"typescript@patch:typescript@npm%3A^5.5.3#optional!builtin": + version: 5.5.3 + resolution: "typescript@patch:typescript@npm%3A5.5.3#optional!builtin::version=5.5.3&hash=379a07" + bin: + tsc: bin/tsc + tsserver: bin/tsserver + checksum: 10/7cf7acb78a80f749b82842f2ffe01e90e7b3e709a6f4268588e0b7599c41dca1059be217f47778fe1a380bfaf60933021ef20d002c426d4d7745e1b36c11467b + languageName: node + linkType: hard + "undici-types@npm:~5.26.4": version: 5.26.5 resolution: "undici-types@npm:5.26.5" @@ -15352,13 +16137,13 @@ __metadata: languageName: node linkType: hard -"vite@npm:^5.2.11": - version: 5.2.11 - resolution: "vite@npm:5.2.11" +"vite@npm:^5.3.3": + version: 5.3.3 + resolution: "vite@npm:5.3.3" dependencies: - esbuild: "npm:^0.20.1" + esbuild: "npm:^0.21.3" fsevents: "npm:~2.3.3" - postcss: "npm:^8.4.38" + postcss: "npm:^8.4.39" rollup: "npm:^4.13.0" peerDependencies: "@types/node": ^18.0.0 || >=20.0.0 @@ -15388,7 +16173,7 @@ __metadata: optional: true bin: vite: bin/vite.js - checksum: 10/ee0ad038f0831c9514796522deb1e2dcb84bc311abbccb77e4b12216d37fc9559137f4f1b8e75187d51007b954e845c6518e36ee3acac2e2a2789c1181ebb16c + checksum: 10/e7a094cefedad9e204b715588502118e07d1b9c00c617f55b810169181907f55144f0a82f650995d6a74f12e3695fca65afc348b475b91a81dcbd0274d30a088 languageName: node linkType: hard @@ -15461,9 +16246,9 @@ __metadata: languageName: node linkType: hard -"webpack@npm:^5.91.0": - version: 5.91.0 - resolution: "webpack@npm:5.91.0" +"webpack@npm:^5.92.1": + version: 5.92.1 + resolution: "webpack@npm:5.92.1" dependencies: "@types/eslint-scope": "npm:^3.7.3" "@types/estree": "npm:^1.0.5" @@ -15471,10 +16256,10 @@ __metadata: "@webassemblyjs/wasm-edit": "npm:^1.12.1" "@webassemblyjs/wasm-parser": "npm:^1.12.1" acorn: "npm:^8.7.1" - acorn-import-assertions: "npm:^1.9.0" + acorn-import-attributes: "npm:^1.9.5" browserslist: "npm:^4.21.10" chrome-trace-event: "npm:^1.0.2" - enhanced-resolve: "npm:^5.16.0" + enhanced-resolve: "npm:^5.17.0" es-module-lexer: "npm:^1.2.1" eslint-scope: "npm:5.1.1" events: "npm:^3.2.0" @@ -15494,7 +16279,7 @@ __metadata: optional: true bin: webpack: bin/webpack.js - checksum: 10/647ca53c15fe0fa1af4396a7257d7a93cbea648d2685e565a11cc822a9e3ea9316345250987d75f02c0b45dae118814f094ec81908d1032e77a33cd6470b289e + checksum: 10/76fcfbebcc0719c4734c65a01dcef7a0f18f3f2647484e8a7e8606adbd128ac42756bb3a8b7e2d486fe97f6286ebdc7b937ccdf3cf1d21b4684134bb89bbed89 languageName: node linkType: hard @@ -15647,3 +16432,10 @@ __metadata: checksum: 10/f77b3d8d00310def622123df93d4ee654fc6a0096182af8bd60679ddcdfb3474c56c6c7190817c84a2785648cdee9d721c0154eb45698c62176c322fb46fc700 languageName: node linkType: hard + +"yoctocolors-cjs@npm:^2.1.2": + version: 2.1.2 + resolution: "yoctocolors-cjs@npm:2.1.2" + checksum: 10/d731e3ba776a0ee19021d909787942933a6c2eafb2bbe85541f0c59aa5c7d475ce86fcb860d5803105e32244c3dd5ba875b87c4c6bf2d6f297da416aa54e556f + languageName: node + linkType: hard